Guides

Introduction GraphQL Guide

Queries

Telemedicine videoRoomToken

Treatment treatmentSheet treatmentSheetTemplate treatmentSheetTemplates treatmentSheets treatmentSummary

Marketing newsletter newsletters

Rdvms contacts getRdvmRecentPatients rdvm rdvmContact rdvmDocument rdvms rdvmsCount searchRdvms visits visitsCount

Tasks overdueTasksCount task taskCategories tasks tasksCount

Lab getInhouseDevices labOrder labOrders labResult labResults labTests modalities orgLab orgLabOrders orgLabResults orgLabs orphanedLabs storedLabTests

Entities alert alerts cages clientReferralSource clientReferralSources consentForm consentForms customClientFields customPatientFields departments emailAttachmentIntegration emailAttachmentIntegrations encounterType entityValidations fileFolders files isDaycareOpen location locationChatMessages locationTag locationTags locations locationsDepartments org providerDepartments searchLocationTags searchPrintnodeComputers searchPrintnodePrinters

Boarding availableCages boardingCages boardingWards bookedDays reservation reservationKennelPdf reservationTypes reservations

Conversations conversation conversations conversationsPaginated openConversationsCount unreadConversations unreadConversationsCount

VoiceCall activeVoiceCalls callLog callLogs callLogsCount dialpadOffices recentVoiceCalls recentVoiceCallsCount

Accounts addresses apiKeys checkDuplicatePhoneNumber client clientTag clientTags clients clientsCount coowners countNewClients externalCommPreferences externalSearch phoneNumbers provider providerAuthToken providerRole providerRoles providers searchAccounts totalClients viewer viewerSubscription

Triggers trigger triggers

NewBilling coupon coupons estimate estimateItems orderFlag orderFlags payment productPackage productPackages reconciliationNotes revenueCenter revenueCenterBudgets revenueCenters voidablePaymentMethods

Reminders reminders sentReminders

Hospital hospitalizations

Board activeBoardRows boardCell boardGroups boardRow

Notifications alertNotifications notifications unreadNotificationsCount

Plan patientPlan patientPlans patientPlansCount plan preventionPlan preventionPlans

Analytics analytics count usageReport

Clinical allergies complication complications customPatientFieldValues diagnostics encounter encounterProducts encounterSummary encounterTypes encounters encountersUpdatedSince immunization immunizationPdf immunizations immunizationsDue lapsingPatients macro macros macrosCount mandatoryConsentForms medicalRecordsSummary medication medications patient patientComplication patientConsentForms patientDocument patientLabel patientProtocols patientQrCode patientTag patientTags patients problems rabiesCertificate rabiesCertificates searchDiagnoses searchEmailAttachments searchMacros totalPatients treatments vitals vitalsTemplate

Inventory clientConsent diagnostic fulfillmentSource fulfillmentSources inventoryAdjustment inventoryAdjustments productCategories productCategory productHistory productType productTypes

Schedule appointment appointmentReminders appointmentTypeTag appointmentTypeTags appointmentTypes appointments availableTimes countAppointmentProviders countAppointments countViewerAppointments locationAppointmentTypes locationSchedules scheduleTemplate scheduleTemplates selfCheckInLink

NewBilling coupon coupons estimate estimateItems orderFlag orderFlags payment productPackage productPackages reconciliationNotes revenueCenter revenueCenterBudgets revenueCenters voidablePaymentMethods

Billing bills ccTerminals creditMemos creditMemosTotals estimatePdf estimates estimatesTotals hasBalanceDue inCollections invoicePdf ledgerEntries ledgerEntryTotals masterProducts order orderItems orderItemsTotals orders ordersTotals packs payments paymentsTotals processorPayments product productManufacturer productManufacturers productManufacturersPaginated products productsCount productsInStockCount purchaseOrder purchaseOrders refundedOrderItems returnedOrderItems searchCoupons searchInventoryBuckets searchPackages searchProductCategories searchProductTypes searchProductables searchProducts searchVendors stripeConnectionToken stripePublishableKey vendor vendors

Mutations

Triggers createTrigger deleteTrigger updateTrigger

Conversations createConversation deleteMessage sendMessage startConversation updateConversation upsertMessage

License createLicense deleteLicense updateLicense

