support-item

Get a single support-item

Get support-item data by id

get/support-items/{id}

Request

Base URL
https://api.splose.com/v1
Auth
HTTP bearer
TypeScript
https://skmtc.dev/splose/apis/splose-public-api/docs/support-items/:id/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

idinteger required

Example:1

Response

Object with support-item data.

idinteger required

Support item id

appointmentIdinteger required

Appointment id of the support item

type'Provider Travel' | 'Provider Travel - Non-Labour Costs' | 'Activity Based Transport' required

Support item type

itemCodestring nullable required

Support item code

pricingnumber nullable required

The appointment unit price, in dollar

toMinutesnumber nullable required

Minutes spent on travelling to the patient for provider travel

returnMinutesnumber nullable required

Minutes spent traveling from the patient for provider travel

appointmentAddressstring nullable required

The appointment address for provider travel

unitstring nullable required

The support item unit

quantitynumber nullable required

The support item quantity

notestring nullable required

The support item note

Example response

{
  "id": 1,
  "appointmentId": 1,
  "type": "Provider Travel",
  "pricing": 193.99,
  "toMinutes": 20,
  "returnMinutes": 20,
  "appointmentAddress": "123 King William Street, Adelaide SA, 5000",
  "unit": "km",
  "note": "Some notes"
}

Changes

No recorded changes to this operation across all 1 revision of this API.