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

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

Create stock adjustment

Request

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

Security
bearer
Path
siteIdnumberrequired

Site identifier

Bodyapplication/jsonrequired
commentsstring

Free-text comments associated with the stock adjustment.

extensionsobject

Vendor- or practice-specific extensions.

lineItemsArray of objects(LineItemDto)required

Line items that make up this stock adjustment.

lineItems[].​createdAtstring

Timestamp when the line item was created.

Example: "2025-01-01T00:00:00.000Z"
lineItems[].​discountAmountstring

Discount applied to this line item, as a decimal string.

Example: "100.00"
lineItems[].​extensionsobject

Vendor- or practice-specific extensions.

lineItems[].​groupIdstring

Grouping identifier for related line items.

Example: "123e4567-e89b-12d3-a456-426614174000"
lineItems[].​invoiceLineItemIdstringrequired

Identifier for the invoice line item.

Example: "123e4567-e89b-12d3-a456-426614174000"
lineItems[].​isActiveboolean

Whether the line item is active.

lineItems[].​ledgerAccountIdstring

Ledger account associated with this line item.

Example: "123e4567-e89b-12d3-a456-426614174000"
lineItems[].​lineTaxAmountstringrequired

Total tax amount for this line.

Example: "100.00"
lineItems[].​lineTotalAmountstringrequired

Total amount for this line excluding tax.

Example: "100.00"
lineItems[].​lineTypestring

Type/category of the line item.

lineItems[].​locationIdstring

Location associated with this line item.

Example: "123e4567-e89b-12d3-a456-426614174000"
lineItems[].​namestringrequired

Display name/description of the line item.

lineItems[].​ownershipIdstring

Owning organization or business unit for this line item.

Example: "123e4567-e89b-12d3-a456-426614174000"
lineItems[].​productIdstring

Product or service associated with this line item.

Example: "123e4567-e89b-12d3-a456-426614174000"
lineItems[].​quantitynumberrequired

Quantity of the product or service.

lineItems[].​salesPersonIdstring

Salesperson associated with this line item.

Example: "123e4567-e89b-12d3-a456-426614174000"
lineItems[].​standardUnitPriceAmountstring

Standard (list) unit price excluding tax.

Example: "100.00"
lineItems[].​standardUnitTaxAmountstring

Standard (list) tax per unit.

Example: "100.00"
lineItems[].​statusstring

Status of the line item.

lineItems[].​taxCodestring

Tax code applied to this line item.

lineItems[].​taxPercentnumber

Tax percentage applied to this line item.

lineItems[].​unitPriceAmountstringrequired

Unit price excluding tax, as a decimal string.

Example: "100.00"
lineItems[].​unitTaxAmountstring

Tax per unit, as a decimal string.

Example: "100.00"
lineItems[].​updatedAtstring

Timestamp when the line item was last modified.

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

When the stock adjustment occurred (RFC 3339).

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

Identifier of the ownership or separation context this stock adjustment belongs to.

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

Canonical identifier for the stock adjustment.

Example: "123e4567-e89b-12d3-a456-426614174000"
curl -i -X POST \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/stock-adjustment' \
  -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",
    "stockAdjustmentId": "123e4567-e89b-12d3-a456-426614174000"
  }'

Responses

Stock Adjustment created successfully

Bodyapplication/json
commentsstringrequired

Free-text comments associated with the stock adjustment.

createdAtstring(date-time)required

Timestamp when this stock adjustment record was created.

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

Vendor- or practice-specific extensions.

lineItemsArray of objects(LineItemDto)required

Line items that make up this stock adjustment.

lineItems[].​createdAtstring

Timestamp when the line item was created.

Example: "2025-01-01T00:00:00.000Z"
lineItems[].​discountAmountstring

Discount applied to this line item, as a decimal string.

Example: "100.00"
lineItems[].​extensionsobject

Vendor- or practice-specific extensions.

lineItems[].​groupIdstring

Grouping identifier for related line items.

Example: "123e4567-e89b-12d3-a456-426614174000"
lineItems[].​invoiceLineItemIdstringrequired

Identifier for the invoice line item.

Example: "123e4567-e89b-12d3-a456-426614174000"
lineItems[].​isActiveboolean

Whether the line item is active.

