Appearance
CreditNoteLineInput
Type: Input
A single line on a credit note, used to credit part of an invoice rather than the whole of it.
Fields
| Name | Type | Default | Description |
|---|---|---|---|
| description | String! | Text describing what is being credited; becomes the credit-note line's description. | |
| orderLineId | OrderLineID | Optional TypeID (oln_…) of the order line this credit relates back to. Omit for a credit that is not attributable to a specific order line. | |
| quantity | Int! | Number of units credited. The line total is quantity × unitPrice, which also feeds the credit note's subtotal. | |
| taxRate | Float | Tax rate recorded on this credit-note line, as a fraction (0.2 = 20%). Recorded on the line only — the credit note's tax total is computed from the original invoice's tax rate. | |
| unitPrice | Float! | Amount credited per unit, in the original invoice's currency. |