Get a receivable's history

GET
/receivables/:receivable_id/history

Returns the history of the specified accounts receivable document. The history contains all revisions of the document, status updates, and other events that occurred during the document’s lifecycle. For more information, see Document history.

You can filter the history by the date range and event type. Events are sorted from oldest to newest by default.

Path parameters

receivable_idstringRequired

ID of the accounts receivable document whose history you want to get.

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>=1<=100

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

Return only the specified event types. To include multiple types, repeat this parameter for each value: event_type__in=receivable_updated&event_type__in=status_changed

entity_user_id__instringOptional

Return only events caused by the entity users with the specified IDs. To specify multiple user IDs, repeat this parameter for each ID: entity_user_id__in=<user1>&entity_user_id__in=<user2>

timestamp__gtdatetimeOptional

Return only events that occurred after the specified date and time. The value must be in the ISO 8601 format YYYY-MM-DDThh:mm[:ss[.ffffff]][Z|±hh:mm].

timestamp__ltdatetimeOptional

Return only events that occurred before the specified date and time.

timestamp__gtedatetimeOptional

Return only events that occurred on or after the specified date and time.

timestamp__ltedatetimeOptional

Return only events that occurred before or on the specified date and time.

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