# API Documentation With iVvy's robust API, you can connect all your core business apps to meet your unique needs. Please note: use of the iVvy API is subject to additional fees. For pricing details, please contact . This documentation covers all of the iVvy products, including: * **iVvy Venue Software** - Software used by venues to market, manage and report on their venues. * **iVvy Events Software** - Software used by Event Organisers to manage the procurement, marketing, online registration, onsite event apps and surveys. * **iVvy Marketplace** - The online marketplace of events suppliers. * **iVvy Contacts CRM** - The contact database and CRM features accessible by the Events and Venues Software * **Partner Software** - The application that allows partners to create Booking Engines and distribute supplier inventory to their customers. Browse through the topics below to find exactly what you're looking for or check our [Getting Started Guide](https://developer.ivvy.com/getting-started) to get the ball rolling. {% content-ref url="/pages/-LH2Zq2wY3aS6NCmGyhw" %} [Getting Started](/getting-started) {% endcontent-ref %} {% content-ref url="/pages/-LI8d8wV4hH2bOgIvCGh" %} [Contacts & Companies](/contact) {% endcontent-ref %} {% content-ref url="/pages/-LH2ZtCZo5xyElQZ839I" %} [Event](/events) {% endcontent-ref %} {% content-ref url="/pages/-LI8d8wsI\_h2Nyxz5lH3" %} [Venue](/venues) {% endcontent-ref %} {% content-ref url="/pages/-LI8d8x823apoSYRdrRw" %} [Invoice](/invoice) {% endcontent-ref %} {% content-ref url="/pages/-LI8d8xCiapzIZQ40FCQ" %} [Account](/account) {% endcontent-ref %} {% content-ref url="/pages/-LfrVXNRw295J7o77jvl" %} [Partner](/partner) {% endcontent-ref %} # Getting Started The iVvy API allows apps to integrate directly with the iVvy product suite. Some typical use cases include: * Connecting a Customer Relationship Manager with iVvy * Connecting a Point of Sale System to iVvy Venues * Pushing Availability, Rates & Inventory into iVvy Venues through a Central Reservation System or Property Management System * Connecting an Accounting Package with iVvy Events or Venues The API described in this document follows an RPC (Remote Procedure Call) paradigm. Each RPC method is grouped into a few higher level namespaces to help organise this document in a more logical manner. iVvy takes security very seriously and the API described in this document has been designed to be as secure as possible. * All transport has been secured by utilising industry standard TLS * Key generation can be done first authenticating with the iVvy backend system * All requests must be signed using the key/secret pair to prove the request was made by a valid key * All requests have a time limit to avoid future replay attacks To help you get started we offer sdk libraries in [C#](https://github.com/ivvycode/ivvy-sdk-net), and [Javascript](https://github.com/ivvycode/ivvy-sdk-js). **Next Steps:** * Download an [example extension](https://github.com/ivvycode/example-extension) designed to work on the AWS infrastructure * Try making an [API call](https://developer.ivvy.com/getting-started/test) # Obtaining Keys For those who wish to develop a way to extract data from iVvy via programming means, whether to display on your website or for entering into a different system, you will need to generate an API Key. Please note: use of the iVvy API is subject to additional fees. For pricing details, please contact . # Creating the request Requests to the API are over the standard HTTP (HyperText Transfer Protocol). The protocol defines three parts to every request. 1. the method/uri header 2. a number of request headers 3. optional body of the request `Note also that the HTTP request also needs to be secured by a TLS/SSL connection, often referred to as HTTPS (or HTTP over SSL). iVvy uses industry standard TLS (Transport Layer Security, the successor to SSL, Secure Sockets Layer) to secure the HTTP transport to the API to ensure eavesdropping on the connection by third parties is protected.` # Method/URI Header This is a line consisting of the method of the request, followed by the request URI, followed by the HTTP version. i.e. `POST /api/1.0/event?action=getEventList HTTP/1.0` This example is for a request, to iVvy’s api ‘event’ namespace, calling the ‘getEventList’ API call, using HTTP version 1.0. Note the HTTP method for calls to the iVvy API are all POST requests. The api version being called is 1.0. Currently supported versions are: * 1.0 The URI in the request must always start with /api/{version} (where {version} is the specific api version, e.g. 1.0) followed by the namespace of the eventual api call to make. All requests must also provide the action parameter indicating the API call to invoke. # Request Headers Request headers are defined by the header name, followed by a colon (:) followed by a space, followed by the value of the header. A number of headers are used with the iVvy API. # Standard Headers ## HOST (Required) You will need to verify which region that you wish to integrate with to determine your host. If you are unsure, you can contact the support team for assistance. For integrations on our AU Servers, the host is: * [api.ap-southeast-2.ivvy.com](http://api.ap-southeast-2.ivvy.com/) For integrations on our US Servers, the host is: * [api.us-west-2.ivvy.com](http://api.us-west-2.ivvy.com/) For integrations on our UK Servers, the host is: * [api.eu-west-2.ivvy.com](http://api.eu-west-2.ivvy.com/) Contact if you are unsure which value to use. ## Date (Required unless using [IVVY-Date header](/getting-started/creating-the-request/request-headers/custom-headers#ivvy-date-optional)) The date header determines the date the request was made. The iVvy API uses this date, compared to the date of the server to determine if the request is within the time to live setting. (Currently requests over 5 minutes old are deemed invalid, this value may change in the future.) `Date: Thu, 12 Apr 2012 07:17:06 UTC` ## Content-MD5 (Required) This is the md5 sum of the body of the request. This header is used to verify the contents of the body of the request have not been altered during transport. Note that if there is no content in the body, the MD5 for the request must still be calculated. See [Calculating MD5](/development-reference/calculating-md5) for more details on how to calculate the value for this field. ## Content-Type The content type of the request body. Valid request types for the api are... * application/json ## Content-Length The length of the request body, in bytes. # Custom Headers A number of custom headers can be used with the request to the API. ## IVVY-Date (Optional) If your HTTP client does not allow the date header to be accessed or set, you can optionally use this header to use for the date string. Note if this header is used, the ‘date’ part of the [signed string](/getting-started/creating-the-request/signing-the-request) will need to be empty. The format of the value of this header will be the[ iVvy Timestamp Format](/development-reference/timestamp-format), NOT the string format of the standard Date header. ## X-Api-Authorization (Required) This is the same format at the standard HTTP Authorization header. For iVvy requests, the format is... `X-Api-Authorization: IWS key:signature` … where IWS is the authentication system used by iVvy, key is the key used to sign the request, and the signature is the HMAC-SHA1 signature of the request. See [Signing the request](/getting-started/creating-the-request/signing-the-request) for details on how to sign a request. The iVvy API server will lookup the secret key associated with the key used in this header, then use the details in the request in association with the secret key, then reconstruct the [HMAC-SHA1](/development-reference/hmac-sha1) hash. Only when the calculated hash, and the signature sent through this header match will the request be authenticated. # Signing the request Every request to the API must be signed with the accounts or users API key. Signing the request is obtained by the following pseudo-code: ```javascript method := POST contentMd5 := md5() contentType := the value of the Content-Type header contentSign := {contentMd5}{contentType} date := the date header of the request (i.e. Tue, 03 Apr, 2012 22:23:24 utc) NOTE: if using the IVVY-Date header, this field will be empty requestString := the entire request string used in the request apiVersion := the api version to use ivvyHeaders := Concatenated string of all headers starting with IVVY, removing all the Dashes (-) and underscore (_) characters in the header, in alphabetical order, joined together with the ampersand (&) character initialStringToSign := {method}{contentSign}{date}{requestString}{apiVersion}{ivvyHeaders} stringToSign := lowercase version of the initialStringToSign ``` For example, the following request... ```javascript POST /api/1.0/test?action=ping HTTP/1.0 Host: api.ap-southeast-2.ivvy.com Date: Tue, 03 Apr 2012 22:23:24 UTC Content-MD5: a09f600c77a6dbd947db24c61e8935ca Content-Type: application/json Content-Length: 18 X-Api-Version: 1.0 X-Api-Authorization: IWS {key:signature here} IVVY-Date: 2012-04-03 22:23:24 ``` ```javascript { "example":"body" } ``` … will require the following string to be signed … `posta09f600c77a6dbd947db24c61e8935caapplication/json/api/1.0/test?action=ping1.0ivvydate=2012-04-03 22:23:24` Note the entire string is set to lowercase before signing. Signing is achieved using the HMAC algorithm, using SHA1 encryption. See [HMAC-SHA1](/development-reference/hmac-sha1) for further details # Query Parameters The api exposes a RPC interface. As such there is a required query parameter, the ‘action’ parameter. This will identify the RPC call to invoke. # Test Ping ## Namespace Used for testing the access to the api. This call takes no parameters and responds to the request with an ack message, with the [timestamp](https://developer.ivvy.com/development-reference/timestamp-format) from the server. ### API URL ``` [PlatformAddress]/api/1.0/test?action=ping ``` # Interpreting the response The response will be given back will be the response in [JSON](/development-reference/json-encoding) format. # Collections Some results return collections of objects. E.g. event?action=getEventList. The resulting [JSON](/development-reference/json-encoding) response for these collections will be an object with the following properties. 1. meta: An object providing information about the result set. The following keys may exist * totalResults: The number of results in the complete collection * start: The starting index of the collection this result represents * perPage: The number of items per page of results * count: The number of objects included in this result. 2. results: An array of objects # Pagination Some requests (mostly the requests that return [collections](/getting-started/interpreting-the-response/collections)) may also accept some pagination options. * perPage: The number of items to return per page. Note that most requests have a cap on this number and providing a perPage option greater than that cap will not have any effect. * start: The record to start paging from. Note this number is zero based, i.e. to return results from the very first result, the start will need to equal 0 (which is the default). Note also this is not the page to start at. For example to get the second page from a list of results that have 20 results per page, the start property will need to equal 20 (i.e. starting at the 21st result) # Filtering Some requests (mostly requests that return [collections ](/getting-started/interpreting-the-response/collections)and/or take [pagination ](/getting-started/interpreting-the-response/pagination)requests) may also accept a filter argument. The structure of this filter will be an object with the key’s being what needs to be filtered, and the value will be the content of the filter. There are a number of options that may modify the filter behaviour. These are appended to the end of the key to filter. The accepted modifiers are: * **\_\_CONTAINS**: Return the results that contain the value. * **\_\_NOTCONTAINS**: Return the results that do not contain the value. * **\_\_BEGINS**: Return the results that start with the value. * **\_\_ENDS**: Return the results that end with the value. * **\_\_LESSTHAN**: Return the results that are less than or equal to the value. * **\_\_GREATERTHAN**: Return the results that are greater than or equal to the value. * **\_\_NOT**: Return the results that are not equal to the value. * **\_\_EMPTY**: Returns results that are empty If you want to search for ‘Null’ values, you can use the special value ‘**ISNULL**’ for the filter value. **Example: Filter all the results where the firstName = Bob** `{"filter":{"firstName":"Bob"}}` **Example: Filter all results where the firstName starts with ‘M’** `{"filter":{"firstName__BEGINS":"M"}}` **Example: Filter all results where the birthDay has not been set** `{"filter":{"firstName":"__ISNULL__"}}` # Exceptions If an error occurred the response will be a [JSON](/development-reference/json-encoding) representation of what went wrong. This will provide the error code, a brief message as well as a specific code. The specific code is a useful piece of information to be provided in any bug reports. Current exception codes and meanings are: | Code | Description | | ---- | --------------------- | | 400 | Bad Request | | 401 | Unauthorized | | 403 | Forbidden | | 404 | Not Found | | 405 | Method Not Allowed | | 406 | Not Acceptable | | 429 | Too Many Requests | | 460 | Unknown | | 461 | Failed Request | | 462 | Session Expired | | 463 | Key Revoked | | 500 | Internal Server Error | | 501 | Not Implemented | Some exceptions will have an additional piece of information associated with the exception, which will contain more specific message about the exception. **Exception: Specific Code 23005** The required Date or iVvyDate parameter does not fall within 5 minutes of UTC time, invalidating the request. Refer [here ](/getting-started/creating-the-request/request-headers/standard-headers#date-required-unless-using-ivvy-date-header)for more information on this. **Example: Date outside of accepted time range** ```javascript Request (venue?action=getVenueList) { "ivvydate":"2000-06-01 00:00:00" } { "errorCode": 401, "message": "Request is stale", "specificCode": 23005 } ``` **Exception: Specific Code 23016** A parameter provided in the request did not validate correctly. For example, the API might have been expecting a number, but a string was provided instead. This exception gets thrown when the first invalid parameter is found. The additional messages will contain the messages from the validator as to why the value was not validated. **Example: Key does not validate error** ```javascript Request (contact?action=getContact): { "id":"wrong" } Response: { "errorCode":400, "message":"'id' does not validate", "specificCode":23016, "additionalMessages":["Value must be a whole number"] } ``` **Exception: Specific Code 23017** A required parameter was missing from the request. Example: Key is required error ```javascript Request (contact?action=getContact): {} Response: { "errorCode":400, "message":"'id' is required", "specificCode":23017 } ``` # Response Headers ## Content-Type This header will identify the content type of the response. At this time only one content type is supported, the application/json type. # Dates Responses from the iVvy API may contain dates. In all cases (unless otherwise stated in documentation for the specific action) the dates are in Universal Coordinated Time (UTC). Care must be taken when using or displaying these dates to ensure they: a) maintain their UTC time zone for communication with the API, and; b) represented in the appropriate time zone for users utilizing the date. Dates may be represented as a string which must be parsed appropriately if it is to be used. Where possible any dates will be converted to the[ iVvy Timestamp Format](/development-reference/timestamp-format), which is a simple to understand text format to represent a specific point in time to the second. # Batch As a way of providing asynchronous access to iVvy’s API, there is a namespace added for batch requests. This also provides a way to run multiple api calls in a batch and provide the result of all the api calls via a URL callback. ## Namespace `batch` # Run ## Run `POST` `[PlatformAddress]/api/1.0/batch?action=run` #### Path Parameters | Name | Type | Description | | ----------- | ------ | ---------------------------------------------------------------------------------------------------- | | jobs | string | Array of api jobs to be run on the api. Each job needs to have keys | | callbackUrl | string | The URL to hit with a POST request after the batch has been run, with a JSON object of the responses | {% tabs %} {% tab title="200 " %} ``` { "asyncId":"e35e06ee592d17a42dc9e6252a058617" } ``` {% endtab %} {% endtabs %} ## Example Request ```javascript { "jobs": [ {"namespace":"event","action":"inviteContacts","params":{"event":1,"contacts":[1,2,3]}}, {"namespace":"event","action":"inviteContacts","params":{"event":2,"contacts":[1,2,4]}}, ], "callbackUrl":"http://example.callback.url.com" } ``` ## Keys | namespace | | --------- | | action | | params | ## Returns | Property | Description | | -------- | -------------------------------- | | asyncId | Identifier for the batch request | ## Throws | Code | Description | | -------------------- | ---------------------------------------------------------------- | | Specific Code: 24092 | Incorrect Job Format | | Specific Code: 24093 | Empty job parameter found | | Specific Code: 24091 | The information was not saved | | Specific Code: 24448 | The maximum number of jobs can be put on a single request is 200 | The run action takes an array of api calls and returns an identifier that can be used to identify the batch. Keep this identifier as it can be used to identify the response of the batch request, as well as being used to fetch the progress and results of the request. To run a batch job, an JSON object must be provided with the following keys: * jobs: An array of jobs, each element being an object with the following keys * namespace: The namespace of the api call * action: The api call to make * params: Any parameters required for the api call * callbackUrl: A URL that will be called after the batch has completed. * The request will be a POST request * The response will be a JSON object with the following keys * asyncId: The async identifier provided when the batch was created * results: An array of objects for each result of the batch, with the following keys * namespace: The namespace of the call for the response * action: The action of of the call for the response * request: The original request parameters used * response: The response of the api call # Progress ## Progress `POST` `[PlatformAddress]/api/1.0/batch?action=progress` #### Path Parameters | Name | Type | Description | | ----- | ------ | --------------------------------------------------- | | async | string | The asyncId for the batch job to check progress for | {% tabs %} {% tab title="200 " %} ``` { "progress":33 } ``` {% endtab %} {% endtabs %} ## Example Request Fetch the progress of a batch job ```javascript { "async":"a7ec88af7d710bf51b188004bb532d77" } ``` ## Returns | Property | Description | | -------- | ----------------------------------------------------------------- | | progress | The progress of the batch job, as a percentage of work completed. | ## Throws | Code | Description | | -------------------- | -------------------- | | Specific Code: 24105 | Could not find batch | The progress action takes the asyncId as a parameter and returns back the progress of the batch job as a percentage. # Result ## Results `POST` `[PlatformAddress]/api/1.0/batch?action=results` The results action takes the asyncId as a parameter and fetch the results of a batch request after it has been executed. #### Path Parameters | Name | Type | Description | | ----- | ------ | ----------- | | async | string | | {% tabs %} {% tab title="200 " %} ``` { "asyncId": "e35e06ee592d17a42dc9e6252a058617", "results": [ { "namespace": "event", "action": "inviteContacts", "request": { "event": 1, "contacts": [1, 2, 3] }, "response": { // Response data for the first job } }, { "namespace": "event", "action": "inviteContacts", "request": { "event": 2, "contacts": [1, 2, 4] }, "response": { // Response data for the second job } }, // Additional results for other jobs in the batch ] } ``` {% endtab %} {% endtabs %} ## Example Request ```javascript { "async":"a7ec88af7d710bf51b188004bb532d77" } ``` ## Returns The response will be a JSON object with the following keys: * asyncId: The async identifier provided when the batch was created. * results: An array of objects for each result of the batch, with the following keys: * namespace: The namespace of the call for the response. * action: The action of the call for the response. * request: The original request parameters used. * response: The response of the API call. ## Throws | Code | Description | | -------------------- | ----------------------- | | Specific Code: 24114 | Batch job not completed | | Specific Code: 24115 | Could not find batch | This structure facilitates retrieving the results of each individual job within the batch request, along with the corresponding request parameters and response data, or it indicates that the batch job is not yet completed. Please note that the data will not be available after 2 days. # Restart ## Restart `POST` `[PlatformAddress]/api/1.0/batch?action=restart` The restart action takes the asyncId as a parameter and returns the success of the call. Note a success of true does not mean the job will restart immediately #### Path Parameters | Name | Type | Description | | ---- | ------ | ----------- | | | string | | {% tabs %} {% tab title="200 " %} ``` { "restarted":true } ``` {% endtab %} {% endtabs %} ## Example Request ```javascript { "async":"a7ec88af7d710bf51b188004bb532d77" } ``` # Repost ## Repost `POST` `[PlatformAddress]/api/1.0/batch?action=repost` #### Path Parameters | Name | Type | Description | | ----- | ------ | ----------- | | async | string | | {% tabs %} {% tab title="200 " %} ``` { "reposted":true } ``` {% endtab %} {% endtabs %} The repost action takes the asyncId as a parameter and returns the success of the call. {% hint style="info" %} Note a success of true does not mean the callback will be hit immediately. {% endhint %} ## Example Request `Example: Restart a batch job` ```javascript { "async":"a7ec88af7d710bf51b188004bb532d77" } ``` # Use Cases This section gives some common use cases with links to relevant sections in the API. # CRM Systems ## CRM Integrations CRM Integrations typically have different modules completed in them for transfer. * [Contacts](#contacts) * [Contact Emails](#contact-emails) * \`\`[Events Software Users](#event-software-users) * [Event Registrations](#event-registrations) * [Events](#events) * [Event Attendees](#event-attendees) * [Venues Software Users](#venue-software-users) * [Companies](#companies) * [Quotes & Bookings](#quotes-and-bookings) ## Contacts Contacts are preferred to be transferred two ways between iVvy and the CRM system so that both systems are always kept up to date. It is important to remember that iVvy uses three fields to uniquely identify a contact: first name, last name and email. Other systems may not use the same identifiers, so it is recommended that a constant identifier is used (such as a contact ID) to make a permanent pairing of the contacts. iVvy does have a field to store a externalId that our integrations typically use to store the contact ID from the other system. Typical endpoints used when doing a 2 way contact sync. * [Get Contact List](/contact/get-contact-list): Using this call with a filter of modifiedDate can give you the list of contacts that were modified in iVvy since the last sync. This minimises the amount of time that is spent comparing the contacts between the two systems. You may or may not also use the get Contact action which returns a single contact. * [Add or Update Contact](/contact/add-or-update-contact) for when the contacts are being synced back into iVvy. * [Get subscription group](/contact/get-subscription-group-list) list and [add Contacts to subscription group](/contact/add-contacts-to-subscription-group) if the integration will be supporting syncing of subscription groups. Remember to provide a method to map custom fields between the two systems if they are also being synced in the integration. ## Contact Emails As an email is usually stored against a singular action in iVvy, they cannot be received into iVvy from a third party. So contact emails are a one way sync out of iVvy and into the CRM so that the CRM has a comprehensive history of all correspondence sent to the contact. Typical endpoints used when doing an email sync from iVvy to a CRM: * [Get Email Log List](/account/get-email-log-list) returns a collection of the emails that have been sent. The content in the body in returned HTML format so it is wise to consider this when syncing the emails into a third party system. ## Event Software Users If completing a integration for Events users, these are some optional modules that have been popular demand. ### Event Registrations Event registrations are usually synced into the CRM as opportunities. This is normally optional so that the user can use the CRM portion and not be forced into this feature if they do not wish to use it. This is associated with the revenue of event registrations being displayed in the CRM system so that more accurate forecasting is completed. It also attaches to the contacts/companies history so that the CRM user can see an accurate historic relationship with the contact/company. This is a one way sync out of iVvy and into the CRM system. Typical Endpoints used when doing an Event Registration syncs into Opportunities in a CRM. * [Get Registration List](/events/get-registration-list) can be used to fetch the latest created and modified event registrations from the iVvy system. Important point to remember is that returned event registrations include both delegate and exhibitor registrations. The data may be filtered depending on which is being targeted. Typical iVvy integrations include both. For a list of registration status they can be found under [Registration Current Status Details](/events/get-registration-list#registration-current-status-details). Usually only paid “completed” status registrations would be synced, because until payment is received they are not guaranteed as income. ### Events Events are synced one way out of iVvy and into CRM campaigns. This is normally optional so that the user can use the CRM portion and not be forced into this feature if they do not wish to use it. This gives the CRM user access to a comprehensive history of what events took place for their clients, and which of the contacts (refer campaign members) actually attended their events. This gives a more comprehensive report of the history and relationship with the customer in the CRM. Typical Endpoints used when syncing events into a CRM. * [Get Event List](/events/get-event-list) returns a list of events in the iVvy account. These can then be synced into the corresponding CRM system. ### Event Attendees Attendees in an iVvy event are synced against the campaign in the CRM as an attendee member. This is included in the optional “Events (campaigns)” module. Part of this sync includes keeping the invitation and attendance status periodically up to date. Typical Endpoints used when syncing event members into a CRM. * [Get Invited Contact List](/events/get-invited-contact-list) gives a list of contacts invited to the event. This action will return a response on if they clicked yes, no or haven’t responded yet, however it also updates a registration ID field when the contact progresses onto a registration. * [Get Attendee List](/events/get-attendee-list) will give a list of contacts that have registered for the event. Event Registration Progress: Initially a contact would start as an invitation with the following invitation status: * U = Undecided * Y = Yes * N = No If the attendee has clicked yes than they will be now found in the attendee list as they have completed their registration. Once on the attendee list (meaning they will attend) the “hasAttended” and “sessionHasAttended” flags will verify if the user registered but did or did not attend. One point to remember is that if the event is not invite only, attendees can still register that haven’t been invited so there may be records in the attendee list that are not in the invited contact list that need to be considered. ## Venue Software Users If completing a integration for Venues users, these are some optional modules that have been popular demand. ### Companies The venues software has a component to store companies against contacts (whereas events does not) so a two way company sync (or as some CRMs refer to them as accounts) to keep the two systems up to date. The same as contacts, a company has an externalID field in iVvy that can be used as the constant to map the company together so if there is a name change, then the two companies are still connected and can be kept up to date. Typical Endpoints used when doing a Company sync * [Get Company List](/contact/get-company-list) and [Get Company](/contact/get-company) if completing company syncs. * [Add or Update Company](/contact/add-or-update-company), if sending data back from the third party CRM. ### Quotes and Bookings Venues may wish for their quotes and bookings to appear in their CRM against the contact / company as an Opportunity. This is usually “optional” so that if the venue wishes to use the CRM, they aren’t forced to use the bookings / quotes module if they do not wish to. iVvy does not allow for quotes/bookings to be pushed back into the system, and the data in an opportunity does not usually meet the minimum requirements of a quote or booking in the iVvy system so it’s completed as a one way sync out of iVvy and into the CRM System. Typical Endpoints used when doing a Quotes / Bookings Sync * [getBookingListForAccount](/venues/getoraddbookingdata/get-booking-list-for-account) (this returns bookings for all venues) [getBookingList](/venues/getoraddbookingdata/get-booking-list) (returns all bookings for a single venue) or [getBooking](/venues/getoraddbookingdata/get-booking) (returns a single booking) can be used to source a list of quotes and bookings out of a venue. To differentiate between a quote and a booking the current status will identify if its Prospective (quote) or Tentative / Confirmed (Booking). To get the latest bookings that have been created or modified, the result can be filtered by a modifiedDateAfter parameter. # Financial Accounting Systems Financial integrations compose of copying the financial history out of iVvy and into a users financial system for reconciliation and reporting. As there is a vast difference between the way the venues and events invoicing systems work, historically they have been completed separately. Typically iVvy only sync paid invoices on Event Integrations, as events invoices can constantly change up until the point they are paid. However venues invoices do not commonly change, so the process of syncing them and paying them later is followed in the Venues integration. When creating a financial integration there are a lot of different steps and scenarios to consider. 1. **Contact or Company:** Each invoice will need to have a contact and/or company assigned 2. **Currency:** What currency is the invoice in, and how does it need to be added into the financial system. 3. **Tax:** Tax tax rate is the invoice and its line items using, and how is this translated into the financial system. 4. **Item Ledger Accounts:** Line items in a financial system will typically have a revenue account assigned. Logic around achieving this will need to be decided. 5. **Bank accounts:** When transferring payments into a financial system, the bank account that the funds are sitting in needs to be allocated. 6. **Historical Data:** If you want to do historical data or just data from when the installation occurs. 7. **Transferring payments both ways:** This is a common scenario if a user \* Has a payment gateway in iVvy \* Is adding payments through the financial system to the invoices, such as a bank feed directly into their finance program. 8. **Existing Contacts:** Financial systems may already have a debtor list. A good algorithm to match up contacts in iVvy and the Financial System when syncing invoices and creating a constant between the two such as a contact ID is highly recommended to avoid duplicates. No two users are the same so iVvy integrations normally offer these as options for the user to set during installation rather than hard wiring them. This allows more flexibility for the end user. ## Common API Actions that would be used in a financial Integration 1. **Fetch the Invoices** Invoices can be fetched from iVvy via the [getInvoice](/invoice/get-invoice) and [getInvoiceList](/invoice/get-invoice-list) API actions. From these actions currency, tax, items and payment information can be accessed. If completing a separate events or venue integration [filtering by refType](/invoice/get-invoice-list#reference-type) is recommended to get the correct invoices that need to be sourced.\ One important thing to note for invoices is they may not always have a company ID or contact ID. Invoices in iVvy can be assigned to an “Other”. So this makes working with a contact database tricky in this situation. Typically if there is no contact or company for the invoice the default contact/company is sourced from the Booking or the Event that the invoice is associated with to create the corresponding contact in the Financial System. 2. **Fetching a contact or company for each invoice** A contact or company can be fetched from the iVvy system using the [Get Contact](/contact/get-contact) / [Get Contact List](/contact/get-contact-list) or [Get Company](/contact/get-company) / [Get Company List](/contact/get-company-list) actions. The list actions return different data to the individual actions so make sure you are calling the correct action that returns the information you are looking for. Both may be used in some cases. 3. **Mapping an Invoice Status** It is recommended to look at the invoice status in iVvy and the financial system and map them accordingly deciding on what behavior happens as the status changes in iVvy. The list of [iVvy invoice status](/invoice/get-invoice-list#current-status) can be found here. 4. **Assigning line items to an account in the Financial System** Each line item in iVvy has a refType. These are iVvy constants that could be used to map to a revenue account in the financial system. These can be accessed by the [getOptions](/invoice/get-options) action. 5. **Adding a payment back to iVvy on a two way sync** If both systems are taking payments it makes sense to transfer payments back to iVvy that were taking in the financial system. This can be done by the [Add Payment](/invoice/add-payment) endpoint. The invoice has to be existing in iVvy already (a new one cannot be created), and invoices cannot be overpaid via the API. ## Venues Invoices Please note this is a general overview which changes for different financial systems depending on how the system works with credit notes and refunds. ![](/files/AGAtE8vDbwewBwHLvXqK) ## Events Invoices Please note this is a general overview which changes for different financial systems depending on how the system works with credit notes and refunds. The iVvy events API does not pass credit note information so if a user needs to create a refund/credit this is done manually in the financial system. ![](/files/aLzXa2flVnH8zDgIwGd1) # Point Of Sale The most common approach to working with a POS integration with iVvy is for confirmed bookings to be pulled into the POS system using the [`Get Booking List`](/venues/getoraddbookingdata/get-booking-list) action so that they are visible on the POS on the day of the event.. The getBooking action will include the total amount of the booking, and outstanding amounts for the event. This allows additional flexibility at the POS level to take any remaining balances for the event and pass back the details to the iVvy booking. Once the event has taken place, (usually at the time of closing the event) food and beverage items entered through the POS system will be pushed back into iVvy as “Additional Items” using the [`Add Items To Booking`](/venues/getoraddbookingdata/add-items-to-booking) action. When adding additional items back into iVvy from the POS system, a Cost centre needs to be assigned. To determine a list of cost centres in the iVvy venue account, the [`Get Cost Centre List`](/account/get-cost-center-list) action can be used to access and map the cost centres with the POS system. Then any payments taken are sent into iVvy using the [`Add Payment to Booking`](/venues/getoraddbookingdata/add-payment-to-booking) action. This action will generate a transaction invoice for the amount of the payment and store the payment information against it. This will reduce the outstanding amount of the iVvy booking, giving the user visibility on total amounts outstanding, if any. The user will then produce the final invoice in iVvy which will contain the summary of billable items from both systems as they were passed into the booking at the time of closing the event in the POS system. Any remaining amounts (if applicable) will be paid against the final invoice. ![](/files/JmBFg5hMfxAt9JuqPqPH) # Property Management Systems PMS Integrations are designed to allow the user to keep accommodation up to date between iVvy and their PMS System. They provide live availability and rates from the PMS to iVvy so that accommodation can be booked real time with the correct pricing. ## Group Accommodation Blocks Group accommodation blocks will be synced from iVvy to the PMS system. The iVvy system will trigger an event when accommodation bookings are created, and release schedules are due. Changes made by the user in iVvy will trigger an update event which will result in an update in the PMS. ![](/files/9DPErM6Ra6HBwUA3jS8a) ## Room Reservations Rooming lists take accommodation blocks one step further by allocating single reservations within the accommodation block to indicate the occupant of the room. These reservations will be synced to the PMS so the user has occupant information. Any changes to the reservations will trigger an event that will update the rooming list in the PMS. ![](/files/B8n48AaEVX342ni7bRf0) ## ARI (Availability, Rates and Inventory) Availability, rates and inventory will be sourced from the PMS to appear in iVvy as real time data from the PMS. This includes in iVvy displaying up to * rate plans, * dynamic inventory and * room data. The accommodation Namespace on the iVvy API allows users to; * [Add or Update Room Counts](/venues/accommodation/add-or-update-room-counts), * [Add or Update Room Dynamic Rates](/venues/accommodation/add-or-update-room-dynamic-rates), * [Remove Room Dynamics Rates](/venues/accommodation/remove-room-dynamic-rates), and * [Add or Update Rate Plan Booking Rules](/getting-started/use-cases/property-management-systems) # Contacts & Companies Contacts and Companies are objects used by both the iVvy Events and iVvy Venues Software. The [Contact ](/contact/get-contact-list)object includes some standard data including email address, first name, last name, mobile phone number and created date. in addition to this, additional Custom Fields can be defined within an account. Contacts can belong to [Companies](/contact/get-company-list), and Companies have a range of standard data recorded against them. # Get Contact List ## Get Contact List `POST` `[PlatformAddress]/api/1.0/contact?action=getContactList` Get Contact List will respond with a list of contacts based on the filter parameters #### Path Parameters | Name | Type | Description | | ------- | ------- | ------------------------------------------------------------------------------------------------------------------- | | perPage | integer | The number of events to get in a single api call | | start | integer | The starting result of the page. Note this is zero based (i.e. sending start = 0 will start from the first result.) | {% tabs %} {% tab title="200 " %} ``` ``` {% endtab %} {% endtabs %} ## Additional [Filter](/getting-started/interpreting-the-response/filtering) Properties | Property | Description | Type | | ---------------- | ------------------------------ | ---------------------------------------------------------------- | | fromModifiedDate | Filter by Modified Date | [iVvy Timestamp Format](/development-reference/timestamp-format) | | toModifiedDate | Filter by Modified Date | [iVvy Timestamp Format](/development-reference/timestamp-format) | | externalId | Filter by external unique id | Unique external Id in string | | venueId | Filter by specific Venue | integer | | venueGroupId | Filter by specific Venue Group | integer | | companyId | Filter by specific Company Id | integer | ## Returns | Property | Description | | ------------------ | ---------------------------------------------------------------------------------------------------------------- | | id | The unique identifier for the contact | | firstName | The contact’s first name | | lastName | The contact’s last name | | email | The contact’s email address | | phone | The contact’s phone number | | privacyConsentData | The object of [Privacy Consent](/contact/get-contact#privacy-consent-data) field objects of the contact. | | customFields | The custom field information for the contact. This is an array of fields, each an object with the [keys](#keys). | | groups | The subscription group information for the contact. | | companies | This will an array company ids to which the contact belongs. | | companiesData | This will an array company containing id and businessName for each company to which the contact belongs. | | externalId | This will be external id of the contact | | modifiedDate | The modified date of the contact | | isAnonymised | Whether or not contact data is annonymised | ## keys | fieldId | | ----------- | | displayName | | value | The result from this call will be a [collection](/getting-started/interpreting-the-response/collections) of all the events the user has access to. This call also accepts the [pagination](/getting-started/interpreting-the-response/pagination) and [filter](/getting-started/interpreting-the-response/filtering) properties. # Get Contact ## Get Contact `POST` `[PlatformAddress]/api/1.0/contact?action=getContact` Get the contact details #### Path Parameters | Name | Type | Description | | ----------------- | ------- | ------------------------------------------------------------------------------------------------- | | id | integer | The contact's identifier | | useEventSortOrder | boolean | If true, the eventInvitations and eventRegistrations will be returned ordered by Event Start Date | {% tabs %} {% tab title="200 " %} ```javascript { "id": 7427530, "firstName": "Test", "lastName": "User", "email": "user@test.com", "phone": "0455550000", "status": 1, "smsStatus": 1, "customFields": [], "groups": [ { "contactId": 7427530, "groupId": 57138, "joinDate": "2018-09-07 02:11:47" } ], "companies": [4, 5, 6], "companiesData":[ {"id":4,"businessName":"Company Name 1"}, {"id":5,"businessName":"Company Name 3 (Department)"}, {"id":6,"businessName":"Company Name 2"}, ], "externalId": null, "modifiedDate": "2018-09-07 02:11:47 UTC", "isAnonymised": false, "eventInvitations": [], "eventRegistrations": [] } ``` {% endtab %} {% endtabs %} ### Example Request This example request will obtain the details of the contact with the id "6" ```javascript { "id":6 } ``` ## Returns | | | | | ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | | **Property** | **Description** | **Type** | | id | The unique identifier for the contact | integer | | firstName | The contact’s first name | string | | lastName | The contact’s last name | string | | email | The contact’s email address | string | | phone | The contact’s phone number | integer | | status | The contact's [email status](#email-status) | enum | | smsStatus | The contact’s [sms status](#sms-status) | enum | | customFields | The custom field information for the contact. This is an array of fields, each an object with the [keys](#custom-fields-keys). | array | | groups | The subscription group information for the contact. | array | | companies | This will an array company ids to which the contact belongs. | array | | companiesData | This will an array company containing id and businessName for each company to which the contact belongs. | array | | externalId | This will be an external id of the contact | integer | | modifiedDate | The modified date of the contact | date | | isAnonymised | Whether or not contact data is annonymised | boolean | | eventInvitations | An array of events the contact has been invited to. Each element of the array is an object with [the event invitations fields](#event-invitations) | array | | eventRegistrations | An array of events the contact has registered for. Each element of the array is an object with [the event registration fields](#event-registrations-details). | array | | externalUrls | This is an array of [ExternalUrl](#external-url-field) field objects of the contact. | array | | privacyConsentData | The object of [Privacy Consent](#privacy-consent-data) field objects of the contact. | object | ### Status Options - Email Registration Status The status is the record of whether the contact has opted in to email communication. | | | | ----- | --------------- | | **#** | **Description** | | 1 | Subscribed | | 2 | Unsubscribed | | 3 | Bounced | | 4 | Registering | | 5 | No Marketing | ### Sms status The sms status is the record of whether the contact has opted in to sms communication. | | | | ----- | --------------- | | **#** | **Description** | | 1 | Subscribed | | 2 | Unsubscribed | | 3 | Failed | | 4 | No Marketing | ### Custom Fields Keys | | | ----------- | | **Keys** | | fieldId | | displayName | | value | ### Event Invitations | | | | ------------------ | ------------------------------------------------------------------------------------- | | **Property** | **Description** | | eventId | The event identifier of the invitation | | eventCode | The code of the event of the invitation | | eventStartDateTime | The timestamp the event is starting | | inviteLinkYes | Invitation link for the Yes response for this contact to the event | | inviteLinkNo | Invitation link for No response for this contact to the event | | response | The contacts response to the invitation. [List of response values](#response-values). | #### Event Invitations Response values | | | | ----- | --------------- | | **#** | **Description** | | U | Undecided | | Y | Yes | | N | No | ### Event Registrations Details | | | | ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | | **Property** | **Description** | | eventId | The event identifier of the registration | | eventCode | The code of the event of the registration | | eventStartDateTime | The timestamp the event is starting | | registrationId | The unique identifier of the registration | | currentStatus | [The status of the registration](#registration-status) | | confirmedDate | Timestamp of the date the registration was confirmed | | isPaymentWaiting | If the registration is payment waiting or not | | printTicketUrl | The URL the registrations tickets | | printTicketUrlPdf | Link to the PDF for the registrations tickets | | attendeeCount | Total number of attendees for this registration | | invoiceUrl | The URL for the registration primary invoice | | invoiceUrlPdf | Link to the PDF for the registration primary invoice | | guestDetails | An array of objects with [the guest details.](#guest-details) | | invoices | The list of invoices associated with the registration. Each element of the array is an object with [the invoice fields.](#invoice-details) | #### Event Registration Status (currentStatus) | | | | ----- | ---------------- | | **#** | **Description** | | 2 | Completed | | 3 | Cancelled | | 4 | Payment Required | #### Guest Details | | | | ---------------- | --------------------------------------- | | **Property** | **Description** | | contactId | The identifier for the contact if known | | fullName | Name of guest | | email | Email address of guest | | attended | If the contact has attended the event | | attendedDateTime | When the contact attended the event | ### Invoice Details | | | | ------------- | ---------------------------------------------------------------------------------------------------------------------------------- | | **Property** | **Description** | | id | The unique identifier for the invoice | | reference | The reference number of the invoice | | title | The title of the invoice | | currentStatus | The current status of the invoice. The value of this field will be [one of the following current status](#invoice-current-status). | | description | The description of the invoice | | currency | The currency of the values of this invoice | | totalCost | The total amount of the invoice | | totalPaid | How much has been paid off the invoice | | invoiceUrl | The URL for the invoice | | invoiceUrlPdf | The URL for the invoice pdf | #### Invoice current status | | | | ----- | ---------------- | | **#** | **Description** | | 0 | Not Paid | | 1 | Unconfirmed Paid | | 2 | Written Off | | 3 | Failed | | 4 | Cancelled | | 5 | Refunded | The result from this call will be a [collection](/getting-started/interpreting-the-response/collections) of all the events the user has access to. This call also accepts the [pagination](/getting-started/interpreting-the-response/pagination) and [filter](/getting-started/interpreting-the-response/filtering) properties. ## External URL Field An External URL field is an object with the following details. | Property | Type | Description | | -------- | ------ | ----------------------------------------------------- | | ref | string | The unique reference key of the external URL | | url | string | The url link (https) scheme eg. | | label | string | The label of the URL to display. | ## Privacy Consent Data | Property | Description | | -------- | ---------------------------------------------------- | | source | The [source](#privacy-consent-source) of the consent | | dateTime | The date time when the consent given | ## Privacy Consent Source | Source | Description | | ------ | ---------------------- | | 1 | User Initiated Entry | | 2 | Marketplace | | 3 | Website Booking Engine | | 4 | Event Website | | 5 | API | ## Throws | | | | -------------------- | ---------------------- | | **Code** | **Description** | | Specific Code: 24096 | Unable to find contact | The contact identifier must be provided to fetch a specific contact from the system. # Get Contact Note List ## Get Contact Note List `POST` `[PlatformAddress]/api/1.0/contact?action=getContactNoteList` Fetches a list of notes for a specific contact. #### Path Parameters | Name | Type | Description | | --------- | ------- | ----------------------------------------------------------------------------------------------------------------- | | contactId | integer | The unique identifier of the contact to which the contact notes belong | | perPage | integer | The number of contact notes to fetch | | start | integer | The starting result of the page. Note this is zero based (i.e. sending start=0 will start from the first result.) | {% tabs %} {% tab title="200 " %} ``` { "meta": { "totalResults": 10, "start": 0, "perPage": 50, "count": 3 }, "results": [ { "id": 2, "contactId": 4, "noteText": "

