Contract schema
For more information, see Contracts.
To add custom fields to the contract schema, Add a custom person or contract field.
Mappable fields
The following fields are included in the default contract schema, and can be mapped in Source mappings.
Note
After the source mapping, each contract needs to have:
A unique identifier, stored in the
ExternalIdfield of a contract.If a Departments import script is used: a
DepartmentCode, which must correspond to theExternalIdof a department defined in the Departments import script
Although only the ExternalId field is strictly required, it makes sense for contracts to also have at least a start date and a title.
Name | Description | Example |
|---|---|---|
ExternalId (required) | Uniquely identifies the contract. | C-81086338 |
StartDate | 2012-02-18T00:00:00 | |
EndDate | 2026-04-11T00:00:00 | |
Type.Code | ||
Type.Description | ||
Details.Fte | 0 | |
Details.HoursPerWeek | 39 | |
Details.Percentage | 0 | |
Details.Sequence | 0 | |
Location.ExternalId | ||
Location.Code | ||
Location.Name | ||
CostCenter.ExternalId | ||
CostCenter.Code | ||
CostCenter.Name | ||
CostBearer.ExternalId | ||
CostBearer.Code | ||
CostBearer.Name | ||
Employer.ExternalId | ||
Employer.Code | ||
Employer.Name | ||
Manager.ExternalId | ||
Team.ExternalId | ||
Team.Code | ||
Team.Name | ||
Department.ExternalId | Uniquely identifies the department associated with each contract. By default, this is mapped from the DepartmentCode in the Persons import script. | 474zx7gq93 |
Department.DisplayName | Used as a fallback if the Departments import script doesn't have a DisplayName defined for a contract's Department.ExternalId. If the script does have a DisplayName defined, that is used as the department's display name, and this field isn't used at all. | Health, Industrial, & Movies |
Division.ExternalId | ||
Division.Code | ||
Division.Name | ||
Title.ExternalId | C-20681249 | |
Title.Code | ||
Title.Name | Direct Web Orchestrator | |
Organization.ExternalId | ||
Organization.Code | ||
Organization.Name |
Special fields
The following fields are not mappable. Instead, they are read-only fields that you can access in various PowerShell scripts and in Notifications.
Name | Description | Example |
|---|---|---|
Custom.<CustomFieldName> | Contains all custom fields that you've added to the contract schema with the Add a custom person or contract field feature. |
|