Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
integer
required
Required range: x > 0

Response

200 - application/json
id
integer
required

Support activity id

Required range: x > 0
start
required

Support activity start date time

end
required

Support activity start date time

patientId
integer
required

Patient id

Required range: x > 0
practitionerId
integer
required

The practitioner id of this support activity

Required range: x > 0
serviceId
integer
required

The service id of this support activity

Required range: x > 0
locationId
integer
required

The location id of this support activity

Required range: x > 0
caseId
integer | null
required

The case id of this support activity

Required range: x > 0
note
string | null
required

Note for the support activity

itemCode
string | null
required

Item code for the support activity

repeatId
string | null
required

An recurring support activity will have this repeat id

recurringRule
string | null
required

The rule for recurring support activity

unit
string | null
default: Hourrequired

The support activity unit

pricing
number | null
required

The support activity unit price, in dollar

quantity
number | null
required

The support activity quantity

taxType
required

Tax type, check Splose support for more info

Available options:
STANDARD,
ZERO,
EXEMPT,
REDUCED
invoiceId
integer | null
required

Invoice id of this support activity patient

Required range: x > 0
createdAt
required

Object creation date time

updatedAt
required

Object update date time

deletedAt
required

Object archived date time

doNotInvoice
boolean | null
default: false

Whether this support activity patient will not be invoiced