Payable history

Learn how to review the history of changes made to a payable.

This guide covers the document history for accounts payable documents. Monite also provides document history for accounts receivable documents.

Overview

The document history for payables provides visibility into key actions performed on these documents. Each event includes the timestamp, the type of action, and the user (or system) that performed it.

This helps teams and auditors understand when documents were created, updated, or linked — and by whom.

Roles and permissions

To access a payables’s change history using an entity user token, this user must have a role with the payables.read permission. If the permission type is allowed_for_own (rather than allowed), the user can access the change history only for documents that they themselves created, but the returned history still includes the changes made to their documents by other users.

If a partner-level token is used, no special permissions are needed.

Event types

Payable history includes the following event types:

Event NameDescription
payable_createdWhen a payable is created.
payable_updatedWhen any fields of the payable are updated.
status_changedWhen the payable’s status changes at any stage throughout the full payable lifecycle.
credit_note_linkedWhen a credit note is linked to the payable.
credit_note_unlinkedWhen a credit note is unlinked from the payable.
file_attachedWhen a file is attached to the payable.

To access a document’s history, call GET /payables/{payable_id}/history. You can filter the history by a date range or the event_type.

The history consists of a list of timestamped events that have occurred since the document was created. For a description of available data fields and query parameters, see the endpoint description.

1curl -X POST 'https://api.sandbox.monite.com/v1/payables/{payable_id}/history?event_type__in=status_changed' \
2 -H 'X-Monite-Version: 2024-05-25' \
3 -H 'X-Monite-Entity-Id: ENTITY_ID' \
4 -H 'Authorization: Bearer ACCESS_TOKEN'

The successful 200 response returns the history of the payable. Each event includes the following information:

  • timestamp: When the event occurred
  • event_type: Type of action (e.g. payable_updated)
  • performed_by: The user or system that triggered the event
  • details: Event-specific metadata:
1{
2 "data": [
3 {
4 "id": "cd58435b-1c79-4b17-9f79-f898c93e5f97",
5 "entity_user_id": "d5a577b0-01c0-4566-ac5c-44f41935e8c4",
6 "event_data": {
7 "new_status": "draft",
8 "old_status": "approve_in_progress"
9 },
10 "event_type": "status_changed",
11 "payable_id": "f669a8a4-0563-4ab9-b54f-e9d700d282c5",
12 "timestamp": "2025-05-28T13:27:23.572Z"
13 }
14 ],
15 "next_pagination_token": null,
16 "prev_pagination_token": null
17}