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



 

Home > Aria Crescendo core api > get_avail_plans_for_acct_all_m

get_avail_plans_for_acct_all_m

Use this API to return a list of all plan, (including services, rate schedule details, and supplemental fields), 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.

For error messages generated by this API, see get_avail_plans_for_acct_all_m Error Messages.

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 acct_no long 22 Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
  plan_instance_no long 22 The unique identifier of the plan instance (can be either a master or supplemental plan) under which a new plan can be assigned. If NULL, retrieves any child plans (including services, and default rate schedules) available for assignment associated with an account's master plan instance(s), along with returning All available master plans (including services, and default rate schedules) available for assignment.
  OR      
  client_plan_instance_id string 100
The client-defined unique identifier of the plan instance (can be either a master or supplemental plan) under which a new plan can be assigned. If NULL, retrieves any child plans (including services, and default rate schedules) available for assignment associated with an account's master plan instance(s), along with returning All available master plans (including services, and default rate schedules) available for assignment.
  promo_cd string 30 Limits the list of master plans available for assignment based on the associated promo code.
  include_full_plan_hierarchy_plans string 5 Use this input parameter to additionally return plans available for assignment to all the supplemental plan instances in the hierarchy (i.e. child supplemental plan instances, grandchild supplemental plan instances, etc,) of the given plan_instance_no / client_plan_instance_id. This input is ignored if plan_instance_no / client_plan_instance_id is not passed.  Allowable Values
  include_rs_summary string 5 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 Locale identifier. This value is unique across all Aria-managed accounts.
  OR      
  locale_name string 100 Name of the locale.
  alt_caller_id string 30 Person or process that submitted the API call. This can be someone's user ID, or the name of an application.
  optional_transaction_qualifiers array   Array of additional values you can associate with this API call.
  brd_arrow.gif qualifier_name string 100 Name of the field you want to associate with this API call.
  brd_arrow.gif qualifier_value string 100 Corresponding value of the field you want to associate with this API call.

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.
all_client_plans_services hash  
brd_arrow.gif parent_plan_instance_no long This references the master / supplemental plan instance to which this supplemental plan can be assigned to. If the current record's plan is a master plan, this field will be empty as the master plan will be assigned at the account level.
brd_arrow.gif parent_client_plan_instance_id string This references the master / supplemental plan's client-defined plan instance identifier to which this supplemental plan can be assigned to. If the current record's plan is a master plan, this field will be empty as the master plan will be assigned at the account level.
brd_arrow.gif plan_no long Aria-assigned unique plan identifier
brd_arrow.gif client_plan_id string Client assigned unique plan identifier
brd_arrow.gif plan_name string Plan Name
brd_arrow.gif plan_desc string Text description of this plan
brd_arrow.gif supp_plan_ind long Indicates whether or not this plan is a supplemental plan.   Allowable Values
brd_arrow.gif billing_ind long Indicates whether or not this plan is billable. This applies to Master Plans only. Supplemental Plans inherit this property from their associated Master Plans.   Allowable Values
brd_arrow.gif display_ind long Indicates whether or not the plan is marked as "displayable". 0 means not displayable. 1 means displayable.   Allowable Values
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 client_rollover_plan_id string Pre-defined client rollover plan ID 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 early_cancel_fee double Fee charged for early cancellations.
brd_arrow.gif early_cancel_min_months long Number of months during which early cancellation fees would apply on plan cancellation. This field is only applicable for master plans.
brd_arrow.gif 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.
brd_arrow.gif new_plan_status long The status code to assert for the new account.   Allowable Values
brd_arrow.gif rollover_plan_status long Status used for the master plan instance at the completion of the rollover period.   Allowable Values
brd_arrow.gif rollover_plan_status_days long Number of days in which an account will change from the initial status code to the pre-defined rollover status code.
brd_arrow.gif init_free_months long Initial free months.
brd_arrow.gif plan_2_assign_on_susp long Plan to assign when an account on this plan is suspended.
brd_arrow.gif client_plan_2_assign_on_susp string Client-defined Plan identifier 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
brd_arrow.gif prepaid_ind long Indicates whether or not this plan is prepaid   Allowable Values
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 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
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
brd_arrow.gif initial_plan_status_cd long Default status used when master plan is initially assigned on an account.   Allowable Values
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 conjuction 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
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
brd_arrow.gif plan_services hash A multidimensional array of Services for this plan
brd_arrow.gif service_no long Aria assigned service number.
brd_arrow.gif service_desc string Description of this service
brd_arrow.gif is_recurring_ind long Indicates whether or not this service is a recurring service   Allowable Values
brd_arrow.gif is_usage_based_ind long Indicates whether or not this service is a usage-based service   Allowable Values
brd_arrow.gif usage_type long The usage type supported by this usage based service
brd_arrow.gif taxable_ind long Indicates whether or not this service is taxable   Allowable Values
brd_arrow.gif is_tax_ind long Indicates whether or not this service is a tax-based service   Allowable Values
brd_arrow.gif is_arrears_ind long Indicates whether or not this service is an arrears-based service   Allowable Values
brd_arrow.gif is_setup_ind long Indicates whether or not this service is a setup-based service   Allowable Values
brd_arrow.gif is_misc_ind long Indicates whether or not this service is a miscellaneous service   Allowable Values
brd_arrow.gif is_donation_ind long Indicates whether or not this service is a donation-based service   Allowable Values
brd_arrow.gif is_order_based_ind long Indicates whether or not this service is an order-based service   Allowable Values
brd_arrow.gif is_cancellation_ind long Indicates whether or not this service is a cancellation- based service   Allowable Values
brd_arrow.gif coa_id string Chart of accounts ID
brd_arrow.gif ledger_code string This field is deprecated in favor of coa_id
brd_arrow.gif client_coa_code string The client-defined override for coa_id
brd_arrow.gif display_ind long Indicates if this service is displayable or not   Allowable Values
brd_arrow.gif tiered_pricing_rule long The Tiered Pricing Rule   Allowable Values
brd_arrow.gif is_min_fee_ind long Indicates whether or not this service is a minimum fee.   Allowable Values
brd_arrow.gif client_service_id string The client-defined Service ID for this plan.
brd_arrow.gif usage_type_cd string Denotes which usage type to record.
brd_arrow.gif all_service_supp_fields hash  
brd_arrow.gif field_name string The machine-readable name of this field
brd_arrow.gif field_desc string The human-readable name of this field
brd_arrow.gif field_order_no long The sort order of this field
brd_arrow.gif field_value string The value stored in this field
brd_arrow.gif fulfillment_based_ind long Indicates if the service is Fulfillment Based or not.
brd_arrow.gif svc_location_no long The Aria-assigned unique identifier for the origin location for the service.
brd_arrow.gif client_svc_location_id string The client-defined location identifier for the origin location for the service.
brd_arrow.gif svc_location_name string The name of the origin location for the service.
brd_arrow.gif svc_location_company_name string Company name of the service location.
brd_arrow.gif svc_location_address1 string First address line of the service location.
brd_arrow.gif svc_location_address2 string Second address line of the service location. If you want to delete existing data in this field, leaving it blank, you must enter a '~' in this field.
brd_arrow.gif svc_location_address3 string Third address line of the service location.
brd_arrow.gif svc_location_city string City of the service location.
brd_arrow.gif svc_location_locality string Locality of the service location.
brd_arrow.gif svc_location_state_prov string State or Province of the service location. The official postal-service codes for all United States, Australia and Canada states, provinces, and territories. This field does not support states, provinces or territories from other countries. Use the locality field for other countries.
brd_arrow.gif svc_location_country string Country of the location contact. The ISO-compliant 2-character country code abbreviation in uppercase.
brd_arrow.gif svc_location_postal_cd string Postal/Zip code for the service location address.
brd_arrow.gif plan_service_rates hash Represents the rates for the default rate schedule for the default currency for the plan
brd_arrow.gif rate_seq_no long Sequential number in the rate schedule for dertermining tiers
brd_arrow.gif from_unit double Tiered Units (from) This value represents the start of a tiered range of values.
brd_arrow.gif to_unit double Tiered Units (to) This value represents the end of the range for a single tier of values.
brd_arrow.gif rate_per_unit double The cost per unit of this service over the time period the plan is billed for
brd_arrow.gif future_rate_per_unit double The future cost per unit of this service over the time period the plan is billed for
brd_arrow.gif monthly_fee double If the plan interval is more than one month, this field will rate per unit per month
brd_arrow.gif client_rate_schedule_id string Client assigned unique rate schedule number
brd_arrow.gif rate_tier_description string Rate Tier Description
brd_arrow.gif all_plan_service_rates hash All rates for all rate schedules and currencies for this plan
brd_arrow.gif schedule_no long Rate schedule number
brd_arrow.gif client_rate_schedule_id string Client assigned unique rate schedule number
brd_arrow.gif future_rate long Indicates whether future rates are captured or not.   Allowable Values
brd_arrow.gif future_change_date string Future Change Date of the rates.
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 plan_service_rates hash Represents the rates for the default rate schedule for the default currency for the plan
brd_arrow.gif rate_seq_no long Sequential number in the rate schedule for dertermining tiers
brd_arrow.gif from_unit double Tiered Units (from) This value represents the start of a tiered range of values.
brd_arrow.gif to_unit double Tiered Units (to) This value represents the end of the range for a single tier of values.
brd_arrow.gif rate_per_unit double The cost per unit of this service over the time period the plan is billed for
brd_arrow.gif future_rate_per_unit double The future cost per unit of this service over the time period the plan is billed for
brd_arrow.gif monthly_fee double If the plan interval is more than one month, this field will rate per unit per month
brd_arrow.gif client_rate_schedule_id string Client assigned unique rate schedule number
brd_arrow.gif rate_tier_description string Rate Tier Description
brd_arrow.gif usage_type_name string The human-readable name of this usage type
brd_arrow.gif usage_type_desc string The long description of this usage type
brd_arrow.gif usage_type_code string Client-assigned identifier for the type of usage being recorded.
brd_arrow.gif usage_unit_label string The display-level description of the units this usage represents.
brd_arrow.gif apply_usage_rates_daily long Indicates whether or not this usage-based service is rated on a daily basis.   Allowable Values
brd_arrow.gif tax_inclusive_ind long

Indicator that states whether a taxable service is tax-inclusive or tax-exclusive. 

Allowable Values
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 default_ind long If true, this is the default rate schedule for the default currency   Allowable Values
brd_arrow.gif default_ind_curr long If true, this is the default rate schedule for the specified currency   Allowable Values
brd_arrow.gif schedule_display_ind long Determines whether the rate schedule is displayable   Allowable Values
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
acct_locale_no long Aria-assigned unique identifier of the locale used for translations. This value is unique across all Aria-managed accounts.
acct_locale_name string Name of the account level locale.
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.