DemandFlow Support Centre

The PLACE entity represents a placement record representing a successful candidate-to-vacancy match, tracking the full lifecycle from start through extension to close.

PLACE: Placement

The PLACE entity represents a placement record representing a successful candidate-to-vacancy match, tracking the full lifecycle from start through extension to close.

Default definition. This article describes the default PLACE definition shipped with DemandFlow. Administrators can add, remove, rename, or re-type fields, change which ones are required, and alter the layout from the Definitions screen in Settings. Your tenant's current schema may differ from what is shown here. To read the current definition at any time, GET the DEFINITION object whose id matches PLACE.

Entity properties

Property	Value
Entity code	`PLACE`
Display name	Placement
Plural	Placements
Level	11000

Use cases

PLACE represents a confirmed placement in the recruitment process. Created when a candidate is matched to a vacancy and placed with a client. Links to CLIENT via multi-link, to VAC via objectLookup, and to PPL for candidate and client contacts. Fields modelled from Dynamics 365 crimson_placement entity with clean DemandFlow naming conventions. The Financial panel splits into permanent and contract views matching the positionType. Commission supports up to 4-way splits between consultants.

Fields

General

Field	Type	Required	Notes
`name`	text	Yes	Name.
`ref`	text		Placement reference. Read-only.
`placementStatus`	enum	Yes	Status. Valid ids: `pending` (Pending), `issued` (Issued), `live` (Live), `onhold` (On Hold), `closed` (Closed).
`runningStatus`	enum		Running status. Valid ids: `awaitingStart` (Awaiting Start), `startingSoon` (Starting Soon), `live` (Live), `endingSoon` (Ending Soon), `ended` (Ended).
`positionType`	enum	Yes	Position type. Valid ids: `permanent` (Permanent), `contract` (Contract), `temporary` (Temporary).
`recruitmentType`	enum		Recruitment type. Valid ids: `recruited` (Recruited), `nominated` (Nominated), `novated` (Novated), `payroll` (Payroll).
`vacancy`	reference → `VAC`		Vacancy.
`candidate`	reference → `PPL`	Yes	Candidate.
`client`	reference → `CLIENT`	Yes	Client.
`clientContact`	reference → `PPL`		Client contact.
`endClient`	reference → `CLIENT`		The end client when supplying via an agency or intermediary.
`endContact`	reference → `PPL`		End contact.
`discipline`	reference → `DISCIPLINE`		Discipline.
`country`	reference → `COUNTRY`		Country.
`division`	text		Division.
`startDate`	date	Yes	Start date.
`endDate`	date		End date.
`actualEndDate`	date		Actual end date.
`hardEndDate`	date		Absolute latest end date, cannot be extended beyond this.
`permanentStartDate`	date		Start date for permanent conversion.
`permanentEndDate`	date		End date for permanent conversion (e.g. probation end).
`consultant`	reference → user		Consultant.
`assignmentOwner`	reference → user		Assignment owner.
`clientRelOwner`	reference → user		Client relationship owner.
`contractorRelOwner`	reference → user		Contractor relationship owner.
`noticeCandidate`	text		E.g. '4 weeks', '1 month'.
`noticeClient`	text		Notice period (client).
`extensionCount`	number		Extension #. Read-only.
`likelyToExtend`	enum		Likely to extend. Valid ids: `notDiscussed` (Not Discussed), `expected` (Expected), `notExpected` (Not Expected), `unsure` (Unsure).
`warrantyPeriod`	number		Warranty (weeks).
`rebateWeeks`	number		Rebate (weeks).

Job & Location

Field	Type	Notes
`jobTitle`	text	Job title.
`requirements`	text (multi-line)	Requirements.
`deliverables`	text (multi-line)	Deliverables.
`specialInstructions`	text (multi-line)	Special instructions.
`specialInstructionsClient`	text (multi-line)	Special instructions (client).
`companyEquipment`	text (multi-line)	Company equipment.
`workAddressStreet1`	text	Street 1.
`workAddressStreet2`	text	Street 2.
`workAddressCity`	text	City.
`workAddressPostcode`	text	Postcode.
`workAddressCountry`	reference → `COUNTRY`	Country.
`invoiceAddressStreet1`	text	Street 1.
`invoiceAddressStreet2`	text	Street 2.
`invoiceAddressCity`	text	City.
`invoiceAddressPostcode`	text	Postcode.
`invoiceAddressCountry`	reference → `COUNTRY`	Country.
`invoiceContact`	reference → `PPL`	Invoice contact.
`clientRef`	text	Finance account ref.
`poRequired`	boolean	PO required.

Financial

