DemandFlow Support Centre

CLIENT: Client

A client organisation with an active or prospective commercial relationship, including contacts, billing, and ownership.

Default definition. This article describes the default CLIENT 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 CLIENT.

Entity properties

Property	Value
Entity code	`CLIENT`
Display name	Client
Plural	Clients
Level	11000
Extends	`COM`. See Entity Extension.

Use cases

CLIENT represents organisations the business has a direct commercial relationship with. It is structurally similar to COM (Company) but exists separately because CLIENT records carry additional billing, credit, legal entity, and ownership fields that are irrelevant to generic company records. COM is a broader universe of companies (prospects, research targets, market data) whereas CLIENT is reserved for organisations that have reached the stage of needing financial administration. Both link to PPL via comboKey for contacts, but CLIENT also links to VAC and PLACE for recruitment workflows.

Fields

Because this entity extends COM, some fields may actually be stored on the linked base record rather than on this record directly. See Entity Extension.

General: Basics

Field	Type	Required	Notes
`name`	text	Yes	Name.
`df_extendObject`	reference → `COM`		Parent company.
`isParent`	boolean		Is this a Parent account for other Client accounts?
`parentClient`	text		Parent client.
`knownAs`	text (multi-line)		Client known as.
`primaryContact`	reference → `PPL`		Primary contact.

General: Primary address

Field	Type	Notes
`pri_add_type`	enum	Type. Valid ids: `1` (Bill to), `2` (Ship to), `3` (Primary), `4` (Other).
`pri_add_name`	text	Name.
`pri_add_street1`	text	Street 1.
`pri_add_street2`	text	Street 2.
`pri_add_street3`	text	Street 3.
`pri_add_city`	text	City.
`pri_add_county`	text	County.
`pri_add_postcode`	text	Postcode.

General: Contact details

Field	Type	Notes
`contact_main_phone`	text	Main phone number. Placeholder: Provide a telephone number.
`contact_fax`	text	Fax number.
`contact_website`	text (URL)	Website.
`contact_careers_website`	text (URL)	Dedicated careers / vancies webpage

General: Comments

Field	Type	Notes
`comments_comment`	text (multi-line)
`roe`	reference → `ROE`	Rules of engagement.
`credit_hold`	boolean	Credit hold.
`email_structure`	text	Eg. firstname.lastname@domain.com
`sic`	reference → `SIC`	SIC.

General: Last contact

Field	Type	Notes
`lc_lastcontact`	text	Read-only. Last contacted.
`lc_lastcontactby`	text	Read-only. Last contacted by.
`lc_lastcall`	text	Read-only. Last called.
`lc_lastcallby`	text	Read-only. Last called by.
`lc_lastemail`	text	Read-only. Last emailed.
`lc_lastemailby`	text	Read-only. Last emailed by.

General: Client ownership

Field	Type	Notes
`client_owner`	reference → user	Client owner.
`client_keyowner`	reference → user	Key account owner.
`client_contractowner`	reference → user	Contract.
`client_owner_p`	reference → user	Permanent.
`client_owner_t`	reference → user	Temporary.

Company information

Field	Type	Notes
`ind`	reference → `IND`	Industry.
`own`	reference → `COMPOWN`	Company ownership.
`revenue`	number	Annual revenue.
`ticker`	text	Company ticker.
`empcount`	number	Number of employees.
`origLead`	reference → `PPL`	Originating lead.

Company information: Client audit history

Field	Type	Notes
`created`	datetime	Read-only. Created on.
`ownerId`	reference → user	Read-only. Created by.
`updated`	datetime	Read-only. Updated on.
`updatedId`	reference → user	Read-only. Updated by.

Company information: Description

Field	Type	Required	Notes
`description`	text (multi-line)

Administration: Billing information

Field	Type	Notes
`creditHold`	boolean	Credit hold.
`checkedBy`	reference → user	Checked by.
`accountsContact`	reference → `PPL`	Accounts contact.
`creditLimit`	number	Credit limit.
`creditDate`	date	Credit check date.
`currency`	reference → `CURRENCY`	Currency.
`crate`	reference → `CRATE`	Credit rating.
`accountref`	text	Finance account ref.
`lentity`	reference → `LENTITY`	Legal entity.
`timesheets`	boolean	Create timesheets.
`taxcode`	reference → `TAXCODE`	Tax code.
`taxcode`	reference → `INVINSTR`	Invoice instructions.

Administration: Internal information

Field	Type	Notes
`regnumber`	text	Reg. number.
`vatnumber`	text	VAT number.
`clienttype`	reference → `CLIENTTYPE`	Client type.
`countryreg`	reference → `COUNTRY`	Registration country.
`countrytrade`	reference → `COUNTRY`	Trading country.
`selfbill`	boolean	Self bill.

Administration: Additional information

Field	Type	Notes
`add1`	text (multi-line)	Additional information 1.
`add2`	text (multi-line)	Additional information 2.
`add3`	text (multi-line)	Additional information 3.

Administration: Email restrictions

Field	Type	Required	Notes
`emaillimit`	reference → `EMAILLIMIT`		Email limit definition.

Administration: Dimensions

Field	Type	Required	Notes
`repbu`	reference → `REPBU`		Reporting BU.
`clientpj`	reference → `CLIENTPJ`		Client project.

Administration: Off limits

Field	Type	Notes
`offlimits`	reference → `OFFLIMIT`	Off limits reason.
`offdate`	date	Off limits expiry date.
`offdesc`	text (multi-line)	Off limits description.

Relationships

Lookups: df_extendObject points at a COM record; primaryContact points at a PPL record; roe points at a ROE record; sic points at a SIC record; ind points at a IND record; own points at a COMPOWN record; origLead points at a PPL record; accountsContact points at a PPL record; currency points at a CURRENCY record; crate points at a CRATE record; lentity points at a LENTITY record; taxcode points at a TAXCODE record; taxcode points at a INVINSTR record; clienttype points at a CLIENTTYPE record; countryreg points at a COUNTRY record; countrytrade points at a COUNTRY record; emaillimit points at a EMAILLIMIT record; repbu points at a REPBU record; clientpj points at a CLIENTPJ record; offlimits points at a OFFLIMIT record.
Extends: this entity extends COM. See Entity Extension.
Related lists: PPL (format SUB|CLIENT|PPL), VAC, PLACE.
Activity: activity timeline panel attached.

Creating a Client via the API

POST /v1/objects
Authorization: Bearer <your-pat>
Content-Type: application/json

{
  "entity":   "CLIENT",
  "level":    11000,
  "comboKey": "SUB:<your-sub-id>|ENT:",
  "name": "Name",
  "description": "Example",
  "parentClient": "Parent client",
  "knownAs": "Client known as"
}

Listing Clients records

GET /v1/entities/CLIENT/SUB

DemandFlow Support Centre

CLIENT: Client

CLIENT: Client

Entity properties

Use cases

Fields

Relationships

Creating a Client via the API

Listing Clients records

See also

Was this article helpful?