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

Create receive invoice item

Request

Creates a new Receive Invoice Item record. Receive Invoice Item resource in the Animal Health Data Store

Security
bearer
Path
siteIdnumberrequired

Site identifier

Bodyapplication/jsonrequired
batchesArray of objects(BatcheDto)

Batch/lot information associated with this receive invoice item.

commentsstring or null

Comments related to this receive invoice item.

extensionsobject

Vendor- or practice-specific extensions.

isActivebooleanrequired

If true, the receive invoice item is active and usable.

lineTotalstringrequired

Total line amount excluding tax as a decimal string.

Example: "100.00"
lineTotalTaxstringrequired

Total tax amount for this line as a decimal string.

Example: "100.00"
locationIdstring or null

Identifier of the inventory location associated with this item.

Example: "123e4567-e89b-12d3-a456-426614174000"
namestring or null

Optional descriptive name for the receive invoice item.

ownershipIdstring or null

Identifier of the ownership separation this item belongs to.

Example: "123e4567-e89b-12d3-a456-426614174000"
productIdstring or null

Identifier of the product on this receive invoice item.

Example: "123e4567-e89b-12d3-a456-426614174000"
productSupplierIdstring or null

Identifier of the product-supplier relationship for this item.

Example: "123e4567-e89b-12d3-a456-426614174000"
purchaseOrderItemIdstring or null

Identifier of the related purchase order item, if any.

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

Quantity of product invoiced. May represent outers or units depending on supplier configuration.

receiveInvoiceIdstringrequired

Identifier of the receive invoice this item belongs to.

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

Canonical identifier for this receive invoice item.

Example: "123e4567-e89b-12d3-a456-426614174000"
supplierCodestring or null

Supplier's product code for this item.

taxCodestring or null

Tax code applied to this line.

taxRatenumber or null

Tax rate applied to this line, expressed as a percentage (e.g., 15 for 15%).

unitPricestringrequired

Price per selling unit as a decimal string.

Example: "100.00"
unitTaxAmountstringrequired

Tax amount per selling unit as a decimal string.

Example: "100.00"
curl -i -X POST \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/receive-invoice-item' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "batches": [
      {
        "batchId": "123e4567-e89b-12d3-a456-426614174000",
        "createdAt": "2025-01-01T00:00:00.000Z",
        "expiryDate": "2025-01-01",
        "isActive": true,
        "name": "string",
        "quantity": 0,
        "type": "string",
        "updatedAt": "2025-01-01T00:00:00.000Z"
      }
    ],
    "comments": "string",
    "extensions": {},
    "isActive": true,
    "lineTotal": "100.00",
    "lineTotalTax": "100.00",
    "locationId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "string",
    "ownershipId": "123e4567-e89b-12d3-a456-426614174000",
    "productId": "123e4567-e89b-12d3-a456-426614174000",
    "productSupplierId": "123e4567-e89b-12d3-a456-426614174000",
    "purchaseOrderItemId": "123e4567-e89b-12d3-a456-426614174000",
    "quantity": 0,
    "receiveInvoiceId": "123e4567-e89b-12d3-a456-426614174000",
    "receiveInvoiceItemId": "123e4567-e89b-12d3-a456-426614174000",
    "supplierCode": "string",
    "taxCode": "string",
    "taxRate": 0,
    "unitPrice": "100.00",
    "unitTaxAmount": "100.00"
  }'

Responses

Receive Invoice Item created successfully

Bodyapplication/json
batchesArray of objects(BatcheDto)required

Batch/lot information associated with this receive invoice item.

batches[].​batchIdstring or null

Identifier of the batch record.

Example: "123e4567-e89b-12d3-a456-426614174000"
batches[].​createdAtstring or null

Timestamp when this batch record was created.

Example: "2025-01-01T00:00:00.000Z"
batches[].​expiryDatestring or null

Expiry date of the batch, if applicable.

Example: "2025-01-01"
batches[].​isActiveboolean or null

If true, the batch is active.

batches[].​namestring or null

Batch or lot name/number.

batches[].​quantitynumber or null

