AmpleoCRM

Authentication

AmpleoCRM uses Keycloak (self-hosted, EU) as the identity provider via OpenID Connect (OIDC).

Web Application (Blazor UI)

The Blazor UI uses cookie-based authentication with OIDC redirect to Keycloak:

User → Blazor App → OIDC Redirect → Keycloak Login → ID Token + Access Token → Cookie

Session cookies with 8-hour expiry (sliding)
Login: GET /Account/Login - redirects to Keycloak
Logout: POST /Account/Logout - signs out of cookie + Keycloak

API Authentication (Token-based)

For programmatic access (e.g., Outlook Add-in, integrations), use the token endpoint:

Endpoint	Method	Description
`/api/v1/auth/login`	POST	Authenticate with email and password. Returns access token, refresh token, and expiry.
`/api/v1/auth/refresh`	POST	Exchange a refresh token for a new access token.

Login Request

POST /api/v1/auth/login

Content-Type: application/json

{

"email": "user@example.com",

"password": "your-password"

}

Login Response

{

"accessToken": "eyJ...",

"refreshToken": "eyJ...",

"expiresIn": 300

}

Using the Access Token

Include the access token in the Authorization header for all API requests:

Authorization: Bearer eyJ...

Custom Claims

Keycloak tokens include custom claims used by AmpleoCRM:

Claim	Description
`sub`	Keycloak user ID
`ampleo_tenant_id`	Tenant identifier
`ampleo_business_unit_id`	Business unit identifier
`ampleo_roles`	User roles (comma-separated)
`ampleo_team_ids`	Team memberships

Authorization & Roles

Role Hierarchy

Roles are hierarchical - higher roles inherit all permissions of lower roles:

User Manager Admin System Admin

Role	Permissions
`user`	Full read access to tenant data. Standard CRUD on owned records.
`manager`	User permissions + metadata/configuration access.
`admin`	Manager permissions + user management, settings, data import.
`system_admin`	Unrestricted cross-tenant access. Platform operators only.

Record-Level Security

Entities that implement ownership (IOwnedEntity) enforce record-level access based on permission levels:

Level	Access Filter
`Own`	Only records where `OwnerId == currentUserId`
`Team`	Records owned by current user or team members
`BusinessUnit`	Records in the same business unit
`Organization`	All records in the tenant (no filter)

Tenant Isolation

All API requests are scoped to the authenticated user's tenant. Tenant isolation is enforced at 4 layers:

DI Context - TenantContext.TenantId set per request
EF Global Filters - automatic WHERE TenantId = @current on all queries
PostgreSQL RLS - Row-Level Security policies at the database level
Integration Tests - cross-tenant access verified by test suite

API Endpoints

All entity operations use a generic REST API. Replace {entityType} with the entity system name (e.g., Company, Contact).

Base URL: /api/v1/{entityType}

Method	Endpoint	Description
GET	`/api/v1/{entityType}`	List records with filtering, sorting, and pagination
GET	`/api/v1/{entityType}/{id}`	Get a single record by ID (UUID)
POST	`/api/v1/{entityType}`	Create a new record
PATCH	`/api/v1/{entityType}/{id}`	Partial update of an existing record
DELETE	`/api/v1/{entityType}/{id}`	Delete a record

Example: Create a Company

POST /api/v1/Company

Authorization: Bearer eyJ...

Content-Type: application/json

{

"name": "Acme Corp",

"email": "info@acme.dk",

"phone": "+45 12345678"

}

Example: List with Query Parameters

GET /api/v1/Company?page=1&pageSize=25&orderBy=name&orderDesc=false&search=acme

Authorization: Bearer eyJ...

Response Format (List)

{

"data": [ { "id": "...", "name": "...", ... } ],

"page": 1,

"pageSize": 25,

"totalCount": 42

}

Filtering & Pagination

Query Parameters

Parameter	Type	Default	Description
`page`	int	1	Page number (1-based)
`pageSize`	int	25	Results per page (max varies per entity)
`orderBy`	string	-	Field name to sort by (camelCase)
`orderDesc`	bool	false	Sort descending
`search`	string	-	Quick search across searchable fields
`filter`	string[]	-	Column filters: `filter=field:op=value`

Filter Operators

Filters use the format filter=fieldName:operator=value. Multiple filters can be combined.

Operator	Description	Example
`eq`	Equals	`filter=industry:eq=3`
`neq`	Not equals	`filter=status:neq=0`
`contains`	String contains	`filter=name:contains=acme`
`gt`	Greater than	`filter=amount:gt=1000`
`lt`	Less than	`filter=amount:lt=5000`
`gte`	Greater than or equal	`filter=amount:gte=1000`
`lte`	Less than or equal	`filter=amount:lte=5000`
`null`	Is null	`filter=email:null=true`

Concurrency Control

Updates use optimistic concurrency via PostgreSQL's xmin system column (exposed as rowVersion). If the record was modified between read and update, the API returns 409 Conflict.

Discovery & Metadata Endpoints

These endpoints allow clients to discover available entities and their schemas dynamically.

Method	Endpoint	Description
GET	`/api/v1/$discovery/entities`	List all available entities with field counts and extension info
GET	`/api/v1/$discovery/entities/{entityType}`	Get field schema for a specific entity (names, types, relationships)
GET	`/api/v1/$metadata/entities`	List all entity types with display names and CRUD permissions
GET	`/api/v1/$metadata/entities/{entityType}`	Detailed metadata: fields with labels, types, constraints, sections

Audit API

All entity mutations (create, update, delete) are automatically audited. The audit trail is read-only and append-only.

Method	Endpoint	Description
GET	`/api/v1/{entityType}/{id}/history`	Get audit history for a specific record
GET	`/api/v1/$audit/recent`	Get recent activity across all entities for the current tenant

Both endpoints support page and pageSize query parameters.

AccountType

Account Type

SettingsC R U D

Field	Type	Details
`category`	Integer	CategoryFilterable
`externalId`	String	External IDMax length: 200 · Filterable
`name`	String	NameMax length: 200 · Searchable · Filterable
`number`	String	NumberMax length: 50 · Searchable · Filterable
`createdAt`system	DateTime	Created OnFilterable · Read-only via API
`createdBy`system	Lookup	Created By→ User · Filterable · Read-only via API
`id`system	Lookup	IDFilterable · Read-only via API
`rowVersion`system	Integer	Row VersionFilterable · Read-only via API
`tenantId`system	Lookup	TenantFilterable · Read-only via API
`updatedAt`system	DateTime	Modified OnFilterable · Read-only via API
`updatedBy`system	Lookup	Modified By→ User · Filterable · Read-only via API

Excluded from API: tenantId

API route: /api/v1/AccountType · Max page size: 100

ActionItem

Action Item

SalesC R U D

Field	Type	Details
`actionType`	Option	TypeOptions: ActionItemType · Filterable
`completedAt`	DateTime	Completed AtFilterable
`createdEntityId`	Lookup	Created RecordFilterable
`createdEntityType`	String	Created Entity TypeMax length: 100 · Filterable
`details`	Text	DetailsMax length: 4000 · Filterable
`externalId`	String	External IDMax length: 200 · Filterable
`isCompleted`	Boolean	CompletedFilterable
`isSelected`	Boolean	SelectedFilterable
`meetingNoteId`	Lookup	Meeting Note→ MeetingNote · Filterable
`name`	String	ActionMax length: 500 · Searchable · Filterable
`ownerId`	PolymorphicLookup	OwnerFilterable
`sortOrder`	Integer	Sort OrderFilterable
`suggestedAmount`	Decimal	AmountFilterable
`suggestedCompanyName`	String	CompanyMax length: 200 · Filterable
`suggestedDate`	DateTime	Suggested DateFilterable
`suggestedLineDescription`	String	Line DescriptionMax length: 500 · Filterable
`suggestedProductName`	String	ProductMax length: 200 · Filterable
`suggestedQuantity`	Decimal	QuantityFilterable
`suggestedRecipientEmail`	String	Recipient EmailMax length: 500 · Filterable
`suggestedSubject`	String	SubjectMax length: 500 · Filterable
`createdAt`system	DateTime	Created OnFilterable · Read-only via API
`createdBy`system	Lookup	Created By→ User · Filterable · Read-only via API
`id`system	Lookup	IDFilterable · Read-only via API
`ownerBusinessUnitId`system	Lookup	Owning Business Unit→ BusinessUnit · Filterable
`ownerType`system	String	Owner TypeFilterable
`rowVersion`system	Integer	Row VersionFilterable · Read-only via API
`tenantId`system	Lookup	TenantFilterable · Read-only via API
`updatedAt`system	DateTime	Modified OnFilterable · Read-only via API
`updatedBy`system	Lookup	Modified By→ User · Filterable · Read-only via API

Excluded from API: tenantId

API route: /api/v1/ActionItem · Max page size: 100

Activity

SalesC R U D

Field	Type	Details
`activityDate`	DateTime	Activity DateFilterable
`bulkEmailId`	Lookup	Bulk Email→ BulkEmail · Filterable
`conversationId`	String	Conversation IDMax length: 500 · Filterable
`description`	Html	DescriptionFilterable
`duration`	Duration	DurationFilterable
`exchangeMessageId`	String	Exchange Message IDMax length: 500 · Filterable
`exchangeMessageIdRest`	String	Exchange REST IDMax length: 500 · Filterable
`externalId`	String	External IDMax length: 200 · Filterable
`internetMessageId`	String	Internet Message IDMax length: 500 · Searchable · Filterable
`meetingNoteId`	Lookup	Meeting Note→ MeetingNote · Filterable
`ownerId`	PolymorphicLookup	OwnerFilterable
`priority`	Option	PriorityOptions: ActivityPriority · Filterable
`regardingId`	PolymorphicLookup	RegardingFilterable
`scheduledEnd`	DateTime	EndFilterable
`scheduledStart`	DateTime	StartFilterable
`status`	Option	StatusOptions: ActivityStatus · Filterable
`subject`	String	SubjectMax length: 500 · Searchable · Filterable
`type`	Option	TypeOptions: ActivityType · Filterable
`clickCount`system	Integer	ClicksFilterable
`createdAt`system	DateTime	Created OnFilterable · Read-only via API
`createdBy`system	Lookup	Created By→ User · Filterable · Read-only via API
`firstClickedAt`system	DateTime	First ClickedFilterable
`firstOpenedAt`system	DateTime	First OpenedFilterable
`id`system	Lookup	IDFilterable · Read-only via API
`openCount`system	Integer	OpensFilterable
`ownerBusinessUnitId`system	Lookup	Owning Business Unit→ BusinessUnit · Filterable
`ownerType`system	String	Owner TypeFilterable
`regardingType`system	String	Regarding TypeMax length: 100 · Filterable
`rowVersion`system	Integer	Row VersionFilterable · Read-only via API
`tenantId`system	Lookup	TenantFilterable · Read-only via API
`trackingToken`system	String	Tracking TokenFilterable
`updatedAt`system	DateTime	Modified OnFilterable · Read-only via API
`updatedBy`system	Lookup	Modified By→ User · Filterable · Read-only via API

Excluded from API: tenantId

API route: /api/v1/Activity · Max page size: 100

ActivityParticipant

Activity Participant

C R U D

Field	Type	Details
`activityId`	Lookup	Activity→ Activity · Filterable
`contactId`	Lookup	Contact→ Contact · Filterable
`externalId`	String	External IDMax length: 200 · Filterable
`participationTypeMask`	Option	RoleOptions: ParticipationTypeMask · Filterable
`userId`	Lookup	User→ User · Filterable
`createdAt`system	DateTime	Created OnFilterable · Read-only via API
`createdBy`system	Lookup	Created By→ User · Filterable · Read-only via API
`id`system	Lookup	IDFilterable · Read-only via API
`ownerBusinessUnitId`system	Lookup	Owning Business Unit→ BusinessUnit · Filterable
`ownerId`system	PolymorphicLookup	OwnerFilterable
`ownerType`system	String	Owner TypeFilterable
`rowVersion`system	Integer	Row VersionFilterable · Read-only via API
`tenantId`system	Lookup	TenantFilterable · Read-only via API
`updatedAt`system	DateTime	Modified OnFilterable · Read-only via API
`updatedBy`system	Lookup	Modified By→ User · Filterable · Read-only via API

Excluded from API: tenantId

API route: /api/v1/ActivityParticipant · Max page size: 100

AgreementComponentSetting

Component Setting

HRC R U D

Field	Type	Details
`collectiveAgreementId`	Lookup	Agreement→ CollectiveAgreement · Filterable
`componentCode`	String	ComponentMax length: 100 · Searchable · Filterable
`externalId`	String	External IDMax length: 200 · Filterable
`isDeactivated`	Boolean	DeactivatedFilterable
`overrideName`	String	Name OverrideMax length: 200 · Filterable
`overrideRequired`	Boolean	Required OverrideFilterable
`payTypeId`	Lookup	Payroll Code→ PayType · Filterable
`createdAt`system	DateTime	Created OnFilterable · Read-only via API
`createdBy`system	Lookup	Created By→ User · Filterable · Read-only via API
`id`system	Lookup	IDFilterable · Read-only via API
`rowVersion`system	Integer	Row VersionFilterable · Read-only via API
`tenantId`system	Lookup	TenantFilterable · Read-only via API
`updatedAt`system	DateTime	Modified OnFilterable · Read-only via API
`updatedBy`system	Lookup	Modified By→ User · Filterable · Read-only via API

Excluded from API: tenantId

API route: /api/v1/AgreementComponentSetting · Max page size: 100

AgreementLocalComponent

Local Component

HRC R U D

Field	Type	Details
`code`	String	CodeMax length: 100 · Searchable · Filterable
`collectiveAgreementId`	Lookup	Agreement→ CollectiveAgreement · Filterable
`externalId`	String	External IDMax length: 200 · Filterable
`granularity`	Option	GranularityOptions: AgreementLocalComponentGranularity · Filterable
`inputType`	Option	Input TypeOptions: AgreementLocalComponentInputType · Filterable
`isRequired`	Boolean	RequiredFilterable
`name`	String	NameMax length: 200 · Searchable · Filterable
`optionSetName`	String	Option SetMax length: 100 · Filterable
`payTypeId`	Lookup	Payroll Code→ PayType · Filterable
`sortOrder`	Integer	Sort OrderFilterable
`unit`	String	UnitMax length: 20 · Filterable
`createdAt`system	DateTime	Created OnFilterable · Read-only via API
`createdBy`system	Lookup	Created By→ User · Filterable · Read-only via API
`id`system	Lookup	IDFilterable · Read-only via API
`rowVersion`system	Integer	Row VersionFilterable · Read-only via API
`tenantId`system	Lookup	TenantFilterable · Read-only via API
`updatedAt`system	DateTime	Modified OnFilterable · Read-only via API
`updatedBy`system	Lookup	Modified By→ User · Filterable · Read-only via API

Excluded from API: tenantId

API route: /api/v1/AgreementLocalComponent · Max page size: 100

AgreementTemplate

Agreement Template

SettingsC R U D

Field	Type	Details
`description`	Text	DescriptionMax length: 4000 · Filterable
`externalId`	String	External IDMax length: 200 · Filterable
`isActive`	Boolean	ActiveFilterable
`name`	String	NameMax length: 200 · Searchable · Filterable
`union`	String	UnionMax length: 200 · Searchable · Filterable
`createdAt`system	DateTime	Created OnFilterable · Read-only via API
`createdBy`system	Lookup	Created By→ User · Filterable · Read-only via API
`id`system	Lookup	IDFilterable · Read-only via API
`rowVersion`system	Integer	Row VersionFilterable · Read-only via API
`tenantId`system	Lookup	TenantFilterable · Read-only via API
`updatedAt`system	DateTime	Modified OnFilterable · Read-only via API
`updatedBy`system	Lookup	Modified By→ User · Filterable · Read-only via API

Excluded from API: tenantId

API route: /api/v1/AgreementTemplate · Max page size: 100

AgreementTemplateComponent

Pay Component

SettingsC R U D

Field	Type	Details
`agreementTemplateVersionId`	Lookup	Version→ AgreementTemplateVersion · Filterable
`code`	String	CodeMax length: 100 · Searchable · Filterable
`externalId`	String	External IDMax length: 200 · Filterable
`granularity`	Option	GranularityOptions: AgreementTemplateComponentGranularity · Filterable
`inputType`	Option	Input TypeOptions: AgreementTemplateComponentInputType · Filterable
`isRequired`	Boolean	RequiredFilterable
`name`	String	NameMax length: 200 · Searchable · Filterable
`optionSetName`	String	Option SetMax length: 100 · Filterable
`payrollCodeHint`	String	Payroll Code HintMax length: 100 · Filterable
`sortOrder`	Integer	Sort OrderFilterable
`unit`	String	UnitMax length: 20 · Filterable
`createdAt`system	DateTime	Created OnFilterable · Read-only via API
`createdBy`system	Lookup	Created By→ User · Filterable · Read-only via API
`id`system	Lookup	IDFilterable · Read-only via API
`rowVersion`system	Integer	Row VersionFilterable · Read-only via API
`tenantId`system	Lookup	TenantFilterable · Read-only via API
`updatedAt`system	DateTime	Modified OnFilterable · Read-only via API
`updatedBy`system	Lookup	Modified By→ User · Filterable · Read-only via API

Excluded from API: tenantId

API route: /api/v1/AgreementTemplateComponent · Max page size: 100

AgreementTemplateVersion

Agreement Version

SettingsC R U D

Field	Type	Details
`agreementTemplateId`	Lookup	Template→ AgreementTemplate · Filterable
`cadence`	Option	CadenceOptions: AgreementTemplateVersionCadence · Filterable
`changelog`	Text	ChangelogMax length: 4000 · Filterable
`effectiveFrom`	Date	Effective FromFilterable
`externalId`	String	External IDMax length: 200 · Filterable
`isCurrent`	Boolean	CurrentFilterable
`lockOnApproval`	Boolean	Lock On ApprovalFilterable
`publishedAt`	Date	PublishedFilterable
`receiptLeadDays`	Integer	Receipt Lead DaysFilterable
`versionLabel`	String	VersionMax length: 50 · Searchable · Filterable
`createdAt`system	DateTime	Created OnFilterable · Read-only via API
`createdBy`system	Lookup	Created By→ User · Filterable · Read-only via API
`id`system	Lookup	IDFilterable · Read-only via API
`rowVersion`system	Integer	Row VersionFilterable · Read-only via API
`tenantId`system	Lookup	TenantFilterable · Read-only via API
`updatedAt`system	DateTime	Modified OnFilterable · Read-only via API
`updatedBy`system	Lookup	Modified By→ User · Filterable · Read-only via API

Excluded from API: tenantId

API route: /api/v1/AgreementTemplateVersion · Max page size: 100

Asset

ServiceFieldServiceC R U D

Field	Type	Details
`assetType`	Option	TypeOptions: AssetType · Filterable
`companyId`	Lookup	Company→ Company · Filterable
`contactId`	Lookup	Contact→ Contact · Filterable
`externalId`	String	External IDMax length: 200 · Filterable
`installedDate`	Date	InstalledFilterable
`locationId`	Lookup	Location→ Location · Filterable
`model`	String	ModelMax length: 200 · Filterable
`name`	String	NameMax length: 200 · Searchable · Filterable
`notes`	Text	NotesMax length: 4000 · Filterable
`ownerId`	PolymorphicLookup	OwnerFilterable
`serialNumber`	String	Serial NumberMax length: 100 · Searchable · Filterable
`status`	Option	StatusOptions: AssetStatus · Filterable
`warrantyEnd`	Date	Warranty EndFilterable
`createdAt`system	DateTime	Created OnFilterable · Read-only via API
`createdBy`system	Lookup	Created By→ User · Filterable · Read-only via API
`id`system	Lookup	IDFilterable · Read-only via API
`ownerBusinessUnitId`system	Lookup	Owning Business Unit→ BusinessUnit · Filterable
`ownerType`system	String	Owner TypeFilterable
`rowVersion`system	Integer	Row VersionFilterable · Read-only via API
`tenantId`system	Lookup	TenantFilterable · Read-only via API
`updatedAt`system	DateTime	Modified OnFilterable · Read-only via API
`updatedBy`system	Lookup	Modified By→ User · Filterable · Read-only via API

Excluded from API: tenantId

API route: /api/v1/Asset · Max page size: 100

Budget

ProjectManagementC R U D

Field	Type	Details
`accountTypeId`	Lookup	Account Type→ AccountType · Filterable
`amount`	Decimal	AmountFilterable
`budgetTemplateId`	Lookup	Budget Template→ BudgetTemplate · Filterable
`externalId`	String	External IDMax length: 200 · Filterable
`lineType`	Option	Line TypeOptions: BudgetLineType · Filterable
`name`	String	NameMax length: 200 · Searchable · Filterable
`regardingId`	PolymorphicLookup	RegardingFilterable
`createdAt`system	DateTime	Created OnFilterable · Read-only via API
`createdBy`system	Lookup	Created By→ User · Filterable · Read-only via API
`id`system	Lookup	IDFilterable · Read-only via API
`regardingType`system	String	Regarding TypeMax length: 100 · Filterable
`rowVersion`system	Integer	Row VersionFilterable · Read-only via API
`tenantId`system	Lookup	TenantFilterable · Read-only via API
`updatedAt`system	DateTime	Modified OnFilterable · Read-only via API
`updatedBy`system	Lookup	Modified By→ User · Filterable · Read-only via API

Excluded from API: tenantId

