Entities

Employee

A person acting within a B2B organization

An Employee is a person acting within an Organization, such as a buyer, approver, cost-center owner, or sales representative. Organization membership and other relationships resolve through links rather than foreign-key fields.

Available since v0.26.0 in @laioutr-core/canonical-types

Components

Base

EmployeeBase

base

Display name, structured person name, contact details, job title, external ID, and custom fields.

Schema

displayName

stringrequired

The least common denominator of how to address the employee.

person

PersonName { firstName, lastName, salutation, 1 more }

string

formatemail

phone

string

Represents a phone number. Formatted as a E.164 number.

pattern^\+?[1-9]\d{1,14}$

jobTitle

string

Job title / function, for display (e.g. "Head of Procurement").

externalId

string

Identifier of this employee in the source system it was imported from.

customFields

Record<string, unknown>

Custom fields are a way for implementations to pass arbitrary data to actions, queries, etc.

Status

EmployeeStatus

status

Membership lifecycle: active, invited, or inactive.

Schema

status

"active" | "invited" | "inactive"required

The status value set — shared with the b2b/organization/employee-* actions so the vocabulary has a single source (invited is set by the invite flow, never manually).

Edit this pageorReport an issue

Organization

Trade-party entity for brands, manufacturers, vendors, suppliers, and distributors

ProductVariant

ProductVariant entity - components, queries, links, and related actions