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

Create billing credit

Request

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

Security
bearer
Path
siteIdnumberrequired

Site identifier

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.

billingCreditIdstringrequired

Canonical identifier for the billing credit.

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

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

Enum"quantity""value"
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.

isActivebooleanrequired

Whether this billing credit is currently active and usable.

remainingAmountnumber

Quantity or monetary amount still available for use.

startDatestring

Date from which the credit becomes valid.

Example: "2025-01-01"
totalAmountnumberrequired

Total quantity or monetary amount originally granted for this credit.

usedAmountnumber

Quantity or monetary amount that has been used.

wastedAmountnumber

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

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 POST \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/billing-credit' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "appliedTo": {},
    "availableTo": {},
    "billingCreditId": "123e4567-e89b-12d3-a456-426614174000",
    "creditType": "quantity",
    "endDate": "2025-01-01",
    "expiry": {},
    "extensions": {},
    "isActive": true,
    "remainingAmount": 0,
    "startDate": "2025-01-01",
    "totalAmount": 0,
    "usedAmount": 0,
    "wastedAmount": 0,
    "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": "string",
      "system": "string",
      "display": "string"
    },
    "creditCategory": {
      "code": "string",
      "system": "string",
      "display": "string"
    },
    "currency": {
      "code": "string",
      "system": "string",
      "display": "string"
    },
    "measurementUnit": {
      "code": "string",
      "system": "string",
      "display": "string"
    }
  }'

Responses

Billing Credit created 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"
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.

remainingAmountnumberrequired

Quantity or monetary amount still available for use.

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.

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.

wastedAmountnumberrequired

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

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

amountType.​systemstringrequired

Code system URI

amountType.​displaystring

Human-readable display

creditCategoryobjectrequired
creditCategory.​codestringrequired

Code value

creditCategory.​systemstringrequired

Code system URI

creditCategory.​displaystring

Human-readable display

currencyobjectrequired
currency.​codestringrequired

Code value

currency.​systemstringrequired

Code system URI

currency.​displaystring

Human-readable display

measurementUnitobjectrequired
measurementUnit.​codestringrequired

Code value

measurementUnit.​systemstringrequired

Code system URI

measurementUnit.​displaystring

Human-readable display

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": 0,
  "startDate": "2025-01-01T00:00:00Z",
  "totalAmount": 0,
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "usedAmount": 0,
  "wastedAmount": 0,
  "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": "string",
    "system": "string",
    "display": "string"
  },
  "creditCategory": {
    "code": "string",
    "system": "string",
    "display": "string"
  },
  "currency": {
    "code": "string",
    "system": "string",
    "display": "string"
  },
  "measurementUnit": {
    "code": "string",
    "system": "string",
    "display": "string"
  }
}

List billing credits

Request

Returns a paginated list of Billing Credits 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""endDate""remainingAmount""startDate""totalAmount""usedAmount""wastedAmount"
sortOrderstring

Sort order

Default "asc"
Enum"asc""desc"
creditTypestring

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

Enum"quantity""value"
isActiveboolean

Whether this billing credit is currently active and usable.

wellnessPlanBenefitIdstring

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

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

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

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

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

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

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

Example: wellnessPlanMembershipId=123e4567-e89b-12d3-a456-426614174000
wellnessPlanMembershipStatusPeriodIdstring

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

Example: wellnessPlanMembershipStatusPeriodId=123e4567-e89b-12d3-a456-426614174000
curl -i -X GET \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/billing-credit?page=0&pageSize=10&sortBy=createdAt&sortOrder=asc&creditType=quantity&isActive=true&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' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Paginated list of Billing Credits

Get billing credit

Request

Returns a single Billing Credit by its unique identifier.

Security
bearer
Path
siteIdnumberrequired

Site identifier

billingCreditIdstringrequired

Billing Credit unique identifier (UUID)

curl -i -X GET \
  '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 found

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

remainingAmountnumberrequired

Quantity or monetary amount still available for use.

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.

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.

wastedAmountnumberrequired

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

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

amountType.​systemstringrequired

Code system URI

amountType.​displaystring

Human-readable display

creditCategoryobjectrequired
creditCategory.​codestringrequired

Code value

creditCategory.​systemstringrequired

Code system URI

creditCategory.​displaystring

Human-readable display

currencyobjectrequired
currency.​codestringrequired

Code value

currency.​systemstringrequired

Code system URI

currency.​displaystring

Human-readable display

measurementUnitobjectrequired
measurementUnit.​codestringrequired

Code value

measurementUnit.​systemstringrequired

Code system URI

measurementUnit.​displaystring

Human-readable display

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": 0,
  "startDate": "2025-01-01T00:00:00Z",
  "totalAmount": 0,
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "usedAmount": 0,
  "wastedAmount": 0,
  "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": "string",
    "system": "string",
    "display": "string"
  },
  "creditCategory": {
    "code": "string",
    "system": "string",
    "display": "string"
  },
  "currency": {
    "code": "string",
    "system": "string",
    "display": "string"
  },
  "measurementUnit": {
    "code": "string",
    "system": "string",
    "display": "string"
  }
}

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

