get_avail_plans_for_acct_all_m
Summary
| API Name | get_avail_plans_for_acct_all_m |
|---|---|
| Class | account_services_m |
| Update Version | 34 |
Description
Use this API to return a listing of all plans, services, and rates, or plans, services, rates related to a specific master or supplemental plan instance number, that are available for assignment to a specified account.
Inputs
| Name | Type | Length | Required | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| client_no | long | 22 | Yes |
Aria-assigned unique identifier indicating the Aria client providing service to this account. |
||||||
| auth_key | string | 32 | No |
Aria-assigned unique key for authenticating the validity of the requestor. This key is passed with each method call. |
||||||
| acct_no | long | 22 | Yes |
Aria-assigned account identifier. This value is unique across all Aria-managed accounts. Alternative required field: client_acct_id |
||||||
| plan_instance_no | long | 22 | No |
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. Alternative field: client_plan_instance_id |
||||||
| client_plan_instance_id | string | 100 | No |
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. Alternative field: plan_instance_no |
||||||
| promo_cd | string | 30 | No |
Limits the list of master plans available for assignment based on the associated promo code. |
||||||
| include_full_plan_hierarchy_plans | string | 5 | No |
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. Allowed values:
|
||||||
| include_rs_summary | string | 5 | No |
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". Allowed values:
|
||||||
| locale_no | long | 30 | No |
Aria-assigned Locale identifier. This value is unique across all Aria-managed accounts. Alternative field: locale_name |
||||||
| locale_name | string | 100 | No |
Name of the locale. Alternative field: locale_no |
||||||
| client_acct_id | string | 50 | Yes |
Client-defined account identifier. Alternative required field: acct_no |
Outputs
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| error_code | long | No |
Aria-assigned error identifier. 0 indicates no error. |
|
| error_msg | string | No |
Description of any error that occurred. "OK" if there was no error. |
|
| all_client_plans_services | object | No | ||
| acct_locale_no | long | 30 | No |
Aria-assigned unique identifier of the locale used for translations. This value is unique across all Aria-managed accounts. |
| acct_locale_name | string | 100 | No |
Name of the account level locale. |
all_client_plans_services.plan_services.all_service_supp_fields fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| field_name | string | No |
The machine-readable name of this field |
|
| field_desc | string | No |
The human-readable name of this field |
|
| field_order_no | long | No |
The sort order of this field |
|
| field_value | string | No |
The value stored in this field |
all_client_plans_services.plan_services.plan_service_rates fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| rate_seq_no | long | No |
Sequential number in the rate schedule for dertermining tiers |
|
| from_unit | double | No |
Tiered Units (from) This value represents the start of a tiered range of values. |
|
| to_unit | double | No |
Tiered Units (to) This value represents the end of the range for a single tier of values. |
|
| rate_per_unit | double | No |
The cost per unit of this service over the time period the plan is billed for |
|
| future_rate_per_unit | double | No |
The future cost per unit of this service over the time period the plan is billed for |
|
| monthly_fee | double | No |
If the plan interval is more than one month, this field will rate per unit per month |
|
| weekly_fee | double | No |
If the plan interval is more than one week, this field will rate per unit per week |
|
| daily_fee | double | No |
If the plan interval is more than one day, this field will rate per unit per day |
|
| client_rate_schedule_id | string | 100 | No |
Client assigned unique rate schedule number |
| rate_tier_description | string | 50 | No |
Rate Tier Description |
all_client_plans_services.plan_services.all_plan_service_rates.plan_service_rates fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| rate_seq_no | long | No |
Sequential number in the rate schedule for dertermining tiers |
|
| from_unit | double | No |
Tiered Units (from) This value represents the start of a tiered range of values. |
|
| to_unit | double | No |
Tiered Units (to) This value represents the end of the range for a single tier of values. |
|
| rate_per_unit | double | No |
The cost per unit of this service over the time period the plan is billed for |
|
| future_rate_per_unit | double | No |
The future cost per unit of this service over the time period the plan is billed for |
|
| monthly_fee | double | No |
If the plan interval is more than one month, this field will rate per unit per month |
|
| weekly_fee | double | No |
If the plan interval is more than one week, this field will rate per unit per week |
|
| daily_fee | double | No |
If the plan interval is more than one day, this field will rate per unit per day |
|
| client_rate_schedule_id | string | 100 | No |
Client assigned unique rate schedule number |
| rate_tier_description | string | 50 | No |
Rate Tier Description |
all_client_plans_services.plan_services.all_plan_service_rates fields
| Name | Type | Length | Required | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| schedule_no | long | No |
Rate schedule number |
|||||||||
| client_rate_schedule_id | string | 100 | No |
Client assigned unique rate schedule number |
||||||||
| future_rate | long | No |
Indicates whether future rates are captured or not. Allowed values:
|
|||||||||
| future_change_date | string | 50 | No |
Future Change Date of the rates. |
||||||||
| followup_rs_no | long | 50 | No |
Aria internal ID of follow-up default rate schedule |
||||||||
| client_followup_rs_id | string | 50 | No |
Client-defined ID of followup rate schedule |
||||||||
| plan_service_rates | object | No |
Represents the rates for the default rate schedule for the default currency for the plan |
all_client_plans_services.plan_services fields
| Name | Type | Length | Required | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| service_no | long | 22 | No |
The services for this plan |
||||||||
| service_desc | string | No |
Description of this service |
|||||||||
| is_recurring_ind | long | No |
Indicates whether or not this service is a recurring service Allowed values:
|
|||||||||
| is_usage_based_ind | long | No |
Indicates whether or not this service is a usage-based service Allowed values:
|
|||||||||
| usage_type | long | No |
The usage type supported by this usage based service |
|||||||||
| taxable_ind | long | No |
Indicates whether or not this service is taxable Allowed values:
|
|||||||||
| is_tax_ind | long | No |
Indicates whether or not this service is a tax-based service Allowed values:
|
|||||||||
| is_arrears_ind | long | No |
Indicates whether or not this service is an arrears-based service Allowed values:
|
|||||||||
| is_setup_ind | long | No |
Indicates whether or not this service is a setup-based service Allowed values:
|
|||||||||
| is_misc_ind | long | No |
Indicates whether or not this service is a miscellaneous service Allowed values:
|
|||||||||
| is_donation_ind | long | No |
Indicates whether or not this service is a donation-based service Allowed values:
|
|||||||||
| is_order_based_ind | long | No |
Indicates whether or not this service is an order-based service Allowed values:
|
|||||||||
| is_cancellation_ind | long | No |
Indicates whether or not this service is a cancellation- based service Allowed values:
|
|||||||||
| coa_id | string | No |
Chart of accounts ID |
|||||||||
| ledger_code | string | No |
This field is deprecated in favor of coa_id |
|||||||||
| client_coa_code | string | No |
The client-defined override for coa_id |
|||||||||
| display_ind | long | No |
Indicates if this service is displayable or not Allowed values:
|
|||||||||
| tiered_pricing_rule | long | No |
The Tiered Pricing Rule Allowed values:
|
|||||||||
| is_min_fee_ind | long | No |
Indicates whether or not this service is a minimum fee. Allowed values:
|
|||||||||
| client_service_id | string | 100 | No |
The client-defined Service ID for this plan. |
||||||||
| usage_type_cd | string | 100 | No |
Denotes which usage type to record. |
||||||||
| all_service_supp_fields | object | No | ||||||||||
| fulfillment_based_ind | long | 1 | No |
Indicates if the service is Fulfillment Based or not. |
||||||||
| svc_location_no | long | 22 | No |
The Aria-assigned unique identifier for the origin location for the service. |
||||||||
| client_svc_location_id | string | 100 | No |
The client-defined location identifier for the origin location for the service. |
||||||||
| svc_location_name | string | No |
The name of the origin location for the service. |
|||||||||
| svc_location_company_name | string | No |
Company name of the service location. |
|||||||||
| svc_location_address1 | string | No |
First address line of the service location. |
|||||||||
| svc_location_address2 | string | No |
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 | No |
Third address line of the service location. |
|||||||||
| svc_location_city | string | No |
City of the service location. |
|||||||||
| svc_location_locality | string | No |
Locality of the service location. |
|||||||||
| svc_location_state_prov | string | No |
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 | No |
Country of the location contact. The ISO-compliant 2-character country code abbreviation in uppercase. |
|||||||||
| svc_location_postal_cd | string | No |
Postal/Zip code for the service location address. |
|||||||||
| plan_service_rates | object | No |
Represents the rates for the default rate schedule for the default currency for the plan |
|||||||||
| all_plan_service_rates | object | No |
All rates for all rate schedules and currencies for this plan |
|||||||||
| usage_type_name | string | No |
The human-readable name of this usage type |
|||||||||
| usage_type_desc | string | No |
The long description of this usage type |
|||||||||
| usage_type_code | string | No |
Client-assigned identifier for the type of usage being recorded. |
|||||||||
| usage_unit_label | string | No |
The display-level description of the units this usage represents. |
|||||||||
| apply_usage_rates_daily | long | No |
Indicates whether or not this usage-based service is rated on a daily basis. Allowed values:
|
|||||||||
| tax_inclusive_ind | long | No |
This flag denotes if a rate is inclusive of the taxes. Value of 1 means tax inclusive rates and a value of 0 (default) means tax exclusive rates. Allowed values:
|
|||||||||
| usage_rating_time_ind | long | No |
Indicates whether rating is performed during load time or invoice time Allowed values:
|
|||||||||
| usage_record_rating_level_ind | long | No |
Indicates whether rating is performed at aggregate level or per usage record level. Allowed values:
|
|||||||||
| usage_record_taxation_level_ind | long | No |
Indicates whether taxation is performed at aggregate level or per usage record level. Allowed values:
|
all_client_plans_services.plan_rate_schedules_details fields
| Name | Type | Length | Required | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| schedule_no | long | No |
The ID of this rate schedule |
|||||||||||||
| client_rate_schedule_id | string | 100 | No |
Client assigned unique rate schedule number |
||||||||||||
| schedule_name | string | No |
The name of this rate schedule |
|||||||||||||
| schedule_currency | string | No |
The currency this rate schedule is linked to |
|||||||||||||
| recurring_billing_interval | long | No |
Number of months between billing cycles for recurring |
|||||||||||||
| usage_billing_interval | long | No |
Number of months between billing cycles for usage |
|||||||||||||
| recurring_billing_period_type | long | No |
Period type for billing cycles for recurring Allowed values:
|
|||||||||||||
| usage_billing_period_type | long | No |
Period type for billing cycles for usage Allowed values:
|
|||||||||||||
| default_ind | long | No |
If true, this is the default rate schedule for the default currency Allowed values:
|
|||||||||||||
| default_ind_curr | long | No |
If true, this is the default rate schedule for the specified currency Allowed values:
|
|||||||||||||
| schedule_display_ind | long | No |
Determines whether the rate schedule is displayable Allowed values:
|
|||||||||||||
| available_from_dt | string | 100 | No |
Start date of rate schedule |
||||||||||||
| available_to_dt | string | 100 | No |
End date of rate schedule |
||||||||||||
| followup_rs_no | long | 100 | No |
Aria internal ID of follow-up default rate schedule |
||||||||||||
| client_followup_rs_id | string | 100 | No |
Client-defined ID of followup rate schedule |
all_client_plans_services.contract_rollover_rate_sched fields
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| contract_current_rate_sched_no | long | No |
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 | No |
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 | No |
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 | No |
Client-defined ID of the pre-defined rate schedule to be used as the rollover rate schedule at the completion of the contract |
all_client_plans_services fields
| Name | Type | Length | Required | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| parent_plan_instance_no | long | 22 | No |
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. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| parent_client_plan_instance_id | string | 100 | No |
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. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| plan_no | long | 22 | No |
Aria-assigned unique plan identifier |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| client_plan_id | string | 100 | No |
Client assigned unique plan identifier |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| plan_name | string | No |
Plan Name |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| plan_desc | string | No |
Text description of this plan |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| supp_plan_ind | long | No |
Indicates whether or not this plan is a supplemental plan. Allowed values:
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| billing_ind | long | No |
Indicates whether or not this plan is billable. This applies to Master Plans only. Supplemental Plans inherit this property from their associated Master Plans. Allowed values:
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| display_ind | long | No |
Indicates whether or not the plan is marked as "displayable". 0 means not displayable. 1 means displayable. Allowed values:
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| rollover_months | long | No |
Number of months in which the account will change from the current plan to the pre-defined rollover plan. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| rollover_plan_no | long | No |
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 | 100 | No |
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 | No |
Fee charged for early cancellations. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| early_cancel_min_months | long | No |
Number of months during which early cancellation fees would apply on plan cancellation. This field is only applicable for master plans. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| suspension_period | long | No |
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 | No |
The status code to assert for the new account. Allowed values:
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| rollover_plan_status | long | No |
Status used for the master plan instance at the completion of the rollover period. Allowed values:
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| rollover_plan_status_days | long | No |
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 | No |
Initial free months. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| plan_2_assign_on_susp | long | No |
Plan to assign when an account on this plan is suspended. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| client_plan_2_assign_on_susp | string | 100 | No |
Client-defined Plan identifier to assign when an account on this plan is suspended. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| default_notify_method | long | No |
Default notification method given to an account that is assigned to this plan. Allowed values:
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| prepaid_ind | long | No |
Indicates whether or not this plan is prepaid Allowed values:
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| currency_cd | string | No |
The 3-character ISO-compliant currency code in lowercase for monetary values used in the context of this API method. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| rollover_plan_duration | long | No |
Duration of the plan rollover period (used in conjunction with rollover_plan_uom_cd). |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| rollover_plan_uom_cd | long | No |
Units associated with the duration of the plan rollover period (used in conjunction with rollover_plan_duration). Allowed values:
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| init_free_period_duration | long | No |
Duration of the initial free period (used in conjunction with init_free_period_uom_cd). |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| init_free_period_uom_cd | long | No |
Units associated with the duration of the initial free period (used in conjunction with init_free_period_duration). Allowed values:
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| initial_plan_status_cd | long | No |
Default status used when master plan is initially assigned on an account. Allowed values:
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| rollover_plan_status_duration | long | No |
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 | No |
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). Allowed values:
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| rollover_plan_status_cd | long | No |
Status used for the master plan instance at the completion of the plan status rollover period. Allowed values:
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| plan_services | object | No |
A multidimensional array of Services for this plan |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| plan_rate_schedules_details | object | No |
An array of the rate schedules for the requested plan |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| contract_rollover_plan_no | long | No |
Pre-defined plan to be used as the rollover plan at the completion of the contract. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| contract_rollover_client_plan_id | string | 100 | No |
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 | object | No |