API docs by Redocly

Provet Cloud REST API Version 0.1

Download OpenAPI specification:Download

Alternative payers

List Alternative Payers

List Alternative Payers

Required permissions:

  • General: 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: 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: 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: 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: 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: 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

Client communication preference rows

List Client Communication Preference Rows

List Client Communication Preference Rows

Required permissions:

  • General: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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

Clients

List Clients

List Clients

Required permissions:

  • General: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: Patients and clients

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

Responses

Patients

Get latest ID of Patient

Get latest ID of Patient

Required permissions:

  • General: Patients and clients

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

Responses

List Patients

List Patients

Required permissions:

  • General: 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: 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: 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: 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: 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
microchip_date
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
stable_name
string
street_address
string
street_address_2
string
zip_code
string
city
string
private
boolean
visible_departments
Array of strings
visible_department_groups
Array of strings

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "color": "string",
  • "archived": true,
  • "species": "string",
  • "breed": "string",
  • "remarks": "string",
  • "microchip": "string",
  • "microchip_date": "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",
  • "stable_name": "string",
  • "street_address": "string",
  • "street_address_2": "string",
  • "zip_code": "string",
  • "city": "string",
  • "private": true,
  • "visible_departments": [
    ],
  • "visible_department_groups": [
    ]
}

Archives an item.

Archives an item.

Required permissions:

  • General: 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: 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: 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 Blood Pressures

List Blood Pressures

Required permissions:

  • General: 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 Blood Pressure

Create new Blood Pressure

Required permissions:

  • General: 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
blood_pressure_max
integer
blood_pressure_min
integer
body_position
string
timestamp
required
string
created_user
string
modified_user
string

Responses

Request samples

Content type
application/json
{
  • "blood_pressure_max": 0,
  • "blood_pressure_min": 0,
  • "body_position": "string",
  • "timestamp": "string",
  • "created_user": "string",
  • "modified_user": "string"
}

Get Blood Pressure by ID

Get Blood Pressure by ID

Required permissions:

  • General: 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 blood pressure.

Responses

Update Blood Pressure

Update Blood Pressure

Required permissions:

  • General: 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 blood pressure.

Request Body schema: application/json
blood_pressure_max
integer
blood_pressure_min
integer
body_position
string
timestamp
required
string
created_user
string
modified_user
string

Responses

Request samples

Content type
application/json
{
  • "blood_pressure_max": 0,
  • "blood_pressure_min": 0,
  • "body_position": "string",
  • "timestamp": "string",
  • "created_user": "string",
  • "modified_user": "string"
}

Partially update Blood Pressure

Partially update Blood Pressure

Required permissions:

  • General: 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 blood pressure.

Request Body schema: application/json
blood_pressure_max
integer
blood_pressure_min
integer
body_position
string
timestamp
string
created_user
string
modified_user
string

Responses

Request samples

Content type
application/json
{
  • "blood_pressure_max": 0,
  • "blood_pressure_min": 0,
  • "body_position": "string",
  • "timestamp": "string",
  • "created_user": "string",
  • "modified_user": "string"
}

Delete Blood Pressure

Delete Blood Pressure

Required permissions:

  • General: 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 blood pressure.

Responses

List Body Condition Scores

List Body Condition Scores

Required permissions:

  • General: 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 Body Condition Score

Create new Body Condition Score

Required permissions:

  • General: 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
body_condition_score
integer
timestamp
required
string
created_user
string
modified_user
string

Responses

Request samples

Content type
application/json
{
  • "body_condition_score": 0,
  • "timestamp": "string",
  • "created_user": "string",
  • "modified_user": "string"
}

Get Body Condition Score by ID

Get Body Condition Score by ID

Required permissions:

  • General: 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 body condition score.

Responses

Update Body Condition Score

Update Body Condition Score

Required permissions:

  • General: 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 body condition score.

