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

Create receive invoice

Request

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

Security
bearer
Path
siteIdnumberrequired

Site identifier

Bodyapplication/jsonrequired
commentsstring

Free-text comments associated with the receive invoice.

currencystringrequired

ISO 4217 currency code for all monetary amounts on this invoice.

dueDatestringrequired

Due date/time for payment of the receive invoice.

Example: "2025-01-01"
extensionsobject

Vendor- or practice-specific extensions.

freightAmountstringrequired

Total freight amount including tax, as a decimal string.

Example: "100.00"
freightTaxAmountstringrequired

Tax component of the freight amount, as a decimal string.

Example: "100.00"
invoiceNumberstringrequired

Supplier-provided invoice number used to track the invoice on their end.

isActivebooleanrequired

Whether the receive invoice is active.

lineItemsArray of objects(LineItemDto)required

Line items that make up this receive invoice.

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

Identifier of the ownership separation to which this receive invoice belongs.

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

List of purchase orders associated with this receive invoice.

receiveInvoiceIdstringrequired

Canonical identifier for the receive invoice.

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

Rounding adjustment applied to the invoice total, as a decimal string.

Example: "100.00"
supplierIdstringrequired

Identifier of the supplier contact associated with this receive invoice.

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

Total tax amount for the invoice, as a decimal string.

Example: "100.00"
totalAmountstringrequired

Total invoice amount including tax, as a decimal string.

Example: "100.00"
transactedAtstringrequired

Timestamp of the receive invoice transaction.

Example: "2025-01-01T00:00:00.000Z"
curl -i -X POST \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/receive-invoice' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "comments": "string",
    "currency": "string",
    "dueDate": "2025-01-01",
    "extensions": {},
    "freightAmount": "100.00",
    "freightTaxAmount": "100.00",
    "invoiceNumber": "string",
    "isActive": true,
    "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"
      }
    ],
    "ownershipId": "123e4567-e89b-12d3-a456-426614174000",
    "purchaseOrderIds": [
      "string"
    ],
    "receiveInvoiceId": "123e4567-e89b-12d3-a456-426614174000",
    "roundingAmount": "100.00",
    "supplierId": "123e4567-e89b-12d3-a456-426614174000",
    "taxAmount": "100.00",
    "totalAmount": "100.00",
    "transactedAt": "2025-01-01T00:00:00.000Z"
  }'

Responses

Receive Invoice created successfully

Bodyapplication/json
commentsstringrequired

Free-text comments associated with the receive invoice.

createdAtstring(date-time)required

Timestamp when the receive invoice was created.

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

ISO 4217 currency code for all monetary amounts on this invoice.

dueDatestring(date-time)required

Due date/time for payment of the receive invoice.

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

Vendor- or practice-specific extensions.

freightAmountstringrequired

Total freight amount including tax, as a decimal string.

Example: "100.00"
freightTaxAmountstringrequired

Tax component of the freight amount, as a decimal string.

Example: "100.00"
invoiceNumberstringrequired

Supplier-provided invoice number used to track the invoice on their end.

isActivebooleanrequired

Whether the receive invoice is active.

lineItemsArray of objects(LineItemDto)required

Line items that make up this receive invoice.

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

Identifier of the ownership separation to which this receive invoice belongs.

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

List of purchase orders associated with this receive invoice.

receiveInvoiceIdstringrequired

Canonical identifier for the receive invoice.

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

Rounding adjustment applied to the invoice total, as a decimal string.

Example: "100.00"
supplierIdstringrequired

Identifier of the supplier contact associated with this receive invoice.

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

Total tax amount for the invoice, as a decimal string.

Example: "100.00"
totalAmountstringrequired

Total invoice amount including tax, as a decimal string.

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

Timestamp when the receive invoice was last updated.

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

Timestamp of the receive invoice transaction.

Example: "2025-01-01T00:00:00.000Z"
Response
application/json
{
  "comments": "string",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "currency": "string",
  "dueDate": "2025-01-01T00:00:00Z",
  "extensions": {},
  "freightAmount": "100.00",
  "freightTaxAmount": "100.00",
  "invoiceNumber": "string",
  "isActive": true,
  "lineItems": [
    { … }
  ],
  "ownershipId": "123e4567-e89b-12d3-a456-426614174000",
  "purchaseOrderIds": [
    "string"
  ],
  "receiveInvoiceId": "123e4567-e89b-12d3-a456-426614174000",
  "roundingAmount": "100.00",
  "supplierId": "123e4567-e89b-12d3-a456-426614174000",
  "taxAmount": "100.00",
  "totalAmount": "100.00",
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "transactedAt": "2025-01-01T00:00:00.000Z"
}

