Skip to main content

InvoiceItem

One line on an invoice: the product or variant billed, quantity, price, tax and discount.

type InvoiceItem {
  acceptAlternativeIfUnavailable: Boolean!
  conversionFactor: Float
  description: String!
  discountAmount: Float!
  discountPercent: Float!
  grnItemId: String
  id: ID!
  invoiceId: String!
  product: Product
  productId: String!
  quantity: Float!
  returnableQuantity: Float
  returnedQuantity: Float
  salesOrderItemId: String
  taxAmount: Float!
  taxBreakdown: JSON
  taxGroupId: String
  taxRate: Float!
  taxRateIds: String
  totalAmount: Float!
  unitPrice: Float!
  uomId: ID
  uomName: String
  variant: ProductVariant
  variantId: String
  warehouseId: String
}

Fields​

InvoiceItem.acceptAlternativeIfUnavailable ● Boolean! non-null scalar​

Buyer consent: if this item becomes unavailable, may fulfillment ship a manually-picked substitute instead? Consent + visibility only.

InvoiceItem.conversionFactor ● Float scalar​

How many base units one unit of the line's unit of measure equals.

InvoiceItem.description ● String! non-null scalar​

Free-text description of the line.

InvoiceItem.discountAmount ● Float! non-null scalar​

Total discount amount on the line.

InvoiceItem.discountPercent ● Float! non-null scalar​

The line discount as a percentage.

InvoiceItem.grnItemId ● String scalar​

The ID of the goods receipt line this line bills, on a purchase invoice.

InvoiceItem.id ● ID! non-null scalar​

Unique identifier of the record.

InvoiceItem.invoiceId ● String! non-null scalar​

The ID of the invoice this line belongs to.

InvoiceItem.product ● Product object​

The product on this line.

InvoiceItem.productId ● String! non-null scalar​

The ID of the product on this line.

InvoiceItem.quantity ● Float! non-null scalar​

Quantity invoiced, in the line's unit of measure.

InvoiceItem.returnableQuantity ● Float scalar​

The quantity a new sales return may still take for this line: invoiced less already returned, and never more than its sales order line has left (returns made against the order count too); never below zero. Only set when a single sales invoice is fetched.

InvoiceItem.returnedQuantity ● Float scalar​

The quantity of this line no longer returnable because it is on live sales returns, through this invoice or through the sales order it was raised from, in the line's unit. Only set when a single sales invoice is fetched.

InvoiceItem.salesOrderItemId ● String scalar​

The ID of the sales order line this line bills, on a sales invoice.

InvoiceItem.taxAmount ● Float! non-null scalar​

Total tax on the line.

InvoiceItem.taxBreakdown ● JSON scalar​

Tax applied to this line, as a list of { taxName, taxCode, taxType, rate, taxAmount }.

InvoiceItem.taxGroupId ● String scalar​

The ID of the tax group applied to this line.

InvoiceItem.taxRate ● Float! non-null scalar​

The tax rate applied to the line, as a percentage.

InvoiceItem.taxRateIds ● String scalar​

The IDs of the tax rates applied to this line.

InvoiceItem.totalAmount ● Float! non-null scalar​

The line total, as calculated and stored by the server.

InvoiceItem.unitPrice ● Float! non-null scalar​

Price per unit before the line discount.

InvoiceItem.uomId ● ID scalar​

The ID of the unit of measure the quantity is expressed in.

InvoiceItem.uomName ● String scalar​

Name of the unit of measure.

InvoiceItem.variant ● ProductVariant object​

The product variant on this line.

InvoiceItem.variantId ● String scalar​

The ID of the product variant on this line.

InvoiceItem.warehouseId ● String scalar​

The ID of the warehouse this line relates to.

Member Of​

Invoice object