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

200 OK.

RESPONSE SCHEMA:

id

string

The Id of the Receivable created

status

string

Enum:PENDINGCARHOLDER_RESOLUTION_FAILEDINVOICE_CREATED

invoicingScheme

object (invoicingScheme)

direct

boolean

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

sessions

array

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

identifiedCredentials

array

currently supports only one credential

Array () [
type

string

identifier

object (identifier)

id

string

license plate of the car

country

string

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

]
element

object (element)

id

string

parking space

name

array

Array () [
languageCode
required

string

ISO language code

value
required

string

text in language code

]
initiator

object (initiator)

id of current receivable owner

id

string

segments

array

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

assignedRight

object (assignedRight)

id

string

name

array

Array () [
languageCode
required

string

ISO language code

value
required

string

text in language code

]
monetaryValue

object (monetaryValue)

value

object (value)

currencyValue

string

currencyType

string

taxIncluded

boolean

taxLines

array

Array () [
taxLabel

array

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]

]
]
400 Bad request.

RESPONSE SCHEMA:

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_ERRORTECHNICAL_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`.

401 Missing or invalid "Authorization" header.

RESPONSE SCHEMA:

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_ERRORTECHNICAL_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`.

403 Lacking permissions.

RESPONSE SCHEMA:

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_ERRORTECHNICAL_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`.

404 Resource not found.

RESPONSE SCHEMA:

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_ERRORTECHNICAL_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`.

500 Unexpected internal server error.

RESPONSE SCHEMA:

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_ERRORTECHNICAL_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`.

Response Example