This API returns a detailed set of information about an account. In addition to contact, demographic, and basic billing configuration information, you can optionally retrieve plan information, billing group information, and payment method information.
| API Specification: |
get_acct_details_all_m
|
| Required Fields: |
- <client_no>
- <auth_key>
- <acct_no> or <client_acct_id>
|
Additional Guidance
Input Fields
| Field Name: |
Notes: |
| <plan_limit> |
The records will be returned in ascending order by Master Plan Instance ID.
Example: You have an account that has 4 Master Plan Instances with ID numbers: 123, 234, 456, and 567. If you pass 2into this field, only Master Plan Instances 123 and 234 will be returned in the <master_plans_info> output array.
If you don't pass a value into this field, then all records that match your input parameters will be returned.
|
| <plan_offset> |
The records will be skipped in ascending order by Master Plan Instance ID.
Example: You have an account that has 4 Master Plan Instances with ID numbers: 123, 234, 456, and 567. If you pass ;into this field, only Master Plan Instances 456 and 567 will be returned in the <master_plans_info> output array.
If you don't pass a value into this field, then it will default to 0.
|
<filter_mpi_status> (array)
<filter_mpi_status_cd>
|
This is a filter based on the status of the Master Plans for the current API call. This input helps to filter out the Master Plan Instances based on the given statuses, thus improve the response time of the API. For example, an account might have four Master Plan Instances with different statuses, such as, Active, Pending Activation, Pending Termination and Suspended. If you pass the array to filter statuses of values "1" and "2", then only those Master Plan Instances that are in Active and Pending Activation are returned.
If you do not pass any values in this input, then the default behavior is that the API will return all the Master Plan Instances irrespective of Master Plan Instance status.
|
<filter_spi_status> (array)
<filter_spi_status_cd>
|
This is a filter based on the status of the Supplemental Plans for the current API call. Some plans may not be returned if the <mpi_status_code> used does not return the Master Plan Instance. If a status is inherited due to pending action on Master Plan Instance, it will not be reflected in the output array.
For example, an account might have four Master Plan Instances and four Supplemental Plans with different statuses, such as, Active, Pending Activation, Suspended and Active. If you pass the array to filter Master Plan Instance statuses (filter_mpi_status_cd) with values "1" and "2" and similarly if you pass the array to filter Supplemental Plan statuses (filter_spi_status_cd) with values "3" and "1", then the API will return the Master Plan Instance/Supplemental Plan based on the given combination of status filters. The Supplemental Plan alone will not be returned if the corresponding Master Plan Instance is not returned, that is, if the Master Plan Instance status code used does not return the Master Plan Instance.
If you do not pass any values in this input, then the default behavior is that the API will return all the Supplemental Plans irrespective of their status for the corresponding Master Plan Instance.
Note: The invalid status validation for Supplemental Plans will be considered only when you pass "include_supp_plans" as with the value "1".
|
| <include_master_plans> |
Allowable Values
| Values |
Description |
| 1 |
Yes (default) |
| 0 |
No |
|
| <include_supp_plans> |
Allowable Values
| Values |
Description |
| 1 |
Yes |
| 0 |
No (default) |
|
| <include_billing_groups> |
Allowable Values
| Values |
Description |
| 1 |
Yes |
| 0 |
No (default) |
|
| <include_payment_methods> |
Allowable Values
| Values |
Description |
| 1 |
Yes |
| 0 |
No (default) |
|
| <filter_mpi_status_cd> |
Allowable Values
| Values |
Description |
| 1 |
Active |
| 2 |
Pending Cancellation |
| 3 |
Pending Termination |
| 31 |
Pending Installation |
| 32 |
Pending Activation |
| 41 |
Trial |
| 61 |
Active Non-billable |
| 0 |
Inactive |
| -1 |
Suspended |
| -2 |
Cancelled |
| -3 |
Terminated |
|
| <filter_spi_status_cd> |
Allowable Values
| Values |
Description |
| 1 |
Active |
| 2 |
Pending Cancellation |
| 3 |
Pending Termination |
| 31 |
Pending Installation |
| 32 |
Pending Activation |
| 41 |
Trial |
| 61 |
Active Non-billable |
| 0 |
Inactive |
| -1 |
Suspended |
| -2 |
Cancelled |
| -3 |
Terminated |
|
Output Fields
| Field Name |
Notes |
| <status_cd> |
Allowable Values
| Values |
Description |
| 0 |
Inactive |
| 1 |
Active |
| 32 |
Registered Pending Activation |
| 51 |
Temporary Service Ban |
| 99 |
Permanent |
| -99 |
Archived |
|
| <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 |
|
| <test_acct_ind> |
Allowable Values
| Values |
Description |
| 1 |
test |
| 0 |
live |
|
| <tax_exemption_level> |
Allowable Values
| Values |
Description |
| 0 |
Account is not exempt from taxation (default). |
| 1 |
Account is exempt from state/province taxation. |
| 2 |
Account is exempt from federal/national taxation. |
| 3 |
Account is exempt from both federal/national and state/province taxation. |
|
| <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. |
|
| <invoice_approval_required> |
Allowable Values
| Values |
Description |
| 0 |
not required |
| 1 |
required |
|
| <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 |
|
| <bg_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 |
|
| <initial_plan_status> |
Allowable Values
| Values |
Description |
| 1 |
Active |
| 2 |
Pending Cancellation |
| 3 |
Pending Termination |
| 31 |
Pending Installation |
| 32 |
Pending Activation |
| 41 |
Trial |
| 61 |
Active Non-billable |
| 0 |
Inactive |
| -1 |
Suspended |
| -2 |
Cancelled |
| -3 |
Terminated |
|
| <rollover_plan_status> |
Allowable Values
| Values |
Description |
| 1 |
Active |
| 2 |
Pending Cancellation |
| 3 |
Pending Termination |
| 31 |
Pending Installation |
| 32 |
Pending Activation |
| 41 |
Trial |
| 61 |
Active Non-billable |
| 0 |
Inactive |
| -1 |
Suspended |
| -2 |
Cancelled |
| -3 |
Terminated |
|
| <rollover_plan_status_uom_cd> |
Allowable Values
| Values |
Description |
| 1 |
Day |
| 2 |
Week |
| 3 |
Month |
| 4 |
Quarter |
| 5 |
Year |
|
| <init_free_period_uom_cd> |
Allowable Values
| Values |
Description |
| 1 |
Day |
| 2 |
Week |
| 3 |
Month |
| 4 |
Quarter |
| 5 |
Year |
|
| <dunning_state> |
Allowable Values
| Values |
Description |
| 0 |
None |
| 1 |
In Progress |
| 2 |
Completed |
|
| <rollover_plan_status> |
Allowable Values
| Values |
Description |
| 1 |
Active |
| 2 |
Pending Cancellation |
| 3 |
Pending Termination |
| 31 |
Pending Installation |
| 32 |
Pending Activation |
| 41 |
Trial |
| 61 |
Active Non-billable |
| 0 |
Inactive |
| -1 |
Suspended |
| -2 |
Cancelled |
| -3 |
Terminated |
|
| <rollover_plan_status_uom_cd> |
Allowable Values
| Values |
Description |
| 1 |
Day |
| 2 |
Week |
| 3 |
Month |
| 4 |
Quarter |
| 5 |
Year |
|
Error Codes
| Error Code/Description |
Associated Inputs |
|
|
|
1004: authentication error
|
<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)
|
<acct_no>, <client_acct_id>, <userid> |
1016: invalid input
Additional Comments: This error can be caused by the wrong type of input; for example, text in a numbers-only field, or specifying a value other than one of the documented allowable values.
|
<client_billing_group_id>, <plan_instance_no>, <plan_instance_service_no>, <client_plan_instance_id>, <plan_instance_no>, <plan_instance_service_no>, <email>, <include_master_plans>, <include_supp_plans>, <include_billing_groups>, <include_payment_methods>, <phone_ext>, <work_phone_ext>, <plan_units>, <reason_code>, <status_cd>, <acct_no>, <billing_group_no>
|
1066: Locale name does not exist in the system.
|
<locale_name> |
1067: Locale no does not exist in the system.
|
<locale_name>, <master_plan_instance_no> |
14121: Include Master Plan Instances in order to retrieve Supplemental Plan instances.
Additional Comments: You must include Master Plans when retreiving suplemental Plans.
|
<include_master_plans>, <include_supp_plans> |
26004: Include billing groups in order to retrieve payment methods.
|
<include_billing_groups>, <include_payment_methods> |