Billing addCreditMemo addLinkedProduct addOrderItem addOrderItemToEncounter addPackageToEncounter addPackageToEstimate addPackageToOrder addPurchaseOrderItem addToWishlist applyAccountCredit billingHistory billingStatement convertEstimateToOrder createOrder createProduct createProductManufacturer createPurchaseOrder createStripePaymentIntent creditMemoPdf deleteLinkedProduct deleteOrder deleteProduct deleteProductManufacturer deletePurchaseOrder deletePurchaseOrderItem deleteWishlistItem emailClientBillingStatement emailClientPaymentReceipt emailCreditMemoToClient emailEstimateToClient emailInventoryCsv emailInvoiceToClient emailProductsCsv endOfDayReport generateInvoice groupOrderItemsByPatient invoiceBarcodesPdf invoicePendingItems issueCreditDiscount markOrderUncollectible newVendor orderWishlist paymentReceiptPdf refundOrderItem reopenOrder reorderEstimateItems reorderOrderItems returnOrderItem saveEstimate sendPaymentRequest updateOrder updateOrderItem updateProductManufacturer updateProductProductCategory updatePurchaseOrder updatePurchaseOrderItem updateVendor updateWishlistItem uploadMassProducts upsertLowStockThreshold upsertPackageLocationMarkup upsertProductLocationMarkup upsertProductTypeLocationMarkup

Telemedicine endVideoCall

Comments comment updateComment

Treatment addTreatmentSheetCellComment addTreatmentSheetRow createTreatmentSheet createTreatmentSheetCell createTreatmentSheetTemplate deleteTreatmentSheet deleteTreatmentSheetRow deleteTreatmentSheetRowAdditiveEntry deleteTreatmentSheetTemplate saveTreatmentSheetCellOrderItem saveTreatmentSheetRowAdditiveEntry signTreatmentSheet updateTreatmentSheet updateTreatmentSheetCell updateTreatmentSheetRow updateTreatmentSheetStart updateTreatmentSheetTemplate updateTreatmentSheetTimeSlots

Schedule createAppointment createAppointmentReminder createAppointmentType createAppointmentTypeTag createLocationProviderSchedule createLocationSchedule createScheduleTemplate deleteAppointment deleteAppointmentReminder deleteAppointmentType deleteAppointmentTypeTag deleteLocationProviderSchedule deleteLocationSchedule deleteScheduleTemplate makeAppointmentTypeDefault sendApptConfirmation setApptPickupTime textApptReady updateAppointment updateAppointmentIntake updateAppointmentType updateAppointmentTypeTag updateLocationHours updateLocationProviderSchedule updateLocationSchedule updateScheduleTemplate

Rdvms createRdvm createRdvmContact createRdvmVisit deleteRdvm deleteRdvmDocument deleteRdvmVisit emailRdvmsCsv mergeRdvms updateRdvm updateRdvmContact updateRdvmVisit uploadMassRdvms uploadRdvmDocument

Reminders createReminder createReminderSilence deleteReminder updateReminder updateReminderSilence

Tasks assignProviderToTask createTask createTaskCategory createUserTask deleteTaskCategory unassignProviderFromTask updateTask updateTaskCategory

Plan addPatientPlanItem cancelPlan createPreventionPlan enrollPlan refreshPreventionPlan removePatientPlanItem updatePatientPlan updatePatientPlanItem updatePreventionPlan

Entities acquireFaxNumber acquireTollFreeNumber acquireTwilioPhoneNumber assignProviderToLocation createAlert createCage createClientRdvm createClientReferralSource createConsentForm createCustomClientField createCustomLocationAttribute createCustomPatientField createDepartment createEmailAttachmentIntegration createEntityValidation createLocation createLocationAttribute createLocationTag createOrgPreference deleteAlert deleteCage deleteClientRdvm deleteClientReferralSource deleteConsentForm deleteCustomClientField deleteCustomLocationAttribute deleteCustomPatientField deleteDepartment deleteEmailAttachmentIntegration deleteEncounterType deleteEntityValidation deleteLocation deleteLocationTag fileDownloadLink loginGoogleCloudPrint mergeClientReferralSources removeGoogleCloudPrintCredentials reorderClientReferralSources sendLocationChatMessage setChatLastReadAt setDaycareOpen unassignProviderFromLocation updateAlert updateCage updateClientRdvm updateClientReferralSource updateConsentForm updateCustomLocationAttribute updateDepartment updateEmailAttachmentIntegration updateEntityValidation updateLocation updateLocationAttribute updateLocationTag updateOrg updateOrgPreference uploadClinicImage uploadLocationLogo uploadOrgLogo