Request Body schema: application/json
body_condition_score
integer
timestamp
required
string
created_user
string
modified_user
string

Responses

Request samples

Content type
application/json
{
  • "body_condition_score": 0,
  • "timestamp": "string",
  • "created_user": "string",
  • "modified_user": "string"
}

Partially update Body Condition Score

Partially update Body Condition Score

Required permissions:

  • General: 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 body condition score.

Request Body schema: application/json
body_condition_score
integer
timestamp
string
created_user
string
modified_user
string

Responses

Request samples

Content type
application/json
{
  • "body_condition_score": 0,
  • "timestamp": "string",
  • "created_user": "string",
  • "modified_user": "string"
}

Delete Body Condition Score

Delete Body Condition Score

Required permissions:

  • General: 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 body condition score.

Responses

List Consultations

List Consultations

Required permissions:

  • General: Patients and clients
  • General: 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: Patients and clients
  • General: 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: Patients and clients
  • General: 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: Patients and clients
  • General: 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: Patients and clients
  • General: 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: Patients and clients
  • General: 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: 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: 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: 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: 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: 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: 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: 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: 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
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: 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: 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
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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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"
}

Delete Heart Rate

Delete Heart Rate

Required permissions:

  • General: 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: 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: 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.

keep_html_markup
boolean

Set to 'true' to keep HTML markup in clinical notes and discharge instructions.

Responses

List Peripheral Oxygen Saturations

List Peripheral Oxygen Saturations

Required permissions:

  • General: 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: 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: 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: 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: 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"
}

Delete Peripheral Oxygen Saturation

Delete Peripheral Oxygen Saturation

Required permissions:

  • General: 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: 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: 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: 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: 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: 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"
}

Delete Respiratory Rate

Delete Respiratory Rate

Required permissions:

  • General: 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: 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: 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
required
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: 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: 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
required
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: 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"
}

Delete Temperature

Delete Temperature

Required permissions:

  • General: 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: 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: 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
required
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: 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: 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
required
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: 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"
}

Delete Weight

Delete Weight

Required permissions:

  • General: 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

Phone numbers

List Phone Numbers

List Phone Numbers

Required permissions:

  • General: 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: 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: 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: 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: 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: 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

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: 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: 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
send_externally
boolean
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",
  • "send_externally": true,
  • "sent_datetime": "string",
  • "phone_number": "string",
  • "email": "string",
  • "sms_text": "string"
}

Get Appointment Reminder by ID

Get Appointment Reminder by ID

Required permissions:

  • Calendar: 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: 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
send_externally
boolean
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",
  • "send_externally": true,
  • "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: 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
send_externally
boolean
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",
  • "send_externally": true,
  • "sent_datetime": "string",
  • "phone_number": "string",
  • "email": "string",
  • "sms_text": "string",
  • "sms_text_sent": "string"
}

Mark external sending for this appointment reminder

Mark external sending for this appointment reminder

Appointment reminder sending will not be triggered from Provet Cloud if set, instead external system is doing the sending and should use /mark_sent/ endpoint after sending is done.

Required permissions:

  • Calendar: Appointments

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

path Parameters
id
required
integer

A unique integer value identifying this appointment reminder.

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

Responses

Request samples

Content type
application/json
{
  • "type_code": "string",
  • "send_date": "string",
  • "send_datetime": "string",
  • "send_externally": true,
  • "sent_datetime": "string",
  • "phone_number": "string",
  • "email": "string",
  • "sms_text": "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: 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

Appointments

List Appointments

List Appointments

Type values:

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

Required permissions:

  • Calendar: 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: 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
holding_place_numbers
Array of strings

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,
  • "holding_place_numbers": [
    ]
}

Combined endpoint for fetching appointments by email

Combined endpoint for fetching appointments by email

This endpoint is accessed at /appointment/combined/?email=test@example.com &cutoff_date=2025-10-01 Returns all appointments for clients/onlinebookingclients matching the email.

