get_acct_plans_all_m Guide

Last updated
Save as PDF

Returns the plan, service, and rate schedule data for all master and supplemental plans assigned to a specified account.

API Specification:	get_acct_plans_all_m
Required Fields:	<client_no> <auth_key> <acct_no>

Additional Guidance

Input Fields

Field Name

Notes

<include_service_supp_fields>

Allowable values

Values	Description
true	true
false	false

<include_product_fields>

Allowable values

Values	Description
true	true
false	false

<include_plan_instance_fields>

Allowable values

Values	Description
true	true
false	false

<include_plan_services>

Allowable values

Values	Description
true	true
false	false

<include_surcharges>

Allowable values

Values	Description
true	true
false	false

<include_rate_schedule>

Allowable values

Values	Description
true	true
false	false

<include_contract_and_rollover_info>

Allowable values

Values	Description
true	true
false	false

<include_dunning_info>

Allowable values

Values	Description
true	true
false	false

Output Fields

Field Name

Notes

<billing_ind>

Allowable values

Values	Description
0	0
1	1

<display_ind>

Allowable values

Values	Description
0	Not displayable
1	displayable

<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
-3	Terminated
-2	Cancelled
-1	Suspended
0	Inactive
1	Active
2	Pending Cancellation
3	Pending Termination
31	Pending Installation
32	Pending Activation
41	Trial
61	Active Non-billable

<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

<rollover_plan_uom_cd>

Allowable values

Values	Description
1	Day
2	Week
3	Month
4	Quarter
5	Year

<initial_plan_status_cd>

Allowable values

Values	Description
1	ACTIVE
41	ACTIVE TRIAL
61	ACTIVE NON-BILLABLE

<rollover_plan_status_cd>

Allowable values

Values	Description
1	ACTIVE
41	ACTIVE TRIAL
61	ACTIVE NON-BILLABLE

<default_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

<prepaid_ind>

Allowable values

Values	Description
0	0
1	1

<rate_sched_is_default_ind>

Allowable values

Values	Description
0	Alternate rate schedule
1	Default rate schedule

<supp_plan_ind>

Allowable values

Values	Description
0	Master plan
1	Supplemental plan

<plan_instance_status_cd>

Allowable values

Values	Description
-3	Terminated
-2	Cancelled
-1	Suspended
0	Inactive
1	Active
2	Pending Cancellation
3	Pending Termination
31	Pending Installation
32	Pending Activation
41	Trial
61	Active Non-billable

<plan_instance_status_label>

Allowable values

Values	Description
Terminated	Terminated
Cancelled	Cancelled
Suspended	Suspended
Inactive	Inactive
Active	Active
Pending Cancellation	Pending Cancellation
Pending Termination	Pending Termination
Pending Installation	Pending Installation
Pending Activation	Pending Activation
Trial	Trial
Active Non-billable	Active Non-billable

<dunning_state>

Allowable values

Values	Description
0	None
1	In Progress

<proration_invoice_timing_cd>

Allowable values

Values	Description
I	Indicates to generate the invoice immediately for the pro-rated charges.
A	Indicates to generate the invoice to the next anniversary date for the pro-rated charges.

<is_recurring_ind>

Allowable values

Values	Description
0	Service is not recurring-based.
1	Service is recurring-based.

<is_usage_based_ind>

Allowable values

Values	Description
0	Service is not usage-based.
1	Service is usage-based.

<taxable_ind>

Allowable values

Values	Description
0	Service is not taxable.
1	Service is taxable.

<is_tax_ind>

Allowable values

Values	Description
0	Service is not a tax-based service.
1	Service is a tax-based service.

<is_arrears_ind>

Allowable values for is_arrears_ind:

Values	Description
0	Service is not arrears-based.
1	Service is arrears-based.

<is_setup_ind>

Allowable values for is_setup_ind:

Values	Description
0	Service is not setup-based.
1	Service is setup-based.

<is_misc_ind>

Allowable values for is_misc_ind:

Values	Description
0	Service is not miscellaneous.
1	Service is miscellaneous.

<is_donation_ind>

Allowable values for is_donation_ind:

Values	Description
0	Service is not donation-based.
1	Service is donation-based.

<is_order_based_ind>

Allowable values for is_order_based_ind:

Values	Description
0	Service is not order-based.
1	Service is order-based.

<is_cancellation_ind>

Allowable values for is_cancellation_ind:

Values	Description
0	Service is not cancellation-based.
1	Service is cancellation-based.

<display_ind>

Allowable values for display_ind:

Values	Description
0	Service is not displayable.
1	Service is displayable.

<tiered_pricing_rule>

Allowable values for tiered_pricing_rule:

Values	Description
1	Standard
2	Volume Discount
3	Flat Rate Per Tier

<is_min_fee_ind>

Allowable values for is_min_fee_ind:

Values	Description
0	Service is not a minimum fee.
1	Service is a minimum fee.

<future_rate>

Allowable values for future_rate:

Values	Description
0	false, i.e., no future rate.
1	True, i.e., future rates are captured.
	null, i.e., no future rate.

<apply_usage_rates_daily>

Allowable values for apply_usage_rates_daily:

Values	Description
0	usage shall be rated based on the entire billing period
1	usage shall be rated based on one day periods individually.

<is_recurring_ind>

Allowable values

Values	Description
0	0
1	1

<is_usage_based_ind>

Allowable values

Values	Description
0	0
1	1

<taxable_ind>

Allowable values

Values	Description
0	0
1	1

<is_tax_ind>

Allowable values

Values	Description
0	0
1	1

