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

Paymentmethod

Operations

Physical Exam

Operations

Plan

Operations

Practitioner

Operations

Prescription

Operations

Prescription Item

Operations

Presentingproblem

Operations

Price Adjustment

Operations

Create price adjustment

Request

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

Security
bearer
Path
siteIdnumberrequired

Site identifier

Bodyapplication/jsonrequired
adjustmentAmountstringrequired

Base adjustment amount as a decimal string (may represent fixed amount or percentage depending on method).

adjustmentMethodstringrequired

Method used to calculate the adjustment (e.g., fixed amount, percentage).

adjustmentTypestringrequired

High-level type of price adjustment.

Enum"user""credit""rounding""discount""surcharge"
associatedResourceIdstring

Identifier of the resource this adjustment is associated with.

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

Type of resource this adjustment is associated with (e.g., invoice, invoiceLine, estimate).

descriptionstring

Human-readable description of the price adjustment.

extensionsobject

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether this price adjustment is currently active.

isConsumingboolean

Whether this adjustment consumes a benefit or credit balance.

priceAdjustmentIdstringrequired

Canonical identifier for the price adjustment.

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

Total change in amount (excluding tax) caused by this adjustment, as a decimal string.

totalChangeTaxstring

Total change in tax amount caused by this adjustment, as a decimal string.

totalEarnedstring

Total amount earned (excluding tax) as a result of this adjustment, as a decimal string.

totalEarnedTaxstring

Total tax amount earned as a result of this adjustment, as a decimal string.

triggeringResourceIdstring

Identifier of the resource that triggered this adjustment, if applicable.

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

Type of resource that triggered this adjustment, if applicable.

wellnessPlanBenefitIdstring or null

Associated wellness plan benefit, if applicable.

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

Associated wellness plan, if applicable.

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

Associated wellness plan membership, if applicable.

Example: "123e4567-e89b-12d3-a456-426614174000"
curl -i -X POST \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/price-adjustment' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "adjustmentAmount": "string",
    "adjustmentMethod": "string",
    "adjustmentType": "user",
    "associatedResourceId": "123e4567-e89b-12d3-a456-426614174000",
    "associatedResourceType": "string",
    "description": "string",
    "extensions": {},
    "isActive": true,
    "isConsuming": true,
    "priceAdjustmentId": "123e4567-e89b-12d3-a456-426614174000",
    "totalChange": "string",
    "totalChangeTax": "string",
    "totalEarned": "string",
    "totalEarnedTax": "string",
    "triggeringResourceId": "123e4567-e89b-12d3-a456-426614174000",
    "triggeringResourceType": "string",
    "wellnessPlanBenefitId": "123e4567-e89b-12d3-a456-426614174000",
    "wellnessPlanId": "123e4567-e89b-12d3-a456-426614174000",
    "wellnessPlanMembershipId": "123e4567-e89b-12d3-a456-426614174000"
  }'

Responses

Price Adjustment created successfully

Bodyapplication/json
adjustmentAmountstringrequired

Base adjustment amount as a decimal string (may represent fixed amount or percentage depending on method).

adjustmentMethodstringrequired

Method used to calculate the adjustment (e.g., fixed amount, percentage).

adjustmentTypestringrequired

High-level type of price adjustment.

Enum"user""credit""rounding""discount""surcharge"
associatedResourceIdstringrequired

Identifier of the resource this adjustment is associated with.

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

Type of resource this adjustment is associated with (e.g., invoice, invoiceLine, estimate).

createdAtstring(date-time)required

Timestamp when the price adjustment was created.

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

Human-readable description of the price adjustment.

extensionsobjectrequired

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether this price adjustment is currently active.

isConsumingbooleanrequired

Whether this adjustment consumes a benefit or credit balance.

priceAdjustmentIdstringrequired

Canonical identifier for the price adjustment.

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

Total change in amount (excluding tax) caused by this adjustment, as a decimal string.

