Credit Notes
List credit notes
Credential: a company's API key or OAuth token.
Returns a paginated list of credit notes for your company, optionally filtered by status and customer.
Required Scope
invoices-read
query Parameters
cursorOpaque cursor from the previous response's nextCursor. Returns the rows after it, in the same order. Send the same filters and sort as the request that produced it, and do not send page. The preferred way to page through a list.
pageDeprecated: page with cursor instead. Page number (1-indexed). From 2026-12-31, a page past the first of a list with more than 10,000 matching rows is refused.
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
limitItems per page
nextCursorCursor for the next page; pass it as cursor. null on the last page, and on every page of a sort that cannot page by cursor — hasMore then says whether another page follows by page number.
hasMoreWhether more rows follow this page.
pageDeprecated: page with nextCursor instead. Current page (1-indexed).
totalPagesDeprecated: page with nextCursor instead. Total pages.
Create a credit note
Credential: a company's API key or OAuth token.
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.")
descriptionInternal description for your own reference. Never printed on the PDF or shown to the customer: put text for the customer in subject and notes.
subjectHeading printed in bold on the PDF, directly above notes. The customer sees it on the document.
notesMessage printed on the PDF under subject. The customer sees it on the document.
tagIdsTag/Dimension value IDs to attach to the journal entry when this credit note is booked. Use the per-line tagIds for a dimension that differs between lines.
discountIdsDocument-scope discount records to apply once to the whole document, after every line discount, reducing the lines whose product each applies to (every line when it names no product). Each id is a discount record (see GET /discounts). The order sent is the order they apply in. Each is checked for the line's product, the document's customer and the document date; a document converted from a quote is checked at the quote's date. A fixed or per-unit discount takes its amount in the document's currency: a discount with no amount in that currency is refused, never converted at an exchange rate. One applies when it applies to the customer and to at least one line's product. A credit note that names invoiceNumber takes none: it gives back the discounts that invoice used, and is refused with DISCOUNT_CREDIT_NOTE_FOLLOWS_INVOICE if it sends any. Refused with: DISCOUNT_NOT_APPLICABLE (no such discount in your company, inactive, not assigned to this product and customer, or outside its dates on the document date; details.reason says which), DISCOUNT_WRONG_SCOPE, DISCOUNT_REFERENCED_TWICE, DISCOUNT_NOT_COMBINABLE, DISCOUNT_NO_AMOUNT_IN_CURRENCY, DISCOUNT_LINE_WITHOUT_PRODUCT, DISCOUNT_EXCEEDS_LINE and DISCOUNT_EXCEEDS_DOCUMENT.
Create a credit note › Responses
Credit note created successfully
idCredit note ID
numberCredit note number. Null until the credit note is sent; every sent credit note has one.
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
The document-scope discount records the document referenced, in the order they applied, each applied once after every line discount. Empty when it referenced none.
totalDiscountedWhat the document's discounts took off in all, in the document's currency: each line's amount before discounts less its amount after them, plus the document discounts. A line discount typed by hand in LedgerBee counts too. Null when the document references no discount record.
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.")
subjectHeading printed in bold on the PDF, directly above notes. The customer sees it on the document.
notesMessage printed on the PDF under subject. The customer sees it on the document.
Get a credit note
Credential: a company's API key or OAuth token.
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. Null until the credit note is sent; every sent credit note has one.
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
The document-scope discount records the document referenced, in the order they applied, each applied once after every line discount. Empty when it referenced none.
totalDiscountedWhat the document's discounts took off in all, in the document's currency: each line's amount before discounts less its amount after them, plus the document discounts. A line discount typed by hand in LedgerBee counts too. Null when the document references no discount record.
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.")
subjectHeading printed in bold on the PDF, directly above notes. The customer sees it on the document.
notesMessage printed on the PDF under subject. The customer sees it on the document.
Get the delivery status of a credit note
Credential: a company's API key or OAuth token.
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
Credential: a company's API key or OAuth token.
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
Credential: a company's API key or OAuth token.
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
Credential: a company's API key or OAuth token.
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. Null until the credit note is sent; every sent credit note has one.
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
The document-scope discount records the document referenced, in the order they applied, each applied once after every line discount. Empty when it referenced none.
totalDiscountedWhat the document's discounts took off in all, in the document's currency: each line's amount before discounts less its amount after them, plus the document discounts. A line discount typed by hand in LedgerBee counts too. Null when the document references no discount record.
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.")
subjectHeading printed in bold on the PDF, directly above notes. The customer sees it on the document.
notesMessage printed on the PDF under subject. The customer sees it on the document.