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

Create booking

Request

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

Security
bearer
Path
siteIdnumberrequired

Site identifier

Bodyapplication/jsonrequired
additionalResourceIdsArray of strings

Identifiers of additional resources associated with this booking.

animalIdstringrequired

Identifier of the animal for this booking.

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

Identifier of the underlying appointment record, if modeled separately.

Example: "123e4567-e89b-12d3-a456-426614174000"
appointmentTypeobjectrequired
appointmentType.​codestringrequired

Code value

appointmentType.​systemstringrequired

Code system URI

appointmentType.​displaystring

Human-readable display

bookingIdstringrequired

Canonical booking identifier.

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

Identifier of the primary contact (e.g., owner) for this booking.

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

Free-text description or reason for the appointment.

durationMinutesnumber

Scheduled duration in minutes.

extensionsobject

Vendor- or practice-specific extensions.

providerIdstringrequired

Identifier of the primary provider/resource for this booking.

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

Appointment start time in RFC 3339 format with timezone offset.

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

Current booking status.

Enum"no_status""confirmed""unconfirmed"
curl -i -X POST \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/booking' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "additionalResourceIds": [
      "string"
    ],
    "animalId": "123e4567-e89b-12d3-a456-426614174000",
    "appointmentId": "123e4567-e89b-12d3-a456-426614174000",
    "appointmentType": {
      "code": "string",
      "system": "string",
      "display": "string"
    },
    "bookingId": "123e4567-e89b-12d3-a456-426614174000",
    "contactId": "123e4567-e89b-12d3-a456-426614174000",
    "description": "string",
    "durationMinutes": 0,
    "extensions": {},
    "providerId": "123e4567-e89b-12d3-a456-426614174000",
    "startsAt": "2025-01-01T00:00:00.000Z",
    "status": "no_status"
  }'

Responses

Booking created successfully

Bodyapplication/json
additionalResourceIdsArray of stringsrequired

Identifiers of additional resources associated with this booking.

animalIdstringrequired

Identifier of the animal for this booking.

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

Identifier of the underlying appointment record, if modeled separately.

Example: "123e4567-e89b-12d3-a456-426614174000"
appointmentTypeobjectrequired
appointmentType.​codestringrequired

Code value

appointmentType.​systemstringrequired

Code system URI

appointmentType.​displaystring

Human-readable display

bookingIdstringrequired

Canonical booking identifier.

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

Identifier of the primary contact (e.g., owner) for this booking.

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

Timestamp when the booking was created.

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

Free-text description or reason for the appointment.

durationMinutesnumberrequired

Scheduled duration in minutes.

extensionsobjectrequired

Vendor- or practice-specific extensions.

providerIdstringrequired

Identifier of the primary provider/resource for this booking.

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

Appointment start time in RFC 3339 format with timezone offset.

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

Current booking status.

Enum"no_status""confirmed""unconfirmed"
updatedAtstring(date-time)required

Timestamp when the booking was last updated.

Example: "2025-01-01T00:00:00.000Z"
Response
application/json
{
  "additionalResourceIds": [
    "string"
  ],
  "animalId": "123e4567-e89b-12d3-a456-426614174000",
  "appointmentId": "123e4567-e89b-12d3-a456-426614174000",
  "appointmentType": {
    "code": "string",
    "system": "string",
    "display": "string"
  },
  "bookingId": "123e4567-e89b-12d3-a456-426614174000",
  "contactId": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "description": "string",
  "durationMinutes": 0,
  "extensions": {},
  "providerId": "123e4567-e89b-12d3-a456-426614174000",
  "startsAt": "2025-01-01T00:00:00.000Z",
  "status": "no_status",
  "updatedAt": "2025-01-01T00:00:00.000Z"
}

List bookings

Request

Returns a paginated list of Bookings 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""description""durationMinutes""startsAt"
sortOrderstring

Sort order

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

Identifier of the animal for this booking.

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

Identifier of the underlying appointment record, if modeled separately.

Example: appointmentId=123e4567-e89b-12d3-a456-426614174000
contactIdstring

Identifier of the primary contact (e.g., owner) for this booking.

Example: contactId=123e4567-e89b-12d3-a456-426614174000
descriptionstring

Free-text description or reason for the appointment.

providerIdstring

Identifier of the primary provider/resource for this booking.

Example: providerId=123e4567-e89b-12d3-a456-426614174000
statusstring

Current booking status.

Enum"no_status""confirmed""unconfirmed"
curl -i -X GET \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/booking?page=0&pageSize=10&sortBy=createdAt&sortOrder=asc&animalId=123e4567-e89b-12d3-a456-426614174000&appointmentId=123e4567-e89b-12d3-a456-426614174000&contactId=123e4567-e89b-12d3-a456-426614174000&description=string&providerId=123e4567-e89b-12d3-a456-426614174000&status=no_status' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Paginated list of Bookings