totalChangeTaxstringrequired

Total change in tax amount caused by this adjustment, as a decimal string.

totalEarnedstringrequired

Total amount earned (excluding tax) as a result of this adjustment, as a decimal string.

totalEarnedTaxstringrequired

Total tax amount earned as a result of this adjustment, as a decimal string.

triggeringResourceIdstringrequired

Identifier of the resource that triggered this adjustment, if applicable.

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

Type of resource that triggered this adjustment, if applicable.

updatedAtstring(date-time)required

Timestamp when the price adjustment was last updated.

Example: "2025-01-01T00:00:00.000Z"
wellnessPlanBenefitIdstring or nullrequired

Associated wellness plan benefit, if applicable.

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

Associated wellness plan, if applicable.

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

Associated wellness plan membership, if applicable.

Example: "123e4567-e89b-12d3-a456-426614174000"
Response
application/json
{
  "adjustmentAmount": "string",
  "adjustmentMethod": "string",
  "adjustmentType": "user",
  "associatedResourceId": "123e4567-e89b-12d3-a456-426614174000",
  "associatedResourceType": "string",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "description": "string",
  "extensions": {},
  "isActive": true,
  "isConsuming": true,
  "priceAdjustmentId": "123e4567-e89b-12d3-a456-426614174000",
  "totalChange": "string",
  "totalChangeTax": "string",
  "totalEarned": "string",
  "totalEarnedTax": "string",
  "triggeringResourceId": "123e4567-e89b-12d3-a456-426614174000",
  "triggeringResourceType": "string",
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "wellnessPlanBenefitId": "123e4567-e89b-12d3-a456-426614174000",
  "wellnessPlanId": "123e4567-e89b-12d3-a456-426614174000",
  "wellnessPlanMembershipId": "123e4567-e89b-12d3-a456-426614174000"
}

List price adjustments

Request

Returns a paginated list of Price Adjustments 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""adjustmentAmount""adjustmentMethod""associatedResourceType""description""totalChange""totalChangeTax""totalEarned""totalEarnedTax"
sortOrderstring

Sort order

Default "asc"
Enum"asc""desc"
adjustmentAmountstring

Base adjustment amount as a decimal string (may represent fixed amount or percentage depending on method).

adjustmentMethodstring

Method used to calculate the adjustment (e.g., fixed amount, percentage).

adjustmentTypestring

High-level type of price adjustment.

Enum"user""credit""rounding""discount""surcharge"
associatedResourceIdstring

Identifier of the resource this adjustment is associated with.

Example: associatedResourceId=123e4567-e89b-12d3-a456-426614174000
associatedResourceTypestring

Type of resource this adjustment is associated with (e.g., invoice, invoiceLine, estimate).

descriptionstring

Human-readable description of the price adjustment.

isActiveboolean

Whether this price adjustment is currently active.

isConsumingboolean

Whether this adjustment consumes a benefit or credit balance.

totalChangestring

Total change in amount (excluding tax) caused by this adjustment, as a decimal string.

totalChangeTaxstring

Total change in tax amount caused by this adjustment, as a decimal string.

totalEarnedstring

Total amount earned (excluding tax) as a result of this adjustment, as a decimal string.

totalEarnedTaxstring

Total tax amount earned as a result of this adjustment, as a decimal string.

triggeringResourceIdstring

Identifier of the resource that triggered this adjustment, if applicable.

Example: triggeringResourceId=123e4567-e89b-12d3-a456-426614174000
triggeringResourceTypestring

Type of resource that triggered this adjustment, if applicable.

wellnessPlanBenefitIdstring

Associated wellness plan benefit, if applicable.

Example: wellnessPlanBenefitId=123e4567-e89b-12d3-a456-426614174000
wellnessPlanIdstring

Associated wellness plan, if applicable.

Example: wellnessPlanId=123e4567-e89b-12d3-a456-426614174000
wellnessPlanMembershipIdstring

