Built-in Objects

Built-in objects are pre-defined objects that come with the platform. They are customizable, but some functionality is fixed. (Custom Objects, in contrast, are created by platform developers. They are fully configurable, and become available when custom applications are developed or installed.)

For Developers

Service Providers should consider the characteristics of Custom Objects vs CRM Objects and Built-in Objects when building applications. Custom Objects are more customizable and generally more flexible, but the CRM Objects and Built-in Objects may have special functionality that is desirable.

Tip: The CRM Objects and Built-in Objects are due to be replaced by newer, more customizable versions in a future release. To minimize any impact on your applications, prefer Custom Objects, if at all possible.

Note: Some objects will be displayed as tabs in the application, while others are hidden from view

Property Limitations

File:Customizeobjects-sysgen.gif

• The following Property options are not available in Built-in or CRM Objects:

• Display Styles - Only Sectional Layout and Horizontal Tabbed Layout are supported
• Record Locators can not be changed
• Cannot make an object Active or Inactive

• Inactive objects are not used in an application
• Data in an Inactive object cannot be viewed, edited or deleted

• Cannot set the object to be Web Enabled; exception: Prospects can be Web Enabled

Note: Web Enabled objects can use the Web Forms tool

• The Help URL is set by default, and cannot be changed
• Campaign Tracking is enabled by default, and cannot be changed

Other Considerations

• Object Inheritance is not supported
• Lookup fields to Built-in or CRM Objects do not include Record Selection Criteria or Post-selection Javascipt
• Workflows are not supported
• Built-in or CRM Objects cannot be deleted, but can be hidden from view
• Fields associated with the Record Identifier are clickable in Built-in or CRM Objects

• Clicking the link to an Account Name, Contact Name, or other Built-in or CRM Objects opens the record for viewing
• By contrast, Custom Objects provide a Details link to open the record for viewing

Built-in Object Type Identifiers

Built-in Objects are listed here, showing the names that appear in the UI, along with the object-type identifiers used in the APIs.

Built-in Objects (As shown in the Platform UI)	Object Type Identifiers
Activity	EVENT
Note	NOTE
Project*	PROJECT
- Project Task*	Project_Task
- Project Phase*	Project_Phase
Role	ROLE
Task	TASK
Team	TEAM
User	USER
User Team	USER TEAM

• *The Project object is always available, but these objects provide extended functionality that is available only after installing the Project Management application.

Built-in Object Attributes

This section provides reference tables for the fields in the platform's Built-in Objects. The tables include Field Name, Display Type and Description for each Object.

Reference for Related Objects

• Dependencies between fields in related objects must be considered; See these topics:
  • Relating Tasks or Events to Objects
  • Relating Objects

Relating Tasks or Events to Objects

To add a Task or Event to the Contacts object, this field must be specified:

• contact_id contains the identifier of the contact record

To add a Task or Event to any Object (other than Contacts), these fields must be specified:

• reference_type contains the name of the object
• reference_id contains the identifier of the record

Relating Objects

When building a relationship between objects, the fields reference_type and reference_id are used as follows.

Example

Object B (Expense Item) is related to Object A (Expense Report), therefore, a record in Object B (Expense Item) contains:

• reference_type the name (or Object Type Identifier) of Object A (Expense Report)
• reference_id the identifier of the record in Object A (Expense Report)

Standard Fields

The standard system fields are:

• Common to, and predefined in, all Objects.
• Created automatically when an object is created.
• Populated automatically when a record is added or updated in the GUI.
• Required when a record is added or updated using an API.