There's three cases:

  • a) client, who booked with a patient (existing pet)
  • b) client, who booked with an onlinebookingpatient (new pet)
  • c) onlinebookingclient, who booked with an onlinebookingpatient

For online-booking, if auto-matching is enabled, the appointment might have both client and onlinebookingclient. However, client.email might be different than onlinebookingclient.email. Thefore we need to search with both.

Required permissions:

  • Calendar: Appointments

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

Responses

Get Appointment by ID

Get Appointment by ID

Required permissions:

  • Calendar: 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: 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
holding_place_numbers
Array of strings

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,
  • "holding_place_numbers": [
    ]
}

Partially update Appointment

Partially update Appointment

Required permissions:

  • Calendar: 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
holding_place_numbers
Array of strings

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,
  • "holding_place_numbers": [
    ]
}

Admit consultation from appointment

Admit consultation from appointment

Required permissions:

  • Calendar: 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
holding_place_numbers
Array of strings

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,
  • "holding_place_numbers": [
    ]
}

Cancel an appointment

Cancel an appointment

Required permissions:

  • Calendar: 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
holding_place_numbers
Array of strings

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,
  • "holding_place_numbers": [
    ]
}

Create advance payment

Create advance payment

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

Required permissions:

  • Calendar: 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
holding_place_numbers
Array of strings

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,
  • "holding_place_numbers": [
    ]
}

Create telemedicine room

Create telemedicine room

Create telemedicine room for the Appointment.

Required permissions:

  • Calendar: 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
holding_place_numbers
Array of strings

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,
  • "holding_place_numbers": [
    ]
}

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: 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
holding_place_numbers
Array of strings

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,
  • "holding_place_numbers": [
    ]
}

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: 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: 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: 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: 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: 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

Cancellation reasons

List Cancellation Reasons

List Cancellation Reasons

Required permissions:

  • Settings: 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: 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

Online booking

List Clients

List Clients

Required permissions:

  • Calendar: 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: 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
state
string
country_region
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",
  • "state": "string",
  • "country_region": "string",
  • "onlinebookingpatients": [
    ],
  • "id_number": "string"
}

Get Client by ID

Get Client by ID

Required permissions:

  • Calendar: 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: 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: 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
microchip
string
notes
string

Responses

Request samples

Content type
application/json
{
  • "onlinebookingclient": "string",
  • "name": "string",
  • "species": "string",
  • "breed": "string",
  • "microchip": "string",
  • "notes": "string"
}

Get Patient by ID

Get Patient by ID

Required permissions:

  • Calendar: 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

Preliminary bookings

List Bookings

List Bookings

Required permissions:

  • Calendar: 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: 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: Appointments

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

path Parameters
id
required
integer

A unique integer value identifying this appointment.

Responses

Resources

List Resources

List Resources

Required permissions:

  • Settings: 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: 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
web
boolean
sharing_departments
Array of strings
sharing_department_groups
Array of strings

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "initials": "string",
  • "is_active": true,
  • "department": "string",
  • "web": true,
  • "sharing_departments": [
    ],
  • "sharing_department_groups": [
    ]
}

Get Resource by ID

Get Resource by ID

Required permissions:

  • Settings: 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: 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
web
boolean
sharing_departments
Array of strings
sharing_department_groups
Array of strings

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "initials": "string",
  • "is_active": true,
  • "department": "string",
  • "web": true,
  • "sharing_departments": [
    ],
  • "sharing_department_groups": [
    ]
}

Partially update Resource

Partially update Resource

Required permissions:

  • Settings: 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
web
boolean
sharing_departments
Array of strings
sharing_department_groups
Array of strings

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "initials": "string",
  • "is_active": true,
  • "department": "string",
  • "web": true,
  • "sharing_departments": [
    ],
  • "sharing_department_groups": [
    ]
}

Shifts

List Shifts

