get_acct_plan_notify_method_m Guide
- Last updated
-
-
Save as PDF
Use this API to return the method by which statements are sent for a specified plan instance, or billing group for a given account.
| API Specification: |
get_acct_plan_notify_method_m |
| Required Fields: |
- <client_no>
- <auth_key>
- <acct_no> or <client_acct_id>
- <plan_instance_no> or <client_plan_instance_id>
|
Additional Guidance:
Output Fields
| Field Name |
Notes |
| <notify_method> |
Allowable Values
| Values |
Description |
| 0 |
None |
| 1 |
HTML Email |
| 2 |
Text Email |
| 3 |
Text Email w/link to HTML |
| 4 |
Data export |
| 5 |
Printable (no Email) w/Surcharge |
| 6 |
Printable & Text Email |
| 7 |
Printable & HTML Email w/Surcharge |
| 8 |
Printable (no Email) |
| 9 |
PDF (Printing required, no Email) |
| 10 |
PDF (delivered by Email) |
| 11 |
PDF (Printing req & Email)w/surcharge |
| 12 |
PDF (Printing req, no Email)w/surcharge |
| 13 |
XML Master File |
| 14 |
PDF Master File |
| 15 |
XML Master File and HTML Email |
| 16 |
XML Master File and Text Email |
| 17 |
PDF Master File and HTML Email |
|
| <list_start_master_file> |
Allowable Values
| Values |
Description |
| 0 |
0 |
| 1 |
When value=1, account is listed at the top of the master file when generated. |
|
Error Codes
| Error Code/Description |
Associated Inputs |
|
|
|
1004: authentication error
Associated Inputs: auth_key, client_id, client_no
|
<auth_key>, <client_no> |
1009: account does not exist, Account not found: AriaNo (acct_no), Account not found: Userid (userid), or Account not found: ClientId (client_acct_id)
Associated Inputs: acct_no, account_no, client_acct_id, user_id, userid, parent_acct_no
|
<acct_no>, <client_acct_id> |
14046: If you passed in an invalid plan_instance_no, this message will appear: "Invalid Plan instance number". If you passed in an invalid master_plan_instance_id, this message will appear: "Invalid master_plan_instance_id".
Associated Inputs: plan_instance_no, master_plan_instance_id, filter_plan_instance_no, percent_eval_plan_instance_no, client_plan_instance_id
Additional Comments: The plan_instance_no or master_plan_instance_id must belong to the account, or it is invalid. The percent_eval_plan_instance_no must belong to the account and also to the MPI given in input.
|
<plan_instance_no>, <client_plan_instance_id> |
14047: If you passed in an invalid client_plan_instance_id, this message will appear: "Invalid client Plan instance identifier". If you passed in an invalid client_master_plan_instance_id , this message will appear: "Invalid client_master_plan_instance_id".
Associated Inputs: client_plan_instance_id, client_master_plan_instance_id, client_percent_eval_plan_instance_id
|
<client_plan_instance_id> |
26010: Invalid billing group number
Associated Inputs: billing_group_no
|
<billing_group_no> |
26012: Invalid client-defined billing group ID.
Associated Inputs: client_billing_group_id
|
<client_billing_group_id> |
