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
Entity the credit is currently associated/applied to, if different from availability.
Whether the credit is tracked as a quantity (e.g., visits) or a monetary value.
Enum"quantity""value"
Example: "quantity"
Total quantity or monetary amount originally granted for this credit.
Example: 1.23
Quantity or monetary amount that has been wasted or expired without use.
Example: 1.23
Identifier of the wellness plan benefit that generated this credit, if applicable.
Example: "123e4567-e89b-12d3-a456-426614174000"
Identifier of the wellness plan that generated this credit, if applicable.
Example: "123e4567-e89b-12d3-a456-426614174000"
Identifier of the membership cycle associated with this credit, if applicable.
Example: "123e4567-e89b-12d3-a456-426614174000"
Identifier of the wellness plan membership associated with this credit, if applicable.
Example: "123e4567-e89b-12d3-a456-426614174000"
Identifier of the membership status period associated with this credit, if applicable.
Example: "123e4567-e89b-12d3-a456-426614174000"
- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/billing-credit/{billingCreditId}
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/billing-credit/{billingCreditId}
- 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/billing-credit/{billingCreditId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"appliedTo": {},
"availableTo": {},
"creditType": "quantity",
"endDate": "2025-01-01",
"expiry": {},
"extensions": {},
"isActive": true,
"remainingAmount": 1.23,
"startDate": "2025-01-01",
"totalAmount": 1.23,
"usedAmount": 1.23,
"wastedAmount": 1.23,
"wellnessPlanBenefitId": "123e4567-e89b-12d3-a456-426614174000",
"wellnessPlanId": "123e4567-e89b-12d3-a456-426614174000",
"wellnessPlanMembershipCycleId": "123e4567-e89b-12d3-a456-426614174000",
"wellnessPlanMembershipId": "123e4567-e89b-12d3-a456-426614174000",
"wellnessPlanMembershipStatusPeriodId": "123e4567-e89b-12d3-a456-426614174000",
"amountType": {
"code": "12345",
"system": "http://example.com/codesystem",
"display": "Example Display Name"
},
"creditCategory": {
"code": "12345",
"system": "http://example.com/codesystem",
"display": "Example Display Name"
},
"currency": {
"code": "12345",
"system": "http://example.com/codesystem",
"display": "Example Display Name"
},
"measurementUnit": {
"code": "12345",
"system": "http://example.com/codesystem",
"display": "Example Display Name"
}
}'Billing Credit replaced successfully
Entity the credit is currently associated/applied to, if different from availability.
Canonical identifier for the billing credit.
Example: "123e4567-e89b-12d3-a456-426614174000"
Timestamp when the billing credit was created.
Example: "2025-01-01T00:00:00.000Z"
Whether the credit is tracked as a quantity (e.g., visits) or a monetary value.
Enum"quantity""value"
Example: "quantity"
Date on which the credit expires, if applicable.
Example: "2025-01-01T00:00:00Z"
Date from which the credit becomes valid.
Example: "2025-01-01T00:00:00Z"
Total quantity or monetary amount originally granted for this credit.
Example: 1.23
Timestamp when the billing credit was last updated.
Example: "2025-01-01T00:00:00.000Z"
Quantity or monetary amount that has been wasted or expired without use.
Example: 1.23
Identifier of the wellness plan benefit that generated this credit, if applicable.
Example: "123e4567-e89b-12d3-a456-426614174000"
Identifier of the wellness plan that generated this credit, if applicable.
Example: "123e4567-e89b-12d3-a456-426614174000"
Identifier of the membership cycle associated with this credit, if applicable.
Example: "123e4567-e89b-12d3-a456-426614174000"
Identifier of the wellness plan membership associated with this credit, if applicable.
Example: "123e4567-e89b-12d3-a456-426614174000"
Identifier of the membership status period associated with this credit, if applicable.
Example: "123e4567-e89b-12d3-a456-426614174000"
Response
application/json
{ "appliedTo": {}, "availableTo": {}, "billingCreditId": "123e4567-e89b-12d3-a456-426614174000", "createdAt": "2025-01-01T00:00:00.000Z", "creditType": "quantity", "endDate": "2025-01-01T00:00:00Z", "expiry": {}, "extensions": {}, "isActive": true, "remainingAmount": 1.23, "startDate": "2025-01-01T00:00:00Z", "totalAmount": 1.23, "updatedAt": "2025-01-01T00:00:00.000Z", "usedAmount": 1.23, "wastedAmount": 1.23, "wellnessPlanBenefitId": "123e4567-e89b-12d3-a456-426614174000", "wellnessPlanId": "123e4567-e89b-12d3-a456-426614174000", "wellnessPlanMembershipCycleId": "123e4567-e89b-12d3-a456-426614174000", "wellnessPlanMembershipId": "123e4567-e89b-12d3-a456-426614174000", "wellnessPlanMembershipStatusPeriodId": "123e4567-e89b-12d3-a456-426614174000", "amountType": { "code": "12345", "system": "http://example.com/codesystem", "display": "Example Display Name" }, "creditCategory": { "code": "12345", "system": "http://example.com/codesystem", "display": "Example Display Name" }, "currency": { "code": "12345", "system": "http://example.com/codesystem", "display": "Example Display Name" }, "measurementUnit": { "code": "12345", "system": "http://example.com/codesystem", "display": "Example Display Name" } }
- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/billing-credit/{billingCreditId}
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/billing-credit/{billingCreditId}
- 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/billing-credit/{billingCreditId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'