API docs by Redocly

Provet Cloud REST API Version 0.1

Download OpenAPI specification:Download

Accounting reports

List Accounting Reports

List Accounting Reports

Required permissions:

  • Financial: Can access / edit end of day and accounting reports

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Get Accounting Report by ID

Get Accounting Report by ID

Required permissions:

  • Financial: Can access / edit end of day and accounting reports

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this cash report accounting.

Responses

Account numbers

List Account Numbers

List Account Numbers

Required permissions:

  • Financial: Can access / edit invoices

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Account Number

Account Number

Required permissions:

  • Financial: Can access / edit invoices

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this account number.

Responses

Alternative payers

List Alternative Payers

List Alternative Payers

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Create new Alternative Payer

Create new Alternative Payer

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

Request Body schema: application/json
name
string
id_number
string
organization_name
string
register_number
string
street_address
string
street_address_2
string
street_address_3
string
zip_code
string
city
string
state
string
country_region
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "id_number": "string",
  • "organization_name": "string",
  • "register_number": "string",
  • "street_address": "string",
  • "street_address_2": "string",
  • "street_address_3": "string",
  • "zip_code": "string",
  • "city": "string",
  • "state": "string",
  • "country_region": "string"
}

Get Alternative Payer by ID

Get Alternative Payer by ID

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this alternative payer.

Responses

Update Alternative Payer

Update Alternative Payer

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this alternative payer.

Request Body schema: application/json
name
string
id_number
string
organization_name
string
register_number
string
street_address
string
street_address_2
string
street_address_3
string
zip_code
string
city
string
state
string
country_region
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "id_number": "string",
  • "organization_name": "string",
  • "register_number": "string",
  • "street_address": "string",
  • "street_address_2": "string",
  • "street_address_3": "string",
  • "zip_code": "string",
  • "city": "string",
  • "state": "string",
  • "country_region": "string"
}

Partially update Alternative Payer

Partially update Alternative Payer

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this alternative payer.

Request Body schema: application/json
name
string
id_number
string
organization_name
string
register_number
string
street_address
string
street_address_2
string
street_address_3
string
zip_code
string
city
string
state
string
country_region
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "id_number": "string",
  • "organization_name": "string",
  • "register_number": "string",
  • "street_address": "string",
  • "street_address_2": "string",
  • "street_address_3": "string",
  • "zip_code": "string",
  • "city": "string",
  • "state": "string",
  • "country_region": "string"
}

Archive Alternative Payer

Archive Alternative Payer

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this alternative payer.

Responses

Alternative pricings

List Alternative Pricings

List Alternative Pricings

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Create new Alternative Pricing

Create new Alternative Pricing

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 300 requests per minute.

Request Body schema: application/json
item
required
string
name
required
string
usage_size
required
string
quantity
number
nominator
required
string
margin_percent
number
use_extra_fees
boolean

Responses

Request samples

Content type
application/json
{
  • "item": "string",
  • "name": "string",
  • "usage_size": "string",
  • "quantity": 0,
  • "nominator": "string",
  • "margin_percent": 0,
  • "use_extra_fees": true
}

Get Alternative Pricing by ID

Get Alternative Pricing by ID

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this alternative pricing.

Responses

Update Alternative Pricing

Update Alternative Pricing

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this alternative pricing.

Request Body schema: application/json
item
required
string
name
required
string
usage_size
required
string
quantity
number
nominator
required
string
margin_percent
number
use_extra_fees
boolean

Responses

Request samples

Content type
application/json
{
  • "item": "string",
  • "name": "string",
  • "usage_size": "string",
  • "quantity": 0,
  • "nominator": "string",
  • "margin_percent": 0,
  • "use_extra_fees": true
}

Partially update Alternative Pricing

Partially update Alternative Pricing

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this alternative pricing.

Request Body schema: application/json
item
string
name
string
usage_size
string
quantity
number
nominator
string
margin_percent
number
use_extra_fees
boolean

Responses

Request samples

Content type
application/json
{
  • "item": "string",
  • "name": "string",
  • "usage_size": "string",
  • "quantity": 0,
  • "nominator": "string",
  • "margin_percent": 0,
  • "use_extra_fees": true
}

Archive Alternative Pricing

Archive Alternative Pricing

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this alternative pricing.

Responses

Antibiotics

Get Antibiotics

Get Antibiotics

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Get Antibiotic by ID

Get Antibiotic by ID

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this antibiotic.

Responses

Get Panels

Get Panels

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Get Panel by ID

Get Panel by ID

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this antibiotic panel.

Responses

Appointments

List Appointments

List Appointments

Type values:

  • TYPE_CONSULTATION = 1
  • TYPE_ONLINE_BOOKING = 2
  • TYPE_OTHER = 3

Required permissions:

  • Calendar: Can access / edit appointments

This endpoint is rate-limited to 300 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

ordering
string

Which field to use when ordering the results.

Responses

Create new Appointment

Create new Appointment

Required permissions:

  • Calendar: Can access / edit appointments

This endpoint is rate-limited to 500 requests per minute.

Request Body schema: application/json
start
required
string
end
required
string
title
required
string
complaint
string
reason
string
instructions
string
user
string
additional_users
Array of strings
resources
Array of strings
client
string
patients
Array of strings
parent_appointment
string
notes
string
start_date
string
end_date
string
department
required
string
type
required
string
created_user
string
active
integer
telemedicine_url
string
telemedicine_url_master
string
cancellation_reason_text
string
cancellation_reason
string
no_show
boolean
telemedicine_room
string
ward
string
client_notes
string
related_shifts
Array of strings
allow_double_booking
boolean
confirmed
boolean

Responses

Request samples

Content type
application/json
{
  • "start": "string",
  • "end": "string",
  • "title": "string",
  • "complaint": "string",
  • "reason": "string",
  • "instructions": "string",
  • "user": "string",
  • "additional_users": [
    ],
  • "resources": [
    ],
  • "client": "string",
  • "patients": [
    ],
  • "parent_appointment": "string",
  • "notes": "string",
  • "start_date": "string",
  • "end_date": "string",
  • "department": "string",
  • "type": "string",
  • "created_user": "string",
  • "active": 0,
  • "telemedicine_url": "string",
  • "telemedicine_url_master": "string",
  • "cancellation_reason_text": "string",
  • "cancellation_reason": "string",
  • "no_show": true,
  • "telemedicine_room": "string",
  • "ward": "string",
  • "client_notes": "string",
  • "related_shifts": [
    ],
  • "allow_double_booking": true,
  • "confirmed": true
}

Get Appointment by ID

Get Appointment by ID

Required permissions:

  • Calendar: Can access / edit appointments

This endpoint is rate-limited to 900 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this appointment.

query Parameters
ordering
string

Which field to use when ordering the results.

Responses

Update Appointment

Update Appointment

Required permissions:

  • Calendar: Can access / edit appointments

This endpoint is rate-limited to 500 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this appointment.

query Parameters
ordering
string

Which field to use when ordering the results.

Request Body schema: application/json
start
required
string
end
required
string
title
required
string
complaint
string
reason
string
instructions
string
user
string
additional_users
Array of strings
resources
Array of strings
client
string
patients
Array of strings
parent_appointment
string
notes
string
start_date
string
end_date
string
department
required
string
type
required
string
created_user
string
active
integer
telemedicine_url
string
telemedicine_url_master
string
cancellation_reason_text
string
cancellation_reason
string
no_show
boolean
telemedicine_room
string
ward
string
client_notes
string
related_shifts
Array of strings
allow_double_booking
boolean
confirmed
boolean

Responses

Request samples

Content type
application/json
{
  • "start": "string",
  • "end": "string",
  • "title": "string",
  • "complaint": "string",
  • "reason": "string",
  • "instructions": "string",
  • "user": "string",
  • "additional_users": [
    ],
  • "resources": [
    ],
  • "client": "string",
  • "patients": [
    ],
  • "parent_appointment": "string",
  • "notes": "string",
  • "start_date": "string",
  • "end_date": "string",
  • "department": "string",
  • "type": "string",
  • "created_user": "string",
  • "active": 0,
  • "telemedicine_url": "string",
  • "telemedicine_url_master": "string",
  • "cancellation_reason_text": "string",
  • "cancellation_reason": "string",
  • "no_show": true,
  • "telemedicine_room": "string",
  • "ward": "string",
  • "client_notes": "string",
  • "related_shifts": [
    ],
  • "allow_double_booking": true,
  • "confirmed": true
}

Partially update Appointment

Partially update Appointment

Required permissions:

  • Calendar: Can access / edit appointments

This endpoint is rate-limited to 500 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this appointment.

query Parameters
ordering
string

Which field to use when ordering the results.

Request Body schema: application/json
start
string
end
string
title
string
complaint
string
reason
string
instructions
string
user
string
additional_users
Array of strings
resources
Array of strings
client
string
patients
Array of strings
parent_appointment
string
notes
string
start_date
string
end_date
string
department
string
type
string
created_user
string
active
integer
telemedicine_url
string
telemedicine_url_master
string
cancellation_reason_text
string
cancellation_reason
string
no_show
boolean
telemedicine_room
string
ward
string
client_notes
string
related_shifts
Array of strings
allow_double_booking
boolean
confirmed
boolean

Responses

Request samples

Content type
application/json
{
  • "start": "string",
  • "end": "string",
  • "title": "string",
  • "complaint": "string",
  • "reason": "string",
  • "instructions": "string",
  • "user": "string",
  • "additional_users": [
    ],
  • "resources": [
    ],
  • "client": "string",
  • "patients": [
    ],
  • "parent_appointment": "string",
  • "notes": "string",
  • "start_date": "string",
  • "end_date": "string",
  • "department": "string",
  • "type": "string",
  • "created_user": "string",
  • "active": 0,
  • "telemedicine_url": "string",
  • "telemedicine_url_master": "string",
  • "cancellation_reason_text": "string",
  • "cancellation_reason": "string",
  • "no_show": true,
  • "telemedicine_room": "string",
  • "ward": "string",
  • "client_notes": "string",
  • "related_shifts": [
    ],
  • "allow_double_booking": true,
  • "confirmed": true
}

Admit consultation from appointment

Admit consultation from appointment

Required permissions:

  • Calendar: Can access / edit appointments

This endpoint is rate-limited to 100 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this appointment.

Request Body schema: application/json
start
required
string
end
required
string
title
required
string
complaint
string
reason
string
instructions
string
user
string
additional_users
Array of strings
resources
Array of strings
client
string
patients
Array of strings
parent_appointment
string
notes
string
start_date
string
end_date
string
department
required
string
type
required
string
created_user
string
active
integer
telemedicine_url
string
telemedicine_url_master
string
cancellation_reason_text
string
cancellation_reason
string
no_show
boolean
telemedicine_room
string
ward
string
client_notes
string
related_shifts
Array of strings
allow_double_booking
boolean
confirmed
boolean

Responses

Request samples

Content type
application/json
{
  • "start": "string",
  • "end": "string",
  • "title": "string",
  • "complaint": "string",
  • "reason": "string",
  • "instructions": "string",
  • "user": "string",
  • "additional_users": [
    ],
  • "resources": [
    ],
  • "client": "string",
  • "patients": [
    ],
  • "parent_appointment": "string",
  • "notes": "string",
  • "start_date": "string",
  • "end_date": "string",
  • "department": "string",
  • "type": "string",
  • "created_user": "string",
  • "active": 0,
  • "telemedicine_url": "string",
  • "telemedicine_url_master": "string",
  • "cancellation_reason_text": "string",
  • "cancellation_reason": "string",
  • "no_show": true,
  • "telemedicine_room": "string",
  • "ward": "string",
  • "client_notes": "string",
  • "related_shifts": [
    ],
  • "allow_double_booking": true,
  • "confirmed": true
}

Cancel an appointment

Cancel an appointment

Required permissions:

  • Calendar: Can access / edit appointments

This endpoint is rate-limited to 100 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this appointment.

Request Body schema: application/json
start
required
string
end
required
string
title
required
string
complaint
string
reason
string
instructions
string
user
string
additional_users
Array of strings
resources
Array of strings
client
string
patients
Array of strings
parent_appointment
string
notes
string
start_date
string
end_date
string
department
required
string
type
required
string
created_user
string
active
integer
telemedicine_url
string
telemedicine_url_master
string
cancellation_reason_text
string
cancellation_reason
string
no_show
boolean
telemedicine_room
string
ward
string
client_notes
string
related_shifts
Array of strings
allow_double_booking
boolean
confirmed
boolean

Responses

Request samples

Content type
application/json
{
  • "start": "string",
  • "end": "string",
  • "title": "string",
  • "complaint": "string",
  • "reason": "string",
  • "instructions": "string",
  • "user": "string",
  • "additional_users": [
    ],
  • "resources": [
    ],
  • "client": "string",
  • "patients": [
    ],
  • "parent_appointment": "string",
  • "notes": "string",
  • "start_date": "string",
  • "end_date": "string",
  • "department": "string",
  • "type": "string",
  • "created_user": "string",
  • "active": 0,
  • "telemedicine_url": "string",
  • "telemedicine_url_master": "string",
  • "cancellation_reason_text": "string",
  • "cancellation_reason": "string",
  • "no_show": true,
  • "telemedicine_room": "string",
  • "ward": "string",
  • "client_notes": "string",
  • "related_shifts": [
    ],
  • "allow_double_booking": true,
  • "confirmed": true
}

Create advance payment

Create advance payment

Create invoice if Appointment's complaint type that has "advance payment item" linked to it.

Required permissions:

  • Calendar: Can access / edit appointments

This endpoint is rate-limited to 100 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this appointment.

Request Body schema: application/json
start
required
string
end
required
string
title
required
string
complaint
string
reason
string
instructions
string
user
string
additional_users
Array of strings
resources
Array of strings
client
string
patients
Array of strings
parent_appointment
string
notes
string
start_date
string
end_date
string
department
required
string
type
required
string
created_user
string
active
integer
telemedicine_url
string
telemedicine_url_master
string
cancellation_reason_text
string
cancellation_reason
string
no_show
boolean
telemedicine_room
string
ward
string
client_notes
string
related_shifts
Array of strings
allow_double_booking
boolean
confirmed
boolean

Responses

Request samples

Content type
application/json
{
  • "start": "string",
  • "end": "string",
  • "title": "string",
  • "complaint": "string",
  • "reason": "string",
  • "instructions": "string",
  • "user": "string",
  • "additional_users": [
    ],
  • "resources": [
    ],
  • "client": "string",
  • "patients": [
    ],
  • "parent_appointment": "string",
  • "notes": "string",
  • "start_date": "string",
  • "end_date": "string",
  • "department": "string",
  • "type": "string",
  • "created_user": "string",
  • "active": 0,
  • "telemedicine_url": "string",
  • "telemedicine_url_master": "string",
  • "cancellation_reason_text": "string",
  • "cancellation_reason": "string",
  • "no_show": true,
  • "telemedicine_room": "string",
  • "ward": "string",
  • "client_notes": "string",
  • "related_shifts": [
    ],
  • "allow_double_booking": true,
  • "confirmed": true
}

Create telemedicine room

Create telemedicine room

Create telemedicine room for the Appointment.

Required permissions:

  • Calendar: Can access / edit appointments

This endpoint is rate-limited to 100 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this appointment.

Request Body schema: application/json
start
required
string
end
required
string
title
required
string
complaint
string
reason
string
instructions
string
user
string
additional_users
Array of strings
resources
Array of strings
client
string
patients
Array of strings
parent_appointment
string
notes
string
start_date
string
end_date
string
department
required
string
type
required
string
created_user
string
active
integer
telemedicine_url
string
telemedicine_url_master
string
cancellation_reason_text
string
cancellation_reason
string
no_show
boolean
telemedicine_room
string
ward
string
client_notes
string
related_shifts
Array of strings
allow_double_booking
boolean
confirmed
boolean

Responses

Request samples

Content type
application/json
{
  • "start": "string",
  • "end": "string",
  • "title": "string",
  • "complaint": "string",
  • "reason": "string",
  • "instructions": "string",
  • "user": "string",
  • "additional_users": [
    ],
  • "resources": [
    ],
  • "client": "string",
  • "patients": [
    ],
  • "parent_appointment": "string",
  • "notes": "string",
  • "start_date": "string",
  • "end_date": "string",
  • "department": "string",
  • "type": "string",
  • "created_user": "string",
  • "active": 0,
  • "telemedicine_url": "string",
  • "telemedicine_url_master": "string",
  • "cancellation_reason_text": "string",
  • "cancellation_reason": "string",
  • "no_show": true,
  • "telemedicine_room": "string",
  • "ward": "string",
  • "client_notes": "string",
  • "related_shifts": [
    ],
  • "allow_double_booking": true,
  • "confirmed": true
}

Send Appointment confirmation

Send Appointment confirmation

Send Appointment confirmation for client. Requires Appointment to have client set and [request_hash] value received when creating Appointment.

When sending confirmations for online booking appointments, a client and patient must first be created via the /onlinebookingclient/ and /onlinebookingpatient/ endpoints.

Required permissions:

  • Calendar: Can access / edit appointments

This endpoint is rate-limited to 100 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this appointment.

Request Body schema: application/json
start
required
string
end
required
string
title
required
string
complaint
string
reason
string
instructions
string
user
string
additional_users
Array of strings
resources
Array of strings
client
string
patients
Array of strings
parent_appointment
string
notes
string
start_date
string
end_date
string
department
required
string
type
required
string
created_user
string
active
integer
telemedicine_url
string
telemedicine_url_master
string
cancellation_reason_text
string
cancellation_reason
string
no_show
boolean
telemedicine_room
string
ward
string
client_notes
string
related_shifts
Array of strings
allow_double_booking
boolean
confirmed
boolean

Responses

Request samples

Content type
application/json
{
  • "start": "string",
  • "end": "string",
  • "title": "string",
  • "complaint": "string",
  • "reason": "string",
  • "instructions": "string",
  • "user": "string",
  • "additional_users": [
    ],
  • "resources": [
    ],
  • "client": "string",
  • "patients": [
    ],
  • "parent_appointment": "string",
  • "notes": "string",
  • "start_date": "string",
  • "end_date": "string",
  • "department": "string",
  • "type": "string",
  • "created_user": "string",
  • "active": 0,
  • "telemedicine_url": "string",
  • "telemedicine_url_master": "string",
  • "cancellation_reason_text": "string",
  • "cancellation_reason": "string",
  • "no_show": true,
  • "telemedicine_room": "string",
  • "ward": "string",
  • "client_notes": "string",
  • "related_shifts": [
    ],
  • "allow_double_booking": true,
  • "confirmed": true
}

Upload multiple files to Appointment

Upload multiple files to Appointment

Maximum of five (5) files can be uploaded in a single request.

Required permissions:

  • Calendar: Can access / edit appointments

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_appointment
required
string
Request Body schema: application/json
id
string
description
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "description": "string"
}

List Appointment Uploads

List Appointment Uploads

Required permissions:

  • Calendar: Can access / edit appointments

This endpoint is rate-limited to 100 requests per minute.

path Parameters
parent_lookup_appointment
required
string
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Request Body schema: multipart/form-data
file
required
string
original_name
required
string
thumbnail_url
string

Responses

Create new Appointment Upload

Create new Appointment Upload

Required permissions:

  • Calendar: Can access / edit appointments

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_appointment
required
string
Request Body schema: multipart/form-data
file
required
string
original_name
required
string
thumbnail_url
string

Responses

Get Appointment Upload by ID

Get Appointment Upload by ID

Required permissions:

  • Calendar: Can access / edit appointments

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_appointment
required
string
id
required
integer

A unique integer value identifying this upload.

Request Body schema: multipart/form-data
file
required
string
original_name
required
string
thumbnail_url
string

Responses

Archive Appointment Upload

Archive Appointment Upload

Required permissions:

  • Calendar: Can access / edit appointments

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_appointment
required
string
id
required
integer

A unique integer value identifying this upload.

Responses

Appointment reminders

List Appointment Reminders

List Appointment Reminders

type_code values:

  • APPOINTMENT_REMINDER_SMS = 1
  • APPOINTMENT_REMINDER_EMAIL = 2
  • APPOINTMENT_SELF_CHECK_IN_REMINDER_SMS = 3
  • APPOINTMENT_SELF_CHECK_IN_REMINDER_EMAIL = 4

Required permissions:

  • Calendar: Can access / edit appointments

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

ordering
string

Which field to use when ordering the results.

Responses

Create new Appointment Reminder

Create new Appointment Reminder

If send_datetime is not provided in the POST request body, send time will be determined based on the send time settings of appointments reason or department booking settings.

Required permissions:

  • Calendar: Can access / edit appointments

This endpoint is rate-limited to 300 requests per minute.

Request Body schema: application/json
appointment
required
string
type_code
required
string
send_date
string
send_datetime
string
sent_datetime
string
phone_number
string
email
string
sms_text
string

Responses

Request samples

Content type
application/json
{
  • "appointment": "string",
  • "type_code": "string",
  • "send_date": "string",
  • "send_datetime": "string",
  • "sent_datetime": "string",
  • "phone_number": "string",
  • "email": "string",
  • "sms_text": "string"
}

Get Appointment Reminder by ID

Get Appointment Reminder by ID

Required permissions:

  • Calendar: Can access / edit appointments

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this appointment reminder.

query Parameters
ordering
string

Which field to use when ordering the results.

Responses

Update Appointment Reminder

Update Appointment Reminder

Required permissions:

  • Calendar: Can access / edit appointments

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this appointment reminder.

query Parameters
ordering
string

Which field to use when ordering the results.

Request Body schema: application/json
type_code
required
string
send_date
string
send_datetime
required
string
sent_datetime
string
phone_number
required
string
email
string
sms_text
required
string
sms_text_sent
string

Responses

Request samples

Content type
application/json
{
  • "type_code": "string",
  • "send_date": "string",
  • "send_datetime": "string",
  • "sent_datetime": "string",
  • "phone_number": "string",
  • "email": "string",
  • "sms_text": "string",
  • "sms_text_sent": "string"
}

Partially update Appointment Reminder

Partially update Appointment Reminder

Required permissions:

  • Calendar: Can access / edit appointments

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this appointment reminder.

query Parameters
ordering
string

Which field to use when ordering the results.

Request Body schema: application/json
type_code
string
send_date
string
send_datetime
string
sent_datetime
string
phone_number
string
email
string
sms_text
string
sms_text_sent
string

Responses

Request samples

Content type
application/json
{
  • "type_code": "string",
  • "send_date": "string",
  • "send_datetime": "string",
  • "sent_datetime": "string",
  • "phone_number": "string",
  • "email": "string",
  • "sms_text": "string",
  • "sms_text_sent": "string"
}

Mark an Appointment Reminder sent

Mark an Appointment Reminder sent

The reminder must not have been marked as sent before for this to work.

Required permissions:

  • Calendar: Can access / edit appointments

This endpoint is rate-limited to 100 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this appointment reminder.

Responses

Cancellation reasons

List Cancellation Reasons

List Cancellation Reasons

Required permissions:

  • Settings: Can access / edit reasons

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Get Cancellation Reason by ID

Get Cancellation Reason by ID

Required permissions:

  • Settings: Can access / edit reasons

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this cancellation reason.

Responses

Check block visibility

Check Block Visibility

Check Block Visibility

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this block.

Responses

Clients

List Clients

List Clients

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 125 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

ordering
string

Which field to use when ordering the results.

Responses

Create new Client

Create new Client

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

Request Body schema: application/json
id
integer
title
string
firstname
string
lastname
string
organization_name
string
customer_type
string
vat_number
string
register_number
string
home_department
string
due_date_delay
integer
street_address
string
street_address_2
string
street_address_3
string
zip_code
string
city
string
state
string
country_region
string
email
string
alt_emails
string
id_number
string
old_client_id
string
critical_notes
string
critical_accounting_notes
string
remarks
string
archived
boolean
country
string

Updating/creating: use two letter country initials

no_sms
boolean
no_email
boolean
external
boolean
referring_organization
boolean
parent_referring_organization
string
breeder
boolean
referring_vet
boolean
imported
boolean
date_imported
string
patients
required
Array of strings
invoicing_client
string
tags_rel
Array of strings
created_user
string
modified_user
string
status_type
string
fields_rel
Array of strings
farm_code
string
production_animal_client
boolean
einvoice_address
string
einvoice_operator
string
alternative_payer
string
secondary_owner_first_name
string
secondary_owner_last_name
string
on_stop
boolean
has_alive_patients
boolean

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "title": "string",
  • "firstname": "string",
  • "lastname": "string",
  • "organization_name": "string",
  • "customer_type": "string",
  • "vat_number": "string",
  • "register_number": "string",
  • "home_department": "string",
  • "due_date_delay": 0,
  • "street_address": "string",
  • "street_address_2": "string",
  • "street_address_3": "string",
  • "zip_code": "string",
  • "city": "string",
  • "state": "string",
  • "country_region": "string",
  • "email": "string",
  • "alt_emails": "string",
  • "id_number": "string",
  • "old_client_id": "string",
  • "critical_notes": "string",
  • "critical_accounting_notes": "string",
  • "remarks": "string",
  • "archived": true,
  • "country": "string",
  • "no_sms": true,
  • "no_email": true,
  • "external": true,
  • "referring_organization": true,
  • "parent_referring_organization": "string",
  • "breeder": true,
  • "referring_vet": true,
  • "imported": true,
  • "date_imported": "string",
  • "patients": [
    ],
  • "invoicing_client": "string",
  • "tags_rel": [
    ],
  • "created_user": "string",
  • "modified_user": "string",
  • "status_type": "string",
  • "fields_rel": [
    ],
  • "farm_code": "string",
  • "production_animal_client": true,
  • "einvoice_address": "string",
  • "einvoice_operator": "string",
  • "alternative_payer": "string",
  • "secondary_owner_first_name": "string",
  • "secondary_owner_last_name": "string",
  • "on_stop": true,
  • "has_alive_patients": true
}

Get Client by ID

Get Client by ID

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 500 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this client.

query Parameters
ordering
string

Which field to use when ordering the results.

Responses

Update Client

Update Client

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 200 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this client.

query Parameters
ordering
string

Which field to use when ordering the results.

Request Body schema: application/json
id
integer
title
string
firstname
string
lastname
string
organization_name
string
customer_type
string
vat_number
string
register_number
string
home_department
string
due_date_delay
integer
street_address
string
street_address_2
string
street_address_3
string
zip_code
string
city
string
state
string
country_region
string
email
string
alt_emails
string
id_number
string
old_client_id
string
critical_notes
string
critical_accounting_notes
string
remarks
string
archived
boolean
country
string

Updating/creating: use two letter country initials

no_sms
boolean
no_email
boolean
external
boolean
referring_organization
boolean
parent_referring_organization
string
breeder
boolean
referring_vet
boolean
imported
boolean
date_imported
string
patients
required
Array of strings
invoicing_client
string
tags_rel
Array of strings
created_user
string
modified_user
string
status_type
string
fields_rel
Array of strings
farm_code
string
production_animal_client
boolean
einvoice_address
string
einvoice_operator
string
alternative_payer
string
secondary_owner_first_name
string
secondary_owner_last_name
string
on_stop
boolean
has_alive_patients
boolean

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "title": "string",
  • "firstname": "string",
  • "lastname": "string",
  • "organization_name": "string",
  • "customer_type": "string",
  • "vat_number": "string",
  • "register_number": "string",
  • "home_department": "string",
  • "due_date_delay": 0,
  • "street_address": "string",
  • "street_address_2": "string",
  • "street_address_3": "string",
  • "zip_code": "string",
  • "city": "string",
  • "state": "string",
  • "country_region": "string",
  • "email": "string",
  • "alt_emails": "string",
  • "id_number": "string",
  • "old_client_id": "string",
  • "critical_notes": "string",
  • "critical_accounting_notes": "string",
  • "remarks": "string",
  • "archived": true,
  • "country": "string",
  • "no_sms": true,
  • "no_email": true,
  • "external": true,
  • "referring_organization": true,
  • "parent_referring_organization": "string",
  • "breeder": true,
  • "referring_vet": true,
  • "imported": true,
  • "date_imported": "string",
  • "patients": [
    ],
  • "invoicing_client": "string",
  • "tags_rel": [
    ],
  • "created_user": "string",
  • "modified_user": "string",
  • "status_type": "string",
  • "fields_rel": [
    ],
  • "farm_code": "string",
  • "production_animal_client": true,
  • "einvoice_address": "string",
  • "einvoice_operator": "string",
  • "alternative_payer": "string",
  • "secondary_owner_first_name": "string",
  • "secondary_owner_last_name": "string",
  • "on_stop": true,
  • "has_alive_patients": true
}

Partially update Client

Partially update Client

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 200 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this client.

query Parameters
ordering
string

Which field to use when ordering the results.

Request Body schema: application/json
id
integer
title
string
firstname
string
lastname
string
organization_name
string
customer_type
string
vat_number
string
register_number
string
home_department
string
due_date_delay
integer
street_address
string
street_address_2
string
street_address_3
string
zip_code
string
city
string
state
string
country_region
string
email
string
alt_emails
string
id_number
string
old_client_id
string
critical_notes
string
critical_accounting_notes
string
remarks
string
archived
boolean
country
string

Updating/creating: use two letter country initials

no_sms
boolean
no_email
boolean
external
boolean
referring_organization
boolean
parent_referring_organization
string
breeder
boolean
referring_vet
boolean
imported
boolean
date_imported
string
patients
Array of strings
invoicing_client
string
tags_rel
Array of strings
created_user
string
modified_user
string
status_type
string
fields_rel
Array of strings
farm_code
string
production_animal_client
boolean
einvoice_address
string
einvoice_operator
string
alternative_payer
string
secondary_owner_first_name
string
secondary_owner_last_name
string
on_stop
boolean
has_alive_patients
boolean

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "title": "string",
  • "firstname": "string",
  • "lastname": "string",
  • "organization_name": "string",
  • "customer_type": "string",
  • "vat_number": "string",
  • "register_number": "string",
  • "home_department": "string",
  • "due_date_delay": 0,
  • "street_address": "string",
  • "street_address_2": "string",
  • "street_address_3": "string",
  • "zip_code": "string",
  • "city": "string",
  • "state": "string",
  • "country_region": "string",
  • "email": "string",
  • "alt_emails": "string",
  • "id_number": "string",
  • "old_client_id": "string",
  • "critical_notes": "string",
  • "critical_accounting_notes": "string",
  • "remarks": "string",
  • "archived": true,
  • "country": "string",
  • "no_sms": true,
  • "no_email": true,
  • "external": true,
  • "referring_organization": true,
  • "parent_referring_organization": "string",
  • "breeder": true,
  • "referring_vet": true,
  • "imported": true,
  • "date_imported": "string",
  • "patients": [
    ],
  • "invoicing_client": "string",
  • "tags_rel": [
    ],
  • "created_user": "string",
  • "modified_user": "string",
  • "status_type": "string",
  • "fields_rel": [
    ],
  • "farm_code": "string",
  • "production_animal_client": true,
  • "einvoice_address": "string",
  • "einvoice_operator": "string",
  • "alternative_payer": "string",
  • "secondary_owner_first_name": "string",
  • "secondary_owner_last_name": "string",
  • "on_stop": true,
  • "has_alive_patients": true
}

Archives an item.

Archives an item.

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this client.

query Parameters
ordering
string

Which field to use when ordering the results.

Responses

List Client Custom Fields

List Client Custom Fields

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 100 requests per minute.

path Parameters
parent_lookup_client
required
string
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Create new Client Custom Field

Create new Client Custom Field

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_client
required
string
Request Body schema: application/json
field
required
integer
value
required
string
object_id
required
integer
compound_values
Array of strings

Responses

Request samples

Content type
application/json
{
  • "field": 0,
  • "value": "string",
  • "object_id": 0,
  • "compound_values": [
    ]
}

Get Client Custom Field by ID

Get Client Custom Field by ID

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_client
required
string
id
required
integer

A unique integer value identifying this custom field value.

Responses

Update Client Custom Field

Update Client Custom Field

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_client
required
string
id
required
integer

A unique integer value identifying this custom field value.

Request Body schema: application/json
field
required
integer
value
required
string
object_id
required
integer
compound_values
Array of strings

Responses

Request samples

Content type
application/json
{
  • "field": 0,
  • "value": "string",
  • "object_id": 0,
  • "compound_values": [
    ]
}

Partially update Client Custom Field

Partially update Client Custom Field

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_client
required
string
id
required
integer

A unique integer value identifying this custom field value.

Request Body schema: application/json
field
integer
value
string
object_id
integer
compound_values
Array of strings

Responses

Request samples

Content type
application/json
{
  • "field": 0,
  • "value": "string",
  • "object_id": 0,
  • "compound_values": [
    ]
}

Archive Client Custom Field

Archive Client Custom Field

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_client
required
string
id
required
integer

A unique integer value identifying this custom field value.

Responses

Get latest ID of client

Get latest ID of client

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 100 requests per minute.

Responses

Client communication preference rows

List Client Communication Preference Rows

List Client Communication Preference Rows

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

ordering
string

Which field to use when ordering the results.

Responses

Create new Client Communication Preference Rows

Create new Client Communication Preference Rows

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

Request Body schema: application/json
sms
boolean
email
boolean
phone
boolean
post
boolean
client_preferences
required
string
organization_preference_row
required
string
created_user
string
modified_user
string

Responses

Request samples

Content type
application/json
{
  • "sms": true,
  • "email": true,
  • "phone": true,
  • "post": true,
  • "client_preferences": "string",
  • "organization_preference_row": "string",
  • "created_user": "string",
  • "modified_user": "string"
}

Get Client Communication Preference Rows by ID

Get Client Communication Preference Rows by ID

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this client communication preference row.

query Parameters
ordering
string

Which field to use when ordering the results.

Responses

Update Client Communication Preference Rows

Update Client Communication Preference Rows

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this client communication preference row.

query Parameters
ordering
string

Which field to use when ordering the results.

Request Body schema: application/json
sms
boolean
email
boolean
phone
boolean
post
boolean
client_preferences
required
string
organization_preference_row
required
string
created_user
string
modified_user
string

Responses

Request samples

Content type
application/json
{
  • "sms": true,
  • "email": true,
  • "phone": true,
  • "post": true,
  • "client_preferences": "string",
  • "organization_preference_row": "string",
  • "created_user": "string",
  • "modified_user": "string"
}

Partially update Client Communication Preference Rows

Partially update Client Communication Preference Rows

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this client communication preference row.

query Parameters
ordering
string

Which field to use when ordering the results.

Request Body schema: application/json
sms
boolean
email
boolean
phone
boolean
post
boolean
client_preferences
string
organization_preference_row
string
created_user
string
modified_user
string

Responses

Request samples

Content type
application/json
{
  • "sms": true,
  • "email": true,
  • "phone": true,
  • "post": true,
  • "client_preferences": "string",
  • "organization_preference_row": "string",
  • "created_user": "string",
  • "modified_user": "string"
}

Archive Client Communication Preference Rows

Archive Client Communication Preference Rows

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this client communication preference row.

query Parameters
ordering
string

Which field to use when ordering the results.

Responses

Client communication preferences

List Client Communication Preferences

List Client Communication Preferences

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

ordering
string

Which field to use when ordering the results.

Responses

Create new Client Communication Preference

Create new Client Communication Preference

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

Request Body schema: application/json
client
string
valid_from
required
string
valid_to
required
string
privacy_policy_version
string
consent_given
required
string
created_user
string
modified_user
string
preference_rows
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "client": "string",
  • "valid_from": "string",
  • "valid_to": "string",
  • "privacy_policy_version": "string",
  • "consent_given": "string",
  • "created_user": "string",
  • "modified_user": "string",
  • "preference_rows": [
    ]
}

Get Client Communication Preference by ID

Get Client Communication Preference by ID

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this client communication preferences.

query Parameters
ordering
string

Which field to use when ordering the results.

Responses

Update Client Communication Preference

Update Client Communication Preference

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this client communication preferences.

query Parameters
ordering
string

Which field to use when ordering the results.

Request Body schema: application/json
client
string
valid_from
required
string
valid_to
required
string
privacy_policy_version
string
consent_given
required
string
created_user
string
modified_user
string
preference_rows
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "client": "string",
  • "valid_from": "string",
  • "valid_to": "string",
  • "privacy_policy_version": "string",
  • "consent_given": "string",
  • "created_user": "string",
  • "modified_user": "string",
  • "preference_rows": [
    ]
}

Partially update Client Communication Preference

Partially update Client Communication Preference

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this client communication preferences.

query Parameters
ordering
string

Which field to use when ordering the results.

Request Body schema: application/json
client
string
valid_from
string
valid_to
string
privacy_policy_version
string
consent_given
string
created_user
string
modified_user
string
preference_rows
Array of strings

Responses

Request samples

Content type
application/json
{
  • "client": "string",
  • "valid_from": "string",
  • "valid_to": "string",
  • "privacy_policy_version": "string",
  • "consent_given": "string",
  • "created_user": "string",
  • "modified_user": "string",
  • "preference_rows": [
    ]
}

Archive Client Communication Preference

Archive Client Communication Preference

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this client communication preferences.

query Parameters
ordering
string

Which field to use when ordering the results.

Responses

Codelists

List Breeds

List Breeds

parent_id is the ID of species list, that this breed belongs to. Add ?parent_id=species_id as query parameter to URL and you can fetch only specific breeds

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

ordering
string

Which field to use when ordering the results.

Responses

Get Breed by ID

Get Breed by ID

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
string
query Parameters
ordering
string

Which field to use when ordering the results.

Responses

List Diagnosis

List Diagnosis

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Get Diagnosis by ID

Get Diagnosis by ID

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
string

Responses

List Insurance Companies

List Insurance Companies

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Get Insurance Company by ID

Get Insurance Company by ID

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
string

Responses

List Species

List Species

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

ordering
string

Which field to use when ordering the results.

Responses

Get Species by ID

Get Species by ID

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
string
query Parameters
ordering
string

Which field to use when ordering the results.

Responses

Communication preference rows

List Communication Preference Rows

List Communication Preference Rows

Required permissions:

  • Settings: Can access / edit organization settings

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Create new Communication Preference Row

Create new Communication Preference Row

Required permissions:

  • Settings: Can access / edit organization settings

This endpoint is rate-limited to 300 requests per minute.

Request Body schema: application/json
name
required
string
description
string
active
boolean
editable
boolean
sms
boolean
email
boolean
phone
boolean
post
boolean
created_user
string
modified_user
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "active": true,
  • "editable": true,
  • "sms": true,
  • "email": true,
  • "phone": true,
  • "post": true,
  • "created_user": "string",
  • "modified_user": "string"
}

Get Communication Preference Row by ID

Get Communication Preference Row by ID

Required permissions:

  • Settings: Can access / edit organization settings

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this communication preference row.

Responses

Update Communication Preference Row

Update Communication Preference Row

Required permissions:

  • Settings: Can access / edit organization settings

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this communication preference row.

Request Body schema: application/json
name
required
string
description
string
active
boolean
editable
boolean
sms
boolean
email
boolean
phone
boolean
post
boolean
created_user
string
modified_user
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "active": true,
  • "editable": true,
  • "sms": true,
  • "email": true,
  • "phone": true,
  • "post": true,
  • "created_user": "string",
  • "modified_user": "string"
}

Partially update Communication Preference Row

Partially update Communication Preference Row

Required permissions:

  • Settings: Can access / edit organization settings

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this communication preference row.

Request Body schema: application/json
name
string
description
string
active
boolean
editable
boolean
sms
boolean
email
boolean
phone
boolean
post
boolean
created_user
string
modified_user
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "active": true,
  • "editable": true,
  • "sms": true,
  • "email": true,
  • "phone": true,
  • "post": true,
  • "created_user": "string",
  • "modified_user": "string"
}

Archive Communication Preference Row

Archive Communication Preference Row

Required permissions:

  • Settings: Can access / edit organization settings

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this communication preference row.

Responses

conditional_price_item_override

List ItemConditionalPriceOverride

List ItemConditionalPriceOverride

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Create new ItemConditionalPriceOverride

Create new ItemConditionalPriceOverride

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 300 requests per minute.

Request Body schema: application/json
rule
string
item
required
string
value
required
number
no_effect
boolean

Responses

Request samples

Content type
application/json
{
  • "rule": "string",
  • "item": "string",
  • "value": 0,
  • "no_effect": true
}

Get ItemConditionalPriceOverride by ID

Get ItemConditionalPriceOverride by ID

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this item conditional price override.

Responses

ItemConditionalPriceOverride

ItemConditionalPriceOverride

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this item conditional price override.

Responses

Consultations

Get Consultations

Get Consultations

Some filters require special values.

  • status:
    • ADMITTED = 0
    • DRAFT = 11
    • CONSULTATION = 8
    • WAITING_FOR_DISCHARGE = 5
    • DISCHARGED = 6
    • INVOICE_PAID = 9
    • FINALIZED = 10
  • type:
    • INPATIENT = 0
    • OUTPATIENT = 1
    • HOME_CALL = 2

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

ordering
string

Which field to use when ordering the results.

Responses

Create new Consultation

Create new Consultation

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

Request Body schema: application/json
client
required
string
patients
required
Array of strings
complaint
string
complaint_type
string
admitted_time
string
first_entry
string
started
string
finished
string
ended
string
status
string
type
required
string
invoice
required
string
supervising_veterinarian
required
string
department
required
string
consultation_items
required
Array of strings
reporting_dimension_1
string

Reporting dimension 1 id can be found on active Reporting dimension 1 list

reporting_dimension_2
string

Reporting dimension 2 id can be found on active Reporting dimension 2 list

consultation_notes
required
Array of strings
consultation_diagnosis
required
Array of strings
consultation_dischargeinstructions
required
Array of strings
consultation_patient_status
required
Array of strings
triage
required
string
external_sent
string
ward
required
string
patient_location
required
string
integration_status
integer
holding_place_number
required
Array of strings
report_to_authorities
boolean
custom_fields
required
string

Responses

Request samples

Content type
application/json
{
  • "client": "string",
  • "patients": [
    ],
  • "complaint": "string",
  • "complaint_type": "string",
  • "admitted_time": "string",
  • "first_entry": "string",
  • "started": "string",
  • "finished": "string",
  • "ended": "string",
  • "status": "string",
  • "type": "string",
  • "invoice": "string",
  • "supervising_veterinarian": "string",
  • "department": "string",
  • "consultation_items": [
    ],
  • "reporting_dimension_1": "string",
  • "reporting_dimension_2": "string",
  • "consultation_notes": [
    ],
  • "consultation_diagnosis": [
    ],
  • "consultation_dischargeinstructions": [
    ],
  • "consultation_patient_status": [
    ],
  • "triage": "string",
  • "external_sent": "string",
  • "ward": "string",
  • "patient_location": "string",
  • "integration_status": 0,
  • "holding_place_number": [
    ],
  • "report_to_authorities": true,
  • "custom_fields": "string"
}

ViewSet for creating/updating Consultations

ViewSet for creating/updating Consultations

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

Request Body schema: application/json
admitted_time
string
complaint
required
string
custom_fields
object
type
required
integer
department
required
string
complaint_type
string
go_after
string
client
required
string
patients
Array of strings
supervising_veterinarian
required
string
ward
string

Responses

Request samples

Content type
application/json
{
  • "admitted_time": "string",
  • "complaint": "string",
  • "custom_fields": { },
  • "type": 0,
  • "department": "string",
  • "complaint_type": "string",
  • "go_after": "string",
  • "client": "string",
  • "patients": [
    ],
  • "supervising_veterinarian": "string",
  • "ward": "string"
}

ViewSet for creating/updating Consultations

ViewSet for creating/updating Consultations

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this consultation.

Request Body schema: application/json
admitted_time
string
complaint
required
string
custom_fields
object
type
required
integer
department
required
string
complaint_type
string
go_after
string
client
required
string
patients
Array of strings
supervising_veterinarian
required
string
ward
string

Responses

Request samples

Content type
application/json
{
  • "admitted_time": "string",
  • "complaint": "string",
  • "custom_fields": { },
  • "type": 0,
  • "department": "string",
  • "complaint_type": "string",
  • "go_after": "string",
  • "client": "string",
  • "patients": [
    ],
  • "supervising_veterinarian": "string",
  • "ward": "string"
}

ViewSet for creating/updating Consultations

ViewSet for creating/updating Consultations

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this consultation.

Request Body schema: application/json
admitted_time
string
complaint
string
custom_fields
object
type
integer
department
string
complaint_type
string
go_after
string
client
string
patients
Array of strings
supervising_veterinarian
string
ward
string

Responses

Request samples

Content type
application/json
{
  • "admitted_time": "string",
  • "complaint": "string",
  • "custom_fields": { },
  • "type": 0,
  • "department": "string",
  • "complaint_type": "string",
  • "go_after": "string",
  • "client": "string",
  • "patients": [
    ],
  • "supervising_veterinarian": "string",
  • "ward": "string"
}

Get Consultation by ID

Get Consultation by ID

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this consultation.

query Parameters
ordering
string

Which field to use when ordering the results.

Responses

Consultation

Consultation

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this consultation.

query Parameters
ordering
string

Which field to use when ordering the results.

Request Body schema: application/json
client
required
string
patients
required
Array of strings
complaint
string
complaint_type
string
admitted_time
string
first_entry
string
started
string
finished
string
ended
string
status
string
type
required
string
invoice
required
string
supervising_veterinarian
required
string
department
required
string
consultation_items
required
Array of strings
reporting_dimension_1
string

Reporting dimension 1 id can be found on active Reporting dimension 1 list

reporting_dimension_2
string

Reporting dimension 2 id can be found on active Reporting dimension 2 list

consultation_notes
required
Array of strings
consultation_diagnosis
required
Array of strings
consultation_dischargeinstructions
required
Array of strings
consultation_patient_status
required
Array of strings
triage
required
string
external_sent
string
ward
required
string
patient_location
required
string
integration_status
integer
holding_place_number
required
Array of strings
report_to_authorities
boolean
custom_fields
required
string

Responses

Request samples

Content type
application/json
{
  • "client": "string",
  • "patients": [
    ],
  • "complaint": "string",
  • "complaint_type": "string",
  • "admitted_time": "string",
  • "first_entry": "string",
  • "started": "string",
  • "finished": "string",
  • "ended": "string",
  • "status": "string",
  • "type": "string",
  • "invoice": "string",
  • "supervising_veterinarian": "string",
  • "department": "string",
  • "consultation_items": [
    ],
  • "reporting_dimension_1": "string",
  • "reporting_dimension_2": "string",
  • "consultation_notes": [
    ],
  • "consultation_diagnosis": [
    ],
  • "consultation_dischargeinstructions": [
    ],
  • "consultation_patient_status": [
    ],
  • "triage": "string",
  • "external_sent": "string",
  • "ward": "string",
  • "patient_location": "string",
  • "integration_status": 0,
  • "holding_place_number": [
    ],
  • "report_to_authorities": true,
  • "custom_fields": "string"
}

Consultation

Consultation

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this consultation.

query Parameters
ordering
string

Which field to use when ordering the results.

Request Body schema: application/json
client
string
patients
Array of strings
complaint
string
complaint_type
string
admitted_time
string
first_entry
string
started
string
finished
string
ended
string
status
string
type
string
invoice
string
supervising_veterinarian
string
department
string
consultation_items
Array of strings
reporting_dimension_1
string

Reporting dimension 1 id can be found on active Reporting dimension 1 list

reporting_dimension_2
string

Reporting dimension 2 id can be found on active Reporting dimension 2 list

consultation_notes
Array of strings
consultation_diagnosis
Array of strings
consultation_dischargeinstructions
Array of strings
consultation_patient_status
Array of strings
triage
string
external_sent
string
ward
string
patient_location
string
integration_status
integer
holding_place_number
Array of strings
report_to_authorities
boolean
custom_fields
string

Responses

Request samples

Content type
application/json
{
  • "client": "string",
  • "patients": [
    ],
  • "complaint": "string",
  • "complaint_type": "string",
  • "admitted_time": "string",
  • "first_entry": "string",
  • "started": "string",
  • "finished": "string",
  • "ended": "string",
  • "status": "string",
  • "type": "string",
  • "invoice": "string",
  • "supervising_veterinarian": "string",
  • "department": "string",
  • "consultation_items": [
    ],
  • "reporting_dimension_1": "string",
  • "reporting_dimension_2": "string",
  • "consultation_notes": [
    ],
  • "consultation_diagnosis": [
    ],
  • "consultation_dischargeinstructions": [
    ],
  • "consultation_patient_status": [
    ],
  • "triage": "string",
  • "external_sent": "string",
  • "ward": "string",
  • "patient_location": "string",
  • "integration_status": 0,
  • "holding_place_number": [
    ],
  • "report_to_authorities": true,
  • "custom_fields": "string"
}

External sent timestamp

External sent timestamp

Allows setting timestamp for external sent field (default null/None) the API can filter consultations according to this field.

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 100 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this consultation.

Responses

External sent timestamp

External sent timestamp

Allows setting timestamp for external sent field (default null/None) the API can filter consultations according to this field.

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 100 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this consultation.

Request Body schema: application/json
external_sent
string

Responses

Request samples

Content type
application/json
{
  • "external_sent": "string"
}

External sent timestamp

External sent timestamp

Allows setting timestamp for external sent field (default null/None) the API can filter consultations according to this field.

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 100 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this consultation.

Request Body schema: application/json
external_sent
string

Responses

Request samples

Content type
application/json
{
  • "external_sent": "string"
}

External sent timestamp

External sent timestamp

Allows setting timestamp for external sent field (default null/None) the API can filter consultations according to this field.

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 100 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this consultation.

Request Body schema: application/json
external_sent
string

Responses

Request samples

Content type
application/json
{
  • "external_sent": "string"
}

Integration status

Integration status

Allows setting an integer value for integration status field (default null/None). The actual meaning for the value is defined by the external system.

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 100 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this consultation.

Responses

Integration status

Integration status

Allows setting an integer value for integration status field (default null/None). The actual meaning for the value is defined by the external system.

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 100 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this consultation.

Request Body schema: application/json
integration_status
integer

Responses

Request samples

Content type
application/json
{
  • "integration_status": 0
}

Integration status

Integration status

Allows setting an integer value for integration status field (default null/None). The actual meaning for the value is defined by the external system.

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 100 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this consultation.

Request Body schema: application/json
integration_status
integer

Responses

Request samples

Content type
application/json
{
  • "integration_status": 0
}

Integration status

Integration status

Allows setting an integer value for integration status field (default null/None). The actual meaning for the value is defined by the external system.

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 100 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this consultation.

Request Body schema: application/json
integration_status
integer

Responses

Request samples

Content type
application/json
{
  • "integration_status": 0
}

Allow updating status from "Arrived" -> "Consultation".

Allow updating status from "Arrived" -> "Consultation". Allow updating status to "Finalized". Do not allow updating status if Consultation is not editable.

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 100 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this consultation.

Request Body schema: application/json
status
required
integer

Responses

Request samples

Content type
application/json
{
  • "status": 0
}

List Analyses

List Analyses

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 150 requests per minute.

path Parameters
parent_lookup_consultation
required
string
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

ordering
string

Which field to use when ordering the results.

Responses

Create new Analysis

Create new Analysis

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_consultation
required
string
Request Body schema: application/json
quantity
number
price
number
price_with_vat
number
vat_percentage
number
used
string
is_dispense_fee_item
boolean
is_injection_fee_item
boolean
herd_size_multiplier
integer
result_numeric
number
result
string
result_entered
string
approved
boolean
approved_date
string
measurement_unit
string
device
string
remarks
string
order_in_panel
integer
description
string
calculate_additional_tax
boolean
result_code
string
item
required
string
created_user
string
modified_user
string
supervising_veterinarian
string
performed_by
string
consultation
required
string
patient
string
template
string
template_item
string
parent_linked_item
string
referral
required
string
panel
string
approved_by
string
sibling_items
Array of strings

Responses

Request samples

Content type
application/json
{
  • "quantity": 0,
  • "price": 0,
  • "price_with_vat": 0,
  • "vat_percentage": 0,
  • "used": "string",
  • "is_dispense_fee_item": true,
  • "is_injection_fee_item": true,
  • "herd_size_multiplier": 0,
  • "result_numeric": 0,
  • "result": "string",
  • "result_entered": "string",
  • "approved": true,
  • "approved_date": "string",
  • "measurement_unit": "string",
  • "device": "string",
  • "remarks": "string",
  • "order_in_panel": 0,
  • "description": "string",
  • "calculate_additional_tax": true,
  • "result_code": "string",
  • "item": "string",
  • "created_user": "string",
  • "modified_user": "string",
  • "supervising_veterinarian": "string",
  • "performed_by": "string",
  • "consultation": "string",
  • "patient": "string",
  • "template": "string",
  • "template_item": "string",
  • "parent_linked_item": "string",
  • "referral": "string",
  • "panel": "string",
  • "approved_by": "string",
  • "sibling_items": [
    ]
}

Get Analysis by ID

Get Analysis by ID

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 600 requests per minute.

path Parameters
parent_lookup_consultation
required
string
id
required
integer

A unique integer value identifying this consultation laboratory analysis.

query Parameters
ordering
string

Which field to use when ordering the results.

Responses

Update Analysis

Update Analysis

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_consultation
required
string
id
required
integer

A unique integer value identifying this consultation laboratory analysis.

query Parameters
ordering
string

Which field to use when ordering the results.

Request Body schema: application/json
quantity
number
price
number
price_with_vat
number
vat_percentage
number
used
string
is_dispense_fee_item
boolean
is_injection_fee_item
boolean
herd_size_multiplier
integer
result_numeric
number
result
string
result_entered
string
approved
boolean
approved_date
string
measurement_unit
string
device
string
remarks
string
order_in_panel
integer
description
string
calculate_additional_tax
boolean
result_code
string
item
required
string
created_user
string
modified_user
string
supervising_veterinarian
string
performed_by
string
consultation
required
string
patient
string
template
string
template_item
string
parent_linked_item
string
referral
required
string
panel
string
approved_by
string
sibling_items
Array of strings

Responses

Request samples

Content type
application/json
{
  • "quantity": 0,
  • "price": 0,
  • "price_with_vat": 0,
  • "vat_percentage": 0,
  • "used": "string",
  • "is_dispense_fee_item": true,
  • "is_injection_fee_item": true,
  • "herd_size_multiplier": 0,
  • "result_numeric": 0,
  • "result": "string",
  • "result_entered": "string",
  • "approved": true,
  • "approved_date": "string",
  • "measurement_unit": "string",
  • "device": "string",
  • "remarks": "string",
  • "order_in_panel": 0,
  • "description": "string",
  • "calculate_additional_tax": true,
  • "result_code": "string",
  • "item": "string",
  • "created_user": "string",
  • "modified_user": "string",
  • "supervising_veterinarian": "string",
  • "performed_by": "string",
  • "consultation": "string",
  • "patient": "string",
  • "template": "string",
  • "template_item": "string",
  • "parent_linked_item": "string",
  • "referral": "string",
  • "panel": "string",
  • "approved_by": "string",
  • "sibling_items": [
    ]
}

Partially update Analysis

Partially update Analysis

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_consultation
required
string
id
required
integer

A unique integer value identifying this consultation laboratory analysis.

query Parameters
ordering
string

Which field to use when ordering the results.

Request Body schema: application/json
quantity
number
price
number
price_with_vat
number
vat_percentage
number
used
string
is_dispense_fee_item
boolean
is_injection_fee_item
boolean
herd_size_multiplier
integer
result_numeric
number
result
string
result_entered
string
approved
boolean
approved_date
string
measurement_unit
string
device
string
remarks
string
order_in_panel
integer
description
string
calculate_additional_tax
boolean
result_code
string
item
string
created_user
string
modified_user
string
supervising_veterinarian
string
performed_by
string
consultation
string
patient
string
template
string
template_item
string
parent_linked_item
string
referral
string
panel
string
approved_by
string
sibling_items
Array of strings

Responses

Request samples

Content type
application/json
{
  • "quantity": 0,
  • "price": 0,
  • "price_with_vat": 0,
  • "vat_percentage": 0,
  • "used": "string",
  • "is_dispense_fee_item": true,
  • "is_injection_fee_item": true,
  • "herd_size_multiplier": 0,
  • "result_numeric": 0,
  • "result": "string",
  • "result_entered": "string",
  • "approved": true,
  • "approved_date": "string",
  • "measurement_unit": "string",
  • "device": "string",
  • "remarks": "string",
  • "order_in_panel": 0,
  • "description": "string",
  • "calculate_additional_tax": true,
  • "result_code": "string",
  • "item": "string",
  • "created_user": "string",
  • "modified_user": "string",
  • "supervising_veterinarian": "string",
  • "performed_by": "string",
  • "consultation": "string",
  • "patient": "string",
  • "template": "string",
  • "template_item": "string",
  • "parent_linked_item": "string",
  • "referral": "string",
  • "panel": "string",
  • "approved_by": "string",
  • "sibling_items": [
    ]
}

Delete Analysis

Delete Analysis

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_consultation
required
string
id
required
integer

A unique integer value identifying this consultation laboratory analysis.

query Parameters
ordering
string

Which field to use when ordering the results.

Responses

Consultation PetMedData schema

Consultation PetMedData schema

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 100 requests per minute.

path Parameters
parent_lookup_consultation
required
string
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

List Diagnoses

List Diagnoses

Category values:

  • CATEGORY_PRIMARY = 0
  • CATEGORY_SECONDARY = 1 Type values:
  • TYPE_DIFFERENTIAL = 0
  • TYPE_FINAL = 1

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 100 requests per minute.

path Parameters
parent_lookup_consultation
required
string
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Create new Diagnosis

Create new Diagnosis

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_consultation
required
string
Request Body schema: application/json
consultation
required
string
patient
required
string
diagnosis
required
string
category
string
type
string
code
required
string
name
required
string
description
string
date
string
created_user
string
modified_user
string
supervising_veterinarian
string

Responses

Request samples

Content type
application/json
{
  • "consultation": "string",
  • "patient": "string",
  • "diagnosis": "string",
  • "category": "string",
  • "type": "string",
  • "code": "string",
  • "name": "string",
  • "description": "string",
  • "date": "string",
  • "created_user": "string",
  • "modified_user": "string",
  • "supervising_veterinarian": "string"
}

Get Diagnosis by ID

Get Diagnosis by ID

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_consultation
required
string
id
required
integer

A unique integer value identifying this consultation diagnosis.

Responses

Update Diagnosis

Update Diagnosis

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_consultation
required
string
id
required
integer

A unique integer value identifying this consultation diagnosis.

Request Body schema: application/json
consultation
required
string
patient
required
string
diagnosis
required
string
category
string
type
string
code
required
string
name
required
string
description
string
date
string
created_user
string
modified_user
string
supervising_veterinarian
string

Responses

Request samples

Content type
application/json
{
  • "consultation": "string",
  • "patient": "string",
  • "diagnosis": "string",
  • "category": "string",
  • "type": "string",
  • "code": "string",
  • "name": "string",
  • "description": "string",
  • "date": "string",
  • "created_user": "string",
  • "modified_user": "string",
  • "supervising_veterinarian": "string"
}

Partially update Diagnosis

Partially update Diagnosis

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_consultation
required
string
id
required
integer

A unique integer value identifying this consultation diagnosis.

Request Body schema: application/json
consultation
string
patient
string
diagnosis
string
category
string
type
string
code
string
name
string
description
string
date
string
created_user
string
modified_user
string
supervising_veterinarian
string

Responses

Request samples

Content type
application/json
{
  • "consultation": "string",
  • "patient": "string",
  • "diagnosis": "string",
  • "category": "string",
  • "type": "string",
  • "code": "string",
  • "name": "string",
  • "description": "string",
  • "date": "string",
  • "created_user": "string",
  • "modified_user": "string",
  • "supervising_veterinarian": "string"
}

Archive Diagnosis

Archive Diagnosis

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_consultation
required
string
id
required
integer

A unique integer value identifying this consultation diagnosis.

Responses

List Discharge Instructions

List Discharge Instructions

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 100 requests per minute.

path Parameters
parent_lookup_consultation
required
string
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Create new Discharge Instruction

Create new Discharge Instruction

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_consultation
required
string
Request Body schema: application/json
consultation
required
string
patient
string
text
string
created_user
string
modified_user
string
modified_session
string
printed_at
string

Responses

Request samples

Content type
application/json
{
  • "consultation": "string",
  • "patient": "string",
  • "text": "string",
  • "created_user": "string",
  • "modified_user": "string",
  • "modified_session": "string",
  • "printed_at": "string"
}

Get Discharge Instruction by ID

Get Discharge Instruction by ID

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_consultation
required
string
id
required
integer

A unique integer value identifying this consultation dischargeinstruction.

Responses

Update Discharge Instruction

Update Discharge Instruction

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_consultation
required
string
id
required
integer

A unique integer value identifying this consultation dischargeinstruction.

Request Body schema: application/json
consultation
required
string
patient
string
text
string
created_user
string
modified_user
string
modified_session
string
printed_at
string

Responses

Request samples

Content type
application/json
{
  • "consultation": "string",
  • "patient": "string",
  • "text": "string",
  • "created_user": "string",
  • "modified_user": "string",
  • "modified_session": "string",
  • "printed_at": "string"
}

Partially update Discharge Instruction

Partially update Discharge Instruction

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_consultation
required
string
id
required
integer

A unique integer value identifying this consultation dischargeinstruction.

Request Body schema: application/json
consultation
string
patient
string
text
string
created_user
string
modified_user
string
modified_session
string
printed_at
string

Responses

Request samples

Content type
application/json
{
  • "consultation": "string",
  • "patient": "string",
  • "text": "string",
  • "created_user": "string",
  • "modified_user": "string",
  • "modified_session": "string",
  • "printed_at": "string"
}

Archive Discharge Instruction

Archive Discharge Instruction

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_consultation
required
string
id
required
integer

A unique integer value identifying this consultation dischargeinstruction.

Responses

List Clinical Notes

List Clinical Notes

Type values:

  • CLINICAL_NOTE = 0
  • ANAMNESIS = 1
  • PRELIMINARY_NOTE = 2

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 100 requests per minute.

path Parameters
parent_lookup_consultation
required
string
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Create new Clinical Note

Create new Clinical Note

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_consultation
required
string
Request Body schema: application/json
consultation
required
string
patient
string
text
string
type
required
string
date_added
string
draft
boolean
approved
boolean
approved_date
string
approved_user
string
created_user
string
modified_user
string
modified_session
string
patient_group
string
specified_patients
Array of strings

Responses

Request samples

Content type
application/json
{
  • "consultation": "string",
  • "patient": "string",
  • "text": "string",
  • "type": "string",
  • "date_added": "string",
  • "draft": true,
  • "approved": true,
  • "approved_date": "string",
  • "approved_user": "string",
  • "created_user": "string",
  • "modified_user": "string",
  • "modified_session": "string",
  • "patient_group": "string",
  • "specified_patients": [
    ]
}

Get Clinical Note by ID

Get Clinical Note by ID

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_consultation
required
string
id
required
integer

A unique integer value identifying this consultation note.

Responses

Update Clinical Note

Update Clinical Note

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_consultation
required
string
id
required
integer

A unique integer value identifying this consultation note.

Request Body schema: application/json
consultation
required
string
patient
string
text
string
type
required
string
date_added
string
draft
boolean
approved
boolean
approved_date
string
approved_user
string
created_user
string
modified_user
string
modified_session
string
patient_group
string
specified_patients
Array of strings

Responses

Request samples

Content type
application/json
{
  • "consultation": "string",
  • "patient": "string",
  • "text": "string",
  • "type": "string",
  • "date_added": "string",
  • "draft": true,
  • "approved": true,
  • "approved_date": "string",
  • "approved_user": "string",
  • "created_user": "string",
  • "modified_user": "string",
  • "modified_session": "string",
  • "patient_group": "string",
  • "specified_patients": [
    ]
}

Partially update Clinical Note

Partially update Clinical Note

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_consultation
required
string
id
required
integer

A unique integer value identifying this consultation note.

Request Body schema: application/json
consultation
string
patient
string
text
string
type
string
date_added
string
draft
boolean
approved
boolean
approved_date
string
approved_user
string
created_user
string
modified_user
string
modified_session
string
patient_group
string
specified_patients
Array of strings

Responses

Request samples

Content type
application/json
{
  • "consultation": "string",
  • "patient": "string",
  • "text": "string",
  • "type": "string",
  • "date_added": "string",
  • "draft": true,
  • "approved": true,
  • "approved_date": "string",
  • "approved_user": "string",
  • "created_user": "string",
  • "modified_user": "string",
  • "modified_session": "string",
  • "patient_group": "string",
  • "specified_patients": [
    ]
}

Archive Clinical Note

Archive Clinical Note

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_consultation
required
string
id
required
integer

A unique integer value identifying this consultation note.

Responses

List Patient Status

List Patient Status

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 100 requests per minute.

path Parameters
parent_lookup_consultation
required
string
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Create new Patient Status

Create new Patient Status

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_consultation
required
string
Request Body schema: application/json
consultation
required
string
patient
required
string
date_added
required
string
text
string
weight
required
string
temperature
required
string
heart_rate
required
string
respiratory_rate
required
string
peripheral_oxygen_saturation
required
string
status_1
string
status_2
string
status_3
string
status_4
string
status_5
string
status_6
string
status_7
string
status_8
string
status_9
string
status_10
string
status_11
string
status_12
string
created_user
string
modified_user
string

Responses

Request samples

Content type
application/json
{
  • "consultation": "string",
  • "patient": "string",
  • "date_added": "string",
  • "text": "string",
  • "weight": "string",
  • "temperature": "string",
  • "heart_rate": "string",
  • "respiratory_rate": "string",
  • "peripheral_oxygen_saturation": "string",
  • "status_1": "string",
  • "status_2": "string",
  • "status_3": "string",
  • "status_4": "string",
  • "status_5": "string",
  • "status_6": "string",
  • "status_7": "string",
  • "status_8": "string",
  • "status_9": "string",
  • "status_10": "string",
  • "status_11": "string",
  • "status_12": "string",
  • "created_user": "string",
  • "modified_user": "string"
}

Get Patient Status by ID

Get Patient Status by ID

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_consultation
required
string
id
required
integer

A unique integer value identifying this consultation patient status.

Responses

Update Patient Status

Update Patient Status

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_consultation
required
string
id
required
integer

A unique integer value identifying this consultation patient status.

Request Body schema: application/json
consultation
required
string
patient
required
string
date_added
required
string
text
string
weight
required
string
temperature
required
string
heart_rate
required
string
respiratory_rate
required
string
peripheral_oxygen_saturation
required
string
status_1
string
status_2
string
status_3
string
status_4
string
status_5
string
status_6
string
status_7
string
status_8
string
status_9
string
status_10
string
status_11
string
status_12
string
created_user
string
modified_user
string

Responses

Request samples

Content type
application/json
{
  • "consultation": "string",
  • "patient": "string",
  • "date_added": "string",
  • "text": "string",
  • "weight": "string",
  • "temperature": "string",
  • "heart_rate": "string",
  • "respiratory_rate": "string",
  • "peripheral_oxygen_saturation": "string",
  • "status_1": "string",
  • "status_2": "string",
  • "status_3": "string",
  • "status_4": "string",
  • "status_5": "string",
  • "status_6": "string",
  • "status_7": "string",
  • "status_8": "string",
  • "status_9": "string",
  • "status_10": "string",
  • "status_11": "string",
  • "status_12": "string",
  • "created_user": "string",
  • "modified_user": "string"
}

Partially update Patient Status

Partially update Patient Status

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_consultation
required
string
id
required
integer

A unique integer value identifying this consultation patient status.

Request Body schema: application/json
consultation
string
patient
string
date_added
string
text
string
weight
string
temperature
string
heart_rate
string
respiratory_rate
string
peripheral_oxygen_saturation
string
status_1
string
status_2
string
status_3
string
status_4
string
status_5
string
status_6
string
status_7
string
status_8
string
status_9
string
status_10
string
status_11
string
status_12
string
created_user
string
modified_user
string

Responses

Request samples

Content type
application/json
{
  • "consultation": "string",
  • "patient": "string",
  • "date_added": "string",
  • "text": "string",
  • "weight": "string",
  • "temperature": "string",
  • "heart_rate": "string",
  • "respiratory_rate": "string",
  • "peripheral_oxygen_saturation": "string",
  • "status_1": "string",
  • "status_2": "string",
  • "status_3": "string",
  • "status_4": "string",
  • "status_5": "string",
  • "status_6": "string",
  • "status_7": "string",
  • "status_8": "string",
  • "status_9": "string",
  • "status_10": "string",
  • "status_11": "string",
  • "status_12": "string",
  • "created_user": "string",
  • "modified_user": "string"
}

Archive Patient Status

Archive Patient Status

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_consultation
required
string
id
required
integer

A unique integer value identifying this consultation patient status.

Responses

List Extras

List Extras

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 100 requests per minute.

path Parameters
parent_lookup_consultation
required
string
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Create new Extra

Create new Extra

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_consultation
required
string
Request Body schema: application/json
exported
string
export_status
integer
imported
string
import_status
integer
discharge_time
string

Responses

Request samples

Content type
application/json
{
  • "exported": "string",
  • "export_status": 0,
  • "imported": "string",
  • "import_status": 0,
  • "discharge_time": "string"
}

Get Extra by ID

Get Extra by ID

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_consultation
required
string
id
required
integer

A unique integer value identifying this consultation extras.

Responses

Update Extra

Update Extra

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_consultation
required
string
id
required
integer

A unique integer value identifying this consultation extras.

Request Body schema: application/json
exported
string
export_status
integer
imported
string
import_status
integer
discharge_time
string

Responses

Request samples

Content type
application/json
{
  • "exported": "string",
  • "export_status": 0,
  • "imported": "string",
  • "import_status": 0,
  • "discharge_time": "string"
}

Partially update Extra

Partially update Extra

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_consultation
required
string
id
required
integer

A unique integer value identifying this consultation extras.

Request Body schema: application/json
exported
string
export_status
integer
imported
string
import_status
integer
discharge_time
string

Responses

Request samples

Content type
application/json
{
  • "exported": "string",
  • "export_status": 0,
  • "imported": "string",
  • "import_status": 0,
  • "discharge_time": "string"
}

Archive Extra

Archive Extra

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_consultation
required
string
id
required
integer

A unique integer value identifying this consultation extras.

Responses

List Foods

List Foods

Required permissions:

  • Settings: Can access / edit items
  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 100 requests per minute.

path Parameters
parent_lookup_consultation
required
string
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

no_multiplier
boolean

Responses

Create new Food

Create new Food

Required permissions:

  • Settings: Can access / edit items
  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_consultation
required
string
query Parameters
no_multiplier
boolean
Request Body schema: application/json
quantity
number
price
number
price_with_vat
number
vat_percentage
number
used
string
is_dispense_fee_item
boolean
is_injection_fee_item
boolean
herd_size_multiplier
integer
usage_type
string
instructions
string
units
number
unit
string
package_description
string
usage_size
string
dosage_units
number
item
required
string
created_user
string
modified_user
string
supervising_veterinarian
string
performed_by
string
consultation
required
string
patient
string
template
string
template_item
string
parent_linked_item
string
sibling_items
Array of strings

Responses

Request samples

Content type
application/json
{
  • "quantity": 0,
  • "price": 0,
  • "price_with_vat": 0,
  • "vat_percentage": 0,
  • "used": "string",
  • "is_dispense_fee_item": true,
  • "is_injection_fee_item": true,
  • "herd_size_multiplier": 0,
  • "usage_type": "string",
  • "instructions": "string",
  • "units": 0,
  • "unit": "string",
  • "package_description": "string",
  • "usage_size": "string",
  • "dosage_units": 0,
  • "item": "string",
  • "created_user": "string",
  • "modified_user": "string",
  • "supervising_veterinarian": "string",
  • "performed_by": "string",
  • "consultation": "string",
  • "patient": "string",
  • "template": "string",
  • "template_item": "string",
  • "parent_linked_item": "string",
  • "sibling_items": [
    ]
}

Get Food by ID

Get Food by ID

Required permissions:

  • Settings: Can access / edit items
  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_consultation
required
string
id
required
integer

A unique integer value identifying this consultation food.

query Parameters
no_multiplier
boolean

Responses

Update Food

Update Food

Required permissions:

  • Settings: Can access / edit items
  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_consultation
required
string
id
required
integer

A unique integer value identifying this consultation food.

query Parameters
no_multiplier
boolean
Request Body schema: application/json
quantity
number
price
number
price_with_vat
number
vat_percentage
number
used
string
is_dispense_fee_item
boolean
is_injection_fee_item
boolean
herd_size_multiplier
integer
usage_type
string
instructions
string
units
number
unit
string
package_description
string
usage_size
string
dosage_units
number
item
required
string
created_user
string
modified_user
string
supervising_veterinarian
string
performed_by
string
consultation
required
string
patient
string
template
string
template_item
string
parent_linked_item
string
sibling_items
Array of strings

Responses

Request samples

Content type
application/json
{
  • "quantity": 0,
  • "price": 0,
  • "price_with_vat": 0,
  • "vat_percentage": 0,
  • "used": "string",
  • "is_dispense_fee_item": true,
  • "is_injection_fee_item": true,
  • "herd_size_multiplier": 0,
  • "usage_type": "string",
  • "instructions": "string",
  • "units": 0,
  • "unit": "string",
  • "package_description": "string",
  • "usage_size": "string",
  • "dosage_units": 0,
  • "item": "string",
  • "created_user": "string",
  • "modified_user": "string",
  • "supervising_veterinarian": "string",
  • "performed_by": "string",
  • "consultation": "string",
  • "patient": "string",
  • "template": "string",
  • "template_item": "string",
  • "parent_linked_item": "string",
  • "sibling_items": [
    ]
}

Partially update Food

Partially update Food

Required permissions:

  • Settings: Can access / edit items
  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_consultation
required
string
id
required
integer

A unique integer value identifying this consultation food.

query Parameters
no_multiplier
boolean
Request Body schema: application/json
quantity
number
price
number
price_with_vat
number
vat_percentage
number
used
string
is_dispense_fee_item
boolean
is_injection_fee_item
boolean
herd_size_multiplier
integer
usage_type
string
instructions
string
units
number
unit
string
package_description
string
usage_size
string
dosage_units
number
item
string
created_user
string
modified_user
string
supervising_veterinarian
string
performed_by
string
consultation
string
patient
string
template
string
template_item
string
parent_linked_item
string
sibling_items
Array of strings

Responses

Request samples

Content type
application/json
{
  • "quantity": 0,
  • "price": 0,
  • "price_with_vat": 0,
  • "vat_percentage": 0,
  • "used": "string",
  • "is_dispense_fee_item": true,
  • "is_injection_fee_item": true,
  • "herd_size_multiplier": 0,
  • "usage_type": "string",
  • "instructions": "string",
  • "units": 0,
  • "unit": "string",
  • "package_description": "string",
  • "usage_size": "string",
  • "dosage_units": 0,
  • "item": "string",
  • "created_user": "string",
  • "modified_user": "string",
  • "supervising_veterinarian": "string",
  • "performed_by": "string",
  • "consultation": "string",
  • "patient": "string",
  • "template": "string",
  • "template_item": "string",
  • "parent_linked_item": "string",
  • "sibling_items": [
    ]
}

Archive Food

Archive Food

Required permissions:

  • Settings: Can access / edit items
  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_consultation
required
string
id
required
integer

A unique integer value identifying this consultation food.

query Parameters
no_multiplier
boolean

Responses

List Medicine

List Medicine

Required permissions:

  • Settings: Can access / edit items
  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 100 requests per minute.

path Parameters
parent_lookup_consultation
required
string
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

no_multiplier
boolean

Responses

Create new Medicine

Create new Medicine

Required permissions:

  • Settings: Can access / edit items
  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_consultation
required
string
query Parameters
no_multiplier
boolean
Request Body schema: application/json
numeric_withdrawal_periods
Array of strings
vaccination_disease
string
quantity
number
price
number
price_with_vat
number
vat_percentage
number
used
string
is_dispense_fee_item
boolean
is_injection_fee_item
boolean
herd_size_multiplier
integer
administration_method
string
administration_speed
number
administration_hours
number
usage_type
string
active_substance
string
controlled_substance
boolean
vaccination
boolean
vaccination_type
string
contraindications
string
preparation
string
manufacturer_data
string
instructions
string
units
number
unit
string
package_description
string
dosage_units
number
usage_size
string
withdrawal_periods
string
measurement_loss_quantity
number
measurement_loss_units
number
dispense_fee
number
injection_fee
number
dispense_fee_with_vat
number
injection_fee_with_vat
number
use_default_dispense_fee
boolean
not_for_food
boolean
use_dispense_fee
boolean
effect_time
integer
medication_duration_days
integer
item
required
string
created_user
string
modified_user
string
supervising_veterinarian
string
performed_by
string
consultation
required
string
patient
string
template
string
template_item
string
parent_linked_item
string
medication_diagnosis
string
sibling_items
Array of strings

Responses

Request samples

Content type
application/json
{
  • "numeric_withdrawal_periods": [
    ],
  • "vaccination_disease": "string",
  • "quantity": 0,
  • "price": 0,
  • "price_with_vat": 0,
  • "vat_percentage": 0,
  • "used": "string",
  • "is_dispense_fee_item": true,
  • "is_injection_fee_item": true,
  • "herd_size_multiplier": 0,
  • "administration_method": "string",
  • "administration_speed": 0,
  • "administration_hours": 0,
  • "usage_type": "string",
  • "active_substance": "string",
  • "controlled_substance": true,
  • "vaccination": true,
  • "vaccination_type": "string",
  • "contraindications": "string",
  • "preparation": "string",
  • "manufacturer_data": "string",
  • "instructions": "string",
  • "units": 0,
  • "unit": "string",
  • "package_description": "string",
  • "dosage_units": 0,
  • "usage_size": "string",
  • "withdrawal_periods": "string",
  • "measurement_loss_quantity": 0,
  • "measurement_loss_units": 0,
  • "dispense_fee": 0,
  • "injection_fee": 0,
  • "dispense_fee_with_vat": 0,
  • "injection_fee_with_vat": 0,
  • "use_default_dispense_fee": true,
  • "not_for_food": true,
  • "use_dispense_fee": true,
  • "effect_time": 0,
  • "medication_duration_days": 0,
  • "item": "string",
  • "created_user": "string",
  • "modified_user": "string",
  • "supervising_veterinarian": "string",
  • "performed_by": "string",
  • "consultation": "string",
  • "patient": "string",
  • "template": "string",
  • "template_item": "string",
  • "parent_linked_item": "string",
  • "medication_diagnosis": "string",
  • "sibling_items": [
    ]
}

Get Medicine by ID

Get Medicine by ID

Required permissions:

  • Settings: Can access / edit items
  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_consultation
required
string
id
required
integer

A unique integer value identifying this consultation medicine.

query Parameters
no_multiplier
boolean

Responses

Update Medicine

Update Medicine

Required permissions:

  • Settings: Can access / edit items
  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_consultation
required
string
id
required
integer

A unique integer value identifying this consultation medicine.

query Parameters
no_multiplier
boolean
Request Body schema: application/json
numeric_withdrawal_periods
Array of strings
vaccination_disease
string
quantity
number
price
number
price_with_vat
number
vat_percentage
number
used
string
is_dispense_fee_item
boolean
is_injection_fee_item
boolean
herd_size_multiplier
integer
administration_method
string
administration_speed
number
administration_hours
number
usage_type
string
active_substance
string
controlled_substance
boolean
vaccination
boolean
vaccination_type
string
contraindications
string
preparation
string
manufacturer_data
string
instructions
string
units
number
unit
string
package_description
string
dosage_units
number
usage_size
string
withdrawal_periods
string
measurement_loss_quantity
number
measurement_loss_units
number
dispense_fee
number
injection_fee
number
dispense_fee_with_vat
number
injection_fee_with_vat
number
use_default_dispense_fee
boolean
not_for_food
boolean
use_dispense_fee
boolean
effect_time
integer
medication_duration_days
integer
item
required
string
created_user
string
modified_user
string
supervising_veterinarian
string
performed_by
string
consultation
required
string
patient
string
template
string
template_item
string
parent_linked_item
string
medication_diagnosis
string
sibling_items
Array of strings

Responses

Request samples

Content type
application/json
{
  • "numeric_withdrawal_periods": [
    ],
  • "vaccination_disease": "string",
  • "quantity": 0,
  • "price": 0,
  • "price_with_vat": 0,
  • "vat_percentage": 0,
  • "used": "string",
  • "is_dispense_fee_item": true,
  • "is_injection_fee_item": true,
  • "herd_size_multiplier": 0,
  • "administration_method": "string",
  • "administration_speed": 0,
  • "administration_hours": 0,
  • "usage_type": "string",
  • "active_substance": "string",
  • "controlled_substance": true,
  • "vaccination": true,
  • "vaccination_type": "string",
  • "contraindications": "string",
  • "preparation": "string",
  • "manufacturer_data": "string",
  • "instructions": "string",
  • "units": 0,
  • "unit": "string",
  • "package_description": "string",
  • "dosage_units": 0,
  • "usage_size": "string",
  • "withdrawal_periods": "string",
  • "measurement_loss_quantity": 0,
  • "measurement_loss_units": 0,
  • "dispense_fee": 0,
  • "injection_fee": 0,
  • "dispense_fee_with_vat": 0,
  • "injection_fee_with_vat": 0,
  • "use_default_dispense_fee": true,
  • "not_for_food": true,
  • "use_dispense_fee": true,
  • "effect_time": 0,
  • "medication_duration_days": 0,
  • "item": "string",
  • "created_user": "string",
  • "modified_user": "string",
  • "supervising_veterinarian": "string",
  • "performed_by": "string",
  • "consultation": "string",
  • "patient": "string",
  • "template": "string",
  • "template_item": "string",
  • "parent_linked_item": "string",
  • "medication_diagnosis": "string",
  • "sibling_items": [
    ]
}

Partially update Medicine

Partially update Medicine

Required permissions:

  • Settings: Can access / edit items
  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_consultation
required
string
id
required
integer

A unique integer value identifying this consultation medicine.

query Parameters
no_multiplier
boolean
Request Body schema: application/json
numeric_withdrawal_periods
Array of strings
vaccination_disease
string
quantity
number
price
number
price_with_vat
number
vat_percentage
number
used
string
is_dispense_fee_item
boolean
is_injection_fee_item
boolean
herd_size_multiplier
integer
administration_method
string
administration_speed
number
administration_hours
number
usage_type
string
active_substance
string
controlled_substance
boolean
vaccination
boolean
vaccination_type
string
contraindications
string
preparation
string
manufacturer_data
string
instructions
string
units
number
unit
string
package_description
string
dosage_units
number
usage_size
string
withdrawal_periods
string
measurement_loss_quantity
number
measurement_loss_units
number
dispense_fee
number
injection_fee
number
dispense_fee_with_vat
number
injection_fee_with_vat
number
use_default_dispense_fee
boolean
not_for_food
boolean
use_dispense_fee
boolean
effect_time
integer
medication_duration_days
integer
item
string
created_user
string
modified_user
string
supervising_veterinarian
string
performed_by
string
consultation
string
patient
string
template
string
template_item
string
parent_linked_item
string
medication_diagnosis
string
sibling_items
Array of strings

Responses

Request samples

Content type
application/json
{
  • "numeric_withdrawal_periods": [
    ],
  • "vaccination_disease": "string",
  • "quantity": 0,
  • "price": 0,
  • "price_with_vat": 0,
  • "vat_percentage": 0,
  • "used": "string",
  • "is_dispense_fee_item": true,
  • "is_injection_fee_item": true,
  • "herd_size_multiplier": 0,
  • "administration_method": "string",
  • "administration_speed": 0,
  • "administration_hours": 0,
  • "usage_type": "string",
  • "active_substance": "string",
  • "controlled_substance": true,
  • "vaccination": true,
  • "vaccination_type": "string",
  • "contraindications": "string",
  • "preparation": "string",
  • "manufacturer_data": "string",
  • "instructions": "string",
  • "units": 0,
  • "unit": "string",
  • "package_description": "string",
  • "dosage_units": 0,
  • "usage_size": "string",
  • "withdrawal_periods": "string",
  • "measurement_loss_quantity": 0,
  • "measurement_loss_units": 0,
  • "dispense_fee": 0,
  • "injection_fee": 0,
  • "dispense_fee_with_vat": 0,
  • "injection_fee_with_vat": 0,
  • "use_default_dispense_fee": true,
  • "not_for_food": true,
  • "use_dispense_fee": true,
  • "effect_time": 0,
  • "medication_duration_days": 0,
  • "item": "string",
  • "created_user": "string",
  • "modified_user": "string",
  • "supervising_veterinarian": "string",
  • "performed_by": "string",
  • "consultation": "string",
  • "patient": "string",
  • "template": "string",
  • "template_item": "string",
  • "parent_linked_item": "string",
  • "medication_diagnosis": "string",
  • "sibling_items": [
    ]
}

Archive Medicine

Archive Medicine

Required permissions:

  • Settings: Can access / edit items
  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_consultation
required
string
id
required
integer

A unique integer value identifying this consultation medicine.

query Parameters
no_multiplier
boolean

Responses

Delete withdrawal period related to consultation item

Delete withdrawal period related to consultation item

Required permissions:

  • Settings: Can access / edit items
  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 100 requests per minute.

path Parameters
parent_lookup_consultation
required
string
id
required
integer

A unique integer value identifying this consultation medicine.

query Parameters
no_multiplier
boolean
Request Body schema: application/json
numeric_withdrawal_periods
Array of strings
vaccination_disease
string
quantity
number
price
number
price_with_vat
number
vat_percentage
number
used
string
is_dispense_fee_item
boolean
is_injection_fee_item
boolean
herd_size_multiplier
integer
administration_method
string
administration_speed
number
administration_hours
number
usage_type
string
active_substance
string
controlled_substance
boolean
vaccination
boolean
vaccination_type
string
contraindications
string
preparation
string
manufacturer_data
string
instructions
string
units
number
unit
string
package_description
string
dosage_units
number
usage_size
string
withdrawal_periods
string
measurement_loss_quantity
number
measurement_loss_units
number
dispense_fee
number
injection_fee
number
dispense_fee_with_vat
number
injection_fee_with_vat
number
use_default_dispense_fee
boolean
not_for_food
boolean
use_dispense_fee
boolean
effect_time
integer
medication_duration_days
integer
item
required
string
created_user
string
modified_user
string
supervising_veterinarian
string
performed_by
string
consultation
required
string
patient
string
template
string
template_item
string
parent_linked_item
string
medication_diagnosis
string
sibling_items
Array of strings

Responses

Request samples

Content type
application/json
{
  • "numeric_withdrawal_periods": [
    ],
  • "vaccination_disease": "string",
  • "quantity": 0,
  • "price": 0,
  • "price_with_vat": 0,
  • "vat_percentage": 0,
  • "used": "string",
  • "is_dispense_fee_item": true,
  • "is_injection_fee_item": true,
  • "herd_size_multiplier": 0,
  • "administration_method": "string",
  • "administration_speed": 0,
  • "administration_hours": 0,
  • "usage_type": "string",
  • "active_substance": "string",
  • "controlled_substance": true,
  • "vaccination": true,
  • "vaccination_type": "string",
  • "contraindications": "string",
  • "preparation": "string",
  • "manufacturer_data": "string",
  • "instructions": "string",
  • "units": 0,
  • "unit": "string",
  • "package_description": "string",
  • "dosage_units": 0,
  • "usage_size": "string",
  • "withdrawal_periods": "string",
  • "measurement_loss_quantity": 0,
  • "measurement_loss_units": 0,
  • "dispense_fee": 0,
  • "injection_fee": 0,
  • "dispense_fee_with_vat": 0,
  • "injection_fee_with_vat": 0,
  • "use_default_dispense_fee": true,
  • "not_for_food": true,
  • "use_dispense_fee": true,
  • "effect_time": 0,
  • "medication_duration_days": 0,
  • "item": "string",
  • "created_user": "string",
  • "modified_user": "string",
  • "supervising_veterinarian": "string",
  • "performed_by": "string",
  • "consultation": "string",
  • "patient": "string",
  • "template": "string",
  • "template_item": "string",
  • "parent_linked_item": "string",
  • "medication_diagnosis": "string",
  • "sibling_items": [
    ]
}

Required permissions:

Required permissions:

  • General: Can access / edit patients and clients
  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 100 requests per minute.

path Parameters
parent_lookup_consultation
required
string
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Required permissions:

Required permissions:

  • General: Can access / edit patients and clients
  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_consultation
required
string
id
required
integer

A unique integer value identifying this consultation patient group.

Responses

List Procedures

List Procedures

Required permissions:

  • Settings: Can access / edit items
  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 100 requests per minute.

path Parameters
parent_lookup_consultation
required
string
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

no_multiplier
boolean

Responses

Create new Procedure

Create new Procedure

Required permissions:

  • Settings: Can access / edit items
  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_consultation
required
string
query Parameters
no_multiplier
boolean
Request Body schema: application/json
quantity
number
price
number
price_with_vat
number
vat_percentage
number
used
string
is_dispense_fee_item
boolean
is_injection_fee_item
boolean
herd_size_multiplier
integer
duration
integer
description
string
calculate_additional_tax
boolean
item
required
string
created_user
string
modified_user
string
supervising_veterinarian
string
performed_by
string
consultation
required
string
patient
string
template
string
template_item
string
parent_linked_item
string
worklist
string
sub_category
string
sibling_items
Array of strings

Responses

Request samples

Content type
application/json
{
  • "quantity": 0,
  • "price": 0,
  • "price_with_vat": 0,
  • "vat_percentage": 0,
  • "used": "string",
  • "is_dispense_fee_item": true,
  • "is_injection_fee_item": true,
  • "herd_size_multiplier": 0,
  • "duration": 0,
  • "description": "string",
  • "calculate_additional_tax": true,
  • "item": "string",
  • "created_user": "string",
  • "modified_user": "string",
  • "supervising_veterinarian": "string",
  • "performed_by": "string",
  • "consultation": "string",
  • "patient": "string",
  • "template": "string",
  • "template_item": "string",
  • "parent_linked_item": "string",
  • "worklist": "string",
  • "sub_category": "string",
  • "sibling_items": [
    ]
}

Get Procedure by ID

Get Procedure by ID

Required permissions:

  • Settings: Can access / edit items
  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_consultation
required
string
id
required
integer

A unique integer value identifying this consultation procedure.

query Parameters
no_multiplier
boolean

Responses

Update Procedure

Update Procedure

Required permissions:

  • Settings: Can access / edit items
  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_consultation
required
string
id
required
integer

A unique integer value identifying this consultation procedure.

query Parameters
no_multiplier
boolean
Request Body schema: application/json
quantity
number
price
number
price_with_vat
number
vat_percentage
number
used
string
is_dispense_fee_item
boolean
is_injection_fee_item
boolean
herd_size_multiplier
integer
duration
integer
description
string
calculate_additional_tax
boolean
item
required
string
created_user
string
modified_user
string
supervising_veterinarian
string
performed_by
string
consultation
required
string
patient
string
template
string
template_item
string
parent_linked_item
string
worklist
string
sub_category
string
sibling_items
Array of strings

Responses

Request samples

Content type
application/json
{
  • "quantity": 0,
  • "price": 0,
  • "price_with_vat": 0,
  • "vat_percentage": 0,
  • "used": "string",
  • "is_dispense_fee_item": true,
  • "is_injection_fee_item": true,
  • "herd_size_multiplier": 0,
  • "duration": 0,
  • "description": "string",
  • "calculate_additional_tax": true,
  • "item": "string",
  • "created_user": "string",
  • "modified_user": "string",
  • "supervising_veterinarian": "string",
  • "performed_by": "string",
  • "consultation": "string",
  • "patient": "string",
  • "template": "string",
  • "template_item": "string",
  • "parent_linked_item": "string",
  • "worklist": "string",
  • "sub_category": "string",
  • "sibling_items": [
    ]
}

Partially update Procedure

Partially update Procedure

Required permissions:

  • Settings: Can access / edit items
  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_consultation
required
string
id
required
integer

A unique integer value identifying this consultation procedure.

query Parameters
no_multiplier
boolean
Request Body schema: application/json
quantity
number
price
number
price_with_vat
number
vat_percentage
number
used
string
is_dispense_fee_item
boolean
is_injection_fee_item
boolean
herd_size_multiplier
integer
duration
integer
description
string
calculate_additional_tax
boolean
item
string
created_user
string
modified_user
string
supervising_veterinarian
string
performed_by
string
consultation
string
patient
string
template
string
template_item
string
parent_linked_item
string
worklist
string
sub_category
string
sibling_items
Array of strings

Responses

Request samples

Content type
application/json
{
  • "quantity": 0,
  • "price": 0,
  • "price_with_vat": 0,
  • "vat_percentage": 0,
  • "used": "string",
  • "is_dispense_fee_item": true,
  • "is_injection_fee_item": true,
  • "herd_size_multiplier": 0,
  • "duration": 0,
  • "description": "string",
  • "calculate_additional_tax": true,
  • "item": "string",
  • "created_user": "string",
  • "modified_user": "string",
  • "supervising_veterinarian": "string",
  • "performed_by": "string",
  • "consultation": "string",
  • "patient": "string",
  • "template": "string",
  • "template_item": "string",
  • "parent_linked_item": "string",
  • "worklist": "string",
  • "sub_category": "string",
  • "sibling_items": [
    ]
}

Archive Procedure

Archive Procedure

Required permissions:

  • Settings: Can access / edit items
  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_consultation
required
string
id
required
integer

A unique integer value identifying this consultation procedure.

query Parameters
no_multiplier
boolean

Responses

List Supplies

List Supplies

Required permissions:

  • Settings: Can access / edit items
  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 100 requests per minute.

path Parameters
parent_lookup_consultation
required
string
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

no_multiplier
boolean

Responses

Create new Supply

Create new Supply

Required permissions:

  • Settings: Can access / edit items
  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_consultation
required
string
query Parameters
no_multiplier
boolean
Request Body schema: application/json
quantity
number
price
number
price_with_vat
number
vat_percentage
number
used
string
is_dispense_fee_item
boolean
is_injection_fee_item
boolean
herd_size_multiplier
integer
usage_type
string
instructions
string
units
number
unit
string
package_description
string
usage_size
string
dosage_units
number
item
required
string
created_user
string
modified_user
string
supervising_veterinarian
string
performed_by
string
consultation
required
string
patient
string
template
string
template_item
string
parent_linked_item
string
sibling_items
Array of strings

Responses

Request samples

Content type
application/json
{
  • "quantity": 0,
  • "price": 0,
  • "price_with_vat": 0,
  • "vat_percentage": 0,
  • "used": "string",
  • "is_dispense_fee_item": true,
  • "is_injection_fee_item": true,
  • "herd_size_multiplier": 0,
  • "usage_type": "string",
  • "instructions": "string",
  • "units": 0,
  • "unit": "string",
  • "package_description": "string",
  • "usage_size": "string",
  • "dosage_units": 0,
  • "item": "string",
  • "created_user": "string",
  • "modified_user": "string",
  • "supervising_veterinarian": "string",
  • "performed_by": "string",
  • "consultation": "string",
  • "patient": "string",
  • "template": "string",
  • "template_item": "string",
  • "parent_linked_item": "string",
  • "sibling_items": [
    ]
}

Get Supply by ID

Get Supply by ID

Required permissions:

  • Settings: Can access / edit items
  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_consultation
required
string
id
required
integer

A unique integer value identifying this consultation supply.

query Parameters
no_multiplier
boolean

Responses

Update Supply

Update Supply

Required permissions:

  • Settings: Can access / edit items
  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_consultation
required
string
id
required
integer

A unique integer value identifying this consultation supply.

query Parameters
no_multiplier
boolean
Request Body schema: application/json
quantity
number
price
number
price_with_vat
number
vat_percentage
number
used
string
is_dispense_fee_item
boolean
is_injection_fee_item
boolean
herd_size_multiplier
integer
usage_type
string
instructions
string
units
number
unit
string
package_description
string
usage_size
string
dosage_units
number
item
required
string
created_user
string
modified_user
string
supervising_veterinarian
string
performed_by
string
consultation
required
string
patient
string
template
string
template_item
string
parent_linked_item
string
sibling_items
Array of strings

Responses

Request samples

Content type
application/json
{
  • "quantity": 0,
  • "price": 0,
  • "price_with_vat": 0,
  • "vat_percentage": 0,
  • "used": "string",
  • "is_dispense_fee_item": true,
  • "is_injection_fee_item": true,
  • "herd_size_multiplier": 0,
  • "usage_type": "string",
  • "instructions": "string",
  • "units": 0,
  • "unit": "string",
  • "package_description": "string",
  • "usage_size": "string",
  • "dosage_units": 0,
  • "item": "string",
  • "created_user": "string",
  • "modified_user": "string",
  • "supervising_veterinarian": "string",
  • "performed_by": "string",
  • "consultation": "string",
  • "patient": "string",
  • "template": "string",
  • "template_item": "string",
  • "parent_linked_item": "string",
  • "sibling_items": [
    ]
}

Partially update Supply

Partially update Supply

Required permissions:

  • Settings: Can access / edit items
  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_consultation
required
string
id
required
integer

A unique integer value identifying this consultation supply.

query Parameters
no_multiplier
boolean
Request Body schema: application/json
quantity
number
price
number
price_with_vat
number
vat_percentage
number
used
string
is_dispense_fee_item
boolean
is_injection_fee_item
boolean
herd_size_multiplier
integer
usage_type
string
instructions
string
units
number
unit
string
package_description
string
usage_size
string
dosage_units
number
item
string
created_user
string
modified_user
string
supervising_veterinarian
string
performed_by
string
consultation
string
patient
string
template
string
template_item
string
parent_linked_item
string
sibling_items
Array of strings

Responses

Request samples

Content type
application/json
{
  • "quantity": 0,
  • "price": 0,
  • "price_with_vat": 0,
  • "vat_percentage": 0,
  • "used": "string",
  • "is_dispense_fee_item": true,
  • "is_injection_fee_item": true,
  • "herd_size_multiplier": 0,
  • "usage_type": "string",
  • "instructions": "string",
  • "units": 0,
  • "unit": "string",
  • "package_description": "string",
  • "usage_size": "string",
  • "dosage_units": 0,
  • "item": "string",
  • "created_user": "string",
  • "modified_user": "string",
  • "supervising_veterinarian": "string",
  • "performed_by": "string",
  • "consultation": "string",
  • "patient": "string",
  • "template": "string",
  • "template_item": "string",
  • "parent_linked_item": "string",
  • "sibling_items": [
    ]
}

Archive Supply

Archive Supply

Required permissions:

  • Settings: Can access / edit items
  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_consultation
required
string
id
required
integer

A unique integer value identifying this consultation supply.

query Parameters
no_multiplier
boolean

Responses

List Plans

List Plans

Required permissions:

  • General: Can access / edit patients and clients
  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 100 requests per minute.

path Parameters
parent_lookup_consultation
required
string
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Get Plan by ID

Get Plan by ID

Required permissions:

  • General: Can access / edit patients and clients
  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_consultation
required
string
id
required
integer

A unique integer value identifying this treatment plan.

Responses

Consultation items

List Analyses

List Analyses

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 150 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

ordering
string

Which field to use when ordering the results.

Responses

Create new Analysis

Create new Analysis

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

Request Body schema: application/json
quantity
number
price
number
price_with_vat
number
vat_percentage
number
used
string
is_dispense_fee_item
boolean
is_injection_fee_item
boolean
herd_size_multiplier
integer
result_numeric
number
result
string
result_entered
string
approved
boolean
approved_date
string
measurement_unit
string
device
string
remarks
string
order_in_panel
integer
description
string
calculate_additional_tax
boolean
result_code
string
item
required
string
created_user
string
modified_user
string
supervising_veterinarian
string
performed_by
string
consultation
required
string
patient
string
template
string
template_item
string
parent_linked_item
string
referral
required
string
panel
string
approved_by
string
sibling_items
Array of strings

Responses

Request samples

Content type
application/json
{
  • "quantity": 0,
  • "price": 0,
  • "price_with_vat": 0,
  • "vat_percentage": 0,
  • "used": "string",
  • "is_dispense_fee_item": true,
  • "is_injection_fee_item": true,
  • "herd_size_multiplier": 0,
  • "result_numeric": 0,
  • "result": "string",
  • "result_entered": "string",
  • "approved": true,
  • "approved_date": "string",
  • "measurement_unit": "string",
  • "device": "string",
  • "remarks": "string",
  • "order_in_panel": 0,
  • "description": "string",
  • "calculate_additional_tax": true,
  • "result_code": "string",
  • "item": "string",
  • "created_user": "string",
  • "modified_user": "string",
  • "supervising_veterinarian": "string",
  • "performed_by": "string",
  • "consultation": "string",
  • "patient": "string",
  • "template": "string",
  • "template_item": "string",
  • "parent_linked_item": "string",
  • "referral": "string",
  • "panel": "string",
  • "approved_by": "string",
  • "sibling_items": [
    ]
}

Get Analysis by ID

Get Analysis by ID

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 600 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this consultation laboratory analysis.

query Parameters
ordering
string

Which field to use when ordering the results.

Responses

Update Analysis

Update Analysis

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this consultation laboratory analysis.

query Parameters
ordering
string

Which field to use when ordering the results.

Request Body schema: application/json
quantity
number
price
number
price_with_vat
number
vat_percentage
number
used
string
is_dispense_fee_item
boolean
is_injection_fee_item
boolean
herd_size_multiplier
integer
result_numeric
number
result
string
result_entered
string
approved
boolean
approved_date
string
measurement_unit
string
device
string
remarks
string
order_in_panel
integer
description
string
calculate_additional_tax
boolean
result_code
string
item
required
string
created_user
string
modified_user
string
supervising_veterinarian
string
performed_by
string
consultation
required
string
patient
string
template
string
template_item
string
parent_linked_item
string
referral
required
string
panel
string
approved_by
string
sibling_items
Array of strings

Responses

Request samples

Content type
application/json
{
  • "quantity": 0,
  • "price": 0,
  • "price_with_vat": 0,
  • "vat_percentage": 0,
  • "used": "string",
  • "is_dispense_fee_item": true,
  • "is_injection_fee_item": true,
  • "herd_size_multiplier": 0,
  • "result_numeric": 0,
  • "result": "string",
  • "result_entered": "string",
  • "approved": true,
  • "approved_date": "string",
  • "measurement_unit": "string",
  • "device": "string",
  • "remarks": "string",
  • "order_in_panel": 0,
  • "description": "string",
  • "calculate_additional_tax": true,
  • "result_code": "string",
  • "item": "string",
  • "created_user": "string",
  • "modified_user": "string",
  • "supervising_veterinarian": "string",
  • "performed_by": "string",
  • "consultation": "string",
  • "patient": "string",
  • "template": "string",
  • "template_item": "string",
  • "parent_linked_item": "string",
  • "referral": "string",
  • "panel": "string",
  • "approved_by": "string",
  • "sibling_items": [
    ]
}

Partially update Analysis

Partially update Analysis

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this consultation laboratory analysis.

query Parameters
ordering
string

Which field to use when ordering the results.

Request Body schema: application/json
quantity
number
price
number
price_with_vat
number
vat_percentage
number
used
string
is_dispense_fee_item
boolean
is_injection_fee_item
boolean
herd_size_multiplier
integer
result_numeric
number
result
string
result_entered
string
approved
boolean
approved_date
string
measurement_unit
string
device
string
remarks
string
order_in_panel
integer
description
string
calculate_additional_tax
boolean
result_code
string
item
string
created_user
string
modified_user
string
supervising_veterinarian
string
performed_by
string
consultation
string
patient
string
template
string
template_item
string
parent_linked_item
string
referral
string
panel
string
approved_by
string
sibling_items
Array of strings

Responses

Request samples

Content type
application/json
{
  • "quantity": 0,
  • "price": 0,
  • "price_with_vat": 0,
  • "vat_percentage": 0,
  • "used": "string",
  • "is_dispense_fee_item": true,
  • "is_injection_fee_item": true,
  • "herd_size_multiplier": 0,
  • "result_numeric": 0,
  • "result": "string",
  • "result_entered": "string",
  • "approved": true,
  • "approved_date": "string",
  • "measurement_unit": "string",
  • "device": "string",
  • "remarks": "string",
  • "order_in_panel": 0,
  • "description": "string",
  • "calculate_additional_tax": true,
  • "result_code": "string",
  • "item": "string",
  • "created_user": "string",
  • "modified_user": "string",
  • "supervising_veterinarian": "string",
  • "performed_by": "string",
  • "consultation": "string",
  • "patient": "string",
  • "template": "string",
  • "template_item": "string",
  • "parent_linked_item": "string",
  • "referral": "string",
  • "panel": "string",
  • "approved_by": "string",
  • "sibling_items": [
    ]
}

Delete Analysis

Delete Analysis

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this consultation laboratory analysis.

query Parameters
ordering
string

Which field to use when ordering the results.

Responses

List Foods

List Foods

Required permissions:

  • Settings: Can access / edit items
  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

no_multiplier
boolean

Responses

Create new Food

Create new Food

Required permissions:

  • Settings: Can access / edit items
  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

query Parameters
no_multiplier
boolean
Request Body schema: application/json
quantity
number
price
number
price_with_vat
number
vat_percentage
number
used
string
is_dispense_fee_item
boolean
is_injection_fee_item
boolean
herd_size_multiplier
integer
usage_type
string
instructions
string
units
number
unit
string
package_description
string
usage_size
string
dosage_units
number
item
required
string
created_user
string
modified_user
string
supervising_veterinarian
string
performed_by
string
consultation
required
string
patient
string
template
string
template_item
string
parent_linked_item
string
sibling_items
Array of strings

Responses

Request samples

Content type
application/json
{
  • "quantity": 0,
  • "price": 0,
  • "price_with_vat": 0,
  • "vat_percentage": 0,
  • "used": "string",
  • "is_dispense_fee_item": true,
  • "is_injection_fee_item": true,
  • "herd_size_multiplier": 0,
  • "usage_type": "string",
  • "instructions": "string",
  • "units": 0,
  • "unit": "string",
  • "package_description": "string",
  • "usage_size": "string",
  • "dosage_units": 0,
  • "item": "string",
  • "created_user": "string",
  • "modified_user": "string",
  • "supervising_veterinarian": "string",
  • "performed_by": "string",
  • "consultation": "string",
  • "patient": "string",
  • "template": "string",
  • "template_item": "string",
  • "parent_linked_item": "string",
  • "sibling_items": [
    ]
}

Get Food by ID

Get Food by ID

Required permissions:

  • Settings: Can access / edit items
  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this consultation food.

query Parameters
no_multiplier
boolean

Responses

Update Food

Update Food

Required permissions:

  • Settings: Can access / edit items
  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this consultation food.

query Parameters
no_multiplier
boolean
Request Body schema: application/json
quantity
number
price
number
price_with_vat
number
vat_percentage
number
used
string
is_dispense_fee_item
boolean
is_injection_fee_item
boolean
herd_size_multiplier
integer
usage_type
string
instructions
string
units
number
unit
string
package_description
string
usage_size
string
dosage_units
number
item
required
string
created_user
string
modified_user
string
supervising_veterinarian
string
performed_by
string
consultation
required
string
patient
string
template
string
template_item
string
parent_linked_item
string
sibling_items
Array of strings

Responses

Request samples

Content type
application/json
{
  • "quantity": 0,
  • "price": 0,
  • "price_with_vat": 0,
  • "vat_percentage": 0,
  • "used": "string",
  • "is_dispense_fee_item": true,
  • "is_injection_fee_item": true,
  • "herd_size_multiplier": 0,
  • "usage_type": "string",
  • "instructions": "string",
  • "units": 0,
  • "unit": "string",
  • "package_description": "string",
  • "usage_size": "string",
  • "dosage_units": 0,
  • "item": "string",
  • "created_user": "string",
  • "modified_user": "string",
  • "supervising_veterinarian": "string",
  • "performed_by": "string",
  • "consultation": "string",
  • "patient": "string",
  • "template": "string",
  • "template_item": "string",
  • "parent_linked_item": "string",
  • "sibling_items": [
    ]
}

Partially update Food

Partially update Food

Required permissions:

  • Settings: Can access / edit items
  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this consultation food.

query Parameters
no_multiplier
boolean
Request Body schema: application/json
quantity
number
price
number
price_with_vat
number
vat_percentage
number
used
string
is_dispense_fee_item
boolean
is_injection_fee_item
boolean
herd_size_multiplier
integer
usage_type
string
instructions
string
units
number
unit
string
package_description
string
usage_size
string
dosage_units
number
item
string
created_user
string
modified_user
string
supervising_veterinarian
string
performed_by
string
consultation
string
patient
string
template
string
template_item
string
parent_linked_item
string
sibling_items
Array of strings

Responses

Request samples

Content type
application/json
{
  • "quantity": 0,
  • "price": 0,
  • "price_with_vat": 0,
  • "vat_percentage": 0,
  • "used": "string",
  • "is_dispense_fee_item": true,
  • "is_injection_fee_item": true,
  • "herd_size_multiplier": 0,
  • "usage_type": "string",
  • "instructions": "string",
  • "units": 0,
  • "unit": "string",
  • "package_description": "string",
  • "usage_size": "string",
  • "dosage_units": 0,
  • "item": "string",
  • "created_user": "string",
  • "modified_user": "string",
  • "supervising_veterinarian": "string",
  • "performed_by": "string",
  • "consultation": "string",
  • "patient": "string",
  • "template": "string",
  • "template_item": "string",
  • "parent_linked_item": "string",
  • "sibling_items": [
    ]
}

Archive Food

Archive Food

Required permissions:

  • Settings: Can access / edit items
  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this consultation food.

query Parameters
no_multiplier
boolean

Responses

List Medicine

List Medicine

Required permissions:

  • Settings: Can access / edit items
  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

no_multiplier
boolean

Responses

Create new Medicine

Create new Medicine

Required permissions:

  • Settings: Can access / edit items
  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

query Parameters
no_multiplier
boolean
Request Body schema: application/json
numeric_withdrawal_periods
Array of strings
vaccination_disease
string
quantity
number
price
number
price_with_vat
number
vat_percentage
number
used
string
is_dispense_fee_item
boolean
is_injection_fee_item
boolean
herd_size_multiplier
integer
administration_method
string
administration_speed
number
administration_hours
number
usage_type
string
active_substance
string
controlled_substance
boolean
vaccination
boolean
vaccination_type
string
contraindications
string
preparation
string
manufacturer_data
string
instructions
string
units
number
unit
string
package_description
string
dosage_units
number
usage_size
string
withdrawal_periods
string
measurement_loss_quantity
number
measurement_loss_units
number
dispense_fee
number
injection_fee
number
dispense_fee_with_vat
number
injection_fee_with_vat
number
use_default_dispense_fee
boolean
not_for_food
boolean
use_dispense_fee
boolean
effect_time
integer
medication_duration_days
integer
item
required
string
created_user
string
modified_user
string
supervising_veterinarian
string
performed_by
string
consultation
required
string
patient
string
template
string
template_item
string
parent_linked_item
string
medication_diagnosis
string
sibling_items
Array of strings

Responses

Request samples

Content type
application/json
{
  • "numeric_withdrawal_periods": [
    ],
  • "vaccination_disease": "string",
  • "quantity": 0,
  • "price": 0,
  • "price_with_vat": 0,
  • "vat_percentage": 0,
  • "used": "string",
  • "is_dispense_fee_item": true,
  • "is_injection_fee_item": true,
  • "herd_size_multiplier": 0,
  • "administration_method": "string",
  • "administration_speed": 0,
  • "administration_hours": 0,
  • "usage_type": "string",
  • "active_substance": "string",
  • "controlled_substance": true,
  • "vaccination": true,
  • "vaccination_type": "string",
  • "contraindications": "string",
  • "preparation": "string",
  • "manufacturer_data": "string",
  • "instructions": "string",
  • "units": 0,
  • "unit": "string",
  • "package_description": "string",
  • "dosage_units": 0,
  • "usage_size": "string",
  • "withdrawal_periods": "string",
  • "measurement_loss_quantity": 0,
  • "measurement_loss_units": 0,
  • "dispense_fee": 0,
  • "injection_fee": 0,
  • "dispense_fee_with_vat": 0,
  • "injection_fee_with_vat": 0,
  • "use_default_dispense_fee": true,
  • "not_for_food": true,
  • "use_dispense_fee": true,
  • "effect_time": 0,
  • "medication_duration_days": 0,
  • "item": "string",
  • "created_user": "string",
  • "modified_user": "string",
  • "supervising_veterinarian": "string",
  • "performed_by": "string",
  • "consultation": "string",
  • "patient": "string",
  • "template": "string",
  • "template_item": "string",
  • "parent_linked_item": "string",
  • "medication_diagnosis": "string",
  • "sibling_items": [
    ]
}

Get Medicine by ID

Get Medicine by ID

Required permissions:

  • Settings: Can access / edit items
  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this consultation medicine.

query Parameters
no_multiplier
boolean

Responses

Update Medicine

Update Medicine

Required permissions:

  • Settings: Can access / edit items
  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this consultation medicine.

query Parameters
no_multiplier
boolean
Request Body schema: application/json
numeric_withdrawal_periods
Array of strings
vaccination_disease
string
quantity
number
price
number
price_with_vat
number
vat_percentage
number
used
string
is_dispense_fee_item
boolean
is_injection_fee_item
boolean
herd_size_multiplier
integer
administration_method
string
administration_speed
number
administration_hours
number
usage_type
string
active_substance
string
controlled_substance
boolean
vaccination
boolean
vaccination_type
string
contraindications
string
preparation
string
manufacturer_data
string
instructions
string
units
number
unit
string
package_description
string
dosage_units
number
usage_size
string
withdrawal_periods
string
measurement_loss_quantity
number
measurement_loss_units
number
dispense_fee
number
injection_fee
number
dispense_fee_with_vat
number
injection_fee_with_vat
number
use_default_dispense_fee
boolean
not_for_food
boolean
use_dispense_fee
boolean
effect_time
integer
medication_duration_days
integer
item
required
string
created_user
string
modified_user
string
supervising_veterinarian
string
performed_by
string
consultation
required
string
patient
string
template
string
template_item
string
parent_linked_item
string
medication_diagnosis
string
sibling_items
Array of strings

Responses

Request samples

Content type
application/json
{
  • "numeric_withdrawal_periods": [
    ],
  • "vaccination_disease": "string",
  • "quantity": 0,
  • "price": 0,
  • "price_with_vat": 0,
  • "vat_percentage": 0,
  • "used": "string",
  • "is_dispense_fee_item": true,
  • "is_injection_fee_item": true,
  • "herd_size_multiplier": 0,
  • "administration_method": "string",
  • "administration_speed": 0,
  • "administration_hours": 0,
  • "usage_type": "string",
  • "active_substance": "string",
  • "controlled_substance": true,
  • "vaccination": true,
  • "vaccination_type": "string",
  • "contraindications": "string",
  • "preparation": "string",
  • "manufacturer_data": "string",
  • "instructions": "string",
  • "units": 0,
  • "unit": "string",
  • "package_description": "string",
  • "dosage_units": 0,
  • "usage_size": "string",
  • "withdrawal_periods": "string",
  • "measurement_loss_quantity": 0,
  • "measurement_loss_units": 0,
  • "dispense_fee": 0,
  • "injection_fee": 0,
  • "dispense_fee_with_vat": 0,
  • "injection_fee_with_vat": 0,
  • "use_default_dispense_fee": true,
  • "not_for_food": true,
  • "use_dispense_fee": true,
  • "effect_time": 0,
  • "medication_duration_days": 0,
  • "item": "string",
  • "created_user": "string",
  • "modified_user": "string",
  • "supervising_veterinarian": "string",
  • "performed_by": "string",
  • "consultation": "string",
  • "patient": "string",
  • "template": "string",
  • "template_item": "string",
  • "parent_linked_item": "string",
  • "medication_diagnosis": "string",
  • "sibling_items": [
    ]
}

Partially update Medicine

Partially update Medicine

Required permissions:

  • Settings: Can access / edit items
  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this consultation medicine.

query Parameters
no_multiplier
boolean
Request Body schema: application/json
numeric_withdrawal_periods
Array of strings
vaccination_disease
string
quantity
number
price
number
price_with_vat
number
vat_percentage
number
used
string
is_dispense_fee_item
boolean
is_injection_fee_item
boolean
herd_size_multiplier
integer
administration_method
string
administration_speed
number
administration_hours
number
usage_type
string
active_substance
string
controlled_substance
boolean
vaccination
boolean
vaccination_type
string
contraindications
string
preparation
string
manufacturer_data
string
instructions
string
units
number
unit
string
package_description
string
dosage_units
number
usage_size
string
withdrawal_periods
string
measurement_loss_quantity
number
measurement_loss_units
number
dispense_fee
number
injection_fee
number
dispense_fee_with_vat
number
injection_fee_with_vat
number
use_default_dispense_fee
boolean
not_for_food
boolean
use_dispense_fee
boolean
effect_time
integer
medication_duration_days
integer
item
string
created_user
string
modified_user
string
supervising_veterinarian
string
performed_by
string
consultation
string
patient
string
template
string
template_item
string
parent_linked_item
string
medication_diagnosis
string
sibling_items
Array of strings

Responses

Request samples

Content type
application/json
{
  • "numeric_withdrawal_periods": [
    ],
  • "vaccination_disease": "string",
  • "quantity": 0,
  • "price": 0,
  • "price_with_vat": 0,
  • "vat_percentage": 0,
  • "used": "string",
  • "is_dispense_fee_item": true,
  • "is_injection_fee_item": true,
  • "herd_size_multiplier": 0,
  • "administration_method": "string",
  • "administration_speed": 0,
  • "administration_hours": 0,
  • "usage_type": "string",
  • "active_substance": "string",
  • "controlled_substance": true,
  • "vaccination": true,
  • "vaccination_type": "string",
  • "contraindications": "string",
  • "preparation": "string",
  • "manufacturer_data": "string",
  • "instructions": "string",
  • "units": 0,
  • "unit": "string",
  • "package_description": "string",
  • "dosage_units": 0,
  • "usage_size": "string",
  • "withdrawal_periods": "string",
  • "measurement_loss_quantity": 0,
  • "measurement_loss_units": 0,
  • "dispense_fee": 0,
  • "injection_fee": 0,
  • "dispense_fee_with_vat": 0,
  • "injection_fee_with_vat": 0,
  • "use_default_dispense_fee": true,
  • "not_for_food": true,
  • "use_dispense_fee": true,
  • "effect_time": 0,
  • "medication_duration_days": 0,
  • "item": "string",
  • "created_user": "string",
  • "modified_user": "string",
  • "supervising_veterinarian": "string",
  • "performed_by": "string",
  • "consultation": "string",
  • "patient": "string",
  • "template": "string",
  • "template_item": "string",
  • "parent_linked_item": "string",
  • "medication_diagnosis": "string",
  • "sibling_items": [
    ]
}

Archive Medicine

Archive Medicine

Required permissions:

  • Settings: Can access / edit items
  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this consultation medicine.

query Parameters
no_multiplier
boolean

Responses

Delete withdrawal period related to consultation item

Delete withdrawal period related to consultation item

Required permissions:

  • Settings: Can access / edit items
  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 100 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this consultation medicine.

query Parameters
no_multiplier
boolean
Request Body schema: application/json
numeric_withdrawal_periods
Array of strings
vaccination_disease
string
quantity
number
price
number
price_with_vat
number
vat_percentage
number
used
string
is_dispense_fee_item
boolean
is_injection_fee_item
boolean
herd_size_multiplier
integer
administration_method
string
administration_speed
number
administration_hours
number
usage_type
string
active_substance
string
controlled_substance
boolean
vaccination
boolean
vaccination_type
string
contraindications
string
preparation
string
manufacturer_data
string
instructions
string
units
number
unit
string
package_description
string
dosage_units
number
usage_size
string
withdrawal_periods
string
measurement_loss_quantity
number
measurement_loss_units
number
dispense_fee
number
injection_fee
number
dispense_fee_with_vat
number
injection_fee_with_vat
number
use_default_dispense_fee
boolean
not_for_food
boolean
use_dispense_fee
boolean
effect_time
integer
medication_duration_days
integer
item
required
string
created_user
string
modified_user
string
supervising_veterinarian
string
performed_by
string
consultation
required
string
patient
string
template
string
template_item
string
parent_linked_item
string
medication_diagnosis
string
sibling_items
Array of strings

Responses

Request samples

Content type
application/json
{
  • "numeric_withdrawal_periods": [
    ],
  • "vaccination_disease": "string",
  • "quantity": 0,
  • "price": 0,
  • "price_with_vat": 0,
  • "vat_percentage": 0,
  • "used": "string",
  • "is_dispense_fee_item": true,
  • "is_injection_fee_item": true,
  • "herd_size_multiplier": 0,
  • "administration_method": "string",
  • "administration_speed": 0,
  • "administration_hours": 0,
  • "usage_type": "string",
  • "active_substance": "string",
  • "controlled_substance": true,
  • "vaccination": true,
  • "vaccination_type": "string",
  • "contraindications": "string",
  • "preparation": "string",
  • "manufacturer_data": "string",
  • "instructions": "string",
  • "units": 0,
  • "unit": "string",
  • "package_description": "string",
  • "dosage_units": 0,
  • "usage_size": "string",
  • "withdrawal_periods": "string",
  • "measurement_loss_quantity": 0,
  • "measurement_loss_units": 0,
  • "dispense_fee": 0,
  • "injection_fee": 0,
  • "dispense_fee_with_vat": 0,
  • "injection_fee_with_vat": 0,
  • "use_default_dispense_fee": true,
  • "not_for_food": true,
  • "use_dispense_fee": true,
  • "effect_time": 0,
  • "medication_duration_days": 0,
  • "item": "string",
  • "created_user": "string",
  • "modified_user": "string",
  • "supervising_veterinarian": "string",
  • "performed_by": "string",
  • "consultation": "string",
  • "patient": "string",
  • "template": "string",
  • "template_item": "string",
  • "parent_linked_item": "string",
  • "medication_diagnosis": "string",
  • "sibling_items": [
    ]
}

List Procedures

List Procedures

Required permissions:

  • Settings: Can access / edit items
  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

no_multiplier
boolean

Responses

Create new Procedure

Create new Procedure

Required permissions:

  • Settings: Can access / edit items
  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

query Parameters
no_multiplier
boolean
Request Body schema: application/json
quantity
number
price
number
price_with_vat
number
vat_percentage
number
used
string
is_dispense_fee_item
boolean
is_injection_fee_item
boolean
herd_size_multiplier
integer
duration
integer
description
string
calculate_additional_tax
boolean
item
required
string
created_user
string
modified_user
string
supervising_veterinarian
string
performed_by
string
consultation
required
string
patient
string
template
string
template_item
string
parent_linked_item
string
worklist
string
sub_category
string
sibling_items
Array of strings

Responses

Request samples

Content type
application/json
{
  • "quantity": 0,
  • "price": 0,
  • "price_with_vat": 0,
  • "vat_percentage": 0,
  • "used": "string",
  • "is_dispense_fee_item": true,
  • "is_injection_fee_item": true,
  • "herd_size_multiplier": 0,
  • "duration": 0,
  • "description": "string",
  • "calculate_additional_tax": true,
  • "item": "string",
  • "created_user": "string",
  • "modified_user": "string",
  • "supervising_veterinarian": "string",
  • "performed_by": "string",
  • "consultation": "string",
  • "patient": "string",
  • "template": "string",
  • "template_item": "string",
  • "parent_linked_item": "string",
  • "worklist": "string",
  • "sub_category": "string",
  • "sibling_items": [
    ]
}

Get Procedure by ID

Get Procedure by ID

Required permissions:

  • Settings: Can access / edit items
  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this consultation procedure.

query Parameters
no_multiplier
boolean

Responses

Update Procedure

Update Procedure

Required permissions:

  • Settings: Can access / edit items
  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this consultation procedure.

query Parameters
no_multiplier
boolean
Request Body schema: application/json
quantity
number
price
number
price_with_vat
number
vat_percentage
number
used
string
is_dispense_fee_item
boolean
is_injection_fee_item
boolean
herd_size_multiplier
integer
duration
integer
description
string
calculate_additional_tax
boolean
item
required
string
created_user
string
modified_user
string
supervising_veterinarian
string
performed_by
string
consultation
required
string
patient
string
template
string
template_item
string
parent_linked_item
string
worklist
string
sub_category
string
sibling_items
Array of strings

Responses

Request samples

Content type
application/json
{
  • "quantity": 0,
  • "price": 0,
  • "price_with_vat": 0,
  • "vat_percentage": 0,
  • "used": "string",
  • "is_dispense_fee_item": true,
  • "is_injection_fee_item": true,
  • "herd_size_multiplier": 0,
  • "duration": 0,
  • "description": "string",
  • "calculate_additional_tax": true,
  • "item": "string",
  • "created_user": "string",
  • "modified_user": "string",
  • "supervising_veterinarian": "string",
  • "performed_by": "string",
  • "consultation": "string",
  • "patient": "string",
  • "template": "string",
  • "template_item": "string",
  • "parent_linked_item": "string",
  • "worklist": "string",
  • "sub_category": "string",
  • "sibling_items": [
    ]
}

Partially update Procedure

Partially update Procedure

Required permissions:

  • Settings: Can access / edit items
  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this consultation procedure.

query Parameters
no_multiplier
boolean
Request Body schema: application/json
quantity
number
price
number
price_with_vat
number
vat_percentage
number
used
string
is_dispense_fee_item
boolean
is_injection_fee_item
boolean
herd_size_multiplier
integer
duration
integer
description
string
calculate_additional_tax
boolean
item
string
created_user
string
modified_user
string
supervising_veterinarian
string
performed_by
string
consultation
string
patient
string
template
string
template_item
string
parent_linked_item
string
worklist
string
sub_category
string
sibling_items
Array of strings

Responses

Request samples

Content type
application/json
{
  • "quantity": 0,
  • "price": 0,
  • "price_with_vat": 0,
  • "vat_percentage": 0,
  • "used": "string",
  • "is_dispense_fee_item": true,
  • "is_injection_fee_item": true,
  • "herd_size_multiplier": 0,
  • "duration": 0,
  • "description": "string",
  • "calculate_additional_tax": true,
  • "item": "string",
  • "created_user": "string",
  • "modified_user": "string",
  • "supervising_veterinarian": "string",
  • "performed_by": "string",
  • "consultation": "string",
  • "patient": "string",
  • "template": "string",
  • "template_item": "string",
  • "parent_linked_item": "string",
  • "worklist": "string",
  • "sub_category": "string",
  • "sibling_items": [
    ]
}

Archive Procedure

Archive Procedure

Required permissions:

  • Settings: Can access / edit items
  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this consultation procedure.

query Parameters
no_multiplier
boolean

Responses

List Supplies

List Supplies

Required permissions:

  • Settings: Can access / edit items
  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

no_multiplier
boolean

Responses

Create new Supply

Create new Supply

Required permissions:

  • Settings: Can access / edit items
  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

query Parameters
no_multiplier
boolean
Request Body schema: application/json
quantity
number
price
number
price_with_vat
number
vat_percentage
number
used
string
is_dispense_fee_item
boolean
is_injection_fee_item
boolean
herd_size_multiplier
integer
usage_type
string
instructions
string
units
number
unit
string
package_description
string
usage_size
string
dosage_units
number
item
required
string
created_user
string
modified_user
string
supervising_veterinarian
string
performed_by
string
consultation
required
string
patient
string
template
string
template_item
string
parent_linked_item
string
sibling_items
Array of strings

Responses

Request samples

Content type
application/json
{
  • "quantity": 0,
  • "price": 0,
  • "price_with_vat": 0,
  • "vat_percentage": 0,
  • "used": "string",
  • "is_dispense_fee_item": true,
  • "is_injection_fee_item": true,
  • "herd_size_multiplier": 0,
  • "usage_type": "string",
  • "instructions": "string",
  • "units": 0,
  • "unit": "string",
  • "package_description": "string",
  • "usage_size": "string",
  • "dosage_units": 0,
  • "item": "string",
  • "created_user": "string",
  • "modified_user": "string",
  • "supervising_veterinarian": "string",
  • "performed_by": "string",
  • "consultation": "string",
  • "patient": "string",
  • "template": "string",
  • "template_item": "string",
  • "parent_linked_item": "string",
  • "sibling_items": [
    ]
}

Get Supply by ID

Get Supply by ID

Required permissions:

  • Settings: Can access / edit items
  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this consultation supply.

query Parameters
no_multiplier
boolean

Responses

Update Supply

Update Supply

Required permissions:

  • Settings: Can access / edit items
  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this consultation supply.

query Parameters
no_multiplier
boolean
Request Body schema: application/json
quantity
number
price
number
price_with_vat
number
vat_percentage
number
used
string
is_dispense_fee_item
boolean
is_injection_fee_item
boolean
herd_size_multiplier
integer
usage_type
string
instructions
string
units
number
unit
string
package_description
string
usage_size
string
dosage_units
number
item
required
string
created_user
string
modified_user
string
supervising_veterinarian
string
performed_by
string
consultation
required
string
patient
string
template
string
template_item
string
parent_linked_item
string
sibling_items
Array of strings

Responses

Request samples

Content type
application/json
{
  • "quantity": 0,
  • "price": 0,
  • "price_with_vat": 0,
  • "vat_percentage": 0,
  • "used": "string",
  • "is_dispense_fee_item": true,
  • "is_injection_fee_item": true,
  • "herd_size_multiplier": 0,
  • "usage_type": "string",
  • "instructions": "string",
  • "units": 0,
  • "unit": "string",
  • "package_description": "string",
  • "usage_size": "string",
  • "dosage_units": 0,
  • "item": "string",
  • "created_user": "string",
  • "modified_user": "string",
  • "supervising_veterinarian": "string",
  • "performed_by": "string",
  • "consultation": "string",
  • "patient": "string",
  • "template": "string",
  • "template_item": "string",
  • "parent_linked_item": "string",
  • "sibling_items": [
    ]
}

Partially update Supply

Partially update Supply

Required permissions:

  • Settings: Can access / edit items
  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this consultation supply.

query Parameters
no_multiplier
boolean
Request Body schema: application/json
quantity
number
price
number
price_with_vat
number
vat_percentage
number
used
string
is_dispense_fee_item
boolean
is_injection_fee_item
boolean
herd_size_multiplier
integer
usage_type
string
instructions
string
units
number
unit
string
package_description
string
usage_size
string
dosage_units
number
item
string
created_user
string
modified_user
string
supervising_veterinarian
string
performed_by
string
consultation
string
patient
string
template
string
template_item
string
parent_linked_item
string
sibling_items
Array of strings

Responses

Request samples

Content type
application/json
{
  • "quantity": 0,
  • "price": 0,
  • "price_with_vat": 0,
  • "vat_percentage": 0,
  • "used": "string",
  • "is_dispense_fee_item": true,
  • "is_injection_fee_item": true,
  • "herd_size_multiplier": 0,
  • "usage_type": "string",
  • "instructions": "string",
  • "units": 0,
  • "unit": "string",
  • "package_description": "string",
  • "usage_size": "string",
  • "dosage_units": 0,
  • "item": "string",
  • "created_user": "string",
  • "modified_user": "string",
  • "supervising_veterinarian": "string",
  • "performed_by": "string",
  • "consultation": "string",
  • "patient": "string",
  • "template": "string",
  • "template_item": "string",
  • "parent_linked_item": "string",
  • "sibling_items": [
    ]
}

Archive Supply

Archive Supply

Required permissions:

  • Settings: Can access / edit items
  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this consultation supply.

query Parameters
no_multiplier
boolean

Responses

List Consultation Items

List Consultation Items

Some filters require special values.

  • type_code:
    • ITEM_TYPE_PROCEDURE = 1
    • ITEM_TYPE_MEDICINE = 2
    • ITEM_TYPE_SUPPLY = 3
    • ITEM_TYPE_FOOD = 4
    • ITEM_TYPE_LABORATORY_ANALYSIS = 5
    • ITEM_TYPE_LABORATORY_ANALYSIS_PANEL = 6
  • usage type:
    • USAGE_TYPE_ADMINISTERED = 1
    • USAGE_TYPE_GIVEN = 2
    • USAGE_TYPE_PRESCRIPTION = 3

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

ordering
string

Which field to use when ordering the results.

Responses

Get Consultation Item by ID

Get Consultation Item by ID

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this consultation item.

query Parameters
ordering
string

Which field to use when ordering the results.

Responses

Consultation laboratory referrals

List Laboratory Referrals

List Laboratory Referrals

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 150 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

ordering
string

Which field to use when ordering the results.

Responses

Create new Laboratory Referral

Create new Laboratory Referral

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

Request Body schema: application/json
consultation
required
string
department
required
string
patient
string
laboratory_type
required
string
type
string
status
string
inhouse_status
integer
created_user
string
modified_user
string
referral_remarks
string
laboratory_remarks
string
internal_notes
string
referral_remarks_user
string
referral_remarks_modified
string
laboratory_remarks_user
string
laboratory_remarks_modified
string
internal_notes_user
string
internal_notes_modified
string
sample_location
object
locked
string
locked_user
string
never_require_results
boolean
external_id
string
external_status
string
external_type
string
internal_id
string
internal_status
string
sampler
string
sample_taken
string
referring_veterinarian
string
create_task_for
Array of strings
urgent
boolean
analyses
Array of strings
panels
Array of strings
samples
Array of strings

Responses

Request samples

Content type
application/json
{
  • "consultation": "string",
  • "department": "string",
  • "patient": "string",
  • "laboratory_type": "string",
  • "type": "string",
  • "status": "string",
  • "inhouse_status": 0,
  • "created_user": "string",
  • "modified_user": "string",
  • "referral_remarks": "string",
  • "laboratory_remarks": "string",
  • "internal_notes": "string",
  • "referral_remarks_user": "string",
  • "referral_remarks_modified": "string",
  • "laboratory_remarks_user": "string",
  • "laboratory_remarks_modified": "string",
  • "internal_notes_user": "string",
  • "internal_notes_modified": "string",
  • "sample_location": { },
  • "locked": "string",
  • "locked_user": "string",
  • "never_require_results": true,
  • "external_id": "string",
  • "external_status": "string",
  • "external_type": "string",
  • "internal_id": "string",
  • "internal_status": "string",
  • "sampler": "string",
  • "sample_taken": "string",
  • "referring_veterinarian": "string",
  • "create_task_for": [
    ],
  • "urgent": true,
  • "analyses": [
    ],
  • "panels": [
    ],
  • "samples": [
    ]
}

Get Laboratory Referral by ID

Get Laboratory Referral by ID

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 500 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this consultation laboratory referral.

query Parameters
ordering
string

Which field to use when ordering the results.

Responses

Update Laboratory Referral

Update Laboratory Referral

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this consultation laboratory referral.

query Parameters
ordering
string

Which field to use when ordering the results.

Request Body schema: application/json
consultation
required
string
department
required
string
patient
string
laboratory_type
required
string
type
string
status
string
inhouse_status
integer
created_user
string
modified_user
string
referral_remarks
string
laboratory_remarks
string
internal_notes
string
referral_remarks_user
string
referral_remarks_modified
string
laboratory_remarks_user
string
laboratory_remarks_modified
string
internal_notes_user
string
internal_notes_modified
string
sample_location
object
locked
string
locked_user
string
never_require_results
boolean
external_id
string
external_status
string
external_type
string
internal_id
string
internal_status
string
sampler
string
sample_taken
string
referring_veterinarian
string
create_task_for
Array of strings
urgent
boolean
analyses
Array of strings
panels
Array of strings
samples
Array of strings

Responses

Request samples

Content type
application/json
{
  • "consultation": "string",
  • "department": "string",
  • "patient": "string",
  • "laboratory_type": "string",
  • "type": "string",
  • "status": "string",
  • "inhouse_status": 0,
  • "created_user": "string",
  • "modified_user": "string",
  • "referral_remarks": "string",
  • "laboratory_remarks": "string",
  • "internal_notes": "string",
  • "referral_remarks_user": "string",
  • "referral_remarks_modified": "string",
  • "laboratory_remarks_user": "string",
  • "laboratory_remarks_modified": "string",
  • "internal_notes_user": "string",
  • "internal_notes_modified": "string",
  • "sample_location": { },
  • "locked": "string",
  • "locked_user": "string",
  • "never_require_results": true,
  • "external_id": "string",
  • "external_status": "string",
  • "external_type": "string",
  • "internal_id": "string",
  • "internal_status": "string",
  • "sampler": "string",
  • "sample_taken": "string",
  • "referring_veterinarian": "string",
  • "create_task_for": [
    ],
  • "urgent": true,
  • "analyses": [
    ],
  • "panels": [
    ],
  • "samples": [
    ]
}

Partially update Laboratory Referral

Partially update Laboratory Referral

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this consultation laboratory referral.

query Parameters
ordering
string

Which field to use when ordering the results.

Request Body schema: application/json
consultation
string
department
string
patient
string
laboratory_type
string
type
string
status
string
inhouse_status
integer
created_user
string
modified_user
string
referral_remarks
string
laboratory_remarks
string
internal_notes
string
referral_remarks_user
string
referral_remarks_modified
string
laboratory_remarks_user
string
laboratory_remarks_modified
string
internal_notes_user
string
internal_notes_modified
string
sample_location
object
locked
string
locked_user
string
never_require_results
boolean
external_id
string
external_status
string
external_type
string
internal_id
string
internal_status
string
sampler
string
sample_taken
string
referring_veterinarian
string
create_task_for
Array of strings
urgent
boolean
analyses
Array of strings
panels
Array of strings
samples
Array of strings

Responses

Request samples

Content type
application/json
{
  • "consultation": "string",
  • "department": "string",
  • "patient": "string",
  • "laboratory_type": "string",
  • "type": "string",
  • "status": "string",
  • "inhouse_status": 0,
  • "created_user": "string",
  • "modified_user": "string",
  • "referral_remarks": "string",
  • "laboratory_remarks": "string",
  • "internal_notes": "string",
  • "referral_remarks_user": "string",
  • "referral_remarks_modified": "string",
  • "laboratory_remarks_user": "string",
  • "laboratory_remarks_modified": "string",
  • "internal_notes_user": "string",
  • "internal_notes_modified": "string",
  • "sample_location": { },
  • "locked": "string",
  • "locked_user": "string",
  • "never_require_results": true,
  • "external_id": "string",
  • "external_status": "string",
  • "external_type": "string",
  • "internal_id": "string",
  • "internal_status": "string",
  • "sampler": "string",
  • "sample_taken": "string",
  • "referring_veterinarian": "string",
  • "create_task_for": [
    ],
  • "urgent": true,
  • "analyses": [
    ],
  • "panels": [
    ],
  • "samples": [
    ]
}

Delete Laboratory Referral

Delete Laboratory Referral

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this consultation laboratory referral.

query Parameters
ordering
string

Which field to use when ordering the results.

Responses

Consultation samples

List Samples

List Samples

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Create new Sample

Create new Sample

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

Request Body schema: application/json
referral
required
string
coded_sample_type
string
quantity
integer
site
string
comment
string
received_date
string
received_user
string

Responses

Request samples

Content type
application/json
{
  • "referral": "string",
  • "coded_sample_type": "string",
  • "quantity": 0,
  • "site": "string",
  • "comment": "string",
  • "received_date": "string",
  • "received_user": "string"
}

Get Sample by ID

Get Sample by ID

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this consultation sample.

Responses

Update Sample

Update Sample

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this consultation sample.

Request Body schema: application/json
referral
required
string
coded_sample_type
string
quantity
integer
site
string
comment
string
received_date
string
received_user
string

Responses

Request samples

Content type
application/json
{
  • "referral": "string",
  • "coded_sample_type": "string",
  • "quantity": 0,
  • "site": "string",
  • "comment": "string",
  • "received_date": "string",
  • "received_user": "string"
}

Partially update Sample

Partially update Sample

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this consultation sample.

Request Body schema: application/json
referral
string
coded_sample_type
string
quantity
integer
site
string
comment
string
received_date
string
received_user
string

Responses

Request samples

Content type
application/json
{
  • "referral": "string",
  • "coded_sample_type": "string",
  • "quantity": 0,
  • "site": "string",
  • "comment": "string",
  • "received_date": "string",
  • "received_user": "string"
}

Consultation target areas

List Target Areas

List Target Areas

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Create new Target Area

Create new Target Area

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

Request Body schema: application/json
target_area
required
string
consultation
string
name
required
string
code
string
procedure
string
worklist
string
created_user
string
modified_user
string
category_id
integer
sub_category_id
integer

Responses

Request samples

Content type
application/json
{
  • "target_area": "string",
  • "consultation": "string",
  • "name": "string",
  • "code": "string",
  • "procedure": "string",
  • "worklist": "string",
  • "created_user": "string",
  • "modified_user": "string",
  • "category_id": 0,
  • "sub_category_id": 0
}

Get Target Area by ID

Get Target Area by ID

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this consultation target area.

Responses

Update Target Area

Update Target Area

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this consultation target area.

Request Body schema: application/json
target_area
required
string
consultation
string
name
required
string
code
string
procedure
string
worklist
string
created_user
string
modified_user
string
category_id
integer
sub_category_id
integer

Responses

Request samples

Content type
application/json
{
  • "target_area": "string",
  • "consultation": "string",
  • "name": "string",
  • "code": "string",
  • "procedure": "string",
  • "worklist": "string",
  • "created_user": "string",
  • "modified_user": "string",
  • "category_id": 0,
  • "sub_category_id": 0
}

Partially update Target Area

Partially update Target Area

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this consultation target area.

Request Body schema: application/json
target_area
string
consultation
string
name
string
code
string
procedure
string
worklist
string
created_user
string
modified_user
string
category_id
integer
sub_category_id
integer

Responses

Request samples

Content type
application/json
{
  • "target_area": "string",
  • "consultation": "string",
  • "name": "string",
  • "code": "string",
  • "procedure": "string",
  • "worklist": "string",
  • "created_user": "string",
  • "modified_user": "string",
  • "category_id": 0,
  • "sub_category_id": 0
}

Archive Target Area

Archive Target Area

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this consultation target area.

Responses

Consultation antibiotics

List Antibiotics

List Antibiotics

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Create new Antibiotic

Create new Antibiotic

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

Request Body schema: application/json
antibiotic
required
string
consultation_organism
required
string
panel
string
resistant
boolean
intermediate
boolean
sensitive
boolean
mic
string

Responses

Request samples

Content type
application/json
{
  • "antibiotic": "string",
  • "consultation_organism": "string",
  • "panel": "string",
  • "resistant": true,
  • "intermediate": true,
  • "sensitive": true,
  • "mic": "string"
}

Get Antibiotic by ID

Get Antibiotic by ID

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this consultation antibiotic.

Responses

Update Antibiotic

Update Antibiotic

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this consultation antibiotic.

Request Body schema: application/json
antibiotic
required
string
consultation_organism
required
string
panel
string
resistant
boolean
intermediate
boolean
sensitive
boolean
mic
string

Responses

Request samples

Content type
application/json
{
  • "antibiotic": "string",
  • "consultation_organism": "string",
  • "panel": "string",
  • "resistant": true,
  • "intermediate": true,
  • "sensitive": true,
  • "mic": "string"
}

Partially update Antibiotic

Partially update Antibiotic

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this consultation antibiotic.

Request Body schema: application/json
antibiotic
string
consultation_organism
string
panel
string
resistant
boolean
intermediate
boolean
sensitive
boolean
mic
string

Responses

Request samples

Content type
application/json
{
  • "antibiotic": "string",
  • "consultation_organism": "string",
  • "panel": "string",
  • "resistant": true,
  • "intermediate": true,
  • "sensitive": true,
  • "mic": "string"
}

Archive Antibiotic

Archive Antibiotic

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this consultation antibiotic.

Responses

List Panels

List Panels

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Create new Panel

Create new Panel

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

Request Body schema: application/json
antibiotic_panel
required
string
consultation_organism
string

Responses

Request samples

Content type
application/json
{
  • "antibiotic_panel": "string",
  • "consultation_organism": "string"
}

Get Panel by ID

Get Panel by ID

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this consultation antibiotic panel.

Responses

Update Panel

Update Panel

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this consultation antibiotic panel.

Request Body schema: application/json
antibiotic_panel
required
string
consultation_organism
string

Responses

Request samples

Content type
application/json
{
  • "antibiotic_panel": "string",
  • "consultation_organism": "string"
}

Partially update Panel

Partially update Panel

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this consultation antibiotic panel.

Request Body schema: application/json
antibiotic_panel
string
consultation_organism
string

Responses

Request samples

Content type
application/json
{
  • "antibiotic_panel": "string",
  • "consultation_organism": "string"
}

Archive Panel

Archive Panel

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this consultation antibiotic panel.

Responses

Consultation bundles

List Bundles

List Bundles

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Create new Bundle

Create new Bundle

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

Request Body schema: application/json
consultation
required
string
patient
required
string
main_consultation_template
string
base_template
required
string
name
required
string
price_change_item
string

Responses

Request samples

Content type
application/json
{
  • "consultation": "string",
  • "patient": "string",
  • "main_consultation_template": "string",
  • "base_template": "string",
  • "name": "string",
  • "price_change_item": "string"
}

Get Bundle by ID

Get Bundle by ID

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this consultation item template.

Responses

Update Bundle

Update Bundle

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this consultation item template.

Request Body schema: application/json
consultation
required
string
patient
required
string
main_consultation_template
string
base_template
required
string
name
required
string
price_change_item
string

Responses

Request samples

Content type
application/json
{
  • "consultation": "string",
  • "patient": "string",
  • "main_consultation_template": "string",
  • "base_template": "string",
  • "name": "string",
  • "price_change_item": "string"
}

Partially update Bundle

Partially update Bundle

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this consultation item template.

Request Body schema: application/json
consultation
string
patient
string
main_consultation_template
string
base_template
string
name
string
price_change_item
string

Responses

Request samples

Content type
application/json
{
  • "consultation": "string",
  • "patient": "string",
  • "main_consultation_template": "string",
  • "base_template": "string",
  • "name": "string",
  • "price_change_item": "string"
}

Consultation organisms

List Organisms

List Organisms

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Create new Organism

Create new Organism

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

Request Body schema: application/json
description
string
organism
required
string
consultation_analysis
required
string

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "organism": "string",
  • "consultation_analysis": "string"
}

Get Organism by ID

Get Organism by ID

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this consultation organism.

Responses

Update Organism

Update Organism

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this consultation organism.

Request Body schema: application/json
description
string
organism
required
string
consultation_analysis
required
string

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "organism": "string",
  • "consultation_analysis": "string"
}

Partially update Organism

Partially update Organism

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this consultation organism.

Request Body schema: application/json
description
string
organism
string
consultation_analysis
string

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "organism": "string",
  • "consultation_analysis": "string"
}

Archive Organism

Archive Organism

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this consultation organism.

Responses

consultationsubcategory

List Consultation Imaging Subcategories

List Consultation Imaging Subcategories

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Get Subcategory by ID

Get Subcategory by ID

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this consultation sub category.

Responses

Content types

List Content Types

List Content Types

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Get Content Type by ID

Get Content Type by ID

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this content type.

Responses

Counter sales

List Counter Sales

List Counter Sales

Required permissions:

  • Financial: Can access / edit invoices

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

ordering
string

Which field to use when ordering the results.

Responses

Create new Counter Sale

Create new Counter Sale

Required permissions:

  • Financial: Can access / edit invoices

This endpoint is rate-limited to 300 requests per minute.

Request Body schema: application/json
client
required
string

Client for the sale. Null is anonymous sale

remarks
string
department
required
string

department of the countersale. the data is a url pointing to a department (see department-endpoint)

tags_rel
Array of strings

Tags for the sale/invoice

Responses

Request samples

Content type
application/json
{
  • "client": "string",
  • "remarks": "string",
  • "department": "string",
  • "tags_rel": [
    ]
}

Get Counter Sale by ID

Get Counter Sale by ID

Required permissions:

  • Financial: Can access / edit invoices

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this invoice.

query Parameters
ordering
string

Which field to use when ordering the results.

Responses

Update Counter Sale

Update Counter Sale

Updates are not allowed if the Counter Sale is finalized.

Required permissions:

  • Financial: Can access / edit invoices

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this invoice.

query Parameters
ordering
string

Which field to use when ordering the results.

Request Body schema: application/json
client
required
string

Client for the sale. Null is anonymous sale

remarks
string
department
required
string

department of the countersale. the data is a url pointing to a department (see department-endpoint)

tags_rel
Array of strings

Tags for the sale/invoice

Responses

Request samples

Content type
application/json
{
  • "client": "string",
  • "remarks": "string",
  • "department": "string",
  • "tags_rel": [
    ]
}

Partially update Counter Sale

Partially update Counter Sale

Updates are not allowed if the Counter Sale is finalized.

Required permissions:

  • Financial: Can access / edit invoices

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this invoice.

query Parameters
ordering
string

Which field to use when ordering the results.

Request Body schema: application/json
department
string
client
string
tags_rel
Array of strings
invoice_row
Array of strings

Responses

Request samples

Content type
application/json
{
  • "department": "string",
  • "client": "string",
  • "tags_rel": [
    ],
  • "invoice_row": [
    ]
}

Archive Counter Sale

Archive Counter Sale

Archiving is not allowed if the Counter Sale is finalized.

Required permissions:

  • Financial: Can access / edit invoices

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this invoice.

query Parameters
ordering
string

Which field to use when ordering the results.

Responses

Add new item to Counter Sale

Add new item to Counter Sale

Required permissions:

  • Financial: Can access / edit invoices

This endpoint is rate-limited to 100 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this invoice.

Responses

Add new item to Counter Sale

Add new item to Counter Sale

Required permissions:

  • Financial: Can access / edit invoices

This endpoint is rate-limited to 100 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this invoice.

Request Body schema: application/json
item
required
string

Item to be added. URL to item instance

patient
string

Patient for the invoice row

name
string

If not defined, item name is used

print_name
string

If not defined, item print name is used

quantity
required
number

The amount sold. usage size defines if the amount is units or packages

usage_size
string

units or packages. if not defined default usage size of the item is used

price
number

price without Vat. use either this or price with vat -field (not both) in your request if you like to set the article price manually. if there is no price the list price of the item is used

price_with_vat
number

price that includes Vat. this is only used if price-field is not defined

vat_percentage
number

If not defined, default VAT percentage of the item is used

Responses

Request samples

Content type
application/json
{
  • "item": "string",
  • "patient": "string",
  • "name": "string",
  • "print_name": "string",
  • "quantity": 0,
  • "usage_size": "string",
  • "price": 0,
  • "price_with_vat": 0,
  • "vat_percentage": 0
}

Add new item to Counter Sale

Add new item to Counter Sale

Required permissions:

  • Financial: Can access / edit invoices

This endpoint is rate-limited to 100 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this invoice.

Request Body schema: application/json
item
required
string

Item to be added. URL to item instance

patient
string

Patient for the invoice row

name
string

If not defined, item name is used

print_name
string

If not defined, item print name is used

quantity
required
number

The amount sold. usage size defines if the amount is units or packages

usage_size
string

units or packages. if not defined default usage size of the item is used

price
number

price without Vat. use either this or price with vat -field (not both) in your request if you like to set the article price manually. if there is no price the list price of the item is used

price_with_vat
number

price that includes Vat. this is only used if price-field is not defined

vat_percentage
number

If not defined, default VAT percentage of the item is used

Responses

Request samples

Content type
application/json
{
  • "item": "string",
  • "patient": "string",
  • "name": "string",
  • "print_name": "string",
  • "quantity": 0,
  • "usage_size": "string",
  • "price": 0,
  • "price_with_vat": 0,
  • "vat_percentage": 0
}

Finalize Counter Sale

Finalize Counter Sale

Updates are not allowed after finalizing the Counter Sale.

Required permissions:

  • Financial: Can access / edit invoices

This endpoint is rate-limited to 100 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this invoice.

Request Body schema: application/json
department
required
string
client
string
tags_rel
Array of strings
invoice_row
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "department": "string",
  • "client": "string",
  • "tags_rel": [
    ],
  • "invoice_row": [
    ]
}

Finalize Counter Sale

Finalize Counter Sale

Updates are not allowed after finalizing the Counter Sale.

Required permissions:

  • Financial: Can access / edit invoices

This endpoint is rate-limited to 100 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this invoice.

Request Body schema: application/json
department
required
string
client
string
tags_rel
Array of strings
invoice_row
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "department": "string",
  • "client": "string",
  • "tags_rel": [
    ],
  • "invoice_row": [
    ]
}

Backdate invoice

Backdate invoice

Used for backdating the invoice by manually setting invoice_date. Sets both invoice_date and manual_invoice_date to preserve the invoice_date when invoice is finalized. Not for general use.

  • Requires api_staff_token access token to use
  • This endpoint is only enabled for select few provets.

Parameters:

  • invoice_date (datetime) - ISO 8601 format
  • api_staff_token (string) - token for authenticating the request

Required permissions:

  • Financial: Can access / edit invoices

This endpoint is rate-limited to 100 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this invoice.

Request Body schema: application/json
invoice_date
required
string

Responses

Request samples

Content type
application/json
{
  • "invoice_date": "string"
}

Create consultation

Get Consultations

Get Consultations

Some filters require special values.

  • status:
    • ADMITTED = 0
    • DRAFT = 11
    • CONSULTATION = 8
    • WAITING_FOR_DISCHARGE = 5
    • DISCHARGED = 6
    • INVOICE_PAID = 9
    • FINALIZED = 10
  • type:
    • INPATIENT = 0
    • OUTPATIENT = 1
    • HOME_CALL = 2

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

ordering
string

Which field to use when ordering the results.

Responses

Create new Consultation

Create new Consultation

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

Request Body schema: application/json
client
required
string
patients
required
Array of strings
complaint
string
complaint_type
string
admitted_time
string
first_entry
string
started
string
finished
string
ended
string
status
string
type
required
string
invoice
required
string
supervising_veterinarian
required
string
department
required
string
consultation_items
required
Array of strings
reporting_dimension_1
string

Reporting dimension 1 id can be found on active Reporting dimension 1 list

reporting_dimension_2
string

Reporting dimension 2 id can be found on active Reporting dimension 2 list

consultation_notes
required
Array of strings
consultation_diagnosis
required
Array of strings
consultation_dischargeinstructions
required
Array of strings
consultation_patient_status
required
Array of strings
triage
required
string
external_sent
string
ward
required
string
patient_location
required
string
integration_status
integer
holding_place_number
required
Array of strings
report_to_authorities
boolean
custom_fields
required
string

Responses

Request samples

Content type
application/json
{
  • "client": "string",
  • "patients": [
    ],
  • "complaint": "string",
  • "complaint_type": "string",
  • "admitted_time": "string",
  • "first_entry": "string",
  • "started": "string",
  • "finished": "string",
  • "ended": "string",
  • "status": "string",
  • "type": "string",
  • "invoice": "string",
  • "supervising_veterinarian": "string",
  • "department": "string",
  • "consultation_items": [
    ],
  • "reporting_dimension_1": "string",
  • "reporting_dimension_2": "string",
  • "consultation_notes": [
    ],
  • "consultation_diagnosis": [
    ],
  • "consultation_dischargeinstructions": [
    ],
  • "consultation_patient_status": [
    ],
  • "triage": "string",
  • "external_sent": "string",
  • "ward": "string",
  • "patient_location": "string",
  • "integration_status": 0,
  • "holding_place_number": [
    ],
  • "report_to_authorities": true,
  • "custom_fields": "string"
}

Get Consultation by ID

Get Consultation by ID

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this consultation.

query Parameters
ordering
string

Which field to use when ordering the results.

Responses

Consultation

Consultation

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this consultation.

query Parameters
ordering
string

Which field to use when ordering the results.

Request Body schema: application/json
client
required
string
patients
required
Array of strings
complaint
string
complaint_type
string
admitted_time
string
first_entry
string
started
string
finished
string
ended
string
status
string
type
required
string
invoice
required
string
supervising_veterinarian
required
string
department
required
string
consultation_items
required
Array of strings
reporting_dimension_1
string

Reporting dimension 1 id can be found on active Reporting dimension 1 list

reporting_dimension_2
string

Reporting dimension 2 id can be found on active Reporting dimension 2 list

consultation_notes
required
Array of strings
consultation_diagnosis
required
Array of strings
consultation_dischargeinstructions
required
Array of strings
consultation_patient_status
required
Array of strings
triage
required
string
external_sent
string
ward
required
string
patient_location
required
string
integration_status
integer
holding_place_number
required
Array of strings
report_to_authorities
boolean
custom_fields
required
string

Responses

Request samples

Content type
application/json
{
  • "client": "string",
  • "patients": [
    ],
  • "complaint": "string",
  • "complaint_type": "string",
  • "admitted_time": "string",
  • "first_entry": "string",
  • "started": "string",
  • "finished": "string",
  • "ended": "string",
  • "status": "string",
  • "type": "string",
  • "invoice": "string",
  • "supervising_veterinarian": "string",
  • "department": "string",
  • "consultation_items": [
    ],
  • "reporting_dimension_1": "string",
  • "reporting_dimension_2": "string",
  • "consultation_notes": [
    ],
  • "consultation_diagnosis": [
    ],
  • "consultation_dischargeinstructions": [
    ],
  • "consultation_patient_status": [
    ],
  • "triage": "string",
  • "external_sent": "string",
  • "ward": "string",
  • "patient_location": "string",
  • "integration_status": 0,
  • "holding_place_number": [
    ],
  • "report_to_authorities": true,
  • "custom_fields": "string"
}

Consultation

Consultation

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this consultation.

query Parameters
ordering
string

Which field to use when ordering the results.

Request Body schema: application/json
client
string
patients
Array of strings
complaint
string
complaint_type
string
admitted_time
string
first_entry
string
started
string
finished
string
ended
string
status
string
type
string
invoice
string
supervising_veterinarian
string
department
string
consultation_items
Array of strings
reporting_dimension_1
string

Reporting dimension 1 id can be found on active Reporting dimension 1 list

reporting_dimension_2
string

Reporting dimension 2 id can be found on active Reporting dimension 2 list

consultation_notes
Array of strings
consultation_diagnosis
Array of strings
consultation_dischargeinstructions
Array of strings
consultation_patient_status
Array of strings
triage
string
external_sent
string
ward
string
patient_location
string
integration_status
integer
holding_place_number
Array of strings
report_to_authorities
boolean
custom_fields
string

Responses

Request samples

Content type
application/json
{
  • "client": "string",
  • "patients": [
    ],
  • "complaint": "string",
  • "complaint_type": "string",
  • "admitted_time": "string",
  • "first_entry": "string",
  • "started": "string",
  • "finished": "string",
  • "ended": "string",
  • "status": "string",
  • "type": "string",
  • "invoice": "string",
  • "supervising_veterinarian": "string",
  • "department": "string",
  • "consultation_items": [
    ],
  • "reporting_dimension_1": "string",
  • "reporting_dimension_2": "string",
  • "consultation_notes": [
    ],
  • "consultation_diagnosis": [
    ],
  • "consultation_dischargeinstructions": [
    ],
  • "consultation_patient_status": [
    ],
  • "triage": "string",
  • "external_sent": "string",
  • "ward": "string",
  • "patient_location": "string",
  • "integration_status": 0,
  • "holding_place_number": [
    ],
  • "report_to_authorities": true,
  • "custom_fields": "string"
}

External sent timestamp

External sent timestamp

Allows setting timestamp for external sent field (default null/None) the API can filter consultations according to this field.

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 100 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this consultation.

Responses

External sent timestamp

External sent timestamp

Allows setting timestamp for external sent field (default null/None) the API can filter consultations according to this field.

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 100 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this consultation.

Request Body schema: application/json
external_sent
string

Responses

Request samples

Content type
application/json
{
  • "external_sent": "string"
}

External sent timestamp

External sent timestamp

Allows setting timestamp for external sent field (default null/None) the API can filter consultations according to this field.

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 100 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this consultation.

Request Body schema: application/json
external_sent
string

Responses

Request samples

Content type
application/json
{
  • "external_sent": "string"
}

External sent timestamp

External sent timestamp

Allows setting timestamp for external sent field (default null/None) the API can filter consultations according to this field.

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 100 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this consultation.

Request Body schema: application/json
external_sent
string

Responses

Request samples

Content type
application/json
{
  • "external_sent": "string"
}

Integration status

Integration status

Allows setting an integer value for integration status field (default null/None). The actual meaning for the value is defined by the external system.

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 100 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this consultation.

Responses

Integration status

Integration status

Allows setting an integer value for integration status field (default null/None). The actual meaning for the value is defined by the external system.

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 100 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this consultation.

Request Body schema: application/json
integration_status
integer

Responses

Request samples

Content type
application/json
{
  • "integration_status": 0
}

Integration status

Integration status

Allows setting an integer value for integration status field (default null/None). The actual meaning for the value is defined by the external system.

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 100 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this consultation.

Request Body schema: application/json
integration_status
integer

Responses

Request samples

Content type
application/json
{
  • "integration_status": 0
}

Integration status

Integration status

Allows setting an integer value for integration status field (default null/None). The actual meaning for the value is defined by the external system.

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 100 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this consultation.

Request Body schema: application/json
integration_status
integer

Responses

Request samples

Content type
application/json
{
  • "integration_status": 0
}

Allow updating status from "Arrived" -> "Consultation".

Allow updating status from "Arrived" -> "Consultation". Allow updating status to "Finalized". Do not allow updating status if Consultation is not editable.

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 100 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this consultation.

Request Body schema: application/json
status
required
integer

Responses

Request samples

Content type
application/json
{
  • "status": 0
}

Custom fields

List Values

List Values

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Create new Value

Create new Value

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

Request Body schema: application/json
field
required
integer
value
required
string
object_id
required
integer
compound_values
Array of strings

Responses

Request samples

Content type
application/json
{
  • "field": 0,
  • "value": "string",
  • "object_id": 0,
  • "compound_values": [
    ]
}

Get Value by ID

Get Value by ID

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this custom field value.

Responses

Update Value

Update Value

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this custom field value.

Request Body schema: application/json
field
required
integer
value
required
string
object_id
required
integer
compound_values
Array of strings

Responses

Request samples

Content type
application/json
{
  • "field": 0,
  • "value": "string",
  • "object_id": 0,
  • "compound_values": [
    ]
}

Partially update Value

Partially update Value

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this custom field value.

Request Body schema: application/json
field
integer
value
string
object_id
integer
compound_values
Array of strings

Responses

Request samples

Content type
application/json
{
  • "field": 0,
  • "value": "string",
  • "object_id": 0,
  • "compound_values": [
    ]
}

Archive Value

Archive Value

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this custom field value.

Responses

Required permissions:

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 100 requests per minute.

path Parameters
parent_lookup_custom_field
required
string
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Required permissions:

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_custom_field
required
string

Responses

Required permissions:

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_custom_field
required
string
id
required
integer

A unique integer value identifying this custom field option value.

Responses

Required permissions:

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_custom_field
required
string
id
required
integer

A unique integer value identifying this custom field option value.

Responses

Required permissions:

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_custom_field
required
string
id
required
integer

A unique integer value identifying this custom field option value.

Responses

Required permissions:

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_custom_field
required
string
id
required
integer

A unique integer value identifying this custom field option value.

Responses

List Fields

List Fields

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Get Field by ID

Get Field by ID

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this custom field.

Responses

Departments

List Departments

List Departments

This endpoint is rate-limited to 300 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Get Department by ID

Get Department by ID

This endpoint is rate-limited to 1200 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this department.

Responses

List Patient Locations

List Patient Locations

Required permissions:

  • Settings: Can access / edit department settings

This endpoint is rate-limited to 100 requests per minute.

path Parameters
parent_lookup_department
required
string
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Create new Patient Location

Create new Patient Location

Required permissions:

  • Settings: Can access / edit department settings

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_department
required
string
Request Body schema: application/json
name
required
string
is_active
boolean
capacity
integer
boarding
boolean

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "is_active": true,
  • "capacity": 0,
  • "boarding": true
}

Get Patient Location by ID

Get Patient Location by ID

Required permissions:

  • Settings: Can access / edit department settings

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_department
required
string
id
required
integer

A unique integer value identifying this patient location.

Responses

Update Patient Location

Update Patient Location

Required permissions:

  • Settings: Can access / edit department settings

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_department
required
string
id
required
integer

A unique integer value identifying this patient location.

Request Body schema: application/json
name
required
string
is_active
boolean
capacity
integer
boarding
boolean

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "is_active": true,
  • "capacity": 0,
  • "boarding": true
}

Partially update Patient Location

Partially update Patient Location

Required permissions:

  • Settings: Can access / edit department settings

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_department
required
string
id
required
integer

A unique integer value identifying this patient location.

Request Body schema: application/json
name
string
is_active
boolean
capacity
integer
boarding
boolean

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "is_active": true,
  • "capacity": 0,
  • "boarding": true
}

Archive Patient Location

Archive Patient Location

Required permissions:

  • Settings: Can access / edit department settings

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_department
required
string
id
required
integer

A unique integer value identifying this patient location.

Responses

List Settings

List Settings

Required permissions:

  • Settings: Can access / edit department settings

This endpoint is rate-limited to 100 requests per minute.

path Parameters
parent_lookup_department
required
string

Responses

List Teams

List Teams

Required permissions:

  • Settings: Can access / edit department settings

This endpoint is rate-limited to 100 requests per minute.

path Parameters
parent_lookup_department
required
string
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Create new Team

Create new Team

Required permissions:

  • Settings: Can access / edit department settings

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_department
required
string
Request Body schema: application/json
name
required
string
code
required
string
ward
required
string
is_active
boolean

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "code": "string",
  • "ward": "string",
  • "is_active": true
}

Get Team by ID

Get Team by ID

Required permissions:

  • Settings: Can access / edit department settings

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_department
required
string
id
required
integer

A unique integer value identifying this team.

Responses

Update Team

Update Team

Required permissions:

  • Settings: Can access / edit department settings

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_department
required
string
id
required
integer

A unique integer value identifying this team.

Request Body schema: application/json
name
required
string
code
required
string
ward
required
string
is_active
boolean

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "code": "string",
  • "ward": "string",
  • "is_active": true
}

Partially update Team

Partially update Team

Required permissions:

  • Settings: Can access / edit department settings

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_department
required
string
id
required
integer

A unique integer value identifying this team.

Request Body schema: application/json
name
string
code
string
ward
string
is_active
boolean

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "code": "string",
  • "ward": "string",
  • "is_active": true
}

Archive Team

Archive Team

Required permissions:

  • Settings: Can access / edit department settings

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_department
required
string
id
required
integer

A unique integer value identifying this team.

Responses

List Wards

List Wards

Required permissions:

  • Settings: Can access / edit department settings

This endpoint is rate-limited to 100 requests per minute.

path Parameters
parent_lookup_department
required
string
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Create new Ward

Create new Ward

Required permissions:

  • Settings: Can access / edit department settings

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_department
required
string
Request Body schema: application/json
name
required
string
code
required
string
is_active
boolean

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "code": "string",
  • "is_active": true
}

Get Ward by ID

Get Ward by ID

Required permissions:

  • Settings: Can access / edit department settings

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_department
required
string
id
required
integer

A unique integer value identifying this ward.

Responses

Update Ward

Update Ward

Required permissions:

  • Settings: Can access / edit department settings

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_department
required
string
id
required
integer

A unique integer value identifying this ward.

Request Body schema: application/json
name
required
string
code
required
string
is_active
boolean

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "code": "string",
  • "is_active": true
}

Partially update Ward

Partially update Ward

Required permissions:

  • Settings: Can access / edit department settings

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_department
required
string
id
required
integer

A unique integer value identifying this ward.

Request Body schema: application/json
name
string
code
string
is_active
boolean

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "code": "string",
  • "is_active": true
}

Archive Ward

Archive Ward

Required permissions:

  • Settings: Can access / edit department settings

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_department
required
string
id
required
integer

A unique integer value identifying this ward.

Responses

List Groups

List Groups

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Get Group by ID

Get Group by ID

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this department group.

Responses

Diagnostic imaging

List Referrals

List Referrals

Required permissions:

  • Diagnostic imaging: Can access / edit diagnostic imaging referrals

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Create new Referral

Create new Referral

Required permissions:

  • Diagnostic imaging: Can access / edit diagnostic imaging referrals

This endpoint is rate-limited to 300 requests per minute.

Request Body schema: application/json
external_id
string
department
required
string
consultation
string
appointment
string
ward
string
worklist
string
client
required
string
patient
required
string
status
string
referral_remarks
string
answer_remarks
string
internal_notes
string
internal_notes_user
string
internal_notes_modified
string
referral_remarks_user
string
referral_remarks_modified
string
answer_remarks_modified
string
answer_remarks_user
string
diagnosis
string
diagnosis_user
string
diagnosis_modified
string
created_user
string
modified_user
string

Responses

Request samples

Content type
application/json
{
  • "external_id": "string",
  • "department": "string",
  • "consultation": "string",
  • "appointment": "string",
  • "ward": "string",
  • "worklist": "string",
  • "client": "string",
  • "patient": "string",
  • "status": "string",
  • "referral_remarks": "string",
  • "answer_remarks": "string",
  • "internal_notes": "string",
  • "internal_notes_user": "string",
  • "internal_notes_modified": "string",
  • "referral_remarks_user": "string",
  • "referral_remarks_modified": "string",
  • "answer_remarks_modified": "string",
  • "answer_remarks_user": "string",
  • "diagnosis": "string",
  • "diagnosis_user": "string",
  • "diagnosis_modified": "string",
  • "created_user": "string",
  • "modified_user": "string"
}

Get Referral by ID

Get Referral by ID

Required permissions:

  • Diagnostic imaging: Can access / edit diagnostic imaging referrals

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this diagnostic imaging referral.

Responses

Update Referral

Update Referral

Required permissions:

  • Diagnostic imaging: Can access / edit diagnostic imaging referrals

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this diagnostic imaging referral.

Request Body schema: application/json
external_id
string
department
required
string
consultation
string
appointment
string
ward
string
worklist
string
client
required
string
patient
required
string
status
string
referral_remarks
string
answer_remarks
string
internal_notes
string
internal_notes_user
string
internal_notes_modified
string
referral_remarks_user
string
referral_remarks_modified
string
answer_remarks_modified
string
answer_remarks_user
string
diagnosis
string
diagnosis_user
string
diagnosis_modified
string
created_user
string
modified_user
string

Responses

Request samples

Content type
application/json
{
  • "external_id": "string",
  • "department": "string",
  • "consultation": "string",
  • "appointment": "string",
  • "ward": "string",
  • "worklist": "string",
  • "client": "string",
  • "patient": "string",
  • "status": "string",
  • "referral_remarks": "string",
  • "answer_remarks": "string",
  • "internal_notes": "string",
  • "internal_notes_user": "string",
  • "internal_notes_modified": "string",
  • "referral_remarks_user": "string",
  • "referral_remarks_modified": "string",
  • "answer_remarks_modified": "string",
  • "answer_remarks_user": "string",
  • "diagnosis": "string",
  • "diagnosis_user": "string",
  • "diagnosis_modified": "string",
  • "created_user": "string",
  • "modified_user": "string"
}

Partially update Referral

Partially update Referral

Required permissions:

  • Diagnostic imaging: Can access / edit diagnostic imaging referrals

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this diagnostic imaging referral.

Request Body schema: application/json
external_id
string
department
string
consultation
string
appointment
string
ward
string
worklist
string
client
string
patient
string
status
string
referral_remarks
string
answer_remarks
string
internal_notes
string
internal_notes_user
string
internal_notes_modified
string
referral_remarks_user
string
referral_remarks_modified
string
answer_remarks_modified
string
answer_remarks_user
string
diagnosis
string
diagnosis_user
string
diagnosis_modified
string
created_user
string
modified_user
string

Responses

Request samples

Content type
application/json
{
  • "external_id": "string",
  • "department": "string",
  • "consultation": "string",
  • "appointment": "string",
  • "ward": "string",
  • "worklist": "string",
  • "client": "string",
  • "patient": "string",
  • "status": "string",
  • "referral_remarks": "string",
  • "answer_remarks": "string",
  • "internal_notes": "string",
  • "internal_notes_user": "string",
  • "internal_notes_modified": "string",
  • "referral_remarks_user": "string",
  • "referral_remarks_modified": "string",
  • "answer_remarks_modified": "string",
  • "answer_remarks_user": "string",
  • "diagnosis": "string",
  • "diagnosis_user": "string",
  • "diagnosis_modified": "string",
  • "created_user": "string",
  • "modified_user": "string"
}

Archive Referral

Archive Referral

Required permissions:

  • Diagnostic imaging: Can access / edit diagnostic imaging referrals

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this diagnostic imaging referral.

Responses

List Worklists

List Worklists

gender values:

  • Unknown = 0
  • Male = 1
  • Female = 2
  • Male fixed = 3
  • Female fixed = 4

status values:

  • Not started = 0
  • Pending = 1
  • Ready (This api lists only not ready items) = 2

list_format values:

  • None = 0
  • AGFA = 1
  • DICOM = 2

Required permissions:

  • Diagnostic imaging: Can access / edit diagnostic imaging referrals

This endpoint is rate-limited to 250 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

department
string

Responses

Create new Worklist

Create new Worklist

Required permissions:

  • Diagnostic imaging: Can access / edit diagnostic imaging referrals

This endpoint is rate-limited to 300 requests per minute.

Request Body schema: application/json
department
required
integer
date
string
status
string
consultation_id
integer
supervising_veterinarian
required
string
user
required
string
user_initials
string
modality
required
string
modality_type
required
integer
modality_procedure
string
modality_dicom_ae_title
required
string
modality_callsign
required
string
modality_list_format
required
integer
referral_remarks
required
string
supervising_veterinarian_user_initials
string
client
required
integer
patient
required
integer
patient_id
required
integer
patient_name
required
string
patient_date_of_birth
required
string
patient_gender
required
integer
patient_remarks
required
string
referral_id
integer
time
string

Responses

Request samples

Content type
application/json
{
  • "department": 0,
  • "date": "string",
  • "status": "string",
  • "consultation_id": 0,
  • "supervising_veterinarian": "string",
  • "user": "string",
  • "user_initials": "string",
  • "modality": "string",
  • "modality_type": 0,
  • "modality_procedure": "string",
  • "modality_dicom_ae_title": "string",
  • "modality_callsign": "string",
  • "modality_list_format": 0,
  • "referral_remarks": "string",
  • "supervising_veterinarian_user_initials": "string",
  • "client": 0,
  • "patient": 0,
  • "patient_id": 0,
  • "patient_name": "string",
  • "patient_date_of_birth": "string",
  • "patient_gender": 0,
  • "patient_remarks": "string",
  • "referral_id": 0,
  • "time": "string"
}

Get Worklist by ID

Get Worklist by ID

Required permissions:

  • Diagnostic imaging: Can access / edit diagnostic imaging referrals

This endpoint is rate-limited to 1000 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this diagnostic imaging worklist.

query Parameters
department
string

Responses

Update Worklist

Update Worklist

Required permissions:

  • Diagnostic imaging: Can access / edit diagnostic imaging referrals

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this diagnostic imaging worklist.

query Parameters
department
string
Request Body schema: application/json
department
required
integer
date
string
status
string
consultation_id
integer
supervising_veterinarian
required
string
user
required
string
user_initials
string
modality
required
string
modality_type
required
integer
modality_procedure
string
modality_dicom_ae_title
required
string
modality_callsign
required
string
modality_list_format
required
integer
referral_remarks
required
string
supervising_veterinarian_user_initials
string
client
required
integer
patient
required
integer
patient_id
required
integer
patient_name
required
string
patient_date_of_birth
required
string
patient_gender
required
integer
patient_remarks
required
string
referral_id
integer
time
string

Responses

Request samples

Content type
application/json
{
  • "department": 0,
  • "date": "string",
  • "status": "string",
  • "consultation_id": 0,
  • "supervising_veterinarian": "string",
  • "user": "string",
  • "user_initials": "string",
  • "modality": "string",
  • "modality_type": 0,
  • "modality_procedure": "string",
  • "modality_dicom_ae_title": "string",
  • "modality_callsign": "string",
  • "modality_list_format": 0,
  • "referral_remarks": "string",
  • "supervising_veterinarian_user_initials": "string",
  • "client": 0,
  • "patient": 0,
  • "patient_id": 0,
  • "patient_name": "string",
  • "patient_date_of_birth": "string",
  • "patient_gender": 0,
  • "patient_remarks": "string",
  • "referral_id": 0,
  • "time": "string"
}

Partially update Worklist

Partially update Worklist

Required permissions:

  • Diagnostic imaging: Can access / edit diagnostic imaging referrals

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this diagnostic imaging worklist.

query Parameters
department
string
Request Body schema: application/json
department
integer
date
string
status
string
consultation_id
integer
supervising_veterinarian
string
user
string
user_initials
string
modality
string
modality_type
integer
modality_procedure
string
modality_dicom_ae_title
string
modality_callsign
string
modality_list_format
integer
referral_remarks
string
supervising_veterinarian_user_initials
string
client
integer
patient
integer
patient_id
integer
patient_name
string
patient_date_of_birth
string
patient_gender
integer
patient_remarks
string
referral_id
integer
time
string

Responses

Request samples

Content type
application/json
{
  • "department": 0,
  • "date": "string",
  • "status": "string",
  • "consultation_id": 0,
  • "supervising_veterinarian": "string",
  • "user": "string",
  • "user_initials": "string",
  • "modality": "string",
  • "modality_type": 0,
  • "modality_procedure": "string",
  • "modality_dicom_ae_title": "string",
  • "modality_callsign": "string",
  • "modality_list_format": 0,
  • "referral_remarks": "string",
  • "supervising_veterinarian_user_initials": "string",
  • "client": 0,
  • "patient": 0,
  • "patient_id": 0,
  • "patient_name": "string",
  • "patient_date_of_birth": "string",
  • "patient_gender": 0,
  • "patient_remarks": "string",
  • "referral_id": 0,
  • "time": "string"
}

Archive Worklist

Archive Worklist

Required permissions:

  • Diagnostic imaging: Can access / edit diagnostic imaging referrals

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this diagnostic imaging worklist.

query Parameters
department
string

Responses

Discount schemes

List Discount schemes

List Discount schemes

Required permissions:

  • Settings: Can access / edit discount settings

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

ordering
string

Which field to use when ordering the results.

Responses

Create a new Discount scheme

Create a new Discount scheme

Required permissions:

  • Settings: Can access / edit discount settings

This endpoint is rate-limited to 300 requests per minute.

Request Body schema: application/json
name
required
string
default_discount
number
minimum_sum
number
internal_notes
string
archived
boolean
department
required
string
start_date
string
end_date
string
times
required
Array of strings
items
required
Array of strings
targets
required
Array of strings
bulk_discounts
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "default_discount": 0,
  • "minimum_sum": 0,
  • "internal_notes": "string",
  • "archived": true,
  • "department": "string",
  • "start_date": "string",
  • "end_date": "string",
  • "times": [
    ],
  • "items": [
    ],
  • "targets": [
    ],
  • "bulk_discounts": [
    ]
}

Get Discount scheme by ID

Get Discount scheme by ID

Required permissions:

  • Settings: Can access / edit discount settings

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this discount scheme.

query Parameters
ordering
string

Which field to use when ordering the results.

Responses

Update a Discount scheme

Update a Discount scheme

Required permissions:

  • Settings: Can access / edit discount settings

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this discount scheme.

query Parameters
ordering
string

Which field to use when ordering the results.

Request Body schema: application/json
name
required
string
default_discount
number
minimum_sum
number
internal_notes
string
archived
boolean
department
required
string
start_date
string
end_date
string
times
required
Array of strings
items
required
Array of strings
targets
required
Array of strings
bulk_discounts
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "default_discount": 0,
  • "minimum_sum": 0,
  • "internal_notes": "string",
  • "archived": true,
  • "department": "string",
  • "start_date": "string",
  • "end_date": "string",
  • "times": [
    ],
  • "items": [
    ],
  • "targets": [
    ],
  • "bulk_discounts": [
    ]
}

Partially update a Discount scheme

Partially update a Discount scheme

Required permissions:

  • Settings: Can access / edit discount settings

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this discount scheme.

query Parameters
ordering
string

Which field to use when ordering the results.

Request Body schema: application/json
name
string
default_discount
number
minimum_sum
number
internal_notes
string
archived
boolean
department
string
start_date
string
end_date
string
times
Array of strings
items
Array of strings
targets
Array of strings
bulk_discounts
Array of strings

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "default_discount": 0,
  • "minimum_sum": 0,
  • "internal_notes": "string",
  • "archived": true,
  • "department": "string",
  • "start_date": "string",
  • "end_date": "string",
  • "times": [
    ],
  • "items": [
    ],
  • "targets": [
    ],
  • "bulk_discounts": [
    ]
}

Archives an item.

Archives an item.

Required permissions:

  • Settings: Can access / edit discount settings

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this discount scheme.

query Parameters
ordering
string

Which field to use when ordering the results.

Responses

List Discount scheme bulk discounts

List Discount scheme bulk discounts

Required permissions:

  • Settings: Can access / edit discount settings

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Get Discount scheme bulk discount by ID

Get Discount scheme bulk discount by ID

Required permissions:

  • Settings: Can access / edit discount settings

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this discount scheme bulk discount.

Responses

List Discount scheme items

List Discount scheme items

Rule type values:

  • 0 = Item types
  • 1 = Item subgroups
  • 2 = Items
  • 3 = Fixed price templates

Item types values:

  • 1 = Procedure
  • 2 = Medicine
  • 3 = Supply
  • 4 = Food
  • 5 = Laboratory analysis
  • 6 = Laboratory analysis group

Required permissions:

  • Settings: Can access / edit discount settings

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Get Discount scheme item by ID

Get Discount scheme item by ID

Required permissions:

  • Settings: Can access / edit discount settings

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this discount scheme item.

Responses

List Discount scheme targets

List Discount scheme targets

Rule type values:

  • 0 = Tags
  • 1 = Clients
  • 2 = Patients
  • 3 = Species
  • 4 = All clients

Required permissions:

  • Settings: Can access / edit discount settings

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Get Discount scheme target by ID

Get Discount scheme target by ID

Required permissions:

  • Settings: Can access / edit discount settings

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this discount scheme target.

Responses

List Discount scheme times

List Discount scheme times

Rule type values:

  • 0 = Valid only
  • 1 = Not valid

Weekday values:

  • 1 = Monday
  • 2 = Tuesday
  • 3 = Wednesday
  • 4 = Thursday
  • 5 = Friday
  • 6 = Saturday
  • 7 = Sunday

Required permissions:

  • Settings: Can access / edit discount settings

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Get Discount scheme time by ID

Get Discount scheme time by ID

Required permissions:

  • Settings: Can access / edit discount settings

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this discount scheme time.

Responses

End of day reports

List Reports

List Reports

Required permissions:

  • Financial: Can access / edit end of day and accounting reports

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Get Report by ID

Get Report by ID

Required permissions:

  • Financial: Can access / edit end of day and accounting reports

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this cash report.

Responses

Electronic prescriptions

List Prescriptions

List Prescriptions

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

ordering
string

Which field to use when ordering the results.

Responses

Get Prescription by ID

Get Prescription by ID

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this prescription.

query Parameters
ordering
string

Which field to use when ordering the results.

Responses

List Items

List Items

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

ordering
string

Which field to use when ordering the results.

Responses

Get Item by ID

Get Item by ID

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this prescription item.

query Parameters
ordering
string

Which field to use when ordering the results.

Responses

Estimates

List Estimates

List Estimates

Required permissions:

  • Financial: Can access / edit estimates

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Get Estimate by ID

Get Estimate by ID

Required permissions:

  • Financial: Can access / edit estimates

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this estimate.

Responses

List Items

List Items

Required permissions:

  • Financial: Can access / edit estimates

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Get Item by ID

Get Item by ID

Required permissions:

  • Financial: Can access / edit estimates

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this estimate item.

Responses

Foods

List Foods

List Foods

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

ordering
string

Which field to use when ordering the results.

include_archived
string

Set to 'true' to include archived items in results

Responses

Create new Food

Create new Food Price calculations documentation:

  • wholesale_price (Purchase price) will never be automatically calculated.
  • If providing margin_percent (Markup Percentage) → price (Selling price) and price_with_vat (Selling price with VAT) will change according to wholesale_price and margin_percent.
  • If providing price or price_with_vat → margin_percent will change according to wholesale_price and new price.
  • If wholesale_price and price are set to 0 → margin_percent will not change.
  • If wholesale_price is set to 0 (without price or price_with_vat) → Will Raise an error.
  • If disable_price_calculation is True:
    • If providing wholesale_price → margin_percent will change according to wholesale_price and price.
  • If disable_price_calculation is False:
    • If providing wholesale_price → price and price_with_vat will change according to wholesale_price and margin_percent.

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 300 requests per minute.

query Parameters
include_archived
string

Set to 'true' to include archived items in results

Request Body schema: application/json
main_item
string
code
string
barcode
string
account_number
string
name
required
string
print_name
string
hide_on_consultation
boolean
price
number
price_with_vat
number
minimum_price
number
minimum_price_with_vat
number
wholesale_price
number
wholesaler_discount
number
producer_discount
number
special_discount
number
margin_percent
number
vat_group
required
string
invoice_group
string
item_list
required
string
type_code
required
string

ITEM_TYPE_PROCEDURE = 1, ITEM_TYPE_MEDICINE = 2, ITEM_TYPE_SUPPLY = 3, ITEM_TYPE_FOOD = 4, ITEM_TYPE_LABORATORY_ANALYSIS = 5, ITEM_TYPE_LABORATORY_ANALYSIS_PANEL = 6

parent_amount
number
instructions
string
archived
boolean
archived_datetime
string
exclude_discount
boolean
hide_zero_print
boolean
linked_items
Array of strings
reporting_dimension_1
string

Primarily code is used, if not found id is used

reporting_dimension_2
string

Primarily code is used, if not found id is used

hide_on_countersale_search
boolean
performed_by_rule
string

PERFORMED_BY_INHERIT = 0, PERFORMED_BY_REQUIRED = 1, PERFORMED_BY_NOT_REQUIRED = 2

royalty_fee
integer
external_reporting_code
string
external_reporting_code_2
string
external_reporting_code_3
string
hide_on_consultation_search
boolean
disable_price_calculation
boolean
species
Array of strings
no_department_rates
boolean
related_diagnoses_groups
Array of strings
conditional_price_overrides
Array of strings
primary_wholesaler
string
primary_wholesaler_code
string
secondary_wholesaler
string
secondary_wholesaler_code
string
alert_level
number
internal_instructions
string
is_cabinet_item
boolean
discontinued_product
boolean

These items can no longer be added into orders

unit
string

"Unit description" in the UI.

default_order_amount
number
manufacturer
object
shelf_location
string
manufacturer_data
string
manufacturer_url
string
optimum_level
number
usage_type
string

USAGE_TYPE_ADMINISTERED = 1, USAGE_TYPE_GIVEN = 2, USAGE_TYPE_PRESCRIPTION = 3

dosage_units
number

"Units in the package" in the UI.

minimum_dosage_units
number
default_usage_size
string

USAGE_SIZE_PACKAGE = 1, USAGE_SIZE_DOSAGE_UNITS = 2

package_description
string
not_in_stock_management
boolean
batch_number_required
boolean
minimum_charge
number
minimum_charge_with_vat
number

Responses

Request samples

Content type
application/json
{
  • "main_item": "string",
  • "code": "string",
  • "barcode": "string",
  • "account_number": "string",
  • "name": "string",
  • "print_name": "string",
  • "hide_on_consultation": true,
  • "price": 0,
  • "price_with_vat": 0,
  • "minimum_price": 0,
  • "minimum_price_with_vat": 0,
  • "wholesale_price": 0,
  • "wholesaler_discount": 0,
  • "producer_discount": 0,
  • "special_discount": 0,
  • "margin_percent": 0,
  • "vat_group": "string",
  • "invoice_group": "string",
  • "item_list": "string",
  • "type_code": "string",
  • "parent_amount": 0,
  • "instructions": "string",
  • "archived": true,
  • "archived_datetime": "string",
  • "exclude_discount": true,
  • "hide_zero_print": true,
  • "linked_items": [
    ],
  • "reporting_dimension_1": "string",
  • "reporting_dimension_2": "string",
  • "hide_on_countersale_search": true,
  • "performed_by_rule": "string",
  • "royalty_fee": 0,
  • "external_reporting_code": "string",
  • "external_reporting_code_2": "string",
  • "external_reporting_code_3": "string",
  • "hide_on_consultation_search": true,
  • "disable_price_calculation": true,
  • "species": [
    ],
  • "no_department_rates": true,
  • "related_diagnoses_groups": [
    ],
  • "conditional_price_overrides": [
    ],
  • "primary_wholesaler": "string",
  • "primary_wholesaler_code": "string",
  • "secondary_wholesaler": "string",
  • "secondary_wholesaler_code": "string",
  • "alert_level": 0,
  • "internal_instructions": "string",
  • "is_cabinet_item": true,
  • "discontinued_product": true,
  • "unit": "string",
  • "default_order_amount": 0,
  • "manufacturer": { },
  • "shelf_location": "string",
  • "manufacturer_data": "string",
  • "manufacturer_url": "string",
  • "optimum_level": 0,
  • "usage_type": "string",
  • "dosage_units": 0,
  • "minimum_dosage_units": 0,
  • "default_usage_size": "string",
  • "package_description": "string",
  • "not_in_stock_management": true,
  • "batch_number_required": true,
  • "minimum_charge": 0,
  • "minimum_charge_with_vat": 0
}

Get Food by ID

Get Food by ID

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this food.

query Parameters
ordering
string

Which field to use when ordering the results.

include_archived
string

Set to 'true' to include archived items in results

Responses

Update Food

Update Food

  • Price calculations documentation: check the documentaion in the "Create new Food" (POST /food/)

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this food.

query Parameters
ordering
string

Which field to use when ordering the results.

include_archived
string

Set to 'true' to include archived items in results

Request Body schema: application/json
main_item
string
code
string
barcode
string
account_number
string
name
required
string
print_name
string
hide_on_consultation
boolean
price
number
price_with_vat
number
minimum_price
number
minimum_price_with_vat
number
wholesale_price
number
wholesaler_discount
number
producer_discount
number
special_discount
number
margin_percent
number
vat_group
required
string
invoice_group
string
item_list
required
string
type_code
required
string

ITEM_TYPE_PROCEDURE = 1, ITEM_TYPE_MEDICINE = 2, ITEM_TYPE_SUPPLY = 3, ITEM_TYPE_FOOD = 4, ITEM_TYPE_LABORATORY_ANALYSIS = 5, ITEM_TYPE_LABORATORY_ANALYSIS_PANEL = 6

parent_amount
number
instructions
string
archived
boolean
archived_datetime
string
exclude_discount
boolean
hide_zero_print
boolean
linked_items
Array of strings
reporting_dimension_1
string

Primarily code is used, if not found id is used

reporting_dimension_2
string

Primarily code is used, if not found id is used

hide_on_countersale_search
boolean
performed_by_rule
string

PERFORMED_BY_INHERIT = 0, PERFORMED_BY_REQUIRED = 1, PERFORMED_BY_NOT_REQUIRED = 2

royalty_fee
integer
external_reporting_code
string
external_reporting_code_2
string
external_reporting_code_3
string
hide_on_consultation_search
boolean
disable_price_calculation
boolean
species
Array of strings
no_department_rates
boolean
related_diagnoses_groups
Array of strings
conditional_price_overrides
Array of strings
primary_wholesaler
string
primary_wholesaler_code
string
secondary_wholesaler
string
secondary_wholesaler_code
string
alert_level
number
internal_instructions
string
is_cabinet_item
boolean
discontinued_product
boolean

These items can no longer be added into orders

unit
string

"Unit description" in the UI.

default_order_amount
number
manufacturer
object
shelf_location
string
manufacturer_data
string
manufacturer_url
string
optimum_level
number
usage_type
string

USAGE_TYPE_ADMINISTERED = 1, USAGE_TYPE_GIVEN = 2, USAGE_TYPE_PRESCRIPTION = 3

dosage_units
number

"Units in the package" in the UI.

minimum_dosage_units
number
default_usage_size
string

USAGE_SIZE_PACKAGE = 1, USAGE_SIZE_DOSAGE_UNITS = 2

package_description
string
not_in_stock_management
boolean
batch_number_required
boolean
minimum_charge
number
minimum_charge_with_vat
number

Responses

Request samples

Content type
application/json
{
  • "main_item": "string",
  • "code": "string",
  • "barcode": "string",
  • "account_number": "string",
  • "name": "string",
  • "print_name": "string",
  • "hide_on_consultation": true,
  • "price": 0,
  • "price_with_vat": 0,
  • "minimum_price": 0,
  • "minimum_price_with_vat": 0,
  • "wholesale_price": 0,
  • "wholesaler_discount": 0,
  • "producer_discount": 0,
  • "special_discount": 0,
  • "margin_percent": 0,
  • "vat_group": "string",
  • "invoice_group": "string",
  • "item_list": "string",
  • "type_code": "string",
  • "parent_amount": 0,
  • "instructions": "string",
  • "archived": true,
  • "archived_datetime": "string",
  • "exclude_discount": true,
  • "hide_zero_print": true,
  • "linked_items": [
    ],
  • "reporting_dimension_1": "string",
  • "reporting_dimension_2": "string",
  • "hide_on_countersale_search": true,
  • "performed_by_rule": "string",
  • "royalty_fee": 0,
  • "external_reporting_code": "string",
  • "external_reporting_code_2": "string",
  • "external_reporting_code_3": "string",
  • "hide_on_consultation_search": true,
  • "disable_price_calculation": true,
  • "species": [
    ],
  • "no_department_rates": true,
  • "related_diagnoses_groups": [
    ],
  • "conditional_price_overrides": [
    ],
  • "primary_wholesaler": "string",
  • "primary_wholesaler_code": "string",
  • "secondary_wholesaler": "string",
  • "secondary_wholesaler_code": "string",
  • "alert_level": 0,
  • "internal_instructions": "string",
  • "is_cabinet_item": true,
  • "discontinued_product": true,
  • "unit": "string",
  • "default_order_amount": 0,
  • "manufacturer": { },
  • "shelf_location": "string",
  • "manufacturer_data": "string",
  • "manufacturer_url": "string",
  • "optimum_level": 0,
  • "usage_type": "string",
  • "dosage_units": 0,
  • "minimum_dosage_units": 0,
  • "default_usage_size": "string",
  • "package_description": "string",
  • "not_in_stock_management": true,
  • "batch_number_required": true,
  • "minimum_charge": 0,
  • "minimum_charge_with_vat": 0
}

Partially update Food

Partially update Food

  • Price calculations documentation: check the documentaion in the "Create new Food" (POST /food/)

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this food.

query Parameters
ordering
string

Which field to use when ordering the results.

include_archived
string

Set to 'true' to include archived items in results

Request Body schema: application/json
main_item
string
code
string
barcode
string
account_number
string
name
string
print_name
string
hide_on_consultation
boolean
price
number
price_with_vat
number
minimum_price
number
minimum_price_with_vat
number
wholesale_price
number
wholesaler_discount
number
producer_discount
number
special_discount
number
margin_percent
number
vat_group
string
invoice_group
string
item_list
string
type_code
string

ITEM_TYPE_PROCEDURE = 1, ITEM_TYPE_MEDICINE = 2, ITEM_TYPE_SUPPLY = 3, ITEM_TYPE_FOOD = 4, ITEM_TYPE_LABORATORY_ANALYSIS = 5, ITEM_TYPE_LABORATORY_ANALYSIS_PANEL = 6

parent_amount
number
instructions
string
archived
boolean
archived_datetime
string
exclude_discount
boolean
hide_zero_print
boolean
linked_items
Array of strings
reporting_dimension_1
string

Primarily code is used, if not found id is used

reporting_dimension_2
string

Primarily code is used, if not found id is used

hide_on_countersale_search
boolean
performed_by_rule
string

PERFORMED_BY_INHERIT = 0, PERFORMED_BY_REQUIRED = 1, PERFORMED_BY_NOT_REQUIRED = 2

royalty_fee
integer
external_reporting_code
string
external_reporting_code_2
string
external_reporting_code_3
string
hide_on_consultation_search
boolean
disable_price_calculation
boolean
species
Array of strings
no_department_rates
boolean
related_diagnoses_groups
Array of strings
conditional_price_overrides
Array of strings
primary_wholesaler
string
primary_wholesaler_code
string
secondary_wholesaler
string
secondary_wholesaler_code
string
alert_level
number
internal_instructions
string
is_cabinet_item
boolean
discontinued_product
boolean

These items can no longer be added into orders

unit
string

"Unit description" in the UI.

default_order_amount
number
manufacturer
object
shelf_location
string
manufacturer_data
string
manufacturer_url
string
optimum_level
number
usage_type
string

USAGE_TYPE_ADMINISTERED = 1, USAGE_TYPE_GIVEN = 2, USAGE_TYPE_PRESCRIPTION = 3

dosage_units
number

"Units in the package" in the UI.

minimum_dosage_units
number
default_usage_size
string

USAGE_SIZE_PACKAGE = 1, USAGE_SIZE_DOSAGE_UNITS = 2

package_description
string
not_in_stock_management
boolean
batch_number_required
boolean
minimum_charge
number
minimum_charge_with_vat
number

Responses

Request samples

Content type
application/json
{
  • "main_item": "string",
  • "code": "string",
  • "barcode": "string",
  • "account_number": "string",
  • "name": "string",
  • "print_name": "string",
  • "hide_on_consultation": true,
  • "price": 0,
  • "price_with_vat": 0,
  • "minimum_price": 0,
  • "minimum_price_with_vat": 0,
  • "wholesale_price": 0,
  • "wholesaler_discount": 0,
  • "producer_discount": 0,
  • "special_discount": 0,
  • "margin_percent": 0,
  • "vat_group": "string",
  • "invoice_group": "string",
  • "item_list": "string",
  • "type_code": "string",
  • "parent_amount": 0,
  • "instructions": "string",
  • "archived": true,
  • "archived_datetime": "string",
  • "exclude_discount": true,
  • "hide_zero_print": true,
  • "linked_items": [
    ],
  • "reporting_dimension_1": "string",
  • "reporting_dimension_2": "string",
  • "hide_on_countersale_search": true,
  • "performed_by_rule": "string",
  • "royalty_fee": 0,
  • "external_reporting_code": "string",
  • "external_reporting_code_2": "string",
  • "external_reporting_code_3": "string",
  • "hide_on_consultation_search": true,
  • "disable_price_calculation": true,
  • "species": [
    ],
  • "no_department_rates": true,
  • "related_diagnoses_groups": [
    ],
  • "conditional_price_overrides": [
    ],
  • "primary_wholesaler": "string",
  • "primary_wholesaler_code": "string",
  • "secondary_wholesaler": "string",
  • "secondary_wholesaler_code": "string",
  • "alert_level": 0,
  • "internal_instructions": "string",
  • "is_cabinet_item": true,
  • "discontinued_product": true,
  • "unit": "string",
  • "default_order_amount": 0,
  • "manufacturer": { },
  • "shelf_location": "string",
  • "manufacturer_data": "string",
  • "manufacturer_url": "string",
  • "optimum_level": 0,
  • "usage_type": "string",
  • "dosage_units": 0,
  • "minimum_dosage_units": 0,
  • "default_usage_size": "string",
  • "package_description": "string",
  • "not_in_stock_management": true,
  • "batch_number_required": true,
  • "minimum_charge": 0,
  • "minimum_charge_with_vat": 0
}

Archives an item.

Archives an item.

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this food.

query Parameters
ordering
string

Which field to use when ordering the results.

include_archived
string

Set to 'true' to include archived items in results

Responses

Written prescriptions

Category view for general prescription APIs.

Category view for general prescription APIs.

This view does not require permissions because it only lists other APIs.

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

List Medicine Metadata

List Medicine Metadata

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Get Medicine Metadata by ID

Get Medicine Metadata by ID

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this medicine meta data.

Responses

List General Prescription Items

List General Prescription Items

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Create new General Prescription Item with organization item or provider item

Create new General Prescription Item with organization item or provider item

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 300 requests per minute.

Responses

Get General Prescription Item by ID

Get General Prescription Item by ID

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this general prescription item.

Responses

Delete General Prescription Item

Delete General Prescription Item

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this general prescription item.

Responses

List Written Prescriptions

List Written Prescriptions

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Create new Written Prescription with lists of General Prescription Item

Create new Written Prescription with lists of General Prescription Item

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

Responses

Get Written Prescription by ID

Get Written Prescription by ID

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this written prescription.

Responses

Update Written Prescription

Update Written Prescription

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this written prescription.

Responses

Partially update Written Prescription

Partially update Written Prescription

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this written prescription.

Responses

Archives an item.

Archives an item.

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this written prescription.

Responses

Required permissions:

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Required permissions:

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

Request Body schema: application/json
written_prescription
required
string
external_system
required
string
external_sent_data
string
external_sent_label
string
readonly
boolean

Responses

Request samples

Content type
application/json
{
  • "written_prescription": "string",
  • "external_system": "string",
  • "external_sent_data": "string",
  • "external_sent_label": "string",
  • "readonly": true
}

Required permissions:

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this written prescription extras.

Responses

Required permissions:

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this written prescription extras.

Request Body schema: application/json
written_prescription
required
string
external_system
required
string
external_sent_data
string
external_sent_label
string
readonly
boolean

Responses

Request samples

Content type
application/json
{
  • "written_prescription": "string",
  • "external_system": "string",
  • "external_sent_data": "string",
  • "external_sent_label": "string",
  • "readonly": true
}

Required permissions:

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this written prescription extras.

Request Body schema: application/json
written_prescription
string
external_system
string
external_sent_data
string
external_sent_label
string
readonly
boolean

Responses

Request samples

Content type
application/json
{
  • "written_prescription": "string",
  • "external_system": "string",
  • "external_sent_data": "string",
  • "external_sent_label": "string",
  • "readonly": true
}

Required permissions:

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this written prescription extras.

Responses

Patients

Get latest ID of Patient

Get latest ID of Patient

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 100 requests per minute.

Responses

List Patients

List Patients

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

ordering
string

Which field to use when ordering the results.

Responses

Create new Patient

Create new Patient

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 250 requests per minute.

Request Body schema: application/json
id
integer
client
required
string
name
required
string
official_name
string
species
required
string

species code can be found on active species List

breed
string

Breed code can be found on active breed List

gender
required
string

{"display_name": "Male","value": 1},{"display_name": "Female","value": 2},{"display_name": "Male, neutered","value": 3},{"display_name": "Female, neutered","value": 4},{"display_name": "Unknown","value": 0}

old_patient_id
string
remarks
string
date_of_registration
string
date_of_birth
string
deceased
string
insurance
string
insurance_company
string
color
string
critical_notes
string
microchip
string
additional_identification
string
archived
boolean
reason_of_death
string
stable_name
string
street_address
string
street_address_2
string
zip_code
string
city
string
not_for_food
boolean
passport_number
string
register_number
string
home_department
string
date_imported
string
imported
boolean
tags_rel
Array of strings
fields_rel
Array of strings
holding_place_number
string
animal_code
string
herd_size
integer
private
boolean
visible_departments
Array of strings
visible_department_groups
Array of strings
microchip_date
string
cpr_agreement
string
blood_group
string
last_consultation
string
save_patient_with_duplicates
boolean
picture
string
passport_given
string

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "client": "string",
  • "name": "string",
  • "official_name": "string",
  • "species": "string",
  • "breed": "string",
  • "gender": "string",
  • "old_patient_id": "string",
  • "remarks": "string",
  • "date_of_registration": "string",
  • "date_of_birth": "string",
  • "deceased": "string",
  • "insurance": "string",
  • "insurance_company": "string",
  • "color": "string",
  • "critical_notes": "string",
  • "microchip": "string",
  • "additional_identification": "string",
  • "archived": true,
  • "reason_of_death": "string",
  • "stable_name": "string",
  • "street_address": "string",
  • "street_address_2": "string",
  • "zip_code": "string",
  • "city": "string",
  • "not_for_food": true,
  • "passport_number": "string",
  • "register_number": "string",
  • "home_department": "string",
  • "date_imported": "string",
  • "imported": true,
  • "tags_rel": [
    ],
  • "fields_rel": [
    ],
  • "holding_place_number": "string",
  • "animal_code": "string",
  • "herd_size": 0,
  • "private": true,
  • "visible_departments": [
    ],
  • "visible_department_groups": [
    ],
  • "microchip_date": "string",
  • "cpr_agreement": "string",
  • "blood_group": "string",
  • "last_consultation": "string",
  • "save_patient_with_duplicates": true,
  • "picture": "string",
  • "passport_given": "string"
}

Get Patient by ID

Get Patient by ID

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 1200 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this patient.

query Parameters
ordering
string

Which field to use when ordering the results.

Responses

Update Patient

Update Patient

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 250 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this patient.

query Parameters
ordering
string

Which field to use when ordering the results.

Request Body schema: application/json
id
integer
client
required
string
name
required
string
official_name
string
species
required
string

species code can be found on active species List

breed
string

Breed code can be found on active breed List

gender
required
string

{"display_name": "Male","value": 1},{"display_name": "Female","value": 2},{"display_name": "Male, neutered","value": 3},{"display_name": "Female, neutered","value": 4},{"display_name": "Unknown","value": 0}

old_patient_id
string
remarks
string
date_of_registration
string
date_of_birth
string
deceased
string
insurance
string
insurance_company
string
color
string
critical_notes
string
microchip
string
additional_identification
string
archived
boolean
reason_of_death
string
stable_name
string
street_address
string
street_address_2
string
zip_code
string
city
string
not_for_food
boolean
passport_number
string
register_number
string
home_department
string
date_imported
string
imported
boolean
tags_rel
Array of strings
fields_rel
Array of strings
holding_place_number
string
animal_code
string
herd_size
integer
private
boolean
visible_departments
Array of strings
visible_department_groups
Array of strings
microchip_date
string
cpr_agreement
string
blood_group
string
last_consultation
string
save_patient_with_duplicates
boolean
picture
string
passport_given
string

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "client": "string",
  • "name": "string",
  • "official_name": "string",
  • "species": "string",
  • "breed": "string",
  • "gender": "string",
  • "old_patient_id": "string",
  • "remarks": "string",
  • "date_of_registration": "string",
  • "date_of_birth": "string",
  • "deceased": "string",
  • "insurance": "string",
  • "insurance_company": "string",
  • "color": "string",
  • "critical_notes": "string",
  • "microchip": "string",
  • "additional_identification": "string",
  • "archived": true,
  • "reason_of_death": "string",
  • "stable_name": "string",
  • "street_address": "string",
  • "street_address_2": "string",
  • "zip_code": "string",
  • "city": "string",
  • "not_for_food": true,
  • "passport_number": "string",
  • "register_number": "string",
  • "home_department": "string",
  • "date_imported": "string",
  • "imported": true,
  • "tags_rel": [
    ],
  • "fields_rel": [
    ],
  • "holding_place_number": "string",
  • "animal_code": "string",
  • "herd_size": 0,
  • "private": true,
  • "visible_departments": [
    ],
  • "visible_department_groups": [
    ],
  • "microchip_date": "string",
  • "cpr_agreement": "string",
  • "blood_group": "string",
  • "last_consultation": "string",
  • "save_patient_with_duplicates": true,
  • "picture": "string",
  • "passport_given": "string"
}

Partially update Patient

Partially update Patient

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 250 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this patient.

query Parameters
ordering
string

Which field to use when ordering the results.

Request Body schema: application/json
id
integer
name
string
color
string
archived
boolean
species
string

species code can be found on active species List

breed
string

Breed code can be found on active breed List

remarks
string
microchip
string
additional_identification
string
animal_code
string
insurance
string
insurance_company
string
home_department
string
old_patient_id
string
official_name
string
date_of_birth
string
register_number
string
picture
string
deceased
string
tags_rel
Array of strings
gender
string

{"display_name": "Male","value": 1},{"display_name": "Female","value": 2},{"display_name": "Male, neutered","value": 3},{"display_name": "Female, neutered","value": 4},{"display_name": "Unknown","value": 0}

passport_number
string
critical_notes
string
passport_given
string
blood_group
string
cpr_agreement
string
holding_place_number
string

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "color": "string",
  • "archived": true,
  • "species": "string",
  • "breed": "string",
  • "remarks": "string",
  • "microchip": "string",
  • "additional_identification": "string",
  • "animal_code": "string",
  • "insurance": "string",
  • "insurance_company": "string",
  • "home_department": "string",
  • "old_patient_id": "string",
  • "official_name": "string",
  • "date_of_birth": "string",
  • "register_number": "string",
  • "picture": "string",
  • "deceased": "string",
  • "tags_rel": [
    ],
  • "gender": "string",
  • "passport_number": "string",
  • "critical_notes": "string",
  • "passport_given": "string",
  • "blood_group": "string",
  • "cpr_agreement": "string",
  • "holding_place_number": "string"
}

Archives an item.

Archives an item.

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this patient.

query Parameters
ordering
string

Which field to use when ordering the results.

Responses

Merge Patient to another

Merge Patient to another

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 100 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this patient.

Request Body schema: application/json
data_to_keep
string

Accepts a list of fields from source patient. The selected fields data will be moved to target patient during merge.

target_patient
required
string

Responses

Request samples

Content type
application/json
{
  • "data_to_keep": "string",
  • "target_patient": "string"
}

Unmerge Patient from earlier merge

Unmerge Patient from earlier merge

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 100 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this patient.

Responses

List Consultations

List Consultations

Required permissions:

  • General: Can access / edit patients and clients
  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 100 requests per minute.

path Parameters
parent_lookup_patient
required
string
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Patient Consultations

Patient Consultations

Required permissions:

  • General: Can access / edit patients and clients
  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_patient
required
string
Request Body schema: application/json
client
required
string
patients
required
Array of strings
complaint
string
admitted_time
string
first_entry
string
started
string
finished
string
ended
string
status
string
type
required
string
invoice
required
Array of strings
supervising_veterinarian
required
string
department
required
string
consultation_items
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "client": "string",
  • "patients": [
    ],
  • "complaint": "string",
  • "admitted_time": "string",
  • "first_entry": "string",
  • "started": "string",
  • "finished": "string",
  • "ended": "string",
  • "status": "string",
  • "type": "string",
  • "invoice": [
    ],
  • "supervising_veterinarian": "string",
  • "department": "string",
  • "consultation_items": [
    ]
}

Get Consultation by ID

Get Consultation by ID

Required permissions:

  • General: Can access / edit patients and clients
  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_patient
required
string
id
required
string

Responses

Update Consultation

Update Consultation

Required permissions:

  • General: Can access / edit patients and clients
  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_patient
required
string
id
required
string
Request Body schema: application/json
client
required
string
patients
required
Array of strings
complaint
string
admitted_time
string
first_entry
string
started
string
finished
string
ended
string
status
string
type
required
string
invoice
required
Array of strings
supervising_veterinarian
required
string
department
required
string
consultation_items
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "client": "string",
  • "patients": [
    ],
  • "complaint": "string",
  • "admitted_time": "string",
  • "first_entry": "string",
  • "started": "string",
  • "finished": "string",
  • "ended": "string",
  • "status": "string",
  • "type": "string",
  • "invoice": [
    ],
  • "supervising_veterinarian": "string",
  • "department": "string",
  • "consultation_items": [
    ]
}

Partially update Consultation

Partially update Consultation

Required permissions:

  • General: Can access / edit patients and clients
  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_patient
required
string
id
required
string
Request Body schema: application/json
client
string
patients
Array of strings
complaint
string
admitted_time
string
first_entry
string
started
string
finished
string
ended
string
status
string
type
string
invoice
Array of strings
supervising_veterinarian
string
department
string
consultation_items
Array of strings

Responses

Request samples

Content type
application/json
{
  • "client": "string",
  • "patients": [
    ],
  • "complaint": "string",
  • "admitted_time": "string",
  • "first_entry": "string",
  • "started": "string",
  • "finished": "string",
  • "ended": "string",
  • "status": "string",
  • "type": "string",
  • "invoice": [
    ],
  • "supervising_veterinarian": "string",
  • "department": "string",
  • "consultation_items": [
    ]
}

Archive Consultation

Archive Consultation

Required permissions:

  • General: Can access / edit patients and clients
  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_patient
required
string
id
required
string

Responses

List Custom Field Values

List Custom Field Values

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 100 requests per minute.

path Parameters
parent_lookup_patient
required
string
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Patient Custom Field Values

Patient Custom Field Values

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_patient
required
string
Request Body schema: application/json
field
required
integer
value
required
string
object_id
required
integer
compound_values
Array of strings

Responses

Request samples

Content type
application/json
{
  • "field": 0,
  • "value": "string",
  • "object_id": 0,
  • "compound_values": [
    ]
}

Get Custom Field Value by ID

Get Custom Field Value by ID

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_patient
required
string
id
required
integer

A unique integer value identifying this custom field value.

Responses

Update Custom Field Value

Update Custom Field Value

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_patient
required
string
id
required
integer

A unique integer value identifying this custom field value.

Request Body schema: application/json
field
required
integer
value
required
string
object_id
required
integer
compound_values
Array of strings

Responses

Request samples

Content type
application/json
{
  • "field": 0,
  • "value": "string",
  • "object_id": 0,
  • "compound_values": [
    ]
}

Partially update Custom Field Value

Partially update Custom Field Value

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_patient
required
string
id
required
integer

A unique integer value identifying this custom field value.

Request Body schema: application/json
field
integer
value
string
object_id
integer
compound_values
Array of strings

Responses

Request samples

Content type
application/json
{
  • "field": 0,
  • "value": "string",
  • "object_id": 0,
  • "compound_values": [
    ]
}

Archive Custom Field Value

Archive Custom Field Value

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_patient
required
string
id
required
integer

A unique integer value identifying this custom field value.

Responses

List External Vaccinations

List External Vaccinations

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 100 requests per minute.

path Parameters
parent_lookup_patient
required
string
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

ordering
string

Which field to use when ordering the results.

Responses

Create new External Vaccination

Create new External Vaccination

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_patient
required
string
Request Body schema: application/json
name
required
string
vaccination_disease
string
given_date
required
string
expiry_date
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "vaccination_disease": "string",
  • "given_date": "string",
  • "expiry_date": "string"
}

Get External Vaccination by ID

Get External Vaccination by ID

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_patient
required
string
id
required
integer

A unique integer value identifying this external vaccination.

query Parameters
ordering
string

Which field to use when ordering the results.

Responses

Update External Vaccination

Update External Vaccination

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_patient
required
string
id
required
integer

A unique integer value identifying this external vaccination.

query Parameters
ordering
string

Which field to use when ordering the results.

Request Body schema: application/json
name
required
string
vaccination_disease
string
given_date
required
string
expiry_date
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "vaccination_disease": "string",
  • "given_date": "string",
  • "expiry_date": "string"
}

Partially update External Vaccination

Partially update External Vaccination

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_patient
required
string
id
required
integer

A unique integer value identifying this external vaccination.

query Parameters
ordering
string

Which field to use when ordering the results.

Request Body schema: application/json
name
string
vaccination_disease
string
given_date
string
expiry_date
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "vaccination_disease": "string",
  • "given_date": "string",
  • "expiry_date": "string"
}

List Extras

List Extras

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 100 requests per minute.

path Parameters
parent_lookup_patient
required
string
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Create new Extra

Create new Extra

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_patient
required
string
Request Body schema: application/json
report_as_group
boolean

Responses

Request samples

Content type
application/json
{
  • "report_as_group": true
}

Get Extra by ID

Get Extra by ID

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_patient
required
string
id
required
integer

A unique integer value identifying this patient extras.

Responses

Update Extra

Update Extra

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_patient
required
string
id
required
integer

A unique integer value identifying this patient extras.

Request Body schema: application/json
report_as_group
boolean

Responses

Request samples

Content type
application/json
{
  • "report_as_group": true
}

Partially update Extra

Partially update Extra

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_patient
required
string
id
required
integer

A unique integer value identifying this patient extras.

Request Body schema: application/json
report_as_group
boolean

Responses

Request samples

Content type
application/json
{
  • "report_as_group": true
}

Archive Extra

Archive Extra

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_patient
required
string
id
required
integer

A unique integer value identifying this patient extras.

Responses

List Heart Rates

List Heart Rates

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 100 requests per minute.

path Parameters
parent_lookup_patient
required
string
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Create new Heart Rate

Create new Heart Rate

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_patient
required
string
Request Body schema: application/json
heart_rate
integer
timestamp
required
string
created_user
string
modified_user
string

Responses

Request samples

Content type
application/json
{
  • "heart_rate": 0,
  • "timestamp": "string",
  • "created_user": "string",
  • "modified_user": "string"
}

Get Heart Rate by ID

Get Heart Rate by ID

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_patient
required
string
id
required
integer

A unique integer value identifying this heart rate.

Responses

Update Heart Rate

Update Heart Rate

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_patient
required
string
id
required
integer

A unique integer value identifying this heart rate.

Request Body schema: application/json
heart_rate
integer
timestamp
required
string
created_user
string
modified_user
string

Responses

Request samples

Content type
application/json
{
  • "heart_rate": 0,
  • "timestamp": "string",
  • "created_user": "string",
  • "modified_user": "string"
}

Partially update Heart Rate

Partially update Heart Rate

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_patient
required
string
id
required
integer

A unique integer value identifying this heart rate.

Request Body schema: application/json
heart_rate
integer
timestamp
string
created_user
string
modified_user
string

Responses

Request samples

Content type
application/json
{
  • "heart_rate": 0,
  • "timestamp": "string",
  • "created_user": "string",
  • "modified_user": "string"
}

Archive Heart Rate

Archive Heart Rate

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_patient
required
string
id
required
integer

A unique integer value identifying this heart rate.

Responses

Required permissions:

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 100 requests per minute.

path Parameters
parent_lookup_patient
required
string

Responses

Patient PetMedData schema

Patient PetMedData schema

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 100 requests per minute.

path Parameters
parent_lookup_patient
required
string
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

List Peripheral Oxygen Saturations

List Peripheral Oxygen Saturations

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 100 requests per minute.

path Parameters
parent_lookup_patient
required
string
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Create new Peripheral Oxygen Saturation

Create new Peripheral Oxygen Saturation

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_patient
required
string
Request Body schema: application/json
peripheral_oxygen_saturation
number
timestamp
required
string
created_user
string
modified_user
string

Responses

Request samples

Content type
application/json
{
  • "peripheral_oxygen_saturation": 0,
  • "timestamp": "string",
  • "created_user": "string",
  • "modified_user": "string"
}

Get Peripheral Oxygen Saturation by ID

Get Peripheral Oxygen Saturation by ID

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_patient
required
string
id
required
integer

A unique integer value identifying this peripheral oxygen saturation.

Responses

Update Peripheral Oxygen Saturation

Update Peripheral Oxygen Saturation

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_patient
required
string
id
required
integer

A unique integer value identifying this peripheral oxygen saturation.

Request Body schema: application/json
peripheral_oxygen_saturation
number
timestamp
required
string
created_user
string
modified_user
string

Responses

Request samples

Content type
application/json
{
  • "peripheral_oxygen_saturation": 0,
  • "timestamp": "string",
  • "created_user": "string",
  • "modified_user": "string"
}

Partially update Peripheral Oxygen Saturation

Partially update Peripheral Oxygen Saturation

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_patient
required
string
id
required
integer

A unique integer value identifying this peripheral oxygen saturation.

Request Body schema: application/json
peripheral_oxygen_saturation
number
timestamp
string
created_user
string
modified_user
string

Responses

Request samples

Content type
application/json
{
  • "peripheral_oxygen_saturation": 0,
  • "timestamp": "string",
  • "created_user": "string",
  • "modified_user": "string"
}

Archive Peripheral Oxygen Saturation

Archive Peripheral Oxygen Saturation

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_patient
required
string
id
required
integer

A unique integer value identifying this peripheral oxygen saturation.

Responses

List Respiratory Rates

List Respiratory Rates

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 100 requests per minute.

path Parameters
parent_lookup_patient
required
string
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Create new Respiratory Rate

Create new Respiratory Rate

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_patient
required
string
Request Body schema: application/json
respiratory_rate
integer
timestamp
required
string
created_user
string
modified_user
string

Responses

Request samples

Content type
application/json
{
  • "respiratory_rate": 0,
  • "timestamp": "string",
  • "created_user": "string",
  • "modified_user": "string"
}

Get Respiratory Rate by ID

Get Respiratory Rate by ID

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_patient
required
string
id
required
integer

A unique integer value identifying this respiratory rate.

Responses

Update Respiratory Rate

Update Respiratory Rate

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_patient
required
string
id
required
integer

A unique integer value identifying this respiratory rate.

Request Body schema: application/json
respiratory_rate
integer
timestamp
required
string
created_user
string
modified_user
string

Responses

Request samples

Content type
application/json
{
  • "respiratory_rate": 0,
  • "timestamp": "string",
  • "created_user": "string",
  • "modified_user": "string"
}

Partially update Respiratory Rate

Partially update Respiratory Rate

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_patient
required
string
id
required
integer

A unique integer value identifying this respiratory rate.

Request Body schema: application/json
respiratory_rate
integer
timestamp
string
created_user
string
modified_user
string

Responses

Request samples

Content type
application/json
{
  • "respiratory_rate": 0,
  • "timestamp": "string",
  • "created_user": "string",
  • "modified_user": "string"
}

Archive Respiratory Rate

Archive Respiratory Rate

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_patient
required
string
id
required
integer

A unique integer value identifying this respiratory rate.

Responses

List Temperatures

List Temperatures

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 100 requests per minute.

path Parameters
parent_lookup_patient
required
string
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Create new Temperature

Create new Temperature

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_patient
required
string
Request Body schema: application/json
temperature
number
timestamp
required
string
created_user
string
modified_user
string

Responses

Request samples

Content type
application/json
{
  • "temperature": 0,
  • "timestamp": "string",
  • "created_user": "string",
  • "modified_user": "string"
}

Get Temperature by ID

Get Temperature by ID

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_patient
required
string
id
required
integer

A unique integer value identifying this temperature.

Responses

Update Temperature

Update Temperature

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_patient
required
string
id
required
integer

A unique integer value identifying this temperature.

Request Body schema: application/json
temperature
number
timestamp
required
string
created_user
string
modified_user
string

Responses

Request samples

Content type
application/json
{
  • "temperature": 0,
  • "timestamp": "string",
  • "created_user": "string",
  • "modified_user": "string"
}

Partially update Temperature

Partially update Temperature

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_patient
required
string
id
required
integer

A unique integer value identifying this temperature.

Request Body schema: application/json
temperature
number
timestamp
string
created_user
string
modified_user
string

Responses

Request samples

Content type
application/json
{
  • "temperature": 0,
  • "timestamp": "string",
  • "created_user": "string",
  • "modified_user": "string"
}

Archive Temperature

Archive Temperature

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_patient
required
string
id
required
integer

A unique integer value identifying this temperature.

Responses

List Weights

List Weights

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 100 requests per minute.

path Parameters
parent_lookup_patient
required
string
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

ordering
string

Which field to use when ordering the results.

Responses

Create new Weight

Create new Weight

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_patient
required
string
Request Body schema: application/json
weight
number
timestamp
required
string
created_user
string
modified_user
string

Responses

Request samples

Content type
application/json
{
  • "weight": 0,
  • "timestamp": "string",
  • "created_user": "string",
  • "modified_user": "string"
}

Get Weight by ID

Get Weight by ID

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_patient
required
string
id
required
integer

A unique integer value identifying this weight.

query Parameters
ordering
string

Which field to use when ordering the results.

Responses

Update Weight

Update Weight

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_patient
required
string
id
required
integer

A unique integer value identifying this weight.

query Parameters
ordering
string

Which field to use when ordering the results.

Request Body schema: application/json
weight
number
timestamp
required
string
created_user
string
modified_user
string

Responses

Request samples

Content type
application/json
{
  • "weight": 0,
  • "timestamp": "string",
  • "created_user": "string",
  • "modified_user": "string"
}

Partially update Weight

Partially update Weight

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_patient
required
string
id
required
integer

A unique integer value identifying this weight.

query Parameters
ordering
string

Which field to use when ordering the results.

Request Body schema: application/json
weight
number
timestamp
string
created_user
string
modified_user
string

Responses

Request samples

Content type
application/json
{
  • "weight": 0,
  • "timestamp": "string",
  • "created_user": "string",
  • "modified_user": "string"
}

Archive Weight

Archive Weight

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_patient
required
string
id
required
integer

A unique integer value identifying this weight.

query Parameters
ordering
string

Which field to use when ordering the results.

Responses

Health plans

List Plans

List Plans

Required permissions:

  • Settings: Can access / edit health plan settings

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

ordering
string

Which field to use when ordering the results.

Responses

Health Plans

Health Plans

Required permissions:

  • Settings: Can access / edit health plan settings

This endpoint is rate-limited to 300 requests per minute.

Request Body schema: application/json
display_name
required
string
department
string
additional_departments
Array of strings
species
required
string
status
string
months
integer
monthly_fee
number
initial_payment
number
internal_name
required
string
description
string
weight_min
number
weight_max
number
age_min
integer
age_max
integer
ongoing
boolean
validity_start
string
validity_end
string
internal_notes
string
invoicing_item
string
compensation_item
string
cancellation_fee_item
string
default_renewal
string
default_renewal_plan
string

Responses

Request samples

Content type
application/json
{
  • "display_name": "string",
  • "department": "string",
  • "additional_departments": [
    ],
  • "species": "string",
  • "status": "string",
  • "months": 0,
  • "monthly_fee": 0,
  • "initial_payment": 0,
  • "internal_name": "string",
  • "description": "string",
  • "weight_min": 0,
  • "weight_max": 0,
  • "age_min": 0,
  • "age_max": 0,
  • "ongoing": true,
  • "validity_start": "string",
  • "validity_end": "string",
  • "internal_notes": "string",
  • "invoicing_item": "string",
  • "compensation_item": "string",
  • "cancellation_fee_item": "string",
  • "default_renewal": "string",
  • "default_renewal_plan": "string"
}

Get Plan by ID

Get Plan by ID

Required permissions:

  • Settings: Can access / edit health plan settings

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this health plan.

query Parameters
ordering
string

Which field to use when ordering the results.

Responses

Health Plans

Health Plans

Required permissions:

  • Settings: Can access / edit health plan settings

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this health plan.

query Parameters
ordering
string

Which field to use when ordering the results.

Request Body schema: application/json
display_name
required
string
department
string
additional_departments
Array of strings
species
required
string
status
string
months
integer
monthly_fee
number
initial_payment
number
internal_name
required
string
description
string
weight_min
number
weight_max
number
age_min
integer
age_max
integer
ongoing
boolean
validity_start
string
validity_end
string
internal_notes
string
invoicing_item
string
compensation_item
string
cancellation_fee_item
string
default_renewal
string
default_renewal_plan
string

Responses

Request samples

Content type
application/json
{
  • "display_name": "string",
  • "department": "string",
  • "additional_departments": [
    ],
  • "species": "string",
  • "status": "string",
  • "months": 0,
  • "monthly_fee": 0,
  • "initial_payment": 0,
  • "internal_name": "string",
  • "description": "string",
  • "weight_min": 0,
  • "weight_max": 0,
  • "age_min": 0,
  • "age_max": 0,
  • "ongoing": true,
  • "validity_start": "string",
  • "validity_end": "string",
  • "internal_notes": "string",
  • "invoicing_item": "string",
  • "compensation_item": "string",
  • "cancellation_fee_item": "string",
  • "default_renewal": "string",
  • "default_renewal_plan": "string"
}

Health Plans

Health Plans

Required permissions:

  • Settings: Can access / edit health plan settings

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this health plan.

query Parameters
ordering
string

Which field to use when ordering the results.

Request Body schema: application/json
display_name
string
department
string
additional_departments
Array of strings
species
string
status
string
months
integer
monthly_fee
number
initial_payment
number
internal_name
string
description
string
weight_min
number
weight_max
number
age_min
integer
age_max
integer
ongoing
boolean
validity_start
string
validity_end
string
internal_notes
string
invoicing_item
string
compensation_item
string
cancellation_fee_item
string
default_renewal
string
default_renewal_plan
string

Responses

Request samples

Content type
application/json
{
  • "display_name": "string",
  • "department": "string",
  • "additional_departments": [
    ],
  • "species": "string",
  • "status": "string",
  • "months": 0,
  • "monthly_fee": 0,
  • "initial_payment": 0,
  • "internal_name": "string",
  • "description": "string",
  • "weight_min": 0,
  • "weight_max": 0,
  • "age_min": 0,
  • "age_max": 0,
  • "ongoing": true,
  • "validity_start": "string",
  • "validity_end": "string",
  • "internal_notes": "string",
  • "invoicing_item": "string",
  • "compensation_item": "string",
  • "cancellation_fee_item": "string",
  • "default_renewal": "string",
  • "default_renewal_plan": "string"
}

List Items

List Items

Required permissions:

  • Settings: Can access / edit health plan settings

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

ordering
string

Which field to use when ordering the results.

Responses

Health Plan Items

Health Plan Items

Required permissions:

  • Settings: Can access / edit health plan settings

This endpoint is rate-limited to 300 requests per minute.

Request Body schema: application/json
health_plan
string
health_plan_item_group
string
item
required
string
type_code
required
string
name
required
string
price
number
price_with_vat
number
vat_percentage
number
quantity
number
units
number
usage_size
string
consultation_item
string
code
string
unit
string
package_description
string
per_consultation
number
unlimited_use
boolean
use_after_expiry
boolean
days_after_expiry
integer
parent_linked_item
string

Responses

Request samples

Content type
application/json
{
  • "health_plan": "string",
  • "health_plan_item_group": "string",
  • "item": "string",
  • "type_code": "string",
  • "name": "string",
  • "price": 0,
  • "price_with_vat": 0,
  • "vat_percentage": 0,
  • "quantity": 0,
  • "units": 0,
  • "usage_size": "string",
  • "consultation_item": "string",
  • "code": "string",
  • "unit": "string",
  • "package_description": "string",
  • "per_consultation": 0,
  • "unlimited_use": true,
  • "use_after_expiry": true,
  • "days_after_expiry": 0,
  • "parent_linked_item": "string"
}

Get Item by ID

Get Item by ID

Required permissions:

  • Settings: Can access / edit health plan settings

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this health plan item.

query Parameters
ordering
string

Which field to use when ordering the results.

Responses

Health Plan Items

Health Plan Items

Required permissions:

  • Settings: Can access / edit health plan settings

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this health plan item.

query Parameters
ordering
string

Which field to use when ordering the results.

Request Body schema: application/json
health_plan
string
health_plan_item_group
string
item
required
string
type_code
required
string
name
required
string
price
number
price_with_vat
number
vat_percentage
number
quantity
number
units
number
usage_size
string
consultation_item
string
code
string
unit
string
package_description
string
per_consultation
number
unlimited_use
boolean
use_after_expiry
boolean
days_after_expiry
integer
parent_linked_item
string

Responses

Request samples

Content type
application/json
{
  • "health_plan": "string",
  • "health_plan_item_group": "string",
  • "item": "string",
  • "type_code": "string",
  • "name": "string",
  • "price": 0,
  • "price_with_vat": 0,
  • "vat_percentage": 0,
  • "quantity": 0,
  • "units": 0,
  • "usage_size": "string",
  • "consultation_item": "string",
  • "code": "string",
  • "unit": "string",
  • "package_description": "string",
  • "per_consultation": 0,
  • "unlimited_use": true,
  • "use_after_expiry": true,
  • "days_after_expiry": 0,
  • "parent_linked_item": "string"
}

Health Plan Items

Health Plan Items

Required permissions:

  • Settings: Can access / edit health plan settings

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this health plan item.

query Parameters
ordering
string

Which field to use when ordering the results.

Request Body schema: application/json
health_plan
string
health_plan_item_group
string
item
string
type_code
string
name
string
price
number
price_with_vat
number
vat_percentage
number
quantity
number
units
number
usage_size
string
consultation_item
string
code
string
unit
string
package_description
string
per_consultation
number
unlimited_use
boolean
use_after_expiry
boolean
days_after_expiry
integer
parent_linked_item
string

Responses

Request samples

Content type
application/json
{
  • "health_plan": "string",
  • "health_plan_item_group": "string",
  • "item": "string",
  • "type_code": "string",
  • "name": "string",
  • "price": 0,
  • "price_with_vat": 0,
  • "vat_percentage": 0,
  • "quantity": 0,
  • "units": 0,
  • "usage_size": "string",
  • "consultation_item": "string",
  • "code": "string",
  • "unit": "string",
  • "package_description": "string",
  • "per_consultation": 0,
  • "unlimited_use": true,
  • "use_after_expiry": true,
  • "days_after_expiry": 0,
  • "parent_linked_item": "string"
}

List Groups

List Groups

Required permissions:

  • Settings: Can access / edit health plan settings

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

ordering
string

Which field to use when ordering the results.

Responses

Health Plan Item Groups

Health Plan Item Groups

Required permissions:

  • Settings: Can access / edit health plan settings

This endpoint is rate-limited to 300 requests per minute.

Request Body schema: application/json
health_plans
Array of strings
name
required
string
status
string
item_list
required
string
usable_items_quantity
integer
total_price_with_vat
number
unlimited_use
boolean

Responses

Request samples

Content type
application/json
{
  • "health_plans": [
    ],
  • "name": "string",
  • "status": "string",
  • "item_list": "string",
  • "usable_items_quantity": 0,
  • "total_price_with_vat": 0,
  • "unlimited_use": true
}

Get Group by ID

Get Group by ID

Required permissions:

  • Settings: Can access / edit health plan settings

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this health plan item group.

query Parameters
ordering
string

Which field to use when ordering the results.

Responses

Health Plan Item Groups

Health Plan Item Groups

Required permissions:

  • Settings: Can access / edit health plan settings

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this health plan item group.

query Parameters
ordering
string

Which field to use when ordering the results.

Request Body schema: application/json
health_plans
Array of strings
name
required
string
status
string
item_list
required
string
usable_items_quantity
integer
total_price_with_vat
number
unlimited_use
boolean

Responses

Request samples

Content type
application/json
{
  • "health_plans": [
    ],
  • "name": "string",
  • "status": "string",
  • "item_list": "string",
  • "usable_items_quantity": 0,
  • "total_price_with_vat": 0,
  • "unlimited_use": true
}

Health Plan Item Groups

Health Plan Item Groups

Required permissions:

  • Settings: Can access / edit health plan settings

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this health plan item group.

query Parameters
ordering
string

Which field to use when ordering the results.

Request Body schema: application/json
health_plans
Array of strings
name
string
status
string
item_list
string
usable_items_quantity
integer
total_price_with_vat
number
unlimited_use
boolean

Responses

Request samples

Content type
application/json
{
  • "health_plans": [
    ],
  • "name": "string",
  • "status": "string",
  • "item_list": "string",
  • "usable_items_quantity": 0,
  • "total_price_with_vat": 0,
  • "unlimited_use": true
}

Holding place numbers

List Numbers

List Numbers

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Create new Number

Create new Number

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

Request Body schema: application/json
client
required
string
holding_place_number
required
string
description
string
patients
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "client": "string",
  • "holding_place_number": "string",
  • "description": "string",
  • "patients": [
    ]
}

Get Number by ID

Get Number by ID

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this holding place numbers.

Responses

Update Number

Update Number

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this holding place numbers.

Request Body schema: application/json
client
required
string
holding_place_number
required
string
description
string
patients
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "client": "string",
  • "holding_place_number": "string",
  • "description": "string",
  • "patients": [
    ]
}

Partially update Number

Partially update Number

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this holding place numbers.

Request Body schema: application/json
client
string
holding_place_number
string
description
string
patients
Array of strings

Responses

Request samples

Content type
application/json
{
  • "client": "string",
  • "holding_place_number": "string",
  • "description": "string",
  • "patients": [
    ]
}

Archive Number

Archive Number

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this holding place numbers.

Responses

Hooks

List Notifications

List Notifications

Required permissions:

  • Settings: Can access / edit integration settings

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

ordering
string

Which field to use when ordering the results.

Responses

Get Notification by ID

Get Notification by ID

Required permissions:

  • Settings: Can access / edit integration settings

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this hook notification.

query Parameters
ordering
string

Which field to use when ordering the results.

Responses

List Webhooks

List Webhooks

Required permissions:

  • Settings: Can access / edit integration settings

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Get Webhook by ID

Get Webhook by ID

trigger values:

  • Client = 1
  • Patient = 2
  • Consultation = 3
  • Consultation delete = 4
  • Consultation item = 5
  • Diagnostic imaging worklist = 6
  • Diagnostic imaging worklist update = 7
  • Diagnostic imaging worklist delete = 8
  • Invoice = 9
  • Invoice draft = 10
  • Invoice payment = 11
  • Unallocated payment = 12
  • Insurance claim = 13
  • Accounting report = 14
  • Organization item = 15
  • Laboratory referral = 16
  • Consultation waiting discharge = 17
  • Patient referral = 18
  • SMS log = 19
  • Email log = 20
  • Appointment = 21
  • Appointment delete = 22
  • Invoice row delete = 23
  • Reminder delete = 24
  • Reminder template delete = 25
  • Treatment plan = 26
  • Treatment plan item = 27
  • User = 28
  • Treatment plan delete = 29
  • Treatment plan item delete = 30

Required permissions:

  • Settings: Can access / edit integration settings

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this webhook.

Responses

Imaging categories

List Categories

List Categories

Required permissions:

  • Settings: Can access / edit integration settings

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Get Category by ID

Get Category by ID

Required permissions:

  • Settings: Can access / edit integration settings

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this imaging category.

Responses

List Subcategories

List Subcategories

Required permissions:

  • Settings: Can access / edit integration settings

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Get Subcategory by ID

Get Subcategory by ID

Required permissions:

  • Settings: Can access / edit integration settings

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this imaging sub category.

Responses

Imported histories

List Imported Histories

List Imported Histories

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Create new Imported History

Create new Imported History

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

Request Body schema: application/json
patient
required
string
document
required
string

Responses

Request samples

Content type
application/json
{
  • "patient": "string",
  • "document": "string"
}

Get Imported History by ID

Get Imported History by ID

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this imported history.

Responses

Update Imported History

Update Imported History

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this imported history.

Request Body schema: application/json
patient
required
string
document
required
string

Responses

Request samples

Content type
application/json
{
  • "patient": "string",
  • "document": "string"
}

Partially update Imported History

Partially update Imported History

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this imported history.

Request Body schema: application/json
patient
string
document
string

Responses

Request samples

Content type
application/json
{
  • "patient": "string",
  • "document": "string"
}

Archive Imported History

Archive Imported History

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this imported history.

Responses

Insurance claims

List Claims

List Claims

Status_codes are:

  • CREATING = 0
  • CREATED = 1
  • SENDING = 2
  • SENT = 3
  • WAITING_FOR_INFO = 4
  • READY = 5
  • REJECTED = 6
  • READY_PAID = 7

Required permissions:

  • Financial: Can access / edit insurance claims

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Get Claim by ID

Get Claim by ID

Required permissions:

  • Financial: Can access / edit insurance claims

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this claim.

Responses

Update Claim

Update Claim

Required permissions:

  • Financial: Can access / edit insurance claims

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this claim.

Request Body schema: application/json
status
string
compensation
number
case_number
string

Responses

Request samples

Content type
application/json
{
  • "status": "string",
  • "compensation": 0,
  • "case_number": "string"
}

Partially update Claim

Partially update Claim

Required permissions:

  • Financial: Can access / edit insurance claims

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this claim.

Request Body schema: application/json
status
string
compensation
number
case_number
string

Responses

Request samples

Content type
application/json
{
  • "status": "string",
  • "compensation": 0,
  • "case_number": "string"
}

Get Clients

Get Clients

Required permissions:

  • Financial: Can access / edit insurance claims

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Get Client by ID

Get Client by ID

Required permissions:

  • Financial: Can access / edit insurance claims

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this claim client.

Responses

Get Patients

Get Patients

Required permissions:

  • Financial: Can access / edit insurance claims

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Get Patient by ID

Get Patient by ID

Required permissions:

  • Financial: Can access / edit insurance claims

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this claim patient.

Responses

Invoices

List Invoices

List Invoices

total = Invoice total amount without taxes total_vat = Total tax amount of the invoice total_with_vat = Invoice total amount with taxes

Status values:

  • Draft = 0
  • Finalized = 3
  • Invoicing = 4
  • Voided = 99

Required permissions:

  • Financial: Can access / edit invoices

This endpoint is rate-limited to 60 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

ordering
string

Which field to use when ordering the results.

Responses

Get Invoice by ID

Get Invoice by ID

Required permissions:

  • Financial: Can access / edit invoices

This endpoint is rate-limited to 250 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this invoice.

query Parameters
ordering
string

Which field to use when ordering the results.

Responses

Update Invoice

Update Invoice

Required permissions:

  • Financial: Can access / edit invoices

This endpoint is rate-limited to 150 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this invoice.

query Parameters
ordering
string

Which field to use when ordering the results.

Request Body schema: application/json
tags_rel
Array of strings
invoice_due_date
string
agreed_to_pay_later
boolean
remarks
string
internal_remarks
string

Responses

Request samples

Content type
application/json
{
  • "tags_rel": [
    ],
  • "invoice_due_date": "string",
  • "agreed_to_pay_later": true,
  • "remarks": "string",
  • "internal_remarks": "string"
}

Partially update Invoice

Partially update Invoice

Required permissions:

  • Financial: Can access / edit invoices

This endpoint is rate-limited to 150 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this invoice.

query Parameters
ordering
string

Which field to use when ordering the results.

Request Body schema: application/json
tags_rel
Array of strings
invoice_due_date
string
agreed_to_pay_later
boolean
remarks
string
internal_remarks
string

Responses

Request samples

Content type
application/json
{
  • "tags_rel": [
    ],
  • "invoice_due_date": "string",
  • "agreed_to_pay_later": true,
  • "remarks": "string",
  • "internal_remarks": "string"
}

Add new item

Add new item

Required permissions:

  • Financial: Can access / edit invoices

This endpoint is rate-limited to 100 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this invoice.

Responses

Add new item

Add new item

Required permissions:

  • Financial: Can access / edit invoices

This endpoint is rate-limited to 100 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this invoice.

Request Body schema: application/json
item
required
string

Item to be added. URL to item instance

patient
string

Patient for the invoice row

name
string

If not defined, item name is used

print_name
string

If not defined, item print name is used

quantity
required
number

The amount sold. usage size defines if the amount is units or packages

usage_size
string

units or packages. if not defined default usage size of the item is used

price
number

price without Vat. use either this or price with vat -field (not both) in your request if you like to set the article price manually. if there is no price the list price of the item is used

price_with_vat
number

price that includes Vat. this is only used if price-field is not defined

vat_percentage
number

If not defined, default VAT percentage of the item is used

Responses

Request samples

Content type
application/json
{
  • "item": "string",
  • "patient": "string",
  • "name": "string",
  • "print_name": "string",
  • "quantity": 0,
  • "usage_size": "string",
  • "price": 0,
  • "price_with_vat": 0,
  • "vat_percentage": 0
}

Add new item

Add new item

Required permissions:

  • Financial: Can access / edit invoices

This endpoint is rate-limited to 100 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this invoice.

Request Body schema: application/json
item
required
string

Item to be added. URL to item instance

patient
string

Patient for the invoice row

name
string

If not defined, item name is used

print_name
string

If not defined, item print name is used

quantity
required
number

The amount sold. usage size defines if the amount is units or packages

usage_size
string

units or packages. if not defined default usage size of the item is used

price
number

price without Vat. use either this or price with vat -field (not both) in your request if you like to set the article price manually. if there is no price the list price of the item is used

price_with_vat
number

price that includes Vat. this is only used if price-field is not defined

vat_percentage
number

If not defined, default VAT percentage of the item is used

Responses

Request samples

Content type
application/json
{
  • "item": "string",
  • "patient": "string",
  • "name": "string",
  • "print_name": "string",
  • "quantity": 0,
  • "usage_size": "string",
  • "price": 0,
  • "price_with_vat": 0,
  • "vat_percentage": 0
}

Refund Invoice fully

Refund Invoice fully

Required permissions:

  • Financial: Can access / edit invoices

This endpoint is rate-limited to 100 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this invoice.

Responses

Refund Invoice fully

Refund Invoice fully

Required permissions:

  • Financial: Can access / edit invoices

This endpoint is rate-limited to 100 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this invoice.

Request Body schema: application/json
use_original_invoice_date
boolean
create_commission_rows
boolean
create_as_draft
boolean
eu_company_without_vat
boolean
override_client_vat_group
boolean

Overrides VAT based on special VAT group specified for the client

payments
Array of strings

Payments to be credited along the refund

payments_action
string

Defines how to handle the payments on original invoice

Responses

Request samples

Content type
application/json
{
  • "use_original_invoice_date": true,
  • "create_commission_rows": true,
  • "create_as_draft": true,
  • "eu_company_without_vat": true,
  • "override_client_vat_group": true,
  • "payments": [
    ],
  • "payments_action": "string"
}

Generate QR code

Generate QR code

Generate a QR code for the invoice. If a QR code already exists for the invoice, the new QR code will replace the existing one.

Required permissions:

  • Financial: Can access / edit invoices

This endpoint is rate-limited to 100 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this invoice.

Request Body schema: application/json
title
string
qr_code_data
required
string

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "qr_code_data": "string"
}

Backdate invoice

Backdate invoice

Used for backdating the invoice by manually setting invoice_date. Sets both invoice_date and manual_invoice_date to preserve the invoice_date when invoice is finalized. Not for general use.

  • Requires api_staff_token access token to use
  • This endpoint is only enabled for select few provets.

Parameters:

  • invoice_date (datetime) - ISO 8601 format
  • api_staff_token (string) - token for authenticating the request

Required permissions:

  • Financial: Can access / edit invoices

This endpoint is rate-limited to 100 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this invoice.

Request Body schema: application/json
invoice_date
required
string

Responses

Request samples

Content type
application/json
{
  • "invoice_date": "string"
}

Refund Invoice partially

Refund Invoice partially

Required permissions:

  • Financial: Can access / edit invoices

This endpoint is rate-limited to 100 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this invoice.

Responses

Refund Invoice partially

Refund Invoice partially

Required permissions:

  • Financial: Can access / edit invoices

This endpoint is rate-limited to 100 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this invoice.

Request Body schema: application/json
use_original_invoice_date
boolean
create_commission_rows
boolean
create_as_draft
boolean
eu_company_without_vat
boolean
override_client_vat_group
boolean

Overrides VAT based on special VAT group specified for the client

payments
Array of strings

Payments to be credited along the refund

payments_action
string

Defines how to handle the payments on original invoice

invoice_rows
required
Array of strings

Invoice rows to refund on invoice

Responses

Request samples

Content type
application/json
{
  • "use_original_invoice_date": true,
  • "create_commission_rows": true,
  • "create_as_draft": true,
  • "eu_company_without_vat": true,
  • "override_client_vat_group": true,
  • "payments": [
    ],
  • "payments_action": "string",
  • "invoice_rows": [
    ]
}

List Extras

List Extras

Required permissions:

  • Financial: Can access / edit invoices

This endpoint is rate-limited to 100 requests per minute.

path Parameters
parent_lookup_invoice
required
string
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Create new Extra

Create new Extra

Required permissions:

  • Financial: Can access / edit invoices

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_invoice
required
string
Request Body schema: application/json
exported
string
appointment
string

Responses

Request samples

Content type
application/json
{
  • "exported": "string",
  • "appointment": "string"
}

Get Extra by ID

Get Extra by ID

Required permissions:

  • Financial: Can access / edit invoices

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_invoice
required
string
id
required
integer

A unique integer value identifying this invoice extras.

Responses

Update Extra

Update Extra

Required permissions:

  • Financial: Can access / edit invoices

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_invoice
required
string
id
required
integer

A unique integer value identifying this invoice extras.

Request Body schema: application/json
exported
string
appointment
string

Responses

Request samples

Content type
application/json
{
  • "exported": "string",
  • "appointment": "string"
}

Partially update Extra

Partially update Extra

Required permissions:

  • Financial: Can access / edit invoices

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_invoice
required
string
id
required
integer

A unique integer value identifying this invoice extras.

Request Body schema: application/json
exported
string
appointment
string

Responses

Request samples

Content type
application/json
{
  • "exported": "string",
  • "appointment": "string"
}

Archive Extra

Archive Extra

Required permissions:

  • Financial: Can access / edit invoices

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_invoice
required
string
id
required
integer

A unique integer value identifying this invoice extras.

Responses

List PDFs

List PDFs

Required permissions:

  • Financial: Can access / edit invoices

This endpoint is rate-limited to 100 requests per minute.

path Parameters
parent_lookup_invoice
required
string
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

List Groups

List Groups

Type_codes are:

  • Procedure = 1
  • Medicine = 2
  • Supply = 3
  • Food = 4
  • Laboratory analysis = 5
  • Laboratory analysis panel = 6

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Create new Group

Create new Group

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 300 requests per minute.

Request Body schema: application/json
title
required
string
type_code
required
integer
account_number
string
parent
string
children
Array of strings

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "type_code": 0,
  • "account_number": "string",
  • "parent": "string",
  • "children": [
    ]
}

Get Group by ID

Get Group by ID

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this Item subgroup.

Responses

Update Group

Update Group

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this Item subgroup.

Request Body schema: application/json
title
required
string
type_code
required
integer
account_number
string
parent
string
children
Array of strings

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "type_code": 0,
  • "account_number": "string",
  • "parent": "string",
  • "children": [
    ]
}

Partially update Group

Partially update Group

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this Item subgroup.

Request Body schema: application/json
title
string
type_code
integer
account_number
string
parent
string
children
Array of strings

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "type_code": 0,
  • "account_number": "string",
  • "parent": "string",
  • "children": [
    ]
}

Archive Group

Archive Group

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this Item subgroup.

Responses

Required permissions:

Required permissions:

  • Financial: Can access / edit invoices

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

ordering
string

Which field to use when ordering the results.

Responses

Required permissions:

Required permissions:

  • Financial: Can access / edit invoices

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this invoice row.

query Parameters
ordering
string

Which field to use when ordering the results.

Responses

List Extras

List Extras

Required permissions:

  • Financial: Can access / edit invoices

This endpoint is rate-limited to 100 requests per minute.

path Parameters
parent_lookup_invoicerow
required
string
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Create new Extra

Create new Extra

Required permissions:

  • Financial: Can access / edit invoices

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_invoicerow
required
string
Request Body schema: application/json
internal_reporting_dimension_1
string
internal_reporting_dimension_2
string
internal_account_number
string
laboratory_group
string
creator
string
void
number
off_label_medicine
boolean

Responses

Request samples

Content type
application/json
{
  • "internal_reporting_dimension_1": "string",
  • "internal_reporting_dimension_2": "string",
  • "internal_account_number": "string",
  • "laboratory_group": "string",
  • "creator": "string",
  • "void": 0,
  • "off_label_medicine": true
}

Get Extra by ID

Get Extra by ID

Required permissions:

  • Financial: Can access / edit invoices

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_invoicerow
required
string
id
required
integer

A unique integer value identifying this invoice row extra.

Responses

Update Extra

Update Extra

Required permissions:

  • Financial: Can access / edit invoices

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_invoicerow
required
string
id
required
integer

A unique integer value identifying this invoice row extra.

Request Body schema: application/json
internal_reporting_dimension_1
string
internal_reporting_dimension_2
string
internal_account_number
string
laboratory_group
string
creator
string
void
number
off_label_medicine
boolean

Responses

Request samples

Content type
application/json
{
  • "internal_reporting_dimension_1": "string",
  • "internal_reporting_dimension_2": "string",
  • "internal_account_number": "string",
  • "laboratory_group": "string",
  • "creator": "string",
  • "void": 0,
  • "off_label_medicine": true
}

Partially update Extra

Partially update Extra

Required permissions:

  • Financial: Can access / edit invoices

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_invoicerow
required
string
id
required
integer

A unique integer value identifying this invoice row extra.

Request Body schema: application/json
internal_reporting_dimension_1
string
internal_reporting_dimension_2
string
internal_account_number
string
laboratory_group
string
creator
string
void
number
off_label_medicine
boolean

Responses

Request samples

Content type
application/json
{
  • "internal_reporting_dimension_1": "string",
  • "internal_reporting_dimension_2": "string",
  • "internal_account_number": "string",
  • "laboratory_group": "string",
  • "creator": "string",
  • "void": 0,
  • "off_label_medicine": true
}

Archive Extra

Archive Extra

Required permissions:

  • Financial: Can access / edit invoices

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_invoicerow
required
string
id
required
integer

A unique integer value identifying this invoice row extra.

Responses

Required permissions:

Required permissions:

  • Financial: Can access / edit invoices

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Required permissions:

Required permissions:

  • Financial: Can access / edit invoices

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this invoice row vat group.

Responses

Invoice payments

List Payments

List Payments

Returns a paginated list of all Invoice Payments.

Current payment_types are:

  • Credit card = 0
  • Cash = 1
  • Bank payment = 2
  • Rounding = 3
  • Cheque = 4
  • Voucher = 5
  • Consolidated invoice = 6
  • Mobile payment = 7
  • Prepayment = 8
  • Present card = 9
  • Financing company = 10
  • Other = 11
  • Credit invoice = 12

Required permissions:

  • Financial: Can access / edit invoices

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

ordering
string

Which field to use when ordering the results.

Responses

Create new Payment

Create new Payment

Required permissions:

  • Financial: Can access / edit invoices

This endpoint is rate-limited to 300 requests per minute.

Request Body schema: application/json
invoice
required
string
payment_type
required
integer
paid
required
number
created_user
required
string
info
string
date_added
string
status
string
status_updated
string
receipt_data
string
claim_number
integer

Responses

Request samples

Content type
application/json
{
  • "invoice": "string",
  • "payment_type": 0,
  • "paid": 0,
  • "created_user": "string",
  • "info": "string",
  • "date_added": "string",
  • "status": "string",
  • "status_updated": "string",
  • "receipt_data": "string",
  • "claim_number": 0
}

Get Payment by ID

Get Payment by ID

Required permissions:

  • Financial: Can access / edit invoices

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this invoice payment.

query Parameters
ordering
string

Which field to use when ordering the results.

Responses

Update Payment

Update Payment

Only partial updates to invoice payments are allowed for now.

Required permissions:

  • Financial: Can access / edit invoices

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this invoice payment.

query Parameters
ordering
string

Which field to use when ordering the results.

Request Body schema: application/json
invoice
required
string
payment_type
required
integer
paid
required
number
created_user
required
string
info
string
date_added
string
status
string
status_updated
string
receipt_data
string
claim_number
integer

Responses

Request samples

Content type
application/json
{
  • "invoice": "string",
  • "payment_type": 0,
  • "paid": 0,
  • "created_user": "string",
  • "info": "string",
  • "date_added": "string",
  • "status": "string",
  • "status_updated": "string",
  • "receipt_data": "string",
  • "claim_number": 0
}

Partially update Payment

Partially update Payment

Updates partial data of an invoice payment. Currently only the status and status_updated fields are supported.

Required permissions:

  • Financial: Can access / edit invoices

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this invoice payment.

query Parameters
ordering
string

Which field to use when ordering the results.

Request Body schema: application/json
invoice
string
payment_type
integer
paid
number
created_user
string
info
string
date_added
string
status
string
status_updated
string
receipt_data
string
claim_number
integer

Responses

Request samples

Content type
application/json
{
  • "invoice": "string",
  • "payment_type": 0,
  • "paid": 0,
  • "created_user": "string",
  • "info": "string",
  • "date_added": "string",
  • "status": "string",
  • "status_updated": "string",
  • "receipt_data": "string",
  • "claim_number": 0
}

Invoice Payments

Invoice Payments

Required permissions:

  • Financial: Can access / edit invoices

This endpoint is rate-limited to 100 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this invoice payment.

Request Body schema: application/json
invoice
required
string
payment_type
required
integer
paid
required
number
created_user
required
string
info
string
date_added
string
status
string
status_updated
string
receipt_data
string
claim_number
integer

Responses

Request samples

Content type
application/json
{
  • "invoice": "string",
  • "payment_type": 0,
  • "paid": 0,
  • "created_user": "string",
  • "info": "string",
  • "date_added": "string",
  • "status": "string",
  • "status_updated": "string",
  • "receipt_data": "string",
  • "claim_number": 0
}

List Extras

List Extras

Required permissions:

  • Financial: Can access / edit invoices

This endpoint is rate-limited to 100 requests per minute.

path Parameters
parent_lookup_invoice_payment
required
string
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Create new Extra

Create new Extra

Required permissions:

  • Financial: Can access / edit invoices

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_invoice_payment
required
string
Request Body schema: application/json
exported
string
external_id
string
metadata
string

Responses

Request samples

Content type
application/json
{
  • "exported": "string",
  • "external_id": "string",
  • "metadata": "string"
}

Get Extra by ID

Get Extra by ID

Required permissions:

  • Financial: Can access / edit invoices

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_invoice_payment
required
string
id
required
integer

A unique integer value identifying this invoice payment extras.

Responses

Update Extra

Update Extra

Required permissions:

  • Financial: Can access / edit invoices

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_invoice_payment
required
string
id
required
integer

A unique integer value identifying this invoice payment extras.

Request Body schema: application/json
exported
string
external_id
string
metadata
string

Responses

Request samples

Content type
application/json
{
  • "exported": "string",
  • "external_id": "string",
  • "metadata": "string"
}

Partially update Extra

Partially update Extra

Required permissions:

  • Financial: Can access / edit invoices

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_invoice_payment
required
string
id
required
integer

A unique integer value identifying this invoice payment extras.

Request Body schema: application/json
exported
string
external_id
string
metadata
string

Responses

Request samples

Content type
application/json
{
  • "exported": "string",
  • "external_id": "string",
  • "metadata": "string"
}

Archive Extra

Archive Extra

Required permissions:

  • Financial: Can access / edit invoices

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_invoice_payment
required
string
id
required
integer

A unique integer value identifying this invoice payment extras.

Responses

invoicerow_draft

Required permissions:

Required permissions:

  • Financial: Can access / edit invoices

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

ordering
string

Which field to use when ordering the results.

Responses

Required permissions:

Required permissions:

  • Financial: Can access / edit invoices

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this invoice row draft.

query Parameters
ordering
string

Which field to use when ordering the results.

Responses

Finalizes draft cabinet item

Finalizes draft cabinet item

Required permissions:

  • Financial: Can access / edit invoices

This endpoint is rate-limited to 100 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this invoice row draft.

Request Body schema: application/json
invoice
string
invoice_row
string
status
string
consultation_item
string
item
required
string
is_cabinet_item
required
boolean
patient
string
supervising_veterinarian
string
units
number

Responses

Request samples

Content type
application/json
{
  • "invoice": "string",
  • "invoice_row": "string",
  • "status": "string",
  • "consultation_item": "string",
  • "item": "string",
  • "is_cabinet_item": true,
  • "patient": "string",
  • "supervising_veterinarian": "string",
  • "units": 0
}

Items

List Items

List Items

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 100 requests per minute.

query Parameters
code
string
name
string
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

department
string
ordering
string

Which field to use when ordering the results.

include_archived
string

Set to 'true' to include archived items in results

only_cabinet_items
string

Set to 'true' to only include cabinet items in results

Responses

Insert or update Items.

Insert or update Items.

If callback (url) is provided, the processing is done in a task and processing result will be sent to the url.

Parameters in JSON:

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 300 requests per minute.

Responses

Get Item by ID

Get Item by ID

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this item.

query Parameters
code
string
name
string
department
string
ordering
string

Which field to use when ordering the results.

include_archived
string

Set to 'true' to include archived items in results

only_cabinet_items
string

Set to 'true' to only include cabinet items in results

Responses

Items

Items

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this item.

query Parameters
code
string
name
string
department
string
ordering
string

Which field to use when ordering the results.

include_archived
string

Set to 'true' to include archived items in results

only_cabinet_items
string

Set to 'true' to only include cabinet items in results

Request Body schema: application/json
main_item
string
barcode
string
account_number
string
print_name
string
hide_on_consultation
boolean
price
number
price_with_vat
number
minimum_price
number
minimum_price_with_vat
number
wholesale_price
number
wholesaler_discount
number
producer_discount
number
special_discount
number
margin_percent
number
vat_group
required
string
invoice_group
string
item_list
required
string
type_code
required
string

ITEM_TYPE_PROCEDURE = 1, ITEM_TYPE_MEDICINE = 2, ITEM_TYPE_SUPPLY = 3, ITEM_TYPE_FOOD = 4, ITEM_TYPE_LABORATORY_ANALYSIS = 5, ITEM_TYPE_LABORATORY_ANALYSIS_PANEL = 6

parent_amount
number
instructions
string
archived
boolean
archived_datetime
string
exclude_discount
boolean
hide_zero_print
boolean
linked_items
Array of strings
reporting_dimension_1
string

Primarily code is used, if not found id is used

reporting_dimension_2
string

Primarily code is used, if not found id is used

hide_on_countersale_search
boolean
performed_by_rule
string

PERFORMED_BY_INHERIT = 0, PERFORMED_BY_REQUIRED = 1, PERFORMED_BY_NOT_REQUIRED = 2

royalty_fee
integer
external_reporting_code
string
external_reporting_code_2
string
external_reporting_code_3
string
hide_on_consultation_search
boolean
disable_price_calculation
boolean
species
Array of strings
no_department_rates
boolean
related_diagnoses_groups
Array of strings
conditional_price_overrides
Array of strings

Responses

Request samples

Content type
application/json
{
  • "main_item": "string",
  • "barcode": "string",
  • "account_number": "string",
  • "print_name": "string",
  • "hide_on_consultation": true,
  • "price": 0,
  • "price_with_vat": 0,
  • "minimum_price": 0,
  • "minimum_price_with_vat": 0,
  • "wholesale_price": 0,
  • "wholesaler_discount": 0,
  • "producer_discount": 0,
  • "special_discount": 0,
  • "margin_percent": 0,
  • "vat_group": "string",
  • "invoice_group": "string",
  • "item_list": "string",
  • "type_code": "string",
  • "parent_amount": 0,
  • "instructions": "string",
  • "archived": true,
  • "archived_datetime": "string",
  • "exclude_discount": true,
  • "hide_zero_print": true,
  • "linked_items": [
    ],
  • "reporting_dimension_1": "string",
  • "reporting_dimension_2": "string",
  • "hide_on_countersale_search": true,
  • "performed_by_rule": "string",
  • "royalty_fee": 0,
  • "external_reporting_code": "string",
  • "external_reporting_code_2": "string",
  • "external_reporting_code_3": "string",
  • "hide_on_consultation_search": true,
  • "disable_price_calculation": true,
  • "species": [
    ],
  • "no_department_rates": true,
  • "related_diagnoses_groups": [
    ],
  • "conditional_price_overrides": [
    ]
}

Items

Items

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this item.

query Parameters
code
string
name
string
department
string
ordering
string

Which field to use when ordering the results.

include_archived
string

Set to 'true' to include archived items in results

only_cabinet_items
string

Set to 'true' to only include cabinet items in results

Request Body schema: application/json
main_item
string
barcode
string
account_number
string
print_name
string
hide_on_consultation
boolean
price
number
price_with_vat
number
minimum_price
number
minimum_price_with_vat
number
wholesale_price
number
wholesaler_discount
number
producer_discount
number
special_discount
number
margin_percent
number
vat_group
string
invoice_group
string
item_list
string
type_code
string

ITEM_TYPE_PROCEDURE = 1, ITEM_TYPE_MEDICINE = 2, ITEM_TYPE_SUPPLY = 3, ITEM_TYPE_FOOD = 4, ITEM_TYPE_LABORATORY_ANALYSIS = 5, ITEM_TYPE_LABORATORY_ANALYSIS_PANEL = 6

parent_amount
number
instructions
string
archived
boolean
archived_datetime
string
exclude_discount
boolean
hide_zero_print
boolean
linked_items
Array of strings
reporting_dimension_1
string

Primarily code is used, if not found id is used

reporting_dimension_2
string

Primarily code is used, if not found id is used

hide_on_countersale_search
boolean
performed_by_rule
string

PERFORMED_BY_INHERIT = 0, PERFORMED_BY_REQUIRED = 1, PERFORMED_BY_NOT_REQUIRED = 2

royalty_fee
integer
external_reporting_code
string
external_reporting_code_2
string
external_reporting_code_3
string
hide_on_consultation_search
boolean
disable_price_calculation
boolean
species
Array of strings
no_department_rates
boolean
related_diagnoses_groups
Array of strings
conditional_price_overrides
Array of strings

Responses

Request samples

Content type
application/json
{
  • "main_item": "string",
  • "barcode": "string",
  • "account_number": "string",
  • "print_name": "string",
  • "hide_on_consultation": true,
  • "price": 0,
  • "price_with_vat": 0,
  • "minimum_price": 0,
  • "minimum_price_with_vat": 0,
  • "wholesale_price": 0,
  • "wholesaler_discount": 0,
  • "producer_discount": 0,
  • "special_discount": 0,
  • "margin_percent": 0,
  • "vat_group": "string",
  • "invoice_group": "string",
  • "item_list": "string",
  • "type_code": "string",
  • "parent_amount": 0,
  • "instructions": "string",
  • "archived": true,
  • "archived_datetime": "string",
  • "exclude_discount": true,
  • "hide_zero_print": true,
  • "linked_items": [
    ],
  • "reporting_dimension_1": "string",
  • "reporting_dimension_2": "string",
  • "hide_on_countersale_search": true,
  • "performed_by_rule": "string",
  • "royalty_fee": 0,
  • "external_reporting_code": "string",
  • "external_reporting_code_2": "string",
  • "external_reporting_code_3": "string",
  • "hide_on_consultation_search": true,
  • "disable_price_calculation": true,
  • "species": [
    ],
  • "no_department_rates": true,
  • "related_diagnoses_groups": [
    ],
  • "conditional_price_overrides": [
    ]
}

Add batch to stock

Add batch to stock

Adds a batch to stock for selected department to default location.

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 100 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this item.

query Parameters
include_archived
string

Set to 'true' to include archived items in results

only_cabinet_items
string

Set to 'true' to only include cabinet items in results

Request Body schema: application/json
main_item
string
code
string
barcode
string
account_number
string
name
required
string
print_name
string
hide_on_consultation
boolean
price
number
price_with_vat
number
minimum_price
number
minimum_price_with_vat
number
wholesale_price
number
wholesaler_discount
number
producer_discount
number
special_discount
number
margin_percent
number
vat_group
required
string
invoice_group
string
item_list
required
string
type_code
required
string

ITEM_TYPE_PROCEDURE = 1, ITEM_TYPE_MEDICINE = 2, ITEM_TYPE_SUPPLY = 3, ITEM_TYPE_FOOD = 4, ITEM_TYPE_LABORATORY_ANALYSIS = 5, ITEM_TYPE_LABORATORY_ANALYSIS_PANEL = 6

parent_amount
number
instructions
string
archived
boolean
archived_datetime
string
exclude_discount
boolean
hide_zero_print
boolean
linked_items
Array of strings
reporting_dimension_1
string

Primarily code is used, if not found id is used

reporting_dimension_2
string

Primarily code is used, if not found id is used

hide_on_countersale_search
boolean
performed_by_rule
string

PERFORMED_BY_INHERIT = 0, PERFORMED_BY_REQUIRED = 1, PERFORMED_BY_NOT_REQUIRED = 2

royalty_fee
integer
external_reporting_code
string
external_reporting_code_2
string
external_reporting_code_3
string
hide_on_consultation_search
boolean
disable_price_calculation
boolean
species
Array of strings
no_department_rates
boolean
related_diagnoses_groups
Array of strings
conditional_price_overrides
Array of strings

Responses

Request samples

Content type
application/json
{
  • "main_item": "string",
  • "code": "string",
  • "barcode": "string",
  • "account_number": "string",
  • "name": "string",
  • "print_name": "string",
  • "hide_on_consultation": true,
  • "price": 0,
  • "price_with_vat": 0,
  • "minimum_price": 0,
  • "minimum_price_with_vat": 0,
  • "wholesale_price": 0,
  • "wholesaler_discount": 0,
  • "producer_discount": 0,
  • "special_discount": 0,
  • "margin_percent": 0,
  • "vat_group": "string",
  • "invoice_group": "string",
  • "item_list": "string",
  • "type_code": "string",
  • "parent_amount": 0,
  • "instructions": "string",
  • "archived": true,
  • "archived_datetime": "string",
  • "exclude_discount": true,
  • "hide_zero_print": true,
  • "linked_items": [
    ],
  • "reporting_dimension_1": "string",
  • "reporting_dimension_2": "string",
  • "hide_on_countersale_search": true,
  • "performed_by_rule": "string",
  • "royalty_fee": 0,
  • "external_reporting_code": "string",
  • "external_reporting_code_2": "string",
  • "external_reporting_code_3": "string",
  • "hide_on_consultation_search": true,
  • "disable_price_calculation": true,
  • "species": [
    ],
  • "no_department_rates": true,
  • "related_diagnoses_groups": [
    ],
  • "conditional_price_overrides": [
    ]
}

Create Invoice or Prepayment

Create Invoice or Prepayment

Used for importing old Invoices from an old system.

If total > 0, an invoice is created. If total < 0, a prepayment is created.

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 100 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this item.

query Parameters
include_archived
string

Set to 'true' to include archived items in results

only_cabinet_items
string

Set to 'true' to only include cabinet items in results

Request Body schema: application/json
main_item
string
code
string
barcode
string
account_number
string
name
required
string
print_name
string
hide_on_consultation
boolean
price
number
price_with_vat
number
minimum_price
number
minimum_price_with_vat
number
wholesale_price
number
wholesaler_discount
number
producer_discount
number
special_discount
number
margin_percent
number
vat_group
required
string
invoice_group
string
item_list
required
string
type_code
required
string

ITEM_TYPE_PROCEDURE = 1, ITEM_TYPE_MEDICINE = 2, ITEM_TYPE_SUPPLY = 3, ITEM_TYPE_FOOD = 4, ITEM_TYPE_LABORATORY_ANALYSIS = 5, ITEM_TYPE_LABORATORY_ANALYSIS_PANEL = 6

parent_amount
number
instructions
string
archived
boolean
archived_datetime
string
exclude_discount
boolean
hide_zero_print
boolean
linked_items
Array of strings
reporting_dimension_1
string

Primarily code is used, if not found id is used

reporting_dimension_2
string

Primarily code is used, if not found id is used

hide_on_countersale_search
boolean
performed_by_rule
string

PERFORMED_BY_INHERIT = 0, PERFORMED_BY_REQUIRED = 1, PERFORMED_BY_NOT_REQUIRED = 2

royalty_fee
integer
external_reporting_code
string
external_reporting_code_2
string
external_reporting_code_3
string
hide_on_consultation_search
boolean
disable_price_calculation
boolean
species
Array of strings
no_department_rates
boolean
related_diagnoses_groups
Array of strings
conditional_price_overrides
Array of strings

Responses

Request samples

Content type
application/json
{
  • "main_item": "string",
  • "code": "string",
  • "barcode": "string",
  • "account_number": "string",
  • "name": "string",
  • "print_name": "string",
  • "hide_on_consultation": true,
  • "price": 0,
  • "price_with_vat": 0,
  • "minimum_price": 0,
  • "minimum_price_with_vat": 0,
  • "wholesale_price": 0,
  • "wholesaler_discount": 0,
  • "producer_discount": 0,
  • "special_discount": 0,
  • "margin_percent": 0,
  • "vat_group": "string",
  • "invoice_group": "string",
  • "item_list": "string",
  • "type_code": "string",
  • "parent_amount": 0,
  • "instructions": "string",
  • "archived": true,
  • "archived_datetime": "string",
  • "exclude_discount": true,
  • "hide_zero_print": true,
  • "linked_items": [
    ],
  • "reporting_dimension_1": "string",
  • "reporting_dimension_2": "string",
  • "hide_on_countersale_search": true,
  • "performed_by_rule": "string",
  • "royalty_fee": 0,
  • "external_reporting_code": "string",
  • "external_reporting_code_2": "string",
  • "external_reporting_code_3": "string",
  • "hide_on_consultation_search": true,
  • "disable_price_calculation": true,
  • "species": [
    ],
  • "no_department_rates": true,
  • "related_diagnoses_groups": [
    ],
  • "conditional_price_overrides": [
    ]
}

Set item's stock level at default location

Set item's stock level at default location

Set item's stock level to a certain amount on a specific department. For other locations and batches/tracking numbers, use inventory endpoint.

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 100 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this item.

query Parameters
include_archived
string

Set to 'true' to include archived items in results

only_cabinet_items
string

Set to 'true' to only include cabinet items in results

Request Body schema: application/json
main_item
string
code
string
barcode
string
account_number
string
name
required
string
print_name
string
hide_on_consultation
boolean
price
number
price_with_vat
number
minimum_price
number
minimum_price_with_vat
number
wholesale_price
number
wholesaler_discount
number
producer_discount
number
special_discount
number
margin_percent
number
vat_group
required
string
invoice_group
string
item_list
required
string
type_code
required
string

ITEM_TYPE_PROCEDURE = 1, ITEM_TYPE_MEDICINE = 2, ITEM_TYPE_SUPPLY = 3, ITEM_TYPE_FOOD = 4, ITEM_TYPE_LABORATORY_ANALYSIS = 5, ITEM_TYPE_LABORATORY_ANALYSIS_PANEL = 6

parent_amount
number
instructions
string
archived
boolean
archived_datetime
string
exclude_discount
boolean
hide_zero_print
boolean
linked_items
Array of strings
reporting_dimension_1
string

Primarily code is used, if not found id is used

reporting_dimension_2
string

Primarily code is used, if not found id is used

hide_on_countersale_search
boolean
performed_by_rule
string

PERFORMED_BY_INHERIT = 0, PERFORMED_BY_REQUIRED = 1, PERFORMED_BY_NOT_REQUIRED = 2

royalty_fee
integer
external_reporting_code
string
external_reporting_code_2
string
external_reporting_code_3
string
hide_on_consultation_search
boolean
disable_price_calculation
boolean
species
Array of strings
no_department_rates
boolean
related_diagnoses_groups
Array of strings
conditional_price_overrides
Array of strings

Responses

Request samples

Content type
application/json
{
  • "main_item": "string",
  • "code": "string",
  • "barcode": "string",
  • "account_number": "string",
  • "name": "string",
  • "print_name": "string",
  • "hide_on_consultation": true,
  • "price": 0,
  • "price_with_vat": 0,
  • "minimum_price": 0,
  • "minimum_price_with_vat": 0,
  • "wholesale_price": 0,
  • "wholesaler_discount": 0,
  • "producer_discount": 0,
  • "special_discount": 0,
  • "margin_percent": 0,
  • "vat_group": "string",
  • "invoice_group": "string",
  • "item_list": "string",
  • "type_code": "string",
  • "parent_amount": 0,
  • "instructions": "string",
  • "archived": true,
  • "archived_datetime": "string",
  • "exclude_discount": true,
  • "hide_zero_print": true,
  • "linked_items": [
    ],
  • "reporting_dimension_1": "string",
  • "reporting_dimension_2": "string",
  • "hide_on_countersale_search": true,
  • "performed_by_rule": "string",
  • "royalty_fee": 0,
  • "external_reporting_code": "string",
  • "external_reporting_code_2": "string",
  • "external_reporting_code_3": "string",
  • "hide_on_consultation_search": true,
  • "disable_price_calculation": true,
  • "species": [
    ],
  • "no_department_rates": true,
  • "related_diagnoses_groups": [
    ],
  • "conditional_price_overrides": [
    ]
}

item_diagnosis_group

Required permissions:

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

ordering
string

Which field to use when ordering the results.

Responses

Required permissions:

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this item diagnosis group.

query Parameters
ordering
string

Which field to use when ordering the results.

Responses

Item size descriptions

List unit and package descriptions of items

List unit and package descriptions of items

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 100 requests per minute.

query Parameters
department_id
string

Only include items from a specific department's item list

include_archived
string

Set to 'true' to include archived items

only_cabinet_items
string

Set to 'true' to include only cabinet items

Responses

Item lists

List Item Lists

List Item Lists

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Create new Item List

Create new Item List

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 300 requests per minute.

Request Body schema: application/json
name
required
string
central
boolean

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "central": true
}

Get Item List by ID

Get Item List by ID

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this item list.

Responses

Update Item List

Update Item List

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this item list.

Request Body schema: application/json
name
required
string
central
boolean

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "central": true
}

Partially update Item List

Partially update Item List

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this item list.

Request Body schema: application/json
name
string
central
boolean

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "central": true
}

Item subgroups

List Groups

List Groups

Type_codes are:

  • Procedure = 1
  • Medicine = 2
  • Supply = 3
  • Food = 4
  • Laboratory analysis = 5
  • Laboratory analysis panel = 6

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Create new Group

Create new Group

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 300 requests per minute.

Request Body schema: application/json
title
required
string
type_code
required
integer
account_number
string
parent
string
children
Array of strings

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "type_code": 0,
  • "account_number": "string",
  • "parent": "string",
  • "children": [
    ]
}

Get Group by ID

Get Group by ID

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this Item subgroup.

Responses

Update Group

Update Group

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this Item subgroup.

Request Body schema: application/json
title
required
string
type_code
required
integer
account_number
string
parent
string
children
Array of strings

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "type_code": 0,
  • "account_number": "string",
  • "parent": "string",
  • "children": [
    ]
}

Partially update Group

Partially update Group

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this Item subgroup.

Request Body schema: application/json
title
string
type_code
integer
account_number
string
parent
string
children
Array of strings

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "type_code": 0,
  • "account_number": "string",
  • "parent": "string",
  • "children": [
    ]
}

Archive Group

Archive Group

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this Item subgroup.

Responses

Bundles (Item templates)

List Bundles

List Bundles

Required permissions:

  • Settings: Can access / edit templates

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Create new Bundle

Create new Bundle

Required permissions:

  • Settings: Can access / edit templates

This endpoint is rate-limited to 300 requests per minute.

Request Body schema: application/json
name
required
string
department
string
item_list
required
string
use_fixed_price
boolean
fixed_price
number

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "department": "string",
  • "item_list": "string",
  • "use_fixed_price": true,
  • "fixed_price": 0
}

Get Bundle by ID

Get Bundle by ID

Required permissions:

  • Settings: Can access / edit templates

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this estimate template.

Responses

Update Bundle

Update Bundle

Required permissions:

  • Settings: Can access / edit templates

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this estimate template.

Request Body schema: application/json
name
required
string
department
string
item_list
required
string
use_fixed_price
boolean
fixed_price
number

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "department": "string",
  • "item_list": "string",
  • "use_fixed_price": true,
  • "fixed_price": 0
}

Partially update Bundle

Partially update Bundle

Required permissions:

  • Settings: Can access / edit templates

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this estimate template.

Request Body schema: application/json
name
string
department
string
item_list
string
use_fixed_price
boolean
fixed_price
number

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "department": "string",
  • "item_list": "string",
  • "use_fixed_price": true,
  • "fixed_price": 0
}

Archive Bundle

Archive Bundle

Required permissions:

  • Settings: Can access / edit templates

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this estimate template.

Responses

List Items

List Items

Default selected:

  • SELECTION_UNTICKED = 0
  • SELECTION_PRETICKED = 1
  • SELECTION_MANDATORY = 2

Required permissions:

  • Settings: Can access / edit templates

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Create new Item

Create new Item

Required permissions:

  • Settings: Can access / edit templates

This endpoint is rate-limited to 300 requests per minute.

Request Body schema: application/json
template
required
string
item
required
string
code
string
name
required
string
quantity
number
units
number
usage_size
string
usage_type
string
price
number
price_with_vat
number
type_code
required
string
sum
number
sum_vat
number
sum_total
number
archived
boolean
default_selected
string
parent_linked_item
string
linked_items
Array of strings

Responses

Request samples

Content type
application/json
{
  • "template": "string",
  • "item": "string",
  • "code": "string",
  • "name": "string",
  • "quantity": 0,
  • "units": 0,
  • "usage_size": "string",
  • "usage_type": "string",
  • "price": 0,
  • "price_with_vat": 0,
  • "type_code": "string",
  • "sum": 0,
  • "sum_vat": 0,
  • "sum_total": 0,
  • "archived": true,
  • "default_selected": "string",
  • "parent_linked_item": "string",
  • "linked_items": [
    ]
}

Get Item by ID

Get Item by ID

Required permissions:

  • Settings: Can access / edit templates

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this estimate template item.

Responses

Update Item

Update Item

Required permissions:

  • Settings: Can access / edit templates

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this estimate template item.

Request Body schema: application/json
template
required
string
item
required
string
code
string
name
required
string
quantity
number
units
number
usage_size
string
usage_type
string
price
number
price_with_vat
number
type_code
required
string
sum
number
sum_vat
number
sum_total
number
archived
boolean
default_selected
string
parent_linked_item
string
linked_items
Array of strings

Responses

Request samples

Content type
application/json
{
  • "template": "string",
  • "item": "string",
  • "code": "string",
  • "name": "string",
  • "quantity": 0,
  • "units": 0,
  • "usage_size": "string",
  • "usage_type": "string",
  • "price": 0,
  • "price_with_vat": 0,
  • "type_code": "string",
  • "sum": 0,
  • "sum_vat": 0,
  • "sum_total": 0,
  • "archived": true,
  • "default_selected": "string",
  • "parent_linked_item": "string",
  • "linked_items": [
    ]
}

Partially update Item

Partially update Item

Required permissions:

  • Settings: Can access / edit templates

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this estimate template item.

Request Body schema: application/json
template
string
item
string
code
string
name
string
quantity
number
units
number
usage_size
string
usage_type
string
price
number
price_with_vat
number
type_code
string
sum
number
sum_vat
number
sum_total
number
archived
boolean
default_selected
string
parent_linked_item
string
linked_items
Array of strings

Responses

Request samples

Content type
application/json
{
  • "template": "string",
  • "item": "string",
  • "code": "string",
  • "name": "string",
  • "quantity": 0,
  • "units": 0,
  • "usage_size": "string",
  • "usage_type": "string",
  • "price": 0,
  • "price_with_vat": 0,
  • "type_code": "string",
  • "sum": 0,
  • "sum_vat": 0,
  • "sum_total": 0,
  • "archived": true,
  • "default_selected": "string",
  • "parent_linked_item": "string",
  • "linked_items": [
    ]
}

Archive Item

Archive Item

Required permissions:

  • Settings: Can access / edit templates

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this estimate template item.

Responses

Bundle in bundle

List Bundles

List Bundles

Required permissions:

  • Settings: Can access / edit templates

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Create new Bundle

Create new Bundle

Required permissions:

  • Settings: Can access / edit templates

This endpoint is rate-limited to 300 requests per minute.

Request Body schema: application/json
child_template
required
string
parent_template
required
string

Responses

Request samples

Content type
application/json
{
  • "child_template": "string",
  • "parent_template": "string"
}

Get Bundle by ID

Get Bundle by ID

Required permissions:

  • Settings: Can access / edit templates

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this estimate template in template.

Responses

Archive Bundle

Archive Bundle

Required permissions:

  • Settings: Can access / edit templates

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this estimate template in template.

Responses

Journal entries

List Journal Entries

List Journal Entries

Required permissions:

  • Financial: Can access / edit invoices

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

ordering
string

Which field to use when ordering the results.

Responses

Get Journal Entry by ID

Get Journal Entry by ID

Required permissions:

  • Financial: Can access / edit invoices

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this journal entry.

query Parameters
ordering
string

Which field to use when ordering the results.

Responses

Journal Entries

Journal Entries

Required permissions:

  • Financial: Can access / edit invoices

This endpoint is rate-limited to 100 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this journal entry.

Request Body schema: application/json
transaction_category
required
string
entry_number
required
integer
department_id
required
integer
journal_transactions
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "transaction_category": "string",
  • "entry_number": 0,
  • "department_id": 0,
  • "journal_transactions": [
    ]
}

Journal entry problems

List Journal Entry Problems

List Journal Entry Problems

Required permissions:

  • Financial: Can access / edit invoices

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

ordering
string

Which field to use when ordering the results.

Responses

Get Journal Entry Problem by ID

Get Journal Entry Problem by ID

Required permissions:

  • Financial: Can access / edit invoices

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this journal entry problem.

query Parameters
ordering
string

Which field to use when ordering the results.

Responses

Journal Entry Problems

Journal Entry Problems

Required permissions:

  • Financial: Can access / edit invoices

This endpoint is rate-limited to 100 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this journal entry problem.

Request Body schema: application/json
transaction_category
required
string
entry_number
required
integer
department_id
required
integer
journal_transaction_problems
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "transaction_category": "string",
  • "entry_number": 0,
  • "department_id": 0,
  • "journal_transaction_problems": [
    ]
}

Journal entry report logs

List Journal Entry Report Logs

List Journal Entry Report Logs

Required permissions:

  • Financial: Can access / edit invoices

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

ordering
string

Which field to use when ordering the results.

Responses

Get Journal Entry Report Log by ID

Get Journal Entry Report Log by ID

Required permissions:

  • Financial: Can access / edit invoices

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this journal report log.

query Parameters
ordering
string

Which field to use when ordering the results.

Responses

Archive Journal Entry Report Log

Archive Journal Entry Report Log

Required permissions:

  • Financial: Can access / edit invoices

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this journal report log.

query Parameters
ordering
string

Which field to use when ordering the results.

Responses

Journal transactions

List Journal Transactions

List Journal Transactions

Required permissions:

  • Financial: Can access / edit invoices

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

ordering
string

Which field to use when ordering the results.

Responses

Get Journal Transaction by ID

Get Journal Transaction by ID

Required permissions:

  • Financial: Can access / edit invoices

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this journal transaction.

query Parameters
ordering
string

Which field to use when ordering the results.

Responses

Journal Transactions

Journal Transactions

Required permissions:

  • Financial: Can access / edit invoices

This endpoint is rate-limited to 100 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this journal transaction.

Request Body schema: application/json
date
required
string
account_number
string
account_name
string
cost_center_label
required
string
project_code_label
required
string
debit
number
credit
number
discount
boolean
description
string
invoice_number
string
invoice_type
string
invoice_id
integer
invoice_row_id
integer
credited_invoice_id
integer
payment_id
integer
client_id
integer
account_type
required
string
account_group
required
string
created_user
string
created_user_id
integer
modification_logged
boolean
journal_entry
required
string

Responses

Request samples

Content type
application/json
{
  • "date": "string",
  • "account_number": "string",
  • "account_name": "string",
  • "cost_center_label": "string",
  • "project_code_label": "string",
  • "debit": 0,
  • "credit": 0,
  • "discount": true,
  • "description": "string",
  • "invoice_number": "string",
  • "invoice_type": "string",
  • "invoice_id": 0,
  • "invoice_row_id": 0,
  • "credited_invoice_id": 0,
  • "payment_id": 0,
  • "client_id": 0,
  • "account_type": "string",
  • "account_group": "string",
  • "created_user": "string",
  • "created_user_id": 0,
  • "modification_logged": true,
  • "journal_entry": "string"
}

Journal transaction problems

List Journal Transaction Problems

List Journal Transaction Problems

Required permissions:

  • Financial: Can access / edit invoices

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

ordering
string

Which field to use when ordering the results.

Responses

Get Journal Transaction Problem by ID

Get Journal Transaction Problem by ID

Required permissions:

  • Financial: Can access / edit invoices

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this journal transaction problem.

query Parameters
ordering
string

Which field to use when ordering the results.

Responses

Journal Transaction Problems

Journal Transaction Problems

Required permissions:

  • Financial: Can access / edit invoices

This endpoint is rate-limited to 100 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this journal transaction problem.

Request Body schema: application/json
date
required
string
account_number
string
account_name
string
debit
number
credit
number
discount
boolean
description
string
invoice_number
string
invoice_type
string
invoice_id
integer
invoice_row_id
integer
credited_invoice_id
integer
payment_id
integer
client_id
integer
account_type
required
string
account_group
required
string
created_user
string
created_user_id
integer
modification_logged
boolean
journal_entry_problem
required
string

Responses

Request samples

Content type
application/json
{
  • "date": "string",
  • "account_number": "string",
  • "account_name": "string",
  • "debit": 0,
  • "credit": 0,
  • "discount": true,
  • "description": "string",
  • "invoice_number": "string",
  • "invoice_type": "string",
  • "invoice_id": 0,
  • "invoice_row_id": 0,
  • "credited_invoice_id": 0,
  • "payment_id": 0,
  • "client_id": 0,
  • "account_type": "string",
  • "account_group": "string",
  • "created_user": "string",
  • "created_user_id": 0,
  • "modification_logged": true,
  • "journal_entry_problem": "string"
}

Knowledge base

List Files

List Files

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Create new File

Create new File

This endpoint is rate-limited to 300 requests per minute.

Request Body schema: application/json
description
required
string
created_user
string
modified_user
string
file
required
string
display_name
required
string
folder
string

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "created_user": "string",
  • "modified_user": "string",
  • "file": "string",
  • "display_name": "string",
  • "folder": "string"
}

Get File by ID

Get File by ID

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this knowledge base file.

Responses

Update File

Update File

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this knowledge base file.

Request Body schema: application/json
description
required
string
created_user
string
modified_user
string
file
required
string
display_name
required
string
folder
string

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "created_user": "string",
  • "modified_user": "string",
  • "file": "string",
  • "display_name": "string",
  • "folder": "string"
}

Partially update File

Partially update File

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this knowledge base file.

Request Body schema: application/json
description
string
created_user
string
modified_user
string
file
string
display_name
string
folder
string

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "created_user": "string",
  • "modified_user": "string",
  • "file": "string",
  • "display_name": "string",
  • "folder": "string"
}

Archive File

Archive File

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this knowledge base file.

Responses

List Folders

List Folders

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Create new Folder

Create new Folder

This endpoint is rate-limited to 300 requests per minute.

Request Body schema: application/json
description
required
string
created_user
string
modified_user
string
name
required
string
parent
string

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "created_user": "string",
  • "modified_user": "string",
  • "name": "string",
  • "parent": "string"
}

Get Folder by ID

Get Folder by ID

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this knowledge base folder.

Responses

Update Folder

Update Folder

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this knowledge base folder.

Request Body schema: application/json
description
required
string
created_user
string
modified_user
string
name
required
string
parent
string

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "created_user": "string",
  • "modified_user": "string",
  • "name": "string",
  • "parent": "string"
}

Partially update Folder

Partially update Folder

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this knowledge base folder.

Request Body schema: application/json
description
string
created_user
string
modified_user
string
name
string
parent
string

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "created_user": "string",
  • "modified_user": "string",
  • "name": "string",
  • "parent": "string"
}

Archive Folder

Archive Folder

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this knowledge base folder.

Responses

List Objects

List Objects

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Get Object by ID

Get Object by ID

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this knowledge base object.

Responses

laboratory_gateway

Required permissions:

Required permissions:

  • Settings: Can access / edit integration settings

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Required permissions:

Required permissions:

  • Settings: Can access / edit integration settings

This endpoint is rate-limited to 100 requests per minute.

Responses

Required permissions:

Required permissions:

  • Settings: Can access / edit integration settings

This endpoint is rate-limited to 100 requests per minute.

path Parameters
id
required
string

Responses

Required permissions:

Required permissions:

  • Settings: Can access / edit integration settings

This endpoint is rate-limited to 100 requests per minute.

path Parameters
id
required
string

Responses

Required permissions:

Required permissions:

  • Settings: Can access / edit integration settings

This endpoint is rate-limited to 100 requests per minute.

path Parameters
id
required
string

Responses

Required permissions:

Required permissions:

  • Settings: Can access / edit integration settings

This endpoint is rate-limited to 100 requests per minute.

path Parameters
id
required
string

Responses

Required permissions:

Required permissions:

  • Settings: Can access / edit integration settings

This endpoint is rate-limited to 100 requests per minute.

path Parameters
id
required
string

Responses

Laboratory analyses

List Analyses

List Analyses

Sample types are defined in Lists & Templates > Lists. sample_type field is deprecated, use coded_sample_type instead.

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 150 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

ordering
string

Which field to use when ordering the results.

include_archived
string

Set to 'true' to include archived items in results

Responses

Create new Analysis

Create new Analysis

  • Price calculations documentation: check the documentaion in the "Create new Food" (POST /food/)

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 300 requests per minute.

query Parameters
include_archived
string

Set to 'true' to include archived items in results

Request Body schema: application/json
main_item
string
code
string
barcode
string
account_number
string
name
required
string
print_name
string
hide_on_consultation
boolean
price
number
price_with_vat
number
minimum_price
number
minimum_price_with_vat
number
wholesale_price
number
wholesaler_discount
number
producer_discount
number
special_discount
number
margin_percent
number
vat_group
required
string
invoice_group
string
item_list
required
string
type_code
required
string

ITEM_TYPE_PROCEDURE = 1, ITEM_TYPE_MEDICINE = 2, ITEM_TYPE_SUPPLY = 3, ITEM_TYPE_FOOD = 4, ITEM_TYPE_LABORATORY_ANALYSIS = 5, ITEM_TYPE_LABORATORY_ANALYSIS_PANEL = 6

parent_amount
number
instructions
string
archived
boolean
archived_datetime
string
exclude_discount
boolean
hide_zero_print
boolean
linked_items
Array of strings
reporting_dimension_1
string

Primarily code is used, if not found id is used

reporting_dimension_2
string

Primarily code is used, if not found id is used

hide_on_countersale_search
boolean
performed_by_rule
string

PERFORMED_BY_INHERIT = 0, PERFORMED_BY_REQUIRED = 1, PERFORMED_BY_NOT_REQUIRED = 2

royalty_fee
integer
external_reporting_code
string
external_reporting_code_2
string
external_reporting_code_3
string
hide_on_consultation_search
boolean
disable_price_calculation
boolean
species
Array of strings
no_department_rates
boolean
related_diagnoses_groups
Array of strings
conditional_price_overrides
Array of strings
external_id
string
measurement_unit
string
sample_type
string

This field will be deprecated

coded_sample_type
string

Primarily code is used, if not found ID is used

panels
Array of strings
group
string
analysis_method
string
internal_instructions
string
for_idexx
boolean
minimum_charge
number
minimum_charge_with_vat
number

Responses

Request samples

Content type
application/json
{
  • "main_item": "string",
  • "code": "string",
  • "barcode": "string",
  • "account_number": "string",
  • "name": "string",
  • "print_name": "string",
  • "hide_on_consultation": true,
  • "price": 0,
  • "price_with_vat": 0,
  • "minimum_price": 0,
  • "minimum_price_with_vat": 0,
  • "wholesale_price": 0,
  • "wholesaler_discount": 0,
  • "producer_discount": 0,
  • "special_discount": 0,
  • "margin_percent": 0,
  • "vat_group": "string",
  • "invoice_group": "string",
  • "item_list": "string",
  • "type_code": "string",
  • "parent_amount": 0,
  • "instructions": "string",
  • "archived": true,
  • "archived_datetime": "string",
  • "exclude_discount": true,
  • "hide_zero_print": true,
  • "linked_items": [
    ],
  • "reporting_dimension_1": "string",
  • "reporting_dimension_2": "string",
  • "hide_on_countersale_search": true,
  • "performed_by_rule": "string",
  • "royalty_fee": 0,
  • "external_reporting_code": "string",
  • "external_reporting_code_2": "string",
  • "external_reporting_code_3": "string",
  • "hide_on_consultation_search": true,
  • "disable_price_calculation": true,
  • "species": [
    ],
  • "no_department_rates": true,
  • "related_diagnoses_groups": [
    ],
  • "conditional_price_overrides": [
    ],
  • "external_id": "string",
  • "measurement_unit": "string",
  • "sample_type": "string",
  • "coded_sample_type": "string",
  • "panels": [
    ],
  • "group": "string",
  • "analysis_method": "string",
  • "internal_instructions": "string",
  • "for_idexx": true,
  • "minimum_charge": 0,
  • "minimum_charge_with_vat": 0
}

Get Analysis by ID

Get Analysis by ID

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 600 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this laboratory analysis.

query Parameters
ordering
string

Which field to use when ordering the results.

include_archived
string

Set to 'true' to include archived items in results

Responses

Update Analysis

Update Analysis

  • Price calculations documentation: check the documentaion in the "Create new Food" (POST /food/)

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this laboratory analysis.

query Parameters
ordering
string

Which field to use when ordering the results.

include_archived
string

Set to 'true' to include archived items in results

Request Body schema: application/json
main_item
string
code
string
barcode
string
account_number
string
name
required
string
print_name
string
hide_on_consultation
boolean
price
number
price_with_vat
number
minimum_price
number
minimum_price_with_vat
number
wholesale_price
number
wholesaler_discount
number
producer_discount
number
special_discount
number
margin_percent
number
vat_group
required
string
invoice_group
string
item_list
required
string
type_code
required
string

ITEM_TYPE_PROCEDURE = 1, ITEM_TYPE_MEDICINE = 2, ITEM_TYPE_SUPPLY = 3, ITEM_TYPE_FOOD = 4, ITEM_TYPE_LABORATORY_ANALYSIS = 5, ITEM_TYPE_LABORATORY_ANALYSIS_PANEL = 6

parent_amount
number
instructions
string
archived
boolean
archived_datetime
string
exclude_discount
boolean
hide_zero_print
boolean
linked_items
Array of strings
reporting_dimension_1
string

Primarily code is used, if not found id is used

reporting_dimension_2
string

Primarily code is used, if not found id is used

hide_on_countersale_search
boolean
performed_by_rule
string

PERFORMED_BY_INHERIT = 0, PERFORMED_BY_REQUIRED = 1, PERFORMED_BY_NOT_REQUIRED = 2

royalty_fee
integer
external_reporting_code
string
external_reporting_code_2
string
external_reporting_code_3
string
hide_on_consultation_search
boolean
disable_price_calculation
boolean
species
Array of strings
no_department_rates
boolean
related_diagnoses_groups
Array of strings
conditional_price_overrides
Array of strings
external_id
string
measurement_unit
string
sample_type
string

This field will be deprecated

coded_sample_type
string

Primarily code is used, if not found ID is used

panels
Array of strings
group
string
analysis_method
string
internal_instructions
string
for_idexx
boolean
minimum_charge
number
minimum_charge_with_vat
number

Responses

Request samples

Content type
application/json
{
  • "main_item": "string",
  • "code": "string",
  • "barcode": "string",
  • "account_number": "string",
  • "name": "string",
  • "print_name": "string",
  • "hide_on_consultation": true,
  • "price": 0,
  • "price_with_vat": 0,
  • "minimum_price": 0,
  • "minimum_price_with_vat": 0,
  • "wholesale_price": 0,
  • "wholesaler_discount": 0,
  • "producer_discount": 0,
  • "special_discount": 0,
  • "margin_percent": 0,
  • "vat_group": "string",
  • "invoice_group": "string",
  • "item_list": "string",
  • "type_code": "string",
  • "parent_amount": 0,
  • "instructions": "string",
  • "archived": true,
  • "archived_datetime": "string",
  • "exclude_discount": true,
  • "hide_zero_print": true,
  • "linked_items": [
    ],
  • "reporting_dimension_1": "string",
  • "reporting_dimension_2": "string",
  • "hide_on_countersale_search": true,
  • "performed_by_rule": "string",
  • "royalty_fee": 0,
  • "external_reporting_code": "string",
  • "external_reporting_code_2": "string",
  • "external_reporting_code_3": "string",
  • "hide_on_consultation_search": true,
  • "disable_price_calculation": true,
  • "species": [
    ],
  • "no_department_rates": true,
  • "related_diagnoses_groups": [
    ],
  • "conditional_price_overrides": [
    ],
  • "external_id": "string",
  • "measurement_unit": "string",
  • "sample_type": "string",
  • "coded_sample_type": "string",
  • "panels": [
    ],
  • "group": "string",
  • "analysis_method": "string",
  • "internal_instructions": "string",
  • "for_idexx": true,
  • "minimum_charge": 0,
  • "minimum_charge_with_vat": 0
}

Partially update Analysis

Partially update Analysis

  • Price calculations documentation: check the documentaion in the "Create new Food" (POST /food/)

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this laboratory analysis.

query Parameters
ordering
string

Which field to use when ordering the results.

include_archived
string

Set to 'true' to include archived items in results

Request Body schema: application/json
main_item
string
code
string
barcode
string
account_number
string
name
string
print_name
string
hide_on_consultation
boolean
price
number
price_with_vat
number
minimum_price
number
minimum_price_with_vat
number
wholesale_price
number
wholesaler_discount
number
producer_discount
number
special_discount
number
margin_percent
number
vat_group
string
invoice_group
string
item_list
string
type_code
string

ITEM_TYPE_PROCEDURE = 1, ITEM_TYPE_MEDICINE = 2, ITEM_TYPE_SUPPLY = 3, ITEM_TYPE_FOOD = 4, ITEM_TYPE_LABORATORY_ANALYSIS = 5, ITEM_TYPE_LABORATORY_ANALYSIS_PANEL = 6

parent_amount
number
instructions
string
archived
boolean
archived_datetime
string
exclude_discount
boolean
hide_zero_print
boolean
linked_items
Array of strings
reporting_dimension_1
string

Primarily code is used, if not found id is used

reporting_dimension_2
string

Primarily code is used, if not found id is used

hide_on_countersale_search
boolean
performed_by_rule
string

PERFORMED_BY_INHERIT = 0, PERFORMED_BY_REQUIRED = 1, PERFORMED_BY_NOT_REQUIRED = 2

royalty_fee
integer
external_reporting_code
string
external_reporting_code_2
string
external_reporting_code_3
string
hide_on_consultation_search
boolean
disable_price_calculation
boolean
species
Array of strings
no_department_rates
boolean
related_diagnoses_groups
Array of strings
conditional_price_overrides
Array of strings
external_id
string
measurement_unit
string
sample_type
string

This field will be deprecated

coded_sample_type
string

Primarily code is used, if not found ID is used

panels
Array of strings
group
string
analysis_method
string
internal_instructions
string
for_idexx
boolean
minimum_charge
number
minimum_charge_with_vat
number

Responses

Request samples

Content type
application/json
{
  • "main_item": "string",
  • "code": "string",
  • "barcode": "string",
  • "account_number": "string",
  • "name": "string",
  • "print_name": "string",
  • "hide_on_consultation": true,
  • "price": 0,
  • "price_with_vat": 0,
  • "minimum_price": 0,
  • "minimum_price_with_vat": 0,
  • "wholesale_price": 0,
  • "wholesaler_discount": 0,
  • "producer_discount": 0,
  • "special_discount": 0,
  • "margin_percent": 0,
  • "vat_group": "string",
  • "invoice_group": "string",
  • "item_list": "string",
  • "type_code": "string",
  • "parent_amount": 0,
  • "instructions": "string",
  • "archived": true,
  • "archived_datetime": "string",
  • "exclude_discount": true,
  • "hide_zero_print": true,
  • "linked_items": [
    ],
  • "reporting_dimension_1": "string",
  • "reporting_dimension_2": "string",
  • "hide_on_countersale_search": true,
  • "performed_by_rule": "string",
  • "royalty_fee": 0,
  • "external_reporting_code": "string",
  • "external_reporting_code_2": "string",
  • "external_reporting_code_3": "string",
  • "hide_on_consultation_search": true,
  • "disable_price_calculation": true,
  • "species": [
    ],
  • "no_department_rates": true,
  • "related_diagnoses_groups": [
    ],
  • "conditional_price_overrides": [
    ],
  • "external_id": "string",
  • "measurement_unit": "string",
  • "sample_type": "string",
  • "coded_sample_type": "string",
  • "panels": [
    ],
  • "group": "string",
  • "analysis_method": "string",
  • "internal_instructions": "string",
  • "for_idexx": true,
  • "minimum_charge": 0,
  • "minimum_charge_with_vat": 0
}

Archives an item.

Archives an item.

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this laboratory analysis.

query Parameters
ordering
string

Which field to use when ordering the results.

include_archived
string

Set to 'true' to include archived items in results

Responses

List Groups

List Groups

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Create new Group

Create new Group

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 300 requests per minute.

Request Body schema: application/json
name
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Get Group by ID

Get Group by ID

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this laboratory analysis group.

Responses

Update Group

Update Group

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this laboratory analysis group.

Request Body schema: application/json
name
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Partially update Group

Partially update Group

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this laboratory analysis group.

Request Body schema: application/json
name
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Archives an item.

Archives an item.

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this laboratory analysis group.

Responses

List Panels

List Panels

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

ordering
string

Which field to use when ordering the results.

include_archived
string

Set to 'true' to include archived items in results

Responses

Create new Panel

Create new Panel

  • Price calculations documentation: check the documentaion in the "Create new Food" (POST /food/)

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 300 requests per minute.

query Parameters
include_archived
string

Set to 'true' to include archived items in results

Request Body schema: application/json
main_item
string
code
string
barcode
string
account_number
string
name
required
string
print_name
string
hide_on_consultation
boolean
price
number
price_with_vat
number
minimum_price
number
minimum_price_with_vat
number
wholesale_price
number
wholesaler_discount
number
producer_discount
number
special_discount
number
margin_percent
number
vat_group
required
string
invoice_group
string
item_list
required
string
type_code
required
string

ITEM_TYPE_PROCEDURE = 1, ITEM_TYPE_MEDICINE = 2, ITEM_TYPE_SUPPLY = 3, ITEM_TYPE_FOOD = 4, ITEM_TYPE_LABORATORY_ANALYSIS = 5, ITEM_TYPE_LABORATORY_ANALYSIS_PANEL = 6

parent_amount
number
instructions
string
archived
boolean
archived_datetime
string
exclude_discount
boolean
hide_zero_print
boolean
linked_items
Array of strings
reporting_dimension_1
string

Primarily code is used, if not found id is used

reporting_dimension_2
string

Primarily code is used, if not found id is used

hide_on_countersale_search
boolean
performed_by_rule
string

PERFORMED_BY_INHERIT = 0, PERFORMED_BY_REQUIRED = 1, PERFORMED_BY_NOT_REQUIRED = 2

royalty_fee
integer
external_reporting_code
string
external_reporting_code_2
string
external_reporting_code_3
string
hide_on_consultation_search
boolean
disable_price_calculation
boolean
species
Array of strings
no_department_rates
boolean
related_diagnoses_groups
Array of strings
conditional_price_overrides
Array of strings
group
required
string
notes
string
analysis_method
string
internal_instructions
string

Responses

Request samples

Content type
application/json
{
  • "main_item": "string",
  • "code": "string",
  • "barcode": "string",
  • "account_number": "string",
  • "name": "string",
  • "print_name": "string",
  • "hide_on_consultation": true,
  • "price": 0,
  • "price_with_vat": 0,
  • "minimum_price": 0,
  • "minimum_price_with_vat": 0,
  • "wholesale_price": 0,
  • "wholesaler_discount": 0,
  • "producer_discount": 0,
  • "special_discount": 0,
  • "margin_percent": 0,
  • "vat_group": "string",
  • "invoice_group": "string",
  • "item_list": "string",
  • "type_code": "string",
  • "parent_amount": 0,
  • "instructions": "string",
  • "archived": true,
  • "archived_datetime": "string",
  • "exclude_discount": true,
  • "hide_zero_print": true,
  • "linked_items": [
    ],
  • "reporting_dimension_1": "string",
  • "reporting_dimension_2": "string",
  • "hide_on_countersale_search": true,
  • "performed_by_rule": "string",
  • "royalty_fee": 0,
  • "external_reporting_code": "string",
  • "external_reporting_code_2": "string",
  • "external_reporting_code_3": "string",
  • "hide_on_consultation_search": true,
  • "disable_price_calculation": true,
  • "species": [
    ],
  • "no_department_rates": true,
  • "related_diagnoses_groups": [
    ],
  • "conditional_price_overrides": [
    ],
  • "group": "string",
  • "notes": "string",
  • "analysis_method": "string",
  • "internal_instructions": "string"
}

Get Panel by ID

Get Panel by ID

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this laboratory analysis panel.

query Parameters
ordering
string

Which field to use when ordering the results.

include_archived
string

Set to 'true' to include archived items in results

Responses

Update Panel

Update Panel

  • Price calculations documentation: check the documentaion in the "Create new Food" (POST /food/)

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this laboratory analysis panel.

query Parameters
ordering
string

Which field to use when ordering the results.

include_archived
string

Set to 'true' to include archived items in results

Request Body schema: application/json
main_item
string
code
string
barcode
string
account_number
string
name
required
string
print_name
string
hide_on_consultation
boolean
price
number
price_with_vat
number
minimum_price
number
minimum_price_with_vat
number
wholesale_price
number
wholesaler_discount
number
producer_discount
number
special_discount
number
margin_percent
number
vat_group
required
string
invoice_group
string
item_list
required
string
type_code
required
string

ITEM_TYPE_PROCEDURE = 1, ITEM_TYPE_MEDICINE = 2, ITEM_TYPE_SUPPLY = 3, ITEM_TYPE_FOOD = 4, ITEM_TYPE_LABORATORY_ANALYSIS = 5, ITEM_TYPE_LABORATORY_ANALYSIS_PANEL = 6

parent_amount
number
instructions
string
archived
boolean
archived_datetime
string
exclude_discount
boolean
hide_zero_print
boolean
linked_items
Array of strings
reporting_dimension_1
string

Primarily code is used, if not found id is used

reporting_dimension_2
string

Primarily code is used, if not found id is used

hide_on_countersale_search
boolean
performed_by_rule
string

PERFORMED_BY_INHERIT = 0, PERFORMED_BY_REQUIRED = 1, PERFORMED_BY_NOT_REQUIRED = 2

royalty_fee
integer
external_reporting_code
string
external_reporting_code_2
string
external_reporting_code_3
string
hide_on_consultation_search
boolean
disable_price_calculation
boolean
species
Array of strings
no_department_rates
boolean
related_diagnoses_groups
Array of strings
conditional_price_overrides
Array of strings
group
required
string
notes
string
analysis_method
string
internal_instructions
string

Responses

Request samples

Content type
application/json
{
  • "main_item": "string",
  • "code": "string",
  • "barcode": "string",
  • "account_number": "string",
  • "name": "string",
  • "print_name": "string",
  • "hide_on_consultation": true,
  • "price": 0,
  • "price_with_vat": 0,
  • "minimum_price": 0,
  • "minimum_price_with_vat": 0,
  • "wholesale_price": 0,
  • "wholesaler_discount": 0,
  • "producer_discount": 0,
  • "special_discount": 0,
  • "margin_percent": 0,
  • "vat_group": "string",
  • "invoice_group": "string",
  • "item_list": "string",
  • "type_code": "string",
  • "parent_amount": 0,
  • "instructions": "string",
  • "archived": true,
  • "archived_datetime": "string",
  • "exclude_discount": true,
  • "hide_zero_print": true,
  • "linked_items": [
    ],
  • "reporting_dimension_1": "string",
  • "reporting_dimension_2": "string",
  • "hide_on_countersale_search": true,
  • "performed_by_rule": "string",
  • "royalty_fee": 0,
  • "external_reporting_code": "string",
  • "external_reporting_code_2": "string",
  • "external_reporting_code_3": "string",
  • "hide_on_consultation_search": true,
  • "disable_price_calculation": true,
  • "species": [
    ],
  • "no_department_rates": true,
  • "related_diagnoses_groups": [
    ],
  • "conditional_price_overrides": [
    ],
  • "group": "string",
  • "notes": "string",
  • "analysis_method": "string",
  • "internal_instructions": "string"
}

Partially update Panel

Partially update Panel

  • Price calculations documentation: check the documentaion in the "Create new Food" (POST /food/)

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this laboratory analysis panel.

query Parameters
ordering
string

Which field to use when ordering the results.

include_archived
string

Set to 'true' to include archived items in results

Request Body schema: application/json
main_item
string
code
string
barcode
string
account_number
string
name
string
print_name
string
hide_on_consultation
boolean
price
number
price_with_vat
number
minimum_price
number
minimum_price_with_vat
number
wholesale_price
number
wholesaler_discount
number
producer_discount
number
special_discount
number
margin_percent
number
vat_group
string
invoice_group
string
item_list
string
type_code
string

ITEM_TYPE_PROCEDURE = 1, ITEM_TYPE_MEDICINE = 2, ITEM_TYPE_SUPPLY = 3, ITEM_TYPE_FOOD = 4, ITEM_TYPE_LABORATORY_ANALYSIS = 5, ITEM_TYPE_LABORATORY_ANALYSIS_PANEL = 6

parent_amount
number
instructions
string
archived
boolean
archived_datetime
string
exclude_discount
boolean
hide_zero_print
boolean
linked_items
Array of strings
reporting_dimension_1
string

Primarily code is used, if not found id is used

reporting_dimension_2
string

Primarily code is used, if not found id is used

hide_on_countersale_search
boolean
performed_by_rule
string

PERFORMED_BY_INHERIT = 0, PERFORMED_BY_REQUIRED = 1, PERFORMED_BY_NOT_REQUIRED = 2

royalty_fee
integer
external_reporting_code
string
external_reporting_code_2
string
external_reporting_code_3
string
hide_on_consultation_search
boolean
disable_price_calculation
boolean
species
Array of strings
no_department_rates
boolean
related_diagnoses_groups
Array of strings
conditional_price_overrides
Array of strings
group
string
notes
string
analysis_method
string
internal_instructions
string

Responses

Request samples

Content type
application/json
{
  • "main_item": "string",
  • "code": "string",
  • "barcode": "string",
  • "account_number": "string",
  • "name": "string",
  • "print_name": "string",
  • "hide_on_consultation": true,
  • "price": 0,
  • "price_with_vat": 0,
  • "minimum_price": 0,
  • "minimum_price_with_vat": 0,
  • "wholesale_price": 0,
  • "wholesaler_discount": 0,
  • "producer_discount": 0,
  • "special_discount": 0,
  • "margin_percent": 0,
  • "vat_group": "string",
  • "invoice_group": "string",
  • "item_list": "string",
  • "type_code": "string",
  • "parent_amount": 0,
  • "instructions": "string",
  • "archived": true,
  • "archived_datetime": "string",
  • "exclude_discount": true,
  • "hide_zero_print": true,
  • "linked_items": [
    ],
  • "reporting_dimension_1": "string",
  • "reporting_dimension_2": "string",
  • "hide_on_countersale_search": true,
  • "performed_by_rule": "string",
  • "royalty_fee": 0,
  • "external_reporting_code": "string",
  • "external_reporting_code_2": "string",
  • "external_reporting_code_3": "string",
  • "hide_on_consultation_search": true,
  • "disable_price_calculation": true,
  • "species": [
    ],
  • "no_department_rates": true,
  • "related_diagnoses_groups": [
    ],
  • "conditional_price_overrides": [
    ],
  • "group": "string",
  • "notes": "string",
  • "analysis_method": "string",
  • "internal_instructions": "string"
}

Archives an item.

Archives an item.

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this laboratory analysis panel.

query Parameters
ordering
string

Which field to use when ordering the results.

include_archived
string

Set to 'true' to include archived items in results

Responses

Lists

List Lists

List Lists

Required permissions:

  • Settings: Can access / edit list and list items

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Create new List

Create new List

Required permissions:

  • Settings: Can access / edit list and list items

This endpoint is rate-limited to 300 requests per minute.

Request Body schema: application/json
code_system
required
integer
type
required
string
parent_id
integer
name
required
string
is_active
boolean

Responses

Request samples

Content type
application/json
{
  • "code_system": 0,
  • "type": "string",
  • "parent_id": 0,
  • "name": "string",
  • "is_active": true
}

Get List by ID

Get List by ID

Code_system values:

  • Items in this List are editable and viewable in REST API = 1
  • Items in this List are from VeNom codes. Not viewable or editable in REST API = 2

Required permissions:

  • Settings: Can access / edit list and list items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this list.

Responses

Update List

Update List

Required permissions:

  • Settings: Can access / edit list and list items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this list.

Request Body schema: application/json
code_system
required
integer
type
required
string
parent_id
integer
name
required
string
is_active
boolean

Responses

Request samples

Content type
application/json
{
  • "code_system": 0,
  • "type": "string",
  • "parent_id": 0,
  • "name": "string",
  • "is_active": true
}

Partially update List

Partially update List

Required permissions:

  • Settings: Can access / edit list and list items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this list.

Request Body schema: application/json
code_system
integer
type
string
parent_id
integer
name
string
is_active
boolean

Responses

Request samples

Content type
application/json
{
  • "code_system": 0,
  • "type": "string",
  • "parent_id": 0,
  • "name": "string",
  • "is_active": true
}

Archive List

Archive List

Required permissions:

  • Settings: Can access / edit list and list items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this list.

Responses

List Items

List Items

Required permissions:

  • Settings: Can access / edit list and list items

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

ordering
string

Which field to use when ordering the results.

Responses

Create new Item

Create new Item

Required permissions:

  • Settings: Can access / edit list and list items

This endpoint is rate-limited to 300 requests per minute.

Request Body schema: application/json
code
required
string

Optional identifier for the item, up to 20 characters. If codes are used, they must be unique within a list.

label
required
string
list
required
string
archived
boolean

Responses

Request samples

Content type
application/json
{
  • "code": "string",
  • "label": "string",
  • "list": "string",
  • "archived": true
}

Get Item by ID

Get Item by ID

Required permissions:

  • Settings: Can access / edit list and list items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this list item.

query Parameters
ordering
string

Which field to use when ordering the results.

Responses

Update Item

Update Item

Required permissions:

  • Settings: Can access / edit list and list items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this list item.

query Parameters
ordering
string

Which field to use when ordering the results.

Request Body schema: application/json
code
required
string

Optional identifier for the item, up to 20 characters. If codes are used, they must be unique within a list.

label
required
string
list
required
string
archived
boolean

Responses

Request samples

Content type
application/json
{
  • "code": "string",
  • "label": "string",
  • "list": "string",
  • "archived": true
}

Partially update Item

Partially update Item

Required permissions:

  • Settings: Can access / edit list and list items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this list item.

query Parameters
ordering
string

Which field to use when ordering the results.

Request Body schema: application/json
code
string

Optional identifier for the item, up to 20 characters. If codes are used, they must be unique within a list.

label
string
list
string
archived
boolean

Responses

Request samples

Content type
application/json
{
  • "code": "string",
  • "label": "string",
  • "list": "string",
  • "archived": true
}

Logs

List Email Logs

List Email Logs

Required permissions:

  • Settings: Can access / edit integration settings

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Get Email Log by ID

Get Email Log by ID

Required permissions:

  • Settings: Can access / edit integration settings

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this email log.

Responses

List Integration Log Events

List Integration Log Events

Required permissions:

  • Settings: Can access / edit integration settings

This endpoint is rate-limited to 100 requests per minute.

Responses

Create new Integration Log Event

Create new Integration Log Event

Required permissions:

  • Settings: Can access / edit integration settings

This endpoint is rate-limited to 300 requests per minute.

Request Body schema: application/json
department_id
required
integer
type
string
sub_type
string
timestamp
string
message
string
status
boolean

Responses

Request samples

Content type
application/json
{
  • "department_id": 0,
  • "type": "string",
  • "sub_type": "string",
  • "timestamp": "string",
  • "message": "string",
  • "status": true
}

Get Integration Log Event

Get Integration Log Event

Required permissions:

  • Settings: Can access / edit integration settings

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
string

Responses

List SMS Logs

List SMS Logs

Required permissions:

  • Settings: Can access / edit integration settings

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Get SMS Log by ID

Get SMS Log by ID

Required permissions:

  • Settings: Can access / edit integration settings

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this sms log.

Responses

masterdataentry

List Master data entry

List Master data entry

Required permissions:

  • Settings: Can access / edit list and list items

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Get Master data entry by ID

Get Master data entry by ID

Required permissions:

  • Settings: Can access / edit list and list items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this master data entry.

Responses

Medicine

List Medicines

List Medicines

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

ordering
string

Which field to use when ordering the results.

include_archived
string

Set to 'true' to include archived items in results

Responses

Create new Medicine

Create new Medicine

  • Price calculations documentation: check the documentaion in the "Create new Food" (POST /food/)

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 300 requests per minute.

query Parameters
include_archived
string

Set to 'true' to include archived items in results

Request Body schema: application/json
main_item
string
code
string
barcode
string
account_number
string
name
required
string
print_name
string
hide_on_consultation
boolean
price
number
price_with_vat
number
minimum_price
number
minimum_price_with_vat
number
wholesale_price
number
wholesaler_discount
number
producer_discount
number
special_discount
number
margin_percent
number
vat_group
required
string
invoice_group
string
item_list
required
string
type_code
required
string

ITEM_TYPE_PROCEDURE = 1, ITEM_TYPE_MEDICINE = 2, ITEM_TYPE_SUPPLY = 3, ITEM_TYPE_FOOD = 4, ITEM_TYPE_LABORATORY_ANALYSIS = 5, ITEM_TYPE_LABORATORY_ANALYSIS_PANEL = 6

parent_amount
number
instructions
string
archived
boolean
archived_datetime
string
exclude_discount
boolean
hide_zero_print
boolean
linked_items
Array of strings
reporting_dimension_1
string

Primarily code is used, if not found id is used

reporting_dimension_2
string

Primarily code is used, if not found id is used

hide_on_countersale_search
boolean
performed_by_rule
string

PERFORMED_BY_INHERIT = 0, PERFORMED_BY_REQUIRED = 1, PERFORMED_BY_NOT_REQUIRED = 2

royalty_fee
integer
external_reporting_code
string
external_reporting_code_2
string
external_reporting_code_3
string
hide_on_consultation_search
boolean
disable_price_calculation
boolean
species
Array of strings
no_department_rates
boolean
related_diagnoses_groups
Array of strings
conditional_price_overrides
Array of strings
primary_wholesaler
string
primary_wholesaler_code
string
secondary_wholesaler
string
secondary_wholesaler_code
string
alert_level
number
internal_instructions
string
is_cabinet_item
boolean
discontinued_product
boolean

These items can no longer be added into orders

unit
string

"Unit description" in the UI.

default_order_amount
number
manufacturer
object
shelf_location
string
manufacturer_data
string
manufacturer_url
string
optimum_level
number
usage_type
string

USAGE_TYPE_ADMINISTERED = 1, USAGE_TYPE_GIVEN = 2, USAGE_TYPE_PRESCRIPTION = 3

dosage_units
number

"Units in the package" in the UI.

minimum_dosage_units
number
default_usage_size
string

USAGE_SIZE_PACKAGE = 1, USAGE_SIZE_DOSAGE_UNITS = 2

package_description
string
not_in_stock_management
boolean
active_substance
string
preparation
string
controlled_substance
boolean
measurement_loss_type
string

MEASUREMENT_LOSS_NONE = 0, MEASUREMENT_LOSS_FIXED = 1, MEASUREMENT_LOSS_ROUND = 2

default_measurement_loss_quantity
number
default_measurement_loss_units
number
vaccination
boolean
allowed_usage_type
string

"Medicine type" in the UI. USAGE_TYPE_ALLOW_ALL = 0, USAGE_TYPE_ALLOW_POM = 1, USAGE_TYPE_ALLOW_POM_VPS = 3, USAGE_TYPE_ALLOW_POM_V = 4, USAGE_TYPE_ALLOW_OTC = 2

default_administration_method
string
contraindications
string
withdrawal_periods
string
numeric_withdrawal_periods
Array of strings
dispense_fee
number
extra_label_text
string
dispense_fee_with_vat
number
injection_fee
number
injection_fee_with_vat
number
use_default_dispense_fee
boolean
use_default_injection_fee
boolean
dispense_fee_partial
number
dispense_fee_partial_with_vat
number
use_default_partial_dispense_fee
boolean
minimum_charge
number
minimum_charge_with_vat
number
batch_number_required
boolean
provider_medicine
integer
from_pharmacy
string
special_medicine
string
off_label_medicine
boolean
off_label_species
Array of strings

Responses

Request samples

Content type
application/json
{
  • "main_item": "string",
  • "code": "string",
  • "barcode": "string",
  • "account_number": "string",
  • "name": "string",
  • "print_name": "string",
  • "hide_on_consultation": true,
  • "price": 0,
  • "price_with_vat": 0,
  • "minimum_price": 0,
  • "minimum_price_with_vat": 0,
  • "wholesale_price": 0,
  • "wholesaler_discount": 0,
  • "producer_discount": 0,
  • "special_discount": 0,
  • "margin_percent": 0,
  • "vat_group": "string",
  • "invoice_group": "string",
  • "item_list": "string",
  • "type_code": "string",
  • "parent_amount": 0,
  • "instructions": "string",
  • "archived": true,
  • "archived_datetime": "string",
  • "exclude_discount": true,
  • "hide_zero_print": true,
  • "linked_items": [
    ],
  • "reporting_dimension_1": "string",
  • "reporting_dimension_2": "string",
  • "hide_on_countersale_search": true,
  • "performed_by_rule": "string",
  • "royalty_fee": 0,
  • "external_reporting_code": "string",
  • "external_reporting_code_2": "string",
  • "external_reporting_code_3": "string",
  • "hide_on_consultation_search": true,
  • "disable_price_calculation": true,
  • "species": [
    ],
  • "no_department_rates": true,
  • "related_diagnoses_groups": [
    ],
  • "conditional_price_overrides": [
    ],
  • "primary_wholesaler": "string",
  • "primary_wholesaler_code": "string",
  • "secondary_wholesaler": "string",
  • "secondary_wholesaler_code": "string",
  • "alert_level": 0,
  • "internal_instructions": "string",
  • "is_cabinet_item": true,
  • "discontinued_product": true,
  • "unit": "string",
  • "default_order_amount": 0,
  • "manufacturer": { },
  • "shelf_location": "string",
  • "manufacturer_data": "string",
  • "manufacturer_url": "string",
  • "optimum_level": 0,
  • "usage_type": "string",
  • "dosage_units": 0,
  • "minimum_dosage_units": 0,
  • "default_usage_size": "string",
  • "package_description": "string",
  • "not_in_stock_management": true,
  • "active_substance": "string",
  • "preparation": "string",
  • "controlled_substance": true,
  • "measurement_loss_type": "string",
  • "default_measurement_loss_quantity": 0,
  • "default_measurement_loss_units": 0,
  • "vaccination": true,
  • "allowed_usage_type": "string",
  • "default_administration_method": "string",
  • "contraindications": "string",
  • "withdrawal_periods": "string",
  • "numeric_withdrawal_periods": [
    ],
  • "dispense_fee": 0,
  • "extra_label_text": "string",
  • "dispense_fee_with_vat": 0,
  • "injection_fee": 0,
  • "injection_fee_with_vat": 0,
  • "use_default_dispense_fee": true,
  • "use_default_injection_fee": true,
  • "dispense_fee_partial": 0,
  • "dispense_fee_partial_with_vat": 0,
  • "use_default_partial_dispense_fee": true,
  • "minimum_charge": 0,
  • "minimum_charge_with_vat": 0,
  • "batch_number_required": true,
  • "provider_medicine": 0,
  • "from_pharmacy": "string",
  • "special_medicine": "string",
  • "off_label_medicine": true,
  • "off_label_species": [
    ]
}

Get Medicine by ID

Get Medicine by ID

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this medicine.

query Parameters
ordering
string

Which field to use when ordering the results.

include_archived
string

Set to 'true' to include archived items in results

Responses

Update Medicine

Update Medicine

  • Price calculations documentation: check the documentaion in the "Create new Food" (POST /food/)

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this medicine.

query Parameters
ordering
string

Which field to use when ordering the results.

include_archived
string

Set to 'true' to include archived items in results

Request Body schema: application/json
main_item
string
code
string
barcode
string
account_number
string
name
required
string
print_name
string
hide_on_consultation
boolean
price
number
price_with_vat
number
minimum_price
number
minimum_price_with_vat
number
wholesale_price
number
wholesaler_discount
number
producer_discount
number
special_discount
number
margin_percent
number
vat_group
required
string
invoice_group
string
item_list
required
string
type_code
required
string

ITEM_TYPE_PROCEDURE = 1, ITEM_TYPE_MEDICINE = 2, ITEM_TYPE_SUPPLY = 3, ITEM_TYPE_FOOD = 4, ITEM_TYPE_LABORATORY_ANALYSIS = 5, ITEM_TYPE_LABORATORY_ANALYSIS_PANEL = 6

parent_amount
number
instructions
string
archived
boolean
archived_datetime
string
exclude_discount
boolean
hide_zero_print
boolean
linked_items
Array of strings
reporting_dimension_1
string

Primarily code is used, if not found id is used

reporting_dimension_2
string

Primarily code is used, if not found id is used

hide_on_countersale_search
boolean
performed_by_rule
string

PERFORMED_BY_INHERIT = 0, PERFORMED_BY_REQUIRED = 1, PERFORMED_BY_NOT_REQUIRED = 2

royalty_fee
integer
external_reporting_code
string
external_reporting_code_2
string
external_reporting_code_3
string
hide_on_consultation_search
boolean
disable_price_calculation
boolean
species
Array of strings
no_department_rates
boolean
related_diagnoses_groups
Array of strings
conditional_price_overrides
Array of strings
primary_wholesaler
string
primary_wholesaler_code
string
secondary_wholesaler
string
secondary_wholesaler_code
string
alert_level
number
internal_instructions
string
is_cabinet_item
boolean
discontinued_product
boolean

These items can no longer be added into orders

unit
string

"Unit description" in the UI.

default_order_amount
number
manufacturer
object
shelf_location
string
manufacturer_data
string
manufacturer_url
string
optimum_level
number
usage_type
string

USAGE_TYPE_ADMINISTERED = 1, USAGE_TYPE_GIVEN = 2, USAGE_TYPE_PRESCRIPTION = 3

dosage_units
number

"Units in the package" in the UI.

minimum_dosage_units
number
default_usage_size
string

USAGE_SIZE_PACKAGE = 1, USAGE_SIZE_DOSAGE_UNITS = 2

package_description
string
not_in_stock_management
boolean
active_substance
string
preparation
string
controlled_substance
boolean
measurement_loss_type
string

MEASUREMENT_LOSS_NONE = 0, MEASUREMENT_LOSS_FIXED = 1, MEASUREMENT_LOSS_ROUND = 2

default_measurement_loss_quantity
number
default_measurement_loss_units
number
vaccination
boolean
allowed_usage_type
string

"Medicine type" in the UI. USAGE_TYPE_ALLOW_ALL = 0, USAGE_TYPE_ALLOW_POM = 1, USAGE_TYPE_ALLOW_POM_VPS = 3, USAGE_TYPE_ALLOW_POM_V = 4, USAGE_TYPE_ALLOW_OTC = 2

default_administration_method
string
contraindications
string
withdrawal_periods
string
numeric_withdrawal_periods
Array of strings
dispense_fee
number
extra_label_text
string
dispense_fee_with_vat
number
injection_fee
number
injection_fee_with_vat
number
use_default_dispense_fee
boolean
use_default_injection_fee
boolean
dispense_fee_partial
number
dispense_fee_partial_with_vat
number
use_default_partial_dispense_fee
boolean
minimum_charge
number
minimum_charge_with_vat
number
batch_number_required
boolean
provider_medicine
integer
from_pharmacy
string
special_medicine
string
off_label_medicine
boolean
off_label_species
Array of strings

Responses

Request samples

Content type
application/json
{
  • "main_item": "string",
  • "code": "string",
  • "barcode": "string",
  • "account_number": "string",
  • "name": "string",
  • "print_name": "string",
  • "hide_on_consultation": true,
  • "price": 0,
  • "price_with_vat": 0,
  • "minimum_price": 0,
  • "minimum_price_with_vat": 0,
  • "wholesale_price": 0,
  • "wholesaler_discount": 0,
  • "producer_discount": 0,
  • "special_discount": 0,
  • "margin_percent": 0,
  • "vat_group": "string",
  • "invoice_group": "string",
  • "item_list": "string",
  • "type_code": "string",
  • "parent_amount": 0,
  • "instructions": "string",
  • "archived": true,
  • "archived_datetime": "string",
  • "exclude_discount": true,
  • "hide_zero_print": true,
  • "linked_items": [
    ],
  • "reporting_dimension_1": "string",
  • "reporting_dimension_2": "string",
  • "hide_on_countersale_search": true,
  • "performed_by_rule": "string",
  • "royalty_fee": 0,
  • "external_reporting_code": "string",
  • "external_reporting_code_2": "string",
  • "external_reporting_code_3": "string",
  • "hide_on_consultation_search": true,
  • "disable_price_calculation": true,
  • "species": [
    ],
  • "no_department_rates": true,
  • "related_diagnoses_groups": [
    ],
  • "conditional_price_overrides": [
    ],
  • "primary_wholesaler": "string",
  • "primary_wholesaler_code": "string",
  • "secondary_wholesaler": "string",
  • "secondary_wholesaler_code": "string",
  • "alert_level": 0,
  • "internal_instructions": "string",
  • "is_cabinet_item": true,
  • "discontinued_product": true,
  • "unit": "string",
  • "default_order_amount": 0,
  • "manufacturer": { },
  • "shelf_location": "string",
  • "manufacturer_data": "string",
  • "manufacturer_url": "string",
  • "optimum_level": 0,
  • "usage_type": "string",
  • "dosage_units": 0,
  • "minimum_dosage_units": 0,
  • "default_usage_size": "string",
  • "package_description": "string",
  • "not_in_stock_management": true,
  • "active_substance": "string",
  • "preparation": "string",
  • "controlled_substance": true,
  • "measurement_loss_type": "string",
  • "default_measurement_loss_quantity": 0,
  • "default_measurement_loss_units": 0,
  • "vaccination": true,
  • "allowed_usage_type": "string",
  • "default_administration_method": "string",
  • "contraindications": "string",
  • "withdrawal_periods": "string",
  • "numeric_withdrawal_periods": [
    ],
  • "dispense_fee": 0,
  • "extra_label_text": "string",
  • "dispense_fee_with_vat": 0,
  • "injection_fee": 0,
  • "injection_fee_with_vat": 0,
  • "use_default_dispense_fee": true,
  • "use_default_injection_fee": true,
  • "dispense_fee_partial": 0,
  • "dispense_fee_partial_with_vat": 0,
  • "use_default_partial_dispense_fee": true,
  • "minimum_charge": 0,
  • "minimum_charge_with_vat": 0,
  • "batch_number_required": true,
  • "provider_medicine": 0,
  • "from_pharmacy": "string",
  • "special_medicine": "string",
  • "off_label_medicine": true,
  • "off_label_species": [
    ]
}

Partially update Medicine

Partially update Medicine

  • Price calculations documentation: check the documentaion in the "Create new Food" (POST /food/)

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this medicine.

query Parameters
ordering
string

Which field to use when ordering the results.

include_archived
string

Set to 'true' to include archived items in results

Request Body schema: application/json
main_item
string
code
string
barcode
string
account_number
string
name
string
print_name
string
hide_on_consultation
boolean
price
number
price_with_vat
number
minimum_price
number
minimum_price_with_vat
number
wholesale_price
number
wholesaler_discount
number
producer_discount
number
special_discount
number
margin_percent
number
vat_group
string
invoice_group
string
item_list
string
type_code
string

ITEM_TYPE_PROCEDURE = 1, ITEM_TYPE_MEDICINE = 2, ITEM_TYPE_SUPPLY = 3, ITEM_TYPE_FOOD = 4, ITEM_TYPE_LABORATORY_ANALYSIS = 5, ITEM_TYPE_LABORATORY_ANALYSIS_PANEL = 6

parent_amount
number
instructions
string
archived
boolean
archived_datetime
string
exclude_discount
boolean
hide_zero_print
boolean
linked_items
Array of strings
reporting_dimension_1
string

Primarily code is used, if not found id is used

reporting_dimension_2
string

Primarily code is used, if not found id is used

hide_on_countersale_search
boolean
performed_by_rule
string

PERFORMED_BY_INHERIT = 0, PERFORMED_BY_REQUIRED = 1, PERFORMED_BY_NOT_REQUIRED = 2

royalty_fee
integer
external_reporting_code
string
external_reporting_code_2
string
external_reporting_code_3
string
hide_on_consultation_search
boolean
disable_price_calculation
boolean
species
Array of strings
no_department_rates
boolean
related_diagnoses_groups
Array of strings
conditional_price_overrides
Array of strings
primary_wholesaler
string
primary_wholesaler_code
string
secondary_wholesaler
string
secondary_wholesaler_code
string
alert_level
number
internal_instructions
string
is_cabinet_item
boolean
discontinued_product
boolean

These items can no longer be added into orders

unit
string

"Unit description" in the UI.

default_order_amount
number
manufacturer
object
shelf_location
string
manufacturer_data
string
manufacturer_url
string
optimum_level
number
usage_type
string

USAGE_TYPE_ADMINISTERED = 1, USAGE_TYPE_GIVEN = 2, USAGE_TYPE_PRESCRIPTION = 3

dosage_units
number

"Units in the package" in the UI.

minimum_dosage_units
number
default_usage_size
string

USAGE_SIZE_PACKAGE = 1, USAGE_SIZE_DOSAGE_UNITS = 2

package_description
string
not_in_stock_management
boolean
active_substance
string
preparation
string
controlled_substance
boolean
measurement_loss_type
string

MEASUREMENT_LOSS_NONE = 0, MEASUREMENT_LOSS_FIXED = 1, MEASUREMENT_LOSS_ROUND = 2

default_measurement_loss_quantity
number
default_measurement_loss_units
number
vaccination
boolean
allowed_usage_type
string

"Medicine type" in the UI. USAGE_TYPE_ALLOW_ALL = 0, USAGE_TYPE_ALLOW_POM = 1, USAGE_TYPE_ALLOW_POM_VPS = 3, USAGE_TYPE_ALLOW_POM_V = 4, USAGE_TYPE_ALLOW_OTC = 2

default_administration_method
string
contraindications
string
withdrawal_periods
string
numeric_withdrawal_periods
Array of strings
dispense_fee
number
extra_label_text
string
dispense_fee_with_vat
number
injection_fee
number
injection_fee_with_vat
number
use_default_dispense_fee
boolean
use_default_injection_fee
boolean
dispense_fee_partial
number
dispense_fee_partial_with_vat
number
use_default_partial_dispense_fee
boolean
minimum_charge
number
minimum_charge_with_vat
number
batch_number_required
boolean
provider_medicine
integer
from_pharmacy
string
special_medicine
string
off_label_medicine
boolean
off_label_species
Array of strings

Responses

Request samples

Content type
application/json
{
  • "main_item": "string",
  • "code": "string",
  • "barcode": "string",
  • "account_number": "string",
  • "name": "string",
  • "print_name": "string",
  • "hide_on_consultation": true,
  • "price": 0,
  • "price_with_vat": 0,
  • "minimum_price": 0,
  • "minimum_price_with_vat": 0,
  • "wholesale_price": 0,
  • "wholesaler_discount": 0,
  • "producer_discount": 0,
  • "special_discount": 0,
  • "margin_percent": 0,
  • "vat_group": "string",
  • "invoice_group": "string",
  • "item_list": "string",
  • "type_code": "string",
  • "parent_amount": 0,
  • "instructions": "string",
  • "archived": true,
  • "archived_datetime": "string",
  • "exclude_discount": true,
  • "hide_zero_print": true,
  • "linked_items": [
    ],
  • "reporting_dimension_1": "string",
  • "reporting_dimension_2": "string",
  • "hide_on_countersale_search": true,
  • "performed_by_rule": "string",
  • "royalty_fee": 0,
  • "external_reporting_code": "string",
  • "external_reporting_code_2": "string",
  • "external_reporting_code_3": "string",
  • "hide_on_consultation_search": true,
  • "disable_price_calculation": true,
  • "species": [
    ],
  • "no_department_rates": true,
  • "related_diagnoses_groups": [
    ],
  • "conditional_price_overrides": [
    ],
  • "primary_wholesaler": "string",
  • "primary_wholesaler_code": "string",
  • "secondary_wholesaler": "string",
  • "secondary_wholesaler_code": "string",
  • "alert_level": 0,
  • "internal_instructions": "string",
  • "is_cabinet_item": true,
  • "discontinued_product": true,
  • "unit": "string",
  • "default_order_amount": 0,
  • "manufacturer": { },
  • "shelf_location": "string",
  • "manufacturer_data": "string",
  • "manufacturer_url": "string",
  • "optimum_level": 0,
  • "usage_type": "string",
  • "dosage_units": 0,
  • "minimum_dosage_units": 0,
  • "default_usage_size": "string",
  • "package_description": "string",
  • "not_in_stock_management": true,
  • "active_substance": "string",
  • "preparation": "string",
  • "controlled_substance": true,
  • "measurement_loss_type": "string",
  • "default_measurement_loss_quantity": 0,
  • "default_measurement_loss_units": 0,
  • "vaccination": true,
  • "allowed_usage_type": "string",
  • "default_administration_method": "string",
  • "contraindications": "string",
  • "withdrawal_periods": "string",
  • "numeric_withdrawal_periods": [
    ],
  • "dispense_fee": 0,
  • "extra_label_text": "string",
  • "dispense_fee_with_vat": 0,
  • "injection_fee": 0,
  • "injection_fee_with_vat": 0,
  • "use_default_dispense_fee": true,
  • "use_default_injection_fee": true,
  • "dispense_fee_partial": 0,
  • "dispense_fee_partial_with_vat": 0,
  • "use_default_partial_dispense_fee": true,
  • "minimum_charge": 0,
  • "minimum_charge_with_vat": 0,
  • "batch_number_required": true,
  • "provider_medicine": 0,
  • "from_pharmacy": "string",
  • "special_medicine": "string",
  • "off_label_medicine": true,
  • "off_label_species": [
    ]
}

Archives an item.

Archives an item.

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this medicine.

query Parameters
ordering
string

Which field to use when ordering the results.

include_archived
string

Set to 'true' to include archived items in results

Responses

Modality

List Modality

List Modality

Required permissions:

  • Settings: Can access / edit integration settings

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Get Modality by ID

Get Modality by ID

Required permissions:

  • Settings: Can access / edit integration settings

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this modality.

Responses

Notes

List Notes

List Notes

Required permissions:

  • General: Can add notes and communication

This endpoint is rate-limited to 50 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

ordering
string

Which field to use when ordering the results.

Responses

Create new Note

Create new Note

Required permissions:

  • General: Can add notes and communication

This endpoint is rate-limited to 300 requests per minute.

Request Body schema: application/json
title
required
string
note
string
type
required
string
created_user
string
modified_user
string
client
required
string
patients
required
Array of strings
archived
string
custom_created
string
locked
boolean
consultation
string
diagnostic_imaging_referral
string
consultation_referral
string
patient_referral
string

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "note": "string",
  • "type": "string",
  • "created_user": "string",
  • "modified_user": "string",
  • "client": "string",
  • "patients": [
    ],
  • "archived": "string",
  • "custom_created": "string",
  • "locked": true,
  • "consultation": "string",
  • "diagnostic_imaging_referral": "string",
  • "consultation_referral": "string",
  • "patient_referral": "string"
}

Get Note by ID

Get Note by ID

Required permissions:

  • General: Can add notes and communication

This endpoint is rate-limited to 200 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this note.

query Parameters
ordering
string

Which field to use when ordering the results.

Responses

Update Note

Update Note

Required permissions:

  • General: Can add notes and communication

This endpoint is rate-limited to 600 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this note.

query Parameters
ordering
string

Which field to use when ordering the results.

Request Body schema: application/json
title
required
string
note
string
type
required
string
created_user
string
modified_user
string
client
required
string
patients
required
Array of strings
archived
string
custom_created
string
locked
boolean
consultation
string
diagnostic_imaging_referral
string
consultation_referral
string
patient_referral
string

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "note": "string",
  • "type": "string",
  • "created_user": "string",
  • "modified_user": "string",
  • "client": "string",
  • "patients": [
    ],
  • "archived": "string",
  • "custom_created": "string",
  • "locked": true,
  • "consultation": "string",
  • "diagnostic_imaging_referral": "string",
  • "consultation_referral": "string",
  • "patient_referral": "string"
}

Partially update Note

Partially update Note

Required permissions:

  • General: Can add notes and communication

This endpoint is rate-limited to 600 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this note.

query Parameters
ordering
string

Which field to use when ordering the results.

Request Body schema: application/json
title
string
note
string
type
string
created_user
string
modified_user
string
client
string
patients
Array of strings
archived
string
custom_created
string
locked
boolean
consultation
string
diagnostic_imaging_referral
string
consultation_referral
string
patient_referral
string

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "note": "string",
  • "type": "string",
  • "created_user": "string",
  • "modified_user": "string",
  • "client": "string",
  • "patients": [
    ],
  • "archived": "string",
  • "custom_created": "string",
  • "locked": true,
  • "consultation": "string",
  • "diagnostic_imaging_referral": "string",
  • "consultation_referral": "string",
  • "patient_referral": "string"
}

Archive Note

Archive Note

Required permissions:

  • General: Can add notes and communication

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this note.

query Parameters
ordering
string

Which field to use when ordering the results.

Responses

List Uploads

List Uploads

Required permissions:

  • General: Can add notes and communication

This endpoint is rate-limited to 100 requests per minute.

path Parameters
parent_lookup_note
required
string
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Request Body schema: multipart/form-data
file
required
string
original_name
required
string
thumbnail_url
string

Responses

Create new Upload

Create new Upload

Required permissions:

  • General: Can add notes and communication

This endpoint is rate-limited to 200 requests per minute.

path Parameters
parent_lookup_note
required
string
Request Body schema: multipart/form-data
file
required
string
original_name
required
string
thumbnail_url
string

Responses

Get Upload by ID

Get Upload by ID

Required permissions:

  • General: Can add notes and communication

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_note
required
string
id
required
integer

A unique integer value identifying this upload.

Request Body schema: multipart/form-data
file
required
string
original_name
required
string
thumbnail_url
string

Responses

Note admin

List Notes

List Notes

Required permissions:

  • General: Can add notes and communication
  • General: Can edit locked notes through API

This endpoint is rate-limited to 50 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

ordering
string

Which field to use when ordering the results.

Responses

Create new Note

Create new Note

Required permissions:

  • General: Can add notes and communication
  • General: Can edit locked notes through API

This endpoint is rate-limited to 300 requests per minute.

Request Body schema: application/json
title
required
string
note
string
type
required
string
created_user
string
modified_user
string
client
required
string
patients
required
Array of strings
archived
string
custom_created
string
locked
boolean
consultation
string
diagnostic_imaging_referral
string
consultation_referral
string
patient_referral
string

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "note": "string",
  • "type": "string",
  • "created_user": "string",
  • "modified_user": "string",
  • "client": "string",
  • "patients": [
    ],
  • "archived": "string",
  • "custom_created": "string",
  • "locked": true,
  • "consultation": "string",
  • "diagnostic_imaging_referral": "string",
  • "consultation_referral": "string",
  • "patient_referral": "string"
}

Get Note by ID

Get Note by ID

Required permissions:

  • General: Can add notes and communication
  • General: Can edit locked notes through API

This endpoint is rate-limited to 200 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this note.

query Parameters
ordering
string

Which field to use when ordering the results.

Responses

Update Note

Update Note

Required permissions:

  • General: Can add notes and communication
  • General: Can edit locked notes through API

This endpoint is rate-limited to 600 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this note.

query Parameters
ordering
string

Which field to use when ordering the results.

Request Body schema: application/json
title
required
string
note
string
type
required
string
created_user
string
modified_user
string
client
required
string
patients
required
Array of strings
archived
string
custom_created
string
locked
boolean
consultation
string
diagnostic_imaging_referral
string
consultation_referral
string
patient_referral
string

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "note": "string",
  • "type": "string",
  • "created_user": "string",
  • "modified_user": "string",
  • "client": "string",
  • "patients": [
    ],
  • "archived": "string",
  • "custom_created": "string",
  • "locked": true,
  • "consultation": "string",
  • "diagnostic_imaging_referral": "string",
  • "consultation_referral": "string",
  • "patient_referral": "string"
}

Partially update Note

Partially update Note

Required permissions:

  • General: Can add notes and communication
  • General: Can edit locked notes through API

This endpoint is rate-limited to 600 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this note.

query Parameters
ordering
string

Which field to use when ordering the results.

Request Body schema: application/json
title
string
note
string
type
string
created_user
string
modified_user
string
client
string
patients
Array of strings
archived
string
custom_created
string
locked
boolean
consultation
string
diagnostic_imaging_referral
string
consultation_referral
string
patient_referral
string

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "note": "string",
  • "type": "string",
  • "created_user": "string",
  • "modified_user": "string",
  • "client": "string",
  • "patients": [
    ],
  • "archived": "string",
  • "custom_created": "string",
  • "locked": true,
  • "consultation": "string",
  • "diagnostic_imaging_referral": "string",
  • "consultation_referral": "string",
  • "patient_referral": "string"
}

Archive Note

Archive Note

Required permissions:

  • General: Can add notes and communication
  • General: Can edit locked notes through API

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this note.

query Parameters
ordering
string

Which field to use when ordering the results.

Responses

List Uploads

List Uploads

Required permissions:

  • General: Can add notes and communication

This endpoint is rate-limited to 100 requests per minute.

path Parameters
parent_lookup_note
required
string
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Request Body schema: multipart/form-data
file
required
string
original_name
required
string
thumbnail_url
string

Responses

Create new Upload

Create new Upload

Required permissions:

  • General: Can add notes and communication

This endpoint is rate-limited to 200 requests per minute.

path Parameters
parent_lookup_note
required
string
Request Body schema: multipart/form-data
file
required
string
original_name
required
string
thumbnail_url
string

Responses

Get Upload by ID

Get Upload by ID

Required permissions:

  • General: Can add notes and communication

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_note
required
string
id
required
integer

A unique integer value identifying this upload.

Request Body schema: multipart/form-data
file
required
string
original_name
required
string
thumbnail_url
string

Responses

Net promoter scores

List Net Promoter Scores

List Net Promoter Scores

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

ordering
string

Which field to use when ordering the results.

Responses

Create new Net Promoter Score

Create new Net Promoter Score

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

Request Body schema: application/json
consultation
required
string
rating
required
integer
comment
string

Responses

Request samples

Content type
application/json
{
  • "consultation": "string",
  • "rating": 0,
  • "comment": "string"
}

Get Net Promoter Score by ID

Get Net Promoter Score by ID

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this net promoter score.

query Parameters
ordering
string

Which field to use when ordering the results.

Responses

Online booking

List Clients

List Clients

Required permissions:

  • Calendar: Can access / edit appointments

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Create new Client

Create new Client

Required permissions:

  • Calendar: Can access / edit appointments

This endpoint is rate-limited to 300 requests per minute.

Request Body schema: application/json
appointment
required
string
first_name
required
string
last_name
required
string
email
string
phone_number
required
string
street_address
string
zip_code
string
city
string
onlinebookingpatients
Array of strings
id_number
string

Responses

Request samples

Content type
application/json
{
  • "appointment": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "email": "string",
  • "phone_number": "string",
  • "street_address": "string",
  • "zip_code": "string",
  • "city": "string",
  • "onlinebookingpatients": [
    ],
  • "id_number": "string"
}

Get Client by ID

Get Client by ID

Required permissions:

  • Calendar: Can access / edit appointments

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this online booking client.

Responses

List Patients

List Patients

Required permissions:

  • Calendar: Can access / edit appointments

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Create new Patient

Create new Patient

Required permissions:

  • Calendar: Can access / edit appointments

This endpoint is rate-limited to 300 requests per minute.

Request Body schema: application/json
onlinebookingclient
required
string
name
required
string
species
required
string
breed
string
notes
string

Responses

Request samples

Content type
application/json
{
  • "onlinebookingclient": "string",
  • "name": "string",
  • "species": "string",
  • "breed": "string",
  • "notes": "string"
}

Get Patient by ID

Get Patient by ID

Required permissions:

  • Calendar: Can access / edit appointments

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this online booking patient.

Responses

Product orders

List Orders

List Orders

Required permissions:

  • Settings: Can access / edit stock

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

ordering
string

Which field to use when ordering the results.

Responses

Create new Order

Create new Order

Required permissions:

  • Settings: Can access / edit stock

This endpoint is rate-limited to 300 requests per minute.

Request Body schema: application/json
department
required
string
status
string
order_date
string
delivery_date
string
added_to_stock_date
string
sum_vat
number
created_user
string
modified_user
string
email_sent_to
string
email_sent_at
string
wholesaler_reference_number
string
wholesaler
string
invoice_date
string
due_date
string
internal_information
string
notes
string

Responses

Request samples

Content type
application/json
{
  • "department": "string",
  • "status": "string",
  • "order_date": "string",
  • "delivery_date": "string",
  • "added_to_stock_date": "string",
  • "sum_vat": 0,
  • "created_user": "string",
  • "modified_user": "string",
  • "email_sent_to": "string",
  • "email_sent_at": "string",
  • "wholesaler_reference_number": "string",
  • "wholesaler": "string",
  • "invoice_date": "string",
  • "due_date": "string",
  • "internal_information": "string",
  • "notes": "string"
}

Get Order by ID

Get Order by ID

Required permissions:

  • Settings: Can access / edit stock

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this order.

query Parameters
ordering
string

Which field to use when ordering the results.

Responses

Update Order

Update Order

Required permissions:

  • Settings: Can access / edit stock

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this order.

query Parameters
ordering
string

Which field to use when ordering the results.

Request Body schema: application/json
department
required
string
status
string
order_date
string
delivery_date
string
added_to_stock_date
string
sum_vat
number
created_user
string
modified_user
string
email_sent_to
string
email_sent_at
string
wholesaler_reference_number
string
wholesaler
string
invoice_date
string
due_date
string
internal_information
string
notes
string

Responses

Request samples

Content type
application/json
{
  • "department": "string",
  • "status": "string",
  • "order_date": "string",
  • "delivery_date": "string",
  • "added_to_stock_date": "string",
  • "sum_vat": 0,
  • "created_user": "string",
  • "modified_user": "string",
  • "email_sent_to": "string",
  • "email_sent_at": "string",
  • "wholesaler_reference_number": "string",
  • "wholesaler": "string",
  • "invoice_date": "string",
  • "due_date": "string",
  • "internal_information": "string",
  • "notes": "string"
}

Partially update Order

Partially update Order

Required permissions:

  • Settings: Can access / edit stock

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this order.

query Parameters
ordering
string

Which field to use when ordering the results.

Request Body schema: application/json
department
string
status
string
order_date
string
delivery_date
string
added_to_stock_date
string
sum_vat
number
created_user
string
modified_user
string
email_sent_to
string
email_sent_at
string
wholesaler_reference_number
string
wholesaler
string
invoice_date
string
due_date
string
internal_information
string
notes
string

Responses

Request samples

Content type
application/json
{
  • "department": "string",
  • "status": "string",
  • "order_date": "string",
  • "delivery_date": "string",
  • "added_to_stock_date": "string",
  • "sum_vat": 0,
  • "created_user": "string",
  • "modified_user": "string",
  • "email_sent_to": "string",
  • "email_sent_at": "string",
  • "wholesaler_reference_number": "string",
  • "wholesaler": "string",
  • "invoice_date": "string",
  • "due_date": "string",
  • "internal_information": "string",
  • "notes": "string"
}

List Items

List Items

Required permissions:

  • Settings: Can access / edit stock

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

ordering
string

Which field to use when ordering the results.

Responses

Create new Item

Create new Item

Required permissions:

  • Settings: Can access / edit stock

This endpoint is rate-limited to 300 requests per minute.

Request Body schema: application/json
org_item
required
string
order_quantity
required
number
delivery_quantity
number
wholesale_price
number
order
required
string
sequence_order
integer
notes
string
created_user
string
modified_user
string

Responses

Request samples

Content type
application/json
{
  • "org_item": "string",
  • "order_quantity": 0,
  • "delivery_quantity": 0,
  • "wholesale_price": 0,
  • "order": "string",
  • "sequence_order": 0,
  • "notes": "string",
  • "created_user": "string",
  • "modified_user": "string"
}

Get Item by ID

Get Item by ID

Required permissions:

  • Settings: Can access / edit stock

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this order item.

query Parameters
ordering
string

Which field to use when ordering the results.

Responses

Update Item

Update Item

Required permissions:

  • Settings: Can access / edit stock

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this order item.

query Parameters
ordering
string

Which field to use when ordering the results.

Request Body schema: application/json
org_item
required
string
order_quantity
required
number
delivery_quantity
number
wholesale_price
number
order
required
string
sequence_order
integer
notes
string
created_user
string
modified_user
string

Responses

Request samples

Content type
application/json
{
  • "org_item": "string",
  • "order_quantity": 0,
  • "delivery_quantity": 0,
  • "wholesale_price": 0,
  • "order": "string",
  • "sequence_order": 0,
  • "notes": "string",
  • "created_user": "string",
  • "modified_user": "string"
}

Partially update Item

Partially update Item

Required permissions:

  • Settings: Can access / edit stock

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this order item.

query Parameters
ordering
string

Which field to use when ordering the results.

Request Body schema: application/json
org_item
string
order_quantity
number
delivery_quantity
number
wholesale_price
number
order
string
sequence_order
integer
notes
string
created_user
string
modified_user
string

Responses

Request samples

Content type
application/json
{
  • "org_item": "string",
  • "order_quantity": 0,
  • "delivery_quantity": 0,
  • "wholesale_price": 0,
  • "order": "string",
  • "sequence_order": 0,
  • "notes": "string",
  • "created_user": "string",
  • "modified_user": "string"
}

Archive Item

Archive Item

Required permissions:

  • Settings: Can access / edit stock

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this order item.

query Parameters
ordering
string

Which field to use when ordering the results.

Responses

Organisms

List Organisms

List Organisms

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Get Organism by ID

Get Organism by ID

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this organism.

Responses

Orphan items

List Orphan Items

List Orphan Items

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Create new Orphan Item

Create new Orphan Item

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 300 requests per minute.

Request Body schema: application/json
date
required
string
veterinarian
string
patient
string
item
required
string
quantity
required
number
usage_size
string
cubex_item_id
required
string
cubex_item_name
required
string
description
string
treatment_plan_item
string
invoice_row_draft
string
archived
boolean
info
object

Responses

Request samples

Content type
application/json
{
  • "date": "string",
  • "veterinarian": "string",
  • "patient": "string",
  • "item": "string",
  • "quantity": 0,
  • "usage_size": "string",
  • "cubex_item_id": "string",
  • "cubex_item_name": "string",
  • "description": "string",
  • "treatment_plan_item": "string",
  • "invoice_row_draft": "string",
  • "archived": true,
  • "info": { }
}

Get Orphan Item by ID

Get Orphan Item by ID

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this orphan item.

Responses

patient_location_attribute

List Patient location attributes

List Patient location attributes

Required permissions:

  • Settings: Can access / edit department settings

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Create new Patient location attribute

Create new Patient location attribute

Required permissions:

  • Settings: Can access / edit department settings

This endpoint is rate-limited to 300 requests per minute.

Request Body schema: application/json
name
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Get Patient location attribute by ID

Get Patient location attribute by ID

Required permissions:

  • Settings: Can access / edit department settings

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this patient location attribute.

Responses

Update Patient location attribute

Update Patient location attribute

Required permissions:

  • Settings: Can access / edit department settings

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this patient location attribute.

Request Body schema: application/json
name
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Partially update Patient location attribute

Partially update Patient location attribute

Required permissions:

  • Settings: Can access / edit department settings

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this patient location attribute.

Request Body schema: application/json
name
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Delete Patient location attribute

Delete Patient location attribute

Required permissions:

  • Settings: Can access / edit department settings

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this patient location attribute.

Responses

Patient referrals

List Referrals

List Referrals

Required permissions:

  • Patient referrals: Can access / edit patient referrals

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Create new Referral

Create new Referral

Required permissions:

  • Patient referrals: Can access / edit patient referrals

This endpoint is rate-limited to 300 requests per minute.

Request Body schema: application/json
referral_date
required
string
client
required
string
patient
required
string
status
string
referral_notes
string
department
required
string
ward
string
veterinarian
string
referrers
Array of strings
external_system
string
has_dicom_files
boolean

Responses

Request samples

Content type
application/json
{
  • "referral_date": "string",
  • "client": "string",
  • "patient": "string",
  • "status": "string",
  • "referral_notes": "string",
  • "department": "string",
  • "ward": "string",
  • "veterinarian": "string",
  • "referrers": [
    ],
  • "external_system": "string",
  • "has_dicom_files": true
}

Get Referral by ID

Get Referral by ID

Required permissions:

  • Patient referrals: Can access / edit patient referrals

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this patient referral.

Responses

Update Referral

Update Referral

Required permissions:

  • Patient referrals: Can access / edit patient referrals

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this patient referral.

Request Body schema: application/json
referral_date
required
string
client
required
string
patient
required
string
status
string
referral_notes
string
department
required
string
ward
string
veterinarian
string
referrers
Array of strings
external_system
string
has_dicom_files
boolean

Responses

Request samples

Content type
application/json
{
  • "referral_date": "string",
  • "client": "string",
  • "patient": "string",
  • "status": "string",
  • "referral_notes": "string",
  • "department": "string",
  • "ward": "string",
  • "veterinarian": "string",
  • "referrers": [
    ],
  • "external_system": "string",
  • "has_dicom_files": true
}

Partially update Referral

Partially update Referral

Required permissions:

  • Patient referrals: Can access / edit patient referrals

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this patient referral.

Request Body schema: application/json
referral_date
string
client
string
patient
string
status
string
referral_notes
string
department
string
ward
string
veterinarian
string
referrers
Array of strings
external_system
string
has_dicom_files
boolean

Responses

Request samples

Content type
application/json
{
  • "referral_date": "string",
  • "client": "string",
  • "patient": "string",
  • "status": "string",
  • "referral_notes": "string",
  • "department": "string",
  • "ward": "string",
  • "veterinarian": "string",
  • "referrers": [
    ],
  • "external_system": "string",
  • "has_dicom_files": true
}

Archive Referral

Archive Referral

Required permissions:

  • Patient referrals: Can access / edit patient referrals

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this patient referral.

Responses

List Feedbacks

List Feedbacks

Required permissions:

  • Patient referrals: Can access / edit patient referrals

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Get Feedback by ID

Get Feedback by ID

Required permissions:

  • Patient referrals: Can access / edit patient referrals

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this patient referral feedback.

Responses

List Attachments

List Attachments

Required permissions:

  • Patient referrals: Can access / edit patient referrals

This endpoint is rate-limited to 100 requests per minute.

path Parameters
parent_lookup_referral_feedback
required
string
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Get Attachment by ID

Get Attachment by ID

Required permissions:

  • Patient referrals: Can access / edit patient referrals

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_referral_feedback
required
string
id
required
integer

A unique integer value identifying this patient referral feedback attachment.

Responses

Patient health plans

List Plans

List Plans

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

ordering
string

Which field to use when ordering the results.

Responses

Create new Plan

Create new Plan

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

Request Body schema: application/json
display_name
required
string
health_plan
required
string
department
string
patient
required
string
client
required
string
status
string
start_date
string
end_date
string
canceled
string
cancel_date
string
months
required
integer
monthly_fee
number
discount
number
initial_payment
number
internal_name
required
string
internal_notes
string
description
string
invoicing_item
string
compensation_item
string
cancellation_fee_item
string
renew
string
next_plan
string
payment_method
string
invoicing_partner
integer
pet_health_plan_item
required
Array of strings
pet_health_plan_itemgroup
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "display_name": "string",
  • "health_plan": "string",
  • "department": "string",
  • "patient": "string",
  • "client": "string",
  • "status": "string",
  • "start_date": "string",
  • "end_date": "string",
  • "canceled": "string",
  • "cancel_date": "string",
  • "months": 0,
  • "monthly_fee": 0,
  • "discount": 0,
  • "initial_payment": 0,
  • "internal_name": "string",
  • "internal_notes": "string",
  • "description": "string",
  • "invoicing_item": "string",
  • "compensation_item": "string",
  • "cancellation_fee_item": "string",
  • "renew": "string",
  • "next_plan": "string",
  • "payment_method": "string",
  • "invoicing_partner": 0,
  • "pet_health_plan_item": [
    ],
  • "pet_health_plan_itemgroup": [
    ]
}

Get Plan by ID

Get Plan by ID

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this patient health plan.

query Parameters
ordering
string

Which field to use when ordering the results.

Responses

Patient Health Plans

Patient Health Plans

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this patient health plan.

query Parameters
ordering
string

Which field to use when ordering the results.

Request Body schema: application/json
display_name
required
string
health_plan
required
string
department
string
patient
required
string
client
required
string
status
string
start_date
string
end_date
string
canceled
string
cancel_date
string
months
required
integer
monthly_fee
number
discount
number
initial_payment
number
internal_name
required
string
internal_notes
string
description
string
invoicing_item
string
compensation_item
string
cancellation_fee_item
string
renew
string
next_plan
string
payment_method
string
invoicing_partner
integer
pet_health_plan_item
required
Array of strings
pet_health_plan_itemgroup
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "display_name": "string",
  • "health_plan": "string",
  • "department": "string",
  • "patient": "string",
  • "client": "string",
  • "status": "string",
  • "start_date": "string",
  • "end_date": "string",
  • "canceled": "string",
  • "cancel_date": "string",
  • "months": 0,
  • "monthly_fee": 0,
  • "discount": 0,
  • "initial_payment": 0,
  • "internal_name": "string",
  • "internal_notes": "string",
  • "description": "string",
  • "invoicing_item": "string",
  • "compensation_item": "string",
  • "cancellation_fee_item": "string",
  • "renew": "string",
  • "next_plan": "string",
  • "payment_method": "string",
  • "invoicing_partner": 0,
  • "pet_health_plan_item": [
    ],
  • "pet_health_plan_itemgroup": [
    ]
}

Patient Health Plans

Patient Health Plans

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this patient health plan.

query Parameters
ordering
string

Which field to use when ordering the results.

Request Body schema: application/json
display_name
string
health_plan
string
department
string
patient
string
client
string
status
string
start_date
string
end_date
string
canceled
string
cancel_date
string
months
integer
monthly_fee
number
discount
number
initial_payment
number
internal_name
string
internal_notes
string
description
string
invoicing_item
string
compensation_item
string
cancellation_fee_item
string
renew
string
next_plan
string
payment_method
string
invoicing_partner
integer
pet_health_plan_item
Array of strings
pet_health_plan_itemgroup
Array of strings

Responses

Request samples

Content type
application/json
{
  • "display_name": "string",
  • "health_plan": "string",
  • "department": "string",
  • "patient": "string",
  • "client": "string",
  • "status": "string",
  • "start_date": "string",
  • "end_date": "string",
  • "canceled": "string",
  • "cancel_date": "string",
  • "months": 0,
  • "monthly_fee": 0,
  • "discount": 0,
  • "initial_payment": 0,
  • "internal_name": "string",
  • "internal_notes": "string",
  • "description": "string",
  • "invoicing_item": "string",
  • "compensation_item": "string",
  • "cancellation_fee_item": "string",
  • "renew": "string",
  • "next_plan": "string",
  • "payment_method": "string",
  • "invoicing_partner": 0,
  • "pet_health_plan_item": [
    ],
  • "pet_health_plan_itemgroup": [
    ]
}

List Items

List Items

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

ordering
string

Which field to use when ordering the results.

Responses

Get Item by ID

Get Item by ID

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this patient health plan item.

query Parameters
ordering
string

Which field to use when ordering the results.

Responses

Set Item used quantity

Set Item used quantity

Mark this Item used.

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 100 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this patient health plan item.

Request Body schema: application/json
health_plan
required
string
health_plan_item_group
string
type_code
required
string
consultation_item
string
compensation_item
string
invoice_row
string
compensation_row
string
used
boolean
used_time
string
original_quantity
number
parent_item
string
replacement_for
string
per_consultation
number
use_after_expiry
boolean
days_after_expiry
integer
parent_linked_item
string

Responses

Request samples

Content type
application/json
{
  • "health_plan": "string",
  • "health_plan_item_group": "string",
  • "type_code": "string",
  • "consultation_item": "string",
  • "compensation_item": "string",
  • "invoice_row": "string",
  • "compensation_row": "string",
  • "used": true,
  • "used_time": "string",
  • "original_quantity": 0,
  • "parent_item": "string",
  • "replacement_for": "string",
  • "per_consultation": 0,
  • "use_after_expiry": true,
  • "days_after_expiry": 0,
  • "parent_linked_item": "string"
}

Set Item used quantity

Set Item used quantity

Mark this Item used.

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 100 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this patient health plan item.

Request Body schema: application/json
health_plan
required
string
health_plan_item_group
string
type_code
required
string
consultation_item
string
compensation_item
string
invoice_row
string
compensation_row
string
used
boolean
used_time
string
original_quantity
number
parent_item
string
replacement_for
string
per_consultation
number
use_after_expiry
boolean
days_after_expiry
integer
parent_linked_item
string

Responses

Request samples

Content type
application/json
{
  • "health_plan": "string",
  • "health_plan_item_group": "string",
  • "type_code": "string",
  • "consultation_item": "string",
  • "compensation_item": "string",
  • "invoice_row": "string",
  • "compensation_row": "string",
  • "used": true,
  • "used_time": "string",
  • "original_quantity": 0,
  • "parent_item": "string",
  • "replacement_for": "string",
  • "per_consultation": 0,
  • "use_after_expiry": true,
  • "days_after_expiry": 0,
  • "parent_linked_item": "string"
}

List Groups

List Groups

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

ordering
string

Which field to use when ordering the results.

Responses

Get Group by ID

Get Group by ID

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this patient health plan item group.

query Parameters
ordering
string

Which field to use when ordering the results.

Responses

Set Item group used items quantity

Set Item group used items quantity

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 100 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this patient health plan item group.

Request Body schema: application/json
health_plan
required
string
health_plan_item_group
required
string
used_items_quantity
integer
pet_health_plan_item
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "health_plan": "string",
  • "health_plan_item_group": "string",
  • "used_items_quantity": 0,
  • "pet_health_plan_item": [
    ]
}

Set Item group used items quantity

Set Item group used items quantity

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 100 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this patient health plan item group.

Request Body schema: application/json
health_plan
required
string
health_plan_item_group
required
string
used_items_quantity
integer
pet_health_plan_item
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "health_plan": "string",
  • "health_plan_item_group": "string",
  • "used_items_quantity": 0,
  • "pet_health_plan_item": [
    ]
}

Payment cards

Create a new Payment Card

Create a new Payment Card

Required permissions:

  • Financial: Can access / edit invoices

This endpoint is rate-limited to 300 requests per minute.

Request Body schema: application/json
client
required
string
tokenization_id
string
info
required
string
expiration_date
string
default
boolean
source
string

Responses

Request samples

Content type
application/json
{
  • "client": "string",
  • "tokenization_id": "string",
  • "info": "string",
  • "expiration_date": "string",
  • "default": true,
  • "source": "string"
}

Payment methods

List Payment Methods

List Payment Methods

Default codes are:

  • Credit card = 0
  • Cash = 1
  • Bank payment = 2
  • Rounding = 3
  • Cheque = 4
  • Voucher = 5
  • Consolidated invoice = 6
  • Mobile payment = 7
  • Prepayment = 8
  • Present_card = 9
  • Financing_company = 10
  • Other = 11
  • Credit invoice = 12
  • Klarna instore = 5000
  • Lindorff invoicing = 5001

Required permissions:

  • Settings: Can access settings page

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Payment Methods

Payment Methods

Required permissions:

  • Settings: Can access settings page

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this payment method.

Responses

Payment type accounting numbers

List Accounting Numbers

List Accounting Numbers

Required permissions:

  • Financial: Can access / edit end of day and accounting reports

This endpoint is rate-limited to 100 requests per minute.

query Parameters
department_id
string

If not provided, get the first department

Responses

Personnel groups

List Personnel groups

List Personnel groups

Required permissions:

  • Settings: Can access settings page

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Get Personnel group by ID

Get Personnel group by ID

Required permissions:

  • Settings: Can access settings page

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this personnel group.

Responses

Petmedchain

List Documents

List Documents

event values:

  • EVENT_PET_SHARED = 1
  • EVENT_INVOICE_FINALIZED = 2

Required permissions:

  • General: Can access / edit patients and clients
  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Create new Document

Create new Document

Required permissions:

  • General: Can access / edit patients and clients
  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

Request Body schema: application/json
pet
string
consultation
string
imported_history
string
event
string
pmc_id
required
string
pmc_uri
required
string

Responses

Request samples

Content type
application/json
{
  • "pet": "string",
  • "consultation": "string",
  • "imported_history": "string",
  • "event": "string",
  • "pmc_id": "string",
  • "pmc_uri": "string"
}

Get Document by ID

Get Document by ID

Required permissions:

  • General: Can access / edit patients and clients
  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this document.

Responses

Update Document

Update Document

Required permissions:

  • General: Can access / edit patients and clients
  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this document.

Request Body schema: application/json
pet
string
consultation
string
imported_history
string
event
string
pmc_id
required
string
pmc_uri
required
string

Responses

Request samples

Content type
application/json
{
  • "pet": "string",
  • "consultation": "string",
  • "imported_history": "string",
  • "event": "string",
  • "pmc_id": "string",
  • "pmc_uri": "string"
}

Partially update Document

Partially update Document

Required permissions:

  • General: Can access / edit patients and clients
  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this document.

Request Body schema: application/json
pet
string
consultation
string
imported_history
string
event
string
pmc_id
string
pmc_uri
string

Responses

Request samples

Content type
application/json
{
  • "pet": "string",
  • "consultation": "string",
  • "imported_history": "string",
  • "event": "string",
  • "pmc_id": "string",
  • "pmc_uri": "string"
}

Archive Document

Archive Document

Required permissions:

  • General: Can access / edit patients and clients
  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this document.

Responses

Create new Pet Shared

Create new Pet Shared

This endpoint is rate-limited to 300 requests per minute.

Responses

List Pets

List Pets

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Create new Pet

Create new Pet

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

Request Body schema: application/json
pmc_id
required
string
patient
string
name
required
string
microchip
string
species
required
string
breed
required
string
date_of_birth
string
verified_at
string

Responses

Request samples

Content type
application/json
{
  • "pmc_id": "string",
  • "patient": "string",
  • "name": "string",
  • "microchip": "string",
  • "species": "string",
  • "breed": "string",
  • "date_of_birth": "string",
  • "verified_at": "string"
}

Get Pet by ID

Get Pet by ID

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this pet.

Responses

Update Pet

Update Pet

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this pet.

Request Body schema: application/json
pmc_id
required
string
patient
string
name
required
string
microchip
string
species
required
string
breed
required
string
date_of_birth
string
verified_at
string

Responses

Request samples

Content type
application/json
{
  • "pmc_id": "string",
  • "patient": "string",
  • "name": "string",
  • "microchip": "string",
  • "species": "string",
  • "breed": "string",
  • "date_of_birth": "string",
  • "verified_at": "string"
}

Partially update Pet

Partially update Pet

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this pet.

Request Body schema: application/json
pmc_id
string
patient
string
name
string
microchip
string
species
string
breed
string
date_of_birth
string
verified_at
string

Responses

Request samples

Content type
application/json
{
  • "pmc_id": "string",
  • "patient": "string",
  • "name": "string",
  • "microchip": "string",
  • "species": "string",
  • "breed": "string",
  • "date_of_birth": "string",
  • "verified_at": "string"
}

Archive Pet

Archive Pet

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this pet.

Responses

List Settings

List Settings

Required permissions:

  • Settings: Can access / edit organization settings

This endpoint is rate-limited to 100 requests per minute.

Responses

Create new Setting

Create new Setting

Required permissions:

  • Settings: Can access / edit organization settings

This endpoint is rate-limited to 300 requests per minute.

Responses

Phone numbers

List Phone Numbers

List Phone Numbers

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 900 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Create new Phone Number

Create new Phone Number

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 900 requests per minute.

Request Body schema: application/json
client
required
string
type_code
required
string
phone_number
required
string
description
string
preferred_reminders
boolean
is_secondary_owners_phone_number
boolean

Responses

Request samples

Content type
application/json
{
  • "client": "string",
  • "type_code": "string",
  • "phone_number": "string",
  • "description": "string",
  • "preferred_reminders": true,
  • "is_secondary_owners_phone_number": true
}

Get Phone Number by ID

Get Phone Number by ID

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 3600 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this phone.

Responses

Update Phone Number

Update Phone Number

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 900 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this phone.

Request Body schema: application/json
client
required
string
type_code
required
string
phone_number
required
string
description
string
preferred_reminders
boolean
is_secondary_owners_phone_number
boolean

Responses

Request samples

Content type
application/json
{
  • "client": "string",
  • "type_code": "string",
  • "phone_number": "string",
  • "description": "string",
  • "preferred_reminders": true,
  • "is_secondary_owners_phone_number": true
}

Partially update Phone Number

Partially update Phone Number

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 900 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this phone.

Request Body schema: application/json
client
string
type_code
string
phone_number
string
description
string
preferred_reminders
boolean
is_secondary_owners_phone_number
boolean

Responses

Request samples

Content type
application/json
{
  • "client": "string",
  • "type_code": "string",
  • "phone_number": "string",
  • "description": "string",
  • "preferred_reminders": true,
  • "is_secondary_owners_phone_number": true
}

Archive Phone Number

Archive Phone Number

Required permissions:

  • General: Can access / edit patients and clients

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this phone.

Responses

postransaction

List PosTransactions

List PosTransactions

Required permissions:

  • Financial: Can access / edit invoices

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Create new PosTransaction

Create new PosTransaction

Required permissions:

  • Financial: Can access / edit invoices

This endpoint is rate-limited to 300 requests per minute.

Request Body schema: application/json
amount
required
number
task_id
required
string
aborted
string
cashier_desk
string
invoice
string
terminal_id
required
integer
department
string
transaction_type
string
payment_type
string
payment_method
string
payment
string
unallocated_payment
string
refunded_transaction
string
creator
required
string

Responses

Request samples

Content type
application/json
{
  • "amount": 0,
  • "task_id": "string",
  • "aborted": "string",
  • "cashier_desk": "string",
  • "invoice": "string",
  • "terminal_id": 0,
  • "department": "string",
  • "transaction_type": "string",
  • "payment_type": "string",
  • "payment_method": "string",
  • "payment": "string",
  • "unallocated_payment": "string",
  • "refunded_transaction": "string",
  • "creator": "string"
}

Get PosTransaction by ID

Get PosTransaction by ID

Required permissions:

  • Financial: Can access / edit invoices

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this pos transaction.

Responses

PosTransactions

PosTransactions

Required permissions:

  • Financial: Can access / edit invoices

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this pos transaction.

Responses

POS transaction results

List Pos Transaction Result

List Pos Transaction Result

Required permissions:

  • Financial: Can access / edit invoices

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Create a new Pos Transaction Result

Create a new Pos Transaction Result

Required permissions:

  • Financial: Can access / edit invoices

This endpoint is rate-limited to 300 requests per minute.

Request Body schema: application/json
success
boolean
external_transaction_id
string
internal_error
boolean
result_raw
required
string
result_text
required
string
transaction
required
integer
external_customer_receipt
string
external_merchant_receipt
string
unique_external_id
string

Responses

Request samples

Content type
application/json
{
  • "success": true,
  • "external_transaction_id": "string",
  • "internal_error": true,
  • "result_raw": "string",
  • "result_text": "string",
  • "transaction": 0,
  • "external_customer_receipt": "string",
  • "external_merchant_receipt": "string",
  • "unique_external_id": "string"
}

List Pos Transaction Result ID

List Pos Transaction Result ID

Required permissions:

  • Financial: Can access / edit invoices

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this pos transaction result.

Responses

Preliminary bookings

List Bookings

List Bookings

Required permissions:

  • Calendar: Can access / edit appointments

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Create new Booking

Create new Booking

Required permissions:

  • Calendar: Can access / edit appointments

This endpoint is rate-limited to 300 requests per minute.

Request Body schema: application/json
user
string
resources
Array of strings
department
required
string
start
required
string
end
required
string
reason
string
client
string
patients
Array of strings
client_notes
string
notes
string

Responses

Request samples

Content type
application/json
{
  • "user": "string",
  • "resources": [
    ],
  • "department": "string",
  • "start": "string",
  • "end": "string",
  • "reason": "string",
  • "client": "string",
  • "patients": [
    ],
  • "client_notes": "string",
  • "notes": "string"
}

Get Booking by ID

Get Booking by ID

Required permissions:

  • Calendar: Can access / edit appointments

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this appointment.

Responses

Prescription invoice rows

List Prescription Billings that do not have any error.

List Prescription Billings that do not have any error.

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

max
integer

Number of results to return per page.

Responses

Create new Prescription Billings

Create new Prescription Billings

This endpoint is rate-limited to 300 requests per minute.

Responses

List Prescription Billing Errors

List Prescription Billing Errors

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

max
integer

Number of results to return per page.

Responses

Create new Prescription Billing Errors

Create new Prescription Billing Errors

This endpoint is rate-limited to 300 requests per minute.

Responses

Procedures

List Procedures

List Procedures

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

ordering
string

Which field to use when ordering the results.

include_archived
string

Set to 'true' to include archived items in results

Responses

Create new Procedure

Create new Procedure

  • Price calculations documentation: check the documentaion in the "Create new Food" (POST /food/)

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 300 requests per minute.

query Parameters
include_archived
string

Set to 'true' to include archived items in results

Request Body schema: application/json
main_item
string
code
string
barcode
string
account_number
string
name
required
string
print_name
string
hide_on_consultation
boolean
price
number
price_with_vat
number
minimum_price
number
minimum_price_with_vat
number
wholesale_price
number
wholesaler_discount
number
producer_discount
number
special_discount
number
margin_percent
number
vat_group
required
string
invoice_group
string
item_list
required
string
type_code
required
string

ITEM_TYPE_PROCEDURE = 1, ITEM_TYPE_MEDICINE = 2, ITEM_TYPE_SUPPLY = 3, ITEM_TYPE_FOOD = 4, ITEM_TYPE_LABORATORY_ANALYSIS = 5, ITEM_TYPE_LABORATORY_ANALYSIS_PANEL = 6

parent_amount
number
instructions
string
archived
boolean
archived_datetime
string
exclude_discount
boolean
hide_zero_print
boolean
linked_items
Array of strings
reporting_dimension_1
string

Primarily code is used, if not found id is used

reporting_dimension_2
string

Primarily code is used, if not found id is used

hide_on_countersale_search
boolean
performed_by_rule
string

PERFORMED_BY_INHERIT = 0, PERFORMED_BY_REQUIRED = 1, PERFORMED_BY_NOT_REQUIRED = 2

royalty_fee
integer
external_reporting_code
string
external_reporting_code_2
string
external_reporting_code_3
string
hide_on_consultation_search
boolean
disable_price_calculation
boolean
species
Array of strings
no_department_rates
boolean
related_diagnoses_groups
Array of strings
conditional_price_overrides
Array of strings
duration
integer
internal_instructions
string
special_procedure
string
category
string
minimum_charge
number
minimum_charge_with_vat
number

Responses

Request samples

Content type
application/json
{
  • "main_item": "string",
  • "code": "string",
  • "barcode": "string",
  • "account_number": "string",
  • "name": "string",
  • "print_name": "string",
  • "hide_on_consultation": true,
  • "price": 0,
  • "price_with_vat": 0,
  • "minimum_price": 0,
  • "minimum_price_with_vat": 0,
  • "wholesale_price": 0,
  • "wholesaler_discount": 0,
  • "producer_discount": 0,
  • "special_discount": 0,
  • "margin_percent": 0,
  • "vat_group": "string",
  • "invoice_group": "string",
  • "item_list": "string",
  • "type_code": "string",
  • "parent_amount": 0,
  • "instructions": "string",
  • "archived": true,
  • "archived_datetime": "string",
  • "exclude_discount": true,
  • "hide_zero_print": true,
  • "linked_items": [
    ],
  • "reporting_dimension_1": "string",
  • "reporting_dimension_2": "string",
  • "hide_on_countersale_search": true,
  • "performed_by_rule": "string",
  • "royalty_fee": 0,
  • "external_reporting_code": "string",
  • "external_reporting_code_2": "string",
  • "external_reporting_code_3": "string",
  • "hide_on_consultation_search": true,
  • "disable_price_calculation": true,
  • "species": [
    ],
  • "no_department_rates": true,
  • "related_diagnoses_groups": [
    ],
  • "conditional_price_overrides": [
    ],
  • "duration": 0,
  • "internal_instructions": "string",
  • "special_procedure": "string",
  • "category": "string",
  • "minimum_charge": 0,
  • "minimum_charge_with_vat": 0
}

Get Procedure by ID

Get Procedure by ID

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this procedure.

query Parameters
ordering
string

Which field to use when ordering the results.

include_archived
string

Set to 'true' to include archived items in results

Responses

Update Procedure

Update Procedure

  • Price calculations documentation: check the documentaion in the "Create new Food" (POST /food/)

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this procedure.

query Parameters
ordering
string

Which field to use when ordering the results.

include_archived
string

Set to 'true' to include archived items in results

Request Body schema: application/json
main_item
string
code
string
barcode
string
account_number
string
name
required
string
print_name
string
hide_on_consultation
boolean
price
number
price_with_vat
number
minimum_price
number
minimum_price_with_vat
number
wholesale_price
number
wholesaler_discount
number
producer_discount
number
special_discount
number
margin_percent
number
vat_group
required
string
invoice_group
string
item_list
required
string
type_code
required
string

ITEM_TYPE_PROCEDURE = 1, ITEM_TYPE_MEDICINE = 2, ITEM_TYPE_SUPPLY = 3, ITEM_TYPE_FOOD = 4, ITEM_TYPE_LABORATORY_ANALYSIS = 5, ITEM_TYPE_LABORATORY_ANALYSIS_PANEL = 6

parent_amount
number
instructions
string
archived
boolean
archived_datetime
string
exclude_discount
boolean
hide_zero_print
boolean
linked_items
Array of strings
reporting_dimension_1
string

Primarily code is used, if not found id is used

reporting_dimension_2
string

Primarily code is used, if not found id is used

hide_on_countersale_search
boolean
performed_by_rule
string

PERFORMED_BY_INHERIT = 0, PERFORMED_BY_REQUIRED = 1, PERFORMED_BY_NOT_REQUIRED = 2

royalty_fee
integer
external_reporting_code
string
external_reporting_code_2
string
external_reporting_code_3
string
hide_on_consultation_search
boolean
disable_price_calculation
boolean
species
Array of strings
no_department_rates
boolean
related_diagnoses_groups
Array of strings
conditional_price_overrides
Array of strings
duration
integer
internal_instructions
string
special_procedure
string
category
string
minimum_charge
number
minimum_charge_with_vat
number

Responses

Request samples

Content type
application/json
{
  • "main_item": "string",
  • "code": "string",
  • "barcode": "string",
  • "account_number": "string",
  • "name": "string",
  • "print_name": "string",
  • "hide_on_consultation": true,
  • "price": 0,
  • "price_with_vat": 0,
  • "minimum_price": 0,
  • "minimum_price_with_vat": 0,
  • "wholesale_price": 0,
  • "wholesaler_discount": 0,
  • "producer_discount": 0,
  • "special_discount": 0,
  • "margin_percent": 0,
  • "vat_group": "string",
  • "invoice_group": "string",
  • "item_list": "string",
  • "type_code": "string",
  • "parent_amount": 0,
  • "instructions": "string",
  • "archived": true,
  • "archived_datetime": "string",
  • "exclude_discount": true,
  • "hide_zero_print": true,
  • "linked_items": [
    ],
  • "reporting_dimension_1": "string",
  • "reporting_dimension_2": "string",
  • "hide_on_countersale_search": true,
  • "performed_by_rule": "string",
  • "royalty_fee": 0,
  • "external_reporting_code": "string",
  • "external_reporting_code_2": "string",
  • "external_reporting_code_3": "string",
  • "hide_on_consultation_search": true,
  • "disable_price_calculation": true,
  • "species": [
    ],
  • "no_department_rates": true,
  • "related_diagnoses_groups": [
    ],
  • "conditional_price_overrides": [
    ],
  • "duration": 0,
  • "internal_instructions": "string",
  • "special_procedure": "string",
  • "category": "string",
  • "minimum_charge": 0,
  • "minimum_charge_with_vat": 0
}

Partially update Procedure

Partially update Procedure

  • Price calculations documentation: check the documentaion in the "Create new Food" (POST /food/)

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this procedure.

query Parameters
ordering
string

Which field to use when ordering the results.

include_archived
string

Set to 'true' to include archived items in results

Request Body schema: application/json
main_item
string
code
string
barcode
string
account_number
string
name
string
print_name
string
hide_on_consultation
boolean
price
number
price_with_vat
number
minimum_price
number
minimum_price_with_vat
number
wholesale_price
number
wholesaler_discount
number
producer_discount
number
special_discount
number
margin_percent
number
vat_group
string
invoice_group
string
item_list
string
type_code
string

ITEM_TYPE_PROCEDURE = 1, ITEM_TYPE_MEDICINE = 2, ITEM_TYPE_SUPPLY = 3, ITEM_TYPE_FOOD = 4, ITEM_TYPE_LABORATORY_ANALYSIS = 5, ITEM_TYPE_LABORATORY_ANALYSIS_PANEL = 6

parent_amount
number
instructions
string
archived
boolean
archived_datetime
string
exclude_discount
boolean
hide_zero_print
boolean
linked_items
Array of strings
reporting_dimension_1
string

Primarily code is used, if not found id is used

reporting_dimension_2
string

Primarily code is used, if not found id is used

hide_on_countersale_search
boolean
performed_by_rule
string

PERFORMED_BY_INHERIT = 0, PERFORMED_BY_REQUIRED = 1, PERFORMED_BY_NOT_REQUIRED = 2

royalty_fee
integer
external_reporting_code
string
external_reporting_code_2
string
external_reporting_code_3
string
hide_on_consultation_search
boolean
disable_price_calculation
boolean
species
Array of strings
no_department_rates
boolean
related_diagnoses_groups
Array of strings
conditional_price_overrides
Array of strings
duration
integer
internal_instructions
string
special_procedure
string
category
string
minimum_charge
number
minimum_charge_with_vat
number

Responses

Request samples

Content type
application/json
{
  • "main_item": "string",
  • "code": "string",
  • "barcode": "string",
  • "account_number": "string",
  • "name": "string",
  • "print_name": "string",
  • "hide_on_consultation": true,
  • "price": 0,
  • "price_with_vat": 0,
  • "minimum_price": 0,
  • "minimum_price_with_vat": 0,
  • "wholesale_price": 0,
  • "wholesaler_discount": 0,
  • "producer_discount": 0,
  • "special_discount": 0,
  • "margin_percent": 0,
  • "vat_group": "string",
  • "invoice_group": "string",
  • "item_list": "string",
  • "type_code": "string",
  • "parent_amount": 0,
  • "instructions": "string",
  • "archived": true,
  • "archived_datetime": "string",
  • "exclude_discount": true,
  • "hide_zero_print": true,
  • "linked_items": [
    ],
  • "reporting_dimension_1": "string",
  • "reporting_dimension_2": "string",
  • "hide_on_countersale_search": true,
  • "performed_by_rule": "string",
  • "royalty_fee": 0,
  • "external_reporting_code": "string",
  • "external_reporting_code_2": "string",
  • "external_reporting_code_3": "string",
  • "hide_on_consultation_search": true,
  • "disable_price_calculation": true,
  • "species": [
    ],
  • "no_department_rates": true,
  • "related_diagnoses_groups": [
    ],
  • "conditional_price_overrides": [
    ],
  • "duration": 0,
  • "internal_instructions": "string",
  • "special_procedure": "string",
  • "category": "string",
  • "minimum_charge": 0,
  • "minimum_charge_with_vat": 0
}

Archives an item.

Archives an item.

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this procedure.

query Parameters
ordering
string

Which field to use when ordering the results.

include_archived
string

Set to 'true' to include archived items in results

Responses

Reasons

List Reasons

List Reasons

email_message values:

  • Standard = 1
  • Custom = 3

sms_message values:

  • Standard = 1
  • Same custom message for confirmation and reminder = 2
  • Own custom messages for confirmation and reminder = 3

Required permissions:

  • Settings: Can access settings page

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Create new Reason

Create new Reason

Required permissions:

  • Settings: Can access settings page

This endpoint is rate-limited to 300 requests per minute.

Request Body schema: application/json
group
required
string
name
required
string
duration
required
integer
proficient_staff
Array of strings
available_online
boolean
instructions
string
available_from
string
available_to
string
prevent_reminders
string
prevent_confirmations
string
email_message
string
email_confirmation_text
string
email_reminder_text
string
sms_message
string
sms_reminder_text
string
sms_confirmation_text
string
default_items
Array of strings
default_clinical_note
string
color
string
reporting_dimension_1
string

Primarily code is used, if not found id is used

reporting_dimension_2
string

Primarily code is used, if not found id is used

archived
boolean
telemedicine
boolean
advance_payment_item
string
shift_types
Array of strings
category
string
default_resources
Array of strings
data_excluded_from_communication
string

Responses

Request samples

Content type
application/json
{
  • "group": "string",
  • "name": "string",
  • "duration": 0,
  • "proficient_staff": [
    ],
  • "available_online": true,
  • "instructions": "string",
  • "available_from": "string",
  • "available_to": "string",
  • "prevent_reminders": "string",
  • "prevent_confirmations": "string",
  • "email_message": "string",
  • "email_confirmation_text": "string",
  • "email_reminder_text": "string",
  • "sms_message": "string",
  • "sms_reminder_text": "string",
  • "sms_confirmation_text": "string",
  • "default_items": [
    ],
  • "default_clinical_note": "string",
  • "color": "string",
  • "reporting_dimension_1": "string",
  • "reporting_dimension_2": "string",
  • "archived": true,
  • "telemedicine": true,
  • "advance_payment_item": "string",
  • "shift_types": [
    ],
  • "category": "string",
  • "default_resources": [
    ],
  • "data_excluded_from_communication": "string"
}

Get Reason by ID

Get Reason by ID

Required permissions:

  • Settings: Can access settings page

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this complaint type.

Responses

Update Reason

Update Reason

Required permissions:

  • Settings: Can access settings page

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this complaint type.

Request Body schema: application/json
group
required
string
name
required
string
duration
required
integer
proficient_staff
Array of strings
available_online
boolean
instructions
string
available_from
string
available_to
string
prevent_reminders
string
prevent_confirmations
string
email_message
string
email_confirmation_text
string
email_reminder_text
string
sms_message
string
sms_reminder_text
string
sms_confirmation_text
string
default_items
Array of strings
default_clinical_note
string
color
string
reporting_dimension_1
string

Primarily code is used, if not found id is used

reporting_dimension_2
string

Primarily code is used, if not found id is used

archived
boolean
telemedicine
boolean
advance_payment_item
string
shift_types
Array of strings
category
string
default_resources
Array of strings
data_excluded_from_communication
string

Responses

Request samples

Content type
application/json
{
  • "group": "string",
  • "name": "string",
  • "duration": 0,
  • "proficient_staff": [
    ],
  • "available_online": true,
  • "instructions": "string",
  • "available_from": "string",
  • "available_to": "string",
  • "prevent_reminders": "string",
  • "prevent_confirmations": "string",
  • "email_message": "string",
  • "email_confirmation_text": "string",
  • "email_reminder_text": "string",
  • "sms_message": "string",
  • "sms_reminder_text": "string",
  • "sms_confirmation_text": "string",
  • "default_items": [
    ],
  • "default_clinical_note": "string",
  • "color": "string",
  • "reporting_dimension_1": "string",
  • "reporting_dimension_2": "string",
  • "archived": true,
  • "telemedicine": true,
  • "advance_payment_item": "string",
  • "shift_types": [
    ],
  • "category": "string",
  • "default_resources": [
    ],
  • "data_excluded_from_communication": "string"
}

Partially update Reason

Partially update Reason

Required permissions:

  • Settings: Can access settings page

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this complaint type.

Request Body schema: application/json
group
string
name
string
duration
integer
proficient_staff
Array of strings
available_online
boolean
instructions
string
available_from
string
available_to
string
prevent_reminders
string
prevent_confirmations
string
email_message
string
email_confirmation_text
string
email_reminder_text
string
sms_message
string
sms_reminder_text
string
sms_confirmation_text
string
default_items
Array of strings
default_clinical_note
string
color
string
reporting_dimension_1
string

Primarily code is used, if not found id is used

reporting_dimension_2
string

Primarily code is used, if not found id is used

archived
boolean
telemedicine
boolean
advance_payment_item
string
shift_types
Array of strings
category
string
default_resources
Array of strings
data_excluded_from_communication
string

Responses

Request samples

Content type
application/json
{
  • "group": "string",
  • "name": "string",
  • "duration": 0,
  • "proficient_staff": [
    ],
  • "available_online": true,
  • "instructions": "string",
  • "available_from": "string",
  • "available_to": "string",
  • "prevent_reminders": "string",
  • "prevent_confirmations": "string",
  • "email_message": "string",
  • "email_confirmation_text": "string",
  • "email_reminder_text": "string",
  • "sms_message": "string",
  • "sms_reminder_text": "string",
  • "sms_confirmation_text": "string",
  • "default_items": [
    ],
  • "default_clinical_note": "string",
  • "color": "string",
  • "reporting_dimension_1": "string",
  • "reporting_dimension_2": "string",
  • "archived": true,
  • "telemedicine": true,
  • "advance_payment_item": "string",
  • "shift_types": [
    ],
  • "category": "string",
  • "default_resources": [
    ],
  • "data_excluded_from_communication": "string"
}

Archive Reason

Archive Reason

Required permissions:

  • Settings: Can access settings page

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this complaint type.

Responses

List Groups

List Groups

Required permissions:

  • Settings: Can access settings page

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Create new Group

Create new Group

Required permissions:

  • Settings: Can access settings page

This endpoint is rate-limited to 300 requests per minute.

Request Body schema: application/json
department
string
name
required
string

Responses

Request samples

Content type
application/json
{
  • "department": "string",
  • "name": "string"
}

Get Group by ID

Get Group by ID

Required permissions:

  • Settings: Can access settings page

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this complaint type group.

Responses

Update Group

Update Group

Required permissions:

  • Settings: Can access settings page

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this complaint type group.

Request Body schema: application/json
department
string
name
required
string

Responses

Request samples

Content type
application/json
{
  • "department": "string",
  • "name": "string"
}

Partially update Group

Partially update Group

Required permissions:

  • Settings: Can access settings page

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this complaint type group.

Request Body schema: application/json
department
string
name
string

Responses

Request samples

Content type
application/json
{
  • "department": "string",
  • "name": "string"
}

Archive Group

Archive Group

Required permissions:

  • Settings: Can access settings page

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this complaint type group.

Responses

recently_viewed

List recently viewed record

List recently viewed record

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Read only API

Read only API Return current user recently viewed records in current active department Depends on the content type, the structure of the history item data will be different Currently the following view history data is recorded:

  • Consultation details
  • Client details
  • Patient details
  • Invoice details
  • Estimate
  • Laboratory Referral
  • Imaging Referral

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this user view history.

Responses

Referral internal status

List Statuses

List Statuses

Required permissions:

  • Settings: Can access / edit department settings

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Get Status by ID

Get Status by ID

Required permissions:

  • Settings: Can access / edit department settings

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this referral internal status.

Responses

Referrers

List Referrers

List Referrers

Required permissions:

  • Patient referrals: Can access / edit patient referrals

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Create new Referrer

Create new Referrer

Required permissions:

  • Patient referrals: Can access / edit patient referrals

This endpoint is rate-limited to 300 requests per minute.

Request Body schema: application/json
referring_veterinarian
string
referring_organization
string
patient_referral
required
string

Responses

Request samples

Content type
application/json
{
  • "referring_veterinarian": "string",
  • "referring_organization": "string",
  • "patient_referral": "string"
}

Get Referrer by ID

Get Referrer by ID

Required permissions:

  • Patient referrals: Can access / edit patient referrals

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this referrer.

Responses

Update Referrer

Update Referrer

Required permissions:

  • Patient referrals: Can access / edit patient referrals

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this referrer.

Request Body schema: application/json
referring_veterinarian
string
referring_organization
string
patient_referral
required
string

Responses

Request samples

Content type
application/json
{
  • "referring_veterinarian": "string",
  • "referring_organization": "string",
  • "patient_referral": "string"
}

Partially update Referrer

Partially update Referrer

Required permissions:

  • Patient referrals: Can access / edit patient referrals

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this referrer.

Request Body schema: application/json
referring_veterinarian
string
referring_organization
string
patient_referral
string

Responses

Request samples

Content type
application/json
{
  • "referring_veterinarian": "string",
  • "referring_organization": "string",
  • "patient_referral": "string"
}

Archive Referrer

Archive Referrer

Required permissions:

  • Patient referrals: Can access / edit patient referrals

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this referrer.

Responses

Reminders

List Reminders

List Reminders

Required permissions:

  • General: Can access / edit reminders

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

ordering
string

Which field to use when ordering the results.

Responses

Create new Reminder

Create new Reminder

Required permissions:

  • General: Can access / edit reminders

This endpoint is rate-limited to 300 requests per minute.

Request Body schema: application/json
department
required
string
reminder_template
string
patient
string
client
required
string
email_address
string
phone_number
string
email_subject
string
email_text
string
sms_text
string
post_text
string
text_manually
boolean
send_before
required
integer
send_method
string
expiry_date
required
string
planned_sending_date
string
status
string
created_by
required
string
modified_by
string
recurring_type
string
recurring_times
integer
recurring_interval
integer
external_url
string
replaced_by
string

Responses

Request samples

Content type
application/json
{
  • "department": "string",
  • "reminder_template": "string",
  • "patient": "string",
  • "client": "string",
  • "email_address": "string",
  • "phone_number": "string",
  • "email_subject": "string",
  • "email_text": "string",
  • "sms_text": "string",
  • "post_text": "string",
  • "text_manually": true,
  • "send_before": 0,
  • "send_method": "string",
  • "expiry_date": "string",
  • "planned_sending_date": "string",
  • "status": "string",
  • "created_by": "string",
  • "modified_by": "string",
  • "recurring_type": "string",
  • "recurring_times": 0,
  • "recurring_interval": 0,
  • "external_url": "string",
  • "replaced_by": "string"
}

Get Reminder by ID

Get Reminder by ID

Required permissions:

  • General: Can access / edit reminders

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this reminder.

query Parameters
ordering
string

Which field to use when ordering the results.

Responses

Update Reminder

Update Reminder

Required permissions:

  • General: Can access / edit reminders

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this reminder.

query Parameters
ordering
string

Which field to use when ordering the results.

Request Body schema: application/json
department
required
string
reminder_template
string
patient
string
client
required
string
email_address
string
phone_number
string
email_subject
string
email_text
string
sms_text
string
post_text
string
text_manually
boolean
send_before
required
integer
send_method
string
expiry_date
required
string
planned_sending_date
string
status
string
created_by
required
string
modified_by
string
recurring_type
string
recurring_times
integer
recurring_interval
integer
external_url
string
replaced_by
string

Responses

Request samples

Content type
application/json
{
  • "department": "string",
  • "reminder_template": "string",
  • "patient": "string",
  • "client": "string",
  • "email_address": "string",
  • "phone_number": "string",
  • "email_subject": "string",
  • "email_text": "string",
  • "sms_text": "string",
  • "post_text": "string",
  • "text_manually": true,
  • "send_before": 0,
  • "send_method": "string",
  • "expiry_date": "string",
  • "planned_sending_date": "string",
  • "status": "string",
  • "created_by": "string",
  • "modified_by": "string",
  • "recurring_type": "string",
  • "recurring_times": 0,
  • "recurring_interval": 0,
  • "external_url": "string",
  • "replaced_by": "string"
}

Partially update Reminder

Partially update Reminder

Required permissions:

  • General: Can access / edit reminders

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this reminder.

query Parameters
ordering
string

Which field to use when ordering the results.

Request Body schema: application/json
department
string
reminder_template
string
patient
string
client
string
email_address
string
phone_number
string
email_subject
string
email_text
string
sms_text
string
post_text
string
text_manually
boolean
send_before
integer
send_method
string
expiry_date
string
planned_sending_date
string
status
string
created_by
string
modified_by
string
recurring_type
string
recurring_times
integer
recurring_interval
integer
external_url
string
replaced_by
string

Responses

Request samples

Content type
application/json
{
  • "department": "string",
  • "reminder_template": "string",
  • "patient": "string",
  • "client": "string",
  • "email_address": "string",
  • "phone_number": "string",
  • "email_subject": "string",
  • "email_text": "string",
  • "sms_text": "string",
  • "post_text": "string",
  • "text_manually": true,
  • "send_before": 0,
  • "send_method": "string",
  • "expiry_date": "string",
  • "planned_sending_date": "string",
  • "status": "string",
  • "created_by": "string",
  • "modified_by": "string",
  • "recurring_type": "string",
  • "recurring_times": 0,
  • "recurring_interval": 0,
  • "external_url": "string",
  • "replaced_by": "string"
}

Archive Reminder

Archive Reminder

Query Params:

  • deceased: If true, list Reminders for deceased patients only. If false, list Reminders for not archived and not deceased patients only.

Required permissions:

  • General: Can access / edit reminders

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this reminder.

query Parameters
ordering
string

Which field to use when ordering the results.

Responses

Mark a Reminder sent

Mark a Reminder sent

The Reminder must not have been marked as sent before and it must have an external sending method for this to work.

Required permissions:

  • General: Can access / edit reminders

This endpoint is rate-limited to 100 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this reminder.

Request Body schema: application/json
department
required
string
reminder_template
string
patient
string
client
required
string
email_address
string
phone_number
string
email_subject
string
email_text
string
sms_text
string
post_text
string
text_manually
boolean
send_before
required
integer
send_method
string
expiry_date
required
string
planned_sending_date
string
status
string
created_by
required
string
modified_by
string
recurring_type
string
recurring_times
integer
recurring_interval
integer
external_url
string
replaced_by
string

Responses

Request samples

Content type
application/json
{
  • "department": "string",
  • "reminder_template": "string",
  • "patient": "string",
  • "client": "string",
  • "email_address": "string",
  • "phone_number": "string",
  • "email_subject": "string",
  • "email_text": "string",
  • "sms_text": "string",
  • "post_text": "string",
  • "text_manually": true,
  • "send_before": 0,
  • "send_method": "string",
  • "expiry_date": "string",
  • "planned_sending_date": "string",
  • "status": "string",
  • "created_by": "string",
  • "modified_by": "string",
  • "recurring_type": "string",
  • "recurring_times": 0,
  • "recurring_interval": 0,
  • "external_url": "string",
  • "replaced_by": "string"
}

List Templates

List Templates

Required permissions:

  • Settings: Can acccess / edit reminder settings

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Create new Template

Create new Template

Required permissions:

  • Settings: Can acccess / edit reminder settings

This endpoint is rate-limited to 300 requests per minute.

Request Body schema: application/json
title
required
string
email_text
string
sms_text
string
post_text
string
department
string
created_by
string
modified_by
string
update_existing
boolean

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "email_text": "string",
  • "sms_text": "string",
  • "post_text": "string",
  • "department": "string",
  • "created_by": "string",
  • "modified_by": "string",
  • "update_existing": true
}

Get Template by ID

Get Template by ID

Required permissions:

  • Settings: Can acccess / edit reminder settings

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this Reminder template.

Responses

Update Template

Update Template

Required permissions:

  • Settings: Can acccess / edit reminder settings

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this Reminder template.

Request Body schema: application/json
title
required
string
email_text
string
sms_text
string
post_text
string
department
string
created_by
string
modified_by
string
update_existing
boolean

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "email_text": "string",
  • "sms_text": "string",
  • "post_text": "string",
  • "department": "string",
  • "created_by": "string",
  • "modified_by": "string",
  • "update_existing": true
}

Partially update Template

Partially update Template

Required permissions:

  • Settings: Can acccess / edit reminder settings

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this Reminder template.

Request Body schema: application/json
title
string
email_text
string
sms_text
string
post_text
string
department
string
created_by
string
modified_by
string
update_existing
boolean

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "email_text": "string",
  • "sms_text": "string",
  • "post_text": "string",
  • "department": "string",
  • "created_by": "string",
  • "modified_by": "string",
  • "update_existing": true
}

Archive Template

Archive Template

Required permissions:

  • Settings: Can acccess / edit reminder settings

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this Reminder template.

Responses

Resources

List Resources

List Resources

Required permissions:

  • Settings: Can access / edit department settings

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Create new Resource

Create new Resource

Required permissions:

  • Settings: Can access / edit department settings

This endpoint is rate-limited to 300 requests per minute.

Request Body schema: application/json
name
required
string
initials
string
is_active
boolean
department
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "initials": "string",
  • "is_active": true,
  • "department": "string"
}

Get Resource by ID

Get Resource by ID

Required permissions:

  • Settings: Can access / edit department settings

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this resource.

Responses

Update Resource

Update Resource

Required permissions:

  • Settings: Can access / edit department settings

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this resource.

Request Body schema: application/json
name
required
string
initials
string
is_active
boolean
department
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "initials": "string",
  • "is_active": true,
  • "department": "string"
}

Partially update Resource

Partially update Resource

Required permissions:

  • Settings: Can access / edit department settings

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this resource.

Request Body schema: application/json
name
string
initials
string
is_active
boolean
department
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "initials": "string",
  • "is_active": true,
  • "department": "string"
}

Shifts

List Shifts

List Shifts

error_code values:

  • SHIFT_ERROR_NON_BOOKABLE_TYPE = 1
  • SHIFT_ERROR_ORPHANED_APPOINTMENTS = 2

Required permissions:

  • Calendar: Can access / edit shifts

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

ordering
string

Which field to use when ordering the results.

Responses

Create new Shift

Create new Shift

Either user or employee_number is required.

Required permissions:

  • Calendar: Can access / edit shifts

This endpoint is rate-limited to 300 requests per minute.

Request Body schema: application/json
start
required
string
end
required
string
user
string
employee_number
string
department
required
string
ward
string
team
string
shift_type
required
string
web
boolean
note
string
is_slot
boolean

Responses

Request samples

Content type
application/json
{
  • "start": "string",
  • "end": "string",
  • "user": "string",
  • "employee_number": "string",
  • "department": "string",
  • "ward": "string",
  • "team": "string",
  • "shift_type": "string",
  • "web": true,
  • "note": "string",
  • "is_slot": true
}

Get Shift by ID

Get Shift by ID

Required permissions:

  • Calendar: Can access / edit shifts

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this user scheduling.

query Parameters
ordering
string

Which field to use when ordering the results.

Responses

Update Shift

Update Shift

Either user or employee_number is required.

Required permissions:

  • Calendar: Can access / edit shifts

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this user scheduling.

query Parameters
ordering
string

Which field to use when ordering the results.

Request Body schema: application/json
start
required
string
end
required
string
user
string
employee_number
string
department
required
string
ward
string
team
string
shift_type
required
string
web
boolean
note
string
is_slot
boolean

Responses

Request samples

Content type
application/json
{
  • "start": "string",
  • "end": "string",
  • "user": "string",
  • "employee_number": "string",
  • "department": "string",
  • "ward": "string",
  • "team": "string",
  • "shift_type": "string",
  • "web": true,
  • "note": "string",
  • "is_slot": true
}

Partially update Shift

Partially update Shift

Required permissions:

  • Calendar: Can access / edit shifts

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this user scheduling.

query Parameters
ordering
string

Which field to use when ordering the results.

Request Body schema: application/json
start
string
end
string
user
string
employee_number
string
department
string
ward
string
team
string
shift_type
string
web
boolean
note
string
is_slot
boolean

Responses

Request samples

Content type
application/json
{
  • "start": "string",
  • "end": "string",
  • "user": "string",
  • "employee_number": "string",
  • "department": "string",
  • "ward": "string",
  • "team": "string",
  • "shift_type": "string",
  • "web": true,
  • "note": "string",
  • "is_slot": true
}

Archive Shift

Archive Shift

Required permissions:

  • Calendar: Can access / edit shifts

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this user scheduling.

query Parameters
ordering
string

Which field to use when ordering the results.

Responses

List Types

List Types

Required permissions:

  • Calendar: Can access / edit shifts

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Create new Shift Type

Create new Shift Type

Required permissions:

  • Calendar: Can access / edit shifts

This endpoint is rate-limited to 300 requests per minute.

Request Body schema: application/json
code
required
integer
department
required
string
in_appointments
boolean
in_online_booking
boolean
in_all_day
boolean
is_custom
boolean
is_active
boolean
complaint_types
Array of strings

Responses

Request samples

Content type
application/json
{
  • "code": 0,
  • "department": "string",
  • "in_appointments": true,
  • "in_online_booking": true,
  • "in_all_day": true,
  • "is_custom": true,
  • "is_active": true,
  • "complaint_types": [
    ]
}

Get Type by ID

Get Type by ID

Required permissions:

  • Calendar: Can access / edit shifts

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this shift type.

Responses

Update Shift Type

Update Shift Type

This will also update existing shifts. Parameter update_existing_shifts can be set to false to disable it.

Required permissions:

  • Calendar: Can access / edit shifts

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this shift type.

Request Body schema: application/json
code
required
integer
department
required
string
in_appointments
boolean
in_online_booking
boolean
in_all_day
boolean
is_custom
boolean
is_active
boolean
complaint_types
Array of strings

Responses

Request samples

Content type
application/json
{
  • "code": 0,
  • "department": "string",
  • "in_appointments": true,
  • "in_online_booking": true,
  • "in_all_day": true,
  • "is_custom": true,
  • "is_active": true,
  • "complaint_types": [
    ]
}

Shift Types

Shift Types

Required permissions:

  • Calendar: Can access / edit shifts

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this shift type.

Request Body schema: application/json
code
integer
department
string
in_appointments
boolean
in_online_booking
boolean
in_all_day
boolean
is_custom
boolean
is_active
boolean
complaint_types
Array of strings

Responses

Request samples

Content type
application/json
{
  • "code": 0,
  • "department": "string",
  • "in_appointments": true,
  • "in_online_booking": true,
  • "in_all_day": true,
  • "is_custom": true,
  • "is_active": true,
  • "complaint_types": [
    ]
}

shifttemplate

List Shift Templates

List Shift Templates

Required permissions:

  • Calendar: Can access / edit shifts

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Create new Shift Template

Create new Shift Template

Required permissions:

  • Calendar: Can access / edit shifts

This endpoint is rate-limited to 300 requests per minute.

Request Body schema: application/json
active
boolean
name
required
string
code
string
two_day_template
boolean
department
required
string

Responses

Request samples

Content type
application/json
{
  • "active": true,
  • "name": "string",
  • "code": "string",
  • "two_day_template": true,
  • "department": "string"
}

Get Shift Template by ID

Get Shift Template by ID

Required permissions:

  • Calendar: Can access / edit shifts

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this shifts template.

Responses

Update Shift Template

Update Shift Template

Required permissions:

  • Calendar: Can access / edit shifts

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this shifts template.

Request Body schema: application/json
active
boolean
name
required
string
code
string
two_day_template
boolean
department
required
string

Responses

Request samples

Content type
application/json
{
  • "active": true,
  • "name": "string",
  • "code": "string",
  • "two_day_template": true,
  • "department": "string"
}

Partially update Shift Template

Partially update Shift Template

Required permissions:

  • Calendar: Can access / edit shifts

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this shifts template.

Request Body schema: application/json
active
boolean
name
string
code
string
two_day_template
boolean
department
string

Responses

Request samples

Content type
application/json
{
  • "active": true,
  • "name": "string",
  • "code": "string",
  • "two_day_template": true,
  • "department": "string"
}

Delete Shift Template

Delete Shift Template

Required permissions:

  • Calendar: Can access / edit shifts

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this shifts template.

Responses

List Shift Template Block Fragments

List Shift Template Block Fragments

Required permissions:

  • Calendar: Can access / edit shifts

This endpoint is rate-limited to 100 requests per minute.

path Parameters
parent_lookup_shifts_template_block__shifts_template
required
string
parent_lookup_shifts_template_block
required
string
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Create new Shift Template Block Fragment

Create new Shift Template Block Fragment

Required permissions:

  • Calendar: Can access / edit shifts

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_shifts_template_block__shifts_template
required
string
parent_lookup_shifts_template_block
required
string
Request Body schema: application/json
start_time
required
string
end_time
required
string
shift_type
required
integer
web
boolean
note
string
ward
integer
team
integer

Responses

Request samples

Content type
application/json
{
  • "start_time": "string",
  • "end_time": "string",
  • "shift_type": 0,
  • "web": true,
  • "note": "string",
  • "ward": 0,
  • "team": 0
}

Get Shift Template Block Fragment by ID

Get Shift Template Block Fragment by ID

Required permissions:

  • Calendar: Can access / edit shifts

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_shifts_template_block__shifts_template
required
string
parent_lookup_shifts_template_block
required
string
id
required
integer

A unique integer value identifying this shifts template block fragment.

Responses

Update Shift Template Block Fragment

Update Shift Template Block Fragment

Required permissions:

  • Calendar: Can access / edit shifts

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_shifts_template_block__shifts_template
required
string
parent_lookup_shifts_template_block
required
string
id
required
integer

A unique integer value identifying this shifts template block fragment.

Request Body schema: application/json
start_time
required
string
end_time
required
string
shift_type
required
integer
web
boolean
note
string
ward
integer
team
integer

Responses

Request samples

Content type
application/json
{
  • "start_time": "string",
  • "end_time": "string",
  • "shift_type": 0,
  • "web": true,
  • "note": "string",
  • "ward": 0,
  • "team": 0
}

Partially update Shift Template Block Fragment

Partially update Shift Template Block Fragment

Required permissions:

  • Calendar: Can access / edit shifts

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_shifts_template_block__shifts_template
required
string
parent_lookup_shifts_template_block
required
string
id
required
integer

A unique integer value identifying this shifts template block fragment.

Request Body schema: application/json
start_time
string
end_time
string
shift_type
integer
web
boolean
note
string
ward
integer
team
integer

Responses

Request samples

Content type
application/json
{
  • "start_time": "string",
  • "end_time": "string",
  • "shift_type": 0,
  • "web": true,
  • "note": "string",
  • "ward": 0,
  • "team": 0
}

Delete Shift Template Block Fragment

Delete Shift Template Block Fragment

Required permissions:

  • Calendar: Can access / edit shifts

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_shifts_template_block__shifts_template
required
string
parent_lookup_shifts_template_block
required
string
id
required
integer

A unique integer value identifying this shifts template block fragment.

Responses

List Shift Template Blocks

List Shift Template Blocks

Required permissions:

  • Calendar: Can access / edit shifts

This endpoint is rate-limited to 100 requests per minute.

path Parameters
parent_lookup_shifts_template
required
string
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Create new Shift Template Block

Create new Shift Template Block

Required permissions:

  • Calendar: Can access / edit shifts

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_shifts_template
required
string
Request Body schema: application/json
block_index
integer
start_time
required
string
end_time
required
string

Responses

Request samples

Content type
application/json
{
  • "block_index": 0,
  • "start_time": "string",
  • "end_time": "string"
}

Get Shift Template Block by ID

Get Shift Template Block by ID

Required permissions:

  • Calendar: Can access / edit shifts

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_shifts_template
required
string
id
required
integer

A unique integer value identifying this shifts template block.

Responses

Update Shift Template Block

Update Shift Template Block

Required permissions:

  • Calendar: Can access / edit shifts

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_shifts_template
required
string
id
required
integer

A unique integer value identifying this shifts template block.

Request Body schema: application/json
block_index
integer
start_time
required
string
end_time
required
string

Responses

Request samples

Content type
application/json
{
  • "block_index": 0,
  • "start_time": "string",
  • "end_time": "string"
}

Partially update Shift Template Block

Partially update Shift Template Block

Required permissions:

  • Calendar: Can access / edit shifts

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_shifts_template
required
string
id
required
integer

A unique integer value identifying this shifts template block.

Request Body schema: application/json
block_index
integer
start_time
string
end_time
string

Responses

Request samples

Content type
application/json
{
  • "block_index": 0,
  • "start_time": "string",
  • "end_time": "string"
}

Delete Shift Template Block

Delete Shift Template Block

Required permissions:

  • Calendar: Can access / edit shifts

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_shifts_template
required
string
id
required
integer

A unique integer value identifying this shifts template block.

Responses

SMS messages

Send SMS message

Send SMS message

Required parameters (JSON object):

  • message (string)
  • department_id (int)
  • phone_number_id (int) OR phone_number (string)

Returns 'sms_task_id' (in a JSON object), which can be used to check the status of the SMS sending task.

This endpoint is rate-limited to 100 requests per minute.

Responses

Check the status of an SMS sending task

Check the status of an SMS sending task

Note that once a task has finished, its status can only be checked once after which the result of the task is forgotten.

Required parameter (query string):

  • sms_task_id (string)

Returns a JSON object with 3 possible keys:

  • finished (boolean)
  • successful (boolean) (only if finished)
  • message (string) (only if finished and not successful)

This endpoint is rate-limited to 100 requests per minute.

Responses

Stock

List Batches

List Batches

Required permissions:

  • Settings: Can access / edit stock

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Create new Batch

Create new Batch

Required permissions:

  • Settings: Can access / edit stock

This endpoint is rate-limited to 300 requests per minute.

Request Body schema: application/json
batch_number
required
string
department_id
integer
expiry_date
string
item_id
integer
stock_item
string

Responses

Request samples

Content type
application/json
{
  • "batch_number": "string",
  • "department_id": 0,
  • "expiry_date": "string",
  • "item_id": 0,
  • "stock_item": "string"
}

Get Batch by ID

Get Batch by ID

Required permissions:

  • Settings: Can access / edit stock

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this batch.

Responses

Update Batch

Update Batch

Required permissions:

  • Settings: Can access / edit stock

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this batch.

Request Body schema: application/json
batch_number
required
string
department_id
integer
expiry_date
string
item_id
integer
stock_item
string

Responses

Request samples

Content type
application/json
{
  • "batch_number": "string",
  • "department_id": 0,
  • "expiry_date": "string",
  • "item_id": 0,
  • "stock_item": "string"
}

Partially update Batch

Partially update Batch

Required permissions:

  • Settings: Can access / edit stock

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this batch.

Request Body schema: application/json
batch_number
string
department_id
integer
expiry_date
string
item_id
integer
stock_item
string

Responses

Request samples

Content type
application/json
{
  • "batch_number": "string",
  • "department_id": 0,
  • "expiry_date": "string",
  • "item_id": 0,
  • "stock_item": "string"
}

Stock Batches

Stock Batches

Required permissions:

  • Settings: Can access / edit stock

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this batch.

Responses

List Item Entries

List Item Entries

type values:

  • TYPE_ADD = 1
  • TYPE_USE = 2
  • TYPE_LOSS = 3
  • TYPE_MEASUREMENT_LOSS = 4
  • TYPE_OTHER = 5
  • TYPE_INVENTORY = 6

Required permissions:

  • Settings: Can access / edit stock

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Create new Item Entry

Create new Item Entry

Required permissions:

  • Settings: Can access / edit stock

This endpoint is rate-limited to 300 requests per minute.

Request Body schema: application/json
batch
string
description
string
department_id
integer
item_id
integer
units
number
quantity
number
type
string
subtype
string
stock_item
string
stock_location
string

Responses

Request samples

Content type
application/json
{
  • "batch": "string",
  • "description": "string",
  • "department_id": 0,
  • "item_id": 0,
  • "units": 0,
  • "quantity": 0,
  • "type": "string",
  • "subtype": "string",
  • "stock_item": "string",
  • "stock_location": "string"
}

Stock Item Entry

Stock Item Entry

Required permissions:

  • Settings: Can access / edit stock

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this item entry.

Responses

Stock items

Stock items

Required permissions:

  • Settings: Can access / edit stock

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

include_archived
string

Set to 'true' to include archived items in results

target_location
string

Get location specific stock levels

Responses

Stock Item

Stock Item

wholesale_price_unit and stock_value are calculated values, rounded to two decimals.

Required permissions:

  • Settings: Can access / edit stock

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this stock item.

query Parameters
include_archived
string

Set to 'true' to include archived items in results

target_location
string

Get location specific stock levels

Responses

Stock inventory

Stock inventory

HTTP GET: Show current levels. If posting the response to POST endpoint, levels are confirmed and no changes to levels are done.

HTTP POST: Set new levels for inventory

Required permissions:

  • Settings: Can access / edit stock

This endpoint is rate-limited to 100 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this stock item.

query Parameters
include_archived
string

Set to 'true' to include archived items in results

target_location
string

Get location specific stock levels

Responses

Stock inventory

Stock inventory

HTTP GET: Show current levels. If posting the response to POST endpoint, levels are confirmed and no changes to levels are done.

HTTP POST: Set new levels for inventory

Required permissions:

  • Settings: Can access / edit stock

This endpoint is rate-limited to 100 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this stock item.

query Parameters
include_archived
string

Set to 'true' to include archived items in results

target_location
string

Get location specific stock levels

Request Body schema: application/json
item
required
string
item_type_code
required
integer
item_name
required
string
item_unit_description
required
string
item_package_description
required
string
department
required
string

Responses

Request samples

Content type
application/json
{
  • "item": "string",
  • "item_type_code": 0,
  • "item_name": "string",
  • "item_unit_description": "string",
  • "item_package_description": "string",
  • "department": "string"
}

List Locations

List Locations

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Stock Locations

Stock Locations

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this stock location.

Responses

List Location Alert Levels

List Location Alert Levels

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Create new Location Alert Level

Create new Location Alert Level

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 300 requests per minute.

Request Body schema: application/json
item
required
string
department
required
string
stock_locations
Array of strings
alert_level
required
number
optimum_level
number

Responses

Request samples

Content type
application/json
{
  • "item": "string",
  • "department": "string",
  • "stock_locations": [
    ],
  • "alert_level": 0,
  • "optimum_level": 0
}

Stock Location Alert Levels

Stock Location Alert Levels

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this location alert level.

Responses

Update Location Alert Level

Update Location Alert Level

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this location alert level.

Request Body schema: application/json
item
required
string
department
required
string
stock_locations
Array of strings
alert_level
required
number
optimum_level
number

Responses

Request samples

Content type
application/json
{
  • "item": "string",
  • "department": "string",
  • "stock_locations": [
    ],
  • "alert_level": 0,
  • "optimum_level": 0
}

Partially update Location Alert Level

Partially update Location Alert Level

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this location alert level.

Request Body schema: application/json
item
string
department
string
stock_locations
Array of strings
alert_level
number
optimum_level
number

Responses

Request samples

Content type
application/json
{
  • "item": "string",
  • "department": "string",
  • "stock_locations": [
    ],
  • "alert_level": 0,
  • "optimum_level": 0
}

Archive Location Alert Level

Archive Location Alert Level

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this location alert level.

Responses

Stock levels

Stock items

Stock items

Required permissions:

  • Settings: Can access / edit stock

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

include_archived
string

Set to 'true' to include archived items in results

target_location
string

Get location specific stock levels

Responses

Stock Item

Stock Item

wholesale_price_unit and stock_value are calculated values, rounded to two decimals.

Required permissions:

  • Settings: Can access / edit stock

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this stock item.

query Parameters
include_archived
string

Set to 'true' to include archived items in results

target_location
string

Get location specific stock levels

Responses

Stock inventory

Stock inventory

HTTP GET: Show current levels. If posting the response to POST endpoint, levels are confirmed and no changes to levels are done.

HTTP POST: Set new levels for inventory

Required permissions:

  • Settings: Can access / edit stock

This endpoint is rate-limited to 100 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this stock item.

query Parameters
include_archived
string

Set to 'true' to include archived items in results

target_location
string

Get location specific stock levels

Responses

Stock inventory

Stock inventory

HTTP GET: Show current levels. If posting the response to POST endpoint, levels are confirmed and no changes to levels are done.

HTTP POST: Set new levels for inventory

Required permissions:

  • Settings: Can access / edit stock

This endpoint is rate-limited to 100 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this stock item.

query Parameters
include_archived
string

Set to 'true' to include archived items in results

target_location
string

Get location specific stock levels

Request Body schema: application/json
item
required
string
item_type_code
required
integer
item_name
required
string
item_unit_description
required
string
item_package_description
required
string
department
required
string

Responses

Request samples

Content type
application/json
{
  • "item": "string",
  • "item_type_code": 0,
  • "item_name": "string",
  • "item_unit_description": "string",
  • "item_package_description": "string",
  • "department": "string"
}

Supplies

List Supplies

List Supplies

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

ordering
string

Which field to use when ordering the results.

include_archived
string

Set to 'true' to include archived items in results

Responses

Create new Supply

Create new Supply

  • Price calculations documentation: check the documentaion in the "Create new Food" (POST /food/)

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 300 requests per minute.

query Parameters
include_archived
string

Set to 'true' to include archived items in results

Request Body schema: application/json
main_item
string
code
string
barcode
string
account_number
string
name
required
string
print_name
string
hide_on_consultation
boolean
price
number
price_with_vat
number
minimum_price
number
minimum_price_with_vat
number
wholesale_price
number
wholesaler_discount
number
producer_discount
number
special_discount
number
margin_percent
number
vat_group
required
string
invoice_group
string
item_list
required
string
type_code
required
string

ITEM_TYPE_PROCEDURE = 1, ITEM_TYPE_MEDICINE = 2, ITEM_TYPE_SUPPLY = 3, ITEM_TYPE_FOOD = 4, ITEM_TYPE_LABORATORY_ANALYSIS = 5, ITEM_TYPE_LABORATORY_ANALYSIS_PANEL = 6

parent_amount
number
instructions
string
archived
boolean
archived_datetime
string
exclude_discount
boolean
hide_zero_print
boolean
linked_items
Array of strings
reporting_dimension_1
string

Primarily code is used, if not found id is used

reporting_dimension_2
string

Primarily code is used, if not found id is used

hide_on_countersale_search
boolean
performed_by_rule
string

PERFORMED_BY_INHERIT = 0, PERFORMED_BY_REQUIRED = 1, PERFORMED_BY_NOT_REQUIRED = 2

royalty_fee
integer
external_reporting_code
string
external_reporting_code_2
string
external_reporting_code_3
string
hide_on_consultation_search
boolean
disable_price_calculation
boolean
species
Array of strings
no_department_rates
boolean
related_diagnoses_groups
Array of strings
conditional_price_overrides
Array of strings
primary_wholesaler
string
primary_wholesaler_code
string
secondary_wholesaler
string
secondary_wholesaler_code
string
alert_level
number
internal_instructions
string
is_cabinet_item
boolean
discontinued_product
boolean

These items can no longer be added into orders

unit
string

"Unit description" in the UI.

default_order_amount
number
manufacturer
object
shelf_location
string
manufacturer_data
string
manufacturer_url
string
optimum_level
number
usage_type
string

USAGE_TYPE_ADMINISTERED = 1, USAGE_TYPE_GIVEN = 2, USAGE_TYPE_PRESCRIPTION = 3

dosage_units
number

"Units in the package" in the UI.

minimum_dosage_units
number
default_usage_size
string

USAGE_SIZE_PACKAGE = 1, USAGE_SIZE_DOSAGE_UNITS = 2

package_description
string
not_in_stock_management
boolean
batch_number_required
boolean
minimum_charge
number
minimum_charge_with_vat
number

Responses

Request samples

Content type
application/json
{
  • "main_item": "string",
  • "code": "string",
  • "barcode": "string",
  • "account_number": "string",
  • "name": "string",
  • "print_name": "string",
  • "hide_on_consultation": true,
  • "price": 0,
  • "price_with_vat": 0,
  • "minimum_price": 0,
  • "minimum_price_with_vat": 0,
  • "wholesale_price": 0,
  • "wholesaler_discount": 0,
  • "producer_discount": 0,
  • "special_discount": 0,
  • "margin_percent": 0,
  • "vat_group": "string",
  • "invoice_group": "string",
  • "item_list": "string",
  • "type_code": "string",
  • "parent_amount": 0,
  • "instructions": "string",
  • "archived": true,
  • "archived_datetime": "string",
  • "exclude_discount": true,
  • "hide_zero_print": true,
  • "linked_items": [
    ],
  • "reporting_dimension_1": "string",
  • "reporting_dimension_2": "string",
  • "hide_on_countersale_search": true,
  • "performed_by_rule": "string",
  • "royalty_fee": 0,
  • "external_reporting_code": "string",
  • "external_reporting_code_2": "string",
  • "external_reporting_code_3": "string",
  • "hide_on_consultation_search": true,
  • "disable_price_calculation": true,
  • "species": [
    ],
  • "no_department_rates": true,
  • "related_diagnoses_groups": [
    ],
  • "conditional_price_overrides": [
    ],
  • "primary_wholesaler": "string",
  • "primary_wholesaler_code": "string",
  • "secondary_wholesaler": "string",
  • "secondary_wholesaler_code": "string",
  • "alert_level": 0,
  • "internal_instructions": "string",
  • "is_cabinet_item": true,
  • "discontinued_product": true,
  • "unit": "string",
  • "default_order_amount": 0,
  • "manufacturer": { },
  • "shelf_location": "string",
  • "manufacturer_data": "string",
  • "manufacturer_url": "string",
  • "optimum_level": 0,
  • "usage_type": "string",
  • "dosage_units": 0,
  • "minimum_dosage_units": 0,
  • "default_usage_size": "string",
  • "package_description": "string",
  • "not_in_stock_management": true,
  • "batch_number_required": true,
  • "minimum_charge": 0,
  • "minimum_charge_with_vat": 0
}

Get Supply by ID

Get Supply by ID

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this supply.

query Parameters
ordering
string

Which field to use when ordering the results.

include_archived
string

Set to 'true' to include archived items in results

Responses

Update Supply

Update Supply

  • Price calculations documentation: check the documentaion in the "Create new Food" (POST /food/)

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this supply.

query Parameters
ordering
string

Which field to use when ordering the results.

include_archived
string

Set to 'true' to include archived items in results

Request Body schema: application/json
main_item
string
code
string
barcode
string
account_number
string
name
required
string
print_name
string
hide_on_consultation
boolean
price
number
price_with_vat
number
minimum_price
number
minimum_price_with_vat
number
wholesale_price
number
wholesaler_discount
number
producer_discount
number
special_discount
number
margin_percent
number
vat_group
required
string
invoice_group
string
item_list
required
string
type_code
required
string

ITEM_TYPE_PROCEDURE = 1, ITEM_TYPE_MEDICINE = 2, ITEM_TYPE_SUPPLY = 3, ITEM_TYPE_FOOD = 4, ITEM_TYPE_LABORATORY_ANALYSIS = 5, ITEM_TYPE_LABORATORY_ANALYSIS_PANEL = 6

parent_amount
number
instructions
string
archived
boolean
archived_datetime
string
exclude_discount
boolean
hide_zero_print
boolean
linked_items
Array of strings
reporting_dimension_1
string

Primarily code is used, if not found id is used

reporting_dimension_2
string

Primarily code is used, if not found id is used

hide_on_countersale_search
boolean
performed_by_rule
string

PERFORMED_BY_INHERIT = 0, PERFORMED_BY_REQUIRED = 1, PERFORMED_BY_NOT_REQUIRED = 2

royalty_fee
integer
external_reporting_code
string
external_reporting_code_2
string
external_reporting_code_3
string
hide_on_consultation_search
boolean
disable_price_calculation
boolean
species
Array of strings
no_department_rates
boolean
related_diagnoses_groups
Array of strings
conditional_price_overrides
Array of strings
primary_wholesaler
string
primary_wholesaler_code
string
secondary_wholesaler
string
secondary_wholesaler_code
string
alert_level
number
internal_instructions
string
is_cabinet_item
boolean
discontinued_product
boolean

These items can no longer be added into orders

unit
string

"Unit description" in the UI.

default_order_amount
number
manufacturer
object
shelf_location
string
manufacturer_data
string
manufacturer_url
string
optimum_level
number
usage_type
string

USAGE_TYPE_ADMINISTERED = 1, USAGE_TYPE_GIVEN = 2, USAGE_TYPE_PRESCRIPTION = 3

dosage_units
number

"Units in the package" in the UI.

minimum_dosage_units
number
default_usage_size
string

USAGE_SIZE_PACKAGE = 1, USAGE_SIZE_DOSAGE_UNITS = 2

package_description
string
not_in_stock_management
boolean
batch_number_required
boolean
minimum_charge
number
minimum_charge_with_vat
number

Responses

Request samples

Content type
application/json
{
  • "main_item": "string",
  • "code": "string",
  • "barcode": "string",
  • "account_number": "string",
  • "name": "string",
  • "print_name": "string",
  • "hide_on_consultation": true,
  • "price": 0,
  • "price_with_vat": 0,
  • "minimum_price": 0,
  • "minimum_price_with_vat": 0,
  • "wholesale_price": 0,
  • "wholesaler_discount": 0,
  • "producer_discount": 0,
  • "special_discount": 0,
  • "margin_percent": 0,
  • "vat_group": "string",
  • "invoice_group": "string",
  • "item_list": "string",
  • "type_code": "string",
  • "parent_amount": 0,
  • "instructions": "string",
  • "archived": true,
  • "archived_datetime": "string",
  • "exclude_discount": true,
  • "hide_zero_print": true,
  • "linked_items": [
    ],
  • "reporting_dimension_1": "string",
  • "reporting_dimension_2": "string",
  • "hide_on_countersale_search": true,
  • "performed_by_rule": "string",
  • "royalty_fee": 0,
  • "external_reporting_code": "string",
  • "external_reporting_code_2": "string",
  • "external_reporting_code_3": "string",
  • "hide_on_consultation_search": true,
  • "disable_price_calculation": true,
  • "species": [
    ],
  • "no_department_rates": true,
  • "related_diagnoses_groups": [
    ],
  • "conditional_price_overrides": [
    ],
  • "primary_wholesaler": "string",
  • "primary_wholesaler_code": "string",
  • "secondary_wholesaler": "string",
  • "secondary_wholesaler_code": "string",
  • "alert_level": 0,
  • "internal_instructions": "string",
  • "is_cabinet_item": true,
  • "discontinued_product": true,
  • "unit": "string",
  • "default_order_amount": 0,
  • "manufacturer": { },
  • "shelf_location": "string",
  • "manufacturer_data": "string",
  • "manufacturer_url": "string",
  • "optimum_level": 0,
  • "usage_type": "string",
  • "dosage_units": 0,
  • "minimum_dosage_units": 0,
  • "default_usage_size": "string",
  • "package_description": "string",
  • "not_in_stock_management": true,
  • "batch_number_required": true,
  • "minimum_charge": 0,
  • "minimum_charge_with_vat": 0
}

Partially update Supply

Partially update Supply

  • Price calculations documentation: check the documentaion in the "Create new Food" (POST /food/)

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this supply.

query Parameters
ordering
string

Which field to use when ordering the results.

include_archived
string

Set to 'true' to include archived items in results

Request Body schema: application/json
main_item
string
code
string
barcode
string
account_number
string
name
string
print_name
string
hide_on_consultation
boolean
price
number
price_with_vat
number
minimum_price
number
minimum_price_with_vat
number
wholesale_price
number
wholesaler_discount
number
producer_discount
number
special_discount
number
margin_percent
number
vat_group
string
invoice_group
string
item_list
string
type_code
string

ITEM_TYPE_PROCEDURE = 1, ITEM_TYPE_MEDICINE = 2, ITEM_TYPE_SUPPLY = 3, ITEM_TYPE_FOOD = 4, ITEM_TYPE_LABORATORY_ANALYSIS = 5, ITEM_TYPE_LABORATORY_ANALYSIS_PANEL = 6

parent_amount
number
instructions
string
archived
boolean
archived_datetime
string
exclude_discount
boolean
hide_zero_print
boolean
linked_items
Array of strings
reporting_dimension_1
string

Primarily code is used, if not found id is used

reporting_dimension_2
string

Primarily code is used, if not found id is used

hide_on_countersale_search
boolean
performed_by_rule
string

PERFORMED_BY_INHERIT = 0, PERFORMED_BY_REQUIRED = 1, PERFORMED_BY_NOT_REQUIRED = 2

royalty_fee
integer
external_reporting_code
string
external_reporting_code_2
string
external_reporting_code_3
string
hide_on_consultation_search
boolean
disable_price_calculation
boolean
species
Array of strings
no_department_rates
boolean
related_diagnoses_groups
Array of strings
conditional_price_overrides
Array of strings
primary_wholesaler
string
primary_wholesaler_code
string
secondary_wholesaler
string
secondary_wholesaler_code
string
alert_level
number
internal_instructions
string
is_cabinet_item
boolean
discontinued_product
boolean

These items can no longer be added into orders

unit
string

"Unit description" in the UI.

default_order_amount
number
manufacturer
object
shelf_location
string
manufacturer_data
string
manufacturer_url
string
optimum_level
number
usage_type
string

USAGE_TYPE_ADMINISTERED = 1, USAGE_TYPE_GIVEN = 2, USAGE_TYPE_PRESCRIPTION = 3

dosage_units
number

"Units in the package" in the UI.

minimum_dosage_units
number
default_usage_size
string

USAGE_SIZE_PACKAGE = 1, USAGE_SIZE_DOSAGE_UNITS = 2

package_description
string
not_in_stock_management
boolean
batch_number_required
boolean
minimum_charge
number
minimum_charge_with_vat
number

Responses

Request samples

Content type
application/json
{
  • "main_item": "string",
  • "code": "string",
  • "barcode": "string",
  • "account_number": "string",
  • "name": "string",
  • "print_name": "string",
  • "hide_on_consultation": true,
  • "price": 0,
  • "price_with_vat": 0,
  • "minimum_price": 0,
  • "minimum_price_with_vat": 0,
  • "wholesale_price": 0,
  • "wholesaler_discount": 0,
  • "producer_discount": 0,
  • "special_discount": 0,
  • "margin_percent": 0,
  • "vat_group": "string",
  • "invoice_group": "string",
  • "item_list": "string",
  • "type_code": "string",
  • "parent_amount": 0,
  • "instructions": "string",
  • "archived": true,
  • "archived_datetime": "string",
  • "exclude_discount": true,
  • "hide_zero_print": true,
  • "linked_items": [
    ],
  • "reporting_dimension_1": "string",
  • "reporting_dimension_2": "string",
  • "hide_on_countersale_search": true,
  • "performed_by_rule": "string",
  • "royalty_fee": 0,
  • "external_reporting_code": "string",
  • "external_reporting_code_2": "string",
  • "external_reporting_code_3": "string",
  • "hide_on_consultation_search": true,
  • "disable_price_calculation": true,
  • "species": [
    ],
  • "no_department_rates": true,
  • "related_diagnoses_groups": [
    ],
  • "conditional_price_overrides": [
    ],
  • "primary_wholesaler": "string",
  • "primary_wholesaler_code": "string",
  • "secondary_wholesaler": "string",
  • "secondary_wholesaler_code": "string",
  • "alert_level": 0,
  • "internal_instructions": "string",
  • "is_cabinet_item": true,
  • "discontinued_product": true,
  • "unit": "string",
  • "default_order_amount": 0,
  • "manufacturer": { },
  • "shelf_location": "string",
  • "manufacturer_data": "string",
  • "manufacturer_url": "string",
  • "optimum_level": 0,
  • "usage_type": "string",
  • "dosage_units": 0,
  • "minimum_dosage_units": 0,
  • "default_usage_size": "string",
  • "package_description": "string",
  • "not_in_stock_management": true,
  • "batch_number_required": true,
  • "minimum_charge": 0,
  • "minimum_charge_with_vat": 0
}

Archives an item.

Archives an item.

Required permissions:

  • Settings: Can access / edit items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this supply.

query Parameters
ordering
string

Which field to use when ordering the results.

include_archived
string

Set to 'true' to include archived items in results

Responses

Tag journal entries

Create new Journal Entry Log

Create new Journal Entry Log

Required permissions:

  • Financial: Can access / edit invoices

This endpoint is rate-limited to 300 requests per minute.

Request Body schema: application/json
report_name
string
created_user
string
created_user_id
integer
metadata
string

Responses

Request samples

Content type
application/json
{
  • "report_name": "string",
  • "created_user": "string",
  • "created_user_id": 0,
  • "metadata": "string"
}

Tag journal entry problems

Required permissions:

Required permissions:

  • Financial: Can access / edit invoices

This endpoint is rate-limited to 300 requests per minute.

Request Body schema: application/json
report_name
string
created_user
string
created_user_id
integer
metadata
string

Responses

Request samples

Content type
application/json
{
  • "report_name": "string",
  • "created_user": "string",
  • "created_user_id": 0,
  • "metadata": "string"
}

Target areas

List Target Areas

List Target Areas

Required permissions:

  • Settings: Can access / edit integration settings

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Get Target Area by ID

Get Target Area by ID

Required permissions:

  • Settings: Can access / edit integration settings

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this target area.

Responses

Tasks

List Tasks

List Tasks

Required permissions:

  • General: Can access / edit tasks

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Create new Task

Create new Task

Required permissions:

  • General: Can access / edit tasks

This endpoint is rate-limited to 300 requests per minute.

Request Body schema: application/json
title
required
string
text
string
status
string
completed
string
task_type
string
favourite
boolean
due
string
remind
string
user
string
client
string
patients
required
Array of strings
created_user
required
string
modified_user
string
ward
string

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "text": "string",
  • "status": "string",
  • "completed": "string",
  • "task_type": "string",
  • "favourite": true,
  • "due": "string",
  • "remind": "string",
  • "user": "string",
  • "client": "string",
  • "patients": [
    ],
  • "created_user": "string",
  • "modified_user": "string",
  • "ward": "string"
}

Get Task by ID

Get Task by ID

Required permissions:

  • General: Can access / edit tasks

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this task.

Responses

Update Task

Update Task

Required permissions:

  • General: Can access / edit tasks

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this task.

Request Body schema: application/json
title
required
string
text
string
status
string
completed
string
task_type
string
favourite
boolean
due
string
remind
string
user
string
client
string
patients
required
Array of strings
created_user
required
string
modified_user
string
ward
string

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "text": "string",
  • "status": "string",
  • "completed": "string",
  • "task_type": "string",
  • "favourite": true,
  • "due": "string",
  • "remind": "string",
  • "user": "string",
  • "client": "string",
  • "patients": [
    ],
  • "created_user": "string",
  • "modified_user": "string",
  • "ward": "string"
}

Partially update Task

Partially update Task

Required permissions:

  • General: Can access / edit tasks

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this task.

Request Body schema: application/json
title
string
text
string
status
string
completed
string
task_type
string
favourite
boolean
due
string
remind
string
user
string
client
string
patients
Array of strings
created_user
string
modified_user
string
ward
string

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "text": "string",
  • "status": "string",
  • "completed": "string",
  • "task_type": "string",
  • "favourite": true,
  • "due": "string",
  • "remind": "string",
  • "user": "string",
  • "client": "string",
  • "patients": [
    ],
  • "created_user": "string",
  • "modified_user": "string",
  • "ward": "string"
}

Archive Task

Archive Task

Required permissions:

  • General: Can access / edit tasks

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this task.

Responses

Text templates

List Text Templates

List Text Templates

Types are:

  • Clinical note template = 0
  • Discharge note template = 1
  • Medicine instruction template = 2
  • Communications template = 3
  • Preliminary note template = 4
  • Referral remark template = 5
  • Laboratory result report template = 6

Required permissions:

  • Settings: Can access settings page

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Create new Text Template

Create new Text Template

Required permissions:

  • Settings: Can access settings page

This endpoint is rate-limited to 300 requests per minute.

Request Body schema: application/json
title
required
string
text
required
string
type
required
string
specific_user
string
departments
Array of strings
archived
boolean
draft
boolean
items
Array of strings

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "text": "string",
  • "type": "string",
  • "specific_user": "string",
  • "departments": [
    ],
  • "archived": true,
  • "draft": true,
  • "items": [
    ]
}

Get Text Template by ID

Get Text Template by ID

Required permissions:

  • Settings: Can access settings page

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this template.

Responses

Update Text Template

Update Text Template

Required permissions:

  • Settings: Can access settings page

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this template.

Request Body schema: application/json
title
required
string
text
required
string
type
required
string
specific_user
string
departments
Array of strings
archived
boolean
draft
boolean
items
Array of strings

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "text": "string",
  • "type": "string",
  • "specific_user": "string",
  • "departments": [
    ],
  • "archived": true,
  • "draft": true,
  • "items": [
    ]
}

Partially update Text Template

Partially update Text Template

Required permissions:

  • Settings: Can access settings page

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this template.

Request Body schema: application/json
title
string
text
string
type
string
specific_user
string
departments
Array of strings
archived
boolean
draft
boolean
items
Array of strings

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "text": "string",
  • "type": "string",
  • "specific_user": "string",
  • "departments": [
    ],
  • "archived": true,
  • "draft": true,
  • "items": [
    ]
}

Treatment plans

List Departments

List Departments

This endpoint is rate-limited to 300 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Get Department by ID

Get Department by ID

This endpoint is rate-limited to 1200 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this department.

Responses

Patient - with treatment plans and active consultations - group by ward

Patient - with treatment plans and active consultations - group by ward

Required permissions:

  • General: Can access / edit patients and clients
  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_departments
required
string
id
required
string

Responses

List Plans

List Plans

Required permissions:

  • General: Can access / edit patients and clients
  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Get Plan by ID

Get Plan by ID

Required permissions:

  • General: Can access / edit patients and clients
  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this treatment plan.

Responses

List Foods

List Foods

Required permissions:

  • General: Can access / edit patients and clients
  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Get Food by ID

Get Food by ID

Required permissions:

  • General: Can access / edit patients and clients
  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this treatment plan food.

Responses

Update Food

Update Food

Required permissions:

  • General: Can access / edit patients and clients
  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this treatment plan food.

Request Body schema: application/json
treatment_plan
required
string
planned_time
required
string
planned_user
string
prepared_time
string
prepared_user
string
started_time
string
started_user
string
done_time
string
done_user
string
status
string
consultation_item
string
usage_size
string
instructions
string
item
required
string
quantity
number
archived
boolean
unit
required
string

Unit description from item settings

package_description
required
string

Package description from item settings

Responses

Request samples

Content type
application/json
{
  • "treatment_plan": "string",
  • "planned_time": "string",
  • "planned_user": "string",
  • "prepared_time": "string",
  • "prepared_user": "string",
  • "started_time": "string",
  • "started_user": "string",
  • "done_time": "string",
  • "done_user": "string",
  • "status": "string",
  • "consultation_item": "string",
  • "usage_size": "string",
  • "instructions": "string",
  • "item": "string",
  • "quantity": 0,
  • "archived": true,
  • "unit": "string",
  • "package_description": "string"
}

Partially update Food

Partially update Food

Patch allows updating quantity and usage_size.

Required permissions:

  • General: Can access / edit patients and clients
  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this treatment plan food.

Request Body schema: application/json
quantity
number
usage_size
string

Responses

Request samples

Content type
application/json
{
  • "quantity": 0,
  • "usage_size": "string"
}

Archive Food

Archive Food

Required permissions:

  • General: Can access / edit patients and clients
  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this treatment plan food.

Responses

Mark Food as done. Creates ConsultationItem automatically.

Mark Food as done. Creates ConsultationItem automatically.

Required permissions:

  • General: Can access / edit patients and clients
  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 100 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this treatment plan food.

Request Body schema: application/json
treatment_plan
required
string
planned_time
required
string
planned_user
string
prepared_time
string
prepared_user
string
started_time
string
started_user
string
done_time
string
done_user
string
status
string
consultation_item
string
usage_size
string
instructions
string
item
required
string
quantity
number
archived
boolean
unit
required
string

Unit description from item settings

package_description
required
string

Package description from item settings

Responses

Request samples

Content type
application/json
{
  • "treatment_plan": "string",
  • "planned_time": "string",
  • "planned_user": "string",
  • "prepared_time": "string",
  • "prepared_user": "string",
  • "started_time": "string",
  • "started_user": "string",
  • "done_time": "string",
  • "done_user": "string",
  • "status": "string",
  • "consultation_item": "string",
  • "usage_size": "string",
  • "instructions": "string",
  • "item": "string",
  • "quantity": 0,
  • "archived": true,
  • "unit": "string",
  • "package_description": "string"
}

List Medicines

List Medicines

Required permissions:

  • General: Can access / edit patients and clients
  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Get Medicine by ID

Get Medicine by ID

Required permissions:

  • General: Can access / edit patients and clients
  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this treatment plan medicine.

Responses

Update Medicine

Update Medicine

Required permissions:

  • General: Can access / edit patients and clients
  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this treatment plan medicine.

Request Body schema: application/json
treatment_plan
required
string
planned_time
required
string
planned_user
string
prepared_time
string
prepared_user
string
started_time
string
started_user
string
done_time
string
done_user
string
status
string
consultation_item
string
usage_size
string
instructions
string
item
required
string
quantity
number
measurement_loss
number
archived
boolean
unit
required
string

Unit description from item settings

package_description
required
string

Package description from item settings

Responses

Request samples

Content type
application/json
{
  • "treatment_plan": "string",
  • "planned_time": "string",
  • "planned_user": "string",
  • "prepared_time": "string",
  • "prepared_user": "string",
  • "started_time": "string",
  • "started_user": "string",
  • "done_time": "string",
  • "done_user": "string",
  • "status": "string",
  • "consultation_item": "string",
  • "usage_size": "string",
  • "instructions": "string",
  • "item": "string",
  • "quantity": 0,
  • "measurement_loss": 0,
  • "archived": true,
  • "unit": "string",
  • "package_description": "string"
}

Partially update Medicine

Partially update Medicine

Patch allows updating quantity and usage_size.

Required permissions:

  • General: Can access / edit patients and clients
  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this treatment plan medicine.

Request Body schema: application/json
quantity
number
usage_size
string

Responses

Request samples

Content type
application/json
{
  • "quantity": 0,
  • "usage_size": "string"
}

Archive Medicine

Archive Medicine

Required permissions:

  • General: Can access / edit patients and clients
  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this treatment plan medicine.

Responses

Mark Medicine as done. Creates ConsultationItem automatically.

Mark Medicine as done. Creates ConsultationItem automatically.

Required permissions:

  • General: Can access / edit patients and clients
  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 100 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this treatment plan medicine.

Request Body schema: application/json
treatment_plan
required
string
planned_time
required
string
planned_user
string
prepared_time
string
prepared_user
string
started_time
string
started_user
string
done_time
string
done_user
string
status
string
consultation_item
string
usage_size
string
instructions
string
item
required
string
quantity
number
measurement_loss
number
archived
boolean
unit
required
string

Unit description from item settings

package_description
required
string

Package description from item settings

Responses

Request samples

Content type
application/json
{
  • "treatment_plan": "string",
  • "planned_time": "string",
  • "planned_user": "string",
  • "prepared_time": "string",
  • "prepared_user": "string",
  • "started_time": "string",
  • "started_user": "string",
  • "done_time": "string",
  • "done_user": "string",
  • "status": "string",
  • "consultation_item": "string",
  • "usage_size": "string",
  • "instructions": "string",
  • "item": "string",
  • "quantity": 0,
  • "measurement_loss": 0,
  • "archived": true,
  • "unit": "string",
  • "package_description": "string"
}

List Procedures

List Procedures

Required permissions:

  • General: Can access / edit patients and clients
  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Get Procedure by ID

Get Procedure by ID

Required permissions:

  • General: Can access / edit patients and clients
  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this treatment plan procedure.

Responses

Update Procedure

Update Procedure

Patch allows updating quantity.

Required permissions:

  • General: Can access / edit patients and clients
  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this treatment plan procedure.

Request Body schema: application/json
treatment_plan
required
string
planned_time
required
string
planned_user
string
prepared_time
string
prepared_user
string
started_time
string
started_user
string
done_time
string
done_user
string
status
string
consultation_item
string
instructions
string
item
required
string
quantity
number
description
string
archived
boolean

Responses

Request samples

Content type
application/json
{
  • "treatment_plan": "string",
  • "planned_time": "string",
  • "planned_user": "string",
  • "prepared_time": "string",
  • "prepared_user": "string",
  • "started_time": "string",
  • "started_user": "string",
  • "done_time": "string",
  • "done_user": "string",
  • "status": "string",
  • "consultation_item": "string",
  • "instructions": "string",
  • "item": "string",
  • "quantity": 0,
  • "description": "string",
  • "archived": true
}

Treatment Plan Procedures

Treatment Plan Procedures

Required permissions:

  • General: Can access / edit patients and clients
  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this treatment plan procedure.

Request Body schema: application/json
quantity
number

Responses

Request samples

Content type
application/json
{
  • "quantity": 0
}

Archive Procedure

Archive Procedure

Required permissions:

  • General: Can access / edit patients and clients
  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this treatment plan procedure.

Responses

Mark Procedure as done. Creates ConsultationItem automatically.

Mark Procedure as done. Creates ConsultationItem automatically.

Required permissions:

  • General: Can access / edit patients and clients
  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 100 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this treatment plan procedure.

Request Body schema: application/json
treatment_plan
required
string
planned_time
required
string
planned_user
string
prepared_time
string
prepared_user
string
started_time
string
started_user
string
done_time
string
done_user
string
status
string
consultation_item
string
instructions
string
item
required
string
quantity
number
description
string
archived
boolean

Responses

Request samples

Content type
application/json
{
  • "treatment_plan": "string",
  • "planned_time": "string",
  • "planned_user": "string",
  • "prepared_time": "string",
  • "prepared_user": "string",
  • "started_time": "string",
  • "started_user": "string",
  • "done_time": "string",
  • "done_user": "string",
  • "status": "string",
  • "consultation_item": "string",
  • "instructions": "string",
  • "item": "string",
  • "quantity": 0,
  • "description": "string",
  • "archived": true
}

List Supplies

List Supplies

Required permissions:

  • General: Can access / edit patients and clients
  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Get Supply by ID

Get Supply by ID

Required permissions:

  • General: Can access / edit patients and clients
  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this treatment plan supply.

Responses

Update Supply

Update Supply

Required permissions:

  • General: Can access / edit patients and clients
  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this treatment plan supply.

Request Body schema: application/json
treatment_plan
required
string
planned_time
required
string
planned_user
string
prepared_time
string
prepared_user
string
started_time
string
started_user
string
done_time
string
done_user
string
status
string
consultation_item
string
usage_size
string
instructions
string
item
required
string
quantity
number
archived
boolean
unit
required
string

Unit description from item settings

package_description
required
string

Package description from item settings

Responses

Request samples

Content type
application/json
{
  • "treatment_plan": "string",
  • "planned_time": "string",
  • "planned_user": "string",
  • "prepared_time": "string",
  • "prepared_user": "string",
  • "started_time": "string",
  • "started_user": "string",
  • "done_time": "string",
  • "done_user": "string",
  • "status": "string",
  • "consultation_item": "string",
  • "usage_size": "string",
  • "instructions": "string",
  • "item": "string",
  • "quantity": 0,
  • "archived": true,
  • "unit": "string",
  • "package_description": "string"
}

Partially update Supply

Partially update Supply

Patch allows updating quantity and usage_size.

Required permissions:

  • General: Can access / edit patients and clients
  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this treatment plan supply.

Request Body schema: application/json
quantity
number
usage_size
string

Responses

Request samples

Content type
application/json
{
  • "quantity": 0,
  • "usage_size": "string"
}

Archive Supply

Archive Supply

Required permissions:

  • General: Can access / edit patients and clients
  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this treatment plan supply.

Responses

Mark Supply as done. Creates ConsultationItem automatically.

Mark Supply as done. Creates ConsultationItem automatically.

Required permissions:

  • General: Can access / edit patients and clients
  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 100 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this treatment plan supply.

Request Body schema: application/json
treatment_plan
required
string
planned_time
required
string
planned_user
string
prepared_time
string
prepared_user
string
started_time
string
started_user
string
done_time
string
done_user
string
status
string
consultation_item
string
usage_size
string
instructions
string
item
required
string
quantity
number
archived
boolean
unit
required
string

Unit description from item settings

package_description
required
string

Package description from item settings

Responses

Request samples

Content type
application/json
{
  • "treatment_plan": "string",
  • "planned_time": "string",
  • "planned_user": "string",
  • "prepared_time": "string",
  • "prepared_user": "string",
  • "started_time": "string",
  • "started_user": "string",
  • "done_time": "string",
  • "done_user": "string",
  • "status": "string",
  • "consultation_item": "string",
  • "usage_size": "string",
  • "instructions": "string",
  • "item": "string",
  • "quantity": 0,
  • "archived": true,
  • "unit": "string",
  • "package_description": "string"
}

treatmentplanitem

All treatment plan items

All treatment plan items

Required permissions:

  • General: Can access / edit patients and clients
  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

All treatment plan items

All treatment plan items

Required permissions:

  • General: Can access / edit patients and clients
  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this treatment plan item.

Responses

All treatment plan items

All treatment plan items

Required permissions:

  • General: Can access / edit patients and clients
  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this treatment plan item.

Request Body schema: application/json
treatment_plan
required
string
planned_time
required
string
planned_user
string
prepared_time
string
prepared_user
string
started_time
string
started_user
string
done_time
string
done_user
string
status
string
consultation_item
string
instructions
string
archived
boolean

Responses

Request samples

Content type
application/json
{
  • "treatment_plan": "string",
  • "planned_time": "string",
  • "planned_user": "string",
  • "prepared_time": "string",
  • "prepared_user": "string",
  • "started_time": "string",
  • "started_user": "string",
  • "done_time": "string",
  • "done_user": "string",
  • "status": "string",
  • "consultation_item": "string",
  • "instructions": "string",
  • "archived": true
}

All treatment plan items

All treatment plan items

Required permissions:

  • General: Can access / edit patients and clients
  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this treatment plan item.

Request Body schema: application/json
treatment_plan
string
planned_time
string
planned_user
string
prepared_time
string
prepared_user
string
started_time
string
started_user
string
done_time
string
done_user
string
status
string
consultation_item
string
instructions
string
archived
boolean

Responses

Request samples

Content type
application/json
{
  • "treatment_plan": "string",
  • "planned_time": "string",
  • "planned_user": "string",
  • "prepared_time": "string",
  • "prepared_user": "string",
  • "started_time": "string",
  • "started_user": "string",
  • "done_time": "string",
  • "done_user": "string",
  • "status": "string",
  • "consultation_item": "string",
  • "instructions": "string",
  • "archived": true
}

All treatment plan items

All treatment plan items

Required permissions:

  • General: Can access / edit patients and clients
  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this treatment plan item.

Responses

Mark TreatmentPlanItem as done. Creates ConsultationItem automatically.

Mark TreatmentPlanItem as done. Creates ConsultationItem automatically.

Required permissions:

  • General: Can access / edit patients and clients
  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 100 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this treatment plan item.

Request Body schema: application/json
treatment_plan
required
string
planned_time
required
string
planned_user
string
prepared_time
string
prepared_user
string
started_time
string
started_user
string
done_time
string
done_user
string
status
string
consultation_item
string
instructions
string
archived
boolean

Responses

Request samples

Content type
application/json
{
  • "treatment_plan": "string",
  • "planned_time": "string",
  • "planned_user": "string",
  • "prepared_time": "string",
  • "prepared_user": "string",
  • "started_time": "string",
  • "started_user": "string",
  • "done_time": "string",
  • "done_user": "string",
  • "status": "string",
  • "consultation_item": "string",
  • "instructions": "string",
  • "archived": true
}

Triages

List Triages

List Triages

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Get Triage by ID

Get Triage by ID

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this triage.

Responses

List Categories

List Categories

Required permissions:

  • Settings: Can access / edit department settings

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Get Category by ID

Get Category by ID

Required permissions:

  • Settings: Can access / edit department settings

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this triage category.

Responses

List Entries

List Entries

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Get Entry by ID

Get Entry by ID

Required permissions:

  • General: Can access / edit consultations and its items

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this triage entry.

Responses

Unallocated payments

List Payments

List Payments

Required permissions:

  • Financial: Can access / edit invoices

This endpoint is rate-limited to 200 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Create new Payment

Create new Payment

Required permissions:

  • Financial: Can access / edit invoices

This endpoint is rate-limited to 300 requests per minute.

Request Body schema: application/json
department
required
string
description
string
payment_type
required
integer
paid
required
number
date_added
string
client
required
string
created_user
string
refunds
string
appointment
string

Responses

Request samples

Content type
application/json
{
  • "department": "string",
  • "description": "string",
  • "payment_type": 0,
  • "paid": 0,
  • "date_added": "string",
  • "client": "string",
  • "created_user": "string",
  • "refunds": "string",
  • "appointment": "string"
}

Get Payment by ID

Get Payment by ID

Required permissions:

  • Financial: Can access / edit invoices

This endpoint is rate-limited to 800 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this unallocated payment.

Responses

List External Infos

List External Infos

Required permissions:

  • Financial: Can access / edit invoices

This endpoint is rate-limited to 100 requests per minute.

path Parameters
parent_lookup_prepayment
required
string
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Create new External Info

Create new External Info

Required permissions:

  • Financial: Can access / edit invoices

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_prepayment
required
string
Request Body schema: application/json
external_id
required
string
metadata
string

Responses

Request samples

Content type
application/json
{
  • "external_id": "string",
  • "metadata": "string"
}

Get External Info by ID

Get External Info by ID

Required permissions:

  • Financial: Can access / edit invoices

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_prepayment
required
string
id
required
integer

A unique integer value identifying this unallocated payment external info.

Responses

Update External Info

Update External Info

Required permissions:

  • Financial: Can access / edit invoices

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_prepayment
required
string
id
required
integer

A unique integer value identifying this unallocated payment external info.

Request Body schema: application/json
external_id
required
string
metadata
string

Responses

Request samples

Content type
application/json
{
  • "external_id": "string",
  • "metadata": "string"
}

Partially update External Info

Partially update External Info

Required permissions:

  • Financial: Can access / edit invoices

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_prepayment
required
string
id
required
integer

A unique integer value identifying this unallocated payment external info.

Request Body schema: application/json
external_id
string
metadata
string

Responses

Request samples

Content type
application/json
{
  • "external_id": "string",
  • "metadata": "string"
}

Archive External Info

Archive External Info

Required permissions:

  • Financial: Can access / edit invoices

This endpoint is rate-limited to 300 requests per minute.

path Parameters
parent_lookup_prepayment
required
string
id
required
integer

A unique integer value identifying this unallocated payment external info.

Responses

Uploads

List Uploads

List Uploads

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Get Upload by ID

Get Upload by ID

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this upload.

Responses

Users

List Users

List Users

Required permissions:

  • Profile: Can access user profile page

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

ordering
string

Which field to use when ordering the results.

Responses

Create new User

Create new User

Required permissions:

  • Profile: Can access user profile page

This endpoint is rate-limited to 300 requests per minute.

Request Body schema: application/json
email
required
string

The email address is used to log in to Provet Cloud. This address may also be used in communication features of the system such as emailing and insurance claims. It is recommended to use a company-provided email instead of a personal email.

first_name
string
last_name
string
is_active
boolean

User can log in and is billable.

last_login
string
user_details
required
string
groups
Array of strings

The groups this user belongs to. A user will get all permissions granted to each of their groups.

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "is_active": true,
  • "last_login": "string",
  • "user_details": "string",
  • "groups": [
    ]
}

Get User by ID

Get User by ID

Required permissions:

  • Profile: Can access user profile page

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this user.

query Parameters
ordering
string

Which field to use when ordering the results.

Responses

Update User

Update User

Required permissions:

  • Profile: Can access user profile page

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this user.

query Parameters
ordering
string

Which field to use when ordering the results.

Request Body schema: application/json
email
required
string

The email address is used to log in to Provet Cloud. This address may also be used in communication features of the system such as emailing and insurance claims. It is recommended to use a company-provided email instead of a personal email.

first_name
string
last_name
string
is_active
boolean

User can log in and is billable.

last_login
string
user_details
required
string
groups
Array of strings

The groups this user belongs to. A user will get all permissions granted to each of their groups.

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "is_active": true,
  • "last_login": "string",
  • "user_details": "string",
  • "groups": [
    ]
}

Partially update User

Partially update User

Required permissions:

  • Profile: Can access user profile page

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this user.

query Parameters
ordering
string

Which field to use when ordering the results.

Request Body schema: application/json
email
string

The email address is used to log in to Provet Cloud. This address may also be used in communication features of the system such as emailing and insurance claims. It is recommended to use a company-provided email instead of a personal email.

first_name
string
last_name
string
is_active
boolean

User can log in and is billable.

last_login
string
user_details
string
groups
Array of strings

The groups this user belongs to. A user will get all permissions granted to each of their groups.

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "is_active": true,
  • "last_login": "string",
  • "user_details": "string",
  • "groups": [
    ]
}

List User Details

List User Details

User types:

  • Veterinarian = 1
  • Support staff = 2
  • Administrator = 3
  • Technical = 4

Required permissions:

  • Profile: Can access user profile page

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Create new User Details

Create new User Details

Required permissions:

  • Profile: Can access user profile page

This endpoint is rate-limited to 300 requests per minute.

Request Body schema: application/json
user
required
string
title
string
phone
string
veterinarian_id
string
active_department
required
string
initials
required
string
language
string
user_type
string
areas_of_expertise
string
qualifications
string
picture
string
prescriber_id
string
employee_number
string
vds_number
string
all_departments_active
boolean
active_departments
required
Array of strings
home_department
string
is_cabinet_user
boolean
verification
string
virtual_user
boolean

Responses

Request samples

Content type
application/json
{
  • "user": "string",
  • "title": "string",
  • "phone": "string",
  • "veterinarian_id": "string",
  • "active_department": "string",
  • "initials": "string",
  • "language": "string",
  • "user_type": "string",
  • "areas_of_expertise": "string",
  • "qualifications": "string",
  • "picture": "string",
  • "prescriber_id": "string",
  • "employee_number": "string",
  • "vds_number": "string",
  • "all_departments_active": true,
  • "active_departments": [
    ],
  • "home_department": "string",
  • "is_cabinet_user": true,
  • "verification": "string",
  • "virtual_user": true
}

Get User Details by ID

Get User Details by ID

Required permissions:

  • Profile: Can access user profile page

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this user details.

Responses

Update User Details

Update User Details

Required permissions:

  • Profile: Can access user profile page

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this user details.

Request Body schema: application/json
user
required
string
title
string
phone
string
veterinarian_id
string
active_department
required
string
initials
required
string
language
string
user_type
string
areas_of_expertise
string
qualifications
string
picture
string
prescriber_id
string
employee_number
string
vds_number
string
all_departments_active
boolean
active_departments
required
Array of strings
home_department
string
is_cabinet_user
boolean
verification
string
virtual_user
boolean

Responses

Request samples

Content type
application/json
{
  • "user": "string",
  • "title": "string",
  • "phone": "string",
  • "veterinarian_id": "string",
  • "active_department": "string",
  • "initials": "string",
  • "language": "string",
  • "user_type": "string",
  • "areas_of_expertise": "string",
  • "qualifications": "string",
  • "picture": "string",
  • "prescriber_id": "string",
  • "employee_number": "string",
  • "vds_number": "string",
  • "all_departments_active": true,
  • "active_departments": [
    ],
  • "home_department": "string",
  • "is_cabinet_user": true,
  • "verification": "string",
  • "virtual_user": true
}

Partially update User Details

Partially update User Details

Required permissions:

  • Profile: Can access user profile page

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this user details.

Request Body schema: application/json
user
string
title
string
phone
string
veterinarian_id
string
active_department
string
initials
string
language
string
user_type
string
areas_of_expertise
string
qualifications
string
picture
string
prescriber_id
string
employee_number
string
vds_number
string
all_departments_active
boolean
active_departments
Array of strings
home_department
string
is_cabinet_user
boolean
verification
string
virtual_user
boolean

Responses

Request samples

Content type
application/json
{
  • "user": "string",
  • "title": "string",
  • "phone": "string",
  • "veterinarian_id": "string",
  • "active_department": "string",
  • "initials": "string",
  • "language": "string",
  • "user_type": "string",
  • "areas_of_expertise": "string",
  • "qualifications": "string",
  • "picture": "string",
  • "prescriber_id": "string",
  • "employee_number": "string",
  • "vds_number": "string",
  • "all_departments_active": true,
  • "active_departments": [
    ],
  • "home_department": "string",
  • "is_cabinet_user": true,
  • "verification": "string",
  • "virtual_user": true
}

Archive User Details

Archive User Details

Required permissions:

  • Profile: Can access user profile page

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this user details.

Responses

List Groups

List Groups

Required permissions:

  • Profile: Can access user profile page

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Get Group by ID

Get Group by ID

Required permissions:

  • Profile: Can access user profile page

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this group.

Responses

VAT groups

List VAT Groups

List VAT Groups

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Get VAT Group by ID

Get VAT Group by ID

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this vat group.

Responses

Veterinarians availability

List Availability

List Availability

Required permissions:

  • Calendar: Can access / edit shifts

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

start
required
datetime
end
required
datetime
duration
required
integer
department_id
required
integer
available_to
datetime
treating_employees
integer | list
user_types
integer | list
reason
boolean
show_extra
boolean

Responses

Weight check

List Weight Checks

List Weight Checks

This endpoint is rate-limited to 100 requests per minute.

Responses

Create new Weight Check

Create new Weight Check

This endpoint is rate-limited to 100 requests per minute.

Responses

Wholesalers

List Wholesalers

List Wholesalers

Required permissions:

  • Settings: Can access / edit stock

This endpoint is rate-limited to 100 requests per minute.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Create new Wholesaler

Create new Wholesaler

Required permissions:

  • Settings: Can access / edit stock

This endpoint is rate-limited to 300 requests per minute.

Request Body schema: application/json
name
required
string
customer_number
string
vat_number
string
register_number
string
street_address
string
street_address_2
string
zip_code
string
city
string
email
string
phone_number
string
notes
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "customer_number": "string",
  • "vat_number": "string",
  • "register_number": "string",
  • "street_address": "string",
  • "street_address_2": "string",
  • "zip_code": "string",
  • "city": "string",
  • "email": "string",
  • "phone_number": "string",
  • "notes": "string"
}

Wholesalers

Wholesalers

Required permissions:

  • Settings: Can access / edit stock

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this wholesaler.

Responses

Update Wholesaler

Update Wholesaler

Required permissions:

  • Settings: Can access / edit stock

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this wholesaler.

Request Body schema: application/json
name
required
string
customer_number
string
vat_number
string
register_number
string
street_address
string
street_address_2
string
zip_code
string
city
string
email
string
phone_number
string
notes
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "customer_number": "string",
  • "vat_number": "string",
  • "register_number": "string",
  • "street_address": "string",
  • "street_address_2": "string",
  • "zip_code": "string",
  • "city": "string",
  • "email": "string",
  • "phone_number": "string",
  • "notes": "string"
}

Partially update Wholesaler

Partially update Wholesaler

Required permissions:

  • Settings: Can access / edit stock

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this wholesaler.

Request Body schema: application/json
name
string
customer_number
string
vat_number
string
register_number
string
street_address
string
street_address_2
string
zip_code
string
city
string
email
string
phone_number
string
notes
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "customer_number": "string",
  • "vat_number": "string",
  • "register_number": "string",
  • "street_address": "string",
  • "street_address_2": "string",
  • "zip_code": "string",
  • "city": "string",
  • "email": "string",
  • "phone_number": "string",
  • "notes": "string"
}

Archive Wholesaler

Archive Wholesaler

Required permissions:

  • Settings: Can access / edit stock

This endpoint is rate-limited to 300 requests per minute.

path Parameters
id
required
integer

A unique integer value identifying this wholesaler.

Responses