Skip to main content

Create Supplementary Sales Invoice

POST 

/api/sales-invoices/:salesInvoice/supplementary

Bill an extra amount on this invoice's sales order — for under-billing such as a price adjustment or a missed charge — without touching the issued invoice. Adds a one-off revenue charge of amount to the order and creates a new invoice for exactly that charge, as a draft or issued straight away.

Required scope: orders:write

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Body

  • description (string, required, up to 255 characters): what the invoice bills, e.g. "Price adjustment"; printed as the line description
  • amount (number, required, greater than 0): the amount to bill, in the order's currency
  • issue (boolean, optional, default false): issue the new invoice immediately

Returns 201 with the new invoice. Returns 422 when the invoice covers several orders (create it from the order instead) or the order cannot be invoiced.

Requires orders:write and sales_invoices.create.

Request​

Responses​

Created

Response Headers
    Content-Type