get_acct_dunning_group_details_m
Summary
| API Name | get_acct_dunning_group_details_m |
|---|---|
| Class | account_services_m |
| Update Version | 55 |
Description
Retreives the details for a specified dunning group, including the list of master plan instances associated with that dunning group.
Inputs
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| client_no | long | 22 | Yes |
Aria-assigned unique identifier indicating the Aria client providing service to this account. |
| auth_key | string | 32 | No |
Aria-assigned unique key for authenticating the validity of the requestor. This key is passed with each method call. |
| acct_no | long | 22 | Yes |
Aria-assigned account identifier. This value is unique across all Aria-managed accounts. Alternative required field: client_acct_id |
| client_acct_id | string | 50 | Yes |
Client-defined account identifier. Alternative required field: acct_no |
| plan_instance_no | long | 22 | No |
The Aria-assigned unique identifier of the master plan instance. Alternative field: client_plan_instance_id, dunning_group_no, or client_dunning_group_id |
| client_plan_instance_id | string | 100 | No |
The client-defined identifier of the master plan instance. Alternative field: plan_instance_no, dunning_group_no, or client_dunning_group_id |
| dunning_group_no | long | 22 | No |
The unique identifier of the dunning group. Alternative field: plan_instance_no, client_plan_instance_id, or client_dunning_group_id |
| client_dunning_group_id | string | 100 | No |
The client-defined identifier of the dunning group. Alternative field: plan_instance_no, client_plan_instance_id, or dunning_group_no |
Outputs
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| error_code | long | No |
Aria-assigned error identifier. 0 indicates no error. |
|
| error_msg | string | No |
Description of any error that occurred. "OK" if there was no error. |
|
| dunning_group_details | object | No |
Array of dunning groups |
|
| dunning_groups | object | No |
Note: This field is deprecated. Aria no longer supports dunning_groups. |
dunning_group_details.master_plans_summary fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| plan_instance_no | long | 22 | No |
Master Subscription plan instance number |
| client_plan_instance_id | string | 100 | No |
Unique master plan instance client-defined identifier |
dunning_group_details fields
| Name | Type | Length | Required | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| dunning_group_no | long | 22 | No |
The unique identifier of the dunning group. |
||||||
| dunning_group_name | string | 100 | No |
Dunning Group name |
||||||
| dunning_group_description | string | 1000 | No |
Dunning group description |
||||||
| client_dunning_group_id | string | 100 | No |
Client-defined unique identifier for dunning group |
||||||
| dunning_process_no | long | 22 | No |
Aria-assigned Dunning process number |
||||||
| client_dunning_process_id | string | 100 | No |
Client-defined dunning process identifier. |
||||||
| status | long | No |
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. Allowed values:
|
|||||||
| master_plans_summary | object | No |
Array of master plan numbers associated with the dunning group or plan instance |
|||||||
| dunning_process_name | string | 100 | No |
Name of the dunning process. |