get_client_plans_all_m Guide

Last updated
Save as PDF

Returns a detailed list of all Active plans associated with a client. If you do not filter the call by acct_no, the information returned includes the services and rate schedules associated with the plans. If you filter the call by acct_no, or enter a plan_no or a client_plan_id that is a supplemental plan number, the information returned does not include any master plan service or rate schedule details.

API Specification:	get_client_plans_all_m
Required Fields:	<client_no> <auth_key>

Additional Guidance

The fields <client_parent_plan_id> and <client_plan_id> will supercede any values passed in the <parent_plan_no> and <plan_no> fields.
If invalid inputs for the fields <acct_no> or <client_acct_id> are passed, the return value for the <all_client_plan_dtls> array will be empty.

Input Fields

Field Name

Notes

<include_all_rate_schedules>

Allowable Values

Values	Description
true	true
false	false

<include_plan_hierarchy>

Allowable Values

Values	Description
true	true
false	false

<retrieve_bundled_nso>

Allowable Values

Values	Description
true	true
false	false

<retrieve_included_nso>

Allowable Values

Values	Description
true	true
false	false

<include_translations>

Allowable Values

Values	Description
true	true
false	false

Output Fields

Field Name

Notes

<supp_plan_ind>

Allowable Values

Values	Description
0	Master Plan
1	Supplemental Plan

<billing_ind>

Allowable Values

Values	Description
0	Plan is not billable.
1	Plan is billable.

<display_ind>

Allowable Values

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

<new_acct_status>

Allowable Values

Values	Description
0	INACTIVE
1	ACTIVE
2	CANCELLATION PENDING
3	TERMINATION PENDING
10	ACTIVE DUNNING PENDING
11	ACTIVE DUNNING 1
12	ACTIVE DUNNING 1
13	ACTIVE DUNNING 3
14	ACTIVE DUNNING 4
15	ACTIVE DUNNING 5
16	ACTIVE DUNNING 6
17	ACTIVE DUNNING 7
18	ACTIVE DUNNING 8
21	REINSTATED FORWARD BILL
22	REINSTATED BACK BILL
31	INSTALLATION PENDING
32	REGISTERED PENDING ACTIVATION
41	ACTIVE TRIAL
51	TEMPORARY SERVICE BAN
61	ACTIVE NON-BILLABLE
99	PERMANENT
-1	SUSPENDED
-2	CANCELLED
-3	TERMINATED
-4	CONTRACT EXPIRED
-11	SUSPENDED DUNNING 1
-12	SUSPENDED DUNNING 2
-13	SUSPENDED DUNNING 3
-14	SUSPENDED DUNNING 4
-15	SUSPENDED DUNNING 5
-99	ARCHIVED

<rollover_acct_status>

Allowable Values

Values	Description
0	INACTIVE
1	ACTIVE
2	CANCELLATION PENDING
3	TERMINATION PENDING
10	ACTIVE DUNNING PENDING
11	ACTIVE DUNNING 1
12	ACTIVE DUNNING 1
13	ACTIVE DUNNING 3
14	ACTIVE DUNNING 4
15	ACTIVE DUNNING 5
16	ACTIVE DUNNING 6
17	ACTIVE DUNNING 7
18	ACTIVE DUNNING 8
21	REINSTATED FORWARD BILL
22	REINSTATED BACK BILL
31	INSTALLATION PENDING
32	REGISTERED PENDING ACTIVATION
41	ACTIVE TRIAL
51	TEMPORARY SERVICE BAN
61	ACTIVE NON-BILLABLE
99	PERMANENT
-1	SUSPENDED
-2	CANCELLED
-3	TERMINATED
-4	CONTRACT EXPIRED
-11	SUSPENDED DUNNING 1
-12	SUSPENDED DUNNING 2
-13	SUSPENDED DUNNING 3
-14	SUSPENDED DUNNING 4
-15	SUSPENDED DUNNING 5
-99	ARCHIVED

<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

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

<rollover_plan_uom_cd>

Allowable Values

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

<init_free_period_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_uom_cd>

Allowable Values

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

<rollover_plan_status_cd>

Allowable Values

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

<nso_incl_list_scope>

Allowable Values

Values	Description
0	Indicates to inclusion type All non-restricted inventory items.
1	Indicates to inclusion type Existing bundled and non-restricted inventory items.
2	Indicates to inclusion type Existing bundled inventory items only.
3	Indicates to inclusion type Selected and non-restricted inventory items.
4	Indicates to inclusion type Selected specific inventory items.

<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

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

<is_setup_ind>

Allowable Values

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

<is_misc_ind>

Allowable Values

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

<is_donation_ind>

Allowable Values

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

<is_order_based_ind>

Allowable Values

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

<is_cancellation_ind>

Allowable Values

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

<display_ind>

Allowable Values

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

<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	Service is not a minimum fee.
1	Service is a minimum fee.

<future_rate>

Allowable Values

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

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.

<recurring_billing_period_type>

Allowable Values

Values	Description
1	Period type for recurring billing cycle is Daily.
2	Period type for recurring billing cycle is Weekly.
3	Period type for recurring billing cycle is Monthly.
4	Period type for recurring billing cycle is Quarterly.
5	Period type for recurring billing cycle is Yearly.

<usage_billing_period_type>

Allowable Values

Values	Description
1	Period type for usage billing cycle is Daily.
2	Period type for usage billing cycle is Weekly.
3	Period type for usage billing cycle is Monthly.
4	Period type for usage billing cycle is Quarterly.
5	Period type for usage billing cycle is Yearly.

<default_ind>

Allowable Values

Values	Description
0	Rate schedule is not the default.
1	Rate schedule is the default.

<default_ind_curr>

Allowable Values

Values	Description
0	Rate schedule is not default for specified currency.
1	Rate schedule is default for specified currency.

<schedule_display_ind>

Allowable Values

Values	Description
0	Rate schedule is not displayable.
1	Rate schedule is displayable.

<active_ind>

Allowable Values

Values	Description
0	Inventory item is not active.
1	Inventory item is active.

<plan_group_usage>

Allowable Values

Values	Description
C	By CSRs only within AdminTools
U	Within your User Self Service applications only
B	For both CSR and USS

<selectable_ind>

Allowable Values

Values	Description
0	Plan group is not selectable.
1	Plan group is selectable.

<first_retrieval_level_ind>

Allowable Values

Values	Description
true	This plan met the initial filtering criteria used to retrieve this list of plans.
false	This plan is a child plan (or other decendant) of a plan which met the initial criteria.

<is_mandatory>

Allowable Values

Values	Description
0	non-mandatory (default)
1	mandatory

<is_default>

Allowable Values

Values	Description
0	this will not be mapped as default plan to the respective parent plan (default)
1	this will be mapped as default plan to the respective parent plan

<enforcement_level>

Allowable Values

Values	Description
0	For each parent plan unit or Instance individually (default)
1	In aggregate across all units and instances of this parent plan on the Account

<active_ind>

Allowable Values

Values	Description
0	Inventory item is not active.
1	Inventory item is active.

<item_scope>

Allowable Values

Values	Description
0	Up to Plan Units
1	Match Plan Units
2	Any Units

<active_ind>

Allowable Values

Values	Description
0	0
1	1

<nso_group_item_scope>

Allowable Values

Values	Description
0	Up to Plan Units
1	Match Plan Units
2	Any Units

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>
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_all_rate_schedules>, <include_plan_hierarchy>
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_name>