Pay categories

Pay category definitions, with rates and award mappings.

Part of Payroll in the register catalog.

Register ID

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

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

Fields

24 fields: 3 required, 19 optional, 2 defined by each organisation.

Required

Every record carries these fields.

pay_category_entity_idWhole number

Demiton canonical PAY_CATEGORY spine node this fact is about.

Example: 1

source_systemText

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

Example: KEYPAY

statutory_income_typeText

The jurisdiction's statutory income/component type this category maps to (AU: ATO income-type list)

Example: OTE

Optional

Present when the source system records them.

source_external_idNumber

The raw record id in the producing system.

nameText

Human name of the pay category.

Example: Award Civil - Ordinary

pay_category_typeText

The category's own type (wage / allowance / deduction / superannuation / …)

Example: hourly

rate_unitText

Unit the category's rate is denominated in.

Example: Hourly

external_codeText

Stable manufacturer/award code where the source supplies one.

default_super_rateNumberUnit: percent

Default superannuation rate applied to this category.

Example: 11.5

exclude_from_qualifying_earningsTrue or false

Whether the category is excluded from super-qualifying earnings.

accrues_leaveTrue or false

Whether the category accrues leave.

Example: true

penalty_loading_percentNumberUnit: percent

Penalty-rate loading applied to the category.

rate_loading_percentNumberUnit: percent

Rate loading applied to the category.

allowance_descriptionText

Description of a separately identifiable allowance.

is_tax_exemptTrue or false

Whether the category is exempt from withholding tax.

is_payroll_tax_exemptTrue or false

Whether the category is exempt from state/territory payroll tax.

hide_units_on_payslipTrue or false

Whether units are hidden on the payslip for this category.

number_of_decimal_placesNumber

Rounding precision for the category.

rounding_methodText

Rounding method applied to the category.

is_primaryTrue or false

Whether this is the tenant's primary/default category.

Example: true

is_system_pay_categoryTrue or false

Whether the category is system-supplied rather than tenant-authored.

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.

parent_referenceNumber

Source id of the tenant-configured parent category.

general_ledger_mapping_codeText

Tenant GL account code the category posts to.

Example record

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

pay_categories.example.json

{
  "accrues_leave": true,
  "default_super_rate": 11.5,
  "is_primary": true,
  "name": "Award Civil - Ordinary",
  "pay_category_entity_id": 1,
  "pay_category_type": "hourly",
  "rate_unit": "Hourly",
  "source_system": "KEYPAY",
  "statutory_income_type": "OTE"
}

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

Show the full JSON Schema

Loading the schema…