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
Line items that make up this stock adjustment.
Timestamp when the line item was created.
Example: "2025-01-01T00:00:00.000Z"
Discount applied to this line item, as a decimal string.
Example: "100.00"
Grouping identifier for related line items.
Example: "123e4567-e89b-12d3-a456-426614174000"
Identifier for the invoice line item.
Example: "123e4567-e89b-12d3-a456-426614174000"
Ledger account associated with this line item.
Example: "123e4567-e89b-12d3-a456-426614174000"
Total amount for this line excluding tax.
Example: "100.00"
Location associated with this line item.
Example: "123e4567-e89b-12d3-a456-426614174000"
Owning organization or business unit for this line item.
Example: "123e4567-e89b-12d3-a456-426614174000"
Product or service associated with this line item.
Example: "123e4567-e89b-12d3-a456-426614174000"
Salesperson associated with this line item.
Example: "123e4567-e89b-12d3-a456-426614174000"
Standard (list) unit price excluding tax.
Example: "100.00"
Unit price excluding tax, as a decimal string.
Example: "100.00"
When the stock adjustment occurred (RFC 3339).
Example: "2025-01-01T00:00:00.000Z"
- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/stock-adjustment/{stockAdjustmentId}
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/stock-adjustment/{stockAdjustmentId}
- 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/stock-adjustment/{stockAdjustmentId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"comments": "string",
"extensions": {},
"lineItems": [
{
"createdAt": "2025-01-01T00:00:00.000Z",
"discountAmount": "100.00",
"extensions": {},
"groupId": "123e4567-e89b-12d3-a456-426614174000",
"invoiceLineItemId": "123e4567-e89b-12d3-a456-426614174000",
"isActive": true,
"ledgerAccountId": "123e4567-e89b-12d3-a456-426614174000",
"lineTaxAmount": "100.00",
"lineTotalAmount": "100.00",
"lineType": "string",
"locationId": "123e4567-e89b-12d3-a456-426614174000",
"name": "string",
"ownershipId": "123e4567-e89b-12d3-a456-426614174000",
"productId": "123e4567-e89b-12d3-a456-426614174000",
"quantity": 0,
"salesPersonId": "123e4567-e89b-12d3-a456-426614174000",
"standardUnitPriceAmount": "100.00",
"standardUnitTaxAmount": "100.00",
"status": "string",
"taxCode": "string",
"taxPercent": 0,
"unitPriceAmount": "100.00",
"unitTaxAmount": "100.00",
"updatedAt": "2025-01-01T00:00:00.000Z"
}
],
"occurredAt": "2025-01-01T00:00:00.000Z",
"ownershipId": "123e4567-e89b-12d3-a456-426614174000"
}'Stock Adjustment replaced successfully
Timestamp when this stock adjustment record was created.
Example: "2025-01-01T00:00:00.000Z"
Line items that make up this stock adjustment.
Timestamp when the line item was created.
Example: "2025-01-01T00:00:00.000Z"
Discount applied to this line item, as a decimal string.
Example: "100.00"
Grouping identifier for related line items.
Example: "123e4567-e89b-12d3-a456-426614174000"
Identifier for the invoice line item.
Example: "123e4567-e89b-12d3-a456-426614174000"
Ledger account associated with this line item.
Example: "123e4567-e89b-12d3-a456-426614174000"
Total amount for this line excluding tax.
Example: "100.00"
Location associated with this line item.
Example: "123e4567-e89b-12d3-a456-426614174000"
Owning organization or business unit for this line item.
Example: "123e4567-e89b-12d3-a456-426614174000"
Product or service associated with this line item.
Example: "123e4567-e89b-12d3-a456-426614174000"
Salesperson associated with this line item.
Example: "123e4567-e89b-12d3-a456-426614174000"
Standard (list) unit price excluding tax.
Example: "100.00"
Unit price excluding tax, as a decimal string.
Example: "100.00"
When the stock adjustment occurred (RFC 3339).
Example: "2025-01-01T00:00:00.000Z"
Identifier of the ownership or separation context this stock adjustment belongs to.
Example: "123e4567-e89b-12d3-a456-426614174000"
Canonical identifier for the stock adjustment.
Example: "123e4567-e89b-12d3-a456-426614174000"
Response
application/json
{ "comments": "string", "createdAt": "2025-01-01T00:00:00.000Z", "extensions": {}, "lineItems": [ { … } ], "occurredAt": "2025-01-01T00:00:00.000Z", "ownershipId": "123e4567-e89b-12d3-a456-426614174000", "stockAdjustmentId": "123e4567-e89b-12d3-a456-426614174000", "updatedAt": "2025-01-01T00:00:00.000Z" }
- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/stock-adjustment/{stockAdjustmentId}
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/stock-adjustment/{stockAdjustmentId}
- 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/stock-adjustment/{stockAdjustmentId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'