Employee hr records

HR record events for a worker: leave, disciplinary action, personnel file changes.

Part of Workforce in the register catalog.

Register ID

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

Each record is

An eventSomething that happened at a point in time.

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.

• Fair Work Act 2009National employment standards and modern awardsAustralia
• GDPRGeneral Data Protection RegulationEuropean Union

Connectors

Connected today

Demiton keeps this register current from these systems now.

• Assignar

On the roadmap

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

• MYOB Acumatica
• SitematePartial
• Xero Payroll AU

Fields

27 fields: 7 required, 19 optional, 1 defined by each organisation.

Required

Every record carries these fields.

external_idText

Stable identity of the source record (Assignar form-result id, cast to text).

Example: ASGN-FR-33021

source_systemText

Originating system; ASSIGNAR today, Xero Payroll AU or MYOB Acumatica if ever bound.

Example: ASSIGNAR

occurred_atDate and timeISO 8601, with time zone

When the source record was submitted/modified; the event time and the retention clock start.

Example: 2026-06-05T08:00:00

workerNumber

The employee the record is about; the required subject anchor.

Example: 5501

family_nameText

The employee's surname as recorded on the HR record.

Example: Patel

employment_basisText

Whether the engagement is full-time, part-time or casual.

Example: full_time

start_dateDateYYYY-MM-DD

The date the employment started; the accrual and retention start point.

Example: 2023-02-06

Optional

Present when the source system records them.

given_namesText

The employee's given name(s), kept separate for cross-system name matching.

Example: Aaron

engagement_typeText

Whether the engagement is permanent, temporary or otherwise.

Example: permanent

termination_dateDateYYYY-MM-DD

The date employment ended, for a former employee.

termination_reasonText

The manner in which employment ended.

job_titleText

The employee's role title.

Example: Site Supervisor

financial_periodDateYYYY-MM-DD

The accounting period the record falls in, derived from occurred_at.

Example: 2026-06-01

date_of_birthDateYYYY-MM-DD

The employee's date of birth.

residential_addressText

The employee's home address.

contact_emailText

Work or personal email for the employee.

Example: aaron.patel@example.com

contact_phoneText

Contact phone number(s).

Example: 0400 000 101

emergency_contactGroup of fields

Emergency contact name, relationship and number.

bank_accountGroup of fields

The employee's pay destination.

superannuation_fundGroup of fields

The nominated superannuation fund and the member identifier.

superannuation_contributionGroup of fieldsUnit: native currency (AUD default)

Contributions made for the employee in the period.

tax_identifier_declarationGroup of fields

Whether the employee's tax-file-number declaration is held with the record.

leave_balanceGroup of fieldsUnit: unit-bearing (days or hours)

The running leave balance the record must show.

hours_worked_per_dayListUnit: hours

Hours worked each day in a pay period.

working_time_opt_outGroup of fields

The 48-hour opt-out agreement the employer must record for a UK worker.

reviewGroup of fields

A performance-review outcome where the record is a review rather than an onboarding form.

Defined by each organisation

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

attributesGroup of fields

Every remaining form answer, keyed by the tenant's own question text.

Example record

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

employee_hr_records.example.json

{
  "contact_email": "aaron.patel@example.com",
  "contact_phone": "0400 000 101",
  "employment_basis": "full_time",
  "engagement_type": "permanent",
  "external_id": "ASGN-FR-33021",
  "family_name": "Patel",
  "financial_period": "2026-06-01",
  "given_names": "Aaron",
  "job_title": "Site Supervisor",
  "occurred_at": "2026-06-05T08:00:00",
  "source_system": "ASSIGNAR",
  "start_date": "2023-02-06",
  "worker": 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_hr_records/v1.json

Show the full JSON Schema

Loading the schema…