Contact Note 1

\n", "createdByUserId": 1, "createdDate": "2022-06-12 06:06:03 UTC", "modifiedDate": "2022-07-13 01:32:10" }, { "id": 4, "contactId": 4, "noteText": "

Contact Note 2

\n", "createdByUserId": 1, "createdDate": "2022-07-13 01:27:27 UTC", "modifiedDate": "2022-07-13 01:27:27" }, { "id": 5, "contactId": 4, "noteText": "

Contact Note 3

\n", "createdByUserId": 1, "createdDate": "2022-07-13 01:29:41 UTC", "modifiedDate": "2022-07-13 01:29:41" }, ] } ``` {% endtab %} {% endtabs %} The result from this call will be a [collection](/getting-started/interpreting-the-response/collections) of contact note to which the user has access. This call also accepts the [pagination](/getting-started/interpreting-the-response/pagination) and [filter](/getting-started/interpreting-the-response/filtering) properties. ## Example Request `Fetches a list of Notes for a specific Contact` ```javascript { "contactId" : 4, "perPage" : 50 } ``` ## Contact Note | Property | Type | Description | | --------------- | --------- | ------------------------------------------------------- | | id | integer | The unique id of the contact note | | contactId | integer | The id of the contact to which the contact note belongs | | noteText | string | The contact note | | createdByUserId | integer | The details of person who created the contact note | | createdDate | timestamp | The date & time the contact note was created | | modifiedDate | timestamp | The date & time the contact note was last modified | # Add or Update Contact ## Add or Update Contact `POST` `[PlatformAddress]/api/1.0/contact?action=addOrUpdateContact` Add or update contact details #### Request Body | Name | Type | Description | | -------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | externalId | string | Reference to the ID of the contact in an external system. | | id | integer | The contact's identifier. (Leave empty to add new contact) | | firstName | string | The contact's first name (required when id is missing) | | LastName | string | The contact's last name (required when id is missing) | | email | string | The contact's email address. Must be a valid email. (required when id is missing) | | phone | string | The contacts phone number. | | groups | string | The array of subscription groups to set for the contact. Note: This list will override any groups currently set for the contact. | | customFields | string | The array of custom fields to set on the contact. Each field will be validated depending on the type of field that is set. | | companies | string | The array of companies to set on the contact. Each value will be validated depending on the type of field as well as it will verify that the given company exists or not. | | status | enum | The contact's email subscription status. | | smsStatus | enum | The contact's sms subscription status. | | updateIfExists | boolean | Whether or not to update the contact by firstName, lastName and email when id parameter is missing. | | externalUrls | array | This is an array of External URL field objects of the contact (a maximum of 3 objects allowed). When set to null, it will remove all externalUrls from the contact. | {% tabs %} {% tab title="200 " %} ``` { "id":33884 } ``` {% endtab %} {% endtabs %} ## Example Request: Adding a contact ```javascript { "firstName": "Bobby", "lastName": "Smith", "email": "bobbysmith@hotmail.com", "groups": [ { "groupId": 10 } ], "customFields": [ { "fieldId": 33443, "value": "No" } ], "companies": [ 4, 5 ], "status": 2, "smsStatus": 2, "externalId" : "12345", "externalUrls" : [ { "ref": "example1", "label": "Example One", "url": "https://example1.com" }, { "ref": "example2", "label": "Example Two", "url": "https://example2.com" }, { "ref": "example3", "label": "Example Three", "url": "https://example3.com" } ], "privacyConsent": true } ``` ## Example Request: Updating a contact `Note : the groups will be set to only group 10, destroying the existing value` ```javascript { "id":33884, "firstName":"Bobby", "groups":[{"groupId":10}], "customFields":[{"fieldId":33443,"value":"No"}], "companies":[4,5], "status": 2, "smsStatus": 2, } ``` This call takes values for a contact, and either 1. Updates the values for that contact (after you have provided an id in the parameters), or 2. Adds the contact to the system (if the id parameter is missing) The result of this call will contain the status of the result (either true or false) and the contact identifier of the updated or newly created contact. The properties of the contact currently supported are: * firstName * lastName * email * phone * groups * This is an array of group objects with the ‘groupId’ key. * customFields * This is an array of custom field objects with ‘fieldId’ and ‘value’ keys * Companies * This is an array of companies Ids * status * The current status of the email susbcription in contact. The value of this field will be [one of the following current status](#email-status) * smsStatus * The current status of the sms susbcription in contact. The value of this field will be [one of the following current status](#sms-status) * externalUrls * This is an array of External URL field objects of the contact (a maximum of 3 objects allowed). When set to null, it will remove all externalUrls from the contact. [ExternalUrl field](#external-url-field) * privacyConsent * Whether or not giving privacy consent for this contact. ## Returns | Property | Description | | -------- | ------------------------------------------------ | | success | If the contact was successfully added or updated | | id | The unique identifier for the contact | | message | Message of the failure (if success was false) | ### Email Status The status is the record of whether the contact has opted in to email communication. | | | | ----- | --------------- | | **#** | **Description** | | 1 | Subscribed | | 2 | Unsubscribed | | 3 | Bounced | | 5 | No Marketing | ### Sms status The sms status is the record of whether the contact has opted in to sms communication. | | | | ----- | --------------- | | **#** | **Description** | | 1 | Subscribed | | 2 | Unsubscribed | | 3 | Failed | | 4 | No Marketing | ## External URL Field An External URL field is an object with the following details. | Property | Type | Required | Description | | -------- | ------ | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | | ref | string | required | The unique reference key of the external URL | | url | string | optional | The url link (https) scheme eg. When the value is null, the external url record will be removed based on the provided reference key. | | label | string | optional | The label of the URL to display. | # Get Contact Custom Field Definition ## Get Custom Field Definition `POST` `[PlatformAddress]/api/1.0/contact?action=getCustomFieldDefinition` Get the definition of custom field {% tabs %} {% tab title="200 " %} ``` ``` {% endtab %} {% endtabs %} ## Returns An array of objects with the following properties | Property | Description | | ------------ | -------------------------------------------------------------- | | fieldId | The unique identifier for this custom field | | fieldType | [The type of this field](#types-of-field) | | displayName | The name of this field | | isRequired | If this field is required or not | | isActive | If this field is active or not | | sortOrder | Order to display this field | | selectValues | Values that can be selected with select fields | | fileTypes | Types of files that can be uploaded with the file custom field | ## Types of field * 0 = Small Text * 1 = Large Text * 2 = Single Select * Valid options are provided in the ‘selectValues’ key * 3 = Multiple Select * Valid options are provided in the ‘selectValues’ key * 4 = Address * 5 = Date * 6 = File * Valid file types are provided in the ‘fileTypes’ key * 7 = Static Text * Values cannot be set for this type * 8 = Whole Number This call will return an array of custom fields available on the account. The result will have the fieldId which is the unique field identifier for the specific field, as well as the display name and any options required for each field. As part of the field definition there is a ‘fieldType’ property which can be resolved to the following types * 0 = Small Text * 1 = Large Text * 2 = Single Select * Valid options are provided in the ‘selectValues’ key * 3 = Multiple Select * Valid options are provided in the ‘selectValues’ key * 4 = Address * 5 = Date * 6 = File * Valid file types are provided in the ‘fileTypes’ key * 7 = Static Text * Values cannot be set for this type * 8 = Whole Number # Get Company Custom Field Definition ## Get Company Custom Field Definition `POST` `[PlatformAddress]/api/1.0/contact?action=getCompanyCustomFieldDefinition` Get the definition of custom field {% tabs %} {% tab title="200 " %} ``` [ { "fieldId": 47, "fieldType": 3, "displayName": "Test Multiple", "isRequired": false, "isActive": true, "sortOrder": 1, "selectValues": { "Test 1": "Test 1", "Test 2": "Test 2" }, "fileTypes": null }, { "fieldId": 1, "fieldType": 0, "displayName": "TIN Number", "isRequired": false, "isActive": true, "sortOrder": 2, "selectValues": null, "fileTypes": null }, { "fieldId": 2, "fieldType": 4, "displayName": "Accountant Address", "isRequired": false, "isActive": false, "sortOrder": 3, "selectValues": null, "fileTypes": null }, { "fieldId": 3, "fieldType": 5, "displayName": "Your Birth Date", "isRequired": true, "isActive": true, "sortOrder": 4, "selectValues": null, "fileTypes": null }, { "fieldId": 45, "fieldType": 6, "displayName": "Profile Picture", "isRequired": false, "isActive": true, "sortOrder": 5, "selectValues": null, "fileTypes": [ "images" ] } ] ``` {% endtab %} {% endtabs %} ## Returns An array of objects with the following properties | Property | Description | | ------------ | ----------------------------------------------------------------------------- | | fieldId | The unique identifier for this custom field | | fieldType | [The type of this field](/contact/get-custom-field-definition#types-of-field) | | displayName | The name of this field | | isRequired | If this field is required or not | | isActive | If this field is active or not | | sortOrder | Order to display this field | | selectValues | Values that can be selected with select fields | | fileTypes | Types of files that can be uploaded with the file custom field | ## Types of field * 0 = Small Text * 1 = Large Text * 2 = Single Select * Valid options are provided in the ‘selectValues’ key * 3 = Multiple Select * Valid options are provided in the ‘selectValues’ key * 4 = Address * 5 = Date * 6 = File * Valid file types are provided in the ‘fileTypes’ key * 7 = Static Text * Values cannot be set for this type * 8 = Whole Number * 9 = Large Select This call will return an array of custom fields available on the account. The result will have the fieldId which is the unique field identifier for the specific field, as well as the display name and any options required for each field. As part of the field definition there is a ‘fieldType’ property which can be resolved to the following types * 0 = Small Text * 1 = Large Text * 2 = Single Select * Valid options are provided in the ‘selectValues’ key * 3 = Multiple Select * Valid options are provided in the ‘selectValues’ key * 4 = Address * 5 = Date * 6 = File * Valid file types are provided in the ‘fileTypes’ key * 7 = Static Text * Values cannot be set for this type * 8 = Whole Number * 9 = Large Select # Get Subscription Group List ## Get Subscription Group List `POST` `[PlatformAddress]/api/1.0/contact?action=getSubscriptionGroupList` {% tabs %} {% tab title="200 " %} ``` ``` {% endtab %} {% endtabs %} Subscription Groups are a feature that enables customers to segment their contacts into groups. These groups can then used for a range of purposes, including email and sms marketing, restricting access to event ticket types and content pages plus more. ## Returns An array with the following properties | Property | Description | | ----------- | ----------------------------------- | | id | The subscription group identifier | | groupName | The name for the group | | memberCount | The number of contacts in the group | | tagColour | The designated colour for the group | Returns an array of subscription groups available on the account. # Add Contacts To Subscription Group ## Add Contacts To Subscription Group `POST` `[PlatformAddress]/api/1.0/contact?action=addContactsToSubscriptionGroup` Add contact details to subscription group #### Path Parameters | Name | Type | Description | | -------- | ------- | ------------------------------------------------------------------------------------------ | | contacts | integer | The contact identifiers to subscribe to the group. This is an array of contact identifiers | | group | integer | The subscription group identifier to add the contacts to | {% tabs %} {% tab title="200 " %} ``` [ { "contactId": 4, "status": true }, { "contactId": 6, "status": true }, { "contactId": 55, "status": true }, { "contactId": 33, "status": false } ] ``` {% endtab %} {% endtabs %} ## Example Request ```javascript { "contacts": [ 4, 6, 55, 33 ], "group": 2481 } ``` ## Returns An array of objects with the following properties | Property | Description | | --------- | -------------------------------------------- | | contactId | The contact this result is for | | status | If the contact was added to the group or not | # Remove Contacts From Subscription Group ## Remove Contacts From Subscription Groups `POST` `[PlatformAddress]/api/1.0/contact?action=removeContactsFromSubscriptionGroup` Remove contact details from a subscription group #### Path Parameters | Name | Type | Description | | -------- | ------- | ------------------------------------------------------------- | | contacts | integer | The contact identifiers to unsubscribe from the group | | | integer | The subscription group identifier to remove the contacts from | {% tabs %} {% tab title="200 " %} ``` ``` {% endtab %} {% endtabs %} ## Returns An array of objects with the following properties | Property | Description | | --------- | ------------------------------------------------ | | contactId | The contact this result is for | | status | If the contact was removed from the group or not | Removes a number of contacts from a subscription group. This call is very similar to the [addContactsToSubscriptionGroup](/contact/add-contacts-to-subscription-group) call. It takes the same parameters and returns the same result. # Get Company List ## Get Company List `POST` `[PlatformAddress]/api/1.0/contact?action=getCompanyList` Get a list of companies #### Path Parameters | Name | Type | Description | | ------- | ------- | ------------------------------------------------------------------------------------------------------------------ | | perPage | integer | The number of companies to get in a single call | | start | integer | The starting result of the page. Not this is zero based (i.e. sending start = 0 will start from the first result.) | {% tabs %} {% tab title="200 " %} ``` ``` {% endtab %} {% endtabs %} ## Additional [Filter ](/getting-started/interpreting-the-response/filtering)Properties | Property | Description | Type | | ---------------- | ------------------------------ | ---------------------------------------------------------------- | | fromModifiedDate | Filter by Modified Date | [iVvy Timestamp Format](/development-reference/timestamp-format) | | toModifiedDate | Filter by Modified Date | [iVvy Timestamp Format](/development-reference/timestamp-format) | | venueId | Filter by specific Venue | integer | | venueGroupId | Filter by specific Venue Group | integer | ## Returns | Property | Description | | ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------ | | id | The unique identifier for the company | | externalId | Optionally a unique identifier of the company that is managed by an external application | | businessName | The company's business name | | tradingName | The company's trading name | | businessNumber | The company's registration number | | phone | The company's phone number | | fax | The company's fax number | | website | The company's website | | email | The company's email address | | address | The company’s address. This is an an object with the address [keys](#keys). | | modifiedDate | The modified date of the company | | primaryAccountManager | The primary account manager of the company. This is an an object with the [keys](#primaryaccountmanager) | | secondaryAccountManager | The secondary account manager of the company. This is an an object with the [keys](#secondaryaccountmanager) | | industry | The industry of the company. This is an an object with the [keys](#industry) | | primaryContact | The primary contact of the company. This is an an object with the [keys](#primarycontact) | | isAgent | Whether the company is an agent or not. | | parentCompanyId | The parent company id of the company | | leftValue | The left value of the node in the tree structure. | | rightValue | The right value of the node in the tree structure. | | depth | The depth of this company in the tree structure. | | rootId | The root company id. | | commissionSpace | The commission amount of the company space. | | commissionSpaceType | The commission amount type of the company space. | | commissionFoodValue | The commission amount of the company food. | | commissionFoodType | The commission amount type of the company food. | | commissionBeverageValue | The commission amount of the company beverage. | | commissionBeverageType | The commission amount type of the company beverage. | | commissionAudioVisualValue | The commission amount of the company audio visual. | | commissionAudioVisualType | The commission amount type of the company audio visual. | | commissionAccommodationValue | The commission amount of the company accommodation. | | commissionAccommodationType | The commission amount type of the accommodation. | | iataNumber | The IATA number of commission payable to the agent. | | customFields | The custom field information for the company. This is an array of fields, each an object with the [keys](#custom-fields-keys). | ## Keys | keys | | --------------------- | | line1 | | line2 | | line3 | | line4 | | city | | stateCode (e.g: QLD) | | countryCode (e.g: AU) | | postalCode | ## primarycontact | Property | Type | Description | | --------- | ------- | ------------------------------------ | | id | integer | The unique identifier of the contact | | firstName | string | The first name of the contact | | lastName | string | The last name of the contact | | email | string | The email address of the contact | | phone | string | The phone number of the contact | ## primaryaccountmanager | Property | Type | Description | | --------- | ------- | ---------------------------------------------------- | | id | integer | The unique identifier of the primary account manager | | firstName | string | The first name of the primary account manager | | lastName | string | The last name of the primary account manager | | email | string | The email address of the primary account manager | ## secondaryaccountmanager | Property | Type | Description | | --------- | ------- | ------------------------------------------------------ | | id | integer | The unique identifier of the secondary account manager | | firstName | string | The first name of the secondary account manager | | lastName | string | The last name of the secondary account manager | | email | string | The email address of the secondary account manager | ## industry | Property | Type | Description | | -------- | ------- | ------------------------------------- | | id | integer | The unique identifier of the industry | | name | string | The name of the industry | ### Custom Fields Keys \| fieldId | | displayName | | value | The result from this call will be a [collection](/getting-started/interpreting-the-response/collections) of all the events the user has access to. This call also accepts the [pagination](/getting-started/interpreting-the-response/pagination) and [filter](/getting-started/interpreting-the-response/filtering) properties. # Get Company ## Get Company `POST` `[PlatformAddress]/api/1.0/contact?action=getCompany` Get a single company's detail #### Path Parameters | Name | Type | Description | | ---- | ------- | ------------------------ | | id | integer | The company's identifier | {% tabs %} {% tab title="200 " %} ``` { "id": "25146", "businessName": "Test", "tradingName": "Test Trading", "businessNumber": "1234586", "email": "company@test.com", "phone": "0455550000", "otherPhone": "123456789", "fax": "0455550125", "website": "www.test.com", "address": { "line1": "Street Number", "line2": "Street Name", "line3": "", "line4": "", "city": "Gold Coast", "stateCode": "QLD", "countryCode": "AU", "postalCode": "4227" }, "customFields": [ { "fieldId": 5, "displayName": "Birth Date", "value": "1985-03-17 23:00:00 UTC" } ], "primaryAccountManager": "Test User", "secondaryAccountManager": "Test User", "industry": "Industry Name", "primaryContact": "Test User", "commissionRoomHireValue": 123, "commissionRoomHireType": "CHF", "commissionFoodValue": 222, "commissionFoodType": "CHF", "commissionBeverageValue": 333, "commissionBeverageType": "CHF", "commissionAudioVisualValue": 444, "commissionAudioVisualType": "CHF", "commissionAccommodationValue": 555, "commissionAccommodationType": "CHF", "iataNumber": "123456789" } ``` {% endtab %} {% endtabs %} ## Example Request `Get a specific company` ```javascript { "id":6 } ``` ## Returns | Property | Description | | ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------ | | id | The unique identifier for the company | | externalId | Optionally a unique identifier of the company that is managed by an external application | | businessName | The company's business name | | tradingName | The company's trading name | | businessNumber | The company's registration number | | phone | The company's phone number | | otherPhone | The company's other phone number | | fax | The company's fax number | | website | The company's website | | email | The company's email address | | address | The company’s address. This is an an object with the [keys](#keys) | | modifiedDate | The modified date of the company | | primaryAccountManager | The primary account manager of the company. This is an an object with the [keys](#primaryaccountmanager) | | secondaryAccountManager | The secondary account manager of the company. This is an an object with the [keys](#secondaryaccountmanager) | | industry | The industry of the company. This is an an object with the [keys](#industry) | | primaryContact | The primary contact of the company. This is an an object with the [keys](#primarycontact) | | isAgent | Whether the company is an agent or not. | | parentCompanyId | The parent company id of the company | | leftValue | The left value of the node in the tree structure. | | rightValue | The right value of the node in the tree structure. | | depth | The depth of this company in the tree structure. | | rootId | The root company id. | | commissionSpace | The commission amount of the company space. | | commissionSpaceType | The commission amount type of the company space. | | commissionFoodValue | The commission amount of the company food. | | commissionFoodType | The commission amount type of the company food. | | commissionBeverageValue | The commission amount of the company beverage. | | commissionBeverageType | The commission amount type of the company beverage. | | commissionAudioVisualValue | The commission amount of the company audio visual. | | commissionAudioVisualType | The commission amount type of the company audio visual. | | commissionAccommodationValue | The commission amount of the company accommodation. | | commissionAccommodationType | The commission amount type of the accommodation. | | iataNumber | The IATA number of commission payable to the agent. | | customFields | The custom field information for the company. This is an array of fields, each an object with the [keys](#custom-fields-keys). | | externalUrls | This is an array of [ExternalUrl](#external-url-field) field objects of the company. | ## Keys | | | --------------------- | | **keys** | | line1 | | line2 | | line3 | | line4 | | city | | stateCode (e.g: QLD) | | countryCode (e.g: AU) | | postalCode | ## primarycontact | Property | Type | Description | | --------- | ------- | ------------------------------------ | | id | integer | The unique identifier of the contact | | firstName | string | The first name of the contact | | lastName | string | The last name of the contact | | email | string | The email address of the contact | | phone | string | The phone number of the contact | ## primaryaccountmanager | Property | Type | Description | | --------- | ------- | ---------------------------------------------------- | | id | integer | The unique identifier of the primary account manager | | firstName | string | The first name of the primary account manager | | lastName | string | The last name of the primary account manager | | email | string | The email address of the primary account manager | ## secondaryaccountmanager | Property | Type | Description | | --------- | ------- | ------------------------------------------------------ | | id | integer | The unique identifier of the secondary account manager | | firstName | string | The first name of the secondary account manager | | lastName | string | The last name of the secondary account manager | | email | string | The email address of the secondary account manager | ## industry | Property | Type | Description | | -------- | ------- | ------------------------------------- | | id | integer | The unique identifier of the industry | | name | string | The name of the industry | ### Custom Fields Keys \| fieldId | | displayName | | value | ## External URL Field An External URL field is an object with the following details. | Property | Type | Description | | -------- | ------ | ----------------------------------------------------- | | ref | string | The unique reference key of the external URL | | url | string | The url link (https) scheme eg. | | label | string | The label of the URL to display. | ## Throws | Code | Description | | -------------------- | ---------------------- | | Specific Code: 24153 | Unable to find company | The company identifier must be provided to fetch a specific company from the system. # Get Company Note List ## Get Company Note List `POST` `[PlatformAddress]/api/1.0/contact?action=getCompanyNoteList` Fetches a list of notes for a specific company. #### Path Parameters | Name | Type | Description | | --------- | ------- | ----------------------------------------------------------------------------------------------------------------- | | companyId | integer | The unique identifier of the company to which the company notes belong | | perPage | integer | The number of company notes to fetch | | start | integer | The starting result of the page. Note this is zero based (i.e. sending start=0 will start from the first result.) | {% tabs %} {% tab title="200 " %} ``` { "meta": { "totalResults": 10, "start": 0, "perPage": 50, "count": 3 }, "results": [ { "id": 2, "companyId": 4, "noteText": "

Company Note 1

\n", "createdByUserId": 1, "createdDate": "2022-06-12 06:06:03 UTC", "modifiedDate": "2022-07-13 01:32:10" }, { "id": 4, "companyId": 4, "noteText": "

Company Note 2

\n", "createdByUserId": 1, "createdDate": "2022-07-13 01:27:27 UTC", "modifiedDate": "2022-07-13 01:27:27" }, { "id": 5, "companyId": 4, "noteText": "

Company Note 3

