assign_collections_acct_group_m
Assigns a specified account to a collections account group. If the account's payment method is credit card, a $1 authorization will be performed on the credit card using the new group's payment processor before the group assignment is completed. Unlike the Aria UI, you can use this API to assign additional collection account groups to an account, if the collection account groups do not have overlapping supported payment methods.
For information on error messages generated by this API, see assign_collections_acct_group_m Error Messages.
Input Arguments
Req | Field Name | Field Type | Max Length | Description |
---|---|---|---|---|
![]() |
client_no | long | 22 | Aria-assigned unique identifier indicating the Aria client providing service to this account. |
![]() |
auth_key | string | 32 | Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor. |
![]() |
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. Note: If you pass in a <client_acct_id> and an <acct_no>, Aria will use this order of precedence to decide which account to take action on:
|
|
![]() |
group_no | long | 22 | Aria-assigned collections account group Identifier to which the account is assigned. If client_acct_group_id is valued, this value must be blank. |
OR | ||||
client_acct_group_id | string | 100 | Aria-assigned unique identifier indicating the Aria client providing service to this account. If group_no is valued, this value must be blank. | |
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. | ||
string | 100 | Name of the field you want to associate with this API call. | ||
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. | |
billing_group_no OR client_billing_group_id |
long string |
22 100 |
Aria-assigned billing group identifier Client-defined billing group identifier For cost savings or for other reasons,
Notes:
|
|
collections_group_bg_no OR client_collections_group_bg_id |
long string |
22 100 |
Aria-assigned identifier of the collection group assigned to a billing group Client-defined identifier of the collection group assigned to a billing group |
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. |