@factorialco/api-client 3.0.0-beta.2026100108 → 3.0.0-beta.2026100110
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.
- package/README.md +17 -0
- package/dist/cjs/generated/index.d.ts +2 -2
- package/dist/cjs/generated/index.d.ts.map +1 -1
- package/dist/cjs/generated/index.js +25 -12
- package/dist/cjs/generated/index.js.map +1 -1
- package/dist/cjs/generated/sdk.gen.d.ts +79 -1
- package/dist/cjs/generated/sdk.gen.d.ts.map +1 -1
- package/dist/cjs/generated/sdk.gen.js +161 -10
- package/dist/cjs/generated/sdk.gen.js.map +1 -1
- package/dist/cjs/generated/types.gen.d.ts +648 -4
- package/dist/cjs/generated/types.gen.d.ts.map +1 -1
- package/dist/cjs/sdk.d.ts +137 -1
- package/dist/cjs/sdk.d.ts.map +1 -1
- package/dist/cjs/sdk.js +156 -4
- package/dist/cjs/sdk.js.map +1 -1
- package/dist/esm/generated/index.d.ts +2 -2
- package/dist/esm/generated/index.d.ts.map +1 -1
- package/dist/esm/generated/index.js +1 -1
- package/dist/esm/generated/index.js.map +1 -1
- package/dist/esm/generated/sdk.gen.d.ts +79 -1
- package/dist/esm/generated/sdk.gen.d.ts.map +1 -1
- package/dist/esm/generated/sdk.gen.js +138 -0
- package/dist/esm/generated/sdk.gen.js.map +1 -1
- package/dist/esm/generated/types.gen.d.ts +648 -4
- package/dist/esm/generated/types.gen.d.ts.map +1 -1
- package/dist/esm/sdk.d.ts +137 -1
- package/dist/esm/sdk.d.ts.map +1 -1
- package/dist/esm/sdk.js +147 -1
- package/dist/esm/sdk.js.map +1 -1
- package/package.json +1 -1
|
@@ -1404,6 +1404,118 @@ export type CompensationsCycle = {
|
|
|
1404
1404
|
*/
|
|
1405
1405
|
updated_at?: string;
|
|
1406
1406
|
};
|
|
1407
|
+
export type CompensationsEmployeesCompensation = {
|
|
1408
|
+
/**
|
|
1409
|
+
* Employee compensation id
|
|
1410
|
+
*/
|
|
1411
|
+
id: string;
|
|
1412
|
+
/**
|
|
1413
|
+
* Employee id (participant of the payroll run)
|
|
1414
|
+
*/
|
|
1415
|
+
payroll_run_employee_id: string;
|
|
1416
|
+
/**
|
|
1417
|
+
* Payroll concept id
|
|
1418
|
+
*/
|
|
1419
|
+
payroll_concept_id: string;
|
|
1420
|
+
/**
|
|
1421
|
+
* Parent payroll run id
|
|
1422
|
+
*/
|
|
1423
|
+
payroll_run_id: string;
|
|
1424
|
+
/**
|
|
1425
|
+
* Amount strategy discriminator
|
|
1426
|
+
*/
|
|
1427
|
+
amount_strategy_type: 'compensations_fixed_amount_strategy' | 'compensations_variable_amount_strategy' | 'compensations_per_worked_day_amount_strategy';
|
|
1428
|
+
/**
|
|
1429
|
+
* Amount strategy id
|
|
1430
|
+
*/
|
|
1431
|
+
amount_strategy_id: string;
|
|
1432
|
+
/**
|
|
1433
|
+
* Manual override of the strategy-computed amount (nullable)
|
|
1434
|
+
*/
|
|
1435
|
+
amount_overwritten?: number;
|
|
1436
|
+
/**
|
|
1437
|
+
* Whether the amount is a manual override
|
|
1438
|
+
*/
|
|
1439
|
+
amount_is_overwritten: boolean;
|
|
1440
|
+
/**
|
|
1441
|
+
* Row projection type (always `compensation` on this endpoint)
|
|
1442
|
+
*/
|
|
1443
|
+
result_type?: 'compensation' | 'payroll_result';
|
|
1444
|
+
/**
|
|
1445
|
+
* Source type discriminator (nullable — dashboard-created rows have no source)
|
|
1446
|
+
*/
|
|
1447
|
+
source_type?: 'compensations_compensationpolicy' | 'timesettings_customtimerangecategory' | 'expenses_expensable' | 'expenses_expense' | 'expenses_mileage' | 'benefits_compensation' | 'salary_advance_request' | 'incentives_compensationplanrequest' | 'attendance_review';
|
|
1448
|
+
/**
|
|
1449
|
+
* Source id (nullable — dashboard-created rows have no source)
|
|
1450
|
+
*/
|
|
1451
|
+
source_id?: string;
|
|
1452
|
+
/**
|
|
1453
|
+
* Employee id of the author (nullable)
|
|
1454
|
+
*/
|
|
1455
|
+
created_by_employee_id?: string;
|
|
1456
|
+
/**
|
|
1457
|
+
* Employee id of the last updater (nullable)
|
|
1458
|
+
*/
|
|
1459
|
+
last_updated_by_employee_id?: string;
|
|
1460
|
+
/**
|
|
1461
|
+
* Timestamp when the compensation record was created
|
|
1462
|
+
*/
|
|
1463
|
+
created_at: string;
|
|
1464
|
+
/**
|
|
1465
|
+
* Timestamp when the compensation record was last updated
|
|
1466
|
+
*/
|
|
1467
|
+
updated_at: string;
|
|
1468
|
+
};
|
|
1469
|
+
export type CompensationsPayrollResult = {
|
|
1470
|
+
/**
|
|
1471
|
+
* Payroll result id
|
|
1472
|
+
*/
|
|
1473
|
+
id: string;
|
|
1474
|
+
/**
|
|
1475
|
+
* Parent payroll run id
|
|
1476
|
+
*/
|
|
1477
|
+
payroll_run_id: string;
|
|
1478
|
+
/**
|
|
1479
|
+
* Employee id (participant of the payroll run)
|
|
1480
|
+
*/
|
|
1481
|
+
payroll_run_employee_id: string;
|
|
1482
|
+
/**
|
|
1483
|
+
* Payroll concept id
|
|
1484
|
+
*/
|
|
1485
|
+
payroll_concept_id: string;
|
|
1486
|
+
/**
|
|
1487
|
+
* Amount strategy discriminator
|
|
1488
|
+
*/
|
|
1489
|
+
amount_strategy_type: 'compensations_fixed_amount_strategy' | 'compensations_variable_amount_strategy' | 'compensations_per_worked_day_amount_strategy';
|
|
1490
|
+
/**
|
|
1491
|
+
* Amount strategy id
|
|
1492
|
+
*/
|
|
1493
|
+
amount_strategy_id: string;
|
|
1494
|
+
/**
|
|
1495
|
+
* Manual override of the strategy-computed amount (nullable)
|
|
1496
|
+
*/
|
|
1497
|
+
amount_overwritten?: number;
|
|
1498
|
+
/**
|
|
1499
|
+
* Whether the amount is a manual override
|
|
1500
|
+
*/
|
|
1501
|
+
amount_is_overwritten: boolean;
|
|
1502
|
+
/**
|
|
1503
|
+
* Source type discriminator (always present for payroll_result)
|
|
1504
|
+
*/
|
|
1505
|
+
source_type: 'compensations_compensationpolicy' | 'timesettings_customtimerangecategory' | 'expenses_expensable' | 'expenses_expense' | 'expenses_mileage' | 'benefits_compensation' | 'salary_advance_request' | 'incentives_compensationplanrequest' | 'attendance_review';
|
|
1506
|
+
/**
|
|
1507
|
+
* Source id (always present for payroll_result)
|
|
1508
|
+
*/
|
|
1509
|
+
source_id: string;
|
|
1510
|
+
/**
|
|
1511
|
+
* Timestamp when the payroll_result row was created
|
|
1512
|
+
*/
|
|
1513
|
+
created_at: string;
|
|
1514
|
+
/**
|
|
1515
|
+
* Timestamp when the payroll_result row was last updated
|
|
1516
|
+
*/
|
|
1517
|
+
updated_at: string;
|
|
1518
|
+
};
|
|
1407
1519
|
export type CompensationsPayrollRun = {
|
|
1408
1520
|
/**
|
|
1409
1521
|
* Payroll run id
|
|
@@ -4342,7 +4454,7 @@ export type IntegrationsSyncableItem = {
|
|
|
4342
4454
|
/**
|
|
4343
4455
|
* Type of the syncable item
|
|
4344
4456
|
*/
|
|
4345
|
-
syncable_type: 'compensations/compensation' | 'expenses/expense' | 'employee_updates/leave' | 'finance/vendor';
|
|
4457
|
+
syncable_type: 'compensations/compensation' | 'expenses/expense' | 'employee_updates/leave' | 'employee_updates/worked_time' | 'finance/vendor';
|
|
4346
4458
|
};
|
|
4347
4459
|
export type IntegrationsSyncableSyncRun = {
|
|
4348
4460
|
/**
|
|
@@ -5615,6 +5727,70 @@ export type PostsPost = {
|
|
|
5615
5727
|
posts_group_id?: string;
|
|
5616
5728
|
comments_count: number;
|
|
5617
5729
|
};
|
|
5730
|
+
export type ProcurementPoFieldValue = {
|
|
5731
|
+
/**
|
|
5732
|
+
* The id of the field value
|
|
5733
|
+
*/
|
|
5734
|
+
id: string;
|
|
5735
|
+
/**
|
|
5736
|
+
* Identifier of the company
|
|
5737
|
+
*/
|
|
5738
|
+
company_id: string;
|
|
5739
|
+
/**
|
|
5740
|
+
* The purchase order this value belongs to
|
|
5741
|
+
*/
|
|
5742
|
+
purchase_order_id: string;
|
|
5743
|
+
/**
|
|
5744
|
+
* The field definition this value corresponds to
|
|
5745
|
+
*/
|
|
5746
|
+
field_definition_id: string;
|
|
5747
|
+
/**
|
|
5748
|
+
* The line item this value belongs to (null for header-level values)
|
|
5749
|
+
*/
|
|
5750
|
+
line_item_id?: string;
|
|
5751
|
+
/**
|
|
5752
|
+
* The stored value as a string (type-cast based on field definition)
|
|
5753
|
+
*/
|
|
5754
|
+
value?: string;
|
|
5755
|
+
/**
|
|
5756
|
+
* Human-readable display name for entity-type fields (resolved at read time)
|
|
5757
|
+
*/
|
|
5758
|
+
display_value?: string;
|
|
5759
|
+
/**
|
|
5760
|
+
* When this field value was created
|
|
5761
|
+
*/
|
|
5762
|
+
created_at: string;
|
|
5763
|
+
/**
|
|
5764
|
+
* When this field value was last updated
|
|
5765
|
+
*/
|
|
5766
|
+
updated_at: string;
|
|
5767
|
+
};
|
|
5768
|
+
export type ProcurementPoLineItem = {
|
|
5769
|
+
/**
|
|
5770
|
+
* The id of the line item
|
|
5771
|
+
*/
|
|
5772
|
+
id: string;
|
|
5773
|
+
/**
|
|
5774
|
+
* Identifier of the company
|
|
5775
|
+
*/
|
|
5776
|
+
company_id: string;
|
|
5777
|
+
/**
|
|
5778
|
+
* The purchase order this line item belongs to
|
|
5779
|
+
*/
|
|
5780
|
+
purchase_order_id: string;
|
|
5781
|
+
/**
|
|
5782
|
+
* The display position of the line item
|
|
5783
|
+
*/
|
|
5784
|
+
position: number;
|
|
5785
|
+
/**
|
|
5786
|
+
* When this line item was created
|
|
5787
|
+
*/
|
|
5788
|
+
created_at: string;
|
|
5789
|
+
/**
|
|
5790
|
+
* When this line item was last updated
|
|
5791
|
+
*/
|
|
5792
|
+
updated_at: string;
|
|
5793
|
+
};
|
|
5618
5794
|
export type ProcurementPoTemplate = {
|
|
5619
5795
|
/**
|
|
5620
5796
|
* The id of the PO template
|
|
@@ -5796,9 +5972,9 @@ export type ProcurementPurchaseOrder = {
|
|
|
5796
5972
|
*/
|
|
5797
5973
|
vendor_id?: string;
|
|
5798
5974
|
/**
|
|
5799
|
-
* Identifier of the purchase request that generated this purchase order
|
|
5975
|
+
* Identifier of the purchase request that generated this purchase order, if any. Externally-created purchase orders (e.g. synced from an ERP) have no purchase request.
|
|
5800
5976
|
*/
|
|
5801
|
-
purchase_request_id
|
|
5977
|
+
purchase_request_id?: string;
|
|
5802
5978
|
/**
|
|
5803
5979
|
* Identifier of the legal entity that owns this purchase order
|
|
5804
5980
|
*/
|
|
@@ -5811,6 +5987,10 @@ export type ProcurementPurchaseOrder = {
|
|
|
5811
5987
|
* Formatted purchase order number with prefix (e.g., PO-00001)
|
|
5812
5988
|
*/
|
|
5813
5989
|
formatted_po_number: string;
|
|
5990
|
+
/**
|
|
5991
|
+
* Identifier of the pinned PO template version this purchase order uses. Fetch that version (and its field definitions) to interpret the purchase order's header and line-item field keys. Null for legacy purchase orders created without a template.
|
|
5992
|
+
*/
|
|
5993
|
+
po_template_version_id?: string;
|
|
5814
5994
|
};
|
|
5815
5995
|
export type ProcurementPurchaseRequest = {
|
|
5816
5996
|
/**
|
|
@@ -6228,6 +6408,59 @@ export type ProjectManagementProjectWorker = {
|
|
|
6228
6408
|
*/
|
|
6229
6409
|
spending_cost_cents?: number;
|
|
6230
6410
|
};
|
|
6411
|
+
export type ProjectManagementRate = {
|
|
6412
|
+
/**
|
|
6413
|
+
* The id of the rate
|
|
6414
|
+
*/
|
|
6415
|
+
id: string;
|
|
6416
|
+
/**
|
|
6417
|
+
* The id of the company the rate belongs to
|
|
6418
|
+
*/
|
|
6419
|
+
company_id: string;
|
|
6420
|
+
/**
|
|
6421
|
+
* The id of the project the rate belongs to
|
|
6422
|
+
*/
|
|
6423
|
+
project_id?: string;
|
|
6424
|
+
quote_id?: string;
|
|
6425
|
+
reference_rate_id?: string;
|
|
6426
|
+
/**
|
|
6427
|
+
* The id of the resource the rate applies to. Together with resource_kind it forms the resource's composite identity.
|
|
6428
|
+
*/
|
|
6429
|
+
resource_id: string;
|
|
6430
|
+
/**
|
|
6431
|
+
* The kind of resource the rate applies to. Together with resource_id it forms the resource's composite identity.
|
|
6432
|
+
*/
|
|
6433
|
+
resource_kind: 'project_worker' | 'project' | 'employee' | 'job_catalog_tree_node';
|
|
6434
|
+
/**
|
|
6435
|
+
* The date from which the rate applies
|
|
6436
|
+
*/
|
|
6437
|
+
starts_on: string;
|
|
6438
|
+
ends_on?: string;
|
|
6439
|
+
/**
|
|
6440
|
+
* The charging cost in cents
|
|
6441
|
+
*/
|
|
6442
|
+
charging_cost_cents: number;
|
|
6443
|
+
/**
|
|
6444
|
+
* The billing rate in cents
|
|
6445
|
+
*/
|
|
6446
|
+
billing_rate_cents: number;
|
|
6447
|
+
/**
|
|
6448
|
+
* The markup-on-cost percentage in cents (e.g. 3000 = 30%)
|
|
6449
|
+
*/
|
|
6450
|
+
markup_percentage_cents: number;
|
|
6451
|
+
/**
|
|
6452
|
+
* Computed profit margin on price in cents = (billing - charging) / billing * 10000. Returns 0 when billing equals charging, and -10000 when billing is zero.
|
|
6453
|
+
*/
|
|
6454
|
+
margin_percentage_cents: number;
|
|
6455
|
+
/**
|
|
6456
|
+
* The currency of the rate
|
|
6457
|
+
*/
|
|
6458
|
+
currency: string;
|
|
6459
|
+
/**
|
|
6460
|
+
* Whether the rate is custom
|
|
6461
|
+
*/
|
|
6462
|
+
unlinked: boolean;
|
|
6463
|
+
};
|
|
6231
6464
|
export type ProjectManagementSubproject = {
|
|
6232
6465
|
/**
|
|
6233
6466
|
* The id of the subproject
|
|
@@ -9861,7 +10094,7 @@ export type PostApi20261001ResourcesAttendanceShiftsData = {
|
|
|
9861
10094
|
/**
|
|
9862
10095
|
* Source of the shift creation
|
|
9863
10096
|
*/
|
|
9864
|
-
source?: 'desktop' | 'mobile' | 'face_recognition' | 'qr_code' | 'mobile_geolocation' | 'shared_device' | 'api' | 'system';
|
|
10097
|
+
source?: 'desktop' | 'mobile' | 'face_recognition' | 'qr_code' | 'mobile_geolocation' | 'shared_device' | 'api' | 'system' | 'one_assistant';
|
|
9865
10098
|
/**
|
|
9866
10099
|
* Id of the break configuration
|
|
9867
10100
|
*/
|
|
@@ -10860,6 +11093,232 @@ export type GetApi20261001ResourcesCompensationsCyclesByIdResponses = {
|
|
|
10860
11093
|
200: CompensationsCycle;
|
|
10861
11094
|
};
|
|
10862
11095
|
export type GetApi20261001ResourcesCompensationsCyclesByIdResponse = GetApi20261001ResourcesCompensationsCyclesByIdResponses[keyof GetApi20261001ResourcesCompensationsCyclesByIdResponses];
|
|
11096
|
+
export type GetApi20261001ResourcesCompensationsEmployeesCompensationsData = {
|
|
11097
|
+
body?: never;
|
|
11098
|
+
path?: never;
|
|
11099
|
+
query?: {
|
|
11100
|
+
/**
|
|
11101
|
+
* Employee compensation ids
|
|
11102
|
+
*/
|
|
11103
|
+
'ids[]'?: Array<string>;
|
|
11104
|
+
/**
|
|
11105
|
+
* Filter by payroll run ids, refers to compensations/payroll_runs endpoint.
|
|
11106
|
+
*/
|
|
11107
|
+
'payroll_run_ids[]'?: Array<string>;
|
|
11108
|
+
/**
|
|
11109
|
+
* Filter by parent cycle ids, refers to compensations/cycles endpoint.
|
|
11110
|
+
*/
|
|
11111
|
+
'cycle_ids[]'?: Array<string>;
|
|
11112
|
+
/**
|
|
11113
|
+
* Filter by employee ids (participants of the payroll run)
|
|
11114
|
+
*/
|
|
11115
|
+
'payroll_run_employee_ids[]'?: Array<string>;
|
|
11116
|
+
/**
|
|
11117
|
+
* Filter by payroll concept ids, refers to compensations/concepts endpoint.
|
|
11118
|
+
*/
|
|
11119
|
+
'payroll_concept_ids[]'?: Array<string>;
|
|
11120
|
+
};
|
|
11121
|
+
url: '/api/2026-10-01/resources/compensations/employees_compensations';
|
|
11122
|
+
};
|
|
11123
|
+
export type GetApi20261001ResourcesCompensationsEmployeesCompensationsResponses = {
|
|
11124
|
+
/**
|
|
11125
|
+
* OK
|
|
11126
|
+
*/
|
|
11127
|
+
200: {
|
|
11128
|
+
data?: Array<CompensationsEmployeesCompensation>;
|
|
11129
|
+
meta?: PagedIndexMeta;
|
|
11130
|
+
};
|
|
11131
|
+
};
|
|
11132
|
+
export type GetApi20261001ResourcesCompensationsEmployeesCompensationsResponse = GetApi20261001ResourcesCompensationsEmployeesCompensationsResponses[keyof GetApi20261001ResourcesCompensationsEmployeesCompensationsResponses];
|
|
11133
|
+
export type PostApi20261001ResourcesCompensationsEmployeesCompensationsData = {
|
|
11134
|
+
body?: {
|
|
11135
|
+
/**
|
|
11136
|
+
* Parent payroll run id, refers to compensations/payroll_runs endpoint.
|
|
11137
|
+
*/
|
|
11138
|
+
payroll_run_id: string;
|
|
11139
|
+
/**
|
|
11140
|
+
* Employee id (participant of the payroll run), refers to employees/employees endpoint.
|
|
11141
|
+
*/
|
|
11142
|
+
employee_id: string;
|
|
11143
|
+
/**
|
|
11144
|
+
* Payroll concept id, refers to compensations/concepts endpoint.
|
|
11145
|
+
*/
|
|
11146
|
+
concept_id: string;
|
|
11147
|
+
/**
|
|
11148
|
+
* Amount value (nullable; required when is_overwritten=true)
|
|
11149
|
+
*/
|
|
11150
|
+
amount?: number;
|
|
11151
|
+
/**
|
|
11152
|
+
* When true, the provided `amount` becomes `amount_overwritten`
|
|
11153
|
+
*/
|
|
11154
|
+
is_overwritten: boolean;
|
|
11155
|
+
/**
|
|
11156
|
+
* Amount strategy discriminator
|
|
11157
|
+
*/
|
|
11158
|
+
strategy_type?: 'compensations_fixed_amount_strategy' | 'compensations_variable_amount_strategy' | 'compensations_per_worked_day_amount_strategy';
|
|
11159
|
+
/**
|
|
11160
|
+
* Unit symbol (e.g. `EUR`)
|
|
11161
|
+
*/
|
|
11162
|
+
unit_symbol?: string;
|
|
11163
|
+
/**
|
|
11164
|
+
* Upper limit for variable strategy (ignored for fixed / per_worked_day)
|
|
11165
|
+
*/
|
|
11166
|
+
upper_limit?: number;
|
|
11167
|
+
/**
|
|
11168
|
+
* Per-day rate (only used for per_worked_day strategy)
|
|
11169
|
+
*/
|
|
11170
|
+
per_day_rate?: number;
|
|
11171
|
+
};
|
|
11172
|
+
path?: never;
|
|
11173
|
+
query?: never;
|
|
11174
|
+
url: '/api/2026-10-01/resources/compensations/employees_compensations';
|
|
11175
|
+
};
|
|
11176
|
+
export type PostApi20261001ResourcesCompensationsEmployeesCompensationsResponses = {
|
|
11177
|
+
/**
|
|
11178
|
+
* CREATED
|
|
11179
|
+
*/
|
|
11180
|
+
201: CompensationsEmployeesCompensation;
|
|
11181
|
+
};
|
|
11182
|
+
export type PostApi20261001ResourcesCompensationsEmployeesCompensationsResponse = PostApi20261001ResourcesCompensationsEmployeesCompensationsResponses[keyof PostApi20261001ResourcesCompensationsEmployeesCompensationsResponses];
|
|
11183
|
+
export type DeleteApi20261001ResourcesCompensationsEmployeesCompensationsByIdData = {
|
|
11184
|
+
body?: never;
|
|
11185
|
+
path: {
|
|
11186
|
+
/**
|
|
11187
|
+
* Employee compensation id to delete
|
|
11188
|
+
*/
|
|
11189
|
+
id: string;
|
|
11190
|
+
};
|
|
11191
|
+
query?: never;
|
|
11192
|
+
url: '/api/2026-10-01/resources/compensations/employees_compensations/{id}';
|
|
11193
|
+
};
|
|
11194
|
+
export type DeleteApi20261001ResourcesCompensationsEmployeesCompensationsByIdResponses = {
|
|
11195
|
+
/**
|
|
11196
|
+
* OK
|
|
11197
|
+
*/
|
|
11198
|
+
200: CompensationsEmployeesCompensation;
|
|
11199
|
+
};
|
|
11200
|
+
export type DeleteApi20261001ResourcesCompensationsEmployeesCompensationsByIdResponse = DeleteApi20261001ResourcesCompensationsEmployeesCompensationsByIdResponses[keyof DeleteApi20261001ResourcesCompensationsEmployeesCompensationsByIdResponses];
|
|
11201
|
+
export type GetApi20261001ResourcesCompensationsEmployeesCompensationsByIdData = {
|
|
11202
|
+
body?: never;
|
|
11203
|
+
path: {
|
|
11204
|
+
/**
|
|
11205
|
+
* Employee compensation ids
|
|
11206
|
+
*/
|
|
11207
|
+
id: string;
|
|
11208
|
+
};
|
|
11209
|
+
query?: never;
|
|
11210
|
+
url: '/api/2026-10-01/resources/compensations/employees_compensations/{id}';
|
|
11211
|
+
};
|
|
11212
|
+
export type GetApi20261001ResourcesCompensationsEmployeesCompensationsByIdResponses = {
|
|
11213
|
+
/**
|
|
11214
|
+
* OK
|
|
11215
|
+
*/
|
|
11216
|
+
200: CompensationsEmployeesCompensation;
|
|
11217
|
+
};
|
|
11218
|
+
export type GetApi20261001ResourcesCompensationsEmployeesCompensationsByIdResponse = GetApi20261001ResourcesCompensationsEmployeesCompensationsByIdResponses[keyof GetApi20261001ResourcesCompensationsEmployeesCompensationsByIdResponses];
|
|
11219
|
+
export type PutApi20261001ResourcesCompensationsEmployeesCompensationsByIdData = {
|
|
11220
|
+
body?: {
|
|
11221
|
+
/**
|
|
11222
|
+
* Employee compensation id
|
|
11223
|
+
*/
|
|
11224
|
+
id: string;
|
|
11225
|
+
amount?: number;
|
|
11226
|
+
/**
|
|
11227
|
+
* Manual override of the strategy-computed amount; not allowed on fixed-strategy rows (422 `overwrite_not_applicable`)
|
|
11228
|
+
*/
|
|
11229
|
+
amount_overwritten?: number;
|
|
11230
|
+
/**
|
|
11231
|
+
* When true, the provided `amount` becomes `amount_overwritten`
|
|
11232
|
+
*/
|
|
11233
|
+
is_overwritten: boolean;
|
|
11234
|
+
/**
|
|
11235
|
+
* Amount strategy discriminator
|
|
11236
|
+
*/
|
|
11237
|
+
strategy_type?: 'compensations_fixed_amount_strategy' | 'compensations_variable_amount_strategy' | 'compensations_per_worked_day_amount_strategy';
|
|
11238
|
+
/**
|
|
11239
|
+
* Unit symbol (e.g. `EUR`)
|
|
11240
|
+
*/
|
|
11241
|
+
unit_symbol?: string;
|
|
11242
|
+
/**
|
|
11243
|
+
* Upper limit for variable-strategy compensations (nullable; ignored on fixed / per_worked_day strategies)
|
|
11244
|
+
*/
|
|
11245
|
+
upper_limit?: number;
|
|
11246
|
+
/**
|
|
11247
|
+
* Per-day rate for per_worked_day strategies (nullable; ignored on fixed / variable strategies)
|
|
11248
|
+
*/
|
|
11249
|
+
per_day_rate?: number;
|
|
11250
|
+
};
|
|
11251
|
+
path: {
|
|
11252
|
+
/**
|
|
11253
|
+
* Employee compensation id
|
|
11254
|
+
*/
|
|
11255
|
+
id: string;
|
|
11256
|
+
};
|
|
11257
|
+
query?: never;
|
|
11258
|
+
url: '/api/2026-10-01/resources/compensations/employees_compensations/{id}';
|
|
11259
|
+
};
|
|
11260
|
+
export type PutApi20261001ResourcesCompensationsEmployeesCompensationsByIdResponses = {
|
|
11261
|
+
/**
|
|
11262
|
+
* OK
|
|
11263
|
+
*/
|
|
11264
|
+
200: CompensationsEmployeesCompensation;
|
|
11265
|
+
};
|
|
11266
|
+
export type PutApi20261001ResourcesCompensationsEmployeesCompensationsByIdResponse = PutApi20261001ResourcesCompensationsEmployeesCompensationsByIdResponses[keyof PutApi20261001ResourcesCompensationsEmployeesCompensationsByIdResponses];
|
|
11267
|
+
export type GetApi20261001ResourcesCompensationsPayrollResultsData = {
|
|
11268
|
+
body?: never;
|
|
11269
|
+
path?: never;
|
|
11270
|
+
query?: {
|
|
11271
|
+
/**
|
|
11272
|
+
* Payroll result ids
|
|
11273
|
+
*/
|
|
11274
|
+
'ids[]'?: Array<string>;
|
|
11275
|
+
/**
|
|
11276
|
+
* Filter by payroll run ids, refers to compensations/payroll_runs endpoint.
|
|
11277
|
+
*/
|
|
11278
|
+
'payroll_run_ids[]'?: Array<string>;
|
|
11279
|
+
/**
|
|
11280
|
+
* Filter by parent cycle ids, refers to compensations/cycles endpoint.
|
|
11281
|
+
*/
|
|
11282
|
+
'cycle_ids[]'?: Array<string>;
|
|
11283
|
+
/**
|
|
11284
|
+
* Filter by employee ids (participants of the payroll run)
|
|
11285
|
+
*/
|
|
11286
|
+
'payroll_run_employee_ids[]'?: Array<string>;
|
|
11287
|
+
/**
|
|
11288
|
+
* Filter by payroll concept ids, refers to compensations/concepts endpoint.
|
|
11289
|
+
*/
|
|
11290
|
+
'payroll_concept_ids[]'?: Array<string>;
|
|
11291
|
+
};
|
|
11292
|
+
url: '/api/2026-10-01/resources/compensations/payroll_results';
|
|
11293
|
+
};
|
|
11294
|
+
export type GetApi20261001ResourcesCompensationsPayrollResultsResponses = {
|
|
11295
|
+
/**
|
|
11296
|
+
* OK
|
|
11297
|
+
*/
|
|
11298
|
+
200: {
|
|
11299
|
+
data?: Array<CompensationsPayrollResult>;
|
|
11300
|
+
meta?: PagedIndexMeta;
|
|
11301
|
+
};
|
|
11302
|
+
};
|
|
11303
|
+
export type GetApi20261001ResourcesCompensationsPayrollResultsResponse = GetApi20261001ResourcesCompensationsPayrollResultsResponses[keyof GetApi20261001ResourcesCompensationsPayrollResultsResponses];
|
|
11304
|
+
export type GetApi20261001ResourcesCompensationsPayrollResultsByIdData = {
|
|
11305
|
+
body?: never;
|
|
11306
|
+
path: {
|
|
11307
|
+
/**
|
|
11308
|
+
* Payroll result ids
|
|
11309
|
+
*/
|
|
11310
|
+
id: string;
|
|
11311
|
+
};
|
|
11312
|
+
query?: never;
|
|
11313
|
+
url: '/api/2026-10-01/resources/compensations/payroll_results/{id}';
|
|
11314
|
+
};
|
|
11315
|
+
export type GetApi20261001ResourcesCompensationsPayrollResultsByIdResponses = {
|
|
11316
|
+
/**
|
|
11317
|
+
* OK
|
|
11318
|
+
*/
|
|
11319
|
+
200: CompensationsPayrollResult;
|
|
11320
|
+
};
|
|
11321
|
+
export type GetApi20261001ResourcesCompensationsPayrollResultsByIdResponse = GetApi20261001ResourcesCompensationsPayrollResultsByIdResponses[keyof GetApi20261001ResourcesCompensationsPayrollResultsByIdResponses];
|
|
10863
11322
|
export type GetApi20261001ResourcesCompensationsPayrollRunsData = {
|
|
10864
11323
|
body?: never;
|
|
10865
11324
|
path?: never;
|
|
@@ -18747,6 +19206,100 @@ export type PutApi20261001ResourcesPostsPostsByIdResponses = {
|
|
|
18747
19206
|
200: PostsPost;
|
|
18748
19207
|
};
|
|
18749
19208
|
export type PutApi20261001ResourcesPostsPostsByIdResponse = PutApi20261001ResourcesPostsPostsByIdResponses[keyof PutApi20261001ResourcesPostsPostsByIdResponses];
|
|
19209
|
+
export type GetApi20261001ResourcesProcurementPoFieldValuesData = {
|
|
19210
|
+
body?: never;
|
|
19211
|
+
path?: never;
|
|
19212
|
+
query?: {
|
|
19213
|
+
/**
|
|
19214
|
+
* An array of field value IDs to filter by.
|
|
19215
|
+
*/
|
|
19216
|
+
'ids[]'?: Array<string>;
|
|
19217
|
+
/**
|
|
19218
|
+
* An array of purchase order IDs to filter values for.
|
|
19219
|
+
*/
|
|
19220
|
+
'purchase_order_ids[]'?: Array<string>;
|
|
19221
|
+
/**
|
|
19222
|
+
* Restrict results to values belonging to these line items. Header-level values (not associated with any line item) are never returned when this is set. Mutually exclusive with `exclude_line_items=true` — combining both returns no results.
|
|
19223
|
+
*/
|
|
19224
|
+
'line_item_ids[]'?: Array<string>;
|
|
19225
|
+
/**
|
|
19226
|
+
* When true, excludes per-line values and returns only values not associated with any line item (i.e. header-level). Mutually exclusive with `line_item_ids`.
|
|
19227
|
+
*/
|
|
19228
|
+
exclude_line_items?: boolean;
|
|
19229
|
+
};
|
|
19230
|
+
url: '/api/2026-10-01/resources/procurement/po_field_values';
|
|
19231
|
+
};
|
|
19232
|
+
export type GetApi20261001ResourcesProcurementPoFieldValuesResponses = {
|
|
19233
|
+
/**
|
|
19234
|
+
* OK
|
|
19235
|
+
*/
|
|
19236
|
+
200: {
|
|
19237
|
+
data?: Array<ProcurementPoFieldValue>;
|
|
19238
|
+
meta?: PagedIndexMeta;
|
|
19239
|
+
};
|
|
19240
|
+
};
|
|
19241
|
+
export type GetApi20261001ResourcesProcurementPoFieldValuesResponse = GetApi20261001ResourcesProcurementPoFieldValuesResponses[keyof GetApi20261001ResourcesProcurementPoFieldValuesResponses];
|
|
19242
|
+
export type GetApi20261001ResourcesProcurementPoFieldValuesByIdData = {
|
|
19243
|
+
body?: never;
|
|
19244
|
+
path: {
|
|
19245
|
+
/**
|
|
19246
|
+
* An array of field value IDs to filter by.
|
|
19247
|
+
*/
|
|
19248
|
+
id: string;
|
|
19249
|
+
};
|
|
19250
|
+
query?: never;
|
|
19251
|
+
url: '/api/2026-10-01/resources/procurement/po_field_values/{id}';
|
|
19252
|
+
};
|
|
19253
|
+
export type GetApi20261001ResourcesProcurementPoFieldValuesByIdResponses = {
|
|
19254
|
+
/**
|
|
19255
|
+
* OK
|
|
19256
|
+
*/
|
|
19257
|
+
200: ProcurementPoFieldValue;
|
|
19258
|
+
};
|
|
19259
|
+
export type GetApi20261001ResourcesProcurementPoFieldValuesByIdResponse = GetApi20261001ResourcesProcurementPoFieldValuesByIdResponses[keyof GetApi20261001ResourcesProcurementPoFieldValuesByIdResponses];
|
|
19260
|
+
export type GetApi20261001ResourcesProcurementPoLineItemsData = {
|
|
19261
|
+
body?: never;
|
|
19262
|
+
path?: never;
|
|
19263
|
+
query?: {
|
|
19264
|
+
/**
|
|
19265
|
+
* An array of line item IDs to filter by.
|
|
19266
|
+
*/
|
|
19267
|
+
'ids[]'?: Array<string>;
|
|
19268
|
+
/**
|
|
19269
|
+
* An array of purchase order IDs to filter line items for.
|
|
19270
|
+
*/
|
|
19271
|
+
'purchase_order_ids[]'?: Array<string>;
|
|
19272
|
+
};
|
|
19273
|
+
url: '/api/2026-10-01/resources/procurement/po_line_items';
|
|
19274
|
+
};
|
|
19275
|
+
export type GetApi20261001ResourcesProcurementPoLineItemsResponses = {
|
|
19276
|
+
/**
|
|
19277
|
+
* OK
|
|
19278
|
+
*/
|
|
19279
|
+
200: {
|
|
19280
|
+
data?: Array<ProcurementPoLineItem>;
|
|
19281
|
+
meta?: PagedIndexMeta;
|
|
19282
|
+
};
|
|
19283
|
+
};
|
|
19284
|
+
export type GetApi20261001ResourcesProcurementPoLineItemsResponse = GetApi20261001ResourcesProcurementPoLineItemsResponses[keyof GetApi20261001ResourcesProcurementPoLineItemsResponses];
|
|
19285
|
+
export type GetApi20261001ResourcesProcurementPoLineItemsByIdData = {
|
|
19286
|
+
body?: never;
|
|
19287
|
+
path: {
|
|
19288
|
+
/**
|
|
19289
|
+
* An array of line item IDs to filter by.
|
|
19290
|
+
*/
|
|
19291
|
+
id: string;
|
|
19292
|
+
};
|
|
19293
|
+
query?: never;
|
|
19294
|
+
url: '/api/2026-10-01/resources/procurement/po_line_items/{id}';
|
|
19295
|
+
};
|
|
19296
|
+
export type GetApi20261001ResourcesProcurementPoLineItemsByIdResponses = {
|
|
19297
|
+
/**
|
|
19298
|
+
* OK
|
|
19299
|
+
*/
|
|
19300
|
+
200: ProcurementPoLineItem;
|
|
19301
|
+
};
|
|
19302
|
+
export type GetApi20261001ResourcesProcurementPoLineItemsByIdResponse = GetApi20261001ResourcesProcurementPoLineItemsByIdResponses[keyof GetApi20261001ResourcesProcurementPoLineItemsByIdResponses];
|
|
18750
19303
|
export type GetApi20261001ResourcesProcurementPoTemplatesData = {
|
|
18751
19304
|
body?: never;
|
|
18752
19305
|
path?: never;
|
|
@@ -20169,6 +20722,97 @@ export type PostApi20261001ResourcesProjectManagementProjectWorkersUnassignRespo
|
|
|
20169
20722
|
200: ProjectManagementProjectWorker;
|
|
20170
20723
|
};
|
|
20171
20724
|
export type PostApi20261001ResourcesProjectManagementProjectWorkersUnassignResponse = PostApi20261001ResourcesProjectManagementProjectWorkersUnassignResponses[keyof PostApi20261001ResourcesProjectManagementProjectWorkersUnassignResponses];
|
|
20725
|
+
export type GetApi20261001ResourcesProjectManagementRatesData = {
|
|
20726
|
+
body?: never;
|
|
20727
|
+
path?: never;
|
|
20728
|
+
query: {
|
|
20729
|
+
/**
|
|
20730
|
+
* Filter rates by IDs
|
|
20731
|
+
*/
|
|
20732
|
+
'ids[]': Array<string>;
|
|
20733
|
+
/**
|
|
20734
|
+
* Filter rates by company ID
|
|
20735
|
+
*/
|
|
20736
|
+
company_id: string;
|
|
20737
|
+
/**
|
|
20738
|
+
* Filter rates by project ID
|
|
20739
|
+
*/
|
|
20740
|
+
project_id: string;
|
|
20741
|
+
/**
|
|
20742
|
+
* Filter rates by canonical resource identity (numeric id or tree node uuid)
|
|
20743
|
+
*/
|
|
20744
|
+
'resource_ids[]': Array<string>;
|
|
20745
|
+
/**
|
|
20746
|
+
* Filter rates by the kind of resource they apply to.
|
|
20747
|
+
*/
|
|
20748
|
+
resource_kind: 'project_worker' | 'project' | 'employee' | 'job_catalog_tree_node';
|
|
20749
|
+
/**
|
|
20750
|
+
* Filter rates by reference rate ID
|
|
20751
|
+
*/
|
|
20752
|
+
reference_rate_id: string;
|
|
20753
|
+
/**
|
|
20754
|
+
* Filter rates by job catalog role or level name
|
|
20755
|
+
*/
|
|
20756
|
+
role_or_level: string;
|
|
20757
|
+
/**
|
|
20758
|
+
* Filter rates by employee name
|
|
20759
|
+
*/
|
|
20760
|
+
employee_name: string;
|
|
20761
|
+
/**
|
|
20762
|
+
* Filter rates by quote ID
|
|
20763
|
+
*/
|
|
20764
|
+
quote_id: string;
|
|
20765
|
+
/**
|
|
20766
|
+
* If true, retrieve only currently active rates.
|
|
20767
|
+
*/
|
|
20768
|
+
only_active: boolean;
|
|
20769
|
+
/**
|
|
20770
|
+
* If true, retrieve only rates that are not linked to a project.
|
|
20771
|
+
*/
|
|
20772
|
+
without_project: boolean;
|
|
20773
|
+
/**
|
|
20774
|
+
* If true, retrieve only rates that are not linked to a quote.
|
|
20775
|
+
*/
|
|
20776
|
+
without_quote: boolean;
|
|
20777
|
+
/**
|
|
20778
|
+
* Filter rates by record type
|
|
20779
|
+
*/
|
|
20780
|
+
record_type: string;
|
|
20781
|
+
/**
|
|
20782
|
+
* Filter rates by reference rate IDs
|
|
20783
|
+
*/
|
|
20784
|
+
'reference_rate_ids[]': Array<string>;
|
|
20785
|
+
};
|
|
20786
|
+
url: '/api/2026-10-01/resources/project_management/rates';
|
|
20787
|
+
};
|
|
20788
|
+
export type GetApi20261001ResourcesProjectManagementRatesResponses = {
|
|
20789
|
+
/**
|
|
20790
|
+
* OK
|
|
20791
|
+
*/
|
|
20792
|
+
200: {
|
|
20793
|
+
data?: Array<ProjectManagementRate>;
|
|
20794
|
+
meta?: PagedIndexMeta;
|
|
20795
|
+
};
|
|
20796
|
+
};
|
|
20797
|
+
export type GetApi20261001ResourcesProjectManagementRatesResponse = GetApi20261001ResourcesProjectManagementRatesResponses[keyof GetApi20261001ResourcesProjectManagementRatesResponses];
|
|
20798
|
+
export type GetApi20261001ResourcesProjectManagementRatesByIdData = {
|
|
20799
|
+
body?: never;
|
|
20800
|
+
path: {
|
|
20801
|
+
/**
|
|
20802
|
+
* Filter rates by IDs
|
|
20803
|
+
*/
|
|
20804
|
+
id: string;
|
|
20805
|
+
};
|
|
20806
|
+
query?: never;
|
|
20807
|
+
url: '/api/2026-10-01/resources/project_management/rates/{id}';
|
|
20808
|
+
};
|
|
20809
|
+
export type GetApi20261001ResourcesProjectManagementRatesByIdResponses = {
|
|
20810
|
+
/**
|
|
20811
|
+
* OK
|
|
20812
|
+
*/
|
|
20813
|
+
200: ProjectManagementRate;
|
|
20814
|
+
};
|
|
20815
|
+
export type GetApi20261001ResourcesProjectManagementRatesByIdResponse = GetApi20261001ResourcesProjectManagementRatesByIdResponses[keyof GetApi20261001ResourcesProjectManagementRatesByIdResponses];
|
|
20172
20816
|
export type GetApi20261001ResourcesProjectManagementSubprojectsData = {
|
|
20173
20817
|
body?: never;
|
|
20174
20818
|
path?: never;
|