Home > Aria6 User Documentation > Aria6 core api > update_acct_status

update_acct_status

Sets the status of a 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.

Input Arguments

Req Field Name Field Type Max Length Description
required-icon.png client_no long 22 Aria-assigned unique identifier indicating the Aria client providing service to this account.
required-icon.png auth_key string 32 Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.
required-icon.png 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.  
Values Description
0 INACTIVE
1 ACTIVE
2 CANCELLATION PENDING
3 TERMINATION PENDING
10 ACTIVE DUNNING PENDING
11 ACTIVE DUNNING 1
12 ACTIVE DUNNING 2
13 ACTIVE DUNNING 3
14 ACTIVE DUNNING 4
15 ACTIVE DUNNING 5
16 ACTIVE DUNNING 6
17 ACTIVE DUNNING 7
18 ACTIVE DUNNING 8
21 REINSTATED FORWARD BILL
22 REINSTATED BACK BILL
31 INSTALLATION PENDING
32 REGISTERED PENDING ACTIVATION
41 ACTIVE TRIAL
51 TEMPORARY SERVICE BAN
61 ACTIVE NON-BILLABLE
99 PERMANENT
-1 SUSPENDED
-2 CANCELLED
-3 TERMINATED
-4 CONTRACT EXPIRED
-11 SUSPENDED DUNNING 1
-12 SUSPENDED DUNNING 2
-13 SUSPENDED DUNNING 3
-14 SUSPENDED DUNNING 4
-15 SUSPENDED DUNNING 5
-99 ARCHIVED
  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.  
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.
  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.  
Values Description
true true
false false
  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.
  brd_arrow.gif qualifier_name string 100 Name of the field you want to associate with this API call.
  brd_arrow.gif 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
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.
 
 
 
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.
Powered by CXone Expert ®