Fetch a service

GET

ext

group-services

{group_service_id}

Fetch a service

curl --request GET \
  --url https://connect.vetcove.com/ext/v2/group-services/{group_service_id}/ \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://connect.vetcove.com/ext/v2/group-services/{group_service_id}/"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://connect.vetcove.com/ext/v2/group-services/{group_service_id}/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://connect.vetcove.com/ext/v2/group-services/{group_service_id}/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://connect.vetcove.com/ext/v2/group-services/{group_service_id}/"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://connect.vetcove.com/ext/v2/group-services/{group_service_id}/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "code": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "has_fixed_subtotal": true,
  "id": 123,
  "is_enabled": true,
  "is_removable": true,
  "is_searchable_for_line_items": true,
  "kind": "PROCEDURE",
  "min_price": 1,
  "name": "<string>",
  "revenue_category_id": 123,
  "service_pricing_category_id": 123,
  "tax_category_id": 123,
  "unit_of_measure": "APPLICATOR",
  "breeds": [
    "<string>"
  ],
  "clinic_location_group_ids": [],
  "default_duration_scales_with_quantity": true,
  "default_duration_unit": "DAY",
  "default_duration_value": 2,
  "default_durations": [
    {
      "standard_care_reminder_id": 123,
      "standard_care_reminder_name": "<string>",
      "default_duration_unit": "DAY",
      "default_duration_value": 2
    }
  ],
  "default_location": "RIGHT_SHOULDER",
  "default_price": 1,
  "default_route": "INTRACARDIAC",
  "default_sig": "<string>",
  "default_treatment_kind": "IN_CLINIC",
  "din": "<string>",
  "display_name": "<string>",
  "exclude_from_discounts": true,
  "has_in_clinic_dispense_fee": false,
  "has_lot_number_for_treatments": true,
  "has_route_and_location_for_treatments": true,
  "has_sig_for_treatments": true,
  "has_take_home_dispense_fee": false,
  "invoiced_as_non_integer": true,
  "is_altered": true,
  "is_invoice_only": true,
  "keywords": [
    "<string>"
  ],
  "max_age": 1,
  "max_age_units": "DAY",
  "max_quantity": 1,
  "max_uses_per_charge": 123,
  "max_weight": 1,
  "min_age": 1,
  "min_age_units": "DAY",
  "min_weight": 1,
  "minimum_subtotal": 1,
  "procedure_kind": "EUTHANASIA",
  "sex": "MALE",
  "species": [
    "CANINE"
  ],
  "treatment_sheet_billing_type": "FIXED_RATE",
  "treatment_sheet_category": "BUNDLE",
  "vaccine_kind": "RABIES"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

group_service_id

integer

required

The ID of the group service to fetch

Response

200 - application/json

code

string

required

The unique service code for this service.

created_at

string<date-time>

required

The date and time the service was created.

has_fixed_subtotal

boolean

required

Whether this service should be priced as a fixed subtotal.

integer

required

The unique identifier for the service.

is_enabled

boolean

required

Whether the service is enabled.

is_removable

boolean

required

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

is_searchable_for_line_items

boolean

required

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

kind

required

The type of the service.

Available options:

PROCEDURE,

PRODUCT,

MEDICATION,

VACCINE,

LAB,

FEE,

SERVICE,

UNKNOWN,

CARE_PLAN

min_price

integer | null

required

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

Required range: x >= 0

name

string

required

The name of this service.

revenue_category_id

integer | null

required

The ID of the revenue category for this service.

service_pricing_category_id

integer

required

The ID of the pricing category for this service.

tax_category_id

integer

required

The ID of the tax category for this service.

unit_of_measure

required

The unit of measurement. This service is sold in increments of this unit.

Available options:

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

breeds

string[] | null

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_ids

integer[]

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.

default_duration_scales_with_quantity

boolean | null

Whether this service's default duration scales with quantity.

default_duration_unit

enum<string> | null

The unit of default duration used for this service. Only applicable when the kind is PROCEDURE, PRODUCT, MEDICATION, LAB, or SERVICE.

Available options:

DAY,

WEEK,

MONTH,

YEAR

default_duration_value

integer | null

The value of the default duration used for this service. Only applicable when the kind is PROCEDURE, PRODUCT, MEDICATION, LAB, or SERVICE.

Required range: x >= 1

default_durations

ExternalServiceVaccineDefaultDurationSchema · object[] | null

Per-reminder default durations for active standard care reminders linked to this vaccine service. Only applicable when the kind is VACCINE.

Show child attributes

default_location

enum<string> | null

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.

Available options:

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_price

integer | null

The default price for this service if not overridden elsewhere.

Required range: x >= 0

default_route

enum<string> | null

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.

Available options:

INTRACARDIAC,

INTRAMUSCULAR,

INTRANASAL,

INTRAPERITONEAL,

INTRAOSSEOUS,

INTRATESTICULAR,

INTRAVENOUS,

OCULAR,

ORAL,

ORAL_NERVE_BLOCK,

OTIC,

SUBCUTANEOUS,

TOPICAL

default_sig

string | null

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

default_treatment_kind

enum<string> | null

The default kind of treatment this service represents. Only applicable when the kind of the associated group service is PRODUCT or MEDICATION.

Available options:

IN_CLINIC,

TAKE_HOME

din

string | null

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_name

string | null

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

exclude_from_discounts

boolean | null

Whether this service is excluded from discounts.

has_in_clinic_dispense_fee

boolean | null

default:false

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

has_lot_number_for_treatments

boolean | null

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_treatments

