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

Create supplied

Request

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

Security
bearer
Path
siteIdnumberrequired

Site identifier

Bodyapplication/jsonrequired
batchNumberstring

Batch or lot number associated with the supplied product.

clientProvidedIdstring

Optional client-supplied identifier for this supplied record.

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

Expiry date of the supplied batch, if applicable.

Example: "2025-01-01"
extensionsobject

Vendor- or practice-specific extensions.

isActiveboolean

Indicates whether this supplied record is active (not fully reversed or deleted).

locationIdstring

Inventory location or store where the product was supplied.

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

Free-text notes about this supplied record.

productIdstringrequired

Reference to the product that was supplied.

Example: "123e4567-e89b-12d3-a456-426614174000"
quantityobjectrequired
quantity.​valuenumberrequired

Numeric value

quantity.​unitstringrequired

Unit of measure

quantity.​systemstring

Unit system URI

referenceNumberstring

External reference such as supplier invoice number or delivery note.

suppliedAtstring

Date and time when the product was supplied/received into inventory.

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

Canonical identifier for this supplied inventory record.

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

Reference to the supplier providing the product.

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

Total cost for this supplied line (quantity × unitCost).

unitCostobject

Cost per unit of the supplied product.

curl -i -X POST \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/supplied' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "batchNumber": "string",
    "clientProvidedId": "123e4567-e89b-12d3-a456-426614174000",
    "expiryDate": "2025-01-01",
    "extensions": {},
    "isActive": true,
    "locationId": "123e4567-e89b-12d3-a456-426614174000",
    "notes": "string",
    "productId": "123e4567-e89b-12d3-a456-426614174000",
    "quantity": {
      "value": 0,
      "unit": "string",
      "system": "string"
    },
    "referenceNumber": "string",
    "suppliedAt": "2025-01-01T00:00:00.000Z",
    "suppliedId": "123e4567-e89b-12d3-a456-426614174000",
    "supplierId": "123e4567-e89b-12d3-a456-426614174000",
    "totalCost": {},
    "unitCost": {}
  }'

Responses

Supplied created successfully

Bodyapplication/json
batchNumberstringrequired

Batch or lot number associated with the supplied product.

clientProvidedIdstringrequired

Optional client-supplied identifier for this supplied record.

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

Timestamp when this record was created in the source system.

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

Expiry date of the supplied batch, if applicable.

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

Vendor- or practice-specific extensions.

isActivebooleanrequired

Indicates whether this supplied record is active (not fully reversed or deleted).

locationIdstringrequired

Inventory location or store where the product was supplied.

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

Free-text notes about this supplied record.

productIdstringrequired

Reference to the product that was supplied.

Example: "123e4567-e89b-12d3-a456-426614174000"
quantityobjectrequired
quantity.​valuenumberrequired

Numeric value

quantity.​unitstringrequired

Unit of measure

quantity.​systemstring

Unit system URI

referenceNumberstringrequired

External reference such as supplier invoice number or delivery note.

suppliedAtstring(date-time)required

Date and time when the product was supplied/received into inventory.

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

Canonical identifier for this supplied inventory record.

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

Reference to the supplier providing the product.

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

Total cost for this supplied line (quantity × unitCost).

unitCostobjectrequired

Cost per unit of the supplied product.

updatedAtstring(date-time)required

Timestamp when this record was last updated in the source system.

Example: "2025-01-01T00:00:00.000Z"
Response
application/json
{
  "batchNumber": "string",
  "clientProvidedId": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "expiryDate": "2025-01-01T00:00:00Z",
  "extensions": {},
  "isActive": true,
  "locationId": "123e4567-e89b-12d3-a456-426614174000",
  "notes": "string",
  "productId": "123e4567-e89b-12d3-a456-426614174000",
  "quantity": {
    "value": 0,
    "unit": "string",
    "system": "string"
  },
  "referenceNumber": "string",
  "suppliedAt": "2025-01-01T00:00:00.000Z",
  "suppliedId": "123e4567-e89b-12d3-a456-426614174000",
  "supplierId": "123e4567-e89b-12d3-a456-426614174000",
  "totalCost": {},
  "unitCost": {},
  "updatedAt": "2025-01-01T00:00:00.000Z"
}