remainingAmountnumber

Quantity or monetary amount still available for use.

startDatestring

Date from which the credit becomes valid.

Example: "2025-01-01"
totalAmountnumber

Total quantity or monetary amount originally granted for this credit.

usedAmountnumber

Quantity or monetary amount that has been used.

wastedAmountnumber

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

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": 0,
    "startDate": "2025-01-01",
    "totalAmount": 0,
    "usedAmount": 0,
    "wastedAmount": 0,
    "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": "string",
      "system": "string",
      "display": "string"
    },
    "creditCategory": {
      "code": "string",
      "system": "string",
      "display": "string"
    },
    "currency": {
      "code": "string",
      "system": "string",
      "display": "string"
    },
    "measurementUnit": {
      "code": "string",
      "system": "string",
      "display": "string"
    }
  }'

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

remainingAmountnumberrequired

Quantity or monetary amount still available for use.

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.

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.

wastedAmountnumberrequired

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

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

amountType.​systemstringrequired

Code system URI

amountType.​displaystring

Human-readable display

creditCategoryobjectrequired
creditCategory.​codestringrequired

Code value

creditCategory.​systemstringrequired

Code system URI

creditCategory.​displaystring

Human-readable display

currencyobjectrequired
currency.​codestringrequired

Code value

currency.​systemstringrequired

Code system URI

currency.​displaystring

Human-readable display

measurementUnitobjectrequired
measurementUnit.​codestringrequired

Code value

measurementUnit.​systemstringrequired

Code system URI

measurementUnit.​displaystring

Human-readable display

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": 0,
  "startDate": "2025-01-01T00:00:00Z",
  "totalAmount": 0,
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "usedAmount": 0,
  "wastedAmount": 0,
  "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": "string",
    "system": "string",
    "display": "string"
  },
  "creditCategory": {
    "code": "string",
    "system": "string",
    "display": "string"
  },
  "currency": {
    "code": "string",
    "system": "string",
    "display": "string"
  },
  "measurementUnit": {
    "code": "string",
    "system": "string",
    "display": "string"
  }
}

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

remainingAmountnumberrequired

Quantity or monetary amount still available for use.

startDatestringrequired

Date from which the credit becomes valid.

Example: "2025-01-01"
totalAmountnumberrequired

Total quantity or monetary amount originally granted for this credit.

usedAmountnumberrequired

Quantity or monetary amount that has been used.

wastedAmountnumberrequired

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

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

amountType.​systemstringrequired

Code system URI

amountType.​displaystring

Human-readable display

creditCategoryobjectrequired
creditCategory.​codestringrequired

Code value

creditCategory.​systemstringrequired

Code system URI

creditCategory.​displaystring

Human-readable display

currencyobjectrequired
currency.​codestringrequired

Code value

currency.​systemstringrequired

Code system URI

currency.​displaystring

Human-readable display

measurementUnitobjectrequired
measurementUnit.​codestringrequired

Code value

measurementUnit.​systemstringrequired

Code system URI

measurementUnit.​displaystring

Human-readable display

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": 0,
    "startDate": "2025-01-01",
    "totalAmount": 0,
    "usedAmount": 0,
    "wastedAmount": 0,
    "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": "string",
      "system": "string",
      "display": "string"
    },
    "creditCategory": {
      "code": "string",
      "system": "string",
      "display": "string"
    },
    "currency": {
      "code": "string",
      "system": "string",
      "display": "string"
    },
    "measurementUnit": {
      "code": "string",
      "system": "string",
      "display": "string"
    }
  }'

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

remainingAmountnumberrequired

Quantity or monetary amount still available for use.

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.

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.

wastedAmountnumberrequired

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

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

amountType.​systemstringrequired

Code system URI

amountType.​displaystring

Human-readable display

creditCategoryobjectrequired
creditCategory.​codestringrequired

Code value

creditCategory.​systemstringrequired

Code system URI

creditCategory.​displaystring

Human-readable display

currencyobjectrequired
currency.​codestringrequired

Code value

currency.​systemstringrequired

Code system URI

currency.​displaystring

Human-readable display

measurementUnitobjectrequired
measurementUnit.​codestringrequired

Code value

measurementUnit.​systemstringrequired

Code system URI

measurementUnit.​displaystring

Human-readable display

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": 0,
  "startDate": "2025-01-01T00:00:00Z",
  "totalAmount": 0,
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "usedAmount": 0,
  "wastedAmount": 0,
  "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": "string",
    "system": "string",
    "display": "string"
  },
  "creditCategory": {
    "code": "string",
    "system": "string",
    "display": "string"
  },
  "currency": {
    "code": "string",
    "system": "string",
    "display": "string"
  },
  "measurementUnit": {
    "code": "string",
    "system": "string",
    "display": "string"
  }
}

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

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

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