Sign in

v1

latestOpenAPI 3.0.02026-07-26550199.6 KB
service

Get a single service

Get service data by id

get/services/{id}

Path parameters

idinteger required
Example:1

Response

Object with service data.

idinteger required

Service id

for'appointment' | 'support activity' required

The service is used for

namestring required

Service name

descriptionstring nullable required

Service description

typestring nullable required

Service type

codestring nullable required

Service code

durationnumber nullable required

Service duration in minute

unit'Hour' | 'Each' nullable required

Service unit

pricingnumber nullable required

Service unit price in dollar

allowProviderTravelboolean nullable

Whether provider travel is enabled

providerTravelItemCodestring nullable required

Provider travel item code

providerTravelPricingnumber nullable required

Provider travel item pricing

allowProviderTravelNonLabourCostsboolean nullable

Whether provider travel non labour cost is enabled

providerTravelNonLabourCostsItemCodestring nullable required

Provider travel non labour cost item code

providerTravelNonLabourCostsPricingnumber nullable required

Provider travel non labour cost item pricing

serviceTagsstring[] required

Service tags

archivedboolean nullable

Whether the service has been archived

Example response

{
  "id": 1,
  "for": "appointment",
  "name": "Initial Consultation",
  "description": "This is a sample service",
  "type": "Other",
  "code": "ABC123",
  "duration": 90,
  "unit": "Hour",
  "pricing": 193.99,
  "serviceTags": [
    "NDIS"
  ]
}