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

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

Create linked payment

Request

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

Security
bearer
Path
siteIdnumberrequired

Site identifier

Bodyapplication/jsonrequired
amountstringrequired

Monetary amount of the payment applied to the target, as a decimal string.

Example: "100.00"
currencystringrequired

ISO 4217 currency code for the linked amount.

extensionsobject

Vendor- or practice-specific extensions.

linkedPaymentIdstringrequired

Canonical identifier for this linked payment record.

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

Identifier of the payment that is being linked.

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

Identifier of the entity this payment is linked to (e.g., invoiceId).

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

Type of entity this payment is linked to.

Enum"invoice""creditNote""other"
curl -i -X POST \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/linked-payment' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "amount": "100.00",
    "currency": "string",
    "extensions": {},
    "linkedPaymentId": "123e4567-e89b-12d3-a456-426614174000",
    "paymentId": "123e4567-e89b-12d3-a456-426614174000",
    "targetId": "123e4567-e89b-12d3-a456-426614174000",
    "targetType": "invoice"
  }'

Responses

Linked Payment created successfully

Bodyapplication/json
amountstringrequired

Monetary amount of the payment applied to the target, as a decimal string.

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

Timestamp when this linked payment record was created.

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

ISO 4217 currency code for the linked amount.

extensionsobjectrequired

Vendor- or practice-specific extensions.

linkedPaymentIdstringrequired

Canonical identifier for this linked payment record.

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

Identifier of the payment that is being linked.

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

Identifier of the entity this payment is linked to (e.g., invoiceId).

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

Type of entity this payment is linked to.

Enum"invoice""creditNote""other"
updatedAtstring(date-time)required

Timestamp when this linked payment record was last updated.

Example: "2025-01-01T00:00:00.000Z"
Response
application/json
{
  "amount": "100.00",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "currency": "string",
  "extensions": {},
  "linkedPaymentId": "123e4567-e89b-12d3-a456-426614174000",
  "paymentId": "123e4567-e89b-12d3-a456-426614174000",
  "targetId": "123e4567-e89b-12d3-a456-426614174000",
  "targetType": "invoice",
  "updatedAt": "2025-01-01T00:00:00.000Z"
}

List linked payments

Request

Returns a paginated list of Linked Payments 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""amount""currency"
sortOrderstring

Sort order

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

ISO 4217 currency code for the linked amount.

paymentIdstring

Identifier of the payment that is being linked.

Example: paymentId=123e4567-e89b-12d3-a456-426614174000
targetIdstring

Identifier of the entity this payment is linked to (e.g., invoiceId).

Example: targetId=123e4567-e89b-12d3-a456-426614174000
targetTypestring

Type of entity this payment is linked to.

Enum"invoice""creditNote""other"
curl -i -X GET \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/linked-payment?page=0&pageSize=10&sortBy=createdAt&sortOrder=asc&currency=string&paymentId=123e4567-e89b-12d3-a456-426614174000&targetId=123e4567-e89b-12d3-a456-426614174000&targetType=invoice' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Paginated list of Linked Payments

Get linked payment

Request

Returns a single Linked Payment by its unique identifier.

Security
bearer
Path
siteIdnumberrequired

Site identifier

linkedPaymentIdstringrequired

Linked Payment unique identifier (UUID)

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

Responses

Linked Payment found

Bodyapplication/json
amountstringrequired

Monetary amount of the payment applied to the target, as a decimal string.

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

Timestamp when this linked payment record was created.

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

ISO 4217 currency code for the linked amount.

extensionsobjectrequired

Vendor- or practice-specific extensions.

linkedPaymentIdstringrequired

Canonical identifier for this linked payment record.

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

Identifier of the payment that is being linked.

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

Identifier of the entity this payment is linked to (e.g., invoiceId).

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

Type of entity this payment is linked to.

Enum"invoice""creditNote""other"
updatedAtstring(date-time)required

Timestamp when this linked payment record was last updated.

Example: "2025-01-01T00:00:00.000Z"
Response
application/json
{
  "amount": "100.00",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "currency": "string",
  "extensions": {},
  "linkedPaymentId": "123e4567-e89b-12d3-a456-426614174000",
  "paymentId": "123e4567-e89b-12d3-a456-426614174000",
  "targetId": "123e4567-e89b-12d3-a456-426614174000",
  "targetType": "invoice",
  "updatedAt": "2025-01-01T00:00:00.000Z"
}

Update linked payment

Request

Partially updates an existing Linked Payment. Only provided fields will be updated.

Security
bearer
Path
siteIdnumberrequired

