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

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

List contacts

Request

Returns a paginated list of Contacts 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""businessName""code""birthDate""driverLicenseExpiryDate""driverLicenseIssuer""driverLicenseNumber""firstName""lastName"
sortOrderstring

Sort order

Default "asc"
Enum"asc""desc"
businessNamestring

Registered or trading name if the contact is a business.

codestring

Practice-specific human-readable contact code.

creditStatusstring

Credit status for the contact.

Enum"OK""WARNING""STOP"
driverLicenseIssuerstring

Issuing authority or jurisdiction for the driver license.

driverLicenseNumberstring

Driver license number, if captured.

firstNamestring

Given name of the contact.

isBusinessboolean

True if the contact represents a business entity.

isCustomerboolean

True if the contact is a customer.

isStaffMemberboolean

True if the contact is a staff member of the practice.

isSupplierboolean

True if the contact is a supplier.

isSyndicateboolean

True if the contact is a syndicate or group owner.

isVetboolean

True if the contact is a veterinarian.

lastNamestring

Family name of the contact.

ownershipIdstring

Identifier for the owning organization or business unit.

Example: ownershipId=123e4567-e89b-12d3-a456-426614174000
physicalAddressstring

Primary physical address for the contact.

postalAddressstring

Primary postal/mailing address for the contact.

curl -i -X GET \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/contact?page=0&pageSize=10&sortBy=createdAt&sortOrder=asc&businessName=string&code=string&creditStatus=OK&driverLicenseIssuer=string&driverLicenseNumber=string&firstName=string&isBusiness=true&isCustomer=true&isStaffMember=true&isSupplier=true&isSyndicate=true&isVet=true&lastName=string&ownershipId=123e4567-e89b-12d3-a456-426614174000&physicalAddress=string&postalAddress=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Paginated list of Contacts

Get contact

Request

Returns a single Contact by its unique identifier.

Security
bearer
Path
siteIdnumberrequired

Site identifier

contactIdstringrequired

Contact unique identifier (UUID)

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

Responses

Contact found

Bodyapplication/json
businessNamestringrequired

Registered or trading name if the contact is a business.

Example: "Example Name"
codestringrequired

Practice-specific human-readable contact code.

Example: "CODE-001"
contactDetailsArray of objects(ContactDetailDto)required

List of contact details such as phone numbers and email addresses.

contactDetails[].​contactDetailIdstringrequired

Canonical identifier for this contact detail.

Example: "123e4567-e89b-12d3-a456-426614174000"
contactDetails[].​contactDetailTypeobjectrequired
contactDetails[].​contactDetailType.​codestringrequired

Code value

Example: "12345"
contactDetails[].​contactDetailType.​systemstringrequired

Code system URI

Example: "http://example.com/codesystem"
contactDetails[].​contactDetailType.​displaystring

Human-readable display

Example: "Example Display Name"
contactDetails[].​contactIdstringrequired

Identifier of the contact this detail belongs to.

Example: "123e4567-e89b-12d3-a456-426614174000"
contactDetails[].​createdAtstringrequired

Timestamp when this contact detail was created.

Example: "2025-01-01T00:00:00.000Z"
contactDetails[].​extensionsobject

Vendor- or practice-specific extensions.

contactDetails[].​isActiveboolean

Whether this contact detail is currently active.

Example: true
contactDetails[].​isPreferredboolean

Whether this is the preferred contact detail of its type for the contact.

Example: true
contactDetails[].​namestringrequired

Label or type name for the contact detail (e.g. 'Home phone', 'Email').

Example: "Example Name"
contactDetails[].​subscriptionGroupsArray of strings

Identifiers of communication subscription groups associated with this contact detail.

contactDetails[].​updatedAtstringrequired

Timestamp when this contact detail was last updated.

Example: "2025-01-01T00:00:00.000Z"
contactDetails[].​valuestringrequired

Raw value of the contact detail (e.g. phone number, email address).

Example: "user@example.com"
contactDetails[].​valueCleanedstring or null

System-normalized representation of the value, if available.

Example: "example"
contactIdstringrequired

Canonical unique identifier for the contact.

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

Timestamp when the contact was created.

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

Credit status for the contact.

Enum"OK""WARNING""STOP"
Example: "OK"
birthDatestring(date-time)required

Date of birth of the contact, if applicable.

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

Expiry date of the driver license.

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

Issuing authority or jurisdiction for the driver license.

Example: "https://example.com"
driverLicenseNumberstringrequired

Driver license number, if captured.

Example: "example"
extensionsobjectrequired

Vendor- or practice-specific extensions.

firstNamestringrequired

Given name of the contact.

Example: "Example Name"
isBusinessbooleanrequired

True if the contact represents a business entity.

Example: true
isCustomerbooleanrequired

True if the contact is a customer.

Example: true
isStaffMemberbooleanrequired

True if the contact is a staff member of the practice.

Example: true
isSupplierbooleanrequired

True if the contact is a supplier.

