List of API Permissions

List of API permissions required for using the Provet Cloud REST API. Permissions template keys are used for ProvetHub permission template to automatically assign permissions.

General

Permission Name	Permission Key
Conversations	conversations
Required two-factor authentication	require-two-factor-authentication
Patients and clients	patients-clients
Delete client	delete-clients
Consultations and its items	consultations
Add handling fee on consultation	use-dispense-fee
Add clinical notes on consultation	clinical-notes
Delete consultations	consultation-delete
Add unapproved clinical notes on consultation	unapproved-clinical-notes
Add unapproved diagnostic imaging referral reports	add-unapproved-referral-report
Approve unapproved diagnostic imaging referral reports	approve-referral-report
Add discharge instructions on consultation	discharge-instructions
Add AI discharge instruction summary	discharge-instructions-ai-summary
Add unapproved discharge instructions on consultation	unapproved-discharge-instructions
Approve unapproved discharge instructions	approve-discharge-instructions
Email unapproved discharge instructions	email-unapproved-discharge-instructions
Reminders	reminder
Use AI Scribe	ai-scribe
Edit notes, discharge instructions and clinical notes made by other users	edit-others-notes
Add / edit discharge instructions and clinical notes after consultation has been finalized	always-edit-consultation-notes
Edit locked notes through API	edit-locked-notes
Mark patients as private	mark-as-private
Tasks	task
Tasks of users from all wards and departments	tasks-of-all-departments
Use AI Patient History	ai-patient-history
Treatment plans	treatment_plan-item
Clinical notes made by students	approve-student-notes
My workspace	workspace
Add unapproved feedback for referring vet	add-unapproved-feedback
Approve feedback for referring vet	approve-feedback
Email feedback to referring vet	email-feedback
Add notes and communication	notes-and-communication
Delete notes and communication	notes-and-communication-can-delete
See deleted notes and communication	notes-and-communication-see-deleted
Set the “on stop” status and create new transactions for clients	use-client-on-stop
Complication reports	complication-report
Release notes	changelog
Read all uploaded files via API	upload-read-all
Create refills outside consultation	add-refill-outside-consultation
Cancel refills	cancel-refills
Appointments page	appointments-page
Appointments	appointments-access
Finder page	finder-page
Shifts page	shifts-page
Shifts	shifts-access
Day plan page	appointments-dayplan
Medvind	medvind
Booking capacity page	bookingcapacity-page
Invoices	invoice
Cancel payment	cancel-payment
Manually set the date on an invoice payment	invoice-payment-date
Change the invoice date	invoice-date
Change price on invoices	invoce-price-edit
Change price on invoices on procedures	invoice-price-edit-on-procedures
Change price change on invoices	invoice-price-change-edit
Change price change on invoices on procedures	invoice-price-change-edit-on-procedures
Manually set the date on a prepayment	client-prepayment-date
Transfer payments to prepayments	prepayment-transfer
Transfer credit note to prepayments	credit-note-to-prepayment-transfer
Credit items on invoices	invoice-negative-amount
End of day and accounting reports	invoice-end-of-day
Estimates	estimate
Estimate bundles	estimate-bundles
Insurance claims	insurance
Delete insurance claims	delete-insurance-claim
Delete insurance claims on finalized invoices	delete-insurance-claim-on-finalized-invoices
Create credit note	credit-note
Create credit notes for credit notes	creat-credit-note-from-credit-note
Use “Credit and invoice again” in credit note modal	credit-note-and-invoice-again
Create credit notes from invoices with insurance claims	credit-note-with-insurance
Statements	statement
Diagnostic imaging referrals	diagnostic_imaging-referrals
Personal details	user-personal-details
Change own password	user-change-password
Multi-factor authenticators	user-multifactor-authentication
Change own preferences	user-preferences
Theme	user-theme
Other users availability information	can-edit-other-users-availability-status
Notifications	notification
Create / edit users through API	user-api-management
Initials	user-edit-initials
Email	user-edit-email
Choices API	reports-choices
Reports page	reports-page
Practice performance reports	reports-practice-performance
Stock management reports	reports-stock-management
Communication reports	reports-communication
Lists reports	reports-lists
Business intelligence reports	reports-business-intelligence
My statistics (only for veterinarians)	reports-my-statistics
Product orders / purchase invoices	edit-purchase-orders
Delete product orders / purchase invoices	delete-purchase-orders
Wholesalers	edit-wholesalers
Stock locations	edit-stock-locations
Move stock between departments	move-stock-between-departments
Catalog management	catalog-management
Add, edit and copy general prescriptions	prescription-edit
See prescription fees from all users	prescription-see-fees-from-all-users
Add health plan subscriptions to patients	add-health-plan-subscription
Update health plan statuses	update-health-plan-status
Cancel patient health plan subscriptions	cancel-health-plan-subscription
Manage payment service settings	payment-gateway-pay-manage
Payment service reports	payment-gateway-pay-reports
Make payments	payment-gateway-pay-payments
Charge tokenized payment cards	payment-gateway-pay-tokenized