API route: /api/v1/Budget · Max page size: 100

BudgetTemplate

Budget Template

ProjectManagementC R U D

Field	Type	Details
`description`	Text	DescriptionMax length: 2000 · Filterable
`externalId`	String	External IDMax length: 200 · Filterable
`name`	String	NameMax length: 200 · Searchable · Filterable
`createdAt`system	DateTime	Created OnFilterable · Read-only via API
`createdBy`system	Lookup	Created By→ User · Filterable · Read-only via API
`id`system	Lookup	IDFilterable · Read-only via API
`rowVersion`system	Integer	Row VersionFilterable · Read-only via API
`tenantId`system	Lookup	TenantFilterable · Read-only via API
`updatedAt`system	DateTime	Modified OnFilterable · Read-only via API
`updatedBy`system	Lookup	Modified By→ User · Filterable · Read-only via API

Excluded from API: tenantId

API route: /api/v1/BudgetTemplate · Max page size: 100

BulkEmail

Bulk Email

CommunicationC R U D

Field	Type	Details
`emailTemplateId`	Lookup	Email Template→ EmailTemplate · Filterable
`externalId`	String	External IDMax length: 200 · Filterable
`name`	String	NameMax length: 200 · Searchable · Filterable
`ownerId`	PolymorphicLookup	OwnerFilterable
`recipientListId`	Lookup	Recipient List→ RecipientList · Filterable
`scheduledAt`	DateTime	Scheduled AtFilterable
`status`	Option	StatusOptions: BulkEmailStatus · Filterable
`createdAt`system	DateTime	Created OnFilterable · Read-only via API
`createdBy`system	Lookup	Created By→ User · Filterable · Read-only via API
`failureCount`system	Integer	FailedFilterable
`id`system	Lookup	IDFilterable · Read-only via API
`ownerBusinessUnitId`system	Lookup	Owning Business Unit→ BusinessUnit · Filterable
`ownerType`system	String	Owner TypeFilterable
`rowVersion`system	Integer	Row VersionFilterable · Read-only via API
`sentAt`system	DateTime	Sent AtFilterable
`successCount`system	Integer	SentFilterable
`tenantId`system	Lookup	TenantFilterable · Read-only via API
`totalRecipients`system	Integer	Total RecipientsFilterable
`updatedAt`system	DateTime	Modified OnFilterable · Read-only via API
`updatedBy`system	Lookup	Modified By→ User · Filterable · Read-only via API

Excluded from API: tenantId

API route: /api/v1/BulkEmail · Max page size: 100

CalculatedField

Calculated Field

SettingsC R U D

Field	Type	Details
`decimalPlaces`	Integer	Decimal PlacesFilterable
`description`	Text	DescriptionMax length: 2000 · Filterable
`entityType`	String	Entity TypeMax length: 100 · Filterable
`externalId`	String	External IDMax length: 200 · Filterable
`format`	Option	FormatOptions: CalculatedFieldFormat · Filterable
`isActive`	Boolean	ActiveFilterable
`name`	String	NameMax length: 200 · Searchable · Filterable
`ownerId`	PolymorphicLookup	OwnerFilterable
`sortOrder`	Integer	Sort OrderFilterable
`createdAt`system	DateTime	Created OnFilterable · Read-only via API
`createdBy`system	Lookup	Created By→ User · Filterable · Read-only via API
`id`system	Lookup	IDFilterable · Read-only via API
`ownerBusinessUnitId`system	Lookup	Owning Business Unit→ BusinessUnit · Filterable
`ownerType`system	String	Owner TypeFilterable
`rowVersion`system	Integer	Row VersionFilterable · Read-only via API
`tenantId`system	Lookup	TenantFilterable · Read-only via API
`updatedAt`system	DateTime	Modified OnFilterable · Read-only via API
`updatedBy`system	Lookup	Modified By→ User · Filterable · Read-only via API

Excluded from API: tenantId

API route: /api/v1/CalculatedField · Max page size: 100

Candidate

HRC R U D

Field	Type	Details
`currentCompany`	String	Current CompanyMax length: 200 · Filterable
`currentTitle`	String	Current TitleMax length: 200 · Filterable
`email`	String	EmailMax length: 320 · Searchable · Filterable
`externalId`	String	External IDMax length: 200 · Filterable
`firstName`	String	First NameMax length: 100 · Searchable · Filterable
`lastName`	String	Last NameMax length: 100 · Searchable · Filterable
`linkedInUrl`	String	LinkedInMax length: 300 · Filterable
`notes`	Text	NotesMax length: 8000 · Filterable
`ownerId`	PolymorphicLookup	OwnerFilterable
`phone`	String	PhoneMax length: 50 · Filterable
`source`	Option	SourceOptions: CandidateSource · Filterable
`createdAt`system	DateTime	Created OnFilterable · Read-only via API
`createdBy`system	Lookup	Created By→ User · Filterable · Read-only via API
`id`system	Lookup	IDFilterable · Read-only via API
`ownerBusinessUnitId`system	Lookup	Owning Business Unit→ BusinessUnit · Filterable
`ownerType`system	String	Owner TypeFilterable
`rowVersion`system	Integer	Row VersionFilterable · Read-only via API
`tenantId`system	Lookup	TenantFilterable · Read-only via API
`updatedAt`system	DateTime	Modified OnFilterable · Read-only via API
`updatedBy`system	Lookup	Modified By→ User · Filterable · Read-only via API

Excluded from API: tenantId

API route: /api/v1/Candidate · Max page size: 100

CaseRoutingCondition

Routing Condition

ServiceC R U D

Field	Type	Details
`caseTypeId`	Lookup	Case Type→ ServiceCaseType · Filterable
`companyId`	Lookup	Company→ Company · Filterable
`externalId`	String	External IDMax length: 200 · Filterable
`field`	Option	FieldOptions: ConditionField · Filterable
`priority`	Option	PriorityOptions: CasePriority · Filterable
`routingRuleId`	Lookup	Routing Rule→ CaseRoutingRule · Filterable
`createdAt`system	DateTime	Created OnFilterable · Read-only via API
`createdBy`system	Lookup	Created By→ User · Filterable · Read-only via API
`id`system	Lookup	IDFilterable · Read-only via API
`rowVersion`system	Integer	Row VersionFilterable · Read-only via API
`tenantId`system	Lookup	TenantFilterable · Read-only via API
`updatedAt`system	DateTime	Modified OnFilterable · Read-only via API
`updatedBy`system	Lookup	Modified By→ User · Filterable · Read-only via API

Excluded from API: tenantId

API route: /api/v1/CaseRoutingCondition · Max page size: 100

CaseRoutingRule

Case Routing Rule

ServiceC R U D

Field	Type	Details
`assignedToId`	Lookup	Assigned To→ User · Filterable
`externalId`	String	External IDMax length: 200 · Filterable
`isActive`	Boolean	ActiveFilterable
`name`	String	NameMax length: 200 · Searchable · Filterable
`ownerId`	PolymorphicLookup	OwnerFilterable
`queueId`	Lookup	Queue→ ServiceQueue · Filterable
`sortOrder`	Integer	Sort OrderFilterable
`createdAt`system	DateTime	Created OnFilterable · Read-only via API
`createdBy`system	Lookup	Created By→ User · Filterable · Read-only via API
`id`system	Lookup	IDFilterable · Read-only via API
`ownerBusinessUnitId`system	Lookup	Owning Business Unit→ BusinessUnit · Filterable
`ownerType`system	String	Owner TypeFilterable
`rowVersion`system	Integer	Row VersionFilterable · Read-only via API
`tenantId`system	Lookup	TenantFilterable · Read-only via API
`updatedAt`system	DateTime	Modified OnFilterable · Read-only via API
`updatedBy`system	Lookup	Modified By→ User · Filterable · Read-only via API

Excluded from API: tenantId

API route: /api/v1/CaseRoutingRule · Max page size: 100

CollectiveAgreement

Collective Agreement

HRC R U D

Field	Type	Details
`agreementTemplateId`	Lookup	Template→ AgreementTemplate · Filterable
`externalId`	String	External IDMax length: 200 · Filterable
`isActive`	Boolean	ActiveFilterable
`name`	String	NameMax length: 200 · Searchable · Filterable
`pinnedVersionId`	Lookup	Version→ AgreementTemplateVersion · Filterable
`createdAt`system	DateTime	Created OnFilterable · Read-only via API
`createdBy`system	Lookup	Created By→ User · Filterable · Read-only via API
`id`system	Lookup	IDFilterable · Read-only via API
`rowVersion`system	Integer	Row VersionFilterable · Read-only via API
`tenantId`system	Lookup	TenantFilterable · Read-only via API
`updatedAt`system	DateTime	Modified OnFilterable · Read-only via API
`updatedBy`system	Lookup	Modified By→ User · Filterable · Read-only via API

Excluded from API: tenantId

API route: /api/v1/CollectiveAgreement · Max page size: 100

Company

SalesServiceC R U D

Field	Type	Details
`accountManagerId`extension	Lookup	Account Manager→ User
`address`	String	AddressMax length: 500 · Filterable
`allowEmail`	Boolean	Allow EmailFilterable
`allowMail`	Boolean	Allow MailFilterable
`allowMarketing`	Boolean	Allow MarketingFilterable
`allowPhone`	Boolean	Allow PhoneFilterable
`annualRevenue`	Currency	Company Annual RevenueFilterable
`city`	String	CityMax length: 100 · Searchable · Filterable
`companyStartDate`	Date	FoundedFilterable
`companyType`	Option	TypeOptions: CompanyType · Filterable
`country`	String	CountryMax length: 100 · Searchable · Filterable
`creditRating`extension	Option	Credit RatingOptions: CreditRating
`customerNumber`	String	Customer NumberMax length: 50 · Searchable · Filterable
`customerSince`extension	DateTime	Customer Since
`cvrStatus`	String	Registry StatusMax length: 100 · Filterable
`description`	Text	DescriptionMax length: 4000 · Filterable
`email`	String	EmailMax length: 320 · Searchable · Filterable
`externalId`	String	External IDMax length: 200 · Filterable
`followUpDate`	DateTime	Follow-up DateFilterable
`followUpNote`	String	Follow-up NoteMax length: 500 · Filterable
`industry`	Option	IndustryOptions: Industry · Filterable
`industryCode`	String	Industry CodeMax length: 20 · Filterable
`industryName`	String	Industry NameMax length: 500 · Filterable
`internalNotes`extension	Text	Internal NotesMax length: 4000
`legalOwner`	String	Legal OwnerMax length: 500 · Filterable
`municipality`	String	MunicipalityMax length: 200 · Filterable
`name`	String	Company NameMax length: 200 · Searchable · Filterable
`numberOfEmployees`	Option	Number of EmployeesOptions: NumberOfEmployees · Filterable
`ownerId`	PolymorphicLookup	OwnerFilterable
`parentCompanyId`	Lookup	Parent Company→ Company · Filterable
`permissionUpdatedAt`	DateTime	Permission UpdatedFilterable
`phone`	String	PhoneMax length: 50 · Searchable · Filterable
`pNumber`	String	P-NumberMax length: 50 · Searchable · Filterable
`postalCode`	String	Postal CodeMax length: 20 · Filterable
`publicCompanyIdentifier`	String	Public Company IDMax length: 50 · Searchable · Filterable
`publicCompanyIdentifierType`	Option	ID TypeOptions: PublicCompanyIdentifierType · Filterable
`transactionCurrencyId`	Lookup	Currency→ Currency · Filterable
`vatNumber`extension	String	VAT NumberMax length: 50
`website`	String	WebsiteMax length: 500 · Filterable
`averageDealSize`system	Currency	Avg. Deal SizeFilterable
`createdAt`system	DateTime	Created OnFilterable · Read-only via API
`createdBy`system	Lookup	Created By→ User · Filterable · Read-only via API
`currentFiscalYearRevenue`system	Currency	Revenue Current Fiscal YearFilterable
`id`system	Lookup	IDFilterable · Read-only via API
`lastFiscalYearRevenue`system	Currency	Revenue Last Fiscal YearFilterable
`mergedIntoId`system	Lookup	Merged Into→ Company · Filterable
`nextSignApiKey`system	String	Next Sign Api Key
`nextSignCompanyId`system	String	Next Sign Company
`ownerBusinessUnitId`system	Lookup	Owning Business Unit→ BusinessUnit · Filterable
`ownerType`system	String	Owner TypeFilterable
`rowVersion`system	Integer	Row VersionFilterable · Read-only via API
`tenantId`system	Lookup	TenantFilterable · Read-only via API
`totalPipeline`system	Currency	Total PipelineFilterable
`updatedAt`system	DateTime	Modified OnFilterable · Read-only via API
`updatedBy`system	Lookup	Modified By→ User · Filterable · Read-only via API

Excluded from API: tenantId

API route: /api/v1/Company · Max page size: 100

CompanyFinanceLine

Financial Report

SalesC R U D

Field	Type	Details
`assets`	Currency	Total AssetsFilterable
`averageNumberOfEmployees`	Integer	Avg. EmployeesFilterable
`cash`	Currency	CashFilterable
`companyId`	Lookup	Company→ Company · Filterable
`currentAssets`	Currency	Current AssetsFilterable
`employeeBenefitsExpense`	Currency	Employee BenefitsFilterable
`equity`	Currency	EquityFilterable
`externalId`	String	External IDMax length: 200 · Filterable
`grossProfitLoss`	Currency	Gross ProfitFilterable
`liabilities`	Currency	Total LiabilitiesFilterable
`noncurrentAssets`	Currency	Non-current AssetsFilterable
`operatingProfit`	Currency	Operating Profit (EBIT)Filterable
`periodEnd`	Date	Period EndFilterable
`periodStart`	Date	Period StartSearchable · Filterable
`profitLoss`	Currency	Net IncomeFilterable
`profitLossBeforeTax`	Currency	Profit Before TaxFilterable
`proposedDividend`	Currency	Proposed DividendFilterable
`shorttermLiabilities`	Currency	Short-term LiabilitiesFilterable
`shorttermReceivables`	Currency	Short-term ReceivablesFilterable
`taxExpense`	Currency	Tax ExpenseFilterable
`transactionCurrencyId`	Lookup	Currency→ Currency · Filterable
`createdAt`system	DateTime	Created OnFilterable · Read-only via API
`createdBy`system	Lookup	Created By→ User · Filterable · Read-only via API
`id`system	Lookup	IDFilterable · Read-only via API
`rowVersion`system	Integer	Row VersionFilterable · Read-only via API
`tenantId`system	Lookup	TenantFilterable · Read-only via API
`updatedAt`system	DateTime	Modified OnFilterable · Read-only via API
`updatedBy`system	Lookup	Modified By→ User · Filterable · Read-only via API

Excluded from API: tenantId

API route: /api/v1/CompanyFinanceLine · Max page size: 100

CompanyVisitGoal

Visit Goal

SalesC R U D

Field	Type	Details
`companyId`	Lookup	Company→ Company · Filterable
`externalId`	String	External IDMax length: 200 · Filterable
`fiscalYear`	Integer	Fiscal YearFilterable
`note`	String	NoteMax length: 500 · Filterable
`ownerId`	Lookup	Owner→ User · Filterable
`targetVisits`	Integer	Target VisitsFilterable
`createdAt`system	DateTime	Created OnFilterable · Read-only via API
`createdBy`system	Lookup	Created By→ User · Filterable · Read-only via API
`id`system	Lookup	IDFilterable · Read-only via API
`ownerBusinessUnitId`system	Lookup	Owning Business Unit→ BusinessUnit · Filterable
`ownerType`system	String	Owner Type
`rowVersion`system	Integer	Row VersionFilterable · Read-only via API
`tenantId`system	Lookup	TenantFilterable · Read-only via API
`updatedAt`system	DateTime	Modified OnFilterable · Read-only via API
`updatedBy`system	Lookup	Modified By→ User · Filterable · Read-only via API

Excluded from API: tenantId

API route: /api/v1/CompanyVisitGoal · Max page size: 100

Contact

SalesServiceC R U D

Field	Type	Details
`address`	String	AddressMax length: 500 · Filterable
`allowEmail`	Boolean	Allow EmailFilterable
`allowMail`	Boolean	Allow MailFilterable
`allowMarketing`	Boolean	Allow MarketingFilterable
`allowPhone`	Boolean	Allow PhoneFilterable
`alternatePhone1`	String	Alternate Phone 1Max length: 50 · Filterable
`alternatePhone2`	String	Alternate Phone 2Max length: 50 · Filterable
`city`	String	CityMax length: 100 · Searchable · Filterable
`companyId`	Lookup	Company→ Company · Filterable
`consentDate`extension	DateTime	Consent Date
`country`	String	CountryMax length: 100 · Filterable
`description`	Text	DescriptionMax length: 4000 · Filterable
`email`	String	EmailMax length: 320 · Searchable · Filterable
`externalId`	String	External IDMax length: 200 · Filterable
`firstName`	String	First NameMax length: 100 · Searchable · Filterable
`followUpDate`	DateTime	Follow-up DateFilterable
`followUpNote`	String	Follow-up NoteMax length: 500 · Filterable
`fullName`	String	Full NameMax length: 200 · Searchable · Filterable
`jobTitle`	String	Job TitleMax length: 200 · Searchable · Filterable
`lastName`	String	Last NameMax length: 100 · Searchable · Filterable
`leadSource`	Option	Lead SourceOptions: LeadSource · Filterable
`linkedInUrl`extension	String	LinkedIn URLMax length: 500
`marketingConsent`extension	Boolean	Marketing Consent
`mobilePhone`	String	Mobile PhoneMax length: 50 · Filterable
`ownerId`	PolymorphicLookup	OwnerFilterable
`permissionUpdatedAt`	DateTime	Permission UpdatedFilterable
`phone`	String	PhoneMax length: 50 · Searchable · Filterable
`postalCode`	String	Postal CodeMax length: 20 · Filterable
`preferredChannel`extension	Option	Preferred ChannelOptions: CommunicationChannel
`preferredContactMethod`	Option	Preferred Contact MethodOptions: PreferredContactMethod · Filterable
`status`	Option	StatusOptions: ContactStatus · Filterable
`twitterHandle`extension	String	Twitter/X HandleMax length: 50
`campaign`system	String	Campaign
`consentGivenAt`system	DateTime	Consent Given At
`consentSource`system	String	Consent Source
`createdAt`system	DateTime	Created OnFilterable · Read-only via API
`createdBy`system	Lookup	Created By→ User · Filterable · Read-only via API
`id`system	Lookup	IDFilterable · Read-only via API
`mergedIntoId`system	Lookup	Merged Into→ Contact · Filterable
`ownerBusinessUnitId`system	Lookup	Owning Business Unit→ BusinessUnit · Filterable
`ownerType`system	String	Owner TypeFilterable
`rowVersion`system	Integer	Row VersionFilterable · Read-only via API
`source`system	String	Source
`tenantId`system	Lookup	TenantFilterable · Read-only via API
`updatedAt`system	DateTime	Modified OnFilterable · Read-only via API
`updatedBy`system	Lookup	Modified By→ User · Filterable · Read-only via API

Excluded from API: tenantId

API route: /api/v1/Contact · Max page size: 100

Contract

SalesC R U D

Field	Type	Details
`companyId`	Lookup	Company→ Company · Filterable
`contactId`	Lookup	Contact→ Contact · Filterable
`description`	Text	DescriptionMax length: 4000 · Filterable
`endDate`	DateTime	End DateFilterable
`externalId`	String	External IDMax length: 200 · Filterable
`name`	String	Contract NameMax length: 200 · Searchable · Filterable
`ownerId`	PolymorphicLookup	OwnerFilterable
`startDate`	DateTime	Start DateFilterable
`status`	Option	StatusOptions: ContractStatus · Filterable
`createdAt`system	DateTime	Created OnFilterable · Read-only via API
`createdBy`system	Lookup	Created By→ User · Filterable · Read-only via API
`externalCaseFileId`system	String	External Case File IDMax length: 500 · Filterable
`id`system	Lookup	IDFilterable · Read-only via API
`ownerBusinessUnitId`system	Lookup	Owning Business Unit→ BusinessUnit · Filterable
`ownerType`system	String	Owner TypeFilterable
`rowVersion`system	Integer	Row VersionFilterable · Read-only via API
`signatureProvider`system	String	Signature ProviderMax length: 100 · Filterable
`tenantId`system	Lookup	TenantFilterable · Read-only via API
`updatedAt`system	DateTime	Modified OnFilterable · Read-only via API
`updatedBy`system	Lookup	Modified By→ User · Filterable · Read-only via API

Excluded from API: tenantId

API route: /api/v1/Contract · Max page size: 100

ContractSigner

Contract Signer

SalesC R U D

Field	Type	Details
`contactId`	Lookup	Contact→ Contact · Filterable
`contractId`	Lookup	Contract→ Contract · Filterable
`email`	String	EmailMax length: 320 · Filterable
`externalId`	String	External IDMax length: 200 · Filterable
`name`	String	NameMax length: 200 · Searchable · Filterable
`signingOrder`	Integer	Signing OrderFilterable
`status`	Option	StatusOptions: SignerStatus · Filterable
`userId`	Lookup	User→ User · Filterable
`createdAt`system	DateTime	Created OnFilterable · Read-only via API
`createdBy`system	Lookup	Created By→ User · Filterable · Read-only via API
`externalSignerId`system	String	External Signer IDMax length: 500 · Filterable
`id`system	Lookup	IDFilterable · Read-only via API
`rowVersion`system	Integer	Row VersionFilterable · Read-only via API
`signedAt`system	DateTime	Signed AtFilterable
`tenantId`system	Lookup	TenantFilterable · Read-only via API
`updatedAt`system	DateTime	Modified OnFilterable · Read-only via API
`updatedBy`system	Lookup	Modified By→ User · Filterable · Read-only via API

