REST API

API documentation

Reference for the AmpleoCRM REST API, entities and fields, generated automatically from the system's metadata.

Contents

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:

EndpointMethodDescription
/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:

ClaimDescription
subKeycloak user ID
ampleo_tenant_idTenant identifier
ampleo_business_unit_idBusiness unit identifier
ampleo_rolesUser roles (comma-separated)
ampleo_team_idsTeam memberships
API key authentication

System-to-system integrations (ERP sync, website forms, automations) can authenticate with an API key instead of a bearer token. Send the key in the X-Api-Key header; when that header is present the API uses it, otherwise it falls back to the bearer token above.

Keys are created in the app by a tenant admin under Settings → Integration → API Keys - see the User Guide for the step-by-step. Each key is scoped to a single tenant and a role (user, manager or admin), can be restricted to specific entity types, and can be given an expiry. The plain-text key is shown only once at creation.

POST /api/v1/Contact
X-Api-Key: ampk_...
Content-Type: application/json

Authorization and roles

Role hierarchy

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

User Manager Admin System Admin
RolePermissions
userFull read access to tenant data. Standard CRUD on owned records.
managerUser permissions + metadata/configuration access.
adminManager permissions + user management, settings, data import.
system_adminUnrestricted cross-tenant access. Platform operators only.
Record-level security

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

LevelAccess filter
OwnOnly records where OwnerId == currentUserId
TeamRecords owned by current user or team members
BusinessUnitRecords in the same business unit
OrganizationAll 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:

  1. DI Context - TenantContext.TenantId set per request
  2. EF Global Filters - automatic WHERE TenantId = @current on all queries
  3. PostgreSQL RLS - Row-Level Security policies at the database level
  4. 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}

MethodEndpointDescription
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 and pagination

Query parameters
ParameterTypeDefaultDescription
pageint1Page number (1-based)
pageSizeint25Results per page (max varies per entity)
orderBystring-Field name to sort by (camelCase)
orderDescboolfalseSort descending
searchstring-Quick search across searchable fields
filterstring[]-Column filters: filter=field:op=value
Filter operators

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

OperatorDescriptionExample
eqEqualsfilter=industry:eq=3
neqNot equalsfilter=status:neq=0
containsString containsfilter=name:contains=acme
gtGreater thanfilter=amount:gt=1000
ltLess thanfilter=amount:lt=5000
gteGreater than or equalfilter=amount:gte=1000
lteLess than or equalfilter=amount:lte=5000
nullIs nullfilter=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 and metadata endpoints

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

MethodEndpointDescription
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.

MethodEndpointDescription
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.

Entity reference

All 109 entities and their fields, auto-generated from the metadata registry. Fields marked as system are auto-managed and read-only.

