The group service with clinic overrides object

clinic_config

ExternalClinicServiceConfigData · object | null

required

Show child attributes

clinic_service_price

ExternalServicePrice · object | null

required

The clinic's set override service price for this service, if one exists.

Show child attributes

code

string

required

The unique service code for this service.

config

ExternalClinicServiceConfigData · object

required

Show child attributes

created_at

string<date-time>

required

The date and time the service was created.

group_config

ExternalClinicServiceConfigData · object

required

Show child attributes

group_service_id

integer

required

The ID of the Group-level service that this service corresponds to.

group_service_price

ExternalServicePrice · object | null

required

The service price for this service set at the group-level, from the group-level service pricing group. Null when the clinic has no pricing group assigned for this service's category.

Show child attributes

has_fixed_subtotal

boolean

required

Whether this service should be priced as a fixed subtotal.

historical_code

string

required

The unique service code that this service existed under at this Clinic before being merged into a Group-level service.

is_clinic_editable

boolean

required

Whether this service is editable at the clinic level.

is_enabled_for_clinic

boolean

required

Whether the service is enabled at the clinic level.

is_enabled_for_group

boolean

required

Whether the service is enabled at the group level.

is_removable

boolean

required

Whether this service is removable once added to the medical record. Only relevant for linked services.

is_searchable_for_line_items

boolean

required

Whether this service is searchable in medical records, invoices, and estimates, to be added as a line item.

kind

required

The type of the service.

Available options:

PROCEDURE,

PRODUCT,

MEDICATION,

VACCINE,

LAB,

FEE,

SERVICE,

UNKNOWN,

CARE_PLAN

min_price

integer | null

required

The minimum price for this service, below which it cannot be discounted.

Required range: x >= 0

name

string

required

The name of this service.

pricing_category

ExternalServicePricingCategorySchema · object

required

The service pricing category this group service belongs to.

Show child attributes

pricing_source

enum<string> | null

required

Whether pricing for this service at this clinic is controlled by the group service pricing group or overridden at the clinic level. Null when the clinic has no pricing group assigned for this service's category.

Available options:

SERVICE_PRICING_GROUP,

CLINIC_OVERRIDE

service_price

ExternalServicePrice · object | null

required

The effective service price for this service, which may be sourced from the group-level service pricing group or from clinic overrides. Null when the clinic has no pricing group assigned for this service's category.

Show child attributes

unit_of_measure

required

The unit of measurement. This service is sold in increments of this unit.

Available options:

APPLICATOR,

BAG,

BOTTLE,

BOX,

BUCKET,

CAN,

CAPLET,

CAPSULE,

CASE,

CATHETER,

CHEW,

COLLAR,

DOSE,

EACH,

GRAM,

GALLON,

JAR,

KIT,

POUND,

LITER,

MILLILITER,

NEEDLE,

OUNCE,

PACKET,

PAIR,

PIPETTE,

PURCHASING_UNIT,

QUART,

ROLL,

SUTURE,

SYRINGE,

TABLET,

TEST,

TRAY,

TUB,

TUBE,

VIAL,

YARD

has_in_clinic_dispense_fee

boolean | null

Whether this service has a dispense fee when administered in-clinic.

has_take_home_dispense_fee

boolean | null

Whether this service has a dispense fee when taken home by the pet parent.

⌘I

{
  "clinic_config": {
    "breeds": [
      "<string>"
    ],
    "default_duration_scales_with_quantity": true,
    "default_duration_value": 2,
    "default_price": 1,
    "default_sig": "<string>",
    "din": "<string>",
    "display_name": "<string>",
    "exclude_from_discounts": true,
    "has_in_clinic_dispense_fee": true,
    "has_lot_number_for_treatments": true,
    "has_route_and_location_for_treatments": true,
    "has_sig_for_treatments": true,
    "has_take_home_dispense_fee": true,
    "invoiced_as_non_integer": true,
    "is_altered": true,
    "is_invoice_only": true,
    "keywords": [
      "<string>"
    ],
    "max_age": 1,
    "max_quantity": 1,
    "max_uses_per_charge": 123,
    "max_weight": 1,
    "min_age": 1,
    "min_weight": 1,
    "minimum_subtotal": 1,
    "species": []
  },
  "clinic_service_price": {
    "id": 123,
    "service_pricing_group_id": 123,
    "strategy_value": {},
    "current_price": 123
  },
  "code": "<string>",
  "config": {
    "breeds": [
      "<string>"
    ],
    "default_duration_scales_with_quantity": true,
    "default_duration_value": 2,
    "default_price": 1,
    "default_sig": "<string>",
    "din": "<string>",
    "display_name": "<string>",
    "exclude_from_discounts": true,
    "has_in_clinic_dispense_fee": true,
    "has_lot_number_for_treatments": true,
    "has_route_and_location_for_treatments": true,
    "has_sig_for_treatments": true,
    "has_take_home_dispense_fee": true,
    "invoiced_as_non_integer": true,
    "is_altered": true,
    "is_invoice_only": true,
    "keywords": [
      "<string>"
    ],
    "max_age": 1,
    "max_quantity": 1,
    "max_uses_per_charge": 123,
    "max_weight": 1,
    "min_age": 1,
    "min_weight": 1,
    "minimum_subtotal": 1,
    "species": []
  },
  "created_at": "2023-11-07T05:31:56Z",
  "group_config": {
    "breeds": [
      "<string>"
    ],
    "default_duration_scales_with_quantity": true,
    "default_duration_value": 2,
    "default_price": 1,
    "default_sig": "<string>",
    "din": "<string>",
    "display_name": "<string>",
    "exclude_from_discounts": true,
    "has_in_clinic_dispense_fee": true,
    "has_lot_number_for_treatments": true,
    "has_route_and_location_for_treatments": true,
    "has_sig_for_treatments": true,
    "has_take_home_dispense_fee": true,
    "invoiced_as_non_integer": true,
    "is_altered": true,
    "is_invoice_only": true,
    "keywords": [
      "<string>"
    ],
    "max_age": 1,
    "max_quantity": 1,
    "max_uses_per_charge": 123,
    "max_weight": 1,
    "min_age": 1,
    "min_weight": 1,
    "minimum_subtotal": 1,
    "species": []
  },
  "group_service_id": 123,
  "group_service_price": {
    "id": 123,
    "service_pricing_group_id": 123,
    "strategy_value": {},
    "current_price": 123
  },
  "has_fixed_subtotal": true,
  "historical_code": "<string>",
  "is_clinic_editable": true,
  "is_enabled_for_clinic": true,
  "is_enabled_for_group": true,
  "is_removable": true,
  "is_searchable_for_line_items": true,
  "min_price": 1,
  "name": "<string>",
  "pricing_category": {
    "id": 123,
    "name": "<string>"
  },
  "service_price": {
    "id": 123,
    "service_pricing_group_id": 123,
    "strategy_value": {},
    "current_price": 123
  },
  "has_in_clinic_dispense_fee": true,
  "has_take_home_dispense_fee": true
}

Using the API

Developer guides

Accounts

Care plans

Catalog

Checkout links

Clients & patients

Clinics

External Rx

Insurance

Inbox

Invoices

Labs

Onboardings

Orders

Payments

PDFs

Prescriptions

Scheduler

Service pricing

Standard care

Subscriptions

File uploads

Inventory

Forms

Medical records

The group service with clinic overrides object