Excluded from API: tenantId

API route: /api/v1/ContractSigner · Max page size: 100

DocumentTemplate

Document Template

Settingsmanager+C R U D

Field	Type	Details
`content`	Text	ContentFilterable
`description`	Text	DescriptionMax length: 2000 · Filterable
`entityType`	String	Entity TypeMax length: 100 · Filterable
`externalId`	String	External IDMax length: 200 · Filterable
`isActive`	Boolean	ActiveFilterable
`name`	String	NameMax length: 200 · Searchable · Filterable
`orientation`	String	OrientationMax length: 20 · Filterable
`paperSize`	String	Paper SizeMax length: 20 · Filterable
`createdAt`system	DateTime	Created OnFilterable · Read-only via API
`createdBy`system	Lookup	Created By→ User · Filterable · Read-only via API
`id`system	Lookup	IDFilterable · Read-only via API
`rowVersion`system	Integer	Row VersionFilterable · Read-only via API
`tenantId`system	Lookup	TenantFilterable · Read-only via API
`updatedAt`system	DateTime	Modified OnFilterable · Read-only via API
`updatedBy`system	Lookup	Modified By→ User · Filterable · Read-only via API

Excluded from API: tenantId

API route: /api/v1/DocumentTemplate · Max page size: 100

EmailTemplate

Email Template

CommunicationC R U D

Field	Type	Details
`body`	Text	BodyMax length: 100000 · Filterable
`description`	Text	DescriptionMax length: 2000 · Filterable
`entityType`	String	Entity TypeMax length: 100 · Filterable
`externalId`	String	External IDMax length: 200 · Filterable
`fromName`	String	From NameMax length: 200 · Filterable
`isActive`	Boolean	ActiveFilterable
`name`	String	NameMax length: 200 · Searchable · Filterable
`ownerId`	PolymorphicLookup	OwnerFilterable
`replyToEmail`	String	Reply-To EmailMax length: 320 · Filterable
`subject`	String	SubjectMax length: 500 · Filterable
`createdAt`system	DateTime	Created OnFilterable · Read-only via API
`createdBy`system	Lookup	Created By→ User · Filterable · Read-only via API
`id`system	Lookup	IDFilterable · Read-only via API
`ownerBusinessUnitId`system	Lookup	Owning Business Unit→ BusinessUnit · Filterable
`ownerType`system	String	Owner TypeFilterable
`rowVersion`system	Integer	Row VersionFilterable · Read-only via API
`tenantId`system	Lookup	TenantFilterable · Read-only via API
`updatedAt`system	DateTime	Modified OnFilterable · Read-only via API
`updatedBy`system	Lookup	Modified By→ User · Filterable · Read-only via API

Excluded from API: tenantId

API route: /api/v1/EmailTemplate · Max page size: 100

EmployeeAgreement

Employee Agreement

HRC R U D

Field	Type	Details
`collectiveAgreementId`	Lookup	Agreement→ CollectiveAgreement · Filterable
`digitalReportingEnabled`	Boolean	Digital ReportingFilterable
`effectiveDate`	Date	Effective DateFilterable
`externalId`	String	External IDMax length: 200 · Filterable
`isActive`	Boolean	ActiveFilterable
`userId`	Lookup	Employee→ User · Filterable
`createdAt`system	DateTime	Created OnFilterable · Read-only via API
`createdBy`system	Lookup	Created By→ User · Filterable · Read-only via API
`id`system	Lookup	IDFilterable · Read-only via API
`rowVersion`system	Integer	Row VersionFilterable · Read-only via API
`tenantId`system	Lookup	TenantFilterable · Read-only via API
`updatedAt`system	DateTime	Modified OnFilterable · Read-only via API
`updatedBy`system	Lookup	Modified By→ User · Filterable · Read-only via API

Excluded from API: tenantId

API route: /api/v1/EmployeeAgreement · Max page size: 100

Equipment

FieldServiceC R U D

Field	Type	Details
`assignedToId`	Lookup	Assigned To→ User · Filterable
`equipmentType`	Option	TypeOptions: EquipmentType · Filterable
`externalId`	String	External IDMax length: 200 · Filterable
`externalReference`	String	External ReferenceMax length: 200 · Searchable · Filterable
`model`	String	ModelMax length: 200 · Filterable
`name`	String	NameMax length: 200 · Searchable · Filterable
`notes`	Text	NotesMax length: 4000 · Filterable
`ownerId`	PolymorphicLookup	OwnerFilterable
`registrationNumber`	String	Registration No.Max length: 50 · Searchable · Filterable
`serialNumber`	String	Serial NumberMax length: 100 · Searchable · Filterable
`status`	Option	StatusOptions: EquipmentStatus · Filterable
`createdAt`system	DateTime	Created OnFilterable · Read-only via API
`createdBy`system	Lookup	Created By→ User · Filterable · Read-only via API
`id`system	Lookup	IDFilterable · Read-only via API
`ownerBusinessUnitId`system	Lookup	Owning Business Unit→ BusinessUnit · Filterable
`ownerType`system	String	Owner TypeFilterable
`rowVersion`system	Integer	Row VersionFilterable · Read-only via API
`tenantId`system	Lookup	TenantFilterable · Read-only via API
`updatedAt`system	DateTime	Modified OnFilterable · Read-only via API
`updatedBy`system	Lookup	Modified By→ User · Filterable · Read-only via API

Excluded from API: tenantId

API route: /api/v1/Equipment · Max page size: 100

Expense

FieldServiceC R U D

Field	Type	Details
`accountTypeId`	Lookup	Account Type→ AccountType · Filterable
`amount`	Currency	AmountFilterable
`category`	Option	CategoryOptions: ExpenseCategory · Filterable
`companyId`	Lookup	Company→ Company · Filterable
`description`	Text	DescriptionMax length: 4000 · Filterable
`expenseDate`	Date	Expense DateFilterable
`externalId`	String	External IDMax length: 200 · Filterable
`name`	String	NameMax length: 200 · Searchable · Filterable
`ownerId`	PolymorphicLookup	OwnerFilterable
`status`	Option	StatusOptions: ExpenseStatus · Filterable
`transactionCurrencyId`	Lookup	Currency→ Currency · Filterable
`workTaskId`	Lookup	Work Task→ WorkTask · Filterable
`createdAt`system	DateTime	Created OnFilterable · Read-only via API
`createdBy`system	Lookup	Created By→ User · Filterable · Read-only via API
`id`system	Lookup	IDFilterable · Read-only via API
`ownerBusinessUnitId`system	Lookup	Owning Business Unit→ BusinessUnit · Filterable
`ownerType`system	String	Owner TypeFilterable
`rowVersion`system	Integer	Row VersionFilterable · Read-only via API
`tenantId`system	Lookup	TenantFilterable · Read-only via API
`updatedAt`system	DateTime	Modified OnFilterable · Read-only via API
`updatedBy`system	Lookup	Modified By→ User · Filterable · Read-only via API

Excluded from API: tenantId

API route: /api/v1/Expense · Max page size: 100

FollowUp

Follow-up

SalesC R U D

Field	Type	Details
`completedAt`	DateTime	Completed OnFilterable
`dueDate`	DateTime	Due DateFilterable
`entityType`	String	Entity TypeMax length: 100 · Filterable
`externalId`	String	External IDMax length: 200 · Filterable
`isCompleted`	Boolean	CompletedFilterable
`note`	Text	NoteMax length: 2000 · Filterable
`ownerId`	PolymorphicLookup	OwnerFilterable
`recordId`	PolymorphicLookup	RecordFilterable
`title`	String	TitleMax length: 200 · Searchable · Filterable
`createdAt`system	DateTime	Created OnFilterable · Read-only via API
`createdBy`system	Lookup	Created By→ User · Filterable · Read-only via API
`id`system	Lookup	IDFilterable · Read-only via API
`ownerBusinessUnitId`system	Lookup	Owning Business Unit→ BusinessUnit · Filterable
`ownerType`system	String	Owner TypeFilterable
`rowVersion`system	Integer	Row VersionFilterable · Read-only via API
`tenantId`system	Lookup	TenantFilterable · Read-only via API
`updatedAt`system	DateTime	Modified OnFilterable · Read-only via API
`updatedBy`system	Lookup	Modified By→ User · Filterable · Read-only via API

Excluded from API: tenantId

API route: /api/v1/FollowUp · Max page size: 100

GeneratedDocument

Document

C R U D

Field	Type	Details
`content`	Text	ContentFilterable
`contentType`	String	Content TypeMax length: 100 · Filterable
`documentType`	Option	TypeOptions: DocumentType · Filterable
`entityType`	String	Entity TypeMax length: 100 · Filterable
`externalId`	String	External IDMax length: 200 · Filterable
`fileName`	String	File NameMax length: 500 · Filterable
`name`	String	NameMax length: 200 · Searchable · Filterable
`orientation`	String	OrientationMax length: 20 · Filterable
`paperSize`	String	Paper SizeMax length: 20 · Filterable
`recordId`	Lookup	Source RecordFilterable
`sizeBytes`	Integer	File SizeFilterable
`templateId`	Lookup	Template→ DocumentTemplate · Filterable
`createdAt`system	DateTime	Created OnFilterable · Read-only via API
`createdBy`system	Lookup	Created By→ User · Filterable · Read-only via API
`id`system	Lookup	IDFilterable · Read-only via API
`rowVersion`system	Integer	Row VersionFilterable · Read-only via API
`tenantId`system	Lookup	TenantFilterable · Read-only via API
`updatedAt`system	DateTime	Modified OnFilterable · Read-only via API
`updatedBy`system	Lookup	Modified By→ User · Filterable · Read-only via API

Excluded from API: tenantId

API route: /api/v1/GeneratedDocument · Max page size: 100

Goal

SalesC R U D

Field	Type	Details
`actualValue`	Decimal	ActualFilterable
`description`	Text	DescriptionMax length: 2000 · Filterable
`externalId`	String	External IDMax length: 200 · Filterable
`fiscalYear`	Integer	Fiscal YearFilterable
`metric`	Option	MetricOptions: GoalMetric · Filterable
`month`	Integer	MonthFilterable
`name`	String	NameMax length: 200 · Searchable · Filterable
`ownerId`	Lookup	Owner→ User · Filterable
`periodType`	Option	Period TypeOptions: GoalPeriodType · Filterable
`quarter`	Integer	QuarterFilterable
`targetValue`	Decimal	TargetFilterable
`year`	Integer	YearFilterable
`createdAt`system	DateTime	Created OnFilterable · Read-only via API
`createdBy`system	Lookup	Created By→ User · Filterable · Read-only via API
`id`system	Lookup	IDFilterable · Read-only via API
`ownerBusinessUnitId`system	Lookup	Owning Business Unit→ BusinessUnit · Filterable
`ownerType`system	String	Owner Type
`rowVersion`system	Integer	Row VersionFilterable · Read-only via API
`tenantId`system	Lookup	TenantFilterable · Read-only via API
`updatedAt`system	DateTime	Modified OnFilterable · Read-only via API
`updatedBy`system	Lookup	Modified By→ User · Filterable · Read-only via API

Excluded from API: tenantId

API route: /api/v1/Goal · Max page size: 100

InboundWebhookEvent

Webhook Event

SettingsC R U D

Field	Type	Details
`contentType`	String	Content TypeMax length: 200 · Filterable
`error`	Text	ErrorFilterable
`externalId`	String	External IDMax length: 200 · Filterable
`handlerName`	String	HandlerMax length: 200 · Filterable
`headers`	Text	HeadersFilterable
`httpMethod`	String	HTTP MethodMax length: 10 · Filterable
`payload`	Text	PayloadFilterable
`processedAt`	DateTime	Processed AtFilterable
`receivedAt`	DateTime	Received AtFilterable
`sourceIp`	String	Source IPMax length: 45 · Filterable
`status`	Integer	StatusFilterable
`system`	String	SystemMax length: 100 · Searchable · Filterable
`createdAt`system	DateTime	Created OnFilterable · Read-only via API
`createdBy`system	Lookup	Created By→ User · Filterable · Read-only via API
`id`system	Lookup	IDFilterable · Read-only via API
`rowVersion`system	Integer	Row VersionFilterable · Read-only via API
`tenantId`system	Lookup	TenantFilterable · Read-only via API
`updatedAt`system	DateTime	Modified OnFilterable · Read-only via API
`updatedBy`system	Lookup	Modified By→ User · Filterable · Read-only via API

Excluded from API: tenantId

API route: /api/v1/InboundWebhookEvent · Max page size: 100

Inspection

FieldServiceC R U D

Field	Type	Details
`blockTaskCompletion`	Boolean	Block Task CompletionFilterable
`externalId`	String	External IDMax length: 200 · Filterable
`inspectionTemplateId`	Lookup	Template→ InspectionTemplate · Filterable
`name`	String	NameMax length: 200 · Searchable · Filterable
`ownerId`	PolymorphicLookup	OwnerFilterable
`status`	Option	StatusOptions: InspectionStatus · Filterable
`workTaskId`	Lookup	Work Task→ WorkTask · Filterable
`completedAt`system	DateTime	Completed OnFilterable
`completedById`system	Lookup	Completed By→ User · Filterable
`completedCount`system	Integer	CompletedFilterable
`createdAt`system	DateTime	Created OnFilterable · Read-only via API
`createdBy`system	Lookup	Created By→ User · Filterable · Read-only via API
`deviationCount`system	Integer	DeviationsFilterable
`id`system	Lookup	IDFilterable · Read-only via API
`ownerBusinessUnitId`system	Lookup	Owning Business Unit→ BusinessUnit · Filterable
`ownerType`system	String	Owner TypeFilterable
`requiredCount`system	Integer	RequiredFilterable
`rowVersion`system	Integer	Row VersionFilterable · Read-only via API
`tenantId`system	Lookup	TenantFilterable · Read-only via API
`updatedAt`system	DateTime	Modified OnFilterable · Read-only via API
`updatedBy`system	Lookup	Modified By→ User · Filterable · Read-only via API

Excluded from API: tenantId

API route: /api/v1/Inspection · Max page size: 100

InspectionLine

Inspection Line

FieldServiceC R U D

Field	Type	Details
`boolResult`	Boolean	CheckedFilterable
`externalId`	String	External IDMax length: 200 · Filterable
`inspectionId`	Lookup	Inspection→ Inspection · Filterable
`isDeviation`	Boolean	DeviationFilterable
`isRequired`	Boolean	RequiredFilterable
`label`	String	LabelMax length: 300 · Searchable · Filterable
`note`	Text	NoteMax length: 2000 · Filterable
`numberValue`	Decimal	ValueFilterable
`passFailResult`	Option	ResultOptions: InspectionResult · Filterable
`photoMediaFileId`	Image	Photo→ MediaFile · Filterable
`resultType`	Option	Result TypeOptions: InspectionResultTypeLine · Filterable
`sortOrder`	Integer	Sort OrderFilterable
`textValue`	String	TextMax length: 2000 · Filterable
`createdAt`system	DateTime	Created OnFilterable · Read-only via API
`createdBy`system	Lookup	Created By→ User · Filterable · Read-only via API
`id`system	Lookup	IDFilterable · Read-only via API
`inspectionTemplateLineId`system	Lookup	Template Line→ InspectionTemplateLine · Filterable
`rowVersion`system	Integer	Row VersionFilterable · Read-only via API
`tenantId`system	Lookup	TenantFilterable · Read-only via API
`updatedAt`system	DateTime	Modified OnFilterable · Read-only via API
`updatedBy`system	Lookup	Modified By→ User · Filterable · Read-only via API

Excluded from API: tenantId

API route: /api/v1/InspectionLine · Max page size: 100

InspectionTemplate

Inspection Template

ServiceFieldServiceC R U D

Field	Type	Details
`blockTaskCompletion`	Boolean	Block Task CompletionFilterable
`description`	Text	DescriptionMax length: 4000 · Filterable
`externalId`	String	External IDMax length: 200 · Filterable
`isActive`	Boolean	ActiveFilterable
`name`	String	NameMax length: 200 · Searchable · Filterable
`ownerId`	PolymorphicLookup	OwnerFilterable
`createdAt`system	DateTime	Created OnFilterable · Read-only via API
`createdBy`system	Lookup	Created By→ User · Filterable · Read-only via API
`id`system	Lookup	IDFilterable · Read-only via API
`ownerBusinessUnitId`system	Lookup	Owning Business Unit→ BusinessUnit · Filterable
`ownerType`system	String	Owner TypeFilterable
`rowVersion`system	Integer	Row VersionFilterable · Read-only via API
`tenantId`system	Lookup	TenantFilterable · Read-only via API
`updatedAt`system	DateTime	Modified OnFilterable · Read-only via API
`updatedBy`system	Lookup	Modified By→ User · Filterable · Read-only via API

Excluded from API: tenantId

API route: /api/v1/InspectionTemplate · Max page size: 100

InspectionTemplateLine

Template Line

ServiceC R U D

Field	Type	Details
`description`	Text	DescriptionMax length: 2000 · Filterable
`externalId`	String	External IDMax length: 200 · Filterable
`inspectionTemplateId`	Lookup	Template→ InspectionTemplate · Filterable
`isRequired`	Boolean	RequiredFilterable
`label`	String	LabelMax length: 300 · Searchable · Filterable
`requiresPhoto`	Boolean	Requires PhotoFilterable
`resultType`	Option	Result TypeOptions: InspectionResultType · Filterable
`sortOrder`	Integer	Sort OrderFilterable
`createdAt`system	DateTime	Created OnFilterable · Read-only via API
`createdBy`system	Lookup	Created By→ User · Filterable · Read-only via API
`id`system	Lookup	IDFilterable · Read-only via API
`rowVersion`system	Integer	Row VersionFilterable · Read-only via API
`tenantId`system	Lookup	TenantFilterable · Read-only via API
`updatedAt`system	DateTime	Modified OnFilterable · Read-only via API
`updatedBy`system	Lookup	Modified By→ User · Filterable · Read-only via API

Excluded from API: tenantId

API route: /api/v1/InspectionTemplateLine · Max page size: 100

Invoice

SalesC R U D

Field	Type	Details
`companyId`	Lookup	Company→ Company · Filterable
`contactId`	Lookup	Contact→ Contact · Filterable
`description`	Text	DescriptionMax length: 4000 · Filterable
`dueDate`	DateTime	Due DateFilterable
`externalId`	String	External IDMax length: 200 · Filterable
`invoiceDate`	DateTime	Invoice DateFilterable
`invoiceNumber`	String	Invoice NumberMax length: 50 · Searchable · Filterable
`name`	String	Invoice NameMax length: 200 · Searchable · Filterable
`opportunityId`	Lookup	Opportunity→ Opportunity · Filterable
`ownerId`	PolymorphicLookup	OwnerFilterable
`quoteId`	Lookup	Quote→ Quote · Filterable
`stage`	Option	StageOptions: InvoiceStage · Filterable
`totalAmount`	Currency	Total AmountFilterable
`totalAmountIncludingVat`	Currency	Total Incl. VATFilterable
`totalDiscountAmount`	Currency	Total DiscountFilterable
`totalLineAmount`	Currency	Total Before DiscountFilterable
`transactionCurrencyId`	Lookup	Currency→ Currency · Filterable
`vatRate`	Decimal	VAT Rate (%)Min: 0 · Max: 100 · Filterable
`createdAt`system	DateTime	Created OnFilterable · Read-only via API
`createdBy`system	Lookup	Created By→ User · Filterable · Read-only via API
`id`system	Lookup	IDFilterable · Read-only via API
`ownerBusinessUnitId`system	Lookup	Owning Business Unit→ BusinessUnit · Filterable
`ownerType`system	String	Owner TypeFilterable
`rowVersion`system	Integer	Row VersionFilterable · Read-only via API
`serviceAgreementId`system	Lookup	Service Agreement
`tenantId`system	Lookup	TenantFilterable · Read-only via API
`updatedAt`system	DateTime	Modified OnFilterable · Read-only via API
`updatedBy`system	Lookup	Modified By→ User · Filterable · Read-only via API

Excluded from API: tenantId

API route: /api/v1/Invoice · Max page size: 100

InvoiceLine

Invoice Line

SalesC R U D

Field	Type	Details
`baseAmount`	Currency	Base AmountFilterable
`description`	String	DescriptionMax length: 1000 · Filterable
`discountAmount`	Currency	Discount AmountFilterable
`discountType`	Option	Discount TypeOptions: DiscountType · Filterable
`discountValue`	Decimal	DiscountMin: 0 · Filterable
`extendedAmount`	Currency	Extended AmountFilterable
`externalId`	String	External IDMax length: 200 · Filterable
`invoiceId`	Lookup	Invoice→ Invoice · Filterable
`productId`	Lookup	Product→ Product · Filterable
`quantity`	Decimal	QuantityMin: 0 · Filterable
`unitPrice`	Currency	Unit PriceFilterable
`createdAt`system	DateTime	Created OnFilterable · Read-only via API
`createdBy`system	Lookup	Created By→ User · Filterable · Read-only via API
`id`system	Lookup	IDFilterable · Read-only via API
`rowVersion`system	Integer	Row VersionFilterable · Read-only via API
`sourceMaterialUsageId`system	Lookup	Source MaterialFilterable
`sourceServiceAgreementBillingLineId`system	Lookup	Source Billing LineFilterable
`sourceTimeEntryId`system	Lookup	Source Time EntryFilterable
`sourceWorkTaskId`system	Lookup	Source Work TaskFilterable
`tenantId`system	Lookup	TenantFilterable · Read-only via API
`updatedAt`system	DateTime	Modified OnFilterable · Read-only via API
`updatedBy`system	Lookup	Modified By→ User · Filterable · Read-only via API

