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

Create batch

Request

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

Security
bearer
Path
siteIdnumberrequired

Site identifier

Bodyapplication/jsonrequired
batchIdstringrequired

Canonical unique identifier for the batch.

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

Type or classification of the batch.

clientProvidedIdstring

Optional client-supplied identifier for idempotency or cross-system mapping.

Example: "123e4567-e89b-12d3-a456-426614174000"
expiryDatestring or null

Date on which the batch expires.

Example: "2025-01-01"
extensionsobject

Vendor- or practice-specific extensions.

isActivebooleanrequired

Indicates whether the batch is active and usable.

namestringrequired

Human-readable batch name or code.

parentBatchIdstring or null

Identifier of the parent batch, if this batch is derived from another.

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

Identifier of the product this batch belongs to.

Example: "123e4567-e89b-12d3-a456-426614174000"
curl -i -X POST \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/batch' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "batchId": "123e4567-e89b-12d3-a456-426614174000",
    "batchType": "string",
    "clientProvidedId": "123e4567-e89b-12d3-a456-426614174000",
    "expiryDate": "2025-01-01",
    "extensions": {},
    "isActive": true,
    "name": "string",
    "parentBatchId": "123e4567-e89b-12d3-a456-426614174000",
    "productId": "123e4567-e89b-12d3-a456-426614174000"
  }'

Responses

Batch created successfully

Bodyapplication/json
batchIdstringrequired

Canonical unique identifier for the batch.

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

Type or classification of the batch.

clientProvidedIdstringrequired

Optional client-supplied identifier for idempotency or cross-system mapping.

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

Timestamp when the batch was created.

Example: "2025-01-01T00:00:00.000Z"
expiryDatestring or null(date-time)required

Date on which the batch expires.

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

Vendor- or practice-specific extensions.

isActivebooleanrequired

Indicates whether the batch is active and usable.

namestringrequired

Human-readable batch name or code.

parentBatchIdstring or nullrequired

Identifier of the parent batch, if this batch is derived from another.

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

Identifier of the product this batch belongs to.

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

Timestamp when the batch was last modified.

Example: "2025-01-01T00:00:00.000Z"
Response
application/json
{
  "batchId": "123e4567-e89b-12d3-a456-426614174000",
  "batchType": "string",
  "clientProvidedId": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "expiryDate": "2025-01-01T00:00:00Z",
  "extensions": {},
  "isActive": true,
  "name": "string",
  "parentBatchId": "123e4567-e89b-12d3-a456-426614174000",
  "productId": "123e4567-e89b-12d3-a456-426614174000",
  "updatedAt": "2025-01-01T00:00:00.000Z"
}

List batches

Request

Returns a paginated list of Batches 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""batchType""expiryDate""name"
sortOrderstring

Sort order

Default "asc"
Enum"asc""desc"
batchTypestring

Type or classification of the batch.

clientProvidedIdstring

Optional client-supplied identifier for idempotency or cross-system mapping.

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

Indicates whether the batch is active and usable.

namestring

Human-readable batch name or code.

parentBatchIdstring

Identifier of the parent batch, if this batch is derived from another.

Example: parentBatchId=123e4567-e89b-12d3-a456-426614174000
productIdstring

Identifier of the product this batch belongs to.

Example: productId=123e4567-e89b-12d3-a456-426614174000
curl -i -X GET \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/batch?page=0&pageSize=10&sortBy=createdAt&sortOrder=asc&batchType=string&clientProvidedId=123e4567-e89b-12d3-a456-426614174000&isActive=true&name=string&parentBatchId=123e4567-e89b-12d3-a456-426614174000&productId=123e4567-e89b-12d3-a456-426614174000' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Paginated list of Batches

Get batch

Request

Returns a single Batch by its unique identifier.

Security
bearer
Path
siteIdnumberrequired

Site identifier

batchIdstringrequired

Batch unique identifier (UUID)

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

Responses

Batch found

Bodyapplication/json
batchIdstringrequired

Canonical unique identifier for the batch.

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

Type or classification of the batch.

clientProvidedIdstringrequired

Optional client-supplied identifier for idempotency or cross-system mapping.

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

Timestamp when the batch was created.

Example: "2025-01-01T00:00:00.000Z"
expiryDatestring or null(date-time)required

Date on which the batch expires.

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

Vendor- or practice-specific extensions.

isActivebooleanrequired

Indicates whether the batch is active and usable.

namestringrequired

Human-readable batch name or code.

parentBatchIdstring or nullrequired

Identifier of the parent batch, if this batch is derived from another.

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

Identifier of the product this batch belongs to.

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

Timestamp when the batch was last modified.

Example: "2025-01-01T00:00:00.000Z"
Response
application/json
{
  "batchId": "123e4567-e89b-12d3-a456-426614174000",
  "batchType": "string",
  "clientProvidedId": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "expiryDate": "2025-01-01T00:00:00Z",
  "extensions": {},
  "isActive": true,
  "name": "string",
  "parentBatchId": "123e4567-e89b-12d3-a456-426614174000",
  "productId": "123e4567-e89b-12d3-a456-426614174000",
  "updatedAt": "2025-01-01T00:00:00.000Z"
}

Update batch

Request

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

Security
bearer
Path
siteIdnumberrequired

Site identifier

batchIdstringrequired