\n", "createdByUserId": 1, "createdDate": "2022-07-13 01:29:41 UTC", "modifiedDate": "2022-07-13 01:29:41" }, ] } ``` {% endtab %} {% endtabs %} The result from this call will be a [collection](/getting-started/interpreting-the-response/collections) of company note to which the user has access. This call also accepts the [pagination](/getting-started/interpreting-the-response/pagination) and [filter](/getting-started/interpreting-the-response/filtering) properties. ## Example Request `Fetches a list of Notes for a specific Company` ```javascript { "companyId" : 4, "perPage" : 50 } ``` ## Company Note | Property | Type | Description | | --------------- | --------- | ------------------------------------------------------- | | id | integer | The unique id of the company note | | companyId | integer | The id of the company to which the company note belongs | | noteText | string | The company note | | createdByUserId | integer | The details of person who created the company note | | createdDate | timestamp | The date & time the company note was created | | modifiedDate | timestamp | The date & time the company note was last modified | # Add or Update Company ## Add or Update Company `POST` `[PlatformAddress]/api/1.0/contact?action=addOrUpdateCompany` Add or update company details #### Path Parameters | Name | Type | Description | | --------------------------- | ------- | ----------------------------------------------------------------------------------------------------------------------- | | id | integer | The company's identifier. (Leave empty to add the company to the system) | | externalId | string | Optionally a unique identifier of the company that is managed by an external application | | businessName | string | The company's business name. (Mandatory if adding a new company) | | tradingName | string | The company's trading name | | businessNumber | string | The company's registration number | | phone | string | The company's phone number | | otherPhone | string | The company's other phone number | | fax | string | The company's fax number | | website | string | The company's website | | email | string | The company's email address | | address | string | The company's address. | | primaryContactId | integer | The unique id of the contact to assign as primary contact to the company | | primaryContact | object | The data array of contact to assign as primary contact. See addOrUpdateContact API in contact namespace for parameters. | | primaryAccountManagerId | integer | The id of primary account manager of the company | | secondaryAccountManagerId | integer | The id of secondary account manager of the company | | industryId | integer | The industry id of company | | isAgent | integer | Whether the company has an agent or not. | | commissionSpace | integer | The commission amount of the company for Space. | | commissionSpaceType | integer | The commission amount type of the company for Space. | | commissionFood | integer | The commission amount of the company for food. | | commissionFoodType | integer | The commission amount type of the company for food. | | commissionBeverage | integer | The commission amount of the company for beverage. | | commissionBeverageType | integer | The commission amount type of the company for beverage. | | commissionAudioVisual | integer | The commission amount of the company for audio visual. | | commissionAudioVisualType | integer | The commission amount type of the company for audio visual. | | commissionAccommodation | integer | The commission amount of the company for accommodation. | | commissionAccommodationType | integer | The commission amount type of the company for accommodation. | | iataNumber | string | The IATA number of commission payable to the agent. | | updateIfExists | boolean | Whether or not to update the company by businessName when id parameter is missing. | | customFields | array | The Company Custom fields | | externalUrls | array | The Company External URLs | {% tabs %} {% tab title="200 " %} ``` Adding a company { "success": true, "id": 1618 } Updating a company { "id": 1618 } ``` {% endtab %} {% endtabs %} ## Example Request: Adding a company ```javascript { "businessName": "New Company", "tradingName": "ABC", "email": "company@test.com", "address": { "line1": "address line 1", "line2": "address line 2", "stateCode": "QLD", "postalCode": "4227", "countryCode": "AU" }, "primaryAccountManagerId": 123, "secondaryAccountManagerId": 123, "industryId": 11, "isAgent": 1, "commissionSpace": 20, "commissionSpaceType" : 2, "commissionFoodType": "2", "commissionFood":"10", "commissionBeverage": 30, "commissionBeverageType" : 1, "commissionAudioVisual": 50, "commissionAudioVisualType" : 2, "commissionAccommodation": 50, "commissionAccommodationType": 1, "iataNumber": "123456789", "customFields": [ { "fieldId": 6, "value": "2022-08-30 10:00:00 UTC" }, { "fieldId": 7, "value": "string" } ], "externalUrls" : [ { "ref": "example1", "label": "Example One", "url": "https://example1.com" }, { "ref": "example2", "label": "Example Two", "url": "https://example2.com" }, { "ref": "example3", "label": "Example Three", "url": "https://example3.com" } ] } ``` ## Example Request: Updating a Company ```javascript { "id": 1618, "businessName": "Updated Company name", "address": { "line1": "address line 11", "line2": "address line 22", "stateCode": "QLD", "postalCode": "4227", "countryCode": "AU" } "primaryAccountManagerId": 123, "secondaryAccountManagerId": 123, "industryId": 11, "isAgent": 1, "commissionSpace": 20, "commissionSpaceType" : 2, "commissionFoodType": "2", "commissionFood":"10", "commissionBeverage": 30, "commissionBeverageType" : 1, "commissionAudioVisual": 50, "commissionAudioVisualType" : 2, "commissionAccommodation": 50, "commissionAccommodationType": 1, "iataNumber": "123456789", "customFields": [ { "fieldId": 6, "value": "2022-08-30 10:00:00 UTC" }, { "fieldId": 7, "value": "string" } ] } ``` ## Keys | keys | | --------------------- | | line1 | | line2 | | line3 | | line4 | | city | | stateCode (e.g: QLD) | | countryCode (e.g: AU) | | postalCode | ## Returns | Property | Description | | -------- | ------------------------------------------------ | | success | If the company was successfully added or updated | | id | The unique identifier for the company | | message | Message of the failure (if success was false) | This call takes values for a company, and either 1. Updates the values for that company (after you have provided an id in the parameters), or 2. Adds the company to the system (if the id parameter is missing) The result of this call will contain the status of the result (either true or false) and the company identifier of the updated or newly created company. The properties of the company currently supported are: * businessName * externalId * tradingName * businessNumber * phone * fax * website * email * address * This is an object * primaryAccountManagerId * secondaryAccountManagerId * industryId * isAgent * commissionSpace * commissionSpaceType * commissionFoodType, * commissionFood * commissionBeverage * commissionBeverageType * commissionAudioVisual * commissionAudioVisualType * commissionAccommodation * commissionAccommodationType * iataNumber * customFields # Add or Update Lead ## Add or Update Lead `POST` `[PlatformAddress]/api/1.0/contact?action=addOrUpdateLead` Add or update the details of a lead #### Path Parameters | Name | Type | Description | | -------------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | | id | integer | The unique identifier of a lead (Leave empty to add the lead to the system) | | qualityId | integer | The quality of the lead | | industryId | integer | The unique industry of the lead. (Required when lead belongs to contact and id parameter is missing) | | sourceId | integer | The unique source id of the lead. (Required when the id parameter is missing. ) | | companyId | integer | The unique company id of lead. (Required when lead belongs to company and id parameter is missing) | | company | object | The data array of company. See addOrUpdateCompany API in contact namespace for parameters. See assigning a company/contact to the lead. | | companyLeadContactId | integer | The unique company id of lead (Required when lead belongs to company and id parameter is missing) | | contactId | integer | The unique contact id of lead (Required when lead belongs to contact and id parameter is missing) | | contact | object | The data array of contact. See addOrUpdateContact API in contact namespace for parameters. See assigning a company/contact to the lead. | | name | string | The name for the lead (Required when the id parameter is missing) | | ownerUserId | integer | The id of the sales person user assigned to the lead. The privileges of the user assigned to the api key may prevent this from being changed. | | typeId | integer | The type of lead (Required when id parameter is missing) | | subtypeId | integer | The sub type of lead (Required when type have sub types) | | stageId | integer | The stage of lead (Required when id parameter is missing) | | stageReasonId | integer | The unique stage reason id of opportunity | | channelId | integer | The channel Id of lead | | description | string | The description for the lead | | customFields | array | The custom field values of the lead. A custom field value might be required depending on how it has been configured in the account. See Custom Field | {% tabs %} {% tab title="200 " %} ``` ``` {% endtab %} {% endtabs %} ## Custom Field A lead custom field is an object with the following details. | Property | Type | Required | Description | | ---------- | ------- | -------- | ------------------------------------------------------------------------------ | | fieldId | integer | required | The unique id of the lead custom field | | fieldValue | mixed | required | The value of the lead custom field. Depends on the type of custom field value. | ## Special Considerations ### Assigning a company/contact to the lead The *contact type* of a lead is either a *company* **or** a *contact*. When *companyId* **or** *company* is present in the request then the *contact type* of the lead is set to *company*, and the *contactId* **or** *contact* must be a contact that belongs to that company. Otherwise the *contact type* of the lead is set to *contact* and contactId can be any valid contact in the account. If *contact* and *company* are present in request then it will link given contact to company. ## Returns | Property | Description | | -------- | ------------------------------------------------ | | success | Whether or not the lead was added to the account | | id | The unique id of the lead | ## Throws | Code | Description | | -------------------- | ---------------------------- | | Specific Code: 24215 | The request is empty | | Specific Code: 24216 | The lead does not exist | | Specific Code: 24218 | The lead details are invalid | This call takes values for a lead, and either 1. Updates the values for that lead (after you have provided an id in the parameters), or 2. Adds the lead to the system (if the id parameter is missing) The result of this call will contain the status of the result (either true or false) and the lead identifier of the updated or newly created lead. # Add or Update Contact Note ## Add or Update Contact Note `POST` `[PlatformAddress]/api/1.0/contact?action=addOrUpdateContactNote` Add or update contact note details #### Request Body | Name | Type | Description | | --------- | ------- | ---------------------------------------------------------- | | id | integer | The contact note's identifier. (Leave empty to add new) | | contactId | integer | The unique identifier of the contact to which note belongs | | noteText | string | The discription of the note | {% tabs %} {% tab title="200 " %} ``` { "success": true "id":33884 } ``` {% endtab %} {% endtabs %} ## Example Request: Adding a contact note ```javascript { "contactId": 2, "noteText": "test note", } ``` ## Returns | Property | Description | | -------- | ----------------------------------------------------- | | success | If the contact note was successfully added or updated | | id | The unique identifier for the contact note | # Add or Update Company Note ## Add or Update Company Note `POST` `[PlatformAddress]/api/1.0/contact?action=addOrUpdateCompanyNote` Add or update company note details #### Request Body | Name | Type | Description | | --------- | ------- | ---------------------------------------------------------------------- | | id | integer | The company note's identifier. (Leave empty to add new) | | companyId | integer | The unique identifier of the company to which note being added/updated | | noteText | string | The description of the note | {% tabs %} {% tab title="200 " %} ``` { "success": true "id":33884 } ``` {% endtab %} {% endtabs %} ## Example Request: Adding a company note ```javascript { "companyId": 2, "noteText": "test note", } ``` ## Returns | Property | Description | | -------- | ----------------------------------------------------- | | success | If the company note was successfully added or updated | | id | The unique identifier for the company note | # Event ## Namespace `event` # Add or Update Event ## addOrUpdateEvent `POST` `[PlatformAddress]/api/1.0/event?action=addOrUpdateEvent` Add or update event details. #### Request Body | Name | Type | Description | | -------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------ | | businessUnitId | integer | Required when business unit defined in event's account | | eventType | string | Required when adding an event. Value must be 12. The value cannot be changed for an existing event. | | title | string | Required when adding an event. The title of the event. Max Length: 140 | | timezone | string | Required when adding an event. The timezone of the event. (Datatype = timestamp) | | startDateTime | string | When adding an event. The start date & time of the event. | | endDateTime | string | When adding an event. The end date & time of the event. The value must be on or after startDateTime. (Datatype = timestamp) | | capacity | integer | The maximum number of attendees who can register for the event. A value of 0 (zero) represents no limit. | | budget | number | A budget amount assigned to the event. (Datatype = float) | | costCenterId | integer | A cost center assigned to the event. The value is an identifier of a cost center in the account, which must be assignable to events. | | primaryContactUserId | integer | The primary contact user of the event. The value is an identifier of a user in the account. | {% tabs %} {% tab title="200 " %} ``` { "success": true, "id": 98481, "code": "BAS4G248" } ``` {% endtab %} {% endtabs %} ## Example Request ```javascript { "eventType": 12, "title": "A New Event", "timezone": "Australia/Sydney", "startDateTime": "2018-03-05 03:00:00 UTC", "endDateTime": "2018-03-05 06:00:00 UTC", "capacity": 10, "budget": 150, "costCenterId": 834, "primaryContactUserId": 7821, "eventTypeIds": [56,57], "isAccommIncluded": false } ``` This action call accepts the parameters of an event and will; 1\) Add a new event to the account 2\) Update an existing event in the account when the id parameter is provided. NOTE: This action call only supports “Record Event Details” type events (i.e. eventType value of 12). ## Returns | Property | Description | Type | | -------- | ------------------------------------------------------------------------- | ------- | | success | Whether or not the action succeeded (i.e. the event as added or updated). | boolean | | id | The event’s unique identifier. The value will be null on failure. | integer | | code | The event’s unique code. The value will be null on failure. | string | # Get Event List ## getEventList `GET` `[PlatformAddress]/api/1.0/event?action=getEventList` Get List of Events #### Request Body | Name | Type | Description | | ------------------------- | ------- | ---------------------------------------------------------------------------------------------------------------- | | perPage | integer | The number of events to get in a single api call | | start | integer | The starting result of the page. Note this is zero based (i.e. sending start=0 will start from the first result) | | includeVenueDetails | boolean | If the response should include venue details | | includeTicketDetails | boolean | If the response should include ticket details | | includeInformationDetails | boolean | If the response should include the event information | | includeHomepageContent | boolean | If the response should include the homepage content of the website | | orderBy | string | Sort Results: Support Parameter 'startDate' | | orderDir | string | Sort Direction: Support Parameter 'asc' or 'desc' | {% tabs %} {% tab title="200 " %} ``` ``` {% endtab %} {% endtabs %} ## Additional [Filter ](/getting-started/interpreting-the-response/filtering)Properties | Property | Description | Type | | ---------- | ---------------------------------------------- | ---------------------------------------------------------------- | | afterDate | Filter by start date | [iVvy Timestamp Format](/development-reference/timestamp-format) | | beforeDate | Filter by end date | [iVvy Timestamp Format](/development-reference/timestamp-format) | | status | Filter by status Array of the following values | Must be an array | ## Returns A collection object with the following properties in the results. | Property | Description | | ----------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | id | The unique event identifier | | code | The code for the event | | eventType | [The type of event.](#event-types) | | title | The title of the event | | domainName | The domain name of the event | | startDateTime | The start of the event, at UTC | | endDateTime | The end of the event, at UTC | | numRegistered | The number of registrations | | currentStatus | [The current status of the event](#current-status-of-event) | | contactEmail | The contact email address on the event | | websiteUrl | The URL for the event website | | websiteTemplateBannerImageUrl | Banner that is displayed on the website | | venue | [Details of the venue of the event (if the includeVenueDetails flag is set on the request)](#venue-details) | | tickets | [The tickets of an event (if the includeTicketDetails flag is set on the request)](#event-ticket-details) | | information | [Event website information (if the includeInformationDetails flag is set on the request) This is an array of objects with the information properties](#event-website-information-details). | | homepageContent | Content of the website home page (if the includeHomepageContent flag is set on the request). Note this is the contents of the HTML that is entered in as the home page content of the event. | | eventTags | [The tags of the event.](#event-tags) | | modifiedDate | timestamp | The result from this call will be a [collection](/getting-started/interpreting-the-response/collections) of all the events the user has access to. This call also accepts the [pagination](/getting-started/interpreting-the-response/pagination) and [filter](/getting-started/interpreting-the-response/filtering) properties. ### Event types | Type | Description | | ---- | -------------------- | | 0 | Other | | 1 | Party | | 2 | Festival | | 3 | Golf Day | | 4 | Wedding | | 5 | Meeting | | 6 | Seminar | | 7 | Conference | | 8 | Exhibition | | 9 | Roadshow | | 10 | Simple | | 11 | Party (21st / 18th) | | 12 | Record Event Details | The result from this call will be a collection of all the events the user has access to. This call also accepts the pagination and filter properties. ### Current status of event | Code | Description | | ---- | ----------- | | 0 | Draft | | 1 | Closed | | 3 | Launched | ### Venue details | Property | Description | | ----------- | --------------------------------- | | name | The venue name | | description | The description of the venue | | address | The address of the venue | | imageUrl | The URL to the image of the venue | ### Event ticket details | Property | Description | | ------------------ | -------------------------------------------------------------------------------------------------------------------------------------- | | id | The unique identifier for the ticket | | title | Title of the ticket | | capacity | Capacity of the ticket | | description | Description of the ticket | | amount | Amount of the ticket | | isTaxFree | Amount of the ticket is tax free | | subscriptionGroups | [Subscription groups assigned to the ticket This an array of objects with subscription group properties](#subscription-group-details). | ### Subscription group details | Property | Description | | --------- | ----------------------------------- | | id | The subscription group identifier | | groupName | The name for the group | | tagColour | The designated colour for the group | ### Event website information details | Property | Description | | ----------- | ------------------------------------------ | | description | Description of the information | | information | Content of the information | | fileUrl | Attached file url of event information | | sortOrder | The order in which to sort the information | ### Event tags | Property | Description | | -------- | --------------------------------------- | | id | The unique identifier for the event tag | | name | The name of the event tag | # Get Event `POST` `[PlatformAddress]/api/1.0/event?action=getEvent` Add or update event details #### Path Parameters | Name | Type | Description | | ---- | ------- | -------------------- | | | integer | The event identifier | {% tabs %} {% tab title="200 " %} ``` { "id": 144428, "code": "EVENTCODE", "eventType": 0, "title": "test", "timezone": "Australia/Brisbane", "capacity": 123, "domainName": null, "startDateTime": "2019-09-28 06:00:00 UTC", "endDateTime": "2019-10-31 07:00:00 UTC", "numRegistered": 26, "currentStatus": 3, "contactName": "", "contactEmail": "", "websiteUrl": "https://www.ivvy.com.au/event/EVENTCODE/", "websiteTemplateBannerImageUrl": "", "eventTags": [], "appTitle": null, "twitter": null, "appBanner": 0, "map": null, "includeSpeakers": false, "displaySpeakers": false, "includeSponsors": false, "displaySponsors": false, "includeBooths": true, "displayExhibitors": false, "includeAbstracts": false, "displayAbstracts": false, "useMultipleSessions": true, "includeHotels": false, "includeTravel": false, "includeMembership": false } ``` {% endtab %} {% endtabs %} ## Returns | Property | Description | | ----------------- | ------------------------------------------------------------------ | | id | The unique event identifier | | code | The code for the event | | title | The title of the event | | domainName | The domain name of the event | | startDateTime | The start of the event, at UTC | | endDateTime | The end of the event, at UTC | | numRegistered | The number of registrations | | currentStatus | The current status of the event | | appTitle | The title to display on mobile platforms | | twitter | Twitter hashtag for this event | | appBanner | Banner to display on mobile platforms | | map | Map of the event | | includeSpeakers | Whether or not the event includes speakers | | displaySpeakers | Whether or not the speakers are displayed on the event website | | includeSponsors | Whether or not the event includes sponsors | | displaySponsors | Whether or not there are sponsors displayed on the event website | | includeBooths | Whether or not the event includes exhibition booths | | displayExhibitors | Whether or not there are exhibitors displayed on the event website | | includeAbstracts | Whether or not the event includes abstracts | | displayAbstracts | Whether or not there are abstracts displayed on the event website | | includeHotels | Whether or not the event includes hotel accommodation | | includeTravel | Whether or not the event includes travel (flights and transfers) | | includeMembership | Whether or not the event includes memberships | | eventTags | The tags of the event | ## Event tags | Code | Description | | ---- | --------------------------------------- | | id | The unique identifier for the event tag | | name | The name of the event tag | ## Throws | Property | Description | | -------------------- | -------------------- | | Specific Code: 24097 | Unable to find event | The event identifier must be provided as part of this call to fetch the specific event. E.g. {"id":1} can be used to fetch the details of an event with the identifier of 1. # Get Registration ## Get Registration `POST` `[PlatformAddress]/api/1.0/event?action=getRegistration` Get Registration Details #### Path Parameters | Name | Type | Description | | ------- | ------- | -------------------------------------------------- | | id | integer | The registration identifier | | eventId | integer | The event identifier to which registration belongs | {% tabs %} {% tab title="200 " %} ``` ``` {% endtab %} {% endtabs %} ## Returns | Property | Description | | ------------------ | ------------------------------------------------------------------------------------------------------------------- | | id | The unique registration identifier | | currentStatus | The current status of the event | | isExhibitor | Whether or not event registration is exhibitor | | completedDate | The registered date time of event registration | | firstName | The first name of the event registration | | lastName | The last name of the event registration | | phone | The phone number of event registration | | privacyConsentData | The object of [Privacy Consent](/contact/get-contact#privacy-consent-data) field objects of the event registration. | | modifiedDate | The date & time the registration was last modified | | mainContactId | The id of the main contact for the event registration | | invoiceTotalCost | Total Cost of the invoices for the event registration | | invoiceTotalPaid | Total payments of the invoices for the event registration | | createdDate | The date that the event registration was initially created. | ## Throws | Code | Description | | -------------------- | ----------------------- | | Specific Code: 24207 | Unable to find event | | Specific Code: 24208 | Invalid Registration Id | | Specific Code: 24209 | Registration not found | # Get Registration List ## Get Registration List `POST` `[PlatformAddress]/api/1.0/event?action=getRegistrationList` Get a list of registrations #### Path Parameters | Name | Type | Description | | ------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------ | | perPage | integer | The number of registrations to get in a single api call. Must be an integer greater than 0 and maximum 100 | | start | integer | The starting result of the page. Note this is zero based (i.e. sending start = 0 will start from first result). Must be 0 or greater | | eventId | integer | The event identifier. | {% tabs %} {% tab title="200 " %} ``` ``` {% endtab %} {% endtabs %} ## Additional [Filter ](/getting-started/interpreting-the-response/filtering)Properties | Property | Description | Type | | ------------ | ----------------------- | ---------------------------------------------------------------- | | modifiedDate | Filter by modified date | [iVvy Timestamp Format](/development-reference/timestamp-format) | ## Returns A collection object with the following properties in the results | Property | Description | | ------------------ | ------------------------------------------------------------------------------------------------------------------- | | id | The unique registration identifier | | eventName | The name of event that event registration belongs | | currentStatus | The current status of the event registration | | isExhibitor | Whether or not event registration is exhibitor | | completedDate | The registered date time of event registration | | mainContactId | The main contact id of event registration | | firstName | The first name of the event registration | | lastName | The last name of the event registration | | phone | The phone number of event registration | | privacyConsentData | The object of [Privacy Consent](/contact/get-contact#privacy-consent-data) field objects of the event registration. | | invoiceTotalCost | The total cost of event registration | | invoiceTotalPaid | The total amount paid of event registration | | createdDate | The date & time the registration was created | | modifiedDate | The date & time the registration was last modified | The result from this call will be a collection of all the events the user has access to. This call also accepts the pagination and filter properties. The result from this call will be a [collection](/events#collections) of all the events the user has access to. This call also accepts the [pagination](/events#pagination) and [filter](/events#filtering) properties. ## Throws | Code | Description | | -------------------- | -------------------- | | Specific Code: 24206 | Unable to find event | ## Registration Current Status Details | Property | Description | | -------- | --------------- | | 1 | In Progress | | 2 | Completed | | 4 | Payment Waiting | # Get Attendee ## Get Attendee `POST` `[PlatformAddress]/api/1.0/event?action=getAttendee` #### Path Parameters | Name | Type | Description | | ------- | ------- | ---------------------------------------------- | | id | integer | The attendee identifier | | eventId | integer | The event identifier to which attendee belongs | {% tabs %} {% tab title="200 " %} ``` ``` {% endtab %} {% endtabs %} ## Returns | Property | Description | | ------------------------ | --------------------------------------------------------------------------------------------------------------- | | id | The unique registration identifier | | registrationStatus | The registration status of the event attendee | | contactId | The contactId of event attendee | | registrationId | The registration id of event attendee | | ticketTitle | The title of ticket | | firstName | The first name of the event attendee | | lastName | The last name of the event attendee | | email | The email address of the event attendee | | privacyConsentData | The object of [Privacy Consent](/contact/get-contact#privacy-consent-data) field objects of the event attendee. | | hasAttended | Whether attendee has attended event or not | | sessionHasAttended | Whether attendee has attended session or not | | isPublic | Whether event attendee is public or not | | barcode | The barcode text of event attendee | | barcodeUrl | The barcode url of event attendee | | ticketUrl | The ticket url of event attendee | | attendedDatetime | The attended date time of event attendee | | sessionAttendedTimestamp | The session attended date time of event attendee | | cost | The cost of ticket of event attendee | | customFields | The array of custom fields data of event attendee with below details | | sessions | array of [Sessions](#session-details) which attendee registered or attended | ## Custom field details | Property | Description | | -------- | ------------------------------------------ | | name | The name of the custom field | | value | The value of the custom field for attendee | ## Session details | Property | Description | | ----------------- | -------------------------------------------- | | sessionId | The unique id of the session | | sessionName | The name of the session | | isOptional | Whether the session is optional or not | | hasAttended | Whether the session has been attended or not | | attendedDatetime | The date & time the session was attended | | isSessionReserved | Whether the session is reserved or not | ## Throws | Code | Description | | -------------------- | -------------------- | | Specific Code: 24211 | Unable to find event | | Specific Code: 24212 | Invalid Attendee Id | | Specific Code: 24213 | Attendee not found | # Get Attendee List ## Get Attendee List `POST` `[PlatformAddress]/api/1.0/event?action=getAttendeeList` #### Path Parameters | Name | Type | Description | | ------- | ------- | -------------------------------------------------------------------------------------------------------------- | | perPage | integer | The number of attendees to get in a single api all | | start | integer | The starting result of the page. Note this is zero based (i.e. sending start = 0 will start from first result. | | eventId | integer | The event identifier | {% tabs %} {% tab title="200 " %} ``` ``` {% endtab %} {% endtabs %} ## Additional [Filter](/getting-started/interpreting-the-response/filtering) Properties No filters available ## Returns A collection object with the following properties in the results | Property | Description | | ------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | id | The unique registration identifier | | registrationStatus | The registration status of the event attendee | | contactId | The contactId of event attendee | | ticketTitle | The title of ticket | | firstName | The first name of the event attendee | | lastName | The last name of the event attendee | | email | The email address of the event attendee | | privacyConsentData | The object of [Privacy Consent](/contact/get-contact#privacy-consent-data) field objects of the event attendee. | | hasAttended | Whether attendee has attended event or not | | sessionHasAttended | Whether attendee has attended session or not | | isPublic | Whether event attndee is public or not | | barcode | The barcode text of event attendee | | barcodeUrl | The barcode url of event attendee | | ticketUrl | The ticket url of event attendee | | attendedDatetime | The attended date time of event attendee | | sessionAttendedTimestamp | The session attended date time of event attendee | | cost | The cost of ticket of event attendee | | customFields | The array of custom fields data of event attendee with below details | | sessions | array of [Sessions](/events/get-attendee#session-details) which attendee registered or attended | | createdDate | The date & time the attendee was created | | modifiedDate | The date & time the attendee was last modified. Note: Updating the contact details of an Attendee changes the modifiedDate of the Contact. It does not change the modifiedDate of the Attendee. | ## Custom field details | Property | Description | | -------- | ------------------------------------------ | | name | The name of the custom field | | value | The value of the custom field for attendee | The result from this call will be a [collection](/getting-started/interpreting-the-response/collections) of all the events the user has access to. This call also accepts the [pagination](/getting-started/interpreting-the-response/pagination) and [filter](/getting-started/interpreting-the-response/filtering) properties. ## Throws | Code | Description | | -------------------- | -------------------- | | Specific Code: 24210 | Unable to find event | # Get Invited Contact List ## Get Invited Contact List ## Get Invited Contact List `POST` `[PlatformAddress]/api/1.0/event?action=getInvitedContactList` Get a list of invited contact for event. #### Request Body | Name | Type | Description | | ------- | ------- | ----------------------------------------------------------------------------------------------------------------- | | eventId | integer | The unique id of the event to which the invitation belong | | start | integer | The starting result of the page. Note this is zero based (i.e. sending start=0 will start from the first result.) | | perPage | integer | The number of invited contacts to fetch | {% tabs %} {% tab title="200 " %} ``` { "meta": { "totalResults": 345, "start": 0, "perPage": 2, "count": 2 }, "results": [ { "eventId": 1, "contactId": 1, "firstName": "Test", "lastName": "Last", "email": "first@test.com", "phone": "1346789798", "response": "Y", "registrationId": 1, "modifiedDate": "2018-09-19 09:00:34 UTC" }, { "eventId": 1, "contactId": 2, "firstName": "Test", "lastName": "Two", "email": "test@two.com", "phone": "+61 123456789", "response": "U", "registrationId": null, "modifiedDate": "2018-09-19 08:57:11 UTC" } ] } ``` {% endtab %} {% endtabs %} The result from this call will be a [collection](/getting-started/interpreting-the-response/collections) of invited contact records the user has access to. This call also accepts the [pagination](/getting-started/interpreting-the-response/pagination) and [filter](/getting-started/interpreting-the-response/filtering) properties. ### Returns | Property | Description | Type | | -------------- | ----------------------------------------------------- | -------- | | eventId | The unique id of the event for invited contact | integer | | contactId | The unique contact id of the invited contact | integer | | firstName | The first name of the invited contact | integer | | lastName | The last name of the invited contact | integer | | email | The email of the invited contact | string | | phone | The phone number of the invited contact | string | | response | The [response](#response) from the invited contact | string | | registrationId | The registration id of the invited contact | integer | | modifiedDate | The date & time the invited contact was last modified | datetime | ### Response | Status | Description | | ------ | ----------- | | U | Undecided | | Y | Yes | | N | No | # Invite Contacts ## Invite Contacts `POST` `[PlatformAddress]/api/1.0/event?action=inviteContacts` Invite contact(s) to event. #### Path Parameters | Name | Type | Description | | -------- | ------- | ------------------------------------------------------ | | event | integer | The event identifier to invite the contact to | | contacts | integer | An array of contact identifiers to invite to the event | {% tabs %} {% tab title="200 " %} ``` { "results":[ { "contact":1, "status":true, "inviteLinkYes":"http://....", "inviteLinkNo":"http://...." }, { "contact":2, "status":false}, { "contact":3, "status":true "inviteLinkYes":"http://....", "inviteLinkNo":"http://...." } ] } ``` {% endtab %} {% endtabs %} ## Example Request `Example: Invite contacts with identifiers 1, 2 and 3 to event with the identifier 4` ```javascript { "event":4, "contacts":[1,2,3] } ``` ## Returns | Property | Description | | ------------- | ------------------------------------------------- | | results | An array of objects with the following properties | | contact | The contact identifier | | status | The status of the request | | inviteLinkYes | Invitation link for the YES responses | | inviteLinkNo | Invitation link fo the NO responses | To invite a contact to the event, pass through the event identifier and an array of contact identifiers through to this call. The result will be a an array indicating if each of the contacts invitation was successful or not, and if so the links for responding to the invitations for both yes and no. # Get Sponsorship List ## Get Sponsorship List `POST` `[PlatformAddress]/api/1.0/event?action=getSponsorshipList` Lists the sponsors that are sponsoring the event. #### Path Parameters | Name | Type | Description | | ----- | ------- | -------------------- | | event | integer | The event identifier | {% tabs %} {% tab title="200 " %} ``` { "meta":{"totalResults":1,"start":0,"perPage":1,"count":1},"results":[{"id":"1","name":"Test Sponsor for event 1","description":"...","websiteAddress":"www.sponsor1.com","logoI mageUrl":"https://.../554ac739bcc9a.png","level":"9","customLevelId":null,"sponsorshipAmount":"44","sponsorshipAmountPaid":"4"}] } ``` {% endtab %} {% endtabs %} ## Example Request `Example: Fetch the list of sponsors on an event` ```javascript { "event":15593 } ``` ## Returns A collection array with the following object properties in the results | Property | Description | | --------------------- | ----------------------------------------------------------------------------- | | id | The unique sponsor identifier | | name | The name of the sponsor | | description | The description of the sponsor | | websiteAddress | The URL to the sponsor details | | logoImageUrl | The URL to the sponsor details | | level | The sponsorship level of the sponsor | | customLevelId | The custom level identifier if this sponsor has a custom level assigned to it | | sponsorshipAmount | How much this sponsorship is for | | sponsorshipAmountPaid | How much has been paid by the sponsor so far | ## Throws | Code | Description | | -------------------- | ---------------------------- | | Specific Code: 24094 | Event does not have sponsors | | Specific Code: 24100 | Unable to find event | # Get Speaker List ## Get Speaker List `POST` `[PlatformAddress]/api/1.0/event?action=getSpeakerList` Get the list of speakers at an event #### Path Parameters | Name | Type | Description | | ----- | ------- | -------------------- | | event | integer | The event identifier | {% tabs %} {% tab title="200 " %} ``` { "meta":{ "totalResults":1, "start":0, "perPage":1, "count":1 }, "results": [ { "id":"6", "fullName":"Mr Speaker", "organisation":"Google", "position":"Lead Developer", "profileDescription":"...", "profileImageUrl":"https://…./8869de9237bb1.png" } ] } ``` {% endtab %} {% endtabs %} ## Example Request `Example: Fetch the list of speakers at an event` ```javascript { "event":15593 } ``` ## Returns A collection object with the following properties of objects in the results | Property | Description | | ------------------ | -------------------------------------- | | id | The unique speaker identifier | | fullName | The speaker’s name | | organisation | The speaker’s organisation | | position | The position of the speaker | | profileDescription | The speaker’s profile | | profileImageUrl | The URL to the speaker’s profile image | ## Throws | Code | Description | | -------------------- | ---------------------------- | | Specific Code: 24124 | Event does not have speakers | | Specific Code: 24101 | Unable to find event | # Get Session List ## Get Session List `POST` `[PlatformAddress]/api/1.0/event?action=getSessionList` Get the list of sessions at an event #### Path Parameters | Name | Type | Description | | ------- | ------- | -------------------- | | eventId | integer | The event identifier | {% tabs %} {% tab title="200 " %} ``` { "meta": { "totalResults": 1, "start": 0, "perPage": 100, "count": 1 }, "results": [ { "id": 1, "eventId": 1, "name": "Test Session 1", "startDate": "2018-04-18 03:30:00 UTC", "endDate": "2018-04-18 15:00:00 UTC", "description": null, "roomId": 1, "isOptional": true, "maxCapacity": 10, "costAmount": 100, "isTaxFree": true, "autoCloseDate": "2025-03-12 19:30:00 UTC", "setupTime": 3, "breakdownTime": 4, "speakers": [ 1, 2581 ], "showInAgenda": true, "showTime": true, "onlyForCertainTickets": true, "tickets": [ 1, 576 ], "notes": "Session notes", "setupNotes": "setup notes", "createdDate": "2018-04-19 05:51:17 UTC", "modifiedDate": "2025-03-11 23:17:05 UTC", "allowGuests": true } ] } ``` {% endtab %} {% endtabs %} ## Example Request `Example: Fetch the list of sessions at an event` ```javascript { "eventId":1 } ``` ## Returns A collection object with the following properties of objects in the results | Property | Description | | --------------------- | -------------------------------------------------------------------------------------------- | | id | The unique identifier of the event session | | eventId | The unique identifier of the event to which the event session belong | | name | Session name | | startDate | The session start date & time | | endDate | The session end date & time | | description | The session HTML description | | roomId | The unique identifier of the room to which the event session belong | | isOptional | Whether or not the session is optional | | maxCapacity | Maximum # of attendees who can register for the session | | costAmount | Optional session cost | | isTaxFree | Whether or not the session tax to be applied | | autoCloseDate | The session auto close date | | setupTime | The setup time of the session (in minutes) | | breakdownTime | The breakdown time of the session (in minutes) | | speakers | Array of a unique identifier of the speakers to which the event session belong | | showInAgenda | Whether or not to show the session in the agenda | | showTime | Whether or not to show the time of the session | | onlyForCertainTickets | Whether or not the session is available for certain tickets only | | tickets | The specific tickets that are available for this session (when onlyForCertainTickets = true) | | notes | Any notes for the session | | setupNotes | Setup notes | | createdDate | The session creation date & time | | modifiedDate | The session last modified date & time | | allowGuests | Whether or not guests are allowed to register for this session | ## Throws | Code | Description | | -------------------- | -------------------- | | Specific Code: 24456 | Event does not exist | # Create Login Token ## Create Login Token `POST` `[PlatformAddress]/api/1.0/event?action=createLoginToken` #### Path Parameters | Name | Type | Description | | -------- | ------- | ------------------------------------------------------------------------ | | event | integer | The event identifier for the contact to be logged in to | | contact | integer | The contact identifier to allow the login | | referrer | string | Referrer of the request which will be used in validating the token later | {% tabs %} {% tab title="200 " %} ``` { "token":"fc877d1bae56ebc5a8e19b29a3df67de", "loginUrl":"http://wired.ivvy.com/event/SQ6EXR/registration/login/token?t=fc877d1bae56ebc5a8e19b29a3df67de&contact=297466" } ``` {% endtab %} {% endtabs %} ## Example Request `Example: Request a login token for a contact on an event` ```javascript { "event":15593, "contact":297466 } ``` ## Description Creates a login token that can be used to login to an event, on the behalf of a registered contact. This call takes an event identifier and a contact identifier and an optional referrer url to generate a single-use, time restricted token. The result will be the token and a URL that can be used to redirect the user to have them logged in to view their registration details without the use of a username and password. If the referrer is provided when creating the token, the browser’s referrer header will also be checked to ensure the request using the token has been redirected from the specific website saved against the token. ## Returns | Property | Description | | -------- | ------------------------------------------------------------------------------------ | | token | Single use, time restricted token for the contact to login to the iVvy Event Website | | loginUrl | The URL that must be used to authenticate the user with the token | ## Throws | Code | Description | | -------------------- | ------------------------ | | Specific Code: 24099 | Unable to generate token | | Specific Code: 24098 | Unable to find event | # Venue The venue namespace is the used for the Venue Management software that is used by hotels, venues, and restaurants to manage Bookings for Group Food & Beverage, Meetings Space, Group Accommodation and Audio Visual. Typical use cases for this API include: * **Point of Sale** - Allow POS systems to post adhoc charges on the day of the event into iVvy in order to produce a final invoice and accurately report on the revenue for the booking. * **Restaurant Bookings** - Allow iVvy to place group bookings into the dining booking tool to ensure that as group bookings are made the capacity for dining bookings is adjusted. Additionally, display run sheet for the floor staff. * **Property Management Systems** - Allow iVvy to push group accommodation blocks into the PMS, and then place reservations into those blocks. * **Venue Signage** - Pull booking information on the day of the event to populate signage tools. Note: iVvy has an XML feed which may be an alternative for this uses case. ## Namespace ``` venue ``` # Venue Setup Data # Get Venue `POST` `[PlatformAddress]/api/1.0/venue?action=getVenue` Get the details to a specific venue to which the user has access #### Request Body | Name | Type | Description | | ---- | ------- | ------------ | | id | integer | The venue Id | {% tabs %} {% tab title="200 " %} ``` { "id": 1, "hashId": "925a1e841805031a06e4586828257520", "businessName": "Peppers Soul Surfers Paradise Tax Exclusive", "businessNumber": "", "venueIdentifier": "Identifier", "phone": "0123456789", "fax": "", "websiteAddress": "", "emailAddress": "test@email.com", "description": "

