Search the Aria Knowledgebase for
User Documentation, APIs, SDKs, and more!

 

Home > Aria Crescendo core api > get_acct_dunning_group_details_m

get_acct_dunning_group_details_m

Retreives the details for a specified dunning group, including the list of master plans associated with that dunning group.

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.
acct_no long 22 Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
  OR      
  client_acct_id string 50 This is the client-assigned identifier for the account.
  plan_instance_no long 22 The unique identifier of the master plan instance.
  OR      
  client_plan_instance_id string 100 The client-defined identifier of the master plan instance.
  OR      
  dunning_group_no long 22 The unique identifier of the dunning group.
  OR      
  client_dunning_group_id string 100 The client-defined identifier of the dunning group.
  alt_caller_id string 30 Person or process that submitted the API call. This can be someone's user ID, or the name of an application.
  optional_transaction_qualifiers array   Array of additional values you can associate with this API call.
  qualifier_name string 100 Name of the field you want to associate with this API call.
  qualifier_value string 100 Corresponding value of the field you want to associate with this API call.

Output Arguments

Field Name Field Type Description
error_code long Aria-assigned error identifier. 0 indicates no error.
error_msg string Description of any error that occurred. "OK" if there was no error.
dunning_groups hash Array of dunning groups
dunning_group_no long The unique identifier of the dunning group.
dunning_group_name string Dunning Group name
dunning_group_description string Dunning group description
client_dunning_group_id string Client-defined unique identifier for dunning group
dunning_process_no long Dunning process code
client_dunning_process_id string Client-defined dunning process identifier.
status long 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.   Allowable Values
master_plans_summary hash Array of master plan numbers associated with the dunning group or plan instance
plan_instance_no long Master Subscription plan instance number
client_plan_instance_id string Unique master plan instance client-defined identifier

You must to post a comment.
Last modified
14:40, 2 Feb 2017

Tags

This page has no custom tags.

Classifications

This page has no classifications.