Get receivable history records

GET
/receivables/:receivable_id/history

Path parameters

receivable_idstringRequired

Headers

Auth
AuthorizationstringRequired
Bearer authentication of the form Bearer <token>, where token is your auth token.
x-monite-versionstringRequired
x-monite-entity-idstringRequired

The ID of the entity that owns the requested resource.

Query parameters

order"asc" or "desc"Optional

Order by

Allowed values: ascdesc
limitintegerOptional

Max is 100

pagination_tokenstringOptional

A token, obtained from previous page. Prior over other filters

sort"timestamp"OptionalDefaults to timestamp

Allowed sort fields

event_type__inenumOptional
Allowed values: status_changedreceivable_updatedbased_on_receivable_createdpayment_receivedmail_sent
entity_user_id__instringOptional
timestamp__gtdatetimeOptional
timestamp__ltdatetimeOptional
timestamp__gtedatetimeOptional
timestamp__ltedatetimeOptional

Response

Successful Response

datalist of objects
next_pagination_tokenstringOptional

A token that can be sent in the pagination_token query parameter to get the next page of results, or null if there is no next page (i.e. you’ve reached the last page).

prev_pagination_tokenstringOptional

A token that can be sent in the pagination_token query parameter to get the previous page of results, or null if there is no previous page (i.e. you’ve reached the first page).

Errors

Get a Receivable history record by ID