STATE: State
A geographic state or province, linked to a country, used for address standardisation and regional reporting.
Default definition. This article describes the default
STATE definition shipped with DemandFlow. Administrators can add, remove, rename, or re-type fields, change which ones are required, and alter the layout from the Definitions screen in Settings. Your tenant's current schema may differ from what is shown here. To read the current definition at any time, GET the DEFINITION object whose id matches STATE.Entity properties
| Property | Value |
|---|---|
| Entity code | STATE |
| Display name | State |
| Plural | States |
| Level | 250 |
Use cases
A geographic state or province, linked to a country, used for address standardisation and regional reporting.
STATE is a simple lookup entity at level 250. Uses a flat definition array with four fields: name, state code, country (COUNTRY objectLookup), and a readonly Dynamics ID for ERP sync. Grid-only view.
Fields
General
| Field | Type | Required | Notes |
|---|---|---|---|
name | text | Yes | Name. |
code | text | State Code. | |
country | reference → COUNTRY | Country. | |
_dynamics_id | text | Dynamics ID. Read only. |
Relationships
- Lookups:
countrypoints at aCOUNTRYrecord.
Creating a State via the API
POST /v1/objects
Authorization: Bearer <your-pat>
Content-Type: application/json
{
"entity": "STATE",
"level": 250,
"comboKey": "SUB:<your-sub-id>|ENT:",
"name": "Example name",
"code": "Example code",
"country": ""
} Listing States records
GET /v1/entities/STATE/SUB