VEvetcove
Service Pricing

Create clinic overrides for a group service

This endpoint is available to Group API Keys only.

Creates clinic-level overrides for an organization-level service at the specified clinic. This allows a clinic to customize the service configuration (e.g., price, tax category) independently from the organization-level defaults.

post/ext/v2/clinics/{clinic_id}/group-services/

Request

  • Base URL
    https://connect.vetcove.com
  • URL
    https://connect.vetcove.com/ext/v2/clinics/{clinic_id}/group-services/
  • Auth
    HTTP bearer

Path parameters

clinic_idinteger required

The ID of the clinic to add clinic-level group service data for.

Request body

breedsstring[] nullable

A list of breed names associated with this service. If the given value is an empty list ([]), that indicates that breed is not a relevant criteria for this service and should be ignored. If the given value is null, that indicates we should fall back to the group service's configuration for this.

config.default_priceinteger nullable

The default price for this service if not overridden elsewhere.

config.display_namestring nullable

The display name of the service. Defaults to the service's name if not defined.

config.exclude_from_discountsboolean nullable

Whether this service is excluded from discounts.

config.invoiced_as_non_integerboolean nullable

Whether this service is invoiced in integer increments or not.

config.keywordsstring[] nullable

A list of keywords associated with this service.

config.minimum_subtotalinteger nullable

The minimum subtotal in cents for this service.

default_location'RIGHT_SHOULDER' | 'RIGHT_REAR' | 'LEFT_SHOULDER' | 'LEFT_REAR' | 'RIGHT_CEPHALIC' | 'LEFT_CEPHALIC' | 'RIGHT_SAPHENOUS' | 'LEFT_SAPHENOUS' | 'RIGHT_EPAXIAL' | 'LEFT_EPAXIAL' | 'JUGULAR' | 'ORAL' | 'INTRANASAL' | 'INTERSCAPULAR' | 'LEFT_EYE' | 'RIGHT_EYE' | 'BOTH_EYES' | 'EYELIDS' | 'LEFT_EAR' | 'RIGHT_EAR' | 'BOTH_EARS' | 'EARS' | 'OTHER' | 'BACK_OF_NECK' | 'MOUTH' | 'INTERDIGITAL' | 'PAWS' | 'TESTICLES' | 'LOWER_RIGHT_QUADRANT' | 'LOWER_LEFT_QUADRANT' | 'INTRACARDIAC' | 'PROXIMAL_TIBIA' | 'PROXIMAL_FEMUR' | 'PROXIMAL_HUMERUS' | 'EPAXIAL' | 'INTRASCAPULAR'
default_route'INTRACARDIAC' | 'INTRAMUSCULAR' | 'INTRANASAL' | 'INTRAPERITONEAL' | 'INTRAOSSEOUS' | 'INTRATESTICULAR' | 'INTRAVENOUS' | 'OCULAR' | 'ORAL' | 'ORAL_NERVE_BLOCK' | 'OTIC' | 'SUBCUTANEOUS' | 'TOPICAL'
default_sigstring nullable

The default signature for this service. Only applicable when the kind of the associated group service is MEDICATION.

default_treatment_kind'IN_CLINIC' | 'TAKE_HOME'
dinstring nullable

The Drug Identification Number (DIN) for this service. Only applicable when the kind of the associated group service is MEDICATION or PRODUCT and the clinic is in Canada.

group_service_idinteger required

The ID of the corresponding Group Service to add clinic-level data for.

has_in_clinic_dispense_feeboolean nullable

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

has_lot_number_for_treatmentsboolean nullable

Whether the lot number field is shown in the treatment form. Only applicable when the kind of the associated group service is PRODUCT, MEDICATION, or SERVICE.

has_route_and_location_for_treatmentsboolean nullable

Whether the route/location fields are shown in treatment forms for the service. Only applicable when the kind of the associated group service is MEDICATION.

has_sig_for_treatmentsboolean nullable

Whether this product should have a signature input in treatments. Only applicable when the kind of the associated group service is PRODUCT.

has_take_home_dispense_feeboolean nullable

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

historical_codestring required

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

is_alteredboolean nullable

Whether a patient eligible for this service has been spayed/neutered.

is_enabledboolean required

Whether the service is enabled.

max_ageinteger nullable

The maximum age of a patient eligible for this service, in the unit specified by max_age_units.

max_age_units'DAY' | 'WEEK' | 'MONTH' | 'YEAR'
max_weightnumber nullable

The maximum weight of a patient eligible for this service, in pounds.

min_ageinteger nullable

The minimum age of a patient eligible for this service, in the unit specified by min_age_units.

min_age_units'DAY' | 'WEEK' | 'MONTH' | 'YEAR'
min_weightnumber nullable

The minimum weight of a patient eligible for this service, in pounds.

procedure_kind'EUTHANASIA' | 'SPAY' | 'NEUTER' | 'OTHER'
sex'MALE' | 'FEMALE' | 'UNKNOWN'
vaccine_kind'RABIES' | 'OTHER'

Response

Created

codestring required

The unique service code for this service.

created_atstring date-time required

The date and time the service was created.

group_service_idinteger required

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

has_fixed_subtotalboolean required

Whether this service should be priced as a fixed subtotal.

has_in_clinic_dispense_feeboolean nullable

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

has_take_home_dispense_feeboolean nullable

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

historical_codestring required

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

is_clinic_editableboolean required

Whether this service is editable at the clinic level.

is_enabled_for_clinicboolean required

Whether the service is enabled at the clinic level.

is_enabled_for_groupboolean required

Whether the service is enabled at the group level.

is_removableboolean required

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

is_searchable_for_line_itemsboolean required

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

min_priceinteger nullable required

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

namestring required

The name of this service.

pricing_source'SERVICE_PRICING_GROUP' | 'CLINIC_OVERRIDE' required

Changes

No recorded changes to this operation across all 1 revision of this API.