Skip to content

AHDS Store API (1.0)

Animal Health Data Store - V1 API Documentation

Overview
Languages
Servers
Mock server

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

Local Development

http://localhost:8083/

Address

Operations

Animal

Operations

Animal Colour

Operations

Appointment

Operations

Appointment Status

Operations

Appointment Type

Operations

Assessment

Operations

Attachment

Operations

Availability

Operations

Availability Slot

Operations

Barcode

Operations

Batch

Operations

Billing Credit

Operations

Billing Line

Operations

Create billing line

Request

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

Security
bearer
Path
siteIdnumberrequired

Site identifier

Bodyapplication/jsonrequired
currencystringrequired

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

descriptionstringrequired

Human-readable description of the billed item or service.

discountAmountstring

Discount amount applied to this line, excluding tax, as a decimal string.

Example: "100.00"
extensionsobject

Vendor- or practice-specific extensions.

invoiceIdstringrequired

Identifier of the invoice this line belongs to.

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

Whether this line is currently active.

lineIdstringrequired

Canonical identifier for this billing line.

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

Total line amount excluding tax (unitPrice * quantity, minus discounts).

Example: "100.00"
lineTotalTaxstringrequired

Total tax amount for this line.

Example: "100.00"
quantitynumberrequired

Quantity of units billed.

taxCodeobject
taxRatePercentnumber

Tax rate as a percentage (e.g., 15 for 15%).

unitPricestringrequired

Unit price excluding tax, as a decimal string.

Example: "100.00"
unitPriceTaxstringrequired

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/billing-line' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "currency": "string",
    "description": "string",
    "discountAmount": "100.00",
    "extensions": {},
    "invoiceId": "123e4567-e89b-12d3-a456-426614174000",
    "isActive": true,
    "lineId": "123e4567-e89b-12d3-a456-426614174000",
    "lineTotal": "100.00",
    "lineTotalTax": "100.00",
    "quantity": 0,
    "taxCode": {
      "code": "string",
      "system": "string",
      "display": "string"
    },
    "taxRatePercent": 0,
    "unitPrice": "100.00",
    "unitPriceTax": "100.00"
  }'

Responses

Billing Line created successfully

Bodyapplication/json
createdAtstring(date-time)required

Timestamp when this line was created.

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

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

descriptionstringrequired

Human-readable description of the billed item or service.

discountAmountstringrequired

Discount amount applied to this line, excluding tax, as a decimal string.

Example: "100.00"
extensionsobjectrequired

Vendor- or practice-specific extensions.

invoiceIdstringrequired

Identifier of the invoice this line belongs to.

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

Whether this line is currently active.

lineIdstringrequired

Canonical identifier for this billing line.

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

Total line amount excluding tax (unitPrice * quantity, minus discounts).

Example: "100.00"
lineTotalTaxstringrequired

Total tax amount for this line.

Example: "100.00"
quantitynumberrequired

Quantity of units billed.

taxCodeobjectrequired
taxCode.​codestringrequired

Code value

taxCode.​systemstringrequired

Code system URI

taxCode.​displaystring

Human-readable display

taxRatePercentnumberrequired

Tax rate as a percentage (e.g., 15 for 15%).

unitPricestringrequired

Unit price excluding tax, as a decimal string.

Example: "100.00"
unitPriceTaxstringrequired

Tax amount per unit, as a decimal string.

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

Timestamp when this line was last updated.

Example: "2025-01-01T00:00:00.000Z"
Response
application/json
{
  "createdAt": "2025-01-01T00:00:00.000Z",
  "currency": "string",
  "description": "string",
  "discountAmount": "100.00",
  "extensions": {},
  "invoiceId": "123e4567-e89b-12d3-a456-426614174000",
  "isActive": true,
  "lineId": "123e4567-e89b-12d3-a456-426614174000",
  "lineTotal": "100.00",
  "lineTotalTax": "100.00",
  "quantity": 0,
  "taxCode": {
    "code": "string",
    "system": "string",
    "display": "string"
  },
  "taxRatePercent": 0,
  "unitPrice": "100.00",
  "unitPriceTax": "100.00",
  "updatedAt": "2025-01-01T00:00:00.000Z"
}

