← API reference
CANONICAL TYPE REFERENCE

CreditNoteLineInput

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

Text describing what is being credited; becomes the credit-note line's description.

Number of units credited. The line total is quantity × unitPrice, which also feeds the credit note's subtotal.

unitPriceFloat!

Amount credited per unit, in the original invoice's currency.

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.

taxRateFloat

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.

View exact SDL
"""
A single line on a credit note, used to credit part of an invoice rather than the whole of it.
"""
input CreditNoteLineInput {
  """
  Text describing what is being credited; becomes the credit-note line's description.
  """
  description: String!
  """
  Number of units credited. The line total is `quantity × unitPrice`, which also feeds the credit note's subtotal.
  """
  quantity: Int!
  """Amount credited per unit, in the original invoice's currency."""
  unitPrice: Float!
  """
  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.
  """
  orderLineId: OrderLineID
  """
  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.
  """
  taxRate: Float
}

One stable address across all schema views. Follow a field’s type to explore connections between domains.