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
Operations
Operations
Operations
Operations
Operations

Request

Creates a new Purchaseorder record. Purchaseorder resource in the Animal Health Data Store

Security
bearer
Path
siteIdnumberrequired

Site identifier

Bodyapplication/jsonrequired
clientIdstring

Client associated with this purchase order, if applicable.

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

Free-text comments on the purchase order.

extensionsobject

Vendor- or practice-specific extensions.

freightAmountstring

Freight amount as a decimal string.

Example: "100.00"
freightTaxAmountstring

Tax amount applicable to freight.

Example: "100.00"
isActivebooleanrequired

Whether the purchase order is active.

orderDatestringrequired

Calendar date of the purchase order.

Example: "2025-01-01"
ownershipIdstring

Ownership or business unit identifier associated with this purchase order.

Example: "123e4567-e89b-12d3-a456-426614174000"
purchaseOrderItemIdsArray of strings

List of purchase order item identifiers associated with this purchase order.

purchaseorderIdstringrequired

Canonical identifier for the purchase order.

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

Reference to the shipping address resource.

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

Status of the purchase order.

Enum"draft""submitted""confirmed""partiallyReceived""received""cancelled"
supplierAccountNumberstring

Account number with the supplier.

supplierIdstringrequired

Supplier from whom the order is placed.

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

Supplier-provided order number.

taxAmountstring

Total tax amount for the purchase order.

Example: "100.00"
totalAmountstring

Total amount for the purchase order including tax.

Example: "100.00"
curl -i -X POST \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/purchaseorder' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "clientId": "123e4567-e89b-12d3-a456-426614174000",
    "comments": "string",
    "extensions": {},
    "freightAmount": "100.00",
    "freightTaxAmount": "100.00",
    "isActive": true,
    "orderDate": "2025-01-01",
    "ownershipId": "123e4567-e89b-12d3-a456-426614174000",
    "purchaseOrderItemIds": [
      "string"
    ],
    "purchaseorderId": "123e4567-e89b-12d3-a456-426614174000",
    "shippingAddressId": "123e4567-e89b-12d3-a456-426614174000",
    "status": "draft",
    "supplierAccountNumber": "string",
    "supplierId": "123e4567-e89b-12d3-a456-426614174000",
    "supplierOrderNumber": "string",
    "taxAmount": "100.00",
    "totalAmount": "100.00"
  }'

Responses

Purchaseorder created successfully

Bodyapplication/json
clientIdstringrequired

Client associated with this purchase order, if applicable.

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

Free-text comments on the purchase order.

createdAtstring(date-time)required

Timestamp when the purchase order was created.

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

Vendor- or practice-specific extensions.

freightAmountstringrequired

Freight amount as a decimal string.

Example: "100.00"
freightTaxAmountstringrequired

Tax amount applicable to freight.

Example: "100.00"
isActivebooleanrequired

Whether the purchase order is active.

orderDatestring(date-time)required

Calendar date of the purchase order.

Example: "2025-01-01T00:00:00Z"
ownershipIdstringrequired

Ownership or business unit identifier associated with this purchase order.

Example: "123e4567-e89b-12d3-a456-426614174000"
purchaseOrderItemIdsArray of stringsrequired

List of purchase order item identifiers associated with this purchase order.

purchaseorderIdstringrequired

Canonical identifier for the purchase order.

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

Reference to the shipping address resource.

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

Status of the purchase order.

Enum"draft""submitted""confirmed""partiallyReceived""received""cancelled"
supplierAccountNumberstringrequired

Account number with the supplier.

supplierIdstringrequired

Supplier from whom the order is placed.

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

Supplier-provided order number.

taxAmountstringrequired

Total tax amount for the purchase order.

Example: "100.00"
totalAmountstringrequired

Total amount for the purchase order including tax.

Example: "100.00"
updatedAtstring(date-time)required

Timestamp when the purchase order was last modified.

Example: "2025-01-01T00:00:00.000Z"
Response
application/json
{ "clientId": "123e4567-e89b-12d3-a456-426614174000", "comments": "string", "createdAt": "2025-01-01T00:00:00.000Z", "extensions": {}, "freightAmount": "100.00", "freightTaxAmount": "100.00", "isActive": true, "orderDate": "2025-01-01T00:00:00Z", "ownershipId": "123e4567-e89b-12d3-a456-426614174000", "purchaseOrderItemIds": [ "string" ], "purchaseorderId": "123e4567-e89b-12d3-a456-426614174000", "shippingAddressId": "123e4567-e89b-12d3-a456-426614174000", "status": "draft", "supplierAccountNumber": "string", "supplierId": "123e4567-e89b-12d3-a456-426614174000", "supplierOrderNumber": "string", "taxAmount": "100.00", "totalAmount": "100.00", "updatedAt": "2025-01-01T00:00:00.000Z" }