Associated wellness plan membership, if applicable.

Example: wellnessPlanMembershipId=123e4567-e89b-12d3-a456-426614174000
curl -i -X GET \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/price-adjustment?page=0&pageSize=10&sortBy=createdAt&sortOrder=asc&adjustmentAmount=string&adjustmentMethod=string&adjustmentType=user&associatedResourceId=123e4567-e89b-12d3-a456-426614174000&associatedResourceType=string&description=string&isActive=true&isConsuming=true&totalChange=string&totalChangeTax=string&totalEarned=string&totalEarnedTax=string&triggeringResourceId=123e4567-e89b-12d3-a456-426614174000&triggeringResourceType=string&wellnessPlanBenefitId=123e4567-e89b-12d3-a456-426614174000&wellnessPlanId=123e4567-e89b-12d3-a456-426614174000&wellnessPlanMembershipId=123e4567-e89b-12d3-a456-426614174000' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Paginated list of Price Adjustments

Get price adjustment

Request

Returns a single Price Adjustment by its unique identifier.

Security
bearer
Path
siteIdnumberrequired

Site identifier

priceAdjustmentIdstringrequired

Price Adjustment unique identifier (UUID)

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

Responses

Price Adjustment found

Bodyapplication/json
adjustmentAmountstringrequired

Base adjustment amount as a decimal string (may represent fixed amount or percentage depending on method).

adjustmentMethodstringrequired

Method used to calculate the adjustment (e.g., fixed amount, percentage).

adjustmentTypestringrequired

High-level type of price adjustment.

Enum"user""credit""rounding""discount""surcharge"
associatedResourceIdstringrequired

Identifier of the resource this adjustment is associated with.

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

Type of resource this adjustment is associated with (e.g., invoice, invoiceLine, estimate).

createdAtstring(date-time)required

Timestamp when the price adjustment was created.

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

Human-readable description of the price adjustment.

extensionsobjectrequired

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether this price adjustment is currently active.

isConsumingbooleanrequired

Whether this adjustment consumes a benefit or credit balance.

priceAdjustmentIdstringrequired

Canonical identifier for the price adjustment.

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

Total change in amount (excluding tax) caused by this adjustment, as a decimal string.

totalChangeTaxstringrequired

Total change in tax amount caused by this adjustment, as a decimal string.

totalEarnedstringrequired

Total amount earned (excluding tax) as a result of this adjustment, as a decimal string.

totalEarnedTaxstringrequired

Total tax amount earned as a result of this adjustment, as a decimal string.

triggeringResourceIdstringrequired

Identifier of the resource that triggered this adjustment, if applicable.

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

Type of resource that triggered this adjustment, if applicable.

updatedAtstring(date-time)required

Timestamp when the price adjustment was last updated.

Example: "2025-01-01T00:00:00.000Z"
wellnessPlanBenefitIdstring or nullrequired

Associated wellness plan benefit, if applicable.

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

Associated wellness plan, if applicable.

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

Associated wellness plan membership, if applicable.

Example: "123e4567-e89b-12d3-a456-426614174000"
Response
application/json
{
  "adjustmentAmount": "string",
  "adjustmentMethod": "string",
  "adjustmentType": "user",
  "associatedResourceId": "123e4567-e89b-12d3-a456-426614174000",
  "associatedResourceType": "string",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "description": "string",
  "extensions": {},
  "isActive": true,
  "isConsuming": true,
  "priceAdjustmentId": "123e4567-e89b-12d3-a456-426614174000",
  "totalChange": "string",
  "totalChangeTax": "string",
  "totalEarned": "string",
  "totalEarnedTax": "string",
  "triggeringResourceId": "123e4567-e89b-12d3-a456-426614174000",
  "triggeringResourceType": "string",
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "wellnessPlanBenefitId": "123e4567-e89b-12d3-a456-426614174000",
  "wellnessPlanId": "123e4567-e89b-12d3-a456-426614174000",
  "wellnessPlanMembershipId": "123e4567-e89b-12d3-a456-426614174000"
}