List Shifts

error_code values:

  • SHIFT_ERROR_NON_BOOKABLE_TYPE = 1
  • SHIFT_ERROR_ORPHANED_APPOINTMENTS = 2

Required permissions:

  • Calendar: 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: 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
resources
Array of strings

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,
  • "resources": [
    ]
}

Get Shift by ID

Get Shift by ID

Required permissions:

  • Calendar: 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: 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
resources
Array of strings

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,
  • "resources": [
    ]
}

Partially update Shift

Partially update Shift

Required permissions:

  • Calendar: 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
resources
Array of strings

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,
  • "resources": [
    ]
}

Archive Shift

Archive Shift

Required permissions:

  • Calendar: 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: 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: 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: 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: 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: 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": [
    ]
}

Veterinarians availability

List Availability

List Availability

Required permissions:

  • Calendar: 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

Consultation antibiotics

List Antibiotics

List Antibiotics

Required permissions:

  • General: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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 items

List Analyses

List Analyses

Required permissions:

  • General: 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: 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: 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: 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: 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: 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: Items
  • General: 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: Items
  • General: 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: Items
  • General: 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: Items
  • General: 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: Items
  • General: 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: Items
  • General: 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: Items
  • General: 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: Items
  • General: 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
use_reason
string
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": [
    ],
  • "use_reason": "string",
  • "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: Items
  • General: 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: Items
  • General: 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
use_reason
string
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": [
    ],
  • "use_reason": "string",
  • "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: Items
  • General: 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
use_reason
string
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": [
    ],
  • "use_reason": "string",
  • "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: Items
  • General: 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: Items
  • General: 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
use_reason
string
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": [
    ],
  • "use_reason": "string",
  • "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: Items
  • General: 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: Items
  • General: 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: Items
  • General: 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: Items
  • General: 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: Items
  • General: 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: Items
  • General: 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: Items
  • General: 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: Items
  • General: 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: Items
  • General: 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: Items
  • General: 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: Items
  • General: 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: Items
  • General: 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

Administration methods mapping: - Category: Injection - Epidural= 3 - Intraarticular (IA)= 12 - Intracardiac (IC)= 13 - Intramuscular (IM)= 14 - Intraosseous (IO)= 16 - Intraperitoneal (IP)= 18 - Intravenous (IV)= 19 - Subcutaneous (SC)= 25 - Category: Infusion - Constant rate infusion (CRI)= 1 - In drip= 10 - Intraosseous drip (IO drip)= 17 - Intravenous drip (IV drip)= 20 - Subcutaneous drip (SC drip)= 26 - Category: Aural - In both ears= 7 - In right ear= 8 - In left ear= 9 - Category: Occular - In both eyes= 4 - In right eye= 5 - In left eye= 6 - Category: Oral - Peroral (PO)= 23 - Category: Nasal - Intranasal= 22 - Category: Other - According to instructions on the package= 2 - In feeding tube= 11 - Inhalation= 15 - Local= 21 - Intrarectal= 24 - Intravaginal= 29 - Intrauterine (IU)= 30 - Intramammary= 31 - Topical= 27 - Sublingual= 28

Required permissions:

  • General: 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: 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: 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: 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: 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: 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: 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: 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 organisms

List Organisms

List Organisms

Required permissions:

  • General: 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: 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: 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: 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: 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: 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

Consultation samples

List Samples

List Samples

Required permissions:

  • General: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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

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: 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: 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
referring_organization
string
referring_vet
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",
  • "referring_organization": "string",
  • "referring_vet": "string"
}

ViewSet for creating/updating Consultations

ViewSet for creating/updating Consultations

Required permissions:

  • General: 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
started
string
holding_place_number
Array of strings

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",
  • "started": "string",
  • "holding_place_number": [
    ]
}

ViewSet for creating/updating Consultations

ViewSet for creating/updating Consultations

Required permissions:

  • General: 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