Calendar

Permission Name	Permission Key
Calendar feeds	user-calendar-feeds

Financial

Permission Name	Permission Key
Financial reports	reports-financial
Financial Invoices reports	reports-financial-invoices
Financial Payments reports	reports-financial-payments
Financial Prepayments reports	reports-financial-prepayments
Financial Sales by payment type reports	reports-financial-sales-by-payment
Financial Item purchases reports	reports-financial-item-purchases
Financial Item sales reports	reports-financial-item-sales
Financial Discounts reports	reports-financial-discounts
Financial Commissions reports	reports-financial-commissions
Financial Gross profit reports	reports-financial-gross-profit
Financial Debtors and creditors reports	reports-financial-debtors_and_creditors
Financial Unpaid invoices reports	reports-financial-unpaid-invoices
Financial Bank payment processing reports	reports-financial-bank-payment-processing
Financial Month end reports	reports-financial-month-end
Financial E-prescription fees reports	reports-financial-epresc-fees
Financial Electronic journal reports	reports-financial-electronic-journal
Financial Central laboratory referral rows reports	reports-financial-cl-referral-rows
Financial Central laboratory month end reports	reports-financial-cl-month-end

Dashboard

Permission Name	Permission Key
Treatment plan dashboard	treatment_plan-dashboard
Pharmacy widget on dashboard	dashboard-pharmacy
Recent consultations widget on dashboard	dashboard-recent-consultations
Expiring reminders widget on dashboard	dashboard-expiring-reminders
Scheduled appointments widget on dashboard	dashboard-scheduled-appointments
Laboratory analyses widget on dashboard	dashboard-laboratory-anayses
Laboratory referrals widget on dashboard	dashboard-laboratory-referrals
Shared inbox widget on dashboard	dashboard-shared-inbox
Laboratory dashboard	laboratory-dashboard
Diagnostic imaging dashboard	diagnostic_imaging-dashboard
Patient referrals dashboard	patient-referrals-dashboard

Laboratory

Permission Name	Permission Key
Laboratory referrals	laboratory-referrals
Lock / unlock laboratory referrals	laboratory-lock-referrals
Approve / unapprove laboratory results	laboratory-approve_results
Approve / cancel laboratory reports	laboratory-approve_reports
Microbiology settings	laboratory-microbiology
Edit samples	laboratory-access-request-detail
Delete laboratory analysis from referral	delete-laboratory-analysis
Linked laboratory analyses in item settings	settings-item-linked-laboratory-analyses

Profile

Permission Name	Permission Key
User profile page	user-profile-page
Profile image	user-profile-image

Settings

Permission Name	Permission Key
Conditional pricing	settings-markup
Widget settings	user-widget-settings
Task settings	user-task-settings
Login credentials to Provet mobile app	user-mobile-app-settings
User-level print settings	user-print-settings
Settings page	settings-page
Organization settings	settings-organization
Department management	settings-department-management
Department settings	settings-department
Access/edit handling and injection fee settings	edit-handling-and-injection-fee-settings
Print settings	settings-print
Users	settings-user-administration
User groups and permissions	settings-group-administration
Integration settings	settings-integration
Manage webhooks via API	settings-webhook-via-api
VAT management settings	settings-vat-management
Items	settings-items
Create new items	settings-items-create
Delete items	settings-items-delete
Item description	settings-item-description
Item options	settings-item-options
Item vaccine options	settings-item-vaccine-options
Item withdrawal periods	settings-item-withdrawal-periods
Item wholesalers	settings-item-wholesalers
Linked items	settings-item-linked-items
Item stock options	settings-item-stock-options
Item stock alert levels	settings-item-stock-alert-level
Item waste management	settings-item-waste-management
Item cost centers	settings-item-cost-centers
Item pricing options	settings-item-pricing-options
Item pricing	settings-item-pricing
Item alternative pricing	settings-item-alternative-pricing
Item attachments	settings-item-attachments
Medicine instruction templates in item settings	settings-item-medicine-instruction-templates
Reference values in item settings	settings-item-reference-values
Creation rules in item settings	settings-item-creation-rules
Stock	settings-stock
Stock sharing settings	edit-stock-sharing-settings
Reasons	settings-reasons
Discount settings	settings-discounts
Templates	settings-templates
Client communication log	settings-client-communication
Shift template management	settings-shift-templates
Revision log	settings-revision-log
Shift types	settings-shift-types
User log	settings-user-log
Bundles	settings-bundles
Integration log	settings-integration-log
Settings log	settings-setting-log
List and list items	settings-lists
Reminder settings	settings-reminders
Tags	settings-tags
Importing functions	settings-import-functions
Exporting functions	settings-export-functions
Subscription settings	settings-subscription
Commission settings	settings-commissions
Health plan settings	settings-health-plan
Custom field settings	settings-custom-fields
Custom status field settings	settings-custom-status-fields
Screens	settings-proflow
Manage central items	settings-central-items

Patient referrals

Permission Name	Permission Key
Patient referrals	patient-referrals