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

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 }

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

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
Operations
Operations
Operations
Operations