Docs
Guides
IntroductionGraphQL Guide
Type System
📦Objects336▾
AccountCreditHistoryResponseAccountsReceivableBalanceAddressAgedAccountsReceivableAgedAccountsReceivableTotalsAgedArReportGenerationAlertAllergyAnalyticsDataAnalyticsDataRowAnalyticsDataRowBreakdownApiKeyAppointmentAppointmentIntakeDataAppointmentReminderAppointmentTypeAppointmentTypeTagApptCountProvidersArReconciliationAsyncMedicalRecordAttachmentAutoMessageAvailableTimeSlotBillingNoteBoardCellBoardGroupBoardingCageBoardingWardBoardRowCadenceCageCallLogCardconnectCardInfoCardconnectVerifyCredentialsResultCareTeamRoleChangelogChangelogConnectionChangelogEdgeCheckboxDatumChecklistDatumClientClientConnectionClientConsentClientEdgeClientExternalCommPreferencesValueClientRdvmClientReferralSourceClientResultClientTagClinicalNoteCommentComplicationConditionalConsentFormConversationConversationPageCoownerCoownerBreakdownCouponCreditMemoCreditMemoTotalsCursorCustomAppointmentFieldCustomAppointmentFieldValueCustomClientFieldCustomClientFieldValueCustomLocationAttributeCustomPatientFieldCustomPatientFieldValueCustomPatientProtocolCustomVitalDashboardDatasyncLogDatasyncRecordsDateCountDeletionLogDepartmentDetailedCreditItemDetailedCreditItemConnectionDetailedCreditItemEdgeDetailedSalesRevenueItemDetailedSalesRevenueItemConnectionDetailedSalesRevenueItemEdgeDiagnosisDiagnosticDiagnosticConnectionDiagnosticEdgeDialpadOfficeDiscountReasonDropdownDatumElectronicSignatureEmailStatusEmailTemplateEncounterEncounterCareTeamMemberEncounterConnectionEncounterEdgeEncounterProductEncounterProductConnectionEncounterProductEdgeEncounterSectionEncounterTypeEncounterVersionEntitiesTagEntityTagEntityTagGroupEntityValidationEstimateEstimateItemEstimatesTotalsEventEventConnectionEventEdgeExternalSearchResultExtraFieldFeatureFlagFieldDatumFieldDatumPartFileFileResultsFormDatumFormulaDatumFulfillmentSourceHighlightHospitalizationHospitalizationTaskImageDatumImmunizationImmunizationDatumInventoryAdjustmentInventoryBucketInventoryLevelInventoryLogLabDeviceLabOrderLabResultLabResultImageLabTestLedgerEntryLedgerEntryTotalsLegalEntityLicenseLinkedClinicalNoteLinkedEncounterLocationLocationAttributeLocationChatMessageLocationChatNotificationLocationClientAccountCreditsLocationHoursLocationKpiLocationProviderScheduleLocationScheduleLocationTagLowStockThresholdMacroMassUploadResultMasterProductMedicationMedicationConnectionMedicationEdgeMedicationIntegrationTransactionMedicationIntegrationTransactionConnectionMedicationIntegrationTransactionEdgeMedicationsReportItemMedicationsReportResultMedicationStatusCountMessageModalityMonitorDatumMonographMonographGuideMonographSectionNewsletterNoteDatumNotificationNotificationMetadataNovaBoardNovaBoardCellNovaBoardClientSummaryNovaBoardPatientSummaryNovaBoardRowObanJobOrderOrderFlagOrderItemOrderItemConnectionOrderItemEdgeOrderItemsTotalsOrderPaymentMismatchOrdersCountsOrdersTotalsOrgOrgDepartmentOrgLabOrgLabUpdateResultOrgPreferencePackPageInfoPatientPatientCompliancePatientComplicationPatientDocumentPatientPlanPatientPlanChargePatientPlanItemPatientProtocolPatientTagPaymentPaymentSourcePaymentsTotalsPendingImmunizationDatumPendingPackageDatumPendingRxDatumPermissionPhoneNumberPlanOptionPlumbsHandoutPreventionPlanPriceChangePriceChangeFilterPriceTierPrintLabelResultPrintnodeComputersFieldPrintnodePrintersFieldProblemProcessorPaymentProductProductCategoryProductManufacturerProductManufacturerPageProductMetadataFieldProductPackageProductPackageItemProductPriceProductTypeProtocolProtocolReminderProtocolReminderByProtocolProviderProviderAppointmentTypeLimitProviderCommissionProviderPreferencesProviderPunchProviderRoleProviderTransferPurchaseOrderPurchaseOrderItemRdvmRdvmContactRdvmDocumentRdvmRecentPatientsRdvmVisitReconciliationNoteRecurrenceRelationshipReminderReminderSilenceRepeatingEventReservationReturnedOrderItemRevenueCenterRevenueCenterBudgetRootMutationTypeRootQueryTypeRootSubscriptionTypeRowUploadErrorRxDatumScheduleRecurrenceScheduleTemplateScheduleTemplateRangeSentAutoMessageSentReminderSketchDatumStockLocationStockTransferStockTransferItemStripeAddressStripeBillingDetailsStripeCardStripeClientSecretStripeCustomerStripeInvoiceSettingsStripePaymentIntentStripePaymentMethodStripeReaderStripeUsBankAccountSwapAppointmentResultSyncClientResultTaskTaskCategoryTaskConnectionTaskEdgeTaskGroupTeletailsSessionTestResultTextDatumTimeSlotTreatmentTreatmentConnectionTreatmentDatumTreatmentEdgeTreatmentInfoTreatmentSheetTreatmentSheetCareTeamMemberTreatmentSheetCellTreatmentSheetCellCommentTreatmentSheetRowTreatmentSheetRowAdditiveTreatmentSheetRowAdditiveEntryTreatmentSheetRowBolusTreatmentSheetRowFluidTreatmentSheetTemplateTreatmentTimeIntervalTriggerTriggerAddOrderItemOptionsTriggerCreateTaskOptionsTriggerDefaultOptionsTriggerProductTriggerSendEmailOptionsTriggerWebhookOptionsUsageReportUsageReportTotalsValuesetDatumValuesetDatumOptionVendorVetspireSubscriptionVetspireSubscriptionTierViewerVisitVitalDatumVitalsVitalsTemplateVoiceCallWeightWishlistItem
🔗Unions4▾
BillLocationOrLocationTagMessageSenderOrderable
📥Input Objects198▾
AccountCreditHistoryOrderByAccountsFiltersAccountsOrderByAddressInputAlertInputAllergyInputAnalyticsFieldModifierAppointmentInputAppointmentIntakeDataInputAppointmentReminderInputAppointmentTypeInputAppointmentTypeTagInputApproveCubexDiagnosticInputApproveCubexEncounterProductInputApproveCubexMedicationInputApproveCubexTreatmentInputApproveMedicationInputAssignOrphanTransactionInputAssignOrphanTransactionToNewEncounterInputAutoMessageInputBillingNoteInputBoardCellInputBoardingBlockInputBoardingCageInputBoardingWardFiltersBoardingWardInputBoardRowInputCadenceInputCageInputCallLogInputChangelogFiltersChangelogOrderByClientExternalCommPreferencesInputClientFiltersClientInputClientRdvmInputClientReferralSourceInputClientTagInputClinicalNoteInputComplicationInputConditionalInputConditionalPermissionConsentFormInputConversationInputConversationSetAttachmentCoownerInputCouponInputCreateCareTeamRoleInputCreateProviderTransferInputCreateTreatmentSheetInputCreditMemoInputCustomAppointmentFieldInputCustomAppointmentFieldValueInputCustomClientFieldInputCustomClientFieldValueInputCustomLocationAttributeInputCustomPatientFieldInputCustomPatientFieldValueInputCustomPatientProtocolInputCustomVitalInputDepartmentInputDiagnosticInputDiscountReasonInputEmailTemplateInputEncounterCareTeamMemberInputEncounterFiltersEncounterOrderByEntitiesTagInputEntityTagGroupInputEntityTagInputEntityValidationInputEstimateInputEstimateItemInputEventMetadataFilterEventsOrderByExternalSearchInputExtraFieldInputFilterFulfillmentSourceInputHospitalizationInputHospitalizationTaskInputImmunizationInputInventoryAdjustmentInputInventoryBucketInputLabOrderInputLabResultInputLicenseInputLinkedClinicalNoteInputLinkedEncounterInputLocationAttributeInputLocationFiltersLocationHoursInputLocationInputLocationProviderScheduleInputLocationScheduleInputLocationTagInputLowStockThresholdInputMacroInputMedicationInputMedicationPharmacyFieldsInputMedicationPharmacyStatusInputNewsletterInputOrderFlagInputOrderInputOrderItemInputOrderLineItemsFiltersOrderLineItemsOrderByOrgDepartmentInputOrgInputOrgLabInputOrgPreferenceInputPatientDocumentInputPatientFiltersPatientInputPatientPlanFiltersPatientPlanInputPatientPlanItemInputPatientRegistrationPatientTagInputPaymentInputPaymentSourceInputPharmacyMedicationsOrderByPhoneNumberInputPlanOptionInputPreventionPlanInputPriceChangeFilterInputPriceChangeInputPriceTierInputPrinterInputProblemInputProductCategoryInputProductInputProductManufacturerInputProductMetadataFieldInputProductPackageInputProductPackageItemInputProductPriceInputProductTypeFlagsProductTypeInputProtocolInputProtocolReminderInputProviderAppointmentTypeLimitInputProviderCommissionInputProviderInputProviderPreferencesInputProviderPunchInputProviderRoleInputProviderViewerInputPurchaseOrderInputPurchaseOrderItemInputRdvmContactInputRdvmInputRdvmVisitInputReconciliationNoteInputRecurrenceInputRelationshipInputReminderInputReminderSilenceInputRepeatingEventInputReservationFiltersReservationInputRevenueCenterBudgetInputRevenueCenterInputSaveTreatmentSheetCellOrderItemInputScheduleRecurrenceInputScheduleTemplateInputScheduleTemplateRangeInputStockLocationInputStockLocationUpdateStockTransferInputStockTransferItemInputSyncClientInputTaskCategoryInputTaskGroupInputTaskInputTasksFiltersTasksOrderByTeletailsSessionInputTreatmentInputTreatmentSheetCareTeamMemberInputTreatmentSheetCellInputTreatmentSheetInputTreatmentSheetRowAdditiveEntryInputTreatmentSheetRowAdditiveInputTreatmentSheetRowBolusInputTreatmentSheetRowFluidInputTreatmentSheetRowInputTreatmentSheetTemplateInputTreatmentTemplateSectionTreatmentTimeIntervalInputTriggerInputUpdateCareTeamRoleInputUpdateProviderTransferInputVendorInputVitalsInputVitalsTemplateInputVoiceCallInputWishlistItemInput
🏷️Enums92▾
ActionsEnumAddressUseAdminTagAgedArReportStatusAnalyticsBreakdownAnalyticsDataRowModifierAnalyticsFieldAnalyticsSegmentAppointmentStatusCadenceContactMethodsCallLogOutcomeCommentableEntityTypeComparisonConditionalOperatorContactTypeConversationMediumDayOfWeekDiagnosticStatusDiscountTypeDoubleBookingConstraintEncounterPdfTypeEncounterProductStatusEncounterSummaryDocumentTypeEstimateStatusEstimateTypeEyeFeatureFlagEnumFilterFieldImmunizationStatusImmunizationTypeInferredResultTypesInvoiceSortFieldEnumInvoiceStatusIsoCountryLabelSizeLicenseTypeMedicationStatusMonthNotificationTypeNovaBoardCellStatusObanJobStateOrderByDirectionOrderByEnumOrgLabTypePatientOrderByEnumPaymentMethodPaymentSortPharmacyStatusPlanIntervalPriceChangeFilterTypePriceChangeStatusPriceChangeTypePriceTypePricingTypeProblemTypeProductApplicationTypePronounsPurchaseOrderStatusRecurrenceEditScopeReminderEventReminderTypeRepeatTypeReportBreakdownReportSegmentReservationCategoryReservationStatusReservationStatusFilterReservationTimeReturnedOrderItemTypeRouteTypeScheduledDrugTypeSeveritySexSortFieldEnumSortOptionsSortProductOptionsStockTransferStatusSubscriptionModelTimeSegmentTreatmentSheetFormatTreatmentSheetRowFluidTypeTreatmentSheetSummaryTypeTreatmentSheetTypeTreatmentSheetUnitsTreatmentStatusTriggeredProtocolsSortFieldEnumTriggerIfTriggerThenVisitTypeWastageReasonWeekOfMonthWeightUnit
🔢Scalars14▾
BooleanDateDateTimeDecimalIDIntJSONNaiveDateTimeNumrangePriceStringTimeTruthyUpload
Object

