get_acct_dunning_group_details_m Sample Call and Response
This example retrieves the dunning group details for one specific dunning group assigned to an account, based on the get_acct_dunning_group_details_m method as defined in plsql_m_r73.yml.
This example includes every required field, plus one optional filter that narrows the result to a single dunning group, rather than every optional field the method accepts.
Sample call
{
"rest_call": "get_acct_dunning_group_details_m",
"output_format": "json",
"client_no": 68219,
"auth_key": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
"acct_no": 5004123,
"dunning_group_no": 8842
}
The rest_call and output_format fields are envelope fields that the REST layer adds; they do not appear in the method's own arguments list. The account is identified with acct_no, the Aria-assigned numeric identifier, instead of its alternative, client_acct_id. The dunning group itself is identified with dunning_group_no, one of a group of four alternative identifiers (plan_instance_no, client_plan_instance_id, dunning_group_no, and client_dunning_group_id) that each narrow the search to a single dunning group; this example uses only the Aria-assigned numeric identifier and omits the other three.
Sample response
{
"error_code": 0,
"error_msg": "OK",
"error_details": [],
"dunning_group_details": [
{
"dunning_group_no": 8842,
"dunning_group_name": "Standard Collections",
"dunning_group_description": "Default dunning group applied to accounts on monthly recurring plans.",
"client_dunning_group_id": "STD-COLLECTIONS",
"dunning_process_no": 301,
"client_dunning_process_id": "STD-DUN-PROC",
"status": 1,
"dunning_process_name": "Standard 30/60/90 Dunning Process",
"master_plans_summary": [
{
"plan_instance_no": 990015,
"client_plan_instance_id": "MPI-990015"
},
{
"plan_instance_no": 990042,
"client_plan_instance_id": "MPI-990042"
}
]
}
]
}
An error_code of zero and an error_msg of “OK” indicate that Aria found the requested dunning group and returned its details successfully. Because the sample call filters by a single dunning_group_no, the dunning_group_details array holds only the one matching entry; a call that omits all four alternative identifiers would return every dunning group assigned to the account instead. The status value of one indicates the dunning group is active for this account; a value of zero would indicate it is disabled for this account. The nested master_plans_summary array lists the master plan instances associated with this dunning group; it shows two entries here, but an account with more subscriptions assigned to the same dunning group would return additional entries. This example leaves out the deprecated dunning_groups array entirely, since a field carrying deprecate_version does not belong in a sample intended to show current best practice.