List supplieds

Request

Returns a paginated list of Supplieds 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""batchNumber""expiryDate""notes""referenceNumber""suppliedAt"
sortOrderstring

Sort order

Default "asc"
Enum"asc""desc"
batchNumberstring

Batch or lot number associated with the supplied product.

clientProvidedIdstring

Optional client-supplied identifier for this supplied record.

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

Indicates whether this supplied record is active (not fully reversed or deleted).

locationIdstring

Inventory location or store where the product was supplied.

Example: locationId=123e4567-e89b-12d3-a456-426614174000
notesstring

Free-text notes about this supplied record.

productIdstring

Reference to the product that was supplied.

Example: productId=123e4567-e89b-12d3-a456-426614174000
referenceNumberstring

External reference such as supplier invoice number or delivery note.

supplierIdstring

Reference to the supplier providing the product.

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

Responses

Paginated list of Supplieds

Get supplied

Request

Returns a single Supplied by its unique identifier.

Security
bearer
Path
siteIdnumberrequired

Site identifier

suppliedIdstringrequired

Supplied unique identifier (UUID)

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

Responses

Supplied found

Bodyapplication/json
batchNumberstringrequired

Batch or lot number associated with the supplied product.

clientProvidedIdstringrequired

Optional client-supplied identifier for this supplied record.

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

Timestamp when this record was created in the source system.

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

Expiry date of the supplied batch, if applicable.

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

Vendor- or practice-specific extensions.

isActivebooleanrequired

Indicates whether this supplied record is active (not fully reversed or deleted).

locationIdstringrequired

Inventory location or store where the product was supplied.

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

Free-text notes about this supplied record.

productIdstringrequired

Reference to the product that was supplied.

Example: "123e4567-e89b-12d3-a456-426614174000"
quantityobjectrequired
quantity.​valuenumberrequired

Numeric value

quantity.​unitstringrequired

Unit of measure

quantity.​systemstring

Unit system URI

referenceNumberstringrequired

External reference such as supplier invoice number or delivery note.

suppliedAtstring(date-time)required

Date and time when the product was supplied/received into inventory.

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

Canonical identifier for this supplied inventory record.

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

Reference to the supplier providing the product.

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

Total cost for this supplied line (quantity × unitCost).

unitCostobjectrequired

Cost per unit of the supplied product.

updatedAtstring(date-time)required

Timestamp when this record was last updated in the source system.

Example: "2025-01-01T00:00:00.000Z"
Response
application/json
{
  "batchNumber": "string",
  "clientProvidedId": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "expiryDate": "2025-01-01T00:00:00Z",
  "extensions": {},
  "isActive": true,
  "locationId": "123e4567-e89b-12d3-a456-426614174000",
  "notes": "string",
  "productId": "123e4567-e89b-12d3-a456-426614174000",
  "quantity": {
    "value": 0,
    "unit": "string",
    "system": "string"
  },
  "referenceNumber": "string",
  "suppliedAt": "2025-01-01T00:00:00.000Z",
  "suppliedId": "123e4567-e89b-12d3-a456-426614174000",
  "supplierId": "123e4567-e89b-12d3-a456-426614174000",
  "totalCost": {},
  "unitCost": {},
  "updatedAt": "2025-01-01T00:00:00.000Z"
}

Update supplied

Request

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

Security
bearer
Path
siteIdnumberrequired

Site identifier

suppliedIdstringrequired

Supplied unique identifier (UUID)

Bodyapplication/jsonrequired
batchNumberstring

Batch or lot number associated with the supplied product.

clientProvidedIdstring

Optional client-supplied identifier for this supplied record.

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

Expiry date of the supplied batch, if applicable.

Example: "2025-01-01"
extensionsobject

Vendor- or practice-specific extensions.

isActiveboolean

