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/

Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations

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" }

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

Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations