Get A Paginated List Of Invoices

🚧

Paginated Response

Objects are returned in pages of 100 items. Pass the page=X query parameter, where X is the page number, to retrieve each page of the request result. Using page=1 will retrieve the first page of the result.

Example Response

See Get Invoice Detail for more details.

{
    "count": 1,
    "next": null,
    "previous": null,
    "results": [
        {
            "id": "76af4f3d-f100-402e-a796-5364f4a8e408",
            "amount_cents": 175,
            "currency": "USD",
            "discount_amount_cents": 0,
            "invoice_date": "2024-10-17",
            "invoice_due_date": "2023-10-17",
            "invoice_number": "202408161806",
            "note": "1",
            "originating_counterparty_id": "00d26d58-f902-42df-bbc3-e9dc071c8a8c",
            "receiving_counterparty_id": "03aac7c4-fa5a-45a3-a028-16c3fef48106",
            "metadata": {
                "id": "3",
                "user": "ryan"
            },
            "payment_id": "d84ee9f4-b85f-4196-8401-ef6592474248",
            "reconciliation_id": null,
            "created": "2024-08-16T22:06:27.965000",
            "updated": "2024-08-16T22:06:28.049000",
            "account_number": null,
            "accounting_id": null,
            "documentationPresented": false,
            "payment_group_id": "",
            "can_be_resubmitted": false
        }
      ]
}
Language
Credentials
Basic
base64
:
Click Try It! to start a request and see the response here!