Get booking

Request

Returns a single Booking by its unique identifier.

Security
bearer
Path
siteIdnumberrequired

Site identifier

bookingIdstringrequired

Booking unique identifier (UUID)

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

Responses

Booking found

Bodyapplication/json
additionalResourceIdsArray of stringsrequired

Identifiers of additional resources associated with this booking.

animalIdstringrequired

Identifier of the animal for this booking.

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

Identifier of the underlying appointment record, if modeled separately.

Example: "123e4567-e89b-12d3-a456-426614174000"
appointmentTypeobjectrequired
appointmentType.​codestringrequired

Code value

appointmentType.​systemstringrequired

Code system URI

appointmentType.​displaystring

Human-readable display

bookingIdstringrequired

Canonical booking identifier.

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

Identifier of the primary contact (e.g., owner) for this booking.

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

Timestamp when the booking was created.

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

Free-text description or reason for the appointment.

durationMinutesnumberrequired

Scheduled duration in minutes.

extensionsobjectrequired

Vendor- or practice-specific extensions.

providerIdstringrequired

Identifier of the primary provider/resource for this booking.

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

Appointment start time in RFC 3339 format with timezone offset.

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

Current booking status.

Enum"no_status""confirmed""unconfirmed"
updatedAtstring(date-time)required

Timestamp when the booking was last updated.

Example: "2025-01-01T00:00:00.000Z"
Response
application/json
{
  "additionalResourceIds": [
    "string"
  ],
  "animalId": "123e4567-e89b-12d3-a456-426614174000",
  "appointmentId": "123e4567-e89b-12d3-a456-426614174000",
  "appointmentType": {
    "code": "string",
    "system": "string",
    "display": "string"
  },
  "bookingId": "123e4567-e89b-12d3-a456-426614174000",
  "contactId": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "description": "string",
  "durationMinutes": 0,
  "extensions": {},
  "providerId": "123e4567-e89b-12d3-a456-426614174000",
  "startsAt": "2025-01-01T00:00:00.000Z",
  "status": "no_status",
  "updatedAt": "2025-01-01T00:00:00.000Z"
}

Update booking

Request

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

Security
bearer
Path
siteIdnumberrequired

Site identifier

bookingIdstringrequired

Booking unique identifier (UUID)

Bodyapplication/jsonrequired
additionalResourceIdsArray of strings

Identifiers of additional resources associated with this booking.

animalIdstring

Identifier of the animal for this booking.

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

Identifier of the underlying appointment record, if modeled separately.

Example: "123e4567-e89b-12d3-a456-426614174000"
appointmentTypeobject
contactIdstring

Identifier of the primary contact (e.g., owner) for this booking.

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

Free-text description or reason for the appointment.

durationMinutesnumber

Scheduled duration in minutes.

extensionsobject

Vendor- or practice-specific extensions.

providerIdstring

Identifier of the primary provider/resource for this booking.

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

Appointment start time in RFC 3339 format with timezone offset.

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

Current booking status.

Enum"no_status""confirmed""unconfirmed"
curl -i -X PATCH \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/booking/{bookingId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "additionalResourceIds": [
      "string"
    ],
    "animalId": "123e4567-e89b-12d3-a456-426614174000",
    "appointmentId": "123e4567-e89b-12d3-a456-426614174000",
    "appointmentType": {
      "code": "string",
      "system": "string",
      "display": "string"
    },
    "contactId": "123e4567-e89b-12d3-a456-426614174000",
    "description": "string",
    "durationMinutes": 0,
    "extensions": {},
    "providerId": "123e4567-e89b-12d3-a456-426614174000",
    "startsAt": "2025-01-01T00:00:00.000Z",
    "status": "no_status"
  }'

Responses

Booking updated successfully

Bodyapplication/json
additionalResourceIdsArray of stringsrequired

Identifiers of additional resources associated with this booking.

animalIdstringrequired

Identifier of the animal for this booking.

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

Identifier of the underlying appointment record, if modeled separately.

Example: "123e4567-e89b-12d3-a456-426614174000"
appointmentTypeobjectrequired
appointmentType.​codestringrequired

Code value

appointmentType.​systemstringrequired

Code system URI

appointmentType.​displaystring

Human-readable display

bookingIdstringrequired

Canonical booking identifier.

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

Identifier of the primary contact (e.g., owner) for this booking.

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

Timestamp when the booking was created.

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

Free-text description or reason for the appointment.

durationMinutesnumberrequired

Scheduled duration in minutes.

extensionsobjectrequired

Vendor- or practice-specific extensions.

providerIdstringrequired

Identifier of the primary provider/resource for this booking.

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

Appointment start time in RFC 3339 format with timezone offset.

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

Current booking status.

Enum"no_status""confirmed""unconfirmed"
updatedAtstring(date-time)required

