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

Location

Operations

Message

Operations

Modality

Operations

Operation

Operations

Payment

Operations

Create payment

Request

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

Security
bearer
Path
siteIdnumberrequired

Site identifier

Bodyapplication/jsonrequired
allocatedAmountstring

Total amount of the payment that has been allocated to invoices.

Example: "100.00"
amountstringrequired

Total payment amount as a decimal string.

Example: "100.00"
availableAmountstring

Unallocated portion of the payment that is still available.

Example: "100.00"
cashAmountstring

Portion of the payment that was paid in cash, if applicable.

Example: "100.00"
cashChangestring

Change returned to the client for cash payments, if applicable.

Example: "100.00"
clientIdstring

Identifier of the client associated with this payment.

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

Internal comments or notes about the payment.

currencystring

ISO 4217 currency code for the payment amount.

extensionsobject

Vendor- or practice-specific extensions.

isActivebooleanrequired

Indicates whether the payment record is active.

linkedInvoicesArray of objects(LinkedInvoiceDto)

Invoices to which this payment has been allocated.

ownershipIdstring

Identifier for the owning organization or practice.

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

Calendar date the payment was received or processed.

Example: "2025-01-01"
paymentDetailsstring

Free-text or structured details about the payment method (e.g., last 4 digits, reference number).

paymentIdstringrequired

Canonical unique identifier for the payment.

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

Method used to make the payment.

Enum"cash""card""check""bank_transfer""online""other"
roundingFactorstring

Rounding adjustment applied to the payment, if any.

Example: "100.00"
statusstringrequired

Lifecycle status of the payment.

Enum"pending""completed""cancelled""refunded""failed"
curl -i -X POST \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/payment' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "allocatedAmount": "100.00",
    "amount": "100.00",
    "availableAmount": "100.00",
    "cashAmount": "100.00",
    "cashChange": "100.00",
    "clientId": "123e4567-e89b-12d3-a456-426614174000",
    "comments": "string",
    "currency": "string",
    "extensions": {},
    "isActive": true,
    "linkedInvoices": [
      {
        "allocatedAmount": "100.00",
        "invoiceId": "123e4567-e89b-12d3-a456-426614174000"
      }
    ],
    "ownershipId": "123e4567-e89b-12d3-a456-426614174000",
    "paymentDate": "2025-01-01",
    "paymentDetails": "string",
    "paymentId": "123e4567-e89b-12d3-a456-426614174000",
    "paymentMethod": "cash",
    "roundingFactor": "100.00",
    "status": "pending"
  }'

Responses

Payment created successfully

Bodyapplication/json
allocatedAmountstringrequired

Total amount of the payment that has been allocated to invoices.

Example: "100.00"
amountstringrequired

Total payment amount as a decimal string.

Example: "100.00"
availableAmountstringrequired

Unallocated portion of the payment that is still available.

Example: "100.00"
cashAmountstringrequired

Portion of the payment that was paid in cash, if applicable.

Example: "100.00"
cashChangestringrequired

Change returned to the client for cash payments, if applicable.

Example: "100.00"
clientIdstringrequired

Identifier of the client associated with this payment.

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

Internal comments or notes about the payment.

createdAtstring(date-time)required

Timestamp when the payment record was created.

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

ISO 4217 currency code for the payment amount.

extensionsobjectrequired

Vendor- or practice-specific extensions.

isActivebooleanrequired

Indicates whether the payment record is active.

linkedInvoicesArray of objects(LinkedInvoiceDto)required

Invoices to which this payment has been allocated.

linkedInvoices[].​allocatedAmountstringrequired

Amount of this payment allocated to the invoice.

Example: "100.00"
linkedInvoices[].​invoiceIdstringrequired

Identifier of the linked invoice.

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

Identifier for the owning organization or practice.

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

Calendar date the payment was received or processed.

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

Free-text or structured details about the payment method (e.g., last 4 digits, reference number).

paymentIdstringrequired

Canonical unique identifier for the payment.

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

Method used to make the payment.

