TAG LINE
SMALL TITLE

Service

(API Version v3)


What can you do with Service?


Properties

Property Details
id
"id": 17
Type: Number
This is the unique numeric identifier for the Service
name
"name": "Hello World"
Type: String
ownerId
"ownerId": 23
Type: Number
Unique identifier for the associated Owner object.
serviceTypeId
"serviceTypeId": 24
Type: Number
Unique identifier for the associated ServiceType object.
usageFrequency
"usageFrequency": 21
Type: Number
usageFrequencyTypeId
"usageFrequencyTypeId": 25
Type: Number
Unique identifier for the associated FrequencyType object.
created
"created": "2005-04-11T14:56:24"
Type: Date
description
"description": "Hello World"
Type: String
invoiceIdentifierId
"invoiceIdentifierId": 20
Type: Number
Unique identifier for the associated InvoiceIdentifier object.
isActive
"isActive": true
Type: Boolean
isTaxExempt
"isTaxExempt": true
Type: Boolean
isInclusiveTaxes
"isInclusiveTaxes": true
Type: Boolean
generalLedgerId
"generalLedgerId": 19
Type: Number
Unique identifier for the associated GeneralLedger object.
taxCodeId
"taxCodeId": 0
Type: Number
Unique identifier for the associated TaxCode object.
serviceTaxCategoryId
"serviceTaxCategoryId": 18
Type: Number
Unique identifier for the associated ServiceTaxCategory object.
defaultServiceStatusTypeId
"defaultServiceStatusTypeId": 14
Type: Number
Unique identifier for the associated ServiceStatusType object.
serviceCategoryId
"serviceCategoryId": 12
Type: Number
Unique identifier for the associated ServiceCategory object.
id
"id": 15
Type: Number


Update Request Filters

When updating an object you use the update request header with the list of properties to update. Then you need only supply the new values in the body of your request. Please note, this header can only be used with PUT or PATCH requests.

Field List:

  • name
  • serviceTypeId
  • usageFrequency
  • usageFrequencyTypeId
  • created
  • description
  • invoiceIdentifierId
  • isActive
  • isTaxExempt
  • isInclusiveTaxes
  • generalLedgerId
  • taxCodeId
  • serviceTaxCategoryId
  • defaultServiceStatusTypeId
  • serviceCategoryId

Patch Types

The PATCH verb allows you to update an object. Just like a put, you only need to supply the fields that will be updated in the payload. However, a patch allows you to update many objects at once.

PATCH operations can be used as a standard API call or nested within the envelope of a DataFlow. Below you will find the child objects that can be updated as part of PATCH operations for the Service object.

Standard PATCH objects:

DataFlow PATCH objects:


End Points

DELETEapi/v3/Service/{id:int}
Delete an instance of the Service object.
GETapi/v3/Service
Retrieve all of the Service objects.
GETapi/v3/Service/AvailableFor/SharePlans
Retrieve all of the Service objects.
GETapi/v3/Service/Paged
Retreive all of the Service objects in a paged fashion.
GETapi/v3/Service/Paged/Detail
Retreive all of the Service objects in a paged fashion with all object details.
GETapi/v3/Service/{id:int}
Retrieve an instance of the Service object by it's ID.
{id:int}Unique identifier for the Service object.
GETapi/v3/Service/{id:int}/Detail
Retreive all of the Detail objects for the specified Service.
{id:int}Unique identifier for the Service object.
PATCHapi/v3/Service/{id:int}
Update the Service object and optionally make changes to any child objects.
POSTapi/v3/Service
Create a new instance of the Service object.
PUTapi/v3/Service/{id:int}
Update an existing instance of the Service object.