Refunds Schema
The Refunds schema models refund information.
Field | Details | Description |
---|---|---|
refund_note_url | Type: String | Refund note image URL. |
refund_note_number | Type: String | Sequential refund note number. |
refund_key | Type: String | Refund identifier. |
line_key | Type: String | Line identifier. If neither line key or custom id is provided, the refund amount will be assigned to lines in order. |
refund_timestamp | Type: String | Refund timestamp in UTC timezone. |
refund_note_number_expanded | Type: String | Refund note number with CN-{invoice-number}-{refund-number} pattern. |
amount | Type: Number | Amount, excluding tax, that was refunded. |
informative | Type: Boolean | Indicates whether the refund was applied to an informative line. |
tax_amount | Type: Number | The amount of tax that is refunded. |
tax_rate | Type: Number | The tax rate that is used to calculate the refund. |
total_amount | Type: Number | The total amount, including tax that is refunded. |
refund_reason | Type: String | The justification for the refund. This is reproduced on the credit note. |
Updated 9 months ago