Timesheet

A timesheet [Timesheet] is a collection of time entries submitted by an employee to claim compensation for time worked.

Review the Usage Guidelines for the Timesheet object.

—	XML	SOAP	REST	Database table
Object	`Timesheet`	`oaTimesheet`	—	`timesheet`
Supported Commands	`Add`, `Read`, `Modify`, `Delete`, `Submit`, `Approve`, `Reject`, `Unapprove`, `Report`	`add()`, `read()`, `modify()`, `upsert()`, `delete()`, `submit()`, `approve()`, `reject()`, `unapprove()`	—	—

—

XML

SOAP

REST

Database table

Object

Timesheet

oaTimesheet

—

timesheet

Supported Commands

Add, Read, Modify, Delete, Submit, Approve, Reject, Unapprove, Report

add(), read(), modify(), upsert(), delete(), submit(), approve(), reject(), unapprove()

—

The Timesheet object has the following standard properties:

Note:

Timesheet 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
`acct_date`	`acct_date`	The accounting period date of the task. See Date Fields.
`approved`	`date_approved`	The date the timesheet was approved. See Date Fields.
`approved_by`	—	Empty value kept for backward compatibility.
`associated_tmid`	`associated_tmid`	Id of complementary timesheet in case of cross month timesheet. Used only when the value of `start_end_month_ts` is not empty. The associated split timesheet must have the same `userid`, `starts` and `ends` and the counterpart value for `start_end_month_ts`.
`created`	`created`	[Read-only] Time the record was created. See Date Fields.
`default_categoryid`	`default_category`	The default category ID this timesheet is associated with. All new task entries get this default value.
`default_customerid`	`default_customer`	The default customer ID this timesheet is associated with. All new task entries get this default value.
`default_payrolltypeid`	`default_payrolltype`	The default payroll type ID this timesheet is associated with.
`default_per_row`	`default_per_row`	Holds a data structure of per row defaults. The format is as follows: Multiple CSV rows with each row having the element name ('cp','category' etc.) as the first record and then the ID values per row.
`default_projectid`	`default_project`	The default project ID this timesheet is associated with.
`default_projecttaskid`	`default_task`	The default task ID this timesheet is associated with. All new task entries get this default value.
`default_timetypeid`	`default_timetype`	The default time type ID this timesheet is associated with.
`duration`	`duration`	The duration of the timesheet: W -Weekly D -Daily M -Monthly B -Bi-weekly S -Semi-monthly
`ends`	`date_end`	[Required] The ending date of the timesheet. See Date Fields. Must be after `starts`.
`history`	`history`	[Read-only] History of events that occurred to the TimeSheet.
`id`	`id`	[Read-only] Unique ID. Automatically assigned by SuiteProjects Pro.
`max_hours`	—	[Read-only] Calculated maximum number of hours allowed on the timesheet as determined by the corresponding timesheet rule. A value is returned only if the rule is active and the attribute `calculate_hours` is set to `1` in the Read request.
`min_hours`	—	[Read-only] Calculated minimum number of hours required on the timesheet as determined by the corresponding timesheet rule. Supports the Read method only. A value is returned only if the rule is active and the attribute `calculate_hours` is set to `1` in the Read request.
`name`	`name`	The name of the timesheet.
`notes`	`notes`	Notes related to this timesheet.
`start_end_month_ts`	`start_end_month_ts`	Indicator of whether the cross_month timesheet belongs to the end of the current month or beggining of the next month'E' -belongs to the end of current month, first date in timesheet'S' -belongs to the start of next month, last date in timesheet. Must be used only for split timesheets at month end.
`starts`	`date_start`	[Required] The starting date of the timesheet. See Date Fields. Must be before `ends`.
`status`	`status`	The status of the timesheet: O -Open (default) S -Submitted A -Approved R -Rejected X -Archived
`submitted`	`date_submitted`	The date the timesheet was submitted. See Date Fields.
`thin_client_id`	`thin_client_id`	Used by thin clients to reconcile imported records.
`total`	`total`	[Read-only] The total number of hours in the timesheet.
`updated`	`updated`	[Read-only] Time the record was last updated or modified. See Date Fields.
`userid`	`userid`	[Required] The ID of the associated user.

