@dsptch-work/api-client 0.12.0 → 0.13.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 +17 -0
- package/dist/gen/index.d.ts +2 -2
- package/dist/gen/index.js +1 -1
- package/dist/gen/sdk.gen.d.ts +67 -1
- package/dist/gen/sdk.gen.js +100 -0
- package/dist/gen/types.gen.d.ts +436 -1
- package/dist/gen/zod.gen.d.ts +358 -1
- package/dist/gen/zod.gen.js +187 -1
- package/package.json +1 -1
package/dist/gen/zod.gen.d.ts
CHANGED
|
@@ -2949,6 +2949,66 @@ export declare const zComplianceCheckParameters: z.ZodObject<{
|
|
|
2949
2949
|
}>>;
|
|
2950
2950
|
time_due: z.ZodOptional<z.ZodNullable<z.ZodISODateTime>>;
|
|
2951
2951
|
}, z.core.$strip>;
|
|
2952
|
+
/**
|
|
2953
|
+
* One compliance requirement from the catalog. Requirements ship with the application, so the catalog reads the same for every company.
|
|
2954
|
+
*/
|
|
2955
|
+
export declare const zComplianceRequirementResponseObject: z.ZodObject<{
|
|
2956
|
+
id: z.ZodString;
|
|
2957
|
+
type: z.ZodString;
|
|
2958
|
+
title: z.ZodString;
|
|
2959
|
+
description: z.ZodString;
|
|
2960
|
+
target: z.ZodEnum<{
|
|
2961
|
+
Company: "Company";
|
|
2962
|
+
Job: "Job";
|
|
2963
|
+
Project: "Project";
|
|
2964
|
+
"Timekeeping::TimeCard": "Timekeeping::TimeCard";
|
|
2965
|
+
"Timekeeping::PayPeriod": "Timekeeping::PayPeriod";
|
|
2966
|
+
User: "User";
|
|
2967
|
+
UserCompany: "UserCompany";
|
|
2968
|
+
}>;
|
|
2969
|
+
category: z.ZodEnum<{
|
|
2970
|
+
regional: "regional";
|
|
2971
|
+
job: "job";
|
|
2972
|
+
project: "project";
|
|
2973
|
+
company: "company";
|
|
2974
|
+
apprenticeship: "apprenticeship";
|
|
2975
|
+
certified_payroll: "certified_payroll";
|
|
2976
|
+
payroll: "payroll";
|
|
2977
|
+
tax_credit: "tax_credit";
|
|
2978
|
+
timekeeping: "timekeeping";
|
|
2979
|
+
worker: "worker";
|
|
2980
|
+
}>;
|
|
2981
|
+
phase: z.ZodEnum<{
|
|
2982
|
+
after_pay_date: "after_pay_date";
|
|
2983
|
+
before_approval_deadline: "before_approval_deadline";
|
|
2984
|
+
close_out: "close_out";
|
|
2985
|
+
maintenance: "maintenance";
|
|
2986
|
+
onboarding: "onboarding";
|
|
2987
|
+
setup: "setup";
|
|
2988
|
+
}>;
|
|
2989
|
+
priority: z.ZodNullable<z.ZodEnum<{
|
|
2990
|
+
high: "high";
|
|
2991
|
+
low: "low";
|
|
2992
|
+
critical: "critical";
|
|
2993
|
+
medium: "medium";
|
|
2994
|
+
}>>;
|
|
2995
|
+
requisite: z.ZodNullable<z.ZodEnum<{
|
|
2996
|
+
apprenticeship: "apprenticeship";
|
|
2997
|
+
payroll: "payroll";
|
|
2998
|
+
timekeeping: "timekeeping";
|
|
2999
|
+
best_practice: "best_practice";
|
|
3000
|
+
dsptch: "dsptch";
|
|
3001
|
+
federal_pwa: "federal_pwa";
|
|
3002
|
+
ira: "ira";
|
|
3003
|
+
ira_tax_credit: "ira_tax_credit";
|
|
3004
|
+
pwa: "pwa";
|
|
3005
|
+
regional_pwa: "regional_pwa";
|
|
3006
|
+
wh347: "wh347";
|
|
3007
|
+
}>>;
|
|
3008
|
+
sort_order: z.ZodInt;
|
|
3009
|
+
created_at: z.ZodISODateTime;
|
|
3010
|
+
updated_at: z.ZodISODateTime;
|
|
3011
|
+
}, z.core.$strip>;
|
|
2952
3012
|
/**
|
|
2953
3013
|
* A worker's individual payment record within a payroll run — a recorded or imported actual payment. Its money detail lives in the paystub's line items; this record carries only identifiers.
|
|
2954
3014
|
*/
|
|
@@ -2973,7 +3033,7 @@ export declare const zPaystubParameters: z.ZodObject<{
|
|
|
2973
3033
|
check_number: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2974
3034
|
}, z.core.$strip>;
|
|
2975
3035
|
/**
|
|
2976
|
-
* An adjustment applied in the current pay period to correct a prior one, tied to the paystub line item it corrects.
|
|
3036
|
+
* An adjustment applied in the current pay period to correct a prior one, tied to the paystub line item it corrects.
|
|
2977
3037
|
*/
|
|
2978
3038
|
export declare const zPriorPeriodAdjustmentResponseObject: z.ZodObject<{
|
|
2979
3039
|
id: z.ZodString;
|
|
@@ -2998,6 +3058,59 @@ export declare const zPriorPeriodAdjustmentResponseObject: z.ZodObject<{
|
|
|
2998
3058
|
created_at: z.ZodISODateTime;
|
|
2999
3059
|
updated_at: z.ZodISODateTime;
|
|
3000
3060
|
}, z.core.$strip>;
|
|
3061
|
+
/**
|
|
3062
|
+
* Request body for allocating part of a retroactive-pay line item to an earlier time card. The time card comes from the path; the adjustment is always a retroactive increase.
|
|
3063
|
+
*/
|
|
3064
|
+
export declare const zPriorPeriodAdjustmentParameters: z.ZodObject<{
|
|
3065
|
+
payrolls_paystub_line_item_id: z.ZodString;
|
|
3066
|
+
created_by_user_id: z.ZodString;
|
|
3067
|
+
amount_cents: z.ZodString;
|
|
3068
|
+
rationale: z.ZodEnum<{
|
|
3069
|
+
other: "other";
|
|
3070
|
+
hours_correction: "hours_correction";
|
|
3071
|
+
pwa_compliance: "pwa_compliance";
|
|
3072
|
+
rate_correction: "rate_correction";
|
|
3073
|
+
}>;
|
|
3074
|
+
job_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
3075
|
+
notes: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
3076
|
+
pwa_compliance_eligible: z.ZodOptional<z.ZodBoolean>;
|
|
3077
|
+
}, z.core.$strip>;
|
|
3078
|
+
/**
|
|
3079
|
+
* What one PWA-tracked job on a time card still owes the worker, from the materialized prevailing-wage compliance view. Read-only.
|
|
3080
|
+
*/
|
|
3081
|
+
export declare const zPwaComplianceResponseObject: z.ZodObject<{
|
|
3082
|
+
timekeeping_time_card_id: z.ZodString;
|
|
3083
|
+
timekeeping_pay_period_id: z.ZodString;
|
|
3084
|
+
job_id: z.ZodString;
|
|
3085
|
+
user_id: z.ZodString;
|
|
3086
|
+
pwa_minutes_worked: z.ZodInt;
|
|
3087
|
+
federal_post_interest_outstanding_cents: z.ZodString;
|
|
3088
|
+
regional_post_interest_outstanding_cents: z.ZodString;
|
|
3089
|
+
pwa_adjustments_cents: z.ZodString;
|
|
3090
|
+
federal_balance_due_cents: z.ZodString;
|
|
3091
|
+
regional_balance_due_cents: z.ZodString;
|
|
3092
|
+
balance_due_cents: z.ZodString;
|
|
3093
|
+
all_actuals_exist: z.ZodBoolean;
|
|
3094
|
+
compliant: z.ZodBoolean;
|
|
3095
|
+
}, z.core.$strip>;
|
|
3096
|
+
/**
|
|
3097
|
+
* A retroactive-pay line item that can fund a prior period adjustment on the time card it was requested for. Read-only.
|
|
3098
|
+
*/
|
|
3099
|
+
export declare const zAdjustableLineItemResponseObject: z.ZodObject<{
|
|
3100
|
+
id: z.ZodString;
|
|
3101
|
+
payrolls_paystub_id: z.ZodNullable<z.ZodString>;
|
|
3102
|
+
payrolls_payroll_run_id: z.ZodNullable<z.ZodString>;
|
|
3103
|
+
payrolls_external_map_id: z.ZodString;
|
|
3104
|
+
user_id: z.ZodNullable<z.ZodString>;
|
|
3105
|
+
amount_cents: z.ZodString;
|
|
3106
|
+
contributor: z.ZodEnum<{
|
|
3107
|
+
employee: "employee";
|
|
3108
|
+
employer: "employer";
|
|
3109
|
+
}>;
|
|
3110
|
+
adjustable_amount_cents: z.ZodString;
|
|
3111
|
+
created_at: z.ZodISODateTime;
|
|
3112
|
+
updated_at: z.ZodISODateTime;
|
|
3113
|
+
}, z.core.$strip>;
|
|
3001
3114
|
/**
|
|
3002
3115
|
* What a worker was actually paid for a pay period, derived from imported paystub line items — gross and net pay, employee deductions (taxes, insurance, savings, garnishments), and employer contributions. Read-only. Every amount is a decimal string of cents.
|
|
3003
3116
|
*/
|
|
@@ -11867,6 +11980,93 @@ export declare const zUpdateCheckResponse: z.ZodObject<{
|
|
|
11867
11980
|
created_at: z.ZodISODateTime;
|
|
11868
11981
|
updated_at: z.ZodISODateTime;
|
|
11869
11982
|
}, z.core.$strip>;
|
|
11983
|
+
export declare const zListRequirementsQuery: z.ZodObject<{
|
|
11984
|
+
'filter[search]': z.ZodOptional<z.ZodString>;
|
|
11985
|
+
'filter[type]': z.ZodOptional<z.ZodString>;
|
|
11986
|
+
'filter[category]': z.ZodOptional<z.ZodString>;
|
|
11987
|
+
'filter[phase]': z.ZodOptional<z.ZodString>;
|
|
11988
|
+
'filter[priority]': z.ZodOptional<z.ZodString>;
|
|
11989
|
+
'filter[requisite]': z.ZodOptional<z.ZodString>;
|
|
11990
|
+
'filter[target]': z.ZodOptional<z.ZodString>;
|
|
11991
|
+
filter: z.ZodOptional<z.ZodString>;
|
|
11992
|
+
'filter[unexpected]': z.ZodOptional<z.ZodString>;
|
|
11993
|
+
'page[cursor]': z.ZodOptional<z.ZodString>;
|
|
11994
|
+
'page[limit]': z.ZodDefault<z.ZodOptional<z.ZodInt>>;
|
|
11995
|
+
page: z.ZodOptional<z.ZodString>;
|
|
11996
|
+
}, z.core.$strip>;
|
|
11997
|
+
/**
|
|
11998
|
+
* Success
|
|
11999
|
+
*/
|
|
12000
|
+
export declare const zListRequirementsResponse: z.ZodObject<{
|
|
12001
|
+
meta: z.ZodObject<{
|
|
12002
|
+
page: z.ZodObject<{
|
|
12003
|
+
next_cursor: z.ZodNullable<z.ZodString>;
|
|
12004
|
+
current_cursor: z.ZodNullable<z.ZodString>;
|
|
12005
|
+
}, z.core.$strip>;
|
|
12006
|
+
}, z.core.$strip>;
|
|
12007
|
+
links: z.ZodObject<{
|
|
12008
|
+
self: z.ZodString;
|
|
12009
|
+
first: z.ZodNullable<z.ZodString>;
|
|
12010
|
+
next: z.ZodNullable<z.ZodString>;
|
|
12011
|
+
}, z.core.$strip>;
|
|
12012
|
+
data: z.ZodArray<z.ZodObject<{
|
|
12013
|
+
id: z.ZodString;
|
|
12014
|
+
type: z.ZodString;
|
|
12015
|
+
title: z.ZodString;
|
|
12016
|
+
description: z.ZodString;
|
|
12017
|
+
target: z.ZodEnum<{
|
|
12018
|
+
Company: "Company";
|
|
12019
|
+
Job: "Job";
|
|
12020
|
+
Project: "Project";
|
|
12021
|
+
"Timekeeping::TimeCard": "Timekeeping::TimeCard";
|
|
12022
|
+
"Timekeeping::PayPeriod": "Timekeeping::PayPeriod";
|
|
12023
|
+
User: "User";
|
|
12024
|
+
UserCompany: "UserCompany";
|
|
12025
|
+
}>;
|
|
12026
|
+
category: z.ZodEnum<{
|
|
12027
|
+
regional: "regional";
|
|
12028
|
+
job: "job";
|
|
12029
|
+
project: "project";
|
|
12030
|
+
company: "company";
|
|
12031
|
+
apprenticeship: "apprenticeship";
|
|
12032
|
+
certified_payroll: "certified_payroll";
|
|
12033
|
+
payroll: "payroll";
|
|
12034
|
+
tax_credit: "tax_credit";
|
|
12035
|
+
timekeeping: "timekeeping";
|
|
12036
|
+
worker: "worker";
|
|
12037
|
+
}>;
|
|
12038
|
+
phase: z.ZodEnum<{
|
|
12039
|
+
after_pay_date: "after_pay_date";
|
|
12040
|
+
before_approval_deadline: "before_approval_deadline";
|
|
12041
|
+
close_out: "close_out";
|
|
12042
|
+
maintenance: "maintenance";
|
|
12043
|
+
onboarding: "onboarding";
|
|
12044
|
+
setup: "setup";
|
|
12045
|
+
}>;
|
|
12046
|
+
priority: z.ZodNullable<z.ZodEnum<{
|
|
12047
|
+
high: "high";
|
|
12048
|
+
low: "low";
|
|
12049
|
+
critical: "critical";
|
|
12050
|
+
medium: "medium";
|
|
12051
|
+
}>>;
|
|
12052
|
+
requisite: z.ZodNullable<z.ZodEnum<{
|
|
12053
|
+
apprenticeship: "apprenticeship";
|
|
12054
|
+
payroll: "payroll";
|
|
12055
|
+
timekeeping: "timekeeping";
|
|
12056
|
+
best_practice: "best_practice";
|
|
12057
|
+
dsptch: "dsptch";
|
|
12058
|
+
federal_pwa: "federal_pwa";
|
|
12059
|
+
ira: "ira";
|
|
12060
|
+
ira_tax_credit: "ira_tax_credit";
|
|
12061
|
+
pwa: "pwa";
|
|
12062
|
+
regional_pwa: "regional_pwa";
|
|
12063
|
+
wh347: "wh347";
|
|
12064
|
+
}>>;
|
|
12065
|
+
sort_order: z.ZodInt;
|
|
12066
|
+
created_at: z.ZodISODateTime;
|
|
12067
|
+
updated_at: z.ZodISODateTime;
|
|
12068
|
+
}, z.core.$strip>>;
|
|
12069
|
+
}, z.core.$strip>;
|
|
11870
12070
|
export declare const zListCustomFieldConfigsQuery: z.ZodObject<{
|
|
11871
12071
|
'page[cursor]': z.ZodOptional<z.ZodString>;
|
|
11872
12072
|
'page[limit]': z.ZodDefault<z.ZodOptional<z.ZodInt>>;
|
|
@@ -16718,6 +16918,48 @@ export declare const zListTemplatesResponse: z.ZodObject<{
|
|
|
16718
16918
|
description: z.ZodNullable<z.ZodString>;
|
|
16719
16919
|
}, z.core.$strip>>;
|
|
16720
16920
|
}, z.core.$strip>;
|
|
16921
|
+
export declare const zListAdjustableLineItemsPath: z.ZodObject<{
|
|
16922
|
+
time_card_id: z.ZodString;
|
|
16923
|
+
}, z.core.$strip>;
|
|
16924
|
+
export declare const zListAdjustableLineItemsQuery: z.ZodObject<{
|
|
16925
|
+
'filter[payrolls_paystub_id]': z.ZodOptional<z.ZodString>;
|
|
16926
|
+
'page[cursor]': z.ZodOptional<z.ZodString>;
|
|
16927
|
+
'page[limit]': z.ZodDefault<z.ZodOptional<z.ZodInt>>;
|
|
16928
|
+
page: z.ZodOptional<z.ZodString>;
|
|
16929
|
+
filter: z.ZodOptional<z.ZodString>;
|
|
16930
|
+
'filter[unexpected]': z.ZodOptional<z.ZodString>;
|
|
16931
|
+
}, z.core.$strip>;
|
|
16932
|
+
/**
|
|
16933
|
+
* Success
|
|
16934
|
+
*/
|
|
16935
|
+
export declare const zListAdjustableLineItemsResponse: z.ZodObject<{
|
|
16936
|
+
meta: z.ZodObject<{
|
|
16937
|
+
page: z.ZodObject<{
|
|
16938
|
+
next_cursor: z.ZodNullable<z.ZodString>;
|
|
16939
|
+
current_cursor: z.ZodNullable<z.ZodString>;
|
|
16940
|
+
}, z.core.$strip>;
|
|
16941
|
+
}, z.core.$strip>;
|
|
16942
|
+
links: z.ZodObject<{
|
|
16943
|
+
self: z.ZodString;
|
|
16944
|
+
first: z.ZodNullable<z.ZodString>;
|
|
16945
|
+
next: z.ZodNullable<z.ZodString>;
|
|
16946
|
+
}, z.core.$strip>;
|
|
16947
|
+
data: z.ZodArray<z.ZodObject<{
|
|
16948
|
+
id: z.ZodString;
|
|
16949
|
+
payrolls_paystub_id: z.ZodNullable<z.ZodString>;
|
|
16950
|
+
payrolls_payroll_run_id: z.ZodNullable<z.ZodString>;
|
|
16951
|
+
payrolls_external_map_id: z.ZodString;
|
|
16952
|
+
user_id: z.ZodNullable<z.ZodString>;
|
|
16953
|
+
amount_cents: z.ZodString;
|
|
16954
|
+
contributor: z.ZodEnum<{
|
|
16955
|
+
employee: "employee";
|
|
16956
|
+
employer: "employer";
|
|
16957
|
+
}>;
|
|
16958
|
+
adjustable_amount_cents: z.ZodString;
|
|
16959
|
+
created_at: z.ZodISODateTime;
|
|
16960
|
+
updated_at: z.ZodISODateTime;
|
|
16961
|
+
}, z.core.$strip>>;
|
|
16962
|
+
}, z.core.$strip>;
|
|
16721
16963
|
export declare const zSetTimeCardLockBody: z.ZodObject<{
|
|
16722
16964
|
locked: z.ZodBoolean;
|
|
16723
16965
|
}, z.core.$strip>;
|
|
@@ -16946,6 +17188,79 @@ export declare const zListPriorPeriodAdjustmentsResponse: z.ZodObject<{
|
|
|
16946
17188
|
updated_at: z.ZodISODateTime;
|
|
16947
17189
|
}, z.core.$strip>>;
|
|
16948
17190
|
}, z.core.$strip>;
|
|
17191
|
+
export declare const zCreatePriorPeriodAdjustmentBody: z.ZodObject<{
|
|
17192
|
+
payrolls_paystub_line_item_id: z.ZodString;
|
|
17193
|
+
created_by_user_id: z.ZodString;
|
|
17194
|
+
amount_cents: z.ZodString;
|
|
17195
|
+
rationale: z.ZodEnum<{
|
|
17196
|
+
other: "other";
|
|
17197
|
+
hours_correction: "hours_correction";
|
|
17198
|
+
pwa_compliance: "pwa_compliance";
|
|
17199
|
+
rate_correction: "rate_correction";
|
|
17200
|
+
}>;
|
|
17201
|
+
job_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
17202
|
+
notes: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
17203
|
+
pwa_compliance_eligible: z.ZodOptional<z.ZodBoolean>;
|
|
17204
|
+
}, z.core.$strip>;
|
|
17205
|
+
export declare const zCreatePriorPeriodAdjustmentPath: z.ZodObject<{
|
|
17206
|
+
time_card_id: z.ZodString;
|
|
17207
|
+
}, z.core.$strip>;
|
|
17208
|
+
/**
|
|
17209
|
+
* Created
|
|
17210
|
+
*/
|
|
17211
|
+
export declare const zCreatePriorPeriodAdjustmentResponse: z.ZodObject<{
|
|
17212
|
+
id: z.ZodString;
|
|
17213
|
+
timekeeping_time_card_id: z.ZodString;
|
|
17214
|
+
payrolls_paystub_line_item_id: z.ZodString;
|
|
17215
|
+
job_id: z.ZodNullable<z.ZodString>;
|
|
17216
|
+
created_by_user_id: z.ZodString;
|
|
17217
|
+
adjustment_type: z.ZodEnum<{
|
|
17218
|
+
overpayment_recovery: "overpayment_recovery";
|
|
17219
|
+
retroactive_increase: "retroactive_increase";
|
|
17220
|
+
}>;
|
|
17221
|
+
rationale: z.ZodEnum<{
|
|
17222
|
+
other: "other";
|
|
17223
|
+
hours_correction: "hours_correction";
|
|
17224
|
+
pwa_compliance: "pwa_compliance";
|
|
17225
|
+
rate_correction: "rate_correction";
|
|
17226
|
+
}>;
|
|
17227
|
+
notes: z.ZodNullable<z.ZodString>;
|
|
17228
|
+
pwa_compliance_eligible: z.ZodBoolean;
|
|
17229
|
+
amount_cents: z.ZodString;
|
|
17230
|
+
currency: z.ZodString;
|
|
17231
|
+
created_at: z.ZodISODateTime;
|
|
17232
|
+
updated_at: z.ZodISODateTime;
|
|
17233
|
+
}, z.core.$strip>;
|
|
17234
|
+
export declare const zDeletePriorPeriodAdjustmentPath: z.ZodObject<{
|
|
17235
|
+
time_card_id: z.ZodString;
|
|
17236
|
+
id: z.ZodString;
|
|
17237
|
+
}, z.core.$strip>;
|
|
17238
|
+
/**
|
|
17239
|
+
* Success
|
|
17240
|
+
*/
|
|
17241
|
+
export declare const zDeletePriorPeriodAdjustmentResponse: z.ZodObject<{
|
|
17242
|
+
id: z.ZodString;
|
|
17243
|
+
timekeeping_time_card_id: z.ZodString;
|
|
17244
|
+
payrolls_paystub_line_item_id: z.ZodString;
|
|
17245
|
+
job_id: z.ZodNullable<z.ZodString>;
|
|
17246
|
+
created_by_user_id: z.ZodString;
|
|
17247
|
+
adjustment_type: z.ZodEnum<{
|
|
17248
|
+
overpayment_recovery: "overpayment_recovery";
|
|
17249
|
+
retroactive_increase: "retroactive_increase";
|
|
17250
|
+
}>;
|
|
17251
|
+
rationale: z.ZodEnum<{
|
|
17252
|
+
other: "other";
|
|
17253
|
+
hours_correction: "hours_correction";
|
|
17254
|
+
pwa_compliance: "pwa_compliance";
|
|
17255
|
+
rate_correction: "rate_correction";
|
|
17256
|
+
}>;
|
|
17257
|
+
notes: z.ZodNullable<z.ZodString>;
|
|
17258
|
+
pwa_compliance_eligible: z.ZodBoolean;
|
|
17259
|
+
amount_cents: z.ZodString;
|
|
17260
|
+
currency: z.ZodString;
|
|
17261
|
+
created_at: z.ZodISODateTime;
|
|
17262
|
+
updated_at: z.ZodISODateTime;
|
|
17263
|
+
}, z.core.$strip>;
|
|
16949
17264
|
export declare const zGetPriorPeriodAdjustmentPath: z.ZodObject<{
|
|
16950
17265
|
time_card_id: z.ZodString;
|
|
16951
17266
|
id: z.ZodString;
|
|
@@ -16976,6 +17291,48 @@ export declare const zGetPriorPeriodAdjustmentResponse: z.ZodObject<{
|
|
|
16976
17291
|
created_at: z.ZodISODateTime;
|
|
16977
17292
|
updated_at: z.ZodISODateTime;
|
|
16978
17293
|
}, z.core.$strip>;
|
|
17294
|
+
export declare const zListPwaCompliancesPath: z.ZodObject<{
|
|
17295
|
+
time_card_id: z.ZodString;
|
|
17296
|
+
}, z.core.$strip>;
|
|
17297
|
+
export declare const zListPwaCompliancesQuery: z.ZodObject<{
|
|
17298
|
+
'filter[job_id]': z.ZodOptional<z.ZodString>;
|
|
17299
|
+
'page[cursor]': z.ZodOptional<z.ZodString>;
|
|
17300
|
+
'page[limit]': z.ZodDefault<z.ZodOptional<z.ZodInt>>;
|
|
17301
|
+
page: z.ZodOptional<z.ZodString>;
|
|
17302
|
+
filter: z.ZodOptional<z.ZodString>;
|
|
17303
|
+
'filter[unexpected]': z.ZodOptional<z.ZodString>;
|
|
17304
|
+
}, z.core.$strip>;
|
|
17305
|
+
/**
|
|
17306
|
+
* Success
|
|
17307
|
+
*/
|
|
17308
|
+
export declare const zListPwaCompliancesResponse: z.ZodObject<{
|
|
17309
|
+
meta: z.ZodObject<{
|
|
17310
|
+
page: z.ZodObject<{
|
|
17311
|
+
next_cursor: z.ZodNullable<z.ZodString>;
|
|
17312
|
+
current_cursor: z.ZodNullable<z.ZodString>;
|
|
17313
|
+
}, z.core.$strip>;
|
|
17314
|
+
}, z.core.$strip>;
|
|
17315
|
+
links: z.ZodObject<{
|
|
17316
|
+
self: z.ZodString;
|
|
17317
|
+
first: z.ZodNullable<z.ZodString>;
|
|
17318
|
+
next: z.ZodNullable<z.ZodString>;
|
|
17319
|
+
}, z.core.$strip>;
|
|
17320
|
+
data: z.ZodArray<z.ZodObject<{
|
|
17321
|
+
timekeeping_time_card_id: z.ZodString;
|
|
17322
|
+
timekeeping_pay_period_id: z.ZodString;
|
|
17323
|
+
job_id: z.ZodString;
|
|
17324
|
+
user_id: z.ZodString;
|
|
17325
|
+
pwa_minutes_worked: z.ZodInt;
|
|
17326
|
+
federal_post_interest_outstanding_cents: z.ZodString;
|
|
17327
|
+
regional_post_interest_outstanding_cents: z.ZodString;
|
|
17328
|
+
pwa_adjustments_cents: z.ZodString;
|
|
17329
|
+
federal_balance_due_cents: z.ZodString;
|
|
17330
|
+
regional_balance_due_cents: z.ZodString;
|
|
17331
|
+
balance_due_cents: z.ZodString;
|
|
17332
|
+
all_actuals_exist: z.ZodBoolean;
|
|
17333
|
+
compliant: z.ZodBoolean;
|
|
17334
|
+
}, z.core.$strip>>;
|
|
17335
|
+
}, z.core.$strip>;
|
|
16979
17336
|
export declare const zCreateWorkerTimeCardApprovalBody: z.ZodObject<{
|
|
16980
17337
|
status: z.ZodEnum<{
|
|
16981
17338
|
pending: "pending";
|
package/dist/gen/zod.gen.js
CHANGED
|
@@ -2706,6 +2706,66 @@ export const zComplianceCheckParameters = z.object({
|
|
|
2706
2706
|
status: z.enum(['dismissed', 'pending']).optional(),
|
|
2707
2707
|
time_due: z.iso.datetime().nullish()
|
|
2708
2708
|
});
|
|
2709
|
+
/**
|
|
2710
|
+
* One compliance requirement from the catalog. Requirements ship with the application, so the catalog reads the same for every company.
|
|
2711
|
+
*/
|
|
2712
|
+
export const zComplianceRequirementResponseObject = z.object({
|
|
2713
|
+
id: z.string(),
|
|
2714
|
+
type: z.string(),
|
|
2715
|
+
title: z.string(),
|
|
2716
|
+
description: z.string(),
|
|
2717
|
+
target: z.enum([
|
|
2718
|
+
'Company',
|
|
2719
|
+
'Job',
|
|
2720
|
+
'Project',
|
|
2721
|
+
'Timekeeping::TimeCard',
|
|
2722
|
+
'Timekeeping::PayPeriod',
|
|
2723
|
+
'User',
|
|
2724
|
+
'UserCompany'
|
|
2725
|
+
]),
|
|
2726
|
+
category: z.enum([
|
|
2727
|
+
'apprenticeship',
|
|
2728
|
+
'certified_payroll',
|
|
2729
|
+
'company',
|
|
2730
|
+
'job',
|
|
2731
|
+
'payroll',
|
|
2732
|
+
'project',
|
|
2733
|
+
'regional',
|
|
2734
|
+
'tax_credit',
|
|
2735
|
+
'timekeeping',
|
|
2736
|
+
'worker'
|
|
2737
|
+
]),
|
|
2738
|
+
phase: z.enum([
|
|
2739
|
+
'after_pay_date',
|
|
2740
|
+
'before_approval_deadline',
|
|
2741
|
+
'close_out',
|
|
2742
|
+
'maintenance',
|
|
2743
|
+
'onboarding',
|
|
2744
|
+
'setup'
|
|
2745
|
+
]),
|
|
2746
|
+
priority: z.enum([
|
|
2747
|
+
'critical',
|
|
2748
|
+
'high',
|
|
2749
|
+
'medium',
|
|
2750
|
+
'low'
|
|
2751
|
+
]).nullable(),
|
|
2752
|
+
requisite: z.enum([
|
|
2753
|
+
'apprenticeship',
|
|
2754
|
+
'best_practice',
|
|
2755
|
+
'dsptch',
|
|
2756
|
+
'federal_pwa',
|
|
2757
|
+
'ira',
|
|
2758
|
+
'ira_tax_credit',
|
|
2759
|
+
'payroll',
|
|
2760
|
+
'pwa',
|
|
2761
|
+
'regional_pwa',
|
|
2762
|
+
'timekeeping',
|
|
2763
|
+
'wh347'
|
|
2764
|
+
]).nullable(),
|
|
2765
|
+
sort_order: z.int(),
|
|
2766
|
+
created_at: z.iso.datetime(),
|
|
2767
|
+
updated_at: z.iso.datetime()
|
|
2768
|
+
});
|
|
2709
2769
|
/**
|
|
2710
2770
|
* A worker's individual payment record within a payroll run — a recorded or imported actual payment. Its money detail lives in the paystub's line items; this record carries only identifiers.
|
|
2711
2771
|
*/
|
|
@@ -2730,7 +2790,7 @@ export const zPaystubParameters = z.object({
|
|
|
2730
2790
|
check_number: z.string().nullish()
|
|
2731
2791
|
});
|
|
2732
2792
|
/**
|
|
2733
|
-
* An adjustment applied in the current pay period to correct a prior one, tied to the paystub line item it corrects.
|
|
2793
|
+
* An adjustment applied in the current pay period to correct a prior one, tied to the paystub line item it corrects.
|
|
2734
2794
|
*/
|
|
2735
2795
|
export const zPriorPeriodAdjustmentResponseObject = z.object({
|
|
2736
2796
|
id: z.string(),
|
|
@@ -2752,6 +2812,56 @@ export const zPriorPeriodAdjustmentResponseObject = z.object({
|
|
|
2752
2812
|
created_at: z.iso.datetime(),
|
|
2753
2813
|
updated_at: z.iso.datetime()
|
|
2754
2814
|
});
|
|
2815
|
+
/**
|
|
2816
|
+
* Request body for allocating part of a retroactive-pay line item to an earlier time card. The time card comes from the path; the adjustment is always a retroactive increase.
|
|
2817
|
+
*/
|
|
2818
|
+
export const zPriorPeriodAdjustmentParameters = z.object({
|
|
2819
|
+
payrolls_paystub_line_item_id: z.string(),
|
|
2820
|
+
created_by_user_id: z.string(),
|
|
2821
|
+
amount_cents: z.string(),
|
|
2822
|
+
rationale: z.enum([
|
|
2823
|
+
'hours_correction',
|
|
2824
|
+
'other',
|
|
2825
|
+
'pwa_compliance',
|
|
2826
|
+
'rate_correction'
|
|
2827
|
+
]),
|
|
2828
|
+
job_id: z.string().nullish(),
|
|
2829
|
+
notes: z.string().nullish(),
|
|
2830
|
+
pwa_compliance_eligible: z.boolean().optional()
|
|
2831
|
+
});
|
|
2832
|
+
/**
|
|
2833
|
+
* What one PWA-tracked job on a time card still owes the worker, from the materialized prevailing-wage compliance view. Read-only.
|
|
2834
|
+
*/
|
|
2835
|
+
export const zPwaComplianceResponseObject = z.object({
|
|
2836
|
+
timekeeping_time_card_id: z.string(),
|
|
2837
|
+
timekeeping_pay_period_id: z.string(),
|
|
2838
|
+
job_id: z.string(),
|
|
2839
|
+
user_id: z.string(),
|
|
2840
|
+
pwa_minutes_worked: z.int(),
|
|
2841
|
+
federal_post_interest_outstanding_cents: z.string(),
|
|
2842
|
+
regional_post_interest_outstanding_cents: z.string(),
|
|
2843
|
+
pwa_adjustments_cents: z.string(),
|
|
2844
|
+
federal_balance_due_cents: z.string(),
|
|
2845
|
+
regional_balance_due_cents: z.string(),
|
|
2846
|
+
balance_due_cents: z.string(),
|
|
2847
|
+
all_actuals_exist: z.boolean(),
|
|
2848
|
+
compliant: z.boolean()
|
|
2849
|
+
});
|
|
2850
|
+
/**
|
|
2851
|
+
* A retroactive-pay line item that can fund a prior period adjustment on the time card it was requested for. Read-only.
|
|
2852
|
+
*/
|
|
2853
|
+
export const zAdjustableLineItemResponseObject = z.object({
|
|
2854
|
+
id: z.string(),
|
|
2855
|
+
payrolls_paystub_id: z.string().nullable(),
|
|
2856
|
+
payrolls_payroll_run_id: z.string().nullable(),
|
|
2857
|
+
payrolls_external_map_id: z.string(),
|
|
2858
|
+
user_id: z.string().nullable(),
|
|
2859
|
+
amount_cents: z.string(),
|
|
2860
|
+
contributor: z.enum(['employee', 'employer']),
|
|
2861
|
+
adjustable_amount_cents: z.string(),
|
|
2862
|
+
created_at: z.iso.datetime(),
|
|
2863
|
+
updated_at: z.iso.datetime()
|
|
2864
|
+
});
|
|
2755
2865
|
/**
|
|
2756
2866
|
* What a worker was actually paid for a pay period, derived from imported paystub line items — gross and net pay, employee deductions (taxes, insurance, savings, garnishments), and employer contributions. Read-only. Every amount is a decimal string of cents.
|
|
2757
2867
|
*/
|
|
@@ -6177,6 +6287,28 @@ export const zUpdateCheckPath = z.object({
|
|
|
6177
6287
|
* Success
|
|
6178
6288
|
*/
|
|
6179
6289
|
export const zUpdateCheckResponse = zComplianceCheckResponseObject;
|
|
6290
|
+
export const zListRequirementsQuery = z.object({
|
|
6291
|
+
'filter[search]': z.string().optional(),
|
|
6292
|
+
'filter[type]': z.string().optional(),
|
|
6293
|
+
'filter[category]': z.string().optional(),
|
|
6294
|
+
'filter[phase]': z.string().optional(),
|
|
6295
|
+
'filter[priority]': z.string().optional(),
|
|
6296
|
+
'filter[requisite]': z.string().optional(),
|
|
6297
|
+
'filter[target]': z.string().optional(),
|
|
6298
|
+
filter: z.string().optional(),
|
|
6299
|
+
'filter[unexpected]': z.string().optional(),
|
|
6300
|
+
'page[cursor]': z.string().optional(),
|
|
6301
|
+
'page[limit]': z.int().gte(1).optional().default(20),
|
|
6302
|
+
page: z.string().optional()
|
|
6303
|
+
});
|
|
6304
|
+
/**
|
|
6305
|
+
* Success
|
|
6306
|
+
*/
|
|
6307
|
+
export const zListRequirementsResponse = z.object({
|
|
6308
|
+
meta: zMeta,
|
|
6309
|
+
links: zLinks,
|
|
6310
|
+
data: z.array(zComplianceRequirementResponseObject)
|
|
6311
|
+
});
|
|
6180
6312
|
export const zListCustomFieldConfigsQuery = z.object({
|
|
6181
6313
|
'page[cursor]': z.string().optional(),
|
|
6182
6314
|
'page[limit]': z.int().gte(1).optional().default(20),
|
|
@@ -7299,6 +7431,25 @@ export const zListTemplatesResponse = z.object({
|
|
|
7299
7431
|
links: zLinks,
|
|
7300
7432
|
data: z.array(zJobTemplateResponseObject)
|
|
7301
7433
|
});
|
|
7434
|
+
export const zListAdjustableLineItemsPath = z.object({
|
|
7435
|
+
time_card_id: z.string()
|
|
7436
|
+
});
|
|
7437
|
+
export const zListAdjustableLineItemsQuery = z.object({
|
|
7438
|
+
'filter[payrolls_paystub_id]': z.string().optional(),
|
|
7439
|
+
'page[cursor]': z.string().optional(),
|
|
7440
|
+
'page[limit]': z.int().gte(1).optional().default(20),
|
|
7441
|
+
page: z.string().optional(),
|
|
7442
|
+
filter: z.string().optional(),
|
|
7443
|
+
'filter[unexpected]': z.string().optional()
|
|
7444
|
+
});
|
|
7445
|
+
/**
|
|
7446
|
+
* Success
|
|
7447
|
+
*/
|
|
7448
|
+
export const zListAdjustableLineItemsResponse = z.object({
|
|
7449
|
+
meta: zMeta,
|
|
7450
|
+
links: zLinks,
|
|
7451
|
+
data: z.array(zAdjustableLineItemResponseObject)
|
|
7452
|
+
});
|
|
7302
7453
|
export const zSetTimeCardLockBody = zTimeCardLockParameters;
|
|
7303
7454
|
export const zSetTimeCardLockPath = z.object({
|
|
7304
7455
|
time_card_id: z.string()
|
|
@@ -7373,6 +7524,22 @@ export const zListPriorPeriodAdjustmentsResponse = z.object({
|
|
|
7373
7524
|
links: zLinks,
|
|
7374
7525
|
data: z.array(zPriorPeriodAdjustmentResponseObject)
|
|
7375
7526
|
});
|
|
7527
|
+
export const zCreatePriorPeriodAdjustmentBody = zPriorPeriodAdjustmentParameters;
|
|
7528
|
+
export const zCreatePriorPeriodAdjustmentPath = z.object({
|
|
7529
|
+
time_card_id: z.string()
|
|
7530
|
+
});
|
|
7531
|
+
/**
|
|
7532
|
+
* Created
|
|
7533
|
+
*/
|
|
7534
|
+
export const zCreatePriorPeriodAdjustmentResponse = zPriorPeriodAdjustmentResponseObject;
|
|
7535
|
+
export const zDeletePriorPeriodAdjustmentPath = z.object({
|
|
7536
|
+
time_card_id: z.string(),
|
|
7537
|
+
id: z.string()
|
|
7538
|
+
});
|
|
7539
|
+
/**
|
|
7540
|
+
* Success
|
|
7541
|
+
*/
|
|
7542
|
+
export const zDeletePriorPeriodAdjustmentResponse = zPriorPeriodAdjustmentResponseObject;
|
|
7376
7543
|
export const zGetPriorPeriodAdjustmentPath = z.object({
|
|
7377
7544
|
time_card_id: z.string(),
|
|
7378
7545
|
id: z.string()
|
|
@@ -7381,6 +7548,25 @@ export const zGetPriorPeriodAdjustmentPath = z.object({
|
|
|
7381
7548
|
* Success
|
|
7382
7549
|
*/
|
|
7383
7550
|
export const zGetPriorPeriodAdjustmentResponse = zPriorPeriodAdjustmentResponseObject;
|
|
7551
|
+
export const zListPwaCompliancesPath = z.object({
|
|
7552
|
+
time_card_id: z.string()
|
|
7553
|
+
});
|
|
7554
|
+
export const zListPwaCompliancesQuery = z.object({
|
|
7555
|
+
'filter[job_id]': z.string().optional(),
|
|
7556
|
+
'page[cursor]': z.string().optional(),
|
|
7557
|
+
'page[limit]': z.int().gte(1).optional().default(20),
|
|
7558
|
+
page: z.string().optional(),
|
|
7559
|
+
filter: z.string().optional(),
|
|
7560
|
+
'filter[unexpected]': z.string().optional()
|
|
7561
|
+
});
|
|
7562
|
+
/**
|
|
7563
|
+
* Success
|
|
7564
|
+
*/
|
|
7565
|
+
export const zListPwaCompliancesResponse = z.object({
|
|
7566
|
+
meta: zMeta,
|
|
7567
|
+
links: zLinks,
|
|
7568
|
+
data: z.array(zPwaComplianceResponseObject)
|
|
7569
|
+
});
|
|
7384
7570
|
export const zCreateWorkerTimeCardApprovalBody = zWorkerTimeCardApprovalParameters;
|
|
7385
7571
|
export const zCreateWorkerTimeCardApprovalPath = z.object({
|
|
7386
7572
|
time_card_id: z.string()
|