Retention position

Retention currently withheld on a job, and its status.

Part of Contracts in the register catalog.

Register ID

retention_positionUse 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

Connectors

Connected today

Demiton keeps this register current from these systems now.

• Business Central
• Xero

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
• Oracle Aconex
• Payapps
• Procore

Fields

8 fields: 2 required, 5 optional, 1 defined by each organisation.

Required

Every record carries these fields.

project_refText

The subject project's stable external reference (today the ERP job number).

Example: BWG-2025-002

retention_heldTrue or false

Whether money is currently withheld by the client.

Example: true

Optional

Present when the source system records them.

retention_amountDecimal numberUnit: currency of the bound legal entity

The amount currently withheld, as recorded by the source.

Example: 97500

retention_amount_sourceText

Which system actually supplied retention_amount (today the constant bc_job_card_unpopulated)

retention_basisText

How the retention was calculated (percent of each claim, accumulated, cap)

Example: 5% of certified value to practical completion

retention_currencyText

The currency the amount is denominated in.

Example: AUD

contract_refText

The contract or trust account the retention attaches to.

Example: TEN/2963

Defined by each organisation

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

retention_statusText

The producer's lifecycle code: PC, DLP, BG, COMPLETED

Example: held

Example record

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

retention_position.example.json

{
  "contract_ref": "TEN/2963",
  "project_ref": "BWG-2025-002",
  "retention_amount": 97500,
  "retention_basis": "5% of certified value to practical completion",
  "retention_currency": "AUD",
  "retention_held": true,
  "retention_status": "held"
}

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

Show the full JSON Schema

Loading the schema…