Home > Aria Crescendo Documentation > Aria Crescendo core api > get_supp_plans_by_supp_field_m

get_supp_plans_by_supp_field_m

Returns a list of supplemental plans associated with a specified value for a supplemental object field.

Input Arguments

Req Field Name Field Type Max Length Description
required-icon.png client_no long 22 Aria-assigned unique identifier indicating the Aria client providing service to this account.
required-icon.png auth_key string 32 Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.
required-icon.png field_val string   The value of the supplemental field which all returned plans should possess
  field_no long   The plan supplemental field number which is being searched against
  field_name string   The optional name of this supplemental field, if the number is not known
  include_rs_summary string   If set to "true", will retrieve summary level rate schedule information for all the rate schedules that are associated with a particular plan. If left blank, will default to "false".  

Allowable values for include_rs_summary:

Values Description
true true
false false
  locale_no long 22 Aria-assigned unique identifier of the locale used for translations. This value must be unique across all Aria clients.
  OR      
  locale_name string 50 Name of the locale.
  include_translations string   Setting this flag as True will fetch the translated fields in all the locales defined. If not passed it defaults to False.  

Allowable values for include_translations:

Values Description
true true
false false

Output Arguments

Field Name Field Type Description
error_code long Aria-assigned error identifier. 0 indicates no error.
error_msg string Description of any error that occurred. "OK" if there was no error.
supp_plans_dtl_by_supp_field hash  
brd_arrow.gif plan_no long The unique ID of this plan
brd_arrow.gif plan_name string The short name of this plan
brd_arrow.gif plan_desc string The long description of this plan
brd_arrow.gif billing_ind long Whether or not this plan is currently billable  

Allowable values for billing_ind:

Values Description
0 0
1 1
brd_arrow.gif display_ind long Whether or not this plan is to be displayed to the end-users  

Allowable values for display_ind:

Values Description
0 Displayable
1 Non displayable
brd_arrow.gif rollover_months long Number of months in which the account will change from the current plan to the pre-defined rollover plan.
brd_arrow.gif rollover_plan_no long Pre-defined plan to which the account will change based on the defined rollover_months value; the rollover record is created when an account is placed on a plan with a defined rollover plan.
brd_arrow.gif plan_2_assign_on_susp long Plan to assign when an account on this plan is suspended.
brd_arrow.gif default_notify_method long Default notification method given to an account that is assigned to this plan.  

Allowable values for default_notify_method:

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
brd_arrow.gif prepaid_ind long Indicates whether or not this plan is prepaid  

Allowable values for prepaid_ind:

Values Description
0 0
1 1
brd_arrow.gif currency_cd string The 3-character ISO-compliant currency code in lowercase for monetary values used in the context of this API method.
brd_arrow.gif client_plan_id string Client-defined Plan ID for which to query available child plans
brd_arrow.gif client_rollover_plan_id string Pre-defined plan to which the account will change based on the defined rollover_months value; the rollover record is created when an account is placed on a plan with a defined client rollover plan ID.
brd_arrow.gif client_plan_id_2_assign_on_susp string Client-defined Plan ID to assign when an account on this plan is suspended.
brd_arrow.gif proration_invoice_timing_cd string Indicates whether to defer the pro-rated charges to the next anniversary date or to create a separate invoice immediately.  

Allowable values for proration_invoice_timing_cd:

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.
brd_arrow.gif rollover_plan_duration long Duration of the plan rollover period (used in conjunction with rollover_plan_uom_cd).
brd_arrow.gif rollover_plan_uom_cd long Units associated with the duration of the plan rollover period (used in conjunction with rollover_plan_duration).  

Allowable values for rollover_plan_uom_cd:

Values Description
1 Day
2 Week
3 Month
4 Quarter
5 Year
brd_arrow.gif init_free_period_duration long Duration of the initial free period (used in conjunction with init_free_period_uom_cd).
brd_arrow.gif init_free_period_uom_cd long Units associated with the duration of the initial free period (used in conjunction with init_free_period_duration).  

Allowable values for init_free_period_uom_cd:

Values Description
1 Day
2 Week
3 Month
4 Quarter
5 Year
brd_arrow.gif initial_plan_status_cd long Default status used when master plan is initially assigned on an account.  

Allowable values for initial_plan_status_cd:

