Skip to main content
Knowledge Central
Aria Knowledge Central

create_service_m

  1. Last updated
  2. Save as PDF
Creates a new service specific to client

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_name string 100 Specifies the service name. Translatable.
required-icon.png service_type string 30 Specifies Service types.

Allowable values for service_type:

 
Values Description
Activation Plan activation service
Recurring A service with recurring charges ( May have flat or tiered rates )
Usage-Based A service with tiered usage levels
Order-Based Order based service
Cancellation Cancellation service
Minimum Fee Minimum Fee service
Recurring Arrears A recurring service that is invoiced at the end of the billing cycles
required-icon.png gl_cd string 30 Specifies chart of access code
  ar_gl_cd string 30 Specifies Accounts receivable gl code. This field is required when rev_rec_ind is set to Yes
  def_gl_cd string 30 Specifies deferred gl code. This field is required when deferred_ind is set to Yes
  rev_rec_ind int   Indicator for ar gl code. Accepted values are 0 or 1.

Allowable values for rev_rec_ind:

 
Values Description
0 When set to 0, ar_gl_cd is not required
1 When set to 1, ar_gl_cd is required
  deferred_ind int   Indicator for deferred gl code . Accepted values are 0 or 1.

Allowable values for deferred_ind:

 
Values Description
0 When set to 0, def_gl_cd is not required
1 When set to 1, def_gl_cd is required
  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.

Allowable values for taxable_ind:

 
Values Description
0 non taxable
1 taxable
  tax_group int 38 Specifies tax group associated with service. This will be null if taxable_ind is set to 0. If taxable_ind is 1 then this field is required
  OR      
  client_tax_group_id string 100 Client Tax Group Id
  usage_type int 38 Specifies usage type associated with service. If service_type is Usage-Based then this field is required. This fields accepts only valid usage type
  client_service_id string 100 Client defined unique id
  svc_location_no int 32 Aria-assigned unique location identifier for the service.
  OR      
  client_svc_location_id string 100 The client-defined location identifier for the service.
  supplemental_obj_field array   Specifies the supplemental object fields to be added for this item. This field is required only if the associated product fields are marked as required
  brd_arrow.giffield_no int 100 the field no
  OR      
  brd_arrow.giffield_name string 100 the field name
  brd_arrow.giffield_value string array   the field value
  commodity_cd string 20 Commodity Code
  allow_service_credits string 1 Y / N. Determines whether or not the service can consume service credits. Null value = yes.

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 int Aria-assigned unique identifier for service
  1. Back to top
  • Was this article helpful?

Recommended articles

  1. Page type
    Topic
  2. Tags
    1. API Specification