Home > Aria6 User Documentation > Aria6 admintools api > get_service_details

get_service_details

Retrieve details on specified service

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
  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 for include_translations

 

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.
service_no string Specifies the Service number
client_service_id string Client defined unique id
service_name string Specifies the service name
service_type string Specifies Service types. Valid values are: "Usage Based", "Recurring", "Activation"
gl_cd string Specifies chart of access code
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 int Specifies tax group associated with service. This will be null if taxable_ind is set to 0
usage_type int Specifies usage type associated with service
rev_rec_ind int Specifies if this service is revrec related.
ar_ind int Account receivable indicator.
ar_gl_cd string Account receivable gl code.
def_ind int Deferred indicator
def_gl_cd string Deferred gl code.
supplemental_obj_fields hash  
brd_arrow.gif field_no int the field no
brd_arrow.gif field_value string the field value
brd_arrow.gif field_name string the field name
commodity_cd string Commodity Code
client_tax_group_id string Client defined unique identifier
service_translation_info 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 int Specifies the Service number
brd_arrow.gif service_name string Specifies the service name
 
 
 
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.