API reference

Invoices

NQD API Invoices reference. List invoices; Retrieve invoice; Create invoices

OpenAPI JSON
GET /v1/invoices
List invoices
GET /v1/invoices/{invoiceId}
Retrieve invoice
POST /v1/invoices
Create invoices
PUT /v1/invoices/{invoiceId}
Upsert invoice
DELETE /v1/invoices/{invoiceId}
Delete invoice
PUT /v1/invoices
Upsert invoices in a batch
GET /v1/invoices/{invoiceId}/entries
List applied entries for an invoice
POST /v1/invoices/{invoiceId}/entries
Add applied entry to an invoice
PATCH /v1/invoices/{invoiceId}/entries/{entryId}
Partially update applied entry on an invoice
DELETE /v1/invoices/{invoiceId}/entries/{entryId}
Remove applied entry from an invoice
PUT /v1/invoices/{invoiceId}/entries/reorder
Reorder applied entries for an invoice
GET /v1/invoices/{invoiceId}/modifiers
List applied modifiers for an invoice
POST /v1/invoices/{invoiceId}/modifiers
Add applied modifier to an invoice
PATCH /v1/invoices/{invoiceId}/modifiers/{modifierId}
Partially update applied modifier on an invoice
DELETE /v1/invoices/{invoiceId}/modifiers/{modifierId}
Remove applied modifier from an invoice
PUT /v1/invoices/{invoiceId}/modifiers/reorder
Reorder applied modifiers for an invoice
GET /v1/invoices/{sourceId}/transactions
List transactions
POST /v1/invoices/{sourceId}/transactions
Record a payment

Every operation uses the same Core contract as the dashboard. Request and response fields, examples, and code samples are generated from the current API descriptor.