RootMutationType

Usage Example
query {
  # Use this type in your queries
  someQuery {
  acquireFaxNumber
  acquireTollFreeNumber
  acquireTwilioPhoneNumber
  addClientAddress
  addClientStripeInfo
  }
}

Fields

acquireFaxNumberLocation
+
acquireTollFreeNumberLocation
+
acquireTwilioPhoneNumberLocation
+
addClientAddressClient
+

Add an address to a client

addClientStripeInfoClient
+
addCoownerCoowner
+

Add a coowner to a client

addCreditMemoCreditMemo
+
addEstimateItem[EstimateItem]
+
addLinkedClinicalNoteLinkedClinicalNote
+
addLinkedEncounterLinkedEncounter
+
addLinkedProductProduct
+
addOrderItem[OrderItem]
+
addOrderItemToEncounterOrderItem
+
addPackageToEncounterEncounter
+
addPackageToEstimateEstimate
+
addPackageToOrderOrder
+
addPackageToPackageProductPackage
+
addPatientPlanItemPatientPlanItem
+
addPatientToBoardBoardRow
+
addPurchaseOrderItemPurchaseOrderItem
+
addReviewerToLabResultLabResult
+

Adds a reviewer to a lab result

addStockTransferItemStockTransferItem
+
addTestsToLabOrderLabOrder
+
addToWishlistWishlistItem
+
addTreatmentTreatment
+
addTreatmentSheetCellCommentTreatmentSheetCell
+
addTreatmentSheetRowTreatmentSheetRow
+
applyAccountCreditOrder
+
applyCouponOrder
+
applyEstimateCouponEstimate
+
applyPriceChangeString
+

