Payables

View history of a payable

Returns a chronological list of events related to the specified payable. This includes changes in status, updates to data, comments, and actions taken by users or automation rules.

get/payables/{payable_id}/history

Request

  • Base URL: https://api.sandbox.monite.com/v1
  • URL: https://api.sandbox.monite.com/v1/payables/{payable_id}/history
  • Auth: HTTP bearer

Path parameters

payable_idstring required

The unique identifier of the payable whose history you want to retrieve.

Query parameters

order'asc' | 'desc'

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

limitinteger

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_tokenstring

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'

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

event_type__in'status_changed' | 'payable_created' | 'payable_updated' | 'credit_note_linked' | 'credit_note_unlinked' | 'file_attached'

Return only the specified event types

entity_user_id__instring 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__gtstring date-time

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__ltstring date-time

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

timestamp__gtestring date-time

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

timestamp__ltestring date-time

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

Headers

x-monite-versionstring required
x-monite-entity-idstring required

The ID of the entity that owns the requested resource.

Response

Successful Response

next_pagination_tokenstring

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_tokenstring

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).

Changes

No recorded changes to this operation across all 1 revision of this API.