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/
Bodyapplication/jsonrequired
Total amount of the payment that has been allocated to invoices.
Example: "100.00"
Unallocated portion of the payment that is still available.
Example: "100.00"
Portion of the payment that was paid in cash, if applicable.
Example: "100.00"
Change returned to the client for cash payments, if applicable.
Example: "100.00"
Identifier of the client associated with this payment.
Example: "123e4567-e89b-12d3-a456-426614174000"
Invoices to which this payment has been allocated.
Identifier for the owning organization or practice.
Example: "123e4567-e89b-12d3-a456-426614174000"
Free-text or structured details about the payment method (e.g., last 4 digits, reference number).
Method used to make the payment.
Enum"cash""card""check""bank_transfer""online""other"
- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/payment/{paymentId}
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/payment/{paymentId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/payment/{paymentId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"allocatedAmount": "100.00",
"amount": "100.00",
"availableAmount": "100.00",
"cashAmount": "100.00",
"cashChange": "100.00",
"clientId": "123e4567-e89b-12d3-a456-426614174000",
"comments": "string",
"currency": "string",
"extensions": {},
"isActive": true,
"linkedInvoices": [
{
"allocatedAmount": "100.00",
"invoiceId": "123e4567-e89b-12d3-a456-426614174000"
}
],
"ownershipId": "123e4567-e89b-12d3-a456-426614174000",
"paymentDate": "2025-01-01",
"paymentDetails": "string",
"paymentMethod": "cash",
"roundingFactor": "100.00",
"status": "pending"
}'Payment replaced successfully
Total amount of the payment that has been allocated to invoices.
Example: "100.00"
Unallocated portion of the payment that is still available.
Example: "100.00"
Portion of the payment that was paid in cash, if applicable.
Example: "100.00"
Change returned to the client for cash payments, if applicable.
Example: "100.00"
Identifier of the client associated with this payment.
Example: "123e4567-e89b-12d3-a456-426614174000"
Timestamp when the payment record was created.
Example: "2025-01-01T00:00:00.000Z"
Invoices to which this payment has been allocated.
Identifier for the owning organization or practice.
Example: "123e4567-e89b-12d3-a456-426614174000"
Calendar date the payment was received or processed.
Example: "2025-01-01T00:00:00Z"
Free-text or structured details about the payment method (e.g., last 4 digits, reference number).
Canonical unique identifier for the payment.
Example: "123e4567-e89b-12d3-a456-426614174000"
Method used to make the payment.
Enum"cash""card""check""bank_transfer""online""other"
Lifecycle status of the payment.
Enum"pending""completed""cancelled""refunded""failed"
Response
application/json
{ "allocatedAmount": "100.00", "amount": "100.00", "availableAmount": "100.00", "cashAmount": "100.00", "cashChange": "100.00", "clientId": "123e4567-e89b-12d3-a456-426614174000", "comments": "string", "createdAt": "2025-01-01T00:00:00.000Z", "currency": "string", "extensions": {}, "isActive": true, "linkedInvoices": [ { … } ], "ownershipId": "123e4567-e89b-12d3-a456-426614174000", "paymentDate": "2025-01-01T00:00:00Z", "paymentDetails": "string", "paymentId": "123e4567-e89b-12d3-a456-426614174000", "paymentMethod": "cash", "roundingFactor": "100.00", "status": "pending", "updatedAt": "2025-01-01T00:00:00.000Z" }
- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/payment/{paymentId}
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/payment/{paymentId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/payment/{paymentId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'