lineItems[].​ledgerAccountIdstring

Ledger account associated with this line item.

Example: "123e4567-e89b-12d3-a456-426614174000"
lineItems[].​lineTaxAmountstringrequired

Total tax amount for this line.

Example: "100.00"
lineItems[].​lineTotalAmountstringrequired

Total amount for this line excluding tax.

Example: "100.00"
lineItems[].​lineTypestring

Type/category of the line item.

lineItems[].​locationIdstring

Location associated with this line item.

Example: "123e4567-e89b-12d3-a456-426614174000"
lineItems[].​namestringrequired

Display name/description of the line item.

lineItems[].​ownershipIdstring

Owning organization or business unit for this line item.

Example: "123e4567-e89b-12d3-a456-426614174000"
lineItems[].​productIdstring

Product or service associated with this line item.

Example: "123e4567-e89b-12d3-a456-426614174000"
lineItems[].​quantitynumberrequired

Quantity of the product or service.

lineItems[].​salesPersonIdstring

Salesperson associated with this line item.

Example: "123e4567-e89b-12d3-a456-426614174000"
lineItems[].​standardUnitPriceAmountstring

Standard (list) unit price excluding tax.

Example: "100.00"
lineItems[].​standardUnitTaxAmountstring

Standard (list) tax per unit.

Example: "100.00"
lineItems[].​statusstring

Status of the line item.

lineItems[].​taxCodestring

Tax code applied to this line item.

lineItems[].​taxPercentnumber

Tax percentage applied to this line item.

lineItems[].​unitPriceAmountstringrequired

Unit price excluding tax, as a decimal string.

Example: "100.00"
lineItems[].​unitTaxAmountstring

Tax per unit, as a decimal string.

Example: "100.00"
lineItems[].​updatedAtstring

Timestamp when the line item was last modified.

Example: "2025-01-01T00:00:00.000Z"
occurredAtstring(date-time)required

When the stock adjustment occurred (RFC 3339).

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

Identifier of the ownership or separation context this stock adjustment belongs to.

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

Canonical identifier for the stock adjustment.

Example: "123e4567-e89b-12d3-a456-426614174000"
updatedAtstring(date-time)required

Timestamp when this stock adjustment record was last updated.

Example: "2025-01-01T00:00:00.000Z"
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"
}

List stock adjustments

Request

Returns a paginated list of Stock Adjustments 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""occurredAt"
sortOrderstring

Sort order

Default "asc"
Enum"asc""desc"
commentsstring

Free-text comments associated with the stock adjustment.

ownershipIdstring

Identifier of the ownership or separation context this stock adjustment belongs to.

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

Responses

Paginated list of Stock Adjustments

Get stock adjustment

Request

Returns a single Stock Adjustment by its unique identifier.

Security
bearer
Path
siteIdnumberrequired

Site identifier

stockAdjustmentIdstringrequired

Stock Adjustment unique identifier (UUID)

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

Responses

Stock Adjustment found

Bodyapplication/json
commentsstringrequired

Free-text comments associated with the stock adjustment.

createdAtstring(date-time)required

Timestamp when this stock adjustment record was created.

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

Vendor- or practice-specific extensions.

lineItemsArray of objects(LineItemDto)required

Line items that make up this stock adjustment.

lineItems[].​createdAtstring

Timestamp when the line item was created.

Example: "2025-01-01T00:00:00.000Z"
lineItems[].​discountAmountstring

Discount applied to this line item, as a decimal string.

Example: "100.00"
lineItems[].​extensionsobject

Vendor- or practice-specific extensions.

lineItems[].​groupIdstring

Grouping identifier for related line items.

Example: "123e4567-e89b-12d3-a456-426614174000"
lineItems[].​invoiceLineItemIdstringrequired

Identifier for the invoice line item.

Example: "123e4567-e89b-12d3-a456-426614174000"
lineItems[].​isActiveboolean

Whether the line item is active.

lineItems[].​ledgerAccountIdstring

Ledger account associated with this line item.

Example: "123e4567-e89b-12d3-a456-426614174000"
lineItems[].​lineTaxAmountstringrequired

Total tax amount for this line.

Example: "100.00"
lineItems[].​lineTotalAmountstringrequired

Total amount for this line excluding tax.

Example: "100.00"
lineItems[].​lineTypestring