Enum"cash""card""check""bank_transfer""online""other"
roundingFactorstringrequired

Rounding adjustment applied to the payment, if any.

Example: "100.00"
statusstringrequired

Lifecycle status of the payment.

Enum"pending""completed""cancelled""refunded""failed"
updatedAtstring(date-time)required

Timestamp when the payment record was last updated.

Example: "2025-01-01T00:00:00.000Z"
Response
application/json
{
  "allocatedAmount": "100.00",
  "amount": "100.00",
  "availableAmount": "100.00",
  "cashAmount": "100.00",
  "cashChange": "100.00",
  "clientId": "123e4567-e89b-12d3-a456-426614174000",
  "comments": "string",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "currency": "string",
  "extensions": {},
  "isActive": true,
  "linkedInvoices": [
    { … }
  ],
  "ownershipId": "123e4567-e89b-12d3-a456-426614174000",
  "paymentDate": "2025-01-01T00:00:00Z",
  "paymentDetails": "string",
  "paymentId": "123e4567-e89b-12d3-a456-426614174000",
  "paymentMethod": "cash",
  "roundingFactor": "100.00",
  "status": "pending",
  "updatedAt": "2025-01-01T00:00:00.000Z"
}

List payments

Request

Returns a paginated list of 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""allocatedAmount""amount""availableAmount""cashAmount""cashChange""comments""currency""paymentDate"
sortOrderstring

Sort order

Default "asc"
Enum"asc""desc"
clientIdstring

Identifier of the client associated with this payment.

Example: clientId=123e4567-e89b-12d3-a456-426614174000
commentsstring

Internal comments or notes about the payment.

currencystring

ISO 4217 currency code for the payment amount.

isActiveboolean

Indicates whether the payment record is active.

ownershipIdstring

Identifier for the owning organization or practice.

Example: ownershipId=123e4567-e89b-12d3-a456-426614174000
paymentDetailsstring

Free-text or structured details about the payment method (e.g., last 4 digits, reference number).

paymentMethodstring

Method used to make the payment.

Enum"cash""card""check""bank_transfer""online""other"
statusstring

Lifecycle status of the payment.

Enum"pending""completed""cancelled""refunded""failed"
curl -i -X GET \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/payment?page=0&pageSize=10&sortBy=createdAt&sortOrder=asc&clientId=123e4567-e89b-12d3-a456-426614174000&comments=string&currency=string&isActive=true&ownershipId=123e4567-e89b-12d3-a456-426614174000&paymentDetails=string&paymentMethod=cash&status=pending' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Paginated list of Payments

Get payment

Request

Returns a single Payment by its unique identifier.

Security
bearer
Path
siteIdnumberrequired

Site identifier

paymentIdstringrequired

Payment unique identifier (UUID)

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

Responses

Payment found

Bodyapplication/json
allocatedAmountstringrequired

Total amount of the payment that has been allocated to invoices.

Example: "100.00"
amountstringrequired

Total payment amount as a decimal string.

Example: "100.00"
availableAmountstringrequired

Unallocated portion of the payment that is still available.

Example: "100.00"
cashAmountstringrequired

Portion of the payment that was paid in cash, if applicable.

Example: "100.00"
cashChangestringrequired

Change returned to the client for cash payments, if applicable.

Example: "100.00"
clientIdstringrequired

Identifier of the client associated with this payment.

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

Internal comments or notes about the payment.

createdAtstring(date-time)required

Timestamp when the payment record was created.

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

ISO 4217 currency code for the payment amount.

extensionsobjectrequired

Vendor- or practice-specific extensions.

isActivebooleanrequired

Indicates whether the payment record is active.

linkedInvoicesArray of objects(LinkedInvoiceDto)required

Invoices to which this payment has been allocated.

linkedInvoices[].​allocatedAmountstringrequired

Amount of this payment allocated to the invoice.

Example: "100.00"
linkedInvoices[].​invoiceIdstringrequired

Identifier of the linked invoice.

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

Identifier for the owning organization or practice.

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

Calendar date the payment was received or processed.

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

