Service

What can you do with Service?


Properties

Property Details
id
"id": 863
Type: Number
This is the unique numeric identifier for the Service
name
"name": "Hello World"
Type: String
ownerId
"ownerId": 504
Type: Number
Unique identifier for the associated Owner object.
serviceTypeId
"serviceTypeId": 443
Type: Number
Unique identifier for the associated ServiceType object.
usageFrequency
"usageFrequency": 602
Type: Number
usageFrequencyTypeId
"usageFrequencyTypeId": 503
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": 103
Type: Number
Unique identifier for the associated InvoiceIdentifier object.
isActive
"isActive": true
Type: Boolean
isTaxExempt
"isTaxExempt": true
Type: Boolean
isInclusiveTaxes
"isInclusiveTaxes": true
Type: Boolean
start
"start": "2005-04-11T14:56:24"
Type: Date
expiry
"expiry": "2005-04-11T14:56:24"
Type: Date
generalLedgerId
"generalLedgerId": 60
Type: Number
Unique identifier for the associated GeneralLedger object.
taxCodeId
"taxCodeId": 896
Type: Number
Unique identifier for the associated TaxCode object.
serviceTaxCategoryId
"serviceTaxCategoryId": 457
Type: Number
Unique identifier for the associated ServiceTaxCategory object.
isUsageBased
"isUsageBased": true
Type: Boolean
isUsageBucketSharePlanService
"isUsageBucketSharePlanService": true
Type: Boolean
defaultServiceStatusTypeId
"defaultServiceStatusTypeId": 344
Type: Number
Unique identifier for the associated ServiceStatusType object.


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
  • start
  • expiry
  • generalLedgerId
  • taxCodeId
  • serviceTaxCategoryId
  • defaultServiceStatusTypeId
  • isUsageBased

DataFlow PATCH objects:


End Points

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