Animal Health Data Store - V1 API Documentation
AHDS Store API (1.0)
Overview
Languages
Servers
Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/
Local Development
http://localhost:8083/
- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/paymentmethod
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/paymentmethod
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
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>'- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/paymentmethod/{paymentmethodId}
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/paymentmethod/{paymentmethodId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
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>'Paymentmethod found
Timestamp when the payment method was created, in RFC 3339 format with timezone offset.
Example: "2025-01-01T00:00:00.000Z"
Vendor- or practice-specific extensions. Keys SHOULD be URIs or namespaced identifiers to avoid collisions.
High-level category of the payment method.
Enum"cash""card""bankTransfer""check""online""other"
Canonical identifier for the payment method.
Example: "123e4567-e89b-12d3-a456-426614174000"
Timestamp when the payment method was last updated.
Example: "2025-01-01T00:00:00.000Z"
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 }
Bodyapplication/jsonrequired
Vendor- or practice-specific extensions. Keys SHOULD be URIs or namespaced identifiers to avoid collisions.
High-level category of the payment method.
Enum"cash""card""bankTransfer""check""online""other"
- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/paymentmethod/{paymentmethodId}
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/paymentmethod/{paymentmethodId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
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
}'Paymentmethod updated successfully
Timestamp when the payment method was created, in RFC 3339 format with timezone offset.
Example: "2025-01-01T00:00:00.000Z"
Vendor- or practice-specific extensions. Keys SHOULD be URIs or namespaced identifiers to avoid collisions.
High-level category of the payment method.
Enum"cash""card""bankTransfer""check""online""other"
Canonical identifier for the payment method.
Example: "123e4567-e89b-12d3-a456-426614174000"
Timestamp when the payment method was last updated.
Example: "2025-01-01T00:00:00.000Z"
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 }