Leave balance
Leave balance is one of Demiton's published registers for Australian civil construction. Current leave balances per employee and leave category. Demiton keeps it current from the systems a contractor already runs and publishes the record's shape as a versioned JSON Schema, so the same question works whichever system produced the record.
Part of Workforce in the register catalog.
- Register ID
leave_balanceUse 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
- v1 (1.0.2)Current version.
Standards
This register's contract was designed against these standards and laws. Holding these records does not by itself certify compliance.
- Fair Work Act 2009Fair Work Act 2009 - employee records and National Employment Standards
- Fair Work Act 2009Fair Work Regulations 2009 - employee record content
- Single Touch PayrollSingle Touch Payroll Phase 2 employer reporting guidelines
- ISO 30414Human resource management - Requirements and recommendations for human capital reporting and disclosure
- Employment Leave Act 2026 (NZ)Employment Leave Act 2026 (2026 No 48)
- Holidays Act 2003 (NZ)Holidays Act 2003 (2003 No 129) - holiday and leave record
- SI 1998/1833Working Time Regulations 1998
Connectors
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 AcumaticaPartial
- MYOB BusinessPartial
- Xero Payroll AU
Fields
9 fields: 5 required, 4 optional.
Required
Every record carries these fields.
- worker_refText
The employee the balance belongs to; the shelf's subject anchor. Rows without it are dropped by
build_atom's no-anchor guard.Example:
1001- balance_as_ofDate
When the balance was observed. A current-state balance with no observation date cannot be aged, cannot answer "as at", and cannot satisfy a record-keeping duty that turns on currency.
Example:
2026-08-31- leave_categoryNumber
Which entitlement the balance is for. Without it the grain collapses into one ambiguous balance per worker rather than one per category.
Example:
1- accrued_balanceNumber
The accrual balance itself — a lifetime meter, never additive across readings. The shelf's only measure.
Example:
96.5- leave_category_nameText
Human-readable label for that entitlement (annual, personal/carer's, long service, …). Mandatory because a balance identified only by an opaque source code is unreadable to a person and unmappable across systems.
Example:
Annual Leave
Optional
Present when the source system records them.
- balance_unitText
The denomination of
accrued_balance. Optional because every observed row today is one payroll system's single denomination; mandatory the moment a second jurisdiction is loaded.Example:
hours- legal_entityText
Which employing entity owns the balance. Optional by declaration, not by accident: KeyPay is multi-business and the business is resolvable from the record.
- entitlement_capNumber
The ceiling on the accrued balance where one applies. Absent today and absent from every observed field, so it is optional; it exists because a bare balance cannot express a statutory maximum.
- financial_periodText
The period context of the balance reading, where the host supplies one.
Filed against
Records are indexed along these dimensions, so they can be asked for by any of them.
- Financial periodcontext for the record, from
When known - Legal entitycontext for the record, from
When known - Workerwhat the record is about, from
Always set
Example record
A sample from Bridgeworks Group, Demiton's demonstration company. The values are illustrative; the shape is exactly what the contract describes.
{ "accrued_balance": 96.5, "balance_as_of": "2026-08-31", "balance_unit": "hours", "leave_category": 1, "leave_category_name": "Annual Leave", "worker_ref": "1001"}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.
https://docs.demiton.io/registers/leave_balance/v1.jsonShow the full JSON Schema
Loading the schema…
Talk to the team
Tell us what you run - your ERP, field, payroll and document systems - and we will show you the registers Demiton would fill from them, on your data, in a 30-minute call.