CreateCreditNoteItemInput

One line of a new credit note.

input CreateCreditNoteItemInput {
  amount: Float!
  description: String!
  discountAmount: Float
  discountAmountExact: Float
  discountPercent: Float
  productId: String
  quantity: Float!
  taxAmount: Float
  taxBreakdown: JSON
  taxRate: Float
  unitPrice: Float!
  variantId: String
}

Fields

CreateCreditNoteItemInput.amount ● Float! non-null scalar

The line amount.

CreateCreditNoteItemInput.description ● String! non-null scalar

What the credit is for on this line.

CreateCreditNoteItemInput.discountAmount ● Float scalar

The discount on the line, rounded to the currency.

CreateCreditNoteItemInput.discountAmountExact ● Float scalar

The exact discount for the full line quantity, before rounding. When left out it is worked out from the percent and the amount.

CreateCreditNoteItemInput.discountPercent ● Float scalar

The discount on the line, in percent.

CreateCreditNoteItemInput.productId ● String scalar

The ID of the product.

CreateCreditNoteItemInput.quantity ● Float! non-null scalar

The quantity credited.

CreateCreditNoteItemInput.taxAmount ● Float scalar

The tax on the line.

CreateCreditNoteItemInput.taxBreakdown ● JSON scalar

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

CreateCreditNoteItemInput.taxRate ● Float scalar

The tax rate on the line, in percent.

CreateCreditNoteItemInput.unitPrice ● Float! non-null scalar

The price of one unit.

CreateCreditNoteItemInput.variantId ● String scalar

The ID of the product variant.

Member Of

CreateCreditNoteInput input