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

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

string

array

zoneName

string

zoneCode

string

FacilityCode

string

FacilityName

string

object

taxIncluded

boolean

array

feeType

string

One value must to be assigned [SEGMENT, PENALTY, INVOICE, REMINDER, LOOKUP]

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.