Leave request

Leave requests and their approval status.

Part of Workforce in the register catalog.

Register ID

leave_requestUse 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

Connectors

Connected today

Demiton keeps this register current from these systems now.

• Assignar
• KeyPay

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
• Xero AccountingPartial
• Xero Payroll AU

Fields

14 fields: 7 required, 6 optional, 1 defined by each organisation.

Required

Every record carries these fields.

workerText

The employee the leave belongs to.

Example: 1003

leave_typeText

Category of leave (annual, personal/carer's, …)

Example: Annual Leave

from_dateDateYYYY-MM-DD

First day of the leave.

Example: 2026-07-20

to_dateDateYYYY-MM-DD

Last day of the leave.

Example: 2026-07-24

hoursDecimal numberUnit: hours

Paid hours of leave, summed from the per-day intervals.

Example: 38

is_approvedTrue or false

Whether the request is approved.

Example: true

source_record_idText

The source record's identity, for idempotent upsert.

Example: LR-55231

Optional

Present when the source system records them.

leave_type_labelText

The vendor's display name for the leave type.

statusText

The source status label (e.g. pending)

Example: approved

reasonText

The employee's stated reason.

daysWhole numberUnit: leave-day rows

Number of per-day leave rows behind the request.

Example: 5

financial_periodText

The pay period the leave falls in.

Example: 2026-07

leave_datesListUnit: datetime (local)

The per-day leave intervals the request comprises.

Defined by each organisation

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

leave_type_idWhole number

The bound system's numeric leave-type id.

Example record

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

leave_request.example.json

{
  "days": 5,
  "financial_period": "2026-07",
  "from_date": "2026-07-20",
  "hours": 38,
  "is_approved": true,
  "leave_type": "Annual Leave",
  "source_record_id": "LR-55231",
  "status": "approved",
  "to_date": "2026-07-24",
  "worker": "1003"
}

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/leave_request/v1.json

Show the full JSON Schema

Loading the schema…