Field Name
Format
Example
Description
userId *
String
"USER_10"
The Colleague 7 User ID (mandatory)
candidateId
ID
"123"
The ID of the Candidate record
jobType
Numeric
"1"
0 = Contract, 1 = Permanent, 2 = Rolling Contract, 3 = Unknown, 4 = Education
jobTitle
String
"Developer"
Job title during employment
notes
String
"First job after University"
Notes on the employment or education
companyName
String
"Colleague Software"
Company name (employer or college / university)
contactName
String
"Will Minns"
Name of contact (line manager or teacher)
location
String
"Chichester, UK"
Location of employment or education
workingCompanyId
ID
"321"
ID of the Company record where employment took place (if a parent company)
owningCompany
String
"Colleague Software"
Name of parent company
startDate
String
"21/04/19"
Start date of employment or education
endDate
String
"21/04/20"
End date of employment or education
chargeRate
Numeric
"100.00"
Charge rate (2 decimal places)
otChargeRate
Numeric
"120.00"
Overtime charge rate (2 decimal places)
payRate
Numeric
"75.00"
Pay rate (2 decimal places)
otPayRate
Numeric
"100.00"
Overtime pay rate (2 decimal places)
noticePeriod
Numeric
"4"
Notice period
SkillsToAdd
Array
JSON array of { lookupCode, lookupParent, lookupPath }
Skills to add to the Experience record (lookupCode mandatory; parent & path optional)