Excluded from API: tenantId

API route: /api/v1/InvoiceLine · Max page size: 100

JobApplication

Application

HRC R U D

Field	Type	Details
`appliedDate`	Date	AppliedFilterable
`candidateId`	Lookup	Candidate→ Candidate · Filterable
`externalId`	String	External IDMax length: 200 · Filterable
`jobPostingId`	Lookup	Posting→ JobPosting · Filterable
`notes`	Text	NotesMax length: 4000 · Filterable
`rating`	Option	RatingOptions: CandidateRating · Filterable
`stage`	Option	StageOptions: ApplicationStage · Filterable
`createdAt`system	DateTime	Created OnFilterable · Read-only via API
`createdBy`system	Lookup	Created By→ User · Filterable · Read-only via API
`id`system	Lookup	IDFilterable · Read-only via API
`rowVersion`system	Integer	Row VersionFilterable · Read-only via API
`tenantId`system	Lookup	TenantFilterable · Read-only via API
`updatedAt`system	DateTime	Modified OnFilterable · Read-only via API
`updatedBy`system	Lookup	Modified By→ User · Filterable · Read-only via API

Excluded from API: tenantId

API route: /api/v1/JobApplication · Max page size: 100

JobPosting

Job Posting

HRC R U D

Field	Type	Details
`closingDate`	Date	ClosingFilterable
`companyId`	Lookup	Client / Company→ Company · Filterable
`description`	Text	DescriptionMax length: 8000 · Filterable
`employmentType`	Option	Employment TypeOptions: EmploymentType · Filterable
`externalId`	String	External IDMax length: 200 · Filterable
`openings`	Integer	OpeningsFilterable
`ownerId`	PolymorphicLookup	OwnerFilterable
`postedDate`	Date	PostedFilterable
`referenceNumber`	String	ReferenceMax length: 50 · Searchable · Filterable
`status`	Option	StatusOptions: JobPostingStatus · Filterable
`title`	String	TitleMax length: 200 · Searchable · Filterable
`workLocation`	String	LocationMax length: 200 · Filterable
`createdAt`system	DateTime	Created OnFilterable · Read-only via API
`createdBy`system	Lookup	Created By→ User · Filterable · Read-only via API
`id`system	Lookup	IDFilterable · Read-only via API
`ownerBusinessUnitId`system	Lookup	Owning Business Unit→ BusinessUnit · Filterable
`ownerType`system	String	Owner TypeFilterable
`rowVersion`system	Integer	Row VersionFilterable · Read-only via API
`tenantId`system	Lookup	TenantFilterable · Read-only via API
`updatedAt`system	DateTime	Modified OnFilterable · Read-only via API
`updatedBy`system	Lookup	Modified By→ User · Filterable · Read-only via API

Excluded from API: tenantId

API route: /api/v1/JobPosting · Max page size: 100

KnowledgeArticle

Knowledge Article

ServiceC R U D

Field	Type	Details
`category`	Option	CategoryOptions: ArticleCategory · Filterable
`content`	Text	ContentMax length: 50000 · Filterable
`externalId`	String	External IDMax length: 200 · Filterable
`keywords`	String	KeywordsMax length: 500 · Searchable · Filterable
`name`	String	TitleMax length: 300 · Searchable · Filterable
`ownerId`	PolymorphicLookup	OwnerFilterable
`status`	Option	StatusOptions: ArticleStatus · Filterable
`summary`	Text	SummaryMax length: 1000 · Filterable
`createdAt`system	DateTime	Created OnFilterable · Read-only via API
`createdBy`system	Lookup	Created By→ User · Filterable · Read-only via API
`id`system	Lookup	IDFilterable · Read-only via API
`ownerBusinessUnitId`system	Lookup	Owning Business Unit→ BusinessUnit · Filterable
`ownerType`system	String	Owner TypeFilterable
`rowVersion`system	Integer	Row VersionFilterable · Read-only via API
`tenantId`system	Lookup	TenantFilterable · Read-only via API
`updatedAt`system	DateTime	Modified OnFilterable · Read-only via API
`updatedBy`system	Lookup	Modified By→ User · Filterable · Read-only via API

Excluded from API: tenantId

API route: /api/v1/KnowledgeArticle · Max page size: 100

Lead

SalesC R U D

Field	Type	Details
`alternatePhone`	String	Alternative NumberMax length: 50 · Filterable
`budget`	Option	BudgetOptions: LeadBudget · Filterable
`budgetAmount`	Currency	Budget AmountFilterable
`companyAction`	Option	CompanyOptions: IntakeCompanyAction · Filterable
`companyId`	Lookup	Existing Company→ Company · Filterable
`companyName`	String	Company NameMax length: 500 · Searchable · Filterable
`companyPhone`	String	Company PhoneMax length: 50 · Filterable
`consentGiven`	Boolean	Consent GivenFilterable
`contactAction`	Option	ContactOptions: IntakeContactAction · Filterable
`contactId`	Lookup	Existing Contact→ Contact · Filterable
`country`	String	CountryMax length: 100 · Searchable · Filterable
`email`	String	EmailMax length: 500 · Searchable · Filterable
`externalId`	String	External IDMax length: 200 · Filterable
`firstName`	String	First NameMax length: 200 · Searchable · Filterable
`jobTitle`	String	Job TitleMax length: 200 · Filterable
`lastName`	String	Last NameMax length: 200 · Searchable · Filterable
`leadSource`	Option	Lead SourceOptions: LeadSource · Filterable
`linkedInUrl`	String	LinkedIn URLMax length: 500 · Searchable · Filterable
`message`	Text	MessageMax length: 4000 · Filterable
`mobilePhone`	String	MobileMax length: 50 · Filterable
`need`	Option	NeedOptions: LeadNeed · Filterable
`opportunityAction`	Option	OpportunityOptions: IntakeOpportunityAction · Filterable
`ownerId`	PolymorphicLookup	OwnerFilterable
`phone`	String	PhoneMax length: 50 · Filterable
`priority`	Option	PriorityOptions: LeadPriority · Filterable
`publicCompanyIdentifier`	String	Company IDMax length: 50 · Searchable · Filterable
`publicCompanyIdentifierType`	Option	ID TypeOptions: PublicCompanyIdentifierType · Filterable
`purchaseProcess`	Option	Buying ProcessOptions: PurchaseProcess · Filterable
`purchaseTimeframe`	Option	Purchase TimeframeOptions: PurchaseTimeframe · Filterable
`question1`	Integer	Question 1Min: 1 · Max: 5 · Filterable
`question2`	Integer	Question 2Min: 1 · Max: 5 · Filterable
`question3`	Integer	Question 3Min: 1 · Max: 5 · Filterable
`question4`	Integer	Question 4Min: 1 · Max: 5 · Filterable
`question5`	Integer	Question 5Min: 1 · Max: 5 · Filterable
`rating`	Option	RatingOptions: LeadRating · Filterable
`source`	String	Source TagMax length: 50 · Filterable
`subject`	String	SubjectMax length: 500 · Searchable · Filterable
`website`	String	WebsiteMax length: 500 · Filterable
`consentGivenAt`system	DateTime	Consent Given At
`convertedAt`system	DateTime	Converted At
`convertedCompanyId`system	Lookup	Created Company→ Company · Filterable
`convertedContactId`system	Lookup	Created Contact→ Contact · Filterable
`convertedOpportunityId`system	Lookup	Created Opportunity→ Opportunity · Filterable
`createdAt`system	DateTime	Created OnFilterable · Read-only via API
`createdBy`system	Lookup	Created By→ User · Filterable · Read-only via API
`formId`system	Lookup	Web Form→ LeadCaptureForm · Filterable
`formType`system	Option	Form TypeOptions: LeadFormType · Filterable
`id`system	Lookup	IdRead-only via API
`mergedIntoId`system	Lookup	Merged Into→ Lead · Filterable
`nextFollowUpDate`system	DateTime	Next Follow-upFilterable
`ownerBusinessUnitId`system	Lookup	Owning Business Unit→ BusinessUnit · Filterable
`ownerType`system	String	Owner TypeFilterable
`rowVersion`system	Integer	Row VersionFilterable · Read-only via API
`score`system	Integer	ScoreFilterable
`status`system	Option	StatusOptions: LeadStatus · Filterable
`tenantId`system	Lookup	TenantRead-only via API
`updatedAt`system	DateTime	Modified OnFilterable · Read-only via API
`updatedBy`system	Lookup	Modified By→ User · Filterable · Read-only via API

Excluded from API: tenantId

API route: /api/v1/Lead · Max page size: 100

LeadCaptureForm

Web Form

CommunicationC R U D

Field	Type	Details
`captureTarget`	Option	CreatesOptions: CaptureTarget · Filterable
`consentText`	Text	Consent TextMax length: 2000 · Filterable
`createActivity`	Boolean	Create TaskFilterable
`defaultCampaign`	String	Default CampaignMax length: 200 · Filterable
`externalId`	String	External IDMax length: 200 · Filterable
`fieldConfiguration`	Text	Field ConfigurationMax length: 4000 · Filterable
`formType`	Option	Form TypeOptions: WebFormType · Filterable
`name`	String	NameMax length: 200 · Filterable
`notifyUserId`	Lookup	Notify User→ User · Filterable
`redirectUrl`	String	Redirect URLMax length: 1000 · Filterable
`requireConsent`	Boolean	Require ConsentFilterable
`source`	String	Source TagMax length: 50 · Filterable
`status`	Option	StatusOptions: LeadCaptureFormStatus · Filterable
`styling`	Text	Styling (JSON)Max length: 4000 · Filterable
`successMessage`	Text	Success MessageMax length: 2000 · Filterable
`accessToken`system	String	Access TokenFilterable
`createdAt`system	DateTime	Created OnFilterable · Read-only via API
`createdBy`system	Lookup	Created By→ User · Filterable · Read-only via API
`id`system	Lookup	IdRead-only via API
`ownerBusinessUnitId`system	Lookup	Owner Business Unit
`ownerId`system	Lookup	Owner
`ownerType`system	String	Owner Type
`rowVersion`system	Integer	Row VersionRead-only via API
`tenantId`system	Lookup	TenantRead-only via API
`updatedAt`system	DateTime	Updated AtRead-only via API
`updatedBy`system	Lookup	Updated ByRead-only via API

Excluded from API: tenantId

API route: /api/v1/LeadCaptureForm · Max page size: 100

Location

FieldServiceC R U D

Field	Type	Details
`address`	String	AddressMax length: 500 · Searchable · Filterable
`city`	String	CityMax length: 200 · Searchable · Filterable
`companyId`	Lookup	Company→ Company · Filterable
`contactId`	Lookup	Contact→ Contact · Filterable
`country`	String	CountryMax length: 100 · Filterable
`externalId`	String	External IDMax length: 200 · Filterable
`latitude`	Decimal	LatitudeFilterable
`longitude`	Decimal	LongitudeFilterable
`name`	String	Location NameMax length: 200 · Searchable · Filterable
`ownerId`	PolymorphicLookup	OwnerFilterable
`postalCode`	String	Postal CodeMax length: 20 · Filterable
`createdAt`system	DateTime	Created OnFilterable · Read-only via API
`createdBy`system	Lookup	Created By→ User · Filterable · Read-only via API
`id`system	Lookup	IDFilterable · Read-only via API
`ownerBusinessUnitId`system	Lookup	Owning Business Unit→ BusinessUnit · Filterable
`ownerType`system	String	Owner TypeFilterable
`rowVersion`system	Integer	Row VersionFilterable · Read-only via API
`tenantId`system	Lookup	TenantFilterable · Read-only via API
`updatedAt`system	DateTime	Modified OnFilterable · Read-only via API
`updatedBy`system	Lookup	Modified By→ User · Filterable · Read-only via API

Excluded from API: tenantId

API route: /api/v1/Location · Max page size: 100

MaterialUsage

Material Usage

FieldServiceC R U D

Field	Type	Details
`companyId`	Lookup	Company→ Company · Filterable
`contactId`	Lookup	Contact→ Contact · Filterable
`date`	DateTime	DateFilterable
`description`	Text	NotesMax length: 4000 · Filterable
`externalId`	String	External IDMax length: 200 · Filterable
`isBillable`	Boolean	BillableFilterable
`name`	String	DescriptionMax length: 200 · Searchable · Filterable
`ownerId`	PolymorphicLookup	OwnerFilterable
`productId`	Lookup	Product→ Product · Filterable
`quantity`	Decimal	QuantityFilterable
`serviceCaseId`	Lookup	Case→ ServiceCase · Filterable
`stockLocationId`	Lookup	From Stock→ StockLocation · Filterable
`totalAmount`	Decimal	Total AmountFilterable
`unitPrice`	Decimal	Unit PriceFilterable
`workTaskId`	Lookup	Work Task→ WorkTask · Filterable
`createdAt`system	DateTime	Created OnFilterable · Read-only via API
`createdBy`system	Lookup	Created By→ User · Filterable · Read-only via API
`id`system	Lookup	IDFilterable · Read-only via API
`invoiceLineId`system	Lookup	Invoice Line→ InvoiceLine · Filterable
`ownerBusinessUnitId`system	Lookup	Owning Business Unit→ BusinessUnit · Filterable
`ownerType`system	String	Owner TypeFilterable
`rowVersion`system	Integer	Row VersionFilterable · Read-only via API
`tenantId`system	Lookup	TenantFilterable · Read-only via API
`updatedAt`system	DateTime	Modified OnFilterable · Read-only via API
`updatedBy`system	Lookup	Modified By→ User · Filterable · Read-only via API

Excluded from API: tenantId

API route: /api/v1/MaterialUsage · Max page size: 100

MediaFile

Media File

C R U D

Field	Type	Details
`altText`	String	Alt TextMax length: 500 · Filterable
`contentType`	String	Content TypeMax length: 100 · Filterable
`context`	String	ContextMax length: 100 · Filterable
`externalId`	String	External IDMax length: 200 · Filterable
`fileName`	String	File NameMax length: 500 · Filterable
`fileSize`	Integer	File SizeFilterable
`createdAt`system	DateTime	Created AtFilterable · Read-only via API
`createdBy`system	Lookup	Created ByFilterable · Read-only via API
`id`system	Lookup	IDFilterable · Read-only via API
`rowVersion`system	Integer	Row VersionRead-only via API
`tenantId`system	Lookup	TenantFilterable · Read-only via API
`updatedAt`system	DateTime	Updated AtFilterable · Read-only via API
`updatedBy`system	Lookup	Updated ByFilterable · Read-only via API

API route: /api/v1/MediaFile · Max page size: 100

MeetingNote

Meeting Note

SalesC R U D

Field	Type	Details
`externalId`	String	External IDMax length: 200 · Filterable
`fullText`	Text	Full Notes (raw)Max length: 100000 · Filterable
`meetingDate`	DateTime	Meeting DateFilterable
`noteText`	Text	SummaryMax length: 50000 · Filterable
`ownerId`	PolymorphicLookup	OwnerFilterable
`regardingId`	PolymorphicLookup	RegardingFilterable
`title`	String	TitleMax length: 500 · Searchable · Filterable
`createdAt`system	DateTime	Created OnFilterable · Read-only via API
`createdBy`system	Lookup	Created By→ User · Filterable · Read-only via API
`id`system	Lookup	IDFilterable · Read-only via API
`ownerBusinessUnitId`system	Lookup	Owning Business Unit→ BusinessUnit · Filterable
`ownerType`system	String	Owner TypeFilterable
`regardingType`system	String	Regarding TypeMax length: 100 · Filterable
`rowVersion`system	Integer	Row VersionFilterable · Read-only via API
`tenantId`system	Lookup	TenantFilterable · Read-only via API
`updatedAt`system	DateTime	Modified OnFilterable · Read-only via API
`updatedBy`system	Lookup	Modified By→ User · Filterable · Read-only via API

Excluded from API: tenantId

API route: /api/v1/MeetingNote · Max page size: 100

Opportunity

SalesC R U D

Field	Type	Details
`actualCloseDate`	DateTime	Actual Close DateFilterable
`companyId`	Lookup	Company→ Company · Filterable
`competitor`	String	CompetitorMax length: 200 · Searchable · Filterable
`contactId`	Lookup	Contact→ Contact · Filterable
`description`	Text	DescriptionMax length: 4000 · Filterable
`expectedCloseDate`	Date	Expected Close DateFilterable
`expectedRevenue`	Currency	Expected RevenueFilterable
`externalId`	String	External IDMax length: 200 · Filterable
`followUpDate`	Date	Follow-up DateFilterable
`followUpNote`	String	Follow-up NoteMax length: 500 · Filterable
`latestQuoteId`	Lookup	Latest Quote→ Quote · Filterable
`leadSource`	Option	Lead SourceOptions: LeadSource · Filterable
`lostReason`	Option	Lost ReasonOptions: LostReason · Filterable
`name`	String	Opportunity NameMax length: 200 · Searchable · Filterable
`ownerId`	PolymorphicLookup	OwnerFilterable
`probability`	Integer	Probability (%)Min: 0 · Max: 100 · Filterable
`revenueType`	Option	Revenue TypeOptions: RevenueType · Filterable
`stage`	Option	StageOptions: OpportunityStage · Filterable
`totalAmount`	Currency	Total AmountFilterable
`totalAmountIncludingVat`	Currency	Total Incl. VATFilterable
`totalDiscountAmount`	Currency	Total DiscountFilterable
`totalLineAmount`	Currency	Total Before DiscountFilterable
`transactionCurrencyId`	Lookup	Currency→ Currency · Filterable
`type`	Option	TypeOptions: OpportunityType · Filterable
`vatRate`	Decimal	VAT Rate (%)Min: 0 · Max: 100 · Filterable
`weightedRevenue`	Currency	Weighted Revenue
`createdAt`system	DateTime	Created OnFilterable · Read-only via API
`createdBy`system	Lookup	Created By→ User · Filterable · Read-only via API
`id`system	Lookup	IDFilterable · Read-only via API
`ownerBusinessUnitId`system	Lookup	Owning Business Unit→ BusinessUnit · Filterable
`ownerType`system	String	Owner TypeFilterable
`rowVersion`system	Integer	Row VersionFilterable · Read-only via API
`tenantId`system	Lookup	TenantFilterable · Read-only via API
`updatedAt`system	DateTime	Modified OnFilterable · Read-only via API
`updatedBy`system	Lookup	Modified By→ User · Filterable · Read-only via API

Excluded from API: tenantId

API route: /api/v1/Opportunity · Max page size: 100

OpportunityLine

Opportunity Line

SalesC R U D

Field	Type	Details
`baseAmount`	Currency	Base AmountFilterable
`discountAmount`	Currency	Discount AmountFilterable
`discountType`	Option	Discount TypeOptions: DiscountType · Filterable
`discountValue`	Decimal	DiscountMin: 0 · Filterable
`extendedAmount`	Currency	Extended AmountFilterable
`externalId`	String	External IDMax length: 200 · Filterable
`opportunityId`	Lookup	Opportunity→ Opportunity · Filterable
`productId`	Lookup	Product→ Product · Filterable
`quantity`	Decimal	QuantityMin: 0 · Filterable
`unitPrice`	Currency	Unit PriceFilterable
`createdAt`system	DateTime	Created OnFilterable · Read-only via API
`createdBy`system	Lookup	Created By→ User · Filterable · Read-only via API
`id`system	Lookup	IDFilterable · Read-only via API
`rowVersion`system	Integer	Row VersionFilterable · Read-only via API
`tenantId`system	Lookup	TenantFilterable · Read-only via API
`updatedAt`system	DateTime	Modified OnFilterable · Read-only via API
`updatedBy`system	Lookup	Modified By→ User · Filterable · Read-only via API

Excluded from API: tenantId

API route: /api/v1/OpportunityLine · Max page size: 100

PayType

Pay Type

SettingsC R U D

Field	Type	Details
`externalId`	String	External IDMax length: 200 · Filterable
`name`	String	NameMax length: 200 · Searchable · Filterable
`number`	String	NumberMax length: 50 · Searchable · Filterable
`createdAt`system	DateTime	Created OnFilterable · Read-only via API
`createdBy`system	Lookup	Created By→ User · Filterable · Read-only via API
`id`system	Lookup	IDFilterable · Read-only via API
`rowVersion`system	Integer	Row VersionFilterable · Read-only via API
`tenantId`system	Lookup	TenantFilterable · Read-only via API
`updatedAt`system	DateTime	Modified OnFilterable · Read-only via API
`updatedBy`system	Lookup	Modified By→ User · Filterable · Read-only via API

Excluded from API: tenantId

API route: /api/v1/PayType · Max page size: 100

Product

SettingsC R U D

