@dsptch-work/api-client 0.20.0 → 0.22.0

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.
@@ -24,7 +24,7 @@ export type Problem = {
24
24
  /**
25
25
  * An opaque URN identifying this one occurrence of the failure, carrying the request's id. Quote it when correlating a failure with support or your logs.
26
26
  */
27
- instance?: string;
27
+ instance: string;
28
28
  /**
29
29
  * Optional nonempty validation entries. Each item gives a readable detail and, when the server can prove a public body location, a pointer to it. Clients must accept entries without a pointer.
30
30
  */
@@ -383,7 +383,7 @@ export type DirectUploadParameters = {
383
383
  /**
384
384
  * What the file is for, named as the endpoint that will attach it (for example `assets.vendors`). Required. It decides where the file is stored, and the signed ID this call returns is issued for that resource alone — it will not resolve at any other endpoint, so a vendor logo cannot be attached as an avatar, or an avatar as a logo.
385
385
  */
386
- resource: 'assets.items' | 'assets.items.documents' | 'assets.items.service_events' | 'assets.products' | 'assets.vendors' | 'compliance.checks' | 'pay_periods.imports.aggregate_times' | 'pay_periods.imports.dsptch_cprs' | 'pay_periods.imports.time_entries' | 'payrolls.payroll_runs.imports.paystubs' | 'users';
386
+ resource: 'assets.items' | 'assets.items.documents' | 'assets.items.service_events' | 'assets.products' | 'assets.vendors' | 'compliance.checks' | 'internal.company_todos' | 'internal.job_todos' | 'internal.project_todos' | 'pay_periods.imports.aggregate_times' | 'pay_periods.imports.dsptch_cprs' | 'pay_periods.imports.time_entries' | 'payrolls.payroll_runs.imports.paystubs' | 'users';
387
387
  /**
388
388
  * Metadata describing the file being registered, before its bytes are uploaded.
389
389
  */
@@ -1318,7 +1318,7 @@ export type TimecodeResponseObject = {
1318
1318
  updated_at: string;
1319
1319
  };
1320
1320
  /**
1321
- * An employment stint in the credential company. Its id is stable across valid-time versions; a rehire is a separate stint with a new id. A read returns only a version covering now or as_of[valid].
1321
+ * An employment stint in the credential company. Its id is stable across valid-time versions; a rehire is a separate stint with a new id. A read returns only a version covering now or as_of[valid]. Company keys, company administrators, and the employed person receive direct monetary fields; those fields are omitted for company managers reading coworkers.
1322
1322
  */
1323
1323
  export type PeopleEmploymentResponseObject = {
1324
1324
  /**
@@ -1394,21 +1394,21 @@ export type PeopleEmploymentResponseObject = {
1394
1394
  */
1395
1395
  training_annual_minutes: number | null;
1396
1396
  /**
1397
- * Hourly pay in cents as a decimal string; null when unset.
1397
+ * Hourly pay in cents as a decimal string; present for company keys, company administrators, and the employed person, and null when authorized but unset.
1398
1398
  */
1399
- hourly_rate_cents: string | null;
1399
+ hourly_rate_cents?: string | null;
1400
1400
  /**
1401
- * Annual training amount in cents as a decimal string; null when unset.
1401
+ * Annual training amount in cents as a decimal string; present for company keys, company administrators, and the employed person, and null when authorized but unset.
1402
1402
  */
1403
- training_annual_amount_cents: string | null;
1403
+ training_annual_amount_cents?: string | null;
1404
1404
  /**
1405
- * Employer health amount in cents as a decimal string; null when unset.
1405
+ * Employer health amount in cents as a decimal string; present for company keys, company administrators, and the employed person, and null when authorized but unset.
1406
1406
  */
1407
- employer_combined_health_amount_cents: string | null;
1407
+ employer_combined_health_amount_cents?: string | null;
1408
1408
  /**
1409
- * Employer savings amount in cents as a decimal string; null when unset.
1409
+ * Employer savings amount in cents as a decimal string; present for company keys, company administrators, and the employed person, and null when authorized but unset.
1410
1410
  */
1411
- employer_combined_savings_cents: string | null;
1411
+ employer_combined_savings_cents?: string | null;
1412
1412
  /**
1413
1413
  * Currency from the company's current pay schedule, or the system default when it has none. It is company configuration context rather than historical employment data.
1414
1414
  */
@@ -1430,6 +1430,203 @@ export type PeopleEmploymentResponseObject = {
1430
1430
  */
1431
1431
  updated_at: string;
1432
1432
  };
1433
+ /**
1434
+ * Create a distinct employment stint for an existing user in the credential company. Only user_id and hire_date are required; omitted optional fields use the defaults or null values described below. This does not create a user, invitation, role, group, or login identity.
1435
+ */
1436
+ export type PeopleEmploymentCreateParameters = {
1437
+ /**
1438
+ * ID of the existing user to employ. Required; the endpoint returns `404` when the user does not exist.
1439
+ */
1440
+ user_id: string;
1441
+ /**
1442
+ * First day of the stint, as a calendar date (`YYYY-MM-DD`). Required; interpreted at midnight in the credential company's time zone. A value carrying a time component is refused with `422` rather than truncated.
1443
+ */
1444
+ hire_date: string;
1445
+ /**
1446
+ * Whether the relationship is `EMPLOYEE` or `CONTRACTOR`. Omit to use `EMPLOYEE`; null is not accepted.
1447
+ */
1448
+ type?: 'EMPLOYEE' | 'CONTRACTOR';
1449
+ /**
1450
+ * Employment title. Omit or send null to leave it unset; blank text is stored as null.
1451
+ */
1452
+ title?: string | null;
1453
+ /**
1454
+ * ID of the user's manager. Omit or send null for no manager; a supplied ID must identify an existing user.
1455
+ */
1456
+ manager_user_id?: string | null;
1457
+ /**
1458
+ * Identifier for this worker in the company's payroll system. Omit or send null to leave it unset; blank text is stored as null.
1459
+ */
1460
+ payroll_id?: string | null;
1461
+ /**
1462
+ * Whether the employment participates in time and attendance. Omit to use true; null is not accepted.
1463
+ */
1464
+ enrolled_in_t_and_a?: boolean;
1465
+ /**
1466
+ * How the worker is paid: `hourly` or `salary`. Omit to use `hourly`; null is not accepted.
1467
+ */
1468
+ compensation_type?: 'hourly' | 'salary';
1469
+ /**
1470
+ * Base hourly pay in cents as a decimal string. Omit or send null to leave it unset.
1471
+ */
1472
+ hourly_rate_cents?: string | null;
1473
+ /**
1474
+ * Whether the employment is eligible for overtime. Omit to use true; send null to leave eligibility unset. Must be true when overtime_package_id is supplied.
1475
+ */
1476
+ overtime_eligible?: boolean | null;
1477
+ /**
1478
+ * ID of the overtime package assigned to this employment. Omit or send null for no package; a supplied ID must belong to the credential company and requires overtime_eligible to be true.
1479
+ */
1480
+ overtime_package_id?: string | null;
1481
+ /**
1482
+ * Annualized worked minutes. Omit or send null to leave it unset; otherwise must be between 0 and the number of minutes in one year.
1483
+ */
1484
+ worked_annual_minutes?: number | null;
1485
+ /**
1486
+ * Annual paid-time-off minutes. Omit or send null to leave it unset; otherwise must be between 0 and the number of minutes in one year.
1487
+ */
1488
+ pto_annual_minutes?: number | null;
1489
+ /**
1490
+ * Annual holiday minutes. Omit or send null to leave it unset; otherwise must be between 0 and the number of minutes in one year.
1491
+ */
1492
+ holiday_annual_minutes?: number | null;
1493
+ /**
1494
+ * Annual paid training minutes. Omit or send null to leave it unset; otherwise must be between 0 and the number of minutes in one year.
1495
+ */
1496
+ training_annual_minutes?: number | null;
1497
+ /**
1498
+ * Annual training amount in cents as a decimal string. Omit or send null to leave it unset.
1499
+ */
1500
+ training_annual_amount_cents?: string | null;
1501
+ /**
1502
+ * Annual employer health contribution in cents as a decimal string. Omit or send null to leave it unset.
1503
+ */
1504
+ employer_combined_health_amount_cents?: string | null;
1505
+ /**
1506
+ * Annual employer savings and retirement contribution in cents as a decimal string. Omit or send null to leave it unset.
1507
+ */
1508
+ employer_combined_savings_cents?: string | null;
1509
+ };
1510
+ /**
1511
+ * Request body for creating one strictly future employment boundary. effective_date is required and is interpreted at midnight in the credential company's time zone. Send at least one value to change; omitted values carry forward from the version immediately before the new boundary.
1512
+ */
1513
+ export type PeopleEmploymentScheduledChangeCreateParameters = {
1514
+ /**
1515
+ * How the employment is paid: hourly or salary. Omit to carry forward the preceding version.
1516
+ */
1517
+ compensation_type?: 'hourly' | 'salary';
1518
+ /**
1519
+ * Hourly pay in cents as a decimal string. Omit to carry forward the preceding version, or send null to clear it.
1520
+ */
1521
+ hourly_rate_cents?: string | null;
1522
+ /**
1523
+ * Whether the employment is overtime eligible. Omit to carry forward the preceding version, or send null to clear it.
1524
+ */
1525
+ overtime_eligible?: boolean | null;
1526
+ /**
1527
+ * Overtime package ID. Omit to carry forward the preceding version, or send null to clear it.
1528
+ */
1529
+ overtime_package_id?: string | null;
1530
+ /**
1531
+ * Annual worked minutes. Omit to carry forward the preceding version, or send null to clear it.
1532
+ */
1533
+ worked_annual_minutes?: number | null;
1534
+ /**
1535
+ * Annual paid-time-off minutes. Omit to carry forward the preceding version, or send null to clear it.
1536
+ */
1537
+ pto_annual_minutes?: number | null;
1538
+ /**
1539
+ * Annual holiday minutes. Omit to carry forward the preceding version, or send null to clear it.
1540
+ */
1541
+ holiday_annual_minutes?: number | null;
1542
+ /**
1543
+ * Annual training minutes. Omit to carry forward the preceding version, or send null to clear it.
1544
+ */
1545
+ training_annual_minutes?: number | null;
1546
+ /**
1547
+ * Annual training amount in cents as a decimal string. Omit to carry forward the preceding version, or send null to clear it.
1548
+ */
1549
+ training_annual_amount_cents?: string | null;
1550
+ /**
1551
+ * Annual employer health contribution in cents as a decimal string. Omit to carry forward the preceding version, or send null to clear it.
1552
+ */
1553
+ employer_combined_health_amount_cents?: string | null;
1554
+ /**
1555
+ * Annual employer savings contribution in cents as a decimal string. Omit to carry forward the preceding version, or send null to clear it.
1556
+ */
1557
+ employer_combined_savings_cents?: string | null;
1558
+ /**
1559
+ * Company-local date when the new boundary takes effect. Must be strictly in the future. Required.
1560
+ */
1561
+ effective_date: string;
1562
+ };
1563
+ /**
1564
+ * Request body for changing values at one exact strictly future employment boundary. Send only the fields to change; omitted values remain as recorded at that boundary. The boundary date cannot move.
1565
+ */
1566
+ export type PeopleEmploymentScheduledChangeUpdateParameters = {
1567
+ /**
1568
+ * How the employment is paid: hourly or salary. Omit to preserve the value at the targeted boundary.
1569
+ */
1570
+ compensation_type?: 'hourly' | 'salary';
1571
+ /**
1572
+ * Hourly pay in cents as a decimal string. Omit to preserve the value at the targeted boundary, or send null to clear it.
1573
+ */
1574
+ hourly_rate_cents?: string | null;
1575
+ /**
1576
+ * Whether the employment is overtime eligible. Omit to preserve the value at the targeted boundary, or send null to clear it.
1577
+ */
1578
+ overtime_eligible?: boolean | null;
1579
+ /**
1580
+ * Overtime package ID. Omit to preserve the value at the targeted boundary, or send null to clear it.
1581
+ */
1582
+ overtime_package_id?: string | null;
1583
+ /**
1584
+ * Annual worked minutes. Omit to preserve the value at the targeted boundary, or send null to clear it.
1585
+ */
1586
+ worked_annual_minutes?: number | null;
1587
+ /**
1588
+ * Annual paid-time-off minutes. Omit to preserve the value at the targeted boundary, or send null to clear it.
1589
+ */
1590
+ pto_annual_minutes?: number | null;
1591
+ /**
1592
+ * Annual holiday minutes. Omit to preserve the value at the targeted boundary, or send null to clear it.
1593
+ */
1594
+ holiday_annual_minutes?: number | null;
1595
+ /**
1596
+ * Annual training minutes. Omit to preserve the value at the targeted boundary, or send null to clear it.
1597
+ */
1598
+ training_annual_minutes?: number | null;
1599
+ /**
1600
+ * Annual training amount in cents as a decimal string. Omit to preserve the value at the targeted boundary, or send null to clear it.
1601
+ */
1602
+ training_annual_amount_cents?: string | null;
1603
+ /**
1604
+ * Annual employer health contribution in cents as a decimal string. Omit to preserve the value at the targeted boundary, or send null to clear it.
1605
+ */
1606
+ employer_combined_health_amount_cents?: string | null;
1607
+ /**
1608
+ * Annual employer savings contribution in cents as a decimal string. Omit to preserve the value at the targeted boundary, or send null to clear it.
1609
+ */
1610
+ employer_combined_savings_cents?: string | null;
1611
+ };
1612
+ /**
1613
+ * Parameters for moving where an employment stint's valid-time timeline begins.
1614
+ */
1615
+ export type PeopleEmploymentGenesisParameters = {
1616
+ /**
1617
+ * The timeline's new start, as a calendar date (`YYYY-MM-DD`). Required; a value carrying a time component is refused with `422` rather than truncated. Moving it earlier extends the first version back to it. Moving it later drops every version whose coverage ended at or before it and truncates the one spanning it, so what those versions said stops being readable. Refused with `422` when the employment has no finite start or the new start would fall at or after a scheduled termination.
1618
+ */
1619
+ effective_date?: string;
1620
+ };
1621
+ /**
1622
+ * Parameters for scheduling when an employment stint stops being valid.
1623
+ */
1624
+ export type PeopleEmploymentScheduledTerminationParameters = {
1625
+ /**
1626
+ * The exclusive end of the employment's valid-time timeline, as a calendar date (`YYYY-MM-DD`). Required; a value carrying a time component is refused with `422` rather than truncated. Must fall after the employment's genesis. Scheduling removes versions that start on or after the new end and truncates the version spanning it. An employment holds at most one scheduled termination; cancel the standing one before scheduling another. Cancellation reopens the last surviving version and does not restore removed versions.
1627
+ */
1628
+ effective_date: string;
1629
+ };
1433
1630
  export type PeopleEmploymentHistoryCorrectionObject = {
1434
1631
  /**
1435
1632
  * Family key shared by every entry on this timeline — the same identity the member route addresses. An entry carries no identifier of its own; versions are distinguished by their window coordinates.
@@ -1452,10 +1649,10 @@ export type PeopleEmploymentHistoryCorrectionObject = {
1452
1649
  pto_annual_minutes: number | null;
1453
1650
  holiday_annual_minutes: number | null;
1454
1651
  training_annual_minutes: number | null;
1455
- hourly_rate_cents: string | null;
1456
- training_annual_amount_cents: string | null;
1457
- employer_combined_health_amount_cents: string | null;
1458
- employer_combined_savings_cents: string | null;
1652
+ hourly_rate_cents?: string | null;
1653
+ training_annual_amount_cents?: string | null;
1654
+ employer_combined_health_amount_cents?: string | null;
1655
+ employer_combined_savings_cents?: string | null;
1459
1656
  currency: string;
1460
1657
  valid_from: string | null;
1461
1658
  valid_to: string | null;
@@ -1484,10 +1681,10 @@ export type PeopleEmploymentHistoryVersionObject = {
1484
1681
  pto_annual_minutes: number | null;
1485
1682
  holiday_annual_minutes: number | null;
1486
1683
  training_annual_minutes: number | null;
1487
- hourly_rate_cents: string | null;
1488
- training_annual_amount_cents: string | null;
1489
- employer_combined_health_amount_cents: string | null;
1490
- employer_combined_savings_cents: string | null;
1684
+ hourly_rate_cents?: string | null;
1685
+ training_annual_amount_cents?: string | null;
1686
+ employer_combined_health_amount_cents?: string | null;
1687
+ employer_combined_savings_cents?: string | null;
1491
1688
  currency: string;
1492
1689
  valid_from: string | null;
1493
1690
  valid_to: string | null;
@@ -6705,6 +6902,10 @@ export type ProjectResponseObject = {
6705
6902
  * Identifier of the immediate parent project in the ancestry hierarchy, or null for a top-level project.
6706
6903
  */
6707
6904
  parent_id: string | null;
6905
+ /**
6906
+ * Identifiers of companies participating in this project.
6907
+ */
6908
+ participating_company_ids: Array<string>;
6708
6909
  /**
6709
6910
  * Federal PWA tracking mode: `all` (prevailing wage + apprenticeship), `pw_only` (prevailing wage), `ap_only` (apprenticeship), or `none`.
6710
6911
  */
@@ -6771,7 +6972,7 @@ export type ProjectResponseObject = {
6771
6972
  updated_at: string;
6772
6973
  };
6773
6974
  /**
6774
- * Request body for creating a project. `name` is required by the schema; `created_by_user_id` is additionally required on create and must be a member of the owning company. The owning company is inferred from the API key and is not part of the body.
6975
+ * Request body for creating or updating a project. Only `name` is required by the schema; `created_by_user_id` is additionally required on create and must be a member of the owning company. The owning company is inferred from the API key and is not part of the body. Omit relationship fields on PATCH to leave them unchanged.
6775
6976
  */
6776
6977
  export type ProjectParameters = {
6777
6978
  /**
@@ -6790,6 +6991,14 @@ export type ProjectParameters = {
6790
6991
  * User recorded as the project's creator; must be a member of the owning company. Required on create and immutable thereafter — an update that sets, changes, or clears it is rejected.
6791
6992
  */
6792
6993
  created_by_user_id: string;
6994
+ /**
6995
+ * ID of a project visible to the API key's policy. Send null to make the project a root; the child schedule must fit within the parent's schedule.
6996
+ */
6997
+ parent_id?: string | null;
6998
+ /**
6999
+ * Complete desired set of participating company IDs. Send an empty array to clear the set. Remove a participant's jobs before removing it from this set.
7000
+ */
7001
+ participating_company_ids?: Array<string>;
6793
7002
  /**
6794
7003
  * Schedule start date as an ISO8601 date (YYYY-MM-DD), or null; requires tz_name to be set.
6795
7004
  */
@@ -6871,6 +7080,14 @@ export type ProjectUpdateParameters = {
6871
7080
  * User recorded as the project's creator; must be a member of the owning company. Required on create and immutable thereafter — an update that sets, changes, or clears it is rejected.
6872
7081
  */
6873
7082
  created_by_user_id?: string | null;
7083
+ /**
7084
+ * ID of a project visible to the API key's policy. Send null to make the project a root; the child schedule must fit within the parent's schedule.
7085
+ */
7086
+ parent_id?: string | null;
7087
+ /**
7088
+ * Complete desired set of participating company IDs. Send an empty array to clear the set. Remove a participant's jobs before removing it from this set.
7089
+ */
7090
+ participating_company_ids?: Array<string>;
6874
7091
  /**
6875
7092
  * Schedule start date as an ISO8601 date (YYYY-MM-DD), or null; requires tz_name to be set.
6876
7093
  */
@@ -8129,6 +8346,10 @@ export type PositionResponseObject = {
8129
8346
  * ID of the worker assigned to fill this position; null when the position is unfilled.
8130
8347
  */
8131
8348
  fulfilled_by_user_id: string | null;
8349
+ /**
8350
+ * ID of the pay-rate rule package applied to this position, or null when none is set.
8351
+ */
8352
+ pay_rates_rule_package_id: string | null;
8132
8353
  position_function: PositionFunction;
8133
8354
  /**
8134
8355
  * Name of the per diem applied to this position; null when none is set.
@@ -8208,6 +8429,56 @@ export type PositionResponseObject = {
8208
8429
  */
8209
8430
  updated_at: string;
8210
8431
  };
8432
+ /**
8433
+ * A company-owned collection of conditional wage and fringe adjustments, optionally scoped to a job.
8434
+ */
8435
+ export type PayRatesRulePackageResponseObject = {
8436
+ /**
8437
+ * Unique identifier of the rule package.
8438
+ */
8439
+ id: string;
8440
+ /**
8441
+ * Human-readable package name.
8442
+ */
8443
+ name: string;
8444
+ /**
8445
+ * Free-form package description, or null.
8446
+ */
8447
+ description: string | null;
8448
+ /**
8449
+ * ID of the job this package is scoped to, or null for a company-wide package.
8450
+ */
8451
+ scoped_to_job_id: string | null;
8452
+ /**
8453
+ * Whether this is the default package within its company-wide or job scope.
8454
+ */
8455
+ default: boolean;
8456
+ /**
8457
+ * Whether users may select this package directly in configuration workflows.
8458
+ */
8459
+ selectable: boolean;
8460
+ /**
8461
+ * When the record was created (ISO 8601).
8462
+ */
8463
+ created_at: string;
8464
+ /**
8465
+ * When the record was last updated (ISO 8601).
8466
+ */
8467
+ updated_at: string;
8468
+ };
8469
+ /**
8470
+ * Parameters for creating a company-wide pay-rate rule package.
8471
+ */
8472
+ export type PayRatesRulePackageParameters = {
8473
+ /**
8474
+ * Human-readable package name.
8475
+ */
8476
+ name: string;
8477
+ /**
8478
+ * Free-form package description; send null or omit it when no description is needed.
8479
+ */
8480
+ description?: string | null;
8481
+ };
8211
8482
  /**
8212
8483
  * A page of a job's positions, with pagination metadata and navigation links.
8213
8484
  */
@@ -9458,6 +9729,10 @@ export type FederalJobWageDeterminationResponseObject = {
9458
9729
  * ID of the overtime package whose rules apply to this determination, or null when none is set. Not a versioned attribute: every version of the determination carries the same package, so this reads the same whatever point in time you ask for. The rules inside the package carry their own valid times.
9459
9730
  */
9460
9731
  overtime_package_id: string | null;
9732
+ /**
9733
+ * ID of the pay-rate rule package attached to this determination family, or null when none is set. The attachment is shared by every temporal version of the determination.
9734
+ */
9735
+ pay_rates_rule_package_id: string | null;
9461
9736
  /**
9462
9737
  * Determination type — the Federal or Regional subtype (an STI class name). Federal carries a DOL class code and construction category; Regional carries the nested regional_fields object.
9463
9738
  */
@@ -9523,6 +9798,10 @@ export type RegionalJobWageDeterminationResponseObject = {
9523
9798
  * ID of the overtime package whose rules apply to this determination, or null when none is set. Not a versioned attribute: every version of the determination carries the same package, so this reads the same whatever point in time you ask for. The rules inside the package carry their own valid times.
9524
9799
  */
9525
9800
  overtime_package_id: string | null;
9801
+ /**
9802
+ * ID of the pay-rate rule package attached to this determination family, or null when none is set. The attachment is shared by every temporal version of the determination.
9803
+ */
9804
+ pay_rates_rule_package_id: string | null;
9526
9805
  /**
9527
9806
  * Determination type — the Federal or Regional subtype (an STI class name). Federal carries a DOL class code and construction category; Regional carries the nested regional_fields object.
9528
9807
  */
@@ -9574,6 +9853,7 @@ export type FederalJobWageDeterminationHistoryVersionObject = {
9574
9853
  job_id: string;
9575
9854
  pwa_trade_id: string;
9576
9855
  overtime_package_id: string | null;
9856
+ pay_rates_rule_package_id: string | null;
9577
9857
  type: 'Pwa::JobWageDeterminations::Federal';
9578
9858
  labor_classification: string;
9579
9859
  hourly_rate_cents: string;
@@ -9596,6 +9876,7 @@ export type RegionalJobWageDeterminationHistoryVersionObject = {
9596
9876
  job_id: string;
9597
9877
  pwa_trade_id: string;
9598
9878
  overtime_package_id: string | null;
9879
+ pay_rates_rule_package_id: string | null;
9599
9880
  type: 'Pwa::JobWageDeterminations::Regional';
9600
9881
  labor_classification: string;
9601
9882
  hourly_rate_cents: string;
@@ -9622,6 +9903,7 @@ export type FederalJobWageDeterminationHistoryCorrectionObject = {
9622
9903
  job_id: string;
9623
9904
  pwa_trade_id: string;
9624
9905
  overtime_package_id: string | null;
9906
+ pay_rates_rule_package_id: string | null;
9625
9907
  type: 'Pwa::JobWageDeterminations::Federal';
9626
9908
  labor_classification: string;
9627
9909
  hourly_rate_cents: string;
@@ -9642,6 +9924,7 @@ export type RegionalJobWageDeterminationHistoryCorrectionObject = {
9642
9924
  job_id: string;
9643
9925
  pwa_trade_id: string;
9644
9926
  overtime_package_id: string | null;
9927
+ pay_rates_rule_package_id: string | null;
9645
9928
  type: 'Pwa::JobWageDeterminations::Regional';
9646
9929
  labor_classification: string;
9647
9930
  hourly_rate_cents: string;
@@ -9772,6 +10055,10 @@ export type FederalJobWageDeterminationParameters = {
9772
10055
  * The DOL general wage determination the rates are drawn from — the general decision number plus its revision (e.g. "CA20230001/5"); null when not recorded.
9773
10056
  */
9774
10057
  general_wage_determination?: string | null;
10058
+ /**
10059
+ * Pay-rate rule package attached to the whole determination family. On create, omit it or send null to leave the family unattached. On update, send null to detach it or omit the key to keep the current attachment. A package belonging to another company is refused.
10060
+ */
10061
+ pay_rates_rule_package_id?: string | null;
9775
10062
  };
9776
10063
  /**
9777
10064
  * Parameters for creating a Regional (state prevailing-wage) wage determination on a job.
@@ -9805,6 +10092,10 @@ export type RegionalJobWageDeterminationParameters = {
9805
10092
  * Overtime package whose rules govern overtime on work under this determination. This is not a versioned attribute: setting it points every version at that package, not only the one this request writes, and `effective_from` does not date it. Send null to detach, leaving the determination with no overtime package of its own. Omit the key to leave the current attachment alone. A package belonging to another company is refused, and a Federal determination refuses one outright — only a Regional determination carries overtime rules.
9806
10093
  */
9807
10094
  overtime_package_id?: string | null;
10095
+ /**
10096
+ * Pay-rate rule package attached to the whole determination family. On create, omit it or send null to leave the family unattached. On update, send null to detach it or omit the key to keep the current attachment. A package belonging to another company is refused.
10097
+ */
10098
+ pay_rates_rule_package_id?: string | null;
9808
10099
  regional_fields?: RegionalWageDeterminationFields;
9809
10100
  };
9810
10101
  /**
@@ -9819,6 +10110,10 @@ export type JobWageDeterminationUpdateParameters = {
9819
10110
  * Overtime package whose rules govern overtime on work under this determination. This is not a versioned attribute: setting it points every version at that package, not only the one this request writes, and `effective_from` does not date it. Send null to detach, leaving the determination with no overtime package of its own. Omit the key to leave the current attachment alone. A package belonging to another company is refused, and a Federal determination refuses one outright — only a Regional determination carries overtime rules.
9820
10111
  */
9821
10112
  overtime_package_id?: string | null;
10113
+ /**
10114
+ * Pay-rate rule package attached to the whole determination family. On create, omit it or send null to leave the family unattached. On update, send null to detach it or omit the key to keep the current attachment. A package belonging to another company is refused.
10115
+ */
10116
+ pay_rates_rule_package_id?: string | null;
9822
10117
  /**
9823
10118
  * Human-readable labor classification — the craft or trade this determination sets rates for; the display label, distinct from the machine class code.
9824
10119
  */
@@ -10085,61 +10380,189 @@ export type RateRuleHistoryVersionObject = {
10085
10380
  corrections: Array<RateRuleHistoryCorrectionObject>;
10086
10381
  };
10087
10382
  /**
10088
- * An overtime rule (daily or weekly) belonging to an overtime package. It sets a pay multiplier that applies once a worked-hours threshold — and any day or date qualifier — is met. `valid_from`/`valid_to` bound the window this version is in effect.
10383
+ * A conditional wage or fringe adjustment owned by a pay-rate rule package, with the selected version's valid-time window.
10089
10384
  */
10090
- export type OvertimeRuleResponseObject = {
10385
+ export type PayRatesRuleResponseObject = {
10091
10386
  /**
10092
- * The rule's identity, shared by every version of it. Addresses the rule itself rather than one of its versions; versions are told apart by their `valid_from`/`valid_to` windows.
10387
+ * Identity shared by every valid-time version of the rule; the member and history paths address the family with this value.
10093
10388
  */
10094
10389
  id: string;
10095
10390
  /**
10096
- * ID of the overtime package this rule belongs to, taken from the request path.
10391
+ * ID of the pay-rate rule package that owns this rule.
10097
10392
  */
10098
- overtime_package_id: string;
10393
+ pay_rates_rule_package_id: string;
10099
10394
  /**
10100
- * The rule's cadence, as a class name: `DailyOvertimeRule` applies per day, `WeeklyOvertimeRule` per week.
10395
+ * ISO 4217 currency code for effect.amount_cents, inherited from the package's company.
10101
10396
  */
10102
- type: 'DailyOvertimeRule' | 'WeeklyOvertimeRule';
10397
+ currency: string;
10398
+ effect: RateRuleEffect;
10103
10399
  /**
10104
- * The overtime pay multiplier: `one_x` = 1.0x (straight time), `one_five_x` = 1.5x, `two_x` = 2.0x.
10400
+ * Conditions that decide when the effect applies. An empty list means the rule always applies.
10105
10401
  */
10106
- rate_multiplier: 'one_x' | 'one_five_x' | 'two_x';
10402
+ conditions: Array<RateRuleCondition>;
10107
10403
  /**
10108
- * Two-letter US state code the rule is limited to, or null when it applies regardless of region.
10404
+ * Valid time — when this version begins applying (ISO 8601); null for an unbounded lower bound.
10109
10405
  */
10110
- region_id: string | null;
10406
+ valid_from: string | null;
10111
10407
  /**
10112
- * Whole hours that must be worked (daily or weekly per `type`) before the multiplier applies. Null when the rule has no hours threshold.
10408
+ * Valid time — the exclusive end when this version stops applying (ISO 8601); null for an open-ended upper bound.
10113
10409
  */
10114
- eligible_hours_worked: number | null;
10410
+ valid_to: string | null;
10115
10411
  /**
10116
- * Lowercase weekday name (e.g. `monday`) the rule is limited to, or null when it is not day-of-week specific.
10412
+ * When the record was created (ISO 8601).
10117
10413
  */
10118
- specific_day_of_week: 'sunday' | 'monday' | 'tuesday' | 'wednesday' | 'thursday' | 'friday' | 'saturday' | null;
10414
+ created_at: string;
10119
10415
  /**
10120
- * A single calendar date (YYYY-MM-DD) the rule is limited to, or null when it is not date specific.
10416
+ * When the record was last updated (ISO 8601).
10121
10417
  */
10122
- specific_date: string | null;
10418
+ updated_at: string;
10419
+ };
10420
+ /**
10421
+ * Parameters for creating a conditional wage or fringe adjustment in a pay-rate rule package.
10422
+ */
10423
+ export type PayRatesRuleParameters = {
10424
+ effect: RateRuleEffect;
10123
10425
  /**
10124
- * Valid time — when this version of the rule took effect (ISO 8601); null when the version has no recorded start.
10426
+ * Match conditions for the rule. Omit or send an empty list for an unconditional rule.
10125
10427
  */
10126
- valid_from: string | null;
10428
+ conditions?: Array<RateRuleCondition>;
10127
10429
  /**
10128
- * Valid time — when this version stopped applying (ISO 8601); null while it is still current.
10430
+ * Calendar date when the rule begins in the package company's timezone; defaults to today there.
10129
10431
  */
10130
- valid_to: string | null;
10432
+ effective_date?: string;
10433
+ };
10434
+ /**
10435
+ * Change a rule from an effective date forward. Omitted effect or conditions keep that part of the targeted version. When the targeted recipe changes, the resulting complete recipe applies from that coordinate across later scheduled versions; an unchanged recipe does not alter later scheduled versions. An empty conditions list makes the rule unconditional. Omit effective_from to correct the selected version from its exact existing start. A rule with an unbounded lower limit requires effective_from.
10436
+ */
10437
+ export type PayRatesRuleUpdateParameters = {
10438
+ effect?: RateRuleEffect;
10131
10439
  /**
10132
- * When the record was created (ISO 8601).
10440
+ * Replacement match conditions. Omit this field to keep the targeted version's conditions; send an empty list to make the rule unconditional.
10133
10441
  */
10134
- created_at: string | null;
10442
+ conditions?: Array<RateRuleCondition>;
10135
10443
  /**
10136
- * When the record was last updated (ISO 8601).
10444
+ * Date the change begins, YYYY-MM-DD. Omit it to correct the selected version from its exact existing start. Required when that version has no lower bound.
10137
10445
  */
10138
- updated_at: string | null;
10446
+ effective_from?: string;
10139
10447
  };
10140
- export type OvertimeRuleHistoryCorrectionObject = {
10448
+ /**
10449
+ * Parameters for moving where a pay-rate rule family's valid-time timeline begins.
10450
+ */
10451
+ export type PayRatesRuleGenesisParameters = {
10141
10452
  /**
10142
- * Family key shared by every entry on this timeline — the same identity the member route addresses. An entry carries no identifier of its own; versions are distinguished by their window coordinates.
10453
+ * The timeline's new start as a calendar date (`YYYY-MM-DD`); a value carrying a time component is refused with `422` rather than truncated. Moving it earlier extends the first version back to it. Moving it later removes coverage before it. Refused with `422` when the new start would fall at or after a standing termination.
10454
+ */
10455
+ effective_date: string;
10456
+ };
10457
+ /**
10458
+ * Parameters for scheduling when a pay-rate rule family stops being valid.
10459
+ */
10460
+ export type PayRatesRuleScheduledTerminationParameters = {
10461
+ /**
10462
+ * The exclusive end of the family's valid-time timeline as a calendar date (`YYYY-MM-DD`); a value carrying a time component is refused with `422` rather than truncated. Must fall after genesis. Scheduling removes versions that start after the new end and truncates the version spanning it. A family holds at most one standing termination; cancel it before scheduling another. Cancellation reopens the last surviving version with its existing recipe and does not restore removed versions.
10463
+ */
10464
+ effective_date: string;
10465
+ };
10466
+ /**
10467
+ * Schedule a rule recipe change from a company-local effective date.
10468
+ */
10469
+ export type PayRatesRuleScheduledChangeParameters = {
10470
+ /**
10471
+ * Date the change begins, YYYY-MM-DD.
10472
+ */
10473
+ effective_date: string;
10474
+ effect?: RateRuleEffect;
10475
+ /**
10476
+ * Replacement match conditions. Omit this field to keep the targeted version's conditions; send an empty list to make the rule unconditional.
10477
+ */
10478
+ conditions?: Array<RateRuleCondition>;
10479
+ };
10480
+ export type PayRatesRuleHistoryCorrectionObject = {
10481
+ /**
10482
+ * Family key shared by every entry on this timeline — the same identity the member route addresses. An entry carries no identifier of its own; versions are distinguished by their window coordinates.
10483
+ */
10484
+ pay_rates_rule_id: string;
10485
+ pay_rates_rule_package_id: string;
10486
+ currency: string;
10487
+ effect: RateRuleEffect;
10488
+ conditions: Array<RateRuleCondition>;
10489
+ valid_from: string | null;
10490
+ valid_to: string | null;
10491
+ created_at: string;
10492
+ updated_at: string;
10493
+ };
10494
+ export type PayRatesRuleHistoryVersionObject = {
10495
+ /**
10496
+ * Family key shared by every entry on this timeline — the same identity the member route addresses. An entry carries no identifier of its own; versions are distinguished by their window coordinates.
10497
+ */
10498
+ pay_rates_rule_id: string;
10499
+ pay_rates_rule_package_id: string;
10500
+ currency: string;
10501
+ effect: RateRuleEffect;
10502
+ conditions: Array<RateRuleCondition>;
10503
+ valid_from: string | null;
10504
+ valid_to: string | null;
10505
+ created_at: string;
10506
+ updated_at: string;
10507
+ version_status: 'scheduled' | 'current' | 'historical';
10508
+ corrections: Array<PayRatesRuleHistoryCorrectionObject>;
10509
+ };
10510
+ /**
10511
+ * An overtime rule (daily or weekly) belonging to an overtime package. It sets a pay multiplier that applies once a worked-hours threshold — and any day or date qualifier — is met. `valid_from`/`valid_to` bound the window this version is in effect.
10512
+ */
10513
+ export type OvertimeRuleResponseObject = {
10514
+ /**
10515
+ * The rule's identity, shared by every version of it. Addresses the rule itself rather than one of its versions; versions are told apart by their `valid_from`/`valid_to` windows.
10516
+ */
10517
+ id: string;
10518
+ /**
10519
+ * ID of the overtime package this rule belongs to, taken from the request path.
10520
+ */
10521
+ overtime_package_id: string;
10522
+ /**
10523
+ * The rule's cadence, as a class name: `DailyOvertimeRule` applies per day, `WeeklyOvertimeRule` per week.
10524
+ */
10525
+ type: 'DailyOvertimeRule' | 'WeeklyOvertimeRule';
10526
+ /**
10527
+ * The overtime pay multiplier: `one_x` = 1.0x (straight time), `one_five_x` = 1.5x, `two_x` = 2.0x.
10528
+ */
10529
+ rate_multiplier: 'one_x' | 'one_five_x' | 'two_x';
10530
+ /**
10531
+ * Two-letter US state code the rule is limited to, or null when it applies regardless of region.
10532
+ */
10533
+ region_id: string | null;
10534
+ /**
10535
+ * Whole hours that must be worked (daily or weekly per `type`) before the multiplier applies. Null when the rule has no hours threshold.
10536
+ */
10537
+ eligible_hours_worked: number | null;
10538
+ /**
10539
+ * Lowercase weekday name (e.g. `monday`) the rule is limited to, or null when it is not day-of-week specific.
10540
+ */
10541
+ specific_day_of_week: 'sunday' | 'monday' | 'tuesday' | 'wednesday' | 'thursday' | 'friday' | 'saturday' | null;
10542
+ /**
10543
+ * A single calendar date (YYYY-MM-DD) the rule is limited to, or null when it is not date specific.
10544
+ */
10545
+ specific_date: string | null;
10546
+ /**
10547
+ * Valid time — when this version of the rule took effect (ISO 8601); null when the version has no recorded start.
10548
+ */
10549
+ valid_from: string | null;
10550
+ /**
10551
+ * Valid time — when this version stopped applying (ISO 8601); null while it is still current.
10552
+ */
10553
+ valid_to: string | null;
10554
+ /**
10555
+ * When the record was created (ISO 8601).
10556
+ */
10557
+ created_at: string | null;
10558
+ /**
10559
+ * When the record was last updated (ISO 8601).
10560
+ */
10561
+ updated_at: string | null;
10562
+ };
10563
+ export type OvertimeRuleHistoryCorrectionObject = {
10564
+ /**
10565
+ * Family key shared by every entry on this timeline — the same identity the member route addresses. An entry carries no identifier of its own; versions are distinguished by their window coordinates.
10143
10566
  */
10144
10567
  overtime_rule_id: string;
10145
10568
  overtime_package_id: string;
@@ -17701,6 +18124,10 @@ export type CreateWageDeterminationData = {
17701
18124
  url: '/api/v1/jobs/{job_id}/wage_determinations';
17702
18125
  };
17703
18126
  export type CreateWageDeterminationErrors = {
18127
+ /**
18128
+ * Bad Request
18129
+ */
18130
+ 400: Problem;
17704
18131
  /**
17705
18132
  * Forbidden
17706
18133
  */
@@ -18663,44 +19090,25 @@ export type UpdateOvertimeRuleResponses = {
18663
19090
  200: OvertimeRuleResponseObject;
18664
19091
  };
18665
19092
  export type UpdateOvertimeRuleResponse = UpdateOvertimeRuleResponses[keyof UpdateOvertimeRuleResponses];
18666
- export type ListAggregateTimeImportsData = {
18667
- body?: never;
18668
- path: {
18669
- pay_period_id: string;
18670
- };
18671
- query?: {
18672
- /**
18673
- * Filter by import status:
18674
- * * `pending`
18675
- * * `processing`
18676
- * * `processed`
18677
- * * `success`
18678
- * * `failed`
18679
- *
18680
- */
18681
- 'filter[status]'?: string;
18682
- filter?: string;
18683
- 'filter[unexpected]'?: string;
18684
- 'filter[completed_at][gte]'?: string;
18685
- 'filter[completed_at][lte]'?: string;
18686
- 'filter[created_at][gte]'?: string;
18687
- 'filter[created_at][lte]'?: string;
18688
- 'filter[updated_at][gte]'?: string;
18689
- 'filter[updated_at][lte]'?: string;
19093
+ export type ShiftPayRateRuleGenesisData = {
19094
+ body: PayRatesRuleGenesisParameters;
19095
+ headers: {
18690
19096
  /**
18691
- * This pagination cursor corresponds to the cursor value found in the response in
18692
- * `meta.page.next_cursor`.
19097
+ * Version validator this write is composed against — the `ETag` from a read of this rule, or `*` to write against whatever exists.
18693
19098
  */
18694
- 'page[cursor]'?: string;
19099
+ 'If-Match': string;
19100
+ };
19101
+ path: {
19102
+ rule_package_id: string;
18695
19103
  /**
18696
- * Maximum number of records to return per page. Defaults to 20. A value above 100 is capped to 100 rather than rejected; a value that is zero, negative, or not an integer is rejected with a `400`.
19104
+ * The rule's version-stable identity.
18697
19105
  */
18698
- 'page[limit]'?: number;
18699
- page?: string;
19106
+ rule_id: string;
18700
19107
  };
18701
- url: '/api/v1/pay_periods/{pay_period_id}/imports/aggregate_times';
19108
+ query?: never;
19109
+ url: '/api/v1/pay/rates/rule_packages/{rule_package_id}/rules/{rule_id}/genesis';
18702
19110
  };
18703
- export type ListAggregateTimeImportsErrors = {
19111
+ export type ShiftPayRateRuleGenesisErrors = {
18704
19112
  /**
18705
19113
  * Bad Request
18706
19114
  */
@@ -18709,32 +19117,57 @@ export type ListAggregateTimeImportsErrors = {
18709
19117
  * Forbidden
18710
19118
  */
18711
19119
  403: Problem;
19120
+ /**
19121
+ * Not Found
19122
+ */
19123
+ 404: Problem;
19124
+ /**
19125
+ * Precondition Failed
19126
+ */
19127
+ 412: Problem;
18712
19128
  /**
18713
19129
  * Unprocessable Content
18714
19130
  */
18715
19131
  422: Problem;
19132
+ /**
19133
+ * Precondition Required
19134
+ */
19135
+ 428: Problem;
18716
19136
  };
18717
- export type ListAggregateTimeImportsError = ListAggregateTimeImportsErrors[keyof ListAggregateTimeImportsErrors];
18718
- export type ListAggregateTimeImportsResponses = {
19137
+ export type ShiftPayRateRuleGenesisError = ShiftPayRateRuleGenesisErrors[keyof ShiftPayRateRuleGenesisErrors];
19138
+ export type ShiftPayRateRuleGenesisResponses = {
18719
19139
  /**
18720
19140
  * Success
18721
19141
  */
18722
- 200: {
18723
- meta: Meta;
18724
- links: Links;
18725
- data: Array<AggregateTimeImportResponseObject>;
18726
- };
19142
+ 200: PayRatesRuleResponseObject;
18727
19143
  };
18728
- export type ListAggregateTimeImportsResponse = ListAggregateTimeImportsResponses[keyof ListAggregateTimeImportsResponses];
18729
- export type CreateAggregateTimeImportData = {
18730
- body: AggregateTimeImportParameters;
19144
+ export type ShiftPayRateRuleGenesisResponse = ShiftPayRateRuleGenesisResponses[keyof ShiftPayRateRuleGenesisResponses];
19145
+ export type ListPayRateRuleHistoryData = {
19146
+ body?: never;
18731
19147
  path: {
18732
- pay_period_id: string;
19148
+ rule_package_id: string;
19149
+ /**
19150
+ * The rule's version-stable identity, as returned in `id`.
19151
+ */
19152
+ rule_id: string;
18733
19153
  };
18734
- query?: never;
18735
- url: '/api/v1/pay_periods/{pay_period_id}/imports/aggregate_times';
19154
+ query?: {
19155
+ 'as_of[valid]'?: string;
19156
+ 'as_of[transaction]'?: string;
19157
+ /**
19158
+ * This pagination cursor corresponds to the cursor value found in the response in
19159
+ * `meta.page.next_cursor`.
19160
+ */
19161
+ 'page[cursor]'?: string;
19162
+ /**
19163
+ * Maximum number of records to return per page. Defaults to 20. A value above 100 is capped to 100 rather than rejected; a value that is zero, negative, or not an integer is rejected with a `400`.
19164
+ */
19165
+ 'page[limit]'?: number;
19166
+ page?: string;
19167
+ };
19168
+ url: '/api/v1/pay/rates/rule_packages/{rule_package_id}/rules/{rule_id}/history';
18736
19169
  };
18737
- export type CreateAggregateTimeImportErrors = {
19170
+ export type ListPayRateRuleHistoryErrors = {
18738
19171
  /**
18739
19172
  * Bad Request
18740
19173
  */
@@ -18747,74 +19180,75 @@ export type CreateAggregateTimeImportErrors = {
18747
19180
  * Not Found
18748
19181
  */
18749
19182
  404: Problem;
18750
- /**
18751
- * Conflict
18752
- */
18753
- 409: Problem;
18754
- /**
18755
- * Unprocessable Content
18756
- */
18757
- 422: Problem;
18758
19183
  };
18759
- export type CreateAggregateTimeImportError = CreateAggregateTimeImportErrors[keyof CreateAggregateTimeImportErrors];
18760
- export type CreateAggregateTimeImportResponses = {
19184
+ export type ListPayRateRuleHistoryError = ListPayRateRuleHistoryErrors[keyof ListPayRateRuleHistoryErrors];
19185
+ export type ListPayRateRuleHistoryResponses = {
18761
19186
  /**
18762
- * Created
19187
+ * Success
18763
19188
  */
18764
- 201: AggregateTimeImportResponseObject;
19189
+ 200: {
19190
+ meta: Meta;
19191
+ links: Links;
19192
+ data: Array<PayRatesRuleHistoryVersionObject>;
19193
+ };
18765
19194
  };
18766
- export type CreateAggregateTimeImportResponse = CreateAggregateTimeImportResponses[keyof CreateAggregateTimeImportResponses];
18767
- export type GetAggregateTimeImportData = {
19195
+ export type ListPayRateRuleHistoryResponse = ListPayRateRuleHistoryResponses[keyof ListPayRateRuleHistoryResponses];
19196
+ export type CancelPayRateRuleScheduledChangesData = {
18768
19197
  body?: never;
19198
+ headers: {
19199
+ /**
19200
+ * Version validator this write is composed against.
19201
+ */
19202
+ 'If-Match': string;
19203
+ };
18769
19204
  path: {
18770
- pay_period_id: string;
18771
- id: string;
19205
+ rule_package_id: string;
19206
+ /**
19207
+ * The rule's version-stable identity.
19208
+ */
19209
+ rule_id: string;
18772
19210
  };
18773
19211
  query?: never;
18774
- url: '/api/v1/pay_periods/{pay_period_id}/imports/aggregate_times/{id}';
19212
+ url: '/api/v1/pay/rates/rule_packages/{rule_package_id}/rules/{rule_id}/scheduled_changes';
18775
19213
  };
18776
- export type GetAggregateTimeImportErrors = {
19214
+ export type CancelPayRateRuleScheduledChangesErrors = {
18777
19215
  /**
18778
19216
  * Forbidden
18779
19217
  */
18780
19218
  403: Problem;
18781
19219
  /**
18782
- * Not Found
19220
+ * Precondition Failed
18783
19221
  */
18784
- 404: Problem;
19222
+ 412: Problem;
19223
+ /**
19224
+ * Unprocessable Content
19225
+ */
19226
+ 422: Problem;
19227
+ /**
19228
+ * Precondition Required
19229
+ */
19230
+ 428: Problem;
18785
19231
  };
18786
- export type GetAggregateTimeImportError = GetAggregateTimeImportErrors[keyof GetAggregateTimeImportErrors];
18787
- export type GetAggregateTimeImportResponses = {
19232
+ export type CancelPayRateRuleScheduledChangesError = CancelPayRateRuleScheduledChangesErrors[keyof CancelPayRateRuleScheduledChangesErrors];
19233
+ export type CancelPayRateRuleScheduledChangesResponses = {
18788
19234
  /**
18789
19235
  * Success
18790
19236
  */
18791
- 200: AggregateTimeImportResponseObject;
19237
+ 200: PayRatesRuleResponseObject;
18792
19238
  };
18793
- export type GetAggregateTimeImportResponse = GetAggregateTimeImportResponses[keyof GetAggregateTimeImportResponses];
18794
- export type ListDsptchCprImportsData = {
19239
+ export type CancelPayRateRuleScheduledChangesResponse = CancelPayRateRuleScheduledChangesResponses[keyof CancelPayRateRuleScheduledChangesResponses];
19240
+ export type ListPayRateRuleScheduledChangesData = {
18795
19241
  body?: never;
18796
19242
  path: {
18797
- pay_period_id: string;
18798
- };
18799
- query?: {
19243
+ rule_package_id: string;
18800
19244
  /**
18801
- * Filter by import status:
18802
- * * `pending`
18803
- * * `processing`
18804
- * * `processed`
18805
- * * `success`
18806
- * * `failed`
18807
- *
19245
+ * The rule's version-stable identity.
18808
19246
  */
18809
- 'filter[status]'?: string;
18810
- filter?: string;
18811
- 'filter[unexpected]'?: string;
18812
- 'filter[completed_at][gte]'?: string;
18813
- 'filter[completed_at][lte]'?: string;
18814
- 'filter[created_at][gte]'?: string;
18815
- 'filter[created_at][lte]'?: string;
18816
- 'filter[updated_at][gte]'?: string;
18817
- 'filter[updated_at][lte]'?: string;
19247
+ rule_id: string;
19248
+ };
19249
+ query?: {
19250
+ 'as_of[valid]'?: string;
19251
+ 'as_of[transaction]'?: string;
18818
19252
  /**
18819
19253
  * This pagination cursor corresponds to the cursor value found in the response in
18820
19254
  * `meta.page.next_cursor`.
@@ -18826,9 +19260,9 @@ export type ListDsptchCprImportsData = {
18826
19260
  'page[limit]'?: number;
18827
19261
  page?: string;
18828
19262
  };
18829
- url: '/api/v1/pay_periods/{pay_period_id}/imports/dsptch_cprs';
19263
+ url: '/api/v1/pay/rates/rule_packages/{rule_package_id}/rules/{rule_id}/scheduled_changes';
18830
19264
  };
18831
- export type ListDsptchCprImportsErrors = {
19265
+ export type ListPayRateRuleScheduledChangesErrors = {
18832
19266
  /**
18833
19267
  * Bad Request
18834
19268
  */
@@ -18838,35 +19272,93 @@ export type ListDsptchCprImportsErrors = {
18838
19272
  */
18839
19273
  403: Problem;
18840
19274
  /**
18841
- * Unprocessable Content
19275
+ * Not Found
18842
19276
  */
18843
- 422: Problem;
19277
+ 404: Problem;
18844
19278
  };
18845
- export type ListDsptchCprImportsError = ListDsptchCprImportsErrors[keyof ListDsptchCprImportsErrors];
18846
- export type ListDsptchCprImportsResponses = {
19279
+ export type ListPayRateRuleScheduledChangesError = ListPayRateRuleScheduledChangesErrors[keyof ListPayRateRuleScheduledChangesErrors];
19280
+ export type ListPayRateRuleScheduledChangesResponses = {
18847
19281
  /**
18848
19282
  * Success
18849
19283
  */
18850
19284
  200: {
18851
19285
  meta: Meta;
18852
19286
  links: Links;
18853
- data: Array<DsptchCprImportResponseObject>;
19287
+ data: Array<PayRatesRuleHistoryVersionObject>;
18854
19288
  };
18855
19289
  };
18856
- export type ListDsptchCprImportsResponse = ListDsptchCprImportsResponses[keyof ListDsptchCprImportsResponses];
18857
- export type CreateDsptchCprImportData = {
18858
- body: DsptchCprImportParameters;
19290
+ export type ListPayRateRuleScheduledChangesResponse = ListPayRateRuleScheduledChangesResponses[keyof ListPayRateRuleScheduledChangesResponses];
19291
+ export type SchedulePayRateRuleChangeData = {
19292
+ body: PayRatesRuleScheduledChangeParameters;
19293
+ headers: {
19294
+ /**
19295
+ * Version validator this write is composed against.
19296
+ */
19297
+ 'If-Match': string;
19298
+ };
18859
19299
  path: {
18860
- pay_period_id: string;
19300
+ rule_package_id: string;
19301
+ /**
19302
+ * The rule's version-stable identity.
19303
+ */
19304
+ rule_id: string;
18861
19305
  };
18862
19306
  query?: never;
18863
- url: '/api/v1/pay_periods/{pay_period_id}/imports/dsptch_cprs';
19307
+ url: '/api/v1/pay/rates/rule_packages/{rule_package_id}/rules/{rule_id}/scheduled_changes';
18864
19308
  };
18865
- export type CreateDsptchCprImportErrors = {
19309
+ export type SchedulePayRateRuleChangeErrors = {
18866
19310
  /**
18867
19311
  * Bad Request
18868
19312
  */
18869
19313
  400: Problem;
19314
+ /**
19315
+ * Forbidden
19316
+ */
19317
+ 403: Problem;
19318
+ /**
19319
+ * Precondition Failed
19320
+ */
19321
+ 412: Problem;
19322
+ /**
19323
+ * Unprocessable Content
19324
+ */
19325
+ 422: Problem;
19326
+ /**
19327
+ * Precondition Required
19328
+ */
19329
+ 428: Problem;
19330
+ };
19331
+ export type SchedulePayRateRuleChangeError = SchedulePayRateRuleChangeErrors[keyof SchedulePayRateRuleChangeErrors];
19332
+ export type SchedulePayRateRuleChangeResponses = {
19333
+ /**
19334
+ * Success without a new segment
19335
+ */
19336
+ 200: PayRatesRuleResponseObject;
19337
+ /**
19338
+ * Created
19339
+ */
19340
+ 201: PayRatesRuleResponseObject;
19341
+ };
19342
+ export type SchedulePayRateRuleChangeResponse = SchedulePayRateRuleChangeResponses[keyof SchedulePayRateRuleChangeResponses];
19343
+ export type CancelPayRateRuleScheduledTerminationData = {
19344
+ body?: never;
19345
+ headers: {
19346
+ /**
19347
+ * Version validator this write is composed against — the `ETag` from a read of this rule, or `*` to write against whatever exists.
19348
+ */
19349
+ 'If-Match': string;
19350
+ };
19351
+ path: {
19352
+ rule_package_id: string;
19353
+ /**
19354
+ * The rule's version-stable identity.
19355
+ */
19356
+ rule_id: string;
19357
+ };
19358
+ query?: never;
19359
+ url: '/api/v1/pay/rates/rule_packages/{rule_package_id}/rules/{rule_id}/scheduled_termination';
19360
+ };
19361
+ export type CancelPayRateRuleScheduledTerminationErrors = {
18870
19362
  /**
18871
19363
  * Forbidden
18872
19364
  */
@@ -18876,32 +19368,49 @@ export type CreateDsptchCprImportErrors = {
18876
19368
  */
18877
19369
  404: Problem;
18878
19370
  /**
18879
- * Conflict
19371
+ * Precondition Failed
18880
19372
  */
18881
- 409: Problem;
19373
+ 412: Problem;
18882
19374
  /**
18883
19375
  * Unprocessable Content
18884
19376
  */
18885
19377
  422: Problem;
19378
+ /**
19379
+ * Precondition Required
19380
+ */
19381
+ 428: Problem;
18886
19382
  };
18887
- export type CreateDsptchCprImportError = CreateDsptchCprImportErrors[keyof CreateDsptchCprImportErrors];
18888
- export type CreateDsptchCprImportResponses = {
19383
+ export type CancelPayRateRuleScheduledTerminationError = CancelPayRateRuleScheduledTerminationErrors[keyof CancelPayRateRuleScheduledTerminationErrors];
19384
+ export type CancelPayRateRuleScheduledTerminationResponses = {
18889
19385
  /**
18890
- * Created
19386
+ * Success
18891
19387
  */
18892
- 201: DsptchCprImportResponseObject;
19388
+ 200: PayRatesRuleResponseObject;
18893
19389
  };
18894
- export type CreateDsptchCprImportResponse = CreateDsptchCprImportResponses[keyof CreateDsptchCprImportResponses];
18895
- export type GetDsptchCprImportData = {
18896
- body?: never;
19390
+ export type CancelPayRateRuleScheduledTerminationResponse = CancelPayRateRuleScheduledTerminationResponses[keyof CancelPayRateRuleScheduledTerminationResponses];
19391
+ export type SchedulePayRateRuleTerminationData = {
19392
+ body: PayRatesRuleScheduledTerminationParameters;
19393
+ headers: {
19394
+ /**
19395
+ * Version validator this write is composed against — the `ETag` from a read of this rule, or `*` to write against whatever exists.
19396
+ */
19397
+ 'If-Match': string;
19398
+ };
18897
19399
  path: {
18898
- pay_period_id: string;
18899
- id: string;
19400
+ rule_package_id: string;
19401
+ /**
19402
+ * The rule's version-stable identity.
19403
+ */
19404
+ rule_id: string;
18900
19405
  };
18901
19406
  query?: never;
18902
- url: '/api/v1/pay_periods/{pay_period_id}/imports/dsptch_cprs/{id}';
19407
+ url: '/api/v1/pay/rates/rule_packages/{rule_package_id}/rules/{rule_id}/scheduled_termination';
18903
19408
  };
18904
- export type GetDsptchCprImportErrors = {
19409
+ export type SchedulePayRateRuleTerminationErrors = {
19410
+ /**
19411
+ * Bad Request
19412
+ */
19413
+ 400: Problem;
18905
19414
  /**
18906
19415
  * Forbidden
18907
19416
  */
@@ -18910,39 +19419,47 @@ export type GetDsptchCprImportErrors = {
18910
19419
  * Not Found
18911
19420
  */
18912
19421
  404: Problem;
19422
+ /**
19423
+ * Conflict
19424
+ */
19425
+ 409: Problem;
19426
+ /**
19427
+ * Precondition Failed
19428
+ */
19429
+ 412: Problem;
19430
+ /**
19431
+ * Unprocessable Content
19432
+ */
19433
+ 422: Problem;
19434
+ /**
19435
+ * Precondition Required
19436
+ */
19437
+ 428: Problem;
18913
19438
  };
18914
- export type GetDsptchCprImportError = GetDsptchCprImportErrors[keyof GetDsptchCprImportErrors];
18915
- export type GetDsptchCprImportResponses = {
19439
+ export type SchedulePayRateRuleTerminationError = SchedulePayRateRuleTerminationErrors[keyof SchedulePayRateRuleTerminationErrors];
19440
+ export type SchedulePayRateRuleTerminationResponses = {
18916
19441
  /**
18917
- * Success
19442
+ * Created
18918
19443
  */
18919
- 200: DsptchCprImportResponseObject;
19444
+ 201: PayRatesRuleResponseObject;
18920
19445
  };
18921
- export type GetDsptchCprImportResponse = GetDsptchCprImportResponses[keyof GetDsptchCprImportResponses];
18922
- export type ListTimeEntryImportsData = {
19446
+ export type SchedulePayRateRuleTerminationResponse = SchedulePayRateRuleTerminationResponses[keyof SchedulePayRateRuleTerminationResponses];
19447
+ export type ListPayRateRulesData = {
18923
19448
  body?: never;
18924
19449
  path: {
18925
- pay_period_id: string;
19450
+ rule_package_id: string;
18926
19451
  };
18927
19452
  query?: {
18928
19453
  /**
18929
- * Filter by import status:
18930
- * * `pending`
18931
- * * `processing`
18932
- * * `processed`
18933
- * * `success`
18934
- * * `failed`
18935
- *
19454
+ * Read the version valid at this point in time. Defaults to now.
18936
19455
  */
18937
- 'filter[status]'?: string;
19456
+ 'as_of[valid]'?: string;
19457
+ as_of?: string;
19458
+ 'as_of[bogus_axis]'?: string;
19459
+ 'as_of[valid][gte]'?: string;
19460
+ 'as_of[transaction]'?: string;
18938
19461
  filter?: string;
18939
19462
  'filter[unexpected]'?: string;
18940
- 'filter[completed_at][gte]'?: string;
18941
- 'filter[completed_at][lte]'?: string;
18942
- 'filter[created_at][gte]'?: string;
18943
- 'filter[created_at][lte]'?: string;
18944
- 'filter[updated_at][gte]'?: string;
18945
- 'filter[updated_at][lte]'?: string;
18946
19463
  /**
18947
19464
  * This pagination cursor corresponds to the cursor value found in the response in
18948
19465
  * `meta.page.next_cursor`.
@@ -18954,9 +19471,9 @@ export type ListTimeEntryImportsData = {
18954
19471
  'page[limit]'?: number;
18955
19472
  page?: string;
18956
19473
  };
18957
- url: '/api/v1/pay_periods/{pay_period_id}/imports/time_entries';
19474
+ url: '/api/v1/pay/rates/rule_packages/{rule_package_id}/rules';
18958
19475
  };
18959
- export type ListTimeEntryImportsErrors = {
19476
+ export type ListPayRateRulesErrors = {
18960
19477
  /**
18961
19478
  * Bad Request
18962
19479
  */
@@ -18970,27 +19487,27 @@ export type ListTimeEntryImportsErrors = {
18970
19487
  */
18971
19488
  422: Problem;
18972
19489
  };
18973
- export type ListTimeEntryImportsError = ListTimeEntryImportsErrors[keyof ListTimeEntryImportsErrors];
18974
- export type ListTimeEntryImportsResponses = {
19490
+ export type ListPayRateRulesError = ListPayRateRulesErrors[keyof ListPayRateRulesErrors];
19491
+ export type ListPayRateRulesResponses = {
18975
19492
  /**
18976
19493
  * Success
18977
19494
  */
18978
19495
  200: {
18979
19496
  meta: Meta;
18980
19497
  links: Links;
18981
- data: Array<TimeEntryImportResponseObject>;
19498
+ data: Array<PayRatesRuleResponseObject>;
18982
19499
  };
18983
19500
  };
18984
- export type ListTimeEntryImportsResponse = ListTimeEntryImportsResponses[keyof ListTimeEntryImportsResponses];
18985
- export type CreateTimeEntryImportData = {
18986
- body: TimeEntryImportParameters;
19501
+ export type ListPayRateRulesResponse = ListPayRateRulesResponses[keyof ListPayRateRulesResponses];
19502
+ export type CreatePayRateRuleData = {
19503
+ body: PayRatesRuleParameters;
18987
19504
  path: {
18988
- pay_period_id: string;
19505
+ rule_package_id: string;
18989
19506
  };
18990
19507
  query?: never;
18991
- url: '/api/v1/pay_periods/{pay_period_id}/imports/time_entries';
19508
+ url: '/api/v1/pay/rates/rule_packages/{rule_package_id}/rules';
18992
19509
  };
18993
- export type CreateTimeEntryImportErrors = {
19510
+ export type CreatePayRateRuleErrors = {
18994
19511
  /**
18995
19512
  * Bad Request
18996
19513
  */
@@ -19003,33 +19520,38 @@ export type CreateTimeEntryImportErrors = {
19003
19520
  * Not Found
19004
19521
  */
19005
19522
  404: Problem;
19006
- /**
19007
- * Conflict
19008
- */
19009
- 409: Problem;
19010
19523
  /**
19011
19524
  * Unprocessable Content
19012
19525
  */
19013
19526
  422: Problem;
19014
19527
  };
19015
- export type CreateTimeEntryImportError = CreateTimeEntryImportErrors[keyof CreateTimeEntryImportErrors];
19016
- export type CreateTimeEntryImportResponses = {
19528
+ export type CreatePayRateRuleError = CreatePayRateRuleErrors[keyof CreatePayRateRuleErrors];
19529
+ export type CreatePayRateRuleResponses = {
19017
19530
  /**
19018
19531
  * Created
19019
19532
  */
19020
- 201: TimeEntryImportResponseObject;
19533
+ 201: PayRatesRuleResponseObject;
19021
19534
  };
19022
- export type CreateTimeEntryImportResponse = CreateTimeEntryImportResponses[keyof CreateTimeEntryImportResponses];
19023
- export type GetTimeEntryImportData = {
19535
+ export type CreatePayRateRuleResponse = CreatePayRateRuleResponses[keyof CreatePayRateRuleResponses];
19536
+ export type DeletePayRateRuleData = {
19024
19537
  body?: never;
19538
+ headers: {
19539
+ /**
19540
+ * Version validator this write is composed against — the `ETag` from a read of this rule, or `*` to write against whatever exists.
19541
+ */
19542
+ 'If-Match': string;
19543
+ };
19025
19544
  path: {
19026
- pay_period_id: string;
19545
+ rule_package_id: string;
19546
+ /**
19547
+ * The rule's version-stable identity.
19548
+ */
19027
19549
  id: string;
19028
19550
  };
19029
19551
  query?: never;
19030
- url: '/api/v1/pay_periods/{pay_period_id}/imports/time_entries/{id}';
19552
+ url: '/api/v1/pay/rates/rule_packages/{rule_package_id}/rules/{id}';
19031
19553
  };
19032
- export type GetTimeEntryImportErrors = {
19554
+ export type DeletePayRateRuleErrors = {
19033
19555
  /**
19034
19556
  * Forbidden
19035
19557
  */
@@ -19038,37 +19560,41 @@ export type GetTimeEntryImportErrors = {
19038
19560
  * Not Found
19039
19561
  */
19040
19562
  404: Problem;
19563
+ /**
19564
+ * Precondition Failed
19565
+ */
19566
+ 412: Problem;
19567
+ /**
19568
+ * Precondition Required
19569
+ */
19570
+ 428: Problem;
19041
19571
  };
19042
- export type GetTimeEntryImportError = GetTimeEntryImportErrors[keyof GetTimeEntryImportErrors];
19043
- export type GetTimeEntryImportResponses = {
19572
+ export type DeletePayRateRuleError = DeletePayRateRuleErrors[keyof DeletePayRateRuleErrors];
19573
+ export type DeletePayRateRuleResponses = {
19044
19574
  /**
19045
19575
  * Success
19046
19576
  */
19047
- 200: TimeEntryImportResponseObject;
19577
+ 200: PayRatesRuleResponseObject;
19048
19578
  };
19049
- export type GetTimeEntryImportResponse = GetTimeEntryImportResponses[keyof GetTimeEntryImportResponses];
19050
- export type ListPayPeriodsData = {
19579
+ export type DeletePayRateRuleResponse = DeletePayRateRuleResponses[keyof DeletePayRateRuleResponses];
19580
+ export type GetPayRateRuleData = {
19051
19581
  body?: never;
19052
- path?: never;
19053
- query?: {
19054
- 'filter[start_time][gte]'?: string;
19055
- 'filter[start_time][lte]'?: string;
19056
- filter?: string;
19057
- 'filter[unexpected]'?: string;
19582
+ path: {
19583
+ rule_package_id: string;
19058
19584
  /**
19059
- * This pagination cursor corresponds to the cursor value found in the response in
19060
- * `meta.page.next_cursor`.
19585
+ * The rule's version-stable identity.
19061
19586
  */
19062
- 'page[cursor]'?: string;
19587
+ id: string;
19588
+ };
19589
+ query?: {
19063
19590
  /**
19064
- * Maximum number of records to return per page. Defaults to 20. A value above 100 is capped to 100 rather than rejected; a value that is zero, negative, or not an integer is rejected with a `400`.
19591
+ * Read the version valid at this point in time. Defaults to now.
19065
19592
  */
19066
- 'page[limit]'?: number;
19067
- page?: string;
19593
+ 'as_of[valid]'?: string;
19068
19594
  };
19069
- url: '/api/v1/pay_periods';
19595
+ url: '/api/v1/pay/rates/rule_packages/{rule_package_id}/rules/{id}';
19070
19596
  };
19071
- export type ListPayPeriodsErrors = {
19597
+ export type GetPayRateRuleErrors = {
19072
19598
  /**
19073
19599
  * Bad Request
19074
19600
  */
@@ -19077,52 +19603,46 @@ export type ListPayPeriodsErrors = {
19077
19603
  * Forbidden
19078
19604
  */
19079
19605
  403: Problem;
19606
+ /**
19607
+ * Not Found
19608
+ */
19609
+ 404: Problem;
19080
19610
  /**
19081
19611
  * Unprocessable Content
19082
19612
  */
19083
19613
  422: Problem;
19084
19614
  };
19085
- export type ListPayPeriodsError = ListPayPeriodsErrors[keyof ListPayPeriodsErrors];
19086
- export type ListPayPeriodsResponses = {
19615
+ export type GetPayRateRuleError = GetPayRateRuleErrors[keyof GetPayRateRuleErrors];
19616
+ export type GetPayRateRuleResponses = {
19087
19617
  /**
19088
19618
  * Success
19089
19619
  */
19090
- 200: PayPeriodsResponseObject;
19091
- };
19092
- export type ListPayPeriodsResponse = ListPayPeriodsResponses[keyof ListPayPeriodsResponses];
19093
- export type ListCompensationElementsData = {
19094
- body?: never;
19095
- path?: never;
19096
- query?: never;
19097
- url: '/api/v1/payrolls/compensation_elements';
19098
- };
19099
- export type ListCompensationElementsErrors = {
19100
- /**
19101
- * Forbidden
19102
- */
19103
- 403: Problem;
19620
+ 200: PayRatesRuleResponseObject;
19104
19621
  };
19105
- export type ListCompensationElementsError = ListCompensationElementsErrors[keyof ListCompensationElementsErrors];
19106
- export type ListCompensationElementsResponses = {
19107
- /**
19108
- * Success
19109
- */
19110
- 200: {
19111
- meta: Meta;
19112
- links: Links;
19113
- data: Array<CompensationElementResponseObject>;
19622
+ export type GetPayRateRuleResponse = GetPayRateRuleResponses[keyof GetPayRateRuleResponses];
19623
+ export type UpdatePayRateRuleData = {
19624
+ body: PayRatesRuleUpdateParameters;
19625
+ headers: {
19626
+ /**
19627
+ * Version validator this write is composed against — the `ETag` from a read of this rule, or `*` to write against whatever exists.
19628
+ */
19629
+ 'If-Match': string;
19114
19630
  };
19115
- };
19116
- export type ListCompensationElementsResponse = ListCompensationElementsResponses[keyof ListCompensationElementsResponses];
19117
- export type GetCompensationElementData = {
19118
- body?: never;
19119
19631
  path: {
19632
+ rule_package_id: string;
19633
+ /**
19634
+ * The rule's version-stable identity.
19635
+ */
19120
19636
  id: string;
19121
19637
  };
19122
19638
  query?: never;
19123
- url: '/api/v1/payrolls/compensation_elements/{id}';
19639
+ url: '/api/v1/pay/rates/rule_packages/{rule_package_id}/rules/{id}';
19124
19640
  };
19125
- export type GetCompensationElementErrors = {
19641
+ export type UpdatePayRateRuleErrors = {
19642
+ /**
19643
+ * Bad Request
19644
+ */
19645
+ 400: Problem;
19126
19646
  /**
19127
19647
  * Forbidden
19128
19648
  */
@@ -19131,74 +19651,51 @@ export type GetCompensationElementErrors = {
19131
19651
  * Not Found
19132
19652
  */
19133
19653
  404: Problem;
19654
+ /**
19655
+ * Precondition Failed
19656
+ */
19657
+ 412: Problem;
19658
+ /**
19659
+ * Unprocessable Content
19660
+ */
19661
+ 422: Problem;
19662
+ /**
19663
+ * Precondition Required
19664
+ */
19665
+ 428: Problem;
19134
19666
  };
19135
- export type GetCompensationElementError = GetCompensationElementErrors[keyof GetCompensationElementErrors];
19136
- export type GetCompensationElementResponses = {
19667
+ export type UpdatePayRateRuleError = UpdatePayRateRuleErrors[keyof UpdatePayRateRuleErrors];
19668
+ export type UpdatePayRateRuleResponses = {
19137
19669
  /**
19138
19670
  * Success
19139
19671
  */
19140
- 200: CompensationElementResponseObject;
19672
+ 200: PayRatesRuleResponseObject;
19141
19673
  };
19142
- export type GetCompensationElementResponse = GetCompensationElementResponses[keyof GetCompensationElementResponses];
19143
- export type ListExternalMapHistoryData = {
19674
+ export type UpdatePayRateRuleResponse = UpdatePayRateRuleResponses[keyof UpdatePayRateRuleResponses];
19675
+ export type ListPayRateRulePackagesData = {
19144
19676
  body?: never;
19145
- path: {
19146
- /**
19147
- * The external map's version-stable identity, as returned in `id`.
19148
- */
19149
- external_map_id: string;
19150
- };
19677
+ path?: never;
19151
19678
  query?: {
19152
19679
  /**
19153
- * Read the timeline as it was recorded at this moment — the corrections nested under each version stop at the same point, and each version publishes the `transaction_to` it had then, so one corrected since still reads as open. `version_status` is always relative to now. Defaults to now.
19680
+ * Return packages scoped to this job.
19154
19681
  */
19155
- 'as_of[transaction]'?: string;
19156
- 'as_of[valid]'?: string;
19157
- };
19158
- url: '/api/v1/payrolls/external_maps/{external_map_id}/history';
19159
- };
19160
- export type ListExternalMapHistoryErrors = {
19161
- /**
19162
- * Bad Request
19163
- */
19164
- 400: Problem;
19165
- /**
19166
- * Forbidden
19167
- */
19168
- 403: Problem;
19169
- /**
19170
- * Not Found
19171
- */
19172
- 404: Problem;
19173
- };
19174
- export type ListExternalMapHistoryError = ListExternalMapHistoryErrors[keyof ListExternalMapHistoryErrors];
19175
- export type ListExternalMapHistoryResponses = {
19176
- /**
19177
- * Success
19178
- */
19179
- 200: {
19180
- meta: Meta;
19181
- links: Links;
19182
- data: Array<PayrollExternalMapHistoryVersionObject>;
19183
- };
19184
- };
19185
- export type ListExternalMapHistoryResponse = ListExternalMapHistoryResponses[keyof ListExternalMapHistoryResponses];
19186
- export type ListExternalMapsData = {
19187
- body?: never;
19188
- path?: never;
19189
- query?: {
19682
+ 'filter[scoped_to_job_id]'?: string;
19190
19683
  /**
19191
- * Fuzzy-match the external field name
19684
+ * Set to `true` to return company-wide packages without a job scope.
19192
19685
  */
19193
- 'filter[name]'?: string;
19686
+ 'filter[scoped_to_job_id][null]'?: boolean;
19194
19687
  /**
19195
- * Narrow to one pay schedule
19688
+ * Filter by whether the package is the default for its scope.
19196
19689
  */
19197
- 'filter[timekeeping_pay_period_config_id]'?: string;
19690
+ 'filter[default]'?: boolean;
19198
19691
  /**
19199
- * true → only global maps; false → only company-owned
19692
+ * Filter by whether users can select the package.
19200
19693
  */
19201
- 'filter[global]'?: boolean;
19694
+ 'filter[selectable]'?: boolean;
19695
+ 'filter[created_at][gte]'?: string;
19696
+ 'filter[created_at][lte]'?: string;
19697
+ 'filter[updated_at][gte]'?: string;
19698
+ 'filter[updated_at][lte]'?: string;
19202
19699
  filter?: string;
19203
19700
  'filter[unexpected]'?: string;
19204
19701
  /**
@@ -19211,21 +19708,10 @@ export type ListExternalMapsData = {
19211
19708
  */
19212
19709
  'page[limit]'?: number;
19213
19710
  page?: string;
19214
- /**
19215
- * Read the version valid at this point in time. Defaults to now.
19216
- */
19217
- 'as_of[valid]'?: string;
19218
- /**
19219
- * Read the version as it was recorded at this point in transaction time. Its `transaction_to` is published as of that point, so a version corrected since still reads as open. Defaults to now.
19220
- */
19221
- 'as_of[transaction]'?: string;
19222
- as_of?: string;
19223
- 'as_of[bogus_axis]'?: string;
19224
- 'as_of[valid][gte]'?: string;
19225
19711
  };
19226
- url: '/api/v1/payrolls/external_maps';
19712
+ url: '/api/v1/pay/rates/rule_packages';
19227
19713
  };
19228
- export type ListExternalMapsErrors = {
19714
+ export type ListPayRateRulePackagesErrors = {
19229
19715
  /**
19230
19716
  * Bad Request
19231
19717
  */
@@ -19239,36 +19725,55 @@ export type ListExternalMapsErrors = {
19239
19725
  */
19240
19726
  422: Problem;
19241
19727
  };
19242
- export type ListExternalMapsError = ListExternalMapsErrors[keyof ListExternalMapsErrors];
19243
- export type ListExternalMapsResponses = {
19728
+ export type ListPayRateRulePackagesError = ListPayRateRulePackagesErrors[keyof ListPayRateRulePackagesErrors];
19729
+ export type ListPayRateRulePackagesResponses = {
19244
19730
  /**
19245
19731
  * Success
19246
19732
  */
19247
19733
  200: {
19248
19734
  meta: Meta;
19249
19735
  links: Links;
19250
- data: Array<PayrollExternalMapResponseObject>;
19736
+ data: Array<PayRatesRulePackageResponseObject>;
19251
19737
  };
19252
19738
  };
19253
- export type ListExternalMapsResponse = ListExternalMapsResponses[keyof ListExternalMapsResponses];
19254
- export type GetExternalMapData = {
19739
+ export type ListPayRateRulePackagesResponse = ListPayRateRulePackagesResponses[keyof ListPayRateRulePackagesResponses];
19740
+ export type CreatePayRateRulePackageData = {
19741
+ body: PayRatesRulePackageParameters;
19742
+ path?: never;
19743
+ query?: never;
19744
+ url: '/api/v1/pay/rates/rule_packages';
19745
+ };
19746
+ export type CreatePayRateRulePackageErrors = {
19747
+ /**
19748
+ * Bad Request
19749
+ */
19750
+ 400: Problem;
19751
+ /**
19752
+ * Forbidden
19753
+ */
19754
+ 403: Problem;
19755
+ /**
19756
+ * Unprocessable Content
19757
+ */
19758
+ 422: Problem;
19759
+ };
19760
+ export type CreatePayRateRulePackageError = CreatePayRateRulePackageErrors[keyof CreatePayRateRulePackageErrors];
19761
+ export type CreatePayRateRulePackageResponses = {
19762
+ /**
19763
+ * Created
19764
+ */
19765
+ 201: PayRatesRulePackageResponseObject;
19766
+ };
19767
+ export type CreatePayRateRulePackageResponse = CreatePayRateRulePackageResponses[keyof CreatePayRateRulePackageResponses];
19768
+ export type GetPayRateRulePackageData = {
19255
19769
  body?: never;
19256
19770
  path: {
19257
19771
  id: string;
19258
19772
  };
19259
- query?: {
19260
- /**
19261
- * Read the version valid at this point in time. Defaults to now.
19262
- */
19263
- 'as_of[valid]'?: string;
19264
- /**
19265
- * Read the version as it was recorded at this point in transaction time. Its `transaction_to` is published as of that point, so a version corrected since still reads as open. Defaults to now.
19266
- */
19267
- 'as_of[transaction]'?: string;
19268
- };
19269
- url: '/api/v1/payrolls/external_maps/{id}';
19773
+ query?: never;
19774
+ url: '/api/v1/pay/rates/rule_packages/{id}';
19270
19775
  };
19271
- export type GetExternalMapErrors = {
19776
+ export type GetPayRateRulePackageErrors = {
19272
19777
  /**
19273
19778
  * Forbidden
19274
19779
  */
@@ -19278,28 +19783,38 @@ export type GetExternalMapErrors = {
19278
19783
  */
19279
19784
  404: Problem;
19280
19785
  };
19281
- export type GetExternalMapError = GetExternalMapErrors[keyof GetExternalMapErrors];
19282
- export type GetExternalMapResponses = {
19786
+ export type GetPayRateRulePackageError = GetPayRateRulePackageErrors[keyof GetPayRateRulePackageErrors];
19787
+ export type GetPayRateRulePackageResponses = {
19283
19788
  /**
19284
19789
  * Success
19285
19790
  */
19286
- 200: PayrollExternalMapResponseObject;
19791
+ 200: PayRatesRulePackageResponseObject;
19287
19792
  };
19288
- export type GetExternalMapResponse = GetExternalMapResponses[keyof GetExternalMapResponses];
19289
- export type ListFringeBenefitPlansData = {
19793
+ export type GetPayRateRulePackageResponse = GetPayRateRulePackageResponses[keyof GetPayRateRulePackageResponses];
19794
+ export type ListAggregateTimeImportsData = {
19290
19795
  body?: never;
19291
- path?: never;
19796
+ path: {
19797
+ pay_period_id: string;
19798
+ };
19292
19799
  query?: {
19293
19800
  /**
19294
- * Fuzzy-match by plan name or number
19295
- */
19296
- 'filter[name]'?: string;
19297
- /**
19298
- * Narrow to one pay schedule
19801
+ * Filter by import status:
19802
+ * * `pending`
19803
+ * * `processing`
19804
+ * * `processed`
19805
+ * * `success`
19806
+ * * `failed`
19807
+ *
19299
19808
  */
19300
- 'filter[timekeeping_pay_period_config_id]'?: string;
19809
+ 'filter[status]'?: string;
19301
19810
  filter?: string;
19302
19811
  'filter[unexpected]'?: string;
19812
+ 'filter[completed_at][gte]'?: string;
19813
+ 'filter[completed_at][lte]'?: string;
19814
+ 'filter[created_at][gte]'?: string;
19815
+ 'filter[created_at][lte]'?: string;
19816
+ 'filter[updated_at][gte]'?: string;
19817
+ 'filter[updated_at][lte]'?: string;
19303
19818
  /**
19304
19819
  * This pagination cursor corresponds to the cursor value found in the response in
19305
19820
  * `meta.page.next_cursor`.
@@ -19311,9 +19826,9 @@ export type ListFringeBenefitPlansData = {
19311
19826
  'page[limit]'?: number;
19312
19827
  page?: string;
19313
19828
  };
19314
- url: '/api/v1/payrolls/fringe_benefit_plans';
19829
+ url: '/api/v1/pay_periods/{pay_period_id}/imports/aggregate_times';
19315
19830
  };
19316
- export type ListFringeBenefitPlansErrors = {
19831
+ export type ListAggregateTimeImportsErrors = {
19317
19832
  /**
19318
19833
  * Bad Request
19319
19834
  */
@@ -19322,52 +19837,36 @@ export type ListFringeBenefitPlansErrors = {
19322
19837
  * Forbidden
19323
19838
  */
19324
19839
  403: Problem;
19840
+ /**
19841
+ * Unprocessable Content
19842
+ */
19843
+ 422: Problem;
19325
19844
  };
19326
- export type ListFringeBenefitPlansError = ListFringeBenefitPlansErrors[keyof ListFringeBenefitPlansErrors];
19327
- export type ListFringeBenefitPlansResponses = {
19845
+ export type ListAggregateTimeImportsError = ListAggregateTimeImportsErrors[keyof ListAggregateTimeImportsErrors];
19846
+ export type ListAggregateTimeImportsResponses = {
19328
19847
  /**
19329
19848
  * Success
19330
19849
  */
19331
19850
  200: {
19332
19851
  meta: Meta;
19333
19852
  links: Links;
19334
- data: Array<PayrollFringeBenefitPlanResponseObject>;
19853
+ data: Array<AggregateTimeImportResponseObject>;
19335
19854
  };
19336
19855
  };
19337
- export type ListFringeBenefitPlansResponse = ListFringeBenefitPlansResponses[keyof ListFringeBenefitPlansResponses];
19338
- export type CreateFringeBenefitPlanData = {
19339
- body?: PayrollFringeBenefitPlanParameters;
19340
- path?: never;
19341
- query?: never;
19342
- url: '/api/v1/payrolls/fringe_benefit_plans';
19343
- };
19344
- export type CreateFringeBenefitPlanErrors = {
19345
- /**
19346
- * Forbidden
19347
- */
19348
- 403: Problem;
19349
- /**
19350
- * Unprocessable Content
19351
- */
19352
- 422: Problem;
19353
- };
19354
- export type CreateFringeBenefitPlanError = CreateFringeBenefitPlanErrors[keyof CreateFringeBenefitPlanErrors];
19355
- export type CreateFringeBenefitPlanResponses = {
19356
- /**
19357
- * Created
19358
- */
19359
- 201: PayrollFringeBenefitPlanResponseObject;
19360
- };
19361
- export type CreateFringeBenefitPlanResponse = CreateFringeBenefitPlanResponses[keyof CreateFringeBenefitPlanResponses];
19362
- export type DeleteFringeBenefitPlanData = {
19363
- body?: never;
19856
+ export type ListAggregateTimeImportsResponse = ListAggregateTimeImportsResponses[keyof ListAggregateTimeImportsResponses];
19857
+ export type CreateAggregateTimeImportData = {
19858
+ body: AggregateTimeImportParameters;
19364
19859
  path: {
19365
- id: string;
19860
+ pay_period_id: string;
19366
19861
  };
19367
19862
  query?: never;
19368
- url: '/api/v1/payrolls/fringe_benefit_plans/{id}';
19863
+ url: '/api/v1/pay_periods/{pay_period_id}/imports/aggregate_times';
19369
19864
  };
19370
- export type DeleteFringeBenefitPlanErrors = {
19865
+ export type CreateAggregateTimeImportErrors = {
19866
+ /**
19867
+ * Bad Request
19868
+ */
19869
+ 400: Problem;
19371
19870
  /**
19372
19871
  * Forbidden
19373
19872
  */
@@ -19376,50 +19875,33 @@ export type DeleteFringeBenefitPlanErrors = {
19376
19875
  * Not Found
19377
19876
  */
19378
19877
  404: Problem;
19379
- };
19380
- export type DeleteFringeBenefitPlanError = DeleteFringeBenefitPlanErrors[keyof DeleteFringeBenefitPlanErrors];
19381
- export type DeleteFringeBenefitPlanResponses = {
19382
- /**
19383
- * Success
19384
- */
19385
- 200: PayrollFringeBenefitPlanResponseObject;
19386
- };
19387
- export type DeleteFringeBenefitPlanResponse = DeleteFringeBenefitPlanResponses[keyof DeleteFringeBenefitPlanResponses];
19388
- export type GetFringeBenefitPlanData = {
19389
- body?: never;
19390
- path: {
19391
- id: string;
19392
- };
19393
- query?: never;
19394
- url: '/api/v1/payrolls/fringe_benefit_plans/{id}';
19395
- };
19396
- export type GetFringeBenefitPlanErrors = {
19397
19878
  /**
19398
- * Forbidden
19879
+ * Conflict
19399
19880
  */
19400
- 403: Problem;
19881
+ 409: Problem;
19401
19882
  /**
19402
- * Not Found
19883
+ * Unprocessable Content
19403
19884
  */
19404
- 404: Problem;
19885
+ 422: Problem;
19405
19886
  };
19406
- export type GetFringeBenefitPlanError = GetFringeBenefitPlanErrors[keyof GetFringeBenefitPlanErrors];
19407
- export type GetFringeBenefitPlanResponses = {
19887
+ export type CreateAggregateTimeImportError = CreateAggregateTimeImportErrors[keyof CreateAggregateTimeImportErrors];
19888
+ export type CreateAggregateTimeImportResponses = {
19408
19889
  /**
19409
- * Success
19890
+ * Created
19410
19891
  */
19411
- 200: PayrollFringeBenefitPlanResponseObject;
19892
+ 201: AggregateTimeImportResponseObject;
19412
19893
  };
19413
- export type GetFringeBenefitPlanResponse = GetFringeBenefitPlanResponses[keyof GetFringeBenefitPlanResponses];
19414
- export type UpdateFringeBenefitPlanData = {
19415
- body?: PayrollFringeBenefitPlanUpdateParameters;
19894
+ export type CreateAggregateTimeImportResponse = CreateAggregateTimeImportResponses[keyof CreateAggregateTimeImportResponses];
19895
+ export type GetAggregateTimeImportData = {
19896
+ body?: never;
19416
19897
  path: {
19898
+ pay_period_id: string;
19417
19899
  id: string;
19418
19900
  };
19419
19901
  query?: never;
19420
- url: '/api/v1/payrolls/fringe_benefit_plans/{id}';
19902
+ url: '/api/v1/pay_periods/{pay_period_id}/imports/aggregate_times/{id}';
19421
19903
  };
19422
- export type UpdateFringeBenefitPlanErrors = {
19904
+ export type GetAggregateTimeImportErrors = {
19423
19905
  /**
19424
19906
  * Forbidden
19425
19907
  */
@@ -19428,23 +19910,19 @@ export type UpdateFringeBenefitPlanErrors = {
19428
19910
  * Not Found
19429
19911
  */
19430
19912
  404: Problem;
19431
- /**
19432
- * Unprocessable Content
19433
- */
19434
- 422: Problem;
19435
19913
  };
19436
- export type UpdateFringeBenefitPlanError = UpdateFringeBenefitPlanErrors[keyof UpdateFringeBenefitPlanErrors];
19437
- export type UpdateFringeBenefitPlanResponses = {
19914
+ export type GetAggregateTimeImportError = GetAggregateTimeImportErrors[keyof GetAggregateTimeImportErrors];
19915
+ export type GetAggregateTimeImportResponses = {
19438
19916
  /**
19439
19917
  * Success
19440
19918
  */
19441
- 200: PayrollFringeBenefitPlanResponseObject;
19919
+ 200: AggregateTimeImportResponseObject;
19442
19920
  };
19443
- export type UpdateFringeBenefitPlanResponse = UpdateFringeBenefitPlanResponses[keyof UpdateFringeBenefitPlanResponses];
19444
- export type ListPaystubImportsData = {
19921
+ export type GetAggregateTimeImportResponse = GetAggregateTimeImportResponses[keyof GetAggregateTimeImportResponses];
19922
+ export type ListDsptchCprImportsData = {
19445
19923
  body?: never;
19446
19924
  path: {
19447
- payroll_run_id: string;
19925
+ pay_period_id: string;
19448
19926
  };
19449
19927
  query?: {
19450
19928
  /**
@@ -19476,9 +19954,9 @@ export type ListPaystubImportsData = {
19476
19954
  'page[limit]'?: number;
19477
19955
  page?: string;
19478
19956
  };
19479
- url: '/api/v1/payrolls/payroll_runs/{payroll_run_id}/imports/paystubs';
19957
+ url: '/api/v1/pay_periods/{pay_period_id}/imports/dsptch_cprs';
19480
19958
  };
19481
- export type ListPaystubImportsErrors = {
19959
+ export type ListDsptchCprImportsErrors = {
19482
19960
  /**
19483
19961
  * Bad Request
19484
19962
  */
@@ -19492,27 +19970,27 @@ export type ListPaystubImportsErrors = {
19492
19970
  */
19493
19971
  422: Problem;
19494
19972
  };
19495
- export type ListPaystubImportsError = ListPaystubImportsErrors[keyof ListPaystubImportsErrors];
19496
- export type ListPaystubImportsResponses = {
19973
+ export type ListDsptchCprImportsError = ListDsptchCprImportsErrors[keyof ListDsptchCprImportsErrors];
19974
+ export type ListDsptchCprImportsResponses = {
19497
19975
  /**
19498
19976
  * Success
19499
19977
  */
19500
19978
  200: {
19501
19979
  meta: Meta;
19502
19980
  links: Links;
19503
- data: Array<PaystubImportResponseObject>;
19981
+ data: Array<DsptchCprImportResponseObject>;
19504
19982
  };
19505
19983
  };
19506
- export type ListPaystubImportsResponse = ListPaystubImportsResponses[keyof ListPaystubImportsResponses];
19507
- export type CreatePaystubImportData = {
19508
- body: PaystubImportParameters;
19984
+ export type ListDsptchCprImportsResponse = ListDsptchCprImportsResponses[keyof ListDsptchCprImportsResponses];
19985
+ export type CreateDsptchCprImportData = {
19986
+ body: DsptchCprImportParameters;
19509
19987
  path: {
19510
- payroll_run_id: string;
19988
+ pay_period_id: string;
19511
19989
  };
19512
19990
  query?: never;
19513
- url: '/api/v1/payrolls/payroll_runs/{payroll_run_id}/imports/paystubs';
19991
+ url: '/api/v1/pay_periods/{pay_period_id}/imports/dsptch_cprs';
19514
19992
  };
19515
- export type CreatePaystubImportErrors = {
19993
+ export type CreateDsptchCprImportErrors = {
19516
19994
  /**
19517
19995
  * Bad Request
19518
19996
  */
@@ -19534,24 +20012,24 @@ export type CreatePaystubImportErrors = {
19534
20012
  */
19535
20013
  422: Problem;
19536
20014
  };
19537
- export type CreatePaystubImportError = CreatePaystubImportErrors[keyof CreatePaystubImportErrors];
19538
- export type CreatePaystubImportResponses = {
20015
+ export type CreateDsptchCprImportError = CreateDsptchCprImportErrors[keyof CreateDsptchCprImportErrors];
20016
+ export type CreateDsptchCprImportResponses = {
19539
20017
  /**
19540
20018
  * Created
19541
20019
  */
19542
- 201: PaystubImportResponseObject;
20020
+ 201: DsptchCprImportResponseObject;
19543
20021
  };
19544
- export type CreatePaystubImportResponse = CreatePaystubImportResponses[keyof CreatePaystubImportResponses];
19545
- export type GetPaystubImportData = {
20022
+ export type CreateDsptchCprImportResponse = CreateDsptchCprImportResponses[keyof CreateDsptchCprImportResponses];
20023
+ export type GetDsptchCprImportData = {
19546
20024
  body?: never;
19547
20025
  path: {
19548
- payroll_run_id: string;
20026
+ pay_period_id: string;
19549
20027
  id: string;
19550
20028
  };
19551
20029
  query?: never;
19552
- url: '/api/v1/payrolls/payroll_runs/{payroll_run_id}/imports/paystubs/{id}';
20030
+ url: '/api/v1/pay_periods/{pay_period_id}/imports/dsptch_cprs/{id}';
19553
20031
  };
19554
- export type GetPaystubImportErrors = {
20032
+ export type GetDsptchCprImportErrors = {
19555
20033
  /**
19556
20034
  * Forbidden
19557
20035
  */
@@ -19561,38 +20039,38 @@ export type GetPaystubImportErrors = {
19561
20039
  */
19562
20040
  404: Problem;
19563
20041
  };
19564
- export type GetPaystubImportError = GetPaystubImportErrors[keyof GetPaystubImportErrors];
19565
- export type GetPaystubImportResponses = {
20042
+ export type GetDsptchCprImportError = GetDsptchCprImportErrors[keyof GetDsptchCprImportErrors];
20043
+ export type GetDsptchCprImportResponses = {
19566
20044
  /**
19567
20045
  * Success
19568
20046
  */
19569
- 200: PaystubImportResponseObject;
20047
+ 200: DsptchCprImportResponseObject;
19570
20048
  };
19571
- export type GetPaystubImportResponse = GetPaystubImportResponses[keyof GetPaystubImportResponses];
19572
- export type ListPayrollRunsData = {
20049
+ export type GetDsptchCprImportResponse = GetDsptchCprImportResponses[keyof GetDsptchCprImportResponses];
20050
+ export type ListTimeEntryImportsData = {
19573
20051
  body?: never;
19574
- path?: never;
20052
+ path: {
20053
+ pay_period_id: string;
20054
+ };
19575
20055
  query?: {
19576
20056
  /**
19577
- * :
19578
- * * `CORRECTION`
19579
- * * `ON_CYCLE`
19580
- * * `OFF_CYCLE`
19581
- * * `RECONCILIATION`
19582
- * * `SIGN_ON_BONUS`
19583
- * * `TERMINATION`
20057
+ * Filter by import status:
20058
+ * * `pending`
20059
+ * * `processing`
20060
+ * * `processed`
20061
+ * * `success`
20062
+ * * `failed`
19584
20063
  *
19585
20064
  */
19586
- 'filter[run_type]'?: string;
19587
- 'filter[timekeeping_pay_period_id]'?: string;
19588
- 'filter[run_date][gte]'?: string;
19589
- 'filter[run_date][lte]'?: string;
20065
+ 'filter[status]'?: string;
20066
+ filter?: string;
20067
+ 'filter[unexpected]'?: string;
20068
+ 'filter[completed_at][gte]'?: string;
20069
+ 'filter[completed_at][lte]'?: string;
19590
20070
  'filter[created_at][gte]'?: string;
19591
20071
  'filter[created_at][lte]'?: string;
19592
20072
  'filter[updated_at][gte]'?: string;
19593
20073
  'filter[updated_at][lte]'?: string;
19594
- filter?: string;
19595
- 'filter[unexpected]'?: string;
19596
20074
  /**
19597
20075
  * This pagination cursor corresponds to the cursor value found in the response in
19598
20076
  * `meta.page.next_cursor`.
@@ -19604,9 +20082,9 @@ export type ListPayrollRunsData = {
19604
20082
  'page[limit]'?: number;
19605
20083
  page?: string;
19606
20084
  };
19607
- url: '/api/v1/payrolls/payroll_runs';
20085
+ url: '/api/v1/pay_periods/{pay_period_id}/imports/time_entries';
19608
20086
  };
19609
- export type ListPayrollRunsErrors = {
20087
+ export type ListTimeEntryImportsErrors = {
19610
20088
  /**
19611
20089
  * Bad Request
19612
20090
  */
@@ -19620,51 +20098,31 @@ export type ListPayrollRunsErrors = {
19620
20098
  */
19621
20099
  422: Problem;
19622
20100
  };
19623
- export type ListPayrollRunsError = ListPayrollRunsErrors[keyof ListPayrollRunsErrors];
19624
- export type ListPayrollRunsResponses = {
20101
+ export type ListTimeEntryImportsError = ListTimeEntryImportsErrors[keyof ListTimeEntryImportsErrors];
20102
+ export type ListTimeEntryImportsResponses = {
19625
20103
  /**
19626
20104
  * Success
19627
20105
  */
19628
- 200: PayrollRunsResponseObject;
20106
+ 200: {
20107
+ meta: Meta;
20108
+ links: Links;
20109
+ data: Array<TimeEntryImportResponseObject>;
20110
+ };
19629
20111
  };
19630
- export type ListPayrollRunsResponse = ListPayrollRunsResponses[keyof ListPayrollRunsResponses];
19631
- export type CreatePayrollRunData = {
19632
- body?: PayrollRunParameters;
19633
- path?: never;
20112
+ export type ListTimeEntryImportsResponse = ListTimeEntryImportsResponses[keyof ListTimeEntryImportsResponses];
20113
+ export type CreateTimeEntryImportData = {
20114
+ body: TimeEntryImportParameters;
20115
+ path: {
20116
+ pay_period_id: string;
20117
+ };
19634
20118
  query?: never;
19635
- url: '/api/v1/payrolls/payroll_runs';
20119
+ url: '/api/v1/pay_periods/{pay_period_id}/imports/time_entries';
19636
20120
  };
19637
- export type CreatePayrollRunErrors = {
20121
+ export type CreateTimeEntryImportErrors = {
19638
20122
  /**
19639
20123
  * Bad Request
19640
20124
  */
19641
20125
  400: Problem;
19642
- /**
19643
- * Forbidden
19644
- */
19645
- 403: Problem;
19646
- /**
19647
- * Unprocessable Content
19648
- */
19649
- 422: Problem;
19650
- };
19651
- export type CreatePayrollRunError = CreatePayrollRunErrors[keyof CreatePayrollRunErrors];
19652
- export type CreatePayrollRunResponses = {
19653
- /**
19654
- * Success
19655
- */
19656
- 201: PayrollRunResponseObject;
19657
- };
19658
- export type CreatePayrollRunResponse = CreatePayrollRunResponses[keyof CreatePayrollRunResponses];
19659
- export type DeletePayrollRunData = {
19660
- body?: never;
19661
- path: {
19662
- id: string;
19663
- };
19664
- query?: never;
19665
- url: '/api/v1/payrolls/payroll_runs/{id}';
19666
- };
19667
- export type DeletePayrollRunErrors = {
19668
20126
  /**
19669
20127
  * Forbidden
19670
20128
  */
@@ -19673,58 +20131,33 @@ export type DeletePayrollRunErrors = {
19673
20131
  * Not Found
19674
20132
  */
19675
20133
  404: Problem;
20134
+ /**
20135
+ * Conflict
20136
+ */
20137
+ 409: Problem;
19676
20138
  /**
19677
20139
  * Unprocessable Content
19678
20140
  */
19679
20141
  422: Problem;
19680
20142
  };
19681
- export type DeletePayrollRunError = DeletePayrollRunErrors[keyof DeletePayrollRunErrors];
19682
- export type DeletePayrollRunResponses = {
20143
+ export type CreateTimeEntryImportError = CreateTimeEntryImportErrors[keyof CreateTimeEntryImportErrors];
20144
+ export type CreateTimeEntryImportResponses = {
19683
20145
  /**
19684
- * Success
20146
+ * Created
19685
20147
  */
19686
- 200: PayrollRunResponseObject;
20148
+ 201: TimeEntryImportResponseObject;
19687
20149
  };
19688
- export type DeletePayrollRunResponse = DeletePayrollRunResponses[keyof DeletePayrollRunResponses];
19689
- export type GetPayrollRunData = {
20150
+ export type CreateTimeEntryImportResponse = CreateTimeEntryImportResponses[keyof CreateTimeEntryImportResponses];
20151
+ export type GetTimeEntryImportData = {
19690
20152
  body?: never;
19691
20153
  path: {
20154
+ pay_period_id: string;
19692
20155
  id: string;
19693
20156
  };
19694
20157
  query?: never;
19695
- url: '/api/v1/payrolls/payroll_runs/{id}';
19696
- };
19697
- export type GetPayrollRunErrors = {
19698
- /**
19699
- * Forbidden
19700
- */
19701
- 403: Problem;
19702
- /**
19703
- * Not Found
19704
- */
19705
- 404: Problem;
19706
- };
19707
- export type GetPayrollRunError = GetPayrollRunErrors[keyof GetPayrollRunErrors];
19708
- export type GetPayrollRunResponses = {
19709
- /**
19710
- * Success
19711
- */
19712
- 200: PayrollRunResponseObject;
19713
- };
19714
- export type GetPayrollRunResponse = GetPayrollRunResponses[keyof GetPayrollRunResponses];
19715
- export type UpdatePayrollRunData = {
19716
- body?: PayrollRunUpdateParameters;
19717
- path: {
19718
- id: string;
19719
- };
19720
- query?: never;
19721
- url: '/api/v1/payrolls/payroll_runs/{id}';
20158
+ url: '/api/v1/pay_periods/{pay_period_id}/imports/time_entries/{id}';
19722
20159
  };
19723
- export type UpdatePayrollRunErrors = {
19724
- /**
19725
- * Bad Request
19726
- */
19727
- 400: Problem;
20160
+ export type GetTimeEntryImportErrors = {
19728
20161
  /**
19729
20162
  * Forbidden
19730
20163
  */
@@ -19733,27 +20166,21 @@ export type UpdatePayrollRunErrors = {
19733
20166
  * Not Found
19734
20167
  */
19735
20168
  404: Problem;
19736
- /**
19737
- * Unprocessable Content
19738
- */
19739
- 422: Problem;
19740
20169
  };
19741
- export type UpdatePayrollRunError = UpdatePayrollRunErrors[keyof UpdatePayrollRunErrors];
19742
- export type UpdatePayrollRunResponses = {
20170
+ export type GetTimeEntryImportError = GetTimeEntryImportErrors[keyof GetTimeEntryImportErrors];
20171
+ export type GetTimeEntryImportResponses = {
19743
20172
  /**
19744
20173
  * Success
19745
20174
  */
19746
- 200: PayrollRunResponseObject;
20175
+ 200: TimeEntryImportResponseObject;
19747
20176
  };
19748
- export type UpdatePayrollRunResponse = UpdatePayrollRunResponses[keyof UpdatePayrollRunResponses];
19749
- export type ListPaystubLineItemsData = {
20177
+ export type GetTimeEntryImportResponse = GetTimeEntryImportResponses[keyof GetTimeEntryImportResponses];
20178
+ export type ListPayPeriodsData = {
19750
20179
  body?: never;
19751
20180
  path?: never;
19752
20181
  query?: {
19753
- /**
19754
- * Filter line items by paystub ID
19755
- */
19756
- 'filter[payrolls_paystub_id]'?: string;
20182
+ 'filter[start_time][gte]'?: string;
20183
+ 'filter[start_time][lte]'?: string;
19757
20184
  filter?: string;
19758
20185
  'filter[unexpected]'?: string;
19759
20186
  /**
@@ -19767,9 +20194,9 @@ export type ListPaystubLineItemsData = {
19767
20194
  'page[limit]'?: number;
19768
20195
  page?: string;
19769
20196
  };
19770
- url: '/api/v1/paystub_line_items';
20197
+ url: '/api/v1/pay_periods';
19771
20198
  };
19772
- export type ListPaystubLineItemsErrors = {
20199
+ export type ListPayPeriodsErrors = {
19773
20200
  /**
19774
20201
  * Bad Request
19775
20202
  */
@@ -19778,51 +20205,52 @@ export type ListPaystubLineItemsErrors = {
19778
20205
  * Forbidden
19779
20206
  */
19780
20207
  403: Problem;
20208
+ /**
20209
+ * Unprocessable Content
20210
+ */
20211
+ 422: Problem;
19781
20212
  };
19782
- export type ListPaystubLineItemsError = ListPaystubLineItemsErrors[keyof ListPaystubLineItemsErrors];
19783
- export type ListPaystubLineItemsResponses = {
20213
+ export type ListPayPeriodsError = ListPayPeriodsErrors[keyof ListPayPeriodsErrors];
20214
+ export type ListPayPeriodsResponses = {
19784
20215
  /**
19785
20216
  * Success
19786
20217
  */
19787
- 200: PaystubLineItemsResponseObject;
20218
+ 200: PayPeriodsResponseObject;
19788
20219
  };
19789
- export type ListPaystubLineItemsResponse = ListPaystubLineItemsResponses[keyof ListPaystubLineItemsResponses];
19790
- export type CreatePaystubLineItemData = {
19791
- body?: PaystubLineItemParameters;
20220
+ export type ListPayPeriodsResponse = ListPayPeriodsResponses[keyof ListPayPeriodsResponses];
20221
+ export type ListCompensationElementsData = {
20222
+ body?: never;
19792
20223
  path?: never;
19793
20224
  query?: never;
19794
- url: '/api/v1/paystub_line_items';
20225
+ url: '/api/v1/payrolls/compensation_elements';
19795
20226
  };
19796
- export type CreatePaystubLineItemErrors = {
20227
+ export type ListCompensationElementsErrors = {
19797
20228
  /**
19798
20229
  * Forbidden
19799
20230
  */
19800
20231
  403: Problem;
19801
- /**
19802
- * Unprocessable Content
19803
- */
19804
- 422: Problem;
19805
20232
  };
19806
- export type CreatePaystubLineItemError = CreatePaystubLineItemErrors[keyof CreatePaystubLineItemErrors];
19807
- export type CreatePaystubLineItemResponses = {
20233
+ export type ListCompensationElementsError = ListCompensationElementsErrors[keyof ListCompensationElementsErrors];
20234
+ export type ListCompensationElementsResponses = {
19808
20235
  /**
19809
20236
  * Success
19810
20237
  */
19811
- 201: PaystubLineItemResponseObject;
20238
+ 200: {
20239
+ meta: Meta;
20240
+ links: Links;
20241
+ data: Array<CompensationElementResponseObject>;
20242
+ };
19812
20243
  };
19813
- export type CreatePaystubLineItemResponse = CreatePaystubLineItemResponses[keyof CreatePaystubLineItemResponses];
19814
- export type DeletePaystubLineItemData = {
20244
+ export type ListCompensationElementsResponse = ListCompensationElementsResponses[keyof ListCompensationElementsResponses];
20245
+ export type GetCompensationElementData = {
19815
20246
  body?: never;
19816
20247
  path: {
19817
- /**
19818
- * Paystub Line Item ID
19819
- */
19820
20248
  id: string;
19821
20249
  };
19822
20250
  query?: never;
19823
- url: '/api/v1/paystub_line_items/{id}';
20251
+ url: '/api/v1/payrolls/compensation_elements/{id}';
19824
20252
  };
19825
- export type DeletePaystubLineItemErrors = {
20253
+ export type GetCompensationElementErrors = {
19826
20254
  /**
19827
20255
  * Forbidden
19828
20256
  */
@@ -19832,26 +20260,894 @@ export type DeletePaystubLineItemErrors = {
19832
20260
  */
19833
20261
  404: Problem;
19834
20262
  };
19835
- export type DeletePaystubLineItemError = DeletePaystubLineItemErrors[keyof DeletePaystubLineItemErrors];
19836
- export type DeletePaystubLineItemResponses = {
20263
+ export type GetCompensationElementError = GetCompensationElementErrors[keyof GetCompensationElementErrors];
20264
+ export type GetCompensationElementResponses = {
19837
20265
  /**
19838
20266
  * Success
19839
20267
  */
19840
- 200: PaystubLineItemResponseObject;
20268
+ 200: CompensationElementResponseObject;
19841
20269
  };
19842
- export type DeletePaystubLineItemResponse = DeletePaystubLineItemResponses[keyof DeletePaystubLineItemResponses];
19843
- export type GetPaystubLineItemData = {
20270
+ export type GetCompensationElementResponse = GetCompensationElementResponses[keyof GetCompensationElementResponses];
20271
+ export type ListExternalMapHistoryData = {
19844
20272
  body?: never;
19845
20273
  path: {
19846
20274
  /**
19847
- * Paystub Line Item ID
20275
+ * The external map's version-stable identity, as returned in `id`.
20276
+ */
20277
+ external_map_id: string;
20278
+ };
20279
+ query?: {
20280
+ /**
20281
+ * Read the timeline as it was recorded at this moment — the corrections nested under each version stop at the same point, and each version publishes the `transaction_to` it had then, so one corrected since still reads as open. `version_status` is always relative to now. Defaults to now.
20282
+ */
20283
+ 'as_of[transaction]'?: string;
20284
+ 'as_of[valid]'?: string;
20285
+ };
20286
+ url: '/api/v1/payrolls/external_maps/{external_map_id}/history';
20287
+ };
20288
+ export type ListExternalMapHistoryErrors = {
20289
+ /**
20290
+ * Bad Request
20291
+ */
20292
+ 400: Problem;
20293
+ /**
20294
+ * Forbidden
20295
+ */
20296
+ 403: Problem;
20297
+ /**
20298
+ * Not Found
20299
+ */
20300
+ 404: Problem;
20301
+ };
20302
+ export type ListExternalMapHistoryError = ListExternalMapHistoryErrors[keyof ListExternalMapHistoryErrors];
20303
+ export type ListExternalMapHistoryResponses = {
20304
+ /**
20305
+ * Success
20306
+ */
20307
+ 200: {
20308
+ meta: Meta;
20309
+ links: Links;
20310
+ data: Array<PayrollExternalMapHistoryVersionObject>;
20311
+ };
20312
+ };
20313
+ export type ListExternalMapHistoryResponse = ListExternalMapHistoryResponses[keyof ListExternalMapHistoryResponses];
20314
+ export type ListExternalMapsData = {
20315
+ body?: never;
20316
+ path?: never;
20317
+ query?: {
20318
+ /**
20319
+ * Fuzzy-match the external field name
20320
+ */
20321
+ 'filter[name]'?: string;
20322
+ /**
20323
+ * Narrow to one pay schedule
20324
+ */
20325
+ 'filter[timekeeping_pay_period_config_id]'?: string;
20326
+ /**
20327
+ * true → only global maps; false → only company-owned
20328
+ */
20329
+ 'filter[global]'?: boolean;
20330
+ filter?: string;
20331
+ 'filter[unexpected]'?: string;
20332
+ /**
20333
+ * This pagination cursor corresponds to the cursor value found in the response in
20334
+ * `meta.page.next_cursor`.
20335
+ */
20336
+ 'page[cursor]'?: string;
20337
+ /**
20338
+ * Maximum number of records to return per page. Defaults to 20. A value above 100 is capped to 100 rather than rejected; a value that is zero, negative, or not an integer is rejected with a `400`.
20339
+ */
20340
+ 'page[limit]'?: number;
20341
+ page?: string;
20342
+ /**
20343
+ * Read the version valid at this point in time. Defaults to now.
20344
+ */
20345
+ 'as_of[valid]'?: string;
20346
+ /**
20347
+ * Read the version as it was recorded at this point in transaction time. Its `transaction_to` is published as of that point, so a version corrected since still reads as open. Defaults to now.
20348
+ */
20349
+ 'as_of[transaction]'?: string;
20350
+ as_of?: string;
20351
+ 'as_of[bogus_axis]'?: string;
20352
+ 'as_of[valid][gte]'?: string;
20353
+ };
20354
+ url: '/api/v1/payrolls/external_maps';
20355
+ };
20356
+ export type ListExternalMapsErrors = {
20357
+ /**
20358
+ * Bad Request
20359
+ */
20360
+ 400: Problem;
20361
+ /**
20362
+ * Forbidden
20363
+ */
20364
+ 403: Problem;
20365
+ /**
20366
+ * Unprocessable Content
20367
+ */
20368
+ 422: Problem;
20369
+ };
20370
+ export type ListExternalMapsError = ListExternalMapsErrors[keyof ListExternalMapsErrors];
20371
+ export type ListExternalMapsResponses = {
20372
+ /**
20373
+ * Success
20374
+ */
20375
+ 200: {
20376
+ meta: Meta;
20377
+ links: Links;
20378
+ data: Array<PayrollExternalMapResponseObject>;
20379
+ };
20380
+ };
20381
+ export type ListExternalMapsResponse = ListExternalMapsResponses[keyof ListExternalMapsResponses];
20382
+ export type GetExternalMapData = {
20383
+ body?: never;
20384
+ path: {
20385
+ id: string;
20386
+ };
20387
+ query?: {
20388
+ /**
20389
+ * Read the version valid at this point in time. Defaults to now.
20390
+ */
20391
+ 'as_of[valid]'?: string;
20392
+ /**
20393
+ * Read the version as it was recorded at this point in transaction time. Its `transaction_to` is published as of that point, so a version corrected since still reads as open. Defaults to now.
20394
+ */
20395
+ 'as_of[transaction]'?: string;
20396
+ };
20397
+ url: '/api/v1/payrolls/external_maps/{id}';
20398
+ };
20399
+ export type GetExternalMapErrors = {
20400
+ /**
20401
+ * Forbidden
20402
+ */
20403
+ 403: Problem;
20404
+ /**
20405
+ * Not Found
20406
+ */
20407
+ 404: Problem;
20408
+ };
20409
+ export type GetExternalMapError = GetExternalMapErrors[keyof GetExternalMapErrors];
20410
+ export type GetExternalMapResponses = {
20411
+ /**
20412
+ * Success
20413
+ */
20414
+ 200: PayrollExternalMapResponseObject;
20415
+ };
20416
+ export type GetExternalMapResponse = GetExternalMapResponses[keyof GetExternalMapResponses];
20417
+ export type ListFringeBenefitPlansData = {
20418
+ body?: never;
20419
+ path?: never;
20420
+ query?: {
20421
+ /**
20422
+ * Fuzzy-match by plan name or number
20423
+ */
20424
+ 'filter[name]'?: string;
20425
+ /**
20426
+ * Narrow to one pay schedule
20427
+ */
20428
+ 'filter[timekeeping_pay_period_config_id]'?: string;
20429
+ filter?: string;
20430
+ 'filter[unexpected]'?: string;
20431
+ /**
20432
+ * This pagination cursor corresponds to the cursor value found in the response in
20433
+ * `meta.page.next_cursor`.
20434
+ */
20435
+ 'page[cursor]'?: string;
20436
+ /**
20437
+ * Maximum number of records to return per page. Defaults to 20. A value above 100 is capped to 100 rather than rejected; a value that is zero, negative, or not an integer is rejected with a `400`.
20438
+ */
20439
+ 'page[limit]'?: number;
20440
+ page?: string;
20441
+ };
20442
+ url: '/api/v1/payrolls/fringe_benefit_plans';
20443
+ };
20444
+ export type ListFringeBenefitPlansErrors = {
20445
+ /**
20446
+ * Bad Request
20447
+ */
20448
+ 400: Problem;
20449
+ /**
20450
+ * Forbidden
20451
+ */
20452
+ 403: Problem;
20453
+ };
20454
+ export type ListFringeBenefitPlansError = ListFringeBenefitPlansErrors[keyof ListFringeBenefitPlansErrors];
20455
+ export type ListFringeBenefitPlansResponses = {
20456
+ /**
20457
+ * Success
20458
+ */
20459
+ 200: {
20460
+ meta: Meta;
20461
+ links: Links;
20462
+ data: Array<PayrollFringeBenefitPlanResponseObject>;
20463
+ };
20464
+ };
20465
+ export type ListFringeBenefitPlansResponse = ListFringeBenefitPlansResponses[keyof ListFringeBenefitPlansResponses];
20466
+ export type CreateFringeBenefitPlanData = {
20467
+ body?: PayrollFringeBenefitPlanParameters;
20468
+ path?: never;
20469
+ query?: never;
20470
+ url: '/api/v1/payrolls/fringe_benefit_plans';
20471
+ };
20472
+ export type CreateFringeBenefitPlanErrors = {
20473
+ /**
20474
+ * Forbidden
20475
+ */
20476
+ 403: Problem;
20477
+ /**
20478
+ * Unprocessable Content
20479
+ */
20480
+ 422: Problem;
20481
+ };
20482
+ export type CreateFringeBenefitPlanError = CreateFringeBenefitPlanErrors[keyof CreateFringeBenefitPlanErrors];
20483
+ export type CreateFringeBenefitPlanResponses = {
20484
+ /**
20485
+ * Created
20486
+ */
20487
+ 201: PayrollFringeBenefitPlanResponseObject;
20488
+ };
20489
+ export type CreateFringeBenefitPlanResponse = CreateFringeBenefitPlanResponses[keyof CreateFringeBenefitPlanResponses];
20490
+ export type DeleteFringeBenefitPlanData = {
20491
+ body?: never;
20492
+ path: {
20493
+ id: string;
20494
+ };
20495
+ query?: never;
20496
+ url: '/api/v1/payrolls/fringe_benefit_plans/{id}';
20497
+ };
20498
+ export type DeleteFringeBenefitPlanErrors = {
20499
+ /**
20500
+ * Forbidden
20501
+ */
20502
+ 403: Problem;
20503
+ /**
20504
+ * Not Found
20505
+ */
20506
+ 404: Problem;
20507
+ };
20508
+ export type DeleteFringeBenefitPlanError = DeleteFringeBenefitPlanErrors[keyof DeleteFringeBenefitPlanErrors];
20509
+ export type DeleteFringeBenefitPlanResponses = {
20510
+ /**
20511
+ * Success
20512
+ */
20513
+ 200: PayrollFringeBenefitPlanResponseObject;
20514
+ };
20515
+ export type DeleteFringeBenefitPlanResponse = DeleteFringeBenefitPlanResponses[keyof DeleteFringeBenefitPlanResponses];
20516
+ export type GetFringeBenefitPlanData = {
20517
+ body?: never;
20518
+ path: {
20519
+ id: string;
20520
+ };
20521
+ query?: never;
20522
+ url: '/api/v1/payrolls/fringe_benefit_plans/{id}';
20523
+ };
20524
+ export type GetFringeBenefitPlanErrors = {
20525
+ /**
20526
+ * Forbidden
20527
+ */
20528
+ 403: Problem;
20529
+ /**
20530
+ * Not Found
20531
+ */
20532
+ 404: Problem;
20533
+ };
20534
+ export type GetFringeBenefitPlanError = GetFringeBenefitPlanErrors[keyof GetFringeBenefitPlanErrors];
20535
+ export type GetFringeBenefitPlanResponses = {
20536
+ /**
20537
+ * Success
20538
+ */
20539
+ 200: PayrollFringeBenefitPlanResponseObject;
20540
+ };
20541
+ export type GetFringeBenefitPlanResponse = GetFringeBenefitPlanResponses[keyof GetFringeBenefitPlanResponses];
20542
+ export type UpdateFringeBenefitPlanData = {
20543
+ body?: PayrollFringeBenefitPlanUpdateParameters;
20544
+ path: {
20545
+ id: string;
20546
+ };
20547
+ query?: never;
20548
+ url: '/api/v1/payrolls/fringe_benefit_plans/{id}';
20549
+ };
20550
+ export type UpdateFringeBenefitPlanErrors = {
20551
+ /**
20552
+ * Forbidden
20553
+ */
20554
+ 403: Problem;
20555
+ /**
20556
+ * Not Found
20557
+ */
20558
+ 404: Problem;
20559
+ /**
20560
+ * Unprocessable Content
20561
+ */
20562
+ 422: Problem;
20563
+ };
20564
+ export type UpdateFringeBenefitPlanError = UpdateFringeBenefitPlanErrors[keyof UpdateFringeBenefitPlanErrors];
20565
+ export type UpdateFringeBenefitPlanResponses = {
20566
+ /**
20567
+ * Success
20568
+ */
20569
+ 200: PayrollFringeBenefitPlanResponseObject;
20570
+ };
20571
+ export type UpdateFringeBenefitPlanResponse = UpdateFringeBenefitPlanResponses[keyof UpdateFringeBenefitPlanResponses];
20572
+ export type ListPaystubImportsData = {
20573
+ body?: never;
20574
+ path: {
20575
+ payroll_run_id: string;
20576
+ };
20577
+ query?: {
20578
+ /**
20579
+ * Filter by import status:
20580
+ * * `pending`
20581
+ * * `processing`
20582
+ * * `processed`
20583
+ * * `success`
20584
+ * * `failed`
20585
+ *
20586
+ */
20587
+ 'filter[status]'?: string;
20588
+ filter?: string;
20589
+ 'filter[unexpected]'?: string;
20590
+ 'filter[completed_at][gte]'?: string;
20591
+ 'filter[completed_at][lte]'?: string;
20592
+ 'filter[created_at][gte]'?: string;
20593
+ 'filter[created_at][lte]'?: string;
20594
+ 'filter[updated_at][gte]'?: string;
20595
+ 'filter[updated_at][lte]'?: string;
20596
+ /**
20597
+ * This pagination cursor corresponds to the cursor value found in the response in
20598
+ * `meta.page.next_cursor`.
20599
+ */
20600
+ 'page[cursor]'?: string;
20601
+ /**
20602
+ * Maximum number of records to return per page. Defaults to 20. A value above 100 is capped to 100 rather than rejected; a value that is zero, negative, or not an integer is rejected with a `400`.
20603
+ */
20604
+ 'page[limit]'?: number;
20605
+ page?: string;
20606
+ };
20607
+ url: '/api/v1/payrolls/payroll_runs/{payroll_run_id}/imports/paystubs';
20608
+ };
20609
+ export type ListPaystubImportsErrors = {
20610
+ /**
20611
+ * Bad Request
20612
+ */
20613
+ 400: Problem;
20614
+ /**
20615
+ * Forbidden
20616
+ */
20617
+ 403: Problem;
20618
+ /**
20619
+ * Unprocessable Content
20620
+ */
20621
+ 422: Problem;
20622
+ };
20623
+ export type ListPaystubImportsError = ListPaystubImportsErrors[keyof ListPaystubImportsErrors];
20624
+ export type ListPaystubImportsResponses = {
20625
+ /**
20626
+ * Success
20627
+ */
20628
+ 200: {
20629
+ meta: Meta;
20630
+ links: Links;
20631
+ data: Array<PaystubImportResponseObject>;
20632
+ };
20633
+ };
20634
+ export type ListPaystubImportsResponse = ListPaystubImportsResponses[keyof ListPaystubImportsResponses];
20635
+ export type CreatePaystubImportData = {
20636
+ body: PaystubImportParameters;
20637
+ path: {
20638
+ payroll_run_id: string;
20639
+ };
20640
+ query?: never;
20641
+ url: '/api/v1/payrolls/payroll_runs/{payroll_run_id}/imports/paystubs';
20642
+ };
20643
+ export type CreatePaystubImportErrors = {
20644
+ /**
20645
+ * Bad Request
20646
+ */
20647
+ 400: Problem;
20648
+ /**
20649
+ * Forbidden
20650
+ */
20651
+ 403: Problem;
20652
+ /**
20653
+ * Not Found
20654
+ */
20655
+ 404: Problem;
20656
+ /**
20657
+ * Conflict
20658
+ */
20659
+ 409: Problem;
20660
+ /**
20661
+ * Unprocessable Content
20662
+ */
20663
+ 422: Problem;
20664
+ };
20665
+ export type CreatePaystubImportError = CreatePaystubImportErrors[keyof CreatePaystubImportErrors];
20666
+ export type CreatePaystubImportResponses = {
20667
+ /**
20668
+ * Created
20669
+ */
20670
+ 201: PaystubImportResponseObject;
20671
+ };
20672
+ export type CreatePaystubImportResponse = CreatePaystubImportResponses[keyof CreatePaystubImportResponses];
20673
+ export type GetPaystubImportData = {
20674
+ body?: never;
20675
+ path: {
20676
+ payroll_run_id: string;
20677
+ id: string;
20678
+ };
20679
+ query?: never;
20680
+ url: '/api/v1/payrolls/payroll_runs/{payroll_run_id}/imports/paystubs/{id}';
20681
+ };
20682
+ export type GetPaystubImportErrors = {
20683
+ /**
20684
+ * Forbidden
20685
+ */
20686
+ 403: Problem;
20687
+ /**
20688
+ * Not Found
20689
+ */
20690
+ 404: Problem;
20691
+ };
20692
+ export type GetPaystubImportError = GetPaystubImportErrors[keyof GetPaystubImportErrors];
20693
+ export type GetPaystubImportResponses = {
20694
+ /**
20695
+ * Success
20696
+ */
20697
+ 200: PaystubImportResponseObject;
20698
+ };
20699
+ export type GetPaystubImportResponse = GetPaystubImportResponses[keyof GetPaystubImportResponses];
20700
+ export type ListPayrollRunsData = {
20701
+ body?: never;
20702
+ path?: never;
20703
+ query?: {
20704
+ /**
20705
+ * :
20706
+ * * `CORRECTION`
20707
+ * * `ON_CYCLE`
20708
+ * * `OFF_CYCLE`
20709
+ * * `RECONCILIATION`
20710
+ * * `SIGN_ON_BONUS`
20711
+ * * `TERMINATION`
20712
+ *
20713
+ */
20714
+ 'filter[run_type]'?: string;
20715
+ 'filter[timekeeping_pay_period_id]'?: string;
20716
+ 'filter[run_date][gte]'?: string;
20717
+ 'filter[run_date][lte]'?: string;
20718
+ 'filter[created_at][gte]'?: string;
20719
+ 'filter[created_at][lte]'?: string;
20720
+ 'filter[updated_at][gte]'?: string;
20721
+ 'filter[updated_at][lte]'?: string;
20722
+ filter?: string;
20723
+ 'filter[unexpected]'?: string;
20724
+ /**
20725
+ * This pagination cursor corresponds to the cursor value found in the response in
20726
+ * `meta.page.next_cursor`.
20727
+ */
20728
+ 'page[cursor]'?: string;
20729
+ /**
20730
+ * Maximum number of records to return per page. Defaults to 20. A value above 100 is capped to 100 rather than rejected; a value that is zero, negative, or not an integer is rejected with a `400`.
20731
+ */
20732
+ 'page[limit]'?: number;
20733
+ page?: string;
20734
+ };
20735
+ url: '/api/v1/payrolls/payroll_runs';
20736
+ };
20737
+ export type ListPayrollRunsErrors = {
20738
+ /**
20739
+ * Bad Request
20740
+ */
20741
+ 400: Problem;
20742
+ /**
20743
+ * Forbidden
20744
+ */
20745
+ 403: Problem;
20746
+ /**
20747
+ * Unprocessable Content
20748
+ */
20749
+ 422: Problem;
20750
+ };
20751
+ export type ListPayrollRunsError = ListPayrollRunsErrors[keyof ListPayrollRunsErrors];
20752
+ export type ListPayrollRunsResponses = {
20753
+ /**
20754
+ * Success
20755
+ */
20756
+ 200: PayrollRunsResponseObject;
20757
+ };
20758
+ export type ListPayrollRunsResponse = ListPayrollRunsResponses[keyof ListPayrollRunsResponses];
20759
+ export type CreatePayrollRunData = {
20760
+ body?: PayrollRunParameters;
20761
+ path?: never;
20762
+ query?: never;
20763
+ url: '/api/v1/payrolls/payroll_runs';
20764
+ };
20765
+ export type CreatePayrollRunErrors = {
20766
+ /**
20767
+ * Bad Request
20768
+ */
20769
+ 400: Problem;
20770
+ /**
20771
+ * Forbidden
20772
+ */
20773
+ 403: Problem;
20774
+ /**
20775
+ * Unprocessable Content
20776
+ */
20777
+ 422: Problem;
20778
+ };
20779
+ export type CreatePayrollRunError = CreatePayrollRunErrors[keyof CreatePayrollRunErrors];
20780
+ export type CreatePayrollRunResponses = {
20781
+ /**
20782
+ * Success
20783
+ */
20784
+ 201: PayrollRunResponseObject;
20785
+ };
20786
+ export type CreatePayrollRunResponse = CreatePayrollRunResponses[keyof CreatePayrollRunResponses];
20787
+ export type DeletePayrollRunData = {
20788
+ body?: never;
20789
+ path: {
20790
+ id: string;
20791
+ };
20792
+ query?: never;
20793
+ url: '/api/v1/payrolls/payroll_runs/{id}';
20794
+ };
20795
+ export type DeletePayrollRunErrors = {
20796
+ /**
20797
+ * Forbidden
20798
+ */
20799
+ 403: Problem;
20800
+ /**
20801
+ * Not Found
20802
+ */
20803
+ 404: Problem;
20804
+ /**
20805
+ * Unprocessable Content
20806
+ */
20807
+ 422: Problem;
20808
+ };
20809
+ export type DeletePayrollRunError = DeletePayrollRunErrors[keyof DeletePayrollRunErrors];
20810
+ export type DeletePayrollRunResponses = {
20811
+ /**
20812
+ * Success
20813
+ */
20814
+ 200: PayrollRunResponseObject;
20815
+ };
20816
+ export type DeletePayrollRunResponse = DeletePayrollRunResponses[keyof DeletePayrollRunResponses];
20817
+ export type GetPayrollRunData = {
20818
+ body?: never;
20819
+ path: {
20820
+ id: string;
20821
+ };
20822
+ query?: never;
20823
+ url: '/api/v1/payrolls/payroll_runs/{id}';
20824
+ };
20825
+ export type GetPayrollRunErrors = {
20826
+ /**
20827
+ * Forbidden
20828
+ */
20829
+ 403: Problem;
20830
+ /**
20831
+ * Not Found
20832
+ */
20833
+ 404: Problem;
20834
+ };
20835
+ export type GetPayrollRunError = GetPayrollRunErrors[keyof GetPayrollRunErrors];
20836
+ export type GetPayrollRunResponses = {
20837
+ /**
20838
+ * Success
20839
+ */
20840
+ 200: PayrollRunResponseObject;
20841
+ };
20842
+ export type GetPayrollRunResponse = GetPayrollRunResponses[keyof GetPayrollRunResponses];
20843
+ export type UpdatePayrollRunData = {
20844
+ body?: PayrollRunUpdateParameters;
20845
+ path: {
20846
+ id: string;
20847
+ };
20848
+ query?: never;
20849
+ url: '/api/v1/payrolls/payroll_runs/{id}';
20850
+ };
20851
+ export type UpdatePayrollRunErrors = {
20852
+ /**
20853
+ * Bad Request
20854
+ */
20855
+ 400: Problem;
20856
+ /**
20857
+ * Forbidden
20858
+ */
20859
+ 403: Problem;
20860
+ /**
20861
+ * Not Found
20862
+ */
20863
+ 404: Problem;
20864
+ /**
20865
+ * Unprocessable Content
20866
+ */
20867
+ 422: Problem;
20868
+ };
20869
+ export type UpdatePayrollRunError = UpdatePayrollRunErrors[keyof UpdatePayrollRunErrors];
20870
+ export type UpdatePayrollRunResponses = {
20871
+ /**
20872
+ * Success
20873
+ */
20874
+ 200: PayrollRunResponseObject;
20875
+ };
20876
+ export type UpdatePayrollRunResponse = UpdatePayrollRunResponses[keyof UpdatePayrollRunResponses];
20877
+ export type ListPaystubLineItemsData = {
20878
+ body?: never;
20879
+ path?: never;
20880
+ query?: {
20881
+ /**
20882
+ * Filter line items by paystub ID
20883
+ */
20884
+ 'filter[payrolls_paystub_id]'?: string;
20885
+ filter?: string;
20886
+ 'filter[unexpected]'?: string;
20887
+ /**
20888
+ * This pagination cursor corresponds to the cursor value found in the response in
20889
+ * `meta.page.next_cursor`.
20890
+ */
20891
+ 'page[cursor]'?: string;
20892
+ /**
20893
+ * Maximum number of records to return per page. Defaults to 20. A value above 100 is capped to 100 rather than rejected; a value that is zero, negative, or not an integer is rejected with a `400`.
20894
+ */
20895
+ 'page[limit]'?: number;
20896
+ page?: string;
20897
+ };
20898
+ url: '/api/v1/paystub_line_items';
20899
+ };
20900
+ export type ListPaystubLineItemsErrors = {
20901
+ /**
20902
+ * Bad Request
20903
+ */
20904
+ 400: Problem;
20905
+ /**
20906
+ * Forbidden
20907
+ */
20908
+ 403: Problem;
20909
+ };
20910
+ export type ListPaystubLineItemsError = ListPaystubLineItemsErrors[keyof ListPaystubLineItemsErrors];
20911
+ export type ListPaystubLineItemsResponses = {
20912
+ /**
20913
+ * Success
20914
+ */
20915
+ 200: PaystubLineItemsResponseObject;
20916
+ };
20917
+ export type ListPaystubLineItemsResponse = ListPaystubLineItemsResponses[keyof ListPaystubLineItemsResponses];
20918
+ export type CreatePaystubLineItemData = {
20919
+ body?: PaystubLineItemParameters;
20920
+ path?: never;
20921
+ query?: never;
20922
+ url: '/api/v1/paystub_line_items';
20923
+ };
20924
+ export type CreatePaystubLineItemErrors = {
20925
+ /**
20926
+ * Forbidden
20927
+ */
20928
+ 403: Problem;
20929
+ /**
20930
+ * Unprocessable Content
20931
+ */
20932
+ 422: Problem;
20933
+ };
20934
+ export type CreatePaystubLineItemError = CreatePaystubLineItemErrors[keyof CreatePaystubLineItemErrors];
20935
+ export type CreatePaystubLineItemResponses = {
20936
+ /**
20937
+ * Success
20938
+ */
20939
+ 201: PaystubLineItemResponseObject;
20940
+ };
20941
+ export type CreatePaystubLineItemResponse = CreatePaystubLineItemResponses[keyof CreatePaystubLineItemResponses];
20942
+ export type DeletePaystubLineItemData = {
20943
+ body?: never;
20944
+ path: {
20945
+ /**
20946
+ * Paystub Line Item ID
20947
+ */
20948
+ id: string;
20949
+ };
20950
+ query?: never;
20951
+ url: '/api/v1/paystub_line_items/{id}';
20952
+ };
20953
+ export type DeletePaystubLineItemErrors = {
20954
+ /**
20955
+ * Forbidden
20956
+ */
20957
+ 403: Problem;
20958
+ /**
20959
+ * Not Found
20960
+ */
20961
+ 404: Problem;
20962
+ };
20963
+ export type DeletePaystubLineItemError = DeletePaystubLineItemErrors[keyof DeletePaystubLineItemErrors];
20964
+ export type DeletePaystubLineItemResponses = {
20965
+ /**
20966
+ * Success
20967
+ */
20968
+ 200: PaystubLineItemResponseObject;
20969
+ };
20970
+ export type DeletePaystubLineItemResponse = DeletePaystubLineItemResponses[keyof DeletePaystubLineItemResponses];
20971
+ export type GetPaystubLineItemData = {
20972
+ body?: never;
20973
+ path: {
20974
+ /**
20975
+ * Paystub Line Item ID
20976
+ */
20977
+ id: string;
20978
+ };
20979
+ query?: never;
20980
+ url: '/api/v1/paystub_line_items/{id}';
20981
+ };
20982
+ export type GetPaystubLineItemErrors = {
20983
+ /**
20984
+ * Forbidden
20985
+ */
20986
+ 403: Problem;
20987
+ /**
20988
+ * Not Found
20989
+ */
20990
+ 404: Problem;
20991
+ };
20992
+ export type GetPaystubLineItemError = GetPaystubLineItemErrors[keyof GetPaystubLineItemErrors];
20993
+ export type GetPaystubLineItemResponses = {
20994
+ /**
20995
+ * Success
20996
+ */
20997
+ 200: PaystubLineItemResponseObject;
20998
+ };
20999
+ export type GetPaystubLineItemResponse = GetPaystubLineItemResponses[keyof GetPaystubLineItemResponses];
21000
+ export type UpdatePaystubLineItemData = {
21001
+ body?: PaystubLineItemUpdateParameters;
21002
+ path: {
21003
+ /**
21004
+ * Paystub Line Item ID
21005
+ */
21006
+ id: string;
21007
+ };
21008
+ query?: never;
21009
+ url: '/api/v1/paystub_line_items/{id}';
21010
+ };
21011
+ export type UpdatePaystubLineItemErrors = {
21012
+ /**
21013
+ * Forbidden
21014
+ */
21015
+ 403: Problem;
21016
+ /**
21017
+ * Not Found
21018
+ */
21019
+ 404: Problem;
21020
+ /**
21021
+ * Unprocessable Content
21022
+ */
21023
+ 422: Problem;
21024
+ };
21025
+ export type UpdatePaystubLineItemError = UpdatePaystubLineItemErrors[keyof UpdatePaystubLineItemErrors];
21026
+ export type UpdatePaystubLineItemResponses = {
21027
+ /**
21028
+ * Success
21029
+ */
21030
+ 200: PaystubLineItemResponseObject;
21031
+ };
21032
+ export type UpdatePaystubLineItemResponse = UpdatePaystubLineItemResponses[keyof UpdatePaystubLineItemResponses];
21033
+ export type ListPaystubsData = {
21034
+ body?: never;
21035
+ path?: never;
21036
+ query?: {
21037
+ /**
21038
+ * Filter paystubs by payroll run ID
21039
+ */
21040
+ 'filter[payrolls_payroll_run_id]'?: string;
21041
+ /**
21042
+ * Filter paystubs by user ID
21043
+ */
21044
+ 'filter[user_id]'?: string;
21045
+ /**
21046
+ * Filter paystubs by time card ID
21047
+ */
21048
+ 'filter[timekeeping_time_card_id]'?: string;
21049
+ filter?: string;
21050
+ 'filter[unexpected]'?: string;
21051
+ /**
21052
+ * This pagination cursor corresponds to the cursor value found in the response in
21053
+ * `meta.page.next_cursor`.
21054
+ */
21055
+ 'page[cursor]'?: string;
21056
+ /**
21057
+ * Maximum number of records to return per page. Defaults to 20. A value above 100 is capped to 100 rather than rejected; a value that is zero, negative, or not an integer is rejected with a `400`.
21058
+ */
21059
+ 'page[limit]'?: number;
21060
+ page?: string;
21061
+ };
21062
+ url: '/api/v1/paystubs';
21063
+ };
21064
+ export type ListPaystubsErrors = {
21065
+ /**
21066
+ * Bad Request
21067
+ */
21068
+ 400: Problem;
21069
+ /**
21070
+ * Forbidden
21071
+ */
21072
+ 403: Problem;
21073
+ };
21074
+ export type ListPaystubsError = ListPaystubsErrors[keyof ListPaystubsErrors];
21075
+ export type ListPaystubsResponses = {
21076
+ /**
21077
+ * Success
21078
+ */
21079
+ 200: PaystubsResponseObject;
21080
+ };
21081
+ export type ListPaystubsResponse = ListPaystubsResponses[keyof ListPaystubsResponses];
21082
+ export type CreatePaystubData = {
21083
+ body: PaystubParameters;
21084
+ path?: never;
21085
+ query?: never;
21086
+ url: '/api/v1/paystubs';
21087
+ };
21088
+ export type CreatePaystubErrors = {
21089
+ /**
21090
+ * Forbidden
21091
+ */
21092
+ 403: Problem;
21093
+ /**
21094
+ * Unprocessable Entity
21095
+ */
21096
+ 422: Problem;
21097
+ };
21098
+ export type CreatePaystubError = CreatePaystubErrors[keyof CreatePaystubErrors];
21099
+ export type CreatePaystubResponses = {
21100
+ /**
21101
+ * Created
21102
+ */
21103
+ 201: PaystubResponseObject;
21104
+ };
21105
+ export type CreatePaystubResponse = CreatePaystubResponses[keyof CreatePaystubResponses];
21106
+ export type DeletePaystubData = {
21107
+ body?: never;
21108
+ path: {
21109
+ /**
21110
+ * Paystub ID
19848
21111
  */
19849
21112
  id: string;
19850
21113
  };
19851
21114
  query?: never;
19852
- url: '/api/v1/paystub_line_items/{id}';
21115
+ url: '/api/v1/paystubs/{id}';
19853
21116
  };
19854
- export type GetPaystubLineItemErrors = {
21117
+ export type DeletePaystubErrors = {
21118
+ /**
21119
+ * Forbidden
21120
+ */
21121
+ 403: Problem;
21122
+ /**
21123
+ * Not Found
21124
+ */
21125
+ 404: Problem;
21126
+ /**
21127
+ * Unprocessable Content
21128
+ */
21129
+ 422: Problem;
21130
+ };
21131
+ export type DeletePaystubError = DeletePaystubErrors[keyof DeletePaystubErrors];
21132
+ export type DeletePaystubResponses = {
21133
+ /**
21134
+ * Success
21135
+ */
21136
+ 200: PaystubResponseObject;
21137
+ };
21138
+ export type DeletePaystubResponse = DeletePaystubResponses[keyof DeletePaystubResponses];
21139
+ export type GetPaystubData = {
21140
+ body?: never;
21141
+ path: {
21142
+ /**
21143
+ * Paystub ID
21144
+ */
21145
+ id: string;
21146
+ };
21147
+ query?: never;
21148
+ url: '/api/v1/paystubs/{id}';
21149
+ };
21150
+ export type GetPaystubErrors = {
19855
21151
  /**
19856
21152
  * Forbidden
19857
21153
  */
@@ -19861,26 +21157,69 @@ export type GetPaystubLineItemErrors = {
19861
21157
  */
19862
21158
  404: Problem;
19863
21159
  };
19864
- export type GetPaystubLineItemError = GetPaystubLineItemErrors[keyof GetPaystubLineItemErrors];
19865
- export type GetPaystubLineItemResponses = {
21160
+ export type GetPaystubError = GetPaystubErrors[keyof GetPaystubErrors];
21161
+ export type GetPaystubResponses = {
19866
21162
  /**
19867
21163
  * Success
19868
21164
  */
19869
- 200: PaystubLineItemResponseObject;
21165
+ 200: PaystubResponseObject;
19870
21166
  };
19871
- export type GetPaystubLineItemResponse = GetPaystubLineItemResponses[keyof GetPaystubLineItemResponses];
19872
- export type UpdatePaystubLineItemData = {
19873
- body?: PaystubLineItemUpdateParameters;
21167
+ export type GetPaystubResponse = GetPaystubResponses[keyof GetPaystubResponses];
21168
+ export type UpdatePaystubData = {
21169
+ body: PaystubUpdateParameters;
19874
21170
  path: {
19875
21171
  /**
19876
- * Paystub Line Item ID
21172
+ * Paystub ID
19877
21173
  */
19878
21174
  id: string;
19879
21175
  };
19880
21176
  query?: never;
19881
- url: '/api/v1/paystub_line_items/{id}';
21177
+ url: '/api/v1/paystubs/{id}';
19882
21178
  };
19883
- export type UpdatePaystubLineItemErrors = {
21179
+ export type UpdatePaystubErrors = {
21180
+ /**
21181
+ * Forbidden
21182
+ */
21183
+ 403: Problem;
21184
+ /**
21185
+ * Not Found
21186
+ */
21187
+ 404: Problem;
21188
+ /**
21189
+ * Unprocessable Entity
21190
+ */
21191
+ 422: Problem;
21192
+ };
21193
+ export type UpdatePaystubError = UpdatePaystubErrors[keyof UpdatePaystubErrors];
21194
+ export type UpdatePaystubResponses = {
21195
+ /**
21196
+ * Success
21197
+ */
21198
+ 200: PaystubResponseObject;
21199
+ };
21200
+ export type UpdatePaystubResponse = UpdatePaystubResponses[keyof UpdatePaystubResponses];
21201
+ export type UpdateGenesisData = {
21202
+ body: PeopleEmploymentGenesisParameters;
21203
+ headers: {
21204
+ /**
21205
+ * Version validator for the whole employment family, or `*` for its current state.
21206
+ */
21207
+ 'If-Match': string;
21208
+ };
21209
+ path: {
21210
+ /**
21211
+ * The employment stint identity returned as `id`.
21212
+ */
21213
+ employment_id: string;
21214
+ };
21215
+ query?: never;
21216
+ url: '/api/v1/people/employments/{employment_id}/genesis';
21217
+ };
21218
+ export type UpdateGenesisErrors = {
21219
+ /**
21220
+ * Bad Request
21221
+ */
21222
+ 400: Problem;
19884
21223
  /**
19885
21224
  * Forbidden
19886
21225
  */
@@ -19889,51 +21228,139 @@ export type UpdatePaystubLineItemErrors = {
19889
21228
  * Not Found
19890
21229
  */
19891
21230
  404: Problem;
21231
+ /**
21232
+ * Precondition Failed
21233
+ */
21234
+ 412: Problem;
19892
21235
  /**
19893
21236
  * Unprocessable Content
19894
21237
  */
19895
21238
  422: Problem;
21239
+ /**
21240
+ * Precondition Required
21241
+ */
21242
+ 428: Problem;
19896
21243
  };
19897
- export type UpdatePaystubLineItemError = UpdatePaystubLineItemErrors[keyof UpdatePaystubLineItemErrors];
19898
- export type UpdatePaystubLineItemResponses = {
21244
+ export type UpdateGenesisError = UpdateGenesisErrors[keyof UpdateGenesisErrors];
21245
+ export type UpdateGenesisResponses = {
19899
21246
  /**
19900
21247
  * Success
19901
21248
  */
19902
- 200: PaystubLineItemResponseObject;
21249
+ 200: PeopleEmploymentResponseObject;
19903
21250
  };
19904
- export type UpdatePaystubLineItemResponse = UpdatePaystubLineItemResponses[keyof UpdatePaystubLineItemResponses];
19905
- export type ListPaystubsData = {
21251
+ export type UpdateGenesisResponse = UpdateGenesisResponses[keyof UpdateGenesisResponses];
21252
+ export type ListEmploymentHistoryData = {
19906
21253
  body?: never;
19907
- path?: never;
21254
+ path: {
21255
+ employment_id: string;
21256
+ };
19908
21257
  query?: {
21258
+ 'as_of[valid]'?: string;
21259
+ 'as_of[transaction]'?: string;
19909
21260
  /**
19910
- * Filter paystubs by payroll run ID
21261
+ * This pagination cursor corresponds to the cursor value found in the response in
21262
+ * `meta.page.next_cursor`.
19911
21263
  */
19912
- 'filter[payrolls_payroll_run_id]'?: string;
21264
+ 'page[cursor]'?: string;
19913
21265
  /**
19914
- * Filter paystubs by user ID
21266
+ * Maximum number of records to return per page. Defaults to 20. A value above 100 is capped to 100 rather than rejected; a value that is zero, negative, or not an integer is rejected with a `400`.
19915
21267
  */
19916
- 'filter[user_id]'?: string;
21268
+ 'page[limit]'?: number;
21269
+ page?: string;
21270
+ };
21271
+ url: '/api/v1/people/employments/{employment_id}/history';
21272
+ };
21273
+ export type ListEmploymentHistoryErrors = {
21274
+ /**
21275
+ * Bad Request
21276
+ */
21277
+ 400: Problem;
21278
+ /**
21279
+ * Forbidden
21280
+ */
21281
+ 403: Problem;
21282
+ /**
21283
+ * Not Found for an unknown employment
21284
+ */
21285
+ 404: Problem;
21286
+ };
21287
+ export type ListEmploymentHistoryError = ListEmploymentHistoryErrors[keyof ListEmploymentHistoryErrors];
21288
+ export type ListEmploymentHistoryResponses = {
21289
+ /**
21290
+ * Success
21291
+ */
21292
+ 200: {
21293
+ meta: Meta;
21294
+ links: Links;
21295
+ data: Array<PeopleEmploymentHistoryVersionObject>;
21296
+ };
21297
+ };
21298
+ export type ListEmploymentHistoryResponse = ListEmploymentHistoryResponses[keyof ListEmploymentHistoryResponses];
21299
+ export type ListEmploymentsHistoryData = {
21300
+ body?: never;
21301
+ path?: never;
21302
+ query?: {
19917
21303
  /**
19918
- * Filter paystubs by time card ID
21304
+ * Return history for this user ID.
19919
21305
  */
19920
- 'filter[timekeeping_time_card_id]'?: string;
21306
+ 'filter[user_id]'?: string;
21307
+ 'as_of[valid]'?: string;
21308
+ 'as_of[transaction]'?: string;
19921
21309
  filter?: string;
19922
21310
  'filter[unexpected]'?: string;
19923
21311
  /**
19924
- * This pagination cursor corresponds to the cursor value found in the response in
19925
- * `meta.page.next_cursor`.
21312
+ * This pagination cursor corresponds to the cursor value found in the response in
21313
+ * `meta.page.next_cursor`.
21314
+ */
21315
+ 'page[cursor]'?: string;
21316
+ /**
21317
+ * Maximum number of records to return per page. Defaults to 20. A value above 100 is capped to 100 rather than rejected; a value that is zero, negative, or not an integer is rejected with a `400`.
21318
+ */
21319
+ 'page[limit]'?: number;
21320
+ page?: string;
21321
+ };
21322
+ url: '/api/v1/people/employments/history';
21323
+ };
21324
+ export type ListEmploymentsHistoryErrors = {
21325
+ /**
21326
+ * Bad Request
21327
+ */
21328
+ 400: Problem;
21329
+ /**
21330
+ * Forbidden
21331
+ */
21332
+ 403: Problem;
21333
+ };
21334
+ export type ListEmploymentsHistoryError = ListEmploymentsHistoryErrors[keyof ListEmploymentsHistoryErrors];
21335
+ export type ListEmploymentsHistoryResponses = {
21336
+ /**
21337
+ * Success
21338
+ */
21339
+ 200: {
21340
+ meta: Meta;
21341
+ links: Links;
21342
+ data: Array<PeopleEmploymentHistoryVersionObject>;
21343
+ };
21344
+ };
21345
+ export type ListEmploymentsHistoryResponse = ListEmploymentsHistoryResponses[keyof ListEmploymentsHistoryResponses];
21346
+ export type CreateEmploymentScheduledChangeData = {
21347
+ body: PeopleEmploymentScheduledChangeCreateParameters;
21348
+ headers: {
21349
+ /**
21350
+ * Version validator this write is composed against.
19926
21351
  */
19927
- 'page[cursor]'?: string;
21352
+ 'If-Match': string;
21353
+ };
21354
+ path: {
19928
21355
  /**
19929
- * Maximum number of records to return per page. Defaults to 20. A value above 100 is capped to 100 rather than rejected; a value that is zero, negative, or not an integer is rejected with a `400`.
21356
+ * The employment stint identity returned as `id`.
19930
21357
  */
19931
- 'page[limit]'?: number;
19932
- page?: string;
21358
+ employment_id: string;
19933
21359
  };
19934
- url: '/api/v1/paystubs';
21360
+ query?: never;
21361
+ url: '/api/v1/people/employments/{employment_id}/scheduled_changes';
19935
21362
  };
19936
- export type ListPaystubsErrors = {
21363
+ export type CreateEmploymentScheduledChangeErrors = {
19937
21364
  /**
19938
21365
  * Bad Request
19939
21366
  */
@@ -19942,51 +21369,57 @@ export type ListPaystubsErrors = {
19942
21369
  * Forbidden
19943
21370
  */
19944
21371
  403: Problem;
19945
- };
19946
- export type ListPaystubsError = ListPaystubsErrors[keyof ListPaystubsErrors];
19947
- export type ListPaystubsResponses = {
19948
21372
  /**
19949
- * Success
21373
+ * Not Found
19950
21374
  */
19951
- 200: PaystubsResponseObject;
19952
- };
19953
- export type ListPaystubsResponse = ListPaystubsResponses[keyof ListPaystubsResponses];
19954
- export type CreatePaystubData = {
19955
- body: PaystubParameters;
19956
- path?: never;
19957
- query?: never;
19958
- url: '/api/v1/paystubs';
19959
- };
19960
- export type CreatePaystubErrors = {
21375
+ 404: Problem;
19961
21376
  /**
19962
- * Forbidden
21377
+ * Conflict
19963
21378
  */
19964
- 403: Problem;
21379
+ 409: Problem;
19965
21380
  /**
19966
- * Unprocessable Entity
21381
+ * Precondition Failed
21382
+ */
21383
+ 412: Problem;
21384
+ /**
21385
+ * Unprocessable Content
19967
21386
  */
19968
21387
  422: Problem;
21388
+ /**
21389
+ * Precondition Required
21390
+ */
21391
+ 428: Problem;
19969
21392
  };
19970
- export type CreatePaystubError = CreatePaystubErrors[keyof CreatePaystubErrors];
19971
- export type CreatePaystubResponses = {
21393
+ export type CreateEmploymentScheduledChangeError = CreateEmploymentScheduledChangeErrors[keyof CreateEmploymentScheduledChangeErrors];
21394
+ export type CreateEmploymentScheduledChangeResponses = {
19972
21395
  /**
19973
21396
  * Created
19974
21397
  */
19975
- 201: PaystubResponseObject;
21398
+ 201: PeopleEmploymentResponseObject;
19976
21399
  };
19977
- export type CreatePaystubResponse = CreatePaystubResponses[keyof CreatePaystubResponses];
19978
- export type DeletePaystubData = {
21400
+ export type CreateEmploymentScheduledChangeResponse = CreateEmploymentScheduledChangeResponses[keyof CreateEmploymentScheduledChangeResponses];
21401
+ export type DeleteEmploymentScheduledChangeData = {
19979
21402
  body?: never;
21403
+ headers: {
21404
+ /**
21405
+ * Version validator this write is composed against.
21406
+ */
21407
+ 'If-Match': string;
21408
+ };
19980
21409
  path: {
19981
21410
  /**
19982
- * Paystub ID
21411
+ * The employment stint identity returned as `id`.
19983
21412
  */
19984
- id: string;
21413
+ employment_id: string;
21414
+ /**
21415
+ * The existing strictly future boundary, as a company-local date.
21416
+ */
21417
+ effective_date: string;
19985
21418
  };
19986
21419
  query?: never;
19987
- url: '/api/v1/paystubs/{id}';
21420
+ url: '/api/v1/people/employments/{employment_id}/scheduled_changes/{effective_date}';
19988
21421
  };
19989
- export type DeletePaystubErrors = {
21422
+ export type DeleteEmploymentScheduledChangeErrors = {
19990
21423
  /**
19991
21424
  * Forbidden
19992
21425
  */
@@ -19996,30 +21429,48 @@ export type DeletePaystubErrors = {
19996
21429
  */
19997
21430
  404: Problem;
19998
21431
  /**
19999
- * Unprocessable Content
21432
+ * Precondition Failed
20000
21433
  */
20001
- 422: Problem;
21434
+ 412: Problem;
21435
+ /**
21436
+ * Precondition Required
21437
+ */
21438
+ 428: Problem;
20002
21439
  };
20003
- export type DeletePaystubError = DeletePaystubErrors[keyof DeletePaystubErrors];
20004
- export type DeletePaystubResponses = {
21440
+ export type DeleteEmploymentScheduledChangeError = DeleteEmploymentScheduledChangeErrors[keyof DeleteEmploymentScheduledChangeErrors];
21441
+ export type DeleteEmploymentScheduledChangeResponses = {
20005
21442
  /**
20006
- * Success
21443
+ * No Content
20007
21444
  */
20008
- 200: PaystubResponseObject;
21445
+ 204: void;
20009
21446
  };
20010
- export type DeletePaystubResponse = DeletePaystubResponses[keyof DeletePaystubResponses];
20011
- export type GetPaystubData = {
20012
- body?: never;
21447
+ export type DeleteEmploymentScheduledChangeResponse = DeleteEmploymentScheduledChangeResponses[keyof DeleteEmploymentScheduledChangeResponses];
21448
+ export type UpdateEmploymentScheduledChangeData = {
21449
+ body: PeopleEmploymentScheduledChangeUpdateParameters;
21450
+ headers: {
21451
+ /**
21452
+ * Version validator this write is composed against.
21453
+ */
21454
+ 'If-Match': string;
21455
+ };
20013
21456
  path: {
20014
21457
  /**
20015
- * Paystub ID
21458
+ * The employment stint identity returned as `id`.
20016
21459
  */
20017
- id: string;
21460
+ employment_id: string;
21461
+ /**
21462
+ * The existing strictly future boundary, as a company-local date.
21463
+ */
21464
+ effective_date: string;
20018
21465
  };
20019
21466
  query?: never;
20020
- url: '/api/v1/paystubs/{id}';
21467
+ url: '/api/v1/people/employments/{employment_id}/scheduled_changes/{effective_date}';
20021
21468
  };
20022
- export type GetPaystubErrors = {
21469
+ export type UpdateEmploymentScheduledChangeErrors = {
21470
+ /**
21471
+ * Bad Request
21472
+ */
21473
+ 400: Problem;
20023
21474
  /**
20024
21475
  * Forbidden
20025
21476
  */
@@ -20028,27 +21479,45 @@ export type GetPaystubErrors = {
20028
21479
  * Not Found
20029
21480
  */
20030
21481
  404: Problem;
21482
+ /**
21483
+ * Precondition Failed
21484
+ */
21485
+ 412: Problem;
21486
+ /**
21487
+ * Unprocessable Content
21488
+ */
21489
+ 422: Problem;
21490
+ /**
21491
+ * Precondition Required
21492
+ */
21493
+ 428: Problem;
20031
21494
  };
20032
- export type GetPaystubError = GetPaystubErrors[keyof GetPaystubErrors];
20033
- export type GetPaystubResponses = {
21495
+ export type UpdateEmploymentScheduledChangeError = UpdateEmploymentScheduledChangeErrors[keyof UpdateEmploymentScheduledChangeErrors];
21496
+ export type UpdateEmploymentScheduledChangeResponses = {
20034
21497
  /**
20035
21498
  * Success
20036
21499
  */
20037
- 200: PaystubResponseObject;
21500
+ 200: PeopleEmploymentResponseObject;
20038
21501
  };
20039
- export type GetPaystubResponse = GetPaystubResponses[keyof GetPaystubResponses];
20040
- export type UpdatePaystubData = {
20041
- body: PaystubUpdateParameters;
21502
+ export type UpdateEmploymentScheduledChangeResponse = UpdateEmploymentScheduledChangeResponses[keyof UpdateEmploymentScheduledChangeResponses];
21503
+ export type DeleteScheduledTerminationData = {
21504
+ body?: never;
21505
+ headers: {
21506
+ /**
21507
+ * Version validator for the whole employment family, or `*` to write against its current state.
21508
+ */
21509
+ 'If-Match': string;
21510
+ };
20042
21511
  path: {
20043
21512
  /**
20044
- * Paystub ID
21513
+ * The employment stint identity returned as `id`.
20045
21514
  */
20046
- id: string;
21515
+ employment_id: string;
20047
21516
  };
20048
21517
  query?: never;
20049
- url: '/api/v1/paystubs/{id}';
21518
+ url: '/api/v1/people/employments/{employment_id}/scheduled_termination';
20050
21519
  };
20051
- export type UpdatePaystubErrors = {
21520
+ export type DeleteScheduledTerminationErrors = {
20052
21521
  /**
20053
21522
  * Forbidden
20054
21523
  */
@@ -20058,40 +21527,44 @@ export type UpdatePaystubErrors = {
20058
21527
  */
20059
21528
  404: Problem;
20060
21529
  /**
20061
- * Unprocessable Entity
21530
+ * Precondition Failed
21531
+ */
21532
+ 412: Problem;
21533
+ /**
21534
+ * Unprocessable Content
20062
21535
  */
20063
21536
  422: Problem;
21537
+ /**
21538
+ * Precondition Required
21539
+ */
21540
+ 428: Problem;
20064
21541
  };
20065
- export type UpdatePaystubError = UpdatePaystubErrors[keyof UpdatePaystubErrors];
20066
- export type UpdatePaystubResponses = {
21542
+ export type DeleteScheduledTerminationError = DeleteScheduledTerminationErrors[keyof DeleteScheduledTerminationErrors];
21543
+ export type DeleteScheduledTerminationResponses = {
20067
21544
  /**
20068
21545
  * Success
20069
21546
  */
20070
- 200: PaystubResponseObject;
21547
+ 200: PeopleEmploymentResponseObject;
20071
21548
  };
20072
- export type UpdatePaystubResponse = UpdatePaystubResponses[keyof UpdatePaystubResponses];
20073
- export type ListEmploymentHistoryData = {
20074
- body?: never;
20075
- path: {
20076
- employment_id: string;
20077
- };
20078
- query?: {
20079
- 'as_of[valid]'?: string;
20080
- 'as_of[transaction]'?: string;
21549
+ export type DeleteScheduledTerminationResponse = DeleteScheduledTerminationResponses[keyof DeleteScheduledTerminationResponses];
21550
+ export type CreateEmploymentScheduledTerminationData = {
21551
+ body: PeopleEmploymentScheduledTerminationParameters;
21552
+ headers: {
20081
21553
  /**
20082
- * This pagination cursor corresponds to the cursor value found in the response in
20083
- * `meta.page.next_cursor`.
21554
+ * Version validator for the whole employment family, or `*` to write against its current state.
20084
21555
  */
20085
- 'page[cursor]'?: string;
21556
+ 'If-Match': string;
21557
+ };
21558
+ path: {
20086
21559
  /**
20087
- * Maximum number of records to return per page. Defaults to 20. A value above 100 is capped to 100 rather than rejected; a value that is zero, negative, or not an integer is rejected with a `400`.
21560
+ * The employment stint identity returned as `id`.
20088
21561
  */
20089
- 'page[limit]'?: number;
20090
- page?: string;
21562
+ employment_id: string;
20091
21563
  };
20092
- url: '/api/v1/people/employments/{employment_id}/history';
21564
+ query?: never;
21565
+ url: '/api/v1/people/employments/{employment_id}/scheduled_termination';
20093
21566
  };
20094
- export type ListEmploymentHistoryErrors = {
21567
+ export type CreateEmploymentScheduledTerminationErrors = {
20095
21568
  /**
20096
21569
  * Bad Request
20097
21570
  */
@@ -20101,69 +21574,34 @@ export type ListEmploymentHistoryErrors = {
20101
21574
  */
20102
21575
  403: Problem;
20103
21576
  /**
20104
- * Not Found for an unknown employment
21577
+ * Not Found
20105
21578
  */
20106
21579
  404: Problem;
20107
- };
20108
- export type ListEmploymentHistoryError = ListEmploymentHistoryErrors[keyof ListEmploymentHistoryErrors];
20109
- export type ListEmploymentHistoryResponses = {
20110
21580
  /**
20111
- * Success
21581
+ * Conflict
20112
21582
  */
20113
- 200: {
20114
- meta: Meta;
20115
- links: Links;
20116
- data: Array<PeopleEmploymentHistoryVersionObject>;
20117
- };
20118
- };
20119
- export type ListEmploymentHistoryResponse = ListEmploymentHistoryResponses[keyof ListEmploymentHistoryResponses];
20120
- export type ListEmploymentsHistoryData = {
20121
- body?: never;
20122
- path?: never;
20123
- query?: {
20124
- /**
20125
- * Return history for this user ID.
20126
- */
20127
- 'filter[user_id]'?: string;
20128
- 'as_of[valid]'?: string;
20129
- 'as_of[transaction]'?: string;
20130
- filter?: string;
20131
- 'filter[unexpected]'?: string;
20132
- /**
20133
- * This pagination cursor corresponds to the cursor value found in the response in
20134
- * `meta.page.next_cursor`.
20135
- */
20136
- 'page[cursor]'?: string;
20137
- /**
20138
- * Maximum number of records to return per page. Defaults to 20. A value above 100 is capped to 100 rather than rejected; a value that is zero, negative, or not an integer is rejected with a `400`.
20139
- */
20140
- 'page[limit]'?: number;
20141
- page?: string;
20142
- };
20143
- url: '/api/v1/people/employments/history';
20144
- };
20145
- export type ListEmploymentsHistoryErrors = {
21583
+ 409: Problem;
20146
21584
  /**
20147
- * Bad Request
21585
+ * Precondition Failed
20148
21586
  */
20149
- 400: Problem;
21587
+ 412: Problem;
20150
21588
  /**
20151
- * Forbidden
21589
+ * Unprocessable Content
20152
21590
  */
20153
- 403: Problem;
21591
+ 422: Problem;
21592
+ /**
21593
+ * Precondition Required
21594
+ */
21595
+ 428: Problem;
20154
21596
  };
20155
- export type ListEmploymentsHistoryError = ListEmploymentsHistoryErrors[keyof ListEmploymentsHistoryErrors];
20156
- export type ListEmploymentsHistoryResponses = {
21597
+ export type CreateEmploymentScheduledTerminationError = CreateEmploymentScheduledTerminationErrors[keyof CreateEmploymentScheduledTerminationErrors];
21598
+ export type CreateEmploymentScheduledTerminationResponses = {
20157
21599
  /**
20158
- * Success
21600
+ * Created
20159
21601
  */
20160
- 200: {
20161
- meta: Meta;
20162
- links: Links;
20163
- data: Array<PeopleEmploymentHistoryVersionObject>;
20164
- };
21602
+ 201: PeopleEmploymentResponseObject;
20165
21603
  };
20166
- export type ListEmploymentsHistoryResponse = ListEmploymentsHistoryResponses[keyof ListEmploymentsHistoryResponses];
21604
+ export type CreateEmploymentScheduledTerminationResponse = CreateEmploymentScheduledTerminationResponses[keyof CreateEmploymentScheduledTerminationResponses];
20167
21605
  export type ListEmploymentsData = {
20168
21606
  body?: never;
20169
21607
  path?: never;
@@ -20221,6 +21659,38 @@ export type ListEmploymentsResponses = {
20221
21659
  };
20222
21660
  };
20223
21661
  export type ListEmploymentsResponse = ListEmploymentsResponses[keyof ListEmploymentsResponses];
21662
+ export type CreateEmploymentData = {
21663
+ body: PeopleEmploymentCreateParameters;
21664
+ path?: never;
21665
+ query?: never;
21666
+ url: '/api/v1/people/employments';
21667
+ };
21668
+ export type CreateEmploymentErrors = {
21669
+ /**
21670
+ * Bad Request
21671
+ */
21672
+ 400: Problem;
21673
+ /**
21674
+ * Forbidden
21675
+ */
21676
+ 403: Problem;
21677
+ /**
21678
+ * Not Found
21679
+ */
21680
+ 404: Problem;
21681
+ /**
21682
+ * Unprocessable Content
21683
+ */
21684
+ 422: Problem;
21685
+ };
21686
+ export type CreateEmploymentError = CreateEmploymentErrors[keyof CreateEmploymentErrors];
21687
+ export type CreateEmploymentResponses = {
21688
+ /**
21689
+ * Created
21690
+ */
21691
+ 201: PeopleEmploymentResponseObject;
21692
+ };
21693
+ export type CreateEmploymentResponse = CreateEmploymentResponses[keyof CreateEmploymentResponses];
20224
21694
  export type GetEmploymentData = {
20225
21695
  body?: never;
20226
21696
  path: {
@@ -20867,6 +22337,10 @@ export type CreateProjectErrors = {
20867
22337
  * Forbidden
20868
22338
  */
20869
22339
  403: Problem;
22340
+ /**
22341
+ * Not Found
22342
+ */
22343
+ 404: Problem;
20870
22344
  /**
20871
22345
  * Unprocessable Content
20872
22346
  */