get_master_plans_by_supp_field_m Guide
- Last updated
-
-
Save as PDF
Use this API to return master plans associated with a specific value for a supplemental object field.
Error Codes:
Error Code/Description |
Associated Inputs |
|
|
|
|
1004: authentication error
Associated Inputs: auth_key, client_id, client_no
|
<auth_key>, <client_no> |
1010: missing required parameters, Missing input: (object-name) is required with assignment_directive ($AriaNo)
Associated Inputs: all required inputs, typically one of the following: custom_rate_per_unit, custom_rate_seq_no, status_cd, dunning_state, userid, acct_no, client_acct_id, assignment_directive, billing_group_no, client_billing_group_id, threshold_billing_rule_no, client_threshold_billing_rule_id
Alternate Message Output
1010: username is required
1010: first name is required
1010: last name is required
1010: email is required
1010: roles are required
Associated APIs: create_user_m, get_user_details_m, delete_user_m, update_user_m
Associated Inputs: username, first_name, last_name, email, role_no
|
<acct_no> |
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.
|
<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, <include_translations>
|
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> |
Additional Guidance
Input Fields
Field Name |
Notes |
<include_rs_summary> |
Allowable values
Values |
Description |
true |
true |
false |
false |
|
<include_translations> |
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 |
Displayable |
1 |
Non 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 |
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 |
|
<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. |
|