Skip to main content

UpdateInvoiceItemInput

One invoice line in an update.

input UpdateInvoiceItemInput {
conversionFactor: Float
description: String!
discountAmount: Float
discountPercent: Float
grnItemId: ID
id: ID
productId: ID!
quantity: Float!
salesOrderItemId: ID
taxBreakdown: JSON
taxRate: Float!
unitPrice: Float!
uomId: ID
uomName: String
variantId: ID
warehouseId: ID
}

Fields​

UpdateInvoiceItemInput.conversionFactor ● Float scalar​

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

UpdateInvoiceItemInput.description ● String! non-null scalar​

Description shown on the invoice line.

UpdateInvoiceItemInput.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.

UpdateInvoiceItemInput.discountPercent ● Float scalar​

Line discount as a percentage, from 0 to 100.

UpdateInvoiceItemInput.grnItemId ● ID scalar​

The ID of the goods receipt line this purchase invoice line bills. Send it back unchanged to keep the link.

UpdateInvoiceItemInput.id ● ID scalar​

The ID of the existing invoice line. Omit for a new line.

UpdateInvoiceItemInput.productId ● ID! non-null scalar​

The ID of the product being invoiced.

UpdateInvoiceItemInput.quantity ● Float! non-null scalar​

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

UpdateInvoiceItemInput.salesOrderItemId ● ID scalar​

The ID of the sales order line this invoice line bills. Send it back unchanged to keep the link to the order.

UpdateInvoiceItemInput.taxBreakdown ● JSON scalar​

Tax split by component, as JSON.

UpdateInvoiceItemInput.taxRate ● Float! non-null scalar​

Tax rate for the line. Must not be negative.

UpdateInvoiceItemInput.unitPrice ● Float! non-null scalar​

Price per unit. Must not be negative.

UpdateInvoiceItemInput.uomId ● ID scalar​

The ID of the unit of measure for the quantity.

UpdateInvoiceItemInput.uomName ● String scalar​

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

UpdateInvoiceItemInput.variantId ● ID scalar​

The ID of the product variant being invoiced.

UpdateInvoiceItemInput.warehouseId ● ID scalar​

The ID of the warehouse the goods ship from.

Member Of​

UpdateInvoiceInput input