boolean | null

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_treatments

boolean | null

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_fee

boolean | null

default:false

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

invoiced_as_non_integer

boolean | null

Whether this service is invoiced in integer increments or not.

is_altered

boolean | null

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

is_invoice_only

boolean | null

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

keywords

string[] | null

A list of keywords associated with this service.

max_age

integer | null

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

Required range: x >= 0

max_age_units

The unit in which the max_age is defined.

Available options:

DAY,

WEEK,

MONTH,

YEAR

max_quantity

The maximum quantity that can be invoiced for this service.

Required range: x >= 0

max_uses_per_charge

integer | null

The maximum number of uses per charge for this service.

max_weight

number | null

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

Required range: x >= 0

min_age

integer | null

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

Required range: x >= 0

min_age_units

The unit in which the min_age is defined.

Available options:

DAY,

WEEK,

MONTH,

YEAR

min_weight

number | null

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

Required range: x >= 0

minimum_subtotal

integer | null

The minimum subtotal in cents for this service.

Required range: x >= 0

procedure_kind

enum<string> | null

The kind of procedure this service represents. Only applicable when the kind of the associated group service is PROCEDURE.

Available options:

EUTHANASIA,

SPAY,

NEUTER,

OTHER

sex

The sex of a patient eligible for this service.

Available options:

MALE,

FEMALE,

UNKNOWN

species

(enum<string> | string)[] | null

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.

Available options:

CANINE,

FELINE,

EQUINE,

AVIAN,

BOVINE,

FERRET,

RABBIT,

RODENT,

REPTILE,

AMPHIBIAN,

FISH,

PORCINE,

CAPRINE,

SHEEP,

CAMELID,

RATITE,

MARSUPIAL,

MUSTELID,

CERVID,

PROCYONIDAE,

ERINACEIDAE,

MEPHITIDAE,

OTHER,

UNSPECIFIED

treatment_sheet_billing_type

enum<string> | null

The treatment sheet billing type for this service.

Available options:

FIXED_RATE,

MAX_USES_PER_CHARGE,

NON_CHARGEABLE

treatment_sheet_category

enum<string> | null

The treatment sheet category for this service, used for grouping in treatment sheet workflows.

Available options:

BUNDLE,

VITAL,

TASK,

NUTRITION,

FLUID,

PATIENT_CARE,

PROCEDURE,

PRODUCT,

MEDICATION,

VACCINE,

LAB,

SERVICE

vaccine_kind

enum<string> | null

The kind of vaccine this service represents. Only applicable when the kind of the associated group service is VACCINE.

Available options:

RABIES,

OTHER

⌘I

Fetch a service

curl --request GET \
  --url https://connect.vetcove.com/ext/v2/group-services/{group_service_id}/ \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://connect.vetcove.com/ext/v2/group-services/{group_service_id}/"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://connect.vetcove.com/ext/v2/group-services/{group_service_id}/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://connect.vetcove.com/ext/v2/group-services/{group_service_id}/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://connect.vetcove.com/ext/v2/group-services/{group_service_id}/"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://connect.vetcove.com/ext/v2/group-services/{group_service_id}/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "code": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "has_fixed_subtotal": true,
  "id": 123,
  "is_enabled": true,
  "is_removable": true,
  "is_searchable_for_line_items": true,
  "kind": "PROCEDURE",
  "min_price": 1,
  "name": "<string>",
  "revenue_category_id": 123,
  "service_pricing_category_id": 123,
  "tax_category_id": 123,
  "unit_of_measure": "APPLICATOR",
  "breeds": [
    "<string>"
  ],
  "clinic_location_group_ids": [],
  "default_duration_scales_with_quantity": true,
  "default_duration_unit": "DAY",
  "default_duration_value": 2,
  "default_durations": [
    {
      "standard_care_reminder_id": 123,
      "standard_care_reminder_name": "<string>",
      "default_duration_unit": "DAY",
      "default_duration_value": 2
    }
  ],
  "default_location": "RIGHT_SHOULDER",
  "default_price": 1,
  "default_route": "INTRACARDIAC",
  "default_sig": "<string>",
  "default_treatment_kind": "IN_CLINIC",
  "din": "<string>",
  "display_name": "<string>",
  "exclude_from_discounts": true,
  "has_in_clinic_dispense_fee": false,
  "has_lot_number_for_treatments": true,
  "has_route_and_location_for_treatments": true,
  "has_sig_for_treatments": true,
  "has_take_home_dispense_fee": false,
  "invoiced_as_non_integer": true,
  "is_altered": true,
  "is_invoice_only": true,
  "keywords": [
    "<string>"
  ],
  "max_age": 1,
  "max_age_units": "DAY",
  "max_quantity": 1,
  "max_uses_per_charge": 123,
  "max_weight": 1,
  "min_age": 1,
  "min_age_units": "DAY",
  "min_weight": 1,
  "minimum_subtotal": 1,
  "procedure_kind": "EUTHANASIA",
  "sex": "MALE",
  "species": [
    "CANINE"
  ],
  "treatment_sheet_billing_type": "FIXED_RATE",
  "treatment_sheet_category": "BUNDLE",
  "vaccine_kind": "RABIES"
}

Using the API

Developer guides

Accounts

Care plans

Catalog

Checkout links

Clients & patients

Clinics

External Rx

Insurance

Inbox

Invoices

Labs

Onboardings

Orders

Payments

PDFs

Prescriptions

Scheduler

Service pricing

Standard care

Subscriptions

File uploads

Inventory

Forms

Medical records

Authorizations

Path Parameters

Response