Opportunities

Your commercial pipeline: won, lost and in-flight opportunities from CRM or ERP.

Part of Opportunities in the register catalog.

Register ID

opportunitiesUse 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
• HubSpot

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
• ProcorePartial

Fields

20 fields: 8 required, 12 optional.

Required

Every record carries these fields.

opportunity_numberText

The source system's natural key for the opportunity — canonical spelling of BC No / No_ / number; today the entity canonical key.

Example: OPP-2451

source_systemText

The system the record was harvested from (observed: D365_BUSINESS_CENTRAL).

Example: HUBSPOT

titleText

The opportunity's human label — canonical spelling of BC Description / description.

Example: ITT2529 Streetscape Upgrade - Mill & Currie Streets, Nambour

statusText

The source's own pipeline status — canonical spelling of BC Status / status.

Example: Qualification

amountNumberUnit: currency

The estimated pipeline value — canonical spelling of BC Estimated_Value_LCY / estimatedValue (LCY = the BC base currency).

Example: 1200000

currencyTextUnit: ISO 4217

The denomination of amount.

Example: AUD

value_basisText

What amount measures — R3's estimated / awarded / maximum / paid / mechanism-only.

Example: estimated_contract_value

as_atDate and timeISO 8601, with time zoneUnit: UTC

When this record was observed/written — the validity anchor of a state-shaped fact.

Example: 2026-09-01T00:00:00Z

Optional

Present when the source system records them.

closedTrue or false

The source's own closed flag — canonical spelling of BC Closed / closed.

created_dateDateYYYY-MM-DD

The opportunity's creation date — BC Creation_Date / creationDate.

expected_close_dateDateYYYY-MM-DD

Expected close — BC Estimated_Closing_Date / estimatedClosingDate.

Example: 2026-11-15

actual_close_dateDateYYYY-MM-DD

Actual close — BC Date_Closed / dateClosed.

salespersonText

The owner — canonical spelling of BC Salesperson_Name / salespersonCode.

sales_cycle_codeText

The source's sales-cycle stage code — BC Sales_Cycle_Code.

customer_nameText

The prospective customer's name — BC Contact_Company_Name / contactCompanyName.

Example: Sunshine Coast Council

contact_nameText

The customer-side contact person — BC Contact_Name / contactName.

descriptionText

Longer free text, if distinct from title — BC Description where title is not used as the label.

jurisdiction_codeTextUnit: ISO 3166-2 subdivision (AU state)

The place of performance derived from the description text.

last_modified_atDate and timeISO 8601, with time zone

Source last-modified timestamp — BC lastModifiedDateTime, present only in Shape B.

summaryText

A Demiton-composed one-line rendering.

Example record

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

opportunities.example.json

{
  "amount": 1200000,
  "as_at": "2026-09-01T00:00:00Z",
  "currency": "AUD",
  "customer_name": "Sunshine Coast Council",
  "expected_close_date": "2026-11-15",
  "opportunity_number": "OPP-2451",
  "source_system": "HUBSPOT",
  "status": "Qualification",
  "title": "ITT2529 Streetscape Upgrade - Mill & Currie Streets, Nambour",
  "value_basis": "estimated_contract_value"
}

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

Show the full JSON Schema

Loading the schema…