AbsenceEntitlement
Absence Entitlement
HRC R U D
Field Type Required Details
bookingType Option Absence TypeOptions: AbsenceEntitlementType · Filterable
carriedOverDays Decimal Carried Over (days)Filterable
employeeId Lookup Employee→ User · Filterable
entitlementDays Decimal Entitlement (days)Filterable
externalId String External IDMax length: 200 · Filterable
note Text NoteMax length: 1000 · Filterable
year Integer YearFilterable
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
idsystem Lookup IDFilterable · Read-only via API
rowVersionsystem Integer Row VersionFilterable · Read-only via API
tenantIdsystem Lookup TenantFilterable · Read-only via API
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem Lookup Modified By→ User · Filterable · Read-only via API
usedDayssystem Decimal Used (days)Filterable
Excluded from API: tenantId
API route: /api/v1/AbsenceEntitlement · Max page size: 100
AccountType
Account Type
SettingsC R U D
Field Type Required 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
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
idsystem Lookup IDFilterable · Read-only via API
rowVersionsystem Integer Row VersionFilterable · Read-only via API
tenantIdsystem Lookup TenantFilterable · Read-only via API
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem 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 Required 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
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
idsystem Lookup IDFilterable · Read-only via API
ownerBusinessUnitIdsystem Lookup Owning Business Unit→ BusinessUnit · Filterable
ownerTypesystem String Owner TypeFilterable
rowVersionsystem Integer Row VersionFilterable · Read-only via API
tenantIdsystem Lookup TenantFilterable · Read-only via API
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem Lookup Modified By→ User · Filterable · Read-only via API
Excluded from API: tenantId
API route: /api/v1/ActionItem · Max page size: 100
Activity
Activity
SalesC R U D
Field Type Required Details
activityDate DateTime Activity DateFilterable
bulkEmailId Lookup Bulk Email→ BulkEmail · Filterable
callReason Option ReasonOptions: CallReason · Filterable
callResult Option Call ResultOptions: CallResult · 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
followUpDate Date Schedule follow-upFilterable
followUpNote String Follow-up noteMax length: 1000 · Filterable
iCalUid String iCalendar UIDMax length: 500 · Filterable
internetMessageId String Internet Message IDMax length: 500 · Searchable · Filterable
location String LocationMax 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
syncToOutlook Boolean Add to Outlook calendarFilterable
type Option TypeOptions: ActivityType · Filterable
abVariantsystem String Subject variantMax length: 1 · Filterable
clickCountsystem Integer ClicksFilterable
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
firstClickedAtsystem DateTime First ClickedFilterable
firstOpenedAtsystem DateTime First OpenedFilterable
idsystem Lookup IDFilterable · Read-only via API
isHrRestrictedsystem Boolean HR RestrictedFilterable
isSystemGeneratedsystem Boolean Is System Generated
meetingInviteSentAtsystem DateTime Invitations SentFilterable
openCountsystem Integer OpensFilterable
ownerBusinessUnitIdsystem Lookup Owning Business Unit→ BusinessUnit · Filterable
ownerTypesystem String Owner TypeFilterable
portalUserIdsystem Lookup Portal User
regardingTypesystem String Regarding TypeMax length: 100 · Filterable
rowVersionsystem Integer Row VersionFilterable · Read-only via API
tenantIdsystem Lookup TenantFilterable · Read-only via API
trackingTokensystem String Tracking TokenFilterable
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem 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 Required Details
activityId Lookup Activity→ Activity · Filterable
candidateId Lookup Candidate→ Candidate · Filterable
contactId Lookup Contact→ Contact · Filterable
externalId String External IDMax length: 200 · Filterable
leadId Lookup Lead→ Lead · Filterable
participationTypeMask Option RoleOptions: ParticipationTypeMask · Filterable
userId Lookup User→ User · Filterable
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
idsystem Lookup IDFilterable · Read-only via API
ownerBusinessUnitIdsystem Lookup Owning Business Unit→ BusinessUnit · Filterable
ownerIdsystem PolymorphicLookup OwnerFilterable
ownerTypesystem String Owner TypeFilterable
rowVersionsystem Integer Row VersionFilterable · Read-only via API
tenantIdsystem Lookup TenantFilterable · Read-only via API
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem 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 Required 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
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
idsystem Lookup IDFilterable · Read-only via API
rowVersionsystem Integer Row VersionFilterable · Read-only via API
tenantIdsystem Lookup TenantFilterable · Read-only via API
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem 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 Required 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
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
idsystem Lookup IDFilterable · Read-only via API
rowVersionsystem Integer Row VersionFilterable · Read-only via API
tenantIdsystem Lookup TenantFilterable · Read-only via API
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem 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 Required 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
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
idsystem Lookup IDFilterable · Read-only via API
rowVersionsystem Integer Row VersionFilterable · Read-only via API
tenantIdsystem Lookup TenantFilterable · Read-only via API
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem 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 Required 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
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
idsystem Lookup IDFilterable · Read-only via API
rowVersionsystem Integer Row VersionFilterable · Read-only via API
tenantIdsystem Lookup TenantFilterable · Read-only via API
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem 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 Required 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
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
idsystem Lookup IDFilterable · Read-only via API
rowVersionsystem Integer Row VersionFilterable · Read-only via API
tenantIdsystem Lookup TenantFilterable · Read-only via API
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem Lookup Modified By→ User · Filterable · Read-only via API
Excluded from API: tenantId
API route: /api/v1/AgreementTemplateVersion · Max page size: 100
AgreementUsage
Usage Entry
C R U D
Field Type Required Details
date Date DateFilterable
externalId String External IDMax length: 200 · Filterable
name String DescriptionMax length: 200 · Searchable · Filterable
quantity Decimal QuantityMin: 0 · Filterable
serviceAgreementId Lookup Service Agreement→ ServiceAgreement · Filterable
serviceAgreementLineId Lookup Service→ ServiceAgreementLine · Filterable
source Option SourceOptions: UsageSource · Filterable
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
idsystem Lookup IDFilterable · Read-only via API
invoiceLineIdsystem Lookup Invoice Line→ InvoiceLine · Filterable
rowVersionsystem Integer Row VersionFilterable · Read-only via API
settledAtsystem DateTime SettledFilterable
sourceMaterialUsageIdsystem Lookup Material Usage→ MaterialUsage · Filterable
sourceTimeEntryIdsystem Lookup Time Registration→ TimeEntry · Filterable
tenantIdsystem Lookup TenantFilterable · Read-only via API
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem Lookup Modified By→ User · Filterable · Read-only via API
Excluded from API: tenantId
API route: /api/v1/AgreementUsage · Max page size: 100
Asset
Asset
ServiceFieldServiceC R U D
Field Type Required 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
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
idsystem Lookup IDFilterable · Read-only via API
ownerBusinessUnitIdsystem Lookup Owning Business Unit→ BusinessUnit · Filterable
ownerTypesystem String Owner TypeFilterable
rowVersionsystem Integer Row VersionFilterable · Read-only via API
tenantIdsystem Lookup TenantFilterable · Read-only via API
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem Lookup Modified By→ User · Filterable · Read-only via API
Excluded from API: tenantId
API route: /api/v1/Asset · Max page size: 100
BonusAccrual
Bonus
C R U D
Field Type Required Details
externalId String External IDMax length: 200 · Filterable
amountsystem Currency Bonus AmountFilterable
basisAmountsystem Currency Basis AmountFilterable
bonusRuleIdsystem Lookup Bonus Rule→ BonusRule · Filterable
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created ByRead-only via API
earnedDatesystem Date Earned DateFilterable
idsystem Lookup IDFilterable · Read-only via API
opportunityIdsystem Lookup Opportunity→ Opportunity · Filterable
ownerBusinessUnitIdsystem Lookup Owning Business Unit→ BusinessUnit · Filterable
ownerIdsystem Lookup Owner→ User · Filterable
ownerTypesystem String Owner TypeFilterable
ratePercentsystem Decimal Rate %Filterable
rowVersionsystem Integer Row VersionFilterable · Read-only via API
serviceAgreementIdsystem Lookup Service Agreement→ ServiceAgreement · Filterable
sharePercentsystem Decimal Share %Filterable
sourceRevenueIdsystem Lookup Source Payment→ Revenue · Filterable
tenantIdsystem Lookup TenantFilterable · Read-only via API
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem Lookup Updated ByRead-only via API
userIdsystem Lookup Salesperson→ User · Filterable
Excluded from API: tenantId
API route: /api/v1/BonusAccrual · Max page size: 100
BonusRule
Bonus Rule
Settingsmanager+C R U D
Field Type Required Details
basis Option BasisOptions: BonusBasis · Filterable
externalId String External IDMax length: 200 · Filterable
isActive Boolean ActiveFilterable
name String NameMax length: 200 · Searchable · Filterable
opportunityType Option Opportunity TypeOptions: OpportunityType · Filterable
priority Integer PriorityFilterable
ratePercent Decimal Rate %Filterable
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created ByRead-only via API
idsystem Lookup IDFilterable · Read-only via API
rowVersionsystem Integer Row VersionFilterable · Read-only via API
tenantIdsystem Lookup TenantFilterable · Read-only via API
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem Lookup Updated ByRead-only via API
Excluded from API: tenantId
API route: /api/v1/BonusRule · Max page size: 100
Budget
Budget
ProjectManagementC R U D
Field Type Required 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
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
idsystem Lookup IDFilterable · Read-only via API
regardingTypesystem String Regarding TypeMax length: 100 · Filterable
rowVersionsystem Integer Row VersionFilterable · Read-only via API
tenantIdsystem Lookup TenantFilterable · Read-only via API
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem 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 Required Details
description Text DescriptionMax length: 2000 · Filterable
externalId String External IDMax length: 200 · Filterable
name String NameMax length: 200 · Searchable · Filterable
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
idsystem Lookup IDFilterable · Read-only via API
rowVersionsystem Integer Row VersionFilterable · Read-only via API
tenantIdsystem Lookup TenantFilterable · Read-only via API
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem 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 Required Details
campaignId Lookup Campaign→ Campaign · Filterable
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
segmentId Lookup Segment→ Segment · Filterable
status Option StatusOptions: BulkEmailStatus · Filterable
subjectB String Test subject line (B)Max length: 500 · Filterable
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
failureCountsystem Integer FailedFilterable
idsystem Lookup IDFilterable · Read-only via API
ownerBusinessUnitIdsystem Lookup Owning Business Unit→ BusinessUnit · Filterable
ownerTypesystem String Owner TypeFilterable
rowVersionsystem Integer Row VersionFilterable · Read-only via API
sentAtsystem DateTime Sent AtFilterable
skippedCountsystem Integer Skipped Count
successCountsystem Integer SentFilterable
tenantIdsystem Lookup TenantFilterable · Read-only via API
totalRecipientssystem Integer Total RecipientsFilterable
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem 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 Required 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
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
idsystem Lookup IDFilterable · Read-only via API
ownerBusinessUnitIdsystem Lookup Owning Business Unit→ BusinessUnit · Filterable
ownerTypesystem String Owner TypeFilterable
rowVersionsystem Integer Row VersionFilterable · Read-only via API
tenantIdsystem Lookup TenantFilterable · Read-only via API
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem Lookup Modified By→ User · Filterable · Read-only via API
Excluded from API: tenantId
API route: /api/v1/CalculatedField · Max page size: 100
Campaign
Campaign
CommunicationSalesC R U D
Field Type Required Details
actualCost Currency Actual costFilterable
budgetedCost Currency Budgeted costFilterable
description Text DescriptionMax length: 4000 · Searchable · Filterable
endDate Date End dateFilterable
externalId String External IDMax length: 200 · Filterable
name String NameMax length: 200 · Searchable · Filterable
ownerId PolymorphicLookup OwnerFilterable
startDate Date Start dateFilterable
status Option StatusOptions: CampaignStatus · Filterable
transactionCurrencyId Lookup Currency→ Currency · Filterable
type Option ChannelOptions: CampaignType · Filterable
convertedLeadCountsystem Integer Converted leadsFilterable
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
idsystem Lookup IDFilterable · Read-only via API
leadCountsystem Integer LeadsFilterable
opportunityCountsystem Integer OpportunitiesFilterable
opportunityValuesystem Currency Open pipelineFilterable
ownerBusinessUnitIdsystem Lookup Owning Business Unit→ BusinessUnit · Filterable
ownerTypesystem String Owner TypeFilterable
rowVersionsystem Integer Row VersionFilterable · Read-only via API
tenantIdsystem Lookup TenantFilterable · Read-only via API
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem Lookup Modified By→ User · Filterable · Read-only via API
wonOpportunityCountsystem Integer WonFilterable
wonOpportunityValuesystem Currency Won deal valueFilterable
wonRevenuesystem Currency Booked revenueFilterable
Excluded from API: tenantId
API route: /api/v1/Campaign · Max page size: 100
Candidate
Candidate
HRC R U D
Field Type Required Details
allowMarketing Boolean Allow MarketingFilterable
consentExpiresAt Date Consent ExpiresFilterable
consentGivenAt Date Consent GivenFilterable
consentSource String Consent SourceMax length: 200 · Filterable
currentCompany String Current CompanyMax length: 200 · Searchable · Filterable
currentTitle String Current TitleMax length: 200 · Searchable · Filterable
email String EmailMax length: 320 · Searchable · Filterable
externalId String External IDMax length: 200 · Filterable
firstName String First NameMax length: 100 · Searchable · Filterable
followUpDate Date Follow-up DateFilterable
followUpNote String Follow-up NoteMax length: 500 · Filterable
lastName String Last NameMax length: 100 · Searchable · Filterable
linkedInUrl String LinkedInMax length: 300 · Filterable
notes Text NotesMax length: 8000 · Searchable · Filterable
ownerId PolymorphicLookup OwnerFilterable
phone String PhoneMax length: 50 · Filterable
salaryExpectation Decimal Salary Expectation (annual)Filterable
skills Text SkillsMax length: 2000 · Searchable · Filterable
source Option SourceOptions: CandidateSource · Filterable
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
cvAnalyzedAtsystem Date CV AnalysedFilterable
cvTextsystem Text CV TextMax length: 30000 · Searchable · Filterable
idsystem Lookup IDFilterable · Read-only via API
mergedIntoIdsystem Lookup Merged Into→ Candidate · Filterable
ownerBusinessUnitIdsystem Lookup Owning Business Unit→ BusinessUnit · Filterable
ownerTypesystem String Owner TypeFilterable
rowVersionsystem Integer Row VersionFilterable · Read-only via API
tenantIdsystem Lookup TenantFilterable · Read-only via API
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem Lookup Modified By→ User · Filterable · Read-only via API
Excluded from API: tenantId
API route: /api/v1/Candidate · Max page size: 100
CandidateEmail
Additional Email
HRC R U D
Field Type Required Details
candidateId Lookup Candidate→ Candidate · Filterable
email String EmailMax length: 320 · Searchable · Filterable
externalId String External IDMax length: 200 · Filterable
label String LabelMax length: 100 · Filterable
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
idsystem Lookup IDFilterable · Read-only via API
rowVersionsystem Integer Row VersionFilterable · Read-only via API
tenantIdsystem Lookup TenantFilterable · Read-only via API
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem Lookup Modified By→ User · Filterable · Read-only via API
Excluded from API: tenantId
API route: /api/v1/CandidateEmail · Max page size: 100
CaseRoutingCondition
Routing Condition
ServiceC R U D
Field Type Required 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
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
idsystem Lookup IDFilterable · Read-only via API
rowVersionsystem Integer Row VersionFilterable · Read-only via API
tenantIdsystem Lookup TenantFilterable · Read-only via API
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem 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 Required 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
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
idsystem Lookup IDFilterable · Read-only via API
ownerBusinessUnitIdsystem Lookup Owning Business Unit→ BusinessUnit · Filterable
ownerTypesystem String Owner TypeFilterable
rowVersionsystem Integer Row VersionFilterable · Read-only via API
tenantIdsystem Lookup TenantFilterable · Read-only via API
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem Lookup Modified By→ User · Filterable · Read-only via API
Excluded from API: tenantId
API route: /api/v1/CaseRoutingRule · Max page size: 100
ClosedDay
Closed Day
Settingsmanager+C R U D
Field Type Required Details
description Text DescriptionMax length: 2000 · Filterable
endDate Date ToFilterable
externalId String External IDMax length: 200 · Filterable
name String NameMax length: 200 · Searchable · Filterable
startDate Date FromFilterable
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
idsystem Lookup IDFilterable · Read-only via API
ownerBusinessUnitIdsystem Lookup Business Unit→ BusinessUnit · Filterable
ownerIdsystem PolymorphicLookup OwnerFilterable
ownerTypesystem String Owner TypeFilterable
rowVersionsystem Integer Row VersionFilterable · Read-only via API
tenantIdsystem Lookup TenantFilterable · Read-only via API
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem Lookup Modified By→ User · Filterable · Read-only via API
Excluded from API: tenantId
API route: /api/v1/ClosedDay · Max page size: 100
CollectiveAgreement
Collective Agreement
HRC R U D
Field Type Required 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
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
idsystem Lookup IDFilterable · Read-only via API
rowVersionsystem Integer Row VersionFilterable · Read-only via API
tenantIdsystem Lookup TenantFilterable · Read-only via API
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem Lookup Modified By→ User · Filterable · Read-only via API
Excluded from API: tenantId
API route: /api/v1/CollectiveAgreement · Max page size: 100
Company
Company
SalesServiceC R U D
Field Type Required Details
accountManagerIdextension 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
creditRatingextension Option Credit RatingOptions: CreditRating
customerNumber String Customer NumberMax length: 50 · Searchable · Filterable
customerSinceextension DateTime Customer Since
cvrStatus String Registry StatusMax length: 100 · Filterable
description Text DescriptionMax length: 4000 · Filterable
domain String DomainMax length: 255 · Searchable · 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
internalNotesextension Text Internal NotesMax length: 4000
lastContactedAt Date Last ContactedFilterable
latitude Decimal LatitudeFilterable
legalOwner String Legal OwnerMax length: 500 · Filterable
longitude Decimal LongitudeFilterable
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
status Option StatusOptions: CompanyStatus · Filterable
transactionCurrencyId Lookup Currency→ Currency · Filterable
vatNumberextension String VAT NumberMax length: 50
website String WebsiteMax length: 500 · Filterable
averageDealSizesystem Currency Avg. Deal SizeFilterable
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
currentAgreementIdsystem Lookup Current Agreement→ ServiceAgreement · Filterable
currentFiscalYearRevenuesystem Currency Revenue Current Fiscal YearFilterable
idsystem Lookup IDFilterable · Read-only via API
lastFiscalYearRevenuesystem Currency Revenue Last Fiscal YearFilterable
mergedIntoIdsystem Lookup Merged Into→ Company · Filterable
ownerBusinessUnitIdsystem Lookup Owning Business Unit→ BusinessUnit · Filterable
ownerTypesystem String Owner TypeFilterable
rowVersionsystem Integer Row VersionFilterable · Read-only via API
tenantIdsystem Lookup TenantFilterable · Read-only via API
totalPipelinesystem Currency Total PipelineFilterable
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem 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 Required 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
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
idsystem Lookup IDFilterable · Read-only via API
rowVersionsystem Integer Row VersionFilterable · Read-only via API
tenantIdsystem Lookup TenantFilterable · Read-only via API
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem 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 Required 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
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
idsystem Lookup IDFilterable · Read-only via API
ownerBusinessUnitIdsystem Lookup Owning Business Unit→ BusinessUnit · Filterable
ownerTypesystem String Owner Type
rowVersionsystem Integer Row VersionFilterable · Read-only via API
tenantIdsystem Lookup TenantFilterable · Read-only via API
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem Lookup Modified By→ User · Filterable · Read-only via API
Excluded from API: tenantId
API route: /api/v1/CompanyVisitGoal · Max page size: 100
Competitor
Competitor
SalesC R U D
Field Type Required Details
description Text NotesMax length: 4000 · Filterable
externalId String External IDMax length: 200 · Filterable
name String NameMax length: 200 · Searchable · Filterable
ownerId PolymorphicLookup OwnerFilterable
products Text Competing productsMax length: 2000 · Filterable
strengths Text StrengthsMax length: 2000 · Filterable
threatLevel Option Threat levelOptions: CompetitorThreatLevel · Filterable
weaknesses Text WeaknessesMax length: 2000 · Filterable
website String WebsiteMax length: 500 · Searchable · Filterable
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
idsystem Lookup IdRead-only via API
ownerBusinessUnitIdsystem Lookup Owning Business Unit→ BusinessUnit · Filterable
ownerTypesystem String Owner TypeFilterable
rowVersionsystem Integer Row VersionFilterable · Read-only via API
tenantIdsystem Lookup TenantRead-only via API
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem Lookup Modified By→ User · Filterable · Read-only via API
Excluded from API: tenantId
API route: /api/v1/Competitor · Max page size: 100
Contact
Contact
SalesServiceC R U D
Field Type Required 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
consentDateextension 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
lastContactedAt Date Last ContactedFilterable
lastName String Last NameMax length: 100 · Searchable · Filterable
latitude Decimal LatitudeFilterable
leadSource Option Lead SourceOptions: LeadSource · Filterable
linkedInUrlextension String LinkedIn URLMax length: 500
longitude Decimal LongitudeFilterable
marketingConsentextension 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
preferredChannelextension Option Preferred ChannelOptions: CommunicationChannel
preferredContactMethod Option Preferred Contact MethodOptions: PreferredContactMethod · Filterable
status Option StatusOptions: ContactStatus · Filterable
twitterHandleextension String Twitter/X HandleMax length: 50
campaignsystem String Campaign
consentGivenAtsystem DateTime Consent Given At
consentSourcesystem String Consent Source
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
idsystem Lookup IDFilterable · Read-only via API
mergedIntoIdsystem Lookup Merged Into→ Contact · Filterable
ownerBusinessUnitIdsystem Lookup Owning Business Unit→ BusinessUnit · Filterable
ownerTypesystem String Owner TypeFilterable
rowVersionsystem Integer Row VersionFilterable · Read-only via API
sourcesystem String Source
tenantIdsystem Lookup TenantFilterable · Read-only via API
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem Lookup Modified By→ User · Filterable · Read-only via API
Excluded from API: tenantId
API route: /api/v1/Contact · Max page size: 100
Contract
Contract
SalesC R U D
Field Type Required 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
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
externalCaseFileIdsystem String External Case File IDMax length: 500 · Filterable
idsystem Lookup IDFilterable · Read-only via API
ownerBusinessUnitIdsystem Lookup Owning Business Unit→ BusinessUnit · Filterable
ownerTypesystem String Owner TypeFilterable
rowVersionsystem Integer Row VersionFilterable · Read-only via API
signatureProvidersystem String Signature ProviderMax length: 100 · Filterable
tenantIdsystem Lookup TenantFilterable · Read-only via API
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem 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 Required 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
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
externalSignerIdsystem String External Signer IDMax length: 500 · Filterable
idsystem Lookup IDFilterable · Read-only via API
rowVersionsystem Integer Row VersionFilterable · Read-only via API
signedAtsystem DateTime Signed AtFilterable
tenantIdsystem Lookup TenantFilterable · Read-only via API
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem 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 Required 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
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
idsystem Lookup IDFilterable · Read-only via API
rowVersionsystem Integer Row VersionFilterable · Read-only via API
tenantIdsystem Lookup TenantFilterable · Read-only via API
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem Lookup Modified By→ User · Filterable · Read-only via API
Excluded from API: tenantId
API route: /api/v1/DocumentTemplate · Max page size: 100
EmailSuppression
Suppressed Address
CommunicationC R U D
Field Type Required Details
bulkEmailId Lookup From Send→ BulkEmail · Filterable
email String EmailMax length: 320 · Searchable · Filterable
externalId String External IDMax length: 200 · Filterable
reason Option ReasonOptions: EmailSuppressionReason · Filterable
source String SourceMax length: 500 · Searchable · Filterable
suppressedAt DateTime Suppressed AtFilterable
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
idsystem Lookup IDFilterable · Read-only via API
rowVersionsystem Integer Row VersionFilterable · Read-only via API
tenantIdsystem Lookup TenantFilterable · Read-only via API
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem Lookup Modified By→ User · Filterable · Read-only via API
Excluded from API: tenantId
API route: /api/v1/EmailSuppression · Max page size: 100
EmailTemplate
Email Template
CommunicationC R U D
Field Type Required Details
body Text BodyMax length: 100000 · Filterable
bodyDesign Text Body designMax length: 200000 · 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
preheaderText String Preview textMax length: 300 · Filterable
replyToEmail String Reply-To EmailMax length: 320 · Filterable
subject String SubjectMax length: 500 · Filterable
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
idsystem Lookup IDFilterable · Read-only via API
ownerBusinessUnitIdsystem Lookup Owning Business Unit→ BusinessUnit · Filterable
ownerTypesystem String Owner TypeFilterable
rowVersionsystem Integer Row VersionFilterable · Read-only via API
tenantIdsystem Lookup TenantFilterable · Read-only via API
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem 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 Required 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
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
idsystem Lookup IDFilterable · Read-only via API
rowVersionsystem Integer Row VersionFilterable · Read-only via API
tenantIdsystem Lookup TenantFilterable · Read-only via API
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem Lookup Modified By→ User · Filterable · Read-only via API
Excluded from API: tenantId
API route: /api/v1/EmployeeAgreement · Max page size: 100
EmployeeCertification
Certification
HRC R U D
Field Type Required Details
employeeId Lookup Employee→ User · Filterable
expiryDate Date ExpiresFilterable
externalId String External IDMax length: 200 · Filterable
issuedBy String Issued ByMax length: 200 · Searchable · Filterable
issuedDate Date IssuedFilterable
name String CertificationMax length: 300 · Searchable · Filterable
note Text NoteMax length: 2000 · Filterable
referenceNumber String ReferenceMax length: 100 · Searchable · Filterable
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
idsystem Lookup IDFilterable · Read-only via API
rowVersionsystem Integer Row VersionFilterable · Read-only via API
tenantIdsystem Lookup TenantFilterable · Read-only via API
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem Lookup Modified By→ User · Filterable · Read-only via API
Excluded from API: tenantId
API route: /api/v1/EmployeeCertification · Max page size: 100
EmployeeChecklistItem
Checklist Item
HRC R U D
Field Type Required Details
assignedToId Lookup Responsible→ User · Filterable
checklistType Option TypeOptions: EmployeeChecklistType · Filterable
dueDate Date DueFilterable
employeeId Lookup Employee→ User · Filterable
externalId String External IDMax length: 200 · Filterable
isCompleted Boolean DoneFilterable
note Text NoteMax length: 2000 · Filterable
sortOrder Integer OrderFilterable
title String StepMax length: 300 · Searchable · Filterable
completedAtsystem DateTime Completed OnFilterable
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
idsystem Lookup IDFilterable · Read-only via API
rowVersionsystem Integer Row VersionFilterable · Read-only via API
tenantIdsystem Lookup TenantFilterable · Read-only via API
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem Lookup Modified By→ User · Filterable · Read-only via API
Excluded from API: tenantId
API route: /api/v1/EmployeeChecklistItem · Max page size: 100
Equipment
Equipment
FieldServiceC R U D
Field Type Required 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
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
idsystem Lookup IDFilterable · Read-only via API
ownerBusinessUnitIdsystem Lookup Owning Business Unit→ BusinessUnit · Filterable
ownerTypesystem String Owner TypeFilterable
rowVersionsystem Integer Row VersionFilterable · Read-only via API
tenantIdsystem Lookup TenantFilterable · Read-only via API
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem Lookup Modified By→ User · Filterable · Read-only via API
Excluded from API: tenantId
API route: /api/v1/Equipment · Max page size: 100
Expense
Expense
FieldServiceC R U D
Field Type Required 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
amountBasesystem Currency Amount (base currency)Filterable
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
idsystem Lookup IDFilterable · Read-only via API
ownerBusinessUnitIdsystem Lookup Owning Business Unit→ BusinessUnit · Filterable
ownerTypesystem String Owner TypeFilterable
rowVersionsystem Integer Row VersionFilterable · Read-only via API
tenantIdsystem Lookup TenantFilterable · Read-only via API
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem 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 Required 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 · Searchable · Filterable
ownerId PolymorphicLookup OwnerFilterable
recordId PolymorphicLookup RecordFilterable
title String TitleMax length: 200 · Filterable
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
idsystem Lookup IDFilterable · Read-only via API
ownerBusinessUnitIdsystem Lookup Owning Business Unit→ BusinessUnit · Filterable
ownerTypesystem String Owner TypeFilterable
reminderSentAtsystem DateTime Reminder Sent At
rowVersionsystem Integer Row VersionFilterable · Read-only via API
tenantIdsystem Lookup TenantFilterable · Read-only via API
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem 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 Required 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
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
idsystem Lookup IDFilterable · Read-only via API
rowVersionsystem Integer Row VersionFilterable · Read-only via API
tenantIdsystem Lookup TenantFilterable · Read-only via API
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem Lookup Modified By→ User · Filterable · Read-only via API
Excluded from API: tenantId
API route: /api/v1/GeneratedDocument · Max page size: 100
Goal
Goal
SalesC R U D
Field Type Required 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
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
idsystem Lookup IDFilterable · Read-only via API
ownerBusinessUnitIdsystem Lookup Owning Business Unit→ BusinessUnit · Filterable
ownerTypesystem String Owner Type
rowVersionsystem Integer Row VersionFilterable · Read-only via API
tenantIdsystem Lookup TenantFilterable · Read-only via API
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem 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 Required 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
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
idsystem Lookup IDFilterable · Read-only via API
rowVersionsystem Integer Row VersionFilterable · Read-only via API
tenantIdsystem Lookup TenantFilterable · Read-only via API
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem Lookup Modified By→ User · Filterable · Read-only via API
Excluded from API: tenantId
API route: /api/v1/InboundWebhookEvent · Max page size: 100
Inspection
Inspection
FieldServiceC R U D
Field Type Required 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
completedAtsystem DateTime Completed OnFilterable
completedByIdsystem Lookup Completed By→ User · Filterable
completedCountsystem Integer CompletedFilterable
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
deviationCountsystem Integer DeviationsFilterable
idsystem Lookup IDFilterable · Read-only via API
ownerBusinessUnitIdsystem Lookup Owning Business Unit→ BusinessUnit · Filterable
ownerTypesystem String Owner TypeFilterable
requiredCountsystem Integer RequiredFilterable
rowVersionsystem Integer Row VersionFilterable · Read-only via API
tenantIdsystem Lookup TenantFilterable · Read-only via API
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem 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 Required 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
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
idsystem Lookup IDFilterable · Read-only via API
inspectionTemplateLineIdsystem Lookup Template Line→ InspectionTemplateLine · Filterable
rowVersionsystem Integer Row VersionFilterable · Read-only via API
tenantIdsystem Lookup TenantFilterable · Read-only via API
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem 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 Required 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
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
idsystem Lookup IDFilterable · Read-only via API
ownerBusinessUnitIdsystem Lookup Owning Business Unit→ BusinessUnit · Filterable
ownerTypesystem String Owner TypeFilterable
rowVersionsystem Integer Row VersionFilterable · Read-only via API
tenantIdsystem Lookup TenantFilterable · Read-only via API
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem 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 Required 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
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
idsystem Lookup IDFilterable · Read-only via API
rowVersionsystem Integer Row VersionFilterable · Read-only via API
tenantIdsystem Lookup TenantFilterable · Read-only via API
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem Lookup Modified By→ User · Filterable · Read-only via API
Excluded from API: tenantId
API route: /api/v1/InspectionTemplateLine · Max page size: 100
Invoice
Invoice
SalesC R U D
Field Type Required 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
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
idsystem Lookup IDFilterable · Read-only via API
ownerBusinessUnitIdsystem Lookup Owning Business Unit→ BusinessUnit · Filterable
ownerTypesystem String Owner TypeFilterable
rowVersionsystem Integer Row VersionFilterable · Read-only via API
serviceAgreementIdsystem Lookup Service Agreement
tenantIdsystem Lookup TenantFilterable · Read-only via API
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem 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 Required 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
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
idsystem Lookup IDFilterable · Read-only via API
rowVersionsystem Integer Row VersionFilterable · Read-only via API
sourceMaterialUsageIdsystem Lookup Source MaterialFilterable
sourceServiceAgreementBillingLineIdsystem Lookup Source Billing LineFilterable
sourceTimeEntryIdsystem Lookup Source Time EntryFilterable
sourceWorkTaskIdsystem Lookup Source Work TaskFilterable
tenantIdsystem Lookup TenantFilterable · Read-only via API
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem 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 Required Details
agreedSalary Decimal Agreed Salary (annual)Filterable
answeredAt Date AnsweredFilterable
appliedDate Date AppliedFilterable
candidateId Lookup Candidate→ Candidate · Filterable
externalId String External IDMax length: 200 · Filterable
feeAmount Decimal FeeFilterable
jobPostingId Lookup Posting→ JobPosting · Filterable
notes Text NotesMax length: 4000 · Filterable
origin Option OriginOptions: ApplicationOrigin · Filterable
rating Option RatingOptions: CandidateRating · Filterable
stage Option StageOptions: ApplicationStage · Filterable
startDate Date Start DateFilterable
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
hiredAtsystem Date Hired OnFilterable
idsystem Lookup IDFilterable · Read-only via API
rowVersionsystem Integer Row VersionFilterable · Read-only via API
tenantIdsystem Lookup TenantFilterable · Read-only via API
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem 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 Required 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
feePercent Decimal Fee (% of annual salary)Filterable
followUpDate Date Follow-up DateFilterable
followUpNote String Follow-up NoteMax length: 500 · Filterable
openings Integer OpeningsFilterable
opportunityId Lookup Opportunity→ Opportunity · Filterable
ownerId PolymorphicLookup OwnerFilterable
postedDate Date PostedFilterable
referenceNumber String ReferenceMax length: 50 · Searchable · Filterable
salaryMax Decimal Annual Salary ToFilterable
salaryMin Decimal Annual Salary FromFilterable
status Option StatusOptions: JobPostingStatus · Filterable
title String TitleMax length: 200 · Searchable · Filterable
workLocation String LocationMax length: 200 · Filterable
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
filledOpeningssystem Integer FilledFilterable
idsystem Lookup IDFilterable · Read-only via API
ownerBusinessUnitIdsystem Lookup Owning Business Unit→ BusinessUnit · Filterable
ownerTypesystem String Owner TypeFilterable
rowVersionsystem Integer Row VersionFilterable · Read-only via API
tenantIdsystem Lookup TenantFilterable · Read-only via API
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem 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 Required 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
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
idsystem Lookup IDFilterable · Read-only via API
ownerBusinessUnitIdsystem Lookup Owning Business Unit→ BusinessUnit · Filterable
ownerTypesystem String Owner TypeFilterable
rowVersionsystem Integer Row VersionFilterable · Read-only via API
tenantIdsystem Lookup TenantFilterable · Read-only via API
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem Lookup Modified By→ User · Filterable · Read-only via API
Excluded from API: tenantId
API route: /api/v1/KnowledgeArticle · Max page size: 100
Lead
Lead
SalesC R U D
Field Type Required Details
address String AddressMax length: 500 · Filterable
alternatePhone String Alternative NumberMax length: 50 · Filterable
budget Option BudgetOptions: LeadBudget · Filterable
budgetAmount Currency Budget AmountFilterable
campaignId Lookup Campaign→ Campaign · Filterable
city String CityMax length: 100 · Searchable · Filterable
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 · Searchable · Filterable
consentGiven Boolean Consent GivenFilterable
contactAction Option ContactOptions: IntakeContactAction · Filterable
contactId Lookup Existing Contact→ Contact · Filterable
country String CountryMax length: 100 · Searchable · Filterable
description Text DescriptionMax length: 4000 · Filterable
email String EmailMax length: 500 · Searchable · Filterable
engagementReason Option ReasonOptions: LeadEngagementReason · Filterable
engagementStatus Option Engagement statusOptions: LeadEngagementStatus · Filterable
externalId String External IDMax length: 200 · Filterable
firstName String First NameMax length: 200 · Searchable · Filterable
industryCode String Industry CodeMax length: 20 · Filterable
industryName String Industry NameMax length: 500 · Searchable · Filterable
jobTitle String Job TitleMax length: 200 · Filterable
keywords String KeywordsMax length: 500 · Searchable · Filterable
lastContactedAt Date Last ContactedFilterable
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 · Searchable · Filterable
municipality String MunicipalityMax length: 200 · Filterable
need Option NeedOptions: LeadNeed · Filterable
opportunityAction Option OpportunityOptions: IntakeOpportunityAction · Filterable
ownerId PolymorphicLookup OwnerFilterable
permissionDate Date Permission DateFilterable
phone String PhoneMax length: 50 · Searchable · Filterable
postalCode String Postal CodeMax length: 20 · 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
consentGivenAtsystem DateTime Consent Given At
convertedAtsystem DateTime ConvertedFilterable
convertedCompanyIdsystem Lookup Created Company→ Company · Filterable
convertedContactIdsystem Lookup Created Contact→ Contact · Filterable
convertedOpportunityIdsystem Lookup Created Opportunity→ Opportunity · Filterable
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
followUpNotesystem String Follow-up NoteMax length: 500 · Filterable
formIdsystem Lookup Web Form→ LeadCaptureForm · Filterable
formTypesystem Option Form TypeOptions: LeadFormType · Filterable
idsystem Lookup IdRead-only via API
isSalesReadysystem Boolean Sales readyFilterable
mergedIntoIdsystem Lookup Merged Into→ Lead · Filterable
nextFollowUpDatesystem DateTime Next Follow-upFilterable
ownerBusinessUnitIdsystem Lookup Owning Business Unit→ BusinessUnit · Filterable
ownerTypesystem String Owner TypeFilterable
rowVersionsystem Integer Row VersionFilterable · Read-only via API
scoresystem Integer ScoreFilterable
scoredAtsystem DateTime Scored AtFilterable
statussystem Option StatusOptions: LeadStatus · Filterable
tenantIdsystem Lookup TenantRead-only via API
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem 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 Required Details
campaignId Lookup Campaign→ Campaign · Filterable
captureTarget Option CreatesOptions: CaptureTarget · Filterable
consentText Text Consent TextMax length: 2000 · Filterable
createActivity Boolean Create TaskFilterable
defaultCampaign String Campaign tag (UTM)Max 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
accessTokensystem String Access TokenFilterable
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
idsystem Lookup IdRead-only via API
ownerBusinessUnitIdsystem Lookup Owner Business Unit
ownerIdsystem Lookup Owner
ownerTypesystem String Owner Type
rowVersionsystem Integer Row VersionRead-only via API
tenantIdsystem Lookup TenantRead-only via API
updatedAtsystem DateTime Updated AtRead-only via API
updatedBysystem Lookup Updated ByRead-only via API
Excluded from API: tenantId
API route: /api/v1/LeadCaptureForm · Max page size: 100
LeadScoringRule
Lead Scoring Rule
SettingsC R U D
Field Type Required Details
eventType Option Event TypeOptions: TrackingEventType · Filterable
externalId String External IDMax length: 200 · Filterable
isActive Boolean ActiveFilterable
name String NameMax length: 200 · Searchable · Filterable
points Integer PointsFilterable
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
idsystem Lookup IDFilterable · Read-only via API
rowVersionsystem Integer Row VersionFilterable · Read-only via API
tenantIdsystem Lookup TenantFilterable · Read-only via API
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem Lookup Modified By→ User · Filterable · Read-only via API
Excluded from API: tenantId
API route: /api/v1/LeadScoringRule · Max page size: 100
Location
Location
FieldServiceC R U D
Field Type Required 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
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
idsystem Lookup IDFilterable · Read-only via API
ownerBusinessUnitIdsystem Lookup Owning Business Unit→ BusinessUnit · Filterable
ownerTypesystem String Owner TypeFilterable
rowVersionsystem Integer Row VersionFilterable · Read-only via API
tenantIdsystem Lookup TenantFilterable · Read-only via API
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem 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 Required 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
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
idsystem Lookup IDFilterable · Read-only via API
invoiceLineIdsystem Lookup Invoice Line→ InvoiceLine · Filterable
ownerBusinessUnitIdsystem Lookup Owning Business Unit→ BusinessUnit · Filterable
ownerTypesystem String Owner TypeFilterable
rowVersionsystem Integer Row VersionFilterable · Read-only via API
tenantIdsystem Lookup TenantFilterable · Read-only via API
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem 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 Required 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
createdAtsystem DateTime Created AtFilterable · Read-only via API
createdBysystem Lookup Created ByFilterable · Read-only via API
idsystem Lookup IDFilterable · Read-only via API
rowVersionsystem Integer Row VersionRead-only via API
tenantIdsystem Lookup TenantFilterable · Read-only via API
updatedAtsystem DateTime Updated AtFilterable · Read-only via API
updatedBysystem 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 Required 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
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
idsystem Lookup IDFilterable · Read-only via API
ownerBusinessUnitIdsystem Lookup Owning Business Unit→ BusinessUnit · Filterable
ownerTypesystem String Owner TypeFilterable
regardingTypesystem String Regarding TypeMax length: 100 · Filterable
rowVersionsystem Integer Row VersionFilterable · Read-only via API
tenantIdsystem Lookup TenantFilterable · Read-only via API
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem Lookup Modified By→ User · Filterable · Read-only via API
Excluded from API: tenantId
API route: /api/v1/MeetingNote · Max page size: 100
Opportunity
Opportunity
SalesC R U D
Field Type Required Details
actualCloseDate DateTime Actual Close DateFilterable
bonusMonths Integer Bonus Period (months)Min: 1 · Filterable
campaignId Lookup Campaign→ Campaign · Filterable
companyId Lookup Company→ Company · Filterable
competitorId Lookup Competitor→ Competitor · Filterable
contactId Lookup Contact→ Contact · Filterable
description Text DescriptionMax length: 20000 · 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
opportunityDate Date Opportunity DateFilterable
opportunityNumber String Opportunity No.Max length: 50 · 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
actualRevenuesystem Currency Actual RevenueFilterable
actualRevenueBasesystem Currency Actual Revenue (base currency)Filterable
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
customerNamesystem String CustomerMax length: 200 · Searchable · Filterable
expectedRevenueBasesystem Currency Expected Revenue (base currency)Filterable
idsystem Lookup IDFilterable · Read-only via API
opportunityNumberSequencesystem Integer Number (sequence)Filterable
ownerBusinessUnitIdsystem Lookup Owning Business Unit→ BusinessUnit · Filterable
ownerTypesystem String Owner TypeFilterable
rowVersionsystem Integer Row VersionFilterable · Read-only via API
tenantIdsystem Lookup TenantFilterable · Read-only via API
totalSharePercentsystem Decimal Sales Share Total (%)Filterable
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem 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 Required 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
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
idsystem Lookup IDFilterable · Read-only via API
rowVersionsystem Integer Row VersionFilterable · Read-only via API
tenantIdsystem Lookup TenantFilterable · Read-only via API
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem Lookup Modified By→ User · Filterable · Read-only via API
Excluded from API: tenantId
API route: /api/v1/OpportunityLine · Max page size: 100
OpportunitySalesShare
Sales Share
C R U D
Field Type Required Details
externalId String External IDMax length: 200 · Filterable
note String NoteMax length: 500 · Filterable
opportunityId Lookup Opportunity→ Opportunity · Filterable
sharePercent Decimal Share %Min: 0 · Max: 100 · Filterable
userId Lookup Salesperson→ User · Filterable
actualRevenuesystem Currency Actual RevenueFilterable
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
expectedRevenuesystem Currency Expected RevenueFilterable
idsystem Lookup IDFilterable · Read-only via API
ownerBusinessUnitIdsystem Lookup Owning Business Unit→ BusinessUnit · Filterable
ownerIdsystem Lookup Owner→ User · Filterable
ownerTypesystem String Owner TypeFilterable
rowVersionsystem Integer Row VersionFilterable · Read-only via API
tenantIdsystem Lookup TenantFilterable · Read-only via API
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem Lookup Modified By→ User · Filterable · Read-only via API
Excluded from API: tenantId
API route: /api/v1/OpportunitySalesShare · Max page size: 100
PayType
Pay Type
SettingsC R U D
Field Type Required Details
externalId String External IDMax length: 200 · Filterable
name String NameMax length: 200 · Searchable · Filterable
number String NumberMax length: 50 · Searchable · Filterable
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
idsystem Lookup IDFilterable · Read-only via API
rowVersionsystem Integer Row VersionFilterable · Read-only via API
tenantIdsystem Lookup TenantFilterable · Read-only via API
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem Lookup Modified By→ User · Filterable · Read-only via API
Excluded from API: tenantId
API route: /api/v1/PayType · Max page size: 100
PortalUser
Portal customer
admin+C R U D
Field Type Required Details
displayName String NameMax length: 200 · Searchable · Filterable
companyIdsystem Lookup Company→ Company · Filterable
contactIdsystem Lookup Contact
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
emailsystem String EmailMax length: 320 · Searchable · Filterable
externalIdsystem String Identity SubjectMax length: 255 · Filterable
idsystem Lookup IDFilterable · Read-only via API
invitedAtsystem DateTime Invited OnFilterable
isActivesystem Boolean ActiveFilterable
lastLoginAtsystem DateTime Last Sign-InFilterable
rowVersionsystem Integer Row VersionFilterable · Read-only via API
scopesystem Option AccessOptions: PortalUserScope · Filterable
tenantIdsystem Lookup TenantFilterable · Read-only via API
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem Lookup Modified By→ User · Filterable · Read-only via API
Excluded from API: tenantId
API route: /api/v1/PortalUser · Max page size: 100
PriceList
Price List
SettingsC R U D
Field Type Required Details
companyId Lookup Customer→ Company · Searchable · Filterable
description Text NotesMax length: 4000 · Filterable
externalId String External IDMax length: 200 · Filterable
isActive Boolean ActiveFilterable
name String NameMax length: 200 · Searchable · Filterable
ownerId Lookup Owner→ User · Filterable
transactionCurrencyId Lookup Currency→ Currency · Filterable
validFrom Date Valid FromFilterable
validTo Date Valid ToFilterable
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
idsystem Lookup IDFilterable · Read-only via API
ownerBusinessUnitIdsystem Lookup Owning Business Unit→ BusinessUnit · Filterable
ownerTypesystem String Owner TypeFilterable
rowVersionsystem Integer Row VersionFilterable · Read-only via API
tenantIdsystem Lookup TenantFilterable · Read-only via API
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem Lookup Modified By→ User · Filterable · Read-only via API
Excluded from API: tenantId
API route: /api/v1/PriceList · Max page size: 100
PriceListItem
Price List Row
SettingsC R U D
Field Type Required Details
externalId String External IDMax length: 200 · Filterable
priceListId Lookup Price List→ PriceList · Filterable
productId Lookup Product→ Product · Filterable
unitPrice Currency Unit PriceFilterable
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
idsystem Lookup IDFilterable · Read-only via API
rowVersionsystem Integer Row VersionFilterable · Read-only via API
tenantIdsystem Lookup TenantFilterable · Read-only via API
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem Lookup Modified By→ User · Filterable · Read-only via API
Excluded from API: tenantId
API route: /api/v1/PriceListItem · Max page size: 100
Product
Product
SettingsC R U D
Field Type Required Details
description Text DescriptionMax length: 4000 · Filterable
externalId String External IDMax length: 200 · Filterable
includedPeriod Option Included perOptions: BillingPeriodProductAllowance · Filterable
includedQuantity Decimal Included per PeriodMin: 0 · Filterable
isActive Boolean ActiveFilterable
isStockTracked Boolean Stock TrackedFilterable
name String Product NameMax length: 200 · Searchable · Filterable
overageBilling Option Excess BilledOptions: OverageBillingProduct · Filterable
overageUnitPrice Currency Rate Beyond IncludedMin: 0 · Filterable
productGroupId Lookup Product Group→ ProductGroup · Filterable
productNumber String Product NumberMax length: 100 · Searchable · Filterable
recurringBillingPeriod Option BilledOptions: BillingPeriodProduct · Filterable
transactionCurrencyId Lookup Currency→ Currency · Filterable
unit String UnitMax length: 30 · Filterable
unitPrice Currency Unit PriceFilterable
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
idsystem Lookup IDFilterable · Read-only via API
rowVersionsystem Integer Row VersionFilterable · Read-only via API
tenantIdsystem Lookup TenantFilterable · Read-only via API
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem 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 Required Details
externalId String External IDMax length: 200 · Filterable
groupNumber String Group NumberMax length: 100 · Searchable · Filterable
name String NameMax length: 200 · Searchable · Filterable
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
idsystem Lookup IDFilterable · Read-only via API
rowVersionsystem Integer Row VersionFilterable · Read-only via API
tenantIdsystem Lookup TenantFilterable · Read-only via API
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem Lookup Modified By→ User · Filterable · Read-only via API
Excluded from API: tenantId
API route: /api/v1/ProductGroup · Max page size: 100
Project
Project
ProjectManagementC R U D
Field Type Required 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
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
idsystem Lookup IDFilterable · Read-only via API
ownerBusinessUnitIdsystem Lookup Owning Business Unit→ BusinessUnit · Filterable
ownerTypesystem String Owner TypeFilterable
rowVersionsystem Integer Row VersionFilterable · Read-only via API
tenantIdsystem Lookup TenantFilterable · Read-only via API
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem 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 Required 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
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
idsystem Lookup IDFilterable · Read-only via API
ownerBusinessUnitIdsystem Lookup Owning Business Unit→ BusinessUnit · Filterable
ownerTypesystem String Owner TypeFilterable
rowVersionsystem Integer Row VersionFilterable · Read-only via API
tenantIdsystem Lookup TenantFilterable · Read-only via API
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem 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 Required 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
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
idsystem Lookup IDFilterable · Read-only via API
ownerBusinessUnitIdsystem Lookup Owning Business Unit→ BusinessUnit · Filterable
ownerTypesystem String Owner TypeFilterable
rowVersionsystem Integer Row VersionFilterable · Read-only via API
tenantIdsystem Lookup TenantFilterable · Read-only via API
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem Lookup Modified By→ User · Filterable · Read-only via API
Excluded from API: tenantId
API route: /api/v1/ProjectAllocation · Max page size: 100
Quote
Quote
SalesC R U D
Field Type Required Details
companyId Lookup Company→ Company · Searchable · Filterable
contactId Lookup Contact→ Contact · Filterable
description Text DescriptionMax length: 20000 · Filterable
externalId String External IDMax length: 200 · Filterable
name String Quote NameMax length: 200 · Searchable · Filterable
opportunityId Lookup Opportunity→ Opportunity · Filterable
ownerId PolymorphicLookup OwnerFilterable
quoteDate Date Quote DateFilterable
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
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
idsystem Lookup IDFilterable · Read-only via API
ownerBusinessUnitIdsystem Lookup Owning Business Unit→ BusinessUnit · Filterable
ownerTypesystem String Owner TypeFilterable
rowVersionsystem Integer Row VersionFilterable · Read-only via API
tenantIdsystem Lookup TenantFilterable · Read-only via API
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem 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 Required 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
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
idsystem Lookup IDFilterable · Read-only via API
rowVersionsystem Integer Row VersionFilterable · Read-only via API
tenantIdsystem Lookup TenantFilterable · Read-only via API
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem 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 Required 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
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
idsystem Lookup IDFilterable · Read-only via API
ownerBusinessUnitIdsystem Lookup Owning Business Unit→ BusinessUnit · Filterable
ownerTypesystem String Owner TypeFilterable
rowVersionsystem Integer Row VersionFilterable · Read-only via API
tenantIdsystem Lookup TenantFilterable · Read-only via API
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem 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 Required Details
displayName String NameMax length: 300 · Searchable · Filterable
email String EmailMax length: 320 · Searchable · 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
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
idsystem Lookup IDFilterable · Read-only via API
rowVersionsystem Integer Row VersionFilterable · Read-only via API
tenantIdsystem Lookup TenantFilterable · Read-only via API
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem 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
ProjectManagementHRC R U D
Field Type Required 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
linkGroupId Lookup Link GroupFilterable
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
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
idsystem Lookup IDFilterable · Read-only via API
ownerBusinessUnitIdsystem Lookup Owning Business Unit→ BusinessUnit · Filterable
ownerTypesystem String Owner TypeFilterable
rowVersionsystem Integer Row VersionFilterable · Read-only via API
tenantIdsystem Lookup TenantFilterable · Read-only via API
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem 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 Required 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
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
idsystem Lookup IDFilterable · Read-only via API
ownerBusinessUnitIdsystem Lookup Owning Business Unit→ BusinessUnit · Filterable
ownerTypesystem String Owner TypeFilterable
rowVersionsystem Integer Row VersionFilterable · Read-only via API
tenantIdsystem Lookup TenantFilterable · Read-only via API
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem 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 Required 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
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
idsystem Lookup IDFilterable · Read-only via API
ownerBusinessUnitIdsystem Lookup Business Unit→ BusinessUnit · Filterable
ownerIdsystem PolymorphicLookup OwnerFilterable
ownerTypesystem String Owner TypeFilterable
rowVersionsystem Integer Row VersionFilterable · Read-only via API
tenantIdsystem Lookup TenantFilterable · Read-only via API
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem Lookup Modified By→ User · Filterable · Read-only via API
Excluded from API: tenantId
API route: /api/v1/ResourceType · Max page size: 100
Revenue
Revenue
SalesC R U D
Field Type Required 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
opportunityId Lookup Opportunity→ Opportunity · Filterable
ownerId PolymorphicLookup OwnerFilterable
productGroupId Lookup Product Group→ ProductGroup · Filterable
productId Lookup Product→ Product · Filterable
revenueDate Date Revenue DateFilterable
serviceAgreementId Lookup Service Agreement→ ServiceAgreement · Filterable
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
amountBasesystem Currency Amount (base currency)Filterable
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
idsystem Lookup IDFilterable · Read-only via API
ownerBusinessUnitIdsystem Lookup Owning Business Unit→ BusinessUnit · Filterable
ownerTypesystem String Owner TypeFilterable
rowVersionsystem Integer Row VersionFilterable · Read-only via API
tenantIdsystem Lookup TenantFilterable · Read-only via API
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem Lookup Modified By→ User · Filterable · Read-only via API
Excluded from API: tenantId
API route: /api/v1/Revenue · Max page size: 100
SalesMaterial
Sales Material
SettingsC R U D
Field Type Required Details
category Option CategoryOptions: SalesMaterialCategory · Filterable
description Text DescriptionMax length: 4000 · Filterable
expectsReturn Boolean Expected backFilterable
externalId String External IDMax length: 200 · Filterable
isActive Boolean ActiveFilterable
kind Option KindOptions: SalesMaterialKind · Filterable
name String NameMax length: 200 · Searchable · Filterable
ownerId PolymorphicLookup OwnerFilterable
replacementValue Currency Replacement ValueFilterable
url String LinkMax length: 1000 · Filterable
validUntil Date Valid UntilFilterable
version String VersionMax length: 50 · Filterable
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
idsystem Lookup IDFilterable · Read-only via API
ownerBusinessUnitIdsystem Lookup Owning Business Unit→ BusinessUnit · Filterable
ownerTypesystem String Owner TypeFilterable
rowVersionsystem Integer Row VersionFilterable · Read-only via API
tenantIdsystem Lookup TenantFilterable · Read-only via API
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem Lookup Modified By→ User · Filterable · Read-only via API
Excluded from API: tenantId
API route: /api/v1/SalesMaterial · Max page size: 100
SalesMaterialHandout
Handout
SalesC R U D
Field Type Required Details
activityId Lookup Activity→ Activity · Filterable
companyId Lookup Company→ Company · Filterable
contactId Lookup Contact→ Contact · Filterable
externalId String External IDMax length: 200 · Filterable
handedOutDate Date Handed OutFilterable
locationId Lookup Location→ Location · Filterable
materialVersion String Version handed outMax length: 50 · Filterable
note Text NoteMax length: 2000 · Filterable
ownerId PolymorphicLookup OwnerFilterable
quantity Decimal QuantityFilterable
returnedDate Date ReturnedFilterable
salesMaterialId Lookup Material→ SalesMaterial · Filterable
status Option StatusOptions: SalesMaterialHandoutStatus · Filterable
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
idsystem Lookup IDFilterable · Read-only via API
ownerBusinessUnitIdsystem Lookup Owning Business Unit→ BusinessUnit · Filterable
ownerTypesystem String Owner TypeFilterable
rowVersionsystem Integer Row VersionFilterable · Read-only via API
tenantIdsystem Lookup TenantFilterable · Read-only via API
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem Lookup Modified By→ User · Filterable · Read-only via API
Excluded from API: tenantId
API route: /api/v1/SalesMaterialHandout · Max page size: 100
Segment
Segment
CommunicationC R U D
Field Type Required Details
description Text DescriptionMax length: 2000 · Searchable · Filterable
externalId String External IDMax length: 200 · Filterable
filtersJson Text CriteriaFilterable
name String NameMax length: 200 · Searchable · Filterable
ownerId PolymorphicLookup OwnerFilterable
status Option StatusOptions: SegmentStatus · Filterable
targetEntityType String Segment ofMax length: 100 · Filterable
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
idsystem Lookup IDFilterable · Read-only via API
lastEvaluatedAtsystem DateTime Last evaluatedFilterable
lastMemberCountsystem Integer Members (last count)Filterable
ownerBusinessUnitIdsystem Lookup Owning Business Unit→ BusinessUnit · Filterable
ownerTypesystem String Owner TypeFilterable
rowVersionsystem Integer Row VersionFilterable · Read-only via API
tenantIdsystem Lookup TenantFilterable · Read-only via API
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem Lookup Modified By→ User · Filterable · Read-only via API
Excluded from API: tenantId
API route: /api/v1/Segment · Max page size: 100
ServiceAgreement
Service Agreement
ServiceFieldServiceC R U D
Field Type Required Details
annualIndexationPercent Decimal Annual Adjustment (%)Filterable
bonusMonths Integer Bonus Period (months)Min: 1 · Filterable
cancellationReason Option Cancellation ReasonOptions: AgreementCancellationReason · Filterable
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
nextIndexationDate Date Next AdjustmentFilterable
ownerId PolymorphicLookup OwnerFilterable
startDate Date Start DateFilterable
status Option StatusOptions: ServiceAgreementStatus · Filterable
transactionCurrencyId Lookup Currency→ Currency · Filterable
vatRate Decimal VAT RateFilterable
actualRevenuesystem Currency Invoiced RevenueFilterable
annualValuesystem Currency Per YearFilterable
billingFrequencysystem Option Billing FrequencyOptions: AgreementBillingFrequency · Filterable
cancelledAtsystem Date Cancelled OnFilterable
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
idsystem Lookup IDFilterable · Read-only via API
monthlyValuesystem Currency Per MonthFilterable
ownerBusinessUnitIdsystem Lookup Owning Business Unit→ BusinessUnit · Filterable
ownerTypesystem String Owner TypeFilterable
rowVersionsystem Integer Row VersionFilterable · Read-only via API
tenantIdsystem Lookup TenantFilterable · Read-only via API
totalAmountsystem Currency Total AmountFilterable
totalAmountIncludingVatsystem Currency Total Incl. VATFilterable
totalLineAmountsystem Currency Total Line AmountFilterable
totalSharePercentsystem Decimal Sales Share Total (%)Filterable
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem 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 Required 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
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
idsystem Lookup IDFilterable · Read-only via API
rowVersionsystem Integer Row VersionFilterable · Read-only via API
tenantIdsystem Lookup TenantFilterable · Read-only via API
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem 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 Required Details
annualAmount Currency Per YearFilterable
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
monthlyAmount Currency Per MonthFilterable
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
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
idsystem Lookup IDFilterable · Read-only via API
lastBilledThroughsystem DateTime Last Billed ThroughFilterable
oneTimeBilledsystem Boolean One-Time BilledFilterable
rowVersionsystem Integer Row VersionFilterable · Read-only via API
tenantIdsystem Lookup TenantFilterable · Read-only via API
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem 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 Required 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
includedPeriod Option Included perOptions: BillingPeriodAllowance · Filterable
includedQuantity Decimal Included per PeriodMin: 0 · 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
overageBilling Option Overage BilledOptions: OverageBilling · Filterable
overageUnitPrice Currency Rate Beyond IncludedMin: 0 · Filterable
priority Option PriorityOptions: WorkTaskPriority · Filterable
productId Lookup Service→ Product · 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
unit String UnitMax length: 30 · Filterable
usageCapture Option Usage Captured FromOptions: UsageCapture · Filterable
visitCoverage Option Billing CoverageOptions: VisitCoverageAgreement · Filterable
weekdaysMask Integer WeekdaysFilterable
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
idsystem Lookup IDFilterable · Read-only via API
lastGeneratedThroughsystem DateTime Last Generated ThroughFilterable
rowVersionsystem Integer Row VersionFilterable · Read-only via API
tenantIdsystem Lookup TenantFilterable · Read-only via API
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem Lookup Modified By→ User · Filterable · Read-only via API
Excluded from API: tenantId
API route: /api/v1/ServiceAgreementLine · Max page size: 100
ServiceAgreementSalesShare
Agreement Sales Share
C R U D
Field Type Required Details
externalId String External IDMax length: 200 · Filterable
note String NoteMax length: 500 · Filterable
serviceAgreementId Lookup Agreement→ ServiceAgreement · Filterable
sharePercent Decimal Share %Min: 0 · Max: 100 · Filterable
userId Lookup Salesperson→ User · Filterable
actualRevenuesystem Currency Invoiced RevenueFilterable
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
idsystem Lookup IDFilterable · Read-only via API
ownerBusinessUnitIdsystem Lookup Owning Business Unit→ BusinessUnit · Filterable
ownerIdsystem Lookup Owner→ User · Filterable
ownerTypesystem String Owner TypeFilterable
rowVersionsystem Integer Row VersionFilterable · Read-only via API
tenantIdsystem Lookup TenantFilterable · Read-only via API
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem Lookup Modified By→ User · Filterable · Read-only via API
Excluded from API: tenantId
API route: /api/v1/ServiceAgreementSalesShare · Max page size: 100
ServiceCase
Case
ServiceC R U D
Field Type Required Details
assignedToId Lookup Assigned To→ User · Filterable
caseTypeId Lookup Case Type→ ServiceCaseType · Filterable
channel Option ChannelOptions: CaseChannel · Filterable
companyId Lookup Company→ Company · Filterable
contactId Lookup Contact→ Contact · Filterable
deadline Date DeadlineFilterable
description Text DescriptionMax length: 4000 · Filterable
externalId String External IDMax length: 200 · Filterable
followUpDate Date Follow-up DateFilterable
followUpNote String Follow-up NoteMax length: 500 · 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
invoiceId Lookup Invoice→ Invoice · Filterable
name String TitleMax length: 200 · Searchable · Filterable
ownerId PolymorphicLookup OwnerFilterable
priority Option PriorityOptions: CasePriority · Filterable
productId Lookup Product→ Product · Filterable
queueId Lookup Queue→ ServiceQueue · Filterable
resolution Text ResolutionMax length: 4000 · Filterable
resolvedAt DateTime Resolved OnFilterable
status Option StatusOptions: CaseStatus · Filterable
visibleOnPortal Boolean Visible on portalFilterable
workAreaId Lookup Work Area→ WorkArea · Filterable
workGroupId Lookup Work Group→ WorkGroup · Filterable
caseNumbersystem Integer Case NumberFilterable
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
formIdsystem Lookup Web Form→ LeadCaptureForm · Filterable
idsystem Lookup IDFilterable · Read-only via API
ownerBusinessUnitIdsystem Lookup Owning Business Unit→ BusinessUnit · Filterable
ownerTypesystem String Owner TypeFilterable
portalLastViewedAtsystem DateTime Last read on portalFilterable
portalUserIdsystem Lookup Portal customer→ PortalUser · Filterable
rowVersionsystem Integer Row VersionFilterable · Read-only via API
tenantIdsystem Lookup TenantFilterable · Read-only via API
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem 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 Required Details
description Text DescriptionMax length: 2000 · Filterable
externalId String External IDMax length: 200 · Filterable
isActive Boolean ActiveFilterable
isComplaint Boolean Complaint typeFilterable
name String NameMax length: 200 · Searchable · Filterable
ownerId PolymorphicLookup OwnerFilterable
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
idsystem Lookup IDFilterable · Read-only via API
ownerBusinessUnitIdsystem Lookup Owning Business Unit→ BusinessUnit · Filterable
ownerTypesystem String Owner TypeFilterable
rowVersionsystem Integer Row VersionFilterable · Read-only via API
tenantIdsystem Lookup TenantFilterable · Read-only via API
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem 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 Required 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
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
idsystem Lookup IDFilterable · Read-only via API
ownerBusinessUnitIdsystem Lookup Owning Business Unit→ BusinessUnit · Filterable
ownerTypesystem String Owner TypeFilterable
rowVersionsystem Integer Row VersionFilterable · Read-only via API
tenantIdsystem Lookup TenantFilterable · Read-only via API
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem 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 Required 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
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
idsystem Lookup IDFilterable · Read-only via API
quantityOnHandsystem Decimal On HandFilterable
rowVersionsystem Integer Row VersionFilterable · Read-only via API
tenantIdsystem Lookup TenantFilterable · Read-only via API
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem 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 Required 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
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
idsystem Lookup IDFilterable · Read-only via API
ownerBusinessUnitIdsystem Lookup Owning Business Unit→ BusinessUnit · Filterable
ownerTypesystem String Owner TypeFilterable
rowVersionsystem Integer Row VersionFilterable · Read-only via API
tenantIdsystem Lookup TenantFilterable · Read-only via API
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem 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 Required 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
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
idsystem Lookup IDFilterable · Read-only via API
materialUsageIdsystem Lookup Material Usage→ MaterialUsage · Filterable
ownerBusinessUnitIdsystem Lookup Owning Business Unit→ BusinessUnit · Filterable
ownerTypesystem String Owner TypeFilterable
rowVersionsystem Integer Row VersionFilterable · Read-only via API
tenantIdsystem Lookup TenantFilterable · Read-only via API
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem 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 Required 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
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
idsystem Lookup IDFilterable · Read-only via API
ownerBusinessUnitIdsystem Lookup Owning Business Unit→ BusinessUnit · Filterable
ownerTypesystem String Owner TypeFilterable
rowVersionsystem Integer Row VersionFilterable · Read-only via API
tenantIdsystem Lookup TenantFilterable · Read-only via API
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem Lookup Modified By→ User · Filterable · Read-only via API
Excluded from API: tenantId
API route: /api/v1/SubTask · Max page size: 100
Team
Team
Settingsmanager+C R U D
Field Type Required 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
businessUnitIdsystem Lookup Business Unit→ BusinessUnit · Filterable
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
idsystem Lookup IDFilterable · Read-only via API
rowVersionsystem Integer Row VersionFilterable · Read-only via API
tenantIdsystem Lookup TenantFilterable · Read-only via API
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem 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 Required Details
allowedEntityTypes String Allowed Entity TypesMax length: 1000 · Filterable
expiresAt DateTime Expires AtFilterable
externalId String External IDMax length: 200 · Filterable
hasHrAccess Boolean HR accessFilterable
name String NameMax length: 200 · Filterable
role String RoleMax length: 50 · Filterable
status Option StatusOptions: ApiKeyStatus · Filterable
apiKeysystem String API KeyFilterable
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
idsystem Lookup IdRead-only via API
keyHashsystem String Key HashFilterable
keyPrefixsystem String Key PrefixFilterable
lastUsedAtsystem DateTime Last UsedFilterable
rowVersionsystem Integer Row VersionRead-only via API
tenantIdsystem Lookup TenantRead-only via API
updatedAtsystem DateTime Updated AtRead-only via API
updatedBysystem Lookup Updated ByRead-only via API
usageCountsystem 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 Required Details
companyId Lookup Company→ Company · Filterable
contactId Lookup Contact→ Contact · Filterable
date Date 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 User→ User · Filterable
payTypeId Lookup Pay Type→ PayType · Filterable
regardingId PolymorphicLookup RegardingFilterable
startTime Time Start TimeFilterable
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
idsystem Lookup IDFilterable · Read-only via API
invoiceLineIdsystem Lookup Invoice Line→ InvoiceLine · Filterable
isReconciledsystem Boolean ReconciledFilterable
ownerBusinessUnitIdsystem Lookup Owning Business Unit→ BusinessUnit · Filterable
ownerTypesystem String Owner TypeFilterable
reconciledAtsystem DateTime Reconciled OnFilterable
regardingTypesystem String Regarding TypeMax length: 100 · Filterable
rowVersionsystem Integer Row VersionFilterable · Read-only via API
tenantIdsystem Lookup TenantFilterable · Read-only via API
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem 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 Required 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
componentCodesystem String Component CodeFilterable
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
granularitysystem Integer GranularityFilterable
idsystem Lookup IDFilterable · Read-only via API
inputTypesystem Integer Input TypeFilterable
payTypeIdsystem Lookup Payroll Code→ PayType · Filterable
rowVersionsystem Integer Row VersionFilterable · Read-only via API
sortOrdersystem Integer Sort OrderFilterable
sourcesystem Integer SourceFilterable
tenantIdsystem Lookup TenantFilterable · Read-only via API
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem 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 Required 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
agreementVersionIdsystem Lookup Agreement VersionFilterable
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
idsystem Lookup IDFilterable · Read-only via API
ownerBusinessUnitIdsystem Lookup Owning Business Unit→ BusinessUnit · Filterable
ownerTypesystem String Owner TypeFilterable
rowVersionsystem Integer Row VersionFilterable · Read-only via API
submittedAtsystem DateTime Submitted OnFilterable
tenantIdsystem Lookup TenantFilterable · Read-only via API
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem 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 Required 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
regardingType String Regarding TypeMax length: 100 · Filterable
source String SourceMax length: 100 · Searchable · Filterable
url String URLMax length: 2000 · Filterable
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
idsystem Lookup IDFilterable · Read-only via API
rowVersionsystem Integer Row VersionFilterable · Read-only via API
tenantIdsystem Lookup TenantFilterable · Read-only via API
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem Lookup Modified By→ User · Filterable · Read-only via API
Excluded from API: tenantId
API route: /api/v1/TrackingEvent · Max page size: 100
User
User
ProjectManagementHRmanager+C R U D
Field Type Required 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
apprenticeshipEndDatesystem DateTime Apprenticeship End Date
businessUnitIdsystem Lookup Business Unit
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
dateOfBirthsystem DateTime Date Of Birth
emailsystem String EmailMax length: 320 · Searchable · Filterable
externalIdsystem String External
idsystem Lookup IDFilterable · Read-only via API
isHrsystem Boolean Is Hr
localesystem String Locale
mergedIntoIdsystem Lookup Merged Into→ User · Filterable
ownerBusinessUnitIdsystem Lookup Business Unit→ BusinessUnit · Filterable
ownerIdsystem PolymorphicLookup OwnerFilterable
ownerTypesystem String Owner TypeFilterable
rowVersionsystem Integer Row VersionFilterable · Read-only via API
tenantIdsystem Lookup TenantFilterable · Read-only via API
terminationDatesystem DateTime Termination Date
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem 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 Required 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
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
idsystem Lookup IDFilterable · Read-only via API
ownerBusinessUnitIdsystem Lookup Business Unit→ BusinessUnit · Filterable
ownerTypesystem String Owner TypeFilterable
rowVersionsystem Integer Row VersionFilterable · Read-only via API
tenantIdsystem Lookup TenantFilterable · Read-only via API
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem Lookup Modified By→ User · Filterable · Read-only via API
Excluded from API: tenantId
API route: /api/v1/WorkArea · Max page size: 100
Workflow
Workflow
Settingsadmin+C R U D
Field Type Required 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
consecutiveFailuressystem Integer Consecutive failuresFilterable
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
disabledReasonsystem String Disabled reasonMax length: 500 · Filterable
idsystem Lookup IDFilterable · Read-only via API
lastRunAtsystem DateTime Last runFilterable
ownerBusinessUnitIdsystem Lookup Owning Business Unit→ BusinessUnit · Filterable
ownerTypesystem String Owner TypeFilterable
rowVersionsystem Integer Row VersionFilterable · Read-only via API
tenantIdsystem Lookup TenantFilterable · Read-only via API
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem 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 Required 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
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
idsystem Lookup IDFilterable · Read-only via API
rowVersionsystem Integer Row VersionFilterable · Read-only via API
tenantIdsystem Lookup TenantFilterable · Read-only via API
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem 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 Required 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
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
idsystem Lookup IDFilterable · Read-only via API
isExitConditionsystem Boolean Is Exit Condition
rowVersionsystem Integer Row VersionFilterable · Read-only via API
tenantIdsystem Lookup TenantFilterable · Read-only via API
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem 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 Required Details
externalId String External IDMax length: 200 · Filterable
actionsExecutedsystem Integer Actions executedFilterable
completedAtsystem DateTime CompletedFilterable
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
depthsystem Integer DepthFilterable
durationMssystem Integer Duration (ms)Filterable
errorsystem Text ErrorFilterable
idsystem Lookup IDFilterable · Read-only via API
rowVersionsystem Integer Row VersionFilterable · Read-only via API
startedAtsystem DateTime StartedFilterable
statussystem Integer StatusFilterable
tenantIdsystem Lookup TenantFilterable · Read-only via API
triggerEntityTypesystem String EntityMax length: 100 · Filterable
triggerRecordIdsystem Lookup RecordFilterable
triggerSourcesystem Integer SourceFilterable
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem Lookup Modified By→ User · Filterable · Read-only via API
workflowIdsystem Lookup Workflow→ Workflow · Filterable
workflowNamesystem 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 Required 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
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
idsystem Lookup IDFilterable · Read-only via API
ownerBusinessUnitIdsystem Lookup Business Unit→ BusinessUnit · Filterable
ownerTypesystem String Owner TypeFilterable
rowVersionsystem Integer Row VersionFilterable · Read-only via API
tenantIdsystem Lookup TenantFilterable · Read-only via API
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem 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 Required 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
category Option CategoryOptions: WorkTaskCategory · 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
serviceAgreementLineId Lookup Service Line→ ServiceAgreementLine · Filterable
status Option StatusOptions: WorkTaskStatus · Filterable
syncResourceBookings Boolean Sync Resource BookingsFilterable
transactionCurrencyId Lookup Currency→ Currency · Filterable
visibleOnPortal Boolean Visible on portalFilterable
visitCoverage Option Billing CoverageOptions: VisitCoverage · Filterable
workAreaId Lookup Work Area→ WorkArea · Filterable
workGroupId Lookup Work Group→ WorkGroup · Filterable
createdAtsystem DateTime Created OnFilterable · Read-only via API
createdBysystem Lookup Created By→ User · Filterable · Read-only via API
idsystem Lookup IDFilterable · Read-only via API
netAmountsystem Currency Net AmountFilterable
ownerBusinessUnitIdsystem Lookup Owning Business Unit→ BusinessUnit · Filterable
ownerTypesystem String Owner TypeFilterable
portalLastViewedAtsystem DateTime Last read on portalFilterable
portalUserIdsystem Lookup Portal customer→ PortalUser · Filterable
primaryResourceBookingIdsystem Lookup Primary Resource Booking→ ResourceBooking · Filterable
regardingTypesystem String Regarding TypeMax length: 100 · Filterable
rowVersionsystem Integer Row VersionFilterable · Read-only via API
tenantIdsystem Lookup TenantFilterable · Read-only via API
totalExpensessystem Currency Total ExpensesFilterable
totalRevenuesystem Currency Total RevenueFilterable
updatedAtsystem DateTime Modified OnFilterable · Read-only via API
updatedBysystem Lookup Modified By→ User · Filterable · Read-only via API
Excluded from API: tenantId
API route: /api/v1/WorkTask · Max page size: 2000