List billing lines

Request

Returns a paginated list of Billing Lines 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""currency""description""discountAmount""lineTotal""lineTotalTax""quantity""taxRatePercent""unitPrice"
sortOrderstring

Sort order

Default "asc"
Enum"asc""desc"
currencystring

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

descriptionstring

Human-readable description of the billed item or service.

invoiceIdstring

Identifier of the invoice this line belongs to.

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

Whether this line is currently active.

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

Responses

Paginated list of Billing Lines

Get billing line

Request

Returns a single Billing Line by its unique identifier.

Security
bearer
Path
siteIdnumberrequired

Site identifier

lineIdstringrequired

Billing Line unique identifier (UUID)

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

Responses

Billing Line found

Bodyapplication/json
createdAtstring(date-time)required

Timestamp when this line was created.

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

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

descriptionstringrequired

Human-readable description of the billed item or service.

discountAmountstringrequired

Discount amount applied to this line, excluding tax, as a decimal string.

Example: "100.00"
extensionsobjectrequired

Vendor- or practice-specific extensions.

invoiceIdstringrequired

Identifier of the invoice this line belongs to.

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

Whether this line is currently active.

lineIdstringrequired

Canonical identifier for this billing line.

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

Total line amount excluding tax (unitPrice * quantity, minus discounts).

Example: "100.00"
lineTotalTaxstringrequired

Total tax amount for this line.

Example: "100.00"
quantitynumberrequired

Quantity of units billed.

taxCodeobjectrequired
taxCode.​codestringrequired

Code value

taxCode.​systemstringrequired

Code system URI

taxCode.​displaystring

Human-readable display

taxRatePercentnumberrequired

Tax rate as a percentage (e.g., 15 for 15%).

unitPricestringrequired

Unit price excluding tax, as a decimal string.

Example: "100.00"
unitPriceTaxstringrequired

Tax amount per unit, as a decimal string.

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

Timestamp when this line was last updated.

Example: "2025-01-01T00:00:00.000Z"
Response
application/json
{
  "createdAt": "2025-01-01T00:00:00.000Z",
  "currency": "string",
  "description": "string",
  "discountAmount": "100.00",
  "extensions": {},
  "invoiceId": "123e4567-e89b-12d3-a456-426614174000",
  "isActive": true,
  "lineId": "123e4567-e89b-12d3-a456-426614174000",
  "lineTotal": "100.00",
  "lineTotalTax": "100.00",
  "quantity": 0,
  "taxCode": {
    "code": "string",
    "system": "string",
    "display": "string"
  },
  "taxRatePercent": 0,
  "unitPrice": "100.00",
  "unitPriceTax": "100.00",
  "updatedAt": "2025-01-01T00:00:00.000Z"
}

Update billing line

Request

Partially updates an existing Billing Line. Only provided fields will be updated.

Security
bearer
Path
siteIdnumberrequired

Site identifier

lineIdstringrequired

Billing Line unique identifier (UUID)

Bodyapplication/jsonrequired
currencystring

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

descriptionstring

Human-readable description of the billed item or service.

discountAmountstring

Discount amount applied to this line, excluding tax, as a decimal string.

Example: "100.00"
extensionsobject

Vendor- or practice-specific extensions.

invoiceIdstring

Identifier of the invoice this line belongs to.

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

Whether this line is currently active.

lineTotalstring

Total line amount excluding tax (unitPrice * quantity, minus discounts).

Example: "100.00"
lineTotalTaxstring

Total tax amount for this line.

Example: "100.00"
quantitynumber

Quantity of units billed.

taxCodeobject
taxRatePercentnumber

Tax rate as a percentage (e.g., 15 for 15%).

unitPricestring

Unit price excluding tax, as a decimal string.

Example: "100.00"
unitPriceTaxstring

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/billing-line/{lineId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "currency": "string",
    "description": "string",
    "discountAmount": "100.00",
    "extensions": {},
    "invoiceId": "123e4567-e89b-12d3-a456-426614174000",
    "isActive": true,
    "lineTotal": "100.00",
    "lineTotalTax": "100.00",
    "quantity": 0,
    "taxCode": {
      "code": "string",
      "system": "string",
      "display": "string"
    },
    "taxRatePercent": 0,
    "unitPrice": "100.00",
    "unitPriceTax": "100.00"
  }'

