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

Create insurance

Request

Creates a new Insurance record. Pet or livestock insurance policy information.

Security
bearer
Path
siteIdnumberrequired

Site identifier

Bodyapplication/jsonrequired
insuranceIdstringrequired

Canonical unique identifier for the insurance record.

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

Insurance policy number.

providerobject
animalIdstring

Reference to the insured animal.

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

Reference to the policy holder contact.

Example: "123e4567-e89b-12d3-a456-426614174000"
coverageTypeobject
effectiveDatestring

Date the policy becomes effective.

Example: "2025-01-01"
expiryDatestring

Date the policy expires.

Example: "2025-01-01"
isActiveboolean

Whether the policy is currently active.

extensionsobject

Vendor- or practice-specific extensions.

curl -i -X POST \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/insurance' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "insuranceId": "123e4567-e89b-12d3-a456-426614174000",
    "policyNumber": "string",
    "provider": {
      "code": "string",
      "system": "string",
      "display": "string"
    },
    "animalId": "123e4567-e89b-12d3-a456-426614174000",
    "contactId": "123e4567-e89b-12d3-a456-426614174000",
    "coverageType": {
      "code": "string",
      "system": "string",
      "display": "string"
    },
    "effectiveDate": "2025-01-01",
    "expiryDate": "2025-01-01",
    "isActive": true,
    "extensions": {}
  }'

Responses

Insurance created successfully

Bodyapplication/json
insuranceIdstringrequired

Canonical unique identifier for the insurance record.

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

Insurance policy number.

providerobjectrequired
provider.​codestringrequired

Code value

provider.​systemstringrequired

Code system URI

provider.​displaystring

Human-readable display

animalIdstringrequired

Reference to the insured animal.

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

Reference to the policy holder contact.

Example: "123e4567-e89b-12d3-a456-426614174000"
coverageTypeobjectrequired
coverageType.​codestringrequired

Code value

coverageType.​systemstringrequired

Code system URI

coverageType.​displaystring

Human-readable display

effectiveDatestring(date-time)required

Date the policy becomes effective.

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

Date the policy expires.

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

Whether the policy is currently active.

createdAtstring(date-time)required

Timestamp when the insurance record was created.

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

Timestamp when the insurance record was last updated.

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

Vendor- or practice-specific extensions.

Response
application/json
{
  "insuranceId": "123e4567-e89b-12d3-a456-426614174000",
  "policyNumber": "string",
  "provider": {
    "code": "string",
    "system": "string",
    "display": "string"
  },
  "animalId": "123e4567-e89b-12d3-a456-426614174000",
  "contactId": "123e4567-e89b-12d3-a456-426614174000",
  "coverageType": {
    "code": "string",
    "system": "string",
    "display": "string"
  },
  "effectiveDate": "2025-01-01T00:00:00Z",
  "expiryDate": "2025-01-01T00:00:00Z",
  "isActive": true,
  "createdAt": "2025-01-01T00:00:00.000Z",
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "extensions": {}
}

List insurances

Request

Returns a paginated list of Insurances 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""policyNumber""effectiveDate""expiryDate"
sortOrderstring

Sort order

Default "asc"
Enum"asc""desc"
policyNumberstring

Insurance policy number.

animalIdstring

Reference to the insured animal.

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

Reference to the policy holder contact.

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

Whether the policy is currently active.

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

Responses

Paginated list of Insurances

Get insurance

Request

Returns a single Insurance by its unique identifier.

Security
bearer
Path
siteIdnumberrequired

Site identifier

insuranceIdstringrequired

Insurance unique identifier (UUID)

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

Responses

Insurance found

Bodyapplication/json
insuranceIdstringrequired

Canonical unique identifier for the insurance record.

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

Insurance policy number.

providerobjectrequired
provider.​codestringrequired

Code value

provider.​systemstringrequired

Code system URI

provider.​displaystring

Human-readable display

animalIdstringrequired

Reference to the insured animal.

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

Reference to the policy holder contact.

Example: "123e4567-e89b-12d3-a456-426614174000"
coverageTypeobjectrequired
coverageType.​codestringrequired

Code value

coverageType.​systemstringrequired

Code system URI

coverageType.​displaystring

Human-readable display

effectiveDatestring(date-time)required

Date the policy becomes effective.

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

Date the policy expires.

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

Whether the policy is currently active.

createdAtstring(date-time)required

Timestamp when the insurance record was created.

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

Timestamp when the insurance record was last updated.

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

Vendor- or practice-specific extensions.

Response
application/json
{
  "insuranceId": "123e4567-e89b-12d3-a456-426614174000",
  "policyNumber": "string",
  "provider": {
    "code": "string",
    "system": "string",
    "display": "string"
  },
  "animalId": "123e4567-e89b-12d3-a456-426614174000",
  "contactId": "123e4567-e89b-12d3-a456-426614174000",
  "coverageType": {
    "code": "string",
    "system": "string",
    "display": "string"
  },
  "effectiveDate": "2025-01-01T00:00:00Z",
  "expiryDate": "2025-01-01T00:00:00Z",
  "isActive": true,
  "createdAt": "2025-01-01T00:00:00.000Z",
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "extensions": {}
}

Update insurance

Request

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

Security
bearer
Path
siteIdnumberrequired

Site identifier

insuranceIdstringrequired

Insurance unique identifier (UUID)

Bodyapplication/jsonrequired
policyNumberstring

Insurance policy number.

providerobject
animalIdstring

Reference to the insured animal.

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

Reference to the policy holder contact.

Example: "123e4567-e89b-12d3-a456-426614174000"
coverageTypeobject
effectiveDatestring

Date the policy becomes effective.

Example: "2025-01-01"
expiryDatestring

Date the policy expires.

