Import field reference

Every importable record type and field. Generated from IMPORT_ENTITIES in packages/core/src/imports/entities.ts.

Type: text is copied (trimmed); number strips $, , and spaces; boolean accepts yes/no, y/n, true/false, 1/0; date becomes YYYY-MM-DD; datetime is a date and time (include an offset).
Lookup: the column must identify an existing record or an active definition. See Lookups.
For Clients, the person fields (name, contact, address, emergency contact) are written to the client's person record.

Clients

Record type key: client.

Field	Key	Required	Type	Lookup
First name	`firstName`	Yes	text
Last name	`lastName`	Yes	text
Middle name	`middleName`		text
Preferred name	`preferredName`		text
Email	`email`		text
Phone	`phone`		text
Alternate phone	`alternatePhone`		text
Date of birth	`dateOfBirth`		date
Gender	`gender`		text
Preferred language	`preferredLanguage`		text
Address line 1	`addressLine1`		text
Address line 2	`addressLine2`		text
City	`city`		text
Province	`province`		text
Postal code	`postalCode`		text
Emergency contact	`emergencyContact`		text
Emergency contact phone	`emergencyContactPhone`		text
Client number	`clientNumber`		text
Status	`currentStatusId`		text	Definition set `client_status`
Assigned staff (email)	`assignedStaffId`		text	staff (by email)
Site	`primarySiteId`		text	sites (by name)
Intake started	`intakeStartedAt`		datetime
Job search notes	`jobSearchNotes`		text
Company	`companyName`		text

Record type key: people.

Field	Key	Required	Type
First name	`firstName`	Yes	text
Last name	`lastName`	Yes	text
Middle name	`middleName`		text
Preferred name	`preferredName`		text
Email	`email`		text
Phone	`phone`		text
Alternate phone	`alternatePhone`		text
Date of birth	`dateOfBirth`		date
Gender	`gender`		text
Preferred language	`preferredLanguage`		text
Address line 1	`addressLine1`		text
Address line 2	`addressLine2`		text
City	`city`		text
Province	`province`		text
Postal code	`postalCode`		text
Emergency contact	`emergencyContact`		text
Emergency contact phone	`emergencyContactPhone`		text

Record type key: staff.

Field	Key	Required	Type	Lookup
Person (email)	`personId`	Yes	text	people (by email)
Title	`title`		text
Employee number	`employeeNumber`		text
Role	`staffRoleId`		text	Definition set `staff_role`
Status	`statusId`		text	Definition set `staff_status`
Department	`departmentId`		text	Definition set `department_type`
Site	`primarySiteId`		text	sites (by name)
Hire date	`hiredAt`		date
Max open cases	`maxOpenCases`		number
Bookable	`isBookableResource`		boolean

Record type key: applicant.

Field	Key	Required	Type	Lookup
Person (email)	`personId`	Yes	text	people (by email)
Registration status	`registrationStatusId`		text	Definition set `applicant_registration_status`
Source	`sourceId`		text	Definition set `applicant_source`
Work authorization	`workAuthorizationStatusId`		text	Definition set `work_authorization_status`
Linked client (email)	`linkedClientId`		text	clients (by email)

Record type key: case.

Field	Key	Required	Type	Lookup
Client (email or client #)	`clientId`	Yes	text	clients (by email)
Case type	`typeId`	Yes	text	Definition set `case_type`
Case status	`statusId`	Yes	text	Definition set `case_status`
Case number	`caseNumber`	Yes	text
Title	`title`	Yes	text
Opened at	`openedAt`	Yes	datetime
Priority	`priorityId`		text	Definition set `case_priority`
Program	`programId`		text	Definition set `program`
Assigned staff (email)	`primaryStaffId`		text	staff (by email)
Description	`description`		text
Closed at	`closedAt`		datetime

Record type key: follow-up.

Field	Key	Required	Type	Lookup
Task	`task`	Yes	text
Due date	`dueDate`		datetime
Client (email)	`clientId`		text	clients (by email)
Case number	`caseId`		text	cases (by caseNumber)
Staff (email)	`staffId`		text	staff (by email)
Status	`statusId`		text	Definition set `follow-up-statuses`
Priority	`priorityId`		text	Definition set `follow-up-priorities`

Record type key: appointment (alias: schedule).

Field	Key	Required	Type	Lookup
Title	`title`	Yes	text
Start	`startAt`	Yes	datetime
End	`endAt`	Yes	datetime
Type	`typeId`	Yes	text	Definition set `appointment_type`
Status	`statusId`	Yes	text	Definition set `appointment_status`
Client (email)	`clientId`		text	clients (by email)
Staff (email)	`primaryStaffId`		text	staff (by email)
Site	`siteId`		text	sites (by name)
Location	`locationText`		text
Description	`description`		text

Record type key: event.

Field	Key	Required	Type	Lookup
Title	`title`	Yes	text
Start	`startAt`	Yes	datetime
End	`endAt`	Yes	datetime
Type	`typeId`	Yes	text	Definition set `event_type`
Status	`statusId`	Yes	text	Definition set `event_status`
Capacity	`capacity`		number
Site	`siteId`		text	sites (by name)
Public	`isPublic`		boolean
Description	`description`		text

Record type key: employer.

Field	Key	Required	Type	Lookup
Legal name	`legalName`	Yes	text
Status	`statusId`	Yes	text	Definition set `employer_status`
Display name	`displayName`		text
Business number	`businessNumber`		text
Email	`email`		text
Phone	`phone`		text
Website	`websiteUrl`		text
Address	`addressLine1`		text
City	`city`		text
Province	`province`		text
Postal code	`postalCode`		text
Industry	`industry`		text
Company size	`companySize`		text
Source	`sourceId`		text	Definition set `employer_source`
Owner (email)	`ownerStaffId`		text	staff (by email)

Record type key: employer-contact.

Field	Key	Required	Type	Lookup
Employer (name)	`employerId`	Yes	text	employers (by legalName)
First name	`firstName`		text
Last name	`lastName`		text
Title	`title`		text
Email	`email`		text
Phone	`phone`		text
Primary	`isPrimary`		boolean

Record type key: employer-interaction.

Field	Key	Required	Type	Lookup
Employer (name)	`employerId`	Yes	text	employers (by legalName)
Date	`interactionAt`	Yes	datetime
Subject	`subject`		text
Summary	`summary`		text
Type	`interactionTypeId`		text	Definition set `interaction_type`
Staff (email)	`staffId`		text	staff (by email)

Record type key: job-posting.

Field	Key	Required	Type	Lookup
Employer (name)	`employerId`	Yes	text	employers (by legalName)
Title	`title`	Yes	text
Description	`description`	Yes	text
Status	`statusId`	Yes	text	Definition set `job_posting_status`
Posting code	`postingCode`		text
Location	`locationText`		text
Employment type	`employmentTypeId`		text	Definition set `employment_type`
Workplace type	`workplaceTypeId`		text	Definition set `workplace_type`
Category	`categoryId`		text	Definition set `job_category`
Salary min	`salaryMin`		number
Salary max	`salaryMax`		number
Salary text	`salaryText`		text
Openings	`openingsCount`		number
Closes at	`closesAt`		datetime
Show on public portal	`showOnPublicPortal`		boolean

Record type key: job-application.

Field	Key	Required	Type	Lookup
Applicant (email)	`applicantId`	Yes	text	applicants (by email)
Job posting (code or title)	`jobPostingId`	Yes	text	job-postings (by postingCode)
Status	`statusId`	Yes	text	Definition set `job-application-statuses`
Stage	`currentStageId`		text	Definition set `application_stage`
Applied at	`appliedAt`		datetime