API Field Directory - PlacementsFields available via the API for Placement records, with required formatting.
Field Name
Format
Example
Description
UserId *
String
"USER_10"
The Colleague 7 User ID (mandatory)
PlacementId
int32
"1114"
Unique ID of the Placement record
ParentId
int32
"1114"
ID of the parent Placement
LatestPlacementId
int32
"1114"
ID of the latest Placement in the chain
PlacementType
int32
"0"
Placement type code
PlacementTypeDescription
String
"Placement"
Placement type description
JobType
int32
"1"
Job type code
JobTitle
String
"Sales Manager"
Job title of the Placement
Dept
String
"Perm Team"
Department
EntityDescription
String
"Placement for Bertie Portal as Sales Manager at Colleague Software with John Smith"
Summary description of the record
RequirementId
int32
"1045"
ID of the linked Requirement
RequirementTemplateId
int32
"0"
ID of the Requirement template
CandidateId
int32
"484"
ID of the Candidate
CandidateName
String
"Bertie Portal"
Name of the Candidate
CandidateTitle
String
"Mr"
Title of the Candidate
CandidateTitleDescription
String
"Mr"
Title lookup description of the Candidate
CandidateForenames
String
"Bertie"
Forenames of the Candidate
CandidateSurname
String
"Portal"
Surname of the Candidate
CandidateEmailAddress
String
"bertieportal@colleaguedemo.com"
Email address of the Candidate
CandidateMailshotStatus
String/Lookup
"MAILSHOTSTATUSALLOWALL"
Mailshot status of the Candidate
CandidateConsentGiven
Boolean (0/1)
"1"
Candidate has given GDPR consent
CandidateSource
String/Lookup
"Referral"
Candidate Source lookup
ApplicantSource
String/Lookup
"Referral"
Applicant Source lookup
NationalInsuranceNo
String
"JM641312B"
National Insurance number of the Candidate
UTR
String
""
Unique Taxpayer Reference
SocialSecurityNo
String
""
Social security number
CompanyId
int32
"1"
ID of the Company
CompanyName
String
"Colleague Software"
Name of the Company
OwningCompanyId
int32
"0"
ID of the owning company
ContactId
int32
"149"
ID of the Contact
ContactName
String
"John Smith"
Name of the Contact
ContactTitle
String
null
Title of the Contact
ContactTitleDescription
String
null
Title lookup description of the Contact
ContactForenames
String
"John"
Forenames of the Contact
ContactSurname
String
"Smith"
Surname of the Contact
ContactEmailAddress
String
"john.smith@colleaguesoftware.com"
Email address of the Contact
ContactMailshotStatus
String/Lookup
"MAILSHOTSTATUSALLOWALL"
Mailshot status of the Contact
ContactConsentGiven
Boolean (0/1)
"1"
Contact has given GDPR consent
ApproverContacts
String
""
Contacts who approve timesheets
WorkingCompanyId
int32
"1"
ID of the working Company
WorkingCompanyName
String
"Colleague Software"
Name of the working Company
WorkingAddress
String
"The Control Tower, Witchcraft Way, Rackheath, Norwich, NR13 6GA"
Working address as a single line
WorkingAddressId
int32
"7436"
ID of the working address
ContractAddressId
int32
"7435"
ID of the contract address
Country
String/Lookup
"United Kingdom"
Country of the working address
StartDate
date (dd MMM yyyy)
"01 Dec 2024"
Start date of the Placement
EndDate
date (dd MMM yyyy)
null
End date of the Placement
Working
date-time
"2024-12-01 00:00:00.000"
Date the Candidate started working
StartTime
String
"09:00"
Daily start time
EndTime
String
"17:30"
Daily end time
HoursPerWeek
Decimal
"37.0"
Hours per week
HoursPerDay
Decimal
"7.5"
Hours per day
HoursUOM
int32
"1"
Hours unit of measure
UnitsPerWeek
Decimal
"5.0"
Units per week
BreakEntitlement
Decimal
"1.0"
Break entitlement
Duration
int32
"0"
Duration of the Placement
DurationUOM
int32
"1"
Duration unit of measure
RenewalPeriod
int32
"0"
Renewal period
NoticePeriod
int32
"12"
Notice period
NoticePeriodUOM
int32
"1"
Notice period unit of measure
NoticePeriod2
int32
"4"
Second notice period
NoticePeriod2UOM
int32
"1"
Second notice period unit of measure
Benefits
String
"Offers flexible and remote working"
Benefits package
IR35Status
String
""
IR35 status
Salary
Decimal
"65000.0"
Salary
PlacementFee
Decimal
"3250.0"
Placement fee
PlacementFeePercentage
Decimal
"5.0"
Placement fee as a percentage
ChargeRate
Decimal
"150.0"
Charge rate
NetChargeRate
Decimal
"0.0"
Net charge rate
ChargeUnit
int32
"3"
Charge unit code
ChargeCurrency
String/Lookup
null
Charge currency
ChargeRateDecimalPlaces
int32
"2"
Decimal places used for the charge rate
PayRate
Decimal
"125.0"
Pay rate
NetPayRate
Decimal
"0.0"
Net pay rate
PayRate2
Decimal
"0.0"
Second pay rate
PayRate3
Decimal
"0.0"
Third pay rate
PayRate4
Decimal
"0.0"
Fourth pay rate
PayCurrency1
String/Lookup
"GBP"
Currency of the pay rate
PayCurrency2
String/Lookup
null
Currency of the second pay rate
PayCurrency3
String/Lookup
null
Currency of the third pay rate
PayCurrency4
String/Lookup
null
Currency of the fourth pay rate
PayRateDecimalPlaces
int32
"2"
Decimal places used for the pay rate
RateUOM
String
"Month"
Rate unit of measure
CurrencyCode
String/Lookup
"GBP" or lookup code
Currency lookup
Margin
Decimal
"5.0"
Margin
MarginOnlyContract
Boolean (0/1)
"0"
Contract is margin only
MarginOnlyRateMarginOnlyMarkup
Decimal
"0.0"
Margin only markup
UpliftRate
Decimal
"0.0"
Uplift rate
NIThresholdRate
Decimal
"0.0"
NI threshold rate
PAYECalculatorOption
String
null
PAYE calculator option
CommissionSplits
String
"David Demo: 100.00%"
Commission split between users
SentBy
String
"David Demo"
User who sent the Candidate
SentByUser
String
"David Demo"
User who sent the Candidate
ResourcedBy
String
"David Demo"
User who resourced the Candidate
PlacedBy
String
"David Demo"
User who made the Placement
PlacedByUser
String
"David Demo"
User who made the Placement
IncludePlacedByInNotif
Boolean (0/1)
"0"
Include the placing user in notifications
DateOfferAccepted
date-time
"2026-06-05 00:00:00.000"
Date the offer was accepted
DateOfferRejected
date-time
null
Date the offer was rejected
AuthorisedLevel
int32
"2"
Current authorisation level
Level1Authorised
Boolean (0/1)
"1"
Placement has been authorised at level 1
Level1DateAuthorised
date (dd MMM yyyy)
"25 Sep 2026"
Date authorised at level 1
Level1AuthorisedBy
String
"USER_8"
User who authorised at level 1
Level2Authorised
Boolean (0/1)
"1"
Placement has been authorised at level 2
Level2DateAuthorised
date (dd MMM yyyy)
"25 Sep 2026"
Date authorised at level 2
Level2AuthorisedBy
String
"USER_8"
User who authorised at level 2
AuthorisationLevel
int32
"0"
Authorisation level
ContractId
int32
"0"
ID of the contract
ContractReference
int32
"0"
Contract reference
CostCentre
String
null
Cost centre
DefaultPONumber
String
null
Default purchase order number
TimesheetType
int32
"-1"
Timesheet type code
TimesheetMethod
String/Lookup
null
Timesheet method
TimesheetTemplate
String
null
Timesheet template
TimesheetClientAuthorise
Boolean (0/1)
"0"
Client authorises timesheets
AllTimesheetsRecd
Boolean (0/1)
"0"
All timesheets have been received
LastTimesheetDate
date-time
null
Date of the last timesheet
PeriodEndDay
int32
"0"
Period end day
MgmtCompanyId
int32
"0"
ID of the management company
InvoiceId
int32
"0"
ID of the invoice
InvoicePlacementId
int32
"1114"
Placement ID used for invoicing
InvoiceCompanyId
int32
"1"
ID of the invoice Company
InvoiceCompanyName
String
"Colleague Software"
Name of the invoice Company
InvoiceCompanyNumber
String
"CSL12345"
Registration number of the invoice Company
InvoiceVatNumber
String
"GB 123 45 6"
Invoice VAT number
InvoiceAccountReference
String
"ACCREF5566"
Invoice account reference
InvoiceTaxCode
String
"20"
Invoice tax code
InvoiceAddressId
int32
"7437"
ID of the invoice address
InvoiceContactId
int32
"2"
ID of the invoice Contact
InvoiceContactTitle
String
"Mr"
Title of the invoice Contact
InvoiceContactForenames
String
"Mike"
Forenames of the invoice Contact
InvoiceContactSurname
String
"Granger"
Surname of the invoice Contact
InvoiceApproverContacts
String
""
Contacts who approve invoices
AdditionalInvoiceContacts
String
""
Additional Contacts that receive invoices
InvoiceFrequency
String/Lookup
"Monthly"
Invoice frequency
InvoiceMethod
String/Lookup
"Company/Candidate"
Invoice method
InvoicePeriod
int32
"0"
Invoice period code
UseInvoiceSchedule
Boolean (0/1)
"0"
An invoice schedule is used
PaymentTerms
String/Lookup
"30 Days"
Payment terms
InvoiceDateCreated
date-time
"2026-06-05 11:47:50.230"
Date the invoice details were created
InvoiceDetailsCreatedBy
String
"USER_8"
User who created the invoice details
InvoiceDateAmended
date-time
"2026-06-05 11:47:50.230"
Date the invoice details were last amended
InvoiceAmendedBy
String
"USER_8"
User who last amended the invoice details
PayeePlacementId
int32
"1114"
Placement ID used for payment
PayeeCompanyId
int32
"0"
ID of the payee company
PayeeCompanyName
String
"B Portal Solutions"
Name of the payee company
PayeeCompanyNumber
String
"6376789"
Registration number of the payee company
PayeeHMRCType
String
""
HMRC employment type of the payee
PayeeVatNumber
String
"8743VAT"
VAT number of the payee
PayeeAccountReference
String
"82"
Account reference of the payee
PayeeTaxCode
String
"20"
Tax code of the payee
PayeeAddressId
int32
"7438"
ID of the payee address
PayeeContactId
int32
"0"
ID of the payee Contact
PayeeContactName
String
"Bertie Portal"
Name of the payee contact
PayeeEmailAddress
String
"bertieportal@colleaguedemo.com"
Email address of the payee
PayeeBankDetails
String
""
Bank details of the payee
PaymentFrequency
String/Lookup
"Monthly"
Payment frequency
PaymentMethod
String/Lookup
"BACS"
Payment method
PaymentPeriod
int32
"0"
Payment period code
PayeeDateCreated
date-time
"2026-06-05 11:47:50.230"
Date the payee details were created
PayeeDetailsCreatedBy
String
"USER_8"
User who created the payee details
PayeeDateAmended
date-time
"2026-06-05 11:47:50.230"
Date the payee details were last amended
PayeeDetailsAmendedBy
String
"USER_8"
User who last amended the payee details
TertiaryUsed
Boolean (0/1)
"0"
A tertiary supplier is used
TertiaryCompanyId
int32
"0"
ID of the tertiary Company
TertiaryCompanyName
String
null
Name of the tertiary Company
TertiaryContactId
int32
"0"
ID of the tertiary Contact
TertiaryContactTitle
String
null
Title of the tertiary Contact
TertiaryContactForenames
String
null
Forenames of the tertiary Contact
TertiaryContactSurname
String
null
Surname of the tertiary Contact
TertiaryContactEmail
String
null
Email address of the tertiary Contact
TertiaryCurrencyCode
String/Lookup
null
Currency of the tertiary supplier
TertiaryPermFeeSplit
Decimal
"0.0"
Tertiary share of the permanent fee
TertiaryPermFee
Decimal
"0.0"
Tertiary permanent fee
TertiaryRate
Decimal
"0.0"
Tertiary rate
TertiaryRateMarginOnlySplit
Decimal
"0.0"
Tertiary margin only split
TertiaryRateDecimalPlaces
Decimal
"2.0"
Decimal places used for the tertiary rate
ShowPayRateInCandidatePortal
Boolean (0/1)
"0"
Show the pay rate in the Candidate Portal
ShowChargeRateInContactPortal
Boolean (0/1)
"1"
Show the charge rate in the Contact Portal
PortalCandidateNotifications
Boolean (0/1)
"0"
Send Portal notifications to the Candidate
PortalContactNotifications
Boolean (0/1)
"0"
Send Portal notifications to the Contact
DateCreated
date-time
"2026-06-05 11:47:50.223"
Date the record was created
CreatedBy
String
"USER_8"
User ID of the user who created the record
CreatedByUser
String
"David Demo"
Name of the user who created the record
DateAmended
date-time
"2026-09-25 10:14:23.590"
Date the record was last amended
AmendedBy
String
"USER_8"
User ID of the user who last amended the record
AmendedByUser
String
"David Demo"
Name of the user who last amended the record
NoteId
int32
"0"
ID of the notes held against the record
AlertText
String
null
Alert text shown on the record
* Mandatory field.
|