Option sets

Pick-list values used by Option-type fields. The integer value is stored in the database; labels are resolved at the API/UI layer.

AbsenceEntitlementType
AbsenceEntitlement.bookingType
Value Name Label Active
1 Work Work
2 Vacation Vacation
3 Sick Sick
4 School School
5 Parental Parental Leave
6 Compensation Compensation
7 Other Other
AccountTypeCategory
AccountType.category
Value Name Label Active
1 Revenue Revenue
2 Expense Expense
ActionItemType
ActionItem.actionType
Value Name Label Active
0 Task Task
1 Meeting Meeting
2 Email Email
3 Opportunity Opportunity
ActivityPriority
Activity.priority
Value Name Label Active
1 Low Low
2 Normal Normal
3 High High
ActivityStatus
Activity.status
Value Name Label Active
1 Planned Planned
2 Completed Completed
3 Received Received
4 Draft Draft
5 Sent Sent
ActivityType
Activity.type
Value Name Label Active
1 Task Task
2 Call Phone Call
3 Meeting Meeting
4 Email Email
5 Note Note
6 PortalMessage Portal Message
AgreementBillingFrequency
ServiceAgreement.billingFrequency
Value Name Label Active
1 Monthly Monthly
2 Quarterly Quarterly
3 Yearly Yearly
99 Variable Variable
AgreementCancellationReason
ServiceAgreement.cancellationReason
Value Name Label Active
1 Price Price
2 Competitor Went to a competitor
3 NoLongerNeeded No longer needed
4 Dissatisfied Dissatisfied
5 CustomerClosed Customer closed down
6 Other Other
AgreementLocalComponentGranularity
AgreementLocalComponent.granularity
Value Name Label Active
1 Week Per week
2 Day Per day
AgreementLocalComponentInputType
AgreementLocalComponent.inputType
Value Name Label Active
1 Hours Hours
2 Amount Amount
3 Checkbox Checkbox
4 Text Free text
5 Option Option list
AgreementTemplateComponentGranularity
AgreementTemplateComponent.granularity
Value Name Label Active
1 Week Per week
2 Day Per day
AgreementTemplateComponentInputType
AgreementTemplateComponent.inputType
Value Name Label Active
1 Hours Hours
2 Amount Amount
3 Checkbox Checkbox
4 Text Free text
5 Option Option list
AgreementTemplateVersionCadence
AgreementTemplateVersion.cadence
Value Name Label Active
1 Week Per week
2 Day Per day
AllocationPeriodType
Project.periodType
Value Name Label Active
1 Week Week
2 Month Month
ApiKeyStatus
TenantApiKey.status
Value Name Label Active
1 Active Active
2 Revoked Revoked
ApplicationOrigin
JobApplication.origin
Value Name Label Active
1 Applied Applied
2 Sourced Sourced
ApplicationStage
JobApplication.stage
Value Name Label Active
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 Active
1 General General
2 FAQ FAQ
3 Troubleshooting Troubleshooting
4 HowTo How-To
5 Policy Policy
ArticleStatus
KnowledgeArticle.status
Value Name Label Active
1 Draft Draft
2 Published Published
3 Archived Archived
AssetStatus
Asset.status
Value Name Label Active
1 Active Active
2 Retired Retired
AssetType
Asset.assetType
Value Name Label Active
1 Equipment Equipment
2 Installation Installation
3 Vehicle Vehicle
4 Software Software
5 Other Other
BillingPeriod
ServiceAgreementBillingLine.billingPeriod
Value Name Label Active
1 Monthly Monthly
2 Quarterly Quarterly
3 Yearly Yearly
BillingPeriodAllowance
ServiceAgreementLine.includedPeriod
Value Name Label Active
1 Monthly Monthly
2 Quarterly Quarterly
3 Yearly Yearly
BillingPeriodProduct
Product.recurringBillingPeriod
Value Name Label Active
1 Monthly Monthly
2 Quarterly Quarterly
3 Yearly Yearly
BillingPeriodProductAllowance
Product.includedPeriod
Value Name Label Active
1 Monthly Monthly
2 Quarterly Quarterly
3 Yearly Yearly
BonusBasis
BonusRule.basis
Value Name Label Active
1 Revenue Paid revenue
2 OpportunityValue Opportunity value
BookingStatus
ResourceBooking.status
Value Name Label Active
1 Planned Planned
2 Confirmed Confirmed
3 Cancelled Cancelled
BookingType
ResourceBooking.bookingType
Value Name Label Active
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 Active
1 Record Record
2 Template Template
BulkEmailStatus
BulkEmail.status
Value Name Label Active
1 Draft Draft
2 Scheduled Scheduled
3 Sending Sending
4 Sent Sent
5 Failed Failed
CalculatedFieldFormat
CalculatedField.format
Value Name Label Active
0 Number Number
1 Currency Currency
2 Percentage Percentage
CallReason
Activity.callReason
Value Name Label Active
1 TooExpensive Too expensive
2 NoNeed No need
3 AlreadyCovered Already covered
6 VoicemailLeft Voicemail left
7 NoVoicemail No voicemail
CallResult
Activity.callResult
Value Name Label Active
1 Interested Interested
2 NotInterested Not interested
3 CallBack Call back later
4 NoAnswer No answer
CampaignStatus
Campaign.status
Value Name Label Active
1 Planned Planned
2 Active Active
3 Completed Completed
4 Cancelled Cancelled
CampaignType
Campaign.type
Value Name Label Active
1 Email Email
2 Event Event
3 Webinar Webinar
4 Advertising Advertising
5 Content Content
6 Telemarketing Telemarketing
7 TradeFair Trade fair
99 Other Other
CandidateRating
JobApplication.rating
Value Name Label Active
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 Active
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 Active
1 Lead Lead
2 ServiceCase Service Case
CaseChannel
ServiceCase.channel
Value Name Label Active
1 Phone Phone
2 Email Email
3 Web Web
4 InPerson In person
5 Letter Letter
CasePriority
ServiceCase.priority
Value Name Label Active
1 Low Low
2 Normal Normal
3 High High
4 Critical Critical
CaseStatus
ServiceCase.status
Value Name Label Active
1 New New
2 InProgress In Progress
3 WaitingOnCustomer Waiting on Customer
4 WaitingOnThirdParty Waiting on Third Party
5 Resolved Resolved
6 Cancelled Cancelled
CompanyStatus
Company.status
Value Name Label Active
1 Active Active
2 Inactive Inactive
CompanyType
Company.companyType
Value Name Label Active
2 Prospect Prospect
3 Customer Customer
4 ExCustomer Ex-Customer
5 Partner Partner
6 Supplier Supplier
7 Vendor Vendor
8 Other Other
CompetitorThreatLevel
Competitor.threatLevel
Value Name Label Active
1 Low Low
2 Medium Medium
3 High High
ConditionField
CaseRoutingCondition.field
Value Name Label Active
1 Priority Priority
2 CaseType Case Type
3 Company Company
ContactStatus
Contact.status
Value Name Label Active
1 Active Active
2 Inactive Inactive
ContractStatus
Contract.status
Value Name Label Active
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 Active
1 Amount Amount
2 Percentage Percentage
DocumentType
GeneratedDocument.documentType
Value Name Label Active
1 Generated Generated
2 Uploaded Uploaded
EmailSuppressionReason
EmailSuppression.reason
Value Name Label Active
1 Unsubscribed Unsubscribed
2 HardBounce Hard bounce
3 Complaint Spam complaint
4 ManuallyBlocked Blocked manually
5 ProviderSuppressed Blocked by provider
EmployeeChecklistType
EmployeeChecklistItem.checklistType
Value Name Label Active
1 Onboarding Onboarding
2 Offboarding Offboarding
EmploymentType
JobPosting.employmentType
Value Name Label Active
1 FullTime Full-time
2 PartTime Part-time
3 Temporary Temporary
4 Contract Contract
5 Internship Internship
EquipmentStatus
Equipment.status
Value Name Label Active
1 Active Active
2 OutOfService Out of service
3 InMaintenance In maintenance
4 Retired Retired
EquipmentType
Equipment.equipmentType
Value Name Label Active
1 Vehicle Vehicle
2 Tool Tool
3 Machine Machine
4 Other Other
ExpenseCategory
Expense.category
Value Name Label Active
1 Materials Materials
2 Travel Travel
3 Subcontractor Subcontractor
4 Equipment Equipment
5 Other Other
ExpenseStatus
Expense.status
Value Name Label Active
1 Active Active
2 Archived Archived
3 Cancelled Cancelled
GoalMetric
Goal.metric
Value Name Label Active
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 Active
0 Year Year
1 FiscalYear Fiscal Year
2 Month Month
3 Quarter Quarter
4 FiscalQuarter Fiscal Quarter
InboundWebhookStatus
InboundWebhookEvent.status
Value Name Label Active
1 Received Received
2 Processed Processed
3 Failed Failed
Industry
Global
Value Name Label Active
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 Active
1 Pass Pass
2 Fail Fail
3 NotApplicable Not applicable
InspectionResultType
InspectionTemplateLine.resultType
Value Name Label Active
1 PassFail Pass / fail
2 Checkbox Checkbox
3 Number Number
4 Text Text
InspectionResultTypeLine
InspectionLine.resultType
Value Name Label Active
1 PassFail Pass / fail
2 Checkbox Checkbox
3 Number Number
4 Text Text
InspectionStatus
Inspection.status
Value Name Label Active
1 NotStarted Not started
2 InProgress In progress
3 Completed Completed
IntakeCompanyAction
Lead.companyAction
Value Name Label Active
1 UseExisting Use Existing
2 CreateNew Create New
3 DoNotCreate Do Not Create
IntakeContactAction
Lead.contactAction
Value Name Label Active
1 UseExisting Use Existing
2 CreateNew Create New
3 DoNotCreate Do Not Create
IntakeOpportunityAction
Lead.opportunityAction
Value Name Label Active
1 CreateNew Create New
2 DoNotCreate Do Not Create
InvoiceStage
Invoice.stage
Value Name Label Active
1 Draft Draft
2 Active Active
3 Paid Paid
4 Cancelled Cancelled
JobPostingStatus
JobPosting.status
Value Name Label Active
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 Active
1 None No Committed Budget
2 MayBuy May Buy
3 CanBuy Can Buy
4 WillBuy Will Buy
LeadCaptureFormStatus
LeadCaptureForm.status
Value Name Label Active
1 Active Active
2 Inactive Inactive
LeadEngagementReason
Lead.engagementReason
Value Name Label Active
1 TooExpensive Too expensive
2 NoNeed No need
3 AlreadyCovered Already covered
4 UsesCompetitor Uses a competitor
5 BudgetNextPeriod Budget next period
6 AwaitingDecision Awaiting internal decision
7 BadTiming Timing not right
8 NoResponse No response
9 WrongDetails Wrong contact details
10 Gatekeeper Blocked by gatekeeper
11 MeetingBooked Meeting booked
12 ProposalSent Proposal sent
13 InNegotiation In negotiation
LeadEngagementStatus
Lead.engagementStatus
Value Name Label Active
1 NoInterestNow No interest now
2 Postponed Postponed
3 NoContact No contact
4 ActiveDialogue Active dialogue
LeadFormType
Lead.formType
Value Name Label Active
1 Contact Contact
2 Support Support
3 Enquiry Enquiry
LeadNeed
Lead.need
Value Name Label Active
1 MustHave Must Have
2 ShouldHave Should Have
3 GoodToHave Good to Have
4 NoNeed No Need
LeadPriority
Lead.priority
Value Name Label Active
1 Low Low
2 Medium Medium
3 High High
4 Critical Critical
LeadRating
Lead.rating
Value Name Label Active
1 Hot Hot
2 Warm Warm
3 Cold Cold
4 Untapped Untapped
LeadSource
Global
Value Name Label Active
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 Active
1 Active Active
2 Qualified Qualified
3 Disqualified Disqualified
LostReason
Opportunity.lostReason
Value Name Label Active
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 Active
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 Active
1 Qualification Qualification
2 Proposal Proposal
3 Negotiation Negotiation
100 Won Won
200 Lost Lost
OpportunityType
Opportunity.type
Value Name Label Active
1 NewBusiness New Business
2 ExistingCustomer Existing Customer
3 Renewal Renewal
4 Upsell Upsell
OverageBilling
ServiceAgreementLine.overageBilling
Value Name Label Active
1 Immediately Immediately
2 Monthly Monthly
3 Quarterly Quarterly
4 Yearly Yearly
OverageBillingProduct
Product.overageBilling
Value Name Label Active
1 Immediately Immediately
2 Monthly Monthly
3 Quarterly Quarterly
4 Yearly Yearly
ParticipationTypeMask
ActivityParticipant.participationTypeMask
Value Name Label Active
1 From From
2 To To
3 CC CC
4 BCC BCC
5 Required Required
6 Optional Optional
7 Organizer Organizer
PaymentAgreementStatus
PaymentAgreement.status
Value Name Label Active
1 Pending Pending
2 Active Active
3 Cancelled Cancelled
4 Rejected Rejected
PaymentCollectionMethod
PaymentRequest.method
Value Name Label Active
1 Betalingsservice Betalingsservice
2 Leverandorservice Leverandørservice
3 Card Payment card
4 MobilePay MobilePay
5 PaymentSlip Payment slip
6 BankTransfer Bank transfer
PaymentRequestStatus
PaymentRequest.status
Value Name Label Active
1 Created Created
2 Sent Sent
3 Paid Paid
4 RejectedByCustomer Rejected by customer
5 Failed Failed
6 Reversed Reversed
7 Refunded Refunded
8 Cancelled Cancelled
PortalUserScope
PortalUser.scope
Value Name Label Active
1 OwnRecordsOnly Own tickets only
2 WholeCompany All the company's tickets
PreferredContactMethod
Global
Value Name Label Active
1 Email Email
2 Phone Phone
3 Mail Mail
4 Any Any
ProjectActivityPriority
ProjectActivity.priority
Value Name Label Active
1 Low Low
2 Normal Normal
3 High High
4 Critical Critical
ProjectActivityStatus
ProjectActivity.status
Value Name Label Active
1 Planning Planning
2 Active Active
3 OnHold On Hold
4 Completed Completed
5 Cancelled Cancelled
ProjectPriority
Project.priority
Value Name Label Active
1 Low Low
2 Normal Normal
3 High High
4 Critical Critical
ProjectStatus
Project.status
Value Name Label Active
1 Planning Planning
2 Active Active
3 OnHold On Hold
4 Completed Completed
5 Cancelled Cancelled
PublicCompanyIdentifierType
Company.publicCompanyIdentifierType
Value Name Label Active
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 Active
1 Individual Individual
2 Committee Committee
3 Unknown Unknown
PurchaseTimeframe
Lead.purchaseTimeframe
Value Name Label Active
1 Immediate Immediate
2 ThisQuarter This Quarter
3 NextQuarter Next Quarter
4 ThisYear This Year
5 Unknown Unknown
QuoteStage
Quote.stage
Value Name Label Active
1 Draft Draft
2 Sent Sent
3 Accepted Accepted
4 Rejected Rejected
RecipientListMemberStatus
RecipientListMember.status
Value Name Label Active
1 Active Active
2 Unsubscribed Unsubscribed
3 Bounced Bounced
RecipientListStatus
RecipientList.status
Value Name Label Active
1 Active Active
2 Inactive Inactive
RecurrenceEndMode
ServiceAgreementLine.endMode
Value Name Label Active
1 Never No end date
2 AfterOccurrences End after N occurrences
3 OnDate End by date
RecurrenceFrequency
ServiceAgreementLine.frequency
Value Name Label Active
1 Daily Daily
2 Weekly Weekly
3 Monthly Monthly
4 Yearly Yearly
RecurrenceMonthlyMode
ServiceAgreementLine.monthlyMode
Value Name Label Active
1 DayOfMonth On day of month
2 DayOfWeek On the …
RecurrenceOrdinal
ServiceAgreementLine.ordinal
Value Name Label Active
1 First First
2 Second Second
3 Third Third
4 Fourth Fourth
5 Last Last
RevenueStatus
Revenue.status
Value Name Label Active
1 Active Active
2 Archived Archived
3 Cancelled Cancelled
RevenueType
Quote.revenueType
Value Name Label Active
1 Entered Entered
2 Calculated Calculated
SalesMaterialCategory
SalesMaterial.category
Value Name Label Active
1 Brochure Brochure
2 Presentation Presentation
3 PriceList Price list
4 PointOfSale Point of sale
5 Sample Sample
6 TradeFair Trade fair
7 Giveaway Giveaway
SalesMaterialHandoutStatus
SalesMaterialHandout.status
Value Name Label Active
1 Delivered Delivered
2 Returned Returned
3 Lost Lost
SalesMaterialKind
SalesMaterial.kind
Value Name Label Active
1 Digital Digital
2 Consumable Consumable
3 Durable Durable item
SegmentStatus
Segment.status
Value Name Label Active
1 Active Active
2 Inactive Inactive
ServiceAgreementChargeType
ServiceAgreementBillingLine.chargeType
Value Name Label Active
1 Recurring Recurring
2 PerVisit Per visit
3 OneTime One-time
ServiceAgreementStatus
ServiceAgreement.status
Value Name Label Active
1 Draft Draft
2 Active Active
3 Paused Paused
4 Expired Expired
5 Cancelled Cancelled
SignerStatus
ContractSigner.status
Value Name Label Active
1 Pending Pending
2 Sent Sent
3 Opened Opened
4 Signed Signed
5 Rejected Rejected
StockLocationType
StockLocation.locationType
Value Name Label Active
1 Main Main warehouse
2 Vehicle Vehicle
3 Other Other
StockMovementType
StockMovement.movementType
Value Name Label Active
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 Active
1 NotStarted Not Started
2 InProgress In Progress
3 Paused Paused
4 Completed Completed
SupportTicketPriority
SupportTicket.priority
Value Name Label Active
1 Low Low
2 Normal Normal
3 High High
SupportTicketStatus
SupportTicket.status
Value Name Label Active
1 New New
2 InProgress In Progress
3 Resolved Resolved
4 Closed Closed
TimeEntryType
TimeEntry.entryType
Value Name Label Active
1 Work Work
2 Travel Travel
3 Administrative Administrative
4 Break Break
5 Absence Absence
6 Vacation Vacation / Time off
7 Sick Sick leave
TimeSheetCadence
TimeSheet.cadence
Value Name Label Active
1 Week Per week
2 Day Per day
TimeSheetStatus
TimeSheet.status
Value Name Label Active
1 Draft Draft
2 Submitted Submitted
TrackingEventType
TrackingEvent.eventType
Value Name Label Active
1 PageView Page View
2 Click Click
3 FormSubmission Form Submission
4 EmailOpen Email Open
5 EmailClick Email Click
99 Custom Custom
UsageCapture
ServiceAgreementLine.usageCapture
Value Name Label Active
1 TimeEntries Time registrations
2 MaterialUsage Material usage
UsageSource
AgreementUsage.source
Value Name Label Active
1 Manual Registered by hand
2 TimeEntry Time registration
3 MaterialUsage Material usage
4 Integration Integration
UserType
User.userType
Value Name Label Active
0 None No License
1 FullUser Full User
2 FieldAgent Field Agent
VisitCoverage
WorkTask.visitCoverage
Value Name Label Active
1 AllBilled Everything billed
2 MaterialsBilled Materials billed
3 AllInclusive All inclusive
VisitCoverageAgreement
ServiceAgreementLine.visitCoverage
Value Name Label Active
1 AllBilled Everything billed
2 MaterialsBilled Materials billed
3 AllInclusive All inclusive
WebFormType
LeadCaptureForm.formType
Value Name Label Active
1 Contact Contact
2 Support Support
3 Enquiry Enquiry
Weekday
ServiceAgreementLine.ordinalWeekday
Value Name Label Active
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 Active
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
9 Wait Wait
WorkflowConditionLogic
Workflow.conditionLogic
Value Name Label Active
1 All All conditions (AND)
2 Any Any condition (OR)
WorkflowConditionOperator
WorkflowCondition.operator
Value Name Label Active
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 Active
1 Pending Pending
2 Running Running
3 Succeeded Succeeded
4 Failed Failed
5 Skipped Skipped
6 Waiting Waiting
WorkflowRunTriggerSource
WorkflowRun.triggerSource
Value Name Label Active
1 Event Event
2 Scheduled Scheduled
3 Manual Manual
WorkflowTriggerType
Workflow.triggerType
Value Name Label Active
1 Create Record created
2 Update Record updated
3 Delete Record deleted
4 Scheduled Scheduled (date-based)
WorkTaskCategory
WorkTask.category
Value Name Label Active
2 Vacation Vacation
3 Sick Sick
4 School School
5 Parental Parental Leave
6 Compensation Compensation
7 Other Other absence
WorkTaskPriority
WorkTask.priority
Value Name Label Active
1 Low Low
2 Normal Normal
3 High High
4 Critical Critical
WorkTaskStatus
WorkTask.status
Value Name Label Active
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

This documentation is auto-generated from the entity metadata registry.

Generated at 2026-10-06 02:37 UTC · 109 entities · 2305 fields

Rejoining the server...

Rejoin failed... trying again in seconds.

Failed to rejoin.
Please retry or reload the page.

The session has been paused by the server.

Failed to resume the session.
Please retry or reload the page.