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

Create message

Request

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

Security
bearer
Path
siteIdnumberrequired

Site identifier

Bodyapplication/jsonrequired
bodystringrequired

Full content of the message.

channelstring

Primary communication channel used to deliver the message.

Enum"internal""email""sms""phone""push""portal""other"
deliveredAtstring

Timestamp when the message was delivered to the recipient's channel, if known.

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

Vendor- or practice-specific extensions.

fromobject

Sender of the message, if known.

messageIdstringrequired

Canonical unique identifier for the message.

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

High-level classification of the message.

Enum"system""user""integration""alert""reminder""other"
prioritystring

Relative importance of the message.

Enum"low""normal""high""urgent"
readAtstring

Timestamp when the message was first read, if tracked.

Example: "2025-01-01T00:00:00.000Z"
relatedEntitiesArray of objects(RelatedEntitieDto)

References to entities this message is about (e.g., animal, appointment, invoice).

sentAtstring

Timestamp when the message was sent or made available to recipients.

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

Current lifecycle status of the message.

Enum"draft""queued""sent""delivered""read""failed""cancelled""archived"
subjectstringrequired

Short subject or title of the message.

toArray of objects(ToDto)

Primary recipients of the message.

curl -i -X POST \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/message' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "body": "string",
    "channel": "internal",
    "deliveredAt": "2025-01-01T00:00:00.000Z",
    "extensions": {},
    "from": {},
    "messageId": "123e4567-e89b-12d3-a456-426614174000",
    "messageType": "system",
    "priority": "low",
    "readAt": "2025-01-01T00:00:00.000Z",
    "relatedEntities": [
      {
        "display": "string",
        "entityId": "123e4567-e89b-12d3-a456-426614174000",
        "entityType": "animal"
      }
    ],
    "sentAt": "2025-01-01T00:00:00.000Z",
    "status": "draft",
    "subject": "string",
    "to": [
      {
        "contactId": "123e4567-e89b-12d3-a456-426614174000",
        "display": "string",
        "userId": "123e4567-e89b-12d3-a456-426614174000"
      }
    ]
  }'

Responses

Message created successfully

Bodyapplication/json
bodystringrequired

Full content of the message.

channelstringrequired

Primary communication channel used to deliver the message.

Enum"internal""email""sms""phone""push""portal""other"
createdAtstring(date-time)required

Timestamp when the message record was created.

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

Timestamp when the message was delivered to the recipient's channel, if known.

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

Vendor- or practice-specific extensions.

fromobjectrequired

Sender of the message, if known.

messageIdstringrequired

Canonical unique identifier for the message.

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

High-level classification of the message.

Enum"system""user""integration""alert""reminder""other"
prioritystringrequired

Relative importance of the message.

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

Timestamp when the message was first read, if tracked.

Example: "2025-01-01T00:00:00.000Z"
relatedEntitiesArray of objects(RelatedEntitieDto)required

References to entities this message is about (e.g., animal, appointment, invoice).

relatedEntities[].​displaystring

Optional display label for the related entity.

relatedEntities[].​entityIdstringrequired

Identifier of the related entity.

Example: "123e4567-e89b-12d3-a456-426614174000"
relatedEntities[].​entityTypestringrequired

Type of the related entity.

Enum"animal""client""appointment""invoice""medicalRecord""task""other"
sentAtstring(date-time)required

Timestamp when the message was sent or made available to recipients.

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

Current lifecycle status of the message.

Enum"draft""queued""sent""delivered""read""failed""cancelled""archived"
subjectstringrequired

Short subject or title of the message.

toArray of objects(ToDto)required

Primary recipients of the message.

to[].​contactIdstring

External contact recipient of the message.

Example: "123e4567-e89b-12d3-a456-426614174000"
to[].​displaystring

Human-readable name of the recipient.

to[].​userIdstring

User recipient of the message.

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

Timestamp when the message record was last updated.

Example: "2025-01-01T00:00:00.000Z"
Response
application/json
{
  "body": "string",
  "channel": "internal",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "deliveredAt": "2025-01-01T00:00:00.000Z",
  "extensions": {},
  "from": {},
  "messageId": "123e4567-e89b-12d3-a456-426614174000",
  "messageType": "system",
  "priority": "low",
  "readAt": "2025-01-01T00:00:00.000Z",
  "relatedEntities": [
    { … }
  ],
  "sentAt": "2025-01-01T00:00:00.000Z",
  "status": "draft",
  "subject": "string",
  "to": [
    { … }
  ],
  "updatedAt": "2025-01-01T00:00:00.000Z"
}

