get_acct_dunning_group_details_m
Retreives the details for a specified dunning group, including the list of Master Plan Instances associated with that dunning group.
For information on error messages generated by this API, see get_acct_dunning_group_details_m Error Messages.
For information on error messages generated by this API, see get_acct_dunning_group_details_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. | |
| plan_instance_no | long | 22 | The Aria-assigned unique identifier of the Master Plan Instance. | |
| OR | ||||
| client_plan_instance_id | string | 100 | The client-defined identifier of the Master Plan Instance. | |
| OR | ||||
| dunning_group_no | long | 22 | The Aria-assigned unique identifier of the dunning group. | |
| OR | ||||
| client_dunning_group_id | string | 100 | The client-defined identifier of the dunning group. | |
| 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. |
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. | ||||||
| dunning_group_details | hash | Array of dunning groups | ||||||
| long | The unique identifier of the dunning group. | |||||||
| string | Dunning Group name | |||||||
| string | Dunning group description | |||||||
| string | Client-defined unique identifier for dunning group | |||||||
| long | Aria-assigned Dunning process number | |||||||
| string | Client-defined dunning process identifier. | |||||||
| long |
If the status is "1", the dunning group is active for this account. If the status is "0", the dunning group is disabled for this account. Allowable values for status:
|
|||||||
| hash | Array of Master Plan numbers associated with the dunning group or Plan instance | |||||||
| long | Master Plan Instance number | |||||||
| string | Unique Master Plan Instance client-defined identifier | |||||||
| dunning_groups | hash | Array of dunning groups DEPRECATED | ||||||
| long | The unique identifier of the dunning group. DEPRECATED | |||||||
| string | Dunning Group name DEPRECATED | |||||||
| string | Dunning group description DEPRECATED | |||||||
| string | Client-defined unique identifier for dunning group DEPRECATED | |||||||
| long | Aria-assigned Dunning process number DEPRECATED | |||||||
| string | Client-defined dunning process identifier. DEPRECATED | |||||||
| long |
If the status is "1", the dunning group is active for this account. If the status is "0", the dunning group is disabled for this account. DEPRECATED Allowable values for status:
|
|||||||
| hash | Array of Master Plan numbers associated with the dunning group or Plan instance DEPRECATED | |||||||
| long | Master Plan Instance number DEPRECATED | |||||||
| string | Unique Master Plan Instance client-defined identifier DEPRECATED |