v1

latestOpenAPI 3.1.02026-08-04261878.5 KB

Retrieve List of All Sales Invoices

get/sales-invoices/all

Query parameters

status'paid' | 'partially_paid'

limitinteger

To configure the number of items per page.

offsetinteger

To specify which page to access.

start_datestring

To filter by invoice_date (the end_date field must be provided). Format YYYY-MM-DD.

end_datestring

To filter by invoice_date. Format YYYY-MM-DD.

order_by'asc' | 'desc'

To set the order in which data is displayed, either ascending or descending.

Response

200

limitinteger

offsetinteger

total_recordsinteger

Example response

{
  "invoices": [
    {
      "uuid": "aad61dca-9be0-4663-9e9a-dd8d76c0b077",
      "number": "INV/08/08/0021",
      "invoice_date": "2023-08-08",
      "status": 3,
      "links": [
        {
          "rel": "self",
          "href": "/sales-invoices/aad61dca-9be0-4663-9e9a-dd8d76c0b077",
          "type": "GET",
          "kind": "item"
        }
      ]
    }
  ],
  "limit": 8,
  "total_records": 7
}