<is_arrears_ind>

Allowable values

Values	Description
0	0
1	1

<is_setup_ind>

Allowable values

Values	Description
0	0
1	1

<is_misc_ind>

Allowable values

Values	Description
0	0
1	1

<is_donation_ind>

Allowable values

Values	Description
0	0
1	1

<is_order_based_ind>

Allowable values

Values	Description
0	0
1	1

<is_cancellation_ind>

Allowable values

Values	Description
0	0
1	1

<display_ind>

Allowable values

Values	Description
0	0
1	1

<tiered_pricing_rule>

Allowable values

Values	Description
1	Standard
2	Volume Discount
3	Flat Rate Per Tier

<is_min_fee_ind>

Allowable values

Values	Description
0	0
1	1

<apply_usage_rates_daily>

Allowable values

Values	Description
0	usage shall be rated based on the entire billing period
1	usage shall be rated based on one day periods individually.

<tax_inclusive_ind>

Allowable values

Values	Description
0	The service is tax-exclusive.
1	The service is tax-inclusive.

<usage_rating_time_ind>

Allowable Values

Values	Description
0	Refers to the setting you have on client parameter "Automatically Rate Un-rated Usage Records at Load Time"
1	At Loading Time
2	At Invoicing Time

<usage_record_rating_level_ind>

Allowable Values

Values	Description
0	Rating will be performed with aggregated usage units.
1	Rating will be performed at per usage record level.

<invoice_app_method>

Allowable values

Values	Description
I	Inline
O	Offset

<months_renewal_option>

Allowable values

Values	Description
NULL or 1	Recurring / Auto Renew.(Default)
2	Single Use.

<plan_instance_services> (array)

<plan_services> (array)

<usage_record_taxation_level_ind>

Allowable Values

Values	Description
0	Taxation will be performed with aggregated usage charges.
1	Taxation will be performed at per-usage-record level.

Error Codes

Error Code/Description	Associated Inputs
1001: unexpected error
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>
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>, <client_plan_instance_id>, <plan_instance_no>, <limit>, <offset>, <acct_no>, <billing_group_no>
1033: a parameter that represents a true or false value contains invalid input Associated Inputs: alt_collect_on_approve, alt_send_statement_on_approve, cancel_orders_on_discard, cascade_action, do_auto_discard, do_collect, change_status_after_coll, reset_dates_after_status, disable_existing_on_update, do_write, exclude_terminated_plan_inst, include_all_rate_schedules, include_plan_hierarchy, retrieve_bundled_nso, retrieve_included_nso, include_translations, include_inactive_items, include_invoice_activity_eligibility, include_rs_summary, include_translations, include_service_supp_fields/include_product_fields/, include_plan_instance_fields/include_plan_services/, include_surcharges, include_void_transactions, include_voided, invoice_unbilled_usage, is_unlinked_refund, record_cc_on_auth_failure, retrieve_excluded_usage, send_email, usage_pooling, do_write	<include_service_supp_fields>, <include_product_fields>, <include_plan_instance_fields>, <include_plan_services>, <include_surcharges>
1066: Locale name does not exist in the system. Associated Inputs: locale_name	<locale_name>
1067: Locale no does not exist in the system. Associated Inputs: locale_no, master_plan_instance_no	<locale_no>, <master_plan_instance_no>
5023: number of supp field values does not meet required minimum number of values Associated Inputs: supp_field_value Additional Comments: The number of values given for a given field must meet the min values criteria set at configuration.	<supp_field_value>
5067: limit must be between 1 and 999. Associated Input: limit, record_limit, contract_limit	<limit>
5068: offset must be greater than or equal to zero. Associated Input: offset, contract_offset	<offset>
6005: invalid supplemental field Associated Inputs: supp_field_name Additional Comments: Unknown field name.	<supp_field_name>
14004: Invalid_plan_no Associated Inputs: new_plan_no, rollover_plan_no	<rollover_plan_no>
14035: Invalid client Plan id Associated Inputs: client_plan_id, custom_rate_client_plan_instance_id	<client_plan_id>
14036: Invalid client service id Associated Inputs: client_service_id, client_plan_instance_service_id, client_percent_eval_service_id, custom_rate_client_service_id	<client_service_id>
14053: Invalid Master Plan Instance number Associated Inputs: master_plan_instance_no	<master_plan_instance_no>
14054: Invalid client Master Plan Instance identifier Associated Inputs: client_master_plan_instance_id	<client_master_plan_instance_id>
14107: Invalid Service Number. Associated Input: custom_rate_service_no	<custom_rate_service_no>
14130: Ensure include_plan_services or include_surcharges is marked as true when setting include_rate_schedule as true. Requesting rate schedules while excluding services and surcharges creates a conflict where no rate schedules will be displayed. Associated Inputs: include_rate_schedule, include_plan_services, include_surcharges	<include_rate_schedule>, <include_plan_services>, <include_surcharges>
14131: More than 10 inputs have been found in an array that is limited to 10 inputs. Please reduce the number of inputs. Associated Inputs: product_catalog_plan_filter[], service_no_filter[], master_plan_instance_filter[], supplemental_field_filter[]	<product_catalog_plan_filter[]>, <service_no_filter[]>, <master_plan_instance_filter[]>, <supplemental_field_filter[]>
14222: Include Plan service in order to retrieve Plan service supplemental fields. Associated Inputs: include_plan_services, include_service_supp_fields Additional Comments: If the include_service_supp_fields is true and include_plan_services is false then this error occurs.	<include_plan_services>, <include_service_supp_fields>