Batch unique identifier (UUID)

Bodyapplication/jsonrequired
batchTypestring

Type or classification of the batch.

clientProvidedIdstring

Optional client-supplied identifier for idempotency or cross-system mapping.

Example: "123e4567-e89b-12d3-a456-426614174000"
expiryDatestring or null

Date on which the batch expires.

Example: "2025-01-01"
extensionsobject

Vendor- or practice-specific extensions.

isActiveboolean

Indicates whether the batch is active and usable.

namestring

Human-readable batch name or code.

parentBatchIdstring or null

Identifier of the parent batch, if this batch is derived from another.

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

Identifier of the product this batch belongs to.

Example: "123e4567-e89b-12d3-a456-426614174000"
curl -i -X PATCH \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/batch/{batchId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "batchType": "string",
    "clientProvidedId": "123e4567-e89b-12d3-a456-426614174000",
    "expiryDate": "2025-01-01",
    "extensions": {},
    "isActive": true,
    "name": "string",
    "parentBatchId": "123e4567-e89b-12d3-a456-426614174000",
    "productId": "123e4567-e89b-12d3-a456-426614174000"
  }'

Responses

Batch updated successfully

Bodyapplication/json
batchIdstringrequired

Canonical unique identifier for the batch.

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

Type or classification of the batch.

clientProvidedIdstringrequired

Optional client-supplied identifier for idempotency or cross-system mapping.

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

Timestamp when the batch was created.

Example: "2025-01-01T00:00:00.000Z"
expiryDatestring or null(date-time)required

Date on which the batch expires.

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

Vendor- or practice-specific extensions.

isActivebooleanrequired

Indicates whether the batch is active and usable.

namestringrequired

Human-readable batch name or code.

parentBatchIdstring or nullrequired

Identifier of the parent batch, if this batch is derived from another.

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

Identifier of the product this batch belongs to.

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

Timestamp when the batch was last modified.

Example: "2025-01-01T00:00:00.000Z"
Response
application/json
{
  "batchId": "123e4567-e89b-12d3-a456-426614174000",
  "batchType": "string",
  "clientProvidedId": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "expiryDate": "2025-01-01T00:00:00Z",
  "extensions": {},
  "isActive": true,
  "name": "string",
  "parentBatchId": "123e4567-e89b-12d3-a456-426614174000",
  "productId": "123e4567-e89b-12d3-a456-426614174000",
  "updatedAt": "2025-01-01T00:00:00.000Z"
}

Replace batch

Request

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

Security
bearer
Path
siteIdnumberrequired

Site identifier

batchIdstringrequired

Batch unique identifier (UUID)

Bodyapplication/jsonrequired
batchTypestringrequired

Type or classification of the batch.

clientProvidedIdstringrequired

Optional client-supplied identifier for idempotency or cross-system mapping.

Example: "123e4567-e89b-12d3-a456-426614174000"
expiryDatestring or null

Date on which the batch expires.

Example: "2025-01-01"
extensionsobjectrequired

Vendor- or practice-specific extensions.

isActivebooleanrequired

Indicates whether the batch is active and usable.

namestringrequired

Human-readable batch name or code.

parentBatchIdstring or null

Identifier of the parent batch, if this batch is derived from another.

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

Identifier of the product this batch belongs to.

Example: "123e4567-e89b-12d3-a456-426614174000"
curl -i -X PUT \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/batch/{batchId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "batchType": "string",
    "clientProvidedId": "123e4567-e89b-12d3-a456-426614174000",
    "expiryDate": "2025-01-01",
    "extensions": {},
    "isActive": true,
    "name": "string",
    "parentBatchId": "123e4567-e89b-12d3-a456-426614174000",
    "productId": "123e4567-e89b-12d3-a456-426614174000"
  }'

Responses

Batch replaced successfully

Bodyapplication/json
batchIdstringrequired

Canonical unique identifier for the batch.

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

Type or classification of the batch.

clientProvidedIdstringrequired

Optional client-supplied identifier for idempotency or cross-system mapping.

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

Timestamp when the batch was created.

Example: "2025-01-01T00:00:00.000Z"
expiryDatestring or null(date-time)required

Date on which the batch expires.

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

Vendor- or practice-specific extensions.

isActivebooleanrequired

Indicates whether the batch is active and usable.

namestringrequired

Human-readable batch name or code.

parentBatchIdstring or nullrequired

Identifier of the parent batch, if this batch is derived from another.

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

Identifier of the product this batch belongs to.

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

Timestamp when the batch was last modified.

Example: "2025-01-01T00:00:00.000Z"
Response
application/json
{
  "batchId": "123e4567-e89b-12d3-a456-426614174000",
  "batchType": "string",
  "clientProvidedId": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "expiryDate": "2025-01-01T00:00:00Z",
  "extensions": {},
  "isActive": true,
  "name": "string",
  "parentBatchId": "123e4567-e89b-12d3-a456-426614174000",
  "productId": "123e4567-e89b-12d3-a456-426614174000",
  "updatedAt": "2025-01-01T00:00:00.000Z"
}

Delete batch

Request

Permanently deletes a Batch record.

Security
bearer
Path
siteIdnumberrequired

Site identifier

batchIdstringrequired

Batch unique identifier (UUID)

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

Responses

Batch deleted successfully

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