Get Booking

Note: Section sessions, packages, additionalItems, beveragePackages, menus, resources, products and serviceFees are not published yet.

Get Booking

POST [PlatformAddress]/api/1.0/venue?action=getBooking

Get the details of a specific booking to which the user has access.

Path Parameters

Name
Type
Description

id

integer

The id of the booking

{
  "id": 3,
  "venueId": 1,
  "code": "123a",
  "name": "Ava Donovan",
  "eventType": "Holiday",
  "eventTypeId": 2,
  "companyId": null,
  "company": null,
  "contactId": null,
  "contact": null,
  "isConfidential": false,
  "currentStatus": 3,
  "totalAmount": 2600,
  "totalTaxAmount": 0,
  "amountOutstanding": 2600,
  "accountTimezone": "Australia/Brisbane",
  "venueTimezone": "Australia/Brisbane",
  "createdDate": "2015-01-21 09:50:49 UTC",
  "modifiedDate": "2016-04-06 07:51:56 UTC",
  "lastModifiedDate": "2016-04-09 07:50:51 UTC",
  "dateEventStart": "1996-02-19 00:00:00 UTC",
  "dateEventEnd": "2002-11-06 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": false,
  "dateAccomStart": "",
  "dateAccomEnd": "",
  "focRoomsDenominator": 0,
  "maxNumFocRoomsPerDay: 0,
  "hasPackages": true,
  "decisionDate": "",
  "canBeMoved": false,
  "bookedById": 123,
  "beoNumbers": ["18-1", "19-1", "20-1"],
  "isBeoFinalised": false,
  "beoFinalisedDate": "",
  "otaFolioRef": "ven1234",
  "accommReservationMethod": [
        1,
        2,
        3
  ],
  "accommCutOffDate": "2019-12-04 00:00:00 UTC",
  "accommCancellationDate": "2019-01-11 00:00:00 UTC",
  "accommChargingMethod": 2,
  "accommGuaranteeRequired": false,
  "accommExternalBlockId": "test 123",
  "dailyRevenue": [
    {
      "venueId": 1,
      "costcenterId": 1276,
      "revenueDate": "2015-09-04",
      "totalAmount": 900,
      "totalDiscountAmount": 100,
      "totalTaxAmount": 81.818
    },
    {
      "venueId": 1,
      "costcenterId": 1277,
      "revenueDate": "2015-09-04",
      "totalAmount": 900,
      "totalDiscountAmount": 100,
      "totalTaxAmount": 81.818
    },
    {
      "venueId": 1,
      "costcenterId": 1278,
      "revenueDate": "2015-09-04",
      "totalAmount": 900,
      "totalDiscountAmount": 100,
      "totalTaxAmount": 81.818
    },
    {
      "venueId": 1,
      "costcenterId": 1279,
      "revenueDate": "2015-09-04",
      "totalAmount": 900,
      "totalDiscountAmount": 100,
      "totalTaxAmount": 81.818
    },
    ...
  ],
  "packages": [
    {
      "id": 5082,
      "bookingDate": "2018-12-30",
      "numberAttendees": 30,
      "price": 40,
      "createdDate": "2018-11-07 03:56:35 UTC",
      "modifiedDate": "2018-11-07 03:56:35 UTC",
      "totalAmount": 1200,
      "totalDiscount": 100,
      "totalTaxAmount": 109.091,
      "priceMethod": 1,
      "costcenters": [
        {
          "costcenterId": 2,
          "value": 10,
          "excludedTaxIds": [],
          "totalAmount": 300,
          "totalDiscount": 100,
          "totalTaxAmount": 27.272727,
          "taxDetails": [
            {
              "id": 1,
              "tax": 27.272727,
              "rateId": 0,
              "rateAmount": 0,
              "rateAmountType": 0
            }
          ]
        },
        {
          "costcenterId": 3,
          "value": 10,
          "excludedTaxIds": [],
          "totalAmount": 300,
          "totalDiscount": 100,
          "totalTaxAmount": 27.272727,
          "taxDetails": [
            {
              "id": 1,
              "tax": 27.272727,
              "rateId": 0,
              "rateAmount": 0,
              "rateAmountType": 0
            }
          ]
        },
        {
          "costcenterId": 4,
          "value": 10,
          "excludedTaxIds": [],
          "totalAmount": 300,
          "totalDiscount": 100,
          "totalTaxAmount": 27.272727,
          "taxDetails": [
            {
              "id": 1,
              "tax": 27.272727,
              "rateId": 0,
              "rateAmount": 0,
              "rateAmountType": 0
            }
          ]
        },
        {
          "costcenterId": 5,
          "value": 10,
          "excludedTaxIds": [],
          "totalAmount": 300,
          "totalDiscount": 100,
          "totalTaxAmount": 27.272727,
          "taxDetails": [
            {
              "id": 1,
              "tax": 27.272727,
              "rateId": 0,
              "rateAmount": 0,
              "rateAmountType": 0
            }
          ]
        }
      ],
      "taxDetails": [
        {
          "id": 1,
          "tax": 109.091,
          "rateId": 0,
          "rateAmount": 0,
          "rateAmountType": 0
        }
      ],
      "smallDescription": "Package Small Description"
    }
  ],
  "sessions": [
    {
      "id": 13185,
      "name": "Computer Graphics",
      "startDate": "2018-12-30",
      "endDate": "2018-12-30",
      "startTime": "10:00:00",
      "endTime": "11:00:00",
      "spaceVenueId": 1,
      "spaceId": 2,
      "spaceLayout": null,
      "customLayoutName": "Custom",
      "tariffId": 50,
      "cost": 50,
      "discount": 5,
      "totalAmount": 50,
      "totalDiscount": 10,
      "totalTaxAmount": 4.545,
      "excludedTaxIds": [],
      "costcenterId": 5,
      "includeInPackage": false,
      "bookingPackageId": 5082,
      "beoNumbers": ["19-1"],
      "createdDate": "2018-11-07 03:56:35 UTC",
      "modifiedDate": "2018-11-07 03:57:36 UTC",
      "taxDetails": [
        {
          "id": 1,
          "tax": 4.545,
          "rateId": 0,
          "rateAmount": 0,
          "rateAmountType": 0
        }
      ],
      "totalAttendees": 2000,
      "projectedSpend": [
        {
            "priceMethod": 1,
            "costcenterId": 1,
            "total": 5000,
            "amount": 100
        },
        {
            "priceMethod": 2,
            "costcenterId": 3,
            "total": 50,
            "amount": 50
        }
      ]
    }
  ],
  "menus": [
    {
      "id": 6686,
      "name": "Main Course",
      "menuVenueId": 1,
      "menuId": 3,
      "menuCategoryId": 3,
      "sessionId": 13185,
      "cost": 10,
      "discount": 5,
      "excludedTaxIds": [],
      "startDate": "2018-12-30",
      "endDate": "2018-12-30",
      "startTime": "10:00:00",
      "endTime": "11:00:00",
      "includeInPackage": false,
      "bookingPackageId": null,
      "createdDate": "2018-11-15 06:48:38 UTC",
      "modifiedDate": "2018-11-15 06:48:38 UTC",
      "costcenterId": 2,
      "totalAmount": 300,
      "totalDiscount": 10,
      "totalTaxAmount": 27.273,
      "taxDetails": [
        {
          "id": 1,
          "tax": 27.273,
          "rateId": 0,
          "rateAmount": 0,
          "rateAmountType": 0
        }
      ],
      "totalAttendees": 2000,
    }
  ],
  "beveragePackages": [
    {
      "id": 6204,
      "name": "Beverage Package 1",
      "sessionId": 13185,
      "beverageVenueId": 1,
      "beverageId": 2,
      "cost": 70,
      "discount": 5,
      "excludedTaxIds": [],
      "startDate": "2018-12-30",
      "endDate": "2018-12-30",
      "startTime": "10:00:00",
      "endTime": "11:00:00",
      "includeInPackage": false,
      "bookingPackageId": null,
      "createdDate": "2018-11-15 06:48:58 UTC",
      "modifiedDate": "2018-11-15 06:48:58 UTC",
      "costcenterId": 3,
      "totalAmount": 2100,
      "totalDiscount": 10,
      "totalTaxAmount": 190.909,
      "taxDetails": [
        {
          "id": 1,
          "tax": 190.909,
          "rateId": 0,
          "rateAmount": 0,
          "rateAmountType": 0
        }
      ],
      "totalAttendees": 2000,
    }
  ],
  "resources": [
    {
      "id": 6437,
      "name": null,
      "sessionId": 13185,
      "cost": 5,
      "discount": 5,
      "excludedTaxIds": [],
      "quantity": 1,
      "startDate": "2018-12-30",
      "endDate": "2018-12-30",
      "startTime": "10:00:00",
      "endTime": "11:00:00",
      "includeInPackage": false,
      "bookingPackageId": null,
      "createdDate": "2018-11-15 06:49:31 UTC",
      "modifiedDate": "2018-11-15 06:49:31 UTC",
      "costcenterId": 4,
      "totalAmount": 5,
      "totalDiscount": 10,
      "totalTaxAmount": 0.455,
      "taxDetails": [
        {
          "id": 1,
          "tax": 0.455,
          "rateId": 0,
          "rateAmount": 0,
          "rateAmountType": 0          ,
        }
      ]
    }
  ],
  "products": [
    {
      "id": 5305,
      "name": null,
      "sessionId": 13185,
      "cost": 100,
      "discount": 5,
      "excludedTaxIds": [],
      "quantity": 1,
      "includeInPackage": false,
      "bookingPackageId": null,
      "createdDate": "2018-11-15 06:49:57 UTC",
      "modifiedDate": "2018-11-15 06:49:57 UTC",
      "costcenterId": 4,
      "totalAmount": 100,
      "totalDiscount": 10,
      "totalTaxAmount": 9.091,
      "taxDetails": [
        {
          "id": 1,
          "tax": 9.091,
          "rateId": 0,
          "rateAmount": 0,
          "rateAmountType": 0
        }
      ]
    }
  ],
  "additionalItems": [
    {
      "id": 3935,
      "description": "Some Additional Item",
      "quantity": 1,
      "totalCost": 100,
      "totalCostDiscount": 10,
      "totalCostExcludedTaxIds": [
        3676
      ],
      "actualCost": 0,
      "actualCostExcludedTaxIds": [],
      "createdDate": "2018-11-15 07:18:17 UTC",
      "modifiedDate": "2018-11-16 01:15:05 UTC",
      "costcenterId": 4,
      "totalAmount": 100,
      "totalDiscount": 10,
      "totalTaxAmount": 9.091,
      "startDateTime": null,
      "endDateTime": null,
      "taxDetails": [
        {
          "id": 1,
          "tax": 9.091,
          "rateId": 0,
          "rateAmount": 0,
          "rateAmountType": 0
        }
      ],
      "dayTaxDetails": []
    },
    {
      "id": 3936,
      "description": "Another additional item",
      "quantity": 1,
      "totalCost": 110,
      "totalCostDiscount": 11,
      "totalCostExcludedTaxIds": [],
      "actualCost": 0,
      "actualCostExcludedTaxIds": [],
      "createdDate": "2018-11-15 07:19:59 UTC",
      "modifiedDate": "2018-11-15 07:19:59 UTC",
      "costcenterId": 4,
      "totalAmount": 110,
      "totalDiscount": 10,
      "totalTaxAmount": 10,
      "startDateTime": "2018-12-30 09:00:00",
      "endDateTime": "2019-01-01 10:00:00",
      "taxDetails": [
        {
          "id": 1,
          "tax": 9.999,
          "rateId": 0,
          "rateAmount": 0,
          "rateAmountType": 0
        }
      ],
      "dayTaxDetails": [
        {
          "date": "2018-12-30",
          "taxDetails": [
            {
              "id": 1,
              "tax": 3.333333,
              "rateId": 0,
              "rateAmount": 0,
              "rateAmountType": 0
            }
          ]
        },
        {
          "date": "2018-12-31",
          "taxDetails": [
            {
              "id": 1,
              "tax": 3.333333,
              "rateId": 0,
              "rateAmount": 0,
              "rateAmountType": 0
            }
          ]
        },
        {
          "date": "2019-01-01",
          "taxDetails": [
            {
              "id": 1,
              "tax": 3.333333,
              "rateId": 0,
              "rateAmount": 0,
              "rateAmountType": 0
            }
          ]
        }
      ]
    }
  ],
  "serviceFees": [
    {
      "id": 3262,
      "refType": 9,
      "refId": 3936,
      "ref2Id": 0,
      "ref3Id": 0,
      "refDate": "2018-12-30",
      "refCostcenterId": 4,
      "amount": 3.333333,
      "excludedTaxIds": [],
      "createdDate": "2018-11-15 07:27:36 UTC",
      "modifiedDate": "2018-11-20 00:15:09 UTC",
      "totalAmount": 3.666333,
      "totalTaxAmount": 0.333,
      "taxDetails": [
        {
          "id": 1,
          "tax": 0.333,
          "rateId": 0,
          "rateAmount": 0,
          "rateAmountType": 0
        }
      ]
    },
    {
      "id": 3264,
      "refType": 9,
      "refId": 3936,
      "ref2Id": 0,
      "ref3Id": 0,
      "refDate": "2018-12-31",
      "refCostcenterId": 4,
      "amount": 3.333333,
      "excludedTaxIds": [],
      "createdDate": "2018-11-15 07:27:36 UTC",
      "modifiedDate": "2018-11-20 00:15:09 UTC",
      "totalAmount": 3.666333,
      "totalTaxAmount": 0.333,
      "taxDetails": [
        {
          "id": 1,
          "tax": 0.333,
          "rateId": 0,
          "rateAmount": 0,
          "rateAmountType": 0
        }
      ]
    },
    {
      "id": 3266,
      "refType": 9,
      "refId": 3936,
      "ref2Id": 0,
      "ref3Id": 0,
      "refDate": "2019-01-01",
      "refCostcenterId": 4,
      "amount": 3.333333,
      "excludedTaxIds": [],
      "createdDate": "2018-11-15 07:27:36 UTC",
      "modifiedDate": "2018-11-20 00:15:09 UTC",
      "totalAmount": 3.666333,
      "totalTaxAmount": 0.333,
      "taxDetails": [
        {
          "id": 1,
          "tax": 0.333,
          "rateId": 0,
          "rateAmount": 0,
          "rateAmountType": 0
        }
      ]
    },
    {
      "id": 3271,
      "refType": 3,
      "refId": 5082,
      "ref2Id": 0,
      "ref3Id": 0,
      "refDate": "2018-12-30",
      "refCostcenterId": 2,
      "amount": 27.272727,
      "excludedTaxIds": [],
      "createdDate": "2018-11-15 07:27:36 UTC",
      "modifiedDate": "2018-11-20 00:15:09 UTC",
      "totalAmount": 29.999727,
      "totalTaxAmount": 2.727,
      "taxDetails": [
        {
          "id": 1,
          "tax": 2.727,
          "rateId": 0,
          "rateAmount": 0,
          "rateAmountType": 0
        }
      ]
    },
    {
      "id": 3272,
      "refType": 3,
      "refId": 5082,
      "ref2Id": 0,
      "ref3Id": 0,
      "refDate": "2018-12-30",
      "refCostcenterId": 3,
      "amount": 27.272727,
      "excludedTaxIds": [],
      "createdDate": "2018-11-15 07:27:36 UTC",
      "modifiedDate": "2018-11-20 00:15:09 UTC",
      "totalAmount": 29.999727,
      "totalTaxAmount": 2.727,
      "taxDetails": [
        {
          "id": 1,
          "tax": 2.727,
          "rateId": 0,
          "rateAmount": 0,
          "rateAmountType": 0
        }
      ]
    },
    {
      "id": 3273,
      "refType": 3,
      "refId": 5082,
      "ref2Id": 0,
      "ref3Id": 0,
      "refDate": "2018-12-30",
      "refCostcenterId": 4,
      "amount": 27.272727,
      "excludedTaxIds": [],
      "createdDate": "2018-11-15 07:27:36 UTC",
      "modifiedDate": "2018-11-20 00:15:09 UTC",
      "totalAmount": 29.999727,
      "totalTaxAmount": 2.727,
      "taxDetails": [
        {
          "id": 1,
          "tax": 2.727,
          "rateId": 0,
          "rateAmount": 0,
          "rateAmountType": 0
        }
      ]
    },
    {
      "id": 3274,
      "refType": 3,
      "refId": 5082,
      "ref2Id": 0,
      "ref3Id": 0,
      "refDate": "2018-12-30",
      "refCostcenterId": 5,
      "amount": 27.272727,
      "excludedTaxIds": [],
      "createdDate": "2018-11-15 07:27:37 UTC",
      "modifiedDate": "2018-11-20 00:15:09 UTC",
      "totalAmount": 29.999727,
      "totalTaxAmount": 2.727,
      "taxDetails": [
        {
          "id": 1,
          "tax": 2.727,
          "rateId": 0,
          "rateAmount": 0,
          "rateAmountType": 0
        }
      ]
    },
    {
      "id": 3275,
      "refType": 4,
      "refId": 13185,
      "ref2Id": 0,
      "ref3Id": 0,
      "refDate": "2018-12-30",
      "refCostcenterId": 5,
      "amount": 4.546,
      "excludedTaxIds": [],
      "createdDate": "2018-11-15 07:27:37 UTC",
      "modifiedDate": "2018-11-20 00:15:10 UTC",
      "totalAmount": 5.001,
      "totalTaxAmount": 0.455,
      "taxDetails": [
        {
          "id": 1,
          "tax": 0.455,
          "rateId": 0,
          "rateAmount": 0,
          "rateAmountType": 0
        }
      ]
    },
    {
      "id": 3276,
      "refType": 5,
      "refId": 6686,
      "ref2Id": 0,
      "ref3Id": 0,
      "refDate": "2018-12-30",
      "refCostcenterId": 2,
      "amount": 27.273,
      "excludedTaxIds": [],
      "createdDate": "2018-11-15 07:27:37 UTC",
      "modifiedDate": "2018-11-20 00:15:10 UTC",
      "totalAmount": 30,
      "totalTaxAmount": 2.727,
      "taxDetails": [
        {
          "id": 1,
          "tax": 2.727,
          "rateId": 0,
          "rateAmount": 0,
          "rateAmountType": 0
        }
      ]
    },
    {
      "id": 3277,
      "refType": 6,
      "refId": 6204,
      "ref2Id": 0,
      "ref3Id": 0,
      "refDate": "2018-12-30",
      "refCostcenterId": 3,
      "amount": 190.909,
      "excludedTaxIds": [],
      "createdDate": "2018-11-15 07:27:37 UTC",
      "modifiedDate": "2018-11-20 00:15:10 UTC",
      "totalAmount": 210,
      "totalTaxAmount": 19.091,
      "taxDetails": [
        {
          "id": 1,
          "tax": 19.091,
          "rateId": 0,
          "rateAmount": 0,
          "rateAmountType": 0
        }
      ]
    },
    {
      "id": 3278,
      "refType": 7,
      "refId": 5305,
      "ref2Id": 0,
      "ref3Id": 0,
      "refDate": "2018-12-30",
      "refCostcenterId": 4,
      "amount": 9.091,
      "excludedTaxIds": [],
      "createdDate": "2018-11-15 07:27:37 UTC",
      "modifiedDate": "2018-11-20 00:15:10 UTC",
      "totalAmount": 10,
      "totalTaxAmount": 0.909,
      "taxDetails": [
        {
          "id": 1,
          "tax": 0.909,
          "rateId": 2,
          "rateAmount": 6,
          "rateAmountType": 2
        }
      ]
    },
    {
      "id": 3279,
      "refType": 8,
      "refId": 6437,
      "ref2Id": 0,
      "ref3Id": 0,
      "refDate": "2018-12-30",
      "refCostcenterId": 4,
      "amount": 0.455,
      "excludedTaxIds": [],
      "createdDate": "2018-11-15 07:27:37 UTC",
      "modifiedDate": "2018-11-20 00:15:10 UTC",
      "totalAmount": 0.501,
      "totalTaxAmount": 0.046,
      "taxDetails": [
        {
          "id": 1,
          "tax": 0.046,
          "rateId": 1,
          "rateAmount": 5,
          "rateAmountType": 1
        }
      ]
    },
    "salesPersonUser": {
        "id": 1,
        "firstName": "Jack",
        "lastName": "Smith",
        "email": "jack@smith.com",
        "phone": 61482154689
    },
    "bookedByUser": {
        "id": 3,
        "firstName": "Oliver",
        "lastName": "Brown",
        "email": "oliver@brown.com",
        "phone": 61582154689
    },
    "leadBccEmail": "lead-1-111-6895d8@ivvy.com",
    "foodBeveragePayableBy": 1,
    "totalAttendees": 20,
    "hasCommissions": 1,
    "hasCommissionPaid": 1,
    "agent": {
        "id": 2,
        "businessName": "company Name",
        "email": "company@name.com",
        "phone": "+354-80-6090113"
    },
    "commissionByCostCentres": [
      {
        "costcenterId": 2,
        "commission": 31.7
      },
      {
        "costcenterId": 2,
        "commission": 1.7
      }
    ],
    "bookingType": 1,
    "opportunityId": 2,
  ]
}

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

