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

Request

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

Security
bearer
Path
siteIdnumberrequired

Site identifier

Bodyapplication/jsonrequired
animalIdstring

Animal associated with the invoice.

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

Timestamp when the invoice was approved.

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

User who approved the invoice.

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

Consultation associated with the invoice.

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

Client/contact associated with the invoice.

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

User who created the invoice.

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

ISO 4217 currency code for monetary amounts.

customerReferenceNumberstring

Customer-provided reference number.

dueDatestring

Invoice due date.

Example: "2025-01-01"
extensionsobject

Vendor- or practice-specific extensions.

financialsobject

Financial linkage information for the invoice.

invoiceCodestring

Human-readable invoice code or number.

invoiceDatestringrequired

Invoice issue date.

Example: "2025-01-01"
invoiceIdstringrequired

Canonical identifier for the invoice.

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

Whether the invoice is active.

isTaxIncludedbooleanrequired

Whether line item prices include tax.

lineItemsArray of objects(LineItemDto)required

Line items that make up the 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

Owning organization or business unit.

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

Payment terms associated with the invoice.

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

Subtotal amount excluding tax, as a decimal string.

Example: "100.00"
taxAmountstringrequired

Total tax amount, as a decimal string.

Example: "100.00"
updatedByUserIdstring

User who last modified the invoice.

Example: "123e4567-e89b-12d3-a456-426614174000"
curl -i -X POST \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/invoice' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "animalId": "123e4567-e89b-12d3-a456-426614174000",
    "approvedAt": "2025-01-01T00:00:00.000Z",
    "approvedByUserId": "123e4567-e89b-12d3-a456-426614174000",
    "consultId": "123e4567-e89b-12d3-a456-426614174000",
    "contactId": "123e4567-e89b-12d3-a456-426614174000",
    "createdByUserId": "123e4567-e89b-12d3-a456-426614174000",
    "currency": "string",
    "customerReferenceNumber": "string",
    "dueDate": "2025-01-01",
    "extensions": {},
    "financials": {},
    "invoiceCode": "string",
    "invoiceDate": "2025-01-01",
    "invoiceId": "123e4567-e89b-12d3-a456-426614174000",
    "isActive": true,
    "isTaxIncluded": 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",
    "paymentTermsId": "123e4567-e89b-12d3-a456-426614174000",
    "subtotalAmount": "100.00",
    "taxAmount": "100.00",
    "updatedByUserId": "123e4567-e89b-12d3-a456-426614174000"
  }'

Responses

Invoice created successfully

Bodyapplication/json
animalIdstringrequired

Animal associated with the invoice.

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

Timestamp when the invoice was approved.

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

User who approved the invoice.

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

Consultation associated with the invoice.

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

Client/contact associated with the invoice.

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

Timestamp when the invoice was created.

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

User who created the invoice.

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

ISO 4217 currency code for monetary amounts.

customerReferenceNumberstringrequired

Customer-provided reference number.

dueDatestring(date-time)required

Invoice due date.

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

Vendor- or practice-specific extensions.

financialsobjectrequired

Financial linkage information for the invoice.

invoiceCodestringrequired

Human-readable invoice code or number.

invoiceDatestring(date-time)required

Invoice issue date.

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

Canonical identifier for the invoice.

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

Whether the invoice is active.

isTaxIncludedbooleanrequired

Whether line item prices include tax.

lineItemsArray of objects(LineItemDto)required

Line items that make up the 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

Owning organization or business unit.

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

Payment terms associated with the invoice.

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

Subtotal amount excluding tax, as a decimal string.

Example: "100.00"
taxAmountstringrequired

Total tax amount, as a decimal string.

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

Timestamp when the invoice was last modified.

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

User who last modified the invoice.

Example: "123e4567-e89b-12d3-a456-426614174000"
Response
application/json
{ "animalId": "123e4567-e89b-12d3-a456-426614174000", "approvedAt": "2025-01-01T00:00:00.000Z", "approvedByUserId": "123e4567-e89b-12d3-a456-426614174000", "consultId": "123e4567-e89b-12d3-a456-426614174000", "contactId": "123e4567-e89b-12d3-a456-426614174000", "createdAt": "2025-01-01T00:00:00.000Z", "createdByUserId": "123e4567-e89b-12d3-a456-426614174000", "currency": "string", "customerReferenceNumber": "string", "dueDate": "2025-01-01T00:00:00Z", "extensions": {}, "financials": {}, "invoiceCode": "string", "invoiceDate": "2025-01-01T00:00:00Z", "invoiceId": "123e4567-e89b-12d3-a456-426614174000", "isActive": true, "isTaxIncluded": true, "lineItems": [ { … } ], "ownershipId": "123e4567-e89b-12d3-a456-426614174000", "paymentTermsId": "123e4567-e89b-12d3-a456-426614174000", "subtotalAmount": "100.00", "taxAmount": "100.00", "updatedAt": "2025-01-01T00:00:00.000Z", "updatedByUserId": "123e4567-e89b-12d3-a456-426614174000" }