Applies a price change

approveAndSendToPharmacyMedication
+

Approve a medication and send it to the pharmacy whiteboard

approveCubexDiagnosticDiagnostic!required
+

Approve a cubex-related diagnostic with a pending approval status. Should only be used when the Cubex Two-Way integration is enabled.

approveCubexEncounterProductEncounterProduct!required
+

Approve a cubex-related encounter product with a pending approval status. Should only be used when the Cubex Two-Way integration is enabled.

approveCubexMedicationMedication!required
+

Approve a cubex-related medication with a pending approval status. Should only be used when the Cubex Two-Way integration is enabled.

approveCubexTreatmentTreatment!required
+

Approve a cubex-related treatment with a pending approval status. Should only be used when the Cubex Two-Way integration is enabled.

approveMedicationMedication!required
+

Approves a medication.

assignOrphanTransactionMedicationIntegrationTransaction!required
+

Links an orphan transaction to a patient and an existing encounter. Should only be used when the Cubex Two-Way integration is enabled

assignOrphanTransactionToNewEncounterMedicationIntegrationTransaction!required
+

Links an orphan transaction to a patient and a new encounter. Should only be used when the Cubex Two-Way integration is enabled

assignProblemToEncounterProblem
+

Assign a problem in the patient's problem list to the encounter

assignProviderToLocationProvider
+

Assigns a provider to a location

assignProviderToTaskTask
+

Assigns a provider to a task

autoApplyCouponsOrder
+
autoApplyEstimateCouponsEstimate
+
batchUpsertOrgPreferences[OrgPreference]
+

Batch create or update multiple org preferences in a single operation

billingHistoryString
+
billingStatementString
+
bulkMarkRemindersAsSentBoolean
+
cancelDatasyncDatasyncLog
+
cancelLabOrderLabOrder
+
cancelPlanPatientPlan
+
captureClientConsentString
+
chargeClientPayment
+
chargeEstimateEstimate
+
chargeOrderOrder
+
checkInReservationReservation!required
+
checkOutReservationReservation!required
+
clockOutProviderPunch
+
commentComment
+
completeBoardCellBoardRow
+
convertCallLogToAppointmentAppointment
+
convertEstimateToOrderEstimate
+
copyFromPreviousEncounterEncounter
+
copyMedicationsToEncounterEncounter
+
copyPackageProductPackage
+
createAlertAlert!required
+
createAllergyAllergy
+
createApiKeyApiKey
+
createAppointmentAppointment
+