NewBilling addEstimateItem addPackageToPackage applyCoupon applyEstimateCoupon autoApplyCoupons autoApplyEstimateCoupons chargeClient chargeEstimate chargeOrder copyPackage createBillingNote createCoupon createEstimate createEstimateItem createOrderFlag createProductPackage createProductPackageItem createProductPrice createReconciliationNote createRevenueCenter createRevenueCenterBudget declinePackage deleteAppliedCoupon deleteAppliedEstimateCoupon deleteCoupon deleteEstimate deleteEstimateItem deleteOrderFlag deleteOrderItem deletePackagePackage deleteProductPackage deleteProductPackageItem deleteProductPrice deleteRevenueCenter markOrderPaidIfFullyPaid refundPayment updateCoupon updateEstimate updateEstimateItem updateEstimateItems updateOrderFlag updateOrderItems updatePayment updateProduct updateProductPackage updateProductPackageItem updateProductPrice updateReconciliationNote updateRevenueCenter updateRevenueCenterBudget voidPayment

Payroll clockIn clockOut createProviderPunch deleteProviderPunch updateProviderPunch

Analytics downloadUsageReport emailUsageReport

VoiceCall convertCallLogToAppointment createCallLog createVoiceCallLog deleteCallLog dismissVoiceCalls linkCall unlinkCall updateCallLog updateDialpadSubscription updateVoiceCall

Accounts addClientAddress addClientStripeInfo addCoowner createApiKey createBridgeUser createClient createClientTag createCustomClientFieldValue createProvider createProviderRole deleteAddress deleteApiKey deleteClientTag deleteCoowner deleteProviderRole emailClientsAddresses generateClientAuthToken mergeClients removeClientStripeInfo resendVerification saveProviderElectronicSignature sendClientCheckinLink sendEmailVerification syncClient updateAddress updateClient updateClientExternalCommPreferences updateClientTag updateCoowner updateCustomClientFieldValue updatePhoneNumber updateProvider updateProviderRole updateViewer updateViewerPassword uploadProviderElectronicSignature uploadProviderProfileImage upsertProviderAppointmentTypeLimit upsertProviderCommission upsertProviderPreferences

Clinical addLinkedClinicalNote addLinkedEncounter addTreatment assignProblemToEncounter attachGmailAttachmentToEncounter cancelVetsourceOrder captureClientConsent clientConsentLink copyFromPreviousEncounter copyMedicationsToEncounter createAllergy createApptVitals createComplication createCustomPatientFieldValue createCustomPatientProtocol createEncounterOrder createEncounterSection createEncounterSectionDatum createEncounterType createImmunization createMacro createParentProblem createPatient createPatientComplication createPatientTag createProblem createVitals deleteAllergy deleteClientConsent deleteComplication deleteEncounter deleteEncounterSection deleteEncounterSectionDatum deleteLinkedClinicalNote deleteLinkedEncounter deleteMacro deleteMedication deletePatientComplication deletePatientDocument deletePatientTag deleteProblem deleteVitals emailEncounter emailEncounterPdf emailEncounterRecord emailEncounterRecordToCustom emailEncounterRecordToRdvms emailHospitalizationNoticeToRdvms emailImmunizationsRecord emailMedicalRecordsSummary emailRabiesCertificate emailSelectedRabiesCertificates encounterPdf genVetsourceUrl markAllNormalEncounter massMicrochipRegister mergePatients movePatientToClient newEncounter orderVetsource prescribeMedication printLabelPrintnode pushMedicationToCubex pushToCubex pushTreatmentToCubex recordPatientWeight refillMedication regeneratePatientProtocols registerPatientMicrochip reopenEncounter replaceEncounterSectionDatum saveMicrochip sendEstimateConsentDepositLink sendSurveyLink signEncounter surgeryLogPdf transferPatient triggerPrescription unassignProblemFromEncounter updateAllergy updateComplication updateCustomPatientFieldValue updateCustomPatientProtocol updateEncounter updateEncounterSection updateEncounterSectionDatum updateEncounterType updateImmunization updateLinkedClinicalNote updateLinkedEncounter updateMacro updateMedication updatePatient updatePatientComplication updatePatientDocument updatePatientTag updateProblem updateVitals uploadEncounterTypeAsset uploadPatientDocument uploadPatientImage valuesetLabel