Type/category of the line item.

lineItems[].​locationIdstring

Location associated with this line item.

Example: "123e4567-e89b-12d3-a456-426614174000"
lineItems[].​namestringrequired

Display name/description of the line item.

lineItems[].​ownershipIdstring

Owning organization or business unit for this line item.

Example: "123e4567-e89b-12d3-a456-426614174000"
lineItems[].​productIdstring

Product or service associated with this line item.

Example: "123e4567-e89b-12d3-a456-426614174000"
lineItems[].​quantitynumberrequired

Quantity of the product or service.

lineItems[].​salesPersonIdstring

Salesperson associated with this line item.

Example: "123e4567-e89b-12d3-a456-426614174000"
lineItems[].​standardUnitPriceAmountstring

Standard (list) unit price excluding tax.

Example: "100.00"
lineItems[].​standardUnitTaxAmountstring

Standard (list) tax per unit.

Example: "100.00"
lineItems[].​statusstring

Status of the line item.

lineItems[].​taxCodestring

Tax code applied to this line item.

lineItems[].​taxPercentnumber

Tax percentage applied to this line item.

lineItems[].​unitPriceAmountstringrequired

Unit price excluding tax, as a decimal string.

Example: "100.00"
lineItems[].​unitTaxAmountstring

Tax per unit, as a decimal string.

Example: "100.00"
lineItems[].​updatedAtstring

Timestamp when the line item was last modified.

Example: "2025-01-01T00:00:00.000Z"
occurredAtstring(date-time)required

When the stock adjustment occurred (RFC 3339).

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

Identifier of the ownership or separation context this stock adjustment belongs to.

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

Canonical identifier for the stock adjustment.

Example: "123e4567-e89b-12d3-a456-426614174000"
updatedAtstring(date-time)required

Timestamp when this stock adjustment record was last updated.

Example: "2025-01-01T00:00:00.000Z"
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"
}

Update stock adjustment

Request

Partially updates an existing Stock Adjustment. Only provided fields will be updated.

Security
bearer
Path
siteIdnumberrequired

Site identifier

stockAdjustmentIdstringrequired

Stock Adjustment unique identifier (UUID)

Bodyapplication/jsonrequired
commentsstring

Free-text comments associated with the stock adjustment.

extensionsobject

Vendor- or practice-specific extensions.

lineItemsArray of objects(LineItemDto)

Line items that make up this stock adjustment.

occurredAtstring

When the stock adjustment occurred (RFC 3339).

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

Identifier of the ownership or separation context this stock adjustment belongs to.

Example: "123e4567-e89b-12d3-a456-426614174000"
curl -i -X PATCH \
  '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"
  }'

Responses

Stock Adjustment updated successfully

Bodyapplication/json
commentsstringrequired

Free-text comments associated with the stock adjustment.

createdAtstring(date-time)required

Timestamp when this stock adjustment record was created.

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

Vendor- or practice-specific extensions.

lineItemsArray of objects(LineItemDto)required

Line items that make up this stock adjustment.

lineItems[].​createdAtstring

Timestamp when the line item was created.

Example: "2025-01-01T00:00:00.000Z"
lineItems[].​discountAmountstring

Discount applied to this line item, as a decimal string.

Example: "100.00"
lineItems[].​extensionsobject

Vendor- or practice-specific extensions.

lineItems[].​groupIdstring

Grouping identifier for related line items.

Example: "123e4567-e89b-12d3-a456-426614174000"
lineItems[].​invoiceLineItemIdstringrequired

Identifier for the invoice line item.

Example: "123e4567-e89b-12d3-a456-426614174000"
lineItems[].​isActiveboolean

Whether the line item is active.

lineItems[].​ledgerAccountIdstring

Ledger account associated with this line item.

Example: "123e4567-e89b-12d3-a456-426614174000"
lineItems[].​lineTaxAmountstringrequired

Total tax amount for this line.

Example: "100.00"
lineItems[].​lineTotalAmountstringrequired

Total amount for this line excluding tax.

Example: "100.00"
lineItems[].​lineTypestring

Type/category of the line item.

lineItems[].​locationIdstring

Location associated with this line item.

Example: "123e4567-e89b-12d3-a456-426614174000"
lineItems[].​namestringrequired

