@factorialco/api-client 3.0.0-beta.2026100101 → 3.0.0-beta.2026100103

package/dist/esm/generated/types.gen.d.ts

@@ -681,11 +681,11 @@ export type AttendanceEditTimesheetRequest = {
      */
     id: string;
     /**
-     * Status of the edit timesheet request
+     * Tri-state approval status — true = approved, false = rejected, null = pending approval
      */
     approved?: boolean;
     /**
-     * Type of the request
+     * What the request asks to do — one of `create_shift`, `update_shift`, `delete_shift`
      */
     request_type: 'create_shift' | 'delete_shift' | 'update_shift';
     /**
@@ -817,15 +817,45 @@ export type AttendanceOpenShift = {
     time_settings_break_configuration_id?: string;
 };
 export type AttendanceOvertimeRequest = {
+    /**
+     * Unique identifier of the overtime request
+     */
     id: string;
+    /**
+     * ID of the employee the overtime is for
+     */
     employee_id: string;
+    /**
+     * ID of the employee assigned to approve the request (null if unassigned)
+     */
     approver_id?: string;
+    /**
+     * ID of the employee who created the request
+     */
     author_id: string;
+    /**
+     * Approval status of the overtime request — one of `pending`, `approved`, `rejected`, `none`
+     */
     status: 'pending' | 'approved' | 'rejected' | 'none';
+    /**
+     * Free-text description of the overtime request
+     */
     description?: string;
+    /**
+     * Reason provided for the overtime
+     */
     reason?: string;
+    /**
+     * The day the overtime was (or will be) worked
+     */
     date: string;
+    /**
+     * Requested overtime amount in hundredths of an hour (e.g. 800 = 8 hours)
+     */
     hours_amount_in_cents: number;
+    /**
+     * When the request was created
+     */
     created_at?: string;
     approver: boolean;
     approver_full_name?: string;
@@ -867,7 +897,7 @@ export type AttendanceShift = {
      */
     date: string;
     /**
-     * Reference date for the shift
+     * The business day this shift is attributed to; can differ from `date` for overnight shifts that cross midnight
      */
     reference_date: string;
     /**
@@ -895,7 +925,7 @@ export type AttendanceShift = {
      */
     location_type?: 'office' | 'business_trip' | 'work_from_home';
     /**
-     * Indicates which worked part of the day
+     * Which half of the day the shift covers when it is a half-day — `beginning_of_day` or `end_of_day`; null for full-day shifts
      */
     half_day?: 'beginning_of_day' | 'end_of_day';
     /**
@@ -923,7 +953,7 @@ export type AttendanceShift = {
      */
     out_location_accuracy?: number;
     /**
-     * Indicates if the shift is workable
+     * Whether the shift counts as worked (workable) time rather than a break
      */
     workable?: boolean;
     /**
@@ -1264,7 +1294,7 @@ export type CompensationsConcept = {
      */
     id: string;
     /**
-     * The category of the concept
+     * The accounting category of the concept (e.g. `earnings_fixed_salary`, `deductions`)
      */
     category?: 'earnings_fixed_salary' | 'earnings_variable' | 'earnings_benefits_in_kind' | 'earnings_others' | 'deductions' | 'company_contribution' | 'summarized_values';
     /**
@@ -1296,14 +1326,26 @@ export type CompensationsConcept = {
      */
     unit_name?: string;
     /**
-     * The type of the unit of the concept
+     * What the concept's amount is measured in (e.g. `money`, a quantity of units)
      */
     unit_type?: 'distance' | 'money' | 'time' | 'unit';
 };
 export type ContractsCompensation = {
+    /**
+     * Unique identifier of the compensation
+     */
     id: string;
+    /**
+     * ID of the contract version this compensation belongs to
+     */
     contract_version_id: string;
+    /**
+     * ID of the contracts taxonomy categorising this compensation
+     */
     contracts_taxonomy_id: string;
+    /**
+     * Free-text description of the compensation
+     */
     description?: string;
     /**
      * Required field. You can only use the following options: fixed, undefined, up_to, per_worked_day, per_worked_hour
@@ -1323,6 +1365,9 @@ export type ContractsCompensation = {
      * How much time will pass between payments. If recurrence is empty, assume months. For example, 12 here means compensation is paid yearly
      */
     recurrence_count?: number;
+    /**
+     * Date from which this compensation applies
+     */
     starts_on?: string;
     /**
      * Frequency (monthly, yearly, one_time) to determine how often the employee is paid. Could be empty, use `recurrence_count` in that case
@@ -1336,6 +1381,9 @@ export type ContractsCompensation = {
      * Human-readable hint about the payroll formula used (for example "current period" or "average of last 3 months")
      */
     calculation?: string;
+    /**
+     * ISO 4217 currency code the amount is expressed in
+     */
     currency?: string;
     time_condition?: 'full_day' | 'half_day' | 'custom';
     minimum_amount_of_hours?: number;
@@ -4285,11 +4333,11 @@ export type JobCatalogLevel = {
      */
     role_name: string;
     /**
-     * Order of the level.
+     * Sort order of the level within its role (lower is more junior).
      */
     order: number;
     /**
-     * Shows if the role is archived.
+     * Whether this level is archived.
      */
     archived: boolean;
     /**
@@ -4409,51 +4457,51 @@ export type JobCatalogNode = {
 };
 export type LocationsLocation = {
     /**
-     * identifier of the location
+     * Unique identifier of the workplace
      */
     id: string;
     /**
-     * company identifier
+     * ID of the company this workplace belongs to
      */
     company_id: string;
     /**
-     * name of the location
+     * Human-readable name of the workplace (e.g. "Barcelona Office")
      */
     name: string;
     /**
-     * timezone of the location
+     * IANA timezone the workplace operates in (e.g. "Europe/Madrid")
      */
     timezone?: string;
     /**
-     * country code of the location
+     * ISO country code of the workplace — the jurisdiction it sits in, often used for country-specific policy thresholds
      */
     country?: string;
     /**
-     * State of the location
+     * State or province the workplace is located in
      */
     state?: string;
     /**
-     * City of the location
+     * City the workplace is located in
      */
     city?: string;
     /**
-     * Address line 1 of the location
+     * First line of the workplace street address
      */
     address_line_1?: string;
     /**
-     * Address line 2 of the location
+     * Second line of the workplace street address (suite, floor, …)
      */
     address_line_2?: string;
     /**
-     * Postal code of the location
+     * Postal/ZIP code of the workplace address
      */
     postal_code?: string;
     /**
-     * phone number of the location
+     * Contact phone number for the workplace
      */
     phone_number?: string;
     /**
-     * whether the location is the main one
+     * Whether this is the company's main (HQ) workplace
      */
     main: boolean;
     /**
@@ -5842,6 +5890,10 @@ export type ProjectManagementTimeRecord = {
      * Id of the subproject
      */
     subproject_id?: string;
+    /**
+     * Id of the project task assigned to the time record. Refers to project_management/project_tasks endpoint.
+     */
+    project_task_id?: string;
     /**
      * Reference date of the shift
      */
@@ -6021,12 +6073,30 @@ export type TeamsMembership = {
     lead: boolean;
 };
 export type TeamsTeam = {
+    /**
+     * Unique identifier of the team
+     */
     id: string;
+    /**
+     * Human-readable name of the team (e.g. "Engineering")
+     */
     name: string;
+    /**
+     * Free-text description of the team
+     */
     description?: string;
     avatar?: string;
+    /**
+     * IDs of the employees who are members of this team
+     */
     employee_ids?: Array<string>;
+    /**
+     * IDs of the employees who are leads of this team (subset of employee_ids)
+     */
     lead_ids?: Array<string>;
+    /**
+     * ID of the company this team belongs to
+     */
     company_id: string;
 };
 export type TimeoffAllowance = {
@@ -6344,27 +6414,27 @@ export type TimeoffLeave = {
      */
     id: string;
     /**
-     * Company identifier of the employee of the leave
+     * ID of the company the leave belongs to
      */
     company_id: string;
     /**
-     * Employee identifier of the leave
+     * ID of the employee taking the leave
      */
     employee_id: string;
     /**
-     * The start date of the leave
+     * First day of the leave
      */
     start_on: string;
     /**
-     * The end date of the leave
+     * Last day of the leave (inclusive); null while an open-ended leave has no end yet
      */
     finish_on?: string;
     /**
-     * Indicates if the leave is taken as a half-day
+     * Which half of the day a half-day leave covers — `beginning_of_day` or `end_of_day`; null for full-day leaves
      */
     half_day?: string;
     /**
-     * A description of the leave
+     * Free-text description of the leave
      */
     description?: string;
     /**
@@ -6372,15 +6442,15 @@ export type TimeoffLeave = {
      */
     reason?: string;
     /**
-     * The identifier for the type of leave
+     * ID of the leave type this leave is of
      */
     leave_type_id?: string;
     /**
-     * The name of the leave type
+     * Denormalised name of the leave type
      */
     leave_type_name?: string;
     /**
-     * Indicates whether the leave has been approved
+     * Tri-state approval status — true = approved, false = rejected, null = pending approval
      */
     approved?: boolean;
     /**
@@ -6392,7 +6462,7 @@ export type TimeoffLeave = {
      */
     start_time?: string;
     /**
-     * The total number of hours taken for the leave, represented in cents
+     * Total hours the leave consumes, in hundredths of an hour (e.g. 800 = 8 hours); set for hourly leaves
      */
     hours_amount_in_cents?: number;
     /**
@@ -6446,67 +6516,67 @@ export type TimeoffLeaveType = {
      */
     editable?: boolean;
     /**
-     * Whether approval is required for this leave type
+     * Whether leaves of this type must be approved before they take effect (when false, requests are auto-approved on creation)
      */
     approval_required?: boolean;
     /**
-     * Whether the leave type accrues over time
+     * Whether leaves of this type consume an accruing balance/allowance (vs. a non-accruing type that does not draw down a balance)
      */
     accrues?: boolean;
     /**
-     * Whether an attachment is required for this leave type
+     * Whether an attachment (e.g. a sick note) can be added to leaves of this type
      */
     attachment: boolean;
     /**
-     * Whether endless leave is allowed
+     * Whether leaves of this type may be open-ended (created with no finish date)
      */
     allow_endless?: boolean;
     /**
-     * Whether the leave type is restricted
+     * Whether requesting this leave type is restricted to specific employees or conditions rather than open to everyone
      */
     restricted?: boolean;
     /**
-     * Whether the leave type is visible to employees
+     * Whether the leave type is visible to employees (vs. admin-only)
      */
     visibility: boolean;
     /**
-     * Whether the leave type is workable
+     * Whether days taken under this leave type still count as workable (working) days
      */
     workable: boolean;
     /**
-     * Whether the leave type is payable
+     * Whether leaves of this type are paid
      */
     payable?: boolean;
     /**
-     * Identifier of the company associated with this leave type
+     * ID of the company this leave type belongs to
      */
     company_id: string;
     /**
-     * Whether the attachment is mandatory
+     * Whether an attachment is mandatory (not just allowed) to request this leave type
      */
     is_attachment_mandatory?: boolean;
     /**
-     * List of allowance identifiers associated with this leave type
+     * IDs of the allowances this leave type draws its balance from
      */
     allowance_ids: Array<string>;
     /**
-     * Whether half-day units are enabled for this leave type
+     * Whether leaves of this type can be requested in half-day units
      */
     half_days_units_enabled?: boolean;
     /**
-     * Maximum days in cents that can be taken
+     * Maximum number of days a single request may take, in hundredths of a day (e.g. 5000 = 50 days); null if unbounded
      */
     max_days_in_cents?: number;
     /**
-     * Minimum days in cents that must be taken
+     * Minimum number of days a single request must take, in hundredths of a day (e.g. 1000 = 10 days); null if unbounded
      */
     min_days_in_cents?: number;
     /**
-     * Description of the leave type
+     * Free-text description of the leave type
      */
     description?: string;
     /**
-     * Whether additional details are required for the leave type
+     * Whether the requester must provide additional details (a reason) when requesting this leave type
      */
     details_required: boolean;
 };
@@ -6520,11 +6590,11 @@ export type TimeoffPolicy = {
      */
     name: string;
     /**
-     * Is the main policy? It will return true if it's the main policy if not it will return false.
+     * Whether this is the company's main (default) time off policy — the one employees fall under unless assigned a specific policy.
      */
     main?: boolean;
     /**
-     * The company id.
+     * ID of the company that owns this policy.
      */
     company_id: string;
     /**
@@ -6538,15 +6608,15 @@ export type TimeoffPolicyAssignment = {
      */
     id?: string;
     /**
-     * The time off policy id
+     * ID of the time off policy assigned to the employee
      */
     timeoff_policy_id: string;
     /**
-     * The employee id
+     * ID of the employee this assignment governs
      */
     employee_id: string;
     /**
-     * The effective date of the policy assignment
+     * Date from which this policy assignment takes effect for the employee
      */
     effective_at: string;
 };
@@ -6999,23 +7069,71 @@ export type WorkScheduleDayConfiguration = {
     duration_in_seconds: number;
 };
 export type WorkScheduleOverlapPeriod = {
+    /**
+     * Identifier of the overlap period
+     */
     id: string;
+    /**
+     * Whether this is the default overlap period of the schedule
+     */
     default: boolean;
+    /**
+     * Identifier of the schedule this overlap period belongs to
+     */
     schedule_id: string;
+    /**
+     * Month the overlap period starts on
+     */
     start_month: number;
+    /**
+     * Day of the month the overlap period starts on
+     */
     start_day: number;
+    /**
+     * Month the overlap period ends on
+     */
     end_month: number;
+    /**
+     * Day of the month the overlap period ends on
+     */
     end_day: number;
+    /**
+     * Whether the schedule is flexible or fixed
+     */
     schedule_type: string;
 };
 export type WorkScheduleSchedule = {
+    /**
+     * Identifier of the schedule
+     */
     id: string;
+    /**
+     * Name of the schedule
+     */
     name: string;
+    /**
+     * When the schedule was archived; null when the schedule is active
+     */
     archived_at?: string;
+    /**
+     * Identifier of the company the schedule belongs to
+     */
     company_id: string;
+    /**
+     * When the schedule was created
+     */
     created_at: string;
+    /**
+     * When the schedule was last updated
+     */
     updated_at: string;
+    /**
+     * Identifiers of the employees assigned to the schedule
+     */
     employee_ids: Array<string>;
+    /**
+     * Overlap periods that make up the schedule
+     */
     periods: Array<unknown>;
 };
 export type BankingBankAccountNumber = {
@@ -8902,7 +9020,10 @@ export type GetApi20261001ResourcesAttendanceOpenShiftsData = {
     path?: never;
     query?: {
         /**
-         * Employee ids to filter the open shifts by.
+         * Optional. Employee ids to filter the open shifts by. When omitted,
+         * callers holding the SeeAttendancePeriods permission receive all open
+         * shifts in the company; other callers receive only their own open shift.
+         *
          */
         'employee_ids[]'?: Array<string>;
     };
@@ -22848,9 +22969,16 @@ export type GetApi20261001ResourcesWorkScheduleOverlapPeriodsResponses = {
 export type GetApi20261001ResourcesWorkScheduleOverlapPeriodsResponse = GetApi20261001ResourcesWorkScheduleOverlapPeriodsResponses[keyof GetApi20261001ResourcesWorkScheduleOverlapPeriodsResponses];
 export type PostApi20261001ResourcesWorkScheduleOverlapPeriodsData = {
     body?: {
-        author: unknown;
+        /**
+         * Identifier of the schedule this overlap period belongs to
+         */
         schedule_id: string;
-        create_params: unknown;
+        /**
+         * Attributes for the new overlap period (default flag, start/end day and month, and schedule type)
+         */
+        create_params?: {
+            [key: string]: unknown;
+        };
     };
     path?: never;
     query?: never;
@@ -22898,11 +23026,21 @@ export type GetApi20261001ResourcesWorkScheduleOverlapPeriodsByIdResponses = {
 export type GetApi20261001ResourcesWorkScheduleOverlapPeriodsByIdResponse = GetApi20261001ResourcesWorkScheduleOverlapPeriodsByIdResponses[keyof GetApi20261001ResourcesWorkScheduleOverlapPeriodsByIdResponses];
 export type PutApi20261001ResourcesWorkScheduleOverlapPeriodsByIdData = {
     body?: {
-        author: unknown;
+        /**
+         * Identifier of the overlap period to update
+         */
         id: string;
-        update_params: unknown;
+        /**
+         * Attributes to update on the overlap period (start/end day and month)
+         */
+        update_params?: {
+            [key: string]: unknown;
+        };
     };
     path: {
+        /**
+         * Identifier of the overlap period to update
+         */
         id: string;
     };
     query?: never;
@@ -22937,7 +23075,13 @@ export type GetApi20261001ResourcesWorkScheduleSchedulesResponses = {
 export type GetApi20261001ResourcesWorkScheduleSchedulesResponse = GetApi20261001ResourcesWorkScheduleSchedulesResponses[keyof GetApi20261001ResourcesWorkScheduleSchedulesResponses];
 export type PostApi20261001ResourcesWorkScheduleSchedulesData = {
     body?: {
+        /**
+         * Name of the new schedule
+         */
         name: string;
+        /**
+         * Whether the schedule is flexible or fixed
+         */
         schedule_type: string;
     };
     path?: never;
@@ -22968,11 +23112,19 @@ export type GetApi20261001ResourcesWorkScheduleSchedulesByIdResponses = {
 export type GetApi20261001ResourcesWorkScheduleSchedulesByIdResponse = GetApi20261001ResourcesWorkScheduleSchedulesByIdResponses[keyof GetApi20261001ResourcesWorkScheduleSchedulesByIdResponses];
 export type PutApi20261001ResourcesWorkScheduleSchedulesByIdData = {
     body?: {
+        /**
+         * The new name for the schedule
+         */
         name?: string;
+        /**
+         * Identifier of the schedule to update
+         */
         id: string;
-        author: unknown;
     };
     path: {
+        /**
+         * Identifier of the schedule to update
+         */
         id: string;
     };
     query?: never;