Home > Aria Crescendo Documentation > Aria Crescendo admintools api > get_dunning_processes_m

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
required-icon.png client_no long 22 Aria-assigned unique identifier indicating the Aria client providing service to this account.
required-icon.png 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    
  brd_arrow.gifdunning_process_no int   The unique identifier of the dunning process.
  OR      
  brd_arrow.gifclient_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

Values Description
1 Credit card
2 Electronic Check (ACH)
3 Pre-paid
4 Net terms 30
5 Net terms 10
6 Net terms 15
7 Net terms 60
8 Click&Buy
9 Net Terms 0
10 PayByCash
11 PayPal Express Checkout
12 Net Terms 45
13 Tokenized Credit Card
14 Purchase Power
15 Net Terms 35
16 Net Terms 75
17 Net Terms 90
18 Net Terms 120
19 Net Terms 25
26 Direct Debit
  master_plans array    
  brd_arrow.gifplan_no int 12 The unique identifier of the master plan associated with a dunning process.
  OR      
  brd_arrow.gifclient_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  
brd_arrow.gif dunning_process_no int The unique identifier of the dunning process.
brd_arrow.gif client_dunning_process_id string The client-defined identifier of the dunning process.
brd_arrow.gif dunning_process_name string The name of the dunning process
brd_arrow.gif dunning_process_description string The description associated with the dunning process.
brd_arrow.gif 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

Values Description
0 False
1 True
brd_arrow.gif total_step_count int Number of steps (including the final dunning notification) defined for the dunning process.
brd_arrow.gif mapped_master_plans hash  
brd_arrow.gif plan_no int The unique identifier of the plan associated with the dunning process.
brd_arrow.gif client_plan_id string The client-defined identifier of the plan associated with the dunning process.
brd_arrow.gif plan_name string The name of the plan associated with the dunning process.
brd_arrow.gif mapped_pay_method_types hash  
brd_arrow.gif pay_method_type_cd int The unique identifier of the payment method type associated with the dunning process.
brd_arrow.gif pay_method_type string The name of the payment method type associated with the dunning process.
 
 
 
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.
Powered by CXone Expert ®