Sign in

v1

latestOpenAPI 3.1.02026-07-24111224223.3 KB
Invoices

Lists all invoices

Returns AR invoices with pagination plus filters for subsidiary, customer, overdue state, and audit timestamps. Use invoice ids from this feed with retrieve-an-invoice before performing full updates.

get/invoices

Query parameters

limitinteger

Maximum number of rows to return in the page.

cursorstring

If defined, a cursor to retrieve the next page.

Example:iLQvkEj3sh3UiweC

Pagination cursor to navigate through the full response.

subsidiary_idstring uuid

Subsidiary to be used when filtering data

overdueboolean

Filter for overdue invoices.

customer_idstring uuid

Optional UUID filter by customer.

updated.gtstring date-time
Example:2023-01-01T00:00:00Z

Filter invoices updated after this timestamp

status'UNPAID' | 'PAID' | 'PARTIALLY_PAID' | 'UNBILLED' | 'CREDITED' | 'PARTIALLY_CREDITED'

Filter invoices by payment status.

Response

OK

Example response

{
  "invoices": [
    {
      "invoice_number": "INV01",
      "items": [
        {
          "description": "Description",
          "revenue": {
            "account_code": "11112"
          },
          "total_amount": {
            "amount": "1.01",
            "currency": "USD"
          },
          "total_discount": {
            "amount": "1.01",
            "currency": "USD"
          },
          "taxed_amount": {
            "amount": "1.01",
            "currency": "USD"
          },
          "gross_rate": {
            "amount": "1.01",
            "currency": "USD"
          },
          "quantity": 1,
          "external_references": [
            {
              "type": "xyzSystemId",
              "id": "234",
              "url": "https://xyzsystempage.com/ids/234"
            }
          ]
        }
      ],
      "address": {
        "line1": "123 Main St",
        "line2": "Apt 4B",
        "city": "Nashville",
        "state": "TN",
        "zip_code": "37201",
        "country": "US"
      },
      "customer_address": {
        "line1": "123 Main St",
        "line2": "Apt 4B",
        "city": "Nashville",
        "state": "TN",
        "zip_code": "37201",
        "country": "US"
      },
      "shipping_address": {
        "line1": "123 Main St",
        "line2": "Apt 4B",
        "city": "Nashville",
        "state": "TN",
        "zip_code": "37201",
        "country": "US"
      },
      "net_amount": {
        "amount": "1.01",
        "currency": "USD"
      },
      "amount_due": {
        "amount": "1.01",
        "currency": "USD"
      },
      "total": {
        "amount": "1.01",
        "currency": "USD"
      },
      "subtotal": {
        "amount": "1.01",
        "currency": "USD"
      },
      "total_discount": {
        "amount": "1.01",
        "currency": "USD"
      },
      "purchase_order_number": "1",
      "exchange_rate": {
        "base": "USD",
        "target": "USD"
      },
      "taxed_amount": {
        "amount": "1.01",
        "currency": "USD"
      },
      "external_references": [
        {
          "type": "xyzSystemId",
          "id": "234",
          "url": "https://xyzsystempage.com/ids/234"
        }
      ]
    }
  ],
  "pagination": {
    "next_cursor": "iLQvkEj3sh3UiweC"
  }
}