Request

Returns a paginated list of Purchaseorders for the specified site. Supports filtering and sorting.

Security
bearer
Path
siteIdnumberrequired

Site identifier

Query
pagenumber>= 0

Page number (0-indexed)

Default 0
pageSizenumber[ 1 .. 100 ]

Number of items per page

Default 10
sortBystring

Field to sort by

Enum"createdAt""updatedAt""comments""freightAmount""freightTaxAmount""orderDate""supplierAccountNumber""supplierOrderNumber""taxAmount""totalAmount"
sortOrderstring

Sort order

Default "asc"
Enum"asc""desc"
clientIdstring

Client associated with this purchase order, if applicable.

Example: clientId=123e4567-e89b-12d3-a456-426614174000
commentsstring

Free-text comments on the purchase order.

isActiveboolean

Whether the purchase order is active.

ownershipIdstring

Ownership or business unit identifier associated with this purchase order.

Example: ownershipId=123e4567-e89b-12d3-a456-426614174000
shippingAddressIdstring

Reference to the shipping address resource.

Example: shippingAddressId=123e4567-e89b-12d3-a456-426614174000
statusstring

Status of the purchase order.

Enum"draft""submitted""confirmed""partiallyReceived""received""cancelled"
supplierAccountNumberstring

Account number with the supplier.

supplierIdstring

Supplier from whom the order is placed.

Example: supplierId=123e4567-e89b-12d3-a456-426614174000
supplierOrderNumberstring

Supplier-provided order number.

curl -i -X GET \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/purchaseorder?page=0&pageSize=10&sortBy=createdAt&sortOrder=asc&clientId=123e4567-e89b-12d3-a456-426614174000&comments=string&isActive=true&ownershipId=123e4567-e89b-12d3-a456-426614174000&shippingAddressId=123e4567-e89b-12d3-a456-426614174000&status=draft&supplierAccountNumber=string&supplierId=123e4567-e89b-12d3-a456-426614174000&supplierOrderNumber=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Paginated list of Purchaseorders

Request

Returns a single Purchaseorder by its unique identifier.

Security
bearer
Path
siteIdnumberrequired

Site identifier

purchaseorderIdstringrequired

Purchaseorder unique identifier (UUID)

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

Responses

Purchaseorder found

Bodyapplication/json
clientIdstringrequired

Client associated with this purchase order, if applicable.

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

Free-text comments on the purchase order.

createdAtstring(date-time)required

Timestamp when the purchase order was created.

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

Vendor- or practice-specific extensions.

freightAmountstringrequired

Freight amount as a decimal string.

Example: "100.00"
freightTaxAmountstringrequired

Tax amount applicable to freight.

Example: "100.00"
isActivebooleanrequired

Whether the purchase order is active.

orderDatestring(date-time)required

Calendar date of the purchase order.

Example: "2025-01-01T00:00:00Z"
ownershipIdstringrequired

Ownership or business unit identifier associated with this purchase order.

Example: "123e4567-e89b-12d3-a456-426614174000"
purchaseOrderItemIdsArray of stringsrequired

List of purchase order item identifiers associated with this purchase order.

purchaseorderIdstringrequired

Canonical identifier for the purchase order.

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

Reference to the shipping address resource.

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

Status of the purchase order.

Enum"draft""submitted""confirmed""partiallyReceived""received""cancelled"
supplierAccountNumberstringrequired

Account number with the supplier.

supplierIdstringrequired

Supplier from whom the order is placed.

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

Supplier-provided order number.

taxAmountstringrequired

Total tax amount for the purchase order.

Example: "100.00"
totalAmountstringrequired

Total amount for the purchase order including tax.

Example: "100.00"
updatedAtstring(date-time)required

Timestamp when the purchase order was last modified.

Example: "2025-01-01T00:00:00.000Z"
Response
application/json
{ "clientId": "123e4567-e89b-12d3-a456-426614174000", "comments": "string", "createdAt": "2025-01-01T00:00:00.000Z", "extensions": {}, "freightAmount": "100.00", "freightTaxAmount": "100.00", "isActive": true, "orderDate": "2025-01-01T00:00:00Z", "ownershipId": "123e4567-e89b-12d3-a456-426614174000", "purchaseOrderItemIds": [ "string" ], "purchaseorderId": "123e4567-e89b-12d3-a456-426614174000", "shippingAddressId": "123e4567-e89b-12d3-a456-426614174000", "status": "draft", "supplierAccountNumber": "string", "supplierId": "123e4567-e89b-12d3-a456-426614174000", "supplierOrderNumber": "string", "taxAmount": "100.00", "totalAmount": "100.00", "updatedAt": "2025-01-01T00:00:00.000Z" }

Request

Partially updates an existing Purchaseorder. Only provided fields will be updated.

