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/

Address

Operations

Animal

Operations

Animal Colour

Operations

Appointment

Operations

Appointment Status

Operations

Appointment Type

Operations

Assessment

Operations

Attachment

Operations

Availability

Operations

Availability Slot

Operations

Barcode

Operations

Batch

Operations

Billing Credit

Operations

Billing Line

Operations

Booking

Operations

Breed

Operations

Communication

Operations

Consult

Operations

Contact

Operations

Contact Association

Operations

Contact Detail

Operations

Country

Operations

Diagnostic

Operations

Diagnostic Code

Operations

Diagnostic Request

Operations

Diagnostic Result

Operations

Diagnostic Result Item

Operations

Estimate

Operations

Eventgroup

Operations

External Prescription

Operations

Facility

Operations

File

Operations

File Upload

Operations

Health Status

Operations

Herd

Operations

History

Operations

Insurance

Operations

Integrated Diagnostic

Operations

Inventory Message

Operations

Inventory Product

Operations

Inventory Requirement

Operations

Inventory Supplied Product

Operations

Invoice

Operations

Invoiceline

Operations

Ledger Account

Operations

Linked Payment

Operations

Location

Operations

Message

Operations

Modality

Operations

Operation

Operations

Payment

Operations

Paymentmethod

Operations

Physical Exam

Operations

Plan

Operations

Practitioner

Operations

Prescription

Operations

Prescription Item

Operations

Presentingproblem

Operations

Price Adjustment

Operations

Product

Operations

Product Minimum Stock

Operations

Product Pricing

Operations

Product Supplier

Operations

Productgroup

Operations

Purchaseorder

Operations

Purchaseorderitem

Operations

Create purchaseorderitem

Request

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

Security
bearer
Path
siteIdnumberrequired

Site identifier

Bodyapplication/jsonrequired
extensionsobject

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether this purchase order item is active.

outersnumber

Number of outer packs ordered.

ownershipIdstring

Identifier representing the owning business unit or organization.

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

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.

supplierCodestring

Supplier-specific product code, if provided.

taxPerUnitstring

Tax amount per individual unit, as a decimal string.

Example: "100.00"
totalAmountstring

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

Example: "100.00"
totalTaxAmountstring

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

Example: "100.00"
unitsPerOuternumber

Number of units contained in each outer pack.

curl -i -X POST \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/purchaseorderitem' \
  -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",
    "purchaseorderitemId": "123e4567-e89b-12d3-a456-426614174000",
    "quantity": 0,
    "supplierCode": "string",
    "taxPerUnit": "100.00",
    "totalAmount": "100.00",
    "totalTaxAmount": "100.00",
    "unitsPerOuter": 0
  }'

Responses

Purchaseorderitem created 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"
}

List purchaseorderitems

Request

Returns a paginated list of Purchaseorderitems 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""outers""pricePerUnit""quantity""supplierCode""taxPerUnit""totalAmount""totalTaxAmount""unitsPerOuter"
sortOrderstring

Sort order

Default "asc"
Enum"asc""desc"
isActiveboolean

Whether this purchase order item is active.

ownershipIdstring

Identifier representing the owning business unit or organization.

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

Identifier of the product being ordered.

Example: productId=123e4567-e89b-12d3-a456-426614174000
purchaseOrderIdstring

Identifier of the related purchase order.

Example: purchaseOrderId=123e4567-e89b-12d3-a456-426614174000
supplierCodestring

Supplier-specific product code, if provided.

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

Responses

Paginated list of Purchaseorderitems

Get purchaseorderitem

Request

Returns a single Purchaseorderitem by its unique identifier.

Security
bearer
Path
siteIdnumberrequired

Site identifier

purchaseorderitemIdstringrequired

Purchaseorderitem unique identifier (UUID)

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

Responses

Purchaseorderitem found

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"
}

Update purchaseorderitem

Request

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

Security
bearer
Path
siteIdnumberrequired

Site identifier

purchaseorderitemIdstringrequired

Purchaseorderitem unique identifier (UUID)

Bodyapplication/jsonrequired
extensionsobject

Vendor- or practice-specific extensions.

isActiveboolean

Whether this purchase order item is active.

outersnumber

Number of outer packs ordered.

ownershipIdstring

Identifier representing the owning business unit or organization.

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

Net price per individual unit, as a decimal string.

Example: "100.00"
productIdstring

Identifier of the product being ordered.

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

Identifier of the related purchase order.

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

Total number of units ordered.

supplierCodestring

Supplier-specific product code, if provided.

taxPerUnitstring

Tax amount per individual unit, as a decimal string.

Example: "100.00"
totalAmountstring

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

Example: "100.00"
totalTaxAmountstring

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

Example: "100.00"
unitsPerOuternumber

Number of units contained in each outer pack.

curl -i -X PATCH \
  '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 updated 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"
}

Replace purchaseorderitem

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"
}

Delete purchaseorderitem

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

Receive Invoice

Operations

Receive Invoice Item

Operations

Requisition Form

Operations

Resource

Operations

Separation

Operations

Sex

Operations

Shelter Animal Booking

Operations

Site Information

Operations

Species

Operations

Standard Diagnostic Lab Report

Operations

Standardofcare

Operations

Stock Adjustment

Operations

Stock Adjustment Item

Operations

Stock Transaction

Operations

Supplied

Operations

System Setting

Operations

Tag

Operations

Tagcategory

Operations

Tagname

Operations

Taxrate

Operations

Template

Operations

Therapeutic

Operations

Transaction

Operations

User

Operations

Vaccination

Operations

Webhook

Operations

Webhook Event

Operations

Wellness Resource

Operations

With Primary Inventory Location

Operations