Skip to content

CreditNoteLineInput ​

Type: Input

A single line on a credit note, used to credit part of an invoice rather than the whole of it.

Fields ​

NameTypeDefaultDescription
descriptionString!Text describing what is being credited; becomes the credit-note line's description.
orderLineIdOrderLineIDOptional TypeID (oln_…) of the order line this credit relates back to. Omit for a credit that is not attributable to a specific order line.
quantityInt!Number of units credited. The line total is quantity × unitPrice, which also feeds the credit note's subtotal.
taxRateFloatTax 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.
unitPriceFloat!Amount credited per unit, in the original invoice's currency.

Connect machines, automate workflows, and build custom apps for print production.