Invoices

Create, read, amend, cancel, reactivate and delete invoices, and reach their lines, notes, files, fulfillments and returns.

An invoice bills an account for items, either on its own or raised from an order. This area has 30 endpoints: create, read, update, amend, cancel, reactivate and delete invoices; raise an invoice for an order; read their lines, KPIs and PDF links; add, read and delete notes and note files; and read their fulfillments, return merchandise authorisations and custom objects. Every SDK supports all of them.

At a glance

Endpoint	Method	Path	What it does
List invoices	GET	/invoices	Returns one page of invoices, with a cursor for the next page.
Retrieve an invoice	GET	/invoices/{invoice_id}	Returns one invoice by its id, including its lines.
Retrieve an invoice’s information	GET	/invoices/{invoice_id}/information	Returns an invoice’s core information, without its lines.
Retrieve an invoice’s PDF links	GET	/invoices/{invoice_id}/pdf	Returns links to the invoice’s PDF, not the PDF file itself.
Create an invoice	POST	/invoices	Creates an invoice for an account and returns it.
Update an invoice’s information	PATCH	/invoices/{invoice_id}/information	Changes an invoice’s note or customer purchase order number and returns the invoice.
Amend an invoice	POST	/invoices/{invoice_id}/amend	Adds, changes or removes invoice lines and returns the invoice.
Cancel an invoice	POST	/invoices/{invoice_id}/cancel	Cancels an invoice and returns it with status inactive.
Reactivate an invoice	POST	/invoices/{invoice_id}/reactivate	Reactivates a cancelled invoice and returns it with status active.
Delete an invoice	DELETE	/invoices/{invoice_id}	Deletes an invoice.
List an invoice’s item fulfillments	GET	/invoices/{invoice_id}/item_fulfillments	Returns one page of the item fulfillments recorded against an invoice.
Retrieve an invoice’s item fulfillment	GET	/invoices/{invoice_id}/item_fulfillments/{fulfillment_id}	Returns one item fulfillment recorded against an invoice.
List an invoice’s return merchandise authorisations	GET	/invoices/{invoice_id}/return_merchandise_authorisations	Returns one page of the return merchandise authorisations raised against an invoice.
Retrieve an invoice’s return merchandise authorisation	GET	/invoices/{invoice_id}/return_merchandise_authorisations/{rma_id}	Returns one return merchandise authorisation raised against an invoice.
List an invoice’s notes	GET	/invoices/{invoice_id}/notes	Returns one page of the notes on an invoice.
Retrieve an invoice note	GET	/invoices/{invoice_id}/notes/{note_id}	Returns one note on an invoice.
Create an invoice note	POST	/invoices/{invoice_id}/notes	Adds a note, and optionally a file, to an invoice and returns the note.
Delete an invoice note	DELETE	/invoices/{invoice_id}/notes/{note_id}	Deletes a note from an invoice.
List an invoice note’s files	GET	/invoices/{invoice_id}/notes/{note_id}/files	Returns the files attached to a note on an invoice.
Retrieve an invoice note file	GET	/invoices/{invoice_id}/notes/{note_id}/files/{file_id}	Returns the details of one file attached to a note, not the file’s contents.
List an order’s invoices	GET	/orders/{order_id}/invoices	Returns one page of the invoices raised for an order.
Create an invoice for an order	POST	/orders/{order_id}/invoices	Raises an invoice against an order and returns it.
Retrieve an invoice’s KPIs	GET	/invoices/{invoice_id}/kpis	Returns an invoice’s key figures, such as payment applied and amount outstanding.
List an invoice’s lines	GET	/invoices/{invoice_id}/lines	Returns all the lines of an invoice.
Retrieve an invoice line	GET	/invoices/{invoice_id}/lines/{line_id}	Returns one line of an invoice.
Retrieve a credit note application through an invoice	GET	/invoices/{invoice_id}/credit_note_applications/{credit_note_application_id}	Returns one credit note application by its id.
List an invoice’s custom objects	GET	/invoices/{invoice_id}/custom_objects	Returns one page of the custom objects defined for invoices.
Retrieve an invoice’s custom object	GET	/invoices/{invoice_id}/custom_objects/{custom_object_id}	Returns one custom object with this invoice’s instances of it.
Retrieve an invoice’s custom object instance	GET	/invoices/{invoice_id}/custom_objects/{custom_object_id}/instances/{instance_id}	Returns one instance of a custom object on an invoice.
Delete an invoice note file	DELETE	/invoices/{invoice_id}/notes/{note_id}/files/{file_id}	Deletes one file from a note on an invoice.

Before you call

Register your API credentials once when your app starts, as shown in Authentication. Every SDK sample on these pages then gets its client in one line. With cURL, send the access token in an Authorization header: Authorization: Bearer $ACCESS_TOKEN.

Things to know

• Pass an invoice’s id, never its uuid. Every {invoice_id} is the invoice’s id, such as INV-0001.
• Write bodies go under an invoice key. Create, update, amend, cancel and reactivate all wrap their fields in invoice. Amend, cancel, reactivate and creating an invoice for an order also work with no body.
• Money comes back as text. Amounts such as total, subtotal and due are strings like "12.00". discount_amount and a line’s tax rate are numbers.
• The invoice listing pages by cursor. Records are under data. Pass pagination.next_cursor back as cursor while pagination.has_more is true.
• Only a single read carries the lines. A listing entry has no lines; retrieve the invoice, or list its lines, to see them.
• Some reads under an invoice do not check the invoice. The credit note application read returns any application under any invoice that exists.