Skip to main content
Get a single support-activity

Authorizations

Authorization
string
header
required

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

Path Parameters

id
integer
required
Required range: x > 0
Example:

1

Response

200 - application/json

Object with support-activity data.

id
integer
required

Support activity id

Required range: x > 0
Example:

1

start
required

Support activity start date time

Example:

"2023-07-30T09:00:00.000Z"

end
required

Support activity start date time

Example:

"2023-07-30T09:00:00.000Z"

patientId
integer
required

Patient id

Required range: x > 0
Example:

1

practitionerId
integer
required

The practitioner id of this support activity

Required range: x > 0
Example:

1

serviceId
integer
required

The service id of this support activity

Required range: x > 0
Example:

1

locationId
integer
required

The location id of this support activity

Required range: x > 0
Example:

1

caseId
integer | null
required

The case id of this support activity

Required range: x > 0
Example:

1

note
string | null
required

Note for the support activity

Example:

"Some notes"

itemCode
string | null
required

Item code for the support activity

Example:

1234567890

repeatId
string | null
required

An recurring support activity will have this repeat id

Example:

"12345678-abcd-4321-dcba-12a34b56c78d"

recurringRule
string | null
required

The rule for recurring support activity

Example:

"DTSTART:2023080T010000ZRRULE:FREQ=WEEKLY;INTERVAL=2;COUNT=6"

unit
string | null
default:Hour
required

The support activity unit

pricing
number | null
required

The support activity unit price, in dollar

Example:

193.99

quantity
number | null
required

The support activity quantity

Example:

193.99

taxType
required

Tax type, check Splose support for more info

Available options:
STANDARD,
ZERO,
EXEMPT,
REDUCED
Example:

"STANDARD"

invoiceId
integer | null
required

Invoice id of this support activity patient

Required range: x > 0
Example:

1

deletedAt
required

Object archived date time

Example:

"2023-07-30T09:00:00.000Z"

doNotInvoice
boolean | null
default:false

Whether this support activity patient will not be invoiced

archived
boolean | null
default:false

Whether the support activity has been archived

createdAt

Object creation date time

Example:

"2023-07-30T09:00:00.000Z"

updatedAt

Object update date time

Example:

"2023-07-30T09:00:00.000Z"