Update clinic overrides for a group service
This endpoint is available to Group API Keys only.
Updates existing clinic-level overrides for an organization-level service at the specified clinic.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The ID of the group service to update clinic-level data for.
The ID of the clinic to update the clinic-level service data for.
Body
The unique service code that this service existed under at this Clinic before being merged into a Group-level service.
Whether the service is enabled.
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.
The default price for this service if not overridden elsewhere.
x >= 0The display name of the service. Defaults to the service's name if not defined.
Whether this service is excluded from discounts.
Whether this service is invoiced in integer increments or not.
A list of keywords associated with this service.
The maximum quantity that can be invoiced for this service.
x >= 0The minimum subtotal in cents for this service.
x >= 0The default location that this vaccine/medication will be administered at. Only applicable when the kind of the associated group service is VACCINE or MEDICATION.
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 The default route that this vaccine/medication will be administered through. Only applicable when the kind of the associated group service is VACCINE or MEDICATION.
INTRACARDIAC, INTRAMUSCULAR, INTRANASAL, INTRAPERITONEAL, INTRAOSSEOUS, INTRATESTICULAR, INTRAVENOUS, OCULAR, ORAL, ORAL_NERVE_BLOCK, OTIC, SUBCUTANEOUS, TOPICAL The default signature for this service. Only applicable when the kind of the associated group service is MEDICATION.
The default kind of treatment this service represents. Only applicable when the kind of the associated group service is PRODUCT or MEDICATION.
IN_CLINIC, TAKE_HOME 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.
Whether this service has a dispense fee when administered in-clinic.
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.
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.
Whether this product should have a signature input in treatments. Only applicable when the kind of the associated group service is PRODUCT.
Whether this service has a dispense fee when taken home by the pet parent.
Whether a patient eligible for this service has been spayed/neutered.
The maximum age of a patient eligible for this service, in the unit specified by max_age_units.
x >= 0The unit in which the max_age is defined.
DAY, WEEK, MONTH, YEAR The maximum weight of a patient eligible for this service, in pounds.
x >= 0The minimum age of a patient eligible for this service, in the unit specified by min_age_units.
x >= 0The unit in which the min_age is defined.
DAY, WEEK, MONTH, YEAR The minimum weight of a patient eligible for this service, in pounds.
x >= 0The kind of procedure this service represents. Only applicable when the kind of the associated group service is PROCEDURE.
EUTHANASIA, SPAY, NEUTER, OTHER The sex of a patient eligible for this service.
MALE, FEMALE, UNKNOWN The species of patient associated with this service. If the given value is an empty string (``), that indicates that species is not a relevant criteria for this service and should be ignored. If the species is null, that indicates we should fall back to the group service's configuration for this.
CANINE, FELINE, EQUINE, AVIAN, BOVINE, FERRET, RABBIT, RODENT, REPTILE, AMPHIBIAN, FISH, PORCINE, CAPRINE, SHEEP, CAMELID, RATITE, MARSUPIAL, MUSTELID, CERVID, PROCYONIDAE, ERINACEIDAE, MEPHITIDAE, OTHER, UNSPECIFIED The kind of vaccine this service represents. Only applicable when the kind of the associated group service is VACCINE.
RABIES, OTHER Response
OK
The clinic's set override service price for this service, if one exists.
The unique service code for this service.
The date and time the service was created.
The ID of the Group-level service that this service corresponds to.
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.
Whether this service should be priced as a fixed subtotal.
The unique service code that this service existed under at this Clinic before being merged into a Group-level service.
Whether this service is editable at the clinic level.
Whether the service is enabled at the clinic level.
Whether the service is enabled at the group level.
Whether this service is removable once added to the medical record. Only relevant for linked services.
Whether this service is searchable in medical records, invoices, and estimates, to be added as a line item.
The type of the service.
PROCEDURE, PRODUCT, MEDICATION, VACCINE, LAB, FEE, SERVICE, UNKNOWN, CARE_PLAN The minimum price for this service, below which it cannot be discounted.
x >= 0The name of this service.
The service pricing category this group service belongs to.
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.
SERVICE_PRICING_GROUP, CLINIC_OVERRIDE 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.
The unit of measurement. This service is sold in increments of this unit.
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 Whether this service has a dispense fee when administered in-clinic.
Whether this service has a dispense fee when taken home by the pet parent.