Free-text or structured details about the payment method (e.g., last 4 digits, reference number).

paymentIdstringrequired

Canonical unique identifier for the payment.

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

Method used to make the payment.

Enum"cash""card""check""bank_transfer""online""other"
roundingFactorstringrequired

Rounding adjustment applied to the payment, if any.

Example: "100.00"
statusstringrequired

Lifecycle status of the payment.

Enum"pending""completed""cancelled""refunded""failed"
updatedAtstring(date-time)required

Timestamp when the payment record was last updated.

Example: "2025-01-01T00:00:00.000Z"
Response
application/json
{
  "allocatedAmount": "100.00",
  "amount": "100.00",
  "availableAmount": "100.00",
  "cashAmount": "100.00",
  "cashChange": "100.00",
  "clientId": "123e4567-e89b-12d3-a456-426614174000",
  "comments": "string",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "currency": "string",
  "extensions": {},
  "isActive": true,
  "linkedInvoices": [
    { … }
  ],
  "ownershipId": "123e4567-e89b-12d3-a456-426614174000",
  "paymentDate": "2025-01-01T00:00:00Z",
  "paymentDetails": "string",
  "paymentId": "123e4567-e89b-12d3-a456-426614174000",
  "paymentMethod": "cash",
  "roundingFactor": "100.00",
  "status": "pending",
  "updatedAt": "2025-01-01T00:00:00.000Z"
}

Update payment

Request

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

Security
bearer
Path
siteIdnumberrequired

Site identifier

paymentIdstringrequired

Payment unique identifier (UUID)

Bodyapplication/jsonrequired
allocatedAmountstring

Total amount of the payment that has been allocated to invoices.

Example: "100.00"
amountstring

Total payment amount as a decimal string.

Example: "100.00"
availableAmountstring

Unallocated portion of the payment that is still available.

Example: "100.00"
cashAmountstring

Portion of the payment that was paid in cash, if applicable.

Example: "100.00"
cashChangestring

Change returned to the client for cash payments, if applicable.

Example: "100.00"
clientIdstring

Identifier of the client associated with this payment.

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

Internal comments or notes about the payment.

currencystring

ISO 4217 currency code for the payment amount.

extensionsobject

Vendor- or practice-specific extensions.

isActiveboolean

Indicates whether the payment record is active.

linkedInvoicesArray of objects(LinkedInvoiceDto)

Invoices to which this payment has been allocated.

ownershipIdstring

Identifier for the owning organization or practice.

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

Calendar date the payment was received or processed.

Example: "2025-01-01"
paymentDetailsstring

Free-text or structured details about the payment method (e.g., last 4 digits, reference number).

paymentMethodstring

Method used to make the payment.

Enum"cash""card""check""bank_transfer""online""other"
roundingFactorstring

Rounding adjustment applied to the payment, if any.

Example: "100.00"
statusstring

Lifecycle status of the payment.

Enum"pending""completed""cancelled""refunded""failed"
curl -i -X PATCH \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/payment/{paymentId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "allocatedAmount": "100.00",
    "amount": "100.00",
    "availableAmount": "100.00",
    "cashAmount": "100.00",
    "cashChange": "100.00",
    "clientId": "123e4567-e89b-12d3-a456-426614174000",
    "comments": "string",
    "currency": "string",
    "extensions": {},
    "isActive": true,
    "linkedInvoices": [
      {
        "allocatedAmount": "100.00",
        "invoiceId": "123e4567-e89b-12d3-a456-426614174000"
      }
    ],
    "ownershipId": "123e4567-e89b-12d3-a456-426614174000",
    "paymentDate": "2025-01-01",
    "paymentDetails": "string",
    "paymentMethod": "cash",
    "roundingFactor": "100.00",
    "status": "pending"
  }'

Responses

Payment updated successfully

Bodyapplication/json
allocatedAmountstringrequired

Total amount of the payment that has been allocated to invoices.

Example: "100.00"
amountstringrequired

Total payment amount as a decimal string.

Example: "100.00"
availableAmountstringrequired

