@factorialco/api-client 3.0.0-beta.2026100127 → 3.0.0-beta.2026100129

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

@@ -1367,6 +1367,75 @@ export type CompaniesLegalEntity = {
      */
     address_line_2?: string;
 };
+export type CompensationsAdditionalCompensation = {
+    /**
+     * The identifier of the additional compensation
+     */
+    id: string;
+    /**
+     * Contract version this additional compensation is attached to
+     */
+    contract_version_id: string;
+    /**
+     * Company id
+     */
+    company_id: string;
+    /**
+     * Payroll concept classifying this additional compensation
+     */
+    payroll_concept_id: string;
+    /**
+     * Employee id derived from the contract version
+     */
+    employee_id: string;
+    /**
+     * Recurrence label. One of `monthly`, `every_2_months`, `every_3_months`, `every_4_months`, `every_5_months`, `every_6_months`, `every_7_months`, `every_8_months`, `every_9_months`, `every_10_months`, `every_11_months`, `every_12_months`.
+     */
+    recurrence?: string;
+    /**
+     * Date of the first payment
+     */
+    first_payment_on?: string;
+    /**
+     * Free-text description
+     */
+    description?: string;
+    /**
+     * Amount strategy discriminator — one of `contracts_fixed_amount_strategy`, `contracts_variable_amount_strategy`, `contracts_per_worked_day_amount_strategy`
+     */
+    amount_strategy_type: 'contracts_fixed_amount_strategy' | 'contracts_variable_amount_strategy' | 'contracts_per_worked_day_amount_strategy';
+    /**
+     * Amount strategy id
+     */
+    amount_strategy_id: string;
+    /**
+     * Amount value (Fixed / PerWorkedDay strategies)
+     */
+    amount?: number;
+    /**
+     * Upper limit (Variable strategy only)
+     */
+    upper_limit?: number;
+    /**
+     * Definition object populated for PerWorkedDay strategies. Carries `calculation_source`, `reference_time`, `minimum_amount_of_hours_in_minutes`, `work_locations`, `timeoff_leave_type_ids`, and `eligible_days`. `null` for Fixed / Variable strategies.
+     */
+    per_worked_day_definition: {
+        calculation_source: string;
+        reference_time: string;
+        minimum_amount_of_hours_in_minutes?: number;
+        work_locations?: Array<string>;
+        timeoff_leave_type_ids?: Array<string>;
+        eligible_days?: Array<string>;
+    };
+    /**
+     * Timestamp when the additional compensation was created
+     */
+    created_at: string;
+    /**
+     * Timestamp when the additional compensation was last updated
+     */
+    updated_at: string;
+};
 export type CompensationsConcept = {
     /**
      * The identifier of the concept
@@ -1497,15 +1566,15 @@ export type CompensationsEmployeesCompensation = {
      */
     amount_is_overwritten: boolean;
     /**
-     * Row projection type (always `compensation` on this endpoint)
+     * Record projection type (always `compensation` on this endpoint)
      */
     result_type?: 'compensation' | 'payroll_result';
     /**
-     * Source type discriminator (nullable — dashboard-created rows have no source)
+     * Source type discriminator (nullable — dashboard-created records have no source)
      */
     source_type?: 'compensations_compensationpolicy' | 'timesettings_customtimerangecategory' | 'expenses_expensable' | 'expenses_expense' | 'expenses_mileage' | 'benefits_compensation' | 'salary_advance_request' | 'incentives_compensationplanrequest' | 'attendance_review';
     /**
-     * Source id (nullable — dashboard-created rows have no source)
+     * Source id (nullable — dashboard-created records have no source)
      */
     source_id?: string;
     /**
@@ -1629,6 +1698,44 @@ export type CompensationsPayrollRun = {
      */
     updated_at?: string;
 };
