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. |
status_cd | long | 8 | This is the status of the object in question for the current API call. Allowable Values | |
queue_days | long | 12 | Days in to queue before the status change occurs. | |
queue_date | string | Specific date for the status change to occur in yyyy-mm-dd format | ||
force_bill_date_reset | long | 1 | Determines whether to reset the billing dates to either the status change date or current anniversary date, reset the billing dates when the status changes from non-provisionable to provisionable depending on client parameter 'RESET_DATES_ON_REPROVISIONED_STATUS' setting, or not reset at all. Allowable Values | |
comments | string | 500 | Additional explanatory text relating to this API call. | |
client_receipt_id | string | 50 | Client-defined unique identifier used to track related system actions | |
alt_do_dunning | string | 5 | When set to true, indicates that dunning should be initiated. Allowable Values | |
status_degrade_date | string | Specific date to allow controlling of an account's dunning process. | ||
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. | ||
![]() |
string | 100 | Name of the field you want to associate with this API call. | |
![]() |
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. |
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. |