Create an appointment

createAppointmentReminderAppointmentReminder!required
+
createAppointmentTypeAppointmentType!required
+
createAppointmentTypeTagAppointmentTypeTag!required
+
createApptVitalsAppointment
+
createAutoMessageAutoMessage!required
+
createBillingNoteBillingNote!required
+
createBoardCellBoardCell!required
+
createBoardingBlockReservation!required
+
createBoardingCageBoardingCage!required
+
createBoardingWardBoardingWard!required
+
createBridgeUserProvider
+
createCadenceCadence
+
createCageCage!required
+
createCallLogCallLog!required
+
createCareTeamRoleCareTeamRole
+
createClientClient!required
+
createClientRdvmClientRdvm!required
+
createClientReferralSourceClientReferralSource!required
+
createClientTagClientTag
+
createClinicalNoteClinicalNote!required
+
createComplicationComplication!required
+
createConsentFormConsentForm!required
+
createConversationConversation
+
createCouponCoupon!required
+
createCustomAppointmentFieldCustomAppointmentField
+

Creates a custom appointment field

createCustomAppointmentFieldValueCustomAppointmentFieldValue
+

Creates a custom appointment field value

createCustomClientFieldCustomClientField
+

Creates a custom client field

createCustomClientFieldValueCustomClientFieldValue
+

Creates a custom client field value

createCustomLocationAttributeCustomLocationAttribute!required
+
createCustomPatientFieldCustomPatientField
+

Creates a custom patient field

createCustomPatientFieldValueCustomPatientFieldValue
+

Creates a custom patient field value

createCustomPatientProtocolCustomPatientProtocol
+
createDepartmentDepartment!required
+
createDiagnosticDiagnostic!required
+
createDiscountReasonDiscountReason
+
createEncounterOrderEncounter
+
createEncounterProductEncounterProduct!required
+
createEncounterSectionEncounter
+

Inserts a new section for the given `encounter_id`'s sections at the `section_idx`th position

createEncounterSectionDatumEncounter
+

Inserts the given datum for the given encounter's `section_idx` at the `datum_idx`th position

createEncounterTypeEncounterType
+
createEntitiesTagEntitiesTag!required
+
createEntityTagEntityTag!required
+
createEntityTagGroupEntityTagGroup!required
+
createEntityValidationEntityValidation!required
+
createEstimateEstimate
+
createEstimateItemEstimateItem!required
+
createFulfillmentSourceFulfillmentSource!required
+
createHospitalizationHospitalization!required
+
createHospitalizationTaskHospitalizationTask
+
createImmunizationImmunization
+

Create an immunization

createInventoryAdjustmentInventoryAdjustment
+
createLicenseLicense
+
createLocationLocation
createLocationAttributeLocationAttribute!required
+
createLocationProviderScheduleLocationProviderSchedule!required
+
createLocationScheduleLocationSchedule
+

Add a location schedule

createLocationTagLocationTag!required
+
createMacroMacro!required
+
createNewsletterNewsletter
createOrderOrder
+
createOrderFlagOrderFlag!required
+
createOrgDepartmentOrgDepartment!required
+
createOrgLabOrgLab!required
+
createOrgLabWithCheckOrgLabUpdateResult
+
createOrgPreferenceOrgPreference!required
+
createOutlookOrgPreferenceOrgPreference
+
createParentProblemProblem
+
createPatientPatient!required
+
createPatientComplicationPatientComplication!required
+
createPatientTagPatientTag!required
+
createPreventionPlanPreventionPlan!required
+
createPriceChangePriceChange
+

Creates a price change

createProblemProblem
+

Create a new problem

createProductProduct
createProductCategoryProductCategory!required
+
createProductManufacturerProductManufacturer
+
createProductPackageProductPackage!required
+
createProductPackageItemProductPackageItem!required
+
createProductPriceProductPrice
+
createProductTypeProductType!required
+
createProtocolProtocol!required
+
createProviderProvider
+

Create a practitioner in your org if you are an admin

createProviderPinProvider
+
createProviderPunchProviderPunch!required
+
createProviderRoleProviderRole!required
+
createProviderTransferProviderTransfer
+
createPurchaseOrderPurchaseOrder
+
createRdvmRdvm
+
createRdvmContactRdvmContact
+

Add a contact to rDVM

createRdvmVisitRdvmVisit
+

Add a vist to rDVM

createReconciliationNoteReconciliationNote!required
+
createRelationshipRelationship!required
+
createReminderReminder!required
+
createReminderSilenceReminderSilence!required
+
createReservationReservation!required
+
createReservationEstimateReservation!required
+
createRevenueCenterRevenueCenter!required
+
createRevenueCenterBudgetRevenueCenterBudget!required
+
createScheduleRecurrenceScheduleRecurrence
+
createScheduleTemplateScheduleTemplate!required
+
createStockLocationStockLocation
+
createStockTransferStockTransfer
+
createStripePaymentIntentString
+
createTaskTask
+
createTaskCategoryTaskCategory
createTaskGroupTaskGroup!required
+
createTeletailsSessionTeletailsSession
+
createTreatmentSheetTreatmentSheet
+
createTreatmentSheetCellTreatmentSheetCell
+
createTreatmentSheetTemplateTreatmentSheetTemplate
+
createTriggerTrigger
createUserTaskTask
+
createVitalsVitals
+
createVoiceCallLogVoiceCall
+
creditMemoPdfString
+
declineCubexDiagnosticDiagnostic!required
+

Decline a cubex-related diagnostic with a pending approval status. Should only be used when the Cubex Two-Way integration is enabled.