+export type CompensationsPayrollRunEmployeesCompensation = {
+    /**
+     * Payroll run employee compensation id
+     */
+    id: string;
+    /**
+     * Employee id (participant of the payroll run)
+     */
+    payroll_run_employee_id: string;
+    /**
+     * Payroll concept id
+     */
+    payroll_concept_id: string;
+    /**
+     * Parent payroll run id
+     */
+    payroll_run_id: string;
+    /**
+     * Record projection type — `compensation` (input) or `payroll_result` (computed)
+     */
+    result_type: string;
+    /**
+     * Amount strategy discriminator
+     */
+    amount_strategy_type: 'compensations_fixed_amount_strategy' | 'compensations_variable_amount_strategy' | 'compensations_per_worked_day_amount_strategy';
+    /**
+     * When the record was created
+     */
+    created_at: string;
+    /**
+     * When the record was last updated
+     */
+    updated_at: string;
+    /**
+     * Aggregated compensation value for this concept and employee within the payroll run, in minor units. For `payroll_result` records, this is the value the bookkeeper computed for that concept (e.g. net pay).
+     */
+    amount?: number;
+};
 export type ContractsCompensation = {
     /**
      * Unique identifier of the compensation
@@ -3430,7 +3537,7 @@ export type ExpensesExpensable = {
      */
     effective_on?: string;
     /**
-     * The optional date and time when the expensable was requested for review
+     * The date and time the expensable was submitted for review. Null while it is a draft; set at submission and never cleared, so it is always present once an approval flow or a policy check runs (they start at submission). Compare it with `effective_on` to measure how late a document was submitted.
      */
     review_request_at?: string;
     /**
@@ -10991,6 +11098,10 @@ export type PostApi20261001ResourcesAttendanceShiftsData = {
          * Id of the location related
          */
         workplace_id?: string;
+        /**
+         * Id of the project worker the shift is imputed to. A time record for that project is created with the shift.
+         */
+        project_worker_id?: string;
     };
     path?: never;
     query?: never;
@@ -11815,6 +11926,190 @@ export type GetApi20261001ResourcesCompaniesLegalEntitiesByIdResponses = {
     200: CompaniesLegalEntity;
 };
 export type GetApi20261001ResourcesCompaniesLegalEntitiesByIdResponse = GetApi20261001ResourcesCompaniesLegalEntitiesByIdResponses[keyof GetApi20261001ResourcesCompaniesLegalEntitiesByIdResponses];
