Leave category list

Leave types defined in your payroll and operational systems.

Part of Workforce in the register catalog.

Register ID

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

• Single Touch PayrollPayroll reporting to the Australian Taxation OfficeAustralia

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

Fields

33 fields: 7 required, 20 optional, 6 defined by each organisation.

Required

Every record carries these fields.

leave_code_entity_idWhole number

Demiton canonical LEAVE_CODE spine node this fact is about.

Example: 301

source_systemText

The bound system that produced this record (ASSIGNAR/KEYPAY/…)

Example: KEYPAY

source_external_idNumber

The raw record id in the producing system.

Example: 5001

codeText

The leave-category code the cross-source alias binding matches on.

Example: ANN

nameText

Human name of the leave category.

Example: Annual Leave

leave_category_typeText

The category's leave type (annual / personal-carer's / long service / …)

Example: annual

unit_typeText

Unit the entitlement and balance are denominated in.

Example: Hours

Optional

Present when the source system records them.

statutory_leave_typeText

The ATO paid-leave type this category maps to (O/P/W/A/C/U)

Example: O

leave_loading_rateNumberUnit: percent

Leave loading applied to this category.

Example: 17.5

external_codeText

Stable manufacturer/award code where the source supplies one.

accrual_ruleGroup of fields

The source's accrual-rule object.

automatically_accruesTrue or false

Whether the category accrues automatically.

Example: true

accrues_first_pay_run_per_period_onlyTrue or false

Accrual timing within a period.

entitlement_periodNumber

The category's entitlement period.

Example: 12

contingent_periodNumber

The category's contingent period.

leave_entitlementText

Entitlement value where the source supplies one.

unitsNumber

The source's unit count/denomination for the category.

Example: 152

leave_unit_typeText

The source's second unit field; its distinction from unitType is unverified.

payout_as_etpTrue or false

Whether the category pays out as an employment termination payment.

exclude_from_termination_payoutTrue or false

Whether the category is excluded from a termination payout.

is_balance_untrackedTrue or false

Whether the category is excluded from balance tracking.

is_pay_run_accrualTrue or false

Whether accrual happens at pay-run time.

is_privateTrue or false

Source privacy flag for the category.

Example: false

is_name_privateTrue or false

Whether the category is hidden from payslips by name.

hide_accruals_on_payslipTrue or false

Whether accruals are hidden on the payslip.

source_classificationText

The source's own classification of the category's origin.

legal_entity_idWhole number

Owning legal entity where the source is multi-company.

Defined by each organisation

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

default_deduct_from_pay_category_referenceNumber

Source id of the tenant-configured pay category this category deducts from.

deduct_from_primary_pay_categoryTrue or false

Whether the deduction follows the primary pay category.

use_deduct_from_pay_category_rateTrue or false

Whether the deducting category's rate is used.

transfer_to_pay_category_referenceNumber

Source id of the tenant-configured pay category this category transfers into.

transfer_on_termination_pay_category_referenceNumber

Source id of the tenant-configured pay category used on termination.

prevent_negative_balance_unpaid_leave_category_referenceText

Source id of the tenant-configured category used to prevent a negative unpaid balance.

Example record

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

leave_category_list.example.json

{
  "automatically_accrues": true,
  "code": "ANN",
  "entitlement_period": 12,
  "is_private": false,
  "leave_category_type": "annual",
  "leave_code_entity_id": 301,
  "leave_loading_rate": 17.5,
  "name": "Annual Leave",
  "source_external_id": 5001,
  "source_system": "KEYPAY",
  "statutory_leave_type": "O",
  "unit_type": "Hours",
  "units": 152
}

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

Show the full JSON Schema

Loading the schema…