Get a Receivable history record by ID

GET

/receivables/:receivable_id/history/:receivable_history_id

receivable_history_idstringRequired

receivable_idstringRequired

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.

Successful Response

idstring

ID of the history record.

event_dataobject

Payload of the event.

event_typeenum

Allowed values: status_changedreceivable_updatedbased_on_receivable_createdpayment_receivedmail_sent

The type of event.

receivable_idstring

ID of receivable that was changed.

timestampdatetime

Timestamp when the event has happened.

current_pdf_urlstringOptional=1 character

Link, that will lead to the PDF that shows the state of the document after this change. If this change doesn’t change PDF - this field will be empty.

entity_user_idstringOptional

1	curl https://api.sandbox.monite.com/v1/receivables/receivable_id/history/receivable_history_id \
2	-H "x-monite-version: 2024-01-31" \
3	-H "x-monite-entity-id: x-monite-entity-id" \
4	-H "Authorization: Bearer <token>"

1	{
2	"id": "id",
3	"event_data": {
4	"new_status": "draft",
5	"old_status": "draft"
6	},
7	"event_type": "status_changed",
8	"receivable_id": "receivable_id",
9	"timestamp": "2024-01-15T09:30:00Z",
10	"current_pdf_url": "current_pdf_url",
11	"entity_user_id": "entity_user_id"
12	}