Skip to content

Insert fields in a contract template ​

Field substitutions are inserted into a contract template using Insert Fields mode. These fields appear as chips and are replaced with actual job, organisation, workflow, or personal details when a contract is generated.

Also see

Switch to insert mode ​

  1. Open the contract template using Preview/edit
  2. Click Insert Fields

The available field groups and chips will be shown below the contract text.

Insert a field substitution ​

  1. Click in the contract text where the field should be added
  2. Locate the correct field group
  3. Click the chip to insert it into the contract

The chip will be added to the contract text.

note

The same chip can be added multiple times to a contract template.

InformationField catalogue ​

The following active fields are defined in PICMI's InformationField enum. They are grouped in the same way as the field groups shown in a contract template. The available groups still depend on whether the contract is for employment or a service proposal.

How job information is used in a contract ​

Contract templates should contain the fixed wording that applies across jobs. Add a field substitution for information that changes between jobs or people.

For example, a template can contain fixed wording such as “The employee will work in the role described below”, followed by the Description (Job) substitution. The job description is then supplied by the job rather than typed again into the contract template.

The job fields below are not added to a contract automatically. They appear in the generated contract only when the matching substitution chip has been inserted into the template:

Job informationContract field
Job descriptionDescription (Job)
Work hoursWork Hours
Job Type LabelOpportunity Type Label

The contract field list uses Opportunity Type Label for the value that may be shown as Job Type Label in the job details. If the template does not contain one of these chips, changing that job field will not add it to the contract.

Avoid entering the same variable information as fixed wording in the template. For example, do not write fixed work hours in the contract and also insert Work Hours unless both statements are intended to agree. Avoid putting dates, especially a year, in fixed template wording when the date should come from a job or application substitution.

Before sending an invite, review the job details and the contract template together to check that the fixed wording and the inserted values are complete and do not duplicate or contradict each other. Use Preview and edit to review the template and Navigate inserted to find the chips already used in it.

Information (Individual) ​

FieldDescription
Given NameThe person's first names.
Family NameThe person's family name.
Middle NameThe person's middle name.
NicknameThe person's nickname.
Preferred NameThe person's preferred name.
EmailThe person's email address.
Email (Verified)Whether the person's email address is verified.
PhoneThe person's phone number.
Phone (Verified)Whether the person's phone number is verified.
HeightThe person's height in metres.
ZoneThe person's time zone information.
LocaleThe person's locale.
NationalityThe person's nationality.
ProfileThe person's profile.
PictureThe person's picture.
WebsiteThe person's website.
SignatureThe person's electronic signature text.

Listing ​

These fields are available for employment contracts and describe the job or listing.

FieldDescription
TitleThe job title.
Description (Job)The main job description.
Date Posted (Listing)The date the listing was posted.
Valid Through (Listing)The date the listing is valid through.
Work HoursThe job's general work hours.
RemunerationThe job's pay rate or remuneration.
Street AddressThe job's street address.
Location (Additional Details)Additional location details for the job.
StartThe job start date.
EndThe job end date.
Summary (Start & End)The job's summary of start and end dates or conditions.
Opportunity Type LabelThe opportunity type label.
Incentive CompensationIncentive compensation details for the job.
BenefitsBenefits provided for the job.
Special CommitmentsSpecial commitments for the job.
Top up to hourly rateWhether the employee's earnings should be topped up to their hourly rate.
Weekly minimum earningsThe minimum weekly earnings agreed for the employee.

For Tātou, Top up to hourly rate and Weekly minimum earnings can use the job values or the person's personal overrides. A personal override takes precedence over the job setting, and the job setting takes precedence over the Tātou integration setting. For more information, see Job settings.

Organisation (Sending) ​

These fields describe the organisation sending the contract.

FieldDescription
NameThe sending organisation's name.
DescriptionThe sending organisation's description.
EmailThe sending organisation's email address.
Email VerifiedWhether the sending organisation's email is verified.
PhoneThe sending organisation's phone number.
Phone VerifiedWhether the sending organisation's phone is verified.
Zone InfoThe sending organisation's time zone information.
LocaleThe sending organisation's locale.
ProfileThe sending organisation's profile.
PictureThe sending organisation's picture.
WebsiteThe sending organisation's website.
Authorised SignatureThe sending organisation's authorised signature.

External Identifier ​

FieldDescription
External IdentifierAn external identifier provided by PICMI.

Organisation (Receiving) ​

These fields describe the organisation receiving the contract, where applicable.

FieldDescription
NameThe receiving organisation's name.
DescriptionThe receiving organisation's description.
EmailThe receiving organisation's email address.
Email VerifiedWhether the receiving organisation's email is verified.
PhoneThe receiving organisation's phone number.
Phone VerifiedWhether the receiving organisation's phone is verified.
Zone InfoThe receiving organisation's time zone information.
LocaleThe receiving organisation's locale.
ProfileThe receiving organisation's profile.
PictureThe receiving organisation's picture.
WebsiteThe receiving organisation's website.
Authorised SignatureThe receiving organisation's authorised signature.

Find a field chip ​

  1. Use the field group chips at the top to move between sections
  2. Use the search field to narrow the available chips
  3. Click the chip once you have found the correct field

This helps when a section contains many available fields.

Check selected chips in the list ​

  1. Review the chips shown as selected in each field group
  2. Click a chip in the list to clear its selection if needed

Clearing a chip from the list does not remove it from the contract text.

note

To remove a chip from the contract itself, click to the right of the chip in the text and delete it from there.

PICMI is the simple hiring tool that helps make your job their first choice