declineCubexEncounterProductEncounterProduct!required
+

Decline a cubex-related encounter product with a pending approval status. Should only be used when the Cubex Two-Way integration is enabled.

declineCubexMedicationMedication!required
+

Decline a cubex-related medication with a pending approval status. Should only be used when the Cubex Two-Way integration is enabled.

declineCubexTreatmentTreatment!required
+

Decline a cubex-related treatment with a pending approval status. Should only be used when the Cubex Two-Way integration is enabled.

declinePackageEstimateItem
+
deleteAddressAddress
+

Deletes an address under the client's info

deleteAlertAlert!required
+
deleteAllergyAllergy!required
+
deleteApiKeyApiKey
+

Deletes an API key and associated API user

deleteAppliedCouponOrder
+
deleteAppliedEstimateCouponEstimate
+
deleteAppointmentAppointment
+
deleteAppointmentReminderAppointmentReminder!required
+
deleteAppointmentTypeAppointmentType!required
+
deleteAppointmentTypeTagAppointmentTypeTag!required
+
deleteAutoMessageAutoMessage!required
+
deleteBoardCellBoardCell!required
+
deleteBoardingBlockReservation!required
+
deleteBoardingCageBoardingCage!required
+
deleteBoardingWardBoardingWard!required
+
deleteCadenceCadence
+
deleteCageCage
+
deleteCallLogCallLog!required
+
deleteClientConsentClientConsent
+
deleteClientRdvmClientRdvm!required
+
deleteClientReferralSourceClientReferralSource!required
+
deleteClientTagClientTag
+
deleteComplicationComplication!required
+
deleteConsentFormConsentForm!required
+
deleteCoownerCoowner
+

Deletes an associate

deleteCouponCoupon!required
+
deleteCustomAppointmentFieldCustomAppointmentField
+

Deletes a custom appointment field

deleteCustomAppointmentFieldValueCustomAppointmentFieldValue
+

Deletes a custom appointment field value

deleteCustomClientFieldCustomClientField
+

Deletes a custom client field

deleteCustomClientFieldValueCustomClientFieldValue
+

Deletes a custom client field value

deleteCustomLocationAttributeCustomLocationAttribute!required
+
deleteCustomLocationProviderScheduleLocationProviderSchedule
+
deleteCustomPatientFieldCustomPatientField
+

Deletes a custom patient field

deleteCustomPatientFieldValueCustomPatientFieldValue
+

Deletes a custom patient field value

deleteDepartmentDepartment!required
+
deleteDiagnosticDiagnostic!required
+
deleteEncounterEncounter
+
deleteEncounterProductEncounterProduct!required
+
deleteEncounterSectionEncounter
+

Deletes the corresponding section for the given `encounter_id`'s sections at the `section_idx`th position

deleteEncounterSectionDatumEncounter
+

Deletes the `datum_idx`th datum for the given encounter's `section_idx`

deleteEncounterTypeEncounterType!required
+
deleteEntitiesTagEntitiesTag
+
deleteEntityTagEntityTag!required
+
deleteEntityTagGroupEntityTagGroup!required
+
deleteEntityValidationEntityValidation!required
+
deleteEstimateEstimate
+
deleteEstimateItemEstimateItem
+
deleteFulfillmentSourceFulfillmentSource!required
+
deleteImmunizationImmunization!required
+
deleteImportedDataDeletionLog
+
deleteLabImageLabResult
+

Delete an existing image from the specified lab result.

deleteLabOrderLabOrder
+
deleteLabResultLabResult!required
+
deleteLicenseLicense
+
deleteLinkedClinicalNoteClinicalNote
+
deleteLinkedEncounterEncounter
+
deleteLinkedProductProduct
+
deleteLocationLocation
+
deleteLocationProviderScheduleLocationProviderSchedule!required
+
deleteLocationScheduleLocationSchedule
+

Deletes a location's schedule

deleteLocationTagLocationTag!required
+
deleteMacroMacro!required
+
deleteMedicationMedication
+
deleteMessageMessage
+
deleteNotificationNotification!required
+
deleteOrderOrder
+
deleteOrderFlagOrderFlag!required
+
deleteOrderItemOrderItem
+
deleteOrgDepartmentOrgDepartment!required
+
deleteOrgLabOrgLab
+
deleteOrphanTransactionMedicationIntegrationTransaction!required
+

Deletes an orphan transaction. Should only be used when the Cubex Two-Way integration is enabled

deletePackagePackageProductPackage
+
deletePatientComplicationPatientComplication!required
+
deletePatientDocumentPatientDocument
+
deletePatientTagPatientTag!required
+
deletePriceChangePriceChange
+

Deletes a price change

deleteProblemProblem!required
+
deleteProductProduct
+
deleteProductCategoryProductCategory!required
+
deleteProductManufacturerProductManufacturer
+
deleteProductPackageProductPackage
+
deleteProductPackageItemProductPackageItem!required
+
deleteProductPriceProductPrice!required
+
deleteProductTypeProductType!required
+
deleteProtocolProtocol!required
+
deleteProviderPunchProviderPunch!required
+
deleteProviderRoleProviderRole!required
+
deletePurchaseOrderPurchaseOrder
+
deletePurchaseOrderItemPurchaseOrderItem
+
deleteRdvmRdvm
+
deleteRdvmDocumentRdvmDocument
+
deleteRdvmVisitRdvmVisit!required
+
deleteRelationshipRelationship!required
+
deleteReminderReminder!required
+
deleteReservationReservation!required
+
deleteRevenueCenterRevenueCenter!required
+
deleteScheduleTemplateScheduleTemplate!required
+
deleteStockTransferStockTransfer
+
deleteStockTransferItemStockTransferItem
+
deleteTaskCategoryTaskCategory
+
deleteTaskGroupTaskGroup!required
+
deleteTreatmentTreatment!required
+
deleteTreatmentSheetTreatmentSheet
+
deleteTreatmentSheetRowTreatmentSheetRow
+
deleteTreatmentSheetRowAdditiveEntryTreatmentSheetRowAdditiveEntry
+
deleteTreatmentSheetTemplateTreatmentSheetTemplate
+
deleteTriggerTrigger
+
deleteVitalsVitals!required
+
deleteWishlistItemWishlistItem
+
disableDiscountReasonDiscountReason
+
dismissVoiceCallsString
+

