@gusto/embedded-react-sdk 0.0.5 → 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (38) hide show
  1. package/dist/{STCWXWCR-C2HWmWAx.js → B4MFY5CR-D8isFb6C.js} +3 -3
  2. package/dist/B4MFY5CR-D8isFb6C.js.map +1 -0
  3. package/dist/{Employee.Compensation-k6cvnqx0.js → Employee.Compensation-D5dhIZgh.js} +7 -6
  4. package/dist/Employee.Compensation-D5dhIZgh.js.map +1 -0
  5. package/dist/{Employee.Deductions-BKQWMJnY.js → Employee.Deductions-yskR0evJ.js} +40 -38
  6. package/dist/Employee.Deductions-yskR0evJ.js.map +1 -0
  7. package/dist/Employee.DocumentSigner-D8JKEl0C.js +42 -0
  8. package/dist/Employee.DocumentSigner-D8JKEl0C.js.map +1 -0
  9. package/dist/{Employee.HomeAddress-DR_603p_.js → Employee.HomeAddress-DQ-CWfZA.js} +6 -6
  10. package/dist/Employee.HomeAddress-DQ-CWfZA.js.map +1 -0
  11. package/dist/Employee.Landing-Hpn09zPP.js +22 -0
  12. package/dist/Employee.Landing-Hpn09zPP.js.map +1 -0
  13. package/dist/Employee.OnboardingSummary-BLQS8GZz.js +36 -0
  14. package/dist/Employee.OnboardingSummary-BLQS8GZz.js.map +1 -0
  15. package/dist/Employee.Profile-DTBA-TQA.js +57 -0
  16. package/dist/Employee.Profile-DTBA-TQA.js.map +1 -0
  17. package/dist/{Employee.Taxes-DnOVtPmd.js → Employee.Taxes-DQX-wk0E.js} +8 -8
  18. package/dist/Employee.Taxes-DQX-wk0E.js.map +1 -0
  19. package/dist/{BMGNQTAT-BdHbew7H.js → HO4MOOFI-MKtO51Gd.js} +3 -3
  20. package/dist/{BMGNQTAT-BdHbew7H.js.map → HO4MOOFI-MKtO51Gd.js.map} +1 -1
  21. package/dist/{UODQIBEW-3KqHTTDo.js → HUY7CZI3-REAOJEds.js} +3 -3
  22. package/dist/{UODQIBEW-3KqHTTDo.js.map → HUY7CZI3-REAOJEds.js.map} +1 -1
  23. package/dist/{index-CYu59Yku.js → index-CTsjS3wh.js} +12908 -11479
  24. package/dist/index-CTsjS3wh.js.map +1 -0
  25. package/dist/index.d.ts +2316 -510
  26. package/dist/index.js +80 -67
  27. package/dist/style.css +1 -1
  28. package/package.json +15 -16
  29. package/dist/Employee.Compensation-k6cvnqx0.js.map +0 -1
  30. package/dist/Employee.Deductions-BKQWMJnY.js.map +0 -1
  31. package/dist/Employee.HomeAddress-DR_603p_.js.map +0 -1
  32. package/dist/Employee.OnboardingSummary-BDFFDrV6.js +0 -32
  33. package/dist/Employee.OnboardingSummary-BDFFDrV6.js.map +0 -1
  34. package/dist/Employee.Profile-D0IZW-HV.js +0 -53
  35. package/dist/Employee.Profile-D0IZW-HV.js.map +0 -1
  36. package/dist/Employee.Taxes-DnOVtPmd.js.map +0 -1
  37. package/dist/STCWXWCR-C2HWmWAx.js.map +0 -1
  38. package/dist/index-CYu59Yku.js.map +0 -1
package/dist/index.d.ts CHANGED
@@ -1,3 +1,4 @@
1
+ import { CustomTypeOptions } from 'i18next';
1
2
  import { default as default_2 } from 'openapi-fetch';
2
3
  import { default as default_3 } from 'react';
3
4
  import { FallbackProps } from 'react-error-boundary';
@@ -5,8 +6,8 @@ import { FetchOptions } from 'openapi-fetch';
5
6
  import { FetchResponse } from 'openapi-fetch';
6
7
  import { i18n } from 'i18next';
7
8
  import { JSX as JSX_2 } from 'react/jsx-runtime';
9
+ import { ReactElement } from 'react';
8
10
  import { ReactNode } from 'react';
9
- import { Resource } from 'i18next';
10
11
  import { useMutation } from '@tanstack/react-query';
11
12
  import { UseMutationResult } from '@tanstack/react-query';
12
13
  import { UseQueryResult } from '@tanstack/react-query';
