Guides

Queries

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

Triggers trigger triggers

Plan patientPlan patientPlans patientPlansCount plan preventionPlan preventionPlans

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

Board activeBoardRows boardCell boardGroups boardRow

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

Rdvms contacts getRdvmRecentPatients rdvm rdvmContact rdvmDocument rdvms rdvmsCount searchRdvms visits visitsCount

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

Treatment treatment treatmentSheet treatmentSheetTemplate treatmentSheetTemplates treatmentSheets treatmentSummary

Billing accountCreditHistory accountsReceivableBalance bills ccTerminals creditMemos creditMemosTotals discountReasons estimatePdf estimates estimatesTotals getCardconnectBaseUrlBySlug getCardconnectCardInfo hasBalanceDue inCollections invoicePdf masterProducts order orderItems orderItemsTotals orderLineItems orders ordersTotals packs paymentProviders 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

Inventory clientConsent diagnostic fulfillmentSource fulfillmentSources inventoryAdjustment inventoryAdjustments productCategories productCategory productHistory productType productTypes stockLocation stockLocations stockTransfer stockTransfers

Marketing newsletter newsletters

Hospital hospitalizations

Telemedicine videoRoomToken

Boarding availableCages boardingCages boardingWards bookedDays reservation reservationKennelPdf reservations

VoiceCall activeVoiceCalls callLog callLogs callLogsCount dialpadOffices recentVoiceCalls recentVoiceCallsCount

Reminders reminders sentReminders

Analytics analytics count usageReport

Notifications notifications unreadNotificationsCount

Events events eventsPaginated

Conversations conversation conversations conversationsPaginated openConversationsCount unreadConversations unreadConversationsCount

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

Tasks listTasks overdueTasksCount task taskCategories taskGroups tasks tasksCount

Clinical allergies complication complications dashboard diagnostics encounter encounterProducts encounterSummary encounterTypes encounters encountersUpdatedSince immunization immunizationPdf immunizations immunizationsDue lapsingPatients listEncounters macro macros macrosCount mandatoryConsentForms medication medications ordersPendingApprovalCounts patient patientComplication patientConsentForms patientDiagnostics patientDocument patientEncounterProducts patientLabel patientProtocols patientQrCode patientTag patientTags patientTreatments patients pharmacyMedications pharmacyMedicationsCount problems rabiesCertificate rabiesCertificates searchDiagnoses searchMacros totalPatients treatments visit vitals vitalsTemplate

Mutations

Comments comment updateComment

Telemedicine endVideoCall

Plan addPatientPlanItem cancelPlan createPreventionPlan enrollPlan linkPatientPlanChargeToOrderItem refreshPreventionPlan removePatientPlanItem updatePatientPlan updatePatientPlanItem updatePreventionPlan

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

Triggers createTrigger deleteTrigger updateTrigger

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

License createLicense deleteLicense updateLicense

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

Hospital createClinicalNote createHospitalization createHospitalizationTask updateClinicalNote updateHospitalization updateHospitalizationTask

Marketing createNewsletter sendNewsletter sendNewsletterTest updateNewsletter

Clinical addTreatment approveAndSendToPharmacy approveCubexDiagnostic approveCubexEncounterProduct approveCubexMedication approveCubexTreatment approveMedication captureClientConsent clientConsentLink createAllergy createApptVitals createComplication createCustomPatientProtocol createImmunization createMacro createParentProblem createPatient createPatientTag createProblem createVitals declineCubexDiagnostic declineCubexEncounterProduct declineCubexMedication declineCubexTreatment deleteAllergy deleteClientConsent deleteComplication deleteImmunization deleteMacro deleteMedication deletePatientDocument deletePatientTag deleteProblem deleteVitals emailEncounter emailEncounterPdf emailEncounterRecord emailEncounterRecordToCustom emailEncounterRecordToRdvms emailHospitalizationNoticeToRdvms emailImmunizationsRecord emailRabiesCertificate emailSelectedRabiesCertificates encounterPdf endVisit genVetsourceUrl markCubexDiagnosticAsPendingApproval markCubexEncounterProductAsPendingApproval markCubexMedicationAsPendingApproval markCubexTreatmentAsPendingApproval markVisitReadyForDischarge massMicrochipRegister mergePatients movePatientToClient prescribeMedication printLabelPrintnode recordPatientWeight refillMedication registerPatientMicrochip reopenVisit requestMedicationApproval saveMicrochip sendEstimateConsentDepositLink sendSurveyLink signEncounter startVisit surgeryLogPdf transferPatient triggerPrescription unassignProblemFromEncounter updateAllergy updateComplication updateCustomPatientProtocol updateImmunization updateLinkedClinicalNote updateLinkedEncounter updateMacro updateMedication updatePatient updatePatientDocument updatePatientTag updateProblem updateVitals uploadPatientImage validateControlledDrugPin valuesetLabel

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