Request

Returns a paginated list of 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""approvedAt""currency""customerReferenceNumber""dueDate""invoiceCode""invoiceDate""subtotalAmount""taxAmount"
sortOrderstring

Sort order

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

Animal associated with the invoice.

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

User who approved the invoice.

Example: approvedByUserId=123e4567-e89b-12d3-a456-426614174000
consultIdstring

Consultation associated with the invoice.

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

Client/contact associated with the invoice.

Example: contactId=123e4567-e89b-12d3-a456-426614174000
createdByUserIdstring

User who created the invoice.

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

ISO 4217 currency code for monetary amounts.

customerReferenceNumberstring

Customer-provided reference number.

invoiceCodestring

Human-readable invoice code or number.

isActiveboolean

Whether the invoice is active.

isTaxIncludedboolean

Whether line item prices include tax.

ownershipIdstring

Owning organization or business unit.

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

Payment terms associated with the invoice.

Example: paymentTermsId=123e4567-e89b-12d3-a456-426614174000
updatedByUserIdstring

User who last modified the invoice.

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

Responses

Paginated list of Invoices

Request

Returns a single Invoice by its unique identifier.

Security
bearer
Path
siteIdnumberrequired

Site identifier

invoiceIdstringrequired

Invoice unique identifier (UUID)

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

Responses

Invoice found

Bodyapplication/json
animalIdstringrequired

Animal associated with the invoice.

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

Timestamp when the invoice was approved.

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

User who approved the invoice.

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

Consultation associated with the invoice.

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

Client/contact associated with the invoice.

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

Timestamp when the invoice was created.

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

User who created the invoice.

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

ISO 4217 currency code for monetary amounts.

customerReferenceNumberstringrequired

Customer-provided reference number.

dueDatestring(date-time)required

Invoice due date.

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

Vendor- or practice-specific extensions.

financialsobjectrequired

Financial linkage information for the invoice.

invoiceCodestringrequired

Human-readable invoice code or number.

invoiceDatestring(date-time)required

Invoice issue date.

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

Canonical identifier for the invoice.

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

Whether the invoice is active.

isTaxIncludedbooleanrequired

Whether line item prices include tax.

lineItemsArray of objects(LineItemDto)required

Line items that make up the 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

Owning organization or business unit.

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

Payment terms associated with the invoice.

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

Subtotal amount excluding tax, as a decimal string.

Example: "100.00"
taxAmountstringrequired

Total tax amount, as a decimal string.

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

Timestamp when the invoice was last modified.

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

User who last modified the invoice.

Example: "123e4567-e89b-12d3-a456-426614174000"
Response
application/json
{ "animalId": "123e4567-e89b-12d3-a456-426614174000", "approvedAt": "2025-01-01T00:00:00.000Z", "approvedByUserId": "123e4567-e89b-12d3-a456-426614174000", "consultId": "123e4567-e89b-12d3-a456-426614174000", "contactId": "123e4567-e89b-12d3-a456-426614174000", "createdAt": "2025-01-01T00:00:00.000Z", "createdByUserId": "123e4567-e89b-12d3-a456-426614174000", "currency": "string", "customerReferenceNumber": "string", "dueDate": "2025-01-01T00:00:00Z", "extensions": {}, "financials": {}, "invoiceCode": "string", "invoiceDate": "2025-01-01T00:00:00Z", "invoiceId": "123e4567-e89b-12d3-a456-426614174000", "isActive": true, "isTaxIncluded": true, "lineItems": [ { … } ], "ownershipId": "123e4567-e89b-12d3-a456-426614174000", "paymentTermsId": "123e4567-e89b-12d3-a456-426614174000", "subtotalAmount": "100.00", "taxAmount": "100.00", "updatedAt": "2025-01-01T00:00:00.000Z", "updatedByUserId": "123e4567-e89b-12d3-a456-426614174000" }

Request

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

Security
bearer
Path
siteIdnumberrequired

Site identifier

invoiceIdstringrequired

Invoice unique identifier (UUID)

Bodyapplication/jsonrequired
animalIdstring

Animal associated with the invoice.

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

Timestamp when the invoice was approved.

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

User who approved the invoice.

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

Consultation associated with the invoice.

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

Client/contact associated with the invoice.

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

User who created the invoice.

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

ISO 4217 currency code for monetary amounts.

customerReferenceNumberstring

Customer-provided reference number.

dueDatestring

Invoice due date.

Example: "2025-01-01"
extensionsobject

Vendor- or practice-specific extensions.

financialsobject

Financial linkage information for the invoice.

