Home > Aria6 User Documentation > Aria6 core api > get_client_plan_services

get_client_plan_services

Returns information for all services in a specified plan.

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 The unique plan identifier.
  OR      
  client_plan_id string 100 Client-defined Plan ID for which to query available child plans
 

Output Arguments

Field Name Field Type Description
plan_services hash Deprecated A multidimensional array of Services for this plan
brd_arrow.gif service_no long A multidimensional array of 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 for is_recurring_ind

Values Description
0 0
1 1
brd_arrow.gif is_usage_based_ind long Indicates whether or not this service is a usage based service 

Allowable values for is_usage_based_ind

Values Description
0 0
1 1
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 for taxable_ind

Values Description
0 0
1 1
brd_arrow.gif is_tax_ind long Indicates whether or not this service is a tax based service 

Allowable values for is_tax_ind

Values Description
0 0
1 1
brd_arrow.gif is_arrears_ind long Indicates whether or not this service is an arrears based service 

Allowable values for is_arrears_ind

Values Description
0 0
1 1
brd_arrow.gif is_setup_ind long Indicates whether or not this service is a setup bases service 

Allowable values for is_setup_ind

Values Description
0 0
1 1
brd_arrow.gif is_misc_ind long Indicates whether or not this service is a miscellaneous service 

Allowable values for is_misc_ind

Values Description
0 0
1 1
brd_arrow.gif is_donation_ind long Indicates whether or not this service is a donation based service 

Allowable values for is_donation_ind

Values Description
0 0
1 1
brd_arrow.gif is_order_based_ind long Indicates whether or not this service is an order based service 

Allowable values for is_order_based_ind

Values Description
0 0
1 1
brd_arrow.gif is_cancellation_ind long Indicates whether or not this service is a cancellation based service 

Allowable values for is_cancellation_ind

Values Description
0 0
1 1
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 for display_ind

Values Description
0 0
1 1
brd_arrow.gif tiered_pricing_rule long The Tiered Pricing Rule 

Allowable values for tiered_pricing_rule

Values Description
1 Standard
2 Volume Discount
3 Flat Rate Per Tier
brd_arrow.gif is_min_fee_ind long Indicates whether or not this service is a minimum fee. 

Allowable values for is_min_fee_ind

Values Description
0 0
1 1
brd_arrow.gif client_service_id string A multidimensional array of client-defined Service ID for this plan.
brd_arrow.gif usage_type_cd string An array containing usage_type_cd(s) to denote which usage type(s) 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 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 for future_rate

Values Description
0 false, i.e., no future rate.
1 True, i.e., future rates are captured.
  null, i.e., no future rate.
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 for apply_usage_rates_daily

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
brd_arrow.gif service_no long A multidimensional array of Services for this plan
brd_arrow.gif client_service_id string A multidimensional array of client-defined Service ID 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 for is_recurring_ind

Values Description
0 0
1 1
brd_arrow.gif is_usage_based_ind long Indicates whether or not this service is a usage based service 

Allowable values for is_usage_based_ind

Values Description
0 0
1 1
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 for taxable_ind

Values Description
0 0
1 1
brd_arrow.gif is_tax_ind long Indicates whether or not this service is a tax based service 

Allowable values for is_tax_ind

Values Description
0 0
1 1
brd_arrow.gif is_arrears_ind long Indicates whether or not this service is an arrears based service 

Allowable values for is_arrears_ind

Values Description
0 0
1 1
brd_arrow.gif is_setup_ind long Indicates whether or not this service is a setup bases service 

Allowable values for is_setup_ind

Values Description
0 0
1 1
brd_arrow.gif is_misc_ind long Indicates whether or not this service is a miscellaneous service 

Allowable values for is_misc_ind

Values Description
0 0
1 1
brd_arrow.gif is_donation_ind long Indicates whether or not this service is a donation based service 

Allowable values for is_donation_ind

Values Description
0 0
1 1
brd_arrow.gif is_order_based_ind long Indicates whether or not this service is an order based service 

Allowable values for is_order_based_ind

Values Description
0 0
1 1
brd_arrow.gif is_cancellation_ind long Indicates whether or not this service is a cancellation based service 

Allowable values for is_cancellation_ind

Values Description
0 0
1 1
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 for display_ind

Values Description
0 0
1 1
brd_arrow.gif tiered_pricing_rule long The Tiered Pricing Rule 

Allowable values for tiered_pricing_rule

Values Description
1 Standard
2 Volume Discount
3 Flat Rate Per Tier
brd_arrow.gif is_min_fee_ind long Indicates whether or not this service is a minimum fee. 

Allowable values for is_min_fee_ind

Values Description
0 0
1 1
brd_arrow.gif fulfillment_based_ind long Indicates if the service is Fulfillment Based or not.
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 for apply_usage_rates_daily

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.
 
 
 
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.
Powered by CXone Expert ®