Entities acquireFaxNumber acquireTollFreeNumber acquireTwilioPhoneNumber assignProviderToLocation batchUpsertOrgPreferences createAlert createCage createClientRdvm createClientReferralSource createConsentForm createCustomLocationAttribute createDepartment createEntityValidation createLocation createLocationAttribute createLocationTag createOrgDepartment createOrgPreference createOutlookOrgPreference deleteAlert deleteCage deleteClientRdvm deleteClientReferralSource deleteConsentForm deleteCustomLocationAttribute deleteDepartment deleteEntityValidation deleteLocation deleteLocationTag deleteOrgDepartment fileDownloadLink mergeClientReferralSources reorderAlerts reorderClientReferralSources sendLocationChatMessage setChatLastReadAt setDaycareOpen unassignProviderFromLocation updateAlert updateCage updateClientRdvm updateClientReferralSource updateConsentForm updateCustomLocationAttribute updateDepartment updateEntityValidation updateLocation updateLocationAttribute updateLocationTag updateOrg updateOrgDepartment updateOrgPreference updateOutlookOrgPreference uploadClinicImage uploadLocationLogo uploadOrgLogo

Lab addReviewerToLabResult addTestsToLabOrder cancelLabOrder createOrgLab createOrgLabWithCheck deleteLabImage deleteLabOrder deleteLabResult deleteOrgLab emailLabResult fetchVetrocketImages finishLabOrder linkOrphanLabResultToPatient onboardPetdxLab orderLab refreshLabResult removeReviewerFromLabResult retryLabOrderPlacement updateLabOrder updateLabResult updateOrgLab updateOrgLabWithCheck uploadLabImage

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

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

Inventory addStockTransferItem createDiagnostic createFulfillmentSource createInventoryAdjustment createProductCategory createProductType createStockLocation createStockTransfer deleteDiagnostic deleteFulfillmentSource deleteProductCategory deleteProductType deleteStockTransfer deleteStockTransferItem generateInventoryReport generateUsageSummaryReport reassignProductType updateDiagnostic updateFulfillmentSource updateProductCategory updateProductCubexEnabled updateProductEnabled updateProductType updateQuantityStockTransferItem updateStockLocation updateStockTransfer updateStockTransferItem uploadMassInventory

VoiceCall convertCallLogToAppointment createCallLog createVoiceCallLog deleteCallLog dismissVoiceCalls linkCall unlinkCall updateCallLog updateDialpadSubscription updateVoiceCall

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

Reminders createReminder createReminderSilence deleteReminder sendTestEmail updateReminder updateReminderSilence

Tasks assignProviderToTask createTask createTaskCategory createTaskGroup createUserTask deleteTaskCategory deleteTaskGroup unassignProviderFromTask updateTask updateTaskCategory updateTaskGroup

Notifications deleteNotification readAllNotifications readNotification

Conversations createConversation deleteMessage sendMessage startConversation updateConversation

Board addPatientToBoard completeBoardCell createBoardCell deleteBoardCell invoiceBoardRow promoteEstimateToBoard uncompleteBoardCell updateBoardCell updateBoardRow

Objects

