@factorialco/api-client 3.0.0-beta.2026100113 → 3.0.0-beta.2026100115

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1426,13 +1426,9 @@ export type CompensationsEmployeesCompensation = {
1426
1426
  */
1427
1427
  amount_strategy_type: 'compensations_fixed_amount_strategy' | 'compensations_variable_amount_strategy' | 'compensations_per_worked_day_amount_strategy';
1428
1428
  /**
1429
- * Amount strategy id
1429
+ * Effective compensation value — the manual override when `amount_is_overwritten` is true, otherwise the strategy-computed value
1430
1430
  */
1431
- amount_strategy_id: string;
1432
- /**
1433
- * Manual override of the strategy-computed amount (nullable)
1434
- */
1435
- amount_overwritten?: number;
1431
+ amount?: number;
1436
1432
  /**
1437
1433
  * Whether the amount is a manual override
1438
1434
  */
@@ -1488,13 +1484,9 @@ export type CompensationsPayrollResult = {
1488
1484
  */
1489
1485
  amount_strategy_type: 'compensations_fixed_amount_strategy' | 'compensations_variable_amount_strategy' | 'compensations_per_worked_day_amount_strategy';
1490
1486
  /**
1491
- * Amount strategy id
1487
+ * Effective compensation value — the manual override when `amount_is_overwritten` is true, otherwise the strategy-computed value
1492
1488
  */
1493
- amount_strategy_id: string;
1494
- /**
1495
- * Manual override of the strategy-computed amount (nullable)
1496
- */
1497
- amount_overwritten?: number;
1489
+ amount?: number;
1498
1490
  /**
1499
1491
  * Whether the amount is a manual override
1500
1492
  */
@@ -4464,7 +4456,7 @@ export type IntegrationsSyncableSyncRun = {
4464
4456
  /**
4465
4457
  * Status of the syncable sync run
4466
4458
  */
4467
- status: 'success' | 'failed' | 'invalid';
4459
+ status: 'running' | 'success' | 'failed' | 'invalid';
4468
4460
  /**
4469
4461
  * Error or validation messages of the syncable sync run
4470
4462
  */
@@ -5481,10 +5473,6 @@ export type PerformanceReviewProcess = {
5481
5473
  * Date when the last bulk reminder was sent
5482
5474
  */
5483
5475
  last_bulk_reminder?: string;
5484
- /**
5485
- * Performance cycle ID
5486
- */
5487
- cycle_id?: string;
5488
5476
  };
5489
5477
  export type PerformanceReviewProcessCustomTemplate = {
5490
5478
  /**
@@ -15274,6 +15262,89 @@ export type GetApi20261001ResourcesFinanceFinancialDocumentsByIdResponses = {
15274
15262
  200: FinanceFinancialDocument;
15275
15263
  };
15276
15264
  export type GetApi20261001ResourcesFinanceFinancialDocumentsByIdResponse = GetApi20261001ResourcesFinanceFinancialDocumentsByIdResponses[keyof GetApi20261001ResourcesFinanceFinancialDocumentsByIdResponses];
15265
+ export type PutApi20261001ResourcesFinanceFinancialDocumentsByIdData = {
15266
+ body?: {
15267
+ /**
15268
+ * Company identifier, as returned by the credentials endpoint (`/resources/api_public/credentials`).
15269
+ */
15270
+ company_id: string;
15271
+ /**
15272
+ * Identifier of the financial document to update.
15273
+ */
15274
+ id: string;
15275
+ /**
15276
+ * Document currency (ISO 4217).
15277
+ */
15278
+ currency?: string;
15279
+ /**
15280
+ * Total amount in cents. Ignored when line_items are provided, since the line items own the totals.
15281
+ */
15282
+ total_amount_cents?: number;
15283
+ /**
15284
+ * Document number. Must be unique per vendor for purchases; a duplicate returns a 409 with the same machine-readable invoice_number error key as the create endpoint.
15285
+ */
15286
+ document_number?: string;
15287
+ /**
15288
+ * Document date.
15289
+ */
15290
+ document_date?: string;
15291
+ /**
15292
+ * Due date.
15293
+ */
15294
+ due_date?: string;
15295
+ /**
15296
+ * Status of the document. Transitions have real side effects: `sent_to_pay` enqueues a payment request in Factorial, and `paid` marks the document as paid (manual payment). Once a document is `sent_to_pay`, its payment lifecycle is owned by the payment flow in Factorial — do not set `paid` manually on it; the payment reconciliation does.
15297
+ */
15298
+ status: 'processing' | 'review' | 'sent_to_pay' | 'paid';
15299
+ /**
15300
+ * Validation timestamp, as returned by the read endpoint (e.g. `2020-01-01T00:00:00.000Z`). Setting it on a not-yet-validated document validates it: the strict required-field set (currency, amounts, document number, dates, vendor, legal entity) is enforced on that transition, not before.
15301
+ */
15302
+ validated_at?: string;
15303
+ /**
15304
+ * Tax breakdown, as returned by the read endpoint — send back what you read (adjusted to your changes). Replaced as sent; ignored when line_items are provided, since the line items own the totals.
15305
+ */
15306
+ taxes: Array<unknown>;
15307
+ /**
15308
+ * Purchase-invoice line items. Rows are addressed by id, never by position: rows carrying an id update the matching line item, rows without an id create new ones, and persisted rows missing from the set are deleted. Send an empty array to remove all line items, or omit the field entirely to leave them untouched. When present they own the document totals.
15309
+ */
15310
+ line_items?: Array<unknown>;
15311
+ /**
15312
+ * Legal entity identifier of the financial document.
15313
+ */
15314
+ legal_entity_id?: string;
15315
+ /**
15316
+ * Vendor identifier (Finance contact).
15317
+ */
15318
+ vendor_id?: string;
15319
+ /**
15320
+ * Type of the financial document. One of `invoice`, `credit_note`, `receipt`.
15321
+ */
15322
+ document_type?: 'invoice' | 'credit_note' | 'receipt';
15323
+ /**
15324
+ * For credit notes, the referenced original document by internal id (e.g. `135`).
15325
+ */
15326
+ parent_financial_document_id?: string;
15327
+ /**
15328
+ * Free-text internal notes about the financial document. Kept unchanged when the field is absent.
15329
+ */
15330
+ additional_information?: string;
15331
+ };
15332
+ path: {
15333
+ /**
15334
+ * Identifier of the financial document to update.
15335
+ */
15336
+ id: string;
15337
+ };
15338
+ query?: never;
15339
+ url: '/api/2026-10-01/resources/finance/financial_documents/{id}';
15340
+ };
15341
+ export type PutApi20261001ResourcesFinanceFinancialDocumentsByIdResponses = {
15342
+ /**
15343
+ * OK
15344
+ */
15345
+ 200: FinanceFinancialDocument;
15346
+ };
15347
+ export type PutApi20261001ResourcesFinanceFinancialDocumentsByIdResponse = PutApi20261001ResourcesFinanceFinancialDocumentsByIdResponses[keyof PutApi20261001ResourcesFinanceFinancialDocumentsByIdResponses];
15277
15348
  export type GetApi20261001ResourcesFinanceJournalEntriesData = {
15278
15349
  body?: never;
15279
15350
  path?: never;
@@ -15895,6 +15966,49 @@ export type GetApi20261001ResourcesIntegrationsSyncableItemsResponses = {
15895
15966
  };
15896
15967
  };
15897
15968
  export type GetApi20261001ResourcesIntegrationsSyncableItemsResponse = GetApi20261001ResourcesIntegrationsSyncableItemsResponses[keyof GetApi20261001ResourcesIntegrationsSyncableItemsResponses];
15969
+ export type GetApi20261001ResourcesIntegrationsSyncableSyncRunsData = {
15970
+ body?: never;
15971
+ path?: never;
15972
+ query?: {
15973
+ /**
15974
+ * Filter syncable sync runs by their identifiers
15975
+ */
15976
+ 'ids[]'?: Array<string>;
15977
+ /**
15978
+ * Filter syncable sync runs by the sync runs they belong to
15979
+ */
15980
+ 'sync_run_ids[]'?: Array<string>;
15981
+ };
15982
+ url: '/api/2026-10-01/resources/integrations/syncable_sync_runs';
15983
+ };
15984
+ export type GetApi20261001ResourcesIntegrationsSyncableSyncRunsResponses = {
15985
+ /**
15986
+ * OK
15987
+ */
15988
+ 200: {
15989
+ data?: Array<IntegrationsSyncableSyncRun>;
15990
+ meta?: PagedIndexMeta;
15991
+ };
15992
+ };
15993
+ export type GetApi20261001ResourcesIntegrationsSyncableSyncRunsResponse = GetApi20261001ResourcesIntegrationsSyncableSyncRunsResponses[keyof GetApi20261001ResourcesIntegrationsSyncableSyncRunsResponses];
15994
+ export type GetApi20261001ResourcesIntegrationsSyncableSyncRunsByIdData = {
15995
+ body?: never;
15996
+ path: {
15997
+ /**
15998
+ * Filter syncable sync runs by their identifiers
15999
+ */
16000
+ id: string;
16001
+ };
16002
+ query?: never;
16003
+ url: '/api/2026-10-01/resources/integrations/syncable_sync_runs/{id}';
16004
+ };
16005
+ export type GetApi20261001ResourcesIntegrationsSyncableSyncRunsByIdResponses = {
16006
+ /**
16007
+ * OK
16008
+ */
16009
+ 200: IntegrationsSyncableSyncRun;
16010
+ };
16011
+ export type GetApi20261001ResourcesIntegrationsSyncableSyncRunsByIdResponse = GetApi20261001ResourcesIntegrationsSyncableSyncRunsByIdResponses[keyof GetApi20261001ResourcesIntegrationsSyncableSyncRunsByIdResponses];
15898
16012
  export type PutApi20261001ResourcesIntegrationsSyncableSyncRunsByIdData = {
15899
16013
  body?: {
15900
16014
  /**
@@ -18087,10 +18201,6 @@ export type PostApi20261001ResourcesPerformanceReviewProcessesData = {
18087
18201
  * Assess employees based on their assigned competencies through both manager and self-reviews. Ensure roles with designated competencies are properly set up.
18088
18202
  */
18089
18203
  competencies_assessments_enabled?: boolean;
18090
- /**
18091
- * Performance cycle ID
18092
- */
18093
- cycle_id?: string;
18094
18204
  };
18095
18205
  path?: never;
18096
18206
  query?: never;