Dismiss voice calls for a location

downloadProtocolsMigrationCsvString
+
downloadUsageReportString
+
emailBillingStatementsBoolean
+

Either zips & emails all billing statements at the given location to the list of provided emails, or if no emails are provided, emails each client their billing statement if they have one.

emailClientBillingStatementString
+
DEPRECATED: Superseded by `emailBillingStatements`.
emailClientPaymentReceiptString
+
emailClientsAddressesString
+
emailCreditMemoToClient[EmailStatus]
+
emailEncounter[EmailStatus]
+
emailEncounterPdf[String]
+
DEPRECATED: You can use email_encounter_record
emailEncounterRecord[EmailStatus]
+
emailEncounterRecordToCustom[EmailStatus]
+
emailEncounterRecordToRdvms[EmailStatus]
+
emailEstimateToClient[EmailStatus]
+
emailFilteredProductsString
+
emailHospitalizationNoticeToRdvms[EmailStatus]
+
emailImmunizationsRecordString
+
emailInventoryCsvString
+
emailInvoiceToClient[EmailStatus]
+
emailLabResult[EmailStatus]
+
emailMedicalRecordsSummaryString
+
emailPatientCompliancesReportString
+
emailProductsCsvString
+
emailRabiesCertificateString
+
emailRdvmsCsvString
+
emailRemindersCsvString
+
emailSelectedRabiesCertificatesString
+
emailTreatmentSheetSummaryString
+
emailUsageReportBoolean
+
encounterPdfString
+
DEPRECATED: You can use encounter_summary
endOfDayReportString
+
endVideoCallString
+
endVisitVisit
+
enrollPlanPatientPlan
+
entitiesTagEntitiesTag
+
entityTagEntityTag
+
fetchVetrocketImagesLabResult
+
finishLabOrderLabOrder
+
genVetsourceUrlString
+
generateAgedArReportAgedArReportGeneration!required
+

Generate aged accounts receivable report

generateClientAuthTokenString
+
generateInventoryReportString
+
generateInvoiceOrder
+
generatePlumbsPdfUrlString
+
generatePlumbsUrlString
generateUsageSummaryReportString
+
groupOrderItemsByPatientOrder
+
invoiceBarcodesPdfString
+
invoiceBoardRowOrder
+
issueCreditDiscountString
+
linkCallVoiceCall
+
linkOrphanLabResultToPatientLabResult!required
+

Links a lab result to a patient

linkPatientPlanChargeToOrderItemPatientPlanCharge
+
makeAppointmentTypeDefaultAppointmentType
+
markAllNormalEncounterEncounter
+
markCubexDiagnosticAsPendingApprovalDiagnostic!required
+

Mark a cubex-related diagnostic as pending approval. Should only be used when the Cubex Two-Way integration is enabled.

markCubexEncounterProductAsPendingApprovalEncounterProduct!required
+

Mark a cubex-related encounter product as pending approval. Should only be used when the Cubex Two-Way integration is enabled.

markCubexMedicationAsPendingApprovalMedication!required
+

Mark a cubex-related medication as pending approval. Should only be used when the Cubex Two-Way integration is enabled.

markCubexTreatmentAsPendingApprovalTreatment!required
+

Mark a cubex-related treatment as pending approval. Should only be used when the Cubex Two-Way integration is enabled.

markOrderPaidIfFullyPaidOrder
+
markOrderUncollectibleOrder
+
markPostcardProtocolReminderAsSentProtocolReminder
+
markVisitReadyForDischargeVisit
+
massMicrochipRegister[String]
+
mergeClientReferralSources[ClientReferralSource]
+
mergeClientsClient
+
mergePatientsPatient
+
mergeRdvmsRdvm!required
+
movePatientToClientPatient
+
newEncounterEncounter
+

Create a new encounter for a patient at a location

newVendorVendor
+
onboardPetdxLabOrgLab
+
orderLabLabOrder
+
orderWishlistLocation
+
paymentReceiptPdfString
+
performDatasyncDatasyncLog
+
prescribeMedicationMedication
+

Prescribe a medication

previewPriceChangeString
+

Previews a price change

printLabelPrintnodePrintLabelResult
+
promoteEstimateToBoardBoardRow
+
pushMedicationToCubexString
+
pushToCubexString
+
pushTreatmentToCubexString
+
readAllNotificationsInt
readNotificationNotification
+
reassignProductTypeProductType
+
recordPatientWeightVitals
+
refillMedicationMedication
+
refreshLabResultLabResult
+
refreshPreventionPlan[PatientPlan]
+
refundOrderItemOrderItem
+
DEPRECATED: Please *do not* use this mutation any longer. Refunding order items now no longer respects the `returned`, `credit`, or `not rendered` args, nor will it always mark the given order as `returned`/`credited`/`not_rendered`, as these states are no longer going to be used. Please update your code to use `returnOrderItem` instead.
refundPaymentPayment
+
registerPatientMicrochipPatient
+
removeClientStripeInfoString
+
removePatientPlanItemPatientPlanItem
+
removeReviewerFromLabResultLabResult
+