Timestamp when the booking was last updated.

Example: "2025-01-01T00:00:00.000Z"
Response
application/json
{
  "additionalResourceIds": [
    "string"
  ],
  "animalId": "123e4567-e89b-12d3-a456-426614174000",
  "appointmentId": "123e4567-e89b-12d3-a456-426614174000",
  "appointmentType": {
    "code": "string",
    "system": "string",
    "display": "string"
  },
  "bookingId": "123e4567-e89b-12d3-a456-426614174000",
  "contactId": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "description": "string",
  "durationMinutes": 0,
  "extensions": {},
  "providerId": "123e4567-e89b-12d3-a456-426614174000",
  "startsAt": "2025-01-01T00:00:00.000Z",
  "status": "no_status",
  "updatedAt": "2025-01-01T00:00:00.000Z"
}

Replace booking

Request

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

Security
bearer
Path
siteIdnumberrequired

Site identifier

bookingIdstringrequired

Booking unique identifier (UUID)

Bodyapplication/jsonrequired
additionalResourceIdsArray of stringsrequired

Identifiers of additional resources associated with this booking.

animalIdstringrequired

Identifier of the animal for this booking.

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

Identifier of the underlying appointment record, if modeled separately.

Example: "123e4567-e89b-12d3-a456-426614174000"
appointmentTypeobjectrequired
appointmentType.​codestringrequired

Code value

appointmentType.​systemstringrequired

Code system URI

appointmentType.​displaystring

Human-readable display

contactIdstringrequired

Identifier of the primary contact (e.g., owner) for this booking.

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

Free-text description or reason for the appointment.

durationMinutesnumberrequired

Scheduled duration in minutes.

extensionsobjectrequired

Vendor- or practice-specific extensions.

providerIdstringrequired

Identifier of the primary provider/resource for this booking.

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

Appointment start time in RFC 3339 format with timezone offset.

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

Current booking status.

Enum"no_status""confirmed""unconfirmed"
curl -i -X PUT \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/booking/{bookingId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "additionalResourceIds": [
      "string"
    ],
    "animalId": "123e4567-e89b-12d3-a456-426614174000",
    "appointmentId": "123e4567-e89b-12d3-a456-426614174000",
    "appointmentType": {
      "code": "string",
      "system": "string",
      "display": "string"
    },
    "contactId": "123e4567-e89b-12d3-a456-426614174000",
    "description": "string",
    "durationMinutes": 0,
    "extensions": {},
    "providerId": "123e4567-e89b-12d3-a456-426614174000",
    "startsAt": "2025-01-01T00:00:00.000Z",
    "status": "no_status"
  }'

Responses

Booking replaced successfully

Bodyapplication/json
additionalResourceIdsArray of stringsrequired

Identifiers of additional resources associated with this booking.

animalIdstringrequired

Identifier of the animal for this booking.

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

Identifier of the underlying appointment record, if modeled separately.

Example: "123e4567-e89b-12d3-a456-426614174000"
appointmentTypeobjectrequired
appointmentType.​codestringrequired

Code value

appointmentType.​systemstringrequired

Code system URI

appointmentType.​displaystring

Human-readable display

bookingIdstringrequired

Canonical booking identifier.

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

Identifier of the primary contact (e.g., owner) for this booking.

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

Timestamp when the booking was created.

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

Free-text description or reason for the appointment.

durationMinutesnumberrequired

Scheduled duration in minutes.

extensionsobjectrequired

Vendor- or practice-specific extensions.

providerIdstringrequired

Identifier of the primary provider/resource for this booking.

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

Appointment start time in RFC 3339 format with timezone offset.

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

Current booking status.

Enum"no_status""confirmed""unconfirmed"
updatedAtstring(date-time)required

Timestamp when the booking was last updated.

Example: "2025-01-01T00:00:00.000Z"
Response
application/json
{
  "additionalResourceIds": [
    "string"
  ],
  "animalId": "123e4567-e89b-12d3-a456-426614174000",
  "appointmentId": "123e4567-e89b-12d3-a456-426614174000",
  "appointmentType": {
    "code": "string",
    "system": "string",
    "display": "string"
  },
  "bookingId": "123e4567-e89b-12d3-a456-426614174000",
  "contactId": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "description": "string",
  "durationMinutes": 0,
  "extensions": {},
  "providerId": "123e4567-e89b-12d3-a456-426614174000",
  "startsAt": "2025-01-01T00:00:00.000Z",
  "status": "no_status",
  "updatedAt": "2025-01-01T00:00:00.000Z"
}

Delete booking

Request

Permanently deletes a Booking record.

Security
bearer
Path
siteIdnumberrequired

Site identifier

bookingIdstringrequired

Booking unique identifier (UUID)

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

Responses

Booking deleted successfully

Breed

Operations

Communication

Operations

Consult

Operations

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