Responses

Billing Line updated successfully

Bodyapplication/json
createdAtstring(date-time)required

Timestamp when this line was created.

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

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

descriptionstringrequired

Human-readable description of the billed item or service.

discountAmountstringrequired

Discount amount applied to this line, excluding tax, as a decimal string.

Example: "100.00"
extensionsobjectrequired

Vendor- or practice-specific extensions.

invoiceIdstringrequired

Identifier of the invoice this line belongs to.

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

Whether this line is currently active.

lineIdstringrequired

Canonical identifier for this billing line.

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

Total line amount excluding tax (unitPrice * quantity, minus discounts).

Example: "100.00"
lineTotalTaxstringrequired

Total tax amount for this line.

Example: "100.00"
quantitynumberrequired

Quantity of units billed.

taxCodeobjectrequired
taxCode.​codestringrequired

Code value

taxCode.​systemstringrequired

Code system URI

taxCode.​displaystring

Human-readable display

taxRatePercentnumberrequired

Tax rate as a percentage (e.g., 15 for 15%).

unitPricestringrequired

Unit price excluding tax, as a decimal string.

Example: "100.00"
unitPriceTaxstringrequired

Tax amount per unit, as a decimal string.

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

Timestamp when this line was last updated.

Example: "2025-01-01T00:00:00.000Z"
Response
application/json
{
  "createdAt": "2025-01-01T00:00:00.000Z",
  "currency": "string",
  "description": "string",
  "discountAmount": "100.00",
  "extensions": {},
  "invoiceId": "123e4567-e89b-12d3-a456-426614174000",
  "isActive": true,
  "lineId": "123e4567-e89b-12d3-a456-426614174000",
  "lineTotal": "100.00",
  "lineTotalTax": "100.00",
  "quantity": 0,
  "taxCode": {
    "code": "string",
    "system": "string",
    "display": "string"
  },
  "taxRatePercent": 0,
  "unitPrice": "100.00",
  "unitPriceTax": "100.00",
  "updatedAt": "2025-01-01T00:00:00.000Z"
}

Replace billing line

Request

Fully replaces an existing Billing Line. All fields must be provided.

Security
bearer
Path
siteIdnumberrequired

Site identifier

lineIdstringrequired

Billing Line unique identifier (UUID)

Bodyapplication/jsonrequired
currencystringrequired

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

descriptionstringrequired

Human-readable description of the billed item or service.

discountAmountstringrequired

Discount amount applied to this line, excluding tax, as a decimal string.

Example: "100.00"
extensionsobjectrequired

Vendor- or practice-specific extensions.

invoiceIdstringrequired

Identifier of the invoice this line belongs to.

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

Whether this line is currently active.

lineTotalstringrequired

Total line amount excluding tax (unitPrice * quantity, minus discounts).

Example: "100.00"
lineTotalTaxstringrequired

Total tax amount for this line.

Example: "100.00"
quantitynumberrequired

Quantity of units billed.

taxCodeobjectrequired
taxCode.​codestringrequired

Code value

taxCode.​systemstringrequired

Code system URI

taxCode.​displaystring

Human-readable display

taxRatePercentnumberrequired

Tax rate as a percentage (e.g., 15 for 15%).

unitPricestringrequired

Unit price excluding tax, as a decimal string.

Example: "100.00"
unitPriceTaxstringrequired

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/billing-line/{lineId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "currency": "string",
    "description": "string",
    "discountAmount": "100.00",
    "extensions": {},
    "invoiceId": "123e4567-e89b-12d3-a456-426614174000",
    "isActive": true,
    "lineTotal": "100.00",
    "lineTotalTax": "100.00",
    "quantity": 0,
    "taxCode": {
      "code": "string",
      "system": "string",
      "display": "string"
    },
    "taxRatePercent": 0,
    "unitPrice": "100.00",
    "unitPriceTax": "100.00"
  }'

Responses

Billing Line replaced successfully

Bodyapplication/json
createdAtstring(date-time)required

Timestamp when this line was created.

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

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

descriptionstringrequired

Human-readable description of the billed item or service.

