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

Update billing credit

Request

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

Security
bearer
Path
siteIdnumberrequired

Site identifier

billingCreditIdstringrequired

Billing Credit unique identifier (UUID)

Bodyapplication/jsonrequired
appliedToobject

Entity the credit is currently associated/applied to, if different from availability.

availableToobject

Entity for which this credit is available to be applied.

creditTypestring

Whether the credit is tracked as a quantity (e.g., visits) or a monetary value.

Enum"quantity""value"
Example: "quantity"
endDatestring

Date on which the credit expires, if applicable.

Example: "2025-01-01"
expiryobject

Relative expiry configuration, if the credit expires after a period.

extensionsobject

Vendor- or practice-specific extensions.

isActiveboolean

Whether this billing credit is currently active and usable.

Example: true
remainingAmountnumber

Quantity or monetary amount still available for use.

Example: 1.23
startDatestring

Date from which the credit becomes valid.

Example: "2025-01-01"
totalAmountnumber

Total quantity or monetary amount originally granted for this credit.

Example: 1.23
usedAmountnumber

Quantity or monetary amount that has been used.

Example: 1.23
wastedAmountnumber

Quantity or monetary amount that has been wasted or expired without use.

Example: 1.23
wellnessPlanBenefitIdstring

Identifier of the wellness plan benefit that generated this credit, if applicable.

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

Identifier of the wellness plan that generated this credit, if applicable.

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

Identifier of the membership cycle associated with this credit, if applicable.

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

Identifier of the wellness plan membership associated with this credit, if applicable.

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

Identifier of the membership status period associated with this credit, if applicable.

Example: "123e4567-e89b-12d3-a456-426614174000"
amountTypeobject
creditCategoryobject
currencyobject
measurementUnitobject
curl -i -X PATCH \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/billing-credit/{billingCreditId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "appliedTo": {},
    "availableTo": {},
    "creditType": "quantity",
    "endDate": "2025-01-01",
    "expiry": {},
    "extensions": {},
    "isActive": true,
    "remainingAmount": 1.23,
    "startDate": "2025-01-01",
    "totalAmount": 1.23,
    "usedAmount": 1.23,
    "wastedAmount": 1.23,
    "wellnessPlanBenefitId": "123e4567-e89b-12d3-a456-426614174000",
    "wellnessPlanId": "123e4567-e89b-12d3-a456-426614174000",
    "wellnessPlanMembershipCycleId": "123e4567-e89b-12d3-a456-426614174000",
    "wellnessPlanMembershipId": "123e4567-e89b-12d3-a456-426614174000",
    "wellnessPlanMembershipStatusPeriodId": "123e4567-e89b-12d3-a456-426614174000",
    "amountType": {
      "code": "12345",
      "system": "http://example.com/codesystem",
      "display": "Example Display Name"
    },
    "creditCategory": {
      "code": "12345",
      "system": "http://example.com/codesystem",
      "display": "Example Display Name"
    },
    "currency": {
      "code": "12345",
      "system": "http://example.com/codesystem",
      "display": "Example Display Name"
    },
    "measurementUnit": {
      "code": "12345",
      "system": "http://example.com/codesystem",
      "display": "Example Display Name"
    }
  }'

Responses

Billing Credit updated successfully

Bodyapplication/json
appliedToobjectrequired

Entity the credit is currently associated/applied to, if different from availability.

availableToobjectrequired

Entity for which this credit is available to be applied.

billingCreditIdstringrequired

Canonical identifier for the billing credit.

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

Timestamp when the billing credit was created.

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

Whether the credit is tracked as a quantity (e.g., visits) or a monetary value.

Enum"quantity""value"
Example: "quantity"
endDatestring(date-time)required

Date on which the credit expires, if applicable.

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

Relative expiry configuration, if the credit expires after a period.

extensionsobjectrequired

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether this billing credit is currently active and usable.

Example: true
remainingAmountnumberrequired

Quantity or monetary amount still available for use.

Example: 1.23
startDatestring(date-time)required