Removes a provider from a lab result

reopenEncounterEncounter
+
reopenOrderOrder
+
reopenVisitVisit
+
reorderAlerts[Alert]
+
reorderBoardingCagesBoardingCage!required
+
reorderBoardingWardsBoardingWard!required
+
reorderClientReferralSources[ClientReferralSource]
+
reorderEntityTags[EntityTag]
+
reorderEstimateItemsEstimate
+
reorderOrderItemsOrder
+
replaceEncounterSectionDatumEncounter
+

Replaces a given datum by (section_idx x datum_idx) with provided JSON. Note that no validity checking of the datum input is performed. If you wish to simply update a given datum, you can more safetly use `replace_encounter_section_datum` instead.

requestMedicationApprovalMedication
+

Update a draft medication to request approval from a veterinarian

requestSourceDataDownloadUrlDatasyncLog
+
resendAllFailedProtocolRemindersInt
resendVerificationString
+
resetProviderPinProvider
+
retryJobObanJob
+
retryLabOrderPlacementLabOrder
+
returnOrderItem[ReturnedOrderItem]
+
reviewArReconciliationArReconciliation!required
+
runAdHocAutoMessageAutoMessage!required
+
runArReconciliationArReconciliation!required
+
saveEstimateEstimate
+
saveMicrochipPatient
+
saveProviderElectronicSignatureProvider
+
saveTreatmentSheetCellOrderItemTreatmentSheetCell
+
saveTreatmentSheetRowAdditiveEntryTreatmentSheetRowAdditiveEntry
+
sendApptConfirmationAppointment
+
sendCardConnectHostedPaymentRequestString
+
sendCareCreditPaymentUrlString
+
sendEmailVerificationClient
+
sendLocationChatMessageLocationChatMessage
+
sendMessageMessage
+
sendNewsletterNewsletter
+
sendNewsletterTestString
+
sendOutlookEmailVerificationProvider
sendPaymentRequestString
+
sendReminderProtocolReminder
+
sendTestEmailString
+
setApptPickupTimeAppointment
+
setChatLastReadAtString
+
setDaycareOpenBoolean
+
setFeatureFlagBoolean
+
signEncounterEncounter
+

Sign an encounter with the current user

signTreatmentSheetTreatmentSheet
+
startAsyncMedicalRecordAsyncMedicalRecord
+
startConversationConversation
+
startVisitVisit
+
stripeAttachPaymentMethodToCustomerStripePaymentMethod
+
stripeCancelReaderActionStripeReader
+
stripeUpsertCustomerStripeCustomer
+
surgeryLogPdfString
+
swapAppointmentStartTimesSwapAppointmentResult
+

Swap the start times of two appointments

switchStockTransferStockTransfer
+
syncClientSyncClientResult
+
testMicrosoftCalendarIntegrationString
textApptReadyAppointment
+
transferPatientPatient
+
triggerPrescriptionMedication
+
unassignProblemFromEncounterProblem
+

Assign a problem in the patient's problem list to the encounter

unassignProviderFromLocationProvider
+

Removes a provider from a location

unassignProviderFromTaskTask
+

Removes a provider from a task

uncompleteBoardCellBoardCell
+
undoWastageAdjustmentInventoryAdjustment
+
unlinkCallVoiceCall
+
updateAddressAddress
+

Updates an address under the client's info

updateAlertAlert
+
updateAllergyAllergy
+
updateAppointmentAppointment
+
updateAppointmentIntakeAppointmentIntakeData
+
updateAppointmentTypeAppointmentType
+
updateAppointmentTypeTagAppointmentTypeTag
+
updateAutoMessageAutoMessage!required
+
updateBoardCellBoardCell
+
updateBoardRowBoardRow
+
updateBoardingBlockReservation!required
+
updateBoardingCageBoardingCage!required
+
updateBoardingWardBoardingWard!required
+
updateCadenceCadence
+
updateCageCage
+
updateCallLogCallLog
+
updateCareTeamRoleCareTeamRole
+
updateClientClient
+

Mutate a client if authorized

updateClientExternalCommPreferencesClientExternalCommPreferencesValue
+
updateClientRdvmClientRdvm
+
updateClientReferralSourceClientReferralSource
+
updateClientTagClientTag
+
updateClinicalNoteClinicalNote
+
updateCommentComment
+
updateComplicationComplication
+
updateConsentFormConsentForm
+
updateConversationConversation
+
updateCoownerCoowner
+

Updates an associate

updateCouponCoupon
+
updateCustomAppointmentFieldValueCustomAppointmentFieldValue
+

Updates a custom appointment field value

updateCustomClientFieldValueCustomClientFieldValue
+

Updates a custom client field value

updateCustomLocationAttributeCustomLocationAttribute
+
updateCustomPatientFieldValueCustomPatientFieldValue
+

Updates a custom patient field value

updateCustomPatientProtocolCustomPatientProtocol
+
updateDepartmentDepartment!required
+
updateDiagnosticDiagnostic
+
updateDialpadSubscriptionOrg
+

create or delete a subscription to dial pad call events

updateDiscountReasonDiscountReason
+
updateEncounterEncounter
+

Update a live encounter

updateEncounterCareTeamMembers[EncounterCareTeamMember]
+

Update encounter care team members

updateEncounterProductEncounterProduct
+
updateEncounterSectionEncounter
+

Updates the section corresponding to the given `section_idx` for the given `encounter_id`

updateEncounterSectionDatumEncounter
+

Updates a given datum by (section_idx x datum_idx) with provided changeset

