Vetspire API

Guides

Introduction GraphQL Guide

Queries

Triggers trigger triggers

Conversations conversation conversations unreadConversations unreadConversationsCount

Tasks overdueTasksCount task taskCategories tasks

Reminders reminders

Board activeBoardRows boardCell boardGroups boardRow

Inventory clientConsent diagnostic inventoryAdjustments productCategories productCategory productType productTypes

Entities consentForm consentForms customClientFields customPatientFields location locationChatMessages locations org rdvm rdvms searchLocationTags searchRdvms

Schedule appointment appointmentTypes appointments countAppointmentProviders countAppointments countViewerAppointments

Lab getInhouseDevices labOrder labOrders labResult labResults orgLab orgLabOrders orgLabResults orgLabs

Accounts client clients countNewClients provider providers searchAccounts totalClients viewer

Billing bills ccTerminals estimatePdf estimates invoicePdf order orderItems orders payments product products productsCount purchaseOrder purchaseOrders searchInventoryBuckets searchPackages searchProductCategories searchProductTypes searchProducts searchVendors vendor vendors

Clinical allergies diagnostics encounter encounterSummary encounterTypes encounters encountersUpdatedSince immunization immunizationPdf immunizations medicalRecordsSummary medication medications patient patientConsentForms patientDocument patientLabel patients rabiesCertificate searchDiagnoses searchMacros totalPatients treatments vitals

Hospital macro macros

Notifications notifications unreadNotificationsCount

Events events

NewBilling coupon coupons estimate estimateItems estimates orderFlag orderFlags patientSubscription patientSubscriptions payment productPackage productPackages revenueCenter revenueCenterBudgets revenueCenters

Mutations

Triggers createTrigger deleteTrigger updateTrigger

Payroll clockIn clockOut createProviderPunch updateProviderPunch

Notifications deleteNotification readAllNotifications readNotification

Comments comment

Hospital createClinicalNote createHospitalization createMacro deleteMacro updateClinicalNote updateEncounterType updateHospitalization updateMacro

Board addPatientToBoard completeBoardCell createBoardCell invoiceBoardRow promoteEstimateToBoard uncompleteBoardCell updateBoardCell updateBoardRow

Accounts addClientAddress addClientStripeInfo addCoowner createBridgeUser createClient createClientTag createCustomClientFieldValue createProvider deleteAddress deleteClientTag deleteCoowner mergeClients removeClientStripeInfo resendVerification sendClientCheckinLink updateAddress updateClient updateClientTag updateCoowner updateCustomClientFieldValue updateProvider updateViewer updateViewerPassword uploadProviderElectronicSignature

Lab createOrgLab deleteLabOrder deleteOrgLab finishLabOrder orderLab updateLabOrder updateOrgLab

Reminders createReminder deleteReminder updateReminder

Tasks assignProviderToTask createTask createTaskCategory deleteTaskCategory unassignProviderFromTask updateTask updateTaskCategory

Conversations createConversation sendMessage updateConversation

Inventory createDiagnostic createInventoryAdjustment createProductCategory createProductType deleteDiagnostic deletePendingInvoiceItem deleteProductCategory deleteProductType generateInventoryReport updateDiagnostic updatePendingInvoiceItem updateProductCategory updateProductType

NewBilling chargeOrder createRevenueCenter refundPayment deleteOrderFlag createProductPackageItem updateEstimateItem updatePayment updateRevenueCenter createBillingNote createEstimateItem updateRevenueCenterBudget addPackageToPackage deleteRevenueCenter chargeEstimate updateOrderFlag deleteEstimate renewSubscription createProductPackage deleteEstimateItem createCoupon reinstateSubscription updateProductPackageItem createRevenueCenterBudget deletePackagePackage createEstimate updateEstimate updateProductPackage updateCoupon deleteCoupon createOrderFlag voidPayment deleteProductPackageItem deleteProductPackage chargeClient

