Home > Aria Crescendo Documentation > Aria Crescendo core api > set_usg_mtd_ptd_bal_m

set_usg_mtd_ptd_bal_m

This API resets the client or Master Plan Instance Billing-Period-To-Date or Month-To-Date unbilled usage balance to zero.

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 threshold_category long 1

Indicates whether category is PTD or MTD 0 means PTD. 1 means MTD.  

Allowable values for threshold_category: 

Values Description
0 PTD (Billing-Period-To-Date)
1 MTD (Month-To-Date)
  acct_no long 22 Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
  OR      
  client_acct_id string 50 Client-defined account identifier.
  master_plan_instance_id long 22 Aria generated unique identifier for the Master Plan Instance.
  OR      
  client_master_plan_instance_id string 100 Client-defined unique identifier for the Master Plan Instance.
  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.

Output Arguments

Field Name Field Type Description
acct_no long Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
client_acct_id string Client-defined account identifier.
master_plan_instance_id long The Master Plan Instance number.
client_master_plan_instance_id string Client-defined Master Plan Instance ID.
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

Classifications

This page has no classifications.
Powered by CXone Expert ®