Skip to content

AHDS Store API (1.0)

Animal Health Data Store - V1 API Documentation

Overview
Languages
Servers
Mock server

https://docs.heydonto.com/_mock/apis/animal-health/openapi/

Local Development

http://localhost:8083/

Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations

Request

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

Security
bearer
Path
siteIdnumberrequired

Site identifier

Bodyapplication/jsonrequired
animalIdstring or null

Identifier of the animal associated with this invoice line, if any.

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

Batch or lot identifier for inventory-tracked products, if applicable.

consultIdstring or null

Identifier of the consultation associated with this invoice line, if any.

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

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

discountAmountstringrequired

Absolute discount amount (excluding tax) applied to this line, as a decimal string.

Example: "100.00"
extensionsobject

Vendor- or practice-specific extensions.

groupIdstring or null

Identifier for a grouping of invoice lines (e.g., package or section).

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

Identifier of the parent invoice.

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

Canonical identifier for this invoice line.

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

Whether this invoice line is active.

ledgerAccountIdstring or null

Identifier of the ledger or GL account associated with this line.

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

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

Example: "100.00"
lineTotalstringrequired

Extended line total (excluding tax) after discount, as a decimal string.

Example: "100.00"
lineTypestring

Type of invoice line (e.g., product, service, discount).

Enum"product""service""discount""surcharge""other"
locationIdstring or null

Identifier of the practice location where this line item was generated.

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

Human-readable description of the invoice line, typically the product or service name.

ownershipIdstring or null

Identifier representing the ownership or billing entity associated with this line.

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

Reference to the billed product or service.

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

Quantity of the product or service as a decimal string.

Example: "100.00"
salesPersonIdstring or null

Identifier of the staff member credited as salesperson for this line.

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

Service or supply date associated with this line, if distinct from the invoice date.

Example: "2025-01-01"
standardUnitPricestringrequired

Standard or list unit price (excluding tax) before discount, as a decimal string.

Example: "100.00"
standardUnitTaxAmountstringrequired

Standard tax amount per unit before discount, as a decimal string.

Example: "100.00"
statusstringrequired

Lifecycle status of the invoice line.

Enum"draft""posted""void""credited"
taxCodestringrequired

Practice-specific tax code applied to this line.

taxPercentnumberrequired

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

unitPricestringrequired

Net unit price (excluding tax) after discount, as a decimal string.

Example: "100.00"
unitTaxAmountstringrequired

Tax amount per 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/invoiceline' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "animalId": "123e4567-e89b-12d3-a456-426614174000",
    "batch": "string",
    "consultId": "123e4567-e89b-12d3-a456-426614174000",
    "currency": "string",
    "discountAmount": "100.00",
    "extensions": {},
    "groupId": "123e4567-e89b-12d3-a456-426614174000",
    "invoiceId": "123e4567-e89b-12d3-a456-426614174000",
    "invoicelineId": "123e4567-e89b-12d3-a456-426614174000",
    "isActive": true,
    "ledgerAccountId": "123e4567-e89b-12d3-a456-426614174000",
    "lineTaxTotal": "100.00",
    "lineTotal": "100.00",
    "lineType": "product",
    "locationId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "string",
    "ownershipId": "123e4567-e89b-12d3-a456-426614174000",
    "productId": "123e4567-e89b-12d3-a456-426614174000",
    "quantity": "100.00",
    "salesPersonId": "123e4567-e89b-12d3-a456-426614174000",
    "serviceDate": "2025-01-01",
    "standardUnitPrice": "100.00",
    "standardUnitTaxAmount": "100.00",
    "status": "draft",
    "taxCode": "string",
    "taxPercent": 0,
    "unitPrice": "100.00",
    "unitTaxAmount": "100.00"
  }'

Responses

Invoiceline created successfully

Bodyapplication/json
animalIdstring or nullrequired

Identifier of the animal associated with this invoice line, if any.

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

Batch or lot identifier for inventory-tracked products, if applicable.

consultIdstring or nullrequired

Identifier of the consultation associated with this invoice line, if any.

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

Timestamp when the invoice line was created.

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

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

discountAmountstringrequired

Absolute discount amount (excluding tax) applied to this line, as a decimal string.

Example: "100.00"
extensionsobjectrequired

Vendor- or practice-specific extensions.

groupIdstring or nullrequired

Identifier for a grouping of invoice lines (e.g., package or section).

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

Identifier of the parent invoice.

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

Canonical identifier for this invoice line.

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

Whether this invoice line is active.

ledgerAccountIdstring or nullrequired

Identifier of the ledger or GL account associated with this line.

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

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

Example: "100.00"
lineTotalstringrequired

Extended line total (excluding tax) after discount, as a decimal string.

Example: "100.00"
lineTypestringrequired

Type of invoice line (e.g., product, service, discount).

Enum"product""service""discount""surcharge""other"
locationIdstring or nullrequired

Identifier of the practice location where this line item was generated.

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

Human-readable description of the invoice line, typically the product or service name.

ownershipIdstring or nullrequired

Identifier representing the ownership or billing entity associated with this line.

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

Reference to the billed product or service.

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

Quantity of the product or service as a decimal string.

Example: "100.00"
salesPersonIdstring or nullrequired

Identifier of the staff member credited as salesperson for this line.

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

Service or supply date associated with this line, if distinct from the invoice date.

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

Standard or list unit price (excluding tax) before discount, as a decimal string.

Example: "100.00"
standardUnitTaxAmountstringrequired

Standard tax amount per unit before discount, as a decimal string.

Example: "100.00"
statusstringrequired

Lifecycle status of the invoice line.

Enum"draft""posted""void""credited"
taxCodestringrequired

Practice-specific tax code applied to this line.

taxPercentnumberrequired

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

unitPricestringrequired

Net unit price (excluding tax) after discount, as a decimal string.

Example: "100.00"
unitTaxAmountstringrequired

Tax amount per unit, as a decimal string.

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

Timestamp when the invoice line was last modified.

Example: "2025-01-01T00:00:00.000Z"
Response
application/json
{ "animalId": "123e4567-e89b-12d3-a456-426614174000", "batch": "string", "consultId": "123e4567-e89b-12d3-a456-426614174000", "createdAt": "2025-01-01T00:00:00.000Z", "currency": "string", "discountAmount": "100.00", "extensions": {}, "groupId": "123e4567-e89b-12d3-a456-426614174000", "invoiceId": "123e4567-e89b-12d3-a456-426614174000", "invoicelineId": "123e4567-e89b-12d3-a456-426614174000", "isActive": true, "ledgerAccountId": "123e4567-e89b-12d3-a456-426614174000", "lineTaxTotal": "100.00", "lineTotal": "100.00", "lineType": "product", "locationId": "123e4567-e89b-12d3-a456-426614174000", "name": "string", "ownershipId": "123e4567-e89b-12d3-a456-426614174000", "productId": "123e4567-e89b-12d3-a456-426614174000", "quantity": "100.00", "salesPersonId": "123e4567-e89b-12d3-a456-426614174000", "serviceDate": "2025-01-01T00:00:00Z", "standardUnitPrice": "100.00", "standardUnitTaxAmount": "100.00", "status": "draft", "taxCode": "string", "taxPercent": 0, "unitPrice": "100.00", "unitTaxAmount": "100.00", "updatedAt": "2025-01-01T00:00:00.000Z" }

Request

Returns a paginated list of Invoicelines 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""batch""currency""discountAmount""lineTaxTotal""lineTotal""name""quantity""serviceDate"
sortOrderstring

Sort order

Default "asc"
Enum"asc""desc"
animalIdstring

Identifier of the animal associated with this invoice line, if any.

Example: animalId=123e4567-e89b-12d3-a456-426614174000
batchstring

Batch or lot identifier for inventory-tracked products, if applicable.

consultIdstring

Identifier of the consultation associated with this invoice line, if any.

Example: consultId=123e4567-e89b-12d3-a456-426614174000
currencystring

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

groupIdstring

