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

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

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

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