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/

Animal

Operations

Animal Colour

Operations

Breed

Operations

Health Status

Operations

Herd

Operations

Sex

Operations

Shelter Animal Booking

Operations

Species

Operations

Assessment

Operations

Consult

Operations

History

Operations

Physical Exam

Operations

Presentingproblem

Operations

Standardofcare

Operations

Therapeutic

Operations

Vaccination

Operations

Diagnostic

Operations

Diagnostic Code

Operations

Diagnostic Request

Operations

Diagnostic Result

Operations

Diagnostic Result Item

Operations

Integrated Diagnostic

Operations

Modality

Operations

Standard Diagnostic Lab Report

Operations

External Prescription

Operations

Prescription

Operations

Prescription Item

Operations

Appointment

Operations

Appointment Status

Operations

Appointment Type

Operations

Availability

Operations

Availability Slot

Operations

Booking

Operations

Billing Credit

Operations

Billing Line

Operations

Estimate

Operations

Insurance

Operations

Invoice

Operations

Replace invoice

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

Delete invoice

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

Invoiceline

Operations

Ledger Account

Operations

Linked Payment

Operations

Payment

Operations

Paymentmethod

Operations

Plan

Operations

Price Adjustment

Operations

Receive Invoice

Operations

Taxrate

Operations

Barcode

Operations

Batch

Operations

Inventory Message

Operations

Inventory Product

Operations

Inventory Requirement

Operations

Inventory Supplied Product

Operations

Product

Operations

Product Minimum Stock

Operations

Product Pricing

Operations

Product Supplier

Operations

Productgroup

Operations

Purchaseorder

Operations

Purchaseorderitem

Operations

Receive Invoice Item

Operations

Stock Adjustment

Operations

Stock Adjustment Item

Operations

Stock Transaction

Operations

Supplied

Operations

With Primary Inventory Location

Operations

Address

Operations

Contact

Operations

Contact Association

Operations

Contact Detail

Operations

Communication

Operations

Message

Operations

Template

Operations

User

Operations

Webhook

Operations

Webhook Event

Operations

Attachment

Operations

Country

Operations

Facility

Operations

File

Operations

File Upload

Operations

Location

Operations

Practitioner

Operations

Wellness Resource

Operations

Eventgroup

Operations

Operation

Operations

Requisition Form

Operations

Resource

Operations

Separation

Operations

Site Information

Operations

System Setting

Operations

Tag

Operations

Tagcategory

Operations

Tagname

Operations

Transaction

Operations