started
string
holding_place_number
Array of strings

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",
  • "started": "string",
  • "holding_place_number": [
    ]
}

ViewSet for creating/updating Consultations

ViewSet for creating/updating Consultations

Required permissions:

  • General: 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
started
string
holding_place_number
Array of strings

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",
  • "started": "string",
  • "holding_place_number": [
    ]
}

Get Consultation by ID

Get Consultation by ID

Required permissions:

  • General: 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: 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
referring_organization
string
referring_vet
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",
  • "referring_organization": "string",
  • "referring_vet": "string"
}

Consultation

Consultation

Required permissions:

  • General: 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
referring_organization
string
referring_vet
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",
  • "referring_organization": "string",
  • "referring_vet": "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: 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: 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: 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: 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: 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: 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: 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: 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 started time.

Allow updating started time. Do not allow updating started if Consultation is not editable.

Required permissions:

  • General: 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
started
required
string

Responses

Request samples

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

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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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
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: 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: 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
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: 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: 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: 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: 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
blood_glucose
number
body_condition_score
required
string
central_venous_pressure
integer
blood_pressure
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
status_1_value
string
status_2_value
string
status_3_value
string
status_4_value
string
status_5_value
string
status_6_value
string
status_7_value
string
status_8_value
string
status_9_value
string
status_10_value
string
status_11_value
string
status_12_value
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",
  • "blood_glucose": 0,
  • "body_condition_score": "string",
  • "central_venous_pressure": 0,
  • "blood_pressure": "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",
  • "status_1_value": "string",
  • "status_2_value": "string",
  • "status_3_value": "string",
  • "status_4_value": "string",
  • "status_5_value": "string",
  • "status_6_value": "string",
  • "status_7_value": "string",
  • "status_8_value": "string",
  • "status_9_value": "string",
  • "status_10_value": "string",
  • "status_11_value": "string",
  • "status_12_value": "string",
  • "created_user": "string",
  • "modified_user": "string"
}

Get Patient Status by ID

Get Patient Status by ID

Required permissions:

  • General: 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: 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
blood_glucose
number
body_condition_score
required
string
central_venous_pressure
integer
blood_pressure
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
status_1_value
string
status_2_value
string
status_3_value
string
status_4_value
string
status_5_value
string
status_6_value
string
status_7_value
string
status_8_value
string
status_9_value
string
status_10_value
string
status_11_value
string
status_12_value
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",
  • "blood_glucose": 0,
  • "body_condition_score": "string",
  • "central_venous_pressure": 0,
  • "blood_pressure": "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",
  • "status_1_value": "string",
  • "status_2_value": "string",
  • "status_3_value": "string",
  • "status_4_value": "string",
  • "status_5_value": "string",
  • "status_6_value": "string",
  • "status_7_value": "string",
  • "status_8_value": "string",
  • "status_9_value": "string",
  • "status_10_value": "string",
  • "status_11_value": "string",
  • "status_12_value": "string",
  • "created_user": "string",
  • "modified_user": "string"
}

Partially update Patient Status

Partially update Patient Status

Required permissions:

  • General: 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
blood_glucose
number
body_condition_score
string
central_venous_pressure
integer
blood_pressure
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
status_1_value
string
status_2_value
string
status_3_value
string
status_4_value
string
status_5_value
string
status_6_value
string
status_7_value
string
status_8_value
string
status_9_value
string
status_10_value
string
status_11_value
string
status_12_value
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",
  • "blood_glucose": 0,
  • "body_condition_score": "string",
  • "central_venous_pressure": 0,
  • "blood_pressure": "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",
  • "status_1_value": "string",
  • "status_2_value": "string",
  • "status_3_value": "string",
  • "status_4_value": "string",
  • "status_5_value": "string",
  • "status_6_value": "string",
  • "status_7_value": "string",
  • "status_8_value": "string",
  • "status_9_value": "string",
  • "status_10_value": "string",
  • "status_11_value": "string",
  • "status_12_value": "string",
  • "created_user": "string",
  • "modified_user": "string"
}

Archive Patient Status

Archive Patient Status

Required permissions:

  • General: 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: 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: 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: 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: 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: 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: 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: Items
  • General: 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: Items
  • General: 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: Items
  • General: 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: Items
  • General: 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: Items
  • General: 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: Items
  • General: 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: Items
  • General: 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: Items
  • General: 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
use_reason
string
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": [
    ],
  • "use_reason": "string",
  • "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: Items
  • General: 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: Items
  • General: 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
use_reason
string
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": [
    ],
  • "use_reason": "string",
  • "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: Items
  • General: 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
use_reason
string
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": [
    ],
  • "use_reason": "string",
  • "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: Items
  • General: 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: Items
  • General: 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
use_reason
string
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": [
    ],
  • "use_reason": "string",
  • "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: Patients and clients
  • General: 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: Patients and clients
  • General: 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: Items
  • General: 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: Items
  • General: 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: Items
  • General: 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: Items
  • General: 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: Items
  • General: 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: Items
  • General: 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: Items
  • General: 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: Items
  • General: 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: Items
  • General: 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: Items
  • General: 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: Items
  • General: 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: Items
  • General: 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: Patients and clients
  • General: 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: Patients and clients
  • General: 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

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: 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: 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
referring_organization
string
referring_vet
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",
  • "referring_organization": "string",
  • "referring_vet": "string"
}

Get Consultation by ID

Get Consultation by ID

Required permissions:

  • General: 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: 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
referring_organization
string
referring_vet
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",
  • "referring_organization": "string",
  • "referring_vet": "string"
}

Consultation

Consultation

Required permissions:

  • General: 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
referring_organization
string
referring_vet
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",
  • "referring_organization": "string",
  • "referring_vet": "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: 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: 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: 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: 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: 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: 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: 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: 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 started time.

Allow updating started time. Do not allow updating started if Consultation is not editable.

Required permissions:

  • General: 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
started
required
string

Responses

Request samples

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

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: 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
}

Procedures

List Procedures

List Procedures

Required permissions:

  • Settings: 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: 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_commissions
boolean
no_department_rates
boolean
related_diagnoses_groups
Array of strings
conditional_price_overrides
Array of strings
tags
Array of strings
force_integer_quantity
boolean
duration
integer
internal_instructions
string
special_procedure
string
category
string
minimum_charge
number
minimum_charge_with_vat
number
minimum_dosage_units
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_commissions": true,
  • "no_department_rates": true,
  • "related_diagnoses_groups": [
    ],
  • "conditional_price_overrides": [
    ],
  • "tags": [
    ],
  • "force_integer_quantity": true,
  • "duration": 0,
  • "internal_instructions": "string",
  • "special_procedure": "string",
  • "category": "string",
  • "minimum_charge": 0,
  • "minimum_charge_with_vat": 0,
  • "minimum_dosage_units": 0
}

Get Procedure by ID

Get Procedure by ID

Required permissions:

  • Settings: 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: 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_commissions
boolean
no_department_rates
boolean
related_diagnoses_groups
Array of strings
conditional_price_overrides
Array of strings
tags
Array of strings
force_integer_quantity
boolean
duration
integer
internal_instructions
string
special_procedure
string
category
string
minimum_charge
number
minimum_charge_with_vat
number
minimum_dosage_units
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_commissions": true,
  • "no_department_rates": true,
  • "related_diagnoses_groups": [
    ],
  • "conditional_price_overrides": [
    ],
  • "tags": [
    ],
  • "force_integer_quantity": true,
  • "duration": 0,
  • "internal_instructions": "string",
  • "special_procedure": "string",
  • "category": "string",
  • "minimum_charge": 0,
  • "minimum_charge_with_vat": 0,
  • "minimum_dosage_units": 0
}

