Documentation

Product Explanation
- Product Explanation
- API Overview
Authentication
- Authentication
- Generate Token
Initial Setup

Api Description

Recievable
Events
Merchant Fee

Get Receivables

Get a receivable by its id.

Path

GET /v1/clients/{clientId}/receivables/{receivableId}

Request Parameters

clientId

required

integer

Your assigned `ClientId`.

receivableId

required

string

The Receivable Id.

Responses

string

The Id of the Receivable created

status

string

Enum:

PENDING

CARHOLDER_RESOLUTION_FAILED

INVOICE_CREATED

WHITELISTED

INVOICE_REQUESTED

CREDITED_PENDING

CREDITED_NOTES_FAILED

CREDITED_NOTES_SUCCEED

object

direct

boolean

true = invoices should be created asap, currently the only supported option

customerDataDeferred

boolean

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

type

string

object

string

license plate of the car

country

string

ISO 3166-1 alpha-2 country code of the car

object

string

parking space

array

languageCode

required

string

ISO language code

value

required

string

text in language code

object

id of current receivable owner

string

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

languageCode

required

string

ISO language code

value

required

string

text in language code

zoneName

string

zoneCode

string

FacilityCode

string

FacilityName

string

object

currencyValue

string

currencyType

string

taxIncluded

boolean

array

languageCode

required

string

ISO language code

value

required

string

text in language code

taxRate

string

taxAmount

string

feeType

string

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

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

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

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

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

title

string

A short, human-readable summary of the problem.

message

string

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