Online Booking API
The OpenVPMS Booking API is a JSON API for making appointments in OpenVPMS.
This API first appears in OpenVPMS 2.0.
The current production version is the Online Booking API V1.
The Online Booking API V2 is in development.
Login or Join the Community (free)[You only need to join if you want to post to our forums or subscribe or donate.]
Documentation Navigation
- Online Documentation
- Online Documentation (2.2)
- Introduction
- Concepts
- Accounting
- Active/Deactivated
- Addresses
- Alerts
- Barcodes
- Categories and Classifications
- Contacts
- Deposit Accounts
- Discounts
- Documents
- Error Handling
- ESCI
- Estimates
- HL7
- Identities
- IDs
- Insurance
- Investigations
- Local Procedures
- Macros
- Medical Record Locking
- Messages
- Names
- OTC - Over The Counter
- Payment Types
- Practice and Locations
- Prescriptions
- Pricing
- Pricing Updates
- Printing
- Problems
- Product Batches
- Products
- Reminders
- Reports, Forms, Letters and Documents
- Schedules, Work Lists and Workflow
- SMS
- Stock Control
- Suppliers
- Taxes
- Tills
- Users
- Visits
- Workspaces
- Customers
- Patients
- Current Patient Alerts
- Information
- Insurance
- Medical Records
- Confirm Delete
- Confirm New
- Confirm Refresh
- Create/Edit Alert
- Create/Edit Attachment
- Create/Edit Form
- Create/Edit Image
- Create/Edit Investigation
- Create/Edit Letter
- Create/Edit Medication
- Create/Edit Note
- Create/Edit Prescription
- Create/Edit Problem
- Create/Edit Reminder
- Create/Edit Visit
- Add Problem to Visit
- Create/Edit Addendum
- Create/Edit Link
- Create/Edit Weight
- New Medication Record prompt
- New Visit & Note
- Select
- Select By Customer
- Suppliers
- Workflow
- Products
- Reporting
- Administration
- Organisation
- Calendar Event
- Clickatell
- Deposit Accounts
- Insurance Service
- Mail Server
- OTC
- Practice
- Practice Location
- Roster Area
- Schedule
- Schedule View
- Service Ratio Calendar
- SMS Configuration: Clickatell SMTP Connection
- SMS Configuration: Generic Email Gateway
- SMS Configuration: SMSGlobal Email2SMS
- Stock Location
- Till
- Work List
- Work List View
- Confirm Delete
- Confirm New
- Types
- Templates
- Lookups
- Address Format
- Bank
- Breed
- Colour
- Contact Purpose
- Country
- Credit Card
- Currency
- Custom Payment Type
- Customer Account Type
- Customer Alert Type
- Customer Communication Reason
- Customer Insurance
- Customer Referral
- Customer Type
- Customer Vet
- Demographic Update
- Diagnosis (VeNom)
- Diagnosis
- Duration Formats
- File Name Format
- Macro
- Message Reason
- Message Status
- Patient Alert Class
- Person Title
- Practice Type
- Presenting Complaint (VeNom)
- Presenting Complaint
- Confirm Delete
- Confirm New
- Confirm Replace
- Pricing Group
- Product Group
- Product Income Type
- Reminder Group
- Report Macros
- Report Type
- Species
- Species (IDEXX)
- State
- Suburb
- Supplier Account Type
- Supplier Type
- Tax Type
- Units of Measure
- Units of Measure Group
- User Name Format
- User Type
- Veterinary Speciality
- Visit Reason
- Visit Reason (VeNom)
- Laboratories
- ESCI
- HL7
- Jobs
- Users
- Groups
- Roles
- Authorities
- Archetypes
- Style Sheets
- System
- Organisation
- Help
- How To
- Administering OpenVPMS
- Appointment Reminders
- Correct 'patient added to wrong customer'
- Deputy Integration
- Email template Tips - Jaspersoft Studio
- Email Template Tips - Open Office
- HL7 Laboratories
- HL7 Pharmacies
- Online Bookings
- Online insurance claims with PetSure VetHub
- Online Investigations with IDEXX VetConnect
- Orders and Deliveries
- Over the Counter Refund
- Patients and Customers - Adding
- Patients and Customers - Finding
- Print General Labels
- Restrict what products are available at each location
- Rostering
- Smart Flow Sheet integration
- Test Reminders
- Use Gmail to send mail
- Reference
- Installing OpenVPMS
- New in 2.2
- Preferences
- Troubleshooting
- Online Documentation (2.1)
- Introduction
- Concepts
- Accounting
- Active/Deactivated
- Addresses
- Alerts
- Barcodes
- Categories and Classifications
- Contacts
- Deposit Accounts
- Discounts
- Documents
- Error Handling
- ESCI
- Estimates
- HL7
- Identities
- IDs
- Insurance
- Investigations
- Local Procedures
- Macros
- Medical Record Locking
- Messages
- Names
- OTC - Over The Counter
- Payment Types
- Practice and Locations
- Prescriptions
- Pricing
- Pricing Updates
- Printing
- Problems
- Product Batches
- Products
- Reminders
- Reports, Forms, Letters and Documents
- Schedules, Work Lists and Workflow
- SMS
- Stock Control
- Suppliers
- Taxes
- Tills
- Users
- Visits
- Workspaces
- Customers
- Patients
- Current Patient Alerts
- Information
- Insurance
- Medical Records
- Confirm Delete
- Confirm New
- Confirm Refresh
- Create/Edit Alert
- Create/Edit Attachment
- Create/Edit Form
- Create/Edit Image
- Create/Edit Investigation
- Create/Edit Letter
- Create/Edit Medication
- Create/Edit Note
- Create/Edit Prescription
- Create/Edit Problem
- Create/Edit Reminder
- Create/Edit Visit
- Add Problem to Visit
- Create/Edit Addendum
- Create/Edit Weight
- New Medication Record prompt
- New Visit & Note
- Select
- Select By Customer
- Suppliers
- Workflow
- Products
- Reporting
- Administration
- Organisation
- Calendar Event
- Deposit Accounts
- Insurance Service
- Mail Server
- OTC
- Practice
- Practice Location
- Roster Area
- Schedule
- Schedule View
- Service Ratio Calendar
- SMS Configuration: Clickatell SMTP Connection
- SMS Configuration: Generic Email Gateway
- SMS Configuration: SMSGlobal Email2SMS
- Stock Location
- Till
- Work List
- Work List View
- Confirm Delete
- Confirm New
- Types
- Templates
- Lookups
- Address Format
- Bank
- Breed
- Colour
- Contact Purpose
- Country
- Credit Card
- Currency
- Custom Payment Type
- Customer Account Type
- Customer Alert Type
- Customer Communication Reason
- Customer Insurance
- Customer Referral
- Customer Type
- Customer Vet
- Demographic Update
- Diagnosis
- Diagnosis (VeNom)
- Duration Formats
- File Name Format
- Macro
- Message Reason
- Message Status
- Patient Alert Class
- Person Title
- Practice Type
- Presenting Complaint
- Presenting Complaint (VeNom)
- Pricing Group
- Product Group
- Product Income Type
- Reminder Group
- Report Macros
- Report Type
- Species
- Species (IDEXX)
- State
- Suburb
- Supplier Account Type
- Supplier Type
- Tax Type
- Units of Measure
- Units of Measure Group
- User Name Format
- User Type
- Veterinary Speciality
- Visit Reason
- Visit Reason (VeNom)
- Confirm Delete
- Confirm New
- Confirm Replace
- HL7
- Jobs
- Users
- Groups
- Roles
- Authorities
- Archetypes
- Style Sheets
- System
- Organisation
- Help
- How To
- Administering OpenVPMS
- Appointment Reminders
- Correct 'patient added to wrong customer'
- Deputy Integration
- Email template Tips - Jaspersoft Studio
- Email Template Tips - Open Office
- HL7 Laboratories
- HL7 Pharmacies
- Online Bookings
- Online insurance claims with PetSure VetHub
- Orders and Deliveries
- Over the Counter Refund
- Patients and Customers - Adding
- Patients and Customers - Finding
- Print General Labels
- Restrict what products are available at each location
- Rostering
- Smart Flow Sheet integration
- Test Reminders
- Use Gmail to send mail
- Reference
- Installing OpenVPMS
- New in 2.1
- Preferences
- Troubleshooting
- Online Documentation (2.0)
- Introduction
- Concepts
- Accounting
- Active/Deactivated
- Addresses
- Alerts
- Barcodes
- Categories and Classifications
- Contacts
- Deposit Accounts
- Discounts
- Documents
- Error Handling
- ESCI
- Estimates
- HL7
- Identities
- IDs
- Insurance
- Investigations
- Local Procedures
- Macros
- Medical Record Locking
- Messages
- Names
- OTC - Over The Counter
- Payment Types
- Practice and Locations
- Prescriptions
- Pricing
- Pricing Updates
- Printing
- Problems
- Product Batches
- Products
- Reminders
- Reports, Forms, Letters and Documents
- Schedules, Work Lists and Workflow
- SMS
- Stock Control
- Suppliers
- Taxes
- Tills
- Users
- Visits
- Workspaces
- Customers
- Patients
- Information
- Insurance
- Medical Records
- Confirm Delete
- Confirm New
- Confirm Refresh
- Create/Edit Alert
- Create/Edit Attachment
- Create/Edit Form
- Create/Edit Image
- Create/Edit Investigation
- Create/Edit Letter
- Create/Edit Medication
- Create/Edit Note
- Create/Edit Prescription
- Create/Edit Problem
- Create/Edit Reminder
- Create/Edit Visit
- Add Problem to Visit
- Create/Edit Weight
- New Medication Record prompt
- New Visit & Note
- Select
- Suppliers
- Workflow
- Products
- Reporting
- Administration
- Organisation
- Types
- Templates
- Lookups
- Address Format
- Bank
- Breed
- Colour
- Contact Purpose
- Country
- Credit Card
- Currency
- Custom Payment Type
- Customer Account Type
- Customer Alert Type
- Customer Communication Reason
- Customer Insurance
- Customer Referral
- Customer Type
- Customer Vet
- Demographic Update
- Diagnosis
- Diagnosis (VeNom)
- Duration Formats
- File Name Format
- Macro
- Message Reason
- Message Status
- Patient Alert Class
- Person Title
- Practice Type
- Presenting Complaint
- Presenting Complaint (VeNom)
- Pricing Group
- Product Group
- Product Income Type
- Reminder Group
- Report Macros
- Report Type
- Species
- Species (IDEXX)
- State
- Suburb
- Supplier Account Type
- Supplier Type
- Tax Type
- Units of Measure
- Units of Measure Group
- User Name Format
- User Type
- Veterinary Speciality
- Visit Reason
- Visit Reason (VeNom)
- Confirm Delete
- Confirm New
- Confirm Replace
- HL7
- Jobs
- Users
- Groups
- Roles
- Authorities
- Archetypes
- Style Sheets
- System
- Help
- How To
- Administering OpenVPMS
- Appointment Reminders
- Correct 'patient added to wrong customer'
- Email template Tips - Jaspersoft Studio
- Email Template Tips - Open Office
- HL7 Laboratories
- HL7 Pharmacies
- Online Bookings
- Online insurance claims with PetSure VetHub
- Orders and Deliveries
- Over the Counter Refund
- Patients and Customers - Adding
- Patients and Customers - Finding
- Print General Labels
- Restrict what products are available at each location
- Smart Flow Sheet integration
- Test Reminders
- Use Gmail to send mail
- Reference
- Installing OpenVPMS
- New in 2.0
- Preferences
- Troubleshooting
- Online Documentation (1.9)
- Introduction
- Concepts
- Accounting
- Active/Deactivated
- Addresses
- Alerts
- Barcodes
- Categories and Classifications
- Contacts
- Deposit Accounts
- Discounts
- Documents
- Error Handling
- ESCI
- Estimates
- HL7
- Identities
- IDs
- Insurance
- Investigations
- Local Procedures
- Macros
- Medical Record Locking
- Messages
- Names
- OTC - Over The Counter
- Payment Types
- Practice and Locations
- Prescriptions
- Pricing
- Pricing Updates
- Printing
- Problems
- Product Batches
- Products
- Reminders
- Reports, Forms, Letters and Documents
- Schedules, Work Lists and Workflow
- SMS
- Stock Control
- Suppliers
- Taxes
- Tills
- Users
- Visits
- Workspaces
- Customers
- Patients
- Information
- Medical Records
- Confirm Delete
- Confirm New
- Confirm Refresh
- Create/Edit Alert
- Create/Edit Attachment
- Create/Edit Form
- Create/Edit Image
- Create/Edit Investigation
- Create/Edit Letter
- Create/Edit Medication
- Create/Edit Note
- Create/Edit Prescription
- Create/Edit Problem
- Create/Edit Reminder
- Create/Edit Visit
- Add Problem to Visit
- Create/Edit Weight
- New Medication Record prompt
- Select
- Suppliers
- Workflow
- Products
- Reporting
- Administration
- Organisation
- Deposit Accounts
- Job Configuration: Appointment Reminder Sender
- Job Configuration: Document Loader
- Job Configuration: ESCI Inbox Reader
- Job Configuration: Medical Record Locker
- Mail Server
- OTC
- Practice
- Practice Location
- Schedule
- Schedule View
- SMS Configuration: Clickatell SMTP Connection
- SMS Configuration: Generic Email Gateway
- SMS Configuration: SMSGlobal Email2SMS
- Stock Location
- Till
- Work List
- Work List View
- Confirm Delete
- Confirm New
- Types
- Templates
- Lookups
- Bank
- Breed
- Colour
- Contact Purpose
- Country
- Credit Card
- Currency
- Custom Payment Type
- Customer Account Type
- Customer Alert Type
- Customer Communication Reason
- Customer Insurance
- Customer Referral
- Customer Type
- Customer Vet
- Demographic Update
- Diagnosis
- Diagnosis (VeNom)
- Duration Formats
- File Name Format
- Macro
- Message Reason
- Message Status
- Patient Alert Type
- Person Title
- Practice Type
- Presenting Complaint
- Presenting Complaint (VeNom)
- Pricing Group
- Product Group
- Product Income Type
- Reminder Group
- Report Macros
- Report Type
- Species
- Species (IDEXX)
- State
- Suburb
- Supplier Account Type
- Supplier Type
- Tax Type
- Units of Measure
- Units of Measure Group
- User Name Format
- User Type
- Veterinary Speciality
- Visit Reason
- Visit Reason (VeNom)
- Confirm Delete
- Confirm New
- Confirm Replace
- HL7
- Users
- Groups
- Roles
- Authorities
- Archetypes
- Style Sheets
- System
- Organisation
- Help
- How To
- Administering OpenVPMS
- Appointment Reminders
- Correct 'patient added to wrong customer'
- Email Template Tips
- HL7 Laboratories
- HL7 Pharmacies
- Orders and Deliveries
- Over the Counter Refund
- Patients and Customers - Adding
- Patients and Customers - Finding
- Print General Labels
- Restrict what products are available at each location
- Smart Flow Sheet integration
- Use Gmail to send mail
- Reference
- Installing OpenVPMS
- New in 1.9
- Preferences
- Troubleshooting
- Online Documentation (1.8)
- Introduction
- Concepts
- Accounting
- Active/Deactivated
- Addresses
- Alerts
- Barcodes
- Categories and Classifications
- Contacts
- Deposit Accounts
- Discounts
- Documents
- Error Handling
- ESCI
- Estimates
- HL7
- Identities
- IDs
- Insurance
- Investigations
- Local Procedures
- Macros
- Messages
- Names
- OTC - Over The Counter
- Payment Types
- Practice and Locations
- Prescriptions
- Pricing
- Pricing Updates
- Printing
- Problems
- Product Batches
- Products
- Reminders
- Reports, Forms, Letters and Documents
- Schedules, Work Lists and Workflow
- SMS
- Stock Control
- Suppliers
- Taxes
- Tills
- Users
- Visits
- Workspaces
- Customers
- Patients
- Information
- Medical Records
- Confirm Delete
- Confirm New
- Confirm Refresh
- Create/Edit Alert
- Create/Edit Attachment
- Create/Edit Form
- Create/Edit Image
- Create/Edit Investigation
- Create/Edit Letter
- Create/Edit Medication
- Create/Edit Note
- Create/Edit Prescription
- Create/Edit Problem
- Create/Edit Reminder
- Create/Edit Visit
- Add Problem to Visit
- Create/Edit Weight
- New Medication Record prompt
- Select
- Suppliers
- Workflow
- Products
- Reporting
- Administration
- Organisation
- Deposit Accounts
- Job Configuration: Document Loader
- Job Configuration: ESCI Inbox Reader
- OTC
- Practice
- Practice Location
- SMS Configuration: Clickatell SMTP Connection
- SMS Configuration: Generic Email Gateway
- SMS Configuration: SMSGlobal Email2SMS
- Schedule
- Schedule View
- Stock Location
- Till
- Work List
- Work List View
- Confirm Delete
- Confirm New
- Types
- Templates
- Lookups
- Bank
- Breed
- Colour
- Contact Purpose
- Country
- Credit Card
- Currency
- Custom Payment Type
- Customer Account Type
- Customer Alert Type
- Customer Insurance
- Customer Note Category
- Customer Referral
- Customer Type
- Customer Vet
- Demographic Update
- Pricing Group
- Report Type
- Diagnosis (VeNom)
- Diagnosis
- File Name Format
- Presenting Complaint (VeNom)
- Presenting Complaint
- Duration Formats
- Macro
- Message Reason
- Message Status
- Patient Alert Type
- Person Title
- Practice Type
- Product Group
- Confirm Delete
- Confirm New
- Confirm Replace
- Product Income Type
- Reminder Group
- Report Macros
- Species
- State
- Suburb
- Supplier Account Type
- Supplier Type
- Tax Type
- Units of Measure
- Units of Measure Group
- User Type
- Veterinary Speciality
- Visit Reason
- HL7
- Users
- Groups
- Roles
- Authorities
- Archetypes
- Style Sheets
- Organisation
- Help
- How To
- Reference
- Installing OpenVPMS
- New in 1.8
- Troubleshooting
- Online Documentation (1.7)
- Introduction
- Concepts
- Accounting
- Active/Deactivated
- Addresses
- Alerts
- Barcodes
- Categories and Classifications
- Contacts
- Deposit Accounts
- Discounts
- Documents
- Error Handling
- ESCI
- Estimates
- Identities
- IDs
- Insurance
- Investigations
- Local Procedures
- Macros
- Messages
- Names
- OTC - Over The Counter
- Payment Types
- Practice and Locations
- Prescriptions
- Pricing
- Pricing Updates
- Printing
- Problems
- Products
- Reminders
- Reports, Forms, Letters and Documents
- Schedules, Work Lists and Workflow
- SMS
- Stock Control
- Suppliers
- Taxes
- Tills
- Users
- Visits
- Workspaces
- Customers
- Patients
- Information
- Medical Records
- Confirm Delete
- Confirm New
- Confirm Refresh
- Create/Edit Alert
- Create/Edit Attachment
- Create/Edit Form
- Create/Edit Image
- Create/Edit Investigation
- Create/Edit Letter
- Create/Edit Medication
- Create/Edit Note
- Create/Edit Prescription
- Create/Edit Problem
- Create/Edit Reminder
- Create/Edit Visit
- Create/Edit Weight
- New Medication Record prompt
- Select
- Suppliers
- Workflow
- Products
- Reporting
- Administration
- Organisation
- Types
- Templates
- Lookups
- Appointment Reason
- Bank
- Breed
- Colour
- Contact Purpose
- Country
- Credit Card
- Currency
- Custom Payment Type
- Customer Account Type
- Customer Alert Type
- Customer Insurance
- Customer Note Category
- Customer Referral
- Customer Type
- Customer Vet
- Demographic Update
- Duration Formats
- Macro
- Message Reason
- Message Status
- Patient Alert Type
- Person Title
- Practice Type
- Product Group
- Product Income Type
- Reminder Group
- Report Macros
- Species
- State
- Suburb
- Supplier Account Type
- Supplier Type
- Tax Type
- Units of Measure
- Units of Measure Group
- User Type
- Veterinary Speciality
- Confirm Delete
- Confirm New
- Confirm Replace
- Users
- Groups
- Roles
- Authorities
- Archetypes
- Style Sheets
- Help
- Reference
- New in 1.7
- New in 1.7.1
- Troubleshooting
- Features
- Community Documentation
- 1.5 User Handbook Contents
- Document merging with Open Office Writer
- Searching
- Various Other Pages
- Adding New Users
- Business Continuity Plan Outline
- Create a New Appointment for a New Customer
- Creating And Using Macros
- Elements
- Glossary
- How to make it easier to see where the cursor is
- How to use a Report downloaded from the Community: Shared Resources Area
- Introduction to the web application
- Searching a patient by microchip number
- The Application Tree
- Backing Up and Restoring Your OpenVPMS data
- Discounts
- Dispensing And Injection Fees
- Reminders: Part 1 - Setup
- Setting Up Email To SMS using Generic SMS Gateway: One User's Experience
- The customer module
- User Guide
- Video tutorials
- Implementors Handbook
- Installation Documentation
- Tweaks and customisation
- [Installation] Configuration
- Automatic Document Importing into OpenVPMS
- Adding gzip compression to tomcat to improve speed.
- Auto-capitalisation
- Local test or demo system setup
- reminders
- Configuring Your New Installation
- Creating a Demo/Training Version of openVPMS on a Windows 7 Computer
- Setting Up A Scheduled Task in Windows 7
- Setting up electronic deliveries from Provet
- Timed logout
- Upgrade Documentation
- 1.5 Release Implementation Guide
- Anonymising a database
- Data Migration
- Developer's Handbook
Thanks to our sponsors: 
OpenVPMS is developed with the help of various tools including the Java profiler 