List messages

Request

Returns a paginated list of Messages 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""body""deliveredAt""readAt""sentAt""subject"
sortOrderstring

Sort order

Default "asc"
Enum"asc""desc"
bodystring

Full content of the message.

channelstring

Primary communication channel used to deliver the message.

Enum"internal""email""sms""phone""push""portal""other"
messageTypestring

High-level classification of the message.

Enum"system""user""integration""alert""reminder""other"
prioritystring

Relative importance of the message.

Enum"low""normal""high""urgent"
statusstring

Current lifecycle status of the message.

Enum"draft""queued""sent""delivered""read""failed""cancelled""archived"
subjectstring

Short subject or title of the message.

curl -i -X GET \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/message?page=0&pageSize=10&sortBy=createdAt&sortOrder=asc&body=string&channel=internal&messageType=system&priority=low&status=draft&subject=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Paginated list of Messages

Get message

Request

Returns a single Message by its unique identifier.

Security
bearer
Path
siteIdnumberrequired

Site identifier

messageIdstringrequired

Message unique identifier (UUID)

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

Responses

Message found

Bodyapplication/json
bodystringrequired

Full content of the message.

channelstringrequired

Primary communication channel used to deliver the message.

Enum"internal""email""sms""phone""push""portal""other"
createdAtstring(date-time)required

Timestamp when the message record was created.

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

Timestamp when the message was delivered to the recipient's channel, if known.

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

Vendor- or practice-specific extensions.

fromobjectrequired

Sender of the message, if known.

messageIdstringrequired

Canonical unique identifier for the message.

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

High-level classification of the message.

Enum"system""user""integration""alert""reminder""other"
prioritystringrequired

Relative importance of the message.

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

Timestamp when the message was first read, if tracked.

Example: "2025-01-01T00:00:00.000Z"
relatedEntitiesArray of objects(RelatedEntitieDto)required

References to entities this message is about (e.g., animal, appointment, invoice).

relatedEntities[].​displaystring

Optional display label for the related entity.

relatedEntities[].​entityIdstringrequired

Identifier of the related entity.

Example: "123e4567-e89b-12d3-a456-426614174000"
relatedEntities[].​entityTypestringrequired

Type of the related entity.

Enum"animal""client""appointment""invoice""medicalRecord""task""other"
sentAtstring(date-time)required

Timestamp when the message was sent or made available to recipients.

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

Current lifecycle status of the message.

Enum"draft""queued""sent""delivered""read""failed""cancelled""archived"
subjectstringrequired

Short subject or title of the message.

toArray of objects(ToDto)required

Primary recipients of the message.

to[].​contactIdstring

External contact recipient of the message.

Example: "123e4567-e89b-12d3-a456-426614174000"
to[].​displaystring

Human-readable name of the recipient.

to[].​userIdstring

User recipient of the message.

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

Timestamp when the message record was last updated.

Example: "2025-01-01T00:00:00.000Z"
Response
application/json
{
  "body": "string",
  "channel": "internal",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "deliveredAt": "2025-01-01T00:00:00.000Z",
  "extensions": {},
  "from": {},
  "messageId": "123e4567-e89b-12d3-a456-426614174000",
  "messageType": "system",
  "priority": "low",
  "readAt": "2025-01-01T00:00:00.000Z",
  "relatedEntities": [
    { … }
  ],
  "sentAt": "2025-01-01T00:00:00.000Z",
  "status": "draft",
  "subject": "string",
  "to": [
    { … }
  ],
  "updatedAt": "2025-01-01T00:00:00.000Z"
}

Update message

Request

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

Security
bearer
Path
siteIdnumberrequired

Site identifier

messageIdstringrequired

Message unique identifier (UUID)

Bodyapplication/jsonrequired
bodystring

Full content of the message.

channelstring

Primary communication channel used to deliver the message.

Enum"internal""email""sms""phone""push""portal""other"
deliveredAtstring

Timestamp when the message was delivered to the recipient's channel, if known.

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

Vendor- or practice-specific extensions.

fromobject

Sender of the message, if known.

messageTypestring

High-level classification of the message.

Enum"system""user""integration""alert""reminder""other"
prioritystring

Relative importance of the message.

Enum"low""normal""high""urgent"
readAtstring

Timestamp when the message was first read, if tracked.

Example: "2025-01-01T00:00:00.000Z"
relatedEntitiesArray of objects(RelatedEntitieDto)

