Bookings

approvalStatus

The approval status of the booking. Possible values:

• O – Open

• S – Submitted

• A – Approved

• R – Rejected

string

—

Yes

Yes

asPercentage

A 1/0 field indicating whether the time booked is set as a percentage of schedule hours or as a number of hours.

• If set to 1, hours is calculated from percentage.

• If set to 0, percentage is calculated from hours.

Boolean

—

Yes

Yes

attachments

The attachments associated with this booking. Array of internal IDs for attachment objects.

Array of {”id”: <integerValue>} objects.

Yes

—

—

bookingRequestId

The internal ID of the booking request associated with this booking.

integer($int64)

—

Yes

Yes

bookingTypeId

The internal ID of the booking type associated with this booking.

integer($int64)

—

Yes

Yes

created

The date the booking was created.

string($date-time)

Yes

Yes

—

customerId

The internal ID of the customer associated with the booking.

integer($int64)

—

Yes

Yes

dateApproved

The date the booking was approved.

string($date)

—

Yes

Yes

dateRejected

The date the booking was rejected.

string($date)

—

Yes

Yes

dateSubmitted

The date the booking was submitted.

string($date)

—

Yes

Yes

endDate

The booking end date.

string($date)

—

Yes

Yes

endTime

The booking end time.

string

—

Yes

Yes

externalId

The unique external ID of the booking, if the record was imported from an external system.

string

—

Yes

Yes

hours

The number of hours for which the resource is booked to this task or project during the date range defined by startDate and endDate. Calculated from percentage if asPercentage is set to 1.

number($float)

Yes

Yes

Yes

jobCodeId

The internal ID of the job code associated with the booking.

integer($int64)

—

Yes

Yes

locationId

The internal ID of the location associated with the booking.

integer($int64)

—

Yes

Yes

matchScore

The match score if this booking was created from search results.

integer($int64)

—

Yes

Yes

notes

Notes about this booking.

string

—

Yes

Yes

notifyOwner

A 1/0 field indicating whether to send notification email to the booking owner when the booking is modified.

Boolean

—

Yes

Yes

ownerId

The internal ID of the employee who created the booking.

integer($int64)

—

Yes

Yes

percentage

The percentage of schedule hours for which the resource is booked to this task or project during the date range defined by startDate and endDate. Calculated from hours if asPercentage is set to 0.

number($float)

—

Yes

Yes

preferred

The preferred status of this booking (1-5).

integer($int64)

—

Yes

Yes

priority

The priority of this booking.

integer($int64)

—

Yes

Yes

projectAssignmentProfileId

The internal ID of the project assignment profile associated with the booking.

integer($int64)

—

Yes

Yes

projectId

The internal ID of the project associated with the booking.

integer($int64)

—

Yes

Yes

projectTaskId

The internal ID of the task associated with the booking.

integer($int64)

—

Yes

Yes

repeatId

The internal ID of the repeat event associated with the booking.

integer($int64)

—

Yes

Yes

resourceRequestQueueId

The internal ID of the resource request queue associated with the booking.

integer($int64)

—

Yes

Yes

rmApprover1

The internal ID of the first booking approver [User] that is substituted into the approval processes.

Other possible value:

• –10 — the first additional booking approver.

integer($int64)

—

Yes

Yes

rmApprover2

The internal ID of the first booking approver [User] that is substituted into the approval processes.

Other possible value:

• –11 — the second additional booking approver.

integer($int64)

—

Yes

Yes

rmApprover3

The internal ID of the first booking approver [User] that is substituted into the approval processes.

Other possible value:

• –12 — the third additional booking approver.

integer($int64)

—

Yes

Yes

scheduleRequestItemId

The internal ID of the schedule request item associated with the booking.

integer($int64)

—

Yes

Yes

sourceBookingId

The internal ID of another booking that was used to create the booking.

integer($int64)

—

Yes

Yes

startDate

The booking start date.

string($date)

—

Yes

Yes

startTime

The booking start time.

string

—

Yes

Yes

updated

The date the booking was last updated or modified.

string($date-time)

Yes

Yes

—

userId

The internal ID of the employee associated with the booking — the resource booked.

integer($int64)

—

Yes

Yes