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
Base adjustment amount as a decimal string (may represent fixed amount or percentage depending on method).
Example: "example"
Method used to calculate the adjustment (e.g., fixed amount, percentage).
Example: "example"
High-level type of price adjustment.
Enum"user""credit""rounding""discount""surcharge"
Example: "user"
Identifier of the resource this adjustment is associated with.
Example: "123e4567-e89b-12d3-a456-426614174000"
Type of resource this adjustment is associated with (e.g., invoice, invoiceLine, estimate).
Example: "example"
Total change in amount (excluding tax) caused by this adjustment, as a decimal string.
Example: "example"
Total change in tax amount caused by this adjustment, as a decimal string.
Example: "example"
Total amount earned (excluding tax) as a result of this adjustment, as a decimal string.
Example: "example"
Total tax amount earned as a result of this adjustment, as a decimal string.
Example: "example"
Identifier of the resource that triggered this adjustment, if applicable.
Example: "123e4567-e89b-12d3-a456-426614174000"
Type of resource that triggered this adjustment, if applicable.
Example: "example"
Associated wellness plan benefit, if applicable.
Example: "123e4567-e89b-12d3-a456-426614174000"
Associated wellness plan, if applicable.
Example: "123e4567-e89b-12d3-a456-426614174000"
- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/price-adjustment/{priceAdjustmentId}
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/price-adjustment/{priceAdjustmentId}
- 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/price-adjustment/{priceAdjustmentId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"adjustmentAmount": "example",
"adjustmentMethod": "example",
"adjustmentType": "user",
"associatedResourceId": "123e4567-e89b-12d3-a456-426614174000",
"associatedResourceType": "example",
"description": "Example description",
"extensions": {},
"isActive": true,
"isConsuming": true,
"totalChange": "example",
"totalChangeTax": "example",
"totalEarned": "example",
"totalEarnedTax": "example",
"triggeringResourceId": "123e4567-e89b-12d3-a456-426614174000",
"triggeringResourceType": "example",
"wellnessPlanBenefitId": "123e4567-e89b-12d3-a456-426614174000",
"wellnessPlanId": "123e4567-e89b-12d3-a456-426614174000",
"wellnessPlanMembershipId": "123e4567-e89b-12d3-a456-426614174000"
}'Price Adjustment updated successfully
Base adjustment amount as a decimal string (may represent fixed amount or percentage depending on method).
Example: "example"
Method used to calculate the adjustment (e.g., fixed amount, percentage).
Example: "example"
High-level type of price adjustment.
Enum"user""credit""rounding""discount""surcharge"
Example: "user"
Identifier of the resource this adjustment is associated with.
Example: "123e4567-e89b-12d3-a456-426614174000"
Type of resource this adjustment is associated with (e.g., invoice, invoiceLine, estimate).
Example: "example"
Timestamp when the price adjustment was created.
Example: "2025-01-01T00:00:00.000Z"
Human-readable description of the price adjustment.
Example: "Example description"
Whether this adjustment consumes a benefit or credit balance.
Example: true
Canonical identifier for the price adjustment.
Example: "123e4567-e89b-12d3-a456-426614174000"
Total change in amount (excluding tax) caused by this adjustment, as a decimal string.
Example: "example"
Total change in tax amount caused by this adjustment, as a decimal string.
Example: "example"
Total amount earned (excluding tax) as a result of this adjustment, as a decimal string.
Example: "example"
Total tax amount earned as a result of this adjustment, as a decimal string.
Example: "example"
Identifier of the resource that triggered this adjustment, if applicable.
Example: "123e4567-e89b-12d3-a456-426614174000"
Type of resource that triggered this adjustment, if applicable.
Example: "example"
Timestamp when the price adjustment was last updated.
Example: "2025-01-01T00:00:00.000Z"
Associated wellness plan benefit, if applicable.
Example: "123e4567-e89b-12d3-a456-426614174000"
Associated wellness plan, if applicable.
Example: "123e4567-e89b-12d3-a456-426614174000"
Response
application/json
{ "adjustmentAmount": "example", "adjustmentMethod": "example", "adjustmentType": "user", "associatedResourceId": "123e4567-e89b-12d3-a456-426614174000", "associatedResourceType": "example", "createdAt": "2025-01-01T00:00:00.000Z", "description": "Example description", "extensions": {}, "isActive": true, "isConsuming": true, "priceAdjustmentId": "123e4567-e89b-12d3-a456-426614174000", "totalChange": "example", "totalChangeTax": "example", "totalEarned": "example", "totalEarnedTax": "example", "triggeringResourceId": "123e4567-e89b-12d3-a456-426614174000", "triggeringResourceType": "example", "updatedAt": "2025-01-01T00:00:00.000Z", "wellnessPlanBenefitId": "123e4567-e89b-12d3-a456-426614174000", "wellnessPlanId": "123e4567-e89b-12d3-a456-426614174000", "wellnessPlanMembershipId": "123e4567-e89b-12d3-a456-426614174000" }
Bodyapplication/jsonrequired
Base adjustment amount as a decimal string (may represent fixed amount or percentage depending on method).
Example: "example"
Method used to calculate the adjustment (e.g., fixed amount, percentage).
Example: "example"
High-level type of price adjustment.
Enum"user""credit""rounding""discount""surcharge"
Example: "user"
Identifier of the resource this adjustment is associated with.
Example: "123e4567-e89b-12d3-a456-426614174000"
Type of resource this adjustment is associated with (e.g., invoice, invoiceLine, estimate).
Example: "example"
Human-readable description of the price adjustment.
Example: "Example description"
Whether this adjustment consumes a benefit or credit balance.
Example: true
Total change in amount (excluding tax) caused by this adjustment, as a decimal string.
Example: "example"
Total change in tax amount caused by this adjustment, as a decimal string.
Example: "example"
Total amount earned (excluding tax) as a result of this adjustment, as a decimal string.
Example: "example"
Total tax amount earned as a result of this adjustment, as a decimal string.
Example: "example"
Identifier of the resource that triggered this adjustment, if applicable.
Example: "123e4567-e89b-12d3-a456-426614174000"
Type of resource that triggered this adjustment, if applicable.
Example: "example"
Associated wellness plan benefit, if applicable.
Example: "123e4567-e89b-12d3-a456-426614174000"
Associated wellness plan, if applicable.
Example: "123e4567-e89b-12d3-a456-426614174000"
- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/price-adjustment/{priceAdjustmentId}
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/price-adjustment/{priceAdjustmentId}
- 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/price-adjustment/{priceAdjustmentId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"adjustmentAmount": "example",
"adjustmentMethod": "example",
"adjustmentType": "user",
"associatedResourceId": "123e4567-e89b-12d3-a456-426614174000",
"associatedResourceType": "example",
"description": "Example description",
"extensions": {},
"isActive": true,
"isConsuming": true,
"totalChange": "example",
"totalChangeTax": "example",
"totalEarned": "example",
"totalEarnedTax": "example",
"triggeringResourceId": "123e4567-e89b-12d3-a456-426614174000",
"triggeringResourceType": "example",
"wellnessPlanBenefitId": "123e4567-e89b-12d3-a456-426614174000",
"wellnessPlanId": "123e4567-e89b-12d3-a456-426614174000",
"wellnessPlanMembershipId": "123e4567-e89b-12d3-a456-426614174000"
}'Price Adjustment replaced successfully
Base adjustment amount as a decimal string (may represent fixed amount or percentage depending on method).
Example: "example"
Method used to calculate the adjustment (e.g., fixed amount, percentage).
Example: "example"
High-level type of price adjustment.
Enum"user""credit""rounding""discount""surcharge"
Example: "user"
Identifier of the resource this adjustment is associated with.
Example: "123e4567-e89b-12d3-a456-426614174000"
Type of resource this adjustment is associated with (e.g., invoice, invoiceLine, estimate).
Example: "example"
Timestamp when the price adjustment was created.
Example: "2025-01-01T00:00:00.000Z"
Human-readable description of the price adjustment.
Example: "Example description"
Whether this adjustment consumes a benefit or credit balance.
Example: true
Canonical identifier for the price adjustment.
Example: "123e4567-e89b-12d3-a456-426614174000"
Total change in amount (excluding tax) caused by this adjustment, as a decimal string.
Example: "example"
Total change in tax amount caused by this adjustment, as a decimal string.
Example: "example"
Total amount earned (excluding tax) as a result of this adjustment, as a decimal string.
Example: "example"
Total tax amount earned as a result of this adjustment, as a decimal string.
Example: "example"
Identifier of the resource that triggered this adjustment, if applicable.
Example: "123e4567-e89b-12d3-a456-426614174000"
Type of resource that triggered this adjustment, if applicable.
Example: "example"
Timestamp when the price adjustment was last updated.
Example: "2025-01-01T00:00:00.000Z"
Associated wellness plan benefit, if applicable.
Example: "123e4567-e89b-12d3-a456-426614174000"
Associated wellness plan, if applicable.
Example: "123e4567-e89b-12d3-a456-426614174000"
Response
application/json
{ "adjustmentAmount": "example", "adjustmentMethod": "example", "adjustmentType": "user", "associatedResourceId": "123e4567-e89b-12d3-a456-426614174000", "associatedResourceType": "example", "createdAt": "2025-01-01T00:00:00.000Z", "description": "Example description", "extensions": {}, "isActive": true, "isConsuming": true, "priceAdjustmentId": "123e4567-e89b-12d3-a456-426614174000", "totalChange": "example", "totalChangeTax": "example", "totalEarned": "example", "totalEarnedTax": "example", "triggeringResourceId": "123e4567-e89b-12d3-a456-426614174000", "triggeringResourceType": "example", "updatedAt": "2025-01-01T00:00:00.000Z", "wellnessPlanBenefitId": "123e4567-e89b-12d3-a456-426614174000", "wellnessPlanId": "123e4567-e89b-12d3-a456-426614174000", "wellnessPlanMembershipId": "123e4567-e89b-12d3-a456-426614174000" }
- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/price-adjustment/{priceAdjustmentId}
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/price-adjustment/{priceAdjustmentId}
- 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/price-adjustment/{priceAdjustmentId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'