Indicates whether this supplied record is active (not fully reversed or deleted).

locationIdstring

Inventory location or store where the product was supplied.

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

Free-text notes about this supplied record.

productIdstring

Reference to the product that was supplied.

Example: "123e4567-e89b-12d3-a456-426614174000"
quantityobject
referenceNumberstring

External reference such as supplier invoice number or delivery note.

suppliedAtstring

Date and time when the product was supplied/received into inventory.

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

Reference to the supplier providing the product.

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

Total cost for this supplied line (quantity × unitCost).

unitCostobject

Cost per unit of the supplied product.

curl -i -X PATCH \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/supplied/{suppliedId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "batchNumber": "string",
    "clientProvidedId": "123e4567-e89b-12d3-a456-426614174000",
    "expiryDate": "2025-01-01",
    "extensions": {},
    "isActive": true,
    "locationId": "123e4567-e89b-12d3-a456-426614174000",
    "notes": "string",
    "productId": "123e4567-e89b-12d3-a456-426614174000",
    "quantity": {
      "value": 0,
      "unit": "string",
      "system": "string"
    },
    "referenceNumber": "string",
    "suppliedAt": "2025-01-01T00:00:00.000Z",
    "supplierId": "123e4567-e89b-12d3-a456-426614174000",
    "totalCost": {},
    "unitCost": {}
  }'

Responses

Supplied updated successfully

Bodyapplication/json
batchNumberstringrequired

Batch or lot number associated with the supplied product.

clientProvidedIdstringrequired

Optional client-supplied identifier for this supplied record.

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

Timestamp when this record was created in the source system.

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

Expiry date of the supplied batch, if applicable.

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

Vendor- or practice-specific extensions.

isActivebooleanrequired

Indicates whether this supplied record is active (not fully reversed or deleted).

locationIdstringrequired

Inventory location or store where the product was supplied.

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

Free-text notes about this supplied record.

productIdstringrequired

Reference to the product that was supplied.

Example: "123e4567-e89b-12d3-a456-426614174000"
quantityobjectrequired
quantity.​valuenumberrequired

Numeric value

quantity.​unitstringrequired

Unit of measure

quantity.​systemstring

Unit system URI

referenceNumberstringrequired

External reference such as supplier invoice number or delivery note.

suppliedAtstring(date-time)required

Date and time when the product was supplied/received into inventory.

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

Canonical identifier for this supplied inventory record.

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

Reference to the supplier providing the product.

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

Total cost for this supplied line (quantity × unitCost).

unitCostobjectrequired

Cost per unit of the supplied product.

updatedAtstring(date-time)required

Timestamp when this record was last updated in the source system.

Example: "2025-01-01T00:00:00.000Z"
Response
application/json
{
  "batchNumber": "string",
  "clientProvidedId": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "expiryDate": "2025-01-01T00:00:00Z",
  "extensions": {},
  "isActive": true,
  "locationId": "123e4567-e89b-12d3-a456-426614174000",
  "notes": "string",
  "productId": "123e4567-e89b-12d3-a456-426614174000",
  "quantity": {
    "value": 0,
    "unit": "string",
    "system": "string"
  },
  "referenceNumber": "string",
  "suppliedAt": "2025-01-01T00:00:00.000Z",
  "suppliedId": "123e4567-e89b-12d3-a456-426614174000",
  "supplierId": "123e4567-e89b-12d3-a456-426614174000",
  "totalCost": {},
  "unitCost": {},
  "updatedAt": "2025-01-01T00:00:00.000Z"
}

Replace supplied

Request

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

Security
bearer
Path
siteIdnumberrequired

Site identifier

suppliedIdstringrequired

Supplied unique identifier (UUID)

Bodyapplication/jsonrequired
batchNumberstringrequired

Batch or lot number associated with the supplied product.

clientProvidedIdstringrequired

Optional client-supplied identifier for this supplied record.

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

Expiry date of the supplied batch, if applicable.

Example: "2025-01-01"
extensionsobjectrequired

Vendor- or practice-specific extensions.

