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

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

Create with primary inventory location

Request

Creates a new With Primary Inventory Location record. With Primary Inventory Location resource in the Animal Health Data Store

Security
bearer
Path
siteIdnumberrequired

Site identifier

Bodyapplication/jsonrequired
childSeparationIdstring

Identifier of the child separation, if any.

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

Identifier of the associated contact entity, if any.

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

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether this separation is currently active.

namestringrequired

Human-readable name of the separation (e.g., clinic or department name).

parentSeparationIdstring

Identifier of the parent separation, if any.

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

Identifier of the primary inventory location associated with this separation.

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

High-level category of the separation (e.g., division, department).

Enum"division""department""location""other"
separationIdstringrequired

Canonical identifier for the separation (e.g., division, department).

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

Free-text type or classification of the separation as used in the source system.

curl -i -X POST \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/with-primary-inventory-location' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "childSeparationId": "123e4567-e89b-12d3-a456-426614174000",
    "contactId": "123e4567-e89b-12d3-a456-426614174000",
    "extensions": {},
    "isActive": true,
    "name": "string",
    "parentSeparationId": "123e4567-e89b-12d3-a456-426614174000",
    "primaryInventoryLocationId": "123e4567-e89b-12d3-a456-426614174000",
    "separationCategory": "division",
    "separationId": "123e4567-e89b-12d3-a456-426614174000",
    "separationType": "string"
  }'

Responses

With Primary Inventory Location created successfully

Bodyapplication/json
childSeparationIdstringrequired

Identifier of the child separation, if any.

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

Identifier of the associated contact entity, if any.

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

Timestamp when the separation record was created.

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

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether this separation is currently active.

namestringrequired

Human-readable name of the separation (e.g., clinic or department name).

parentSeparationIdstringrequired

Identifier of the parent separation, if any.

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

Identifier of the primary inventory location associated with this separation.

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

High-level category of the separation (e.g., division, department).

Enum"division""department""location""other"
separationIdstringrequired

Canonical identifier for the separation (e.g., division, department).

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

Free-text type or classification of the separation as used in the source system.

updatedAtstring(date-time)required

Timestamp when the separation record was last updated.

Example: "2025-01-01T00:00:00.000Z"
Response
application/json
{
  "childSeparationId": "123e4567-e89b-12d3-a456-426614174000",
  "contactId": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "extensions": {},
  "isActive": true,
  "name": "string",
  "parentSeparationId": "123e4567-e89b-12d3-a456-426614174000",
  "primaryInventoryLocationId": "123e4567-e89b-12d3-a456-426614174000",
  "separationCategory": "division",
  "separationId": "123e4567-e89b-12d3-a456-426614174000",
  "separationType": "string",
  "updatedAt": "2025-01-01T00:00:00.000Z"
}

List with primary inventory locations

Request

Returns a paginated list of With Primary Inventory Locations 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""name""separationType"
sortOrderstring

Sort order

Default "asc"
Enum"asc""desc"
childSeparationIdstring

Identifier of the child separation, if any.

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

Identifier of the associated contact entity, if any.

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

Whether this separation is currently active.

namestring

Human-readable name of the separation (e.g., clinic or department name).

parentSeparationIdstring

Identifier of the parent separation, if any.

Example: parentSeparationId=123e4567-e89b-12d3-a456-426614174000
primaryInventoryLocationIdstring

Identifier of the primary inventory location associated with this separation.

Example: primaryInventoryLocationId=123e4567-e89b-12d3-a456-426614174000
separationCategorystring

High-level category of the separation (e.g., division, department).

Enum"division""department""location""other"
separationTypestring

Free-text type or classification of the separation as used in the source system.

curl -i -X GET \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/with-primary-inventory-location?page=0&pageSize=10&sortBy=createdAt&sortOrder=asc&childSeparationId=123e4567-e89b-12d3-a456-426614174000&contactId=123e4567-e89b-12d3-a456-426614174000&isActive=true&name=string&parentSeparationId=123e4567-e89b-12d3-a456-426614174000&primaryInventoryLocationId=123e4567-e89b-12d3-a456-426614174000&separationCategory=division&separationType=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Paginated list of With Primary Inventory Locations

Get with primary inventory location

Request

Returns a single With Primary Inventory Location by its unique identifier.

Security
bearer
Path
siteIdnumberrequired

Site identifier

separationIdstringrequired

With Primary Inventory Location unique identifier (UUID)

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

Responses

With Primary Inventory Location found

Bodyapplication/json
childSeparationIdstringrequired

Identifier of the child separation, if any.

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

Identifier of the associated contact entity, if any.

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

Timestamp when the separation record was created.

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

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether this separation is currently active.

namestringrequired

Human-readable name of the separation (e.g., clinic or department name).

parentSeparationIdstringrequired

Identifier of the parent separation, if any.

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

Identifier of the primary inventory location associated with this separation.

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

High-level category of the separation (e.g., division, department).

Enum"division""department""location""other"
separationIdstringrequired

Canonical identifier for the separation (e.g., division, department).

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

Free-text type or classification of the separation as used in the source system.

updatedAtstring(date-time)required

Timestamp when the separation record was last updated.

Example: "2025-01-01T00:00:00.000Z"
Response
application/json
{
  "childSeparationId": "123e4567-e89b-12d3-a456-426614174000",
  "contactId": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "extensions": {},
  "isActive": true,
  "name": "string",
  "parentSeparationId": "123e4567-e89b-12d3-a456-426614174000",
  "primaryInventoryLocationId": "123e4567-e89b-12d3-a456-426614174000",
  "separationCategory": "division",
  "separationId": "123e4567-e89b-12d3-a456-426614174000",
  "separationType": "string",
  "updatedAt": "2025-01-01T00:00:00.000Z"
}

