Bookings
Get one Booking
Retrieve a single Booking record by its Id.
GET
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
Resource Id.
Resource name.
Resource allocation.
Resource hidden in calendar.
Resource No Return Policy.
Resource No Return Policy All Resources.
Resource No Return Policy All Users.
Resource type ID.
Resource type name.
Floor Plan Desk Id.
Floor plan desk name.
Coworker Id.
Coworker Coworker Type.
Coworker full name.
Coworker Mobile Phone.
Coworker Land Line.
Coworker billing name.
Coworker company name.
Coworker team names.
Extra Service Id.
Extra service name.
Booking start time.
Booking end time.
Notes.
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.
Last Notification Time.
Google Calendar Id.
Google Event Id.
Office365Event Id.
Public Google Event Id.
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.
Repeat Series Unique Id.
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.
Reminded.
Mrm Reminded.
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.
Kisi Key Id.
Start Scheduled Job Id.
End Scheduled Job Id.
Billed.
From Time Local.
To Time Local.
Invoice Date Local.
Coworker invoice ID.
Coworker invoice number.
Coworker invoice paid.
Coworker Invoice Draft.
Coworker Invoice Void.
Coworker Invoice Credit Note.
Coworker Extra Service Ids.
Coworker Extra Service Price.
Coworker Extra Service Currency Code.
Coworker Extra Service Charge Period.
Coworker Extra Service Total Uses.
Include Zoom invite.
Zoom Event Data.
Checked in at time.
Cancel if not paid.
Cancel if not checked in.
Maximum occupancy.
Last Minute Price Adjustment.
Dynamic Price Adjustment.
Price Factor Last Minute.
Price Factor Demand.
Office365Admin Event Id.
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