Field	Type	Details
`description`	Text	DescriptionMax length: 4000 · Filterable
`externalId`	String	External IDMax length: 200 · Filterable
`isActive`	Boolean	ActiveFilterable
`isStockTracked`	Boolean	Stock TrackedFilterable
`name`	String	Product NameMax length: 200 · Searchable · Filterable
`productGroupId`	Lookup	Product Group→ ProductGroup · Filterable
`productNumber`	String	Product NumberMax length: 100 · Searchable · Filterable
`transactionCurrencyId`	Lookup	Currency→ Currency · Filterable
`unitPrice`	Currency	Unit PriceFilterable
`createdAt`system	DateTime	Created OnFilterable · Read-only via API
`createdBy`system	Lookup	Created By→ User · Filterable · Read-only via API
`id`system	Lookup	IDFilterable · Read-only via API
`rowVersion`system	Integer	Row VersionFilterable · Read-only via API
`tenantId`system	Lookup	TenantFilterable · Read-only via API
`updatedAt`system	DateTime	Modified OnFilterable · Read-only via API
`updatedBy`system	Lookup	Modified By→ User · Filterable · Read-only via API

Excluded from API: tenantId

API route: /api/v1/Product · Max page size: 100

ProductGroup

Product Group

SettingsC R U D

Field	Type	Details
`externalId`	String	External IDMax length: 200 · Filterable
`groupNumber`	String	Group NumberMax length: 100 · Searchable · Filterable
`name`	String	NameMax length: 200 · Searchable · Filterable
`createdAt`system	DateTime	Created OnFilterable · Read-only via API
`createdBy`system	Lookup	Created By→ User · Filterable · Read-only via API
`id`system	Lookup	IDFilterable · Read-only via API
`rowVersion`system	Integer	Row VersionFilterable · Read-only via API
`tenantId`system	Lookup	TenantFilterable · Read-only via API
`updatedAt`system	DateTime	Modified OnFilterable · Read-only via API
`updatedBy`system	Lookup	Modified By→ User · Filterable · Read-only via API

Excluded from API: tenantId

API route: /api/v1/ProductGroup · Max page size: 100

Project

ProjectManagementC R U D

Field	Type	Details
`budget`	Currency	BudgetFilterable
`budgetTemplateId`	Lookup	Budget Template→ BudgetTemplate · Filterable
`companyId`	Lookup	Company→ Company · Filterable
`completedDate`	DateTime	Completed DateFilterable
`contactId`	Lookup	Contact→ Contact · Filterable
`description`	Text	DescriptionMax length: 4000 · Filterable
`endDate`	DateTime	End DateFilterable
`estimatedHours`	Integer	Estimated HoursFilterable
`externalId`	String	External IDMax length: 200 · Filterable
`name`	String	NameMax length: 200 · Searchable · Filterable
`ownerId`	PolymorphicLookup	OwnerFilterable
`periodType`	Integer	Period TypeFilterable
`priority`	Option	PriorityOptions: ProjectPriority · Filterable
`progressPercent`	Integer	Progress (%)Filterable
`startDate`	DateTime	Start DateFilterable
`status`	Option	StatusOptions: ProjectStatus · Filterable
`transactionCurrencyId`	Lookup	Currency→ Currency · Filterable
`createdAt`system	DateTime	Created OnFilterable · Read-only via API
`createdBy`system	Lookup	Created By→ User · Filterable · Read-only via API
`id`system	Lookup	IDFilterable · Read-only via API
`ownerBusinessUnitId`system	Lookup	Owning Business Unit→ BusinessUnit · Filterable
`ownerType`system	String	Owner TypeFilterable
`rowVersion`system	Integer	Row VersionFilterable · Read-only via API
`tenantId`system	Lookup	TenantFilterable · Read-only via API
`updatedAt`system	DateTime	Modified OnFilterable · Read-only via API
`updatedBy`system	Lookup	Modified By→ User · Filterable · Read-only via API

Excluded from API: tenantId

API route: /api/v1/Project · Max page size: 100

ProjectActivity

Project Activity

ProjectManagementC R U D

Field	Type	Details
`assignedToId`	Lookup	Assigned To→ User · Filterable
`budgetTemplateId`	Lookup	Budget Template→ BudgetTemplate · Filterable
`completedDate`	DateTime	Completed DateFilterable
`description`	String	DescriptionFilterable
`endDate`	DateTime	End DateFilterable
`estimatedHours`	Integer	Estimated HoursFilterable
`externalId`	String	External IDMax length: 200 · Filterable
`name`	String	NameMax length: 200 · Searchable · Filterable
`ownerId`	PolymorphicLookup	OwnerFilterable
`predecessorId`	Lookup	Predecessor→ ProjectActivity · Filterable
`priority`	Option	PriorityOptions: ProjectActivityPriority · Filterable
`progressPercent`	Integer	Progress (%)Filterable
`projectId`	Lookup	Project→ Project · Filterable
`resourceTypeId`	Lookup	Resource Type→ ResourceType · Filterable
`startDate`	DateTime	Start DateFilterable
`status`	Option	StatusOptions: ProjectActivityStatus · Filterable
`workAreaId`	Lookup	Work Area→ WorkArea · Filterable
`workGroupId`	Lookup	Work Group→ WorkGroup · Filterable
`createdAt`system	DateTime	Created OnFilterable · Read-only via API
`createdBy`system	Lookup	Created By→ User · Filterable · Read-only via API
`id`system	Lookup	IDFilterable · Read-only via API
`ownerBusinessUnitId`system	Lookup	Owning Business Unit→ BusinessUnit · Filterable
`ownerType`system	String	Owner TypeFilterable
`rowVersion`system	Integer	Row VersionFilterable · Read-only via API
`tenantId`system	Lookup	TenantFilterable · Read-only via API
`updatedAt`system	DateTime	Modified OnFilterable · Read-only via API
`updatedBy`system	Lookup	Modified By→ User · Filterable · Read-only via API

Excluded from API: tenantId

API route: /api/v1/ProjectActivity · Max page size: 100

ProjectAllocation

Project Allocation

ProjectManagementC R U D

Field	Type	Details
`externalId`	String	External IDMax length: 200 · Filterable
`name`	String	NameMax length: 200 · Searchable · Filterable
`ownerId`	PolymorphicLookup	OwnerFilterable
`periodNumber`	Integer	PeriodFilterable
`periodType`	Option	Period TypeOptions: AllocationPeriodType · Filterable
`plannedHours`	Decimal	Planned HoursFilterable
`projectId`	Lookup	Project→ Project · Filterable
`resourceId`	Lookup	Resource→ User · Filterable
`resourceTypeId`	Lookup	Resource Type→ ResourceType · Filterable
`year`	Integer	YearFilterable
`createdAt`system	DateTime	Created OnFilterable · Read-only via API
`createdBy`system	Lookup	Created By→ User · Filterable · Read-only via API
`id`system	Lookup	IDFilterable · Read-only via API
`ownerBusinessUnitId`system	Lookup	Owning Business Unit→ BusinessUnit · Filterable
`ownerType`system	String	Owner TypeFilterable
`rowVersion`system	Integer	Row VersionFilterable · Read-only via API
`tenantId`system	Lookup	TenantFilterable · Read-only via API
`updatedAt`system	DateTime	Modified OnFilterable · Read-only via API
`updatedBy`system	Lookup	Modified By→ User · Filterable · Read-only via API

Excluded from API: tenantId

API route: /api/v1/ProjectAllocation · Max page size: 100

Quote

SalesC R U D

Field	Type	Details
`companyId`	Lookup	Company→ Company · Filterable
`contactId`	Lookup	Contact→ Contact · Filterable
`description`	Text	DescriptionMax length: 4000 · Filterable
`externalId`	String	External IDMax length: 200 · Filterable
`name`	String	Quote NameMax length: 200 · Searchable · Filterable
`opportunityId`	Lookup	Opportunity→ Opportunity · Filterable
`ownerId`	PolymorphicLookup	OwnerFilterable
`quoteNumber`	String	Quote NumberMax length: 50 · Searchable · Filterable
`revenueType`	Option	Revenue TypeOptions: RevenueType · Filterable
`stage`	Option	StageOptions: QuoteStage · Filterable
`totalAmount`	Currency	Total AmountFilterable
`totalAmountIncludingVat`	Currency	Total Incl. VATFilterable
`totalDiscountAmount`	Currency	Total DiscountFilterable
`totalLineAmount`	Currency	Total Before DiscountFilterable
`transactionCurrencyId`	Lookup	Currency→ Currency · Filterable
`validFrom`	DateTime	Valid FromFilterable
`validTo`	DateTime	Valid ToFilterable
`vatRate`	Decimal	VAT Rate (%)Min: 0 · Max: 100 · Filterable
`createdAt`system	DateTime	Created OnFilterable · Read-only via API
`createdBy`system	Lookup	Created By→ User · Filterable · Read-only via API
`id`system	Lookup	IDFilterable · Read-only via API
`ownerBusinessUnitId`system	Lookup	Owning Business Unit→ BusinessUnit · Filterable
`ownerType`system	String	Owner TypeFilterable
`rowVersion`system	Integer	Row VersionFilterable · Read-only via API
`tenantId`system	Lookup	TenantFilterable · Read-only via API
`updatedAt`system	DateTime	Modified OnFilterable · Read-only via API
`updatedBy`system	Lookup	Modified By→ User · Filterable · Read-only via API

Excluded from API: tenantId

API route: /api/v1/Quote · Max page size: 100

QuoteLine

Quote Line

SalesC R U D

Field	Type	Details
`baseAmount`	Currency	Base AmountFilterable
`discountAmount`	Currency	Discount AmountFilterable
`discountType`	Option	Discount TypeOptions: DiscountType · Filterable
`discountValue`	Decimal	DiscountMin: 0 · Filterable
`extendedAmount`	Currency	Extended AmountFilterable
`externalId`	String	External IDMax length: 200 · Filterable
`productId`	Lookup	Product→ Product · Filterable
`quantity`	Decimal	QuantityMin: 0 · Filterable
`quoteId`	Lookup	Quote→ Quote · Filterable
`unitPrice`	Currency	Unit PriceFilterable
`createdAt`system	DateTime	Created OnFilterable · Read-only via API
`createdBy`system	Lookup	Created By→ User · Filterable · Read-only via API
`id`system	Lookup	IDFilterable · Read-only via API
`rowVersion`system	Integer	Row VersionFilterable · Read-only via API
`tenantId`system	Lookup	TenantFilterable · Read-only via API
`updatedAt`system	DateTime	Modified OnFilterable · Read-only via API
`updatedBy`system	Lookup	Modified By→ User · Filterable · Read-only via API

Excluded from API: tenantId

API route: /api/v1/QuoteLine · Max page size: 100

RecipientList

Recipient List

CommunicationC R U D

Field	Type	Details
`description`	Text	DescriptionMax length: 2000 · Filterable
`externalId`	String	External IDMax length: 200 · Filterable
`memberCount`	Integer	Member CountFilterable
`name`	String	NameMax length: 200 · Searchable · Filterable
`ownerId`	PolymorphicLookup	OwnerFilterable
`status`	Option	StatusOptions: RecipientListStatus · Filterable
`createdAt`system	DateTime	Created OnFilterable · Read-only via API
`createdBy`system	Lookup	Created By→ User · Filterable · Read-only via API
`id`system	Lookup	IDFilterable · Read-only via API
`ownerBusinessUnitId`system	Lookup	Owning Business Unit→ BusinessUnit · Filterable
`ownerType`system	String	Owner TypeFilterable
`rowVersion`system	Integer	Row VersionFilterable · Read-only via API
`tenantId`system	Lookup	TenantFilterable · Read-only via API
`updatedAt`system	DateTime	Modified OnFilterable · Read-only via API
`updatedBy`system	Lookup	Modified By→ User · Filterable · Read-only via API

Excluded from API: tenantId

API route: /api/v1/RecipientList · Max page size: 100

RecipientListMember

List Member

CommunicationC R U D

Field	Type	Details
`displayName`	String	NameMax length: 300 · Filterable
`email`	String	EmailMax length: 320 · Filterable
`externalId`	String	External IDMax length: 200 · Filterable
`memberId`	PolymorphicLookup	MemberFilterable
`memberType`	String	Member TypeMax length: 50 · Filterable
`recipientListId`	Lookup	Recipient List→ RecipientList · Filterable
`status`	Option	StatusOptions: RecipientListMemberStatus · Filterable
`createdAt`system	DateTime	Created OnFilterable · Read-only via API
`createdBy`system	Lookup	Created By→ User · Filterable · Read-only via API
`id`system	Lookup	IDFilterable · Read-only via API
`rowVersion`system	Integer	Row VersionFilterable · Read-only via API
`tenantId`system	Lookup	TenantFilterable · Read-only via API
`updatedAt`system	DateTime	Modified OnFilterable · Read-only via API
`updatedBy`system	Lookup	Modified By→ User · Filterable · Read-only via API

Excluded from API: tenantId

API route: /api/v1/RecipientListMember · Max page size: 100

ResourceBooking

Resource Booking

ProjectManagementC R U D

Field	Type	Details
`bookingType`	Option	Booking TypeOptions: BookingType · Filterable
`duration`	Duration	DurationFilterable
`endDate`	DateTime	EndFilterable
`externalId`	String	External IDMax length: 200 · Filterable
`isAttention`	Boolean	AttentionFilterable
`isLocked`	Boolean	LockedFilterable
`isSystemUpdate`	Boolean	System UpdateFilterable
`name`	String	NameMax length: 200 · Searchable · Filterable
`note`	Text	NoteMax length: 2000 · Filterable
`ownerId`	PolymorphicLookup	OwnerFilterable
`resourceId`	Lookup	Resource→ User · Filterable
`resourceTypeId`	Lookup	Resource Type→ ResourceType · Filterable
`startDate`	DateTime	StartFilterable
`status`	Option	StatusOptions: BookingStatus · Filterable
`workTaskId`	Lookup	Work Task→ WorkTask · Filterable
`createdAt`system	DateTime	Created OnFilterable · Read-only via API
`createdBy`system	Lookup	Created By→ User · Filterable · Read-only via API
`id`system	Lookup	IDFilterable · Read-only via API
`ownerBusinessUnitId`system	Lookup	Owning Business Unit→ BusinessUnit · Filterable
`ownerType`system	String	Owner TypeFilterable
`rowVersion`system	Integer	Row VersionFilterable · Read-only via API
`tenantId`system	Lookup	TenantFilterable · Read-only via API
`updatedAt`system	DateTime	Modified OnFilterable · Read-only via API
`updatedBy`system	Lookup	Modified By→ User · Filterable · Read-only via API

Excluded from API: tenantId

API route: /api/v1/ResourceBooking · Max page size: 100

ResourceCapacity

Resource Capacity

ProjectManagementC R U D

Field	Type	Details
`availableHours`	Decimal	Available HoursFilterable
`externalId`	String	External IDMax length: 200 · Filterable
`name`	String	NameMax length: 200 · Searchable · Filterable
`ownerId`	PolymorphicLookup	OwnerFilterable
`periodNumber`	Integer	PeriodFilterable
`periodType`	Option	Period TypeOptions: AllocationPeriodType · Filterable
`resourceTypeId`	Lookup	Resource Type→ ResourceType · Filterable
`year`	Integer	YearFilterable
`createdAt`system	DateTime	Created OnFilterable · Read-only via API
`createdBy`system	Lookup	Created By→ User · Filterable · Read-only via API
`id`system	Lookup	IDFilterable · Read-only via API
`ownerBusinessUnitId`system	Lookup	Owning Business Unit→ BusinessUnit · Filterable
`ownerType`system	String	Owner TypeFilterable
`rowVersion`system	Integer	Row VersionFilterable · Read-only via API
`tenantId`system	Lookup	TenantFilterable · Read-only via API
`updatedAt`system	DateTime	Modified OnFilterable · Read-only via API
`updatedBy`system	Lookup	Modified By→ User · Filterable · Read-only via API

Excluded from API: tenantId

API route: /api/v1/ResourceCapacity · Max page size: 100

ResourceType

Resource Type

Settingsmanager+C R U D

Field	Type	Details
`color`	Color	ColourMax length: 9 · Filterable
`description`	Text	DescriptionMax length: 2000 · Filterable
`externalId`	String	External IDMax length: 200 · Filterable
`isActive`	Boolean	ActiveFilterable
`name`	String	NameMax length: 200 · Searchable · Filterable
`createdAt`system	DateTime	Created OnFilterable · Read-only via API
`createdBy`system	Lookup	Created By→ User · Filterable · Read-only via API
`id`system	Lookup	IDFilterable · Read-only via API
`ownerBusinessUnitId`system	Lookup	Business Unit→ BusinessUnit · Filterable
`ownerId`system	PolymorphicLookup	OwnerFilterable
`ownerType`system	String	Owner TypeFilterable
`rowVersion`system	Integer	Row VersionFilterable · Read-only via API
`tenantId`system	Lookup	TenantFilterable · Read-only via API
`updatedAt`system	DateTime	Modified OnFilterable · Read-only via API
`updatedBy`system	Lookup	Modified By→ User · Filterable · Read-only via API

Excluded from API: tenantId

API route: /api/v1/ResourceType · Max page size: 100

Revenue

SalesC R U D

Field	Type	Details
`accountTypeId`	Lookup	Account Type→ AccountType · Filterable
`amount`	Currency	AmountFilterable
`companyId`	Lookup	Company→ Company · Filterable
`description`	Text	DescriptionMax length: 4000 · Filterable
`externalId`	String	External IDMax length: 200 · Filterable
`externalReference`	String	External ReferenceMax length: 200 · Searchable · Filterable
`name`	String	NameMax length: 200 · Searchable · Filterable
`ownerId`	PolymorphicLookup	OwnerFilterable
`productGroupId`	Lookup	Product Group→ ProductGroup · Filterable
`productId`	Lookup	Product→ Product · Filterable
`revenueDate`	Date	Revenue DateFilterable
`sourceInvoiceId`	Lookup	Source Invoice→ Invoice · Filterable
`sourceInvoiceLineId`	Lookup	Source Invoice Line→ InvoiceLine · Filterable
`sourceOpportunityId`	Lookup	Source Opportunity→ Opportunity · Filterable
`status`	Option	StatusOptions: RevenueStatus · Filterable
`transactionCurrencyId`	Lookup	Currency→ Currency · Filterable
`workTaskId`	Lookup	Work Task→ WorkTask · Filterable
`createdAt`system	DateTime	Created OnFilterable · Read-only via API
`createdBy`system	Lookup	Created By→ User · Filterable · Read-only via API
`id`system	Lookup	IDFilterable · Read-only via API
`ownerBusinessUnitId`system	Lookup	Owning Business Unit→ BusinessUnit · Filterable
`ownerType`system	String	Owner TypeFilterable
`rowVersion`system	Integer	Row VersionFilterable · Read-only via API
`tenantId`system	Lookup	TenantFilterable · Read-only via API
`updatedAt`system	DateTime	Modified OnFilterable · Read-only via API
`updatedBy`system	Lookup	Modified By→ User · Filterable · Read-only via API

Excluded from API: tenantId

API route: /api/v1/Revenue · Max page size: 100

ServiceAgreement

Service Agreement

ServiceFieldServiceC R U D

Field	Type	Details
`companyId`	Lookup	Company→ Company · Filterable
`contactId`	Lookup	Contact→ Contact · Filterable
`endDate`	Date	End DateFilterable
`externalId`	String	External IDMax length: 200 · Filterable
`locationId`	Lookup	Location→ Location · Filterable
`name`	String	NameMax length: 200 · Searchable · Filterable
`ownerId`	PolymorphicLookup	OwnerFilterable
`startDate`	Date	Start DateFilterable
`status`	Option	StatusOptions: ServiceAgreementStatus · Filterable
`transactionCurrencyId`	Lookup	Currency→ Currency · Filterable
`vatRate`	Decimal	VAT RateFilterable
`createdAt`system	DateTime	Created OnFilterable · Read-only via API
`createdBy`system	Lookup	Created By→ User · Filterable · Read-only via API
`id`system	Lookup	IDFilterable · Read-only via API
`ownerBusinessUnitId`system	Lookup	Owning Business Unit→ BusinessUnit · Filterable
`ownerType`system	String	Owner TypeFilterable
`rowVersion`system	Integer	Row VersionFilterable · Read-only via API
`tenantId`system	Lookup	TenantFilterable · Read-only via API
`totalAmount`system	Currency	Total AmountFilterable
`totalAmountIncludingVat`system	Currency	Total Incl. VATFilterable
`totalLineAmount`system	Currency	Total Line AmountFilterable
`updatedAt`system	DateTime	Modified OnFilterable · Read-only via API
`updatedBy`system	Lookup	Modified By→ User · Filterable · Read-only via API

Excluded from API: tenantId

API route: /api/v1/ServiceAgreement · Max page size: 100

ServiceAgreementAsset

Agreement Asset

ServiceC R U D

Field	Type	Details
`assetId`	Lookup	Asset→ Asset · Filterable
`companyId`	Lookup	Company→ Company · Filterable
`externalId`	String	External IDMax length: 200 · Filterable
`note`	String	NoteMax length: 1000 · Filterable
`serviceAgreementId`	Lookup	Service Agreement→ ServiceAgreement · Filterable
`createdAt`system	DateTime	Created OnFilterable · Read-only via API
`createdBy`system	Lookup	Created By→ User · Filterable · Read-only via API
`id`system	Lookup	IDFilterable · Read-only via API
`rowVersion`system	Integer	Row VersionFilterable · Read-only via API
`tenantId`system	Lookup	TenantFilterable · Read-only via API
`updatedAt`system	DateTime	Modified OnFilterable · Read-only via API
`updatedBy`system	Lookup	Modified By→ User · Filterable · Read-only via API

