Payroll run

Completed pay runs with gross and net totals.

Part of Payroll in the register catalog.

Register ID

payroll_runUse 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.

• Single Touch PayrollPayroll reporting to the Australian Taxation OfficeAustralia

Connectors

Connected today

Demiton keeps this register current from these systems now.

• 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 Acumatica
• MYOB BusinessPartial
• Xero Accounting
• Xero Payroll AU

Fields

16 fields: 9 required, 7 optional.

Required

Every record carries these fields.

external_idText

The source system's identifier for the pay run; the producer hinge.

Example: KP-PAYRUN-2026-24

source_systemText

Which bound payroll system emitted the run.

Example: KEYPAY

occurred_atDateYYYY-MM-DD

The pay period end — the payday the run is dated to.

Example: 2026-06-18

pay_period_startDateYYYY-MM-DD

First day of the pay period.

Example: 2026-06-05

financial_periodText

The financial period the run is attributed to.

Example: 2026-06

legal_entityText

The employing legal entity (the KeyPay business)

Example: Bridgeworks Group Pty Ltd

total_grossDecimal numberUnit: currency (by coordinate)

Whole-run gross pay.

Example: 214380.5

total_netDecimal numberUnit: currency (by coordinate)

Whole-run net pay.

Example: 168120.2

is_finalisedTrue or false

Whether the run is finalised (reportable)

Example: true

Optional

Present when the source system records them.

currencyText

Denomination of the money measures.

Example: AUD

workerText

A worker the run paid, if the grain is ever per-worker.

pay_schedule_idNumber

The pay schedule / calendar the run belongs to.

pay_slips_publishedTrue or false

Whether payslips for the run have been published.

Example: true

notationText

The run's free-text label/notation.

date_paidDateYYYY-MM-DD

The date the run was paid.

Example: 2026-06-19

date_finalisedDateYYYY-MM-DD

When the run reached its finalised state.

Example: 2026-06-19

Example record

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

payroll_run.example.json

{
  "currency": "AUD",
  "date_finalised": "2026-06-19",
  "date_paid": "2026-06-19",
  "external_id": "KP-PAYRUN-2026-24",
  "financial_period": "2026-06",
  "is_finalised": true,
  "legal_entity": "Bridgeworks Group Pty Ltd",
  "occurred_at": "2026-06-18",
  "pay_period_start": "2026-06-05",
  "pay_slips_published": true,
  "source_system": "KEYPAY",
  "total_gross": 214380.5,
  "total_net": 168120.2
}

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

Show the full JSON Schema

Loading the schema…