Quantity from this batch associated with the receive invoice item.

batches[].​typestring or null

Batch type classification.

batches[].​updatedAtstring or null

Timestamp when this batch record was last modified.

Example: "2025-01-01T00:00:00.000Z"
commentsstring or nullrequired

Comments related to this receive invoice item.

createdAtstring(date-time)required

Timestamp when this receive invoice item was created.

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

Vendor- or practice-specific extensions.

isActivebooleanrequired

If true, the receive invoice item is active and usable.

lineTotalstringrequired

Total line amount excluding tax as a decimal string.

Example: "100.00"
lineTotalTaxstringrequired

Total tax amount for this line as a decimal string.

Example: "100.00"
locationIdstring or nullrequired

Identifier of the inventory location associated with this item.

Example: "123e4567-e89b-12d3-a456-426614174000"
namestring or nullrequired

Optional descriptive name for the receive invoice item.

ownershipIdstring or nullrequired

Identifier of the ownership separation this item belongs to.

Example: "123e4567-e89b-12d3-a456-426614174000"
productIdstring or nullrequired

Identifier of the product on this receive invoice item.

Example: "123e4567-e89b-12d3-a456-426614174000"
productSupplierIdstring or nullrequired

Identifier of the product-supplier relationship for this item.

Example: "123e4567-e89b-12d3-a456-426614174000"
purchaseOrderItemIdstring or nullrequired

Identifier of the related purchase order item, if any.

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

Quantity of product invoiced. May represent outers or units depending on supplier configuration.

receiveInvoiceIdstringrequired

Identifier of the receive invoice this item belongs to.

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

Canonical identifier for this receive invoice item.

Example: "123e4567-e89b-12d3-a456-426614174000"
supplierCodestring or nullrequired

Supplier's product code for this item.

taxCodestring or nullrequired

Tax code applied to this line.

taxRatenumber or nullrequired

Tax rate applied to this line, expressed as a percentage (e.g., 15 for 15%).

unitPricestringrequired

Price per selling unit as a decimal string.

Example: "100.00"
unitTaxAmountstringrequired

Tax amount per selling unit as a decimal string.

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

Timestamp when this receive invoice item was last modified.

Example: "2025-01-01T00:00:00.000Z"
Response
application/json
{
  "batches": [
    { … }
  ],
  "comments": "string",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "extensions": {},
  "isActive": true,
  "lineTotal": "100.00",
  "lineTotalTax": "100.00",
  "locationId": "123e4567-e89b-12d3-a456-426614174000",
  "name": "string",
  "ownershipId": "123e4567-e89b-12d3-a456-426614174000",
  "productId": "123e4567-e89b-12d3-a456-426614174000",
  "productSupplierId": "123e4567-e89b-12d3-a456-426614174000",
  "purchaseOrderItemId": "123e4567-e89b-12d3-a456-426614174000",
  "quantity": 0,
  "receiveInvoiceId": "123e4567-e89b-12d3-a456-426614174000",
  "receiveInvoiceItemId": "123e4567-e89b-12d3-a456-426614174000",
  "supplierCode": "string",
  "taxCode": "string",
  "taxRate": 0,
  "unitPrice": "100.00",
  "unitTaxAmount": "100.00",
  "updatedAt": "2025-01-01T00:00:00.000Z"
}

List receive invoice items

Request

Returns a paginated list of Receive Invoice Items 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""lineTotal""lineTotalTax""name""quantity""supplierCode""taxCode""taxRate"
sortOrderstring

Sort order

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

Comments related to this receive invoice item.

isActiveboolean

If true, the receive invoice item is active and usable.

locationIdstring

Identifier of the inventory location associated with this item.

Example: locationId=123e4567-e89b-12d3-a456-426614174000
namestring

Optional descriptive name for the receive invoice item.

ownershipIdstring

Identifier of the ownership separation this item belongs to.

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

Identifier of the product on this receive invoice item.

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

Identifier of the product-supplier relationship for this item.

Example: productSupplierId=123e4567-e89b-12d3-a456-426614174000
purchaseOrderItemIdstring

Identifier of the related purchase order item, if any.

Example: purchaseOrderItemId=123e4567-e89b-12d3-a456-426614174000
receiveInvoiceIdstring

Identifier of the receive invoice this item belongs to.

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

Supplier's product code for this item.

taxCodestring

Tax code applied to this line.

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

Responses

Paginated list of Receive Invoice Items

Get receive invoice item

Request

Returns a single Receive Invoice Item by its unique identifier.

Security
bearer
Path
siteIdnumberrequired

Site identifier

receiveInvoiceItemIdstringrequired

Receive Invoice Item unique identifier (UUID)

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

Responses

Receive Invoice Item found

Bodyapplication/json
batchesArray of objects(BatcheDto)required

Batch/lot information associated with this receive invoice item.

batches[].​batchIdstring or null

Identifier of the batch record.

Example: "123e4567-e89b-12d3-a456-426614174000"
batches[].​createdAtstring or null

Timestamp when this batch record was created.

Example: "2025-01-01T00:00:00.000Z"
batches[].​expiryDatestring or null

Expiry date of the batch, if applicable.

Example: "2025-01-01"
batches[].​isActiveboolean or null

If true, the batch is active.

batches[].​namestring or null

Batch or lot name/number.

batches[].​quantitynumber or null

Quantity from this batch associated with the receive invoice item.

batches[].​typestring or null

Batch type classification.

batches[].​updatedAtstring or null

Timestamp when this batch record was last modified.

Example: "2025-01-01T00:00:00.000Z"
commentsstring or nullrequired

Comments related to this receive invoice item.

createdAtstring(date-time)required

Timestamp when this receive invoice item was created.

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

Vendor- or practice-specific extensions.

isActivebooleanrequired

If true, the receive invoice item is active and usable.

lineTotalstringrequired

Total line amount excluding tax as a decimal string.

Example: "100.00"
lineTotalTaxstringrequired

Total tax amount for this line as a decimal string.

Example: "100.00"
locationIdstring or nullrequired

Identifier of the inventory location associated with this item.

Example: "123e4567-e89b-12d3-a456-426614174000"
namestring or nullrequired

Optional descriptive name for the receive invoice item.

ownershipIdstring or nullrequired

Identifier of the ownership separation this item belongs to.

Example: "123e4567-e89b-12d3-a456-426614174000"
productIdstring or nullrequired

Identifier of the product on this receive invoice item.

Example: "123e4567-e89b-12d3-a456-426614174000"
productSupplierIdstring or nullrequired

Identifier of the product-supplier relationship for this item.

Example: "123e4567-e89b-12d3-a456-426614174000"
purchaseOrderItemIdstring or nullrequired

Identifier of the related purchase order item, if any.

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

Quantity of product invoiced. May represent outers or units depending on supplier configuration.

receiveInvoiceIdstringrequired

Identifier of the receive invoice this item belongs to.

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

Canonical identifier for this receive invoice item.

Example: "123e4567-e89b-12d3-a456-426614174000"
supplierCodestring or nullrequired

Supplier's product code for this item.

taxCodestring or nullrequired

Tax code applied to this line.

taxRatenumber or nullrequired

Tax rate applied to this line, expressed as a percentage (e.g., 15 for 15%).

unitPricestringrequired

Price per selling unit as a decimal string.

Example: "100.00"
unitTaxAmountstringrequired

Tax amount per selling unit as a decimal string.

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

Timestamp when this receive invoice item was last modified.

Example: "2025-01-01T00:00:00.000Z"
Response
application/json
{
  "batches": [
    { … }
  ],
  "comments": "string",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "extensions": {},
  "isActive": true,
  "lineTotal": "100.00",
  "lineTotalTax": "100.00",
  "locationId": "123e4567-e89b-12d3-a456-426614174000",
  "name": "string",
  "ownershipId": "123e4567-e89b-12d3-a456-426614174000",
  "productId": "123e4567-e89b-12d3-a456-426614174000",
  "productSupplierId": "123e4567-e89b-12d3-a456-426614174000",
  "purchaseOrderItemId": "123e4567-e89b-12d3-a456-426614174000",
  "quantity": 0,
  "receiveInvoiceId": "123e4567-e89b-12d3-a456-426614174000",
  "receiveInvoiceItemId": "123e4567-e89b-12d3-a456-426614174000",
  "supplierCode": "string",
  "taxCode": "string",
  "taxRate": 0,
  "unitPrice": "100.00",
  "unitTaxAmount": "100.00",
  "updatedAt": "2025-01-01T00:00:00.000Z"
}

Update receive invoice item

Request

Partially updates an existing Receive Invoice Item. Only provided fields will be updated.

Security
bearer
Path
siteIdnumberrequired

Site identifier

receiveInvoiceItemIdstringrequired

Receive Invoice Item unique identifier (UUID)

Bodyapplication/jsonrequired
batchesArray of objects(BatcheDto)

Batch/lot information associated with this receive invoice item.

commentsstring or null

Comments related to this receive invoice item.

extensionsobject

Vendor- or practice-specific extensions.

isActiveboolean

If true, the receive invoice item is active and usable.

lineTotalstring

Total line amount excluding tax as a decimal string.

Example: "100.00"
lineTotalTaxstring

Total tax amount for this line as a decimal string.

Example: "100.00"
locationIdstring or null

Identifier of the inventory location associated with this item.

Example: "123e4567-e89b-12d3-a456-426614174000"
namestring or null

Optional descriptive name for the receive invoice item.

ownershipIdstring or null

Identifier of the ownership separation this item belongs to.

Example: "123e4567-e89b-12d3-a456-426614174000"
productIdstring or null

Identifier of the product on this receive invoice item.

Example: "123e4567-e89b-12d3-a456-426614174000"
productSupplierIdstring or null

Identifier of the product-supplier relationship for this item.

Example: "123e4567-e89b-12d3-a456-426614174000"
purchaseOrderItemIdstring or null

Identifier of the related purchase order item, if any.

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

Quantity of product invoiced. May represent outers or units depending on supplier configuration.

receiveInvoiceIdstring

Identifier of the receive invoice this item belongs to.

Example: "123e4567-e89b-12d3-a456-426614174000"
supplierCodestring or null

Supplier's product code for this item.

taxCodestring or null

Tax code applied to this line.

taxRatenumber or null

Tax rate applied to this line, expressed as a percentage (e.g., 15 for 15%).

unitPricestring

Price per selling unit as a decimal string.

Example: "100.00"
unitTaxAmountstring

Tax amount per selling unit as a decimal string.

Example: "100.00"
curl -i -X PATCH \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/receive-invoice-item/{receiveInvoiceItemId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "batches": [
      {
        "batchId": "123e4567-e89b-12d3-a456-426614174000",
        "createdAt": "2025-01-01T00:00:00.000Z",
        "expiryDate": "2025-01-01",
        "isActive": true,
        "name": "string",
        "quantity": 0,
        "type": "string",
        "updatedAt": "2025-01-01T00:00:00.000Z"
      }
    ],
    "comments": "string",
    "extensions": {},
    "isActive": true,
    "lineTotal": "100.00",
    "lineTotalTax": "100.00",
    "locationId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "string",
    "ownershipId": "123e4567-e89b-12d3-a456-426614174000",
    "productId": "123e4567-e89b-12d3-a456-426614174000",
    "productSupplierId": "123e4567-e89b-12d3-a456-426614174000",
    "purchaseOrderItemId": "123e4567-e89b-12d3-a456-426614174000",
    "quantity": 0,
    "receiveInvoiceId": "123e4567-e89b-12d3-a456-426614174000",
    "supplierCode": "string",
    "taxCode": "string",
    "taxRate": 0,
    "unitPrice": "100.00",
    "unitTaxAmount": "100.00"
  }'

Responses

Receive Invoice Item updated successfully

Bodyapplication/json
batchesArray of objects(BatcheDto)required

Batch/lot information associated with this receive invoice item.

batches[].​batchIdstring or null

Identifier of the batch record.

Example: "123e4567-e89b-12d3-a456-426614174000"
batches[].​createdAtstring or null

Timestamp when this batch record was created.

Example: "2025-01-01T00:00:00.000Z"
batches[].​expiryDatestring or null

Expiry date of the batch, if applicable.

Example: "2025-01-01"
batches[].​isActiveboolean or null

If true, the batch is active.

batches[].​namestring or null

Batch or lot name/number.

batches[].​quantitynumber or null

Quantity from this batch associated with the receive invoice item.

batches[].​typestring or null

Batch type classification.

batches[].​updatedAtstring or null

Timestamp when this batch record was last modified.

Example: "2025-01-01T00:00:00.000Z"
commentsstring or nullrequired

Comments related to this receive invoice item.

createdAtstring(date-time)required

Timestamp when this receive invoice item was created.

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

Vendor- or practice-specific extensions.

isActivebooleanrequired

If true, the receive invoice item is active and usable.

lineTotalstringrequired

Total line amount excluding tax as a decimal string.

Example: "100.00"
lineTotalTaxstringrequired

Total tax amount for this line as a decimal string.

Example: "100.00"
locationIdstring or nullrequired

Identifier of the inventory location associated with this item.

Example: "123e4567-e89b-12d3-a456-426614174000"
namestring or nullrequired

Optional descriptive name for the receive invoice item.

ownershipIdstring or nullrequired

Identifier of the ownership separation this item belongs to.

Example: "123e4567-e89b-12d3-a456-426614174000"
productIdstring or nullrequired

Identifier of the product on this receive invoice item.

Example: "123e4567-e89b-12d3-a456-426614174000"
productSupplierIdstring or nullrequired

Identifier of the product-supplier relationship for this item.

Example: "123e4567-e89b-12d3-a456-426614174000"
purchaseOrderItemIdstring or nullrequired

Identifier of the related purchase order item, if any.

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

Quantity of product invoiced. May represent outers or units depending on supplier configuration.

receiveInvoiceIdstringrequired

Identifier of the receive invoice this item belongs to.

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

Canonical identifier for this receive invoice item.

Example: "123e4567-e89b-12d3-a456-426614174000"
supplierCodestring or nullrequired

Supplier's product code for this item.

taxCodestring or nullrequired

Tax code applied to this line.

taxRatenumber or nullrequired

Tax rate applied to this line, expressed as a percentage (e.g., 15 for 15%).

unitPricestringrequired

Price per selling unit as a decimal string.

Example: "100.00"
unitTaxAmountstringrequired

Tax amount per selling unit as a decimal string.

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

Timestamp when this receive invoice item was last modified.

Example: "2025-01-01T00:00:00.000Z"
Response
application/json
{
  "batches": [
    { … }
  ],
  "comments": "string",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "extensions": {},
  "isActive": true,
  "lineTotal": "100.00",
  "lineTotalTax": "100.00",
  "locationId": "123e4567-e89b-12d3-a456-426614174000",
  "name": "string",
  "ownershipId": "123e4567-e89b-12d3-a456-426614174000",
  "productId": "123e4567-e89b-12d3-a456-426614174000",
  "productSupplierId": "123e4567-e89b-12d3-a456-426614174000",
  "purchaseOrderItemId": "123e4567-e89b-12d3-a456-426614174000",
  "quantity": 0,
  "receiveInvoiceId": "123e4567-e89b-12d3-a456-426614174000",
  "receiveInvoiceItemId": "123e4567-e89b-12d3-a456-426614174000",
  "supplierCode": "string",
  "taxCode": "string",
  "taxRate": 0,
  "unitPrice": "100.00",
  "unitTaxAmount": "100.00",
  "updatedAt": "2025-01-01T00:00:00.000Z"
}

Replace receive invoice item

Request

Fully replaces an existing Receive Invoice Item. All fields must be provided.

Security
bearer
Path
siteIdnumberrequired

Site identifier

receiveInvoiceItemIdstringrequired

Receive Invoice Item unique identifier (UUID)

Bodyapplication/jsonrequired
batchesArray of objects(BatcheDto)required

Batch/lot information associated with this receive invoice item.

batches[].​batchIdstring or null

Identifier of the batch record.

Example: "123e4567-e89b-12d3-a456-426614174000"
batches[].​createdAtstring or null

Timestamp when this batch record was created.

Example: "2025-01-01T00:00:00.000Z"
batches[].​expiryDatestring or null

Expiry date of the batch, if applicable.

Example: "2025-01-01"
batches[].​isActiveboolean or null

If true, the batch is active.

batches[].​namestring or null

Batch or lot name/number.

batches[].​quantitynumber or null

Quantity from this batch associated with the receive invoice item.

batches[].​typestring or null

Batch type classification.

batches[].​updatedAtstring or null

Timestamp when this batch record was last modified.

Example: "2025-01-01T00:00:00.000Z"
commentsstring or null

Comments related to this receive invoice item.

extensionsobjectrequired

Vendor- or practice-specific extensions.

isActivebooleanrequired

If true, the receive invoice item is active and usable.

lineTotalstringrequired

Total line amount excluding tax as a decimal string.

Example: "100.00"
lineTotalTaxstringrequired

Total tax amount for this line as a decimal string.

Example: "100.00"
locationIdstring or null

Identifier of the inventory location associated with this item.

Example: "123e4567-e89b-12d3-a456-426614174000"
namestring or null

Optional descriptive name for the receive invoice item.

ownershipIdstring or null

Identifier of the ownership separation this item belongs to.

Example: "123e4567-e89b-12d3-a456-426614174000"
productIdstring or null

Identifier of the product on this receive invoice item.

Example: "123e4567-e89b-12d3-a456-426614174000"
productSupplierIdstring or null

Identifier of the product-supplier relationship for this item.

Example: "123e4567-e89b-12d3-a456-426614174000"
purchaseOrderItemIdstring or null

Identifier of the related purchase order item, if any.

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

Quantity of product invoiced. May represent outers or units depending on supplier configuration.

receiveInvoiceIdstringrequired

Identifier of the receive invoice this item belongs to.

Example: "123e4567-e89b-12d3-a456-426614174000"
supplierCodestring or null

Supplier's product code for this item.

taxCodestring or null

Tax code applied to this line.

taxRatenumber or null

Tax rate applied to this line, expressed as a percentage (e.g., 15 for 15%).

unitPricestringrequired

Price per selling unit as a decimal string.

Example: "100.00"
unitTaxAmountstringrequired

Tax amount per selling unit as a decimal string.

Example: "100.00"
curl -i -X PUT \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/receive-invoice-item/{receiveInvoiceItemId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "batches": [
      {
        "batchId": "123e4567-e89b-12d3-a456-426614174000",
        "createdAt": "2025-01-01T00:00:00.000Z",
        "expiryDate": "2025-01-01",
        "isActive": true,
        "name": "string",
        "quantity": 0,
        "type": "string",
        "updatedAt": "2025-01-01T00:00:00.000Z"
      }
    ],
    "comments": "string",
    "extensions": {},
    "isActive": true,
    "lineTotal": "100.00",
    "lineTotalTax": "100.00",
    "locationId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "string",
    "ownershipId": "123e4567-e89b-12d3-a456-426614174000",
    "productId": "123e4567-e89b-12d3-a456-426614174000",
    "productSupplierId": "123e4567-e89b-12d3-a456-426614174000",
    "purchaseOrderItemId": "123e4567-e89b-12d3-a456-426614174000",
    "quantity": 0,
    "receiveInvoiceId": "123e4567-e89b-12d3-a456-426614174000",
    "supplierCode": "string",
    "taxCode": "string",
    "taxRate": 0,
    "unitPrice": "100.00",
    "unitTaxAmount": "100.00"
  }'

Responses

Receive Invoice Item replaced successfully

Bodyapplication/json
batchesArray of objects(BatcheDto)required

Batch/lot information associated with this receive invoice item.

batches[].​batchIdstring or null

Identifier of the batch record.

Example: "123e4567-e89b-12d3-a456-426614174000"
batches[].​createdAtstring or null

Timestamp when this batch record was created.

Example: "2025-01-01T00:00:00.000Z"
batches[].​expiryDatestring or null

Expiry date of the batch, if applicable.

Example: "2025-01-01"
batches[].​isActiveboolean or null

If true, the batch is active.

batches[].​namestring or null

Batch or lot name/number.

batches[].​quantitynumber or null

Quantity from this batch associated with the receive invoice item.

batches[].​typestring or null

Batch type classification.

batches[].​updatedAtstring or null

Timestamp when this batch record was last modified.

Example: "2025-01-01T00:00:00.000Z"
commentsstring or nullrequired

Comments related to this receive invoice item.

createdAtstring(date-time)required

Timestamp when this receive invoice item was created.

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

Vendor- or practice-specific extensions.

isActivebooleanrequired

If true, the receive invoice item is active and usable.

lineTotalstringrequired

Total line amount excluding tax as a decimal string.

Example: "100.00"
lineTotalTaxstringrequired

Total tax amount for this line as a decimal string.

Example: "100.00"
locationIdstring or nullrequired

Identifier of the inventory location associated with this item.

Example: "123e4567-e89b-12d3-a456-426614174000"
namestring or nullrequired

Optional descriptive name for the receive invoice item.

ownershipIdstring or nullrequired

Identifier of the ownership separation this item belongs to.

Example: "123e4567-e89b-12d3-a456-426614174000"
productIdstring or nullrequired

Identifier of the product on this receive invoice item.

Example: "123e4567-e89b-12d3-a456-426614174000"
productSupplierIdstring or nullrequired

Identifier of the product-supplier relationship for this item.

Example: "123e4567-e89b-12d3-a456-426614174000"
purchaseOrderItemIdstring or nullrequired

Identifier of the related purchase order item, if any.

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

Quantity of product invoiced. May represent outers or units depending on supplier configuration.

receiveInvoiceIdstringrequired

Identifier of the receive invoice this item belongs to.

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

Canonical identifier for this receive invoice item.

Example: "123e4567-e89b-12d3-a456-426614174000"
supplierCodestring or nullrequired

Supplier's product code for this item.

taxCodestring or nullrequired

Tax code applied to this line.

taxRatenumber or nullrequired

Tax rate applied to this line, expressed as a percentage (e.g., 15 for 15%).

unitPricestringrequired

Price per selling unit as a decimal string.

Example: "100.00"
unitTaxAmountstringrequired

Tax amount per selling unit as a decimal string.

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

Timestamp when this receive invoice item was last modified.

Example: "2025-01-01T00:00:00.000Z"
Response
application/json
{
  "batches": [
    { … }
  ],
  "comments": "string",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "extensions": {},
  "isActive": true,
  "lineTotal": "100.00",
  "lineTotalTax": "100.00",
  "locationId": "123e4567-e89b-12d3-a456-426614174000",
  "name": "string",
  "ownershipId": "123e4567-e89b-12d3-a456-426614174000",
  "productId": "123e4567-e89b-12d3-a456-426614174000",
  "productSupplierId": "123e4567-e89b-12d3-a456-426614174000",
  "purchaseOrderItemId": "123e4567-e89b-12d3-a456-426614174000",
  "quantity": 0,
  "receiveInvoiceId": "123e4567-e89b-12d3-a456-426614174000",
  "receiveInvoiceItemId": "123e4567-e89b-12d3-a456-426614174000",
  "supplierCode": "string",
  "taxCode": "string",
  "taxRate": 0,
  "unitPrice": "100.00",
  "unitTaxAmount": "100.00",
  "updatedAt": "2025-01-01T00:00:00.000Z"
}

Delete receive invoice item

Request

Permanently deletes a Receive Invoice Item record.

Security
bearer
Path
siteIdnumberrequired

Site identifier

receiveInvoiceItemIdstringrequired

Receive Invoice Item unique identifier (UUID)

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

Responses

Receive Invoice Item deleted successfully

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