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



 

Home > Aria Crescendo core api > get_client_plans_all_m

get_client_plans_all_m

Table of contents
  1. Input Arguments
  2. Allowable values for include_all_rate_schedules
  3. Allowable values for include_plan_hierarchy
  4. Allowable values for retrieve_bundled_nso
  5. Allowable values for retrieve_included_nso
  6. Allowable values for include_translations
  7. Output Arguments
  8. Allowable values for supp_plan_ind
  9. Allowable values for billing_ind
  10. Allowable values for display_ind
  11. Allowable values for new_acct_status
  12. Allowable values for rollover_acct_status
  13. Allowable values for default_notify_method
  14. Allowable values for prepaid_ind
  15. Allowable values for proration_invoice_timing_cd
  16. Allowable values for rollover_plan_uom_cd
  17. Allowable values for init_free_period_uom_cd
  18. Allowable values for initial_plan_status_cd
  19. Allowable values for rollover_plan_status_uom_cd
  20. Allowable values for rollover_plan_status_cd
  21. Allowable values for nso_incl_list_scope
  22. Allowable values for is_recurring_ind
  23. Allowable values for is_usage_based_ind
  24. Allowable values for taxable_ind
  25. Allowable values for is_tax_ind
  26. Allowable values for is_arrears_ind
  27. Allowable values for is_setup_ind
  28. Allowable values for is_misc_ind
  29. Allowable values for is_donation_ind
  30. Allowable values for is_order_based_ind
  31. Allowable values for is_cancellation_ind
  32. Allowable values for display_ind
  33. Allowable values for tiered_pricing_rule
  34. Allowable values for is_min_fee_ind
  35. Allowable values for future_rate
  36. Allowable values for apply_usage_rates_daily
  37. Allowable values for tax_inclusive_ind
  38. Allowable values for default_ind
  39. Allowable values for default_ind_curr
  40. Allowable values for schedule_display_ind
  41. Allowable values for active_ind
  42. Allowable values for plan_group_usage
  43. Allowable values for selectable_ind
  44. Allowable values for first_retrieval_level_ind
  45. Allowable values for is_mandatory
  46. Allowable values for is_default
  47. Allowable values for enforcement_level
  48. Allowable values for active_ind
  49. Allowable values for item_scope
  50. Allowable values for active_ind
  51. Allowable values for nso_group_item_scope
Returns a detailed list of all plans associated with a client. If you do not filter the call by acct_no, the information returned includes the services and rate schedules associated with the plans. If you filter the call by acct_no, or enter a plan_no or a client_plan_id that is a supplemental plan number, the information returned does not include any master plan service or rate schedule details.

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.
  plan_no long 22 Unique Aria-assigned plan number. Provide a value for this field to filter the list of plans returned.
  OR      
  client_plan_id string 100 Client-defined Plan ID for which to query available child plans
  acct_no long 38 Unique Aria-assigned account number. Provide a value for this field to filter the list of plans returned.
  promo_code string 30 Provide a value for this field to filter the list of plans return. This code is provided during registration and generally provides access to a custom set of reduced-rate plans.
  parent_plan_no long 22 Unique Aria-assigned plan number. Provide a value for this field to filter the list of plans returned.
  OR      
  client_parent_plan_id string 100 Client-defined unique parent Plan ID
  supp_field_names string array   An array of client-defined product field names. Provide a value for this field to filter the list of plans returned.
  supp_field_values string array   An array of client-defined product field values paired with the provided product field names above. Provide a value for this field to filter the list of plans returned.
  include_all_rate_schedules string 5 If set to "true", will retrieve all of the rates and rate schedules associated with a particular plan. If left blank, will default to "false".   Allowable Values
  include_plan_hierarchy string 5 You can use this input parameter to specify whether to retrieve the child plans associated with the returned plans or with the plan_no or parent_plan_no that you specified. If you set the include_plan_hierarchy parameter to true , then all of the child plans down to the bottom level of your plan hierarchy will be returned.   Allowable Values
  retrieve_bundled_nso string 5 If set to "true", will retrieve all of the bundled inventory items associated with a particular plan. If left blank, will default to "false".   Allowable Values
  retrieve_included_nso string 5 If set to "true", will retrieve all of the inventory items 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 5 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.