XML / SOAP

Database

Description

acct_date

The accounting period date of the task. See Date Fields.

approved

date_approved

The date the timesheet was approved. See Date Fields.

approved_by

—

Empty value kept for backward compatibility.

associated_tmid

Id of complementary timesheet in case of cross month timesheet. Used only when the value of start_end_month_ts is not empty. The associated split timesheet must have the same userid, starts and ends and the counterpart value for start_end_month_ts.

created

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

default_categoryid

default_category

The default category ID this timesheet is associated with. All new task entries get this default value.

default_customerid

default_customer

The default customer ID this timesheet is associated with. All new task entries get this default value.

default_payrolltypeid

default_payrolltype

The default payroll type ID this timesheet is associated with.

default_per_row

Holds a data structure of per row defaults. The format is as follows: Multiple CSV rows with each row having the element name ('cp','category' etc.) as the first record and then the ID values per row.

default_projectid

default_project

The default project ID this timesheet is associated with.

default_projecttaskid

default_task

The default task ID this timesheet is associated with. All new task entries get this default value.

default_timetypeid

default_timetype

The default time type ID this timesheet is associated with.

duration

The duration of the timesheet:

W -Weekly
D -Daily
M -Monthly
B -Bi-weekly
S -Semi-monthly

ends

date_end

[Required] The ending date of the timesheet. See Date Fields. Must be after starts.

history

[Read-only] History of events that occurred to the TimeSheet.

id

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

max_hours

—

[Read-only] Calculated maximum number of hours allowed on the timesheet as determined by the corresponding timesheet rule. A value is returned only if the rule is active and the attribute calculate_hours is set to 1 in the Read request.

min_hours

—

[Read-only] Calculated minimum number of hours required on the timesheet as determined by the corresponding timesheet rule. Supports the Read method only. A value is returned only if the rule is active and the attribute calculate_hours is set to 1 in the Read request.

name

The name of the timesheet.

notes

Notes related to this timesheet.

start_end_month_ts

Indicator of whether the cross_month timesheet belongs to the end of the current month or beggining of the next month'E' -belongs to the end of current month, first date in timesheet'S' -belongs to the start of next month, last date in timesheet. Must be used only for split timesheets at month end.

starts

date_start

[Required] The starting date of the timesheet. See Date Fields. Must be before ends.

status

The status of the timesheet:

O -Open (default)
S -Submitted
A -Approved
R -Rejected
X -Archived

submitted

date_submitted

The date the timesheet was submitted. See Date Fields.

thin_client_id

Used by thin clients to reconcile imported records.

total

[Read-only] The total number of hours in the timesheet.

updated

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

userid

[Required] The ID of the associated user.

Usage Guidelines

Review the following notes and guidelines:

Your account can be configured to:
- Allow the modification of approved and archived timesheets using the API.
- Disallow the modification of submitted timesheet by the timesheet owner.
- Disallow the modification of exported timesheets.
To enable any of the above features, contact SuiteProjects Pro Support.
To modify another user's timesheet, the authenticated user must be an account administrator
Set the attribute calculate_hours to 1 to return the minimum number of hours required [min_hours] and maximum number of hours allowed [max_hours] on the timesheet if an active timesheet rule set these values as a fixed number of hours or as a percentage of the work schedule. For more information about timesheet rules, see Timesheet Rules.

Important:
Using the attribute calculate_hours may slow the response time significantly, particularly when there are active timesheet rules are active and the minimum and maximum number of hours are set as a percentage of the work schedule.
You cannot delete a Timesheet object if this object is referenced by a Task object. Delete any dependent objects first before you delete a Timesheet object.