Summary

API Name	update_service_m
Class	administration_services_m
Update Version	6.45

Description

Inputs

Name

Type

Length

Required

Description

client_no

long

12

Yes

Aria-assigned unique identifier indicating the Aria client providing service to this account.

auth_key

string

32

Yes

Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.

service_no

long

Yes

Specifies the Aria-assigned unique identifier of the service to be edited.

Alternative required field: client_service_id

service_name

string

100

Yes

Specifies the service name. Translatable.

service_type

string

30

Yes

Specifies Service types.

Allowed values:

Value	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

gl_cd

string

30

Yes

Specifies chart of access code

ar_gl_cd

string

30

No

Specifies Accounts receivable gl code. This field is required when rev_rec_ind is set to Yes

def_gl_cd

string

30

No

Specifies deferred gl code. This field is required when deferred_ind is set to Yes

rev_rec_ind

int

No

Indicator for ar gl code. Accepted values are 0 or 1

Allowed values:

Value	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

No

Indicator for deferred gl code . Accepted values are 0 or 1

Allowed values:

Value	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

No

Indicates If The service has tax associated with it [can be 0 or 1]; 1 indicates taxable and 0 indicates non taxable.

Allowed values:

Value	Description
0	non taxable
1	taxable

tax_group

int

1

No

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

Alternative field: client_tax_group_id

usage_type

int

38

No

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

No

Client defined unique id

Alternative field: service_no

svc_location_no

long

32

No

Aria-assigned unique location identifier for the service.

Alternative field: client_svc_location_id

client_svc_location_id

string

100

No

The client-defined location identifier for the service.

Alternative field: svc_location_no

supplemental_obj_field

object

No

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

See fields below

commodity_cd

string

20

No

Commodity Code

client_tax_group_id

string

100

No

Client Tax Group Id

Alternative field: tax_group

locale_no

long

38

No

Aria-assigned unique identifier of the locale used for translations.

Alternative field: locale_name

locale_name

string

32

No

Name of the locale to which the translations belong.

Alternative field: locale_no

allow_service_credits

string

1

No

Y / N. Determines whether or not the service can consume service credits. Null value = yes.

supplemental_obj_field fields

Name	Type	Length	Required	Description
field_no	long	100	No	the field no Alternative field: field_name
field_name	string	100	No	the field name Alternative field: field_no
field_value	string		No	the field value

Name

Type

Length

Required

Description

field_no

long

100

No

the field no

Alternative field: field_name

field_name

string

100

No

the field name

Alternative field: field_no

field_value

string

No

the field value

Outputs

Name	Type	Required	Description
error_code	long	No	Aria-assigned error identifier. 0 indicates no error
error_msg	string	No	Textual description of any error that occurred. "OK" if there was no error.
service_no	long	No