plan_services | hash | Deprecated 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 Values | Description | 0 | 0 | 1 | 1 | |
is_usage_based_ind | long | Indicates whether or not this service is a usage based service Allowable Values Values | Description | 0 | 0 | 1 | 1 | |
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 Values | Description | 0 | 0 | 1 | 1 | |
is_tax_ind | long | Indicates whether or not this service is a tax based service Allowable Values Values | Description | 0 | 0 | 1 | 1 | |
is_arrears_ind | long | Indicates whether or not this service is an arrears based service Allowable Values Values | Description | 0 | 0 | 1 | 1 | |
is_setup_ind | long | Indicates whether or not this service is a setup bases service Allowable Values Values | Description | 0 | 0 | 1 | 1 | |
is_misc_ind | long | Indicates whether or not this service is a miscellaneous service Allowable Values Values | Description | 0 | 0 | 1 | 1 | |
is_donation_ind | long | Indicates whether or not this service is a donation based service Allowable Values Values | Description | 0 | 0 | 1 | 1 | |
is_order_based_ind | long | Indicates whether or not this service is an order based service Allowable Values Values | Description | 0 | 0 | 1 | 1 | |
is_cancellation_ind | long | Indicates whether or not this service is a cancellation based service Allowable Values Values | Description | 0 | 0 | 1 | 1 | |
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 Values | Description | 0 | 0 | 1 | 1 | |
tiered_pricing_rule | long | The Tiered Pricing Rule Allowable Values Values | Description | 1 | Standard | 2 | Volume Discount | 3 | Flat Rate Per Tier | |
is_min_fee_ind | long | Indicates whether or not this service is a minimum fee. Allowable Values Values | Description | 0 | 0 | 1 | 1 | |
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. |
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 Values | Description | 0 | false, i.e., no future rate. | 1 | True, i.e., future rates are captured. | | null, i.e., no future rate. | |
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 Values | Description | 0 | usage shall be rated based on the entire billing period | 1 | usage shall be rated based on one day periods individually. | |
plan_services_list | hash | A multidimensional array of Services for this plan |
service_no | long | A multidimensional array of Services for this plan |
client_service_id | string | A multidimensional array of client-defined Service ID 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 Values | Description | 0 | 0 | 1 | 1 | |
is_usage_based_ind | long | Indicates whether or not this service is a usage based service Allowable Values Values | Description | 0 | 0 | 1 | 1 | |
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 Values | Description | 0 | 0 | 1 | 1 | |
is_tax_ind | long | Indicates whether or not this service is a tax based service Allowable Values Values | Description | 0 | 0 | 1 | 1 | |
is_arrears_ind | long | Indicates whether or not this service is an arrears based service Allowable Values Values | Description | 0 | 0 | 1 | 1 | |
is_setup_ind | long | Indicates whether or not this service is a setup bases service Allowable Values Values | Description | 0 | 0 | 1 | 1 | |
is_misc_ind | long | Indicates whether or not this service is a miscellaneous service Allowable Values Values | Description | 0 | 0 | 1 | 1 | |
is_donation_ind | long | Indicates whether or not this service is a donation based service Allowable Values Values | Description | 0 | 0 | 1 | 1 | |
is_order_based_ind | long | Indicates whether or not this service is an order based service Allowable Values Values | Description | 0 | 0 | 1 | 1 | |
is_cancellation_ind | long | Indicates whether or not this service is a cancellation based service Allowable Values Values | Description | 0 | 0 | 1 | 1 | |
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 Values | Description | 0 | 0 | 1 | 1 | |
tiered_pricing_rule | long | The Tiered Pricing Rule Allowable Values Values | Description | 1 | Standard | 2 | Volume Discount | 3 | Flat Rate Per Tier | |
is_min_fee_ind | long | Indicates whether or not this service is a minimum fee. Allowable Values Values | Description | 0 | 0 | 1 | 1 | |
fulfillment_based_ind | long | Indicates if the service is Fulfillment Based or not. |
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 Values | Description | 0 | usage shall be rated based on the entire billing period | 1 | usage shall be rated based on one day periods individually. | |
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. |