Lab addReviewerToLabResult cancelLabOrder createOrgLab deleteLabOrder deleteLabResult deleteOrgLab emailLabResult finishLabOrder onboardPetdxLab orderLab refreshLabResult removeReviewerFromLabResult retryLabOrderPlacement testLabCredentials updateLabOrder updateLabResult updateOrgLab

Notifications deleteNotification readAllNotifications readNotification

Marketing createNewsletter sendNewsletter sendNewsletterTest updateNewsletter

Boarding checkInReservation checkOutReservation createBoardingBlock createBoardingCage createBoardingWard createReservation createReservationEstimate deleteBoardingBlock deleteBoardingCage deleteBoardingWard deleteReservation reorderBoardingCages reorderBoardingWards updateBoardingBlock updateBoardingCage updateBoardingWard updateReservation

NewBilling addEstimateItem addPackageToPackage applyCoupon applyEstimateCoupon autoApplyCoupons autoApplyEstimateCoupons chargeClient chargeEstimate chargeOrder copyPackage createBillingNote createCoupon createEstimate createEstimateItem createOrderFlag createProductPackage createProductPackageItem createProductPrice createReconciliationNote createRevenueCenter createRevenueCenterBudget declinePackage deleteAppliedCoupon deleteAppliedEstimateCoupon deleteCoupon deleteEstimate deleteEstimateItem deleteOrderFlag deleteOrderItem deletePackagePackage deleteProductPackage deleteProductPackageItem deleteProductPrice deleteRevenueCenter markOrderPaidIfFullyPaid refundPayment updateCoupon updateEstimate updateEstimateItem updateEstimateItems updateOrderFlag updateOrderItems updatePayment updateProduct updateProductPackage updateProductPackageItem updateProductPrice updateReconciliationNote updateRevenueCenter updateRevenueCenterBudget voidPayment

Hospital createClinicalNote createHospitalization createHospitalizationTask updateClinicalNote updateHospitalization updateHospitalizationTask

Board addPatientToBoard completeBoardCell createBoardCell deleteBoardCell invoiceBoardRow promoteEstimateToBoard uncompleteBoardCell updateBoardCell updateBoardRow

Inventory createDiagnostic createFulfillmentSource createInventoryAdjustment createProductCategory createProductType deleteDiagnostic deleteFulfillmentSource deletePendingInvoiceItem deleteProductCategory deleteProductType generateInventoryReport generateUsageSummaryReport reassignProductType updateDiagnostic updateFulfillmentSource updatePendingInvoiceItem updateProductCategory updateProductEnabled updateProductType uploadMassInventory

Objects