Date from which the credit becomes valid.

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

Total quantity or monetary amount originally granted for this credit.

Example: 1.23
updatedAtstring(date-time)required

Timestamp when the billing credit was last updated.

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

Quantity or monetary amount that has been used.

Example: 1.23
wastedAmountnumberrequired

Quantity or monetary amount that has been wasted or expired without use.

Example: 1.23
wellnessPlanBenefitIdstringrequired

Identifier of the wellness plan benefit that generated this credit, if applicable.

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

Identifier of the wellness plan that generated this credit, if applicable.

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

Identifier of the membership cycle associated with this credit, if applicable.

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

Identifier of the wellness plan membership associated with this credit, if applicable.

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

Identifier of the membership status period associated with this credit, if applicable.

Example: "123e4567-e89b-12d3-a456-426614174000"
amountTypeobjectrequired
amountType.​codestringrequired

Code value

Example: "12345"
amountType.​systemstringrequired

Code system URI

Example: "http://example.com/codesystem"
amountType.​displaystring

Human-readable display

Example: "Example Display Name"
creditCategoryobjectrequired
creditCategory.​codestringrequired

Code value

Example: "12345"
creditCategory.​systemstringrequired

Code system URI

Example: "http://example.com/codesystem"
creditCategory.​displaystring

Human-readable display

Example: "Example Display Name"
currencyobjectrequired
currency.​codestringrequired

Code value

Example: "12345"
currency.​systemstringrequired

Code system URI

Example: "http://example.com/codesystem"
currency.​displaystring

Human-readable display

Example: "Example Display Name"
measurementUnitobjectrequired
measurementUnit.​codestringrequired

Code value

Example: "12345"
measurementUnit.​systemstringrequired

Code system URI

Example: "http://example.com/codesystem"
measurementUnit.​displaystring

Human-readable display

Example: "Example Display Name"
Response
application/json
{
  "appliedTo": {},
  "availableTo": {},
  "billingCreditId": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "creditType": "quantity",
  "endDate": "2025-01-01T00:00:00Z",
  "expiry": {},
  "extensions": {},
  "isActive": true,
  "remainingAmount": 1.23,
  "startDate": "2025-01-01T00:00:00Z",
  "totalAmount": 1.23,
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "usedAmount": 1.23,
  "wastedAmount": 1.23,
  "wellnessPlanBenefitId": "123e4567-e89b-12d3-a456-426614174000",
  "wellnessPlanId": "123e4567-e89b-12d3-a456-426614174000",
  "wellnessPlanMembershipCycleId": "123e4567-e89b-12d3-a456-426614174000",
  "wellnessPlanMembershipId": "123e4567-e89b-12d3-a456-426614174000",
  "wellnessPlanMembershipStatusPeriodId": "123e4567-e89b-12d3-a456-426614174000",
  "amountType": {
    "code": "12345",
    "system": "http://example.com/codesystem",
    "display": "Example Display Name"
  },
  "creditCategory": {
    "code": "12345",
    "system": "http://example.com/codesystem",
    "display": "Example Display Name"
  },
  "currency": {
    "code": "12345",
    "system": "http://example.com/codesystem",
    "display": "Example Display Name"
  },
  "measurementUnit": {
    "code": "12345",
    "system": "http://example.com/codesystem",
    "display": "Example Display Name"
  }
}

Replace billing credit

Request

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

Security
bearer
Path
siteIdnumberrequired

Site identifier

billingCreditIdstringrequired

Billing Credit unique identifier (UUID)

Bodyapplication/jsonrequired
appliedToobjectrequired

Entity the credit is currently associated/applied to, if different from availability.

availableToobjectrequired

Entity for which this credit is available to be applied.

creditTypestringrequired

Whether the credit is tracked as a quantity (e.g., visits) or a monetary value.

Enum"quantity""value"
Example: "quantity"
endDatestringrequired

Date on which the credit expires, if applicable.

Example: "2025-01-01"
expiryobjectrequired

Relative expiry configuration, if the credit expires after a period.

