Skip to main content
Get a single support-item

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-item data.

id
integer
required

Support item id

Required range: x > 0
Example:

1

appointmentId
integer
required

Appointment id of the support item

Required range: x > 0
Example:

1

type
enum<string>
required

Support item type

Available options:
Provider Travel,
Provider Travel - Non-Labour Costs,
Activity Based Transport
Example:

"Provider Travel"

itemCode
string | null
required

Support item code

Example:

1234567890

pricing
number | null
required

The appointment unit price, in dollar

Example:

193.99

toMinutes
number | null
required

Minutes spent on travelling to the patient for provider travel

Example:

20

returnMinutes
number | null
required

Minutes spent traveling from the patient for provider travel

Example:

20

appointmentAddress
string | null
required

The appointment address for provider travel

Example:

"123 King William Street, Adelaide SA, 5000"

unit
string | null
required

The support item unit

Example:

"km"

quantity
number | null
required

The support item quantity

Example:

null

note
string | null
required

The support item note

Example:

"Some notes"

deletedAt
required

Object archived date time

Example:

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

createdAt

Object creation date time

Example:

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

updatedAt

Object update date time

Example:

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