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

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

@@ -1497,15 +1497,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 +1629,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
@@ -1762,6 +1800,10 @@ export type ContractsContractVersion = {
      * the amount of money the employee earns in cents.
      */
     salary_amount?: number;
+    /**
+     * the currency of the salary amount, inherited from the governing legal entity.
+     */
+    salary_currency?: string;
     /**
      * the frequency of the salary payment.
      */
@@ -4077,7 +4119,7 @@ export type FinanceCategory = {
      */
     id: string;
     /**
-     * Custom label for the category
+     * The category's display name — the one shown in the UI and the one a person will call it by. It is the company's own label when they renamed the category, otherwise the translated default name. Match on this, never on `identifier`, which is a stable internal key that need not resemble the name (`restaurants` is displayed as "Meals").
      */
     label: string;
     /**
@@ -4089,7 +4131,7 @@ export type FinanceCategory = {
      */
     parent_category_id?: string;
     /**
-     * System identifier for the category
+     * Stable internal key for the category, for callers that hold one. NOT a display name and not derivable from one — `restaurants` is shown to everyone as "Meals" — so never present it to a user or match a user's wording against it; use `label` for both.
      */
     identifier: string;
     /**
@@ -4254,35 +4296,35 @@ export type FinanceCostCenterMembership = {
 };
 export type FinanceFinancialDocument = {
     /**
-     * Factorial unique identifier.
+     * Factorial unique identifier for the financial document.
      */
     id: string;
     /**
-     * Net amount in cents.
+     * Sum of the line items before taxes, in cents. Use `total_amount_cents` for what is actually payable.
      */
     net_amount_cents?: number;
     /**
-     * Total amount in cents.
+     * 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_amount_cents?: number;
     /**
-     * Document number.
+     * Number the issuer printed on the document; for a purchase, the vendor's own invoice number. Not a Factorial identifier: on a purchase it is only unique per vendor, so the same number can legitimately appear on documents from two different vendors.
      */
     document_number?: string;
     /**
-     * Document currency.
+     * ISO 4217 code of the currency the document is issued in, such as EUR or USD. Every amount on the document is expressed in it, so comparing amounts across documents without checking this is unsafe.
      */
     currency?: string;
     /**
-     * Current status.
+     * Where the document stands on its way to being paid: `processing` while it is still being prepared, `review` while it awaits review (the value is `review`, never `pending`), `sent_to_pay` once it has been sent for payment, and `paid`. This is not an approval state: a document generated from an employee expense is created already `paid`, because the money left before Factorial ever saw it.
      */
     status: 'processing' | 'review' | 'sent_to_pay' | 'paid';
     /**
-     * Due date.
+     * Date the payment falls due, as stated on the document.
      */
     due_date?: string;
     /**
-     * Document date.
+     * Date the issuer put on the document. Distinct from `created_at`, which is when it reached Factorial; a document can arrive weeks after it was issued.
      */
     document_date?: string;
     /**
@@ -4323,11 +4365,11 @@ export type FinanceFinancialDocument = {
         }>;
     }>;
     /**
-     * Date when was fully reconciled.
+     * When the document was fully matched against bank transactions. Null while any part of it remains unreconciled.
      */
     fully_reconciled_at?: string;
     /**
-     * Date when was recorded.
+     * When the document was posted to accounting. Only possible once `validated_at` is set.
      */
     recorded_at?: string;
     /**
@@ -4335,15 +4377,15 @@ export type FinanceFinancialDocument = {
      */
     duplicate_financial_document_id?: string;
     /**
-     * Date when was validated.
+     * When a person confirmed the document data is correct. Validation is what unlocks recording and payment; it is not an approval decision, and says nothing about whether the spend was authorised.
      */
     validated_at?: string;
     /**
-     * Factorial unique identifier for the user who validated the financial document.
+     * Factorial unique identifier of the employee who validated the document.
      */
     validated_by_id?: string;
     /**
-     * Type of the financial document. Using "invoice" as default.
+     * One of `invoice`, `receipt` or `credit_note`. A document generated from an expense is typed automatically and can flip between `receipt` and `invoice` when the employee edits the expense.
      */
     document_type: 'invoice' | 'receipt' | 'credit_note';
     /**
@@ -4351,7 +4393,7 @@ export type FinanceFinancialDocument = {
      */
     parent_financial_document_id?: string;
     /**
-     * Taxes total amount in cents.
+     * Sum of every tax charged on the document, in cents.
      */
     taxes_total_amount_cents?: number;
     /**
@@ -10987,6 +11029,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;
@@ -12145,7 +12191,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;
         /**
@@ -12307,6 +12353,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;
@@ -14175,7 +14280,7 @@ export type PostApi20261001ResourcesDocumentsDocumentsRestoreFromTrashBinRespons
 export type PostApi20261001ResourcesDocumentsDownloadUrlsBulkCreateData = {
     body?: {
         /**
-         * list of document identifiers.
+         * list of document identifiers (between 1 and 100).
          */
         ids?: Array<string>;
     };
@@ -14444,11 +14549,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;
         /**
@@ -16956,6 +17065,28 @@ export type GetApi20261001ResourcesIntegrationsSyncRunsResponses = {
     };
 };
 export type GetApi20261001ResourcesIntegrationsSyncRunsResponse = GetApi20261001ResourcesIntegrationsSyncRunsResponses[keyof GetApi20261001ResourcesIntegrationsSyncRunsResponses];
+export type PostApi20261001ResourcesIntegrationsSyncRunsData = {
+    body?: {
+        /**
+         * Identifier of the company the sync run belongs to.
+         */
+        company_id: string;
+        /**
+         * UUID of the marketplace integration to create a sync run for.
+         */
+        marketplace_integration_uuid: string;
+    };
+    path?: never;
+    query?: never;
+    url: '/api/2026-10-01/resources/integrations/sync_runs';
+};
+export type PostApi20261001ResourcesIntegrationsSyncRunsResponses = {
+    /**
+     * CREATED
+     */
+    201: IntegrationsSyncRun;
+};
+export type PostApi20261001ResourcesIntegrationsSyncRunsResponse = PostApi20261001ResourcesIntegrationsSyncRunsResponses[keyof PostApi20261001ResourcesIntegrationsSyncRunsResponses];
 export type GetApi20261001ResourcesIntegrationsSyncRunsByIdData = {
     body?: never;
     path: {
@@ -17169,7 +17300,7 @@ export type PostApi20261001ResourcesIntegrationsSyncableSyncRunsBulkUpsertData =
             /**
              * Outcome of processing the item
              */
-            status: 'success' | 'failed' | 'invalid';
+            status: 'running' | 'success' | 'failed' | 'invalid';
             /**
              * The Factorial record this item resolved to (link). Only fills a missing link; re-linking to a different record is rejected.
              */
@@ -24111,7 +24242,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>;
         /**
@@ -24123,7 +24254,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;
     };
@@ -24948,6 +25079,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;
@@ -26545,7 +26680,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
          */