Receivables

Get a receivable's history record by ID

Returns a single record from the change history of the specified accounts receivable document.

get/receivables/{receivable_id}/history/{receivable_history_id}

Request

  • Base URL: https://api.sandbox.monite.com/v1
  • URL: https://api.sandbox.monite.com/v1/receivables/{receivable_id}/history/{receivable_history_id}
  • Auth: HTTP bearer

Path parameters

receivable_history_idstring required

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

receivable_idstring required

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

Headers

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

The ID of the entity that owns the requested resource.

Response

Successful Response

idstring uuid required

A unique ID of the history record.

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

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

event_type'status_changed' | 'receivable_created' | 'receivable_updated' | 'based_on_receivable_created' | 'payment_received' | 'mail_sent' | 'payment_reminder_mail_sent' | 'overdue_reminder_mail_sent' required
receivable_idstring uuid required

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

timestampstring date-time required

UTC date and time when the event or change occurred.

Changes

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