Update price adjustment

Request

Partially updates an existing Price Adjustment. Only provided fields will be updated.

Security
bearer
Path
siteIdnumberrequired

Site identifier

priceAdjustmentIdstringrequired

Price Adjustment unique identifier (UUID)

Bodyapplication/jsonrequired
adjustmentAmountstring

Base adjustment amount as a decimal string (may represent fixed amount or percentage depending on method).

adjustmentMethodstring

Method used to calculate the adjustment (e.g., fixed amount, percentage).

adjustmentTypestring

High-level type of price adjustment.

Enum"user""credit""rounding""discount""surcharge"
associatedResourceIdstring

Identifier of the resource this adjustment is associated with.

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

Type of resource this adjustment is associated with (e.g., invoice, invoiceLine, estimate).

descriptionstring

Human-readable description of the price adjustment.

extensionsobject

Vendor- or practice-specific extensions.

isActiveboolean

Whether this price adjustment is currently active.

isConsumingboolean

Whether this adjustment consumes a benefit or credit balance.

totalChangestring

Total change in amount (excluding tax) caused by this adjustment, as a decimal string.

totalChangeTaxstring

Total change in tax amount caused by this adjustment, as a decimal string.

totalEarnedstring

Total amount earned (excluding tax) as a result of this adjustment, as a decimal string.

totalEarnedTaxstring

Total tax amount earned as a result of this adjustment, as a decimal string.

triggeringResourceIdstring

Identifier of the resource that triggered this adjustment, if applicable.

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

Type of resource that triggered this adjustment, if applicable.

wellnessPlanBenefitIdstring or null

Associated wellness plan benefit, if applicable.

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

Associated wellness plan, if applicable.

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

Associated wellness plan membership, if applicable.

Example: "123e4567-e89b-12d3-a456-426614174000"
curl -i -X PATCH \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/price-adjustment/{priceAdjustmentId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "adjustmentAmount": "string",
    "adjustmentMethod": "string",
    "adjustmentType": "user",
    "associatedResourceId": "123e4567-e89b-12d3-a456-426614174000",
    "associatedResourceType": "string",
    "description": "string",
    "extensions": {},
    "isActive": true,
    "isConsuming": true,
    "totalChange": "string",
    "totalChangeTax": "string",
    "totalEarned": "string",
    "totalEarnedTax": "string",
    "triggeringResourceId": "123e4567-e89b-12d3-a456-426614174000",
    "triggeringResourceType": "string",
    "wellnessPlanBenefitId": "123e4567-e89b-12d3-a456-426614174000",
    "wellnessPlanId": "123e4567-e89b-12d3-a456-426614174000",
    "wellnessPlanMembershipId": "123e4567-e89b-12d3-a456-426614174000"
  }'

Responses

Price Adjustment updated successfully

Bodyapplication/json
adjustmentAmountstringrequired

Base adjustment amount as a decimal string (may represent fixed amount or percentage depending on method).

adjustmentMethodstringrequired

Method used to calculate the adjustment (e.g., fixed amount, percentage).

adjustmentTypestringrequired

High-level type of price adjustment.

Enum"user""credit""rounding""discount""surcharge"
associatedResourceIdstringrequired

Identifier of the resource this adjustment is associated with.

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

Type of resource this adjustment is associated with (e.g., invoice, invoiceLine, estimate).

createdAtstring(date-time)required

Timestamp when the price adjustment was created.

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

Human-readable description of the price adjustment.

extensionsobjectrequired

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether this price adjustment is currently active.

isConsumingbooleanrequired

Whether this adjustment consumes a benefit or credit balance.

priceAdjustmentIdstringrequired

Canonical identifier for the price adjustment.

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