extensionsobjectrequired

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether this billing credit is currently active and usable.

Example: true
remainingAmountnumberrequired

Quantity or monetary amount still available for use.

Example: 1.23
startDatestringrequired

Date from which the credit becomes valid.

Example: "2025-01-01"
totalAmountnumberrequired

Total quantity or monetary amount originally granted for this credit.

Example: 1.23
usedAmountnumberrequired

Quantity or monetary amount that has been used.

Example: 1.23
wastedAmountnumberrequired

Quantity or monetary amount that has been wasted or expired without use.

Example: 1.23
wellnessPlanBenefitIdstringrequired

Identifier of the wellness plan benefit that generated this credit, if applicable.

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

Identifier of the wellness plan that generated this credit, if applicable.

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

Identifier of the membership cycle associated with this credit, if applicable.

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

Identifier of the wellness plan membership associated with this credit, if applicable.

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

Identifier of the membership status period associated with this credit, if applicable.

Example: "123e4567-e89b-12d3-a456-426614174000"
amountTypeobjectrequired
amountType.​codestringrequired

Code value

Example: "12345"
amountType.​systemstringrequired

Code system URI

Example: "http://example.com/codesystem"
amountType.​displaystring

Human-readable display

Example: "Example Display Name"
creditCategoryobjectrequired
creditCategory.​codestringrequired

Code value

Example: "12345"
creditCategory.​systemstringrequired

Code system URI

Example: "http://example.com/codesystem"
creditCategory.​displaystring

Human-readable display

Example: "Example Display Name"
currencyobjectrequired
currency.​codestringrequired

Code value

Example: "12345"
currency.​systemstringrequired

Code system URI

Example: "http://example.com/codesystem"
currency.​displaystring

Human-readable display

Example: "Example Display Name"
measurementUnitobjectrequired
measurementUnit.​codestringrequired

Code value

Example: "12345"
measurementUnit.​systemstringrequired

Code system URI

Example: "http://example.com/codesystem"
measurementUnit.​displaystring

Human-readable display

Example: "Example Display Name"
curl -i -X PUT \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/billing-credit/{billingCreditId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "appliedTo": {},
    "availableTo": {},
    "creditType": "quantity",
    "endDate": "2025-01-01",
    "expiry": {},
    "extensions": {},
    "isActive": true,
    "remainingAmount": 1.23,
    "startDate": "2025-01-01",
    "totalAmount": 1.23,
    "usedAmount": 1.23,
    "wastedAmount": 1.23,
    "wellnessPlanBenefitId": "123e4567-e89b-12d3-a456-426614174000",
    "wellnessPlanId": "123e4567-e89b-12d3-a456-426614174000",
    "wellnessPlanMembershipCycleId": "123e4567-e89b-12d3-a456-426614174000",
    "wellnessPlanMembershipId": "123e4567-e89b-12d3-a456-426614174000",
    "wellnessPlanMembershipStatusPeriodId": "123e4567-e89b-12d3-a456-426614174000",
    "amountType": {
      "code": "12345",
      "system": "http://example.com/codesystem",
      "display": "Example Display Name"
    },
    "creditCategory": {
      "code": "12345",
      "system": "http://example.com/codesystem",
      "display": "Example Display Name"
    },
    "currency": {
      "code": "12345",
      "system": "http://example.com/codesystem",
      "display": "Example Display Name"
    },
    "measurementUnit": {
      "code": "12345",
      "system": "http://example.com/codesystem",
      "display": "Example Display Name"
    }
  }'

Responses

Billing Credit replaced successfully

Bodyapplication/json
appliedToobjectrequired

Entity the credit is currently associated/applied to, if different from availability.

availableToobjectrequired

Entity for which this credit is available to be applied.

billingCreditIdstringrequired

Canonical identifier for the billing credit.

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

Timestamp when the billing credit was created.

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

Whether the credit is tracked as a quantity (e.g., visits) or a monetary value.

Enum"quantity""value"
Example: "quantity"
endDatestring(date-time)required

