Get one CancelledBooking

GET

api

spaces

cancelledbookings

{id}

Get one CancelledBooking

curl --request GET \
  --url https://spaces.nexudus.com/api/spaces/cancelledbookings/{id} \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/spaces/cancelledbookings/{id}"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/spaces/cancelledbookings/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "ResourceId": 123,
  "ResourceName": "<string>",
  "ResourceAllocation": 123,
  "ResourceHideInCalendar": true,
  "ResourceNoReturnPolicy": 123,
  "ResourceNoReturnPolicyAllResources": 123,
  "ResourceNoReturnPolicyAllUsers": 123,
  "ResourceResourceTypeId": 123,
  "ResourceResourceTypeName": "<string>",
  "FloorPlanDeskId": 123,
  "FloorPlanDeskName": "<string>",
  "CoworkerId": 123,
  "CoworkerCoworkerType": "<string>",
  "CoworkerFullName": "<string>",
  "CoworkerBillingName": "<string>",
  "CoworkerCompanyName": "<string>",
  "CoworkerTeamNames": "<string>",
  "ExtraServiceId": 123,
  "ExtraServiceName": "<string>",
  "FromTime": "<string>",
  "ToTime": "<string>",
  "Notes": "<string>",
  "InternalNotes": "<string>",
  "ChargeNow": true,
  "InvoiceNow": true,
  "InvoiceThisCoworker": true,
  "DoNotUseBookingCredit": true,
  "PurchaseOrder": "<string>",
  "DiscountCode": "<string>",
  "LastNotificationTime": "<string>",
  "GoogleCalendarId": "<string>",
  "GoogleEventId": "<string>",
  "Office365EventId": "<string>",
  "PublicGoogleEventId": "<string>",
  "Tentative": true,
  "Online": true,
  "TeamsAtTheTimeOfBooking": "<string>",
  "TariffAtTheTimeOfBooking": "<string>",
  "RepeatSeriesUniqueId": "<string>",
  "RepeatBooking": true,
  "Repeats": 123,
  "WhichBookingsToUpdate": 123,
  "RepeatEvery": 123,
  "RepeatUntil": "<string>",
  "RepeatOnMondays": true,
  "RepeatOnTuesdays": true,
  "RepeatOnWednesdays": true,
  "RepeatOnThursdays": true,
  "RepeatOnFridays": true,
  "RepeatOnSaturdays": true,
  "RepeatOnSundays": true,
  "Reminded": true,
  "MrmReminded": true,
  "OverridePrice": 123,
  "Invoiced": true,
  "InvoiceDate": "<string>",
  "BookingNumber": 123,
  "KisiKeyId": 123,
  "StartScheduledJobId": "<string>",
  "EndScheduledJobId": "<string>",
  "Billed": true,
  "FromTimeLocal": "<string>",
  "ToTimeLocal": "<string>",
  "InvoiceDateLocal": "<string>",
  "CoworkerInvoiceId": 123,
  "CoworkerInvoiceNumber": "<string>",
  "CoworkerInvoicePaid": true,
  "CoworkerInvoiceDraft": true,
  "CoworkerInvoiceVoid": true,
  "CoworkerInvoiceCreditNote": true,
  "CoworkerExtraServiceIds": "<string>",
  "CoworkerExtraServicePrice": 123,
  "CoworkerExtraServiceCurrencyCode": "<string>",
  "CoworkerExtraServiceChargePeriod": 123,
  "CoworkerExtraServiceTotalUses": 123,
  "IncludeZoomInvite": true,
  "ZoomEventData": "<string>",
  "CheckedInAt": "<string>",
  "CancelIfNotPaid": true,
  "CancelIfNotCheckedIn": true,
  "MaxOccupancy": 123,
  "LastMinutePriceAdjustment": 123,
  "DynamicPriceAdjustment": 123,
  "PriceFactorLastMinute": 123,
  "PriceFactorDemand": 123,
  "Office365AdminEventId": "<string>",
  "CancellationReason": 123,
  "CancelledOn": "<string>",
  "CancelledBy": "<string>",
  "CancellationReasonDetails": "<string>",
  "Price": 123,
  "OriginalBookingId": "<string>",
  "CoworkerCheckedInAt": "<string>",
  "CoworkerCheckedOutAt": "<string>",
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

A cancelled booking is the audit snapshot created when a resource reservation is cancelled, preserving its resource, customer, time, price, and cancellation reason for reporting.

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 CancelledBooking-Read role.

Path Parameters

integer

required

The Id of the CancelledBooking record to retrieve.

Code Examples

curl -X GET \
  "https://spaces.nexudus.com/api/spaces/cancelledbookings/87654321" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/spaces/cancelledbookings/87654321',
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const record = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/spaces/cancelledbookings/87654321',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

record = response.json()

Response

200

integer

ID of the resource that was reserved; it determines the cancelled booking’s location..

string

Display value for Resource.Name..

integer

Display value for Resource.Allocation..

boolean

Display value for Resource.HideInCalendar..

integer

Display value for Resource.NoReturnPolicy..

integer

Display value for Resource.NoReturnPolicyAllResources..

integer

Display value for Resource.NoReturnPolicyAllUsers..

integer

Display value for Resource.ResourceType.Id..

string

Display value for Resource.ResourceType.Name..

integer

Optional ID of the floor-plan unit assigned within the resource when the booking was cancelled..

string

Display value for FloorPlanDesk.Name..

integer

Optional ID of the customer whose booking was cancelled..

string

Display value for Coworker.CoworkerType..

string

Display value for Coworker.FullName..

string

Display value for Coworker.BillingName..

string

Display value for Coworker.CompanyName..

string

Display value for Coworker.TeamNames..

integer

Optional ID of the booking rate used when the cancelled booking was priced..

string

Display value for ExtraService.Name..

string

UTC date and time when the cancelled booking began..

string

UTC date and time when the cancelled booking ended; it is after FromTime..

string

Customer-facing notes retained from the cancelled booking..

string

Internal staff notes retained from the cancelled booking..

boolean

Whether the original booking was requested to be charged immediately..

boolean

Whether the original booking was requested to generate an invoice immediately..

boolean

Whether the selected customer was the billing party for the original booking..

boolean

Whether customer booking credit was prevented from being used for the original booking..

string

Customer purchase-order reference retained from the cancelled booking..

string

Discount code retained from the cancelled booking..

string

Internal UTC timestamp maintained for the last booking notification..

string

Internal Google Calendar identifier maintained by calendar synchronization..

string

Internal Google Calendar event identifier maintained by calendar synchronization..

string

Internal Microsoft 365 calendar event identifier maintained by synchronization..

string

Internal public Google Calendar event identifier maintained by synchronization..

boolean

Whether the cancelled booking was tentative and awaiting confirmation; tentative bookings still blocked the calendar..

boolean

Whether the cancelled booking was for an online resource..

string

System snapshot of the customer’s team memberships when the cancelled booking was made..

string

System snapshot of the customer’s plan when the cancelled booking was made..

string

System-generated identifier linking bookings from the same recurrence series..

boolean

Whether the cancelled booking was created as part of a recurrence series..

integer

Recurrence cycle retained from the booking: Daily, Weekly, Monthly, Yearly, FirstOfMonth, SecondOfMonth, ThirdOfMonth, FourthOfMonth, or LastOfMonth.. See eBookingRepeatCycle enum values: 1 = Daily, 2 = Weekly, 3 = Monthly, 4 = Yearly, 5 = FirstOfMonth, 6 = SecondOfMonth, 7 = ThirdOfMonth, 8 = LastOfMonth, 9 = FourthOfMonth.

integer

Original recurrence action: UpdateThisBookingOnly, UpdateFutureBookingsOnly, UpdateAllBookings, UpdateNotChargedBookings, DeleteAllBookings, DeleteBookingsAfterThis, DeleteNotChargedBookings, or RevertAllCharges.. See eRepeatedBookingUpdateAction enum values: 1 = UpdateThisBookingOnly, 2 = UpdateFutureBookingsOnly, 3 = UpdateAllBookings, 4 = UpdateNotChargedBookings, 5 = DeleteAllBookings, 6 = DeleteBookingsAfterThis, 7 = DeleteNotChargedBookings, 8 = RevertAllCharges.

integer

Recurrence interval retained from the booking; for example, 2 with Weekly means every two weeks..

string

Final UTC date and time for creating occurrences in the original recurrence series..

boolean

Whether the original weekly recurrence included Mondays..

boolean

Whether the original weekly recurrence included Tuesdays..

boolean

Whether the original weekly recurrence included Wednesdays..

boolean

Whether the original weekly recurrence included Thursdays..

boolean

Whether the original weekly recurrence included Fridays..

boolean

Whether the original weekly recurrence included Saturdays..

boolean

Whether the original weekly recurrence included Sundays..

boolean

System flag showing whether the standard booking reminder had been sent..

boolean

System flag showing whether an MRM reminder had been sent..

number

Optional total price override retained from the original booking, before normal rate calculation..

boolean

Whether a charge was posted to the customer account for the original booking; it does not indicate invoice status..

string

UTC date and time when the original booking was charged..

integer

System-generated reference number retained from the original booking..

integer

Internal Kisi access-control key identifier retained from the original booking..

string

Internal scheduled-job identifier for the original booking start..

string

Internal scheduled-job identifier for the original booking end..

boolean

Internal billing-processing state retained from the original booking..

string

System-maintained local-time representation of FromTime..

string

System-maintained local-time representation of ToTime..

string

System-maintained local-time representation of InvoiceDate..

integer

ID of the invoice associated with the original booking; manage it through the invoice entity..

string

Invoice number associated with the original booking, when it was included in an invoice..

boolean

Whether the invoice associated with the original booking has been paid..

boolean

Whether the invoice associated with the original booking is a draft..

boolean

Whether the invoice associated with the original booking has been voided..

boolean

Whether the invoice associated with the original booking is a credit note..

string

Internal serialized identifiers of customer rate entitlements used by the original booking..

number

System-calculated price from the customer’s applicable booking rate entitlement..

string

Read-only system-calculated currency code for the customer rate entitlement used by the original booking..

integer

System-calculated charge-period setting for the customer rate entitlement used by the original booking..

integer

System-calculated number of customer rate uses consumed or available for the original booking..

boolean

Whether the original booking included a Zoom meeting invitation..

string

Internal Zoom event payload maintained by the integration..

string

UTC date and time when the original booking was checked in through the booking workflow..

boolean

Whether the resource policy cancelled the booking when payment was not received..

boolean

Whether the resource policy cancelled the booking when no check-in occurred..

integer

Maximum occupancy detected by sensors in the resource during the original booking..

number

System-calculated monetary dynamic-pricing adjustment applied for a last-minute booking..

number

System-calculated monetary adjustment from dynamic-pricing settings for the resource or location..

number

System-calculated multiplier used for the last-minute dynamic-pricing adjustment..

number

System-calculated multiplier used for demand-based dynamic pricing..

string

Internal Microsoft 365 administrator calendar event identifier maintained by synchronization..

integer

Reason the booking was cancelled: Unknown, NoLongerNeeded, TooExpensive, BadPreviousExperience, RebookedForADifferentTime, FailedToPayUpfront, Integration, Other, NotCheckedIn, or MarketPlace..

string

UTC date and time when the booking was cancelled..

string

Name or identifier supplied by the user or process that cancelled the booking..

string

Optional free-text details explaining the cancellation reason, up to 255 characters..

number

Final calculated price of the booking at cancellation, including the system’s booking cost calculation..

string

GUID of the original booking from which this cancellation record was created..

string

Date and time when the customer checked in to this booking (before it was cancelled).

string

Date and time when the customer checked out from this booking (before it was cancelled).

integer

Unique record identifier.

string

UUID of the record.

string

Date and time the record was created (ISO 8601).

string

Date and time the record was last updated (ISO 8601).

string

Email of the user who last updated this record.

boolean

Whether the record was recently created.

string

External system identifier.

Example Response

{
  "ResourceId": 0,
  "ResourceName": null,
  "ResourceAllocation": null,
  "ResourceHideInCalendar": null,
  "ResourceNoReturnPolicy": null,
  "ResourceNoReturnPolicyAllResources": null,
  "ResourceNoReturnPolicyAllUsers": null,
  "ResourceResourceTypeId": null,
  "ResourceResourceTypeName": null,
  "FloorPlanDeskId": null,
  "FloorPlanDeskName": null,
  "CoworkerId": null,
  "CoworkerCoworkerType": null,
  "CoworkerFullName": null,
  "CoworkerBillingName": null,
  "CoworkerCompanyName": null,
  "CoworkerTeamNames": null,
  "ExtraServiceId": null,
  "ExtraServiceName": null,
  "FromTime": "2025-01-15T10:30:00Z",
  "ToTime": "2025-01-15T10:30:00Z",
  "Notes": null,
  "InternalNotes": null,
  "ChargeNow": false,
  "InvoiceNow": false,
  "InvoiceThisCoworker": false,
  "DoNotUseBookingCredit": false,
  "PurchaseOrder": null,
  "DiscountCode": null,
  "LastNotificationTime": null,
  "GoogleCalendarId": null,
  "GoogleEventId": null,
  "Office365EventId": null,
  "PublicGoogleEventId": null,
  "Tentative": false,
  "Online": false,
  "TeamsAtTheTimeOfBooking": null,
  "TariffAtTheTimeOfBooking": null,
  "RepeatSeriesUniqueId": null,
  "RepeatBooking": false,
  "Repeats": 0,
  "WhichBookingsToUpdate": 0,
  "RepeatEvery": null,
  "RepeatUntil": null,
  "RepeatOnMondays": false,
  "RepeatOnTuesdays": false,
  "RepeatOnWednesdays": false,
  "RepeatOnThursdays": false,
  "RepeatOnFridays": false,
  "RepeatOnSaturdays": false,
  "RepeatOnSundays": false,
  "Reminded": false,
  "MrmReminded": false,
  "OverridePrice": null,
  "Invoiced": false,
  "InvoiceDate": null,
  "BookingNumber": null,
  "KisiKeyId": null,
  "StartScheduledJobId": null,
  "EndScheduledJobId": null,
  "Billed": false,
  "FromTimeLocal": null,
  "ToTimeLocal": null,
  "InvoiceDateLocal": null,
  "CoworkerInvoiceId": null,
  "CoworkerInvoiceNumber": null,
  "CoworkerInvoicePaid": false,
  "CoworkerInvoiceDraft": false,
  "CoworkerInvoiceVoid": false,
  "CoworkerInvoiceCreditNote": false,
  "CoworkerExtraServiceIds": null,
  "CoworkerExtraServicePrice": null,
  "CoworkerExtraServiceCurrencyCode": null,
  "CoworkerExtraServiceChargePeriod": null,
  "CoworkerExtraServiceTotalUses": null,
  "IncludeZoomInvite": false,
  "ZoomEventData": null,
  "CheckedInAt": null,
  "CancelIfNotPaid": false,
  "CancelIfNotCheckedIn": false,
  "MaxOccupancy": null,
  "LastMinutePriceAdjustment": null,
  "DynamicPriceAdjustment": null,
  "PriceFactorLastMinute": null,
  "PriceFactorDemand": null,
  "Office365AdminEventId": null,
  "CancellationReason": 0,
  "CancelledOn": "2025-01-15T10:30:00Z",
  "CancelledBy": null,
  "CancellationReasonDetails": null,
  "Price": null,
  "OriginalBookingId": null,
  "CoworkerCheckedInAt": null,
  "CoworkerCheckedOutAt": null,
  "Id": 87654321,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "CreatedOn": "2025-01-10T08:00:00Z",
  "UniqueId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "UpdatedBy": "admin@example.com",
  "IsNew": false,
  "SystemId": null,
  "ToStringText": "CancelledBooking Example",
  "LocalizationDetails": null,
  "CustomFields": null
}

Get one CancelledBooking

curl --request GET \
  --url https://spaces.nexudus.com/api/spaces/cancelledbookings/{id} \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/spaces/cancelledbookings/{id}"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/spaces/cancelledbookings/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "ResourceId": 123,
  "ResourceName": "<string>",
  "ResourceAllocation": 123,
  "ResourceHideInCalendar": true,
  "ResourceNoReturnPolicy": 123,
  "ResourceNoReturnPolicyAllResources": 123,
  "ResourceNoReturnPolicyAllUsers": 123,
  "ResourceResourceTypeId": 123,
  "ResourceResourceTypeName": "<string>",
  "FloorPlanDeskId": 123,
  "FloorPlanDeskName": "<string>",
  "CoworkerId": 123,
  "CoworkerCoworkerType": "<string>",
  "CoworkerFullName": "<string>",
  "CoworkerBillingName": "<string>",
  "CoworkerCompanyName": "<string>",
  "CoworkerTeamNames": "<string>",
  "ExtraServiceId": 123,
  "ExtraServiceName": "<string>",
  "FromTime": "<string>",
  "ToTime": "<string>",
  "Notes": "<string>",
  "InternalNotes": "<string>",
  "ChargeNow": true,
  "InvoiceNow": true,
  "InvoiceThisCoworker": true,
  "DoNotUseBookingCredit": true,
  "PurchaseOrder": "<string>",
  "DiscountCode": "<string>",
  "LastNotificationTime": "<string>",
  "GoogleCalendarId": "<string>",
  "GoogleEventId": "<string>",
  "Office365EventId": "<string>",
  "PublicGoogleEventId": "<string>",
  "Tentative": true,
  "Online": true,
  "TeamsAtTheTimeOfBooking": "<string>",
  "TariffAtTheTimeOfBooking": "<string>",
  "RepeatSeriesUniqueId": "<string>",
  "RepeatBooking": true,
  "Repeats": 123,
  "WhichBookingsToUpdate": 123,
  "RepeatEvery": 123,
  "RepeatUntil": "<string>",
  "RepeatOnMondays": true,
  "RepeatOnTuesdays": true,
  "RepeatOnWednesdays": true,
  "RepeatOnThursdays": true,
  "RepeatOnFridays": true,
  "RepeatOnSaturdays": true,
  "RepeatOnSundays": true,
  "Reminded": true,
  "MrmReminded": true,
  "OverridePrice": 123,
  "Invoiced": true,
  "InvoiceDate": "<string>",
  "BookingNumber": 123,
  "KisiKeyId": 123,
  "StartScheduledJobId": "<string>",
  "EndScheduledJobId": "<string>",
  "Billed": true,
  "FromTimeLocal": "<string>",
  "ToTimeLocal": "<string>",
  "InvoiceDateLocal": "<string>",
  "CoworkerInvoiceId": 123,
  "CoworkerInvoiceNumber": "<string>",
  "CoworkerInvoicePaid": true,
  "CoworkerInvoiceDraft": true,
  "CoworkerInvoiceVoid": true,
  "CoworkerInvoiceCreditNote": true,
  "CoworkerExtraServiceIds": "<string>",
  "CoworkerExtraServicePrice": 123,
  "CoworkerExtraServiceCurrencyCode": "<string>",
  "CoworkerExtraServiceChargePeriod": 123,
  "CoworkerExtraServiceTotalUses": 123,
  "IncludeZoomInvite": true,
  "ZoomEventData": "<string>",
  "CheckedInAt": "<string>",
  "CancelIfNotPaid": true,
  "CancelIfNotCheckedIn": true,
  "MaxOccupancy": 123,
  "LastMinutePriceAdjustment": 123,
  "DynamicPriceAdjustment": 123,
  "PriceFactorLastMinute": 123,
  "PriceFactorDemand": 123,
  "Office365AdminEventId": "<string>",
  "CancellationReason": 123,
  "CancelledOn": "<string>",
  "CancelledBy": "<string>",
  "CancellationReasonDetails": "<string>",
  "Price": 123,
  "OriginalBookingId": "<string>",
  "CoworkerCheckedInAt": "<string>",
  "CoworkerCheckedOutAt": "<string>",
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Path Parameters

Code Examples

Response

200

​Authentication

​Path Parameters

​Code Examples

​Response

​200

Authentication

Path Parameters

Code Examples

Response

200