Field Name	REST Search Name	GUI Label	Display Type	Description
object_id	object_id	Object ID	Number	Unique identifier for the object. (This field is always present, but is only displayed when examining Object metadata (the data that defines the object).
record_id	id	Record ID	Number	Unique record identifier
owner_id	OWNERID	Owner	String	Unique identifier of the record's owner
owner_team_id	OWNER_TEAM_ID	n/a	String	Unique identifier of record owner's primary team. (This is a virtual field that does not actually exist in the record. The actual field is in the User object. It is returned in APIs, to keep from having to access the database a second time to check permissions.)
created_id	CREATEDID	Created By	String	Unique identifier of the user who created the record
date_created	DATECREATED	Date Created	String	Date the record was created: UTC Format in the REST API. User's Date Format in the GUI and the Java API.
date_modified	DATEMODIFIED	Date Modified	String	Date the record was last modified: UTC Format in the REST API. User's Date Format in the GUI and the Java API.
modified_id	MODIFIEDID	Modified By	String	Unique identifier of the user who last modified the record

EVENT (Activity) Object

Object ID

EVENT

Available Fields

• Required Fields are highlighted, in italics

This state describes the default field property in a new instance of the platform. Users with appropriate Data Access Permissions can change field properties without notice.

• Additional fields may be returned. Such fields are generally intended for internal use, or for backward compatibility. Common fields intended for internal use include:

• CALL_ACTION
• VIEW_ACTION

Field Name	Display Type	Description
assigned_id	String	ID of the User to whom this Event is assigned
calendar_category	String	Calendar ID on which this event should set; The included calendar has ID = "0"; Optionally, specify the customer calendar ID that you created
calendar_frequency	Number	Calendar Frequency for the Event; For more information see Constants for Task and Event Objects
calendar_type	Number	Calendar Type for the Event; For more information see Constants for Task and Event Objects
cc	String	A String of email addresses (separated by commas) containing additional users/contacts that you want to notify about this event
contact_id	Number	ID of the Contact this event is related to; In order to relate the event to a specific contact record, you need to set only this attribute; reference_id and reference_type are not required
description	String	Event Description
duration	Number	Event duration in minutes
end_date	Date	Date when the task ends
end_flag	Boolean	Flag to specify whether this event ends or not; True value means it ends on certain date, false means it never ends
flag_all_day	Boolean	Flag to specify if the event is all day or not
invitee_list	String	A comma separated String of IDs of Additional owners of this event
notify_contact	Boolean	Flag to determine whether the contact identified by contact_id should be notified or not
notify_participants	Boolean	Flag to determine whether to notify participants in invitee_list or not
reference_id	Number	ID of the record this event is related to; To relate an event to a record, set reference_id, reference_id_name and reference_type ; Use this attribute to relate the event to any object other than Contact
reference_type	String	Type of object this event is related to; To relate an event to a record, set reference_id, reference_id_name and reference_type; Use this attribute to relate the event to any object other than Contact
reminder_duration	String	Event reminder duration; For more information see Constants for Task and Event Objects
repeat_flag	Boolean	Flag to specify whether this event repeats or not; True value means the task repeats, false indicates no recurrence
start_date	Date	Event Start Date, in Date/Time Format. (The time value in this field is ignored when creating an event. The fields below are used, instead.)
start_hour	Date	Event Start Hour
start_minute	Date	Event Start Minute
subject	String	Event subject

NOTE Object

Object ID

NOTE

Considerations

• NOTE object records can be added, updated, retrieved, and deleted. They cannot be searched.

Available Fields

• Required Fields are highlighted, in italics

This state describes the default field property in a new instance of the platform. Users with appropriate Data Access Permissions can change field properties without notice.

• Additional fields may be returned. Such fields are generally intended for internal use, or for backward compatibility. Common fields intended for internal use include:

• CALL_ACTION
• VIEW_ACTION

Field Name	Display Type	Description
description	String	Note Description
reference_id	String	Record ID of the object to which this note is related
reference_name	String	Name of the object to which this note is related
reference_type	String	Object ID to which this note is related
title	String	Note title

PROJECT Object

Note: This object is available only after installing the Project Management application. It can be accessed using both the Java API and the REST API.

Object ID

PROJECT

Available Fields

• Required Fields are highlighted, in italics

This state describes the default field property in a new instance of the platform. Users with appropriate Data Access Permissions can change field properties without notice.

• Additional fields may be returned. Such fields are generally intended for internal use, or for backward compatibility. Common fields intended for internal use include:

• CALL_ACTION
• VIEW_ACTION

Field Name	Display Type	Description
name	string	Project Name
stage	string	Project Status
type	string	Type
percentage_complete	percent	% Complete
estimated_start_date	date	Estimated Start Date
estimated_end_date	date	Estimated End Date
actual_start_date	date	Actual Start Date
actual_end_date	date	Actual End Date
priority	string	Priority
estimated_hours	double	Estimated Hours
estimated_costs	currency	Estimated Costs
actual_hours	double	Actual Hours
actual_costs	currency	Actual Costs
percent_over_hours	percent	% Over Hours
percent_over_budget	percent	% Over Budget
description	string	Description

Project Task Object

Object ID

Project_Task

Available Fields

• Required Fields are highlighted, in italics

This state describes the default field property in a new instance of the platform. Users with appropriate Data Access Permissions can change field properties without notice.

• Additional fields may be returned. Such fields are generally intended for internal use, or for backward compatibility. Common fields intended for internal use include:

• CALL_ACTION
• VIEW_ACTION

Note: This object can be accessed only through the REST API.

Field Name	Display Type	Description	Additional Information
assigned_id	String	ID of the User to whom this Task is assigned
duration	Number	Duration in days for project task
due_date	Date	Task Start date	UTC Format
subject	String	Task Name
description	String	Task Description
date_completed	Date	Date when the task is actually completed	UTC Format
action_type	String	Task action type
percentage_complete	Number	Percentage of task completion
priority	String	Task priority
reference_id	String	Project ID of the record this task is related to To relate a task to a record, set reference_id, reference_id_name and reference_type
name	String	Name of the Project this task is related to
project_milestone_id	String	ID of the project Phase the task is linked
calculated_finish_date	Date	This field value is calculated based on the Start date and duration given for the project	UTC Format
status	String	Task status
budget_hours	Double	Task Budget Hours
budget_amount	Currency	Task Budget Amount
actual_hours	Double	Task Actual Hours
actual_amount	Currency	Task Actual Amount
overrun_hours	Percent	Task Overrun Hours
overrun_amount	Percent	Task Overrun Amount

Project Phase Object

Object ID

Project_Phase

Available Fields

• Required Fields are highlighted, in italics

This state describes the default field property in a new instance of the platform. Users with appropriate Data Access Permissions can change field properties without notice.

• Additional fields may be returned. Such fields are generally intended for internal use, or for backward compatibility. Common fields intended for internal use include:

• CALL_ACTION
• VIEW_ACTION

Note: This object can be accessed only through the REST API.

Field Name	Display Type	Description	Additional Information
name	String	Name of the Project Phase
project_id	String	Id of the Project the phase is linked
comments	String	Project Phase Comments

ROLE Object

DEPRECATED: The Built-in Objects object still exists, but the description on this page is deprecated. For the most comprehensive information, consult the REST API:Role Resource.

Object ID

ROLE

Available Fields

• Required Fields are highlighted, in italics

This state describes the default field property in a new instance of the platform. Users with appropriate Data Access Permissions can change field properties without notice.

• Additional fields may be returned. Such fields are generally intended for internal use, or for backward compatibility. Common fields intended for internal use include:

• CALL_ACTION
• VIEW_ACTION

Field Name	Display Type	Description
description	String	Description of this role
name	String	Name of this Role

TASK Object

Object ID

TASK

Available Fields

• Required Fields are highlighted, in italics

This state describes the default field property in a new instance of the platform. Users with appropriate Data Access Permissions can change field properties without notice.

• Additional fields may be returned. Such fields are generally intended for internal use, or for backward compatibility. Common fields intended for internal use include:

• CALL_ACTION
• VIEW_ACTION

Field Name	Display Type	Description
action_type	String	Task action type
assigned_id	String	ID of the User to whom this Task is assigned
calendar_frequency	Number	Calendar frequency for a task; For more information see Constants for Task and Event Objects
calendar_type	Number	Calendar type for a task; For more information see Constants for Task and Event Objects
contact_id	Number	ID of the Contact this task is related to; You do not need to set reference_id and reference_type to relate the task to a contact record;
description	String	Task Description
due_date	Date	Task due date
end_date	Date	Date when the task ends; In order to set an end date for the task, you need to set end_flag and repeat_flag attributes
end_flag	Boolean	Flag to specify whether this task ends or not; True value means it ends on certain date, false means it never ends
invitee_list	String	A comma separated string of IDs of additional owners of this task
notify_complete	String	Flag to Notify creator of status changes
percentage_complete	Number	Percentage of task completion
priority	String	Task priority. Defined in the Task Priority Global Piclist. ("High", "Normal", "Low", by default.)
reference_id	String	ID of the record this task is related to Use this attribute to relate the task to any object other than Contact To relate a task to a record, set reference_id, reference_id_name and reference_type
reference_id_name	String	Name of the record this task is related to, equal to the Record Locator Use this attribute to relate the task to any object other than Contact To relate a task to a record, set reference_id, reference_id_name and reference_type
reference_type	String	Type of object this task is related to Use this attribute to relate the task to any object other than contact
reminder_duration	String	Task reminder duration; For more information see Constants for Task and Event Objects
repeat_flag	Boolean	Flag to specify whether this task repeats or not True value means the task repeats, false indicates no recurrence
status	String	Task status. Defined in the Task Status Global Piclist. ("Not Started", "In Progress", "Waiting on Someone else", "Completed", by default.)
subject	String	Task subject

TEAM Object

DEPRECATED: The Built-in Objects object still exists, but the description on this page is deprecated. For the most comprehensive information, consult the REST API:Team Resource.

Object ID

TEAM

Available Fields

• Required Fields are highlighted, in italics

This state describes the default field property in a new instance of the platform. Users with appropriate Data Access Permissions can change field properties without notice.

• Additional fields may be returned. Such fields are generally intended for internal use, or for backward compatibility. Common fields intended for internal use include:

• CALL_ACTION
• VIEW_ACTION

Field Name	Display Type	Description
name	String	Name of this team. (Must be unique in the parent team's list of subteams.)
parent_team_id	Number	Record ID of the parent team

USER Object

DEPRECATED: The Built-in Objects object still exists, but the description on this page is deprecated. For the most comprehensive information, consult the REST API:User Resource.

Object ID

USER

Available Fields

• Required Fields are highlighted, in italics

This state describes the default field property in a new instance of the platform. Users with appropriate Data Access Permissions can change field properties without notice.

• Additional fields may be returned. Such fields are generally intended for internal use, or for backward compatibility. Common fields intended for internal use include:

• CALL_ACTION
• VIEW_ACTION

Note: In this object, Boolean fields accept only 1 or 0 (not TRUE/FALSE)

Field Name	Display Type	Description
active	Boolean	Specify if this user is active or not Default is 1 (new user is created as an active user)
city	String	City
company	String	Company name
country	String	Country name
email	String	User Email Address
employee_number	String	Employee number
fax	String	Fax Number
first_name	String	User first name
force_password_change_on_login	Boolean	When enabled, the User is prompted to change the password when logging in for the first time Default is 1 (new user is forced to change password on first login)
last_login	Date	Time of the last login by this user
last_name	String	User last name
mobile	String	Mobile Number
notify_by_email	Boolean	When enabled, a notification email is sent (containing the username, welcome and login information) when a new user is added Default is 1 (email is sent automatically, on new user creation)
password	String	Password used to login Considerations Password is required for Login Password is optional when creating a new user via REST API V1.0 If password is not provided, a temporary password is generated and sent to the user/tenant via email Learn more: Manage Email Templates - Forgot Reset Password Email
phone	String	User's phone number
reports_to	String	User's manager or supervisor (often used for approvals in workflows)
team_id	String	ID of the user's primary team Required on Add action Not supported for Update or Search
access_profile_id	String	User's Access Profile identifier Required on Add action Not supported for Update or Search
state	String	State
street	String	User's street address
time_zone	Integer	Time zone (See Time Zone Codes for details)
title	String	Title
username	String	Username is a unique name associated with each User. Username is required to Login, can be an email address or an alphanumeric text string.
zip	String	Zip code

Time Zone Codes

Code	Time Zone
80	(GMT+14:00) Line Is. Time (Pacific/Kiritimati)
76	(GMT+13:00) Phoenix Is. Time (Pacific/Enderbury)
84	(GMT+13:00) Tonga Time (Pacific/Tongatapu)
75	(GMT+12:45) Chatham Daylight Time (Pacific/Chatham)
31	(GMT+12:00) Petropavlovsk-Kamchatski Time (Asia/Kamchatka)
74	(GMT+12:00) New Zealand Daylight Time (Pacific/Auckland)
77	(GMT+12:00) Fiji Time (Pacific/Fiji)
82	(GMT+11:30) Norfolk Time (Pacific/Norfolk)
78	(GMT+11:00) Solomon Is. Time (Pacific/Guadalcanal)
54	(GMT+10:30) Load Howe Summer Time (Australia/Lord Howe)
52	(GMT+10:00) Eastern Standard Time (Queensland)
56	(GMT+10:00) Eastern Summer Time (New South Wales)
51	(GMT+09:30) Central Summer Time (South Australia)
53	(GMT+09:30) Central Standard Time (Northern Territory)
40	(GMT+09:00) Korea Standard Time (Asia/Seoul)
46	(GMT+09:00) Japan Standard Time (Asia/Tokyo)
27	(GMT+08:00) Hong Kong Time (Asia/Hong Kong)
34	(GMT+08:00) Malaysia Time (Asia/Kuala Lumpur)
36	(GMT+08:00) Philippines Time (Asia/Manila)
57	(GMT+08:00) China Standard Time (Asia/Shanghai)
41	(GMT+08:00) Singapore Time (Asia/Singapore)
42	(GMT+08:00) China Standard Time (Asia/Taipei)
55	(GMT+08:00) Western Standard Time (Australia)
22	(GMT+07:00) Indochina Time (Asia/Bangkok)
28	(GMT+07:00) West Indonesia Time (Asia/Jakarta)
39	(GMT+07:00) Indochina Time (Asia/Saigon)
37	(GMT+06:30) Myanmar Time (Asia/Rangoon)
24	(GMT+06:00) Sri Lanka Time (Asia/Colombo)
25	(GMT+06:00) Bangladesh Time (Asia/Dacca)
33	(GMT+05:45) Nepal Time (Asia/Katmandu)
23	(GMT+05:30) India Standard Time (Asia/Calcutta)
32	(GMT+05:00) Pakistan Time (Asia/Karachi)
43	(GMT+05:00) Uzbekistan Time (Asia/Tashkent)
47	(GMT+05:00) Yekaterinburg Time (Asia/Yekaterinburg)
30	(GMT+04:30) Afghanistan Time (Asia/Kabul)
26	(GMT+04:00) Gulf Standard Time (Asia/Dubai)
44	(GMT+04:00) Georgia Time (Asia/Tbilisi)
45	(GMT+03:30) Iran Standard Time (Asia/Tehran)
3	(GMT+03:00) Eastern African Time (Africa/Nairobi)
21	(GMT+03:00) Arabia Standard Time (Asia/Baghdad)
35	(GMT+03:00) Arabia Standard Time (Asia/Kuwait)
38	(GMT+03:00) Arabia Standard Time (Asia/Riyadh)
69	(GMT+03:00) Moscow Standard Time (Europe/Moscow)
1	(GMT+02:00) Eastern European Time (Africa/Cairo)
2	(GMT+02:00) South Africa Standard Time (Africa/Johannesburg)
29	(GMT+02:00) Israel Standard Time (Asia/Jerusalem)
59	(GMT+02:00) Eastern European Time (Europe/Athens)
62	(GMT+02:00) Eastern European Time (Europe/Bucharest)
64	(GMT+02:00) Eastern European Time (Europe/Helsinki)
65	(GMT+02:00) Eastern European Time (Europe/Istanbul)
68	(GMT+02:00) Eastern European Time (Europe/Minsk)
58	(GMT+01:00) Central European Time (Europe/Amsterdam)
60	(GMT+01:00) Central European Time (Europe/Berlin)
61	(GMT+01:00) Central European Time (Europe/Brussels)
70	(GMT+01:00) Central European Time (Europe/Paris)
71	(GMT+01:00) Central European Time (Europe/Prague)
72	(GMT+01:00) Central European Time (Europe/Rome)
63	(GMT+00:00) Greenwich Mean Time (Europe/Dublin)
66	(GMT+00:00) Western European Time (Europe/Lisbon)
67	(GMT+00:00) Greenwich Mean Time (Europe/London)
73	(GMT+00:00) Greenwich Mean Time (GMT)
49	(GMT-01:00) Cape Verde Time (Atlantic/Cape Verde)
50	(GMT-02:00) South Georgia Standard Time (Atlantic/South Georgia)
6	(GMT-03:00) Argentine Time (America/Buenos Aires)
18	(GMT-03:00) Brazil Summer Time (America/Sao Paulo)
19	(GMT-03:30) Newfoundland Standard Time (America/St Johns)
7	(GMT-04:00) Venezuela Time (America/Caracas)
10	(GMT-04:00) Atlantic Standard Time (America/Halifax)
17	(GMT-04:00) Atlantic Standard Time (America/Puerto Rico)
48	(GMT-04:00) Atlantic Standard Time (Atlantic/Bermuda)
5	(GMT-05:00) Colombia Time (America/Bogota)
85	(GMT-05:00) Eastern Standard Time (America/Indianapolis)
11	(GMT-05:00) Peru Time (America/Lima)
14	(GMT-05:00) Eastern Standard Time (America/New York)
15	(GMT-05:00) Eastern Standard Time (America/Panama)
86	(GMT-06:00) Central Standard Time (Canada/Saskatchewan)
8	(GMT-06:00) Central Standard Time (America/Chicago)
13	(GMT-06:00) Central Standard Time (America/Mexico City)
9	(GMT-07:00) Mountain Standard Time (America/Denver)
16	(GMT-07:00) Mountain Standard Time (America/Phoenix)
12	(GMT-08:00) Pacific Standard Time (America/Los Angeles)
20	(GMT-08:00) Pacific Standard Time (America/Tijuana)
4	(GMT-09:00) Alaska Standard Time (America/Anchorage)
79	(GMT-10:00) Hawaii Standard Time (Pacific/Honolulu)
81	(GMT-11:00) Niue Time (Pacific/Niue)
83	(GMT-11:00) Samoa Standard Time (Pacific/Pago Pago)

USER TEAM Object

This is a Junction Object, used to join Users to Teams. (Most developers will never need to reference this object.)

Object ID

USER_TEAM

Available Fields

• Required Fields are highlighted, in italics

This state describes the default field property in a new instance of the platform. Users with appropriate Data Access Permissions can change field properties without notice.

• Additional fields may be returned. Such fields are generally intended for internal use, or for backward compatibility. Common fields intended for internal use include:

• CALL_ACTION
• VIEW_ACTION

Note: In this object, Boolean fields accept only 1 or 0 (not TRUE/FALSE)

Field Name	Display Type	Description
user_id	String	User Id
team_id	Number	Team Id
role_id	Number	Role Id of a USER
flag_primary	Boolean	Flag Team as Primary Default is 0 (this team will not be the specified user’s primary team)
comments	String	Comments