Bookings
Get one Booking
Retrieve a single Booking record by its Id.
GET
Get one Booking
A Booking is a reservation for a specific
Resource and, optionally, for a customer (CoworkerId) and a desk or unit in the floor plan (FloorPlanDeskId).
Charging vs Invoicing — When a booking is charged (confusingly labelled Invoiced in the booking entity), a charge is posted to the customer account as a CoworkerExtraService with the calculated price. If the booking has no fixed rate (ExtraServiceId = null), Nexudus calculates the rate automatically based on the resource type, booking parameters and customer. A booking is actually invoiced when the CoworkerExtraService associated with it is invoiced.
InvoiceThisCoworker = truemeans the booking is charged to the customer making it rather than their paying member (if any).Tentativebookings must be approved by an administrator before being confirmed or charged. They still block the calendar.Onlinebookings are those made via the portal or the app.
RepeatBooking and all repeat-configuration fields (Repeats, RepeatEvery, RepeatUntil, RepeatOn*) are create-only. Once a booking series is created, only WhichBookingsToUpdate can be used to update or delete bookings in the series. No new bookings can be added to an existing series.
Pricing overrides — OverridePrice lets an admin set a fixed price for the booking, regardless of what extra service (rate) is associated with it.
Authentication
This endpoint requires OAuth2 authentication. Include a valid bearer token in the
Authorization header.
The authenticated user must be a full unrestricted administrator or have the Booking-Read role.Path Parameters
The Id of the Booking record to retrieve.
Code Examples
Response
200
ID of the resource linked to this record.
Resource name.
Resource allocation.
Resource hidden in calendar.
The resource no return policy value for this booking.
The resource no return policy all resources value for this booking.
The resource no return policy all users value for this booking.
Resource type ID.
Resource type name.
ID of the floor plan desk linked to this record.
Floor plan desk name.
ID of the coworker linked to this record.
The coworker coworker type value for this booking.
Coworker full name.
The coworker mobile phone value for this booking.
The coworker land line value for this booking.
Coworker billing name.
Coworker company name.
Coworker team names.
ID of the extra service linked to this record.
Extra service name.
Booking start time.
Booking end time.
Optional notes or comments about this booking.
Internal notes.
Charge immediately.
Invoice immediately.
Charge the booking to the customer making it rather than their paying member (if any).
Do not use booking credit.
Purchase order.
Discount code.
Date/time value for last notification time.
ID of the google calendar associated with this record.
ID of the google event associated with this record.
ID of the office365 event associated with this record.
ID of the public google event associated with this record.
Tentative booking. Must be approved by an administrator before confirmed or charged. Tentative bookings still block the calendar.
Whether the booking was made in the portal or the app.
Teams at the time of booking.
Tariff at the time of booking.
ID of the repeat series unique associated with this record.
Create a repeating booking series. Create-only: once created, only WhichBookingsToUpdate can be used to update the series. No new bookings can be added to the series.
Repeat cycle. Create-only. See
eBookingRepeatCycle enum values: 1 = Daily, 2 = Weekly, 3 = Monthly, 4 = Yearly, 5 = FirstOfMonth, 6 = SecondOfMonth, 7 = ThirdOfMonth, 8 = LastOfMonth, 9 = FourthOfMonth.Action to apply when updating or deleting bookings in a repeated series. This is the only field that can modify a series after creation. See
eRepeatedBookingUpdateAction enum values: 1 = UpdateThisBookingOnly, 2 = UpdateFutureBookingsOnly, 3 = UpdateAllBookings, 4 = UpdateNotChargedBookings, 5 = DeleteAllBookings, 6 = DeleteBookingsAfterThis, 7 = DeleteNotChargedBookings, 8 = RevertAllCharges.Repeat every N periods. Create-only.
Repeat until date. Create-only.
Repeat on Mondays. Create-only.
Repeat on Tuesdays. Create-only.
Repeat on Wednesdays. Create-only.
Repeat on Thursdays. Create-only.
Repeat on Fridays. Create-only.
Repeat on Saturdays. Create-only.
Repeat on Sundays. Create-only.
Whether reminded is enabled.
Whether mrm reminded is enabled.
Admin-set fixed price for the booking, regardless of what extra service (rate) is associated with it.
Whether the booking has been charged. When true, a charge (CoworkerExtraService) has been posted to the customer account. Note: the booking is actually invoiced when the associated CoworkerExtraService is invoiced.
Invoice date.
Booking number.
ID of the kisi key associated with this record.
ID of the start scheduled job associated with this record.
ID of the end scheduled job associated with this record.
Whether billed is enabled.
Date/time value for from time local.
Date/time value for to time local.
Date/time value for invoice date local.
Coworker invoice ID.
Coworker invoice number.
Coworker invoice paid.
Whether coworker invoice draft is enabled.
Whether coworker invoice void is enabled.
Whether coworker invoice credit note is enabled.
The coworker extra service ids value for this booking.
The coworker extra service price value for this booking.
The coworker extra service currency code value for this booking.
The coworker extra service charge period value for this booking.
The coworker extra service total uses value for this booking.
Include Zoom invite.
The zoom event data value for this booking.
Checked in at time.
Cancel if not paid.
Cancel if not checked in.
Maximum occupancy.
The last minute price adjustment value for this booking.
The dynamic price adjustment value for this booking.
The price factor last minute value for this booking.
The price factor demand value for this booking.
ID of the office365 admin event associated with this record.
Unique record identifier.
UUID of the record.
Date and time the record was created (ISO 8601).
Date and time the record was last updated (ISO 8601).
Email of the user who last updated this record.
Whether the record was recently created.
External system identifier.
Example Response
Get one Booking