CreditNoteItem

One line of a credit note.

type CreditNoteItem {
  amount: Float!
  description: String!
  discountAmount: Float
  discountPercent: Float
  id: ID!
  productId: String
  quantity: Float!
  taxAmount: Float
  taxBreakdown: JSON
  taxRate: Float
  totalAmount: Float
  unitPrice: Float!
  variantId: String
}

Fields

CreditNoteItem.amount ● Float! non-null scalar

The line amount.

CreditNoteItem.description ● String! non-null scalar

What the credit is for on this line.

CreditNoteItem.discountAmount ● Float scalar

The discount on the line, rounded to the currency.

CreditNoteItem.discountPercent ● Float scalar

The discount on the line, in percent.

CreditNoteItem.id ● ID! non-null scalar

The unique ID of this record.

CreditNoteItem.productId ● String scalar

The ID of the product.

CreditNoteItem.quantity ● Float! non-null scalar

The quantity credited.

CreditNoteItem.taxAmount ● Float scalar

The tax on the line.

CreditNoteItem.taxBreakdown ● JSON scalar

The tax split as a list of tax type, rate and tax amount.

CreditNoteItem.taxRate ● Float scalar

The tax rate on the line, in percent.

CreditNoteItem.totalAmount ● Float scalar

The line total including tax. Prefer this over amount, which means something different on a manual note and a return-based note.

CreditNoteItem.unitPrice ● Float! non-null scalar

The price of one unit.

CreditNoteItem.variantId ● String scalar

The ID of the product variant.

Member Of

CreditNote object