get_dunning_processes_m
Retrieves the plans and payment methods associated with dunning process(es)
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. | ||||||||||||||||||||||||||||||||||||||||||
| dunning_processes | array | |||||||||||||||||||||||||||||||||||||||||||||
 dunning_process_no |
int | The unique identifier of the dunning process. | ||||||||||||||||||||||||||||||||||||||||||||
| OR | ||||||||||||||||||||||||||||||||||||||||||||||
| client_dunning_process_id |
string | The client-defined identifier of the dunning process. | ||||||||||||||||||||||||||||||||||||||||||||
| pay_method_types | int array | Will return all dunning processes associated with the payment method type specified.
Allowable values for pay_method_type_cd:
|
||||||||||||||||||||||||||||||||||||||||||||
| master_plans | array | |||||||||||||||||||||||||||||||||||||||||||||
| plan_no |
int | 12 | The unique identifier of the master plan associated with a dunning process. | |||||||||||||||||||||||||||||||||||||||||||
| OR | ||||||||||||||||||||||||||||||||||||||||||||||
| client_plan_id |
string | The client-defined identifier of the master plan associated with a dunning process. |
Output Arguments
| Field Name | Field Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
| error_code | long | Aria-assigned error identifier. 0 indicates no error | ||||||
| error_msg | string | Textual description of any error that occurred. "OK" if there was no error. | ||||||
| dunning_process_details | hash | |||||||
| dunning_process_no |
int | The unique identifier of the dunning process. | ||||||
| client_dunning_process_id |
string | The client-defined identifier of the dunning process. | ||||||
| dunning_process_name |
string | The name of the dunning process | ||||||
| dunning_process_description |
string | The description associated with the dunning process. | ||||||
| client_default_ind |
int | Indicator of whether the dunning process has been defined as the client default dunning process.0 = False, 1 = True.
Allowable values for client_default_ind:
|
||||||
| total_step_count |
int | Number of steps (including the final dunning notification) defined for the dunning process. | ||||||
| mapped_master_plans |
hash | |||||||
| plan_no |
int | The unique identifier of the plan associated with the dunning process. | ||||||
| client_plan_id |
string | The client-defined identifier of the plan associated with the dunning process. | ||||||
| plan_name |
string | The name of the plan associated with the dunning process. | ||||||
| mapped_pay_method_types |
hash | |||||||
| pay_method_type_cd |
int | The unique identifier of the payment method type associated with the dunning process. | ||||||
| pay_method_type |
string | The name of the payment method type associated with the dunning process. |