get_avail_plans_for_acct_m Guide

Last updated
Save as PDF

Use this API to return a list of all plans available for assignment on a particular account. Available plans mean any master plans to create a new master plan instance(s), and any child plans (supplemental plans) of a master or supplemental plan that are available for assignment on the plan instances referred to as parent_plan_instance_no in the output array for this API.

API Specification:	get_avail_plans_for_acct_m
Required Fields:	<client_no> <auth_key> <acct_no> or <client_acct_id>

Additional Guidance

Input Fields

Field Name

Notes

<include_full_plan_hierarchy_plans>

Allowable values

Values	Description
true	Apart from returning the plans available to assign for a given plan_instance_no / client_plan_instance_id, it will additionally include plans available for assignment to all the supplemental plan instances in the plan hierarchy of the given plan_instance_no / client_plan_instance_id.
false	(Default) This will return the plans available to assign for the given plan_instance_no / client_plan_instance_id.

<include_rs_summary>

Allowable values

Values	Description
true	true
false (Default)	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_plan_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_plan_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	Indicates that the plan is not prepaid.
1	Indicates the plan is prepaid.

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

<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

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

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

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>
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_rs_summary>
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>
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>
14033: Invalid Promo Code Associated Inputs: promo_cd	<promo_cd>