DemandFlow Support Centre

STF: Staff

A staff member record covering personal details, employment terms, engagement type, and commercial arrangements.

Default definition. This article describes the default STF 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 STF.

Entity properties

Property	Value
Entity code	`STF`
Display name	Staff
Plural	Staff
Level	210

Use cases

A staff member record covering personal details, employment terms, engagement type, and commercial arrangements.

STF is a general-purpose HR staff record. The stafftype field (Employee, Contractor, Managed Service, Work Package) classifies the engagement model. For non-employees, vendor (VEN lookup) and purchaseContract (PCON lookup) track commercial relationships. The dayrate field supports cost planning. The General panel covers personal info, contact details, and employment status. The Employment panel holds role, department, engagement type, and compensation. Documents and Notes panels provide file storage and activity timeline.

Fields

Personal Details

Field	Type	Required	Notes
`name`	text	Yes	Full name.
`firstName`	text		First name.
`lastName`	text		Last name.
`preferredName`	text		Preferred name.
`dateOfBirth`	date		Date of birth.
`gender`	enum		Valid ids: `Female` (Female), `Male` (Male), `Non-binary` (Non-binary), `Prefer not to say` (Prefer not to say).
`nationality`	text		Nationality.
`user`	reference → user		DemandFlow account.

Contact

Field	Type	Notes
`emailWork`	text	Work email.
`emailPersonal`	text	Personal email.
`phoneMobile`	text	Mobile phone.
`phoneWork`	text	Work phone.
`address`	text (multi-line)	Home address.

Emergency Contact

Field	Type	Notes
`emergencyContactName`	text	Name.
`emergencyContactPhone`	text	Phone.
`emergencyContactRelationship`	text	Relationship.

Status

Field	Type	Notes
`status`	enum	Valid ids: `1` (Active), `2` (Inactive).
`startDate`	date	Start date.
`endDate`	date	End date.
`probationEndDate`	date	Probation end date.
`noticePeriod`	text	Notice period.
`location`	text	Location.
`manager`	reference → `STF`	Line manager.

Role

Field	Type	Required	Notes
`role`	text	Yes	Job title.
`jobcode`	text		Job code.
`department`	text		Department.
`jobFunction`	enum		Valid ids: `13` (Engineering), `1` (Executive), `15` (Field), `2` (Finance), `3` (Human Resources), `7` (IT), `17` (Infrastructure), `4` (Legal), `5` (Marketing), `14` (Network Operations), `8` (Operations), `9` (Procurement), `10` (Product Management), `11` (Project Management), `18` (Regulatory & Compliance), `6` (Sales), `12` (Strategy), `16` (Support).
`division`	text		Division.
`costCentre`	text		Cost centre.
`payGrade`	text		Pay grade.

Engagement

Field	Type	Notes
`stafftype`	enum	Valid ids: `Contractor` (Contractor), `Employee` (Employee), `Managed Service` (Managed Service), `Work Package` (Work Package).
`contractType`	enum	Valid ids: `Fixed-term` (Fixed-term), `Full-time` (Full-time), `Part-time` (Part-time).
`vendor`	reference → `VEN`	Supplied through.
`purchaseContract`	reference → `PCON`	Purchase contract.

Working Pattern

Field	Type	Required	Notes
`workingDays`	enum		Days this person works each week. capacity is derived from this Valid ids: `mon` (Monday), `tue` (Tuesday), `wed` (Wednesday), `thu` (Thursday), `fri` (Friday).
`capacity`	number		Auto-calculated from working days (days / 5 * 100) Read only.

Compensation

Field	Type	Notes
`dayrate`	number	Day rate.
`salary`	number	Annual salary.
`currency`	reference → `CURRENCY`	Currency.

Carbon Profile

Field	Type	Required	Notes
`carbonProfile`	reference → `CARBONPROFILE`		Equipment usage template for carbon calculation

Attachments and additional panels

Activity timeline panel attached.
File attachment on file. Allowed types: *.

Relationships

Lookups: manager points at a STF record; vendor points at a VEN record; purchaseContract points at a PCON record; currency points at a CURRENCY record; carbonProfile points at a CARBONPROFILE record.
Related lists: STFLICENSE via comboKeyEntity2; TRAINING via comboKey (format: SUB|STF); SKILL via link.

Creating a Staff via the API

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

{
  "entity":   "STF",
  "level":    210,
  "comboKey": "SUB:<your-sub-id>|ENT:",
  "name": "Example name",
  "role": "Example role"
}

Listing Staff

GET /v1/entities/STF/SUB

DemandFlow Support Centre

STF: Staff

STF: Staff

Entity properties

Use cases

Fields

Attachments and additional panels

Relationships

Creating a Staff via the API

Listing Staff

See also

Was this article helpful?