invoiceCodestring

Human-readable invoice code or number.

invoiceDatestring

Invoice issue date.

Example: "2025-01-01"
isActiveboolean

Whether the invoice is active.

isTaxIncludedboolean

Whether line item prices include tax.

lineItemsArray of objects(LineItemDto)

Line items that make up the invoice.

ownershipIdstring

Owning organization or business unit.

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

Payment terms associated with the invoice.

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

Subtotal amount excluding tax, as a decimal string.

Example: "100.00"
taxAmountstring

Total tax amount, as a decimal string.

Example: "100.00"
updatedByUserIdstring

User who last modified the invoice.

Example: "123e4567-e89b-12d3-a456-426614174000"
curl -i -X PATCH \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/invoice/{invoiceId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "animalId": "123e4567-e89b-12d3-a456-426614174000",
    "approvedAt": "2025-01-01T00:00:00.000Z",
    "approvedByUserId": "123e4567-e89b-12d3-a456-426614174000",
    "consultId": "123e4567-e89b-12d3-a456-426614174000",
    "contactId": "123e4567-e89b-12d3-a456-426614174000",
    "createdByUserId": "123e4567-e89b-12d3-a456-426614174000",
    "currency": "string",
    "customerReferenceNumber": "string",
    "dueDate": "2025-01-01",
    "extensions": {},
    "financials": {},
    "invoiceCode": "string",
    "invoiceDate": "2025-01-01",
    "isActive": true,
    "isTaxIncluded": 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",
    "paymentTermsId": "123e4567-e89b-12d3-a456-426614174000",
    "subtotalAmount": "100.00",
    "taxAmount": "100.00",
    "updatedByUserId": "123e4567-e89b-12d3-a456-426614174000"
  }'

Responses

Invoice updated successfully

Bodyapplication/json
animalIdstringrequired

Animal associated with the invoice.

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

Timestamp when the invoice was approved.

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

User who approved the invoice.

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

Consultation associated with the invoice.

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

Client/contact associated with the invoice.

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

Timestamp when the invoice was created.

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

User who created the invoice.

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

ISO 4217 currency code for monetary amounts.

customerReferenceNumberstringrequired

Customer-provided reference number.

dueDatestring(date-time)required

Invoice due date.

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

Vendor- or practice-specific extensions.

financialsobjectrequired

Financial linkage information for the invoice.

invoiceCodestringrequired

Human-readable invoice code or number.

invoiceDatestring(date-time)required

Invoice issue date.

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

Canonical identifier for the invoice.

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

Whether the invoice is active.

isTaxIncludedbooleanrequired

Whether line item prices include tax.

lineItemsArray of objects(LineItemDto)required

Line items that make up the 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

Owning organization or business unit.

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

Payment terms associated with the invoice.

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

Subtotal amount excluding tax, as a decimal string.

Example: "100.00"
taxAmountstringrequired

Total tax amount, as a decimal string.

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

Timestamp when the invoice was last modified.

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

User who last modified the invoice.

Example: "123e4567-e89b-12d3-a456-426614174000"
Response
application/json
{ "animalId": "123e4567-e89b-12d3-a456-426614174000", "approvedAt": "2025-01-01T00:00:00.000Z", "approvedByUserId": "123e4567-e89b-12d3-a456-426614174000", "consultId": "123e4567-e89b-12d3-a456-426614174000", "contactId": "123e4567-e89b-12d3-a456-426614174000", "createdAt": "2025-01-01T00:00:00.000Z", "createdByUserId": "123e4567-e89b-12d3-a456-426614174000", "currency": "string", "customerReferenceNumber": "string", "dueDate": "2025-01-01T00:00:00Z", "extensions": {}, "financials": {}, "invoiceCode": "string", "invoiceDate": "2025-01-01T00:00:00Z", "invoiceId": "123e4567-e89b-12d3-a456-426614174000", "isActive": true, "isTaxIncluded": true, "lineItems": [ { … } ], "ownershipId": "123e4567-e89b-12d3-a456-426614174000", "paymentTermsId": "123e4567-e89b-12d3-a456-426614174000", "subtotalAmount": "100.00", "taxAmount": "100.00", "updatedAt": "2025-01-01T00:00:00.000Z", "updatedByUserId": "123e4567-e89b-12d3-a456-426614174000" }

Request

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

Security
bearer
Path
siteIdnumberrequired

Site identifier

invoiceIdstringrequired

Invoice unique identifier (UUID)

Bodyapplication/jsonrequired
animalIdstringrequired

Animal associated with the invoice.

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

Timestamp when the invoice was approved.

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

User who approved the invoice.

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

Consultation associated with the invoice.

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

Client/contact associated with the invoice.

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

User who created the invoice.

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

ISO 4217 currency code for monetary amounts.

