Customer list

Customers registered in your ERP.

Part of Counterparties in the register catalog.

Register ID

customer_listUse 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
• Dynamics 365 Finance & Operations
• 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.

• HammerTechPartial
• MapTrackPartial
• MYOB Acumatica
• MYOB BusinessPartial
• Oracle Aconex
• PayappsPartial
• ProcorePartial
• Xero Accounting

Fields

27 fields: 2 required, 20 optional, 5 defined by each organisation.

Required

Every record carries these fields.

customer_entity_idWhole number

Demiton canonical CUSTOMER spine node this fact is about.

Example: 7001

source_systemText

The bound system that produced this record (D365_BUSINESS_CENTRAL/D365_FINOPS/HUBSPOT/…)

Example: D365_BUSINESS_CENTRAL

Optional

Present when the source system records them.

customer_numberText

The customer account code that joins this record to AR transactions across systems.

Example: CUST-7001

nameText

Registered/trading name of the customer party.

Example: Central Highlands Regional Council

tax_registration_numberText

The customer's ABN / GST / VAT identifier.

country_codeTextUnit: ISO 3166-1 alpha-2

Customer's country.

Example: AU

source_external_idText

The raw record id in the producing system.

emailText

Customer contact email.

phoneText

Customer contact phone.

websiteText

Customer website / domain.

address_line_1Text

Street address line 1.

address_line_2Text

Street address line 2.

cityText

Locality.

Example: Emerald

stateText

State/territory code.

Example: QLD

postal_codeText

Postal code.

credit_limitNumberUnit: currency amount

Credit limit the tenant extends to this customer.

blockedText

Source's blocked/credit-hold status for the customer.

tax_liableTrue or false

Whether the customer is taxable in the source's tax setup.

Example: true

customer_typeText

The source's customer type (e.g. person/company distinction)

default_currency_codeTextUnit: ISO 4217

The customer's default transaction currency.

Example: AUD

tax_area_display_nameText

Human label of the source's tax area.

modified_atDate and timeISO 8601, with time zone

Source last-modified timestamp (freshness)

Defined by each organisation

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

payment_terms_referenceText

Source id of the tenant-configured payment-terms row.

payment_method_referenceText

Source id of the tenant-configured payment-method row.

shipment_method_referenceText

Source id of the tenant-configured shipment-method row.

salesperson_codeText

Tenant's internal salesperson code for this customer.

tax_area_referenceText

Source id of the tenant-configured tax area row.

Example record

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

customer_list.example.json

{
  "city": "Emerald",
  "country_code": "AU",
  "customer_entity_id": 7001,
  "customer_number": "CUST-7001",
  "default_currency_code": "AUD",
  "name": "Central Highlands Regional Council",
  "source_system": "D365_BUSINESS_CENTRAL",
  "state": "QLD",
  "tax_liable": true
}

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

Show the full JSON Schema

Loading the schema…