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/

Animal

Operations

Animal Colour

Operations

Breed

Operations

Health Status

Operations

Herd

Operations

Sex

Operations

Shelter Animal Booking

Operations

Species

Operations

Assessment

Operations

Consult

Operations

History

Operations

Physical Exam

Operations

Presentingproblem

Operations

Standardofcare

Operations

Therapeutic

Operations

Vaccination

Operations

Diagnostic

Operations

Diagnostic Code

Operations

Diagnostic Request

Operations

Diagnostic Result

Operations

Diagnostic Result Item

Operations

Integrated Diagnostic

Operations

Modality

Operations

Standard Diagnostic Lab Report

Operations

External Prescription

Operations

Prescription

Operations

Prescription Item

Operations

Appointment

Operations

Appointment Status

Operations

Appointment Type

Operations

Availability

Operations

Availability Slot

Operations

Booking

Operations

Billing Credit

Operations

Billing Line

Operations

Estimate

Operations

Insurance

Operations

Invoice

Operations

Invoiceline

Operations

Ledger Account

Operations

Linked Payment

Operations

Payment

Operations

Paymentmethod

Operations

Plan

Operations

Price Adjustment

Operations

Receive Invoice

Operations

Taxrate

Operations

Barcode

Operations

Batch

Operations

Inventory Message

Operations

Replace inventory message

Request

Fully replaces an existing Inventory Message. All fields must be provided.

Security
bearer
Path
siteIdnumberrequired

Site identifier

messageIdstringrequired

Inventory Message unique identifier (UUID)

Bodyapplication/jsonrequired
authorobjectrequired

Author of the message (user or system).

bodystringrequired

Full content of the message.

channelstringrequired

Primary communication channel or medium for this message.

Enum"internal""email""sms""phone""push""other"
clientProvidedIdstringrequired

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

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

Vendor- or practice-specific extensions.

isPinnedbooleanrequired

Whether this message is pinned or highlighted in the UI.

prioritystringrequired

Relative importance of the message.

Enum"low""normal""high""urgent"
readAtstringrequired

Timestamp when the message was first marked as read, if applicable.

Example: "2025-01-01T00:00:00.000Z"
recipientsArray of objects(RecipientDto)required

Intended recipients of the message.

recipients[].​displaystring

Human-readable display name for the recipient.

recipients[].​rolestring

Recipient role or group, if addressed to a role rather than a specific user.

recipients[].​userIdstring

Recipient user identifier, if applicable.

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

Inventory item this message is primarily about, if applicable.

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

Purchase order this message is related to, if applicable.

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

Supplier this message is related to, if applicable.

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

Timestamp when the message was sent, if applicable.

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

Current lifecycle status of the message.

Enum"draft""sent""received""read""archived""cancelled"
subjectstringrequired

Short, human-readable subject or title of the message.

tagsArray of stringsrequired

Free-form tags or labels for filtering and search.

typestringrequired

High-level classification of the message.

Enum"system""user""integration""alert""note"
curl -i -X PUT \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/inventory-message/{messageId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "author": {},
    "body": "string",
    "channel": "internal",
    "clientProvidedId": "123e4567-e89b-12d3-a456-426614174000",
    "extensions": {},
    "isPinned": true,
    "priority": "low",
    "readAt": "2025-01-01T00:00:00.000Z",
    "recipients": [
      {
        "display": "string",
        "role": "string",
        "userId": "123e4567-e89b-12d3-a456-426614174000"
      }
    ],
    "relatedInventoryItemId": "123e4567-e89b-12d3-a456-426614174000",
    "relatedPurchaseOrderId": "123e4567-e89b-12d3-a456-426614174000",
    "relatedSupplierId": "123e4567-e89b-12d3-a456-426614174000",
    "sentAt": "2025-01-01T00:00:00.000Z",
    "status": "draft",
    "subject": "string",
    "tags": [
      "string"
    ],
    "type": "system"
  }'

Responses

