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

Create paymentmethod

Request

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

Security
bearer
Path
siteIdnumberrequired

Site identifier

Bodyapplication/jsonrequired
commissionRatestring

Commission rate as a decimal fraction (e.g., '0.025' for 2.5%).

extensionsobject

Vendor- or practice-specific extensions. Keys SHOULD be URIs or namespaced identifiers to avoid collisions.

isActivebooleanrequired

Whether this payment method is active and can be used.

namestringrequired

Human-readable name of the payment method (e.g., Cash, Visa).

paymentMethodTypestring

High-level category of the payment method.

Enum"cash""card""bankTransfer""check""online""other"
paymentmethodIdstringrequired

Canonical identifier for the payment method.

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

Configuration for any surcharge applied when using this payment method.

isUsingEftposTerminalboolean

Indicates if this payment method uses an EFTPOS/credit card terminal.

curl -i -X POST \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/paymentmethod' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "commissionRate": "string",
    "extensions": {},
    "isActive": true,
    "name": "string",
    "paymentMethodType": "cash",
    "paymentmethodId": "123e4567-e89b-12d3-a456-426614174000",
    "surcharge": {},
    "isUsingEftposTerminal": true
  }'

Responses

Paymentmethod created successfully

Bodyapplication/json
commissionRatestringrequired

Commission rate as a decimal fraction (e.g., '0.025' for 2.5%).

createdAtstring(date-time)required

Timestamp when the payment method was created, in RFC 3339 format with timezone offset.

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

Vendor- or practice-specific extensions. Keys SHOULD be URIs or namespaced identifiers to avoid collisions.

isActivebooleanrequired

Whether this payment method is active and can be used.

namestringrequired

Human-readable name of the payment method (e.g., Cash, Visa).

paymentMethodTypestringrequired

High-level category of the payment method.

Enum"cash""card""bankTransfer""check""online""other"
paymentmethodIdstringrequired

Canonical identifier for the payment method.

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

Configuration for any surcharge applied when using this payment method.

updatedAtstring(date-time)required

Timestamp when the payment method was last updated.

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

Indicates if this payment method uses an EFTPOS/credit card terminal.

Response
application/json
{
  "commissionRate": "string",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "extensions": {},
  "isActive": true,
  "name": "string",
  "paymentMethodType": "cash",
  "paymentmethodId": "123e4567-e89b-12d3-a456-426614174000",
  "surcharge": {},
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "isUsingEftposTerminal": true
}

List paymentmethods

Request

Returns a paginated list of Paymentmethods 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""commissionRate""name"
sortOrderstring

Sort order

Default "asc"
Enum"asc""desc"
commissionRatestring

Commission rate as a decimal fraction (e.g., '0.025' for 2.5%).

isActiveboolean

Whether this payment method is active and can be used.

namestring

Human-readable name of the payment method (e.g., Cash, Visa).

paymentMethodTypestring

High-level category of the payment method.

Enum"cash""card""bankTransfer""check""online""other"
isUsingEftposTerminalboolean

Indicates if this payment method uses an EFTPOS/credit card terminal.

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

Responses

Paginated list of Paymentmethods

Get paymentmethod

Request

Returns a single Paymentmethod by its unique identifier.

Security
bearer
Path
siteIdnumberrequired

Site identifier

paymentmethodIdstringrequired

Paymentmethod unique identifier (UUID)

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

Responses

Paymentmethod found

Bodyapplication/json
commissionRatestringrequired

Commission rate as a decimal fraction (e.g., '0.025' for 2.5%).

createdAtstring(date-time)required

Timestamp when the payment method was created, in RFC 3339 format with timezone offset.

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

Vendor- or practice-specific extensions. Keys SHOULD be URIs or namespaced identifiers to avoid collisions.

isActivebooleanrequired

Whether this payment method is active and can be used.

namestringrequired

Human-readable name of the payment method (e.g., Cash, Visa).

paymentMethodTypestringrequired

High-level category of the payment method.

Enum"cash""card""bankTransfer""check""online""other"
paymentmethodIdstringrequired

Canonical identifier for the payment method.

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

Configuration for any surcharge applied when using this payment method.

updatedAtstring(date-time)required

Timestamp when the payment method was last updated.

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

Indicates if this payment method uses an EFTPOS/credit card terminal.

Response
application/json
{
  "commissionRate": "string",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "extensions": {},
  "isActive": true,
  "name": "string",
  "paymentMethodType": "cash",
  "paymentmethodId": "123e4567-e89b-12d3-a456-426614174000",
  "surcharge": {},
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "isUsingEftposTerminal": true
}

Update paymentmethod

Request

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

Security
bearer
Path
siteIdnumberrequired

Site identifier

paymentmethodIdstringrequired

Paymentmethod unique identifier (UUID)

Bodyapplication/jsonrequired
commissionRatestring