Example: true
isSyndicatebooleanrequired

True if the contact is a syndicate or group owner.

Example: true
isVetbooleanrequired

True if the contact is a veterinarian.

Example: true
lastNamestringrequired

Family name of the contact.

Example: "Example Name"
ownershipIdstringrequired

Identifier for the owning organization or business unit.

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

Primary physical address for the contact.

Example: "example"
postalAddressstringrequired

Primary postal/mailing address for the contact.

Example: "example"
updatedAtstring(date-time)required

Timestamp when the contact was last updated.

Example: "2025-01-01T00:00:00.000Z"
creditStatusConceptobjectrequired
creditStatusConcept.​codestringrequired

Code value

Example: "12345"
creditStatusConcept.​systemstringrequired

Code system URI

Example: "http://example.com/codesystem"
creditStatusConcept.​displaystring

Human-readable display

Example: "Example Display Name"
Response
application/json
{
  "businessName": "Example Name",
  "code": "CODE-001",
  "contactDetails": [
    { … }
  ],
  "contactId": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "creditStatus": "OK",
  "birthDate": "2025-01-01T00:00:00Z",
  "driverLicenseExpiryDate": "2025-01-01T00:00:00Z",
  "driverLicenseIssuer": "https://example.com",
  "driverLicenseNumber": "example",
  "extensions": {},
  "firstName": "Example Name",
  "isBusiness": true,
  "isCustomer": true,
  "isStaffMember": true,
  "isSupplier": true,
  "isSyndicate": true,
  "isVet": true,
  "lastName": "Example Name",
  "ownershipId": "123e4567-e89b-12d3-a456-426614174000",
  "physicalAddress": "example",
  "postalAddress": "example",
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "creditStatusConcept": {
    "code": "12345",
    "system": "http://example.com/codesystem",
    "display": "Example Display Name"
  }
}

Update contact

Request

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

Security
bearer
Path
siteIdnumberrequired

Site identifier

contactIdstringrequired

Contact unique identifier (UUID)

Bodyapplication/jsonrequired
businessNamestring

Registered or trading name if the contact is a business.

Example: "Example Name"
codestring

Practice-specific human-readable contact code.

Example: "CODE-001"
contactDetailsArray of objects(ContactDetailDto)

List of contact details such as phone numbers and email addresses.

creditStatusstring

Credit status for the contact.

Enum"OK""WARNING""STOP"
Example: "OK"
birthDatestring

Date of birth of the contact, if applicable.

Example: "2025-01-01"
driverLicenseExpiryDatestring

Expiry date of the driver license.

Example: "2025-01-01"
driverLicenseIssuerstring

Issuing authority or jurisdiction for the driver license.

Example: "https://example.com"
driverLicenseNumberstring

Driver license number, if captured.

Example: "example"
extensionsobject

Vendor- or practice-specific extensions.

firstNamestring

Given name of the contact.

Example: "Example Name"
isBusinessboolean

True if the contact represents a business entity.

Example: true
isCustomerboolean

True if the contact is a customer.

Example: true
isStaffMemberboolean

True if the contact is a staff member of the practice.

Example: true
isSupplierboolean

True if the contact is a supplier.

Example: true
isSyndicateboolean

True if the contact is a syndicate or group owner.

Example: true
isVetboolean

True if the contact is a veterinarian.

Example: true
lastNamestring

Family name of the contact.

Example: "Example Name"
ownershipIdstring

Identifier for the owning organization or business unit.

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

Primary physical address for the contact.

Example: "example"
postalAddressstring

Primary postal/mailing address for the contact.

Example: "example"
creditStatusConceptobject
curl -i -X PATCH \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/contact/{contactId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "businessName": "Example Name",
    "code": "CODE-001",
    "contactDetails": [
      {
        "contactDetailId": "123e4567-e89b-12d3-a456-426614174000",
        "contactDetailType": {
          "code": "12345",
          "system": "http://example.com/codesystem",
          "display": "Example Display Name"
        },
        "contactId": "123e4567-e89b-12d3-a456-426614174000",
        "createdAt": "2025-01-01T00:00:00.000Z",
        "extensions": {},
        "isActive": true,
        "isPreferred": true,
        "name": "Example Name",
        "subscriptionGroups": [
          "string"
        ],
        "updatedAt": "2025-01-01T00:00:00.000Z",
        "value": "user@example.com",
        "valueCleaned": "example"
      }
    ],
    "creditStatus": "OK",
    "birthDate": "2025-01-01",
    "driverLicenseExpiryDate": "2025-01-01",
    "driverLicenseIssuer": "https://example.com",
    "driverLicenseNumber": "example",
    "extensions": {},
    "firstName": "Example Name",
    "isBusiness": true,
    "isCustomer": true,
    "isStaffMember": true,
    "isSupplier": true,
    "isSyndicate": true,
    "isVet": true,
    "lastName": "Example Name",
    "ownershipId": "123e4567-e89b-12d3-a456-426614174000",
    "physicalAddress": "example",
    "postalAddress": "example",
    "creditStatusConcept": {
      "code": "12345",
      "system": "http://example.com/codesystem",
      "display": "Example Display Name"
    }
  }'

