get_acct_billing_group_details_m Guide
- Last updated
-
-
Save as PDF
-
The get_acct_billing_group_details_m API retrieves the details for a specified billing group, including the list of master plans associated with that billing group.
Additional Guidance
Output Fields
| Field Name |
Notes |
| <status> |
Allowable Values
| Values |
Description |
| 0 |
The status is "0", the billing group is disabled for this account. |
| 1 |
The status is "1", the billing group is active for this account. |
|
| <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 |
|
| <payment_option> |
Allowable Values
| Values |
Description |
| Methods |
Methods |
| Terms |
Terms |
|
| <payment_terms_type> |
Allowable Values
| Values |
Description |
| Net Terms |
Net Terms |
| EAN/GLN |
EAN/GLN |
|
| <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. |
|
| <pay_method_type> |
Allowable Values
| Values |
Description |
| -1 |
External Payment |
| 0 |
Other |
| 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 |
|
Error Codes
| Error Code/Description |
Associated Inputs |
|
|
|
1004: authentication error
|
<auth_key>, <client_id>, <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)
|
<acct_no>, <account_no>, <client_acct_id>, <user_id>, <userid>, <parent_acct_no> |
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".
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>, <master_plan_instance_id>, <filter_plan_instance_no>, <percent_eval_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".
|
<client_plan_instance_id>, <client_master_plan_instance_id>, <client_percent_eval_plan_instance_id> |
26010: Invalid billing group number
|
<billing_group_no> |
26012: Invalid client-defined billing group ID.
|
<client_billing_group_id> |