Total change in amount (excluding tax) caused by this adjustment, as a decimal string.

totalChangeTaxstringrequired

Total change in tax amount caused by this adjustment, as a decimal string.

totalEarnedstringrequired

Total amount earned (excluding tax) as a result of this adjustment, as a decimal string.

totalEarnedTaxstringrequired

Total tax amount earned as a result of this adjustment, as a decimal string.

triggeringResourceIdstringrequired

Identifier of the resource that triggered this adjustment, if applicable.

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

Type of resource that triggered this adjustment, if applicable.

updatedAtstring(date-time)required

Timestamp when the price adjustment was last updated.

Example: "2025-01-01T00:00:00.000Z"
wellnessPlanBenefitIdstring or nullrequired

Associated wellness plan benefit, if applicable.

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

Associated wellness plan, if applicable.

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

Associated wellness plan membership, if applicable.

Example: "123e4567-e89b-12d3-a456-426614174000"
Response
application/json
{
  "adjustmentAmount": "string",
  "adjustmentMethod": "string",
  "adjustmentType": "user",
  "associatedResourceId": "123e4567-e89b-12d3-a456-426614174000",
  "associatedResourceType": "string",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "description": "string",
  "extensions": {},
  "isActive": true,
  "isConsuming": true,
  "priceAdjustmentId": "123e4567-e89b-12d3-a456-426614174000",
  "totalChange": "string",
  "totalChangeTax": "string",
  "totalEarned": "string",
  "totalEarnedTax": "string",
  "triggeringResourceId": "123e4567-e89b-12d3-a456-426614174000",
  "triggeringResourceType": "string",
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "wellnessPlanBenefitId": "123e4567-e89b-12d3-a456-426614174000",
  "wellnessPlanId": "123e4567-e89b-12d3-a456-426614174000",
  "wellnessPlanMembershipId": "123e4567-e89b-12d3-a456-426614174000"
}

Replace price adjustment

Request

Fully replaces an existing Price Adjustment. All fields must be provided.

Security
bearer
Path
siteIdnumberrequired

Site identifier

priceAdjustmentIdstringrequired

Price Adjustment unique identifier (UUID)

Bodyapplication/jsonrequired
adjustmentAmountstringrequired

Base adjustment amount as a decimal string (may represent fixed amount or percentage depending on method).

adjustmentMethodstringrequired

Method used to calculate the adjustment (e.g., fixed amount, percentage).

adjustmentTypestringrequired

High-level type of price adjustment.

Enum"user""credit""rounding""discount""surcharge"
associatedResourceIdstringrequired

Identifier of the resource this adjustment is associated with.

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

Type of resource this adjustment is associated with (e.g., invoice, invoiceLine, estimate).

descriptionstringrequired

Human-readable description of the price adjustment.

extensionsobjectrequired

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether this price adjustment is currently active.

isConsumingbooleanrequired

Whether this adjustment consumes a benefit or credit balance.

totalChangestringrequired

Total change in amount (excluding tax) caused by this adjustment, as a decimal string.

totalChangeTaxstringrequired

Total change in tax amount caused by this adjustment, as a decimal string.

totalEarnedstringrequired

Total amount earned (excluding tax) as a result of this adjustment, as a decimal string.

totalEarnedTaxstringrequired

Total tax amount earned as a result of this adjustment, as a decimal string.

triggeringResourceIdstringrequired

Identifier of the resource that triggered this adjustment, if applicable.

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

Type of resource that triggered this adjustment, if applicable.

wellnessPlanBenefitIdstring or null

Associated wellness plan benefit, if applicable.

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

Associated wellness plan, if applicable.

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

Associated wellness plan membership, if applicable.

