Schemas

First day of the requested absence.

Last day of the requested absence. Must be on or after startDate.

ID of the associated AbsenceType record. The requested type of absence (e.g. vacation, sick leave).

ID of the associated User record. The employee requesting the absence.

ID of the associated User record. The admin or team manager who reviews the request. Defaults to the account owner if omitted on create.

Optional message from the sender explaining the request.

Optional message from the reviewer when approving or rejecting.

When the request was reviewed. Set automatically on update.

Approval state. Null while pending review.

Whether the requested absence covers a half-day or multiple full days. When set to ONE_DAY_HALF, startDate and endDate must be the same date.

ID of the associated User record

Number of overtime hours to adjust. Positive values reduce the balance; negative values credit overtime.

Internal monetary note. Only visible with remuneration permissions.

The date this overtime reduction applies to.

ID of the associated User record

ID of the associated User record. The employee this absence is recorded for.

First day of the absence. Must not be more than 400 days before endDate.

Last day of the absence. Must be on or after startDate, and the span must not exceed 400 days.

ID of the associated AbsenceType record. E.g. vacation, sick leave, home office. Determines the values of the read-only boolean flags on this record.

Whether the absence covers a half-day or multiple full days. When set to ONE_DAY_HALF, startDate and endDate must be the same date.

Deducted from the employee's vacation allowance. Inherited from the linked AbsenceType on create and when absenceType is changed; cannot be modified independently.

When true, the employee's expected hours are unaffected. When false, the employee's expected hours are reduced. Should be set to true for Home Office or travel-type absences where hours should still be logged. Inherited from the linked AbsenceType on create and when absenceType is changed; cannot be modified independently.

Salary continues to be paid. Should be true for virtually all absence types other than long-term illness or maternity/paternity leave. Inherited from the linked AbsenceType on create and when absenceType is changed; cannot be modified independently.

Reduces overtime balance. Should only be set for overtime-reduction type absences. Inherited from the linked AbsenceType on create and when absenceType is changed; cannot be modified independently.

Used for certain analytics regarding missing days. Should be true for illness-related absences. Inherited from the linked AbsenceType on create and when absenceType is changed; cannot be modified independently.

Optional external system identifier for integrations.

Display name of the absence type.

Color index for display.

Icon index for display.

1 = enabled, 0 = archived (hidden from clients).

Whether employees can select this type when submitting an absence request.

When false, the absenceType, timestamps, and boolean flags are hidden from users without absence reading permissions. Dates and user are always visible.

Default for Absence records. Deducted from the employee's vacation allowance.

Default for Absence records. When true, the employee's expected hours are unaffected; when false, expected hours are reduced. Should be true for Home Office or travel-type absences.

Default for Absence records. Salary continues to be paid. Should be true for virtually all absence types other than long-term illness or maternity/paternity leave.

Default for Absence records. Reduces overtime balance. Should only be true for overtime-reduction type absences.

Default for Absence records. Counts as a missing day in analytics. Should be true for illness-related absences.

System-defined category for built-in absence types (e.g. vacation, illness). Null for user-created types. Cannot be set or changed via the API.

Optional external system identifier for integrations.

Display name of the client.

1 = enabled, 0 = archived.

Short unique identifier. Auto-generated from the client name if not provided.

Optional external system identifier for integrations.

Default hourly rate for new projects created for this client.

How the client image is sourced: initials, Gravatar, or uploaded file.

Token for the uploaded client image. Managed by the image upload flow.

ID of the associated Client record

ID of the associated IntegrationService record. The external service (e.g. easybill, sevDesk).

The client's ID in the external service.

The type of entity this document is attached to. One of: user, project, client.

The ID of the entity (user, project, or client) this document is attached to.

ID of the associated User record

Display name of the document.

Controls whether a user-attached document (model=user) is visible to that user.

Arbitrary date associated with the document.

ID of the associated Project record

Whether this expense can be billed to the client.

Whether this expense counts towards the project budget. When false, the external price of the expense virtually increases the budget.

ID of the associated ExpenseCategory record

Internal cost amount (what the company pays).

External billing amount (what the client is charged).

Timestamp when this expense was billed. Automatically set when an invoice is created or when locked.

ID of the associated Invoice record. The invoice this expense was billed on, if any.

The date the expense was incurred.

Snapshot of the expense category percentage at the time this expense was created.

Whether the category is active (true) or archived (false).

One of: 'AMOUNT', 'PERCENT'. For AMOUNT categories, behavior depends on pricePerUnit: if set, expense amounts are derived from quantity * pricePerUnit; if null, amounts are entered freely.

