update_service_m
Summary
| API Name | update_service_m |
|---|---|
| Class | administration_services_m |
| Update Version | 6.45 |
Description
Updates information associated with a specified service.
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 the service type. Allowed values:
|
||||||||||||||||
| 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 the AR GL code. Accepted values are zero or one. Allowed values:
|
|||||||||||||||||
| deferred_ind | int | No |
Indicator for the deferred GL code. Accepted values are zero or one. Allowed values:
|
|||||||||||||||||
| taxable_ind | int | No |
Indicates whether the service has tax associated with it. One indicates taxable and zero indicates non-taxable. Allowed values:
|
|||||||||||||||||
| tax_group | int | 1 | No |
Specifies the tax group associated with the service. This value is null if taxable_ind is set to zero. If taxable_ind is one, this field is required. Alternative field: client_tax_group_id |
||||||||||||||||
| usage_type | int | 38 | No |
Specifies the usage type associated with the service. If service_type is Usage-Based, this field is required. This field accepts only a 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. |
|||||||||||||||||
| 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 or N. Determines whether the service can consume service credits. A null value indicates 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. |
Outputs
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| error_code | long | Yes |
Aria-assigned error identifier. Zero indicates no error. |
|
| error_msg | string | Yes |
Textual description of any error that occurred. "OK" if there was no error. |
|
| service_no | long | No |
Aria-assigned unique identifier of the service that was updated. |