+export type GetApi20261001ResourcesCompensationsAdditionalCompensationsData = {
+    body?: never;
+    path?: never;
+    query?: {
+        /**
+         * Filter by additional compensation ids
+         */
+        'ids[]'?: Array<string>;
+        /**
+         * Filter by contract version ids, refers to contracts/contract_versions endpoint.
+         */
+        'contract_version_ids[]'?: Array<string>;
+        /**
+         * Filter by employee ids, refers to employees/employees endpoint.
+         */
+        'employee_ids[]'?: Array<string>;
+        /**
+         * Filter by payroll concept ids, refers to compensations/concepts endpoint.
+         */
+        'payroll_concept_ids[]'?: Array<string>;
+    };
+    url: '/api/2026-10-01/resources/compensations/additional_compensations';
+};
+export type GetApi20261001ResourcesCompensationsAdditionalCompensationsResponses = {
+    /**
+     * OK
+     */
+    200: {
+        data?: Array<CompensationsAdditionalCompensation>;
+        meta?: PagedIndexMeta;
+    };
+};
+export type GetApi20261001ResourcesCompensationsAdditionalCompensationsResponse = GetApi20261001ResourcesCompensationsAdditionalCompensationsResponses[keyof GetApi20261001ResourcesCompensationsAdditionalCompensationsResponses];
+export type PostApi20261001ResourcesCompensationsAdditionalCompensationsData = {
+    body?: {
+        /**
+         * Target contract version id, refers to contracts/contract_versions endpoint.
+         */
+        contract_version_id: string;
+        /**
+         * Payroll concept id, refers to compensations/concepts endpoint.
+         */
+        payroll_concept_id: string;
+        /**
+         * Amount strategy discriminator
+         */
+        amount_strategy_type: 'contracts_fixed_amount_strategy' | 'contracts_variable_amount_strategy' | 'contracts_per_worked_day_amount_strategy';
+        /**
+         * Amount value (required for Fixed and PerWorkedDay strategies)
+         */
+        amount?: number;
+        /**
+         * Upper limit for Variable strategy (ignored for others)
+         */
+        upper_limit?: number;
+        /**
+         * Definition object required when `amount_strategy_type = contracts_per_worked_day_amount_strategy`. Carries `calculation_source`, `reference_time`, `minimum_amount_of_hours_in_minutes`, `work_locations`, `timeoff_leave_type_ids`, and `eligible_days`.
+         */
+        per_worked_day_definition: {
+            calculation_source: string;
+            reference_time: string;
+            minimum_amount_of_hours_in_minutes?: number;
+            work_locations?: Array<string>;
+            timeoff_leave_type_ids?: Array<string>;
+            eligible_days?: Array<string>;
+        };
+        /**
+         * Free-text description
+         */
+        description?: string;
+        /**
+         * Recurrence label. One of `monthly`, `every_2_months`, `every_3_months`, `every_4_months`, `every_5_months`, `every_6_months`, `every_7_months`, `every_8_months`, `every_9_months`, `every_10_months`, `every_11_months`, `every_12_months`.
+         */
+        recurrence?: 'monthly' | 'every_2_months' | 'every_3_months' | 'every_4_months' | 'every_5_months' | 'every_6_months' | 'every_7_months' | 'every_8_months' | 'every_9_months' | 'every_10_months' | 'every_11_months' | 'every_12_months';
+        /**
+         * Date of the first payment (must be on or after the contract version's effective month)
+         */
+        first_payment_on?: string;
+    };
+    path?: never;
+    query?: never;
+    url: '/api/2026-10-01/resources/compensations/additional_compensations';
+};
+export type PostApi20261001ResourcesCompensationsAdditionalCompensationsResponses = {
+    /**
+     * CREATED
+     */
+    201: CompensationsAdditionalCompensation;
+};
+export type PostApi20261001ResourcesCompensationsAdditionalCompensationsResponse = PostApi20261001ResourcesCompensationsAdditionalCompensationsResponses[keyof PostApi20261001ResourcesCompensationsAdditionalCompensationsResponses];
+export type DeleteApi20261001ResourcesCompensationsAdditionalCompensationsByIdData = {
+    body?: never;
+    path: {
+        /**
+         * Additional compensation id to delete
+         */
+        id: string;
+    };
+    query?: never;
+    url: '/api/2026-10-01/resources/compensations/additional_compensations/{id}';
+};
+export type DeleteApi20261001ResourcesCompensationsAdditionalCompensationsByIdResponses = {
+    /**
+     * OK
+     */
+    200: CompensationsAdditionalCompensation;
+};
+export type DeleteApi20261001ResourcesCompensationsAdditionalCompensationsByIdResponse = DeleteApi20261001ResourcesCompensationsAdditionalCompensationsByIdResponses[keyof DeleteApi20261001ResourcesCompensationsAdditionalCompensationsByIdResponses];
+export type GetApi20261001ResourcesCompensationsAdditionalCompensationsByIdData = {
+    body?: never;
+    path: {
+        /**
+         * Filter by additional compensation ids
+         */
+        id: string;
+    };
+    query?: never;
+    url: '/api/2026-10-01/resources/compensations/additional_compensations/{id}';
+};
+export type GetApi20261001ResourcesCompensationsAdditionalCompensationsByIdResponses = {
+    /**
+     * OK
+     */
+    200: CompensationsAdditionalCompensation;
+};
+export type GetApi20261001ResourcesCompensationsAdditionalCompensationsByIdResponse = GetApi20261001ResourcesCompensationsAdditionalCompensationsByIdResponses[keyof GetApi20261001ResourcesCompensationsAdditionalCompensationsByIdResponses];
+export type PutApi20261001ResourcesCompensationsAdditionalCompensationsByIdData = {
+    body?: {
+        /**
+         * Additional compensation id
+         */
+        id: string;
+        /**
+         * Amount strategy discriminator
+         */
+        amount_strategy_type?: 'contracts_fixed_amount_strategy' | 'contracts_variable_amount_strategy' | 'contracts_per_worked_day_amount_strategy';
+        /**
+         * Updated amount value (Fixed and PerWorkedDay strategies)
+         */
+        amount?: number;
+        /**
+         * Updated upper limit (Variable strategy only)
+         */
+        upper_limit?: number;
+        /**
+         * Definition object for PerWorkedDay strategies. Same shape as on create — replaces the previous definition when supplied.
+         */
+        per_worked_day_definition: {
+            calculation_source: string;
+            reference_time: string;
+            minimum_amount_of_hours_in_minutes?: number;
+            work_locations?: Array<string>;
+            timeoff_leave_type_ids?: Array<string>;
+            eligible_days?: Array<string>;
+        };
+        /**
+         * Free-text description
+         */
+        description?: string;
+        /**
+         * Recurrence label. Same enum as on create.
+         */
+        recurrence?: 'monthly' | 'every_2_months' | 'every_3_months' | 'every_4_months' | 'every_5_months' | 'every_6_months' | 'every_7_months' | 'every_8_months' | 'every_9_months' | 'every_10_months' | 'every_11_months' | 'every_12_months';
+        /**
+         * Date of the first payment
+         */
+        first_payment_on?: string;
+    };
+    path: {
+        /**
+         * Additional compensation id
+         */
+        id: string;
+    };
+    query?: never;
+    url: '/api/2026-10-01/resources/compensations/additional_compensations/{id}';
+};
+export type PutApi20261001ResourcesCompensationsAdditionalCompensationsByIdResponses = {
+    /**
+     * OK
+     */
+    200: CompensationsAdditionalCompensation;
+};
+export type PutApi20261001ResourcesCompensationsAdditionalCompensationsByIdResponse = PutApi20261001ResourcesCompensationsAdditionalCompensationsByIdResponses[keyof PutApi20261001ResourcesCompensationsAdditionalCompensationsByIdResponses];
 export type GetApi20261001ResourcesCompensationsConceptsData = {
     body?: never;
     path?: never;
@@ -12149,7 +12444,7 @@ export type PutApi20261001ResourcesCompensationsEmployeesCompensationsByIdData =
         id: string;
         amount?: number;
         /**
-         * Manual override of the strategy-computed amount; not allowed on fixed-strategy rows (422 `overwrite_not_applicable`)
+         * Manual override of the strategy-computed amount; not allowed on fixed-strategy records (422 `overwrite_not_applicable`)
          */
         amount_overwritten?: number;
         /**
@@ -12311,6 +12606,65 @@ export type GetApi20261001ResourcesCompensationsPayrollRunsByIdResponses = {
     200: CompensationsPayrollRun;
 };
 export type GetApi20261001ResourcesCompensationsPayrollRunsByIdResponse = GetApi20261001ResourcesCompensationsPayrollRunsByIdResponses[keyof GetApi20261001ResourcesCompensationsPayrollRunsByIdResponses];
+export type GetApi20261001ResourcesCompensationsPayrollRunEmployeesCompensationsData = {
+    body?: never;
+    path?: never;
+    query?: {
+        /**
+         * Payroll run employee compensation ids
+         */
+        'ids[]'?: Array<string>;
+        /**
+         * Filter by payroll run ids, refers to compensations/payroll_runs endpoint.
+         */
+        'payroll_run_ids[]'?: Array<string>;
+        /**
+         * Filter by employee ids (participants of the payroll run)
+         */
+        'payroll_run_employee_ids[]'?: Array<string>;
+        /**
+         * Filter by payroll concept ids, refers to compensations/concepts endpoint.
+         */
+        'payroll_concept_ids[]'?: Array<string>;
+        /**
+         * Filter by record projection type — `compensation` (input) or `payroll_result` (computed)
+         */
+        result_type?: 'compensation' | 'payroll_result';
+        /**
+         * Filter by legal entity ids, refers to companies/legal_entities endpoint.
+         */
+        'legal_entity_ids[]'?: Array<string>;
+    };
+    url: '/api/2026-10-01/resources/compensations/payroll_run_employees_compensations';
+};
+export type GetApi20261001ResourcesCompensationsPayrollRunEmployeesCompensationsResponses = {
+    /**
+     * OK
+     */
+    200: {
+        data?: Array<CompensationsPayrollRunEmployeesCompensation>;
+        meta?: PagedIndexMeta;
+    };
+};
+export type GetApi20261001ResourcesCompensationsPayrollRunEmployeesCompensationsResponse = GetApi20261001ResourcesCompensationsPayrollRunEmployeesCompensationsResponses[keyof GetApi20261001ResourcesCompensationsPayrollRunEmployeesCompensationsResponses];
+export type GetApi20261001ResourcesCompensationsPayrollRunEmployeesCompensationsByIdData = {
+    body?: never;
+    path: {
+        /**
+         * Payroll run employee compensation ids
+         */
+        id: string;
+    };
+    query?: never;
+    url: '/api/2026-10-01/resources/compensations/payroll_run_employees_compensations/{id}';
+};
+export type GetApi20261001ResourcesCompensationsPayrollRunEmployeesCompensationsByIdResponses = {
+    /**
+     * OK
+     */
+    200: CompensationsPayrollRunEmployeesCompensation;
+};
+export type GetApi20261001ResourcesCompensationsPayrollRunEmployeesCompensationsByIdResponse = GetApi20261001ResourcesCompensationsPayrollRunEmployeesCompensationsByIdResponses[keyof GetApi20261001ResourcesCompensationsPayrollRunEmployeesCompensationsByIdResponses];
 export type GetApi20261001ResourcesContractsCompensationsData = {
     body?: never;
     path?: never;
@@ -14179,7 +14533,7 @@ export type PostApi20261001ResourcesDocumentsDocumentsRestoreFromTrashBinRespons
 export type PostApi20261001ResourcesDocumentsDownloadUrlsBulkCreateData = {
     body?: {
         /**
-         * list of document identifiers.
+         * list of document identifiers (between 1 and 100).
          */
         ids?: Array<string>;
     };
@@ -14448,11 +14802,15 @@ export type PutApi20261001ResourcesEmployeesEmployeesByIdData = {
          */
         country?: string;
         /**
-         * bank account number of the employee.
+         * bank account number of the employee, in the format given by bank_number_format.
          */
         bank_number?: string;
         /**
-         * code to identify banks and financial institutions globally.
+         * format of bank_number. Required when bank_number is set.
+         */
+        bank_number_format?: 'iban' | 'sort_code_and_account_number' | 'routing_number_and_account_number' | 'clabe' | 'other' | 'bank_name_and_account_number';
+        /**
+         * SWIFT/BIC for iban, the sort code for sort_code_and_account_number, the routing number for routing_number_and_account_number, the bank name for bank_name_and_account_number. Required for those three formats.
          */
         swift_bic?: string;
         /**
@@ -24137,7 +24495,7 @@ export type GetApi20261001ResourcesTimeoffAllowanceStatsData = {
          */
         'ids[]'?: Array<string>;
         /**
-         * Get the allowance stats for specific employees
+         * IDs of the employees to read allowance stats for, at most 25 per request. Leave it empty to read every employee you have access to. Naming an employee you cannot access returns an empty page rather than the stats for the others.
          */
         'employee_ids[]'?: Array<string>;
         /**
@@ -24149,7 +24507,7 @@ export type GetApi20261001ResourcesTimeoffAllowanceStatsData = {
          */
         reference_date?: string;
         /**
-         * When provided, computes the stats as if the employee were moved to this target time off policy effective the day AFTER reference_date, so pass the day before the change date - for a change effective on 2026-08-03, send reference_date=2026-08-02. This truncates the source policy's current cycle at that boundary so available_days reflects the prorated balance that would actually transfer or be discarded on the change, rather than the full entitlement. Purely a read - nothing is persisted. Requires the policy timeline feature; without it the result is identical to an un-simulated read.
+         * When provided, computes the stats as if the employee were moved to this target time off policy effective the day AFTER reference_date, so pass the day before the change date - for a change effective on 2026-08-03, send reference_date=2026-08-02. This truncates the source policy's current cycle at that boundary so available_days reflects the prorated balance that would actually transfer or be discarded on the change, rather than the full entitlement. Purely a read - nothing is persisted. Requires the policy timeline feature; without it the result is identical to an un-simulated read. Can only be used together with employee_ids, because a simulation needs every employee in the read to belong to the target policy's company - which a company-wide read cannot guarantee.
          */
         simulate_policy_change_to_id?: string;
     };
@@ -24974,6 +25332,10 @@ export type PostApi20261001ResourcesTimeoffPoliciesData = {
          * Company ID.
          */
         company_id?: string;
+        /**
+         * ID of an existing policy to copy. When set, the new policy is created with a copy of that policy's allowances and no employees assigned. Omit it to create a policy from scratch.
+         */
+        based_on_policy_id?: string;
     };
     path?: never;
     query?: never;
@@ -26571,7 +26933,7 @@ export type PostApi20261001ResourcesTrainingsTrainingMembershipsBulkCreateData =
         /**
          * ids for the accesses to be assigned in a training
          */
-        employee_ids: Array<string>;
+        employee_ids?: Array<string>;
         /**
          * Training id to be assigned
          */