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

Create taxrate

Request

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

Security
bearer
Path
siteIdnumberrequired

Site identifier

Bodyapplication/jsonrequired
codestringrequired

Human-readable tax code or label (e.g., 'GST', 'VAT15').

extensionsobject

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether this tax rate is currently active and can be used for billing.

ratenumberrequired

Tax rate as a decimal fraction (e.g., 0.15 for 15%).

taxrateIdstringrequired

Canonical unique identifier for the tax rate.

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

Human-readable description of the tax jurisdiction or authority this rate applies to (e.g., 'NZ national', 'CA-ON provincial').

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

Responses

Taxrate created successfully

Bodyapplication/json
codestringrequired

Human-readable tax code or label (e.g., 'GST', 'VAT15').

createdAtstring(date-time)required

Timestamp when the tax rate record was created.

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

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether this tax rate is currently active and can be used for billing.

ratenumberrequired

Tax rate as a decimal fraction (e.g., 0.15 for 15%).

taxrateIdstringrequired

Canonical unique identifier for the tax rate.

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

Timestamp when the tax rate record was last updated.

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

Human-readable description of the tax jurisdiction or authority this rate applies to (e.g., 'NZ national', 'CA-ON provincial').

Response
application/json
{
  "code": "string",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "extensions": {},
  "isActive": true,
  "rate": 0,
  "taxrateId": "123e4567-e89b-12d3-a456-426614174000",
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "jurisdiction": "string"
}

List taxrates

Request

Returns a paginated list of Taxrates 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""rate""jurisdiction"
sortOrderstring

Sort order

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

Human-readable tax code or label (e.g., 'GST', 'VAT15').

isActiveboolean

Whether this tax rate is currently active and can be used for billing.

jurisdictionstring

Human-readable description of the tax jurisdiction or authority this rate applies to (e.g., 'NZ national', 'CA-ON provincial').

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

Responses

Paginated list of Taxrates

Get taxrate

Request

Returns a single Taxrate by its unique identifier.

Security
bearer
Path
siteIdnumberrequired

Site identifier

taxrateIdstringrequired

Taxrate unique identifier (UUID)

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

Responses

Taxrate found

Bodyapplication/json
codestringrequired

Human-readable tax code or label (e.g., 'GST', 'VAT15').

createdAtstring(date-time)required

Timestamp when the tax rate record was created.

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

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether this tax rate is currently active and can be used for billing.

ratenumberrequired

Tax rate as a decimal fraction (e.g., 0.15 for 15%).

taxrateIdstringrequired

Canonical unique identifier for the tax rate.

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

Timestamp when the tax rate record was last updated.

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

Human-readable description of the tax jurisdiction or authority this rate applies to (e.g., 'NZ national', 'CA-ON provincial').

Response
application/json
{
  "code": "string",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "extensions": {},
  "isActive": true,
  "rate": 0,
  "taxrateId": "123e4567-e89b-12d3-a456-426614174000",
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "jurisdiction": "string"
}

Update taxrate

Request

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

Security
bearer
Path
siteIdnumberrequired

Site identifier

taxrateIdstringrequired

Taxrate unique identifier (UUID)

Bodyapplication/jsonrequired
codestring

Human-readable tax code or label (e.g., 'GST', 'VAT15').

extensionsobject

Vendor- or practice-specific extensions.

isActiveboolean

Whether this tax rate is currently active and can be used for billing.

ratenumber

Tax rate as a decimal fraction (e.g., 0.15 for 15%).

jurisdictionstring

Human-readable description of the tax jurisdiction or authority this rate applies to (e.g., 'NZ national', 'CA-ON provincial').

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

Responses

Taxrate updated successfully

Bodyapplication/json
codestringrequired

Human-readable tax code or label (e.g., 'GST', 'VAT15').

createdAtstring(date-time)required

Timestamp when the tax rate record was created.

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

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether this tax rate is currently active and can be used for billing.

ratenumberrequired

Tax rate as a decimal fraction (e.g., 0.15 for 15%).

taxrateIdstringrequired

Canonical unique identifier for the tax rate.

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

Timestamp when the tax rate record was last updated.

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

Human-readable description of the tax jurisdiction or authority this rate applies to (e.g., 'NZ national', 'CA-ON provincial').

Response
application/json
{
  "code": "string",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "extensions": {},
  "isActive": true,
  "rate": 0,
  "taxrateId": "123e4567-e89b-12d3-a456-426614174000",
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "jurisdiction": "string"
}

Replace taxrate

Request

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

Security
bearer
Path
siteIdnumberrequired

Site identifier

taxrateIdstringrequired

Taxrate unique identifier (UUID)

Bodyapplication/jsonrequired
codestringrequired

Human-readable tax code or label (e.g., 'GST', 'VAT15').

extensionsobjectrequired

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether this tax rate is currently active and can be used for billing.

ratenumberrequired

Tax rate as a decimal fraction (e.g., 0.15 for 15%).

jurisdictionstringrequired

Human-readable description of the tax jurisdiction or authority this rate applies to (e.g., 'NZ national', 'CA-ON provincial').

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

Responses

Taxrate replaced successfully

Bodyapplication/json
codestringrequired

Human-readable tax code or label (e.g., 'GST', 'VAT15').

createdAtstring(date-time)required

Timestamp when the tax rate record was created.

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

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether this tax rate is currently active and can be used for billing.

ratenumberrequired

Tax rate as a decimal fraction (e.g., 0.15 for 15%).

taxrateIdstringrequired

Canonical unique identifier for the tax rate.

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

Timestamp when the tax rate record was last updated.

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

Human-readable description of the tax jurisdiction or authority this rate applies to (e.g., 'NZ national', 'CA-ON provincial').

Response
application/json
{
  "code": "string",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "extensions": {},
  "isActive": true,
  "rate": 0,
  "taxrateId": "123e4567-e89b-12d3-a456-426614174000",
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "jurisdiction": "string"
}

Delete taxrate

Request

Permanently deletes a Taxrate record.

Security
bearer
Path
siteIdnumberrequired

Site identifier

taxrateIdstringrequired

Taxrate unique identifier (UUID)

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

Responses

Taxrate deleted successfully

Template

Operations

Therapeutic

Operations

Transaction

Operations

User

Operations

Vaccination

Operations

Webhook

Operations

Webhook Event

Operations

Wellness Resource

Operations

With Primary Inventory Location

Operations