@dsptch-work/api-client 0.8.0 → 0.10.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.
- package/CHANGELOG.md +108 -1
- package/dist/gen/index.d.ts +1 -1
- package/dist/gen/sdk.gen.d.ts +103 -14
- package/dist/gen/sdk.gen.js +125 -30
- package/dist/gen/types.gen.d.ts +680 -459
- package/dist/gen/zod.gen.d.ts +2462 -2275
- package/dist/gen/zod.gen.js +495 -312
- package/package.json +1 -1
package/dist/gen/types.gen.d.ts
CHANGED
|
@@ -66,6 +66,12 @@ export type Problem = {
|
|
|
66
66
|
*
|
|
67
67
|
* A signed token in the request fails signature verification. Re-obtain the token from the endpoint that issued it.
|
|
68
68
|
*
|
|
69
|
+
* ### malformed_body
|
|
70
|
+
*
|
|
71
|
+
* **Malformed Request Body**
|
|
72
|
+
*
|
|
73
|
+
* The request body could not be parsed in the declared content type — most commonly a body that is not valid JSON. Send a well-formed body matching the `Content-Type` header.
|
|
74
|
+
*
|
|
69
75
|
* ### non_range_filter_value
|
|
70
76
|
*
|
|
71
77
|
* **Range Filter Needs Bounds**
|
|
@@ -94,7 +100,7 @@ export type Problem = {
|
|
|
94
100
|
*
|
|
95
101
|
* **Parameter Must Be An Object**
|
|
96
102
|
*
|
|
97
|
-
*
|
|
103
|
+
* Something that must be an object arrived as something else. Either a container query parameter — `filter`, `page`, or `as_of` — arrived as a scalar, array, or blank value, in which case use the object syntax, for example `filter[key]=value`; or the request body of a write that documents this failure parsed to `null`, an array, or a bare scalar, in which case send a JSON object. An absent or empty body is not this failure.
|
|
98
104
|
*
|
|
99
105
|
* ### unknown_axis
|
|
100
106
|
*
|
|
@@ -104,9 +110,9 @@ export type Problem = {
|
|
|
104
110
|
*
|
|
105
111
|
* ### unknown_key
|
|
106
112
|
*
|
|
107
|
-
* **Unknown
|
|
113
|
+
* **Unknown Key**
|
|
108
114
|
*
|
|
109
|
-
* The query string carries a top-level key outside the declared containers — typically a misspelled container. Remove or correct
|
|
115
|
+
* The query string carries a top-level key outside the declared containers, or the request body carries a key the operation's contract does not declare — typically a misspelled container or field. Remove or correct the keys the detail names; unknown keys are never silently ignored.
|
|
110
116
|
*
|
|
111
117
|
* ### unsupported_axis
|
|
112
118
|
*
|
|
@@ -216,6 +222,12 @@ export type Problem = {
|
|
|
216
222
|
*
|
|
217
223
|
* A deletion is refused by the record's guards — dependent records restrict removal. The message carries the specifics; remove or reassign the dependents first.
|
|
218
224
|
*
|
|
225
|
+
* ### interval_too_wide
|
|
226
|
+
*
|
|
227
|
+
* **Interval Too Wide**
|
|
228
|
+
*
|
|
229
|
+
* A change feed was asked for a span of event time wider than one request may cover. Split it into consecutive windows no wider than the maximum stated in the feed's operation and read them in order; their pages concatenate without gaps. Both bounds are inclusive, so an event stamped exactly on a shared bound appears in both pages — deduplicate as usual.
|
|
230
|
+
*
|
|
219
231
|
* ### invalid_date
|
|
220
232
|
*
|
|
221
233
|
* **Unparseable Date Value**
|
|
@@ -226,7 +238,7 @@ export type Problem = {
|
|
|
226
238
|
*
|
|
227
239
|
* **Invalid Filter Value**
|
|
228
240
|
*
|
|
229
|
-
* A declared filter key carries a value outside its accepted set — a non-boolean on a boolean key,
|
|
241
|
+
* A declared filter key carries a value outside its accepted set — a non-boolean on a boolean key, a token outside an enum key's vocabulary, or a range whose upper bound precedes its lower bound. Send an accepted value.
|
|
230
242
|
*
|
|
231
243
|
* ### invalid_iso8601_duration
|
|
232
244
|
*
|
|
@@ -294,12 +306,6 @@ export type Problem = {
|
|
|
294
306
|
*
|
|
295
307
|
* The apprentice's wage schedule does not belong to the program in the URL. Use a schedule from that program.
|
|
296
308
|
*
|
|
297
|
-
* ### watermark_outside_retention
|
|
298
|
-
*
|
|
299
|
-
* **Watermark Outside Retention Window**
|
|
300
|
-
*
|
|
301
|
-
* A change feed was polled from a watermark older than the window it covers, so no page it could return would be complete. Resync instead: re-crawl the live index, diff it against your replica, and resume polling from the `meta.complete_through` of the first page you then read.
|
|
302
|
-
*
|
|
303
309
|
* ## 428
|
|
304
310
|
*
|
|
305
311
|
* ### precondition_required
|
|
@@ -333,7 +339,7 @@ export type Problem = {
|
|
|
333
339
|
* Another write to the same resource held it for longer than this request was willing to wait, so nothing was applied. The request itself is fine — resend it unchanged after the `Retry-After` window.
|
|
334
340
|
*
|
|
335
341
|
*/
|
|
336
|
-
export type ProblemTypeCatalog = 'blank_axis' | 'invalid_cursor' | 'invalid_filter_key' | 'invalid_limit' | 'invalid_signature' | 'non_range_filter_value' | 'non_scalar_axis' | 'non_scalar_filter_value' | 'parameter_missing' | 'parameter_not_object' | 'unknown_axis' | 'unknown_key' | 'unsupported_axis' | 'valid_axis_on_timeline' | 'unauthorized' | 'company_scoped_key_required' | 'forbidden' | 'insufficient_api_key_scope' | 'not_found' | 'already_terminated' | 'recorded_since_termination' | 'span_beyond_timeline_end' | 'version_overlap' | 'precondition_failed' | 'attachment_not_image' | 'company_not_employer' | 'confirm_apprenticeship_conflict' | 'destroy_restricted' | 'invalid_date' | 'invalid_filter_value' | 'invalid_iso8601_duration' | 'invalid_placement_move' | 'invalid_signed_id' | 'non_numeric_cents' | 'nothing_to_cancel' | 'pagination_failed' | 'subtype_foreign_keys' | 'synced_determination' | 'user_not_company_member' | 'validation_failed' | 'wage_schedule_outside_program' | '
|
|
342
|
+
export type ProblemTypeCatalog = 'blank_axis' | 'invalid_cursor' | 'invalid_filter_key' | 'invalid_limit' | 'invalid_signature' | 'malformed_body' | 'non_range_filter_value' | 'non_scalar_axis' | 'non_scalar_filter_value' | 'parameter_missing' | 'parameter_not_object' | 'unknown_axis' | 'unknown_key' | 'unsupported_axis' | 'valid_axis_on_timeline' | 'unauthorized' | 'company_scoped_key_required' | 'forbidden' | 'insufficient_api_key_scope' | 'not_found' | 'already_terminated' | 'recorded_since_termination' | 'span_beyond_timeline_end' | 'version_overlap' | 'precondition_failed' | 'attachment_not_image' | 'company_not_employer' | 'confirm_apprenticeship_conflict' | 'destroy_restricted' | 'interval_too_wide' | 'invalid_date' | 'invalid_filter_value' | 'invalid_iso8601_duration' | 'invalid_placement_move' | 'invalid_signed_id' | 'non_numeric_cents' | 'nothing_to_cancel' | 'pagination_failed' | 'subtype_foreign_keys' | 'synced_determination' | 'user_not_company_member' | 'validation_failed' | 'wage_schedule_outside_program' | 'precondition_required' | 'too_many_requests' | 'internal_error' | 'write_contended';
|
|
337
343
|
export type ApiKeyScopeResponseObject = {
|
|
338
344
|
resource: string;
|
|
339
345
|
action: 'read' | 'create' | 'update' | 'delete';
|
|
@@ -468,7 +474,7 @@ export type ApprenticeshipProgramResponseObject = {
|
|
|
468
474
|
/**
|
|
469
475
|
* Agency that registered the program: federal (DOL Office of Apprenticeship) or regional (a recognized state apprenticeship agency); null when not recorded.
|
|
470
476
|
*/
|
|
471
|
-
registration_agency_type: 'federal' | 'regional';
|
|
477
|
+
registration_agency_type: 'federal' | 'regional' | null;
|
|
472
478
|
/**
|
|
473
479
|
* When the record was created (ISO 8601).
|
|
474
480
|
*/
|
|
@@ -709,7 +715,7 @@ export type ApprenticeshipApprenticeResponseObject = {
|
|
|
709
715
|
/**
|
|
710
716
|
* Result of the last DOL status-verification attempt: one of pending, in_progress, failed, or success; null when never attempted.
|
|
711
717
|
*/
|
|
712
|
-
status_verification_result: 'pending' | 'in_progress' | 'failed' | 'success';
|
|
718
|
+
status_verification_result: 'pending' | 'in_progress' | 'failed' | 'success' | null;
|
|
713
719
|
/**
|
|
714
720
|
* Date the apprentice is expected to begin the apprenticeship.
|
|
715
721
|
*/
|
|
@@ -799,7 +805,7 @@ export type ApprenticeshipProgramParameters = {
|
|
|
799
805
|
/**
|
|
800
806
|
* Agency that registered the program: federal or regional; optional, null to clear.
|
|
801
807
|
*/
|
|
802
|
-
registration_agency_type?: 'federal' | 'regional';
|
|
808
|
+
registration_agency_type?: 'federal' | 'regional' | null;
|
|
803
809
|
};
|
|
804
810
|
/**
|
|
805
811
|
* Create or update an occupation (trade) within a sponsored program; the program is taken from the URL path.
|
|
@@ -967,7 +973,7 @@ export type ApprenticeshipWageScheduleParameters = {
|
|
|
967
973
|
*/
|
|
968
974
|
export type TimecodeResponseObject = {
|
|
969
975
|
/**
|
|
970
|
-
*
|
|
976
|
+
* Version-stable identifier — the identity every version of the timecode shares, never a per-version row id (UUID string).
|
|
971
977
|
*/
|
|
972
978
|
id: string;
|
|
973
979
|
/**
|
|
@@ -1031,13 +1037,13 @@ export type TimecodeResponseObject = {
|
|
|
1031
1037
|
*/
|
|
1032
1038
|
restricted_to: 'none' | 'job' | 'non_job' | 'job_with_timecode';
|
|
1033
1039
|
/**
|
|
1034
|
-
* Id of the company that owns this timecode as a company-wide default
|
|
1040
|
+
* Id of the company that owns this timecode as a company-wide default. Always your company — a timecode is either company-default or job-scoped, and this API only exposes the company-default ones.
|
|
1035
1041
|
*/
|
|
1036
|
-
default_for_company_id: string
|
|
1042
|
+
default_for_company_id: string;
|
|
1037
1043
|
/**
|
|
1038
|
-
* ISO8601 timestamp at which this version's validity window begins (bitemporal valid-time start).
|
|
1044
|
+
* ISO8601 timestamp at which this version's validity window begins (bitemporal valid-time start); never null for this resource — a lower bound is always recorded.
|
|
1039
1045
|
*/
|
|
1040
|
-
valid_from: string;
|
|
1046
|
+
valid_from: string | null;
|
|
1041
1047
|
/**
|
|
1042
1048
|
* ISO8601 timestamp at which this version stops being valid (bitemporal valid-time end); null until the timecode is terminated.
|
|
1043
1049
|
*/
|
|
@@ -1059,8 +1065,39 @@ export type TimecodeResponseObject = {
|
|
|
1059
1065
|
*/
|
|
1060
1066
|
updated_at: string;
|
|
1061
1067
|
};
|
|
1068
|
+
export type TimecodeHistoryCorrectionObject = {
|
|
1069
|
+
/**
|
|
1070
|
+
* 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.
|
|
1071
|
+
*/
|
|
1072
|
+
timekeeping_timecode_id: string;
|
|
1073
|
+
name: string;
|
|
1074
|
+
description: string | null;
|
|
1075
|
+
description_is_required: boolean;
|
|
1076
|
+
billable: boolean;
|
|
1077
|
+
overtime_eligible: boolean;
|
|
1078
|
+
unpaid: boolean;
|
|
1079
|
+
holiday: boolean;
|
|
1080
|
+
pto: boolean;
|
|
1081
|
+
safety: boolean;
|
|
1082
|
+
lunch_shortcut: boolean;
|
|
1083
|
+
break_shortcut: boolean;
|
|
1084
|
+
pwa: boolean;
|
|
1085
|
+
rest_and_recovery: boolean;
|
|
1086
|
+
incentive_pay_eligible: boolean;
|
|
1087
|
+
restricted_to: 'none' | 'job' | 'non_job' | 'job_with_timecode';
|
|
1088
|
+
default_for_company_id: string;
|
|
1089
|
+
valid_from: string | null;
|
|
1090
|
+
valid_to: string | null;
|
|
1091
|
+
transaction_from: string;
|
|
1092
|
+
transaction_to: string | null;
|
|
1093
|
+
created_at: string;
|
|
1094
|
+
updated_at: string;
|
|
1095
|
+
};
|
|
1062
1096
|
export type TimecodeHistoryVersionObject = {
|
|
1063
|
-
|
|
1097
|
+
/**
|
|
1098
|
+
* 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.
|
|
1099
|
+
*/
|
|
1100
|
+
timekeeping_timecode_id: string;
|
|
1064
1101
|
name: string;
|
|
1065
1102
|
description: string | null;
|
|
1066
1103
|
description_is_required: boolean;
|
|
@@ -1076,15 +1113,15 @@ export type TimecodeHistoryVersionObject = {
|
|
|
1076
1113
|
rest_and_recovery: boolean;
|
|
1077
1114
|
incentive_pay_eligible: boolean;
|
|
1078
1115
|
restricted_to: 'none' | 'job' | 'non_job' | 'job_with_timecode';
|
|
1079
|
-
default_for_company_id: string
|
|
1080
|
-
valid_from: string;
|
|
1116
|
+
default_for_company_id: string;
|
|
1117
|
+
valid_from: string | null;
|
|
1081
1118
|
valid_to: string | null;
|
|
1082
1119
|
transaction_from: string;
|
|
1083
1120
|
transaction_to: string | null;
|
|
1084
1121
|
created_at: string;
|
|
1085
1122
|
updated_at: string;
|
|
1086
1123
|
version_status: 'scheduled' | 'current' | 'historical';
|
|
1087
|
-
corrections: Array<
|
|
1124
|
+
corrections: Array<TimecodeHistoryCorrectionObject>;
|
|
1088
1125
|
};
|
|
1089
1126
|
/**
|
|
1090
1127
|
* Request body for creating or updating a timecode; only `name` is required. On create, omitted fields take their model/DB defaults (noted per field). On update the request applies a bitemporal correction, so omitted fields keep the current version's values rather than reverting to defaults.
|
|
@@ -1875,9 +1912,9 @@ export type HolidayResponseObject = {
|
|
|
1875
1912
|
*/
|
|
1876
1913
|
id: string;
|
|
1877
1914
|
/**
|
|
1878
|
-
*
|
|
1915
|
+
* ID of the pay schedule (PayPeriodConfig) this holiday belongs to, stable across all of its versions.
|
|
1879
1916
|
*/
|
|
1880
|
-
|
|
1917
|
+
timekeeping_pay_period_config_id: string;
|
|
1881
1918
|
/**
|
|
1882
1919
|
* Calendar date (YYYY-MM-DD) the holiday falls on; for a fixed holiday it is set directly, for a floating holiday it is computed from month/week/wday/year.
|
|
1883
1920
|
*/
|
|
@@ -1944,13 +1981,13 @@ export type AttestationConfigResponseObject = {
|
|
|
1944
1981
|
*/
|
|
1945
1982
|
id: string;
|
|
1946
1983
|
/**
|
|
1947
|
-
*
|
|
1984
|
+
* ID of the pay schedule (PayPeriodConfig) this attestation config belongs to, stable across all of its versions.
|
|
1948
1985
|
*/
|
|
1949
|
-
|
|
1986
|
+
timekeeping_pay_period_config_id: string;
|
|
1950
1987
|
/**
|
|
1951
1988
|
* The attestation question presented to the worker when a shift ends.
|
|
1952
1989
|
*/
|
|
1953
|
-
content: string
|
|
1990
|
+
content: string;
|
|
1954
1991
|
/**
|
|
1955
1992
|
* The answer expected for a compliant shift (true or false).
|
|
1956
1993
|
*/
|
|
@@ -1990,13 +2027,13 @@ export type AttestationConfigParameters = {
|
|
|
1990
2027
|
us_state_id?: string | null;
|
|
1991
2028
|
};
|
|
1992
2029
|
/**
|
|
1993
|
-
* A pay schedule (PayPeriodConfig) — the top-level timekeeping unit that sets a company's payroll cadence and tracking modes and generates its stream of pay periods. Read-only; only the currently-valid version is returned, keyed by its stable
|
|
2030
|
+
* A pay schedule (PayPeriodConfig) — the top-level timekeeping unit that sets a company's payroll cadence and tracking modes and generates its stream of pay periods. Read-only; only the currently-valid version is returned, keyed by its stable id.
|
|
1994
2031
|
*/
|
|
1995
2032
|
export type PayPeriodConfigResponseObject = {
|
|
1996
2033
|
/**
|
|
1997
2034
|
* Stable identifier of the pay schedule across all of its versions; other resources reference this.
|
|
1998
2035
|
*/
|
|
1999
|
-
|
|
2036
|
+
id: string;
|
|
2000
2037
|
/**
|
|
2001
2038
|
* ID of the company that owns this record.
|
|
2002
2039
|
*/
|
|
@@ -2028,7 +2065,7 @@ export type PayPeriodConfigResponseObject = {
|
|
|
2028
2065
|
/**
|
|
2029
2066
|
* Granularity at which payroll actuals are collected: none (not collected), base (from paystub line items), or aggregate (pre-summed totals). Null when unset.
|
|
2030
2067
|
*/
|
|
2031
|
-
payroll_mode: 'none' | 'base' | 'aggregate';
|
|
2068
|
+
payroll_mode: 'none' | 'base' | 'aggregate' | null;
|
|
2032
2069
|
/**
|
|
2033
2070
|
* Granularity at which time is tracked: none, base (individual time entries, auto-aggregated), or aggregate (day-level totals only, no entries).
|
|
2034
2071
|
*/
|
|
@@ -2036,7 +2073,7 @@ export type PayPeriodConfigResponseObject = {
|
|
|
2036
2073
|
/**
|
|
2037
2074
|
* External payroll provider this schedule integrates with: one of rippling, quickbooks_online, paychex, or gusto. Null when none.
|
|
2038
2075
|
*/
|
|
2039
|
-
payroll_system: 'rippling' | 'quickbooks_online' | 'paychex' | 'gusto';
|
|
2076
|
+
payroll_system: 'rippling' | 'quickbooks_online' | 'paychex' | 'gusto' | null;
|
|
2040
2077
|
/**
|
|
2041
2078
|
* Whether paystub line-item actuals are imported from the payroll system. Null when unset.
|
|
2042
2079
|
*/
|
|
@@ -2054,9 +2091,9 @@ export type PayPeriodConfigResponseObject = {
|
|
|
2054
2091
|
*/
|
|
2055
2092
|
demo: boolean | null;
|
|
2056
2093
|
/**
|
|
2057
|
-
* Start of this schedule version's validity window (ISO 8601).
|
|
2094
|
+
* Start of this schedule version's validity window (ISO 8601); null when the version has no recorded start.
|
|
2058
2095
|
*/
|
|
2059
|
-
valid_from: string;
|
|
2096
|
+
valid_from: string | null;
|
|
2060
2097
|
/**
|
|
2061
2098
|
* End of this schedule version's validity window (ISO 8601); null while the version is open-ended.
|
|
2062
2099
|
*/
|
|
@@ -2066,8 +2103,34 @@ export type PayPeriodConfigResponseObject = {
|
|
|
2066
2103
|
*/
|
|
2067
2104
|
created_at: string;
|
|
2068
2105
|
};
|
|
2106
|
+
export type PayPeriodConfigHistoryCorrectionObject = {
|
|
2107
|
+
/**
|
|
2108
|
+
* 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.
|
|
2109
|
+
*/
|
|
2110
|
+
timekeeping_pay_period_config_id: string;
|
|
2111
|
+
company_id: string;
|
|
2112
|
+
name: string;
|
|
2113
|
+
frequency: 'weekly' | 'biweekly';
|
|
2114
|
+
start_day_of_week: number;
|
|
2115
|
+
tz_name: string;
|
|
2116
|
+
currency: string;
|
|
2117
|
+
status: 'synced' | 'pending' | 'failed';
|
|
2118
|
+
payroll_mode: 'none' | 'base' | 'aggregate' | null;
|
|
2119
|
+
time_mode: 'none' | 'base' | 'aggregate';
|
|
2120
|
+
payroll_system: 'rippling' | 'quickbooks_online' | 'paychex' | 'gusto' | null;
|
|
2121
|
+
actuals_enabled: boolean | null;
|
|
2122
|
+
requires_external_map_contributor: boolean;
|
|
2123
|
+
paid_after_holiday: boolean;
|
|
2124
|
+
demo: boolean | null;
|
|
2125
|
+
valid_from: string | null;
|
|
2126
|
+
valid_to: string | null;
|
|
2127
|
+
created_at: string;
|
|
2128
|
+
};
|
|
2069
2129
|
export type PayPeriodConfigHistoryVersionObject = {
|
|
2070
|
-
|
|
2130
|
+
/**
|
|
2131
|
+
* 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.
|
|
2132
|
+
*/
|
|
2133
|
+
timekeeping_pay_period_config_id: string;
|
|
2071
2134
|
company_id: string;
|
|
2072
2135
|
name: string;
|
|
2073
2136
|
frequency: 'weekly' | 'biweekly';
|
|
@@ -2075,18 +2138,18 @@ export type PayPeriodConfigHistoryVersionObject = {
|
|
|
2075
2138
|
tz_name: string;
|
|
2076
2139
|
currency: string;
|
|
2077
2140
|
status: 'synced' | 'pending' | 'failed';
|
|
2078
|
-
payroll_mode: 'none' | 'base' | 'aggregate';
|
|
2141
|
+
payroll_mode: 'none' | 'base' | 'aggregate' | null;
|
|
2079
2142
|
time_mode: 'none' | 'base' | 'aggregate';
|
|
2080
|
-
payroll_system: 'rippling' | 'quickbooks_online' | 'paychex' | 'gusto';
|
|
2143
|
+
payroll_system: 'rippling' | 'quickbooks_online' | 'paychex' | 'gusto' | null;
|
|
2081
2144
|
actuals_enabled: boolean | null;
|
|
2082
2145
|
requires_external_map_contributor: boolean;
|
|
2083
2146
|
paid_after_holiday: boolean;
|
|
2084
2147
|
demo: boolean | null;
|
|
2085
|
-
valid_from: string;
|
|
2148
|
+
valid_from: string | null;
|
|
2086
2149
|
valid_to: string | null;
|
|
2087
2150
|
created_at: string;
|
|
2088
2151
|
version_status: 'scheduled' | 'current' | 'historical';
|
|
2089
|
-
corrections: Array<
|
|
2152
|
+
corrections: Array<PayPeriodConfigHistoryCorrectionObject>;
|
|
2090
2153
|
};
|
|
2091
2154
|
/**
|
|
2092
2155
|
* Create or update a holiday on a pay schedule. name, holiday_type, and month are required; mday is required for fixed holidays and wday + week for floating holidays (enforced by model validation).
|
|
@@ -2184,7 +2247,7 @@ export type PwaCompanyUserDetailsResponseObject = {
|
|
|
2184
2247
|
/**
|
|
2185
2248
|
* Worker sex for demographic reporting: one of female, male, non_binary, or not_specified; null when unset.
|
|
2186
2249
|
*/
|
|
2187
|
-
sex: 'female' | 'male' | 'non_binary' | 'not_specified';
|
|
2250
|
+
sex: 'female' | 'male' | 'non_binary' | 'not_specified' | null;
|
|
2188
2251
|
/**
|
|
2189
2252
|
* Local business license number, when a jurisdiction requires it on certified payroll; null when unset.
|
|
2190
2253
|
*/
|
|
@@ -2204,11 +2267,11 @@ export type PwaCompanyUserDetailsResponseObject = {
|
|
|
2204
2267
|
/**
|
|
2205
2268
|
* Veteran status per US Census definitions: one of protected_veteran, not_protected_veteran, reserves, guard, or not_specified; null when unset.
|
|
2206
2269
|
*/
|
|
2207
|
-
veteran_status: 'protected_veteran' | 'not_protected_veteran' | 'reserves' | 'guard' | 'not_specified';
|
|
2270
|
+
veteran_status: 'protected_veteran' | 'not_protected_veteran' | 'reserves' | 'guard' | 'not_specified' | null;
|
|
2208
2271
|
/**
|
|
2209
2272
|
* Whether the worker is of Hispanic origin per US Census definitions: one of yes, no, or not_specified; null when unset.
|
|
2210
2273
|
*/
|
|
2211
|
-
hispanic_origin: 'yes' | 'no' | 'not_specified';
|
|
2274
|
+
hispanic_origin: 'yes' | 'no' | 'not_specified' | null;
|
|
2212
2275
|
/**
|
|
2213
2276
|
* Number of payroll withholding exemptions reported on California DIR certified payroll (eCPR), 0 to 99; null when unset.
|
|
2214
2277
|
*/
|
|
@@ -2220,11 +2283,11 @@ export type PwaCompanyUserDetailsResponseObject = {
|
|
|
2220
2283
|
/**
|
|
2221
2284
|
* Illinois DOL race classification for Illinois prevailing-wage reporting, as a single code (e.g. white, black, hispanic_or_latino); null when unset. See the schema enum for the full set.
|
|
2222
2285
|
*/
|
|
2223
|
-
il_dol_race: 'white' | 'black' | 'hispanic_or_latino' | 'american_indian_or_alaska_native' | 'chinese' | 'filipino' | 'asian_india' | 'vietnamese' | 'korean' | 'japanese' | 'native_hawaiian' | 'samoan' | 'chamorro' | 'other_asian' | 'other_pacific_islander' | 'other';
|
|
2286
|
+
il_dol_race: 'white' | 'black' | 'hispanic_or_latino' | 'american_indian_or_alaska_native' | 'chinese' | 'filipino' | 'asian_india' | 'vietnamese' | 'korean' | 'japanese' | 'native_hawaiian' | 'samoan' | 'chamorro' | 'other_asian' | 'other_pacific_islander' | 'other' | null;
|
|
2224
2287
|
/**
|
|
2225
2288
|
* Illinois SHINES employment type: one of part_time, full_time, seasonal_temporary, or independent_contract; null when unset.
|
|
2226
2289
|
*/
|
|
2227
|
-
il_shines_employment_type: 'part_time' | 'full_time' | 'seasonal_temporary' | 'independent_contract';
|
|
2290
|
+
il_shines_employment_type: 'part_time' | 'full_time' | 'seasonal_temporary' | 'independent_contract' | null;
|
|
2228
2291
|
/**
|
|
2229
2292
|
* Illinois SHINES Equity Eligible Person (EEP) qualifiers for the worker, as an array of codes (e.g. eep_program_completed, foster_care, formerly_incarcerated); null when unset. See the schema enum for the full set.
|
|
2230
2293
|
*/
|
|
@@ -2236,7 +2299,7 @@ export type PwaCompanyUserDetailsResponseObject = {
|
|
|
2236
2299
|
/**
|
|
2237
2300
|
* Oregon BOLI workweek schedule: five_eight (five eight-hour days) or four_ten (four ten-hour days); null when unset.
|
|
2238
2301
|
*/
|
|
2239
|
-
or_boli_schedule_type: 'five_eight' | 'four_ten';
|
|
2302
|
+
or_boli_schedule_type: 'five_eight' | 'four_ten' | null;
|
|
2240
2303
|
/**
|
|
2241
2304
|
* Oregon BOLI race classification, as an array of codes (e.g. white, asian, hispanic_or_latino, black_or_african_american); null when unset. See the schema enum for the full set.
|
|
2242
2305
|
*/
|
|
@@ -2281,7 +2344,7 @@ export type PwaCompanyUserDetailsParameters = {
|
|
|
2281
2344
|
/**
|
|
2282
2345
|
* Worker sex for demographic reporting: one of female, male, non_binary, or not_specified.
|
|
2283
2346
|
*/
|
|
2284
|
-
sex?: 'female' | 'male' | 'non_binary' | 'not_specified';
|
|
2347
|
+
sex?: 'female' | 'male' | 'non_binary' | 'not_specified' | null;
|
|
2285
2348
|
/**
|
|
2286
2349
|
* Local business license number, when a jurisdiction requires it on certified payroll.
|
|
2287
2350
|
*/
|
|
@@ -2301,11 +2364,11 @@ export type PwaCompanyUserDetailsParameters = {
|
|
|
2301
2364
|
/**
|
|
2302
2365
|
* Veteran status per US Census definitions: one of protected_veteran, not_protected_veteran, reserves, guard, or not_specified.
|
|
2303
2366
|
*/
|
|
2304
|
-
veteran_status?: 'protected_veteran' | 'not_protected_veteran' | 'reserves' | 'guard' | 'not_specified';
|
|
2367
|
+
veteran_status?: 'protected_veteran' | 'not_protected_veteran' | 'reserves' | 'guard' | 'not_specified' | null;
|
|
2305
2368
|
/**
|
|
2306
2369
|
* Whether the worker is of Hispanic origin per US Census definitions: one of yes, no, or not_specified.
|
|
2307
2370
|
*/
|
|
2308
|
-
hispanic_origin?: 'yes' | 'no' | 'not_specified';
|
|
2371
|
+
hispanic_origin?: 'yes' | 'no' | 'not_specified' | null;
|
|
2309
2372
|
/**
|
|
2310
2373
|
* Number of payroll withholding exemptions reported on California DIR certified payroll (eCPR), 0 to 99.
|
|
2311
2374
|
*/
|
|
@@ -2317,11 +2380,11 @@ export type PwaCompanyUserDetailsParameters = {
|
|
|
2317
2380
|
/**
|
|
2318
2381
|
* Illinois DOL race classification for Illinois prevailing-wage reporting, as a single code (e.g. white, black, hispanic_or_latino). See the schema enum for the full set.
|
|
2319
2382
|
*/
|
|
2320
|
-
il_dol_race?: 'white' | 'black' | 'hispanic_or_latino' | 'american_indian_or_alaska_native' | 'chinese' | 'filipino' | 'asian_india' | 'vietnamese' | 'korean' | 'japanese' | 'native_hawaiian' | 'samoan' | 'chamorro' | 'other_asian' | 'other_pacific_islander' | 'other';
|
|
2383
|
+
il_dol_race?: 'white' | 'black' | 'hispanic_or_latino' | 'american_indian_or_alaska_native' | 'chinese' | 'filipino' | 'asian_india' | 'vietnamese' | 'korean' | 'japanese' | 'native_hawaiian' | 'samoan' | 'chamorro' | 'other_asian' | 'other_pacific_islander' | 'other' | null;
|
|
2321
2384
|
/**
|
|
2322
2385
|
* Illinois SHINES employment type: one of part_time, full_time, seasonal_temporary, or independent_contract.
|
|
2323
2386
|
*/
|
|
2324
|
-
il_shines_employment_type?: 'part_time' | 'full_time' | 'seasonal_temporary' | 'independent_contract';
|
|
2387
|
+
il_shines_employment_type?: 'part_time' | 'full_time' | 'seasonal_temporary' | 'independent_contract' | null;
|
|
2325
2388
|
/**
|
|
2326
2389
|
* Illinois SHINES Equity Eligible Person (EEP) qualifiers for the worker, as an array of codes (e.g. eep_program_completed, foster_care, formerly_incarcerated). See the schema enum for the full set.
|
|
2327
2390
|
*/
|
|
@@ -2333,7 +2396,7 @@ export type PwaCompanyUserDetailsParameters = {
|
|
|
2333
2396
|
/**
|
|
2334
2397
|
* Oregon BOLI workweek schedule: five_eight (five eight-hour days) or four_ten (four ten-hour days).
|
|
2335
2398
|
*/
|
|
2336
|
-
or_boli_schedule_type?: 'five_eight' | 'four_ten';
|
|
2399
|
+
or_boli_schedule_type?: 'five_eight' | 'four_ten' | null;
|
|
2337
2400
|
/**
|
|
2338
2401
|
* Oregon BOLI race classification, as an array of codes (e.g. white, asian, hispanic_or_latino, black_or_african_american).
|
|
2339
2402
|
*/
|
|
@@ -2475,52 +2538,7 @@ export type JobResponseObject = {
|
|
|
2475
2538
|
*/
|
|
2476
2539
|
project_id: string | null;
|
|
2477
2540
|
/**
|
|
2478
|
-
*
|
|
2479
|
-
*
|
|
2480
|
-
* @deprecated
|
|
2481
|
-
*/
|
|
2482
|
-
created_by_company: {
|
|
2483
|
-
/**
|
|
2484
|
-
* ID of the creating company.
|
|
2485
|
-
*/
|
|
2486
|
-
id?: string;
|
|
2487
|
-
/**
|
|
2488
|
-
* Name of the creating company.
|
|
2489
|
-
*/
|
|
2490
|
-
name?: string;
|
|
2491
|
-
};
|
|
2492
|
-
/**
|
|
2493
|
-
* Deprecated. The requesting company as a minimal object; use requested_by_company_id instead.
|
|
2494
|
-
*
|
|
2495
|
-
* @deprecated
|
|
2496
|
-
*/
|
|
2497
|
-
requested_by_company: {
|
|
2498
|
-
/**
|
|
2499
|
-
* ID of the requesting company.
|
|
2500
|
-
*/
|
|
2501
|
-
id?: string;
|
|
2502
|
-
/**
|
|
2503
|
-
* Name of the requesting company.
|
|
2504
|
-
*/
|
|
2505
|
-
name?: string;
|
|
2506
|
-
};
|
|
2507
|
-
/**
|
|
2508
|
-
* Deprecated. The job's primary manager as a minimal object; null when the job has no manager.
|
|
2509
|
-
*
|
|
2510
|
-
* @deprecated
|
|
2511
|
-
*/
|
|
2512
|
-
manager_user: {
|
|
2513
|
-
/**
|
|
2514
|
-
* ID of the manager user.
|
|
2515
|
-
*/
|
|
2516
|
-
id?: string;
|
|
2517
|
-
/**
|
|
2518
|
-
* Name of the manager user.
|
|
2519
|
-
*/
|
|
2520
|
-
name?: string;
|
|
2521
|
-
} | null;
|
|
2522
|
-
/**
|
|
2523
|
-
* The job's managers, each as a minimal object; empty when the job has no managers. This is the current field — the singular manager_user is deprecated.
|
|
2541
|
+
* The job's managers, each as a minimal object; empty when the job has no managers.
|
|
2524
2542
|
*/
|
|
2525
2543
|
manager_users: Array<{
|
|
2526
2544
|
/**
|
|
@@ -2539,30 +2557,30 @@ export type JobResponseObject = {
|
|
|
2539
2557
|
/**
|
|
2540
2558
|
* ID of the creating user.
|
|
2541
2559
|
*/
|
|
2542
|
-
id
|
|
2560
|
+
id: string;
|
|
2543
2561
|
/**
|
|
2544
2562
|
* Name of the creating user.
|
|
2545
2563
|
*/
|
|
2546
|
-
name
|
|
2564
|
+
name: string;
|
|
2547
2565
|
};
|
|
2548
2566
|
/**
|
|
2549
|
-
* Sites (geofenced locations) associated with the job;
|
|
2567
|
+
* Sites (geofenced locations) associated with the job; empty when none.
|
|
2550
2568
|
*/
|
|
2551
2569
|
sites: Array<{
|
|
2552
2570
|
/**
|
|
2553
2571
|
* Name of the site.
|
|
2554
2572
|
*/
|
|
2555
|
-
name
|
|
2573
|
+
name: string;
|
|
2556
2574
|
/**
|
|
2557
|
-
* Geofenced features within the site;
|
|
2575
|
+
* Geofenced features within the site; empty when none.
|
|
2558
2576
|
*/
|
|
2559
|
-
features
|
|
2577
|
+
features: Array<{
|
|
2560
2578
|
/**
|
|
2561
2579
|
* Name of the feature.
|
|
2562
2580
|
*/
|
|
2563
|
-
name
|
|
2564
|
-
}
|
|
2565
|
-
}
|
|
2581
|
+
name: string;
|
|
2582
|
+
}>;
|
|
2583
|
+
}>;
|
|
2566
2584
|
/**
|
|
2567
2585
|
* The job's structured address; null when unset.
|
|
2568
2586
|
*/
|
|
@@ -2570,18 +2588,18 @@ export type JobResponseObject = {
|
|
|
2570
2588
|
/**
|
|
2571
2589
|
* Human-readable one-line address label.
|
|
2572
2590
|
*/
|
|
2573
|
-
label
|
|
2591
|
+
label: string;
|
|
2574
2592
|
} | null;
|
|
2575
2593
|
/**
|
|
2576
|
-
* Positions on the job — the worker assignments that track time against it;
|
|
2594
|
+
* Positions on the job — the worker assignments that track time against it; empty when none.
|
|
2577
2595
|
*/
|
|
2578
2596
|
positions: Array<{
|
|
2579
|
-
position_function
|
|
2597
|
+
position_function: PositionFunction;
|
|
2580
2598
|
/**
|
|
2581
2599
|
* ID of the worker assigned to the position; null when unfilled.
|
|
2582
2600
|
*/
|
|
2583
|
-
fulfilled_by_user_id
|
|
2584
|
-
}
|
|
2601
|
+
fulfilled_by_user_id: string | null;
|
|
2602
|
+
}>;
|
|
2585
2603
|
/**
|
|
2586
2604
|
* The project this job belongs to; null when none.
|
|
2587
2605
|
*/
|
|
@@ -2589,22 +2607,22 @@ export type JobResponseObject = {
|
|
|
2589
2607
|
/**
|
|
2590
2608
|
* Name of the project.
|
|
2591
2609
|
*/
|
|
2592
|
-
name
|
|
2610
|
+
name: string;
|
|
2593
2611
|
} | null;
|
|
2594
2612
|
pwa_details: PwaJobDetailsResponseObject;
|
|
2595
2613
|
/**
|
|
2596
|
-
* Work types (trade or scope categories) associated with the job;
|
|
2614
|
+
* Work types (trade or scope categories) associated with the job; empty when none.
|
|
2597
2615
|
*/
|
|
2598
2616
|
work_types: Array<{
|
|
2599
2617
|
/**
|
|
2600
2618
|
* The work-type name.
|
|
2601
2619
|
*/
|
|
2602
|
-
value
|
|
2603
|
-
}
|
|
2620
|
+
value: string;
|
|
2621
|
+
}>;
|
|
2604
2622
|
/**
|
|
2605
|
-
* IDs of the timecodes currently associated with the job;
|
|
2623
|
+
* IDs of the timecodes currently associated with the job; empty when none.
|
|
2606
2624
|
*/
|
|
2607
|
-
timekeeping_timecode_ids: Array<string
|
|
2625
|
+
timekeeping_timecode_ids: Array<string>;
|
|
2608
2626
|
/**
|
|
2609
2627
|
* Whether the feature-allocation selector is shown for this job.
|
|
2610
2628
|
*/
|
|
@@ -2705,15 +2723,13 @@ export type JobParameters = {
|
|
|
2705
2723
|
*/
|
|
2706
2724
|
description?: string;
|
|
2707
2725
|
/**
|
|
2708
|
-
* ID of the
|
|
2726
|
+
* ID of the company that requested the job (for example a general contractor). Required.
|
|
2709
2727
|
*/
|
|
2710
|
-
|
|
2728
|
+
requested_by_company_id: string;
|
|
2711
2729
|
/**
|
|
2712
|
-
*
|
|
2713
|
-
*
|
|
2714
|
-
* @deprecated
|
|
2730
|
+
* ID of the user creating the job. Required.
|
|
2715
2731
|
*/
|
|
2716
|
-
|
|
2732
|
+
created_by_user_id: string;
|
|
2717
2733
|
/**
|
|
2718
2734
|
* IDs of the users who manage the job; null when the job has no managers.
|
|
2719
2735
|
*/
|
|
@@ -3048,6 +3064,10 @@ export type UserResponseObject = {
|
|
|
3048
3064
|
* URL of the worker's LinkedIn profile. Null when unset.
|
|
3049
3065
|
*/
|
|
3050
3066
|
linkedin_url: string | null;
|
|
3067
|
+
/**
|
|
3068
|
+
* Identity of the worker's employment at your company, stable across employment versions — a title change or a raise versions the employment without changing this id. It names the employment that this object's employment fields (type through employment_window, plus manager_user_id and any employment custom fields) describe: a worker rehired after an earlier stint holds a second employment with its own id, and exactly one of them is published here.
|
|
3069
|
+
*/
|
|
3070
|
+
employment_id: string;
|
|
3051
3071
|
type: UserCompanyType;
|
|
3052
3072
|
/**
|
|
3053
3073
|
* Job title at your company. Null when unset.
|
|
@@ -3110,15 +3130,15 @@ export type UserResponseObject = {
|
|
|
3110
3130
|
*/
|
|
3111
3131
|
termination_date: string | null;
|
|
3112
3132
|
/**
|
|
3113
|
-
* Window over which the employment version in this response is in effect. Employment is versioned, so a worker whose title or pay changed has several versions and exactly one is published here. The version in effect now is served; where none is in effect the
|
|
3133
|
+
* Window over which the employment version in this response is in effect. Employment is versioned, so a worker whose title or pay changed has several versions and exactly one is published here. The version in effect now is served; where none is in effect, the soonest to begin is served, else the most recently ended — a scheduled hire outranks an ended stint — so this window is how you tell a current employment from an ended or a not-yet-started one. Distinct from hire_date and termination_date, which bound the whole employment rather than this one version.
|
|
3114
3134
|
*/
|
|
3115
3135
|
employment_window: {
|
|
3116
3136
|
/**
|
|
3117
|
-
* When this version of the employment took effect (ISO 8601). A value in the future means the worker is a scheduled hire who has not started.
|
|
3137
|
+
* When this version of the employment took effect (ISO 8601); null when the version has no recorded start. A value in the future means the worker is a scheduled hire who has not started.
|
|
3118
3138
|
*/
|
|
3119
|
-
valid_from: string;
|
|
3139
|
+
valid_from: string | null;
|
|
3120
3140
|
/**
|
|
3121
|
-
* When this version of the employment stopped applying (ISO 8601); null while it is still in effect. A value in the past means
|
|
3141
|
+
* When this version of the employment stopped applying (ISO 8601); null while it is still in effect. A value in the past means an ended version is being served because the worker has nothing current or scheduled.
|
|
3122
3142
|
*/
|
|
3123
3143
|
valid_to: string | null;
|
|
3124
3144
|
};
|
|
@@ -3137,91 +3157,91 @@ export type UserResponseObject = {
|
|
|
3137
3157
|
/**
|
|
3138
3158
|
* Unique identifier of the compliance record.
|
|
3139
3159
|
*/
|
|
3140
|
-
id
|
|
3160
|
+
id: string;
|
|
3141
3161
|
/**
|
|
3142
3162
|
* Home street address line 1, for certified-payroll reporting. Null when unset.
|
|
3143
3163
|
*/
|
|
3144
|
-
address1
|
|
3164
|
+
address1: string | null;
|
|
3145
3165
|
/**
|
|
3146
3166
|
* Home street address line 2. Null when unset.
|
|
3147
3167
|
*/
|
|
3148
|
-
address2
|
|
3168
|
+
address2: string | null;
|
|
3149
3169
|
/**
|
|
3150
3170
|
* Home address city. Null when unset.
|
|
3151
3171
|
*/
|
|
3152
|
-
city
|
|
3172
|
+
city: string | null;
|
|
3153
3173
|
/**
|
|
3154
3174
|
* Home address two-letter US state code. Null when unset.
|
|
3155
3175
|
*/
|
|
3156
|
-
state
|
|
3176
|
+
state: string | null;
|
|
3157
3177
|
/**
|
|
3158
3178
|
* Home address ZIP code. Null when unset.
|
|
3159
3179
|
*/
|
|
3160
|
-
zip
|
|
3180
|
+
zip: string | null;
|
|
3161
3181
|
/**
|
|
3162
3182
|
* Worker race for demographic reporting, as an array of codes such as CAUCASIAN, AFRICAN_AMERICAN, ASIAN, NATIVE_AMERICAN, OTHER, and NOT_SPECIFIED. Null when unset.
|
|
3163
3183
|
*/
|
|
3164
|
-
race
|
|
3184
|
+
race: Array<string> | null;
|
|
3165
3185
|
/**
|
|
3166
3186
|
* Worker sex for demographic reporting: one of female, male, non_binary, or not_specified. Null when unset.
|
|
3167
3187
|
*/
|
|
3168
|
-
sex
|
|
3188
|
+
sex: string | null;
|
|
3169
3189
|
/**
|
|
3170
3190
|
* Local business license number, when a jurisdiction requires it on certified payroll. Null when unset.
|
|
3171
3191
|
*/
|
|
3172
|
-
local_business_license
|
|
3192
|
+
local_business_license: string | null;
|
|
3173
3193
|
/**
|
|
3174
3194
|
* Two-letter US state that issued the worker's driver's license. Null when unset.
|
|
3175
3195
|
*/
|
|
3176
|
-
drivers_license_state
|
|
3196
|
+
drivers_license_state: string | null;
|
|
3177
3197
|
/**
|
|
3178
3198
|
* Worker's driver's license number (stored encrypted). Null when unset.
|
|
3179
3199
|
*/
|
|
3180
|
-
drivers_license_number
|
|
3200
|
+
drivers_license_number: string | null;
|
|
3181
3201
|
/**
|
|
3182
3202
|
* Veteran status per US Census definitions: one of protected_veteran, not_protected_veteran, reserves, guard, or not_specified. Null when unset.
|
|
3183
3203
|
*/
|
|
3184
|
-
veteran_status
|
|
3204
|
+
veteran_status: string | null;
|
|
3185
3205
|
/**
|
|
3186
3206
|
* Whether the worker is of Hispanic origin per US Census definitions: one of yes, no, or not_specified. Null when unset.
|
|
3187
3207
|
*/
|
|
3188
|
-
hispanic_origin
|
|
3208
|
+
hispanic_origin: string | null;
|
|
3189
3209
|
/**
|
|
3190
3210
|
* Worker Social Security Number (nine digits, stored encrypted), required on certified payroll in some jurisdictions. Null when unset.
|
|
3191
3211
|
*/
|
|
3192
|
-
ssn
|
|
3212
|
+
ssn: string | null;
|
|
3193
3213
|
/**
|
|
3194
3214
|
* Whether the worker has a disability, for demographic reporting. Null when unset.
|
|
3195
3215
|
*/
|
|
3196
|
-
disabled
|
|
3216
|
+
disabled: boolean | null;
|
|
3197
3217
|
/**
|
|
3198
3218
|
* Number of payroll withholding exemptions reported on California DIR certified payroll (eCPR); an integer from 0 to 99. Null when unset.
|
|
3199
3219
|
*/
|
|
3200
|
-
ca_dir_withholding_exemptions
|
|
3220
|
+
ca_dir_withholding_exemptions: number | null;
|
|
3201
3221
|
/**
|
|
3202
3222
|
* Illinois DOL race classification for Illinois prevailing-wage reporting, as a single code such as white, black, or hispanic_or_latino. Null when unset. See the schema enum for the full set.
|
|
3203
3223
|
*/
|
|
3204
|
-
il_dol_race
|
|
3224
|
+
il_dol_race: 'white' | 'black' | 'hispanic_or_latino' | 'american_indian_or_alaska_native' | 'chinese' | 'filipino' | 'asian_india' | 'vietnamese' | 'korean' | 'japanese' | 'native_hawaiian' | 'samoan' | 'chamorro' | 'other_asian' | 'other_pacific_islander' | 'other' | null;
|
|
3205
3225
|
/**
|
|
3206
3226
|
* Illinois SHINES employment type: one of part_time, full_time, seasonal_temporary, or independent_contract. Null when unset.
|
|
3207
3227
|
*/
|
|
3208
|
-
il_shines_employment_type
|
|
3228
|
+
il_shines_employment_type: 'part_time' | 'full_time' | 'seasonal_temporary' | 'independent_contract' | null;
|
|
3209
3229
|
/**
|
|
3210
3230
|
* Illinois SHINES Equity Eligible Person (EEP) qualifiers for the worker, as an array of codes such as eep_program_completed, foster_care, and formerly_incarcerated. Null when unset.
|
|
3211
3231
|
*/
|
|
3212
|
-
il_shines_eep_qualifiers
|
|
3232
|
+
il_shines_eep_qualifiers: Array<'eep_program_completed' | 'foster_care' | 'formerly_incarcerated' | 'equity_investment_eligible_community' | 'self_registered_or_unknown'> | null;
|
|
3213
3233
|
/**
|
|
3214
3234
|
* Illinois SHINES workforce-program participation for the worker, as an array of program codes such as solar_training_pipeline_program and craft_apprenticeship_program. Null when unset.
|
|
3215
3235
|
*/
|
|
3216
|
-
il_shines_other_programs
|
|
3236
|
+
il_shines_other_programs: Array<'solar_training_pipeline_program' | 'craft_apprenticeship_program' | 'multi_cultural_jobs_program' | 'clean_jobs_workforce_network_program' | 'illinois_climate_works_prep_apprenticeship_program' | 'returning_residents_clean_jobs_training_program' | 'other'> | null;
|
|
3217
3237
|
/**
|
|
3218
3238
|
* Oregon BOLI workweek schedule: five_eight (five eight-hour days) or four_ten (four ten-hour days). Null when unset.
|
|
3219
3239
|
*/
|
|
3220
|
-
or_boli_schedule_type
|
|
3240
|
+
or_boli_schedule_type: 'five_eight' | 'four_ten' | null;
|
|
3221
3241
|
/**
|
|
3222
3242
|
* Oregon BOLI race classification, as an array of codes such as white, asian, hispanic_or_latino, and black_or_african_american. Null when unset.
|
|
3223
3243
|
*/
|
|
3224
|
-
or_boli_race
|
|
3244
|
+
or_boli_race: Array<'american_indian_or_alaska_native' | 'asian' | 'hispanic_or_latino' | 'black_or_african_american' | 'native_hawaiian_or_pacific_islander' | 'white' | 'portuguese_or_brazilian'> | null;
|
|
3225
3245
|
} | null;
|
|
3226
3246
|
[key: string]: unknown;
|
|
3227
3247
|
};
|
|
@@ -3490,11 +3510,11 @@ export type UserParameters = {
|
|
|
3490
3510
|
/**
|
|
3491
3511
|
* Illinois DOL race classification for Illinois prevailing-wage reporting, as a single code such as white, black, or hispanic_or_latino. See the schema enum for the full set.
|
|
3492
3512
|
*/
|
|
3493
|
-
il_dol_race?: 'white' | 'black' | 'hispanic_or_latino' | 'american_indian_or_alaska_native' | 'chinese' | 'filipino' | 'asian_india' | 'vietnamese' | 'korean' | 'japanese' | 'native_hawaiian' | 'samoan' | 'chamorro' | 'other_asian' | 'other_pacific_islander' | 'other';
|
|
3513
|
+
il_dol_race?: 'white' | 'black' | 'hispanic_or_latino' | 'american_indian_or_alaska_native' | 'chinese' | 'filipino' | 'asian_india' | 'vietnamese' | 'korean' | 'japanese' | 'native_hawaiian' | 'samoan' | 'chamorro' | 'other_asian' | 'other_pacific_islander' | 'other' | null;
|
|
3494
3514
|
/**
|
|
3495
3515
|
* Illinois SHINES employment type: one of part_time, full_time, seasonal_temporary, or independent_contract.
|
|
3496
3516
|
*/
|
|
3497
|
-
il_shines_employment_type?: 'part_time' | 'full_time' | 'seasonal_temporary' | 'independent_contract';
|
|
3517
|
+
il_shines_employment_type?: 'part_time' | 'full_time' | 'seasonal_temporary' | 'independent_contract' | null;
|
|
3498
3518
|
/**
|
|
3499
3519
|
* Illinois SHINES Equity Eligible Person (EEP) qualifiers for the worker, as an array of codes such as eep_program_completed, foster_care, and formerly_incarcerated.
|
|
3500
3520
|
*/
|
|
@@ -3506,7 +3526,7 @@ export type UserParameters = {
|
|
|
3506
3526
|
/**
|
|
3507
3527
|
* Oregon BOLI workweek schedule: five_eight (five eight-hour days) or four_ten (four ten-hour days).
|
|
3508
3528
|
*/
|
|
3509
|
-
or_boli_schedule_type?: 'five_eight' | 'four_ten';
|
|
3529
|
+
or_boli_schedule_type?: 'five_eight' | 'four_ten' | null;
|
|
3510
3530
|
/**
|
|
3511
3531
|
* Oregon BOLI race classification, as an array of codes such as white, asian, hispanic_or_latino, and black_or_african_american.
|
|
3512
3532
|
*/
|
|
@@ -3518,12 +3538,12 @@ export type UserParameters = {
|
|
|
3518
3538
|
* A page of time entries, with pagination metadata and navigation links.
|
|
3519
3539
|
*/
|
|
3520
3540
|
export type TimeEntryIndexObject = {
|
|
3521
|
-
meta
|
|
3522
|
-
links
|
|
3541
|
+
meta: Meta;
|
|
3542
|
+
links: Links;
|
|
3523
3543
|
/**
|
|
3524
3544
|
* The page of time entries.
|
|
3525
3545
|
*/
|
|
3526
|
-
data
|
|
3546
|
+
data: Array<TimeEntryResponseObject>;
|
|
3527
3547
|
};
|
|
3528
3548
|
/**
|
|
3529
3549
|
* A single time entry: one atomic block of tracked work with its start/end times, optional timecode classification, optional job, pay rate, and manager approval status.
|
|
@@ -3580,15 +3600,15 @@ export type TimeEntryResponseObject = {
|
|
|
3580
3600
|
/**
|
|
3581
3601
|
* Straight-time minutes worked (1.0× pay multiplier).
|
|
3582
3602
|
*/
|
|
3583
|
-
1
|
|
3603
|
+
1: number;
|
|
3584
3604
|
/**
|
|
3585
3605
|
* Time-and-a-half minutes worked (1.5× pay multiplier).
|
|
3586
3606
|
*/
|
|
3587
|
-
1.5
|
|
3607
|
+
1.5: number;
|
|
3588
3608
|
/**
|
|
3589
3609
|
* Double-time minutes worked (2.0× pay multiplier).
|
|
3590
3610
|
*/
|
|
3591
|
-
2
|
|
3611
|
+
2: number;
|
|
3592
3612
|
};
|
|
3593
3613
|
/**
|
|
3594
3614
|
* The "1.5" (time-and-a-half) slice of the entry's incentive-pay overtime minutes, in minutes; an integer.
|
|
@@ -3599,9 +3619,9 @@ export type TimeEntryResponseObject = {
|
|
|
3599
3619
|
*/
|
|
3600
3620
|
hourly_rate_cents: string | null;
|
|
3601
3621
|
/**
|
|
3602
|
-
* ISO currency code for the money fields, delegated from the time card
|
|
3622
|
+
* ISO currency code for the money fields, delegated from the time card's pay schedule.
|
|
3603
3623
|
*/
|
|
3604
|
-
currency: string
|
|
3624
|
+
currency: string;
|
|
3605
3625
|
/**
|
|
3606
3626
|
* Where the base rate came from: one of user_default, position, prevailing_wage, or custom; null when no rate is set. (The schema types this as a free-form nullable string; the value set is defined by the model enum.)
|
|
3607
3627
|
*/
|
|
@@ -3637,44 +3657,8 @@ export type TimeEntryResponseObject = {
|
|
|
3637
3657
|
/**
|
|
3638
3658
|
* Name of the allocated feature.
|
|
3639
3659
|
*/
|
|
3640
|
-
name
|
|
3660
|
+
name: string;
|
|
3641
3661
|
}>;
|
|
3642
|
-
/**
|
|
3643
|
-
* Deprecated. The worker as a nested object with id and name; prefer user_id.
|
|
3644
|
-
*
|
|
3645
|
-
* @deprecated
|
|
3646
|
-
*/
|
|
3647
|
-
user: {
|
|
3648
|
-
/**
|
|
3649
|
-
* Unique identifier of the time entry.
|
|
3650
|
-
*/
|
|
3651
|
-
id?: string;
|
|
3652
|
-
/**
|
|
3653
|
-
* The worker's name.
|
|
3654
|
-
*/
|
|
3655
|
-
name?: string;
|
|
3656
|
-
};
|
|
3657
|
-
/**
|
|
3658
|
-
* Deprecated. The timecode as a nested object with id and name; null when none is set; prefer timekeeping_timecode_id.
|
|
3659
|
-
*
|
|
3660
|
-
* @deprecated
|
|
3661
|
-
*/
|
|
3662
|
-
timecode: {
|
|
3663
|
-
/**
|
|
3664
|
-
* Unique identifier of the time entry.
|
|
3665
|
-
*/
|
|
3666
|
-
id?: string;
|
|
3667
|
-
/**
|
|
3668
|
-
* The timecode's name.
|
|
3669
|
-
*/
|
|
3670
|
-
name?: string;
|
|
3671
|
-
} | null;
|
|
3672
|
-
/**
|
|
3673
|
-
* Deprecated. Same value as hours_worked, retained for backward compatibility.
|
|
3674
|
-
*
|
|
3675
|
-
* @deprecated
|
|
3676
|
-
*/
|
|
3677
|
-
total_hours: number;
|
|
3678
3662
|
};
|
|
3679
3663
|
/**
|
|
3680
3664
|
* A record of a single approval or decline action taken against a time entry.
|
|
@@ -3776,93 +3760,93 @@ export type FormDefinitionResponseObject = {
|
|
|
3776
3760
|
/**
|
|
3777
3761
|
* Unique identifier.
|
|
3778
3762
|
*/
|
|
3779
|
-
id
|
|
3763
|
+
id: string;
|
|
3780
3764
|
/**
|
|
3781
3765
|
* Human-readable name of the form.
|
|
3782
3766
|
*/
|
|
3783
|
-
name
|
|
3767
|
+
name: string;
|
|
3784
3768
|
/**
|
|
3785
3769
|
* Free-text description of the form.
|
|
3786
3770
|
*/
|
|
3787
|
-
description
|
|
3771
|
+
description: string;
|
|
3788
3772
|
/**
|
|
3789
3773
|
* ID of the company that owns this form.
|
|
3790
3774
|
*/
|
|
3791
|
-
company_id
|
|
3775
|
+
company_id: string;
|
|
3792
3776
|
/**
|
|
3793
3777
|
* ID of the user who last modified the form; null when unknown.
|
|
3794
3778
|
*/
|
|
3795
|
-
modified_by_user_id
|
|
3779
|
+
modified_by_user_id: string | null;
|
|
3796
3780
|
/**
|
|
3797
3781
|
* Lowercase tags on the form; null when none are set.
|
|
3798
3782
|
*/
|
|
3799
|
-
tags
|
|
3783
|
+
tags: Array<string> | null;
|
|
3800
3784
|
/**
|
|
3801
3785
|
* Names of the questions whose answers make up a submission's title; null when none are set.
|
|
3802
3786
|
*/
|
|
3803
|
-
title_keys
|
|
3787
|
+
title_keys: Array<string> | null;
|
|
3804
3788
|
/**
|
|
3805
3789
|
* Whether the form can be edited.
|
|
3806
3790
|
*/
|
|
3807
|
-
editable
|
|
3791
|
+
editable: boolean;
|
|
3808
3792
|
/**
|
|
3809
3793
|
* Whether the form is always shown to users.
|
|
3810
3794
|
*/
|
|
3811
|
-
always_visible
|
|
3795
|
+
always_visible: boolean;
|
|
3812
3796
|
/**
|
|
3813
3797
|
* Whether the form collects sensitive data.
|
|
3814
3798
|
*/
|
|
3815
|
-
sensitive_form
|
|
3799
|
+
sensitive_form: boolean;
|
|
3816
3800
|
/**
|
|
3817
3801
|
* Whether a user's prior answers can be carried forward into a new submission.
|
|
3818
3802
|
*/
|
|
3819
|
-
allow_carry_forward
|
|
3803
|
+
allow_carry_forward: boolean;
|
|
3820
3804
|
/**
|
|
3821
3805
|
* Revision number of the form's active version; null when it has no active version.
|
|
3822
3806
|
*/
|
|
3823
|
-
current_revision
|
|
3807
|
+
current_revision: number | null;
|
|
3824
3808
|
/**
|
|
3825
3809
|
* The SurveyJS form schema (questions, pages, and logic).
|
|
3826
3810
|
*/
|
|
3827
|
-
json
|
|
3811
|
+
json: {
|
|
3828
3812
|
[key: string]: unknown;
|
|
3829
3813
|
};
|
|
3830
3814
|
/**
|
|
3831
3815
|
* When the record was created (ISO 8601).
|
|
3832
3816
|
*/
|
|
3833
|
-
created_at
|
|
3817
|
+
created_at: string;
|
|
3834
3818
|
}>;
|
|
3835
3819
|
};
|
|
3836
3820
|
/**
|
|
3837
3821
|
* A page of form submissions — the lighter list representation. A submission is a user's completed form; submissions are created in the app, so this API is read-only.
|
|
3838
3822
|
*/
|
|
3839
3823
|
export type FormSubmissionIndexObject = {
|
|
3840
|
-
meta
|
|
3841
|
-
links
|
|
3824
|
+
meta: Meta;
|
|
3825
|
+
links: Links;
|
|
3842
3826
|
/**
|
|
3843
3827
|
* The page of form submissions.
|
|
3844
3828
|
*/
|
|
3845
|
-
data
|
|
3829
|
+
data: Array<{
|
|
3846
3830
|
/**
|
|
3847
3831
|
* Unique identifier.
|
|
3848
3832
|
*/
|
|
3849
|
-
id
|
|
3833
|
+
id: string;
|
|
3850
3834
|
/**
|
|
3851
3835
|
* ID of the user who owns the submission.
|
|
3852
3836
|
*/
|
|
3853
|
-
user_id
|
|
3837
|
+
user_id: string;
|
|
3854
3838
|
/**
|
|
3855
3839
|
* ID of the user who last updated the submission.
|
|
3856
3840
|
*/
|
|
3857
|
-
updated_by_user_id
|
|
3841
|
+
updated_by_user_id: string;
|
|
3858
3842
|
/**
|
|
3859
3843
|
* When the record was created (ISO 8601).
|
|
3860
3844
|
*/
|
|
3861
|
-
created_at
|
|
3845
|
+
created_at: string;
|
|
3862
3846
|
/**
|
|
3863
3847
|
* When the record was last updated (ISO 8601).
|
|
3864
3848
|
*/
|
|
3865
|
-
updated_at
|
|
3849
|
+
updated_at: string;
|
|
3866
3850
|
}>;
|
|
3867
3851
|
};
|
|
3868
3852
|
/**
|
|
@@ -3876,11 +3860,11 @@ export type FormSubmissionResponseObject = {
|
|
|
3876
3860
|
/**
|
|
3877
3861
|
* Unique identifier.
|
|
3878
3862
|
*/
|
|
3879
|
-
id
|
|
3863
|
+
id: string;
|
|
3880
3864
|
/**
|
|
3881
3865
|
* The submitting user's name.
|
|
3882
3866
|
*/
|
|
3883
|
-
name
|
|
3867
|
+
name: string;
|
|
3884
3868
|
};
|
|
3885
3869
|
/**
|
|
3886
3870
|
* Human-readable title derived from the submission's title-key answers; null when none.
|
|
@@ -4009,6 +3993,7 @@ export type UserCompanyCreateParameters = {
|
|
|
4009
3993
|
* Paid training time for the year, in minutes.
|
|
4010
3994
|
*/
|
|
4011
3995
|
training_annual_minutes?: number | null;
|
|
3996
|
+
[key: string]: unknown;
|
|
4012
3997
|
};
|
|
4013
3998
|
/**
|
|
4014
3999
|
* A worker's scheduled compensation timeline at your company — the version currently in effect plus any future-dated versions.
|
|
@@ -4017,12 +4002,12 @@ export type UserCompanyScheduledChangesResponse = {
|
|
|
4017
4002
|
/**
|
|
4018
4003
|
* Id of the worker whose compensation timeline this is.
|
|
4019
4004
|
*/
|
|
4020
|
-
user_id
|
|
4021
|
-
current_version
|
|
4005
|
+
user_id: string;
|
|
4006
|
+
current_version: UserCompanyScheduledChange;
|
|
4022
4007
|
/**
|
|
4023
4008
|
* Future-dated compensation versions, each taking effect on its start date, ordered earliest first.
|
|
4024
4009
|
*/
|
|
4025
|
-
scheduled_changes
|
|
4010
|
+
scheduled_changes: Array<UserCompanyScheduledChange>;
|
|
4026
4011
|
};
|
|
4027
4012
|
/**
|
|
4028
4013
|
* Request body for scheduling a future-dated compensation change. effective_date sets when the new values take effect; earlier history is preserved as its own version. Covers the pay, benefit, accrual, and department fields.
|
|
@@ -4306,11 +4291,11 @@ export type UserGroupResponse = {
|
|
|
4306
4291
|
/**
|
|
4307
4292
|
* Unique identifier.
|
|
4308
4293
|
*/
|
|
4309
|
-
id
|
|
4294
|
+
id: string;
|
|
4310
4295
|
/**
|
|
4311
4296
|
* ID of the user who belongs to the group.
|
|
4312
4297
|
*/
|
|
4313
|
-
user_id
|
|
4298
|
+
user_id: string;
|
|
4314
4299
|
};
|
|
4315
4300
|
/**
|
|
4316
4301
|
* Request body for adding users to a group. The group is taken from the URL path.
|
|
@@ -4321,28 +4306,52 @@ export type UserGroupParameters = {
|
|
|
4321
4306
|
*/
|
|
4322
4307
|
user_ids: Array<string>;
|
|
4323
4308
|
};
|
|
4309
|
+
/**
|
|
4310
|
+
* A page of change events for form submissions, written at archival time; archiving hard-deletes the live row, so this feed is the deletion signal the main index cannot give. Visibility derives from metadata retained at archival time — a subset of the live submission index, never a superset.
|
|
4311
|
+
*/
|
|
4312
|
+
export type FormSubmissionDeltasResponse = {
|
|
4313
|
+
meta: DeltaMeta;
|
|
4314
|
+
links: Links;
|
|
4315
|
+
/**
|
|
4316
|
+
* The page of form-submission change events.
|
|
4317
|
+
*/
|
|
4318
|
+
data: Array<{
|
|
4319
|
+
/**
|
|
4320
|
+
* The change this event records: only destroy events are emitted today — creates and updates surface on the live index.
|
|
4321
|
+
*/
|
|
4322
|
+
event: 'destroy';
|
|
4323
|
+
/**
|
|
4324
|
+
* ID of the form submission this event applies to — the submission's own id, not a version-record id; for a destroy event, the id of the now-deleted submission.
|
|
4325
|
+
*/
|
|
4326
|
+
id: string;
|
|
4327
|
+
/**
|
|
4328
|
+
* When this event occurred (ISO 8601).
|
|
4329
|
+
*/
|
|
4330
|
+
timestamp: string;
|
|
4331
|
+
}>;
|
|
4332
|
+
};
|
|
4324
4333
|
/**
|
|
4325
4334
|
* A page of change events (create, update, destroy) for time entries, drawn from version history; scoped by the surviving parent time card, so a destroyed entry's history stays visible.
|
|
4326
4335
|
*/
|
|
4327
4336
|
export type TimeEntryDeltasResponse = {
|
|
4328
|
-
meta
|
|
4329
|
-
links
|
|
4337
|
+
meta: DeltaMeta;
|
|
4338
|
+
links: Links;
|
|
4330
4339
|
/**
|
|
4331
4340
|
* The page of time-entry change events.
|
|
4332
4341
|
*/
|
|
4333
|
-
data
|
|
4342
|
+
data: Array<{
|
|
4334
4343
|
/**
|
|
4335
4344
|
* The change this event records: one of create, update, or destroy.
|
|
4336
4345
|
*/
|
|
4337
|
-
event
|
|
4346
|
+
event: 'create' | 'update' | 'destroy';
|
|
4338
4347
|
/**
|
|
4339
4348
|
* ID of the time entry this event applies to — the entry's own id, not a version-record id; for a destroy event, the id of the now-deleted entry.
|
|
4340
4349
|
*/
|
|
4341
|
-
id
|
|
4350
|
+
id: string;
|
|
4342
4351
|
/**
|
|
4343
4352
|
* When this event occurred (ISO 8601).
|
|
4344
4353
|
*/
|
|
4345
|
-
timestamp
|
|
4354
|
+
timestamp: string;
|
|
4346
4355
|
}>;
|
|
4347
4356
|
};
|
|
4348
4357
|
/**
|
|
@@ -4356,55 +4365,55 @@ export type UserCompanyScheduledChange = {
|
|
|
4356
4365
|
/**
|
|
4357
4366
|
* Unique identifier of this employment version.
|
|
4358
4367
|
*/
|
|
4359
|
-
id
|
|
4368
|
+
id: string;
|
|
4360
4369
|
/**
|
|
4361
4370
|
* Date this version takes effect (ISO 8601). For a scheduled change this equals the effective_date that created it.
|
|
4362
4371
|
*/
|
|
4363
|
-
start_date
|
|
4372
|
+
start_date: string;
|
|
4364
4373
|
/**
|
|
4365
4374
|
* Base pay rate for this version, formatted as a currency string; null when unset.
|
|
4366
4375
|
*/
|
|
4367
|
-
hourly_rate
|
|
4376
|
+
hourly_rate: string | null;
|
|
4368
4377
|
/**
|
|
4369
4378
|
* How the worker is paid: hourly or salary.
|
|
4370
4379
|
*/
|
|
4371
|
-
compensation_type
|
|
4380
|
+
compensation_type: string;
|
|
4372
4381
|
/**
|
|
4373
4382
|
* Whether the worker is eligible for overtime pay in this version.
|
|
4374
4383
|
*/
|
|
4375
|
-
overtime_eligible
|
|
4384
|
+
overtime_eligible: boolean;
|
|
4376
4385
|
/**
|
|
4377
4386
|
* Annual training-fund contribution, formatted as a currency string; null when unset.
|
|
4378
4387
|
*/
|
|
4379
|
-
training_annual_amount
|
|
4388
|
+
training_annual_amount: string | null;
|
|
4380
4389
|
/**
|
|
4381
4390
|
* Employer-paid annual combined health benefit, formatted as a currency string; null when unset.
|
|
4382
4391
|
*/
|
|
4383
|
-
employer_combined_health_amount
|
|
4392
|
+
employer_combined_health_amount: string | null;
|
|
4384
4393
|
/**
|
|
4385
4394
|
* Employer-paid annual combined savings and retirement benefit, formatted as a currency string; null when unset.
|
|
4386
4395
|
*/
|
|
4387
|
-
employer_combined_savings
|
|
4396
|
+
employer_combined_savings: string | null;
|
|
4388
4397
|
/**
|
|
4389
4398
|
* Annualized minutes the worker is expected to work in this version; null when unset.
|
|
4390
4399
|
*/
|
|
4391
|
-
worked_annual_minutes
|
|
4400
|
+
worked_annual_minutes: number | null;
|
|
4392
4401
|
/**
|
|
4393
4402
|
* Paid time off accrued for the year, in minutes; null when unset.
|
|
4394
4403
|
*/
|
|
4395
|
-
pto_annual_minutes
|
|
4404
|
+
pto_annual_minutes: number | null;
|
|
4396
4405
|
/**
|
|
4397
4406
|
* Holiday time accrued for the year, in minutes; null when unset.
|
|
4398
4407
|
*/
|
|
4399
|
-
holiday_annual_minutes
|
|
4408
|
+
holiday_annual_minutes: number | null;
|
|
4400
4409
|
/**
|
|
4401
4410
|
* Paid training time for the year, in minutes; null when unset.
|
|
4402
4411
|
*/
|
|
4403
|
-
training_annual_minutes
|
|
4412
|
+
training_annual_minutes: number | null;
|
|
4404
4413
|
/**
|
|
4405
4414
|
* Id of the department the worker is assigned to in this version; null when none.
|
|
4406
4415
|
*/
|
|
4407
|
-
companies_department_id
|
|
4416
|
+
companies_department_id: string | null;
|
|
4408
4417
|
};
|
|
4409
4418
|
/**
|
|
4410
4419
|
* Request body for scheduling the end of a worker's employment at your company. Sets the employment's end date; cancel the scheduled termination to restore open-ended employment. Deleting the employment record instead (DELETE on the membership) removes it entirely and is not reversible.
|
|
@@ -4428,43 +4437,39 @@ export type PayPeriodsResponseObject = {
|
|
|
4428
4437
|
/**
|
|
4429
4438
|
* Unique identifier.
|
|
4430
4439
|
*/
|
|
4431
|
-
id
|
|
4432
|
-
/**
|
|
4433
|
-
* ID of the specific pay-schedule version (PayPeriodConfig) that owns this pay period.
|
|
4434
|
-
*/
|
|
4435
|
-
timekeeping_pay_period_config_id?: string;
|
|
4440
|
+
id: string;
|
|
4436
4441
|
/**
|
|
4437
|
-
*
|
|
4442
|
+
* ID of the pay schedule (PayPeriodConfig) that owns this pay period, stable across all of its versions.
|
|
4438
4443
|
*/
|
|
4439
|
-
|
|
4444
|
+
timekeeping_pay_period_config_id: string;
|
|
4440
4445
|
/**
|
|
4441
4446
|
* Calendar date (YYYY-MM-DD) that workers are paid for this period.
|
|
4442
4447
|
*/
|
|
4443
|
-
pay_date
|
|
4448
|
+
pay_date: string;
|
|
4444
4449
|
/**
|
|
4445
4450
|
* Start of the pay-period window (ISO 8601).
|
|
4446
4451
|
*/
|
|
4447
|
-
start_time
|
|
4452
|
+
start_time: string;
|
|
4448
4453
|
/**
|
|
4449
4454
|
* End of the pay-period window (ISO 8601).
|
|
4450
4455
|
*/
|
|
4451
|
-
end_time
|
|
4456
|
+
end_time: string;
|
|
4452
4457
|
/**
|
|
4453
4458
|
* When payroll must be run for this period (ISO 8601).
|
|
4454
4459
|
*/
|
|
4455
|
-
pay_run_deadline
|
|
4460
|
+
pay_run_deadline: string;
|
|
4456
4461
|
/**
|
|
4457
4462
|
* When time-card approvals are due for this period (ISO 8601).
|
|
4458
4463
|
*/
|
|
4459
|
-
approvals_deadline
|
|
4464
|
+
approvals_deadline: string;
|
|
4460
4465
|
/**
|
|
4461
4466
|
* When the record was created (ISO 8601).
|
|
4462
4467
|
*/
|
|
4463
|
-
created_at
|
|
4468
|
+
created_at: string;
|
|
4464
4469
|
/**
|
|
4465
4470
|
* When the record was last updated (ISO 8601).
|
|
4466
4471
|
*/
|
|
4467
|
-
updated_at
|
|
4472
|
+
updated_at: string;
|
|
4468
4473
|
}>;
|
|
4469
4474
|
};
|
|
4470
4475
|
/**
|
|
@@ -4554,15 +4559,15 @@ export type TimeCardResponseObject = {
|
|
|
4554
4559
|
/**
|
|
4555
4560
|
* Minutes at the 1.0x (straight-time) pay-rate multiplier.
|
|
4556
4561
|
*/
|
|
4557
|
-
1
|
|
4562
|
+
1: number;
|
|
4558
4563
|
/**
|
|
4559
4564
|
* Minutes at the 1.5x (time-and-a-half) overtime multiplier.
|
|
4560
4565
|
*/
|
|
4561
|
-
1.5
|
|
4566
|
+
1.5: number;
|
|
4562
4567
|
/**
|
|
4563
4568
|
* Minutes at the 2.0x (double-time) overtime multiplier.
|
|
4564
4569
|
*/
|
|
4565
|
-
2
|
|
4570
|
+
2: number;
|
|
4566
4571
|
};
|
|
4567
4572
|
/**
|
|
4568
4573
|
* Incentive-pay-eligible overtime minutes bucketed by pay-rate multiplier.
|
|
@@ -4571,15 +4576,15 @@ export type TimeCardResponseObject = {
|
|
|
4571
4576
|
/**
|
|
4572
4577
|
* Minutes at the 1.0x (straight-time) pay-rate multiplier.
|
|
4573
4578
|
*/
|
|
4574
|
-
1
|
|
4579
|
+
1: number;
|
|
4575
4580
|
/**
|
|
4576
4581
|
* Minutes at the 1.5x (time-and-a-half) overtime multiplier.
|
|
4577
4582
|
*/
|
|
4578
|
-
1.5
|
|
4583
|
+
1.5: number;
|
|
4579
4584
|
/**
|
|
4580
4585
|
* Minutes at the 2.0x (double-time) overtime multiplier.
|
|
4581
4586
|
*/
|
|
4582
|
-
2
|
|
4587
|
+
2: number;
|
|
4583
4588
|
};
|
|
4584
4589
|
/**
|
|
4585
4590
|
* Total pay for the period in integer cents, as a decimal string.
|
|
@@ -4677,15 +4682,15 @@ export type JobTimeCardDayResponseObject = {
|
|
|
4677
4682
|
/**
|
|
4678
4683
|
* Minutes at the 1.0x (straight-time) pay-rate multiplier.
|
|
4679
4684
|
*/
|
|
4680
|
-
1
|
|
4685
|
+
1: number;
|
|
4681
4686
|
/**
|
|
4682
4687
|
* Minutes at the 1.5x (time-and-a-half) overtime multiplier.
|
|
4683
4688
|
*/
|
|
4684
|
-
1.5
|
|
4689
|
+
1.5: number;
|
|
4685
4690
|
/**
|
|
4686
4691
|
* Minutes at the 2.0x (double-time) overtime multiplier.
|
|
4687
4692
|
*/
|
|
4688
|
-
2
|
|
4693
|
+
2: number;
|
|
4689
4694
|
};
|
|
4690
4695
|
/**
|
|
4691
4696
|
* Incentive-pay-eligible overtime minutes bucketed by pay-rate multiplier.
|
|
@@ -4694,15 +4699,15 @@ export type JobTimeCardDayResponseObject = {
|
|
|
4694
4699
|
/**
|
|
4695
4700
|
* Minutes at the 1.0x (straight-time) pay-rate multiplier.
|
|
4696
4701
|
*/
|
|
4697
|
-
1
|
|
4702
|
+
1: number;
|
|
4698
4703
|
/**
|
|
4699
4704
|
* Minutes at the 1.5x (time-and-a-half) overtime multiplier.
|
|
4700
4705
|
*/
|
|
4701
|
-
1.5
|
|
4706
|
+
1.5: number;
|
|
4702
4707
|
/**
|
|
4703
4708
|
* Minutes at the 2.0x (double-time) overtime multiplier.
|
|
4704
4709
|
*/
|
|
4705
|
-
2
|
|
4710
|
+
2: number;
|
|
4706
4711
|
};
|
|
4707
4712
|
/**
|
|
4708
4713
|
* Total pay for this date in integer cents, as a decimal string.
|
|
@@ -4811,15 +4816,15 @@ export type JobTimeCardDayResponseObject = {
|
|
|
4811
4816
|
/**
|
|
4812
4817
|
* Minutes at the 1.0x (straight-time) pay-rate multiplier.
|
|
4813
4818
|
*/
|
|
4814
|
-
1
|
|
4819
|
+
1: number;
|
|
4815
4820
|
/**
|
|
4816
4821
|
* Minutes at the 1.5x (time-and-a-half) overtime multiplier.
|
|
4817
4822
|
*/
|
|
4818
|
-
1.5
|
|
4823
|
+
1.5: number;
|
|
4819
4824
|
/**
|
|
4820
4825
|
* Minutes at the 2.0x (double-time) overtime multiplier.
|
|
4821
4826
|
*/
|
|
4822
|
-
2
|
|
4827
|
+
2: number;
|
|
4823
4828
|
};
|
|
4824
4829
|
/**
|
|
4825
4830
|
* Week-to-date running total of overtime minutes bucketed by pay-rate multiplier, through this date.
|
|
@@ -4828,15 +4833,15 @@ export type JobTimeCardDayResponseObject = {
|
|
|
4828
4833
|
/**
|
|
4829
4834
|
* Minutes at the 1.0x (straight-time) pay-rate multiplier.
|
|
4830
4835
|
*/
|
|
4831
|
-
1
|
|
4836
|
+
1: number;
|
|
4832
4837
|
/**
|
|
4833
4838
|
* Minutes at the 1.5x (time-and-a-half) overtime multiplier.
|
|
4834
4839
|
*/
|
|
4835
|
-
1.5
|
|
4840
|
+
1.5: number;
|
|
4836
4841
|
/**
|
|
4837
4842
|
* Minutes at the 2.0x (double-time) overtime multiplier.
|
|
4838
4843
|
*/
|
|
4839
|
-
2
|
|
4844
|
+
2: number;
|
|
4840
4845
|
};
|
|
4841
4846
|
/**
|
|
4842
4847
|
* Pay-period-to-date running total of incentive-pay overtime minutes bucketed by pay-rate multiplier, through this date.
|
|
@@ -4845,15 +4850,15 @@ export type JobTimeCardDayResponseObject = {
|
|
|
4845
4850
|
/**
|
|
4846
4851
|
* Minutes at the 1.0x (straight-time) pay-rate multiplier.
|
|
4847
4852
|
*/
|
|
4848
|
-
1
|
|
4853
|
+
1: number;
|
|
4849
4854
|
/**
|
|
4850
4855
|
* Minutes at the 1.5x (time-and-a-half) overtime multiplier.
|
|
4851
4856
|
*/
|
|
4852
|
-
1.5
|
|
4857
|
+
1.5: number;
|
|
4853
4858
|
/**
|
|
4854
4859
|
* Minutes at the 2.0x (double-time) overtime multiplier.
|
|
4855
4860
|
*/
|
|
4856
|
-
2
|
|
4861
|
+
2: number;
|
|
4857
4862
|
};
|
|
4858
4863
|
/**
|
|
4859
4864
|
* Week-to-date running total of incentive-pay overtime minutes bucketed by pay-rate multiplier, through this date.
|
|
@@ -4862,15 +4867,15 @@ export type JobTimeCardDayResponseObject = {
|
|
|
4862
4867
|
/**
|
|
4863
4868
|
* Minutes at the 1.0x (straight-time) pay-rate multiplier.
|
|
4864
4869
|
*/
|
|
4865
|
-
1
|
|
4870
|
+
1: number;
|
|
4866
4871
|
/**
|
|
4867
4872
|
* Minutes at the 1.5x (time-and-a-half) overtime multiplier.
|
|
4868
4873
|
*/
|
|
4869
|
-
1.5
|
|
4874
|
+
1.5: number;
|
|
4870
4875
|
/**
|
|
4871
4876
|
* Minutes at the 2.0x (double-time) overtime multiplier.
|
|
4872
4877
|
*/
|
|
4873
|
-
2
|
|
4878
|
+
2: number;
|
|
4874
4879
|
};
|
|
4875
4880
|
/**
|
|
4876
4881
|
* Pay-period-to-date running total of total pay in integer cents, as a decimal string, through this date.
|
|
@@ -5064,9 +5069,9 @@ export type PayrollFringeBenefitPlanResponseObject = {
|
|
|
5064
5069
|
*/
|
|
5065
5070
|
id: string;
|
|
5066
5071
|
/**
|
|
5067
|
-
*
|
|
5072
|
+
* ID of the pay schedule that owns this plan, stable across all of its versions.
|
|
5068
5073
|
*/
|
|
5069
|
-
|
|
5074
|
+
timekeeping_pay_period_config_id: string;
|
|
5070
5075
|
/**
|
|
5071
5076
|
* Human-readable name of the plan.
|
|
5072
5077
|
*/
|
|
@@ -5082,7 +5087,7 @@ export type PayrollFringeBenefitPlanResponseObject = {
|
|
|
5082
5087
|
/**
|
|
5083
5088
|
* Which employer contribution this plan covers: one of employer_combined_health, employer_combined_savings, employer_combined_holiday_pto, employer_training, or employer_other_contributions. Null when unset.
|
|
5084
5089
|
*/
|
|
5085
|
-
benefit_category: 'employer_combined_health' | 'employer_combined_savings' | 'employer_combined_holiday_pto' | 'employer_training' | 'employer_other_contributions';
|
|
5090
|
+
benefit_category: 'employer_combined_health' | 'employer_combined_savings' | 'employer_combined_holiday_pto' | 'employer_training' | 'employer_other_contributions' | null;
|
|
5086
5091
|
/**
|
|
5087
5092
|
* Whether this is a jointly-managed (Taft-Hartley) fund, which is exempt from the detailed Illinois fund fields.
|
|
5088
5093
|
*/
|
|
@@ -5129,13 +5134,13 @@ export type PayrollFringeBenefitPlanResponseObject = {
|
|
|
5129
5134
|
updated_at: string;
|
|
5130
5135
|
};
|
|
5131
5136
|
/**
|
|
5132
|
-
* Request body for creating or updating a fringe-benefit plan.
|
|
5137
|
+
* Request body for creating or updating a fringe-benefit plan. timekeeping_pay_period_config_id, name, plan_number, and benefit_category are required.
|
|
5133
5138
|
*/
|
|
5134
5139
|
export type PayrollFringeBenefitPlanParameters = {
|
|
5135
5140
|
/**
|
|
5136
|
-
*
|
|
5141
|
+
* ID of the pay schedule that owns the plan, stable across all of its versions. Required.
|
|
5137
5142
|
*/
|
|
5138
|
-
|
|
5143
|
+
timekeeping_pay_period_config_id: string;
|
|
5139
5144
|
/**
|
|
5140
5145
|
* Human-readable name of the plan. Required.
|
|
5141
5146
|
*/
|
|
@@ -5194,13 +5199,9 @@ export type PayrollFringeBenefitPlanParameters = {
|
|
|
5194
5199
|
*/
|
|
5195
5200
|
export type PayrollExternalMapResponseObject = {
|
|
5196
5201
|
/**
|
|
5197
|
-
*
|
|
5202
|
+
* Identity shared by every version of the map, never a per-version row id — the value other resources store to reference it (a paystub line item's payrolls_external_map_id).
|
|
5198
5203
|
*/
|
|
5199
5204
|
id: string;
|
|
5200
|
-
/**
|
|
5201
|
-
* Identity shared by every version of the map — the value other resources store to reference it (a paystub line item's payrolls_external_map_id).
|
|
5202
|
-
*/
|
|
5203
|
-
bitemporal_id: string;
|
|
5204
5205
|
/**
|
|
5205
5206
|
* The external system's field name for the mapped compensation element.
|
|
5206
5207
|
*/
|
|
@@ -5218,9 +5219,9 @@ export type PayrollExternalMapResponseObject = {
|
|
|
5218
5219
|
*/
|
|
5219
5220
|
compensation_element_category: 'tax' | 'health' | 'retirement' | 'insurance' | 'earning' | 'garnishment' | 'other';
|
|
5220
5221
|
/**
|
|
5221
|
-
*
|
|
5222
|
+
* ID of the owning pay schedule; null for a global map shared across companies.
|
|
5222
5223
|
*/
|
|
5223
|
-
|
|
5224
|
+
timekeeping_pay_period_config_id: string | null;
|
|
5224
5225
|
/**
|
|
5225
5226
|
* ID of the fringe-benefit plan this map contributes to; null when none.
|
|
5226
5227
|
*/
|
|
@@ -5228,7 +5229,7 @@ export type PayrollExternalMapResponseObject = {
|
|
|
5228
5229
|
/**
|
|
5229
5230
|
* Who the amount is attributed to: one of any, employee, or employer. Null when unset.
|
|
5230
5231
|
*/
|
|
5231
|
-
contributor: 'any' | 'employee' | 'employer';
|
|
5232
|
+
contributor: 'any' | 'employee' | 'employer' | null;
|
|
5232
5233
|
/**
|
|
5233
5234
|
* Number of pay periods per year, used to annualize this element's amounts.
|
|
5234
5235
|
*/
|
|
@@ -5242,9 +5243,9 @@ export type PayrollExternalMapResponseObject = {
|
|
|
5242
5243
|
*/
|
|
5243
5244
|
global: boolean;
|
|
5244
5245
|
/**
|
|
5245
|
-
* Valid time — when this version starts being true in business reality (ISO 8601).
|
|
5246
|
+
* Valid time — when this version starts being true in business reality (ISO 8601); never null for this resource — a lower bound is always recorded.
|
|
5246
5247
|
*/
|
|
5247
|
-
valid_from: string;
|
|
5248
|
+
valid_from: string | null;
|
|
5248
5249
|
/**
|
|
5249
5250
|
* Valid time — when this version stops being true (ISO 8601); null while it is still current.
|
|
5250
5251
|
*/
|
|
@@ -5266,27 +5267,51 @@ export type PayrollExternalMapResponseObject = {
|
|
|
5266
5267
|
*/
|
|
5267
5268
|
updated_at: string;
|
|
5268
5269
|
};
|
|
5270
|
+
export type PayrollExternalMapHistoryCorrectionObject = {
|
|
5271
|
+
/**
|
|
5272
|
+
* 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.
|
|
5273
|
+
*/
|
|
5274
|
+
payrolls_external_map_id: string;
|
|
5275
|
+
name: string;
|
|
5276
|
+
payrolls_compensation_element_id: string;
|
|
5277
|
+
compensation_element_name: string;
|
|
5278
|
+
compensation_element_category: 'tax' | 'health' | 'retirement' | 'insurance' | 'earning' | 'garnishment' | 'other';
|
|
5279
|
+
timekeeping_pay_period_config_id: string | null;
|
|
5280
|
+
payrolls_fringe_benefit_plan_id: string | null;
|
|
5281
|
+
contributor: 'any' | 'employee' | 'employer' | null;
|
|
5282
|
+
annual_periods: number;
|
|
5283
|
+
created_by_user_id: string | null;
|
|
5284
|
+
global: boolean;
|
|
5285
|
+
valid_from: string | null;
|
|
5286
|
+
valid_to: string | null;
|
|
5287
|
+
transaction_from: string;
|
|
5288
|
+
transaction_to: string | null;
|
|
5289
|
+
created_at: string;
|
|
5290
|
+
updated_at: string;
|
|
5291
|
+
};
|
|
5269
5292
|
export type PayrollExternalMapHistoryVersionObject = {
|
|
5270
|
-
|
|
5271
|
-
|
|
5293
|
+
/**
|
|
5294
|
+
* 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.
|
|
5295
|
+
*/
|
|
5296
|
+
payrolls_external_map_id: string;
|
|
5272
5297
|
name: string;
|
|
5273
5298
|
payrolls_compensation_element_id: string;
|
|
5274
5299
|
compensation_element_name: string;
|
|
5275
5300
|
compensation_element_category: 'tax' | 'health' | 'retirement' | 'insurance' | 'earning' | 'garnishment' | 'other';
|
|
5276
|
-
|
|
5301
|
+
timekeeping_pay_period_config_id: string | null;
|
|
5277
5302
|
payrolls_fringe_benefit_plan_id: string | null;
|
|
5278
|
-
contributor: 'any' | 'employee' | 'employer';
|
|
5303
|
+
contributor: 'any' | 'employee' | 'employer' | null;
|
|
5279
5304
|
annual_periods: number;
|
|
5280
5305
|
created_by_user_id: string | null;
|
|
5281
5306
|
global: boolean;
|
|
5282
|
-
valid_from: string;
|
|
5307
|
+
valid_from: string | null;
|
|
5283
5308
|
valid_to: string | null;
|
|
5284
5309
|
transaction_from: string;
|
|
5285
5310
|
transaction_to: string | null;
|
|
5286
5311
|
created_at: string;
|
|
5287
5312
|
updated_at: string;
|
|
5288
5313
|
version_status: 'scheduled' | 'current' | 'historical';
|
|
5289
|
-
corrections: Array<
|
|
5314
|
+
corrections: Array<PayrollExternalMapHistoryCorrectionObject>;
|
|
5290
5315
|
};
|
|
5291
5316
|
/**
|
|
5292
5317
|
* A payroll run — a record of one payroll-processing event, synced from an external payroll system or reported to DSPTCH (never a run DSPTCH itself initiates). Paystubs belong to a run.
|
|
@@ -5710,7 +5735,7 @@ export type FeatureResponseObject = {
|
|
|
5710
5735
|
*/
|
|
5711
5736
|
geometry: {
|
|
5712
5737
|
[key: string]: unknown;
|
|
5713
|
-
}
|
|
5738
|
+
};
|
|
5714
5739
|
/**
|
|
5715
5740
|
* When the feature became active.
|
|
5716
5741
|
*/
|
|
@@ -5802,9 +5827,9 @@ export type ComplianceCheckResponseObject = {
|
|
|
5802
5827
|
*/
|
|
5803
5828
|
user_id: string | null;
|
|
5804
5829
|
/**
|
|
5805
|
-
*
|
|
5830
|
+
* ID of the employment (user-company) this check applies to, stable across all of its versions; set only when type is "Compliances::UserCompanyCheck", else null.
|
|
5806
5831
|
*/
|
|
5807
|
-
|
|
5832
|
+
employment_id: string | null;
|
|
5808
5833
|
/**
|
|
5809
5834
|
* From the check's requirement.
|
|
5810
5835
|
*/
|
|
@@ -5824,7 +5849,7 @@ export type ComplianceCheckResponseObject = {
|
|
|
5824
5849
|
/**
|
|
5825
5850
|
* Urgency of the requirement: one of critical, high, medium, or low; null when the requirement sets no priority.
|
|
5826
5851
|
*/
|
|
5827
|
-
priority: 'critical' | 'high' | 'medium' | 'low';
|
|
5852
|
+
priority: 'critical' | 'high' | 'medium' | 'low' | null;
|
|
5828
5853
|
/**
|
|
5829
5854
|
* When the check was last evaluated (ISO 8601); null when never evaluated.
|
|
5830
5855
|
*/
|
|
@@ -6214,7 +6239,7 @@ export type PaystubLineItemResponseObject = {
|
|
|
6214
6239
|
*/
|
|
6215
6240
|
id: string;
|
|
6216
6241
|
/**
|
|
6217
|
-
* ID
|
|
6242
|
+
* ID of the external map that defines what this line item represents — the identity every version of the map shares.
|
|
6218
6243
|
*/
|
|
6219
6244
|
payrolls_external_map_id: string;
|
|
6220
6245
|
/**
|
|
@@ -6236,23 +6261,23 @@ export type PaystubLineItemResponseObject = {
|
|
|
6236
6261
|
/**
|
|
6237
6262
|
* The external system's field name for the mapped compensation element.
|
|
6238
6263
|
*/
|
|
6239
|
-
name
|
|
6264
|
+
name: string;
|
|
6240
6265
|
/**
|
|
6241
6266
|
* The DSPTCH compensation element the external map points to.
|
|
6242
6267
|
*/
|
|
6243
|
-
compensation_element
|
|
6268
|
+
compensation_element: {
|
|
6244
6269
|
/**
|
|
6245
6270
|
* Name of the compensation element (e.g. "401(k)").
|
|
6246
6271
|
*/
|
|
6247
|
-
name
|
|
6272
|
+
name: string;
|
|
6248
6273
|
/**
|
|
6249
6274
|
* Free-text description of the compensation element; null when none.
|
|
6250
6275
|
*/
|
|
6251
|
-
description
|
|
6276
|
+
description: string | null;
|
|
6252
6277
|
/**
|
|
6253
6278
|
* Internal categorization of the compensation element: one of tax, health, retirement, insurance, earning, garnishment, or other.
|
|
6254
6279
|
*/
|
|
6255
|
-
category
|
|
6280
|
+
category: 'tax' | 'health' | 'retirement' | 'insurance' | 'earning' | 'garnishment' | 'other';
|
|
6256
6281
|
};
|
|
6257
6282
|
};
|
|
6258
6283
|
/**
|
|
@@ -6355,13 +6380,13 @@ export type PositionResponseObject = {
|
|
|
6355
6380
|
*/
|
|
6356
6381
|
pwa: boolean;
|
|
6357
6382
|
/**
|
|
6358
|
-
*
|
|
6383
|
+
* IDs of the federal (Davis-Bacon) wage determinations applied to this position; empty when none.
|
|
6359
6384
|
*/
|
|
6360
|
-
|
|
6385
|
+
federal_wage_determination_ids: Array<string>;
|
|
6361
6386
|
/**
|
|
6362
|
-
*
|
|
6387
|
+
* IDs of the regional (state) wage determinations applied to this position; empty when none.
|
|
6363
6388
|
*/
|
|
6364
|
-
|
|
6389
|
+
regional_wage_determination_ids: Array<string>;
|
|
6365
6390
|
/**
|
|
6366
6391
|
* PWA classification detail for this position; carries skill_level, the apprenticeship or skill classification, which is null when unset.
|
|
6367
6392
|
*/
|
|
@@ -6370,7 +6395,7 @@ export type PositionResponseObject = {
|
|
|
6370
6395
|
* The apprenticeship or skill classification; null when unset.
|
|
6371
6396
|
*/
|
|
6372
6397
|
skill_level: string | null;
|
|
6373
|
-
}
|
|
6398
|
+
};
|
|
6374
6399
|
/**
|
|
6375
6400
|
* Start of the position's scheduled window (ISO 8601); null when unscheduled.
|
|
6376
6401
|
*/
|
|
@@ -6452,7 +6477,7 @@ export type PositionParameters = {
|
|
|
6452
6477
|
*/
|
|
6453
6478
|
wage_adder_rate_cents?: number | null;
|
|
6454
6479
|
/**
|
|
6455
|
-
* Wage determinations to attach
|
|
6480
|
+
* Wage determinations to attach, each by job_wage_determination_id (with the join record id when updating an existing attachment). Detaching is not available through this API.
|
|
6456
6481
|
*/
|
|
6457
6482
|
job_wage_determinations_positions_attributes?: Array<{
|
|
6458
6483
|
/**
|
|
@@ -6460,9 +6485,9 @@ export type PositionParameters = {
|
|
|
6460
6485
|
*/
|
|
6461
6486
|
id?: number | null;
|
|
6462
6487
|
/**
|
|
6463
|
-
*
|
|
6488
|
+
* ID of the job wage determination to attach.
|
|
6464
6489
|
*/
|
|
6465
|
-
|
|
6490
|
+
job_wage_determination_id?: string | null;
|
|
6466
6491
|
}>;
|
|
6467
6492
|
/**
|
|
6468
6493
|
* PWA classification detail to set; skill_level sets the apprenticeship or skill classification.
|
|
@@ -6720,51 +6745,51 @@ export type FormAssignmentTaskResponseObject = Array<{
|
|
|
6720
6745
|
/**
|
|
6721
6746
|
* Unique identifier of the assignment task.
|
|
6722
6747
|
*/
|
|
6723
|
-
id
|
|
6748
|
+
id: string;
|
|
6724
6749
|
/**
|
|
6725
6750
|
* ID of the form being assigned.
|
|
6726
6751
|
*/
|
|
6727
|
-
form_definition_id
|
|
6752
|
+
form_definition_id: string;
|
|
6728
6753
|
/**
|
|
6729
6754
|
* Recurrence frequency (e.g. DAILY, WEEKLY); null when the assignment does not recur.
|
|
6730
6755
|
*/
|
|
6731
|
-
frequency
|
|
6756
|
+
frequency: 'DAILY' | 'WORKDAILY' | 'WORKDAILYSIX' | 'WEEKLY' | 'BIWEEKLY' | 'MONTHLY' | 'QUARTERLY' | null;
|
|
6732
6757
|
/**
|
|
6733
6758
|
* When the recurrence stops (ISO 8601); null when the assignment does not recur.
|
|
6734
6759
|
*/
|
|
6735
|
-
recurrence_end_time
|
|
6760
|
+
recurrence_end_time: string | null;
|
|
6736
6761
|
/**
|
|
6737
6762
|
* When the assigned form is due (ISO 8601).
|
|
6738
6763
|
*/
|
|
6739
|
-
time_due
|
|
6764
|
+
time_due: string;
|
|
6740
6765
|
/**
|
|
6741
6766
|
* Timezone for the due time.
|
|
6742
6767
|
*/
|
|
6743
|
-
tz_name
|
|
6768
|
+
tz_name: string;
|
|
6744
6769
|
/**
|
|
6745
6770
|
* Display name of the task; falls back to the form's name.
|
|
6746
6771
|
*/
|
|
6747
|
-
name
|
|
6772
|
+
name: string;
|
|
6748
6773
|
/**
|
|
6749
6774
|
* Free-text task description; null when none.
|
|
6750
6775
|
*/
|
|
6751
|
-
description
|
|
6776
|
+
description: string | null;
|
|
6752
6777
|
/**
|
|
6753
6778
|
* IDs of the users the form is assigned to.
|
|
6754
6779
|
*/
|
|
6755
|
-
task_assignee_user_ids
|
|
6780
|
+
task_assignee_user_ids: Array<string>;
|
|
6756
6781
|
/**
|
|
6757
6782
|
* Reminder schedule for the assignment.
|
|
6758
6783
|
*/
|
|
6759
|
-
reminders
|
|
6784
|
+
reminders: Array<{
|
|
6760
6785
|
/**
|
|
6761
6786
|
* Lead time before the due time, as an ISO 8601 duration.
|
|
6762
6787
|
*/
|
|
6763
|
-
offset
|
|
6788
|
+
offset: string;
|
|
6764
6789
|
/**
|
|
6765
6790
|
* Absolute time the reminder fires (ISO 8601).
|
|
6766
6791
|
*/
|
|
6767
|
-
remind_at
|
|
6792
|
+
remind_at: string;
|
|
6768
6793
|
}>;
|
|
6769
6794
|
}>;
|
|
6770
6795
|
/**
|
|
@@ -6960,12 +6985,12 @@ export type UserCertificationParameters = {
|
|
|
6960
6985
|
* A page of certifications held by your company's workers.
|
|
6961
6986
|
*/
|
|
6962
6987
|
export type UserCertificationsResponseObj = {
|
|
6963
|
-
meta
|
|
6964
|
-
links
|
|
6988
|
+
meta: Meta;
|
|
6989
|
+
links: Links;
|
|
6965
6990
|
/**
|
|
6966
6991
|
* The page of held certifications.
|
|
6967
6992
|
*/
|
|
6968
|
-
data
|
|
6993
|
+
data: Array<UserCertificationResponseObject>;
|
|
6969
6994
|
};
|
|
6970
6995
|
/**
|
|
6971
6996
|
* A certification held by a worker — the record that a worker earned a certification, with its receipt date, optional expiry, and verification state.
|
|
@@ -7039,15 +7064,15 @@ export type PositionFunction = {
|
|
|
7039
7064
|
/**
|
|
7040
7065
|
* Unique identifier.
|
|
7041
7066
|
*/
|
|
7042
|
-
id
|
|
7067
|
+
id: string;
|
|
7043
7068
|
/**
|
|
7044
7069
|
* The function name (e.g. "Electrician", "Foreman").
|
|
7045
7070
|
*/
|
|
7046
|
-
value
|
|
7071
|
+
value: string;
|
|
7047
7072
|
/**
|
|
7048
7073
|
* Free-text description of what the function covers.
|
|
7049
7074
|
*/
|
|
7050
|
-
description
|
|
7075
|
+
description: string;
|
|
7051
7076
|
} | null;
|
|
7052
7077
|
/**
|
|
7053
7078
|
* Request body for granting a user a role in a company.
|
|
@@ -7073,24 +7098,24 @@ export type UserRoleResponse = {
|
|
|
7073
7098
|
/**
|
|
7074
7099
|
* Unique identifier.
|
|
7075
7100
|
*/
|
|
7076
|
-
id
|
|
7101
|
+
id: string;
|
|
7077
7102
|
/**
|
|
7078
7103
|
* ID of the user who holds the role.
|
|
7079
7104
|
*/
|
|
7080
|
-
user_id
|
|
7105
|
+
user_id: string;
|
|
7081
7106
|
/**
|
|
7082
7107
|
* ID of the company the role is scoped to.
|
|
7083
7108
|
*/
|
|
7084
|
-
company_id
|
|
7109
|
+
company_id: string;
|
|
7085
7110
|
/**
|
|
7086
7111
|
* The granted role: one of TECHNICIAN, FIELD_LEAD, MANAGER, SAFETY_MANAGER, or ADMIN.
|
|
7087
7112
|
*/
|
|
7088
|
-
role
|
|
7113
|
+
role: 'TECHNICIAN' | 'FIELD_LEAD' | 'MANAGER' | 'SAFETY_MANAGER' | 'ADMIN';
|
|
7089
7114
|
};
|
|
7090
7115
|
/**
|
|
7091
7116
|
* Employment classification of a worker at a company: EMPLOYEE (W-2) or CONTRACTOR (1099). Null when unset.
|
|
7092
7117
|
*/
|
|
7093
|
-
export type UserCompanyType = 'EMPLOYEE' | 'CONTRACTOR';
|
|
7118
|
+
export type UserCompanyType = 'EMPLOYEE' | 'CONTRACTOR' | null;
|
|
7094
7119
|
/**
|
|
7095
7120
|
* Keyset pagination cursors for the collection.
|
|
7096
7121
|
*/
|
|
@@ -7098,17 +7123,17 @@ export type Page = {
|
|
|
7098
7123
|
/**
|
|
7099
7124
|
* Opaque cursor to send back as `page[cursor]` to fetch the next page; null when there are no more pages.
|
|
7100
7125
|
*/
|
|
7101
|
-
next_cursor
|
|
7126
|
+
next_cursor: string | null;
|
|
7102
7127
|
/**
|
|
7103
7128
|
* Opaque cursor for the page just returned; null on the first page.
|
|
7104
7129
|
*/
|
|
7105
|
-
current_cursor
|
|
7130
|
+
current_cursor: string | null;
|
|
7106
7131
|
};
|
|
7107
7132
|
/**
|
|
7108
7133
|
* Pagination metadata for a paged collection, holding the keyset cursors under `page`.
|
|
7109
7134
|
*/
|
|
7110
7135
|
export type Meta = {
|
|
7111
|
-
page
|
|
7136
|
+
page: Page;
|
|
7112
7137
|
};
|
|
7113
7138
|
/**
|
|
7114
7139
|
* Pagination metadata for a change-feed page, with the feed's safe polling watermark.
|
|
@@ -7127,15 +7152,15 @@ export type Links = {
|
|
|
7127
7152
|
/**
|
|
7128
7153
|
* URL of the current request, echoing the path and query that produced this page.
|
|
7129
7154
|
*/
|
|
7130
|
-
self
|
|
7155
|
+
self: string;
|
|
7131
7156
|
/**
|
|
7132
7157
|
* URL of the collection's first page.
|
|
7133
7158
|
*/
|
|
7134
|
-
first
|
|
7159
|
+
first: string | null;
|
|
7135
7160
|
/**
|
|
7136
7161
|
* URL of the next page, already carrying its `page[cursor]`; null when this is the last page.
|
|
7137
7162
|
*/
|
|
7138
|
-
next
|
|
7163
|
+
next: string | null;
|
|
7139
7164
|
};
|
|
7140
7165
|
/**
|
|
7141
7166
|
* A timestamp range filter on a date/time field, supplied as `filter[field][gte]` and/or `filter[field][lte]`; omit or null a bound for an open-ended range.
|
|
@@ -7155,13 +7180,9 @@ export type DateTimeFilter = {
|
|
|
7155
7180
|
*/
|
|
7156
7181
|
export type WageDeterminationResponseObject = {
|
|
7157
7182
|
/**
|
|
7158
|
-
*
|
|
7183
|
+
* Identifier of this determination record — permanent, because the record is an immutable DOL publication; a DOL revision arrives as a new record linked through superseded_by_wage_determination_id, not a rewrite of this one.
|
|
7159
7184
|
*/
|
|
7160
7185
|
id: string;
|
|
7161
|
-
/**
|
|
7162
|
-
* Stable identifier shared by every temporal version of this determination; the id changes with each version, the uid does not.
|
|
7163
|
-
*/
|
|
7164
|
-
uid: string;
|
|
7165
7186
|
/**
|
|
7166
7187
|
* DOL general decision number identifying this determination (e.g. "CA20240001"); combine with modification_number for the full versioned identifier (e.g. "CA20240001/1").
|
|
7167
7188
|
*/
|
|
@@ -7283,13 +7304,9 @@ export type JobWageDeterminationResponseObject = ({
|
|
|
7283
7304
|
*/
|
|
7284
7305
|
export type FederalJobWageDeterminationResponseObject = {
|
|
7285
7306
|
/**
|
|
7286
|
-
*
|
|
7307
|
+
* Identifier of the determination, stable across every one of its temporal versions — it addresses the determination itself, not the version you happen to be reading, and is what the member and history paths take.
|
|
7287
7308
|
*/
|
|
7288
7309
|
id: string;
|
|
7289
|
-
/**
|
|
7290
|
-
* Stable identifier shared by every temporal version of this determination; the id changes with each version, the uid does not.
|
|
7291
|
-
*/
|
|
7292
|
-
uid: string;
|
|
7293
7310
|
/**
|
|
7294
7311
|
* ID of the job this wage determination applies to.
|
|
7295
7312
|
*/
|
|
@@ -7321,15 +7338,15 @@ export type FederalJobWageDeterminationResponseObject = {
|
|
|
7321
7338
|
/**
|
|
7322
7339
|
* Broad DOL construction category — one of building, heavy, highway, or residential; null when not recorded.
|
|
7323
7340
|
*/
|
|
7324
|
-
construction_category: 'building' | 'heavy' | 'highway' | 'residential';
|
|
7341
|
+
construction_category: 'building' | 'heavy' | 'highway' | 'residential' | null;
|
|
7325
7342
|
/**
|
|
7326
7343
|
* 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.
|
|
7327
7344
|
*/
|
|
7328
7345
|
general_wage_determination: string | null;
|
|
7329
7346
|
/**
|
|
7330
|
-
* Valid time — when this version of the determination took effect (ISO 8601).
|
|
7347
|
+
* Valid time — when this version of the determination took effect (ISO 8601); null when the version has no recorded start.
|
|
7331
7348
|
*/
|
|
7332
|
-
valid_from: string;
|
|
7349
|
+
valid_from: string | null;
|
|
7333
7350
|
/**
|
|
7334
7351
|
* Valid time — when this version stopped applying (ISO 8601); null while it is still current.
|
|
7335
7352
|
*/
|
|
@@ -7348,13 +7365,9 @@ export type FederalJobWageDeterminationResponseObject = {
|
|
|
7348
7365
|
*/
|
|
7349
7366
|
export type RegionalJobWageDeterminationResponseObject = {
|
|
7350
7367
|
/**
|
|
7351
|
-
*
|
|
7368
|
+
* Identifier of the determination, stable across every one of its temporal versions — it addresses the determination itself, not the version you happen to be reading, and is what the member and history paths take.
|
|
7352
7369
|
*/
|
|
7353
7370
|
id: string;
|
|
7354
|
-
/**
|
|
7355
|
-
* Stable identifier shared by every temporal version of this determination; the id changes with each version, the uid does not.
|
|
7356
|
-
*/
|
|
7357
|
-
uid: string;
|
|
7358
7371
|
/**
|
|
7359
7372
|
* ID of the job this wage determination applies to.
|
|
7360
7373
|
*/
|
|
@@ -7383,11 +7396,11 @@ export type RegionalJobWageDeterminationResponseObject = {
|
|
|
7383
7396
|
* 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.
|
|
7384
7397
|
*/
|
|
7385
7398
|
general_wage_determination: string | null;
|
|
7386
|
-
regional_fields:
|
|
7399
|
+
regional_fields: RegionalWageDeterminationFieldsResponse;
|
|
7387
7400
|
/**
|
|
7388
|
-
* Valid time — when this version of the determination took effect (ISO 8601).
|
|
7401
|
+
* Valid time — when this version of the determination took effect (ISO 8601); null when the version has no recorded start.
|
|
7389
7402
|
*/
|
|
7390
|
-
valid_from: string;
|
|
7403
|
+
valid_from: string | null;
|
|
7391
7404
|
/**
|
|
7392
7405
|
* Valid time — when this version stopped applying (ISO 8601); null while it is still current.
|
|
7393
7406
|
*/
|
|
@@ -7407,8 +7420,10 @@ export type JobWageDeterminationHistoryVersionObject = ({
|
|
|
7407
7420
|
type: 'Pwa::JobWageDeterminations::Regional';
|
|
7408
7421
|
} & RegionalJobWageDeterminationHistoryVersionObject);
|
|
7409
7422
|
export type FederalJobWageDeterminationHistoryVersionObject = {
|
|
7410
|
-
|
|
7411
|
-
|
|
7423
|
+
/**
|
|
7424
|
+
* 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.
|
|
7425
|
+
*/
|
|
7426
|
+
job_wage_determination_id: string;
|
|
7412
7427
|
job_id: string;
|
|
7413
7428
|
pwa_trade_id: string;
|
|
7414
7429
|
type: 'Pwa::JobWageDeterminations::Federal';
|
|
@@ -7416,18 +7431,20 @@ export type FederalJobWageDeterminationHistoryVersionObject = {
|
|
|
7416
7431
|
hourly_rate_cents: string;
|
|
7417
7432
|
fringe_rate_cents: string;
|
|
7418
7433
|
class_code: string | null;
|
|
7419
|
-
construction_category: 'building' | 'heavy' | 'highway' | 'residential';
|
|
7434
|
+
construction_category: 'building' | 'heavy' | 'highway' | 'residential' | null;
|
|
7420
7435
|
general_wage_determination: string | null;
|
|
7421
|
-
valid_from: string;
|
|
7436
|
+
valid_from: string | null;
|
|
7422
7437
|
valid_to: string | null;
|
|
7423
7438
|
created_at: string;
|
|
7424
7439
|
updated_at: string;
|
|
7425
7440
|
version_status: 'scheduled' | 'current' | 'historical';
|
|
7426
|
-
corrections: Array<
|
|
7441
|
+
corrections: Array<JobWageDeterminationHistoryCorrectionObject>;
|
|
7427
7442
|
};
|
|
7428
7443
|
export type RegionalJobWageDeterminationHistoryVersionObject = {
|
|
7429
|
-
|
|
7430
|
-
|
|
7444
|
+
/**
|
|
7445
|
+
* 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.
|
|
7446
|
+
*/
|
|
7447
|
+
job_wage_determination_id: string;
|
|
7431
7448
|
job_id: string;
|
|
7432
7449
|
pwa_trade_id: string;
|
|
7433
7450
|
type: 'Pwa::JobWageDeterminations::Regional';
|
|
@@ -7435,18 +7452,116 @@ export type RegionalJobWageDeterminationHistoryVersionObject = {
|
|
|
7435
7452
|
hourly_rate_cents: string;
|
|
7436
7453
|
fringe_rate_cents: string;
|
|
7437
7454
|
general_wage_determination: string | null;
|
|
7438
|
-
regional_fields:
|
|
7439
|
-
valid_from: string;
|
|
7455
|
+
regional_fields: RegionalWageDeterminationFieldsResponse;
|
|
7456
|
+
valid_from: string | null;
|
|
7440
7457
|
valid_to: string | null;
|
|
7441
7458
|
created_at: string;
|
|
7442
7459
|
updated_at: string;
|
|
7443
7460
|
version_status: 'scheduled' | 'current' | 'historical';
|
|
7444
|
-
corrections: Array<
|
|
7461
|
+
corrections: Array<JobWageDeterminationHistoryCorrectionObject>;
|
|
7462
|
+
};
|
|
7463
|
+
export type JobWageDeterminationHistoryCorrectionObject = ({
|
|
7464
|
+
type: 'Pwa::JobWageDeterminations::Federal';
|
|
7465
|
+
} & FederalJobWageDeterminationHistoryCorrectionObject) | ({
|
|
7466
|
+
type: 'Pwa::JobWageDeterminations::Regional';
|
|
7467
|
+
} & RegionalJobWageDeterminationHistoryCorrectionObject);
|
|
7468
|
+
export type FederalJobWageDeterminationHistoryCorrectionObject = {
|
|
7469
|
+
/**
|
|
7470
|
+
* 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.
|
|
7471
|
+
*/
|
|
7472
|
+
job_wage_determination_id: string;
|
|
7473
|
+
job_id: string;
|
|
7474
|
+
pwa_trade_id: string;
|
|
7475
|
+
type: 'Pwa::JobWageDeterminations::Federal';
|
|
7476
|
+
labor_classification: string;
|
|
7477
|
+
hourly_rate_cents: string;
|
|
7478
|
+
fringe_rate_cents: string;
|
|
7479
|
+
class_code: string | null;
|
|
7480
|
+
construction_category: 'building' | 'heavy' | 'highway' | 'residential' | null;
|
|
7481
|
+
general_wage_determination: string | null;
|
|
7482
|
+
valid_from: string | null;
|
|
7483
|
+
valid_to: string | null;
|
|
7484
|
+
created_at: string;
|
|
7485
|
+
updated_at: string;
|
|
7486
|
+
};
|
|
7487
|
+
export type RegionalJobWageDeterminationHistoryCorrectionObject = {
|
|
7488
|
+
/**
|
|
7489
|
+
* 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.
|
|
7490
|
+
*/
|
|
7491
|
+
job_wage_determination_id: string;
|
|
7492
|
+
job_id: string;
|
|
7493
|
+
pwa_trade_id: string;
|
|
7494
|
+
type: 'Pwa::JobWageDeterminations::Regional';
|
|
7495
|
+
labor_classification: string;
|
|
7496
|
+
hourly_rate_cents: string;
|
|
7497
|
+
fringe_rate_cents: string;
|
|
7498
|
+
general_wage_determination: string | null;
|
|
7499
|
+
regional_fields: RegionalWageDeterminationFieldsResponse;
|
|
7500
|
+
valid_from: string | null;
|
|
7501
|
+
valid_to: string | null;
|
|
7502
|
+
created_at: string;
|
|
7503
|
+
updated_at: string;
|
|
7445
7504
|
};
|
|
7446
7505
|
/**
|
|
7447
7506
|
* State-specific rate fields for a Regional determination, as decimal-string money in cents
|
|
7448
|
-
* (e.g. "538.0").
|
|
7449
|
-
*
|
|
7507
|
+
* (e.g. "538.0"). These nine properties are the whole write vocabulary, but which of them a
|
|
7508
|
+
* request may send is set by the job's region, not the request — sending a key the job's
|
|
7509
|
+
* region does not allow returns a 422:
|
|
7510
|
+
*
|
|
7511
|
+
* - Categorized-fringe regions (currently IL) accept `combined_health_fringe_rate_cents`,
|
|
7512
|
+
* `combined_savings_fringe_rate_cents`, `combined_holiday_pto_fringe_rate_cents`,
|
|
7513
|
+
* `training_fringe_rate_cents`, and `other_fringe_rate_cents`.
|
|
7514
|
+
* - Overtime-adder regions (currently IL and NY) accept `one_five_x_adder_rate_cents`,
|
|
7515
|
+
* `two_x_adder_rate_cents`, `one_five_x_fringe_adder_rate_cents`, and
|
|
7516
|
+
* `two_x_fringe_adder_rate_cents`.
|
|
7517
|
+
*
|
|
7518
|
+
* In a categorized-fringe region the five fringe keys are required, not merely accepted —
|
|
7519
|
+
* omitting any of them returns a 422. Categorized-fringe values are non-null when present;
|
|
7520
|
+
* overtime-adder values may be null.
|
|
7521
|
+
*
|
|
7522
|
+
*/
|
|
7523
|
+
export type RegionalWageDeterminationFields = {
|
|
7524
|
+
/**
|
|
7525
|
+
* Combined health fringe rate, in cents as a decimal string. Categorized-fringe regions only; non-null when present.
|
|
7526
|
+
*/
|
|
7527
|
+
combined_health_fringe_rate_cents?: string;
|
|
7528
|
+
/**
|
|
7529
|
+
* Combined savings fringe rate, in cents as a decimal string. Categorized-fringe regions only; non-null when present.
|
|
7530
|
+
*/
|
|
7531
|
+
combined_savings_fringe_rate_cents?: string;
|
|
7532
|
+
/**
|
|
7533
|
+
* Combined holiday/PTO fringe rate, in cents as a decimal string. Categorized-fringe regions only; non-null when present.
|
|
7534
|
+
*/
|
|
7535
|
+
combined_holiday_pto_fringe_rate_cents?: string;
|
|
7536
|
+
/**
|
|
7537
|
+
* Training fringe rate, in cents as a decimal string. Categorized-fringe regions only; non-null when present.
|
|
7538
|
+
*/
|
|
7539
|
+
training_fringe_rate_cents?: string;
|
|
7540
|
+
/**
|
|
7541
|
+
* Other (uncategorized) fringe rate, in cents as a decimal string. Categorized-fringe regions only; non-null when present.
|
|
7542
|
+
*/
|
|
7543
|
+
other_fringe_rate_cents?: string;
|
|
7544
|
+
/**
|
|
7545
|
+
* Hourly wage adder added to 1.5x overtime, in cents as a decimal string. Overtime-adder regions only; may be null.
|
|
7546
|
+
*/
|
|
7547
|
+
one_five_x_adder_rate_cents?: string | null;
|
|
7548
|
+
/**
|
|
7549
|
+
* Hourly wage adder added to 2x overtime, in cents as a decimal string. Overtime-adder regions only; may be null.
|
|
7550
|
+
*/
|
|
7551
|
+
two_x_adder_rate_cents?: string | null;
|
|
7552
|
+
/**
|
|
7553
|
+
* Hourly fringe adder added to 1.5x overtime, in cents as a decimal string. Overtime-adder regions only; may be null.
|
|
7554
|
+
*/
|
|
7555
|
+
one_five_x_fringe_adder_rate_cents?: string | null;
|
|
7556
|
+
/**
|
|
7557
|
+
* Hourly fringe adder added to 2x overtime, in cents as a decimal string. Overtime-adder regions only; may be null.
|
|
7558
|
+
*/
|
|
7559
|
+
two_x_fringe_adder_rate_cents?: string | null;
|
|
7560
|
+
};
|
|
7561
|
+
/**
|
|
7562
|
+
* State-specific rate fields recorded on a Regional determination, as decimal-string money in
|
|
7563
|
+
* cents (e.g. "538.0"). Which keys appear is set by the job's region, so this object is always
|
|
7564
|
+
* a region-determined subset of the nine keys the write side accepts — never a fixed shape:
|
|
7450
7565
|
*
|
|
7451
7566
|
* - Categorized-fringe regions (currently IL) carry `combined_health_fringe_rate_cents`,
|
|
7452
7567
|
* `combined_savings_fringe_rate_cents`, `combined_holiday_pto_fringe_rate_cents`,
|
|
@@ -7456,12 +7571,10 @@ export type RegionalJobWageDeterminationHistoryVersionObject = {
|
|
|
7456
7571
|
* `two_x_fringe_adder_rate_cents`.
|
|
7457
7572
|
* - A region with neither returns an empty object.
|
|
7458
7573
|
*
|
|
7459
|
-
*
|
|
7460
|
-
* allow returns a 422. Categorized-fringe values are non-null when present; overtime-adder values
|
|
7461
|
-
* may be null.
|
|
7574
|
+
* Categorized-fringe values are non-null when present; overtime-adder values may be null.
|
|
7462
7575
|
*
|
|
7463
7576
|
*/
|
|
7464
|
-
export type
|
|
7577
|
+
export type RegionalWageDeterminationFieldsResponse = {
|
|
7465
7578
|
[key: string]: string | null;
|
|
7466
7579
|
};
|
|
7467
7580
|
/**
|
|
@@ -7503,7 +7616,7 @@ export type FederalJobWageDeterminationParameters = {
|
|
|
7503
7616
|
/**
|
|
7504
7617
|
* Broad DOL construction category — one of building, heavy, highway, or residential; null when not recorded.
|
|
7505
7618
|
*/
|
|
7506
|
-
construction_category?: 'building' | 'heavy' | 'highway' | 'residential';
|
|
7619
|
+
construction_category?: 'building' | 'heavy' | 'highway' | 'residential' | null;
|
|
7507
7620
|
/**
|
|
7508
7621
|
* 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.
|
|
7509
7622
|
*/
|
|
@@ -7659,15 +7772,11 @@ export type RateRuleCondition = ({
|
|
|
7659
7772
|
*/
|
|
7660
7773
|
export type RateRuleResponseObject = {
|
|
7661
7774
|
/**
|
|
7662
|
-
*
|
|
7775
|
+
* Identity shared by every version of the rule, never a per-version row id — the value the member and history paths address the rule by.
|
|
7663
7776
|
*/
|
|
7664
7777
|
id: string;
|
|
7665
7778
|
/**
|
|
7666
|
-
*
|
|
7667
|
-
*/
|
|
7668
|
-
uid: string;
|
|
7669
|
-
/**
|
|
7670
|
-
* ID of the job wage determination this rule is applied to, taken from the request path. Because rules attach to a shared package, the same rule can surface under more than one determination.
|
|
7779
|
+
* ID of the job wage determination this rule is applied to, taken from the request path — the determination's own family identifier, stable across its temporal versions. Because rules attach to a shared package, the same rule can surface under more than one determination.
|
|
7671
7780
|
*/
|
|
7672
7781
|
job_wage_determination_id: string;
|
|
7673
7782
|
/**
|
|
@@ -7680,9 +7789,9 @@ export type RateRuleResponseObject = {
|
|
|
7680
7789
|
*/
|
|
7681
7790
|
conditions: Array<RateRuleCondition>;
|
|
7682
7791
|
/**
|
|
7683
|
-
* Valid time — when this version of the rule took effect (ISO 8601).
|
|
7792
|
+
* Valid time — when this version of the rule took effect (ISO 8601); null when the version has no recorded start.
|
|
7684
7793
|
*/
|
|
7685
|
-
valid_from: string;
|
|
7794
|
+
valid_from: string | null;
|
|
7686
7795
|
/**
|
|
7687
7796
|
* Valid time — when this version stopped applying (ISO 8601); null while it is still current.
|
|
7688
7797
|
*/
|
|
@@ -7696,19 +7805,35 @@ export type RateRuleResponseObject = {
|
|
|
7696
7805
|
*/
|
|
7697
7806
|
updated_at: string;
|
|
7698
7807
|
};
|
|
7808
|
+
export type RateRuleHistoryCorrectionObject = {
|
|
7809
|
+
/**
|
|
7810
|
+
* 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.
|
|
7811
|
+
*/
|
|
7812
|
+
pay_rates_rule_id: string;
|
|
7813
|
+
job_wage_determination_id: string;
|
|
7814
|
+
pay_rates_rule_package_id: string;
|
|
7815
|
+
effect: RateRuleEffect;
|
|
7816
|
+
conditions: Array<RateRuleCondition>;
|
|
7817
|
+
valid_from: string | null;
|
|
7818
|
+
valid_to: string | null;
|
|
7819
|
+
created_at: string;
|
|
7820
|
+
updated_at: string;
|
|
7821
|
+
};
|
|
7699
7822
|
export type RateRuleHistoryVersionObject = {
|
|
7700
|
-
|
|
7701
|
-
|
|
7823
|
+
/**
|
|
7824
|
+
* 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.
|
|
7825
|
+
*/
|
|
7826
|
+
pay_rates_rule_id: string;
|
|
7702
7827
|
job_wage_determination_id: string;
|
|
7703
7828
|
pay_rates_rule_package_id: string;
|
|
7704
7829
|
effect: RateRuleEffect;
|
|
7705
7830
|
conditions: Array<RateRuleCondition>;
|
|
7706
|
-
valid_from: string;
|
|
7831
|
+
valid_from: string | null;
|
|
7707
7832
|
valid_to: string | null;
|
|
7708
7833
|
created_at: string;
|
|
7709
7834
|
updated_at: string;
|
|
7710
7835
|
version_status: 'scheduled' | 'current' | 'historical';
|
|
7711
|
-
corrections: Array<
|
|
7836
|
+
corrections: Array<RateRuleHistoryCorrectionObject>;
|
|
7712
7837
|
};
|
|
7713
7838
|
/**
|
|
7714
7839
|
* Create a rate rule on a job wage determination. `effect` is required. `conditions` is optional — an omitted or empty list makes the rule always apply. `effective_date` (YYYY-MM-DD) sets when the rule takes effect; it defaults to today and cannot predate the earliest applicable wage determination.
|
|
@@ -7759,7 +7884,7 @@ export type AssetsItemResponseObject = {
|
|
|
7759
7884
|
/**
|
|
7760
7885
|
* Lifecycle status of the item: one of available, assigned, or retired.
|
|
7761
7886
|
*/
|
|
7762
|
-
status: 'available' | 'assigned' | 'retired';
|
|
7887
|
+
status: 'available' | 'assigned' | 'retired' | null;
|
|
7763
7888
|
/**
|
|
7764
7889
|
* When the item was purchased (ISO 8601).
|
|
7765
7890
|
*/
|
|
@@ -8023,7 +8148,7 @@ export type AssetsFormAssignmentTriggerResponseObject = {
|
|
|
8023
8148
|
/**
|
|
8024
8149
|
* How often the generated form recurs: one of DAILY, WORKDAILY, WORKDAILYSIX, WEEKLY, BIWEEKLY, MONTHLY, or QUARTERLY. Null for a one-time assignment.
|
|
8025
8150
|
*/
|
|
8026
|
-
recurrence_frequency: 'DAILY' | 'WORKDAILY' | 'WORKDAILYSIX' | 'WEEKLY' | 'BIWEEKLY' | 'MONTHLY' | 'QUARTERLY';
|
|
8151
|
+
recurrence_frequency: 'DAILY' | 'WORKDAILY' | 'WORKDAILYSIX' | 'WEEKLY' | 'BIWEEKLY' | 'MONTHLY' | 'QUARTERLY' | null;
|
|
8027
8152
|
/**
|
|
8028
8153
|
* How the first due date is set: day_of_event (the day the rule fires), day_of_week (the next day_of_week_due), or day_of_month (day_of_month_due of the current or next month).
|
|
8029
8154
|
*/
|
|
@@ -8096,7 +8221,7 @@ export type AssetsFormAssignmentTriggerParameters = {
|
|
|
8096
8221
|
/**
|
|
8097
8222
|
* How often the generated form recurs: one of DAILY, WORKDAILY, WORKDAILYSIX, WEEKLY, BIWEEKLY, MONTHLY, or QUARTERLY. Null for a one-time assignment.
|
|
8098
8223
|
*/
|
|
8099
|
-
recurrence_frequency?: 'DAILY' | 'WORKDAILY' | 'WORKDAILYSIX' | 'WEEKLY' | 'BIWEEKLY' | 'MONTHLY' | 'QUARTERLY';
|
|
8224
|
+
recurrence_frequency?: 'DAILY' | 'WORKDAILY' | 'WORKDAILYSIX' | 'WEEKLY' | 'BIWEEKLY' | 'MONTHLY' | 'QUARTERLY' | null;
|
|
8100
8225
|
/**
|
|
8101
8226
|
* Day of week the form is first due, 0 (Sunday) to 6 (Saturday). Required when first_due_by is day_of_week; null otherwise.
|
|
8102
8227
|
*/
|
|
@@ -8133,7 +8258,7 @@ export type AssetsAttachmentResponseObject = {
|
|
|
8133
8258
|
/**
|
|
8134
8259
|
* MIME type of the file; null when not recorded.
|
|
8135
8260
|
*/
|
|
8136
|
-
content_type
|
|
8261
|
+
content_type: string | null;
|
|
8137
8262
|
/**
|
|
8138
8263
|
* Size of the file in bytes.
|
|
8139
8264
|
*/
|
|
@@ -8212,7 +8337,7 @@ export type AssetsDocumentResponseObject = {
|
|
|
8212
8337
|
/**
|
|
8213
8338
|
* MIME type of the file; null when not recorded.
|
|
8214
8339
|
*/
|
|
8215
|
-
content_type
|
|
8340
|
+
content_type: string | null;
|
|
8216
8341
|
/**
|
|
8217
8342
|
* Size of the file in bytes.
|
|
8218
8343
|
*/
|
|
@@ -8298,9 +8423,9 @@ export type AssetsItemFormAssignmentResponseObject = {
|
|
|
8298
8423
|
*/
|
|
8299
8424
|
description: string | null;
|
|
8300
8425
|
/**
|
|
8301
|
-
* IANA time zone in which time_due is interpreted;
|
|
8426
|
+
* IANA time zone in which time_due is interpreted; always set, defaulting to US/Central.
|
|
8302
8427
|
*/
|
|
8303
|
-
tz_name: string
|
|
8428
|
+
tz_name: string;
|
|
8304
8429
|
/**
|
|
8305
8430
|
* When the form task is due (ISO 8601), interpreted in tz_name; null for an unscheduled task.
|
|
8306
8431
|
*/
|
|
@@ -8308,7 +8433,7 @@ export type AssetsItemFormAssignmentResponseObject = {
|
|
|
8308
8433
|
/**
|
|
8309
8434
|
* How often this form task recurs: one of DAILY, WORKDAILY, WORKDAILYSIX, WEEKLY, BIWEEKLY, MONTHLY, or QUARTERLY. Null for a one-time assignment; on write, applied only when recurring is true.
|
|
8310
8435
|
*/
|
|
8311
|
-
frequency: 'DAILY' | 'WORKDAILY' | 'WORKDAILYSIX' | 'WEEKLY' | 'BIWEEKLY' | 'MONTHLY' | 'QUARTERLY';
|
|
8436
|
+
frequency: 'DAILY' | 'WORKDAILY' | 'WORKDAILYSIX' | 'WEEKLY' | 'BIWEEKLY' | 'MONTHLY' | 'QUARTERLY' | null;
|
|
8312
8437
|
/**
|
|
8313
8438
|
* When recurrence stops (ISO 8601); null for a non-recurring or open-ended task.
|
|
8314
8439
|
*/
|
|
@@ -8324,11 +8449,11 @@ export type AssetsItemFormAssignmentResponseObject = {
|
|
|
8324
8449
|
/**
|
|
8325
8450
|
* ISO 8601 duration offset from the due time for the reminder (e.g. -PT1H for one hour before); must be one of the preset reminder times.
|
|
8326
8451
|
*/
|
|
8327
|
-
offset
|
|
8452
|
+
offset: string;
|
|
8328
8453
|
/**
|
|
8329
8454
|
* When the reminder fires (ISO 8601), computed as the due time plus the offset.
|
|
8330
8455
|
*/
|
|
8331
|
-
remind_at
|
|
8456
|
+
remind_at: string;
|
|
8332
8457
|
}>;
|
|
8333
8458
|
};
|
|
8334
8459
|
/**
|
|
@@ -8374,7 +8499,7 @@ export type AssetsItemFormAssignmentParameters = {
|
|
|
8374
8499
|
/**
|
|
8375
8500
|
* How often this form task recurs: one of DAILY, WORKDAILY, WORKDAILYSIX, WEEKLY, BIWEEKLY, MONTHLY, or QUARTERLY. Null for a one-time assignment; on write, applied only when recurring is true.
|
|
8376
8501
|
*/
|
|
8377
|
-
frequency?: 'DAILY' | 'WORKDAILY' | 'WORKDAILYSIX' | 'WEEKLY' | 'BIWEEKLY' | 'MONTHLY' | 'QUARTERLY';
|
|
8502
|
+
frequency?: 'DAILY' | 'WORKDAILY' | 'WORKDAILYSIX' | 'WEEKLY' | 'BIWEEKLY' | 'MONTHLY' | 'QUARTERLY' | null;
|
|
8378
8503
|
/**
|
|
8379
8504
|
* When recurrence stops (ISO 8601); null for a non-recurring or open-ended task.
|
|
8380
8505
|
*/
|
|
@@ -13096,6 +13221,50 @@ export type ListFormDefinitionsResponses = {
|
|
|
13096
13221
|
200: FormDefinitionResponseObject;
|
|
13097
13222
|
};
|
|
13098
13223
|
export type ListFormDefinitionsResponse = ListFormDefinitionsResponses[keyof ListFormDefinitionsResponses];
|
|
13224
|
+
export type ListFormSubmissionDeltasData = {
|
|
13225
|
+
body?: never;
|
|
13226
|
+
path?: never;
|
|
13227
|
+
query?: {
|
|
13228
|
+
'filter[event]'?: 'create' | 'update' | 'destroy';
|
|
13229
|
+
'filter[created_at][gte]'?: string;
|
|
13230
|
+
'filter[created_at][lte]'?: string;
|
|
13231
|
+
filter?: string;
|
|
13232
|
+
'filter[unexpected]'?: string;
|
|
13233
|
+
/**
|
|
13234
|
+
* This pagination cursor corresponds to the cursor value found in the response in
|
|
13235
|
+
* `meta.page.next_cursor`.
|
|
13236
|
+
*/
|
|
13237
|
+
'page[cursor]'?: string;
|
|
13238
|
+
/**
|
|
13239
|
+
* 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`.
|
|
13240
|
+
*/
|
|
13241
|
+
'page[limit]'?: number;
|
|
13242
|
+
page?: string;
|
|
13243
|
+
};
|
|
13244
|
+
url: '/api/v1/form_submissions/deltas';
|
|
13245
|
+
};
|
|
13246
|
+
export type ListFormSubmissionDeltasErrors = {
|
|
13247
|
+
/**
|
|
13248
|
+
* Bad Request
|
|
13249
|
+
*/
|
|
13250
|
+
400: Problem;
|
|
13251
|
+
/**
|
|
13252
|
+
* Forbidden
|
|
13253
|
+
*/
|
|
13254
|
+
403: Problem;
|
|
13255
|
+
/**
|
|
13256
|
+
* Unprocessable Content
|
|
13257
|
+
*/
|
|
13258
|
+
422: Problem;
|
|
13259
|
+
};
|
|
13260
|
+
export type ListFormSubmissionDeltasError = ListFormSubmissionDeltasErrors[keyof ListFormSubmissionDeltasErrors];
|
|
13261
|
+
export type ListFormSubmissionDeltasResponses = {
|
|
13262
|
+
/**
|
|
13263
|
+
* Success
|
|
13264
|
+
*/
|
|
13265
|
+
200: FormSubmissionDeltasResponse;
|
|
13266
|
+
};
|
|
13267
|
+
export type ListFormSubmissionDeltasResponse = ListFormSubmissionDeltasResponses[keyof ListFormSubmissionDeltasResponses];
|
|
13099
13268
|
export type ListFormSubmissionsData = {
|
|
13100
13269
|
body?: never;
|
|
13101
13270
|
path?: never;
|
|
@@ -13308,6 +13477,10 @@ export type CreateGroupData = {
|
|
|
13308
13477
|
url: '/api/v1/groups';
|
|
13309
13478
|
};
|
|
13310
13479
|
export type CreateGroupErrors = {
|
|
13480
|
+
/**
|
|
13481
|
+
* Bad Request
|
|
13482
|
+
*/
|
|
13483
|
+
400: Problem;
|
|
13311
13484
|
/**
|
|
13312
13485
|
* Forbidden
|
|
13313
13486
|
*/
|
|
@@ -13386,6 +13559,10 @@ export type UpdateGroupData = {
|
|
|
13386
13559
|
url: '/api/v1/groups/{id}';
|
|
13387
13560
|
};
|
|
13388
13561
|
export type UpdateGroupErrors = {
|
|
13562
|
+
/**
|
|
13563
|
+
* Bad Request
|
|
13564
|
+
*/
|
|
13565
|
+
400: Problem;
|
|
13389
13566
|
/**
|
|
13390
13567
|
* Forbidden
|
|
13391
13568
|
*/
|
|
@@ -13612,16 +13789,16 @@ export type ListRateRuleHistoryData = {
|
|
|
13612
13789
|
body?: never;
|
|
13613
13790
|
path: {
|
|
13614
13791
|
job_id: string;
|
|
13615
|
-
|
|
13792
|
+
wage_determination_id: string;
|
|
13616
13793
|
/**
|
|
13617
|
-
* The rule's version-stable identity, as returned in `
|
|
13794
|
+
* The rule's version-stable identity, as returned in `id`.
|
|
13618
13795
|
*/
|
|
13619
|
-
|
|
13796
|
+
rate_rule_id: string;
|
|
13620
13797
|
};
|
|
13621
13798
|
query?: {
|
|
13622
13799
|
'as_of[valid]'?: string;
|
|
13623
13800
|
};
|
|
13624
|
-
url: '/api/v1/jobs/{job_id}/wage_determinations/{
|
|
13801
|
+
url: '/api/v1/jobs/{job_id}/wage_determinations/{wage_determination_id}/rate_rules/{rate_rule_id}/history';
|
|
13625
13802
|
};
|
|
13626
13803
|
export type ListRateRuleHistoryErrors = {
|
|
13627
13804
|
/**
|
|
@@ -13653,7 +13830,7 @@ export type ListRateRulesData = {
|
|
|
13653
13830
|
body?: never;
|
|
13654
13831
|
path: {
|
|
13655
13832
|
job_id: string;
|
|
13656
|
-
|
|
13833
|
+
wage_determination_id: string;
|
|
13657
13834
|
};
|
|
13658
13835
|
query?: {
|
|
13659
13836
|
/**
|
|
@@ -13665,7 +13842,7 @@ export type ListRateRulesData = {
|
|
|
13665
13842
|
'as_of[valid][gte]'?: string;
|
|
13666
13843
|
'as_of[transaction]'?: string;
|
|
13667
13844
|
};
|
|
13668
|
-
url: '/api/v1/jobs/{job_id}/wage_determinations/{
|
|
13845
|
+
url: '/api/v1/jobs/{job_id}/wage_determinations/{wage_determination_id}/rate_rules';
|
|
13669
13846
|
};
|
|
13670
13847
|
export type ListRateRulesErrors = {
|
|
13671
13848
|
/**
|
|
@@ -13697,10 +13874,10 @@ export type CreateRateRuleData = {
|
|
|
13697
13874
|
body: RateRuleParameters;
|
|
13698
13875
|
path: {
|
|
13699
13876
|
job_id: string;
|
|
13700
|
-
|
|
13877
|
+
wage_determination_id: string;
|
|
13701
13878
|
};
|
|
13702
13879
|
query?: never;
|
|
13703
|
-
url: '/api/v1/jobs/{job_id}/wage_determinations/{
|
|
13880
|
+
url: '/api/v1/jobs/{job_id}/wage_determinations/{wage_determination_id}/rate_rules';
|
|
13704
13881
|
};
|
|
13705
13882
|
export type CreateRateRuleErrors = {
|
|
13706
13883
|
/**
|
|
@@ -13724,8 +13901,8 @@ export type GetRateRuleData = {
|
|
|
13724
13901
|
body?: never;
|
|
13725
13902
|
path: {
|
|
13726
13903
|
job_id: string;
|
|
13727
|
-
|
|
13728
|
-
|
|
13904
|
+
wage_determination_id: string;
|
|
13905
|
+
id: string;
|
|
13729
13906
|
};
|
|
13730
13907
|
query?: {
|
|
13731
13908
|
/**
|
|
@@ -13733,7 +13910,7 @@ export type GetRateRuleData = {
|
|
|
13733
13910
|
*/
|
|
13734
13911
|
'as_of[valid]'?: string;
|
|
13735
13912
|
};
|
|
13736
|
-
url: '/api/v1/jobs/{job_id}/wage_determinations/{
|
|
13913
|
+
url: '/api/v1/jobs/{job_id}/wage_determinations/{wage_determination_id}/rate_rules/{id}';
|
|
13737
13914
|
};
|
|
13738
13915
|
export type GetRateRuleErrors = {
|
|
13739
13916
|
/**
|
|
@@ -13758,14 +13935,14 @@ export type ListJobWageDeterminationHistoryData = {
|
|
|
13758
13935
|
path: {
|
|
13759
13936
|
job_id: string;
|
|
13760
13937
|
/**
|
|
13761
|
-
* The determination's version-stable identity, as returned in `
|
|
13938
|
+
* The determination's version-stable identity, as returned in `id`.
|
|
13762
13939
|
*/
|
|
13763
|
-
|
|
13940
|
+
wage_determination_id: string;
|
|
13764
13941
|
};
|
|
13765
13942
|
query?: {
|
|
13766
13943
|
'as_of[valid]'?: string;
|
|
13767
13944
|
};
|
|
13768
|
-
url: '/api/v1/jobs/{job_id}/wage_determinations/{
|
|
13945
|
+
url: '/api/v1/jobs/{job_id}/wage_determinations/{wage_determination_id}/history';
|
|
13769
13946
|
};
|
|
13770
13947
|
export type ListJobWageDeterminationHistoryErrors = {
|
|
13771
13948
|
/**
|
|
@@ -13872,10 +14049,10 @@ export type DeleteWageDeterminationData = {
|
|
|
13872
14049
|
};
|
|
13873
14050
|
path: {
|
|
13874
14051
|
job_id: string;
|
|
13875
|
-
|
|
14052
|
+
id: string;
|
|
13876
14053
|
};
|
|
13877
14054
|
query?: never;
|
|
13878
|
-
url: '/api/v1/jobs/{job_id}/wage_determinations/{
|
|
14055
|
+
url: '/api/v1/jobs/{job_id}/wage_determinations/{id}';
|
|
13879
14056
|
};
|
|
13880
14057
|
export type DeleteWageDeterminationErrors = {
|
|
13881
14058
|
/**
|
|
@@ -13911,7 +14088,7 @@ export type GetJobWageDeterminationData = {
|
|
|
13911
14088
|
body?: never;
|
|
13912
14089
|
path: {
|
|
13913
14090
|
job_id: string;
|
|
13914
|
-
|
|
14091
|
+
id: string;
|
|
13915
14092
|
};
|
|
13916
14093
|
query?: {
|
|
13917
14094
|
/**
|
|
@@ -13919,7 +14096,7 @@ export type GetJobWageDeterminationData = {
|
|
|
13919
14096
|
*/
|
|
13920
14097
|
'as_of[valid]'?: string;
|
|
13921
14098
|
};
|
|
13922
|
-
url: '/api/v1/jobs/{job_id}/wage_determinations/{
|
|
14099
|
+
url: '/api/v1/jobs/{job_id}/wage_determinations/{id}';
|
|
13923
14100
|
};
|
|
13924
14101
|
export type GetJobWageDeterminationErrors = {
|
|
13925
14102
|
/**
|
|
@@ -14264,7 +14441,7 @@ export type ListExternalMapHistoryData = {
|
|
|
14264
14441
|
body?: never;
|
|
14265
14442
|
path: {
|
|
14266
14443
|
/**
|
|
14267
|
-
* The external map's version-stable identity, as returned in `
|
|
14444
|
+
* The external map's version-stable identity, as returned in `id`.
|
|
14268
14445
|
*/
|
|
14269
14446
|
external_map_id: string;
|
|
14270
14447
|
};
|
|
@@ -14314,7 +14491,7 @@ export type ListExternalMapsData = {
|
|
|
14314
14491
|
/**
|
|
14315
14492
|
* Narrow to one pay schedule
|
|
14316
14493
|
*/
|
|
14317
|
-
'filter[
|
|
14494
|
+
'filter[timekeeping_pay_period_config_id]'?: string;
|
|
14318
14495
|
/**
|
|
14319
14496
|
* true → only global maps; false → only company-owned
|
|
14320
14497
|
*/
|
|
@@ -14417,7 +14594,7 @@ export type ListFringeBenefitPlansData = {
|
|
|
14417
14594
|
/**
|
|
14418
14595
|
* Narrow to one pay schedule
|
|
14419
14596
|
*/
|
|
14420
|
-
'filter[
|
|
14597
|
+
'filter[timekeeping_pay_period_config_id]'?: string;
|
|
14421
14598
|
filter?: string;
|
|
14422
14599
|
'filter[unexpected]'?: string;
|
|
14423
14600
|
/**
|
|
@@ -14971,6 +15148,10 @@ export type DeletePaystubErrors = {
|
|
|
14971
15148
|
* Not Found
|
|
14972
15149
|
*/
|
|
14973
15150
|
404: Problem;
|
|
15151
|
+
/**
|
|
15152
|
+
* Unprocessable Content
|
|
15153
|
+
*/
|
|
15154
|
+
422: Problem;
|
|
14974
15155
|
};
|
|
14975
15156
|
export type DeletePaystubError = DeletePaystubErrors[keyof DeletePaystubErrors];
|
|
14976
15157
|
export type DeletePaystubResponses = {
|
|
@@ -15110,6 +15291,10 @@ export type CreatePerDiemData = {
|
|
|
15110
15291
|
url: '/api/v1/per_diems';
|
|
15111
15292
|
};
|
|
15112
15293
|
export type CreatePerDiemErrors = {
|
|
15294
|
+
/**
|
|
15295
|
+
* Bad Request
|
|
15296
|
+
*/
|
|
15297
|
+
400: Problem;
|
|
15113
15298
|
/**
|
|
15114
15299
|
* Forbidden
|
|
15115
15300
|
*/
|
|
@@ -15201,6 +15386,10 @@ export type UpdatePerDiemData = {
|
|
|
15201
15386
|
url: '/api/v1/per_diems/{id}';
|
|
15202
15387
|
};
|
|
15203
15388
|
export type UpdatePerDiemErrors = {
|
|
15389
|
+
/**
|
|
15390
|
+
* Bad Request
|
|
15391
|
+
*/
|
|
15392
|
+
400: Problem;
|
|
15204
15393
|
/**
|
|
15205
15394
|
* Forbidden
|
|
15206
15395
|
*/
|
|
@@ -15264,6 +15453,10 @@ export type CreatePositionFunctionData = {
|
|
|
15264
15453
|
url: '/api/v1/position_functions';
|
|
15265
15454
|
};
|
|
15266
15455
|
export type CreatePositionFunctionErrors = {
|
|
15456
|
+
/**
|
|
15457
|
+
* Bad Request
|
|
15458
|
+
*/
|
|
15459
|
+
400: Problem;
|
|
15267
15460
|
/**
|
|
15268
15461
|
* Forbidden
|
|
15269
15462
|
*/
|
|
@@ -15346,6 +15539,10 @@ export type UpdatePositionFunctionData = {
|
|
|
15346
15539
|
url: '/api/v1/position_functions/{id}';
|
|
15347
15540
|
};
|
|
15348
15541
|
export type UpdatePositionFunctionErrors = {
|
|
15542
|
+
/**
|
|
15543
|
+
* Bad Request
|
|
15544
|
+
*/
|
|
15545
|
+
400: Problem;
|
|
15349
15546
|
/**
|
|
15350
15547
|
* Forbidden
|
|
15351
15548
|
*/
|
|
@@ -15951,6 +16148,10 @@ export type CreatePositionData = {
|
|
|
15951
16148
|
url: '/api/v1/jobs/{job_id}/positions';
|
|
15952
16149
|
};
|
|
15953
16150
|
export type CreatePositionErrors = {
|
|
16151
|
+
/**
|
|
16152
|
+
* Bad Request
|
|
16153
|
+
*/
|
|
16154
|
+
400: Problem;
|
|
15954
16155
|
/**
|
|
15955
16156
|
* Forbidden
|
|
15956
16157
|
*/
|
|
@@ -15978,6 +16179,10 @@ export type UpdatePositionData = {
|
|
|
15978
16179
|
url: '/api/v1/jobs/{job_id}/positions/{id}';
|
|
15979
16180
|
};
|
|
15980
16181
|
export type UpdatePositionErrors = {
|
|
16182
|
+
/**
|
|
16183
|
+
* Bad Request
|
|
16184
|
+
*/
|
|
16185
|
+
400: Problem;
|
|
15981
16186
|
/**
|
|
15982
16187
|
* Forbidden
|
|
15983
16188
|
*/
|
|
@@ -16527,6 +16732,10 @@ export type CreateTimeEntryData = {
|
|
|
16527
16732
|
url: '/api/v1/time_entries';
|
|
16528
16733
|
};
|
|
16529
16734
|
export type CreateTimeEntryErrors = {
|
|
16735
|
+
/**
|
|
16736
|
+
* Bad Request
|
|
16737
|
+
*/
|
|
16738
|
+
400: Problem;
|
|
16530
16739
|
/**
|
|
16531
16740
|
* Forbidden
|
|
16532
16741
|
*/
|
|
@@ -16585,6 +16794,10 @@ export type UpdateTimeEntryData = {
|
|
|
16585
16794
|
url: '/api/v1/time_entries/{id}';
|
|
16586
16795
|
};
|
|
16587
16796
|
export type UpdateTimeEntryErrors = {
|
|
16797
|
+
/**
|
|
16798
|
+
* Bad Request
|
|
16799
|
+
*/
|
|
16800
|
+
400: Problem;
|
|
16588
16801
|
/**
|
|
16589
16802
|
* Forbidden
|
|
16590
16803
|
*/
|
|
@@ -17193,10 +17406,10 @@ export type CreateManagerTimeEntryApprovalResponse = CreateManagerTimeEntryAppro
|
|
|
17193
17406
|
export type ListAttestationConfigsData = {
|
|
17194
17407
|
body?: never;
|
|
17195
17408
|
path: {
|
|
17196
|
-
|
|
17409
|
+
pay_period_config_id: string;
|
|
17197
17410
|
};
|
|
17198
17411
|
query?: never;
|
|
17199
|
-
url: '/api/v1/timekeeping/pay_period_configs/{
|
|
17412
|
+
url: '/api/v1/timekeeping/pay_period_configs/{pay_period_config_id}/attestation_configs';
|
|
17200
17413
|
};
|
|
17201
17414
|
export type ListAttestationConfigsErrors = {
|
|
17202
17415
|
/**
|
|
@@ -17223,10 +17436,10 @@ export type ListAttestationConfigsResponse = ListAttestationConfigsResponses[key
|
|
|
17223
17436
|
export type CreateAttestationConfigData = {
|
|
17224
17437
|
body?: AttestationConfigParameters;
|
|
17225
17438
|
path: {
|
|
17226
|
-
|
|
17439
|
+
pay_period_config_id: string;
|
|
17227
17440
|
};
|
|
17228
17441
|
query?: never;
|
|
17229
|
-
url: '/api/v1/timekeeping/pay_period_configs/{
|
|
17442
|
+
url: '/api/v1/timekeeping/pay_period_configs/{pay_period_config_id}/attestation_configs';
|
|
17230
17443
|
};
|
|
17231
17444
|
export type CreateAttestationConfigErrors = {
|
|
17232
17445
|
/**
|
|
@@ -17253,11 +17466,11 @@ export type CreateAttestationConfigResponse = CreateAttestationConfigResponses[k
|
|
|
17253
17466
|
export type DeleteAttestationConfigData = {
|
|
17254
17467
|
body?: never;
|
|
17255
17468
|
path: {
|
|
17256
|
-
|
|
17469
|
+
pay_period_config_id: string;
|
|
17257
17470
|
id: string;
|
|
17258
17471
|
};
|
|
17259
17472
|
query?: never;
|
|
17260
|
-
url: '/api/v1/timekeeping/pay_period_configs/{
|
|
17473
|
+
url: '/api/v1/timekeeping/pay_period_configs/{pay_period_config_id}/attestation_configs/{id}';
|
|
17261
17474
|
};
|
|
17262
17475
|
export type DeleteAttestationConfigErrors = {
|
|
17263
17476
|
/**
|
|
@@ -17280,11 +17493,11 @@ export type DeleteAttestationConfigResponse = DeleteAttestationConfigResponses[k
|
|
|
17280
17493
|
export type GetAttestationConfigData = {
|
|
17281
17494
|
body?: never;
|
|
17282
17495
|
path: {
|
|
17283
|
-
|
|
17496
|
+
pay_period_config_id: string;
|
|
17284
17497
|
id: string;
|
|
17285
17498
|
};
|
|
17286
17499
|
query?: never;
|
|
17287
|
-
url: '/api/v1/timekeeping/pay_period_configs/{
|
|
17500
|
+
url: '/api/v1/timekeeping/pay_period_configs/{pay_period_config_id}/attestation_configs/{id}';
|
|
17288
17501
|
};
|
|
17289
17502
|
export type GetAttestationConfigErrors = {
|
|
17290
17503
|
/**
|
|
@@ -17308,14 +17521,14 @@ export type ListPayPeriodConfigHistoryData = {
|
|
|
17308
17521
|
body?: never;
|
|
17309
17522
|
path: {
|
|
17310
17523
|
/**
|
|
17311
|
-
* The pay schedule's version-stable identity, as returned in `
|
|
17524
|
+
* The pay schedule's version-stable identity, as returned in `id`.
|
|
17312
17525
|
*/
|
|
17313
|
-
|
|
17526
|
+
pay_period_config_id: string;
|
|
17314
17527
|
};
|
|
17315
17528
|
query?: {
|
|
17316
17529
|
'as_of[valid]'?: string;
|
|
17317
17530
|
};
|
|
17318
|
-
url: '/api/v1/timekeeping/pay_period_configs/{
|
|
17531
|
+
url: '/api/v1/timekeeping/pay_period_configs/{pay_period_config_id}/history';
|
|
17319
17532
|
};
|
|
17320
17533
|
export type ListPayPeriodConfigHistoryErrors = {
|
|
17321
17534
|
/**
|
|
@@ -17347,9 +17560,9 @@ export type ListHolidaysData = {
|
|
|
17347
17560
|
body?: never;
|
|
17348
17561
|
path: {
|
|
17349
17562
|
/**
|
|
17350
|
-
*
|
|
17563
|
+
* ID of the pay schedule
|
|
17351
17564
|
*/
|
|
17352
|
-
|
|
17565
|
+
pay_period_config_id: string;
|
|
17353
17566
|
};
|
|
17354
17567
|
query?: {
|
|
17355
17568
|
/**
|
|
@@ -17377,7 +17590,7 @@ export type ListHolidaysData = {
|
|
|
17377
17590
|
'page[limit]'?: number;
|
|
17378
17591
|
page?: string;
|
|
17379
17592
|
};
|
|
17380
|
-
url: '/api/v1/timekeeping/pay_period_configs/{
|
|
17593
|
+
url: '/api/v1/timekeeping/pay_period_configs/{pay_period_config_id}/holidays';
|
|
17381
17594
|
};
|
|
17382
17595
|
export type ListHolidaysErrors = {
|
|
17383
17596
|
/**
|
|
@@ -17413,14 +17626,18 @@ export type CreateHolidayData = {
|
|
|
17413
17626
|
body: HolidayParameters;
|
|
17414
17627
|
path: {
|
|
17415
17628
|
/**
|
|
17416
|
-
*
|
|
17629
|
+
* ID of the pay schedule
|
|
17417
17630
|
*/
|
|
17418
|
-
|
|
17631
|
+
pay_period_config_id: string;
|
|
17419
17632
|
};
|
|
17420
17633
|
query?: never;
|
|
17421
|
-
url: '/api/v1/timekeeping/pay_period_configs/{
|
|
17634
|
+
url: '/api/v1/timekeeping/pay_period_configs/{pay_period_config_id}/holidays';
|
|
17422
17635
|
};
|
|
17423
17636
|
export type CreateHolidayErrors = {
|
|
17637
|
+
/**
|
|
17638
|
+
* Bad Request
|
|
17639
|
+
*/
|
|
17640
|
+
400: Problem;
|
|
17424
17641
|
/**
|
|
17425
17642
|
* Forbidden
|
|
17426
17643
|
*/
|
|
@@ -17446,13 +17663,13 @@ export type DeleteHolidayData = {
|
|
|
17446
17663
|
body?: never;
|
|
17447
17664
|
path: {
|
|
17448
17665
|
/**
|
|
17449
|
-
*
|
|
17666
|
+
* ID of the pay schedule
|
|
17450
17667
|
*/
|
|
17451
|
-
|
|
17668
|
+
pay_period_config_id: string;
|
|
17452
17669
|
id: string;
|
|
17453
17670
|
};
|
|
17454
17671
|
query?: never;
|
|
17455
|
-
url: '/api/v1/timekeeping/pay_period_configs/{
|
|
17672
|
+
url: '/api/v1/timekeeping/pay_period_configs/{pay_period_config_id}/holidays/{id}';
|
|
17456
17673
|
};
|
|
17457
17674
|
export type DeleteHolidayErrors = {
|
|
17458
17675
|
/**
|
|
@@ -17472,15 +17689,19 @@ export type UpdateHolidayData = {
|
|
|
17472
17689
|
body: HolidayParameters;
|
|
17473
17690
|
path: {
|
|
17474
17691
|
/**
|
|
17475
|
-
*
|
|
17692
|
+
* ID of the pay schedule
|
|
17476
17693
|
*/
|
|
17477
|
-
|
|
17694
|
+
pay_period_config_id: string;
|
|
17478
17695
|
id: string;
|
|
17479
17696
|
};
|
|
17480
17697
|
query?: never;
|
|
17481
|
-
url: '/api/v1/timekeeping/pay_period_configs/{
|
|
17698
|
+
url: '/api/v1/timekeeping/pay_period_configs/{pay_period_config_id}/holidays/{id}';
|
|
17482
17699
|
};
|
|
17483
17700
|
export type UpdateHolidayErrors = {
|
|
17701
|
+
/**
|
|
17702
|
+
* Bad Request
|
|
17703
|
+
*/
|
|
17704
|
+
400: Problem;
|
|
17484
17705
|
/**
|
|
17485
17706
|
* Forbidden
|
|
17486
17707
|
*/
|
|
@@ -17552,7 +17773,7 @@ export type ListPayPeriodConfigsResponse = ListPayPeriodConfigsResponses[keyof L
|
|
|
17552
17773
|
export type GetPayPeriodConfigData = {
|
|
17553
17774
|
body?: never;
|
|
17554
17775
|
path: {
|
|
17555
|
-
|
|
17776
|
+
id: string;
|
|
17556
17777
|
};
|
|
17557
17778
|
query?: {
|
|
17558
17779
|
/**
|
|
@@ -17560,7 +17781,7 @@ export type GetPayPeriodConfigData = {
|
|
|
17560
17781
|
*/
|
|
17561
17782
|
'as_of[valid]'?: string;
|
|
17562
17783
|
};
|
|
17563
|
-
url: '/api/v1/timekeeping/pay_period_configs/{
|
|
17784
|
+
url: '/api/v1/timekeeping/pay_period_configs/{id}';
|
|
17564
17785
|
};
|
|
17565
17786
|
export type GetPayPeriodConfigErrors = {
|
|
17566
17787
|
/**
|