Example: "2025-01-01"
isActiveboolean

Whether the policy is currently active.

extensionsobject

Vendor- or practice-specific extensions.

curl -i -X PATCH \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/insurance/{insuranceId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "policyNumber": "string",
    "provider": {
      "code": "string",
      "system": "string",
      "display": "string"
    },
    "animalId": "123e4567-e89b-12d3-a456-426614174000",
    "contactId": "123e4567-e89b-12d3-a456-426614174000",
    "coverageType": {
      "code": "string",
      "system": "string",
      "display": "string"
    },
    "effectiveDate": "2025-01-01",
    "expiryDate": "2025-01-01",
    "isActive": true,
    "extensions": {}
  }'

Responses

Insurance updated successfully

Bodyapplication/json
insuranceIdstringrequired

Canonical unique identifier for the insurance record.

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

Insurance policy number.

providerobjectrequired
provider.​codestringrequired

Code value

provider.​systemstringrequired

Code system URI

provider.​displaystring

Human-readable display

animalIdstringrequired

Reference to the insured animal.

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

Reference to the policy holder contact.

Example: "123e4567-e89b-12d3-a456-426614174000"
coverageTypeobjectrequired
coverageType.​codestringrequired

Code value

coverageType.​systemstringrequired

Code system URI

coverageType.​displaystring

Human-readable display

effectiveDatestring(date-time)required

Date the policy becomes effective.

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

Date the policy expires.

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

Whether the policy is currently active.

createdAtstring(date-time)required

Timestamp when the insurance record was created.

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

Timestamp when the insurance record was last updated.

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

Vendor- or practice-specific extensions.

Response
application/json
{
  "insuranceId": "123e4567-e89b-12d3-a456-426614174000",
  "policyNumber": "string",
  "provider": {
    "code": "string",
    "system": "string",
    "display": "string"
  },
  "animalId": "123e4567-e89b-12d3-a456-426614174000",
  "contactId": "123e4567-e89b-12d3-a456-426614174000",
  "coverageType": {
    "code": "string",
    "system": "string",
    "display": "string"
  },
  "effectiveDate": "2025-01-01T00:00:00Z",
  "expiryDate": "2025-01-01T00:00:00Z",
  "isActive": true,
  "createdAt": "2025-01-01T00:00:00.000Z",
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "extensions": {}
}

Replace insurance

Request

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

Security
bearer
Path
siteIdnumberrequired

Site identifier

insuranceIdstringrequired

Insurance unique identifier (UUID)

Bodyapplication/jsonrequired
policyNumberstringrequired

Insurance policy number.

providerobjectrequired
provider.​codestringrequired

Code value

provider.​systemstringrequired

Code system URI

provider.​displaystring

Human-readable display

animalIdstringrequired

Reference to the insured animal.

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

Reference to the policy holder contact.

Example: "123e4567-e89b-12d3-a456-426614174000"
coverageTypeobjectrequired
coverageType.​codestringrequired

Code value

coverageType.​systemstringrequired

Code system URI

coverageType.​displaystring

Human-readable display

effectiveDatestringrequired

Date the policy becomes effective.

Example: "2025-01-01"
expiryDatestringrequired

Date the policy expires.

Example: "2025-01-01"
isActivebooleanrequired

Whether the policy is currently active.

extensionsobjectrequired

Vendor- or practice-specific extensions.

curl -i -X PUT \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/insurance/{insuranceId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "policyNumber": "string",
    "provider": {
      "code": "string",
      "system": "string",
      "display": "string"
    },
    "animalId": "123e4567-e89b-12d3-a456-426614174000",
    "contactId": "123e4567-e89b-12d3-a456-426614174000",
    "coverageType": {
      "code": "string",
      "system": "string",
      "display": "string"
    },
    "effectiveDate": "2025-01-01",
    "expiryDate": "2025-01-01",
    "isActive": true,
    "extensions": {}
  }'

Responses

Insurance replaced successfully

Bodyapplication/json
insuranceIdstringrequired

Canonical unique identifier for the insurance record.

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

Insurance policy number.

providerobjectrequired
provider.​codestringrequired

Code value

provider.​systemstringrequired

Code system URI

provider.​displaystring

Human-readable display

animalIdstringrequired

Reference to the insured animal.

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

Reference to the policy holder contact.

Example: "123e4567-e89b-12d3-a456-426614174000"
coverageTypeobjectrequired
coverageType.​codestringrequired

Code value

coverageType.​systemstringrequired

Code system URI

coverageType.​displaystring

Human-readable display

effectiveDatestring(date-time)required

Date the policy becomes effective.

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

Date the policy expires.

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

Whether the policy is currently active.

createdAtstring(date-time)required

Timestamp when the insurance record was created.

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

Timestamp when the insurance record was last updated.

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

Vendor- or practice-specific extensions.

Response
application/json
{
  "insuranceId": "123e4567-e89b-12d3-a456-426614174000",
  "policyNumber": "string",
  "provider": {
    "code": "string",
    "system": "string",
    "display": "string"
  },
  "animalId": "123e4567-e89b-12d3-a456-426614174000",
  "contactId": "123e4567-e89b-12d3-a456-426614174000",
  "coverageType": {
    "code": "string",
    "system": "string",
    "display": "string"
  },
  "effectiveDate": "2025-01-01T00:00:00Z",
  "expiryDate": "2025-01-01T00:00:00Z",
  "isActive": true,
  "createdAt": "2025-01-01T00:00:00.000Z",
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "extensions": {}
}

Delete insurance

Request

Permanently deletes a Insurance record.

Security
bearer
Path
siteIdnumberrequired

Site identifier

insuranceIdstringrequired

Insurance unique identifier (UUID)

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

Responses

Insurance deleted successfully

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