all_client_plan_dtls hash A multidimensional array containing all client plans.
brd_arrow.gif plan_no long Aria-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 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.
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_acct_status long The status code to assert for the new account.   Allowable Values
brd_arrow.gif rollover_acct_status long Default status for new accounts created on this plan.   Allowable Values
brd_arrow.gif 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.
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 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 client_plan_id string Client assigned unique plan identifier
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 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
brd_arrow.gif rollover_plan_duration string 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 string 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 nso_incl_list_scope long Scope of additional NSO as part of inclusion list.   Allowable Values
brd_arrow.gif plan_services hash A multidimensional array of Services for this plan
brd_arrow.gif service_no long The services for this plan
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
brd_arrow.gif plan_nso_incl_list hash Non-Subscription Offerings inclusion list that is in addition to NSOs that are bundled with the plan
brd_arrow.gif item_no long Inventory item number
brd_arrow.gif active_ind long Inventory item status.   Allowable Values
brd_arrow.gif plan_groups hash A grouping of plans which can be used for plan assignment
brd_arrow.gif plan_group_no long The ID of this plan group
brd_arrow.gif plan_group_name string The name of this plan group
brd_arrow.gif plan_group_desc string The long description of this plan group
brd_arrow.gif plan_group_usage string Determines where the plan groups are made available   Allowable Values
brd_arrow.gif selectable_ind long Whether or not this plan group is selectable   Allowable Values
brd_arrow.gif client_plan_group_id string Client-defined ID for this plan group
brd_arrow.gif promotional_plan_sets hash A grouping of plans based on promo code
brd_arrow.gif promo_set_no long The ID of this promotional plan set
brd_arrow.gif promo_set_name string The name of this promotional plan set
brd_arrow.gif promo_set_desc string The long description of this promotional plan set
brd_arrow.gif promotions_for_set hash The promo codes associated with this group of plans
brd_arrow.gif promo_code string The promo code itself
brd_arrow.gif promo_code_desc string A long description of this promo code
brd_arrow.gif client_promo_set_id string Client-defined ID of this promotional plan set
brd_arrow.gif parent_plans hash The plans which are mapped as parents of this plan
brd_arrow.gif parent_plan_no long ID of the parent plan
brd_arrow.gif parent_plan_name string Name of the parent plan
brd_arrow.gif client_parent_plan_id string Client-defined unique parent Plan ID
brd_arrow.gif plan_supp_fields hash Supplemental object fields associated with this plan
brd_arrow.gif plan_supp_field_no long Supplemental object field ID
brd_arrow.gif plan_supp_field_name string Name of the supplemental field. This value is required if you want to assign supplemental fields. For example, if you have any accounts that are tax-exempt or international, you must set up corresponding account supplemental fields prior to your tax provider configuration. Create fields for the tax exemption number and for the VAT ID used by the tax provider.
brd_arrow.gif plan_supp_field_desc string Description of the supplemental object field
brd_arrow.gif plan_supp_field_value string The value in this supplemental field on the plan
brd_arrow.gif first_retrieval_level_ind string If true, this plan met the initial filtering criteria used to retrieve this list of plans. If false, this plan is a child plan (or other decendant) of a plan which met the initial criteria   Allowable Values
brd_arrow.gif child_plans hash The plans which are mapped as children of this plan
brd_arrow.gif plan_no long Aria generated unique ID of the plan.
brd_arrow.gif client_plan_id string Client-defined unique ID for the plan.
brd_arrow.gif is_mandatory long Determines if this child plan must be purchased along with the parent plan.   Allowable Values
brd_arrow.gif is_default string Determines if this child plan must be added to the purchase plan list in the UI.   Allowable Values
brd_arrow.gif min_units long Determines the minimum number of units that must be purchased.
brd_arrow.gif max_units string Determines the maximum number of units that can be purchased.
brd_arrow.gif enforcement_level string Determines the level at which the minimum and maximum values are enforced.   Allowable Values
brd_arrow.gif plan_nso_items hash Non-Subscription Offerings that are bundled with the plan.
brd_arrow.gif item_no long Inventory item number that is bundled with the plan
brd_arrow.gif active_ind long Inventory item status.   Allowable Values
brd_arrow.gif min_qty string Minimum NSO quantity needed during plan purchase
brd_arrow.gif max_qty string Maximum NSO quantity needed during plan purchase
brd_arrow.gif item_scope long Scope of bundled NSO during plan purchase.   Allowable Values
brd_arrow.gif plan_nso_price_override hash Overridden prices for NSO items.
brd_arrow.gif rate_schedule_no long The internal Id of the rate schedule
brd_arrow.gif client_rate_schedule_id string Client assigned unique rate schedule number
brd_arrow.gif currency_cd string Currency code for Inventory item.
brd_arrow.gif override_price string Overridden price for Inventory item for currencies.
brd_arrow.gif plan_nso_group hash Non-Subscription Offerings that are bundled with the plan as part of NSO group
brd_arrow.gif item_no long Inventory item number that is bundled with the plan
brd_arrow.gif active_ind long Inventory item status.   Allowable Values
brd_arrow.gif plan_nso_group_price_override hash Overridden prices for NSO items.
brd_arrow.gif rate_schedule_no long The internal Id of the rate schedule
brd_arrow.gif client_rate_schedule_id string Client assigned unique rate schedule number
brd_arrow.gif currency_cd string Currency code for Inventory item.
brd_arrow.gif override_price string Overridden price for Inventory item for currencies.
brd_arrow.gif nso_group_min_qty string Minimum NSO quantity needed during plan purchase for the NSO group.
brd_arrow.gif nso_group_max_qty string Maximum NSO quantity needed during plan purchase for the NSO group.
brd_arrow.gif nso_group_item_scope string Scope of bundled NSO group during plan purchase.   Allowable Values
brd_arrow.gif plan_translation_dtls hash  
brd_arrow.gif plan_no long Aria-assigned unique plan identifier
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 plan_service_t hash  
brd_arrow.gif service_no long The unique ID for the service this line represents.
brd_arrow.gif service_desc string The name of the service this line represents.
brd_arrow.gif all_service_supp_fields_t 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 plan_service_rates_t 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 rate_schedule_name string Rate Tier Description
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_unit_label string The display-level description of the units this usage represents.
brd_arrow.gif plan_supp_fields_t hash Supplemental object fields associated with this plan
brd_arrow.gif plan_supp_field_no long Supplemental object field ID
brd_arrow.gif plan_supp_field_name string Name of the supplemental field. This value is required if you want to assign supplemental fields. For example, if you have any accounts that are tax-exempt or international, you must set up corresponding account supplemental fields prior to your tax provider configuration. Create fields for the tax exemption number and for the VAT ID used by the tax provider.
brd_arrow.gif plan_supp_field_desc string Description of the supplemental object field
brd_arrow.gif plan_supp_field_value string The value in this supplemental field on the plan
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.
Powered by MindTouch ®