SDK Reference (Version 2)
Tax Type
Tax Type GET /v2/catalogue/getTaxTypes?includeInactive=true Returns a list of tax types. Parameter includeInact...
Booking Status
Booking Status GET v2/event/get/status?includeInactive=true Returns a list of booking status. Parameter include...
Booking Type
Booking Type GET v2/event/get/bookingType?includeInactive=true Returns a list of booking types. Parameter in...
Opportunity: Create or Update
Create or Update Opportunity POST /v2/opportunity/save This API creates an opportunity with a unique opportunity...
Opportunity: Get Quotes
Get Quotes POST /v2/opportunity/quote/get Returns a list of quotes for the specified Opportunity number in your re...
Opportunity: Search Opportunity By Number
Search Opportunity By Number POST /v2/opportunity/getByNumber This API returns the complete Opportunity details fo...
Opportunity: Get Quote Details
Get Quote details POST /v2/opportunity/quote/getDetails Returns the quote details for the specified Quote number in ...
Opportunity : Search Opportunity
Search Opportunity POST /v2/opportunity/get This API returns a list of opportunities that satisfy the search parame...
Opportunity: Save Quote
Save Quote POST /v2/opportunity/save/quote This API creates Quote in an opportunity and returns a unique Id and its...
Opportunity: Delete Catalogue Items
Delete Catalogue Items POST /v2/opportunity/quote/catl/delete This API deletes the catalogue items from opportunity....
Opportunity: Get Allowed Catalogue Items
Get Allowed Catalogue Items POST /v2/opportunity/get/allowedCatl This API returns the list of allowed catalogue item...
Opportunity: Save Beverage Catalogue
Save Beverage Catalogue POST /v2/opportunity/save/quote/beverage This API adds Beverage catalogue in an opportunity ...
Opportunity: Save Food Catalogue
Save Food Catalogue POST /v2/opportunity/save/quote/food This API adds Food catalogue in an opportunity quote and re...
Opportunity: Save Charge Catalogue
Save Charge Catalogue POST /v2/opportunity/save/quote/charge This API adds Charge catalogue in an opportunity qu...
Opportunity: Save VenueRate Catalogue
Save VenueRate Catalogue POST /v2/opportunity/save/quote/venueRate This API adds VenueRate catalogue in an oppor...
Opportunity: Save Inventory Catalogue
Save Inventory Catalogue POST /v2/opportunity/save/quote/inventory This API adds Inventory catalogue in an oppor...
Opportunity: Save Package Catalogue
Save Package Catalogue POST /v2/opportunity/save/quote/package This API adds Package catalogue in an opportunity qu...
Events: Save Package Catalogue
Save Package Catalogue POST /v2/event/save/catl/package This API creates a Package Catalogue in an event and returns...
Opportunity Status
Opportunity Status POST /v2/opportunity/get/status Parameter IncludeInactive Boolean true if you would like...
Venue: Get Catalogue By Id
Get Venue Catalogue By Id POST /v2/catalogue/getVenueById Parameter CatalogueId Long The Id of the catalogue...
File Upload : Contact/Event/Opportunity/Organisation
FileUpload POST /api/rest/v2/files/upload This API returns a file uploaded by user and it's details. Params:- al...
Event: Change Event Status
Change Event Status POST /v2/event/change/status Parameter Event Number Long The Number of an Event. Even...
Consolidated API: Create Opportunity
Create Opportunity POST /v2/thirdparty/opportunity/save This is consolidated API to create opportunity, save quotes ...
Venues: Get Venues List
GetVenuesList GetVenues POST /v2/common/catl/get Returns a list of venues matching the search parameters provided in...
Contacts: Search Contact By Id
Search Contact By Id POST /v2/contact/getById This API returns the complete contact details for specified Contact Id...
Event Venue Booking Prices: Venue Booking prices based on Smart Pricing
Find venue booking prices based on Smart Pricing POST v2/priceSchedule/getMatchingPSForVB This API returns the best...
Opportunity Venue Booking Prices: Venue Booking prices based on Smart Pricing
Find venue booking prices based on Smart Pricing POST v2/priceSchedule/opp/vb/getMatching This API returns the best...
Events: Create or Update
Create or Update POST /v2/event/save This API creates an event with a unique event number and its associated det...
Events: Add Contact to Event
Add Contact to Event POST /v2/event/save/contact This API will allow you to add an existing contact to an event....
Events: Remove Contact From Event
Remove Contact From Event POST /v2/event/delete/contact This API will remove the contact with the specified cont...