Legal entities

The operating companies in your group: the root every worker, project and cost code belongs to.

Part of Counterparties in the register catalog.

Register ID

legal_entitiesUse 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
• 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.

• HammerTechPartial
• MYOB Acumatica
• MYOB Business
• Oracle AconexPartial
• PayappsPartial
• Xero Accounting

Fields

20 fields: 4 required, 13 optional, 3 defined by each organisation.

Required

Every record carries these fields.

source_systemText

The system the entity record was read from.

Example: D365_BUSINESS_CENTRAL

external_idText

The source system's own company id.

Example: BWG-AU

legal_nameText

Registered/legal name of the entity.

Example: Bridgeworks Group Pty Ltd

base_currencyTextUnit: currency

The entity's functional currency.

Example: AUD

Optional

Present when the source system records them.

registration_statusText

Registration state at a point in time.

Example: active

registration_status_as_atDateYYYY-MM-DD

When that status was verified.

country_codeText

Country of registration/operation.

Example: AU

trading_nameText

Name the entity trades under, if different.

Example: Bridgeworks Group

address_line1Text

Street address line 1.

Example: 42 Depot Road

address_line2Text

Street address line 2.

localityText

Suburb/city.

Example: Kawana

administrative_areaText

State/region.

Example: QLD

postal_codeText

Postal code.

Example: 4701

fiscal_year_startNumber

Financial-year start.

primary_contact_nameText

The entity's general contact person.

Example: Brett Hollis

primary_emailText

The entity's general contact email.

Example: accounts@example.com

primary_phoneText

The entity's general contact phone.

Example: 0400 000 001

Defined by each organisation

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

identifier_schemeText

The scheme the primary identifier belongs to.

Example: ABN

identifier_valueText

The identifier in that scheme.

Example: 83167229410

identifier_authorityText

The register/authority that issues or validates the identifier.

Example: Australian Business Register

Example record

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

legal_entities.example.json

{
  "address_line1": "42 Depot Road",
  "administrative_area": "QLD",
  "base_currency": "AUD",
  "country_code": "AU",
  "external_id": "BWG-AU",
  "identifier_authority": "Australian Business Register",
  "identifier_scheme": "ABN",
  "identifier_value": "83167229410",
  "legal_name": "Bridgeworks Group Pty Ltd",
  "locality": "Kawana",
  "postal_code": "4701",
  "primary_contact_name": "Brett Hollis",
  "primary_email": "accounts@example.com",
  "primary_phone": "0400 000 001",
  "registration_status": "active",
  "source_system": "D365_BUSINESS_CENTRAL",
  "trading_name": "Bridgeworks Group"
}

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

Show the full JSON Schema

Loading the schema…