Unit of measurement for this category (e.g. km, hours, pieces).

Legacy icon index.

Price per unit for AMOUNT categories. When set, expense amounts are derived from quantity * pricePerUnit. When null, expense amounts are entered freely.

Legacy color index.

Identifier for mapping to an external billing system.

How this category maps in external billing. One of: 'SERVICE', 'PRODUCT'.

When true, users can refine the computed amount on individual expenses. Mainly relevant for PERCENT categories.

Default percentage value for percent-type categories.

ID of the associated Project record

Invoice total.

Start of the billing period.

End of the billing period.

Timestamp when the invoice was issued.

One of: 'DUE', 'PAID', 'OVERDUE', 'AUTOMATIC'. AUTOMATIC means the payment status is retrieved from the external billing provider.

Date the invoice was paid. Automatically set when paymentStatus changes to PAID.

Identifier for mapping to an external billing system.

How this invoice maps in external billing. One of: 'SERVICE', 'PRODUCT'.

Whether the invoice is for an internal recipient.

Start of the effectiveness period — the date range during which the invoice is considered effective for accounting purposes. Independent of the billing period (startDate / endDate).

End of the effectiveness period.

ID of the associated Invoice record

ID of the associated IntegrationService record

ID of the associated UserIntegration record

ID of the associated Project record

Planned invoice date.

Planned invoice amount.

Approval status. One of: 'NOTAPPROVED', 'APPROVED'.

Timestamp when the planned invoice was approved.

ID of the associated User record. The user who approved this planned invoice.

ID of the associated Invoice record. The actual invoice created once this planned invoice is converted.

Determines how the invoice amount is calculated. One of: 'FIXED_AMOUNT', 'TIME_MATERIAL'.

Start of the billing period.

End of the billing period.

Identifier for mapping to an external billing system.

How this invoice maps in external billing. One of: 'SERVICE', 'PRODUCT'.

Whether the planned invoice will be for an internal recipient. Carried over to the actual invoice when this planned invoice is converted.

Start date of the assignment. Assignments on the same project for the same user cannot overlap.

End date of the assignment.

ID of the associated User record

ID of the associated Project record

Daily time allocation in seconds (max 86400). Applied only on the user's working days within startDate–endDate; non-working days (weekends per the user's schedule, public holidays, and full-day absences) are automatically skipped. A single assignment spanning a non-working day is correct — do not split into multiple assignments to avoid it.

Short unique identifier. Auto-generated from the project name if not provided.

Determines the source of the hourly rate for billing. 0=none, 1=client, 2=project, 3=user, 4=task.

Determines where the project budget is derived from. 0=effort (no budget), 1=total hours, 2=total amount, 3=per user, 4=per task.

Project-level hourly rate. Used when billBy=project, and for planning when the rate cannot be determined by the bill-by mode.

Project budget amount. Interpretation depends on budgetBy mode.

Project budget in hours. Interpretation depends on budgetBy mode.

ID of the associated Contact record. Primary contact for this project.

Timestamp when the project was completed or archived.

Time entry rounding direction. 0=none, 1=up, 2=down.

Time entry rounding granularity in minutes. 5, 15, 30, or 60.

User-selectable percentage (0-100) representing estimated project progress.

Project lifecycle state. 1=planning, 2=in progress, 3=completed, 4=pending, 5=deal.

Project health indicator. 0=none, 1=high, 2=medium, 3=low.

ID of the associated Client record

ID of the associated Color record

When true, this project is a container for sub-projects. Sub-projects inherit color and client from the parent.

ID of the associated Project record. The super project this sub-project belongs to.

Account-configurable custom field. The label and meaning are defined in account settings.

Account-configurable custom field. The label and meaning are defined in account settings.

Account-configurable custom field. The label and meaning are defined in account settings.

Account-configurable custom field. The label and meaning are defined in account settings.

Account-configurable custom field. The label and meaning are defined in account settings.

Account-configurable custom field. The label and meaning are defined in account settings.

Account-configurable custom field. The label and meaning are defined in account settings.

Account-configurable custom field. The label and meaning are defined in account settings.

Account-configurable custom field. The label and meaning are defined in account settings.

Account-configurable custom field. The label and meaning are defined in account settings.

Optional identifier for linking this project to an external system.

Weighting factor used in staff analytics metrics. Defaults based on account settings for billable/non-billable projects.

Project-specific comment/reference requirements. Overrides account settings when set; inherits from account settings when null.

Projected deal value. Coming soon.

Estimated probability of closing the deal (0-100). Coming soon.

ID of the associated Project record

