@gusto/embedded-react-sdk 0.0.6 → 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.
package/dist/index.d.ts CHANGED
@@ -6,6 +6,7 @@ import { FetchOptions } from 'openapi-fetch';
6
6
  import { FetchResponse } from 'openapi-fetch';
7
7
  import { i18n } from 'i18next';
8
8
  import { JSX as JSX_2 } from 'react/jsx-runtime';
9
+ import { ReactElement } from 'react';
9
10
  import { ReactNode } from 'react';
10
11
  import { useMutation } from '@tanstack/react-query';
11
12
  import { UseMutationResult } from '@tanstack/react-query';
@@ -137,7 +138,6 @@ 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, 1, 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>;
@@ -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: {
@@ -206,6 +208,9 @@ declare const componentEvents: {
206
208
  readonly EMPLOYEE_SUMMARY_VIEW: "employee/summary";
207
209
  readonly EMPLOYEES_LIST: "company/employees";
208
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;
@@ -4476,13 +4785,49 @@ declare interface DeductionsProps extends CommonComponentInterface {
4476
4785
  }
4477
4786
 
4478
4787
  declare type DeepPartial<T> = {
4479
- [P in keyof T]?: T[P] extends (infer U)[] ? DeepPartial<U>[] : T[P] extends object ? DeepPartial<T[P]> : T[P];
4480
- };
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
+ }
4481
4794
 
4482
4795
  export declare type Dictionary = Record<string, Partial<{
4483
4796
  [K in keyof Resources]: DeepPartial<Resources[K]>;
4484
4797
  }>>;
4485
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
+
4486
4831
  declare namespace Employee {
4487
4832
  export {
4488
4833
  EmployeeList,
@@ -4495,9 +4840,9 @@ declare namespace Employee {
4495
4840
  IncludeDeductionsPayload,
4496
4841
  Root,
4497
4842
  DeductionsContextual,
4498
- OnboardingSummary,
4843
+ OnboardingSummary_2 as OnboardingSummary,
4499
4844
  OnboardingSummaryContextual,
4500
- Profile,
4845
+ Profile_2 as Profile,
4501
4846
  useProfile,
4502
4847
  ProfileContextual,
4503
4848
  Compensation,
@@ -4505,15 +4850,17 @@ declare namespace Employee {
4505
4850
  CompensationInputs,
4506
4851
  CompensationOutputs,
4507
4852
  CompensationContextual,
4508
- Taxes,
4853
+ Taxes_2 as Taxes,
4509
4854
  useTaxes,
4510
4855
  TaxesContextual,
4511
- PaymentMethod,
4856
+ PaymentMethod_2 as PaymentMethod,
4512
4857
  usePaymentMethod,
4513
4858
  CombinedSchemaInputs,
4514
4859
  CombinedSchemaOutputs,
4515
4860
  PaymentMethodContextual,
4516
- Landing
4861
+ Landing_2 as Landing,
4862
+ DocumentSigner_2 as DocumentSigner,
4863
+ useDocumentSigner
4517
4864
  }
4518
4865
  }
4519
4866
  export { Employee }
@@ -4544,6 +4891,7 @@ declare interface EmployeeListProps extends CommonComponentInterface {
4544
4891
  export declare interface EmployeeOnboardingContextInterface extends FlowContextInterface {
4545
4892
  companyId: string;
4546
4893
  employeeId?: string;
4894
+ isAdmin?: boolean;
4547
4895
  paymentMethod?: Schemas['Employee-Payment-Method'];
4548
4896
  }
4549
4897
 
@@ -4553,13 +4901,26 @@ export declare interface EmployeeOnboardingFlowProps extends BaseComponentInterf
4553
4901
  companyId: string;
4554
4902
  }
4555
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
+
4556
4917
  declare type EventType = (typeof componentEvents)[keyof typeof componentEvents];
4557
4918
 
4558
4919
  declare function FederalForm(): JSX_2.Element;
4559
4920
 
4560
4921
  declare function FederalHead(): JSX_2.Element;
4561
4922
 
4562
- declare interface FlowContextInterface {
4923
+ export declare interface FlowContextInterface {
4563
4924
  component: React.ComponentType | null;
4564
4925
  onEvent: OnEventType<EventType, unknown>;
4565
4926
  title?: string;
@@ -4567,25 +4928,31 @@ declare interface FlowContextInterface {
4567
4928
 
4568
4929
  declare interface GTheme {
4569
4930
  rootFS: string
4570
- colors?: GThemeColors
4571
- focus?: GThemeFocus
4572
- shadow?: GThemeShadow
4573
- spacing?: GThemeSpacing
4574
- typography?: GThemeTypography
4931
+ colors: GThemeColors
4932
+ focus: GThemeFocus
4933
+ shadow: GThemeShadow
4934
+ spacing: GThemeSpacing
4935
+ typography: GThemeTypography
4575
4936
  input: GThemeInput
4576
4937
  button: GThemeButton
4577
4938
  radio: GThemeRadio
4578
4939
  checkbox: GThemeCheckbox
4579
- table?: GThemeTable
4580
- link?: GThemeLink
4581
- badge?: GThemeBadge
4582
- 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
4583
4944
  }
4584
4945
 
4585
4946
  declare interface GThemeBadge {
4947
+ success: {
4948
+ color: string
4949
+ backgroundColor: string
4950
+ borderColor: string
4951
+ }
4586
4952
  fontSize: string
4587
4953
  fontWeight: number
4588
4954
  borderWidth: string
4955
+ borderRadius: string
4589
4956
  paddingX: string
4590
4957
  paddingY: string
4591
4958
  }
@@ -4594,6 +4961,8 @@ declare interface GThemeButton {
4594
4961
  fontSize: string
4595
4962
  fontWeight: number
4596
4963
  borderWidth: string
4964
+ borderRadius: string
4965
+ textStyle: 'uppercase' | 'none' | 'capitalize' | 'lowercase'
4597
4966
  paddingX: string
4598
4967
  paddingY: string
4599
4968
  shadow: string
@@ -4630,6 +4999,18 @@ declare interface GThemeColors {
4630
4999
  900: ThemeColor
4631
5000
  1000: ThemeColor
4632
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
+ }
4633
5014
  error: {
4634
5015
  100: ThemeColor
4635
5016
  500: ThemeColor
@@ -4638,6 +5019,7 @@ declare interface GThemeColors {
4638
5019
  warning: {
4639
5020
  100: ThemeColor
4640
5021
  500: ThemeColor
5022
+ 700: ThemeColor
4641
5023
  800: ThemeColor
4642
5024
  }
4643
5025
  success: {
@@ -4654,12 +5036,26 @@ declare interface GThemeFocus {
4654
5036
  }
4655
5037
 
4656
5038
  declare interface GThemeInput {
5039
+ fontSize: string
4657
5040
  textColor: ThemeColor
4658
5041
  borderColor: ThemeColor
5042
+ borderWidth: string
5043
+ background: string
4659
5044
  padding: string
4660
5045
  labelFontSize: string
4661
5046
  labelColor: ThemeColor
4662
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
4663
5059
  }
4664
5060
 
4665
5061
  declare interface GThemeLink {
@@ -4685,6 +5081,7 @@ declare interface GThemeRadio {
4685
5081
  }
4686
5082
 
4687
5083
  declare interface GThemeShadow {
5084
+ 100: string
4688
5085
  200: string
4689
5086
  }
4690
5087
 
@@ -4701,20 +5098,42 @@ declare interface GThemeSpacing {
4701
5098
  }
4702
5099
 
4703
5100
  declare interface GThemeTable {
4704
- borderColor?: string
4705
- background?: string
4706
- highlightBg?: string
4707
- highlightFg?: string
4708
- focusRingColor?: string
4709
- 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
4710
5112
  }
4711
5113
 
4712
5114
  declare interface GThemeTypography {
4713
- font?: string
4714
- fontBold?: string
4715
- textColor?: ThemeColor
4716
- errorTextColor?: ThemeColor
4717
- 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
+ }
4718
5137
  }
4719
5138
 
4720
5139
  export declare function GustoApiContextProvider({ children, context, }: {
@@ -4730,7 +5149,7 @@ export declare interface GustoApiProps {
4730
5149
  lng?: string;
4731
5150
  locale?: string;
4732
5151
  currency?: string;
4733
- theme?: GTheme;
5152
+ theme?: DeepPartial<GTheme>;
4734
5153
  children?: default_3.ReactNode;
4735
5154
  }
4736
5155
 
@@ -4776,6 +5195,7 @@ export declare class GustoClient {
4776
5195
  getCompany(company_id: string): Promise<{
4777
5196
  readonly ein?: string;
4778
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;
4779
5199
  readonly tier?: "simple" | "plus" | "premium" | "core" | "complete" | "concierge" | "contractor_only" | "basic" | null;
4780
5200
  is_suspended?: boolean;
4781
5201
  readonly company_status?: "Approved" | "Not Approved" | "Suspended";
@@ -4784,7 +5204,7 @@ export declare class GustoClient {
4784
5204
  readonly slug?: string;
4785
5205
  readonly trade_name?: string;
4786
5206
  readonly is_partner_managed?: boolean;
4787
- readonly pay_schedule_type?: "single" | "hourly_salaried" | "by_employee" | "by_department";
5207
+ readonly pay_schedule_type?: "single" | "hourly_salaried" | "by_employee" | "by_department" | null;
4788
5208
  readonly join_date?: string;
4789
5209
  funding_type?: "ach" | "reverse_wire" | "wire_in" | "brex";
4790
5210
  readonly locations?: components["schemas"]["Company-Address"][];
@@ -4848,7 +5268,7 @@ export declare class GustoClient {
4848
5268
  getEmployee(employee_id: string): Promise<FetchResponse< {
4849
5269
  parameters: {
4850
5270
  query?: {
4851
- include?: "all_compensations" | "custom_fields";
5271
+ include?: ("all_compensations" | "custom_fields")[];
4852
5272
  };
4853
5273
  header?: {
4854
5274
  "X-Gusto-API-Version"?: components["parameters"]["VersionHeader"];
@@ -4877,11 +5297,11 @@ export declare class GustoClient {
4877
5297
  last_name: string;
4878
5298
  email?: string | null;
4879
5299
  readonly company_uuid?: string;
4880
- readonly manager_uuid?: string;
5300
+ readonly manager_uuid?: string | null;
4881
5301
  readonly version?: string;
4882
5302
  readonly department?: string | null;
4883
5303
  readonly terminated?: boolean;
4884
- two_percent_shareholder?: boolean;
5304
+ two_percent_shareholder?: boolean | null;
4885
5305
  readonly onboarded?: boolean;
4886
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";
4887
5307
  jobs?: components["schemas"]["Job"][];
@@ -4892,8 +5312,8 @@ export declare class GustoClient {
4892
5312
  readonly date_of_birth?: string | null;
4893
5313
  has_ssn?: boolean;
4894
5314
  ssn?: string;
4895
- phone?: string;
4896
- preferred_first_name?: string;
5315
+ phone?: string | null;
5316
+ preferred_first_name?: string | null;
4897
5317
  payment_method: "Direct Deposit" | "Check";
4898
5318
  work_email?: string | null;
4899
5319
  readonly current_employment_status?: "full_time" | "part_time_under_twenty_hours" | "part_time_twenty_plus_hours" | "variable" | "seasonal" | null;
@@ -4919,7 +5339,7 @@ export declare class GustoClient {
4919
5339
  parameters: {
4920
5340
  query?: {
4921
5341
  terminated?: boolean;
4922
- include?: "all_compensations" | "custom_fields";
5342
+ include?: ("all_compensations" | "custom_fields")[];
4923
5343
  page?: components["parameters"]["pageParam"];
4924
5344
  per?: components["parameters"]["perParam"];
4925
5345
  search_term?: components["parameters"]["search_term"];
@@ -4955,11 +5375,11 @@ export declare class GustoClient {
4955
5375
  last_name: string;
4956
5376
  email?: string | null;
4957
5377
  readonly company_uuid?: string;
4958
- readonly manager_uuid?: string;
5378
+ readonly manager_uuid?: string | null;
4959
5379
  readonly version?: string;
4960
5380
  readonly department?: string | null;
4961
5381
  readonly terminated?: boolean;
4962
- two_percent_shareholder?: boolean;
5382
+ two_percent_shareholder?: boolean | null;
4963
5383
  readonly onboarded?: boolean;
4964
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";
4965
5385
  jobs?: components["schemas"]["Job"][];
@@ -4970,8 +5390,8 @@ export declare class GustoClient {
4970
5390
  readonly date_of_birth?: string | null;
4971
5391
  has_ssn?: boolean;
4972
5392
  ssn?: string;
4973
- phone?: string;
4974
- preferred_first_name?: string;
5393
+ phone?: string | null;
5394
+ preferred_first_name?: string | null;
4975
5395
  payment_method: "Direct Deposit" | "Check";
4976
5396
  work_email?: string | null;
4977
5397
  readonly current_employment_status?: "full_time" | "part_time_under_twenty_hours" | "part_time_twenty_plus_hours" | "variable" | "seasonal" | null;
@@ -5503,6 +5923,8 @@ export declare class GustoClient {
5503
5923
  annual_maximum: string | null;
5504
5924
  pay_period_maximum: string | null;
5505
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"];
5506
5928
  }>;
5507
5929
  updateDeduction(garnishment_id: string, body: BodyParams<'/v1/garnishments/{garnishment_id}', 'PUT'>): Promise<{
5508
5930
  readonly uuid: string;
@@ -5517,6 +5939,8 @@ export declare class GustoClient {
5517
5939
  annual_maximum: string | null;
5518
5940
  pay_period_maximum: string | null;
5519
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"];
5520
5944
  }>;
5521
5945
  getEmployeeBankAccounts(employee_id: string): Promise<FetchResponse< {
5522
5946
  parameters: {
@@ -5765,10 +6189,10 @@ export declare class GustoClient {
5765
6189
  }, `${string}/${string}`>>;
5766
6190
  previewPayScheduleDates(company_id: string, query: QueryParams<'/v1/companies/{company_id}/pay_schedules/preview'>): Promise<FetchResponse< {
5767
6191
  parameters: {
5768
- query?: {
5769
- frequency?: "Every week" | "Every other week" | "Twice per month" | "Monthly";
5770
- anchor_pay_date?: string;
5771
- 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;
5772
6196
  day_1?: number;
5773
6197
  day_2?: number;
5774
6198
  };
@@ -5805,22 +6229,22 @@ export declare class GustoClient {
5805
6229
  company_id: string;
5806
6230
  };
5807
6231
  query: {
5808
- frequency?: "Every week" | "Every other week" | "Twice per month" | "Monthly";
5809
- anchor_pay_date?: string;
5810
- 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;
5811
6235
  day_1?: number;
5812
6236
  day_2?: number;
5813
- } | undefined;
6237
+ };
5814
6238
  };
5815
6239
  }, `${string}/${string}`>>;
5816
6240
  getEmployeeFederalTaxes(employee_uuid: string): Promise<{
5817
6241
  version?: string;
5818
6242
  filing_status?: string;
5819
- extra_withholding?: string;
5820
- two_jobs?: boolean;
5821
- dependents_amount?: string;
5822
- other_income?: string;
5823
- deductions?: 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;
5824
6248
  w4_data_type?: "pre_2020_w4" | "rev_2020_w4";
5825
6249
  federal_withholding_allowance?: number;
5826
6250
  additional_withholding?: boolean;
@@ -5828,11 +6252,11 @@ export declare class GustoClient {
5828
6252
  updateEmployeeFederalTaxes(employee_uuid: string, body: BodyParams<'/v1/employees/{employee_uuid}/federal_taxes', 'PUT'>): Promise<{
5829
6253
  version?: string;
5830
6254
  filing_status?: string;
5831
- extra_withholding?: string;
5832
- two_jobs?: boolean;
5833
- dependents_amount?: string;
5834
- other_income?: string;
5835
- 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;
5836
6260
  w4_data_type?: "pre_2020_w4" | "rev_2020_w4";
5837
6261
  federal_withholding_allowance?: number;
5838
6262
  additional_withholding?: boolean;
@@ -5859,6 +6283,7 @@ export declare class GustoClient {
5859
6283
  include?: ("totals" | "payroll_status_meta" | "risk_blockers")[];
5860
6284
  start_date?: string;
5861
6285
  end_date?: string;
6286
+ sort_order?: components["parameters"]["sort_order"];
5862
6287
  };
5863
6288
  header?: {
5864
6289
  "X-Gusto-API-Version"?: components["parameters"]["VersionHeader"];
@@ -5894,6 +6319,7 @@ export declare class GustoClient {
5894
6319
  include?: ("totals" | "payroll_status_meta" | "risk_blockers")[];
5895
6320
  start_date?: string;
5896
6321
  end_date?: string;
6322
+ sort_order?: components["parameters"]["sort_order"];
5897
6323
  };
5898
6324
  header?: {
5899
6325
  "X-Gusto-API-Version"?: components["parameters"]["VersionHeader"];
@@ -5925,7 +6351,7 @@ export declare class GustoClient {
5925
6351
  getPayroll(company_id: string, payroll_id: string): Promise<FetchResponse< {
5926
6352
  parameters: {
5927
6353
  query?: {
5928
- include?: "benefits" | "deductions" | "taxes" | "payroll_status_meta";
6354
+ include?: ("benefits" | "deductions" | "taxes" | "payroll_status_meta")[];
5929
6355
  };
5930
6356
  header?: {
5931
6357
  "X-Gusto-API-Version"?: components["parameters"]["VersionHeader"];
@@ -5944,7 +6370,7 @@ export declare class GustoClient {
5944
6370
  }, FetchOptions< {
5945
6371
  parameters: {
5946
6372
  query?: {
5947
- include?: "benefits" | "deductions" | "taxes" | "payroll_status_meta";
6373
+ include?: ("benefits" | "deductions" | "taxes" | "payroll_status_meta")[];
5948
6374
  };
5949
6375
  header?: {
5950
6376
  "X-Gusto-API-Version"?: components["parameters"]["VersionHeader"];
@@ -5998,7 +6424,7 @@ export declare class GustoClient {
5998
6424
  requestBody?: {
5999
6425
  content: {
6000
6426
  "application/json": {
6001
- title: string;
6427
+ title?: string;
6002
6428
  naics_code: string;
6003
6429
  sic_codes?: string[];
6004
6430
  };
@@ -6016,7 +6442,7 @@ export declare class GustoClient {
6016
6442
  };
6017
6443
  };
6018
6444
  body: {
6019
- title: string;
6445
+ title?: string;
6020
6446
  naics_code: string;
6021
6447
  sic_codes?: string[];
6022
6448
  } | undefined;
@@ -6135,6 +6561,30 @@ export declare class GustoClient {
6135
6561
  requirements?: string[];
6136
6562
  }[];
6137
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
+ }>;
6138
6588
  }
6139
6589
 
6140
6590
  export declare function handleResponse<T>({ response, data, error }: {
@@ -6159,7 +6609,9 @@ declare const IncludeDeductionsSchema: v.ObjectSchema<{
6159
6609
 
6160
6610
  declare type InferResponse<T, S> = T extends string ? Awaited<ReturnType<typeof handleResponse<S>>> : null;
6161
6611
 
6162
- declare function Landing(props: SummaryProps_2 & BaseComponentInterface): JSX_2.Element;
6612
+ export declare function Landing(): JSX_2.Element;
6613
+
6614
+ declare function Landing_2(props: SummaryProps_2 & BaseComponentInterface): JSX_2.Element;
6163
6615
 
6164
6616
  declare type MODE = 'ADD' | 'LIST' | 'INITIAL' | 'EDIT';
6165
6617
 
@@ -6167,9 +6619,13 @@ declare type MODE_2 = 'LIST' | 'EDIT' | 'ADD' | 'SINGLE' | 'PROCEED';
6167
6619
 
6168
6620
  declare type MODE_3 = 'ADD' | 'LIST' | 'SPLIT' | 'INITIAL';
6169
6621
 
6622
+ declare type MODE_4 = 'LIST' | 'SIGN';
6623
+
6170
6624
  declare type OnboardingFlow = 'self' | 'admin'
6171
6625
 
6172
- declare function OnboardingSummary(props: SummaryProps & BaseComponentInterface): JSX_2.Element;
6626
+ export declare function OnboardingSummary(): JSX_2.Element;
6627
+
6628
+ declare function OnboardingSummary_2(props: SummaryProps & BaseComponentInterface): JSX_2.Element;
6173
6629
 
6174
6630
  declare const OnboardingSummaryContextual: () => JSX_2.Element;
6175
6631
 
@@ -6281,6 +6737,8 @@ declare interface operations {
6281
6737
  trade_name?: string;
6282
6738
  /** @description The employer identification number (EIN) of the company. */
6283
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;
6284
6742
  };
6285
6743
  };
6286
6744
  };
@@ -6333,6 +6791,33 @@ declare interface operations {
6333
6791
  404: components["responses"]["Not-Found-Error-Object"];
6334
6792
  };
6335
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
+ };
6336
6821
  "put-v1-partner-managed-companies-company-uuid-migrate": {
6337
6822
  parameters: {
6338
6823
  query?: never;
@@ -6484,7 +6969,7 @@ declare interface operations {
6484
6969
  422: components["responses"]["Unprocessable-Entity-Error-Object"];
6485
6970
  };
6486
6971
  };
6487
- "get-v1-companies-company_id-federal_tax_details": {
6972
+ "get-v1-companies-attachment": {
6488
6973
  parameters: {
6489
6974
  query?: never;
6490
6975
  header?: {
@@ -6494,16 +6979,18 @@ declare interface operations {
6494
6979
  path: {
6495
6980
  /** @description The UUID of the company */
6496
6981
  company_id: components["parameters"]["company_id"];
6982
+ /** @description The UUID of the company attachment */
6983
+ company_attachment_uuid: components["parameters"]["company_attachment_uuid"];
6497
6984
  };
6498
6985
  cookie?: never;
6499
6986
  };
6500
6987
  requestBody?: never;
6501
6988
  responses: {
6502
- 200: components["responses"]["Federal-Tax-Details-Object"];
6989
+ 200: components["responses"]["Company-Attachment-Object"];
6503
6990
  404: components["responses"]["Not-Found-Error-Object"];
6504
6991
  };
6505
6992
  };
6506
- "put-v1-companies-company_id-federal_tax_details": {
6993
+ "get-v1-companies-attachment-url": {
6507
6994
  parameters: {
6508
6995
  query?: never;
6509
6996
  header?: {
@@ -6513,16 +7000,120 @@ declare interface operations {
6513
7000
  path: {
6514
7001
  /** @description The UUID of the company */
6515
7002
  company_id: components["parameters"]["company_id"];
7003
+ /** @description The UUID of the company attachment */
7004
+ company_attachment_uuid: components["parameters"]["company_attachment_uuid"];
6516
7005
  };
6517
7006
  cookie?: never;
6518
7007
  };
6519
- /** @description Attributes related to federal tax details that can be updated via this endpoint include: */
6520
- requestBody?: {
6521
- content: {
6522
- "application/json": {
6523
- /** @description The legal name of the company */
6524
- legal_name?: string;
6525
- /** @description The EIN of of the company */
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
+ };
7078
+ "get-v1-companies-company_id-federal_tax_details": {
7079
+ parameters: {
7080
+ query?: never;
7081
+ header?: {
7082
+ /** @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. */
7083
+ "X-Gusto-API-Version"?: components["parameters"]["VersionHeader"];
7084
+ };
7085
+ path: {
7086
+ /** @description The UUID of the company */
7087
+ company_id: components["parameters"]["company_id"];
7088
+ };
7089
+ cookie?: never;
7090
+ };
7091
+ requestBody?: never;
7092
+ responses: {
7093
+ 200: components["responses"]["Federal-Tax-Details-Object"];
7094
+ 404: components["responses"]["Not-Found-Error-Object"];
7095
+ };
7096
+ };
7097
+ "put-v1-companies-company_id-federal_tax_details": {
7098
+ parameters: {
7099
+ query?: never;
7100
+ header?: {
7101
+ /** @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. */
7102
+ "X-Gusto-API-Version"?: components["parameters"]["VersionHeader"];
7103
+ };
7104
+ path: {
7105
+ /** @description The UUID of the company */
7106
+ company_id: components["parameters"]["company_id"];
7107
+ };
7108
+ cookie?: never;
7109
+ };
7110
+ /** @description Attributes related to federal tax details that can be updated via this endpoint include: */
7111
+ requestBody?: {
7112
+ content: {
7113
+ "application/json": {
7114
+ /** @description The legal name of the company */
7115
+ legal_name?: string;
7116
+ /** @description The EIN of of the company */
6526
7117
  ein?: string;
6527
7118
  /**
6528
7119
  * @description What type of tax entity the company is
@@ -6582,7 +7173,7 @@ declare interface operations {
6582
7173
  content: {
6583
7174
  "application/json": {
6584
7175
  /** @description Industry title */
6585
- title: string;
7176
+ title?: string;
6586
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 */
6587
7178
  naics_code: string;
6588
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. */
@@ -7511,13 +8102,13 @@ declare interface operations {
7511
8102
  };
7512
8103
  "get-v1-companies-company_id-pay_schedules-preview": {
7513
8104
  parameters: {
7514
- query?: {
8105
+ query: {
7515
8106
  /** @description The frequency that employees on this pay schedule are paid with Gusto. */
7516
- frequency?: "Every week" | "Every other week" | "Twice per month" | "Monthly";
8107
+ frequency: "Every week" | "Every other week" | "Twice per month" | "Monthly";
7517
8108
  /** @description The first date that employees on this pay schedule are paid with Gusto. */
7518
- anchor_pay_date?: string;
8109
+ anchor_pay_date: string;
7519
8110
  /** @description The last date of the first pay period. This can be the same date as the anchor pay date. */
7520
- anchor_end_of_pay_period?: string;
8111
+ anchor_end_of_pay_period: string;
7521
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. */
7522
8113
  day_1?: number;
7523
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. */
@@ -7758,7 +8349,7 @@ declare interface operations {
7758
8349
  /** @description Include the requested attribute(s) in each employee response, multiple options are comma separated. Available options:
7759
8350
  * - all_compensations: Include all effective dated compensations for each job instead of only the current compensation
7760
8351
  * - custom_fields: Include employees' custom fields */
7761
- include?: "all_compensations" | "custom_fields";
8352
+ include?: ("all_compensations" | "custom_fields")[];
7762
8353
  /** @description The page that is requested. When unspecified, will load all objects unless endpoint forces pagination. */
7763
8354
  page?: components["parameters"]["pageParam"];
7764
8355
  /** @description Number of objects per page. For majority of endpoints will default to 25 */
@@ -7806,6 +8397,7 @@ declare interface operations {
7806
8397
  first_name: string;
7807
8398
  middle_initial?: string;
7808
8399
  last_name: string;
8400
+ preferred_first_name?: string;
7809
8401
  date_of_birth?: string;
7810
8402
  /** @description The employee's personal email address. */
7811
8403
  email?: string;
@@ -7821,6 +8413,55 @@ declare interface operations {
7821
8413
  422: components["responses"]["Unprocessable-Entity-Error-Object"];
7822
8414
  };
7823
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
+ };
7824
8465
  "get-companies-departments": {
7825
8466
  parameters: {
7826
8467
  query?: never;
@@ -8013,7 +8654,7 @@ declare interface operations {
8013
8654
  /** @description Include the requested attribute(s) in each employee response, multiple options are comma separated. Available options:
8014
8655
  * - all_compensations: Include all effective dated compensations for each job instead of only the current compensation
8015
8656
  * - custom_fields: Include employees' custom fields */
8016
- include?: "all_compensations" | "custom_fields";
8657
+ include?: ("all_compensations" | "custom_fields")[];
8017
8658
  };
8018
8659
  header?: {
8019
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. */
@@ -8053,6 +8694,7 @@ declare interface operations {
8053
8694
  first_name?: string;
8054
8695
  middle_initial?: string;
8055
8696
  last_name?: string;
8697
+ preferred_first_name?: string;
8056
8698
  date_of_birth?: string;
8057
8699
  /** @description The employee's personal email address. */
8058
8700
  email?: string;
@@ -8670,24 +9312,6 @@ declare interface operations {
8670
9312
  422: components["responses"]["Unprocessable-Entity-Error-Object"];
8671
9313
  };
8672
9314
  };
8673
- "put-v1-employee-finish-onboarding": {
8674
- parameters: {
8675
- query?: never;
8676
- header?: {
8677
- /** @description Determines the date-based API version associated with your API call. If none is provided, your application's [minimum API version](https://docs.gusto.com/embedded-payroll/docs/api-versioning#minimum-api-version) is used. */
8678
- "X-Gusto-API-Version"?: components["parameters"]["VersionHeader"];
8679
- };
8680
- path: {
8681
- /** @description The UUID of the employee */
8682
- employee_id: components["parameters"]["employee_id"];
8683
- };
8684
- cookie?: never;
8685
- };
8686
- requestBody?: never;
8687
- responses: {
8688
- 200: components["responses"]["Employee-Object"];
8689
- };
8690
- };
8691
9315
  "get-v1-employees-employee_id-federal_taxes": {
8692
9316
  parameters: {
8693
9317
  query?: never;
@@ -9470,7 +10094,7 @@ declare interface operations {
9470
10094
  };
9471
10095
  };
9472
10096
  responses: {
9473
- 201: components["responses"]["Contractor-Object"];
10097
+ 201: components["responses"]["Created-Contractor-Object"];
9474
10098
  404: components["responses"]["Not-Found-Error-Object"];
9475
10099
  422: components["responses"]["Unprocessable-Entity-Error-Object"];
9476
10100
  };
@@ -9831,6 +10455,131 @@ declare interface operations {
9831
10455
  404: components["responses"]["Not-Found-Error-Object"];
9832
10456
  };
9833
10457
  };
10458
+ "get-v1-contractor-documents": {
10459
+ parameters: {
10460
+ query?: never;
10461
+ header?: {
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. */
10463
+ "X-Gusto-API-Version"?: components["parameters"]["VersionHeader"];
10464
+ };
10465
+ path: {
10466
+ /** @description The UUID of the contractor */
10467
+ contractor_uuid: components["parameters"]["contractor_uuid"];
10468
+ };
10469
+ cookie?: never;
10470
+ };
10471
+ requestBody?: never;
10472
+ responses: {
10473
+ /** @description Example response */
10474
+ 200: {
10475
+ headers: {
10476
+ [name: string]: unknown;
10477
+ };
10478
+ content: {
10479
+ "application/json": components["schemas"]["Document"][];
10480
+ };
10481
+ };
10482
+ 404: components["responses"]["Not-Found-Error-Object"];
10483
+ };
10484
+ };
10485
+ "get-v1-contractor-document": {
10486
+ parameters: {
10487
+ query?: never;
10488
+ header?: {
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. */
10490
+ "X-Gusto-API-Version"?: components["parameters"]["VersionHeader"];
10491
+ };
10492
+ path: {
10493
+ /** @description The ID or UUID of the document */
10494
+ document_uuid: components["parameters"]["document_uuid"];
10495
+ };
10496
+ cookie?: never;
10497
+ };
10498
+ requestBody?: never;
10499
+ responses: {
10500
+ /** @description Example response */
10501
+ 200: {
10502
+ headers: {
10503
+ [name: string]: unknown;
10504
+ };
10505
+ content: {
10506
+ "application/json": components["schemas"]["Document"];
10507
+ };
10508
+ };
10509
+ 404: components["responses"]["Not-Found-Error-Object"];
10510
+ };
10511
+ };
10512
+ "get-v1-contractor-document-pdf": {
10513
+ parameters: {
10514
+ query?: never;
10515
+ header?: {
10516
+ /** @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. */
10517
+ "X-Gusto-API-Version"?: components["parameters"]["VersionHeader"];
10518
+ };
10519
+ path: {
10520
+ /** @description The ID or UUID of the document */
10521
+ document_uuid: components["parameters"]["document_uuid"];
10522
+ };
10523
+ cookie?: never;
10524
+ };
10525
+ requestBody?: never;
10526
+ responses: {
10527
+ /** @description Example response */
10528
+ 200: {
10529
+ headers: {
10530
+ [name: string]: unknown;
10531
+ };
10532
+ content: {
10533
+ "application/json": components["schemas"]["Document-Pdf"];
10534
+ };
10535
+ };
10536
+ 404: components["responses"]["Not-Found-Error-Object"];
10537
+ };
10538
+ };
10539
+ "put-v1-contractor-document-sign": {
10540
+ parameters: {
10541
+ query?: never;
10542
+ header?: {
10543
+ /** @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. */
10544
+ "X-Gusto-API-Version"?: components["parameters"]["VersionHeader"];
10545
+ };
10546
+ path: {
10547
+ /** @description The ID or UUID of the document */
10548
+ document_uuid: components["parameters"]["document_uuid"];
10549
+ };
10550
+ cookie?: never;
10551
+ };
10552
+ requestBody?: {
10553
+ content: {
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
+ };
9834
10583
  "post-v1-sandbox-generate_1099": {
9835
10584
  parameters: {
9836
10585
  query?: never;
@@ -10066,6 +10815,8 @@ declare interface operations {
10066
10815
  start_date?: string;
10067
10816
  /** @description Return payrolls whose pay period is before the end date. If left empty, defaults to today's date. */
10068
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"];
10069
10820
  };
10070
10821
  header?: {
10071
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. */
@@ -10162,7 +10913,7 @@ declare interface operations {
10162
10913
  parameters: {
10163
10914
  query?: {
10164
10915
  /** @description Include the requested attribute in the response, for multiple attributes comma separate the values, i.e. `?include=benefits,deductions,taxes` */
10165
- include?: "benefits" | "deductions" | "taxes" | "payroll_status_meta";
10916
+ include?: ("benefits" | "deductions" | "taxes" | "payroll_status_meta")[];
10166
10917
  };
10167
10918
  header?: {
10168
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. */
@@ -10220,7 +10971,7 @@ declare interface operations {
10220
10971
  /** @description The amount of the compensation for the pay period. */
10221
10972
  amount?: string;
10222
10973
  /** @description The UUID of the job for the compensation. */
10223
- job_uuid?: number;
10974
+ job_uuid?: string;
10224
10975
  }[];
10225
10976
  hourly_compensations?: {
10226
10977
  /** @description The name of the compensation. This also serves as the unique, immutable identifier for this compensation. */
@@ -10228,7 +10979,7 @@ declare interface operations {
10228
10979
  /** @description The number of hours to be compensated for this pay period. */
10229
10980
  hours?: string;
10230
10981
  /** @description The UUIDs of the job for the compensation. */
10231
- job_uuid?: number;
10982
+ job_uuid?: string;
10232
10983
  }[];
10233
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. */
10234
10985
  paid_time_off?: {
@@ -10684,7 +11435,7 @@ declare interface operations {
10684
11435
  contractor_uuid: string;
10685
11436
  /**
10686
11437
  * Format: date
10687
- * @description The contractor receiving the payment
11438
+ * @description Date of contractor payment
10688
11439
  * @example 2020-01-01
10689
11440
  */
10690
11441
  date: string;
@@ -11070,7 +11821,7 @@ declare interface operations {
11070
11821
  signature_text: string;
11071
11822
  /** @description whether you agree to sign electronically */
11072
11823
  agree: boolean;
11073
- /** @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. */
11074
11825
  signed_by_ip_address: string;
11075
11826
  };
11076
11827
  };
@@ -11164,7 +11915,7 @@ declare interface operations {
11164
11915
  signature_text: string;
11165
11916
  /** @description whether you agree to sign electronically */
11166
11917
  agree: boolean;
11167
- /** @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. */
11168
11919
  signed_by_ip_address: string;
11169
11920
  };
11170
11921
  };
@@ -11288,9 +12039,9 @@ declare interface operations {
11288
12039
  content: {
11289
12040
  "application/json": {
11290
12041
  /** @description Columns to include in the report */
11291
- columns: ("bank_account_account_number" | "bank_account_routing_number" | "bank_account_type" | "bank_account" | "bonus" | "cash_tips" | "check_amount" | "check_date" | "commission" | "date_of_birth" | "double_overtime_earnings" | "double_overtime_hours" | "double_overtime_rate" | "employee_additional_taxes" | "employee_compensation_time_period" | "employee_compensation" | "employee_deductions" | "employee_department" | "employee_email" | "employee_federal_income_tax" | "employee_first_name" | "employee_last_name" | "employee_middle_initial" | "employee_medicare_additional_tax" | "employee_medicare_tax" | "employee_phone_number" | "employee_social_security_tax" | "employee_taxes" | "employee_work_email" | "employer_additional_taxes" | "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")[];
11292
12043
  /** @description How to group the report */
11293
- groupings: ("payroll" | "employee" | "work_address")[];
12044
+ groupings: ("payroll" | "employee" | "work_address" | "work_address_state")[];
11294
12045
  /** @description The title of the report */
11295
12046
  custom_name?: string;
11296
12047
  /**
@@ -11442,7 +12193,7 @@ declare interface operations {
11442
12193
  * @default true
11443
12194
  */
11444
12195
  active?: boolean;
11445
- /** @description The description of the company benefit.For example, a company may offer multiple benefits with an ID of 1 (for Medical Insurance). The description would show something more specific like “Kaiser Permanente” or “Blue Cross/ Blue Shield”. */
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”. */
11446
12197
  description: string;
11447
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. */
11448
12199
  responsible_for_employer_taxes?: boolean;
@@ -11499,7 +12250,7 @@ declare interface operations {
11499
12250
  version: string;
11500
12251
  /** @description Whether this benefit is active for employee participation. Company benefits may only be deactivated if no employees are actively participating. */
11501
12252
  active?: boolean;
11502
- /** @description The description of the company benefit.For example, a company may offer multiple benefits with an ID of 1 (for Medical Insurance). The description would show something more specific like “Kaiser Permanente” or “Blue Cross/ Blue Shield”. */
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”. */
11503
12254
  description?: string;
11504
12255
  };
11505
12256
  };
@@ -11613,6 +12364,57 @@ declare interface operations {
11613
12364
  404: components["responses"]["Not-Found-Error-Object"];
11614
12365
  };
11615
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
+ };
11616
12418
  "get-v1-benefits-benefits_id-requirements": {
11617
12419
  parameters: {
11618
12420
  query?: never;
@@ -11990,9 +12792,14 @@ declare interface operations {
11990
12792
  */
11991
12793
  amount: string;
11992
12794
  /** @description The description of the garnishment. */
11993
- description: string;
12795
+ description?: string;
11994
12796
  /** @description Whether the garnishment is court ordered. */
11995
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;
11996
12803
  /**
11997
12804
  * @description The number of times to apply the garnishment. Ignored if recurring is true.
11998
12805
  * @default null
@@ -12020,6 +12827,12 @@ declare interface operations {
12020
12827
  * @default false
12021
12828
  */
12022
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"];
12023
12836
  };
12024
12837
  };
12025
12838
  };
@@ -12105,6 +12918,12 @@ declare interface operations {
12105
12918
  * @default false
12106
12919
  */
12107
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"];
12108
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. */
12109
12928
  version: string;
12110
12929
  };
@@ -12116,6 +12935,22 @@ declare interface operations {
12116
12935
  422: components["responses"]["Unprocessable-Entity-Error-Object"];
12117
12936
  };
12118
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
+ };
12119
12954
  "post-v1-plaid-processor_token": {
12120
12955
  parameters: {
12121
12956
  query?: never;
@@ -12383,18 +13218,18 @@ declare interface operations {
12383
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".
12384
13219
  */
12385
13220
  accrual_rate_unit?: string;
12386
- /** @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 */
12387
13222
  paid_out_on_termination?: boolean;
12388
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. */
12389
13224
  accrual_waiting_period_days?: number;
12390
13225
  /**
12391
13226
  * Format: float
12392
- * @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.
12393
13228
  */
12394
13229
  carryover_limit_hours?: string;
12395
13230
  /**
12396
13231
  * Format: float
12397
- * @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.
12398
13233
  */
12399
13234
  max_accrual_hours_per_year?: string;
12400
13235
  /**
@@ -12474,18 +13309,18 @@ declare interface operations {
12474
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".
12475
13310
  */
12476
13311
  accrual_rate_unit?: string;
12477
- /** @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 */
12478
13313
  paid_out_on_termination?: boolean;
12479
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. */
12480
13315
  accrual_waiting_period_days?: number;
12481
13316
  /**
12482
13317
  * Format: float
12483
- * @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.
12484
13319
  */
12485
13320
  carryover_limit_hours?: string;
12486
13321
  /**
12487
13322
  * Format: float
12488
- * @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.
12489
13324
  */
12490
13325
  max_accrual_hours_per_year?: string;
12491
13326
  /**
@@ -12919,7 +13754,7 @@ declare interface operations {
12919
13754
  "X-Gusto-API-Version"?: components["parameters"]["VersionHeader"];
12920
13755
  };
12921
13756
  path: {
12922
- /** @description The UUID of the notification */
13757
+ /** @description The notification entity_uuid */
12923
13758
  notification_uuid: components["parameters"]["notification_uuid"];
12924
13759
  };
12925
13760
  cookie?: never;
@@ -13192,10 +14027,16 @@ declare interface paths {
13192
14027
  * The company_admin:read scope is required to return primary_payroll_admin.
13193
14028
  * The signatories:read scope is required to return primary_signatory.
13194
14029
  *
13195
- * scope: `companies:read`
14030
+ * scope: `companies:read`
14031
+ */
14032
+ get: operations["get-v1-companies"];
14033
+ /**
14034
+ * Update a company
14035
+ * @description Update a company.
14036
+ *
14037
+ * scope: `companies:write`
13196
14038
  */
13197
- get: operations["get-v1-companies"];
13198
- put?: never;
14039
+ put: operations["put-v1-companies"];
13199
14040
  post?: never;
13200
14041
  delete?: never;
13201
14042
  options?: never;
@@ -13298,6 +14139,81 @@ declare interface paths {
13298
14139
  patch?: never;
13299
14140
  trace?: never;
13300
14141
  };
14142
+ "/v1/companies/{company_id}/attachments/{company_attachment_uuid}": {
14143
+ parameters: {
14144
+ query?: never;
14145
+ header?: never;
14146
+ path?: never;
14147
+ cookie?: never;
14148
+ };
14149
+ /**
14150
+ * Get Company Attachment Details
14151
+ * @description Retrieve the detail of an attachment uploaded by the company.
14152
+ *
14153
+ * scope: `company_attachments:read`
14154
+ */
14155
+ get: operations["get-v1-companies-attachment"];
14156
+ put?: never;
14157
+ post?: never;
14158
+ delete?: never;
14159
+ options?: never;
14160
+ head?: never;
14161
+ patch?: never;
14162
+ trace?: never;
14163
+ };
14164
+ "/v1/companies/{company_id}/attachments/{company_attachment_uuid}/download_url": {
14165
+ parameters: {
14166
+ query?: never;
14167
+ header?: never;
14168
+ path?: never;
14169
+ cookie?: never;
14170
+ };
14171
+ /**
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.
14175
+ *
14176
+ * scope: `company_attachments:read`
14177
+ */
14178
+ get: operations["get-v1-companies-attachment-url"];
14179
+ put?: never;
14180
+ post?: never;
14181
+ delete?: never;
14182
+ options?: never;
14183
+ head?: never;
14184
+ patch?: never;
14185
+ trace?: never;
14186
+ };
14187
+ "/v1/companies/{company_id}/attachments": {
14188
+ parameters: {
14189
+ query?: never;
14190
+ header?: never;
14191
+ path?: never;
14192
+ cookie?: never;
14193
+ };
14194
+ /**
14195
+ * Get List of Company Attachments
14196
+ * @description Retrieve a list of all the attachments uploaded by the company.
14197
+ *
14198
+ * scope: `company_attachments:read`
14199
+ */
14200
+ get: operations["get-v1-companies-attachments"];
14201
+ put?: never;
14202
+ /**
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.
14207
+ *
14208
+ * scope: `company_attachments:write`
14209
+ */
14210
+ post: operations["post-v1-companies-attachment"];
14211
+ delete?: never;
14212
+ options?: never;
14213
+ head?: never;
14214
+ patch?: never;
14215
+ trace?: never;
14216
+ };
13301
14217
  "/v1/companies/{company_id}/federal_tax_details": {
13302
14218
  parameters: {
13303
14219
  query?: never;
@@ -13498,7 +14414,7 @@ declare interface paths {
13498
14414
  * @description Finalize a given company's onboarding process.
13499
14415
  *
13500
14416
  * ### Approve a company in demo
13501
- * 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.
13502
14418
  * In production environments, this step is required for risk-analysis purposes.
13503
14419
  *
13504
14420
  * We provide the endpoint `PUT '/v1/companies/{company_uuid}/approve'` to facilitate company approvals in the demo environment.
@@ -14066,7 +14982,8 @@ declare interface paths {
14066
14982
  put?: never;
14067
14983
  /**
14068
14984
  * Assign pay schedules for a company
14069
- * @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).
14070
14987
  *
14071
14988
  * scope: `pay_schedules:write`
14072
14989
  */
@@ -14105,6 +15022,34 @@ declare interface paths {
14105
15022
  patch?: never;
14106
15023
  trace?: never;
14107
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
+ };
14108
15053
  "/v1/companies/{company_uuid}/departments": {
14109
15054
  parameters: {
14110
15055
  query?: never;
@@ -14604,28 +15549,6 @@ declare interface paths {
14604
15549
  patch?: never;
14605
15550
  trace?: never;
14606
15551
  };
14607
- "/v1/employees/{employee_id}/finish_onboarding": {
14608
- parameters: {
14609
- query?: never;
14610
- header?: never;
14611
- path?: never;
14612
- cookie?: never;
14613
- };
14614
- get?: never;
14615
- /**
14616
- * Finish onboarding an employee
14617
- * @description This endpoint is currently supported but will eventually be deprecated; please use `/v1/employees/{employee_id}/onboarding_status` instead.
14618
- *
14619
- * Call this endpoint as the very last step of employee onboarding to complete their onboarding. When successful, the employee's `onboarded` attribute will be updated to true, indicating that they can be included in company's payrolls.
14620
- */
14621
- put: operations["put-v1-employee-finish-onboarding"];
14622
- post?: never;
14623
- delete?: never;
14624
- options?: never;
14625
- head?: never;
14626
- patch?: never;
14627
- trace?: never;
14628
- };
14629
15552
  "/v1/employees/{employee_uuid}/federal_taxes": {
14630
15553
  parameters: {
14631
15554
  query?: never;
@@ -15305,6 +16228,94 @@ declare interface paths {
15305
16228
  patch?: never;
15306
16229
  trace?: never;
15307
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
+ };
15308
16319
  "/v1/sandbox/generate_1099": {
15309
16320
  parameters: {
15310
16321
  query?: never;
@@ -15447,7 +16458,7 @@ declare interface paths {
15447
16458
  * | Invite a contractor to self-onboard | `admin_onboarding_incomplete` or `self_onboarding_not_invited` | `self_onboarding_invited` |
15448
16459
  * | Cancel a contractor's self-onboarding | `self_onboarding_invited` or `self_onboarding_not_invited` | `admin_onboarding_incomplete` |
15449
16460
  * | Review a contractor's self-onboarded info | `self_onboarding_started` | `self_onboarding_review` |
15450
- * | 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` |
15451
16462
  */
15452
16463
  put: operations["put-v1-contractors-contractor_uuid-onboarding_status"];
15453
16464
  post?: never;
@@ -15511,9 +16522,12 @@ declare interface paths {
15511
16522
  * @description Creates a new, unprocessed, off-cycle payroll.
15512
16523
  *
15513
16524
  * ## `off_cycle_reason`
16525
+ * By default:
15514
16526
  * - External benefits and deductions will be included when the `off_cycle_reason` is set to `Correction`.
15515
16527
  * - All benefits and deductions are blocked when the `off_cycle_reason` is set to `Bonus`.
15516
16528
  *
16529
+ * These elections can be overridden with the `skip_regular_deductions` boolean.
16530
+ *
15517
16531
  * scope: `payrolls:run`
15518
16532
  */
15519
16533
  post: operations["post-v1-companies-company_id-payrolls"];
@@ -15561,7 +16575,6 @@ declare interface paths {
15561
16575
  * * Hours are represented to the thousands place; dollar amounts are represented to the cent.
15562
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 ).
15563
16577
  * * To return future payrolls, you must include an `end_date` in the future.
15564
- * * To return future payrolls, you must include an `end_date` in the future.
15565
16578
  * * When include parameter with benefits value is passed, employee_benefits:read scope is required to return benefits
15566
16579
  * * Benefits containing PHI are only visible with the `employee_benefits:read:phi` scope
15567
16580
  *
@@ -15840,6 +16853,8 @@ declare interface paths {
15840
16853
  * Submit payroll
15841
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.
15842
16855
  *
16856
+ * You should poll to ensure that payroll is processed successfully, as async errors only occur after async processing is complete.
16857
+ *
15843
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.
15844
16859
  *
15845
16860
  * scope: `payrolls:run`
@@ -15922,7 +16937,7 @@ declare interface paths {
15922
16937
  post?: never;
15923
16938
  /**
15924
16939
  * Cancel a contractor payment
15925
- * @description Cancels and deletes a contractor payment. If the contractor payment has already started processing, the payment cannot be cancelled.
16940
+ * @description Cancels and deletes a contractor payment. If the contractor payment has already started processing ("may_cancel": true), the payment cannot be cancelled.
15926
16941
  *
15927
16942
  * scope: `payrolls:run`
15928
16943
  */
@@ -16177,7 +17192,7 @@ declare interface paths {
16177
17192
  };
16178
17193
  /**
16179
17194
  * Get the employee form pdf
16180
- * @description Get the link to the form PDF
17195
+ * @description Get the link to the employee form PDF
16181
17196
  *
16182
17197
  * scope: `employee_forms:read`
16183
17198
  */
@@ -16515,6 +17530,42 @@ declare interface paths {
16515
17530
  patch?: never;
16516
17531
  trace?: never;
16517
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
+ };
16518
17569
  "/v1/benefits/{benefit_id}/requirements": {
16519
17570
  parameters: {
16520
17571
  query?: never;
@@ -16685,6 +17736,28 @@ declare interface paths {
16685
17736
  patch?: never;
16686
17737
  trace?: never;
16687
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
+ };
16688
17761
  "/v1/plaid/processor_token": {
16689
17762
  parameters: {
16690
17763
  query?: never;
@@ -17252,7 +18325,9 @@ declare interface paths {
17252
18325
  };
17253
18326
  }
17254
18327
 
17255
- 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;
17256
18331
 
17257
18332
  declare type PaymentMethodContextType = {
17258
18333
  bankAccounts: Schemas['Employee-Bank-Account'][];
@@ -17360,9 +18435,11 @@ declare interface PayrollTotalsConstructor {
17360
18435
  companyDebit?: number;
17361
18436
  }
17362
18437
 
17363
- declare function Profile(props: ProfileProps & BaseComponentInterface): JSX_2.Element;
18438
+ export declare function Profile(): JSX_2.Element;
18439
+
18440
+ declare function Profile_2(props: ProfileProps & BaseComponentInterface): JSX_2.Element;
17364
18441
 
17365
- declare namespace Profile {
18442
+ declare namespace Profile_2 {
17366
18443
  var Head: () => JSX_2.Element;
17367
18444
  var Actions: () => JSX_2.Element;
17368
18445
  var AdminPersonalDetails: () => JSX_2.Element | null;
@@ -17412,6 +18489,23 @@ declare type QueryParams<Path extends keyof paths> = _QueryParams<Path> extends
17412
18489
 
17413
18490
  declare type _QueryParams<Path extends keyof paths> = Parameters<ReturnType<typeof default_2<Pick<paths, Path>>>['GET']>['1'];
17414
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
+
17415
18509
  declare type Resources = CustomTypeOptions['resources'];
17416
18510
 
17417
18511
  declare type RGB = `rgb(${string})`
@@ -17425,6 +18519,10 @@ declare type Schemas = components["schemas"];
17425
18519
  /**Creating new i18next instance to avoid global clashing */
17426
18520
  export declare const SDKI18next: i18n;
17427
18521
 
18522
+ declare function SignatureForm(): JSX_2.Element | null;
18523
+
18524
+ declare function SignatureFormHead(): JSX_2.Element | null;
18525
+
17428
18526
  declare interface SummaryProps extends CommonComponentInterface {
17429
18527
  employeeId: string;
17430
18528
  flow?: OnboardingFlow;
@@ -17435,9 +18533,11 @@ declare interface SummaryProps_2 extends CommonComponentInterface {
17435
18533
  companyId: string;
17436
18534
  }
17437
18535
 
17438
- declare function Taxes(props: TaxesProps & BaseComponentInterface): JSX_2.Element;
18536
+ export declare function Taxes(): JSX_2.Element;
17439
18537
 
17440
- declare namespace Taxes {
18538
+ declare function Taxes_2(props: TaxesProps & BaseComponentInterface): JSX_2.Element;
18539
+
18540
+ declare namespace Taxes_2 {
17441
18541
  var FederalHead: FederalHead;
17442
18542
  var FederalForm: FederalForm;
17443
18543
  var StateForm: () => JSX_2.Element[];
@@ -17447,12 +18547,14 @@ declare namespace Taxes {
17447
18547
  declare type TaxesContextType = {
17448
18548
  employeeStateTaxes: Schemas['Employee-State-Tax'][];
17449
18549
  isPending: boolean;
18550
+ isAdmin: boolean;
17450
18551
  };
17451
18552
 
17452
18553
  declare const TaxesContextual: () => JSX_2.Element;
17453
18554
 
17454
18555
  declare interface TaxesProps extends CommonComponentInterface {
17455
18556
  employeeId: string;
18557
+ isAdmin?: boolean;
17456
18558
  }
17457
18559
 
17458
18560
  declare type ThemeColor = RGB | RGBA | HEX | HSL | HSLA | VAR | 'transparent'
@@ -17466,7 +18568,7 @@ export declare interface ThemeContextProps {
17466
18568
  export declare const ThemeProvider: default_3.FC<ThemeProviderProps>;
17467
18569
 
17468
18570
  export declare interface ThemeProviderProps {
17469
- theme?: GTheme;
18571
+ theme?: DeepPartial<GTheme>;
17470
18572
  children?: default_3.ReactNode;
17471
18573
  }
17472
18574
 
@@ -17504,6 +18606,8 @@ recurring: boolean;
17504
18606
  annual_maximum: string | null;
17505
18607
  pay_period_maximum: string | null;
17506
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"];
17507
18611
  }, Error, {
17508
18612
  employee_id: string;
17509
18613
  body: Parameters<(employee_id: string, body: BodyParams<"/v1/employees/{employee_id}/garnishments", "POST">) => Promise<{
@@ -17519,6 +18623,8 @@ recurring: boolean;
17519
18623
  annual_maximum: string | null;
17520
18624
  pay_period_maximum: string | null;
17521
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"];
17522
18628
  }>>[1];
17523
18629
  }, unknown>;
17524
18630
 
@@ -17654,11 +18760,11 @@ middle_initial?: string | null;
17654
18760
  last_name: string;
17655
18761
  email?: string | null;
17656
18762
  readonly company_uuid?: string;
17657
- readonly manager_uuid?: string;
18763
+ readonly manager_uuid?: string | null;
17658
18764
  readonly version?: string;
17659
18765
  readonly department?: string | null;
17660
18766
  readonly terminated?: boolean;
17661
- two_percent_shareholder?: boolean;
18767
+ two_percent_shareholder?: boolean | null;
17662
18768
  readonly onboarded?: boolean;
17663
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";
17664
18770
  jobs?: components["schemas"]["Job"][];
@@ -17669,8 +18775,8 @@ custom_fields?: components["schemas"]["Employee-Custom-Field"][];
17669
18775
  readonly date_of_birth?: string | null;
17670
18776
  has_ssn?: boolean;
17671
18777
  ssn?: string;
17672
- phone?: string;
17673
- preferred_first_name?: string;
18778
+ phone?: string | null;
18779
+ preferred_first_name?: string | null;
17674
18780
  payment_method: "Direct Deposit" | "Check";
17675
18781
  work_email?: string | null;
17676
18782
  readonly current_employment_status?: "full_time" | "part_time_under_twenty_hours" | "part_time_twenty_plus_hours" | "variable" | "seasonal" | null;
@@ -17683,11 +18789,11 @@ middle_initial?: string | null;
17683
18789
  last_name: string;
17684
18790
  email?: string | null;
17685
18791
  readonly company_uuid?: string;
17686
- readonly manager_uuid?: string;
18792
+ readonly manager_uuid?: string | null;
17687
18793
  readonly version?: string;
17688
18794
  readonly department?: string | null;
17689
18795
  readonly terminated?: boolean;
17690
- two_percent_shareholder?: boolean;
18796
+ two_percent_shareholder?: boolean | null;
17691
18797
  readonly onboarded?: boolean;
17692
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";
17693
18799
  jobs?: components["schemas"]["Job"][];
@@ -17698,8 +18804,8 @@ custom_fields?: components["schemas"]["Employee-Custom-Field"][];
17698
18804
  readonly date_of_birth?: string | null;
17699
18805
  has_ssn?: boolean;
17700
18806
  ssn?: string;
17701
- phone?: string;
17702
- preferred_first_name?: string;
18807
+ phone?: string | null;
18808
+ preferred_first_name?: string | null;
17703
18809
  payment_method: "Direct Deposit" | "Check";
17704
18810
  work_email?: string | null;
17705
18811
  readonly current_employment_status?: "full_time" | "part_time_under_twenty_hours" | "part_time_twenty_plus_hours" | "variable" | "seasonal" | null;
@@ -17863,13 +18969,27 @@ export declare function useDeleteEmployeeWorkAddress(employee_id: string, opts:
17863
18969
  onError: OnError;
17864
18970
  } & Omit<Parameters<typeof useMutation>[0], 'mutationFn' | 'onError'>): UseMutationResult<unknown, unknown, string, unknown>;
17865
18971
 
18972
+ declare const useDocumentSigner: () => DocumentSignerContextType;
18973
+
17866
18974
  declare const useEmployeeList: () => EmployeeListContextType;
17867
18975
 
17868
18976
  export declare function useFlow<C extends FlowContextInterface>(): C;
17869
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
+
17870
18989
  export declare function useGetCompany(company_id: string): UseSuspenseQueryResult< {
17871
18990
  readonly ein?: string;
17872
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;
17873
18993
  readonly tier?: "simple" | "plus" | "premium" | "core" | "complete" | "concierge" | "contractor_only" | "basic" | null;
17874
18994
  is_suspended?: boolean;
17875
18995
  readonly company_status?: "Approved" | "Not Approved" | "Suspended";
@@ -17878,7 +18998,7 @@ readonly name?: string;
17878
18998
  readonly slug?: string;
17879
18999
  readonly trade_name?: string;
17880
19000
  readonly is_partner_managed?: boolean;
17881
- readonly pay_schedule_type?: "single" | "hourly_salaried" | "by_employee" | "by_department";
19001
+ readonly pay_schedule_type?: "single" | "hourly_salaried" | "by_employee" | "by_department" | null;
17882
19002
  readonly join_date?: string;
17883
19003
  funding_type?: "ach" | "reverse_wire" | "wire_in" | "brex";
17884
19004
  readonly locations?: components["schemas"]["Company-Address"][];
@@ -18014,6 +19134,8 @@ export declare function useGetDeduction(garnishment_id: string): UseSuspenseQuer
18014
19134
  annual_maximum: string | null;
18015
19135
  pay_period_maximum: string | null;
18016
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"];
18017
19139
  }, Error>;
18018
19140
 
18019
19141
  export declare function useGetEmployee<T extends string | undefined>(employee_id: T): UseSuspenseQueryResult<InferResponse<T, Schemas["Employee"]>>;
@@ -18040,21 +19162,30 @@ export declare function useGetEmployeeDeductions(employee_id: string): UseSuspen
18040
19162
  annual_maximum: string | null;
18041
19163
  pay_period_maximum: string | null;
18042
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"];
18043
19167
  }[], Error>;
18044
19168
 
18045
19169
  export declare function useGetEmployeeFederalTaxes(employee_id: string): UseSuspenseQueryResult<{
18046
19170
  version?: string;
18047
19171
  filing_status?: string;
18048
- extra_withholding?: string;
18049
- two_jobs?: boolean;
18050
- dependents_amount?: string;
18051
- other_income?: string;
18052
- deductions?: 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;
18053
19177
  w4_data_type?: "pre_2020_w4" | "rev_2020_w4";
18054
19178
  federal_withholding_allowance?: number;
18055
19179
  additional_withholding?: boolean;
18056
19180
  }, Error>;
18057
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
+
18058
19189
  export declare function useGetEmployeeHomeAddress(home_address_uuid: string): UseSuspenseQueryResult<NonNullable<{
18059
19190
  version?: string;
18060
19191
  } & {
@@ -18147,11 +19278,11 @@ middle_initial?: string | null;
18147
19278
  last_name: string;
18148
19279
  email?: string | null;
18149
19280
  readonly company_uuid?: string;
18150
- readonly manager_uuid?: string;
19281
+ readonly manager_uuid?: string | null;
18151
19282
  readonly version?: string;
18152
19283
  readonly department?: string | null;
18153
19284
  readonly terminated?: boolean;
18154
- two_percent_shareholder?: boolean;
19285
+ two_percent_shareholder?: boolean | null;
18155
19286
  readonly onboarded?: boolean;
18156
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";
18157
19288
  jobs?: components["schemas"]["Job"][];
@@ -18162,8 +19293,8 @@ custom_fields?: components["schemas"]["Employee-Custom-Field"][];
18162
19293
  readonly date_of_birth?: string | null;
18163
19294
  has_ssn?: boolean;
18164
19295
  ssn?: string;
18165
- phone?: string;
18166
- preferred_first_name?: string;
19296
+ phone?: string | null;
19297
+ preferred_first_name?: string | null;
18167
19298
  payment_method: "Direct Deposit" | "Check";
18168
19299
  work_email?: string | null;
18169
19300
  readonly current_employment_status?: "full_time" | "part_time_under_twenty_hours" | "part_time_twenty_plus_hours" | "variable" | "seasonal" | null;
@@ -18234,6 +19365,7 @@ payroll_uuid: components["schemas"]["Payroll-Payroll-Uuid-Type"];
18234
19365
  company_uuid: components["schemas"]["Payroll-Company-Uuid-Type"];
18235
19366
  off_cycle?: components["schemas"]["Payroll-Off-Cycle-Type"];
18236
19367
  off_cycle_reason?: components["schemas"]["Off-Cycle-Reason-Type"];
19368
+ auto_pilot?: components["schemas"]["Auto-Pilot-Type"];
18237
19369
  external?: components["schemas"]["Payroll-External-Type"];
18238
19370
  final_termination_payroll?: components["schemas"]["Payroll-Final-Termination-Payroll-Type"];
18239
19371
  withholding_pay_period?: components["schemas"]["Payroll-Withholding-Pay-Period-Type"];
@@ -18270,6 +19402,29 @@ declare type UsePaySchedulePreviewParams = Operations['get-v1-companies-company_
18270
19402
 
18271
19403
  declare const useProfile: () => ProfileContextType;
18272
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
+
18273
19428
  declare const useTaxes: () => TaxesContextType;
18274
19429
 
18275
19430
  export declare const useTheme: () => ThemeContextProps;
@@ -18350,7 +19505,7 @@ cookie?: never;
18350
19505
  requestBody?: {
18351
19506
  content: {
18352
19507
  "application/json": {
18353
- title: string;
19508
+ title?: string;
18354
19509
  naics_code: string;
18355
19510
  sic_codes?: string[];
18356
19511
  };
@@ -18368,7 +19523,7 @@ company_id: string;
18368
19523
  };
18369
19524
  };
18370
19525
  body: {
18371
- title: string;
19526
+ title?: string;
18372
19527
  naics_code: string;
18373
19528
  sic_codes?: string[];
18374
19529
  } | undefined;
@@ -18459,6 +19614,8 @@ recurring: boolean;
18459
19614
  annual_maximum: string | null;
18460
19615
  pay_period_maximum: string | null;
18461
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"];
18462
19619
  }, Error, {
18463
19620
  garnishment_id: string;
18464
19621
  body: Parameters<(garnishment_id: string, body: BodyParams<"/v1/garnishments/{garnishment_id}", "PUT">) => Promise<{
@@ -18474,6 +19631,8 @@ recurring: boolean;
18474
19631
  annual_maximum: string | null;
18475
19632
  pay_period_maximum: string | null;
18476
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"];
18477
19636
  }>>[1];
18478
19637
  }, unknown>;
18479
19638
 
@@ -18484,11 +19643,11 @@ middle_initial?: string | null;
18484
19643
  last_name: string;
18485
19644
  email?: string | null;
18486
19645
  readonly company_uuid?: string;
18487
- readonly manager_uuid?: string;
19646
+ readonly manager_uuid?: string | null;
18488
19647
  readonly version?: string;
18489
19648
  readonly department?: string | null;
18490
19649
  readonly terminated?: boolean;
18491
- two_percent_shareholder?: boolean;
19650
+ two_percent_shareholder?: boolean | null;
18492
19651
  readonly onboarded?: boolean;
18493
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";
18494
19653
  jobs?: components["schemas"]["Job"][];
@@ -18499,8 +19658,8 @@ custom_fields?: components["schemas"]["Employee-Custom-Field"][];
18499
19658
  readonly date_of_birth?: string | null;
18500
19659
  has_ssn?: boolean;
18501
19660
  ssn?: string;
18502
- phone?: string;
18503
- preferred_first_name?: string;
19661
+ phone?: string | null;
19662
+ preferred_first_name?: string | null;
18504
19663
  payment_method: "Direct Deposit" | "Check";
18505
19664
  work_email?: string | null;
18506
19665
  readonly current_employment_status?: "full_time" | "part_time_under_twenty_hours" | "part_time_twenty_plus_hours" | "variable" | "seasonal" | null;
@@ -18513,11 +19672,11 @@ middle_initial?: string | null;
18513
19672
  last_name: string;
18514
19673
  email?: string | null;
18515
19674
  readonly company_uuid?: string;
18516
- readonly manager_uuid?: string;
19675
+ readonly manager_uuid?: string | null;
18517
19676
  readonly version?: string;
18518
19677
  readonly department?: string | null;
18519
19678
  readonly terminated?: boolean;
18520
- two_percent_shareholder?: boolean;
19679
+ two_percent_shareholder?: boolean | null;
18521
19680
  readonly onboarded?: boolean;
18522
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";
18523
19682
  jobs?: components["schemas"]["Job"][];
@@ -18528,8 +19687,8 @@ custom_fields?: components["schemas"]["Employee-Custom-Field"][];
18528
19687
  readonly date_of_birth?: string | null;
18529
19688
  has_ssn?: boolean;
18530
19689
  ssn?: string;
18531
- phone?: string;
18532
- preferred_first_name?: string;
19690
+ phone?: string | null;
19691
+ preferred_first_name?: string | null;
18533
19692
  payment_method: "Direct Deposit" | "Check";
18534
19693
  work_email?: string | null;
18535
19694
  readonly current_employment_status?: "full_time" | "part_time_under_twenty_hours" | "part_time_twenty_plus_hours" | "variable" | "seasonal" | null;
@@ -18618,11 +19777,11 @@ uuid?: string;
18618
19777
  export declare function useUpdateEmployeeFederalTaxes(employeeId: string, opts?: Omit<Parameters<typeof useMutation>[0], 'mutationFn'>): UseMutationResult< {
18619
19778
  version?: string;
18620
19779
  filing_status?: string;
18621
- extra_withholding?: string;
18622
- two_jobs?: boolean;
18623
- dependents_amount?: string;
18624
- other_income?: string;
18625
- 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;
18626
19785
  w4_data_type?: "pre_2020_w4" | "rev_2020_w4";
18627
19786
  federal_withholding_allowance?: number;
18628
19787
  additional_withholding?: boolean;
@@ -18630,11 +19789,11 @@ additional_withholding?: boolean;
18630
19789
  body: Parameters<(employee_uuid: string, body: BodyParams<"/v1/employees/{employee_uuid}/federal_taxes", "PUT">) => Promise<{
18631
19790
  version?: string;
18632
19791
  filing_status?: string;
18633
- extra_withholding?: string;
18634
- two_jobs?: boolean;
18635
- dependents_amount?: string;
18636
- other_income?: string;
18637
- 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;
18638
19797
  w4_data_type?: "pre_2020_w4" | "rev_2020_w4";
18639
19798
  federal_withholding_allowance?: number;
18640
19799
  additional_withholding?: boolean;
@@ -18953,6 +20112,26 @@ export interface EmployeeDeductions{
18953
20112
  "amount":string;
18954
20113
  }
18955
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
+ };
18956
20135
  export interface EmployeeEmployeeList{
18957
20136
  "actionLabel":string;
18958
20137
  "addEmployeeCTA":string;
@@ -19228,6 +20407,10 @@ export interface common{
19228
20407
  "deductionsTitle":string;
19229
20408
  "summaryTitle":string;
19230
20409
  }
20410
+ "employeeSelfOnboarding":{
20411
+ "profileTitle":string;
20412
+ "documentSignerTitle":string;
20413
+ }
19231
20414
  }
19232
20415
  "labels":{
19233
20416
  "draggableLabel":string;
@@ -19314,7 +20497,7 @@ export interface common{
19314
20497
 
19315
20498
  interface CustomTypeOptions {
19316
20499
  defaultNS: 'common';
19317
- resources: { 'Company.AddBank': CompanyAddBank, 'Company.Addresses': CompanyAddresses, 'Company.FederalTaxes': CompanyFederalTaxes, 'Company.Industry': CompanyIndustry, 'Employee.BankAccount': EmployeeBankAccount, 'Employee.Compensation': EmployeeCompensation, 'Employee.Deductions': EmployeeDeductions, 'Employee.EmployeeList': EmployeeEmployeeList, 'Employee.HomeAddress': EmployeeHomeAddress, 'Employee.Landing': EmployeeLanding, 'Employee.OnboardingSummary': EmployeeOnboardingSummary, 'Employee.PaySchedules': EmployeePaySchedules, 'Employee.PaymentMethod': EmployeePaymentMethod, 'Employee.Profile': EmployeeProfile, 'Employee.SplitPaycheck': EmployeeSplitPaycheck, 'Employee.StateTaxes': EmployeeStateTaxes, 'Employee.Taxes': EmployeeTaxes, 'Payroll.PayrollHistoryList': PayrollPayrollHistoryList, 'Payroll.PayrollSchedule': PayrollPayrollSchedule, 'common': common, }
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, }
19318
20501
  };
19319
20502
  }
19320
20503
  declare module 'robot3' {