customerReferenceNumberstringrequired

Customer-provided reference number.

dueDatestringrequired

Invoice due date.

Example: "2025-01-01"
extensionsobjectrequired

Vendor- or practice-specific extensions.

financialsobjectrequired

Financial linkage information for the invoice.

invoiceCodestringrequired

Human-readable invoice code or number.

invoiceDatestringrequired

Invoice issue date.

Example: "2025-01-01"
isActivebooleanrequired

Whether the invoice is active.

isTaxIncludedbooleanrequired

Whether line item prices include tax.

lineItemsArray of objects(LineItemDto)required

Line items that make up the 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

Owning organization or business unit.

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

Payment terms associated with the invoice.

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

Subtotal amount excluding tax, as a decimal string.

Example: "100.00"
taxAmountstringrequired

Total tax amount, as a decimal string.

Example: "100.00"
updatedByUserIdstringrequired

User who last modified the invoice.

Example: "123e4567-e89b-12d3-a456-426614174000"
curl -i -X PUT \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/invoice/{invoiceId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "animalId": "123e4567-e89b-12d3-a456-426614174000",
    "approvedAt": "2025-01-01T00:00:00.000Z",
    "approvedByUserId": "123e4567-e89b-12d3-a456-426614174000",
    "consultId": "123e4567-e89b-12d3-a456-426614174000",
    "contactId": "123e4567-e89b-12d3-a456-426614174000",
    "createdByUserId": "123e4567-e89b-12d3-a456-426614174000",
    "currency": "string",
    "customerReferenceNumber": "string",
    "dueDate": "2025-01-01",
    "extensions": {},
    "financials": {},
    "invoiceCode": "string",
    "invoiceDate": "2025-01-01",
    "isActive": true,
    "isTaxIncluded": 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",
    "paymentTermsId": "123e4567-e89b-12d3-a456-426614174000",
    "subtotalAmount": "100.00",
    "taxAmount": "100.00",
    "updatedByUserId": "123e4567-e89b-12d3-a456-426614174000"
  }'

Responses

Invoice replaced successfully

Bodyapplication/json
animalIdstringrequired

Animal associated with the invoice.

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

Timestamp when the invoice was approved.

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

User who approved the invoice.

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

Consultation associated with the invoice.

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

Client/contact associated with the invoice.

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

Timestamp when the invoice was created.

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

User who created the invoice.

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

ISO 4217 currency code for monetary amounts.

customerReferenceNumberstringrequired

Customer-provided reference number.

dueDatestring(date-time)required

Invoice due date.

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

Vendor- or practice-specific extensions.

financialsobjectrequired

Financial linkage information for the invoice.

invoiceCodestringrequired

Human-readable invoice code or number.

invoiceDatestring(date-time)required

Invoice issue date.

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

Canonical identifier for the invoice.

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

Whether the invoice is active.

isTaxIncludedbooleanrequired

Whether line item prices include tax.

lineItemsArray of objects(LineItemDto)required

Line items that make up the 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

Owning organization or business unit.

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

Payment terms associated with the invoice.

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

Subtotal amount excluding tax, as a decimal string.

Example: "100.00"
taxAmountstringrequired

Total tax amount, as a decimal string.

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

Timestamp when the invoice was last modified.

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

User who last modified the invoice.

Example: "123e4567-e89b-12d3-a456-426614174000"
Response
application/json
{ "animalId": "123e4567-e89b-12d3-a456-426614174000", "approvedAt": "2025-01-01T00:00:00.000Z", "approvedByUserId": "123e4567-e89b-12d3-a456-426614174000", "consultId": "123e4567-e89b-12d3-a456-426614174000", "contactId": "123e4567-e89b-12d3-a456-426614174000", "createdAt": "2025-01-01T00:00:00.000Z", "createdByUserId": "123e4567-e89b-12d3-a456-426614174000", "currency": "string", "customerReferenceNumber": "string", "dueDate": "2025-01-01T00:00:00Z", "extensions": {}, "financials": {}, "invoiceCode": "string", "invoiceDate": "2025-01-01T00:00:00Z", "invoiceId": "123e4567-e89b-12d3-a456-426614174000", "isActive": true, "isTaxIncluded": true, "lineItems": [ { … } ], "ownershipId": "123e4567-e89b-12d3-a456-426614174000", "paymentTermsId": "123e4567-e89b-12d3-a456-426614174000", "subtotalAmount": "100.00", "taxAmount": "100.00", "updatedAt": "2025-01-01T00:00:00.000Z", "updatedByUserId": "123e4567-e89b-12d3-a456-426614174000" }

Request

Permanently deletes a Invoice record.

Security
bearer
Path
siteIdnumberrequired

Site identifier

invoiceIdstringrequired

Invoice unique identifier (UUID)

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

Responses

Invoice 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
Operations