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

System Setting

Operations

Tag

Operations

Tagcategory

Operations

Tagname

Operations

Taxrate

Operations

Template

Operations

Therapeutic

Operations

Transaction

Operations

User

Operations

Create user

Request

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

Security
bearer
Path
siteIdnumberrequired

Site identifier

Bodyapplication/jsonrequired
codestring

Practice-specific short code or identifier for the user.

displayNamestringrequired

Human-readable display name for the user.

extensionsobject

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether the user is active and can be used in workflows.

isSalespersonboolean

Whether the user is a salesperson.

isVeterinarianboolean

Whether the user is a veterinarian.

userIdstringrequired

Canonical unique identifier for the user.

Example: "123e4567-e89b-12d3-a456-426614174000"
curl -i -X POST \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/user' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "code": "string",
    "displayName": "string",
    "extensions": {},
    "isActive": true,
    "isSalesperson": true,
    "isVeterinarian": true,
    "userId": "123e4567-e89b-12d3-a456-426614174000"
  }'

Responses

User created successfully

Bodyapplication/json
codestringrequired

Practice-specific short code or identifier for the user.

createdAtstring(date-time)required

Timestamp when the user record was created.

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

Human-readable display name for the user.

extensionsobjectrequired

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether the user is active and can be used in workflows.

isSalespersonbooleanrequired

Whether the user is a salesperson.

isVeterinarianbooleanrequired

Whether the user is a veterinarian.

updatedAtstring(date-time)required

Timestamp when the user record was last updated.

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

Canonical unique identifier for the user.

Example: "123e4567-e89b-12d3-a456-426614174000"
Response
application/json
{
  "code": "string",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "displayName": "string",
  "extensions": {},
  "isActive": true,
  "isSalesperson": true,
  "isVeterinarian": true,
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "userId": "123e4567-e89b-12d3-a456-426614174000"
}

List users

Request

Returns a paginated list of Users 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""code""displayName"
sortOrderstring

Sort order

Default "asc"
Enum"asc""desc"
codestring

Practice-specific short code or identifier for the user.

displayNamestring

Human-readable display name for the user.

isActiveboolean

Whether the user is active and can be used in workflows.

isSalespersonboolean

Whether the user is a salesperson.

isVeterinarianboolean

Whether the user is a veterinarian.

curl -i -X GET \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/user?page=0&pageSize=10&sortBy=createdAt&sortOrder=asc&code=string&displayName=string&isActive=true&isSalesperson=true&isVeterinarian=true' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Paginated list of Users

Get user

Request

Returns a single User by its unique identifier.

Security
bearer
Path
siteIdnumberrequired

Site identifier

userIdstringrequired

User unique identifier (UUID)

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

Responses

User found

Bodyapplication/json
codestringrequired

Practice-specific short code or identifier for the user.

createdAtstring(date-time)required

Timestamp when the user record was created.

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

Human-readable display name for the user.

extensionsobjectrequired

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether the user is active and can be used in workflows.

isSalespersonbooleanrequired

Whether the user is a salesperson.

isVeterinarianbooleanrequired

Whether the user is a veterinarian.

updatedAtstring(date-time)required

Timestamp when the user record was last updated.

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

Canonical unique identifier for the user.

Example: "123e4567-e89b-12d3-a456-426614174000"
Response
application/json
{
  "code": "string",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "displayName": "string",
  "extensions": {},
  "isActive": true,
  "isSalesperson": true,
  "isVeterinarian": true,
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "userId": "123e4567-e89b-12d3-a456-426614174000"
}

Update user

Request

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

Security
bearer
Path
siteIdnumberrequired

Site identifier

userIdstringrequired

User unique identifier (UUID)

Bodyapplication/jsonrequired
codestring

Practice-specific short code or identifier for the user.

displayNamestring

Human-readable display name for the user.

extensionsobject

Vendor- or practice-specific extensions.

isActiveboolean

Whether the user is active and can be used in workflows.

isSalespersonboolean

Whether the user is a salesperson.

isVeterinarianboolean

Whether the user is a veterinarian.

curl -i -X PATCH \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/user/{userId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "code": "string",
    "displayName": "string",
    "extensions": {},
    "isActive": true,
    "isSalesperson": true,
    "isVeterinarian": true
  }'

Responses

User updated successfully

Bodyapplication/json
codestringrequired

Practice-specific short code or identifier for the user.

createdAtstring(date-time)required

Timestamp when the user record was created.

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

Human-readable display name for the user.

extensionsobjectrequired

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether the user is active and can be used in workflows.

isSalespersonbooleanrequired

Whether the user is a salesperson.

isVeterinarianbooleanrequired

Whether the user is a veterinarian.

updatedAtstring(date-time)required

Timestamp when the user record was last updated.

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

Canonical unique identifier for the user.

Example: "123e4567-e89b-12d3-a456-426614174000"
Response
application/json
{
  "code": "string",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "displayName": "string",
  "extensions": {},
  "isActive": true,
  "isSalesperson": true,
  "isVeterinarian": true,
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "userId": "123e4567-e89b-12d3-a456-426614174000"
}

Replace user

Request

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

Security
bearer
Path
siteIdnumberrequired

Site identifier

userIdstringrequired

User unique identifier (UUID)

Bodyapplication/jsonrequired
codestringrequired

Practice-specific short code or identifier for the user.

displayNamestringrequired

Human-readable display name for the user.

extensionsobjectrequired

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether the user is active and can be used in workflows.

isSalespersonbooleanrequired

Whether the user is a salesperson.

isVeterinarianbooleanrequired

Whether the user is a veterinarian.

curl -i -X PUT \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/user/{userId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "code": "string",
    "displayName": "string",
    "extensions": {},
    "isActive": true,
    "isSalesperson": true,
    "isVeterinarian": true
  }'

Responses

User replaced successfully

Bodyapplication/json
codestringrequired

Practice-specific short code or identifier for the user.

createdAtstring(date-time)required

Timestamp when the user record was created.

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

Human-readable display name for the user.

extensionsobjectrequired

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether the user is active and can be used in workflows.

isSalespersonbooleanrequired

Whether the user is a salesperson.

isVeterinarianbooleanrequired

Whether the user is a veterinarian.

updatedAtstring(date-time)required

Timestamp when the user record was last updated.

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

Canonical unique identifier for the user.

Example: "123e4567-e89b-12d3-a456-426614174000"
Response
application/json
{
  "code": "string",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "displayName": "string",
  "extensions": {},
  "isActive": true,
  "isSalesperson": true,
  "isVeterinarian": true,
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "userId": "123e4567-e89b-12d3-a456-426614174000"
}

Delete user

Request

Permanently deletes a User record.

Security
bearer
Path
siteIdnumberrequired

Site identifier

userIdstringrequired

User unique identifier (UUID)

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

Responses

User deleted successfully

Vaccination

Operations

Webhook

Operations

Webhook Event

Operations

Wellness Resource

Operations

With Primary Inventory Location

Operations