List credit notes
Returns a paginated list of credit notes. Filters use the unified field.op=value grammar; see /docs/pagination for the operator set.
query Parameters
limitPage size
cursorPagination cursor
statusFilter by status; supports .eq, .ne, .in operators
customer_idFilter by customer id; supports .eq, .in operators
invoice_idFilter by invoice id; supports .eq, .in operators
currencyFilter by currency; supports .eq, .in operators
credit_note_numberFilter by credit_note_number; supports .eq, .contains operators
reason_codeFilter by reason_code; supports .eq, .in operators
issued_atFilter by issued_at; supports .eq, .gt, .gte, .lt, .lte operators
created_atFilter by created_at; supports .eq, .gt, .gte, .lt, .lte operators
updated_atFilter by updated_at; supports .eq, .gt, .gte, .lt, .lte operators
List credit notes › Responses
Paginated list with data and pagination envelope
created_atcredit_note_numbercurrencycustomer_iddeleted_atidinvoice_idissued_atorganization_idreasonreason_codestatusupdated_atvoided_atCreate a credit note
Creates a credit note in draft status - it is not yet posted to the customer ledger. Use POST /v1/credit-notes/{id}/issue to finalize, or POST /v1/credit-notes/{id}/void to discard. The credit_note_number is allocated at issue time, not at creation.
Create a credit note › Request Body
currencycustomer_idinvoice_idreasonreason_codetemplate_idCreate a credit note › Responses
Newly created credit note (draft)
created_atcredit_note_numbercurrencycustomer_iddeleted_atidinvoice_idissued_atorganization_idreasonreason_codestatusupdated_atvoided_atGet a credit note
Returns a single credit note by UUID, including its line items.
path Parameters
idCredit note UUID
Get a credit note › Responses
Credit note
created_atcredit_note_numbercurrencycustomer_iddeleted_atidinvoice_idissued_atorganization_idreasonreason_codestatusupdated_atvoided_atList credit note applications
Returns every application of this credit note - i.e. invoices it was applied against and refunds issued from it, with the per-application amount.
path Parameters
idCredit note UUID
List credit note applications › Responses
Applications wrapped in data envelope
amountapplied_atcreated_atcredit_note_ididinvoice_idorganization_idApply a credit note
Applies a portion (or all) of the credit note's remaining balance - either against an open invoice or as a cash refund (when the request includes a refund target). Decreases the credit note's available balance and records a credit_note_application row. Emits creditnotepkg.applied.
path Parameters
idCredit note UUID
Apply a credit note › Responses
Newly created application
amountapplied_atcreated_atcredit_note_ididinvoice_idorganization_idIssue a credit note
Finalizes a draft credit note: allocates the credit_note_number, posts it to the customer ledger, and emits the creditnotepkg.issued event. Once issued, the line items and totals are immutable - only Apply and Void state transitions are allowed.
path Parameters
idCredit note UUID
Issue a credit note › Responses
Issued credit note
created_atcredit_note_numbercurrencycustomer_iddeleted_atidinvoice_idissued_atorganization_idreasonreason_codestatusupdated_atvoided_atDownload credit-note PDF
Generates or retrieves the credit-note PDF (visual layout, distinct from the XRechnung XML at /xrechnung). Streams the bytes directly. Drafts are rejected - credit_note_number is allocated at issue time and must be present in the printed document.
path Parameters
idCredit note UUID
Download credit-note PDF › Responses
PDF file
Regenerate credit-note PDF
Re-queues a document.requested event so the document worker re-renders and archives the PDF. Use this when the PDF is missing after the grace window (e.g. the worker was down at issue time). The endpoint is idempotent: submitting it twice enqueues two worker jobs but the archive's content-hash dedup prevents a second write if the PDF already exists.
path Parameters
idCredit note UUID
Regenerate credit-note PDF › Responses
PDF regeneration queued
Void a credit note
Marks the credit note as void. A draft is voided in place; an issued credit note is voided only if it has no applications (otherwise reverse those first). Emits the creditnotepkg.voided event.
path Parameters
idCredit note UUID
Void a credit note › Responses
Voided credit note
created_atcredit_note_numbercurrencycustomer_iddeleted_atidinvoice_idissued_atorganization_idreasonreason_codestatusupdated_atvoided_atDownload XRechnung XML for a credit note
Returns the customer's available credit balance, broken down by currency. Sums the unapplied portion of every issued, non-voided credit note for the customer. Generates an EN 16931-compliant XRechnung 3.0 (CII XML) credit-note document. Includes BillingReference (BG-3) pointing back at the original invoice when the credit note is anchored to one. Only valid for issued / partially_applied / applied credit notes - drafts return 409.
path Parameters
idCustomer UUID
idCredit note UUID
Download XRechnung XML for a credit note › Responses
XRechnung XML file
Download XRechnung XML for a credit note
Returns the customer's available credit balance, broken down by currency. Sums the unapplied portion of every issued, non-voided credit note for the customer. Generates an EN 16931-compliant XRechnung 3.0 (CII XML) credit-note document. Includes BillingReference (BG-3) pointing back at the original invoice when the credit note is anchored to one. Only valid for issued / partially_applied / applied credit notes - drafts return 409.
path Parameters
idCustomer UUID
idCredit note UUID
Download XRechnung XML for a credit note › Responses
XRechnung XML file