Skip to main content

InvoiceItemInput

One line of a new invoice.

input InvoiceItemInput {
  acceptAlternativeIfUnavailable: Boolean
  batchNumber: String
  conversionFactor: Float
  description: String!
  discountAmount: Float
  discountPercent: Float
  grnItemId: ID
  productId: ID!
  quantity: Float!
  salesOrderItemId: ID
  serialNumber: String
  taxBreakdown: JSON
  taxRate: Float
  unitPrice: Float!
  uomId: ID
  uomName: String
  variantId: ID!
  warehouseId: ID
}

Fields

`InvoiceItemInput.acceptAlternativeIfUnavailable` ● `Boolean` scalar

Whether the buyer accepts a substitute if this item is unavailable. Taken from the linked sales order line when omitted.

`InvoiceItemInput.batchNumber` ● `String` scalar

Batch number of the goods on this line.

`InvoiceItemInput.conversionFactor` ● `Float` scalar

How many stock units one invoiced unit is worth. Must not be negative.

`InvoiceItemInput.description` ● `String!` non-null scalar

Description shown on the invoice line.

`InvoiceItemInput.discountAmount` ● `Float` scalar

The line discount as an amount. When sent it is used instead of re-deriving the amount from discountPercent. Must not be negative.

`InvoiceItemInput.discountPercent` ● `Float` scalar

Line discount as a percentage, from 0 to 100.

`InvoiceItemInput.grnItemId` ● `ID` scalar

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

`InvoiceItemInput.productId` ● `ID!` non-null scalar

The ID of the product being invoiced.

`InvoiceItemInput.quantity` ● `Float!` non-null scalar

Quantity invoiced, in the unit given by uomId. Must be greater than zero.

`InvoiceItemInput.salesOrderItemId` ● `ID` scalar

The ID of the sales order line this invoice line bills. Keeps the link to the order and limits invoicing to the quantity not yet invoiced.

`InvoiceItemInput.serialNumber` ● `String` scalar

Serial number of the goods on this line.

`InvoiceItemInput.taxBreakdown` ● `JSON` scalar

Tax split by component, as JSON.

`InvoiceItemInput.taxRate` ● `Float` scalar

Tax rate for the line. When omitted or 0 the server resolves tax from the product's tax setup; a rate you send overrides it.

`InvoiceItemInput.unitPrice` ● `Float!` non-null scalar

Price per unit. Must not be negative.

`InvoiceItemInput.uomId` ● `ID` scalar

The ID of the unit of measure for the quantity.

`InvoiceItemInput.uomName` ● `String` scalar

Name of the unit of measure, shown on the line.

`InvoiceItemInput.variantId` ● `ID!` non-null scalar

The ID of the product variant being invoiced.

`InvoiceItemInput.warehouseId` ● `ID` scalar

The ID of the warehouse the goods ship from.

Member Of

CreateInvoiceInput input

Fields
Member Of