Identifier for a grouping of invoice lines (e.g., package or section).

Example: groupId=123e4567-e89b-12d3-a456-426614174000
invoiceIdstring

Identifier of the parent invoice.

Example: invoiceId=123e4567-e89b-12d3-a456-426614174000
isActiveboolean

Whether this invoice line is active.

ledgerAccountIdstring

Identifier of the ledger or GL account associated with this line.

Example: ledgerAccountId=123e4567-e89b-12d3-a456-426614174000
lineTypestring

Type of invoice line (e.g., product, service, discount).

Enum"product""service""discount""surcharge""other"
locationIdstring

Identifier of the practice location where this line item was generated.

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

Human-readable description of the invoice line, typically the product or service name.

ownershipIdstring

Identifier representing the ownership or billing entity associated with this line.

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

Reference to the billed product or service.

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

Identifier of the staff member credited as salesperson for this line.

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

Lifecycle status of the invoice line.

Enum"draft""posted""void""credited"
taxCodestring

Practice-specific tax code applied to this line.

curl -i -X GET \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/invoiceline?page=0&pageSize=10&sortBy=createdAt&sortOrder=asc&animalId=123e4567-e89b-12d3-a456-426614174000&batch=string&consultId=123e4567-e89b-12d3-a456-426614174000&currency=string&groupId=123e4567-e89b-12d3-a456-426614174000&invoiceId=123e4567-e89b-12d3-a456-426614174000&isActive=true&ledgerAccountId=123e4567-e89b-12d3-a456-426614174000&lineType=product&locationId=123e4567-e89b-12d3-a456-426614174000&name=string&ownershipId=123e4567-e89b-12d3-a456-426614174000&productId=123e4567-e89b-12d3-a456-426614174000&salesPersonId=123e4567-e89b-12d3-a456-426614174000&status=draft&taxCode=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Paginated list of Invoicelines

Request

Returns a single Invoiceline by its unique identifier.

Security
bearer
Path
siteIdnumberrequired

Site identifier

invoicelineIdstringrequired

Invoiceline unique identifier (UUID)

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

Responses

Invoiceline found

Bodyapplication/json
animalIdstring or nullrequired

Identifier of the animal associated with this invoice line, if any.

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

Batch or lot identifier for inventory-tracked products, if applicable.

consultIdstring or nullrequired

Identifier of the consultation associated with this invoice line, if any.

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

Timestamp when the invoice line was created.

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

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

discountAmountstringrequired

Absolute discount amount (excluding tax) applied to this line, as a decimal string.

Example: "100.00"
extensionsobjectrequired

Vendor- or practice-specific extensions.

groupIdstring or nullrequired

Identifier for a grouping of invoice lines (e.g., package or section).

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

Identifier of the parent invoice.

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

Canonical identifier for this invoice line.

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

Whether this invoice line is active.

ledgerAccountIdstring or nullrequired

Identifier of the ledger or GL account associated with this line.

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

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

Example: "100.00"
lineTotalstringrequired

Extended line total (excluding tax) after discount, as a decimal string.

Example: "100.00"
lineTypestringrequired

Type of invoice line (e.g., product, service, discount).

Enum"product""service""discount""surcharge""other"
locationIdstring or nullrequired

Identifier of the practice location where this line item was generated.

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

Human-readable description of the invoice line, typically the product or service name.

ownershipIdstring or nullrequired

Identifier representing the ownership or billing entity associated with this line.

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

Reference to the billed product or service.

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

Quantity of the product or service as a decimal string.

Example: "100.00"
salesPersonIdstring or nullrequired

Identifier of the staff member credited as salesperson for this line.

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

Service or supply date associated with this line, if distinct from the invoice date.

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

Standard or list unit price (excluding tax) before discount, as a decimal string.

Example: "100.00"
standardUnitTaxAmountstringrequired

Standard tax amount per unit before discount, as a decimal string.

Example: "100.00"
statusstringrequired

Lifecycle status of the invoice line.

Enum"draft""posted""void""credited"
taxCodestringrequired

Practice-specific tax code applied to this line.