Partially update Procedure

Partially update Procedure

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

Required permissions:

  • Settings: 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_commissions
boolean
no_department_rates
boolean
related_diagnoses_groups
Array of strings
conditional_price_overrides
Array of strings
tags
Array of strings
force_integer_quantity
boolean
duration
integer
internal_instructions
string
special_procedure
string
category
string
minimum_charge
number
minimum_charge_with_vat
number
minimum_dosage_units
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_commissions": true,
  • "no_department_rates": true,
  • "related_diagnoses_groups": [
    ],
  • "conditional_price_overrides": [
    ],
  • "tags": [
    ],
  • "force_integer_quantity": true,
  • "duration": 0,
  • "internal_instructions": "string",
  • "special_procedure": "string",
  • "category": "string",
  • "minimum_charge": 0,
  • "minimum_charge_with_vat": 0,
  • "minimum_dosage_units": 0
}

Archives an item.

Archives an item.

Required permissions:

  • Settings: 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

Target areas

List Target Areas

List Target Areas

Required permissions:

  • Settings: 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: 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

Antibiotics

Get Antibiotics

Get Antibiotics

Required permissions:

  • Settings: 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: 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: 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: 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

Diagnostic imaging

List Referrals

List Referrals

Required permissions:

  • Diagnostic imaging: 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: 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
responsible_radiologist
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",
  • "responsible_radiologist": "string"
}

Get Referral by ID

Get Referral by ID

Required permissions:

  • Diagnostic imaging: 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: 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
responsible_radiologist
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",
  • "responsible_radiologist": "string"
}

Partially update Referral

Partially update Referral

Required permissions:

  • Diagnostic imaging: 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
responsible_radiologist
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",
  • "responsible_radiologist": "string"
}

Archive Referral

Archive Referral

Required permissions:

  • Diagnostic imaging: 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: 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: 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: 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: 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: 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: 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

Imaging categories

List Categories

List Categories

Required permissions:

  • Settings: 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: 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: 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: 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

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: 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: 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_commissions
boolean
no_department_rates
boolean
related_diagnoses_groups
Array of strings
conditional_price_overrides
Array of strings
tags
Array of strings
force_integer_quantity
boolean
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
minimum_dosage_units
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_commissions": true,
  • "no_department_rates": true,
  • "related_diagnoses_groups": [
    ],
  • "conditional_price_overrides": [
    ],
  • "tags": [
    ],
  • "force_integer_quantity": true,
  • "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,
  • "minimum_dosage_units": 0
}

Get Analysis by ID

Get Analysis by ID

Required permissions:

  • Settings: 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: 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_commissions
boolean
no_department_rates
boolean
related_diagnoses_groups
Array of strings
conditional_price_overrides
Array of strings
tags
Array of strings
force_integer_quantity
boolean
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
minimum_dosage_units
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_commissions": true,
  • "no_department_rates": true,
  • "related_diagnoses_groups": [
    ],
  • "conditional_price_overrides": [
    ],
  • "tags": [
    ],
  • "force_integer_quantity": true,
  • "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,
  • "minimum_dosage_units": 0
}

Partially update Analysis

Partially update Analysis

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

Required permissions:

  • Settings: 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_commissions
boolean
no_department_rates
boolean
related_diagnoses_groups
Array of strings
conditional_price_overrides
Array of strings
tags
Array of strings
force_integer_quantity
boolean
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
minimum_dosage_units
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_commissions": true,
  • "no_department_rates": true,
  • "related_diagnoses_groups": [
    ],
  • "conditional_price_overrides": [
    ],
  • "tags": [
    ],
  • "force_integer_quantity": true,
  • "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,
  • "minimum_dosage_units": 0
}

Archives an item.

Archives an item.

Required permissions:

  • Settings: 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: 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: 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: 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: 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: 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: 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: 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: 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_commissions