Unallocated portion of the payment that is still available.

Example: "100.00"
cashAmountstringrequired

Portion of the payment that was paid in cash, if applicable.

Example: "100.00"
cashChangestringrequired

Change returned to the client for cash payments, if applicable.

Example: "100.00"
clientIdstringrequired

Identifier of the client associated with this payment.

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

Internal comments or notes about the payment.

createdAtstring(date-time)required

Timestamp when the payment record was created.

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

ISO 4217 currency code for the payment amount.

extensionsobjectrequired

Vendor- or practice-specific extensions.

isActivebooleanrequired

Indicates whether the payment record is active.

linkedInvoicesArray of objects(LinkedInvoiceDto)required

Invoices to which this payment has been allocated.

linkedInvoices[].​allocatedAmountstringrequired

Amount of this payment allocated to the invoice.

Example: "100.00"
linkedInvoices[].​invoiceIdstringrequired

Identifier of the linked invoice.

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

Identifier for the owning organization or practice.

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

Calendar date the payment was received or processed.

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

Free-text or structured details about the payment method (e.g., last 4 digits, reference number).

paymentIdstringrequired

Canonical unique identifier for the payment.

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

Method used to make the payment.

Enum"cash""card""check""bank_transfer""online""other"
roundingFactorstringrequired

Rounding adjustment applied to the payment, if any.

Example: "100.00"
statusstringrequired

Lifecycle status of the payment.

Enum"pending""completed""cancelled""refunded""failed"
updatedAtstring(date-time)required

Timestamp when the payment record was last updated.

Example: "2025-01-01T00:00:00.000Z"
Response
application/json
{
  "allocatedAmount": "100.00",
  "amount": "100.00",
  "availableAmount": "100.00",
  "cashAmount": "100.00",
  "cashChange": "100.00",
  "clientId": "123e4567-e89b-12d3-a456-426614174000",
  "comments": "string",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "currency": "string",
  "extensions": {},
  "isActive": true,
  "linkedInvoices": [
    { … }
  ],
  "ownershipId": "123e4567-e89b-12d3-a456-426614174000",
  "paymentDate": "2025-01-01T00:00:00Z",
  "paymentDetails": "string",
  "paymentId": "123e4567-e89b-12d3-a456-426614174000",
  "paymentMethod": "cash",
  "roundingFactor": "100.00",
  "status": "pending",
  "updatedAt": "2025-01-01T00:00:00.000Z"
}

Replace payment

Request

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

Security
bearer
Path
siteIdnumberrequired

Site identifier

paymentIdstringrequired

Payment unique identifier (UUID)

Bodyapplication/jsonrequired
allocatedAmountstringrequired

Total amount of the payment that has been allocated to invoices.

Example: "100.00"
amountstringrequired

Total payment amount as a decimal string.

Example: "100.00"
availableAmountstringrequired

Unallocated portion of the payment that is still available.

Example: "100.00"
cashAmountstringrequired

Portion of the payment that was paid in cash, if applicable.

Example: "100.00"
cashChangestringrequired

Change returned to the client for cash payments, if applicable.

Example: "100.00"
clientIdstringrequired

Identifier of the client associated with this payment.

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

Internal comments or notes about the payment.

currencystringrequired

ISO 4217 currency code for the payment amount.

extensionsobjectrequired

Vendor- or practice-specific extensions.

isActivebooleanrequired

Indicates whether the payment record is active.

linkedInvoicesArray of objects(LinkedInvoiceDto)required

Invoices to which this payment has been allocated.

linkedInvoices[].​allocatedAmountstringrequired

Amount of this payment allocated to the invoice.

Example: "100.00"
linkedInvoices[].​invoiceIdstringrequired

Identifier of the linked invoice.

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

Identifier for the owning organization or practice.

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

Calendar date the payment was received or processed.

Example: "2025-01-01"
paymentDetailsstringrequired

Free-text or structured details about the payment method (e.g., last 4 digits, reference number).

paymentMethodstringrequired

Method used to make the payment.

