Request model for line items used when submitting a PartnerServices AddStockOrder request to the server.
Required
lineItemID :
string (GUID)
The unique identifier for the line item within the stock order
Required
type :
StockItemStringItemType
The type of line item this record represents
Required
MaxLength(50)
description :
string
A description for the line item. Typically the product name from the supplier invoice, or a description of the charge/discount/surcharge.
Required
decimal(18, 5)
quantity :
number (decimal)
The quantity of the line item being ordered. For charge/discount/surcharge/rounding lines this should be 1.
Required
decimal(18, 2)
amount :
number (decimal)
The TOTAL amount for the line item (including inclusive taxes, but excluding addon (ie exTax1-4) taxes).
Eg if the line represents 3 x $4 items, then Quantity would be 3 and Amount would be 12
If Type is Discount, this amount should be negative.
Nullable
MaxLength(18)
supplierProductCode :
string
The supplier product code for the line item.
This is REQUIRED when Type is any of the StockItem_* values.
This should be NULL when Type is any of the DeliveryCharge, Discount, Surcharge or RoundingLine values.
Nullable
MaxLength(32)
taxGroupName :
string
(OPTIONAL) The name of the tax group that should be used to calculate the taxes for these line items
If NULL, the system will automatically determine the appropriate tax group based on the supplier and product configuration
Example
{
"lineItemID": "3f49efe7-ea42-4f21-8718-7e6ce9a33512",
"type": 1,
"description": "string value",
"quantity": 1.23,
"amount": 1.23,
"supplierProductCode": "string value",
"taxGroupName": "string value"
}