Description

\n", "checkinTime": null, "checkoutTime": null, "childAge": 0, "infantAge": 0, "currencyCode": "AUD", "localeCode": "en_AU", "timezone": "Pacific/Midway", "hasSpaces": true, "hasAccommodation": true, "numMeetingRooms": 10, "numAccommodationRooms": 50, "maxSpaceArea": 100, "totalSpaceArea": 1000, "longitude": "-79.3763095", "latitude": "43.6460143", "primaryAddress": { "line1": "8 The Esplanade", "line2": "", "line3": "", "line4": "", "city": "Varsity Lake", "stateCode": "QLD", "stateName": null, "countryCode": "AU", "countryName": null, "postalCode": "4227" }, "isTaxExclusive": true, "hasDistributionChannel": false, "allowsLiveBook": true, "instantBookUrl": "https://www.ivvy.com.au/venue/order/start?v=925a1e841805031a06e4586828257520", "availability": { "2024-01-01": { "isAvailable": false }, "2024-01-02": { "isAvailable": false }, "2024-01-03": { "isAvailable": false } }, "createdDate": "2017-12-18 12:11:45 UTC", "modifiedDate": "2025-04-29 04:11:57 UTC", "lastModifiedDate": "2025-04-30 03:57:21 UTC", "videoUrls": [ "asdasd", "test" ], "airportName": "", "airportDistance": "11", "starRating": 6.5, "ratingAuthority": 1, "maxSpaceCapacity": 100, "facilities": [ 2, 1, 3, 6, 7, 9, 12, 13, 15, 36, 19 ], "mainImage": { "url": "https://s3-ap-southeast-2.amazonaws.com/development.accounts.ivvy.com/account2/venues/1/102482716866e7885c6c38b.jpg", "originalFileName": "4258468533.jpg", "tags": [], "size": 149613, "contentType": "image/jpeg" }, "marketplaceBannerImage": null, "brochureFile": null, "imageLibrary": [], "packages": [ { "id": 1, "name": "Standard with Accomm", "minPax": 1, "price": 500, "priceMethod": 1, "smallDescription": "Standard", "largeDescription": "

Standard

\n", "marketplaceName": "Standard", "marketplaceEventTypes": null }, { "id": 4, "name": "Premium", "minPax": 1, "price": 100, "priceMethod": 1, "smallDescription": "sdsd", "largeDescription": null, "marketplaceName": "Premium", "marketplaceEventTypes": null } ], "functionSpaces": [ { "id": 3, "name": "Space", "description": null, "area": null, "length": null, "width": null, "heightMaximum": null, "heightMinimum": null, "floorPressureMaximum": null, "marketplaceName": "PRO - The Salon (Space 1)", "marketplaceEventTypes": null, "minPax": 1, "maxPax": 10, "hasLayouts": true, "image": { "url": "https://s3-ap-southeast-2.amazonaws.com/development.accounts.ivvy.com/account2/venues/1/spaces/3/617f6ad3b0bde.png", "originalFileName": "standard_decade.png", "tags": [], "size": 7051, "contentType": "image/png" }, "layouts": [ { "id": 5, "type": 1, "paxMinimum": null, "paxMaximum": null, "timeForSetup": 0, "timeForTakedown": 0 } ] } ], "accommodation": [ { "id": 6, "code": "2-6", "name": "Ocean King Room (Conference Centre)", "description": "

room one desc

\n", "numStandardAdults": 2, "numExtraAdults": 1, "extraAdultCost": 13, "canSmoke": false, "capacity": 200, "marketplaceName": "Room 1", "image": { "url": "https://s3-ap-southeast-2.amazonaws.com/development.accounts.ivvy.com/account2/venues/1/accommodation/6/5d92b47f1925e.jpg", "originalFileName": "55b97e5479c87.jpg", "tags": [], "size": 133133, "contentType": "image/jpeg" } } ], "menus": [ { "id": 1, "name": "Lunch", "marketplaceName": "Lunch", "smallDescription": "Description", "menuTypeCategory": 0, "image": null, "minimumPax": null, "maximumPax": null, "marketplaceCategories": [ 3 ], "currentStatus": 1, "activePeriodStart": { "month": 1, "date": 2 }, "activePeriodEnd": null }, { "id": 13, "name": "Total of all & items", "marketplaceName": "Lunch", "smallDescription": "Description", "menuTypeCategory": 0, "image": null, "minimumPax": null, "maximumPax": null, "marketplaceCategories": [ 3 ], "currentStatus": 1, "activePeriodStart": null, "activePeriodEnd": null } ], "beveragePackages": [ { "id": 33, "name": "Hourly Price - Complimentary house cocktail on arrival", "marketplaceName": "Hourly Price", "smallDescription": "Morning maza", "minPax": 0, "maxPax": 0, "marketplaceCategories": [ 2 ], "currentStatus": 1, "activePeriodStart": null, "activePeriodEnd": null }, { "id": 7, "name": "Per Person - 30 Minute Pre-dinner Beverages", "marketplaceName": null, "smallDescription": "Per Person", "minPax": 0, "maxPax": 0, "marketplaceCategories": [], "currentStatus": 1, "activePeriodStart": null, "activePeriodEnd": null } ], "reviews": [], "accommodationSetting": { "enableMultiOccupancy": true }, "cateringWebsitePrimaryColour": "#ae1e1e", "cateringWebsiteLogoId": "1819", "cateringWebsiteLogo": { "id": 1819, "accountId": 2, "originalFileName": "standard_hour.png", "size": 5929, "contentType": "image/png", "url": "https://s3-ap-southeast-2.amazonaws.com/development.accounts.ivvy.com/account2/venues/1/6180b0108fe0f.png" }, "cateringWebsiteBannerId": "1820", "cateringWebsiteBanner": { "id": 1820, "accountId": 2, "originalFileName": "standard_day_meridian.png", "size": 7204, "contentType": "image/png", "url": "https://s3-ap-southeast-2.amazonaws.com/development.accounts.ivvy.com/account2/venues/1/6180b017aea26.png" } } ``` {% endtab %} {% endtabs %} ### Example Request `Get a specific venue` ```javascript { "id":21 } ``` ### Returns | Property | Type | Description | | ---------------------------- | ------------------------------------------------------------- | ---------------------------------------------------------- | | id | integer | The unique identifier for the venue. | | hashId | string | The unique hash identifier for the venue. | | businessName | string | The name of the venue. | | businessNumber | string | The business number of the venue. | | venueIdentifier | string | Available within reports and API to complement Venue Name. | | phone | string | The contact phone number of the venue. | | fax | string | The fax number of the venue. | | websiteAddress | string | The website address of the venue. | | emailAddress | string | The email address of the venue. | | description | string | The description of the venue. | | checkinTime | string | The check-in time for accommodation. | | checkoutTime | string | The check-out time for accommodation. | | childAge | integer | The age of a child for the venue. | | infantAge | integer | The age of an infant for the venue. | | currencyCode | string | The currency code of the venue. | | localeCode | string | The locale code of the venue. | | timezone | string | The timezone of the venue. | | hasSpaces | boolean | If the venue has spaces. | | hasAccommodation | boolean | If the venue has accommodation. | | numMeetingRooms | integer | The number of meeting rooms in the venue. | | numAccommodationRooms | integer | The number of accommodation rooms in the venue. | | maxSpaceArea | integer | The maximum area of the largest space in the venue. | | totalSpaceArea | integer | The total area of all spaces in the venue. | | longitude | float | The longitude of the venue. | | latitude | float | The latitude of the venue. | | primaryAddress | object of [Address](/venues/venuedata/get-venue-list#address) | The primary address of the venue. | | isTaxExclusive | boolean | If the venue is tax exclusive. | | hasDistributionChannel | boolean | Whether or not the venue has a distribution channel. | | allowsLiveBook | boolean | If the venue allows live booking. | | instantBookUrl | string | The URL for instant booking. | | availability | object | The availability details of the venue. | | createdDate | string | The date when the venue was created. | | modifiedDate | string | The date when the venue was last modified. | | lastModifiedDate | string | The date of last modification. | | videoUrls | array of string | The list of video URLs for the venue. | | airportName | string | The name of the nearest airport. | | airportDistance | string | The distance from the nearest airport. | | starRating | float | The star rating of the venue. | | ratingAuthority | integer | The rating authority of the venue. | | maxSpaceCapacity | integer | The maximum space capacity of the venue. | | facilities | array of integer | The list of facility IDs for the venue. | | mainImage | object of [file](#file) | The main image details of the venue. | | marketplaceBannerImage | object of [file](#file) | The marketplace banner image details of the venue. | | brochureFile | object of [file](#file) | The brochure file details of the venue. | | imageLibrary | array of [file](#file) | The list of image library items. | | packages | array of [package](#package) | The list of venue packages. | | functionSpaces | array of [functionSpace](#functionspace) | The list of function spaces. | | accommodation | array of [accommodation](#accommodation) | The list of accommodation rooms. | | menus | array of [menu](#menu) | The list of menus. | | beveragePackages | array of [beveragePackage](#beveragepackage) | The list of beverage packages. | | reviews | array | The list of reviews. | | accommodationSetting | object of [accommodationSetting](#accommodationsetting) | The accommodation settings. | | cateringWebsitePrimaryColour | string | The primary color for the catering website. | | cateringWebsiteLogoId | integer | The ID of the catering website logo. | | cateringWebsiteLogo | object of [file](#file) | The catering website logo details. | | cateringWebsiteBannerId | integer | The ID of the catering website banner. | | cateringWebsiteBanner | object of [file](#file) | The catering website banner details. | | businessNumber | integer | The business number of the venue. | | phone | string | The phone number of the venue. | | fax | string | The fax number of the venue. | | websiteAddress | string | The website address of the venue. | | emailAddress | string | The email address of the venue. | | description | string | The description of the venue. | | checkinTime | string | The checkin time of the venue. | | checkoutTime | string | The checkout time of the venue. | | childAge | integer | The age of a child for the venue. | | infantAge | integer | The age of an infant for the venue. | | currencyCode | string | The currency code of the venue. | | localeCode | string | The locale code of the venue. | | timezone | string | The timezone of the venue. | | hasSpaces | boolean | If the venue has spaces. | | hasAccommodation | boolean | If the venue has accommodation. | | numMeetingRooms | integer | The number of meeting rooms in the venue. | | numAccommodationRooms | integer | The number of accommodation rooms in the venue. | | maxSpaceArea | integer | The maximum area of the largest space in the venue. | | totalSpaceArea | integer | The total area of all spaces in the venue. | | longitude | float | The longitude of the venue. | | latitude | float | The latitude of the venue. | | primaryAddress | object of [address](#address) | The primary address of the venue. | | isTaxExclusive | boolean | If the venue is tax exclusive. | ### address | Property | Type | Description | | ----------- | ------ | -------------------------------- | | line1 | string | The first line of the address. | | line2 | string | The second line of the address. | | line3 | string | The third line of the address. | | line4 | string | The fourth line of the address. | | city | string | The city of the address. | | stateCode | string | The state code of the address. | | stateName | string | The state name of the address. | | countryCode | string | The country code of the address. | | countryName | string | The country name of the address. | | postalCode | string | The postal code of the address. | ### package | Property | Type | Description | | --------------------- | ------- | --------------------------------------------- | | id | integer | The unique identifier for the package. | | name | string | The name of the package. | | minPax | integer | The minimum number of people for the package. | | price | float | The price of the package. | | priceMethod | integer | The price method for the package. | | smallDescription | string | The small description of the package. | | largeDescription | string | The large description of the package. | | marketplaceName | string | The marketplace name of the package. | | marketplaceEventTypes | array | The event types of the package. | ### functionSpace | Property | Type | Description | | -------------------- | -------------------------- | ------------------------------------------------------------------------------------------ | | id | integer | The unique identifier for the function space. | | name | string | The name of the function space. | | description | string | The description of the function space. | | area | integer | The area of the function space. | | length | float | The length of the function space. | | width | float | The width of the function space. | | heightMaximum | float | The maximum height of the function space. | | heightMinimum | float | The minimum height of the function space. | | floorPressureMaximum | float | The maximum floor pressure of the function space. | | floorPressureMinimum | float | The minimum floor pressure of the function space. | | marketplaceName | string | The marketplace name of the function space. | | minPax | integer | The minimum number of people allowed within a single session to order this function space. | | maxPax | integer | The maximum number of people allowed within a single session to order this function space. | | hasLayouts | boolean | If the function space has layouts. | | image | object of [file](#file) | The image of the function space. | | layouts | array of [layout](#layout) | The list of layouts for the function space. | ### layout | Property | Type | Description | | --------------- | ----------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | | id | integer | The unique identifier for the layout. | | type | integer | The type of the layout. 1 = Theatre, 2 = Classroom, 3 = U-Shape, 4 = Cabaret, 5 = Boardroom, 6 = Banquet, 7 = Cocktail, 8 = Hollow Square, 9 = Exhibition | | name | string | The name of the layout. | | description | string | The description of the layout. | | image | object of [file](#file) | The image of the layout. | | paxMinimum | integer | The minimum number of people allowed for the layout. | | paxMaximum | integer | The maximum number of people allowed for the layout. | | timeForSetup | integer | The time for setup of the layout. | | timeForTakedown | integer | The time for takedown of the layout. | ### file | Property | Type | Description | | ---------------- | ------- | ----------------------------- | | url | string | The url of the file. | | originalFileName | string | The original file name. | | tags | array | The tags of the file. | | size | integer | The size of the file. | | contentType | string | The content type of the file. | ### accommodation | Property | Type | Description | | ----------------- | ----------------------- | --------------------------------------------------- | | id | integer | The unique identifier for the accommodation. | | code | string | The code of the accommodation. | | name | string | The name of the accommodation. | | description | string | The description of the accommodation. | | numStandardAdults | integer | The number of standard adults in the accommodation. | | numExtraAdults | integer | The number of extra adults in the accommodation. | | extraAdultCost | float | The cost of an extra adult in the accommodation. | | canSmoke | boolean | If smoking is allowed in the accommodation. | | capacity | integer | The capacity of the accommodation. | | marketplaceName | string | The marketplace name of the accommodation. | | image | object of [file](#file) | The image of the accommodation. | ### menu | Property | Type | Description | | --------------------- | --------------------------------------- | ------------------------------------------ | | id | integer | The unique identifier for the menu. | | name | string | The name of the menu. | | marketplaceName | string | The marketplace name of the menu. | | smallDescription | string | The small description of the menu. | | menuTypeCategory | integer | The category of the menu type. | | image | object of [file](#file) | The image of the menu. | | minimumPax | integer | The minimum number of people for the menu. | | maximumPax | integer | The maximum number of people for the menu. | | marketplaceCategories | array | The categories of the menu. | | currentStatus | integer | The status of the menu. | | activePeriodStart | object of [activePeriod](#activeperiod) | The start period when the menu is active. | | activePeriodEnd | object of [activePeriod](#activeperiod) | The end period when the menu is active. | ### activePeriod | Property | Type | Description | | -------- | ------- | ------------------------ | | month | integer | The month of the period. | | date | integer | The date of the period. | ### beveragePackage \| Property | Type | Description | | Property | Type | Description | | --------------------- | --------------------------------------- | ------------------------------------------------------ | | id | integer | The unique identifier for the beverage package. | | name | string | The name of the beverage package. | | marketplaceName | string | The marketplace name of the beverage package. | | smallDescription | string | The small description of the beverage package. | | minimumPax | integer | The minimum number of people for the beverage package. | | maximumPax | integer | The maximum number of people for the beverage package. | | marketplaceCategories | array | The categories of the beverage package. | | currentStatus | integer | The status of the beverage package. | | activePeriodStart | object of [activePeriod](#activeperiod) | The start period when the beverage package is active. | | activePeriodEnd | object of [activePeriod](#activeperiod) | The end period when the beverage package is active. | ### accommodationSetting | Property | Type | Description | | -------------------- | ------- | ------------------------------------------------------- | | enableMultiOccupancy | boolean | If the accommodation setting allows multiple occupancy. | ### ratingAuthority One of the following values: * 1 = AAA rated * 2 = Self rated ### facilities An array of the following values: * 1 = Air Conditioning * 2 = Airport Shuttle * 3 = Audio Visual * 4 = BBQ * 6 = Business Centre * 7 = Ceremony On Site * 8 = Child Minding * 9 = Disabled Access * 10 = Dry Cleaning * 11 = Express Checkout * 12 = Free Parking * 13 = Gaming Area * 14 = Gymnasium * 15 = Internet Access * 16 = Laundry * 39 = Liquor License * 17 = Mobile Bar * 18 = Open 24 Hours * 19 = Outdoor Area * 20 = Parking Available * 21 = Pay TV * 22 = Playground * 23 = Printing Services * 24 = Public Transport * 25 = Restaurant On Site * 26 = Sauna Steam Room * 27 = Smoking Permitted * 28 = Spa * 29 = Staging * 30 = Street Parking * 31 = Swimming Pool * 32 = Tour Desk * 33 = Undercover Parking * 34 = Valet Parking * 35 = Wheelchair Access * 36 = Wifi Access * 37 = Outside Catering Allowed * 38 = BYO Allowed ### priceMethod (package pricing) One of the following values: * 1 = Per person * 2 = Flat rate ### type (function space layout) One of the following values: * 0 = Custom * 1 = Theatre * 2 = Classroom * 3 = U-Shape * 4 = Cabaret * 5 = Boardroom * 6 = Banquet * 7 = Cocktail * 8 = Hollow Square ### marketplaceEventTypes Packages, function spaces and image library file for the marketplaceEventType. An array of the following values: * 11 = Event * 21 = Wedding * 31 = Conference * 41 = Meeting # Get Venue List `POST` `[PlatformAddress]/api/1.0/venue?action=getVenueList` Get a list of venues. {% tabs %} {% tab title="200 " %} ``` { "meta": { "totalResults": 19, "start": 0, "perPage": 2, "count": 2 }, "results": [ { "id": 21, "hashId": "1efda3e35a75aabd13e8996037d35a79", "businessName": "iVvy Conference Centre", "businessNumber": 1231235, "venueIdentifier": "Identifier", "phone": "1300 004 889", "fax": "", "websiteAddress": "www.ivvy.com", "emailAddress": "support@ivvy.com", "description": "

Located by the River at Hamilton, this is the closest 5.5 star, full service Hotel to the Brisbane Cruise Terminal - Portside at Hamilton, the Airport precinct, Gateway Arterial Bridge linking the Gold Coast to the Sunshine Coast and is just minutes from the CBD.

Featuring 90 spacious, newly refurbished and well appointed accommodation rooms, the hotel is an urban escape perfect for business or leisure travellers alike. Most rooms feature magnificent views of the widest reach of the Brisbane River spanning from the Brisbane City past the Brisbane Cruise Terminal and to the Gateway Bridge.

Enjoy the resort style pool, spa, sauna, gym and complimentary car parking & Wi-Fi for all delegates, guests and visitors.

From the grandeur of the column free Hamilton Ballroom which can easily divide into smaller configurations, the intimacy of the Newstead Room or take advantage of the newly refurbished Executive Boardroom the Brisbane Riverview Hotel has an option to suit your budget and requirements. The resort style pool area is a fantastic venue for breakout sessions or lunches. This is a flexible and well equipped conference venue can cater for intimte boardroom meeting of 6 people up to large corporate events for up to 300 delegates.

With expansive river views, Plates Restaurant offers a seasonal menu showcasing superb produce from Queensland’s freshest seafood, international cuisine, and wood fired steaks and pizzas. It is the perfect place for business or pleasure, mixing excellent atmosphere with great service.

", "checkinTime": "11:00:00", "checkoutTime": "14:00:00", "childAge": 0, "infantAge": 0, "currencyCode": "AUD", "localeCode": "en_AU", "timezone": "Australia/Brisbane", "hasSpaces": true, "hasAccommodation": true, "numMeetingRooms": 20, "numAccommodationRooms": 500, "maxSpaceArea": null, "totalSpaceArea": null, "longitude": "153.4086914", "latitude": "-28.0793739", "primaryAddress": { "line1": "1 Bellvue Drive", "line2": "", "line3": "", "line4": "", "city": "Varsity Lakes", "stateCode": "QLD", "stateName": null, "countryCode": "AU", "countryName": null, "postalCode": 4227 }, "isTaxExclusive": false, "hasDistributionChannel": false }, { "id": 37, "hashId": "5c7264a5dd3525690bb134bd9480ffcd", "businessName": "IvVy HQ", "businessNumber": 12345789, "phone": "1300 399 399", "fax": "(+617) 5657 4499", "websiteAddress": "", "emailAddress": null, "description": null, "checkinTime": null, "checkoutTime": null, "childAge": 0, "infantAge": 0, "currencyCode": "AUD", "localeCode": "en_AU", "timezone": "Australia/Brisbane", "hasSpaces": true, "hasAccommodation": true, "numMeetingRooms": 0, "numAccommodationRooms": 0, "maxSpaceArea": null, "totalSpaceArea": null, "longitude": "153.409881", "latitude": "-28.079096", "primaryAddress": { "line1": "244EZU5W", "line2": "55K0CD6Z", "line3": "9UQSFQJB", "line4": "7UA0P52H", "city": "49NE250N", "stateCode": "QLD", "stateName": null, "countryCode": "AU", "countryName": null, "postalCode": "8CBLZE9Y" }, "isTaxExclusive": false, "hasDistributionChannel": false } ] } ``` {% endtab %} {% endtabs %} ### Returns `A collection object with the following properties in the results` | Property | Type | Description | | ---------------------- | ----------------------------- | ---------------------------------------------------------- | | id | integer | The unique identifier for the venue. | | hashId | string | The unique hash identifier for the venue. | | businessName | string | The name of the venue. | | businessNumber | integer | The business number of the venue. | | venueIdentifier | string | Available within reports and API to complement Venue Name. | | phone | string | The phone number of the venue. | | fax | string | The fax number of the venue. | | websiteAddress | string | The website address of the venue. | | emailAddress | string | The email address of the venue. | | description | string | The description of the venue. | | checkinTime | string | The checkin time of the venue. | | checkoutTime | string | The checkout time of the venue. | | childAge | integer | The age of a child for the venue. | | infantAge | integer | The age of an infant for the venue. | | currencyCode | string | The currency code of the venue. | | localeCode | string | The locale code of the venue. | | timezone | string | The timezone of the venue. | | hasSpaces | boolean | If the venue has spaces. | | hasAccommodation | boolean | If the venue has accommodation. | | numMeetingRooms | integer | The number of meeting rooms in the venue. | | numAccommodationRooms | integer | The number of accommodation rooms in the venue. | | maxSpaceArea | integer | The maximum area of the largest space in the venue. | | totalSpaceArea | integer | The total area of all spaces in the venue. | | longitude | float | The longitude of the venue. | | latitude | float | The latitude of the venue. | | primaryAddress | object of [Address](#address) | The primary address of the venue. | | isTaxExclusive | boolean | If the venue is tax exclusive. | | hasDistributionChannel | boolean | Whether or not the venue has a distribution channel. | ### Address | Property | Type | Description | | ----------- | ------ | -------------------------------- | | line1 | string | The first line of the address. | | line2 | string | The second line of the address. | | line3 | string | The third line of the address. | | line4 | string | The fourth line of the address. | | city | string | The city of the address. | | stateCode | string | The state code of the address. | | stateName | string | The state name of the address. | | countryCode | string | The country code of the address. | | countryName | string | The country name of the address. | | postalCode | string | The postal code of the address. | The result from this call will be a [collection](/getting-started/interpreting-the-response/collections) of all the events the user has access to. This call also accepts the [pagination](/getting-started/interpreting-the-response/pagination) and [filter](/getting-started/interpreting-the-response/filtering) properties. # Get Venue Room List `POST` `[PlatformAddress]/api/1.0/venue?action=getVenueRoomList` #### Request Body | Name | Type | Description | | ------- | ------- | ------------------- | | venueId | integer | The id of the venue | {% tabs %} {% tab title="200 " %} ``` { "meta": { "totalResults": 1, "start": 0, "perPage": null, "count": 1 }, "results": [ { "id": 1, "code": "2-1", "name": "Family RoomFamily", "description": "

The best family rooms:

  • One double bed
  • Two child beds
  • Sitting area
  • Balcony
", "numStandardAdults": 2, "numExtraAdults": 1, "extraAdultCost": 100, "canSmoke": false, "capacity": 10, "marketplaceName": null } ] } ``` {% endtab %} {% endtabs %} The result from this call will be a [collection](/getting-started/interpreting-the-response/collections) of all the events the user has access to. This call also accepts the [pagination](/getting-started/interpreting-the-response/pagination) and [filter](/getting-started/interpreting-the-response/filtering) properties. The venueId is required, for example {"venuId":10} ### Example Request `Get a specific Venue’s Room List` ```javascript { "venueId": 1 } ``` # Get Venue Room Rates `POST` `[PlatformAddress]/api/1.0/venue?action=getRoomRates` Return the room rates for the given rate plan and date and optionally provided room ids. #### Request Body | Name | Type | Description | | ------------------------------------------- | ------- | ----------------------------------------------------- | | venueId\* | integer | The unique id of the venue to which the room belongs. | | barId\* | integer | The unique id of the rate plan. | | startDate\* | date | The start date of the rate. | | endDate\* | date | The end date of the rate. | | roomIds | array | The room ids to filter the rates. | {% tabs %} {% tab title="200 " %} ```json { "meta": { "totalResults": 4, "start": 0, "perPage": 4, "count": 4 }, "results": [ { "barId": 63, "roomId": 122, "date": "2025-07-06", "cost": null, "costDouble": null, "costTriple": null, "costQuad": null }, { "barId": 63, "roomId": 123, "date": "2025-07-06", "cost": 50, "costDouble": 60, "costTriple": 0, "costQuad": 80 }, { "barId": 63, "roomId": 122, "date": "2025-07-07", "cost": null, "costDouble": null, "costTriple": null, "costQuad": null }, { "barId": 63, "roomId": 123, "date": "2025-07-07", "cost": 5, "costDouble": 6, "costTriple": 7, "costQuad": 0 } ] } ``` {% endtab %} {% endtabs %} ### Date Range Restrictions * **startDate and endDate**: The maximum date range is 31 days. Past dates are not allowed. ### Returns A collection object with the following properties in result | Property | Data Type | Description | | ---------- | --------- | --------------------------------------------------------- | | barId | integer | The unique id of the rate plan | | date | date | The date of the inventory | | roomId | integer | The unique id of the room | | cost | float | The cost of the room for a given day for single occupancy | | costDouble | float | The cost of the room for a given day for two occupants | | costTriple | float | The cost of the room for a given day for three occupants | | costQuad | float | The cost of the room for a given day for four occupants | # Get Venue Rate Plan Booking Rules `POST` `[PlatformAddress]/api/1.0/venue?action=getRatePlanBookingRules` Return the rate plan booking rules for the given date and optionally room ids. #### Request Body | Name | Type | Description | | ------------------------------------------- | ------- | --------------------------------------------------------- | | venueId\* | integer | The unique id of the venue to which the room belongs. | | startDate\* | date | The start date of the rate plan rule which it applies to. | | endDate\* | date | The end date of the rate plan rule which it applies to. | | roomIds | array | The room ids to filter the rate plan rule. | {% tabs %} {% tab title="200 " %} ```json { "meta": { "totalResults": 3, "start": 0, "perPage": 3, "count": 3 }, "results": [ { "barId": 1, "roomId": 6, "date": "2026-05-09", "closeOutStatus": 2 }, { "barId": 1, "roomId": 6, "date": "2026-05-10", "closeOutStatus": 2 }, { "barId": 1, "roomId": 6, "date": "2026-05-11", "closeOutStatus": null } ] } ``` {% endtab %} {% endtabs %} ### Date Range Restrictions * **startDate and endDate**: The maximum date range is 31 days. Past dates are not allowed. ### Returns A collection object with the following properties in result | Property | Data Type | Description | | -------------- | --------- | ------------------------------------------------------------ | | barId | string | The unique id of the rate plan | | date | date | The date of the rate plan rule which it applies to | | roomId | integer | The unique id of the room | | closeOutStatus | integer | The close out status of the rate plan rule on the given date | # Get Venue Room Inventory `POST` `[PlatformAddress]/api/1.0/venue?action=getRoomInventory` Return the inventory and available count for the given date and optionally provided room ids. #### Request Body | Name | Type | Description | | ------------------------------------------- | ------- | ----------------------------------------------------- | | venueId\* | integer | The unique id of the venue to which the room belongs. | | startDate\* | date | The start date of the inventory. | | endDate\* | date | The end date of the inventory. | | roomIds | array | The room ids to filter the inventory. | {% tabs %} {% tab title="200 " %} ```json { "meta": { "totalResults": 2, "start": 0, "perPage": 2, "count": 2 }, "results": [ { "date": "2025-12-16", "roomId": 7, "inventoryCount": 3, "availableCount": 3 }, { "date": "2025-12-16", "roomId": 2, "inventoryCount": 130, "availableCount": 130 }, ] } ``` {% endtab %} {% endtabs %} ### Date Range Restrictions * **startDate and endDate**: The maximum date range is 31 days. Past dates are not allowed. ### Returns A collection object with the following properties in result | Property | Data Type | Description | | -------------- | --------- | ---------------------------------------- | | date | date | The date of the inventory | | roomId | integer | The unique id of the room | | inventoryCount | integer | The total rooms | | availableCount | integer | The total available rooms after bookings | # Get Venue Room Option List `POST` `[PlatformAddress]/api/1.0/venue?action=getVenueRoomOptionList` Get a list of room options for a venue. #### Request Body | Name | Type | Description | | ------- | ------- | ----------------------------------------------------------------------------------------------------------------- | | venueId | integer | The unique id of the venue to which the room options belong | | start | integer | The starting result of the page. Note this is zero based (i.e. sending start=0 will start from the first result.) | | perPage | integer | The number of booking accomodation groups to fetch | {% tabs %} {% tab title="200 " %} ``` { "meta": { "totalResults": 2, "start": 0, "perPage": 100, "count": 2 }, "results": [ { "id": 1, "venueId": 1, "name": "Test Room Option 1", "description": "Test Room Option 1", "price": 100, "priceExcludedTaxIds": [1], "cost": 100, "costExcludedTaxIds": [1], "costcenterId": null, "createdDate": "2018-08-08 12:37:14 UTC", "modifiedDate": "2018-08-08 12:37:14 UTC" }, { "id": 2, "venueId": 1, "name": "Test Room Option 2", "description": "Test Room Option 2", "price": 100, "priceExcludedTaxIds": [1], "cost": 100, "costExcludedTaxIds": [1], "costcenterId": null, "createdDate": "2018-08-08 18:21:59 UTC", "modifiedDate": "2018-08-08 18:21:59 UTC" } ] } ``` {% endtab %} {% endtabs %} The result from this call will be a [collection](/getting-started/interpreting-the-response/collections) of room options the user has access to. This call also accepts the [pagination](/getting-started/interpreting-the-response/pagination) and [filter](/getting-started/interpreting-the-response/filtering) properties. ### Venue Room Option | Property | Type | Description | | ------------------- | ----------------- | ---------------------------------------------------------------------------------------------------------------------- | | id | integer | The unique id of the room option | | venueId | integer | The unique id of the venue to which the room option belongs | | name | string | The name of the room option (e.g. "Breakfast") | | description | string | The description of the room option. This can be html formatted text | | price | number | The sale price of the room option. The amount either includes or excludes tax depending on how the venue is configured | | priceExcludedTaxIds | array of integers | The unique ids of the taxes that are excluded from price | | cost | number | The cost of the room option. The amount either includes or excludes tax depending on how the venue is configured | | costExcludedTaxIds | array of integers | The unique ids of the taxes that are excluded from cost | | costcenterId | integer | The unique id of the cost center assigned to the room option | | createdDate | datetime | The date & time the room option was created | | modifiedDate | datetime | The date & time the room option was last modified | # Get Venue Rate Plan List `POST` `[PlatformAddress]/api/1.0/venue?action=getVenueRatePlanList` Get the rate plan for a specific venue. #### Request Body | Name | Type | Description | | ------- | ------- | ------------------- | | venueId | integer | The id of the venue | {% tabs %} {% tab title="200 " %} ``` { "meta": { "totalResults": 2, "start": 0, "perPage": null, "count": 2 }, "results": [ { "id": 1, "name": "Basic Rate Plan", "code": "2-1", "description": "

