Search the Aria Knowledgebase for
User Documentation, APIs, SDKs, and more!

 

Home > Aria6 core api > get_standing_order

get_standing_order

Provides information about one or more standing orders associated with a speficied account.

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.
acct_no long 22 Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
  my_standing_order long 22 If this value is not null, then information about this specific standing order number will be retrieved. If null, then all standing order for the given acct_no will be retrieved.
  OR      
  my_client_order_id string 300 Client-defined order ID.
  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.

Output Arguments

Field Name Field Type Description
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.
so hash  
standing_order_no long Aria-assigned unique identifier for the standing order record created.
create_date string Date the order was created
update_date string Date the order was modified
comments string Comments for this order
num_orders_req long The number of orders which a standing order will create
num_orders_comp long The number of orders which have been created by this standing order
num_orders_remain long The remaining orders this standing order can create
interval_days long The number of days between orders
last_order_date string The date of the last time this standing order generated an order
next_order_date string The date on which another order will be generated from this standing order
status_cd long The status of this order
status_label string The short label for this order status code
status_desc string The long description of the status of this order
first_order_date string The date of the first generated order from this standing order
cancel_date string The date, if any, at which this standing order was canceled
cancel_comments string If this order has been canceled, the CSR comments, if any, would appear here
client_order_id string Client-defined order ID.
client_receipt_id string Client-defined reciept ID
statement_message string Alternate contact details for orders.

You must to post a comment.
Last modified
14:43, 2 Feb 2017

Tags

This page has no custom tags.

Classifications

This page has no classifications.