Display name/description of the line item.

lineItems[].​ownershipIdstring

Owning organization or business unit for this line item.

Example: "123e4567-e89b-12d3-a456-426614174000"
lineItems[].​productIdstring

Product or service associated with this line item.

Example: "123e4567-e89b-12d3-a456-426614174000"
lineItems[].​quantitynumberrequired

Quantity of the product or service.

lineItems[].​salesPersonIdstring

Salesperson associated with this line item.

Example: "123e4567-e89b-12d3-a456-426614174000"
lineItems[].​standardUnitPriceAmountstring

Standard (list) unit price excluding tax.

Example: "100.00"
lineItems[].​standardUnitTaxAmountstring

Standard (list) tax per unit.

Example: "100.00"
lineItems[].​statusstring

Status of the line item.

lineItems[].​taxCodestring

Tax code applied to this line item.

lineItems[].​taxPercentnumber

Tax percentage applied to this line item.

lineItems[].​unitPriceAmountstringrequired

Unit price excluding tax, as a decimal string.

Example: "100.00"
lineItems[].​unitTaxAmountstring

Tax per unit, as a decimal string.

Example: "100.00"
lineItems[].​updatedAtstring

Timestamp when the line item was last modified.

Example: "2025-01-01T00:00:00.000Z"
occurredAtstring(date-time)required

When the stock adjustment occurred (RFC 3339).

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

Identifier of the ownership or separation context this stock adjustment belongs to.

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

Canonical identifier for the stock adjustment.

Example: "123e4567-e89b-12d3-a456-426614174000"
updatedAtstring(date-time)required

Timestamp when this stock adjustment record was last updated.

Example: "2025-01-01T00:00:00.000Z"
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"
}

Replace stock adjustment

Request

Fully replaces an existing Stock Adjustment. All fields must be provided.

Security
bearer
Path
siteIdnumberrequired

Site identifier

stockAdjustmentIdstringrequired

Stock Adjustment unique identifier (UUID)

Bodyapplication/jsonrequired
commentsstringrequired

Free-text comments associated with the stock adjustment.

extensionsobjectrequired

Vendor- or practice-specific extensions.

lineItemsArray of objects(LineItemDto)required

Line items that make up this stock adjustment.

lineItems[].​createdAtstring

Timestamp when the line item was created.

Example: "2025-01-01T00:00:00.000Z"
lineItems[].​discountAmountstring

Discount applied to this line item, as a decimal string.

Example: "100.00"
lineItems[].​extensionsobject

Vendor- or practice-specific extensions.

lineItems[].​groupIdstring

Grouping identifier for related line items.

Example: "123e4567-e89b-12d3-a456-426614174000"
lineItems[].​invoiceLineItemIdstringrequired

Identifier for the invoice line item.

Example: "123e4567-e89b-12d3-a456-426614174000"
lineItems[].​isActiveboolean

Whether the line item is active.

lineItems[].​ledgerAccountIdstring

Ledger account associated with this line item.

Example: "123e4567-e89b-12d3-a456-426614174000"
lineItems[].​lineTaxAmountstringrequired

Total tax amount for this line.

Example: "100.00"
lineItems[].​lineTotalAmountstringrequired

Total amount for this line excluding tax.

Example: "100.00"
lineItems[].​lineTypestring

Type/category of the line item.

lineItems[].​locationIdstring

Location associated with this line item.

Example: "123e4567-e89b-12d3-a456-426614174000"
lineItems[].​namestringrequired

Display name/description of the line item.

lineItems[].​ownershipIdstring

Owning organization or business unit for this line item.

Example: "123e4567-e89b-12d3-a456-426614174000"
lineItems[].​productIdstring

Product or service associated with this line item.

Example: "123e4567-e89b-12d3-a456-426614174000"
lineItems[].​quantitynumberrequired

Quantity of the product or service.

lineItems[].​salesPersonIdstring

Salesperson associated with this line item.

Example: "123e4567-e89b-12d3-a456-426614174000"
lineItems[].​standardUnitPriceAmountstring

Standard (list) unit price excluding tax.

Example: "100.00"
lineItems[].​standardUnitTaxAmountstring

Standard (list) tax per unit.

Example: "100.00"
lineItems[].​statusstring