Address Alert AlertNotification Allergy AnalyticsData AnalyticsDataRow AnalyticsDataRowBreakdown ApiKey Appointment AppointmentIntakeData AppointmentReminder AppointmentType AppointmentTypeTag ApptCountProviders Attachment AutoMessage AvailableTimeSlot BillingNote BoardCell BoardGroup BoardRow BoardingCage BoardingWard Cadence Cage CallLog CheckboxDatum ChecklistDatum Client ClientConsent ClientExternalCommPreferencesValue ClientRdvm ClientReferralSource ClientResult ClientTag ClinicalNote Comment Complication Conditional ConsentForm Conversation ConversationPage Coowner CoownerBreakdown Coupon CreditMemo CreditMemoTotals Cursor CustomClientField CustomClientFieldValue CustomLocationAttribute CustomPatientField CustomPatientFieldValue CustomPatientProtocol CustomVital DatasyncLog DatasyncRecords DateCount Department DeprecatedVitalDatum Diagnosis Diagnostic DialpadOffice DropdownDatum ElectronicSignature EmailAttachment EmailAttachmentIntegration EmailStatus EmailTemplate Encounter EncounterMetadata EncounterProduct EncounterSection EncounterType EncounterVersion EntitiesTag EntityTag EntityTagGroup EntityValidation Estimate EstimateItem EstimatesTotals Event ExternalSearchResult ExtraField FeatureFlag FieldDatum FieldDatumPart File FileResults FormDatum FormulaDatum FulfillmentSource Highlight Hospitalization HospitalizationTask ImageDatum Immunization ImmunizationDatum InventoryAdjustment InventoryBucket InventoryLevel InventoryLog LabDevice LabOrder LabResult LabTest LedgerEntry LedgerEntryTotals License LinkedClinicalNote LinkedEncounter Location LocationAttribute LocationChatMessage LocationHours LocationKpi LocationProviderSchedule LocationSchedule LocationTag LowStockThreshold Macro MassUploadResult MasterProduct Medication Message Modality MonitorDatum Monograph MonographGuide MonographSection RootMutationType Newsletter NoteDatum Notification NotificationMetadata ObanJob OldDatum Order OrderFlag OrderItem OrderItemsTotals OrdersTotals Org OrgLab OrgPreference OrgSubscription Pack Patient PatientComplication PatientDocument PatientPlan PatientPlanItem PatientProtocol PatientSubscription PatientTag Payment PaymentSource PaymentsTotals PendingImmunizationDatum PendingInvoiceItem PendingPackageDatum PendingRxDatum PhoneNumber PlanOption PlumbsHandout PreventionPlan PriceChange PriceChangeFilter PriceTier PrintLabelResult PrintnodeComputersField PrintnodePrintersField Problem ProcessorPayment Product ProductCategory ProductManufacturer ProductManufacturerPage ProductMetadataField ProductPackage ProductPackageItem ProductPrice ProductType Protocol ProtocolReminder Provider ProviderAppointmentTypeLimit ProviderCommission ProviderPreferences ProviderPunch ProviderRole PurchaseOrder PurchaseOrderItem RootQueryType Rdvm RdvmContact RdvmDocument RdvmRecentPatients RdvmVisit ReconciliationNote Reminder ReminderSilence RepeatingEvent Reservation ReservationNightlyPrice ReservationType ReturnedOrderItem RevenueCenter RevenueCenterBudget RowUploadError RxDatum ScheduleTemplate ScheduleTemplateRange SentAutoMessage SentReminder SketchDatum StripeAddress StripeBillingDetails StripeCard StripeClientSecret StripeCustomer StripeCustomerEvent StripeInvoiceSettings StripePaymentIntent StripePaymentMethod StripeReader StripeUsBankAccount RootSubscriptionType SyncClientResult Task TaskCategory TeletailsSession TestResult TextDatum Treatment TreatmentDatum TreatmentSheet TreatmentSheetCell TreatmentSheetCellComment TreatmentSheetRow TreatmentSheetRowAdditive TreatmentSheetRowAdditiveEntry TreatmentSheetRowBolus TreatmentSheetRowFluid TreatmentSheetTemplate TreatmentTimeInterval Trigger TriggerAddOrderItemOptions TriggerCreateTaskOptions TriggerDefaultOptions TriggerSendEmailOptions TriggerWebhookOptions UsageReport UsageReportTotals ValuesetDatum ValuesetDatumOption Vendor VetspireSubscription VetspireSubscriptionTier Viewer VitalDatum Vitals VitalsTemplate VoiceCall Weight WishlistItem

Unions

Bill LocationOrLocationTag MessageSender Orderable

Input Objects