taxPercentnumberrequired

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

unitPricestringrequired

Net unit price (excluding tax) after discount, as a decimal string.

Example: "100.00"
unitTaxAmountstringrequired

Tax amount per unit, as a decimal string.

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

Timestamp when the invoice line was last modified.

Example: "2025-01-01T00:00:00.000Z"
Response
application/json
{ "animalId": "123e4567-e89b-12d3-a456-426614174000", "batch": "string", "consultId": "123e4567-e89b-12d3-a456-426614174000", "createdAt": "2025-01-01T00:00:00.000Z", "currency": "string", "discountAmount": "100.00", "extensions": {}, "groupId": "123e4567-e89b-12d3-a456-426614174000", "invoiceId": "123e4567-e89b-12d3-a456-426614174000", "invoicelineId": "123e4567-e89b-12d3-a456-426614174000", "isActive": true, "ledgerAccountId": "123e4567-e89b-12d3-a456-426614174000", "lineTaxTotal": "100.00", "lineTotal": "100.00", "lineType": "product", "locationId": "123e4567-e89b-12d3-a456-426614174000", "name": "string", "ownershipId": "123e4567-e89b-12d3-a456-426614174000", "productId": "123e4567-e89b-12d3-a456-426614174000", "quantity": "100.00", "salesPersonId": "123e4567-e89b-12d3-a456-426614174000", "serviceDate": "2025-01-01T00:00:00Z", "standardUnitPrice": "100.00", "standardUnitTaxAmount": "100.00", "status": "draft", "taxCode": "string", "taxPercent": 0, "unitPrice": "100.00", "unitTaxAmount": "100.00", "updatedAt": "2025-01-01T00:00:00.000Z" }

Request

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

Security
bearer
Path
siteIdnumberrequired

Site identifier

invoicelineIdstringrequired

Invoiceline unique identifier (UUID)

Bodyapplication/jsonrequired
animalIdstring or null

Identifier of the animal associated with this invoice line, if any.

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

Batch or lot identifier for inventory-tracked products, if applicable.

consultIdstring or null

Identifier of the consultation associated with this invoice line, if any.

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

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

discountAmountstring

Absolute discount amount (excluding tax) applied to this line, as a decimal string.

Example: "100.00"
extensionsobject

Vendor- or practice-specific extensions.

groupIdstring or null

Identifier for a grouping of invoice lines (e.g., package or section).

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

Identifier of the parent invoice.

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

Whether this invoice line is active.

ledgerAccountIdstring or null

Identifier of the ledger or GL account associated with this line.

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

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

Example: "100.00"
lineTotalstring

Extended line total (excluding tax) after discount, as a decimal string.

Example: "100.00"
lineTypestring

Type of invoice line (e.g., product, service, discount).

Enum"product""service""discount""surcharge""other"
locationIdstring or null

Identifier of the practice location where this line item was generated.

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

Human-readable description of the invoice line, typically the product or service name.

ownershipIdstring or null

Identifier representing the ownership or billing entity associated with this line.

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

Reference to the billed product or service.

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

Quantity of the product or service as a decimal string.

Example: "100.00"
salesPersonIdstring or null

Identifier of the staff member credited as salesperson for this line.

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

Service or supply date associated with this line, if distinct from the invoice date.

Example: "2025-01-01"
standardUnitPricestring

Standard or list unit price (excluding tax) before discount, as a decimal string.

Example: "100.00"
standardUnitTaxAmountstring

Standard tax amount per unit before discount, as a decimal string.

Example: "100.00"
statusstring

Lifecycle status of the invoice line.

Enum"draft""posted""void""credited"
taxCodestring

Practice-specific tax code applied to this line.

taxPercentnumber

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

unitPricestring

Net unit price (excluding tax) after discount, as a decimal string.

Example: "100.00"
unitTaxAmountstring