References to entities this message is about (e.g., animal, appointment, invoice).

sentAtstring

Timestamp when the message was sent or made available to recipients.

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

Current lifecycle status of the message.

Enum"draft""queued""sent""delivered""read""failed""cancelled""archived"
subjectstring

Short subject or title of the message.

toArray of objects(ToDto)

Primary recipients of the message.

curl -i -X PATCH \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/message/{messageId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "body": "string",
    "channel": "internal",
    "deliveredAt": "2025-01-01T00:00:00.000Z",
    "extensions": {},
    "from": {},
    "messageType": "system",
    "priority": "low",
    "readAt": "2025-01-01T00:00:00.000Z",
    "relatedEntities": [
      {
        "display": "string",
        "entityId": "123e4567-e89b-12d3-a456-426614174000",
        "entityType": "animal"
      }
    ],
    "sentAt": "2025-01-01T00:00:00.000Z",
    "status": "draft",
    "subject": "string",
    "to": [
      {
        "contactId": "123e4567-e89b-12d3-a456-426614174000",
        "display": "string",
        "userId": "123e4567-e89b-12d3-a456-426614174000"
      }
    ]
  }'

Responses

Message updated successfully

Bodyapplication/json
bodystringrequired

Full content of the message.

channelstringrequired

Primary communication channel used to deliver the message.

Enum"internal""email""sms""phone""push""portal""other"
createdAtstring(date-time)required

Timestamp when the message record was created.

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

Timestamp when the message was delivered to the recipient's channel, if known.

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

Vendor- or practice-specific extensions.

fromobjectrequired

Sender of the message, if known.

messageIdstringrequired

Canonical unique identifier for the message.

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

High-level classification of the message.

Enum"system""user""integration""alert""reminder""other"
prioritystringrequired

Relative importance of the message.

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

Timestamp when the message was first read, if tracked.

Example: "2025-01-01T00:00:00.000Z"
relatedEntitiesArray of objects(RelatedEntitieDto)required

References to entities this message is about (e.g., animal, appointment, invoice).

relatedEntities[].​displaystring

Optional display label for the related entity.

relatedEntities[].​entityIdstringrequired

Identifier of the related entity.

Example: "123e4567-e89b-12d3-a456-426614174000"
relatedEntities[].​entityTypestringrequired

Type of the related entity.

Enum"animal""client""appointment""invoice""medicalRecord""task""other"
sentAtstring(date-time)required

Timestamp when the message was sent or made available to recipients.

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

Current lifecycle status of the message.

Enum"draft""queued""sent""delivered""read""failed""cancelled""archived"
subjectstringrequired

Short subject or title of the message.

toArray of objects(ToDto)required

Primary recipients of the message.

to[].​contactIdstring

External contact recipient of the message.

Example: "123e4567-e89b-12d3-a456-426614174000"
to[].​displaystring

Human-readable name of the recipient.

to[].​userIdstring

User recipient of the message.

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

Timestamp when the message record was last updated.

Example: "2025-01-01T00:00:00.000Z"
Response
application/json
{
  "body": "string",
  "channel": "internal",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "deliveredAt": "2025-01-01T00:00:00.000Z",
  "extensions": {},
  "from": {},
  "messageId": "123e4567-e89b-12d3-a456-426614174000",
  "messageType": "system",
  "priority": "low",
  "readAt": "2025-01-01T00:00:00.000Z",
  "relatedEntities": [
    { … }
  ],
  "sentAt": "2025-01-01T00:00:00.000Z",
  "status": "draft",
  "subject": "string",
  "to": [
    { … }
  ],
  "updatedAt": "2025-01-01T00:00:00.000Z"
}

Replace message

Request

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

Security
bearer
Path
siteIdnumberrequired

Site identifier

messageIdstringrequired

Message unique identifier (UUID)

Bodyapplication/jsonrequired
bodystringrequired

Full content of the message.

channelstringrequired

Primary communication channel used to deliver the message.

Enum"internal""email""sms""phone""push""portal""other"
deliveredAtstringrequired

Timestamp when the message was delivered to the recipient's channel, if known.

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

Vendor- or practice-specific extensions.

fromobjectrequired

Sender of the message, if known.

messageTypestringrequired

High-level classification of the message.

Enum"system""user""integration""alert""reminder""other"
prioritystringrequired

Relative importance of the message.

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

Timestamp when the message was first read, if tracked.

Example: "2025-01-01T00:00:00.000Z"
relatedEntitiesArray of objects(RelatedEntitieDto)required