updateEncounterTypeEncounterType
+
updateEntityTagEntityTag
+
updateEntityTagGroupEntityTagGroup
+
updateEntityValidationEntityValidation
+
updateEstimateEstimate
+
updateEstimateItemEstimateItem
+
updateEstimateItemsEstimate
+
updateFulfillmentSourceFulfillmentSource
+
updateHospitalizationHospitalization
+
updateHospitalizationTaskHospitalizationTask
+
updateImmunizationImmunization
+
updateLabOrderLabOrder
+
updateLabResultLabResult
+
updateLicenseLicense
+
updateLinkedClinicalNoteLinkedClinicalNote
+

Update a linked clinical note

updateLinkedEncounterLinkedEncounter
+

Update a linked encounter

updateLocationLocation
+

Updates a location

updateLocationAttributeLocationAttribute
+
updateLocationHoursLocationHours
+
updateLocationProviderScheduleLocationProviderSchedule
+
updateLocationScheduleLocationSchedule
+
updateLocationTagLocationTag
+
updateMacroMacro
+
updateMedicationMedication!required
+

Update a medication

updateMedicationPharmacyFieldsMedication!required
+

Update pharmacy-specific fields in a medication

updateMedicationWithPharmacyStatusMedication!required
+

Update a medication with pharmacy status support

updateNewsletterNewsletter
+
updateOrderOrder
+
updateOrderFlagOrderFlag
+
updateOrderItemOrderItem
+
updateOrderItemsOrder
+
updateOrgOrg
+

Update the viewer's org if the provider is an org admin

updateOrgDepartmentOrgDepartment!required
+
updateOrgLabOrgLab
+
updateOrgLabWithCheckOrgLabUpdateResult
+
updateOrgPreferenceOrgPreference
+
updateOutlookOrgPreferenceOrgPreference
+
updatePatientPatient
+
updatePatientComplicationPatientComplication
+
updatePatientDocumentPatientDocument
+
updatePatientPlanPatientPlan!required
+
updatePatientPlanItemPatientPlanItem
+
updatePatientTagPatientTag
+
updatePaymentPayment
+
updatePhoneNumberPhoneNumber
+

Mutate a phone number

updatePreventionPlanPreventionPlan
+
updatePriceChangePriceChange
+

Updates a price change

updateProblemProblem
+
updateProductProduct
+

Update a product

updateProductCategoryProductCategory
+
updateProductCubexEnabledProduct
+

Controls whether a product is synced to Cubex at the specified location. Requires the Cubex Sync feature to be enabled.

updateProductEnabledProduct
+
updateProductManufacturerProductManufacturer
+
updateProductPackageProductPackage
+
updateProductPackageItemProductPackageItem
+
updateProductPriceProductPrice
+
updateProductProductCategoryProduct
+
updateProductTypeProductType
+
updateProtocolProtocol
+
updateProtocolReminderProtocolReminder
+
updateProviderProvider
+

Mutate a provider only if you are an org admin

updateProviderPunchProviderPunch!required
+
updateProviderRoleProviderRole!required
+
updateProviderTransferProviderTransfer
+
updatePurchaseOrderPurchaseOrder
+
updatePurchaseOrderItemPurchaseOrderItem
+
updateQuantityStockTransferItemStockTransferItem
+
updateRdvmRdvm
+
updateRdvmContactRdvmContact
+
updateRdvmVisitRdvmVisit
+
updateReconciliationNoteReconciliationNote!required
+
updateRelationshipRelationship!required
+
updateReminderReminder
+
updateReminderSilenceReminderSilence
+
updateReservationReservation!required
+
updateRevenueCenterRevenueCenter
+
updateRevenueCenterBudgetRevenueCenterBudget
+
updateScheduleTemplateScheduleTemplate
+
updateStockLocationStockLocation
+
updateStockTransferStockTransfer
+
updateStockTransferItemStockTransferItem
+
updateTaskTask
+
updateTaskCategoryTaskCategory
+
updateTaskGroupTaskGroup!required
+
updateTreatmentTreatment
+
updateTreatmentSheetTreatmentSheet
+
updateTreatmentSheetCellTreatmentSheetCell
+
updateTreatmentSheetRowTreatmentSheetRow
+
updateTreatmentSheetStartTreatmentSheet
+
updateTreatmentSheetTemplateTreatmentSheetTemplate
+
updateTreatmentSheetTimeSlotsTreatmentSheet
+
updateTriggerTrigger
+
updateVendorVendor
+
updateViewerProvider
+
updateViewerPasswordProvider
+
updateVitalsVitals
+
updateVoiceCallVoiceCall
+
updateWishlistItemWishlistItem
+
uploadClinicImageLocation
+
uploadEncounterTypeAssetString
+
uploadLabImageLabResult
+

Create a new image for the specified lab result.

uploadMassInventoryMassUploadResult
+
uploadMassProductsString
+
uploadMassRdvmsString
+
uploadPatientDocumentPatientDocument
+
uploadPatientImagePatient
+
uploadProtocolsMigrationCsvString
+
uploadProviderElectronicSignatureProvider
+
uploadProviderProfileImageProvider
+
uploadRdvmDocumentRdvmDocument
+
upsertLowStockThresholdLowStockThreshold
+
upsertPackageLocationMarkupLocationOrLocationTag
+
upsertProductLocationMarkupLocationOrLocationTag
+
upsertProductTypeLocationMarkupLocation
+
upsertProviderAppointmentTypeLimitProviderAppointmentTypeLimit
+
upsertProviderCommissionProviderCommission
+
upsertProviderPreferencesProviderPreferences
+
validateControlledDrugPinBoolean
+
valuesetLabelString
+
voidPaymentPayment
+