Skip to main content
Aria Knowledge Central

get_dunning_processes_m

  1. Last updated
  2. Save as PDF

Summary

API Name get_dunning_processes_m
Class administration_services_m
Update Version 6.37

Description

Retrieves the plans and payment methods associated with dunning process(es)

Inputs

Name Type Length Required Description
client_no long 12 Yes

Aria assigned unique identifier indicating the Aria client providing service to this account.
auth_key string 32 Yes

Aria assigned unique key to be passed with each method call for authenticating the validity of the requestor.
dunning_processes object   No

The dunning_processes associated with this method.

See fields below
pay_method_types object   No

The pay_method_types associated with this method.

See fields below
master_plans object   No

The master_plans associated with this method.

See fields below
include_dunning_steps string 10 No

Boolean - true/false. If set to "true", will return per-step detail (dunning_process_steps array, include_all_subscriptions_ind, and final_step_template_no) for each returned dunning process. Defaults to "false".

dunning_processes fields

Name Type Length Required Description
dunning_process_no long   No

The unique identifier of the dunning process.

Alternative field: client_dunning_process_id
client_dunning_process_id string   No

The client-defined identifier of the dunning process.

Alternative field: dunning_process_no

pay_method_types fields

Name Type Length Required Description
pay_method_type_cd int   No

Will return all dunning processes associated with the payment method type specified.

Allowed values:

Value 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 fields

Name Type Length Required Description
plan_no long   No

The unique identifier of the master plan associated with a dunning process.

Alternative field: client_plan_id
client_plan_id string   No

The client-defined identifier of the master plan associated with a dunning process.

Alternative field: plan_no

Outputs

Name Type Length Required Description
error_code long   No

Aria-assigned error identifier. 0 indicates no error
error_msg string   No

Textual description of any error that occurred. "OK" if there was no error.
dunning_process_details object   No

The dunning_process_details associated with this method.

See fields below

dunning_process_details.mapped_master_plans fields

Name Type Length Required Description
plan_no long   No

The unique identifier of the plan associated with the dunning process.
client_plan_id string   No

The client-defined identifier of the plan associated with the dunning process.
plan_name string   No

The name of the plan associated with the dunning process.

dunning_process_details.mapped_pay_method_types fields

Name Type Length Required Description
pay_method_type_cd int   No

The unique identifier of the payment method type associated with the dunning process.
pay_method_type string   No

The name of the payment method type associated with the dunning process.

dunning_process_details.dunning_process_steps.fee_currencies fields

Name Type Length Required Description
currency_cd string   No

Three-letter ISO currency code.
fee_amount string   No

Fee amount in the specified currency.

dunning_process_details.dunning_process_steps fields

Name Type Length Required Description
step_no int   Yes

Sequential step number (1 through total_step_count). The final suspension step is not included in this array.
step_description string   No

Description of the dunning step.
status_duration_days int   No

Number of days this step remains active before advancing to the next step.
collect_ind int   No

Indicator of whether a collection attempt is made during this step. 0 = False, 1 = True.

Allowed values:

Value Description
0 False
1 True
notification_template_no string   No

The notification template number for this step. Returns "DO_NOT_SEND" if no template is configured.
email_destination string   No

Human-readable label for the email destination of the dunning notification.

Allowed values:

Value Description
Default Default email destination
Account only Account contact only
Billing only Billing contact only
Account & Billing Account and billing contacts
Statement only Statement contact only
Account & Statement Account and statement contacts
Billing & Statement Billing and statement contacts
Account & Billing & Statement Account, billing, and statement contacts
fee_type string   No

Fee type assessed by this step. Returns "None" when no fee is configured.

Allowed values:

Value Description
Flat Fee A fixed fee amount per currency
Percentage Fee A percentage of the past-due balance
None No fee assessed at this step
fee_currencies object   No

Per-currency fee amounts for this step. Empty array when fee_type is "None".

See fields below

dunning_process_details fields

Name Type Length Required Description
dunning_process_no long   Yes

The unique identifier of the dunning process.
client_dunning_process_id string   No

The client-defined identifier of the dunning process.
dunning_process_name string   Yes

The name of the dunning process
dunning_process_description string   No

The description associated with the dunning process.
client_default_ind int   No

Indicator of whether the dunning process has been defined as the client default dunning process.0 = False, 1 = True

Allowed values:

Value Description
0 False
1 True
total_step_count int   Yes

Number of steps (excluding the final dunning notification / suspension step) defined for the dunning process.
mapped_master_plans object   No

The mapped_master_plans associated with this method.

See fields below
mapped_pay_method_types object   No

The mapped_pay_method_types associated with this method.

See fields below
include_all_subscriptions_ind int   No

Indicator of whether the dunning process applies to all master plan instances on the account. 0 = False, 1 = True. Only returned when include_dunning_steps is set to "true".

Allowed values:

Value Description
0 False
1 True
final_step_template_no string   No

The notification template number used for the final dunning step (suspension). Returns "DO_NOT_SEND" if no template is configured. Only returned when include_dunning_steps is set to "true".
dunning_process_steps object   No

Per-step detail for the dunning process, excluding the final suspension step. Only returned when include_dunning_steps is set to "true". Empty array if the process has no non-final steps.

See fields below
TOP
  1. Back to top
  • Was this article helpful?

Recommended articles

  1. Page type
    Topic
  2. Tags
    This page has no tags.