Guides

Introduction GraphQL Guide

Queries

Reminders reminders

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

Conversations conversation conversations openConversationsCount unreadConversations unreadConversationsCount

Inventory clientConsent diagnostic fulfillmentSource fulfillmentSources inventoryAdjustments productCategories productCategory productType productTypes

Schedule appointment appointmentTypes appointments availableTimes countAppointmentProviders countAppointments countViewerAppointments scheduleTemplate scheduleTemplates selfCheckInLink

Accounts client clients clientsCount coowners countNewClients externalCommPreferences externalSearch provider providerAuthToken providers searchAccounts totalClients viewer

Entities alert alerts clientReferralSource clientReferralSources clientTag consentForm consentForms customClientFields customPatientFields emailAttachmentIntegration emailAttachmentIntegrations encounterType entityValidations isDaycareOpen location locationChatMessages locationTag locationTags locations org rdvm rdvms searchLocationTags searchPrinters searchRdvms unreadLocationChatMessagesCount

Hospital macro macros

Board activeBoardRows boardCell boardGroups boardRow

Notifications notifications unreadNotificationsCount

Triggers trigger triggers

Tasks overdueTasksCount task taskCategories tasks

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

Plan patientPlan patientPlans plan preventionPlan preventionPlans

Marketing newsletter newsletters protocol protocols

Clinical customPatientFieldValues lapsingPatients patientLabel immunizationPdf patient diagnostics patientTag treatments patientComplication medications vitals patientProtocols patientDocument complication allergies totalPatients encounter searchEmailAttachments complications immunizations patientTags medicalRecordsSummary searchDiagnoses encountersUpdatedSince encounterSummary encounterTypes medication searchMacros patients rabiesCertificate patientConsentForms immunizationsDue encounters immunization

Lab getInhouseDevices getModalities labOrder labOrders labResult labResults orgLab orgLabOrders orgLabResults orgLabs orphanedLabs

Mutations

Comments comment

Clinical massMicrochipRegister createAllergy registerPatientMicrochip signEncounter copyMedicationsToEncounter updateAllergy updatePatientDocument updateLinkedEncounter emailRabiesCertificate printPatientLabel printMedicationLabel emailEstimateToClient emailEncounterRecordToRdvms refillMedication updateVitals createPatientTag emailEncounterRecord updateEncounter createImmunization unassignProblemFromEncounter updateImmunization deleteAllergy updateComplication updatePatientTag createEncounterOrder encounterPdf copyFromPreviousEncounter emailImmunizationsRecord sendSurveyLink addTreatment createProblem updateCustomPatientFieldValue addLinkedEncounter pushTreatmentToCubex deleteComplication updateProblem prescribeMedication uploadPatientDocument deleteLinkedClinicalNote newEncounter reopenEncounter attachGmailAttachmentToEncounter deleteEncounter createEncounterType markAllNormalEncounter createPatientComplication deleteClientConsent pushToCubex deletePatientTag deletePatientComplication createCustomPatientFieldValue deletePatientDocument addLinkedClinicalNote movePatientToClient createComplication triggerPrescription updateLinkedClinicalNote updateMedication mergePatients captureClientConsent uploadPatientImage recordPatientWeight assignProblemToEncounter deleteProblem emailInvoiceToClient deleteMedication emailHospitalizationNoticeToRdvms updatePatientComplication createPatient updatePatient createParentProblem pushRxToCubex clientConsentLink deleteLinkedEncounter

Notifications deleteNotification readAllNotifications readNotification

Triggers createTrigger deleteTrigger updateTrigger

Reminders createReminder createReminderSilence deleteReminder updateReminder updateReminderSilence

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

Tasks assignProviderToTask createTask createTaskCategory deleteTaskCategory unassignProviderFromTask updateTask updateTaskCategory

Board addPatientToBoard completeBoardCell createBoardCell deleteBoardCell invoiceBoardRow promoteEstimateToBoard uncompleteBoardCell updateBoardCell updateBoardRow

Lab cancelLabOrder createOrgLab deleteLabOrder deleteLabResult deleteOrgLab emailLabResult finishLabOrder orderLab refreshLabResult updateLabOrder updateLabResult updateOrgLab

Hospital createClinicalNote createHospitalization createMacro deleteMacro updateClinicalNote updateEncounterType updateHospitalization updateMacro

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