List receive invoices

Request

Returns a paginated list of Receive Invoices 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""currency""dueDate""freightAmount""freightTaxAmount""invoiceNumber""roundingAmount""taxAmount"
sortOrderstring

Sort order

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

Free-text comments associated with the receive invoice.

currencystring

ISO 4217 currency code for all monetary amounts on this invoice.

invoiceNumberstring

Supplier-provided invoice number used to track the invoice on their end.

isActiveboolean

Whether the receive invoice is active.

ownershipIdstring

Identifier of the ownership separation to which this receive invoice belongs.

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

Identifier of the supplier contact associated with this receive invoice.

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

Responses

Paginated list of Receive Invoices

Get receive invoice

Request

Returns a single Receive Invoice by its unique identifier.

Security
bearer
Path
siteIdnumberrequired

Site identifier

receiveInvoiceIdstringrequired

Receive Invoice unique identifier (UUID)

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

Responses

Receive Invoice found

Bodyapplication/json
commentsstringrequired

Free-text comments associated with the receive invoice.

createdAtstring(date-time)required

Timestamp when the receive invoice was created.

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

ISO 4217 currency code for all monetary amounts on this invoice.

dueDatestring(date-time)required

Due date/time for payment of the receive invoice.

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

Vendor- or practice-specific extensions.

freightAmountstringrequired

Total freight amount including tax, as a decimal string.

Example: "100.00"
freightTaxAmountstringrequired

Tax component of the freight amount, as a decimal string.

Example: "100.00"
invoiceNumberstringrequired

Supplier-provided invoice number used to track the invoice on their end.

isActivebooleanrequired

Whether the receive invoice is active.

lineItemsArray of objects(LineItemDto)required

Line items that make up this receive invoice.

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

Identifier of the ownership separation to which this receive invoice belongs.

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

List of purchase orders associated with this receive invoice.

receiveInvoiceIdstringrequired

Canonical identifier for the receive invoice.

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

Rounding adjustment applied to the invoice total, as a decimal string.

Example: "100.00"
supplierIdstringrequired

Identifier of the supplier contact associated with this receive invoice.

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

Total tax amount for the invoice, as a decimal string.

Example: "100.00"
totalAmountstringrequired

Total invoice amount including tax, as a decimal string.

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

Timestamp when the receive invoice was last updated.

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

Timestamp of the receive invoice transaction.

Example: "2025-01-01T00:00:00.000Z"
Response
application/json
{
  "comments": "string",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "currency": "string",
  "dueDate": "2025-01-01T00:00:00Z",
  "extensions": {},
  "freightAmount": "100.00",
  "freightTaxAmount": "100.00",
  "invoiceNumber": "string",
  "isActive": true,
  "lineItems": [
    { … }
  ],
  "ownershipId": "123e4567-e89b-12d3-a456-426614174000",
  "purchaseOrderIds": [
    "string"
  ],
  "receiveInvoiceId": "123e4567-e89b-12d3-a456-426614174000",
  "roundingAmount": "100.00",
  "supplierId": "123e4567-e89b-12d3-a456-426614174000",
  "taxAmount": "100.00",
  "totalAmount": "100.00",
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "transactedAt": "2025-01-01T00:00:00.000Z"
}

Update receive invoice

Request

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

Security
bearer
Path
siteIdnumberrequired

Site identifier

receiveInvoiceIdstringrequired

Receive Invoice unique identifier (UUID)

Bodyapplication/jsonrequired
commentsstring

Free-text comments associated with the receive invoice.

currencystring

ISO 4217 currency code for all monetary amounts on this invoice.

dueDatestring

Due date/time for payment of the receive invoice.

Example: "2025-01-01"
extensionsobject

Vendor- or practice-specific extensions.

freightAmountstring

Total freight amount including tax, as a decimal string.

Example: "100.00"
freightTaxAmountstring

Tax component of the freight amount, as a decimal string.

Example: "100.00"
invoiceNumberstring

Supplier-provided invoice number used to track the invoice on their end.

isActiveboolean

Whether the receive invoice is active.

