Domain Model
Customer
Fields
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
| id | string.uuid | Yes | — | Id |
| createdAt | string.date-time | Yes | — | Created at |
| updatedAt | string.date-time | Yes | — | Updated at |
| legalName | string | Yes | — | Legal name |
| displayName | string | Yes | — | Display name |
| customerType | enum(prospect, active, partner) | Yes | — | Customer type |
| vertical | unknown | No | — | Vertical |
| industrySegment | enum(corporate, retail, hospitality, healthcare, education, government, residential, industrial, financial, other) | No | — | Industry segment |
| status | enum(active, inactive, suspended, churned) | Yes | — | Status |
| customerSince | string.date-time | No | — | Customer since |
| contractTerms | object | No | — | Contract terms |
| billingPreferences | object | No | — | Billing preferences |
| taxProfile | object | No | — | Tax profile |
| healthScore | integer | No | — | Health score |
| annualRevenue | unknown | No | — | Annual revenue |
| ownerUserId | string | No | — | ID of the associated owner user |
| parentCustomerId | unknown | No | — | ID of the associated parent customer |
| notesSummary | string | No | — | Notes summary |
| accountNumber | string | No | — | Account number |
| website | string.uri | No | — | Website |
| primaryPhone | string | No | — | Primary phone |
| primaryEmail | string.email | No | — | Primary email |
| faxNumber | string | No | — | Fax number |
| physicalAddress | object | No | — | Physical address |
| mailingAddress | object | No | — | Mailing address |
| billingAddress | object | No | — | Billing address |
| paymentTerms | enum(net_15, net_30, net_45, net_60, net_90, due_on_receipt, custom) | No | — | Payment terms |
| taxExempt | boolean | Yes | false | Tax exempt |
| creditLimit | unknown | No | — | Credit limit |
| source | enum(referral, web, trade_show, cold_call, partner, other) | No | — | Source |
| referredBy | string | No | — | Referred by |
| logoS3Key | unknown | No | — | Logo s3key |
| workspaceId | string | Yes | — | ID of the associated workspace |
| visibilityMode | unknown | Yes | — | Visibility mode |
Create Schema
Fields accepted when creating a new record:
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
| legalName | string | Yes | — | Legal name |
| displayName | string | Yes | — | Display name |
| customerType | enum(prospect, active, partner) | Yes | — | Customer type |
| vertical | unknown | No | — | Vertical |
| industrySegment | enum(corporate, retail, hospitality, healthcare, education, government, residential, industrial, financial, other) | No | — | Industry segment |
| status | enum(active, inactive, suspended, churned) | Yes | "active" | Status |
| customerSince | unknown | No | — | Customer since |
| contractTerms | unknown | No | — | Contract terms |
| billingPreferences | unknown | No | — | Billing preferences |
| taxProfile | unknown | No | — | Tax profile |
| healthScore | integer | No | — | Health score |
| annualRevenue | unknown | No | — | Annual revenue |
| ownerUserId | unknown | No | — | ID of the associated owner user |
| parentCustomerId | unknown | No | — | ID of the associated parent customer |
| inheritParentLogo | boolean | No | — | Inherit parent logo |
| notesSummary | string,null | No | — | Notes summary |
| accountNumber | unknown | No | — | Account number |
| website | unknown | No | — | Website |
| primaryPhone | unknown | No | — | Primary phone |
| primaryEmail | unknown | No | — | Primary email |
| faxNumber | unknown | No | — | Fax number |
| physicalAddress | object | No | — | Physical address |
| mailingAddress | object | No | — | Mailing address |
| billingAddress | object | No | — | Billing address |
| paymentTerms | unknown | No | — | Payment terms |
| taxExempt | boolean | Yes | false | Tax exempt |
| creditLimit | unknown | No | — | Credit limit |
| source | unknown | No | — | Source |
| referredBy | unknown | No | — | Referred by |
| workspaceId | string | No | — | ID of the associated workspace |
| visibilityMode | unknown | No | — | Visibility mode |
| site | object | No | — | Site |
Update Schema
All fields are optional when updating:
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
| legalName | string | No | — | Legal name |
| displayName | string | No | — | Display name |
| customerType | enum(prospect, active, partner) | No | — | Customer type |
| vertical | unknown | No | — | Vertical |
| industrySegment | enum(corporate, retail, hospitality, healthcare, education, government, residential, industrial, financial, other) | No | — | Industry segment |
| status | enum(active, inactive, suspended, churned) | No | — | Status |
| customerSince | unknown | No | — | Customer since |
| contractTerms | unknown | No | — | Contract terms |
| billingPreferences | unknown | No | — | Billing preferences |
| taxProfile | unknown | No | — | Tax profile |
| healthScore | integer | No | — | Health score |
| annualRevenue | unknown | No | — | Annual revenue |
| ownerUserId | unknown | No | — | ID of the associated owner user |
| parentCustomerId | unknown | No | — | ID of the associated parent customer |
| notesSummary | string,null | No | — | Notes summary |
| accountNumber | unknown | No | — | Account number |
| website | unknown | No | — | Website |
| primaryPhone | unknown | No | — | Primary phone |
| primaryEmail | unknown | No | — | Primary email |
| faxNumber | unknown | No | — | Fax number |
| physicalAddress | object | No | — | Physical address |
| mailingAddress | object | No | — | Mailing address |
| billingAddress | object | No | — | Billing address |
| paymentTerms | unknown | No | — | Payment terms |
| taxExempt | boolean | No | — | Tax exempt |
| creditLimit | unknown | No | — | Credit limit |
| source | unknown | No | — | Source |
| referredBy | unknown | No | — | Referred by |