Marketing createNewsletter createProtocol deleteProtocol sendNewsletter sendNewsletterTest updateNewsletter updateProtocol

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

Payroll clockIn clockOut createProviderPunch deleteProviderPunch updateProviderPunch

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

Plan cancelPlan createPreventionPlan enrollPlan updatePatientPlan updatePreventionPlan

Billing addPackageToEncounter deleteLinkedProduct updatePurchaseOrderItem deletePurchaseOrderItem updateProductProductCategory invoiceBarcodesPdf createPurchaseOrder updatePurchaseOrder createProduct updateOrder applyAccountCredit endOfDayReport addPurchaseOrderItem deleteWishlistItem addLinkedProduct upsertLowStockThreshold billingStatement invoicePendingItems addOrderItemToEncounter reopenOrder cancelSubscriptionSilently updateVendor deleteOrder upsertProductLocationMarkup updateWishlistItem orderWishlist sendPaymentRequest deletePurchaseOrder cancelSubscription newVendor deleteProduct addCreditMemo convertEstimateToOrder upsertProductTypeLocationMarkup addPackageToEstimate saveEstimate addToWishlist generateInvoice paymentReceiptPdf reorderOrderItems addPackageToOrder createOrder subscribePatients upsertPackageLocationMarkup addOrderItem refundOrderItem updateOrderItem

Entities updateRdvm updateOrgPreference acquireTwilioPhoneNumber updateLocationTag deleteLocation unassignProviderFromLocation assignProviderToLocation updateAlert createCustomLocationAttribute deleteLocationTag addOrgPaymentSource updateOrg loginGoogleCloudPrint createRdvm updateClientReferralSource createCustomClientField deleteEmailAttachmentIntegration updateEmailAttachmentIntegration createClientRdvm createCage removeOrgPaymentSource mergeRdvms updateConsentForm deleteAlert uploadLocationLogo createEntityValidation updateCustomLocationAttribute createOrgPreference reorderClientReferralSources sendLocationChatMessage deleteClientRdvm createCustomPatientField updateClientRdvm deleteCustomPatientField createConsentForm deleteCustomClientField createClientReferralSource deleteEncounterType uploadOrgLogo deleteConsentForm updateLocation setDaycareOpen deleteCustomLocationAttribute updateLocationAttribute deleteEntityValidation createLocation deleteRdvm createLocationAttribute updateCage createLocationTag deleteClientReferralSource updateEntityValidation createAlert createEmailAttachmentIntegration deleteCage removeGoogleCloudPrintCredentials mergeClientReferralSources makeLocationDefault

Conversations createConversation sendMessage startConversation updateConversation

Objects

AnalyticsDataRowBreakdown FieldDatumPart Immunization OrderItemsTotals EncounterVersion PaymentSource PlanOption OrgSubscription OrdersTotals Reservation LinkedEncounter AnalyticsData RootMutationType EmailTemplate Conversation Client RingCentralCall Allergy ProviderRole EmailAttachment TestResult LowStockThreshold PurchaseOrderItem ApptCountProviders Coowner ClientRdvm TriggerAddOrderItemOptions Coupon RepeatingEvent Provider FulfillmentSource PrintPatientLabelResult Address Rdvm Weight ReservationNightlyPrice Org Medication ProviderAppointmentTypeLimit EncounterProduct ValuesetDatumOption RootSubscriptionType LocationHours VitalsTemplate ReminderSilence Viewer EstimateItem ScheduleTemplate PatientPlanItem ProductMetadataField PendingImmunizationDatum ProductPackageItem EmailStatus FeatureFlag BoardingCage LocationProviderSchedule OrgLab NotificationMetadata FormulaDatum TreatmentDatum EncounterType NoteDatum PrintLabelResult Attachment TriggerSendEmailOptions ProductCategory TextDatum ProductPrice PatientPlan ApolloAudience ClientExternalCommPreferencesValue AppointmentType Macro ProductType Treatment ProviderCommission ProductPackage Message RootQueryType CallLog CustomVital ConsentForm DropdownDatum Location OrderFlag PurchaseOrder PrintersField TriggerWebhookOptions AppointmentIntakeData MasterProduct Diagnosis Trigger Task PendingRxDatum LabResult Comment RevenueCenter CustomLocationAttribute EstimatesTotals WishlistItem EncounterSection CustomClientFieldValue EmailAttachmentIntegration Encounter LabDevice ClientResult BillingNote ExternalSearchResult ClientReferralSource PendingInvoiceItem PatientProtocol Pack CustomClientField Vendor DateCount LabOrder SketchDatum Complication PhoneNumber Product Protocol ProviderPunch OrderItem Newsletter TriggerCreateTaskOptions RxDatum BoardCell ReconciliationNote ClientConsent CustomPatientFieldValue BoardGroup PatientDocument LocationChatMessage Cage ReservationType Alert TriggerDefaultOptions OrgPreference InventoryBucket AutoMessage BoardingWard Reminder LinkedClinicalNote Payment PreventionPlan Vitals ClientTag Estimate PatientComplication PaymentsTotals Order AnalyticsDataRow Problem Notification EntityValidation PatientSubscription PatientTag InventoryLevel ClinicalNote LocationTag Patient BoardRow TeletailsSession LocationSchedule PendingPackageDatum VitalDatum CreditMemoTotals RevenueCenterBudget Diagnostic FormDatum SyncClientResult Highlight InventoryAdjustment Hospitalization Appointment CustomPatientField AvailableTimeSlot Event ScheduleTemplateRange ValuesetDatum ProcessorPayment LocationAttribute FieldDatum ImmunizationDatum TaskCategory OldDatum CreditMemo ElectronicSignature

