Credit Notes

Resource 'Credit Notes' operations.

📄️List your credit notes.

Returns the flat list of your credit notes, sorted by most recent first.

📄️Send a credit note (UBL, CII or Factur-X)

Uploads a credit note file to A-Cube. Accepts UBL 2.1 or UN/CEFACT CII XML documents; the syntax is detected automatically from the payload, or upload a Factur-X PDF as a `multipart/form-data` request with the file in the `file` field, A Factur-X PDF is validated as a whole (PDF/A-3 container and embedded XML). For CII and Factur-X the document must carry a credit note type code (BT-3, e.g. 381). Send the `X-Referenced-Invoice-Uuid` header to link the credit note to one of your invoices. The document is validated and transmitted to the network within the request: on success it answers 201 with the credit note already `SUBMITTED`, and a transmission failure is reported as an error, with nothing stored. Send the `X-Send-Async` header to queue the transmission instead: the response is then 202 with the credit note `ACQUIRED`, and it becomes `SUBMITTED` once the network confirms it has been sent, which is reported via the `credit_note.outbound` webhook. Returns 409 when the legal entity the document is addressed from is not onboarded yet.

📄️Get one of your credit notes by uuid

Returns the credit notes matching `uuid`. Responds 404 if the uuid is unknown or belongs to another tenant.

📄️Get the current lifecycle status for a credit note

Returns the current lifecycle status of a credit note.

📄️Get the chronological lifecycle event history for a credit note

Returns the full sequence of lifecycle events recorded upstream for the credit note. Owner-scoped.

📄️Send a lifecycle event for a credit note

Submits a status transition for the invoice (e.g. REFUSED, APPROVED, PAYMENT_RECEIVED). The optional intermediate statuses may be skipped: a mandatory end status (REFUSED, PAYMENT_RECEIVED) can be sent directly from any earlier status. The upstream provider processes the event asynchronously and emits follow-up status callbacks. Returns 202 on success. Returns 422 if `invoiceStatus` is not a known InvoiceStatus value. Owner-scoped.

📄️Download a human-readable PDF rendering of the credit note

Streams a PDF rendering of the credit note.

📄️Download the original credit note payload

Streams the original credit note payload (UBL XML / Factur-X PDF / CII XML) for the invoice identified by `uuid`.