@dsptch-work/api-client 0.18.0 → 0.20.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 +66 -0
- package/dist/gen/index.d.ts +2 -2
- package/dist/gen/index.js +1 -1
- package/dist/gen/sdk.gen.d.ts +99 -15
- package/dist/gen/sdk.gen.js +144 -14
- package/dist/gen/types.gen.d.ts +2044 -262
- package/dist/gen/zod.gen.d.ts +1490 -159
- package/dist/gen/zod.gen.js +950 -79
- package/package.json +1 -1
package/dist/gen/types.gen.d.ts
CHANGED
|
@@ -25,6 +25,19 @@ export type Problem = {
|
|
|
25
25
|
* An opaque URN identifying this one occurrence of the failure, carrying the request's id. Quote it when correlating a failure with support or your logs.
|
|
26
26
|
*/
|
|
27
27
|
instance?: string;
|
|
28
|
+
/**
|
|
29
|
+
* Optional nonempty validation entries. Each item gives a readable detail and, when the server can prove a public body location, a pointer to it. Clients must accept entries without a pointer.
|
|
30
|
+
*/
|
|
31
|
+
errors?: Array<{
|
|
32
|
+
/**
|
|
33
|
+
* The validation message for this entry.
|
|
34
|
+
*/
|
|
35
|
+
detail: string;
|
|
36
|
+
/**
|
|
37
|
+
* A JSON Pointer URI fragment for the public request-body field this entry identifies. Omitted when the server cannot reliably name a public field. It may name a required field absent from the body (for example `#/name`); clients must handle that missing target.
|
|
38
|
+
*/
|
|
39
|
+
pointer?: string;
|
|
40
|
+
}>;
|
|
28
41
|
};
|
|
29
42
|
/**
|
|
30
43
|
* Error types
|
|
@@ -767,6 +780,29 @@ export type ApprenticeshipApprenticeResponseObject = {
|
|
|
767
780
|
*/
|
|
768
781
|
updated_at: string;
|
|
769
782
|
};
|
|
783
|
+
export type ApprenticeshipAllocationResponseObject = {
|
|
784
|
+
id: string;
|
|
785
|
+
apprenticeship_apprentice_id: string;
|
|
786
|
+
apprenticeship_work_process_category_id: string | null;
|
|
787
|
+
allocated_by_user_id: string;
|
|
788
|
+
timekeeping_time_card_id: string | null;
|
|
789
|
+
minutes: number;
|
|
790
|
+
description: string | null;
|
|
791
|
+
allocated_at: string;
|
|
792
|
+
cumulative_minutes: number;
|
|
793
|
+
apprenticeship_wage_schedule_period_id: string;
|
|
794
|
+
created_at: string;
|
|
795
|
+
updated_at: string;
|
|
796
|
+
};
|
|
797
|
+
/**
|
|
798
|
+
* 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.
|
|
799
|
+
*/
|
|
800
|
+
export type ApprenticeshipAllocationUpdateParameters = {
|
|
801
|
+
/**
|
|
802
|
+
* 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.
|
|
803
|
+
*/
|
|
804
|
+
allocated_at?: string;
|
|
805
|
+
};
|
|
770
806
|
/**
|
|
771
807
|
* 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
808
|
*/
|
|
@@ -805,7 +841,7 @@ export type ApprenticeshipApprenticeParameters = {
|
|
|
805
841
|
operative_end_date?: string | null;
|
|
806
842
|
};
|
|
807
843
|
/**
|
|
808
|
-
* Create
|
|
844
|
+
* Create an apprenticeship program sponsored by your company; the sponsor is always your company and is never taken from the request body.
|
|
809
845
|
*/
|
|
810
846
|
export type ApprenticeshipProgramParameters = {
|
|
811
847
|
/**
|
|
@@ -830,7 +866,32 @@ export type ApprenticeshipProgramParameters = {
|
|
|
830
866
|
registration_agency_type?: 'federal' | 'regional' | null;
|
|
831
867
|
};
|
|
832
868
|
/**
|
|
833
|
-
*
|
|
869
|
+
* Update an apprenticeship program sponsored by your company. Send only the fields to change; the sponsor is fixed to your company.
|
|
870
|
+
*/
|
|
871
|
+
export type ApprenticeshipProgramUpdateParameters = {
|
|
872
|
+
/**
|
|
873
|
+
* DOL- or state-agency-assigned registration number for the program; unique per sponsor company. Omit to leave it unchanged.
|
|
874
|
+
*/
|
|
875
|
+
program_number?: string;
|
|
876
|
+
/**
|
|
877
|
+
* Human-readable name for the program; omit to leave it unchanged, or send null to clear.
|
|
878
|
+
*/
|
|
879
|
+
program_name?: string | null;
|
|
880
|
+
/**
|
|
881
|
+
* Official name of the sponsoring organization; omit to leave it unchanged, or send null to clear.
|
|
882
|
+
*/
|
|
883
|
+
sponsor_name?: string | null;
|
|
884
|
+
/**
|
|
885
|
+
* Name the sponsor operates under; omit to leave it unchanged, or send null to clear.
|
|
886
|
+
*/
|
|
887
|
+
doing_business_as?: string | null;
|
|
888
|
+
/**
|
|
889
|
+
* Agency that registered the program: federal or regional; omit to leave it unchanged, or send null to clear.
|
|
890
|
+
*/
|
|
891
|
+
registration_agency_type?: 'federal' | 'regional' | null;
|
|
892
|
+
};
|
|
893
|
+
/**
|
|
894
|
+
* Create an occupation (trade) within a sponsored program; the program is taken from the URL path.
|
|
834
895
|
*/
|
|
835
896
|
export type ApprenticeshipOccupationParameters = {
|
|
836
897
|
/**
|
|
@@ -871,7 +932,48 @@ export type ApprenticeshipOccupationParameters = {
|
|
|
871
932
|
num_journeyworkers: number;
|
|
872
933
|
};
|
|
873
934
|
/**
|
|
874
|
-
*
|
|
935
|
+
* Update an occupation (trade) within a sponsored program. Send only the fields to change; the program is taken from the URL path.
|
|
936
|
+
*/
|
|
937
|
+
export type ApprenticeshipOccupationUpdateParameters = {
|
|
938
|
+
/**
|
|
939
|
+
* DOL RAPIDS code identifying this occupation. Omit to leave it unchanged.
|
|
940
|
+
*/
|
|
941
|
+
rapids_code?: string;
|
|
942
|
+
/**
|
|
943
|
+
* How apprentices progress through this occupation: time_based, competency_based, or hybrid. Omit to leave it unchanged.
|
|
944
|
+
*/
|
|
945
|
+
occupation_type?: 'time_based' | 'competency_based' | 'hybrid';
|
|
946
|
+
/**
|
|
947
|
+
* Trade title for the occupation (e.g. "Electrician"). Omit to leave it unchanged.
|
|
948
|
+
*/
|
|
949
|
+
title?: string;
|
|
950
|
+
/**
|
|
951
|
+
* Description of the occupation; omit to leave it unchanged, or send null to clear.
|
|
952
|
+
*/
|
|
953
|
+
description?: string | null;
|
|
954
|
+
/**
|
|
955
|
+
* Minimum total on-the-job minutes required to complete the occupation. Omit to leave it unchanged.
|
|
956
|
+
*/
|
|
957
|
+
min_minutes?: number;
|
|
958
|
+
/**
|
|
959
|
+
* Maximum total on-the-job minutes allowed for the occupation; must exceed min_minutes. Omit to leave it unchanged.
|
|
960
|
+
*/
|
|
961
|
+
max_minutes?: number;
|
|
962
|
+
/**
|
|
963
|
+
* Length of the occupation's initial probationary period, in minutes. Omit to leave it unchanged.
|
|
964
|
+
*/
|
|
965
|
+
probation_minutes?: number;
|
|
966
|
+
/**
|
|
967
|
+
* Apprentice side of the apprentice-to-journeyworker ratio. Omit to leave it unchanged.
|
|
968
|
+
*/
|
|
969
|
+
num_apprentices?: number;
|
|
970
|
+
/**
|
|
971
|
+
* Journeyworker side of the apprentice-to-journeyworker ratio. Omit to leave it unchanged.
|
|
972
|
+
*/
|
|
973
|
+
num_journeyworkers?: number;
|
|
974
|
+
};
|
|
975
|
+
/**
|
|
976
|
+
* Create an authorization for an employer to employ apprentices in a program; only the program's sponsor may manage this roster.
|
|
875
977
|
*/
|
|
876
978
|
export type ApprenticeshipProgramEmployerParameters = {
|
|
877
979
|
/**
|
|
@@ -884,7 +986,20 @@ export type ApprenticeshipProgramEmployerParameters = {
|
|
|
884
986
|
require_timecard_allocation?: boolean;
|
|
885
987
|
};
|
|
886
988
|
/**
|
|
887
|
-
*
|
|
989
|
+
* Update an employer authorization in a program. Send only the fields to change; only the program's sponsor may manage this roster.
|
|
990
|
+
*/
|
|
991
|
+
export type ApprenticeshipProgramEmployerUpdateParameters = {
|
|
992
|
+
/**
|
|
993
|
+
* 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.
|
|
994
|
+
*/
|
|
995
|
+
company_id?: string;
|
|
996
|
+
/**
|
|
997
|
+
* Whether this employer's apprentices must allocate apprenticeship hours from DSPTCH time cards rather than recording them standalone; omit to leave it unchanged.
|
|
998
|
+
*/
|
|
999
|
+
require_timecard_allocation?: boolean;
|
|
1000
|
+
};
|
|
1001
|
+
/**
|
|
1002
|
+
* Create a period on a wage schedule; the wage schedule is taken from the URL path. wage_cents is sent as integer cents.
|
|
888
1003
|
*/
|
|
889
1004
|
export type ApprenticeshipWageSchedulePeriodParameters = {
|
|
890
1005
|
/**
|
|
@@ -917,7 +1032,40 @@ export type ApprenticeshipWageSchedulePeriodParameters = {
|
|
|
917
1032
|
wage_cents: number;
|
|
918
1033
|
};
|
|
919
1034
|
/**
|
|
920
|
-
*
|
|
1035
|
+
* 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.
|
|
1036
|
+
*/
|
|
1037
|
+
export type ApprenticeshipWageSchedulePeriodUpdateParameters = {
|
|
1038
|
+
/**
|
|
1039
|
+
* 0-indexed position of this period in the progression; omit to leave it unchanged.
|
|
1040
|
+
*/
|
|
1041
|
+
period_number?: number;
|
|
1042
|
+
/**
|
|
1043
|
+
* 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.
|
|
1044
|
+
*/
|
|
1045
|
+
min_minutes?: number | null;
|
|
1046
|
+
/**
|
|
1047
|
+
* 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.
|
|
1048
|
+
*/
|
|
1049
|
+
max_minutes?: number | null;
|
|
1050
|
+
/**
|
|
1051
|
+
* 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.
|
|
1052
|
+
*/
|
|
1053
|
+
num_competencies?: number | null;
|
|
1054
|
+
/**
|
|
1055
|
+
* Free-text description of this period; optional, null to clear.
|
|
1056
|
+
*/
|
|
1057
|
+
description?: string | null;
|
|
1058
|
+
/**
|
|
1059
|
+
* Percentage of the journeyworker wage paid during this period (e.g. 75 for 75%); omit to leave it unchanged.
|
|
1060
|
+
*/
|
|
1061
|
+
wage_percent?: number;
|
|
1062
|
+
/**
|
|
1063
|
+
* Wage rate for this period, in cents; omit to leave it unchanged.
|
|
1064
|
+
*/
|
|
1065
|
+
wage_cents?: number;
|
|
1066
|
+
};
|
|
1067
|
+
/**
|
|
1068
|
+
* 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
1069
|
*/
|
|
922
1070
|
export type ApprenticeshipWageScheduleParameters = {
|
|
923
1071
|
/**
|
|
@@ -990,6 +1138,88 @@ export type ApprenticeshipWageScheduleParameters = {
|
|
|
990
1138
|
_destroy?: boolean;
|
|
991
1139
|
}>;
|
|
992
1140
|
};
|
|
1141
|
+
/**
|
|
1142
|
+
* 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.
|
|
1143
|
+
*/
|
|
1144
|
+
export type ApprenticeshipWageScheduleUpdateParameters = {
|
|
1145
|
+
/**
|
|
1146
|
+
* Human-readable name for the wage schedule; omit to leave it unchanged.
|
|
1147
|
+
*/
|
|
1148
|
+
name?: string;
|
|
1149
|
+
/**
|
|
1150
|
+
* Free-text description of the wage schedule; omit to leave it unchanged, or send null to clear.
|
|
1151
|
+
*/
|
|
1152
|
+
description?: string | null;
|
|
1153
|
+
/**
|
|
1154
|
+
* Pay frequency for each period's wage_cents: hourly, weekly, monthly, quarterly, semi_annually, or annually. Omit to leave it unchanged.
|
|
1155
|
+
*/
|
|
1156
|
+
wage_unit?: 'hourly' | 'weekly' | 'monthly' | 'quarterly' | 'semi_annually' | 'annually';
|
|
1157
|
+
/**
|
|
1158
|
+
* Pay frequency for journeyworker_wage_cents: hourly, weekly, monthly, quarterly, semi_annually, or annually. Omit to leave it unchanged.
|
|
1159
|
+
*/
|
|
1160
|
+
journeyworker_wage_unit?: 'hourly' | 'weekly' | 'monthly' | 'quarterly' | 'semi_annually' | 'annually';
|
|
1161
|
+
/**
|
|
1162
|
+
* Display unit for the periods: hours, weeks, months, quarter, semi_annual, or year. Omit to leave it unchanged.
|
|
1163
|
+
*/
|
|
1164
|
+
period_unit?: 'hours' | 'weeks' | 'months' | 'quarter' | 'semi_annual' | 'year';
|
|
1165
|
+
/**
|
|
1166
|
+
* Journeyworker wage to progress toward, in cents; omit to leave it unchanged.
|
|
1167
|
+
*/
|
|
1168
|
+
journeyworker_wage_cents?: number;
|
|
1169
|
+
/**
|
|
1170
|
+
* Wage at the end of the progression, in cents; omit to leave it unchanged.
|
|
1171
|
+
*/
|
|
1172
|
+
end_wage_cents?: number;
|
|
1173
|
+
/**
|
|
1174
|
+
* 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.
|
|
1175
|
+
*/
|
|
1176
|
+
periods_attributes?: Array<(unknown | {
|
|
1177
|
+
min_minutes: number;
|
|
1178
|
+
} | {
|
|
1179
|
+
max_minutes: number;
|
|
1180
|
+
} | {
|
|
1181
|
+
num_competencies: number;
|
|
1182
|
+
} | {
|
|
1183
|
+
_destroy: true;
|
|
1184
|
+
}) & {
|
|
1185
|
+
/**
|
|
1186
|
+
* Unique identifier.
|
|
1187
|
+
*/
|
|
1188
|
+
id?: string;
|
|
1189
|
+
/**
|
|
1190
|
+
* 0-indexed position of this period in the progression; omit to leave it unchanged.
|
|
1191
|
+
*/
|
|
1192
|
+
period_number?: number;
|
|
1193
|
+
/**
|
|
1194
|
+
* 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.
|
|
1195
|
+
*/
|
|
1196
|
+
min_minutes?: number | null;
|
|
1197
|
+
/**
|
|
1198
|
+
* 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.
|
|
1199
|
+
*/
|
|
1200
|
+
max_minutes?: number | null;
|
|
1201
|
+
/**
|
|
1202
|
+
* 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.
|
|
1203
|
+
*/
|
|
1204
|
+
num_competencies?: number | null;
|
|
1205
|
+
/**
|
|
1206
|
+
* Free-text description of this period; optional, null to clear.
|
|
1207
|
+
*/
|
|
1208
|
+
description?: string | null;
|
|
1209
|
+
/**
|
|
1210
|
+
* Percentage of the journeyworker wage paid during this period (e.g. 75 for 75%); omit to leave it unchanged.
|
|
1211
|
+
*/
|
|
1212
|
+
wage_percent?: number;
|
|
1213
|
+
/**
|
|
1214
|
+
* Wage rate for this period, in cents; omit to leave it unchanged.
|
|
1215
|
+
*/
|
|
1216
|
+
wage_cents?: number;
|
|
1217
|
+
/**
|
|
1218
|
+
* Set to true, together with the period's id, to remove that period from the schedule.
|
|
1219
|
+
*/
|
|
1220
|
+
_destroy?: boolean;
|
|
1221
|
+
}>;
|
|
1222
|
+
};
|
|
993
1223
|
/**
|
|
994
1224
|
* 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
1225
|
*/
|
|
@@ -1087,161 +1317,391 @@ export type TimecodeResponseObject = {
|
|
|
1087
1317
|
*/
|
|
1088
1318
|
updated_at: string;
|
|
1089
1319
|
};
|
|
1090
|
-
|
|
1320
|
+
/**
|
|
1321
|
+
* An employment stint in the credential company. Its id is stable across valid-time versions; a rehire is a separate stint with a new id. A read returns only a version covering now or as_of[valid].
|
|
1322
|
+
*/
|
|
1323
|
+
export type PeopleEmploymentResponseObject = {
|
|
1091
1324
|
/**
|
|
1092
|
-
*
|
|
1325
|
+
* Version-stable identity for this employment stint.
|
|
1093
1326
|
*/
|
|
1094
|
-
|
|
1095
|
-
name: string;
|
|
1096
|
-
description: string | null;
|
|
1097
|
-
description_is_required: boolean;
|
|
1098
|
-
billable: boolean;
|
|
1099
|
-
overtime_eligible: boolean;
|
|
1100
|
-
unpaid: boolean;
|
|
1101
|
-
holiday: boolean;
|
|
1102
|
-
pto: boolean;
|
|
1103
|
-
safety: boolean;
|
|
1104
|
-
lunch_shortcut: boolean;
|
|
1105
|
-
break_shortcut: boolean;
|
|
1106
|
-
pwa: boolean;
|
|
1107
|
-
rest_and_recovery: boolean;
|
|
1108
|
-
incentive_pay_eligible: boolean;
|
|
1109
|
-
restricted_to: 'none' | 'job' | 'non_job' | 'job_with_timecode';
|
|
1110
|
-
default_for_company_id: string;
|
|
1111
|
-
valid_from: string | null;
|
|
1112
|
-
valid_to: string | null;
|
|
1113
|
-
transaction_from: string;
|
|
1114
|
-
transaction_to: string | null;
|
|
1115
|
-
created_at: string;
|
|
1116
|
-
updated_at: string;
|
|
1117
|
-
};
|
|
1118
|
-
export type TimecodeHistoryVersionObject = {
|
|
1327
|
+
id: string;
|
|
1119
1328
|
/**
|
|
1120
|
-
*
|
|
1329
|
+
* ID of the employed person.
|
|
1121
1330
|
*/
|
|
1122
|
-
|
|
1123
|
-
name: string;
|
|
1124
|
-
description: string | null;
|
|
1125
|
-
description_is_required: boolean;
|
|
1126
|
-
billable: boolean;
|
|
1127
|
-
overtime_eligible: boolean;
|
|
1128
|
-
unpaid: boolean;
|
|
1129
|
-
holiday: boolean;
|
|
1130
|
-
pto: boolean;
|
|
1131
|
-
safety: boolean;
|
|
1132
|
-
lunch_shortcut: boolean;
|
|
1133
|
-
break_shortcut: boolean;
|
|
1134
|
-
pwa: boolean;
|
|
1135
|
-
rest_and_recovery: boolean;
|
|
1136
|
-
incentive_pay_eligible: boolean;
|
|
1137
|
-
restricted_to: 'none' | 'job' | 'non_job' | 'job_with_timecode';
|
|
1138
|
-
default_for_company_id: string;
|
|
1139
|
-
valid_from: string | null;
|
|
1140
|
-
valid_to: string | null;
|
|
1141
|
-
transaction_from: string;
|
|
1142
|
-
transaction_to: string | null;
|
|
1143
|
-
created_at: string;
|
|
1144
|
-
updated_at: string;
|
|
1145
|
-
version_status: 'scheduled' | 'current' | 'historical';
|
|
1146
|
-
corrections: Array<TimecodeHistoryCorrectionObject>;
|
|
1147
|
-
};
|
|
1148
|
-
/**
|
|
1149
|
-
* Request body for creating or updating a timecode; only `name` is required. On create, omitted fields take their model/DB defaults (noted per field). On update the request applies a bitemporal correction, so omitted fields keep the current version's values rather than reverting to defaults.
|
|
1150
|
-
*/
|
|
1151
|
-
export type TimecodeParameters = {
|
|
1331
|
+
user_id: string;
|
|
1152
1332
|
/**
|
|
1153
|
-
*
|
|
1333
|
+
* ID of the employing company; always the credential company.
|
|
1154
1334
|
*/
|
|
1155
|
-
|
|
1335
|
+
company_id: string;
|
|
1156
1336
|
/**
|
|
1157
|
-
*
|
|
1337
|
+
* Whether the relationship is EMPLOYEE or CONTRACTOR.
|
|
1158
1338
|
*/
|
|
1159
|
-
|
|
1339
|
+
type: 'EMPLOYEE' | 'CONTRACTOR';
|
|
1160
1340
|
/**
|
|
1161
|
-
*
|
|
1341
|
+
* Employment title; null when unset.
|
|
1162
1342
|
*/
|
|
1163
|
-
|
|
1343
|
+
title: string | null;
|
|
1164
1344
|
/**
|
|
1165
|
-
* Whether
|
|
1345
|
+
* Whether pay is hourly or salary.
|
|
1166
1346
|
*/
|
|
1167
|
-
|
|
1347
|
+
compensation_type: 'hourly' | 'salary';
|
|
1168
1348
|
/**
|
|
1169
|
-
*
|
|
1349
|
+
* Payroll-system identifier; null when unset.
|
|
1170
1350
|
*/
|
|
1171
|
-
|
|
1351
|
+
payroll_id: string | null;
|
|
1172
1352
|
/**
|
|
1173
|
-
*
|
|
1353
|
+
* Manager ID; null when unset.
|
|
1174
1354
|
*/
|
|
1175
|
-
|
|
1355
|
+
manager_user_id: string | null;
|
|
1176
1356
|
/**
|
|
1177
|
-
*
|
|
1357
|
+
* Department ID; null when unset.
|
|
1178
1358
|
*/
|
|
1179
|
-
|
|
1359
|
+
companies_department_id: string | null;
|
|
1180
1360
|
/**
|
|
1181
|
-
* Whether
|
|
1361
|
+
* Whether this employment is enrolled in time and attendance.
|
|
1182
1362
|
*/
|
|
1183
|
-
|
|
1363
|
+
enrolled_in_t_and_a: boolean;
|
|
1184
1364
|
/**
|
|
1185
|
-
* Whether
|
|
1365
|
+
* Whether this employment is overtime eligible; null when unset.
|
|
1186
1366
|
*/
|
|
1187
|
-
|
|
1367
|
+
overtime_eligible: boolean | null;
|
|
1188
1368
|
/**
|
|
1189
|
-
*
|
|
1369
|
+
* Overtime package ID; null when unset.
|
|
1190
1370
|
*/
|
|
1191
|
-
|
|
1371
|
+
overtime_package_id: string | null;
|
|
1192
1372
|
/**
|
|
1193
|
-
*
|
|
1373
|
+
* Pay-rate rules package ID; null when unset.
|
|
1194
1374
|
*/
|
|
1195
|
-
|
|
1375
|
+
pay_rates_rule_package_id: string | null;
|
|
1196
1376
|
/**
|
|
1197
|
-
*
|
|
1377
|
+
* Pay-rates package ID; null when unset.
|
|
1198
1378
|
*/
|
|
1199
|
-
|
|
1379
|
+
pay_rates_package_id: string | null;
|
|
1200
1380
|
/**
|
|
1201
|
-
*
|
|
1381
|
+
* Annual worked minutes; null when unset.
|
|
1202
1382
|
*/
|
|
1203
|
-
|
|
1383
|
+
worked_annual_minutes: number | null;
|
|
1204
1384
|
/**
|
|
1205
|
-
*
|
|
1385
|
+
* Annual paid-time-off minutes; null when unset.
|
|
1206
1386
|
*/
|
|
1207
|
-
|
|
1387
|
+
pto_annual_minutes: number | null;
|
|
1208
1388
|
/**
|
|
1209
|
-
*
|
|
1389
|
+
* Annual holiday minutes; null when unset.
|
|
1210
1390
|
*/
|
|
1211
|
-
|
|
1391
|
+
holiday_annual_minutes: number | null;
|
|
1212
1392
|
/**
|
|
1213
|
-
*
|
|
1393
|
+
* Annual training minutes; null when unset.
|
|
1214
1394
|
*/
|
|
1215
|
-
|
|
1216
|
-
};
|
|
1217
|
-
export type TimecodeCorrectionParameters = {
|
|
1395
|
+
training_annual_minutes: number | null;
|
|
1218
1396
|
/**
|
|
1219
|
-
*
|
|
1397
|
+
* Hourly pay in cents as a decimal string; null when unset.
|
|
1220
1398
|
*/
|
|
1221
|
-
|
|
1399
|
+
hourly_rate_cents: string | null;
|
|
1222
1400
|
/**
|
|
1223
|
-
*
|
|
1401
|
+
* Annual training amount in cents as a decimal string; null when unset.
|
|
1402
|
+
*/
|
|
1403
|
+
training_annual_amount_cents: string | null;
|
|
1404
|
+
/**
|
|
1405
|
+
* Employer health amount in cents as a decimal string; null when unset.
|
|
1406
|
+
*/
|
|
1407
|
+
employer_combined_health_amount_cents: string | null;
|
|
1408
|
+
/**
|
|
1409
|
+
* Employer savings amount in cents as a decimal string; null when unset.
|
|
1410
|
+
*/
|
|
1411
|
+
employer_combined_savings_cents: string | null;
|
|
1412
|
+
/**
|
|
1413
|
+
* Currency from the company's current pay schedule, or the system default when it has none. It is company configuration context rather than historical employment data.
|
|
1414
|
+
*/
|
|
1415
|
+
currency: string;
|
|
1416
|
+
/**
|
|
1417
|
+
* ISO8601 timestamp when this version starts; null for an unbounded lower bound.
|
|
1418
|
+
*/
|
|
1419
|
+
valid_from: string | null;
|
|
1420
|
+
/**
|
|
1421
|
+
* ISO8601 timestamp when this version ends; null for an open-ended version.
|
|
1422
|
+
*/
|
|
1423
|
+
valid_to: string | null;
|
|
1424
|
+
/**
|
|
1425
|
+
* ISO8601 timestamp when this stored version was created.
|
|
1426
|
+
*/
|
|
1427
|
+
created_at: string;
|
|
1428
|
+
/**
|
|
1429
|
+
* ISO8601 timestamp when this stored version was last updated.
|
|
1430
|
+
*/
|
|
1431
|
+
updated_at: string;
|
|
1432
|
+
};
|
|
1433
|
+
export type PeopleEmploymentHistoryCorrectionObject = {
|
|
1434
|
+
/**
|
|
1435
|
+
* 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.
|
|
1436
|
+
*/
|
|
1437
|
+
people_employment_id: string;
|
|
1438
|
+
user_id: string;
|
|
1439
|
+
company_id: string;
|
|
1440
|
+
type: 'EMPLOYEE' | 'CONTRACTOR';
|
|
1441
|
+
title: string | null;
|
|
1442
|
+
compensation_type: 'hourly' | 'salary';
|
|
1443
|
+
payroll_id: string | null;
|
|
1444
|
+
manager_user_id: string | null;
|
|
1445
|
+
companies_department_id: string | null;
|
|
1446
|
+
enrolled_in_t_and_a: boolean;
|
|
1447
|
+
overtime_eligible: boolean | null;
|
|
1448
|
+
overtime_package_id: string | null;
|
|
1449
|
+
pay_rates_rule_package_id: string | null;
|
|
1450
|
+
pay_rates_package_id: string | null;
|
|
1451
|
+
worked_annual_minutes: number | null;
|
|
1452
|
+
pto_annual_minutes: number | null;
|
|
1453
|
+
holiday_annual_minutes: number | null;
|
|
1454
|
+
training_annual_minutes: number | null;
|
|
1455
|
+
hourly_rate_cents: string | null;
|
|
1456
|
+
training_annual_amount_cents: string | null;
|
|
1457
|
+
employer_combined_health_amount_cents: string | null;
|
|
1458
|
+
employer_combined_savings_cents: string | null;
|
|
1459
|
+
currency: string;
|
|
1460
|
+
valid_from: string | null;
|
|
1461
|
+
valid_to: string | null;
|
|
1462
|
+
created_at: string;
|
|
1463
|
+
updated_at: string;
|
|
1464
|
+
};
|
|
1465
|
+
export type PeopleEmploymentHistoryVersionObject = {
|
|
1466
|
+
/**
|
|
1467
|
+
* 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.
|
|
1468
|
+
*/
|
|
1469
|
+
people_employment_id: string;
|
|
1470
|
+
user_id: string;
|
|
1471
|
+
company_id: string;
|
|
1472
|
+
type: 'EMPLOYEE' | 'CONTRACTOR';
|
|
1473
|
+
title: string | null;
|
|
1474
|
+
compensation_type: 'hourly' | 'salary';
|
|
1475
|
+
payroll_id: string | null;
|
|
1476
|
+
manager_user_id: string | null;
|
|
1477
|
+
companies_department_id: string | null;
|
|
1478
|
+
enrolled_in_t_and_a: boolean;
|
|
1479
|
+
overtime_eligible: boolean | null;
|
|
1480
|
+
overtime_package_id: string | null;
|
|
1481
|
+
pay_rates_rule_package_id: string | null;
|
|
1482
|
+
pay_rates_package_id: string | null;
|
|
1483
|
+
worked_annual_minutes: number | null;
|
|
1484
|
+
pto_annual_minutes: number | null;
|
|
1485
|
+
holiday_annual_minutes: number | null;
|
|
1486
|
+
training_annual_minutes: number | null;
|
|
1487
|
+
hourly_rate_cents: string | null;
|
|
1488
|
+
training_annual_amount_cents: string | null;
|
|
1489
|
+
employer_combined_health_amount_cents: string | null;
|
|
1490
|
+
employer_combined_savings_cents: string | null;
|
|
1491
|
+
currency: string;
|
|
1492
|
+
valid_from: string | null;
|
|
1493
|
+
valid_to: string | null;
|
|
1494
|
+
created_at: string;
|
|
1495
|
+
updated_at: string;
|
|
1496
|
+
version_status: 'scheduled' | 'current' | 'historical';
|
|
1497
|
+
corrections: Array<PeopleEmploymentHistoryCorrectionObject>;
|
|
1498
|
+
};
|
|
1499
|
+
export type TimecodeHistoryCorrectionObject = {
|
|
1500
|
+
/**
|
|
1501
|
+
* 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.
|
|
1502
|
+
*/
|
|
1503
|
+
timekeeping_timecode_id: string;
|
|
1504
|
+
name: string;
|
|
1505
|
+
description: string | null;
|
|
1506
|
+
description_is_required: boolean;
|
|
1507
|
+
billable: boolean;
|
|
1508
|
+
overtime_eligible: boolean;
|
|
1509
|
+
unpaid: boolean;
|
|
1510
|
+
holiday: boolean;
|
|
1511
|
+
pto: boolean;
|
|
1512
|
+
safety: boolean;
|
|
1513
|
+
lunch_shortcut: boolean;
|
|
1514
|
+
break_shortcut: boolean;
|
|
1515
|
+
pwa: boolean;
|
|
1516
|
+
rest_and_recovery: boolean;
|
|
1517
|
+
incentive_pay_eligible: boolean;
|
|
1518
|
+
restricted_to: 'none' | 'job' | 'non_job' | 'job_with_timecode';
|
|
1519
|
+
default_for_company_id: string;
|
|
1520
|
+
valid_from: string | null;
|
|
1521
|
+
valid_to: string | null;
|
|
1522
|
+
transaction_from: string;
|
|
1523
|
+
transaction_to: string | null;
|
|
1524
|
+
created_at: string;
|
|
1525
|
+
updated_at: string;
|
|
1526
|
+
};
|
|
1527
|
+
export type TimecodeHistoryVersionObject = {
|
|
1528
|
+
/**
|
|
1529
|
+
* 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.
|
|
1530
|
+
*/
|
|
1531
|
+
timekeeping_timecode_id: string;
|
|
1532
|
+
name: string;
|
|
1533
|
+
description: string | null;
|
|
1534
|
+
description_is_required: boolean;
|
|
1535
|
+
billable: boolean;
|
|
1536
|
+
overtime_eligible: boolean;
|
|
1537
|
+
unpaid: boolean;
|
|
1538
|
+
holiday: boolean;
|
|
1539
|
+
pto: boolean;
|
|
1540
|
+
safety: boolean;
|
|
1541
|
+
lunch_shortcut: boolean;
|
|
1542
|
+
break_shortcut: boolean;
|
|
1543
|
+
pwa: boolean;
|
|
1544
|
+
rest_and_recovery: boolean;
|
|
1545
|
+
incentive_pay_eligible: boolean;
|
|
1546
|
+
restricted_to: 'none' | 'job' | 'non_job' | 'job_with_timecode';
|
|
1547
|
+
default_for_company_id: string;
|
|
1548
|
+
valid_from: string | null;
|
|
1549
|
+
valid_to: string | null;
|
|
1550
|
+
transaction_from: string;
|
|
1551
|
+
transaction_to: string | null;
|
|
1552
|
+
created_at: string;
|
|
1553
|
+
updated_at: string;
|
|
1554
|
+
version_status: 'scheduled' | 'current' | 'historical';
|
|
1555
|
+
corrections: Array<TimecodeHistoryCorrectionObject>;
|
|
1556
|
+
};
|
|
1557
|
+
/**
|
|
1558
|
+
* Request body for creating or updating a timecode; only `name` is required. On create, omitted fields take their model/DB defaults (noted per field). On update the request applies a bitemporal correction, so omitted fields keep the current version's values rather than reverting to defaults.
|
|
1559
|
+
*/
|
|
1560
|
+
export type TimecodeParameters = {
|
|
1561
|
+
/**
|
|
1562
|
+
* Human-readable name of the timecode. Required; must be unique within the company.
|
|
1563
|
+
*/
|
|
1564
|
+
name: string;
|
|
1565
|
+
/**
|
|
1566
|
+
* Optional free-text description; blank is stored as null.
|
|
1567
|
+
*/
|
|
1568
|
+
description?: string | null;
|
|
1569
|
+
/**
|
|
1570
|
+
* When true, users must supply a description when logging time against this timecode. Defaults to false on create.
|
|
1571
|
+
*/
|
|
1572
|
+
description_is_required?: boolean;
|
|
1573
|
+
/**
|
|
1574
|
+
* Whether tracked time is billable to the customer. Defaults to true on create.
|
|
1575
|
+
*/
|
|
1576
|
+
billable?: boolean;
|
|
1577
|
+
/**
|
|
1578
|
+
* Whether tracked time counts toward overtime. Defaults to true on create.
|
|
1579
|
+
*/
|
|
1580
|
+
overtime_eligible?: boolean;
|
|
1581
|
+
/**
|
|
1582
|
+
* Whether tracked time is unpaid. Defaults to false on create.
|
|
1583
|
+
*/
|
|
1584
|
+
unpaid?: boolean;
|
|
1585
|
+
/**
|
|
1586
|
+
* Whether the timecode represents holiday time. Defaults to false on create.
|
|
1587
|
+
*/
|
|
1588
|
+
holiday?: boolean;
|
|
1589
|
+
/**
|
|
1590
|
+
* Whether the timecode represents paid time off. Defaults to false on create.
|
|
1591
|
+
*/
|
|
1592
|
+
pto?: boolean;
|
|
1593
|
+
/**
|
|
1594
|
+
* Whether the timecode represents a safety hour or safety-related task. Defaults to false on create.
|
|
1595
|
+
*/
|
|
1596
|
+
safety?: boolean;
|
|
1597
|
+
/**
|
|
1598
|
+
* Marks this as the company's lunch-break shortcut; at most one per company. Defaults to false on create.
|
|
1599
|
+
*/
|
|
1600
|
+
lunch_shortcut?: boolean;
|
|
1601
|
+
/**
|
|
1602
|
+
* Marks this as the company's rest-break shortcut; at most one per company. Defaults to false on create.
|
|
1603
|
+
*/
|
|
1604
|
+
break_shortcut?: boolean;
|
|
1605
|
+
/**
|
|
1606
|
+
* Whether tracked time is prevailing-wage (PWA) eligible. Defaults to true on create. Cannot be true together with restricted_to: non_job.
|
|
1607
|
+
*/
|
|
1608
|
+
pwa?: boolean;
|
|
1609
|
+
/**
|
|
1610
|
+
* Whether the timecode represents rest-and-recovery time. Defaults to false on create.
|
|
1611
|
+
*/
|
|
1612
|
+
rest_and_recovery?: boolean;
|
|
1613
|
+
/**
|
|
1614
|
+
* Whether tracked time is eligible for incentive (holiday) pay. Defaults to false on create.
|
|
1615
|
+
*/
|
|
1616
|
+
incentive_pay_eligible?: boolean;
|
|
1617
|
+
/**
|
|
1618
|
+
* Where the timecode may be applied: none, job, non_job, or job_with_timecode. Defaults to none on create.
|
|
1619
|
+
*/
|
|
1620
|
+
restricted_to?: 'none' | 'job' | 'non_job' | 'job_with_timecode';
|
|
1621
|
+
/**
|
|
1622
|
+
* When the new timecode becomes effective. Defaults to the time of the request. Accepted on create only.
|
|
1623
|
+
*/
|
|
1624
|
+
effective_date?: string;
|
|
1625
|
+
};
|
|
1626
|
+
/**
|
|
1627
|
+
* 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.
|
|
1628
|
+
*/
|
|
1629
|
+
export type TimecodeCorrectionParameters = {
|
|
1630
|
+
/**
|
|
1631
|
+
* Where the correction starts applying. Defaults to the addressed version's own start.
|
|
1632
|
+
*/
|
|
1633
|
+
effective_from?: string;
|
|
1634
|
+
/**
|
|
1635
|
+
* 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.
|
|
1636
|
+
*/
|
|
1637
|
+
effective_to?: string;
|
|
1638
|
+
/**
|
|
1639
|
+
* Human-readable name of the timecode. Send it to change the name; omitted on update to retain the existing name.
|
|
1640
|
+
*/
|
|
1641
|
+
name?: string;
|
|
1642
|
+
/**
|
|
1643
|
+
* Optional free-text description; `null` clears it and a blank value is stored as null.
|
|
1644
|
+
*/
|
|
1645
|
+
description?: string | null;
|
|
1646
|
+
/**
|
|
1647
|
+
* Whether users must supply a description when logging time against this timecode.
|
|
1648
|
+
*/
|
|
1649
|
+
description_is_required?: boolean;
|
|
1650
|
+
/**
|
|
1651
|
+
* Whether tracked time is billable to the customer.
|
|
1652
|
+
*/
|
|
1653
|
+
billable?: boolean;
|
|
1654
|
+
/**
|
|
1655
|
+
* Whether tracked time counts toward overtime calculations.
|
|
1224
1656
|
*/
|
|
1225
|
-
effective_to?: string;
|
|
1226
|
-
name: string;
|
|
1227
|
-
description?: string | null;
|
|
1228
|
-
description_is_required?: boolean;
|
|
1229
|
-
billable?: boolean;
|
|
1230
1657
|
overtime_eligible?: boolean;
|
|
1658
|
+
/**
|
|
1659
|
+
* Whether tracked time is unpaid.
|
|
1660
|
+
*/
|
|
1231
1661
|
unpaid?: boolean;
|
|
1662
|
+
/**
|
|
1663
|
+
* Whether the timecode represents holiday time.
|
|
1664
|
+
*/
|
|
1232
1665
|
holiday?: boolean;
|
|
1666
|
+
/**
|
|
1667
|
+
* Whether the timecode represents paid time off.
|
|
1668
|
+
*/
|
|
1233
1669
|
pto?: boolean;
|
|
1670
|
+
/**
|
|
1671
|
+
* Whether the timecode represents a safety hour or safety-related task.
|
|
1672
|
+
*/
|
|
1234
1673
|
safety?: boolean;
|
|
1674
|
+
/**
|
|
1675
|
+
* Whether this timecode is the company's lunch-break shortcut.
|
|
1676
|
+
*/
|
|
1235
1677
|
lunch_shortcut?: boolean;
|
|
1678
|
+
/**
|
|
1679
|
+
* Whether this timecode is the company's rest-break shortcut.
|
|
1680
|
+
*/
|
|
1236
1681
|
break_shortcut?: boolean;
|
|
1682
|
+
/**
|
|
1683
|
+
* Whether tracked time is eligible for prevailing-wage (PWA) calculations. Cannot be true when restricted_to is non_job.
|
|
1684
|
+
*/
|
|
1237
1685
|
pwa?: boolean;
|
|
1686
|
+
/**
|
|
1687
|
+
* Whether the timecode represents rest-and-recovery time.
|
|
1688
|
+
*/
|
|
1238
1689
|
rest_and_recovery?: boolean;
|
|
1690
|
+
/**
|
|
1691
|
+
* Whether tracked time is eligible for incentive (holiday) pay.
|
|
1692
|
+
*/
|
|
1239
1693
|
incentive_pay_eligible?: boolean;
|
|
1694
|
+
/**
|
|
1695
|
+
* Where the timecode may be applied: none, job, non_job, or job_with_timecode.
|
|
1696
|
+
*/
|
|
1240
1697
|
restricted_to?: 'none' | 'job' | 'non_job' | 'job_with_timecode';
|
|
1241
1698
|
};
|
|
1699
|
+
/**
|
|
1700
|
+
* 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.
|
|
1701
|
+
*/
|
|
1242
1702
|
export type TimecodeGenesisParameters = {
|
|
1243
1703
|
/**
|
|
1244
|
-
* The
|
|
1704
|
+
* 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
1705
|
*/
|
|
1246
1706
|
effective_date: string;
|
|
1247
1707
|
};
|
|
@@ -1587,11 +2047,11 @@ export type PerDiemResponseObject = {
|
|
|
1587
2047
|
updated_at: string;
|
|
1588
2048
|
};
|
|
1589
2049
|
/**
|
|
1590
|
-
*
|
|
2050
|
+
* Request body for creating a per diem. name, currency, and rate_cents are required.
|
|
1591
2051
|
*/
|
|
1592
2052
|
export type PerDiemParameters = {
|
|
1593
2053
|
/**
|
|
1594
|
-
* Human-readable name, e.g. "Travel Meals".
|
|
2054
|
+
* Human-readable name, e.g. "Travel Meals". Required.
|
|
1595
2055
|
*/
|
|
1596
2056
|
name: string;
|
|
1597
2057
|
/**
|
|
@@ -1599,11 +2059,11 @@ export type PerDiemParameters = {
|
|
|
1599
2059
|
*/
|
|
1600
2060
|
description?: string | null;
|
|
1601
2061
|
/**
|
|
1602
|
-
* Allowance amount in cents, as a string (e.g. "7500" is $75.00).
|
|
2062
|
+
* Allowance amount in cents, as a string (e.g. "7500" is $75.00). Required.
|
|
1603
2063
|
*/
|
|
1604
2064
|
rate_cents: string;
|
|
1605
2065
|
/**
|
|
1606
|
-
* ISO 4217 currency code, e.g. "USD".
|
|
2066
|
+
* ISO 4217 currency code, e.g. "USD". Required.
|
|
1607
2067
|
*/
|
|
1608
2068
|
currency: string;
|
|
1609
2069
|
/**
|
|
@@ -1627,6 +2087,47 @@ export type PerDiemParameters = {
|
|
|
1627
2087
|
*/
|
|
1628
2088
|
timekeeping_timecode_ids?: Array<string>;
|
|
1629
2089
|
};
|
|
2090
|
+
/**
|
|
2091
|
+
* Request body for updating a per diem. Send only the fields to change.
|
|
2092
|
+
*/
|
|
2093
|
+
export type PerDiemUpdateParameters = {
|
|
2094
|
+
/**
|
|
2095
|
+
* Human-readable name, e.g. "Travel Meals". Omit to leave it unchanged.
|
|
2096
|
+
*/
|
|
2097
|
+
name?: string;
|
|
2098
|
+
/**
|
|
2099
|
+
* Optional free-text notes; omit to leave them unchanged, or send null to clear them.
|
|
2100
|
+
*/
|
|
2101
|
+
description?: string | null;
|
|
2102
|
+
/**
|
|
2103
|
+
* Allowance amount in cents, as a string (e.g. "7500" is $75.00). Omit to leave it unchanged.
|
|
2104
|
+
*/
|
|
2105
|
+
rate_cents?: string;
|
|
2106
|
+
/**
|
|
2107
|
+
* ISO 4217 currency code, e.g. "USD". Omit to leave it unchanged.
|
|
2108
|
+
*/
|
|
2109
|
+
currency?: string;
|
|
2110
|
+
/**
|
|
2111
|
+
* Whether the allowance is treated as taxable income. Omit to leave it unchanged.
|
|
2112
|
+
*/
|
|
2113
|
+
taxable?: boolean;
|
|
2114
|
+
/**
|
|
2115
|
+
* Whether this should become the company default per diem. Omit to leave it unchanged.
|
|
2116
|
+
*/
|
|
2117
|
+
default?: boolean | null;
|
|
2118
|
+
/**
|
|
2119
|
+
* Whether the per diem is active and available to use. Omit to leave it unchanged.
|
|
2120
|
+
*/
|
|
2121
|
+
active?: boolean | null;
|
|
2122
|
+
/**
|
|
2123
|
+
* Complete set of work type IDs this per diem applies to. Omit to leave it unchanged.
|
|
2124
|
+
*/
|
|
2125
|
+
work_type_ids?: Array<string>;
|
|
2126
|
+
/**
|
|
2127
|
+
* Complete set of timecode IDs this per diem applies to. Omit to leave it unchanged.
|
|
2128
|
+
*/
|
|
2129
|
+
timekeeping_timecode_ids?: Array<string>;
|
|
2130
|
+
};
|
|
1630
2131
|
/**
|
|
1631
2132
|
* The product's filled attribute values — one entry per attribute assigned to its category.
|
|
1632
2133
|
*/
|
|
@@ -1724,6 +2225,40 @@ export type AssetsAttributeParameters = {
|
|
|
1724
2225
|
_destroy?: boolean;
|
|
1725
2226
|
}>;
|
|
1726
2227
|
};
|
|
2228
|
+
/**
|
|
2229
|
+
* 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.
|
|
2230
|
+
*/
|
|
2231
|
+
export type AssetsAttributeUpdateParameters = {
|
|
2232
|
+
/**
|
|
2233
|
+
* The attribute's name.
|
|
2234
|
+
*/
|
|
2235
|
+
name?: string;
|
|
2236
|
+
/**
|
|
2237
|
+
* 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.
|
|
2238
|
+
*/
|
|
2239
|
+
data_type?: 'text' | 'number' | 'date' | 'boolean' | 'select';
|
|
2240
|
+
/**
|
|
2241
|
+
* 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.
|
|
2242
|
+
*/
|
|
2243
|
+
options?: Array<{
|
|
2244
|
+
/**
|
|
2245
|
+
* Unique identifier.
|
|
2246
|
+
*/
|
|
2247
|
+
id?: string;
|
|
2248
|
+
/**
|
|
2249
|
+
* The option's label.
|
|
2250
|
+
*/
|
|
2251
|
+
value?: string;
|
|
2252
|
+
/**
|
|
2253
|
+
* Display order within the list (0-based).
|
|
2254
|
+
*/
|
|
2255
|
+
position?: number;
|
|
2256
|
+
/**
|
|
2257
|
+
* Set true to remove this entry.
|
|
2258
|
+
*/
|
|
2259
|
+
_destroy?: boolean;
|
|
2260
|
+
}>;
|
|
2261
|
+
};
|
|
1727
2262
|
/**
|
|
1728
2263
|
* 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
2264
|
*/
|
|
@@ -1824,6 +2359,48 @@ export type AssetsCategoryParameters = {
|
|
|
1824
2359
|
_destroy?: boolean;
|
|
1825
2360
|
}>;
|
|
1826
2361
|
};
|
|
2362
|
+
/**
|
|
2363
|
+
* Update a category. All fields are optional — send only what changes. `category_attributes` sets this category's direct attribute assignments.
|
|
2364
|
+
*/
|
|
2365
|
+
export type AssetsCategoryUpdateParameters = {
|
|
2366
|
+
/**
|
|
2367
|
+
* The category's name.
|
|
2368
|
+
*/
|
|
2369
|
+
name?: string;
|
|
2370
|
+
/**
|
|
2371
|
+
* ID of the parent category; null for a root category.
|
|
2372
|
+
*/
|
|
2373
|
+
parent_id?: string | null;
|
|
2374
|
+
/**
|
|
2375
|
+
* Attribute assignments for this category. Include id to update an existing assignment, omit id to add one, or set _destroy to remove one.
|
|
2376
|
+
*/
|
|
2377
|
+
category_attributes?: Array<{
|
|
2378
|
+
/**
|
|
2379
|
+
* Unique identifier.
|
|
2380
|
+
*/
|
|
2381
|
+
id?: string;
|
|
2382
|
+
/**
|
|
2383
|
+
* ID of the attribute definition.
|
|
2384
|
+
*/
|
|
2385
|
+
assets_attribute_id: string;
|
|
2386
|
+
/**
|
|
2387
|
+
* Where this attribute is filled in for the category: product (on the catalog product) or item (on each individual item).
|
|
2388
|
+
*/
|
|
2389
|
+
fillable_on: 'product' | 'item';
|
|
2390
|
+
/**
|
|
2391
|
+
* Whether a value for this attribute must be provided.
|
|
2392
|
+
*/
|
|
2393
|
+
required?: boolean;
|
|
2394
|
+
/**
|
|
2395
|
+
* Display order within the list (0-based).
|
|
2396
|
+
*/
|
|
2397
|
+
position?: number;
|
|
2398
|
+
/**
|
|
2399
|
+
* Set true to remove this entry.
|
|
2400
|
+
*/
|
|
2401
|
+
_destroy?: boolean;
|
|
2402
|
+
}>;
|
|
2403
|
+
};
|
|
1827
2404
|
/**
|
|
1828
2405
|
* A company department that workers can be assigned to.
|
|
1829
2406
|
*/
|
|
@@ -1854,7 +2431,7 @@ export type DepartmentResponseObject = {
|
|
|
1854
2431
|
updated_at: string;
|
|
1855
2432
|
};
|
|
1856
2433
|
/**
|
|
1857
|
-
* Request body for creating
|
|
2434
|
+
* Request body for creating a department.
|
|
1858
2435
|
*/
|
|
1859
2436
|
export type DepartmentParameters = {
|
|
1860
2437
|
/**
|
|
@@ -1866,6 +2443,19 @@ export type DepartmentParameters = {
|
|
|
1866
2443
|
*/
|
|
1867
2444
|
description?: string | null;
|
|
1868
2445
|
};
|
|
2446
|
+
/**
|
|
2447
|
+
* Request body for updating a department. Send only the fields to change.
|
|
2448
|
+
*/
|
|
2449
|
+
export type DepartmentUpdateParameters = {
|
|
2450
|
+
/**
|
|
2451
|
+
* Department name; unique within the company. Omit to leave it unchanged.
|
|
2452
|
+
*/
|
|
2453
|
+
name?: string;
|
|
2454
|
+
/**
|
|
2455
|
+
* Optional free-text description; null clears it.
|
|
2456
|
+
*/
|
|
2457
|
+
description?: string | null;
|
|
2458
|
+
};
|
|
1869
2459
|
/**
|
|
1870
2460
|
* 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
2461
|
*/
|
|
@@ -1912,7 +2502,7 @@ export type TimeCardPerDiemResponseObject = {
|
|
|
1912
2502
|
updated_at: string;
|
|
1913
2503
|
};
|
|
1914
2504
|
/**
|
|
1915
|
-
* Request body for recording
|
|
2505
|
+
* 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
2506
|
*/
|
|
1917
2507
|
export type TimeCardPerDiemParameters = {
|
|
1918
2508
|
/**
|
|
@@ -1924,9 +2514,26 @@ export type TimeCardPerDiemParameters = {
|
|
|
1924
2514
|
*/
|
|
1925
2515
|
approver_user_id: string;
|
|
1926
2516
|
/**
|
|
1927
|
-
* ID of the catalog per diem to record; its rate, currency, and taxable flag are copied onto the entry.
|
|
2517
|
+
* Optional ID of the catalog per diem to record; its rate, currency, and taxable flag are copied onto the entry.
|
|
1928
2518
|
*/
|
|
1929
|
-
per_diem_id
|
|
2519
|
+
per_diem_id?: string;
|
|
2520
|
+
};
|
|
2521
|
+
/**
|
|
2522
|
+
* 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.
|
|
2523
|
+
*/
|
|
2524
|
+
export type TimeCardPerDiemUpdateParameters = {
|
|
2525
|
+
/**
|
|
2526
|
+
* Calendar date (YYYY-MM-DD) the per diem applies to; must fall within the card's pay period. Omit to leave it unchanged.
|
|
2527
|
+
*/
|
|
2528
|
+
date?: string;
|
|
2529
|
+
/**
|
|
2530
|
+
* ID of the user recorded as approving the per diem. Omit to leave it unchanged.
|
|
2531
|
+
*/
|
|
2532
|
+
approver_user_id?: string;
|
|
2533
|
+
/**
|
|
2534
|
+
* ID of the catalog per diem to record; its rate, currency, and taxable flag are copied onto the entry. Omit to leave it unchanged.
|
|
2535
|
+
*/
|
|
2536
|
+
per_diem_id?: string;
|
|
1930
2537
|
};
|
|
1931
2538
|
/**
|
|
1932
2539
|
* 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 +2784,7 @@ export type PayPeriodConfigHistoryVersionObject = {
|
|
|
2177
2784
|
corrections: Array<PayPeriodConfigHistoryCorrectionObject>;
|
|
2178
2785
|
};
|
|
2179
2786
|
/**
|
|
2180
|
-
* Create
|
|
2787
|
+
* 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
2788
|
*/
|
|
2182
2789
|
export type HolidayParameters = {
|
|
2183
2790
|
/**
|
|
@@ -2229,6 +2836,59 @@ export type HolidayParameters = {
|
|
|
2229
2836
|
*/
|
|
2230
2837
|
count_hours_for_overtime?: boolean;
|
|
2231
2838
|
};
|
|
2839
|
+
/**
|
|
2840
|
+
* Update a holiday on a pay schedule. Send only the fields to change; the resulting fixed or floating definition must remain complete.
|
|
2841
|
+
*/
|
|
2842
|
+
export type HolidayUpdateParameters = {
|
|
2843
|
+
/**
|
|
2844
|
+
* The holiday's human-readable label (e.g. "Thanksgiving"). Omit to leave it unchanged.
|
|
2845
|
+
*/
|
|
2846
|
+
name?: string;
|
|
2847
|
+
/**
|
|
2848
|
+
* Calendar date (YYYY-MM-DD) the holiday falls on. Omit to let the definition calculate it or to leave the calculated date unchanged.
|
|
2849
|
+
*/
|
|
2850
|
+
date?: string;
|
|
2851
|
+
/**
|
|
2852
|
+
* `fixed` holidays use month + mday; `floating` holidays use month + week + wday. Omit to leave it unchanged.
|
|
2853
|
+
*/
|
|
2854
|
+
holiday_type?: 'fixed' | 'floating';
|
|
2855
|
+
/**
|
|
2856
|
+
* Month 1-12. Omit to leave it unchanged.
|
|
2857
|
+
*/
|
|
2858
|
+
month?: number;
|
|
2859
|
+
/**
|
|
2860
|
+
* Day of month for a fixed holiday. Omit to leave it unchanged.
|
|
2861
|
+
*/
|
|
2862
|
+
mday?: number;
|
|
2863
|
+
/**
|
|
2864
|
+
* Weekday 0-6 (Sunday=0) for a floating holiday. Omit to leave it unchanged.
|
|
2865
|
+
*/
|
|
2866
|
+
wday?: number;
|
|
2867
|
+
/**
|
|
2868
|
+
* Nth weekday of the month for a floating holiday. Omit to leave it unchanged.
|
|
2869
|
+
*/
|
|
2870
|
+
week?: number;
|
|
2871
|
+
/**
|
|
2872
|
+
* Anchor year for date calculation. Omit to leave it unchanged.
|
|
2873
|
+
*/
|
|
2874
|
+
year?: number;
|
|
2875
|
+
/**
|
|
2876
|
+
* Observe on the nearest weekday when it falls on a weekend. Omit to leave it unchanged.
|
|
2877
|
+
*/
|
|
2878
|
+
move_to_weekday?: boolean;
|
|
2879
|
+
/**
|
|
2880
|
+
* Whether overtime rules targeting holidays automatically apply. Omit to leave it unchanged.
|
|
2881
|
+
*/
|
|
2882
|
+
overtime?: boolean;
|
|
2883
|
+
/**
|
|
2884
|
+
* Whether this is a banking holiday. Omit to leave it unchanged.
|
|
2885
|
+
*/
|
|
2886
|
+
banking?: boolean;
|
|
2887
|
+
/**
|
|
2888
|
+
* Whether worked hours count toward overtime; false unless overtime is true. Omit to leave it unchanged.
|
|
2889
|
+
*/
|
|
2890
|
+
count_hours_for_overtime?: boolean;
|
|
2891
|
+
};
|
|
2232
2892
|
/**
|
|
2233
2893
|
* 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
2894
|
*/
|
|
@@ -2270,78 +2930,163 @@ export type PwaCompanyUserDetailsResponseObject = {
|
|
|
2270
2930
|
*/
|
|
2271
2931
|
race: Array<'AFRICAN_AMERICAN' | 'ASIAN' | 'CAUCASIAN' | 'NATIVE_AMERICAN' | 'NOT_SPECIFIED' | 'OTHER'> | null;
|
|
2272
2932
|
/**
|
|
2273
|
-
* Worker sex for demographic reporting: one of female, male, non_binary, or not_specified; null when unset.
|
|
2933
|
+
* Worker sex for demographic reporting: one of female, male, non_binary, or not_specified; null when unset.
|
|
2934
|
+
*/
|
|
2935
|
+
sex: 'female' | 'male' | 'non_binary' | 'not_specified' | null;
|
|
2936
|
+
/**
|
|
2937
|
+
* Local business license number, when a jurisdiction requires it on certified payroll; null when unset.
|
|
2938
|
+
*/
|
|
2939
|
+
local_business_license: string | null;
|
|
2940
|
+
/**
|
|
2941
|
+
* Two-letter US state that issued the worker's driver's license; null when unset.
|
|
2942
|
+
*/
|
|
2943
|
+
drivers_license_state: string | null;
|
|
2944
|
+
/**
|
|
2945
|
+
* Worker's driver's license number (stored encrypted); null when unset.
|
|
2946
|
+
*/
|
|
2947
|
+
drivers_license_number: string | null;
|
|
2948
|
+
/**
|
|
2949
|
+
* Worker Social Security Number (nine digits, stored encrypted), required on certified payroll in some jurisdictions; null when unset.
|
|
2950
|
+
*/
|
|
2951
|
+
ssn: string | null;
|
|
2952
|
+
/**
|
|
2953
|
+
* Veteran status per US Census definitions: one of protected_veteran, not_protected_veteran, reserves, guard, or not_specified; null when unset.
|
|
2954
|
+
*/
|
|
2955
|
+
veteran_status: 'protected_veteran' | 'not_protected_veteran' | 'reserves' | 'guard' | 'not_specified' | null;
|
|
2956
|
+
/**
|
|
2957
|
+
* Whether the worker is of Hispanic origin per US Census definitions: one of yes, no, or not_specified; null when unset.
|
|
2958
|
+
*/
|
|
2959
|
+
hispanic_origin: 'yes' | 'no' | 'not_specified' | null;
|
|
2960
|
+
/**
|
|
2961
|
+
* Number of payroll withholding exemptions reported on California DIR certified payroll (eCPR), 0 to 99; null when unset.
|
|
2962
|
+
*/
|
|
2963
|
+
ca_dir_withholding_exemptions: number | null;
|
|
2964
|
+
/**
|
|
2965
|
+
* Whether the worker has a disability, for demographic reporting.
|
|
2966
|
+
*/
|
|
2967
|
+
disabled: boolean;
|
|
2968
|
+
/**
|
|
2969
|
+
* Illinois DOL race classification for Illinois prevailing-wage reporting, as a single code (e.g. white, black, hispanic_or_latino); null when unset. See the schema enum for the full set.
|
|
2970
|
+
*/
|
|
2971
|
+
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;
|
|
2972
|
+
/**
|
|
2973
|
+
* Illinois SHINES employment type: one of part_time, full_time, seasonal_temporary, or independent_contract; null when unset.
|
|
2974
|
+
*/
|
|
2975
|
+
il_shines_employment_type: 'part_time' | 'full_time' | 'seasonal_temporary' | 'independent_contract' | null;
|
|
2976
|
+
/**
|
|
2977
|
+
* Illinois SHINES Equity Eligible Person (EEP) qualifiers for the worker, as an array of codes (e.g. eep_program_completed, foster_care, formerly_incarcerated); null when unset. See the schema enum for the full set.
|
|
2978
|
+
*/
|
|
2979
|
+
il_shines_eep_qualifiers: Array<'eep_program_completed' | 'foster_care' | 'formerly_incarcerated' | 'equity_investment_eligible_community' | 'self_registered_or_unknown'> | null;
|
|
2980
|
+
/**
|
|
2981
|
+
* Illinois SHINES workforce-program participation, as an array of program codes (e.g. solar_training_pipeline_program, craft_apprenticeship_program); null when unset. See the schema enum for the full set.
|
|
2982
|
+
*/
|
|
2983
|
+
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;
|
|
2984
|
+
/**
|
|
2985
|
+
* Oregon BOLI workweek schedule: five_eight (five eight-hour days) or four_ten (four ten-hour days); null when unset.
|
|
2986
|
+
*/
|
|
2987
|
+
or_boli_schedule_type: 'five_eight' | 'four_ten' | null;
|
|
2988
|
+
/**
|
|
2989
|
+
* Oregon BOLI race classification, as an array of codes (e.g. white, asian, hispanic_or_latino, black_or_african_american); null when unset. See the schema enum for the full set.
|
|
2990
|
+
*/
|
|
2991
|
+
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;
|
|
2992
|
+
};
|
|
2993
|
+
/**
|
|
2994
|
+
* 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.
|
|
2995
|
+
*/
|
|
2996
|
+
export type PwaCompanyUserDetailsParameters = {
|
|
2997
|
+
/**
|
|
2998
|
+
* 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.
|
|
2999
|
+
*/
|
|
3000
|
+
user_id: string;
|
|
3001
|
+
/**
|
|
3002
|
+
* Home street address line 1, for certified-payroll reporting; required together with city, state, and zip when any home-address field is set.
|
|
3003
|
+
*/
|
|
3004
|
+
address1?: string | null;
|
|
3005
|
+
/**
|
|
3006
|
+
* Home street address line 2.
|
|
3007
|
+
*/
|
|
3008
|
+
address2?: string | null;
|
|
3009
|
+
/**
|
|
3010
|
+
* Home address city; required together with address1 when any home-address field is set.
|
|
3011
|
+
*/
|
|
3012
|
+
city?: string | null;
|
|
3013
|
+
/**
|
|
3014
|
+
* Home address two-letter US state code; required together with address1 when any home-address field is set.
|
|
3015
|
+
*/
|
|
3016
|
+
state?: string | null;
|
|
3017
|
+
/**
|
|
3018
|
+
* Home address ZIP code; required together with address1 when any home-address field is set.
|
|
3019
|
+
*/
|
|
3020
|
+
zip?: string | null;
|
|
3021
|
+
/**
|
|
3022
|
+
* Worker race for demographic reporting, as an array of codes (e.g. CAUCASIAN, AFRICAN_AMERICAN, ASIAN, NATIVE_AMERICAN, OTHER, NOT_SPECIFIED).
|
|
3023
|
+
*/
|
|
3024
|
+
race?: Array<'AFRICAN_AMERICAN' | 'ASIAN' | 'CAUCASIAN' | 'NATIVE_AMERICAN' | 'NOT_SPECIFIED' | 'OTHER'> | null;
|
|
3025
|
+
/**
|
|
3026
|
+
* Worker sex for demographic reporting: one of female, male, non_binary, or not_specified.
|
|
2274
3027
|
*/
|
|
2275
|
-
sex
|
|
3028
|
+
sex?: 'female' | 'male' | 'non_binary' | 'not_specified' | null;
|
|
2276
3029
|
/**
|
|
2277
|
-
* Local business license number, when a jurisdiction requires it on certified payroll
|
|
3030
|
+
* Local business license number, when a jurisdiction requires it on certified payroll.
|
|
2278
3031
|
*/
|
|
2279
|
-
local_business_license
|
|
3032
|
+
local_business_license?: string | null;
|
|
2280
3033
|
/**
|
|
2281
|
-
* Two-letter US state that issued the worker's driver's license
|
|
3034
|
+
* Two-letter US state that issued the worker's driver's license.
|
|
2282
3035
|
*/
|
|
2283
|
-
drivers_license_state
|
|
3036
|
+
drivers_license_state?: string | null;
|
|
2284
3037
|
/**
|
|
2285
|
-
* Worker's driver's license number (stored encrypted)
|
|
3038
|
+
* Worker's driver's license number (stored encrypted).
|
|
2286
3039
|
*/
|
|
2287
|
-
drivers_license_number
|
|
3040
|
+
drivers_license_number?: string | null;
|
|
2288
3041
|
/**
|
|
2289
|
-
* Worker Social Security Number (nine digits, stored encrypted), required on certified payroll in some jurisdictions
|
|
3042
|
+
* Worker Social Security Number (nine digits, stored encrypted), required on certified payroll in some jurisdictions.
|
|
2290
3043
|
*/
|
|
2291
|
-
ssn
|
|
3044
|
+
ssn?: string | null;
|
|
2292
3045
|
/**
|
|
2293
|
-
* Veteran status per US Census definitions: one of protected_veteran, not_protected_veteran, reserves, guard, or not_specified
|
|
3046
|
+
* Veteran status per US Census definitions: one of protected_veteran, not_protected_veteran, reserves, guard, or not_specified.
|
|
2294
3047
|
*/
|
|
2295
|
-
veteran_status
|
|
3048
|
+
veteran_status?: 'protected_veteran' | 'not_protected_veteran' | 'reserves' | 'guard' | 'not_specified' | null;
|
|
2296
3049
|
/**
|
|
2297
|
-
* Whether the worker is of Hispanic origin per US Census definitions: one of yes, no, or not_specified
|
|
3050
|
+
* Whether the worker is of Hispanic origin per US Census definitions: one of yes, no, or not_specified.
|
|
2298
3051
|
*/
|
|
2299
|
-
hispanic_origin
|
|
3052
|
+
hispanic_origin?: 'yes' | 'no' | 'not_specified' | null;
|
|
2300
3053
|
/**
|
|
2301
|
-
* Number of payroll withholding exemptions reported on California DIR certified payroll (eCPR), 0 to 99
|
|
3054
|
+
* Number of payroll withholding exemptions reported on California DIR certified payroll (eCPR), 0 to 99.
|
|
2302
3055
|
*/
|
|
2303
|
-
ca_dir_withholding_exemptions
|
|
3056
|
+
ca_dir_withholding_exemptions?: number | null;
|
|
2304
3057
|
/**
|
|
2305
3058
|
* Whether the worker has a disability, for demographic reporting.
|
|
2306
3059
|
*/
|
|
2307
|
-
disabled
|
|
3060
|
+
disabled?: boolean;
|
|
2308
3061
|
/**
|
|
2309
|
-
* Illinois DOL race classification for Illinois prevailing-wage reporting, as a single code (e.g. white, black, hispanic_or_latino)
|
|
3062
|
+
* 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.
|
|
2310
3063
|
*/
|
|
2311
|
-
il_dol_race
|
|
3064
|
+
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;
|
|
2312
3065
|
/**
|
|
2313
|
-
* Illinois SHINES employment type: one of part_time, full_time, seasonal_temporary, or independent_contract
|
|
3066
|
+
* Illinois SHINES employment type: one of part_time, full_time, seasonal_temporary, or independent_contract.
|
|
2314
3067
|
*/
|
|
2315
|
-
il_shines_employment_type
|
|
3068
|
+
il_shines_employment_type?: 'part_time' | 'full_time' | 'seasonal_temporary' | 'independent_contract' | null;
|
|
2316
3069
|
/**
|
|
2317
|
-
* Illinois SHINES Equity Eligible Person (EEP) qualifiers for the worker, as an array of codes (e.g. eep_program_completed, foster_care, formerly_incarcerated)
|
|
3070
|
+
* 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.
|
|
2318
3071
|
*/
|
|
2319
|
-
il_shines_eep_qualifiers
|
|
3072
|
+
il_shines_eep_qualifiers?: Array<'eep_program_completed' | 'foster_care' | 'formerly_incarcerated' | 'equity_investment_eligible_community' | 'self_registered_or_unknown'> | null;
|
|
2320
3073
|
/**
|
|
2321
|
-
* Illinois SHINES workforce-program participation, as an array of program codes (e.g. solar_training_pipeline_program, craft_apprenticeship_program)
|
|
3074
|
+
* 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.
|
|
2322
3075
|
*/
|
|
2323
|
-
il_shines_other_programs
|
|
3076
|
+
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;
|
|
2324
3077
|
/**
|
|
2325
|
-
* Oregon BOLI workweek schedule: five_eight (five eight-hour days) or four_ten (four ten-hour days)
|
|
3078
|
+
* Oregon BOLI workweek schedule: five_eight (five eight-hour days) or four_ten (four ten-hour days).
|
|
2326
3079
|
*/
|
|
2327
|
-
or_boli_schedule_type
|
|
3080
|
+
or_boli_schedule_type?: 'five_eight' | 'four_ten' | null;
|
|
2328
3081
|
/**
|
|
2329
|
-
* Oregon BOLI race classification, as an array of codes (e.g. white, asian, hispanic_or_latino, black_or_african_american)
|
|
3082
|
+
* Oregon BOLI race classification, as an array of codes (e.g. white, asian, hispanic_or_latino, black_or_african_american).
|
|
2330
3083
|
*/
|
|
2331
|
-
or_boli_race
|
|
3084
|
+
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
3085
|
};
|
|
2333
3086
|
/**
|
|
2334
|
-
*
|
|
3087
|
+
* 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.
|
|
2335
3088
|
*/
|
|
2336
|
-
export type
|
|
2337
|
-
/**
|
|
2338
|
-
* ID of the company the compliance details belong to; required on create, ignored on update (the company cannot be changed afterward).
|
|
2339
|
-
*/
|
|
2340
|
-
company_id: string;
|
|
2341
|
-
/**
|
|
2342
|
-
* ID of the worker the compliance details belong to; required on create, ignored on update (the worker cannot be changed afterward).
|
|
2343
|
-
*/
|
|
2344
|
-
user_id: string;
|
|
3089
|
+
export type PwaCompanyUserDetailsUpdateParameters = {
|
|
2345
3090
|
/**
|
|
2346
3091
|
* Home street address line 1, for certified-payroll reporting; required together with city, state, and zip when any home-address field is set.
|
|
2347
3092
|
*/
|
|
@@ -2805,7 +3550,7 @@ export type PwaJobDetailsResponseObject = {
|
|
|
2805
3550
|
ny_dol_prc_number?: string | null;
|
|
2806
3551
|
} | null;
|
|
2807
3552
|
/**
|
|
2808
|
-
*
|
|
3553
|
+
* Fields shared by job creation and updates. Updates may omit any field to preserve its current value. The resulting job must still satisfy its schedule and PWA validation rules. Extra keys are accepted, including custom fields.
|
|
2809
3554
|
*/
|
|
2810
3555
|
export type JobParameters = {
|
|
2811
3556
|
/**
|
|
@@ -2821,13 +3566,13 @@ export type JobParameters = {
|
|
|
2821
3566
|
*/
|
|
2822
3567
|
description?: string;
|
|
2823
3568
|
/**
|
|
2824
|
-
* ID of the company that requested the job (for example a general contractor). Required.
|
|
3569
|
+
* ID of the company that requested the job (for example a general contractor). Required on create; omit on update to preserve the existing requester.
|
|
2825
3570
|
*/
|
|
2826
|
-
requested_by_company_id
|
|
3571
|
+
requested_by_company_id?: string;
|
|
2827
3572
|
/**
|
|
2828
3573
|
* ID of the user creating the job. Required on create and immutable thereafter — an update that sets, changes, or clears it is rejected.
|
|
2829
3574
|
*/
|
|
2830
|
-
created_by_user_id
|
|
3575
|
+
created_by_user_id?: string;
|
|
2831
3576
|
/**
|
|
2832
3577
|
* IDs of the users who manage the job; null when the job has no managers.
|
|
2833
3578
|
*/
|
|
@@ -3048,7 +3793,13 @@ export type JobParameters = {
|
|
|
3048
3793
|
[key: string]: unknown;
|
|
3049
3794
|
};
|
|
3050
3795
|
/**
|
|
3051
|
-
* Parameters for
|
|
3796
|
+
* Parameters for creating a job. `requested_by_company_id` and `created_by_user_id` are required. Sets the job's schedule, work types, address, and optional Prevailing Wage / Apprenticeship (PWA) compliance.
|
|
3797
|
+
*/
|
|
3798
|
+
export type JobCreateParameters = JobParameters & {
|
|
3799
|
+
[key: string]: unknown;
|
|
3800
|
+
};
|
|
3801
|
+
/**
|
|
3802
|
+
* Parameters for updating an existing job. Every field is optional; omit a field to preserve its current value. The resulting job must still satisfy schedule and PWA validation rules. Accepts every shared job field plus a directly settable status.
|
|
3052
3803
|
*/
|
|
3053
3804
|
export type JobUpdateParameters = JobParameters & {
|
|
3054
3805
|
/**
|
|
@@ -3095,7 +3846,7 @@ export type GroupResponseObject = {
|
|
|
3095
3846
|
updated_at: string;
|
|
3096
3847
|
};
|
|
3097
3848
|
/**
|
|
3098
|
-
* Request body for creating
|
|
3849
|
+
* Request body for creating a group.
|
|
3099
3850
|
*/
|
|
3100
3851
|
export type GroupParameters = {
|
|
3101
3852
|
/**
|
|
@@ -3103,6 +3854,15 @@ export type GroupParameters = {
|
|
|
3103
3854
|
*/
|
|
3104
3855
|
name: string;
|
|
3105
3856
|
};
|
|
3857
|
+
/**
|
|
3858
|
+
* Request body for updating a group. Send only the fields to change.
|
|
3859
|
+
*/
|
|
3860
|
+
export type GroupUpdateParameters = {
|
|
3861
|
+
/**
|
|
3862
|
+
* The group's display name; unique within the company. Omit to leave it unchanged.
|
|
3863
|
+
*/
|
|
3864
|
+
name?: string;
|
|
3865
|
+
};
|
|
3106
3866
|
/**
|
|
3107
3867
|
* 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
3868
|
*/
|
|
@@ -3486,11 +4246,11 @@ export type UserParameters = {
|
|
|
3486
4246
|
*/
|
|
3487
4247
|
avatar_signed_id?: string;
|
|
3488
4248
|
/**
|
|
3489
|
-
* Id of the internal user recorded as the creator of the worker's invite. Ignored when skip_invite is set.
|
|
4249
|
+
* Id of the internal user recorded as the creator of the worker's invite, and named to the recipient as the person inviting them; must be a member of your company. Ignored when skip_invite is set.
|
|
3490
4250
|
*/
|
|
3491
4251
|
created_by_user_id?: string;
|
|
3492
4252
|
/**
|
|
3493
|
-
* Id of the internal user recorded as having last sent the worker's invite. Null, and ignored, when skip_invite is set.
|
|
4253
|
+
* Id of the internal user recorded as having last sent the worker's invite, and named as the sender on that person's in-app notification; must be a member of your company. Null, and ignored, when skip_invite is set.
|
|
3494
4254
|
*/
|
|
3495
4255
|
last_sent_by_user_id?: string | null;
|
|
3496
4256
|
/**
|
|
@@ -4258,7 +5018,7 @@ export type PositionFunctionResponseObject = {
|
|
|
4258
5018
|
updated_at: string;
|
|
4259
5019
|
};
|
|
4260
5020
|
/**
|
|
4261
|
-
* Request body for creating
|
|
5021
|
+
* Request body for creating a position function.
|
|
4262
5022
|
*/
|
|
4263
5023
|
export type PositionFunctionParameters = {
|
|
4264
5024
|
/**
|
|
@@ -4270,6 +5030,19 @@ export type PositionFunctionParameters = {
|
|
|
4270
5030
|
*/
|
|
4271
5031
|
description: string;
|
|
4272
5032
|
};
|
|
5033
|
+
/**
|
|
5034
|
+
* Request body for updating a position function. Send only the fields to change.
|
|
5035
|
+
*/
|
|
5036
|
+
export type PositionFunctionUpdateParameters = {
|
|
5037
|
+
/**
|
|
5038
|
+
* The function name (e.g. "Electrician", "Foreman"). Omit to leave it unchanged.
|
|
5039
|
+
*/
|
|
5040
|
+
value?: string;
|
|
5041
|
+
/**
|
|
5042
|
+
* What the function covers. Omit to leave it unchanged.
|
|
5043
|
+
*/
|
|
5044
|
+
description?: string;
|
|
5045
|
+
};
|
|
4273
5046
|
export type CompanyResponseObject = {
|
|
4274
5047
|
id: string;
|
|
4275
5048
|
name: string;
|
|
@@ -4397,7 +5170,7 @@ export type CustomFieldConfigsResponseObject = {
|
|
|
4397
5170
|
updated_at: string;
|
|
4398
5171
|
};
|
|
4399
5172
|
/**
|
|
4400
|
-
* Request body for creating
|
|
5173
|
+
* Request body for creating a custom field definition. `name` and `model_type` are required.
|
|
4401
5174
|
*/
|
|
4402
5175
|
export type CustomFieldConfigParameters = {
|
|
4403
5176
|
/**
|
|
@@ -4417,6 +5190,27 @@ export type CustomFieldConfigParameters = {
|
|
|
4417
5190
|
*/
|
|
4418
5191
|
visible?: boolean;
|
|
4419
5192
|
};
|
|
5193
|
+
/**
|
|
5194
|
+
* Request body for updating a custom field definition. Every field is optional; omit a field to preserve its current value. The resulting definition's name must remain unique for its company and model type.
|
|
5195
|
+
*/
|
|
5196
|
+
export type CustomFieldConfigUpdateParameters = {
|
|
5197
|
+
/**
|
|
5198
|
+
* Name of the custom field; omit to preserve the current value. The resulting name must remain present and unique per company and model type.
|
|
5199
|
+
*/
|
|
5200
|
+
name?: string;
|
|
5201
|
+
/**
|
|
5202
|
+
* Optional description of the custom field.
|
|
5203
|
+
*/
|
|
5204
|
+
description?: string | null;
|
|
5205
|
+
/**
|
|
5206
|
+
* The kind of record the field attaches to: one of apprenticeship_apprentice, company, job, or user_company. Omit to preserve the current value.
|
|
5207
|
+
*/
|
|
5208
|
+
model_type?: 'apprenticeship_apprentice' | 'company' | 'job' | 'user_company';
|
|
5209
|
+
/**
|
|
5210
|
+
* Whether the field is shown.
|
|
5211
|
+
*/
|
|
5212
|
+
visible?: boolean;
|
|
5213
|
+
};
|
|
4420
5214
|
/**
|
|
4421
5215
|
* A user's membership in a group.
|
|
4422
5216
|
*/
|
|
@@ -5536,7 +6330,7 @@ export type PayrollFringeBenefitPlanResponseObject = {
|
|
|
5536
6330
|
updated_at: string;
|
|
5537
6331
|
};
|
|
5538
6332
|
/**
|
|
5539
|
-
* Request body for creating
|
|
6333
|
+
* Request body for creating a fringe-benefit plan. timekeeping_pay_period_config_id, name, plan_number, and benefit_category are required.
|
|
5540
6334
|
*/
|
|
5541
6335
|
export type PayrollFringeBenefitPlanParameters = {
|
|
5542
6336
|
/**
|
|
@@ -5596,6 +6390,67 @@ export type PayrollFringeBenefitPlanParameters = {
|
|
|
5596
6390
|
*/
|
|
5597
6391
|
il_admin_name?: string | null;
|
|
5598
6392
|
};
|
|
6393
|
+
/**
|
|
6394
|
+
* Request body for updating a fringe-benefit plan. Send only the fields to change.
|
|
6395
|
+
*/
|
|
6396
|
+
export type PayrollFringeBenefitPlanUpdateParameters = {
|
|
6397
|
+
/**
|
|
6398
|
+
* ID of the pay schedule that owns the plan, stable across all of its versions. Omit to leave it unchanged.
|
|
6399
|
+
*/
|
|
6400
|
+
timekeeping_pay_period_config_id?: string;
|
|
6401
|
+
/**
|
|
6402
|
+
* Human-readable name of the plan. Omit to leave it unchanged.
|
|
6403
|
+
*/
|
|
6404
|
+
name?: string;
|
|
6405
|
+
/**
|
|
6406
|
+
* Three-digit plan number, reported together with the company EIN. Omit to leave it unchanged.
|
|
6407
|
+
*/
|
|
6408
|
+
plan_number?: string;
|
|
6409
|
+
/**
|
|
6410
|
+
* Whether contributions are paid into a bona-fide benefit plan. Omit to leave it unchanged.
|
|
6411
|
+
*/
|
|
6412
|
+
funded?: boolean;
|
|
6413
|
+
/**
|
|
6414
|
+
* Which employer contribution the plan covers. Omit to leave it unchanged.
|
|
6415
|
+
*/
|
|
6416
|
+
benefit_category?: 'employer_combined_health' | 'employer_combined_savings' | 'employer_combined_holiday_pto' | 'employer_training' | 'employer_other_contributions';
|
|
6417
|
+
/**
|
|
6418
|
+
* Whether this is a jointly-managed (Taft-Hartley) fund. Omit to leave it unchanged.
|
|
6419
|
+
*/
|
|
6420
|
+
il_jointly_managed?: boolean;
|
|
6421
|
+
/**
|
|
6422
|
+
* 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.
|
|
6423
|
+
*/
|
|
6424
|
+
il_fund_name?: string | null;
|
|
6425
|
+
/**
|
|
6426
|
+
* 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.
|
|
6427
|
+
*/
|
|
6428
|
+
il_fund_address1?: string | null;
|
|
6429
|
+
/**
|
|
6430
|
+
* Illinois fund street address line 2; omit to leave it unchanged, or send null to clear it.
|
|
6431
|
+
*/
|
|
6432
|
+
il_fund_address2?: string | null;
|
|
6433
|
+
/**
|
|
6434
|
+
* 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.
|
|
6435
|
+
*/
|
|
6436
|
+
il_fund_city?: string | null;
|
|
6437
|
+
/**
|
|
6438
|
+
* 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.
|
|
6439
|
+
*/
|
|
6440
|
+
il_fund_state?: string | null;
|
|
6441
|
+
/**
|
|
6442
|
+
* 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.
|
|
6443
|
+
*/
|
|
6444
|
+
il_fund_zip?: string | null;
|
|
6445
|
+
/**
|
|
6446
|
+
* Illinois fund sponsor name; omit to leave it unchanged, or send null to clear it.
|
|
6447
|
+
*/
|
|
6448
|
+
il_sponsor_name?: string | null;
|
|
6449
|
+
/**
|
|
6450
|
+
* 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.
|
|
6451
|
+
*/
|
|
6452
|
+
il_admin_name?: string | null;
|
|
6453
|
+
};
|
|
5599
6454
|
/**
|
|
5600
6455
|
* 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
6456
|
*/
|
|
@@ -5757,11 +6612,11 @@ export type PayrollRunResponseObject = {
|
|
|
5757
6612
|
updated_at: string;
|
|
5758
6613
|
};
|
|
5759
6614
|
/**
|
|
5760
|
-
*
|
|
6615
|
+
* 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
6616
|
*/
|
|
5762
6617
|
export type PayrollRunParameters = {
|
|
5763
6618
|
/**
|
|
5764
|
-
* ID of the company the run belongs to. Required.
|
|
6619
|
+
* 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
6620
|
*/
|
|
5766
6621
|
company_id: string;
|
|
5767
6622
|
/**
|
|
@@ -5785,6 +6640,31 @@ export type PayrollRunParameters = {
|
|
|
5785
6640
|
*/
|
|
5786
6641
|
external_id?: string | null;
|
|
5787
6642
|
};
|
|
6643
|
+
/**
|
|
6644
|
+
* 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.
|
|
6645
|
+
*/
|
|
6646
|
+
export type PayrollRunUpdateParameters = {
|
|
6647
|
+
/**
|
|
6648
|
+
* ID of the pay period the run is for; required for an on-cycle run, omitted for an off-cycle run.
|
|
6649
|
+
*/
|
|
6650
|
+
timekeeping_pay_period_id?: string | null;
|
|
6651
|
+
/**
|
|
6652
|
+
* ID of the payroll-system credential that sourced the run.
|
|
6653
|
+
*/
|
|
6654
|
+
payrolls_credential_id?: string | null;
|
|
6655
|
+
/**
|
|
6656
|
+
* Kind of payroll run (uppercase): one of CORRECTION, ON_CYCLE, OFF_CYCLE, RECONCILIATION, SIGN_ON_BONUS, or TERMINATION.
|
|
6657
|
+
*/
|
|
6658
|
+
run_type?: 'CORRECTION' | 'ON_CYCLE' | 'OFF_CYCLE' | 'RECONCILIATION' | 'SIGN_ON_BONUS' | 'TERMINATION';
|
|
6659
|
+
/**
|
|
6660
|
+
* 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.
|
|
6661
|
+
*/
|
|
6662
|
+
run_date?: string;
|
|
6663
|
+
/**
|
|
6664
|
+
* ID of the run in the external payroll system.
|
|
6665
|
+
*/
|
|
6666
|
+
external_id?: string | null;
|
|
6667
|
+
};
|
|
5788
6668
|
/**
|
|
5789
6669
|
* 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
6670
|
*/
|
|
@@ -5891,7 +6771,7 @@ export type ProjectResponseObject = {
|
|
|
5891
6771
|
updated_at: string;
|
|
5892
6772
|
};
|
|
5893
6773
|
/**
|
|
5894
|
-
* Request body for creating
|
|
6774
|
+
* Request body for creating a project. `name` is required by the schema; `created_by_user_id` is additionally required on create and must be a member of the owning company. The owning company is inferred from the API key and is not part of the body.
|
|
5895
6775
|
*/
|
|
5896
6776
|
export type ProjectParameters = {
|
|
5897
6777
|
/**
|
|
@@ -5906,6 +6786,87 @@ export type ProjectParameters = {
|
|
|
5906
6786
|
* Free-form project description, or null.
|
|
5907
6787
|
*/
|
|
5908
6788
|
description?: string | null;
|
|
6789
|
+
/**
|
|
6790
|
+
* User recorded as the project's creator; must be a member of the owning company. Required on create and immutable thereafter — an update that sets, changes, or clears it is rejected.
|
|
6791
|
+
*/
|
|
6792
|
+
created_by_user_id: string;
|
|
6793
|
+
/**
|
|
6794
|
+
* Schedule start date as an ISO8601 date (YYYY-MM-DD), or null; requires tz_name to be set.
|
|
6795
|
+
*/
|
|
6796
|
+
start_date?: string | null;
|
|
6797
|
+
/**
|
|
6798
|
+
* Schedule end date as an ISO8601 date (YYYY-MM-DD), or null; must be on or after start_date.
|
|
6799
|
+
*/
|
|
6800
|
+
end_date?: string | null;
|
|
6801
|
+
/**
|
|
6802
|
+
* IANA time zone name. Required when start_date is set.
|
|
6803
|
+
*/
|
|
6804
|
+
tz_name?: string | null;
|
|
6805
|
+
/**
|
|
6806
|
+
* Day of week billing starts: 0 (Sunday) through 6 (Saturday).
|
|
6807
|
+
*/
|
|
6808
|
+
billing_start_day?: number | null;
|
|
6809
|
+
/**
|
|
6810
|
+
* Federal PWA tracking mode: `all` (prevailing wage + apprenticeship), `pw_only`, `ap_only`, or `none`. Any other value returns 422.
|
|
6811
|
+
*/
|
|
6812
|
+
federal_pwa_mode?: 'all' | 'pw_only' | 'ap_only' | 'none';
|
|
6813
|
+
/**
|
|
6814
|
+
* Any value other than `none` requires `region`.
|
|
6815
|
+
*/
|
|
6816
|
+
regional_pwa_mode?: 'all' | 'pw_only' | 'ap_only' | 'none';
|
|
6817
|
+
/**
|
|
6818
|
+
* US state abbreviation; must be one of the owning company's operating regions.
|
|
6819
|
+
*/
|
|
6820
|
+
region?: string | null;
|
|
6821
|
+
/**
|
|
6822
|
+
* 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`.
|
|
6823
|
+
*/
|
|
6824
|
+
asset_owner?: boolean;
|
|
6825
|
+
/**
|
|
6826
|
+
* 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.
|
|
6827
|
+
*/
|
|
6828
|
+
administrator_name?: string | null;
|
|
6829
|
+
/**
|
|
6830
|
+
* 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.
|
|
6831
|
+
*/
|
|
6832
|
+
administrator_email?: string | null;
|
|
6833
|
+
/**
|
|
6834
|
+
* 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.
|
|
6835
|
+
*/
|
|
6836
|
+
administrator_phone?: string | null;
|
|
6837
|
+
/**
|
|
6838
|
+
* 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.
|
|
6839
|
+
*/
|
|
6840
|
+
budget?: string;
|
|
6841
|
+
/**
|
|
6842
|
+
* 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.
|
|
6843
|
+
*/
|
|
6844
|
+
prevailing_wage_lock_in_date?: string | null;
|
|
6845
|
+
/**
|
|
6846
|
+
* 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.
|
|
6847
|
+
*/
|
|
6848
|
+
beginning_of_construction_date?: string | null;
|
|
6849
|
+
/**
|
|
6850
|
+
* 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.
|
|
6851
|
+
*/
|
|
6852
|
+
placed_in_service_date?: string | null;
|
|
6853
|
+
};
|
|
6854
|
+
/**
|
|
6855
|
+
* Request body for updating a project. Every field is optional; omit a field to preserve its current value. The resulting project must still satisfy conditional PWA, regional, and schedule validation rules. `created_by_user_id` is create-only and an update that names it is rejected.
|
|
6856
|
+
*/
|
|
6857
|
+
export type ProjectUpdateParameters = {
|
|
6858
|
+
/**
|
|
6859
|
+
* Client-supplied external identifier, or null.
|
|
6860
|
+
*/
|
|
6861
|
+
external_id?: string | null;
|
|
6862
|
+
/**
|
|
6863
|
+
* Human-readable project name; omit to preserve the current value. The resulting project name must remain present and unique within the owning company.
|
|
6864
|
+
*/
|
|
6865
|
+
name?: string;
|
|
6866
|
+
/**
|
|
6867
|
+
* Free-form project description, or null.
|
|
6868
|
+
*/
|
|
6869
|
+
description?: string | null;
|
|
5909
6870
|
/**
|
|
5910
6871
|
* User recorded as the project's creator; must be a member of the owning company. Required on create and immutable thereafter — an update that sets, changes, or clears it is rejected.
|
|
5911
6872
|
*/
|
|
@@ -5939,35 +6900,35 @@ export type ProjectParameters = {
|
|
|
5939
6900
|
*/
|
|
5940
6901
|
region?: string | null;
|
|
5941
6902
|
/**
|
|
5942
|
-
* Gates IRA tax-credit checks.
|
|
6903
|
+
* 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
6904
|
*/
|
|
5944
6905
|
asset_owner?: boolean;
|
|
5945
6906
|
/**
|
|
5946
|
-
* Name of the project administrator
|
|
6907
|
+
* 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
6908
|
*/
|
|
5948
6909
|
administrator_name?: string | null;
|
|
5949
6910
|
/**
|
|
5950
|
-
* Email of the project administrator
|
|
6911
|
+
* 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
6912
|
*/
|
|
5952
6913
|
administrator_email?: string | null;
|
|
5953
6914
|
/**
|
|
5954
|
-
* Phone of the project administrator, normalized to E.164
|
|
6915
|
+
* 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
6916
|
*/
|
|
5956
6917
|
administrator_phone?: string | null;
|
|
5957
6918
|
/**
|
|
5958
|
-
* Decimal string (e.g. "5000.0").
|
|
6919
|
+
* 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
6920
|
*/
|
|
5960
6921
|
budget?: string;
|
|
5961
6922
|
/**
|
|
5962
|
-
* Prevailing-wage lock-in date as an ISO8601 date
|
|
6923
|
+
* 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
6924
|
*/
|
|
5964
6925
|
prevailing_wage_lock_in_date?: string | null;
|
|
5965
6926
|
/**
|
|
5966
|
-
* IRA beginning-of-construction date as an ISO8601 date
|
|
6927
|
+
* 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
6928
|
*/
|
|
5968
6929
|
beginning_of_construction_date?: string | null;
|
|
5969
6930
|
/**
|
|
5970
|
-
* IRA placed-in-service date as an ISO8601 date
|
|
6931
|
+
* 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
6932
|
*/
|
|
5972
6933
|
placed_in_service_date?: string | null;
|
|
5973
6934
|
};
|
|
@@ -5989,7 +6950,7 @@ export type SiteCheckInResponseObject = {
|
|
|
5989
6950
|
/**
|
|
5990
6951
|
* How the check-in was captured.
|
|
5991
6952
|
*/
|
|
5992
|
-
source: 'manual' | 'auto';
|
|
6953
|
+
source: 'manual' | 'auto' | 'public_form';
|
|
5993
6954
|
nerc_check_in: boolean;
|
|
5994
6955
|
cip_exceptional: boolean;
|
|
5995
6956
|
created_by_user_id: string | null;
|
|
@@ -6579,34 +7540,59 @@ export type PaystubResponseObject = {
|
|
|
6579
7540
|
/**
|
|
6580
7541
|
* When the record was created (ISO 8601).
|
|
6581
7542
|
*/
|
|
6582
|
-
created_at: string;
|
|
7543
|
+
created_at: string;
|
|
7544
|
+
/**
|
|
7545
|
+
* When the record was last updated (ISO 8601).
|
|
7546
|
+
*/
|
|
7547
|
+
updated_at: string;
|
|
7548
|
+
};
|
|
7549
|
+
/**
|
|
7550
|
+
* 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.
|
|
7551
|
+
*/
|
|
7552
|
+
export type PaystubParameters = {
|
|
7553
|
+
/**
|
|
7554
|
+
* ID of the payroll run this paystub belongs to. Required.
|
|
7555
|
+
*/
|
|
7556
|
+
payrolls_payroll_run_id: string;
|
|
7557
|
+
/**
|
|
7558
|
+
* ID of the worker who received the payment. Required.
|
|
7559
|
+
*/
|
|
7560
|
+
user_id: string;
|
|
7561
|
+
/**
|
|
7562
|
+
* ID of the time card this paystub is for; required for an on-cycle run, not allowed for an off-cycle run.
|
|
7563
|
+
*/
|
|
7564
|
+
timekeeping_time_card_id?: string | null;
|
|
7565
|
+
/**
|
|
7566
|
+
* ID of the paystub in the external payroll system; unique within its payroll run.
|
|
7567
|
+
*/
|
|
7568
|
+
external_id?: string | null;
|
|
6583
7569
|
/**
|
|
6584
|
-
*
|
|
7570
|
+
* Payment reference (check) number from the payroll provider.
|
|
6585
7571
|
*/
|
|
6586
|
-
|
|
7572
|
+
check_number?: string | null;
|
|
6587
7573
|
};
|
|
6588
7574
|
/**
|
|
6589
|
-
* Request body for
|
|
7575
|
+
* Request body for updating a paystub. Send only the fields to change; the resulting paystub must still match its payroll run type.
|
|
6590
7576
|
*/
|
|
6591
|
-
export type
|
|
7577
|
+
export type PaystubUpdateParameters = {
|
|
6592
7578
|
/**
|
|
6593
|
-
* ID of the payroll run this paystub belongs to.
|
|
7579
|
+
* ID of the payroll run this paystub belongs to. Omit to leave it unchanged.
|
|
6594
7580
|
*/
|
|
6595
|
-
payrolls_payroll_run_id
|
|
7581
|
+
payrolls_payroll_run_id?: string;
|
|
6596
7582
|
/**
|
|
6597
|
-
* ID of the worker who received the payment.
|
|
7583
|
+
* ID of the worker who received the payment. Omit to leave it unchanged.
|
|
6598
7584
|
*/
|
|
6599
|
-
user_id
|
|
7585
|
+
user_id?: string;
|
|
6600
7586
|
/**
|
|
6601
|
-
* ID of the time card this paystub is for;
|
|
7587
|
+
* 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.
|
|
6602
7588
|
*/
|
|
6603
7589
|
timekeeping_time_card_id?: string | null;
|
|
6604
7590
|
/**
|
|
6605
|
-
* ID of the paystub in the external payroll system; unique within its payroll run.
|
|
7591
|
+
* ID of the paystub in the external payroll system; unique within its payroll run. Omit to leave it unchanged.
|
|
6606
7592
|
*/
|
|
6607
7593
|
external_id?: string | null;
|
|
6608
7594
|
/**
|
|
6609
|
-
* Payment reference
|
|
7595
|
+
* Payment reference from the payroll provider; omit to leave it unchanged, or send null to clear it.
|
|
6610
7596
|
*/
|
|
6611
7597
|
check_number?: string | null;
|
|
6612
7598
|
};
|
|
@@ -7086,7 +8072,7 @@ export type PaystubLineItemResponseObject = {
|
|
|
7086
8072
|
updated_at: string;
|
|
7087
8073
|
};
|
|
7088
8074
|
/**
|
|
7089
|
-
* Request body for creating
|
|
8075
|
+
* Request body for creating a paystub line item. All four fields are required.
|
|
7090
8076
|
*/
|
|
7091
8077
|
export type PaystubLineItemParameters = {
|
|
7092
8078
|
/**
|
|
@@ -7106,6 +8092,27 @@ export type PaystubLineItemParameters = {
|
|
|
7106
8092
|
*/
|
|
7107
8093
|
payrolls_external_map_id: string;
|
|
7108
8094
|
};
|
|
8095
|
+
/**
|
|
8096
|
+
* Request body for updating a paystub line item. Send only the fields to change.
|
|
8097
|
+
*/
|
|
8098
|
+
export type PaystubLineItemUpdateParameters = {
|
|
8099
|
+
/**
|
|
8100
|
+
* ID of the paystub this line item belongs to. Omit to leave it unchanged.
|
|
8101
|
+
*/
|
|
8102
|
+
payrolls_paystub_id?: string;
|
|
8103
|
+
/**
|
|
8104
|
+
* Amount of this line, in cents as a decimal string (e.g. "5000.0" is $50.00). Omit to leave it unchanged.
|
|
8105
|
+
*/
|
|
8106
|
+
amount_cents?: string;
|
|
8107
|
+
/**
|
|
8108
|
+
* Who contributes this amount: employee or employer. Omit to leave it unchanged.
|
|
8109
|
+
*/
|
|
8110
|
+
contributor?: 'employee' | 'employer';
|
|
8111
|
+
/**
|
|
8112
|
+
* ID of the external map defining which compensation element this line item represents. Omit to leave it unchanged.
|
|
8113
|
+
*/
|
|
8114
|
+
payrolls_external_map_id?: string;
|
|
8115
|
+
};
|
|
7109
8116
|
/**
|
|
7110
8117
|
* 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
8118
|
*/
|
|
@@ -7279,7 +8286,7 @@ export type PositionParameters = {
|
|
|
7279
8286
|
};
|
|
7280
8287
|
};
|
|
7281
8288
|
/**
|
|
7282
|
-
* Parameters for creating
|
|
8289
|
+
* Parameters for creating a per-unit scope price on a job. `scope_kind` and `unit_price` are required.
|
|
7283
8290
|
*/
|
|
7284
8291
|
export type ProductionJobScopePriceParameters = {
|
|
7285
8292
|
/**
|
|
@@ -7299,6 +8306,27 @@ export type ProductionJobScopePriceParameters = {
|
|
|
7299
8306
|
*/
|
|
7300
8307
|
unit_of_measure?: string;
|
|
7301
8308
|
};
|
|
8309
|
+
/**
|
|
8310
|
+
* Parameters for updating a per-unit scope price on a job. Every field is optional; omit a field to preserve its current value. The resulting price must retain a scope kind and non-negative unit price.
|
|
8311
|
+
*/
|
|
8312
|
+
export type ProductionJobScopePriceUpdateParameters = {
|
|
8313
|
+
/**
|
|
8314
|
+
* The scope of work this price covers, as a free-text label (for example "annual", "semi_annual", or "modules"). A job has at most one price per scope kind.
|
|
8315
|
+
*/
|
|
8316
|
+
scope_kind?: string;
|
|
8317
|
+
/**
|
|
8318
|
+
* Billing rate per unit, as a decimal string in the company's currency.
|
|
8319
|
+
*/
|
|
8320
|
+
unit_price?: string;
|
|
8321
|
+
/**
|
|
8322
|
+
* Contracted number of units expected for this scope on the job; null when no target is set.
|
|
8323
|
+
*/
|
|
8324
|
+
contracted_count?: number | null;
|
|
8325
|
+
/**
|
|
8326
|
+
* What each priced unit represents, as a free-text label (for example "modules", "piles", or "turbines"); defaults to "units".
|
|
8327
|
+
*/
|
|
8328
|
+
unit_of_measure?: string;
|
|
8329
|
+
};
|
|
7302
8330
|
/**
|
|
7303
8331
|
* A per-unit billing price for one scope of work on a job. Production completions bill against these prices.
|
|
7304
8332
|
*/
|
|
@@ -7572,7 +8600,7 @@ export type FormAssignmentTaskResponseObject = Array<{
|
|
|
7572
8600
|
}>;
|
|
7573
8601
|
}>;
|
|
7574
8602
|
/**
|
|
7575
|
-
* Request body for creating
|
|
8603
|
+
* 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
8604
|
*/
|
|
7577
8605
|
export type CertificationParameters = {
|
|
7578
8606
|
/**
|
|
@@ -7596,6 +8624,31 @@ export type CertificationParameters = {
|
|
|
7596
8624
|
*/
|
|
7597
8625
|
duration?: string | null;
|
|
7598
8626
|
};
|
|
8627
|
+
/**
|
|
8628
|
+
* 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.
|
|
8629
|
+
*/
|
|
8630
|
+
export type CertificationUpdateParameters = {
|
|
8631
|
+
/**
|
|
8632
|
+
* 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.
|
|
8633
|
+
*/
|
|
8634
|
+
company_id?: string;
|
|
8635
|
+
/**
|
|
8636
|
+
* Name of the certification (for example "OSHA 30" or a GWO training module). Unique within the company.
|
|
8637
|
+
*/
|
|
8638
|
+
name?: string;
|
|
8639
|
+
/**
|
|
8640
|
+
* Optional free-text description of the certification; omit to leave it unchanged, or send null to clear it.
|
|
8641
|
+
*/
|
|
8642
|
+
description?: string | null;
|
|
8643
|
+
/**
|
|
8644
|
+
* 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.
|
|
8645
|
+
*/
|
|
8646
|
+
verified?: boolean;
|
|
8647
|
+
/**
|
|
8648
|
+
* 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.
|
|
8649
|
+
*/
|
|
8650
|
+
duration?: string | null;
|
|
8651
|
+
};
|
|
7599
8652
|
/**
|
|
7600
8653
|
* A page of certifications — your company's own plus all global (platform) certifications.
|
|
7601
8654
|
*/
|
|
@@ -7649,7 +8702,7 @@ export type CertificationPackageResponseObject = {
|
|
|
7649
8702
|
updated_at: string;
|
|
7650
8703
|
};
|
|
7651
8704
|
/**
|
|
7652
|
-
* Request body for creating
|
|
8705
|
+
* Request body for creating a certification package — a named set of certifications a company requires together.
|
|
7653
8706
|
*/
|
|
7654
8707
|
export type CertificationPackageParameters = {
|
|
7655
8708
|
/**
|
|
@@ -7669,6 +8722,27 @@ export type CertificationPackageParameters = {
|
|
|
7669
8722
|
*/
|
|
7670
8723
|
performed_by_user_id: string;
|
|
7671
8724
|
};
|
|
8725
|
+
/**
|
|
8726
|
+
* Request body for updating a certification package — a named set of certifications a company requires together. Include only the fields to change.
|
|
8727
|
+
*/
|
|
8728
|
+
export type CertificationPackageUpdateParameters = {
|
|
8729
|
+
/**
|
|
8730
|
+
* Name of the package. Unique within the company; omit to leave it unchanged.
|
|
8731
|
+
*/
|
|
8732
|
+
name?: string;
|
|
8733
|
+
/**
|
|
8734
|
+
* Optional free-text description of the package; omit to leave it unchanged.
|
|
8735
|
+
*/
|
|
8736
|
+
description?: string | null;
|
|
8737
|
+
/**
|
|
8738
|
+
* Ids of the certifications in the package; global and your company's own may be mixed. Providing this replaces the entire membership.
|
|
8739
|
+
*/
|
|
8740
|
+
certification_ids?: Array<string>;
|
|
8741
|
+
/**
|
|
8742
|
+
* Id of the company member recorded as updating the package. Required, and must belong to the company that owns the API key.
|
|
8743
|
+
*/
|
|
8744
|
+
performed_by_user_id: string;
|
|
8745
|
+
};
|
|
7672
8746
|
/**
|
|
7673
8747
|
* A certification — a named qualification a worker can hold, either owned by your company or a global (platform) credential type (company_id null).
|
|
7674
8748
|
*/
|
|
@@ -7707,7 +8781,7 @@ export type CertificationResponseObject = {
|
|
|
7707
8781
|
updated_at: string;
|
|
7708
8782
|
};
|
|
7709
8783
|
/**
|
|
7710
|
-
* Request body for recording
|
|
8784
|
+
* Request body for recording a certification held by a worker — who holds it, which certification, when it was received, and optional proof, expiry, and verification details.
|
|
7711
8785
|
*/
|
|
7712
8786
|
export type UserCertificationParameters = {
|
|
7713
8787
|
/**
|
|
@@ -7760,6 +8834,60 @@ export type UserCertificationParameters = {
|
|
|
7760
8834
|
*/
|
|
7761
8835
|
approved_at?: string | null;
|
|
7762
8836
|
};
|
|
8837
|
+
/**
|
|
8838
|
+
* Request body for updating a certification held by a worker. Every field is optional; omit a field to preserve its current value. The resulting certification must still have a receipt date and verification state, and any expiry date must remain after its receipt date.
|
|
8839
|
+
*/
|
|
8840
|
+
export type UserCertificationUpdateParameters = {
|
|
8841
|
+
/**
|
|
8842
|
+
* Id of the worker who holds the certification. Omit to preserve the current worker.
|
|
8843
|
+
*/
|
|
8844
|
+
user_id?: string;
|
|
8845
|
+
/**
|
|
8846
|
+
* Id of the certification held. Omit to preserve the current certification; a worker can hold each certification at most once.
|
|
8847
|
+
*/
|
|
8848
|
+
certification_id?: string;
|
|
8849
|
+
/**
|
|
8850
|
+
* When the worker earned the certification (ISO 8601). Omit to preserve the current receipt date.
|
|
8851
|
+
*/
|
|
8852
|
+
received_at?: string;
|
|
8853
|
+
/**
|
|
8854
|
+
* Optional proof document to attach (for example a certificate scan). Write-only — it is not returned in responses.
|
|
8855
|
+
*/
|
|
8856
|
+
file?: {
|
|
8857
|
+
/**
|
|
8858
|
+
* File name of the proof document, including its extension (for example "gwo-cert.pdf").
|
|
8859
|
+
*/
|
|
8860
|
+
name: string;
|
|
8861
|
+
/**
|
|
8862
|
+
* Base64-encoded contents of the proof document.
|
|
8863
|
+
*/
|
|
8864
|
+
content: string;
|
|
8865
|
+
} | null;
|
|
8866
|
+
/**
|
|
8867
|
+
* Whether DSPTCH has verified this held certification. Distinct from the verified flag on the certification definition itself.
|
|
8868
|
+
*/
|
|
8869
|
+
verified?: boolean;
|
|
8870
|
+
/**
|
|
8871
|
+
* When the held certification expires (YYYY-MM-DD). Must be after received_at; null when it does not expire.
|
|
8872
|
+
*/
|
|
8873
|
+
expiration_date?: string | null;
|
|
8874
|
+
/**
|
|
8875
|
+
* The credential or document number for the held certification, as issued by the issuer (for example a WINDA number or a license number). Free text; null when none.
|
|
8876
|
+
*/
|
|
8877
|
+
credential_id?: string | null;
|
|
8878
|
+
/**
|
|
8879
|
+
* Id of the user recorded as approving this held certification; null when unset.
|
|
8880
|
+
*/
|
|
8881
|
+
approved_by_user_id?: string | null;
|
|
8882
|
+
/**
|
|
8883
|
+
* When the held certification was archived (ISO 8601); null while active. Archiving is a soft flag, separate from deleting the record.
|
|
8884
|
+
*/
|
|
8885
|
+
archived_at?: string | null;
|
|
8886
|
+
/**
|
|
8887
|
+
* When this held certification was approved (ISO 8601); null when unset.
|
|
8888
|
+
*/
|
|
8889
|
+
approved_at?: string | null;
|
|
8890
|
+
};
|
|
7763
8891
|
/**
|
|
7764
8892
|
* A page of certifications held by your company's workers.
|
|
7765
8893
|
*/
|
|
@@ -9280,7 +10408,7 @@ export type AssetsItemResponseObject = {
|
|
|
9280
10408
|
updated_at: string;
|
|
9281
10409
|
};
|
|
9282
10410
|
/**
|
|
9283
|
-
* Create
|
|
10411
|
+
* Create an asset item. The write API creates serial items only; assets_product_id and serial_number identify the product and serial number. On create you may also place the item — assets_site_id to stock it at a site, or user_id to assign it to a user (the two are mutually exclusive). performed_by_user_id is required.
|
|
9284
10412
|
*/
|
|
9285
10413
|
export type AssetsItemParameters = {
|
|
9286
10414
|
/**
|
|
@@ -9344,6 +10472,71 @@ export type AssetsItemParameters = {
|
|
|
9344
10472
|
*/
|
|
9345
10473
|
performed_by_user_id: string;
|
|
9346
10474
|
};
|
|
10475
|
+
/**
|
|
10476
|
+
* Update an asset item. All item fields are optional — send only what changes — but performed_by_user_id is required to record the updater and any placement. Omitted attributes retain their existing values.
|
|
10477
|
+
*/
|
|
10478
|
+
export type AssetsItemUpdateParameters = {
|
|
10479
|
+
/**
|
|
10480
|
+
* Human-readable name for the item.
|
|
10481
|
+
*/
|
|
10482
|
+
name?: string;
|
|
10483
|
+
/**
|
|
10484
|
+
* Free-text description of the item.
|
|
10485
|
+
*/
|
|
10486
|
+
description?: string;
|
|
10487
|
+
/**
|
|
10488
|
+
* ID of the product this item is an instance of.
|
|
10489
|
+
*/
|
|
10490
|
+
assets_product_id?: string;
|
|
10491
|
+
/**
|
|
10492
|
+
* Serial number identifying the individual physical unit; unique within its product.
|
|
10493
|
+
*/
|
|
10494
|
+
serial_number?: string;
|
|
10495
|
+
/**
|
|
10496
|
+
* Placement status of the item: available, or assigned when held by a user.
|
|
10497
|
+
*/
|
|
10498
|
+
status?: 'available' | 'assigned';
|
|
10499
|
+
/**
|
|
10500
|
+
* When the item was purchased (ISO 8601).
|
|
10501
|
+
*/
|
|
10502
|
+
purchase_date?: string;
|
|
10503
|
+
/**
|
|
10504
|
+
* Purchase price in cents, in the item's currency.
|
|
10505
|
+
*/
|
|
10506
|
+
purchase_price_cents?: number;
|
|
10507
|
+
/**
|
|
10508
|
+
* Identifier for this item in an external system.
|
|
10509
|
+
*/
|
|
10510
|
+
external_id?: string;
|
|
10511
|
+
/**
|
|
10512
|
+
* URL to this item in an external system.
|
|
10513
|
+
*/
|
|
10514
|
+
external_system_url?: string;
|
|
10515
|
+
/**
|
|
10516
|
+
* Image attachments. Send file with a signed_id to add one; include id with _destroy to remove an existing one.
|
|
10517
|
+
*/
|
|
10518
|
+
images_attributes?: Array<AssetsAttachmentParameters>;
|
|
10519
|
+
/**
|
|
10520
|
+
* Optional. Move the item to this site; mutually exclusive with user_id and container_item_id.
|
|
10521
|
+
*/
|
|
10522
|
+
assets_site_id?: string;
|
|
10523
|
+
/**
|
|
10524
|
+
* Optional. Assign the item to this user; mutually exclusive with assets_site_id and container_item_id.
|
|
10525
|
+
*/
|
|
10526
|
+
user_id?: string;
|
|
10527
|
+
/**
|
|
10528
|
+
* Optional. Place the item inside this container item; mutually exclusive with assets_site_id and user_id.
|
|
10529
|
+
*/
|
|
10530
|
+
container_item_id?: string;
|
|
10531
|
+
/**
|
|
10532
|
+
* Optional. The storage location within the placement site or container; omit for an unbinned placement. Ignored for a user assignment.
|
|
10533
|
+
*/
|
|
10534
|
+
assets_sub_location_id?: string;
|
|
10535
|
+
/**
|
|
10536
|
+
* ID of the user this update is performed on behalf of, recorded as updater and attributed to any placement. Required; must belong to your company.
|
|
10537
|
+
*/
|
|
10538
|
+
performed_by_user_id: string;
|
|
10539
|
+
};
|
|
9347
10540
|
/**
|
|
9348
10541
|
* A vendor in the company's asset catalog — a supplier or manufacturer that products are sourced from.
|
|
9349
10542
|
*/
|
|
@@ -9386,6 +10579,19 @@ export type AssetsVendorParameters = {
|
|
|
9386
10579
|
*/
|
|
9387
10580
|
logo_signed_id?: string;
|
|
9388
10581
|
};
|
|
10582
|
+
/**
|
|
10583
|
+
* Update a vendor. All fields are optional — send only what changes.
|
|
10584
|
+
*/
|
|
10585
|
+
export type AssetsVendorUpdateParameters = {
|
|
10586
|
+
/**
|
|
10587
|
+
* The vendor's name; unique within the company (case-insensitive).
|
|
10588
|
+
*/
|
|
10589
|
+
name?: string;
|
|
10590
|
+
/**
|
|
10591
|
+
* 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.
|
|
10592
|
+
*/
|
|
10593
|
+
logo_signed_id?: string;
|
|
10594
|
+
};
|
|
9389
10595
|
/**
|
|
9390
10596
|
* A location that holds a company's assets and inventory — a warehouse or yard, optionally backed by a site on the Atlas map.
|
|
9391
10597
|
*/
|
|
@@ -9447,9 +10653,21 @@ export type AssetsSiteParameters = ({
|
|
|
9447
10653
|
*/
|
|
9448
10654
|
name?: string | null;
|
|
9449
10655
|
};
|
|
10656
|
+
/**
|
|
10657
|
+
* 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`.
|
|
10658
|
+
*/
|
|
9450
10659
|
export type AssetsSiteUpdateParameters = {
|
|
10660
|
+
/**
|
|
10661
|
+
* Location type: warehouse or yard.
|
|
10662
|
+
*/
|
|
9451
10663
|
kind?: 'warehouse' | 'yard';
|
|
10664
|
+
/**
|
|
10665
|
+
* ID of the Atlas map site to back this location. `null` removes the backing site when a name remains available.
|
|
10666
|
+
*/
|
|
9452
10667
|
site_id?: string | null;
|
|
10668
|
+
/**
|
|
10669
|
+
* Display name for the location. `null` clears the direct name when a backing `site_id` supplies the display name.
|
|
10670
|
+
*/
|
|
9453
10671
|
name?: string | null;
|
|
9454
10672
|
};
|
|
9455
10673
|
/**
|
|
@@ -9515,40 +10733,93 @@ export type AssetsFormAssignmentTriggerResponseObject = {
|
|
|
9515
10733
|
/**
|
|
9516
10734
|
* When the record was created (ISO 8601).
|
|
9517
10735
|
*/
|
|
9518
|
-
created_at: string;
|
|
10736
|
+
created_at: string;
|
|
10737
|
+
/**
|
|
10738
|
+
* When the record was last updated (ISO 8601).
|
|
10739
|
+
*/
|
|
10740
|
+
updated_at: string;
|
|
10741
|
+
};
|
|
10742
|
+
/**
|
|
10743
|
+
* Create or update a form-assignment trigger rule. form_definition_id, triggered_by, assign_to, first_due_by, tz_name, and time_of_day_due are required; the day fields depend on first_due_by, and assigned_user_ids applies only to the custom assign_to mode.
|
|
10744
|
+
*/
|
|
10745
|
+
export type AssetsFormAssignmentTriggerParameters = {
|
|
10746
|
+
/**
|
|
10747
|
+
* ID of the form definition (a SurveyJS form template) this assignment is for.
|
|
10748
|
+
*/
|
|
10749
|
+
form_definition_id: string;
|
|
10750
|
+
/**
|
|
10751
|
+
* The custody event that fires the rule: assignment (an item is assigned to a user) or unassignment (an item is removed from a user).
|
|
10752
|
+
*/
|
|
10753
|
+
triggered_by: 'assignment' | 'unassignment';
|
|
10754
|
+
/**
|
|
10755
|
+
* Who the generated form is assigned to: custom (the users in assigned_user_ids), asset_assignee (the user who now holds the item), or previous_asset_assignee (the user who held it before the event).
|
|
10756
|
+
*/
|
|
10757
|
+
assign_to: 'custom' | 'asset_assignee' | 'previous_asset_assignee';
|
|
10758
|
+
/**
|
|
10759
|
+
* How the first due date is set: day_of_event (the day the rule fires), day_of_week (the next day_of_week_due), or day_of_month (day_of_month_due of the current or next month).
|
|
10760
|
+
*/
|
|
10761
|
+
first_due_by: 'day_of_event' | 'day_of_week' | 'day_of_month';
|
|
10762
|
+
/**
|
|
10763
|
+
* IANA time zone (e.g. "America/New_York") in which time_of_day_due is interpreted.
|
|
10764
|
+
*/
|
|
10765
|
+
tz_name: string;
|
|
10766
|
+
/**
|
|
10767
|
+
* Wall-clock time of day the form is due (HH:MM), interpreted in tz_name.
|
|
10768
|
+
*/
|
|
10769
|
+
time_of_day_due: string;
|
|
10770
|
+
/**
|
|
10771
|
+
* Optional label for this trigger rule; null when unset.
|
|
10772
|
+
*/
|
|
10773
|
+
name?: string | null;
|
|
10774
|
+
/**
|
|
10775
|
+
* How often the generated form recurs: one of DAILY, WORKDAILY, WORKDAILYSIX, WEEKLY, BIWEEKLY, MONTHLY, or QUARTERLY. Null for a one-time assignment.
|
|
10776
|
+
*/
|
|
10777
|
+
recurrence_frequency?: 'DAILY' | 'WORKDAILY' | 'WORKDAILYSIX' | 'WEEKLY' | 'BIWEEKLY' | 'MONTHLY' | 'QUARTERLY' | null;
|
|
10778
|
+
/**
|
|
10779
|
+
* Day of week the form is first due, 0 (Sunday) to 6 (Saturday). Required when first_due_by is day_of_week; null otherwise.
|
|
10780
|
+
*/
|
|
10781
|
+
day_of_week_due?: number | null;
|
|
10782
|
+
/**
|
|
10783
|
+
* Day of month the form is first due, 1 to 31 (clamped to the month's last day). Required when first_due_by is day_of_month; null otherwise.
|
|
10784
|
+
*/
|
|
10785
|
+
day_of_month_due?: number | null;
|
|
10786
|
+
/**
|
|
10787
|
+
* IDs of the users the generated form is assigned to. Used only when assign_to is custom; cleared for the other modes.
|
|
10788
|
+
*/
|
|
10789
|
+
assigned_user_ids?: Array<string>;
|
|
9519
10790
|
/**
|
|
9520
|
-
*
|
|
10791
|
+
* IDs of the products this rule applies to; the rule fires for items of these products.
|
|
9521
10792
|
*/
|
|
9522
|
-
|
|
10793
|
+
assets_product_ids?: Array<string>;
|
|
9523
10794
|
};
|
|
9524
10795
|
/**
|
|
9525
|
-
*
|
|
10796
|
+
* Update a form-assignment trigger rule. All fields are optional — send only what changes. When changing first_due_by, include the matching day field when required; assigned_user_ids applies only to the custom assign_to mode.
|
|
9526
10797
|
*/
|
|
9527
|
-
export type
|
|
10798
|
+
export type AssetsFormAssignmentTriggerUpdateParameters = {
|
|
9528
10799
|
/**
|
|
9529
10800
|
* ID of the form definition (a SurveyJS form template) this assignment is for.
|
|
9530
10801
|
*/
|
|
9531
|
-
form_definition_id
|
|
10802
|
+
form_definition_id?: string;
|
|
9532
10803
|
/**
|
|
9533
10804
|
* The custody event that fires the rule: assignment (an item is assigned to a user) or unassignment (an item is removed from a user).
|
|
9534
10805
|
*/
|
|
9535
|
-
triggered_by
|
|
10806
|
+
triggered_by?: 'assignment' | 'unassignment';
|
|
9536
10807
|
/**
|
|
9537
10808
|
* Who the generated form is assigned to: custom (the users in assigned_user_ids), asset_assignee (the user who now holds the item), or previous_asset_assignee (the user who held it before the event).
|
|
9538
10809
|
*/
|
|
9539
|
-
assign_to
|
|
10810
|
+
assign_to?: 'custom' | 'asset_assignee' | 'previous_asset_assignee';
|
|
9540
10811
|
/**
|
|
9541
10812
|
* How the first due date is set: day_of_event (the day the rule fires), day_of_week (the next day_of_week_due), or day_of_month (day_of_month_due of the current or next month).
|
|
9542
10813
|
*/
|
|
9543
|
-
first_due_by
|
|
10814
|
+
first_due_by?: 'day_of_event' | 'day_of_week' | 'day_of_month';
|
|
9544
10815
|
/**
|
|
9545
10816
|
* IANA time zone (e.g. "America/New_York") in which time_of_day_due is interpreted.
|
|
9546
10817
|
*/
|
|
9547
|
-
tz_name
|
|
10818
|
+
tz_name?: string;
|
|
9548
10819
|
/**
|
|
9549
10820
|
* Wall-clock time of day the form is due (HH:MM), interpreted in tz_name.
|
|
9550
10821
|
*/
|
|
9551
|
-
time_of_day_due
|
|
10822
|
+
time_of_day_due?: string;
|
|
9552
10823
|
/**
|
|
9553
10824
|
* Optional label for this trigger rule; null when unset.
|
|
9554
10825
|
*/
|
|
@@ -9708,6 +10979,23 @@ export type AssetsDocumentParameters = {
|
|
|
9708
10979
|
*/
|
|
9709
10980
|
description?: string | null;
|
|
9710
10981
|
};
|
|
10982
|
+
/**
|
|
10983
|
+
* Update an asset-item document. All fields are optional — send only what changes. Omit file to retain the existing attachment, or supply a new signed_id to replace it.
|
|
10984
|
+
*/
|
|
10985
|
+
export type AssetsDocumentUpdateParameters = {
|
|
10986
|
+
/**
|
|
10987
|
+
* A signed_id from POST /api/v1/direct_uploads identifying a replacement blob. Register the upload naming `assets.items.documents` — a signed_id issued for any other resource will not resolve here.
|
|
10988
|
+
*/
|
|
10989
|
+
file?: string;
|
|
10990
|
+
/**
|
|
10991
|
+
* The file's human-readable download name; null when not set.
|
|
10992
|
+
*/
|
|
10993
|
+
filename?: string | null;
|
|
10994
|
+
/**
|
|
10995
|
+
* Free-text description of the document; null when none.
|
|
10996
|
+
*/
|
|
10997
|
+
description?: string | null;
|
|
10998
|
+
};
|
|
9711
10999
|
/**
|
|
9712
11000
|
* One entry in an item document's change history, recorded whenever the document is created, updated, or deleted — including when only its attached file is replaced.
|
|
9713
11001
|
*/
|
|
@@ -9854,6 +11142,69 @@ export type AssetsItemFormAssignmentParameters = {
|
|
|
9854
11142
|
}>;
|
|
9855
11143
|
};
|
|
9856
11144
|
};
|
|
11145
|
+
/**
|
|
11146
|
+
* Update an item form assignment. All fields are optional — send only what changes. recurring gates the recurrence fields, and task_attributes.reminders_attributes replaces the existing reminder set when supplied.
|
|
11147
|
+
*/
|
|
11148
|
+
export type AssetsItemFormAssignmentUpdateParameters = {
|
|
11149
|
+
/**
|
|
11150
|
+
* ID of the form definition (a SurveyJS form template) this assignment is for.
|
|
11151
|
+
*/
|
|
11152
|
+
form_definition_id?: string;
|
|
11153
|
+
/**
|
|
11154
|
+
* When true, frequency and recurrence_end_time apply; when false or omitted, the task is one-time and those fields are cleared.
|
|
11155
|
+
*/
|
|
11156
|
+
recurring?: boolean;
|
|
11157
|
+
/**
|
|
11158
|
+
* The underlying task's name, schedule, assignees, and reminders.
|
|
11159
|
+
*/
|
|
11160
|
+
task_attributes?: {
|
|
11161
|
+
/**
|
|
11162
|
+
* Name of the form task; defaults to the form definition's name.
|
|
11163
|
+
*/
|
|
11164
|
+
name?: string | null;
|
|
11165
|
+
/**
|
|
11166
|
+
* Free-text description of the task.
|
|
11167
|
+
*/
|
|
11168
|
+
description?: string | null;
|
|
11169
|
+
/**
|
|
11170
|
+
* ID of the user who created the task. Existing assignments retain their creator when this is omitted.
|
|
11171
|
+
*/
|
|
11172
|
+
created_by_user_id?: string;
|
|
11173
|
+
/**
|
|
11174
|
+
* ID of the user updating the task. The API derives the stored updater from the task creator.
|
|
11175
|
+
*/
|
|
11176
|
+
updated_by_user_id?: string | null;
|
|
11177
|
+
/**
|
|
11178
|
+
* When the form task is due (ISO 8601), interpreted in tz_name; null for an unscheduled task.
|
|
11179
|
+
*/
|
|
11180
|
+
time_due?: string | null;
|
|
11181
|
+
/**
|
|
11182
|
+
* IANA time zone in which time_due is interpreted; null for an unscheduled task.
|
|
11183
|
+
*/
|
|
11184
|
+
tz_name?: string | null;
|
|
11185
|
+
/**
|
|
11186
|
+
* How often this form task recurs: one of DAILY, WORKDAILY, WORKDAILYSIX, WEEKLY, BIWEEKLY, MONTHLY, or QUARTERLY. Null for a one-time assignment; on write, applied only when recurring is true.
|
|
11187
|
+
*/
|
|
11188
|
+
frequency?: 'DAILY' | 'WORKDAILY' | 'WORKDAILYSIX' | 'WEEKLY' | 'BIWEEKLY' | 'MONTHLY' | 'QUARTERLY' | null;
|
|
11189
|
+
/**
|
|
11190
|
+
* When recurrence stops (ISO 8601); null for a non-recurring or open-ended task.
|
|
11191
|
+
*/
|
|
11192
|
+
recurrence_end_time?: string | null;
|
|
11193
|
+
/**
|
|
11194
|
+
* IDs of the users this form task is assigned to.
|
|
11195
|
+
*/
|
|
11196
|
+
task_assignee_user_ids?: Array<string>;
|
|
11197
|
+
/**
|
|
11198
|
+
* Reminders to attach, each an offset from the due time. On update, replaces the existing set.
|
|
11199
|
+
*/
|
|
11200
|
+
reminders_attributes?: Array<{
|
|
11201
|
+
/**
|
|
11202
|
+
* ISO 8601 duration offset from the due time for the reminder (e.g. -PT1H for one hour before); must be one of the preset reminder times.
|
|
11203
|
+
*/
|
|
11204
|
+
offset: 'PT0S' | 'PT-1M' | 'PT-5M' | 'PT-10M' | 'PT-15M' | 'PT-30M' | 'PT-1H' | 'PT-2H' | 'P-1D' | 'P-2D' | 'P-3D' | 'P-4D' | 'P-5D' | 'P-6D' | 'P-1W' | 'P-2W' | 'P-1M' | 'P-2M' | 'P-3M' | 'P-6M' | 'P-1Y' | 'PT5M' | 'PT15M' | 'PT30M' | 'PT1H' | 'PT6H' | 'PT12H' | 'P1D' | 'P2D' | 'P3D' | 'P4D' | 'P5D' | 'P6D' | 'P1W' | 'P2W' | 'P3W';
|
|
11205
|
+
}>;
|
|
11206
|
+
};
|
|
11207
|
+
};
|
|
9857
11208
|
/**
|
|
9858
11209
|
* On-hand stock of an item at a site — one row per item, site, and storage location. Read-only. A site with none of the item has no row at all, since a row is removed once its count reaches zero.
|
|
9859
11210
|
*/
|
|
@@ -10150,6 +11501,35 @@ export type AssetsServiceScheduleParameters = {
|
|
|
10150
11501
|
*/
|
|
10151
11502
|
performed_by_user_id: string;
|
|
10152
11503
|
};
|
|
11504
|
+
/**
|
|
11505
|
+
* Update a service schedule. Cadence and last_serviced_on fields are optional — send only what changes — but performed_by_user_id is required to record the updater. next_due_date is recomputed.
|
|
11506
|
+
*/
|
|
11507
|
+
export type AssetsServiceScheduleUpdateParameters = {
|
|
11508
|
+
/**
|
|
11509
|
+
* The service cadence: one of calibration or maintenance.
|
|
11510
|
+
*/
|
|
11511
|
+
kind?: 'calibration' | 'maintenance';
|
|
11512
|
+
/**
|
|
11513
|
+
* Optional label distinguishing this schedule from others of the same kind on the item; null when unset.
|
|
11514
|
+
*/
|
|
11515
|
+
name?: string | null;
|
|
11516
|
+
/**
|
|
11517
|
+
* Unit of the service interval: one of year, month, week, or day.
|
|
11518
|
+
*/
|
|
11519
|
+
interval_unit?: 'year' | 'month' | 'week' | 'day';
|
|
11520
|
+
/**
|
|
11521
|
+
* Number of interval_units between services; greater than 0.
|
|
11522
|
+
*/
|
|
11523
|
+
interval_count?: number;
|
|
11524
|
+
/**
|
|
11525
|
+
* Manually-set anchor date of the most recent service; next_due_date derives from it until an actual service event supersedes it. Null when unset.
|
|
11526
|
+
*/
|
|
11527
|
+
last_serviced_on?: string | null;
|
|
11528
|
+
/**
|
|
11529
|
+
* ID of the user this update is performed on behalf of, recorded as the schedule's updater. Required; must belong to your company.
|
|
11530
|
+
*/
|
|
11531
|
+
performed_by_user_id: string;
|
|
11532
|
+
};
|
|
10153
11533
|
/**
|
|
10154
11534
|
* A service performed on a serial item — scheduled (satisfying a service schedule) or ad-hoc. Recording one advances the linked schedule's next_due_date.
|
|
10155
11535
|
*/
|
|
@@ -10228,6 +11608,35 @@ export type AssetsServiceEventParameters = {
|
|
|
10228
11608
|
*/
|
|
10229
11609
|
attachments_attributes?: Array<AssetsAttachmentParameters>;
|
|
10230
11610
|
};
|
|
11611
|
+
/**
|
|
11612
|
+
* Update a service event. Event fields are optional — send only what changes — but performed_by_user_id is required to record the updater. A linked schedule dictates kind, and changing or removing the link recomputes affected due dates.
|
|
11613
|
+
*/
|
|
11614
|
+
export type AssetsServiceEventUpdateParameters = {
|
|
11615
|
+
/**
|
|
11616
|
+
* The kind of service performed: one of calibration, maintenance, or repair. Ignored when assets_service_schedule_id is set — the schedule dictates the kind.
|
|
11617
|
+
*/
|
|
11618
|
+
kind?: 'calibration' | 'maintenance' | 'repair';
|
|
11619
|
+
/**
|
|
11620
|
+
* Free-text notes on the service; null when none.
|
|
11621
|
+
*/
|
|
11622
|
+
notes?: string | null;
|
|
11623
|
+
/**
|
|
11624
|
+
* Date the service was performed; stored as company-local midnight and returned as performed_at. Omit to retain the existing date.
|
|
11625
|
+
*/
|
|
11626
|
+
performed_on?: string;
|
|
11627
|
+
/**
|
|
11628
|
+
* ID of the service schedule this event satisfies; must belong to the item. Omit to retain the existing link, or send null to remove it.
|
|
11629
|
+
*/
|
|
11630
|
+
assets_service_schedule_id?: string | null;
|
|
11631
|
+
/**
|
|
11632
|
+
* ID of the user this update is performed on behalf of. Required; must belong to your company.
|
|
11633
|
+
*/
|
|
11634
|
+
performed_by_user_id: string;
|
|
11635
|
+
/**
|
|
11636
|
+
* Document attachments for the service. Set _destroy with an id to remove an existing one; omit id to add a new one.
|
|
11637
|
+
*/
|
|
11638
|
+
attachments_attributes?: Array<AssetsAttachmentParameters>;
|
|
11639
|
+
};
|
|
10231
11640
|
/**
|
|
10232
11641
|
* A product-level service cadence that seeds and syncs the matching schedules on that product's items. Changing its defining fields (name, kind, interval) reconciles linked item schedules in the background.
|
|
10233
11642
|
*/
|
|
@@ -10294,6 +11703,31 @@ export type AssetsServiceScheduleTemplateParameters = {
|
|
|
10294
11703
|
*/
|
|
10295
11704
|
performed_by_user_id: string;
|
|
10296
11705
|
};
|
|
11706
|
+
/**
|
|
11707
|
+
* Update a service schedule template. Cadence fields are optional — send only what changes — but performed_by_user_id is required to record the updater. Changing defining fields reconciles linked item schedules in the background.
|
|
11708
|
+
*/
|
|
11709
|
+
export type AssetsServiceScheduleTemplateUpdateParameters = {
|
|
11710
|
+
/**
|
|
11711
|
+
* The service cadence: one of calibration or maintenance.
|
|
11712
|
+
*/
|
|
11713
|
+
kind?: 'calibration' | 'maintenance';
|
|
11714
|
+
/**
|
|
11715
|
+
* Optional label distinguishing this template from others of the same kind on the product; null when unset.
|
|
11716
|
+
*/
|
|
11717
|
+
name?: string | null;
|
|
11718
|
+
/**
|
|
11719
|
+
* Unit of the service interval: one of year, month, week, or day.
|
|
11720
|
+
*/
|
|
11721
|
+
interval_unit?: 'year' | 'month' | 'week' | 'day';
|
|
11722
|
+
/**
|
|
11723
|
+
* Number of interval_units between services; greater than 0.
|
|
11724
|
+
*/
|
|
11725
|
+
interval_count?: number;
|
|
11726
|
+
/**
|
|
11727
|
+
* ID of the user this update is performed on behalf of, recorded as the template's updater. Required; must belong to your company.
|
|
11728
|
+
*/
|
|
11729
|
+
performed_by_user_id: string;
|
|
11730
|
+
};
|
|
10297
11731
|
/**
|
|
10298
11732
|
* A node of fixed storage structure inside a site or a container item — a zone, aisle, rack, shelf, bin, or drawer. Nodes form a tree per holder, and each carries a scannable path_code composed from its ancestors' codes.
|
|
10299
11733
|
*/
|
|
@@ -10569,40 +12003,159 @@ export type AssetsAdjustmentParameters = {
|
|
|
10569
12003
|
/**
|
|
10570
12004
|
* Optional. The site's storage location whose count is being set; must belong to the site. Omit to set the site's unbinned count.
|
|
10571
12005
|
*/
|
|
10572
|
-
assets_sub_location_id?: string;
|
|
12006
|
+
assets_sub_location_id?: string;
|
|
12007
|
+
/**
|
|
12008
|
+
* The corrected on-hand count for the site; 0 or greater. The difference from the current count is recorded as the adjustment.
|
|
12009
|
+
*/
|
|
12010
|
+
new_quantity: number;
|
|
12011
|
+
/**
|
|
12012
|
+
* ID of the user this adjustment is performed on behalf of, recorded on the transaction. Required; must belong to your company.
|
|
12013
|
+
*/
|
|
12014
|
+
performed_by_user_id: string;
|
|
12015
|
+
};
|
|
12016
|
+
/**
|
|
12017
|
+
* 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.
|
|
12018
|
+
*/
|
|
12019
|
+
export type AssetsArchiveParameters = {
|
|
12020
|
+
/**
|
|
12021
|
+
* ID of the user this archive or unarchive is performed on behalf of, recorded for auditing. Required; must belong to your company.
|
|
12022
|
+
*/
|
|
12023
|
+
performed_by_user_id: string;
|
|
12024
|
+
};
|
|
12025
|
+
export type ListApiKeyScopesData = {
|
|
12026
|
+
body?: never;
|
|
12027
|
+
path?: never;
|
|
12028
|
+
query?: never;
|
|
12029
|
+
url: '/api/v1/api_key/scopes';
|
|
12030
|
+
};
|
|
12031
|
+
export type ListApiKeyScopesResponses = {
|
|
12032
|
+
/**
|
|
12033
|
+
* Success
|
|
12034
|
+
*/
|
|
12035
|
+
200: {
|
|
12036
|
+
data: Array<ApiKeyScopeResponseObject>;
|
|
12037
|
+
};
|
|
12038
|
+
};
|
|
12039
|
+
export type ListApiKeyScopesResponse = ListApiKeyScopesResponses[keyof ListApiKeyScopesResponses];
|
|
12040
|
+
export type ListAllocationsData = {
|
|
12041
|
+
body?: never;
|
|
12042
|
+
path: {
|
|
12043
|
+
apprentice_id: string;
|
|
12044
|
+
};
|
|
12045
|
+
query?: {
|
|
12046
|
+
'filter[allocated_at][gte]'?: string;
|
|
12047
|
+
'filter[allocated_at][lte]'?: string;
|
|
12048
|
+
'filter[created_at][gte]'?: string;
|
|
12049
|
+
'filter[created_at][lte]'?: string;
|
|
12050
|
+
'filter[updated_at][gte]'?: string;
|
|
12051
|
+
'filter[updated_at][lte]'?: string;
|
|
12052
|
+
filter?: string;
|
|
12053
|
+
'filter[unexpected]'?: string;
|
|
12054
|
+
/**
|
|
12055
|
+
* This pagination cursor corresponds to the cursor value found in the response in
|
|
12056
|
+
* `meta.page.next_cursor`.
|
|
12057
|
+
*/
|
|
12058
|
+
'page[cursor]'?: string;
|
|
12059
|
+
/**
|
|
12060
|
+
* 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`.
|
|
12061
|
+
*/
|
|
12062
|
+
'page[limit]'?: number;
|
|
12063
|
+
page?: string;
|
|
12064
|
+
};
|
|
12065
|
+
url: '/api/v1/apprenticeship/apprentices/{apprentice_id}/allocations';
|
|
12066
|
+
};
|
|
12067
|
+
export type ListAllocationsErrors = {
|
|
12068
|
+
/**
|
|
12069
|
+
* Bad Request
|
|
12070
|
+
*/
|
|
12071
|
+
400: Problem;
|
|
12072
|
+
/**
|
|
12073
|
+
* Forbidden
|
|
12074
|
+
*/
|
|
12075
|
+
403: Problem;
|
|
12076
|
+
/**
|
|
12077
|
+
* Not Found
|
|
12078
|
+
*/
|
|
12079
|
+
404: Problem;
|
|
12080
|
+
/**
|
|
12081
|
+
* Unprocessable Content
|
|
12082
|
+
*/
|
|
12083
|
+
422: Problem;
|
|
12084
|
+
};
|
|
12085
|
+
export type ListAllocationsError = ListAllocationsErrors[keyof ListAllocationsErrors];
|
|
12086
|
+
export type ListAllocationsResponses = {
|
|
12087
|
+
/**
|
|
12088
|
+
* Success
|
|
12089
|
+
*/
|
|
12090
|
+
200: {
|
|
12091
|
+
meta: Meta;
|
|
12092
|
+
links: Links;
|
|
12093
|
+
data: Array<ApprenticeshipAllocationResponseObject>;
|
|
12094
|
+
};
|
|
12095
|
+
};
|
|
12096
|
+
export type ListAllocationsResponse = ListAllocationsResponses[keyof ListAllocationsResponses];
|
|
12097
|
+
export type GetAllocationData = {
|
|
12098
|
+
body?: never;
|
|
12099
|
+
path: {
|
|
12100
|
+
apprentice_id: string;
|
|
12101
|
+
id: string;
|
|
12102
|
+
};
|
|
12103
|
+
query?: never;
|
|
12104
|
+
url: '/api/v1/apprenticeship/apprentices/{apprentice_id}/allocations/{id}';
|
|
12105
|
+
};
|
|
12106
|
+
export type GetAllocationErrors = {
|
|
12107
|
+
/**
|
|
12108
|
+
* Forbidden
|
|
12109
|
+
*/
|
|
12110
|
+
403: Problem;
|
|
12111
|
+
/**
|
|
12112
|
+
* Not Found
|
|
12113
|
+
*/
|
|
12114
|
+
404: Problem;
|
|
12115
|
+
};
|
|
12116
|
+
export type GetAllocationError = GetAllocationErrors[keyof GetAllocationErrors];
|
|
12117
|
+
export type GetAllocationResponses = {
|
|
12118
|
+
/**
|
|
12119
|
+
* Success
|
|
12120
|
+
*/
|
|
12121
|
+
200: ApprenticeshipAllocationResponseObject;
|
|
12122
|
+
};
|
|
12123
|
+
export type GetAllocationResponse = GetAllocationResponses[keyof GetAllocationResponses];
|
|
12124
|
+
export type UpdateAllocationData = {
|
|
12125
|
+
body: ApprenticeshipAllocationUpdateParameters;
|
|
12126
|
+
path: {
|
|
12127
|
+
apprentice_id: string;
|
|
12128
|
+
id: string;
|
|
12129
|
+
};
|
|
12130
|
+
query?: never;
|
|
12131
|
+
url: '/api/v1/apprenticeship/apprentices/{apprentice_id}/allocations/{id}';
|
|
12132
|
+
};
|
|
12133
|
+
export type UpdateAllocationErrors = {
|
|
12134
|
+
/**
|
|
12135
|
+
* Bad Request
|
|
12136
|
+
*/
|
|
12137
|
+
400: Problem;
|
|
10573
12138
|
/**
|
|
10574
|
-
*
|
|
12139
|
+
* Forbidden
|
|
10575
12140
|
*/
|
|
10576
|
-
|
|
12141
|
+
403: Problem;
|
|
10577
12142
|
/**
|
|
10578
|
-
*
|
|
12143
|
+
* Not Found
|
|
10579
12144
|
*/
|
|
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 = {
|
|
12145
|
+
404: Problem;
|
|
10586
12146
|
/**
|
|
10587
|
-
*
|
|
12147
|
+
* Unprocessable Content
|
|
10588
12148
|
*/
|
|
10589
|
-
|
|
10590
|
-
};
|
|
10591
|
-
export type ListApiKeyScopesData = {
|
|
10592
|
-
body?: never;
|
|
10593
|
-
path?: never;
|
|
10594
|
-
query?: never;
|
|
10595
|
-
url: '/api/v1/api_key/scopes';
|
|
12149
|
+
422: Problem;
|
|
10596
12150
|
};
|
|
10597
|
-
export type
|
|
12151
|
+
export type UpdateAllocationError = UpdateAllocationErrors[keyof UpdateAllocationErrors];
|
|
12152
|
+
export type UpdateAllocationResponses = {
|
|
10598
12153
|
/**
|
|
10599
12154
|
* Success
|
|
10600
12155
|
*/
|
|
10601
|
-
200:
|
|
10602
|
-
data: Array<ApiKeyScopeResponseObject>;
|
|
10603
|
-
};
|
|
12156
|
+
200: ApprenticeshipAllocationResponseObject;
|
|
10604
12157
|
};
|
|
10605
|
-
export type
|
|
12158
|
+
export type UpdateAllocationResponse = UpdateAllocationResponses[keyof UpdateAllocationResponses];
|
|
10606
12159
|
export type ListApprenticesData = {
|
|
10607
12160
|
body?: never;
|
|
10608
12161
|
path: {
|
|
@@ -10787,7 +12340,7 @@ export type CreateOccupationResponses = {
|
|
|
10787
12340
|
};
|
|
10788
12341
|
export type CreateOccupationResponse = CreateOccupationResponses[keyof CreateOccupationResponses];
|
|
10789
12342
|
export type UpdateOccupationData = {
|
|
10790
|
-
body?:
|
|
12343
|
+
body?: ApprenticeshipOccupationUpdateParameters;
|
|
10791
12344
|
path: {
|
|
10792
12345
|
program_id: string;
|
|
10793
12346
|
id: string;
|
|
@@ -10922,7 +12475,7 @@ export type DeleteEmployerResponses = {
|
|
|
10922
12475
|
};
|
|
10923
12476
|
export type DeleteEmployerResponse = DeleteEmployerResponses[keyof DeleteEmployerResponses];
|
|
10924
12477
|
export type UpdateEmployerData = {
|
|
10925
|
-
body?:
|
|
12478
|
+
body?: ApprenticeshipProgramEmployerUpdateParameters;
|
|
10926
12479
|
path: {
|
|
10927
12480
|
program_id: string;
|
|
10928
12481
|
id: string;
|
|
@@ -11022,7 +12575,7 @@ export type CreateProgramResponses = {
|
|
|
11022
12575
|
};
|
|
11023
12576
|
export type CreateProgramResponse = CreateProgramResponses[keyof CreateProgramResponses];
|
|
11024
12577
|
export type UpdateProgramData = {
|
|
11025
|
-
body?:
|
|
12578
|
+
body?: ApprenticeshipProgramUpdateParameters;
|
|
11026
12579
|
path: {
|
|
11027
12580
|
id: string;
|
|
11028
12581
|
};
|
|
@@ -11129,7 +12682,7 @@ export type CreatePeriodResponses = {
|
|
|
11129
12682
|
};
|
|
11130
12683
|
export type CreatePeriodResponse = CreatePeriodResponses[keyof CreatePeriodResponses];
|
|
11131
12684
|
export type UpdatePeriodData = {
|
|
11132
|
-
body?:
|
|
12685
|
+
body?: ApprenticeshipWageSchedulePeriodUpdateParameters;
|
|
11133
12686
|
path: {
|
|
11134
12687
|
wage_schedule_id: string;
|
|
11135
12688
|
id: string;
|
|
@@ -11237,7 +12790,7 @@ export type CreateWageScheduleResponses = {
|
|
|
11237
12790
|
};
|
|
11238
12791
|
export type CreateWageScheduleResponse = CreateWageScheduleResponses[keyof CreateWageScheduleResponses];
|
|
11239
12792
|
export type UpdateWageScheduleData = {
|
|
11240
|
-
body?:
|
|
12793
|
+
body?: ApprenticeshipWageScheduleUpdateParameters;
|
|
11241
12794
|
path: {
|
|
11242
12795
|
occupation_id: string;
|
|
11243
12796
|
id: string;
|
|
@@ -11403,7 +12956,7 @@ export type GetAttributeResponses = {
|
|
|
11403
12956
|
};
|
|
11404
12957
|
export type GetAttributeResponse = GetAttributeResponses[keyof GetAttributeResponses];
|
|
11405
12958
|
export type UpdateAttributeData = {
|
|
11406
|
-
body?:
|
|
12959
|
+
body?: AssetsAttributeUpdateParameters;
|
|
11407
12960
|
path: {
|
|
11408
12961
|
id: string;
|
|
11409
12962
|
};
|
|
@@ -11562,7 +13115,7 @@ export type GetCategoryResponses = {
|
|
|
11562
13115
|
};
|
|
11563
13116
|
export type GetCategoryResponse = GetCategoryResponses[keyof GetCategoryResponses];
|
|
11564
13117
|
export type UpdateCategoryData = {
|
|
11565
|
-
body?:
|
|
13118
|
+
body?: AssetsCategoryUpdateParameters;
|
|
11566
13119
|
path: {
|
|
11567
13120
|
id: string;
|
|
11568
13121
|
};
|
|
@@ -11826,7 +13379,7 @@ export type GetFormAssignmentTriggerResponses = {
|
|
|
11826
13379
|
};
|
|
11827
13380
|
export type GetFormAssignmentTriggerResponse = GetFormAssignmentTriggerResponses[keyof GetFormAssignmentTriggerResponses];
|
|
11828
13381
|
export type UpdateFormAssignmentTriggerData = {
|
|
11829
|
-
body:
|
|
13382
|
+
body: AssetsFormAssignmentTriggerUpdateParameters;
|
|
11830
13383
|
path: {
|
|
11831
13384
|
id: string;
|
|
11832
13385
|
};
|
|
@@ -12046,7 +13599,7 @@ export type GetItemResponses = {
|
|
|
12046
13599
|
};
|
|
12047
13600
|
export type GetItemResponse = GetItemResponses[keyof GetItemResponses];
|
|
12048
13601
|
export type UpdateItemData = {
|
|
12049
|
-
body:
|
|
13602
|
+
body: AssetsItemUpdateParameters;
|
|
12050
13603
|
path: {
|
|
12051
13604
|
id: string;
|
|
12052
13605
|
};
|
|
@@ -12054,10 +13607,18 @@ export type UpdateItemData = {
|
|
|
12054
13607
|
url: '/api/v1/assets/items/{id}';
|
|
12055
13608
|
};
|
|
12056
13609
|
export type UpdateItemErrors = {
|
|
13610
|
+
/**
|
|
13611
|
+
* Bad Request (missing performed_by_user_id)
|
|
13612
|
+
*/
|
|
13613
|
+
400: Problem;
|
|
12057
13614
|
/**
|
|
12058
13615
|
* Forbidden
|
|
12059
13616
|
*/
|
|
12060
13617
|
403: Problem;
|
|
13618
|
+
/**
|
|
13619
|
+
* Unprocessable Content
|
|
13620
|
+
*/
|
|
13621
|
+
422: Problem;
|
|
12061
13622
|
};
|
|
12062
13623
|
export type UpdateItemError = UpdateItemErrors[keyof UpdateItemErrors];
|
|
12063
13624
|
export type UpdateItemResponses = {
|
|
@@ -12252,7 +13813,7 @@ export type GetServiceScheduleResponses = {
|
|
|
12252
13813
|
};
|
|
12253
13814
|
export type GetServiceScheduleResponse = GetServiceScheduleResponses[keyof GetServiceScheduleResponses];
|
|
12254
13815
|
export type UpdateServiceScheduleData = {
|
|
12255
|
-
body:
|
|
13816
|
+
body: AssetsServiceScheduleUpdateParameters;
|
|
12256
13817
|
path: {
|
|
12257
13818
|
item_id: string;
|
|
12258
13819
|
id: string;
|
|
@@ -12261,6 +13822,10 @@ export type UpdateServiceScheduleData = {
|
|
|
12261
13822
|
url: '/api/v1/assets/items/{item_id}/service_schedules/{id}';
|
|
12262
13823
|
};
|
|
12263
13824
|
export type UpdateServiceScheduleErrors = {
|
|
13825
|
+
/**
|
|
13826
|
+
* Bad Request (missing performed_by_user_id)
|
|
13827
|
+
*/
|
|
13828
|
+
400: Problem;
|
|
12264
13829
|
/**
|
|
12265
13830
|
* Forbidden
|
|
12266
13831
|
*/
|
|
@@ -12410,7 +13975,7 @@ export type GetServiceEventResponses = {
|
|
|
12410
13975
|
};
|
|
12411
13976
|
export type GetServiceEventResponse = GetServiceEventResponses[keyof GetServiceEventResponses];
|
|
12412
13977
|
export type UpdateServiceEventData = {
|
|
12413
|
-
body:
|
|
13978
|
+
body: AssetsServiceEventUpdateParameters;
|
|
12414
13979
|
path: {
|
|
12415
13980
|
item_id: string;
|
|
12416
13981
|
id: string;
|
|
@@ -12419,6 +13984,10 @@ export type UpdateServiceEventData = {
|
|
|
12419
13984
|
url: '/api/v1/assets/items/{item_id}/service_events/{id}';
|
|
12420
13985
|
};
|
|
12421
13986
|
export type UpdateServiceEventErrors = {
|
|
13987
|
+
/**
|
|
13988
|
+
* Bad Request (missing performed_by_user_id)
|
|
13989
|
+
*/
|
|
13990
|
+
400: Problem;
|
|
12422
13991
|
/**
|
|
12423
13992
|
* Forbidden
|
|
12424
13993
|
*/
|
|
@@ -12531,7 +14100,7 @@ export type GetFormAssignmentTaskResponses = {
|
|
|
12531
14100
|
};
|
|
12532
14101
|
export type GetFormAssignmentTaskResponse = GetFormAssignmentTaskResponses[keyof GetFormAssignmentTaskResponses];
|
|
12533
14102
|
export type UpdateFormAssignmentTaskData = {
|
|
12534
|
-
body:
|
|
14103
|
+
body: AssetsItemFormAssignmentUpdateParameters;
|
|
12535
14104
|
path: {
|
|
12536
14105
|
item_id: string;
|
|
12537
14106
|
id: string;
|
|
@@ -12677,7 +14246,7 @@ export type GetDocumentResponses = {
|
|
|
12677
14246
|
};
|
|
12678
14247
|
export type GetDocumentResponse = GetDocumentResponses[keyof GetDocumentResponses];
|
|
12679
14248
|
export type UpdateDocumentData = {
|
|
12680
|
-
body:
|
|
14249
|
+
body: AssetsDocumentUpdateParameters;
|
|
12681
14250
|
path: {
|
|
12682
14251
|
item_id: string;
|
|
12683
14252
|
id: string;
|
|
@@ -13118,7 +14687,7 @@ export type GetServiceScheduleTemplateResponses = {
|
|
|
13118
14687
|
};
|
|
13119
14688
|
export type GetServiceScheduleTemplateResponse = GetServiceScheduleTemplateResponses[keyof GetServiceScheduleTemplateResponses];
|
|
13120
14689
|
export type UpdateServiceScheduleTemplateData = {
|
|
13121
|
-
body:
|
|
14690
|
+
body: AssetsServiceScheduleTemplateUpdateParameters;
|
|
13122
14691
|
path: {
|
|
13123
14692
|
product_id: string;
|
|
13124
14693
|
id: string;
|
|
@@ -13127,6 +14696,10 @@ export type UpdateServiceScheduleTemplateData = {
|
|
|
13127
14696
|
url: '/api/v1/assets/products/{product_id}/service_schedule_templates/{id}';
|
|
13128
14697
|
};
|
|
13129
14698
|
export type UpdateServiceScheduleTemplateErrors = {
|
|
14699
|
+
/**
|
|
14700
|
+
* Bad Request (missing performed_by_user_id)
|
|
14701
|
+
*/
|
|
14702
|
+
400: Problem;
|
|
13130
14703
|
/**
|
|
13131
14704
|
* Forbidden
|
|
13132
14705
|
*/
|
|
@@ -13741,7 +15314,7 @@ export type GetVendorResponses = {
|
|
|
13741
15314
|
};
|
|
13742
15315
|
export type GetVendorResponse = GetVendorResponses[keyof GetVendorResponses];
|
|
13743
15316
|
export type UpdateVendorData = {
|
|
13744
|
-
body:
|
|
15317
|
+
body: AssetsVendorUpdateParameters;
|
|
13745
15318
|
path: {
|
|
13746
15319
|
id: string;
|
|
13747
15320
|
};
|
|
@@ -14094,7 +15667,7 @@ export type GetPackageResponses = {
|
|
|
14094
15667
|
};
|
|
14095
15668
|
export type GetPackageResponse = GetPackageResponses[keyof GetPackageResponses];
|
|
14096
15669
|
export type UpdatePackageData = {
|
|
14097
|
-
body?:
|
|
15670
|
+
body?: CertificationPackageUpdateParameters;
|
|
14098
15671
|
path: {
|
|
14099
15672
|
id: string;
|
|
14100
15673
|
};
|
|
@@ -14249,7 +15822,7 @@ export type GetUserCertificationResponses = {
|
|
|
14249
15822
|
};
|
|
14250
15823
|
export type GetUserCertificationResponse = GetUserCertificationResponses[keyof GetUserCertificationResponses];
|
|
14251
15824
|
export type UpdateUserCertificationData = {
|
|
14252
|
-
body?:
|
|
15825
|
+
body?: UserCertificationUpdateParameters;
|
|
14253
15826
|
path: {
|
|
14254
15827
|
id: string;
|
|
14255
15828
|
};
|
|
@@ -14390,7 +15963,7 @@ export type GetCertificationResponses = {
|
|
|
14390
15963
|
};
|
|
14391
15964
|
export type GetCertificationResponse = GetCertificationResponses[keyof GetCertificationResponses];
|
|
14392
15965
|
export type UpdateCertificationData = {
|
|
14393
|
-
body?:
|
|
15966
|
+
body?: CertificationUpdateParameters;
|
|
14394
15967
|
path: {
|
|
14395
15968
|
id: string;
|
|
14396
15969
|
};
|
|
@@ -14489,7 +16062,7 @@ export type CreateDepartmentResponses = {
|
|
|
14489
16062
|
};
|
|
14490
16063
|
export type CreateDepartmentResponse = CreateDepartmentResponses[keyof CreateDepartmentResponses];
|
|
14491
16064
|
export type UpdateDepartmentData = {
|
|
14492
|
-
body:
|
|
16065
|
+
body: DepartmentUpdateParameters;
|
|
14493
16066
|
path: {
|
|
14494
16067
|
id: string;
|
|
14495
16068
|
};
|
|
@@ -14945,7 +16518,7 @@ export type GetCustomFieldConfigResponses = {
|
|
|
14945
16518
|
};
|
|
14946
16519
|
export type GetCustomFieldConfigResponse = GetCustomFieldConfigResponses[keyof GetCustomFieldConfigResponses];
|
|
14947
16520
|
export type UpdateCustomFieldConfigData = {
|
|
14948
|
-
body?:
|
|
16521
|
+
body?: CustomFieldConfigUpdateParameters;
|
|
14949
16522
|
path: {
|
|
14950
16523
|
id: string;
|
|
14951
16524
|
};
|
|
@@ -15381,7 +16954,7 @@ export type GetGroupResponses = {
|
|
|
15381
16954
|
};
|
|
15382
16955
|
export type GetGroupResponse = GetGroupResponses[keyof GetGroupResponses];
|
|
15383
16956
|
export type UpdateGroupData = {
|
|
15384
|
-
body?:
|
|
16957
|
+
body?: GroupUpdateParameters;
|
|
15385
16958
|
path: {
|
|
15386
16959
|
id: string;
|
|
15387
16960
|
};
|
|
@@ -15555,7 +17128,7 @@ export type GetJobScopePriceResponses = {
|
|
|
15555
17128
|
};
|
|
15556
17129
|
export type GetJobScopePriceResponse = GetJobScopePriceResponses[keyof GetJobScopePriceResponses];
|
|
15557
17130
|
export type UpdateJobScopePriceData = {
|
|
15558
|
-
body?:
|
|
17131
|
+
body?: ProductionJobScopePriceUpdateParameters;
|
|
15559
17132
|
path: {
|
|
15560
17133
|
job_id: string;
|
|
15561
17134
|
id: string;
|
|
@@ -16348,7 +17921,7 @@ export type CreateJobData = {
|
|
|
16348
17921
|
/**
|
|
16349
17922
|
* Create a job
|
|
16350
17923
|
*/
|
|
16351
|
-
body:
|
|
17924
|
+
body: JobCreateParameters;
|
|
16352
17925
|
path?: never;
|
|
16353
17926
|
query?: never;
|
|
16354
17927
|
url: '/api/v1/jobs';
|
|
@@ -17839,7 +19412,7 @@ export type GetFringeBenefitPlanResponses = {
|
|
|
17839
19412
|
};
|
|
17840
19413
|
export type GetFringeBenefitPlanResponse = GetFringeBenefitPlanResponses[keyof GetFringeBenefitPlanResponses];
|
|
17841
19414
|
export type UpdateFringeBenefitPlanData = {
|
|
17842
|
-
body?:
|
|
19415
|
+
body?: PayrollFringeBenefitPlanUpdateParameters;
|
|
17843
19416
|
path: {
|
|
17844
19417
|
id: string;
|
|
17845
19418
|
};
|
|
@@ -17855,6 +19428,10 @@ export type UpdateFringeBenefitPlanErrors = {
|
|
|
17855
19428
|
* Not Found
|
|
17856
19429
|
*/
|
|
17857
19430
|
404: Problem;
|
|
19431
|
+
/**
|
|
19432
|
+
* Unprocessable Content
|
|
19433
|
+
*/
|
|
19434
|
+
422: Problem;
|
|
17858
19435
|
};
|
|
17859
19436
|
export type UpdateFringeBenefitPlanError = UpdateFringeBenefitPlanErrors[keyof UpdateFringeBenefitPlanErrors];
|
|
17860
19437
|
export type UpdateFringeBenefitPlanResponses = {
|
|
@@ -18058,6 +19635,10 @@ export type CreatePayrollRunData = {
|
|
|
18058
19635
|
url: '/api/v1/payrolls/payroll_runs';
|
|
18059
19636
|
};
|
|
18060
19637
|
export type CreatePayrollRunErrors = {
|
|
19638
|
+
/**
|
|
19639
|
+
* Bad Request
|
|
19640
|
+
*/
|
|
19641
|
+
400: Problem;
|
|
18061
19642
|
/**
|
|
18062
19643
|
* Forbidden
|
|
18063
19644
|
*/
|
|
@@ -18132,7 +19713,7 @@ export type GetPayrollRunResponses = {
|
|
|
18132
19713
|
};
|
|
18133
19714
|
export type GetPayrollRunResponse = GetPayrollRunResponses[keyof GetPayrollRunResponses];
|
|
18134
19715
|
export type UpdatePayrollRunData = {
|
|
18135
|
-
body?:
|
|
19716
|
+
body?: PayrollRunUpdateParameters;
|
|
18136
19717
|
path: {
|
|
18137
19718
|
id: string;
|
|
18138
19719
|
};
|
|
@@ -18140,6 +19721,10 @@ export type UpdatePayrollRunData = {
|
|
|
18140
19721
|
url: '/api/v1/payrolls/payroll_runs/{id}';
|
|
18141
19722
|
};
|
|
18142
19723
|
export type UpdatePayrollRunErrors = {
|
|
19724
|
+
/**
|
|
19725
|
+
* Bad Request
|
|
19726
|
+
*/
|
|
19727
|
+
400: Problem;
|
|
18143
19728
|
/**
|
|
18144
19729
|
* Forbidden
|
|
18145
19730
|
*/
|
|
@@ -18285,7 +19870,7 @@ export type GetPaystubLineItemResponses = {
|
|
|
18285
19870
|
};
|
|
18286
19871
|
export type GetPaystubLineItemResponse = GetPaystubLineItemResponses[keyof GetPaystubLineItemResponses];
|
|
18287
19872
|
export type UpdatePaystubLineItemData = {
|
|
18288
|
-
body?:
|
|
19873
|
+
body?: PaystubLineItemUpdateParameters;
|
|
18289
19874
|
path: {
|
|
18290
19875
|
/**
|
|
18291
19876
|
* Paystub Line Item ID
|
|
@@ -18453,7 +20038,7 @@ export type GetPaystubResponses = {
|
|
|
18453
20038
|
};
|
|
18454
20039
|
export type GetPaystubResponse = GetPaystubResponses[keyof GetPaystubResponses];
|
|
18455
20040
|
export type UpdatePaystubData = {
|
|
18456
|
-
body:
|
|
20041
|
+
body: PaystubUpdateParameters;
|
|
18457
20042
|
path: {
|
|
18458
20043
|
/**
|
|
18459
20044
|
* Paystub ID
|
|
@@ -18485,6 +20070,191 @@ export type UpdatePaystubResponses = {
|
|
|
18485
20070
|
200: PaystubResponseObject;
|
|
18486
20071
|
};
|
|
18487
20072
|
export type UpdatePaystubResponse = UpdatePaystubResponses[keyof UpdatePaystubResponses];
|
|
20073
|
+
export type ListEmploymentHistoryData = {
|
|
20074
|
+
body?: never;
|
|
20075
|
+
path: {
|
|
20076
|
+
employment_id: string;
|
|
20077
|
+
};
|
|
20078
|
+
query?: {
|
|
20079
|
+
'as_of[valid]'?: string;
|
|
20080
|
+
'as_of[transaction]'?: string;
|
|
20081
|
+
/**
|
|
20082
|
+
* This pagination cursor corresponds to the cursor value found in the response in
|
|
20083
|
+
* `meta.page.next_cursor`.
|
|
20084
|
+
*/
|
|
20085
|
+
'page[cursor]'?: string;
|
|
20086
|
+
/**
|
|
20087
|
+
* Maximum number of records to return per page. Defaults to 20. A value above 100 is capped to 100 rather than rejected; a value that is zero, negative, or not an integer is rejected with a `400`.
|
|
20088
|
+
*/
|
|
20089
|
+
'page[limit]'?: number;
|
|
20090
|
+
page?: string;
|
|
20091
|
+
};
|
|
20092
|
+
url: '/api/v1/people/employments/{employment_id}/history';
|
|
20093
|
+
};
|
|
20094
|
+
export type ListEmploymentHistoryErrors = {
|
|
20095
|
+
/**
|
|
20096
|
+
* Bad Request
|
|
20097
|
+
*/
|
|
20098
|
+
400: Problem;
|
|
20099
|
+
/**
|
|
20100
|
+
* Forbidden
|
|
20101
|
+
*/
|
|
20102
|
+
403: Problem;
|
|
20103
|
+
/**
|
|
20104
|
+
* Not Found for an unknown employment
|
|
20105
|
+
*/
|
|
20106
|
+
404: Problem;
|
|
20107
|
+
};
|
|
20108
|
+
export type ListEmploymentHistoryError = ListEmploymentHistoryErrors[keyof ListEmploymentHistoryErrors];
|
|
20109
|
+
export type ListEmploymentHistoryResponses = {
|
|
20110
|
+
/**
|
|
20111
|
+
* Success
|
|
20112
|
+
*/
|
|
20113
|
+
200: {
|
|
20114
|
+
meta: Meta;
|
|
20115
|
+
links: Links;
|
|
20116
|
+
data: Array<PeopleEmploymentHistoryVersionObject>;
|
|
20117
|
+
};
|
|
20118
|
+
};
|
|
20119
|
+
export type ListEmploymentHistoryResponse = ListEmploymentHistoryResponses[keyof ListEmploymentHistoryResponses];
|
|
20120
|
+
export type ListEmploymentsHistoryData = {
|
|
20121
|
+
body?: never;
|
|
20122
|
+
path?: never;
|
|
20123
|
+
query?: {
|
|
20124
|
+
/**
|
|
20125
|
+
* Return history for this user ID.
|
|
20126
|
+
*/
|
|
20127
|
+
'filter[user_id]'?: string;
|
|
20128
|
+
'as_of[valid]'?: string;
|
|
20129
|
+
'as_of[transaction]'?: string;
|
|
20130
|
+
filter?: string;
|
|
20131
|
+
'filter[unexpected]'?: string;
|
|
20132
|
+
/**
|
|
20133
|
+
* This pagination cursor corresponds to the cursor value found in the response in
|
|
20134
|
+
* `meta.page.next_cursor`.
|
|
20135
|
+
*/
|
|
20136
|
+
'page[cursor]'?: string;
|
|
20137
|
+
/**
|
|
20138
|
+
* Maximum number of records to return per page. Defaults to 20. A value above 100 is capped to 100 rather than rejected; a value that is zero, negative, or not an integer is rejected with a `400`.
|
|
20139
|
+
*/
|
|
20140
|
+
'page[limit]'?: number;
|
|
20141
|
+
page?: string;
|
|
20142
|
+
};
|
|
20143
|
+
url: '/api/v1/people/employments/history';
|
|
20144
|
+
};
|
|
20145
|
+
export type ListEmploymentsHistoryErrors = {
|
|
20146
|
+
/**
|
|
20147
|
+
* Bad Request
|
|
20148
|
+
*/
|
|
20149
|
+
400: Problem;
|
|
20150
|
+
/**
|
|
20151
|
+
* Forbidden
|
|
20152
|
+
*/
|
|
20153
|
+
403: Problem;
|
|
20154
|
+
};
|
|
20155
|
+
export type ListEmploymentsHistoryError = ListEmploymentsHistoryErrors[keyof ListEmploymentsHistoryErrors];
|
|
20156
|
+
export type ListEmploymentsHistoryResponses = {
|
|
20157
|
+
/**
|
|
20158
|
+
* Success
|
|
20159
|
+
*/
|
|
20160
|
+
200: {
|
|
20161
|
+
meta: Meta;
|
|
20162
|
+
links: Links;
|
|
20163
|
+
data: Array<PeopleEmploymentHistoryVersionObject>;
|
|
20164
|
+
};
|
|
20165
|
+
};
|
|
20166
|
+
export type ListEmploymentsHistoryResponse = ListEmploymentsHistoryResponses[keyof ListEmploymentsHistoryResponses];
|
|
20167
|
+
export type ListEmploymentsData = {
|
|
20168
|
+
body?: never;
|
|
20169
|
+
path?: never;
|
|
20170
|
+
query?: {
|
|
20171
|
+
/**
|
|
20172
|
+
* Return employments for this user ID.
|
|
20173
|
+
*/
|
|
20174
|
+
'filter[user_id]'?: string;
|
|
20175
|
+
filter?: string;
|
|
20176
|
+
'filter[unexpected]'?: string;
|
|
20177
|
+
/**
|
|
20178
|
+
* Read the version valid at this point in time. Defaults to now.
|
|
20179
|
+
*/
|
|
20180
|
+
'as_of[valid]'?: string;
|
|
20181
|
+
as_of?: string;
|
|
20182
|
+
'as_of[bogus_axis]'?: string;
|
|
20183
|
+
'as_of[valid][gte]'?: string;
|
|
20184
|
+
'as_of[transaction]'?: string;
|
|
20185
|
+
/**
|
|
20186
|
+
* This pagination cursor corresponds to the cursor value found in the response in
|
|
20187
|
+
* `meta.page.next_cursor`.
|
|
20188
|
+
*/
|
|
20189
|
+
'page[cursor]'?: string;
|
|
20190
|
+
/**
|
|
20191
|
+
* 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`.
|
|
20192
|
+
*/
|
|
20193
|
+
'page[limit]'?: number;
|
|
20194
|
+
page?: string;
|
|
20195
|
+
};
|
|
20196
|
+
url: '/api/v1/people/employments';
|
|
20197
|
+
};
|
|
20198
|
+
export type ListEmploymentsErrors = {
|
|
20199
|
+
/**
|
|
20200
|
+
* Bad Request
|
|
20201
|
+
*/
|
|
20202
|
+
400: Problem;
|
|
20203
|
+
/**
|
|
20204
|
+
* Forbidden
|
|
20205
|
+
*/
|
|
20206
|
+
403: Problem;
|
|
20207
|
+
/**
|
|
20208
|
+
* Unprocessable Content
|
|
20209
|
+
*/
|
|
20210
|
+
422: Problem;
|
|
20211
|
+
};
|
|
20212
|
+
export type ListEmploymentsError = ListEmploymentsErrors[keyof ListEmploymentsErrors];
|
|
20213
|
+
export type ListEmploymentsResponses = {
|
|
20214
|
+
/**
|
|
20215
|
+
* Success in a gap between employment stints
|
|
20216
|
+
*/
|
|
20217
|
+
200: {
|
|
20218
|
+
meta: Meta;
|
|
20219
|
+
links: Links;
|
|
20220
|
+
data: Array<PeopleEmploymentResponseObject>;
|
|
20221
|
+
};
|
|
20222
|
+
};
|
|
20223
|
+
export type ListEmploymentsResponse = ListEmploymentsResponses[keyof ListEmploymentsResponses];
|
|
20224
|
+
export type GetEmploymentData = {
|
|
20225
|
+
body?: never;
|
|
20226
|
+
path: {
|
|
20227
|
+
/**
|
|
20228
|
+
* The employment stint identity returned as `id`.
|
|
20229
|
+
*/
|
|
20230
|
+
id: string;
|
|
20231
|
+
};
|
|
20232
|
+
query?: {
|
|
20233
|
+
/**
|
|
20234
|
+
* Read the version valid at this point.
|
|
20235
|
+
*/
|
|
20236
|
+
'as_of[valid]'?: string;
|
|
20237
|
+
};
|
|
20238
|
+
url: '/api/v1/people/employments/{id}';
|
|
20239
|
+
};
|
|
20240
|
+
export type GetEmploymentErrors = {
|
|
20241
|
+
/**
|
|
20242
|
+
* Forbidden
|
|
20243
|
+
*/
|
|
20244
|
+
403: Problem;
|
|
20245
|
+
/**
|
|
20246
|
+
* Not Found in an employment gap
|
|
20247
|
+
*/
|
|
20248
|
+
404: Problem;
|
|
20249
|
+
};
|
|
20250
|
+
export type GetEmploymentError = GetEmploymentErrors[keyof GetEmploymentErrors];
|
|
20251
|
+
export type GetEmploymentResponses = {
|
|
20252
|
+
/**
|
|
20253
|
+
* Success
|
|
20254
|
+
*/
|
|
20255
|
+
200: PeopleEmploymentResponseObject;
|
|
20256
|
+
};
|
|
20257
|
+
export type GetEmploymentResponse = GetEmploymentResponses[keyof GetEmploymentResponses];
|
|
18488
20258
|
export type ListPerDiemsData = {
|
|
18489
20259
|
body?: never;
|
|
18490
20260
|
path?: never;
|
|
@@ -18637,7 +20407,7 @@ export type GetPerDiemResponses = {
|
|
|
18637
20407
|
};
|
|
18638
20408
|
export type GetPerDiemResponse = GetPerDiemResponses[keyof GetPerDiemResponses];
|
|
18639
20409
|
export type UpdatePerDiemData = {
|
|
18640
|
-
body?:
|
|
20410
|
+
body?: PerDiemUpdateParameters;
|
|
18641
20411
|
path: {
|
|
18642
20412
|
/**
|
|
18643
20413
|
* Unique identifier of the per diem.
|
|
@@ -18793,7 +20563,7 @@ export type GetPositionFunctionResponses = {
|
|
|
18793
20563
|
};
|
|
18794
20564
|
export type GetPositionFunctionResponse = GetPositionFunctionResponses[keyof GetPositionFunctionResponses];
|
|
18795
20565
|
export type UpdatePositionFunctionData = {
|
|
18796
|
-
body?:
|
|
20566
|
+
body?: PositionFunctionUpdateParameters;
|
|
18797
20567
|
path: {
|
|
18798
20568
|
id: string;
|
|
18799
20569
|
};
|
|
@@ -18813,6 +20583,10 @@ export type UpdatePositionFunctionErrors = {
|
|
|
18813
20583
|
* Not Found
|
|
18814
20584
|
*/
|
|
18815
20585
|
404: Problem;
|
|
20586
|
+
/**
|
|
20587
|
+
* Unprocessable Content
|
|
20588
|
+
*/
|
|
20589
|
+
422: Problem;
|
|
18816
20590
|
};
|
|
18817
20591
|
export type UpdatePositionFunctionError = UpdatePositionFunctionErrors[keyof UpdatePositionFunctionErrors];
|
|
18818
20592
|
export type UpdatePositionFunctionResponses = {
|
|
@@ -19136,7 +20910,7 @@ export type GetProjectResponses = {
|
|
|
19136
20910
|
};
|
|
19137
20911
|
export type GetProjectResponse = GetProjectResponses[keyof GetProjectResponses];
|
|
19138
20912
|
export type UpdateProjectData = {
|
|
19139
|
-
body:
|
|
20913
|
+
body: ProjectUpdateParameters;
|
|
19140
20914
|
path: {
|
|
19141
20915
|
/**
|
|
19142
20916
|
* Unique identifier of the project (UUID).
|
|
@@ -19197,7 +20971,7 @@ export type CreateCompanyUserDetailResponses = {
|
|
|
19197
20971
|
};
|
|
19198
20972
|
export type CreateCompanyUserDetailResponse = CreateCompanyUserDetailResponses[keyof CreateCompanyUserDetailResponses];
|
|
19199
20973
|
export type UpdateCompanyUserDetailData = {
|
|
19200
|
-
body:
|
|
20974
|
+
body: PwaCompanyUserDetailsUpdateParameters;
|
|
19201
20975
|
path: {
|
|
19202
20976
|
id: string;
|
|
19203
20977
|
};
|
|
@@ -19205,6 +20979,10 @@ export type UpdateCompanyUserDetailData = {
|
|
|
19205
20979
|
url: '/api/v1/pwa/company_user_details/{id}';
|
|
19206
20980
|
};
|
|
19207
20981
|
export type UpdateCompanyUserDetailErrors = {
|
|
20982
|
+
/**
|
|
20983
|
+
* Bad Request
|
|
20984
|
+
*/
|
|
20985
|
+
400: Problem;
|
|
19208
20986
|
/**
|
|
19209
20987
|
* Forbidden
|
|
19210
20988
|
*/
|
|
@@ -19974,7 +21752,7 @@ export type DeleteTimeCardPerDiemResponses = {
|
|
|
19974
21752
|
};
|
|
19975
21753
|
export type DeleteTimeCardPerDiemResponse = DeleteTimeCardPerDiemResponses[keyof DeleteTimeCardPerDiemResponses];
|
|
19976
21754
|
export type UpdateTimeCardPerDiemData = {
|
|
19977
|
-
body:
|
|
21755
|
+
body: TimeCardPerDiemUpdateParameters;
|
|
19978
21756
|
path: {
|
|
19979
21757
|
time_card_id: string;
|
|
19980
21758
|
id: number;
|
|
@@ -21378,7 +23156,7 @@ export type DeleteHolidayResponses = {
|
|
|
21378
23156
|
};
|
|
21379
23157
|
export type DeleteHolidayResponse = DeleteHolidayResponses[keyof DeleteHolidayResponses];
|
|
21380
23158
|
export type UpdateHolidayData = {
|
|
21381
|
-
body:
|
|
23159
|
+
body: HolidayUpdateParameters;
|
|
21382
23160
|
path: {
|
|
21383
23161
|
/**
|
|
21384
23162
|
* ID of the pay schedule
|
|
@@ -21894,6 +23672,10 @@ export type UpdateScheduledChangeData = {
|
|
|
21894
23672
|
url: '/api/v1/users/{user_id}/companies/{company_id}/scheduled_changes/{id}';
|
|
21895
23673
|
};
|
|
21896
23674
|
export type UpdateScheduledChangeErrors = {
|
|
23675
|
+
/**
|
|
23676
|
+
* Bad Request
|
|
23677
|
+
*/
|
|
23678
|
+
400: Problem;
|
|
21897
23679
|
/**
|
|
21898
23680
|
* Forbidden
|
|
21899
23681
|
*/
|