Document transmittal

Transmittals recording which documents went to whom, and when.

Part of Documents in the register catalog.

Register ID

document_transmittalUse 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

PlannedDefined ahead of the connector that will fill it.

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.

No system fills this register yet.

On the roadmap

Systems in the planned connector rollout that can fill this register. Partial means the system holds only some of its fields.

None planned yet.

Fields

21 fields: 7 required, 14 optional.

Required

Every record carries these fields.

external_idText

The source system's own id for the transmittal.

Example: SP-TRN-2201

source_systemText

Which bound system emitted the row.

Example: SHAREPOINT

projectText

The project the transmittal is on.

Example: BWG-2025-001

numberText

The transmittal number.

Example: TRN-0021

subjectText

What the transmittal is.

Example: Issue for Construction - Pavement Design Drawings Rev C

statusText

Whether it is outstanding, responded or closed.

Example: outstanding

sent_atDate and timeISO 8601, with time zone

When the transmittal was issued.

Example: 2026-06-20T09:15:00

Optional

Present when the source system records them.

correspondence_typeText

The kind of correspondence, e.g. transmittal or submittal.

Example: transmittal

reason_for_issueText

Why the documents were issued.

from_partyText

Who sent the transmittal.

Example: Bridgeworks Group Pty Ltd

to_partiesList

Who received it, with the distribution type.

documentsList

The documents transmitted, each with number and revision.

response_requiredTrue or false

Whether a response is owed.

Example: true

response_dueDateYYYY-MM-DD

When a response is due.

Example: 2026-07-04

in_reply_toText

The transmittal this one answers.

threadText

The correspondence thread it belongs to.

approval_statusText

The approval state of the transmittal.

confidentialTrue or false

Whether the transmittal is confidential.

revisionWhole number

The submittal revision.

specification_sectionText

The specification section the documents address.

responsible_contractorText

The contractor responsible for the submission.

Example record

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

document_transmittal.example.json

{
  "correspondence_type": "transmittal",
  "documents": [
    {
      "number": "BWG-001-CIV-201",
      "revision": "C"
    }
  ],
  "external_id": "SP-TRN-2201",
  "from_party": "Bridgeworks Group Pty Ltd",
  "number": "TRN-0021",
  "project": "BWG-2025-001",
  "response_due": "2026-07-04",
  "response_required": true,
  "sent_at": "2026-06-20T09:15:00",
  "source_system": "SHAREPOINT",
  "status": "outstanding",
  "subject": "Issue for Construction - Pavement Design Drawings Rev C",
  "to_parties": [
    {
      "name": "Central Highlands Regional Council",
      "type": "for_approval"
    }
  ]
}

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

Show the full JSON Schema

Loading the schema…