discountAmountstringrequired

Discount amount applied to this line, excluding tax, as a decimal string.

Example: "100.00"
extensionsobjectrequired

Vendor- or practice-specific extensions.

invoiceIdstringrequired

Identifier of the invoice this line belongs to.

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

Whether this line is currently active.

lineIdstringrequired

Canonical identifier for this billing line.

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

Total line amount excluding tax (unitPrice * quantity, minus discounts).

Example: "100.00"
lineTotalTaxstringrequired

Total tax amount for this line.

Example: "100.00"
quantitynumberrequired

Quantity of units billed.

taxCodeobjectrequired
taxCode.​codestringrequired

Code value

taxCode.​systemstringrequired

Code system URI

taxCode.​displaystring

Human-readable display

taxRatePercentnumberrequired

Tax rate as a percentage (e.g., 15 for 15%).

unitPricestringrequired

Unit price excluding tax, as a decimal string.

Example: "100.00"
unitPriceTaxstringrequired

Tax amount per unit, as a decimal string.

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

Timestamp when this line was last updated.

Example: "2025-01-01T00:00:00.000Z"
Response
application/json
{
  "createdAt": "2025-01-01T00:00:00.000Z",
  "currency": "string",
  "description": "string",
  "discountAmount": "100.00",
  "extensions": {},
  "invoiceId": "123e4567-e89b-12d3-a456-426614174000",
  "isActive": true,
  "lineId": "123e4567-e89b-12d3-a456-426614174000",
  "lineTotal": "100.00",
  "lineTotalTax": "100.00",
  "quantity": 0,
  "taxCode": {
    "code": "string",
    "system": "string",
    "display": "string"
  },
  "taxRatePercent": 0,
  "unitPrice": "100.00",
  "unitPriceTax": "100.00",
  "updatedAt": "2025-01-01T00:00:00.000Z"
}

Delete billing line

Request

Permanently deletes a Billing Line record.

Security
bearer
Path
siteIdnumberrequired

Site identifier

lineIdstringrequired

Billing Line unique identifier (UUID)

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

Responses

Billing Line deleted successfully

Booking

Operations

Breed

Operations

Communication

Operations

Consult

Operations

Contact

Operations

Contact Association

Operations

Contact Detail

Operations

Country

Operations

Diagnostic

Operations

Diagnostic Code

Operations

Diagnostic Request

Operations

Diagnostic Result

Operations

Diagnostic Result Item

Operations

Estimate

Operations

Eventgroup

Operations

External Prescription

Operations

Facility

Operations

File

Operations

File Upload

Operations

Health Status

Operations

Herd

Operations

History

Operations

Insurance

Operations

Integrated Diagnostic

Operations

Inventory Message

Operations

Inventory Product

Operations

Inventory Requirement

Operations

Inventory Supplied Product

Operations

Invoice

Operations

Invoiceline

Operations

Ledger Account

Operations

Linked Payment

Operations

Location

Operations

Message

Operations

Modality

Operations

Operation

Operations

Payment

Operations

Paymentmethod

Operations

Physical Exam

Operations

Plan

Operations

Practitioner

Operations

Prescription

Operations

Prescription Item

Operations

Presentingproblem

Operations

Price Adjustment

Operations

Product

Operations

Product Minimum Stock

Operations

Product Pricing

Operations

Product Supplier

Operations

Productgroup

Operations

Purchaseorder

Operations

Purchaseorderitem

Operations

Receive Invoice

Operations

Receive Invoice Item

Operations

Requisition Form

Operations

Resource

Operations

Separation

Operations

Sex

Operations

Shelter Animal Booking

Operations

Site Information

Operations

Species

Operations

Standard Diagnostic Lab Report

Operations

Standardofcare

Operations

Stock Adjustment

Operations

Stock Adjustment Item

Operations

Stock Transaction

Operations

Supplied

Operations

System Setting

Operations

Tag

Operations

Tagcategory

Operations

Tagname

Operations

Taxrate

Operations

Template

Operations

Therapeutic

Operations

Transaction

Operations

User

Operations

Vaccination

Operations

Webhook

Operations

Webhook Event

Operations

Wellness Resource

Operations

With Primary Inventory Location

Operations