boolean
no_department_rates
boolean
related_diagnoses_groups
Array of strings
conditional_price_overrides
Array of strings
tags
Array of strings
force_integer_quantity
boolean
group
required
string
notes
string
analysis_method
string
internal_instructions
string
minimum_dosage_units
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_commissions": true,
  • "no_department_rates": true,
  • "related_diagnoses_groups": [
    ],
  • "conditional_price_overrides": [
    ],
  • "tags": [
    ],
  • "force_integer_quantity": true,
  • "group": "string",
  • "notes": "string",
  • "analysis_method": "string",
  • "internal_instructions": "string",
  • "minimum_dosage_units": 0
}

Get Panel by ID

Get Panel by ID

Required permissions:

  • Settings: 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: 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_commissions
boolean
no_department_rates
boolean
related_diagnoses_groups
Array of strings
conditional_price_overrides
Array of strings
tags
Array of strings
force_integer_quantity
boolean
group
required
string
notes
string
analysis_method
string
internal_instructions
string
minimum_dosage_units
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_commissions": true,
  • "no_department_rates": true,
  • "related_diagnoses_groups": [
    ],
  • "conditional_price_overrides": [
    ],
  • "tags": [
    ],
  • "force_integer_quantity": true,
  • "group": "string",
  • "notes": "string",
  • "analysis_method": "string",
  • "internal_instructions": "string",
  • "minimum_dosage_units": 0
}

Partially update Panel

Partially update Panel

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

Required permissions:

  • Settings: 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_commissions
boolean
no_department_rates
boolean
related_diagnoses_groups
Array of strings
conditional_price_overrides
Array of strings
tags
Array of strings
force_integer_quantity
boolean
group
string
notes
string
analysis_method
string
internal_instructions
string
minimum_dosage_units
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_commissions": true,
  • "no_department_rates": true,
  • "related_diagnoses_groups": [
    ],
  • "conditional_price_overrides": [
    ],
  • "tags": [
    ],
  • "force_integer_quantity": true,
  • "group": "string",
  • "notes": "string",
  • "analysis_method": "string",
  • "internal_instructions": "string",
  • "minimum_dosage_units": 0
}

Archives an item.

Archives an item.

Required permissions:

  • Settings: 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

Modality

List Modality

List Modality

Required permissions:

  • Settings: 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: 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

Organisms

List Organisms

List Organisms

Required permissions:

  • Settings: 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: Items

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

path Parameters
id
required
integer

A unique integer value identifying this organism.

Responses

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.

ordering
string

Which field to use when ordering the results.

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.

query Parameters
ordering
string

Which field to use when ordering the results.

Responses

List of Patient -> List of TreatmentPlanItem

List of Patient -> List of TreatmentPlanItem

Required permissions:

  • General: Patients and clients
  • General: Consultations and its items

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

path Parameters
parent_lookup_departments
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 Patient by ID

Get Patient by ID

Required permissions:

  • General: Patients and clients
  • General: 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

Patient - with treatment plans and active consultations - group by ward

Patient - with treatment plans and active consultations - group by ward

Required permissions:

  • General: Patients and clients
  • General: 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: Patients and clients
  • General: 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: Patients and clients
  • General: 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: Patients and clients
  • General: 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: Patients and clients
  • General: 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: Patients and clients
  • General: 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: Patients and clients
  • General: 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: Patients and clients
  • General: 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: Patients and clients
  • General: 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: Patients and clients
  • General: 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: Patients and clients
  • General: 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: Patients and clients
  • General: 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: Patients and clients
  • General: 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: Patients and clients
  • General: 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: Patients and clients
  • General: 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: Patients and clients
  • General: 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: Patients and clients
  • General: 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: Patients and clients
  • General: 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: Patients and clients
  • General: 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: Patients and clients
  • General: 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: Patients and clients
  • General: 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: Patients and clients
  • General: 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