APIReferenceInvoices

Invoices

Archived invoices are not returned. Archiving is how the Novex UI removes an invoice, so an archived row disappears from both GET /invoices and GET /invoices/{id} — the detail route returns 404. There is no way to read an archived invoice through the API.

GET /invoices

curl -sS "https://nov3x.com/api/public/v1/invoices?status=PAID" \
  -H "Authorization: Bearer nvx_live_your_key_here"

Scope: invoices.read

Query parameters

ParameterTypeNotes
limitintegerPage size, 1–100. Defaults to 25.
cursorstringFrom the previous response’s meta.cursor.
updatedSinceISO 8601Only invoices updated at or after this instant.
statusstringFilter by invoice status, e.g. PAID.
eventIdstringRestrict to invoices attached to one event.

GET /invoices/{id}

Returns 404 if the invoice is not in your workspace.

Fields

FieldTypeNotes
idstringStable identifier
numberstringHuman-facing invoice number
statusstringe.g. PAID
totalstringTotal amount — a string, see below
currencystringe.g. SAR
issueDateISO 8601Issue date
dueDateISO 8601Due date
createdAtISO 8601Created
updatedAtISO 8601Last modified — use for sync

⚠️ total is a string, not a number. Amounts are exact decimals, and JSON numbers are floating point — parsing 1234.56 into a float and back is how invoices end up a halala out. Feed the string straight into your decimal type and never into a float.

Read-only

Invoices cannot be created or modified through the API, and that is not an oversight. An invoice carries Saudi e-invoicing (ZATCA) submission state tied to a government clearance lifecycle — that is a compliance surface, not a CRUD one, and it deserves its own design rather than arriving as a side effect of a read API.

The ZATCA fields themselves (submission UUID, signed XML, hashes, clearance timestamps) are not returned by this API for the same reason.

What is not included

The money breakdown — subtotal, VAT, discounts, amount paid, balance due — is not returned in v1. If you are reconciling payments and need it, tell us; it is a non-breaking addition.