Site identifier

linkedPaymentIdstringrequired

Linked Payment unique identifier (UUID)

Bodyapplication/jsonrequired
amountstring

Monetary amount of the payment applied to the target, as a decimal string.

Example: "100.00"
currencystring

ISO 4217 currency code for the linked amount.

extensionsobject

Vendor- or practice-specific extensions.

paymentIdstring

Identifier of the payment that is being linked.

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

Identifier of the entity this payment is linked to (e.g., invoiceId).

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

Type of entity this payment is linked to.

Enum"invoice""creditNote""other"
curl -i -X PATCH \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/linked-payment/{linkedPaymentId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "amount": "100.00",
    "currency": "string",
    "extensions": {},
    "paymentId": "123e4567-e89b-12d3-a456-426614174000",
    "targetId": "123e4567-e89b-12d3-a456-426614174000",
    "targetType": "invoice"
  }'

Responses

Linked Payment updated successfully

Bodyapplication/json
amountstringrequired

Monetary amount of the payment applied to the target, as a decimal string.

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

Timestamp when this linked payment record was created.

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

ISO 4217 currency code for the linked amount.

extensionsobjectrequired

Vendor- or practice-specific extensions.

linkedPaymentIdstringrequired

Canonical identifier for this linked payment record.

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

Identifier of the payment that is being linked.

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

Identifier of the entity this payment is linked to (e.g., invoiceId).

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

Type of entity this payment is linked to.

Enum"invoice""creditNote""other"
updatedAtstring(date-time)required

Timestamp when this linked payment record was last updated.

Example: "2025-01-01T00:00:00.000Z"
Response
application/json
{
  "amount": "100.00",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "currency": "string",
  "extensions": {},
  "linkedPaymentId": "123e4567-e89b-12d3-a456-426614174000",
  "paymentId": "123e4567-e89b-12d3-a456-426614174000",
  "targetId": "123e4567-e89b-12d3-a456-426614174000",
  "targetType": "invoice",
  "updatedAt": "2025-01-01T00:00:00.000Z"
}

Replace linked payment

Request

Fully replaces an existing Linked Payment. All fields must be provided.

Security
bearer
Path
siteIdnumberrequired

Site identifier

linkedPaymentIdstringrequired

Linked Payment unique identifier (UUID)

Bodyapplication/jsonrequired
amountstringrequired

Monetary amount of the payment applied to the target, as a decimal string.

Example: "100.00"
currencystringrequired

ISO 4217 currency code for the linked amount.

extensionsobjectrequired

Vendor- or practice-specific extensions.

paymentIdstringrequired

Identifier of the payment that is being linked.

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

Identifier of the entity this payment is linked to (e.g., invoiceId).

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

Type of entity this payment is linked to.

Enum"invoice""creditNote""other"
curl -i -X PUT \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/linked-payment/{linkedPaymentId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "amount": "100.00",
    "currency": "string",
    "extensions": {},
    "paymentId": "123e4567-e89b-12d3-a456-426614174000",
    "targetId": "123e4567-e89b-12d3-a456-426614174000",
    "targetType": "invoice"
  }'

Responses

Linked Payment replaced successfully

Bodyapplication/json
amountstringrequired

Monetary amount of the payment applied to the target, as a decimal string.

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

Timestamp when this linked payment record was created.

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

ISO 4217 currency code for the linked amount.

extensionsobjectrequired

Vendor- or practice-specific extensions.

linkedPaymentIdstringrequired

Canonical identifier for this linked payment record.

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

Identifier of the payment that is being linked.

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

Identifier of the entity this payment is linked to (e.g., invoiceId).

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

Type of entity this payment is linked to.

Enum"invoice""creditNote""other"
updatedAtstring(date-time)required

Timestamp when this linked payment record was last updated.

Example: "2025-01-01T00:00:00.000Z"
Response
application/json
{
  "amount": "100.00",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "currency": "string",
  "extensions": {},
  "linkedPaymentId": "123e4567-e89b-12d3-a456-426614174000",
  "paymentId": "123e4567-e89b-12d3-a456-426614174000",
  "targetId": "123e4567-e89b-12d3-a456-426614174000",
  "targetType": "invoice",
  "updatedAt": "2025-01-01T00:00:00.000Z"
}

Delete linked payment

Request

Permanently deletes a Linked Payment record.

Security
bearer
Path
siteIdnumberrequired

Site identifier

linkedPaymentIdstringrequired

Linked Payment unique identifier (UUID)

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

Responses

Linked Payment deleted successfully

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