Docs

Post Receivables

Create a new recievable for which an invoice should be created.

Path

POST /v1/clients/{clientId}/receivables

Request Parameters

clientId

required

integer

Your assigned `ClientId`.

Request Body

application/json

invoicingScheme

N/A

array

externalReference

string

merchant's own reference

actualStart

string

Accepted formats example: 1985-04-12T23:02:50 or 1985-04-12T23:02:50Z or 1985-04-12T23:02:50-04:00

actualEnd

string

Accepted formats example: 1985-04-12T23:02:50 or 1985-04-12T23:02:50Z or 1985-04-12T23:02:50-04:00

array

currently supports only one credential

object

object

id of current receivable owner

array

actualStart

string

Accepted formats example: 1985-04-12T23:02:50 or 1985-04-12T23:02:50Z or 1985-04-12T23:02:50-04:00

actualEnd

string

Accepted formats example: 1985-04-12T23:02:50 or 1985-04-12T23:02:50Z or 1985-04-12T23:02:50-04:00

object

id

string

array

object

Responses

type

required

string

The type of error that is carried within this response. The value of this type is an URI that can be dereferenced for a human-readable explanation of the error type.

category

required

string

Enum:

BUSINESS_ERROR

TECHNICAL_ERROR

Category of the error, used primarily to determine whether the same request should be retried or not. Possible values: * `BUSINESS_ERROR` - A business error occured. This request should *not* be retried without modification * `TECHNICAL_ERROR` - A temporary, technical error occurred. the request *should* be retried after a back-off period.

title

string

A short, human-readable summary of the problem.

message

string

A short, human-readable summary of the problem. Identical to `title`.

type

required

string

The type of error that is carried within this response. The value of this type is an URI that can be dereferenced for a human-readable explanation of the error type.

category

required

string

Enum:

BUSINESS_ERROR

TECHNICAL_ERROR

Category of the error, used primarily to determine whether the same request should be retried or not. Possible values: * `BUSINESS_ERROR` - A business error occured. This request should *not* be retried without modification * `TECHNICAL_ERROR` - A temporary, technical error occurred. the request *should* be retried after a back-off period.

title

string

A short, human-readable summary of the problem.

message

string

A short, human-readable summary of the problem. Identical to `title`.

required

array

A list of validation failures for the request.