Update or Add the Service object and optionally make changes to any child objects.

patch

https://{server_address}/ResourceServer/api/v10/Service/{id}

Path Params

integer

required

Unique identifier for the Service object.

Body Params

Represents Service definition which represents a chargable item that can be attached to a Package.

name

string

serviceTypeId

number

Unique identifier for the associated ServiceType object.

serviceTypeName

string

The name of the object associated with the serviceTypeId property.

usageFrequency

number

usageFrequencyTypeId

number

Unique identifier for the associated FrequencyType object.

usageFrequencyTypeName

string

The name of the object associated with the usageFrequencyTypeId property.

isActive

boolean

isTaxExempt

boolean

isTaxInclusive

boolean

generalLedgerId

number

Unique identifier for the associated GeneralLedger object.

generalLedgerName

string

The name of the object associated with the generalLedgerId property.

serviceTaxCategoryId

number

Unique identifier for the associated ServiceTaxCategory object.

serviceTaxCategoryName

string

The name of the object associated with the serviceTaxCategoryId property.

defaultServiceStatusTypeId

number

Unique identifier for the associated ServiceStatusType object.

defaultServiceStatusTypeName

string

The name of the object associated with the defaultServiceStatusTypeId property.

serviceCategoryId

number

Unique identifier for the associated ServiceCategory object.

serviceCategoryName

string

The name of the object associated with the serviceCategoryId property.

description

string

number

Responses

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Patch end points allow for adding/updating multiple related entities and the results of those changes will be reported in the response JSON payload in the items array.

400The request could not be processed.