@@ -137,11 +138,10 @@ declare interface CompensationProps extends CommonComponentInterface {
137
138
 
138
139
  declare const CompensationSchema: v.IntersectSchema<[v.ObjectSchema<{
139
140
  readonly job_title: v.SchemaWithPipe<[v.StringSchema<undefined>, v.NonEmptyAction<string, undefined>]>;
140
- readonly rate: v.SchemaWithPipe<[v.NumberSchema<undefined>, v.MinValueAction<number, 0, undefined>, v.TransformAction<any, string>]>;
141
141
  }, undefined>, v.VariantSchema<"flsa_status", [v.SchemaWithPipe<[v.ObjectSchema<{
142
142
  readonly flsa_status: v.UnionSchema<[v.LiteralSchema<"Exempt", undefined>, v.LiteralSchema<"Salaried Nonexempt", undefined>, v.LiteralSchema<"Nonexempt", undefined>], undefined>;
143
143
  readonly payment_unit: v.UnionSchema<[v.LiteralSchema<"Hour", undefined>, v.LiteralSchema<"Week", undefined>, v.LiteralSchema<"Month", undefined>, v.LiteralSchema<"Year", undefined>], undefined>;
144
- readonly rate: v.SchemaWithPipe<[v.NumberSchema<undefined>, v.MinValueAction<number, 0, undefined>, v.TransformAction<any, string>]>;
144
+ readonly rate: v.SchemaWithPipe<[v.NumberSchema<undefined>, v.MinValueAction<number, 1, undefined>, v.TransformAction<any, string>]>;
145
145
  }, undefined>, v.BaseValidation<{
146
146
  rate: string;
147
147
  flsa_status: "Exempt" | "Salaried Nonexempt" | "Nonexempt";
@@ -157,9 +157,11 @@ declare const CompensationSchema: v.IntersectSchema<[v.ObjectSchema<{
157
157
  }>>]>, v.ObjectSchema<{
158
158
  readonly flsa_status: v.LiteralSchema<"Owner", undefined>;
159
159
  readonly payment_unit: v.LiteralSchema<"Paycheck", undefined>;
160
+ readonly rate: v.SchemaWithPipe<[v.NumberSchema<undefined>, v.MinValueAction<number, 1, undefined>, v.TransformAction<any, string>]>;
160
161
  }, undefined>, v.ObjectSchema<{
161
162
  readonly flsa_status: v.UnionSchema<[v.LiteralSchema<"Commission Only Exempt", undefined>, v.LiteralSchema<"Commission Only Nonexempt", undefined>], undefined>;
162
163
  readonly payment_unit: v.LiteralSchema<"Year", undefined>;
164
+ readonly rate: v.SchemaWithPipe<[v.LiteralSchema<0, undefined>, v.TransformAction<any, string>]>;
163
165
  }, undefined>], undefined>], undefined>;
164
166
 
165
167
  declare const componentEvents: {
@@ -204,8 +206,11 @@ declare const componentEvents: {
204
206
  readonly EMPLOYEE_JOB_CREATED: "employee/job/created";
205
207
  readonly EMPLOYEE_JOB_UPDATED: "employee/job/updated";
206
208
  readonly EMPLOYEE_SUMMARY_VIEW: "employee/summary";
207
- readonly EMPLOYEE_FILE_NEW_HIRE_REPORT: "employee/newHireReport";
208
209
  readonly EMPLOYEES_LIST: "company/employees";
210
+ readonly EMPLOYEE_SELF_ONBOARDING_START: "employee/selfOnboarding/start";
211
+ readonly EMPLOYEE_VIEW_FORM_TO_SIGN: "employee/forms/view";
212
+ readonly EMPLOYEE_SIGN_FORM: "employee/forms/sign";
213
+ readonly EMPLOYEE_FORMS_DONE: "employee/forms/done";
209
214
  readonly SUCCESS: "SUCCESS";
210
215
  readonly ERROR: "ERROR";
211
216
  readonly CANCEL: "CANCEL";
@@ -340,7 +345,7 @@ declare interface components {
340
345
  /** @description The UUID of the company the employee is employed by. */
341
346
  readonly company_uuid?: string;
342
347
  /** @description The UUID of the employee's manager. */
343
- readonly manager_uuid?: string;
348
+ readonly manager_uuid?: string | null;
344
349
  /** @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
350
  readonly version?: string;
346
351
  /** @description The employee's department in the company. */
@@ -348,7 +353,7 @@ declare interface components {
348
353
  /** @description Whether the employee is terminated. */
349
354
  readonly terminated?: boolean;
350
355
  /** @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;
356
+ two_percent_shareholder?: boolean | null;
352
357
  /** @description Whether the employee has completed onboarding. */
353
358
  readonly onboarded?: boolean;
354
359
  /**
@@ -367,8 +372,8 @@ declare interface components {
367
372
  has_ssn?: boolean;
368
373
  /** @description Deprecated. This field always returns an empty string. */
369
374
  ssn?: string;
370
- phone?: string;
371
- preferred_first_name?: string;
375
+ phone?: string | null;
376
+ preferred_first_name?: string | null;
372
377
  /**
373
378
  * @description The employee's payment method
374
379
  * @default Check
@@ -481,6 +486,54 @@ declare interface components {
481
486
  /** @description Whether the accrual balance is paid to the employee upon termination. */
482
487
  readonly paid_at_termination?: boolean;
483
488
  };
489
+ /** @description Child Support agency data */
490
+ "Child-Support-Data": {
491
+ /** @description State child support agencies */
492
+ agencies?: {
493
+ /** @description Two letter state abbreviation */
494
+ state?: string;
495
+ /** @description Name of state child support agency */
496
+ name?: string;
497
+ /** @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.
498
+ * */
499
+ manual_payment_required?: boolean;
500
+ /** @description FIPS codes for state or county child support orders */
501
+ fips_codes?: {
502
+ /** @description FIPS code for state or county */
503
+ code?: string;
504
+ /** @description Name of county in the state for the corresponding FIPS code. When `null` the FIPS code applies state wide. */
505
+ county?: string | null;
506
+ }[];
507
+ /** @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. */
508
+ required_attributes?: {
509
+ /**
510
+ * @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.
511
+ * @enum {string}
512
+ */
513
+ key?: "case_number" | "order_number" | "remittance_number";
514
+ /** @description A human readable name of the attribute, e.g. CSE Case Number */
515
+ label?: string;
516
+ }[];
517
+ }[];
518
+ };
519
+ /** @description Additional child support order details */
520
+ "Garnishment-Child-Support": {
521
+ /** @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. */
522
+ state?: string;
523
+ /**
524
+ * @description How often the agency collects the withholding amount. e.g. $500 monthly -> `Monthly`.
525
+ * @enum {string}
526
+ */
527
+ payment_period?: "Every week" | "Every other week" | "Twice per month" | "Monthly";
528
+ /** @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. */
529
+ readonly fips_code?: string;
530
+ /** @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. */
531
+ case_number?: string | null;
532
+ /** @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. */
533
+ order_number?: string | null;
534
+ /** @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. */
535
+ remittance_number?: string | null;
536
+ } | null;
484
537
  /** @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
538
  Garnishment: {
486
539
  /** @description The UUID of the garnishment in Gusto. */
@@ -530,6 +583,12 @@ declare interface components {
530
583
  * @default false
531
584
  */
532
585
  deduct_as_percentage: boolean;
586
+ /**
587
+ * @description The specific type of garnishment for court ordered garnishments.
588
+ * @enum {string|null}
589
+ */
590
+ garnishment_type?: "child_support" | "federal_tax_lien" | "state_tax_lien" | "student_loan" | "creditor_garnishment" | "federal_loan" | "other_garnishment" | null;
591
+ child_support?: components["schemas"]["Garnishment-Child-Support"];
533
592
  };
534
593
  /** @description The representation of a termination in Gusto. */
535
594
  Termination: {
@@ -563,18 +622,59 @@ declare interface components {
563
622
  /** @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
623
  two_percent_shareholder?: boolean;
565
624
  };
625
+ "Historical-Employee-Body": {
626
+ first_name: string;
627
+ middle_initial?: string;
628
+ last_name: string;
629
+ preferred_first_name?: string;
630
+ date_of_birth: string;
631
+ ssn: string;
632
+ work_address: {
633
+ /** @description Reference to a company location */
634
+ location_uuid?: string;
635
+ };
636
+ home_address: {
637
+ street_1?: string;
638
+ street_2?: string | null;
639
+ city?: string;
640
+ state?: string;
641
+ zip?: string;
642
+ };
643
+ termination: {
644
+ /**
645
+ * Format: date
646
+ * @description Date the employee was terminated from the company
647
+ */
648
+ effective_date?: string;
649
+ };
650
+ job: {
651
+ /**
652
+ * Format: date
653
+ * @description The date when the employee was hired to the company
654
+ */
655
+ hire_date?: string;
656
+ };
657
+ employee_state_taxes?: {
658
+ /** @description Whether this job is eligible for workers' compensation coverage in the states of Washington (WA) or Wyoming (WY). */
659
+ wc_covered?: boolean;
660
+ /** @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. */
661
+ wc_class_code?: string;
662
+ };
663
+ };
566
664
  "Pay-Schedule-Assignment-Body": {
567
665
  /**
568
666
  * @description The pay schedule assignment type.
569
- * @enum {string}
667
+ * @enum {string|null}
570
668
  */
571
- type: "single" | "hourly_salaried" | "by_employee" | "by_department";
669
+ type: "single" | "hourly_salaried" | "by_employee" | "by_department" | null;
572
670
  /** @description Pay schedule for hourly employees. */
573
671
  hourly_pay_schedule_uuid?: string;
574
672
  /** @description Pay schedule for salaried employees. */
575
673
  salaried_pay_schedule_uuid?: string;
576
674
  /** @description Default pay schedule for employees. */
577
675
  default_pay_schedule_uuid?: string;
676
+ /** @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. */
677
+ partial_assignment?: boolean;
578
678
  /** @description List of employees and their pay schedules. */
579
679
  employees?: {
580
680
  /** @description Employee UUID */
@@ -663,6 +763,97 @@ declare interface components {
663
763
  /** @description the URL of the form */
664
764
  document_url?: string;
665
765
  };
766
+ /** Document */
767
+ Document: {
768
+ /** @description The UUID of the document */
769
+ readonly uuid?: string;
770
+ /** @description The title of the document */
771
+ readonly title?: string;
772
+ /** @description The type identifier of the document */
773
+ readonly name?: string;
774
+ /**
775
+ * @description The type of recipient associated with the document (will be `Contractor` for Contractor Documents)
776
+ * @enum {string}
777
+ */
778
+ readonly recipient_type?: "Company" | "Employee" | "Contractor";
779
+ /** @description Unique identifier for the recipient associated with the document */
780
+ readonly recipient_uuid?: string;
781
+ /** @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. */
782
+ readonly pages?: {
783
+ /** @description Image URL for the page */
784
+ image_url?: string;
785
+ /** @description Page number */
786
+ page_number?: number;
787
+ }[];
788
+ /** @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. */
789
+ readonly fields?: {
790
+ /** @description Unique identifier of the field */
791
+ key?: string;
792
+ /** @description Auto-filled value of the field */
793
+ value?: string | null;
794
+ /** @description X-coordinate location of the field on the page */
795
+ x?: number;
796
+ /** @description Y-coordinate location of the field on the page */
797
+ y?: number;
798
+ /** @description Width of the field */
799
+ width?: number;
800
+ /** @description Height of the field */
801
+ height?: number;
802
+ /** @description Page number of the field */
803
+ page_number?: number;
804
+ /** @description The field's data type */
805
+ data_type?: string;
806
+ /** @description Whether the field is required */
807
+ required?: boolean;
808
+ }[];
809
+ /** @description When the document was signed (will be `null` if unsigned) */
810
+ readonly signed_at?: string | null;
811
+ /** @description The description of the document */
812
+ readonly description?: string;
813
+ /** @description A boolean flag that indicates whether the document needs signing or not. Note that this value will change after the document is signed. */
814
+ requires_signing?: boolean;
815
+ /** @description If the document is in a draft state */
816
+ readonly draft?: boolean;
817
+ /** @description The year of this document. This value is nullable and will not be present on all documents. */
818
+ readonly year?: number | null;
819
+ /** @description The quarter of this document. This value is nullable and will not be present on all documents. */
820
+ readonly quarter?: number | null;
821
+ };
822
+ /** Document Signed */
823
+ "Document-Signed": {
824
+ /** @description The UUID of the document */
825
+ readonly uuid?: string;
826
+ /** @description The title of the document */
827
+ readonly title?: string;
828
+ /** @description The type identifier of the document */
829
+ readonly name?: string;
830
+ /**
831
+ * @description The type of recipient associated with the document (will be `Contractor` for Contractor Documents)
832
+ * @enum {string}
833
+ */
834
+ readonly recipient_type?: "Company" | "Employee" | "Contractor";
835
+ /** @description Unique identifier for the recipient associated with the document */
836
+ readonly recipient_uuid?: string;
837
+ /** @description When the document was signed (will be `null` if unsigned) */
838
+ readonly signed_at?: string | null;
839
+ /** @description The description of the document */
840
+ readonly description?: string;
841
+ /** @description A boolean flag that indicates whether the document needs signing or not. Note that this value will change after the document is signed. */
842
+ requires_signing?: boolean;
843
+ /** @description If the document is in a draft state */
844
+ readonly draft?: boolean;
845
+ /** @description The year of this document. This value is nullable and will not be present on all documents. */
846
+ readonly year?: number | null;
847
+ /** @description The quarter of this document. This value is nullable and will not be present on all documents. */
848
+ readonly quarter?: number | null;
849
+ };
850
+ /** Document Pdf */
851
+ "Document-Pdf": {
852
+ /** @description the UUID of the document */
853
+ readonly uuid?: string;
854
+ /** @description the URL of the document */
855
+ document_url?: string;
856
+ };
666
857
  /** Industry */
667
858
  Industry: {
668
859
  /** @description Company uuid */
@@ -788,7 +979,7 @@ declare interface components {
788
979
  * @description The status of the webhook subscription.
789
980
  * @enum {string}
790
981
  */
791
- readonly status?: "pending" | "verified" | "removed";
982
+ readonly status?: "pending" | "verified" | "removed" | "unreachable";
792
983
  /** @description Receive updates for these types. */
793
984
  subscription_types?: ("BankAccount" | "Company" | "CompanyBenefit" | "Contractor" | "ContractorPayment" | "Employee" | "EmployeeBenefit" | "EmployeeJobCompensation" | "ExternalPayroll" | "Form" | "Location" | "Notification" | "Payroll" | "PaySchedule" | "Signatory")[];
794
985
  };
@@ -866,6 +1057,8 @@ declare interface components {
866
1057
  * @enum {string}
867
1058
  */
868
1059
  readonly entity_type?: "C-Corporation" | "S-Corporation" | "Sole proprietor" | "LLC" | "LLP" | "Limited partnership" | "Co-ownership" | "Association" | "Trusteeship" | "General partnership" | "Joint venture" | "Non-Profit";
1060
+ /** @description Whether the company only supports contractors. */
1061
+ contractor_only?: boolean;
869
1062
  /**
870
1063
  * @description The Gusto product tier of the company (not applicable to Embedded partner managed companies).
871
1064
  * @enum {string|null}
@@ -890,9 +1083,9 @@ declare interface components {
890
1083
  readonly is_partner_managed?: boolean;
891
1084
  /**
892
1085
  * @description The pay schedule assignment type.
893
- * @enum {string}
1086
+ * @enum {string|null}
894
1087
  */
895
- readonly pay_schedule_type?: "single" | "hourly_salaried" | "by_employee" | "by_department";
1088
+ readonly pay_schedule_type?: "single" | "hourly_salaried" | "by_employee" | "by_department" | null;
896
1089
  /** @description Company's first invoiceable event date */
897
1090
  readonly join_date?: string;
898
1091
  /**
@@ -1121,7 +1314,7 @@ declare interface components {
1121
1314
  * @description One of the "onboarding_status" enum values.
1122
1315
  * @enum {string}
1123
1316
  */
1124
- onboarding_status?: "onboarding_completed" | "admin_onboarding_review" | "admin_onboarding_incomplete";
1317
+ onboarding_status?: "admin_onboarding_incomplete" | "admin_onboarding_review" | "self_onboarding_not_invited" | "self_onboarding_invited" | "self_onboarding_started" | "self_onboarding_review" | "onboarding_completed";
1125
1318
  };
1126
1319
  /**
1127
1320
  * Contractor-Onboarding-Status
@@ -1402,10 +1595,22 @@ declare interface components {
1402
1595
  * 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
1596
  * */
1404
1597
  "Unprocessable-Entity-Error-Object": {
1598
+ errors?: components["schemas"]["Entity-Error-Object"][];
1599
+ };
1600
+ "Entity-Error-Object": {
1601
+ /** @description Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error. */
1602
+ error_key?: string;
1603
+ /** @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. */
1604
+ category?: string;
1605
+ /** @description Provides details about the error - generally this message can be surfaced to an end user. */
1606
+ message?: string;
1607
+ /** @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. */
1608
+ metadata?: Record<string, never>;
1609
+ /** @description Will only exist if category is `nested_errors`. It is possible to have multiple levels of nested errors. */
1405
1610
  errors?: {
1406
1611
  /** @description Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error. */
1407
1612
  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. */
1613
+ /** @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
1614
  category?: string;
1410
1615
  /** @description Provides details about the error - generally this message can be surfaced to an end user. */
1411
1616
  message?: string;
@@ -1479,6 +1684,20 @@ declare interface components {
1479
1684
  /** @description Whether this pay schedule is associated with any employees. A pay schedule is inactive when it's unassigned. */
1480
1685
  readonly active?: boolean;
1481
1686
  };
1687
+ /** @description The company attachment */
1688
+ "Company-Attachment": {
1689
+ /** @description UUID of the company attachment */
1690
+ uuid?: string;
1691
+ /** @description name of the file uploaded */
1692
+ name?: string;
1693
+ /**
1694
+ * @description The category of the company attachment
1695
+ * @enum {string}
1696
+ */
1697
+ category?: "gep_notice" | "compliance";
1698
+ /** @description The ISO 8601 timestamp of when an attachment was uploaded */
1699
+ upload_time?: string;
1700
+ };
1482
1701
  /** @description The company bank account */
1483
1702
  "Company-Bank-Account": {
1484
1703
  /** @description UUID of the bank account */
@@ -1604,34 +1823,44 @@ declare interface components {
1604
1823
  end_date?: string;
1605
1824
  /** @description Description of the benefit. */
1606
1825
  description?: string;
1607
- /** @description The aggregate of employee deduction for all employees given the period of time and benefit type. */
1826
+ /** @description The aggregate of employee deduction for all employees given the period of time and the specific company benefit. */
1608
1827
  company_benefit_deduction?: string;
1609
- /** @description The aggregate of company contribution for all employees given the period of time and benefit type. */
1828
+ /** @description The aggregate of company contribution for all employees given the period of time and the specific company benefit. */
1610
1829
  company_benefit_contribution?: string;
1611
1830
  employees?: {
1612
1831
  /** @description The UUID of the employee */
1613
1832
  uuid?: string;
1614
- /** @description The aggregate of employee deduction for all employees given the period of time and benefit type. */
1833
+ /** @description The sum of employee deduction for this employee given the period of time and the specific company benefit. */
1615
1834
  company_benefit_deduction?: string;
1616
- /** @description The aggregate of company contribution for all employees given the period of time and benefit type. */
1835
+ /** @description The sum of company contribution for this employee given the period of time and the specific company benefit. */
1617
1836
  company_benefit_contribution?: string;
1618
- /** @description Sum of employee benefit deduction given the period of time for this specific employee. */
1837
+ /** @description The sum of employee benefit deduction for this employee given the period of time and the benefit type. */
1619
1838
  benefit_deduction?: string;
1620
- /** @description Sum of company contribution given the period of time for this specific employee. */
1839
+ /** @description The sum of company contribution for this employee given the period of time and the benefit type. */
1621
1840
  benefit_contribution?: string;
1622
- /** @description Gross pay of this pay check. */
1841
+ /** @description Gross pay for this employee given the period of time. */
1623
1842
  gross_pay?: string;
1843
+ /** @description Total imputed pay for this employee given the period of time (not scoped to a benefit type). */
1844
+ imputed_pay?: string;
1624
1845
  payroll_benefits?: {
1625
1846
  payroll_uuid?: string;
1626
1847
  /** @description Whether it is regular or bonus payroll */
1627
1848
  payroll_type?: string;
1849
+ /** @description Check date of this payroll. */
1628
1850
  check_date?: string;
1851
+ /** @description Gross pay for this employee on the payroll. */
1629
1852
  gross_pay?: string;
1853
+ /** @description Total imputed pay for this employee on the payroll. */
1854
+ imputed_pay?: string;
1855
+ /** @description The employee benefit deduction amount for this employee on the payroll. */
1630
1856
  company_benefit_deduction?: string;
1857
+ /** @description The company contribution amount for this employee on the payroll. */
1631
1858
  company_benefit_contribution?: string;
1632
1859
  pay_period?: {
1633
- start_date?: string;
1634
- end_date?: string;
1860
+ /** @description The beginning of the payroll's pay period. */
1861
+ start_date?: string | null;
1862
+ /** @description The end of the payroll's pay period. */
1863
+ end_date?: string | null;
1635
1864
  };
1636
1865
  };
1637
1866
  };
@@ -1671,7 +1900,7 @@ declare interface components {
1671
1900
  * @default true
1672
1901
  */
1673
1902
  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”. */
1903
+ /** @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
1904
  description?: string;
1676
1905
  /** @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
1906
  deletable?: boolean;
@@ -1747,7 +1976,7 @@ declare interface components {
1747
1976
  * @default true
1748
1977
  */
1749
1978
  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”. */
1979
+ /** @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
1980
  description?: string;
1752
1981
  /** @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
1982
  deletable?: boolean;
@@ -1764,21 +1993,14 @@ declare interface components {
1764
1993
  /** @description The ID of the earning type. */
1765
1994
  readonly uuid: string;
1766
1995
  };
1767
- /** @description The representation of an employee benefit. */
1768
- "Employee-Benefit": {
1996
+ "Employee-Benefit-Base-Object": {
1769
1997
  /** @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
1998
  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
1999
  /**
1776
2000
  * @description Whether the employee benefit is active.
1777
2001
  * @default true
1778
2002
  */
1779
2003
  active: boolean;
1780
- /** @description The UUID of the employee benefit. */
1781
- readonly uuid: string;
1782
2004
  /**
1783
2005
  * @description The amount to be deducted, per pay period, from the employee's pay.
1784
2006
  * @default 0.00
@@ -1861,6 +2083,24 @@ declare interface components {
1861
2083
  */
1862
2084
  contribute_as_percentage: boolean;
1863
2085
  };
2086
+ /** @description The representation of an employee benefit. */
2087
+ "Employee-Benefit": components["schemas"]["Employee-Benefit-Base-Object"] & {
2088
+ /** @description The UUID of the employee to which the benefit belongs. */
2089
+ readonly employee_uuid?: string;
2090
+ /** @description The UUID of the company benefit. */
2091
+ readonly company_benefit_uuid?: string;
2092
+ /** @description The UUID of the employee benefit. */
2093
+ readonly uuid: string;
2094
+ };
2095
+ /** @description The representation of an employee benefit for a company benefit. */
2096
+ "Employee-Benefit-For-Company-Benefit": components["schemas"]["Employee-Benefit-Base-Object"] & {
2097
+ /** @description The UUID of the employee to which the benefit belongs. */
2098
+ employee_uuid: string;
2099
+ /** @description The UUID of the company benefit. */
2100
+ readonly company_benefit_uuid?: string;
2101
+ /** @description The UUID of the employee benefit. */
2102
+ readonly uuid?: string;
2103
+ };
1864
2104
  /** @description The representation of an employee pay stub information. */
1865
2105
  "Employee-Pay-Stub": {
1866
2106
  /** @description The UUID of the employee pay stub. */
@@ -1914,10 +2154,12 @@ declare interface components {
1914
2154
  * @enum {string|null}
1915
2155
  */
1916
2156
  "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;
2157
+ /** @description Indicates whether the payroll is an auto pilot payroll */
2158
+ "Auto-Pilot-Type": boolean;
1917
2159
  "Payroll-Employee-Compensations-Type": {
1918
2160
  /** @description The UUID of the employee. */
1919
2161
  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. */
2162
+ /** @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
2163
  readonly excluded?: boolean;
1922
2164
  /** @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
2165
  version?: string;
@@ -2024,6 +2266,8 @@ declare interface components {
2024
2266
  readonly benefits?: string;
2025
2267
  /** @description The total amount of employee deducted benefits for the payroll. */
2026
2268
  readonly employee_benefits_deductions?: string;
2269
+ /** @description The total amount of imputed pay for the payroll. */
2270
+ readonly imputed_pay?: string;
2027
2271
  /** @description The total amount of payroll taxes deferred for the payroll, such as allowed by the CARES act. */
2028
2272
  readonly deferred_payroll_taxes?: string;
2029
2273
  /** @description The total amount of deductions for the payroll. */
@@ -2045,7 +2289,7 @@ declare interface components {
2045
2289
  /** @description Current check date. */
2046
2290
  readonly current_check_date?: string;
2047
2291
  /** @description Original debit date when fast ach applies. */
2048
- readonly original_debit_date?: number;
2292
+ readonly original_debit_date?: string;
2049
2293
  /** @description Current debit date. */
2050
2294
  readonly current_debit_date?: string;
2051
2295
  /** @description The reason why the payroll is moved to four day. */
@@ -2090,7 +2334,7 @@ declare interface components {
2090
2334
  "Payroll-Processed-Type": boolean;
2091
2335
  /** @description The date at which the payroll was processed. Null if the payroll isn't processed yet. */
2092
2336
  "Payroll-Processed-Date-Type": string;
2093
- /** @description A timestamp of the last valid payroll calculation. Null is there isn't a valid calculation. */
2337
+ /** @description A timestamp of the last valid payroll calculation. Null if there isn't a valid calculation. */
2094
2338
  "Payroll-Calculated-At-Type": string;
2095
2339
  /** @description The UUID of the payroll. */
2096
2340
  "Payroll-Payroll-Uuid-Type": string;
@@ -2110,6 +2354,7 @@ declare interface components {
2110
2354
  /** @description The name of an available type of fixed compensation. */
2111
2355
  readonly name?: string;
2112
2356
  }[];
2357
+ /** @description Only included for processed or calculated payrolls */
2113
2358
  "Payroll-Submission-Blockers-Type": {
2114
2359
  /** @description The type of blocker that's blocking the payment submission. */
2115
2360
  readonly blocker_type?: string;
@@ -2132,6 +2377,7 @@ declare interface components {
2132
2377
  */
2133
2378
  status?: "unresolved" | "resolved";
2134
2379
  }[];
2380
+ /** @description Only included for processed payrolls */
2135
2381
  "Payroll-Credit-Blockers-Type": {
2136
2382
  /** @description The type of blocker that's blocking the payment from being credited. */
2137
2383
  readonly blocker_type?: string;
@@ -2154,6 +2400,15 @@ declare interface components {
2154
2400
  */
2155
2401
  status?: "unresolved" | "pending_review" | "resolved" | "failed";
2156
2402
  }[];
2403
+ "Payroll-Processing-Request": {
2404
+ /**
2405
+ * @description The status of the payroll processing request
2406
+ * @enum {string}
2407
+ */
2408
+ readonly status?: "calculating" | "calculate_success" | "submitting" | "submit_success" | "processing_failed";
2409
+ /** @description Errors that occurred during async payroll processing */
2410
+ readonly errors?: components["schemas"]["Entity-Error-Object"][];
2411
+ } | null;
2157
2412
  Payroll: {
2158
2413
  payroll_deadline?: components["schemas"]["Payroll-Deadline-Type"];
2159
2414
  check_date?: components["schemas"]["Payroll-Check-Date-Type"];
@@ -2164,6 +2419,7 @@ declare interface components {
2164
2419
  company_uuid?: components["schemas"]["Payroll-Company-Uuid-Type"];
2165
2420
  off_cycle?: components["schemas"]["Payroll-Off-Cycle-Type"];
2166
2421
  off_cycle_reason?: components["schemas"]["Off-Cycle-Reason-Type"];
2422
+ auto_pilot?: components["schemas"]["Auto-Pilot-Type"];
2167
2423
  external?: components["schemas"]["Payroll-External-Type"];
2168
2424
  final_termination_payroll?: components["schemas"]["Payroll-Final-Termination-Payroll-Type"];
2169
2425
  withholding_pay_period?: components["schemas"]["Payroll-Withholding-Pay-Period-Type"];
@@ -2178,6 +2434,7 @@ declare interface components {
2178
2434
  created_at?: components["schemas"]["Created-At-Type"];
2179
2435
  submission_blockers?: components["schemas"]["Payroll-Submission-Blockers-Type"];
2180
2436
  credit_blockers?: components["schemas"]["Payroll-Credit-Blockers-Type"];
2437
+ processing_request?: components["schemas"]["Payroll-Processing-Request"];
2181
2438
  };
2182
2439
  "Payroll-Prepared": {
2183
2440
  payroll_deadline?: components["schemas"]["Payroll-Deadline-Type"];
@@ -2189,6 +2446,7 @@ declare interface components {
2189
2446
  company_uuid?: components["schemas"]["Payroll-Company-Uuid-Type"];
2190
2447
  off_cycle?: components["schemas"]["Payroll-Off-Cycle-Type"];
2191
2448
  off_cycle_reason?: components["schemas"]["Off-Cycle-Reason-Type"];
2449
+ auto_pilot?: components["schemas"]["Auto-Pilot-Type"];
2192
2450
  external?: components["schemas"]["Payroll-External-Type"];
2193
2451
  final_termination_payroll?: components["schemas"]["Payroll-Final-Termination-Payroll-Type"];
2194
2452
  withholding_pay_period?: components["schemas"]["Payroll-Withholding-Pay-Period-Type"];
@@ -2200,6 +2458,7 @@ declare interface components {
2200
2458
  payment_speed_changed?: components["schemas"]["Payroll-Payment-Speed-Changed-Type"];
2201
2459
  created_at?: components["schemas"]["Created-At-Type"];
2202
2460
  fixed_compensation_types?: components["schemas"]["Payroll-Fixed-Compensation-Types-Type"];
2461
+ processing_request?: components["schemas"]["Payroll-Processing-Request"];
2203
2462
  };
2204
2463
  "Payroll-Minimal": {
2205
2464
  payroll_deadline?: components["schemas"]["Payroll-Deadline-Type"];
@@ -2211,6 +2470,7 @@ declare interface components {
2211
2470
  company_uuid: components["schemas"]["Payroll-Company-Uuid-Type"];
2212
2471
  off_cycle?: components["schemas"]["Payroll-Off-Cycle-Type"];
2213
2472
  off_cycle_reason?: components["schemas"]["Off-Cycle-Reason-Type"];
2473
+ auto_pilot?: components["schemas"]["Auto-Pilot-Type"];
2214
2474
  external?: components["schemas"]["Payroll-External-Type"];
2215
2475
  final_termination_payroll?: components["schemas"]["Payroll-Final-Termination-Payroll-Type"];
2216
2476
  withholding_pay_period?: components["schemas"]["Payroll-Withholding-Pay-Period-Type"];
@@ -2559,9 +2819,9 @@ declare interface components {
2559
2819
  "Pay-Schedule-Assignment": {
2560
2820
  /**
2561
2821
  * @description The pay schedule assignment type.
2562
- * @enum {string}
2822
+ * @enum {string|null}
2563
2823
  */
2564
- readonly type?: "single" | "hourly_salaried" | "by_employee" | "by_department";
2824
+ readonly type?: "single" | "hourly_salaried" | "by_employee" | "by_department" | null;
2565
2825
  /** @description Pay schedule for hourly employees. */
2566
2826
  readonly hourly_pay_schedule_uuid?: string | null;
2567
2827
  /** @description Pay schedule for salaried employees. */
@@ -2589,9 +2849,9 @@ declare interface components {
2589
2849
  "Pay-Schedule-Assignment-Preview": {
2590
2850
  /**
2591
2851
  * @description The pay schedule assignment type.
2592
- * @enum {string}
2852
+ * @enum {string|null}
2593
2853
  */
2594
- readonly type?: "single" | "hourly_salaried" | "by_employee" | "by_department";
2854
+ readonly type?: "single" | "hourly_salaried" | "by_employee" | "by_department" | null;
2595
2855
  /** @description A list of pay schedule changes including pay period and transition pay period. */
2596
2856
  employee_changes?: components["schemas"]["Pay-Schedule-Assignment-Employee-Change"][];
2597
2857
  };
@@ -2644,14 +2904,14 @@ declare interface components {
2644
2904
  * - Married, but withhold as Single (does not apply to rev_2020_w4 form) */
2645
2905
  filing_status?: string;
2646
2906
  /** @description An employee can request an additional amount to be withheld from each paycheck. */
2647
- extra_withholding?: string;
2907
+ extra_withholding?: string | null;
2648
2908
  /** @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;
2909
+ two_jobs?: boolean | null;
2650
2910
  /** @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;
2911
+ dependents_amount?: string | null;
2652
2912
  /** @description Other income amount. */
2653
- other_income?: string;
2654
- deductions?: string;
2913
+ other_income?: string | null;
2914
+ deductions?: string | null;
2655
2915
  /**
2656
2916
  * @description The version of w4 form.
2657
2917
  * @enum {string}
@@ -2937,18 +3197,18 @@ declare interface components {
2937
3197
  * @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
3198
  */
2939
3199
  accrual_rate_unit?: string;
2940
- /** @description Boolean representing if an employees accrued time off hours will be paid out on termination */
3200
+ /** @description Boolean representing if an employee's accrued time off hours will be paid out on termination */
2941
3201
  paid_out_on_termination?: boolean;
2942
3202
  /** @description Number of days before an employee on the policy will begin accruing time off hours */
2943
3203
  accrual_waiting_period_days?: number;
2944
3204
  /**
2945
3205
  * Format: float
2946
- * @description The max number of hours and employee can carryover from one year to the next
3206
+ * @description The max number of hours an employee can carryover from one year to the next
2947
3207
  */
2948
3208
  carryover_limit_hours?: string;
2949
3209
  /**
2950
3210
  * Format: float
2951
- * @description The max number of hours and employee can accrue in a year
3211
+ * @description The max number of hours an employee can accrue in a year
2952
3212
  */
2953
3213
  max_accrual_hours_per_year?: string;
2954
3214
  /**
@@ -3167,8 +3427,8 @@ declare interface components {
3167
3427
  * @description Status of the recovery case
3168
3428
  * @enum {string}
3169
3429
  */
3170
- status?: "open" | "redebit_initiated" | "recovered" | "lost";
3171
- /** @description The latest bank error code for the recovery case. See [this article](https://engineering.gusto.com/how-ach-works-a-developer-perspective-part-2/) for a complete list of ACH return codes. */
3430
+ status?: "open" | "redebit_initiated" | "wire_initiated" | "recovered" | "lost";
3431
+ /** @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
3432
  latest_error_code?: string;
3173
3433
  /** @description Date when funds were originally debited from the company's bank account */
3174
3434
  original_debit_date?: string;
@@ -3369,6 +3629,15 @@ declare interface components {
3369
3629
  };
3370
3630
  };
3371
3631
  /** @description Example response */
3632
+ "Historical-Employee-Object": {
3633
+ headers: {
3634
+ [name: string]: unknown;
3635
+ };
3636
+ content: {
3637
+ "application/json": components["schemas"]["Employee"];
3638
+ };
3639
+ };
3640
+ /** @description Example response */
3372
3641
  "Employee-List": {
3373
3642
  headers: {
3374
3643
  [name: string]: unknown;
@@ -3554,6 +3823,24 @@ declare interface components {
3554
3823
  };
3555
3824
  };
3556
3825
  /** @description Example response */
3826
+ "Company-Attachment-Object": {
3827
+ headers: {
3828
+ [name: string]: unknown;
3829
+ };
3830
+ content: {
3831
+ "application/json": components["schemas"]["Company-Attachment"];
3832
+ };
3833
+ };
3834
+ /** @description Example response */
3835
+ "Company-Attachment-List": {
3836
+ headers: {
3837
+ [name: string]: unknown;
3838
+ };
3839
+ content: {
3840
+ "application/json": components["schemas"]["Company-Attachment"][];
3841
+ };
3842
+ };
3843
+ /** @description Example response */
3557
3844
  "Signatory-List": {
3558
3845
  headers: {
3559
3846
  [name: string]: unknown;
@@ -3698,6 +3985,15 @@ declare interface components {
3698
3985
  };
3699
3986
  };
3700
3987
  /** @description Example response */
3988
+ "Created-Contractor-Object": {
3989
+ headers: {
3990
+ [name: string]: unknown;
3991
+ };
3992
+ content: {
3993
+ "application/json": components["schemas"]["Contractor"];
3994
+ };
3995
+ };
3996
+ /** @description Example response */
3701
3997
  "Contractor-Object": {
3702
3998
  headers: {
3703
3999
  [name: string]: unknown;
@@ -3796,6 +4092,15 @@ declare interface components {
3796
4092
  "application/json": components["schemas"]["Garnishment"][];
3797
4093
  };
3798
4094
  };
4095
+ /** @description Example response */
4096
+ "Child-Support-Data-Object": {
4097
+ headers: {
4098
+ [name: string]: unknown;
4099
+ };
4100
+ content: {
4101
+ "application/json": components["schemas"]["Child-Support-Data"];
4102
+ };
4103
+ };
3799
4104
  /** @description Example Response */
3800
4105
  "Termination-Object": {
3801
4106
  headers: {
@@ -4317,6 +4622,8 @@ declare interface components {
4317
4622
  benefit_id: string;
4318
4623
  /** @description The UUID of the compensation */
4319
4624
  compensation_id: string;
4625
+ /** @description The UUID of the company attachment */
4626
+ company_attachment_uuid: string;
4320
4627
  /** @description The UUID of the company benefit */
4321
4628
  company_benefit_id: string;
4322
4629
  /** @description The UUID of the company */
@@ -4352,6 +4659,8 @@ declare interface components {
4352
4659
  external_payroll_id: string;
4353
4660
  /** @description The UUID of the form */
4354
4661
  form_id: string;
4662
+ /** @description The ID or UUID of the document */
4663
+ document_uuid: string;
4355
4664
  /** @description The UUID of the garnishment */
4356
4665
  garnishment_id: string;
4357
4666
  /** @description The UUID of the home address */
@@ -4396,7 +4705,7 @@ declare interface components {
4396
4705
  webhook_subscription_uuid: string;
4397
4706
  /** @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
4707
  VersionHeader: "2024-04-01";
4399
- /** @description The UUID of the notification */
4708
+ /** @description The notification entity_uuid */
4400
4709
  notification_uuid: string;
4401
4710
  /** @description The month we are calculating the invoice for. Must be in YYYY-MM format */
4402
4711
  invoice_period: string;
@@ -4475,6 +4784,50 @@ declare interface DeductionsProps extends CommonComponentInterface {
4475
4784
  employeeId: string;
4476
4785
  }
4477
4786
 
4787
+ declare type DeepPartial<T> = {
4788
+ [P in keyof T]?: T[P] extends (infer U)[]
4789
+ ? DeepPartial<U>[]
4790
+ : T[P] extends object
4791
+ ? DeepPartial<T[P]>
4792
+ : T[P]
4793
+ }
4794
+
4795
+ export declare type Dictionary = Record<string, Partial<{
4796
+ [K in keyof Resources]: DeepPartial<Resources[K]>;
4797
+ }>>;
4798
+
4799
+ declare function DocumentList(): JSX_2.Element | null;
4800
+
4801
+ declare function DocumentListHead(): JSX_2.Element | null;
4802
+
4803
+ export declare function DocumentSigner(): JSX_2.Element;
4804
+
4805
+ declare function DocumentSigner_2(props: DocumentSignerProps & BaseComponentInterface): JSX_2.Element;
4806
+
4807
+ declare namespace DocumentSigner_2 {
4808
+ var DocumentListHead: DocumentListHead;
4809
+ var DocumentList: DocumentList;
4810
+ var SignatureFormHead: SignatureFormHead;
4811
+ var SignatureForm: SignatureForm;
4812
+ }
4813
+
4814
+ declare type DocumentSignerContextType = {
4815
+ employeeForms: Schemas['Form'][];
4816
+ isPending: boolean;
4817
+ mode: MODE_4;
4818
+ handleRequestFormToSign: (form: Schemas['Form']) => void;
4819
+ handleContinue: () => void;
4820
+ documentListError: Error | null;
4821
+ formToSign?: Schemas['Form'];
4822
+ pdfUrl?: string;
4823
+ handleBack: () => void;
4824
+ handleSubmit: (event: React.FormEvent<HTMLFormElement>) => void;
4825
+ };
4826
+
4827
+ declare interface DocumentSignerProps extends CommonComponentInterface {
4828
+ employeeId: string;
4829
+ }
4830
+
4478
4831
  declare namespace Employee {
4479
4832
  export {
4480
4833
  EmployeeList,
@@ -4487,9 +4840,9 @@ declare namespace Employee {
4487
4840
  IncludeDeductionsPayload,
4488
4841
  Root,
4489
4842
  DeductionsContextual,
4490
- OnboardingSummary,
4843
+ OnboardingSummary_2 as OnboardingSummary,
4491
4844
  OnboardingSummaryContextual,
4492
- Profile,
4845
+ Profile_2 as Profile,
4493
4846
  useProfile,
4494
4847
  ProfileContextual,
4495
4848
  Compensation,
@@ -4497,14 +4850,17 @@ declare namespace Employee {
4497
4850
  CompensationInputs,
4498
4851
  CompensationOutputs,
4499
4852
  CompensationContextual,
4500
- Taxes,
4853
+ Taxes_2 as Taxes,
4501
4854
  useTaxes,
4502
4855
  TaxesContextual,
4503
- PaymentMethod,
4856
+ PaymentMethod_2 as PaymentMethod,
4504
4857
  usePaymentMethod,
4505
4858
  CombinedSchemaInputs,
4506
4859
  CombinedSchemaOutputs,
4507
- PaymentMethodContextual
4860
+ PaymentMethodContextual,
4861
+ Landing_2 as Landing,
4862
+ DocumentSigner_2 as DocumentSigner,
4863
+ useDocumentSigner
4508
4864
  }
4509
4865
  }
4510
4866
  export { Employee }
@@ -4518,7 +4874,7 @@ declare namespace EmployeeList {
4518
4874
 
4519
4875
  declare type EmployeeListContextType = {
4520
4876
  handleEdit: (uuid: string) => void;
4521
- handleDelete: (uuid: string) => void;
4877
+ handleDelete: (uuid: string) => Promise<void>;
4522
4878
  handleNew: () => void;
4523
4879
  employees: Schemas['Employee'][];
4524
4880
  };
@@ -4535,6 +4891,7 @@ declare interface EmployeeListProps extends CommonComponentInterface {
4535
4891
  export declare interface EmployeeOnboardingContextInterface extends FlowContextInterface {
4536
4892
  companyId: string;
4537
4893
  employeeId?: string;
4894
+ isAdmin?: boolean;
4538
4895
  paymentMethod?: Schemas['Employee-Payment-Method'];
4539
4896
  }
4540
4897
 
@@ -4544,13 +4901,26 @@ export declare interface EmployeeOnboardingFlowProps extends BaseComponentInterf
4544
4901
  companyId: string;
4545
4902
  }
4546
4903
 
4904
+ export declare interface EmployeeSelfOnboardingContextInterface extends FlowContextInterface {
4905
+ companyId: string;
4906
+ employeeId: string;
4907
+ paymentMethod?: Schemas['Employee-Payment-Method'];
4908
+ }
4909
+
4910
+ export declare const EmployeeSelfOnboardingFlow: ({ companyId, employeeId, onEvent, }: EmployeeSelfOnboardingFlowProps) => JSX_2.Element;
4911
+
4912
+ export declare interface EmployeeSelfOnboardingFlowProps extends BaseComponentInterface {
4913
+ companyId: string;
4914
+ employeeId: string;
4915
+ }
4916
+
4547
4917
  declare type EventType = (typeof componentEvents)[keyof typeof componentEvents];
4548
4918
 
4549
4919
  declare function FederalForm(): JSX_2.Element;
4550
4920
 
4551
4921
  declare function FederalHead(): JSX_2.Element;
4552
4922
 
4553
- declare interface FlowContextInterface {
4923
+ export declare interface FlowContextInterface {
4554
4924
  component: React.ComponentType | null;
4555
4925
  onEvent: OnEventType<EventType, unknown>;
4556
4926
  title?: string;
@@ -4558,25 +4928,31 @@ declare interface FlowContextInterface {
4558
4928
 
4559
4929
  declare interface GTheme {
4560
4930
  rootFS: string
4561
- colors?: GThemeColors
4562
- focus?: GThemeFocus
4563
- shadow?: GThemeShadow
4564
- spacing?: GThemeSpacing
4565
- typography?: GThemeTypography
4931
+ colors: GThemeColors
4932
+ focus: GThemeFocus
4933
+ shadow: GThemeShadow
4934
+ spacing: GThemeSpacing
4935
+ typography: GThemeTypography
4566
4936
  input: GThemeInput
4567
4937
  button: GThemeButton
4568
4938
  radio: GThemeRadio
4569
4939
  checkbox: GThemeCheckbox
4570
- table?: GThemeTable
4571
- link?: GThemeLink
4572
- badge?: GThemeBadge
4573
- optionalLabel?: string //This is a string pulled from translations to indicate (optional) on form elements
4940
+ table: GThemeTable
4941
+ link: GThemeLink
4942
+ badge: GThemeBadge
4943
+ optionalLabel: string //This is a string pulled from translations to indicate (optional) on form elements
4574
4944
  }
4575
4945
 
4576
4946
  declare interface GThemeBadge {
4947
+ success: {
4948
+ color: string
4949
+ backgroundColor: string
4950
+ borderColor: string
4951
+ }
4577
4952
  fontSize: string
4578
4953
  fontWeight: number
4579
4954
  borderWidth: string
4955
+ borderRadius: string
4580
4956
  paddingX: string
4581
4957
  paddingY: string
4582
4958
  }
@@ -4585,6 +4961,8 @@ declare interface GThemeButton {
4585
4961
  fontSize: string
4586
4962
  fontWeight: number
4587
4963
  borderWidth: string
4964
+ borderRadius: string
4965
+ textStyle: 'uppercase' | 'none' | 'capitalize' | 'lowercase'
4588
4966
  paddingX: string
4589
4967
  paddingY: string
4590
4968
  shadow: string
@@ -4621,6 +4999,18 @@ declare interface GThemeColors {
4621
4999
  900: ThemeColor
4622
5000
  1000: ThemeColor
4623
5001
  }
5002
+ gray: {
5003
+ 100: ThemeColor
5004
+ 200: ThemeColor
5005
+ 300: ThemeColor
5006
+ 400: ThemeColor
5007
+ 500: ThemeColor
5008
+ 600: ThemeColor
5009
+ 700: ThemeColor
5010
+ 800: ThemeColor
5011
+ 900: ThemeColor
5012
+ 1000: ThemeColor
5013
+ }
4624
5014
  error: {
4625
5015
  100: ThemeColor
4626
5016
  500: ThemeColor
@@ -4629,6 +5019,7 @@ declare interface GThemeColors {
4629
5019
  warning: {
4630
5020
  100: ThemeColor
4631
5021
  500: ThemeColor
5022
+ 700: ThemeColor
4632
5023
  800: ThemeColor
4633
5024
  }
4634
5025
  success: {
@@ -4645,12 +5036,26 @@ declare interface GThemeFocus {
4645
5036
  }
4646
5037
 
4647
5038
  declare interface GThemeInput {
5039
+ fontSize: string
4648
5040
  textColor: ThemeColor
4649
5041
  borderColor: ThemeColor
5042
+ borderWidth: string
5043
+ background: string
4650
5044
  padding: string
4651
5045
  labelFontSize: string
4652
5046
  labelColor: ThemeColor
4653
5047
  labelFontWeight: number
5048
+ disabled: {
5049
+ color: ThemeColor
5050
+ border: ThemeColor
5051
+ bg: ThemeColor
5052
+ }
5053
+ hovered: {
5054
+ borderColor: ThemeColor
5055
+ }
5056
+ placeholderColor: ThemeColor
5057
+ descriptionColor: ThemeColor
5058
+ disabledColor: ThemeColor
4654
5059
  }
4655
5060
 
4656
5061
  declare interface GThemeLink {
@@ -4676,6 +5081,7 @@ declare interface GThemeRadio {
4676
5081
  }
4677
5082
 
4678
5083
  declare interface GThemeShadow {
5084
+ 100: string
4679
5085
  200: string
4680
5086
  }
4681
5087
 
@@ -4692,20 +5098,42 @@ declare interface GThemeSpacing {
4692
5098
  }
4693
5099
 
4694
5100
  declare interface GThemeTable {
4695
- borderColor?: string
4696
- background?: string
4697
- highlightBg?: string
4698
- highlightFg?: string
4699
- focusRingColor?: string
4700
- textColor?: string
5101
+ paddingX: string
5102
+ paddingY: string
5103
+ fontSize: string
5104
+ headerColor: string
5105
+ headerBg: string
5106
+ columnWeight: number
5107
+ borderColor: string
5108
+ background: string
5109
+ highlightBg: string
5110
+ highlightFg: string
5111
+ textColor: string
4701
5112
  }
4702
5113
 
4703
5114
  declare interface GThemeTypography {
4704
- font?: string
4705
- fontBold?: string
4706
- textColor?: ThemeColor
4707
- errorTextColor?: ThemeColor
4708
- defaultLineHeight?: string
5115
+ font: string
5116
+ textColor: ThemeColor
5117
+ errorTextColor: ThemeColor
5118
+ defaultLineHeight: string
5119
+ fontSize: {
5120
+ small: string
5121
+ regular: string
5122
+ medium: string
5123
+ }
5124
+ fontWeight: {
5125
+ book: number
5126
+ medium: number
5127
+ }
5128
+ disabledTextColor: ThemeColor
5129
+ headings: {
5130
+ 1: string
5131
+ 2: string
5132
+ 3: string
5133
+ 4: string
5134
+ 5: string
5135
+ 6: string
5136
+ }
4709
5137
  }
4710
5138
 
4711
5139
  export declare function GustoApiContextProvider({ children, context, }: {
@@ -4717,11 +5145,11 @@ export declare function GustoApiContextProvider({ children, context, }: {
4717
5145
 
4718
5146
  export declare interface GustoApiProps {
4719
5147
  config?: APIConfig;
4720
- dictionary?: Resource;
5148
+ dictionary?: Dictionary;
4721
5149
  lng?: string;
4722
5150
  locale?: string;
4723
5151
  currency?: string;
4724
- theme?: GTheme;
5152
+ theme?: DeepPartial<GTheme>;
4725
5153
  children?: default_3.ReactNode;
4726
5154
  }
4727
5155
 
@@ -4764,6 +5192,56 @@ export declare class GustoClient {
4764
5192
  }, {
4765
5193
  params: {};
4766
5194
  }, `${string}/${string}`>>;
5195
+ getCompany(company_id: string): Promise<{
5196
+ readonly ein?: string;
5197
+ readonly entity_type?: "C-Corporation" | "S-Corporation" | "Sole proprietor" | "LLC" | "LLP" | "Limited partnership" | "Co-ownership" | "Association" | "Trusteeship" | "General partnership" | "Joint venture" | "Non-Profit";
5198
+ contractor_only?: boolean;
5199
+ readonly tier?: "simple" | "plus" | "premium" | "core" | "complete" | "concierge" | "contractor_only" | "basic" | null;
5200
+ is_suspended?: boolean;
5201
+ readonly company_status?: "Approved" | "Not Approved" | "Suspended";
5202
+ readonly uuid: string;
5203
+ readonly name?: string;
5204
+ readonly slug?: string;
5205
+ readonly trade_name?: string;
5206
+ readonly is_partner_managed?: boolean;
5207
+ readonly pay_schedule_type?: "single" | "hourly_salaried" | "by_employee" | "by_department" | null;
5208
+ readonly join_date?: string;
5209
+ funding_type?: "ach" | "reverse_wire" | "wire_in" | "brex";
5210
+ readonly locations?: components["schemas"]["Company-Address"][];
5211
+ readonly compensations?: {
5212
+ readonly hourly?: {
5213
+ readonly name?: string;
5214
+ readonly multiple?: number;
5215
+ }[];
5216
+ readonly fixed?: {
5217
+ name?: string;
5218
+ }[];
5219
+ readonly paid_time_off?: {
5220
+ readonly name?: string;
5221
+ }[];
5222
+ };
5223
+ readonly primary_signatory?: {
5224
+ readonly first_name?: string;
5225
+ readonly middle_initial?: string;
5226
+ readonly last_name?: string;
5227
+ readonly phone?: string;
5228
+ readonly email?: string;
5229
+ readonly home_address?: {
5230
+ readonly street_1?: string;
5231
+ readonly street_2?: string | null;
5232
+ readonly city?: string;
5233
+ readonly state?: string;
5234
+ readonly zip?: string;
5235
+ readonly country?: string;
5236
+ };
5237
+ };
5238
+ primary_payroll_admin?: {
5239
+ readonly first_name?: string;
5240
+ readonly last_name?: string;
5241
+ readonly phone?: string;
5242
+ readonly email?: string;
5243
+ };
5244
+ }>;
4767
5245
  getCompanyOnboardingStatus(company_uuid: string): Promise<FetchResponse< {
4768
5246
  parameters: {
4769
5247
  query?: never;
@@ -4790,7 +5268,7 @@ export declare class GustoClient {
4790
5268
  getEmployee(employee_id: string): Promise<FetchResponse< {
4791
5269
  parameters: {
4792
5270
  query?: {
4793
- include?: "all_compensations" | "custom_fields";
5271
+ include?: ("all_compensations" | "custom_fields")[];
4794
5272
  };
4795
5273
  header?: {
4796
5274
  "X-Gusto-API-Version"?: components["parameters"]["VersionHeader"];
@@ -4819,11 +5297,11 @@ export declare class GustoClient {
4819
5297
  last_name: string;
4820
5298
  email?: string | null;
4821
5299
  readonly company_uuid?: string;
4822
- readonly manager_uuid?: string;
5300
+ readonly manager_uuid?: string | null;
4823
5301
  readonly version?: string;
4824
5302
  readonly department?: string | null;
4825
5303
  readonly terminated?: boolean;
4826
- two_percent_shareholder?: boolean;
5304
+ two_percent_shareholder?: boolean | null;
4827
5305
  readonly onboarded?: boolean;
4828
5306
  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";
4829
5307
  jobs?: components["schemas"]["Job"][];
@@ -4834,8 +5312,8 @@ export declare class GustoClient {
4834
5312
  readonly date_of_birth?: string | null;
4835
5313
  has_ssn?: boolean;
4836
5314
  ssn?: string;
4837
- phone?: string;
4838
- preferred_first_name?: string;
5315
+ phone?: string | null;
5316
+ preferred_first_name?: string | null;
4839
5317
  payment_method: "Direct Deposit" | "Check";
4840
5318
  work_email?: string | null;
4841
5319
  readonly current_employment_status?: "full_time" | "part_time_under_twenty_hours" | "part_time_twenty_plus_hours" | "variable" | "seasonal" | null;
@@ -4861,7 +5339,7 @@ export declare class GustoClient {
4861
5339
  parameters: {
4862
5340
  query?: {
4863
5341
  terminated?: boolean;
4864
- include?: "all_compensations" | "custom_fields";
5342
+ include?: ("all_compensations" | "custom_fields")[];
4865
5343
  page?: components["parameters"]["pageParam"];
4866
5344
  per?: components["parameters"]["perParam"];
4867
5345
  search_term?: components["parameters"]["search_term"];
@@ -4897,11 +5375,11 @@ export declare class GustoClient {
4897
5375
  last_name: string;
4898
5376
  email?: string | null;
4899
5377
  readonly company_uuid?: string;
4900
- readonly manager_uuid?: string;
5378
+ readonly manager_uuid?: string | null;
4901
5379
  readonly version?: string;
4902
5380
  readonly department?: string | null;
4903
5381
  readonly terminated?: boolean;
4904
- two_percent_shareholder?: boolean;
5382
+ two_percent_shareholder?: boolean | null;
4905
5383
  readonly onboarded?: boolean;
4906
5384
  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";
4907
5385
  jobs?: components["schemas"]["Job"][];
@@ -4912,8 +5390,8 @@ export declare class GustoClient {
4912
5390
  readonly date_of_birth?: string | null;
4913
5391
  has_ssn?: boolean;
4914
5392
  ssn?: string;
4915
- phone?: string;
4916
- preferred_first_name?: string;
5393
+ phone?: string | null;
5394
+ preferred_first_name?: string | null;
4917
5395
  payment_method: "Direct Deposit" | "Check";
4918
5396
  work_email?: string | null;
4919
5397
  readonly current_employment_status?: "full_time" | "part_time_under_twenty_hours" | "part_time_twenty_plus_hours" | "variable" | "seasonal" | null;
@@ -5445,6 +5923,8 @@ export declare class GustoClient {
5445
5923
  annual_maximum: string | null;
5446
5924
  pay_period_maximum: string | null;
5447
5925
  deduct_as_percentage: boolean;
5926
+ garnishment_type?: "child_support" | "federal_tax_lien" | "state_tax_lien" | "student_loan" | "creditor_garnishment" | "federal_loan" | "other_garnishment" | null;
5927
+ child_support?: components["schemas"]["Garnishment-Child-Support"];
5448
5928
  }>;
5449
5929
  updateDeduction(garnishment_id: string, body: BodyParams<'/v1/garnishments/{garnishment_id}', 'PUT'>): Promise<{
5450
5930
  readonly uuid: string;
@@ -5459,6 +5939,8 @@ export declare class GustoClient {
5459
5939
  annual_maximum: string | null;
5460
5940
  pay_period_maximum: string | null;
5461
5941
  deduct_as_percentage: boolean;
5942
+ garnishment_type?: "child_support" | "federal_tax_lien" | "state_tax_lien" | "student_loan" | "creditor_garnishment" | "federal_loan" | "other_garnishment" | null;
5943
+ child_support?: components["schemas"]["Garnishment-Child-Support"];
5462
5944
  }>;
5463
5945
  getEmployeeBankAccounts(employee_id: string): Promise<FetchResponse< {
5464
5946
  parameters: {
@@ -5707,10 +6189,10 @@ export declare class GustoClient {
5707
6189
  }, `${string}/${string}`>>;
5708
6190
  previewPayScheduleDates(company_id: string, query: QueryParams<'/v1/companies/{company_id}/pay_schedules/preview'>): Promise<FetchResponse< {
5709
6191
  parameters: {
5710
- query?: {
5711
- frequency?: "Every week" | "Every other week" | "Twice per month" | "Monthly";
5712
- anchor_pay_date?: string;
5713
- anchor_end_of_pay_period?: string;
6192
+ query: {
6193
+ frequency: "Every week" | "Every other week" | "Twice per month" | "Monthly";
6194
+ anchor_pay_date: string;
6195
+ anchor_end_of_pay_period: string;
5714
6196
  day_1?: number;
5715
6197
  day_2?: number;
5716
6198
  };
@@ -5747,45 +6229,34 @@ export declare class GustoClient {
5747
6229
  company_id: string;
5748
6230
  };
5749
6231
  query: {
5750
- frequency?: "Every week" | "Every other week" | "Twice per month" | "Monthly";
5751
- anchor_pay_date?: string;
5752
- anchor_end_of_pay_period?: string;
6232
+ frequency: "Every week" | "Every other week" | "Twice per month" | "Monthly";
6233
+ anchor_pay_date: string;
6234
+ anchor_end_of_pay_period: string;
5753
6235
  day_1?: number;
5754
6236
  day_2?: number;
5755
- } | undefined;
5756
- };
5757
- }, `${string}/${string}`>>;
5758
- getEmployeeFederalTaxes(employee_uuid: string): Promise<FetchResponse< {
5759
- parameters: {
5760
- query?: never;
5761
- header?: {
5762
- "X-Gusto-API-Version"?: components["parameters"]["VersionHeader"];
5763
- };
5764
- path: {
5765
- employee_uuid: components["parameters"]["employee_uuid"];
5766
- };
5767
- cookie?: never;
5768
- };
5769
- requestBody?: never;
5770
- responses: {
5771
- 200: components["responses"]["Employee-Federal-Tax-Object"];
5772
- 404: components["responses"]["Not-Found-Error-Object"];
5773
- };
5774
- }, {
5775
- params: {
5776
- path: {
5777
- employee_uuid: string;
5778
6237
  };
5779
6238
  };
5780
6239
  }, `${string}/${string}`>>;
6240
+ getEmployeeFederalTaxes(employee_uuid: string): Promise<{
6241
+ version?: string;
6242
+ filing_status?: string;
6243
+ extra_withholding?: string | null;
6244
+ two_jobs?: boolean | null;
6245
+ dependents_amount?: string | null;
6246
+ other_income?: string | null;
6247
+ deductions?: string | null;
6248
+ w4_data_type?: "pre_2020_w4" | "rev_2020_w4";
6249
+ federal_withholding_allowance?: number;
6250
+ additional_withholding?: boolean;
6251
+ }>;
5781
6252
  updateEmployeeFederalTaxes(employee_uuid: string, body: BodyParams<'/v1/employees/{employee_uuid}/federal_taxes', 'PUT'>): Promise<{
5782
6253
  version?: string;
5783
6254
  filing_status?: string;
5784
- extra_withholding?: string;
5785
- two_jobs?: boolean;
5786
- dependents_amount?: string;
5787
- other_income?: string;
5788
- deductions?: string;
6255
+ extra_withholding?: string | null;
6256
+ two_jobs?: boolean | null;
6257
+ dependents_amount?: string | null;
6258
+ other_income?: string | null;
6259
+ deductions?: string | null;
5789
6260
  w4_data_type?: "pre_2020_w4" | "rev_2020_w4";
5790
6261
  federal_withholding_allowance?: number;
5791
6262
  additional_withholding?: boolean;
@@ -5812,6 +6283,7 @@ export declare class GustoClient {
5812
6283
  include?: ("totals" | "payroll_status_meta" | "risk_blockers")[];
5813
6284
  start_date?: string;
5814
6285
  end_date?: string;
6286
+ sort_order?: components["parameters"]["sort_order"];
5815
6287
  };
5816
6288
  header?: {
5817
6289
  "X-Gusto-API-Version"?: components["parameters"]["VersionHeader"];
@@ -5847,6 +6319,7 @@ export declare class GustoClient {
5847
6319
  include?: ("totals" | "payroll_status_meta" | "risk_blockers")[];
5848
6320
  start_date?: string;
5849
6321
  end_date?: string;
6322
+ sort_order?: components["parameters"]["sort_order"];
5850
6323
  };
5851
6324
  header?: {
5852
6325
  "X-Gusto-API-Version"?: components["parameters"]["VersionHeader"];
@@ -5878,7 +6351,7 @@ export declare class GustoClient {
5878
6351
  getPayroll(company_id: string, payroll_id: string): Promise<FetchResponse< {
5879
6352
  parameters: {
5880
6353
  query?: {
5881
- include?: "benefits" | "deductions" | "taxes" | "payroll_status_meta";
6354
+ include?: ("benefits" | "deductions" | "taxes" | "payroll_status_meta")[];
5882
6355
  };
5883
6356
  header?: {
5884
6357
  "X-Gusto-API-Version"?: components["parameters"]["VersionHeader"];
@@ -5897,7 +6370,7 @@ export declare class GustoClient {
5897
6370
  }, FetchOptions< {
5898
6371
  parameters: {
5899
6372
  query?: {
5900
- include?: "benefits" | "deductions" | "taxes" | "payroll_status_meta";
6373
+ include?: ("benefits" | "deductions" | "taxes" | "payroll_status_meta")[];
5901
6374
  };
5902
6375
  header?: {
5903
6376
  "X-Gusto-API-Version"?: components["parameters"]["VersionHeader"];
@@ -5951,7 +6424,7 @@ export declare class GustoClient {
5951
6424
  requestBody?: {
5952
6425
  content: {
5953
6426
  "application/json": {
5954
- title: string;
6427
+ title?: string;
5955
6428
  naics_code: string;
5956
6429
  sic_codes?: string[];
5957
6430
  };
@@ -5969,7 +6442,7 @@ export declare class GustoClient {
5969
6442
  };
5970
6443
  };
5971
6444
  body: {
5972
- title: string;
6445
+ title?: string;
5973
6446
  naics_code: string;
5974
6447
  sic_codes?: string[];
5975
6448
  } | undefined;
@@ -6088,6 +6561,30 @@ export declare class GustoClient {
6088
6561
  requirements?: string[];
6089
6562
  }[];
6090
6563
  }>;
6564
+ getAllEmployeeForms(employee_id: string): Promise<{
6565
+ readonly uuid: string;
6566
+ readonly name?: string;
6567
+ readonly title?: string;
6568
+ readonly description?: string;
6569
+ readonly draft?: boolean;
6570
+ readonly year?: number | null;
6571
+ readonly quarter?: number | null;
6572
+ readonly requires_signing?: boolean;
6573
+ }[]>;
6574
+ getEmployeeFormPdf(employee_id: string, form_id: string): Promise<{
6575
+ readonly uuid: string;
6576
+ document_url?: string;
6577
+ }>;
6578
+ signEmployeeForm(employee_id: string, form_id: string, body: BodyParams<'/v1/employees/{employee_id}/forms/{form_id}/sign', 'PUT'>): Promise<{
6579
+ readonly uuid: string;
6580
+ readonly name?: string;
6581
+ readonly title?: string;
6582
+ readonly description?: string;
6583
+ readonly draft?: boolean;
6584
+ readonly year?: number | null;
6585
+ readonly quarter?: number | null;
6586
+ readonly requires_signing?: boolean;
6587
+ }>;
6091
6588
  }
6092
6589
 
6093
6590
  export declare function handleResponse<T>({ response, data, error }: {
@@ -6110,13 +6607,25 @@ declare const IncludeDeductionsSchema: v.ObjectSchema<{
6110
6607
  readonly includeDeductions: v.PicklistSchema<["Yes", "No"], undefined>;
6111
6608
  }, undefined>;
6112
6609
 
6610
+ declare type InferResponse<T, S> = T extends string ? Awaited<ReturnType<typeof handleResponse<S>>> : null;
6611
+
6612
+ export declare function Landing(): JSX_2.Element;
6613
+
6614
+ declare function Landing_2(props: SummaryProps_2 & BaseComponentInterface): JSX_2.Element;
6615
+
6113
6616
  declare type MODE = 'ADD' | 'LIST' | 'INITIAL' | 'EDIT';
6114
6617
 
6115
6618
  declare type MODE_2 = 'LIST' | 'EDIT' | 'ADD' | 'SINGLE' | 'PROCEED';
6116
6619
 
6117
6620
  declare type MODE_3 = 'ADD' | 'LIST' | 'SPLIT' | 'INITIAL';
6118
6621
 
6119
- declare function OnboardingSummary(props: SummaryProps & BaseComponentInterface): JSX_2.Element;
6622
+ declare type MODE_4 = 'LIST' | 'SIGN';
6623
+
6624
+ declare type OnboardingFlow = 'self' | 'admin'
6625
+
6626
+ export declare function OnboardingSummary(): JSX_2.Element;
6627
+
6628
+ declare function OnboardingSummary_2(props: SummaryProps & BaseComponentInterface): JSX_2.Element;
6120
6629
 
6121
6630
  declare const OnboardingSummaryContextual: () => JSX_2.Element;
6122
6631
 
@@ -6228,6 +6737,8 @@ declare interface operations {
6228
6737
  trade_name?: string;
6229
6738
  /** @description The employer identification number (EIN) of the company. */
6230
6739
  ein?: string;
6740
+ /** @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). */
6741
+ contractor_only?: boolean;
6231
6742
  };
6232
6743
  };
6233
6744
  };
@@ -6280,6 +6791,33 @@ declare interface operations {
6280
6791
  404: components["responses"]["Not-Found-Error-Object"];
6281
6792
  };
6282
6793
  };
6794
+ "put-v1-companies": {
6795
+ parameters: {
6796
+ query?: never;
6797
+ header?: {
6798
+ /** @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. */
6799
+ "X-Gusto-API-Version"?: components["parameters"]["VersionHeader"];
6800
+ };
6801
+ path: {
6802
+ /** @description The UUID of the company */
6803
+ company_id: components["parameters"]["company_id"];
6804
+ };
6805
+ cookie?: never;
6806
+ };
6807
+ requestBody?: {
6808
+ content: {
6809
+ "application/json": {
6810
+ /** @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. */
6811
+ contractor_only: boolean;
6812
+ };
6813
+ };
6814
+ };
6815
+ responses: {
6816
+ 200: components["responses"]["Company-Object"];
6817
+ 404: components["responses"]["Not-Found-Error-Object"];
6818
+ 422: components["responses"]["Unprocessable-Entity-Error-Object"];
6819
+ };
6820
+ };
6283
6821
  "put-v1-partner-managed-companies-company-uuid-migrate": {
6284
6822
  parameters: {
6285
6823
  query?: never;
@@ -6431,6 +6969,112 @@ declare interface operations {
6431
6969
  422: components["responses"]["Unprocessable-Entity-Error-Object"];
6432
6970
  };
6433
6971
  };
6972
+ "get-v1-companies-attachment": {
6973
+ parameters: {
6974
+ query?: never;
6975
+ header?: {
6976
+ /** @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. */
6977
+ "X-Gusto-API-Version"?: components["parameters"]["VersionHeader"];
6978
+ };
6979
+ path: {
6980
+ /** @description The UUID of the company */
6981
+ company_id: components["parameters"]["company_id"];
6982
+ /** @description The UUID of the company attachment */
6983
+ company_attachment_uuid: components["parameters"]["company_attachment_uuid"];
6984
+ };
6985
+ cookie?: never;
6986
+ };
6987
+ requestBody?: never;
6988
+ responses: {
6989
+ 200: components["responses"]["Company-Attachment-Object"];
6990
+ 404: components["responses"]["Not-Found-Error-Object"];
6991
+ };
6992
+ };
6993
+ "get-v1-companies-attachment-url": {
6994
+ parameters: {
6995
+ query?: never;
6996
+ header?: {
6997
+ /** @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. */
6998
+ "X-Gusto-API-Version"?: components["parameters"]["VersionHeader"];
6999
+ };
7000
+ path: {
7001
+ /** @description The UUID of the company */
7002
+ company_id: components["parameters"]["company_id"];
7003
+ /** @description The UUID of the company attachment */
7004
+ company_attachment_uuid: components["parameters"]["company_attachment_uuid"];
7005
+ };
7006
+ cookie?: never;
7007
+ };
7008
+ requestBody?: never;
7009
+ responses: {
7010
+ /** @description Example response */
7011
+ 200: {
7012
+ headers: {
7013
+ [name: string]: unknown;
7014
+ };
7015
+ content: {
7016
+ "application/json": {
7017
+ /** @description A full Url to download a Company Attachment File */
7018
+ url: string;
7019
+ };
7020
+ };
7021
+ };
7022
+ 404: components["responses"]["Not-Found-Error-Object"];
7023
+ };
7024
+ };
7025
+ "get-v1-companies-attachments": {
7026
+ parameters: {
7027
+ query?: never;
7028
+ header?: {
7029
+ /** @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. */
7030
+ "X-Gusto-API-Version"?: components["parameters"]["VersionHeader"];
7031
+ };
7032
+ path: {
7033
+ /** @description The UUID of the company */
7034
+ company_id: components["parameters"]["company_id"];
7035
+ };
7036
+ cookie?: never;
7037
+ };
7038
+ requestBody?: never;
7039
+ responses: {
7040
+ 200: components["responses"]["Company-Attachment-List"];
7041
+ 404: components["responses"]["Not-Found-Error-Object"];
7042
+ };
7043
+ };
7044
+ "post-v1-companies-attachment": {
7045
+ parameters: {
7046
+ query?: never;
7047
+ header?: {
7048
+ /** @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. */
7049
+ "X-Gusto-API-Version"?: components["parameters"]["VersionHeader"];
7050
+ };
7051
+ path: {
7052
+ /** @description The UUID of the company */
7053
+ company_id: components["parameters"]["company_id"];
7054
+ };
7055
+ cookie?: never;
7056
+ };
7057
+ requestBody?: {
7058
+ content: {
7059
+ "multipart/form-data": {
7060
+ /**
7061
+ * Format: binary
7062
+ * @description The binary payload of the file to be uploaded.
7063
+ */
7064
+ document: string;
7065
+ /**
7066
+ * @description The category of a company attachment.
7067
+ * @enum {string}
7068
+ */
7069
+ category: "gep_notice" | "compliance";
7070
+ };
7071
+ };
7072
+ };
7073
+ responses: {
7074
+ 201: components["responses"]["Company-Attachment-Object"];
7075
+ 404: components["responses"]["Not-Found-Error-Object"];
7076
+ };
7077
+ };
6434
7078
  "get-v1-companies-company_id-federal_tax_details": {
6435
7079
  parameters: {
6436
7080
  query?: never;
@@ -6529,7 +7173,7 @@ declare interface operations {
6529
7173
  content: {
6530
7174
  "application/json": {
6531
7175
  /** @description Industry title */
6532
- title: string;
7176
+ title?: string;
6533
7177
  /** @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 */
6534
7178
  naics_code: string;
6535
7179
  /** @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. */
@@ -7458,13 +8102,13 @@ declare interface operations {
7458
8102
  };
7459
8103
  "get-v1-companies-company_id-pay_schedules-preview": {
7460
8104
  parameters: {
7461
- query?: {
8105
+ query: {
7462
8106
  /** @description The frequency that employees on this pay schedule are paid with Gusto. */
7463
- frequency?: "Every week" | "Every other week" | "Twice per month" | "Monthly";
8107
+ frequency: "Every week" | "Every other week" | "Twice per month" | "Monthly";
7464
8108
  /** @description The first date that employees on this pay schedule are paid with Gusto. */
7465
- anchor_pay_date?: string;
8109
+ anchor_pay_date: string;
7466
8110
  /** @description The last date of the first pay period. This can be the same date as the anchor pay date. */
7467
- anchor_end_of_pay_period?: string;
8111
+ anchor_end_of_pay_period: string;
7468
8112
  /** @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. */
7469
8113
  day_1?: number;
7470
8114
  /** @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. */
@@ -7705,7 +8349,7 @@ declare interface operations {
7705
8349
  /** @description Include the requested attribute(s) in each employee response, multiple options are comma separated. Available options:
7706
8350
  * - all_compensations: Include all effective dated compensations for each job instead of only the current compensation
7707
8351
  * - custom_fields: Include employees' custom fields */
7708
- include?: "all_compensations" | "custom_fields";
8352
+ include?: ("all_compensations" | "custom_fields")[];
7709
8353
  /** @description The page that is requested. When unspecified, will load all objects unless endpoint forces pagination. */
7710
8354
  page?: components["parameters"]["pageParam"];
7711
8355
  /** @description Number of objects per page. For majority of endpoints will default to 25 */
@@ -7753,6 +8397,7 @@ declare interface operations {
7753
8397
  first_name: string;
7754
8398
  middle_initial?: string;
7755
8399
  last_name: string;
8400
+ preferred_first_name?: string;
7756
8401
  date_of_birth?: string;
7757
8402
  /** @description The employee's personal email address. */
7758
8403
  email?: string;
@@ -7768,6 +8413,55 @@ declare interface operations {
7768
8413
  422: components["responses"]["Unprocessable-Entity-Error-Object"];
7769
8414
  };
7770
8415
  };
8416
+ "put-v1-historical_employees": {
8417
+ parameters: {
8418
+ query?: never;
8419
+ header?: {
8420
+ /** @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. */
8421
+ "X-Gusto-API-Version"?: components["parameters"]["VersionHeader"];
8422
+ };
8423
+ path: {
8424
+ /** @description The UUID of the company */
8425
+ company_uuid: components["parameters"]["company_uuid"];
8426
+ };
8427
+ cookie?: never;
8428
+ };
8429
+ /** @description Update a historical employee. */
8430
+ requestBody?: {
8431
+ content: {
8432
+ "application/json": components["schemas"]["Versionable-Required"] & components["schemas"]["Historical-Employee-Body"];
8433
+ };
8434
+ };
8435
+ responses: {
8436
+ 200: components["responses"]["Historical-Employee-Object"];
8437
+ 404: components["responses"]["Not-Found-Error-Object"];
8438
+ };
8439
+ };
8440
+ "post-v1-historical_employees": {
8441
+ parameters: {
8442
+ query?: never;
8443
+ header?: {
8444
+ /** @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. */
8445
+ "X-Gusto-API-Version"?: components["parameters"]["VersionHeader"];
8446
+ };
8447
+ path: {
8448
+ /** @description The UUID of the company */
8449
+ company_uuid: components["parameters"]["company_uuid"];
8450
+ };
8451
+ cookie?: never;
8452
+ };
8453
+ /** @description Create a historical employee. */
8454
+ requestBody?: {
8455
+ content: {
8456
+ "application/json": components["schemas"]["Historical-Employee-Body"];
8457
+ };
8458
+ };
8459
+ responses: {
8460
+ 201: components["responses"]["Historical-Employee-Object"];
8461
+ 404: components["responses"]["Not-Found-Error-Object"];
8462
+ 422: components["responses"]["Unprocessable-Entity-Error-Object"];
8463
+ };
8464
+ };
7771
8465
  "get-companies-departments": {
7772
8466
  parameters: {
7773
8467
  query?: never;
@@ -7960,7 +8654,7 @@ declare interface operations {
7960
8654
  /** @description Include the requested attribute(s) in each employee response, multiple options are comma separated. Available options:
7961
8655
  * - all_compensations: Include all effective dated compensations for each job instead of only the current compensation
7962
8656
  * - custom_fields: Include employees' custom fields */
7963
- include?: "all_compensations" | "custom_fields";
8657
+ include?: ("all_compensations" | "custom_fields")[];
7964
8658
  };
7965
8659
  header?: {
7966
8660
  /** @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. */
@@ -8000,6 +8694,7 @@ declare interface operations {
8000
8694
  first_name?: string;
8001
8695
  middle_initial?: string;
8002
8696
  last_name?: string;
8697
+ preferred_first_name?: string;
8003
8698
  date_of_birth?: string;
8004
8699
  /** @description The employee's personal email address. */
8005
8700
  email?: string;
@@ -8617,24 +9312,6 @@ declare interface operations {
8617
9312
  422: components["responses"]["Unprocessable-Entity-Error-Object"];
8618
9313
  };
8619
9314
  };
8620
- "put-v1-employee-finish-onboarding": {
8621
- parameters: {
8622
- query?: never;
8623
- header?: {
8624
- /** @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. */
8625
- "X-Gusto-API-Version"?: components["parameters"]["VersionHeader"];
8626
- };
8627
- path: {
8628
- /** @description The UUID of the employee */
8629
- employee_id: components["parameters"]["employee_id"];
8630
- };
8631
- cookie?: never;
8632
- };
8633
- requestBody?: never;
8634
- responses: {
8635
- 200: components["responses"]["Employee-Object"];
8636
- };
8637
- };
8638
9315
  "get-v1-employees-employee_id-federal_taxes": {
8639
9316
  parameters: {
8640
9317
  query?: never;
@@ -9417,7 +10094,7 @@ declare interface operations {
9417
10094
  };
9418
10095
  };
9419
10096
  responses: {
9420
- 201: components["responses"]["Contractor-Object"];
10097
+ 201: components["responses"]["Created-Contractor-Object"];
9421
10098
  404: components["responses"]["Not-Found-Error-Object"];
9422
10099
  422: components["responses"]["Unprocessable-Entity-Error-Object"];
9423
10100
  };
@@ -9778,80 +10455,61 @@ declare interface operations {
9778
10455
  404: components["responses"]["Not-Found-Error-Object"];
9779
10456
  };
9780
10457
  };
9781
- "post-v1-sandbox-generate_1099": {
10458
+ "get-v1-contractor-documents": {
9782
10459
  parameters: {
9783
10460
  query?: never;
9784
10461
  header?: {
9785
10462
  /** @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. */
9786
10463
  "X-Gusto-API-Version"?: components["parameters"]["VersionHeader"];
9787
10464
  };
9788
- path?: never;
9789
- cookie?: never;
9790
- };
9791
- requestBody?: {
9792
- content: {
9793
- "application/json": {
9794
- /** @description The contractor UUID. */
9795
- contractor_id: string;
9796
- /** @description Must be equal to or more recent than 2015. If not specified, defaults to the previous year.
9797
- * */
9798
- year?: number;
9799
- };
10465
+ path: {
10466
+ /** @description The UUID of the contractor */
10467
+ contractor_uuid: components["parameters"]["contractor_uuid"];
9800
10468
  };
10469
+ cookie?: never;
9801
10470
  };
10471
+ requestBody?: never;
9802
10472
  responses: {
9803
- /** @description OK */
10473
+ /** @description Example response */
9804
10474
  200: {
9805
10475
  headers: {
9806
10476
  [name: string]: unknown;
9807
10477
  };
9808
10478
  content: {
9809
- "application/json": components["schemas"]["Form_1099"];
10479
+ "application/json": components["schemas"]["Document"][];
9810
10480
  };
9811
10481
  };
9812
10482
  404: components["responses"]["Not-Found-Error-Object"];
9813
- 422: components["responses"]["Unprocessable-Entity-Error-Object"];
9814
10483
  };
9815
10484
  };
9816
- "post-v1-sandbox-generate_w2": {
10485
+ "get-v1-contractor-document": {
9817
10486
  parameters: {
9818
10487
  query?: never;
9819
10488
  header?: {
9820
10489
  /** @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. */
9821
10490
  "X-Gusto-API-Version"?: components["parameters"]["VersionHeader"];
9822
10491
  };
9823
- path?: never;
9824
- cookie?: never;
9825
- };
9826
- requestBody?: {
9827
- content: {
9828
- "application/json": {
9829
- /** @description The employee UUID. */
9830
- employee_id: string;
9831
- /** @description Must be equal to or more recent than 2015. If not specified, defaults to the previous year.
9832
- * */
9833
- year?: number;
9834
- };
10492
+ path: {
10493
+ /** @description The ID or UUID of the document */
10494
+ document_uuid: components["parameters"]["document_uuid"];
9835
10495
  };
10496
+ cookie?: never;
9836
10497
  };
10498
+ requestBody?: never;
9837
10499
  responses: {
9838
- /** @description OK */
10500
+ /** @description Example response */
9839
10501
  200: {
9840
10502
  headers: {
9841
10503
  [name: string]: unknown;
9842
10504
  };
9843
10505
  content: {
9844
- "application/json": {
9845
- /** @description The UUID of the employee */
9846
- readonly employee_uuid?: string;
9847
- } & components["schemas"]["Form"];
10506
+ "application/json": components["schemas"]["Document"];
9848
10507
  };
9849
10508
  };
9850
10509
  404: components["responses"]["Not-Found-Error-Object"];
9851
- 422: components["responses"]["Unprocessable-Entity-Error-Object"];
9852
10510
  };
9853
10511
  };
9854
- "get-v1-contractors-contractor_uuid-payment_method": {
10512
+ "get-v1-contractor-document-pdf": {
9855
10513
  parameters: {
9856
10514
  query?: never;
9857
10515
  header?: {
@@ -9859,18 +10517,26 @@ declare interface operations {
9859
10517
  "X-Gusto-API-Version"?: components["parameters"]["VersionHeader"];
9860
10518
  };
9861
10519
  path: {
9862
- /** @description The UUID of the contractor */
9863
- contractor_uuid: components["parameters"]["contractor_uuid"];
10520
+ /** @description The ID or UUID of the document */
10521
+ document_uuid: components["parameters"]["document_uuid"];
9864
10522
  };
9865
10523
  cookie?: never;
9866
10524
  };
9867
10525
  requestBody?: never;
9868
10526
  responses: {
9869
- 200: components["responses"]["Contractor-Payment-Method-Object"];
10527
+ /** @description Example response */
10528
+ 200: {
10529
+ headers: {
10530
+ [name: string]: unknown;
10531
+ };
10532
+ content: {
10533
+ "application/json": components["schemas"]["Document-Pdf"];
10534
+ };
10535
+ };
9870
10536
  404: components["responses"]["Not-Found-Error-Object"];
9871
10537
  };
9872
10538
  };
9873
- "put-v1-contractors-contractor_id-payment_method": {
10539
+ "put-v1-contractor-document-sign": {
9874
10540
  parameters: {
9875
10541
  query?: never;
9876
10542
  header?: {
@@ -9878,23 +10544,159 @@ declare interface operations {
9878
10544
  "X-Gusto-API-Version"?: components["parameters"]["VersionHeader"];
9879
10545
  };
9880
10546
  path: {
9881
- /** @description The UUID of the contractor */
9882
- contractor_uuid: components["parameters"]["contractor_uuid"];
10547
+ /** @description The ID or UUID of the document */
10548
+ document_uuid: components["parameters"]["document_uuid"];
9883
10549
  };
9884
10550
  cookie?: never;
9885
10551
  };
9886
10552
  requestBody?: {
9887
10553
  content: {
9888
- "application/json": components["schemas"]["Versionable-Required"] & {
9889
- /**
9890
- * @description The payment method type. If type is Direct Deposit, the contractor is required to have a bank account.
9891
- * see [Bank account endpoint](./post-v1-contractors-contractor_uuid-bank_accounts)
9892
- * @enum {string}
9893
- */
9894
- type: "Direct Deposit" | "Check";
9895
- };
9896
- };
9897
- };
10554
+ "application/json": {
10555
+ /** @description List of fields and the values they will be set to. */
10556
+ fields: {
10557
+ /** @description Unique identifier of the field */
10558
+ key?: string;
10559
+ /** @description Value for the field */
10560
+ value?: string;
10561
+ }[];
10562
+ /** @description Whether you agree to sign electronically */
10563
+ agree: boolean;
10564
+ /** @description The IP address of the signatory who signed the form. */
10565
+ signed_by_ip_address: string;
10566
+ };
10567
+ };
10568
+ };
10569
+ responses: {
10570
+ /** @description Example response */
10571
+ 200: {
10572
+ headers: {
10573
+ [name: string]: unknown;
10574
+ };
10575
+ content: {
10576
+ "application/json": components["schemas"]["Document-Signed"];
10577
+ };
10578
+ };
10579
+ 404: components["responses"]["Not-Found-Error-Object"];
10580
+ 422: components["responses"]["Unprocessable-Entity-Error-Object"];
10581
+ };
10582
+ };
10583
+ "post-v1-sandbox-generate_1099": {
10584
+ parameters: {
10585
+ query?: never;
10586
+ header?: {
10587
+ /** @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. */
10588
+ "X-Gusto-API-Version"?: components["parameters"]["VersionHeader"];
10589
+ };
10590
+ path?: never;
10591
+ cookie?: never;
10592
+ };
10593
+ requestBody?: {
10594
+ content: {
10595
+ "application/json": {
10596
+ /** @description The contractor UUID. */
10597
+ contractor_id: string;
10598
+ /** @description Must be equal to or more recent than 2015. If not specified, defaults to the previous year.
10599
+ * */
10600
+ year?: number;
10601
+ };
10602
+ };
10603
+ };
10604
+ responses: {
10605
+ /** @description OK */
10606
+ 200: {
10607
+ headers: {
10608
+ [name: string]: unknown;
10609
+ };
10610
+ content: {
10611
+ "application/json": components["schemas"]["Form_1099"];
10612
+ };
10613
+ };
10614
+ 404: components["responses"]["Not-Found-Error-Object"];
10615
+ 422: components["responses"]["Unprocessable-Entity-Error-Object"];
10616
+ };
10617
+ };
10618
+ "post-v1-sandbox-generate_w2": {
10619
+ parameters: {
10620
+ query?: never;
10621
+ header?: {
10622
+ /** @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. */
10623
+ "X-Gusto-API-Version"?: components["parameters"]["VersionHeader"];
10624
+ };
10625
+ path?: never;
10626
+ cookie?: never;
10627
+ };
10628
+ requestBody?: {
10629
+ content: {
10630
+ "application/json": {
10631
+ /** @description The employee UUID. */
10632
+ employee_id: string;
10633
+ /** @description Must be equal to or more recent than 2015. If not specified, defaults to the previous year.
10634
+ * */
10635
+ year?: number;
10636
+ };
10637
+ };
10638
+ };
10639
+ responses: {
10640
+ /** @description OK */
10641
+ 200: {
10642
+ headers: {
10643
+ [name: string]: unknown;
10644
+ };
10645
+ content: {
10646
+ "application/json": {
10647
+ /** @description The UUID of the employee */
10648
+ readonly employee_uuid?: string;
10649
+ } & components["schemas"]["Form"];
10650
+ };
10651
+ };
10652
+ 404: components["responses"]["Not-Found-Error-Object"];
10653
+ 422: components["responses"]["Unprocessable-Entity-Error-Object"];
10654
+ };
10655
+ };
10656
+ "get-v1-contractors-contractor_uuid-payment_method": {
10657
+ parameters: {
10658
+ query?: never;
10659
+ header?: {
10660
+ /** @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. */
10661
+ "X-Gusto-API-Version"?: components["parameters"]["VersionHeader"];
10662
+ };
10663
+ path: {
10664
+ /** @description The UUID of the contractor */
10665
+ contractor_uuid: components["parameters"]["contractor_uuid"];
10666
+ };
10667
+ cookie?: never;
10668
+ };
10669
+ requestBody?: never;
10670
+ responses: {
10671
+ 200: components["responses"]["Contractor-Payment-Method-Object"];
10672
+ 404: components["responses"]["Not-Found-Error-Object"];
10673
+ };
10674
+ };
10675
+ "put-v1-contractors-contractor_id-payment_method": {
10676
+ parameters: {
10677
+ query?: never;
10678
+ header?: {
10679
+ /** @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. */
10680
+ "X-Gusto-API-Version"?: components["parameters"]["VersionHeader"];
10681
+ };
10682
+ path: {
10683
+ /** @description The UUID of the contractor */
10684
+ contractor_uuid: components["parameters"]["contractor_uuid"];
10685
+ };
10686
+ cookie?: never;
10687
+ };
10688
+ requestBody?: {
10689
+ content: {
10690
+ "application/json": components["schemas"]["Versionable-Required"] & {
10691
+ /**
10692
+ * @description The payment method type. If type is Direct Deposit, the contractor is required to have a bank account.
10693
+ * see [Bank account endpoint](./post-v1-contractors-contractor_uuid-bank_accounts)
10694
+ * @enum {string}
10695
+ */
10696
+ type: "Direct Deposit" | "Check";
10697
+ };
10698
+ };
10699
+ };
9898
10700
  responses: {
9899
10701
  200: components["responses"]["Contractor-Payment-Method-Object"];
9900
10702
  404: components["responses"]["Not-Found-Error-Object"];
@@ -10013,6 +10815,8 @@ declare interface operations {
10013
10815
  start_date?: string;
10014
10816
  /** @description Return payrolls whose pay period is before the end date. If left empty, defaults to today's date. */
10015
10817
  end_date?: string;
10818
+ /** @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. */
10819
+ sort_order?: components["parameters"]["sort_order"];
10016
10820
  };
10017
10821
  header?: {
10018
10822
  /** @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. */
@@ -10109,7 +10913,7 @@ declare interface operations {
10109
10913
  parameters: {
10110
10914
  query?: {
10111
10915
  /** @description Include the requested attribute in the response, for multiple attributes comma separate the values, i.e. `?include=benefits,deductions,taxes` */
10112
- include?: "benefits" | "deductions" | "taxes" | "payroll_status_meta";
10916
+ include?: ("benefits" | "deductions" | "taxes" | "payroll_status_meta")[];
10113
10917
  };
10114
10918
  header?: {
10115
10919
  /** @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. */
@@ -10167,7 +10971,7 @@ declare interface operations {
10167
10971
  /** @description The amount of the compensation for the pay period. */
10168
10972
  amount?: string;
10169
10973
  /** @description The UUID of the job for the compensation. */
10170
- job_uuid?: number;
10974
+ job_uuid?: string;
10171
10975
  }[];
10172
10976
  hourly_compensations?: {
10173
10977
  /** @description The name of the compensation. This also serves as the unique, immutable identifier for this compensation. */
@@ -10175,7 +10979,7 @@ declare interface operations {
10175
10979
  /** @description The number of hours to be compensated for this pay period. */
10176
10980
  hours?: string;
10177
10981
  /** @description The UUIDs of the job for the compensation. */
10178
- job_uuid?: number;
10982
+ job_uuid?: string;
10179
10983
  }[];
10180
10984
  /** @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. */
10181
10985
  paid_time_off?: {
@@ -10631,7 +11435,7 @@ declare interface operations {
10631
11435
  contractor_uuid: string;
10632
11436
  /**
10633
11437
  * Format: date
10634
- * @description The contractor receiving the payment
11438
+ * @description Date of contractor payment
10635
11439
  * @example 2020-01-01
10636
11440
  */
10637
11441
  date: string;
@@ -11017,7 +11821,7 @@ declare interface operations {
11017
11821
  signature_text: string;
11018
11822
  /** @description whether you agree to sign electronically */
11019
11823
  agree: boolean;
11020
- /** @description The IP address of the signatory who signed the form. */
11824
+ /** @description The IP address of the signatory who signed the form. Both IPv4 AND IPv6 are supported. */
11021
11825
  signed_by_ip_address: string;
11022
11826
  };
11023
11827
  };
@@ -11111,7 +11915,7 @@ declare interface operations {
11111
11915
  signature_text: string;
11112
11916
  /** @description whether you agree to sign electronically */
11113
11917
  agree: boolean;
11114
- /** @description The IP address of the signatory who signed the form. */
11918
+ /** @description The IP address of the signatory who signed the form. Both IPv4 AND IPv6 are supported. */
11115
11919
  signed_by_ip_address: string;
11116
11920
  };
11117
11921
  };
@@ -11235,9 +12039,9 @@ declare interface operations {
11235
12039
  content: {
11236
12040
  "application/json": {
11237
12041
  /** @description Columns to include in the report */
11238
- 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" | "employer_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_time_off_earnings" | "total_time_off_hours" | "work_address_city" | "work_address_street" | "work_address_zip")[];
12042
+ 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")[];
11239
12043
  /** @description How to group the report */
11240
- groupings: ("payroll" | "employee" | "work_address")[];
12044
+ groupings: ("payroll" | "employee" | "work_address" | "work_address_state")[];
11241
12045
  /** @description The title of the report */
11242
12046
  custom_name?: string;
11243
12047
  /**
@@ -11389,7 +12193,7 @@ declare interface operations {
11389
12193
  * @default true
11390
12194
  */
11391
12195
  active?: boolean;
11392
- /** @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”. */
12196
+ /** @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”. */
11393
12197
  description: string;
11394
12198
  /** @description Whether the employer is subject to pay employer taxes when an employee is on leave. Only applicable to third party sick pay benefits. */
11395
12199
  responsible_for_employer_taxes?: boolean;
@@ -11446,7 +12250,7 @@ declare interface operations {
11446
12250
  version: string;
11447
12251
  /** @description Whether this benefit is active for employee participation. Company benefits may only be deactivated if no employees are actively participating. */
11448
12252
  active?: boolean;
11449
- /** @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”. */
12253
+ /** @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”. */
11450
12254
  description?: string;
11451
12255
  };
11452
12256
  };
@@ -11560,6 +12364,57 @@ declare interface operations {
11560
12364
  404: components["responses"]["Not-Found-Error-Object"];
11561
12365
  };
11562
12366
  };
12367
+ "get-v1-company_benefits-company_benefit_id-employee_benefits": {
12368
+ parameters: {
12369
+ query?: {
12370
+ /** @description The page that is requested. When unspecified, will load all objects unless endpoint forces pagination. */
12371
+ page?: components["parameters"]["pageParam"];
12372
+ /** @description Number of objects per page. For majority of endpoints will default to 25 */
12373
+ per?: components["parameters"]["perParam"];
12374
+ };
12375
+ header?: {
12376
+ /** @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. */
12377
+ "X-Gusto-API-Version"?: components["parameters"]["VersionHeader"];
12378
+ };
12379
+ path: {
12380
+ /** @description The UUID of the company benefit */
12381
+ company_benefit_id: components["parameters"]["company_benefit_id"];
12382
+ };
12383
+ cookie?: never;
12384
+ };
12385
+ requestBody?: never;
12386
+ responses: {
12387
+ 200: components["responses"]["Employee-Benefit-List"];
12388
+ 404: components["responses"]["Not-Found-Error-Object"];
12389
+ };
12390
+ };
12391
+ "put-v1-company_benefits-company_benefit_id-employee_benefits": {
12392
+ parameters: {
12393
+ query?: never;
12394
+ header?: {
12395
+ /** @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. */
12396
+ "X-Gusto-API-Version"?: components["parameters"]["VersionHeader"];
12397
+ };
12398
+ path: {
12399
+ /** @description The UUID of the company benefit */
12400
+ company_benefit_id: components["parameters"]["company_benefit_id"];
12401
+ };
12402
+ cookie?: never;
12403
+ };
12404
+ requestBody?: {
12405
+ content: {
12406
+ "application/json": {
12407
+ /** @description The list of employee benefits to create or update */
12408
+ employee_benefits?: components["schemas"]["Employee-Benefit-For-Company-Benefit"][];
12409
+ };
12410
+ };
12411
+ };
12412
+ responses: {
12413
+ 200: components["responses"]["Employee-Benefit-List"];
12414
+ 404: components["responses"]["Not-Found-Error-Object"];
12415
+ 422: components["responses"]["Unprocessable-Entity-Error-Object"];
12416
+ };
12417
+ };
11563
12418
  "get-v1-benefits-benefits_id-requirements": {
11564
12419
  parameters: {
11565
12420
  query?: never;
@@ -11937,9 +12792,14 @@ declare interface operations {
11937
12792
  */
11938
12793
  amount: string;
11939
12794
  /** @description The description of the garnishment. */
11940
- description: string;
12795
+ description?: string;
11941
12796
  /** @description Whether the garnishment is court ordered. */
11942
12797
  court_ordered: boolean;
12798
+ /**
12799
+ * @description The specific type of garnishment for court ordered garnishments.
12800
+ * @enum {string|null}
12801
+ */
12802
+ garnishment_type?: "child_support" | "federal_tax_lien" | "state_tax_lien" | "student_loan" | "creditor_garnishment" | "federal_loan" | "other_garnishment" | null;
11943
12803
  /**
11944
12804
  * @description The number of times to apply the garnishment. Ignored if recurring is true.
11945
12805
  * @default null
@@ -11967,6 +12827,12 @@ declare interface operations {
11967
12827
  * @default false
11968
12828
  */
11969
12829
  deduct_as_percentage?: boolean;
12830
+ /**
12831
+ * Format: float
12832
+ * @description A maximum total deduction for the lifetime of this garnishment. A null value indicates no maximum.
12833
+ */
12834
+ total_amount?: string;
12835
+ child_support?: components["schemas"]["Garnishment-Child-Support"];
11970
12836
  };
11971
12837
  };
11972
12838
  };
@@ -12052,6 +12918,12 @@ declare interface operations {
12052
12918
  * @default false
12053
12919
  */
12054
12920
  deduct_as_percentage?: boolean;
12921
+ /**
12922
+ * Format: float
12923
+ * @description A maximum total deduction for the lifetime of this garnishment. A null value indicates no maximum.
12924
+ */
12925
+ total_amount?: string;
12926
+ child_support?: components["schemas"]["Garnishment-Child-Support"];
12055
12927
  /** @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. */
12056
12928
  version: string;
12057
12929
  };
@@ -12063,6 +12935,22 @@ declare interface operations {
12063
12935
  422: components["responses"]["Unprocessable-Entity-Error-Object"];
12064
12936
  };
12065
12937
  };
12938
+ "get-v1-garnishments-child_support": {
12939
+ parameters: {
12940
+ query?: never;
12941
+ header?: {
12942
+ /** @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. */
12943
+ "X-Gusto-API-Version"?: components["parameters"]["VersionHeader"];
12944
+ };
12945
+ path?: never;
12946
+ cookie?: never;
12947
+ };
12948
+ requestBody?: never;
12949
+ responses: {
12950
+ 200: components["responses"]["Child-Support-Data-Object"];
12951
+ 404: components["responses"]["Not-Found-Error-Object"];
12952
+ };
12953
+ };
12066
12954
  "post-v1-plaid-processor_token": {
12067
12955
  parameters: {
12068
12956
  query?: never;
@@ -12330,18 +13218,18 @@ declare interface operations {
12330
13218
  * @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".
12331
13219
  */
12332
13220
  accrual_rate_unit?: string;
12333
- /** @description Boolean representing if an employees accrued time off hours will be paid out on termination */
13221
+ /** @description Boolean representing if an employee's accrued time off hours will be paid out on termination */
12334
13222
  paid_out_on_termination?: boolean;
12335
13223
  /** @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. */
12336
13224
  accrual_waiting_period_days?: number;
12337
13225
  /**
12338
13226
  * Format: float
12339
- * @description The max number of hours and employee can carryover from one year to the next. If accrual_method is unlimited, then carryover_limit_hours must be blank.
13227
+ * @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.
12340
13228
  */
12341
13229
  carryover_limit_hours?: string;
12342
13230
  /**
12343
13231
  * Format: float
12344
- * @description The max number of hours and employee can accrue in a year. If accrual_method is unlimited, then max_accrual_hours_per_year must be blank.
13232
+ * @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.
12345
13233
  */
12346
13234
  max_accrual_hours_per_year?: string;
12347
13235
  /**
@@ -12421,18 +13309,18 @@ declare interface operations {
12421
13309
  * @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".
12422
13310
  */
12423
13311
  accrual_rate_unit?: string;
12424
- /** @description Boolean representing if an employees accrued time off hours will be paid out on termination */
13312
+ /** @description Boolean representing if an employee's accrued time off hours will be paid out on termination */
12425
13313
  paid_out_on_termination?: boolean;
12426
13314
  /** @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. */
12427
13315
  accrual_waiting_period_days?: number;
12428
13316
  /**
12429
13317
  * Format: float
12430
- * @description The max number of hours and employee can carryover from one year to the next. If accrual_method is unlimited, then carryover_limit_hours must be blank.
13318
+ * @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.
12431
13319
  */
12432
13320
  carryover_limit_hours?: string;
12433
13321
  /**
12434
13322
  * Format: float
12435
- * @description The max number of hours and employee can accrue in a year. If accrual_method is unlimited, then max_accrual_hours_per_year must be blank.
13323
+ * @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.
12436
13324
  */
12437
13325
  max_accrual_hours_per_year?: string;
12438
13326
  /**
@@ -12866,7 +13754,7 @@ declare interface operations {
12866
13754
  "X-Gusto-API-Version"?: components["parameters"]["VersionHeader"];
12867
13755
  };
12868
13756
  path: {
12869
- /** @description The UUID of the notification */
13757
+ /** @description The notification entity_uuid */
12870
13758
  notification_uuid: components["parameters"]["notification_uuid"];
12871
13759
  };
12872
13760
  cookie?: never;
@@ -13142,7 +14030,13 @@ declare interface paths {
13142
14030
  * scope: `companies:read`
13143
14031
  */
13144
14032
  get: operations["get-v1-companies"];
13145
- put?: never;
14033
+ /**
14034
+ * Update a company
14035
+ * @description Update a company.
14036
+ *
14037
+ * scope: `companies:write`
14038
+ */
14039
+ put: operations["put-v1-companies"];
13146
14040
  post?: never;
13147
14041
  delete?: never;
13148
14042
  options?: never;
@@ -13245,7 +14139,7 @@ declare interface paths {
13245
14139
  patch?: never;
13246
14140
  trace?: never;
13247
14141
  };
13248
- "/v1/companies/{company_id}/federal_tax_details": {
14142
+ "/v1/companies/{company_id}/attachments/{company_attachment_uuid}": {
13249
14143
  parameters: {
13250
14144
  query?: never;
13251
14145
  header?: never;
@@ -13253,20 +14147,13 @@ declare interface paths {
13253
14147
  cookie?: never;
13254
14148
  };
13255
14149
  /**
13256
- * Get Federal Tax Details
13257
- * @description Fetches attributes relevant for a company's federal taxes.
13258
- *
13259
- * scope: `company_federal_taxes:read`
13260
- */
13261
- get: operations["get-v1-companies-company_id-federal_tax_details"];
13262
- /**
13263
- * Update Federal Tax Details
13264
- * @description Updates attributes relevant for a company's federal taxes.
13265
- * This information is required is to onboard a company for use with Gusto Embedded Payroll.
14150
+ * Get Company Attachment Details
14151
+ * @description Retrieve the detail of an attachment uploaded by the company.
13266
14152
  *
13267
- * scope: `company_federal_taxes:write`
14153
+ * scope: `company_attachments:read`
13268
14154
  */
13269
- put: operations["put-v1-companies-company_id-federal_tax_details"];
14155
+ get: operations["get-v1-companies-attachment"];
14156
+ put?: never;
13270
14157
  post?: never;
13271
14158
  delete?: never;
13272
14159
  options?: never;
@@ -13274,7 +14161,7 @@ declare interface paths {
13274
14161
  patch?: never;
13275
14162
  trace?: never;
13276
14163
  };
13277
- "/v1/companies/{company_id}/industry_selection": {
14164
+ "/v1/companies/{company_id}/attachments/{company_attachment_uuid}/download_url": {
13278
14165
  parameters: {
13279
14166
  query?: never;
13280
14167
  header?: never;
@@ -13282,19 +14169,14 @@ declare interface paths {
13282
14169
  cookie?: never;
13283
14170
  };
13284
14171
  /**
13285
- * Get a company industry selection
13286
- * @description Get industry selection for the company.
13287
- *
13288
- * scope: `companies:read`
13289
- */
13290
- get: operations["get-v1-company-industry"];
13291
- /**
13292
- * Update a company industry selection
13293
- * @description Update the company industry selection by passing in industry classification codes: [NAICS code](https://www.naics.com), [SICS code](https://siccode.com/) and industry title. Our UI is leveraging [Middesk API](https://docs.middesk.com/reference/introduction) to determine industry classification codes.
14172
+ * Get a temporary url to download the Company Attachment file
14173
+ * @description Retrieve a temporary url to download a attachment file uploaded
14174
+ * by the company.
13294
14175
  *
13295
- * scope: `companies:write`
14176
+ * scope: `company_attachments:read`
13296
14177
  */
13297
- put: operations["put-v1-company-industry"];
14178
+ get: operations["get-v1-companies-attachment-url"];
14179
+ put?: never;
13298
14180
  post?: never;
13299
14181
  delete?: never;
13300
14182
  options?: never;
@@ -13302,7 +14184,7 @@ declare interface paths {
13302
14184
  patch?: never;
13303
14185
  trace?: never;
13304
14186
  };
13305
- "/v1/companies/{company_id}/admins": {
14187
+ "/v1/companies/{company_id}/attachments": {
13306
14188
  parameters: {
13307
14189
  query?: never;
13308
14190
  header?: never;
@@ -13310,21 +14192,108 @@ declare interface paths {
13310
14192
  cookie?: never;
13311
14193
  };
13312
14194
  /**
13313
- * Get all the admins at a company
13314
- * @description Returns a list of all the admins at a company
14195
+ * Get List of Company Attachments
14196
+ * @description Retrieve a list of all the attachments uploaded by the company.
13315
14197
  *
13316
- * scope: `company_admin:read`
14198
+ * scope: `company_attachments:read`
13317
14199
  */
13318
- get: operations["get-v1-companies-company_id-admins"];
14200
+ get: operations["get-v1-companies-attachments"];
13319
14201
  put?: never;
13320
14202
  /**
13321
- * Create an admin for the company
13322
- * @description Creates a new admin for a company.
13323
- * If the email matches an existing user, this will create an admin account for the current user. Otherwise, this will create a new user.
14203
+ * Create Company Attachment and Upload File
14204
+ * @description Upload a file and create a company attachment. We recommend uploading
14205
+ * PDF files for optimal compatibility. However, the following file types are
14206
+ * allowed: .qbb, .qbm, .gif, .jpg, .png, .pdf, .xls, .xlsx, .doc and .docx.
13324
14207
  *
13325
- * scope: `company_admin:write`
14208
+ * scope: `company_attachments:write`
13326
14209
  */
13327
- post: operations["post-v1-companies-company_id-admins"];
14210
+ post: operations["post-v1-companies-attachment"];
14211
+ delete?: never;
14212
+ options?: never;
14213
+ head?: never;
14214
+ patch?: never;
14215
+ trace?: never;
14216
+ };
14217
+ "/v1/companies/{company_id}/federal_tax_details": {
14218
+ parameters: {
14219
+ query?: never;
14220
+ header?: never;
14221
+ path?: never;
14222
+ cookie?: never;
14223
+ };
14224
+ /**
14225
+ * Get Federal Tax Details
14226
+ * @description Fetches attributes relevant for a company's federal taxes.
14227
+ *
14228
+ * scope: `company_federal_taxes:read`
14229
+ */
14230
+ get: operations["get-v1-companies-company_id-federal_tax_details"];
14231
+ /**
14232
+ * Update Federal Tax Details
14233
+ * @description Updates attributes relevant for a company's federal taxes.
14234
+ * This information is required is to onboard a company for use with Gusto Embedded Payroll.
14235
+ *
14236
+ * scope: `company_federal_taxes:write`
14237
+ */
14238
+ put: operations["put-v1-companies-company_id-federal_tax_details"];
14239
+ post?: never;
14240
+ delete?: never;
14241
+ options?: never;
14242
+ head?: never;
14243
+ patch?: never;
14244
+ trace?: never;
14245
+ };
14246
+ "/v1/companies/{company_id}/industry_selection": {
14247
+ parameters: {
14248
+ query?: never;
14249
+ header?: never;
14250
+ path?: never;
14251
+ cookie?: never;
14252
+ };
14253
+ /**
14254
+ * Get a company industry selection
14255
+ * @description Get industry selection for the company.
14256
+ *
14257
+ * scope: `companies:read`
14258
+ */
14259
+ get: operations["get-v1-company-industry"];
14260
+ /**
14261
+ * Update a company industry selection
14262
+ * @description Update the company industry selection by passing in industry classification codes: [NAICS code](https://www.naics.com), [SICS code](https://siccode.com/) and industry title. Our UI is leveraging [Middesk API](https://docs.middesk.com/reference/introduction) to determine industry classification codes.
14263
+ *
14264
+ * scope: `companies:write`
14265
+ */
14266
+ put: operations["put-v1-company-industry"];
14267
+ post?: never;
14268
+ delete?: never;
14269
+ options?: never;
14270
+ head?: never;
14271
+ patch?: never;
14272
+ trace?: never;
14273
+ };
14274
+ "/v1/companies/{company_id}/admins": {
14275
+ parameters: {
14276
+ query?: never;
14277
+ header?: never;
14278
+ path?: never;
14279
+ cookie?: never;
14280
+ };
14281
+ /**
14282
+ * Get all the admins at a company
14283
+ * @description Returns a list of all the admins at a company
14284
+ *
14285
+ * scope: `company_admin:read`
14286
+ */
14287
+ get: operations["get-v1-companies-company_id-admins"];
14288
+ put?: never;
14289
+ /**
14290
+ * Create an admin for the company
14291
+ * @description Creates a new admin for a company.
14292
+ * If the email matches an existing user, this will create an admin account for the current user. Otherwise, this will create a new user.
14293
+ *
14294
+ * scope: `company_admin:write`
14295
+ */
14296
+ post: operations["post-v1-companies-company_id-admins"];
13328
14297
  delete?: never;
13329
14298
  options?: never;
13330
14299
  head?: never;
@@ -13445,7 +14414,7 @@ declare interface paths {
13445
14414
  * @description Finalize a given company's onboarding process.
13446
14415
  *
13447
14416
  * ### Approve a company in demo
13448
- * After a company is finished onboarding, Gusto requires an additional step to review and approve that company.
14417
+ * 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.
13449
14418
  * In production environments, this step is required for risk-analysis purposes.
13450
14419
  *
13451
14420
  * We provide the endpoint `PUT '/v1/companies/{company_uuid}/approve'` to facilitate company approvals in the demo environment.
@@ -14013,7 +14982,8 @@ declare interface paths {
14013
14982
  put?: never;
14014
14983
  /**
14015
14984
  * Assign pay schedules for a company
14016
- * @description This endpoints assigns employees to specified pay schedules based on the pay schedule type.
14985
+ * @description This endpoint assigns employees to pay schedules based on the schedule type.
14986
+ * 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).
14017
14987
  *
14018
14988
  * scope: `pay_schedules:write`
14019
14989
  */
@@ -14052,6 +15022,34 @@ declare interface paths {
14052
15022
  patch?: never;
14053
15023
  trace?: never;
14054
15024
  };
15025
+ "/v1/companies/{company_uuid}/historical_employees": {
15026
+ parameters: {
15027
+ query?: never;
15028
+ header?: never;
15029
+ path?: never;
15030
+ cookie?: never;
15031
+ };
15032
+ get?: never;
15033
+ /**
15034
+ * Update a historical employee
15035
+ * @description Update a historical employee, an employee that was previously dismissed from the company in the current year.
15036
+ *
15037
+ * scope: `employees:manage`
15038
+ */
15039
+ put: operations["put-v1-historical_employees"];
15040
+ /**
15041
+ * Create a historical employee
15042
+ * @description Create a historical employee, an employee that was previously dismissed from the company in the current year.
15043
+ *
15044
+ * scope: `employees:manage`
15045
+ */
15046
+ post: operations["post-v1-historical_employees"];
15047
+ delete?: never;
15048
+ options?: never;
15049
+ head?: never;
15050
+ patch?: never;
15051
+ trace?: never;
15052
+ };
14055
15053
  "/v1/companies/{company_uuid}/departments": {
14056
15054
  parameters: {
14057
15055
  query?: never;
@@ -14551,28 +15549,6 @@ declare interface paths {
14551
15549
  patch?: never;
14552
15550
  trace?: never;
14553
15551
  };
14554
- "/v1/employees/{employee_id}/finish_onboarding": {
14555
- parameters: {
14556
- query?: never;
14557
- header?: never;
14558
- path?: never;
14559
- cookie?: never;
14560
- };
14561
- get?: never;
14562
- /**
14563
- * Finish onboarding an employee
14564
- * @description This endpoint is currently supported but will eventually be deprecated; please use `/v1/employees/{employee_id}/onboarding_status` instead.
14565
- *
14566
- * 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.
14567
- */
14568
- put: operations["put-v1-employee-finish-onboarding"];
14569
- post?: never;
14570
- delete?: never;
14571
- options?: never;
14572
- head?: never;
14573
- patch?: never;
14574
- trace?: never;
14575
- };
14576
15552
  "/v1/employees/{employee_uuid}/federal_taxes": {
14577
15553
  parameters: {
14578
15554
  query?: never;
@@ -15252,6 +16228,94 @@ declare interface paths {
15252
16228
  patch?: never;
15253
16229
  trace?: never;
15254
16230
  };
16231
+ "/v1/contractors/{contractor_uuid}/documents": {
16232
+ parameters: {
16233
+ query?: never;
16234
+ header?: never;
16235
+ path?: never;
16236
+ cookie?: never;
16237
+ };
16238
+ /**
16239
+ * Get all contractor documents
16240
+ * @description Get a list of all contractor's documents
16241
+ *
16242
+ * scope: `contractor_documents:read`
16243
+ */
16244
+ get: operations["get-v1-contractor-documents"];
16245
+ put?: never;
16246
+ post?: never;
16247
+ delete?: never;
16248
+ options?: never;
16249
+ head?: never;
16250
+ patch?: never;
16251
+ trace?: never;
16252
+ };
16253
+ "/v1/documents/{document_uuid}": {
16254
+ parameters: {
16255
+ query?: never;
16256
+ header?: never;
16257
+ path?: never;
16258
+ cookie?: never;
16259
+ };
16260
+ /**
16261
+ * Get a contractor document
16262
+ * @description Get a contractor document.
16263
+ *
16264
+ * scope: `contractor_documents:read`
16265
+ */
16266
+ get: operations["get-v1-contractor-document"];
16267
+ put?: never;
16268
+ post?: never;
16269
+ delete?: never;
16270
+ options?: never;
16271
+ head?: never;
16272
+ patch?: never;
16273
+ trace?: never;
16274
+ };
16275
+ "/v1/documents/{document_uuid}/pdf": {
16276
+ parameters: {
16277
+ query?: never;
16278
+ header?: never;
16279
+ path?: never;
16280
+ cookie?: never;
16281
+ };
16282
+ /**
16283
+ * Get the contractor document pdf
16284
+ * @description Get the contractor document pdf.
16285
+ *
16286
+ * scope: `contractor_documents:read`
16287
+ */
16288
+ get: operations["get-v1-contractor-document-pdf"];
16289
+ put?: never;
16290
+ post?: never;
16291
+ delete?: never;
16292
+ options?: never;
16293
+ head?: never;
16294
+ patch?: never;
16295
+ trace?: never;
16296
+ };
16297
+ "/v1/documents/{document_uuid}/sign": {
16298
+ parameters: {
16299
+ query?: never;
16300
+ header?: never;
16301
+ path?: never;
16302
+ cookie?: never;
16303
+ };
16304
+ get?: never;
16305
+ /**
16306
+ * Sign a contractor document
16307
+ * @description Sign a contractor document.
16308
+ *
16309
+ * scope: `contractor_documents:write`
16310
+ */
16311
+ put: operations["put-v1-contractor-document-sign"];
16312
+ post?: never;
16313
+ delete?: never;
16314
+ options?: never;
16315
+ head?: never;
16316
+ patch?: never;
16317
+ trace?: never;
16318
+ };
15255
16319
  "/v1/sandbox/generate_1099": {
15256
16320
  parameters: {
15257
16321
  query?: never;
@@ -15394,7 +16458,7 @@ declare interface paths {
15394
16458
  * | Invite a contractor to self-onboard | `admin_onboarding_incomplete` or `self_onboarding_not_invited` | `self_onboarding_invited` |
15395
16459
  * | Cancel a contractor's self-onboarding | `self_onboarding_invited` or `self_onboarding_not_invited` | `admin_onboarding_incomplete` |
15396
16460
  * | Review a contractor's self-onboarded info | `self_onboarding_started` | `self_onboarding_review` |
15397
- * | Finish a contractor's onboarding | `admin_onboarding_incomplete` or `self_onboarding_review` | `onboarding_completed` |
16461
+ * | Finish a contractor's onboarding | `admin_onboarding_review` or `self_onboarding_review` | `onboarding_completed` |
15398
16462
  */
15399
16463
  put: operations["put-v1-contractors-contractor_uuid-onboarding_status"];
15400
16464
  post?: never;
@@ -15458,9 +16522,12 @@ declare interface paths {
15458
16522
  * @description Creates a new, unprocessed, off-cycle payroll.
15459
16523
  *
15460
16524
  * ## `off_cycle_reason`
16525
+ * By default:
15461
16526
  * - External benefits and deductions will be included when the `off_cycle_reason` is set to `Correction`.
15462
16527
  * - All benefits and deductions are blocked when the `off_cycle_reason` is set to `Bonus`.
15463
16528
  *
16529
+ * These elections can be overridden with the `skip_regular_deductions` boolean.
16530
+ *
15464
16531
  * scope: `payrolls:run`
15465
16532
  */
15466
16533
  post: operations["post-v1-companies-company_id-payrolls"];
@@ -15508,7 +16575,6 @@ declare interface paths {
15508
16575
  * * Hours are represented to the thousands place; dollar amounts are represented to the cent.
15509
16576
  * * 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 ).
15510
16577
  * * To return future payrolls, you must include an `end_date` in the future.
15511
- * * To return future payrolls, you must include an `end_date` in the future.
15512
16578
  * * When include parameter with benefits value is passed, employee_benefits:read scope is required to return benefits
15513
16579
  * * Benefits containing PHI are only visible with the `employee_benefits:read:phi` scope
15514
16580
  *
@@ -15787,6 +16853,8 @@ declare interface paths {
15787
16853
  * Submit payroll
15788
16854
  * @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.
15789
16855
  *
16856
+ * You should poll to ensure that payroll is processed successfully, as async errors only occur after async processing is complete.
16857
+ *
15790
16858
  * 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.
15791
16859
  *
15792
16860
  * scope: `payrolls:run`
@@ -15869,7 +16937,7 @@ declare interface paths {
15869
16937
  post?: never;
15870
16938
  /**
15871
16939
  * Cancel a contractor payment
15872
- * @description Cancels and deletes a contractor payment. If the contractor payment has already started processing, the payment cannot be cancelled.
16940
+ * @description Cancels and deletes a contractor payment. If the contractor payment has already started processing ("may_cancel": true), the payment cannot be cancelled.
15873
16941
  *
15874
16942
  * scope: `payrolls:run`
15875
16943
  */
@@ -16124,7 +17192,7 @@ declare interface paths {
16124
17192
  };
16125
17193
  /**
16126
17194
  * Get the employee form pdf
16127
- * @description Get the link to the form PDF
17195
+ * @description Get the link to the employee form PDF
16128
17196
  *
16129
17197
  * scope: `employee_forms:read`
16130
17198
  */
@@ -16462,6 +17530,42 @@ declare interface paths {
16462
17530
  patch?: never;
16463
17531
  trace?: never;
16464
17532
  };
17533
+ "/v1/company_benefits/{company_benefit_id}/employee_benefits": {
17534
+ parameters: {
17535
+ query?: never;
17536
+ header?: never;
17537
+ path?: never;
17538
+ cookie?: never;
17539
+ };
17540
+ /**
17541
+ * Get all employee benefits for a company benefit
17542
+ * @description Employee benefits represent an employee enrolled in a particular company benefit. It includes information specific to that employee’s enrollment.
17543
+ *
17544
+ * Returns an array of all employee benefits enrolled for this company benefit.
17545
+ *
17546
+ * Benefits containing PHI are only visible to applications with the `employee_benefits:read:phi` scope.
17547
+ *
17548
+ * scope: `employee_benefits:read`
17549
+ */
17550
+ get: operations["get-v1-company_benefits-company_benefit_id-employee_benefits"];
17551
+ /**
17552
+ * Bulk update 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
+ * Create or update(if the employee is already enrolled in the company benefit previously) an employee benefit for the company benefit.
17556
+ *
17557
+ * Benefits containing PHI are only visible to applications with the `employee_benefits:read:phi` scope.
17558
+ *
17559
+ * scope: `employee_benefits:write`
17560
+ */
17561
+ put: operations["put-v1-company_benefits-company_benefit_id-employee_benefits"];
17562
+ post?: never;
17563
+ delete?: never;
17564
+ options?: never;
17565
+ head?: never;
17566
+ patch?: never;
17567
+ trace?: never;
17568
+ };
16465
17569
  "/v1/benefits/{benefit_id}/requirements": {
16466
17570
  parameters: {
16467
17571
  query?: never;
@@ -16632,6 +17736,28 @@ declare interface paths {
16632
17736
  patch?: never;
16633
17737
  trace?: never;
16634
17738
  };
17739
+ "/v1/garnishments/child_support": {
17740
+ parameters: {
17741
+ query?: never;
17742
+ header?: never;
17743
+ path?: never;
17744
+ cookie?: never;
17745
+ };
17746
+ /**
17747
+ * Get child support garnishment data
17748
+ * @description Agency data and requirements to be used for creating child support garnishments
17749
+ *
17750
+ * scope: `garnishments:read`
17751
+ */
17752
+ get: operations["get-v1-garnishments-child_support"];
17753
+ put?: never;
17754
+ post?: never;
17755
+ delete?: never;
17756
+ options?: never;
17757
+ head?: never;
17758
+ patch?: never;
17759
+ trace?: never;
17760
+ };
16635
17761
  "/v1/plaid/processor_token": {
16636
17762
  parameters: {
16637
17763
  query?: never;
@@ -17199,7 +18325,9 @@ declare interface paths {
17199
18325
  };
17200
18326
  }
17201
18327
 
17202
- declare function PaymentMethod(props: PaymentMethodProps & BaseComponentInterface): JSX_2.Element;
18328
+ export declare function PaymentMethod(): JSX_2.Element;
18329
+
18330
+ declare function PaymentMethod_2(props: PaymentMethodProps & BaseComponentInterface): JSX_2.Element;
17203
18331
 
17204
18332
  declare type PaymentMethodContextType = {
17205
18333
  bankAccounts: Schemas['Employee-Bank-Account'][];
@@ -17307,19 +18435,26 @@ declare interface PayrollTotalsConstructor {
17307
18435
  companyDebit?: number;
17308
18436
  }
17309
18437
 
17310
- declare function Profile(props: ProfileProps & BaseComponentInterface): JSX_2.Element;
18438
+ export declare function Profile(): JSX_2.Element;
17311
18439
 
17312
- declare namespace Profile {
18440
+ declare function Profile_2(props: ProfileProps & BaseComponentInterface): JSX_2.Element;
18441
+
18442
+ declare namespace Profile_2 {
17313
18443
  var Head: () => JSX_2.Element;
17314
18444
  var Actions: () => JSX_2.Element;
17315
- var PersonalDetails: () => JSX_2.Element;
18445
+ var AdminPersonalDetails: () => JSX_2.Element | null;
18446
+ var SelfPersonalDetails: () => JSX_2.Element | null;
18447
+ var HomeAddress: () => JSX_2.Element;
18448
+ var WorkAddress: WorkAddress;
17316
18449
  }
17317
18450
 
17318
18451
  declare type ProfileContextType = {
17319
18452
  companyLocations: Schemas['Location'][];
18453
+ workAddresses: Schemas['Employee-Work-Address'][] | null;
17320
18454
  employee?: Schemas['Employee'];
17321
18455
  isPending: boolean;
17322
18456
  handleCancel: () => void;
18457
+ flow: OnboardingFlow;
17323
18458
  };
17324
18459
 
17325
18460
  declare const ProfileContextual: () => JSX_2.Element;
@@ -17343,6 +18478,7 @@ declare interface ProfileProps extends CommonComponentInterface {
17343
18478
  zip?: string;
17344
18479
  };
17345
18480
  };
18481
+ flow?: OnboardingFlow;
17346
18482
  }
17347
18483
 
17348
18484
  declare type QueryParams<Path extends keyof paths> = _QueryParams<Path> extends {
@@ -17353,6 +18489,25 @@ declare type QueryParams<Path extends keyof paths> = _QueryParams<Path> extends
17353
18489
 
17354
18490
  declare type _QueryParams<Path extends keyof paths> = Parameters<ReturnType<typeof default_2<Pick<paths, Path>>>['GET']>['1'];
17355
18491
 
18492
+ export declare function ReorderableItem({ item, index, moveItem, itemCount }: ReorderableItemProps): JSX_2.Element;
18493
+
18494
+ declare interface ReorderableItemProps {
18495
+ item: ReactElement;
18496
+ index: number;
18497
+ moveItem: (fromIndex: number, toIndex: number) => void;
18498
+ itemCount: number;
18499
+ }
18500
+
18501
+ export declare function ReorderableList({ items, label, onReorder }: ReorderableListProps): JSX_2.Element;
18502
+
18503
+ declare interface ReorderableListProps {
18504
+ items: ReactElement[];
18505
+ label: string;
18506
+ onReorder?: (itemOrder: number[]) => void;
18507
+ }
18508
+
18509
+ declare type Resources = CustomTypeOptions['resources'];
18510
+
17356
18511
  declare type RGB = `rgb(${string})`
17357
18512
 
17358
18513
  declare type RGBA = `rgba(${string})`
@@ -17364,13 +18519,25 @@ declare type Schemas = components["schemas"];
17364
18519
  /**Creating new i18next instance to avoid global clashing */
17365
18520
  export declare const SDKI18next: i18n;
17366
18521
 
18522
+ declare function SignatureForm(): JSX_2.Element | null;
18523
+
18524
+ declare function SignatureFormHead(): JSX_2.Element | null;
18525
+
17367
18526
  declare interface SummaryProps extends CommonComponentInterface {
17368
18527
  employeeId: string;
18528
+ flow?: OnboardingFlow;
18529
+ }
18530
+
18531
+ declare interface SummaryProps_2 extends CommonComponentInterface {
18532
+ employeeId: string;
18533
+ companyId: string;
17369
18534
  }
17370
18535
 
17371
- declare function Taxes(props: TaxesProps & BaseComponentInterface): JSX_2.Element;
18536
+ export declare function Taxes(): JSX_2.Element;
18537
+
18538
+ declare function Taxes_2(props: TaxesProps & BaseComponentInterface): JSX_2.Element;
17372
18539
 
17373
- declare namespace Taxes {
18540
+ declare namespace Taxes_2 {
17374
18541
  var FederalHead: FederalHead;
17375
18542
  var FederalForm: FederalForm;
17376
18543
  var StateForm: () => JSX_2.Element[];
@@ -17380,12 +18547,14 @@ declare namespace Taxes {
17380
18547
  declare type TaxesContextType = {
17381
18548
  employeeStateTaxes: Schemas['Employee-State-Tax'][];
17382
18549
  isPending: boolean;
18550
+ isAdmin: boolean;
17383
18551
  };
17384
18552
 
17385
18553
  declare const TaxesContextual: () => JSX_2.Element;
17386
18554
 
17387
18555
  declare interface TaxesProps extends CommonComponentInterface {
17388
18556
  employeeId: string;
18557
+ isAdmin?: boolean;
17389
18558
  }
17390
18559
 
17391
18560
  declare type ThemeColor = RGB | RGBA | HEX | HSL | HSLA | VAR | 'transparent'
@@ -17399,7 +18568,7 @@ export declare interface ThemeContextProps {
17399
18568
  export declare const ThemeProvider: default_3.FC<ThemeProviderProps>;
17400
18569
 
17401
18570
  export declare interface ThemeProviderProps {
17402
- theme?: GTheme;
18571
+ theme?: DeepPartial<GTheme>;
17403
18572
  children?: default_3.ReactNode;
17404
18573
  }
17405
18574
 
@@ -17437,6 +18606,8 @@ recurring: boolean;
17437
18606
  annual_maximum: string | null;
17438
18607
  pay_period_maximum: string | null;
17439
18608
  deduct_as_percentage: boolean;
18609
+ garnishment_type?: "child_support" | "federal_tax_lien" | "state_tax_lien" | "student_loan" | "creditor_garnishment" | "federal_loan" | "other_garnishment" | null;
18610
+ child_support?: components["schemas"]["Garnishment-Child-Support"];
17440
18611
  }, Error, {
17441
18612
  employee_id: string;
17442
18613
  body: Parameters<(employee_id: string, body: BodyParams<"/v1/employees/{employee_id}/garnishments", "POST">) => Promise<{
@@ -17452,6 +18623,8 @@ recurring: boolean;
17452
18623
  annual_maximum: string | null;
17453
18624
  pay_period_maximum: string | null;
17454
18625
  deduct_as_percentage: boolean;
18626
+ garnishment_type?: "child_support" | "federal_tax_lien" | "state_tax_lien" | "student_loan" | "creditor_garnishment" | "federal_loan" | "other_garnishment" | null;
18627
+ child_support?: components["schemas"]["Garnishment-Child-Support"];
17455
18628
  }>>[1];
17456
18629
  }, unknown>;
17457
18630
 
@@ -17587,11 +18760,11 @@ middle_initial?: string | null;
17587
18760
  last_name: string;
17588
18761
  email?: string | null;
17589
18762
  readonly company_uuid?: string;
17590
- readonly manager_uuid?: string;
18763
+ readonly manager_uuid?: string | null;
17591
18764
  readonly version?: string;
17592
18765
  readonly department?: string | null;
17593
18766
  readonly terminated?: boolean;
17594
- two_percent_shareholder?: boolean;
18767
+ two_percent_shareholder?: boolean | null;
17595
18768
  readonly onboarded?: boolean;
17596
18769
  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";
17597
18770
  jobs?: components["schemas"]["Job"][];
@@ -17602,8 +18775,8 @@ custom_fields?: components["schemas"]["Employee-Custom-Field"][];
17602
18775
  readonly date_of_birth?: string | null;
17603
18776
  has_ssn?: boolean;
17604
18777
  ssn?: string;
17605
- phone?: string;
17606
- preferred_first_name?: string;
18778
+ phone?: string | null;
18779
+ preferred_first_name?: string | null;
17607
18780
  payment_method: "Direct Deposit" | "Check";
17608
18781
  work_email?: string | null;
17609
18782
  readonly current_employment_status?: "full_time" | "part_time_under_twenty_hours" | "part_time_twenty_plus_hours" | "variable" | "seasonal" | null;
@@ -17616,11 +18789,11 @@ middle_initial?: string | null;
17616
18789
  last_name: string;
17617
18790
  email?: string | null;
17618
18791
  readonly company_uuid?: string;
17619
- readonly manager_uuid?: string;
18792
+ readonly manager_uuid?: string | null;
17620
18793
  readonly version?: string;
17621
18794
  readonly department?: string | null;
17622
18795
  readonly terminated?: boolean;
17623
- two_percent_shareholder?: boolean;
18796
+ two_percent_shareholder?: boolean | null;
17624
18797
  readonly onboarded?: boolean;
17625
18798
  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";
17626
18799
  jobs?: components["schemas"]["Job"][];
@@ -17631,8 +18804,8 @@ custom_fields?: components["schemas"]["Employee-Custom-Field"][];
17631
18804
  readonly date_of_birth?: string | null;
17632
18805
  has_ssn?: boolean;
17633
18806
  ssn?: string;
17634
- phone?: string;
17635
- preferred_first_name?: string;
18807
+ phone?: string | null;
18808
+ preferred_first_name?: string | null;
17636
18809
  payment_method: "Direct Deposit" | "Check";
17637
18810
  work_email?: string | null;
17638
18811
  readonly current_employment_status?: "full_time" | "part_time_under_twenty_hours" | "part_time_twenty_plus_hours" | "variable" | "seasonal" | null;
@@ -17796,10 +18969,74 @@ export declare function useDeleteEmployeeWorkAddress(employee_id: string, opts:
17796
18969
  onError: OnError;
17797
18970
  } & Omit<Parameters<typeof useMutation>[0], 'mutationFn' | 'onError'>): UseMutationResult<unknown, unknown, string, unknown>;
17798
18971
 
18972
+ declare const useDocumentSigner: () => DocumentSignerContextType;
18973
+
17799
18974
  declare const useEmployeeList: () => EmployeeListContextType;
17800
18975
 
17801
18976
  export declare function useFlow<C extends FlowContextInterface>(): C;
17802
18977
 
18978
+ export declare function useGetAllEmployeeForms(employee_id: string): UseSuspenseQueryResult<{
18979
+ readonly uuid: string;
18980
+ readonly name?: string;
18981
+ readonly title?: string;
18982
+ readonly description?: string;
18983
+ readonly draft?: boolean;
18984
+ readonly year?: number | null;
18985
+ readonly quarter?: number | null;
18986
+ readonly requires_signing?: boolean;
18987
+ }[], Error>;
18988
+
18989
+ export declare function useGetCompany(company_id: string): UseSuspenseQueryResult< {
18990
+ readonly ein?: string;
18991
+ readonly entity_type?: "C-Corporation" | "S-Corporation" | "Sole proprietor" | "LLC" | "LLP" | "Limited partnership" | "Co-ownership" | "Association" | "Trusteeship" | "General partnership" | "Joint venture" | "Non-Profit";
18992
+ contractor_only?: boolean;
18993
+ readonly tier?: "simple" | "plus" | "premium" | "core" | "complete" | "concierge" | "contractor_only" | "basic" | null;
18994
+ is_suspended?: boolean;
18995
+ readonly company_status?: "Approved" | "Not Approved" | "Suspended";
18996
+ readonly uuid: string;
18997
+ readonly name?: string;
18998
+ readonly slug?: string;
18999
+ readonly trade_name?: string;
19000
+ readonly is_partner_managed?: boolean;
19001
+ readonly pay_schedule_type?: "single" | "hourly_salaried" | "by_employee" | "by_department" | null;
19002
+ readonly join_date?: string;
19003
+ funding_type?: "ach" | "reverse_wire" | "wire_in" | "brex";
19004
+ readonly locations?: components["schemas"]["Company-Address"][];
19005
+ readonly compensations?: {
19006
+ readonly hourly?: {
19007
+ readonly name?: string;
19008
+ readonly multiple?: number;
19009
+ }[];
19010
+ readonly fixed?: {
19011
+ name?: string;
19012
+ }[];
19013
+ readonly paid_time_off?: {
19014
+ readonly name?: string;
19015
+ }[];
19016
+ };
19017
+ readonly primary_signatory?: {
19018
+ readonly first_name?: string;
19019
+ readonly middle_initial?: string;
19020
+ readonly last_name?: string;
19021
+ readonly phone?: string;
19022
+ readonly email?: string;
19023
+ readonly home_address?: {
19024
+ readonly street_1?: string;
19025
+ readonly street_2?: string | null;
19026
+ readonly city?: string;
19027
+ readonly state?: string;
19028
+ readonly zip?: string;
19029
+ readonly country?: string;
19030
+ };
19031
+ };
19032
+ primary_payroll_admin?: {
19033
+ readonly first_name?: string;
19034
+ readonly last_name?: string;
19035
+ readonly phone?: string;
19036
+ readonly email?: string;
19037
+ };
19038
+ }, Error>;
19039
+
17803
19040
  export declare function useGetCompanyAddresses(company_id: string): UseSuspenseQueryResult< {
17804
19041
  readonly uuid: string;
17805
19042
  version?: string;
@@ -17884,170 +19121,154 @@ requirements?: string[];
17884
19121
  }[];
17885
19122
  }, Error>;
17886
19123
 
17887
- export declare function useGetDeduction(garnishment_id: string): UseSuspenseQueryResult< {
17888
- readonly uuid: string;
17889
- version?: string;
17890
- readonly employee_uuid?: string;
17891
- active: boolean;
17892
- amount?: string;
17893
- description?: string;
17894
- court_ordered?: boolean;
17895
- times: number | null;
17896
- recurring: boolean;
17897
- annual_maximum: string | null;
17898
- pay_period_maximum: string | null;
17899
- deduct_as_percentage: boolean;
19124
+ export declare function useGetDeduction(garnishment_id: string): UseSuspenseQueryResult<{
19125
+ readonly uuid: string;
19126
+ version?: string;
19127
+ readonly employee_uuid?: string;
19128
+ active: boolean;
19129
+ amount?: string;
19130
+ description?: string;
19131
+ court_ordered?: boolean;
19132
+ times: number | null;
19133
+ recurring: boolean;
19134
+ annual_maximum: string | null;
19135
+ pay_period_maximum: string | null;
19136
+ deduct_as_percentage: boolean;
19137
+ garnishment_type?: "child_support" | "federal_tax_lien" | "state_tax_lien" | "student_loan" | "creditor_garnishment" | "federal_loan" | "other_garnishment" | null;
19138
+ child_support?: components["schemas"]["Garnishment-Child-Support"];
17900
19139
  }, Error>;
17901
19140
 
17902
- export declare function useGetEmployee(employee_id: string): UseSuspenseQueryResult< {
17903
- readonly uuid: string;
17904
- first_name: string;
17905
- middle_initial?: string | null;
17906
- last_name: string;
17907
- email?: string | null;
17908
- readonly company_uuid?: string;
17909
- readonly manager_uuid?: string;
17910
- readonly version?: string;
17911
- readonly department?: string | null;
17912
- readonly terminated?: boolean;
17913
- two_percent_shareholder?: boolean;
17914
- readonly onboarded?: boolean;
17915
- 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";
17916
- jobs?: components["schemas"]["Job"][];
17917
- eligible_paid_time_off?: components["schemas"]["Paid-Time-Off"][];
17918
- terminations?: components["schemas"]["Termination"][];
17919
- garnishments?: components["schemas"]["Garnishment"][];
17920
- custom_fields?: components["schemas"]["Employee-Custom-Field"][];
17921
- readonly date_of_birth?: string | null;
17922
- has_ssn?: boolean;
17923
- ssn?: string;
17924
- phone?: string;
17925
- preferred_first_name?: string;
17926
- payment_method: "Direct Deposit" | "Check";
17927
- work_email?: string | null;
17928
- readonly current_employment_status?: "full_time" | "part_time_under_twenty_hours" | "part_time_twenty_plus_hours" | "variable" | "seasonal" | null;
17929
- }, Error>;
19141
+ export declare function useGetEmployee<T extends string | undefined>(employee_id: T): UseSuspenseQueryResult<InferResponse<T, Schemas["Employee"]>>;
17930
19142
 
17931
- export declare function useGetEmployeeBankAccounts(employee_id: string): UseSuspenseQueryResult< {
17932
- uuid: string;
17933
- employee_uuid?: string;
17934
- account_type?: "Checking" | "Savings";
17935
- name?: string;
17936
- routing_number?: string;
17937
- hidden_account_number?: string;
19143
+ export declare function useGetEmployeeBankAccounts(employee_id: string): UseSuspenseQueryResult<{
19144
+ uuid: string;
19145
+ employee_uuid?: string;
19146
+ account_type?: "Checking" | "Savings";
19147
+ name?: string;
19148
+ routing_number?: string;
19149
+ hidden_account_number?: string;
17938
19150
  }[], Error>;
17939
19151
 
17940
- export declare function useGetEmployeeDeductions(employee_id: string): UseSuspenseQueryResult< {
17941
- readonly uuid: string;
17942
- version?: string;
17943
- readonly employee_uuid?: string;
17944
- active: boolean;
17945
- amount?: string;
17946
- description?: string;
17947
- court_ordered?: boolean;
17948
- times: number | null;
17949
- recurring: boolean;
17950
- annual_maximum: string | null;
17951
- pay_period_maximum: string | null;
17952
- deduct_as_percentage: boolean;
19152
+ export declare function useGetEmployeeDeductions(employee_id: string): UseSuspenseQueryResult<{
19153
+ readonly uuid: string;
19154
+ version?: string;
19155
+ readonly employee_uuid?: string;
19156
+ active: boolean;
19157
+ amount?: string;
19158
+ description?: string;
19159
+ court_ordered?: boolean;
19160
+ times: number | null;
19161
+ recurring: boolean;
19162
+ annual_maximum: string | null;
19163
+ pay_period_maximum: string | null;
19164
+ deduct_as_percentage: boolean;
19165
+ garnishment_type?: "child_support" | "federal_tax_lien" | "state_tax_lien" | "student_loan" | "creditor_garnishment" | "federal_loan" | "other_garnishment" | null;
19166
+ child_support?: components["schemas"]["Garnishment-Child-Support"];
17953
19167
  }[], Error>;
17954
19168
 
17955
- export declare function useGetEmployeeFederalTaxes(employee_id: string): UseSuspenseQueryResult< {
17956
- version?: string;
17957
- filing_status?: string;
17958
- extra_withholding?: string;
17959
- two_jobs?: boolean;
17960
- dependents_amount?: string;
17961
- other_income?: string;
17962
- deductions?: string;
17963
- w4_data_type?: "pre_2020_w4" | "rev_2020_w4";
17964
- federal_withholding_allowance?: number;
17965
- additional_withholding?: boolean;
19169
+ export declare function useGetEmployeeFederalTaxes(employee_id: string): UseSuspenseQueryResult<{
19170
+ version?: string;
19171
+ filing_status?: string;
19172
+ extra_withholding?: string | null;
19173
+ two_jobs?: boolean | null;
19174
+ dependents_amount?: string | null;
19175
+ other_income?: string | null;
19176
+ deductions?: string | null;
19177
+ w4_data_type?: "pre_2020_w4" | "rev_2020_w4";
19178
+ federal_withholding_allowance?: number;
19179
+ additional_withholding?: boolean;
17966
19180
  }, Error>;
17967
19181
 
19182
+ export declare function useGetEmployeeFormPdf(employee_id: string): UseMutationResult< {
19183
+ readonly uuid: string;
19184
+ document_url?: string;
19185
+ }, Error, {
19186
+ form_id: string;
19187
+ }, unknown>;
19188
+
17968
19189
  export declare function useGetEmployeeHomeAddress(home_address_uuid: string): UseSuspenseQueryResult<NonNullable<{
17969
- version?: string;
19190
+ version?: string;
17970
19191
  } & {
17971
- street_1?: string;
17972
- street_2?: string | null;
17973
- city?: string;
17974
- state?: string;
17975
- zip?: string;
17976
- country: string;
17977
- readonly active?: boolean;
19192
+ street_1?: string;
19193
+ street_2?: string | null;
19194
+ city?: string;
19195
+ state?: string;
19196
+ zip?: string;
19197
+ country: string;
19198
+ readonly active?: boolean;
17978
19199
  } & {
17979
- uuid?: string;
17980
- employee_uuid?: string;
17981
- effective_date?: string;
17982
- courtesy_withholding?: boolean;
19200
+ uuid?: string;
19201
+ employee_uuid?: string;
19202
+ effective_date?: string;
19203
+ courtesy_withholding?: boolean;
17983
19204
  }>, Error>;
17984
19205
 
17985
- export declare function useGetEmployeeHomeAddresses(employee_id: string): UseSuspenseQueryResult<({
17986
- version?: string;
19206
+ export declare function useGetEmployeeHomeAddresses(employee_id: string | undefined): UseSuspenseQueryResult<({
19207
+ version?: string;
17987
19208
  } & {
17988
- street_1?: string;
17989
- street_2?: string | null;
17990
- city?: string;
17991
- state?: string;
17992
- zip?: string;
17993
- country: string;
17994
- readonly active?: boolean;
19209
+ street_1?: string;
19210
+ street_2?: string | null;
19211
+ city?: string;
19212
+ state?: string;
19213
+ zip?: string;
19214
+ country: string;
19215
+ readonly active?: boolean;
17995
19216
  } & {
17996
- uuid?: string;
17997
- employee_uuid?: string;
17998
- effective_date?: string;
17999
- courtesy_withholding?: boolean;
18000
- })[], Error>;
19217
+ uuid?: string;
19218
+ employee_uuid?: string;
19219
+ effective_date?: string;
19220
+ courtesy_withholding?: boolean;
19221
+ })[] | null, Error>;
18001
19222
 
18002
- export declare function useGetEmployeeJob(job_id: string): UseSuspenseQueryResult< {
18003
- readonly uuid: string;
18004
- version?: string;
18005
- readonly employee_uuid?: string;
18006
- hire_date?: string;
18007
- title: string | null;
18008
- readonly primary?: boolean;
18009
- readonly rate?: string;
18010
- readonly payment_unit?: string;
18011
- readonly current_compensation_uuid?: string;
18012
- two_percent_shareholder?: boolean;
18013
- state_wc_covered?: boolean;
18014
- state_wc_class_code?: string;
18015
- readonly compensations?: components["schemas"]["Compensation"][];
19223
+ export declare function useGetEmployeeJob(job_id: string): UseSuspenseQueryResult<{
19224
+ readonly uuid: string;
19225
+ version?: string;
19226
+ readonly employee_uuid?: string;
19227
+ hire_date?: string;
19228
+ title: string | null;
19229
+ readonly primary?: boolean;
19230
+ readonly rate?: string;
19231
+ readonly payment_unit?: string;
19232
+ readonly current_compensation_uuid?: string;
19233
+ two_percent_shareholder?: boolean;
19234
+ state_wc_covered?: boolean;
19235
+ state_wc_class_code?: string;
19236
+ readonly compensations?: components["schemas"]["Compensation"][];
18016
19237
  }, Error>;
18017
19238
 
18018
- export declare function useGetEmployeeJobs(employee_id: string): UseSuspenseQueryResult< {
18019
- readonly uuid: string;
18020
- version?: string;
18021
- readonly employee_uuid?: string;
18022
- hire_date?: string;
18023
- title: string | null;
18024
- readonly primary?: boolean;
18025
- readonly rate?: string;
18026
- readonly payment_unit?: string;
18027
- readonly current_compensation_uuid?: string;
18028
- two_percent_shareholder?: boolean;
18029
- state_wc_covered?: boolean;
18030
- state_wc_class_code?: string;
18031
- readonly compensations?: components["schemas"]["Compensation"][];
19239
+ export declare function useGetEmployeeJobs(employee_id: string): UseSuspenseQueryResult<{
19240
+ readonly uuid: string;
19241
+ version?: string;
19242
+ readonly employee_uuid?: string;
19243
+ hire_date?: string;
19244
+ title: string | null;
19245
+ readonly primary?: boolean;
19246
+ readonly rate?: string;
19247
+ readonly payment_unit?: string;
19248
+ readonly current_compensation_uuid?: string;
19249
+ two_percent_shareholder?: boolean;
19250
+ state_wc_covered?: boolean;
19251
+ state_wc_class_code?: string;
19252
+ readonly compensations?: components["schemas"]["Compensation"][];
18032
19253
  }[], Error>;
18033
19254
 
18034
- export declare function useGetEmployeeOnboardingStatus(employee_id: string): UseSuspenseQueryResult< {
18035
- uuid: string;
18036
- onboarding_status?: string;
18037
- onboarding_steps?: {
18038
- title?: string;
18039
- id?: string;
18040
- required?: boolean;
18041
- completed?: boolean;
18042
- requirements?: string[];
18043
- }[];
19255
+ export declare function useGetEmployeeOnboardingStatus(employee_id: string): UseSuspenseQueryResult<{
19256
+ uuid: string;
19257
+ onboarding_status?: string;
19258
+ onboarding_steps?: {
19259
+ title?: string;
19260
+ id?: string;
19261
+ required?: boolean;
19262
+ completed?: boolean;
19263
+ requirements?: string[];
19264
+ }[];
18044
19265
  }, Error>;
18045
19266
 
18046
- export declare function useGetEmployeePaymentMethod(employee_id: string): UseSuspenseQueryResult< {
18047
- version?: string;
18048
- type?: "Direct Deposit" | "Check";
18049
- split_by?: "Amount" | "Percentage" | null;
18050
- splits?: components["schemas"]["Payment-Method-Bank-Account"][] | null;
19267
+ export declare function useGetEmployeePaymentMethod(employee_id: string): UseSuspenseQueryResult<{
19268
+ version?: string;
19269
+ type?: "Direct Deposit" | "Check";
19270
+ split_by?: "Amount" | "Percentage" | null;
19271
+ splits?: components["schemas"]["Payment-Method-Bank-Account"][] | null;
18051
19272
  }, Error>;
18052
19273
 
18053
19274
  export declare function useGetEmployeesByCompany(company_id: string): UseSuspenseQueryResult< {
@@ -18057,11 +19278,11 @@ middle_initial?: string | null;
18057
19278
  last_name: string;
18058
19279
  email?: string | null;
18059
19280
  readonly company_uuid?: string;
18060
- readonly manager_uuid?: string;
19281
+ readonly manager_uuid?: string | null;
18061
19282
  readonly version?: string;
18062
19283
  readonly department?: string | null;
18063
19284
  readonly terminated?: boolean;
18064
- two_percent_shareholder?: boolean;
19285
+ two_percent_shareholder?: boolean | null;
18065
19286
  readonly onboarded?: boolean;
18066
19287
  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";
18067
19288
  jobs?: components["schemas"]["Job"][];
@@ -18072,50 +19293,50 @@ custom_fields?: components["schemas"]["Employee-Custom-Field"][];
18072
19293
  readonly date_of_birth?: string | null;
18073
19294
  has_ssn?: boolean;
18074
19295
  ssn?: string;
18075
- phone?: string;
18076
- preferred_first_name?: string;
19296
+ phone?: string | null;
19297
+ preferred_first_name?: string | null;
18077
19298
  payment_method: "Direct Deposit" | "Check";
18078
19299
  work_email?: string | null;
18079
19300
  readonly current_employment_status?: "full_time" | "part_time_under_twenty_hours" | "part_time_twenty_plus_hours" | "variable" | "seasonal" | null;
18080
19301
  }[], Error>;
18081
19302
 
18082
- export declare function useGetEmployeeStateTaxes(employee_id: string): UseSuspenseQueryResult< {
18083
- employee_uuid: string;
18084
- state: string;
18085
- file_new_hire_report?: boolean;
18086
- is_work_state?: boolean;
18087
- questions: components["schemas"]["Employee-State-Tax-Question"][];
19303
+ export declare function useGetEmployeeStateTaxes(employee_id: string): UseSuspenseQueryResult<{
19304
+ employee_uuid: string;
19305
+ state: string;
19306
+ file_new_hire_report?: boolean;
19307
+ is_work_state?: boolean;
19308
+ questions: components["schemas"]["Employee-State-Tax-Question"][];
18088
19309
  }[], Error>;
18089
19310
 
18090
- export declare function useGetEmployeeWorkAddress(work_address_uuid: string): UseSuspenseQueryResult< {
18091
- readonly uuid: string;
18092
- effective_date?: string;
18093
- readonly active?: boolean;
18094
- location_uuid?: string;
18095
- employee_uuid?: string;
18096
- version?: string;
18097
- readonly street_1?: string;
18098
- readonly street_2?: string | null;
18099
- readonly city?: string;
18100
- readonly state?: string;
18101
- readonly zip?: string;
18102
- readonly country: string;
19311
+ export declare function useGetEmployeeWorkAddress(work_address_uuid: string): UseSuspenseQueryResult<{
19312
+ readonly uuid: string;
19313
+ effective_date?: string;
19314
+ readonly active?: boolean;
19315
+ location_uuid?: string;
19316
+ employee_uuid?: string;
19317
+ version?: string;
19318
+ readonly street_1?: string;
19319
+ readonly street_2?: string | null;
19320
+ readonly city?: string;
19321
+ readonly state?: string;
19322
+ readonly zip?: string;
19323
+ readonly country: string;
18103
19324
  }[], Error>;
18104
19325
 
18105
- export declare function useGetEmployeeWorkAddresses(employee_id: string): UseSuspenseQueryResult< {
18106
- readonly uuid: string;
18107
- effective_date?: string;
18108
- readonly active?: boolean;
18109
- location_uuid?: string;
18110
- employee_uuid?: string;
18111
- version?: string;
18112
- readonly street_1?: string;
18113
- readonly street_2?: string | null;
18114
- readonly city?: string;
18115
- readonly state?: string;
18116
- readonly zip?: string;
18117
- readonly country: string;
18118
- }[], Error>;
19326
+ export declare function useGetEmployeeWorkAddresses(employee_id: string | undefined): UseSuspenseQueryResult<{
19327
+ readonly uuid: string;
19328
+ effective_date?: string;
19329
+ readonly active?: boolean;
19330
+ location_uuid?: string;
19331
+ employee_uuid?: string;
19332
+ version?: string;
19333
+ readonly street_1?: string;
19334
+ readonly street_2?: string | null;
19335
+ readonly city?: string;
19336
+ readonly state?: string;
19337
+ readonly zip?: string;
19338
+ readonly country: string;
19339
+ }[] | null, Error>;
18119
19340
 
18120
19341
  export declare function useGetHistoricalPayrolls(companyId: string, startDate: Date, endDate: Date): UseSuspenseQueryResult<Payroll[], Error>;
18121
19342
 
@@ -18144,6 +19365,7 @@ payroll_uuid: components["schemas"]["Payroll-Payroll-Uuid-Type"];
18144
19365
  company_uuid: components["schemas"]["Payroll-Company-Uuid-Type"];
18145
19366
  off_cycle?: components["schemas"]["Payroll-Off-Cycle-Type"];
18146
19367
  off_cycle_reason?: components["schemas"]["Off-Cycle-Reason-Type"];
19368
+ auto_pilot?: components["schemas"]["Auto-Pilot-Type"];
18147
19369
  external?: components["schemas"]["Payroll-External-Type"];
18148
19370
  final_termination_payroll?: components["schemas"]["Payroll-Final-Termination-Payroll-Type"];
18149
19371
  withholding_pay_period?: components["schemas"]["Payroll-Withholding-Pay-Period-Type"];
@@ -18180,6 +19402,29 @@ declare type UsePaySchedulePreviewParams = Operations['get-v1-companies-company_
18180
19402
 
18181
19403
  declare const useProfile: () => ProfileContextType;
18182
19404
 
19405
+ export declare function useSignEmployeeForm(employee_id: string, opts?: Omit<Parameters<typeof useMutation>[0], 'mutationFn'>): UseMutationResult< {
19406
+ readonly uuid: string;
19407
+ readonly name?: string;
19408
+ readonly title?: string;
19409
+ readonly description?: string;
19410
+ readonly draft?: boolean;
19411
+ readonly year?: number | null;
19412
+ readonly quarter?: number | null;
19413
+ readonly requires_signing?: boolean;
19414
+ }, Error, {
19415
+ form_id: string;
19416
+ body: Parameters<(employee_id: string, form_id: string, body: BodyParams<"/v1/employees/{employee_id}/forms/{form_id}/sign", "PUT">) => Promise<{
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
+ }>>[2];
19426
+ }, unknown>;
19427
+
18183
19428
  declare const useTaxes: () => TaxesContextType;
18184
19429
 
18185
19430
  export declare const useTheme: () => ThemeContextProps;
@@ -18260,7 +19505,7 @@ cookie?: never;
18260
19505
  requestBody?: {
18261
19506
  content: {
18262
19507
  "application/json": {
18263
- title: string;
19508
+ title?: string;
18264
19509
  naics_code: string;
18265
19510
  sic_codes?: string[];
18266
19511
  };
@@ -18278,7 +19523,7 @@ company_id: string;
18278
19523
  };
18279
19524
  };
18280
19525
  body: {
18281
- title: string;
19526
+ title?: string;
18282
19527
  naics_code: string;
18283
19528
  sic_codes?: string[];
18284
19529
  } | undefined;
@@ -18369,6 +19614,8 @@ recurring: boolean;
18369
19614
  annual_maximum: string | null;
18370
19615
  pay_period_maximum: string | null;
18371
19616
  deduct_as_percentage: boolean;
19617
+ garnishment_type?: "child_support" | "federal_tax_lien" | "state_tax_lien" | "student_loan" | "creditor_garnishment" | "federal_loan" | "other_garnishment" | null;
19618
+ child_support?: components["schemas"]["Garnishment-Child-Support"];
18372
19619
  }, Error, {
18373
19620
  garnishment_id: string;
18374
19621
  body: Parameters<(garnishment_id: string, body: BodyParams<"/v1/garnishments/{garnishment_id}", "PUT">) => Promise<{
@@ -18384,6 +19631,8 @@ recurring: boolean;
18384
19631
  annual_maximum: string | null;
18385
19632
  pay_period_maximum: string | null;
18386
19633
  deduct_as_percentage: boolean;
19634
+ garnishment_type?: "child_support" | "federal_tax_lien" | "state_tax_lien" | "student_loan" | "creditor_garnishment" | "federal_loan" | "other_garnishment" | null;
19635
+ child_support?: components["schemas"]["Garnishment-Child-Support"];
18387
19636
  }>>[1];
18388
19637
  }, unknown>;
18389
19638
 
@@ -18394,11 +19643,11 @@ middle_initial?: string | null;
18394
19643
  last_name: string;
18395
19644
  email?: string | null;
18396
19645
  readonly company_uuid?: string;
18397
- readonly manager_uuid?: string;
19646
+ readonly manager_uuid?: string | null;
18398
19647
  readonly version?: string;
18399
19648
  readonly department?: string | null;
18400
19649
  readonly terminated?: boolean;
18401
- two_percent_shareholder?: boolean;
19650
+ two_percent_shareholder?: boolean | null;
18402
19651
  readonly onboarded?: boolean;
18403
19652
  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";
18404
19653
  jobs?: components["schemas"]["Job"][];
@@ -18409,8 +19658,8 @@ custom_fields?: components["schemas"]["Employee-Custom-Field"][];
18409
19658
  readonly date_of_birth?: string | null;
18410
19659
  has_ssn?: boolean;
18411
19660
  ssn?: string;
18412
- phone?: string;
18413
- preferred_first_name?: string;
19661
+ phone?: string | null;
19662
+ preferred_first_name?: string | null;
18414
19663
  payment_method: "Direct Deposit" | "Check";
18415
19664
  work_email?: string | null;
18416
19665
  readonly current_employment_status?: "full_time" | "part_time_under_twenty_hours" | "part_time_twenty_plus_hours" | "variable" | "seasonal" | null;
@@ -18423,11 +19672,11 @@ middle_initial?: string | null;
18423
19672
  last_name: string;
18424
19673
  email?: string | null;
18425
19674
  readonly company_uuid?: string;
18426
- readonly manager_uuid?: string;
19675
+ readonly manager_uuid?: string | null;
18427
19676
  readonly version?: string;
18428
19677
  readonly department?: string | null;
18429
19678
  readonly terminated?: boolean;
18430
- two_percent_shareholder?: boolean;
19679
+ two_percent_shareholder?: boolean | null;
18431
19680
  readonly onboarded?: boolean;
18432
19681
  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";
18433
19682
  jobs?: components["schemas"]["Job"][];
@@ -18438,8 +19687,8 @@ custom_fields?: components["schemas"]["Employee-Custom-Field"][];
18438
19687
  readonly date_of_birth?: string | null;
18439
19688
  has_ssn?: boolean;
18440
19689
  ssn?: string;
18441
- phone?: string;
18442
- preferred_first_name?: string;
19690
+ phone?: string | null;
19691
+ preferred_first_name?: string | null;
18443
19692
  payment_method: "Direct Deposit" | "Check";
18444
19693
  work_email?: string | null;
18445
19694
  readonly current_employment_status?: "full_time" | "part_time_under_twenty_hours" | "part_time_twenty_plus_hours" | "variable" | "seasonal" | null;
@@ -18525,27 +19774,26 @@ uuid?: string;
18525
19774
  }, `${string}/${string}`>>>[1];
18526
19775
  }, unknown>;
18527
19776
 
18528
- export declare function useUpdateEmployeeFederalTaxes(opts?: Omit<Parameters<typeof useMutation>[0], 'mutationFn'>): UseMutationResult< {
19777
+ export declare function useUpdateEmployeeFederalTaxes(employeeId: string, opts?: Omit<Parameters<typeof useMutation>[0], 'mutationFn'>): UseMutationResult< {
18529
19778
  version?: string;
18530
19779
  filing_status?: string;
18531
- extra_withholding?: string;
18532
- two_jobs?: boolean;
18533
- dependents_amount?: string;
18534
- other_income?: string;
18535
- deductions?: string;
19780
+ extra_withholding?: string | null;
19781
+ two_jobs?: boolean | null;
19782
+ dependents_amount?: string | null;
19783
+ other_income?: string | null;
19784
+ deductions?: string | null;
18536
19785
  w4_data_type?: "pre_2020_w4" | "rev_2020_w4";
18537
19786
  federal_withholding_allowance?: number;
18538
19787
  additional_withholding?: boolean;
18539
19788
  }, Error, {
18540
- employeeId: string;
18541
19789
  body: Parameters<(employee_uuid: string, body: BodyParams<"/v1/employees/{employee_uuid}/federal_taxes", "PUT">) => Promise<{
18542
19790
  version?: string;
18543
19791
  filing_status?: string;
18544
- extra_withholding?: string;
18545
- two_jobs?: boolean;
18546
- dependents_amount?: string;
18547
- other_income?: string;
18548
- deductions?: string;
19792
+ extra_withholding?: string | null;
19793
+ two_jobs?: boolean | null;
19794
+ dependents_amount?: string | null;
19795
+ other_income?: string | null;
19796
+ deductions?: string | null;
18549
19797
  w4_data_type?: "pre_2020_w4" | "rev_2020_w4";
18550
19798
  federal_withholding_allowance?: number;
18551
19799
  additional_withholding?: boolean;
@@ -18683,17 +19931,575 @@ readonly country: string;
18683
19931
 
18684
19932
  declare type VAR = `var(${string})`
18685
19933
 
19934
+ declare function WorkAddress(): JSX_2.Element | null;
19935
+
18686
19936
  export { }
18687
19937
 
19938
+ declare namespace _default {
19939
+ function process(): {
19940
+ code: string;
19941
+ };
19942
+ }
19943
+
19944
+ declare namespace _default {
19945
+ function process(sourceText: any, sourcePath: any): {
19946
+ code: string;
19947
+ };
19948
+ }
19949
+
18688
19950
 
18689
19951
 
18690
19952
  declare module 'i18next' {
18691
- interface CustomTypeOptions {
18692
- defaultNS: 'common'
18693
- resources: typeof Resources
18694
- }
19953
+ export interface CompanyAddBank{
19954
+ "title":string;
19955
+ "intro":string;
19956
+ "entry_selection_question":string;
19957
+ "manual_entry":string;
19958
+ "plaid_entry":string;
19959
+ "routing_number_label":string;
19960
+ "account_number_label":string;
19961
+ "account_type_label":string;
19962
+ "account_type_checking":string;
19963
+ "account_type_savings":string;
19964
+ "submit":string;
19965
+ };
19966
+ export interface CompanyAddresses{
19967
+ "title":string;
19968
+ "description":string;
19969
+ "mailingLabel":string;
19970
+ "filingLabel":string;
19971
+ "editCta":string;
19972
+ "addCta":string;
19973
+ "continueCta":string;
19974
+ };
19975
+ export interface CompanyFederalTaxes{
19976
+ "pageTitle":string;
19977
+ "entity_type_and_legal_name_intro":string;
19978
+ "federal_ein_label":string;
19979
+ "federal_ein_description":string;
19980
+ "taxpayer_type_label":string;
19981
+ "taxpayer_type_options":string;
19982
+ "federal_filing_form_label":string;
19983
+ "federal_filing_form_description":string;
19984
+ "form_941_label":string;
19985
+ "form_944_label":string;
19986
+ "legal_entity_name_label":string;
19987
+ "legal_entity_name_tip":string;
19988
+ "c_corporation":string;
19989
+ "s_corporation":string;
19990
+ "sole_proprietor":string;
19991
+ "llc":string;
19992
+ "llp":string;
19993
+ "limited_partnership":string;
19994
+ "co_ownership":string;
19995
+ "association":string;
19996
+ "trusteeship":string;
19997
+ "general_partnership":string;
19998
+ "joint_venture":string;
19999
+ "non_profit":string;
20000
+ "cancelCta":string;
20001
+ };
20002
+ export interface CompanyIndustry{
20003
+ "pageTitle":string;
20004
+ "sectionTitle":string;
20005
+ "desc":string;
20006
+ "placeholder":string;
20007
+ "cancelCta":string;
20008
+ "continueCta":string;
20009
+ };
20010
+ export interface EmployeeBankAccount{
20011
+ "accountNumberLabel":string;
20012
+ "accountTypeChecking":string;
20013
+ "accountTypeLabel":string;
20014
+ "accountTypeSavings":string;
20015
+ "accountTypeSelect":string;
20016
+ "cancelCta":string;
20017
+ "checkImageAlt":string;
20018
+ "description":string;
20019
+ "nameLabel":string;
20020
+ "routingNumberLabel":string;
20021
+ "routingNumberDescription":string;
20022
+ "submitCta":string;
20023
+ "title":string;
20024
+ "validations":{
20025
+ "accountType":string;
20026
+ }
20027
+ };
20028
+ export interface EmployeeCompensation{
20029
+ "addAnotherJobCta":string;
20030
+ "allCompensations":{
20031
+ "actionColumn":string;
20032
+ "amountColumn":string;
20033
+ "deleteCta":string;
20034
+ "editCta":string;
20035
+ "jobColumn":string;
20036
+ "perColumn":string;
20037
+ "tableLabel":string;
20038
+ "typeColumn":string;
20039
+ }
20040
+ "amount":string;
20041
+ "backCta":string;
20042
+ "cancelCta":string;
20043
+ "cancelNewJobCta":string;
20044
+ "classificationCTA":string;
20045
+ "employeeClassification":string;
20046
+ "flsaStatusLabels":{
20047
+ "Commission Only Exempt":string;
20048
+ "Commission Only Nonexempt":string;
20049
+ "Exempt":string;
20050
+ "Nonexempt":string;
20051
+ "Owner":string;
20052
+ "Salaried Nonexempt":string;
20053
+ }
20054
+ "hamburgerTitle":string;
20055
+ "jobTitle":string;
20056
+ "paymentUnitDescription":string;
20057
+ "paymentUnitLabel":string;
20058
+ "paymentUnitOptions":{
20059
+ "Hour":string;
20060
+ "Month":string;
20061
+ "Paycheck":string;
20062
+ "Week":string;
20063
+ "Year":string;
20064
+ }
20065
+ "saveNewJobCta":string;
20066
+ "submitCta":string;
20067
+ "title":string;
20068
+ "validations":{
20069
+ "classificationChangeNotification":string;
20070
+ "exemptThreshold":string;
20071
+ "paymentUnit":string;
20072
+ "rate":string;
20073
+ "title":string;
20074
+ }
20075
+ };
20076
+ export interface EmployeeDeductions{
20077
+ "pageTitle":string;
20078
+ "includeDeductionsFormLabel":string;
20079
+ "includeDeductionsDescription":string;
20080
+ "includeDeductionsYes":string;
20081
+ "includeDeductionsNo":string;
20082
+ "continueCta":string;
20083
+ "addDeductionTitle":string;
20084
+ "editDeductionTitle":string;
20085
+ "addDeuctionDescription":string;
20086
+ "descriptionLabel":string;
20087
+ "frequencyLabel":string;
20088
+ "frequencyRecurringOption":string;
20089
+ "frequencyOneTimeOption":string;
20090
+ "deductionsTableLabel":string;
20091
+ "deductionTypeLabel":string;
20092
+ "deductionTypePercentageOption":string;
20093
+ "deductionTypeFixedAmountOption":string;
20094
+ "deductionAmountLabel":string;
20095
+ "annualMaxLabel":string;
20096
+ "courtOrderedLabel":string;
20097
+ "nameColumn":string;
20098
+ "frequencyColumn":string;
20099
+ "withheldColumn":string;
20100
+ "actionsColumn":string;
20101
+ "recurringText":string;
20102
+ "recurringAmount":string;
20103
+ "nonRecurringText":string;
20104
+ "emptyListMessage":string;
20105
+ "hamburgerTitle":string;
20106
+ "editCta":string;
20107
+ "deleteCta":string;
20108
+ "addDeductionCta":string;
20109
+ "cancelCta":string;
20110
+ "validations":{
20111
+ "description":string;
20112
+ "amount":string;
20113
+ }
20114
+ };
20115
+ export interface EmployeeDocumentSigner{
20116
+ "documentListTitle":string;
20117
+ "documentListLabel":string;
20118
+ "formColumnLabel":string;
20119
+ "statusColumnLabel":string;
20120
+ "continueCta":string;
20121
+ "signDocumentCta":string;
20122
+ "signDocumentComplete":string;
20123
+ "documentListError":string;
20124
+ "emptyTableTitle":string;
20125
+ "signatureFormTitle":string;
20126
+ "downloadPrompt":string;
20127
+ "signatureFieldLabel":string;
20128
+ "signatureFieldDescription":string;
20129
+ "signatureFieldError":string;
20130
+ "confirmSignatureCheckboxLabel":string;
20131
+ "confirmSignatureError":string;
20132
+ "backCta":string;
20133
+ "signFormCta":string;
20134
+ };
20135
+ export interface EmployeeEmployeeList{
20136
+ "actionLabel":string;
20137
+ "addEmployeeCTA":string;
20138
+ "addAnotherCta":string;
20139
+ "addressesCta":string;
20140
+ "deductionsCta":string;
20141
+ "deleteCta":string;
20142
+ "editCta":string;
20143
+ "employeeListLabel":string;
20144
+ "emptyTableDescription":string;
20145
+ "emptyTableTitle":string;
20146
+ "federalTaxesCta":string;
20147
+ "hamburgerTitle":string;
20148
+ "nameLabel":string;
20149
+ "statusLabel":string;
20150
+ "title":string;
20151
+ };
20152
+ export interface EmployeeHomeAddress{
20153
+ "formTitle":string;
20154
+ "desc":string;
20155
+ "street1":string;
20156
+ "street2":string;
20157
+ "city":string;
20158
+ "state":string;
20159
+ "statePlaceholder":string;
20160
+ "zip":string;
20161
+ "courtesyWithholdingLabel":string;
20162
+ "courtesyWhithholdingDescription":string;
20163
+ "learnMoreCta":string;
20164
+ "withholdingTitle":string;
20165
+ "withholdingNote":string;
20166
+ "editAddress":string;
20167
+ "cancel":string;
20168
+ "submit":string;
20169
+ "validations":{
20170
+ "street1":string;
20171
+ "city":string;
20172
+ "state":string;
20173
+ "zip":string;
20174
+ }
20175
+ };
20176
+ export interface EmployeeLanding{
20177
+ "landingSubtitle":string;
20178
+ "landingDescription":string;
20179
+ "stepsSubtitle":string;
20180
+ "steps":{
20181
+ "personalInfo":string;
20182
+ "taxInfo":string;
20183
+ "bankInfo":string;
20184
+ }
20185
+ "getStartedCta":string;
20186
+ "getStartedDescription":string;
20187
+ };
20188
+ export interface EmployeeOnboardingSummary{
20189
+ "subTitle":string;
20190
+ "description":string;
20191
+ "onboardedAdminSubtitle":string;
20192
+ "onboardedAdminDescription":string;
20193
+ "onboardedSelfSubtitle":string;
20194
+ "onboardedSelfDescription":string;
20195
+ "returnToEmployeeListCta":string;
20196
+ "addAnotherCta":string;
20197
+ "newHireReportCta":string;
20198
+ "steps":{
20199
+ "personal_details":string;
20200
+ "compensation_details":string;
20201
+ "add_work_address":string;
20202
+ "add_home_address":string;
20203
+ "federal_tax_setup":string;
20204
+ "state_tax_setup":string;
20205
+ "direct_deposit_setup":string;
20206
+ "employee_form_signing":string;
20207
+ "file_new_hire_report":string;
20208
+ }
20209
+ };
20210
+ export interface EmployeePaySchedules{
20211
+ "pageTitle":string;
20212
+ "saveAndContinueCta":string;
20213
+ "pleaseVerify":string;
20214
+ "labels":{
20215
+ "frequency":string;
20216
+ "firstPayDate":string;
20217
+ "deadline":string;
18695
20218
  }
20219
+ };
20220
+ export interface EmployeePaymentMethod{
20221
+ "accountNumberLabel":string;
20222
+ "accountTypeColumn":string;
20223
+ "accountTypeLabel":string;
20224
+ "accountTypeChecking":string;
20225
+ "accountTypeSavings":string;
20226
+ "allocationColumn":string;
20227
+ "actionColumn":string;
20228
+ "addAnotherCta":string;
20229
+ "addBankAccountCTA":string;
20230
+ "bankAccountsListLabel":string;
20231
+ "cancelCta":string;
20232
+ "saveCta":string;
20233
+ "cancelAddCta":string;
20234
+ "checkDescription":string;
20235
+ "checkLabel":string;
20236
+ "deleteBankAccountCTA":string;
20237
+ "directDepositDescription":string;
20238
+ "directDepositLabel":string;
20239
+ "hamburgerTitle":string;
20240
+ "nameLabel":string;
20241
+ "nicknameColumn":string;
20242
+ "paymentFieldsetLegend":string;
20243
+ "routingNumberColumn":string;
20244
+ "routingNumberLabel":string;
20245
+ "routingNumberDescription":string;
20246
+ "splitCta":string;
20247
+ "submitCta":string;
20248
+ "title":string;
20249
+ "amountLabel":string;
20250
+ "splitDescription":string;
20251
+ "draggableListLabel":string;
20252
+ "percentageLabel":string;
20253
+ "splitAmountLabel":string;
20254
+ "splitByLabel":string;
20255
+ "priorityLabel":string;
20256
+ "remainderLabel":string;
20257
+ "splitTitle":string;
20258
+ "priority_one":string;
20259
+ "priority_two":string;
20260
+ "priority_few":string;
20261
+ "priority_other":string;
20262
+ "validations":{
20263
+ "percentageError":string;
20264
+ "amountError":string;
20265
+ "accountName":string;
20266
+ "routingNumber":string;
20267
+ "accountNumber":string;
20268
+ }
20269
+ };
20270
+ export interface EmployeeProfile{
20271
+ "cancelCta":string;
20272
+ "description":string;
20273
+ "dobLabel":string;
20274
+ "email":string;
20275
+ "emailDescription":string;
20276
+ "firstName":string;
20277
+ "formTitle":string;
20278
+ "lastName":string;
20279
+ "middleInitial":string;
20280
+ "preferredFirstName":string;
20281
+ "selfOnboardingLabel":string;
20282
+ "ssnLabel":string;
20283
+ "ssnMask":string;
20284
+ "startDateDescription":string;
20285
+ "startDateLabel":string;
20286
+ "submitCta":string;
20287
+ "title":string;
20288
+ "validations":{
20289
+ "email":string;
20290
+ "firstName":string;
20291
+ "lastName":string;
20292
+ "startDate":string;
20293
+ }
20294
+ "workAddress":string;
20295
+ "workAddressDescription":string;
20296
+ "workAddressPlaceholder":string;
20297
+ "workAddressSectionTitle":string;
20298
+ "workAddressSectionDescription":string;
20299
+ };
20300
+ export interface EmployeeSplitPaycheck{
20301
+ "amountLabel":string;
20302
+ "bankDescription":string;
20303
+ "description":string;
20304
+ "percentageLabel":string;
20305
+ "splitAmountLabel":string;
20306
+ "splitByLabel":string;
20307
+ "priorityLabel":string;
20308
+ "title":string;
20309
+ "remainderLabel":string;
20310
+ "priority_one":string;
20311
+ "priority_two":string;
20312
+ "priority_few":string;
20313
+ "priority_other":string;
20314
+ "validations":{
20315
+ "percentageError":string;
20316
+ "priorityError":string;
20317
+ "amountError":string;
20318
+ }
20319
+ "cancelCta":string;
20320
+ "submitCta":string;
20321
+ };
20322
+ export interface EmployeeStateTaxes{
20323
+ "title":string;
20324
+ "filingStatusLabel":string;
20325
+ "cancelCta":string;
20326
+ "submitCta":string;
20327
+ };
20328
+ export interface EmployeeTaxes{
20329
+ "cancelCta":string;
20330
+ "deductions":string;
20331
+ "dependentsTotalIfApplicable":string;
20332
+ "extraWithholding":string;
20333
+ "federalFilingStatus1c":string;
20334
+ "federalFillingStatusPlaceholder":string;
20335
+ "federalTaxesTitle":string;
20336
+ "filingStatusExemptFromWithholding":string;
20337
+ "filingStatusHeadOfHousehold":string;
20338
+ "filingStatusMarried":string;
20339
+ "filingStatusSingle":string;
20340
+ "includesSpouseExplanation":string;
20341
+ "irs_calculator":string;
20342
+ "irsCalculatorOrW4Line":string;
20343
+ "multipleJobs2c":string;
20344
+ "otherIncome":string;
20345
+ "selectWithholdingDescription":string;
20346
+ "stateTaxesTitle":string;
20347
+ "submitCta":string;
20348
+ "twoJobYesLabel":string;
20349
+ "twoJobNoLabel":string;
20350
+ "validations":{
20351
+ "federalFilingStatus":string;
20352
+ "federalTwoJobs":string;
20353
+ }
20354
+ };
20355
+ export interface PayrollPayrollHistoryList{
20356
+ "period":string;
20357
+ "payrollType":string;
20358
+ "payrollCancellable":string;
20359
+ "checkDate":string;
20360
+ "payrollTotal":string;
20361
+ };
20362
+ export interface PayrollPayrollSchedule{
20363
+ "pageTitle":string;
20364
+ "helpOne":string;
20365
+ "helpTwo":string;
20366
+ "helpThree":string;
20367
+ "payFrequency":string;
20368
+ "payFrequency.weekly":string;
20369
+ "payFrequency.biweekly":string;
20370
+ "payFrequency.semimonthly":string;
20371
+ "payFrequency.semimonthly_custom":string;
20372
+ "payFrequency.monthly":string;
20373
+ "day_1.label":string;
20374
+ "day_2.label":string;
20375
+ "anchor_pay_date.label":string;
20376
+ "deadline_to_run_payroll.label":string;
20377
+ "anchor_end_of_pay_period.label":string;
20378
+ "anchor_end_of_pay_period.help":string;
20379
+ };
20380
+ export interface common{
20381
+ "status":{
20382
+ "loading":string;
20383
+ "requiredField":string;
20384
+ "errorEncountered":string;
20385
+ }
20386
+ "optionalLabel":string;
20387
+ "errors":{
20388
+ "globalReactError":string;
20389
+ "missingParamsOrContext":string;
20390
+ "unhandledEvent":string;
20391
+ "unknownEventType":string;
20392
+ }
20393
+ "icons":{
20394
+ "selectArrow":string;
20395
+ "calendarArrow":string;
20396
+ "nextMonth":string;
20397
+ "previousMonth":string;
20398
+ "magnifyingGlass":string;
20399
+ }
20400
+ "flows":{
20401
+ "employeeOnboarding":{
20402
+ "employeeListTitle":string;
20403
+ "profileTitle":string;
20404
+ "compensationTitle":string;
20405
+ "taxesTitle":string;
20406
+ "paymentMethodTitle":string;
20407
+ "deductionsTitle":string;
20408
+ "summaryTitle":string;
20409
+ }
20410
+ "employeeSelfOnboarding":{
20411
+ "profileTitle":string;
20412
+ "documentSignerTitle":string;
20413
+ }
20414
+ }
20415
+ "labels":{
20416
+ "draggableLabel":string;
20417
+ "draggablePosition":string;
20418
+ "back":string;
20419
+ "saveContinue":string;
20420
+ "submit":string;
20421
+ "name":string;
20422
+ "yes":string;
20423
+ "no":string;
20424
+ }
20425
+ "onboardingStatus":{
20426
+ "undefined":string;
20427
+ "onboarding_completed":string;
20428
+ "admin_onboarding_incomplete":string;
20429
+ "self_onboarding_pending_invite":string;
20430
+ "self_onboarding_invited":string;
20431
+ "self_onboarding_invited_started":string;
20432
+ "self_onboarding_invited_overdue":string;
20433
+ "self_onboarding_completed_by_employee":string;
20434
+ "self_onboarding_awaiting_admin_review":string;
20435
+ }
20436
+ "validations":{
20437
+ "accountName":string;
20438
+ "routingNumber":string;
20439
+ "accountNumber":string;
20440
+ "ssn":string;
20441
+ "location":string;
20442
+ "dob":string;
20443
+ }
20444
+ "statesHash":{
20445
+ "AL":string;
20446
+ "AK":string;
20447
+ "AZ":string;
20448
+ "AR":string;
20449
+ "CA":string;
20450
+ "CO":string;
20451
+ "CT":string;
20452
+ "DE":string;
20453
+ "FL":string;
20454
+ "GA":string;
20455
+ "HI":string;
20456
+ "ID":string;
20457
+ "IL":string;
20458
+ "IN":string;
20459
+ "IA":string;
20460
+ "KS":string;
20461
+ "KY":string;
20462
+ "LA":string;
20463
+ "ME":string;
20464
+ "MD":string;
20465
+ "MA":string;
20466
+ "MI":string;
20467
+ "MN":string;
20468
+ "MS":string;
20469
+ "MO":string;
20470
+ "MT":string;
20471
+ "NE":string;
20472
+ "NV":string;
20473
+ "NH":string;
20474
+ "NJ":string;
20475
+ "NM":string;
20476
+ "NY":string;
20477
+ "NC":string;
20478
+ "ND":string;
20479
+ "OH":string;
20480
+ "OK":string;
20481
+ "OR":string;
20482
+ "PA":string;
20483
+ "RI":string;
20484
+ "SC":string;
20485
+ "SD":string;
20486
+ "TN":string;
20487
+ "TX":string;
20488
+ "UT":string;
20489
+ "VT":string;
20490
+ "VA":string;
20491
+ "WA":string;
20492
+ "WV":string;
20493
+ "WI":string;
20494
+ "WY":string;
20495
+ }
20496
+ };
18696
20497
 
20498
+ interface CustomTypeOptions {
20499
+ defaultNS: 'common';
20500
+ 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, }
20501
+ };
20502
+ }
18697
20503
  declare module 'robot3' {
18698
20504
  /**
18699
20505
  * TS Helpers