AddressInput AlertInput AllergyInput AnalyticsFieldModifier AppointmentInput AppointmentIntakeDataInput AppointmentReminderInput AppointmentTypeInput AppointmentTypeTagInput AutoMessageInput BillingNoteInput BoardCellInput BoardRowInput BoardingBlockInput BoardingCageInput BoardingWardInput CadenceInput CageInput CallLogInput ClientExternalCommPreferencesInput ClientFilters ClientInput ClientRdvmInput ClientReferralSourceInput ClientTagInput ClientsTagsInput ClinicalNoteInput ComplicationInput ConditionalInput ConsentFormInput ConversationInput ConversationSetAttachment CoownerInput CouponInput CreditMemoInput CustomClientFieldInput CustomLocationAttributeInput CustomPatientFieldInput CustomPatientProtocolInput CustomVitalInput DepartmentInput DiagnosticInput EmailAttachmentIntegrationInput EmailTemplateInput EncounterInput EncounterMetadataInput EncounterProductInput EncounterSectionInput EncounterTypeInput EntitiesTagInput EntityTagGroupInput EntityTagInput EntityValidationInput EstimateInput EstimateItemInput EventMetadataFilter ExternalSearchInput ExtraFieldInput Filter FulfillmentSourceInput HospitalizationInput HospitalizationTaskInput ImmunizationInput InventoryAdjustmentInput InventoryBucketInput LabOrderInput LabResultInput LicenseInput LinkedClinicalNoteInput LinkedEncounterInput LocationAttributeInput LocationFilters LocationHoursInput LocationInput LocationProviderScheduleInput LocationScheduleInput LocationTagInput LowStockThresholdInput MacroInput MedicationInput NewsletterInput OrderFlagInput OrderInput OrderItemInput OrgInput OrgLabInput OrgPreferenceInput PatientComplicationInput PatientDocumentInput PatientFilters PatientInput PatientPlanFilters PatientPlanInput PatientPlanItemInput PatientRegistration PatientTagInput PaymentInput PaymentSourceInput PendingInvoiceItemInput PhoneNumberInput PlanOptionInput PreventionPlanInput PriceChangeFilterInput PriceChangeInput PriceTierInput PrinterInput ProblemInput ProductCategoryInput ProductInput ProductManufacturerInput ProductMetadataFieldInput ProductPackageInput ProductPackageItemInput ProductPriceInput ProductTypeFlags ProductTypeInput ProtocolInput ProtocolReminderInput ProviderAppointmentTypeLimitInput ProviderCommissionInput ProviderInput ProviderPreferencesInput ProviderPunchInput ProviderRoleInput ProviderViewerInput PurchaseOrderInput PurchaseOrderItemInput RdvmContactInput RdvmInput RdvmVisitInput ReconciliationNoteInput ReminderInput ReminderSilenceInput RepeatingEventInput ReservationFilters ReservationInput RevenueCenterBudgetInput RevenueCenterInput SaveTreatmentSheetCellOrderItemInput ScheduleTemplateInput ScheduleTemplateRangeInput SyncClientInput TaskCategoryInput TaskInput TeletailsSessionInput TreatmentInput TreatmentSheetCellInput TreatmentSheetInput TreatmentSheetRowAdditiveEntryInput TreatmentSheetRowAdditiveInput TreatmentSheetRowBolusInput TreatmentSheetRowFluidInput TreatmentSheetRowInput TreatmentSheetTemplateInput TreatmentTemplateSection TreatmentTimeIntervalInput TriggerInput VendorInput VitalsInput VitalsTemplateInput VoiceCallInput WishlistItemInput

Enums

AddressUse AnalyticsBreakdown AnalyticsDataRowModifier AnalyticsField AnalyticsSegment AppointmentStatus CadenceContactMethods CommentableEntityType Comparison ConditionalOperator ContactType ConversationMedium DiscountType DoubleBookingConstraint EncounterPdfType EncounterSummaryDocumentType EncounterTypeEnum EstimateStatus EstimateType EventType Eye FeatureFlagEnum FilterField ImmunizationStatus ImmunizationType InferredResultTypes InvoiceSortFieldEnum InvoiceStatus IsoCountry LabelSize LicenseType MedicationStatus ObanJobState OrderByEnum OrgLabType PaymentMethod PaymentSort PlanInterval PriceChangeFilterType PriceChangeStatus PriceChangeType PriceType PricingType ProblemType ProductApplicationType Pronouns PurchaseOrderStatus ReminderEvent ReminderType ReservationCategory ReservationStatus ReservationStatusFilter ReservationTime ReturnedOrderItemType RouteType Severity Sex SortFieldEnum SortOptions SortProductOptions SubscriptionModel TimeSegment TreatmentSheetFormat TreatmentSheetRowFluidType TreatmentSheetType TreatmentSheetUnits TriggerIf TriggerThen TriggeredProtocolsSortFieldEnum WeightUnit

Scalars

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

Enum » ConversationMedium

Values

APP

EMAIL

FACEBOOK

FAX

OTHER

POSTCARD

SMS

WEBSITE_CHAT