lineItemsArray of objects(LineItemDto)

Line items that make up this receive invoice.

ownershipIdstring

Identifier of the ownership separation to which this receive invoice belongs.

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

List of purchase orders associated with this receive invoice.

roundingAmountstring

Rounding adjustment applied to the invoice total, as a decimal string.

Example: "100.00"
supplierIdstring

Identifier of the supplier contact associated with this receive invoice.

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

Total tax amount for the invoice, as a decimal string.

Example: "100.00"
totalAmountstring

Total invoice amount including tax, as a decimal string.

Example: "100.00"
transactedAtstring

Timestamp of the receive invoice transaction.

Example: "2025-01-01T00:00:00.000Z"
curl -i -X PATCH \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/receive-invoice/{receiveInvoiceId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "comments": "string",
    "currency": "string",
    "dueDate": "2025-01-01",
    "extensions": {},
    "freightAmount": "100.00",
    "freightTaxAmount": "100.00",
    "invoiceNumber": "string",
    "isActive": true,
    "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"
      }
    ],
    "ownershipId": "123e4567-e89b-12d3-a456-426614174000",
    "purchaseOrderIds": [
      "string"
    ],
    "roundingAmount": "100.00",
    "supplierId": "123e4567-e89b-12d3-a456-426614174000",
    "taxAmount": "100.00",
    "totalAmount": "100.00",
    "transactedAt": "2025-01-01T00:00:00.000Z"
  }'

Responses

Receive Invoice updated successfully

Bodyapplication/json
commentsstringrequired

Free-text comments associated with the receive invoice.

createdAtstring(date-time)required

Timestamp when the receive invoice was created.

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

ISO 4217 currency code for all monetary amounts on this invoice.

dueDatestring(date-time)required

Due date/time for payment of the receive invoice.

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

Vendor- or practice-specific extensions.

freightAmountstringrequired

Total freight amount including tax, as a decimal string.

Example: "100.00"
freightTaxAmountstringrequired

Tax component of the freight amount, as a decimal string.

Example: "100.00"
invoiceNumberstringrequired

Supplier-provided invoice number used to track the invoice on their end.

isActivebooleanrequired

Whether the receive invoice is active.

lineItemsArray of objects(LineItemDto)required

Line items that make up this receive invoice.

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

Identifier of the ownership separation to which this receive invoice belongs.

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

List of purchase orders associated with this receive invoice.

receiveInvoiceIdstringrequired

Canonical identifier for the receive invoice.

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

Rounding adjustment applied to the invoice total, as a decimal string.

Example: "100.00"
supplierIdstringrequired

Identifier of the supplier contact associated with this receive invoice.

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

Total tax amount for the invoice, as a decimal string.

Example: "100.00"
totalAmountstringrequired

Total invoice amount including tax, as a decimal string.

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

Timestamp when the receive invoice was last updated.

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

Timestamp of the receive invoice transaction.

Example: "2025-01-01T00:00:00.000Z"
Response
application/json
{
  "comments": "string",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "currency": "string",
  "dueDate": "2025-01-01T00:00:00Z",
  "extensions": {},
  "freightAmount": "100.00",
  "freightTaxAmount": "100.00",
  "invoiceNumber": "string",
  "isActive": true,
  "lineItems": [
    { … }
  ],
  "ownershipId": "123e4567-e89b-12d3-a456-426614174000",
  "purchaseOrderIds": [
    "string"
  ],
  "receiveInvoiceId": "123e4567-e89b-12d3-a456-426614174000",
  "roundingAmount": "100.00",
  "supplierId": "123e4567-e89b-12d3-a456-426614174000",
  "taxAmount": "100.00",
  "totalAmount": "100.00",
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "transactedAt": "2025-01-01T00:00:00.000Z"
}

Replace receive invoice

Request

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

Security
bearer
Path
siteIdnumberrequired

Site identifier

receiveInvoiceIdstringrequired

Receive Invoice unique identifier (UUID)

Bodyapplication/jsonrequired
commentsstringrequired

Free-text comments associated with the receive invoice.

currencystringrequired

ISO 4217 currency code for all monetary amounts on this invoice.

dueDatestringrequired

Due date/time for payment of the receive invoice.

Example: "2025-01-01"
extensionsobjectrequired

Vendor- or practice-specific extensions.

freightAmountstringrequired

