Create credit note
Creates a new credit note in draft status. The credit note can be created with or without line items. When documentNumber is provided, it is used for idempotency — retrying a create with the same documentNumber returns the existing credit note instead of creating a duplicate. The areLinesWithTax field controls whether line amounts include tax (true = gross, tax included) or exclude tax (false = net, tax added on top). A businessPartnerId (vendor) is required if the credit note will be linked to an invoice payable later. The posting date is automatically set to the documentDate.
Authorizations
Basic authentication header of the form Basic <api_key>, where <api_key> is your api key.
Headers
Body
ID of the entity
"USD"
Date when the credit note was issued
ID of the vendor (required if the credit note will be linked to an invoice payable)
Description of the credit note
Total credit note amount in cents
Whether line amounts include tax. true = tax included (gross), false = tax added on top (net)
Unique credit note number. When provided, it is also used for idempotency — retrying a create with the same documentNumber returns the existing credit note. If omitted, a number is generated automatically.
List of custom properties
List of custom properties to set on the vendor. Replaces the existing set.
List of credit note line items
Response
default response
Unique identifier for the object
ID of the company
ID of the entity
Total credit note amount in cents
Name of the vendor
ID of the vendor
Status of the credit note
⚠️ This enum is not exhaustive; new values may be added in the future.
DRAFT, POSTED, PARTIALLY_CLEARED, CLEARED, ARCHIVED Description of the credit note
"USD"
Date when the credit note should be posted to the ledger
Date when the credit note was issued
Date used when applying foreign exchange rate
Whether the credit note line amount is inclusive of tax or not. True means tax is already included in the line amount and will not be added on top, false means tax will be added on top of the line amount
List of credit note line items
Timestamp when the credit note was created
Timestamp when the credit note was last updated
ID of the user who last updated the credit note
The email of the user who sent the document that this credit note was created from
The name of the document that this credit note was created from