Commission rate as a decimal fraction (e.g., '0.025' for 2.5%).

extensionsobject

Vendor- or practice-specific extensions. Keys SHOULD be URIs or namespaced identifiers to avoid collisions.

isActiveboolean

Whether this payment method is active and can be used.

namestring

Human-readable name of the payment method (e.g., Cash, Visa).

paymentMethodTypestring

High-level category of the payment method.

Enum"cash""card""bankTransfer""check""online""other"
surchargeobject

Configuration for any surcharge applied when using this payment method.

isUsingEftposTerminalboolean

Indicates if this payment method uses an EFTPOS/credit card terminal.

curl -i -X PATCH \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/paymentmethod/{paymentmethodId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "commissionRate": "string",
    "extensions": {},
    "isActive": true,
    "name": "string",
    "paymentMethodType": "cash",
    "surcharge": {},
    "isUsingEftposTerminal": true
  }'

Responses

Paymentmethod updated successfully

Bodyapplication/json
commissionRatestringrequired

Commission rate as a decimal fraction (e.g., '0.025' for 2.5%).

createdAtstring(date-time)required

Timestamp when the payment method was created, in RFC 3339 format with timezone offset.

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

Vendor- or practice-specific extensions. Keys SHOULD be URIs or namespaced identifiers to avoid collisions.

isActivebooleanrequired

Whether this payment method is active and can be used.

namestringrequired

Human-readable name of the payment method (e.g., Cash, Visa).

paymentMethodTypestringrequired

High-level category of the payment method.

Enum"cash""card""bankTransfer""check""online""other"
paymentmethodIdstringrequired

Canonical identifier for the payment method.

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

Configuration for any surcharge applied when using this payment method.

updatedAtstring(date-time)required

Timestamp when the payment method was last updated.

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

Indicates if this payment method uses an EFTPOS/credit card terminal.

Response
application/json
{
  "commissionRate": "string",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "extensions": {},
  "isActive": true,
  "name": "string",
  "paymentMethodType": "cash",
  "paymentmethodId": "123e4567-e89b-12d3-a456-426614174000",
  "surcharge": {},
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "isUsingEftposTerminal": true
}

Replace paymentmethod

Request

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

Security
bearer
Path
siteIdnumberrequired

Site identifier

paymentmethodIdstringrequired

Paymentmethod unique identifier (UUID)

Bodyapplication/jsonrequired
commissionRatestringrequired

Commission rate as a decimal fraction (e.g., '0.025' for 2.5%).

extensionsobjectrequired

Vendor- or practice-specific extensions. Keys SHOULD be URIs or namespaced identifiers to avoid collisions.

isActivebooleanrequired

Whether this payment method is active and can be used.

namestringrequired

Human-readable name of the payment method (e.g., Cash, Visa).

paymentMethodTypestringrequired

High-level category of the payment method.

Enum"cash""card""bankTransfer""check""online""other"
surchargeobjectrequired

Configuration for any surcharge applied when using this payment method.

isUsingEftposTerminalbooleanrequired

Indicates if this payment method uses an EFTPOS/credit card terminal.

curl -i -X PUT \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/paymentmethod/{paymentmethodId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "commissionRate": "string",
    "extensions": {},
    "isActive": true,
    "name": "string",
    "paymentMethodType": "cash",
    "surcharge": {},
    "isUsingEftposTerminal": true
  }'

Responses

Paymentmethod replaced successfully

Bodyapplication/json
commissionRatestringrequired

Commission rate as a decimal fraction (e.g., '0.025' for 2.5%).

createdAtstring(date-time)required

Timestamp when the payment method was created, in RFC 3339 format with timezone offset.

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

Vendor- or practice-specific extensions. Keys SHOULD be URIs or namespaced identifiers to avoid collisions.

isActivebooleanrequired

Whether this payment method is active and can be used.

namestringrequired

Human-readable name of the payment method (e.g., Cash, Visa).

paymentMethodTypestringrequired

High-level category of the payment method.

Enum"cash""card""bankTransfer""check""online""other"
paymentmethodIdstringrequired

Canonical identifier for the payment method.

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

Configuration for any surcharge applied when using this payment method.

updatedAtstring(date-time)required

Timestamp when the payment method was last updated.

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

Indicates if this payment method uses an EFTPOS/credit card terminal.

Response
application/json
{
  "commissionRate": "string",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "extensions": {},
  "isActive": true,
  "name": "string",
  "paymentMethodType": "cash",
  "paymentmethodId": "123e4567-e89b-12d3-a456-426614174000",
  "surcharge": {},
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "isUsingEftposTerminal": true
}

Delete paymentmethod

Request

Permanently deletes a Paymentmethod record.

Security
bearer
Path
siteIdnumberrequired

Site identifier

paymentmethodIdstringrequired

Paymentmethod unique identifier (UUID)

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

Responses

Paymentmethod deleted successfully

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