Total freight amount including tax, as a decimal string.

Example: "100.00"
freightTaxAmountstringrequired

Tax component of the freight amount, as a decimal string.

Example: "100.00"
invoiceNumberstringrequired

Supplier-provided invoice number used to track the invoice on their end.

isActivebooleanrequired

Whether the receive invoice is active.

lineItemsArray of objects(LineItemDto)required

Line items that make up this receive invoice.

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

Identifier of the ownership separation to which this receive invoice belongs.

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

List of purchase orders associated with this receive invoice.

roundingAmountstringrequired

Rounding adjustment applied to the invoice total, as a decimal string.

Example: "100.00"
supplierIdstringrequired

Identifier of the supplier contact associated with this receive invoice.

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

Total tax amount for the invoice, as a decimal string.

Example: "100.00"
totalAmountstringrequired

Total invoice amount including tax, as a decimal string.

Example: "100.00"
transactedAtstringrequired

Timestamp of the receive invoice transaction.

Example: "2025-01-01T00:00:00.000Z"
curl -i -X PUT \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/receive-invoice/{receiveInvoiceId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "comments": "string",
    "currency": "string",
    "dueDate": "2025-01-01",
    "extensions": {},
    "freightAmount": "100.00",
    "freightTaxAmount": "100.00",
    "invoiceNumber": "string",
    "isActive": true,
    "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"
      }
    ],
    "ownershipId": "123e4567-e89b-12d3-a456-426614174000",
    "purchaseOrderIds": [
      "string"
    ],
    "roundingAmount": "100.00",
    "supplierId": "123e4567-e89b-12d3-a456-426614174000",
    "taxAmount": "100.00",
    "totalAmount": "100.00",
    "transactedAt": "2025-01-01T00:00:00.000Z"
  }'

Responses

Receive Invoice replaced successfully

Bodyapplication/json
commentsstringrequired

Free-text comments associated with the receive invoice.

createdAtstring(date-time)required

Timestamp when the receive invoice was created.

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

ISO 4217 currency code for all monetary amounts on this invoice.

dueDatestring(date-time)required

Due date/time for payment of the receive invoice.

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

Vendor- or practice-specific extensions.

freightAmountstringrequired

Total freight amount including tax, as a decimal string.

Example: "100.00"
freightTaxAmountstringrequired

Tax component of the freight amount, as a decimal string.

Example: "100.00"
invoiceNumberstringrequired

Supplier-provided invoice number used to track the invoice on their end.

isActivebooleanrequired

Whether the receive invoice is active.

lineItemsArray of objects(LineItemDto)required

Line items that make up this receive invoice.

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

Identifier of the ownership separation to which this receive invoice belongs.

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

List of purchase orders associated with this receive invoice.

receiveInvoiceIdstringrequired

Canonical identifier for the receive invoice.

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

Rounding adjustment applied to the invoice total, as a decimal string.

Example: "100.00"
supplierIdstringrequired

Identifier of the supplier contact associated with this receive invoice.

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

Total tax amount for the invoice, as a decimal string.

Example: "100.00"
totalAmountstringrequired

Total invoice amount including tax, as a decimal string.

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

Timestamp when the receive invoice was last updated.

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

Timestamp of the receive invoice transaction.

Example: "2025-01-01T00:00:00.000Z"
Response
application/json
{
  "comments": "string",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "currency": "string",
  "dueDate": "2025-01-01T00:00:00Z",
  "extensions": {},
  "freightAmount": "100.00",
  "freightTaxAmount": "100.00",
  "invoiceNumber": "string",
  "isActive": true,
  "lineItems": [
    { … }
  ],
  "ownershipId": "123e4567-e89b-12d3-a456-426614174000",
  "purchaseOrderIds": [
    "string"
  ],
  "receiveInvoiceId": "123e4567-e89b-12d3-a456-426614174000",
  "roundingAmount": "100.00",
  "supplierId": "123e4567-e89b-12d3-a456-426614174000",
  "taxAmount": "100.00",
  "totalAmount": "100.00",
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "transactedAt": "2025-01-01T00:00:00.000Z"
}

Delete receive invoice

Request

Permanently deletes a Receive Invoice record.

Security
bearer
Path
siteIdnumberrequired

Site identifier

receiveInvoiceIdstringrequired

Receive Invoice unique identifier (UUID)

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

Responses

Receive Invoice deleted successfully

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