---
title: "Get a receivable's history"
method: GET
path: "/receivables/{receivable_id}/history"
tags: ["Receivables"]
---

# Get a receivable's history

`GET /receivables/{receivable_id}/history`

## Request

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

Returns the history of the specified accounts receivable document. The history contains all revisions of the document, status updates, and other events that occurred during the document's lifecycle. For more information, see [Document history](https://docs.monite.com/accounts-receivable/document-history).

You can filter the history by the date range and event type. Events are sorted from oldest to newest by default.

## Path parameters

- `receivable_id` string, required

## Query parameters

- `order` 'asc' | 'desc'
- `limit` integer
- `pagination_token` string
- `sort` 'timestamp'
- `event_type__in` 'status_changed' | 'receivable_created' | 'receivable_updated' | 'based_on_receivable_created' | 'payment_received' | 'mail_sent' | 'payment_reminder_mail_sent' | 'overdue_reminder_mail_sent'
- `entity_user_id__in` string, uuid
- `timestamp__gt` string, date-time
- `timestamp__lt` string, date-time
- `timestamp__gte` string, date-time
- `timestamp__lte` string, date-time

## Headers

- `x-monite-version` string, required
- `x-monite-entity-id` string, required

## Response `200`

Successful Response

- ReceivableHistoryPaginationResponse: A paginated list of change history records.
  - `data` ReceivableHistoryResponse[], required
    - `id` string, uuid, required: A unique ID of the history record.
    - `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.
    - `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.
    - `event_data` union, 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 `{}`.
      - StatusChangedEventData: Contains information about a document's status change. See the applicable [invoice statuses](https://docs.monite.com/accounts-receivable/invoices/index), [quote statuses](https://docs.monite.com/accounts-receivable/quotes/index), and [credit note statuses](https://docs.monite.com/accounts-receivable/credit-notes#credit-note-lifecycle).
        - `new_status` 'draft' | 'issuing' | 'issued' | 'failed' | 'accepted' | 'expired' | 'declined' | 'recurring' | 'partially_paid' | 'paid' | 'overdue' | 'uncollectible' | 'canceled', required
        - `old_status` 'draft' | 'issuing' | 'issued' | 'failed' | 'accepted' | 'expired' | 'declined' | 'recurring' | 'partially_paid' | 'paid' | 'overdue' | 'uncollectible' | 'canceled', required
      - ReceivableUpdatedEventData
      - ReceivableCreatedEventData
      - BasedOnReceivableCreatedEventData: In invoice history, this object contains information about a credit note created for this invoice. In quote history, it contains information about an invoice created from this quote.
        - `receivable_id` string, uuid, required: The ID of the newly created receivable document.
        - `type` 'quote' | 'invoice' | 'credit_note', required
      - PaymentReceivedEventData: Contains information about a payment received for an invoice.
        - `amount_due` integer, required: The remaining amount due of the invoice, in [minor units](https://docs.monite.com/references/currencies#minor-units) of the currency. For example, $12.5 is represented as 1250.
        - `amount_paid` integer, required: The payment amount, in minor units of the currency.
        - `comment` string: A user-defined comment about this payment, or `null` if no comment was provided. Comments are available only for payments recorded via `POST /receivables/{receivable_id}/mark_as_paid` and `POST /receivables/{receivable_id}/mark_as_partially_paid`.
      - MailSentEventData: Contains information about a sent email.
        - `mail_id` string, uuid, required: ID of the email sending operation. Can be used to get the email sending status from `GET /receivables/{receivable_id}/mails/{mail_id}`.
        - `mail_status` 'pending' | 'processing' | 'sent' | 'partially_sent' | 'failed', required
        - `recipients` ReceivableMailRecipients, required
          - `bcc` ReceivableMailRecipientState[]
            - `email` string, email, required: An email address of the recipient.
            - `error` string: An error message in case the mailing was unsuccessful.
            - `is_success` boolean, required: Whether mail was sent successfully.
          - `cc` ReceivableMailRecipientState[]
            - `email` string, email, required: An email address of the recipient.
            - `error` string: An error message in case the mailing was unsuccessful.
            - `is_success` boolean, required: Whether mail was sent successfully.
          - `to` ReceivableMailRecipientState[]
            - `email` string, email, required: An email address of the recipient.
            - `error` string: An error message in case the mailing was unsuccessful.
            - `is_success` boolean, required: Whether mail was sent successfully.
      - ReminderMailSentEventData: Contains information about an invoice reminder sent via email.
        - `mail_id` string, uuid, required: ID of the email sending operation. Can be used to get the email sending status from `GET /receivables/{receivable_id}/mails/{mail_id}`.
        - `mail_status` 'pending' | 'processing' | 'sent' | 'partially_sent' | 'failed', required
        - `recipients` ReceivableMailRecipients, required
          - `bcc` ReceivableMailRecipientState[]
            - `email` string, email, required: An email address of the recipient.
            - `error` string: An error message in case the mailing was unsuccessful.
            - `is_success` boolean, required: Whether mail was sent successfully.
          - `cc` ReceivableMailRecipientState[]
            - `email` string, email, required: An email address of the recipient.
            - `error` string: An error message in case the mailing was unsuccessful.
            - `is_success` boolean, required: Whether mail was sent successfully.
          - `to` ReceivableMailRecipientState[]
            - `email` string, email, required: An email address of the recipient.
            - `error` string: An error message in case the mailing was unsuccessful.
            - `is_success` boolean, required: Whether mail was sent successfully.
        - `term` 'term_1' | 'term_2' | 'term_final' | 'overdue', required
    - `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_id` string, uuid, required: ID of the receivable document that was changed or triggered an event.
    - `timestamp` string, date-time, required: UTC date and time when the event or change occurred.
  - `next_pagination_token` string: A token that can be sent in the `pagination_token` query parameter to get the next page of results, or `null` if there is no next page (i.e. you've reached the last page).
  - `prev_pagination_token` string: A token that can be sent in the `pagination_token` query parameter to get the previous page of results, or `null` if there is no previous page (i.e. you've reached the first page).

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not found
- `422`: Validation Error
- `500`: Internal Server Error

---

[API](https://skmtc.dev/monite/apis/monite-3.md) - [All operations](https://skmtc.dev/monite/apis/monite-3/llms.txt) - [OpenAPI document](https://skmtc.dev/monite/apis/monite-3/revisions/c13be6f83ce9?raw)