> ## Documentation Index > Fetch the complete documentation index at: https://developer.vetcove.com/llms.txt > Use this file to discover all available pages before exploring further. # Update a service > This endpoint is available to Group API Keys only. Updates an existing organization-level service by its ID. ## OpenAPI ````yaml put /ext/v2/group-services/{group_service_id}/ openapi: 3.1.0 info: description: '' title: NinjaAPI version: 2.0.0 servers: - url: https://connect.vetcove.com/ security: [] paths: /ext/v2/group-services/{group_service_id}/: put: tags: - Service Pricing summary: Update a service description: |- This endpoint is available to Group API Keys only. Updates an existing organization-level service by its ID. operationId: group_service_update parameters: - description: The ID of the group service to update in: path name: group_service_id required: true schema: description: The ID of the group service to update title: Group Service Id type: integer requestBody: content: application/json: schema: $ref: '#/components/schemas/ExternalGroupServiceCreateOrUpdateSchema' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/ExternalGroupServiceDetailSchema' description: OK security: - ExternalAPIAuth: [] components: schemas: ExternalGroupServiceCreateOrUpdateSchema: properties: breeds: default: [] description: >- 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. items: type: string title: Breeds type: array clinic_location_group_ids: description: >- 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. items: type: integer title: Clinic Location Group Ids type: array code: description: The unique service code for this service. title: Code type: string default_duration_scales_with_quantity: anyOf: - type: boolean - type: 'null' description: Whether this service's default duration scales with quantity. title: Default Duration Scales With Quantity default_duration_unit: anyOf: - $ref: '#/components/schemas/FrequencyUnit' - type: 'null' description: >- The unit of default duration used for this service. Only applicable when the `kind` is `PROCEDURE`, `PRODUCT`, `MEDICATION`, `LAB`, or `SERVICE`. default_duration_value: anyOf: - minimum: 1 type: integer - type: 'null' description: >- The value of the default duration used for this service. Only applicable when the `kind` is `PROCEDURE`, `PRODUCT`, `MEDICATION`, `LAB`, or `SERVICE`. title: Default Duration Value default_durations: anyOf: - items: $ref: >- #/components/schemas/ExternalServiceVaccineDefaultDurationCreateOrUpdateSchema type: array - type: 'null' description: >- Per-reminder default durations for active standard care reminders linked to this vaccine service. Only applicable when the `kind` is `VACCINE`. title: Default Durations default_location: anyOf: - $ref: '#/components/schemas/ServiceProductLocation' - type: 'null' description: >- 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`. default_price: anyOf: - minimum: 0 type: integer - type: 'null' description: The default price for this service if not overridden elsewhere. title: Default Price default_route: anyOf: - $ref: '#/components/schemas/ServiceProductRoute' - type: 'null' description: >- 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`. default_sig: anyOf: - type: string - type: 'null' description: >- The default signature for this service. Only applicable when the `kind` of the associated group service is `MEDICATION`. title: Default Sig default_treatment_kind: anyOf: - $ref: '#/components/schemas/TreatmentKind' - type: 'null' description: >- The default kind of treatment this service represents. Only applicable when the `kind` of the associated group service is `PRODUCT` or `MEDICATION`. din: anyOf: - type: string - type: 'null' description: >- 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. title: Din display_name: description: >- The display name of the service. Defaults to the service's name if not defined. title: Display Name type: string exclude_from_discounts: anyOf: - type: boolean - type: 'null' description: Whether this service is excluded from discounts. title: Exclude From Discounts has_fixed_subtotal: description: Whether this service should be priced as a fixed subtotal. title: Has Fixed Subtotal type: boolean has_in_clinic_dispense_fee: anyOf: - type: boolean - type: 'null' default: false description: Whether this service has a dispense fee when administered in-clinic. title: Has In Clinic Dispense Fee has_lot_number_for_treatments: anyOf: - type: boolean - type: 'null' description: >- 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`. title: Has Lot Number For Treatments has_route_and_location_for_treatments: anyOf: - type: boolean - type: 'null' description: >- 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`. title: Has Route And Location For Treatments has_sig_for_treatments: anyOf: - type: boolean - type: 'null' description: >- Whether this product should have a signature input in treatments. Only applicable when the `kind` of the associated group service is `PRODUCT`. title: Has Sig For Treatments has_take_home_dispense_fee: anyOf: - type: boolean - type: 'null' default: false description: >- Whether this service has a dispense fee when taken home by the pet parent. title: Has Take Home Dispense Fee invoiced_as_non_integer: description: Whether this service is invoiced in integer increments or not. title: Invoiced As Non Integer type: boolean is_altered: anyOf: - type: boolean - type: 'null' description: >- Whether a patient eligible for this service has been spayed/neutered. title: Is Altered is_enabled: description: Whether the service is enabled. title: Is Enabled type: boolean is_invoice_only: anyOf: - type: boolean - type: 'null' description: >- Whether this service is only invoiced, not charged for hospitalizations. title: Is Invoice Only is_removable: default: false description: >- Whether this service is removable once added to the medical record. Only relevant for linked services. title: Is Removable type: boolean is_searchable_for_line_items: default: true description: >- Whether this service is searchable in medical records, invoices, and estimates, to be added as a line item. title: Is Searchable For Line Items type: boolean keywords: anyOf: - items: type: string type: array - type: 'null' description: A list of keywords associated with this service. title: Keywords kind: anyOf: - $ref: '#/components/schemas/ServiceKind' - const: '' type: string description: The type of the service. title: Kind max_age: anyOf: - minimum: 0 type: integer - type: 'null' description: >- The maximum age of a patient eligible for this service, in the unit specified by `max_age_units`. title: Max Age max_age_units: anyOf: - $ref: '#/components/schemas/FrequencyUnit' - const: '' type: string default: '' description: The unit in which the `max_age` is defined. title: Max Age Units max_quantity: anyOf: - minimum: 0 type: number - type: string - type: 'null' description: The maximum quantity that can be invoiced for this service. title: Max Quantity max_uses_per_charge: anyOf: - type: integer - type: 'null' description: The maximum number of uses per charge for this service. title: Max Uses Per Charge max_weight: anyOf: - minimum: 0 type: number - type: 'null' description: >- The maximum weight of a patient eligible for this service, in pounds. title: Max Weight min_age: anyOf: - minimum: 0 type: integer - type: 'null' description: >- The minimum age of a patient eligible for this service, in the unit specified by `min_age_units`. title: Min Age min_age_units: anyOf: - $ref: '#/components/schemas/FrequencyUnit' - const: '' type: string default: '' description: The unit in which the `min_age` is defined. title: Min Age Units min_price: anyOf: - minimum: 0 type: integer - type: 'null' description: >- The minimum price for this service, below which it cannot be discounted. title: Min Price min_weight: anyOf: - minimum: 0 type: number - type: 'null' description: >- The minimum weight of a patient eligible for this service, in pounds. title: Min Weight minimum_subtotal: anyOf: - minimum: 0 type: integer - type: 'null' description: The minimum subtotal in cents for this service. title: Minimum Subtotal name: description: The name of this service. title: Name type: string procedure_kind: anyOf: - $ref: '#/components/schemas/ServiceProcedureKind' - type: 'null' description: >- The kind of procedure this service represents. Only applicable when the `kind` of the associated group service is `PROCEDURE`. revenue_category_id: anyOf: - type: integer - type: 'null' description: The ID of the revenue category for this service. title: Revenue Category Id service_pricing_category_id: description: The ID of the pricing category for this service. title: Service Pricing Category Id type: integer sex: anyOf: - $ref: '#/components/schemas/SexKind' - const: '' type: string default: '' description: The sex of a patient eligible for this service. title: Sex species: default: [] description: >- 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. items: $ref: '#/components/schemas/PatientKind' title: Species type: array tax_category_id: description: The ID of the tax category for this service. title: Tax Category Id type: integer treatment_sheet_billing_type: anyOf: - $ref: '#/components/schemas/HospitalizationServiceBillingType' - type: 'null' description: The treatment sheet billing type for this service. treatment_sheet_category: anyOf: - $ref: '#/components/schemas/TreatmentSheetSeriesCategory' - type: 'null' description: The treatment sheet category of this service. unit_of_measure: anyOf: - $ref: '#/components/schemas/InventoryUnitOfMeasure' - const: '' type: string description: >- The unit of measurement. This service is sold in increments of this unit. title: Unit Of Measure vaccine_kind: anyOf: - $ref: '#/components/schemas/VaccineKind' - type: 'null' description: >- The kind of vaccine this service represents. Only applicable when the `kind` of the associated group service is `VACCINE`. required: - code - name - kind - service_pricing_category_id - is_enabled - min_price - unit_of_measure - has_fixed_subtotal - clinic_location_group_ids - tax_category_id - display_name - invoiced_as_non_integer title: ExternalGroupServiceCreateOrUpdateSchema type: object ExternalGroupServiceDetailSchema: properties: breeds: anyOf: - items: type: string type: array - type: 'null' description: >- 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. title: Breeds clinic_location_group_ids: default: [] description: >- 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. items: type: integer title: Clinic Location Group Ids type: array code: description: The unique service code for this service. title: Code type: string created_at: description: The date and time the service was created. format: date-time title: Created At type: string default_duration_scales_with_quantity: anyOf: - type: boolean - type: 'null' description: Whether this service's default duration scales with quantity. title: Default Duration Scales With Quantity default_duration_unit: anyOf: - $ref: '#/components/schemas/FrequencyUnit' - type: 'null' description: >- The unit of default duration used for this service. Only applicable when the `kind` is `PROCEDURE`, `PRODUCT`, `MEDICATION`, `LAB`, or `SERVICE`. default_duration_value: anyOf: - minimum: 1 type: integer - type: 'null' description: >- The value of the default duration used for this service. Only applicable when the `kind` is `PROCEDURE`, `PRODUCT`, `MEDICATION`, `LAB`, or `SERVICE`. title: Default Duration Value default_durations: anyOf: - items: $ref: >- #/components/schemas/ExternalServiceVaccineDefaultDurationSchema type: array - type: 'null' description: >- Per-reminder default durations for active standard care reminders linked to this vaccine service. Only applicable when the `kind` is `VACCINE`. title: Default Durations default_location: anyOf: - $ref: '#/components/schemas/ServiceProductLocation' - type: 'null' description: >- 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`. default_price: anyOf: - minimum: 0 type: integer - type: 'null' description: The default price for this service if not overridden elsewhere. title: Default Price default_route: anyOf: - $ref: '#/components/schemas/ServiceProductRoute' - type: 'null' description: >- 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`. default_sig: anyOf: - type: string - type: 'null' description: >- The default signature for this service. Only applicable when the `kind` of the associated group service is `MEDICATION`. title: Default Sig default_treatment_kind: anyOf: - $ref: '#/components/schemas/TreatmentKind' - type: 'null' description: >- The default kind of treatment this service represents. Only applicable when the `kind` of the associated group service is `PRODUCT` or `MEDICATION`. din: anyOf: - type: string - type: 'null' description: >- 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. title: Din display_name: anyOf: - type: string - type: 'null' description: >- The display name of the service. Defaults to the service's name if not defined. title: Display Name exclude_from_discounts: anyOf: - type: boolean - type: 'null' description: Whether this service is excluded from discounts. title: Exclude From Discounts has_fixed_subtotal: description: Whether this service should be priced as a fixed subtotal. title: Has Fixed Subtotal type: boolean has_in_clinic_dispense_fee: anyOf: - type: boolean - type: 'null' default: false description: Whether this service has a dispense fee when administered in-clinic. title: Has In Clinic Dispense Fee has_lot_number_for_treatments: anyOf: - type: boolean - type: 'null' description: >- 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`. title: Has Lot Number For Treatments has_route_and_location_for_treatments: anyOf: - type: boolean - type: 'null' description: >- 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`. title: Has Route And Location For Treatments has_sig_for_treatments: anyOf: - type: boolean - type: 'null' description: >- Whether this product should have a signature input in treatments. Only applicable when the `kind` of the associated group service is `PRODUCT`. title: Has Sig For Treatments has_take_home_dispense_fee: anyOf: - type: boolean - type: 'null' default: false description: >- Whether this service has a dispense fee when taken home by the pet parent. title: Has Take Home Dispense Fee id: description: The unique identifier for the service. title: Id type: integer invoiced_as_non_integer: anyOf: - type: boolean - type: 'null' description: Whether this service is invoiced in integer increments or not. title: Invoiced As Non Integer is_altered: anyOf: - type: boolean - type: 'null' description: >- Whether a patient eligible for this service has been spayed/neutered. title: Is Altered is_enabled: description: Whether the service is enabled. title: Is Enabled type: boolean is_invoice_only: anyOf: - type: boolean - type: 'null' description: >- Whether this service is only invoiced, not charged for hospitalizations. title: Is Invoice Only is_removable: description: >- Whether this service is removable once added to the medical record. Only relevant for linked services. title: Is Removable type: boolean is_searchable_for_line_items: description: >- Whether this service is searchable in medical records, invoices, and estimates, to be added as a line item. title: Is Searchable For Line Items type: boolean keywords: anyOf: - items: type: string type: array - type: 'null' description: A list of keywords associated with this service. title: Keywords kind: anyOf: - $ref: '#/components/schemas/ServiceKind' - const: '' type: string description: The type of the service. title: Kind max_age: anyOf: - minimum: 0 type: integer - type: 'null' description: >- The maximum age of a patient eligible for this service, in the unit specified by `max_age_units`. title: Max Age max_age_units: anyOf: - $ref: '#/components/schemas/FrequencyUnit' - const: '' type: string - type: 'null' description: The unit in which the `max_age` is defined. title: Max Age Units max_quantity: anyOf: - minimum: 0 type: number - type: string - type: 'null' description: The maximum quantity that can be invoiced for this service. title: Max Quantity max_uses_per_charge: anyOf: - type: integer - type: 'null' description: The maximum number of uses per charge for this service. title: Max Uses Per Charge max_weight: anyOf: - minimum: 0 type: number - type: 'null' description: >- The maximum weight of a patient eligible for this service, in pounds. title: Max Weight min_age: anyOf: - minimum: 0 type: integer - type: 'null' description: >- The minimum age of a patient eligible for this service, in the unit specified by `min_age_units`. title: Min Age min_age_units: anyOf: - $ref: '#/components/schemas/FrequencyUnit' - const: '' type: string - type: 'null' description: The unit in which the `min_age` is defined. title: Min Age Units min_price: anyOf: - minimum: 0 type: integer - type: 'null' description: >- The minimum price for this service, below which it cannot be discounted. title: Min Price min_weight: anyOf: - minimum: 0 type: number - type: 'null' description: >- The minimum weight of a patient eligible for this service, in pounds. title: Min Weight minimum_subtotal: anyOf: - minimum: 0 type: integer - type: 'null' description: The minimum subtotal in cents for this service. title: Minimum Subtotal name: description: The name of this service. title: Name type: string procedure_kind: anyOf: - $ref: '#/components/schemas/ServiceProcedureKind' - type: 'null' description: >- The kind of procedure this service represents. Only applicable when the `kind` of the associated group service is `PROCEDURE`. revenue_category_id: anyOf: - type: integer - type: 'null' description: The ID of the revenue category for this service. title: Revenue Category Id service_pricing_category_id: description: The ID of the pricing category for this service. title: Service Pricing Category Id type: integer sex: anyOf: - $ref: '#/components/schemas/SexKind' - const: '' type: string - type: 'null' description: The sex of a patient eligible for this service. title: Sex species: anyOf: - items: anyOf: - $ref: '#/components/schemas/PatientKind' - const: '' type: string type: array - type: 'null' description: >- 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. title: Species tax_category_id: description: The ID of the tax category for this service. title: Tax Category Id type: integer treatment_sheet_billing_type: anyOf: - $ref: '#/components/schemas/HospitalizationServiceBillingType' - type: 'null' description: The treatment sheet billing type for this service. treatment_sheet_category: anyOf: - $ref: '#/components/schemas/TreatmentSheetSeriesCategory' - type: 'null' description: >- The treatment sheet category for this service, used for grouping in treatment sheet workflows. unit_of_measure: anyOf: - $ref: '#/components/schemas/InventoryUnitOfMeasure' - const: '' type: string description: >- The unit of measurement. This service is sold in increments of this unit. title: Unit Of Measure vaccine_kind: anyOf: - $ref: '#/components/schemas/VaccineKind' - type: 'null' description: >- The kind of vaccine this service represents. Only applicable when the `kind` of the associated group service is `VACCINE`. required: - id - code - name - kind - service_pricing_category_id - is_enabled - created_at - min_price - is_removable - unit_of_measure - tax_category_id - revenue_category_id - is_searchable_for_line_items - has_fixed_subtotal title: ExternalGroupServiceDetailSchema type: object FrequencyUnit: enum: - DAY - WEEK - MONTH - YEAR title: FrequencyUnit type: string ExternalServiceVaccineDefaultDurationCreateOrUpdateSchema: properties: default_duration_unit: anyOf: - $ref: '#/components/schemas/FrequencyUnit' - type: 'null' description: The unit of the default duration for this vaccine reminder. default_duration_value: anyOf: - minimum: 1 type: integer - type: 'null' description: The value of the default duration for this vaccine reminder. title: Default Duration Value standard_care_reminder_id: description: >- The ID of the active standard care reminder linked to this vaccine service. title: Standard Care Reminder Id type: integer required: - standard_care_reminder_id title: ExternalServiceVaccineDefaultDurationCreateOrUpdateSchema type: object ServiceProductLocation: enum: - 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 title: ServiceProductLocation type: string ServiceProductRoute: enum: - INTRACARDIAC - INTRAMUSCULAR - INTRANASAL - INTRAPERITONEAL - INTRAOSSEOUS - INTRATESTICULAR - INTRAVENOUS - OCULAR - ORAL - ORAL_NERVE_BLOCK - OTIC - SUBCUTANEOUS - TOPICAL title: ServiceProductRoute type: string TreatmentKind: enum: - IN_CLINIC - TAKE_HOME title: TreatmentKind type: string ServiceKind: enum: - PROCEDURE - PRODUCT - MEDICATION - VACCINE - LAB - FEE - SERVICE - UNKNOWN - CARE_PLAN title: ServiceKind type: string ServiceProcedureKind: enum: - EUTHANASIA - SPAY - NEUTER - OTHER title: ServiceProcedureKind type: string SexKind: enum: - MALE - FEMALE - UNKNOWN title: SexKind type: string PatientKind: enum: - CANINE - FELINE - EQUINE - AVIAN - BOVINE - FERRET - RABBIT - RODENT - REPTILE - AMPHIBIAN - FISH - PORCINE - CAPRINE - SHEEP - CAMELID - RATITE - MARSUPIAL - MUSTELID - CERVID - PROCYONIDAE - ERINACEIDAE - MEPHITIDAE - OTHER - UNSPECIFIED title: PatientKind type: string HospitalizationServiceBillingType: enum: - FIXED_RATE - MAX_USES_PER_CHARGE - NON_CHARGEABLE title: HospitalizationServiceBillingType type: string TreatmentSheetSeriesCategory: enum: - BUNDLE - VITAL - TASK - NUTRITION - FLUID - PATIENT_CARE - PROCEDURE - PRODUCT - MEDICATION - VACCINE - LAB - SERVICE title: TreatmentSheetSeriesCategory type: string InventoryUnitOfMeasure: enum: - 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 title: InventoryUnitOfMeasure type: string VaccineKind: enum: - RABIES - OTHER title: VaccineKind type: string ExternalServiceVaccineDefaultDurationSchema: properties: default_duration_unit: anyOf: - $ref: '#/components/schemas/FrequencyUnit' - type: 'null' description: The unit of the default duration for this vaccine reminder. default_duration_value: anyOf: - minimum: 1 type: integer - type: 'null' description: The value of the default duration for this vaccine reminder. title: Default Duration Value standard_care_reminder_id: description: >- The ID of the active standard care reminder linked to this vaccine service. title: Standard Care Reminder Id type: integer standard_care_reminder_name: description: >- The name of the active standard care reminder linked to this vaccine service. title: Standard Care Reminder Name type: string required: - standard_care_reminder_id - standard_care_reminder_name title: ExternalServiceVaccineDefaultDurationSchema type: object securitySchemes: ExternalAPIAuth: scheme: bearer type: http ````