TimeSheetTemplate

Represents a template for creating time sheets in Field Service.

Version 

Introduced in API version 45.0.

Supported SOAP API Calls 

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

Supported REST API Methods 

DELETE, GET, HEAD, PATCH, POST, Query

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 

Active 

• Type: boolean

• Required: No

• Properties: Defaulted on create, Filter, Group, Sort

• Introduced: API version 45.0

• Description: Indicates whether the time sheet template is active (true) or not (false).

• Default value: false

Description 

• Type: textarea

• Required: No

• Properties: Nillable

• Introduced: API version 45.0

• Description: The time sheet template’s description.

DeveloperName 

• Type: string

• Required: No

• 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

• Required: No

• Properties: Filter, Group, Restricted picklist, Sort

• Introduced: API version 45.0

• Description: Defines the frequency of the time sheet creation period. One of the following values:

• Possible values:

  • Daily — Daily

  • Weekly — Weekly

  • EveryTwoWeeks — Every Two Weeks

  • TwiceAMonth — Twice a Month

  • Monthly — Monthly

Fullname 

• Type: string

• Required: No

• Properties: Create, Group, Nillable

• Introduced: API version 45.0

• 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

• Required: No

• Properties: Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort

• Description: The language associated with the time sheet template.

• Possible values:

  • en_US — English

  • de — German

  • es — Spanish

  • fr — French

  • it — Italian

  • ja — Japanese

  • sv — Swedish

  • ko — Korean

  • zh_TW — Chinese (Traditional)

  • zh_CN — Chinese (Simplified)

  • pt_BR — Portuguese (Brazil)

  • nl_NL — Dutch

  • da — Danish

  • th — Thai

  • fi — Finnish

  • ru — Russian

  • es_MX — Spanish (Mexico)

  • no — Norwegian

ManageableState 

• Type: picklist

• Required: No

• 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

• Possible values:

  • beta — beta

  • deleted — deleted

  • deprecated — deprecated

  • deprecatedEditable — deprecatedEditable

  • installed — installed

  • installedEditable — installedEditable

  • released — released

  • unmanaged — unmanaged

MasterLabel 

• Type: string

• Required: No

• Properties: Filter, Group, Sort

• Description: The name of the time sheet template.

Metadata 

• Type: complexvalue

• Required: No

• Properties: Create, Nillable, Update

• Introduced: API version 45.0

• Description: The TimeSheetTemplate metadata.

NamespacePrefix 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Introduced: API version 48.0

• Description: The namespace that identifies the package that manages the time sheet template.

StartDate 

• Type: date

• Required: No

• Properties: Filter, Group, Sort

• Introduced: API version 45.0

• Description: The date when the time sheet takes effect.

WorkWeekEndDay 

• Type: picklist

• Required: No

• Properties: Defaulted on create, Filter, Group, Restricted picklist, Sort

• Introduced: API version 45.0

• Description: The end day of the template’s work week. One of the following values:

• Possible values:

  • Sunday — Sunday (default)

  • Monday — Monday

  • Tuesday — Tuesday

  • Wednesday — Wednesday

  • Thursday — Thursday

  • Friday — Friday

  • Saturday — Saturday

• Default value: Sunday

WorkWeekStartDay 

• Type: picklist

• Required: No

• Properties: Defaulted on create, Filter, Group, Restricted picklist, Sort

• Introduced: API version 45.0

• Description: The start day of the template’s work week. One of the following values:

• Possible values:

  • Sunday — Sunday (default)

  • Monday — Monday

  • Tuesday — Tuesday

  • Wednesday — Wednesday

  • Thursday — Thursday

  • Friday — Friday

  • Saturday — Saturday

• Default value: Sunday