@dsptch-work/api-client 0.18.0 → 0.19.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 +38 -0
- package/dist/gen/index.d.ts +2 -2
- package/dist/gen/index.js +1 -1
- package/dist/gen/sdk.gen.d.ts +91 -7
- package/dist/gen/sdk.gen.js +136 -6
- package/dist/gen/types.gen.d.ts +1377 -96
- package/dist/gen/zod.gen.d.ts +1087 -117
- package/dist/gen/zod.gen.js +658 -43
- package/package.json +1 -1
package/dist/gen/types.gen.d.ts
CHANGED
|
@@ -767,6 +767,29 @@ export type ApprenticeshipApprenticeResponseObject = {
|
|
|
767
767
|
*/
|
|
768
768
|
updated_at: string;
|
|
769
769
|
};
|
|
770
|
+
export type ApprenticeshipAllocationResponseObject = {
|
|
771
|
+
id: string;
|
|
772
|
+
apprenticeship_apprentice_id: string;
|
|
773
|
+
apprenticeship_work_process_category_id: string | null;
|
|
774
|
+
allocated_by_user_id: string;
|
|
775
|
+
timekeeping_time_card_id: string | null;
|
|
776
|
+
minutes: number;
|
|
777
|
+
description: string | null;
|
|
778
|
+
allocated_at: string;
|
|
779
|
+
cumulative_minutes: number;
|
|
780
|
+
apprenticeship_wage_schedule_period_id: string;
|
|
781
|
+
created_at: string;
|
|
782
|
+
updated_at: string;
|
|
783
|
+
};
|
|
784
|
+
/**
|
|
785
|
+
* Correct the effective timestamp of an existing standalone allocation. Time-card-linked allocations cannot be date-corrected. A changed timestamp rebuilds progression and requests historical wage repricing in the background, including locked time cards.
|
|
786
|
+
*/
|
|
787
|
+
export type ApprenticeshipAllocationUpdateParameters = {
|
|
788
|
+
/**
|
|
789
|
+
* Effective timestamp for the credited hours, as ISO 8601 with an explicit UTC offset or Z. Optional; omission leaves the timestamp unchanged, and null is rejected. The employer-local date must be today or earlier and may predate enrollment. An unchanged timestamp does not request repricing.
|
|
790
|
+
*/
|
|
791
|
+
allocated_at?: string;
|
|
792
|
+
};
|
|
770
793
|
/**
|
|
771
794
|
* Enroll a user as an apprentice under an employer in a program; the employing program-employer record is derived from the enrolling company and the program in the URL path. Apprentices cannot be updated through the API, only created.
|
|
772
795
|
*/
|
|
@@ -805,7 +828,7 @@ export type ApprenticeshipApprenticeParameters = {
|
|
|
805
828
|
operative_end_date?: string | null;
|
|
806
829
|
};
|
|
807
830
|
/**
|
|
808
|
-
* Create
|
|
831
|
+
* Create an apprenticeship program sponsored by your company; the sponsor is always your company and is never taken from the request body.
|
|
809
832
|
*/
|
|
810
833
|
export type ApprenticeshipProgramParameters = {
|
|
811
834
|
/**
|
|
@@ -830,7 +853,32 @@ export type ApprenticeshipProgramParameters = {
|
|
|
830
853
|
registration_agency_type?: 'federal' | 'regional' | null;
|
|
831
854
|
};
|
|
832
855
|
/**
|
|
833
|
-
*
|
|
856
|
+
* Update an apprenticeship program sponsored by your company. Send only the fields to change; the sponsor is fixed to your company.
|
|
857
|
+
*/
|
|
858
|
+
export type ApprenticeshipProgramUpdateParameters = {
|
|
859
|
+
/**
|
|
860
|
+
* DOL- or state-agency-assigned registration number for the program; unique per sponsor company. Omit to leave it unchanged.
|
|
861
|
+
*/
|
|
862
|
+
program_number?: string;
|
|
863
|
+
/**
|
|
864
|
+
* Human-readable name for the program; omit to leave it unchanged, or send null to clear.
|
|
865
|
+
*/
|
|
866
|
+
program_name?: string | null;
|
|
867
|
+
/**
|
|
868
|
+
* Official name of the sponsoring organization; omit to leave it unchanged, or send null to clear.
|
|
869
|
+
*/
|
|
870
|
+
sponsor_name?: string | null;
|
|
871
|
+
/**
|
|
872
|
+
* Name the sponsor operates under; omit to leave it unchanged, or send null to clear.
|
|
873
|
+
*/
|
|
874
|
+
doing_business_as?: string | null;
|
|
875
|
+
/**
|
|
876
|
+
* Agency that registered the program: federal or regional; omit to leave it unchanged, or send null to clear.
|
|
877
|
+
*/
|
|
878
|
+
registration_agency_type?: 'federal' | 'regional' | null;
|
|
879
|
+
};
|
|
880
|
+
/**
|
|
881
|
+
* Create an occupation (trade) within a sponsored program; the program is taken from the URL path.
|
|
834
882
|
*/
|
|
835
883
|
export type ApprenticeshipOccupationParameters = {
|
|
836
884
|
/**
|
|
@@ -871,7 +919,48 @@ export type ApprenticeshipOccupationParameters = {
|
|
|
871
919
|
num_journeyworkers: number;
|
|
872
920
|
};
|
|
873
921
|
/**
|
|
874
|
-
*
|
|
922
|
+
* Update an occupation (trade) within a sponsored program. Send only the fields to change; the program is taken from the URL path.
|
|
923
|
+
*/
|
|
924
|
+
export type ApprenticeshipOccupationUpdateParameters = {
|
|
925
|
+
/**
|
|
926
|
+
* DOL RAPIDS code identifying this occupation. Omit to leave it unchanged.
|
|
927
|
+
*/
|
|
928
|
+
rapids_code?: string;
|
|
929
|
+
/**
|
|
930
|
+
* How apprentices progress through this occupation: time_based, competency_based, or hybrid. Omit to leave it unchanged.
|
|
931
|
+
*/
|
|
932
|
+
occupation_type?: 'time_based' | 'competency_based' | 'hybrid';
|
|
933
|
+
/**
|
|
934
|
+
* Trade title for the occupation (e.g. "Electrician"). Omit to leave it unchanged.
|
|
935
|
+
*/
|
|
936
|
+
title?: string;
|
|
937
|
+
/**
|
|
938
|
+
* Description of the occupation; omit to leave it unchanged, or send null to clear.
|
|
939
|
+
*/
|
|
940
|
+
description?: string | null;
|
|
941
|
+
/**
|
|
942
|
+
* Minimum total on-the-job minutes required to complete the occupation. Omit to leave it unchanged.
|
|
943
|
+
*/
|
|
944
|
+
min_minutes?: number;
|
|
945
|
+
/**
|
|
946
|
+
* Maximum total on-the-job minutes allowed for the occupation; must exceed min_minutes. Omit to leave it unchanged.
|
|
947
|
+
*/
|
|
948
|
+
max_minutes?: number;
|
|
949
|
+
/**
|
|
950
|
+
* Length of the occupation's initial probationary period, in minutes. Omit to leave it unchanged.
|
|
951
|
+
*/
|
|
952
|
+
probation_minutes?: number;
|
|
953
|
+
/**
|
|
954
|
+
* Apprentice side of the apprentice-to-journeyworker ratio. Omit to leave it unchanged.
|
|
955
|
+
*/
|
|
956
|
+
num_apprentices?: number;
|
|
957
|
+
/**
|
|
958
|
+
* Journeyworker side of the apprentice-to-journeyworker ratio. Omit to leave it unchanged.
|
|
959
|
+
*/
|
|
960
|
+
num_journeyworkers?: number;
|
|
961
|
+
};
|
|
962
|
+
/**
|
|
963
|
+
* Create an authorization for an employer to employ apprentices in a program; only the program's sponsor may manage this roster.
|
|
875
964
|
*/
|
|
876
965
|
export type ApprenticeshipProgramEmployerParameters = {
|
|
877
966
|
/**
|
|
@@ -884,7 +973,20 @@ export type ApprenticeshipProgramEmployerParameters = {
|
|
|
884
973
|
require_timecard_allocation?: boolean;
|
|
885
974
|
};
|
|
886
975
|
/**
|
|
887
|
-
*
|
|
976
|
+
* Update an employer authorization in a program. Send only the fields to change; only the program's sponsor may manage this roster.
|
|
977
|
+
*/
|
|
978
|
+
export type ApprenticeshipProgramEmployerUpdateParameters = {
|
|
979
|
+
/**
|
|
980
|
+
* ID of the company authorized as an employer in this program. It cannot be changed once the employer has apprentices; omit to leave it unchanged.
|
|
981
|
+
*/
|
|
982
|
+
company_id?: string;
|
|
983
|
+
/**
|
|
984
|
+
* Whether this employer's apprentices must allocate apprenticeship hours from DSPTCH time cards rather than recording them standalone; omit to leave it unchanged.
|
|
985
|
+
*/
|
|
986
|
+
require_timecard_allocation?: boolean;
|
|
987
|
+
};
|
|
988
|
+
/**
|
|
989
|
+
* Create a period on a wage schedule; the wage schedule is taken from the URL path. wage_cents is sent as integer cents.
|
|
888
990
|
*/
|
|
889
991
|
export type ApprenticeshipWageSchedulePeriodParameters = {
|
|
890
992
|
/**
|
|
@@ -917,7 +1019,40 @@ export type ApprenticeshipWageSchedulePeriodParameters = {
|
|
|
917
1019
|
wage_cents: number;
|
|
918
1020
|
};
|
|
919
1021
|
/**
|
|
920
|
-
*
|
|
1022
|
+
* Update a period on a wage schedule. Send only the fields to change; the wage schedule is taken from the URL path and wage_cents is sent as integer cents.
|
|
1023
|
+
*/
|
|
1024
|
+
export type ApprenticeshipWageSchedulePeriodUpdateParameters = {
|
|
1025
|
+
/**
|
|
1026
|
+
* 0-indexed position of this period in the progression; omit to leave it unchanged.
|
|
1027
|
+
*/
|
|
1028
|
+
period_number?: number;
|
|
1029
|
+
/**
|
|
1030
|
+
* Duration of this period, in on-the-job minutes spent within it — not a cumulative threshold; omit to leave it unchanged, or send null to clear. A newly added period must set at least one of min_minutes, max_minutes, or num_competencies.
|
|
1031
|
+
*/
|
|
1032
|
+
min_minutes?: number | null;
|
|
1033
|
+
/**
|
|
1034
|
+
* Upper bound on this period's duration, in minutes; informational only, not used to compute advancement; omit to leave it unchanged, or send null to clear. A newly added period must set at least one of min_minutes, max_minutes, or num_competencies.
|
|
1035
|
+
*/
|
|
1036
|
+
max_minutes?: number | null;
|
|
1037
|
+
/**
|
|
1038
|
+
* Number of competencies required to complete this period; omit to leave it unchanged, or send null to clear. A newly added period must set at least one of min_minutes, max_minutes, or num_competencies.
|
|
1039
|
+
*/
|
|
1040
|
+
num_competencies?: number | null;
|
|
1041
|
+
/**
|
|
1042
|
+
* Free-text description of this period; optional, null to clear.
|
|
1043
|
+
*/
|
|
1044
|
+
description?: string | null;
|
|
1045
|
+
/**
|
|
1046
|
+
* Percentage of the journeyworker wage paid during this period (e.g. 75 for 75%); omit to leave it unchanged.
|
|
1047
|
+
*/
|
|
1048
|
+
wage_percent?: number;
|
|
1049
|
+
/**
|
|
1050
|
+
* Wage rate for this period, in cents; omit to leave it unchanged.
|
|
1051
|
+
*/
|
|
1052
|
+
wage_cents?: number;
|
|
1053
|
+
};
|
|
1054
|
+
/**
|
|
1055
|
+
* Create a wage schedule for an occupation; the occupation is taken from the URL path. Money is sent as integer cents; periods may be created inline via periods_attributes.
|
|
921
1056
|
*/
|
|
922
1057
|
export type ApprenticeshipWageScheduleParameters = {
|
|
923
1058
|
/**
|
|
@@ -990,6 +1125,88 @@ export type ApprenticeshipWageScheduleParameters = {
|
|
|
990
1125
|
_destroy?: boolean;
|
|
991
1126
|
}>;
|
|
992
1127
|
};
|
|
1128
|
+
/**
|
|
1129
|
+
* Update a wage schedule for an occupation. Send only the fields to change; money is sent as integer cents and periods may be created, updated, or removed inline via periods_attributes.
|
|
1130
|
+
*/
|
|
1131
|
+
export type ApprenticeshipWageScheduleUpdateParameters = {
|
|
1132
|
+
/**
|
|
1133
|
+
* Human-readable name for the wage schedule; omit to leave it unchanged.
|
|
1134
|
+
*/
|
|
1135
|
+
name?: string;
|
|
1136
|
+
/**
|
|
1137
|
+
* Free-text description of the wage schedule; omit to leave it unchanged, or send null to clear.
|
|
1138
|
+
*/
|
|
1139
|
+
description?: string | null;
|
|
1140
|
+
/**
|
|
1141
|
+
* Pay frequency for each period's wage_cents: hourly, weekly, monthly, quarterly, semi_annually, or annually. Omit to leave it unchanged.
|
|
1142
|
+
*/
|
|
1143
|
+
wage_unit?: 'hourly' | 'weekly' | 'monthly' | 'quarterly' | 'semi_annually' | 'annually';
|
|
1144
|
+
/**
|
|
1145
|
+
* Pay frequency for journeyworker_wage_cents: hourly, weekly, monthly, quarterly, semi_annually, or annually. Omit to leave it unchanged.
|
|
1146
|
+
*/
|
|
1147
|
+
journeyworker_wage_unit?: 'hourly' | 'weekly' | 'monthly' | 'quarterly' | 'semi_annually' | 'annually';
|
|
1148
|
+
/**
|
|
1149
|
+
* Display unit for the periods: hours, weeks, months, quarter, semi_annual, or year. Omit to leave it unchanged.
|
|
1150
|
+
*/
|
|
1151
|
+
period_unit?: 'hours' | 'weeks' | 'months' | 'quarter' | 'semi_annual' | 'year';
|
|
1152
|
+
/**
|
|
1153
|
+
* Journeyworker wage to progress toward, in cents; omit to leave it unchanged.
|
|
1154
|
+
*/
|
|
1155
|
+
journeyworker_wage_cents?: number;
|
|
1156
|
+
/**
|
|
1157
|
+
* Wage at the end of the progression, in cents; omit to leave it unchanged.
|
|
1158
|
+
*/
|
|
1159
|
+
end_wage_cents?: number;
|
|
1160
|
+
/**
|
|
1161
|
+
* Periods to create, update, or remove alongside the schedule; omit a period's id to add one, include its id to update it, or send its id with _destroy true to remove it.
|
|
1162
|
+
*/
|
|
1163
|
+
periods_attributes?: Array<(unknown | {
|
|
1164
|
+
min_minutes: number;
|
|
1165
|
+
} | {
|
|
1166
|
+
max_minutes: number;
|
|
1167
|
+
} | {
|
|
1168
|
+
num_competencies: number;
|
|
1169
|
+
} | {
|
|
1170
|
+
_destroy: true;
|
|
1171
|
+
}) & {
|
|
1172
|
+
/**
|
|
1173
|
+
* Unique identifier.
|
|
1174
|
+
*/
|
|
1175
|
+
id?: string;
|
|
1176
|
+
/**
|
|
1177
|
+
* 0-indexed position of this period in the progression; omit to leave it unchanged.
|
|
1178
|
+
*/
|
|
1179
|
+
period_number?: number;
|
|
1180
|
+
/**
|
|
1181
|
+
* Duration of this period, in on-the-job minutes spent within it — not a cumulative threshold; omit to leave it unchanged, or send null to clear. A newly added period must set at least one of min_minutes, max_minutes, or num_competencies.
|
|
1182
|
+
*/
|
|
1183
|
+
min_minutes?: number | null;
|
|
1184
|
+
/**
|
|
1185
|
+
* Upper bound on this period's duration, in minutes; informational only, not used to compute advancement; omit to leave it unchanged, or send null to clear. A newly added period must set at least one of min_minutes, max_minutes, or num_competencies.
|
|
1186
|
+
*/
|
|
1187
|
+
max_minutes?: number | null;
|
|
1188
|
+
/**
|
|
1189
|
+
* Number of competencies required to complete this period; omit to leave it unchanged, or send null to clear. A newly added period must set at least one of min_minutes, max_minutes, or num_competencies.
|
|
1190
|
+
*/
|
|
1191
|
+
num_competencies?: number | null;
|
|
1192
|
+
/**
|
|
1193
|
+
* Free-text description of this period; optional, null to clear.
|
|
1194
|
+
*/
|
|
1195
|
+
description?: string | null;
|
|
1196
|
+
/**
|
|
1197
|
+
* Percentage of the journeyworker wage paid during this period (e.g. 75 for 75%); omit to leave it unchanged.
|
|
1198
|
+
*/
|
|
1199
|
+
wage_percent?: number;
|
|
1200
|
+
/**
|
|
1201
|
+
* Wage rate for this period, in cents; omit to leave it unchanged.
|
|
1202
|
+
*/
|
|
1203
|
+
wage_cents?: number;
|
|
1204
|
+
/**
|
|
1205
|
+
* Set to true, together with the period's id, to remove that period from the schedule.
|
|
1206
|
+
*/
|
|
1207
|
+
_destroy?: boolean;
|
|
1208
|
+
}>;
|
|
1209
|
+
};
|
|
993
1210
|
/**
|
|
994
1211
|
* A work-type classification that determines how tracked time is treated — paid vs unpaid, overtime-eligible, billable, PWA/prevailing-wage-eligible, holiday, PTO, or rest-and-recovery — versioned bitemporally so each version carries its own validity window.
|
|
995
1212
|
*/
|
|
@@ -1087,6 +1304,185 @@ export type TimecodeResponseObject = {
|
|
|
1087
1304
|
*/
|
|
1088
1305
|
updated_at: string;
|
|
1089
1306
|
};
|
|
1307
|
+
/**
|
|
1308
|
+
* An employment stint in the credential company. Its id is stable across valid-time versions; a rehire is a separate stint with a new id. A read returns only a version covering now or as_of[valid].
|
|
1309
|
+
*/
|
|
1310
|
+
export type PeopleEmploymentResponseObject = {
|
|
1311
|
+
/**
|
|
1312
|
+
* Version-stable identity for this employment stint.
|
|
1313
|
+
*/
|
|
1314
|
+
id: string;
|
|
1315
|
+
/**
|
|
1316
|
+
* ID of the employed person.
|
|
1317
|
+
*/
|
|
1318
|
+
user_id: string;
|
|
1319
|
+
/**
|
|
1320
|
+
* ID of the employing company; always the credential company.
|
|
1321
|
+
*/
|
|
1322
|
+
company_id: string;
|
|
1323
|
+
/**
|
|
1324
|
+
* Whether the relationship is EMPLOYEE or CONTRACTOR.
|
|
1325
|
+
*/
|
|
1326
|
+
type: 'EMPLOYEE' | 'CONTRACTOR';
|
|
1327
|
+
/**
|
|
1328
|
+
* Employment title; null when unset.
|
|
1329
|
+
*/
|
|
1330
|
+
title: string | null;
|
|
1331
|
+
/**
|
|
1332
|
+
* Whether pay is hourly or salary.
|
|
1333
|
+
*/
|
|
1334
|
+
compensation_type: 'hourly' | 'salary';
|
|
1335
|
+
/**
|
|
1336
|
+
* Payroll-system identifier; null when unset.
|
|
1337
|
+
*/
|
|
1338
|
+
payroll_id: string | null;
|
|
1339
|
+
/**
|
|
1340
|
+
* Manager ID; null when unset.
|
|
1341
|
+
*/
|
|
1342
|
+
manager_user_id: string | null;
|
|
1343
|
+
/**
|
|
1344
|
+
* Department ID; null when unset.
|
|
1345
|
+
*/
|
|
1346
|
+
companies_department_id: string | null;
|
|
1347
|
+
/**
|
|
1348
|
+
* Whether this employment is enrolled in time and attendance.
|
|
1349
|
+
*/
|
|
1350
|
+
enrolled_in_t_and_a: boolean;
|
|
1351
|
+
/**
|
|
1352
|
+
* Whether this employment is overtime eligible; null when unset.
|
|
1353
|
+
*/
|
|
1354
|
+
overtime_eligible: boolean | null;
|
|
1355
|
+
/**
|
|
1356
|
+
* Overtime package ID; null when unset.
|
|
1357
|
+
*/
|
|
1358
|
+
overtime_package_id: string | null;
|
|
1359
|
+
/**
|
|
1360
|
+
* Pay-rate rules package ID; null when unset.
|
|
1361
|
+
*/
|
|
1362
|
+
pay_rates_rule_package_id: string | null;
|
|
1363
|
+
/**
|
|
1364
|
+
* Pay-rates package ID; null when unset.
|
|
1365
|
+
*/
|
|
1366
|
+
pay_rates_package_id: string | null;
|
|
1367
|
+
/**
|
|
1368
|
+
* Annual worked minutes; null when unset.
|
|
1369
|
+
*/
|
|
1370
|
+
worked_annual_minutes: number | null;
|
|
1371
|
+
/**
|
|
1372
|
+
* Annual paid-time-off minutes; null when unset.
|
|
1373
|
+
*/
|
|
1374
|
+
pto_annual_minutes: number | null;
|
|
1375
|
+
/**
|
|
1376
|
+
* Annual holiday minutes; null when unset.
|
|
1377
|
+
*/
|
|
1378
|
+
holiday_annual_minutes: number | null;
|
|
1379
|
+
/**
|
|
1380
|
+
* Annual training minutes; null when unset.
|
|
1381
|
+
*/
|
|
1382
|
+
training_annual_minutes: number | null;
|
|
1383
|
+
/**
|
|
1384
|
+
* Hourly pay in cents as a decimal string; null when unset.
|
|
1385
|
+
*/
|
|
1386
|
+
hourly_rate_cents: string | null;
|
|
1387
|
+
/**
|
|
1388
|
+
* Annual training amount in cents as a decimal string; null when unset.
|
|
1389
|
+
*/
|
|
1390
|
+
training_annual_amount_cents: string | null;
|
|
1391
|
+
/**
|
|
1392
|
+
* Employer health amount in cents as a decimal string; null when unset.
|
|
1393
|
+
*/
|
|
1394
|
+
employer_combined_health_amount_cents: string | null;
|
|
1395
|
+
/**
|
|
1396
|
+
* Employer savings amount in cents as a decimal string; null when unset.
|
|
1397
|
+
*/
|
|
1398
|
+
employer_combined_savings_cents: string | null;
|
|
1399
|
+
/**
|
|
1400
|
+
* Currency from the company's current pay schedule, or the system default when it has none. It is company configuration context rather than historical employment data.
|
|
1401
|
+
*/
|
|
1402
|
+
currency: string;
|
|
1403
|
+
/**
|
|
1404
|
+
* ISO8601 timestamp when this version starts; null for an unbounded lower bound.
|
|
1405
|
+
*/
|
|
1406
|
+
valid_from: string | null;
|
|
1407
|
+
/**
|
|
1408
|
+
* ISO8601 timestamp when this version ends; null for an open-ended version.
|
|
1409
|
+
*/
|
|
1410
|
+
valid_to: string | null;
|
|
1411
|
+
/**
|
|
1412
|
+
* ISO8601 timestamp when this stored version was created.
|
|
1413
|
+
*/
|
|
1414
|
+
created_at: string;
|
|
1415
|
+
/**
|
|
1416
|
+
* ISO8601 timestamp when this stored version was last updated.
|
|
1417
|
+
*/
|
|
1418
|
+
updated_at: string;
|
|
1419
|
+
};
|
|
1420
|
+
export type PeopleEmploymentHistoryCorrectionObject = {
|
|
1421
|
+
/**
|
|
1422
|
+
* 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.
|
|
1423
|
+
*/
|
|
1424
|
+
people_employment_id: string;
|
|
1425
|
+
user_id: string;
|
|
1426
|
+
company_id: string;
|
|
1427
|
+
type: 'EMPLOYEE' | 'CONTRACTOR';
|
|
1428
|
+
title: string | null;
|
|
1429
|
+
compensation_type: 'hourly' | 'salary';
|
|
1430
|
+
payroll_id: string | null;
|
|
1431
|
+
manager_user_id: string | null;
|
|
1432
|
+
companies_department_id: string | null;
|
|
1433
|
+
enrolled_in_t_and_a: boolean;
|
|
1434
|
+
overtime_eligible: boolean | null;
|
|
1435
|
+
overtime_package_id: string | null;
|
|
1436
|
+
pay_rates_rule_package_id: string | null;
|
|
1437
|
+
pay_rates_package_id: string | null;
|
|
1438
|
+
worked_annual_minutes: number | null;
|
|
1439
|
+
pto_annual_minutes: number | null;
|
|
1440
|
+
holiday_annual_minutes: number | null;
|
|
1441
|
+
training_annual_minutes: number | null;
|
|
1442
|
+
hourly_rate_cents: string | null;
|
|
1443
|
+
training_annual_amount_cents: string | null;
|
|
1444
|
+
employer_combined_health_amount_cents: string | null;
|
|
1445
|
+
employer_combined_savings_cents: string | null;
|
|
1446
|
+
currency: string;
|
|
1447
|
+
valid_from: string | null;
|
|
1448
|
+
valid_to: string | null;
|
|
1449
|
+
created_at: string;
|
|
1450
|
+
updated_at: string;
|
|
1451
|
+
};
|
|
1452
|
+
export type PeopleEmploymentHistoryVersionObject = {
|
|
1453
|
+
/**
|
|
1454
|
+
* 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.
|
|
1455
|
+
*/
|
|
1456
|
+
people_employment_id: string;
|
|
1457
|
+
user_id: string;
|
|
1458
|
+
company_id: string;
|
|
1459
|
+
type: 'EMPLOYEE' | 'CONTRACTOR';
|
|
1460
|
+
title: string | null;
|
|
1461
|
+
compensation_type: 'hourly' | 'salary';
|
|
1462
|
+
payroll_id: string | null;
|
|
1463
|
+
manager_user_id: string | null;
|
|
1464
|
+
companies_department_id: string | null;
|
|
1465
|
+
enrolled_in_t_and_a: boolean;
|
|
1466
|
+
overtime_eligible: boolean | null;
|
|
1467
|
+
overtime_package_id: string | null;
|
|
1468
|
+
pay_rates_rule_package_id: string | null;
|
|
1469
|
+
pay_rates_package_id: string | null;
|
|
1470
|
+
worked_annual_minutes: number | null;
|
|
1471
|
+
pto_annual_minutes: number | null;
|
|
1472
|
+
holiday_annual_minutes: number | null;
|
|
1473
|
+
training_annual_minutes: number | null;
|
|
1474
|
+
hourly_rate_cents: string | null;
|
|
1475
|
+
training_annual_amount_cents: string | null;
|
|
1476
|
+
employer_combined_health_amount_cents: string | null;
|
|
1477
|
+
employer_combined_savings_cents: string | null;
|
|
1478
|
+
currency: string;
|
|
1479
|
+
valid_from: string | null;
|
|
1480
|
+
valid_to: string | null;
|
|
1481
|
+
created_at: string;
|
|
1482
|
+
updated_at: string;
|
|
1483
|
+
version_status: 'scheduled' | 'current' | 'historical';
|
|
1484
|
+
corrections: Array<PeopleEmploymentHistoryCorrectionObject>;
|
|
1485
|
+
};
|
|
1090
1486
|
export type TimecodeHistoryCorrectionObject = {
|
|
1091
1487
|
/**
|
|
1092
1488
|
* 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.
|
|
@@ -1214,34 +1610,85 @@ export type TimecodeParameters = {
|
|
|
1214
1610
|
*/
|
|
1215
1611
|
effective_date?: string;
|
|
1216
1612
|
};
|
|
1613
|
+
/**
|
|
1614
|
+
* Request body for correcting a timecode over a valid-time span. Send only the fields to change; omitted fields retain their current values. `effective_from` defaults to the addressed version's start, and `effective_to` is optional.
|
|
1615
|
+
*/
|
|
1217
1616
|
export type TimecodeCorrectionParameters = {
|
|
1218
1617
|
/**
|
|
1219
1618
|
* Where the correction starts applying. Defaults to the addressed version's own start.
|
|
1220
1619
|
*/
|
|
1221
1620
|
effective_from?: string;
|
|
1222
1621
|
/**
|
|
1223
|
-
* Where the correction stops applying
|
|
1622
|
+
* Where the correction stops applying; it must be later than `effective_from`. Omit to correct through the end of the segment containing `effective_from`, preserving later scheduled changes.
|
|
1224
1623
|
*/
|
|
1225
1624
|
effective_to?: string;
|
|
1226
|
-
|
|
1625
|
+
/**
|
|
1626
|
+
* Human-readable name of the timecode. Send it to change the name; omitted on update to retain the existing name.
|
|
1627
|
+
*/
|
|
1628
|
+
name?: string;
|
|
1629
|
+
/**
|
|
1630
|
+
* Optional free-text description; `null` clears it and a blank value is stored as null.
|
|
1631
|
+
*/
|
|
1227
1632
|
description?: string | null;
|
|
1633
|
+
/**
|
|
1634
|
+
* Whether users must supply a description when logging time against this timecode.
|
|
1635
|
+
*/
|
|
1228
1636
|
description_is_required?: boolean;
|
|
1637
|
+
/**
|
|
1638
|
+
* Whether tracked time is billable to the customer.
|
|
1639
|
+
*/
|
|
1229
1640
|
billable?: boolean;
|
|
1641
|
+
/**
|
|
1642
|
+
* Whether tracked time counts toward overtime calculations.
|
|
1643
|
+
*/
|
|
1230
1644
|
overtime_eligible?: boolean;
|
|
1645
|
+
/**
|
|
1646
|
+
* Whether tracked time is unpaid.
|
|
1647
|
+
*/
|
|
1231
1648
|
unpaid?: boolean;
|
|
1649
|
+
/**
|
|
1650
|
+
* Whether the timecode represents holiday time.
|
|
1651
|
+
*/
|
|
1232
1652
|
holiday?: boolean;
|
|
1653
|
+
/**
|
|
1654
|
+
* Whether the timecode represents paid time off.
|
|
1655
|
+
*/
|
|
1233
1656
|
pto?: boolean;
|
|
1657
|
+
/**
|
|
1658
|
+
* Whether the timecode represents a safety hour or safety-related task.
|
|
1659
|
+
*/
|
|
1234
1660
|
safety?: boolean;
|
|
1661
|
+
/**
|
|
1662
|
+
* Whether this timecode is the company's lunch-break shortcut.
|
|
1663
|
+
*/
|
|
1235
1664
|
lunch_shortcut?: boolean;
|
|
1665
|
+
/**
|
|
1666
|
+
* Whether this timecode is the company's rest-break shortcut.
|
|
1667
|
+
*/
|
|
1236
1668
|
break_shortcut?: boolean;
|
|
1669
|
+
/**
|
|
1670
|
+
* Whether tracked time is eligible for prevailing-wage (PWA) calculations. Cannot be true when restricted_to is non_job.
|
|
1671
|
+
*/
|
|
1237
1672
|
pwa?: boolean;
|
|
1673
|
+
/**
|
|
1674
|
+
* Whether the timecode represents rest-and-recovery time.
|
|
1675
|
+
*/
|
|
1238
1676
|
rest_and_recovery?: boolean;
|
|
1677
|
+
/**
|
|
1678
|
+
* Whether tracked time is eligible for incentive (holiday) pay.
|
|
1679
|
+
*/
|
|
1239
1680
|
incentive_pay_eligible?: boolean;
|
|
1681
|
+
/**
|
|
1682
|
+
* Where the timecode may be applied: none, job, non_job, or job_with_timecode.
|
|
1683
|
+
*/
|
|
1240
1684
|
restricted_to?: 'none' | 'job' | 'non_job' | 'job_with_timecode';
|
|
1241
1685
|
};
|
|
1686
|
+
/**
|
|
1687
|
+
* Request body for moving the beginning of a timecode's valid-time timeline. Moving it earlier extends coverage; moving it later removes coverage before the new beginning.
|
|
1688
|
+
*/
|
|
1242
1689
|
export type TimecodeGenesisParameters = {
|
|
1243
1690
|
/**
|
|
1244
|
-
* The
|
|
1691
|
+
* The new beginning of the timecode's valid-time timeline. Required; the shift is refused if it would orphan recorded time or leave no coverage.
|
|
1245
1692
|
*/
|
|
1246
1693
|
effective_date: string;
|
|
1247
1694
|
};
|
|
@@ -1587,11 +2034,11 @@ export type PerDiemResponseObject = {
|
|
|
1587
2034
|
updated_at: string;
|
|
1588
2035
|
};
|
|
1589
2036
|
/**
|
|
1590
|
-
*
|
|
2037
|
+
* Request body for creating a per diem. name, currency, and rate_cents are required.
|
|
1591
2038
|
*/
|
|
1592
2039
|
export type PerDiemParameters = {
|
|
1593
2040
|
/**
|
|
1594
|
-
* Human-readable name, e.g. "Travel Meals".
|
|
2041
|
+
* Human-readable name, e.g. "Travel Meals". Required.
|
|
1595
2042
|
*/
|
|
1596
2043
|
name: string;
|
|
1597
2044
|
/**
|
|
@@ -1599,11 +2046,11 @@ export type PerDiemParameters = {
|
|
|
1599
2046
|
*/
|
|
1600
2047
|
description?: string | null;
|
|
1601
2048
|
/**
|
|
1602
|
-
* Allowance amount in cents, as a string (e.g. "7500" is $75.00).
|
|
2049
|
+
* Allowance amount in cents, as a string (e.g. "7500" is $75.00). Required.
|
|
1603
2050
|
*/
|
|
1604
2051
|
rate_cents: string;
|
|
1605
2052
|
/**
|
|
1606
|
-
* ISO 4217 currency code, e.g. "USD".
|
|
2053
|
+
* ISO 4217 currency code, e.g. "USD". Required.
|
|
1607
2054
|
*/
|
|
1608
2055
|
currency: string;
|
|
1609
2056
|
/**
|
|
@@ -1627,6 +2074,47 @@ export type PerDiemParameters = {
|
|
|
1627
2074
|
*/
|
|
1628
2075
|
timekeeping_timecode_ids?: Array<string>;
|
|
1629
2076
|
};
|
|
2077
|
+
/**
|
|
2078
|
+
* Request body for updating a per diem. Send only the fields to change.
|
|
2079
|
+
*/
|
|
2080
|
+
export type PerDiemUpdateParameters = {
|
|
2081
|
+
/**
|
|
2082
|
+
* Human-readable name, e.g. "Travel Meals". Omit to leave it unchanged.
|
|
2083
|
+
*/
|
|
2084
|
+
name?: string;
|
|
2085
|
+
/**
|
|
2086
|
+
* Optional free-text notes; omit to leave them unchanged, or send null to clear them.
|
|
2087
|
+
*/
|
|
2088
|
+
description?: string | null;
|
|
2089
|
+
/**
|
|
2090
|
+
* Allowance amount in cents, as a string (e.g. "7500" is $75.00). Omit to leave it unchanged.
|
|
2091
|
+
*/
|
|
2092
|
+
rate_cents?: string;
|
|
2093
|
+
/**
|
|
2094
|
+
* ISO 4217 currency code, e.g. "USD". Omit to leave it unchanged.
|
|
2095
|
+
*/
|
|
2096
|
+
currency?: string;
|
|
2097
|
+
/**
|
|
2098
|
+
* Whether the allowance is treated as taxable income. Omit to leave it unchanged.
|
|
2099
|
+
*/
|
|
2100
|
+
taxable?: boolean;
|
|
2101
|
+
/**
|
|
2102
|
+
* Whether this should become the company default per diem. Omit to leave it unchanged.
|
|
2103
|
+
*/
|
|
2104
|
+
default?: boolean | null;
|
|
2105
|
+
/**
|
|
2106
|
+
* Whether the per diem is active and available to use. Omit to leave it unchanged.
|
|
2107
|
+
*/
|
|
2108
|
+
active?: boolean | null;
|
|
2109
|
+
/**
|
|
2110
|
+
* Complete set of work type IDs this per diem applies to. Omit to leave it unchanged.
|
|
2111
|
+
*/
|
|
2112
|
+
work_type_ids?: Array<string>;
|
|
2113
|
+
/**
|
|
2114
|
+
* Complete set of timecode IDs this per diem applies to. Omit to leave it unchanged.
|
|
2115
|
+
*/
|
|
2116
|
+
timekeeping_timecode_ids?: Array<string>;
|
|
2117
|
+
};
|
|
1630
2118
|
/**
|
|
1631
2119
|
* The product's filled attribute values — one entry per attribute assigned to its category.
|
|
1632
2120
|
*/
|
|
@@ -1724,6 +2212,40 @@ export type AssetsAttributeParameters = {
|
|
|
1724
2212
|
_destroy?: boolean;
|
|
1725
2213
|
}>;
|
|
1726
2214
|
};
|
|
2215
|
+
/**
|
|
2216
|
+
* Update an attribute definition. All fields are optional — send only what changes. Options apply only to a select attribute and are ignored otherwise; data_type cannot be changed once any value has been filled.
|
|
2217
|
+
*/
|
|
2218
|
+
export type AssetsAttributeUpdateParameters = {
|
|
2219
|
+
/**
|
|
2220
|
+
* The attribute's name.
|
|
2221
|
+
*/
|
|
2222
|
+
name?: string;
|
|
2223
|
+
/**
|
|
2224
|
+
* Kind of value the attribute holds: one of text, number, date, boolean, or select. A select attribute takes its value from a predefined option; the others store a typed literal.
|
|
2225
|
+
*/
|
|
2226
|
+
data_type?: 'text' | 'number' | 'date' | 'boolean' | 'select';
|
|
2227
|
+
/**
|
|
2228
|
+
* Choices for a select attribute, ignored for other data types. Include id to update an existing option, omit id to add one, or set _destroy to remove one.
|
|
2229
|
+
*/
|
|
2230
|
+
options?: Array<{
|
|
2231
|
+
/**
|
|
2232
|
+
* Unique identifier.
|
|
2233
|
+
*/
|
|
2234
|
+
id?: string;
|
|
2235
|
+
/**
|
|
2236
|
+
* The option's label.
|
|
2237
|
+
*/
|
|
2238
|
+
value?: string;
|
|
2239
|
+
/**
|
|
2240
|
+
* Display order within the list (0-based).
|
|
2241
|
+
*/
|
|
2242
|
+
position?: number;
|
|
2243
|
+
/**
|
|
2244
|
+
* Set true to remove this entry.
|
|
2245
|
+
*/
|
|
2246
|
+
_destroy?: boolean;
|
|
2247
|
+
}>;
|
|
2248
|
+
};
|
|
1727
2249
|
/**
|
|
1728
2250
|
* A node in the company's asset category tree. Categories classify products and, through their attribute assignments, set which custom fields those products and items carry.
|
|
1729
2251
|
*/
|
|
@@ -1824,6 +2346,48 @@ export type AssetsCategoryParameters = {
|
|
|
1824
2346
|
_destroy?: boolean;
|
|
1825
2347
|
}>;
|
|
1826
2348
|
};
|
|
2349
|
+
/**
|
|
2350
|
+
* Update a category. All fields are optional — send only what changes. `category_attributes` sets this category's direct attribute assignments.
|
|
2351
|
+
*/
|
|
2352
|
+
export type AssetsCategoryUpdateParameters = {
|
|
2353
|
+
/**
|
|
2354
|
+
* The category's name.
|
|
2355
|
+
*/
|
|
2356
|
+
name?: string;
|
|
2357
|
+
/**
|
|
2358
|
+
* ID of the parent category; null for a root category.
|
|
2359
|
+
*/
|
|
2360
|
+
parent_id?: string | null;
|
|
2361
|
+
/**
|
|
2362
|
+
* Attribute assignments for this category. Include id to update an existing assignment, omit id to add one, or set _destroy to remove one.
|
|
2363
|
+
*/
|
|
2364
|
+
category_attributes?: Array<{
|
|
2365
|
+
/**
|
|
2366
|
+
* Unique identifier.
|
|
2367
|
+
*/
|
|
2368
|
+
id?: string;
|
|
2369
|
+
/**
|
|
2370
|
+
* ID of the attribute definition.
|
|
2371
|
+
*/
|
|
2372
|
+
assets_attribute_id: string;
|
|
2373
|
+
/**
|
|
2374
|
+
* Where this attribute is filled in for the category: product (on the catalog product) or item (on each individual item).
|
|
2375
|
+
*/
|
|
2376
|
+
fillable_on: 'product' | 'item';
|
|
2377
|
+
/**
|
|
2378
|
+
* Whether a value for this attribute must be provided.
|
|
2379
|
+
*/
|
|
2380
|
+
required?: boolean;
|
|
2381
|
+
/**
|
|
2382
|
+
* Display order within the list (0-based).
|
|
2383
|
+
*/
|
|
2384
|
+
position?: number;
|
|
2385
|
+
/**
|
|
2386
|
+
* Set true to remove this entry.
|
|
2387
|
+
*/
|
|
2388
|
+
_destroy?: boolean;
|
|
2389
|
+
}>;
|
|
2390
|
+
};
|
|
1827
2391
|
/**
|
|
1828
2392
|
* A company department that workers can be assigned to.
|
|
1829
2393
|
*/
|
|
@@ -1854,7 +2418,7 @@ export type DepartmentResponseObject = {
|
|
|
1854
2418
|
updated_at: string;
|
|
1855
2419
|
};
|
|
1856
2420
|
/**
|
|
1857
|
-
* Request body for creating
|
|
2421
|
+
* Request body for creating a department.
|
|
1858
2422
|
*/
|
|
1859
2423
|
export type DepartmentParameters = {
|
|
1860
2424
|
/**
|
|
@@ -1866,6 +2430,19 @@ export type DepartmentParameters = {
|
|
|
1866
2430
|
*/
|
|
1867
2431
|
description?: string | null;
|
|
1868
2432
|
};
|
|
2433
|
+
/**
|
|
2434
|
+
* Request body for updating a department. Send only the fields to change.
|
|
2435
|
+
*/
|
|
2436
|
+
export type DepartmentUpdateParameters = {
|
|
2437
|
+
/**
|
|
2438
|
+
* Department name; unique within the company. Omit to leave it unchanged.
|
|
2439
|
+
*/
|
|
2440
|
+
name?: string;
|
|
2441
|
+
/**
|
|
2442
|
+
* Optional free-text description; null clears it.
|
|
2443
|
+
*/
|
|
2444
|
+
description?: string | null;
|
|
2445
|
+
};
|
|
1869
2446
|
/**
|
|
1870
2447
|
* A per-diem allowance recorded on a time card for a specific date. Its rate, currency, and taxable flag are snapshotted from the referenced catalog per diem when saved.
|
|
1871
2448
|
*/
|
|
@@ -1912,7 +2489,7 @@ export type TimeCardPerDiemResponseObject = {
|
|
|
1912
2489
|
updated_at: string;
|
|
1913
2490
|
};
|
|
1914
2491
|
/**
|
|
1915
|
-
* Request body for recording
|
|
2492
|
+
* Request body for recording a per diem on a time card. The time card is taken from the URL path; the rate, currency, and taxable flag are copied from the referenced catalog per diem when one is supplied, not this body.
|
|
1916
2493
|
*/
|
|
1917
2494
|
export type TimeCardPerDiemParameters = {
|
|
1918
2495
|
/**
|
|
@@ -1924,9 +2501,26 @@ export type TimeCardPerDiemParameters = {
|
|
|
1924
2501
|
*/
|
|
1925
2502
|
approver_user_id: string;
|
|
1926
2503
|
/**
|
|
1927
|
-
* ID of the catalog per diem to record; its rate, currency, and taxable flag are copied onto the entry.
|
|
2504
|
+
* Optional ID of the catalog per diem to record; its rate, currency, and taxable flag are copied onto the entry.
|
|
2505
|
+
*/
|
|
2506
|
+
per_diem_id?: string;
|
|
2507
|
+
};
|
|
2508
|
+
/**
|
|
2509
|
+
* Request body for updating a per diem recorded on a time card. Send only the fields to change; the time card comes from the URL path.
|
|
2510
|
+
*/
|
|
2511
|
+
export type TimeCardPerDiemUpdateParameters = {
|
|
2512
|
+
/**
|
|
2513
|
+
* Calendar date (YYYY-MM-DD) the per diem applies to; must fall within the card's pay period. Omit to leave it unchanged.
|
|
2514
|
+
*/
|
|
2515
|
+
date?: string;
|
|
2516
|
+
/**
|
|
2517
|
+
* ID of the user recorded as approving the per diem. Omit to leave it unchanged.
|
|
2518
|
+
*/
|
|
2519
|
+
approver_user_id?: string;
|
|
2520
|
+
/**
|
|
2521
|
+
* ID of the catalog per diem to record; its rate, currency, and taxable flag are copied onto the entry. Omit to leave it unchanged.
|
|
1928
2522
|
*/
|
|
1929
|
-
per_diem_id
|
|
2523
|
+
per_diem_id?: string;
|
|
1930
2524
|
};
|
|
1931
2525
|
/**
|
|
1932
2526
|
* A holiday on a pay schedule's holiday calendar — a fixed (month + day) or floating (nth weekday of a month) date that gets holiday-pay treatment when a time entry's timecode opts into holiday handling.
|
|
@@ -2177,7 +2771,7 @@ export type PayPeriodConfigHistoryVersionObject = {
|
|
|
2177
2771
|
corrections: Array<PayPeriodConfigHistoryCorrectionObject>;
|
|
2178
2772
|
};
|
|
2179
2773
|
/**
|
|
2180
|
-
* Create
|
|
2774
|
+
* Create 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.
|
|
2181
2775
|
*/
|
|
2182
2776
|
export type HolidayParameters = {
|
|
2183
2777
|
/**
|
|
@@ -2229,6 +2823,59 @@ export type HolidayParameters = {
|
|
|
2229
2823
|
*/
|
|
2230
2824
|
count_hours_for_overtime?: boolean;
|
|
2231
2825
|
};
|
|
2826
|
+
/**
|
|
2827
|
+
* Update a holiday on a pay schedule. Send only the fields to change; the resulting fixed or floating definition must remain complete.
|
|
2828
|
+
*/
|
|
2829
|
+
export type HolidayUpdateParameters = {
|
|
2830
|
+
/**
|
|
2831
|
+
* The holiday's human-readable label (e.g. "Thanksgiving"). Omit to leave it unchanged.
|
|
2832
|
+
*/
|
|
2833
|
+
name?: string;
|
|
2834
|
+
/**
|
|
2835
|
+
* Calendar date (YYYY-MM-DD) the holiday falls on. Omit to let the definition calculate it or to leave the calculated date unchanged.
|
|
2836
|
+
*/
|
|
2837
|
+
date?: string;
|
|
2838
|
+
/**
|
|
2839
|
+
* `fixed` holidays use month + mday; `floating` holidays use month + week + wday. Omit to leave it unchanged.
|
|
2840
|
+
*/
|
|
2841
|
+
holiday_type?: 'fixed' | 'floating';
|
|
2842
|
+
/**
|
|
2843
|
+
* Month 1-12. Omit to leave it unchanged.
|
|
2844
|
+
*/
|
|
2845
|
+
month?: number;
|
|
2846
|
+
/**
|
|
2847
|
+
* Day of month for a fixed holiday. Omit to leave it unchanged.
|
|
2848
|
+
*/
|
|
2849
|
+
mday?: number;
|
|
2850
|
+
/**
|
|
2851
|
+
* Weekday 0-6 (Sunday=0) for a floating holiday. Omit to leave it unchanged.
|
|
2852
|
+
*/
|
|
2853
|
+
wday?: number;
|
|
2854
|
+
/**
|
|
2855
|
+
* Nth weekday of the month for a floating holiday. Omit to leave it unchanged.
|
|
2856
|
+
*/
|
|
2857
|
+
week?: number;
|
|
2858
|
+
/**
|
|
2859
|
+
* Anchor year for date calculation. Omit to leave it unchanged.
|
|
2860
|
+
*/
|
|
2861
|
+
year?: number;
|
|
2862
|
+
/**
|
|
2863
|
+
* Observe on the nearest weekday when it falls on a weekend. Omit to leave it unchanged.
|
|
2864
|
+
*/
|
|
2865
|
+
move_to_weekday?: boolean;
|
|
2866
|
+
/**
|
|
2867
|
+
* Whether overtime rules targeting holidays automatically apply. Omit to leave it unchanged.
|
|
2868
|
+
*/
|
|
2869
|
+
overtime?: boolean;
|
|
2870
|
+
/**
|
|
2871
|
+
* Whether this is a banking holiday. Omit to leave it unchanged.
|
|
2872
|
+
*/
|
|
2873
|
+
banking?: boolean;
|
|
2874
|
+
/**
|
|
2875
|
+
* Whether worked hours count toward overtime; false unless overtime is true. Omit to leave it unchanged.
|
|
2876
|
+
*/
|
|
2877
|
+
count_hours_for_overtime?: boolean;
|
|
2878
|
+
};
|
|
2232
2879
|
/**
|
|
2233
2880
|
* Prevailing-wage / apprenticeship (PWA) compliance details for a worker at a company — home address, demographics, and jurisdiction-specific fields used in certified-payroll and compliance exports. One record per company/user pair.
|
|
2234
2881
|
*/
|
|
@@ -2331,17 +2978,102 @@ export type PwaCompanyUserDetailsResponseObject = {
|
|
|
2331
2978
|
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;
|
|
2332
2979
|
};
|
|
2333
2980
|
/**
|
|
2334
|
-
* Create
|
|
2981
|
+
* Create a worker's PWA compliance details at a company. The company is taken from the API key. user_id names the worker and is required; every other field is optional — send whichever your jurisdiction's certified-payroll export requires. Only the keys listed here are accepted — any other key is rejected with 400 unknown_key.
|
|
2335
2982
|
*/
|
|
2336
2983
|
export type PwaCompanyUserDetailsParameters = {
|
|
2337
2984
|
/**
|
|
2338
|
-
* ID of the
|
|
2985
|
+
* ID of the worker the compliance details belong to. Required on create; rejected on update — the details cannot be moved to another worker, so PATCH refuses the key rather than accepting and ignoring it.
|
|
2339
2986
|
*/
|
|
2340
|
-
|
|
2987
|
+
user_id: string;
|
|
2341
2988
|
/**
|
|
2342
|
-
*
|
|
2989
|
+
* Home street address line 1, for certified-payroll reporting; required together with city, state, and zip when any home-address field is set.
|
|
2343
2990
|
*/
|
|
2344
|
-
|
|
2991
|
+
address1?: string | null;
|
|
2992
|
+
/**
|
|
2993
|
+
* Home street address line 2.
|
|
2994
|
+
*/
|
|
2995
|
+
address2?: string | null;
|
|
2996
|
+
/**
|
|
2997
|
+
* Home address city; required together with address1 when any home-address field is set.
|
|
2998
|
+
*/
|
|
2999
|
+
city?: string | null;
|
|
3000
|
+
/**
|
|
3001
|
+
* Home address two-letter US state code; required together with address1 when any home-address field is set.
|
|
3002
|
+
*/
|
|
3003
|
+
state?: string | null;
|
|
3004
|
+
/**
|
|
3005
|
+
* Home address ZIP code; required together with address1 when any home-address field is set.
|
|
3006
|
+
*/
|
|
3007
|
+
zip?: string | null;
|
|
3008
|
+
/**
|
|
3009
|
+
* Worker race for demographic reporting, as an array of codes (e.g. CAUCASIAN, AFRICAN_AMERICAN, ASIAN, NATIVE_AMERICAN, OTHER, NOT_SPECIFIED).
|
|
3010
|
+
*/
|
|
3011
|
+
race?: Array<'AFRICAN_AMERICAN' | 'ASIAN' | 'CAUCASIAN' | 'NATIVE_AMERICAN' | 'NOT_SPECIFIED' | 'OTHER'> | null;
|
|
3012
|
+
/**
|
|
3013
|
+
* Worker sex for demographic reporting: one of female, male, non_binary, or not_specified.
|
|
3014
|
+
*/
|
|
3015
|
+
sex?: 'female' | 'male' | 'non_binary' | 'not_specified' | null;
|
|
3016
|
+
/**
|
|
3017
|
+
* Local business license number, when a jurisdiction requires it on certified payroll.
|
|
3018
|
+
*/
|
|
3019
|
+
local_business_license?: string | null;
|
|
3020
|
+
/**
|
|
3021
|
+
* Two-letter US state that issued the worker's driver's license.
|
|
3022
|
+
*/
|
|
3023
|
+
drivers_license_state?: string | null;
|
|
3024
|
+
/**
|
|
3025
|
+
* Worker's driver's license number (stored encrypted).
|
|
3026
|
+
*/
|
|
3027
|
+
drivers_license_number?: string | null;
|
|
3028
|
+
/**
|
|
3029
|
+
* Worker Social Security Number (nine digits, stored encrypted), required on certified payroll in some jurisdictions.
|
|
3030
|
+
*/
|
|
3031
|
+
ssn?: string | null;
|
|
3032
|
+
/**
|
|
3033
|
+
* Veteran status per US Census definitions: one of protected_veteran, not_protected_veteran, reserves, guard, or not_specified.
|
|
3034
|
+
*/
|
|
3035
|
+
veteran_status?: 'protected_veteran' | 'not_protected_veteran' | 'reserves' | 'guard' | 'not_specified' | null;
|
|
3036
|
+
/**
|
|
3037
|
+
* Whether the worker is of Hispanic origin per US Census definitions: one of yes, no, or not_specified.
|
|
3038
|
+
*/
|
|
3039
|
+
hispanic_origin?: 'yes' | 'no' | 'not_specified' | null;
|
|
3040
|
+
/**
|
|
3041
|
+
* Number of payroll withholding exemptions reported on California DIR certified payroll (eCPR), 0 to 99.
|
|
3042
|
+
*/
|
|
3043
|
+
ca_dir_withholding_exemptions?: number | null;
|
|
3044
|
+
/**
|
|
3045
|
+
* Whether the worker has a disability, for demographic reporting.
|
|
3046
|
+
*/
|
|
3047
|
+
disabled?: boolean;
|
|
3048
|
+
/**
|
|
3049
|
+
* 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.
|
|
3050
|
+
*/
|
|
3051
|
+
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;
|
|
3052
|
+
/**
|
|
3053
|
+
* Illinois SHINES employment type: one of part_time, full_time, seasonal_temporary, or independent_contract.
|
|
3054
|
+
*/
|
|
3055
|
+
il_shines_employment_type?: 'part_time' | 'full_time' | 'seasonal_temporary' | 'independent_contract' | null;
|
|
3056
|
+
/**
|
|
3057
|
+
* 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.
|
|
3058
|
+
*/
|
|
3059
|
+
il_shines_eep_qualifiers?: Array<'eep_program_completed' | 'foster_care' | 'formerly_incarcerated' | 'equity_investment_eligible_community' | 'self_registered_or_unknown'> | null;
|
|
3060
|
+
/**
|
|
3061
|
+
* Illinois SHINES workforce-program participation, as an array of program codes (e.g. solar_training_pipeline_program, craft_apprenticeship_program). See the schema enum for the full set.
|
|
3062
|
+
*/
|
|
3063
|
+
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;
|
|
3064
|
+
/**
|
|
3065
|
+
* Oregon BOLI workweek schedule: five_eight (five eight-hour days) or four_ten (four ten-hour days).
|
|
3066
|
+
*/
|
|
3067
|
+
or_boli_schedule_type?: 'five_eight' | 'four_ten' | null;
|
|
3068
|
+
/**
|
|
3069
|
+
* Oregon BOLI race classification, as an array of codes (e.g. white, asian, hispanic_or_latino, black_or_african_american).
|
|
3070
|
+
*/
|
|
3071
|
+
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;
|
|
3072
|
+
};
|
|
3073
|
+
/**
|
|
3074
|
+
* Update a worker's PWA compliance details. The company is taken from the API key. Every field is optional — send only what changes, and omitted fields are left unchanged. user_id is absent by design — the company/user pair is fixed at creation, so sending the key is rejected with 400 unknown_key, as is any other key not listed here.
|
|
3075
|
+
*/
|
|
3076
|
+
export type PwaCompanyUserDetailsUpdateParameters = {
|
|
2345
3077
|
/**
|
|
2346
3078
|
* Home street address line 1, for certified-payroll reporting; required together with city, state, and zip when any home-address field is set.
|
|
2347
3079
|
*/
|
|
@@ -3095,7 +3827,7 @@ export type GroupResponseObject = {
|
|
|
3095
3827
|
updated_at: string;
|
|
3096
3828
|
};
|
|
3097
3829
|
/**
|
|
3098
|
-
* Request body for creating
|
|
3830
|
+
* Request body for creating a group.
|
|
3099
3831
|
*/
|
|
3100
3832
|
export type GroupParameters = {
|
|
3101
3833
|
/**
|
|
@@ -3103,6 +3835,15 @@ export type GroupParameters = {
|
|
|
3103
3835
|
*/
|
|
3104
3836
|
name: string;
|
|
3105
3837
|
};
|
|
3838
|
+
/**
|
|
3839
|
+
* Request body for updating a group. Send only the fields to change.
|
|
3840
|
+
*/
|
|
3841
|
+
export type GroupUpdateParameters = {
|
|
3842
|
+
/**
|
|
3843
|
+
* The group's display name; unique within the company. Omit to leave it unchanged.
|
|
3844
|
+
*/
|
|
3845
|
+
name?: string;
|
|
3846
|
+
};
|
|
3106
3847
|
/**
|
|
3107
3848
|
* A worker as your company sees them: the cross-company person merged with their employment record at your company (title, pay, benefits, and accruals), their roles at your company, and optional prevailing-wage compliance details. Your company sees everyone it employs, everyone it has granted a role, and everyone it has invited, which is the same set the web app shows. A role holder or an invitee your company does not employ has no employment record to merge, so the employment fields (employment_id through employment_window, plus manager_user_id) are null for them, no employment custom fields are published for them, and employment_state reads none. There is no delete — removing a worker terminates their employment at the company (see the user-company endpoints), which sets termination_date and drops them from the default list.
|
|
3108
3849
|
*/
|
|
@@ -4258,7 +4999,7 @@ export type PositionFunctionResponseObject = {
|
|
|
4258
4999
|
updated_at: string;
|
|
4259
5000
|
};
|
|
4260
5001
|
/**
|
|
4261
|
-
* Request body for creating
|
|
5002
|
+
* Request body for creating a position function.
|
|
4262
5003
|
*/
|
|
4263
5004
|
export type PositionFunctionParameters = {
|
|
4264
5005
|
/**
|
|
@@ -4270,6 +5011,19 @@ export type PositionFunctionParameters = {
|
|
|
4270
5011
|
*/
|
|
4271
5012
|
description: string;
|
|
4272
5013
|
};
|
|
5014
|
+
/**
|
|
5015
|
+
* Request body for updating a position function. Send only the fields to change.
|
|
5016
|
+
*/
|
|
5017
|
+
export type PositionFunctionUpdateParameters = {
|
|
5018
|
+
/**
|
|
5019
|
+
* The function name (e.g. "Electrician", "Foreman"). Omit to leave it unchanged.
|
|
5020
|
+
*/
|
|
5021
|
+
value?: string;
|
|
5022
|
+
/**
|
|
5023
|
+
* What the function covers. Omit to leave it unchanged.
|
|
5024
|
+
*/
|
|
5025
|
+
description?: string;
|
|
5026
|
+
};
|
|
4273
5027
|
export type CompanyResponseObject = {
|
|
4274
5028
|
id: string;
|
|
4275
5029
|
name: string;
|
|
@@ -5536,7 +6290,7 @@ export type PayrollFringeBenefitPlanResponseObject = {
|
|
|
5536
6290
|
updated_at: string;
|
|
5537
6291
|
};
|
|
5538
6292
|
/**
|
|
5539
|
-
* Request body for creating
|
|
6293
|
+
* Request body for creating a fringe-benefit plan. timekeeping_pay_period_config_id, name, plan_number, and benefit_category are required.
|
|
5540
6294
|
*/
|
|
5541
6295
|
export type PayrollFringeBenefitPlanParameters = {
|
|
5542
6296
|
/**
|
|
@@ -5596,6 +6350,67 @@ export type PayrollFringeBenefitPlanParameters = {
|
|
|
5596
6350
|
*/
|
|
5597
6351
|
il_admin_name?: string | null;
|
|
5598
6352
|
};
|
|
6353
|
+
/**
|
|
6354
|
+
* Request body for updating a fringe-benefit plan. Send only the fields to change.
|
|
6355
|
+
*/
|
|
6356
|
+
export type PayrollFringeBenefitPlanUpdateParameters = {
|
|
6357
|
+
/**
|
|
6358
|
+
* ID of the pay schedule that owns the plan, stable across all of its versions. Omit to leave it unchanged.
|
|
6359
|
+
*/
|
|
6360
|
+
timekeeping_pay_period_config_id?: string;
|
|
6361
|
+
/**
|
|
6362
|
+
* Human-readable name of the plan. Omit to leave it unchanged.
|
|
6363
|
+
*/
|
|
6364
|
+
name?: string;
|
|
6365
|
+
/**
|
|
6366
|
+
* Three-digit plan number, reported together with the company EIN. Omit to leave it unchanged.
|
|
6367
|
+
*/
|
|
6368
|
+
plan_number?: string;
|
|
6369
|
+
/**
|
|
6370
|
+
* Whether contributions are paid into a bona-fide benefit plan. Omit to leave it unchanged.
|
|
6371
|
+
*/
|
|
6372
|
+
funded?: boolean;
|
|
6373
|
+
/**
|
|
6374
|
+
* Which employer contribution the plan covers. Omit to leave it unchanged.
|
|
6375
|
+
*/
|
|
6376
|
+
benefit_category?: 'employer_combined_health' | 'employer_combined_savings' | 'employer_combined_holiday_pto' | 'employer_training' | 'employer_other_contributions';
|
|
6377
|
+
/**
|
|
6378
|
+
* Whether this is a jointly-managed (Taft-Hartley) fund. Omit to leave it unchanged.
|
|
6379
|
+
*/
|
|
6380
|
+
il_jointly_managed?: boolean;
|
|
6381
|
+
/**
|
|
6382
|
+
* Illinois certified-payroll fund name; omit to leave it unchanged. The resulting value must be present for a non-jointly-managed Illinois plan; send null only when it is not required.
|
|
6383
|
+
*/
|
|
6384
|
+
il_fund_name?: string | null;
|
|
6385
|
+
/**
|
|
6386
|
+
* Illinois fund street address line 1; omit to leave it unchanged. The resulting value must be present for a non-jointly-managed Illinois plan; send null only when it is not required.
|
|
6387
|
+
*/
|
|
6388
|
+
il_fund_address1?: string | null;
|
|
6389
|
+
/**
|
|
6390
|
+
* Illinois fund street address line 2; omit to leave it unchanged, or send null to clear it.
|
|
6391
|
+
*/
|
|
6392
|
+
il_fund_address2?: string | null;
|
|
6393
|
+
/**
|
|
6394
|
+
* Illinois fund city; omit to leave it unchanged. The resulting value must be present for a non-jointly-managed Illinois plan; send null only when it is not required.
|
|
6395
|
+
*/
|
|
6396
|
+
il_fund_city?: string | null;
|
|
6397
|
+
/**
|
|
6398
|
+
* Illinois fund two-letter US state code; omit to leave it unchanged. The resulting value must be present for a non-jointly-managed Illinois plan; send null only when it is not required.
|
|
6399
|
+
*/
|
|
6400
|
+
il_fund_state?: string | null;
|
|
6401
|
+
/**
|
|
6402
|
+
* Illinois fund ZIP code; omit to leave it unchanged. The resulting value must be present for a non-jointly-managed Illinois plan; send null only when it is not required.
|
|
6403
|
+
*/
|
|
6404
|
+
il_fund_zip?: string | null;
|
|
6405
|
+
/**
|
|
6406
|
+
* Illinois fund sponsor name; omit to leave it unchanged, or send null to clear it.
|
|
6407
|
+
*/
|
|
6408
|
+
il_sponsor_name?: string | null;
|
|
6409
|
+
/**
|
|
6410
|
+
* Illinois fund administrator name; omit to leave it unchanged. The resulting value must be present for a non-jointly-managed Illinois plan; send null only when it is not required.
|
|
6411
|
+
*/
|
|
6412
|
+
il_admin_name?: string | null;
|
|
6413
|
+
};
|
|
5599
6414
|
/**
|
|
5600
6415
|
* A mapping from an external payroll or benefits system's field name to a DSPTCH compensation element, so imported paystub line items can be normalized. Bitemporal and read-only; a null pay schedule means the map is global (shared across companies).
|
|
5601
6416
|
*/
|
|
@@ -5757,11 +6572,11 @@ export type PayrollRunResponseObject = {
|
|
|
5757
6572
|
updated_at: string;
|
|
5758
6573
|
};
|
|
5759
6574
|
/**
|
|
5760
|
-
*
|
|
6575
|
+
* Create a payroll run. company_id, run_type, and run_date are required; an on-cycle run additionally requires timekeeping_pay_period_id. Only the keys listed here are accepted — any other key is rejected with 400 unknown_key.
|
|
5761
6576
|
*/
|
|
5762
6577
|
export type PayrollRunParameters = {
|
|
5763
6578
|
/**
|
|
5764
|
-
* ID of the company the run belongs to. Required.
|
|
6579
|
+
* ID of the company the run belongs to. Required on create; rejected on update — a run cannot be moved to another company, so PATCH refuses the key rather than accepting and ignoring it.
|
|
5765
6580
|
*/
|
|
5766
6581
|
company_id: string;
|
|
5767
6582
|
/**
|
|
@@ -5785,6 +6600,31 @@ export type PayrollRunParameters = {
|
|
|
5785
6600
|
*/
|
|
5786
6601
|
external_id?: string | null;
|
|
5787
6602
|
};
|
|
6603
|
+
/**
|
|
6604
|
+
* Update a payroll run. Every field is optional — send only what changes. company_id is absent by design — the run's company is fixed at creation, so sending the key is rejected with 400 unknown_key, as is any other key not listed here.
|
|
6605
|
+
*/
|
|
6606
|
+
export type PayrollRunUpdateParameters = {
|
|
6607
|
+
/**
|
|
6608
|
+
* ID of the pay period the run is for; required for an on-cycle run, omitted for an off-cycle run.
|
|
6609
|
+
*/
|
|
6610
|
+
timekeeping_pay_period_id?: string | null;
|
|
6611
|
+
/**
|
|
6612
|
+
* ID of the payroll-system credential that sourced the run.
|
|
6613
|
+
*/
|
|
6614
|
+
payrolls_credential_id?: string | null;
|
|
6615
|
+
/**
|
|
6616
|
+
* Kind of payroll run (uppercase): one of CORRECTION, ON_CYCLE, OFF_CYCLE, RECONCILIATION, SIGN_ON_BONUS, or TERMINATION.
|
|
6617
|
+
*/
|
|
6618
|
+
run_type?: 'CORRECTION' | 'ON_CYCLE' | 'OFF_CYCLE' | 'RECONCILIATION' | 'SIGN_ON_BONUS' | 'TERMINATION';
|
|
6619
|
+
/**
|
|
6620
|
+
* Check date of the run (YYYY-MM-DD). For a self-reported run (off-cycle with no payrolls_credential_id), at most 3 days after the current date — later dates fail validation.
|
|
6621
|
+
*/
|
|
6622
|
+
run_date?: string;
|
|
6623
|
+
/**
|
|
6624
|
+
* ID of the run in the external payroll system.
|
|
6625
|
+
*/
|
|
6626
|
+
external_id?: string | null;
|
|
6627
|
+
};
|
|
5788
6628
|
/**
|
|
5789
6629
|
* A project: a top-level container that groups jobs into federal and regional PWA compliance scopes, carrying the compliance modes, regional scoping, schedule envelope, and administrator/budget metadata.
|
|
5790
6630
|
*/
|
|
@@ -5939,35 +6779,35 @@ export type ProjectParameters = {
|
|
|
5939
6779
|
*/
|
|
5940
6780
|
region?: string | null;
|
|
5941
6781
|
/**
|
|
5942
|
-
* Gates IRA tax-credit checks.
|
|
6782
|
+
* Gates IRA tax-credit checks. Applies only while `federal_pwa_mode` is not `none` — sending `true` or null while federal tracking is off returns 422, and switching to `none` sets it back to `false`.
|
|
5943
6783
|
*/
|
|
5944
6784
|
asset_owner?: boolean;
|
|
5945
6785
|
/**
|
|
5946
|
-
* Name of the project administrator
|
|
6786
|
+
* Name of the project administrator. Applies only while `federal_pwa_mode` is not `none` — sending it while federal tracking is off, even as null, returns 422, and switching to `none` clears the stored value.
|
|
5947
6787
|
*/
|
|
5948
6788
|
administrator_name?: string | null;
|
|
5949
6789
|
/**
|
|
5950
|
-
* Email of the project administrator
|
|
6790
|
+
* Email of the project administrator. Applies only while `federal_pwa_mode` is not `none` — sending it while federal tracking is off, even as null, returns 422, and switching to `none` clears the stored value.
|
|
5951
6791
|
*/
|
|
5952
6792
|
administrator_email?: string | null;
|
|
5953
6793
|
/**
|
|
5954
|
-
* Phone of the project administrator, normalized to E.164
|
|
6794
|
+
* Phone of the project administrator, normalized to E.164. Applies only while `federal_pwa_mode` is not `none` — sending it while federal tracking is off, even as null, returns 422, and switching to `none` clears the stored value.
|
|
5955
6795
|
*/
|
|
5956
6796
|
administrator_phone?: string | null;
|
|
5957
6797
|
/**
|
|
5958
|
-
* Decimal string (e.g. "5000.0").
|
|
6798
|
+
* Decimal string (e.g. "5000.0"). Applies only while `federal_pwa_mode` is not `none` — sending it while federal tracking is off, even as null, returns 422, and switching to `none` clears the stored value.
|
|
5959
6799
|
*/
|
|
5960
6800
|
budget?: string;
|
|
5961
6801
|
/**
|
|
5962
|
-
* Prevailing-wage lock-in date as an ISO8601 date
|
|
6802
|
+
* Prevailing-wage lock-in date as an ISO8601 date. Applies only while `federal_pwa_mode` is not `none` — sending it while federal tracking is off, even as null, returns 422, and switching to `none` clears the stored value.
|
|
5963
6803
|
*/
|
|
5964
6804
|
prevailing_wage_lock_in_date?: string | null;
|
|
5965
6805
|
/**
|
|
5966
|
-
* IRA beginning-of-construction date as an ISO8601 date
|
|
6806
|
+
* IRA beginning-of-construction date as an ISO8601 date. Applies only while `federal_pwa_mode` is not `none` — sending it while federal tracking is off, even as null, returns 422, and switching to `none` clears the stored value.
|
|
5967
6807
|
*/
|
|
5968
6808
|
beginning_of_construction_date?: string | null;
|
|
5969
6809
|
/**
|
|
5970
|
-
* IRA placed-in-service date as an ISO8601 date
|
|
6810
|
+
* IRA placed-in-service date as an ISO8601 date. Applies only while `federal_pwa_mode` is not `none` — sending it while federal tracking is off, even as null, returns 422, and switching to `none` clears the stored value.
|
|
5971
6811
|
*/
|
|
5972
6812
|
placed_in_service_date?: string | null;
|
|
5973
6813
|
};
|
|
@@ -5989,7 +6829,7 @@ export type SiteCheckInResponseObject = {
|
|
|
5989
6829
|
/**
|
|
5990
6830
|
* How the check-in was captured.
|
|
5991
6831
|
*/
|
|
5992
|
-
source: 'manual' | 'auto';
|
|
6832
|
+
source: 'manual' | 'auto' | 'public_form';
|
|
5993
6833
|
nerc_check_in: boolean;
|
|
5994
6834
|
cip_exceptional: boolean;
|
|
5995
6835
|
created_by_user_id: string | null;
|
|
@@ -6586,7 +7426,7 @@ export type PaystubResponseObject = {
|
|
|
6586
7426
|
updated_at: string;
|
|
6587
7427
|
};
|
|
6588
7428
|
/**
|
|
6589
|
-
* Request body for creating
|
|
7429
|
+
* Request body for creating a paystub. payrolls_payroll_run_id and user_id are required; timekeeping_time_card_id is required for an on-cycle run and disallowed for an off-cycle run.
|
|
6590
7430
|
*/
|
|
6591
7431
|
export type PaystubParameters = {
|
|
6592
7432
|
/**
|
|
@@ -6610,6 +7450,31 @@ export type PaystubParameters = {
|
|
|
6610
7450
|
*/
|
|
6611
7451
|
check_number?: string | null;
|
|
6612
7452
|
};
|
|
7453
|
+
/**
|
|
7454
|
+
* Request body for updating a paystub. Send only the fields to change; the resulting paystub must still match its payroll run type.
|
|
7455
|
+
*/
|
|
7456
|
+
export type PaystubUpdateParameters = {
|
|
7457
|
+
/**
|
|
7458
|
+
* ID of the payroll run this paystub belongs to. Omit to leave it unchanged.
|
|
7459
|
+
*/
|
|
7460
|
+
payrolls_payroll_run_id?: string;
|
|
7461
|
+
/**
|
|
7462
|
+
* ID of the worker who received the payment. Omit to leave it unchanged.
|
|
7463
|
+
*/
|
|
7464
|
+
user_id?: string;
|
|
7465
|
+
/**
|
|
7466
|
+
* ID of the time card this paystub is for. Omit to leave it unchanged; the resulting paystub must have one for an on-cycle run and must not have one for an off-cycle run.
|
|
7467
|
+
*/
|
|
7468
|
+
timekeeping_time_card_id?: string | null;
|
|
7469
|
+
/**
|
|
7470
|
+
* ID of the paystub in the external payroll system; unique within its payroll run. Omit to leave it unchanged.
|
|
7471
|
+
*/
|
|
7472
|
+
external_id?: string | null;
|
|
7473
|
+
/**
|
|
7474
|
+
* Payment reference from the payroll provider; omit to leave it unchanged, or send null to clear it.
|
|
7475
|
+
*/
|
|
7476
|
+
check_number?: string | null;
|
|
7477
|
+
};
|
|
6613
7478
|
/**
|
|
6614
7479
|
* A page of paystub line items, with pagination metadata and navigation links.
|
|
6615
7480
|
*/
|
|
@@ -7086,7 +7951,7 @@ export type PaystubLineItemResponseObject = {
|
|
|
7086
7951
|
updated_at: string;
|
|
7087
7952
|
};
|
|
7088
7953
|
/**
|
|
7089
|
-
* Request body for creating
|
|
7954
|
+
* Request body for creating a paystub line item. All four fields are required.
|
|
7090
7955
|
*/
|
|
7091
7956
|
export type PaystubLineItemParameters = {
|
|
7092
7957
|
/**
|
|
@@ -7106,6 +7971,27 @@ export type PaystubLineItemParameters = {
|
|
|
7106
7971
|
*/
|
|
7107
7972
|
payrolls_external_map_id: string;
|
|
7108
7973
|
};
|
|
7974
|
+
/**
|
|
7975
|
+
* Request body for updating a paystub line item. Send only the fields to change.
|
|
7976
|
+
*/
|
|
7977
|
+
export type PaystubLineItemUpdateParameters = {
|
|
7978
|
+
/**
|
|
7979
|
+
* ID of the paystub this line item belongs to. Omit to leave it unchanged.
|
|
7980
|
+
*/
|
|
7981
|
+
payrolls_paystub_id?: string;
|
|
7982
|
+
/**
|
|
7983
|
+
* Amount of this line, in cents as a decimal string (e.g. "5000.0" is $50.00). Omit to leave it unchanged.
|
|
7984
|
+
*/
|
|
7985
|
+
amount_cents?: string;
|
|
7986
|
+
/**
|
|
7987
|
+
* Who contributes this amount: employee or employer. Omit to leave it unchanged.
|
|
7988
|
+
*/
|
|
7989
|
+
contributor?: 'employee' | 'employer';
|
|
7990
|
+
/**
|
|
7991
|
+
* ID of the external map defining which compensation element this line item represents. Omit to leave it unchanged.
|
|
7992
|
+
*/
|
|
7993
|
+
payrolls_external_map_id?: string;
|
|
7994
|
+
};
|
|
7109
7995
|
/**
|
|
7110
7996
|
* A spot to be filled on a job — one worker's assignment and the unit against which they track time, carrying the schedule window, assigned worker, function, and the planned pay and fringe rates (including PWA prevailing-wage compliance rates). Always accessed nested under a job.
|
|
7111
7997
|
*/
|
|
@@ -7572,7 +8458,7 @@ export type FormAssignmentTaskResponseObject = Array<{
|
|
|
7572
8458
|
}>;
|
|
7573
8459
|
}>;
|
|
7574
8460
|
/**
|
|
7575
|
-
* Request body for creating
|
|
8461
|
+
* Request body for creating a certification — a named qualification a worker can hold. You can only manage your own company's certifications; global (platform) certifications are read-only.
|
|
7576
8462
|
*/
|
|
7577
8463
|
export type CertificationParameters = {
|
|
7578
8464
|
/**
|
|
@@ -7596,6 +8482,31 @@ export type CertificationParameters = {
|
|
|
7596
8482
|
*/
|
|
7597
8483
|
duration?: string | null;
|
|
7598
8484
|
};
|
|
8485
|
+
/**
|
|
8486
|
+
* Request body for updating a certification — a named qualification a worker can hold. Include only the fields to change. You can only manage your own company's certifications; global (platform) certifications are read-only.
|
|
8487
|
+
*/
|
|
8488
|
+
export type CertificationUpdateParameters = {
|
|
8489
|
+
/**
|
|
8490
|
+
* Id of the company that owns the certification. It must match the company that owns the API key; updates cannot move a certification between companies.
|
|
8491
|
+
*/
|
|
8492
|
+
company_id?: string;
|
|
8493
|
+
/**
|
|
8494
|
+
* Name of the certification (for example "OSHA 30" or a GWO training module). Unique within the company.
|
|
8495
|
+
*/
|
|
8496
|
+
name?: string;
|
|
8497
|
+
/**
|
|
8498
|
+
* Optional free-text description of the certification; omit to leave it unchanged, or send null to clear it.
|
|
8499
|
+
*/
|
|
8500
|
+
description?: string | null;
|
|
8501
|
+
/**
|
|
8502
|
+
* Whether this is a recognized, vetted credential type. This is a property of the certification definition, distinct from the verified flag on a certification a worker holds.
|
|
8503
|
+
*/
|
|
8504
|
+
verified?: boolean;
|
|
8505
|
+
/**
|
|
8506
|
+
* How long the certification stays valid, as an ISO 8601 duration (for example "P1Y" for one year or "P6M" for six months). Drives expiry reminders on held certifications; null when the certification does not expire.
|
|
8507
|
+
*/
|
|
8508
|
+
duration?: string | null;
|
|
8509
|
+
};
|
|
7599
8510
|
/**
|
|
7600
8511
|
* A page of certifications — your company's own plus all global (platform) certifications.
|
|
7601
8512
|
*/
|
|
@@ -7649,7 +8560,7 @@ export type CertificationPackageResponseObject = {
|
|
|
7649
8560
|
updated_at: string;
|
|
7650
8561
|
};
|
|
7651
8562
|
/**
|
|
7652
|
-
* Request body for creating
|
|
8563
|
+
* Request body for creating a certification package — a named set of certifications a company requires together.
|
|
7653
8564
|
*/
|
|
7654
8565
|
export type CertificationPackageParameters = {
|
|
7655
8566
|
/**
|
|
@@ -7669,6 +8580,27 @@ export type CertificationPackageParameters = {
|
|
|
7669
8580
|
*/
|
|
7670
8581
|
performed_by_user_id: string;
|
|
7671
8582
|
};
|
|
8583
|
+
/**
|
|
8584
|
+
* Request body for updating a certification package — a named set of certifications a company requires together. Include only the fields to change.
|
|
8585
|
+
*/
|
|
8586
|
+
export type CertificationPackageUpdateParameters = {
|
|
8587
|
+
/**
|
|
8588
|
+
* Name of the package. Unique within the company; omit to leave it unchanged.
|
|
8589
|
+
*/
|
|
8590
|
+
name?: string;
|
|
8591
|
+
/**
|
|
8592
|
+
* Optional free-text description of the package; omit to leave it unchanged.
|
|
8593
|
+
*/
|
|
8594
|
+
description?: string | null;
|
|
8595
|
+
/**
|
|
8596
|
+
* Ids of the certifications in the package; global and your company's own may be mixed. Providing this replaces the entire membership.
|
|
8597
|
+
*/
|
|
8598
|
+
certification_ids?: Array<string>;
|
|
8599
|
+
/**
|
|
8600
|
+
* Id of the company member recorded as updating the package. Required, and must belong to the company that owns the API key.
|
|
8601
|
+
*/
|
|
8602
|
+
performed_by_user_id: string;
|
|
8603
|
+
};
|
|
7672
8604
|
/**
|
|
7673
8605
|
* A certification — a named qualification a worker can hold, either owned by your company or a global (platform) credential type (company_id null).
|
|
7674
8606
|
*/
|
|
@@ -9386,6 +10318,19 @@ export type AssetsVendorParameters = {
|
|
|
9386
10318
|
*/
|
|
9387
10319
|
logo_signed_id?: string;
|
|
9388
10320
|
};
|
|
10321
|
+
/**
|
|
10322
|
+
* Update a vendor. All fields are optional — send only what changes.
|
|
10323
|
+
*/
|
|
10324
|
+
export type AssetsVendorUpdateParameters = {
|
|
10325
|
+
/**
|
|
10326
|
+
* The vendor's name; unique within the company (case-insensitive).
|
|
10327
|
+
*/
|
|
10328
|
+
name?: string;
|
|
10329
|
+
/**
|
|
10330
|
+
* A signed_id from POST /api/v1/direct_uploads registered for assets.vendors. The logo must be a readable PNG, JPEG, GIF, or HEIC image, at most 10 MiB, 20,000 pixels per side, and 50 megapixels total. An invalid logo rejects the entire update; the existing vendor and logo remain unchanged.
|
|
10331
|
+
*/
|
|
10332
|
+
logo_signed_id?: string;
|
|
10333
|
+
};
|
|
9389
10334
|
/**
|
|
9390
10335
|
* A location that holds a company's assets and inventory — a warehouse or yard, optionally backed by a site on the Atlas map.
|
|
9391
10336
|
*/
|
|
@@ -9447,9 +10392,21 @@ export type AssetsSiteParameters = ({
|
|
|
9447
10392
|
*/
|
|
9448
10393
|
name?: string | null;
|
|
9449
10394
|
};
|
|
10395
|
+
/**
|
|
10396
|
+
* Request body for updating an asset location. Every field is optional; send only the fields to change. The saved location must still have a name or a backing `site_id`.
|
|
10397
|
+
*/
|
|
9450
10398
|
export type AssetsSiteUpdateParameters = {
|
|
10399
|
+
/**
|
|
10400
|
+
* Location type: warehouse or yard.
|
|
10401
|
+
*/
|
|
9451
10402
|
kind?: 'warehouse' | 'yard';
|
|
10403
|
+
/**
|
|
10404
|
+
* ID of the Atlas map site to back this location. `null` removes the backing site when a name remains available.
|
|
10405
|
+
*/
|
|
9452
10406
|
site_id?: string | null;
|
|
10407
|
+
/**
|
|
10408
|
+
* Display name for the location. `null` clears the direct name when a backing `site_id` supplies the display name.
|
|
10409
|
+
*/
|
|
9453
10410
|
name?: string | null;
|
|
9454
10411
|
};
|
|
9455
10412
|
/**
|
|
@@ -10548,61 +11505,180 @@ export type AssetsRestockParameters = {
|
|
|
10548
11505
|
/**
|
|
10549
11506
|
* Optional. The site's storage location the stock lands in; must belong to the site. Omit for the site's unbinned stock.
|
|
10550
11507
|
*/
|
|
10551
|
-
assets_sub_location_id?: string;
|
|
11508
|
+
assets_sub_location_id?: string;
|
|
11509
|
+
/**
|
|
11510
|
+
* Number of units to add; greater than 0.
|
|
11511
|
+
*/
|
|
11512
|
+
quantity: number;
|
|
11513
|
+
/**
|
|
11514
|
+
* ID of the user this restock is performed on behalf of, recorded on the transaction. Required; must belong to your company.
|
|
11515
|
+
*/
|
|
11516
|
+
performed_by_user_id: string;
|
|
11517
|
+
};
|
|
11518
|
+
/**
|
|
11519
|
+
* Set the on-hand count of a bulk product at a site to a specific number, recording the difference as an adjustment transaction. The site must already stock the product. Bulk products only.
|
|
11520
|
+
*/
|
|
11521
|
+
export type AssetsAdjustmentParameters = {
|
|
11522
|
+
/**
|
|
11523
|
+
* ID of the site whose on-hand count is being set.
|
|
11524
|
+
*/
|
|
11525
|
+
assets_site_id: string;
|
|
11526
|
+
/**
|
|
11527
|
+
* Optional. The site's storage location whose count is being set; must belong to the site. Omit to set the site's unbinned count.
|
|
11528
|
+
*/
|
|
11529
|
+
assets_sub_location_id?: string;
|
|
11530
|
+
/**
|
|
11531
|
+
* The corrected on-hand count for the site; 0 or greater. The difference from the current count is recorded as the adjustment.
|
|
11532
|
+
*/
|
|
11533
|
+
new_quantity: number;
|
|
11534
|
+
/**
|
|
11535
|
+
* ID of the user this adjustment is performed on behalf of, recorded on the transaction. Required; must belong to your company.
|
|
11536
|
+
*/
|
|
11537
|
+
performed_by_user_id: string;
|
|
11538
|
+
};
|
|
11539
|
+
/**
|
|
11540
|
+
* Archive or unarchive a product or item. Archiving takes it out of circulation without deleting it — history is preserved and it is hidden from listings unless requested with filter[state]. Archiving a product cascades to its items; item operations apply to serial items only.
|
|
11541
|
+
*/
|
|
11542
|
+
export type AssetsArchiveParameters = {
|
|
11543
|
+
/**
|
|
11544
|
+
* ID of the user this archive or unarchive is performed on behalf of, recorded for auditing. Required; must belong to your company.
|
|
11545
|
+
*/
|
|
11546
|
+
performed_by_user_id: string;
|
|
11547
|
+
};
|
|
11548
|
+
export type ListApiKeyScopesData = {
|
|
11549
|
+
body?: never;
|
|
11550
|
+
path?: never;
|
|
11551
|
+
query?: never;
|
|
11552
|
+
url: '/api/v1/api_key/scopes';
|
|
11553
|
+
};
|
|
11554
|
+
export type ListApiKeyScopesResponses = {
|
|
11555
|
+
/**
|
|
11556
|
+
* Success
|
|
11557
|
+
*/
|
|
11558
|
+
200: {
|
|
11559
|
+
data: Array<ApiKeyScopeResponseObject>;
|
|
11560
|
+
};
|
|
11561
|
+
};
|
|
11562
|
+
export type ListApiKeyScopesResponse = ListApiKeyScopesResponses[keyof ListApiKeyScopesResponses];
|
|
11563
|
+
export type ListAllocationsData = {
|
|
11564
|
+
body?: never;
|
|
11565
|
+
path: {
|
|
11566
|
+
apprentice_id: string;
|
|
11567
|
+
};
|
|
11568
|
+
query?: {
|
|
11569
|
+
'filter[allocated_at][gte]'?: string;
|
|
11570
|
+
'filter[allocated_at][lte]'?: string;
|
|
11571
|
+
'filter[created_at][gte]'?: string;
|
|
11572
|
+
'filter[created_at][lte]'?: string;
|
|
11573
|
+
'filter[updated_at][gte]'?: string;
|
|
11574
|
+
'filter[updated_at][lte]'?: string;
|
|
11575
|
+
filter?: string;
|
|
11576
|
+
'filter[unexpected]'?: string;
|
|
11577
|
+
/**
|
|
11578
|
+
* This pagination cursor corresponds to the cursor value found in the response in
|
|
11579
|
+
* `meta.page.next_cursor`.
|
|
11580
|
+
*/
|
|
11581
|
+
'page[cursor]'?: string;
|
|
11582
|
+
/**
|
|
11583
|
+
* 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`.
|
|
11584
|
+
*/
|
|
11585
|
+
'page[limit]'?: number;
|
|
11586
|
+
page?: string;
|
|
11587
|
+
};
|
|
11588
|
+
url: '/api/v1/apprenticeship/apprentices/{apprentice_id}/allocations';
|
|
11589
|
+
};
|
|
11590
|
+
export type ListAllocationsErrors = {
|
|
11591
|
+
/**
|
|
11592
|
+
* Bad Request
|
|
11593
|
+
*/
|
|
11594
|
+
400: Problem;
|
|
11595
|
+
/**
|
|
11596
|
+
* Forbidden
|
|
11597
|
+
*/
|
|
11598
|
+
403: Problem;
|
|
11599
|
+
/**
|
|
11600
|
+
* Not Found
|
|
11601
|
+
*/
|
|
11602
|
+
404: Problem;
|
|
11603
|
+
/**
|
|
11604
|
+
* Unprocessable Content
|
|
11605
|
+
*/
|
|
11606
|
+
422: Problem;
|
|
11607
|
+
};
|
|
11608
|
+
export type ListAllocationsError = ListAllocationsErrors[keyof ListAllocationsErrors];
|
|
11609
|
+
export type ListAllocationsResponses = {
|
|
11610
|
+
/**
|
|
11611
|
+
* Success
|
|
11612
|
+
*/
|
|
11613
|
+
200: {
|
|
11614
|
+
meta: Meta;
|
|
11615
|
+
links: Links;
|
|
11616
|
+
data: Array<ApprenticeshipAllocationResponseObject>;
|
|
11617
|
+
};
|
|
11618
|
+
};
|
|
11619
|
+
export type ListAllocationsResponse = ListAllocationsResponses[keyof ListAllocationsResponses];
|
|
11620
|
+
export type GetAllocationData = {
|
|
11621
|
+
body?: never;
|
|
11622
|
+
path: {
|
|
11623
|
+
apprentice_id: string;
|
|
11624
|
+
id: string;
|
|
11625
|
+
};
|
|
11626
|
+
query?: never;
|
|
11627
|
+
url: '/api/v1/apprenticeship/apprentices/{apprentice_id}/allocations/{id}';
|
|
11628
|
+
};
|
|
11629
|
+
export type GetAllocationErrors = {
|
|
10552
11630
|
/**
|
|
10553
|
-
*
|
|
11631
|
+
* Forbidden
|
|
10554
11632
|
*/
|
|
10555
|
-
|
|
11633
|
+
403: Problem;
|
|
10556
11634
|
/**
|
|
10557
|
-
*
|
|
11635
|
+
* Not Found
|
|
10558
11636
|
*/
|
|
10559
|
-
|
|
11637
|
+
404: Problem;
|
|
10560
11638
|
};
|
|
10561
|
-
|
|
10562
|
-
|
|
10563
|
-
*/
|
|
10564
|
-
export type AssetsAdjustmentParameters = {
|
|
11639
|
+
export type GetAllocationError = GetAllocationErrors[keyof GetAllocationErrors];
|
|
11640
|
+
export type GetAllocationResponses = {
|
|
10565
11641
|
/**
|
|
10566
|
-
*
|
|
11642
|
+
* Success
|
|
10567
11643
|
*/
|
|
10568
|
-
|
|
11644
|
+
200: ApprenticeshipAllocationResponseObject;
|
|
11645
|
+
};
|
|
11646
|
+
export type GetAllocationResponse = GetAllocationResponses[keyof GetAllocationResponses];
|
|
11647
|
+
export type UpdateAllocationData = {
|
|
11648
|
+
body: ApprenticeshipAllocationUpdateParameters;
|
|
11649
|
+
path: {
|
|
11650
|
+
apprentice_id: string;
|
|
11651
|
+
id: string;
|
|
11652
|
+
};
|
|
11653
|
+
query?: never;
|
|
11654
|
+
url: '/api/v1/apprenticeship/apprentices/{apprentice_id}/allocations/{id}';
|
|
11655
|
+
};
|
|
11656
|
+
export type UpdateAllocationErrors = {
|
|
10569
11657
|
/**
|
|
10570
|
-
*
|
|
11658
|
+
* Bad Request
|
|
10571
11659
|
*/
|
|
10572
|
-
|
|
11660
|
+
400: Problem;
|
|
10573
11661
|
/**
|
|
10574
|
-
*
|
|
11662
|
+
* Forbidden
|
|
10575
11663
|
*/
|
|
10576
|
-
|
|
11664
|
+
403: Problem;
|
|
10577
11665
|
/**
|
|
10578
|
-
*
|
|
11666
|
+
* Not Found
|
|
10579
11667
|
*/
|
|
10580
|
-
|
|
10581
|
-
};
|
|
10582
|
-
/**
|
|
10583
|
-
* Archive or unarchive a product or item. Archiving takes it out of circulation without deleting it — history is preserved and it is hidden from listings unless requested with filter[state]. Archiving a product cascades to its items; item operations apply to serial items only.
|
|
10584
|
-
*/
|
|
10585
|
-
export type AssetsArchiveParameters = {
|
|
11668
|
+
404: Problem;
|
|
10586
11669
|
/**
|
|
10587
|
-
*
|
|
11670
|
+
* Unprocessable Content
|
|
10588
11671
|
*/
|
|
10589
|
-
|
|
10590
|
-
};
|
|
10591
|
-
export type ListApiKeyScopesData = {
|
|
10592
|
-
body?: never;
|
|
10593
|
-
path?: never;
|
|
10594
|
-
query?: never;
|
|
10595
|
-
url: '/api/v1/api_key/scopes';
|
|
11672
|
+
422: Problem;
|
|
10596
11673
|
};
|
|
10597
|
-
export type
|
|
11674
|
+
export type UpdateAllocationError = UpdateAllocationErrors[keyof UpdateAllocationErrors];
|
|
11675
|
+
export type UpdateAllocationResponses = {
|
|
10598
11676
|
/**
|
|
10599
11677
|
* Success
|
|
10600
11678
|
*/
|
|
10601
|
-
200:
|
|
10602
|
-
data: Array<ApiKeyScopeResponseObject>;
|
|
10603
|
-
};
|
|
11679
|
+
200: ApprenticeshipAllocationResponseObject;
|
|
10604
11680
|
};
|
|
10605
|
-
export type
|
|
11681
|
+
export type UpdateAllocationResponse = UpdateAllocationResponses[keyof UpdateAllocationResponses];
|
|
10606
11682
|
export type ListApprenticesData = {
|
|
10607
11683
|
body?: never;
|
|
10608
11684
|
path: {
|
|
@@ -10787,7 +11863,7 @@ export type CreateOccupationResponses = {
|
|
|
10787
11863
|
};
|
|
10788
11864
|
export type CreateOccupationResponse = CreateOccupationResponses[keyof CreateOccupationResponses];
|
|
10789
11865
|
export type UpdateOccupationData = {
|
|
10790
|
-
body?:
|
|
11866
|
+
body?: ApprenticeshipOccupationUpdateParameters;
|
|
10791
11867
|
path: {
|
|
10792
11868
|
program_id: string;
|
|
10793
11869
|
id: string;
|
|
@@ -10922,7 +11998,7 @@ export type DeleteEmployerResponses = {
|
|
|
10922
11998
|
};
|
|
10923
11999
|
export type DeleteEmployerResponse = DeleteEmployerResponses[keyof DeleteEmployerResponses];
|
|
10924
12000
|
export type UpdateEmployerData = {
|
|
10925
|
-
body?:
|
|
12001
|
+
body?: ApprenticeshipProgramEmployerUpdateParameters;
|
|
10926
12002
|
path: {
|
|
10927
12003
|
program_id: string;
|
|
10928
12004
|
id: string;
|
|
@@ -11022,7 +12098,7 @@ export type CreateProgramResponses = {
|
|
|
11022
12098
|
};
|
|
11023
12099
|
export type CreateProgramResponse = CreateProgramResponses[keyof CreateProgramResponses];
|
|
11024
12100
|
export type UpdateProgramData = {
|
|
11025
|
-
body?:
|
|
12101
|
+
body?: ApprenticeshipProgramUpdateParameters;
|
|
11026
12102
|
path: {
|
|
11027
12103
|
id: string;
|
|
11028
12104
|
};
|
|
@@ -11129,7 +12205,7 @@ export type CreatePeriodResponses = {
|
|
|
11129
12205
|
};
|
|
11130
12206
|
export type CreatePeriodResponse = CreatePeriodResponses[keyof CreatePeriodResponses];
|
|
11131
12207
|
export type UpdatePeriodData = {
|
|
11132
|
-
body?:
|
|
12208
|
+
body?: ApprenticeshipWageSchedulePeriodUpdateParameters;
|
|
11133
12209
|
path: {
|
|
11134
12210
|
wage_schedule_id: string;
|
|
11135
12211
|
id: string;
|
|
@@ -11237,7 +12313,7 @@ export type CreateWageScheduleResponses = {
|
|
|
11237
12313
|
};
|
|
11238
12314
|
export type CreateWageScheduleResponse = CreateWageScheduleResponses[keyof CreateWageScheduleResponses];
|
|
11239
12315
|
export type UpdateWageScheduleData = {
|
|
11240
|
-
body?:
|
|
12316
|
+
body?: ApprenticeshipWageScheduleUpdateParameters;
|
|
11241
12317
|
path: {
|
|
11242
12318
|
occupation_id: string;
|
|
11243
12319
|
id: string;
|
|
@@ -11403,7 +12479,7 @@ export type GetAttributeResponses = {
|
|
|
11403
12479
|
};
|
|
11404
12480
|
export type GetAttributeResponse = GetAttributeResponses[keyof GetAttributeResponses];
|
|
11405
12481
|
export type UpdateAttributeData = {
|
|
11406
|
-
body?:
|
|
12482
|
+
body?: AssetsAttributeUpdateParameters;
|
|
11407
12483
|
path: {
|
|
11408
12484
|
id: string;
|
|
11409
12485
|
};
|
|
@@ -11562,7 +12638,7 @@ export type GetCategoryResponses = {
|
|
|
11562
12638
|
};
|
|
11563
12639
|
export type GetCategoryResponse = GetCategoryResponses[keyof GetCategoryResponses];
|
|
11564
12640
|
export type UpdateCategoryData = {
|
|
11565
|
-
body?:
|
|
12641
|
+
body?: AssetsCategoryUpdateParameters;
|
|
11566
12642
|
path: {
|
|
11567
12643
|
id: string;
|
|
11568
12644
|
};
|
|
@@ -13741,7 +14817,7 @@ export type GetVendorResponses = {
|
|
|
13741
14817
|
};
|
|
13742
14818
|
export type GetVendorResponse = GetVendorResponses[keyof GetVendorResponses];
|
|
13743
14819
|
export type UpdateVendorData = {
|
|
13744
|
-
body:
|
|
14820
|
+
body: AssetsVendorUpdateParameters;
|
|
13745
14821
|
path: {
|
|
13746
14822
|
id: string;
|
|
13747
14823
|
};
|
|
@@ -14094,7 +15170,7 @@ export type GetPackageResponses = {
|
|
|
14094
15170
|
};
|
|
14095
15171
|
export type GetPackageResponse = GetPackageResponses[keyof GetPackageResponses];
|
|
14096
15172
|
export type UpdatePackageData = {
|
|
14097
|
-
body?:
|
|
15173
|
+
body?: CertificationPackageUpdateParameters;
|
|
14098
15174
|
path: {
|
|
14099
15175
|
id: string;
|
|
14100
15176
|
};
|
|
@@ -14390,7 +15466,7 @@ export type GetCertificationResponses = {
|
|
|
14390
15466
|
};
|
|
14391
15467
|
export type GetCertificationResponse = GetCertificationResponses[keyof GetCertificationResponses];
|
|
14392
15468
|
export type UpdateCertificationData = {
|
|
14393
|
-
body?:
|
|
15469
|
+
body?: CertificationUpdateParameters;
|
|
14394
15470
|
path: {
|
|
14395
15471
|
id: string;
|
|
14396
15472
|
};
|
|
@@ -14489,7 +15565,7 @@ export type CreateDepartmentResponses = {
|
|
|
14489
15565
|
};
|
|
14490
15566
|
export type CreateDepartmentResponse = CreateDepartmentResponses[keyof CreateDepartmentResponses];
|
|
14491
15567
|
export type UpdateDepartmentData = {
|
|
14492
|
-
body:
|
|
15568
|
+
body: DepartmentUpdateParameters;
|
|
14493
15569
|
path: {
|
|
14494
15570
|
id: string;
|
|
14495
15571
|
};
|
|
@@ -15381,7 +16457,7 @@ export type GetGroupResponses = {
|
|
|
15381
16457
|
};
|
|
15382
16458
|
export type GetGroupResponse = GetGroupResponses[keyof GetGroupResponses];
|
|
15383
16459
|
export type UpdateGroupData = {
|
|
15384
|
-
body?:
|
|
16460
|
+
body?: GroupUpdateParameters;
|
|
15385
16461
|
path: {
|
|
15386
16462
|
id: string;
|
|
15387
16463
|
};
|
|
@@ -17839,7 +18915,7 @@ export type GetFringeBenefitPlanResponses = {
|
|
|
17839
18915
|
};
|
|
17840
18916
|
export type GetFringeBenefitPlanResponse = GetFringeBenefitPlanResponses[keyof GetFringeBenefitPlanResponses];
|
|
17841
18917
|
export type UpdateFringeBenefitPlanData = {
|
|
17842
|
-
body?:
|
|
18918
|
+
body?: PayrollFringeBenefitPlanUpdateParameters;
|
|
17843
18919
|
path: {
|
|
17844
18920
|
id: string;
|
|
17845
18921
|
};
|
|
@@ -17855,6 +18931,10 @@ export type UpdateFringeBenefitPlanErrors = {
|
|
|
17855
18931
|
* Not Found
|
|
17856
18932
|
*/
|
|
17857
18933
|
404: Problem;
|
|
18934
|
+
/**
|
|
18935
|
+
* Unprocessable Content
|
|
18936
|
+
*/
|
|
18937
|
+
422: Problem;
|
|
17858
18938
|
};
|
|
17859
18939
|
export type UpdateFringeBenefitPlanError = UpdateFringeBenefitPlanErrors[keyof UpdateFringeBenefitPlanErrors];
|
|
17860
18940
|
export type UpdateFringeBenefitPlanResponses = {
|
|
@@ -18058,6 +19138,10 @@ export type CreatePayrollRunData = {
|
|
|
18058
19138
|
url: '/api/v1/payrolls/payroll_runs';
|
|
18059
19139
|
};
|
|
18060
19140
|
export type CreatePayrollRunErrors = {
|
|
19141
|
+
/**
|
|
19142
|
+
* Bad Request
|
|
19143
|
+
*/
|
|
19144
|
+
400: Problem;
|
|
18061
19145
|
/**
|
|
18062
19146
|
* Forbidden
|
|
18063
19147
|
*/
|
|
@@ -18132,7 +19216,7 @@ export type GetPayrollRunResponses = {
|
|
|
18132
19216
|
};
|
|
18133
19217
|
export type GetPayrollRunResponse = GetPayrollRunResponses[keyof GetPayrollRunResponses];
|
|
18134
19218
|
export type UpdatePayrollRunData = {
|
|
18135
|
-
body?:
|
|
19219
|
+
body?: PayrollRunUpdateParameters;
|
|
18136
19220
|
path: {
|
|
18137
19221
|
id: string;
|
|
18138
19222
|
};
|
|
@@ -18140,6 +19224,10 @@ export type UpdatePayrollRunData = {
|
|
|
18140
19224
|
url: '/api/v1/payrolls/payroll_runs/{id}';
|
|
18141
19225
|
};
|
|
18142
19226
|
export type UpdatePayrollRunErrors = {
|
|
19227
|
+
/**
|
|
19228
|
+
* Bad Request
|
|
19229
|
+
*/
|
|
19230
|
+
400: Problem;
|
|
18143
19231
|
/**
|
|
18144
19232
|
* Forbidden
|
|
18145
19233
|
*/
|
|
@@ -18285,7 +19373,7 @@ export type GetPaystubLineItemResponses = {
|
|
|
18285
19373
|
};
|
|
18286
19374
|
export type GetPaystubLineItemResponse = GetPaystubLineItemResponses[keyof GetPaystubLineItemResponses];
|
|
18287
19375
|
export type UpdatePaystubLineItemData = {
|
|
18288
|
-
body?:
|
|
19376
|
+
body?: PaystubLineItemUpdateParameters;
|
|
18289
19377
|
path: {
|
|
18290
19378
|
/**
|
|
18291
19379
|
* Paystub Line Item ID
|
|
@@ -18453,7 +19541,7 @@ export type GetPaystubResponses = {
|
|
|
18453
19541
|
};
|
|
18454
19542
|
export type GetPaystubResponse = GetPaystubResponses[keyof GetPaystubResponses];
|
|
18455
19543
|
export type UpdatePaystubData = {
|
|
18456
|
-
body:
|
|
19544
|
+
body: PaystubUpdateParameters;
|
|
18457
19545
|
path: {
|
|
18458
19546
|
/**
|
|
18459
19547
|
* Paystub ID
|
|
@@ -18485,6 +19573,191 @@ export type UpdatePaystubResponses = {
|
|
|
18485
19573
|
200: PaystubResponseObject;
|
|
18486
19574
|
};
|
|
18487
19575
|
export type UpdatePaystubResponse = UpdatePaystubResponses[keyof UpdatePaystubResponses];
|
|
19576
|
+
export type ListEmploymentHistoryData = {
|
|
19577
|
+
body?: never;
|
|
19578
|
+
path: {
|
|
19579
|
+
employment_id: string;
|
|
19580
|
+
};
|
|
19581
|
+
query?: {
|
|
19582
|
+
'as_of[valid]'?: string;
|
|
19583
|
+
'as_of[transaction]'?: string;
|
|
19584
|
+
/**
|
|
19585
|
+
* This pagination cursor corresponds to the cursor value found in the response in
|
|
19586
|
+
* `meta.page.next_cursor`.
|
|
19587
|
+
*/
|
|
19588
|
+
'page[cursor]'?: string;
|
|
19589
|
+
/**
|
|
19590
|
+
* Maximum number of records to return per page. Defaults to 20. A value above 100 is capped to 100 rather than rejected; a value that is zero, negative, or not an integer is rejected with a `400`.
|
|
19591
|
+
*/
|
|
19592
|
+
'page[limit]'?: number;
|
|
19593
|
+
page?: string;
|
|
19594
|
+
};
|
|
19595
|
+
url: '/api/v1/people/employments/{employment_id}/history';
|
|
19596
|
+
};
|
|
19597
|
+
export type ListEmploymentHistoryErrors = {
|
|
19598
|
+
/**
|
|
19599
|
+
* Bad Request
|
|
19600
|
+
*/
|
|
19601
|
+
400: Problem;
|
|
19602
|
+
/**
|
|
19603
|
+
* Forbidden
|
|
19604
|
+
*/
|
|
19605
|
+
403: Problem;
|
|
19606
|
+
/**
|
|
19607
|
+
* Not Found for an unknown employment
|
|
19608
|
+
*/
|
|
19609
|
+
404: Problem;
|
|
19610
|
+
};
|
|
19611
|
+
export type ListEmploymentHistoryError = ListEmploymentHistoryErrors[keyof ListEmploymentHistoryErrors];
|
|
19612
|
+
export type ListEmploymentHistoryResponses = {
|
|
19613
|
+
/**
|
|
19614
|
+
* Success
|
|
19615
|
+
*/
|
|
19616
|
+
200: {
|
|
19617
|
+
meta: Meta;
|
|
19618
|
+
links: Links;
|
|
19619
|
+
data: Array<PeopleEmploymentHistoryVersionObject>;
|
|
19620
|
+
};
|
|
19621
|
+
};
|
|
19622
|
+
export type ListEmploymentHistoryResponse = ListEmploymentHistoryResponses[keyof ListEmploymentHistoryResponses];
|
|
19623
|
+
export type ListEmploymentsHistoryData = {
|
|
19624
|
+
body?: never;
|
|
19625
|
+
path?: never;
|
|
19626
|
+
query?: {
|
|
19627
|
+
/**
|
|
19628
|
+
* Return history for this user ID.
|
|
19629
|
+
*/
|
|
19630
|
+
'filter[user_id]'?: string;
|
|
19631
|
+
'as_of[valid]'?: string;
|
|
19632
|
+
'as_of[transaction]'?: string;
|
|
19633
|
+
filter?: string;
|
|
19634
|
+
'filter[unexpected]'?: string;
|
|
19635
|
+
/**
|
|
19636
|
+
* This pagination cursor corresponds to the cursor value found in the response in
|
|
19637
|
+
* `meta.page.next_cursor`.
|
|
19638
|
+
*/
|
|
19639
|
+
'page[cursor]'?: string;
|
|
19640
|
+
/**
|
|
19641
|
+
* 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`.
|
|
19642
|
+
*/
|
|
19643
|
+
'page[limit]'?: number;
|
|
19644
|
+
page?: string;
|
|
19645
|
+
};
|
|
19646
|
+
url: '/api/v1/people/employments/history';
|
|
19647
|
+
};
|
|
19648
|
+
export type ListEmploymentsHistoryErrors = {
|
|
19649
|
+
/**
|
|
19650
|
+
* Bad Request
|
|
19651
|
+
*/
|
|
19652
|
+
400: Problem;
|
|
19653
|
+
/**
|
|
19654
|
+
* Forbidden
|
|
19655
|
+
*/
|
|
19656
|
+
403: Problem;
|
|
19657
|
+
};
|
|
19658
|
+
export type ListEmploymentsHistoryError = ListEmploymentsHistoryErrors[keyof ListEmploymentsHistoryErrors];
|
|
19659
|
+
export type ListEmploymentsHistoryResponses = {
|
|
19660
|
+
/**
|
|
19661
|
+
* Success
|
|
19662
|
+
*/
|
|
19663
|
+
200: {
|
|
19664
|
+
meta: Meta;
|
|
19665
|
+
links: Links;
|
|
19666
|
+
data: Array<PeopleEmploymentHistoryVersionObject>;
|
|
19667
|
+
};
|
|
19668
|
+
};
|
|
19669
|
+
export type ListEmploymentsHistoryResponse = ListEmploymentsHistoryResponses[keyof ListEmploymentsHistoryResponses];
|
|
19670
|
+
export type ListEmploymentsData = {
|
|
19671
|
+
body?: never;
|
|
19672
|
+
path?: never;
|
|
19673
|
+
query?: {
|
|
19674
|
+
/**
|
|
19675
|
+
* Return employments for this user ID.
|
|
19676
|
+
*/
|
|
19677
|
+
'filter[user_id]'?: string;
|
|
19678
|
+
filter?: string;
|
|
19679
|
+
'filter[unexpected]'?: string;
|
|
19680
|
+
/**
|
|
19681
|
+
* Read the version valid at this point in time. Defaults to now.
|
|
19682
|
+
*/
|
|
19683
|
+
'as_of[valid]'?: string;
|
|
19684
|
+
as_of?: string;
|
|
19685
|
+
'as_of[bogus_axis]'?: string;
|
|
19686
|
+
'as_of[valid][gte]'?: string;
|
|
19687
|
+
'as_of[transaction]'?: string;
|
|
19688
|
+
/**
|
|
19689
|
+
* This pagination cursor corresponds to the cursor value found in the response in
|
|
19690
|
+
* `meta.page.next_cursor`.
|
|
19691
|
+
*/
|
|
19692
|
+
'page[cursor]'?: string;
|
|
19693
|
+
/**
|
|
19694
|
+
* 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`.
|
|
19695
|
+
*/
|
|
19696
|
+
'page[limit]'?: number;
|
|
19697
|
+
page?: string;
|
|
19698
|
+
};
|
|
19699
|
+
url: '/api/v1/people/employments';
|
|
19700
|
+
};
|
|
19701
|
+
export type ListEmploymentsErrors = {
|
|
19702
|
+
/**
|
|
19703
|
+
* Bad Request
|
|
19704
|
+
*/
|
|
19705
|
+
400: Problem;
|
|
19706
|
+
/**
|
|
19707
|
+
* Forbidden
|
|
19708
|
+
*/
|
|
19709
|
+
403: Problem;
|
|
19710
|
+
/**
|
|
19711
|
+
* Unprocessable Content
|
|
19712
|
+
*/
|
|
19713
|
+
422: Problem;
|
|
19714
|
+
};
|
|
19715
|
+
export type ListEmploymentsError = ListEmploymentsErrors[keyof ListEmploymentsErrors];
|
|
19716
|
+
export type ListEmploymentsResponses = {
|
|
19717
|
+
/**
|
|
19718
|
+
* Success in a gap between employment stints
|
|
19719
|
+
*/
|
|
19720
|
+
200: {
|
|
19721
|
+
meta: Meta;
|
|
19722
|
+
links: Links;
|
|
19723
|
+
data: Array<PeopleEmploymentResponseObject>;
|
|
19724
|
+
};
|
|
19725
|
+
};
|
|
19726
|
+
export type ListEmploymentsResponse = ListEmploymentsResponses[keyof ListEmploymentsResponses];
|
|
19727
|
+
export type GetEmploymentData = {
|
|
19728
|
+
body?: never;
|
|
19729
|
+
path: {
|
|
19730
|
+
/**
|
|
19731
|
+
* The employment stint identity returned as `id`.
|
|
19732
|
+
*/
|
|
19733
|
+
id: string;
|
|
19734
|
+
};
|
|
19735
|
+
query?: {
|
|
19736
|
+
/**
|
|
19737
|
+
* Read the version valid at this point.
|
|
19738
|
+
*/
|
|
19739
|
+
'as_of[valid]'?: string;
|
|
19740
|
+
};
|
|
19741
|
+
url: '/api/v1/people/employments/{id}';
|
|
19742
|
+
};
|
|
19743
|
+
export type GetEmploymentErrors = {
|
|
19744
|
+
/**
|
|
19745
|
+
* Forbidden
|
|
19746
|
+
*/
|
|
19747
|
+
403: Problem;
|
|
19748
|
+
/**
|
|
19749
|
+
* Not Found in an employment gap
|
|
19750
|
+
*/
|
|
19751
|
+
404: Problem;
|
|
19752
|
+
};
|
|
19753
|
+
export type GetEmploymentError = GetEmploymentErrors[keyof GetEmploymentErrors];
|
|
19754
|
+
export type GetEmploymentResponses = {
|
|
19755
|
+
/**
|
|
19756
|
+
* Success
|
|
19757
|
+
*/
|
|
19758
|
+
200: PeopleEmploymentResponseObject;
|
|
19759
|
+
};
|
|
19760
|
+
export type GetEmploymentResponse = GetEmploymentResponses[keyof GetEmploymentResponses];
|
|
18488
19761
|
export type ListPerDiemsData = {
|
|
18489
19762
|
body?: never;
|
|
18490
19763
|
path?: never;
|
|
@@ -18637,7 +19910,7 @@ export type GetPerDiemResponses = {
|
|
|
18637
19910
|
};
|
|
18638
19911
|
export type GetPerDiemResponse = GetPerDiemResponses[keyof GetPerDiemResponses];
|
|
18639
19912
|
export type UpdatePerDiemData = {
|
|
18640
|
-
body?:
|
|
19913
|
+
body?: PerDiemUpdateParameters;
|
|
18641
19914
|
path: {
|
|
18642
19915
|
/**
|
|
18643
19916
|
* Unique identifier of the per diem.
|
|
@@ -18793,7 +20066,7 @@ export type GetPositionFunctionResponses = {
|
|
|
18793
20066
|
};
|
|
18794
20067
|
export type GetPositionFunctionResponse = GetPositionFunctionResponses[keyof GetPositionFunctionResponses];
|
|
18795
20068
|
export type UpdatePositionFunctionData = {
|
|
18796
|
-
body?:
|
|
20069
|
+
body?: PositionFunctionUpdateParameters;
|
|
18797
20070
|
path: {
|
|
18798
20071
|
id: string;
|
|
18799
20072
|
};
|
|
@@ -19197,7 +20470,7 @@ export type CreateCompanyUserDetailResponses = {
|
|
|
19197
20470
|
};
|
|
19198
20471
|
export type CreateCompanyUserDetailResponse = CreateCompanyUserDetailResponses[keyof CreateCompanyUserDetailResponses];
|
|
19199
20472
|
export type UpdateCompanyUserDetailData = {
|
|
19200
|
-
body:
|
|
20473
|
+
body: PwaCompanyUserDetailsUpdateParameters;
|
|
19201
20474
|
path: {
|
|
19202
20475
|
id: string;
|
|
19203
20476
|
};
|
|
@@ -19205,6 +20478,10 @@ export type UpdateCompanyUserDetailData = {
|
|
|
19205
20478
|
url: '/api/v1/pwa/company_user_details/{id}';
|
|
19206
20479
|
};
|
|
19207
20480
|
export type UpdateCompanyUserDetailErrors = {
|
|
20481
|
+
/**
|
|
20482
|
+
* Bad Request
|
|
20483
|
+
*/
|
|
20484
|
+
400: Problem;
|
|
19208
20485
|
/**
|
|
19209
20486
|
* Forbidden
|
|
19210
20487
|
*/
|
|
@@ -19974,7 +21251,7 @@ export type DeleteTimeCardPerDiemResponses = {
|
|
|
19974
21251
|
};
|
|
19975
21252
|
export type DeleteTimeCardPerDiemResponse = DeleteTimeCardPerDiemResponses[keyof DeleteTimeCardPerDiemResponses];
|
|
19976
21253
|
export type UpdateTimeCardPerDiemData = {
|
|
19977
|
-
body:
|
|
21254
|
+
body: TimeCardPerDiemUpdateParameters;
|
|
19978
21255
|
path: {
|
|
19979
21256
|
time_card_id: string;
|
|
19980
21257
|
id: number;
|
|
@@ -21378,7 +22655,7 @@ export type DeleteHolidayResponses = {
|
|
|
21378
22655
|
};
|
|
21379
22656
|
export type DeleteHolidayResponse = DeleteHolidayResponses[keyof DeleteHolidayResponses];
|
|
21380
22657
|
export type UpdateHolidayData = {
|
|
21381
|
-
body:
|
|
22658
|
+
body: HolidayUpdateParameters;
|
|
21382
22659
|
path: {
|
|
21383
22660
|
/**
|
|
21384
22661
|
* ID of the pay schedule
|
|
@@ -21894,6 +23171,10 @@ export type UpdateScheduledChangeData = {
|
|
|
21894
23171
|
url: '/api/v1/users/{user_id}/companies/{company_id}/scheduled_changes/{id}';
|
|
21895
23172
|
};
|
|
21896
23173
|
export type UpdateScheduledChangeErrors = {
|
|
23174
|
+
/**
|
|
23175
|
+
* Bad Request
|
|
23176
|
+
*/
|
|
23177
|
+
400: Problem;
|
|
21897
23178
|
/**
|
|
21898
23179
|
* Forbidden
|
|
21899
23180
|
*/
|