Inventory Message replaced successfully

Bodyapplication/json
authorobjectrequired

Author of the message (user or system).

bodystringrequired

Full content of the message.

channelstringrequired

Primary communication channel or medium for this message.

Enum"internal""email""sms""phone""push""other"
clientProvidedIdstringrequired

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

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

Timestamp when the message was created.

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

Vendor- or practice-specific extensions.

isPinnedbooleanrequired

Whether this message is pinned or highlighted in the UI.

messageIdstringrequired

Canonical unique identifier for this message.

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

Relative importance of the message.

Enum"low""normal""high""urgent"
readAtstring(date-time)required

Timestamp when the message was first marked as read, if applicable.

Example: "2025-01-01T00:00:00.000Z"
recipientsArray of objects(RecipientDto)required

Intended recipients of the message.

recipients[].​displaystring

Human-readable display name for the recipient.

recipients[].​rolestring

Recipient role or group, if addressed to a role rather than a specific user.

recipients[].​userIdstring

Recipient user identifier, if applicable.

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

Inventory item this message is primarily about, if applicable.

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

Purchase order this message is related to, if applicable.

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

Supplier this message is related to, if applicable.

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

Timestamp when the message was sent, if applicable.

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

Current lifecycle status of the message.

Enum"draft""sent""received""read""archived""cancelled"
subjectstringrequired

Short, human-readable subject or title of the message.

tagsArray of stringsrequired

Free-form tags or labels for filtering and search.

typestringrequired

High-level classification of the message.

Enum"system""user""integration""alert""note"
updatedAtstring(date-time)required

Timestamp when the message was last updated.

Example: "2025-01-01T00:00:00.000Z"
Response
application/json
{
  "author": {},
  "body": "string",
  "channel": "internal",
  "clientProvidedId": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "extensions": {},
  "isPinned": true,
  "messageId": "123e4567-e89b-12d3-a456-426614174000",
  "priority": "low",
  "readAt": "2025-01-01T00:00:00.000Z",
  "recipients": [
    { … }
  ],
  "relatedInventoryItemId": "123e4567-e89b-12d3-a456-426614174000",
  "relatedPurchaseOrderId": "123e4567-e89b-12d3-a456-426614174000",
  "relatedSupplierId": "123e4567-e89b-12d3-a456-426614174000",
  "sentAt": "2025-01-01T00:00:00.000Z",
  "status": "draft",
  "subject": "string",
  "tags": [
    "string"
  ],
  "type": "system",
  "updatedAt": "2025-01-01T00:00:00.000Z"
}

Delete inventory message

Request

Permanently deletes a Inventory Message record.

Security
bearer
Path
siteIdnumberrequired

Site identifier

messageIdstringrequired

Inventory Message unique identifier (UUID)

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

Responses

Inventory Message deleted successfully

Inventory Product

Operations

Inventory Requirement

Operations

Inventory Supplied Product

Operations

Product

Operations

Product Minimum Stock

Operations

Product Pricing

Operations

Product Supplier

Operations

Productgroup

Operations

Purchaseorder

Operations

Purchaseorderitem

Operations

Receive Invoice Item

Operations

Stock Adjustment

Operations

Stock Adjustment Item

Operations

Stock Transaction

Operations

Supplied

Operations

With Primary Inventory Location

Operations

Address

Operations

Contact

Operations

Contact Association

Operations

Contact Detail

Operations

Communication

Operations

Message

Operations

Template

Operations

User

Operations

Webhook

Operations

Webhook Event

Operations

Attachment

Operations

Country

Operations

Facility

Operations

File

Operations

File Upload

Operations

Location

Operations

Practitioner

Operations

Wellness Resource

Operations

Eventgroup

Operations

Operation

Operations

Requisition Form

Operations

Resource

Operations

Separation

Operations

Site Information

Operations

System Setting

Operations

Tag

Operations

Tagcategory

Operations

Tagname

Operations

Transaction

Operations