Skip to content

AHDS Store API (1.0)

Animal Health Data Store - V1 API Documentation

Overview
Languages
Servers
Mock server

https://docs.heydonto.com/_mock/apis/animal-health/openapi/

Local Development

http://localhost:8083/

Address

Operations

Animal

Operations

Animal Colour

Operations

Appointment

Operations

Appointment Status

Operations

Appointment Type

Operations

Assessment

Operations

Attachment

Operations

Availability

Operations

Availability Slot

Operations

Barcode

Operations

Batch

Operations

Billing Credit

Operations

Billing Line

Operations

Booking

Operations

Breed

Operations

Communication

Operations

Consult

Operations

Create consult

Request

Creates a new Consult record. Consult resource in the Animal Health Data Store

Security
bearer
Path
siteIdnumberrequired

Site identifier

Bodyapplication/jsonrequired
animalIdstringrequired

Identifier of the animal this consult is for.

Example: "123e4567-e89b-12d3-a456-426614174000"
codestring

Practice-specific consult code or short identifier.

consultedAtstringrequired

Date and time when the consult occurred or is scheduled.

Example: "2025-01-01T00:00:00.000Z"
consultIdstringrequired

Canonical identifier for the consult.

Example: "123e4567-e89b-12d3-a456-426614174000"
descriptionstring

Free-text description or summary of the consult.

extensionsobject

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether the consult is currently active/open.

ownershipIdstring

Identifier for the ownership context (e.g., client account or business unit).

Example: "123e4567-e89b-12d3-a456-426614174000"
presentingProblemsArray of objects(PresentingProblemDto)

List of presenting problems associated with this consult.

referringClinicIdstring

Identifier of the referring clinic, if any.

Example: "123e4567-e89b-12d3-a456-426614174000"
referringVetContactIdstring

Identifier of the referring veterinarian contact, if any.

Example: "123e4567-e89b-12d3-a456-426614174000"
vetIdstringrequired

Identifier of the primary veterinarian responsible for the consult.

Example: "123e4567-e89b-12d3-a456-426614174000"
curl -i -X POST \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/consult' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "animalId": "123e4567-e89b-12d3-a456-426614174000",
    "code": "string",
    "consultedAt": "2025-01-01T00:00:00.000Z",
    "consultId": "123e4567-e89b-12d3-a456-426614174000",
    "description": "string",
    "extensions": {},
    "isActive": true,
    "ownershipId": "123e4567-e89b-12d3-a456-426614174000",
    "presentingProblems": [
      {
        "presentingProblemId": "123e4567-e89b-12d3-a456-426614174000"
      }
    ],
    "referringClinicId": "123e4567-e89b-12d3-a456-426614174000",
    "referringVetContactId": "123e4567-e89b-12d3-a456-426614174000",
    "vetId": "123e4567-e89b-12d3-a456-426614174000"
  }'

Responses

Consult created successfully

Bodyapplication/json
animalIdstringrequired

Identifier of the animal this consult is for.

Example: "123e4567-e89b-12d3-a456-426614174000"
codestringrequired

Practice-specific consult code or short identifier.

consultedAtstring(date-time)required

Date and time when the consult occurred or is scheduled.

Example: "2025-01-01T00:00:00.000Z"
consultIdstringrequired

Canonical identifier for the consult.

Example: "123e4567-e89b-12d3-a456-426614174000"
createdAtstring(date-time)required

Timestamp when the consult was created.

Example: "2025-01-01T00:00:00.000Z"
descriptionstringrequired

Free-text description or summary of the consult.

extensionsobjectrequired

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether the consult is currently active/open.

ownershipIdstringrequired

Identifier for the ownership context (e.g., client account or business unit).

Example: "123e4567-e89b-12d3-a456-426614174000"
presentingProblemsArray of objects(PresentingProblemDto)required

List of presenting problems associated with this consult.

presentingProblems[].​presentingProblemIdstringrequired

Identifier of the presenting problem.

Example: "123e4567-e89b-12d3-a456-426614174000"
referringClinicIdstringrequired

Identifier of the referring clinic, if any.

Example: "123e4567-e89b-12d3-a456-426614174000"
referringVetContactIdstringrequired

