get_acct_plan_notify_method_m
Summary
| API Name | get_acct_plan_notify_method_m |
|---|---|
| Class | account_services_m |
| Update Version | 35 |
Description
Use this API to return the method by which statements are sent for a specified plan instance, or billing group for a given account.
Inputs
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| client_no | long | 22 | Yes |
Aria-assigned unique identifier indicating the Aria client providing service to this account. |
| auth_key | string | 32 | Yes |
Aria-assigned unique key for authenticating the validity of the requestor. This key is passed with each method call. |
| acct_no | long | 22 | Yes |
Aria-assigned account identifier. This value is unique across all Aria-managed accounts. Alternative required field: client_acct_id |
| plan_instance_no | long | 22 | Yes |
The unique identifier of the master plan instance. Alternative required field: client_plan_instance_id, billing_group_no, or client_def_billing_group_id |
| client_plan_instance_id | string | 100 | Yes |
The client-defined identifier of the master plan instance. Alternative required field: plan_instance_no, billing_group_no, or client_def_billing_group_id |
| billing_group_no | long | 22 | Yes |
'The unique identifier of the billing group.' Alternative required field: plan_instance_no, client_plan_instance_id, or client_def_billing_group_id |
| client_def_billing_group_id | string | 100 | Yes |
The client-defined identifier of the billing group. Alternative required field: plan_instance_no, client_plan_instance_id, or billing_group_no |
| client_acct_id | string | 50 | Yes |
Client-defined account identifier. Alternative required field: acct_no |
Outputs
| Name | Type | Length | Required | Description | ||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| error_code | long | No |
Aria-assigned error identifier. 0 indicates no error. |
|||||||||||||||||||||||||||||||||||||||
| error_msg | string | No |
Description of any error that occurred. "OK" if there was no error. |
|||||||||||||||||||||||||||||||||||||||
| notify_method | long | 2 | No |
How the client communicates with the account holder. If a notification method is not provided, this value defaults to "1" (HTML email). Allowed values:
|
||||||||||||||||||||||||||||||||||||||
| list_start_master_file | long | 1 | No |
Indicates whether the account is listed at the start of a master file. Allowed values:
|
||||||||||||||||||||||||||||||||||||||
| notify_method_name | string | No |
The name of the notify method to be used in communicating with the account holder. |