VEvetcove
Service Pricing

Create a service

This endpoint is available to Group API Keys only.

Creates a new service at the organization level.

post/ext/v2/group-services/

Request

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

Request body

breedsstring[]

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.

clinic_location_group_idsinteger[] required

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.

codestring required

The unique service code for this service.

default_duration_scales_with_quantityboolean nullable

Whether this service's default duration scales with quantity.

default_duration_unit'DAY' | 'WEEK' | 'MONTH' | 'YEAR'
default_duration_valueinteger nullable

The value of the default duration used for this service. Only applicable when the kind is PROCEDURE, PRODUCT, MEDICATION, LAB, or 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_priceinteger nullable

The default price for this service if not overridden elsewhere.

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.

display_namestring required

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

exclude_from_discountsboolean nullable

Whether this service is excluded from discounts.

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_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.

invoiced_as_non_integerboolean required

Whether this service is invoiced in integer increments or not.

is_alteredboolean nullable

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

is_enabledboolean required

Whether the service is enabled.

is_invoice_onlyboolean nullable

Whether this service is only invoiced, not charged for hospitalizations.

is_removableboolean

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

is_searchable_for_line_itemsboolean

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

keywordsstring[] nullable

A list of keywords associated with this service.

max_ageinteger nullable

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

max_uses_per_chargeinteger nullable

The maximum number of uses per charge for this service.

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_priceinteger nullable required

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

min_weightnumber nullable

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

minimum_subtotalinteger nullable

The minimum subtotal in cents for this service.

namestring required

The name of this service.

procedure_kind'EUTHANASIA' | 'SPAY' | 'NEUTER' | 'OTHER'
revenue_category_idinteger nullable

The ID of the revenue category for this service.

service_pricing_category_idinteger required

The ID of the pricing category for this service.

speciesPatientKind[]

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.

tax_category_idinteger required

The ID of the tax category for this service.

treatment_sheet_billing_type'FIXED_RATE' | 'MAX_USES_PER_CHARGE' | 'NON_CHARGEABLE'
treatment_sheet_category'BUNDLE' | 'VITAL' | 'TASK' | 'NUTRITION' | 'FLUID' | 'PATIENT_CARE' | 'PROCEDURE' | 'PRODUCT' | 'MEDICATION' | 'VACCINE' | 'LAB' | 'SERVICE'
vaccine_kind'RABIES' | 'OTHER'

Response

Created

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.

clinic_location_group_idsinteger[]

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.

codestring required

The unique service code for this service.

created_atstring date-time required

The date and time the service was created.

default_duration_scales_with_quantityboolean nullable

Whether this service's default duration scales with quantity.

default_duration_unit'DAY' | 'WEEK' | 'MONTH' | 'YEAR'
default_duration_valueinteger nullable

The value of the default duration used for this service. Only applicable when the kind is PROCEDURE, PRODUCT, MEDICATION, LAB, or 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_priceinteger nullable

The default price for this service if not overridden elsewhere.

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.

display_namestring nullable

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

exclude_from_discountsboolean nullable

Whether this service is excluded from discounts.

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_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.

idinteger required

The unique identifier for the service.

invoiced_as_non_integerboolean nullable

Whether this service is invoiced in integer increments or not.

is_alteredboolean nullable

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

is_enabledboolean required

Whether the service is enabled.

is_invoice_onlyboolean nullable

Whether this service is only invoiced, not charged for hospitalizations.

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.

keywordsstring[] nullable

A list of keywords associated with this service.

max_ageinteger nullable

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

max_uses_per_chargeinteger nullable

The maximum number of uses per charge for this service.

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_priceinteger nullable required

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

min_weightnumber nullable

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

minimum_subtotalinteger nullable

The minimum subtotal in cents for this service.

namestring required

The name of this service.

procedure_kind'EUTHANASIA' | 'SPAY' | 'NEUTER' | 'OTHER'
revenue_category_idinteger nullable required

The ID of the revenue category for this service.

service_pricing_category_idinteger required

The ID of the pricing category for this service.

tax_category_idinteger required

The ID of the tax category for this service.

treatment_sheet_billing_type'FIXED_RATE' | 'MAX_USES_PER_CHARGE' | 'NON_CHARGEABLE'
treatment_sheet_category'BUNDLE' | 'VITAL' | 'TASK' | 'NUTRITION' | 'FLUID' | 'PATIENT_CARE' | 'PROCEDURE' | 'PRODUCT' | 'MEDICATION' | 'VACCINE' | 'LAB' | 'SERVICE'
vaccine_kind'RABIES' | 'OTHER'

Changes

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