Tax amount per 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/invoiceline/{invoicelineId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "animalId": "123e4567-e89b-12d3-a456-426614174000",
    "batch": "string",
    "consultId": "123e4567-e89b-12d3-a456-426614174000",
    "currency": "string",
    "discountAmount": "100.00",
    "extensions": {},
    "groupId": "123e4567-e89b-12d3-a456-426614174000",
    "invoiceId": "123e4567-e89b-12d3-a456-426614174000",
    "isActive": true,
    "ledgerAccountId": "123e4567-e89b-12d3-a456-426614174000",
    "lineTaxTotal": "100.00",
    "lineTotal": "100.00",
    "lineType": "product",
    "locationId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "string",
    "ownershipId": "123e4567-e89b-12d3-a456-426614174000",
    "productId": "123e4567-e89b-12d3-a456-426614174000",
    "quantity": "100.00",
    "salesPersonId": "123e4567-e89b-12d3-a456-426614174000",
    "serviceDate": "2025-01-01",
    "standardUnitPrice": "100.00",
    "standardUnitTaxAmount": "100.00",
    "status": "draft",
    "taxCode": "string",
    "taxPercent": 0,
    "unitPrice": "100.00",
    "unitTaxAmount": "100.00"
  }'

Responses

Invoiceline updated successfully

Bodyapplication/json
animalIdstring or nullrequired

Identifier of the animal associated with this invoice line, if any.

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

Batch or lot identifier for inventory-tracked products, if applicable.

consultIdstring or nullrequired

Identifier of the consultation associated with this invoice line, if any.

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

Timestamp when the invoice line was created.

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

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

discountAmountstringrequired

Absolute discount amount (excluding tax) applied to this line, as a decimal string.

Example: "100.00"
extensionsobjectrequired

Vendor- or practice-specific extensions.

groupIdstring or nullrequired

Identifier for a grouping of invoice lines (e.g., package or section).

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

Identifier of the parent invoice.

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

Canonical identifier for this invoice line.

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

Whether this invoice line is active.

ledgerAccountIdstring or nullrequired

Identifier of the ledger or GL account associated with this line.

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

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

Example: "100.00"
lineTotalstringrequired

Extended line total (excluding tax) after discount, as a decimal string.

Example: "100.00"
lineTypestringrequired

Type of invoice line (e.g., product, service, discount).

Enum"product""service""discount""surcharge""other"
locationIdstring or nullrequired

Identifier of the practice location where this line item was generated.

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

Human-readable description of the invoice line, typically the product or service name.

ownershipIdstring or nullrequired

Identifier representing the ownership or billing entity associated with this line.

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

Reference to the billed product or service.

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

Quantity of the product or service as a decimal string.

Example: "100.00"
salesPersonIdstring or nullrequired

Identifier of the staff member credited as salesperson for this line.

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

Service or supply date associated with this line, if distinct from the invoice date.

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

Standard or list unit price (excluding tax) before discount, as a decimal string.

Example: "100.00"
standardUnitTaxAmountstringrequired

Standard tax amount per unit before discount, as a decimal string.

Example: "100.00"
statusstringrequired

Lifecycle status of the invoice line.

Enum"draft""posted""void""credited"
taxCodestringrequired

Practice-specific tax code applied to this line.

taxPercentnumberrequired

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

unitPricestringrequired

Net unit price (excluding tax) after discount, as a decimal string.

Example: "100.00"
unitTaxAmountstringrequired

Tax amount per unit, as a decimal string.

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

Timestamp when the invoice line was last modified.

Example: "2025-01-01T00:00:00.000Z"
Response
application/json
{ "animalId": "123e4567-e89b-12d3-a456-426614174000", "batch": "string", "consultId": "123e4567-e89b-12d3-a456-426614174000", "createdAt": "2025-01-01T00:00:00.000Z", "currency": "string", "discountAmount": "100.00", "extensions": {}, "groupId": "123e4567-e89b-12d3-a456-426614174000", "invoiceId": "123e4567-e89b-12d3-a456-426614174000", "invoicelineId": "123e4567-e89b-12d3-a456-426614174000", "isActive": true, "ledgerAccountId": "123e4567-e89b-12d3-a456-426614174000", "lineTaxTotal": "100.00", "lineTotal": "100.00", "lineType": "product", "locationId": "123e4567-e89b-12d3-a456-426614174000", "name": "string", "ownershipId": "123e4567-e89b-12d3-a456-426614174000", "productId": "123e4567-e89b-12d3-a456-426614174000", "quantity": "100.00", "salesPersonId": "123e4567-e89b-12d3-a456-426614174000", "serviceDate": "2025-01-01T00:00:00Z", "standardUnitPrice": "100.00", "standardUnitTaxAmount": "100.00", "status": "draft", "taxCode": "string", "taxPercent": 0, "unitPrice": "100.00", "unitTaxAmount": "100.00", "updatedAt": "2025-01-01T00:00:00.000Z" }

