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



 

Home > Aria Crescendo admintools api > get_plan_service_details_m

get_plan_service_details_m

Retrieve details on specified service that is on 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.
required-icon.png service_no int 8 Specifies the Service number
  OR      
  client_service_id string 100 Client defined unique id
required-icon.png plan_no int 100 Plan Number
  OR      
  client_plan_id string 100 Client defined unique id
  locale_no int 38 Aria-assigned unique identifier of the locale used for translations.
  OR      
  locale_name string 32 Name of the locale to which the translations belong.
  include_translations string 1 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 Textual description of any error that occurred. "OK" if there was no error.
plan_no string Plan Number
client_plan_id string Client defined unique id
currency_cd string Specifies the currency code of plan
service_no string Specifies the Service number
service_name string Specifies the service name
service_type string Specifies Service types. Valid values are: "Usage Based", "Recurring", "Activation"
client_service_id string Client defined unique id
taxable_ind int Indicates If The service has tax associated with it [can be 0 or 1]; 1 indicates taxable and 0 indicates non taxable.
tax_group string Specifies tax group associated with service. This will be null if taxable_ind is set to 0
client_tax_group_id string Client defined unique identifier
gl_cd string Specifies chart of access code
usage_type int Specifies usage type associated with service
rate_type string Specifies the rate type. Valid values are:'Flat Rate' and 'Tiered Pricing'
rate_schedules hash  
brd_arrow.gif currency string Currency for the schedule
brd_arrow.gif rate_info hash  
brd_arrow.gif schedule_no int Schedule Number for the currency
brd_arrow.gif schedule_name string  
brd_arrow.gif client_rate_schedule_id string Client defined unique id
brd_arrow.gif from_unit int Tiered Pricing Rule that Specifies rate from units. This is null for Flat Rates
brd_arrow.gif to_unit int Tiered Pricing Rule that Specifies rate to units. This is null for Flat Rates
brd_arrow.gif rate_per_unit float Specifies rate per unit
brd_arrow.gif description string Specifies rate tier description
brd_arrow.gif is_default int 1 or 0 depending on if the schedule is the default or not. identifies the default
parent_plans hash  
brd_arrow.gif parent_plan int  
parent_plan_ids hash  
brd_arrow.gif parent_plan_id string  
exclusion_plans hash  
brd_arrow.gif exclusion_plan int  
supplemental_obj_fields hash  
brd_arrow.gif supplemental_obj_field string  
commodity_cd string Commodity Code
fulfillment_based_ind int Indicates if the service is “Fulfillment Based” or not.   Allowable Values
apply_usage_rates_daily int Indicates whether or not this usage-based service is rated on a daily basis.   Allowable Values
service_locations hash  
brd_arrow.gif svc_location_no int 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.
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.
service_translation_details hash Array that contains all the translated values for a given locale.
brd_arrow.gif locale_name string Name of the locale
brd_arrow.gif locale_no int Aria-assigned unique identifier of the locale used for translations.
brd_arrow.gif service_no string Specifies the Service number
brd_arrow.gif service_name string Specifies the service name
brd_arrow.gif rate_schedules_t hash  
brd_arrow.gif rate_info hash  
brd_arrow.gif schedule_no int Schedule Number for the currency
brd_arrow.gif schedule_name string Schedule Name
brd_arrow.gif description string Specifies rate tier description
tax_inclusive_ind long

Indicator that states whether a taxable service is tax-inclusive or tax-exclusive. 

Allowable Values
 
 
 
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.