AccountCreditHistoryResponse AccountsReceivableBalance Address Alert Allergy AnalyticsData AnalyticsDataRow AnalyticsDataRowBreakdown ApiKey Appointment AppointmentIntakeData AppointmentReminder AppointmentType AppointmentTypeTag ApptCountProviders ArReconciliation AsyncMedicalRecord Attachment AutoMessage AvailableTimeSlot BillingNote BoardCell BoardGroup BoardRow BoardingCage BoardingWard Cadence Cage CallLog CardconnectCardInfo CareTeamRole CheckboxDatum ChecklistDatum Client ClientConnection ClientConsent ClientEdge ClientExternalCommPreferencesValue ClientRdvm ClientReferralSource ClientResult ClientTag ClinicalNote Comment Complication Conditional ConsentForm Conversation ConversationPage Coowner CoownerBreakdown Coupon CreditMemo CreditMemoTotals Cursor CustomAppointmentField CustomAppointmentFieldValue CustomClientField CustomClientFieldValue CustomLocationAttribute CustomPatientField CustomPatientFieldValue CustomPatientProtocol CustomVital Dashboard DatasyncLog DatasyncRecords DateCount DeletionLog Department DetailedSalesRevenueItem DetailedSalesRevenueItemConnection DetailedSalesRevenueItemEdge Diagnosis Diagnostic DiagnosticConnection DiagnosticEdge DialpadOffice DiscountReason DropdownDatum ElectronicSignature EmailStatus EmailTemplate Encounter EncounterConnection EncounterEdge EncounterProduct EncounterProductConnection EncounterProductEdge EncounterSection EncounterType EncounterVersion EntitiesTag EntityTag EntityTagGroup EntityValidation Estimate EstimateItem EstimatesTotals Event EventConnection EventEdge ExternalSearchResult ExtraField FeatureFlag FieldDatum FieldDatumPart File FileResults FormDatum FormulaDatum FulfillmentSource Highlight Hospitalization HospitalizationTask ImageDatum Immunization ImmunizationDatum InventoryAdjustment InventoryBucket InventoryLevel InventoryLog LabDevice LabOrder LabResult LabResultImage LabTest LedgerEntry LedgerEntryTotals LegalEntity License LinkedClinicalNote LinkedEncounter Location LocationAttribute LocationChatMessage LocationChatNotification LocationClientAccountCredits LocationHours LocationKpi LocationProviderSchedule LocationSchedule LocationTag LowStockThreshold Macro MassUploadResult MasterProduct Medication MedicationConnection MedicationEdge MedicationIntegrationTransaction MedicationIntegrationTransactionConnection MedicationIntegrationTransactionEdge MedicationStatusCount MedicationsReportItem MedicationsReportResult Message Modality MonitorDatum Monograph MonographGuide MonographSection RootMutationType Newsletter NoteDatum Notification NotificationMetadata NovaBoard NovaBoardCell NovaBoardRow ObanJob Order OrderFlag OrderItem OrderItemConnection OrderItemEdge OrderItemsTotals OrderPaymentMismatch OrdersCounts OrdersTotals Org OrgDepartment OrgLab OrgLabUpdateResult OrgPreference Pack PageInfo Patient PatientCompliance PatientComplication PatientDocument PatientPlan PatientPlanCharge PatientPlanItem PatientProtocol PatientTag Payment PaymentSource PaymentsTotals PendingImmunizationDatum PendingPackageDatum PendingRxDatum Permission PhoneNumber PlanOption PlumbsHandout PreventionPlan PriceChange PriceChangeFilter PriceTier PrintLabelResult PrintnodeComputersField PrintnodePrintersField Problem ProcessorPayment Product ProductCategory ProductManufacturer ProductManufacturerPage ProductMetadataField ProductPackage ProductPackageItem ProductPrice ProductType Protocol ProtocolReminder ProtocolReminderByProtocol Provider ProviderAppointmentTypeLimit ProviderCommission ProviderPreferences ProviderPunch ProviderRole ProviderTransfer PurchaseOrder PurchaseOrderItem RootQueryType Rdvm RdvmContact RdvmDocument RdvmRecentPatients RdvmVisit ReconciliationNote Recurrence Relationship Reminder ReminderSilence RepeatingEvent Reservation ReturnedOrderItem RevenueCenter RevenueCenterBudget RowUploadError RxDatum ScheduleRecurrence ScheduleTemplate ScheduleTemplateRange SentAutoMessage SentReminder SketchDatum StockLocation StockTransfer StockTransferItem StripeAddress StripeBillingDetails StripeCard StripeClientSecret StripeCustomer StripeInvoiceSettings StripePaymentIntent StripePaymentMethod StripeReader StripeUsBankAccount RootSubscriptionType SwapAppointmentResult SyncClientResult Task TaskCategory TaskConnection TaskEdge TaskGroup TeletailsSession TestResult TextDatum TimeSlot Treatment TreatmentConnection TreatmentDatum TreatmentEdge TreatmentInfo TreatmentSheet TreatmentSheetCareTeamMember TreatmentSheetCell TreatmentSheetCellComment TreatmentSheetRow TreatmentSheetRowAdditive TreatmentSheetRowAdditiveEntry TreatmentSheetRowBolus TreatmentSheetRowFluid TreatmentSheetTemplate TreatmentTimeInterval Trigger TriggerAddOrderItemOptions TriggerCreateTaskOptions TriggerDefaultOptions TriggerProduct TriggerSendEmailOptions TriggerWebhookOptions UsageReport UsageReportTotals ValuesetDatum ValuesetDatumOption Vendor VetspireSubscription VetspireSubscriptionTier Viewer Visit VitalDatum Vitals VitalsTemplate VoiceCall Weight WishlistItem