Request

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

Security
bearer
Path
siteIdnumberrequired

Site identifier

invoicelineIdstringrequired

Invoiceline unique identifier (UUID)

Bodyapplication/jsonrequired
animalIdstring or null

Identifier of the animal associated with this invoice line, if any.

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

Batch or lot identifier for inventory-tracked products, if applicable.

consultIdstring or null

Identifier of the consultation associated with this invoice line, if any.

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

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

discountAmountstringrequired

Absolute discount amount (excluding tax) applied to this line, as a decimal string.

Example: "100.00"
extensionsobjectrequired

Vendor- or practice-specific extensions.

groupIdstring or null

Identifier for a grouping of invoice lines (e.g., package or section).

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

Identifier of the parent invoice.

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

Whether this invoice line is active.

ledgerAccountIdstring or null

Identifier of the ledger or GL account associated with this line.

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

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

Example: "100.00"
lineTotalstringrequired

Extended line total (excluding tax) after discount, as a decimal string.

Example: "100.00"
lineTypestringrequired

Type of invoice line (e.g., product, service, discount).

Enum"product""service""discount""surcharge""other"
locationIdstring or null

Identifier of the practice location where this line item was generated.

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

Human-readable description of the invoice line, typically the product or service name.

ownershipIdstring or null

Identifier representing the ownership or billing entity associated with this line.

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

Reference to the billed product or service.

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

Quantity of the product or service as a decimal string.

Example: "100.00"
salesPersonIdstring or null

Identifier of the staff member credited as salesperson for this line.

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

Service or supply date associated with this line, if distinct from the invoice date.

Example: "2025-01-01"
standardUnitPricestringrequired

Standard or list unit price (excluding tax) before discount, as a decimal string.

Example: "100.00"
standardUnitTaxAmountstringrequired

Standard tax amount per unit before discount, as a decimal string.

Example: "100.00"
statusstringrequired

Lifecycle status of the invoice line.

Enum"draft""posted""void""credited"
taxCodestringrequired

Practice-specific tax code applied to this line.

taxPercentnumberrequired

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

unitPricestringrequired

Net unit price (excluding tax) after discount, as a decimal string.

Example: "100.00"
unitTaxAmountstringrequired

Tax amount per 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/invoiceline/{invoicelineId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "animalId": "123e4567-e89b-12d3-a456-426614174000",
    "batch": "string",
    "consultId": "123e4567-e89b-12d3-a456-426614174000",
    "currency": "string",
    "discountAmount": "100.00",
    "extensions": {},
    "groupId": "123e4567-e89b-12d3-a456-426614174000",
    "invoiceId": "123e4567-e89b-12d3-a456-426614174000",
    "isActive": true,
    "ledgerAccountId": "123e4567-e89b-12d3-a456-426614174000",
    "lineTaxTotal": "100.00",
    "lineTotal": "100.00",
    "lineType": "product",
    "locationId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "string",
    "ownershipId": "123e4567-e89b-12d3-a456-426614174000",
    "productId": "123e4567-e89b-12d3-a456-426614174000",
    "quantity": "100.00",
    "salesPersonId": "123e4567-e89b-12d3-a456-426614174000",
    "serviceDate": "2025-01-01",
    "standardUnitPrice": "100.00",
    "standardUnitTaxAmount": "100.00",
    "status": "draft",
    "taxCode": "string",
    "taxPercent": 0,
    "unitPrice": "100.00",
    "unitTaxAmount": "100.00"
  }'