Excluded from API: tenantId

API route: /api/v1/ServiceAgreementAsset · Max page size: 100

ServiceAgreementBillingLine

Billing Line

C R U D

Field	Type	Details
`baseAmount`	Currency	Base AmountFilterable
`billingPeriod`	Option	Billing PeriodOptions: BillingPeriod · Filterable
`chargeType`	Option	Charge TypeOptions: ServiceAgreementChargeType · Filterable
`discountAmount`	Currency	Discount AmountFilterable
`discountType`	Option	Discount TypeOptions: DiscountType · Filterable
`discountValue`	Decimal	DiscountMin: 0 · Filterable
`endDate`	Date	End DateFilterable
`extendedAmount`	Currency	Extended AmountFilterable
`externalId`	String	External IDMax length: 200 · Filterable
`name`	String	NameMax length: 200 · Searchable · Filterable
`productId`	Lookup	Product→ Product · Filterable
`quantity`	Decimal	QuantityMin: 0 · Filterable
`serviceAgreementId`	Lookup	Service Agreement→ ServiceAgreement · Filterable
`serviceAgreementLineId`	Lookup	Service Line→ ServiceAgreementLine · Filterable
`startDate`	Date	Start DateFilterable
`transactionCurrencyId`	Lookup	Currency→ Currency · Filterable
`unitPrice`	Currency	Unit PriceFilterable
`vatRate`	Decimal	VAT RateFilterable
`createdAt`system	DateTime	Created OnFilterable · Read-only via API
`createdBy`system	Lookup	Created By→ User · Filterable · Read-only via API
`id`system	Lookup	IDFilterable · Read-only via API
`lastBilledThrough`system	DateTime	Last Billed ThroughFilterable
`oneTimeBilled`system	Boolean	One-Time BilledFilterable
`rowVersion`system	Integer	Row VersionFilterable · Read-only via API
`tenantId`system	Lookup	TenantFilterable · Read-only via API
`updatedAt`system	DateTime	Modified OnFilterable · Read-only via API
`updatedBy`system	Lookup	Modified By→ User · Filterable · Read-only via API

Excluded from API: tenantId

API route: /api/v1/ServiceAgreementBillingLine · Max page size: 100

ServiceAgreementLine

Service Line

ServiceC R U D

Field	Type	Details
`assetId`	Lookup	Asset→ Asset · Filterable
`assignedToId`	Lookup	Fixed Resource→ User · Filterable
`companyId`	Lookup	Company→ Company · Filterable
`dayOfMonth`	Integer	Day of MonthMin: 1 · Max: 31 · Filterable
`description`	Text	DescriptionMax length: 4000 · Filterable
`duration`	Duration	DurationFilterable
`endDate`	Date	End DateFilterable
`endMode`	Option	EndOptions: RecurrenceEndMode · Filterable
`externalId`	String	External IDMax length: 200 · Filterable
`frequency`	Option	FrequencyOptions: RecurrenceFrequency · Filterable
`interval`	Integer	IntervalMin: 1 · Filterable
`leadTimeDays`	Integer	Lead Time (days)Min: 0 · Filterable
`locationId`	Lookup	Location→ Location · Filterable
`monthlyMode`	Option	Monthly ModeOptions: RecurrenceMonthlyMode · Filterable
`monthOfYear`	Integer	MonthMin: 1 · Max: 12 · Filterable
`name`	String	NameMax length: 200 · Searchable · Filterable
`occurrenceCount`	Integer	OccurrencesMin: 1 · Filterable
`onLocation`	Boolean	On LocationFilterable
`ordinal`	Option	OrdinalOptions: RecurrenceOrdinal · Filterable
`ordinalWeekday`	Option	WeekdayOptions: Weekday · Filterable
`priority`	Option	PriorityOptions: WorkTaskPriority · Filterable
`recurrenceSummary`	String	RecurrenceMax length: 500 · Filterable
`serviceAgreementId`	Lookup	Service Agreement→ ServiceAgreement · Filterable
`startDate`	Date	Start DateFilterable
`startHour`	Integer	Start HourMin: 0 · Max: 23 · Filterable
`startMinute`	Integer	Start MinuteMin: 0 · Max: 59 · Filterable
`visitCoverage`	Option	Billing CoverageOptions: VisitCoverageAgreement · Filterable
`weekdaysMask`	Integer	WeekdaysFilterable
`createdAt`system	DateTime	Created OnFilterable · Read-only via API
`createdBy`system	Lookup	Created By→ User · Filterable · Read-only via API
`id`system	Lookup	IDFilterable · Read-only via API
`lastGeneratedThrough`system	DateTime	Last Generated ThroughFilterable
`rowVersion`system	Integer	Row VersionFilterable · Read-only via API
`tenantId`system	Lookup	TenantFilterable · Read-only via API
`updatedAt`system	DateTime	Modified OnFilterable · Read-only via API
`updatedBy`system	Lookup	Modified By→ User · Filterable · Read-only via API

Excluded from API: tenantId

API route: /api/v1/ServiceAgreementLine · Max page size: 100

ServiceCase

Case

ServiceC R U D

Field	Type	Details
`assignedToId`	Lookup	Assigned To→ User · Filterable
`caseTypeId`	Lookup	Case Type→ ServiceCaseType · Filterable
`companyId`	Lookup	Company→ Company · Filterable
`contactId`	Lookup	Contact→ Contact · Filterable
`description`	Text	DescriptionMax length: 4000 · Filterable
`externalId`	String	External IDMax length: 200 · Filterable
`intakeCompanyName`	String	Submitted CompanyMax length: 500 · Filterable
`intakeEmail`	String	Submitted EmailMax length: 500 · Filterable
`intakeFirstName`	String	Submitted First NameMax length: 200 · Filterable
`intakeJobTitle`	String	Submitted Job TitleMax length: 200 · Filterable
`intakeLastName`	String	Submitted Last NameMax length: 200 · Filterable
`intakePhone`	String	Submitted PhoneMax length: 50 · Filterable
`name`	String	TitleMax length: 200 · Searchable · Filterable
`ownerId`	PolymorphicLookup	OwnerFilterable
`priority`	Option	PriorityOptions: CasePriority · Filterable
`queueId`	Lookup	Queue→ ServiceQueue · Filterable
`resolution`	Text	ResolutionMax length: 4000 · Filterable
`resolvedAt`	DateTime	Resolved OnFilterable
`status`	Option	StatusOptions: CaseStatus · Filterable
`workAreaId`	Lookup	Work Area→ WorkArea · Filterable
`workGroupId`	Lookup	Work Group→ WorkGroup · Filterable
`createdAt`system	DateTime	Created OnFilterable · Read-only via API
`createdBy`system	Lookup	Created By→ User · Filterable · Read-only via API
`formId`system	Lookup	Web Form→ LeadCaptureForm · Filterable
`id`system	Lookup	IDFilterable · Read-only via API
`ownerBusinessUnitId`system	Lookup	Owning Business Unit→ BusinessUnit · Filterable
`ownerType`system	String	Owner TypeFilterable
`rowVersion`system	Integer	Row VersionFilterable · Read-only via API
`tenantId`system	Lookup	TenantFilterable · Read-only via API
`updatedAt`system	DateTime	Modified OnFilterable · Read-only via API
`updatedBy`system	Lookup	Modified By→ User · Filterable · Read-only via API

Excluded from API: tenantId

API route: /api/v1/ServiceCase · Max page size: 100

ServiceCaseType

Case Type

ServiceC R U D

Field	Type	Details
`description`	Text	DescriptionMax length: 2000 · Filterable
`externalId`	String	External IDMax length: 200 · Filterable
`isActive`	Boolean	ActiveFilterable
`name`	String	NameMax length: 200 · Searchable · Filterable
`ownerId`	PolymorphicLookup	OwnerFilterable
`createdAt`system	DateTime	Created OnFilterable · Read-only via API
`createdBy`system	Lookup	Created By→ User · Filterable · Read-only via API
`id`system	Lookup	IDFilterable · Read-only via API
`ownerBusinessUnitId`system	Lookup	Owning Business Unit→ BusinessUnit · Filterable
`ownerType`system	String	Owner TypeFilterable
`rowVersion`system	Integer	Row VersionFilterable · Read-only via API
`tenantId`system	Lookup	TenantFilterable · Read-only via API
`updatedAt`system	DateTime	Modified OnFilterable · Read-only via API
`updatedBy`system	Lookup	Modified By→ User · Filterable · Read-only via API

Excluded from API: tenantId

API route: /api/v1/ServiceCaseType · Max page size: 100

ServiceQueue

Queue

ServiceC R U D

Field	Type	Details
`description`	Text	DescriptionMax length: 2000 · Filterable
`externalId`	String	External IDMax length: 200 · Filterable
`isActive`	Boolean	ActiveFilterable
`name`	String	NameMax length: 200 · Searchable · Filterable
`ownerId`	PolymorphicLookup	OwnerFilterable
`createdAt`system	DateTime	Created OnFilterable · Read-only via API
`createdBy`system	Lookup	Created By→ User · Filterable · Read-only via API
`id`system	Lookup	IDFilterable · Read-only via API
`ownerBusinessUnitId`system	Lookup	Owning Business Unit→ BusinessUnit · Filterable
`ownerType`system	String	Owner TypeFilterable
`rowVersion`system	Integer	Row VersionFilterable · Read-only via API
`tenantId`system	Lookup	TenantFilterable · Read-only via API
`updatedAt`system	DateTime	Modified OnFilterable · Read-only via API
`updatedBy`system	Lookup	Modified By→ User · Filterable · Read-only via API

Excluded from API: tenantId

API route: /api/v1/ServiceQueue · Max page size: 100

StockItem

Stock Item

FieldServiceC R U D

Field	Type	Details
`externalId`	String	External IDMax length: 200 · Filterable
`externalReference`	String	External ReferenceMax length: 200 · Searchable · Filterable
`productId`	Lookup	Product→ Product · Filterable
`reorderPoint`	Decimal	Reorder PointFilterable
`stockLocationId`	Lookup	Location→ StockLocation · Filterable
`createdAt`system	DateTime	Created OnFilterable · Read-only via API
`createdBy`system	Lookup	Created By→ User · Filterable · Read-only via API
`id`system	Lookup	IDFilterable · Read-only via API
`quantityOnHand`system	Decimal	On HandFilterable
`rowVersion`system	Integer	Row VersionFilterable · Read-only via API
`tenantId`system	Lookup	TenantFilterable · Read-only via API
`updatedAt`system	DateTime	Modified OnFilterable · Read-only via API
`updatedBy`system	Lookup	Modified By→ User · Filterable · Read-only via API

Excluded from API: tenantId

API route: /api/v1/StockItem · Max page size: 100

StockLocation

Stock Location

FieldServiceC R U D

Field	Type	Details
`equipmentId`	Lookup	Vehicle→ Equipment · Filterable
`externalId`	String	External IDMax length: 200 · Filterable
`externalReference`	String	External ReferenceMax length: 200 · Searchable · Filterable
`isActive`	Boolean	ActiveFilterable
`locationType`	Option	TypeOptions: StockLocationType · Filterable
`name`	String	NameMax length: 200 · Searchable · Filterable
`notes`	Text	NotesMax length: 4000 · Filterable
`ownerId`	PolymorphicLookup	OwnerFilterable
`responsibleUserId`	Lookup	Responsible→ User · Filterable
`createdAt`system	DateTime	Created OnFilterable · Read-only via API
`createdBy`system	Lookup	Created By→ User · Filterable · Read-only via API
`id`system	Lookup	IDFilterable · Read-only via API
`ownerBusinessUnitId`system	Lookup	Owning Business Unit→ BusinessUnit · Filterable
`ownerType`system	String	Owner TypeFilterable
`rowVersion`system	Integer	Row VersionFilterable · Read-only via API
`tenantId`system	Lookup	TenantFilterable · Read-only via API
`updatedAt`system	DateTime	Modified OnFilterable · Read-only via API
`updatedBy`system	Lookup	Modified By→ User · Filterable · Read-only via API

Excluded from API: tenantId

API route: /api/v1/StockLocation · Max page size: 100

StockMovement

Stock Movement

FieldServiceC R U D

Field	Type	Details
`counterpartyStockLocationId`	Lookup	Counterparty Location→ StockLocation · Filterable
`externalId`	String	External IDMax length: 200 · Filterable
`externalReference`	String	External ReferenceMax length: 200 · Searchable · Filterable
`movementDate`	DateTime	DateFilterable
`movementType`	Option	TypeOptions: StockMovementType · Filterable
`note`	Text	NoteMax length: 4000 · Filterable
`ownerId`	PolymorphicLookup	OwnerFilterable
`productId`	Lookup	Product→ Product · Filterable
`quantity`	Decimal	QuantityFilterable
`stockLocationId`	Lookup	Location→ StockLocation · Filterable
`workTaskId`	Lookup	Work Task→ WorkTask · Filterable
`createdAt`system	DateTime	Created OnFilterable · Read-only via API
`createdBy`system	Lookup	Created By→ User · Filterable · Read-only via API
`id`system	Lookup	IDFilterable · Read-only via API
`materialUsageId`system	Lookup	Material Usage→ MaterialUsage · Filterable
`ownerBusinessUnitId`system	Lookup	Owning Business Unit→ BusinessUnit · Filterable
`ownerType`system	String	Owner TypeFilterable
`rowVersion`system	Integer	Row VersionFilterable · Read-only via API
`tenantId`system	Lookup	TenantFilterable · Read-only via API
`updatedAt`system	DateTime	Modified OnFilterable · Read-only via API
`updatedBy`system	Lookup	Modified By→ User · Filterable · Read-only via API

Excluded from API: tenantId

API route: /api/v1/StockMovement · Max page size: 100

SubTask

Sub-Task

FieldServiceC R U D

Field	Type	Details
`completedAt`	DateTime	Completed AtFilterable
`description`	Text	NotesMax length: 4000 · Filterable
`externalId`	String	External IDMax length: 200 · Filterable
`lastResumedAt`	DateTime	Last Resumed AtFilterable
`name`	String	TitleMax length: 200 · Searchable · Filterable
`ownerId`	PolymorphicLookup	OwnerFilterable
`pausedAt`	DateTime	Paused AtFilterable
`sortOrder`	Integer	Sort OrderFilterable
`startedAt`	DateTime	Started AtFilterable
`status`	Option	StatusOptions: SubTaskStatus · Filterable
`totalPauseSeconds`	Duration	Pause TimeFilterable
`totalWorkSeconds`	Duration	Work TimeFilterable
`workTaskId`	Lookup	Work Task→ WorkTask · Filterable
`createdAt`system	DateTime	Created OnFilterable · Read-only via API
`createdBy`system	Lookup	Created By→ User · Filterable · Read-only via API
`id`system	Lookup	IDFilterable · Read-only via API
`ownerBusinessUnitId`system	Lookup	Owning Business Unit→ BusinessUnit · Filterable
`ownerType`system	String	Owner TypeFilterable
`rowVersion`system	Integer	Row VersionFilterable · Read-only via API
`tenantId`system	Lookup	TenantFilterable · Read-only via API
`updatedAt`system	DateTime	Modified OnFilterable · Read-only via API
`updatedBy`system	Lookup	Modified By→ User · Filterable · Read-only via API

Excluded from API: tenantId

API route: /api/v1/SubTask · Max page size: 100

Team

Settingsmanager+C R U D

Field	Type	Details
`description`	Text	DescriptionMax length: 2000 · Filterable
`externalId`	String	External IDMax length: 200 · Filterable
`name`	String	Team NameMax length: 200 · Searchable · Filterable
`ownerId`	Lookup	Responsible→ User · Filterable
`businessUnitId`system	Lookup	Business Unit→ BusinessUnit · Filterable
`createdAt`system	DateTime	Created OnFilterable · Read-only via API
`createdBy`system	Lookup	Created By→ User · Filterable · Read-only via API
`id`system	Lookup	IDFilterable · Read-only via API
`rowVersion`system	Integer	Row VersionFilterable · Read-only via API
`tenantId`system	Lookup	TenantFilterable · Read-only via API
`updatedAt`system	DateTime	Modified OnFilterable · Read-only via API
`updatedBy`system	Lookup	Modified By→ User · Filterable · Read-only via API

Excluded from API: tenantId

API route: /api/v1/Team · Max page size: 100

TenantApiKey

API Key

Settingsadmin+C R U D

Field	Type	Details
`allowedEntityTypes`	String	Allowed Entity TypesMax length: 1000 · Filterable
`expiresAt`	DateTime	Expires AtFilterable
`externalId`	String	External IDMax length: 200 · Filterable
`name`	String	NameMax length: 200 · Filterable
`role`	String	RoleMax length: 50 · Filterable
`status`	Option	StatusOptions: ApiKeyStatus · Filterable
`apiKey`system	String	API KeyFilterable
`createdAt`system	DateTime	Created OnFilterable · Read-only via API
`createdBy`system	Lookup	Created By→ User · Filterable · Read-only via API
`id`system	Lookup	IdRead-only via API
`keyHash`system	String	Key HashFilterable
`keyPrefix`system	String	Key PrefixFilterable
`lastUsedAt`system	DateTime	Last UsedFilterable
`rowVersion`system	Integer	Row VersionRead-only via API
`tenantId`system	Lookup	TenantRead-only via API
`updatedAt`system	DateTime	Updated AtRead-only via API
`updatedBy`system	Lookup	Updated ByRead-only via API
`usageCount`system	Integer	Usage CountFilterable

Excluded from API: tenantId, apiKey

API route: /api/v1/TenantApiKey · Max page size: 100

TimeEntry

Time Entry

FieldServiceProjectManagementC R U D

Field	Type	Details
`companyId`	Lookup	Company→ Company · Filterable
`contactId`	Lookup	Contact→ Contact · Filterable
`date`	DateTime	DateFilterable
`description`	Text	NotesMax length: 4000 · Filterable
`durationSeconds`	Duration	DurationFilterable
`endTime`	Time	End TimeFilterable
`entryType`	Option	TypeOptions: TimeEntryType · Filterable
`externalId`	String	External IDMax length: 200 · Filterable
`hourlyRate`	Currency	Hourly RateFilterable
`isBillable`	Boolean	BillableFilterable
`name`	String	DescriptionMax length: 200 · Searchable · Filterable
`ownerId`	Lookup	Owner→ User · Filterable
`payTypeId`	Lookup	Pay Type→ PayType · Filterable
`regardingId`	PolymorphicLookup	RegardingFilterable
`startTime`	Time	Start TimeFilterable
`createdAt`system	DateTime	Created OnFilterable · Read-only via API
`createdBy`system	Lookup	Created By→ User · Filterable · Read-only via API
`id`system	Lookup	IDFilterable · Read-only via API
`invoiceLineId`system	Lookup	Invoice Line→ InvoiceLine · Filterable
`isReconciled`system	Boolean	ReconciledFilterable
`ownerBusinessUnitId`system	Lookup	Owning Business Unit→ BusinessUnit · Filterable
`ownerType`system	String	Owner TypeFilterable
`reconciledAt`system	DateTime	Reconciled OnFilterable
`regardingType`system	String	Regarding TypeMax length: 100 · Filterable
`rowVersion`system	Integer	Row VersionFilterable · Read-only via API
`tenantId`system	Lookup	TenantFilterable · Read-only via API
`updatedAt`system	DateTime	Modified OnFilterable · Read-only via API
`updatedBy`system	Lookup	Modified By→ User · Filterable · Read-only via API

Excluded from API: tenantId

API route: /api/v1/TimeEntry · Max page size: 100

TimeReportValue

Time Report Value

HRC R U D

Field	Type	Details
`amountValue`	Currency	AmountFilterable
`boolValue`	Boolean	CheckedFilterable
`componentName`	String	ComponentMax length: 200 · Filterable
`externalId`	String	External IDMax length: 200 · Filterable
`hoursValue`	Decimal	HoursFilterable
`optionValue`	String	OptionMax length: 200 · Filterable
`textValue`	String	TextMax length: 2000 · Filterable
`timeSheetId`	Lookup	Time Sheet→ TimeSheet · Filterable
`unit`	String	UnitMax length: 20 · Filterable
`workDate`	Date	DateFilterable
`componentCode`system	String	Component CodeFilterable
`createdAt`system	DateTime	Created OnFilterable · Read-only via API
`createdBy`system	Lookup	Created By→ User · Filterable · Read-only via API
`granularity`system	Integer	GranularityFilterable
`id`system	Lookup	IDFilterable · Read-only via API
`inputType`system	Integer	Input TypeFilterable
`payTypeId`system	Lookup	Payroll Code→ PayType · Filterable
`rowVersion`system	Integer	Row VersionFilterable · Read-only via API
`sortOrder`system	Integer	Sort OrderFilterable
`source`system	Integer	SourceFilterable
`tenantId`system	Lookup	TenantFilterable · Read-only via API
`updatedAt`system	DateTime	Modified OnFilterable · Read-only via API
`updatedBy`system	Lookup	Modified By→ User · Filterable · Read-only via API

Excluded from API: tenantId

API route: /api/v1/TimeReportValue · Max page size: 100

TimeSheet

Time Sheet

HRC R U D

