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
-
idstringThe Id of the Receivable createdstatusstringEnum:
- PENDING
- CARHOLDER_LOOKUP_REQUESTED
- CARHOLDER_RESOLUTION_FAILED
- INVOICE_CREATED
- WHITELISTED
- INVOICE_REQUESTED
- CREDITED_PENDING
- CREDITED_NOTES_FAILED
- CREDITED_NOTES_SUCCEED
- WAITING_CONTRACT_DATA
objectexternalInvoiceNumberstringUnique number that identifies an invoice. Auto-generated if not given.directbooleantrue = invoices should be created asap, currently the only supported optionarrayexternalReferencestringmerchant's own referenceactualStartstringAccepted formats example: 1985-04-12T23:02:50 or 1985-04-12T23:02:50Z or 1985-04-12T23:02:50-04:00actualEndstringAccepted formats example: 1985-04-12T23:02:50 or 1985-04-12T23:02:50Z or 1985-04-12T23:02:50-04:00arraycurrently supports only one credentialtypestringobjectidstringlicense plate of the carcountrystringISO 3166-1 alpha-2 country code of the carobjectidstringparking spacearraylanguageCoderequiredstringISO language codevaluerequiredstringtext in language codeobjectid of current receivable owneridstringarrayactualStartstringAccepted formats example: 1985-04-12T23:02:50 or 1985-04-12T23:02:50Z or 1985-04-12T23:02:50-04:00actualEndstringAccepted formats example: 1985-04-12T23:02:50 or 1985-04-12T23:02:50Z or 1985-04-12T23:02:50-04:00objectidstringarraylanguageCoderequiredstringISO language codevaluerequiredstringtext in language codezoneNamestringzoneCodestringFacilityCodestringFacilityNamestringobjectobjectcurrencyValuestringcurrencyTypestringtaxIncludedbooleanarrayarraylanguageCoderequiredstringISO language codevaluerequiredstringtext in language codetaxRatestringtaxAmountstringfeeTypestringOne value must to be assigned [SEGMENT, PENALTY, INVOICE, REMINDER, LOOKUP] -
typerequiredstringThe 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.categoryrequiredstringEnum:
- 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.titlestringA short, human-readable summary of the problem.messagestringA short, human-readable summary of the problem. Identical to `title`. -
typerequiredstringThe 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.categoryrequiredstringEnum:
- 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.titlestringA short, human-readable summary of the problem.messagestringA short, human-readable summary of the problem. Identical to `title`. -
typerequiredstringThe 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.categoryrequiredstringEnum:
- 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.titlestringA short, human-readable summary of the problem.messagestringA short, human-readable summary of the problem. Identical to `title`. -
typerequiredstringThe 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.categoryrequiredstringEnum:
- 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.titlestringA short, human-readable summary of the problem.messagestringA short, human-readable summary of the problem. Identical to `title`. -
typerequiredstringThe 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.categoryrequiredstringEnum:
- 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.titlestringA short, human-readable summary of the problem.messagestringA short, human-readable summary of the problem. Identical to `title`.