Responses

Invoiceline replaced successfully

Bodyapplication/json
animalIdstring or nullrequired

Identifier of the animal associated with this invoice line, if any.

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

Batch or lot identifier for inventory-tracked products, if applicable.

consultIdstring or nullrequired

Identifier of the consultation associated with this invoice line, if any.

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

Timestamp when the invoice line was created.

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

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

discountAmountstringrequired

Absolute discount amount (excluding tax) applied to this line, as a decimal string.

Example: "100.00"
extensionsobjectrequired

Vendor- or practice-specific extensions.

groupIdstring or nullrequired

Identifier for a grouping of invoice lines (e.g., package or section).

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

Identifier of the parent invoice.

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

Canonical identifier for this invoice line.

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

Whether this invoice line is active.

ledgerAccountIdstring or nullrequired

Identifier of the ledger or GL account associated with this line.

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

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

Example: "100.00"
lineTotalstringrequired

Extended line total (excluding tax) after discount, as a decimal string.

Example: "100.00"
lineTypestringrequired

Type of invoice line (e.g., product, service, discount).

Enum"product""service""discount""surcharge""other"
locationIdstring or nullrequired

Identifier of the practice location where this line item was generated.

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

Human-readable description of the invoice line, typically the product or service name.

ownershipIdstring or nullrequired

Identifier representing the ownership or billing entity associated with this line.

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

Reference to the billed product or service.

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

Quantity of the product or service as a decimal string.

Example: "100.00"
salesPersonIdstring or nullrequired

Identifier of the staff member credited as salesperson for this line.

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

Service or supply date associated with this line, if distinct from the invoice date.

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

Standard or list unit price (excluding tax) before discount, as a decimal string.

Example: "100.00"
standardUnitTaxAmountstringrequired

Standard tax amount per unit before discount, as a decimal string.

Example: "100.00"
statusstringrequired

Lifecycle status of the invoice line.

Enum"draft""posted""void""credited"
taxCodestringrequired

Practice-specific tax code applied to this line.

taxPercentnumberrequired

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

unitPricestringrequired

Net unit price (excluding tax) after discount, as a decimal string.

Example: "100.00"
unitTaxAmountstringrequired

Tax amount per unit, as a decimal string.

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

Timestamp when the invoice line was last modified.

Example: "2025-01-01T00:00:00.000Z"
Response
application/json
{ "animalId": "123e4567-e89b-12d3-a456-426614174000", "batch": "string", "consultId": "123e4567-e89b-12d3-a456-426614174000", "createdAt": "2025-01-01T00:00:00.000Z", "currency": "string", "discountAmount": "100.00", "extensions": {}, "groupId": "123e4567-e89b-12d3-a456-426614174000", "invoiceId": "123e4567-e89b-12d3-a456-426614174000", "invoicelineId": "123e4567-e89b-12d3-a456-426614174000", "isActive": true, "ledgerAccountId": "123e4567-e89b-12d3-a456-426614174000", "lineTaxTotal": "100.00", "lineTotal": "100.00", "lineType": "product", "locationId": "123e4567-e89b-12d3-a456-426614174000", "name": "string", "ownershipId": "123e4567-e89b-12d3-a456-426614174000", "productId": "123e4567-e89b-12d3-a456-426614174000", "quantity": "100.00", "salesPersonId": "123e4567-e89b-12d3-a456-426614174000", "serviceDate": "2025-01-01T00:00:00Z", "standardUnitPrice": "100.00", "standardUnitTaxAmount": "100.00", "status": "draft", "taxCode": "string", "taxPercent": 0, "unitPrice": "100.00", "unitTaxAmount": "100.00", "updatedAt": "2025-01-01T00:00:00.000Z" }

Request

Permanently deletes a Invoiceline record.

Security
bearer
Path
siteIdnumberrequired

Site identifier

invoicelineIdstringrequired

Invoiceline unique identifier (UUID)

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

Responses

Invoiceline deleted successfully

Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations