Create credit note
Creates a new credit note.
Business rules
- The credit note must be linked to an existing invoice through
invoiceId. - The credit-note client is always taken from the selected source invoice, so do not send
clientId. - This endpoint does not support inline
clientpayloads, client resolution, or automatic client creation. - The resulting total of the credit note must stay negative; if the payload produces a positive document, the endpoint returns
422.
Payload contract
Unlike the public invoice and proforma APIs, this is an explicit create flow without smart defaults. Send the complete business payload for the document including dates, bank account, symbols, currency, and items.
If you use warehouse allocations on items, the backend processes them as inbound warehouse movements linked to the credit note.
If you send an Idempotency-Key, the same key with the same payload returns the original response without creating the credit note again.
Authorizations
Headers
Body
Payload used to create a credit note. This is an explicit create flow without inline client resolution. You must send the complete business payload including invoiceId, all key document fields, and items. The client is derived automatically from the source invoice and the resulting credit note total must stay negative.
Payment method ID from the payment method reference table.
1
Currency ID from the currency reference table.
1
Language ID from the language reference table.
1
Credit note line items. The resulting document must have a negative total amount.
1 - 100 elementsPayload for a single invoice line item. Three modes are supported: a manual item, priceListItemId + quantity, or priceListItemId with sparse override fields. quantity is always required. If you omit priceListItemId, you must also send name, unitPrice, and vatRate. unitId is optional; when you omit it for a manual item, the backend defaults to unit 1 (piece / Unit::Piece). If you send priceListItemId, the backend can hydrate the name, unit, unit price, and VAT rate from the price list item, and the payload acts only as a sparse override.
- Option 1
- Option 2
Text shown above the line items.
3000"We are crediting part of the original supply."
Response
Credit note created.
Credit note.
Payment method ID from the payment method reference table.
1
Currency ID from the currency reference table.
1
Language ID from the language reference table.
1