Field	Type	Details
`agreementVersionLabel`	String	VersionMax length: 50 · Filterable
`cadence`	Option	CadenceOptions: TimeSheetCadence · Filterable
`collectiveAgreementId`	Lookup	Agreement→ CollectiveAgreement · Filterable
`externalId`	String	External IDMax length: 200 · Filterable
`ownerId`	PolymorphicLookup	OwnerFilterable
`periodEnd`	Date	Period EndFilterable
`periodStart`	Date	Period StartFilterable
`status`	Option	StatusOptions: TimeSheetStatus · Filterable
`userId`	Lookup	Employee→ User · Filterable
`agreementVersionId`system	Lookup	Agreement VersionFilterable
`createdAt`system	DateTime	Created OnFilterable · Read-only via API
`createdBy`system	Lookup	Created By→ User · Filterable · Read-only via API
`id`system	Lookup	IDFilterable · Read-only via API
`ownerBusinessUnitId`system	Lookup	Owning Business Unit→ BusinessUnit · Filterable
`ownerType`system	String	Owner TypeFilterable
`rowVersion`system	Integer	Row VersionFilterable · Read-only via API
`submittedAt`system	DateTime	Submitted OnFilterable
`tenantId`system	Lookup	TenantFilterable · Read-only via API
`updatedAt`system	DateTime	Modified OnFilterable · Read-only via API
`updatedBy`system	Lookup	Modified By→ User · Filterable · Read-only via API

Excluded from API: tenantId

API route: /api/v1/TimeSheet · Max page size: 100

TrackingEvent

Tracking Event

SalesC R U D

Field	Type	Details
`eventType`	Option	Event TypeOptions: TrackingEventType · Filterable
`externalId`	String	External IDMax length: 200 · Filterable
`name`	String	SummaryMax length: 500 · Searchable · Filterable
`occurredAt`	DateTime	Occurred AtFilterable
`properties`	Text	PropertiesMax length: 8000 · Filterable
`regardingId`	PolymorphicLookup	RegardingFilterable
`source`	String	SourceMax length: 100 · Searchable · Filterable
`url`	String	URLMax length: 2000 · Filterable
`createdAt`system	DateTime	Created OnFilterable · Read-only via API
`createdBy`system	Lookup	Created By→ User · Filterable · Read-only via API
`id`system	Lookup	IDFilterable · Read-only via API
`regardingType`system	String	Regarding TypeMax length: 100 · Filterable
`rowVersion`system	Integer	Row VersionFilterable · Read-only via API
`tenantId`system	Lookup	TenantFilterable · Read-only via API
`updatedAt`system	DateTime	Modified OnFilterable · Read-only via API
`updatedBy`system	Lookup	Modified By→ User · Filterable · Read-only via API

Excluded from API: tenantId

API route: /api/v1/TrackingEvent · Max page size: 100

User

ProjectManagementmanager+C R U D

Field	Type	Details
`address`	String	AddressMax length: 500 · Filterable
`billingRate`	Decimal	Billing Rate (Sell)Filterable
`city`	String	CityMax length: 200 · Filterable
`displayName`	String	Display NameMax length: 200 · Searchable · Filterable
`employeeNumber`	String	Employee NumberMax length: 50 · Searchable · Filterable
`hireDate`	DateTime	Hire DateFilterable
`hourlyRateNormal`	Decimal	Hourly Rate (Normal)Filterable
`hourlyRateOvertime`	Decimal	Hourly Rate (Overtime)Filterable
`isActive`	Boolean	ActiveFilterable
`jobTitle`	String	Job TitleMax length: 200 · Searchable · Filterable
`mobilePhone`	String	Mobile PhoneMax length: 50 · Filterable
`payrollCodeNormal`	String	Payroll Code (Normal)Max length: 20 · Filterable
`payrollCodeOvertime`	String	Payroll Code (Overtime)Max length: 20 · Filterable
`phone`	String	PhoneMax length: 50 · Filterable
`postalCode`	String	Postal CodeMax length: 20 · Filterable
`resourceSortIndex`	Integer	Sort OrderFilterable
`resourceTypeId`	Lookup	Resource Type→ ResourceType · Filterable
`userType`	Option	LicenseOptions: UserType · Filterable
`weeklyHours`	Decimal	Weekly HoursFilterable
`apprenticeshipEndDate`system	DateTime	Apprenticeship End Date
`businessUnitId`system	Lookup	Business Unit
`createdAt`system	DateTime	Created OnFilterable · Read-only via API
`createdBy`system	Lookup	Created By→ User · Filterable · Read-only via API
`dateOfBirth`system	DateTime	Date Of Birth
`email`system	String	EmailMax length: 320 · Searchable · Filterable
`externalId`system	String	External
`id`system	Lookup	IDFilterable · Read-only via API
`ownerBusinessUnitId`system	Lookup	Business Unit→ BusinessUnit · Filterable
`ownerId`system	PolymorphicLookup	OwnerFilterable
`ownerType`system	String	Owner TypeFilterable
`rowVersion`system	Integer	Row VersionFilterable · Read-only via API
`tenantId`system	Lookup	TenantFilterable · Read-only via API
`terminationDate`system	DateTime	Termination Date
`updatedAt`system	DateTime	Modified OnFilterable · Read-only via API
`updatedBy`system	Lookup	Modified By→ User · Filterable · Read-only via API

Excluded from API: tenantId

API route: /api/v1/User · Max page size: 100

WorkArea

Work Area

C R U D

Field	Type	Details
`description`	Text	DescriptionMax length: 2000 · Filterable
`externalId`	String	External IDMax length: 200 · Filterable
`name`	String	NameMax length: 200 · Searchable · Filterable
`ownerId`	PolymorphicLookup	OwnerFilterable
`projectId`	Lookup	Project→ Project · Filterable
`sortOrder`	Integer	Sort OrderFilterable
`createdAt`system	DateTime	Created OnFilterable · Read-only via API
`createdBy`system	Lookup	Created By→ User · Filterable · Read-only via API
`id`system	Lookup	IDFilterable · Read-only via API
`ownerBusinessUnitId`system	Lookup	Business Unit→ BusinessUnit · Filterable
`ownerType`system	String	Owner TypeFilterable
`rowVersion`system	Integer	Row VersionFilterable · Read-only via API
`tenantId`system	Lookup	TenantFilterable · Read-only via API
`updatedAt`system	DateTime	Modified OnFilterable · Read-only via API
`updatedBy`system	Lookup	Modified By→ User · Filterable · Read-only via API

Excluded from API: tenantId

API route: /api/v1/WorkArea · Max page size: 100

Workflow

Settingsadmin+C R U D

Field	Type	Details
`changedFields`	String	Changed fields (Update only)Max length: 1000 · Filterable
`conditionLogic`	Integer	Condition logicFilterable
`description`	Text	DescriptionMax length: 1000 · Filterable
`entityType`	String	EntityMax length: 100 · Filterable
`externalId`	String	External IDMax length: 200 · Filterable
`isActive`	Boolean	ActiveFilterable
`name`	String	NameMax length: 200 · Searchable · Filterable
`ownerId`	PolymorphicLookup	OwnerFilterable
`reactToWorkflowChanges`	Boolean	React to workflow-made changesFilterable
`scheduleDateField`	String	Schedule date fieldMax length: 100 · Filterable
`scheduleOffsetDays`	Integer	Offset (days)Filterable
`triggerType`	Integer	TriggerFilterable
`consecutiveFailures`system	Integer	Consecutive failuresFilterable
`createdAt`system	DateTime	Created OnFilterable · Read-only via API
`createdBy`system	Lookup	Created By→ User · Filterable · Read-only via API
`disabledReason`system	String	Disabled reasonMax length: 500 · Filterable
`id`system	Lookup	IDFilterable · Read-only via API
`lastRunAt`system	DateTime	Last runFilterable
`ownerBusinessUnitId`system	Lookup	Owning Business Unit→ BusinessUnit · Filterable
`ownerType`system	String	Owner TypeFilterable
`rowVersion`system	Integer	Row VersionFilterable · Read-only via API
`tenantId`system	Lookup	TenantFilterable · Read-only via API
`updatedAt`system	DateTime	Modified OnFilterable · Read-only via API
`updatedBy`system	Lookup	Modified By→ User · Filterable · Read-only via API

Excluded from API: tenantId

API route: /api/v1/Workflow · Max page size: 100

WorkflowAction

Action

Settingsadmin+C R U D

Field	Type	Details
`actionType`	Integer	ActionFilterable
`config`	Text	Config (JSON)Filterable
`description`	String	DescriptionMax length: 500 · Filterable
`externalId`	String	External IDMax length: 200 · Filterable
`sortOrder`	Integer	OrderFilterable
`workflowId`	Lookup	Workflow→ Workflow · Filterable
`createdAt`system	DateTime	Created OnFilterable · Read-only via API
`createdBy`system	Lookup	Created By→ User · Filterable · Read-only via API
`id`system	Lookup	IDFilterable · Read-only via API
`rowVersion`system	Integer	Row VersionFilterable · Read-only via API
`tenantId`system	Lookup	TenantFilterable · Read-only via API
`updatedAt`system	DateTime	Modified OnFilterable · Read-only via API
`updatedBy`system	Lookup	Modified By→ User · Filterable · Read-only via API

Excluded from API: tenantId

API route: /api/v1/WorkflowAction · Max page size: 100

WorkflowCondition

Condition

Settingsadmin+C R U D

Field	Type	Details
`externalId`	String	External IDMax length: 200 · Filterable
`fieldName`	String	FieldMax length: 100 · Filterable
`groupNo`	Integer	GroupFilterable
`operator`	Integer	OperatorFilterable
`sortOrder`	Integer	OrderFilterable
`value`	String	ValueMax length: 2000 · Filterable
`workflowId`	Lookup	Workflow→ Workflow · Filterable
`createdAt`system	DateTime	Created OnFilterable · Read-only via API
`createdBy`system	Lookup	Created By→ User · Filterable · Read-only via API
`id`system	Lookup	IDFilterable · Read-only via API
`rowVersion`system	Integer	Row VersionFilterable · Read-only via API
`tenantId`system	Lookup	TenantFilterable · Read-only via API
`updatedAt`system	DateTime	Modified OnFilterable · Read-only via API
`updatedBy`system	Lookup	Modified By→ User · Filterable · Read-only via API

Excluded from API: tenantId

API route: /api/v1/WorkflowCondition · Max page size: 100

WorkflowRun

Workflow Run

Settingsadmin+C R U D

Field	Type	Details
`externalId`	String	External IDMax length: 200 · Filterable
`actionsExecuted`system	Integer	Actions executedFilterable
`completedAt`system	DateTime	CompletedFilterable
`createdAt`system	DateTime	Created OnFilterable · Read-only via API
`createdBy`system	Lookup	Created By→ User · Filterable · Read-only via API
`depth`system	Integer	DepthFilterable
`durationMs`system	Integer	Duration (ms)Filterable
`error`system	Text	ErrorFilterable
`id`system	Lookup	IDFilterable · Read-only via API
`rowVersion`system	Integer	Row VersionFilterable · Read-only via API
`startedAt`system	DateTime	StartedFilterable
`status`system	Integer	StatusFilterable
`tenantId`system	Lookup	TenantFilterable · Read-only via API
`triggerEntityType`system	String	EntityMax length: 100 · Filterable
`triggerRecordId`system	Lookup	RecordFilterable
`triggerSource`system	Integer	SourceFilterable
`updatedAt`system	DateTime	Modified OnFilterable · Read-only via API
`updatedBy`system	Lookup	Modified By→ User · Filterable · Read-only via API
`workflowId`system	Lookup	Workflow→ Workflow · Filterable
`workflowName`system	String	WorkflowMax length: 200 · Filterable

Excluded from API: tenantId

API route: /api/v1/WorkflowRun · Max page size: 100

WorkGroup

Work Group

C R U D

Field	Type	Details
`description`	Text	DescriptionMax length: 2000 · Filterable
`externalId`	String	External IDMax length: 200 · Filterable
`name`	String	NameMax length: 200 · Searchable · Filterable
`ownerId`	PolymorphicLookup	OwnerFilterable
`projectId`	Lookup	Project→ Project · Filterable
`sortOrder`	Integer	Sort OrderFilterable
`workAreaId`	Lookup	Work Area→ WorkArea · Filterable
`createdAt`system	DateTime	Created OnFilterable · Read-only via API
`createdBy`system	Lookup	Created By→ User · Filterable · Read-only via API
`id`system	Lookup	IDFilterable · Read-only via API
`ownerBusinessUnitId`system	Lookup	Business Unit→ BusinessUnit · Filterable
`ownerType`system	String	Owner TypeFilterable
`rowVersion`system	Integer	Row VersionFilterable · Read-only via API
`tenantId`system	Lookup	TenantFilterable · Read-only via API
`updatedAt`system	DateTime	Modified OnFilterable · Read-only via API
`updatedBy`system	Lookup	Modified By→ User · Filterable · Read-only via API

Excluded from API: tenantId

API route: /api/v1/WorkGroup · Max page size: 100

WorkTask

Work Task

FieldServiceProjectManagementC R U D

Field	Type	Details
`address`	String	AddressMax length: 300 · Searchable · Filterable
`areaNumber`	Integer	Area NumberFilterable
`assetId`	Lookup	Asset→ Asset · Filterable
`assignedToId`	Lookup	Primary Resource→ User · Filterable
`budgetTemplateId`	Lookup	Budget Template→ BudgetTemplate · Filterable
`caseNumber`	String	Case NumberMax length: 50 · Searchable · Filterable
`city`	String	CityMax length: 100 · Searchable · Filterable
`companyId`	Lookup	Company→ Company · Filterable
`contactId`	Lookup	Contact→ Contact · Filterable
`description`	Text	DescriptionMax length: 4000 · Filterable
`duration`	Duration	DurationFilterable
`externalId`	String	External IDMax length: 200 · Filterable
`hideInPlanner`	Boolean	Hide in plannerFilterable
`isAttention`	Boolean	AttentionFilterable
`isLocked`	Boolean	LockedFilterable
`isSystemUpdate`	Boolean	System UpdateFilterable
`locationId`	Lookup	Location→ Location · Filterable
`name`	String	TitleMax length: 200 · Searchable · Filterable
`onLocation`	Boolean	On LocationFilterable
`ownerId`	PolymorphicLookup	OwnerFilterable
`postalCode`	String	Postal CodeMax length: 20 · Searchable · Filterable
`predecessorId`	Lookup	Predecessor→ WorkTask · Filterable
`priority`	Option	PriorityOptions: WorkTaskPriority · Filterable
`regardingId`	PolymorphicLookup	RegardingFilterable
`scheduledEnd`	DateTime	Scheduled EndFilterable
`scheduledStart`	DateTime	Scheduled StartFilterable
`sequenceNumber`	Integer	Sequence NumberFilterable
`status`	Option	StatusOptions: WorkTaskStatus · Filterable
`syncResourceBookings`	Boolean	Sync Resource BookingsFilterable
`transactionCurrencyId`	Lookup	Currency→ Currency · Filterable
`visitCoverage`	Option	Billing CoverageOptions: VisitCoverage · Filterable
`workAreaId`	Lookup	Work Area→ WorkArea · Filterable
`workGroupId`	Lookup	Work Group→ WorkGroup · Filterable
`createdAt`system	DateTime	Created OnFilterable · Read-only via API
`createdBy`system	Lookup	Created By→ User · Filterable · Read-only via API
`id`system	Lookup	IDFilterable · Read-only via API
`netAmount`system	Currency	Net AmountFilterable
`ownerBusinessUnitId`system	Lookup	Owning Business Unit→ BusinessUnit · Filterable
`ownerType`system	String	Owner TypeFilterable
`primaryResourceBookingId`system	Lookup	Primary Resource Booking→ ResourceBooking · Filterable
`regardingType`system	String	Regarding TypeMax length: 100 · Filterable
`rowVersion`system	Integer	Row VersionFilterable · Read-only via API
`serviceAgreementLineId`system	Lookup	Service Agreement Line
`tenantId`system	Lookup	TenantFilterable · Read-only via API
`totalExpenses`system	Currency	Total ExpensesFilterable
`totalRevenue`system	Currency	Total RevenueFilterable
`updatedAt`system	DateTime	Modified OnFilterable · Read-only via API
`updatedBy`system	Lookup	Modified By→ User · Filterable · Read-only via API

Excluded from API: tenantId

API route: /api/v1/WorkTask · Max page size: 2000

AccountTypeCategory

AccountType.category

Value	Name	Label (en)	Active
`1`	`Revenue`	Revenue
`2`	`Expense`	Expense

ActionItemType

ActionItem.actionType

Value	Name	Label (en)
`0`	`Task`	Task
`1`	`Meeting`	Meeting
`2`	`Email`	Email
`3`	`Opportunity`	Opportunity

ActivityPriority

Activity.priority

Value	Name	Label (en)
`1`	`Low`	Low
`2`	`Normal`	Normal
`3`	`High`	High

ActivityStatus

Activity.status

Value	Name	Label (en)
`1`	`Planned`	Planned
`2`	`Completed`	Completed
`3`	`Received`	Received
`4`	`Draft`	Draft
`5`	`Sent`	Sent

ActivityType

Activity.type

Value	Name	Label (en)
`1`	`Task`	Task
`2`	`Call`	Phone Call
`3`	`Meeting`	Meeting
`4`	`Email`	Email
`5`	`Note`	Note

AgreementLocalComponentGranularity

AgreementLocalComponent.granularity

Value	Name	Label (en)	Active
`1`	`Week`	Per week
`2`	`Day`	Per day

AgreementLocalComponentInputType

AgreementLocalComponent.inputType

Value	Name	Label (en)
`1`	`Hours`	Hours
`2`	`Amount`	Amount
`3`	`Checkbox`	Checkbox
`4`	`Text`	Free text
`5`	`Option`	Option list

AgreementTemplateComponentGranularity

AgreementTemplateComponent.granularity

Value	Name	Label (en)	Active
`1`	`Week`	Per week
`2`	`Day`	Per day

AgreementTemplateComponentInputType

AgreementTemplateComponent.inputType

Value	Name	Label (en)
`1`	`Hours`	Hours
`2`	`Amount`	Amount
`3`	`Checkbox`	Checkbox
`4`	`Text`	Free text
`5`	`Option`	Option list

AgreementTemplateVersionCadence

AgreementTemplateVersion.cadence

Value	Name	Label (en)	Active
`1`	`Week`	Per week
`2`	`Day`	Per day

AllocationPeriodType

Project.periodType

Value	Name	Label (en)	Active
`1`	`Week`	Week
`2`	`Month`	Month

ApiKeyStatus

TenantApiKey.status

Value	Name	Label (en)	Active
`1`	`Active`	Active
`2`	`Revoked`	Revoked

ApplicationStage

JobApplication.stage

Value	Name	Label (en)
`1`	`New`	New
`2`	`Screening`	Screening
`3`	`Interview`	Interview
`4`	`Offer`	Offer
`5`	`Hired`	Hired
`6`	`Rejected`	Rejected
`7`	`Withdrawn`	Withdrawn

ArticleCategory

KnowledgeArticle.category

Value	Name	Label (en)
`1`	`General`	General
`2`	`FAQ`	FAQ
`3`	`Troubleshooting`	Troubleshooting
`4`	`HowTo`	How-To
`5`	`Policy`	Policy

ArticleStatus

KnowledgeArticle.status

Value	Name	Label (en)
`1`	`Draft`	Draft
`2`	`Published`	Published
`3`	`Archived`	Archived

AssetStatus

Asset.status

Value	Name	Label (en)	Active
`1`	`Active`	Active
`2`	`Retired`	Retired

AssetType

Asset.assetType

Value	Name	Label (en)
`1`	`Equipment`	Equipment
`2`	`Installation`	Installation
`3`	`Vehicle`	Vehicle
`4`	`Software`	Software
`5`	`Other`	Other

BillingPeriod

ServiceAgreementBillingLine.billingPeriod

Value	Name	Label (en)
`1`	`Monthly`	Monthly
`2`	`Quarterly`	Quarterly
`3`	`Yearly`	Yearly

BookingStatus

ResourceBooking.status

Value	Name	Label (en)
`1`	`Planned`	Planned
`2`	`Confirmed`	Confirmed
`3`	`Cancelled`	Cancelled

BookingType

ResourceBooking.bookingType

Value	Name	Label (en)
`1`	`Work`	Work
`2`	`Vacation`	Vacation
`3`	`Sick`	Sick
`4`	`School`	School
`5`	`Parental`	Parental Leave
`6`	`Compensation`	Compensation
`7`	`Other`	Other

BudgetLineType

Budget.lineType

Value	Name	Label (en)	Active
`1`	`Record`	Record
`2`	`Template`	Template

BulkEmailStatus

BulkEmail.status

Value	Name	Label (en)
`1`	`Draft`	Draft
`2`	`Scheduled`	Scheduled
`3`	`Sending`	Sending
`4`	`Sent`	Sent
`5`	`Failed`	Failed

CalculatedFieldFormat

CalculatedField.format

Value	Name	Label (en)
`0`	`Number`	Number
`1`	`Currency`	Currency
`2`	`Percentage`	Percentage

CandidateRating

JobApplication.rating

Value	Name	Label (en)
`1`	`NotRated`	Not rated
`2`	`TopCandidate`	Top candidate
`3`	`Suitable`	Suitable
`4`	`Maybe`	Maybe
`5`	`NotSuitable`	Not suitable
`6`	`Rejected`	Rejected

CandidateSource

Candidate.source

Value	Name	Label (en)
`1`	`Direct`	Direct
`2`	`Referral`	Referral
`3`	`Agency`	Agency
`4`	`JobBoard`	Job board
`5`	`LinkedIn`	LinkedIn
`6`	`Other`	Other

CaptureTarget

