Credit Notes
List credit notes
Returns a paginated list of credit notes for your company, optionally filtered by status and customer.
Required Scope
invoices-read
query Parameters
pagePage number (1-indexed)
limitNumber of items per page
searchFree-text search (credit note number, description)
statusFilter credit notes by status
customerIdFilter credit notes for a specific customer
List credit notes › Responses
Paginated list of credit notes
Credit notes on this page (line items omitted; GET one for lines)
totalTotal credit notes matching the query
pageCurrent page (1-indexed)
limitItems per page
totalPagesTotal pages
Create a credit note
Creates a credit note. Pass invoiceNumber to credit an existing invoice; the referenced invoice is then marked credited.
Required Scope
invoices-write
Headers
x-api-idempotency-keyOptional idempotency key for safely retrying mutating requests.
Create a credit note › Request Body
customerIdCustomer ID this credit note is for
dateCredit note date (ISO date, YYYY-MM-DD)
Credit note lines
customerDepartmentIdCustomer department ID (for EAN-based e-invoicing and address override)
customerContactIdCustomer contact ID (credit note recipient)
invoiceNumberOriginal invoice number this credit note credits. When set, the referenced invoice is marked credited.
currencyCurrency code (ISO 4217). Defaults to the company default currency.
referenceReference / PO number ("PO-nr.")
ourReferenceOur reference ("Vores ref.")
descriptionOptional description of the credit note
notesAdditional notes or comments
Create a credit note › Responses
Credit note created successfully
idCredit note ID
numberCredit note number
statusCredit note status
dateCredit note date (ISO date)
currencyCurrency code (ISO 4217)
subtotalSubtotal before VAT (decimal string)
vatVAT amount (decimal string)
amountTotal amount including VAT (decimal string)
Credit note lines
createdAtCreation timestamp (ISO)
updatedAtLast update timestamp (ISO)
invoiceNumberOriginal invoice number this credit note credits
customerIdCustomer ID
customerSubscriptionIdThe subscription this credit note credits, when it credits exactly one. Null on a billing group’s credit note (see billingGroupId) and on a manually created one.
billingGroupIdThe billing group this credit note is issued to, when it credits a group’s shared invoice. Set instead of customerSubscriptionId, never alongside it.
referenceReference / PO number
ourReferenceOur reference ("Vores ref.")
notesAdditional notes
Get a credit note
Retrieves a single credit note by its unique identifier. Returns 404
when the credit note does not exist in your company. For the rendered
document, use the PDF endpoint.
Required Scope
invoices-read
path Parameters
idCredit Note ID
Get a credit note › Responses
The credit note
idCredit note ID
numberCredit note number
statusCredit note status
dateCredit note date (ISO date)
currencyCurrency code (ISO 4217)
subtotalSubtotal before VAT (decimal string)
vatVAT amount (decimal string)
amountTotal amount including VAT (decimal string)
Credit note lines
createdAtCreation timestamp (ISO)
updatedAtLast update timestamp (ISO)
invoiceNumberOriginal invoice number this credit note credits
customerIdCustomer ID
customerSubscriptionIdThe subscription this credit note credits, when it credits exactly one. Null on a billing group’s credit note (see billingGroupId) and on a manually created one.
billingGroupIdThe billing group this credit note is issued to, when it credits a group’s shared invoice. Set instead of customerSubscriptionId, never alongside it.
referenceReference / PO number
ourReferenceOur reference ("Vores ref.")
notesAdditional notes
Get the delivery status of a credit note
Returns an aggregate send summary plus a per-attempt delivery log for the credit note.
Required Scope
invoices-read
path Parameters
idCredit Note ID
Get the delivery status of a credit note › Responses
Delivery status
Aggregate send summary
Per-attempt delivery log entries
Download the credit note PDF
Streams the rendered credit note PDF. Pass draft=true to render a draft watermark version (generated on the fly).
Required Scope
invoices-read
path Parameters
idCredit Note ID
query Parameters
draftRender a draft watermark version
Download the credit note PDF › Responses
Bad Request
statusCodetimestamppathmessageSend a credit note to the customer
Sends the credit note over the chosen delivery channel (Email, Sproom e-invoicing, or Manual).
Required Scope
invoices-write
path Parameters
idCredit Note ID
Headers
x-api-idempotency-keyOptional idempotency key for safely retrying mutating requests.
Send a credit note to the customer › Request Body
deliveryTypeDelivery channel
overrideEmailOverride recipient email for this send only
overrideEanNumberOverride EAN number for this send only
updateCustomerRecordPersist the override email / EAN onto the customer record
documentTemplateIdOverride document template for PDF generation
Send a credit note to the customer › Responses
Credit note send accepted
successWhether the send was accepted
deliveryTypeThe delivery channel the document was sent through
sproomDocumentIdSproom document ID when sent via e-invoicing
Credit a whole invoice
Creates a draft credit note that reverses every line of invoiceId, without
restating them. The credit carries the invoice's own VAT rates and per-line
dimensions and is linked line-by-line to what it credits, so the invoice flips
to credited once the credit note is sent — none of which a line-by-line
POST /credit-notes can reproduce.
Returns 400 when the invoice is a draft, already credited, has no invoice
number, or carries no lines — a credit with nothing to reverse would be a
sendable document crediting nothing.
Required Scope
invoices-write
path Parameters
invoiceIdID of the invoice to credit in full
Headers
x-api-idempotency-keyOptional idempotency key for safely retrying mutating requests.
Credit a whole invoice › Responses
Draft credit note created for the whole invoice
idCredit note ID
numberCredit note number
statusCredit note status
dateCredit note date (ISO date)
currencyCurrency code (ISO 4217)
subtotalSubtotal before VAT (decimal string)
vatVAT amount (decimal string)
amountTotal amount including VAT (decimal string)
Credit note lines
createdAtCreation timestamp (ISO)
updatedAtLast update timestamp (ISO)
invoiceNumberOriginal invoice number this credit note credits
customerIdCustomer ID
customerSubscriptionIdThe subscription this credit note credits, when it credits exactly one. Null on a billing group’s credit note (see billingGroupId) and on a manually created one.
billingGroupIdThe billing group this credit note is issued to, when it credits a group’s shared invoice. Set instead of customerSubscriptionId, never alongside it.
referenceReference / PO number
ourReferenceOur reference ("Vores ref.")
notesAdditional notes