Identifier of the referring veterinarian contact, if any.

Example: "123e4567-e89b-12d3-a456-426614174000"
updatedAtstring(date-time)required

Timestamp when the consult was last modified.

Example: "2025-01-01T00:00:00.000Z"
vetIdstringrequired

Identifier of the primary veterinarian responsible for the consult.

Example: "123e4567-e89b-12d3-a456-426614174000"
Response
application/json
{
  "animalId": "123e4567-e89b-12d3-a456-426614174000",
  "code": "string",
  "consultedAt": "2025-01-01T00:00:00.000Z",
  "consultId": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "description": "string",
  "extensions": {},
  "isActive": true,
  "ownershipId": "123e4567-e89b-12d3-a456-426614174000",
  "presentingProblems": [
    { … }
  ],
  "referringClinicId": "123e4567-e89b-12d3-a456-426614174000",
  "referringVetContactId": "123e4567-e89b-12d3-a456-426614174000",
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "vetId": "123e4567-e89b-12d3-a456-426614174000"
}

List consults

Request

Returns a paginated list of Consults for the specified site. Supports filtering and sorting.

Security
bearer
Path
siteIdnumberrequired

Site identifier

Query
pagenumber>= 0

Page number (0-indexed)

Default 0
pageSizenumber[ 1 .. 100 ]

Number of items per page

Default 10
sortBystring

Field to sort by

Enum"createdAt""updatedAt""code""consultedAt""description"
sortOrderstring

Sort order

Default "asc"
Enum"asc""desc"
animalIdstring

Identifier of the animal this consult is for.

Example: animalId=123e4567-e89b-12d3-a456-426614174000
codestring

Practice-specific consult code or short identifier.

descriptionstring

Free-text description or summary of the consult.

isActiveboolean

Whether the consult is currently active/open.

ownershipIdstring

Identifier for the ownership context (e.g., client account or business unit).

Example: ownershipId=123e4567-e89b-12d3-a456-426614174000
referringClinicIdstring

Identifier of the referring clinic, if any.

Example: referringClinicId=123e4567-e89b-12d3-a456-426614174000
referringVetContactIdstring

Identifier of the referring veterinarian contact, if any.

Example: referringVetContactId=123e4567-e89b-12d3-a456-426614174000
vetIdstring

Identifier of the primary veterinarian responsible for the consult.

Example: vetId=123e4567-e89b-12d3-a456-426614174000
curl -i -X GET \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/consult?page=0&pageSize=10&sortBy=createdAt&sortOrder=asc&animalId=123e4567-e89b-12d3-a456-426614174000&code=string&description=string&isActive=true&ownershipId=123e4567-e89b-12d3-a456-426614174000&referringClinicId=123e4567-e89b-12d3-a456-426614174000&referringVetContactId=123e4567-e89b-12d3-a456-426614174000&vetId=123e4567-e89b-12d3-a456-426614174000' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Paginated list of Consults

Get consult

Request

Returns a single Consult by its unique identifier.

Security
bearer
Path
siteIdnumberrequired

Site identifier

consultIdstringrequired

Consult unique identifier (UUID)