Security
bearer
Path
siteIdnumberrequired

Site identifier

purchaseorderIdstringrequired

Purchaseorder unique identifier (UUID)

Bodyapplication/jsonrequired
clientIdstring

Client associated with this purchase order, if applicable.

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

Free-text comments on the purchase order.

extensionsobject

Vendor- or practice-specific extensions.

freightAmountstring

Freight amount as a decimal string.

Example: "100.00"
freightTaxAmountstring

Tax amount applicable to freight.

Example: "100.00"
isActiveboolean

Whether the purchase order is active.

orderDatestring

Calendar date of the purchase order.

Example: "2025-01-01"
ownershipIdstring

Ownership or business unit identifier associated with this purchase order.

Example: "123e4567-e89b-12d3-a456-426614174000"
purchaseOrderItemIdsArray of strings

List of purchase order item identifiers associated with this purchase order.

shippingAddressIdstring

Reference to the shipping address resource.

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

Status of the purchase order.

Enum"draft""submitted""confirmed""partiallyReceived""received""cancelled"
supplierAccountNumberstring

Account number with the supplier.

supplierIdstring

Supplier from whom the order is placed.

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

Supplier-provided order number.

taxAmountstring

Total tax amount for the purchase order.

Example: "100.00"
totalAmountstring

Total amount for the purchase order including tax.

Example: "100.00"
curl -i -X PATCH \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/purchaseorder/{purchaseorderId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "clientId": "123e4567-e89b-12d3-a456-426614174000",
    "comments": "string",
    "extensions": {},
    "freightAmount": "100.00",
    "freightTaxAmount": "100.00",
    "isActive": true,
    "orderDate": "2025-01-01",
    "ownershipId": "123e4567-e89b-12d3-a456-426614174000",
    "purchaseOrderItemIds": [
      "string"
    ],
    "shippingAddressId": "123e4567-e89b-12d3-a456-426614174000",
    "status": "draft",
    "supplierAccountNumber": "string",
    "supplierId": "123e4567-e89b-12d3-a456-426614174000",
    "supplierOrderNumber": "string",
    "taxAmount": "100.00",
    "totalAmount": "100.00"
  }'

Responses

Purchaseorder updated successfully

Bodyapplication/json
clientIdstringrequired

Client associated with this purchase order, if applicable.

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

Free-text comments on the purchase order.

createdAtstring(date-time)required

Timestamp when the purchase order was created.

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

Vendor- or practice-specific extensions.

freightAmountstringrequired

Freight amount as a decimal string.

Example: "100.00"
freightTaxAmountstringrequired

Tax amount applicable to freight.

Example: "100.00"
isActivebooleanrequired

Whether the purchase order is active.

orderDatestring(date-time)required

Calendar date of the purchase order.

Example: "2025-01-01T00:00:00Z"
ownershipIdstringrequired

Ownership or business unit identifier associated with this purchase order.

Example: "123e4567-e89b-12d3-a456-426614174000"
purchaseOrderItemIdsArray of stringsrequired

List of purchase order item identifiers associated with this purchase order.

purchaseorderIdstringrequired

Canonical identifier for the purchase order.

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

Reference to the shipping address resource.

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

Status of the purchase order.

Enum"draft""submitted""confirmed""partiallyReceived""received""cancelled"
supplierAccountNumberstringrequired

Account number with the supplier.

supplierIdstringrequired

Supplier from whom the order is placed.

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

Supplier-provided order number.

taxAmountstringrequired

Total tax amount for the purchase order.

Example: "100.00"
totalAmountstringrequired

Total amount for the purchase order including tax.

Example: "100.00"
updatedAtstring(date-time)required

Timestamp when the purchase order was last modified.

Example: "2025-01-01T00:00:00.000Z"
Response
application/json
{ "clientId": "123e4567-e89b-12d3-a456-426614174000", "comments": "string", "createdAt": "2025-01-01T00:00:00.000Z", "extensions": {}, "freightAmount": "100.00", "freightTaxAmount": "100.00", "isActive": true, "orderDate": "2025-01-01T00:00:00Z", "ownershipId": "123e4567-e89b-12d3-a456-426614174000", "purchaseOrderItemIds": [ "string" ], "purchaseorderId": "123e4567-e89b-12d3-a456-426614174000", "shippingAddressId": "123e4567-e89b-12d3-a456-426614174000", "status": "draft", "supplierAccountNumber": "string", "supplierId": "123e4567-e89b-12d3-a456-426614174000", "supplierOrderNumber": "string", "taxAmount": "100.00", "totalAmount": "100.00", "updatedAt": "2025-01-01T00:00:00.000Z" }

Request

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

Security
bearer
Path
siteIdnumberrequired

Site identifier

purchaseorderIdstringrequired

Purchaseorder unique identifier (UUID)

