update_acct_status_m
Summary
| API Name | update_acct_status_m |
|---|---|
| Class | account_services_m |
| Update Version | 6.35 |
Description
Sets the status of a specified account and optionally indicates the number of days or date in the future on which the status change should go into effect.This call can also reset the billing dates on the status change date for accounts changing from a non-billable to a billable status; or for accounts changing from a non-provisioned to provisioned status. This billing dates reset occurs for all plan instances on the account.
When the status is set to "archived," sensitive billing data are cleared. When the status is set to "deactivated," all plan instances on the account are set to "terminated."
Inputs
| Name | Type | Length | Required | Description | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| client_no | long | 22 | Yes |
Aria-assigned unique identifier indicating the Aria client providing service to this account. |
||||||||||||||
| auth_key | string | 32 | No |
Aria-assigned unique key for authenticating the validity of the requestor. This key is passed with each method call. |
||||||||||||||
| account_no | long | 22 | Yes |
Aria-assigned account identifier. This value is unique across all Aria-managed accounts. Alternative required field: client_acct_id |
||||||||||||||
| status_cd | long | 8 | No |
This is the status of the object in question for the current API call. Allowed values:
|
||||||||||||||
| queue_days | long | 12 | No |
Days in to queue before the status change occurs. |
||||||||||||||
| queue_date | string | No |
Specific date for the status change to occur in yyyy-mm-dd format |
|||||||||||||||
| force_bill_date_reset | long | 1 | No |
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. Allowed values:
|
||||||||||||||
| comments | string | 500 | No |
Additional explanatory text relating to this API call. |
||||||||||||||
| client_receipt_id | string | 50 | No |
Client-defined unique identifier used to track related system actions |
||||||||||||||
| alt_do_dunning | string | 5 | No |
Note: This field is deprecated. Aria no longer supports alt_do_dunning. |
||||||||||||||
| status_degrade_date | string | 10 | No |
Note: This field is deprecated. Aria no longer supports status_degrade_date. |
||||||||||||||
| client_acct_id | string | 50 | Yes |
Client-defined account identifier. Alternative required field: account_no |
Outputs
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| error_code | long | No |
Aria-assigned error identifier. 0 indicates no error. |
|
| error_msg | string | No |
Description of any error that occurred. "OK" if there was no error. |