Create a service
This endpoint is available to Group API Keys only.
Creates a new service at the organization level.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
If defined, the subset of clinic location groups that this service is for.Otherwise, the service is for all clinics in the group regardless of their location group.
The unique service code for this service.
The display name of the service. Defaults to the service's name if not defined.
Whether this service should be priced as a fixed subtotal.
Whether this service is invoiced in integer increments or not.
Whether the service is enabled.
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 ID of the pricing category for this service.
The ID of the tax category for this service.
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 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.
Whether this service's default duration scales with quantity.
The unit of default duration used for this service. Only applicable when the kind is PROCEDURE, PRODUCT, MEDICATION, LAB, or SERVICE.
DAY, WEEK, MONTH, YEAR The value of the default duration used for this service. Only applicable when the kind is PROCEDURE, PRODUCT, MEDICATION, LAB, or SERVICE.
x >= 1Per-reminder default durations for active standard care reminders linked to this vaccine service. Only applicable when the kind is VACCINE.
The 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 price for this service if not overridden elsewhere.
x >= 0The 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 is excluded from discounts.
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.
Whether this service is only invoiced, not charged for hospitalizations.
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.
A list of keywords associated with this service.
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 quantity that can be invoiced for this service.
x >= 0The maximum number of uses per charge for this service.
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 minimum subtotal in cents for this service.
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 ID of the revenue category for this service.
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 list ([]), that indicates that species is not a relevant criteria for this service and should be ignored.
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 treatment sheet billing type for this service.
FIXED_RATE, MAX_USES_PER_CHARGE, NON_CHARGEABLE The treatment sheet category of this service.
BUNDLE, VITAL, TASK, NUTRITION, FLUID, PATIENT_CARE, PROCEDURE, PRODUCT, MEDICATION, VACCINE, LAB, SERVICE The kind of vaccine this service represents. Only applicable when the kind of the associated group service is VACCINE.
RABIES, OTHER Response
Created
The unique service code for this service.
The date and time the service was created.
Whether this service should be priced as a fixed subtotal.
The unique identifier for the service.
Whether the service is enabled.
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 ID of the revenue category for this service.
The ID of the pricing category for this service.
The ID of the tax category for this service.
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 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 defined, the subset of clinic location groups that this service is for.Otherwise, the service is for all clinics in the group regardless of their location group.
Whether this service's default duration scales with quantity.
The unit of default duration used for this service. Only applicable when the kind is PROCEDURE, PRODUCT, MEDICATION, LAB, or SERVICE.
DAY, WEEK, MONTH, YEAR The value of the default duration used for this service. Only applicable when the kind is PROCEDURE, PRODUCT, MEDICATION, LAB, or SERVICE.
x >= 1Per-reminder default durations for active standard care reminders linked to this vaccine service. Only applicable when the kind is VACCINE.
The 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 price for this service if not overridden elsewhere.
x >= 0The 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.
The display name of the service. Defaults to the service's name if not defined.
Whether this service is excluded from discounts.
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 this service is invoiced in integer increments or not.
Whether a patient eligible for this service has been spayed/neutered.
Whether this service is only invoiced, not charged for hospitalizations.
A list of keywords associated with this service.
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 quantity that can be invoiced for this service.
x >= 0The maximum number of uses per charge for this service.
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 minimum subtotal in cents for this service.
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 list ([]), that indicates that species is not a relevant criteria for this service and should be ignored.
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 treatment sheet billing type for this service.
FIXED_RATE, MAX_USES_PER_CHARGE, NON_CHARGEABLE The treatment sheet category for this service, used for grouping in treatment sheet workflows.
BUNDLE, VITAL, TASK, NUTRITION, FLUID, PATIENT_CARE, PROCEDURE, PRODUCT, MEDICATION, VACCINE, LAB, SERVICE The kind of vaccine this service represents. Only applicable when the kind of the associated group service is VACCINE.
RABIES, OTHER