Credit invoice amount
credit_invoiceIssue a credit note against an invoice, crediting the full remaining balance or a specified amount. Choose refund to original payment source or wallet.
Instructions
Issue a credit note against an invoice. Omit amount to credit the full remaining amount, or set full_credit=true. refund_source: 0 = original payment source, 1 = wallet. DESTRUCTIVE: moves money / changes billing records.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| amount | No | Amount in invoice currency (omit = remaining) | |
| invoice_id | Yes | Invoice UUID | |
| full_credit | No | Credit the full uncredited amount | |
| refund_source | No | 0 original source, 1 wallet only | |
| force_paid_status | No | Force invoice status to Paid afterwards |