curl -i -X GET \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/consult/{consultId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Consult found

Bodyapplication/json
animalIdstringrequired

Identifier of the animal this consult is for.

Example: "123e4567-e89b-12d3-a456-426614174000"
codestringrequired

Practice-specific consult code or short identifier.

consultedAtstring(date-time)required

Date and time when the consult occurred or is scheduled.

Example: "2025-01-01T00:00:00.000Z"
consultIdstringrequired

Canonical identifier for the consult.

Example: "123e4567-e89b-12d3-a456-426614174000"
createdAtstring(date-time)required

Timestamp when the consult was created.

Example: "2025-01-01T00:00:00.000Z"
descriptionstringrequired

Free-text description or summary of the consult.

extensionsobjectrequired

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether the consult is currently active/open.

ownershipIdstringrequired

Identifier for the ownership context (e.g., client account or business unit).

Example: "123e4567-e89b-12d3-a456-426614174000"
presentingProblemsArray of objects(PresentingProblemDto)required

List of presenting problems associated with this consult.

presentingProblems[].​presentingProblemIdstringrequired

Identifier of the presenting problem.

Example: "123e4567-e89b-12d3-a456-426614174000"
referringClinicIdstringrequired

Identifier of the referring clinic, if any.

Example: "123e4567-e89b-12d3-a456-426614174000"
referringVetContactIdstringrequired

Identifier of the referring veterinarian contact, if any.

Example: "123e4567-e89b-12d3-a456-426614174000"
updatedAtstring(date-time)required

Timestamp when the consult was last modified.

Example: "2025-01-01T00:00:00.000Z"
vetIdstringrequired

Identifier of the primary veterinarian responsible for the consult.

Example: "123e4567-e89b-12d3-a456-426614174000"
Response
application/json
{
  "animalId": "123e4567-e89b-12d3-a456-426614174000",
  "code": "string",
  "consultedAt": "2025-01-01T00:00:00.000Z",
  "consultId": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "description": "string",
  "extensions": {},
  "isActive": true,
  "ownershipId": "123e4567-e89b-12d3-a456-426614174000",
  "presentingProblems": [
    { … }
  ],
  "referringClinicId": "123e4567-e89b-12d3-a456-426614174000",
  "referringVetContactId": "123e4567-e89b-12d3-a456-426614174000",
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "vetId": "123e4567-e89b-12d3-a456-426614174000"
}

Update consult

Request

Partially updates an existing Consult. Only provided fields will be updated.

Security
bearer
Path
siteIdnumberrequired

Site identifier

consultIdstringrequired

Consult unique identifier (UUID)

Bodyapplication/jsonrequired
animalIdstring

Identifier of the animal this consult is for.

Example: "123e4567-e89b-12d3-a456-426614174000"
codestring

Practice-specific consult code or short identifier.

consultedAtstring

Date and time when the consult occurred or is scheduled.

Example: "2025-01-01T00:00:00.000Z"
descriptionstring

Free-text description or summary of the consult.

extensionsobject

Vendor- or practice-specific extensions.

isActiveboolean

Whether the consult is currently active/open.

ownershipIdstring

Identifier for the ownership context (e.g., client account or business unit).

Example: "123e4567-e89b-12d3-a456-426614174000"
presentingProblemsArray of objects(PresentingProblemDto)

List of presenting problems associated with this consult.

referringClinicIdstring

Identifier of the referring clinic, if any.

Example: "123e4567-e89b-12d3-a456-426614174000"
referringVetContactIdstring

Identifier of the referring veterinarian contact, if any.

Example: "123e4567-e89b-12d3-a456-426614174000"
vetIdstring

Identifier of the primary veterinarian responsible for the consult.

Example: "123e4567-e89b-12d3-a456-426614174000"
curl -i -X PATCH \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/consult/{consultId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "animalId": "123e4567-e89b-12d3-a456-426614174000",
    "code": "string",
    "consultedAt": "2025-01-01T00:00:00.000Z",
    "description": "string",
    "extensions": {},
    "isActive": true,
    "ownershipId": "123e4567-e89b-12d3-a456-426614174000",
    "presentingProblems": [
      {
        "presentingProblemId": "123e4567-e89b-12d3-a456-426614174000"
      }
    ],
    "referringClinicId": "123e4567-e89b-12d3-a456-426614174000",
    "referringVetContactId": "123e4567-e89b-12d3-a456-426614174000",
    "vetId": "123e4567-e89b-12d3-a456-426614174000"
  }'

Responses

Consult updated successfully

Bodyapplication/json
animalIdstringrequired

Identifier of the animal this consult is for.

Example: "123e4567-e89b-12d3-a456-426614174000"
codestringrequired

Practice-specific consult code or short identifier.

consultedAtstring(date-time)required

Date and time when the consult occurred or is scheduled.

Example: "2025-01-01T00:00:00.000Z"
consultIdstringrequired

Canonical identifier for the consult.

Example: "123e4567-e89b-12d3-a456-426614174000"
createdAtstring(date-time)required

Timestamp when the consult was created.

Example: "2025-01-01T00:00:00.000Z"
descriptionstringrequired

Free-text description or summary of the consult.

extensionsobjectrequired

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether the consult is currently active/open.

ownershipIdstringrequired

Identifier for the ownership context (e.g., client account or business unit).

Example: "123e4567-e89b-12d3-a456-426614174000"
presentingProblemsArray of objects(PresentingProblemDto)required

List of presenting problems associated with this consult.

presentingProblems[].​presentingProblemIdstringrequired

Identifier of the presenting problem.

Example: "123e4567-e89b-12d3-a456-426614174000"
referringClinicIdstringrequired

Identifier of the referring clinic, if any.

Example: "123e4567-e89b-12d3-a456-426614174000"
referringVetContactIdstringrequired

Identifier of the referring veterinarian contact, if any.

Example: "123e4567-e89b-12d3-a456-426614174000"
updatedAtstring(date-time)required

Timestamp when the consult was last modified.

Example: "2025-01-01T00:00:00.000Z"
vetIdstringrequired

Identifier of the primary veterinarian responsible for the consult.

Example: "123e4567-e89b-12d3-a456-426614174000"
Response
application/json
{
  "animalId": "123e4567-e89b-12d3-a456-426614174000",
  "code": "string",
  "consultedAt": "2025-01-01T00:00:00.000Z",
  "consultId": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "description": "string",
  "extensions": {},
  "isActive": true,
  "ownershipId": "123e4567-e89b-12d3-a456-426614174000",
  "presentingProblems": [
    { … }
  ],
  "referringClinicId": "123e4567-e89b-12d3-a456-426614174000",
  "referringVetContactId": "123e4567-e89b-12d3-a456-426614174000",
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "vetId": "123e4567-e89b-12d3-a456-426614174000"
}

Replace consult

Request

Fully replaces an existing Consult. All fields must be provided.

Security
bearer
Path
siteIdnumberrequired

Site identifier

consultIdstringrequired

Consult unique identifier (UUID)

Bodyapplication/jsonrequired
animalIdstringrequired

Identifier of the animal this consult is for.

Example: "123e4567-e89b-12d3-a456-426614174000"
codestringrequired

Practice-specific consult code or short identifier.

consultedAtstringrequired

Date and time when the consult occurred or is scheduled.

Example: "2025-01-01T00:00:00.000Z"
descriptionstringrequired

Free-text description or summary of the consult.

extensionsobjectrequired

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether the consult is currently active/open.

ownershipIdstringrequired

Identifier for the ownership context (e.g., client account or business unit).

Example: "123e4567-e89b-12d3-a456-426614174000"
presentingProblemsArray of objects(PresentingProblemDto)required

List of presenting problems associated with this consult.

presentingProblems[].​presentingProblemIdstringrequired

Identifier of the presenting problem.

Example: "123e4567-e89b-12d3-a456-426614174000"
referringClinicIdstringrequired

Identifier of the referring clinic, if any.

Example: "123e4567-e89b-12d3-a456-426614174000"
referringVetContactIdstringrequired

Identifier of the referring veterinarian contact, if any.

Example: "123e4567-e89b-12d3-a456-426614174000"
vetIdstringrequired

Identifier of the primary veterinarian responsible for the consult.

Example: "123e4567-e89b-12d3-a456-426614174000"
curl -i -X PUT \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/consult/{consultId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "animalId": "123e4567-e89b-12d3-a456-426614174000",
    "code": "string",
    "consultedAt": "2025-01-01T00:00:00.000Z",
    "description": "string",
    "extensions": {},
    "isActive": true,
    "ownershipId": "123e4567-e89b-12d3-a456-426614174000",
    "presentingProblems": [
      {
        "presentingProblemId": "123e4567-e89b-12d3-a456-426614174000"
      }
    ],
    "referringClinicId": "123e4567-e89b-12d3-a456-426614174000",
    "referringVetContactId": "123e4567-e89b-12d3-a456-426614174000",
    "vetId": "123e4567-e89b-12d3-a456-426614174000"
  }'

Responses

Consult replaced successfully

Bodyapplication/json
animalIdstringrequired

Identifier of the animal this consult is for.

Example: "123e4567-e89b-12d3-a456-426614174000"
codestringrequired

Practice-specific consult code or short identifier.

consultedAtstring(date-time)required

Date and time when the consult occurred or is scheduled.

Example: "2025-01-01T00:00:00.000Z"
consultIdstringrequired

Canonical identifier for the consult.

Example: "123e4567-e89b-12d3-a456-426614174000"
createdAtstring(date-time)required

Timestamp when the consult was created.

Example: "2025-01-01T00:00:00.000Z"
descriptionstringrequired

Free-text description or summary of the consult.

extensionsobjectrequired

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether the consult is currently active/open.

ownershipIdstringrequired

Identifier for the ownership context (e.g., client account or business unit).

Example: "123e4567-e89b-12d3-a456-426614174000"
presentingProblemsArray of objects(PresentingProblemDto)required

List of presenting problems associated with this consult.

presentingProblems[].​presentingProblemIdstringrequired

Identifier of the presenting problem.

Example: "123e4567-e89b-12d3-a456-426614174000"
referringClinicIdstringrequired

Identifier of the referring clinic, if any.

Example: "123e4567-e89b-12d3-a456-426614174000"
referringVetContactIdstringrequired

Identifier of the referring veterinarian contact, if any.

Example: "123e4567-e89b-12d3-a456-426614174000"
updatedAtstring(date-time)required

Timestamp when the consult was last modified.

Example: "2025-01-01T00:00:00.000Z"
vetIdstringrequired

Identifier of the primary veterinarian responsible for the consult.

Example: "123e4567-e89b-12d3-a456-426614174000"
Response
application/json
{
  "animalId": "123e4567-e89b-12d3-a456-426614174000",
  "code": "string",
  "consultedAt": "2025-01-01T00:00:00.000Z",
  "consultId": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "description": "string",
  "extensions": {},
  "isActive": true,
  "ownershipId": "123e4567-e89b-12d3-a456-426614174000",
  "presentingProblems": [
    { … }
  ],
  "referringClinicId": "123e4567-e89b-12d3-a456-426614174000",
  "referringVetContactId": "123e4567-e89b-12d3-a456-426614174000",
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "vetId": "123e4567-e89b-12d3-a456-426614174000"
}

Delete consult

Request

Permanently deletes a Consult record.

Security
bearer
Path
siteIdnumberrequired

Site identifier

consultIdstringrequired

Consult unique identifier (UUID)

curl -i -X DELETE \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/consult/{consultId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Consult deleted successfully

Contact

Operations

Contact Association

Operations

Contact Detail

Operations

Country

Operations

Diagnostic

Operations

Diagnostic Code

Operations

Diagnostic Request

Operations

Diagnostic Result

Operations

Diagnostic Result Item

Operations

Estimate

Operations

Eventgroup

Operations

External Prescription

Operations

Facility

Operations

File

Operations

File Upload

Operations

Health Status

Operations

Herd

Operations

History

Operations

Insurance

Operations

Integrated Diagnostic

Operations

Inventory Message

Operations

Inventory Product

Operations

Inventory Requirement

Operations

Inventory Supplied Product

Operations

Invoice

Operations

Invoiceline

Operations

Ledger Account

Operations

Linked Payment

Operations

Location

Operations

Message

Operations

Modality

Operations

Operation

Operations

Payment

Operations

Paymentmethod

Operations

Physical Exam

Operations

Plan

Operations

Practitioner

Operations

Prescription

Operations

Prescription Item

Operations

Presentingproblem

Operations

Price Adjustment

Operations

Product

Operations

Product Minimum Stock

Operations

Product Pricing

Operations

Product Supplier

Operations

Productgroup

Operations

Purchaseorder

Operations

Purchaseorderitem

Operations

Receive Invoice

Operations

Receive Invoice Item

Operations

Requisition Form

Operations

Resource

Operations

Separation

Operations

Sex

Operations

Shelter Animal Booking

Operations

Site Information

Operations

Species

Operations

Standard Diagnostic Lab Report

Operations

Standardofcare

Operations

Stock Adjustment

Operations

Stock Adjustment Item

Operations

Stock Transaction

Operations

Supplied

Operations

System Setting

Operations

Tag

Operations

Tagcategory

Operations

Tagname

Operations

Taxrate

Operations

Template

Operations

Therapeutic

Operations

Transaction

Operations

User

Operations

Vaccination

Operations

Webhook

Operations

Webhook Event

Operations

Wellness Resource

Operations

With Primary Inventory Location

Operations