Enum"cash""card""check""bank_transfer""online""other"
roundingFactorstringrequired

Rounding adjustment applied to the payment, if any.

Example: "100.00"
statusstringrequired

Lifecycle status of the payment.

Enum"pending""completed""cancelled""refunded""failed"
curl -i -X PUT \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/payment/{paymentId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "allocatedAmount": "100.00",
    "amount": "100.00",
    "availableAmount": "100.00",
    "cashAmount": "100.00",
    "cashChange": "100.00",
    "clientId": "123e4567-e89b-12d3-a456-426614174000",
    "comments": "string",
    "currency": "string",
    "extensions": {},
    "isActive": true,
    "linkedInvoices": [
      {
        "allocatedAmount": "100.00",
        "invoiceId": "123e4567-e89b-12d3-a456-426614174000"
      }
    ],
    "ownershipId": "123e4567-e89b-12d3-a456-426614174000",
    "paymentDate": "2025-01-01",
    "paymentDetails": "string",
    "paymentMethod": "cash",
    "roundingFactor": "100.00",
    "status": "pending"
  }'

Responses

Payment replaced successfully

Bodyapplication/json
allocatedAmountstringrequired

Total amount of the payment that has been allocated to invoices.

Example: "100.00"
amountstringrequired

Total payment amount as a decimal string.

Example: "100.00"
availableAmountstringrequired

Unallocated portion of the payment that is still available.

Example: "100.00"
cashAmountstringrequired

Portion of the payment that was paid in cash, if applicable.

Example: "100.00"
cashChangestringrequired

Change returned to the client for cash payments, if applicable.

Example: "100.00"
clientIdstringrequired

Identifier of the client associated with this payment.

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

Internal comments or notes about the payment.

createdAtstring(date-time)required

Timestamp when the payment record was created.

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

ISO 4217 currency code for the payment amount.

extensionsobjectrequired

Vendor- or practice-specific extensions.

isActivebooleanrequired

Indicates whether the payment record is active.

linkedInvoicesArray of objects(LinkedInvoiceDto)required

Invoices to which this payment has been allocated.

linkedInvoices[].​allocatedAmountstringrequired

Amount of this payment allocated to the invoice.

Example: "100.00"
linkedInvoices[].​invoiceIdstringrequired

Identifier of the linked invoice.

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

Identifier for the owning organization or practice.

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

Calendar date the payment was received or processed.

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

Free-text or structured details about the payment method (e.g., last 4 digits, reference number).

paymentIdstringrequired

Canonical unique identifier for the payment.

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

Method used to make the payment.

Enum"cash""card""check""bank_transfer""online""other"
roundingFactorstringrequired

Rounding adjustment applied to the payment, if any.

Example: "100.00"
statusstringrequired

Lifecycle status of the payment.

Enum"pending""completed""cancelled""refunded""failed"
updatedAtstring(date-time)required

Timestamp when the payment record was last updated.

Example: "2025-01-01T00:00:00.000Z"
Response
application/json
{
  "allocatedAmount": "100.00",
  "amount": "100.00",
  "availableAmount": "100.00",
  "cashAmount": "100.00",
  "cashChange": "100.00",
  "clientId": "123e4567-e89b-12d3-a456-426614174000",
  "comments": "string",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "currency": "string",
  "extensions": {},
  "isActive": true,
  "linkedInvoices": [
    { … }
  ],
  "ownershipId": "123e4567-e89b-12d3-a456-426614174000",
  "paymentDate": "2025-01-01T00:00:00Z",
  "paymentDetails": "string",
  "paymentId": "123e4567-e89b-12d3-a456-426614174000",
  "paymentMethod": "cash",
  "roundingFactor": "100.00",
  "status": "pending",
  "updatedAt": "2025-01-01T00:00:00.000Z"
}

Delete payment

Request

Permanently deletes a Payment record.

Security
bearer
Path
siteIdnumberrequired

Site identifier

paymentIdstringrequired

Payment unique identifier (UUID)

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

Responses

Payment deleted successfully

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