companyId

integer

The unique id of the company assigned to the booking

company

The details of the company assigned to the booking

contactId

integer

The unique id of the contact assigned to the booking

contact

The details of the contact assigned to the booking

isConfidential

boolean

Whether or not the booking is confidential

currentStatus

enum

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

The timezone of the account

venueTimezone

The timezone of the venue

createdDate

The date & time the booking was created

modifiedDate

The date & time the booking was last modified

lastModifiedDate

The last modified date & time the booking or its children like Accommodation, Package, Session, Additional Items, etc.

dateEventStart

The start event date of the booking

dateEventEnd

The end event date of the booking

convertedToTentative

The date when booking converted to tentatvive

convertedToConfirmed

The date when booking converted to confirmed

convertedToCancelled

The date when booking converted to cancelled

isAccommIncluded

boolean

Whether or not the booking includes accommodation

dateAccomStart

The start accommodation date of the booking

dateAccomEnd

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

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

The date & time on which the BEO of the booking was finalised

accommReservationMethod

optional

otaFolioRef

string

The recorded Folio ID of a booking.

accommCutOffDate

After this date no more reservations may be made against the Block for the entire date range.

accommCancellationDate

The last date a customer can cancel their Group Accommodation without financial penalty.

accommChargingMethod

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.

dailyRevenue