Basic Room Pan

" }, { "id": 2, "name": "Luxrious Plan", "code": "2-2", "description": "

This is bit good:) here  

" } ] } ``` {% endtab %} {% endtabs %} The result from this call will be a [collection](/getting-started/interpreting-the-response/collections) of all the events the user has access to. This call also accepts the [pagination](/getting-started/interpreting-the-response/pagination) and [filter](/getting-started/interpreting-the-response/filtering) properties. The venueId is required, for example {"venuId":10} ### Example Request `Get a specific Venue’s Rate Plan List` ```javascript { "venueId": 1 } ``` # Get Venue Rate Plan Rate List `POST` `[PlatformAddress]/api/1.0/venue?action=getRatePlanRateList` Get a list of menus. #### Request Body | Name | Type | Description | | ------- | ------- | ----------------------------------------------------- | | venueId | integer | The id of the venue | | barId | integer | The id of the rate plan | | perPage | integer | The number of rate plan rates to get in a single call | {% tabs %} {% tab title="200 " %} ``` { "meta": { "totalResults": 2, "start": 0, "perPage": 50, "count": 2 }, "results": [ { "id": 1, "barId": 1, "startDate": "2019-08-08", "endDate": "2022-04-23", "minAcceptableRate": 10, "daysOfWeek": [ 0, 1, 2, 3, 4, 5, 6 ] }, { "id": 4, "barId": 1, "startDate": "2023-04-24", "endDate": "2023-04-28", "minAcceptableRate": 50, "daysOfWeek": [ 0, 6 ] } ] } ``` {% endtab %} {% endtabs %} The result from this call will be a [collection](/getting-started/interpreting-the-response/collections) of all the rates the user has access to. This call also accepts the [pagination](/getting-started/interpreting-the-response/pagination) and [filter](/getting-started/interpreting-the-response/filtering) properties. ### Example Request ```javascript { "venueId": 1, "barId": 1 } ``` ### Rate Plan Rate | Property | Type | Description | | ----------------- | -------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------- | | id | integer | The unique id of the rate | | barId | integer | The unique id of the rate plan | | startDate | date | The start date of the rate | | endDate | date | The end date of the rate | | minAcceptableRate | integer | The minimum acceptable rate for room rate plan | | daysOfWeek | array of [Days](https://github.com/ivvycode/apidocs/blob/master/venues/venuedata/get-rate-plan-rate-list/README.md#days-of-week) | Days of the week where rate applies | ### Days of Week * 0 = Sunday * 1 = Monday * 2 = Tuesday * 3 = Wednesday * 4 = Thursday * 5 = Friday * 6 = Saturday # Get Venue Rate Plan Room Rate List `POST` `[PlatformAddress]/api/1.0/venue?action=getRoomRateList` Get a list of rate plan room rates. #### Request Body | Name | Type | Description | | ------------------------------------------- | ------- | ---------------------------- | | venueId\* | integer | The id of the venue | | barId\* | integer | The id of the rate plan | | barRateId\* | integer | The id of the rate plan rate | | roomId | integer | The id of the room | {% tabs %} {% tab title="200 " %} ``` { "meta": { "totalResults": 3, "start": 0, "perPage": 3, "count": 3 }, "results": [ { "id": 1, "barId": 1, "barRateId": 1, "roomId": 1, "cost": 55, "costDouble": null, "costTriple": null, "costQuad": null, "costExcludedTaxIds": [], "actualCost": 45, "actualCostDouble": null, "actualCostTriple": null, "actualCostQuad": null, "actualCostExcludedTaxIds": [] }, { "id": 2, "barId": 1, "barRateId": 1, "roomId": 22, "cost": 50, "costDouble": null, "costTriple": null, "costQuad": null, "costExcludedTaxIds": [], "actualCost": 45, "actualCostDouble": null, "actualCostTriple": null, "actualCostQuad": null, "actualCostExcludedTaxIds": [] }, { "id": 3, "barId": 1, "barRateId": 1, "roomId": 23, "cost": 50, "costDouble": 70, "costTriple": 0, "costQuad": 0, "costExcludedTaxIds": [], "actualCost": 0, "actualCostDouble": 0, "actualCostTriple": 0, "actualCostQuad": 0, "actualCostExcludedTaxIds": [] } ] } ``` {% endtab %} {% endtabs %} The result from this call will be a [collection](/getting-started/interpreting-the-response/collections) of all the room rates the user has access to. it does not accept [pagination](/getting-started/interpreting-the-response/pagination) or [filter](/getting-started/interpreting-the-response/filtering) properties. ### Example Request ```javascript { "venueId": 1, "barId": 1, "barRateId": 1, } ``` ### Rate Plan Room Rate | Property | Type | Description | | ------------------------ | ------- | --------------------------------------------------------------------------------------------- | | id | integer | The unique id of the room rate | | barId | integer | The unique id of the rate plan | | barRateId | integer | The unique id of the rate plan rate | | roomId | integer | The unique id of the room | | cost | double | The sale price of the room rate. Represents single occupancy when multi occupancy is enabled. | | costDouble | double | The sale price of the room rate for double occupancy | | costTriple | double | The sale price of the room rate for triple occupancy | | costQuad | double | The sale price of the room rate for quad occupancy | | costExcludedTaxIds | array | The excluded tax identifiers of the sale price | | actualCost | double | The cost of the room rate. Represents single occupancy when multi occupancy is enabled. | | actualCostDouble | double | The cost of the room rate for double occupancy | | actualCostTriple | double | The cost of the room rate for triple occupancy | | actualCostQuad | double | The cost of the room rate for quad occupancy | | actualCostExcludedTaxIds | array | The excluded tax identifiers of the cost | # Get Resource List `POST` `[PlatformAddress]/api/1.0/venue?action=getResourceList` Return the venue resource list for the venue. #### Request Body | Name | Type | Description | | ------- | ------- | ------------------- | | venueId | integer | The id of the venue | {% tabs %} {% tab title="200 " %} ``` { "meta": { "totalResults": 2, "start": 0, "perPage": 100, "count": 2 }, "results": [ { "id": 3, "venueId": 1, "name": "Resource 1", "code": "", "categoryId": 1, "shortDescription": "", "longDescription": null, "quantity": 12, "canBookByHour": true, "hourlyCost": 0, "dailyCost": 10, "isRestrictedToSpaces": true, "hasSubResources": false, "costcenterId": 3, "isViewable": true, "createdDate": "2017-12-20 11:09:38 UTC", "modifiedDate": "2020-11-10 06:51:47 UTC" }, { "id": 24, "venueId": 1, "name": "Resource 2", "code": "", "categoryId": 1, "shortDescription": "", "longDescription": null, "quantity": null, "canBookByHour": true, "hourlyCost": 0, "dailyCost": 0, "isRestrictedToSpaces": true, "hasSubResources": true, "costcenterId": 3, "isViewable": true, "createdDate": "2020-11-10 06:59:29 UTC", "modifiedDate": "2020-11-10 06:59:29 UTC" } ] } ``` {% endtab %} {% endtabs %} ### Example Request `Get Venues Resource List` ```javascript { "venueId": 2 } ``` ### Returns `A collection object with the following properties in the results` | Property | Description | | ------------------------ | ------------------------------------------------------ | | id | The unique invoice identifier | | venueId | The id of the venue to which the resource belongs | | name | The name of the resource | | code | The code of the resource | | categoryId | The category of the resource | | shortDescription | The short description of the resource | | longDescription | The long description of the resource | | quantity | The quantity of the resource | | canBookByHour | Whether or not the resource can be booked by hour | | hourlyCost | Hourly cost of the resource | | hourlyCostExcludedTaxIds | Details of taxes | | dailyCost | Daily cost of the resource | | dailyCostExcludedTaxIds | Details of taxes | | isRestrictedToSpaces | Whether or not this resource is restricted to spaces | | hasSubResources | Whether or not this resource has sub resources | | subResourceIds | ids of sub resources | | costcenterId | The costcenter id of the resource | | isViewable | Whether or not the resource is viewable on marketplace | | createdDate | The date & time the resource was created | | modifiedDate | The date & time the resource was last modified | # Get Resource Availability `POST` `[PlatformAddress]/api/1.0/venue?action=getResourceAvailability` Return the availability for resources. #### Request Body | Name | Type | Description | | --------------------------------------------- | ------- | ------------------------------------------------------------------------------------- | | venueId\* | integer | The id of the venue | | startDate\* | date | The start date of the period from which to include the resource availability details. | | endDate\* | date | The end date of the period from which to include the resource availability details. | | resourceIds\* | array | The end date of the period from which to include the resource availability details. | | quantity | integer | Specifies the quantity to check for resource availability. | {% tabs %} {% tab title="200 " %} ``` { "meta": { "totalResults": 2, "start": 0, "perPage": 100, "count": 2 }, "results": [ { "id": 1, "unAvailableTimes": [ { "startDate": "2021-06-24 00:00:00", "endDate": "2021-06-24 23:59:00", "quantity": 10 } ], "isAvailable": true, "conflict": null }, { "id": 25, "unAvailableTimes": [ { "startDate": "2021-06-24 00:00:00", "endDate": "2021-06-24 23:59:00", "quantity": 10 } ], "isAvailable": false, "conflict": { "venueId": 1, "bookingId": 20815, "sessionId": 11544, "spaceId": 288, "resourceId": 25, "startDate": "2021-06-24 00:00:00", "endDate": "2021-06-24 23:59:00", "quantity": 10 } } ] } ``` {% endtab %} {% endtabs %} ### Example Request `Get Resource Availability` ```javascript { "venueId": 1, "startDate": "2021-06-24 00:00:00", "endDate": "2021-06-25 00:00:00", "resourceIds": [1, 25], "quantity": 10 } ``` ### Returns `A collection object with the following properties in the results` | Property | Description | | ---------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | | id | The unique resource identifier | | unAvailableTimes | The reserved date time ranges for resource with quantity | | isAvailble | Whether or not resource is available for given time range and quantity. (Only when request contains quantity) | | conflict | If resource is not available (i.e. isAvailable to false), then it gives conflicted session details (Only when request contains quantity) | # Get Menu List `POST` `[PlatformAddress]/api/1.0/venue?action=getMenuList` Get a list of menus. #### Request Body | Name | Type | Description | | ------- | ------- | ------------------------------------------ | | venueId | integer | The id of the venue | | perPage | integer | The number of menu to get in a single call | {% tabs %} {% tab title="200 " %} ``` { "meta": { "totalResults": 5, "start": 0, "perPage": 50, "count": 2 }, "results": [ { "id": 125, "menuTypeCategory": 0, "name": "Menu 1", "minimumPax": 20, "maximumPax": 30, "cost": 98, "costType": 1, "smallDescription": "small description", "marketplaceName": "Marketplace Name 1", "marketplaceCategories": [] }, { "id": 125, "menuTypeCategory": 1, "name": "Menu 2", "minimumPax": 10, "maximumPax": 30, "cost": 198, "costType": 2, "smallDescription": "small description", "marketplaceName": "Marketplace Name 2", "marketplaceCategories": [3] } ] } ``` {% endtab %} {% endtabs %} The result from this call will be a [collection](/getting-started/interpreting-the-response/collections) of all the menus the user has access to. This call also accepts the [pagination](/getting-started/interpreting-the-response/pagination) and [filter](/getting-started/interpreting-the-response/filtering) properties. ### Example Request ```javascript { "venueId": 1, "perPage": 50, "start": 15 } ``` ### Menu | Property | Type | Description | | --------------------- | ---------------------------------------------------------- | --------------------------------------------------------------------------------- | | id | integer | The unique id of the menu | | menuTypeCategory | integer [Menu Type Category](#menu-type-categories) | The category of the menu type that's used in various reports | | name | text | The name of the menu | | minimumPax | integer | The minimum number of people allowed within a single session to order this menu | | maximumPax | integer | The maximum number of people allowed within a single session to order this menu | | cost | float | The price of the menu | | costType | integer [Cost Type](#cost-type-menu-pricing) | The price type of the menu | | costPerPerson | float | The per person price of the menu | | smallDescription | text | The small description of the menu | | marketplaceName | text | The name of the menu displayed in marketplace booking engines | | marketplaceCategories | array of [Marketplace Categories](#marketplace-categories) | The categories in which the menu will be displayed in marketplace booking engines | | costcenters | array of [Costcenter](#costcenter) | Cost breakdown of a menu when selected menu type is multi cost per person | ### Cost Type (Menu Pricing) * 1 = Per person * 2 = Flat rate * 3 = Total of menu items ### Marketplace Categories * 1 = Breakfast * 2 = Morning Break * 3 = Lunch * 4 = Afternoon Break * 5 = Dinner * 6 = Cocktail ### Menu Type Categories * 0 = Unassigned * 1 = Breakfast * 2 = Lunch * 3 = Dinner * 4 = Coffee Break * 5 = Reception * 6 = Outside Catering ### Costcenter | Property | Type | Required | Description | | --------------------------- | -------- | ----------------- | ----------------------------------------------------------------- | | costcenterId | integer | required | The id of costcenter | | costPerPerson | double | required | The cost per person value of a costcenter | | costPerPersonExcludedTaxIds | optional | array of integers | The excluded cost tax ids applied to the price of this costcenter | # Get Beverage Package List `POST` `[PlatformAddress]/api/1.0/venue?action=getBeveragePackageList` Get a list of Beverage Packages. #### Request Body | Name | Type | Description | | ------- | ------- | ------------------------------------------------------ | | venueId | integer | The id of the venue | | perPage | integer | The number of beverage package to get in a single call | {% tabs %} {% tab title="200 " %} ``` { "meta": { "totalResults": 5, "start": 0, "perPage": 50, "count": 2 }, "results": [ { "id": 125, "name": "Beverage Package 1", "minimumPax": 20, "maximumPax": 30, "cost": 98, "costType": 1, "smallDescription": "small description", "marketplaceName": "Marketplace Name 1", "marketplaceEventTypes": null }, { "id": 125, "name": "Beverage Package 2", "minimumPax": 10, "maximumPax": 30, "cost": 198, "costType": 2, "smallDescription": "small description", "marketplaceName": "Marketplace Name 2", "marketplaceEventTypes": null } ] } ``` {% endtab %} {% endtabs %} The result from this call will be a [collection](/getting-started/interpreting-the-response/collections) of all the beverages the user has access to. This call also accepts the [pagination](/getting-started/interpreting-the-response/pagination) and [filter](/getting-started/interpreting-the-response/filtering) properties. ### Example Request `Get a specific Beverage Package List` ```javascript { "venueId": "1", "perPage": "50", } ``` ### Beverage Package | Property | Type | Description | | --------------------- | ---------------------------------------------------------- | ------------------------------------------------------------------------------------------- | | id | integer | The unique id of the Beverage Package | | name | text | The name of the Beverage Package | | minimumPax | integer | The minimum number of people allowed within a single session to order this Beverage Package | | maximumPax | integer | The maximum number of people allowed within a single session to order this Beverage Package | | price | integer | The price of the Beverage Package | | cost | double | The price of the Beverage Package | | costs | array [Hourly Cost](#hourly-cost) | The hourly cost details of the beverage package | | actualCost | double | The price of the Beverage Package | | priceType | integer [Price Type](#price-type-beverage-package-pricing) | The price type of the Beverage Package | | smallDescription | text | The small description of the Beverage Package | | marketplaceName | text | The name of the Beverage Package displayed in marketplace booking engines | | marketplaceEventTypes | text | The event types of the Beverage Package displayed in marketplace booking engines | ### Price Type (Beverage Package pricing) One of the following values: * 1 = Per person * 2 = Flat rate ### Hourly Cost (Hourly Cost) | Property | Type | Description | | ------------------------ | ------- | ------------------------------------------------------------- | | id | integer | The unique id of the Beverage Package Hourly Cost | | beveragePackageId | integer | The unique id of the Beverage Package Hourly Cost | | id | integer | The unique id of the Beverage Package Hourly Cost | | beveragePackageId | integer | The unique identifier of the Beverage Package | | numHours | integer | The number of hours for which the cost apply | | cost | double | The hourly cost of the Beverage Package for this setup | | costExcludedTaxIds | double | The cost excluded tax identifiers | | actualCost | double | The actual hourly cost of the Beverage Package for this setup | | actualCostExcludedTaxIds | double | The actual cost excluded tax identifiers | # Get Function Space List `POST` `[PlatformAddress]/api/1.0/venue?action=getFunctionSpaceList` Return the venue function spaces list for the venue. #### Request Body | Name | Type | Description | | ------- | ------- | ------------------- | | venueId | integer | The id of the venue | {% tabs %} {% tab title="200 " %} ``` { "meta": { "totalResults": 1, "start": 0, "perPage": 100, "count": 1 }, "results": [ { "id": 1, "venueId": 1, "name": "Some Space", "description": "

This is some space