Date on which the credit expires, if applicable.

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

Relative expiry configuration, if the credit expires after a period.

extensionsobjectrequired

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether this billing credit is currently active and usable.

Example: true
remainingAmountnumberrequired

Quantity or monetary amount still available for use.

Example: 1.23
startDatestring(date-time)required

Date from which the credit becomes valid.

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

Total quantity or monetary amount originally granted for this credit.

Example: 1.23
updatedAtstring(date-time)required

Timestamp when the billing credit was last updated.

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

Quantity or monetary amount that has been used.

Example: 1.23
wastedAmountnumberrequired

Quantity or monetary amount that has been wasted or expired without use.

Example: 1.23
wellnessPlanBenefitIdstringrequired

Identifier of the wellness plan benefit that generated this credit, if applicable.

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

Identifier of the wellness plan that generated this credit, if applicable.

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

Identifier of the membership cycle associated with this credit, if applicable.

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

Identifier of the wellness plan membership associated with this credit, if applicable.

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

Identifier of the membership status period associated with this credit, if applicable.

Example: "123e4567-e89b-12d3-a456-426614174000"
amountTypeobjectrequired
amountType.​codestringrequired

Code value

Example: "12345"
amountType.​systemstringrequired

Code system URI

Example: "http://example.com/codesystem"
amountType.​displaystring

Human-readable display

Example: "Example Display Name"
creditCategoryobjectrequired
creditCategory.​codestringrequired

Code value

Example: "12345"
creditCategory.​systemstringrequired

Code system URI

Example: "http://example.com/codesystem"
creditCategory.​displaystring

Human-readable display

Example: "Example Display Name"
currencyobjectrequired
currency.​codestringrequired

Code value

Example: "12345"
currency.​systemstringrequired

Code system URI

Example: "http://example.com/codesystem"
currency.​displaystring

Human-readable display

Example: "Example Display Name"
measurementUnitobjectrequired
measurementUnit.​codestringrequired

Code value

Example: "12345"
measurementUnit.​systemstringrequired

Code system URI

Example: "http://example.com/codesystem"
measurementUnit.​displaystring

Human-readable display

Example: "Example Display Name"
Response
application/json
{
  "appliedTo": {},
  "availableTo": {},
  "billingCreditId": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "creditType": "quantity",
  "endDate": "2025-01-01T00:00:00Z",
  "expiry": {},
  "extensions": {},
  "isActive": true,
  "remainingAmount": 1.23,
  "startDate": "2025-01-01T00:00:00Z",
  "totalAmount": 1.23,
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "usedAmount": 1.23,
  "wastedAmount": 1.23,
  "wellnessPlanBenefitId": "123e4567-e89b-12d3-a456-426614174000",
  "wellnessPlanId": "123e4567-e89b-12d3-a456-426614174000",
  "wellnessPlanMembershipCycleId": "123e4567-e89b-12d3-a456-426614174000",
  "wellnessPlanMembershipId": "123e4567-e89b-12d3-a456-426614174000",
  "wellnessPlanMembershipStatusPeriodId": "123e4567-e89b-12d3-a456-426614174000",
  "amountType": {
    "code": "12345",
    "system": "http://example.com/codesystem",
    "display": "Example Display Name"
  },
  "creditCategory": {
    "code": "12345",
    "system": "http://example.com/codesystem",
    "display": "Example Display Name"
  },
  "currency": {
    "code": "12345",
    "system": "http://example.com/codesystem",
    "display": "Example Display Name"
  },
  "measurementUnit": {
    "code": "12345",
    "system": "http://example.com/codesystem",
    "display": "Example Display Name"
  }
}

Delete billing credit

Request

Permanently deletes a Billing Credit record.

Security
bearer
Path
siteIdnumberrequired

Site identifier

billingCreditIdstringrequired

Billing Credit unique identifier (UUID)

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

Responses

Billing Credit deleted successfully

Billing Line

Operations

Estimate

Operations

Insurance

Operations

Invoice

Operations

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