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

Returns a list of all plans available for assignment on a particular account

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.
acct_no long 22 Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
  plan_instance_no long 22 The Master and Supplementary Subscription plan instance number.
  OR      
  client_plan_instance_id string 100 Unique client-defined identifier for the master plan instance or supplementary plan instance.
  promo_cd string 30 This is the code provided the client and used by the account holder during registration or when executing a transaction. A promotion generally provides access to a custom set of reduced-rate plans.
  include_full_plan_hierarchy_plans string   You can use this input parameter to specify whether to retrieve full hierarchy of child plans associated with the returned plans or with the plan_instance_no or client_plan_instance_id that you specified. If you set the include_full_plan_hierarchy_plans parameter to true , then full hierarchy of child plans down to the bottom level of your plan hierarchy will be returned.   Allowable Values
  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 Locale identifier. This value is unique across all Aria-managed accounts.
  OR      
  locale_name string 50 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.
  qualifier_name string 100 Name of the field you want to associate with this API call.
  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  
parent_plan_instance_no long Aria-assigned unique parent plan Instance identifier
parent_client_plan_instance_id string Parent plans Client-defined Plan Instance ID
plan_no long Aria-assigned unique plan identifier
client_plan_id string Client assigned unique plan identifier
plan_name string Plan Name
plan_desc string Text description of this plan
supp_plan_ind long Indicates whether or not this plan is a supplemental plan.   Allowable Values
billing_ind long Indicates whether or not this plan is billable   Allowable Values
display_ind long Indicates whether or not the plan is marked as "displayable". 0 means not displayable. 1 means displayable.   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.
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.
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_plan_status long The status code to assert for the new account.   Allowable Values
rollover_plan_status long Status used for the master plan instance at the completion of the rollover period.   Allowable Values
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.
init_free_months long Initial free months.
plan_2_assign_on_susp long Plan to assign when an account on this plan is suspended.
client_plan_2_assign_on_susp string Client-defined Plan identifier 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.
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_services hash A multidimensional array of Services for this plan
service_no long A multidimensional array of Services for this plan
service_desc string Description of this service
is_recurring_ind long Indicates whether or not this service is a recurring service   Allowable Values
is_usage_based_ind long Indicates whether or not this service is a usage based service   Allowable Values
usage_type long The usage type supported by this usage based service
taxable_ind long Indicates whether or not this service is taxable   Allowable Values
is_tax_ind long Indicates whether or not this service is a tax based service   Allowable Values
is_arrears_ind long Indicates whether or not this service is an arrears based service   Allowable Values
is_setup_ind long Indicates whether or not this service is a setup bases service   Allowable Values
is_misc_ind long Indicates whether or not this service is a miscellaneous service   Allowable Values
is_donation_ind long Indicates whether or not this service is a donation based service   Allowable Values
is_order_based_ind long Indicates whether or not this service is an order based service   Allowable Values
is_cancellation_ind long Indicates whether or not this service is a cancellation based service   Allowable Values
coa_id string Chart of accounts ID
ledger_code string This field is deprecated in favor of coa_id
client_coa_code string The client-defined override for coa_id
display_ind long Indicates if this service is displayable or not   Allowable Values
tiered_pricing_rule long The Tiered Pricing Rule   Allowable Values
is_min_fee_ind long Indicates whether or not this service is a minimum fee.   Allowable Values
client_service_id string A multidimensional array of client-defined Service ID for this plan.
usage_type_cd string An array containing usage_type_cd(s) to denote which usage type(s) to record.
all_service_supp_fields hash  
field_name string The machine-readable name of this field
field_desc string The human-readable name of this field
field_order_no long The sort order of this field
field_value string The value stored in this field
fulfillment_based_ind long Indicates if the service is Fulfillment Based or not.
svc_location_no long The Aria-assigned unique identifier for the origin location for the service.
client_svc_location_id string The client-defined location identifier for the origin location for the service.
svc_location_name string The name of the origin location for the service.
svc_location_company_name string Company name of the service location.
svc_location_address1 string First address line of the service location.
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.
svc_location_address3 string Third address line of the service location.
svc_location_city string City of the service location.
svc_location_locality string Locality of the service location.
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.
svc_location_country string Country of the location contact. The ISO-compliant 2-character country code abbreviation in uppercase.
svc_location_postal_cd string Postal/Zip code for the service location address.
plan_service_rates hash Represents the rates for the default rate schedule for the default currency for the plan
rate_seq_no long Sequential number in the rate schedule for dertermining tiers
from_unit double Tiered Units (from) This value represents the start of a tiered range of values.
to_unit double Tiered Units (to) This value represents the end of the range for a single tier of values.
rate_per_unit double The cost per unit of this service over the time period the plan is billed for
future_rate_per_unit double The future cost per unit of this service over the time period the plan is billed for
monthly_fee double If the plan interval is more than one month, this field will rate per unit per month
client_rate_schedule_id string Client assigned unique rate schedule number
rate_tier_description string Rate Tier Description
all_plan_service_rates hash All rates for all rate schedules and currencies for this plan
schedule_no long Rate schedule number
client_rate_schedule_id string Client assigned unique rate schedule number
future_rate long Indicates whether future rates are captured or not.   Allowable Values
future_change_date string Future Change Date of the rates.
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
plan_service_rates hash Represents the rates for the default rate schedule for the default currency for the plan
rate_seq_no long Sequential number in the rate schedule for dertermining tiers
from_unit double Tiered Units (from) This value represents the start of a tiered range of values.
to_unit double Tiered Units (to) This value represents the end of the range for a single tier of values.
rate_per_unit double The cost per unit of this service over the time period the plan is billed for
future_rate_per_unit double The future cost per unit of this service over the time period the plan is billed for
monthly_fee double If the plan interval is more than one month, this field will rate per unit per month
client_rate_schedule_id string Client assigned unique rate schedule number
rate_tier_description string Rate Tier Description
usage_type_name string The human-readable name of this usage type
usage_type_desc string The long description of this usage type
usage_type_code string Client-assigned identifier for the type of usage being recorded.
usage_unit_label string The display-level description of the units this usage represents.
apply_usage_rates_daily long Indicates whether or not this usage-based service is rated on a daily basis.   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
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.

You must to post a comment.
Last modified
10:23, 24 Aug 2017

Tags

This page has no custom tags.

Classifications

This page has no classifications.