Field	Type	Notes
`salary`	number	Salary.
`packageValue`	number	Package value.
`feeBasedOn`	enum	Fee based on. Valid ids: `baseSalary` (Base Salary), `totalPackage` (Total Package), `fixed` (Fixed), `staged` (Staged).
`feePercent`	number	Fee %.
`feeAmount`	number	Fee amount.
`salesValue`	number	Sales value.
`permanentBenefits`	text (multi-line)	Benefits description.
`chargeRate`	number	Charge rate.
`payRate`	number	Pay rate.
`contractRatePer`	enum	Per. Valid ids: `hour` (Hour), `day` (Day), `week` (Week), `month` (Month), `year` (Year).
`contractFrequency`	enum	Contract frequency. Valid ids: `hourly` (Hourly), `daily` (Daily), `weekly` (Weekly), `monthly` (Monthly), `annually` (Annually).
`marginPercent`	number	Margin %.
`marginValue`	number	Margin value.
`markupPercent`	number	Markup %.
`grossProfit`	number	Gross profit.
`onCostsPercent`	number	On-costs %.
`onCosts`	number	On-costs.
`tempDeductionPercent`	number	Deduction %.
`tempDeductions`	number	Deductions.
`daysPerWeek`	number	Days per week.
`hoursPerWeek`	number	Hours per week.
`numberOfWeeks`	number	Number of weeks.
`holidayDays`	number	Holiday days.
`timesheetInterval`	enum	Timesheet interval. Valid ids: `daily` (Daily), `weekly` (Weekly), `twoWeeks` (2 Weeks), `monthly` (Monthly), `fourFourFive` (4-4-5).
`payInterval`	enum	Pay interval. Valid ids: `weekly` (Weekly), `fortnightly` (Fortnightly), `fourFourFive` (4-4-5 Weekly), `monthly` (Monthly).
`createTimesheets`	boolean	Create timesheets.
`homeBased`	boolean	Home based.
`bonus`	number	Bonus.
`bonusFrequency`	enum	Bonus frequency. Valid ids: `monthly` (Monthly), `quarterly` (Quarterly), `annually` (Annually), `biAnnually` (Bi-Annually).
`bonusDescription`	text	Bonus description.
`holidayPay`	number	Holiday pay.
`currency`	reference → `CURRENCY`	Currency.

Commission

Field	Type	Notes
`commissionConsultant0`	reference → user	Consultant 1.
`commissionConsultant1`	reference → user	Consultant 2.
`commissionConsultant2`	reference → user	Consultant 3.
`commissionConsultant3`	reference → user	Consultant 4.
`commissionRate0`	number	Rate % (1).
`commissionFlat0`	number	Flat (1).
`commissionRate1`	number	Rate % (2).
`commissionFlat1`	number	Flat (2).
`commissionRate2`	number	Rate % (3).
`commissionFlat2`	number	Flat (3).
`commissionRate3`	number	Rate % (4).
`commissionFlat3`	number	Flat (4).
`commissionTotal`	number	Commission total %. Read-only.

Compliance

Field	Type	Required	Notes
`compliancy`	enum	Yes	Compliancy. Valid ids: `nonCompliant` (Non-Compliant), `compliant` (Compliant).
`compliancePercent`	number		Compliance %. Read-only.
`onboardingStatus`	enum		Onboarding. Valid ids: `notComplete` (Not Complete), `complete` (Complete).
`onboardingPercent`	number		Onboarding %. Read-only.
`offboardingStatus`	enum		Offboarding. Valid ids: `notComplete` (Not Complete), `complete` (Complete).
`offboardingPercent`	number		Offboarding %. Read-only.
`candidateAcceptance`	enum		Acceptance. Valid ids: `pending` (Pending), `accepted` (Accepted), `rejected` (Rejected).
`candidateAcceptanceDate`	date		Acceptance date.
`confirmedStart`	boolean		Confirmed start.
`sentiment`	enum		Sentiment. Valid ids: `positive` (Positive), `neutral` (Neutral), `negative` (Negative).
`paperworkStatus`	enum		Paperwork status. Valid ids: `pending` (Pending), `issued` (Issued), `complete` (Complete).
`paperworkIssuedDate`	date		Paperwork issued.
`approvalStatus`	enum		Approval status. Valid ids: `notComplete` (Not Complete), `complete` (Complete).
`finalised`	boolean		Finalised.
`primaryAuthoriser`	reference → `PPL`		Primary authoriser.
`secondaryAuthoriser`	reference → `PPL`		Second authoriser.
`availableOnPortal`	boolean		Available on portal.
`taxableAs`	enum		Taxable as. Valid ids: `employee` (Employee), `consultant` (Consultant).

Additional panels

Activity timeline panel attached.
Documents. Field placementDocuments.
Map panel.

Relationships

Lookups: vacancy points at VAC record; candidate points at PPL record; client points at CLIENT record; clientContact points at PPL record; endClient points at CLIENT record; endContact points at PPL record; discipline points at DISCIPLINE record; country points at COUNTRY record; workAddressCountry points at COUNTRY record; invoiceAddressCountry points at COUNTRY record; invoiceContact points at PPL record; currency points at CURRENCY record; primaryAuthoriser points at PPL record; secondaryAuthoriser points at PPL record.
Related lists: BGCHECK via format SUB.

Creating a Placement via the API

POST /v1/objects
Authorization: Bearer <your-pat>
Content-Type: application/json

{
  "entity":   "PLACE",
  "level":    11000,
  "comboKey": "SUB:<your-sub-id>|ENT:",
  "name": "Example",
  "placementStatus": "pending",
  "positionType": "permanent",
  "candidate": ""
}

Listing PLACE records

# All placements in your tenant
GET /v1/entities/PLACE/SUB

DemandFlow Support Centre

PLACE: Placement

PLACE: Placement

Entity properties

Use cases

Fields

Additional panels

Relationships

Creating a Placement via the API

Listing PLACE records

See also

Was this article helpful?