Schedule createAppointment createAppointmentType createLocationProviderSchedule createLocationSchedule deleteAppointment deleteAppointmentType deleteLocationProviderSchedule deleteLocationSchedule makeAppointmentTypeDefault updateAppointment updateAppointmentIntake updateAppointmentType updateLocationHours updateLocationProviderSchedule updateLocationSchedule

Entities addOrgPaymentSource assignProviderToLocation createClientRdvm createConsentForm createCustomClientField createCustomLocationAttribute createCustomPatientField createLocation createLocationAttribute createOrgPreference createRdvm deleteClientRdvm deleteConsentForm deleteCustomClientField deleteCustomLocationAttribute deleteCustomPatientField deleteLocation deleteRdvm makeLocationDefault removeOrgPaymentSource sendLocationChatMessage unassignProviderFromLocation updateClientRdvm updateConsentForm updateCustomLocationAttribute updateLocation updateLocationAttribute updateOrg updateOrgPreference updateRdvm uploadLocationLogo uploadOrgLogo

Billing cancelSubscription createOrder addOrderItemToEncounter updateOrder updateProduct endOfDayReport updateOrderItem addLinkedProduct cancelSubscriptionSilently newVendor updateProductProductCategory deleteWishlistItem deleteOrderItem billingStatement createPurchaseOrder refundOrderItem deleteLinkedProduct addPackageToEstimate addPendingInvoiceItem updateVendor upsertProductLocationMarkup convertEstimateToOrder deleteOrder addPackageToEncounter addOrderItem deletePurchaseOrderItem addToWishlist addPackageToOrder applyAccountCredit updateLocationDistribution subscribePatients deletePurchaseOrder generateInvoice deleteProduct addPurchaseOrderItem reopenOrder updatePurchaseOrderItem updateWishlistItem updatePurchaseOrder createProduct invoicePendingItems orderWishlist reorderOrderItems

Clinical createPatient prescribeMedication signEncounter recordPatientWeight createAllergy createCustomPatientFieldValue newEncounter assignProblemToEncounter updateImmunization deleteAllergy deleteProblem updateMedication captureClientConsent emailEstimateToClient unassignProblemFromEncounter deletePatientDocument deleteMedication deleteEncounter emailImmunizationsRecord uploadPatientImage mergePatients updateProblem emailInvoiceToClient updatePatient copyFromPreviousEncounter emailEncounterRecordToRdvms addTreatment updateEncounter emailEncounterRecord createEncounterOrder updateAllergy emailRabiesCertificate createProblem updatePatientDocument uploadPatientDocument refillMedication copyMedicationsToEncounter createImmunization updateCustomPatientFieldValue registerPatientMicrochip

Objects

OrderFlag ProductType Medication LocationAttribute CustomClientField BillingNote Comment ImmunizationDatum AvailableTimeSlot LabDevice RevenueCenter Cage Rdvm EncounterProduct RevenueCenterBudget LocationProviderSchedule WishlistItem Macro Immunization ClientResult ClientRdvm Notification ConsentForm Coupon Vitals Order RepeatingEvent LocationDistribution Hospitalization TextDatum ProductCategory BoardGroup AnalyticsData LabOrder CustomPatientField AppointmentIntakeData InventoryAdjustment Allergy PendingRxDatum LabResult Reminder Location ProductPackageItem OrgPreference Highlight EstimateItem AnalyticsDataRowBreakdown CustomLocationAttribute PlanOption CustomPatientFieldValue FormulaDatum Problem Provider EncounterType TriggerCreateTaskOptions Task ApolloAudience NotificationMetadata AppointmentType InventoryLevel TriggerSendEmailOptions Diagnosis ClinicalNote PhoneNumber TriggerDefaultOptions TriggerAddOrderItemOptions EncounterSection PurchaseOrderItem Event Treatment PendingImmunizationDatum Diagnostic CustomVital TaskCategory Payment LocationChatMessage DateCount Plan LocationSchedule PatientPlan Message PatientDocument Coowner ApptCountProviders Client VitalsTemplate Estimate DropdownDatum EmailTemplate FieldDatum Address Vendor ClientConsent PaymentSource RootQueryType Conversation OrgLab ProviderPunch RxDatum OldDatum Patient RootMutationType ClientTag Appointment OrderItem Org Trigger Product Weight BoardRow LocationHours ElectronicSignature PatientSubscription InventoryBucket OrgSubscription AutoMessage SketchDatum Encounter BoardCell ValuesetDatum CustomClientFieldValue TriggerWebhookOptions NoteDatum ValuesetDatumOption PatientPlanItem PendingPackageDatum VitalDatum ProductPackage TreatmentDatum ProviderRole AnalyticsDataRow Viewer TestResult PurchaseOrder PendingInvoiceItem