isActivebooleanrequired

Indicates whether this supplied record is active (not fully reversed or deleted).

locationIdstringrequired

Inventory location or store where the product was supplied.

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

Free-text notes about this supplied record.

productIdstringrequired

Reference to the product that was supplied.

Example: "123e4567-e89b-12d3-a456-426614174000"
quantityobjectrequired
quantity.​valuenumberrequired

Numeric value

quantity.​unitstringrequired

Unit of measure

quantity.​systemstring

Unit system URI

referenceNumberstringrequired

External reference such as supplier invoice number or delivery note.

suppliedAtstringrequired

Date and time when the product was supplied/received into inventory.

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

Reference to the supplier providing the product.

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

Total cost for this supplied line (quantity × unitCost).

unitCostobjectrequired

Cost per unit of the supplied product.

curl -i -X PUT \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/supplied/{suppliedId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "batchNumber": "string",
    "clientProvidedId": "123e4567-e89b-12d3-a456-426614174000",
    "expiryDate": "2025-01-01",
    "extensions": {},
    "isActive": true,
    "locationId": "123e4567-e89b-12d3-a456-426614174000",
    "notes": "string",
    "productId": "123e4567-e89b-12d3-a456-426614174000",
    "quantity": {
      "value": 0,
      "unit": "string",
      "system": "string"
    },
    "referenceNumber": "string",
    "suppliedAt": "2025-01-01T00:00:00.000Z",
    "supplierId": "123e4567-e89b-12d3-a456-426614174000",
    "totalCost": {},
    "unitCost": {}
  }'

Responses

Supplied replaced successfully

Bodyapplication/json
batchNumberstringrequired

Batch or lot number associated with the supplied product.

clientProvidedIdstringrequired

Optional client-supplied identifier for this supplied record.

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

Timestamp when this record was created in the source system.

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

Expiry date of the supplied batch, if applicable.

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

Vendor- or practice-specific extensions.

isActivebooleanrequired

Indicates whether this supplied record is active (not fully reversed or deleted).

locationIdstringrequired

Inventory location or store where the product was supplied.

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

Free-text notes about this supplied record.

productIdstringrequired

Reference to the product that was supplied.

Example: "123e4567-e89b-12d3-a456-426614174000"
quantityobjectrequired
quantity.​valuenumberrequired

Numeric value

quantity.​unitstringrequired

Unit of measure

quantity.​systemstring

Unit system URI

referenceNumberstringrequired

External reference such as supplier invoice number or delivery note.

suppliedAtstring(date-time)required

Date and time when the product was supplied/received into inventory.

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

Canonical identifier for this supplied inventory record.

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

Reference to the supplier providing the product.

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

Total cost for this supplied line (quantity × unitCost).

unitCostobjectrequired

Cost per unit of the supplied product.

updatedAtstring(date-time)required

Timestamp when this record was last updated in the source system.

Example: "2025-01-01T00:00:00.000Z"
Response
application/json
{
  "batchNumber": "string",
  "clientProvidedId": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "expiryDate": "2025-01-01T00:00:00Z",
  "extensions": {},
  "isActive": true,
  "locationId": "123e4567-e89b-12d3-a456-426614174000",
  "notes": "string",
  "productId": "123e4567-e89b-12d3-a456-426614174000",
  "quantity": {
    "value": 0,
    "unit": "string",
    "system": "string"
  },
  "referenceNumber": "string",
  "suppliedAt": "2025-01-01T00:00:00.000Z",
  "suppliedId": "123e4567-e89b-12d3-a456-426614174000",
  "supplierId": "123e4567-e89b-12d3-a456-426614174000",
  "totalCost": {},
  "unitCost": {},
  "updatedAt": "2025-01-01T00:00:00.000Z"
}

Delete supplied

Request

Permanently deletes a Supplied record.

Security
bearer
Path
siteIdnumberrequired

Site identifier

suppliedIdstringrequired

Supplied unique identifier (UUID)

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

Responses

Supplied deleted successfully

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