Create credit note draft
Creates a persisted credit note in `draft` status against an already-issued source invoice.
Contexte financier
Create credit note draft
Finance
Typed result
Vue d’ensemble
Creates a persisted credit note in draft status against an already-issued source invoice.
Exemple
Prepare a credit note after an accepted return before issuance and any refund.
Parameters 6
source_invoice
Issued invoice against which the credit note is prepared. The credit note remains linked to this source document.
amount_excluding_tax
Amount excluding tax in minor monetary units. When lines are supplied, consistent totals may be derived from those lines.
amount_tax
Tax amount in minor monetary units.
amount_including_tax
Total amount including tax in minor monetary units.
line_items
Detailed document lines. They carry product/service detail and can be used to derive totals when the contract allows it.
metadata
Free-form integration metadata associated with the resource according to the flat
common.metadata contract.Outputs 1
credit_note
Canonical credit note created in
draft status and linked to the source invoice.Behavior
The created document remains linked to the source invoice and carries the amounts or lines that will be credited when the credit note continues through its lifecycle.
Key point Always distinguish the canonical object created by Ormuz from any external effect. A payment or refund intent in
draft status does not prove that a provider executed the movement of funds.Limits and responsibilities
- The node prepares the credit note but does not issue it.
- Creating a credit note performs no cash refund; that must be materialized separately according to the original payment.