Values Description
1 ACTIVE
41 ACTIVE TRIAL
61 ACTIVE NON-BILLABLE
brd_arrow.gif rollover_plan_status_duration long Duration of the plan status rollover period, after which the initial plan status on the master plan instance will change to the pre-defined rollover plan status (used in conjunction with rollover_plan_status_uom_cd).
brd_arrow.gif rollover_plan_status_uom_cd long Units associated with the duration of the plan status rollover period after which the initial plan status on the master plan instance will change to the pre-defined rollover plan status. (used in conjunction with rollover_plan_status_duration).  

Allowable values for rollover_plan_status_uom_cd:

Values Description
1 Day
2 Week
3 Month
4 Quarter
5 Year
brd_arrow.gif rollover_plan_status_cd long Status used for the master plan instance at the completion of the plan status rollover period.  

Allowable values for rollover_plan_status_cd:

Values Description
1 ACTIVE
41 ACTIVE TRIAL
61 ACTIVE NON-BILLABLE
brd_arrow.gif plan_rate_schedules_details hash An array of the rate schedules for the requested plan
brd_arrow.gif schedule_no long The ID of this rate schedule
brd_arrow.gif client_rate_schedule_id string Client assigned unique rate schedule number
brd_arrow.gif schedule_name string The name of this rate schedule
brd_arrow.gif schedule_currency string The currency this rate schedule is linked to
brd_arrow.gif recurring_billing_interval long Number of months between billing cycles for recurring
brd_arrow.gif usage_billing_interval long Number of months between billing cycles for usage
brd_arrow.gif recurring_billing_period_type long Period type for billing cycles for recurring.  

Allowable values for recurring_billing_period_type:

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.
brd_arrow.gif usage_billing_period_type long Period type for billing cycles for usage.  

Allowable values for usage_billing_period_type:

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.
brd_arrow.gif default_ind long If true, this is the default rate schedule for the default currency  

Allowable values for default_ind:

Values Description
0 Rate schedule is not the default.
1 Rate schedule is the default.
brd_arrow.gif default_ind_curr long If true, this is the default rate schedule for the specified currency  

Allowable values for default_ind_curr:

Values Description
0 Rate schedule is not default for specified currency.
1 Rate schedule is default for specified currency.
brd_arrow.gif schedule_display_ind long Determines whether the rate schedule is displayable  

Allowable values for schedule_display_ind:

Values Description
0 Rate schedule is not displayable.
1 Rate schedule is displayable.
brd_arrow.gif available_from_dt string Start date of rate schedule
brd_arrow.gif available_to_dt string End date of rate schedule
brd_arrow.gif followup_rs_no long Aria internal ID of follow-up default rate schedule
brd_arrow.gif client_followup_rs_id string Client-defined ID of followup rate schedule
brd_arrow.gif contract_rollover_plan_no long Pre-defined plan to be used as the rollover plan at the completion of the contract.
brd_arrow.gif contract_rollover_client_plan_id string Client-defined ID of the pre-defined plan to be used as the rollover plan at the completion of a contract.
brd_arrow.gif contract_rollover_rate_sched hash  
brd_arrow.gif contract_current_rate_sched_no long Current rate schedule for which the rollover rate schedule will be used at the completion of the contract
brd_arrow.gif contract_current_client_rate_sched_id string Client-defined ID of the current rate schedule for which the rollover rate schedule will be used at the completion of the contract
brd_arrow.gif contract_rollover_rate_sched_no long Pre-defined rate schedule to be used as the rollover rate schedule at the completion of the contract
brd_arrow.gif contract_rollover_client_rate_sched_id string Client-defined ID of the pre-defined rate schedule to be used as the rollover rate schedule at the completion of the contract
brd_arrow.gif plan_translation_info hash  
brd_arrow.gif plan_no long The unique ID of this plan.
brd_arrow.gif locale_name string Name of the locale.
brd_arrow.gif plan_name string The short name of this plan.
brd_arrow.gif plan_desc string The long description of this plan.
brd_arrow.gif locale_no long Aria-assigned unique identifier of the locale used for translations. This value must be unique across all Aria clients.
brd_arrow.gif rate_scheds_t hash  
brd_arrow.gif schedule_no long The ID of this rate schedule
brd_arrow.gif schedule_name string The name of this rate schedule
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.
Powered by CXone Expert ®