Invoices

List invoices, or read one with its line items and payments. Needs a key with the invoices:read scope.

List invoices

GET/v1/invoicesScope: invoices:read

Newest first. The list gives each invoice's summary; fetch a single invoice to get its line items and payments.

Parameter	Type	Description
status	string	One of the invoice statuses.
customer_id	string	Only invoices of this customer.
shipment_id	string	Only invoices for this shipment (its internal id).
created_since	ISO 8601	Only invoices created at or after this moment.
limit	integer	1 to 100, default 25.
cursor	string	From the previous page.

curl

curl -H "Authorization: Bearer zlx_live_YOUR_KEY" \
  "https://api.zargologix.com/v1/invoices?status=OVERDUE&limit=25"

Get one invoice

GET/v1/invoices/{id}Scope: invoices:read

{id} can be the internal id or the invoice number. An unknown id returns 404 not_found.

200 OK

{
  "id": "cm2kb7d900010",
  "invoice_number": "ZINV-2026-00031",
  "customer_id": "cm2k8w7b20000",
  "shipment_id": "cm2k9x0a10001",
  "status": "SENT",
  "subtotal": "310.00",
  "tax_rate": "7.5",
  "total": "333.25",
  "due_date": "2026-11-08T00:00:00.000Z",
  "created_at": "2026-10-08T15:30:00.000Z",
  "line_items": [
    { "description": "Air freight, Sparks to Accra", "quantity": 1, "rate": "310.00" }
  ],
  "payments": [
    {
      "id": "cm2kc2e400020",
      "invoice_id": "cm2kb7d900010",
      "gateway": "BANK_TRANSFER",
      "amount": "333.25",
      "reference": "TRF-88231",
      "receipt_number": "ZPR-2026-00018",
      "created_at": "2026-10-12T09:41:00.000Z"
    }
  ]
}

The invoice object

Field	Type	Description
id	string	Internal id.
invoice_number	string	The number printed on the invoice.
customer_id	string	The customer billed.
shipment_id	string \| null	The shipment this invoice is for, if any.
status	string	See Status values.
subtotal	string	Before tax.
tax_rate	string	Tax rate in percent.
total	string	Amount due including tax.
due_date	string	Payment due date.
created_at	string	When the invoice was created.
line_items	array	Single-invoice response only. Each item: `description`, `quantity`, `rate`.
payments	array	Single-invoice response only. Each payment: `id`, `invoice_id`, `gateway`, `amount`, `reference` (the bank or gateway transaction reference), `receipt_number` (our ZPR receipt number, or null), `created_at`.

Payment gateway is one of STRIPE, PAYSTACK, FLUTTERWAVE, BANK_TRANSFER, WALLET, PAYPAL or CRYPTO.