References to entities this message is about (e.g., animal, appointment, invoice).

relatedEntities[].​displaystring

Optional display label for the related entity.

relatedEntities[].​entityIdstringrequired

Identifier of the related entity.

Example: "123e4567-e89b-12d3-a456-426614174000"
relatedEntities[].​entityTypestringrequired

Type of the related entity.

Enum"animal""client""appointment""invoice""medicalRecord""task""other"
sentAtstringrequired

Timestamp when the message was sent or made available to recipients.

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

Current lifecycle status of the message.

Enum"draft""queued""sent""delivered""read""failed""cancelled""archived"
subjectstringrequired

Short subject or title of the message.

toArray of objects(ToDto)required

Primary recipients of the message.

to[].​contactIdstring

External contact recipient of the message.

Example: "123e4567-e89b-12d3-a456-426614174000"
to[].​displaystring

Human-readable name of the recipient.

to[].​userIdstring

User recipient of the message.

Example: "123e4567-e89b-12d3-a456-426614174000"
curl -i -X PUT \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/message/{messageId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "body": "string",
    "channel": "internal",
    "deliveredAt": "2025-01-01T00:00:00.000Z",
    "extensions": {},
    "from": {},
    "messageType": "system",
    "priority": "low",
    "readAt": "2025-01-01T00:00:00.000Z",
    "relatedEntities": [
      {
        "display": "string",
        "entityId": "123e4567-e89b-12d3-a456-426614174000",
        "entityType": "animal"
      }
    ],
    "sentAt": "2025-01-01T00:00:00.000Z",
    "status": "draft",
    "subject": "string",
    "to": [
      {
        "contactId": "123e4567-e89b-12d3-a456-426614174000",
        "display": "string",
        "userId": "123e4567-e89b-12d3-a456-426614174000"
      }
    ]
  }'

Responses

Message replaced successfully

Bodyapplication/json
bodystringrequired

Full content of the message.

channelstringrequired

Primary communication channel used to deliver the message.

Enum"internal""email""sms""phone""push""portal""other"
createdAtstring(date-time)required

Timestamp when the message record was created.

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

Timestamp when the message was delivered to the recipient's channel, if known.

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

Vendor- or practice-specific extensions.

fromobjectrequired

Sender of the message, if known.

messageIdstringrequired

Canonical unique identifier for the message.

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

High-level classification of the message.

Enum"system""user""integration""alert""reminder""other"
prioritystringrequired

Relative importance of the message.

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

Timestamp when the message was first read, if tracked.

Example: "2025-01-01T00:00:00.000Z"
relatedEntitiesArray of objects(RelatedEntitieDto)required

References to entities this message is about (e.g., animal, appointment, invoice).

relatedEntities[].​displaystring

Optional display label for the related entity.

relatedEntities[].​entityIdstringrequired

Identifier of the related entity.

Example: "123e4567-e89b-12d3-a456-426614174000"
relatedEntities[].​entityTypestringrequired

Type of the related entity.

Enum"animal""client""appointment""invoice""medicalRecord""task""other"
sentAtstring(date-time)required

Timestamp when the message was sent or made available to recipients.

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

Current lifecycle status of the message.

Enum"draft""queued""sent""delivered""read""failed""cancelled""archived"
subjectstringrequired

Short subject or title of the message.

toArray of objects(ToDto)required

Primary recipients of the message.

to[].​contactIdstring

External contact recipient of the message.

Example: "123e4567-e89b-12d3-a456-426614174000"
to[].​displaystring

Human-readable name of the recipient.

to[].​userIdstring

User recipient of the message.

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

Timestamp when the message record was last updated.

Example: "2025-01-01T00:00:00.000Z"
Response
application/json
{
  "body": "string",
  "channel": "internal",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "deliveredAt": "2025-01-01T00:00:00.000Z",
  "extensions": {},
  "from": {},
  "messageId": "123e4567-e89b-12d3-a456-426614174000",
  "messageType": "system",
  "priority": "low",
  "readAt": "2025-01-01T00:00:00.000Z",
  "relatedEntities": [
    { … }
  ],
  "sentAt": "2025-01-01T00:00:00.000Z",
  "status": "draft",
  "subject": "string",
  "to": [
    { … }
  ],
  "updatedAt": "2025-01-01T00:00:00.000Z"
}

Delete message

Request

Permanently deletes a Message record.

Security
bearer
Path
siteIdnumberrequired

Site identifier

messageIdstringrequired

Message unique identifier (UUID)

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

Responses

Message deleted successfully

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