Home > Aria Crescendo Documentation > Aria Crescendo core api > get_acct_plan_notify_method_m


Use this API to return the method by which statements are sent for a specified Plan instance, or billing group for a given account.

For information on error messages generated by this API, see get_acct_plan_notify_method_m Error Messages.

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.
required-icon.png acct_no long 22 Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
  client_acct_id string 50 Client-defined account identifier.
required-icon.png plan_instance_no long 22 The unique identifier of the Master Plan Instance.
  client_plan_instance_id string 100 The client-defined identifier of the Master Plan Instance.
  billing_group_no long 22 'The unique identifier of the billing group.'
  client_def_billing_group_id string 100 The client-defined identifier of the billing 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.
  brd_arrow.gif qualifier_name string 100 Name of the field you want to associate with this API call.
  brd_arrow.gif 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.
notify_method long How the client communicates with the account holder. If a notification method is not provided, this value defaults to "1" (HTML email).  

Allowable values for notify_method:

list_start_master_file long Indicates whether the account is listed at the start of a master file.  

Allowable values for list_start_master_file:

notify_method_name string The name of the notify method to be used in communicating with the account holder.
Last modified



This page has no classifications.