Issue a credit note
credit_note_createIssue a credit note against an invoice or standalone, with recipient, reason, line items, tax, and currency. Returns a revisable draft before final numbering.
Instructions
Issue a credit note against an invoice, or standalone: the recipient, the reason (returned goods, overcharge, discount correction, service issue, other), line items with quantity, unit price and tax rate, and the currency. Returns a draft you can still revise; credit_note_finalize burns the final CN number.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| lines | Yes | What is being credited, line by line | |
| notes | No | Text printed at the foot of the document, e.g. how the credit will be settled | |
| reason | Yes | Why the credit is issued: returned_goods, overcharge, discount_correction, service_issue or other | |
| currency | Yes | ISO code the credit is in | |
| recipient | Yes | Who the credit is for, e.g. Acme GmbH | |
| issue_date | No | The date the credit is issued, YYYY-MM-DD. Default today; a future date is refused | |
| invoice_ref | No | The invoice this credits, e.g. INV-2026-0042. Omit for a standalone credit | |
| duplicate_ok | No | Create it even though an identical draft or note exists, for a genuinely repeated credit. Default false | |
| reason_detail | No | One line of specifics, e.g. Client was billed 10 seats, used 7 |