@gusto/embedded-react-sdk 0.0.6 → 0.1.1
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/dist/{B4MFY5CR-DoQFjw0x.js → B4MFY5CR-DbAkgRf2.js} +2 -2
- package/dist/{B4MFY5CR-DoQFjw0x.js.map → B4MFY5CR-DbAkgRf2.js.map} +1 -1
- package/dist/{Employee.Compensation-D5dhIZgh.js → Employee.Compensation-OoWTM-1y.js} +15 -11
- package/dist/Employee.Compensation-OoWTM-1y.js.map +1 -0
- package/dist/Employee.DocumentSigner-D8JKEl0C.js +42 -0
- package/dist/Employee.DocumentSigner-D8JKEl0C.js.map +1 -0
- package/dist/{Employee.Profile-DTBA-TQA.js → Employee.Profile-u_Zt7QkR.js} +15 -14
- package/dist/Employee.Profile-u_Zt7QkR.js.map +1 -0
- package/dist/{HO4MOOFI-ObmoeQ5Y.js → HO4MOOFI-DC9xJXAO.js} +3 -3
- package/dist/{HO4MOOFI-ObmoeQ5Y.js.map → HO4MOOFI-DC9xJXAO.js.map} +1 -1
- package/dist/{HUY7CZI3-DEEhMfZT.js → HUY7CZI3-_EKhPi75.js} +3 -3
- package/dist/{HUY7CZI3-DEEhMfZT.js.map → HUY7CZI3-_EKhPi75.js.map} +1 -1
- package/dist/{index-DZ5zT4yt.js → index-DifV7WRe.js} +10575 -9653
- package/dist/index-DifV7WRe.js.map +1 -0
- package/dist/index.d.ts +1441 -244
- package/dist/index.js +81 -68
- package/dist/style.css +1 -1
- package/package.json +6 -2
- package/dist/Employee.Compensation-D5dhIZgh.js.map +0 -1
- package/dist/Employee.Profile-DTBA-TQA.js.map +0 -1
- package/dist/index-DZ5zT4yt.js.map +0 -1
package/dist/index.d.ts
CHANGED
|
@@ -6,6 +6,8 @@ import { FetchOptions } from 'openapi-fetch';
|
|
|
6
6
|
import { FetchResponse } from 'openapi-fetch';
|
|
7
7
|
import { i18n } from 'i18next';
|
|
8
8
|
import { JSX as JSX_2 } from 'react/jsx-runtime';
|
|
9
|
+
import { QueryClient } from '@tanstack/react-query';
|
|
10
|
+
import { ReactElement } from 'react';
|
|
9
11
|
import { ReactNode } from 'react';
|
|
10
12
|
import { useMutation } from '@tanstack/react-query';
|
|
11
13
|
import { UseMutationResult } from '@tanstack/react-query';
|
|
@@ -95,7 +97,8 @@ declare interface CommonComponentInterface {
|
|
|
95
97
|
|
|
96
98
|
declare namespace Company {
|
|
97
99
|
export {
|
|
98
|
-
|
|
100
|
+
OnboardingSummary_3 as OnboardingSummary,
|
|
101
|
+
OnboardingSummaryContextual_2 as OnboardingSummaryContextual
|
|
99
102
|
}
|
|
100
103
|
}
|
|
101
104
|
export { Company }
|
|
@@ -132,12 +135,12 @@ declare type CompensationOutputs = v.InferOutput<typeof CompensationSchema>;
|
|
|
132
135
|
|
|
133
136
|
declare interface CompensationProps extends CommonComponentInterface {
|
|
134
137
|
employeeId: string;
|
|
138
|
+
startDate: string;
|
|
135
139
|
defaultValues?: Pick<Schemas['Job'], 'rate' | 'title' | 'payment_unit'>;
|
|
136
140
|
}
|
|
137
141
|
|
|
138
142
|
declare const CompensationSchema: v.IntersectSchema<[v.ObjectSchema<{
|
|
139
143
|
readonly job_title: v.SchemaWithPipe<[v.StringSchema<undefined>, v.NonEmptyAction<string, undefined>]>;
|
|
140
|
-
readonly rate: v.SchemaWithPipe<[v.NumberSchema<undefined>, v.MinValueAction<number, 1, undefined>, v.TransformAction<any, string>]>;
|
|
141
144
|
}, undefined>, v.VariantSchema<"flsa_status", [v.SchemaWithPipe<[v.ObjectSchema<{
|
|
142
145
|
readonly flsa_status: v.UnionSchema<[v.LiteralSchema<"Exempt", undefined>, v.LiteralSchema<"Salaried Nonexempt", undefined>, v.LiteralSchema<"Nonexempt", undefined>], undefined>;
|
|
143
146
|
readonly payment_unit: v.UnionSchema<[v.LiteralSchema<"Hour", undefined>, v.LiteralSchema<"Week", undefined>, v.LiteralSchema<"Month", undefined>, v.LiteralSchema<"Year", undefined>], undefined>;
|
|
@@ -157,12 +160,14 @@ declare const CompensationSchema: v.IntersectSchema<[v.ObjectSchema<{
|
|
|
157
160
|
}>>]>, v.ObjectSchema<{
|
|
158
161
|
readonly flsa_status: v.LiteralSchema<"Owner", undefined>;
|
|
159
162
|
readonly payment_unit: v.LiteralSchema<"Paycheck", undefined>;
|
|
163
|
+
readonly rate: v.SchemaWithPipe<[v.NumberSchema<undefined>, v.MinValueAction<number, 1, undefined>, v.TransformAction<any, string>]>;
|
|
160
164
|
}, undefined>, v.ObjectSchema<{
|
|
161
165
|
readonly flsa_status: v.UnionSchema<[v.LiteralSchema<"Commission Only Exempt", undefined>, v.LiteralSchema<"Commission Only Nonexempt", undefined>], undefined>;
|
|
162
166
|
readonly payment_unit: v.LiteralSchema<"Year", undefined>;
|
|
167
|
+
readonly rate: v.SchemaWithPipe<[v.LiteralSchema<0, undefined>, v.TransformAction<any, string>]>;
|
|
163
168
|
}, undefined>], undefined>], undefined>;
|
|
164
169
|
|
|
165
|
-
declare const componentEvents: {
|
|
170
|
+
export declare const componentEvents: {
|
|
166
171
|
readonly COMPANY_ADDRESSES: "company/addresses";
|
|
167
172
|
readonly COMPANY_ADDRESSE_EDIT: "company/address/edit";
|
|
168
173
|
readonly COMPANY_INDUSTRY: "company/industry";
|
|
@@ -203,9 +208,13 @@ declare const componentEvents: {
|
|
|
203
208
|
readonly EMPLOYEE_SPLIT_PAYCHECK: "employee/bankAccount/split";
|
|
204
209
|
readonly EMPLOYEE_JOB_CREATED: "employee/job/created";
|
|
205
210
|
readonly EMPLOYEE_JOB_UPDATED: "employee/job/updated";
|
|
211
|
+
readonly EMPLOYEE_JOB_DELETED: "employee/job/deleted";
|
|
206
212
|
readonly EMPLOYEE_SUMMARY_VIEW: "employee/summary";
|
|
207
213
|
readonly EMPLOYEES_LIST: "company/employees";
|
|
208
214
|
readonly EMPLOYEE_SELF_ONBOARDING_START: "employee/selfOnboarding/start";
|
|
215
|
+
readonly EMPLOYEE_VIEW_FORM_TO_SIGN: "employee/forms/view";
|
|
216
|
+
readonly EMPLOYEE_SIGN_FORM: "employee/forms/sign";
|
|
217
|
+
readonly EMPLOYEE_FORMS_DONE: "employee/forms/done";
|
|
209
218
|
readonly SUCCESS: "SUCCESS";
|
|
210
219
|
readonly ERROR: "ERROR";
|
|
211
220
|
readonly CANCEL: "CANCEL";
|
|
@@ -340,7 +349,7 @@ declare interface components {
|
|
|
340
349
|
/** @description The UUID of the company the employee is employed by. */
|
|
341
350
|
readonly company_uuid?: string;
|
|
342
351
|
/** @description The UUID of the employee's manager. */
|
|
343
|
-
readonly manager_uuid?: string;
|
|
352
|
+
readonly manager_uuid?: string | null;
|
|
344
353
|
/** @description The current version of the employee. See the [versioning guide](https://docs.gusto.com/embedded-payroll/docs/idempotency) for information on how to use this field. */
|
|
345
354
|
readonly version?: string;
|
|
346
355
|
/** @description The employee's department in the company. */
|
|
@@ -348,7 +357,7 @@ declare interface components {
|
|
|
348
357
|
/** @description Whether the employee is terminated. */
|
|
349
358
|
readonly terminated?: boolean;
|
|
350
359
|
/** @description Whether the employee is a two percent shareholder of the company. This field only applies to companies with an S-Corp entity type. */
|
|
351
|
-
two_percent_shareholder?: boolean;
|
|
360
|
+
two_percent_shareholder?: boolean | null;
|
|
352
361
|
/** @description Whether the employee has completed onboarding. */
|
|
353
362
|
readonly onboarded?: boolean;
|
|
354
363
|
/**
|
|
@@ -367,8 +376,8 @@ declare interface components {
|
|
|
367
376
|
has_ssn?: boolean;
|
|
368
377
|
/** @description Deprecated. This field always returns an empty string. */
|
|
369
378
|
ssn?: string;
|
|
370
|
-
phone?: string;
|
|
371
|
-
preferred_first_name?: string;
|
|
379
|
+
phone?: string | null;
|
|
380
|
+
preferred_first_name?: string | null;
|
|
372
381
|
/**
|
|
373
382
|
* @description The employee's payment method
|
|
374
383
|
* @default Check
|
|
@@ -481,6 +490,54 @@ declare interface components {
|
|
|
481
490
|
/** @description Whether the accrual balance is paid to the employee upon termination. */
|
|
482
491
|
readonly paid_at_termination?: boolean;
|
|
483
492
|
};
|
|
493
|
+
/** @description Child Support agency data */
|
|
494
|
+
"Child-Support-Data": {
|
|
495
|
+
/** @description State child support agencies */
|
|
496
|
+
agencies?: {
|
|
497
|
+
/** @description Two letter state abbreviation */
|
|
498
|
+
state?: string;
|
|
499
|
+
/** @description Name of state child support agency */
|
|
500
|
+
name?: string;
|
|
501
|
+
/** @description Specifies if remitting payment to the agency is required outside of Gusto. If true, Gusto includes garnishment amounts for this agency in payroll calculation, but does not debit for or remit payment to the agency automatically. As of September 2024, only garnishments for South Carolina Integrated Child Support Services require manual payment.
|
|
502
|
+
* */
|
|
503
|
+
manual_payment_required?: boolean;
|
|
504
|
+
/** @description FIPS codes for state or county child support orders */
|
|
505
|
+
fips_codes?: {
|
|
506
|
+
/** @description FIPS code for state or county */
|
|
507
|
+
code?: string;
|
|
508
|
+
/** @description Name of county in the state for the corresponding FIPS code. When `null` the FIPS code applies state wide. */
|
|
509
|
+
county?: string | null;
|
|
510
|
+
}[];
|
|
511
|
+
/** @description Describes which child support case identifying attributes are required for this agency. While most agencies only require a single identifier, some (e.g. OH) require multiple identifiers. */
|
|
512
|
+
required_attributes?: {
|
|
513
|
+
/**
|
|
514
|
+
* @description A required attribute when creating a garnishment for this state agency. The current values are listed as an enum; though unlikely, values could be added if state agency requirements change in the future.
|
|
515
|
+
* @enum {string}
|
|
516
|
+
*/
|
|
517
|
+
key?: "case_number" | "order_number" | "remittance_number";
|
|
518
|
+
/** @description A human readable name of the attribute, e.g. CSE Case Number */
|
|
519
|
+
label?: string;
|
|
520
|
+
}[];
|
|
521
|
+
}[];
|
|
522
|
+
};
|
|
523
|
+
/** @description Additional child support order details */
|
|
524
|
+
"Garnishment-Child-Support": {
|
|
525
|
+
/** @description The two letter state abbreviation for the state issuing the child support order. Agency data is available in the `GET /v1/garnishments/child_support` API. */
|
|
526
|
+
state?: string;
|
|
527
|
+
/**
|
|
528
|
+
* @description How often the agency collects the withholding amount. e.g. $500 monthly -> `Monthly`.
|
|
529
|
+
* @enum {string}
|
|
530
|
+
*/
|
|
531
|
+
payment_period?: "Every week" | "Every other week" | "Twice per month" | "Monthly";
|
|
532
|
+
/** @description The FIPS code associated with the state or county agency issuing the child support order. Agency data is available in the `GET /v1/garnishments/child_support` API. */
|
|
533
|
+
readonly fips_code?: string;
|
|
534
|
+
/** @description Child Support Enforcement Case Number associated with this child support obligation - required for most states. Agency specific requirements are available in the `GET /v1/garnishments/child_support` API. */
|
|
535
|
+
case_number?: string | null;
|
|
536
|
+
/** @description Order Identifier or Order ID associated with this child support obligation - required for some states. Agency specific requirements are available in the `GET /v1/garnishments/child_support` API. */
|
|
537
|
+
order_number?: string | null;
|
|
538
|
+
/** @description Child Support Enforcement Remittance ID associated with this child support obligation - required for some states. Agency specific requirements are available in the `GET /v1/garnishments/child_support` API. */
|
|
539
|
+
remittance_number?: string | null;
|
|
540
|
+
} | null;
|
|
484
541
|
/** @description Garnishments, or employee deductions, are fixed amounts or percentages deducted from an employee’s pay. They can be deducted a specific number of times or on a recurring basis. Garnishments can also have maximum deductions on a yearly or per-pay-period bases. Common uses for garnishments are court-ordered payments for child support or back taxes. Some companies provide loans to their employees that are repaid via garnishments. */
|
|
485
542
|
Garnishment: {
|
|
486
543
|
/** @description The UUID of the garnishment in Gusto. */
|
|
@@ -530,6 +587,12 @@ declare interface components {
|
|
|
530
587
|
* @default false
|
|
531
588
|
*/
|
|
532
589
|
deduct_as_percentage: boolean;
|
|
590
|
+
/**
|
|
591
|
+
* @description The specific type of garnishment for court ordered garnishments.
|
|
592
|
+
* @enum {string|null}
|
|
593
|
+
*/
|
|
594
|
+
garnishment_type?: "child_support" | "federal_tax_lien" | "state_tax_lien" | "student_loan" | "creditor_garnishment" | "federal_loan" | "other_garnishment" | null;
|
|
595
|
+
child_support?: components["schemas"]["Garnishment-Child-Support"];
|
|
533
596
|
};
|
|
534
597
|
/** @description The representation of a termination in Gusto. */
|
|
535
598
|
Termination: {
|
|
@@ -563,18 +626,59 @@ declare interface components {
|
|
|
563
626
|
/** @description Whether the employee is a two percent shareholder of the company. This field only applies to companies with an S-Corp entity type. */
|
|
564
627
|
two_percent_shareholder?: boolean;
|
|
565
628
|
};
|
|
629
|
+
"Historical-Employee-Body": {
|
|
630
|
+
first_name: string;
|
|
631
|
+
middle_initial?: string;
|
|
632
|
+
last_name: string;
|
|
633
|
+
preferred_first_name?: string;
|
|
634
|
+
date_of_birth: string;
|
|
635
|
+
ssn: string;
|
|
636
|
+
work_address: {
|
|
637
|
+
/** @description Reference to a company location */
|
|
638
|
+
location_uuid?: string;
|
|
639
|
+
};
|
|
640
|
+
home_address: {
|
|
641
|
+
street_1?: string;
|
|
642
|
+
street_2?: string | null;
|
|
643
|
+
city?: string;
|
|
644
|
+
state?: string;
|
|
645
|
+
zip?: string;
|
|
646
|
+
};
|
|
647
|
+
termination: {
|
|
648
|
+
/**
|
|
649
|
+
* Format: date
|
|
650
|
+
* @description Date the employee was terminated from the company
|
|
651
|
+
*/
|
|
652
|
+
effective_date?: string;
|
|
653
|
+
};
|
|
654
|
+
job: {
|
|
655
|
+
/**
|
|
656
|
+
* Format: date
|
|
657
|
+
* @description The date when the employee was hired to the company
|
|
658
|
+
*/
|
|
659
|
+
hire_date?: string;
|
|
660
|
+
};
|
|
661
|
+
employee_state_taxes?: {
|
|
662
|
+
/** @description Whether this job is eligible for workers' compensation coverage in the states of Washington (WA) or Wyoming (WY). */
|
|
663
|
+
wc_covered?: boolean;
|
|
664
|
+
/** @description The risk class code for workers' compensation in Washington or Wyoming state. For Washington, visit [Washington state's Risk Class page](https://www.lni.wa.gov/insurance/rates-risk-classes/risk-classes-for-workers-compensation/risk-class-lookup#/) to learn more. For Wyoming you can search for the code online using [WY Workforce Services website](https://dws.wyo.gov/dws-division/workers-compensation/) or call the agency at (307) 235-3217. */
|
|
665
|
+
wc_class_code?: string;
|
|
666
|
+
};
|
|
667
|
+
};
|
|
566
668
|
"Pay-Schedule-Assignment-Body": {
|
|
567
669
|
/**
|
|
568
670
|
* @description The pay schedule assignment type.
|
|
569
|
-
* @enum {string}
|
|
671
|
+
* @enum {string|null}
|
|
570
672
|
*/
|
|
571
|
-
type: "single" | "hourly_salaried" | "by_employee" | "by_department";
|
|
673
|
+
type: "single" | "hourly_salaried" | "by_employee" | "by_department" | null;
|
|
572
674
|
/** @description Pay schedule for hourly employees. */
|
|
573
675
|
hourly_pay_schedule_uuid?: string;
|
|
574
676
|
/** @description Pay schedule for salaried employees. */
|
|
575
677
|
salaried_pay_schedule_uuid?: string;
|
|
576
678
|
/** @description Default pay schedule for employees. */
|
|
577
679
|
default_pay_schedule_uuid?: string;
|
|
680
|
+
/** @description Indicates whether the request provides pay schedule assignments for a partial list of employees or departments of the company. By default, this is set to false. */
|
|
681
|
+
partial_assignment?: boolean;
|
|
578
682
|
/** @description List of employees and their pay schedules. */
|
|
579
683
|
employees?: {
|
|
580
684
|
/** @description Employee UUID */
|
|
@@ -663,6 +767,97 @@ declare interface components {
|
|
|
663
767
|
/** @description the URL of the form */
|
|
664
768
|
document_url?: string;
|
|
665
769
|
};
|
|
770
|
+
/** Document */
|
|
771
|
+
Document: {
|
|
772
|
+
/** @description The UUID of the document */
|
|
773
|
+
readonly uuid?: string;
|
|
774
|
+
/** @description The title of the document */
|
|
775
|
+
readonly title?: string;
|
|
776
|
+
/** @description The type identifier of the document */
|
|
777
|
+
readonly name?: string;
|
|
778
|
+
/**
|
|
779
|
+
* @description The type of recipient associated with the document (will be `Contractor` for Contractor Documents)
|
|
780
|
+
* @enum {string}
|
|
781
|
+
*/
|
|
782
|
+
readonly recipient_type?: "Company" | "Employee" | "Contractor";
|
|
783
|
+
/** @description Unique identifier for the recipient associated with the document */
|
|
784
|
+
readonly recipient_uuid?: string;
|
|
785
|
+
/** @description List of the document's pages and associated image URLs. This is only returned for documents with `required_signing` = `true`, and can be used for signing preparation. */
|
|
786
|
+
readonly pages?: {
|
|
787
|
+
/** @description Image URL for the page */
|
|
788
|
+
image_url?: string;
|
|
789
|
+
/** @description Page number */
|
|
790
|
+
page_number?: number;
|
|
791
|
+
}[];
|
|
792
|
+
/** @description List of the document's fields and associated data. Values are set for auto-filled fields. This is only returned for documents with `required_signing` = `true`, and can be used for signing preparation. */
|
|
793
|
+
readonly fields?: {
|
|
794
|
+
/** @description Unique identifier of the field */
|
|
795
|
+
key?: string;
|
|
796
|
+
/** @description Auto-filled value of the field */
|
|
797
|
+
value?: string | null;
|
|
798
|
+
/** @description X-coordinate location of the field on the page */
|
|
799
|
+
x?: number;
|
|
800
|
+
/** @description Y-coordinate location of the field on the page */
|
|
801
|
+
y?: number;
|
|
802
|
+
/** @description Width of the field */
|
|
803
|
+
width?: number;
|
|
804
|
+
/** @description Height of the field */
|
|
805
|
+
height?: number;
|
|
806
|
+
/** @description Page number of the field */
|
|
807
|
+
page_number?: number;
|
|
808
|
+
/** @description The field's data type */
|
|
809
|
+
data_type?: string;
|
|
810
|
+
/** @description Whether the field is required */
|
|
811
|
+
required?: boolean;
|
|
812
|
+
}[];
|
|
813
|
+
/** @description When the document was signed (will be `null` if unsigned) */
|
|
814
|
+
readonly signed_at?: string | null;
|
|
815
|
+
/** @description The description of the document */
|
|
816
|
+
readonly description?: string;
|
|
817
|
+
/** @description A boolean flag that indicates whether the document needs signing or not. Note that this value will change after the document is signed. */
|
|
818
|
+
requires_signing?: boolean;
|
|
819
|
+
/** @description If the document is in a draft state */
|
|
820
|
+
readonly draft?: boolean;
|
|
821
|
+
/** @description The year of this document. This value is nullable and will not be present on all documents. */
|
|
822
|
+
readonly year?: number | null;
|
|
823
|
+
/** @description The quarter of this document. This value is nullable and will not be present on all documents. */
|
|
824
|
+
readonly quarter?: number | null;
|
|
825
|
+
};
|
|
826
|
+
/** Document Signed */
|
|
827
|
+
"Document-Signed": {
|
|
828
|
+
/** @description The UUID of the document */
|
|
829
|
+
readonly uuid?: string;
|
|
830
|
+
/** @description The title of the document */
|
|
831
|
+
readonly title?: string;
|
|
832
|
+
/** @description The type identifier of the document */
|
|
833
|
+
readonly name?: string;
|
|
834
|
+
/**
|
|
835
|
+
* @description The type of recipient associated with the document (will be `Contractor` for Contractor Documents)
|
|
836
|
+
* @enum {string}
|
|
837
|
+
*/
|
|
838
|
+
readonly recipient_type?: "Company" | "Employee" | "Contractor";
|
|
839
|
+
/** @description Unique identifier for the recipient associated with the document */
|
|
840
|
+
readonly recipient_uuid?: string;
|
|
841
|
+
/** @description When the document was signed (will be `null` if unsigned) */
|
|
842
|
+
readonly signed_at?: string | null;
|
|
843
|
+
/** @description The description of the document */
|
|
844
|
+
readonly description?: string;
|
|
845
|
+
/** @description A boolean flag that indicates whether the document needs signing or not. Note that this value will change after the document is signed. */
|
|
846
|
+
requires_signing?: boolean;
|
|
847
|
+
/** @description If the document is in a draft state */
|
|
848
|
+
readonly draft?: boolean;
|
|
849
|
+
/** @description The year of this document. This value is nullable and will not be present on all documents. */
|
|
850
|
+
readonly year?: number | null;
|
|
851
|
+
/** @description The quarter of this document. This value is nullable and will not be present on all documents. */
|
|
852
|
+
readonly quarter?: number | null;
|
|
853
|
+
};
|
|
854
|
+
/** Document Pdf */
|
|
855
|
+
"Document-Pdf": {
|
|
856
|
+
/** @description the UUID of the document */
|
|
857
|
+
readonly uuid?: string;
|
|
858
|
+
/** @description the URL of the document */
|
|
859
|
+
document_url?: string;
|
|
860
|
+
};
|
|
666
861
|
/** Industry */
|
|
667
862
|
Industry: {
|
|
668
863
|
/** @description Company uuid */
|
|
@@ -788,7 +983,7 @@ declare interface components {
|
|
|
788
983
|
* @description The status of the webhook subscription.
|
|
789
984
|
* @enum {string}
|
|
790
985
|
*/
|
|
791
|
-
readonly status?: "pending" | "verified" | "removed";
|
|
986
|
+
readonly status?: "pending" | "verified" | "removed" | "unreachable";
|
|
792
987
|
/** @description Receive updates for these types. */
|
|
793
988
|
subscription_types?: ("BankAccount" | "Company" | "CompanyBenefit" | "Contractor" | "ContractorPayment" | "Employee" | "EmployeeBenefit" | "EmployeeJobCompensation" | "ExternalPayroll" | "Form" | "Location" | "Notification" | "Payroll" | "PaySchedule" | "Signatory")[];
|
|
794
989
|
};
|
|
@@ -866,6 +1061,8 @@ declare interface components {
|
|
|
866
1061
|
* @enum {string}
|
|
867
1062
|
*/
|
|
868
1063
|
readonly entity_type?: "C-Corporation" | "S-Corporation" | "Sole proprietor" | "LLC" | "LLP" | "Limited partnership" | "Co-ownership" | "Association" | "Trusteeship" | "General partnership" | "Joint venture" | "Non-Profit";
|
|
1064
|
+
/** @description Whether the company only supports contractors. */
|
|
1065
|
+
contractor_only?: boolean;
|
|
869
1066
|
/**
|
|
870
1067
|
* @description The Gusto product tier of the company (not applicable to Embedded partner managed companies).
|
|
871
1068
|
* @enum {string|null}
|
|
@@ -890,9 +1087,9 @@ declare interface components {
|
|
|
890
1087
|
readonly is_partner_managed?: boolean;
|
|
891
1088
|
/**
|
|
892
1089
|
* @description The pay schedule assignment type.
|
|
893
|
-
* @enum {string}
|
|
1090
|
+
* @enum {string|null}
|
|
894
1091
|
*/
|
|
895
|
-
readonly pay_schedule_type?: "single" | "hourly_salaried" | "by_employee" | "by_department";
|
|
1092
|
+
readonly pay_schedule_type?: "single" | "hourly_salaried" | "by_employee" | "by_department" | null;
|
|
896
1093
|
/** @description Company's first invoiceable event date */
|
|
897
1094
|
readonly join_date?: string;
|
|
898
1095
|
/**
|
|
@@ -1121,7 +1318,7 @@ declare interface components {
|
|
|
1121
1318
|
* @description One of the "onboarding_status" enum values.
|
|
1122
1319
|
* @enum {string}
|
|
1123
1320
|
*/
|
|
1124
|
-
onboarding_status?: "
|
|
1321
|
+
onboarding_status?: "admin_onboarding_incomplete" | "admin_onboarding_review" | "self_onboarding_not_invited" | "self_onboarding_invited" | "self_onboarding_started" | "self_onboarding_review" | "onboarding_completed";
|
|
1125
1322
|
};
|
|
1126
1323
|
/**
|
|
1127
1324
|
* Contractor-Onboarding-Status
|
|
@@ -1402,10 +1599,22 @@ declare interface components {
|
|
|
1402
1599
|
* This may happen when the body of your request contains errors such as `invalid_attribute_value`, or the request fails due to an `invalid_operation`. See the [Errors Categories](https://docs.gusto.com/embedded-payroll/docs/error-categories) guide for more details.
|
|
1403
1600
|
* */
|
|
1404
1601
|
"Unprocessable-Entity-Error-Object": {
|
|
1602
|
+
errors?: components["schemas"]["Entity-Error-Object"][];
|
|
1603
|
+
};
|
|
1604
|
+
"Entity-Error-Object": {
|
|
1605
|
+
/** @description Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error. */
|
|
1606
|
+
error_key?: string;
|
|
1607
|
+
/** @description Specifies the type of error. The category provides error groupings and can be used to build custom error handling in your integration. If category is `nested_errors`, the object will contain a nested `errors` property with entity errors. */
|
|
1608
|
+
category?: string;
|
|
1609
|
+
/** @description Provides details about the error - generally this message can be surfaced to an end user. */
|
|
1610
|
+
message?: string;
|
|
1611
|
+
/** @description Contains relevant data to identify the resource in question when applicable. For example, to identify an entity `entity_type` and `entity_uuid` will be provided. */
|
|
1612
|
+
metadata?: Record<string, never>;
|
|
1613
|
+
/** @description Will only exist if category is `nested_errors`. It is possible to have multiple levels of nested errors. */
|
|
1405
1614
|
errors?: {
|
|
1406
1615
|
/** @description Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error. */
|
|
1407
1616
|
error_key?: string;
|
|
1408
|
-
/** @description Specifies the type of error. The category provides error groupings and can be used to build custom error handling in your integration. */
|
|
1617
|
+
/** @description Specifies the type of error. The category provides error groupings and can be used to build custom error handling in your integration. If category is `nested_errors`, the object will contain a nested `errors` property with entity errors. */
|
|
1409
1618
|
category?: string;
|
|
1410
1619
|
/** @description Provides details about the error - generally this message can be surfaced to an end user. */
|
|
1411
1620
|
message?: string;
|
|
@@ -1479,6 +1688,20 @@ declare interface components {
|
|
|
1479
1688
|
/** @description Whether this pay schedule is associated with any employees. A pay schedule is inactive when it's unassigned. */
|
|
1480
1689
|
readonly active?: boolean;
|
|
1481
1690
|
};
|
|
1691
|
+
/** @description The company attachment */
|
|
1692
|
+
"Company-Attachment": {
|
|
1693
|
+
/** @description UUID of the company attachment */
|
|
1694
|
+
uuid?: string;
|
|
1695
|
+
/** @description name of the file uploaded */
|
|
1696
|
+
name?: string;
|
|
1697
|
+
/**
|
|
1698
|
+
* @description The category of the company attachment
|
|
1699
|
+
* @enum {string}
|
|
1700
|
+
*/
|
|
1701
|
+
category?: "gep_notice" | "compliance";
|
|
1702
|
+
/** @description The ISO 8601 timestamp of when an attachment was uploaded */
|
|
1703
|
+
upload_time?: string;
|
|
1704
|
+
};
|
|
1482
1705
|
/** @description The company bank account */
|
|
1483
1706
|
"Company-Bank-Account": {
|
|
1484
1707
|
/** @description UUID of the bank account */
|
|
@@ -1604,34 +1827,44 @@ declare interface components {
|
|
|
1604
1827
|
end_date?: string;
|
|
1605
1828
|
/** @description Description of the benefit. */
|
|
1606
1829
|
description?: string;
|
|
1607
|
-
/** @description The aggregate of employee deduction for all employees given the period of time and benefit
|
|
1830
|
+
/** @description The aggregate of employee deduction for all employees given the period of time and the specific company benefit. */
|
|
1608
1831
|
company_benefit_deduction?: string;
|
|
1609
|
-
/** @description The aggregate of company contribution for all employees given the period of time and benefit
|
|
1832
|
+
/** @description The aggregate of company contribution for all employees given the period of time and the specific company benefit. */
|
|
1610
1833
|
company_benefit_contribution?: string;
|
|
1611
1834
|
employees?: {
|
|
1612
1835
|
/** @description The UUID of the employee */
|
|
1613
1836
|
uuid?: string;
|
|
1614
|
-
/** @description The
|
|
1837
|
+
/** @description The sum of employee deduction for this employee given the period of time and the specific company benefit. */
|
|
1615
1838
|
company_benefit_deduction?: string;
|
|
1616
|
-
/** @description The
|
|
1839
|
+
/** @description The sum of company contribution for this employee given the period of time and the specific company benefit. */
|
|
1617
1840
|
company_benefit_contribution?: string;
|
|
1618
|
-
/** @description
|
|
1841
|
+
/** @description The sum of employee benefit deduction for this employee given the period of time and the benefit type. */
|
|
1619
1842
|
benefit_deduction?: string;
|
|
1620
|
-
/** @description
|
|
1843
|
+
/** @description The sum of company contribution for this employee given the period of time and the benefit type. */
|
|
1621
1844
|
benefit_contribution?: string;
|
|
1622
|
-
/** @description Gross pay
|
|
1845
|
+
/** @description Gross pay for this employee given the period of time. */
|
|
1623
1846
|
gross_pay?: string;
|
|
1847
|
+
/** @description Total imputed pay for this employee given the period of time (not scoped to a benefit type). */
|
|
1848
|
+
imputed_pay?: string;
|
|
1624
1849
|
payroll_benefits?: {
|
|
1625
1850
|
payroll_uuid?: string;
|
|
1626
1851
|
/** @description Whether it is regular or bonus payroll */
|
|
1627
1852
|
payroll_type?: string;
|
|
1853
|
+
/** @description Check date of this payroll. */
|
|
1628
1854
|
check_date?: string;
|
|
1855
|
+
/** @description Gross pay for this employee on the payroll. */
|
|
1629
1856
|
gross_pay?: string;
|
|
1857
|
+
/** @description Total imputed pay for this employee on the payroll. */
|
|
1858
|
+
imputed_pay?: string;
|
|
1859
|
+
/** @description The employee benefit deduction amount for this employee on the payroll. */
|
|
1630
1860
|
company_benefit_deduction?: string;
|
|
1861
|
+
/** @description The company contribution amount for this employee on the payroll. */
|
|
1631
1862
|
company_benefit_contribution?: string;
|
|
1632
1863
|
pay_period?: {
|
|
1633
|
-
|
|
1634
|
-
|
|
1864
|
+
/** @description The beginning of the payroll's pay period. */
|
|
1865
|
+
start_date?: string | null;
|
|
1866
|
+
/** @description The end of the payroll's pay period. */
|
|
1867
|
+
end_date?: string | null;
|
|
1635
1868
|
};
|
|
1636
1869
|
};
|
|
1637
1870
|
};
|
|
@@ -1671,7 +1904,7 @@ declare interface components {
|
|
|
1671
1904
|
* @default true
|
|
1672
1905
|
*/
|
|
1673
1906
|
active: boolean;
|
|
1674
|
-
/** @description The description of the company benefit.For example, a company may offer multiple benefits with an ID of 1 (for Medical Insurance). The description would show something more specific like “Kaiser Permanente” or “Blue Cross/ Blue Shield”. */
|
|
1907
|
+
/** @description The description of the company benefit. For example, a company may offer multiple benefits with an ID of 1 (for Medical Insurance). The description would show something more specific like “Kaiser Permanente” or “Blue Cross/ Blue Shield”. */
|
|
1675
1908
|
description?: string;
|
|
1676
1909
|
/** @description Whether this company benefit can be deleted. Deletable will be set to true if the benefit has not been used in payroll, has no employee benefits associated, and the benefit is not owned by Gusto or a Partner */
|
|
1677
1910
|
deletable?: boolean;
|
|
@@ -1747,7 +1980,7 @@ declare interface components {
|
|
|
1747
1980
|
* @default true
|
|
1748
1981
|
*/
|
|
1749
1982
|
active: boolean;
|
|
1750
|
-
/** @description The description of the company benefit.For example, a company may offer multiple benefits with an ID of 1 (for Medical Insurance). The description would show something more specific like “Kaiser Permanente” or “Blue Cross/ Blue Shield”. */
|
|
1983
|
+
/** @description The description of the company benefit. For example, a company may offer multiple benefits with an ID of 1 (for Medical Insurance). The description would show something more specific like “Kaiser Permanente” or “Blue Cross/ Blue Shield”. */
|
|
1751
1984
|
description?: string;
|
|
1752
1985
|
/** @description Whether this company benefit can be deleted. Deletable will be set to true if the benefit has not been used in payroll, has no employee benefits associated, and the benefit is not owned by Gusto or a Partner */
|
|
1753
1986
|
deletable?: boolean;
|
|
@@ -1764,21 +1997,14 @@ declare interface components {
|
|
|
1764
1997
|
/** @description The ID of the earning type. */
|
|
1765
1998
|
readonly uuid: string;
|
|
1766
1999
|
};
|
|
1767
|
-
|
|
1768
|
-
"Employee-Benefit": {
|
|
2000
|
+
"Employee-Benefit-Base-Object": {
|
|
1769
2001
|
/** @description The current version of the object. See the [versioning guide](https://docs.gusto.com/embedded-payroll/docs/idempotency) for information on how to use this field. */
|
|
1770
2002
|
version?: string;
|
|
1771
|
-
/** @description The UUID of the employee to which the benefit belongs. */
|
|
1772
|
-
readonly employee_uuid?: string;
|
|
1773
|
-
/** @description The UUID of the company benefit. */
|
|
1774
|
-
readonly company_benefit_uuid?: string;
|
|
1775
2003
|
/**
|
|
1776
2004
|
* @description Whether the employee benefit is active.
|
|
1777
2005
|
* @default true
|
|
1778
2006
|
*/
|
|
1779
2007
|
active: boolean;
|
|
1780
|
-
/** @description The UUID of the employee benefit. */
|
|
1781
|
-
readonly uuid: string;
|
|
1782
2008
|
/**
|
|
1783
2009
|
* @description The amount to be deducted, per pay period, from the employee's pay.
|
|
1784
2010
|
* @default 0.00
|
|
@@ -1861,6 +2087,24 @@ declare interface components {
|
|
|
1861
2087
|
*/
|
|
1862
2088
|
contribute_as_percentage: boolean;
|
|
1863
2089
|
};
|
|
2090
|
+
/** @description The representation of an employee benefit. */
|
|
2091
|
+
"Employee-Benefit": components["schemas"]["Employee-Benefit-Base-Object"] & {
|
|
2092
|
+
/** @description The UUID of the employee to which the benefit belongs. */
|
|
2093
|
+
readonly employee_uuid?: string;
|
|
2094
|
+
/** @description The UUID of the company benefit. */
|
|
2095
|
+
readonly company_benefit_uuid?: string;
|
|
2096
|
+
/** @description The UUID of the employee benefit. */
|
|
2097
|
+
readonly uuid: string;
|
|
2098
|
+
};
|
|
2099
|
+
/** @description The representation of an employee benefit for a company benefit. */
|
|
2100
|
+
"Employee-Benefit-For-Company-Benefit": components["schemas"]["Employee-Benefit-Base-Object"] & {
|
|
2101
|
+
/** @description The UUID of the employee to which the benefit belongs. */
|
|
2102
|
+
employee_uuid: string;
|
|
2103
|
+
/** @description The UUID of the company benefit. */
|
|
2104
|
+
readonly company_benefit_uuid?: string;
|
|
2105
|
+
/** @description The UUID of the employee benefit. */
|
|
2106
|
+
readonly uuid?: string;
|
|
2107
|
+
};
|
|
1864
2108
|
/** @description The representation of an employee pay stub information. */
|
|
1865
2109
|
"Employee-Pay-Stub": {
|
|
1866
2110
|
/** @description The UUID of the employee pay stub. */
|
|
@@ -1914,10 +2158,12 @@ declare interface components {
|
|
|
1914
2158
|
* @enum {string|null}
|
|
1915
2159
|
*/
|
|
1916
2160
|
"Off-Cycle-Reason-Type": "Benefit reversal" | "Bonus" | "Correction" | "Dismissed employee" | "Hired employee" | "Wage correction" | "Tax reconciliation" | "Reversal" | "Disability insurance distribution" | "Transition from old pay schedule" | null;
|
|
2161
|
+
/** @description Indicates whether the payroll is an auto pilot payroll */
|
|
2162
|
+
"Auto-Pilot-Type": boolean;
|
|
1917
2163
|
"Payroll-Employee-Compensations-Type": {
|
|
1918
2164
|
/** @description The UUID of the employee. */
|
|
1919
2165
|
readonly employee_uuid?: string;
|
|
1920
|
-
/** @description This employee will be excluded from payroll calculation and will not be paid for the payroll. Cancelling a payroll would reset all employees' excluded back to false. */
|
|
2166
|
+
/** @description This employee will be excluded (skipped) from payroll calculation and will not be paid for the payroll. Cancelling a payroll would reset all employees' excluded back to false. */
|
|
1921
2167
|
readonly excluded?: boolean;
|
|
1922
2168
|
/** @description The current version of this employee compensation. This field is only available for prepared payrolls. See the [versioning guide](https://docs.gusto.com/embedded-payroll/docs/idempotency) for information on how to use this field. */
|
|
1923
2169
|
version?: string;
|
|
@@ -2024,6 +2270,8 @@ declare interface components {
|
|
|
2024
2270
|
readonly benefits?: string;
|
|
2025
2271
|
/** @description The total amount of employee deducted benefits for the payroll. */
|
|
2026
2272
|
readonly employee_benefits_deductions?: string;
|
|
2273
|
+
/** @description The total amount of imputed pay for the payroll. */
|
|
2274
|
+
readonly imputed_pay?: string;
|
|
2027
2275
|
/** @description The total amount of payroll taxes deferred for the payroll, such as allowed by the CARES act. */
|
|
2028
2276
|
readonly deferred_payroll_taxes?: string;
|
|
2029
2277
|
/** @description The total amount of deductions for the payroll. */
|
|
@@ -2045,7 +2293,7 @@ declare interface components {
|
|
|
2045
2293
|
/** @description Current check date. */
|
|
2046
2294
|
readonly current_check_date?: string;
|
|
2047
2295
|
/** @description Original debit date when fast ach applies. */
|
|
2048
|
-
readonly original_debit_date?:
|
|
2296
|
+
readonly original_debit_date?: string;
|
|
2049
2297
|
/** @description Current debit date. */
|
|
2050
2298
|
readonly current_debit_date?: string;
|
|
2051
2299
|
/** @description The reason why the payroll is moved to four day. */
|
|
@@ -2090,7 +2338,7 @@ declare interface components {
|
|
|
2090
2338
|
"Payroll-Processed-Type": boolean;
|
|
2091
2339
|
/** @description The date at which the payroll was processed. Null if the payroll isn't processed yet. */
|
|
2092
2340
|
"Payroll-Processed-Date-Type": string;
|
|
2093
|
-
/** @description A timestamp of the last valid payroll calculation. Null
|
|
2341
|
+
/** @description A timestamp of the last valid payroll calculation. Null if there isn't a valid calculation. */
|
|
2094
2342
|
"Payroll-Calculated-At-Type": string;
|
|
2095
2343
|
/** @description The UUID of the payroll. */
|
|
2096
2344
|
"Payroll-Payroll-Uuid-Type": string;
|
|
@@ -2110,6 +2358,7 @@ declare interface components {
|
|
|
2110
2358
|
/** @description The name of an available type of fixed compensation. */
|
|
2111
2359
|
readonly name?: string;
|
|
2112
2360
|
}[];
|
|
2361
|
+
/** @description Only included for processed or calculated payrolls */
|
|
2113
2362
|
"Payroll-Submission-Blockers-Type": {
|
|
2114
2363
|
/** @description The type of blocker that's blocking the payment submission. */
|
|
2115
2364
|
readonly blocker_type?: string;
|
|
@@ -2132,6 +2381,7 @@ declare interface components {
|
|
|
2132
2381
|
*/
|
|
2133
2382
|
status?: "unresolved" | "resolved";
|
|
2134
2383
|
}[];
|
|
2384
|
+
/** @description Only included for processed payrolls */
|
|
2135
2385
|
"Payroll-Credit-Blockers-Type": {
|
|
2136
2386
|
/** @description The type of blocker that's blocking the payment from being credited. */
|
|
2137
2387
|
readonly blocker_type?: string;
|
|
@@ -2154,6 +2404,15 @@ declare interface components {
|
|
|
2154
2404
|
*/
|
|
2155
2405
|
status?: "unresolved" | "pending_review" | "resolved" | "failed";
|
|
2156
2406
|
}[];
|
|
2407
|
+
"Payroll-Processing-Request": {
|
|
2408
|
+
/**
|
|
2409
|
+
* @description The status of the payroll processing request
|
|
2410
|
+
* @enum {string}
|
|
2411
|
+
*/
|
|
2412
|
+
readonly status?: "calculating" | "calculate_success" | "submitting" | "submit_success" | "processing_failed";
|
|
2413
|
+
/** @description Errors that occurred during async payroll processing */
|
|
2414
|
+
readonly errors?: components["schemas"]["Entity-Error-Object"][];
|
|
2415
|
+
} | null;
|
|
2157
2416
|
Payroll: {
|
|
2158
2417
|
payroll_deadline?: components["schemas"]["Payroll-Deadline-Type"];
|
|
2159
2418
|
check_date?: components["schemas"]["Payroll-Check-Date-Type"];
|
|
@@ -2164,6 +2423,7 @@ declare interface components {
|
|
|
2164
2423
|
company_uuid?: components["schemas"]["Payroll-Company-Uuid-Type"];
|
|
2165
2424
|
off_cycle?: components["schemas"]["Payroll-Off-Cycle-Type"];
|
|
2166
2425
|
off_cycle_reason?: components["schemas"]["Off-Cycle-Reason-Type"];
|
|
2426
|
+
auto_pilot?: components["schemas"]["Auto-Pilot-Type"];
|
|
2167
2427
|
external?: components["schemas"]["Payroll-External-Type"];
|
|
2168
2428
|
final_termination_payroll?: components["schemas"]["Payroll-Final-Termination-Payroll-Type"];
|
|
2169
2429
|
withholding_pay_period?: components["schemas"]["Payroll-Withholding-Pay-Period-Type"];
|
|
@@ -2178,6 +2438,7 @@ declare interface components {
|
|
|
2178
2438
|
created_at?: components["schemas"]["Created-At-Type"];
|
|
2179
2439
|
submission_blockers?: components["schemas"]["Payroll-Submission-Blockers-Type"];
|
|
2180
2440
|
credit_blockers?: components["schemas"]["Payroll-Credit-Blockers-Type"];
|
|
2441
|
+
processing_request?: components["schemas"]["Payroll-Processing-Request"];
|
|
2181
2442
|
};
|
|
2182
2443
|
"Payroll-Prepared": {
|
|
2183
2444
|
payroll_deadline?: components["schemas"]["Payroll-Deadline-Type"];
|
|
@@ -2189,6 +2450,7 @@ declare interface components {
|
|
|
2189
2450
|
company_uuid?: components["schemas"]["Payroll-Company-Uuid-Type"];
|
|
2190
2451
|
off_cycle?: components["schemas"]["Payroll-Off-Cycle-Type"];
|
|
2191
2452
|
off_cycle_reason?: components["schemas"]["Off-Cycle-Reason-Type"];
|
|
2453
|
+
auto_pilot?: components["schemas"]["Auto-Pilot-Type"];
|
|
2192
2454
|
external?: components["schemas"]["Payroll-External-Type"];
|
|
2193
2455
|
final_termination_payroll?: components["schemas"]["Payroll-Final-Termination-Payroll-Type"];
|
|
2194
2456
|
withholding_pay_period?: components["schemas"]["Payroll-Withholding-Pay-Period-Type"];
|
|
@@ -2200,6 +2462,7 @@ declare interface components {
|
|
|
2200
2462
|
payment_speed_changed?: components["schemas"]["Payroll-Payment-Speed-Changed-Type"];
|
|
2201
2463
|
created_at?: components["schemas"]["Created-At-Type"];
|
|
2202
2464
|
fixed_compensation_types?: components["schemas"]["Payroll-Fixed-Compensation-Types-Type"];
|
|
2465
|
+
processing_request?: components["schemas"]["Payroll-Processing-Request"];
|
|
2203
2466
|
};
|
|
2204
2467
|
"Payroll-Minimal": {
|
|
2205
2468
|
payroll_deadline?: components["schemas"]["Payroll-Deadline-Type"];
|
|
@@ -2211,6 +2474,7 @@ declare interface components {
|
|
|
2211
2474
|
company_uuid: components["schemas"]["Payroll-Company-Uuid-Type"];
|
|
2212
2475
|
off_cycle?: components["schemas"]["Payroll-Off-Cycle-Type"];
|
|
2213
2476
|
off_cycle_reason?: components["schemas"]["Off-Cycle-Reason-Type"];
|
|
2477
|
+
auto_pilot?: components["schemas"]["Auto-Pilot-Type"];
|
|
2214
2478
|
external?: components["schemas"]["Payroll-External-Type"];
|
|
2215
2479
|
final_termination_payroll?: components["schemas"]["Payroll-Final-Termination-Payroll-Type"];
|
|
2216
2480
|
withholding_pay_period?: components["schemas"]["Payroll-Withholding-Pay-Period-Type"];
|
|
@@ -2559,9 +2823,9 @@ declare interface components {
|
|
|
2559
2823
|
"Pay-Schedule-Assignment": {
|
|
2560
2824
|
/**
|
|
2561
2825
|
* @description The pay schedule assignment type.
|
|
2562
|
-
* @enum {string}
|
|
2826
|
+
* @enum {string|null}
|
|
2563
2827
|
*/
|
|
2564
|
-
readonly type?: "single" | "hourly_salaried" | "by_employee" | "by_department";
|
|
2828
|
+
readonly type?: "single" | "hourly_salaried" | "by_employee" | "by_department" | null;
|
|
2565
2829
|
/** @description Pay schedule for hourly employees. */
|
|
2566
2830
|
readonly hourly_pay_schedule_uuid?: string | null;
|
|
2567
2831
|
/** @description Pay schedule for salaried employees. */
|
|
@@ -2589,9 +2853,9 @@ declare interface components {
|
|
|
2589
2853
|
"Pay-Schedule-Assignment-Preview": {
|
|
2590
2854
|
/**
|
|
2591
2855
|
* @description The pay schedule assignment type.
|
|
2592
|
-
* @enum {string}
|
|
2856
|
+
* @enum {string|null}
|
|
2593
2857
|
*/
|
|
2594
|
-
readonly type?: "single" | "hourly_salaried" | "by_employee" | "by_department";
|
|
2858
|
+
readonly type?: "single" | "hourly_salaried" | "by_employee" | "by_department" | null;
|
|
2595
2859
|
/** @description A list of pay schedule changes including pay period and transition pay period. */
|
|
2596
2860
|
employee_changes?: components["schemas"]["Pay-Schedule-Assignment-Employee-Change"][];
|
|
2597
2861
|
};
|
|
@@ -2644,14 +2908,14 @@ declare interface components {
|
|
|
2644
2908
|
* - Married, but withhold as Single (does not apply to rev_2020_w4 form) */
|
|
2645
2909
|
filing_status?: string;
|
|
2646
2910
|
/** @description An employee can request an additional amount to be withheld from each paycheck. */
|
|
2647
|
-
extra_withholding?: string;
|
|
2911
|
+
extra_withholding?: string | null;
|
|
2648
2912
|
/** @description If there are only two jobs (i.e., you and your spouse each have a job, or you have two), you can set it to true. */
|
|
2649
|
-
two_jobs?: boolean;
|
|
2913
|
+
two_jobs?: boolean | null;
|
|
2650
2914
|
/** @description A dependent is a person other than the taxpayer or spouse who entitles the taxpayer to claim a dependency exemption. */
|
|
2651
|
-
dependents_amount?: string;
|
|
2915
|
+
dependents_amount?: string | null;
|
|
2652
2916
|
/** @description Other income amount. */
|
|
2653
|
-
other_income?: string;
|
|
2654
|
-
deductions?: string;
|
|
2917
|
+
other_income?: string | null;
|
|
2918
|
+
deductions?: string | null;
|
|
2655
2919
|
/**
|
|
2656
2920
|
* @description The version of w4 form.
|
|
2657
2921
|
* @enum {string}
|
|
@@ -2937,18 +3201,18 @@ declare interface components {
|
|
|
2937
3201
|
* @description The number of hours an employee has to work or be paid for to accrue the number of hours set in the accrual rate. Only used for hourly policies (per_hour_paid, per_hour_paid_no_overtime, per_hour_work, per_hour_worked_no_overtime). Represented as a float, e.g. "40.0".
|
|
2938
3202
|
*/
|
|
2939
3203
|
accrual_rate_unit?: string;
|
|
2940
|
-
/** @description Boolean representing if an
|
|
3204
|
+
/** @description Boolean representing if an employee's accrued time off hours will be paid out on termination */
|
|
2941
3205
|
paid_out_on_termination?: boolean;
|
|
2942
3206
|
/** @description Number of days before an employee on the policy will begin accruing time off hours */
|
|
2943
3207
|
accrual_waiting_period_days?: number;
|
|
2944
3208
|
/**
|
|
2945
3209
|
* Format: float
|
|
2946
|
-
* @description The max number of hours
|
|
3210
|
+
* @description The max number of hours an employee can carryover from one year to the next
|
|
2947
3211
|
*/
|
|
2948
3212
|
carryover_limit_hours?: string;
|
|
2949
3213
|
/**
|
|
2950
3214
|
* Format: float
|
|
2951
|
-
* @description The max number of hours
|
|
3215
|
+
* @description The max number of hours an employee can accrue in a year
|
|
2952
3216
|
*/
|
|
2953
3217
|
max_accrual_hours_per_year?: string;
|
|
2954
3218
|
/**
|
|
@@ -3167,8 +3431,8 @@ declare interface components {
|
|
|
3167
3431
|
* @description Status of the recovery case
|
|
3168
3432
|
* @enum {string}
|
|
3169
3433
|
*/
|
|
3170
|
-
status?: "open" | "redebit_initiated" | "recovered" | "lost";
|
|
3171
|
-
/** @description The latest bank error code for the recovery case. See [this
|
|
3434
|
+
status?: "open" | "redebit_initiated" | "wire_initiated" | "recovered" | "lost";
|
|
3435
|
+
/** @description The latest bank error code for the recovery case. See [this doc](https://docs.gusto.com/embedded-payroll/docs/ach-codes-and-transaction-types) for a list of common ACH return codes. */
|
|
3172
3436
|
latest_error_code?: string;
|
|
3173
3437
|
/** @description Date when funds were originally debited from the company's bank account */
|
|
3174
3438
|
original_debit_date?: string;
|
|
@@ -3369,6 +3633,15 @@ declare interface components {
|
|
|
3369
3633
|
};
|
|
3370
3634
|
};
|
|
3371
3635
|
/** @description Example response */
|
|
3636
|
+
"Historical-Employee-Object": {
|
|
3637
|
+
headers: {
|
|
3638
|
+
[name: string]: unknown;
|
|
3639
|
+
};
|
|
3640
|
+
content: {
|
|
3641
|
+
"application/json": components["schemas"]["Employee"];
|
|
3642
|
+
};
|
|
3643
|
+
};
|
|
3644
|
+
/** @description Example response */
|
|
3372
3645
|
"Employee-List": {
|
|
3373
3646
|
headers: {
|
|
3374
3647
|
[name: string]: unknown;
|
|
@@ -3554,6 +3827,24 @@ declare interface components {
|
|
|
3554
3827
|
};
|
|
3555
3828
|
};
|
|
3556
3829
|
/** @description Example response */
|
|
3830
|
+
"Company-Attachment-Object": {
|
|
3831
|
+
headers: {
|
|
3832
|
+
[name: string]: unknown;
|
|
3833
|
+
};
|
|
3834
|
+
content: {
|
|
3835
|
+
"application/json": components["schemas"]["Company-Attachment"];
|
|
3836
|
+
};
|
|
3837
|
+
};
|
|
3838
|
+
/** @description Example response */
|
|
3839
|
+
"Company-Attachment-List": {
|
|
3840
|
+
headers: {
|
|
3841
|
+
[name: string]: unknown;
|
|
3842
|
+
};
|
|
3843
|
+
content: {
|
|
3844
|
+
"application/json": components["schemas"]["Company-Attachment"][];
|
|
3845
|
+
};
|
|
3846
|
+
};
|
|
3847
|
+
/** @description Example response */
|
|
3557
3848
|
"Signatory-List": {
|
|
3558
3849
|
headers: {
|
|
3559
3850
|
[name: string]: unknown;
|
|
@@ -3698,6 +3989,15 @@ declare interface components {
|
|
|
3698
3989
|
};
|
|
3699
3990
|
};
|
|
3700
3991
|
/** @description Example response */
|
|
3992
|
+
"Created-Contractor-Object": {
|
|
3993
|
+
headers: {
|
|
3994
|
+
[name: string]: unknown;
|
|
3995
|
+
};
|
|
3996
|
+
content: {
|
|
3997
|
+
"application/json": components["schemas"]["Contractor"];
|
|
3998
|
+
};
|
|
3999
|
+
};
|
|
4000
|
+
/** @description Example response */
|
|
3701
4001
|
"Contractor-Object": {
|
|
3702
4002
|
headers: {
|
|
3703
4003
|
[name: string]: unknown;
|
|
@@ -3796,6 +4096,15 @@ declare interface components {
|
|
|
3796
4096
|
"application/json": components["schemas"]["Garnishment"][];
|
|
3797
4097
|
};
|
|
3798
4098
|
};
|
|
4099
|
+
/** @description Example response */
|
|
4100
|
+
"Child-Support-Data-Object": {
|
|
4101
|
+
headers: {
|
|
4102
|
+
[name: string]: unknown;
|
|
4103
|
+
};
|
|
4104
|
+
content: {
|
|
4105
|
+
"application/json": components["schemas"]["Child-Support-Data"];
|
|
4106
|
+
};
|
|
4107
|
+
};
|
|
3799
4108
|
/** @description Example Response */
|
|
3800
4109
|
"Termination-Object": {
|
|
3801
4110
|
headers: {
|
|
@@ -4317,6 +4626,8 @@ declare interface components {
|
|
|
4317
4626
|
benefit_id: string;
|
|
4318
4627
|
/** @description The UUID of the compensation */
|
|
4319
4628
|
compensation_id: string;
|
|
4629
|
+
/** @description The UUID of the company attachment */
|
|
4630
|
+
company_attachment_uuid: string;
|
|
4320
4631
|
/** @description The UUID of the company benefit */
|
|
4321
4632
|
company_benefit_id: string;
|
|
4322
4633
|
/** @description The UUID of the company */
|
|
@@ -4352,6 +4663,8 @@ declare interface components {
|
|
|
4352
4663
|
external_payroll_id: string;
|
|
4353
4664
|
/** @description The UUID of the form */
|
|
4354
4665
|
form_id: string;
|
|
4666
|
+
/** @description The ID or UUID of the document */
|
|
4667
|
+
document_uuid: string;
|
|
4355
4668
|
/** @description The UUID of the garnishment */
|
|
4356
4669
|
garnishment_id: string;
|
|
4357
4670
|
/** @description The UUID of the home address */
|
|
@@ -4396,7 +4709,7 @@ declare interface components {
|
|
|
4396
4709
|
webhook_subscription_uuid: string;
|
|
4397
4710
|
/** @description Determines the date-based API version associated with your API call. If none is provided, your application's [minimum API version](https://docs.gusto.com/embedded-payroll/docs/api-versioning#minimum-api-version) is used. */
|
|
4398
4711
|
VersionHeader: "2024-04-01";
|
|
4399
|
-
/** @description The
|
|
4712
|
+
/** @description The notification entity_uuid */
|
|
4400
4713
|
notification_uuid: string;
|
|
4401
4714
|
/** @description The month we are calculating the invoice for. Must be in YYYY-MM format */
|
|
4402
4715
|
invoice_period: string;
|
|
@@ -4476,13 +4789,49 @@ declare interface DeductionsProps extends CommonComponentInterface {
|
|
|
4476
4789
|
}
|
|
4477
4790
|
|
|
4478
4791
|
declare type DeepPartial<T> = {
|
|
4479
|
-
[P in keyof T]?: T[P] extends (infer U)[]
|
|
4480
|
-
|
|
4792
|
+
[P in keyof T]?: T[P] extends (infer U)[]
|
|
4793
|
+
? DeepPartial<U>[]
|
|
4794
|
+
: T[P] extends object
|
|
4795
|
+
? DeepPartial<T[P]>
|
|
4796
|
+
: T[P]
|
|
4797
|
+
}
|
|
4481
4798
|
|
|
4482
4799
|
export declare type Dictionary = Record<string, Partial<{
|
|
4483
4800
|
[K in keyof Resources]: DeepPartial<Resources[K]>;
|
|
4484
4801
|
}>>;
|
|
4485
4802
|
|
|
4803
|
+
declare function DocumentList(): JSX_2.Element | null;
|
|
4804
|
+
|
|
4805
|
+
declare function DocumentListHead(): JSX_2.Element | null;
|
|
4806
|
+
|
|
4807
|
+
export declare function DocumentSigner(): JSX_2.Element;
|
|
4808
|
+
|
|
4809
|
+
declare function DocumentSigner_2(props: DocumentSignerProps & BaseComponentInterface): JSX_2.Element;
|
|
4810
|
+
|
|
4811
|
+
declare namespace DocumentSigner_2 {
|
|
4812
|
+
var DocumentListHead: DocumentListHead;
|
|
4813
|
+
var DocumentList: DocumentList;
|
|
4814
|
+
var SignatureFormHead: SignatureFormHead;
|
|
4815
|
+
var SignatureForm: SignatureForm;
|
|
4816
|
+
}
|
|
4817
|
+
|
|
4818
|
+
declare type DocumentSignerContextType = {
|
|
4819
|
+
employeeForms: Schemas['Form'][];
|
|
4820
|
+
isPending: boolean;
|
|
4821
|
+
mode: MODE_4;
|
|
4822
|
+
handleRequestFormToSign: (form: Schemas['Form']) => void;
|
|
4823
|
+
handleContinue: () => void;
|
|
4824
|
+
documentListError: Error | null;
|
|
4825
|
+
formToSign?: Schemas['Form'];
|
|
4826
|
+
pdfUrl?: string;
|
|
4827
|
+
handleBack: () => void;
|
|
4828
|
+
handleSubmit: (event: React.FormEvent<HTMLFormElement>) => void;
|
|
4829
|
+
};
|
|
4830
|
+
|
|
4831
|
+
declare interface DocumentSignerProps extends CommonComponentInterface {
|
|
4832
|
+
employeeId: string;
|
|
4833
|
+
}
|
|
4834
|
+
|
|
4486
4835
|
declare namespace Employee {
|
|
4487
4836
|
export {
|
|
4488
4837
|
EmployeeList,
|
|
@@ -4495,9 +4844,9 @@ declare namespace Employee {
|
|
|
4495
4844
|
IncludeDeductionsPayload,
|
|
4496
4845
|
Root,
|
|
4497
4846
|
DeductionsContextual,
|
|
4498
|
-
OnboardingSummary,
|
|
4847
|
+
OnboardingSummary_2 as OnboardingSummary,
|
|
4499
4848
|
OnboardingSummaryContextual,
|
|
4500
|
-
Profile,
|
|
4849
|
+
Profile_2 as Profile,
|
|
4501
4850
|
useProfile,
|
|
4502
4851
|
ProfileContextual,
|
|
4503
4852
|
Compensation,
|
|
@@ -4505,15 +4854,17 @@ declare namespace Employee {
|
|
|
4505
4854
|
CompensationInputs,
|
|
4506
4855
|
CompensationOutputs,
|
|
4507
4856
|
CompensationContextual,
|
|
4508
|
-
Taxes,
|
|
4857
|
+
Taxes_2 as Taxes,
|
|
4509
4858
|
useTaxes,
|
|
4510
4859
|
TaxesContextual,
|
|
4511
|
-
PaymentMethod,
|
|
4860
|
+
PaymentMethod_2 as PaymentMethod,
|
|
4512
4861
|
usePaymentMethod,
|
|
4513
4862
|
CombinedSchemaInputs,
|
|
4514
4863
|
CombinedSchemaOutputs,
|
|
4515
4864
|
PaymentMethodContextual,
|
|
4516
|
-
Landing
|
|
4865
|
+
Landing_2 as Landing,
|
|
4866
|
+
DocumentSigner_2 as DocumentSigner,
|
|
4867
|
+
useDocumentSigner
|
|
4517
4868
|
}
|
|
4518
4869
|
}
|
|
4519
4870
|
export { Employee }
|
|
@@ -4544,6 +4895,8 @@ declare interface EmployeeListProps extends CommonComponentInterface {
|
|
|
4544
4895
|
export declare interface EmployeeOnboardingContextInterface extends FlowContextInterface {
|
|
4545
4896
|
companyId: string;
|
|
4546
4897
|
employeeId?: string;
|
|
4898
|
+
isAdmin?: boolean;
|
|
4899
|
+
startDate?: string;
|
|
4547
4900
|
paymentMethod?: Schemas['Employee-Payment-Method'];
|
|
4548
4901
|
}
|
|
4549
4902
|
|
|
@@ -4553,13 +4906,26 @@ export declare interface EmployeeOnboardingFlowProps extends BaseComponentInterf
|
|
|
4553
4906
|
companyId: string;
|
|
4554
4907
|
}
|
|
4555
4908
|
|
|
4909
|
+
export declare interface EmployeeSelfOnboardingContextInterface extends FlowContextInterface {
|
|
4910
|
+
companyId: string;
|
|
4911
|
+
employeeId: string;
|
|
4912
|
+
paymentMethod?: Schemas['Employee-Payment-Method'];
|
|
4913
|
+
}
|
|
4914
|
+
|
|
4915
|
+
export declare const EmployeeSelfOnboardingFlow: ({ companyId, employeeId, onEvent, }: EmployeeSelfOnboardingFlowProps) => JSX_2.Element;
|
|
4916
|
+
|
|
4917
|
+
export declare interface EmployeeSelfOnboardingFlowProps extends BaseComponentInterface {
|
|
4918
|
+
companyId: string;
|
|
4919
|
+
employeeId: string;
|
|
4920
|
+
}
|
|
4921
|
+
|
|
4556
4922
|
declare type EventType = (typeof componentEvents)[keyof typeof componentEvents];
|
|
4557
4923
|
|
|
4558
4924
|
declare function FederalForm(): JSX_2.Element;
|
|
4559
4925
|
|
|
4560
4926
|
declare function FederalHead(): JSX_2.Element;
|
|
4561
4927
|
|
|
4562
|
-
declare interface FlowContextInterface {
|
|
4928
|
+
export declare interface FlowContextInterface {
|
|
4563
4929
|
component: React.ComponentType | null;
|
|
4564
4930
|
onEvent: OnEventType<EventType, unknown>;
|
|
4565
4931
|
title?: string;
|
|
@@ -4567,25 +4933,31 @@ declare interface FlowContextInterface {
|
|
|
4567
4933
|
|
|
4568
4934
|
declare interface GTheme {
|
|
4569
4935
|
rootFS: string
|
|
4570
|
-
colors
|
|
4571
|
-
focus
|
|
4572
|
-
shadow
|
|
4573
|
-
spacing
|
|
4574
|
-
typography
|
|
4936
|
+
colors: GThemeColors
|
|
4937
|
+
focus: GThemeFocus
|
|
4938
|
+
shadow: GThemeShadow
|
|
4939
|
+
spacing: GThemeSpacing
|
|
4940
|
+
typography: GThemeTypography
|
|
4575
4941
|
input: GThemeInput
|
|
4576
4942
|
button: GThemeButton
|
|
4577
4943
|
radio: GThemeRadio
|
|
4578
4944
|
checkbox: GThemeCheckbox
|
|
4579
|
-
table
|
|
4580
|
-
link
|
|
4581
|
-
badge
|
|
4582
|
-
optionalLabel
|
|
4945
|
+
table: GThemeTable
|
|
4946
|
+
link: GThemeLink
|
|
4947
|
+
badge: GThemeBadge
|
|
4948
|
+
optionalLabel: string //This is a string pulled from translations to indicate (optional) on form elements
|
|
4583
4949
|
}
|
|
4584
4950
|
|
|
4585
4951
|
declare interface GThemeBadge {
|
|
4952
|
+
success: {
|
|
4953
|
+
color: string
|
|
4954
|
+
backgroundColor: string
|
|
4955
|
+
borderColor: string
|
|
4956
|
+
}
|
|
4586
4957
|
fontSize: string
|
|
4587
4958
|
fontWeight: number
|
|
4588
4959
|
borderWidth: string
|
|
4960
|
+
borderRadius: string
|
|
4589
4961
|
paddingX: string
|
|
4590
4962
|
paddingY: string
|
|
4591
4963
|
}
|
|
@@ -4594,6 +4966,8 @@ declare interface GThemeButton {
|
|
|
4594
4966
|
fontSize: string
|
|
4595
4967
|
fontWeight: number
|
|
4596
4968
|
borderWidth: string
|
|
4969
|
+
borderRadius: string
|
|
4970
|
+
textStyle: 'uppercase' | 'none' | 'capitalize' | 'lowercase'
|
|
4597
4971
|
paddingX: string
|
|
4598
4972
|
paddingY: string
|
|
4599
4973
|
shadow: string
|
|
@@ -4630,6 +5004,18 @@ declare interface GThemeColors {
|
|
|
4630
5004
|
900: ThemeColor
|
|
4631
5005
|
1000: ThemeColor
|
|
4632
5006
|
}
|
|
5007
|
+
gray: {
|
|
5008
|
+
100: ThemeColor
|
|
5009
|
+
200: ThemeColor
|
|
5010
|
+
300: ThemeColor
|
|
5011
|
+
400: ThemeColor
|
|
5012
|
+
500: ThemeColor
|
|
5013
|
+
600: ThemeColor
|
|
5014
|
+
700: ThemeColor
|
|
5015
|
+
800: ThemeColor
|
|
5016
|
+
900: ThemeColor
|
|
5017
|
+
1000: ThemeColor
|
|
5018
|
+
}
|
|
4633
5019
|
error: {
|
|
4634
5020
|
100: ThemeColor
|
|
4635
5021
|
500: ThemeColor
|
|
@@ -4638,6 +5024,7 @@ declare interface GThemeColors {
|
|
|
4638
5024
|
warning: {
|
|
4639
5025
|
100: ThemeColor
|
|
4640
5026
|
500: ThemeColor
|
|
5027
|
+
700: ThemeColor
|
|
4641
5028
|
800: ThemeColor
|
|
4642
5029
|
}
|
|
4643
5030
|
success: {
|
|
@@ -4654,12 +5041,26 @@ declare interface GThemeFocus {
|
|
|
4654
5041
|
}
|
|
4655
5042
|
|
|
4656
5043
|
declare interface GThemeInput {
|
|
5044
|
+
fontSize: string
|
|
4657
5045
|
textColor: ThemeColor
|
|
4658
5046
|
borderColor: ThemeColor
|
|
5047
|
+
borderWidth: string
|
|
5048
|
+
background: string
|
|
4659
5049
|
padding: string
|
|
4660
5050
|
labelFontSize: string
|
|
4661
5051
|
labelColor: ThemeColor
|
|
4662
5052
|
labelFontWeight: number
|
|
5053
|
+
disabled: {
|
|
5054
|
+
color: ThemeColor
|
|
5055
|
+
border: ThemeColor
|
|
5056
|
+
bg: ThemeColor
|
|
5057
|
+
}
|
|
5058
|
+
hovered: {
|
|
5059
|
+
borderColor: ThemeColor
|
|
5060
|
+
}
|
|
5061
|
+
placeholderColor: ThemeColor
|
|
5062
|
+
descriptionColor: ThemeColor
|
|
5063
|
+
disabledColor: ThemeColor
|
|
4663
5064
|
}
|
|
4664
5065
|
|
|
4665
5066
|
declare interface GThemeLink {
|
|
@@ -4685,6 +5086,7 @@ declare interface GThemeRadio {
|
|
|
4685
5086
|
}
|
|
4686
5087
|
|
|
4687
5088
|
declare interface GThemeShadow {
|
|
5089
|
+
100: string
|
|
4688
5090
|
200: string
|
|
4689
5091
|
}
|
|
4690
5092
|
|
|
@@ -4701,26 +5103,49 @@ declare interface GThemeSpacing {
|
|
|
4701
5103
|
}
|
|
4702
5104
|
|
|
4703
5105
|
declare interface GThemeTable {
|
|
4704
|
-
|
|
4705
|
-
|
|
4706
|
-
|
|
4707
|
-
|
|
4708
|
-
|
|
4709
|
-
|
|
5106
|
+
paddingX: string
|
|
5107
|
+
paddingY: string
|
|
5108
|
+
fontSize: string
|
|
5109
|
+
headerColor: string
|
|
5110
|
+
headerBg: string
|
|
5111
|
+
columnWeight: number
|
|
5112
|
+
borderColor: string
|
|
5113
|
+
background: string
|
|
5114
|
+
highlightBg: string
|
|
5115
|
+
highlightFg: string
|
|
5116
|
+
textColor: string
|
|
4710
5117
|
}
|
|
4711
5118
|
|
|
4712
5119
|
declare interface GThemeTypography {
|
|
4713
|
-
font
|
|
4714
|
-
|
|
4715
|
-
|
|
4716
|
-
|
|
4717
|
-
|
|
5120
|
+
font: string
|
|
5121
|
+
textColor: ThemeColor
|
|
5122
|
+
errorTextColor: ThemeColor
|
|
5123
|
+
defaultLineHeight: string
|
|
5124
|
+
fontSize: {
|
|
5125
|
+
small: string
|
|
5126
|
+
regular: string
|
|
5127
|
+
medium: string
|
|
5128
|
+
}
|
|
5129
|
+
fontWeight: {
|
|
5130
|
+
book: number
|
|
5131
|
+
medium: number
|
|
5132
|
+
}
|
|
5133
|
+
disabledTextColor: ThemeColor
|
|
5134
|
+
headings: {
|
|
5135
|
+
1: string
|
|
5136
|
+
2: string
|
|
5137
|
+
3: string
|
|
5138
|
+
4: string
|
|
5139
|
+
5: string
|
|
5140
|
+
6: string
|
|
5141
|
+
}
|
|
4718
5142
|
}
|
|
4719
5143
|
|
|
4720
|
-
export declare function GustoApiContextProvider({ children, context, }: {
|
|
5144
|
+
export declare function GustoApiContextProvider({ children, context, queryClient, }: {
|
|
4721
5145
|
context: {
|
|
4722
5146
|
GustoClient: GustoClient;
|
|
4723
5147
|
};
|
|
5148
|
+
queryClient?: QueryClient;
|
|
4724
5149
|
children: React.ReactNode;
|
|
4725
5150
|
}): JSX_2.Element;
|
|
4726
5151
|
|
|
@@ -4730,8 +5155,9 @@ export declare interface GustoApiProps {
|
|
|
4730
5155
|
lng?: string;
|
|
4731
5156
|
locale?: string;
|
|
4732
5157
|
currency?: string;
|
|
4733
|
-
theme?: GTheme
|
|
5158
|
+
theme?: DeepPartial<GTheme>;
|
|
4734
5159
|
children?: default_3.ReactNode;
|
|
5160
|
+
queryClient?: QueryClient;
|
|
4735
5161
|
}
|
|
4736
5162
|
|
|
4737
5163
|
export declare const GustoApiProvider: default_3.FC<GustoApiProps>;
|
|
@@ -4776,6 +5202,7 @@ export declare class GustoClient {
|
|
|
4776
5202
|
getCompany(company_id: string): Promise<{
|
|
4777
5203
|
readonly ein?: string;
|
|
4778
5204
|
readonly entity_type?: "C-Corporation" | "S-Corporation" | "Sole proprietor" | "LLC" | "LLP" | "Limited partnership" | "Co-ownership" | "Association" | "Trusteeship" | "General partnership" | "Joint venture" | "Non-Profit";
|
|
5205
|
+
contractor_only?: boolean;
|
|
4779
5206
|
readonly tier?: "simple" | "plus" | "premium" | "core" | "complete" | "concierge" | "contractor_only" | "basic" | null;
|
|
4780
5207
|
is_suspended?: boolean;
|
|
4781
5208
|
readonly company_status?: "Approved" | "Not Approved" | "Suspended";
|
|
@@ -4784,7 +5211,7 @@ export declare class GustoClient {
|
|
|
4784
5211
|
readonly slug?: string;
|
|
4785
5212
|
readonly trade_name?: string;
|
|
4786
5213
|
readonly is_partner_managed?: boolean;
|
|
4787
|
-
readonly pay_schedule_type?: "single" | "hourly_salaried" | "by_employee" | "by_department";
|
|
5214
|
+
readonly pay_schedule_type?: "single" | "hourly_salaried" | "by_employee" | "by_department" | null;
|
|
4788
5215
|
readonly join_date?: string;
|
|
4789
5216
|
funding_type?: "ach" | "reverse_wire" | "wire_in" | "brex";
|
|
4790
5217
|
readonly locations?: components["schemas"]["Company-Address"][];
|
|
@@ -4848,7 +5275,7 @@ export declare class GustoClient {
|
|
|
4848
5275
|
getEmployee(employee_id: string): Promise<FetchResponse< {
|
|
4849
5276
|
parameters: {
|
|
4850
5277
|
query?: {
|
|
4851
|
-
include?: "all_compensations" | "custom_fields";
|
|
5278
|
+
include?: ("all_compensations" | "custom_fields")[];
|
|
4852
5279
|
};
|
|
4853
5280
|
header?: {
|
|
4854
5281
|
"X-Gusto-API-Version"?: components["parameters"]["VersionHeader"];
|
|
@@ -4877,11 +5304,11 @@ export declare class GustoClient {
|
|
|
4877
5304
|
last_name: string;
|
|
4878
5305
|
email?: string | null;
|
|
4879
5306
|
readonly company_uuid?: string;
|
|
4880
|
-
readonly manager_uuid?: string;
|
|
5307
|
+
readonly manager_uuid?: string | null;
|
|
4881
5308
|
readonly version?: string;
|
|
4882
5309
|
readonly department?: string | null;
|
|
4883
5310
|
readonly terminated?: boolean;
|
|
4884
|
-
two_percent_shareholder?: boolean;
|
|
5311
|
+
two_percent_shareholder?: boolean | null;
|
|
4885
5312
|
readonly onboarded?: boolean;
|
|
4886
5313
|
readonly onboarding_status?: "onboarding_completed" | "admin_onboarding_incomplete" | "self_onboarding_pending_invite" | "self_onboarding_invited" | "self_onboarding_invited_started" | "self_onboarding_invited_overdue" | "self_onboarding_completed_by_employee" | "self_onboarding_awaiting_admin_review";
|
|
4887
5314
|
jobs?: components["schemas"]["Job"][];
|
|
@@ -4892,8 +5319,8 @@ export declare class GustoClient {
|
|
|
4892
5319
|
readonly date_of_birth?: string | null;
|
|
4893
5320
|
has_ssn?: boolean;
|
|
4894
5321
|
ssn?: string;
|
|
4895
|
-
phone?: string;
|
|
4896
|
-
preferred_first_name?: string;
|
|
5322
|
+
phone?: string | null;
|
|
5323
|
+
preferred_first_name?: string | null;
|
|
4897
5324
|
payment_method: "Direct Deposit" | "Check";
|
|
4898
5325
|
work_email?: string | null;
|
|
4899
5326
|
readonly current_employment_status?: "full_time" | "part_time_under_twenty_hours" | "part_time_twenty_plus_hours" | "variable" | "seasonal" | null;
|
|
@@ -4919,7 +5346,7 @@ export declare class GustoClient {
|
|
|
4919
5346
|
parameters: {
|
|
4920
5347
|
query?: {
|
|
4921
5348
|
terminated?: boolean;
|
|
4922
|
-
include?: "all_compensations" | "custom_fields";
|
|
5349
|
+
include?: ("all_compensations" | "custom_fields")[];
|
|
4923
5350
|
page?: components["parameters"]["pageParam"];
|
|
4924
5351
|
per?: components["parameters"]["perParam"];
|
|
4925
5352
|
search_term?: components["parameters"]["search_term"];
|
|
@@ -4955,11 +5382,11 @@ export declare class GustoClient {
|
|
|
4955
5382
|
last_name: string;
|
|
4956
5383
|
email?: string | null;
|
|
4957
5384
|
readonly company_uuid?: string;
|
|
4958
|
-
readonly manager_uuid?: string;
|
|
5385
|
+
readonly manager_uuid?: string | null;
|
|
4959
5386
|
readonly version?: string;
|
|
4960
5387
|
readonly department?: string | null;
|
|
4961
5388
|
readonly terminated?: boolean;
|
|
4962
|
-
two_percent_shareholder?: boolean;
|
|
5389
|
+
two_percent_shareholder?: boolean | null;
|
|
4963
5390
|
readonly onboarded?: boolean;
|
|
4964
5391
|
readonly onboarding_status?: "onboarding_completed" | "admin_onboarding_incomplete" | "self_onboarding_pending_invite" | "self_onboarding_invited" | "self_onboarding_invited_started" | "self_onboarding_invited_overdue" | "self_onboarding_completed_by_employee" | "self_onboarding_awaiting_admin_review";
|
|
4965
5392
|
jobs?: components["schemas"]["Job"][];
|
|
@@ -4970,8 +5397,8 @@ export declare class GustoClient {
|
|
|
4970
5397
|
readonly date_of_birth?: string | null;
|
|
4971
5398
|
has_ssn?: boolean;
|
|
4972
5399
|
ssn?: string;
|
|
4973
|
-
phone?: string;
|
|
4974
|
-
preferred_first_name?: string;
|
|
5400
|
+
phone?: string | null;
|
|
5401
|
+
preferred_first_name?: string | null;
|
|
4975
5402
|
payment_method: "Direct Deposit" | "Check";
|
|
4976
5403
|
work_email?: string | null;
|
|
4977
5404
|
readonly current_employment_status?: "full_time" | "part_time_under_twenty_hours" | "part_time_twenty_plus_hours" | "variable" | "seasonal" | null;
|
|
@@ -5503,6 +5930,8 @@ export declare class GustoClient {
|
|
|
5503
5930
|
annual_maximum: string | null;
|
|
5504
5931
|
pay_period_maximum: string | null;
|
|
5505
5932
|
deduct_as_percentage: boolean;
|
|
5933
|
+
garnishment_type?: "child_support" | "federal_tax_lien" | "state_tax_lien" | "student_loan" | "creditor_garnishment" | "federal_loan" | "other_garnishment" | null;
|
|
5934
|
+
child_support?: components["schemas"]["Garnishment-Child-Support"];
|
|
5506
5935
|
}>;
|
|
5507
5936
|
updateDeduction(garnishment_id: string, body: BodyParams<'/v1/garnishments/{garnishment_id}', 'PUT'>): Promise<{
|
|
5508
5937
|
readonly uuid: string;
|
|
@@ -5517,6 +5946,8 @@ export declare class GustoClient {
|
|
|
5517
5946
|
annual_maximum: string | null;
|
|
5518
5947
|
pay_period_maximum: string | null;
|
|
5519
5948
|
deduct_as_percentage: boolean;
|
|
5949
|
+
garnishment_type?: "child_support" | "federal_tax_lien" | "state_tax_lien" | "student_loan" | "creditor_garnishment" | "federal_loan" | "other_garnishment" | null;
|
|
5950
|
+
child_support?: components["schemas"]["Garnishment-Child-Support"];
|
|
5520
5951
|
}>;
|
|
5521
5952
|
getEmployeeBankAccounts(employee_id: string): Promise<FetchResponse< {
|
|
5522
5953
|
parameters: {
|
|
@@ -5765,10 +6196,10 @@ export declare class GustoClient {
|
|
|
5765
6196
|
}, `${string}/${string}`>>;
|
|
5766
6197
|
previewPayScheduleDates(company_id: string, query: QueryParams<'/v1/companies/{company_id}/pay_schedules/preview'>): Promise<FetchResponse< {
|
|
5767
6198
|
parameters: {
|
|
5768
|
-
query
|
|
5769
|
-
frequency
|
|
5770
|
-
anchor_pay_date
|
|
5771
|
-
anchor_end_of_pay_period
|
|
6199
|
+
query: {
|
|
6200
|
+
frequency: "Every week" | "Every other week" | "Twice per month" | "Monthly";
|
|
6201
|
+
anchor_pay_date: string;
|
|
6202
|
+
anchor_end_of_pay_period: string;
|
|
5772
6203
|
day_1?: number;
|
|
5773
6204
|
day_2?: number;
|
|
5774
6205
|
};
|
|
@@ -5805,22 +6236,22 @@ export declare class GustoClient {
|
|
|
5805
6236
|
company_id: string;
|
|
5806
6237
|
};
|
|
5807
6238
|
query: {
|
|
5808
|
-
frequency
|
|
5809
|
-
anchor_pay_date
|
|
5810
|
-
anchor_end_of_pay_period
|
|
6239
|
+
frequency: "Every week" | "Every other week" | "Twice per month" | "Monthly";
|
|
6240
|
+
anchor_pay_date: string;
|
|
6241
|
+
anchor_end_of_pay_period: string;
|
|
5811
6242
|
day_1?: number;
|
|
5812
6243
|
day_2?: number;
|
|
5813
|
-
}
|
|
6244
|
+
};
|
|
5814
6245
|
};
|
|
5815
6246
|
}, `${string}/${string}`>>;
|
|
5816
6247
|
getEmployeeFederalTaxes(employee_uuid: string): Promise<{
|
|
5817
6248
|
version?: string;
|
|
5818
6249
|
filing_status?: string;
|
|
5819
|
-
extra_withholding?: string;
|
|
5820
|
-
two_jobs?: boolean;
|
|
5821
|
-
dependents_amount?: string;
|
|
5822
|
-
other_income?: string;
|
|
5823
|
-
deductions?: string;
|
|
6250
|
+
extra_withholding?: string | null;
|
|
6251
|
+
two_jobs?: boolean | null;
|
|
6252
|
+
dependents_amount?: string | null;
|
|
6253
|
+
other_income?: string | null;
|
|
6254
|
+
deductions?: string | null;
|
|
5824
6255
|
w4_data_type?: "pre_2020_w4" | "rev_2020_w4";
|
|
5825
6256
|
federal_withholding_allowance?: number;
|
|
5826
6257
|
additional_withholding?: boolean;
|
|
@@ -5828,11 +6259,11 @@ export declare class GustoClient {
|
|
|
5828
6259
|
updateEmployeeFederalTaxes(employee_uuid: string, body: BodyParams<'/v1/employees/{employee_uuid}/federal_taxes', 'PUT'>): Promise<{
|
|
5829
6260
|
version?: string;
|
|
5830
6261
|
filing_status?: string;
|
|
5831
|
-
extra_withholding?: string;
|
|
5832
|
-
two_jobs?: boolean;
|
|
5833
|
-
dependents_amount?: string;
|
|
5834
|
-
other_income?: string;
|
|
5835
|
-
deductions?: string;
|
|
6262
|
+
extra_withholding?: string | null;
|
|
6263
|
+
two_jobs?: boolean | null;
|
|
6264
|
+
dependents_amount?: string | null;
|
|
6265
|
+
other_income?: string | null;
|
|
6266
|
+
deductions?: string | null;
|
|
5836
6267
|
w4_data_type?: "pre_2020_w4" | "rev_2020_w4";
|
|
5837
6268
|
federal_withholding_allowance?: number;
|
|
5838
6269
|
additional_withholding?: boolean;
|
|
@@ -5859,6 +6290,7 @@ export declare class GustoClient {
|
|
|
5859
6290
|
include?: ("totals" | "payroll_status_meta" | "risk_blockers")[];
|
|
5860
6291
|
start_date?: string;
|
|
5861
6292
|
end_date?: string;
|
|
6293
|
+
sort_order?: components["parameters"]["sort_order"];
|
|
5862
6294
|
};
|
|
5863
6295
|
header?: {
|
|
5864
6296
|
"X-Gusto-API-Version"?: components["parameters"]["VersionHeader"];
|
|
@@ -5894,6 +6326,7 @@ export declare class GustoClient {
|
|
|
5894
6326
|
include?: ("totals" | "payroll_status_meta" | "risk_blockers")[];
|
|
5895
6327
|
start_date?: string;
|
|
5896
6328
|
end_date?: string;
|
|
6329
|
+
sort_order?: components["parameters"]["sort_order"];
|
|
5897
6330
|
};
|
|
5898
6331
|
header?: {
|
|
5899
6332
|
"X-Gusto-API-Version"?: components["parameters"]["VersionHeader"];
|
|
@@ -5925,7 +6358,7 @@ export declare class GustoClient {
|
|
|
5925
6358
|
getPayroll(company_id: string, payroll_id: string): Promise<FetchResponse< {
|
|
5926
6359
|
parameters: {
|
|
5927
6360
|
query?: {
|
|
5928
|
-
include?: "benefits" | "deductions" | "taxes" | "payroll_status_meta";
|
|
6361
|
+
include?: ("benefits" | "deductions" | "taxes" | "payroll_status_meta")[];
|
|
5929
6362
|
};
|
|
5930
6363
|
header?: {
|
|
5931
6364
|
"X-Gusto-API-Version"?: components["parameters"]["VersionHeader"];
|
|
@@ -5944,7 +6377,7 @@ export declare class GustoClient {
|
|
|
5944
6377
|
}, FetchOptions< {
|
|
5945
6378
|
parameters: {
|
|
5946
6379
|
query?: {
|
|
5947
|
-
include?: "benefits" | "deductions" | "taxes" | "payroll_status_meta";
|
|
6380
|
+
include?: ("benefits" | "deductions" | "taxes" | "payroll_status_meta")[];
|
|
5948
6381
|
};
|
|
5949
6382
|
header?: {
|
|
5950
6383
|
"X-Gusto-API-Version"?: components["parameters"]["VersionHeader"];
|
|
@@ -5998,7 +6431,7 @@ export declare class GustoClient {
|
|
|
5998
6431
|
requestBody?: {
|
|
5999
6432
|
content: {
|
|
6000
6433
|
"application/json": {
|
|
6001
|
-
title
|
|
6434
|
+
title?: string;
|
|
6002
6435
|
naics_code: string;
|
|
6003
6436
|
sic_codes?: string[];
|
|
6004
6437
|
};
|
|
@@ -6016,7 +6449,7 @@ export declare class GustoClient {
|
|
|
6016
6449
|
};
|
|
6017
6450
|
};
|
|
6018
6451
|
body: {
|
|
6019
|
-
title
|
|
6452
|
+
title?: string;
|
|
6020
6453
|
naics_code: string;
|
|
6021
6454
|
sic_codes?: string[];
|
|
6022
6455
|
} | undefined;
|
|
@@ -6135,6 +6568,30 @@ export declare class GustoClient {
|
|
|
6135
6568
|
requirements?: string[];
|
|
6136
6569
|
}[];
|
|
6137
6570
|
}>;
|
|
6571
|
+
getAllEmployeeForms(employee_id: string): Promise<{
|
|
6572
|
+
readonly uuid: string;
|
|
6573
|
+
readonly name?: string;
|
|
6574
|
+
readonly title?: string;
|
|
6575
|
+
readonly description?: string;
|
|
6576
|
+
readonly draft?: boolean;
|
|
6577
|
+
readonly year?: number | null;
|
|
6578
|
+
readonly quarter?: number | null;
|
|
6579
|
+
readonly requires_signing?: boolean;
|
|
6580
|
+
}[]>;
|
|
6581
|
+
getEmployeeFormPdf(employee_id: string, form_id: string): Promise<{
|
|
6582
|
+
readonly uuid: string;
|
|
6583
|
+
document_url?: string;
|
|
6584
|
+
}>;
|
|
6585
|
+
signEmployeeForm(employee_id: string, form_id: string, body: BodyParams<'/v1/employees/{employee_id}/forms/{form_id}/sign', 'PUT'>): Promise<{
|
|
6586
|
+
readonly uuid: string;
|
|
6587
|
+
readonly name?: string;
|
|
6588
|
+
readonly title?: string;
|
|
6589
|
+
readonly description?: string;
|
|
6590
|
+
readonly draft?: boolean;
|
|
6591
|
+
readonly year?: number | null;
|
|
6592
|
+
readonly quarter?: number | null;
|
|
6593
|
+
readonly requires_signing?: boolean;
|
|
6594
|
+
}>;
|
|
6138
6595
|
}
|
|
6139
6596
|
|
|
6140
6597
|
export declare function handleResponse<T>({ response, data, error }: {
|
|
@@ -6159,20 +6616,30 @@ declare const IncludeDeductionsSchema: v.ObjectSchema<{
|
|
|
6159
6616
|
|
|
6160
6617
|
declare type InferResponse<T, S> = T extends string ? Awaited<ReturnType<typeof handleResponse<S>>> : null;
|
|
6161
6618
|
|
|
6162
|
-
declare function Landing(
|
|
6619
|
+
export declare function Landing(): JSX_2.Element;
|
|
6620
|
+
|
|
6621
|
+
declare function Landing_2(props: SummaryProps_2 & BaseComponentInterface): JSX_2.Element;
|
|
6163
6622
|
|
|
6164
6623
|
declare type MODE = 'ADD' | 'LIST' | 'INITIAL' | 'EDIT';
|
|
6165
6624
|
|
|
6166
|
-
declare type MODE_2 = 'LIST' | '
|
|
6625
|
+
declare type MODE_2 = 'LIST' | 'ADD_ADDITIONAL_JOB' | 'ADD_INITIAL_JOB' | 'EDIT_ADDITIONAL_JOB' | 'EDIT_INITIAL_JOB' | 'PROCEED';
|
|
6167
6626
|
|
|
6168
6627
|
declare type MODE_3 = 'ADD' | 'LIST' | 'SPLIT' | 'INITIAL';
|
|
6169
6628
|
|
|
6629
|
+
declare type MODE_4 = 'LIST' | 'SIGN';
|
|
6630
|
+
|
|
6170
6631
|
declare type OnboardingFlow = 'self' | 'admin'
|
|
6171
6632
|
|
|
6172
|
-
declare function OnboardingSummary(
|
|
6633
|
+
export declare function OnboardingSummary(): JSX_2.Element;
|
|
6634
|
+
|
|
6635
|
+
declare function OnboardingSummary_2(props: SummaryProps & BaseComponentInterface): JSX_2.Element;
|
|
6636
|
+
|
|
6637
|
+
declare function OnboardingSummary_3(): JSX_2.Element;
|
|
6173
6638
|
|
|
6174
6639
|
declare const OnboardingSummaryContextual: () => JSX_2.Element;
|
|
6175
6640
|
|
|
6641
|
+
declare function OnboardingSummaryContextual_2(): JSX_2.Element;
|
|
6642
|
+
|
|
6176
6643
|
declare type OnError = Parameters<typeof useMutation>[0]['onError'];
|
|
6177
6644
|
|
|
6178
6645
|
declare type OnEventType<K, T> = (type: K, data?: T) => void;
|
|
@@ -6281,6 +6748,8 @@ declare interface operations {
|
|
|
6281
6748
|
trade_name?: string;
|
|
6282
6749
|
/** @description The employer identification number (EIN) of the company. */
|
|
6283
6750
|
ein?: string;
|
|
6751
|
+
/** @description Whether the company only supports contractors. Should be set to true if the company has no W-2 employees. If not passed, will default to false (i.e. the company will support both contractors and employees). */
|
|
6752
|
+
contractor_only?: boolean;
|
|
6284
6753
|
};
|
|
6285
6754
|
};
|
|
6286
6755
|
};
|
|
@@ -6333,6 +6802,33 @@ declare interface operations {
|
|
|
6333
6802
|
404: components["responses"]["Not-Found-Error-Object"];
|
|
6334
6803
|
};
|
|
6335
6804
|
};
|
|
6805
|
+
"put-v1-companies": {
|
|
6806
|
+
parameters: {
|
|
6807
|
+
query?: never;
|
|
6808
|
+
header?: {
|
|
6809
|
+
/** @description Determines the date-based API version associated with your API call. If none is provided, your application's [minimum API version](https://docs.gusto.com/embedded-payroll/docs/api-versioning#minimum-api-version) is used. */
|
|
6810
|
+
"X-Gusto-API-Version"?: components["parameters"]["VersionHeader"];
|
|
6811
|
+
};
|
|
6812
|
+
path: {
|
|
6813
|
+
/** @description The UUID of the company */
|
|
6814
|
+
company_id: components["parameters"]["company_id"];
|
|
6815
|
+
};
|
|
6816
|
+
cookie?: never;
|
|
6817
|
+
};
|
|
6818
|
+
requestBody?: {
|
|
6819
|
+
content: {
|
|
6820
|
+
"application/json": {
|
|
6821
|
+
/** @description Whether the company only supports contractors. Must be updated in order for the company to start supporting W-2 employees. Can only be updated from true to false. Note that updating this value will require additional onboarding steps to be completed in order for the company to support W-2 employees. */
|
|
6822
|
+
contractor_only: boolean;
|
|
6823
|
+
};
|
|
6824
|
+
};
|
|
6825
|
+
};
|
|
6826
|
+
responses: {
|
|
6827
|
+
200: components["responses"]["Company-Object"];
|
|
6828
|
+
404: components["responses"]["Not-Found-Error-Object"];
|
|
6829
|
+
422: components["responses"]["Unprocessable-Entity-Error-Object"];
|
|
6830
|
+
};
|
|
6831
|
+
};
|
|
6336
6832
|
"put-v1-partner-managed-companies-company-uuid-migrate": {
|
|
6337
6833
|
parameters: {
|
|
6338
6834
|
query?: never;
|
|
@@ -6484,7 +6980,7 @@ declare interface operations {
|
|
|
6484
6980
|
422: components["responses"]["Unprocessable-Entity-Error-Object"];
|
|
6485
6981
|
};
|
|
6486
6982
|
};
|
|
6487
|
-
"get-v1-companies-
|
|
6983
|
+
"get-v1-companies-attachment": {
|
|
6488
6984
|
parameters: {
|
|
6489
6985
|
query?: never;
|
|
6490
6986
|
header?: {
|
|
@@ -6494,16 +6990,18 @@ declare interface operations {
|
|
|
6494
6990
|
path: {
|
|
6495
6991
|
/** @description The UUID of the company */
|
|
6496
6992
|
company_id: components["parameters"]["company_id"];
|
|
6993
|
+
/** @description The UUID of the company attachment */
|
|
6994
|
+
company_attachment_uuid: components["parameters"]["company_attachment_uuid"];
|
|
6497
6995
|
};
|
|
6498
6996
|
cookie?: never;
|
|
6499
6997
|
};
|
|
6500
6998
|
requestBody?: never;
|
|
6501
6999
|
responses: {
|
|
6502
|
-
200: components["responses"]["
|
|
7000
|
+
200: components["responses"]["Company-Attachment-Object"];
|
|
6503
7001
|
404: components["responses"]["Not-Found-Error-Object"];
|
|
6504
7002
|
};
|
|
6505
7003
|
};
|
|
6506
|
-
"
|
|
7004
|
+
"get-v1-companies-attachment-url": {
|
|
6507
7005
|
parameters: {
|
|
6508
7006
|
query?: never;
|
|
6509
7007
|
header?: {
|
|
@@ -6513,13 +7011,117 @@ declare interface operations {
|
|
|
6513
7011
|
path: {
|
|
6514
7012
|
/** @description The UUID of the company */
|
|
6515
7013
|
company_id: components["parameters"]["company_id"];
|
|
7014
|
+
/** @description The UUID of the company attachment */
|
|
7015
|
+
company_attachment_uuid: components["parameters"]["company_attachment_uuid"];
|
|
6516
7016
|
};
|
|
6517
7017
|
cookie?: never;
|
|
6518
7018
|
};
|
|
6519
|
-
|
|
6520
|
-
|
|
6521
|
-
|
|
6522
|
-
|
|
7019
|
+
requestBody?: never;
|
|
7020
|
+
responses: {
|
|
7021
|
+
/** @description Example response */
|
|
7022
|
+
200: {
|
|
7023
|
+
headers: {
|
|
7024
|
+
[name: string]: unknown;
|
|
7025
|
+
};
|
|
7026
|
+
content: {
|
|
7027
|
+
"application/json": {
|
|
7028
|
+
/** @description A full Url to download a Company Attachment File */
|
|
7029
|
+
url: string;
|
|
7030
|
+
};
|
|
7031
|
+
};
|
|
7032
|
+
};
|
|
7033
|
+
404: components["responses"]["Not-Found-Error-Object"];
|
|
7034
|
+
};
|
|
7035
|
+
};
|
|
7036
|
+
"get-v1-companies-attachments": {
|
|
7037
|
+
parameters: {
|
|
7038
|
+
query?: never;
|
|
7039
|
+
header?: {
|
|
7040
|
+
/** @description Determines the date-based API version associated with your API call. If none is provided, your application's [minimum API version](https://docs.gusto.com/embedded-payroll/docs/api-versioning#minimum-api-version) is used. */
|
|
7041
|
+
"X-Gusto-API-Version"?: components["parameters"]["VersionHeader"];
|
|
7042
|
+
};
|
|
7043
|
+
path: {
|
|
7044
|
+
/** @description The UUID of the company */
|
|
7045
|
+
company_id: components["parameters"]["company_id"];
|
|
7046
|
+
};
|
|
7047
|
+
cookie?: never;
|
|
7048
|
+
};
|
|
7049
|
+
requestBody?: never;
|
|
7050
|
+
responses: {
|
|
7051
|
+
200: components["responses"]["Company-Attachment-List"];
|
|
7052
|
+
404: components["responses"]["Not-Found-Error-Object"];
|
|
7053
|
+
};
|
|
7054
|
+
};
|
|
7055
|
+
"post-v1-companies-attachment": {
|
|
7056
|
+
parameters: {
|
|
7057
|
+
query?: never;
|
|
7058
|
+
header?: {
|
|
7059
|
+
/** @description Determines the date-based API version associated with your API call. If none is provided, your application's [minimum API version](https://docs.gusto.com/embedded-payroll/docs/api-versioning#minimum-api-version) is used. */
|
|
7060
|
+
"X-Gusto-API-Version"?: components["parameters"]["VersionHeader"];
|
|
7061
|
+
};
|
|
7062
|
+
path: {
|
|
7063
|
+
/** @description The UUID of the company */
|
|
7064
|
+
company_id: components["parameters"]["company_id"];
|
|
7065
|
+
};
|
|
7066
|
+
cookie?: never;
|
|
7067
|
+
};
|
|
7068
|
+
requestBody?: {
|
|
7069
|
+
content: {
|
|
7070
|
+
"multipart/form-data": {
|
|
7071
|
+
/**
|
|
7072
|
+
* Format: binary
|
|
7073
|
+
* @description The binary payload of the file to be uploaded.
|
|
7074
|
+
*/
|
|
7075
|
+
document: string;
|
|
7076
|
+
/**
|
|
7077
|
+
* @description The category of a company attachment.
|
|
7078
|
+
* @enum {string}
|
|
7079
|
+
*/
|
|
7080
|
+
category: "gep_notice" | "compliance";
|
|
7081
|
+
};
|
|
7082
|
+
};
|
|
7083
|
+
};
|
|
7084
|
+
responses: {
|
|
7085
|
+
201: components["responses"]["Company-Attachment-Object"];
|
|
7086
|
+
404: components["responses"]["Not-Found-Error-Object"];
|
|
7087
|
+
};
|
|
7088
|
+
};
|
|
7089
|
+
"get-v1-companies-company_id-federal_tax_details": {
|
|
7090
|
+
parameters: {
|
|
7091
|
+
query?: never;
|
|
7092
|
+
header?: {
|
|
7093
|
+
/** @description Determines the date-based API version associated with your API call. If none is provided, your application's [minimum API version](https://docs.gusto.com/embedded-payroll/docs/api-versioning#minimum-api-version) is used. */
|
|
7094
|
+
"X-Gusto-API-Version"?: components["parameters"]["VersionHeader"];
|
|
7095
|
+
};
|
|
7096
|
+
path: {
|
|
7097
|
+
/** @description The UUID of the company */
|
|
7098
|
+
company_id: components["parameters"]["company_id"];
|
|
7099
|
+
};
|
|
7100
|
+
cookie?: never;
|
|
7101
|
+
};
|
|
7102
|
+
requestBody?: never;
|
|
7103
|
+
responses: {
|
|
7104
|
+
200: components["responses"]["Federal-Tax-Details-Object"];
|
|
7105
|
+
404: components["responses"]["Not-Found-Error-Object"];
|
|
7106
|
+
};
|
|
7107
|
+
};
|
|
7108
|
+
"put-v1-companies-company_id-federal_tax_details": {
|
|
7109
|
+
parameters: {
|
|
7110
|
+
query?: never;
|
|
7111
|
+
header?: {
|
|
7112
|
+
/** @description Determines the date-based API version associated with your API call. If none is provided, your application's [minimum API version](https://docs.gusto.com/embedded-payroll/docs/api-versioning#minimum-api-version) is used. */
|
|
7113
|
+
"X-Gusto-API-Version"?: components["parameters"]["VersionHeader"];
|
|
7114
|
+
};
|
|
7115
|
+
path: {
|
|
7116
|
+
/** @description The UUID of the company */
|
|
7117
|
+
company_id: components["parameters"]["company_id"];
|
|
7118
|
+
};
|
|
7119
|
+
cookie?: never;
|
|
7120
|
+
};
|
|
7121
|
+
/** @description Attributes related to federal tax details that can be updated via this endpoint include: */
|
|
7122
|
+
requestBody?: {
|
|
7123
|
+
content: {
|
|
7124
|
+
"application/json": {
|
|
6523
7125
|
/** @description The legal name of the company */
|
|
6524
7126
|
legal_name?: string;
|
|
6525
7127
|
/** @description The EIN of of the company */
|
|
@@ -6582,7 +7184,7 @@ declare interface operations {
|
|
|
6582
7184
|
content: {
|
|
6583
7185
|
"application/json": {
|
|
6584
7186
|
/** @description Industry title */
|
|
6585
|
-
title
|
|
7187
|
+
title?: string;
|
|
6586
7188
|
/** @description North American Industry Classification System (NAICS) is used to classify businesses with a six digit number based on the primary type of work the business performs */
|
|
6587
7189
|
naics_code: string;
|
|
6588
7190
|
/** @description A list of Standard Industrial Classification (SIC) codes, which are four digit number that categorize the industries that companies belong to based on their business activities. If sic_codes is not passed in, we will perform an internal lookup with naics_code. */
|
|
@@ -7511,13 +8113,13 @@ declare interface operations {
|
|
|
7511
8113
|
};
|
|
7512
8114
|
"get-v1-companies-company_id-pay_schedules-preview": {
|
|
7513
8115
|
parameters: {
|
|
7514
|
-
query
|
|
8116
|
+
query: {
|
|
7515
8117
|
/** @description The frequency that employees on this pay schedule are paid with Gusto. */
|
|
7516
|
-
frequency
|
|
8118
|
+
frequency: "Every week" | "Every other week" | "Twice per month" | "Monthly";
|
|
7517
8119
|
/** @description The first date that employees on this pay schedule are paid with Gusto. */
|
|
7518
|
-
anchor_pay_date
|
|
8120
|
+
anchor_pay_date: string;
|
|
7519
8121
|
/** @description The last date of the first pay period. This can be the same date as the anchor pay date. */
|
|
7520
|
-
anchor_end_of_pay_period
|
|
8122
|
+
anchor_end_of_pay_period: string;
|
|
7521
8123
|
/** @description An integer between 1 and 31 indicating the first day of the month that employees are paid. This field is only relevant for pay schedules with the “Twice per month” and “Monthly” frequencies. It will be null for pay schedules with other frequencies. */
|
|
7522
8124
|
day_1?: number;
|
|
7523
8125
|
/** @description An integer between 1 and 31 indicating the second day of the month that employees are paid. This field is the second pay date for pay schedules with the "Twice per month" frequency. For semi-monthly pay schedules, set this field to 31. For months shorter than 31 days, we will set the second pay date to the last day of the month. It will be null for pay schedules with other frequencies. */
|
|
@@ -7758,7 +8360,7 @@ declare interface operations {
|
|
|
7758
8360
|
/** @description Include the requested attribute(s) in each employee response, multiple options are comma separated. Available options:
|
|
7759
8361
|
* - all_compensations: Include all effective dated compensations for each job instead of only the current compensation
|
|
7760
8362
|
* - custom_fields: Include employees' custom fields */
|
|
7761
|
-
include?: "all_compensations" | "custom_fields";
|
|
8363
|
+
include?: ("all_compensations" | "custom_fields")[];
|
|
7762
8364
|
/** @description The page that is requested. When unspecified, will load all objects unless endpoint forces pagination. */
|
|
7763
8365
|
page?: components["parameters"]["pageParam"];
|
|
7764
8366
|
/** @description Number of objects per page. For majority of endpoints will default to 25 */
|
|
@@ -7806,6 +8408,7 @@ declare interface operations {
|
|
|
7806
8408
|
first_name: string;
|
|
7807
8409
|
middle_initial?: string;
|
|
7808
8410
|
last_name: string;
|
|
8411
|
+
preferred_first_name?: string;
|
|
7809
8412
|
date_of_birth?: string;
|
|
7810
8413
|
/** @description The employee's personal email address. */
|
|
7811
8414
|
email?: string;
|
|
@@ -7821,6 +8424,55 @@ declare interface operations {
|
|
|
7821
8424
|
422: components["responses"]["Unprocessable-Entity-Error-Object"];
|
|
7822
8425
|
};
|
|
7823
8426
|
};
|
|
8427
|
+
"put-v1-historical_employees": {
|
|
8428
|
+
parameters: {
|
|
8429
|
+
query?: never;
|
|
8430
|
+
header?: {
|
|
8431
|
+
/** @description Determines the date-based API version associated with your API call. If none is provided, your application's [minimum API version](https://docs.gusto.com/embedded-payroll/docs/api-versioning#minimum-api-version) is used. */
|
|
8432
|
+
"X-Gusto-API-Version"?: components["parameters"]["VersionHeader"];
|
|
8433
|
+
};
|
|
8434
|
+
path: {
|
|
8435
|
+
/** @description The UUID of the company */
|
|
8436
|
+
company_uuid: components["parameters"]["company_uuid"];
|
|
8437
|
+
};
|
|
8438
|
+
cookie?: never;
|
|
8439
|
+
};
|
|
8440
|
+
/** @description Update a historical employee. */
|
|
8441
|
+
requestBody?: {
|
|
8442
|
+
content: {
|
|
8443
|
+
"application/json": components["schemas"]["Versionable-Required"] & components["schemas"]["Historical-Employee-Body"];
|
|
8444
|
+
};
|
|
8445
|
+
};
|
|
8446
|
+
responses: {
|
|
8447
|
+
200: components["responses"]["Historical-Employee-Object"];
|
|
8448
|
+
404: components["responses"]["Not-Found-Error-Object"];
|
|
8449
|
+
};
|
|
8450
|
+
};
|
|
8451
|
+
"post-v1-historical_employees": {
|
|
8452
|
+
parameters: {
|
|
8453
|
+
query?: never;
|
|
8454
|
+
header?: {
|
|
8455
|
+
/** @description Determines the date-based API version associated with your API call. If none is provided, your application's [minimum API version](https://docs.gusto.com/embedded-payroll/docs/api-versioning#minimum-api-version) is used. */
|
|
8456
|
+
"X-Gusto-API-Version"?: components["parameters"]["VersionHeader"];
|
|
8457
|
+
};
|
|
8458
|
+
path: {
|
|
8459
|
+
/** @description The UUID of the company */
|
|
8460
|
+
company_uuid: components["parameters"]["company_uuid"];
|
|
8461
|
+
};
|
|
8462
|
+
cookie?: never;
|
|
8463
|
+
};
|
|
8464
|
+
/** @description Create a historical employee. */
|
|
8465
|
+
requestBody?: {
|
|
8466
|
+
content: {
|
|
8467
|
+
"application/json": components["schemas"]["Historical-Employee-Body"];
|
|
8468
|
+
};
|
|
8469
|
+
};
|
|
8470
|
+
responses: {
|
|
8471
|
+
201: components["responses"]["Historical-Employee-Object"];
|
|
8472
|
+
404: components["responses"]["Not-Found-Error-Object"];
|
|
8473
|
+
422: components["responses"]["Unprocessable-Entity-Error-Object"];
|
|
8474
|
+
};
|
|
8475
|
+
};
|
|
7824
8476
|
"get-companies-departments": {
|
|
7825
8477
|
parameters: {
|
|
7826
8478
|
query?: never;
|
|
@@ -8013,7 +8665,7 @@ declare interface operations {
|
|
|
8013
8665
|
/** @description Include the requested attribute(s) in each employee response, multiple options are comma separated. Available options:
|
|
8014
8666
|
* - all_compensations: Include all effective dated compensations for each job instead of only the current compensation
|
|
8015
8667
|
* - custom_fields: Include employees' custom fields */
|
|
8016
|
-
include?: "all_compensations" | "custom_fields";
|
|
8668
|
+
include?: ("all_compensations" | "custom_fields")[];
|
|
8017
8669
|
};
|
|
8018
8670
|
header?: {
|
|
8019
8671
|
/** @description Determines the date-based API version associated with your API call. If none is provided, your application's [minimum API version](https://docs.gusto.com/embedded-payroll/docs/api-versioning#minimum-api-version) is used. */
|
|
@@ -8053,6 +8705,7 @@ declare interface operations {
|
|
|
8053
8705
|
first_name?: string;
|
|
8054
8706
|
middle_initial?: string;
|
|
8055
8707
|
last_name?: string;
|
|
8708
|
+
preferred_first_name?: string;
|
|
8056
8709
|
date_of_birth?: string;
|
|
8057
8710
|
/** @description The employee's personal email address. */
|
|
8058
8711
|
email?: string;
|
|
@@ -8670,24 +9323,6 @@ declare interface operations {
|
|
|
8670
9323
|
422: components["responses"]["Unprocessable-Entity-Error-Object"];
|
|
8671
9324
|
};
|
|
8672
9325
|
};
|
|
8673
|
-
"put-v1-employee-finish-onboarding": {
|
|
8674
|
-
parameters: {
|
|
8675
|
-
query?: never;
|
|
8676
|
-
header?: {
|
|
8677
|
-
/** @description Determines the date-based API version associated with your API call. If none is provided, your application's [minimum API version](https://docs.gusto.com/embedded-payroll/docs/api-versioning#minimum-api-version) is used. */
|
|
8678
|
-
"X-Gusto-API-Version"?: components["parameters"]["VersionHeader"];
|
|
8679
|
-
};
|
|
8680
|
-
path: {
|
|
8681
|
-
/** @description The UUID of the employee */
|
|
8682
|
-
employee_id: components["parameters"]["employee_id"];
|
|
8683
|
-
};
|
|
8684
|
-
cookie?: never;
|
|
8685
|
-
};
|
|
8686
|
-
requestBody?: never;
|
|
8687
|
-
responses: {
|
|
8688
|
-
200: components["responses"]["Employee-Object"];
|
|
8689
|
-
};
|
|
8690
|
-
};
|
|
8691
9326
|
"get-v1-employees-employee_id-federal_taxes": {
|
|
8692
9327
|
parameters: {
|
|
8693
9328
|
query?: never;
|
|
@@ -9470,7 +10105,7 @@ declare interface operations {
|
|
|
9470
10105
|
};
|
|
9471
10106
|
};
|
|
9472
10107
|
responses: {
|
|
9473
|
-
201: components["responses"]["Contractor-Object"];
|
|
10108
|
+
201: components["responses"]["Created-Contractor-Object"];
|
|
9474
10109
|
404: components["responses"]["Not-Found-Error-Object"];
|
|
9475
10110
|
422: components["responses"]["Unprocessable-Entity-Error-Object"];
|
|
9476
10111
|
};
|
|
@@ -9831,6 +10466,131 @@ declare interface operations {
|
|
|
9831
10466
|
404: components["responses"]["Not-Found-Error-Object"];
|
|
9832
10467
|
};
|
|
9833
10468
|
};
|
|
10469
|
+
"get-v1-contractor-documents": {
|
|
10470
|
+
parameters: {
|
|
10471
|
+
query?: never;
|
|
10472
|
+
header?: {
|
|
10473
|
+
/** @description Determines the date-based API version associated with your API call. If none is provided, your application's [minimum API version](https://docs.gusto.com/embedded-payroll/docs/api-versioning#minimum-api-version) is used. */
|
|
10474
|
+
"X-Gusto-API-Version"?: components["parameters"]["VersionHeader"];
|
|
10475
|
+
};
|
|
10476
|
+
path: {
|
|
10477
|
+
/** @description The UUID of the contractor */
|
|
10478
|
+
contractor_uuid: components["parameters"]["contractor_uuid"];
|
|
10479
|
+
};
|
|
10480
|
+
cookie?: never;
|
|
10481
|
+
};
|
|
10482
|
+
requestBody?: never;
|
|
10483
|
+
responses: {
|
|
10484
|
+
/** @description Example response */
|
|
10485
|
+
200: {
|
|
10486
|
+
headers: {
|
|
10487
|
+
[name: string]: unknown;
|
|
10488
|
+
};
|
|
10489
|
+
content: {
|
|
10490
|
+
"application/json": components["schemas"]["Document"][];
|
|
10491
|
+
};
|
|
10492
|
+
};
|
|
10493
|
+
404: components["responses"]["Not-Found-Error-Object"];
|
|
10494
|
+
};
|
|
10495
|
+
};
|
|
10496
|
+
"get-v1-contractor-document": {
|
|
10497
|
+
parameters: {
|
|
10498
|
+
query?: never;
|
|
10499
|
+
header?: {
|
|
10500
|
+
/** @description Determines the date-based API version associated with your API call. If none is provided, your application's [minimum API version](https://docs.gusto.com/embedded-payroll/docs/api-versioning#minimum-api-version) is used. */
|
|
10501
|
+
"X-Gusto-API-Version"?: components["parameters"]["VersionHeader"];
|
|
10502
|
+
};
|
|
10503
|
+
path: {
|
|
10504
|
+
/** @description The ID or UUID of the document */
|
|
10505
|
+
document_uuid: components["parameters"]["document_uuid"];
|
|
10506
|
+
};
|
|
10507
|
+
cookie?: never;
|
|
10508
|
+
};
|
|
10509
|
+
requestBody?: never;
|
|
10510
|
+
responses: {
|
|
10511
|
+
/** @description Example response */
|
|
10512
|
+
200: {
|
|
10513
|
+
headers: {
|
|
10514
|
+
[name: string]: unknown;
|
|
10515
|
+
};
|
|
10516
|
+
content: {
|
|
10517
|
+
"application/json": components["schemas"]["Document"];
|
|
10518
|
+
};
|
|
10519
|
+
};
|
|
10520
|
+
404: components["responses"]["Not-Found-Error-Object"];
|
|
10521
|
+
};
|
|
10522
|
+
};
|
|
10523
|
+
"get-v1-contractor-document-pdf": {
|
|
10524
|
+
parameters: {
|
|
10525
|
+
query?: never;
|
|
10526
|
+
header?: {
|
|
10527
|
+
/** @description Determines the date-based API version associated with your API call. If none is provided, your application's [minimum API version](https://docs.gusto.com/embedded-payroll/docs/api-versioning#minimum-api-version) is used. */
|
|
10528
|
+
"X-Gusto-API-Version"?: components["parameters"]["VersionHeader"];
|
|
10529
|
+
};
|
|
10530
|
+
path: {
|
|
10531
|
+
/** @description The ID or UUID of the document */
|
|
10532
|
+
document_uuid: components["parameters"]["document_uuid"];
|
|
10533
|
+
};
|
|
10534
|
+
cookie?: never;
|
|
10535
|
+
};
|
|
10536
|
+
requestBody?: never;
|
|
10537
|
+
responses: {
|
|
10538
|
+
/** @description Example response */
|
|
10539
|
+
200: {
|
|
10540
|
+
headers: {
|
|
10541
|
+
[name: string]: unknown;
|
|
10542
|
+
};
|
|
10543
|
+
content: {
|
|
10544
|
+
"application/json": components["schemas"]["Document-Pdf"];
|
|
10545
|
+
};
|
|
10546
|
+
};
|
|
10547
|
+
404: components["responses"]["Not-Found-Error-Object"];
|
|
10548
|
+
};
|
|
10549
|
+
};
|
|
10550
|
+
"put-v1-contractor-document-sign": {
|
|
10551
|
+
parameters: {
|
|
10552
|
+
query?: never;
|
|
10553
|
+
header?: {
|
|
10554
|
+
/** @description Determines the date-based API version associated with your API call. If none is provided, your application's [minimum API version](https://docs.gusto.com/embedded-payroll/docs/api-versioning#minimum-api-version) is used. */
|
|
10555
|
+
"X-Gusto-API-Version"?: components["parameters"]["VersionHeader"];
|
|
10556
|
+
};
|
|
10557
|
+
path: {
|
|
10558
|
+
/** @description The ID or UUID of the document */
|
|
10559
|
+
document_uuid: components["parameters"]["document_uuid"];
|
|
10560
|
+
};
|
|
10561
|
+
cookie?: never;
|
|
10562
|
+
};
|
|
10563
|
+
requestBody?: {
|
|
10564
|
+
content: {
|
|
10565
|
+
"application/json": {
|
|
10566
|
+
/** @description List of fields and the values they will be set to. */
|
|
10567
|
+
fields: {
|
|
10568
|
+
/** @description Unique identifier of the field */
|
|
10569
|
+
key?: string;
|
|
10570
|
+
/** @description Value for the field */
|
|
10571
|
+
value?: string;
|
|
10572
|
+
}[];
|
|
10573
|
+
/** @description Whether you agree to sign electronically */
|
|
10574
|
+
agree: boolean;
|
|
10575
|
+
/** @description The IP address of the signatory who signed the form. */
|
|
10576
|
+
signed_by_ip_address: string;
|
|
10577
|
+
};
|
|
10578
|
+
};
|
|
10579
|
+
};
|
|
10580
|
+
responses: {
|
|
10581
|
+
/** @description Example response */
|
|
10582
|
+
200: {
|
|
10583
|
+
headers: {
|
|
10584
|
+
[name: string]: unknown;
|
|
10585
|
+
};
|
|
10586
|
+
content: {
|
|
10587
|
+
"application/json": components["schemas"]["Document-Signed"];
|
|
10588
|
+
};
|
|
10589
|
+
};
|
|
10590
|
+
404: components["responses"]["Not-Found-Error-Object"];
|
|
10591
|
+
422: components["responses"]["Unprocessable-Entity-Error-Object"];
|
|
10592
|
+
};
|
|
10593
|
+
};
|
|
9834
10594
|
"post-v1-sandbox-generate_1099": {
|
|
9835
10595
|
parameters: {
|
|
9836
10596
|
query?: never;
|
|
@@ -10066,6 +10826,8 @@ declare interface operations {
|
|
|
10066
10826
|
start_date?: string;
|
|
10067
10827
|
/** @description Return payrolls whose pay period is before the end date. If left empty, defaults to today's date. */
|
|
10068
10828
|
end_date?: string;
|
|
10829
|
+
/** @description A string indicating whether to sort resulting events in ascending (asc) or descending (desc) chronological order. Events are sorted by their `timestamp`. Defaults to asc if left empty. */
|
|
10830
|
+
sort_order?: components["parameters"]["sort_order"];
|
|
10069
10831
|
};
|
|
10070
10832
|
header?: {
|
|
10071
10833
|
/** @description Determines the date-based API version associated with your API call. If none is provided, your application's [minimum API version](https://docs.gusto.com/embedded-payroll/docs/api-versioning#minimum-api-version) is used. */
|
|
@@ -10162,7 +10924,7 @@ declare interface operations {
|
|
|
10162
10924
|
parameters: {
|
|
10163
10925
|
query?: {
|
|
10164
10926
|
/** @description Include the requested attribute in the response, for multiple attributes comma separate the values, i.e. `?include=benefits,deductions,taxes` */
|
|
10165
|
-
include?: "benefits" | "deductions" | "taxes" | "payroll_status_meta";
|
|
10927
|
+
include?: ("benefits" | "deductions" | "taxes" | "payroll_status_meta")[];
|
|
10166
10928
|
};
|
|
10167
10929
|
header?: {
|
|
10168
10930
|
/** @description Determines the date-based API version associated with your API call. If none is provided, your application's [minimum API version](https://docs.gusto.com/embedded-payroll/docs/api-versioning#minimum-api-version) is used. */
|
|
@@ -10220,7 +10982,7 @@ declare interface operations {
|
|
|
10220
10982
|
/** @description The amount of the compensation for the pay period. */
|
|
10221
10983
|
amount?: string;
|
|
10222
10984
|
/** @description The UUID of the job for the compensation. */
|
|
10223
|
-
job_uuid?:
|
|
10985
|
+
job_uuid?: string;
|
|
10224
10986
|
}[];
|
|
10225
10987
|
hourly_compensations?: {
|
|
10226
10988
|
/** @description The name of the compensation. This also serves as the unique, immutable identifier for this compensation. */
|
|
@@ -10228,7 +10990,7 @@ declare interface operations {
|
|
|
10228
10990
|
/** @description The number of hours to be compensated for this pay period. */
|
|
10229
10991
|
hours?: string;
|
|
10230
10992
|
/** @description The UUIDs of the job for the compensation. */
|
|
10231
|
-
job_uuid?:
|
|
10993
|
+
job_uuid?: string;
|
|
10232
10994
|
}[];
|
|
10233
10995
|
/** @description An array of all paid time off the employee is eligible for this pay period. Each paid time off object can be the name or the specific policy_uuid. */
|
|
10234
10996
|
paid_time_off?: {
|
|
@@ -10684,7 +11446,7 @@ declare interface operations {
|
|
|
10684
11446
|
contractor_uuid: string;
|
|
10685
11447
|
/**
|
|
10686
11448
|
* Format: date
|
|
10687
|
-
* @description
|
|
11449
|
+
* @description Date of contractor payment
|
|
10688
11450
|
* @example 2020-01-01
|
|
10689
11451
|
*/
|
|
10690
11452
|
date: string;
|
|
@@ -11070,7 +11832,7 @@ declare interface operations {
|
|
|
11070
11832
|
signature_text: string;
|
|
11071
11833
|
/** @description whether you agree to sign electronically */
|
|
11072
11834
|
agree: boolean;
|
|
11073
|
-
/** @description The IP address of the signatory who signed the form. */
|
|
11835
|
+
/** @description The IP address of the signatory who signed the form. Both IPv4 AND IPv6 are supported. */
|
|
11074
11836
|
signed_by_ip_address: string;
|
|
11075
11837
|
};
|
|
11076
11838
|
};
|
|
@@ -11164,7 +11926,7 @@ declare interface operations {
|
|
|
11164
11926
|
signature_text: string;
|
|
11165
11927
|
/** @description whether you agree to sign electronically */
|
|
11166
11928
|
agree: boolean;
|
|
11167
|
-
/** @description The IP address of the signatory who signed the form. */
|
|
11929
|
+
/** @description The IP address of the signatory who signed the form. Both IPv4 AND IPv6 are supported. */
|
|
11168
11930
|
signed_by_ip_address: string;
|
|
11169
11931
|
};
|
|
11170
11932
|
};
|
|
@@ -11288,9 +12050,9 @@ declare interface operations {
|
|
|
11288
12050
|
content: {
|
|
11289
12051
|
"application/json": {
|
|
11290
12052
|
/** @description Columns to include in the report */
|
|
11291
|
-
columns: ("bank_account_account_number" | "bank_account_routing_number" | "bank_account_type" | "bank_account" | "bonus" | "cash_tips" | "check_amount" | "check_date" | "commission" | "date_of_birth" | "double_overtime_earnings" | "double_overtime_hours" | "double_overtime_rate" | "employee_additional_taxes" | "employee_compensation_time_period" | "employee_compensation" | "employee_deductions" | "employee_department" | "employee_email" | "employee_federal_income_tax" | "employee_first_name" | "employee_last_name" | "employee_middle_initial" | "employee_medicare_additional_tax" | "employee_medicare_tax" | "employee_phone_number" | "employee_social_security_tax" | "employee_taxes" | "employee_work_email" | "employer_additional_taxes" | "
|
|
12053
|
+
columns: ("bank_account_account_number" | "bank_account_routing_number" | "bank_account_type" | "bank_account" | "bonus" | "cash_tips" | "check_amount" | "check_date" | "commission" | "date_of_birth" | "double_overtime_earnings" | "double_overtime_hours" | "double_overtime_rate" | "employee_additional_taxes" | "employee_benefit_contributions" | "employee_compensation_time_period" | "employee_compensation" | "employee_deductions" | "employee_department" | "employee_email" | "employee_federal_income_tax" | "employee_first_name" | "employee_last_name" | "employee_middle_initial" | "employee_medicare_additional_tax" | "employee_medicare_tax" | "employee_phone_number" | "employee_social_security_tax" | "employee_taxes" | "employee_work_email" | "employer_additional_taxes" | "employer_benefit_contributions" | "employer_cost" | "employer_futa_tax" | "employer_medicare_tax" | "employer_social_security_tax" | "employer_suta_tax" | "employer_taxes" | "employment_type" | "employment" | "end_date" | "garnishments" | "gross_earnings" | "holiday_earnings" | "holiday_hours" | "home_address_city" | "home_address_state" | "home_address_street" | "home_address_zip" | "home_address" | "job_title" | "net_pay" | "one_time_reimbursements" | "overtime_earnings" | "overtime_hours" | "overtime_rate" | "paid_time_off_earnings" | "paid_time_off_hours" | "paid_time_off_rate" | "pay_period_end" | "pay_period_start" | "paycheck_tips" | "payment_method" | "payroll_type" | "preferred_first_name" | "recurring_reimbursements" | "regular_earnings" | "regular_hours" | "regular_rate" | "reimbursements" | "risk_class_code" | "sick_rate" | "sick_time_off_earnings" | "sick_time_off_hours" | "start_date" | "total_employer_benefit_contributions" | "total_time_off_earnings" | "total_time_off_hours" | "work_address_city" | "work_address_street" | "work_address_zip")[];
|
|
11292
12054
|
/** @description How to group the report */
|
|
11293
|
-
groupings: ("payroll" | "employee" | "work_address")[];
|
|
12055
|
+
groupings: ("payroll" | "employee" | "work_address" | "work_address_state")[];
|
|
11294
12056
|
/** @description The title of the report */
|
|
11295
12057
|
custom_name?: string;
|
|
11296
12058
|
/**
|
|
@@ -11442,7 +12204,7 @@ declare interface operations {
|
|
|
11442
12204
|
* @default true
|
|
11443
12205
|
*/
|
|
11444
12206
|
active?: boolean;
|
|
11445
|
-
/** @description The description of the company benefit.For example, a company may offer multiple benefits with an ID of 1 (for Medical Insurance). The description would show something more specific like “Kaiser Permanente” or “Blue Cross/ Blue Shield”. */
|
|
12207
|
+
/** @description The description of the company benefit. For example, a company may offer multiple benefits with an ID of 1 (for Medical Insurance). The description would show something more specific like “Kaiser Permanente” or “Blue Cross/ Blue Shield”. */
|
|
11446
12208
|
description: string;
|
|
11447
12209
|
/** @description Whether the employer is subject to pay employer taxes when an employee is on leave. Only applicable to third party sick pay benefits. */
|
|
11448
12210
|
responsible_for_employer_taxes?: boolean;
|
|
@@ -11499,7 +12261,7 @@ declare interface operations {
|
|
|
11499
12261
|
version: string;
|
|
11500
12262
|
/** @description Whether this benefit is active for employee participation. Company benefits may only be deactivated if no employees are actively participating. */
|
|
11501
12263
|
active?: boolean;
|
|
11502
|
-
/** @description The description of the company benefit.For example, a company may offer multiple benefits with an ID of 1 (for Medical Insurance). The description would show something more specific like “Kaiser Permanente” or “Blue Cross/ Blue Shield”. */
|
|
12264
|
+
/** @description The description of the company benefit. For example, a company may offer multiple benefits with an ID of 1 (for Medical Insurance). The description would show something more specific like “Kaiser Permanente” or “Blue Cross/ Blue Shield”. */
|
|
11503
12265
|
description?: string;
|
|
11504
12266
|
};
|
|
11505
12267
|
};
|
|
@@ -11613,6 +12375,57 @@ declare interface operations {
|
|
|
11613
12375
|
404: components["responses"]["Not-Found-Error-Object"];
|
|
11614
12376
|
};
|
|
11615
12377
|
};
|
|
12378
|
+
"get-v1-company_benefits-company_benefit_id-employee_benefits": {
|
|
12379
|
+
parameters: {
|
|
12380
|
+
query?: {
|
|
12381
|
+
/** @description The page that is requested. When unspecified, will load all objects unless endpoint forces pagination. */
|
|
12382
|
+
page?: components["parameters"]["pageParam"];
|
|
12383
|
+
/** @description Number of objects per page. For majority of endpoints will default to 25 */
|
|
12384
|
+
per?: components["parameters"]["perParam"];
|
|
12385
|
+
};
|
|
12386
|
+
header?: {
|
|
12387
|
+
/** @description Determines the date-based API version associated with your API call. If none is provided, your application's [minimum API version](https://docs.gusto.com/embedded-payroll/docs/api-versioning#minimum-api-version) is used. */
|
|
12388
|
+
"X-Gusto-API-Version"?: components["parameters"]["VersionHeader"];
|
|
12389
|
+
};
|
|
12390
|
+
path: {
|
|
12391
|
+
/** @description The UUID of the company benefit */
|
|
12392
|
+
company_benefit_id: components["parameters"]["company_benefit_id"];
|
|
12393
|
+
};
|
|
12394
|
+
cookie?: never;
|
|
12395
|
+
};
|
|
12396
|
+
requestBody?: never;
|
|
12397
|
+
responses: {
|
|
12398
|
+
200: components["responses"]["Employee-Benefit-List"];
|
|
12399
|
+
404: components["responses"]["Not-Found-Error-Object"];
|
|
12400
|
+
};
|
|
12401
|
+
};
|
|
12402
|
+
"put-v1-company_benefits-company_benefit_id-employee_benefits": {
|
|
12403
|
+
parameters: {
|
|
12404
|
+
query?: never;
|
|
12405
|
+
header?: {
|
|
12406
|
+
/** @description Determines the date-based API version associated with your API call. If none is provided, your application's [minimum API version](https://docs.gusto.com/embedded-payroll/docs/api-versioning#minimum-api-version) is used. */
|
|
12407
|
+
"X-Gusto-API-Version"?: components["parameters"]["VersionHeader"];
|
|
12408
|
+
};
|
|
12409
|
+
path: {
|
|
12410
|
+
/** @description The UUID of the company benefit */
|
|
12411
|
+
company_benefit_id: components["parameters"]["company_benefit_id"];
|
|
12412
|
+
};
|
|
12413
|
+
cookie?: never;
|
|
12414
|
+
};
|
|
12415
|
+
requestBody?: {
|
|
12416
|
+
content: {
|
|
12417
|
+
"application/json": {
|
|
12418
|
+
/** @description The list of employee benefits to create or update */
|
|
12419
|
+
employee_benefits?: components["schemas"]["Employee-Benefit-For-Company-Benefit"][];
|
|
12420
|
+
};
|
|
12421
|
+
};
|
|
12422
|
+
};
|
|
12423
|
+
responses: {
|
|
12424
|
+
200: components["responses"]["Employee-Benefit-List"];
|
|
12425
|
+
404: components["responses"]["Not-Found-Error-Object"];
|
|
12426
|
+
422: components["responses"]["Unprocessable-Entity-Error-Object"];
|
|
12427
|
+
};
|
|
12428
|
+
};
|
|
11616
12429
|
"get-v1-benefits-benefits_id-requirements": {
|
|
11617
12430
|
parameters: {
|
|
11618
12431
|
query?: never;
|
|
@@ -11990,9 +12803,14 @@ declare interface operations {
|
|
|
11990
12803
|
*/
|
|
11991
12804
|
amount: string;
|
|
11992
12805
|
/** @description The description of the garnishment. */
|
|
11993
|
-
description
|
|
12806
|
+
description?: string;
|
|
11994
12807
|
/** @description Whether the garnishment is court ordered. */
|
|
11995
12808
|
court_ordered: boolean;
|
|
12809
|
+
/**
|
|
12810
|
+
* @description The specific type of garnishment for court ordered garnishments.
|
|
12811
|
+
* @enum {string|null}
|
|
12812
|
+
*/
|
|
12813
|
+
garnishment_type?: "child_support" | "federal_tax_lien" | "state_tax_lien" | "student_loan" | "creditor_garnishment" | "federal_loan" | "other_garnishment" | null;
|
|
11996
12814
|
/**
|
|
11997
12815
|
* @description The number of times to apply the garnishment. Ignored if recurring is true.
|
|
11998
12816
|
* @default null
|
|
@@ -12020,6 +12838,12 @@ declare interface operations {
|
|
|
12020
12838
|
* @default false
|
|
12021
12839
|
*/
|
|
12022
12840
|
deduct_as_percentage?: boolean;
|
|
12841
|
+
/**
|
|
12842
|
+
* Format: float
|
|
12843
|
+
* @description A maximum total deduction for the lifetime of this garnishment. A null value indicates no maximum.
|
|
12844
|
+
*/
|
|
12845
|
+
total_amount?: string;
|
|
12846
|
+
child_support?: components["schemas"]["Garnishment-Child-Support"];
|
|
12023
12847
|
};
|
|
12024
12848
|
};
|
|
12025
12849
|
};
|
|
@@ -12105,6 +12929,12 @@ declare interface operations {
|
|
|
12105
12929
|
* @default false
|
|
12106
12930
|
*/
|
|
12107
12931
|
deduct_as_percentage?: boolean;
|
|
12932
|
+
/**
|
|
12933
|
+
* Format: float
|
|
12934
|
+
* @description A maximum total deduction for the lifetime of this garnishment. A null value indicates no maximum.
|
|
12935
|
+
*/
|
|
12936
|
+
total_amount?: string;
|
|
12937
|
+
child_support?: components["schemas"]["Garnishment-Child-Support"];
|
|
12108
12938
|
/** @description The current version of the object. See the [versioning guide](https://docs.gusto.com/embedded-payroll/docs/versioning#object-layer) for information on how to use this field. */
|
|
12109
12939
|
version: string;
|
|
12110
12940
|
};
|
|
@@ -12116,6 +12946,22 @@ declare interface operations {
|
|
|
12116
12946
|
422: components["responses"]["Unprocessable-Entity-Error-Object"];
|
|
12117
12947
|
};
|
|
12118
12948
|
};
|
|
12949
|
+
"get-v1-garnishments-child_support": {
|
|
12950
|
+
parameters: {
|
|
12951
|
+
query?: never;
|
|
12952
|
+
header?: {
|
|
12953
|
+
/** @description Determines the date-based API version associated with your API call. If none is provided, your application's [minimum API version](https://docs.gusto.com/embedded-payroll/docs/api-versioning#minimum-api-version) is used. */
|
|
12954
|
+
"X-Gusto-API-Version"?: components["parameters"]["VersionHeader"];
|
|
12955
|
+
};
|
|
12956
|
+
path?: never;
|
|
12957
|
+
cookie?: never;
|
|
12958
|
+
};
|
|
12959
|
+
requestBody?: never;
|
|
12960
|
+
responses: {
|
|
12961
|
+
200: components["responses"]["Child-Support-Data-Object"];
|
|
12962
|
+
404: components["responses"]["Not-Found-Error-Object"];
|
|
12963
|
+
};
|
|
12964
|
+
};
|
|
12119
12965
|
"post-v1-plaid-processor_token": {
|
|
12120
12966
|
parameters: {
|
|
12121
12967
|
query?: never;
|
|
@@ -12383,18 +13229,18 @@ declare interface operations {
|
|
|
12383
13229
|
* @description The number of hours an employee has to work or be paid for to accrue the number of hours set in the accrual rate. Only used for hourly policies (per_hour_paid, per_hour_paid_no_overtime, per_hour_work, per_hour_worked_no_overtime). Represented as a float, e.g. "40.0".
|
|
12384
13230
|
*/
|
|
12385
13231
|
accrual_rate_unit?: string;
|
|
12386
|
-
/** @description Boolean representing if an
|
|
13232
|
+
/** @description Boolean representing if an employee's accrued time off hours will be paid out on termination */
|
|
12387
13233
|
paid_out_on_termination?: boolean;
|
|
12388
13234
|
/** @description Number of days before an employee on the policy will begin accruing time off hours. If accrual_method is per_anniversary_year, per_calendar_year, or unlimited, then accrual_waiting_period_days should be 0. */
|
|
12389
13235
|
accrual_waiting_period_days?: number;
|
|
12390
13236
|
/**
|
|
12391
13237
|
* Format: float
|
|
12392
|
-
* @description The max number of hours
|
|
13238
|
+
* @description The max number of hours an employee can carryover from one year to the next. If accrual_method is unlimited, then carryover_limit_hours must be blank.
|
|
12393
13239
|
*/
|
|
12394
13240
|
carryover_limit_hours?: string;
|
|
12395
13241
|
/**
|
|
12396
13242
|
* Format: float
|
|
12397
|
-
* @description The max number of hours
|
|
13243
|
+
* @description The max number of hours an employee can accrue in a year. If accrual_method is unlimited, then max_accrual_hours_per_year must be blank.
|
|
12398
13244
|
*/
|
|
12399
13245
|
max_accrual_hours_per_year?: string;
|
|
12400
13246
|
/**
|
|
@@ -12474,18 +13320,18 @@ declare interface operations {
|
|
|
12474
13320
|
* @description The number of hours an employee has to work or be paid for to accrue the number of hours set in the accrual rate. Only used for hourly policies (per_hour_paid, per_hour_paid_no_overtime, per_hour_work, per_hour_worked_no_overtime). Represented as a float, e.g. "40.0".
|
|
12475
13321
|
*/
|
|
12476
13322
|
accrual_rate_unit?: string;
|
|
12477
|
-
/** @description Boolean representing if an
|
|
13323
|
+
/** @description Boolean representing if an employee's accrued time off hours will be paid out on termination */
|
|
12478
13324
|
paid_out_on_termination?: boolean;
|
|
12479
13325
|
/** @description Number of days before an employee on the policy will begin accruing time off hours. If accrual_method is per_anniversary_year, per_calendar_year, or unlimited, then accrual_waiting_period_days should be 0. */
|
|
12480
13326
|
accrual_waiting_period_days?: number;
|
|
12481
13327
|
/**
|
|
12482
13328
|
* Format: float
|
|
12483
|
-
* @description The max number of hours
|
|
13329
|
+
* @description The max number of hours an employee can carryover from one year to the next. If accrual_method is unlimited, then carryover_limit_hours must be blank.
|
|
12484
13330
|
*/
|
|
12485
13331
|
carryover_limit_hours?: string;
|
|
12486
13332
|
/**
|
|
12487
13333
|
* Format: float
|
|
12488
|
-
* @description The max number of hours
|
|
13334
|
+
* @description The max number of hours an employee can accrue in a year. If accrual_method is unlimited, then max_accrual_hours_per_year must be blank.
|
|
12489
13335
|
*/
|
|
12490
13336
|
max_accrual_hours_per_year?: string;
|
|
12491
13337
|
/**
|
|
@@ -12919,7 +13765,7 @@ declare interface operations {
|
|
|
12919
13765
|
"X-Gusto-API-Version"?: components["parameters"]["VersionHeader"];
|
|
12920
13766
|
};
|
|
12921
13767
|
path: {
|
|
12922
|
-
/** @description The
|
|
13768
|
+
/** @description The notification entity_uuid */
|
|
12923
13769
|
notification_uuid: components["parameters"]["notification_uuid"];
|
|
12924
13770
|
};
|
|
12925
13771
|
cookie?: never;
|
|
@@ -13192,10 +14038,16 @@ declare interface paths {
|
|
|
13192
14038
|
* The company_admin:read scope is required to return primary_payroll_admin.
|
|
13193
14039
|
* The signatories:read scope is required to return primary_signatory.
|
|
13194
14040
|
*
|
|
13195
|
-
* scope: `companies:read`
|
|
14041
|
+
* scope: `companies:read`
|
|
14042
|
+
*/
|
|
14043
|
+
get: operations["get-v1-companies"];
|
|
14044
|
+
/**
|
|
14045
|
+
* Update a company
|
|
14046
|
+
* @description Update a company.
|
|
14047
|
+
*
|
|
14048
|
+
* scope: `companies:write`
|
|
13196
14049
|
*/
|
|
13197
|
-
|
|
13198
|
-
put?: never;
|
|
14050
|
+
put: operations["put-v1-companies"];
|
|
13199
14051
|
post?: never;
|
|
13200
14052
|
delete?: never;
|
|
13201
14053
|
options?: never;
|
|
@@ -13298,6 +14150,81 @@ declare interface paths {
|
|
|
13298
14150
|
patch?: never;
|
|
13299
14151
|
trace?: never;
|
|
13300
14152
|
};
|
|
14153
|
+
"/v1/companies/{company_id}/attachments/{company_attachment_uuid}": {
|
|
14154
|
+
parameters: {
|
|
14155
|
+
query?: never;
|
|
14156
|
+
header?: never;
|
|
14157
|
+
path?: never;
|
|
14158
|
+
cookie?: never;
|
|
14159
|
+
};
|
|
14160
|
+
/**
|
|
14161
|
+
* Get Company Attachment Details
|
|
14162
|
+
* @description Retrieve the detail of an attachment uploaded by the company.
|
|
14163
|
+
*
|
|
14164
|
+
* scope: `company_attachments:read`
|
|
14165
|
+
*/
|
|
14166
|
+
get: operations["get-v1-companies-attachment"];
|
|
14167
|
+
put?: never;
|
|
14168
|
+
post?: never;
|
|
14169
|
+
delete?: never;
|
|
14170
|
+
options?: never;
|
|
14171
|
+
head?: never;
|
|
14172
|
+
patch?: never;
|
|
14173
|
+
trace?: never;
|
|
14174
|
+
};
|
|
14175
|
+
"/v1/companies/{company_id}/attachments/{company_attachment_uuid}/download_url": {
|
|
14176
|
+
parameters: {
|
|
14177
|
+
query?: never;
|
|
14178
|
+
header?: never;
|
|
14179
|
+
path?: never;
|
|
14180
|
+
cookie?: never;
|
|
14181
|
+
};
|
|
14182
|
+
/**
|
|
14183
|
+
* Get a temporary url to download the Company Attachment file
|
|
14184
|
+
* @description Retrieve a temporary url to download a attachment file uploaded
|
|
14185
|
+
* by the company.
|
|
14186
|
+
*
|
|
14187
|
+
* scope: `company_attachments:read`
|
|
14188
|
+
*/
|
|
14189
|
+
get: operations["get-v1-companies-attachment-url"];
|
|
14190
|
+
put?: never;
|
|
14191
|
+
post?: never;
|
|
14192
|
+
delete?: never;
|
|
14193
|
+
options?: never;
|
|
14194
|
+
head?: never;
|
|
14195
|
+
patch?: never;
|
|
14196
|
+
trace?: never;
|
|
14197
|
+
};
|
|
14198
|
+
"/v1/companies/{company_id}/attachments": {
|
|
14199
|
+
parameters: {
|
|
14200
|
+
query?: never;
|
|
14201
|
+
header?: never;
|
|
14202
|
+
path?: never;
|
|
14203
|
+
cookie?: never;
|
|
14204
|
+
};
|
|
14205
|
+
/**
|
|
14206
|
+
* Get List of Company Attachments
|
|
14207
|
+
* @description Retrieve a list of all the attachments uploaded by the company.
|
|
14208
|
+
*
|
|
14209
|
+
* scope: `company_attachments:read`
|
|
14210
|
+
*/
|
|
14211
|
+
get: operations["get-v1-companies-attachments"];
|
|
14212
|
+
put?: never;
|
|
14213
|
+
/**
|
|
14214
|
+
* Create Company Attachment and Upload File
|
|
14215
|
+
* @description Upload a file and create a company attachment. We recommend uploading
|
|
14216
|
+
* PDF files for optimal compatibility. However, the following file types are
|
|
14217
|
+
* allowed: .qbb, .qbm, .gif, .jpg, .png, .pdf, .xls, .xlsx, .doc and .docx.
|
|
14218
|
+
*
|
|
14219
|
+
* scope: `company_attachments:write`
|
|
14220
|
+
*/
|
|
14221
|
+
post: operations["post-v1-companies-attachment"];
|
|
14222
|
+
delete?: never;
|
|
14223
|
+
options?: never;
|
|
14224
|
+
head?: never;
|
|
14225
|
+
patch?: never;
|
|
14226
|
+
trace?: never;
|
|
14227
|
+
};
|
|
13301
14228
|
"/v1/companies/{company_id}/federal_tax_details": {
|
|
13302
14229
|
parameters: {
|
|
13303
14230
|
query?: never;
|
|
@@ -13498,7 +14425,7 @@ declare interface paths {
|
|
|
13498
14425
|
* @description Finalize a given company's onboarding process.
|
|
13499
14426
|
*
|
|
13500
14427
|
* ### Approve a company in demo
|
|
13501
|
-
* After a company is finished onboarding, Gusto requires an additional step to review and approve that company.
|
|
14428
|
+
* After a company is finished onboarding, Gusto requires an additional step to review and approve that company. The company onboarding status is `"onboarding_completed": false`, until the API call is made to finish company onboarding.
|
|
13502
14429
|
* In production environments, this step is required for risk-analysis purposes.
|
|
13503
14430
|
*
|
|
13504
14431
|
* We provide the endpoint `PUT '/v1/companies/{company_uuid}/approve'` to facilitate company approvals in the demo environment.
|
|
@@ -14066,7 +14993,8 @@ declare interface paths {
|
|
|
14066
14993
|
put?: never;
|
|
14067
14994
|
/**
|
|
14068
14995
|
* Assign pay schedules for a company
|
|
14069
|
-
* @description This
|
|
14996
|
+
* @description This endpoint assigns employees to pay schedules based on the schedule type.
|
|
14997
|
+
* For `by_employee` and `by_department` schedules, use the `partial_assignment` parameter to control the assignment scope. Set it to `true` for partial assignments (only some employees or departments at a time) and `false` for full assignments (all employees or departments at once).
|
|
14070
14998
|
*
|
|
14071
14999
|
* scope: `pay_schedules:write`
|
|
14072
15000
|
*/
|
|
@@ -14105,6 +15033,34 @@ declare interface paths {
|
|
|
14105
15033
|
patch?: never;
|
|
14106
15034
|
trace?: never;
|
|
14107
15035
|
};
|
|
15036
|
+
"/v1/companies/{company_uuid}/historical_employees": {
|
|
15037
|
+
parameters: {
|
|
15038
|
+
query?: never;
|
|
15039
|
+
header?: never;
|
|
15040
|
+
path?: never;
|
|
15041
|
+
cookie?: never;
|
|
15042
|
+
};
|
|
15043
|
+
get?: never;
|
|
15044
|
+
/**
|
|
15045
|
+
* Update a historical employee
|
|
15046
|
+
* @description Update a historical employee, an employee that was previously dismissed from the company in the current year.
|
|
15047
|
+
*
|
|
15048
|
+
* scope: `employees:manage`
|
|
15049
|
+
*/
|
|
15050
|
+
put: operations["put-v1-historical_employees"];
|
|
15051
|
+
/**
|
|
15052
|
+
* Create a historical employee
|
|
15053
|
+
* @description Create a historical employee, an employee that was previously dismissed from the company in the current year.
|
|
15054
|
+
*
|
|
15055
|
+
* scope: `employees:manage`
|
|
15056
|
+
*/
|
|
15057
|
+
post: operations["post-v1-historical_employees"];
|
|
15058
|
+
delete?: never;
|
|
15059
|
+
options?: never;
|
|
15060
|
+
head?: never;
|
|
15061
|
+
patch?: never;
|
|
15062
|
+
trace?: never;
|
|
15063
|
+
};
|
|
14108
15064
|
"/v1/companies/{company_uuid}/departments": {
|
|
14109
15065
|
parameters: {
|
|
14110
15066
|
query?: never;
|
|
@@ -14604,28 +15560,6 @@ declare interface paths {
|
|
|
14604
15560
|
patch?: never;
|
|
14605
15561
|
trace?: never;
|
|
14606
15562
|
};
|
|
14607
|
-
"/v1/employees/{employee_id}/finish_onboarding": {
|
|
14608
|
-
parameters: {
|
|
14609
|
-
query?: never;
|
|
14610
|
-
header?: never;
|
|
14611
|
-
path?: never;
|
|
14612
|
-
cookie?: never;
|
|
14613
|
-
};
|
|
14614
|
-
get?: never;
|
|
14615
|
-
/**
|
|
14616
|
-
* Finish onboarding an employee
|
|
14617
|
-
* @description This endpoint is currently supported but will eventually be deprecated; please use `/v1/employees/{employee_id}/onboarding_status` instead.
|
|
14618
|
-
*
|
|
14619
|
-
* Call this endpoint as the very last step of employee onboarding to complete their onboarding. When successful, the employee's `onboarded` attribute will be updated to true, indicating that they can be included in company's payrolls.
|
|
14620
|
-
*/
|
|
14621
|
-
put: operations["put-v1-employee-finish-onboarding"];
|
|
14622
|
-
post?: never;
|
|
14623
|
-
delete?: never;
|
|
14624
|
-
options?: never;
|
|
14625
|
-
head?: never;
|
|
14626
|
-
patch?: never;
|
|
14627
|
-
trace?: never;
|
|
14628
|
-
};
|
|
14629
15563
|
"/v1/employees/{employee_uuid}/federal_taxes": {
|
|
14630
15564
|
parameters: {
|
|
14631
15565
|
query?: never;
|
|
@@ -15305,6 +16239,94 @@ declare interface paths {
|
|
|
15305
16239
|
patch?: never;
|
|
15306
16240
|
trace?: never;
|
|
15307
16241
|
};
|
|
16242
|
+
"/v1/contractors/{contractor_uuid}/documents": {
|
|
16243
|
+
parameters: {
|
|
16244
|
+
query?: never;
|
|
16245
|
+
header?: never;
|
|
16246
|
+
path?: never;
|
|
16247
|
+
cookie?: never;
|
|
16248
|
+
};
|
|
16249
|
+
/**
|
|
16250
|
+
* Get all contractor documents
|
|
16251
|
+
* @description Get a list of all contractor's documents
|
|
16252
|
+
*
|
|
16253
|
+
* scope: `contractor_documents:read`
|
|
16254
|
+
*/
|
|
16255
|
+
get: operations["get-v1-contractor-documents"];
|
|
16256
|
+
put?: never;
|
|
16257
|
+
post?: never;
|
|
16258
|
+
delete?: never;
|
|
16259
|
+
options?: never;
|
|
16260
|
+
head?: never;
|
|
16261
|
+
patch?: never;
|
|
16262
|
+
trace?: never;
|
|
16263
|
+
};
|
|
16264
|
+
"/v1/documents/{document_uuid}": {
|
|
16265
|
+
parameters: {
|
|
16266
|
+
query?: never;
|
|
16267
|
+
header?: never;
|
|
16268
|
+
path?: never;
|
|
16269
|
+
cookie?: never;
|
|
16270
|
+
};
|
|
16271
|
+
/**
|
|
16272
|
+
* Get a contractor document
|
|
16273
|
+
* @description Get a contractor document.
|
|
16274
|
+
*
|
|
16275
|
+
* scope: `contractor_documents:read`
|
|
16276
|
+
*/
|
|
16277
|
+
get: operations["get-v1-contractor-document"];
|
|
16278
|
+
put?: never;
|
|
16279
|
+
post?: never;
|
|
16280
|
+
delete?: never;
|
|
16281
|
+
options?: never;
|
|
16282
|
+
head?: never;
|
|
16283
|
+
patch?: never;
|
|
16284
|
+
trace?: never;
|
|
16285
|
+
};
|
|
16286
|
+
"/v1/documents/{document_uuid}/pdf": {
|
|
16287
|
+
parameters: {
|
|
16288
|
+
query?: never;
|
|
16289
|
+
header?: never;
|
|
16290
|
+
path?: never;
|
|
16291
|
+
cookie?: never;
|
|
16292
|
+
};
|
|
16293
|
+
/**
|
|
16294
|
+
* Get the contractor document pdf
|
|
16295
|
+
* @description Get the contractor document pdf.
|
|
16296
|
+
*
|
|
16297
|
+
* scope: `contractor_documents:read`
|
|
16298
|
+
*/
|
|
16299
|
+
get: operations["get-v1-contractor-document-pdf"];
|
|
16300
|
+
put?: never;
|
|
16301
|
+
post?: never;
|
|
16302
|
+
delete?: never;
|
|
16303
|
+
options?: never;
|
|
16304
|
+
head?: never;
|
|
16305
|
+
patch?: never;
|
|
16306
|
+
trace?: never;
|
|
16307
|
+
};
|
|
16308
|
+
"/v1/documents/{document_uuid}/sign": {
|
|
16309
|
+
parameters: {
|
|
16310
|
+
query?: never;
|
|
16311
|
+
header?: never;
|
|
16312
|
+
path?: never;
|
|
16313
|
+
cookie?: never;
|
|
16314
|
+
};
|
|
16315
|
+
get?: never;
|
|
16316
|
+
/**
|
|
16317
|
+
* Sign a contractor document
|
|
16318
|
+
* @description Sign a contractor document.
|
|
16319
|
+
*
|
|
16320
|
+
* scope: `contractor_documents:write`
|
|
16321
|
+
*/
|
|
16322
|
+
put: operations["put-v1-contractor-document-sign"];
|
|
16323
|
+
post?: never;
|
|
16324
|
+
delete?: never;
|
|
16325
|
+
options?: never;
|
|
16326
|
+
head?: never;
|
|
16327
|
+
patch?: never;
|
|
16328
|
+
trace?: never;
|
|
16329
|
+
};
|
|
15308
16330
|
"/v1/sandbox/generate_1099": {
|
|
15309
16331
|
parameters: {
|
|
15310
16332
|
query?: never;
|
|
@@ -15447,7 +16469,7 @@ declare interface paths {
|
|
|
15447
16469
|
* | Invite a contractor to self-onboard | `admin_onboarding_incomplete` or `self_onboarding_not_invited` | `self_onboarding_invited` |
|
|
15448
16470
|
* | Cancel a contractor's self-onboarding | `self_onboarding_invited` or `self_onboarding_not_invited` | `admin_onboarding_incomplete` |
|
|
15449
16471
|
* | Review a contractor's self-onboarded info | `self_onboarding_started` | `self_onboarding_review` |
|
|
15450
|
-
* | Finish a contractor's onboarding | `
|
|
16472
|
+
* | Finish a contractor's onboarding | `admin_onboarding_review` or `self_onboarding_review` | `onboarding_completed` |
|
|
15451
16473
|
*/
|
|
15452
16474
|
put: operations["put-v1-contractors-contractor_uuid-onboarding_status"];
|
|
15453
16475
|
post?: never;
|
|
@@ -15511,9 +16533,12 @@ declare interface paths {
|
|
|
15511
16533
|
* @description Creates a new, unprocessed, off-cycle payroll.
|
|
15512
16534
|
*
|
|
15513
16535
|
* ## `off_cycle_reason`
|
|
16536
|
+
* By default:
|
|
15514
16537
|
* - External benefits and deductions will be included when the `off_cycle_reason` is set to `Correction`.
|
|
15515
16538
|
* - All benefits and deductions are blocked when the `off_cycle_reason` is set to `Bonus`.
|
|
15516
16539
|
*
|
|
16540
|
+
* These elections can be overridden with the `skip_regular_deductions` boolean.
|
|
16541
|
+
*
|
|
15517
16542
|
* scope: `payrolls:run`
|
|
15518
16543
|
*/
|
|
15519
16544
|
post: operations["post-v1-companies-company_id-payrolls"];
|
|
@@ -15561,7 +16586,6 @@ declare interface paths {
|
|
|
15561
16586
|
* * Hours are represented to the thousands place; dollar amounts are represented to the cent.
|
|
15562
16587
|
* * Every eligible compensation is returned for each employee. If no data has yet be inserted for a given field, it defaults to “0.00” (for fixed amounts) or “0.000” (for hours ).
|
|
15563
16588
|
* * To return future payrolls, you must include an `end_date` in the future.
|
|
15564
|
-
* * To return future payrolls, you must include an `end_date` in the future.
|
|
15565
16589
|
* * When include parameter with benefits value is passed, employee_benefits:read scope is required to return benefits
|
|
15566
16590
|
* * Benefits containing PHI are only visible with the `employee_benefits:read:phi` scope
|
|
15567
16591
|
*
|
|
@@ -15840,6 +16864,8 @@ declare interface paths {
|
|
|
15840
16864
|
* Submit payroll
|
|
15841
16865
|
* @description Submits an unprocessed payroll to be calculated and run. This submission is asynchronous and a successful request responds with a 202 HTTP status. Upon success, transitions the payroll to the `processed` state.
|
|
15842
16866
|
*
|
|
16867
|
+
* You should poll to ensure that payroll is processed successfully, as async errors only occur after async processing is complete.
|
|
16868
|
+
*
|
|
15843
16869
|
* If the company is blocked from running payroll due to issues like incomplete setup, missing information or other compliance issues, the response will be 422 Unprocessable Entity with a categorization of the blockers as described in the error responses.
|
|
15844
16870
|
*
|
|
15845
16871
|
* scope: `payrolls:run`
|
|
@@ -15922,7 +16948,7 @@ declare interface paths {
|
|
|
15922
16948
|
post?: never;
|
|
15923
16949
|
/**
|
|
15924
16950
|
* Cancel a contractor payment
|
|
15925
|
-
* @description Cancels and deletes a contractor payment. If the contractor payment has already started processing, the payment cannot be cancelled.
|
|
16951
|
+
* @description Cancels and deletes a contractor payment. If the contractor payment has already started processing ("may_cancel": true), the payment cannot be cancelled.
|
|
15926
16952
|
*
|
|
15927
16953
|
* scope: `payrolls:run`
|
|
15928
16954
|
*/
|
|
@@ -16177,7 +17203,7 @@ declare interface paths {
|
|
|
16177
17203
|
};
|
|
16178
17204
|
/**
|
|
16179
17205
|
* Get the employee form pdf
|
|
16180
|
-
* @description Get the link to the form PDF
|
|
17206
|
+
* @description Get the link to the employee form PDF
|
|
16181
17207
|
*
|
|
16182
17208
|
* scope: `employee_forms:read`
|
|
16183
17209
|
*/
|
|
@@ -16515,6 +17541,42 @@ declare interface paths {
|
|
|
16515
17541
|
patch?: never;
|
|
16516
17542
|
trace?: never;
|
|
16517
17543
|
};
|
|
17544
|
+
"/v1/company_benefits/{company_benefit_id}/employee_benefits": {
|
|
17545
|
+
parameters: {
|
|
17546
|
+
query?: never;
|
|
17547
|
+
header?: never;
|
|
17548
|
+
path?: never;
|
|
17549
|
+
cookie?: never;
|
|
17550
|
+
};
|
|
17551
|
+
/**
|
|
17552
|
+
* Get all employee benefits for a company benefit
|
|
17553
|
+
* @description Employee benefits represent an employee enrolled in a particular company benefit. It includes information specific to that employee’s enrollment.
|
|
17554
|
+
*
|
|
17555
|
+
* Returns an array of all employee benefits enrolled for this company benefit.
|
|
17556
|
+
*
|
|
17557
|
+
* Benefits containing PHI are only visible to applications with the `employee_benefits:read:phi` scope.
|
|
17558
|
+
*
|
|
17559
|
+
* scope: `employee_benefits:read`
|
|
17560
|
+
*/
|
|
17561
|
+
get: operations["get-v1-company_benefits-company_benefit_id-employee_benefits"];
|
|
17562
|
+
/**
|
|
17563
|
+
* Bulk update employee benefits for a company benefit
|
|
17564
|
+
* @description Employee benefits represent an employee enrolled in a particular company benefit. It includes information specific to that employee’s enrollment.
|
|
17565
|
+
*
|
|
17566
|
+
* Create or update(if the employee is already enrolled in the company benefit previously) an employee benefit for the company benefit.
|
|
17567
|
+
*
|
|
17568
|
+
* Benefits containing PHI are only visible to applications with the `employee_benefits:read:phi` scope.
|
|
17569
|
+
*
|
|
17570
|
+
* scope: `employee_benefits:write`
|
|
17571
|
+
*/
|
|
17572
|
+
put: operations["put-v1-company_benefits-company_benefit_id-employee_benefits"];
|
|
17573
|
+
post?: never;
|
|
17574
|
+
delete?: never;
|
|
17575
|
+
options?: never;
|
|
17576
|
+
head?: never;
|
|
17577
|
+
patch?: never;
|
|
17578
|
+
trace?: never;
|
|
17579
|
+
};
|
|
16518
17580
|
"/v1/benefits/{benefit_id}/requirements": {
|
|
16519
17581
|
parameters: {
|
|
16520
17582
|
query?: never;
|
|
@@ -16685,6 +17747,28 @@ declare interface paths {
|
|
|
16685
17747
|
patch?: never;
|
|
16686
17748
|
trace?: never;
|
|
16687
17749
|
};
|
|
17750
|
+
"/v1/garnishments/child_support": {
|
|
17751
|
+
parameters: {
|
|
17752
|
+
query?: never;
|
|
17753
|
+
header?: never;
|
|
17754
|
+
path?: never;
|
|
17755
|
+
cookie?: never;
|
|
17756
|
+
};
|
|
17757
|
+
/**
|
|
17758
|
+
* Get child support garnishment data
|
|
17759
|
+
* @description Agency data and requirements to be used for creating child support garnishments
|
|
17760
|
+
*
|
|
17761
|
+
* scope: `garnishments:read`
|
|
17762
|
+
*/
|
|
17763
|
+
get: operations["get-v1-garnishments-child_support"];
|
|
17764
|
+
put?: never;
|
|
17765
|
+
post?: never;
|
|
17766
|
+
delete?: never;
|
|
17767
|
+
options?: never;
|
|
17768
|
+
head?: never;
|
|
17769
|
+
patch?: never;
|
|
17770
|
+
trace?: never;
|
|
17771
|
+
};
|
|
16688
17772
|
"/v1/plaid/processor_token": {
|
|
16689
17773
|
parameters: {
|
|
16690
17774
|
query?: never;
|
|
@@ -17252,7 +18336,9 @@ declare interface paths {
|
|
|
17252
18336
|
};
|
|
17253
18337
|
}
|
|
17254
18338
|
|
|
17255
|
-
declare function PaymentMethod(
|
|
18339
|
+
export declare function PaymentMethod(): JSX_2.Element;
|
|
18340
|
+
|
|
18341
|
+
declare function PaymentMethod_2(props: PaymentMethodProps & BaseComponentInterface): JSX_2.Element;
|
|
17256
18342
|
|
|
17257
18343
|
declare type PaymentMethodContextType = {
|
|
17258
18344
|
bankAccounts: Schemas['Employee-Bank-Account'][];
|
|
@@ -17360,9 +18446,11 @@ declare interface PayrollTotalsConstructor {
|
|
|
17360
18446
|
companyDebit?: number;
|
|
17361
18447
|
}
|
|
17362
18448
|
|
|
17363
|
-
declare function Profile(
|
|
18449
|
+
export declare function Profile(): JSX_2.Element;
|
|
18450
|
+
|
|
18451
|
+
declare function Profile_2(props: ProfileProps & BaseComponentInterface): JSX_2.Element;
|
|
17364
18452
|
|
|
17365
|
-
declare namespace
|
|
18453
|
+
declare namespace Profile_2 {
|
|
17366
18454
|
var Head: () => JSX_2.Element;
|
|
17367
18455
|
var Actions: () => JSX_2.Element;
|
|
17368
18456
|
var AdminPersonalDetails: () => JSX_2.Element | null;
|
|
@@ -17412,6 +18500,23 @@ declare type QueryParams<Path extends keyof paths> = _QueryParams<Path> extends
|
|
|
17412
18500
|
|
|
17413
18501
|
declare type _QueryParams<Path extends keyof paths> = Parameters<ReturnType<typeof default_2<Pick<paths, Path>>>['GET']>['1'];
|
|
17414
18502
|
|
|
18503
|
+
export declare function ReorderableItem({ item, index, moveItem, itemCount }: ReorderableItemProps): JSX_2.Element;
|
|
18504
|
+
|
|
18505
|
+
declare interface ReorderableItemProps {
|
|
18506
|
+
item: ReactElement;
|
|
18507
|
+
index: number;
|
|
18508
|
+
moveItem: (fromIndex: number, toIndex: number) => void;
|
|
18509
|
+
itemCount: number;
|
|
18510
|
+
}
|
|
18511
|
+
|
|
18512
|
+
export declare function ReorderableList({ items, label, onReorder }: ReorderableListProps): JSX_2.Element;
|
|
18513
|
+
|
|
18514
|
+
declare interface ReorderableListProps {
|
|
18515
|
+
items: ReactElement[];
|
|
18516
|
+
label: string;
|
|
18517
|
+
onReorder?: (itemOrder: number[]) => void;
|
|
18518
|
+
}
|
|
18519
|
+
|
|
17415
18520
|
declare type Resources = CustomTypeOptions['resources'];
|
|
17416
18521
|
|
|
17417
18522
|
declare type RGB = `rgb(${string})`
|
|
@@ -17425,6 +18530,10 @@ declare type Schemas = components["schemas"];
|
|
|
17425
18530
|
/**Creating new i18next instance to avoid global clashing */
|
|
17426
18531
|
export declare const SDKI18next: i18n;
|
|
17427
18532
|
|
|
18533
|
+
declare function SignatureForm(): JSX_2.Element | null;
|
|
18534
|
+
|
|
18535
|
+
declare function SignatureFormHead(): JSX_2.Element | null;
|
|
18536
|
+
|
|
17428
18537
|
declare interface SummaryProps extends CommonComponentInterface {
|
|
17429
18538
|
employeeId: string;
|
|
17430
18539
|
flow?: OnboardingFlow;
|
|
@@ -17435,9 +18544,11 @@ declare interface SummaryProps_2 extends CommonComponentInterface {
|
|
|
17435
18544
|
companyId: string;
|
|
17436
18545
|
}
|
|
17437
18546
|
|
|
17438
|
-
declare function Taxes(
|
|
18547
|
+
export declare function Taxes(): JSX_2.Element;
|
|
17439
18548
|
|
|
17440
|
-
declare
|
|
18549
|
+
declare function Taxes_2(props: TaxesProps & BaseComponentInterface): JSX_2.Element;
|
|
18550
|
+
|
|
18551
|
+
declare namespace Taxes_2 {
|
|
17441
18552
|
var FederalHead: FederalHead;
|
|
17442
18553
|
var FederalForm: FederalForm;
|
|
17443
18554
|
var StateForm: () => JSX_2.Element[];
|
|
@@ -17447,12 +18558,14 @@ declare namespace Taxes {
|
|
|
17447
18558
|
declare type TaxesContextType = {
|
|
17448
18559
|
employeeStateTaxes: Schemas['Employee-State-Tax'][];
|
|
17449
18560
|
isPending: boolean;
|
|
18561
|
+
isAdmin: boolean;
|
|
17450
18562
|
};
|
|
17451
18563
|
|
|
17452
18564
|
declare const TaxesContextual: () => JSX_2.Element;
|
|
17453
18565
|
|
|
17454
18566
|
declare interface TaxesProps extends CommonComponentInterface {
|
|
17455
18567
|
employeeId: string;
|
|
18568
|
+
isAdmin?: boolean;
|
|
17456
18569
|
}
|
|
17457
18570
|
|
|
17458
18571
|
declare type ThemeColor = RGB | RGBA | HEX | HSL | HSLA | VAR | 'transparent'
|
|
@@ -17466,7 +18579,7 @@ export declare interface ThemeContextProps {
|
|
|
17466
18579
|
export declare const ThemeProvider: default_3.FC<ThemeProviderProps>;
|
|
17467
18580
|
|
|
17468
18581
|
export declare interface ThemeProviderProps {
|
|
17469
|
-
theme?: GTheme
|
|
18582
|
+
theme?: DeepPartial<GTheme>;
|
|
17470
18583
|
children?: default_3.ReactNode;
|
|
17471
18584
|
}
|
|
17472
18585
|
|
|
@@ -17504,6 +18617,8 @@ recurring: boolean;
|
|
|
17504
18617
|
annual_maximum: string | null;
|
|
17505
18618
|
pay_period_maximum: string | null;
|
|
17506
18619
|
deduct_as_percentage: boolean;
|
|
18620
|
+
garnishment_type?: "child_support" | "federal_tax_lien" | "state_tax_lien" | "student_loan" | "creditor_garnishment" | "federal_loan" | "other_garnishment" | null;
|
|
18621
|
+
child_support?: components["schemas"]["Garnishment-Child-Support"];
|
|
17507
18622
|
}, Error, {
|
|
17508
18623
|
employee_id: string;
|
|
17509
18624
|
body: Parameters<(employee_id: string, body: BodyParams<"/v1/employees/{employee_id}/garnishments", "POST">) => Promise<{
|
|
@@ -17519,6 +18634,8 @@ recurring: boolean;
|
|
|
17519
18634
|
annual_maximum: string | null;
|
|
17520
18635
|
pay_period_maximum: string | null;
|
|
17521
18636
|
deduct_as_percentage: boolean;
|
|
18637
|
+
garnishment_type?: "child_support" | "federal_tax_lien" | "state_tax_lien" | "student_loan" | "creditor_garnishment" | "federal_loan" | "other_garnishment" | null;
|
|
18638
|
+
child_support?: components["schemas"]["Garnishment-Child-Support"];
|
|
17522
18639
|
}>>[1];
|
|
17523
18640
|
}, unknown>;
|
|
17524
18641
|
|
|
@@ -17654,11 +18771,11 @@ middle_initial?: string | null;
|
|
|
17654
18771
|
last_name: string;
|
|
17655
18772
|
email?: string | null;
|
|
17656
18773
|
readonly company_uuid?: string;
|
|
17657
|
-
readonly manager_uuid?: string;
|
|
18774
|
+
readonly manager_uuid?: string | null;
|
|
17658
18775
|
readonly version?: string;
|
|
17659
18776
|
readonly department?: string | null;
|
|
17660
18777
|
readonly terminated?: boolean;
|
|
17661
|
-
two_percent_shareholder?: boolean;
|
|
18778
|
+
two_percent_shareholder?: boolean | null;
|
|
17662
18779
|
readonly onboarded?: boolean;
|
|
17663
18780
|
readonly onboarding_status?: "onboarding_completed" | "admin_onboarding_incomplete" | "self_onboarding_pending_invite" | "self_onboarding_invited" | "self_onboarding_invited_started" | "self_onboarding_invited_overdue" | "self_onboarding_completed_by_employee" | "self_onboarding_awaiting_admin_review";
|
|
17664
18781
|
jobs?: components["schemas"]["Job"][];
|
|
@@ -17669,8 +18786,8 @@ custom_fields?: components["schemas"]["Employee-Custom-Field"][];
|
|
|
17669
18786
|
readonly date_of_birth?: string | null;
|
|
17670
18787
|
has_ssn?: boolean;
|
|
17671
18788
|
ssn?: string;
|
|
17672
|
-
phone?: string;
|
|
17673
|
-
preferred_first_name?: string;
|
|
18789
|
+
phone?: string | null;
|
|
18790
|
+
preferred_first_name?: string | null;
|
|
17674
18791
|
payment_method: "Direct Deposit" | "Check";
|
|
17675
18792
|
work_email?: string | null;
|
|
17676
18793
|
readonly current_employment_status?: "full_time" | "part_time_under_twenty_hours" | "part_time_twenty_plus_hours" | "variable" | "seasonal" | null;
|
|
@@ -17683,11 +18800,11 @@ middle_initial?: string | null;
|
|
|
17683
18800
|
last_name: string;
|
|
17684
18801
|
email?: string | null;
|
|
17685
18802
|
readonly company_uuid?: string;
|
|
17686
|
-
readonly manager_uuid?: string;
|
|
18803
|
+
readonly manager_uuid?: string | null;
|
|
17687
18804
|
readonly version?: string;
|
|
17688
18805
|
readonly department?: string | null;
|
|
17689
18806
|
readonly terminated?: boolean;
|
|
17690
|
-
two_percent_shareholder?: boolean;
|
|
18807
|
+
two_percent_shareholder?: boolean | null;
|
|
17691
18808
|
readonly onboarded?: boolean;
|
|
17692
18809
|
readonly onboarding_status?: "onboarding_completed" | "admin_onboarding_incomplete" | "self_onboarding_pending_invite" | "self_onboarding_invited" | "self_onboarding_invited_started" | "self_onboarding_invited_overdue" | "self_onboarding_completed_by_employee" | "self_onboarding_awaiting_admin_review";
|
|
17693
18810
|
jobs?: components["schemas"]["Job"][];
|
|
@@ -17698,8 +18815,8 @@ custom_fields?: components["schemas"]["Employee-Custom-Field"][];
|
|
|
17698
18815
|
readonly date_of_birth?: string | null;
|
|
17699
18816
|
has_ssn?: boolean;
|
|
17700
18817
|
ssn?: string;
|
|
17701
|
-
phone?: string;
|
|
17702
|
-
preferred_first_name?: string;
|
|
18818
|
+
phone?: string | null;
|
|
18819
|
+
preferred_first_name?: string | null;
|
|
17703
18820
|
payment_method: "Direct Deposit" | "Check";
|
|
17704
18821
|
work_email?: string | null;
|
|
17705
18822
|
readonly current_employment_status?: "full_time" | "part_time_under_twenty_hours" | "part_time_twenty_plus_hours" | "variable" | "seasonal" | null;
|
|
@@ -17863,13 +18980,27 @@ export declare function useDeleteEmployeeWorkAddress(employee_id: string, opts:
|
|
|
17863
18980
|
onError: OnError;
|
|
17864
18981
|
} & Omit<Parameters<typeof useMutation>[0], 'mutationFn' | 'onError'>): UseMutationResult<unknown, unknown, string, unknown>;
|
|
17865
18982
|
|
|
18983
|
+
declare const useDocumentSigner: () => DocumentSignerContextType;
|
|
18984
|
+
|
|
17866
18985
|
declare const useEmployeeList: () => EmployeeListContextType;
|
|
17867
18986
|
|
|
17868
18987
|
export declare function useFlow<C extends FlowContextInterface>(): C;
|
|
17869
18988
|
|
|
18989
|
+
export declare function useGetAllEmployeeForms(employee_id: string): UseSuspenseQueryResult<{
|
|
18990
|
+
readonly uuid: string;
|
|
18991
|
+
readonly name?: string;
|
|
18992
|
+
readonly title?: string;
|
|
18993
|
+
readonly description?: string;
|
|
18994
|
+
readonly draft?: boolean;
|
|
18995
|
+
readonly year?: number | null;
|
|
18996
|
+
readonly quarter?: number | null;
|
|
18997
|
+
readonly requires_signing?: boolean;
|
|
18998
|
+
}[], Error>;
|
|
18999
|
+
|
|
17870
19000
|
export declare function useGetCompany(company_id: string): UseSuspenseQueryResult< {
|
|
17871
19001
|
readonly ein?: string;
|
|
17872
19002
|
readonly entity_type?: "C-Corporation" | "S-Corporation" | "Sole proprietor" | "LLC" | "LLP" | "Limited partnership" | "Co-ownership" | "Association" | "Trusteeship" | "General partnership" | "Joint venture" | "Non-Profit";
|
|
19003
|
+
contractor_only?: boolean;
|
|
17873
19004
|
readonly tier?: "simple" | "plus" | "premium" | "core" | "complete" | "concierge" | "contractor_only" | "basic" | null;
|
|
17874
19005
|
is_suspended?: boolean;
|
|
17875
19006
|
readonly company_status?: "Approved" | "Not Approved" | "Suspended";
|
|
@@ -17878,7 +19009,7 @@ readonly name?: string;
|
|
|
17878
19009
|
readonly slug?: string;
|
|
17879
19010
|
readonly trade_name?: string;
|
|
17880
19011
|
readonly is_partner_managed?: boolean;
|
|
17881
|
-
readonly pay_schedule_type?: "single" | "hourly_salaried" | "by_employee" | "by_department";
|
|
19012
|
+
readonly pay_schedule_type?: "single" | "hourly_salaried" | "by_employee" | "by_department" | null;
|
|
17882
19013
|
readonly join_date?: string;
|
|
17883
19014
|
funding_type?: "ach" | "reverse_wire" | "wire_in" | "brex";
|
|
17884
19015
|
readonly locations?: components["schemas"]["Company-Address"][];
|
|
@@ -18014,6 +19145,8 @@ export declare function useGetDeduction(garnishment_id: string): UseSuspenseQuer
|
|
|
18014
19145
|
annual_maximum: string | null;
|
|
18015
19146
|
pay_period_maximum: string | null;
|
|
18016
19147
|
deduct_as_percentage: boolean;
|
|
19148
|
+
garnishment_type?: "child_support" | "federal_tax_lien" | "state_tax_lien" | "student_loan" | "creditor_garnishment" | "federal_loan" | "other_garnishment" | null;
|
|
19149
|
+
child_support?: components["schemas"]["Garnishment-Child-Support"];
|
|
18017
19150
|
}, Error>;
|
|
18018
19151
|
|
|
18019
19152
|
export declare function useGetEmployee<T extends string | undefined>(employee_id: T): UseSuspenseQueryResult<InferResponse<T, Schemas["Employee"]>>;
|
|
@@ -18040,21 +19173,30 @@ export declare function useGetEmployeeDeductions(employee_id: string): UseSuspen
|
|
|
18040
19173
|
annual_maximum: string | null;
|
|
18041
19174
|
pay_period_maximum: string | null;
|
|
18042
19175
|
deduct_as_percentage: boolean;
|
|
19176
|
+
garnishment_type?: "child_support" | "federal_tax_lien" | "state_tax_lien" | "student_loan" | "creditor_garnishment" | "federal_loan" | "other_garnishment" | null;
|
|
19177
|
+
child_support?: components["schemas"]["Garnishment-Child-Support"];
|
|
18043
19178
|
}[], Error>;
|
|
18044
19179
|
|
|
18045
19180
|
export declare function useGetEmployeeFederalTaxes(employee_id: string): UseSuspenseQueryResult<{
|
|
18046
19181
|
version?: string;
|
|
18047
19182
|
filing_status?: string;
|
|
18048
|
-
extra_withholding?: string;
|
|
18049
|
-
two_jobs?: boolean;
|
|
18050
|
-
dependents_amount?: string;
|
|
18051
|
-
other_income?: string;
|
|
18052
|
-
deductions?: string;
|
|
19183
|
+
extra_withholding?: string | null;
|
|
19184
|
+
two_jobs?: boolean | null;
|
|
19185
|
+
dependents_amount?: string | null;
|
|
19186
|
+
other_income?: string | null;
|
|
19187
|
+
deductions?: string | null;
|
|
18053
19188
|
w4_data_type?: "pre_2020_w4" | "rev_2020_w4";
|
|
18054
19189
|
federal_withholding_allowance?: number;
|
|
18055
19190
|
additional_withholding?: boolean;
|
|
18056
19191
|
}, Error>;
|
|
18057
19192
|
|
|
19193
|
+
export declare function useGetEmployeeFormPdf(employee_id: string): UseMutationResult< {
|
|
19194
|
+
readonly uuid: string;
|
|
19195
|
+
document_url?: string;
|
|
19196
|
+
}, Error, {
|
|
19197
|
+
form_id: string;
|
|
19198
|
+
}, unknown>;
|
|
19199
|
+
|
|
18058
19200
|
export declare function useGetEmployeeHomeAddress(home_address_uuid: string): UseSuspenseQueryResult<NonNullable<{
|
|
18059
19201
|
version?: string;
|
|
18060
19202
|
} & {
|
|
@@ -18147,11 +19289,11 @@ middle_initial?: string | null;
|
|
|
18147
19289
|
last_name: string;
|
|
18148
19290
|
email?: string | null;
|
|
18149
19291
|
readonly company_uuid?: string;
|
|
18150
|
-
readonly manager_uuid?: string;
|
|
19292
|
+
readonly manager_uuid?: string | null;
|
|
18151
19293
|
readonly version?: string;
|
|
18152
19294
|
readonly department?: string | null;
|
|
18153
19295
|
readonly terminated?: boolean;
|
|
18154
|
-
two_percent_shareholder?: boolean;
|
|
19296
|
+
two_percent_shareholder?: boolean | null;
|
|
18155
19297
|
readonly onboarded?: boolean;
|
|
18156
19298
|
readonly onboarding_status?: "onboarding_completed" | "admin_onboarding_incomplete" | "self_onboarding_pending_invite" | "self_onboarding_invited" | "self_onboarding_invited_started" | "self_onboarding_invited_overdue" | "self_onboarding_completed_by_employee" | "self_onboarding_awaiting_admin_review";
|
|
18157
19299
|
jobs?: components["schemas"]["Job"][];
|
|
@@ -18162,8 +19304,8 @@ custom_fields?: components["schemas"]["Employee-Custom-Field"][];
|
|
|
18162
19304
|
readonly date_of_birth?: string | null;
|
|
18163
19305
|
has_ssn?: boolean;
|
|
18164
19306
|
ssn?: string;
|
|
18165
|
-
phone?: string;
|
|
18166
|
-
preferred_first_name?: string;
|
|
19307
|
+
phone?: string | null;
|
|
19308
|
+
preferred_first_name?: string | null;
|
|
18167
19309
|
payment_method: "Direct Deposit" | "Check";
|
|
18168
19310
|
work_email?: string | null;
|
|
18169
19311
|
readonly current_employment_status?: "full_time" | "part_time_under_twenty_hours" | "part_time_twenty_plus_hours" | "variable" | "seasonal" | null;
|
|
@@ -18234,6 +19376,7 @@ payroll_uuid: components["schemas"]["Payroll-Payroll-Uuid-Type"];
|
|
|
18234
19376
|
company_uuid: components["schemas"]["Payroll-Company-Uuid-Type"];
|
|
18235
19377
|
off_cycle?: components["schemas"]["Payroll-Off-Cycle-Type"];
|
|
18236
19378
|
off_cycle_reason?: components["schemas"]["Off-Cycle-Reason-Type"];
|
|
19379
|
+
auto_pilot?: components["schemas"]["Auto-Pilot-Type"];
|
|
18237
19380
|
external?: components["schemas"]["Payroll-External-Type"];
|
|
18238
19381
|
final_termination_payroll?: components["schemas"]["Payroll-Final-Termination-Payroll-Type"];
|
|
18239
19382
|
withholding_pay_period?: components["schemas"]["Payroll-Withholding-Pay-Period-Type"];
|
|
@@ -18270,6 +19413,29 @@ declare type UsePaySchedulePreviewParams = Operations['get-v1-companies-company_
|
|
|
18270
19413
|
|
|
18271
19414
|
declare const useProfile: () => ProfileContextType;
|
|
18272
19415
|
|
|
19416
|
+
export declare function useSignEmployeeForm(employee_id: string, opts?: Omit<Parameters<typeof useMutation>[0], 'mutationFn'>): UseMutationResult< {
|
|
19417
|
+
readonly uuid: string;
|
|
19418
|
+
readonly name?: string;
|
|
19419
|
+
readonly title?: string;
|
|
19420
|
+
readonly description?: string;
|
|
19421
|
+
readonly draft?: boolean;
|
|
19422
|
+
readonly year?: number | null;
|
|
19423
|
+
readonly quarter?: number | null;
|
|
19424
|
+
readonly requires_signing?: boolean;
|
|
19425
|
+
}, Error, {
|
|
19426
|
+
form_id: string;
|
|
19427
|
+
body: Parameters<(employee_id: string, form_id: string, body: BodyParams<"/v1/employees/{employee_id}/forms/{form_id}/sign", "PUT">) => Promise<{
|
|
19428
|
+
readonly uuid: string;
|
|
19429
|
+
readonly name?: string;
|
|
19430
|
+
readonly title?: string;
|
|
19431
|
+
readonly description?: string;
|
|
19432
|
+
readonly draft?: boolean;
|
|
19433
|
+
readonly year?: number | null;
|
|
19434
|
+
readonly quarter?: number | null;
|
|
19435
|
+
readonly requires_signing?: boolean;
|
|
19436
|
+
}>>[2];
|
|
19437
|
+
}, unknown>;
|
|
19438
|
+
|
|
18273
19439
|
declare const useTaxes: () => TaxesContextType;
|
|
18274
19440
|
|
|
18275
19441
|
export declare const useTheme: () => ThemeContextProps;
|
|
@@ -18350,7 +19516,7 @@ cookie?: never;
|
|
|
18350
19516
|
requestBody?: {
|
|
18351
19517
|
content: {
|
|
18352
19518
|
"application/json": {
|
|
18353
|
-
title
|
|
19519
|
+
title?: string;
|
|
18354
19520
|
naics_code: string;
|
|
18355
19521
|
sic_codes?: string[];
|
|
18356
19522
|
};
|
|
@@ -18368,7 +19534,7 @@ company_id: string;
|
|
|
18368
19534
|
};
|
|
18369
19535
|
};
|
|
18370
19536
|
body: {
|
|
18371
|
-
title
|
|
19537
|
+
title?: string;
|
|
18372
19538
|
naics_code: string;
|
|
18373
19539
|
sic_codes?: string[];
|
|
18374
19540
|
} | undefined;
|
|
@@ -18459,6 +19625,8 @@ recurring: boolean;
|
|
|
18459
19625
|
annual_maximum: string | null;
|
|
18460
19626
|
pay_period_maximum: string | null;
|
|
18461
19627
|
deduct_as_percentage: boolean;
|
|
19628
|
+
garnishment_type?: "child_support" | "federal_tax_lien" | "state_tax_lien" | "student_loan" | "creditor_garnishment" | "federal_loan" | "other_garnishment" | null;
|
|
19629
|
+
child_support?: components["schemas"]["Garnishment-Child-Support"];
|
|
18462
19630
|
}, Error, {
|
|
18463
19631
|
garnishment_id: string;
|
|
18464
19632
|
body: Parameters<(garnishment_id: string, body: BodyParams<"/v1/garnishments/{garnishment_id}", "PUT">) => Promise<{
|
|
@@ -18474,6 +19642,8 @@ recurring: boolean;
|
|
|
18474
19642
|
annual_maximum: string | null;
|
|
18475
19643
|
pay_period_maximum: string | null;
|
|
18476
19644
|
deduct_as_percentage: boolean;
|
|
19645
|
+
garnishment_type?: "child_support" | "federal_tax_lien" | "state_tax_lien" | "student_loan" | "creditor_garnishment" | "federal_loan" | "other_garnishment" | null;
|
|
19646
|
+
child_support?: components["schemas"]["Garnishment-Child-Support"];
|
|
18477
19647
|
}>>[1];
|
|
18478
19648
|
}, unknown>;
|
|
18479
19649
|
|
|
@@ -18484,11 +19654,11 @@ middle_initial?: string | null;
|
|
|
18484
19654
|
last_name: string;
|
|
18485
19655
|
email?: string | null;
|
|
18486
19656
|
readonly company_uuid?: string;
|
|
18487
|
-
readonly manager_uuid?: string;
|
|
19657
|
+
readonly manager_uuid?: string | null;
|
|
18488
19658
|
readonly version?: string;
|
|
18489
19659
|
readonly department?: string | null;
|
|
18490
19660
|
readonly terminated?: boolean;
|
|
18491
|
-
two_percent_shareholder?: boolean;
|
|
19661
|
+
two_percent_shareholder?: boolean | null;
|
|
18492
19662
|
readonly onboarded?: boolean;
|
|
18493
19663
|
readonly onboarding_status?: "onboarding_completed" | "admin_onboarding_incomplete" | "self_onboarding_pending_invite" | "self_onboarding_invited" | "self_onboarding_invited_started" | "self_onboarding_invited_overdue" | "self_onboarding_completed_by_employee" | "self_onboarding_awaiting_admin_review";
|
|
18494
19664
|
jobs?: components["schemas"]["Job"][];
|
|
@@ -18499,8 +19669,8 @@ custom_fields?: components["schemas"]["Employee-Custom-Field"][];
|
|
|
18499
19669
|
readonly date_of_birth?: string | null;
|
|
18500
19670
|
has_ssn?: boolean;
|
|
18501
19671
|
ssn?: string;
|
|
18502
|
-
phone?: string;
|
|
18503
|
-
preferred_first_name?: string;
|
|
19672
|
+
phone?: string | null;
|
|
19673
|
+
preferred_first_name?: string | null;
|
|
18504
19674
|
payment_method: "Direct Deposit" | "Check";
|
|
18505
19675
|
work_email?: string | null;
|
|
18506
19676
|
readonly current_employment_status?: "full_time" | "part_time_under_twenty_hours" | "part_time_twenty_plus_hours" | "variable" | "seasonal" | null;
|
|
@@ -18513,11 +19683,11 @@ middle_initial?: string | null;
|
|
|
18513
19683
|
last_name: string;
|
|
18514
19684
|
email?: string | null;
|
|
18515
19685
|
readonly company_uuid?: string;
|
|
18516
|
-
readonly manager_uuid?: string;
|
|
19686
|
+
readonly manager_uuid?: string | null;
|
|
18517
19687
|
readonly version?: string;
|
|
18518
19688
|
readonly department?: string | null;
|
|
18519
19689
|
readonly terminated?: boolean;
|
|
18520
|
-
two_percent_shareholder?: boolean;
|
|
19690
|
+
two_percent_shareholder?: boolean | null;
|
|
18521
19691
|
readonly onboarded?: boolean;
|
|
18522
19692
|
readonly onboarding_status?: "onboarding_completed" | "admin_onboarding_incomplete" | "self_onboarding_pending_invite" | "self_onboarding_invited" | "self_onboarding_invited_started" | "self_onboarding_invited_overdue" | "self_onboarding_completed_by_employee" | "self_onboarding_awaiting_admin_review";
|
|
18523
19693
|
jobs?: components["schemas"]["Job"][];
|
|
@@ -18528,8 +19698,8 @@ custom_fields?: components["schemas"]["Employee-Custom-Field"][];
|
|
|
18528
19698
|
readonly date_of_birth?: string | null;
|
|
18529
19699
|
has_ssn?: boolean;
|
|
18530
19700
|
ssn?: string;
|
|
18531
|
-
phone?: string;
|
|
18532
|
-
preferred_first_name?: string;
|
|
19701
|
+
phone?: string | null;
|
|
19702
|
+
preferred_first_name?: string | null;
|
|
18533
19703
|
payment_method: "Direct Deposit" | "Check";
|
|
18534
19704
|
work_email?: string | null;
|
|
18535
19705
|
readonly current_employment_status?: "full_time" | "part_time_under_twenty_hours" | "part_time_twenty_plus_hours" | "variable" | "seasonal" | null;
|
|
@@ -18618,11 +19788,11 @@ uuid?: string;
|
|
|
18618
19788
|
export declare function useUpdateEmployeeFederalTaxes(employeeId: string, opts?: Omit<Parameters<typeof useMutation>[0], 'mutationFn'>): UseMutationResult< {
|
|
18619
19789
|
version?: string;
|
|
18620
19790
|
filing_status?: string;
|
|
18621
|
-
extra_withholding?: string;
|
|
18622
|
-
two_jobs?: boolean;
|
|
18623
|
-
dependents_amount?: string;
|
|
18624
|
-
other_income?: string;
|
|
18625
|
-
deductions?: string;
|
|
19791
|
+
extra_withholding?: string | null;
|
|
19792
|
+
two_jobs?: boolean | null;
|
|
19793
|
+
dependents_amount?: string | null;
|
|
19794
|
+
other_income?: string | null;
|
|
19795
|
+
deductions?: string | null;
|
|
18626
19796
|
w4_data_type?: "pre_2020_w4" | "rev_2020_w4";
|
|
18627
19797
|
federal_withholding_allowance?: number;
|
|
18628
19798
|
additional_withholding?: boolean;
|
|
@@ -18630,11 +19800,11 @@ additional_withholding?: boolean;
|
|
|
18630
19800
|
body: Parameters<(employee_uuid: string, body: BodyParams<"/v1/employees/{employee_uuid}/federal_taxes", "PUT">) => Promise<{
|
|
18631
19801
|
version?: string;
|
|
18632
19802
|
filing_status?: string;
|
|
18633
|
-
extra_withholding?: string;
|
|
18634
|
-
two_jobs?: boolean;
|
|
18635
|
-
dependents_amount?: string;
|
|
18636
|
-
other_income?: string;
|
|
18637
|
-
deductions?: string;
|
|
19803
|
+
extra_withholding?: string | null;
|
|
19804
|
+
two_jobs?: boolean | null;
|
|
19805
|
+
dependents_amount?: string | null;
|
|
19806
|
+
other_income?: string | null;
|
|
19807
|
+
deductions?: string | null;
|
|
18638
19808
|
w4_data_type?: "pre_2020_w4" | "rev_2020_w4";
|
|
18639
19809
|
federal_withholding_allowance?: number;
|
|
18640
19810
|
additional_withholding?: boolean;
|
|
@@ -18906,6 +20076,8 @@ export interface EmployeeCompensation{
|
|
|
18906
20076
|
"saveNewJobCta":string;
|
|
18907
20077
|
"submitCta":string;
|
|
18908
20078
|
"title":string;
|
|
20079
|
+
"editTitle":string;
|
|
20080
|
+
"addTitle":string;
|
|
18909
20081
|
"validations":{
|
|
18910
20082
|
"classificationChangeNotification":string;
|
|
18911
20083
|
"exemptThreshold":string;
|
|
@@ -18953,6 +20125,26 @@ export interface EmployeeDeductions{
|
|
|
18953
20125
|
"amount":string;
|
|
18954
20126
|
}
|
|
18955
20127
|
};
|
|
20128
|
+
export interface EmployeeDocumentSigner{
|
|
20129
|
+
"documentListTitle":string;
|
|
20130
|
+
"documentListLabel":string;
|
|
20131
|
+
"formColumnLabel":string;
|
|
20132
|
+
"statusColumnLabel":string;
|
|
20133
|
+
"continueCta":string;
|
|
20134
|
+
"signDocumentCta":string;
|
|
20135
|
+
"signDocumentComplete":string;
|
|
20136
|
+
"documentListError":string;
|
|
20137
|
+
"emptyTableTitle":string;
|
|
20138
|
+
"signatureFormTitle":string;
|
|
20139
|
+
"downloadPrompt":string;
|
|
20140
|
+
"signatureFieldLabel":string;
|
|
20141
|
+
"signatureFieldDescription":string;
|
|
20142
|
+
"signatureFieldError":string;
|
|
20143
|
+
"confirmSignatureCheckboxLabel":string;
|
|
20144
|
+
"confirmSignatureError":string;
|
|
20145
|
+
"backCta":string;
|
|
20146
|
+
"signFormCta":string;
|
|
20147
|
+
};
|
|
18956
20148
|
export interface EmployeeEmployeeList{
|
|
18957
20149
|
"actionLabel":string;
|
|
18958
20150
|
"addEmployeeCTA":string;
|
|
@@ -19111,6 +20303,7 @@ export interface EmployeeProfile{
|
|
|
19111
20303
|
"firstName":string;
|
|
19112
20304
|
"lastName":string;
|
|
19113
20305
|
"startDate":string;
|
|
20306
|
+
"startDateOutOfRange":string;
|
|
19114
20307
|
}
|
|
19115
20308
|
"workAddress":string;
|
|
19116
20309
|
"workAddressDescription":string;
|
|
@@ -19228,6 +20421,10 @@ export interface common{
|
|
|
19228
20421
|
"deductionsTitle":string;
|
|
19229
20422
|
"summaryTitle":string;
|
|
19230
20423
|
}
|
|
20424
|
+
"employeeSelfOnboarding":{
|
|
20425
|
+
"profileTitle":string;
|
|
20426
|
+
"documentSignerTitle":string;
|
|
20427
|
+
}
|
|
19231
20428
|
}
|
|
19232
20429
|
"labels":{
|
|
19233
20430
|
"draggableLabel":string;
|
|
@@ -19314,7 +20511,7 @@ export interface common{
|
|
|
19314
20511
|
|
|
19315
20512
|
interface CustomTypeOptions {
|
|
19316
20513
|
defaultNS: 'common';
|
|
19317
|
-
resources: { 'Company.AddBank': CompanyAddBank, 'Company.Addresses': CompanyAddresses, 'Company.FederalTaxes': CompanyFederalTaxes, 'Company.Industry': CompanyIndustry, 'Employee.BankAccount': EmployeeBankAccount, 'Employee.Compensation': EmployeeCompensation, 'Employee.Deductions': EmployeeDeductions, 'Employee.EmployeeList': EmployeeEmployeeList, 'Employee.HomeAddress': EmployeeHomeAddress, 'Employee.Landing': EmployeeLanding, 'Employee.OnboardingSummary': EmployeeOnboardingSummary, 'Employee.PaySchedules': EmployeePaySchedules, 'Employee.PaymentMethod': EmployeePaymentMethod, 'Employee.Profile': EmployeeProfile, 'Employee.SplitPaycheck': EmployeeSplitPaycheck, 'Employee.StateTaxes': EmployeeStateTaxes, 'Employee.Taxes': EmployeeTaxes, 'Payroll.PayrollHistoryList': PayrollPayrollHistoryList, 'Payroll.PayrollSchedule': PayrollPayrollSchedule, 'common': common, }
|
|
20514
|
+
resources: { 'Company.AddBank': CompanyAddBank, 'Company.Addresses': CompanyAddresses, 'Company.FederalTaxes': CompanyFederalTaxes, 'Company.Industry': CompanyIndustry, 'Employee.BankAccount': EmployeeBankAccount, 'Employee.Compensation': EmployeeCompensation, 'Employee.Deductions': EmployeeDeductions, 'Employee.DocumentSigner': EmployeeDocumentSigner, 'Employee.EmployeeList': EmployeeEmployeeList, 'Employee.HomeAddress': EmployeeHomeAddress, 'Employee.Landing': EmployeeLanding, 'Employee.OnboardingSummary': EmployeeOnboardingSummary, 'Employee.PaySchedules': EmployeePaySchedules, 'Employee.PaymentMethod': EmployeePaymentMethod, 'Employee.Profile': EmployeeProfile, 'Employee.SplitPaycheck': EmployeeSplitPaycheck, 'Employee.StateTaxes': EmployeeStateTaxes, 'Employee.Taxes': EmployeeTaxes, 'Payroll.PayrollHistoryList': PayrollPayrollHistoryList, 'Payroll.PayrollSchedule': PayrollPayrollSchedule, 'common': common, }
|
|
19318
20515
|
};
|
|
19319
20516
|
}
|
|
19320
20517
|
declare module 'robot3' {
|