Unions

Bill LocationOrLocationTag MessageSender Orderable

Input Objects

Enums

AddressUse AnalyticsBreakdown AnalyticsDataRowModifier AnalyticsField AnalyticsSegment AppointmentStatus CadenceContactMethods CallLogOutcome CellStatus CommentableEntityType Comparison ConditionalOperator ContactType ConversationMedium DayOfWeek DiagnosticStatus DiscountType DoubleBookingConstraint EncounterPdfType EncounterProductStatus EncounterSummaryDocumentType EstimateStatus EstimateType Eye FeatureFlagEnum FilterField ImmunizationStatus ImmunizationType InferredResultTypes InvoiceSortFieldEnum InvoiceStatus IsoCountry LabelSize LicenseType MedicationStatus Month NotificationType ObanJobState OrderByDirection OrderByEnum OrgLabType PatientOrderByEnum PaymentMethod PaymentSort PharmacyStatus PlanInterval PriceChangeFilterType PriceChangeStatus PriceChangeType PriceType PricingType ProblemType ProductApplicationType Pronouns PurchaseOrderStatus ReminderEvent ReminderType RepeatType ReportBreakdown ReportSegment ReservationCategory ReservationStatus ReservationStatusFilter ReservationTime ReturnedOrderItemType RouteType ScheduledDrugType Severity Sex SortFieldEnum SortOptions SortProductOptions StockTransferStatus SubscriptionModel TimeSegment TreatmentSheetFormat TreatmentSheetRowFluidType TreatmentSheetSummaryType TreatmentSheetType TreatmentSheetUnits TreatmentStatus TriggerIf TriggerThen TriggeredProtocolsSortFieldEnum VisitType WeekOfMonth WeightUnit

Scalars

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

Tasks Mutations

Interactive examples coming soon...

assignProviderToTask :: Task

Assigns a provider to a task

Argument	Type	Description
providerId	ID!
taskId	ID!

createTask :: Task

Argument	Type	Description
input	TaskInput
patientId	ID

createTaskCategory :: TaskCategory

No arguments.

createTaskGroup :: TaskGroup!

Argument	Type	Description
input	TaskGroupInput!

createUserTask :: Task

Argument	Type	Description
input	TaskInput
locationId	ID
providerIds	[ID]
roleId	ID
taskGroupIds	[ID]

deleteTaskCategory :: TaskCategory

Argument	Type	Description
id	ID!

deleteTaskGroup :: TaskGroup!

Argument	Type	Description
id	ID!

unassignProviderFromTask :: Task

Removes a provider from a task

Argument	Type	Description
providerId	ID!
taskId	ID!

updateTask :: Task

Argument	Type	Description
id	ID!
input	TaskInput!

updateTaskCategory :: TaskCategory

Argument	Type	Description
id	ID!
input	TaskCategoryInput!

updateTaskGroup :: TaskGroup!

Argument	Type	Description
id	ID!
input	TaskGroupInput!