Approval status. One of: 'NOTAPPROVED', 'APPROVED'. When APPROVED, no user may create new WORK entries against this (project, day), and every existing WORK entry on this (project, day) is also APPROVED. Lack of a ProjectDay record on a given day implies NOTAPPROVED.

ID of the associated User record. The user who approved this project day.

Timestamp when approved.

ID of the associated Project record

Short identifier. Auto-generated from the milestone name if not provided. Unlike other code properties, uniqueness is not enforced.

URL of the referenced item on the external platform.

Identifier of the referenced item on the external platform (e.g. a Jira issue key).

Full name of the referenced item on the external platform.

ID of the associated ReferenceFamily record

Platform-dependent scope (e.g. project, repository, board). Set automatically by clients and used for filtering.

Integration-specific metadata (e.g. labels, epic information).

ID of the referenced item in the external system.

Display name of the integration. Defaults to the platform name (e.g. Jira) if not provided.

The external platform. One of: 'jira', 'github', 'monday', 'gitlab', 'azure', 'clickup', 'asana', 'linear', 'youtrack'.

Base URL of the external platform instance.

Platform-specific configuration. Currently only used for Jira.

Whether this integration is active.

When true, Browser Extension users will automatically collect references as pages on the external platform are visited.

ID of the associated Project record

ID of the associated ReferenceFamily record

Filters the references from this family to a specific scope (e.g. a specific board or repository). Corresponds to the scope property on Reference records.

Additional filtering configuration (e.g. Jira labels or epics). Platform-specific.

Display name. Must be unique within the same type.

Reserved for future use with Skills. When null, this is a plain tag. When set, this is a skill of the specified type: 1=skill, 2=language, 3=certificate.

ID of the associated TagCategory record. Reserved for future use with Skills.

The ID of the entity this tag is assigned to.

The type of entity this tag is assigned to. One of: 'client', 'expense-category', 'project', 'skill-set', 'task', 'user'.

ID of the associated Tag record

Short unique identifier. Auto-generated from the task label if not provided.

Identifier for mapping to an external billing system.

Default hourly rate for this task. Copied to the TaskAssignment when associating this task with a project.

When true, this task is automatically added to newly created projects. At least one active task must be marked as favorite.

Whether time entries using this task are billable.

ID of the associated Color record

Optional label for display purposes, shown alongside the team name.

Not currently used.

Short identifier for the team. Not currently used.

When true, new users without a specified team are added to this team. The default team cannot be deleted.

ID of the associated User record. Cannot be changed after creation.

ID of the associated Team record. Cannot be changed after creation.

Reserved for future use.

Reserved for future use.

When true, this user can manage time entries for members of this team.

When true, this user can view time entries for members of this team.

When true, this user can approve work time for members of this team.

When true, this user can manage absences for members of this team.

When true, grants limited access to user data for members of this team.

When true, this is a guest membership. Guest assignments are used for granular cross-team permissions. Cannot be changed after creation.

When true, this user can view skill assignments for members of this team.

When true, this user can manage skill assignments for members of this team.

The date this time entry is recorded on.

ID of the associated User record

Type of entry. WORK: time on a specific project. WORKTIME: clock-in/clock-out presence for the day, independent of any project. BREAK: pause within a WORKTIME period. Cannot be changed after creation.

Start time (HH:mm). Used in start/end time timer mode and for WORKTIME/BREAK entries.

End time (HH:mm). Used in start/end time timer mode and for WORKTIME/BREAK entries.

Display order within the day. Required when the account-level AccountSetting.timerMode is DURATION (except for worktime entries that are not project time). Must be omitted when AccountSetting.timerMode is START_TIME_END_TIME unless the entry is a break.

ID of the associated Team record. The user's team at the time of creation. Auto-assigned from the user's primary team if not provided.

Actual tracked duration in seconds. In start/end time mode, computed from startTime and endTime.

Duration in seconds, rounded according to the project rounding settings. Computed automatically.

Manual override of the rounded duration in seconds for billing purposes. PM-only.

Reserved for future use.

Whether the timer is currently running.

ID of the associated Task record

ID of the associated Project record

ID of the associated Invoice record. The invoice this time entry was billed on. Set automatically when invoiced; cannot be set directly.

ID of the associated Reference record

Computed hourly rate based on the project's billBy mode. Recalculated on create and update.

Timestamp when this time entry was billed. Set when associated with an invoice, or can be set separately to mark an entry as locked.

Whether this time entry is billable. Computed from the task assignment and project billing configuration.

Approval status. One of: 'NOTSUBMITTED', 'SUBMITTED', 'REJECTED', 'APPROVED'.

