Skip to content

AHDS Store API (1.0)

Animal Health Data Store - V1 API Documentation

Overview
Languages
Servers
Mock server

https://docs.heydonto.com/_mock/apis/animal-health/openapi/

Local Development

http://localhost:8083/

Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations

Request

Fully replaces an existing Purchaseorderitem. All fields must be provided.

Security
bearer
Path
siteIdnumberrequired

Site identifier

purchaseorderitemIdstringrequired

Purchaseorderitem unique identifier (UUID)

Bodyapplication/jsonrequired
extensionsobjectrequired

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether this purchase order item is active.

outersnumberrequired

Number of outer packs ordered.

ownershipIdstringrequired

Identifier representing the owning business unit or organization.

Example: "123e4567-e89b-12d3-a456-426614174000"
pricePerUnitstringrequired

Net price per individual unit, as a decimal string.

Example: "100.00"
productIdstringrequired

Identifier of the product being ordered.

Example: "123e4567-e89b-12d3-a456-426614174000"
purchaseOrderIdstringrequired

Identifier of the related purchase order.

Example: "123e4567-e89b-12d3-a456-426614174000"
quantitynumberrequired

Total number of units ordered.

supplierCodestringrequired

Supplier-specific product code, if provided.

taxPerUnitstringrequired

Tax amount per individual unit, as a decimal string.

Example: "100.00"
totalAmountstringrequired

Total net amount for this line (excluding tax), as a decimal string.

Example: "100.00"
totalTaxAmountstringrequired

Total tax amount for this line, as a decimal string.

Example: "100.00"
unitsPerOuternumberrequired

Number of units contained in each outer pack.

curl -i -X PUT \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/purchaseorderitem/{purchaseorderitemId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "extensions": {},
    "isActive": true,
    "outers": 0,
    "ownershipId": "123e4567-e89b-12d3-a456-426614174000",
    "pricePerUnit": "100.00",
    "productId": "123e4567-e89b-12d3-a456-426614174000",
    "purchaseOrderId": "123e4567-e89b-12d3-a456-426614174000",
    "quantity": 0,
    "supplierCode": "string",
    "taxPerUnit": "100.00",
    "totalAmount": "100.00",
    "totalTaxAmount": "100.00",
    "unitsPerOuter": 0
  }'

Responses

Purchaseorderitem replaced successfully

Bodyapplication/json
createdAtstring(date-time)required

Timestamp when the purchase order item was created.

Example: "2025-01-01T00:00:00.000Z"
extensionsobjectrequired

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether this purchase order item is active.

outersnumberrequired

Number of outer packs ordered.

ownershipIdstringrequired

Identifier representing the owning business unit or organization.

Example: "123e4567-e89b-12d3-a456-426614174000"
pricePerUnitstringrequired

Net price per individual unit, as a decimal string.

Example: "100.00"
productIdstringrequired

Identifier of the product being ordered.

Example: "123e4567-e89b-12d3-a456-426614174000"
purchaseOrderIdstringrequired

Identifier of the related purchase order.

Example: "123e4567-e89b-12d3-a456-426614174000"
purchaseorderitemIdstringrequired

Canonical identifier for the purchase order item.

Example: "123e4567-e89b-12d3-a456-426614174000"
quantitynumberrequired

Total number of units ordered.

supplierCodestringrequired

Supplier-specific product code, if provided.

taxPerUnitstringrequired

Tax amount per individual unit, as a decimal string.

Example: "100.00"
totalAmountstringrequired

Total net amount for this line (excluding tax), as a decimal string.

Example: "100.00"
totalTaxAmountstringrequired

Total tax amount for this line, as a decimal string.

Example: "100.00"
unitsPerOuternumberrequired

Number of units contained in each outer pack.

updatedAtstring(date-time)required

Timestamp when the purchase order item was last modified.

Example: "2025-01-01T00:00:00.000Z"
Response
application/json
{ "createdAt": "2025-01-01T00:00:00.000Z", "extensions": {}, "isActive": true, "outers": 0, "ownershipId": "123e4567-e89b-12d3-a456-426614174000", "pricePerUnit": "100.00", "productId": "123e4567-e89b-12d3-a456-426614174000", "purchaseOrderId": "123e4567-e89b-12d3-a456-426614174000", "purchaseorderitemId": "123e4567-e89b-12d3-a456-426614174000", "quantity": 0, "supplierCode": "string", "taxPerUnit": "100.00", "totalAmount": "100.00", "totalTaxAmount": "100.00", "unitsPerOuter": 0, "updatedAt": "2025-01-01T00:00:00.000Z" }

Request

Permanently deletes a Purchaseorderitem record.

Security
bearer
Path
siteIdnumberrequired

Site identifier

purchaseorderitemIdstringrequired

Purchaseorderitem unique identifier (UUID)

curl -i -X DELETE \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/purchaseorderitem/{purchaseorderitemId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Purchaseorderitem deleted successfully

Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations