Scenario Bookings

Time bookings scheduled for scenario items, applied to the deal as real bookings when the scenario is applied with apply_bookings. All scenario endpoints require the Scenario Builder feature on the organization's plan.

Attributes

after string
Parameter `filter`

Internal field used for date-range filtering.
before string
Parameter `filter`

Internal field used for date-range filtering.
booking_method_id integer
Response Request Enum

ID of the booking method used to create this booking (e.g. hours per day, percentage, total hours).

Enum Values (3 values)

  • 1
    Hours per day
  • 2
    Percentage
  • 3
    Total hours
created_at string
Response Parameter `filter`

Date when the booking was created.
creator person
Response

The person who created this booking.
custom_fields object
Response Request Nullable

Custom field values for this booking.
ended_on string
Response Request Parameter `filter`

Booking end date.
hours integer
Response Nullable

Scheduled hours per day for this booking.
id integer
Parameter `filter` Parameter `sort`

Unique identifier of the booking.
last_activity_at string
Response Parameter `filter` Nullable

Timestamp of the last activity recorded on this booking.
note string
Response Request Parameter `filter` Nullable

An optional note or description for this booking.
organization organization
Response

The organization this booking belongs to.
percentage integer
Response Request Nullable

Scheduled time as a percentage of the person's daily capacity.
person_id integer
Parameter `filter`

ID of the person assigned to this booking.
scenario_item scenario item
Response

The scenario item this booking belongs to.
scenario_item_id integer
Request Parameter `filter`

ID of the scenario item this booking belongs to.
started_on string
Response Request Parameter `filter`

The start date of the booking.
time integer
Response Request Nullable

The booked time in minutes per day.
total_time integer
Response Request

The total booked time in minutes across the entire booking period.
total_working_days integer
Response Nullable

The total number of working days covered by this booking.
updated_at string
Response Parameter `filter`

Timestamp when this booking was last updated.
updater person
Response

The person who last updated this booking.

Examples

Loading example

Operations

GET /api/v2/scenario_bookings
Get scenario bookings
GET /api/v2/scenario_bookings/{id}
Gets a scenario booking
POST /api/v2/scenario_bookings
Create a scenario booking
PATCH /api/v2/scenario_bookings/{id}
Update a scenario booking
DELETE /api/v2/scenario_bookings/{id}
Deletes a scenario booking