Search the Aria Knowledgebase for
User Documentation, APIs, SDKs, and more!

 

Home > Aria Crescendo core api > get_master_plans_by_supp_field_m

get_master_plans_by_supp_field_m

Returns the master plans associated with a particular value for a supplemental object field.

Input Arguments

Req Field Name Field Type Max Length Description
client_no long 22 Aria-assigned unique identifier indicating the Aria client providing service to this account.
auth_key string 32 Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.
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
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

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.
master_plans_dtl_by_supp_field hash
plan_no long The unique ID of this plan
plan_name string The short name of this plan
plan_desc string The long description of this plan
billing_ind long Whether or not this plan is currently billable   Allowable Values
display_ind long Whether or not this plan is to be displayed to the end-users   Allowable Values
rollover_months long Number of months in which the account will change from the current plan to the pre-defined rollover plan.
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.
early_cancel_fee double Fee charged for early cancellations.
early_cancel_min_months long Number of months during which early cancellation fees would apply on plan cancellation.
suspension_period long Pre-defined period in days in which an account will degrade to Suspended status (-1) if action is not taken such as a plan or status change.
new_acct_status long The status code to assert for the new account.   Allowable Values
rollover_acct_status long Default status for new accounts created on this plan.   Allowable Values
rollover_acct_status_days long Number of days in which an account will change from the initial status code to the pre-defined rollover status code.
init_free_months long Initial free months.
plan_2_assign_on_susp long Plan to assign when an account on this plan is suspended.
default_notify_method long Default notification method given to an account that is assigned to this plan.   Allowable Values
prepaid_ind long Indicates whether or not this plan is prepaid   Allowable Values
currency_cd string The 3-character ISO-compliant currency code in lowercase for monetary values used in the context of this API method.
client_plan_id string Client-defined Plan ID for which to query available child plans
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.
client_plan_id_2_assign_on_susp string Client-defined Plan ID to assign when an account on this plan is suspended.
proration_invoice_timing_cd string Indicates whether to defer the pro-rated charges to the next anniversary date or to create a seperate invoice immediately.   Allowable Values
rollover_plan_duration long Duration of the plan rollover period (used in conjunction with rollover_plan_uom_cd).
rollover_plan_uom_cd long Units associated with the duration of the plan rollover period (used in conjunction with rollover_plan_duration).   Allowable Values
init_free_period_duration long Duration of the initial free period (used in conjunction with init_free_period_uom_cd).
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
initial_plan_status_cd long Default status used when master plan is initially assigned on an account.   Allowable Values
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 conjuction with rollover_plan_status_uom_cd).
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
rollover_plan_status_cd long Status used for the master plan instance at the completion of the plan status rollover period.   Allowable Values
plan_rate_schedules_details hash An array of the rate schedules for the requested plan
schedule_no long The ID of this rate schedule
client_rate_schedule_id string Client assigned unique rate schedule number
schedule_name string The name of this rate schedule
schedule_currency string The currency this rate schedule is linked to
recurring_billing_interval long Number of months between billing cycles for recurring
usage_billing_interval long Number of months between billing cycles for usage
default_ind long If true, this is the default rate schedule for the default currency   Allowable Values
default_ind_curr long If true, this is the default rate schedule for the specified currency   Allowable Values
schedule_display_ind long Determines whether the rate schedule is displayable   Allowable Values
available_from_dt string Start date of rate schedule
available_to_dt string End date of rate schedule
followup_rs_no long Aria internal ID of follow-up default rate schedule
client_followup_rs_id string Client-defined ID of followup rate schedule
contract_rollover_plan_no long Pre-defined plan to be used as the rollover plan at the completion of the contract.
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.
contract_rollover_rate_sched hash
contract_current_rate_sched_no long Current rate schedule for which the rollover rate schedule will be used at the completion of the contract
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
contract_rollover_rate_sched_no long Pre-defined rate schedule to be used as the rollover rate schedule at the completion of the contract
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
plan_translation_info hash
plan_no long The unique ID of this plan.
locale_name string Name of the locale.
plan_name string The short name of this plan.
plan_desc string The long description of this plan.
locale_no long Aria-assigned unique identifier of the locale used for translations. This value must be unique across all Aria clients.
rate_scheds_t hash
schedule_no long The ID of this rate schedule
schedule_name string The name of this rate schedule

You must to post a comment.
Last modified
12:50, 12 Oct 2017

Tags

This page has no custom tags.

Classifications

This page has no classifications.