TimeSheetTemplate

Represents a template for creating time sheets in Field Service. Available in API version 46.0 and later.

Supported SOAP Calls

create(), delete(), describeLayout(), describeSObjects(), query(), retrieve(), update(), upsert()

Supported REST HTTP Methods

GET, POST, PATCH, DELETE

Special Access Rules

Field Service must be enabled to access TimeSheetTemplate. Users must have the Customize Application and Time Sheet Template permissions.

Limitations

SOQL Limitations

Fields

Field Details
Active
Type
boolean
Properties
Defaulted On Create, Filter, Group, Sort
Description
Indicates whether the time sheet template is active (true) or not (false).
Description
Type
textarea
Properties
Nillable
Description
The time sheet template's description.
DeveloperName
Type
string
Properties
Filter, Group, Sort
Description
The API name of the time sheet template. Can contain alphanumeric characters and underscores, and must begin with a letter.

Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field.

Frequency
Type
picklist
Properties
Filter, Group, Restricted picklist, Sort
Description
Defines the frequency of the time sheet creation period. One of the following values:
  • Daily
  • Weekly
  • EveryTwoWeeks
  • TwiceAMonth
  • Monthly
Fullname
Type
string
Properties
Create, Group, Nillable
Description

The full name of the associated metadata object in Metadata API. Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance.

Language
Type
picklist
Properties
Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort
Description

The language associated with the time sheet template.

ManageableState
Type
ManageableState enumerated list
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
Indicates the manageable state of the specified component that is contained in a package:
  • beta
  • deleted
  • deprecated
  • deprecatedEditable
  • installed
  • installedEditable
  • released
  • unmanaged
Available in API version 48.0 and later.
MasterLabel
Type
string
Properties
Filter, Group, Sort
Description
The name of the time sheet template.
Metadata
Type
mns:TimeSheetTemplate
Properties
Create, Nillable, Update
Description
The TimeSheetTemplate metadata.
NamespacePrefix
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The namespace that identifies the package that manages the time sheet template. Available in API version 48.0 and later.
StartDate
Type
date
Properties
Filter, Group, Sort
Description
The date when the time sheet takes effect.
TimeSheetTemplateAssignments
Type
QueryResult
Properties
Nillable
Description
A list of profiles that the template is assigned to. This field is only visible when the template has been assigned to at least one user profile. Available in API version 48.0 and later.
WorkWeekEndDay
Type
picklist
Properties
Defaulted On Create, Filter, Group, Restricted picklist, Sort
Description
The end day of the template's work week. One of the following values:
  • Monday
  • Tuesday
  • Wednesday
  • Thursday
  • Friday
  • Saturday
  • Sunday (default)
WorkWeekStartDay
Type
picklist
Properties
Defaulted On Create, Filter, Group, Restricted picklist, Sort
Description
The start day of the template's work week. One of the following values:
  • Monday
  • Tuesday
  • Wednesday
  • Thursday
  • Friday
  • Saturday
  • Sunday (default)