Skip to main content
GET
/
receivables
/
{receivable_id}
/
history
/
{receivable_history_id}
Get a receivable's history record by ID
curl --request GET \
  --url https://api.sandbox.monite.com/v1/receivables/{receivable_id}/history/{receivable_history_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-monite-entity-id: <x-monite-entity-id>' \
  --header 'x-monite-version: <x-monite-version>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "event_data": {
    "new_status": "issued",
    "old_status": "draft"
  },
  "event_type": "status_changed",
  "receivable_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "timestamp": "2023-11-07T05:31:56Z",
  "current_pdf_url": "<string>",
  "entity_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
x-monite-version
string<date>
required
​
x-monite-entity-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 and receivable_updated events, event_data is an empty object {}.

​
event_type
enum<string>
required

The type of the event or change. See Event types.

Available options:
status_changed,
receivable_created,
receivable_updated,
based_on_receivable_created,
payment_received,
mail_sent,
payment_reminder_mail_sent,
overdue_reminder_mail_sent
​
receivable_id
string<uuid>
required

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

Example:

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

​
timestamp
string<date-time>
required

UTC date and time when the event or change occurred.

​
current_pdf_url
string<uri>

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.

Required string length: 1 - 65536
Example:

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

​
entity_user_id
string<uuid>

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"