Data Types

Carrot understands many rich data types, including standard types such as Number﻿ and String﻿ that are common across systems, as well as a number of ChartHop-specific data types.﻿﻿
Basic Data Types
These data types are basic building blocks of the system.
Type
Description
Example Syntax
﻿Boolean﻿ 
A true or false value. (Also known as "Yes or No")
true
﻿Currency﻿ 
A national currency, such as the dollar or euro.
﻿
﻿Date﻿ 
A  date, independent of time.
date('2025-01-01')
﻿Enum﻿ 
A multiple-choice value selected by a user.
enum("Meets Expectations")
﻿Image﻿ 
An image stored on the ChartHop system
﻿
﻿Money﻿ 
A monetary value, including currency and amount.
money(1000, 'USD')
﻿List﻿ 
Represents a list of any other value
[1, 2, 3]
﻿Null﻿ 
An empty value that means "data not set"
null
﻿Number﻿ 
A number, either decimal or integer.
42.123
﻿Percent﻿ 
A percentage value
42%
﻿String﻿ 
A piece of text.
"Hello, world!"
﻿Timestamp﻿ 
A moment in time (both date and time, timezone-independent)
﻿
ChartHop Data Types
These data types represent more complex structures that can be used inside other fields.
Type
Description
﻿Address﻿ 
A mailing address, including street address, city, and postal code.
﻿Name﻿ 
The name of a person, including first, last, and preferred names.
﻿PayInterval﻿ 
A recurring pay rate, such as an hourly or yearly salary.
﻿VariableComp﻿ 
Target variable compensation, such as an annual bonus or commission target. 
﻿
﻿
ChartHop Entity Types
These data types represent important objects within the ChartHop data model.
Entity Type
Description
﻿Comp Band﻿ 
A compensation band used to describe pay levels.
﻿
﻿
﻿File﻿ 
A file that has been uploaded into the ChartHop system, such as a document.
﻿Group﻿ 
An organizational unit comprising Jobs and People, such as a Department, Location, or Team.
﻿Job﻿ 
A set of responsibilities represented as a box on the org chart.
﻿Person﻿ 
A person, such as an employee.
﻿StockGrant﻿ 
An equity or stock option grant issued to a Person.
﻿TimeOff﻿ 
Time Off requested or taken by a Person, including paid and unpaid leave.
﻿User﻿ 
A user of the ChartHop system. This often represents the user-identity of a corresponding Person﻿, but also might be an app or an external user who is not part of the organization.
﻿

Type	Description	Example Syntax
Boolean	A true or false value. (Also known as "Yes or No")	true
Currency	A national currency, such as the dollar or euro.
Date	A date, independent of time.	date('2025-01-01')
Enum	A multiple-choice value selected by a user.	enum("Meets Expectations")
Image	An image stored on the ChartHop system
Money	A monetary value, including currency and amount.	money(1000, 'USD')
List	Represents a list of any other value	[1, 2, 3]
Null	An empty value that means "data not set"	null
Number	A number, either decimal or integer.	42.123
Percent	A percentage value	42%
String	A piece of text.	"Hello, world!"
Timestamp	A moment in time (both date and time, timezone-independent)

Type	Description
Address	A mailing address, including street address, city, and postal code.
Name	The name of a person, including first, last, and preferred names.
PayInterval	A recurring pay rate, such as an hourly or yearly salary.
VariableComp	Target variable compensation, such as an annual bonus or commission target.

Entity Type	Description
Comp Band	A compensation band used to describe pay levels.

File	A file that has been uploaded into the ChartHop system, such as a document.
Group	An organizational unit comprising Jobs and People, such as a Department, Location, or Team.
Job	A set of responsibilities represented as a box on the org chart.
Person	A person, such as an employee.
StockGrant	An equity or stock option grant issued to a Person.
TimeOff	Time Off requested or taken by a Person, including paid and unpaid leave.
User	A user of the ChartHop system. This often represents the user-identity of a corresponding Person, but also might be an app or an external user who is not part of the organization.

Updated 20 Nov 2024

Did this page help you?

Previous Time Off

Address