Unions

LocationOrLocationTag Orderable MessageSender Bill

Input Objects

RepeatingEventInput LabResultInput BoardRowInput Filter PaymentInput ReconciliationNoteInput NewsletterInput PatientRegistration PrinterInput FulfillmentSourceInput VitalsTemplateInput ProviderAppointmentTypeLimitInput EstimateItemInput ClientsTagsInput MacroInput EventMetadataFilter ProblemInput TeletailsSessionInput LocationInput AutoMessageInput ClientReferralSourceInput InventoryAdjustmentInput BoardCellInput ClinicalNoteInput PurchaseOrderInput TriggerInput ProviderRoleInput CallLogInput OrgLabInput CustomLocationAttributeInput ReservationInput InventoryBucketInput EmailTemplateInput PatientPlanInput OrgPreferenceInput LocationHoursInput RdvmInput PatientInput LinkedClinicalNoteInput EmailAttachmentIntegrationInput TreatmentInput ProviderCommissionInput LocationTagInput ProductPriceInput CustomClientFieldInput PatientFilters ApolloAudienceInput LocationAttributeInput AllergyInput ClientExternalCommPreferencesInput SyncClientInput RevenueCenterBudgetInput RevenueCenterInput ExternalSearchInput TaskInput ClientRdvmInput PlanOptionInput LocationProviderScheduleInput AppointmentInput ProductPackageInput VitalsInput AppointmentIntakeDataInput ProductCategoryInput ReminderSilenceInput ProviderInput PatientComplicationInput PatientDocumentInput ProtocolInput PurchaseOrderItemInput ScheduleTemplateRangeInput ProductMetadataFieldInput CouponInput LabOrderInput EstimateInput CageInput WishlistItemInput MedicationInput BillingNoteInput VendorInput AddressInput AnalyticsFieldModifier LinkedEncounterInput ProductTypeInput PendingInvoiceItemInput ProductInput HospitalizationInput PreventionPlanInput ClientInput PaymentSourceInput LocationFilters DiagnosticInput CustomPatientFieldInput OrderInput EncounterTypeInput CustomVitalInput ConversationInput AlertInput ProviderPunchInput CoownerInput ImmunizationInput LowStockThresholdInput ClientTagInput ConsentFormInput ClientFilters CreditMemoInput RingCentralCallInput ComplicationInput EncounterInput PhoneNumberInput OrderItemInput EntityValidationInput EncounterProductInput PatientTagInput OrderFlagInput AppointmentTypeInput ReminderInput TaskCategoryInput ScheduleTemplateInput OrgInput ProviderViewerInput ProductPackageItemInput ProductTypeFlags LocationScheduleInput

Enums

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

Scalars

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

Input Object » ReservationInput

Fields

addonProductIds ([ID])

boardingCageId (ID)

endDate (Date)

locationId (ID)

notes (String)

patientId (ID)

reservationTypeId (ID)

startDate (Date)