Example: "123e4567-e89b-12d3-a456-426614174000"
curl -i -X PUT \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/price-adjustment/{priceAdjustmentId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "adjustmentAmount": "string",
    "adjustmentMethod": "string",
    "adjustmentType": "user",
    "associatedResourceId": "123e4567-e89b-12d3-a456-426614174000",
    "associatedResourceType": "string",
    "description": "string",
    "extensions": {},
    "isActive": true,
    "isConsuming": true,
    "totalChange": "string",
    "totalChangeTax": "string",
    "totalEarned": "string",
    "totalEarnedTax": "string",
    "triggeringResourceId": "123e4567-e89b-12d3-a456-426614174000",
    "triggeringResourceType": "string",
    "wellnessPlanBenefitId": "123e4567-e89b-12d3-a456-426614174000",
    "wellnessPlanId": "123e4567-e89b-12d3-a456-426614174000",
    "wellnessPlanMembershipId": "123e4567-e89b-12d3-a456-426614174000"
  }'

Responses

Price Adjustment replaced successfully

Bodyapplication/json
adjustmentAmountstringrequired

Base adjustment amount as a decimal string (may represent fixed amount or percentage depending on method).

adjustmentMethodstringrequired

Method used to calculate the adjustment (e.g., fixed amount, percentage).

adjustmentTypestringrequired

High-level type of price adjustment.

Enum"user""credit""rounding""discount""surcharge"
associatedResourceIdstringrequired

Identifier of the resource this adjustment is associated with.

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

Type of resource this adjustment is associated with (e.g., invoice, invoiceLine, estimate).

createdAtstring(date-time)required

Timestamp when the price adjustment was created.

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

Human-readable description of the price adjustment.

extensionsobjectrequired

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether this price adjustment is currently active.

isConsumingbooleanrequired

Whether this adjustment consumes a benefit or credit balance.

priceAdjustmentIdstringrequired

Canonical identifier for the price adjustment.

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

Total change in amount (excluding tax) caused by this adjustment, as a decimal string.

totalChangeTaxstringrequired

Total change in tax amount caused by this adjustment, as a decimal string.

totalEarnedstringrequired

Total amount earned (excluding tax) as a result of this adjustment, as a decimal string.

totalEarnedTaxstringrequired

Total tax amount earned as a result of this adjustment, as a decimal string.

triggeringResourceIdstringrequired

Identifier of the resource that triggered this adjustment, if applicable.

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

Type of resource that triggered this adjustment, if applicable.

updatedAtstring(date-time)required

Timestamp when the price adjustment was last updated.

Example: "2025-01-01T00:00:00.000Z"
wellnessPlanBenefitIdstring or nullrequired

Associated wellness plan benefit, if applicable.

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

Associated wellness plan, if applicable.

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

Associated wellness plan membership, if applicable.

Example: "123e4567-e89b-12d3-a456-426614174000"
Response
application/json
{
  "adjustmentAmount": "string",
  "adjustmentMethod": "string",
  "adjustmentType": "user",
  "associatedResourceId": "123e4567-e89b-12d3-a456-426614174000",
  "associatedResourceType": "string",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "description": "string",
  "extensions": {},
  "isActive": true,
  "isConsuming": true,
  "priceAdjustmentId": "123e4567-e89b-12d3-a456-426614174000",
  "totalChange": "string",
  "totalChangeTax": "string",
  "totalEarned": "string",
  "totalEarnedTax": "string",
  "triggeringResourceId": "123e4567-e89b-12d3-a456-426614174000",
  "triggeringResourceType": "string",
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "wellnessPlanBenefitId": "123e4567-e89b-12d3-a456-426614174000",
  "wellnessPlanId": "123e4567-e89b-12d3-a456-426614174000",
  "wellnessPlanMembershipId": "123e4567-e89b-12d3-a456-426614174000"
}

Delete price adjustment

Request

Permanently deletes a Price Adjustment record.

Security
bearer
Path
siteIdnumberrequired

Site identifier

priceAdjustmentIdstringrequired

Price Adjustment unique identifier (UUID)

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

Responses

Price Adjustment deleted successfully

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