Delete billing credit

Animal
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

Animal Colour
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

Breed
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

Health Status
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

Herd
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

Sex
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

Shelter Animal Booking
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

Species
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

Assessment
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

Consult
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

History
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

Physical Exam
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

Presenting Problem Link
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

Presentingproblem
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

Standardofcare
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

Therapeutic
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

Vaccination
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

Diagnostic
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

Diagnostic Code
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

Diagnostic Request
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

Diagnostic Result
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

Diagnostic Result Item
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

Integrated Diagnostic
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

Modality
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

Standard Diagnostic Lab Report
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

External Prescription
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

Prescription
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

Prescription Item
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

Appointment
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

Appointment Status
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

Appointment Type
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

Availability
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

Availability Slot
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

Booking
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

Billing Credit
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

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