Table of Contents


Field Type Reference

Every EntityField is created with a FieldTypeId. All IDs are case-sensitive — copy them exactly, including the lowercase hex letters (a through m).


Field Type IDs

TypeFieldTypeIdDescription
Text7NY0000000000000000Single-line text.
DateTime7NY0000000000020000Date + time.
GlobalPicklist7NY0000000000030000Picklist bound to a shared value set.
TextArea7NY0000000000040000Long / multi-line text. Supports rich-text via FieldOptions.IsHtmlField.
Checkbox7NY0000000000050000Boolean.
Lookup7NY0000000000060000Reference to a record on another entity.
Date7NY0000000000070000Date only.
Time7NY0000000000080000Time only.
Picklist7NY0000000000090000Single-select picklist with its own value set.
Currency7NY00000000000a0000Numeric currency amount.
Number7NY00000000000b0000Numeric.
Percent7NY00000000000c0000Numeric percentage.
Email7NY00000000000d0000Email address, format-validated.
Phone7NY00000000000e0000Phone number.
URL7NY00000000000f0000URL, format-validated.
PicklistMultiSelect7NY00000000000g0000Multi-select picklist. Values are semicolon-delimited on the wire.
MasterDetail7NY00000000000h0000Owned-by relationship. Child records cascade-delete with the parent and support Rollup Summary aggregation.
RollupSummary7NY00000000000i0000Read-only aggregation of child records. See Rollup Summary Fields.
AutoNumber7NY00000000000k0000Auto-incrementing formatted number.
Password7NY00000000000l0000Secret / masked text; the stored value is not returned on GET.
Formula7NY00000000000m0000Read-only expression evaluated at read time. See Formula Fields.

Per-Type Required Properties

Field TypeRequired beyond the base payload
TextLength
TextAreaLength, NumberOfVisibleLines
Number, Currency, PercentLength, DecimalPlaces
Checkbox(nothing extra; DefaultValue must be "true" or "false" if sent)
Email, Phone, URL, Date, DateTime, Time, Password(nothing extra)
PicklistPicklists (at least one value)
PicklistMultiSelectPicklists, NumberOfVisibleLines
GlobalPicklistPicklistTypeId (bind to an existing GlobalPicklistType). Do not send an embedded Picklists array.
LookupRelatedToEntityId, RelatedToRelationshipName
MasterDetailRelatedToEntityId, RelatedToRelationshipName
RollupSummaryDefaultValue (operation), RelatedToEntityId, RelatedToFilterFieldId, RelatedToFieldId (except for COUNT)
FormulaDefaultValue (expression), RelatedToFieldId (return-type ID)
AutoNumberDisplayFormat ({0:0+} token), StartingNumber, Increments

DefaultValue by Type

TypeFormat
Checkbox"true" or "false". Any other value is rejected.
EmailValid email address.
URLValid URL.
PhoneValid phone number.
Number, Currency, PercentA numeric string. Must fit within the field's Length and DecimalPlaces.
Date, DateTime, TimeValid ISO-format date/time.
Picklist, GlobalPicklistMust match one of the field's (or bound global type's) values exactly.

IsUnique Support

IsUnique is only accepted on these field types:

Text, Number, Currency, Percent, Email, Phone, URL, Date, DateTime, AutoNumber

Setting IsUnique on Picklist, MultiSelect, Lookup, MasterDetail, Formula, or Rollup fields is rejected.


Numeric Length Rules

For Number, Currency, and Percent:

  • Length is the number of digits left of the decimal.
  • DecimalPlaces = 0 for whole numbers.
  • Length + DecimalPlaces cannot exceed the type's maximum precision. The platform will return a validation error if it does.

AutoNumber Format

Both entity-level auto-numbers (on the built-in Name field) and AutoNumber fields use the same format pattern. The regex enforced is:

^.*\{0\:0{1,}\}[^\{^\}]*$

Exactly one {0:0+} counter token, no other braces. Zero-padding is defined by the number of zeros in the token. Examples:

FormatProduces
INV-{0:0000}INV-1000, INV-1001, ...
PO/{0:00000000}PO/00001000, ...
{0:00}01, 02, ...
INV-{0000}Rejected — token missing the 0: prefix.
{0:0000}-{0:0000}Rejected — multiple braces.

Date tokens (year, month) are not supported.


Reserved Field Names

Id, Name, OwnerId, IsDeleted, CreatedOn, ModifiedOn, CreatedById, ModifiedById, RecordTypeId

Comparison is case-insensitive against the base name (before the __c suffix).


<< EntityField Resource | Picklists and Global Picklists >>

Last updated on 7/28/2026

Attachments