The daily revenue data of booking

packages

The list of packages of the booking

sessions

The list of sessions of booking

menus

The list of menus of the booking

beveragePackages

The list of beverage packages of the booking

resources

The list of resources of the booking

products

The list of products of the booking

additionalItems

The list of additional items of the booking

serviceFees

The list of service fee applied to different items of the booking

salesPersonUser

The details of sales Person in the booking

bookedByUser

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

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

The details of the agent in the booking

commissionByCostCentres

The commission amount by Cost Centres in the Booking

bookingType

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

The catering website logo for the booking

cateringWebsiteBannerId

string

The catering website banner for the booking

cateringWebsiteBanner

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

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

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

The date of the package

numberAttendees

integer

The number of attendees for the booking package

price

double

The price of the booking package

createdDate

The date and time when the booking package was added to this booking

modifiedDate

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

The price method of the booking package

costcenters

The list of costcenter and its individual value of the booking package

taxDetails

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

The individual tax amount

Session

Property
Type
Description

id

integer

The unique identifier of the session

name

string

The name of the session

startDate

The start date of the session

endDate

The end date of the session

startTime

The start time of the session

endTime

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

The date and time when the session was created

modifiedDate

The date and time when the session was last modified

taxDetails

Individual tax details

totalAttendees

integer

The minimum number of attendees for the Booking session

projectedSpend

object

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

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

The start date of the menu

endDate

The end date of the menu

startTime

The start time of the menu

endTime

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

The date and time the menu was created

modifiedDate

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

Individual tax details

totalAttendees

integer

The minimum number of attendees for the menu

costcenters

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