Bodyapplication/jsonrequired
clientIdstringrequired

Client associated with this purchase order, if applicable.

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

Free-text comments on the purchase order.

extensionsobjectrequired

Vendor- or practice-specific extensions.

freightAmountstringrequired

Freight amount as a decimal string.

Example: "100.00"
freightTaxAmountstringrequired

Tax amount applicable to freight.

Example: "100.00"
isActivebooleanrequired

Whether the purchase order is active.

orderDatestringrequired

Calendar date of the purchase order.

Example: "2025-01-01"
ownershipIdstringrequired

Ownership or business unit identifier associated with this purchase order.

Example: "123e4567-e89b-12d3-a456-426614174000"
purchaseOrderItemIdsArray of stringsrequired

List of purchase order item identifiers associated with this purchase order.

shippingAddressIdstringrequired

Reference to the shipping address resource.

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

Status of the purchase order.

Enum"draft""submitted""confirmed""partiallyReceived""received""cancelled"
supplierAccountNumberstringrequired

Account number with the supplier.

supplierIdstringrequired

Supplier from whom the order is placed.

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

Supplier-provided order number.

taxAmountstringrequired

Total tax amount for the purchase order.

Example: "100.00"
totalAmountstringrequired

Total amount for the purchase order including tax.

Example: "100.00"
curl -i -X PUT \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/purchaseorder/{purchaseorderId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "clientId": "123e4567-e89b-12d3-a456-426614174000",
    "comments": "string",
    "extensions": {},
    "freightAmount": "100.00",
    "freightTaxAmount": "100.00",
    "isActive": true,
    "orderDate": "2025-01-01",
    "ownershipId": "123e4567-e89b-12d3-a456-426614174000",
    "purchaseOrderItemIds": [
      "string"
    ],
    "shippingAddressId": "123e4567-e89b-12d3-a456-426614174000",
    "status": "draft",
    "supplierAccountNumber": "string",
    "supplierId": "123e4567-e89b-12d3-a456-426614174000",
    "supplierOrderNumber": "string",
    "taxAmount": "100.00",
    "totalAmount": "100.00"
  }'

Responses

Purchaseorder replaced successfully

Bodyapplication/json
clientIdstringrequired

Client associated with this purchase order, if applicable.

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

Free-text comments on the purchase order.

createdAtstring(date-time)required

Timestamp when the purchase order was created.

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

Vendor- or practice-specific extensions.

freightAmountstringrequired

Freight amount as a decimal string.

Example: "100.00"
freightTaxAmountstringrequired

Tax amount applicable to freight.

Example: "100.00"
isActivebooleanrequired

Whether the purchase order is active.

orderDatestring(date-time)required

Calendar date of the purchase order.

Example: "2025-01-01T00:00:00Z"
ownershipIdstringrequired

Ownership or business unit identifier associated with this purchase order.

Example: "123e4567-e89b-12d3-a456-426614174000"
purchaseOrderItemIdsArray of stringsrequired

List of purchase order item identifiers associated with this purchase order.

purchaseorderIdstringrequired

Canonical identifier for the purchase order.

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

Reference to the shipping address resource.

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

Status of the purchase order.

Enum"draft""submitted""confirmed""partiallyReceived""received""cancelled"
supplierAccountNumberstringrequired

Account number with the supplier.

supplierIdstringrequired

Supplier from whom the order is placed.

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

Supplier-provided order number.

taxAmountstringrequired

Total tax amount for the purchase order.

Example: "100.00"
totalAmountstringrequired

Total amount for the purchase order including tax.

Example: "100.00"
updatedAtstring(date-time)required

Timestamp when the purchase order was last modified.

Example: "2025-01-01T00:00:00.000Z"
Response
application/json
{ "clientId": "123e4567-e89b-12d3-a456-426614174000", "comments": "string", "createdAt": "2025-01-01T00:00:00.000Z", "extensions": {}, "freightAmount": "100.00", "freightTaxAmount": "100.00", "isActive": true, "orderDate": "2025-01-01T00:00:00Z", "ownershipId": "123e4567-e89b-12d3-a456-426614174000", "purchaseOrderItemIds": [ "string" ], "purchaseorderId": "123e4567-e89b-12d3-a456-426614174000", "shippingAddressId": "123e4567-e89b-12d3-a456-426614174000", "status": "draft", "supplierAccountNumber": "string", "supplierId": "123e4567-e89b-12d3-a456-426614174000", "supplierOrderNumber": "string", "taxAmount": "100.00", "totalAmount": "100.00", "updatedAt": "2025-01-01T00:00:00.000Z" }

Request

Permanently deletes a Purchaseorder record.

Security
bearer
Path
siteIdnumberrequired

Site identifier

purchaseorderIdstringrequired

Purchaseorder unique identifier (UUID)

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

Responses

Purchaseorder 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