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

orderenumOptional

Sort order (ascending by default). Typically used together with the sort parameter.

Allowed values: ascdesc
limitintegerOptional>=1<=100Defaults to 100

The number of items (0 .. 100) to return in a single page of the response. The response may contain fewer items if it is the last or only page.

pagination_tokenstringOptional

A pagination token obtained from a previous call to this endpoint. Use it to get the next or previous page of results for your initial query. If pagination_token is specified, all other query parameters are ignored and inferred from the initial query.

If not specified, the first page of results will be returned.

sort"timestamp"OptionalDefaults to timestamp

The field to sort the results by. Typically used together with the order parameter.

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__instringOptionalformat: "uuid"

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