Responses

Contact updated successfully

Bodyapplication/json
businessNamestringrequired

Registered or trading name if the contact is a business.

Example: "Example Name"
codestringrequired

Practice-specific human-readable contact code.

Example: "CODE-001"
contactDetailsArray of objects(ContactDetailDto)required

List of contact details such as phone numbers and email addresses.

contactDetails[].​contactDetailIdstringrequired

Canonical identifier for this contact detail.

Example: "123e4567-e89b-12d3-a456-426614174000"
contactDetails[].​contactDetailTypeobjectrequired
contactDetails[].​contactDetailType.​codestringrequired

Code value

Example: "12345"
contactDetails[].​contactDetailType.​systemstringrequired

Code system URI

Example: "http://example.com/codesystem"
contactDetails[].​contactDetailType.​displaystring

Human-readable display

Example: "Example Display Name"
contactDetails[].​contactIdstringrequired

Identifier of the contact this detail belongs to.

Example: "123e4567-e89b-12d3-a456-426614174000"
contactDetails[].​createdAtstringrequired

Timestamp when this contact detail was created.

Example: "2025-01-01T00:00:00.000Z"
contactDetails[].​extensionsobject

Vendor- or practice-specific extensions.

contactDetails[].​isActiveboolean

Whether this contact detail is currently active.

Example: true
contactDetails[].​isPreferredboolean

Whether this is the preferred contact detail of its type for the contact.

Example: true
contactDetails[].​namestringrequired

Label or type name for the contact detail (e.g. 'Home phone', 'Email').

Example: "Example Name"
contactDetails[].​subscriptionGroupsArray of strings

Identifiers of communication subscription groups associated with this contact detail.

contactDetails[].​updatedAtstringrequired

Timestamp when this contact detail was last updated.

Example: "2025-01-01T00:00:00.000Z"
contactDetails[].​valuestringrequired

Raw value of the contact detail (e.g. phone number, email address).

Example: "user@example.com"
contactDetails[].​valueCleanedstring or null

System-normalized representation of the value, if available.

Example: "example"
contactIdstringrequired

Canonical unique identifier for the contact.

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

Timestamp when the contact was created.

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

Credit status for the contact.

Enum"OK""WARNING""STOP"
Example: "OK"
birthDatestring(date-time)required

Date of birth of the contact, if applicable.

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

Expiry date of the driver license.

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

Issuing authority or jurisdiction for the driver license.

Example: "https://example.com"
driverLicenseNumberstringrequired

Driver license number, if captured.

Example: "example"
extensionsobjectrequired

Vendor- or practice-specific extensions.

firstNamestringrequired

Given name of the contact.

Example: "Example Name"
isBusinessbooleanrequired

True if the contact represents a business entity.

Example: true
isCustomerbooleanrequired

True if the contact is a customer.

Example: true
isStaffMemberbooleanrequired

True if the contact is a staff member of the practice.

Example: true
isSupplierbooleanrequired

True if the contact is a supplier.

Example: true
isSyndicatebooleanrequired

True if the contact is a syndicate or group owner.

Example: true
isVetbooleanrequired

True if the contact is a veterinarian.

Example: true
lastNamestringrequired

Family name of the contact.

Example: "Example Name"
ownershipIdstringrequired

Identifier for the owning organization or business unit.

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

Primary physical address for the contact.

Example: "example"
postalAddressstringrequired

Primary postal/mailing address for the contact.

Example: "example"
updatedAtstring(date-time)required

Timestamp when the contact was last updated.

Example: "2025-01-01T00:00:00.000Z"
creditStatusConceptobjectrequired
creditStatusConcept.​codestringrequired

Code value

Example: "12345"
creditStatusConcept.​systemstringrequired

Code system URI

Example: "http://example.com/codesystem"
creditStatusConcept.​displaystring

Human-readable display

Example: "Example Display Name"
Response
application/json
{
  "businessName": "Example Name",
  "code": "CODE-001",
  "contactDetails": [
    { … }
  ],
  "contactId": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "creditStatus": "OK",
  "birthDate": "2025-01-01T00:00:00Z",
  "driverLicenseExpiryDate": "2025-01-01T00:00:00Z",
  "driverLicenseIssuer": "https://example.com",
  "driverLicenseNumber": "example",
  "extensions": {},
  "firstName": "Example Name",
  "isBusiness": true,
  "isCustomer": true,
  "isStaffMember": true,
  "isSupplier": true,
  "isSyndicate": true,
  "isVet": true,
  "lastName": "Example Name",
  "ownershipId": "123e4567-e89b-12d3-a456-426614174000",
  "physicalAddress": "example",
  "postalAddress": "example",
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "creditStatusConcept": {
    "code": "12345",
    "system": "http://example.com/codesystem",
    "display": "Example Display Name"
  }
}

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