update_threshold_billing_rule_for_billing_group_m Guide

Last updated
Save as PDF

This API will set the threshold billing rule to be used for a given account's billing groups.

API Specification:	update_threshold_billing_rule_for_billing_group_m
Required Fields:	<client_no> <auth_key> <acct_no> or <userid> or <client_acct_id>

Additional Guidance

Input Fields

Field Name:

Notes:

<threshold_billing_rule_assignment_updates_row>

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.

<assignment_directive>

Allowable Values

Values	Description
0	Remove identified threshold billing rule from specified billing group.
1	Assign identified threshold billing rule to specified billing group.

Error Codes

Error Code/Description	Associated Inputs
1004: authentication error Associated Inputs: auth_key, client_id, client_no	<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) Associated Inputs: acct_no, account_no, client_acct_id, user_id, userid, parent_acct_no	<acct_no>, <userid>, <client_acct_id>
1010: missing required parameters, Missing input: (object-name) is required with assignment_directive ($AriaNo) Associated Inputs: all required inputs, typically one of the following: custom_rate_per_unit, custom_rate_seq_no, status_cd, dunning_state, userid, acct_no, client_acct_id, assignment_directive, billing_group_no, client_billing_group_id, threshold_billing_rule_no, client_threshold_billing_rule_id Alternate Message Output 1010: username is required 1010: first name is required 1010: last name is required 1010: email is required 1010: roles are required Associated APIs: create_user_m, get_user_details_m, delete_user_m, update_user_m Associated Inputs: username, first_name, last_name, email, role_no	<client_no>, <auth_key>, <acct_no> or <userid> or <client_acct_id>
1013: Object does not exist, Threshold Rule not found: AriaNo ($AriaNo) or Billing Group not found: AriaNo ($AriaNo) Associated Inputs: billing_group_no, client_billing_group_id, threshold_billing_rule_no, client_threshold_billing_rule_id Alternate Message Output 1013: role_no is invalid 1013: username is invalid 1013: user does not exist 1013: client_role_id is invalid Associated APIs: create_user_m, get_user_details_m, delete_user_m, update_user_m Associated Inputs: role_no, username, client_role_id	<billing_group_no>, <client_billing_group_id>, <threshold_billing_rule_no>, <client_threshold_billing_rule_id>
1015: duplicate record found, New assignment conflicts with existing assignment Alternate Message Output 1015: username should be unique Associated APIs: create_user_m Associated Inputs: username	<userid>
1016: invalid input Additional Comments: This error can be caused by the wrong type of input; for example, text in a numbers-only field, or specifying a value other than one of the documented allowable values.	<client_no>, <acct_no>, <assignment_directive>, <billing_group_no>, <threshold_billing_rule_no>
1022: Account billing group not found, Billing group does not belong to account. Billing group: AriaNo ($AriaNo), Account: AriaNo ($AriaNo) Associated Inputs: billing_group_no, client_billing_group_id	<billing_group_no>, <client_billing_group_id>
1035: invalid assignment directive, Invalid Assignment Directive: (assignment_directive) Associated Inputs: master_plan_assign_directive, assignment_directive	<assignment_directive>
1049: Billing or Plan changes not allowed due to the account status, Cannot add assignment for account with status code -99, Cannot add assignment for account with status code 0 Associated Inputs: N/A Additional Comments: This message indicates a processing problem.
5007: invalid currency cd Associated Inputs: currency_cd, Currency code of Threshold Billing Rule does not match Account. Rule: AriaNo ($AriaNo)