LeadCaptureForm.captureTarget

Value	Name	Label (en)	Active
`1`	`Lead`	Lead
`2`	`ServiceCase`	Service Case

CasePriority

ServiceCase.priority

Value	Name	Label (en)
`1`	`Low`	Low
`2`	`Normal`	Normal
`3`	`High`	High
`4`	`Critical`	Critical

CaseStatus

ServiceCase.status

Value	Name	Label (en)
`1`	`New`	New
`2`	`InProgress`	In Progress
`3`	`WaitingOnCustomer`	Waiting on Customer
`4`	`WaitingOnThirdParty`	Waiting on Third Party
`5`	`Resolved`	Resolved
`6`	`Cancelled`	Cancelled

CompanyType

Company.companyType

Value	Name	Label (en)
`2`	`Prospect`	Prospect
`3`	`Customer`	Customer
`4`	`ExCustomer`	Ex-Customer
`5`	`Partner`	Partner
`6`	`Supplier`	Supplier
`7`	`Vendor`	Vendor
`8`	`Other`	Other

ConditionField

CaseRoutingCondition.field

Value	Name	Label (en)
`1`	`Priority`	Priority
`2`	`CaseType`	Case Type
`3`	`Company`	Company

ContactStatus

Contact.status

Value	Name	Label (en)	Active
`1`	`Active`	Active
`2`	`Inactive`	Inactive

ContractStatus

Contract.status

Value	Name	Label (en)
`1`	`Draft`	Draft
`2`	`Ready`	Ready
`3`	`SentForSignature`	Sent for Signature
`4`	`Signed`	Signed
`5`	`Expired`	Expired
`6`	`Cancelled`	Cancelled

DiscountType

ServiceAgreementBillingLine.discountType

Value	Name	Label (en)	Active
`1`	`Amount`	Amount
`2`	`Percentage`	Percentage

DocumentType

GeneratedDocument.documentType

Value	Name	Label (en)	Active
`1`	`Generated`	Generated
`2`	`Uploaded`	Uploaded

EmploymentType

JobPosting.employmentType

Value	Name	Label (en)
`1`	`FullTime`	Full-time
`2`	`PartTime`	Part-time
`3`	`Temporary`	Temporary
`4`	`Contract`	Contract
`5`	`Internship`	Internship

EquipmentStatus

Equipment.status

Value	Name	Label (en)
`1`	`Active`	Active
`2`	`OutOfService`	Out of service
`3`	`InMaintenance`	In maintenance
`4`	`Retired`	Retired

EquipmentType

Equipment.equipmentType

Value	Name	Label (en)
`1`	`Vehicle`	Vehicle
`2`	`Tool`	Tool
`3`	`Machine`	Machine
`4`	`Other`	Other

ExpenseCategory

Expense.category

Value	Name	Label (en)
`1`	`Materials`	Materials
`2`	`Travel`	Travel
`3`	`Subcontractor`	Subcontractor
`4`	`Equipment`	Equipment
`5`	`Other`	Other

ExpenseStatus

Expense.status

Value	Name	Label (en)
`1`	`Active`	Active
`2`	`Archived`	Archived
`3`	`Cancelled`	Cancelled

GoalMetric

Goal.metric

Value	Name	Label (en)
`1`	`Revenue`	Revenue
`2`	`OpportunityWonValue`	Opportunity Won Value
`3`	`Meetings`	Meetings
`4`	`OpportunitiesCreated`	Opportunities Created
`5`	`OpportunitiesWon`	Opportunities Won
`6`	`LeadsCreated`	Leads Created

GoalPeriodType

Goal.periodType

Value	Name	Label (en)
`0`	`Year`	Year
`1`	`FiscalYear`	Fiscal Year
`2`	`Month`	Month
`3`	`Quarter`	Quarter
`4`	`FiscalQuarter`	Fiscal Quarter

InboundWebhookStatus

InboundWebhookEvent.status

Value	Name	Label (en)
`1`	`Received`	Received
`2`	`Processed`	Processed
`3`	`Failed`	Failed

Industry

Global

Value	Name	Label (en)
`1`	`Technology`	Technology
`2`	`Finance`	Finance
`3`	`Healthcare`	Healthcare
`4`	`Manufacturing`	Manufacturing
`5`	`Retail`	Retail
`6`	`Services`	Services
`7`	`Construction`	Construction
`8`	`Transportation`	Transportation
`9`	`Education`	Education
`10`	`Government`	Government
`99`	`Other`	Other

InspectionResult

InspectionLine.passFailResult

Value	Name	Label (en)
`1`	`Pass`	Pass
`2`	`Fail`	Fail
`3`	`NotApplicable`	Not applicable

InspectionResultType

InspectionTemplateLine.resultType

Value	Name	Label (en)
`1`	`PassFail`	Pass / fail
`2`	`Checkbox`	Checkbox
`3`	`Number`	Number
`4`	`Text`	Text

InspectionResultTypeLine

InspectionLine.resultType

Value	Name	Label (en)
`1`	`PassFail`	Pass / fail
`2`	`Checkbox`	Checkbox
`3`	`Number`	Number
`4`	`Text`	Text

InspectionStatus

Inspection.status

Value	Name	Label (en)
`1`	`NotStarted`	Not started
`2`	`InProgress`	In progress
`3`	`Completed`	Completed

IntakeCompanyAction

Lead.companyAction

Value	Name	Label (en)
`1`	`UseExisting`	Use Existing
`2`	`CreateNew`	Create New
`3`	`DoNotCreate`	Do Not Create

IntakeContactAction

Lead.contactAction

Value	Name	Label (en)
`1`	`UseExisting`	Use Existing
`2`	`CreateNew`	Create New
`3`	`DoNotCreate`	Do Not Create

IntakeOpportunityAction

Lead.opportunityAction

Value	Name	Label (en)	Active
`1`	`CreateNew`	Create New
`2`	`DoNotCreate`	Do Not Create

InvoiceStage

Invoice.stage

Value	Name	Label (en)
`1`	`Draft`	Draft
`2`	`Active`	Active
`3`	`Paid`	Paid
`4`	`Cancelled`	Cancelled

JobPostingStatus

JobPosting.status

Value	Name	Label (en)
`1`	`Draft`	Draft
`2`	`Open`	Open
`3`	`OnHold`	On hold
`4`	`Filled`	Filled
`5`	`Closed`	Closed
`6`	`Cancelled`	Cancelled

LeadBudget

Lead.budget

Value	Name	Label (en)
`1`	`None`	No Committed Budget
`2`	`MayBuy`	May Buy
`3`	`CanBuy`	Can Buy
`4`	`WillBuy`	Will Buy

LeadCaptureFormStatus

LeadCaptureForm.status

Value	Name	Label (en)	Active
`1`	`Active`	Active
`2`	`Inactive`	Inactive

LeadFormType

Lead.formType

Value	Name	Label (en)
`1`	`Contact`	Contact
`2`	`Support`	Support
`3`	`Enquiry`	Enquiry

LeadNeed

Lead.need

Value	Name	Label (en)
`1`	`MustHave`	Must Have
`2`	`ShouldHave`	Should Have
`3`	`GoodToHave`	Good to Have
`4`	`NoNeed`	No Need

LeadPriority

Lead.priority

Value	Name	Label (en)
`1`	`Low`	Low
`2`	`Medium`	Medium
`3`	`High`	High
`4`	`Critical`	Critical

LeadRating

Lead.rating

Value	Name	Label (en)
`1`	`Hot`	Hot
`2`	`Warm`	Warm
`3`	`Cold`	Cold
`4`	`Untapped`	Untapped

LeadSource

Global

Value	Name	Label (en)
`1`	`Website`	Website
`2`	`Referral`	Referral
`3`	`TradeShow`	Trade Show
`4`	`ColdCall`	Cold Call
`5`	`Advertisement`	Advertisement
`6`	`SocialMedia`	Social Media
`7`	`Partner`	Partner
`8`	`Marketing`	Marketing
`9`	`Networking`	Networking
`10`	`Telemarketing`	Telemarketing
`11`	`Canvassing`	Canvassing
`12`	`WordOfMouth`	Word of Mouth
`13`	`EmployeeReferral`	Employee Referral
`99`	`Other`	Other

LeadStatus

Lead.status

Value	Name	Label (en)
`1`	`Active`	Active
`2`	`Qualified`	Qualified
`3`	`Disqualified`	Disqualified

LostReason

Opportunity.lostReason

Value	Name	Label (en)
`1`	`Price`	Price
`2`	`Competitor`	Competitor
`3`	`NoDecision`	No Decision
`4`	`Timing`	Timing
`5`	`Requirements`	Requirements Not Met
`99`	`Other`	Other

NumberOfEmployees

Global

Value	Name	Label (en)
`1`	`OneToTen`	1-10
`2`	`ElevenToFifty`	11-50
`3`	`FiftyOneToTwoHundred`	51-200
`4`	`TwoHundredOneToFiveHundred`	201-500
`5`	`FiveHundredOneToThousand`	501-1000
`6`	`OverThousand`	1000+

OpportunityStage

Opportunity.stage

Value	Name	Label (en)
`1`	`Qualification`	Qualification
`2`	`Proposal`	Proposal
`3`	`Negotiation`	Negotiation
`100`	`Won`	Won
`200`	`Lost`	Lost

OpportunityType

Opportunity.type

Value	Name	Label (en)
`1`	`NewBusiness`	New Business
`2`	`ExistingCustomer`	Existing Customer
`3`	`Renewal`	Renewal
`4`	`Upsell`	Upsell

ParticipationTypeMask

ActivityParticipant.participationTypeMask

Value	Name	Label (en)
`1`	`From`	From
`2`	`To`	To
`3`	`CC`	CC
`4`	`BCC`	BCC
`5`	`Required`	Required
`6`	`Optional`	Optional
`7`	`Organizer`	Organizer

PreferredContactMethod

Global

Value	Name	Label (en)
`1`	`Email`	Email
`2`	`Phone`	Phone
`3`	`Mail`	Mail
`4`	`Any`	Any

ProjectActivityPriority

ProjectActivity.priority

Value	Name	Label (en)
`1`	`Low`	Low
`2`	`Normal`	Normal
`3`	`High`	High
`4`	`Critical`	Critical

ProjectActivityStatus

ProjectActivity.status

Value	Name	Label (en)
`1`	`Planning`	Planning
`2`	`Active`	Active
`3`	`OnHold`	On Hold
`4`	`Completed`	Completed
`5`	`Cancelled`	Cancelled

ProjectPriority

Project.priority

Value	Name	Label (en)
`1`	`Low`	Low
`2`	`Normal`	Normal
`3`	`High`	High
`4`	`Critical`	Critical

ProjectStatus

Project.status

Value	Name	Label (en)
`1`	`Planning`	Planning
`2`	`Active`	Active
`3`	`OnHold`	On Hold
`4`	`Completed`	Completed
`5`	`Cancelled`	Cancelled

PublicCompanyIdentifierType

Company.publicCompanyIdentifierType

Value	Name	Label (en)
`1`	`CVR`	CVR
`2`	`Orgnr_SE`	Org.nr. (SE)
`3`	`Orgnr_NO`	Org.nr. (NO)
`4`	`Y_tunnus`	Y-tunnus (FI)
`5`	`KVK`	KVK (NL)
`6`	`HRB`	HRB (DE)
`7`	`CompanyNumber`	Company No. (UK)
`8`	`SIREN`	SIREN (FR)
`9`	`NIP`	NIP (PL)
`10`	`Partita_IVA`	Partita IVA (IT)
`11`	`CIF`	CIF (ES)
`99`	`Other`	Company ID

PurchaseProcess

Lead.purchaseProcess

Value	Name	Label (en)
`1`	`Individual`	Individual
`2`	`Committee`	Committee
`3`	`Unknown`	Unknown

PurchaseTimeframe

Lead.purchaseTimeframe

Value	Name	Label (en)
`1`	`Immediate`	Immediate
`2`	`ThisQuarter`	This Quarter
`3`	`NextQuarter`	Next Quarter
`4`	`ThisYear`	This Year
`5`	`Unknown`	Unknown

QuoteStage

Quote.stage

Value	Name	Label (en)
`1`	`Draft`	Draft
`2`	`Sent`	Sent
`3`	`Accepted`	Accepted
`4`	`Rejected`	Rejected

RecipientListMemberStatus

RecipientListMember.status

Value	Name	Label (en)
`1`	`Active`	Active
`2`	`Unsubscribed`	Unsubscribed
`3`	`Bounced`	Bounced

RecipientListStatus

RecipientList.status

Value	Name	Label (en)	Active
`1`	`Active`	Active
`2`	`Inactive`	Inactive

RecurrenceEndMode

ServiceAgreementLine.endMode

Value	Name	Label (en)
`1`	`Never`	No end date
`2`	`AfterOccurrences`	End after N occurrences
`3`	`OnDate`	End by date

RecurrenceFrequency

ServiceAgreementLine.frequency

Value	Name	Label (en)
`1`	`Daily`	Daily
`2`	`Weekly`	Weekly
`3`	`Monthly`	Monthly
`4`	`Yearly`	Yearly

RecurrenceMonthlyMode

ServiceAgreementLine.monthlyMode

Value	Name	Label (en)	Active
`1`	`DayOfMonth`	On day of month
`2`	`DayOfWeek`	On the …

RecurrenceOrdinal

ServiceAgreementLine.ordinal

Value	Name	Label (en)
`1`	`First`	First
`2`	`Second`	Second
`3`	`Third`	Third
`4`	`Fourth`	Fourth
`5`	`Last`	Last

RevenueStatus

Revenue.status

Value	Name	Label (en)
`1`	`Active`	Active
`2`	`Archived`	Archived
`3`	`Cancelled`	Cancelled

RevenueType

Quote.revenueType

Value	Name	Label (en)	Active
`1`	`Entered`	Entered
`2`	`Calculated`	Calculated

ServiceAgreementChargeType

ServiceAgreementBillingLine.chargeType

Value	Name	Label (en)
`1`	`Recurring`	Recurring
`2`	`PerVisit`	Per visit
`3`	`OneTime`	One-time

ServiceAgreementStatus

ServiceAgreement.status

Value	Name	Label (en)
`1`	`Draft`	Draft
`2`	`Active`	Active
`3`	`Paused`	Paused
`4`	`Expired`	Expired
`5`	`Cancelled`	Cancelled

SignerStatus

ContractSigner.status

Value	Name	Label (en)
`1`	`Pending`	Pending
`2`	`Sent`	Sent
`3`	`Opened`	Opened
`4`	`Signed`	Signed
`5`	`Rejected`	Rejected

StockLocationType

StockLocation.locationType

Value	Name	Label (en)
`1`	`Main`	Main warehouse
`2`	`Vehicle`	Vehicle
`3`	`Other`	Other

StockMovementType

StockMovement.movementType

Value	Name	Label (en)
`1`	`Receipt`	Receipt / purchase
`2`	`Consumption`	Consumption
`3`	`Adjustment`	Adjustment
`4`	`TransferIn`	Transfer in
`5`	`TransferOut`	Transfer out
`6`	`Return`	Return to stock

SubTaskStatus

SubTask.status

Value	Name	Label (en)
`1`	`NotStarted`	Not Started
`2`	`InProgress`	In Progress
`3`	`Paused`	Paused
`4`	`Completed`	Completed

SupportTicketPriority

SupportTicket.priority

Value	Name	Label (en)
`1`	`Low`	Low
`2`	`Normal`	Normal
`3`	`High`	High

SupportTicketStatus

SupportTicket.status

Value	Name	Label (en)
`1`	`New`	New
`2`	`InProgress`	In Progress
`3`	`Resolved`	Resolved
`4`	`Closed`	Closed

TimeEntryType

TimeEntry.entryType

Value	Name	Label (en)
`1`	`Work`	Work
`2`	`Travel`	Travel
`3`	`Administrative`	Administrative
`4`	`Break`	Break

TimeSheetCadence

TimeSheet.cadence

Value	Name	Label (en)	Active
`1`	`Week`	Per week
`2`	`Day`	Per day

TimeSheetStatus

TimeSheet.status

Value	Name	Label (en)	Active
`1`	`Draft`	Draft
`2`	`Submitted`	Submitted

TrackingEventType

TrackingEvent.eventType

Value	Name	Label (en)
`1`	`PageView`	Page View
`2`	`Click`	Click
`3`	`FormSubmission`	Form Submission
`4`	`EmailOpen`	Email Open
`5`	`EmailClick`	Email Click
`99`	`Custom`	Custom

UserType

User.userType

Value	Name	Label (en)
`0`	`None`	No License
`1`	`FullUser`	Full User
`2`	`FieldAgent`	Field Agent

VisitCoverage

WorkTask.visitCoverage

Value	Name	Label (en)
`1`	`AllBilled`	Everything billed
`2`	`MaterialsBilled`	Materials billed
`3`	`AllInclusive`	All inclusive

VisitCoverageAgreement

ServiceAgreementLine.visitCoverage

Value	Name	Label (en)
`1`	`AllBilled`	Everything billed
`2`	`MaterialsBilled`	Materials billed
`3`	`AllInclusive`	All inclusive

WebFormType

LeadCaptureForm.formType

Value	Name	Label (en)
`1`	`Contact`	Contact
`2`	`Support`	Support
`3`	`Enquiry`	Enquiry

Weekday

ServiceAgreementLine.ordinalWeekday

Value	Name	Label (en)
`1`	`Monday`	Monday
`2`	`Tuesday`	Tuesday
`3`	`Wednesday`	Wednesday
`4`	`Thursday`	Thursday
`5`	`Friday`	Friday
`6`	`Saturday`	Saturday
`7`	`Sunday`	Sunday

WorkflowActionType

WorkflowAction.actionType

Value	Name	Label (en)
`1`	`SetField`	Set field on this record
`2`	`CreateRecord`	Create record
`3`	`SendEmail`	Send email
`4`	`CreateActivity`	Create activity / follow-up
`5`	`AssignOwner`	Assign owner
`6`	`UpdateRelated`	Update related record
`7`	`SendWebhook`	Send outbound webhook

WorkflowConditionLogic

Workflow.conditionLogic

Value	Name	Label (en)	Active
`1`	`All`	All conditions (AND)
`2`	`Any`	Any condition (OR)

WorkflowConditionOperator

WorkflowCondition.operator

Value	Name	Label (en)
`1`	`Equals`	Equals
`2`	`NotEquals`	Not equals
`3`	`Contains`	Contains
`4`	`GreaterThan`	Greater than
`5`	`LessThan`	Less than
`6`	`IsEmpty`	Is empty
`7`	`IsNotEmpty`	Is not empty
`8`	`Changed`	Changed

WorkflowRunStatus

WorkflowRun.status

Value	Name	Label (en)
`1`	`Pending`	Pending
`2`	`Running`	Running
`3`	`Succeeded`	Succeeded
`4`	`Failed`	Failed
`5`	`Skipped`	Skipped

WorkflowRunTriggerSource

WorkflowRun.triggerSource

Value	Name	Label (en)
`1`	`Event`	Event
`2`	`Scheduled`	Scheduled
`3`	`Manual`	Manual

WorkflowTriggerType

Workflow.triggerType

Value	Name	Label (en)
`1`	`Create`	Record created
`2`	`Update`	Record updated
`3`	`Delete`	Record deleted
`4`	`Scheduled`	Scheduled (date-based)

WorkTaskPriority

WorkTask.priority

Value	Name	Label (en)
`1`	`Low`	Low
`2`	`Normal`	Normal
`3`	`High`	High
`4`	`Critical`	Critical

WorkTaskStatus

WorkTask.status

Value	Name	Label (en)
`1`	`New`	New
`2`	`InProgress`	In Progress
`3`	`OnHold`	On Hold
`4`	`Completed`	Completed
`5`	`Cancelled`	Cancelled
`6`	`Planned`	Planned
`7`	`Unconfirmed`	Unconfirmed
`8`	`AwaitingCustomer`	Awaiting Customer
`9`	`AwaitingSubcontractor`	Awaiting Subcontractor

API Documentation

Contents

Authentication

Web Application (Blazor UI)

API Authentication (Token-based)

Login Request

Login Response

Using the Access Token

Custom Claims

Authorization & Roles

Role Hierarchy

Record-Level Security

Tenant Isolation

API Endpoints

Example: Create a Company

Example: List with Query Parameters

Response Format (List)

Filtering & Pagination

Query Parameters

Filter Operators

Concurrency Control

Discovery & Metadata Endpoints

Audit API

Entity Reference

AccountType

ActionItem

Activity

ActivityParticipant

AgreementComponentSetting

AgreementLocalComponent

AgreementTemplate

AgreementTemplateComponent

AgreementTemplateVersion

Asset

Budget

BudgetTemplate

BulkEmail

CalculatedField

Candidate

CaseRoutingCondition

CaseRoutingRule

CollectiveAgreement

Company

CompanyFinanceLine

CompanyVisitGoal

Contact

Contract

ContractSigner

DocumentTemplate

EmailTemplate

EmployeeAgreement

Equipment

Expense

FollowUp

GeneratedDocument

Goal

InboundWebhookEvent

Inspection

InspectionLine

InspectionTemplate

InspectionTemplateLine

Invoice

InvoiceLine

JobApplication

JobPosting

KnowledgeArticle

Lead

LeadCaptureForm

Location

MaterialUsage

MediaFile

MeetingNote

Opportunity

OpportunityLine

PayType

Product

ProductGroup

Project

ProjectActivity

ProjectAllocation