Home > Aria6 User Documentation > Aria6 core api > record_standing_order
record_standing_order
record_standing_order
Creates a pre-defined, recurring order called a standing order. A standing order will automatically generate order transactions for a specified account and a specified number of iterations with a specified time interval between iterations.
Input Arguments
| Req | Field Name | Field Type | Max Length | Description |
|---|---|---|---|---|
 | client_no | long | 22 | Aria-assigned unique identifier indicating the Aria client providing service to this account. |
| auth_key | string | 32 | Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor. |
| account_no | long | 22 | Aria-assigned account identifier. This value is unique across all Aria-managed accounts. |
| billing_interval_units | long | 8 | Number of times "billing_interval_type" should be multiplied by in order to determine time to elapse between orders generated from this standing order (e.g. a "billing_interval_type" value of "M" combined with a "billing_interval_units value of "2 indicates that two months should elapse between each order generated from this standing order. |
| times_to_bill | long | 8 | Indicator specifying the total number of orders to be generated from this standing order. Value must be >0.To create an "indefinite" standing order, specify -1. |
| billing_interval_type | string | 1 | Indicator specifying the type of time unit multiplied by the value provided in parameter billing_interval_units, determining the time to elapse between each order generated from this standing order. Allowable Values | |
| first_bill_date | string | 10 | Date to commence order generation based on this standing order. A null value causes the first order to be generated in the next Aria daily batch processing run. | |
| standing_order | array | Multidimensional array "standing_order": The standing_order array represent order-based (i.e. one-time purchased) items, and valid values must be pre-defined in Aria's inventory table structure. | ||
 client_sku | string | 100 | Client-defined indicator of an item to be included on all orders generated from this standing order. At least one client_sku value must be supplied. REST input arrays are values separated by ""|"" | |
| units | double | 8 | Number of units of client_sku to be included on all orders generated from this standing order. Number of values supplied in this array must match number of values supplied in client_sku. Values must be integers greater than zero. REST input arrays are values separated by "|" |
| amount | string | 12 | Currency amount per unit of "client_sku" to be used on all orders generated from this standing order. A null value indicates that orders of the given client_sku should use the unit price already defined for that item in the Aria system. Supplied, non-null values must be greater than zero. REST input arrays are values separated by ""|""" | |
| unit_discount_amount | string | 22 | Per unit discount amount to be applied. Value must be greater than 0. If values is greater than specified amount or SKU price, this value will be ignored. REST input arrays are values separated by "|". | |
| line_comments | string | 3000 | Any client-defined comments, from a CSR or automated system, for this particular line item | |
| rate_schedule_no | long | Aria-assigned unique identifier for the rate schedule. | ||
| OR | ||||
| client_defined_rate_schedule_id | string | 3000 | Client-defined unique identifier for the rate schedule. If both are not specified, the default rate schedule for the account's currency is chosen. | |
| client_order_id | string | 100 | This is the client-assigned order identifier. | |
| client_receipt_id | string | 50 | Client-defined unique identifier used to track related system actions nullable: true | |
| statement_message | string | 1000 | Alternate contact details for orders. | |
| order_comments | string | 3000 | Comments for this order | |
| alt_caller_id | string | 30 | Person or process that submitted the API call. This can be someone's user ID, or the name of an application. | |
| optional_transaction_qualifiers | array | Array of additional values you can associate with this API call. | ||
| qualifier_name | string | 100 | Name of the field you want to associate with this API call. | |
| qualifier_value | string | 100 | Corresponding value of the field you want to associate with this API call. | |
| application_id | string | 300 | The application identifier in which the API is being used in. (Example: “Sales Force”) | |
| application_date | string | 300 | The application date/timestamp, ie. 01/01/2014 10:00:00 to track when the application called the API. |
Output Arguments
| Field Name | Field Type | Description |
|---|---|---|
| standing_order_no | long | Aria-assigned unique identifier for the standing order record created. |
| error_code | long | Aria-assigned error identifier. 0 indicates no error. |
| error_msg | string | Description of any error that occurred. "OK" if there was no error. |
- © Copyright 2021 Aria Developer Central