Status of the line item.

lineItems[].​taxCodestring

Tax code applied to this line item.

lineItems[].​taxPercentnumber

Tax percentage applied to this line item.

lineItems[].​unitPriceAmountstringrequired

Unit price excluding tax, as a decimal string.

Example: "100.00"
lineItems[].​unitTaxAmountstring

Tax per unit, as a decimal string.

Example: "100.00"
lineItems[].​updatedAtstring

Timestamp when the line item was last modified.

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

When the stock adjustment occurred (RFC 3339).

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

Identifier of the ownership or separation context this stock adjustment belongs to.

Example: "123e4567-e89b-12d3-a456-426614174000"
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"
  }'

Responses

Stock Adjustment replaced successfully

Bodyapplication/json
commentsstringrequired

Free-text comments associated with the stock adjustment.

createdAtstring(date-time)required

Timestamp when this stock adjustment record was created.

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

Vendor- or practice-specific extensions.

lineItemsArray of objects(LineItemDto)required

Line items that make up this stock adjustment.

lineItems[].​createdAtstring

Timestamp when the line item was created.

Example: "2025-01-01T00:00:00.000Z"
lineItems[].​discountAmountstring

Discount applied to this line item, as a decimal string.

Example: "100.00"
lineItems[].​extensionsobject

Vendor- or practice-specific extensions.

lineItems[].​groupIdstring

Grouping identifier for related line items.

Example: "123e4567-e89b-12d3-a456-426614174000"
lineItems[].​invoiceLineItemIdstringrequired

Identifier for the invoice line item.

Example: "123e4567-e89b-12d3-a456-426614174000"
lineItems[].​isActiveboolean

Whether the line item is active.

lineItems[].​ledgerAccountIdstring

Ledger account associated with this line item.

Example: "123e4567-e89b-12d3-a456-426614174000"
lineItems[].​lineTaxAmountstringrequired

Total tax amount for this line.

Example: "100.00"
lineItems[].​lineTotalAmountstringrequired

Total amount for this line excluding tax.

Example: "100.00"
lineItems[].​lineTypestring

Type/category of the line item.

lineItems[].​locationIdstring

Location associated with this line item.

Example: "123e4567-e89b-12d3-a456-426614174000"
lineItems[].​namestringrequired

Display name/description of the line item.

lineItems[].​ownershipIdstring

Owning organization or business unit for this line item.

Example: "123e4567-e89b-12d3-a456-426614174000"
lineItems[].​productIdstring

Product or service associated with this line item.

Example: "123e4567-e89b-12d3-a456-426614174000"
lineItems[].​quantitynumberrequired

Quantity of the product or service.

lineItems[].​salesPersonIdstring

Salesperson associated with this line item.

Example: "123e4567-e89b-12d3-a456-426614174000"
lineItems[].​standardUnitPriceAmountstring

Standard (list) unit price excluding tax.

Example: "100.00"
lineItems[].​standardUnitTaxAmountstring

Standard (list) tax per unit.

Example: "100.00"
lineItems[].​statusstring

Status of the line item.

lineItems[].​taxCodestring

Tax code applied to this line item.

lineItems[].​taxPercentnumber

Tax percentage applied to this line item.

lineItems[].​unitPriceAmountstringrequired

Unit price excluding tax, as a decimal string.

Example: "100.00"
lineItems[].​unitTaxAmountstring

Tax per unit, as a decimal string.

Example: "100.00"
lineItems[].​updatedAtstring

Timestamp when the line item was last modified.

Example: "2025-01-01T00:00:00.000Z"
occurredAtstring(date-time)required

When the stock adjustment occurred (RFC 3339).

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

Identifier of the ownership or separation context this stock adjustment belongs to.

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

Canonical identifier for the stock adjustment.

Example: "123e4567-e89b-12d3-a456-426614174000"
updatedAtstring(date-time)required

Timestamp when this stock adjustment record was last updated.

Example: "2025-01-01T00:00:00.000Z"
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"
}

Delete stock adjustment

Request

Permanently deletes a Stock Adjustment record.

Security
bearer
Path
siteIdnumberrequired

Site identifier

stockAdjustmentIdstringrequired

Stock Adjustment unique identifier (UUID)

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

Responses

Stock Adjustment deleted successfully

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