", "categoryId": 1, "imageId": 2555, "hasLayouts": true, "minPax": 1, "maxPax": 1000, "maxNumBookings": 1, "area": 100, "length": 100, "width": 100, "heightMaximum": 15, "heightMinimum": 15, "floorPressureMaximum": 100, "partSpaceIds": [], "includedInReportDashboard": true, "threeDScanId": "", "useIntegrationPartner": false, "isViewable": true, "marketplaceName": "Some Space", "eventTypes": [ 1, 2, 14, 15, 16, 17, 18 ], "canBeLiveBooked": true, "canProvideFoodBeverage": true, "menuTypeIds": [ 1, 2, 4 ], "beverageCategoryIds": [ 1, 2, 3, 4, 6 ], "availableFromTime": null, "availableTillTime": null, "minimumBookingTime": null, "restrictBookingTimeInterval": null, "availableDaysOfWeek": [], "displayAvailabilityTo": null, "restrictVisibility": null, "userGroupIds": [], "isViewableToAnonymousUsers": true, "sortOrder": 3, "marketplaceSortOrder": 1, "createdDate": "2015-01-09 03:51:23 UTC", "modifiedDate": "2020-12-07 00:20:45 UTC", "layouts": [ { "id": 1, "layoutName": "Theatre", "layoutType": 1 }, { "id": 2, "layoutName": "Cabaret", "layoutType": 4 } ] } ] } ``` {% endtab %} {% endtabs %} ### Example Request `Get Venues Function Space List` ```javascript { "venueId": 1 } ``` ### Returns `A collection object with the following properties in the results` | Property | Data Type | Description | | --------------------------- | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | id | integer | The unique id of the space. | | venueId | integer | The id of the venue to which the space belongs. | | name | string | The name of the space. | | description | string | The description of the space. | | categoryId | integer | The id of the category assigned to the space. | | imageId | integer | The id of the main image the space. | | hasLayouts | boolean | Whether or not the space has layouts. | | minPax | integer | The minimum pax of the space. | | maxPax | integer | The maximum pax of the space. | | maxNumBookings | integer | The maximum number of confirmed bookings that can share this space at the same time. | | area | float | The area of the space. | | length | float | The length of the space. | | width | float | The width of the space. | | heightMaximum | float | The maximum height of the space. | | heightMinimum | float | The minimum height of the space. | | floorPressureMaximum | float | The maximum floor pressure of the space. | | partSpaceIds | array | The ids of the spaces that are the smallest spaces that divide this space. | | includedInReportDashboard | boolean | Whether or not this space should be included in the reporting dashboard calculations (e.g. CI revenue per space). | | threeDScanId | string | An ID which can be used to display a 3D view of the space. | | useIntegrationPartner | boolean | Whether or not the space is integrated with ResDiary. | | isViewable | boolean | Whether or not the space is viewable on the iVvy marketplace and booking engines. | | marketplaceName | string | The name of the space shown on the iVvy marketplace and booking engines. | | eventTypes | array | The types of events that can be held in the space. | | canBeLiveBooked | boolean | Whether or not the space can be booked live on the iVvy marketplace and booking engines. | | canProvideFoodBeverage | boolean | Whether or not food and beverage can be added to the space. | | menuTypeIds | array | The ids of the types of menus available if the space can provide food and beverage. | | beverageCategoryIds | array | The ids of the types of beverage packages available if the space can provide food and beverage. | | availableFromTime | string | The earliest time from which the space can be reserved on the iVvy marketplace and booking engines. | | availableTillTime | string | The latest time to which the space can be reserved on the iVvy marketplace and booking engines. | | minimumBookingTime | integer | The minimum number of continuous hours that must not be reserved for the space to be considered available for reservations. | | restrictBookingTimeInterval | integer | The smallest minute block interval for which the space can be reserved. For example, if 15 minutes then reservations from 0900 to 0920 are not allowed, but reservations from 0900 to 0915, 0900 to 0930, 0900 to 0945 etc. are allowed. | | availableDaysOfWeek | array | The days of the week that the space is available for reservations. | | displayAvailabilityTo | integer | Controls whether or not meeting bookers can see the live availability of the space via a mini-calendar of the day. | | restrictVisibility | integer | Whether or not the space visibility is restricted on the iVvy marketplace and booking engines. | | userGroupIds | array | The ids of the groups of users allowed to reserve the space on the venue's marketplace booking page when "restrictVisibility" is true. | | isViewableToAnonymousUsers | boolean | Whether or not annonymous users are allowed to reserve the space on the venue's marketplace booking page when "restrictVisibility" is true. | | sortOrder | integer | The sorting order of the space. Used to sort the list of spaces in documents etc. | | marketplaceSortOrder | integer | The sorting order of the space on the iVvy marketplace and booking engines. | | createdDate | timestamp | The date & time the space was created. | | modifiedDate | timestamp | The date & time the space was last modified. | | layouts | array | List of layouts associated to the requested space | ### Layout Types | # | Type | | - | ------------- | | 1 | Theatre | | 2 | Classroom | | 3 | U-Shape | | 4 | Cabaret | | 5 | Boardroom | | 6 | Banquet | | 7 | Cocktail | | 8 | Hollow Square | | 9 | Exhibition | # Get Space Blockout List `POST` `[PlatformAddress]/api/1.0/venue?action=getSpaceBlockoutList` Return the venue space blockout list for the venue. #### Request Body | Name | Type | Description | | ------- | ------- | ------------------- | | venueId | integer | The id of the venue | {% tabs %} {% tab title="200 " %} ``` { "meta": { "totalResults": 56, "start": 0, "perPage": 2, "count": 2 }, "results": [ { "id": 2, "venueId": 1, "spaceId": 5, "name": "Public Holiday 1", "startDate": "2022-01-17", "startTime": "12:00:00", "endDate": "2022-01-17", "endTime": "13:00:00", "bookedById": 1 }, { "id": 3, "venueId": 1, "spaceId": 4, "name": "Booked by XYZ", "startDate": "2022-01-17", "startTime": "05:00:00", "endDate": "2022-01-17", "endTime": "06:00:00", "bookedById": 1 } ] } ``` {% endtab %} {% endtabs %} ### Example Request `Get Space Blockout List` ```javascript { "venueId": 1 } ``` ### Returns `A collection object with the following properties in the results` | Property | Data Type | Description | | ---------- | --------- | ------------------------------------------------------------------------ | | id | integer | The unique identifier of the space blockout. | | venueId | integer | The unique id of the venue to which the space blockout belongs. | | spaceId | integer | The unique id of the function space to which the space blockout belongs. | | name | string | The name of the space blockout. | | startDate | date | The start date of the space blockout. | | startTime | time | The start time of the space blockout. | | endDate | date | The end date of the space blockout. | | endTime | time | The end time of the space blockout. | | bookedById | integer | 'The coordinator user who created the space blockout. | # Get Function Space Category List `POST` `[PlatformAddress]/api/1.0/venue?action=getFunctionSpaceCategoryList` Return the venue function space category list for the venue. #### Path Parameters | Name | Type | Description | | ----------------------------------------- | ------- | ------------------------------------------ | | venueId\* | integer | The id of the venue | | perPage | integer | The number of menu to get in a single call | {% tabs %} {% tab title="200 " %} ``` { "meta": { "totalResults": 5, "start": 0, "perPage": 10, "count": 5 }, "results": [ { "id": 2, "name": "B Category" }, { "id": 1, "name": "A Category" }, { "id": 3, "name": "C" }, { "id": 4, "name": "abc" }, { "id": 5, "name": "D Category" } ] } ``` {% endtab %} {% endtabs %} ### Example Request `Get Venues Function Space Category List` ```javascript { "venueId": 1, "perPage":10 } ``` ### Returns `A collection object with the following properties in the results` | Property | Data Type | Description | | -------- | --------- | ------------------------------------ | | id | integer | The unique id of the space category. | | name | string | The name of the space category. | #### Throws | Code | Description | | -------------------- | ---------------------- | | Specific Code: 24150 | Account does not exist | | Specific Code: 24102 | Venue does not exist | | Specific Code: 24408 | Feature not allowed | # Get Function Space Availability `POST` `[PlatformAddress]/api/1.0/venue?action=getFunctionSpaceAvailability` Returns the availability of function spaces in a specific venue. #### Request Body | Name | Type | Description | | --------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | venueId | integer | The id of the venue | | startDate | date | The date from which the availability data will be fetched. Format YYY-MM-DD | | endDate | date | The date to which the availability data will be fetched. Format YYY-MM-DD. The maximum number of days of available that can be fetched is 14. | | spaceIds | array | Optionally the list of space ids to which availability will be limited. | {% tabs %} {% tab title="200 " %} ``` { "availability": [ { "spaceId": 1, "timeSlots": [ { "date": "2020-11-26", "startTime": "00:00:00", "endTime": "23:59:59" }, { "date": "2020-11-27", "startTime": "00:00:00", "endTime": "09:00:00" }, { "date": "2020-11-27", "startTime": "17:00:00", "endTime": "23:59:59" }, { "date": "2020-11-28", "startTime": "00:00:00", "endTime": "23:59:59" }, { "date": "2020-11-29", "startTime": "00:00:00", "endTime": "23:59:59" }, { "date": "2020-11-30", "startTime": "00:00:00", "endTime": "23:59:59" } ] }, { "spaceId": 2, "timeSlots": [ { "date": "2020-11-26", "startTime": "00:00:00", "endTime": "23:59:59" }, { "date": "2020-11-27", "startTime": "00:00:00", "endTime": "23:59:59" }, { "date": "2020-11-28", "startTime": "00:00:00", "endTime": "23:59:59" }, { "date": "2020-11-29", "startTime": "00:00:00", "endTime": "23:59:59" }, { "date": "2020-11-30", "startTime": "00:00:00", "endTime": "23:59:59" } ] } ] } ``` {% endtab %} {% endtabs %} ### Example Request `Get Venues Function Space List` ```javascript { "venueId":1, "startDate": "2020-11-26", "endDate": "2020-11-30", "spaceIds": [1, 2] } ``` ### Returns `A collection object with the following properties in the results` | Property | Data Type | Description | | ------------ | --------- | ----------------------------------------------------------------------------- | | availability | array | Array of spaces with availability data. See "Space Availability" for details. | ### Space Availability `A collection object with the following properties in the results` | Property | Data Type | Description | | --------- | --------- | ------------------------------------------------------------ | | spaceId | integer | The id of space to which the time slots belong. | | timeSlots | array | The array of time slots. See "Space Time Slots" for details. | ### Space Time Slots `A collection object with the following properties in the results` | Property | Data Type | Description | | --------- | --------- | ---------------------------------------------------------- | | date | date | The date to which the time slot applies. Format YYYY-MM-DD | | startTime | string | The start time of the available time slot. Format H:i:s | | endTime | string | The end time of the available time slot. Format H:i:s | # Get Available Function Spaces `POST` `[PlatformAddress]/api/1.0/venue?action=getAvailableFunctionSpaces` Returns the availability of function spaces in a specific venue based on some filtering criteria. This API is different to [Get Function Space Availability](/venues/venuedata/get-function-space-availability) in that besides allowing extra filtering, it returns the availability of function spaces for a maximum date-time range of 24 hours only. Availability timeslots are not returned. #### Request Body | Name | Type | Description | | ------------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------- | | venueId | integer | The id of the venue | | startDatetime | timestamp | The start date and time of the activity. Format is Y-m-d H:i:s | | endDatetime | timestamp | The end date and time of the activity. Format is Y-m-d H:i:s. The date and time range that of availability that can be fetched is 24 hours. | | eventType | integer | The event type id applied to the function space | | pax | integer | The number of attendees that the function space will be used for | | layoutType | integer | The layout type of the function space | | spaceIds | array | Optionally the list of space ids to which availability will be limited. | {% tabs %} {% tab title="200 " %} ``` { "meta": { "totalResults": 2, "start": 0, "perPage": 100, "count": 2 }, "results": [ { "id": 5991, "name": "Main Hall", "isAvailable": true, "reason": null, "conflict": null }, { "id": 6048, "name": "Music hall", "isAvailable": false, "reason": 3, "conflict": { "venueId": 1, "bookingId": 30167, "sessionId": 25728, "spaceId": 6048, "startDate": "2025-07-20 09:00:00", "endDate": "2025-07-20 10:00:00", "pax": 10 } } ] } ``` {% endtab %} {% endtabs %} ### Example Request `Get Available function spaces` ```javascript { "venueId":1, "startDatetime": "2025-11-26 09:00:00", "endDatetime": "2025-11-26 10:00:00", "eventType": 1, "pax": 10, "layoutType": 1, "spaceIds": [1] } ``` ### Returns | Property | Data Type | Description | | ----------- | --------- | -------------------------------------------------------------------------------------------- | | id | integer | The id of space to which the time slots belong. | | name | string | The name of space | | isAvailable | boolean | Whether the space is available | | reason | integer | The [reason](#conflict-reason) why the space is unavailable | | conflict | object | The [conflict](#conflict) object if there is a conflict with an existing booking reservation | ### Conflict Reason | Value | Description | | ----- | ---------------------------------------------------------------------------------------------- | | 1 | The reservation is unavailable because the space has been blocked | | 2 | The reservation is unavailable because the max pax on space has been crossed | | 3 | The reservation is unavailable because there is a conflict with an exiting booking reservation | ### Conflict | Property | Data Type | Description | | --------- | --------- | ---------------------------------------------------------------- | | venueId | integer | The id of venue | | bookingId | integer | The id of booking | | sessionId | integer | The id of session | | spaceId | integer | The id of space | | startDate | string | The start date of the conflict | | endDate | string | The end date of the conflict | | pax | integer | The number of attendees that the function space will be used for | # Get Function Space Hire Plan Rate List `POST` `[PlatformAddress]/api/1.0/venue?action=getSpaceHirePlanRateList` Return the space hire plan rates list for the venue. #### Request Body | Name | Type | Description | | -------- | ------- | ----------------------------- | | venueId | integer | The id of the venue | | tariffId | integer | The id of the space hire plan | {% tabs %} {% tab title="200 " %} ``` { "meta": { "totalResults": 1, "start": 0, "perPage": 100, "count": 1 }, "results": [ { "id": 9, "venueId": 1, "tariffId": 8, "colour": "#e4afaf", "startDate": "2021-01-09", "endDate": "2021-01-16", "daysOfWeek": [ 0 ], "createdDate": "2021-01-08 12:01:22 UTC", "modifiedDate": "2022-10-24 07:57:22 UTC" } ] } ``` {% endtab %} {% endtabs %} ### Example Request `Get Space Hire Plan Rate List` ```javascript { "venueId": 1, "tariffId": 8, "perPage": 100 } ``` You can use `startDateFilter` and `endDateFilter` in [filter](/getting-started/interpreting-the-response/filtering) to object to filter space hire plan rates within specific timeframe ### Returns `A collection object with the following properties in the results` | Property | Data Type | Description | | ------------ | --------- | ----------------------------------------------------- | | id | int | The unique identifier of the tariff rate | | venueId | int | The venue identifier of the tariff rate | | tariffId | int | The unique identifier of the tariff | | colour | string | The colour to identify the tariff rate | | startDate | sqldate | The start date of tariff rate | | endDate | sqldate | The end date of tariff rate | | daysOfWeek | array | The days of the week to which the tariff rate applies | | createdDate | timestamp | The date & time the tariff rate was created | | modifiedDate | timestamp | The date & time the tariff rate was last modified | ### daysOfWeek: following values: * 0 = Sunday * 1 = Monday * 2 = Tuesday * 3 = Wednesday * 4 = Thursday * 5 = Friday * 6 = Saturday # Get Function Space Hire Plan Rate `POST` `[PlatformAddress]/api/1.0/venue?action=getSpaceHirePlanRate` Return the detailed space rates for the specific space hire plan. #### Request Body | Name | Type | Description | | ------------ | ------- | ---------------------------------- | | venueId | integer | The id of the venue | | tariffId | integer | The id of the space hire plan | | tariffRateId | integer | The id of the space hire plan rate | {% tabs %} {% tab title="200 " %} ``` { "id": 9, "venueId": 1, "tariffId": 8, "colour": "#e4afaf", "startDate": "2021-01-09", "endDate": "2021-01-16", "daysOfWeek": [ 0, 1 ], "createdDate": "2021-01-08 12:01:22 UTC", "modifiedDate": "2022-10-24 07:57:22 UTC", "spaceRates": [ { "id": 8, "spaceId": 1, "spaceName": "Space", "minSpendCost": 200, "hourlyCost": 100, "halfDayCost": 50, "halfDayCostMinMins": 75, "halfDayCostMaxMins": 240, "halfDayCostAvailFrom": "19:30:00", "halfDayCostAvailTo": "20:00:00", "fullDayCost": 60, "fullDayCostMinMins": 75, "fullDayCostMaxMins": 150, "fullDayCostAvailFrom": "10:30:00", "fullDayCostAvailTo": "13:00:00", "nightCost": 60, "nightCostMinMins": 60, "nightCostMaxMins": 180, "nightCostAvailFrom": "22:00:00", "nightCostAvailTo": "23:00:00", "areCostsPerPerson": true, "hasLayoutRates": false, "createdDate": "2022-10-20 07:32:11 UTC", "modifiedDate": "2022-10-21 01:16:34 UTC" }, { "id": 9, "spaceId": 3, "spaceName": "PRO - The Salon", "minSpendCost": 40, "hourlyCost": 0, "halfDayCost": 0, "halfDayCostMinMins": 0, "halfDayCostMaxMins": 0, "halfDayCostAvailFrom": null, "halfDayCostAvailTo": null, "fullDayCost": 0, "fullDayCostMinMins": 0, "fullDayCostMaxMins": 0, "fullDayCostAvailFrom": null, "fullDayCostAvailTo": null, "nightCost": 0, "nightCostMinMins": 0, "nightCostMaxMins": 0, "nightCostAvailFrom": null, "nightCostAvailTo": null, "areCostsPerPerson": false, "hasLayoutRates": false, "createdDate": "2022-10-21 01:07:10 UTC", "modifiedDate": "2022-10-21 01:07:10 UTC" } ] } ``` {% endtab %} {% endtabs %} ### Example Request `Get Space Hire Plan Rate` ```javascript { "venueId": 1, "tariffId": 8, "tariffRateId": 9, } ``` ### Returns | Property | Data Type | Description | | ------------ | --------- | ------------------------------------------------------------------------------------- | | id | int | The unique identifier of the tariff rate | | venueId | int | The venue identifier of the tariff rate | | tariffId | int | The unique identifier of the tariff | | colour | string | The colour to identify the tariff rate | | startDate | sqldate | The start date of tariff rate | | endDate | sqldate | The end date of tariff rate | | spaceRates | array | The detailed rates for each spaces for the tariff rate. See [Space Rate](#space-rate) | | daysOfWeek | array | The days of the week to which the tariff rate applies | | createdDate | timestamp | The date & time the tariff rate was created | | modifiedDate | timestamp | The date & time the tariff rate was last modified | ### daysOfWeek: following values: * 0 = Sunday * 1 = Monday * 2 = Tuesday * 3 = Wednesday * 4 = Thursday * 5 = Friday * 6 = Saturday ### Space Rate | Property | Data Type | Description | | -------------------------- | --------- | --------------------------------------------------------------- | | id | string | The uniqie identifier of the tariff space rate | | spaceId | int | The space id of the tariff space rate | | spaceName | string | The space name of the tariff space rate | | minSpendCost | number | The minimum Sale Price of the tariff space rate | | minSpendCostExcludedTaxIds | array | The minimum Sale Price ExcludedTaxIds of the tariff space rate | | hourlyCost | number | The hourly sale Price of the tariff space rate | | hourlyCostExcludedTaxIds | array | The hourly sale Price ExcludedTaxIds of the tariff space rate | | halfDayCost | number | The Half Day Sale Price of the tariff space rate | | halfDayCostExcludedTaxIds | array | The Half Day Sale Price ExcludedTaxIds of the tariff space rate | | halfDayCostMinMins | int | The Half Day minimum minutes of the tariff space rate | | halfDayCostMaxMins | int | The Half Day maximum minutes of the tariff space rate | | halfDayCostAvailFrom | string | The Half Day Available From of the tariff space rate | | halfDayCostAvailTo | string | The Half Day Available To of the tariff space rate | | fullDayCost | number | The fullDayCost of the tariff space rate | | fullDayCostExcludedTaxIds | array | The fullDayCostExcludedTaxIds of the tariff space rate | | fullDayCostMinMins | int | The full day minimum minutes of the tariff space rate | | fullDayCostMaxMins | int | The full day maximum minutes of the tariff space rate | | fullDayCostAvailFrom | string | The full day Available From of the tariff space rate | | fullDayCostAvailTo | string | The full day Available To of the tariff space rate | | nightCost | number | The night sale price of the tariff space rate | | nightCostExcludedTaxIds | array | The night sale price ExcludedTaxIds of the tariff space rate | | nightCostMinMins | int | The n minimum minutes of the tariff space rate | | nightCostMaxMins | int | The night maximum minutes of the tariff space rate | | nightCostAvailFrom | string | The night Available From of the tariff space rate | | nightCostAvailTo | string | The night Available To of the tariff space rate | | areCostsPerPerson | boolean | Whether costs are per person for the tariff space rate | | hasLayoutRates | boolean | Whether or not layout has rates for the tariff space rate | | createdDate | timestamp | The createdDate of the tariff space rate | | modifiedDate | timestamp | The modifiedDate of the tariff space rate | # Get Cost Center List `POST` `[PlatformAddress]/api/1.0/venue?action=getCostCenterList` #### Request Body | Name | Type | Description | | ------- | ------- | ------------------- | | venueId | integer | The id of the venue | {% tabs %} {% tab title="200 " %} ``` { "meta": { "totalResults": 1, "start": 0, "perPage": 50, "count": 1 }, "results": [ { "id": 1, "name": "Food", "code": "venueccfd", "description": "Venue food cost center", "parentId": 321, "parentDefaultType": 1, } ] } ``` {% endtab %} {% endtabs %} The result from this call will be a [collection](/getting-started/interpreting-the-response/collections) of all the events the user has access to. This call also accepts the [pagination](/getting-started/interpreting-the-response/pagination) and [filter](/getting-started/interpreting-the-response/filtering) properties. The venueId is required, for example {"venuId":10} ### Returns | Property | Description | | ----------------- | -------------------------------------------------------------------------------------------------- | | id | The unique identifier of the cost center | | name | The name of the cost center | | code | The code of the cost center | | description | The complete description of the cost center | | parentId | The unique identifier of the parent account cost center | | parentDefaultType | The type of the parent account cost center. See [Type](/account/get-cost-center-list#default-type) | ### Throws | Code | Description | | -------------------- | ---------------------- | | Specific Code: 24270 | Account does not exist | | Specific Code: 24271 | Venue does not exist | # Get Session Type List `POST` `[PlatformAddress]/api/1.0/venue?action=getSessionTypeList` Return the venue session type list for the account. {% tabs %} {% tab title="200 " %} ``` { "meta": { "totalResults": 1, "start": 0, "perPage": 1, "count": 1 }, "results": [ { "id": 2, "name": "Session Type" } ] } ``` {% endtab %} {% endtabs %} ### Example Request `Get Session Type List` ```javascript {} ``` ### Returns `A collection object with the following properties in the results` | Property | Type | Description | | -------- | ------- | ---------------------------------- | | id | integer | The unique session type identifier | | name | integer | The name of Session TYpe | # Get Revenue Template List `POST` `[PlatformAddress]/api/1.0/venue?action=getRevenueTemplateList` Return the event type list for the account. {% tabs %} {% tab title="200 " %} ``` { "meta": { "totalResults": 2, "start": 0, "perPage": 100, "count": 2 }, "results": [ { "id": 1, "name": "Banquet", "isDefault": true, "costcenters": [ { "costcenterId": 1, "newCostcenterId": 1102 }, { "costcenterId": 2, "newCostcenterId": 1109 }, { "costcenterId": 4, "newCostcenterId": 4 } ], "createdDate": "2021-03-03 11:22:20 UTC", "modifiedDate": "2021-03-15 14:19:47 UTC" }, { "id": 2, "name": "Catering", "isDefault": false, "costcenters": [ { "costcenterId": 1, "newCostcenterId": 1101 }, { "costcenterId": 2, "newCostcenterId": 1110 } ], "createdDate": "2021-03-03 11:22:35 UTC", "modifiedDate": "2021-03-15 04:41:59 UTC" } ] } ``` {% endtab %} {% endtabs %} ### Example Request `Get Venues Revenue Template List` ```javascript { "venueId" : 1 "perPage": 100 "start": 0 } ``` ### Returns `A collection object with the following properties in the results` | Property | Description | | ------------ | ------------------------------------------------------------------------ | | id | The unique id of the revenue template | | name | The name of the revenue template | | isDefault | Whether or not the revenue template is default on venue. | | costcenters | The cost center mapping of the revenue template. See [Mapping](#mapping) | | createdDate | The date & time the revenue template was created | | modifiedDate | The date & time the revenue template was last modified | ### Mapping | Property | Description | | --------------- | ----------------------------------------------- | | costcenterId | The current cost center | | newCostcenterId | The new cost center against current cost center | # Get Tax List `POST` `[PlatformAddress]/api/1.0/venue?action=getTaxList` Return the tax list for the venue. #### Request Body | Name | Type | Description | | ------- | ------- | ------------------- | | venueId | integer | The id of the venue | {% tabs %} {% tab title="200 " %} ``` { "meta": { "totalResults": 1, "start": 0, "perPage": 1, "count": 1 }, "results": [ { "id": 2, "name": "GST" } ] } ``` {% endtab %} {% endtabs %} ### Example Request `Get Venues Tax List` ```javascript { "venueId": 2 } ``` ### Returns `A collection object with the following properties in the results` | Property | Type | Description | | -------------------- | ----------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | id | integer | The unique invoice identifier | | name | string | The name of Tax | | type | integer [Type](#type) | The type of the tax. Whether Tax / Service Fee | | appliesTo | integer [Applies To](#applies-to) | Whether the tax only applies to accommodation | | amountType | integer [Amount Type](#amount-type) | Tax or service fee amount / percent to apply on items. 1 = A percentage, 2 = An amount | | amount | double | Percentage / Amount of the tax | | taxIds | array | The taxes which are applied to the amount of the service fee | | costcenterIds | array | The cost centers to which the tax /service fee apply | | excludedTaxIds | array | The array of tax Ids which are excluded to apply on the booking | | calculateExclusively | boolean | If enabled, the tax will not be included in the line item totals, only in the cost centre, booking and invoice totals | | unitType | integer [Unit Type](#unit-type) | The metric of which to calculate the units of tax to be charged. Capacity - Max occupancy of the room. Occupants - Number of guest staying in the room, calculated from capacity or multi-occupancy values if enabled. Room Nights - Total number of room nights for the room type | ### Type The tax types. | Value | Description | | ----- | ------------ | | 1 | Tax | | 2 | Service Fees | ### Applies To The applies to options. | Value | Description | | ----- | ------------------ | | 1 | All | | 2 | Accommodation Only | ### Amount Type The amount options. | Value | Description | | ----- | ----------- | | 1 | Percentage | | 2 | Amount | ### Unit Type The unit type options. | Value | Description | | ----- | ----------- | | 1 | Room Nights | | 2 | Capacity | | 3 | Occupancy | # Add or Update Function Space `POST` `[PlatformAddress]/api/1.0/venue?action=addOrUpdateFunctionSpace` #### Request Body | Name | Type | Description | | ------------------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | id | integer | The unique id of the function space to update (Leave empty if adding a new space ) | | venueId | integer | The unique id of the venue to which the function space belongs | | name | string | The name of the function space (Required when the ID parameter is missing) | | description | string | The description of the function space | | categoryId | integer | The categoryId id of the function space | | hasLayouts | boolean | Whether or not the function space has layout | | minPax | integer | The minimum pax of the function space (Required when the ID parameter is missing) | | maxPax | integer | The maximum pax of the function space (Required when the ID parameter is missing) | | maxNumBookings | integer | The maximum number bookings of the function space (Required when the ID parameter is missing) | | area | integer | The usable floor area of the function space | | length | integer | The usable length of the function space | | width | integer | The usable width of the function space | | heightMaximum | integer | The usable width of the function space | | heightMinimum | integer | The mminimum height of the function space | | floorPressureMaximum | integer | The maximum floor pressure allowed for the function space | | isViewable | boolean | Whether or not the function space is viewable on marketplace (Required when the ID parameter is missing) | | eventTypes | array | The event type ids applied to the function space | | marketplaceName | string | The name of the space displayed in marketplace and booking engines | | hasSmallerSpaces | boolean | Whether or not this space can be divided into smaller, individual spaces (Required when the ID parameter is missing) | | partSpaceIds | array | The smallest individual spaces that are available within this space. Also include the smallest spaces that overlap other spaces (Only used when hasSmallerSpaces=true) | | includedInReportDashboard | boolean | Whether or not this space should be included in the reporting dashboard calculations (e.g. CI revenue per function space) | | threeDScanId | string | The 3D scan ID which will show 3D view of your space on iVvy | | useIntegrationPartner | boolean | Whether this function space is integrated with ResDiary | {% tabs %} {% tab title="200 " %} ``` { "success": true, "id": 7 } ``` {% endtab %} {% endtabs %} #### Example Request **Add function space** ```javascript { "venueId": 1, "name": "test", "minPax": 5, "maxPax": 0, "maxNumBookings": 50, "isViewable": false, "hasSmallerSpaces": false } ``` **Update function space** ```javascript { "id": 7, "venueId": 1, "name": "test", "minPax": 5, "maxPax": 0, "maxNumBookings": 50, "isViewable": false, "hasSmallerSpaces": false } ``` #### Returns | Property | Description | | -------- | --------------------------------------------------- | | success | Whether or not the function space was added/updated | | id | The unique id of the function space | #### Throws | Code | Description | | -------------------- | --------------------------------- | | Specific Code: 24385 | The function space does not exist | | Specific Code: 24386 | An unknown error has occurred | | Specific Code: 24387 | The request contains invalid data | | Specific Code: 24388 | The request contains invalid data | # Get Event Type List `POST` `[PlatformAddress]/api/1.0/venue?action=getEventTypeList` Return the event type list for the account. {% tabs %} {% tab title="200 " %} ``` { "meta": { "totalResults": 11, "start": 0, "perPage": 2, "count": 2 }, "results": [ { "id": 1, "name": "Christmas", "description": null, "marketplaceEventType": 11, "contactType": 0, "isViewable": true, "createdDate": "2017-12-18 09:48:05 UTC", "modifiedDate": "2017-12-18 09:48:05 UTC" "subTypes": [ { "id": 1, "name": "Christmas Eve" } ] }, { "id": 2, "name": "Cocktail", "description": null, "marketplaceEventType": 11, "contactType": 0, "isViewable": true, "createdDate": "2017-12-18 09:48:05 UTC", "modifiedDate": "2017-12-18 09:48:05 UTC" "subTypes": [] } ] } ``` {% endtab %} {% endtabs %} ### Example Request `Get Venues Event Type List` ```javascript { "perPage": 10 "start": 0 } ``` ### Returns `A collection object with the following properties in the results` | Property | Description | | -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | id | The unique event type identifier | | name | The name of the event type | | description | The description of the event type | | marketplaceEventType | The Venue Marketplace event type to associate with the event type. See [Marketplace Event Types](https://github.com/ivvycode/apidocs/blob/master/venues/venuedata/get-event-type-list.md.md#marketplace-event-types) | | contactType | The type of contact that can be assigned to a opportunity/booking of the event type. 0 = Company & Contact, 1 = Company, 2 = Contact | | isViewable | Whether or not the event type is viewable on marketplace | | createdDate | The date & time the event type was created | | modifiedDate | The date & time the event type was last modified | | subTypes | Array of [Event Sub Type](#event-sub-type) | ### Marketplace Event Types | # | Description | | -- | ------------------ | | 2 | Christmas | | 3 | Cocktail | | 4 | Conference | | 5 | Corporate Function | | 13 | Breakfast | | 14 | Lunch | | 6 | Dinner | | 11 | Event | | 7 | Exhibition | | 8 | Meeting | | 9 | Party | | 10 | Wedding | | 1 | Other | ### Event Sub Type | Property | Description | | -------- | ------------------------------------ | | id | The unique event sub type identifier | | name | The name of the event sub type | # Add or Update Function Space Category `POST` `[PlatformAddress]/api/1.0/venue?action=addOrUpdateFunctionSpaceCategory` #### Path Parameters | Name | Type | Description | | ----------------------------------------- | ------- | -------------------------------------------------------------------------------- | | venueId\* | integer | | | id | integer | The unique id of the space category (Leave empty if adding a new space category) | | name\* | string | The name of the event space category (Required when the ID parameter is missing) | {% tabs %} {% tab title="200 " %} ``` { "success": true, "id": 7 } ``` {% endtab %} {% endtabs %} #### Example Request **Add space category** ```javascript { "venueId": "1", "name": "Category 1", } ``` **Update space category** ```javascript { "id": 7, "name": "Updated Category" } ``` #### Returns | Property | Description | | -------- | ------------------------------------------- | | success | Whether or not the space category was added | | id | The unique id of the space category | #### Throws | Code | Description | | -------------------- | --------------------------------------- | | Specific Code: 24308 | The venue space category does not exist | | Specific Code: 24309 | An error has occurred | | Specific Code: 24310 | The request contains invalid data | | Specific Code: 24311 | The request contains invalid data | This call takes values for a space category, and either 1. Updates the values for that space category (after you have provided an id in the parameters), or 2. Adds the space category to the system (if the id parameter is missing) 1. The result of this call will contain the status of the result (either true or false) and the space category identifier of the updated or newly created space category. # Add or Update Guest Room `POST` `[PlatformAddress]/api/1.0/venue?action=addOrUpdateGuestRoom` #### Request Body | Name | Type | Description | | ----------------- | ------- | --------------------------------------------------------- | | id | integer | The unique id of the guest room | | venueId | integer | The unique id of the venue to which the rate plan belongs | | name | string | The name of the venue room | | code | string | The unique code assigned to the room | | categoryIds | array | An array of category ids to which the room belongs. | | capacity | integer | The total number of this room type at the venue. | | description | string | A html formatted description of the room. | | numStandardAdults | integer | The number of standard adults allowed in the room. | | numExtraAdults | integer | The number of standard adults allowed in the room. | | extraAdultCost | number | The price of adding an extra adult to the room. | | canSmoke | bool | Whether or not smoking is allowed in the room. | | active | bool | Whether or not venue room is active on marketplace. | | marketplaceName | bool | Whether or not venue room is active on marketplace. | {% tabs %} {% tab title="200 " %} ``` { "success": true, "id": 10 } ``` {% endtab %} {% endtabs %} ### Example Request #### Add Guest Room ```javascript { "venueId": "1", "name": "Room 3.3", "extraAdultCost": "15", "categoryIds": [ 1,2 ], "capacity": 10, "description": "this is testing", "numStandardAdults": 5, "numExtraAdults": 0, "canSmoke": "0", "active": "0" } ``` #### Update Guest Room ```javascript { "venueId": "1", "name": "Room 3.4", "id": 54 } ``` ### Returns | Property | Description | | -------- | -------------------------------------------------------- | | success | Whether or not the Space Blockout was added to the venue | | id | The unique id of the Space Blockout | ### Throws | Code | Description | | -------------------- | --------------------------------- | | Specific Code: 24312 | The room does not exist | | Specific Code: 24313 | An error has occurred | | Specific Code: 24314 | The request contains invalid data | | Specific Code: 24315 | An unknown error has occurred | # Get Booking Custom Field List `POST` `[PlatformAddress]/api/1.0/venue?action=getBookingCustomFieldList` Return the booking custom fields (definition) list. #### Path Parameters | Name | Type | Description | | ------- | ------- | ----------------------------------------------------------- | | perPage | integer | The number of booking custom fields to get in a single call | {% tabs %} {% tab title="200 " %} ``` { "meta": { "totalResults": 9, "start": 0, "perPage": 100, "count": 9 }, "results": [ { "id": 1, "fieldType": 0, "displayName": "Small Text", "isRequired": false, "visibleTo": 3, "userGroupIds": [ 10 ], "tooltipText": "", "isRequiredOnMarketplace": false, "sortOrder": 0, "selectValues": null }, ] } ``` {% endtab %} {% endtabs %} ### Example Request `Get Venues Function Space Category List` ```javascript { "perPage":10 } ``` ### Returns `A collection object with the following properties in the results` | Property | Data Type | Description | | ----------------------- | --------- | ------------------------------------------------------ | | id | integer | The unique id of the booking custom field. | | fieldType | integer | The [type](#type) of this field. | | displayName | string | The name of this field. | | isRequired | boolean | If this is a required field. | | visibleTo | integer | Field [visiblity options](#visiblity-to-options). | | userGroupIds | array | Ids of user groups if visible to specific user groups. | | tooltipText | string | Tooltip text of the custom field. | | isRequiredOnMarketplace | boolean | Whether or not the field is required on marketplace. | | sortOrder | integer | Order to display this field. | | selectValues | object | Values that can be selected with select fields. | ### Type | # | Description | | -- | ------------- | | 0 | Small Text | | 1 | Large Text | | 2 | Single Select | | 3 | Multi Select | | 5 | Date | | 10 | Html Text | ### Visiblity to Options | # | Description | | - | ----------- | | 1 | All | | 2 | User Group | | 3 | None | #### Throws | Code | Description | | -------------------- | ---------------------- | | Specific Code: 24150 | Account does not exist | # Get Space Hire Plans `POST` `[PlatformAddress]/api/1.0/venue?action=getSpaceHirePlanList` Get a list of space hire plans. #### Path Parameters | Name | Type | Description | | ----------------------------------------- | ------- | ----------------------------------------------------- | | venueId\* | integer | The id of the venue | | perPage | integer | The number of space hire plan to get in a single call | {% tabs %} {% tab title="200 " %} ``` { "meta": { "totalResults": 2, "start": 0, "perPage": 50, "count": 2 }, "results": [ { "id": 1, "name": "RHP", "code": "RHP", "description": null, "createdDate": "2017-12-18 12:17:49 UTC", "modifiedDate": "2018-01-15 05:44:41 UTC" }, { "id": 8, "name": "Test Hire Plan", "code": "HIRE123", "description": "

test

", "createdDate": "2019-04-03 11:27:42 UTC", "modifiedDate": "2020-04-29 04:43:02 UTC" } ] } ``` {% endtab %} {% endtabs %} The result from this call will be a [collection](/getting-started/interpreting-the-response/collections) of all the space hire plans the user has access to. This call also accepts the [pagination](/getting-started/interpreting-the-response/pagination) and [filter](/getting-started/interpreting-the-response/filtering) properties. ### Example Request `Get a specific space hire plan list` ```javascript { "venueId": "1", "perPage": "50", } ``` # Get Venue Package List `POST` `[PlatformAddress]/api/1.0/venue?action=getVenuePackageListundefined` Provides the list of packages (Event Templates) #### Request Body | Name | Type | Description | | ------- | ------- | ------------------- | | venueId | integer | The id of the venue | {% tabs %} {% tab title="200 " %} ``` { "meta": { "totalResults": 1, "start": 0, "perPage": 100, "count": 1 }, "results": [ { "id": 1, "name": "Standard", "type": 1, "minPax": 1, "maxPax": 1000, "cost": 500, "priceMethod": 1, "actualCost": 50, "actualCostExcludedTaxIds": [ 1, 317, 1046, 1203, 1204, 1955, 1986, 1988, 3910, 3979 ], "smallDescription": "Standard", "largeDescription": "

Standard

\n", "marketplaceName": "Standard", "isVisibleOnVenueSearch": false, "createdDate": "2017-12-18 12:23:53", "modifiedDate": "2025-04-23 23:28:28", "startDate": null, "endDate": null, "startTime": "06:00:00", "endTime": "12:30:00", "costcenters": [ { "id": 1, "value": 149.5, "excludedTaxIds": [ 1, 317, 1955 ] }, { "id": 2, "value": 100, "excludedTaxIds": [] }, { "id": 3, "value": 100.5, "excludedTaxIds": [ 3910, 3979 ] }, { "id": 4, "value": 100, "excludedTaxIds": [] }, { "id": 5, "value": 0, "excludedTaxIds": [] }, { "id": 1166, "value": 0, "excludedTaxIds": [] }, { "id": 2986, "value": 50, "excludedTaxIds": [] }, { "id": 6338, "value": 0, "excludedTaxIds": [] }, { "id": 17647, "value": 0, "excludedTaxIds": [] }, { "id": 17648, "value": 0, "excludedTaxIds": [] }, { "id": 17649, "value": 0, "excludedTaxIds": [] } ], "hasSessions": true, "spaceId": 1, "spaceLayoutId": 2, "spaceCustomLayoutName": "C", "sortOrder": 0, "excludedFromCommissions": false, "reduceRoomHireFirst": true, "eventTypes": [ 1, 2, 3, 4, 5, 6 ], "userGroupIds": [ 1, 2 ], "hasLimitedStartTimes": true, "limitedStartTimes": [ "02:30:00", "03:00:00" ], "isAccommIncluded": true, "discountCampaignId": 59, "costcentersDiscounts": [ { "id": 1, "value": 18 }, { "id": 2, "value": 18 }, { "id": 3, "value": 18 }, { "id": 4, "value": 18 }, { "id": 5, "value": 18 }, { "id": 6338, "value": 18 }, { "id": 2986, "value": 18 } ] } ] } ``` {% endtab %} {% endtabs %} ### Example Request `getVenuePackageList` ```javascript { "venueId": 1, "perPage": 2 } ``` ### Returns `A collection object with the following properties in the results` | Property | Data Type | Description | | ------------------------ | ------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | | id | integer | The unique identifier of the package | | name | string | The name of the package | | type | enum [PackageType](#package-type) | Simple or Detailed | | minPax | integer | The minimum pax of the package | | maxPax | integer | The maximum pax of the package | | cost | float | The price of the package (depends on the "priceMethod" value) | | priceMethod | enum [priceMethod](#price-method) | The type of package price - per person or flat rate | | actualCost | float | The actual cost of the package | | actualCostExcludedTaxIds | array | The tax ids excluded from the actual cost | | smallDescription | string | A html formatted small description of the package | | largeDescription | string | A html formatted large description of the package | | marketplaceName | string | The name of the package displayed in marketplace booking engines | | isVisibleOnVenueSearch | boolean | Whether the package is visible on venue search | | createdDate | datetime | The date and time the package was created | | modifiedDate | datetime | The date and time the package was last modified. Does not include changes to the package items | | startDate | date | The date from which the package is available | | endDate | date | The date to which the package is available | | startTime | time | The time from which the package is available | | endTime | time | The time to which the package is available | | costcenters | array of [CostCenter](#cost-center) | The cost centers to which the package applies. | | hasSessions | boolean | Whether the package has sessions | | spaceId | integer | The default space to be used for the package | | spaceLayoutId | integer | The default space layout to be used for the package | | spaceCustomLayoutName | string | Layout name for custom space layout | | sortOrder | integer | The order in which the package should be displayed | | excludedFromCommissions | boolean | Whether the package is excluded from commissions | | reduceRoomHireFirst | boolean | Whether to reduce room hire first when applying the package to bookings | | eventTypes | array | The marketplace event types to which the package applies. If empty, the package applies to all event types | | userGroupIds | array | The user groups to which the package applies. If empty, the package applies to all user groups | | hasLimitedStartTimes | boolean | Whether the package has limited start times | | limitedStartTimes | time | The limited start time of the package | | isAccommIncluded | boolean | Whether accommodation is included in the package. This is a legacy field and should not be used | | discountCampaignId | integer | The discount campaign to apply to the package | | costcentersDiscounts | array of [Cost Center Discounts](#cost-center-discount) | The cost center discounts to apply to the package | ### Cost Center | Property | Data Type | Description | | -------- | --------- | ------------------------------------------- | | id | integer | The cost center identifier | | value | float | The discount percentage for the cost center | ### Cost Center Discount | Property | Data Type | Description | | -------- | --------- | ----------------------------- | | id | integer | The cost center identifier | | value | float | The price for the cost center | ### Package Type | Identifier | Description | | ---------- | ----------- | | 1 | Detailed | | 2 | Simple | ### Price Method | Identifier | Description | | ---------- | ----------- | | 1 | Per Person | | 2 | Flat Rate | The result from this call will be a [collection](/getting-started/interpreting-the-response/collections) of all the events the user has access to. This call also accepts the [pagination](/getting-started/interpreting-the-response/pagination) and [filter](/getting-started/interpreting-the-response/filtering) properties. # Get Venue Package `POST` `[PlatformAddress]/api/1.0/venue?action=getVenuePackageundefined` Provides all the details of the venue package including Sessions and its items ie. Menus, Beverages, Resources, Products, Setup Requirements and Setup Requirement Options #### Request Body | Name | Type | Description | | ------- | ------- | --------------------------- | | venueId | integer | The id of the venue | | id | integer | The id of the venue package | {% tabs %} {% tab title="200 " %} ``` { "id": 1, "name": "Standard", "type": 1, "minPax": 1, "maxPax": 1000, "cost": 500, "priceMethod": 1, "actualCost": 50, "actualCostExcludedTaxIds": [ 1, 317, 1046, 1203, 1204, 1955, 1986, 1988, 3910, 3979 ], "smallDescription": "Standard", "largeDescription": "

Standard

