Home > Aria Crescendo Documentation > Aria Crescendo core api > update_threshold_billing_rule_for_billing_group_m

update_threshold_billing_rule_for_billing_group_m

Assigns a Threshold Billing Rule (TBR, also referred to as a "threshold") to an account's billing group and/or unassigns a threshold from an account's billing group.

 

For a list of error messages generated by this API, see update_threshold_billing_rule_for_billing_group_m error messages.

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 acct_no long 22 Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
 

 

OR

 

      
 

userid

 

OR

 

client_acct_id

string

 

 

 

string

32

 

 

 

50

Client-defined user ID of the account.

 

 

 

Client-defined account identifier.
Start of the <threshold_billing_rule_assignment_updates_row> array
  threshold_billing_rule_assignment_updates_row array  

Array of 1 or more threshold-related actions to take on a specified billing group.

Note:

  • If you pass in 2 actions in 1 single API call that assigns and removes the same threshold associated with the same billing group;
  • Then that threshold will be assigned to the billing group.

 

The above is true regardless of the order in which you passed the assign and remove actions into the API call.
  Field Name Field Type Max Length Description
required-icon.png  brd_arrow.gif assignment_directive long 2

Threshold-related action to be taken on the specified billing group.

Values Description
0 Remove identified threshold billing rule from specified billing group.
1 Assign identified threshold billing rule to specified billing group.
required-icon.png  brd_arrow.gif billing_group_no long 22

Aria-assigned billing group number.
      OR      
   brd_arrow.gif client_billing_group_id string 100 Client-defined billing group number.
required-icon.png   brd_arrow.gif threshold_billing_rule_no long 22 Aria-assigned threshold identifier.
      OR      
   brd_arrow.gif client_threshold_billing_rule_id string 100 Client-defined threshold identifier.
End of the <threshold_billing_rule_assignment_updates_row> array
  application_id string 300 The application identifier in which the API is being used in. (Example: “Salesforce”)
  application_date string 300 The application date/timestamp, example: 01/01/2014 10:00:00 to track when the application called the API.
  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.
Start of <optional_transaction_qualifiers> array
  optional_transaction_qualifiers array   Array of additional values you can associate with this API call.
  Field Name     Description
  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.
End of <optional_transaction_qualifiers> array

 

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 ®