Booking
A booking [Booking
] is the allocation of an employee's (or resource's) time to a work package (project or project task).
Review the Usage Guidelines for the Booking
object.
— |
XML |
SOAP |
REST |
Database table |
---|---|---|---|---|
Object |
|
|
— |
|
Supported Commands |
|
|
— |
— |
The Booking
object has the following standard properties:
Booking
object properties may also include custom fields. The object type supports the custom equal to
read method and the enable_custom
read attribute.
XML / SOAP |
Database |
Description |
---|---|---|
|
|
A one-character string indicating the approval status of the booking request. Possible values:
|
|
|
A 1/0 field indicating which of the fields (hours or percentage) are actual, and which is derived.
|
|
|
The ID of the associated booking_type. |
|
|
[Read-only] Time the record was created. See Date Fields |
|
|
[Required] The ID of the associated customer. |
|
|
The date the booking request was approved. See Date Fields |
|
|
The date the booking_request was submitted. See Date Fields |
|
|
[Required] The end date of the booking. See Date Fields |
|
|
End time. See Date Fields |
|
|
If the record was imported from an external system you store the unique external record ID here. |
|
|
The number of hours booked to this project during this date range. This is either the actual booked hours or derived from the percentage. |
|
|
[Read-only] Unique ID. Automatically assigned by OpenAir. |
|
|
The ID of the associated job code. |
|
|
The location ID for this booking. |
|
|
Booking notes. |
|
|
A 1/0 field indicating whether to send email to the requestor when the booking is modified. |
|
|
The ID of the associated user creating the booking. Can be specified when adding an object. If specified, the user must exist, must not be marked as deleted and must be active. |
|
|
The percentage of time booked to this project during this date range. This is either the actual booked percentage or derived from the hours. |
|
|
The ID of the associated project assignment profile. |
|
|
The ID of the task within the associated project. |
|
|
[Required] The ID of the associated project. |
|
|
The ID of the associated repeating event. |
|
|
The ID of the associated resource request queue. |
|
|
ID of the booking used to create this booking. |
|
|
[Required] The start date of the booking. See Date Fields |
|
|
Start time. See Date Fields |
|
|
[Read-only] Time the record was last updated or modified. See Date Fields |
|
|
[Required] The ID of the associated user. The user must exist, must not be marked as deleted and must be active. |
Usage Guidelines
Review the following guidelines:
-
Some object properties are required depending on the
as_percentage
property value:-
percentage
is required ifas_percentage
is set to1
. -
hours
is required otherwise.
-
-
The date range defined by
start_date
andend_date
must be valid.start_date
must be beforeend_date
. -
approval_status
is set automatically, if empty or not already set when adding or modifying aBooking
object. It is set toO
if booking approvals are enabled for your company's OpenAir account, or toA
otherwise. -
A
booking_typeid
is required if the Require booking type when booking resources [rm_booking_require_type
] box is checked in Administration > Application Settings > Resources > Other Settings for your company's account. -
Depending on your company's account configuration,
booking_typeid
may be set automatically, if empty or not already set when adding or modifying aBooking
object. It is set to the default booking type associated with theapproval_status
, if one is set. See Booking Types. -
A booking cannot be deleted if it is a source booking [
source_booking_id
] for another booking. Delete any other bookings referencing the booking as source booking before you can delete aBooking
object. -
Deleting a booking deletes the booking and all its attachments, all references to this booking in project task assignments, all related approvals, and all related alerts.