Update with primary inventory location

Request

Partially updates an existing With Primary Inventory Location. Only provided fields will be updated.

Security
bearer
Path
siteIdnumberrequired

Site identifier

separationIdstringrequired

With Primary Inventory Location unique identifier (UUID)

Bodyapplication/jsonrequired
childSeparationIdstring

Identifier of the child separation, if any.

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

Identifier of the associated contact entity, if any.

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

Vendor- or practice-specific extensions.

isActiveboolean

Whether this separation is currently active.

namestring

Human-readable name of the separation (e.g., clinic or department name).

parentSeparationIdstring

Identifier of the parent separation, if any.

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

Identifier of the primary inventory location associated with this separation.

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

High-level category of the separation (e.g., division, department).

Enum"division""department""location""other"
separationTypestring

Free-text type or classification of the separation as used in the source system.

curl -i -X PATCH \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/with-primary-inventory-location/{separationId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "childSeparationId": "123e4567-e89b-12d3-a456-426614174000",
    "contactId": "123e4567-e89b-12d3-a456-426614174000",
    "extensions": {},
    "isActive": true,
    "name": "string",
    "parentSeparationId": "123e4567-e89b-12d3-a456-426614174000",
    "primaryInventoryLocationId": "123e4567-e89b-12d3-a456-426614174000",
    "separationCategory": "division",
    "separationType": "string"
  }'

Responses

With Primary Inventory Location updated successfully

Bodyapplication/json
childSeparationIdstringrequired

Identifier of the child separation, if any.

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

Identifier of the associated contact entity, if any.

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

Timestamp when the separation record was created.

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

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether this separation is currently active.

namestringrequired

Human-readable name of the separation (e.g., clinic or department name).

parentSeparationIdstringrequired

Identifier of the parent separation, if any.

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

Identifier of the primary inventory location associated with this separation.

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

High-level category of the separation (e.g., division, department).

Enum"division""department""location""other"
separationIdstringrequired

Canonical identifier for the separation (e.g., division, department).

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

Free-text type or classification of the separation as used in the source system.

updatedAtstring(date-time)required

Timestamp when the separation record was last updated.

Example: "2025-01-01T00:00:00.000Z"
Response
application/json
{
  "childSeparationId": "123e4567-e89b-12d3-a456-426614174000",
  "contactId": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "extensions": {},
  "isActive": true,
  "name": "string",
  "parentSeparationId": "123e4567-e89b-12d3-a456-426614174000",
  "primaryInventoryLocationId": "123e4567-e89b-12d3-a456-426614174000",
  "separationCategory": "division",
  "separationId": "123e4567-e89b-12d3-a456-426614174000",
  "separationType": "string",
  "updatedAt": "2025-01-01T00:00:00.000Z"
}

Replace with primary inventory location

Request

Fully replaces an existing With Primary Inventory Location. All fields must be provided.

Security
bearer
Path
siteIdnumberrequired

Site identifier

separationIdstringrequired

With Primary Inventory Location unique identifier (UUID)

Bodyapplication/jsonrequired
childSeparationIdstringrequired

Identifier of the child separation, if any.

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

Identifier of the associated contact entity, if any.

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

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether this separation is currently active.

namestringrequired

Human-readable name of the separation (e.g., clinic or department name).

parentSeparationIdstringrequired

Identifier of the parent separation, if any.

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

Identifier of the primary inventory location associated with this separation.

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

High-level category of the separation (e.g., division, department).

Enum"division""department""location""other"
separationTypestringrequired

Free-text type or classification of the separation as used in the source system.

curl -i -X PUT \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/with-primary-inventory-location/{separationId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "childSeparationId": "123e4567-e89b-12d3-a456-426614174000",
    "contactId": "123e4567-e89b-12d3-a456-426614174000",
    "extensions": {},
    "isActive": true,
    "name": "string",
    "parentSeparationId": "123e4567-e89b-12d3-a456-426614174000",
    "primaryInventoryLocationId": "123e4567-e89b-12d3-a456-426614174000",
    "separationCategory": "division",
    "separationType": "string"
  }'

Responses

With Primary Inventory Location replaced successfully

Bodyapplication/json
childSeparationIdstringrequired

Identifier of the child separation, if any.

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

Identifier of the associated contact entity, if any.

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

Timestamp when the separation record was created.

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

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether this separation is currently active.

namestringrequired

Human-readable name of the separation (e.g., clinic or department name).

parentSeparationIdstringrequired

Identifier of the parent separation, if any.

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

Identifier of the primary inventory location associated with this separation.

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

High-level category of the separation (e.g., division, department).

Enum"division""department""location""other"
separationIdstringrequired

Canonical identifier for the separation (e.g., division, department).

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

Free-text type or classification of the separation as used in the source system.

updatedAtstring(date-time)required

Timestamp when the separation record was last updated.

Example: "2025-01-01T00:00:00.000Z"
Response
application/json
{
  "childSeparationId": "123e4567-e89b-12d3-a456-426614174000",
  "contactId": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "extensions": {},
  "isActive": true,
  "name": "string",
  "parentSeparationId": "123e4567-e89b-12d3-a456-426614174000",
  "primaryInventoryLocationId": "123e4567-e89b-12d3-a456-426614174000",
  "separationCategory": "division",
  "separationId": "123e4567-e89b-12d3-a456-426614174000",
  "separationType": "string",
  "updatedAt": "2025-01-01T00:00:00.000Z"
}

Delete with primary inventory location

Request

Permanently deletes a With Primary Inventory Location record.

Security
bearer
Path
siteIdnumberrequired

Site identifier

separationIdstringrequired

With Primary Inventory Location unique identifier (UUID)

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

Responses

With Primary Inventory Location deleted successfully