Scheduleexception

A schedule exception [Scheduleexception] is an exception to the normal work pattern in the company's or the employee's work schedule.

Review the Usage Guidelines for the Scheduleexception object.

—	XML	SOAP	REST	Database table
Object	`Scheduleexception`	`oaScheduleexception`	—	`scheduleexception`
Supported Commands	`Add`, `Read`, `Modify`, `Delete`	`add()`, `read()`, `modify()`, `upsert()`, `delete()`	—	—

—

XML

SOAP

REST

Database table

Object

Scheduleexception

oaScheduleexception

—

scheduleexception

Supported Commands

Add, Read, Modify, Delete

add(), read(), modify(), upsert(), delete()

—

A Scheduleexception object has the following properties:

XML / SOAP	Database	Description
`created`	`created`	[Read-only] Time the record was created. See Date Fields.
`enddate`	`enddate`	[Required] The end date for the exception. See Date Fields. Must be after `startdate`.
`exception_type`	`exception_type`	[Read-only] The type of exception. The only possible value is `R` – Date range of the exception.
`id`	`id`	[Read-only] Unique ID. Automatically assigned by SuiteProjects Pro.
`name`	`name`	[Required] The exception name or description, for example New Years Day.
`schedule_request_itemid`	`schedule_request_item_id`	The ID of the schedule change item from a schedule request.
`startdate`	`startdate`	[Required] The start date for the exception. See Date Fields. Must be before `enddate`.
`timetypeid`	`timetype_id`	The ID of the associated time type. The time type must be allowed in schedules.
`updated`	`updated`	[Read-only] Time the record was last updated or modified. See Date Fields.
`userid`	`user_id`	The ID of the user of this is an exception to the user's work schedule. 0 if this is an exception to an account work schedule.
`workhours`	`workhours`	The number of hours per day during this date range. This overrides any work hours on each day of either the account schedule or the account/user schedule.
`workscheduleid`	`workschedule_id`	The ID of the corresponding work schedule.

XML / SOAP

Database

Description

created

[Read-only] Time the record was created. See Date Fields.

enddate

[Required] The end date for the exception. See Date Fields. Must be after startdate.

exception_type

[Read-only] The type of exception. The only possible value is R – Date range of the exception.

id

[Read-only] Unique ID. Automatically assigned by SuiteProjects Pro.

name

[Required] The exception name or description, for example New Years Day.

schedule_request_itemid

schedule_request_item_id

The ID of the schedule change item from a schedule request.

startdate

[Required] The start date for the exception. See Date Fields. Must be before enddate.

timetypeid

timetype_id

The ID of the associated time type. The time type must be allowed in schedules.

updated

[Read-only] Time the record was last updated or modified. See Date Fields.

userid

user_id

The ID of the user of this is an exception to the user's work schedule. 0 if this is an exception to an account work schedule.

workhours

The number of hours per day during this date range. This overrides any work hours on each day of either the account schedule or the account/user schedule.

workscheduleid

workschedule_id

The ID of the corresponding work schedule.

Usage Guidelines

Review the following guidelines:

One of userid or workscheduleid is required. If the schedule exception is for a user work schedule, the value of one property is derived from the other.
The date range defined by startdate and enddate must not overlap with the date range for any other schedule exceptions associated with the same work schedule, unless all the following conditions are met:
- The Automatically create schedule exceptions when a time-off request is approved box is checked in the Timesheets application settings in SuiteProjects Pro (Administration > Application Settings > Timesheets > Other Settings ).
- The schedule_request_itemid value is not empty or 0.
- Your account is configured to allow multiple schedule exceptions on the same day.
Changes to schedule exceptions trigger a recalculation of the associated work schedule and automatic changes to the booking_by_day table.