Whether this time entry was previously rejected.

Timestamp of the first submission.

Hours after the user's grace period that this time entry was first submitted.

Timestamp when approved.

ID of the associated User record. The user who approved this time entry.

Optional identifier for linking this time entry to an external system.

ID of the associated Role record

User-level hourly rate. Used when the project's billBy mode is set to per-user.

JSON blob of client-side UI preferences.

Internal feature flags. Read-only.

Avatar source. 0=Gravatar, 1=upload, 2=initials.

Account invitation and password state. 0=needs set, 1=needs reset, 2=ok, 3=not invited, 4=not set.

Token for the uploaded avatar image. Read-only.

When true, this user can run multiple timers simultaneously.

When true, this user is automatically added to newly created projects.

Whether this user appears in the planner view.

Whether this user appears in the absence planner view.

HMAC hash of the user email. Used for third-party client identification.

ID of the associated User record. Default recipient for this user's absence requests. Reserved for expanded use in future approval features.

Identifier for mapping to an external billing system.

Optional identifier for linking this user to an external system.

Public holiday region code for this user, formatted as country, country/state, or country/state/region — for example DE (Germany), DE/BY (Bavaria), or DE/BY/A (Augsburg); a country code on its own yields national holidays. Changing this value regenerates the user's public-holiday-type absences from today onward to match the new region; absences dated before today are left in place. Setting it to an empty value leaves the user with no future public-holiday absences.

When true, the user's holidayRegion follows the account-level default — admin changes to the account default overwrite this user's region and regenerate their public-holiday absences accordingly. Setting holidayRegion directly on this user does not change this flag, so a user left at true will revert to the account default on the next default change.

When true, worktime tracking is enabled for this user.

Default work day start time for this user.

Default work day end time for this user.

Default break schedule. Used to pre-populate break entries for worktime tracking.

Whether overtime information is displayed for this user.

User-level SSO login provider overrides. Allows specific users to use email login when the account is restricted to SSO.

ID of the associated User record

ID of the associated IntegrationService record

API key or token for the integration service. Returned encrypted in find, decrypted in findOne.

Integration-specific configuration data. Must be a valid JSON string.

When true, indicates the API key needs to be updated by the user.

Salutation or honorific (e.g. Mr, Ms, Dr).

Job title or role at the client company.

Additional address line (e.g. apartment, suite, floor).

ISO 3166-1 alpha-2 country code.

ID of the associated Client record. The client this contact belongs to.

ID of the associated User record

Employment type. 0=employee (deprecated), 1=freelancer (deprecated), 2=former employee, 3=employee, 4=freelancer.

Start date of this employment period.

Employer contribution rate. Only visible to users with remuneration access.

Hourly cost. Used in profitability calculations as cost. Only visible to users with remuneration access.

Work hours mode. 0=fixed per day, 1=fixed per week, 2=flexible.

Weekly work hours. Used when workHoursType is fixed-per-week.

Scheduled work hours for Monday. Used when workHoursType is fixed-per-day.

Scheduled work hours for Tuesday. Used when workHoursType is fixed-per-day.

Scheduled work hours for Wednesday. Used when workHoursType is fixed-per-day.

Scheduled work hours for Thursday. Used when workHoursType is fixed-per-day.

Scheduled work hours for Friday. Used when workHoursType is fixed-per-day.

Scheduled work hours for Saturday. Used when workHoursType is fixed-per-day.

Scheduled work hours for Sunday. Used when workHoursType is fixed-per-day.

1 = enabled, 0 = archived.

Display sort order.

Display name of the color.

Legacy hex color code without the leading #. Official clients may override this value depending on light/dark mode.

ID of the associated IntegrationServiceType record

System role type. 0=custom, 1=default user, 2=root admin. The root admin role's permissions cannot be modified. Root admin and default user roles cannot be deleted.

ID of the associated Task record

ID of the associated Project record

Project-specific override of the task's billable flag.

Hourly rate applied to time entries when the project's billBy mode is set to per-task. Initialized from the task's default hourlyRate.

Budget hours allocated to this task on this project. Used when the project's budgetBy mode is set to per-task.

ID of the associated User record

ID of the associated Project record

Hourly rate applied to time entries when the project's billBy mode is set to per-user. Initialized from the user's default hourlyRate.

Budget hours allocated to this user on this project. Used when the project's budgetBy mode is set to per-user.

When true, grants the assigned user additional permissions to edit this project and its time entries, according to the user's role-level permissions.

When true, this user is designated as the project lead. Grants no extra permissions, but is displayed in the app and can be used for filtering and exporting.