@factorialco/api-client 3.0.0-beta.2026100128 → 3.0.0-beta.2026100130

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
@@ -2267,6 +2336,7 @@ export type ContractsMaterializedTemplate = {
         label: string;
         field_type: 'boolean' | 'cents' | 'integer' | 'option' | 'string';
         edit_mode: 'not_editable' | 'add_only' | 'full_editable';
+        source_level?: 'company' | 'country' | 'legal_entity';
         options?: Array<{
             id: string;
             option_id: string;
@@ -3468,7 +3538,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 afterwards. Compare it with `effective_on` to measure how late a document was submitted.
      */
     review_request_at?: string;
     /**
@@ -4304,7 +4374,7 @@ export type FinanceFinancialDocument = {
      */
     net_amount_cents?: number;
     /**
-     * Total payable on the document, taxes included, in cents. This is the amount to branch on when a rule cares about how much is being spent.
+     * Total payable on the document, taxes included, in cents.
      */
     total_amount_cents?: number;
     /**
@@ -4759,7 +4829,7 @@ export type IntegrationsSyncableItem = {
     /**
      * Type of the syncable item
      */
-    syncable_type: 'compensations/compensation' | 'expenses/expense' | 'employee_updates/leave' | 'employee_updates/worked_time' | 'finance/vendor';
+    syncable_type: 'compensations/compensation' | 'expenses/expense' | 'employee_updates/leave' | 'employee_updates/new_hire' | 'employee_updates/worked_time' | 'finance/vendor';
 };
 export type IntegrationsSyncableState = {
     /**
@@ -10436,27 +10506,27 @@ export type GetApi20261001ResourcesAttendanceEditTimesheetRequestsData = {
     path?: never;
     query?: {
         /**
-         * filter by ids.
+         * Return only the timesheet-edit requests with these ids.
          */
         'ids[]'?: Array<string>;
         /**
-         * filter by employee ids.
+         * Return only the requests raised for these employees.
          */
         'employee_ids[]'?: Array<string>;
         /**
-         * filter by shift id.
+         * Return only the requests targeting this existing attendance shift. Requests that propose a brand-new shift have no shift yet and are never matched.
          */
         shift_id?: string;
         /**
-         * filter by edit timesheet request status.
+         * Set to true to return only the requests still awaiting a decision (`approved` is null). Passing false has no effect: it does not restrict the result to already-decided requests.
          */
         pending?: boolean;
         /**
-         * filter by edit timesheet requests that were created after or including this date.
+         * Return only the requests about a timesheet day on or after this date. This is the day the request refers to, not the day it was created. Given without `end_on` it matches that single day.
          */
         start_on?: string;
         /**
-         * filter by edit timesheet requests that were created before or including this date.
+         * Return only the requests about a timesheet day on or before this date. Given without `start_on` it matches every request up to that day.
          */
         end_on?: string;
     };
@@ -10565,7 +10635,7 @@ export type GetApi20261001ResourcesAttendanceEditTimesheetRequestsByIdData = {
     body?: never;
     path: {
         /**
-         * filter by ids.
+         * Return only the timesheet-edit requests with these ids.
          */
         id: string;
     };
@@ -10702,10 +10772,25 @@ export type GetApi20261001ResourcesAttendanceOvertimeRequestsData = {
     body?: never;
     path?: never;
     query: {
+        /**
+         * Return only the overtime requests with these ids.
+         */
         'ids[]'?: Array<string>;
+        /**
+         * Return only the overtime requests of these employees.
+         */
         'employee_ids[]'?: Array<string>;
+        /**
+         * Return only the requests for an overtime day on or after this date. Given without `end_on` it matches that single day.
+         */
         start_on?: string;
+        /**
+         * Return only the requests for an overtime day on or before this date. Given without `start_on` it matches every request up to that day.
+         */
         end_on?: string;
+        /**
+         * Return only the requests in this state: `pending` (the state of a newly created request), `approved`, `rejected` or `none`.
+         */
         status?: 'pending' | 'approved' | 'rejected' | 'none';
         include_approval_flow: boolean;
     };
@@ -10758,6 +10843,9 @@ export type DeleteApi20261001ResourcesAttendanceOvertimeRequestsByIdResponse = D
 export type GetApi20261001ResourcesAttendanceOvertimeRequestsByIdData = {
     body?: never;
     path: {
+        /**
+         * Return only the overtime requests with these ids.
+         */
         id: string;
     };
     query?: never;
@@ -10919,27 +11007,27 @@ export type GetApi20261001ResourcesAttendanceShiftsData = {
     path?: never;
     query: {
         /**
-         * filter by employee ids.
+         * Return only the shifts of these employees.
          */
         'employee_ids[]'?: Array<string>;
         /**
-         * filter by shift that starts after or including this date.
+         * Return only the shifts whose reference date (the day the shift counts towards, which for an overnight shift is the day it started) is on or after this date. Can be given on its own, as an open-ended lower bound.
          */
         start_on?: string;
         /**
-         * filter by shift that ends before or including this date.
+         * Return only the shifts whose reference date is on or before this date. Can be given on its own, as an open-ended upper bound.
          */
         end_on?: string;
         /**
-         * filter by ids.
+         * Return only the shifts with these ids.
          */
         'ids[]'?: Array<string>;
         /**
-         * Flag to filter half day shifts
+         * Set to true to return only the shifts marked as covering half a day. Passing false has no effect: it does not exclude them.
          */
         half_day: boolean;
         /**
-         * Flag to filter shifts in workable days
+         * Set to true for worked time only, false for the non-workable entries (breaks). Leave it unset to get both.
          */
         workable?: boolean;
         /**
@@ -11064,7 +11152,7 @@ export type GetApi20261001ResourcesAttendanceShiftsByIdData = {
     body?: never;
     path: {
         /**
-         * filter by ids.
+         * Return only the shifts with these ids.
          */
         id: string;
     };
@@ -11757,7 +11845,7 @@ export type GetApi20261001ResourcesCompaniesLegalEntitiesData = {
     path?: never;
     query?: {
         /**
-         * identifier of the legal entity
+         * Return only the legal entities with these ids.
          */
         'ids[]'?: Array<string>;
         /**
@@ -11843,7 +11931,7 @@ export type GetApi20261001ResourcesCompaniesLegalEntitiesByIdData = {
     body?: never;
     path: {
         /**
-         * identifier of the legal entity
+         * Return only the legal entities with these ids.
          */
         id: string;
     };
@@ -11857,6 +11945,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;
@@ -11866,7 +12138,7 @@ export type GetApi20261001ResourcesCompensationsConceptsData = {
          */
         'ids[]'?: Array<string>;
         /**
-         * Filter by concept categories
+         * Return only the concepts in these categories: `earnings_fixed_salary`, `earnings_variable`, `earnings_benefits_in_kind`, `earnings_others`, `deductions`, `company_contribution` or `summarized_values`.
          */
         'categories[]'?: 'earnings_fixed_salary' | 'earnings_variable' | 'earnings_benefits_in_kind' | 'earnings_others' | 'deductions' | 'company_contribution' | 'summarized_values';
         /**
@@ -11878,7 +12150,7 @@ export type GetApi20261001ResourcesCompensationsConceptsData = {
          */
         enabled?: boolean;
         /**
-         * When true, returns only default concepts
+         * Set to true to return only the concepts Factorial ships by default, leaving out the ones the company created itself. Passing false has no effect.
          */
         default?: boolean;
     };
@@ -12065,7 +12337,7 @@ export type GetApi20261001ResourcesCompensationsEmployeesCompensationsData = {
     path?: never;
     query?: {
         /**
-         * Employee compensation ids
+         * Return only the employee compensation rows with these ids.
          */
         'ids[]'?: Array<string>;
         /**
@@ -12169,7 +12441,7 @@ export type GetApi20261001ResourcesCompensationsEmployeesCompensationsByIdData =
     body?: never;
     path: {
         /**
-         * Employee compensation ids
+         * Return only the employee compensation rows with these ids.
          */
         id: string;
     };
@@ -12416,7 +12688,13 @@ export type GetApi20261001ResourcesContractsCompensationsData = {
     body?: never;
     path?: never;
     query?: {
+        /**
+         * Return only the compensations with these ids.
+         */
         'ids[]'?: Array<string>;
+        /**
+         * Return only the compensations belonging to these contract versions.
+         */
         'contract_version_ids[]'?: Array<string>;
     };
     url: '/api/2026-10-01/resources/contracts/compensations';
@@ -12479,6 +12757,9 @@ export type DeleteApi20261001ResourcesContractsCompensationsByIdResponse = Delet
 export type GetApi20261001ResourcesContractsCompensationsByIdData = {
     body?: never;
     path: {
+        /**
+         * Return only the compensations with these ids.
+         */
         id: string;
     };
     query?: never;
@@ -12575,11 +12856,11 @@ export type GetApi20261001ResourcesContractsContractVersionsData = {
     path?: never;
     query: {
         /**
-         * list of contract version identifiers.
+         * Return only the contract versions with these ids.
          */
         'ids[]'?: Array<string>;
         /**
-         * list of employee identifiers, refers to /employees/employees endpoint.
+         * Return only the contract versions of these employees.
          */
         'employee_ids[]'?: Array<string>;
         /**
@@ -12745,7 +13026,7 @@ export type GetApi20261001ResourcesContractsContractVersionsByIdData = {
     body?: never;
     path: {
         /**
-         * list of contract version identifiers.
+         * Return only the contract versions with these ids.
          */
         id: string;
     };
@@ -14408,7 +14689,7 @@ export type GetApi20261001ResourcesEmployeesEmployeesData = {
     path?: never;
     query: {
         /**
-         * filter by employee ids.
+         * Return only the employees with these ids. Ids outside what the reader may see are dropped, rather than failing the whole read.
          */
         'ids[]'?: Array<string>;
         /**
@@ -14428,7 +14709,7 @@ export type GetApi20261001ResourcesEmployeesEmployeesData = {
          */
         updated_at_gteq?: string;
         /**
-         * filter by legal entity id (refereces to companies/legal_entities).
+         * Return only the employees whose contract is under these legal entities.
          */
         'legal_entity_ids[]'?: Array<string>;
         /**
@@ -14436,19 +14717,19 @@ export type GetApi20261001ResourcesEmployeesEmployeesData = {
          */
         company_identifier?: string;
         /**
-         * get only active employees
+         * Set to true to keep only the employees not terminated as of today: those with no termination date, or one still in the future. Passing false has no effect, and it is ignored altogether when `include_active_and_terminated` is set.
          */
         only_active: boolean;
         /**
-         * filter employees by team id (references to core/teams).
+         * Return only the employees who belong to these teams.
          */
         'team_ids[]'?: Array<string>;
         /**
-         * filter employees by location id (references to locations/location).
+         * Return only the employees whose default workplace is one of these locations.
          */
         'location_ids[]'?: Array<string>;
         /**
-         * get only manager employees.
+         * Set to true to return only the employees who have at least one direct report. Passing false has no effect.
          */
         only_managers: boolean;
         /**
@@ -14472,7 +14753,7 @@ export type GetApi20261001ResourcesEmployeesEmployeesByIdData = {
     body?: never;
     path: {
         /**
-         * filter by employee ids.
+         * Return only the employees with these ids. Ids outside what the reader may see are dropped, rather than failing the whole read.
          */
         id: string;
     };
@@ -15181,17 +15462,41 @@ export type GetApi20261001ResourcesExpensesExpensablesData = {
     body?: never;
     path?: never;
     query: {
+        /**
+         * Return only the expensables with these ids.
+         */
         'ids[]'?: Array<string>;
         company_id?: string;
+        /**
+         * Return only the expensables filed inside these expense groups, the report or trip bundles an employee submits several expensables in.
+         */
         'group_ids[]'?: Array<string>;
         'by_resources[]'?: Array<{
             [key: string]: unknown;
         }>;
+        /**
+         * Return only the expensables whose spending employee is one of these. When `reporter_ids` is given too the two are OR'ed, not intersected: the result holds the expensables owned by these employees plus the ones submitted by those reporters.
+         */
         'employee_ids[]'?: Array<string>;
+        /**
+         * Return only the expensables submitted by these employees on somebody else's behalf, such as an assistant or an office manager. OR'ed with `employee_ids` when both are given.
+         */
         'reporter_ids[]'?: Array<string>;
+        /**
+         * Return only the expensables in these states: `draft`, `pending`, `changes_requested`, `approved`, `rejected`, `reversed`, `in_payroll`, `sent_to_pay` or `paid`.
+         */
         'status[]'?: 'pending' | 'changes_requested' | 'approved' | 'paid' | 'rejected' | 'reversed' | 'draft' | 'in_payroll' | 'sent_to_pay';
+        /**
+         * Return only the expensables created this way: `manual` (entered by a person) or `automatic` (raised from a card transaction). Those are the only two values the filter understands, and any other string makes the read return nothing at all rather than ignoring the filter.
+         */
         'creation_type[]'?: Array<string>;
+        /**
+         * Start of the window of expense dates (`effective_on`) to return, inclusive. It only takes effect together with `to`: given on its own it is ignored and no date narrowing happens.
+         */
         from?: string;
+        /**
+         * End of the window of expense dates (`effective_on`) to return, inclusive. It only takes effect together with `from`.
+         */
         to?: string;
         search?: string;
         include_grouped: boolean;
@@ -15213,6 +15518,9 @@ export type GetApi20261001ResourcesExpensesExpensablesResponse = GetApi20261001R
 export type GetApi20261001ResourcesExpensesExpensablesByIdData = {
     body?: never;
     path: {
+        /**
+         * Return only the expensables with these ids.
+         */
         id: string;
     };
     query?: never;
@@ -15270,11 +15578,11 @@ export type GetApi20261001ResourcesExpensesExpensesData = {
     path?: never;
     query: {
         /**
-         * The ids of the expenses to filter by
+         * Return only the expenses with these ids.
          */
         'ids[]'?: Array<string>;
         /**
-         * The ids of the expensables to filter by
+         * Return only the expenses attached to these expensables. An expense is the detail record of an expensable, so this is the usual way to reach it from the header.
          */
         'expenses_expensable_ids[]'?: Array<string>;
         /**
@@ -15282,7 +15590,7 @@ export type GetApi20261001ResourcesExpensesExpensesData = {
          */
         include_manual_drafts: boolean;
         /**
-         * The ids of the employees to filter by
+         * Return only the expenses of these employees.
          */
         'employee_ids[]'?: Array<string>;
         /**
@@ -15290,11 +15598,11 @@ export type GetApi20261001ResourcesExpensesExpensesData = {
          */
         'external_authorization_ids[]'?: Array<string>;
         /**
-         * The ids of the cards to filter by
+         * Return only the expenses paid with these cards.
          */
         'card_ids[]'?: Array<string>;
         /**
-         * The ids of the card payments to filter by
+         * Return only the expenses raised from these card payments.
          */
         'card_payment_ids[]'?: Array<string>;
         /**
@@ -15302,15 +15610,15 @@ export type GetApi20261001ResourcesExpensesExpensesData = {
          */
         include_attachments: boolean;
         /**
-         * The time from which to filter expenses
+         * Start of the window of expense dates (`effective_on`) to return, inclusive. It only takes effect together with `to`: given on its own it is ignored.
          */
         from?: string;
         /**
-         * The time to which to filter expenses
+         * End of the window of expense dates (`effective_on`) to return, exclusive. It only takes effect together with `from`.
          */
         to?: string;
         /**
-         * The ids of the disputes to filter by
+         * Return only the expenses under these payment disputes.
          */
         'dispute_ids[]'?: Array<string>;
     };
@@ -15330,7 +15638,7 @@ export type GetApi20261001ResourcesExpensesExpensesByIdData = {
     body?: never;
     path: {
         /**
-         * The ids of the expenses to filter by
+         * Return only the expenses with these ids.
          */
         id: string;
     };
@@ -15348,16 +15656,40 @@ export type GetApi20261001ResourcesExpensesMileagesData = {
     body?: never;
     path?: never;
     query: {
+        /**
+         * Return only the mileage records with these ids.
+         */
         'ids[]'?: Array<string>;
+        /**
+         * Return only the mileage records attached to these expensables. A mileage record is the detail record of an expensable, so this is the usual way to reach it from the header.
+         */
         'expenses_expensable_ids[]'?: Array<string>;
         include_manual_drafts: boolean;
+        /**
+         * Return only the mileage records of these employees.
+         */
         'employee_ids[]'?: Array<string>;
         'external_authorization_ids[]'?: Array<string>;
+        /**
+         * Return only the mileage records paid with these cards.
+         */
         'card_ids[]'?: Array<string>;
+        /**
+         * Return only the mileage records raised from these card payments.
+         */
         'card_payment_ids[]'?: Array<string>;
         include_attachments: boolean;
+        /**
+         * Start of the window of travel dates (`effective_on`) to return, inclusive. It only takes effect together with `to`: given on its own it is ignored.
+         */
         from?: string;
+        /**
+         * End of the window of travel dates (`effective_on`) to return, exclusive. It only takes effect together with `from`.
+         */
         to?: string;
+        /**
+         * Return only the mileage records under these payment disputes.
+         */
         'dispute_ids[]'?: Array<string>;
     };
     url: '/api/2026-10-01/resources/expenses/mileages';
@@ -15375,6 +15707,9 @@ export type GetApi20261001ResourcesExpensesMileagesResponse = GetApi20261001Reso
 export type GetApi20261001ResourcesExpensesMileagesByIdData = {
     body?: never;
     path: {
+        /**
+         * Return only the mileage records with these ids.
+         */
         id: string;
     };
     query?: never;
@@ -16223,31 +16558,31 @@ export type GetApi20261001ResourcesFinanceFinancialDocumentsData = {
     path?: never;
     query?: {
         /**
-         * Search financial documents by company_id
+         * Return only the documents of this company. It must be a company the reader has access to: an id outside that set makes the read fail rather than come back empty.
          */
         company_id?: string;
         /**
-         * Search financial documents by ID
+         * Return only the financial documents with these ids.
          */
         'ids[]'?: Array<string>;
         /**
-         * Search financial documents by vendor_id
+         * Return only the documents issued by this vendor contact.
          */
         vendor_id?: string;
         /**
-         * Search financial documents by currency
+         * Return only the documents in this currency, as an uppercase ISO 4217 code. It takes one code, not a list.
          */
         currency?: string;
         /**
-         * Search financial documents by status
+         * Return only the documents in these states: `processing`, `review` (awaiting approval), `sent_to_pay` or `paid`.
          */
         'statuses[]'?: 'processing' | 'review' | 'sent_to_pay' | 'paid';
         /**
-         * Search financial documents by legal_entity_id
+         * Return only the documents booked against these legal entities.
          */
         'legal_entity_ids[]'?: Array<string>;
         /**
-         * Search financial documents by document_type
+         * Return only the documents of these kinds: `invoice`, `receipt` or `credit_note`.
          */
         'document_types[]'?: 'invoice' | 'receipt' | 'credit_note';
         /**
@@ -16348,7 +16683,7 @@ export type GetApi20261001ResourcesFinanceFinancialDocumentsByIdData = {
     body?: never;
     path: {
         /**
-         * Search financial documents by ID
+         * Return only the financial documents with these ids.
          */
         id: string;
     };
@@ -16982,15 +17317,15 @@ export type GetApi20261001ResourcesHolidaysCompanyHolidaysData = {
     path?: never;
     query?: {
         /**
-         * Company holiday ids
+         * Return only the company holidays with these ids.
          */
         'ids[]'?: Array<string>;
         /**
-         * Location ids
+         * Return only the holidays declared for these locations. A company holiday always belongs to exactly one location.
          */
         'location_ids[]'?: Array<string>;
         /**
-         * Team ids
+         * Return only the holidays of the locations that are the default workplace of somebody in these teams. It reaches teams through employees, not directly.
          */
         'team_ids[]'?: Array<string>;
         /**
@@ -16998,11 +17333,11 @@ export type GetApi20261001ResourcesHolidaysCompanyHolidaysData = {
          */
         'employee_ids[]'?: Array<string>;
         /**
-         * Start date
+         * Return only the holidays falling on or after this date. Usable on its own, as an open-ended lower bound.
          */
         start_at?: string;
         /**
-         * End date
+         * Return only the holidays falling on or before this date. Usable on its own, as an open-ended upper bound.
          */
         end_at?: string;
     };
@@ -17022,7 +17357,7 @@ export type GetApi20261001ResourcesHolidaysCompanyHolidaysByIdData = {
     body?: never;
     path: {
         /**
-         * Company holiday ids
+         * Return only the company holidays with these ids.
          */
         id: string;
     };
@@ -17131,27 +17466,6 @@ export type PostApi20261001ResourcesIntegrationsSyncRunOutputsResponses = {
     201: IntegrationsSyncRunOutput;
 };
 export type PostApi20261001ResourcesIntegrationsSyncRunOutputsResponse = PostApi20261001ResourcesIntegrationsSyncRunOutputsResponses[keyof PostApi20261001ResourcesIntegrationsSyncRunOutputsResponses];
-export type GetApi20261001ResourcesIntegrationsSyncableItemsData = {
-    body?: never;
-    path?: never;
-    query: {
-        /**
-         * Identifier of the sync run
-         */
-        sync_run_id: string;
-    };
-    url: '/api/2026-10-01/resources/integrations/syncable_items';
-};
-export type GetApi20261001ResourcesIntegrationsSyncableItemsResponses = {
-    /**
-     * OK
-     */
-    200: {
-        data?: Array<IntegrationsSyncableItem>;
-        meta?: PagedIndexMeta;
-    };
-};
-export type GetApi20261001ResourcesIntegrationsSyncableItemsResponse = GetApi20261001ResourcesIntegrationsSyncableItemsResponses[keyof GetApi20261001ResourcesIntegrationsSyncableItemsResponses];
 export type GetApi20261001ResourcesIntegrationsSyncableStatesData = {
     body?: never;
     path?: never;
@@ -17296,7 +17610,7 @@ export type PostApi20261001ResourcesIntegrationsSyncableSyncRunsBulkUpsertData =
             /**
              * The Factorial resource type this item maps to
              */
-            syncable_type: 'compensationscompensation' | 'expensesexpensable' | 'employeeupdatesleave' | 'employeeupdatesworkedtime' | 'financecontact';
+            syncable_type: 'compensationscompensation' | 'expensesexpensable' | 'employeeupdatesleave' | 'employeeupdatesnewhire' | 'employeeupdatesworkedtime' | 'financecontact';
             /**
              * Outcome of processing the item
              */
@@ -17788,6 +18102,9 @@ export type GetApi20261001ResourcesJobCatalogRolesData = {
     body?: never;
     path?: never;
     query?: {
+        /**
+         * Return only the job roles with these ids.
+         */
         'ids[]'?: Array<string>;
     };
     url: '/api/2026-10-01/resources/job_catalog/roles';
@@ -17805,6 +18122,9 @@ export type GetApi20261001ResourcesJobCatalogRolesResponse = GetApi20261001Resou
 export type GetApi20261001ResourcesJobCatalogRolesByIdData = {
     body?: never;
     path: {
+        /**
+         * Return only the job roles with these ids.
+         */
         id: string;
     };
     query?: never;
@@ -17863,7 +18183,7 @@ export type GetApi20261001ResourcesLocationsLocationsData = {
          */
         'employee_ids[]'?: Array<string>;
         /**
-         * Wether to filter only the main location.
+         * Set to true to return only the company's main location. Passing false has no effect.
          */
         main?: boolean;
     };
@@ -23517,7 +23837,7 @@ export type GetApi20261001ResourcesTeamsMembershipsData = {
     path?: never;
     query?: {
         /**
-         * Membership ids.
+         * Return only the memberships with these ids.
          */
         'ids[]'?: Array<string>;
         /**
@@ -23525,11 +23845,11 @@ export type GetApi20261001ResourcesTeamsMembershipsData = {
          */
         lead?: boolean;
         /**
-         * Team ids.
+         * Return only the memberships of these teams.
          */
         'team_ids[]'?: Array<string>;
         /**
-         * Employee ids.
+         * Return only the memberships of these employees.
          */
         'employee_ids[]'?: Array<string>;
     };
@@ -23593,7 +23913,7 @@ export type GetApi20261001ResourcesTeamsMembershipsByIdData = {
     body?: never;
     path: {
         /**
-         * Membership ids.
+         * Return only the memberships with these ids.
          */
         id: string;
     };
@@ -23638,6 +23958,9 @@ export type GetApi20261001ResourcesTeamsTeamsData = {
     body?: never;
     path?: never;
     query?: {
+        /**
+         * Return only the teams with these ids.
+         */
         'ids[]'?: Array<string>;
     };
     url: '/api/2026-10-01/resources/teams/teams';
@@ -23695,6 +24018,9 @@ export type DeleteApi20261001ResourcesTeamsTeamsByIdResponse = DeleteApi20261001
 export type GetApi20261001ResourcesTeamsTeamsByIdData = {
     body?: never;
     path: {
+        /**
+         * Return only the teams with these ids.
+         */
         id: string;
     };
     query?: never;
@@ -23747,15 +24073,15 @@ export type GetApi20261001ResourcesTimeoffAllowancesData = {
     path?: never;
     query?: {
         /**
-         * An array of allowance ids to look for
+         * Return only the allowances with these ids.
          */
         'ids[]'?: Array<string>;
         /**
-         * Filter allowances by Time off policy id
+         * Return only the allowances belonging to this time-off policy. It takes one id, not a list.
          */
         timeoff_policy_id?: string;
         /**
-         * Filter by only overtime allowances
+         * Set to true to return only the allowances funded by overtime hours, leaving out those accrued from a base entitlement or from worked time. Passing false has no effect.
          */
         by_overtime?: boolean;
     };
@@ -23937,7 +24263,7 @@ export type GetApi20261001ResourcesTimeoffAllowancesByIdData = {
     body?: never;
     path: {
         /**
-         * An array of allowance ids to look for
+         * Return only the allowances with these ids.
          */
         id: string;
     };
@@ -24464,23 +24790,23 @@ export type GetApi20261001ResourcesTimeoffLeavesData = {
     path?: never;
     query: {
         /**
-         * The leave ids to retrieve
+         * Return only the leaves with these ids.
          */
         'ids[]'?: Array<string>;
         /**
-         * The employee ids to retrieve
+         * Return only the leaves of these employees.
          */
         'employee_ids[]'?: Array<string>;
         /**
-         * The leave type id to retrieve
+         * Return only the leaves of these leave types. Despite the singular name it takes a list.
          */
         'leave_type_id[]'?: Array<string>;
         /**
-         * Valid date following the format YYYY-MM-DD
+         * Return only the leaves that had already started by this date (start date on or before it). Usable on its own; pair it with `from` for a window.
          */
         to?: string;
         /**
-         * Valid date following the format YYYY-MM-DD
+         * Return only the leaves that had not finished before this date, meaning they end on or after it or have no end date at all. Usable on its own; pair it with `to` for a window.
          */
         from?: string;
         /**
@@ -24492,11 +24818,11 @@ export type GetApi20261001ResourcesTimeoffLeavesData = {
          */
         include_deleted_leaves: boolean;
         /**
-         * Retrieve approved leaves
+         * Set to true for leaves that were approved, false for leaves that were rejected. Leave it unset for every leave whatever its decision. Combining `approved: true` with `include_pending: true` returns approved and still-pending leaves together.
          */
         approved?: boolean;
         /**
-         * Retrieve pending leaves
+         * Set to true to include leaves still awaiting a decision. On its own it returns ONLY the pending ones; alongside `approved: true` it returns approved and pending together.
          */
         include_pending?: boolean;
         /**
@@ -24512,11 +24838,11 @@ export type GetApi20261001ResourcesTimeoffLeavesData = {
          */
         include_duration_by_day?: boolean;
         /**
-         * Retrieve workable leaves
+         * Set to true for leaves whose leave type counts as worked time, false for those that do not. Leave it unset to get both.
          */
         type_is_workable?: boolean;
         /**
-         * Retrieve payable leaves
+         * Set to true for leaves whose leave type is paid, false for unpaid ones. Leave it unset to get both.
          */
         type_is_payable?: boolean;
         /**
@@ -24637,7 +24963,7 @@ export type GetApi20261001ResourcesTimeoffLeavesByIdData = {
     body?: never;
     path: {
         /**
-         * The leave ids to retrieve
+         * Return only the leaves with these ids.
          */
         id: string;
     };
@@ -24785,19 +25111,19 @@ export type GetApi20261001ResourcesTimeoffLeaveTypesData = {
     path?: never;
     query?: {
         /**
-         * Identifiers of the leave types
+         * Return only the leave types with these ids.
          */
         'ids[]'?: Array<string>;
         /**
-         * Identifiers of the companies
+         * Return only the leave types of these companies.
          */
         'company_ids[]'?: Array<string>;
         /**
-         * Whether the leave type is active
+         * Set to true for the leave types currently in use, false for the retired ones. Leave it unset to get both.
          */
         active?: boolean;
         /**
-         * Whether the leave type is payable
+         * Set to true for the leave types that are paid, false for the unpaid ones. Leave it unset to get both.
          */
         payable?: boolean;
         /**
@@ -24805,11 +25131,11 @@ export type GetApi20261001ResourcesTimeoffLeaveTypesData = {
          */
         identifier?: unknown;
         /**
-         * Identifier of the employee
+         * Return only the leave types the time-off policy in force for this employee grants. It REQUIRES `reference_date`, which says on which date to resolve that policy: without it the read raises.
          */
         employee_id?: string;
         /**
-         * A reference date for the leave type
+         * The date on which to resolve the employee's time-off policy. Only meaningful alongside `employee_id`, and mandatory whenever that is given.
          */
         reference_date?: string;
         /**
@@ -24927,7 +25253,7 @@ export type GetApi20261001ResourcesTimeoffLeaveTypesByIdData = {
     body?: never;
     path: {
         /**
-         * Identifiers of the leave types
+         * Return only the leave types with these ids.
          */
         id: string;
     };