Employee list

Employees registered in your payroll system.

Part of Workforce in the register catalog.

Register ID

employee_listUse this name to ask for the register. The API calls it a shelf ID.

Each record is

A stateThe current value of something, replaced when it changes.

Status

AvailableFilled today from connected systems, uploads or public data.

Data

OrganisationPrivate to each organisation's own workspace.

Version

v1Current version.

Download JSON SchemaSee an example record

Standards

This register holds records these standards and laws ask for. Holding them does not by itself certify compliance.

• ISO 30414Human capital reportingInternational · Clauses 1, 3
• Fair Work Act 2009National employment standards and modern awardsAustralia

Connectors

Connected today

Demiton keeps this register current from these systems now.

• Dynamics 365 Finance & Operations
• KeyPay
• Navman

On the roadmap

Systems in the planned connector rollout that can fill this register. Partial means the system holds only some of its fields.

• EROADPartial
• GeotabPartial
• HammerTechPartial
• MapTrackPartial
• MittiPartial
• MYOB Acumatica
• MYOB Business
• PayappsPartial
• ProcorePartial
• SignOnSitePartial
• SitematePartial
• Xero Accounting
• Xero Payroll AU

Fields

21 fields: 6 required, 11 optional, 4 defined by each organisation.

Required

Every record carries these fields.

worker_entity_idWhole number

Demiton canonical worker spine node this fact anchors to (the subject)

Example: 5501

source_systemText

The bound system that produced this record (KEYPAY / D365_FINOPS / NAVMAN)

Example: KEYPAY

source_external_idText

The raw record id in the producing system.

Example: 1001

display_nameText

The worker's display name.

Example: Aaron Patel

employment_typeText

The engagement basis.

Example: Full-time

employment_start_dateDateYYYY-MM-DD

Date the employment relationship started.

Example: 2022-03-07

Optional

Present when the source system records them.

given_nameText

First/given name as a separate part.

Example: Aaron

family_nameText

Surname/family name as a separate part.

Example: Patel

titleText

Honorific or name prefix.

job_titleText

Role/job title at the employer.

Example: Site Supervisor

emailText

Work/contact email used as an identity bridge.

employment_statusText

Current employment state.

Example: Active

employment_end_dateDateYYYY-MM-DD

Date the engagement ended, where known.

legal_entity_idWhole number

The employing legal entity, resolved per record.

date_of_birthDateYYYY-MM-DD

Worker date of birth.

genderText

Gender, for diversity aggregation.

source_created_atDate and timeISO 8601, with time zone

When the source record was created (freshness)

Defined by each organisation

Their contents come from the organisation's own forms or systems, so they differ between organisations.

tagsList

Tenant-assigned labels on the employee record.

reporting_dimension_valuesText

Tenant reporting-dimension assignment.

work_typesText

Tenant work-type assignment.

employment_agreementText

Tenant award/agreement name the employee is paid under.

Example record

A sample from Bridgeworks Group, Demiton's demonstration company. The values are illustrative; the shape is exactly what the contract describes.

employee_list.example.json

{
  "display_name": "Aaron Patel",
  "employment_start_date": "2022-03-07",
  "employment_status": "Active",
  "employment_type": "Full-time",
  "family_name": "Patel",
  "given_name": "Aaron",
  "job_title": "Site Supervisor",
  "source_external_id": "1001",
  "source_system": "KEYPAY",
  "worker_entity_id": 5501
}

Use this contract

The contract is a standard JSON Schema (draft 2020-12) document, so any JSON Schema validator can check a record against it. Keywords starting with x-demiton- add Demiton's own meaning, such as units and requiredness, and validators ignore them.

Schema URL

https://docs.demiton.io/registers/employee_list/v1.json

Show the full JSON Schema

Loading the schema…