\n", "marketplaceName": "Standard", "isVisibleOnVenueSearch": false, "createdDate": "2017-12-18 12:23:53", "modifiedDate": "2025-04-23 23:28:28", "startDate": null, "endDate": null, "startTime": "06:00:00", "endTime": "12:30:00", "costcenters": [ { "id": 1, "value": 149.5, "excludedTaxIds": [ 1, 317, 1955 ] }, { "id": 2, "value": 100, "excludedTaxIds": [] }, { "id": 3, "value": 100.5, "excludedTaxIds": [ 3910, 3979 ] }, { "id": 4, "value": 100, "excludedTaxIds": [] }, { "id": 5, "value": 0, "excludedTaxIds": [] }, { "id": 1166, "value": 0, "excludedTaxIds": [] }, { "id": 2986, "value": 50, "excludedTaxIds": [] }, { "id": 6338, "value": 0, "excludedTaxIds": [] }, { "id": 17647, "value": 0, "excludedTaxIds": [] }, { "id": 17648, "value": 0, "excludedTaxIds": [] }, { "id": 17649, "value": 0, "excludedTaxIds": [] } ], "hasSessions": true, "spaceId": 1, "spaceLayoutId": 2, "spaceCustomLayoutName": "C", "sortOrder": 0, "excludedFromCommissions": false, "reduceRoomHireFirst": true, "eventTypes": [ 1, 2, 3, 4, 5, 6 ], "userGroupIds": [ 1, 2 ], "hasLimitedStartTimes": true, "limitedStartTimes": [ "02:30:00", "03:00:00" ], "isAccommIncluded": true, "discountCampaignId": 59, "costcentersDiscounts": [ { "id": 1, "value": 18 }, { "id": 2, "value": 18 }, { "id": 3, "value": 18 }, { "id": 4, "value": 18 }, { "id": 5, "value": 18 }, { "id": 6338, "value": 18 }, { "id": 2986, "value": 18 } ], "sessions": [ { "id": 1, "name": "Morning1", "startTime": "08:00:00", "endTime": "09:00:00", "setupTime": 0, "setDownTime": 0, "createdDate": "2017-12-18 12:25:01", "modifiedDate": "2025-04-23 23:28:31", "isOptional": false, "spaceVenueId": 1, "spaceId": 1, "spaceLayoutId": 0, "spaceCustomLayoutName": "C", "includeInPackage": true, "tariffId": 1, "roomHireType": 1, "minSpendAmount": 10, "minSpendRevenueItems": [ 1, 2, 3, 4, 5 ], "overridePax": false, "costcenterId": 0, "amount": null, "excludedTaxIds": [], "sortOrder": 0, "sessionTypeId": 64, "sessionStatusId": 0, "beveragePackages": [ { "id": 1, "name": "Morning tea", "beverageVenueId": 1, "beverageId": 1, "numHours": null, "startTime": "08:00:00", "endTime": "09:00:00", "sameAsSessionTime": true, "itemsIds": [ 1, 10 ], "includeInPackage": false, "costcenterId": 2, "amount": 10, "excludedTaxIds": [], "createdDate": "2017-12-18 12:25:32", "modifiedDate": "2025-04-23 05:52:34" }, { "id": 15, "name": "Per Person - 30 Minute Pre-dinner Beverages", "beverageVenueId": 1, "beverageId": 7, "numHours": null, "startTime": "08:00:00", "endTime": "09:00:00", "sameAsSessionTime": true, "itemsIds": [ 11 ], "includeInPackage": false, "costcenterId": 2, "amount": 15, "excludedTaxIds": [ 1 ], "createdDate": "2025-04-23 05:53:02", "modifiedDate": "2025-04-23 05:53:02" } ], "menus": [ { "id": 14, "name": "Total of all items", "menuVenueId": 1, "menuId": 13, "startTime": "08:00:00", "endTime": "09:00:00", "sameAsSessionTime": true, "includeInPackage": false, "costcenterId": 1, "amount": 10, "excludedTaxIds": [ 317, 1955 ], "createdDate": "2021-11-09 01:31:05", "modifiedDate": "2025-04-23 05:28:22", "items": [ { "inventoryId": 8, "groupId": "gr6189d144bfc41" } ], "groups": [ { "idHash": "gr6189d144bfc41", "name": "Group 1", "marketplaceName": "", "minSelection": 1, "maxSelection": 2, "servingTime": null } ], "costcenters": [] }, { "id": 19, "name": "Multi Cost center", "menuVenueId": 1, "menuId": 114, "startTime": "08:00:00", "endTime": "09:00:00", "sameAsSessionTime": true, "includeInPackage": false, "costcenterId": 0, "amount": 30, "excludedTaxIds": [], "createdDate": "2025-04-23 05:27:26", "modifiedDate": "2025-04-23 05:27:26", "items": [ { "inventoryId": 10, "groupId": "" } ], "groups": [], "costcenters": [ { "id": 1, "value": 10, "excludedTaxIds": [ 1046, 1955, 1986, 1988, 3910, 3979 ] }, { "id": 2, "value": 20, "excludedTaxIds": [ 1, 317, 1046, 1955, 1986, 1988, 3910, 3979 ] } ] } ], "products": [ { "id": 3, "productId": 13, "includeInPackage": false, "costcenterId": 3, "amount": null, "excludedTaxIds": [ 317 ], "createdDate": "2020-12-01 00:58:55", "modifiedDate": "2025-04-23 06:17:48" } ], "resources": [ { "id": 16, "resourceVenueId": 1, "resourceId": 0, "quantity": 1, "includeInPackage": false, "costcenterId": 1, "amount": 0, "excludedTaxIds": [], "createdDate": "2022-04-05 04:49:30", "modifiedDate": "2022-04-05 04:49:30" }, { "id": 22, "resourceVenueId": 1, "resourceId": 2, "quantity": 1, "includeInPackage": false, "costcenterId": 2986, "amount": 12, "excludedTaxIds": [], "createdDate": "2022-04-06 07:12:50", "modifiedDate": "2022-04-06 07:12:50" }, { "id": 23, "resourceVenueId": 1, "resourceId": 3, "quantity": 1, "includeInPackage": false, "costcenterId": 3, "amount": 10, "excludedTaxIds": [ 1955, 1986, 3910, 3979 ], "createdDate": "2022-04-13 23:31:13", "modifiedDate": "2025-04-23 06:11:55" } ], "setupRequirements": [ { "id": 8, "setupRequirementId": 1, "name": "mysetuprequire", "description": null, "createdDate": "2025-04-23 06:38:29", "modifiedDate": "2025-04-23 06:38:49", "sortOrder": 2, "hasChoices": false, "minChoices": 1, "maxChoices": 0, "options": [ { "id": 10, "setupRequirementId": 1, "setupRequirementOptionId": 2, "name": "a", "createdDate": "2025-04-23 06:38:29", "modifiedDate": "2025-04-23 06:38:29", "sortOrder": 0 }, { "id": 11, "setupRequirementId": 1, "setupRequirementOptionId": 3, "name": "b", "createdDate": "2025-04-23 06:38:29", "modifiedDate": "2025-04-23 06:38:29", "sortOrder": 1 }, { "id": 14, "setupRequirementId": 1, "setupRequirementOptionId": 8, "name": "d", "createdDate": "2025-04-23 23:29:27", "modifiedDate": "2025-04-23 23:29:27", "sortOrder": 3 } ] }, { "id": 10, "setupRequirementId": 18, "name": "newsetup", "description": null, "createdDate": "2025-04-23 23:34:00", "modifiedDate": "2025-04-23 23:34:00", "sortOrder": 3, "hasChoices": false, "minChoices": 1, "maxChoices": 0, "options": [ { "id": 15, "setupRequirementId": 18, "setupRequirementOptionId": 9, "name": "newsetup1", "createdDate": "2025-04-23 23:34:00", "modifiedDate": "2025-04-23 23:34:00", "sortOrder": 0 } ] } ] } ] } ``` {% endtab %} {% endtabs %} ### Example Request `getVenuePackage` ```javascript { "venueId": 1, "id": 1 } ``` ### Package Details | Property | Data Type | Description | | ------------------------ | ----------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | | id | integer | The unique identifier of the package | | name | string | The name of the package | | type | enum [PackageType](/venues/venuedata/get-venue-package-list#package-type) | Simple or Detailed | | minPax | integer | The minimum pax of the package | | maxPax | integer | The maximum pax of the package | | cost | float | The price of the package (depends on the "priceMethod" value) | | priceMethod | enum [PriceMethod](/venues/venuedata/get-venue-package-list#price-method) | The type of package price - per person or flat rate | | actualCost | float | The actual cost of the package | | actualCostExcludedTaxIds | array | The tax ids excluded from the actual cost | | smallDescription | string | A html formatted small description of the package | | largeDescription | string | A html formatted large description of the package | | marketplaceName | string | The name of the package displayed in marketplace booking engines | | isVisibleOnVenueSearch | boolean | Whether the package is visible on venue search | | createdDate | datetime | The date and time the package was created | | modifiedDate | datetime | The date and time the package was last modified. Does not include changes to the package items | | startDate | date | The date from which the package is available | | endDate | date | The date to which the package is available | | startTime | time | The time from which the package is available | | endTime | time | The time to which the package is available | | costcenters | array of [CostCenter](/venues/venuedata/get-venue-package-list#cost-center) | The cost centers to which the package applies. | | hasSessions | boolean | Whether the package has sessions | | spaceId | integer | The default space to be used for the package | | spaceLayoutId | integer | The default space layout to be used for the package | | spaceCustomLayoutName | string | Layout name for custom space layout | | sortOrder | integer | The order in which the package should be displayed | | excludedFromCommissions | boolean | Whether the package is excluded from commissions | | reduceRoomHireFirst | boolean | Whether to reduce room hire first when applying the package to bookings | | eventTypes | array | The marketplace event types to which the package applies. If empty, the package applies to all event types | | userGroupIds | array | The user groups to which the package applies. If empty, the package applies to all user groups | | hasLimitedStartTimes | boolean | Whether the package has limited start times | | limitedStartTimes | time | The limited start time of the package | | isAccommIncluded | boolean | Whether accommodation is included in the package. This is a legacy field and should not be used | | discountCampaignId | integer | The discount campaign to apply to the package | | costcentersDiscounts | array of [Cost Center Discounts](/venues/venuedata/get-venue-package-list#cost-center-discount) | The cost center discounts to apply to the package | | sessions | array | The list sessions that is setup in the package. see [Session](#session-details) | ### Session Details | Property | Data Type | Description | | --------------------- | --------- | ----------------------------------------------------------------------------------------------- | | id | integer | The unique identifier of the session | | name | string | The name of the session | | startTime | time | The start time of the session | | endTime | time | The end time of the session | | setupTime | time | The setup time of the session | | setdownTime | time | The setdown time of the session | | createdDate | datetime | The date and time the session was created | | modifiedDate | datetime | The date and time the session was last modified | | isOptional | boolean | Whether the session is optional | | spaceVenueId | integer | The id of the venue to which the space belongs (it can be different to the booking venueId) | | spaceId | integer | The default space to be used for the session | | spaceLayoutId | integer | The default layout to use for the selected space | | spaceCustomLayoutName | string | Layout Name for Custom space layout | | includeInPackage | boolean | Whether the session is included in the package | | tariffId | integer | The tariff id of the session | | roomHireType | integer | The room hire type of the session | | minSpendAmount | float | The minimum spend required for the room hire | | minSpendRevenueItems | array | An array of revenue items that override the venue setup | | overridePax | boolean | Whether the number of attendees of this session can exceed the space's max pax | | costcenterId | integer | The cost center id of the session | | amount | float | The amount of the session (only used if includeInPackage is set to false) | | excludedTaxIds | array | The tax component of the amount | | sortOrder | integer | The sort order of the package sessions | | sessionTypeId | integer | The id of the session type | | sessionStatusId | integer | The id of the session status | | beverages | array | Array of beverages in the session. See [Beverage](#beverage-package-details) | | menus | array | Array of menus in the session. See [Menu](#menu-details) | | products | array | Array of products in the session. See [Product](#product-details) | | resources | array | Array of resources in the session. See [Resource](#resource-details) | | setupRequirements | array | Array of setup requirements in the session. See [Setup Requirement](#setup-requirement-details) | ### Beverage Package Details | Property | Data Type | Description | | ----------------- | --------- | -------------------------------------------------------------------------- | | id | integer | The unique identifier of the beverage | | name | string | The name of the beverage | | beverageVenueId | integer | The id of the venue to which the beverage package belongs | | beverageId | integer | The id of the beverage package | | numHours | float | The number of hours the beverage package is available | | startTime | time | The start time of the beverage | | endTime | time | The end time of the beverage | | sameAsSessionTime | boolean | If this is true, then it copies start/end time based on session time | | itemsIds | array | The items of the beverage | | includeInPackage | boolean | Whether the beverage is included in the package | | costcenterId | integer | The cost center id of the beverage | | amount | float | The amount of the beverage (only used if includeInPackage is set to false) | | excludedTaxIds | array | The tax component of the amount | | createdDate | datetime | The date and time the beverage was created | | modifiedDate | datetime | The date and time the beverage was last modified | ### Menu Details | Property | Data Type | Description | | ----------------- | --------- | -------------------------------------------------------------------------------------------- | | id | integer | The unique identifier of the menu | | name | string | The name of the menu | | menuVenueId | integer | The id of the venue to which the menu (menuId) belongs | | menuId | integer | The id of the menu | | startTime | time | The start time of the menu | | endTime | time | The end time of the menu | | sameAsSessionTime | boolean | If this is true, then it copies start/end time based on session time | | includeInPackage | boolean | Whether the menu is included in the package | | costcenterId | integer | The cost center id of the menu | | amount | float | The amount of the menu (only used if includeInPackage is set to false) | | excludedTaxIds | array | The tax component of the amount | | createdDate | datetime | The date and time the menu was created | | modifiedDate | datetime | The date and time the menu was last modified | | items | array | List of menu items. See [Menu Item](#menu-item) | | groups | array | List of menu groups. See [Menu Group](#menu-group) | | costcenters | array | List of Cost Centers value when menu is multi cost.See [Menu Cost Center](#menu-cost-center) | #### Menu Item | Property | Data Type | Description | | ----------- | --------- | --------------------------------------------------------------------- | | inventoryId | integer | The inventory id of the item | | groupId | string | The group id to which item belongs. Empty when it belongs to no group | #### Menu Group | Property | Data Type | Description | | --------------- | --------- | ---------------------------------- | | idHash | string | The hash id of the group | | name | string | The name of the group | | marketplaceName | string | The marketplace name of the group | | minSelection | integer | The minimum selection of the group | | maxSelection | integer | The maximum selection of the group | | servingTime | time | The serving time of the group | ### Menu Cost Center | Property | Data Type | Description | | -------------- | --------- | ------------------------------------ | | id | integer | The cost center identifier | | value | float | The amount of the cost center | | excludedTaxIds | array | The tax ids excluded from the amount | ### Product Details | Property | Data Type | Description | | ---------------- | --------- | ------------------------------------------------------------------------- | | id | integer | The unique identifier of the product | | productId | integer | The product id from inventory | | includeInPackage | boolean | Whether the product is included in the package | | costcenterId | integer | The cost center id of the product | | amount | float | The amount of the product (only used if includeInPackage is set to false) | | excludedTaxIds | array | The tax component of the amount | | createdDate | datetime | The date and time the product was created | | modifiedDate | datetime | The date and time the product was last modified | ### Resource Details | Property | Data Type | Description | | ---------------- | --------- | -------------------------------------------------------------------------- | | id | integer | The unique identifier of the resource | | resourceVenueId | integer | The venue id of the resource | | resourceId | integer | The resource id | | quantity | integer | The quantity of the resource | | includeInPackage | boolean | Whether the resource is included in the package | | costcenterId | integer | The cost center id of the resource | | amount | float | The amount of the resource (only used if includeInPackage is set to false) | | excludedTaxIds | array | The tax component of the amount | | createdDate | datetime | The date and time the resource was created | | modifiedDate | datetime | The date and time the resource was last modified | ### Setup Requirement Details | Property | Data Type | Description | | ------------------ | ---------------------------------------------------------------------- | ------------------------------------------------------------------ | | id | integer | The unique identifier of the setup requirement | | setupRequirementId | integer | Related setup requirement id | | name | string | The name of the setup requirement | | description | string | The description of the session | | createdDate | datetime | The date and time the setup requirement was created | | modifiedDate | datetime | The date and time the setup requirement was last modified | | sortOrder | integer | The sort order of the session | | hasChoices | boolean | Whether the setup requirement has choices/options | | minChoices | integer | The minimum number of choices | | maxChoices | integer | The maximum number of choices | | options | array of [Setup Requirement Option](#setup-requirement-option-details) | The array of the setup requirement options when hasChoices is true | ### Setup Requirement Option Details | Property | Data Type | Description | | ------------------------ | --------- | ---------------------------------------------------------------- | | id | integer | The unique identifier of the setup requirement option | | setupRequirementId | integer | Related setup requirement id from inventory | | setupRequirementOptionId | integer | Related setup requirement option id from inventory | | name | string | The name of the setup requirement option | | createdDate | datetime | The date and time the setup requirement option was created | | modifiedDate | datetime | The date and time the setup requirement option was last modified | | sortOrder | integer | The sort order of the setup requirement option | Note: The api will only return maximum of 100 items for each type session, menu, beverage product, etc. # Booking Data # Convert Lead To Opportunity `POST` `[PlatformAddress]/api/1.0/venue?action=convertLeadToOpportunity` #### Request Body | Name | Type | Description | | ------- | ------- | ---------------------------------- | | leadId | integer | The unique identifier of lead | | venueId | integer | The unique venue id of opportunity | | stageId | integer | The stage of opportunity | {% tabs %} {% tab title="200 " %} ``` ``` {% endtab %} {% endtabs %} ### Returns | Property | Description | | -------- | ----------------------------------------------------------- | | success | Whether or not the lead was converted to opportunity or not | ### Throws | Code | Description | | -------------------- | ----------------------- | | Specific Code: 24227 | The request is empty | | Specific Code: 24228 | The lead does not exist | # Add or Update Opportunity `POST` `[PlatformAddress]/api/1.0/venue?action=addOrUpdateOpportunity` {% tabs %} {% tab title="200 " %} ``` { "success": true, "id": 755 } ``` {% endtab %} {% endtabs %} ### Opportunity | Property | Type | Required | Description | | -------------------- | ------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | id | integer | optional | The unique identifier of opportunity. A new opportunity will be created if this parameter is not present. | | venueId | integer | required | The unique id of the venue to which the opportunity belongs. | | name | string | optional | The name for the opportunity (Required when id is missing). | | description | string | optional | The description for the opportunity. | | companyId | integer | optional | The unique id of the company to assign to the opportunity. See [assigning a company/contact to the opportunity](#assigning-a-company-contact-to-the-opportunity). | | company | object | optional | The data array of company. See addOrUpdateCompany API in contact namespace for parameters. | | companyLeadContactId | integer | optional | The unique id of the company contact to assign to the opportunity See [assigning a company/contact to the opportunity](#assigning-a-company-contact-to-the-opportunity). | | contactId | integer | optional | The unique id of the contact to assign to the opportunity See [assigning a company/contact to the opportunity](#assigning-a-company-contact-to-the-opportunity). | | contact | object | optional | The data array of contact. See addOrUpdateContact API in contact namespace for parameters. | | qualityId | integer | optional | The unique id of the quality. | | industryId | integer | optional | The unique id of industry. | | sourceId | integer | optional | The unique id of source (Required when the ID parameter is missing) | | ownerUserId | integer | optional | The id of the sales person user assigned to the opportunity. The privileges of the user assigned to the api key may prevent this from being changed. | | typeId | integer | optional | The unique id of type (Required when id is missing). | | subtypeId | integer | optional | The unique id of the opportunity sub type (Required when type have sub types). | | stageId | integer | optional | The unique id of stage. | | stageReasonId | integer | optional | The unique stage reason id of opportunity. | | channelId | integer | optional | The unique id of channel. | | utmSource | string | optional | The source of the campaign. (only when adding) | | utmMedium | string | optional | What medium the campaign used/uses. (only when adding) | | utmCampaign | string | optional | The name of the campaign. (only when adding) | | utmTerm | string | optional | The Term of the campaign. (only when adding) | | utmContent | string | optional | Any content about the campaign. | | referralContactId | integer | optional | The contact Id of referral for "Referral Program" source. (Required when the source is Referral Program and referralContact parameter is missing) | | referralContact | object | optional | The data array of contact. See addOrUpdateContact API in contact namespace for parameters. | | referralCompanyId | integer | optional | The company Id of referral for "Referral Program" source. (Required when the source is Referral Program and referralCompany parameter is missing) | | referralCompany | object | optional | The data array of company. See addOrUpdateCompany API in contact namespace for parameters. | | confirmedQuoteId | integer | optional | The unique if of confirmed quote to which the opportunity belongs. | | confirmedQuoteStatus | integer | optional | The status of the confirmed quote to which the opportunity belongs. | | cancelledQuoteId | integer | optional | The unique id of cancelled quote to which the opportunity belongs. | | lostToCompetition | integer | optional | The unique id of lost reason. | | closedDate | date | optional | The close date of the opportunity. | | customFields | array | optional | The custom field values of the opportunity. A custom field value might be required depending on how it has been configured in the venue's account. See [Custom Field](#custom-field) | | externalUrls | array | optional | This is an array of External URL field objects of the opportunity (a maximum of 3 objects allowed). When set to null, it will remove all externalUrls from the opportunity. See [External Url](#external-url-field) | ### Custom Field A opportunity custom field is an object with the following details. | Property | Type | Required | Description | | ---------- | ------- | -------- | ------------------------------------------------------------------------------------- | | fieldId | integer | required | The unique id of the opportunity custom field | | fieldValue | mixed | required | The value of the opportunity custom field. Depends on the type of custom field value. | ### External URL Field An External URL field is an object with the following details. | Property | Type | Required | Description | | -------- | ------ | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | | ref | string | required | The unique reference key of the external URL | | url | string | optional | The url link (https) scheme eg. When the value is null, the external url record will be removed based on the provided reference key. | | label | string | optional | The label of the URL to display. | ### Special Considerations #### Assigning a company/contact to the opportunity The *contact type* of a opportunity is either a *company* **or** a *contact*. When *companyId* **or** *company* is present in the request then the *contact type* of the opportunity is set to *company*, and the *companyLeadContactId* **or** *contact* must be a contact that belongs to that company. Otherwise the *contact type* of the opportunity is set to *contact* and contactId can be any valid contact in the venue's account. If *contact* and *company* are present in request then it will link given contact to company. ### Example Request #### Add Opportunity ```javascript { "venueId": "107", "name": "Lead By API", "company" : { "businessName": "Business Name", "updateIfExists": true }, "contact" : { "firstName" : "First", "lastName" : "Last", "email" : "email8@email.com", "updateIfExists" : true }, "typeId": "18", "subtypeId": "2", "sourceId": "25", "stageId": "69", "industryId": "77", "stageReasonId": "127", "closedDate": "2017-05-05", "referralCompany": { "businessName": "Business", "primaryContact": { "firstName": "Test", "lastName": "Test", "email": "Test@gmail.com" } }, "referralContact": { "firstName": "Test", "lastName": "Test", "email": "Test@gmail.com" } } ``` #### Update Opportunity ```javascript { "id": 755, "venueId": "107", "name": "Updated Name" } ``` ### Returns | Property | Description | | -------- | ----------------------------------------------------- | | success | Whether or not the opportunity was added to the venue | | id | The unique id of the opportunity | ### Throws | Code | Description | | -------------------- | ----------------------------------- | | Specific Code: 24221 | The request is empty | | Specific Code: 24222 | The opportunity does not exist | | Specific Code: 24224 | The opportunity details are invalid | This call takes values for a opportunity, and either 1. Updates the values for that opportunity (after you have provided an id in the parameters), or 2. Adds the opportunity to the system (if the id parameter is missing) The result of this call will contain the status of the result (either true or false) and the opportunity identifier of the updated or newly # Get Booking Note: Section sessions, packages, additionalItems, beveragePackages, menus, resources, products and serviceFees are not published yet. `POST` `[PlatformAddress]/api/1.0/venue?action=getBooking` Get the details of a specific booking to which the user has access. #### Request Body | Name | Type | Description | | ---- | ------- | --------------------- | | id | integer | The id of the booking | {% tabs %} {% tab title="200 " %} ``` { "id": 36160, "venueId": 1, "code": "4EQBCB2CCW", "name": "Booking Test", "eventType": "Conference", "eventTypeId": 3, "eventSubTypeId": null, "companyId": 773, "company": { "id": 773, "businessName": "My Company Co." }, "contactId": 6892, "contact": { "id": 6892, "firstName": "Jon", "lastName": "A", "email": "john.a@b.com", "phone": "123" }, "isConfidential": false, "currentStatus": 2, "totalAmount": 131, "totalTaxAmount": 10.25, "amountOutstanding": 131, "accountTimezone": "Australia/Brisbane", "venueTimezone": "Australia/Brisbane", "createdDate": "2026-07-06 01:41:51 UTC", "modifiedDate": "2026-07-06 01:41:51 UTC", "lastModifiedDate": "2026-07-06 01:44:26 UTC", "bookingType": 1, "dateEventStart": "2026-03-31 00:00:00 UTC", "dateEventEnd": "2026-03-31 00:00:00 UTC", "convertedToTentative": "2026-07-06 01:41:51 UTC", "convertedToConfirmed": "", "convertedToCancelled": "", "convertedToProspectiveHold": "", "isAccommIncluded": false, "dateAccomStart": "", "dateAccomEnd": "", "focRoomsDenominator": 0, "maxNumFocRoomsPerDay": 0, "hasPackages": true, "decisionDate": "", "canBeMoved": false, "bookedById": 1, "beoNumbers": [], "isBeoFinalised": false, "beoFinalisedDate": "", "otaFolioRef": null, "accommCutOffDate": "", "accommReservationMethod": [], "accommCancellationDate": "", "accommChargingMethod": 0, "accommGuaranteeRequired": false, "accommExternalBlockId": "BLOCKID", "revenueTemplateId": null, "hasCommissions": false, "hasCommissionPaid": false, "agentCompanyId": 0, "agentCompany": null, "agentContactId": 0, "agentContact": null, "commissionAccommodationType": 2, "commissionAccommodation": null, "commissionSpaceType": 2, "commissionSpace": null, "commissionFoodType": 2, "commissionFood": 0, "commissionBeverageType": 2, "commissionBeverage": 0, "commissionAudioVisualType": 2, "commissionAudioVisual": null, "dailyRevenue": [ { "venueId": 1, "costcenterId": 1, "revenueDate": "2026-03-31", "totalAmount": 27.5, "totalDiscountAmount": 0, "totalTaxAmount": 2.5 }, { "venueId": 1, "costcenterId": 2, "revenueDate": "2026-03-31", "totalAmount": 26.25, "totalDiscountAmount": 0, "totalTaxAmount": 1.25 }, { "venueId": 1, "costcenterId": 3, "revenueDate": "2026-03-31", "totalAmount": 44, "totalDiscountAmount": 0, "totalTaxAmount": 4 }, { "venueId": 1, "costcenterId": 4, "revenueDate": "2026-03-31", "totalAmount": 27.5, "totalDiscountAmount": 0, "totalTaxAmount": 2.5 }, { "venueId": 1, "costcenterId": 5, "revenueDate": "2026-03-31", "totalAmount": 0, "totalDiscountAmount": 0, "totalTaxAmount": 0 } ], "packages": [ { "id": 7861, "bookingDate": "2026-03-31", "numberAttendees": 10, "price": 100, "createdDate": "2026-07-06 01:41:51 UTC", "modifiedDate": "2026-07-06 01:41:52 UTC", "totalAmount": 108.75, "totalDiscount": 0, "totalSurcharge": 0, "totalTaxAmount": 8.75, "priceMethod": 2, "costcenters": [ { "costcenterId": 1, "value": 25, "discount": 0, "surcharge": 0, "totalAmount": 27.5, "totalSurcharge": 0, "totalTaxAmount": 2.5, "taxDetails": [ { "id": 1, "tax": 2.5, "rateId": 0, "rateAmount": 10, "rateAmountType": 1 } ] }, { "costcenterId": 2, "value": 25, "discount": 0, "surcharge": 0, "totalAmount": 26.25, "totalSurcharge": 0, "totalTaxAmount": 1.25, "taxDetails": [ { "id": 1, "tax": 1.25, "rateId": 13, "rateAmount": 5, "rateAmountType": 1 } ] }, { "costcenterId": 3, "value": 25, "discount": 0, "surcharge": 0, "totalAmount": 27.5, "totalSurcharge": 0, "totalTaxAmount": 2.5, "taxDetails": [ { "id": 1, "tax": 2.5, "rateId": 0, "rateAmount": 10, "rateAmountType": 1 } ] }, { "costcenterId": 4, "value": 25, "discount": 0, "surcharge": 0, "totalAmount": 27.5, "totalSurcharge": 0, "totalTaxAmount": 2.5, "taxDetails": [ { "id": 1, "tax": 2.5, "rateId": 0, "rateAmount": 10, "rateAmountType": 1 } ] }, { "costcenterId": 5, "value": 0, "discount": 0, "surcharge": 0, "totalAmount": 0, "totalSurcharge": 0, "totalTaxAmount": 0, "taxDetails": [] } ], "taxDetails": [ { "id": 1, "tax": 7.5, "rateId": 0, "rateAmount": 10, "rateAmountType": 1 }, { "id": 1, "tax": 1.25, "rateId": 13, "rateAmount": 5, "rateAmountType": 1 } ], "smallDescription": "sdsd", "packageId": 7, "packageName": "Premium - Flat rate" } ], "sessions": [ { "id": 20261, "name": "Morning", "startDate": "2026-03-31", "endDate": "2026-03-31", "startTime": "15:00:00", "endTime": "17:00:00", "spaceVenueId": 1, "spaceId": 1, "spaceLayout": 0, "customLayoutName": "C", "tariffId": null, "cost": 0, "discount": 0, "surcharge": 0, "totalAmount": 0, "totalDiscount": 0, "totalSurcharge": 0, "totalTaxAmount": 0, "costcenterId": 0, "includeInPackage": true, "bookingPackageId": 7861, "beoNumbers": [], "createdDate": "2026-07-06 01:41:51 UTC", "modifiedDate": "2026-07-06 01:41:52 UTC", "taxDetails": [], "totalAttendees": 10, "projectedSpend": [] } ], "menus": [ { "id": 2742, "name": "Lunch", "menuVenueId": 1, "menuId": 1, "menuTypeCategory": 0, "sessionId": 20261, "cost": 0, "discount": 0, "surcharge": 0, "excludedTaxIds": [], "startDate": "2026-03-31", "endDate": "2026-03-31", "startTime": "08:00:00", "endTime": "20:00:00", "includeInPackage": true, "bookingPackageId": 7861, "createdDate": "2026-07-06 01:41:51 UTC", "modifiedDate": "2026-07-06 01:41:52 UTC", "costcenterId": 0, "totalAmount": 0, "totalDiscount": 0, "totalSurcharge": 0, "totalTaxAmount": 0, "taxDetails": [], "totalAttendees": 10, "costcenters": [] } ], "beveragePackages": [ { "id": 3191, "name": "Morning tea", "sessionId": 20261, "beverageVenueId": 1, "beverageId": 1, "cost": 0, "discount": 0, "surcharge": 0, "startDate": "2026-03-31", "endDate": "2026-03-31", "startTime": "08:00:00", "endTime": "20:00:00", "includeInPackage": true, "bookingPackageId": 7861, "createdDate": "2026-07-06 01:41:51 UTC", "modifiedDate": "2026-07-06 01:41:52 UTC", "costcenterId": 0, "totalAmount": 0, "totalDiscount": 0, "totalSurcharge": 0, "totalTaxAmount": 0, "taxDetails": [], "totalAttendees": 10, "smallDescription": "Morning maza", "marketplaceName": "Hourly Price" } ], "resources": [ { "id": 5713, "name": "Resource 1", "sessionId": 20261, "resourceVenueId": 1, "resourceId": 8, "cost": 0, "discount": 0, "surcharge": 0, "quantity": 10, "startDate": "2026-03-31", "endDate": "2026-03-31", "startTime": "15:00:00", "endTime": "17:00:00", "includeInPackage": true, "bookingPackageId": 7861, "createdDate": "2026-07-06 01:41:51 UTC", "modifiedDate": "2026-07-06 01:41:52 UTC", "costcenterId": 0, "totalAmount": 0, "totalDiscount": 0, "totalSurcharge": 0, "totalTaxAmount": 0, "taxDetails": [] }, { "id": 5714, "name": "Resource 2", "sessionId": 20261, "resourceVenueId": 76, "resourceId": 4, "cost": 0, "discount": 0, "surcharge": 0, "quantity": 1, "startDate": "2026-03-31", "endDate": "2026-03-31", "startTime": "15:00:00", "endTime": "17:00:00", "includeInPackage": false, "bookingPackageId": 7861, "createdDate": "2026-07-06 01:41:51 UTC", "modifiedDate": "2026-07-06 01:41:52 UTC", "costcenterId": 3, "totalAmount": 0, "totalDiscount": 0, "totalSurcharge": 0, "totalTaxAmount": 0, "taxDetails": [] } ], "products": [ { "id": 1597, "name": "Product", "sessionId": 20261, "productId": 13, "cost": 5, "discount": 0, "surcharge": 0, "quantity": 1, "includeInPackage": false, "bookingPackageId": 0, "createdDate": "2026-07-06 01:44:14 UTC", "modifiedDate": "2026-07-06 01:44:26 UTC", "costcenterId": 3, "totalAmount": 5.5, "totalDiscount": 0, "totalSurcharge": 0, "totalTaxAmount": 0.5, "taxDetails": [ { "id": 1, "tax": 0.5, "rateId": 0, "rateAmount": 10, "rateAmountType": 1 } ] } ], "additionalItems": [ { "id": 4066, "description": "Test Item", "quantity": 1, "totalCost": 10, "totalCostDiscount": 0, "totalCostSurcharge": 0, "actualCost": 0, "createdDate": "2026-07-06 01:42:21 UTC", "modifiedDate": "2026-07-06 01:42:21 UTC", "costcenterId": 3, "totalAmount": 11, "totalDiscount": 0, "totalSurcharge": 0, "totalTaxAmount": 1, "startDateTime": "", "endDateTime": "", "taxDetails": [ { "id": 1, "tax": 1, "rateId": 0, "rateAmount": 10, "rateAmountType": 1 } ], "dayTaxDetails": [] } ], "serviceFees": [ { "id": 31482, "refType": 3, "refId": 7861, "ref2Id": 0, "ref3Id": 0, "refDate": "2026-03-31", "refCostcenterId": 1, "amount": 1.25, "createdDate": "2026-07-06 01:41:52 UTC", "modifiedDate": "2026-07-06 01:41:54 UTC", "totalAmount": 1.25, "totalTaxAmount": 0, "taxDetails": [] }, { "id": 31484, "refType": 3, "refId": 7861, "ref2Id": 0, "ref3Id": 0, "refDate": "2026-03-31", "refCostcenterId": 2, "amount": 1.25, "createdDate": "2026-07-06 01:41:52 UTC", "modifiedDate": "2026-07-06 01:41:54 UTC", "totalAmount": 1.25, "totalTaxAmount": 0, "taxDetails": [] }, { "id": 31486, "refType": 3, "refId": 7861, "ref2Id": 0, "ref3Id": 0, "refDate": "2026-03-31", "refCostcenterId": 3, "amount": 1.25, "createdDate": "2026-07-06 01:41:52 UTC", "modifiedDate": "2026-07-06 01:41:54 UTC", "totalAmount": 1.25, "totalTaxAmount": 0, "taxDetails": [] }, { "id": 31488, "refType": 3, "refId": 7861, "ref2Id": 0, "ref3Id": 0, "refDate": "2026-03-31", "refCostcenterId": 4, "amount": 1.25, "createdDate": "2026-07-06 01:41:52 UTC", "modifiedDate": "2026-07-06 01:41:54 UTC", "totalAmount": 1.25, "totalTaxAmount": 0, "taxDetails": [] }, { "id": 31490, "refType": 9, "refId": 4066, "ref2Id": 0, "ref3Id": 0, "refDate": "2026-03-31", "refCostcenterId": 3, "amount": 0.5, "createdDate": "2026-07-06 01:42:22 UTC", "modifiedDate": "2026-07-06 01:42:22 UTC", "totalAmount": 0.5, "totalTaxAmount": 0, "taxDetails": [] }, { "id": 31498, "refType": 7, "refId": 1597, "ref2Id": 0, "ref3Id": 0, "refDate": "2026-03-31", "refCostcenterId": 3, "amount": 0.25, "createdDate": "2026-07-06 01:44:14 UTC", "modifiedDate": "2026-07-06 01:44:26 UTC", "totalAmount": 0.25, "totalTaxAmount": 0, "taxDetails": [] } ], "customFields": [ { "fieldId": 1, "displayName": "Small Text", "fieldValue": null }, { "fieldId": 5, "displayName": "Booking Field", "fieldValue": null }, { "fieldId": 8, "displayName": "Response Due Date", "fieldValue": null }, { "fieldId": 9, "displayName": "Decision Due Date", "fieldValue": null } ], "salesPersonUser": null, "bookedByUser": { "id": 1, "firstName": "John", "lastName": "Doe", "email": "john.doe@iv.com", "phone": "" }, "leadBccEmail": null, "foodBeveragePayableBy": 1, "totalAttendees": 10, "agent": null, "commissionByCostCentres": [ { "costcenterId": 1, "commission": 0 }, { "costcenterId": 2, "commission": 0 }, { "costcenterId": 3, "commission": 0 }, { "costcenterId": 4, "commission": 0 }, { "costcenterId": 5, "commission": 0 } ], "opportunityId": null, "hasCateringWebsite": false, "cateringWebsiteLogoId": null, "cateringWebsiteLogo": null, "cateringWebsiteBannerId": null, "cateringWebsiteBanner": null, "cateringWebsiteEventDesc": null, "cateringWebsiteEndNumDays": null, "externalUrls": [ { "ref": "sales-force", "url": "https://salesforce.com", "label": "Sales force" } ] } ``` {% endtab %} {% endtabs %} The result from this call will be the details of a specific booking to which the user has access. The unique booking identifier is required, for example {“id”:123} ### Example Request ``` { "id":3 } ``` ### Booking | Property | Type | Description | | --------------------------- | --------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | | id | integer | The unique identifier of the booking | | venueId | integer | The venue identifier of the booking | | code | string | A reference assigned to the booking by the venue (only unique within a single venue) | | name | string | The name of the booking | | eventType | string | The event type of the booking | | eventTypeId | integer | The event type id of the booking | | eventSubTypeId | integer | The event sub type id of the booking | | companyId | integer | The unique id of the company assigned to the booking | | company | [Company](#company) | The details of the company assigned to the booking | | contactId | integer | The unique id of the contact assigned to the booking | | contact | [Contact](#contact) | The details of the contact assigned to the booking | | isConfidential | boolean | Whether or not the booking is confidential | | currentStatus | enum | The current status of the booking. See [Status](#status) | | totalAmount | double | The total amount of the booking, including tax | | totalTaxAmount | double | The total tax of the booking | | amountOutstanding | double | The amount outstanding of the booking, including tax | | accountTimezone | [timezone](/development-reference/timezone-list) | The timezone of the account | | venueTimezone | [timezone](/development-reference/timezone-list) | The timezone of the venue | | createdDate | [timestamp](/development-reference/timestamp-format) | The date & time the booking was created | | modifiedDate | [timestamp](/development-reference/timestamp-format) | The date & time the booking was last modified | | lastModifiedDate | [timestamp](/development-reference/timestamp-format) | The last modified date & time the booking or its children like Accommodation, Package, Session, Additional Items, etc. | | dateEventStart | [timestamp](/development-reference/timestamp-format) | The start event date of the booking | | dateEventEnd | [timestamp](/development-reference/timestamp-format) | The end event date of the booking | | convertedToTentative | [timestamp](/development-reference/timestamp-format) | The date when booking converted to tentatvive | | convertedToConfirmed | [timestamp](/development-reference/timestamp-format) | The date when booking converted to confirmed | | convertedToCancelled | [timestamp](/development-reference/timestamp-format) | The date when booking converted to cancelled | | isAccommIncluded | boolean | Whether or not the booking includes accommodation | | dateAccomStart | [timestamp](/development-reference/timestamp-format) | The start accommodation date of the booking | | dateAccomEnd | [timestamp](/development-reference/timestamp-format) | The end accommodation date of the booking | | focRoomsDenominator | int | The number of accommodation rooms in which one room is complimentary. For example if the value is 5, then 1 in 5 accommodation rooms will be complimentary. | | maxNumFocRoomsPerDay | int | The maximum number of accommodation rooms per day that can be complimentary | | hasPackages | boolean | Whether or not the booking has packages | | decisionDate | [timestamp](/development-reference/timestamp-format) | The date before which the event/accommodation dates must be decided | | canBeMoved | boolean | Whether or not the event/accommodation dates of the booking are flexible | | bookedById | integer | The unique id of the event coordinator user assigned to the booking | | beoNumbers | array | The id/numbers for the BEO documents assigned to the booking | | isBeoFinalised | boolean | Whether or not the BEO of the booking has been finalised | | beoFinalisedDate | [timestamp](/development-reference/timestamp-format) | The date & time on which the BEO of the booking was finalised | | accommReservationMethod | [Reservation Method](/venues/getoraddbookingdata/add-or-update-booking#accommodation-reservation-methods) | optional | | otaFolioRef | string | The recorded Folio ID of a booking. | | accommCutOffDate | [timestamp](/development-reference/timestamp-format) | After this date no more reservations may be made against the Block for the entire date range. | | accommCancellationDate | [timestamp](/development-reference/timestamp-format) | The last date a customer can cancel their Group Accommodation without financial penalty. | | accommChargingMethod | enum ([Charging Method](#get-booking.md#charging-method)) | A record of the Charging Method for Documents, Note that values will still need to be altered in the Block. | | accommGuaranteeRequired | boolean | Indicates whether the customer is required to guarantee their reservation with a credit card. | | accommExternalBlockId | string | The Block ID from an external PMS. | | hasCommissions | boolean | Whether or not the booking has commissions | | hasCommissionPaid | boolean | The commission has been paid for the Booking | | agentCompanyId | integer | The id of the revenue template applied to the booking | | agentCompany | [Company](#company) | The details of the agent company assigned to the booking | | agentContactId | integer | The id of the revenue template applied to the booking | | agentContact | [Contact](#contact) | The details of the agent contact assigned to the booking | | commissionAccommodationType | integer | The [Commission Type](#commission-type) for accommodation | | commissionAccommodation | double | The amount of commission for accommodation | | commissionSpaceType | integer | The [Commission Type](#commission-type) for space | | commissionSpace | double | The amount of commission for space | | commissionFoodType | integer | The [Commission Type](#commission-type) for food | | commissionFood | double | The amount of commission for food | | commissionBeverageType | integer | The [Commission Type](#commission-type) for beverage | | commissionBeverage | double | The amount of commission for beverage | | commissionAudioVisualType | integer | The [Commission Type](#commission-type) for audio visual | | commissionAudioVisual | double | The amount of commission for audio visual | | dailyRevenue | Array of [DailyRevenue](#daily-revenue) | The daily revenue data of booking | | packages | Array of [Package](#package) | The list of packages of the booking | | sessions | Array of [Session](#session) | The list of sessions of booking | | menus | Array of [Menu](#menu) | The list of menus of the booking | | beveragePackages | Array of [Beverage Package](#beverage-package) | The list of beverage packages of the booking | | resources | Array of [Resource](#resource) | The list of resources of the booking | | products | Array of [Product](#product) | The list of products of the booking | | additionalItems | Array of [Additional Item](#additional-item) | The list of additional items of the booking | | serviceFees | Array of [Service Fees](#service-fee) | The list of service fee applied to different items of the booking | | salesPersonUser | Array of [Sales Person](#sales-person) | The details of sales Person in the booking | | bookedByUser | Array of [Booked By](#booked-by) | The details of the user that created the booking | | leadBccEmail | string | The email address that can be used to record emails against this lead | | foodBeveragePayableBy | enum ([Food Beverage Payable By](#food-beverage-payableby)) | The Food and Beverage can be payable by | | totalAttendees | integer | The total number of attendees for the booking | | hasCommissions | boolean | The booking pay comissions to an agent | | hasCommissionPaid | boolean | The commission has been paid for the booking | | agent | Array of [Agent](#agent) | The details of the agent in the booking | | commissionByCostCentres | Array of [Commission By Cost Centres](#commission-by-cost-centres) | The commission amount by Cost Centres in the Booking | | bookingType | enum ([Booking Types](#booking-types)) | The type of Booking selected for the Booking | | opportunityId | integer | The id of the Opportunity for the Booking | | hasCateringWebsite | boolean | Whether or not the catering website is enabled for the booking | | cateringWebsiteLogoId | string | The catering website logo for the booking | | cateringWebsiteLogo | [File](#file) | The catering website logo for the booking | | cateringWebsiteBannerId | string | The catering website banner for the booking | | cateringWebsiteBanner | [File](#file) | The catering website banner for the booking | | cateringWebsiteEventDesc | string | The catering website event description for the booking | | cateringWebsiteEndNumDays | integer | The catering website end num days from event start for the booking | | externalUrls | Array of [ExternalUrl](#external-url-field) | This is an array of External URL field objects of the booking. | ### File | Property | Type | Description | | ---------------- | ------- | ------------------------ | | id | integer | The file identifier | | accountId | integer | The account id of a file | | originalFileName | string | The original file name | | size | integer | Size of the file | | tags | array | Tags related to the file | | contentType | string | Content type of the file | | url | string | Url of the file | ### Status One of the following values: | # | Description | | - | ---------------- | | 1 | Prospective | | 2 | Tentative | | 3 | Confirmed | | 4 | Cancelled | | 5 | Ordering | | 8 | Not Accepted | | 9 | Prospective Hold | ### Daily Revenue | Property | Type | Description | | ------------------- | ------------------------------------------ | --------------------------------------------------------------------- | | venueId | integer | The unique identifier of the venue to which the cost center belongs | | costcenterId | integer | The unique identifier of the cost center to which the revenue applies | | revenueDate | [Date](/development-reference/date-format) | The date on which the revenue applies | | totalAmount | double | The total revenue amount, including tax | | totalDiscountAmount | number | The amount of total discount | | totalTaxAmount | double | The total tax amount that is included in the total revenue amount | ### Company | Property | Type | Description | | ------------ | ------- | ------------------------------------ | | id | integer | The unique identifier of the company | | businessName | integer | The business name of the company | ### Contact | Property | Type | Description | | --------- | ------- | ------------------------------------ | | id | integer | The unique identifier of the contact | | firstName | string | The first name of the contact | | lastName | string | The last name of the contact | | email | string | The email address of the contact | | phone | string | The phone number of the contact | ### Package | Property | Type | Description | | ---------------- | ---------------------------------------------------- | ---------------------------------------------------------------------- | | id | integer | The unique identifier for the booking package | | bookingDate | [Date](/development-reference/date-format) | The date of the package | | numberAttendees | integer | The number of attendees for the booking package | | price | double | The price of the booking package | | createdDate | [timestamp](/development-reference/timestamp-format) | The date and time when the booking package was added to this booking | | modifiedDate | [timestamp](/development-reference/timestamp-format) | The date and time when the booking package was last modified | | totalAmount | double | The total amount of the booking package including tax amount | | totalDiscount | double | The total amount of the discount | | totalSurcharge | double | The total amount of the surcharge | | totalTaxAmount | double | The tax amount of the booking package | | priceMethod | enum ([Package Price Method](#package-price-method)) | The price method of the booking package | | costcenters | Array of [Package Cost Centre](#package-cost-center) | The list of costcenter and its individual value of the booking package | | taxDetails | Array of [Tax Detail](#tax-detail) | Individual tax details | | smallDescription | string | The small description of the booking package | | packageId | string | The id of the venue package | | packageName | string | The name of the venue package | ### Package Price Method | Value | Description | | ----- | ----------- | | 1 | Per Person | | 2 | Flat Rate | ### Package Cost Center | Property | Type | Description | | -------------- | ---------------------------------- | ---------------------------------------- | | costcenterId | integer | The unique identifier of the cost center | | value | double | The amount of the cost center | | discount | double | The amount of the discount on value | | surcharge | double | The amount of the surcharge on value | | excludedTaxIds | array | The excluded tax identifiers | | totalAmount | double | The amount of the cost center | | totalSurcharge | double | The amount of the total surcharge | | totalTaxAmount | double | The total tax amount of the cost center | | taxDetails | Array of [Tax Detail](#tax-detail) | The individual tax amount | ### Session | Property | Type | Description | | ---------------- | ---------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | | id | integer | The unique identifier of the session | | name | string | The name of the session | | startDate | [Date](/development-reference/date-format) | The start date of the session | | endDate | [Date](/development-reference/date-format) | The end date of the session | | startTime | [Time](/development-reference/time-format) | The start time of the session | | endTime | [Time](/development-reference/time-format) | The end time of the session | | spaceVenueId | integer | The id of the venue to which the space (spaceId) belongs (it can be different to the booking's venueId) | | spaceId | integer | The space identifier booked by the session | | spaceLayout | integer | The space layout identifier of the session | | customLayoutName | string | The space layout name when space layout is custom | | cost | double | The cost of the session | | discount | double | The amount of the discount on cost | | totalAmount | double | The total amount of session including tax amount | | totalDiscount | double | The total amount of the discount | | totalSurcharge | double | The total amount of the surcharge | | totalTaxAmount | double | The tax amount of the session | | excludedTaxIds | array | The excluded tax identifiers of the session | | costcenterId | integer | The cost center identifier to which the session's revenue applies | | includeInPackage | boolean | Whether or not the booking session is included in booking package | | bookingPackageId | integer | The booking package identifier if the booking session is included in package | | beoNumbers | array | The id/numbers of the BEO documents assigned to the booking session | | createdDate | [timestamp](/development-reference/timestamp-format) | The date and time when the session was created | | modifiedDate | [timestamp](/development-reference/timestamp-format) | The date and time when the session was last modified | | taxDetails | Array of [Tax Detail](#tax-detail) | Individual tax details | | totalAttendees | integer | The minimum number of attendees for the Booking session | | projectedSpend | object | The [projected spend](/venues/getoraddbookingdata/get-booking-session-list#projected-spend) of the session | ### Menu | Property | Type | Description | | ---------------- | ---------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | | id | integer | The unique identifier of the menu | | name | string | The name of the menu | | menuVenueId | integer | The venue identifier to which the menu package belongs. This can be different than booking's venue id | | menuId | integer | The reference menu identifier in venue menus | | menuTypeCategory | integer ([Menu Category List](#menu-category)) | The reference menu category identifier in venue menus | | sessionId | integer | The session identifier to which this menu belongs | | cost | double | The cost of the menu | | discount | double | The amount of the discount on cost | | surcharge | double | The amount of the surcharge on cost | | excludedTaxIds | array | The excluded tax identifiers | | startDate | [Date](/development-reference/date-format) | The start date of the menu | | endDate | [Date](/development-reference/date-format) | The end date of the menu | | startTime | [Time](/development-reference/time-format) | The start time of the menu | | endTime | [Time](/development-reference/time-format) | The end time of the menu | | includeInPackage | boolean | Whether or not the menu is included in booking package | | bookingPackageId | integer | The booking package identifier if menu is included in package | | createdDate | [timestamp](/development-reference/timestamp-format) | The date and time the menu was created | | modifiedDate | [timestamp](/development-reference/timestamp-format) | The date and time the menu was last modified | | costcenterId | integer | The cost center identifier to which the revenue applies | | totalAmount | double | The total amount of the menu including tax | | totalDiscount | double | The total amount of the discount | | totalSurcharge | double | The total amount of the surcharge | | totalTaxAmount | double | The tax amount of the menu | | taxDetails | Array of [Tax Detail](#tax-detail) | Individual tax details | | totalAttendees | integer | The minimum number of attendees for the menu | | costcenters | array of [Costcenter](#costcenter) | optional | ### Beverage Package | Property | Type | Description | | ---------------- | ---------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | | id | integer | The unique identifier of the beverage package | | name | string | The name of the beverage package | | sessionId | integer | The session identifier to which this beverage package belongs | | beverageVenueId | integer | The venue identifier to which the beverage package belongs. This can be different than booking's venue id | | beverageId | integer | The reference beverage package identifier in venue beverage packages | | cost | double | The cost of the beverage package | | discount | double | The amount of the discount on cost | | surcharge | double | The amount of the surcharge on cost | | excludedTaxIds | array | The excluded tax identifiers | | startDate | [Date](/development-reference/date-format) | The start date of the beverage package | | endDate | [Date](/development-reference/date-format) | The end date of the beverage package | | startTime | [Time](/development-reference/time-format) | The start time of the beverage package | | endTime | [Time](/development-reference/time-format) | The end time of the beverage package | | includeInPackage | boolean | Whether or not the beverage package is included in booking package | | bookingPackageId | integer | The booking package identifier if beverage package is included in package | | createdDate | [timestamp](/development-reference/timestamp-format) | The date and time the beverage package was created | | modifiedDate | [timestamp](/development-reference/timestamp-format) | The date and time the beverage package was last modified | | costcenterId | integer | The cost center identifier to which the revenue applies | | totalAmount | double | The total amount of the beverage package including tax | | totalDiscount | double | The total amount of the discount | | totalSurcharge | double | The total amount of the surcharge | | totalTaxAmount | double | The tax amount of the beverage package | | taxDetails | Array of [Tax Detail](#tax-detail) | Individual tax details | | totalAttendees | integer | The minimum number of attendees for the beverage package | | smallDescription | double | The small description of the beverage package | | marketplaceName | double | The marketplace name of the beverage package | ### Resource | Property | Type | Description | | ---------------- | ---------------------------------------------------- | ------------------------------------------------------------------------------------------------- | | id | integer | The unique identifier of the resource | | name | string | The name of the resource | | sessionId | integer | The session identifier to which this resource belongs | | resourceVenueId | integer | The venue identifier to which the resource belongs. This can be different than booking's venue id | | resourceId | integer | The reference resource identifier in venue resources | | cost | double | The cost of the resource | | discount | double | The amount of the discount on cost | | surcharge | double | The amount of the surcharge on cost | | excludedTaxIds | array | The excluded tax identifiers | | quantity | integer | The quantity of the resource | | startDate | [Date](/development-reference/date-format) | The start date of the resource | | endDate | [Date](/development-reference/date-format) | The end date of the resource | | startTime | [Time](/development-reference/time-format) | The start time of the resource | | endTime | [Time](/development-reference/time-format) | The end time of the resource | | includeInPackage | boolean | Whether or not the resource is included in booking package | | bookingPackageId | integer | The booking package identifier if resource is included in package | | createdDate | [timestamp](/development-reference/timestamp-format) | The date and time the resource was created | | modifiedDate | [timestamp](/development-reference/timestamp-format) | The date and time the resource was last modified | | costcenterId | integer | The cost center identifier to which the revenue applies | | totalAmount | double | The total amount of the resource including tax | | totalDiscount | double | The total amount of the discount | | totalSurcharge | double | The total amount of the surcharge | | totalTaxAmount | double | The tax amount of the resource | | taxDetails | Array of [Tax Detail](#tax-detail) | Individual tax details | ### Product | Property | Type | Description | | ---------------- | ---------------------------------------------------- | ---------------------------------------------------------------- | | id | integer | The unique identifier of the product | | name | string | The name of the product | | sessionId | integer | The session identifier to which this product belongs | | productId | integer | The reference product identifier in venue products | | cost | double | The cost of the product | | discount | double | The amount of the discount on cost | | surcharge | double | The amount of the surcharge on cost | | excludedTaxIds | array | The excluded tax identifiers | | quantity | integer | The quantity of the product | | includeInPackage | boolean | Whether or not the product is included in booking package | | bookingPackageId | integer | The booking package identifier if product is included in package | | createdDate | [timestamp](/development-reference/timestamp-format) | The date and time the product was created | | modifiedDate | [timestamp](/development-reference/timestamp-format) | The date and time the product was last modified | | costcenterId | integer | The cost center identifier to which the revenue applies | | totalAmount | double | The total amount of the product including tax | | totalDiscount | double | The total amount of the discount | | totalSurcharge | double | The total amount of the surcharge | | totalTaxAmount | double | The tax amount of the product | | taxDetails | Array of [Tax Detail](#tax-detail) | Individual tax details | ### Additional Item | Property | Type | Description | | ------------------------ | ---------------------------------------------------- | ---------------------------------------------------------------------- | | id | integer | The list of additional items of the booking | | description | string | The description of the item | | quantity | double | The quantity of the item | | totalCost | double | The sale price of the item | | totalCostDiscount | double | The amount of the discount on totalCost | | totalCostSurcharge | double | The amount of the surcharge on totalCost | | totalCostExcludedTaxIds | array | The sale price excluded tax identifiers | | actualCost | double | The cost of the item | | actualCostExcludedTaxIds | array | The cost excluded tax identifiers | | createdDate | [timestamp](/development-reference/timestamp-format) | The date and time when the item was created | | modifiedDate | [timestamp](/development-reference/timestamp-format) | The date and time when the item was last modified | | costcenterId | integer | The cost center identifier to which the revenue applies | | totalAmount | double | The total amount of the item including tax amount | | totalDiscount | double | The total amount of the discount | | totalSurcharge | double | The total amount of the surcharge | | totalTaxAmount | double | The tax amount of the item | | startDateTime | [timestamp](/development-reference/timestamp-format) | The start date and time of the item | | endDateTime | [timestamp](/development-reference/timestamp-format) | The end date and time of item | | taxDetails | Array of [Tax Detail](#tax-detail) | Individual tax details | | dayTaxDetails | Array of [Day Tax Detail](#day-tax-detail) | The individual tax for each date. Empty when start date time is empty. | ### Service Fee | Property | Type | Description | | --------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------------- | | id | integer | The unique identifier of the applied service fee | | refType | enum ([Service Fee Reference Type](#service-fee-reference-types)) | The item reference type to which the service fee applies | | refId | integer | The first identifier for identifying reference item in the booking | | ref2Id | integer | The second identifier for identifying the reference item in the booking | | ref3Id | integer | The third identifier for identifying the reference item in the booking | | refDate | [Date](/development-reference/date-format) | The date on which the fee applies | | refCostcenterId | integer | The reference cost centre identifier to which the fee applies | | amount | double | The amount of the service fee without tax | | excludedTaxIds | array | The list of excluded tax ids | | createdDate | [timestamp](/development-reference/timestamp-format) | The date and time the product was created | | modifiedDate | [timestamp](/development-reference/timestamp-format) | The date and time the product was last modified | | totalAmount | double | The total amount of the service including tax | | totalTaxAmount | double | The tax amount of the service fee | | taxDetails | Array of [Tax Detail](#tax-detail) | Individual tax details | ### Tax Detail | Property | Type | Description | | -------------- | ------- | -------------------------------------------------------------------------------------------------------------------- | | id | integer | The unique identifier of tax in venue | | tax | double | The amount of tax applied | | rateId | integer | The identifier of the rate that overrided the default tax rate. Zero (0) when the default tax rate is not overridden | | rateAmount | double | The rate at which the tax was calculated | | rateAmountType | integer | The rate type of the tax. 1 = A percentage, 2 = An amount | ### Day Tax Detail | Property | Type | Description | | ---------- | ------------------------------------------ | ---------------------------------- | | date | [Date](/development-reference/date-format) | The day to which taxes applies | | taxDetails | Array of [Tax Detail](#tax-detail) | Individual tax details for the day | ### Service Fee Reference Types | Value | Description | Value of refId | Value of ref2Id | Value of ref3Id | | ----- | ---------------------------- | ------------------------------------------- | ---------------------------------------------- | --------------------------------------------------- | | 1 | Booking Accommodation | Booking Accommodation Identifier | | | | 2 | Booking Accommodation Option | Booking Accommodation Identifier | Booking Accommodation Option Id (roomOptionId) | Booking Accommodation Option Number (roomOptionNum) | | 3 | Package | Booking Package Identifier | | | | 4 | Session | Booking Session Identifier | | | | 5 | Menu / Food | Booking Session Menu Identifier | | | | 6 | Beverage Package | Booking Session Beverage Package Identifier | | | | 7 | Product | Booking Session Product Identifier | | | | 8 | Resource | Booking Session Resource Identifier | | | | 9 | Additional Item | Booking Additional Item Identifier | | | | 11 | Service | Booking Service Identifier | | | ### Commission By Cost Centres | Property | Type | Description | | ------------ | ------- | ------------------------------------------------------- | | costcenterId | integer | The cost center identifier to which the revenue applies | | commission | integer | The commission amount by Cost Centres in the Booking | ### Booking Types One of the following values: | # | Description | | - | ------------------ | | 3 | Simple | | 1 | Detailed | | 4 | Accommodation Only | ### Food Beverage Payable By One of the following values: | # | Description | | - | -------------- | | 1 | Master Account | | 2 | Guests | ### Sales Person | Property | Type | Description | | --------- | ------- | ----------------------------------------- | | id | integer | The unique identifier of the sales person | | firstName | string | The first name of the sales person | | lastName | string | The last name of the sales person | | email | string | The email address of the sales person | | phone | string | The phone number of the sales person | ### Booked By | Property | Type | Description | | --------- | ------- | ----------------------------------------- | | id | integer | The unique identifier of the co-ordinator | | firstName | string | The first name of the co-ordinator | | lastName | string | The last name of the co-ordinator | | email | string | The email address of the co-ordinator | | phone | string | The phone number of the co-ordinator | ### Agent | Property | Type | Description | | ------------ | ------- | ------------------------------------ | | id | integer | The unique identifier of the company | | businessName | integer | The business name of the company | | email | string | The email address of the company | | phone | string | The phone number of the company | ### Menu Category | Id | Name | | -- | ---------------- | | 1 | Breakfast | | 2 | Lunch | | 3 | Dinner | | 4 | Coffee Break | | 5 | Reception | | 6 | Outside Catering | ### Costcenter | Property | Type | Required | Description | | --------------------------- | -------- | ----------------- | ----------------------------------------------------------------- | | costcenterId | integer | required | The id of costcenter | | costPerPerson | double | required | The cost per person value of a costcenter | | costPerPersonExcludedTaxIds | optional | array of integers | The excluded cost tax ids applied to the price of this costcenter | ### External URL Field An External URL field is an object with the following details. | Property | Type | Description | | -------- | ------ | ----------------------------------------------------- | | ref | string | The unique reference key of the external URL | | url | string | The url link (https) scheme eg. | | label | string | The label of the URL to display. | ### Commission Type One of the following values: | # | Description | | - | ----------- | | 1 | Fixed | | 2 | Percentage | # Get Booking List `POST` `[PlatformAddress]/api/1.0/venue?action=getBookingList` Get a list of bookings. #### Request Body | Name | Type | Description | | ------- | ------- | ---------------------------------------------- | | venueId | integer | The id of the venue | | perPage | integer | The number of bookings to get in a single call | {% tabs %} {% tab title="200 " %} ``` { "meta": { "totalResults": 256, "start": 0, "perPage": 1, "count": 1 }, "results": [ { "id": 1, "venueId": 1, "leadId": 2, "code": "HR5ZASGMQ1", "name": "Some Booking", "eventType": "Holiday", "eventTypeId": 3, "eventSubTypeId": 5, "companyId": 4, "company": { "id": 4, "businessName": "Some Business" }, "contactId": 3, "contact": { "id": 3, "firstName": "Quamar", "lastName": "Boyer", "email": "faly@gmail.com", "phone": "+247-92-9848064" }, "isConfidential": false, "currentStatus": 3, "totalAmount": 105, "totalTaxAmount": 5, "amountOutstanding": -425.3, "accountTimezone": null, "venueTimezone": null, "createdDate": "2015-01-07 09:21:53 UTC", "modifiedDate": "2016-04-06 07:51:56 UTC", "lastModifiedDate": "2016-04-08 07:50:00 UTC", "bookingType": 1, "dateEventStart": "2015-06-01 00:00:00 UTC", "dateEventEnd": "2015-06-04 00:00:00 UTC", "convertedToTentative": "2016-02-23 00:00:00 UTC", "convertedToConfirmed": "2016-03-05 12:49:31 UTC", "convertedToCancelled": "2016-02-28 00:00:00 UTC", "isAccommIncluded": true, "dateAccomStart": "2015-06-01 00:00:00 UTC", "dateAccomEnd": "2015-06-27 00:00:00 UTC", "focRoomsDenominator": 5, "maxNumFocRoomsPerDay: 2, "hasPackages": true, "decisionDate": "", "canBeMoved": false, "bookedById": 123, "beoNumbers": ["11-1", "12-1", "13-2"], "isBeoFinalised": true, "beoFinalisedDate": "2015-02-09 03:37:39 UTC", "otaFolioRef": "ven1234", "accommCutOffDate": "2019-12-04 00:00:00 UTC", "accommCancellationDate": "2019-01-11 00:00:00 UTC", "accommChargingMethod": 2, "accommGuaranteeRequired": false, "accommExternalBlockId": "test 123", } ] } ``` {% endtab %} {% endtabs %} The result from this call will be a [collection](/getting-started/interpreting-the-response/collections) of all the events the user has access to. This call also accepts the [pagination](/getting-started/interpreting-the-response/pagination) and [filter](/getting-started/interpreting-the-response/filtering) properties. ### Example Request `Get a specific venue’s Booking List` ```javascript { "venueId": "1", "perPage": 1 } ``` ### currentStatus: One of the following values: * 1 = Prospective * 2 = Tentative * 3 = Confirmed * 4 = Cancelled * 5 = Ordering * 8 = Not Accepted ### Additional [Filter](/getting-started/interpreting-the-response/filtering) Properties | Property | Description | Type | | | ------------------ | ------------------------------ | ---------------------------------------------------------------- | - | | companyId | Filter by unique id of company | integer | | | contactId | Filter by unique id of contact | integer | | | modifiedDateBefore | Filter by Modified Date | [iVvy Timestamp Format](/development-reference/timestamp-format) | | | modifiedDateAfter | Filter by Modified Date | [iVvy Timestamp Format](/development-reference/timestamp-format) | | --- [Next Page](/llms-full.txt/1)