Special Notes:
Str SalesOrder: <attributes> – defines the order general parameters. The <attributes> line comprises a set of pairs of the following format: parameter=value.
The following parameters are available:
- Int
AccountID– the existing customer account ID to place the order for; - Str
OrderTypeID– the order type ID. The list of order types available can be viewed under the System > Settings > Order Processing > Order Types submenu of the Navigation tree. Each order type has its own order flow. We recommend that you place billing orders (BO) if there are no special requirements to order flow; - Str
OrderStatusID– status the order will be created in. The order processing will start from this status as well. The list of statuses available depends on order type. It can be viewed under the Statuses tab of the order type selected; - Str
PromoCode– a promotion code. The parameter is optional and can be skipped or passed empty; - Int
BranchID– ID of a sales branch to be assigned to the order. The parameter is optional and can be skipped or passed empty; - Int
SalesID– ID of a sales person to be assigned to the order. The parameter is optional and can be skipped or passed empty; - Int
ConsolidationType– signifies how the invoice is to be created for the order. Available options are: "0" – the invoice is generated according to the Billing Type parameter value set in the account customer class, "10" – the Billing Type parameter value set in the account customer class is ignored and invoice is generated as if the Billing Type parameter is set to the Per Subscription value, "20" – forced consolidation of the first order for Billing Type set to Per Account.The parameter is optional and can be skipped or passed empty; - Int
SOPayToolID– ID of the customer payment method (credit card or bank account) to be used to pay the order. The parameter is optional and can be skipped or passed empty. The customer default payment method will be used in this case; - Str
FromIP– customer IP address the order is placed from. The parameter is optional and can be skipped or passed empty; - Int
OrderDate– order creation date in Unix time format. The parameter is optional. If it is not specified, system current time is assigned; - Str
Descr– order general description, the order Comments field.
Example
Copy
<value>
SalesOrder:
AccountID=200;
OrderTypeID=SO;
OrderStatusID=NW;
PromoCode=PromoCode5;
BranchID=;
SalesID=;
ConsolidationType=10;
SOPayToolID=;
FromIP=10.20.30.40;
OrderDate=;
Descr =order description;
</value>