Skip to main content
GET
Get history record

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-finops-version
string<date>
required
x-organization-id
string<uuid>
required

The ID of the entity that owns the requested resource.

Example:

"9d2b4c8f-2087-4738-ba91-7359683c49a4"

Path Parameters

receivable_history_id
string<uuid>
required

ID of the history record to return. You can get these IDs from GET /receivables/{receivable_id}/history.

receivable_id
string<uuid>
required

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

Response

Successful Response

Represents an entry in the change history of an accounts receivable document.

id
string<uuid>
required

A unique ID of the history record.

Example:

"cd58435b-1c79-4b17-9f79-f898c93e5f97"

event_data
object
required

An object containing additional information about the event or change. The object structure varies based on the event_type. In receivable_created events it carries the document's initial status and its creation source. In receivable_updated events it carries a fields map describing what changed: each entry names a field and gives its old and new values. An update where nothing tracked changed carries an empty field map ({"fields": {}}).

event_type
string
required

The type of the event or change.

receivable_id
string<uuid>
required

ID of the receivable document that was changed or triggered an event.

Example:

"f669a8a4-0563-4ab9-b54f-e9d700d282c5"

recorded_by
enum<string>
required

Whether the row is attributed to an entity user or to no user: 'user' when entity_user_id is set, 'system' when it is null.

Available options:
user,
system
timestamp
string<date-time>
required

UTC date and time when the event or change occurred.

current_pdf_url
string | null

A URL of the PDF file that shows the document state after the change. Available only for the following event types: receivable_created, receivable_updated, status_changed, and payment_received. In other event types the current_pdf_url value is null.

In payment_received events, the current_pdf_url value is available only in case of full payments and only if the entity setting generate_paid_invoice_pdf is true.

Note that Monite generates PDFs asynchronously. This means that the initial value of current_pdf_url for the abovementioned events right after they occurred is usually null and the value gets populated later after the PDF document has been generated.

Example:

"https://monite-file-saver.example.com/12345/67890.pdf"

entity_user_first_name
string | null

First name of the entity user who made the change, as it was at the time of the event. null on rows where it was not captured: recorded_by is system, the event predates this field, or the name could not be resolved when the row was written.

Example:

"Mary"

entity_user_id
string<uuid> | null

ID of the entity user who made the change or trigger the event, or null if it was done by using a partner access token.

Example:

"d5a577b0-01c0-4566-ac5c-44f41935e8c4"

entity_user_last_name
string | null

Last name of the entity user who made the change, as it was at the time of the event. null on rows where it was not captured: recorded_by is system, the event predates this field, or the name could not be resolved when the row was written.

Example:

"Wong"

entity_user_role_id
string<uuid> | null

ID of the role the entity user held at the time of the event. null on rows where it was not captured: recorded_by is system, the event predates this field, or the role could not be resolved when the row was written.

Example:

"9f8b1a2c-3d4e-4f50-a61b-7c8d9e0f1a2b"

entity_user_role_name
string | null

Display name of the role the entity user held at the time of the event. null on rows where it was not captured: recorded_by is system, the event predates this field, or the role could not be resolved when the row was written.

Example:

"Finance admin"