Request model for submitting a PartnerServices AddStockOrder request to the server.
Constant
System.Int32 MAX_LINE_ITEMS = 1024
The maximum number of LineItems records that can be included in a submission
Required
orderID :
string (GUID)
A unique identifier for the stock order being created
Required
MaxLength(32)
supplierInvoiceNumber :
string
The invoice number from the supplier for this stock order
Required
supplierInvoiceDate :
string (ISO 8601 DateTime)
The date of the supplier invoice for this stock order
Required
MaxLength(128)
applicationClientName :
string
The name of the software application that has created this request.
3rd Party integrations should enter their application or integration name here.
Example: "My App" or "My Website App"
Required
MaxLength(128)
applicationClientVersion :
string
The version of the software application that has created the transaction.
3rd Party integrations should enter their application version name here.
Example: "1.0.0.0" or "1" or "2.5a" etc
Required
lineItems :
AddStockOrderRequestLineItem
[]
The list of line items to be added to this order
Nullable
outletID :
string (GUID)
The unique identifier for the outlet that this stock order is being created for (if known)
Note: Either OutletID or OutletName must be provided to identify the outlet
Nullable
MaxLength(64)
outletName :
string
The name of the outlet that this stock order is being created for (if known)
Note: Either OutletID or OutletName must be provided to identify the outlet
Nullable
MaxLength(4)
currencyCode :
string
(OPTIONAL) 3 letter ISO currency code to explicitly set the currency that all currency values in the stock order represent
eg AUD, USD, EUR, GBP
If not specified, the system will automatically determine the default currency for the outlet and use that
Nullable
supplierID :
string (GUID)
The unique identifier of the supplier for this stock order (if known)
Note: Either SupplierID or SupplierName must be provided to identify the supplier
Nullable
MaxLength(128)
supplierName :
string
The name of the supplier for this stock order (if known)
Note: Either SupplierID or SupplierName must be provided to identify the supplier
Nullable
MaxLength(32)
purchaseOrderNumber :
string
The purchase order number relating to this stock order (if known)
Nullable
dateTimeDeliveryExpected :
string (ISO 8601 DateTime)
(OPTIONAL) The date and time that delivery is expected for this stock order (if known)
Nullable
decimal(18, 2)
total_Amount :
number (decimal)
(OPTIONAL) The total expected amount for the stock order (including all inclusive taxes, and excluding addon (ie exTax1-4) taxes).
Nullable
decimal(18, 2)
total_IncTax1 :
number (decimal)
(OPTIONAL) The total expected inclusive tax amount for the stock order at tax level 1
Nullable
decimal(18, 2)
total_IncTax2 :
number (decimal)
(OPTIONAL) The total expected inclusive tax amount for the stock order at tax level 2
Nullable
decimal(18, 2)
total_IncTax3 :
number (decimal)
(OPTIONAL) The total expected inclusive tax amount for the stock order at tax level 3
Nullable
decimal(18, 2)
total_IncTax4 :
number (decimal)
(OPTIONAL) The total expected inclusive tax amount for the stock order at tax level 4
Nullable
decimal(18, 2)
total_ExTax1 :
number (decimal)
(OPTIONAL) The total expected exclusive (addon) tax amount for the stock order at tax level 1
Nullable
decimal(18, 2)
total_ExTax2 :
number (decimal)
(OPTIONAL) The total expected exclusive (addon) tax amount for the stock order at tax level 2
Nullable
decimal(18, 2)
total_ExTax3 :
number (decimal)
(OPTIONAL) The total expected exclusive (addon) tax amount for the stock order at tax level 3
Nullable
decimal(18, 2)
total_ExTax4 :
number (decimal)
(OPTIONAL) The total expected exclusive (addon) tax amount for the stock order at tax level 4
Example
{
"orderID": "3f49efe7-ea42-4f21-8718-7e6ce9a33512",
"supplierInvoiceNumber": "string value",
"supplierInvoiceDate": "2012-04-03T09:40:59.736Z",
"applicationClientName": "string value",
"applicationClientVersion": "string value",
"lineItems": [],
"outletID": "3f49efe7-ea42-4f21-8718-7e6ce9a33512",
"outletName": "string value",
"currencyCode": "string value",
"supplierID": "3f49efe7-ea42-4f21-8718-7e6ce9a33512",
"supplierName": "string value",
"purchaseOrderNumber": "string value",
"dateTimeDeliveryExpected": "2012-04-03T09:40:59.736Z",
"total_Amount": 1.23,
"total_IncTax1": 1.23,
"total_IncTax2": 1.23,
"total_IncTax3": 1.23,
"total_IncTax4": 1.23,
"total_ExTax1": 1.23,
"total_ExTax2": 1.23,
"total_ExTax3": 1.23,
"total_ExTax4": 1.23
}