Unions

MessageSender Bill EncounterOrEstimate

Input Objects

CouponInput BillingNoteInput ClientRdvmInput WishlistItemInput LocationAttributeInput EmailTemplateInput PatientDocumentInput PlanOptionInput OrgInput ApolloAudienceInput PaymentSourceInput PurchaseOrderInput DiagnosticInput TaskCategoryInput ClinicalNoteInput AppointmentTypeInput ProviderViewerInput LabOrderInput RevenueCenterBudgetInput ReminderInput InventoryAdjustmentInput OrderInput TaskInput AddressInput CustomPatientFieldInput OrgLabInput HospitalizationInput CustomLocationAttributeInput ProductCategoryInput CustomClientFieldInput ProviderRoleInput ConsentFormInput BoardCellInput AppointmentInput ProductTypeInput EncounterProductInput PatientFilters CoownerInput PurchaseOrderItemInput AllergyInput EstimateInput ClientTagInput MacroInput PendingInvoiceItemInput ClientsTagsInput EstimateItemInput ProductInput RepeatingEventInput ClientInput PatientInput AppointmentIntakeDataInput PaymentInput OrderItemInput RdvmInput InventoryBucketInput PhoneNumberInput ProblemInput Filter VitalsTemplateInput VitalsInput EncounterInput ProductTypeFlags ProductPackageItemInput EventMetadataFilter BoardRowInput LocationScheduleInput LocationHoursInput CustomVitalInput VendorInput ImmunizationInput ProductPackageInput RevenueCenterInput LocationProviderScheduleInput OrgPreferenceInput LocationFilters ConversationInput ProviderPunchInput LowStockThresholdInput LocationInput OrderFlagInput ClientFilters AutoMessageInput ProviderInput TriggerInput MedicationInput TreatmentInput EncounterTypeInput AnalyticsFieldModifier

Enums

AnalyticsBreakdown MedicationStatus CommentableEntityType TriggerThen EncounterTypeEnum AnalyticsField DiscountType ImmunizationType PlanInterval PurchaseOrderStatus OrgLabType SortOptions FilterField PaymentMethod InvoiceStatus Sex WeightUnit AnalyticsDataRowModifier TriggerIf ReminderEvent AppointmentStatus ProductApplicationType ReminderType ProblemType TimeSegment AnalyticsSegment ImmunizationStatus ConversationMedium AddressUse Comparison

Scalars

Int Date NaiveDateTime Price Decimal DateTime Numrange Boolean Upload JSON String ID

Object » OrderItem

An order item is a single line item of an order that registers the bill for a product

Fields

credited (Boolean)

creditedQuantity (Decimal)

date (Date)

discounted (Boolean)

dispenseFee (Decimal)

id (ID)

inPackage (Boolean)

insertedAt (NaiveDateTime)

isPackage (Boolean)

isTaxed (Boolean)

lotNumber (String)

name (String)

order (Order)

package (ProductPackage)

patient (Patient)

percentDiscounted (Decimal)

position (Int)

priceIncluded (Boolean)

product (Product)

productId (ID)

provider (Provider)

quantity (Decimal)

refunded (Boolean)

refundedQuantity (Decimal)

returned (Boolean)

returnedQuantity (Decimal)

totalPrice (Decimal)

unitPrice (Decimal)

updatedAt (NaiveDateTime)