The update_acct_status_m API 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 (a.k.a. queued status change). It can also clear a queued status change.
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. Aria resets the billing dates 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."
| API Specification: |
update_acct_status_m |
| Required Fields: |
- <client_no>
- <auth_key>
- <acct_no> or <client_acct_id>
- <status_cd>
|
Additional Guidance
- To clear a queued status change, send the account’s current <status_cd> without including any queue dates. This will clear the queue record.
Input Fields
| Field Name |
Notes |
| <status_cd> |
Allowable Values
| Values |
Description |
| 0 |
DEACTIVATED |
| 1 |
ACTIVE |
| 32 |
REGISTERED PENDING ACTIVATION |
| 51 |
TEMPORARY SERVICE BAN |
| 99 |
PERMANENT |
| -99 |
ARCHIVED |
|
| <force_bill_date_reset> |
Note: field value “2” does not function when the call is queuing the status change using queue data fields.
Allowable Values
| Values |
Description |
| |
Reset the billing dates when the status changes from non-provisionable to provisionable depending on client parameter 'RESET_DATES_ON_REPROVISIONED_STATUS' setting. |
| 0 |
Do not reset the billing dates regardless of client parameter setting. |
| 1 |
Reset the billing anniversary date to coincide with the status change date. |
| 2 |
Reset the billing anniversary date to coincide with the current anniversary date. |
|
| <alt_do_dunning> |
Allowable Values
| Values |
Description |
| true |
true |
| false |
false |
|
Error Codes
| Error Code/Description |
Associated Inputs |
|
|
|
1004: authentication error
|
<client_no>, <auth_key> |
1009: account does not exist, Account not found: AriaNo (acct_no), Account not found: Userid (userid), or Account not found: ClientId (client_acct_id)
|
<account_no>, <client_acct_id> |
5002: invalid account status code
|
<status_cd> |
25020: Illegal characters entered
|
<auth_key>, <queue_date>, <comments>, <client_receipt_id>, <client_acct_id>, <application_id>, <application_date>, <alt_caller_id>, <attach_qualifier_option>, <qualifier_name>, <qualifier_value> |
5045: Status Code is mandatory
|
<status_cd> |
1024: invalid date format
Additional Comments: All date inputs must be in yyyy-mm-dd format.
|
<queue_date> |
