@factorialco/api-client 3.0.0-beta.2026100128 → 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
@@ -3468,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;
     /**
@@ -11857,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;