From 02d1134df7175056e65f787ef4e1443772bbd8ed Mon Sep 17 00:00:00 2001
From: Jeff Johnson
Date: Fri, 27 Mar 2026 14:04:02 -0700
Subject: [PATCH 1/3] docs: add Docusaurus website and migrate documentation
Set up Docusaurus site with API reference docs generated from OpenAPI spec,
update existing markdown docs for Docusaurus compatibility, and add website
configuration with custom theming and sidebar structure.
Made-with: Cursor
---
docs/api/ach-transactions.tag.mdx | 20 +
docs/api/bank-accounts.tag.mdx | 20 +
docs/api/companies.tag.mdx | 20 +
docs/api/company-attachment.tag.mdx | 20 +
docs/api/company-benefits.tag.mdx | 20 +
docs/api/company-forms.tag.mdx | 20 +
docs/api/contractor-documents.tag.mdx | 20 +
docs/api/contractor-forms.tag.mdx | 20 +
docs/api/contractor-payment-groups.tag.mdx | 20 +
docs/api/contractor-payment-method.tag.mdx | 20 +
docs/api/contractor-payments.tag.mdx | 20 +
docs/api/contractors.tag.mdx | 20 +
docs/api/delete-department.ParamsDetails.json | 1 +
docs/api/delete-department.RequestSchema.json | 1 +
docs/api/delete-department.StatusCodes.json | 1 +
docs/api/delete-department.api.mdx | 72 +
...ccounts-bank-account-id.ParamsDetails.json | 1 +
...ccounts-bank-account-id.RequestSchema.json | 1 +
...-accounts-bank-account-id.StatusCodes.json | 1 +
...y-id-bank-accounts-bank-account-id.api.mdx | 73 +
...ment-contractor-payment.ParamsDetails.json | 1 +
...ment-contractor-payment.RequestSchema.json | 1 +
...ayment-contractor-payment.StatusCodes.json | 1 +
...tractor-payment-contractor-payment.api.mdx | 71 +
...types-earning-type-uuid.ParamsDetails.json | 1 +
...types-earning-type-uuid.RequestSchema.json | 1 +
...g-types-earning-type-uuid.StatusCodes.json | 1 +
...id-earning-types-earning-type-uuid.api.mdx | 71 +
...ies-company-id-payrolls.ParamsDetails.json | 1 +
...ies-company-id-payrolls.RequestSchema.json | 1 +
...anies-company-id-payrolls.StatusCodes.json | 1 +
...-v-1-companies-company-id-payrolls.api.mdx | 73 +
...uuid-holiday-pay-policy.ParamsDetails.json | 1 +
...uuid-holiday-pay-policy.RequestSchema.json | 1 +
...y-uuid-holiday-pay-policy.StatusCodes.json | 1 +
...es-company-uuid-holiday-pay-policy.api.mdx | 71 +
...natories-signatory-uuid.ParamsDetails.json | 1 +
...natories-signatory-uuid.RequestSchema.json | 1 +
...ignatories-signatory-uuid.StatusCodes.json | 1 +
...ny-uuid-signatories-signatory-uuid.api.mdx | 74 +
...fits-company-benefit-id.ParamsDetails.json | 1 +
...fits-company-benefit-id.RequestSchema.json | 1 +
...nefits-company-benefit-id.StatusCodes.json | 1 +
...ompany-benefits-company-benefit-id.api.mdx | 76 +
...sations-compensation-id.ParamsDetails.json | 1 +
...sations-compensation-id.RequestSchema.json | 1 +
...ensations-compensation-id.StatusCodes.json | 1 +
...-v-1-compensations-compensation-id.api.mdx | 74 +
...ractor-payment-group-id.ParamsDetails.json | 1 +
...ractor-payment-group-id.RequestSchema.json | 1 +
...ntractor-payment-group-id.StatusCodes.json | 1 +
...groups-contractor-payment-group-id.api.mdx | 71 +
...ractors-contractor-uuid.ParamsDetails.json | 1 +
...ractors-contractor-uuid.RequestSchema.json | 1 +
...ntractors-contractor-uuid.StatusCodes.json | 1 +
...te-v-1-contractors-contractor-uuid.api.mdx | 71 +
...its-employee-benefit-id.ParamsDetails.json | 1 +
...its-employee-benefit-id.RequestSchema.json | 1 +
...efits-employee-benefit-id.StatusCodes.json | 1 +
...loyee-benefits-employee-benefit-id.api.mdx | 73 +
.../delete-v-1-employee.ParamsDetails.json | 1 +
.../delete-v-1-employee.RequestSchema.json | 1 +
docs/api/delete-v-1-employee.StatusCodes.json | 1 +
docs/api/delete-v-1-employee.api.mdx | 73 +
...ccounts-bank-account-id.ParamsDetails.json | 1 +
...ccounts-bank-account-id.RequestSchema.json | 1 +
...-accounts-bank-account-id.StatusCodes.json | 1 +
...e-id-bank-accounts-bank-account-id.api.mdx | 72 +
...n-documents-document-id.ParamsDetails.json | 1 +
...n-documents-document-id.RequestSchema.json | 1 +
...ion-documents-document-id.StatusCodes.json | 1 +
...uthorization-documents-document-id.api.mdx | 71 +
...yees-employee-id-rehire.ParamsDetails.json | 1 +
...yees-employee-id-rehire.RequestSchema.json | 1 +
...loyees-employee-id-rehire.StatusCodes.json | 1 +
...e-v-1-employees-employee-id-rehire.api.mdx | 71 +
...mployee-id-terminations.ParamsDetails.json | 1 +
...mployee-id-terminations.RequestSchema.json | 1 +
...-employee-id-terminations.StatusCodes.json | 1 +
...employees-employee-id-terminations.api.mdx | 71 +
...te-v-1-external-payroll.ParamsDetails.json | 1 +
...te-v-1-external-payroll.RequestSchema.json | 1 +
...lete-v-1-external-payroll.StatusCodes.json | 1 +
docs/api/delete-v-1-external-payroll.api.mdx | 71 +
...esses-home-address-uuid.ParamsDetails.json | 1 +
...esses-home-address-uuid.RequestSchema.json | 1 +
...dresses-home-address-uuid.StatusCodes.json | 1 +
...1-home-addresses-home-address-uuid.api.mdx | 71 +
.../delete-v-1-jobs-job-id.ParamsDetails.json | 1 +
.../delete-v-1-jobs-job-id.RequestSchema.json | 1 +
.../delete-v-1-jobs-job-id.StatusCodes.json | 1 +
docs/api/delete-v-1-jobs-job-id.api.mdx | 71 +
...ecurring-reimbursements.ParamsDetails.json | 1 +
...ecurring-reimbursements.RequestSchema.json | 1 +
...-recurring-reimbursements.StatusCodes.json | 1 +
...elete-v-1-recurring-reimbursements.api.mdx | 71 +
...bhook-subscription-uuid.ParamsDetails.json | 1 +
...bhook-subscription-uuid.RequestSchema.json | 1 +
...webhook-subscription-uuid.StatusCodes.json | 1 +
...lete-v-1-webhook-subscription-uuid.api.mdx | 76 +
...esses-work-address-uuid.ParamsDetails.json | 1 +
...esses-work-address-uuid.RequestSchema.json | 1 +
...dresses-work-address-uuid.StatusCodes.json | 1 +
...1-work-addresses-work-address-uuid.api.mdx | 71 +
docs/api/departments.tag.mdx | 20 +
docs/api/earning-types.tag.mdx | 20 +
docs/api/employee-addresses.tag.mdx | 20 +
docs/api/employee-benefits.tag.mdx | 20 +
docs/api/employee-employments.tag.mdx | 20 +
docs/api/employee-forms.tag.mdx | 20 +
docs/api/employee-payment-method.tag.mdx | 20 +
docs/api/employee-tax-setup.tag.mdx | 20 +
docs/api/employees.tag.mdx | 20 +
docs/api/events.tag.mdx | 20 +
docs/api/external-payrolls.tag.mdx | 20 +
docs/api/federal-tax-details.tag.mdx | 20 +
docs/api/flows.tag.mdx | 20 +
docs/api/garnishments.tag.mdx | 20 +
docs/api/generated-documents.tag.mdx | 20 +
.../get-ach-transactions.ParamsDetails.json | 1 +
.../get-ach-transactions.RequestSchema.json | 1 +
.../api/get-ach-transactions.StatusCodes.json | 1 +
docs/api/get-ach-transactions.api.mdx | 71 +
...ractor-payments-preview.ParamsDetails.json | 1 +
...ractor-payments-preview.RequestSchema.json | 1 +
...ntractor-payments-preview.StatusCodes.json | 1 +
...y-uuid-contractor-payments-preview.api.mdx | 73 +
...pany-uuid-paid-holidays.ParamsDetails.json | 1 +
...pany-uuid-paid-holidays.RequestSchema.json | 1 +
...ompany-uuid-paid-holidays.StatusCodes.json | 1 +
...mpanies-company-uuid-paid-holidays.api.mdx | 71 +
...t-templates-report-type.ParamsDetails.json | 1 +
...t-templates-report-type.RequestSchema.json | 1 +
...ort-templates-report-type.StatusCodes.json | 1 +
...-uuid-report-templates-report-type.api.mdx | 71 +
...ompany-uuid-suspensions.ParamsDetails.json | 1 +
...ompany-uuid-suspensions.RequestSchema.json | 1 +
...-company-uuid-suspensions.StatusCodes.json | 1 +
...companies-company-uuid-suspensions.api.mdx | 75 +
...id-wire-in-request-uuid.ParamsDetails.json | 1 +
...id-wire-in-request-uuid.RequestSchema.json | 1 +
...uuid-wire-in-request-uuid.StatusCodes.json | 1 +
...-company-uuid-wire-in-request-uuid.api.mdx | 71 +
...t-companies-departments.ParamsDetails.json | 1 +
...t-companies-departments.RequestSchema.json | 1 +
...get-companies-departments.StatusCodes.json | 1 +
docs/api/get-companies-departments.api.mdx | 71 +
...t-company-notifications.ParamsDetails.json | 1 +
...t-company-notifications.RequestSchema.json | 1 +
...get-company-notifications.StatusCodes.json | 1 +
docs/api/get-company-notifications.api.mdx | 71 +
docs/api/get-department.ParamsDetails.json | 1 +
docs/api/get-department.RequestSchema.json | 1 +
docs/api/get-department.StatusCodes.json | 1 +
docs/api/get-department.api.mdx | 72 +
...-from-different-company.ParamsDetails.json | 1 +
...-from-different-company.RequestSchema.json | 1 +
...ts-from-different-company.StatusCodes.json | 1 +
...fit-amounts-from-different-company.api.mdx | 74 +
docs/api/get-events.ParamsDetails.json | 1 +
docs/api/get-events.RequestSchema.json | 1 +
docs/api/get-events.StatusCodes.json | 1 +
docs/api/get-events.api.mdx | 75 +
...et-information-requests.ParamsDetails.json | 1 +
...et-information-requests.RequestSchema.json | 1 +
.../get-information-requests.StatusCodes.json | 1 +
docs/api/get-information-requests.api.mdx | 71 +
...invoices-invoice-period.ParamsDetails.json | 1 +
...invoices-invoice-period.RequestSchema.json | 1 +
...t-invoices-invoice-period.StatusCodes.json | 1 +
docs/api/get-invoices-invoice-period.api.mdx | 75 +
...tions-notification-uuid.ParamsDetails.json | 1 +
...tions-notification-uuid.RequestSchema.json | 1 +
...cations-notification-uuid.StatusCodes.json | 1 +
...et-notifications-notification-uuid.api.mdx | 75 +
.../api/get-recovery-cases.ParamsDetails.json | 1 +
.../api/get-recovery-cases.RequestSchema.json | 1 +
docs/api/get-recovery-cases.StatusCodes.json | 1 +
docs/api/get-recovery-cases.api.mdx | 71 +
...et-reports-request-uuid.ParamsDetails.json | 1 +
...et-reports-request-uuid.RequestSchema.json | 1 +
.../get-reports-request-uuid.StatusCodes.json | 1 +
docs/api/get-reports-request-uuid.api.mdx | 73 +
...v-1-benefits-benefit-id.ParamsDetails.json | 1 +
...v-1-benefits-benefit-id.RequestSchema.json | 1 +
...t-v-1-benefits-benefit-id.StatusCodes.json | 1 +
docs/api/get-v-1-benefits-benefit-id.api.mdx | 73 +
...enefits-id-requirements.ParamsDetails.json | 1 +
...enefits-id-requirements.RequestSchema.json | 1 +
...-benefits-id-requirements.StatusCodes.json | 1 +
...-benefits-benefits-id-requirements.api.mdx | 71 +
...pany-benefit-id-summary.ParamsDetails.json | 1 +
...pany-benefit-id-summary.RequestSchema.json | 1 +
...ompany-benefit-id-summary.StatusCodes.json | 1 +
...enefits-company-benefit-id-summary.api.mdx | 73 +
docs/api/get-v-1-benefits.ParamsDetails.json | 1 +
docs/api/get-v-1-benefits.RequestSchema.json | 1 +
docs/api/get-v-1-benefits.StatusCodes.json | 1 +
docs/api/get-v-1-benefits.api.mdx | 73 +
...ompanies-attachment-url.ParamsDetails.json | 1 +
...ompanies-attachment-url.RequestSchema.json | 1 +
...-companies-attachment-url.StatusCodes.json | 1 +
.../get-v-1-companies-attachment-url.api.mdx | 72 +
...-1-companies-attachment.ParamsDetails.json | 1 +
...-1-companies-attachment.RequestSchema.json | 1 +
...-v-1-companies-attachment.StatusCodes.json | 1 +
docs/api/get-v-1-companies-attachment.api.mdx | 71 +
...1-companies-attachments.ParamsDetails.json | 1 +
...1-companies-attachments.RequestSchema.json | 1 +
...v-1-companies-attachments.StatusCodes.json | 1 +
.../api/get-v-1-companies-attachments.api.mdx | 71 +
...anies-company-id-admins.ParamsDetails.json | 1 +
...anies-company-id-admins.RequestSchema.json | 1 +
...mpanies-company-id-admins.StatusCodes.json | 1 +
...et-v-1-companies-company-id-admins.api.mdx | 71 +
...ompany-id-bank-accounts.ParamsDetails.json | 1 +
...ompany-id-bank-accounts.RequestSchema.json | 1 +
...-company-id-bank-accounts.StatusCodes.json | 1 +
...companies-company-id-bank-accounts.api.mdx | 71 +
...any-id-company-benefits.ParamsDetails.json | 1 +
...any-id-company-benefits.RequestSchema.json | 1 +
...mpany-id-company-benefits.StatusCodes.json | 1 +
...panies-company-id-company-benefits.api.mdx | 75 +
...ment-contractor-payment.ParamsDetails.json | 1 +
...ment-contractor-payment.RequestSchema.json | 1 +
...ayment-contractor-payment.StatusCodes.json | 1 +
...tractor-payment-contractor-payment.api.mdx | 71 +
...ntractor-payment-groups.ParamsDetails.json | 1 +
...ntractor-payment-groups.RequestSchema.json | 1 +
...contractor-payment-groups.StatusCodes.json | 1 +
...mpany-id-contractor-payment-groups.api.mdx | 71 +
...-id-contractor-payments.ParamsDetails.json | 1 +
...-id-contractor-payments.RequestSchema.json | 1 +
...ny-id-contractor-payments.StatusCodes.json | 1 +
...ies-company-id-contractor-payments.api.mdx | 71 +
...ractors-payment-details.ParamsDetails.json | 1 +
...ractors-payment-details.RequestSchema.json | 1 +
...ntractors-payment-details.StatusCodes.json | 1 +
...any-id-contractors-payment-details.api.mdx | 95 +
...ompany-id-custom-fields.ParamsDetails.json | 1 +
...ompany-id-custom-fields.RequestSchema.json | 1 +
...-company-id-custom-fields.StatusCodes.json | 1 +
...companies-company-id-custom-fields.api.mdx | 71 +
...ompany-id-earning-types.ParamsDetails.json | 1 +
...ompany-id-earning-types.RequestSchema.json | 1 +
...-company-id-earning-types.StatusCodes.json | 1 +
...companies-company-id-earning-types.api.mdx | 77 +
...ployees-payment-details.ParamsDetails.json | 1 +
...ployees-payment-details.RequestSchema.json | 1 +
...employees-payment-details.StatusCodes.json | 1 +
...mpany-id-employees-payment-details.api.mdx | 78 +
...es-company-id-employees.ParamsDetails.json | 1 +
...es-company-id-employees.RequestSchema.json | 1 +
...nies-company-id-employees.StatusCodes.json | 1 +
...v-1-companies-company-id-employees.api.mdx | 73 +
...-id-federal-tax-details.ParamsDetails.json | 1 +
...-id-federal-tax-details.RequestSchema.json | 1 +
...ny-id-federal-tax-details.StatusCodes.json | 1 +
...ies-company-id-federal-tax-details.api.mdx | 71 +
...es-company-id-locations.ParamsDetails.json | 1 +
...es-company-id-locations.RequestSchema.json | 1 +
...nies-company-id-locations.StatusCodes.json | 1 +
...v-1-companies-company-id-locations.api.mdx | 75 +
...-company-id-pay-periods.ParamsDetails.json | 1 +
...-company-id-pay-periods.RequestSchema.json | 1 +
...es-company-id-pay-periods.StatusCodes.json | 1 +
...1-companies-company-id-pay-periods.api.mdx | 77 +
...y-schedules-assignments.ParamsDetails.json | 1 +
...y-schedules-assignments.RequestSchema.json | 1 +
...pay-schedules-assignments.StatusCodes.json | 1 +
...mpany-id-pay-schedules-assignments.api.mdx | 71 +
...hedules-pay-schedule-id.ParamsDetails.json | 1 +
...hedules-pay-schedule-id.RequestSchema.json | 1 +
...schedules-pay-schedule-id.StatusCodes.json | 1 +
...y-id-pay-schedules-pay-schedule-id.api.mdx | 71 +
...d-pay-schedules-preview.ParamsDetails.json | 1 +
...d-pay-schedules-preview.RequestSchema.json | 1 +
...-id-pay-schedules-preview.StatusCodes.json | 1 +
...s-company-id-pay-schedules-preview.api.mdx | 71 +
...ompany-id-pay-schedules.ParamsDetails.json | 1 +
...ompany-id-pay-schedules.RequestSchema.json | 1 +
...-company-id-pay-schedules.StatusCodes.json | 1 +
...companies-company-id-pay-schedules.api.mdx | 71 +
...ny-id-payroll-reversals.ParamsDetails.json | 1 +
...ny-id-payroll-reversals.RequestSchema.json | 1 +
...pany-id-payroll-reversals.StatusCodes.json | 1 +
...anies-company-id-payroll-reversals.api.mdx | 71 +
...d-partner-disbursements.ParamsDetails.json | 1 +
...d-partner-disbursements.RequestSchema.json | 1 +
...-id-partner-disbursements.StatusCodes.json | 1 +
...-payrolls-id-partner-disbursements.api.mdx | 71 +
...-id-payrolls-payroll-id.ParamsDetails.json | 1 +
...-id-payrolls-payroll-id.RequestSchema.json | 1 +
...ny-id-payrolls-payroll-id.StatusCodes.json | 1 +
...ies-company-id-payrolls-payroll-id.api.mdx | 79 +
...ies-company-id-payrolls.ParamsDetails.json | 1 +
...ies-company-id-payrolls.RequestSchema.json | 1 +
...anies-company-id-payrolls.StatusCodes.json | 1 +
...-v-1-companies-company-id-payrolls.api.mdx | 77 +
...termination-pay-periods.ParamsDetails.json | 1 +
...termination-pay-periods.RequestSchema.json | 1 +
...d-termination-pay-periods.StatusCodes.json | 1 +
...nprocessed-termination-pay-periods.api.mdx | 73 +
...ompany-uuid-contractors.ParamsDetails.json | 1 +
...ompany-uuid-contractors.RequestSchema.json | 1 +
...-company-uuid-contractors.StatusCodes.json | 1 +
...companies-company-uuid-contractors.api.mdx | 71 +
...uuid-holiday-pay-policy.ParamsDetails.json | 1 +
...uuid-holiday-pay-policy.RequestSchema.json | 1 +
...y-uuid-holiday-pay-policy.StatusCodes.json | 1 +
...es-company-uuid-holiday-pay-policy.api.mdx | 71 +
...ompany-uuid-signatories.ParamsDetails.json | 1 +
...ompany-uuid-signatories.RequestSchema.json | 1 +
...-company-uuid-signatories.StatusCodes.json | 1 +
...companies-company-uuid-signatories.api.mdx | 74 +
...-tax-requirements-state.ParamsDetails.json | 1 +
...-tax-requirements-state.RequestSchema.json | 1 +
...id-tax-requirements-state.StatusCodes.json | 1 +
...ompany-uuid-tax-requirements-state.api.mdx | 111 +
...y-uuid-tax-requirements.ParamsDetails.json | 1 +
...y-uuid-tax-requirements.RequestSchema.json | 1 +
...any-uuid-tax-requirements.StatusCodes.json | 1 +
...nies-company-uuid-tax-requirements.api.mdx | 71 +
...-uuid-time-off-policies.ParamsDetails.json | 1 +
...-uuid-time-off-policies.RequestSchema.json | 1 +
...ny-uuid-time-off-policies.StatusCodes.json | 1 +
...ies-company-uuid-time-off-policies.api.mdx | 71 +
...l-blockers-company-uuid.ParamsDetails.json | 1 +
...l-blockers-company-uuid.RequestSchema.json | 1 +
...oll-blockers-company-uuid.StatusCodes.json | 1 +
...nies-payroll-blockers-company-uuid.api.mdx | 71 +
docs/api/get-v-1-companies.ParamsDetails.json | 1 +
docs/api/get-v-1-companies.RequestSchema.json | 1 +
docs/api/get-v-1-companies.StatusCodes.json | 1 +
docs/api/get-v-1-companies.api.mdx | 75 +
...contribution-exclusions.ParamsDetails.json | 1 +
...contribution-exclusions.RequestSchema.json | 1 +
...d-contribution-exclusions.StatusCodes.json | 1 +
...benefit-id-contribution-exclusions.api.mdx | 73 +
...it-id-employee-benefits.ParamsDetails.json | 1 +
...it-id-employee-benefits.RequestSchema.json | 1 +
...efit-id-employee-benefits.StatusCodes.json | 1 +
...mpany-benefit-id-employee-benefits.api.mdx | 75 +
...fits-company-benefit-id.ParamsDetails.json | 1 +
...fits-company-benefit-id.RequestSchema.json | 1 +
...nefits-company-benefit-id.StatusCodes.json | 1 +
...ompany-benefits-company-benefit-id.api.mdx | 75 +
...mpany-external-payrolls.ParamsDetails.json | 1 +
...mpany-external-payrolls.RequestSchema.json | 1 +
...company-external-payrolls.StatusCodes.json | 1 +
.../get-v-1-company-external-payrolls.api.mdx | 71 +
...mpany-finish-onboarding.ParamsDetails.json | 1 +
...mpany-finish-onboarding.RequestSchema.json | 1 +
...company-finish-onboarding.StatusCodes.json | 1 +
.../get-v-1-company-finish-onboarding.api.mdx | 85 +
...et-v-1-company-form-pdf.ParamsDetails.json | 1 +
...et-v-1-company-form-pdf.RequestSchema.json | 1 +
.../get-v-1-company-form-pdf.StatusCodes.json | 1 +
docs/api/get-v-1-company-form-pdf.api.mdx | 71 +
.../get-v-1-company-form.ParamsDetails.json | 1 +
.../get-v-1-company-form.RequestSchema.json | 1 +
.../api/get-v-1-company-form.StatusCodes.json | 1 +
docs/api/get-v-1-company-form.api.mdx | 71 +
.../get-v-1-company-forms.ParamsDetails.json | 1 +
.../get-v-1-company-forms.RequestSchema.json | 1 +
.../get-v-1-company-forms.StatusCodes.json | 1 +
docs/api/get-v-1-company-forms.api.mdx | 71 +
...et-v-1-company-industry.ParamsDetails.json | 1 +
...et-v-1-company-industry.RequestSchema.json | 1 +
.../get-v-1-company-industry.StatusCodes.json | 1 +
docs/api/get-v-1-company-industry.api.mdx | 71 +
...mpany-onboarding-status.ParamsDetails.json | 1 +
...mpany-onboarding-status.RequestSchema.json | 1 +
...company-onboarding-status.StatusCodes.json | 1 +
.../get-v-1-company-onboarding-status.api.mdx | 72 +
...company-payment-configs.ParamsDetails.json | 1 +
...company-payment-configs.RequestSchema.json | 1 +
...1-company-payment-configs.StatusCodes.json | 1 +
.../get-v-1-company-payment-configs.api.mdx | 74 +
...sations-compensation-id.ParamsDetails.json | 1 +
...sations-compensation-id.RequestSchema.json | 1 +
...ensations-compensation-id.StatusCodes.json | 1 +
...-v-1-compensations-compensation-id.api.mdx | 71 +
...contractor-document-pdf.ParamsDetails.json | 1 +
...contractor-document-pdf.RequestSchema.json | 1 +
...1-contractor-document-pdf.StatusCodes.json | 1 +
.../get-v-1-contractor-document-pdf.api.mdx | 71 +
...v-1-contractor-document.ParamsDetails.json | 1 +
...v-1-contractor-document.RequestSchema.json | 1 +
...t-v-1-contractor-document.StatusCodes.json | 1 +
docs/api/get-v-1-contractor-document.api.mdx | 71 +
...-1-contractor-documents.ParamsDetails.json | 1 +
...-1-contractor-documents.RequestSchema.json | 1 +
...-v-1-contractor-documents.StatusCodes.json | 1 +
docs/api/get-v-1-contractor-documents.api.mdx | 71 +
...v-1-contractor-form-pdf.ParamsDetails.json | 1 +
...v-1-contractor-form-pdf.RequestSchema.json | 1 +
...t-v-1-contractor-form-pdf.StatusCodes.json | 1 +
docs/api/get-v-1-contractor-form-pdf.api.mdx | 71 +
...get-v-1-contractor-form.ParamsDetails.json | 1 +
...get-v-1-contractor-form.RequestSchema.json | 1 +
.../get-v-1-contractor-form.StatusCodes.json | 1 +
docs/api/get-v-1-contractor-form.api.mdx | 71 +
...et-v-1-contractor-forms.ParamsDetails.json | 1 +
...et-v-1-contractor-forms.RequestSchema.json | 1 +
.../get-v-1-contractor-forms.StatusCodes.json | 1 +
docs/api/get-v-1-contractor-forms.api.mdx | 71 +
...ractor-payment-group-id.ParamsDetails.json | 1 +
...ractor-payment-group-id.RequestSchema.json | 1 +
...ntractor-payment-group-id.StatusCodes.json | 1 +
...groups-contractor-payment-group-id.api.mdx | 71 +
...d-partner-disbursements.ParamsDetails.json | 1 +
...d-partner-disbursements.RequestSchema.json | 1 +
...-id-partner-disbursements.StatusCodes.json | 1 +
...nt-groups-id-partner-disbursements.api.mdx | 71 +
...actor-payment-uuid-fund.ParamsDetails.json | 1 +
...actor-payment-uuid-fund.RequestSchema.json | 1 +
...tractor-payment-uuid-fund.StatusCodes.json | 1 +
...ments-contractor-payment-uuid-fund.api.mdx | 75 +
...or-payment-uuid-receipt.ParamsDetails.json | 1 +
...or-payment-uuid-receipt.RequestSchema.json | 1 +
...ctor-payment-uuid-receipt.StatusCodes.json | 1 +
...ts-contractor-payment-uuid-receipt.api.mdx | 78 +
...contractor-uuid-address.ParamsDetails.json | 1 +
...contractor-uuid-address.RequestSchema.json | 1 +
...s-contractor-uuid-address.StatusCodes.json | 1 +
...ontractors-contractor-uuid-address.api.mdx | 71 +
...ctor-uuid-bank-accounts.ParamsDetails.json | 1 +
...ctor-uuid-bank-accounts.RequestSchema.json | 1 +
...ractor-uuid-bank-accounts.StatusCodes.json | 1 +
...tors-contractor-uuid-bank-accounts.api.mdx | 71 +
...-uuid-onboarding-status.ParamsDetails.json | 1 +
...-uuid-onboarding-status.RequestSchema.json | 1 +
...or-uuid-onboarding-status.StatusCodes.json | 1 +
...-contractor-uuid-onboarding-status.api.mdx | 102 +
...tor-uuid-payment-method.ParamsDetails.json | 1 +
...tor-uuid-payment-method.RequestSchema.json | 1 +
...actor-uuid-payment-method.StatusCodes.json | 1 +
...ors-contractor-uuid-payment-method.api.mdx | 73 +
...ractors-contractor-uuid.ParamsDetails.json | 1 +
...ractors-contractor-uuid.RequestSchema.json | 1 +
...ntractors-contractor-uuid.StatusCodes.json | 1 +
...et-v-1-contractors-contractor-uuid.api.mdx | 71 +
...its-employee-benefit-id.ParamsDetails.json | 1 +
...its-employee-benefit-id.RequestSchema.json | 1 +
...efits-employee-benefit-id.StatusCodes.json | 1 +
...loyee-benefits-employee-benefit-id.api.mdx | 73 +
...t-v-1-employee-form-pdf.ParamsDetails.json | 1 +
...t-v-1-employee-form-pdf.RequestSchema.json | 1 +
...get-v-1-employee-form-pdf.StatusCodes.json | 1 +
docs/api/get-v-1-employee-form-pdf.api.mdx | 71 +
.../get-v-1-employee-form.ParamsDetails.json | 1 +
.../get-v-1-employee-form.RequestSchema.json | 1 +
.../get-v-1-employee-form.StatusCodes.json | 1 +
docs/api/get-v-1-employee-form.api.mdx | 71 +
.../get-v-1-employee-forms.ParamsDetails.json | 1 +
.../get-v-1-employee-forms.RequestSchema.json | 1 +
.../get-v-1-employee-forms.StatusCodes.json | 1 +
docs/api/get-v-1-employee-forms.api.mdx | 71 +
...ployee-id-bank-accounts.ParamsDetails.json | 1 +
...ployee-id-bank-accounts.RequestSchema.json | 1 +
...employee-id-bank-accounts.StatusCodes.json | 1 +
...mployees-employee-id-bank-accounts.api.mdx | 71 +
...ployee-id-custom-fields.ParamsDetails.json | 1 +
...ployee-id-custom-fields.RequestSchema.json | 1 +
...employee-id-custom-fields.StatusCodes.json | 1 +
...mployees-employee-id-custom-fields.api.mdx | 71 +
...ee-id-employee-benefits.ParamsDetails.json | 1 +
...ee-id-employee-benefits.RequestSchema.json | 1 +
...oyee-id-employee-benefits.StatusCodes.json | 1 +
...yees-employee-id-employee-benefits.api.mdx | 75 +
...e-id-employment-history.ParamsDetails.json | 1 +
...e-id-employment-history.RequestSchema.json | 1 +
...yee-id-employment-history.StatusCodes.json | 1 +
...ees-employee-id-employment-history.api.mdx | 71 +
...ployee-id-federal-taxes.ParamsDetails.json | 1 +
...ployee-id-federal-taxes.RequestSchema.json | 1 +
...employee-id-federal-taxes.StatusCodes.json | 1 +
...mployees-employee-id-federal-taxes.api.mdx | 71 +
...mployee-id-garnishments.ParamsDetails.json | 1 +
...mployee-id-garnishments.RequestSchema.json | 1 +
...-employee-id-garnishments.StatusCodes.json | 1 +
...employees-employee-id-garnishments.api.mdx | 71 +
...loyee-id-home-addresses.ParamsDetails.json | 1 +
...loyee-id-home-addresses.RequestSchema.json | 1 +
...mployee-id-home-addresses.StatusCodes.json | 1 +
...ployees-employee-id-home-addresses.api.mdx | 73 +
...zation-document-options.ParamsDetails.json | 1 +
...zation-document-options.RequestSchema.json | 1 +
...rization-document-options.StatusCodes.json | 1 +
...i-9-authorization-document-options.api.mdx | 71 +
...authorization-documents.ParamsDetails.json | 1 +
...authorization-documents.RequestSchema.json | 1 +
...9-authorization-documents.StatusCodes.json | 1 +
...yee-id-i-9-authorization-documents.api.mdx | 71 +
...ee-id-i-9-authorization.ParamsDetails.json | 1 +
...ee-id-i-9-authorization.RequestSchema.json | 1 +
...oyee-id-i-9-authorization.StatusCodes.json | 1 +
...yees-employee-id-i-9-authorization.api.mdx | 73 +
...loyees-employee-id-jobs.ParamsDetails.json | 1 +
...loyees-employee-id-jobs.RequestSchema.json | 1 +
...mployees-employee-id-jobs.StatusCodes.json | 1 +
...get-v-1-employees-employee-id-jobs.api.mdx | 71 +
...ee-id-onboarding-status.ParamsDetails.json | 1 +
...ee-id-onboarding-status.RequestSchema.json | 1 +
...oyee-id-onboarding-status.StatusCodes.json | 1 +
...yees-employee-id-onboarding-status.api.mdx | 108 +
...loyee-id-payment-method.ParamsDetails.json | 1 +
...loyee-id-payment-method.RequestSchema.json | 1 +
...mployee-id-payment-method.StatusCodes.json | 1 +
...ployees-employee-id-payment-method.api.mdx | 71 +
...ecurring-reimbursements.ParamsDetails.json | 1 +
...ecurring-reimbursements.RequestSchema.json | 1 +
...-recurring-reimbursements.StatusCodes.json | 1 +
...ployee-id-recurring-reimbursements.api.mdx | 71 +
...yees-employee-id-rehire.ParamsDetails.json | 1 +
...yees-employee-id-rehire.RequestSchema.json | 1 +
...loyees-employee-id-rehire.StatusCodes.json | 1 +
...t-v-1-employees-employee-id-rehire.api.mdx | 71 +
...employee-id-state-taxes.ParamsDetails.json | 1 +
...employee-id-state-taxes.RequestSchema.json | 1 +
...s-employee-id-state-taxes.StatusCodes.json | 1 +
...-employees-employee-id-state-taxes.api.mdx | 82 +
...mployee-id-terminations.ParamsDetails.json | 1 +
...mployee-id-terminations.RequestSchema.json | 1 +
...-employee-id-terminations.StatusCodes.json | 1 +
...employees-employee-id-terminations.api.mdx | 73 +
...loyee-id-work-addresses.ParamsDetails.json | 1 +
...loyee-id-work-addresses.RequestSchema.json | 1 +
...mployee-id-work-addresses.StatusCodes.json | 1 +
...ployees-employee-id-work-addresses.api.mdx | 72 +
...employee-uuid-pay-stubs.ParamsDetails.json | 1 +
...employee-uuid-pay-stubs.RequestSchema.json | 1 +
...s-employee-uuid-pay-stubs.StatusCodes.json | 1 +
...-employees-employee-uuid-pay-stubs.api.mdx | 71 +
...statuses-effective-year.ParamsDetails.json | 1 +
...statuses-effective-year.RequestSchema.json | 1 +
...r-statuses-effective-year.StatusCodes.json | 1 +
...igh-earner-statuses-effective-year.api.mdx | 74 +
...03-high-earner-statuses.ParamsDetails.json | 1 +
...03-high-earner-statuses.RequestSchema.json | 1 +
...-603-high-earner-statuses.StatusCodes.json | 1 +
...d-section-603-high-earner-statuses.api.mdx | 74 +
docs/api/get-v-1-employees.ParamsDetails.json | 1 +
docs/api/get-v-1-employees.RequestSchema.json | 1 +
docs/api/get-v-1-employees.StatusCodes.json | 1 +
docs/api/get-v-1-employees.api.mdx | 73 +
...payroll-calculate-taxes.ParamsDetails.json | 1 +
...payroll-calculate-taxes.RequestSchema.json | 1 +
...l-payroll-calculate-taxes.StatusCodes.json | 1 +
...1-external-payroll-calculate-taxes.api.mdx | 73 +
...et-v-1-external-payroll.ParamsDetails.json | 1 +
...et-v-1-external-payroll.RequestSchema.json | 1 +
.../get-v-1-external-payroll.StatusCodes.json | 1 +
docs/api/get-v-1-external-payroll.api.mdx | 71 +
...nishments-child-support.ParamsDetails.json | 1 +
...nishments-child-support.RequestSchema.json | 1 +
...arnishments-child-support.StatusCodes.json | 1 +
...get-v-1-garnishments-child-support.api.mdx | 71 +
...ishments-garnishment-id.ParamsDetails.json | 1 +
...ishments-garnishment-id.RequestSchema.json | 1 +
...rnishments-garnishment-id.StatusCodes.json | 1 +
...et-v-1-garnishments-garnishment-id.api.mdx | 71 +
...ument-type-request-uuid.ParamsDetails.json | 1 +
...ument-type-request-uuid.RequestSchema.json | 1 +
...ocument-type-request-uuid.StatusCodes.json | 1 +
...cuments-document-type-request-uuid.api.mdx | 71 +
...esses-home-address-uuid.ParamsDetails.json | 1 +
...esses-home-address-uuid.RequestSchema.json | 1 +
...dresses-home-address-uuid.StatusCodes.json | 1 +
...1-home-addresses-home-address-uuid.api.mdx | 73 +
...bs-job-id-compensations.ParamsDetails.json | 1 +
...bs-job-id-compensations.RequestSchema.json | 1 +
...jobs-job-id-compensations.StatusCodes.json | 1 +
.../get-v-1-jobs-job-id-compensations.api.mdx | 76 +
.../get-v-1-jobs-job-id.ParamsDetails.json | 1 +
.../get-v-1-jobs-job-id.RequestSchema.json | 1 +
docs/api/get-v-1-jobs-job-id.StatusCodes.json | 1 +
docs/api/get-v-1-jobs-job-id.api.mdx | 71 +
...1-locations-location-id.ParamsDetails.json | 1 +
...1-locations-location-id.RequestSchema.json | 1 +
...v-1-locations-location-id.StatusCodes.json | 1 +
.../api/get-v-1-locations-location-id.api.mdx | 71 +
...tion-uuid-minimum-wages.ParamsDetails.json | 1 +
...tion-uuid-minimum-wages.RequestSchema.json | 1 +
...cation-uuid-minimum-wages.StatusCodes.json | 1 +
...ations-location-uuid-minimum-wages.api.mdx | 71 +
...uid-migration-readiness.ParamsDetails.json | 1 +
...uid-migration-readiness.RequestSchema.json | 1 +
...-uuid-migration-readiness.StatusCodes.json | 1 +
...s-company-uuid-migration-readiness.api.mdx | 71 +
...s-payrolls-payroll-uuid.ParamsDetails.json | 1 +
...s-payrolls-payroll-uuid.RequestSchema.json | 1 +
...pts-payrolls-payroll-uuid.StatusCodes.json | 1 +
...ent-receipts-payrolls-payroll-uuid.api.mdx | 76 +
...-employee-uuid-pay-stub.ParamsDetails.json | 1 +
...-employee-uuid-pay-stub.RequestSchema.json | 1 +
...es-employee-uuid-pay-stub.StatusCodes.json | 1 +
...d-employees-employee-uuid-pay-stub.api.mdx | 71 +
...tches-people-batch-uuid.ParamsDetails.json | 1 +
...tches-people-batch-uuid.RequestSchema.json | 1 +
...batches-people-batch-uuid.StatusCodes.json | 1 +
...1-people-batches-people-batch-uuid.api.mdx | 73 +
...ecurring-reimbursements.ParamsDetails.json | 1 +
...ecurring-reimbursements.RequestSchema.json | 1 +
...-recurring-reimbursements.StatusCodes.json | 1 +
.../get-v-1-recurring-reimbursements.api.mdx | 71 +
...v-1-salary-estimates-id.ParamsDetails.json | 1 +
...v-1-salary-estimates-id.RequestSchema.json | 1 +
...t-v-1-salary-estimates-id.StatusCodes.json | 1 +
docs/api/get-v-1-salary-estimates-id.api.mdx | 71 +
...y-estimates-occupations.ParamsDetails.json | 1 +
...y-estimates-occupations.RequestSchema.json | 1 +
...ary-estimates-occupations.StatusCodes.json | 1 +
...t-v-1-salary-estimates-occupations.api.mdx | 77 +
...get-v-1-tax-liabilities.ParamsDetails.json | 1 +
...get-v-1-tax-liabilities.RequestSchema.json | 1 +
.../get-v-1-tax-liabilities.StatusCodes.json | 1 +
docs/api/get-v-1-tax-liabilities.api.mdx | 71 +
...es-time-off-policy-uuid.ParamsDetails.json | 1 +
...es-time-off-policy-uuid.RequestSchema.json | 1 +
...cies-time-off-policy-uuid.StatusCodes.json | 1 +
...-off-policies-time-off-policy-uuid.api.mdx | 71 +
.../api/get-v-1-token-info.ParamsDetails.json | 1 +
.../api/get-v-1-token-info.RequestSchema.json | 1 +
docs/api/get-v-1-token-info.StatusCodes.json | 1 +
docs/api/get-v-1-token-info.api.mdx | 71 +
...bhook-subscription-uuid.ParamsDetails.json | 1 +
...bhook-subscription-uuid.RequestSchema.json | 1 +
...webhook-subscription-uuid.StatusCodes.json | 1 +
.../get-v-1-webhook-subscription-uuid.api.mdx | 76 +
...verification-token-uuid.ParamsDetails.json | 1 +
...verification-token-uuid.RequestSchema.json | 1 +
...n-verification-token-uuid.StatusCodes.json | 1 +
...bscription-verification-token-uuid.api.mdx | 76 +
...1-webhook-subscriptions.ParamsDetails.json | 1 +
...1-webhook-subscriptions.RequestSchema.json | 1 +
...v-1-webhook-subscriptions.StatusCodes.json | 1 +
.../api/get-v-1-webhook-subscriptions.api.mdx | 75 +
...1-webhooks-health-check.ParamsDetails.json | 1 +
...1-webhooks-health-check.RequestSchema.json | 1 +
...v-1-webhooks-health-check.StatusCodes.json | 1 +
.../api/get-v-1-webhooks-health-check.api.mdx | 75 +
...esses-work-address-uuid.ParamsDetails.json | 1 +
...esses-work-address-uuid.RequestSchema.json | 1 +
...dresses-work-address-uuid.StatusCodes.json | 1 +
...1-work-addresses-work-address-uuid.api.mdx | 71 +
...ees-time-off-activities.ParamsDetails.json | 1 +
...ees-time-off-activities.RequestSchema.json | 1 +
...oyees-time-off-activities.StatusCodes.json | 1 +
...sion-employees-time-off-activities.api.mdx | 71 +
...ts-wire-in-request-uuid.ParamsDetails.json | 1 +
...ts-wire-in-request-uuid.RequestSchema.json | 1 +
...ests-wire-in-request-uuid.StatusCodes.json | 1 +
...e-in-requests-wire-in-request-uuid.api.mdx | 71 +
docs/api/gusto-api.info.mdx | 125 +
docs/api/holiday-pay-policies.tag.mdx | 20 +
docs/api/i-9-verification.tag.mdx | 20 +
docs/api/industry-selection.tag.mdx | 20 +
docs/api/information-requests.tag.mdx | 20 +
docs/api/introspection.tag.mdx | 20 +
docs/api/invoices.tag.mdx | 20 +
docs/api/jobs-and-compensations.tag.mdx | 20 +
docs/api/locations.tag.mdx | 20 +
docs/api/notifications.tag.mdx | 20 +
.../api/oauth-access-token.ParamsDetails.json | 1 +
.../api/oauth-access-token.RequestSchema.json | 1 +
docs/api/oauth-access-token.StatusCodes.json | 1 +
docs/api/oauth-access-token.api.mdx | 69 +
...d-partner-disbursements.ParamsDetails.json | 1 +
...d-partner-disbursements.RequestSchema.json | 1 +
...-id-partner-disbursements.StatusCodes.json | 1 +
...-payrolls-id-partner-disbursements.api.mdx | 71 +
...d-partner-disbursements.ParamsDetails.json | 1 +
...d-partner-disbursements.RequestSchema.json | 1 +
...-id-partner-disbursements.StatusCodes.json | 1 +
...nt-groups-id-partner-disbursements.api.mdx | 71 +
...statuses-effective-year.ParamsDetails.json | 1 +
...statuses-effective-year.RequestSchema.json | 1 +
...r-statuses-effective-year.StatusCodes.json | 1 +
...igh-earner-statuses-effective-year.api.mdx | 74 +
docs/api/pay-schedules.tag.mdx | 20 +
docs/api/payment-configs.tag.mdx | 20 +
docs/api/payrolls.tag.mdx | 20 +
docs/api/people-batches.tag.mdx | 20 +
...es-company-uuid-reports.ParamsDetails.json | 1 +
...es-company-uuid-reports.RequestSchema.json | 1 +
...nies-company-uuid-reports.StatusCodes.json | 1 +
...ost-companies-company-uuid-reports.api.mdx | 71 +
...ompany-uuid-suspensions.ParamsDetails.json | 1 +
...ompany-uuid-suspensions.RequestSchema.json | 1 +
...-company-uuid-suspensions.StatusCodes.json | 1 +
...companies-company-uuid-suspensions.api.mdx | 71 +
...yroll-skip-company-uuid.ParamsDetails.json | 1 +
...yroll-skip-company-uuid.RequestSchema.json | 1 +
...payroll-skip-company-uuid.StatusCodes.json | 1 +
...ompanies-payroll-skip-company-uuid.api.mdx | 73 +
docs/api/post-departments.ParamsDetails.json | 1 +
docs/api/post-departments.RequestSchema.json | 1 +
docs/api/post-departments.StatusCodes.json | 1 +
docs/api/post-departments.api.mdx | 71 +
...-from-different-company.ParamsDetails.json | 1 +
...-from-different-company.RequestSchema.json | 1 +
...ts-from-different-company.StatusCodes.json | 1 +
...fit-amounts-from-different-company.api.mdx | 73 +
...accept-terms-of-service.ParamsDetails.json | 1 +
...accept-terms-of-service.RequestSchema.json | 1 +
...d-accept-terms-of-service.StatusCodes.json | 1 +
...mpany-uuid-accept-terms-of-service.api.mdx | 72 +
...trieve-terms-of-service.ParamsDetails.json | 1 +
...trieve-terms-of-service.RequestSchema.json | 1 +
...retrieve-terms-of-service.StatusCodes.json | 1 +
...any-uuid-retrieve-terms-of-service.api.mdx | 71 +
...s-gross-up-payroll-uuid.ParamsDetails.json | 1 +
...s-gross-up-payroll-uuid.RequestSchema.json | 1 +
...lls-gross-up-payroll-uuid.StatusCodes.json | 1 +
...ost-payrolls-gross-up-payroll-uuid.api.mdx | 73 +
...-reports-general-ledger.ParamsDetails.json | 1 +
...-reports-general-ledger.RequestSchema.json | 1 +
...id-reports-general-ledger.StatusCodes.json | 1 +
...ayroll-uuid-reports-general-ledger.api.mdx | 73 +
...-1-companies-attachment.ParamsDetails.json | 1 +
...-1-companies-attachment.RequestSchema.json | 1 +
...-v-1-companies-attachment.StatusCodes.json | 1 +
.../api/post-v-1-companies-attachment.api.mdx | 73 +
...anies-company-id-admins.ParamsDetails.json | 1 +
...anies-company-id-admins.RequestSchema.json | 1 +
...mpanies-company-id-admins.StatusCodes.json | 1 +
...st-v-1-companies-company-id-admins.api.mdx | 72 +
...ompany-id-bank-accounts.ParamsDetails.json | 1 +
...ompany-id-bank-accounts.RequestSchema.json | 1 +
...-company-id-bank-accounts.StatusCodes.json | 1 +
...companies-company-id-bank-accounts.api.mdx | 81 +
...any-id-company-benefits.ParamsDetails.json | 1 +
...any-id-company-benefits.RequestSchema.json | 1 +
...mpany-id-company-benefits.StatusCodes.json | 1 +
...panies-company-id-company-benefits.api.mdx | 75 +
...-payment-groups-preview.ParamsDetails.json | 1 +
...-payment-groups-preview.RequestSchema.json | 1 +
...or-payment-groups-preview.StatusCodes.json | 1 +
...-contractor-payment-groups-preview.api.mdx | 73 +
...ntractor-payment-groups.ParamsDetails.json | 1 +
...ntractor-payment-groups.RequestSchema.json | 1 +
...contractor-payment-groups.StatusCodes.json | 1 +
...mpany-id-contractor-payment-groups.api.mdx | 71 +
...-id-contractor-payments.ParamsDetails.json | 1 +
...-id-contractor-payments.RequestSchema.json | 1 +
...ny-id-contractor-payments.StatusCodes.json | 1 +
...ies-company-id-contractor-payments.api.mdx | 71 +
...ompany-id-earning-types.ParamsDetails.json | 1 +
...ompany-id-earning-types.RequestSchema.json | 1 +
...-company-id-earning-types.StatusCodes.json | 1 +
...companies-company-id-earning-types.api.mdx | 73 +
...es-company-id-locations.ParamsDetails.json | 1 +
...es-company-id-locations.RequestSchema.json | 1 +
...nies-company-id-locations.StatusCodes.json | 1 +
...v-1-companies-company-id-locations.api.mdx | 75 +
...id-pay-schedules-assign.ParamsDetails.json | 1 +
...id-pay-schedules-assign.RequestSchema.json | 1 +
...y-id-pay-schedules-assign.StatusCodes.json | 1 +
...es-company-id-pay-schedules-assign.api.mdx | 72 +
...ules-assignment-preview.ParamsDetails.json | 1 +
...ules-assignment-preview.RequestSchema.json | 1 +
...edules-assignment-preview.StatusCodes.json | 1 +
...d-pay-schedules-assignment-preview.api.mdx | 71 +
...ompany-id-pay-schedules.ParamsDetails.json | 1 +
...ompany-id-pay-schedules.RequestSchema.json | 1 +
...-company-id-pay-schedules.StatusCodes.json | 1 +
...companies-company-id-pay-schedules.api.mdx | 81 +
...ies-company-id-payrolls.ParamsDetails.json | 1 +
...ies-company-id-payrolls.RequestSchema.json | 1 +
...anies-company-id-payrolls.StatusCodes.json | 1 +
...-v-1-companies-company-id-payrolls.api.mdx | 78 +
...mpany-id-people-batches.ParamsDetails.json | 1 +
...mpany-id-people-batches.RequestSchema.json | 1 +
...company-id-people-batches.StatusCodes.json | 1 +
...ompanies-company-id-people-batches.api.mdx | 73 +
...loyees-annual-fica-wage.ParamsDetails.json | 1 +
...loyees-annual-fica-wage.RequestSchema.json | 1 +
...mployees-annual-fica-wage.StatusCodes.json | 1 +
...reports-employees-annual-fica-wage.api.mdx | 75 +
...ompany-uuid-contractors.ParamsDetails.json | 1 +
...ompany-uuid-contractors.RequestSchema.json | 1 +
...-company-uuid-contractors.StatusCodes.json | 1 +
...companies-company-uuid-contractors.api.mdx | 71 +
...uuid-holiday-pay-policy.ParamsDetails.json | 1 +
...uuid-holiday-pay-policy.RequestSchema.json | 1 +
...y-uuid-holiday-pay-policy.StatusCodes.json | 1 +
...es-company-uuid-holiday-pay-policy.api.mdx | 71 +
...uuid-signatories-invite.ParamsDetails.json | 1 +
...uuid-signatories-invite.RequestSchema.json | 1 +
...y-uuid-signatories-invite.StatusCodes.json | 1 +
...es-company-uuid-signatories-invite.api.mdx | 74 +
...-uuid-time-off-policies.ParamsDetails.json | 1 +
...-uuid-time-off-policies.RequestSchema.json | 1 +
...ny-uuid-time-off-policies.StatusCodes.json | 1 +
...ies-company-uuid-time-off-policies.api.mdx | 71 +
.../post-v-1-company-flows.ParamsDetails.json | 1 +
.../post-v-1-company-flows.RequestSchema.json | 1 +
.../post-v-1-company-flows.StatusCodes.json | 1 +
docs/api/post-v-1-company-flows.api.mdx | 87 +
...v-1-company-signatories.ParamsDetails.json | 1 +
...v-1-company-signatories.RequestSchema.json | 1 +
...t-v-1-company-signatories.StatusCodes.json | 1 +
docs/api/post-v-1-company-signatories.api.mdx | 79 +
...sations-compensation-id.ParamsDetails.json | 1 +
...sations-compensation-id.RequestSchema.json | 1 +
...ensations-compensation-id.StatusCodes.json | 1 +
...-v-1-compensations-compensation-id.api.mdx | 78 +
...ctor-uuid-bank-accounts.ParamsDetails.json | 1 +
...ctor-uuid-bank-accounts.RequestSchema.json | 1 +
...ractor-uuid-bank-accounts.StatusCodes.json | 1 +
...tors-contractor-uuid-bank-accounts.api.mdx | 73 +
...ployee-id-bank-accounts.ParamsDetails.json | 1 +
...ployee-id-bank-accounts.RequestSchema.json | 1 +
...employee-id-bank-accounts.StatusCodes.json | 1 +
...mployees-employee-id-bank-accounts.api.mdx | 73 +
...ee-id-employee-benefits.ParamsDetails.json | 1 +
...ee-id-employee-benefits.RequestSchema.json | 1 +
...oyee-id-employee-benefits.StatusCodes.json | 1 +
...yees-employee-id-employee-benefits.api.mdx | 73 +
...mployee-id-garnishments.ParamsDetails.json | 1 +
...mployee-id-garnishments.RequestSchema.json | 1 +
...-employee-id-garnishments.StatusCodes.json | 1 +
...employees-employee-id-garnishments.api.mdx | 71 +
...loyee-id-home-addresses.ParamsDetails.json | 1 +
...loyee-id-home-addresses.RequestSchema.json | 1 +
...mployee-id-home-addresses.StatusCodes.json | 1 +
...ployees-employee-id-home-addresses.api.mdx | 73 +
...ecurring-reimbursements.ParamsDetails.json | 1 +
...ecurring-reimbursements.RequestSchema.json | 1 +
...-recurring-reimbursements.StatusCodes.json | 1 +
...ployee-id-recurring-reimbursements.api.mdx | 71 +
...yees-employee-id-rehire.ParamsDetails.json | 1 +
...yees-employee-id-rehire.RequestSchema.json | 1 +
...loyees-employee-id-rehire.StatusCodes.json | 1 +
...t-v-1-employees-employee-id-rehire.api.mdx | 71 +
...yee-id-salary-estimates.ParamsDetails.json | 1 +
...yee-id-salary-estimates.RequestSchema.json | 1 +
...loyee-id-salary-estimates.StatusCodes.json | 1 +
...oyees-employee-id-salary-estimates.api.mdx | 78 +
...mployee-id-terminations.ParamsDetails.json | 1 +
...mployee-id-terminations.RequestSchema.json | 1 +
...-employee-id-terminations.StatusCodes.json | 1 +
...employees-employee-id-terminations.api.mdx | 73 +
...loyee-id-work-addresses.ParamsDetails.json | 1 +
...loyee-id-work-addresses.RequestSchema.json | 1 +
...mployee-id-work-addresses.StatusCodes.json | 1 +
...ployees-employee-id-work-addresses.api.mdx | 71 +
...03-high-earner-statuses.ParamsDetails.json | 1 +
...03-high-earner-statuses.RequestSchema.json | 1 +
...-603-high-earner-statuses.StatusCodes.json | 1 +
...d-section-603-high-earner-statuses.api.mdx | 74 +
.../api/post-v-1-employees.ParamsDetails.json | 1 +
.../api/post-v-1-employees.RequestSchema.json | 1 +
docs/api/post-v-1-employees.StatusCodes.json | 1 +
docs/api/post-v-1-employees.api.mdx | 71 +
...st-v-1-external-payroll.ParamsDetails.json | 1 +
...st-v-1-external-payroll.RequestSchema.json | 1 +
...post-v-1-external-payroll.StatusCodes.json | 1 +
docs/api/post-v-1-external-payroll.api.mdx | 71 +
...-1-historical-employees.ParamsDetails.json | 1 +
...-1-historical-employees.RequestSchema.json | 1 +
...-v-1-historical-employees.StatusCodes.json | 1 +
.../api/post-v-1-historical-employees.api.mdx | 71 +
.../post-v-1-jobs-job-id.ParamsDetails.json | 1 +
.../post-v-1-jobs-job-id.RequestSchema.json | 1 +
.../api/post-v-1-jobs-job-id.StatusCodes.json | 1 +
docs/api/post-v-1-jobs-job-id.api.mdx | 71 +
...rtner-managed-companies.ParamsDetails.json | 1 +
...rtner-managed-companies.RequestSchema.json | 1 +
...partner-managed-companies.StatusCodes.json | 1 +
...post-v-1-partner-managed-companies.api.mdx | 80 +
...accruing-time-off-hours.ParamsDetails.json | 1 +
...accruing-time-off-hours.RequestSchema.json | 1 +
...e-accruing-time-off-hours.StatusCodes.json | 1 +
...-calculate-accruing-time-off-hours.api.mdx | 80 +
...rintable-payroll-checks.ParamsDetails.json | 1 +
...rintable-payroll-checks.RequestSchema.json | 1 +
...-printable-payroll-checks.StatusCodes.json | 1 +
...documents-printable-payroll-checks.api.mdx | 71 +
...1-plaid-processor-token.ParamsDetails.json | 1 +
...1-plaid-processor-token.RequestSchema.json | 1 +
...v-1-plaid-processor-token.StatusCodes.json | 1 +
.../post-v-1-plaid-processor-token.api.mdx | 78 +
...y-estimates-uuid-accept.ParamsDetails.json | 1 +
...y-estimates-uuid-accept.RequestSchema.json | 1 +
...ary-estimates-uuid-accept.StatusCodes.json | 1 +
...t-v-1-salary-estimates-uuid-accept.api.mdx | 73 +
...1-sandbox-generate-1099.ParamsDetails.json | 1 +
...1-sandbox-generate-1099.RequestSchema.json | 1 +
...v-1-sandbox-generate-1099.StatusCodes.json | 1 +
.../post-v-1-sandbox-generate-1099.api.mdx | 75 +
...-1-sandbox-generate-w-2.ParamsDetails.json | 1 +
...-1-sandbox-generate-w-2.RequestSchema.json | 1 +
...-v-1-sandbox-generate-w-2.StatusCodes.json | 1 +
.../api/post-v-1-sandbox-generate-w-2.api.mdx | 75 +
...-1-webhook-subscription.ParamsDetails.json | 1 +
...-1-webhook-subscription.RequestSchema.json | 1 +
...-v-1-webhook-subscription.StatusCodes.json | 1 +
.../api/post-v-1-webhook-subscription.api.mdx | 75 +
...dd-people-to-department.ParamsDetails.json | 1 +
...dd-people-to-department.RequestSchema.json | 1 +
...-add-people-to-department.StatusCodes.json | 1 +
docs/api/put-add-people-to-department.api.mdx | 72 +
...rolls-payroll-id-cancel.ParamsDetails.json | 1 +
...rolls-payroll-id-cancel.RequestSchema.json | 1 +
...ayrolls-payroll-id-cancel.StatusCodes.json | 1 +
...pany-id-payrolls-payroll-id-cancel.api.mdx | 74 +
docs/api/put-departments.ParamsDetails.json | 1 +
docs/api/put-departments.RequestSchema.json | 1 +
docs/api/put-departments.StatusCodes.json | 1 +
docs/api/put-departments.api.mdx | 71 +
...-people-from-department.ParamsDetails.json | 1 +
...-people-from-department.RequestSchema.json | 1 +
...ve-people-from-department.StatusCodes.json | 1 +
.../put-remove-people-from-department.api.mdx | 72 +
...id-bank-accounts-verify.ParamsDetails.json | 1 +
...id-bank-accounts-verify.RequestSchema.json | 1 +
...y-id-bank-accounts-verify.StatusCodes.json | 1 +
...es-company-id-bank-accounts-verify.api.mdx | 84 +
...types-earning-type-uuid.ParamsDetails.json | 1 +
...types-earning-type-uuid.RequestSchema.json | 1 +
...g-types-earning-type-uuid.StatusCodes.json | 1 +
...id-earning-types-earning-type-uuid.api.mdx | 71 +
...-id-federal-tax-details.ParamsDetails.json | 1 +
...-id-federal-tax-details.RequestSchema.json | 1 +
...ny-id-federal-tax-details.StatusCodes.json | 1 +
...ies-company-id-federal-tax-details.api.mdx | 72 +
...hedules-pay-schedule-id.ParamsDetails.json | 1 +
...hedules-pay-schedule-id.RequestSchema.json | 1 +
...schedules-pay-schedule-id.StatusCodes.json | 1 +
...y-id-pay-schedules-pay-schedule-id.api.mdx | 77 +
...ls-payroll-id-calculate.ParamsDetails.json | 1 +
...ls-payroll-id-calculate.RequestSchema.json | 1 +
...olls-payroll-id-calculate.StatusCodes.json | 1 +
...y-id-payrolls-payroll-id-calculate.api.mdx | 75 +
...olls-payroll-id-prepare.ParamsDetails.json | 1 +
...olls-payroll-id-prepare.RequestSchema.json | 1 +
...yrolls-payroll-id-prepare.StatusCodes.json | 1 +
...any-id-payrolls-payroll-id-prepare.api.mdx | 76 +
...rolls-payroll-id-submit.ParamsDetails.json | 1 +
...rolls-payroll-id-submit.RequestSchema.json | 1 +
...ayrolls-payroll-id-submit.StatusCodes.json | 1 +
...pany-id-payrolls-payroll-id-submit.api.mdx | 75 +
...ies-company-id-payrolls.ParamsDetails.json | 1 +
...ies-company-id-payrolls.RequestSchema.json | 1 +
...anies-company-id-payrolls.StatusCodes.json | 1 +
...-v-1-companies-company-id-payrolls.api.mdx | 76 +
...-holiday-pay-policy-add.ParamsDetails.json | 1 +
...-holiday-pay-policy-add.RequestSchema.json | 1 +
...id-holiday-pay-policy-add.StatusCodes.json | 1 +
...ompany-uuid-holiday-pay-policy-add.api.mdx | 71 +
...liday-pay-policy-remove.ParamsDetails.json | 1 +
...liday-pay-policy-remove.RequestSchema.json | 1 +
...holiday-pay-policy-remove.StatusCodes.json | 1 +
...any-uuid-holiday-pay-policy-remove.api.mdx | 71 +
...uuid-holiday-pay-policy.ParamsDetails.json | 1 +
...uuid-holiday-pay-policy.RequestSchema.json | 1 +
...y-uuid-holiday-pay-policy.StatusCodes.json | 1 +
...es-company-uuid-holiday-pay-policy.api.mdx | 71 +
...natories-signatory-uuid.ParamsDetails.json | 1 +
...natories-signatory-uuid.RequestSchema.json | 1 +
...ignatories-signatory-uuid.StatusCodes.json | 1 +
...ny-uuid-signatories-signatory-uuid.api.mdx | 74 +
...-tax-requirements-state.ParamsDetails.json | 1 +
...-tax-requirements-state.RequestSchema.json | 1 +
...id-tax-requirements-state.StatusCodes.json | 1 +
...ompany-uuid-tax-requirements-state.api.mdx | 71 +
docs/api/put-v-1-companies.ParamsDetails.json | 1 +
docs/api/put-v-1-companies.RequestSchema.json | 1 +
docs/api/put-v-1-companies.StatusCodes.json | 1 +
docs/api/put-v-1-companies.api.mdx | 71 +
...contribution-exclusions.ParamsDetails.json | 1 +
...contribution-exclusions.RequestSchema.json | 1 +
...d-contribution-exclusions.StatusCodes.json | 1 +
...benefit-id-contribution-exclusions.api.mdx | 73 +
...it-id-employee-benefits.ParamsDetails.json | 1 +
...it-id-employee-benefits.RequestSchema.json | 1 +
...efit-id-employee-benefits.StatusCodes.json | 1 +
...mpany-benefit-id-employee-benefits.api.mdx | 77 +
...fits-company-benefit-id.ParamsDetails.json | 1 +
...fits-company-benefit-id.RequestSchema.json | 1 +
...nefits-company-benefit-id.StatusCodes.json | 1 +
...ompany-benefits-company-benefit-id.api.mdx | 75 +
...t-v-1-company-form-sign.ParamsDetails.json | 1 +
...t-v-1-company-form-sign.RequestSchema.json | 1 +
...put-v-1-company-form-sign.StatusCodes.json | 1 +
docs/api/put-v-1-company-form-sign.api.mdx | 71 +
...ut-v-1-company-industry.ParamsDetails.json | 1 +
...ut-v-1-company-industry.RequestSchema.json | 1 +
.../put-v-1-company-industry.StatusCodes.json | 1 +
docs/api/put-v-1-company-industry.api.mdx | 77 +
...company-payment-configs.ParamsDetails.json | 1 +
...company-payment-configs.RequestSchema.json | 1 +
...1-company-payment-configs.StatusCodes.json | 1 +
.../put-v-1-company-payment-configs.api.mdx | 77 +
...sations-compensation-id.ParamsDetails.json | 1 +
...sations-compensation-id.RequestSchema.json | 1 +
...ensations-compensation-id.StatusCodes.json | 1 +
...-v-1-compensations-compensation-id.api.mdx | 74 +
...ontractor-document-sign.ParamsDetails.json | 1 +
...ontractor-document-sign.RequestSchema.json | 1 +
...-contractor-document-sign.StatusCodes.json | 1 +
.../put-v-1-contractor-document-sign.api.mdx | 71 +
...r-payment-group-id-fund.ParamsDetails.json | 1 +
...r-payment-group-id-fund.RequestSchema.json | 1 +
...tor-payment-group-id-fund.StatusCodes.json | 1 +
...s-contractor-payment-group-id-fund.api.mdx | 74 +
...actor-id-payment-method.ParamsDetails.json | 1 +
...actor-id-payment-method.RequestSchema.json | 1 +
...tractor-id-payment-method.StatusCodes.json | 1 +
...ctors-contractor-id-payment-method.api.mdx | 72 +
...contractor-uuid-address.ParamsDetails.json | 1 +
...contractor-uuid-address.RequestSchema.json | 1 +
...s-contractor-uuid-address.StatusCodes.json | 1 +
...ontractors-contractor-uuid-address.api.mdx | 75 +
...-uuid-onboarding-status.ParamsDetails.json | 1 +
...-uuid-onboarding-status.RequestSchema.json | 1 +
...or-uuid-onboarding-status.StatusCodes.json | 1 +
...-contractor-uuid-onboarding-status.api.mdx | 81 +
...ractors-contractor-uuid.ParamsDetails.json | 1 +
...ractors-contractor-uuid.RequestSchema.json | 1 +
...ntractors-contractor-uuid.StatusCodes.json | 1 +
...ut-v-1-contractors-contractor-uuid.api.mdx | 75 +
...its-employee-benefit-id.ParamsDetails.json | 1 +
...its-employee-benefit-id.RequestSchema.json | 1 +
...efits-employee-benefit-id.StatusCodes.json | 1 +
...loyee-benefits-employee-benefit-id.api.mdx | 73 +
...-v-1-employee-form-sign.ParamsDetails.json | 1 +
...-v-1-employee-form-sign.RequestSchema.json | 1 +
...ut-v-1-employee-form-sign.StatusCodes.json | 1 +
docs/api/put-v-1-employee-form-sign.api.mdx | 74 +
...ployee-id-bank-accounts.ParamsDetails.json | 1 +
...ployee-id-bank-accounts.RequestSchema.json | 1 +
...employee-id-bank-accounts.StatusCodes.json | 1 +
...mployees-employee-id-bank-accounts.api.mdx | 71 +
...ployee-id-federal-taxes.ParamsDetails.json | 1 +
...ployee-id-federal-taxes.RequestSchema.json | 1 +
...employee-id-federal-taxes.StatusCodes.json | 1 +
...mployees-employee-id-federal-taxes.api.mdx | 71 +
...authorization-documents.ParamsDetails.json | 1 +
...authorization-documents.RequestSchema.json | 1 +
...9-authorization-documents.StatusCodes.json | 1 +
...yee-id-i-9-authorization-documents.api.mdx | 78 +
...orization-employer-sign.ParamsDetails.json | 1 +
...orization-employer-sign.RequestSchema.json | 1 +
...thorization-employer-sign.StatusCodes.json | 1 +
...id-i-9-authorization-employer-sign.api.mdx | 71 +
...ee-id-i-9-authorization.ParamsDetails.json | 1 +
...ee-id-i-9-authorization.RequestSchema.json | 1 +
...oyee-id-i-9-authorization.StatusCodes.json | 1 +
...yees-employee-id-i-9-authorization.api.mdx | 89 +
...arding-documents-config.ParamsDetails.json | 1 +
...arding-documents-config.RequestSchema.json | 1 +
...boarding-documents-config.StatusCodes.json | 1 +
...yee-id-onboarding-documents-config.api.mdx | 75 +
...ee-id-onboarding-status.ParamsDetails.json | 1 +
...ee-id-onboarding-status.RequestSchema.json | 1 +
...oyee-id-onboarding-status.StatusCodes.json | 1 +
...yees-employee-id-onboarding-status.api.mdx | 80 +
...loyee-id-payment-method.ParamsDetails.json | 1 +
...loyee-id-payment-method.RequestSchema.json | 1 +
...mployee-id-payment-method.StatusCodes.json | 1 +
...ployees-employee-id-payment-method.api.mdx | 71 +
...yees-employee-id-rehire.ParamsDetails.json | 1 +
...yees-employee-id-rehire.RequestSchema.json | 1 +
...loyees-employee-id-rehire.StatusCodes.json | 1 +
...t-v-1-employees-employee-id-rehire.api.mdx | 71 +
...employee-id-state-taxes.ParamsDetails.json | 1 +
...employee-id-state-taxes.RequestSchema.json | 1 +
...s-employee-id-state-taxes.StatusCodes.json | 1 +
...-employees-employee-id-state-taxes.api.mdx | 73 +
docs/api/put-v-1-employees.ParamsDetails.json | 1 +
docs/api/put-v-1-employees.RequestSchema.json | 1 +
docs/api/put-v-1-employees.StatusCodes.json | 1 +
docs/api/put-v-1-employees.api.mdx | 71 +
...ut-v-1-external-payroll.ParamsDetails.json | 1 +
...ut-v-1-external-payroll.RequestSchema.json | 1 +
.../put-v-1-external-payroll.StatusCodes.json | 1 +
docs/api/put-v-1-external-payroll.api.mdx | 71 +
...ishments-garnishment-id.ParamsDetails.json | 1 +
...ishments-garnishment-id.RequestSchema.json | 1 +
...rnishments-garnishment-id.StatusCodes.json | 1 +
...ut-v-1-garnishments-garnishment-id.api.mdx | 71 +
...-1-historical-employees.ParamsDetails.json | 1 +
...-1-historical-employees.RequestSchema.json | 1 +
...-v-1-historical-employees.StatusCodes.json | 1 +
docs/api/put-v-1-historical-employees.api.mdx | 71 +
...esses-home-address-uuid.ParamsDetails.json | 1 +
...esses-home-address-uuid.RequestSchema.json | 1 +
...dresses-home-address-uuid.StatusCodes.json | 1 +
...1-home-addresses-home-address-uuid.api.mdx | 73 +
.../put-v-1-jobs-job-id.ParamsDetails.json | 1 +
.../put-v-1-jobs-job-id.RequestSchema.json | 1 +
docs/api/put-v-1-jobs-job-id.StatusCodes.json | 1 +
docs/api/put-v-1-jobs-job-id.api.mdx | 71 +
...1-locations-location-id.ParamsDetails.json | 1 +
...1-locations-location-id.RequestSchema.json | 1 +
...v-1-locations-location-id.StatusCodes.json | 1 +
.../api/put-v-1-locations-location-id.api.mdx | 71 +
...es-company-uuid-migrate.ParamsDetails.json | 1 +
...es-company-uuid-migrate.RequestSchema.json | 1 +
...nies-company-uuid-migrate.StatusCodes.json | 1 +
...ged-companies-company-uuid-migrate.api.mdx | 73 +
...ecurring-reimbursements.ParamsDetails.json | 1 +
...ecurring-reimbursements.RequestSchema.json | 1 +
...-recurring-reimbursements.StatusCodes.json | 1 +
.../put-v-1-recurring-reimbursements.api.mdx | 71 +
...v-1-salary-estimates-id.ParamsDetails.json | 1 +
...v-1-salary-estimates-id.RequestSchema.json | 1 +
...t-v-1-salary-estimates-id.StatusCodes.json | 1 +
docs/api/put-v-1-salary-estimates-id.api.mdx | 73 +
...-tax-liabilities-finish.ParamsDetails.json | 1 +
...-tax-liabilities-finish.RequestSchema.json | 1 +
...-1-tax-liabilities-finish.StatusCodes.json | 1 +
.../put-v-1-tax-liabilities-finish.api.mdx | 71 +
...put-v-1-tax-liabilities.ParamsDetails.json | 1 +
...put-v-1-tax-liabilities.RequestSchema.json | 1 +
.../put-v-1-tax-liabilities.StatusCodes.json | 1 +
docs/api/put-v-1-tax-liabilities.api.mdx | 71 +
...erminations-employee-id.ParamsDetails.json | 1 +
...erminations-employee-id.RequestSchema.json | 1 +
...-terminations-employee-id.StatusCodes.json | 1 +
.../put-v-1-terminations-employee-id.api.mdx | 73 +
...licy-uuid-add-employees.ParamsDetails.json | 1 +
...licy-uuid-add-employees.RequestSchema.json | 1 +
...policy-uuid-add-employees.StatusCodes.json | 1 +
...time-off-policy-uuid-add-employees.api.mdx | 71 +
...off-policy-uuid-balance.ParamsDetails.json | 1 +
...off-policy-uuid-balance.RequestSchema.json | 1 +
...e-off-policy-uuid-balance.StatusCodes.json | 1 +
...icies-time-off-policy-uuid-balance.api.mdx | 71 +
...-policy-uuid-deactivate.ParamsDetails.json | 1 +
...-policy-uuid-deactivate.RequestSchema.json | 1 +
...ff-policy-uuid-deactivate.StatusCodes.json | 1 +
...es-time-off-policy-uuid-deactivate.api.mdx | 71 +
...y-uuid-remove-employees.ParamsDetails.json | 1 +
...y-uuid-remove-employees.RequestSchema.json | 1 +
...icy-uuid-remove-employees.StatusCodes.json | 1 +
...e-off-policy-uuid-remove-employees.api.mdx | 71 +
...es-time-off-policy-uuid.ParamsDetails.json | 1 +
...es-time-off-policy-uuid.RequestSchema.json | 1 +
...cies-time-off-policy-uuid.StatusCodes.json | 1 +
...-off-policies-time-off-policy-uuid.api.mdx | 71 +
...bhook-subscription-uuid.ParamsDetails.json | 1 +
...bhook-subscription-uuid.RequestSchema.json | 1 +
...webhook-subscription-uuid.StatusCodes.json | 1 +
...1-verify-webhook-subscription-uuid.api.mdx | 78 +
...bhook-subscription-uuid.ParamsDetails.json | 1 +
...bhook-subscription-uuid.RequestSchema.json | 1 +
...webhook-subscription-uuid.StatusCodes.json | 1 +
.../put-v-1-webhook-subscription-uuid.api.mdx | 76 +
...esses-work-address-uuid.ParamsDetails.json | 1 +
...esses-work-address-uuid.RequestSchema.json | 1 +
...dresses-work-address-uuid.StatusCodes.json | 1 +
...1-work-addresses-work-address-uuid.api.mdx | 71 +
...ts-wire-in-request-uuid.ParamsDetails.json | 1 +
...ts-wire-in-request-uuid.RequestSchema.json | 1 +
...ests-wire-in-request-uuid.StatusCodes.json | 1 +
...e-in-requests-wire-in-request-uuid.api.mdx | 71 +
docs/api/recovery-cases.tag.mdx | 20 +
.../redebit-recovery-case.ParamsDetails.json | 1 +
.../redebit-recovery-case.RequestSchema.json | 1 +
.../redebit-recovery-case.StatusCodes.json | 1 +
docs/api/redebit-recovery-case.api.mdx | 75 +
docs/api/reimbursements.tag.mdx | 20 +
docs/api/reports.tag.mdx | 20 +
docs/api/salary-estimates.tag.mdx | 20 +
docs/api/schemas/admin.Schema.json | 1 +
docs/api/schemas/admin.schema.mdx | 32 +
docs/api/schemas/benefit-summary.Schema.json | 1 +
docs/api/schemas/benefit-summary.schema.mdx | 32 +
.../benefit-type-requirements.Schema.json | 1 +
.../benefit-type-requirements.schema.mdx | 32 +
.../schemas/company-attachment.Schema.json | 1 +
.../api/schemas/company-attachment.schema.mdx | 32 +
.../schemas/company-bank-account.Schema.json | 1 +
.../schemas/company-bank-account.schema.mdx | 32 +
.../schemas/company-custom-field.Schema.json | 1 +
.../schemas/company-custom-field.schema.mdx | 32 +
.../company-onboarding-status.Schema.json | 1 +
.../company-onboarding-status.schema.mdx | 32 +
docs/api/schemas/company.Schema.json | 1 +
docs/api/schemas/company.schema.mdx | 32 +
.../contractor-bank-account.Schema.json | 1 +
.../contractor-bank-account.schema.mdx | 32 +
.../contractor-onboarding-status.Schema.json | 1 +
.../contractor-onboarding-status.schema.mdx | 32 +
.../contractor-payment-body.Schema.json | 1 +
.../contractor-payment-body.schema.mdx | 32 +
...ctor-payment-for-group-preview.Schema.json | 1 +
...actor-payment-for-group-preview.schema.mdx | 32 +
.../contractor-payment-for-group.Schema.json | 1 +
.../contractor-payment-for-group.schema.mdx | 32 +
...ntractor-payment-group-minimal.Schema.json | 1 +
...ontractor-payment-group-minimal.schema.mdx | 32 +
...or-payment-group-with-blockers.Schema.json | 1 +
...tor-payment-group-with-blockers.schema.mdx | 32 +
.../contractor-payment-group.Schema.json | 1 +
.../contractor-payment-group.schema.mdx | 32 +
.../contractor-payment-method.Schema.json | 1 +
.../contractor-payment-method.schema.mdx | 32 +
...actor-payment-summary-by-dates.Schema.json | 1 +
...ractor-payment-summary-by-dates.schema.mdx | 32 +
.../contractor-payment-summary.Schema.json | 1 +
.../contractor-payment-summary.schema.mdx | 32 +
.../schemas/contractor-payment.Schema.json | 1 +
.../api/schemas/contractor-payment.schema.mdx | 32 +
docs/api/schemas/contractor.Schema.json | 1 +
docs/api/schemas/contractor.schema.mdx | 32 +
.../contribution-exclusion.Schema.json | 1 +
.../schemas/contribution-exclusion.schema.mdx | 32 +
docs/api/schemas/document-signed.Schema.json | 1 +
docs/api/schemas/document-signed.schema.mdx | 32 +
docs/api/schemas/document.Schema.json | 1 +
docs/api/schemas/document.schema.mdx | 32 +
docs/api/schemas/earning-type.Schema.json | 1 +
docs/api/schemas/earning-type.schema.mdx | 32 +
.../schemas/employee-bank-account.Schema.json | 1 +
.../schemas/employee-bank-account.schema.mdx | 32 +
.../employee-federal-tax-pre-2020.Schema.json | 1 +
.../employee-federal-tax-pre-2020.schema.mdx | 32 +
.../employee-federal-tax-rev-2020.Schema.json | 1 +
.../employee-federal-tax-rev-2020.schema.mdx | 32 +
.../schemas/employee-federal-tax.Schema.json | 1 +
.../schemas/employee-federal-tax.schema.mdx | 32 +
.../api/schemas/employee-pay-stub.Schema.json | 1 +
docs/api/schemas/employee-pay-stub.schema.mdx | 32 +
.../employee-payment-method.Schema.json | 1 +
.../employee-payment-method.schema.mdx | 32 +
.../schemas/employee-state-tax.Schema.json | 1 +
.../api/schemas/employee-state-tax.schema.mdx | 32 +
.../external-payroll-basic.Schema.json | 1 +
.../schemas/external-payroll-basic.schema.mdx | 32 +
...ternal-payroll-tax-suggestions.Schema.json | 1 +
...xternal-payroll-tax-suggestions.schema.mdx | 32 +
docs/api/schemas/external-payroll.Schema.json | 1 +
docs/api/schemas/external-payroll.schema.mdx | 32 +
.../schemas/federal-tax-details.Schema.json | 1 +
.../schemas/federal-tax-details.schema.mdx | 32 +
docs/api/schemas/flow.Schema.json | 1 +
docs/api/schemas/flow.schema.mdx | 32 +
docs/api/schemas/form.Schema.json | 1 +
docs/api/schemas/form.schema.mdx | 32 +
...-authorization-document-option.Schema.json | 1 +
...9-authorization-document-option.schema.mdx | 32 +
.../i-9-authorization-document.Schema.json | 1 +
.../i-9-authorization-document.schema.mdx | 32 +
.../api/schemas/i-9-authorization.Schema.json | 1 +
docs/api/schemas/i-9-authorization.schema.mdx | 32 +
docs/api/schemas/industry.Schema.json | 1 +
docs/api/schemas/industry.schema.mdx | 32 +
docs/api/schemas/pay-period.Schema.json | 1 +
docs/api/schemas/pay-period.schema.mdx | 32 +
...schedule-assignment-department.Schema.json | 1 +
...-schedule-assignment-department.schema.mdx | 32 +
...ule-assignment-employee-change.Schema.json | 1 +
...dule-assignment-employee-change.schema.mdx | 32 +
...y-schedule-assignment-employee.Schema.json | 1 +
...ay-schedule-assignment-employee.schema.mdx | 32 +
...schedule-assignment-pay-period.Schema.json | 1 +
...-schedule-assignment-pay-period.schema.mdx | 32 +
...ay-schedule-assignment-preview.Schema.json | 1 +
...pay-schedule-assignment-preview.schema.mdx | 32 +
...signment-transition-pay-period.Schema.json | 1 +
...ssignment-transition-pay-period.schema.mdx | 32 +
.../pay-schedule-assignment.Schema.json | 1 +
.../pay-schedule-assignment.schema.mdx | 32 +
docs/api/schemas/pay-schedule.Schema.json | 1 +
docs/api/schemas/pay-schedule.schema.mdx | 32 +
docs/api/schemas/payment-configs.Schema.json | 1 +
docs/api/schemas/payment-configs.schema.mdx | 32 +
docs/api/schemas/payroll-minimal.Schema.json | 1 +
docs/api/schemas/payroll-minimal.schema.mdx | 32 +
.../signatory-create-request.Schema.json | 1 +
.../signatory-create-request.schema.mdx | 32 +
.../signatory-invite-request.Schema.json | 1 +
.../signatory-invite-request.schema.mdx | 32 +
.../signatory-update-request.Schema.json | 1 +
.../signatory-update-request.schema.mdx | 32 +
docs/api/schemas/signatory.Schema.json | 1 +
docs/api/schemas/signatory.schema.mdx | 32 +
.../tax-liabilities-selections.Schema.json | 1 +
.../tax-liabilities-selections.schema.mdx | 32 +
...ocessed-termination-pay-period.Schema.json | 1 +
...rocessed-termination-pay-period.schema.mdx | 32 +
.../schemas/webhook-subscription.Schema.json | 1 +
.../schemas/webhook-subscription.schema.mdx | 32 +
docs/api/sidebar.ts | 2608 +++++++++++++++++
docs/api/signatories.tag.mdx | 20 +
...mit-information-request.ParamsDetails.json | 1 +
...mit-information-request.RequestSchema.json | 1 +
...ubmit-information-request.StatusCodes.json | 1 +
docs/api/submit-information-request.api.mdx | 73 +
docs/api/tax-requirements.tag.mdx | 20 +
docs/api/time-off-policies.tag.mdx | 20 +
docs/api/webhooks.tag.mdx | 20 +
docs/api/wire-in-requests.tag.mdx | 20 +
.../component-adapter-faq.md | 2 -
.../component-adapter-types.md | 2 -
docs/component-adapter/component-adapter.md | 2 -
.../how-the-component-adapter-works.md | 6 +-
.../setting-up-your-component-adapter.md | 8 +-
docs/getting-started/authentication.md | 6 +-
docs/getting-started/getting-started.md | 2 +-
.../proxy-security-partner-guidance.md | 2 -
docs/hooks/hooks.md | 4 +-
docs/hooks/useCompensationForm.md | 2 -
docs/hooks/useEmployeeDetailsForm.md | 2 -
docs/hooks/useWorkAddressForm.md | 2 -
docs/integration-guide/composition.md | 4 +-
docs/integration-guide/customizing-sdk-ui.md | 4 +-
docs/integration-guide/error-handling.md | 2 -
docs/integration-guide/event-handling.md | 4 +-
docs/integration-guide/integration-guide.md | 2 +-
docs/integration-guide/observability.md | 2 -
docs/integration-guide/routing.md | 3 +-
docs/integration-guide/translation.md | 4 +-
docs/reference/endpoint-reference.md | 2 -
docs/reference/proxy-examples.md | 2 -
docs/theming/theme-variables.md | 2 -
docs/theming/theming-guide.md | 12 +-
docs/theming/theming.md | 2 -
docs/what-is-the-gep-react-sdk.md | 59 +-
docs/workflows-overview/company-onboarding.md | 34 +-
.../employee-onboarding.md | 112 +-
.../employee-self-onboarding.md | 2 +-
.../information-requests.md | 111 +
docs/workflows-overview/run-payroll.md | 220 ++
docs/workflows-overview/workflows-overview.md | 5 +-
e2e/package-lock.json | 2439 +++++++++++++++
website/.gitignore | 6 +
website/docusaurus.config.ts | 168 ++
website/package.json | 52 +
website/sidebars.ts | 132 +
website/src/css/custom.css | 532 ++++
website/src/pages/index.module.css | 344 +++
website/src/pages/index.tsx | 190 ++
website/src/theme/NotFound/Content/index.tsx | 44 +
.../theme/NotFound/Content/styles.module.css | 144 +
website/static/img/favicon.svg | 4 +
website/static/img/gusto-logo-dark.svg | 1 +
website/static/img/gusto-logo.svg | 1 +
website/tsconfig.json | 6 +
1345 files changed, 31781 insertions(+), 143 deletions(-)
create mode 100644 docs/api/ach-transactions.tag.mdx
create mode 100644 docs/api/bank-accounts.tag.mdx
create mode 100644 docs/api/companies.tag.mdx
create mode 100644 docs/api/company-attachment.tag.mdx
create mode 100644 docs/api/company-benefits.tag.mdx
create mode 100644 docs/api/company-forms.tag.mdx
create mode 100644 docs/api/contractor-documents.tag.mdx
create mode 100644 docs/api/contractor-forms.tag.mdx
create mode 100644 docs/api/contractor-payment-groups.tag.mdx
create mode 100644 docs/api/contractor-payment-method.tag.mdx
create mode 100644 docs/api/contractor-payments.tag.mdx
create mode 100644 docs/api/contractors.tag.mdx
create mode 100644 docs/api/delete-department.ParamsDetails.json
create mode 100644 docs/api/delete-department.RequestSchema.json
create mode 100644 docs/api/delete-department.StatusCodes.json
create mode 100644 docs/api/delete-department.api.mdx
create mode 100644 docs/api/delete-v-1-companies-company-id-bank-accounts-bank-account-id.ParamsDetails.json
create mode 100644 docs/api/delete-v-1-companies-company-id-bank-accounts-bank-account-id.RequestSchema.json
create mode 100644 docs/api/delete-v-1-companies-company-id-bank-accounts-bank-account-id.StatusCodes.json
create mode 100644 docs/api/delete-v-1-companies-company-id-bank-accounts-bank-account-id.api.mdx
create mode 100644 docs/api/delete-v-1-companies-company-id-contractor-payment-contractor-payment.ParamsDetails.json
create mode 100644 docs/api/delete-v-1-companies-company-id-contractor-payment-contractor-payment.RequestSchema.json
create mode 100644 docs/api/delete-v-1-companies-company-id-contractor-payment-contractor-payment.StatusCodes.json
create mode 100644 docs/api/delete-v-1-companies-company-id-contractor-payment-contractor-payment.api.mdx
create mode 100644 docs/api/delete-v-1-companies-company-id-earning-types-earning-type-uuid.ParamsDetails.json
create mode 100644 docs/api/delete-v-1-companies-company-id-earning-types-earning-type-uuid.RequestSchema.json
create mode 100644 docs/api/delete-v-1-companies-company-id-earning-types-earning-type-uuid.StatusCodes.json
create mode 100644 docs/api/delete-v-1-companies-company-id-earning-types-earning-type-uuid.api.mdx
create mode 100644 docs/api/delete-v-1-companies-company-id-payrolls.ParamsDetails.json
create mode 100644 docs/api/delete-v-1-companies-company-id-payrolls.RequestSchema.json
create mode 100644 docs/api/delete-v-1-companies-company-id-payrolls.StatusCodes.json
create mode 100644 docs/api/delete-v-1-companies-company-id-payrolls.api.mdx
create mode 100644 docs/api/delete-v-1-companies-company-uuid-holiday-pay-policy.ParamsDetails.json
create mode 100644 docs/api/delete-v-1-companies-company-uuid-holiday-pay-policy.RequestSchema.json
create mode 100644 docs/api/delete-v-1-companies-company-uuid-holiday-pay-policy.StatusCodes.json
create mode 100644 docs/api/delete-v-1-companies-company-uuid-holiday-pay-policy.api.mdx
create mode 100644 docs/api/delete-v-1-companies-company-uuid-signatories-signatory-uuid.ParamsDetails.json
create mode 100644 docs/api/delete-v-1-companies-company-uuid-signatories-signatory-uuid.RequestSchema.json
create mode 100644 docs/api/delete-v-1-companies-company-uuid-signatories-signatory-uuid.StatusCodes.json
create mode 100644 docs/api/delete-v-1-companies-company-uuid-signatories-signatory-uuid.api.mdx
create mode 100644 docs/api/delete-v-1-company-benefits-company-benefit-id.ParamsDetails.json
create mode 100644 docs/api/delete-v-1-company-benefits-company-benefit-id.RequestSchema.json
create mode 100644 docs/api/delete-v-1-company-benefits-company-benefit-id.StatusCodes.json
create mode 100644 docs/api/delete-v-1-company-benefits-company-benefit-id.api.mdx
create mode 100644 docs/api/delete-v-1-compensations-compensation-id.ParamsDetails.json
create mode 100644 docs/api/delete-v-1-compensations-compensation-id.RequestSchema.json
create mode 100644 docs/api/delete-v-1-compensations-compensation-id.StatusCodes.json
create mode 100644 docs/api/delete-v-1-compensations-compensation-id.api.mdx
create mode 100644 docs/api/delete-v-1-contractor-payment-groups-contractor-payment-group-id.ParamsDetails.json
create mode 100644 docs/api/delete-v-1-contractor-payment-groups-contractor-payment-group-id.RequestSchema.json
create mode 100644 docs/api/delete-v-1-contractor-payment-groups-contractor-payment-group-id.StatusCodes.json
create mode 100644 docs/api/delete-v-1-contractor-payment-groups-contractor-payment-group-id.api.mdx
create mode 100644 docs/api/delete-v-1-contractors-contractor-uuid.ParamsDetails.json
create mode 100644 docs/api/delete-v-1-contractors-contractor-uuid.RequestSchema.json
create mode 100644 docs/api/delete-v-1-contractors-contractor-uuid.StatusCodes.json
create mode 100644 docs/api/delete-v-1-contractors-contractor-uuid.api.mdx
create mode 100644 docs/api/delete-v-1-employee-benefits-employee-benefit-id.ParamsDetails.json
create mode 100644 docs/api/delete-v-1-employee-benefits-employee-benefit-id.RequestSchema.json
create mode 100644 docs/api/delete-v-1-employee-benefits-employee-benefit-id.StatusCodes.json
create mode 100644 docs/api/delete-v-1-employee-benefits-employee-benefit-id.api.mdx
create mode 100644 docs/api/delete-v-1-employee.ParamsDetails.json
create mode 100644 docs/api/delete-v-1-employee.RequestSchema.json
create mode 100644 docs/api/delete-v-1-employee.StatusCodes.json
create mode 100644 docs/api/delete-v-1-employee.api.mdx
create mode 100644 docs/api/delete-v-1-employees-employee-id-bank-accounts-bank-account-id.ParamsDetails.json
create mode 100644 docs/api/delete-v-1-employees-employee-id-bank-accounts-bank-account-id.RequestSchema.json
create mode 100644 docs/api/delete-v-1-employees-employee-id-bank-accounts-bank-account-id.StatusCodes.json
create mode 100644 docs/api/delete-v-1-employees-employee-id-bank-accounts-bank-account-id.api.mdx
create mode 100644 docs/api/delete-v-1-employees-employee-id-i-9-authorization-documents-document-id.ParamsDetails.json
create mode 100644 docs/api/delete-v-1-employees-employee-id-i-9-authorization-documents-document-id.RequestSchema.json
create mode 100644 docs/api/delete-v-1-employees-employee-id-i-9-authorization-documents-document-id.StatusCodes.json
create mode 100644 docs/api/delete-v-1-employees-employee-id-i-9-authorization-documents-document-id.api.mdx
create mode 100644 docs/api/delete-v-1-employees-employee-id-rehire.ParamsDetails.json
create mode 100644 docs/api/delete-v-1-employees-employee-id-rehire.RequestSchema.json
create mode 100644 docs/api/delete-v-1-employees-employee-id-rehire.StatusCodes.json
create mode 100644 docs/api/delete-v-1-employees-employee-id-rehire.api.mdx
create mode 100644 docs/api/delete-v-1-employees-employee-id-terminations.ParamsDetails.json
create mode 100644 docs/api/delete-v-1-employees-employee-id-terminations.RequestSchema.json
create mode 100644 docs/api/delete-v-1-employees-employee-id-terminations.StatusCodes.json
create mode 100644 docs/api/delete-v-1-employees-employee-id-terminations.api.mdx
create mode 100644 docs/api/delete-v-1-external-payroll.ParamsDetails.json
create mode 100644 docs/api/delete-v-1-external-payroll.RequestSchema.json
create mode 100644 docs/api/delete-v-1-external-payroll.StatusCodes.json
create mode 100644 docs/api/delete-v-1-external-payroll.api.mdx
create mode 100644 docs/api/delete-v-1-home-addresses-home-address-uuid.ParamsDetails.json
create mode 100644 docs/api/delete-v-1-home-addresses-home-address-uuid.RequestSchema.json
create mode 100644 docs/api/delete-v-1-home-addresses-home-address-uuid.StatusCodes.json
create mode 100644 docs/api/delete-v-1-home-addresses-home-address-uuid.api.mdx
create mode 100644 docs/api/delete-v-1-jobs-job-id.ParamsDetails.json
create mode 100644 docs/api/delete-v-1-jobs-job-id.RequestSchema.json
create mode 100644 docs/api/delete-v-1-jobs-job-id.StatusCodes.json
create mode 100644 docs/api/delete-v-1-jobs-job-id.api.mdx
create mode 100644 docs/api/delete-v-1-recurring-reimbursements.ParamsDetails.json
create mode 100644 docs/api/delete-v-1-recurring-reimbursements.RequestSchema.json
create mode 100644 docs/api/delete-v-1-recurring-reimbursements.StatusCodes.json
create mode 100644 docs/api/delete-v-1-recurring-reimbursements.api.mdx
create mode 100644 docs/api/delete-v-1-webhook-subscription-uuid.ParamsDetails.json
create mode 100644 docs/api/delete-v-1-webhook-subscription-uuid.RequestSchema.json
create mode 100644 docs/api/delete-v-1-webhook-subscription-uuid.StatusCodes.json
create mode 100644 docs/api/delete-v-1-webhook-subscription-uuid.api.mdx
create mode 100644 docs/api/delete-v-1-work-addresses-work-address-uuid.ParamsDetails.json
create mode 100644 docs/api/delete-v-1-work-addresses-work-address-uuid.RequestSchema.json
create mode 100644 docs/api/delete-v-1-work-addresses-work-address-uuid.StatusCodes.json
create mode 100644 docs/api/delete-v-1-work-addresses-work-address-uuid.api.mdx
create mode 100644 docs/api/departments.tag.mdx
create mode 100644 docs/api/earning-types.tag.mdx
create mode 100644 docs/api/employee-addresses.tag.mdx
create mode 100644 docs/api/employee-benefits.tag.mdx
create mode 100644 docs/api/employee-employments.tag.mdx
create mode 100644 docs/api/employee-forms.tag.mdx
create mode 100644 docs/api/employee-payment-method.tag.mdx
create mode 100644 docs/api/employee-tax-setup.tag.mdx
create mode 100644 docs/api/employees.tag.mdx
create mode 100644 docs/api/events.tag.mdx
create mode 100644 docs/api/external-payrolls.tag.mdx
create mode 100644 docs/api/federal-tax-details.tag.mdx
create mode 100644 docs/api/flows.tag.mdx
create mode 100644 docs/api/garnishments.tag.mdx
create mode 100644 docs/api/generated-documents.tag.mdx
create mode 100644 docs/api/get-ach-transactions.ParamsDetails.json
create mode 100644 docs/api/get-ach-transactions.RequestSchema.json
create mode 100644 docs/api/get-ach-transactions.StatusCodes.json
create mode 100644 docs/api/get-ach-transactions.api.mdx
create mode 100644 docs/api/get-companies-company-uuid-contractor-payments-preview.ParamsDetails.json
create mode 100644 docs/api/get-companies-company-uuid-contractor-payments-preview.RequestSchema.json
create mode 100644 docs/api/get-companies-company-uuid-contractor-payments-preview.StatusCodes.json
create mode 100644 docs/api/get-companies-company-uuid-contractor-payments-preview.api.mdx
create mode 100644 docs/api/get-companies-company-uuid-paid-holidays.ParamsDetails.json
create mode 100644 docs/api/get-companies-company-uuid-paid-holidays.RequestSchema.json
create mode 100644 docs/api/get-companies-company-uuid-paid-holidays.StatusCodes.json
create mode 100644 docs/api/get-companies-company-uuid-paid-holidays.api.mdx
create mode 100644 docs/api/get-companies-company-uuid-report-templates-report-type.ParamsDetails.json
create mode 100644 docs/api/get-companies-company-uuid-report-templates-report-type.RequestSchema.json
create mode 100644 docs/api/get-companies-company-uuid-report-templates-report-type.StatusCodes.json
create mode 100644 docs/api/get-companies-company-uuid-report-templates-report-type.api.mdx
create mode 100644 docs/api/get-companies-company-uuid-suspensions.ParamsDetails.json
create mode 100644 docs/api/get-companies-company-uuid-suspensions.RequestSchema.json
create mode 100644 docs/api/get-companies-company-uuid-suspensions.StatusCodes.json
create mode 100644 docs/api/get-companies-company-uuid-suspensions.api.mdx
create mode 100644 docs/api/get-companies-company-uuid-wire-in-request-uuid.ParamsDetails.json
create mode 100644 docs/api/get-companies-company-uuid-wire-in-request-uuid.RequestSchema.json
create mode 100644 docs/api/get-companies-company-uuid-wire-in-request-uuid.StatusCodes.json
create mode 100644 docs/api/get-companies-company-uuid-wire-in-request-uuid.api.mdx
create mode 100644 docs/api/get-companies-departments.ParamsDetails.json
create mode 100644 docs/api/get-companies-departments.RequestSchema.json
create mode 100644 docs/api/get-companies-departments.StatusCodes.json
create mode 100644 docs/api/get-companies-departments.api.mdx
create mode 100644 docs/api/get-company-notifications.ParamsDetails.json
create mode 100644 docs/api/get-company-notifications.RequestSchema.json
create mode 100644 docs/api/get-company-notifications.StatusCodes.json
create mode 100644 docs/api/get-company-notifications.api.mdx
create mode 100644 docs/api/get-department.ParamsDetails.json
create mode 100644 docs/api/get-department.RequestSchema.json
create mode 100644 docs/api/get-department.StatusCodes.json
create mode 100644 docs/api/get-department.api.mdx
create mode 100644 docs/api/get-employee-ytd-benefit-amounts-from-different-company.ParamsDetails.json
create mode 100644 docs/api/get-employee-ytd-benefit-amounts-from-different-company.RequestSchema.json
create mode 100644 docs/api/get-employee-ytd-benefit-amounts-from-different-company.StatusCodes.json
create mode 100644 docs/api/get-employee-ytd-benefit-amounts-from-different-company.api.mdx
create mode 100644 docs/api/get-events.ParamsDetails.json
create mode 100644 docs/api/get-events.RequestSchema.json
create mode 100644 docs/api/get-events.StatusCodes.json
create mode 100644 docs/api/get-events.api.mdx
create mode 100644 docs/api/get-information-requests.ParamsDetails.json
create mode 100644 docs/api/get-information-requests.RequestSchema.json
create mode 100644 docs/api/get-information-requests.StatusCodes.json
create mode 100644 docs/api/get-information-requests.api.mdx
create mode 100644 docs/api/get-invoices-invoice-period.ParamsDetails.json
create mode 100644 docs/api/get-invoices-invoice-period.RequestSchema.json
create mode 100644 docs/api/get-invoices-invoice-period.StatusCodes.json
create mode 100644 docs/api/get-invoices-invoice-period.api.mdx
create mode 100644 docs/api/get-notifications-notification-uuid.ParamsDetails.json
create mode 100644 docs/api/get-notifications-notification-uuid.RequestSchema.json
create mode 100644 docs/api/get-notifications-notification-uuid.StatusCodes.json
create mode 100644 docs/api/get-notifications-notification-uuid.api.mdx
create mode 100644 docs/api/get-recovery-cases.ParamsDetails.json
create mode 100644 docs/api/get-recovery-cases.RequestSchema.json
create mode 100644 docs/api/get-recovery-cases.StatusCodes.json
create mode 100644 docs/api/get-recovery-cases.api.mdx
create mode 100644 docs/api/get-reports-request-uuid.ParamsDetails.json
create mode 100644 docs/api/get-reports-request-uuid.RequestSchema.json
create mode 100644 docs/api/get-reports-request-uuid.StatusCodes.json
create mode 100644 docs/api/get-reports-request-uuid.api.mdx
create mode 100644 docs/api/get-v-1-benefits-benefit-id.ParamsDetails.json
create mode 100644 docs/api/get-v-1-benefits-benefit-id.RequestSchema.json
create mode 100644 docs/api/get-v-1-benefits-benefit-id.StatusCodes.json
create mode 100644 docs/api/get-v-1-benefits-benefit-id.api.mdx
create mode 100644 docs/api/get-v-1-benefits-benefits-id-requirements.ParamsDetails.json
create mode 100644 docs/api/get-v-1-benefits-benefits-id-requirements.RequestSchema.json
create mode 100644 docs/api/get-v-1-benefits-benefits-id-requirements.StatusCodes.json
create mode 100644 docs/api/get-v-1-benefits-benefits-id-requirements.api.mdx
create mode 100644 docs/api/get-v-1-benefits-company-benefit-id-summary.ParamsDetails.json
create mode 100644 docs/api/get-v-1-benefits-company-benefit-id-summary.RequestSchema.json
create mode 100644 docs/api/get-v-1-benefits-company-benefit-id-summary.StatusCodes.json
create mode 100644 docs/api/get-v-1-benefits-company-benefit-id-summary.api.mdx
create mode 100644 docs/api/get-v-1-benefits.ParamsDetails.json
create mode 100644 docs/api/get-v-1-benefits.RequestSchema.json
create mode 100644 docs/api/get-v-1-benefits.StatusCodes.json
create mode 100644 docs/api/get-v-1-benefits.api.mdx
create mode 100644 docs/api/get-v-1-companies-attachment-url.ParamsDetails.json
create mode 100644 docs/api/get-v-1-companies-attachment-url.RequestSchema.json
create mode 100644 docs/api/get-v-1-companies-attachment-url.StatusCodes.json
create mode 100644 docs/api/get-v-1-companies-attachment-url.api.mdx
create mode 100644 docs/api/get-v-1-companies-attachment.ParamsDetails.json
create mode 100644 docs/api/get-v-1-companies-attachment.RequestSchema.json
create mode 100644 docs/api/get-v-1-companies-attachment.StatusCodes.json
create mode 100644 docs/api/get-v-1-companies-attachment.api.mdx
create mode 100644 docs/api/get-v-1-companies-attachments.ParamsDetails.json
create mode 100644 docs/api/get-v-1-companies-attachments.RequestSchema.json
create mode 100644 docs/api/get-v-1-companies-attachments.StatusCodes.json
create mode 100644 docs/api/get-v-1-companies-attachments.api.mdx
create mode 100644 docs/api/get-v-1-companies-company-id-admins.ParamsDetails.json
create mode 100644 docs/api/get-v-1-companies-company-id-admins.RequestSchema.json
create mode 100644 docs/api/get-v-1-companies-company-id-admins.StatusCodes.json
create mode 100644 docs/api/get-v-1-companies-company-id-admins.api.mdx
create mode 100644 docs/api/get-v-1-companies-company-id-bank-accounts.ParamsDetails.json
create mode 100644 docs/api/get-v-1-companies-company-id-bank-accounts.RequestSchema.json
create mode 100644 docs/api/get-v-1-companies-company-id-bank-accounts.StatusCodes.json
create mode 100644 docs/api/get-v-1-companies-company-id-bank-accounts.api.mdx
create mode 100644 docs/api/get-v-1-companies-company-id-company-benefits.ParamsDetails.json
create mode 100644 docs/api/get-v-1-companies-company-id-company-benefits.RequestSchema.json
create mode 100644 docs/api/get-v-1-companies-company-id-company-benefits.StatusCodes.json
create mode 100644 docs/api/get-v-1-companies-company-id-company-benefits.api.mdx
create mode 100644 docs/api/get-v-1-companies-company-id-contractor-payment-contractor-payment.ParamsDetails.json
create mode 100644 docs/api/get-v-1-companies-company-id-contractor-payment-contractor-payment.RequestSchema.json
create mode 100644 docs/api/get-v-1-companies-company-id-contractor-payment-contractor-payment.StatusCodes.json
create mode 100644 docs/api/get-v-1-companies-company-id-contractor-payment-contractor-payment.api.mdx
create mode 100644 docs/api/get-v-1-companies-company-id-contractor-payment-groups.ParamsDetails.json
create mode 100644 docs/api/get-v-1-companies-company-id-contractor-payment-groups.RequestSchema.json
create mode 100644 docs/api/get-v-1-companies-company-id-contractor-payment-groups.StatusCodes.json
create mode 100644 docs/api/get-v-1-companies-company-id-contractor-payment-groups.api.mdx
create mode 100644 docs/api/get-v-1-companies-company-id-contractor-payments.ParamsDetails.json
create mode 100644 docs/api/get-v-1-companies-company-id-contractor-payments.RequestSchema.json
create mode 100644 docs/api/get-v-1-companies-company-id-contractor-payments.StatusCodes.json
create mode 100644 docs/api/get-v-1-companies-company-id-contractor-payments.api.mdx
create mode 100644 docs/api/get-v-1-companies-company-id-contractors-payment-details.ParamsDetails.json
create mode 100644 docs/api/get-v-1-companies-company-id-contractors-payment-details.RequestSchema.json
create mode 100644 docs/api/get-v-1-companies-company-id-contractors-payment-details.StatusCodes.json
create mode 100644 docs/api/get-v-1-companies-company-id-contractors-payment-details.api.mdx
create mode 100644 docs/api/get-v-1-companies-company-id-custom-fields.ParamsDetails.json
create mode 100644 docs/api/get-v-1-companies-company-id-custom-fields.RequestSchema.json
create mode 100644 docs/api/get-v-1-companies-company-id-custom-fields.StatusCodes.json
create mode 100644 docs/api/get-v-1-companies-company-id-custom-fields.api.mdx
create mode 100644 docs/api/get-v-1-companies-company-id-earning-types.ParamsDetails.json
create mode 100644 docs/api/get-v-1-companies-company-id-earning-types.RequestSchema.json
create mode 100644 docs/api/get-v-1-companies-company-id-earning-types.StatusCodes.json
create mode 100644 docs/api/get-v-1-companies-company-id-earning-types.api.mdx
create mode 100644 docs/api/get-v-1-companies-company-id-employees-payment-details.ParamsDetails.json
create mode 100644 docs/api/get-v-1-companies-company-id-employees-payment-details.RequestSchema.json
create mode 100644 docs/api/get-v-1-companies-company-id-employees-payment-details.StatusCodes.json
create mode 100644 docs/api/get-v-1-companies-company-id-employees-payment-details.api.mdx
create mode 100644 docs/api/get-v-1-companies-company-id-employees.ParamsDetails.json
create mode 100644 docs/api/get-v-1-companies-company-id-employees.RequestSchema.json
create mode 100644 docs/api/get-v-1-companies-company-id-employees.StatusCodes.json
create mode 100644 docs/api/get-v-1-companies-company-id-employees.api.mdx
create mode 100644 docs/api/get-v-1-companies-company-id-federal-tax-details.ParamsDetails.json
create mode 100644 docs/api/get-v-1-companies-company-id-federal-tax-details.RequestSchema.json
create mode 100644 docs/api/get-v-1-companies-company-id-federal-tax-details.StatusCodes.json
create mode 100644 docs/api/get-v-1-companies-company-id-federal-tax-details.api.mdx
create mode 100644 docs/api/get-v-1-companies-company-id-locations.ParamsDetails.json
create mode 100644 docs/api/get-v-1-companies-company-id-locations.RequestSchema.json
create mode 100644 docs/api/get-v-1-companies-company-id-locations.StatusCodes.json
create mode 100644 docs/api/get-v-1-companies-company-id-locations.api.mdx
create mode 100644 docs/api/get-v-1-companies-company-id-pay-periods.ParamsDetails.json
create mode 100644 docs/api/get-v-1-companies-company-id-pay-periods.RequestSchema.json
create mode 100644 docs/api/get-v-1-companies-company-id-pay-periods.StatusCodes.json
create mode 100644 docs/api/get-v-1-companies-company-id-pay-periods.api.mdx
create mode 100644 docs/api/get-v-1-companies-company-id-pay-schedules-assignments.ParamsDetails.json
create mode 100644 docs/api/get-v-1-companies-company-id-pay-schedules-assignments.RequestSchema.json
create mode 100644 docs/api/get-v-1-companies-company-id-pay-schedules-assignments.StatusCodes.json
create mode 100644 docs/api/get-v-1-companies-company-id-pay-schedules-assignments.api.mdx
create mode 100644 docs/api/get-v-1-companies-company-id-pay-schedules-pay-schedule-id.ParamsDetails.json
create mode 100644 docs/api/get-v-1-companies-company-id-pay-schedules-pay-schedule-id.RequestSchema.json
create mode 100644 docs/api/get-v-1-companies-company-id-pay-schedules-pay-schedule-id.StatusCodes.json
create mode 100644 docs/api/get-v-1-companies-company-id-pay-schedules-pay-schedule-id.api.mdx
create mode 100644 docs/api/get-v-1-companies-company-id-pay-schedules-preview.ParamsDetails.json
create mode 100644 docs/api/get-v-1-companies-company-id-pay-schedules-preview.RequestSchema.json
create mode 100644 docs/api/get-v-1-companies-company-id-pay-schedules-preview.StatusCodes.json
create mode 100644 docs/api/get-v-1-companies-company-id-pay-schedules-preview.api.mdx
create mode 100644 docs/api/get-v-1-companies-company-id-pay-schedules.ParamsDetails.json
create mode 100644 docs/api/get-v-1-companies-company-id-pay-schedules.RequestSchema.json
create mode 100644 docs/api/get-v-1-companies-company-id-pay-schedules.StatusCodes.json
create mode 100644 docs/api/get-v-1-companies-company-id-pay-schedules.api.mdx
create mode 100644 docs/api/get-v-1-companies-company-id-payroll-reversals.ParamsDetails.json
create mode 100644 docs/api/get-v-1-companies-company-id-payroll-reversals.RequestSchema.json
create mode 100644 docs/api/get-v-1-companies-company-id-payroll-reversals.StatusCodes.json
create mode 100644 docs/api/get-v-1-companies-company-id-payroll-reversals.api.mdx
create mode 100644 docs/api/get-v-1-companies-company-id-payrolls-id-partner-disbursements.ParamsDetails.json
create mode 100644 docs/api/get-v-1-companies-company-id-payrolls-id-partner-disbursements.RequestSchema.json
create mode 100644 docs/api/get-v-1-companies-company-id-payrolls-id-partner-disbursements.StatusCodes.json
create mode 100644 docs/api/get-v-1-companies-company-id-payrolls-id-partner-disbursements.api.mdx
create mode 100644 docs/api/get-v-1-companies-company-id-payrolls-payroll-id.ParamsDetails.json
create mode 100644 docs/api/get-v-1-companies-company-id-payrolls-payroll-id.RequestSchema.json
create mode 100644 docs/api/get-v-1-companies-company-id-payrolls-payroll-id.StatusCodes.json
create mode 100644 docs/api/get-v-1-companies-company-id-payrolls-payroll-id.api.mdx
create mode 100644 docs/api/get-v-1-companies-company-id-payrolls.ParamsDetails.json
create mode 100644 docs/api/get-v-1-companies-company-id-payrolls.RequestSchema.json
create mode 100644 docs/api/get-v-1-companies-company-id-payrolls.StatusCodes.json
create mode 100644 docs/api/get-v-1-companies-company-id-payrolls.api.mdx
create mode 100644 docs/api/get-v-1-companies-company-id-unprocessed-termination-pay-periods.ParamsDetails.json
create mode 100644 docs/api/get-v-1-companies-company-id-unprocessed-termination-pay-periods.RequestSchema.json
create mode 100644 docs/api/get-v-1-companies-company-id-unprocessed-termination-pay-periods.StatusCodes.json
create mode 100644 docs/api/get-v-1-companies-company-id-unprocessed-termination-pay-periods.api.mdx
create mode 100644 docs/api/get-v-1-companies-company-uuid-contractors.ParamsDetails.json
create mode 100644 docs/api/get-v-1-companies-company-uuid-contractors.RequestSchema.json
create mode 100644 docs/api/get-v-1-companies-company-uuid-contractors.StatusCodes.json
create mode 100644 docs/api/get-v-1-companies-company-uuid-contractors.api.mdx
create mode 100644 docs/api/get-v-1-companies-company-uuid-holiday-pay-policy.ParamsDetails.json
create mode 100644 docs/api/get-v-1-companies-company-uuid-holiday-pay-policy.RequestSchema.json
create mode 100644 docs/api/get-v-1-companies-company-uuid-holiday-pay-policy.StatusCodes.json
create mode 100644 docs/api/get-v-1-companies-company-uuid-holiday-pay-policy.api.mdx
create mode 100644 docs/api/get-v-1-companies-company-uuid-signatories.ParamsDetails.json
create mode 100644 docs/api/get-v-1-companies-company-uuid-signatories.RequestSchema.json
create mode 100644 docs/api/get-v-1-companies-company-uuid-signatories.StatusCodes.json
create mode 100644 docs/api/get-v-1-companies-company-uuid-signatories.api.mdx
create mode 100644 docs/api/get-v-1-companies-company-uuid-tax-requirements-state.ParamsDetails.json
create mode 100644 docs/api/get-v-1-companies-company-uuid-tax-requirements-state.RequestSchema.json
create mode 100644 docs/api/get-v-1-companies-company-uuid-tax-requirements-state.StatusCodes.json
create mode 100644 docs/api/get-v-1-companies-company-uuid-tax-requirements-state.api.mdx
create mode 100644 docs/api/get-v-1-companies-company-uuid-tax-requirements.ParamsDetails.json
create mode 100644 docs/api/get-v-1-companies-company-uuid-tax-requirements.RequestSchema.json
create mode 100644 docs/api/get-v-1-companies-company-uuid-tax-requirements.StatusCodes.json
create mode 100644 docs/api/get-v-1-companies-company-uuid-tax-requirements.api.mdx
create mode 100644 docs/api/get-v-1-companies-company-uuid-time-off-policies.ParamsDetails.json
create mode 100644 docs/api/get-v-1-companies-company-uuid-time-off-policies.RequestSchema.json
create mode 100644 docs/api/get-v-1-companies-company-uuid-time-off-policies.StatusCodes.json
create mode 100644 docs/api/get-v-1-companies-company-uuid-time-off-policies.api.mdx
create mode 100644 docs/api/get-v-1-companies-payroll-blockers-company-uuid.ParamsDetails.json
create mode 100644 docs/api/get-v-1-companies-payroll-blockers-company-uuid.RequestSchema.json
create mode 100644 docs/api/get-v-1-companies-payroll-blockers-company-uuid.StatusCodes.json
create mode 100644 docs/api/get-v-1-companies-payroll-blockers-company-uuid.api.mdx
create mode 100644 docs/api/get-v-1-companies.ParamsDetails.json
create mode 100644 docs/api/get-v-1-companies.RequestSchema.json
create mode 100644 docs/api/get-v-1-companies.StatusCodes.json
create mode 100644 docs/api/get-v-1-companies.api.mdx
create mode 100644 docs/api/get-v-1-company-benefits-company-benefit-id-contribution-exclusions.ParamsDetails.json
create mode 100644 docs/api/get-v-1-company-benefits-company-benefit-id-contribution-exclusions.RequestSchema.json
create mode 100644 docs/api/get-v-1-company-benefits-company-benefit-id-contribution-exclusions.StatusCodes.json
create mode 100644 docs/api/get-v-1-company-benefits-company-benefit-id-contribution-exclusions.api.mdx
create mode 100644 docs/api/get-v-1-company-benefits-company-benefit-id-employee-benefits.ParamsDetails.json
create mode 100644 docs/api/get-v-1-company-benefits-company-benefit-id-employee-benefits.RequestSchema.json
create mode 100644 docs/api/get-v-1-company-benefits-company-benefit-id-employee-benefits.StatusCodes.json
create mode 100644 docs/api/get-v-1-company-benefits-company-benefit-id-employee-benefits.api.mdx
create mode 100644 docs/api/get-v-1-company-benefits-company-benefit-id.ParamsDetails.json
create mode 100644 docs/api/get-v-1-company-benefits-company-benefit-id.RequestSchema.json
create mode 100644 docs/api/get-v-1-company-benefits-company-benefit-id.StatusCodes.json
create mode 100644 docs/api/get-v-1-company-benefits-company-benefit-id.api.mdx
create mode 100644 docs/api/get-v-1-company-external-payrolls.ParamsDetails.json
create mode 100644 docs/api/get-v-1-company-external-payrolls.RequestSchema.json
create mode 100644 docs/api/get-v-1-company-external-payrolls.StatusCodes.json
create mode 100644 docs/api/get-v-1-company-external-payrolls.api.mdx
create mode 100644 docs/api/get-v-1-company-finish-onboarding.ParamsDetails.json
create mode 100644 docs/api/get-v-1-company-finish-onboarding.RequestSchema.json
create mode 100644 docs/api/get-v-1-company-finish-onboarding.StatusCodes.json
create mode 100644 docs/api/get-v-1-company-finish-onboarding.api.mdx
create mode 100644 docs/api/get-v-1-company-form-pdf.ParamsDetails.json
create mode 100644 docs/api/get-v-1-company-form-pdf.RequestSchema.json
create mode 100644 docs/api/get-v-1-company-form-pdf.StatusCodes.json
create mode 100644 docs/api/get-v-1-company-form-pdf.api.mdx
create mode 100644 docs/api/get-v-1-company-form.ParamsDetails.json
create mode 100644 docs/api/get-v-1-company-form.RequestSchema.json
create mode 100644 docs/api/get-v-1-company-form.StatusCodes.json
create mode 100644 docs/api/get-v-1-company-form.api.mdx
create mode 100644 docs/api/get-v-1-company-forms.ParamsDetails.json
create mode 100644 docs/api/get-v-1-company-forms.RequestSchema.json
create mode 100644 docs/api/get-v-1-company-forms.StatusCodes.json
create mode 100644 docs/api/get-v-1-company-forms.api.mdx
create mode 100644 docs/api/get-v-1-company-industry.ParamsDetails.json
create mode 100644 docs/api/get-v-1-company-industry.RequestSchema.json
create mode 100644 docs/api/get-v-1-company-industry.StatusCodes.json
create mode 100644 docs/api/get-v-1-company-industry.api.mdx
create mode 100644 docs/api/get-v-1-company-onboarding-status.ParamsDetails.json
create mode 100644 docs/api/get-v-1-company-onboarding-status.RequestSchema.json
create mode 100644 docs/api/get-v-1-company-onboarding-status.StatusCodes.json
create mode 100644 docs/api/get-v-1-company-onboarding-status.api.mdx
create mode 100644 docs/api/get-v-1-company-payment-configs.ParamsDetails.json
create mode 100644 docs/api/get-v-1-company-payment-configs.RequestSchema.json
create mode 100644 docs/api/get-v-1-company-payment-configs.StatusCodes.json
create mode 100644 docs/api/get-v-1-company-payment-configs.api.mdx
create mode 100644 docs/api/get-v-1-compensations-compensation-id.ParamsDetails.json
create mode 100644 docs/api/get-v-1-compensations-compensation-id.RequestSchema.json
create mode 100644 docs/api/get-v-1-compensations-compensation-id.StatusCodes.json
create mode 100644 docs/api/get-v-1-compensations-compensation-id.api.mdx
create mode 100644 docs/api/get-v-1-contractor-document-pdf.ParamsDetails.json
create mode 100644 docs/api/get-v-1-contractor-document-pdf.RequestSchema.json
create mode 100644 docs/api/get-v-1-contractor-document-pdf.StatusCodes.json
create mode 100644 docs/api/get-v-1-contractor-document-pdf.api.mdx
create mode 100644 docs/api/get-v-1-contractor-document.ParamsDetails.json
create mode 100644 docs/api/get-v-1-contractor-document.RequestSchema.json
create mode 100644 docs/api/get-v-1-contractor-document.StatusCodes.json
create mode 100644 docs/api/get-v-1-contractor-document.api.mdx
create mode 100644 docs/api/get-v-1-contractor-documents.ParamsDetails.json
create mode 100644 docs/api/get-v-1-contractor-documents.RequestSchema.json
create mode 100644 docs/api/get-v-1-contractor-documents.StatusCodes.json
create mode 100644 docs/api/get-v-1-contractor-documents.api.mdx
create mode 100644 docs/api/get-v-1-contractor-form-pdf.ParamsDetails.json
create mode 100644 docs/api/get-v-1-contractor-form-pdf.RequestSchema.json
create mode 100644 docs/api/get-v-1-contractor-form-pdf.StatusCodes.json
create mode 100644 docs/api/get-v-1-contractor-form-pdf.api.mdx
create mode 100644 docs/api/get-v-1-contractor-form.ParamsDetails.json
create mode 100644 docs/api/get-v-1-contractor-form.RequestSchema.json
create mode 100644 docs/api/get-v-1-contractor-form.StatusCodes.json
create mode 100644 docs/api/get-v-1-contractor-form.api.mdx
create mode 100644 docs/api/get-v-1-contractor-forms.ParamsDetails.json
create mode 100644 docs/api/get-v-1-contractor-forms.RequestSchema.json
create mode 100644 docs/api/get-v-1-contractor-forms.StatusCodes.json
create mode 100644 docs/api/get-v-1-contractor-forms.api.mdx
create mode 100644 docs/api/get-v-1-contractor-payment-groups-contractor-payment-group-id.ParamsDetails.json
create mode 100644 docs/api/get-v-1-contractor-payment-groups-contractor-payment-group-id.RequestSchema.json
create mode 100644 docs/api/get-v-1-contractor-payment-groups-contractor-payment-group-id.StatusCodes.json
create mode 100644 docs/api/get-v-1-contractor-payment-groups-contractor-payment-group-id.api.mdx
create mode 100644 docs/api/get-v-1-contractor-payment-groups-id-partner-disbursements.ParamsDetails.json
create mode 100644 docs/api/get-v-1-contractor-payment-groups-id-partner-disbursements.RequestSchema.json
create mode 100644 docs/api/get-v-1-contractor-payment-groups-id-partner-disbursements.StatusCodes.json
create mode 100644 docs/api/get-v-1-contractor-payment-groups-id-partner-disbursements.api.mdx
create mode 100644 docs/api/get-v-1-contractor-payments-contractor-payment-uuid-fund.ParamsDetails.json
create mode 100644 docs/api/get-v-1-contractor-payments-contractor-payment-uuid-fund.RequestSchema.json
create mode 100644 docs/api/get-v-1-contractor-payments-contractor-payment-uuid-fund.StatusCodes.json
create mode 100644 docs/api/get-v-1-contractor-payments-contractor-payment-uuid-fund.api.mdx
create mode 100644 docs/api/get-v-1-contractor-payments-contractor-payment-uuid-receipt.ParamsDetails.json
create mode 100644 docs/api/get-v-1-contractor-payments-contractor-payment-uuid-receipt.RequestSchema.json
create mode 100644 docs/api/get-v-1-contractor-payments-contractor-payment-uuid-receipt.StatusCodes.json
create mode 100644 docs/api/get-v-1-contractor-payments-contractor-payment-uuid-receipt.api.mdx
create mode 100644 docs/api/get-v-1-contractors-contractor-uuid-address.ParamsDetails.json
create mode 100644 docs/api/get-v-1-contractors-contractor-uuid-address.RequestSchema.json
create mode 100644 docs/api/get-v-1-contractors-contractor-uuid-address.StatusCodes.json
create mode 100644 docs/api/get-v-1-contractors-contractor-uuid-address.api.mdx
create mode 100644 docs/api/get-v-1-contractors-contractor-uuid-bank-accounts.ParamsDetails.json
create mode 100644 docs/api/get-v-1-contractors-contractor-uuid-bank-accounts.RequestSchema.json
create mode 100644 docs/api/get-v-1-contractors-contractor-uuid-bank-accounts.StatusCodes.json
create mode 100644 docs/api/get-v-1-contractors-contractor-uuid-bank-accounts.api.mdx
create mode 100644 docs/api/get-v-1-contractors-contractor-uuid-onboarding-status.ParamsDetails.json
create mode 100644 docs/api/get-v-1-contractors-contractor-uuid-onboarding-status.RequestSchema.json
create mode 100644 docs/api/get-v-1-contractors-contractor-uuid-onboarding-status.StatusCodes.json
create mode 100644 docs/api/get-v-1-contractors-contractor-uuid-onboarding-status.api.mdx
create mode 100644 docs/api/get-v-1-contractors-contractor-uuid-payment-method.ParamsDetails.json
create mode 100644 docs/api/get-v-1-contractors-contractor-uuid-payment-method.RequestSchema.json
create mode 100644 docs/api/get-v-1-contractors-contractor-uuid-payment-method.StatusCodes.json
create mode 100644 docs/api/get-v-1-contractors-contractor-uuid-payment-method.api.mdx
create mode 100644 docs/api/get-v-1-contractors-contractor-uuid.ParamsDetails.json
create mode 100644 docs/api/get-v-1-contractors-contractor-uuid.RequestSchema.json
create mode 100644 docs/api/get-v-1-contractors-contractor-uuid.StatusCodes.json
create mode 100644 docs/api/get-v-1-contractors-contractor-uuid.api.mdx
create mode 100644 docs/api/get-v-1-employee-benefits-employee-benefit-id.ParamsDetails.json
create mode 100644 docs/api/get-v-1-employee-benefits-employee-benefit-id.RequestSchema.json
create mode 100644 docs/api/get-v-1-employee-benefits-employee-benefit-id.StatusCodes.json
create mode 100644 docs/api/get-v-1-employee-benefits-employee-benefit-id.api.mdx
create mode 100644 docs/api/get-v-1-employee-form-pdf.ParamsDetails.json
create mode 100644 docs/api/get-v-1-employee-form-pdf.RequestSchema.json
create mode 100644 docs/api/get-v-1-employee-form-pdf.StatusCodes.json
create mode 100644 docs/api/get-v-1-employee-form-pdf.api.mdx
create mode 100644 docs/api/get-v-1-employee-form.ParamsDetails.json
create mode 100644 docs/api/get-v-1-employee-form.RequestSchema.json
create mode 100644 docs/api/get-v-1-employee-form.StatusCodes.json
create mode 100644 docs/api/get-v-1-employee-form.api.mdx
create mode 100644 docs/api/get-v-1-employee-forms.ParamsDetails.json
create mode 100644 docs/api/get-v-1-employee-forms.RequestSchema.json
create mode 100644 docs/api/get-v-1-employee-forms.StatusCodes.json
create mode 100644 docs/api/get-v-1-employee-forms.api.mdx
create mode 100644 docs/api/get-v-1-employees-employee-id-bank-accounts.ParamsDetails.json
create mode 100644 docs/api/get-v-1-employees-employee-id-bank-accounts.RequestSchema.json
create mode 100644 docs/api/get-v-1-employees-employee-id-bank-accounts.StatusCodes.json
create mode 100644 docs/api/get-v-1-employees-employee-id-bank-accounts.api.mdx
create mode 100644 docs/api/get-v-1-employees-employee-id-custom-fields.ParamsDetails.json
create mode 100644 docs/api/get-v-1-employees-employee-id-custom-fields.RequestSchema.json
create mode 100644 docs/api/get-v-1-employees-employee-id-custom-fields.StatusCodes.json
create mode 100644 docs/api/get-v-1-employees-employee-id-custom-fields.api.mdx
create mode 100644 docs/api/get-v-1-employees-employee-id-employee-benefits.ParamsDetails.json
create mode 100644 docs/api/get-v-1-employees-employee-id-employee-benefits.RequestSchema.json
create mode 100644 docs/api/get-v-1-employees-employee-id-employee-benefits.StatusCodes.json
create mode 100644 docs/api/get-v-1-employees-employee-id-employee-benefits.api.mdx
create mode 100644 docs/api/get-v-1-employees-employee-id-employment-history.ParamsDetails.json
create mode 100644 docs/api/get-v-1-employees-employee-id-employment-history.RequestSchema.json
create mode 100644 docs/api/get-v-1-employees-employee-id-employment-history.StatusCodes.json
create mode 100644 docs/api/get-v-1-employees-employee-id-employment-history.api.mdx
create mode 100644 docs/api/get-v-1-employees-employee-id-federal-taxes.ParamsDetails.json
create mode 100644 docs/api/get-v-1-employees-employee-id-federal-taxes.RequestSchema.json
create mode 100644 docs/api/get-v-1-employees-employee-id-federal-taxes.StatusCodes.json
create mode 100644 docs/api/get-v-1-employees-employee-id-federal-taxes.api.mdx
create mode 100644 docs/api/get-v-1-employees-employee-id-garnishments.ParamsDetails.json
create mode 100644 docs/api/get-v-1-employees-employee-id-garnishments.RequestSchema.json
create mode 100644 docs/api/get-v-1-employees-employee-id-garnishments.StatusCodes.json
create mode 100644 docs/api/get-v-1-employees-employee-id-garnishments.api.mdx
create mode 100644 docs/api/get-v-1-employees-employee-id-home-addresses.ParamsDetails.json
create mode 100644 docs/api/get-v-1-employees-employee-id-home-addresses.RequestSchema.json
create mode 100644 docs/api/get-v-1-employees-employee-id-home-addresses.StatusCodes.json
create mode 100644 docs/api/get-v-1-employees-employee-id-home-addresses.api.mdx
create mode 100644 docs/api/get-v-1-employees-employee-id-i-9-authorization-document-options.ParamsDetails.json
create mode 100644 docs/api/get-v-1-employees-employee-id-i-9-authorization-document-options.RequestSchema.json
create mode 100644 docs/api/get-v-1-employees-employee-id-i-9-authorization-document-options.StatusCodes.json
create mode 100644 docs/api/get-v-1-employees-employee-id-i-9-authorization-document-options.api.mdx
create mode 100644 docs/api/get-v-1-employees-employee-id-i-9-authorization-documents.ParamsDetails.json
create mode 100644 docs/api/get-v-1-employees-employee-id-i-9-authorization-documents.RequestSchema.json
create mode 100644 docs/api/get-v-1-employees-employee-id-i-9-authorization-documents.StatusCodes.json
create mode 100644 docs/api/get-v-1-employees-employee-id-i-9-authorization-documents.api.mdx
create mode 100644 docs/api/get-v-1-employees-employee-id-i-9-authorization.ParamsDetails.json
create mode 100644 docs/api/get-v-1-employees-employee-id-i-9-authorization.RequestSchema.json
create mode 100644 docs/api/get-v-1-employees-employee-id-i-9-authorization.StatusCodes.json
create mode 100644 docs/api/get-v-1-employees-employee-id-i-9-authorization.api.mdx
create mode 100644 docs/api/get-v-1-employees-employee-id-jobs.ParamsDetails.json
create mode 100644 docs/api/get-v-1-employees-employee-id-jobs.RequestSchema.json
create mode 100644 docs/api/get-v-1-employees-employee-id-jobs.StatusCodes.json
create mode 100644 docs/api/get-v-1-employees-employee-id-jobs.api.mdx
create mode 100644 docs/api/get-v-1-employees-employee-id-onboarding-status.ParamsDetails.json
create mode 100644 docs/api/get-v-1-employees-employee-id-onboarding-status.RequestSchema.json
create mode 100644 docs/api/get-v-1-employees-employee-id-onboarding-status.StatusCodes.json
create mode 100644 docs/api/get-v-1-employees-employee-id-onboarding-status.api.mdx
create mode 100644 docs/api/get-v-1-employees-employee-id-payment-method.ParamsDetails.json
create mode 100644 docs/api/get-v-1-employees-employee-id-payment-method.RequestSchema.json
create mode 100644 docs/api/get-v-1-employees-employee-id-payment-method.StatusCodes.json
create mode 100644 docs/api/get-v-1-employees-employee-id-payment-method.api.mdx
create mode 100644 docs/api/get-v-1-employees-employee-id-recurring-reimbursements.ParamsDetails.json
create mode 100644 docs/api/get-v-1-employees-employee-id-recurring-reimbursements.RequestSchema.json
create mode 100644 docs/api/get-v-1-employees-employee-id-recurring-reimbursements.StatusCodes.json
create mode 100644 docs/api/get-v-1-employees-employee-id-recurring-reimbursements.api.mdx
create mode 100644 docs/api/get-v-1-employees-employee-id-rehire.ParamsDetails.json
create mode 100644 docs/api/get-v-1-employees-employee-id-rehire.RequestSchema.json
create mode 100644 docs/api/get-v-1-employees-employee-id-rehire.StatusCodes.json
create mode 100644 docs/api/get-v-1-employees-employee-id-rehire.api.mdx
create mode 100644 docs/api/get-v-1-employees-employee-id-state-taxes.ParamsDetails.json
create mode 100644 docs/api/get-v-1-employees-employee-id-state-taxes.RequestSchema.json
create mode 100644 docs/api/get-v-1-employees-employee-id-state-taxes.StatusCodes.json
create mode 100644 docs/api/get-v-1-employees-employee-id-state-taxes.api.mdx
create mode 100644 docs/api/get-v-1-employees-employee-id-terminations.ParamsDetails.json
create mode 100644 docs/api/get-v-1-employees-employee-id-terminations.RequestSchema.json
create mode 100644 docs/api/get-v-1-employees-employee-id-terminations.StatusCodes.json
create mode 100644 docs/api/get-v-1-employees-employee-id-terminations.api.mdx
create mode 100644 docs/api/get-v-1-employees-employee-id-work-addresses.ParamsDetails.json
create mode 100644 docs/api/get-v-1-employees-employee-id-work-addresses.RequestSchema.json
create mode 100644 docs/api/get-v-1-employees-employee-id-work-addresses.StatusCodes.json
create mode 100644 docs/api/get-v-1-employees-employee-id-work-addresses.api.mdx
create mode 100644 docs/api/get-v-1-employees-employee-uuid-pay-stubs.ParamsDetails.json
create mode 100644 docs/api/get-v-1-employees-employee-uuid-pay-stubs.RequestSchema.json
create mode 100644 docs/api/get-v-1-employees-employee-uuid-pay-stubs.StatusCodes.json
create mode 100644 docs/api/get-v-1-employees-employee-uuid-pay-stubs.api.mdx
create mode 100644 docs/api/get-v-1-employees-employee-uuid-section-603-high-earner-statuses-effective-year.ParamsDetails.json
create mode 100644 docs/api/get-v-1-employees-employee-uuid-section-603-high-earner-statuses-effective-year.RequestSchema.json
create mode 100644 docs/api/get-v-1-employees-employee-uuid-section-603-high-earner-statuses-effective-year.StatusCodes.json
create mode 100644 docs/api/get-v-1-employees-employee-uuid-section-603-high-earner-statuses-effective-year.api.mdx
create mode 100644 docs/api/get-v-1-employees-employee-uuid-section-603-high-earner-statuses.ParamsDetails.json
create mode 100644 docs/api/get-v-1-employees-employee-uuid-section-603-high-earner-statuses.RequestSchema.json
create mode 100644 docs/api/get-v-1-employees-employee-uuid-section-603-high-earner-statuses.StatusCodes.json
create mode 100644 docs/api/get-v-1-employees-employee-uuid-section-603-high-earner-statuses.api.mdx
create mode 100644 docs/api/get-v-1-employees.ParamsDetails.json
create mode 100644 docs/api/get-v-1-employees.RequestSchema.json
create mode 100644 docs/api/get-v-1-employees.StatusCodes.json
create mode 100644 docs/api/get-v-1-employees.api.mdx
create mode 100644 docs/api/get-v-1-external-payroll-calculate-taxes.ParamsDetails.json
create mode 100644 docs/api/get-v-1-external-payroll-calculate-taxes.RequestSchema.json
create mode 100644 docs/api/get-v-1-external-payroll-calculate-taxes.StatusCodes.json
create mode 100644 docs/api/get-v-1-external-payroll-calculate-taxes.api.mdx
create mode 100644 docs/api/get-v-1-external-payroll.ParamsDetails.json
create mode 100644 docs/api/get-v-1-external-payroll.RequestSchema.json
create mode 100644 docs/api/get-v-1-external-payroll.StatusCodes.json
create mode 100644 docs/api/get-v-1-external-payroll.api.mdx
create mode 100644 docs/api/get-v-1-garnishments-child-support.ParamsDetails.json
create mode 100644 docs/api/get-v-1-garnishments-child-support.RequestSchema.json
create mode 100644 docs/api/get-v-1-garnishments-child-support.StatusCodes.json
create mode 100644 docs/api/get-v-1-garnishments-child-support.api.mdx
create mode 100644 docs/api/get-v-1-garnishments-garnishment-id.ParamsDetails.json
create mode 100644 docs/api/get-v-1-garnishments-garnishment-id.RequestSchema.json
create mode 100644 docs/api/get-v-1-garnishments-garnishment-id.StatusCodes.json
create mode 100644 docs/api/get-v-1-garnishments-garnishment-id.api.mdx
create mode 100644 docs/api/get-v-1-generated-documents-document-type-request-uuid.ParamsDetails.json
create mode 100644 docs/api/get-v-1-generated-documents-document-type-request-uuid.RequestSchema.json
create mode 100644 docs/api/get-v-1-generated-documents-document-type-request-uuid.StatusCodes.json
create mode 100644 docs/api/get-v-1-generated-documents-document-type-request-uuid.api.mdx
create mode 100644 docs/api/get-v-1-home-addresses-home-address-uuid.ParamsDetails.json
create mode 100644 docs/api/get-v-1-home-addresses-home-address-uuid.RequestSchema.json
create mode 100644 docs/api/get-v-1-home-addresses-home-address-uuid.StatusCodes.json
create mode 100644 docs/api/get-v-1-home-addresses-home-address-uuid.api.mdx
create mode 100644 docs/api/get-v-1-jobs-job-id-compensations.ParamsDetails.json
create mode 100644 docs/api/get-v-1-jobs-job-id-compensations.RequestSchema.json
create mode 100644 docs/api/get-v-1-jobs-job-id-compensations.StatusCodes.json
create mode 100644 docs/api/get-v-1-jobs-job-id-compensations.api.mdx
create mode 100644 docs/api/get-v-1-jobs-job-id.ParamsDetails.json
create mode 100644 docs/api/get-v-1-jobs-job-id.RequestSchema.json
create mode 100644 docs/api/get-v-1-jobs-job-id.StatusCodes.json
create mode 100644 docs/api/get-v-1-jobs-job-id.api.mdx
create mode 100644 docs/api/get-v-1-locations-location-id.ParamsDetails.json
create mode 100644 docs/api/get-v-1-locations-location-id.RequestSchema.json
create mode 100644 docs/api/get-v-1-locations-location-id.StatusCodes.json
create mode 100644 docs/api/get-v-1-locations-location-id.api.mdx
create mode 100644 docs/api/get-v-1-locations-location-uuid-minimum-wages.ParamsDetails.json
create mode 100644 docs/api/get-v-1-locations-location-uuid-minimum-wages.RequestSchema.json
create mode 100644 docs/api/get-v-1-locations-location-uuid-minimum-wages.StatusCodes.json
create mode 100644 docs/api/get-v-1-locations-location-uuid-minimum-wages.api.mdx
create mode 100644 docs/api/get-v-1-partner-managed-companies-company-uuid-migration-readiness.ParamsDetails.json
create mode 100644 docs/api/get-v-1-partner-managed-companies-company-uuid-migration-readiness.RequestSchema.json
create mode 100644 docs/api/get-v-1-partner-managed-companies-company-uuid-migration-readiness.StatusCodes.json
create mode 100644 docs/api/get-v-1-partner-managed-companies-company-uuid-migration-readiness.api.mdx
create mode 100644 docs/api/get-v-1-payment-receipts-payrolls-payroll-uuid.ParamsDetails.json
create mode 100644 docs/api/get-v-1-payment-receipts-payrolls-payroll-uuid.RequestSchema.json
create mode 100644 docs/api/get-v-1-payment-receipts-payrolls-payroll-uuid.StatusCodes.json
create mode 100644 docs/api/get-v-1-payment-receipts-payrolls-payroll-uuid.api.mdx
create mode 100644 docs/api/get-v-1-payrolls-payroll-uuid-employees-employee-uuid-pay-stub.ParamsDetails.json
create mode 100644 docs/api/get-v-1-payrolls-payroll-uuid-employees-employee-uuid-pay-stub.RequestSchema.json
create mode 100644 docs/api/get-v-1-payrolls-payroll-uuid-employees-employee-uuid-pay-stub.StatusCodes.json
create mode 100644 docs/api/get-v-1-payrolls-payroll-uuid-employees-employee-uuid-pay-stub.api.mdx
create mode 100644 docs/api/get-v-1-people-batches-people-batch-uuid.ParamsDetails.json
create mode 100644 docs/api/get-v-1-people-batches-people-batch-uuid.RequestSchema.json
create mode 100644 docs/api/get-v-1-people-batches-people-batch-uuid.StatusCodes.json
create mode 100644 docs/api/get-v-1-people-batches-people-batch-uuid.api.mdx
create mode 100644 docs/api/get-v-1-recurring-reimbursements.ParamsDetails.json
create mode 100644 docs/api/get-v-1-recurring-reimbursements.RequestSchema.json
create mode 100644 docs/api/get-v-1-recurring-reimbursements.StatusCodes.json
create mode 100644 docs/api/get-v-1-recurring-reimbursements.api.mdx
create mode 100644 docs/api/get-v-1-salary-estimates-id.ParamsDetails.json
create mode 100644 docs/api/get-v-1-salary-estimates-id.RequestSchema.json
create mode 100644 docs/api/get-v-1-salary-estimates-id.StatusCodes.json
create mode 100644 docs/api/get-v-1-salary-estimates-id.api.mdx
create mode 100644 docs/api/get-v-1-salary-estimates-occupations.ParamsDetails.json
create mode 100644 docs/api/get-v-1-salary-estimates-occupations.RequestSchema.json
create mode 100644 docs/api/get-v-1-salary-estimates-occupations.StatusCodes.json
create mode 100644 docs/api/get-v-1-salary-estimates-occupations.api.mdx
create mode 100644 docs/api/get-v-1-tax-liabilities.ParamsDetails.json
create mode 100644 docs/api/get-v-1-tax-liabilities.RequestSchema.json
create mode 100644 docs/api/get-v-1-tax-liabilities.StatusCodes.json
create mode 100644 docs/api/get-v-1-tax-liabilities.api.mdx
create mode 100644 docs/api/get-v-1-time-off-policies-time-off-policy-uuid.ParamsDetails.json
create mode 100644 docs/api/get-v-1-time-off-policies-time-off-policy-uuid.RequestSchema.json
create mode 100644 docs/api/get-v-1-time-off-policies-time-off-policy-uuid.StatusCodes.json
create mode 100644 docs/api/get-v-1-time-off-policies-time-off-policy-uuid.api.mdx
create mode 100644 docs/api/get-v-1-token-info.ParamsDetails.json
create mode 100644 docs/api/get-v-1-token-info.RequestSchema.json
create mode 100644 docs/api/get-v-1-token-info.StatusCodes.json
create mode 100644 docs/api/get-v-1-token-info.api.mdx
create mode 100644 docs/api/get-v-1-webhook-subscription-uuid.ParamsDetails.json
create mode 100644 docs/api/get-v-1-webhook-subscription-uuid.RequestSchema.json
create mode 100644 docs/api/get-v-1-webhook-subscription-uuid.StatusCodes.json
create mode 100644 docs/api/get-v-1-webhook-subscription-uuid.api.mdx
create mode 100644 docs/api/get-v-1-webhook-subscription-verification-token-uuid.ParamsDetails.json
create mode 100644 docs/api/get-v-1-webhook-subscription-verification-token-uuid.RequestSchema.json
create mode 100644 docs/api/get-v-1-webhook-subscription-verification-token-uuid.StatusCodes.json
create mode 100644 docs/api/get-v-1-webhook-subscription-verification-token-uuid.api.mdx
create mode 100644 docs/api/get-v-1-webhook-subscriptions.ParamsDetails.json
create mode 100644 docs/api/get-v-1-webhook-subscriptions.RequestSchema.json
create mode 100644 docs/api/get-v-1-webhook-subscriptions.StatusCodes.json
create mode 100644 docs/api/get-v-1-webhook-subscriptions.api.mdx
create mode 100644 docs/api/get-v-1-webhooks-health-check.ParamsDetails.json
create mode 100644 docs/api/get-v-1-webhooks-health-check.RequestSchema.json
create mode 100644 docs/api/get-v-1-webhooks-health-check.StatusCodes.json
create mode 100644 docs/api/get-v-1-webhooks-health-check.api.mdx
create mode 100644 docs/api/get-v-1-work-addresses-work-address-uuid.ParamsDetails.json
create mode 100644 docs/api/get-v-1-work-addresses-work-address-uuid.RequestSchema.json
create mode 100644 docs/api/get-v-1-work-addresses-work-address-uuid.StatusCodes.json
create mode 100644 docs/api/get-v-1-work-addresses-work-address-uuid.api.mdx
create mode 100644 docs/api/get-version-employees-time-off-activities.ParamsDetails.json
create mode 100644 docs/api/get-version-employees-time-off-activities.RequestSchema.json
create mode 100644 docs/api/get-version-employees-time-off-activities.StatusCodes.json
create mode 100644 docs/api/get-version-employees-time-off-activities.api.mdx
create mode 100644 docs/api/get-wire-in-requests-wire-in-request-uuid.ParamsDetails.json
create mode 100644 docs/api/get-wire-in-requests-wire-in-request-uuid.RequestSchema.json
create mode 100644 docs/api/get-wire-in-requests-wire-in-request-uuid.StatusCodes.json
create mode 100644 docs/api/get-wire-in-requests-wire-in-request-uuid.api.mdx
create mode 100644 docs/api/gusto-api.info.mdx
create mode 100644 docs/api/holiday-pay-policies.tag.mdx
create mode 100644 docs/api/i-9-verification.tag.mdx
create mode 100644 docs/api/industry-selection.tag.mdx
create mode 100644 docs/api/information-requests.tag.mdx
create mode 100644 docs/api/introspection.tag.mdx
create mode 100644 docs/api/invoices.tag.mdx
create mode 100644 docs/api/jobs-and-compensations.tag.mdx
create mode 100644 docs/api/locations.tag.mdx
create mode 100644 docs/api/notifications.tag.mdx
create mode 100644 docs/api/oauth-access-token.ParamsDetails.json
create mode 100644 docs/api/oauth-access-token.RequestSchema.json
create mode 100644 docs/api/oauth-access-token.StatusCodes.json
create mode 100644 docs/api/oauth-access-token.api.mdx
create mode 100644 docs/api/patch-v-1-companies-company-id-payrolls-id-partner-disbursements.ParamsDetails.json
create mode 100644 docs/api/patch-v-1-companies-company-id-payrolls-id-partner-disbursements.RequestSchema.json
create mode 100644 docs/api/patch-v-1-companies-company-id-payrolls-id-partner-disbursements.StatusCodes.json
create mode 100644 docs/api/patch-v-1-companies-company-id-payrolls-id-partner-disbursements.api.mdx
create mode 100644 docs/api/patch-v-1-contractor-payment-groups-id-partner-disbursements.ParamsDetails.json
create mode 100644 docs/api/patch-v-1-contractor-payment-groups-id-partner-disbursements.RequestSchema.json
create mode 100644 docs/api/patch-v-1-contractor-payment-groups-id-partner-disbursements.StatusCodes.json
create mode 100644 docs/api/patch-v-1-contractor-payment-groups-id-partner-disbursements.api.mdx
create mode 100644 docs/api/patch-v-1-employees-employee-uuid-section-603-high-earner-statuses-effective-year.ParamsDetails.json
create mode 100644 docs/api/patch-v-1-employees-employee-uuid-section-603-high-earner-statuses-effective-year.RequestSchema.json
create mode 100644 docs/api/patch-v-1-employees-employee-uuid-section-603-high-earner-statuses-effective-year.StatusCodes.json
create mode 100644 docs/api/patch-v-1-employees-employee-uuid-section-603-high-earner-statuses-effective-year.api.mdx
create mode 100644 docs/api/pay-schedules.tag.mdx
create mode 100644 docs/api/payment-configs.tag.mdx
create mode 100644 docs/api/payrolls.tag.mdx
create mode 100644 docs/api/people-batches.tag.mdx
create mode 100644 docs/api/post-companies-company-uuid-reports.ParamsDetails.json
create mode 100644 docs/api/post-companies-company-uuid-reports.RequestSchema.json
create mode 100644 docs/api/post-companies-company-uuid-reports.StatusCodes.json
create mode 100644 docs/api/post-companies-company-uuid-reports.api.mdx
create mode 100644 docs/api/post-companies-company-uuid-suspensions.ParamsDetails.json
create mode 100644 docs/api/post-companies-company-uuid-suspensions.RequestSchema.json
create mode 100644 docs/api/post-companies-company-uuid-suspensions.StatusCodes.json
create mode 100644 docs/api/post-companies-company-uuid-suspensions.api.mdx
create mode 100644 docs/api/post-companies-payroll-skip-company-uuid.ParamsDetails.json
create mode 100644 docs/api/post-companies-payroll-skip-company-uuid.RequestSchema.json
create mode 100644 docs/api/post-companies-payroll-skip-company-uuid.StatusCodes.json
create mode 100644 docs/api/post-companies-payroll-skip-company-uuid.api.mdx
create mode 100644 docs/api/post-departments.ParamsDetails.json
create mode 100644 docs/api/post-departments.RequestSchema.json
create mode 100644 docs/api/post-departments.StatusCodes.json
create mode 100644 docs/api/post-departments.api.mdx
create mode 100644 docs/api/post-employee-ytd-benefit-amounts-from-different-company.ParamsDetails.json
create mode 100644 docs/api/post-employee-ytd-benefit-amounts-from-different-company.RequestSchema.json
create mode 100644 docs/api/post-employee-ytd-benefit-amounts-from-different-company.StatusCodes.json
create mode 100644 docs/api/post-employee-ytd-benefit-amounts-from-different-company.api.mdx
create mode 100644 docs/api/post-partner-managed-companies-company-uuid-accept-terms-of-service.ParamsDetails.json
create mode 100644 docs/api/post-partner-managed-companies-company-uuid-accept-terms-of-service.RequestSchema.json
create mode 100644 docs/api/post-partner-managed-companies-company-uuid-accept-terms-of-service.StatusCodes.json
create mode 100644 docs/api/post-partner-managed-companies-company-uuid-accept-terms-of-service.api.mdx
create mode 100644 docs/api/post-partner-managed-companies-company-uuid-retrieve-terms-of-service.ParamsDetails.json
create mode 100644 docs/api/post-partner-managed-companies-company-uuid-retrieve-terms-of-service.RequestSchema.json
create mode 100644 docs/api/post-partner-managed-companies-company-uuid-retrieve-terms-of-service.StatusCodes.json
create mode 100644 docs/api/post-partner-managed-companies-company-uuid-retrieve-terms-of-service.api.mdx
create mode 100644 docs/api/post-payrolls-gross-up-payroll-uuid.ParamsDetails.json
create mode 100644 docs/api/post-payrolls-gross-up-payroll-uuid.RequestSchema.json
create mode 100644 docs/api/post-payrolls-gross-up-payroll-uuid.StatusCodes.json
create mode 100644 docs/api/post-payrolls-gross-up-payroll-uuid.api.mdx
create mode 100644 docs/api/post-payrolls-payroll-uuid-reports-general-ledger.ParamsDetails.json
create mode 100644 docs/api/post-payrolls-payroll-uuid-reports-general-ledger.RequestSchema.json
create mode 100644 docs/api/post-payrolls-payroll-uuid-reports-general-ledger.StatusCodes.json
create mode 100644 docs/api/post-payrolls-payroll-uuid-reports-general-ledger.api.mdx
create mode 100644 docs/api/post-v-1-companies-attachment.ParamsDetails.json
create mode 100644 docs/api/post-v-1-companies-attachment.RequestSchema.json
create mode 100644 docs/api/post-v-1-companies-attachment.StatusCodes.json
create mode 100644 docs/api/post-v-1-companies-attachment.api.mdx
create mode 100644 docs/api/post-v-1-companies-company-id-admins.ParamsDetails.json
create mode 100644 docs/api/post-v-1-companies-company-id-admins.RequestSchema.json
create mode 100644 docs/api/post-v-1-companies-company-id-admins.StatusCodes.json
create mode 100644 docs/api/post-v-1-companies-company-id-admins.api.mdx
create mode 100644 docs/api/post-v-1-companies-company-id-bank-accounts.ParamsDetails.json
create mode 100644 docs/api/post-v-1-companies-company-id-bank-accounts.RequestSchema.json
create mode 100644 docs/api/post-v-1-companies-company-id-bank-accounts.StatusCodes.json
create mode 100644 docs/api/post-v-1-companies-company-id-bank-accounts.api.mdx
create mode 100644 docs/api/post-v-1-companies-company-id-company-benefits.ParamsDetails.json
create mode 100644 docs/api/post-v-1-companies-company-id-company-benefits.RequestSchema.json
create mode 100644 docs/api/post-v-1-companies-company-id-company-benefits.StatusCodes.json
create mode 100644 docs/api/post-v-1-companies-company-id-company-benefits.api.mdx
create mode 100644 docs/api/post-v-1-companies-company-id-contractor-payment-groups-preview.ParamsDetails.json
create mode 100644 docs/api/post-v-1-companies-company-id-contractor-payment-groups-preview.RequestSchema.json
create mode 100644 docs/api/post-v-1-companies-company-id-contractor-payment-groups-preview.StatusCodes.json
create mode 100644 docs/api/post-v-1-companies-company-id-contractor-payment-groups-preview.api.mdx
create mode 100644 docs/api/post-v-1-companies-company-id-contractor-payment-groups.ParamsDetails.json
create mode 100644 docs/api/post-v-1-companies-company-id-contractor-payment-groups.RequestSchema.json
create mode 100644 docs/api/post-v-1-companies-company-id-contractor-payment-groups.StatusCodes.json
create mode 100644 docs/api/post-v-1-companies-company-id-contractor-payment-groups.api.mdx
create mode 100644 docs/api/post-v-1-companies-company-id-contractor-payments.ParamsDetails.json
create mode 100644 docs/api/post-v-1-companies-company-id-contractor-payments.RequestSchema.json
create mode 100644 docs/api/post-v-1-companies-company-id-contractor-payments.StatusCodes.json
create mode 100644 docs/api/post-v-1-companies-company-id-contractor-payments.api.mdx
create mode 100644 docs/api/post-v-1-companies-company-id-earning-types.ParamsDetails.json
create mode 100644 docs/api/post-v-1-companies-company-id-earning-types.RequestSchema.json
create mode 100644 docs/api/post-v-1-companies-company-id-earning-types.StatusCodes.json
create mode 100644 docs/api/post-v-1-companies-company-id-earning-types.api.mdx
create mode 100644 docs/api/post-v-1-companies-company-id-locations.ParamsDetails.json
create mode 100644 docs/api/post-v-1-companies-company-id-locations.RequestSchema.json
create mode 100644 docs/api/post-v-1-companies-company-id-locations.StatusCodes.json
create mode 100644 docs/api/post-v-1-companies-company-id-locations.api.mdx
create mode 100644 docs/api/post-v-1-companies-company-id-pay-schedules-assign.ParamsDetails.json
create mode 100644 docs/api/post-v-1-companies-company-id-pay-schedules-assign.RequestSchema.json
create mode 100644 docs/api/post-v-1-companies-company-id-pay-schedules-assign.StatusCodes.json
create mode 100644 docs/api/post-v-1-companies-company-id-pay-schedules-assign.api.mdx
create mode 100644 docs/api/post-v-1-companies-company-id-pay-schedules-assignment-preview.ParamsDetails.json
create mode 100644 docs/api/post-v-1-companies-company-id-pay-schedules-assignment-preview.RequestSchema.json
create mode 100644 docs/api/post-v-1-companies-company-id-pay-schedules-assignment-preview.StatusCodes.json
create mode 100644 docs/api/post-v-1-companies-company-id-pay-schedules-assignment-preview.api.mdx
create mode 100644 docs/api/post-v-1-companies-company-id-pay-schedules.ParamsDetails.json
create mode 100644 docs/api/post-v-1-companies-company-id-pay-schedules.RequestSchema.json
create mode 100644 docs/api/post-v-1-companies-company-id-pay-schedules.StatusCodes.json
create mode 100644 docs/api/post-v-1-companies-company-id-pay-schedules.api.mdx
create mode 100644 docs/api/post-v-1-companies-company-id-payrolls.ParamsDetails.json
create mode 100644 docs/api/post-v-1-companies-company-id-payrolls.RequestSchema.json
create mode 100644 docs/api/post-v-1-companies-company-id-payrolls.StatusCodes.json
create mode 100644 docs/api/post-v-1-companies-company-id-payrolls.api.mdx
create mode 100644 docs/api/post-v-1-companies-company-id-people-batches.ParamsDetails.json
create mode 100644 docs/api/post-v-1-companies-company-id-people-batches.RequestSchema.json
create mode 100644 docs/api/post-v-1-companies-company-id-people-batches.StatusCodes.json
create mode 100644 docs/api/post-v-1-companies-company-id-people-batches.api.mdx
create mode 100644 docs/api/post-v-1-companies-company-id-reports-employees-annual-fica-wage.ParamsDetails.json
create mode 100644 docs/api/post-v-1-companies-company-id-reports-employees-annual-fica-wage.RequestSchema.json
create mode 100644 docs/api/post-v-1-companies-company-id-reports-employees-annual-fica-wage.StatusCodes.json
create mode 100644 docs/api/post-v-1-companies-company-id-reports-employees-annual-fica-wage.api.mdx
create mode 100644 docs/api/post-v-1-companies-company-uuid-contractors.ParamsDetails.json
create mode 100644 docs/api/post-v-1-companies-company-uuid-contractors.RequestSchema.json
create mode 100644 docs/api/post-v-1-companies-company-uuid-contractors.StatusCodes.json
create mode 100644 docs/api/post-v-1-companies-company-uuid-contractors.api.mdx
create mode 100644 docs/api/post-v-1-companies-company-uuid-holiday-pay-policy.ParamsDetails.json
create mode 100644 docs/api/post-v-1-companies-company-uuid-holiday-pay-policy.RequestSchema.json
create mode 100644 docs/api/post-v-1-companies-company-uuid-holiday-pay-policy.StatusCodes.json
create mode 100644 docs/api/post-v-1-companies-company-uuid-holiday-pay-policy.api.mdx
create mode 100644 docs/api/post-v-1-companies-company-uuid-signatories-invite.ParamsDetails.json
create mode 100644 docs/api/post-v-1-companies-company-uuid-signatories-invite.RequestSchema.json
create mode 100644 docs/api/post-v-1-companies-company-uuid-signatories-invite.StatusCodes.json
create mode 100644 docs/api/post-v-1-companies-company-uuid-signatories-invite.api.mdx
create mode 100644 docs/api/post-v-1-companies-company-uuid-time-off-policies.ParamsDetails.json
create mode 100644 docs/api/post-v-1-companies-company-uuid-time-off-policies.RequestSchema.json
create mode 100644 docs/api/post-v-1-companies-company-uuid-time-off-policies.StatusCodes.json
create mode 100644 docs/api/post-v-1-companies-company-uuid-time-off-policies.api.mdx
create mode 100644 docs/api/post-v-1-company-flows.ParamsDetails.json
create mode 100644 docs/api/post-v-1-company-flows.RequestSchema.json
create mode 100644 docs/api/post-v-1-company-flows.StatusCodes.json
create mode 100644 docs/api/post-v-1-company-flows.api.mdx
create mode 100644 docs/api/post-v-1-company-signatories.ParamsDetails.json
create mode 100644 docs/api/post-v-1-company-signatories.RequestSchema.json
create mode 100644 docs/api/post-v-1-company-signatories.StatusCodes.json
create mode 100644 docs/api/post-v-1-company-signatories.api.mdx
create mode 100644 docs/api/post-v-1-compensations-compensation-id.ParamsDetails.json
create mode 100644 docs/api/post-v-1-compensations-compensation-id.RequestSchema.json
create mode 100644 docs/api/post-v-1-compensations-compensation-id.StatusCodes.json
create mode 100644 docs/api/post-v-1-compensations-compensation-id.api.mdx
create mode 100644 docs/api/post-v-1-contractors-contractor-uuid-bank-accounts.ParamsDetails.json
create mode 100644 docs/api/post-v-1-contractors-contractor-uuid-bank-accounts.RequestSchema.json
create mode 100644 docs/api/post-v-1-contractors-contractor-uuid-bank-accounts.StatusCodes.json
create mode 100644 docs/api/post-v-1-contractors-contractor-uuid-bank-accounts.api.mdx
create mode 100644 docs/api/post-v-1-employees-employee-id-bank-accounts.ParamsDetails.json
create mode 100644 docs/api/post-v-1-employees-employee-id-bank-accounts.RequestSchema.json
create mode 100644 docs/api/post-v-1-employees-employee-id-bank-accounts.StatusCodes.json
create mode 100644 docs/api/post-v-1-employees-employee-id-bank-accounts.api.mdx
create mode 100644 docs/api/post-v-1-employees-employee-id-employee-benefits.ParamsDetails.json
create mode 100644 docs/api/post-v-1-employees-employee-id-employee-benefits.RequestSchema.json
create mode 100644 docs/api/post-v-1-employees-employee-id-employee-benefits.StatusCodes.json
create mode 100644 docs/api/post-v-1-employees-employee-id-employee-benefits.api.mdx
create mode 100644 docs/api/post-v-1-employees-employee-id-garnishments.ParamsDetails.json
create mode 100644 docs/api/post-v-1-employees-employee-id-garnishments.RequestSchema.json
create mode 100644 docs/api/post-v-1-employees-employee-id-garnishments.StatusCodes.json
create mode 100644 docs/api/post-v-1-employees-employee-id-garnishments.api.mdx
create mode 100644 docs/api/post-v-1-employees-employee-id-home-addresses.ParamsDetails.json
create mode 100644 docs/api/post-v-1-employees-employee-id-home-addresses.RequestSchema.json
create mode 100644 docs/api/post-v-1-employees-employee-id-home-addresses.StatusCodes.json
create mode 100644 docs/api/post-v-1-employees-employee-id-home-addresses.api.mdx
create mode 100644 docs/api/post-v-1-employees-employee-id-recurring-reimbursements.ParamsDetails.json
create mode 100644 docs/api/post-v-1-employees-employee-id-recurring-reimbursements.RequestSchema.json
create mode 100644 docs/api/post-v-1-employees-employee-id-recurring-reimbursements.StatusCodes.json
create mode 100644 docs/api/post-v-1-employees-employee-id-recurring-reimbursements.api.mdx
create mode 100644 docs/api/post-v-1-employees-employee-id-rehire.ParamsDetails.json
create mode 100644 docs/api/post-v-1-employees-employee-id-rehire.RequestSchema.json
create mode 100644 docs/api/post-v-1-employees-employee-id-rehire.StatusCodes.json
create mode 100644 docs/api/post-v-1-employees-employee-id-rehire.api.mdx
create mode 100644 docs/api/post-v-1-employees-employee-id-salary-estimates.ParamsDetails.json
create mode 100644 docs/api/post-v-1-employees-employee-id-salary-estimates.RequestSchema.json
create mode 100644 docs/api/post-v-1-employees-employee-id-salary-estimates.StatusCodes.json
create mode 100644 docs/api/post-v-1-employees-employee-id-salary-estimates.api.mdx
create mode 100644 docs/api/post-v-1-employees-employee-id-terminations.ParamsDetails.json
create mode 100644 docs/api/post-v-1-employees-employee-id-terminations.RequestSchema.json
create mode 100644 docs/api/post-v-1-employees-employee-id-terminations.StatusCodes.json
create mode 100644 docs/api/post-v-1-employees-employee-id-terminations.api.mdx
create mode 100644 docs/api/post-v-1-employees-employee-id-work-addresses.ParamsDetails.json
create mode 100644 docs/api/post-v-1-employees-employee-id-work-addresses.RequestSchema.json
create mode 100644 docs/api/post-v-1-employees-employee-id-work-addresses.StatusCodes.json
create mode 100644 docs/api/post-v-1-employees-employee-id-work-addresses.api.mdx
create mode 100644 docs/api/post-v-1-employees-employee-uuid-section-603-high-earner-statuses.ParamsDetails.json
create mode 100644 docs/api/post-v-1-employees-employee-uuid-section-603-high-earner-statuses.RequestSchema.json
create mode 100644 docs/api/post-v-1-employees-employee-uuid-section-603-high-earner-statuses.StatusCodes.json
create mode 100644 docs/api/post-v-1-employees-employee-uuid-section-603-high-earner-statuses.api.mdx
create mode 100644 docs/api/post-v-1-employees.ParamsDetails.json
create mode 100644 docs/api/post-v-1-employees.RequestSchema.json
create mode 100644 docs/api/post-v-1-employees.StatusCodes.json
create mode 100644 docs/api/post-v-1-employees.api.mdx
create mode 100644 docs/api/post-v-1-external-payroll.ParamsDetails.json
create mode 100644 docs/api/post-v-1-external-payroll.RequestSchema.json
create mode 100644 docs/api/post-v-1-external-payroll.StatusCodes.json
create mode 100644 docs/api/post-v-1-external-payroll.api.mdx
create mode 100644 docs/api/post-v-1-historical-employees.ParamsDetails.json
create mode 100644 docs/api/post-v-1-historical-employees.RequestSchema.json
create mode 100644 docs/api/post-v-1-historical-employees.StatusCodes.json
create mode 100644 docs/api/post-v-1-historical-employees.api.mdx
create mode 100644 docs/api/post-v-1-jobs-job-id.ParamsDetails.json
create mode 100644 docs/api/post-v-1-jobs-job-id.RequestSchema.json
create mode 100644 docs/api/post-v-1-jobs-job-id.StatusCodes.json
create mode 100644 docs/api/post-v-1-jobs-job-id.api.mdx
create mode 100644 docs/api/post-v-1-partner-managed-companies.ParamsDetails.json
create mode 100644 docs/api/post-v-1-partner-managed-companies.RequestSchema.json
create mode 100644 docs/api/post-v-1-partner-managed-companies.StatusCodes.json
create mode 100644 docs/api/post-v-1-partner-managed-companies.api.mdx
create mode 100644 docs/api/post-v-1-payrolls-payroll-id-calculate-accruing-time-off-hours.ParamsDetails.json
create mode 100644 docs/api/post-v-1-payrolls-payroll-id-calculate-accruing-time-off-hours.RequestSchema.json
create mode 100644 docs/api/post-v-1-payrolls-payroll-id-calculate-accruing-time-off-hours.StatusCodes.json
create mode 100644 docs/api/post-v-1-payrolls-payroll-id-calculate-accruing-time-off-hours.api.mdx
create mode 100644 docs/api/post-v-1-payrolls-payroll-uuid-generated-documents-printable-payroll-checks.ParamsDetails.json
create mode 100644 docs/api/post-v-1-payrolls-payroll-uuid-generated-documents-printable-payroll-checks.RequestSchema.json
create mode 100644 docs/api/post-v-1-payrolls-payroll-uuid-generated-documents-printable-payroll-checks.StatusCodes.json
create mode 100644 docs/api/post-v-1-payrolls-payroll-uuid-generated-documents-printable-payroll-checks.api.mdx
create mode 100644 docs/api/post-v-1-plaid-processor-token.ParamsDetails.json
create mode 100644 docs/api/post-v-1-plaid-processor-token.RequestSchema.json
create mode 100644 docs/api/post-v-1-plaid-processor-token.StatusCodes.json
create mode 100644 docs/api/post-v-1-plaid-processor-token.api.mdx
create mode 100644 docs/api/post-v-1-salary-estimates-uuid-accept.ParamsDetails.json
create mode 100644 docs/api/post-v-1-salary-estimates-uuid-accept.RequestSchema.json
create mode 100644 docs/api/post-v-1-salary-estimates-uuid-accept.StatusCodes.json
create mode 100644 docs/api/post-v-1-salary-estimates-uuid-accept.api.mdx
create mode 100644 docs/api/post-v-1-sandbox-generate-1099.ParamsDetails.json
create mode 100644 docs/api/post-v-1-sandbox-generate-1099.RequestSchema.json
create mode 100644 docs/api/post-v-1-sandbox-generate-1099.StatusCodes.json
create mode 100644 docs/api/post-v-1-sandbox-generate-1099.api.mdx
create mode 100644 docs/api/post-v-1-sandbox-generate-w-2.ParamsDetails.json
create mode 100644 docs/api/post-v-1-sandbox-generate-w-2.RequestSchema.json
create mode 100644 docs/api/post-v-1-sandbox-generate-w-2.StatusCodes.json
create mode 100644 docs/api/post-v-1-sandbox-generate-w-2.api.mdx
create mode 100644 docs/api/post-v-1-webhook-subscription.ParamsDetails.json
create mode 100644 docs/api/post-v-1-webhook-subscription.RequestSchema.json
create mode 100644 docs/api/post-v-1-webhook-subscription.StatusCodes.json
create mode 100644 docs/api/post-v-1-webhook-subscription.api.mdx
create mode 100644 docs/api/put-add-people-to-department.ParamsDetails.json
create mode 100644 docs/api/put-add-people-to-department.RequestSchema.json
create mode 100644 docs/api/put-add-people-to-department.StatusCodes.json
create mode 100644 docs/api/put-add-people-to-department.api.mdx
create mode 100644 docs/api/put-api-v-1-companies-company-id-payrolls-payroll-id-cancel.ParamsDetails.json
create mode 100644 docs/api/put-api-v-1-companies-company-id-payrolls-payroll-id-cancel.RequestSchema.json
create mode 100644 docs/api/put-api-v-1-companies-company-id-payrolls-payroll-id-cancel.StatusCodes.json
create mode 100644 docs/api/put-api-v-1-companies-company-id-payrolls-payroll-id-cancel.api.mdx
create mode 100644 docs/api/put-departments.ParamsDetails.json
create mode 100644 docs/api/put-departments.RequestSchema.json
create mode 100644 docs/api/put-departments.StatusCodes.json
create mode 100644 docs/api/put-departments.api.mdx
create mode 100644 docs/api/put-remove-people-from-department.ParamsDetails.json
create mode 100644 docs/api/put-remove-people-from-department.RequestSchema.json
create mode 100644 docs/api/put-remove-people-from-department.StatusCodes.json
create mode 100644 docs/api/put-remove-people-from-department.api.mdx
create mode 100644 docs/api/put-v-1-companies-company-id-bank-accounts-verify.ParamsDetails.json
create mode 100644 docs/api/put-v-1-companies-company-id-bank-accounts-verify.RequestSchema.json
create mode 100644 docs/api/put-v-1-companies-company-id-bank-accounts-verify.StatusCodes.json
create mode 100644 docs/api/put-v-1-companies-company-id-bank-accounts-verify.api.mdx
create mode 100644 docs/api/put-v-1-companies-company-id-earning-types-earning-type-uuid.ParamsDetails.json
create mode 100644 docs/api/put-v-1-companies-company-id-earning-types-earning-type-uuid.RequestSchema.json
create mode 100644 docs/api/put-v-1-companies-company-id-earning-types-earning-type-uuid.StatusCodes.json
create mode 100644 docs/api/put-v-1-companies-company-id-earning-types-earning-type-uuid.api.mdx
create mode 100644 docs/api/put-v-1-companies-company-id-federal-tax-details.ParamsDetails.json
create mode 100644 docs/api/put-v-1-companies-company-id-federal-tax-details.RequestSchema.json
create mode 100644 docs/api/put-v-1-companies-company-id-federal-tax-details.StatusCodes.json
create mode 100644 docs/api/put-v-1-companies-company-id-federal-tax-details.api.mdx
create mode 100644 docs/api/put-v-1-companies-company-id-pay-schedules-pay-schedule-id.ParamsDetails.json
create mode 100644 docs/api/put-v-1-companies-company-id-pay-schedules-pay-schedule-id.RequestSchema.json
create mode 100644 docs/api/put-v-1-companies-company-id-pay-schedules-pay-schedule-id.StatusCodes.json
create mode 100644 docs/api/put-v-1-companies-company-id-pay-schedules-pay-schedule-id.api.mdx
create mode 100644 docs/api/put-v-1-companies-company-id-payrolls-payroll-id-calculate.ParamsDetails.json
create mode 100644 docs/api/put-v-1-companies-company-id-payrolls-payroll-id-calculate.RequestSchema.json
create mode 100644 docs/api/put-v-1-companies-company-id-payrolls-payroll-id-calculate.StatusCodes.json
create mode 100644 docs/api/put-v-1-companies-company-id-payrolls-payroll-id-calculate.api.mdx
create mode 100644 docs/api/put-v-1-companies-company-id-payrolls-payroll-id-prepare.ParamsDetails.json
create mode 100644 docs/api/put-v-1-companies-company-id-payrolls-payroll-id-prepare.RequestSchema.json
create mode 100644 docs/api/put-v-1-companies-company-id-payrolls-payroll-id-prepare.StatusCodes.json
create mode 100644 docs/api/put-v-1-companies-company-id-payrolls-payroll-id-prepare.api.mdx
create mode 100644 docs/api/put-v-1-companies-company-id-payrolls-payroll-id-submit.ParamsDetails.json
create mode 100644 docs/api/put-v-1-companies-company-id-payrolls-payroll-id-submit.RequestSchema.json
create mode 100644 docs/api/put-v-1-companies-company-id-payrolls-payroll-id-submit.StatusCodes.json
create mode 100644 docs/api/put-v-1-companies-company-id-payrolls-payroll-id-submit.api.mdx
create mode 100644 docs/api/put-v-1-companies-company-id-payrolls.ParamsDetails.json
create mode 100644 docs/api/put-v-1-companies-company-id-payrolls.RequestSchema.json
create mode 100644 docs/api/put-v-1-companies-company-id-payrolls.StatusCodes.json
create mode 100644 docs/api/put-v-1-companies-company-id-payrolls.api.mdx
create mode 100644 docs/api/put-v-1-companies-company-uuid-holiday-pay-policy-add.ParamsDetails.json
create mode 100644 docs/api/put-v-1-companies-company-uuid-holiday-pay-policy-add.RequestSchema.json
create mode 100644 docs/api/put-v-1-companies-company-uuid-holiday-pay-policy-add.StatusCodes.json
create mode 100644 docs/api/put-v-1-companies-company-uuid-holiday-pay-policy-add.api.mdx
create mode 100644 docs/api/put-v-1-companies-company-uuid-holiday-pay-policy-remove.ParamsDetails.json
create mode 100644 docs/api/put-v-1-companies-company-uuid-holiday-pay-policy-remove.RequestSchema.json
create mode 100644 docs/api/put-v-1-companies-company-uuid-holiday-pay-policy-remove.StatusCodes.json
create mode 100644 docs/api/put-v-1-companies-company-uuid-holiday-pay-policy-remove.api.mdx
create mode 100644 docs/api/put-v-1-companies-company-uuid-holiday-pay-policy.ParamsDetails.json
create mode 100644 docs/api/put-v-1-companies-company-uuid-holiday-pay-policy.RequestSchema.json
create mode 100644 docs/api/put-v-1-companies-company-uuid-holiday-pay-policy.StatusCodes.json
create mode 100644 docs/api/put-v-1-companies-company-uuid-holiday-pay-policy.api.mdx
create mode 100644 docs/api/put-v-1-companies-company-uuid-signatories-signatory-uuid.ParamsDetails.json
create mode 100644 docs/api/put-v-1-companies-company-uuid-signatories-signatory-uuid.RequestSchema.json
create mode 100644 docs/api/put-v-1-companies-company-uuid-signatories-signatory-uuid.StatusCodes.json
create mode 100644 docs/api/put-v-1-companies-company-uuid-signatories-signatory-uuid.api.mdx
create mode 100644 docs/api/put-v-1-companies-company-uuid-tax-requirements-state.ParamsDetails.json
create mode 100644 docs/api/put-v-1-companies-company-uuid-tax-requirements-state.RequestSchema.json
create mode 100644 docs/api/put-v-1-companies-company-uuid-tax-requirements-state.StatusCodes.json
create mode 100644 docs/api/put-v-1-companies-company-uuid-tax-requirements-state.api.mdx
create mode 100644 docs/api/put-v-1-companies.ParamsDetails.json
create mode 100644 docs/api/put-v-1-companies.RequestSchema.json
create mode 100644 docs/api/put-v-1-companies.StatusCodes.json
create mode 100644 docs/api/put-v-1-companies.api.mdx
create mode 100644 docs/api/put-v-1-company-benefits-company-benefit-id-contribution-exclusions.ParamsDetails.json
create mode 100644 docs/api/put-v-1-company-benefits-company-benefit-id-contribution-exclusions.RequestSchema.json
create mode 100644 docs/api/put-v-1-company-benefits-company-benefit-id-contribution-exclusions.StatusCodes.json
create mode 100644 docs/api/put-v-1-company-benefits-company-benefit-id-contribution-exclusions.api.mdx
create mode 100644 docs/api/put-v-1-company-benefits-company-benefit-id-employee-benefits.ParamsDetails.json
create mode 100644 docs/api/put-v-1-company-benefits-company-benefit-id-employee-benefits.RequestSchema.json
create mode 100644 docs/api/put-v-1-company-benefits-company-benefit-id-employee-benefits.StatusCodes.json
create mode 100644 docs/api/put-v-1-company-benefits-company-benefit-id-employee-benefits.api.mdx
create mode 100644 docs/api/put-v-1-company-benefits-company-benefit-id.ParamsDetails.json
create mode 100644 docs/api/put-v-1-company-benefits-company-benefit-id.RequestSchema.json
create mode 100644 docs/api/put-v-1-company-benefits-company-benefit-id.StatusCodes.json
create mode 100644 docs/api/put-v-1-company-benefits-company-benefit-id.api.mdx
create mode 100644 docs/api/put-v-1-company-form-sign.ParamsDetails.json
create mode 100644 docs/api/put-v-1-company-form-sign.RequestSchema.json
create mode 100644 docs/api/put-v-1-company-form-sign.StatusCodes.json
create mode 100644 docs/api/put-v-1-company-form-sign.api.mdx
create mode 100644 docs/api/put-v-1-company-industry.ParamsDetails.json
create mode 100644 docs/api/put-v-1-company-industry.RequestSchema.json
create mode 100644 docs/api/put-v-1-company-industry.StatusCodes.json
create mode 100644 docs/api/put-v-1-company-industry.api.mdx
create mode 100644 docs/api/put-v-1-company-payment-configs.ParamsDetails.json
create mode 100644 docs/api/put-v-1-company-payment-configs.RequestSchema.json
create mode 100644 docs/api/put-v-1-company-payment-configs.StatusCodes.json
create mode 100644 docs/api/put-v-1-company-payment-configs.api.mdx
create mode 100644 docs/api/put-v-1-compensations-compensation-id.ParamsDetails.json
create mode 100644 docs/api/put-v-1-compensations-compensation-id.RequestSchema.json
create mode 100644 docs/api/put-v-1-compensations-compensation-id.StatusCodes.json
create mode 100644 docs/api/put-v-1-compensations-compensation-id.api.mdx
create mode 100644 docs/api/put-v-1-contractor-document-sign.ParamsDetails.json
create mode 100644 docs/api/put-v-1-contractor-document-sign.RequestSchema.json
create mode 100644 docs/api/put-v-1-contractor-document-sign.StatusCodes.json
create mode 100644 docs/api/put-v-1-contractor-document-sign.api.mdx
create mode 100644 docs/api/put-v-1-contractor-payment-groups-contractor-payment-group-id-fund.ParamsDetails.json
create mode 100644 docs/api/put-v-1-contractor-payment-groups-contractor-payment-group-id-fund.RequestSchema.json
create mode 100644 docs/api/put-v-1-contractor-payment-groups-contractor-payment-group-id-fund.StatusCodes.json
create mode 100644 docs/api/put-v-1-contractor-payment-groups-contractor-payment-group-id-fund.api.mdx
create mode 100644 docs/api/put-v-1-contractors-contractor-id-payment-method.ParamsDetails.json
create mode 100644 docs/api/put-v-1-contractors-contractor-id-payment-method.RequestSchema.json
create mode 100644 docs/api/put-v-1-contractors-contractor-id-payment-method.StatusCodes.json
create mode 100644 docs/api/put-v-1-contractors-contractor-id-payment-method.api.mdx
create mode 100644 docs/api/put-v-1-contractors-contractor-uuid-address.ParamsDetails.json
create mode 100644 docs/api/put-v-1-contractors-contractor-uuid-address.RequestSchema.json
create mode 100644 docs/api/put-v-1-contractors-contractor-uuid-address.StatusCodes.json
create mode 100644 docs/api/put-v-1-contractors-contractor-uuid-address.api.mdx
create mode 100644 docs/api/put-v-1-contractors-contractor-uuid-onboarding-status.ParamsDetails.json
create mode 100644 docs/api/put-v-1-contractors-contractor-uuid-onboarding-status.RequestSchema.json
create mode 100644 docs/api/put-v-1-contractors-contractor-uuid-onboarding-status.StatusCodes.json
create mode 100644 docs/api/put-v-1-contractors-contractor-uuid-onboarding-status.api.mdx
create mode 100644 docs/api/put-v-1-contractors-contractor-uuid.ParamsDetails.json
create mode 100644 docs/api/put-v-1-contractors-contractor-uuid.RequestSchema.json
create mode 100644 docs/api/put-v-1-contractors-contractor-uuid.StatusCodes.json
create mode 100644 docs/api/put-v-1-contractors-contractor-uuid.api.mdx
create mode 100644 docs/api/put-v-1-employee-benefits-employee-benefit-id.ParamsDetails.json
create mode 100644 docs/api/put-v-1-employee-benefits-employee-benefit-id.RequestSchema.json
create mode 100644 docs/api/put-v-1-employee-benefits-employee-benefit-id.StatusCodes.json
create mode 100644 docs/api/put-v-1-employee-benefits-employee-benefit-id.api.mdx
create mode 100644 docs/api/put-v-1-employee-form-sign.ParamsDetails.json
create mode 100644 docs/api/put-v-1-employee-form-sign.RequestSchema.json
create mode 100644 docs/api/put-v-1-employee-form-sign.StatusCodes.json
create mode 100644 docs/api/put-v-1-employee-form-sign.api.mdx
create mode 100644 docs/api/put-v-1-employees-employee-id-bank-accounts.ParamsDetails.json
create mode 100644 docs/api/put-v-1-employees-employee-id-bank-accounts.RequestSchema.json
create mode 100644 docs/api/put-v-1-employees-employee-id-bank-accounts.StatusCodes.json
create mode 100644 docs/api/put-v-1-employees-employee-id-bank-accounts.api.mdx
create mode 100644 docs/api/put-v-1-employees-employee-id-federal-taxes.ParamsDetails.json
create mode 100644 docs/api/put-v-1-employees-employee-id-federal-taxes.RequestSchema.json
create mode 100644 docs/api/put-v-1-employees-employee-id-federal-taxes.StatusCodes.json
create mode 100644 docs/api/put-v-1-employees-employee-id-federal-taxes.api.mdx
create mode 100644 docs/api/put-v-1-employees-employee-id-i-9-authorization-documents.ParamsDetails.json
create mode 100644 docs/api/put-v-1-employees-employee-id-i-9-authorization-documents.RequestSchema.json
create mode 100644 docs/api/put-v-1-employees-employee-id-i-9-authorization-documents.StatusCodes.json
create mode 100644 docs/api/put-v-1-employees-employee-id-i-9-authorization-documents.api.mdx
create mode 100644 docs/api/put-v-1-employees-employee-id-i-9-authorization-employer-sign.ParamsDetails.json
create mode 100644 docs/api/put-v-1-employees-employee-id-i-9-authorization-employer-sign.RequestSchema.json
create mode 100644 docs/api/put-v-1-employees-employee-id-i-9-authorization-employer-sign.StatusCodes.json
create mode 100644 docs/api/put-v-1-employees-employee-id-i-9-authorization-employer-sign.api.mdx
create mode 100644 docs/api/put-v-1-employees-employee-id-i-9-authorization.ParamsDetails.json
create mode 100644 docs/api/put-v-1-employees-employee-id-i-9-authorization.RequestSchema.json
create mode 100644 docs/api/put-v-1-employees-employee-id-i-9-authorization.StatusCodes.json
create mode 100644 docs/api/put-v-1-employees-employee-id-i-9-authorization.api.mdx
create mode 100644 docs/api/put-v-1-employees-employee-id-onboarding-documents-config.ParamsDetails.json
create mode 100644 docs/api/put-v-1-employees-employee-id-onboarding-documents-config.RequestSchema.json
create mode 100644 docs/api/put-v-1-employees-employee-id-onboarding-documents-config.StatusCodes.json
create mode 100644 docs/api/put-v-1-employees-employee-id-onboarding-documents-config.api.mdx
create mode 100644 docs/api/put-v-1-employees-employee-id-onboarding-status.ParamsDetails.json
create mode 100644 docs/api/put-v-1-employees-employee-id-onboarding-status.RequestSchema.json
create mode 100644 docs/api/put-v-1-employees-employee-id-onboarding-status.StatusCodes.json
create mode 100644 docs/api/put-v-1-employees-employee-id-onboarding-status.api.mdx
create mode 100644 docs/api/put-v-1-employees-employee-id-payment-method.ParamsDetails.json
create mode 100644 docs/api/put-v-1-employees-employee-id-payment-method.RequestSchema.json
create mode 100644 docs/api/put-v-1-employees-employee-id-payment-method.StatusCodes.json
create mode 100644 docs/api/put-v-1-employees-employee-id-payment-method.api.mdx
create mode 100644 docs/api/put-v-1-employees-employee-id-rehire.ParamsDetails.json
create mode 100644 docs/api/put-v-1-employees-employee-id-rehire.RequestSchema.json
create mode 100644 docs/api/put-v-1-employees-employee-id-rehire.StatusCodes.json
create mode 100644 docs/api/put-v-1-employees-employee-id-rehire.api.mdx
create mode 100644 docs/api/put-v-1-employees-employee-id-state-taxes.ParamsDetails.json
create mode 100644 docs/api/put-v-1-employees-employee-id-state-taxes.RequestSchema.json
create mode 100644 docs/api/put-v-1-employees-employee-id-state-taxes.StatusCodes.json
create mode 100644 docs/api/put-v-1-employees-employee-id-state-taxes.api.mdx
create mode 100644 docs/api/put-v-1-employees.ParamsDetails.json
create mode 100644 docs/api/put-v-1-employees.RequestSchema.json
create mode 100644 docs/api/put-v-1-employees.StatusCodes.json
create mode 100644 docs/api/put-v-1-employees.api.mdx
create mode 100644 docs/api/put-v-1-external-payroll.ParamsDetails.json
create mode 100644 docs/api/put-v-1-external-payroll.RequestSchema.json
create mode 100644 docs/api/put-v-1-external-payroll.StatusCodes.json
create mode 100644 docs/api/put-v-1-external-payroll.api.mdx
create mode 100644 docs/api/put-v-1-garnishments-garnishment-id.ParamsDetails.json
create mode 100644 docs/api/put-v-1-garnishments-garnishment-id.RequestSchema.json
create mode 100644 docs/api/put-v-1-garnishments-garnishment-id.StatusCodes.json
create mode 100644 docs/api/put-v-1-garnishments-garnishment-id.api.mdx
create mode 100644 docs/api/put-v-1-historical-employees.ParamsDetails.json
create mode 100644 docs/api/put-v-1-historical-employees.RequestSchema.json
create mode 100644 docs/api/put-v-1-historical-employees.StatusCodes.json
create mode 100644 docs/api/put-v-1-historical-employees.api.mdx
create mode 100644 docs/api/put-v-1-home-addresses-home-address-uuid.ParamsDetails.json
create mode 100644 docs/api/put-v-1-home-addresses-home-address-uuid.RequestSchema.json
create mode 100644 docs/api/put-v-1-home-addresses-home-address-uuid.StatusCodes.json
create mode 100644 docs/api/put-v-1-home-addresses-home-address-uuid.api.mdx
create mode 100644 docs/api/put-v-1-jobs-job-id.ParamsDetails.json
create mode 100644 docs/api/put-v-1-jobs-job-id.RequestSchema.json
create mode 100644 docs/api/put-v-1-jobs-job-id.StatusCodes.json
create mode 100644 docs/api/put-v-1-jobs-job-id.api.mdx
create mode 100644 docs/api/put-v-1-locations-location-id.ParamsDetails.json
create mode 100644 docs/api/put-v-1-locations-location-id.RequestSchema.json
create mode 100644 docs/api/put-v-1-locations-location-id.StatusCodes.json
create mode 100644 docs/api/put-v-1-locations-location-id.api.mdx
create mode 100644 docs/api/put-v-1-partner-managed-companies-company-uuid-migrate.ParamsDetails.json
create mode 100644 docs/api/put-v-1-partner-managed-companies-company-uuid-migrate.RequestSchema.json
create mode 100644 docs/api/put-v-1-partner-managed-companies-company-uuid-migrate.StatusCodes.json
create mode 100644 docs/api/put-v-1-partner-managed-companies-company-uuid-migrate.api.mdx
create mode 100644 docs/api/put-v-1-recurring-reimbursements.ParamsDetails.json
create mode 100644 docs/api/put-v-1-recurring-reimbursements.RequestSchema.json
create mode 100644 docs/api/put-v-1-recurring-reimbursements.StatusCodes.json
create mode 100644 docs/api/put-v-1-recurring-reimbursements.api.mdx
create mode 100644 docs/api/put-v-1-salary-estimates-id.ParamsDetails.json
create mode 100644 docs/api/put-v-1-salary-estimates-id.RequestSchema.json
create mode 100644 docs/api/put-v-1-salary-estimates-id.StatusCodes.json
create mode 100644 docs/api/put-v-1-salary-estimates-id.api.mdx
create mode 100644 docs/api/put-v-1-tax-liabilities-finish.ParamsDetails.json
create mode 100644 docs/api/put-v-1-tax-liabilities-finish.RequestSchema.json
create mode 100644 docs/api/put-v-1-tax-liabilities-finish.StatusCodes.json
create mode 100644 docs/api/put-v-1-tax-liabilities-finish.api.mdx
create mode 100644 docs/api/put-v-1-tax-liabilities.ParamsDetails.json
create mode 100644 docs/api/put-v-1-tax-liabilities.RequestSchema.json
create mode 100644 docs/api/put-v-1-tax-liabilities.StatusCodes.json
create mode 100644 docs/api/put-v-1-tax-liabilities.api.mdx
create mode 100644 docs/api/put-v-1-terminations-employee-id.ParamsDetails.json
create mode 100644 docs/api/put-v-1-terminations-employee-id.RequestSchema.json
create mode 100644 docs/api/put-v-1-terminations-employee-id.StatusCodes.json
create mode 100644 docs/api/put-v-1-terminations-employee-id.api.mdx
create mode 100644 docs/api/put-v-1-time-off-policies-time-off-policy-uuid-add-employees.ParamsDetails.json
create mode 100644 docs/api/put-v-1-time-off-policies-time-off-policy-uuid-add-employees.RequestSchema.json
create mode 100644 docs/api/put-v-1-time-off-policies-time-off-policy-uuid-add-employees.StatusCodes.json
create mode 100644 docs/api/put-v-1-time-off-policies-time-off-policy-uuid-add-employees.api.mdx
create mode 100644 docs/api/put-v-1-time-off-policies-time-off-policy-uuid-balance.ParamsDetails.json
create mode 100644 docs/api/put-v-1-time-off-policies-time-off-policy-uuid-balance.RequestSchema.json
create mode 100644 docs/api/put-v-1-time-off-policies-time-off-policy-uuid-balance.StatusCodes.json
create mode 100644 docs/api/put-v-1-time-off-policies-time-off-policy-uuid-balance.api.mdx
create mode 100644 docs/api/put-v-1-time-off-policies-time-off-policy-uuid-deactivate.ParamsDetails.json
create mode 100644 docs/api/put-v-1-time-off-policies-time-off-policy-uuid-deactivate.RequestSchema.json
create mode 100644 docs/api/put-v-1-time-off-policies-time-off-policy-uuid-deactivate.StatusCodes.json
create mode 100644 docs/api/put-v-1-time-off-policies-time-off-policy-uuid-deactivate.api.mdx
create mode 100644 docs/api/put-v-1-time-off-policies-time-off-policy-uuid-remove-employees.ParamsDetails.json
create mode 100644 docs/api/put-v-1-time-off-policies-time-off-policy-uuid-remove-employees.RequestSchema.json
create mode 100644 docs/api/put-v-1-time-off-policies-time-off-policy-uuid-remove-employees.StatusCodes.json
create mode 100644 docs/api/put-v-1-time-off-policies-time-off-policy-uuid-remove-employees.api.mdx
create mode 100644 docs/api/put-v-1-time-off-policies-time-off-policy-uuid.ParamsDetails.json
create mode 100644 docs/api/put-v-1-time-off-policies-time-off-policy-uuid.RequestSchema.json
create mode 100644 docs/api/put-v-1-time-off-policies-time-off-policy-uuid.StatusCodes.json
create mode 100644 docs/api/put-v-1-time-off-policies-time-off-policy-uuid.api.mdx
create mode 100644 docs/api/put-v-1-verify-webhook-subscription-uuid.ParamsDetails.json
create mode 100644 docs/api/put-v-1-verify-webhook-subscription-uuid.RequestSchema.json
create mode 100644 docs/api/put-v-1-verify-webhook-subscription-uuid.StatusCodes.json
create mode 100644 docs/api/put-v-1-verify-webhook-subscription-uuid.api.mdx
create mode 100644 docs/api/put-v-1-webhook-subscription-uuid.ParamsDetails.json
create mode 100644 docs/api/put-v-1-webhook-subscription-uuid.RequestSchema.json
create mode 100644 docs/api/put-v-1-webhook-subscription-uuid.StatusCodes.json
create mode 100644 docs/api/put-v-1-webhook-subscription-uuid.api.mdx
create mode 100644 docs/api/put-v-1-work-addresses-work-address-uuid.ParamsDetails.json
create mode 100644 docs/api/put-v-1-work-addresses-work-address-uuid.RequestSchema.json
create mode 100644 docs/api/put-v-1-work-addresses-work-address-uuid.StatusCodes.json
create mode 100644 docs/api/put-v-1-work-addresses-work-address-uuid.api.mdx
create mode 100644 docs/api/put-wire-in-requests-wire-in-request-uuid.ParamsDetails.json
create mode 100644 docs/api/put-wire-in-requests-wire-in-request-uuid.RequestSchema.json
create mode 100644 docs/api/put-wire-in-requests-wire-in-request-uuid.StatusCodes.json
create mode 100644 docs/api/put-wire-in-requests-wire-in-request-uuid.api.mdx
create mode 100644 docs/api/recovery-cases.tag.mdx
create mode 100644 docs/api/redebit-recovery-case.ParamsDetails.json
create mode 100644 docs/api/redebit-recovery-case.RequestSchema.json
create mode 100644 docs/api/redebit-recovery-case.StatusCodes.json
create mode 100644 docs/api/redebit-recovery-case.api.mdx
create mode 100644 docs/api/reimbursements.tag.mdx
create mode 100644 docs/api/reports.tag.mdx
create mode 100644 docs/api/salary-estimates.tag.mdx
create mode 100644 docs/api/schemas/admin.Schema.json
create mode 100644 docs/api/schemas/admin.schema.mdx
create mode 100644 docs/api/schemas/benefit-summary.Schema.json
create mode 100644 docs/api/schemas/benefit-summary.schema.mdx
create mode 100644 docs/api/schemas/benefit-type-requirements.Schema.json
create mode 100644 docs/api/schemas/benefit-type-requirements.schema.mdx
create mode 100644 docs/api/schemas/company-attachment.Schema.json
create mode 100644 docs/api/schemas/company-attachment.schema.mdx
create mode 100644 docs/api/schemas/company-bank-account.Schema.json
create mode 100644 docs/api/schemas/company-bank-account.schema.mdx
create mode 100644 docs/api/schemas/company-custom-field.Schema.json
create mode 100644 docs/api/schemas/company-custom-field.schema.mdx
create mode 100644 docs/api/schemas/company-onboarding-status.Schema.json
create mode 100644 docs/api/schemas/company-onboarding-status.schema.mdx
create mode 100644 docs/api/schemas/company.Schema.json
create mode 100644 docs/api/schemas/company.schema.mdx
create mode 100644 docs/api/schemas/contractor-bank-account.Schema.json
create mode 100644 docs/api/schemas/contractor-bank-account.schema.mdx
create mode 100644 docs/api/schemas/contractor-onboarding-status.Schema.json
create mode 100644 docs/api/schemas/contractor-onboarding-status.schema.mdx
create mode 100644 docs/api/schemas/contractor-payment-body.Schema.json
create mode 100644 docs/api/schemas/contractor-payment-body.schema.mdx
create mode 100644 docs/api/schemas/contractor-payment-for-group-preview.Schema.json
create mode 100644 docs/api/schemas/contractor-payment-for-group-preview.schema.mdx
create mode 100644 docs/api/schemas/contractor-payment-for-group.Schema.json
create mode 100644 docs/api/schemas/contractor-payment-for-group.schema.mdx
create mode 100644 docs/api/schemas/contractor-payment-group-minimal.Schema.json
create mode 100644 docs/api/schemas/contractor-payment-group-minimal.schema.mdx
create mode 100644 docs/api/schemas/contractor-payment-group-with-blockers.Schema.json
create mode 100644 docs/api/schemas/contractor-payment-group-with-blockers.schema.mdx
create mode 100644 docs/api/schemas/contractor-payment-group.Schema.json
create mode 100644 docs/api/schemas/contractor-payment-group.schema.mdx
create mode 100644 docs/api/schemas/contractor-payment-method.Schema.json
create mode 100644 docs/api/schemas/contractor-payment-method.schema.mdx
create mode 100644 docs/api/schemas/contractor-payment-summary-by-dates.Schema.json
create mode 100644 docs/api/schemas/contractor-payment-summary-by-dates.schema.mdx
create mode 100644 docs/api/schemas/contractor-payment-summary.Schema.json
create mode 100644 docs/api/schemas/contractor-payment-summary.schema.mdx
create mode 100644 docs/api/schemas/contractor-payment.Schema.json
create mode 100644 docs/api/schemas/contractor-payment.schema.mdx
create mode 100644 docs/api/schemas/contractor.Schema.json
create mode 100644 docs/api/schemas/contractor.schema.mdx
create mode 100644 docs/api/schemas/contribution-exclusion.Schema.json
create mode 100644 docs/api/schemas/contribution-exclusion.schema.mdx
create mode 100644 docs/api/schemas/document-signed.Schema.json
create mode 100644 docs/api/schemas/document-signed.schema.mdx
create mode 100644 docs/api/schemas/document.Schema.json
create mode 100644 docs/api/schemas/document.schema.mdx
create mode 100644 docs/api/schemas/earning-type.Schema.json
create mode 100644 docs/api/schemas/earning-type.schema.mdx
create mode 100644 docs/api/schemas/employee-bank-account.Schema.json
create mode 100644 docs/api/schemas/employee-bank-account.schema.mdx
create mode 100644 docs/api/schemas/employee-federal-tax-pre-2020.Schema.json
create mode 100644 docs/api/schemas/employee-federal-tax-pre-2020.schema.mdx
create mode 100644 docs/api/schemas/employee-federal-tax-rev-2020.Schema.json
create mode 100644 docs/api/schemas/employee-federal-tax-rev-2020.schema.mdx
create mode 100644 docs/api/schemas/employee-federal-tax.Schema.json
create mode 100644 docs/api/schemas/employee-federal-tax.schema.mdx
create mode 100644 docs/api/schemas/employee-pay-stub.Schema.json
create mode 100644 docs/api/schemas/employee-pay-stub.schema.mdx
create mode 100644 docs/api/schemas/employee-payment-method.Schema.json
create mode 100644 docs/api/schemas/employee-payment-method.schema.mdx
create mode 100644 docs/api/schemas/employee-state-tax.Schema.json
create mode 100644 docs/api/schemas/employee-state-tax.schema.mdx
create mode 100644 docs/api/schemas/external-payroll-basic.Schema.json
create mode 100644 docs/api/schemas/external-payroll-basic.schema.mdx
create mode 100644 docs/api/schemas/external-payroll-tax-suggestions.Schema.json
create mode 100644 docs/api/schemas/external-payroll-tax-suggestions.schema.mdx
create mode 100644 docs/api/schemas/external-payroll.Schema.json
create mode 100644 docs/api/schemas/external-payroll.schema.mdx
create mode 100644 docs/api/schemas/federal-tax-details.Schema.json
create mode 100644 docs/api/schemas/federal-tax-details.schema.mdx
create mode 100644 docs/api/schemas/flow.Schema.json
create mode 100644 docs/api/schemas/flow.schema.mdx
create mode 100644 docs/api/schemas/form.Schema.json
create mode 100644 docs/api/schemas/form.schema.mdx
create mode 100644 docs/api/schemas/i-9-authorization-document-option.Schema.json
create mode 100644 docs/api/schemas/i-9-authorization-document-option.schema.mdx
create mode 100644 docs/api/schemas/i-9-authorization-document.Schema.json
create mode 100644 docs/api/schemas/i-9-authorization-document.schema.mdx
create mode 100644 docs/api/schemas/i-9-authorization.Schema.json
create mode 100644 docs/api/schemas/i-9-authorization.schema.mdx
create mode 100644 docs/api/schemas/industry.Schema.json
create mode 100644 docs/api/schemas/industry.schema.mdx
create mode 100644 docs/api/schemas/pay-period.Schema.json
create mode 100644 docs/api/schemas/pay-period.schema.mdx
create mode 100644 docs/api/schemas/pay-schedule-assignment-department.Schema.json
create mode 100644 docs/api/schemas/pay-schedule-assignment-department.schema.mdx
create mode 100644 docs/api/schemas/pay-schedule-assignment-employee-change.Schema.json
create mode 100644 docs/api/schemas/pay-schedule-assignment-employee-change.schema.mdx
create mode 100644 docs/api/schemas/pay-schedule-assignment-employee.Schema.json
create mode 100644 docs/api/schemas/pay-schedule-assignment-employee.schema.mdx
create mode 100644 docs/api/schemas/pay-schedule-assignment-pay-period.Schema.json
create mode 100644 docs/api/schemas/pay-schedule-assignment-pay-period.schema.mdx
create mode 100644 docs/api/schemas/pay-schedule-assignment-preview.Schema.json
create mode 100644 docs/api/schemas/pay-schedule-assignment-preview.schema.mdx
create mode 100644 docs/api/schemas/pay-schedule-assignment-transition-pay-period.Schema.json
create mode 100644 docs/api/schemas/pay-schedule-assignment-transition-pay-period.schema.mdx
create mode 100644 docs/api/schemas/pay-schedule-assignment.Schema.json
create mode 100644 docs/api/schemas/pay-schedule-assignment.schema.mdx
create mode 100644 docs/api/schemas/pay-schedule.Schema.json
create mode 100644 docs/api/schemas/pay-schedule.schema.mdx
create mode 100644 docs/api/schemas/payment-configs.Schema.json
create mode 100644 docs/api/schemas/payment-configs.schema.mdx
create mode 100644 docs/api/schemas/payroll-minimal.Schema.json
create mode 100644 docs/api/schemas/payroll-minimal.schema.mdx
create mode 100644 docs/api/schemas/signatory-create-request.Schema.json
create mode 100644 docs/api/schemas/signatory-create-request.schema.mdx
create mode 100644 docs/api/schemas/signatory-invite-request.Schema.json
create mode 100644 docs/api/schemas/signatory-invite-request.schema.mdx
create mode 100644 docs/api/schemas/signatory-update-request.Schema.json
create mode 100644 docs/api/schemas/signatory-update-request.schema.mdx
create mode 100644 docs/api/schemas/signatory.Schema.json
create mode 100644 docs/api/schemas/signatory.schema.mdx
create mode 100644 docs/api/schemas/tax-liabilities-selections.Schema.json
create mode 100644 docs/api/schemas/tax-liabilities-selections.schema.mdx
create mode 100644 docs/api/schemas/unprocessed-termination-pay-period.Schema.json
create mode 100644 docs/api/schemas/unprocessed-termination-pay-period.schema.mdx
create mode 100644 docs/api/schemas/webhook-subscription.Schema.json
create mode 100644 docs/api/schemas/webhook-subscription.schema.mdx
create mode 100644 docs/api/sidebar.ts
create mode 100644 docs/api/signatories.tag.mdx
create mode 100644 docs/api/submit-information-request.ParamsDetails.json
create mode 100644 docs/api/submit-information-request.RequestSchema.json
create mode 100644 docs/api/submit-information-request.StatusCodes.json
create mode 100644 docs/api/submit-information-request.api.mdx
create mode 100644 docs/api/tax-requirements.tag.mdx
create mode 100644 docs/api/time-off-policies.tag.mdx
create mode 100644 docs/api/webhooks.tag.mdx
create mode 100644 docs/api/wire-in-requests.tag.mdx
create mode 100644 docs/workflows-overview/information-requests.md
create mode 100644 e2e/package-lock.json
create mode 100644 website/.gitignore
create mode 100644 website/docusaurus.config.ts
create mode 100644 website/package.json
create mode 100644 website/sidebars.ts
create mode 100644 website/src/css/custom.css
create mode 100644 website/src/pages/index.module.css
create mode 100644 website/src/pages/index.tsx
create mode 100644 website/src/theme/NotFound/Content/index.tsx
create mode 100644 website/src/theme/NotFound/Content/styles.module.css
create mode 100644 website/static/img/favicon.svg
create mode 100644 website/static/img/gusto-logo-dark.svg
create mode 100644 website/static/img/gusto-logo.svg
create mode 100644 website/tsconfig.json
diff --git a/docs/api/ach-transactions.tag.mdx b/docs/api/ach-transactions.tag.mdx
new file mode 100644
index 000000000..3a14066bf
--- /dev/null
+++ b/docs/api/ach-transactions.tag.mdx
@@ -0,0 +1,20 @@
+---
+id: ach-transactions
+title: "ACH Transactions"
+description: "ACH Transactions"
+custom_edit_url: null
+---
+
+
+
+
+
+
+
+```mdx-code-block
+import DocCardList from '@theme/DocCardList';
+import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
+
+
+```
+
\ No newline at end of file
diff --git a/docs/api/bank-accounts.tag.mdx b/docs/api/bank-accounts.tag.mdx
new file mode 100644
index 000000000..37a7cd6e4
--- /dev/null
+++ b/docs/api/bank-accounts.tag.mdx
@@ -0,0 +1,20 @@
+---
+id: bank-accounts
+title: "Bank Accounts"
+description: "Bank Accounts"
+custom_edit_url: null
+---
+
+
+
+
+
+
+
+```mdx-code-block
+import DocCardList from '@theme/DocCardList';
+import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
+
+
+```
+
\ No newline at end of file
diff --git a/docs/api/companies.tag.mdx b/docs/api/companies.tag.mdx
new file mode 100644
index 000000000..fbfa4f5f3
--- /dev/null
+++ b/docs/api/companies.tag.mdx
@@ -0,0 +1,20 @@
+---
+id: companies
+title: "Companies"
+description: "Companies"
+custom_edit_url: null
+---
+
+
+
+
+
+
+
+```mdx-code-block
+import DocCardList from '@theme/DocCardList';
+import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
+
+
+```
+
\ No newline at end of file
diff --git a/docs/api/company-attachment.tag.mdx b/docs/api/company-attachment.tag.mdx
new file mode 100644
index 000000000..aa680c63a
--- /dev/null
+++ b/docs/api/company-attachment.tag.mdx
@@ -0,0 +1,20 @@
+---
+id: company-attachment
+title: "Company Attachment"
+description: "Company Attachment"
+custom_edit_url: null
+---
+
+
+
+
+
+
+
+```mdx-code-block
+import DocCardList from '@theme/DocCardList';
+import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
+
+
+```
+
\ No newline at end of file
diff --git a/docs/api/company-benefits.tag.mdx b/docs/api/company-benefits.tag.mdx
new file mode 100644
index 000000000..4c7cdc491
--- /dev/null
+++ b/docs/api/company-benefits.tag.mdx
@@ -0,0 +1,20 @@
+---
+id: company-benefits
+title: "Company Benefits"
+description: "Company Benefits"
+custom_edit_url: null
+---
+
+
+
+
+
+
+
+```mdx-code-block
+import DocCardList from '@theme/DocCardList';
+import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
+
+
+```
+
\ No newline at end of file
diff --git a/docs/api/company-forms.tag.mdx b/docs/api/company-forms.tag.mdx
new file mode 100644
index 000000000..d38f14b56
--- /dev/null
+++ b/docs/api/company-forms.tag.mdx
@@ -0,0 +1,20 @@
+---
+id: company-forms
+title: "Company Forms"
+description: "Company Forms"
+custom_edit_url: null
+---
+
+
+
+
+
+
+
+```mdx-code-block
+import DocCardList from '@theme/DocCardList';
+import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
+
+
+```
+
\ No newline at end of file
diff --git a/docs/api/contractor-documents.tag.mdx b/docs/api/contractor-documents.tag.mdx
new file mode 100644
index 000000000..a89172d51
--- /dev/null
+++ b/docs/api/contractor-documents.tag.mdx
@@ -0,0 +1,20 @@
+---
+id: contractor-documents
+title: "Contractor Documents"
+description: "Contractor Documents"
+custom_edit_url: null
+---
+
+
+
+
+
+
+
+```mdx-code-block
+import DocCardList from '@theme/DocCardList';
+import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
+
+
+```
+
\ No newline at end of file
diff --git a/docs/api/contractor-forms.tag.mdx b/docs/api/contractor-forms.tag.mdx
new file mode 100644
index 000000000..c6e9509fc
--- /dev/null
+++ b/docs/api/contractor-forms.tag.mdx
@@ -0,0 +1,20 @@
+---
+id: contractor-forms
+title: "Contractor Forms"
+description: "Contractor Forms"
+custom_edit_url: null
+---
+
+
+
+
+
+
+
+```mdx-code-block
+import DocCardList from '@theme/DocCardList';
+import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
+
+
+```
+
\ No newline at end of file
diff --git a/docs/api/contractor-payment-groups.tag.mdx b/docs/api/contractor-payment-groups.tag.mdx
new file mode 100644
index 000000000..4160d9650
--- /dev/null
+++ b/docs/api/contractor-payment-groups.tag.mdx
@@ -0,0 +1,20 @@
+---
+id: contractor-payment-groups
+title: "Contractor Payment Groups"
+description: "Contractor Payment Groups"
+custom_edit_url: null
+---
+
+
+
+
+
+
+
+```mdx-code-block
+import DocCardList from '@theme/DocCardList';
+import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
+
+
+```
+
\ No newline at end of file
diff --git a/docs/api/contractor-payment-method.tag.mdx b/docs/api/contractor-payment-method.tag.mdx
new file mode 100644
index 000000000..4ab01a3bf
--- /dev/null
+++ b/docs/api/contractor-payment-method.tag.mdx
@@ -0,0 +1,20 @@
+---
+id: contractor-payment-method
+title: "Contractor Payment Method"
+description: "Contractor Payment Method"
+custom_edit_url: null
+---
+
+
+
+
+
+
+
+```mdx-code-block
+import DocCardList from '@theme/DocCardList';
+import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
+
+
+```
+
\ No newline at end of file
diff --git a/docs/api/contractor-payments.tag.mdx b/docs/api/contractor-payments.tag.mdx
new file mode 100644
index 000000000..67c8074f9
--- /dev/null
+++ b/docs/api/contractor-payments.tag.mdx
@@ -0,0 +1,20 @@
+---
+id: contractor-payments
+title: "Contractor Payments"
+description: "Contractor Payments"
+custom_edit_url: null
+---
+
+
+
+
+
+
+
+```mdx-code-block
+import DocCardList from '@theme/DocCardList';
+import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
+
+
+```
+
\ No newline at end of file
diff --git a/docs/api/contractors.tag.mdx b/docs/api/contractors.tag.mdx
new file mode 100644
index 000000000..e7183f3b1
--- /dev/null
+++ b/docs/api/contractors.tag.mdx
@@ -0,0 +1,20 @@
+---
+id: contractors
+title: "Contractors"
+description: "Contractors"
+custom_edit_url: null
+---
+
+
+
+
+
+
+
+```mdx-code-block
+import DocCardList from '@theme/DocCardList';
+import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
+
+
+```
+
\ No newline at end of file
diff --git a/docs/api/delete-department.ParamsDetails.json b/docs/api/delete-department.ParamsDetails.json
new file mode 100644
index 000000000..c2fb5baa0
--- /dev/null
+++ b/docs/api/delete-department.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"department_uuid","in":"path","required":true,"schema":{"type":"string"},"description":"The UUID of the department"},{"name":"X-Gusto-API-Version","in":"header","required":false,"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.","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"}}]}
\ No newline at end of file
diff --git a/docs/api/delete-department.RequestSchema.json b/docs/api/delete-department.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/delete-department.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/delete-department.StatusCodes.json b/docs/api/delete-department.StatusCodes.json
new file mode 100644
index 000000000..8c4f80195
--- /dev/null
+++ b/docs/api/delete-department.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"204":{"description":"No Content"},"404":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided UUID is valid.\n"},"422":{"description":"Unprocessable Entity \n \nThis 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.\n","content":{"application/json":{"schema":{"description":"Unprocessable Entity\n \nThis 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.\n","type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["error_key","category"],"properties":{"error_key":{"type":"string","description":"Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error."},"category":{"type":"string","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."},"message":{"type":"string","description":"Provides details about the error - generally this message can be surfaced to an end user."},"metadata":{"type":"object","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.","oneOf":[{"type":"object","description":"multiple entities","required":["entities"],"properties":{"entities":{"type":"array","items":{"type":"object","description":"single entity","additionalProperties":true,"properties":{"entity_type":{"type":"string","description":"Name of the entity that the error corresponds to."},"entity_uuid":{"type":"string","description":"Unique identifier for the entity."},"valid_from":{"type":["string","null"]},"valid_up_to":{"type":["string","null"]},"key":{"type":["string","null"]},"state":{"type":["string","null"]}},"title":"Metadata-With-One-Entity"}}},"title":"Metadata-With-Multiple-Entities"},{"type":"object","description":"single entity","additionalProperties":true,"properties":{"entity_type":{"type":"string","description":"Name of the entity that the error corresponds to."},"entity_uuid":{"type":"string","description":"Unique identifier for the entity."},"valid_from":{"type":["string","null"]},"valid_up_to":{"type":["string","null"]},"key":{"type":["string","null"]},"state":{"type":["string","null"]}},"title":"Metadata-With-One-Entity"}]},"errors":{"type":"array","description":"Will only exist if category is `nested_errors`. It is possible to have multiple levels of nested errors.","items":"circular(Entity-Error-Object)"}},"title":"Entity-Error-Object"}}},"x-examples":{"bank_account_delete_unfunded_payments":{"errors":[{"error_key":"base","category":"invalid_operation","message":"FundingMethod has unfunded payments"}]},"bank_account_verify_incorrect_deposits":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Your bank account cannot be verified. Please check the test deposit amounts."}]},"bank_account_verify_already_verified":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Your bank account has already been verified."}]},"bank_account_missing_routing":{"errors":[{"error_key":"routing_number","category":"invalid_attribute_value","message":"Routing number is required."}]},"payment_configs_missing_parameter":{"errors":[{"error_key":"base","category":"missing_parameter","message":"At least one parameter must be provided"}]},"payment_configs_invalid_fast_payment_limit":{"errors":[{"error_key":"fast_payment_limit","category":"invalid_attribute_value","message":"Fast payment limit should be a number"}]},"pay_periods_invalid_end_date":{"errors":[{"error_key":"end_date","category":"invalid_parameter","message":"End date cannot be more than 3 months in future"}]},"company_industry_selection_naics_code_required":{"errors":[{"error_key":"naics_code","category":"invalid_attribute_value","message":"Naics code is required."}]},"company_industry_selection_naics_code_invalid":{"errors":[{"error_key":"naics_code","category":"invalid_attribute_value","message":"Naics code must be equal to 6 digits."}]},"company_industry_selection_sics_codes_invalid":{"errors":[{"error_key":"sic_codes","category":"invalid_attribute_value","message":"Sic codes must be equal to 4 digits"}]},"time_off_policy_name_required":{"errors":[{"error_key":"name","category":"invalid_attribute_value","message":"Name is required."}]},"time_off_policy_unlimited_invalid_accrual_rate":{"errors":[{"error_key":"accrual_rate","category":"invalid_operation","message":"Accrual rate must be blank for unlimited policies."}]},"time_off_policy_pending_requests":{"errors":[{"error_key":"time_off_policy","category":"invalid_operation","message":"Cannot deactivate policy with pending time off requests."}]},"time_off_policy_employees_required":{"errors":[{"error_key":"employees","category":"invalid_attribute_value","message":"Employees are required."}]},"time_off_policy_unlimited_balance_update":{"errors":[{"error_key":"base","category":"invalid_attribute_value","message":"Can not adjust balances for unlimited policies."}]},"holiday_pay_policy_already_exists":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Company already has a holiday pay policy."}]},"holiday_pay_policy_not_exists":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Company does not have a holiday pay policy, please create one"}]},"holiday_pay_policy_invalid_employees":{"errors":[{"error_key":"employees","category":"invalid_attribute_value","message":"Invalid employee uuids provided."}]},"onboarded_employee":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Cannot delete onboarded employee"}]},"invalid_attribute":{"errors":[{"error_key":"base","category":"invalid_operation","message":"There is an error in the request body."}]},"company_cannot_enable_contractor_only":{"errors":[{"error_key":"contractor_only","category":"invalid_attribute_value","message":"Contractor only cannot be enabled for existing companies."}]},"company_missing_parameter":{"errors":[{"error_key":"base","category":"missing_parameter","message":"contractor_only is required."}]},"starting_after_uuid_invalid":{"errors":[{"error_key":"starting_after_uuid","category":"invalid_attribute_value","message":"Parameter 'starting_after_uuid' does not correspond to a valid event."}]},"resource_uuid_invalid":{"errors":[{"error_key":"resource_uuid","category":"invalid_attribute_value","message":"Parameter 'resource_uuid' does not correspond to a valid resource."}]},"payroll_gross_up_invalid_net_pay":{"errors":[{"error_key":"net_pay","category":"invalid_attribute_value","message":"Net pay must be a number."}]},"payroll_accruing_hours_invalid":{"errors":[{"error_key":"base","category":"invalid_attribute_value","message":"Hours cannot be negative."}]},"payroll_cannot_cancel":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Payroll cannot be canceled."}]},"frozen_payroll":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This payroll has already been processed. Its data cannot be updated or altered."}]},"frozen_payroll_processing":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This payroll is being processed and cannot be updated at this time."}]},"unmodifiable_payroll_type":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This type of payroll cannot be modified or processed. It is reserved for system processes."}]},"invalid_employee_uuids_format":{"errors":[{"error_key":"employee_uuids","category":"invalid_attribute_value","message":"Parameter employee_uuids must be an array."}]},"maximum_employee_uuids_surpassed":{"errors":[{"error_key":"employee_uuids","category":"invalid_attribute_value","message":"Exceeded maximum of 100 for lookup."}]},"invalid_employee_uuid":{"errors":[{"error_key":"employee_uuids","category":"invalid_attribute_value","message":"Invalid Employee UUID(s).","metadata":{"entities":[{"entity_type":"Employee","entity_uuid":"invalid-uuid-123"}]}}]},"payroll_blocker_missing_bank_info":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must have a bank account in order to run payroll.","metadata":{"key":"missing_bank_info"}}]},"payroll_blocker_missing_employee_setup":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must add employees in order to run payroll.","metadata":{"key":"missing_employee_setup"}}]},"payroll_blocker_missing_federal_tax_setup":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must complete federal tax setup in order to run payroll.","metadata":{"key":"missing_federal_tax_setup"}}]},"payroll_blocker_missing_bank_verification":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company bank account must be verified in order to run payroll.","metadata":{"key":"missing_bank_verification"}}]},"payroll_blocker_suspended":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company is suspended and cannot run payroll.","metadata":{"key":"suspended"}}]},"submission_blocker_missing_selection":{"errors":[{"error_key":"submission_blockers","category":"invalid_attribute_value","message":"Submission blockers selections required"}]},"submission_blocker_invalid_option":{"errors":[{"error_key":"submission_blockers","category":"nested_errors","metadata":{"blocker_type":"fast_ach_threshold_exceeded"},"errors":[{"error_key":"selected_option","category":"invalid_attribute_value","message":"Selection is not available to resolve Fast ACH Threshold Exceeded. Please choose one of Wire In, Move To Four Day"}]}]},"invalid_version":{"errors":[{"error_key":"base","category":"invalid_resource_version","message":"You are attempting to update a resource using an out-of-date version."}]},"signatory_email_required":{"errors":[{"error_key":"email","category":"invalid_attribute_value","message":"Email is required"}]},"signatory_company_already_has_signatory":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Cannot have more than one signatory in a company. Please remove the existing signatory before adding a new one."}]},"mixed_disbursement_errors":{"errors":[{"error_key":"disbursements","category":"nested_errors","metadata":{"contractor_payment_uuid":"invalid-uuid-1"},"errors":[{"error_key":"contractor_payment_uuid","category":"not_found","message":"Disbursement not found."}]},{"error_key":"disbursements","category":"nested_errors","metadata":{"contractor_payment_uuid":"d0dfa222-ad08-4ea7-a06a-717688c3b179"},"errors":[{"error_key":"payment_method","category":"invalid_attribute_value","message":"Payment method must be one of: Direct Deposit, Check."},{"error_key":"payment_status","category":"invalid_attribute_value","message":"Payment status is not valid for payment method 'InvalidMethod'."}]}]},"not_found":{"errors":[{"error_key":"request","category":"not_found","message":"The requested resource was not found."}]},"finish_onboarding_incomplete":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Company is not ready to exit onboarding."}]},"company_location_validation":{"errors":[{"error_key":"street_1","category":"invalid_attribute_value","message":"Must include a street address"},{"error_key":"city","category":"invalid_attribute_value","message":"Must include a city"},{"error_key":"state","category":"invalid_attribute_value","message":"State is in the wrong format"},{"error_key":"zip","category":"invalid_attribute_value","message":"Please enter a valid zip code (e.g. 12345)."},{"error_key":"phone_number","category":"invalid_attribute_value","message":"Phone number must be 10 digits"}]},"conflict":{"errors":[{"error_key":"request","category":"duplicate_operation","message":"A resource with these attributes already exists."}]},"invalid_parameter":{"errors":[{"error_key":"request","category":"invalid_parameter","message":"The provided parameter is invalid or missing."}]},"flow_invalid_entity":{"errors":[{"error_key":"entity_type","category":"invalid_attribute_value","message":"Invalid flow entity"},{"error_key":"entity_uuid","category":"invalid_attribute_value","message":"Invalid flow entity"}]},"flow_nested_options_errors":{"errors":[{"error_key":"options","category":"nested_errors","metadata":{"flow_type":"company_forms"},"errors":[{"error_key":"form_types","category":"invalid_attribute_value","message":"Supplied value 'invalid' contains no permitted values"}]}]},"basic":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must complete all onboarding requirements in order to run payroll.","metadata":{"key":"needs_onboarding"}}]},"contractor_payment_invalid_wage":{"errors":[{"error_key":"wage","category":"invalid_attribute_value","message":"Wage must be greater than or equal to 0."}]},"contractor_payment_cannot_cancel":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Payment has already been processed and cannot be cancelled. Contact support directly."}]},"time_off_request_cannot_delete":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This time off request cannot be deleted."}]},"resource":{"errors":[{"error_key":"first_name","category":"invalid_attribute_value","message":"First name is required"},{"error_key":"date_of_birth","category":"invalid_attribute_value","message":"Date of birth is not a valid date"}]},"nested":{"errors":[{"error_key":"contractor_payments","category":"nested_errors","metadata":{"contractor_uuid":"72ae4617-daa9-4ed7-85e0-18ed5d0ee835"},"errors":[{"error_key":"hours","category":"invalid_attribute_value","message":"Ella Fitzgerald is paid fixed wage and hours cannot be set on a contractor payment"}]},{"error_key":"contractor_payments","category":"nested_errors","metadata":{"contractor_uuid":"2d7bf62c-babf-4a12-8292-340e2d9cab28"},"errors":[{"error_key":"wage","category":"invalid_attribute_value","message":"Isaiah Berlin is paid hourly and wage cannot be set on a contractor payment"}]}]},"compensation_invalid_rate":{"errors":[{"error_key":"rate","category":"invalid_attribute_value","message":"Rate is not a valid number"}]},"compensation_invalid_payment_unit":{"errors":[{"error_key":"payment_unit","category":"invalid_attribute_value","message":"Payment unit must be one of Hour, Week, Month, or Year"}]},"compensation_already_processed":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Compensation has already been processed on payroll."}]}},"title":"Unprocessable-Entity-Error-Object"},"examples":{"Basic":{"value":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must complete all onboarding requirements in order to run payroll.","metadata":{"key":"needs_onboarding"}}]}},"Resource":{"value":{"errors":[{"error_key":"first_name","category":"invalid_attribute_value","message":"First name is required"},{"error_key":"date_of_birth","category":"invalid_attribute_value","message":"Date of birth is not a valid date"}]}},"Nested":{"value":{"errors":[{"error_key":"contractor_payments","category":"nested_errors","metadata":{"contractor_uuid":"72ae4617-daa9-4ed7-85e0-18ed5d0ee835"},"errors":[{"error_key":"hours","category":"invalid_attribute_value","message":"Ella Fitzgerald is paid fixed wage and hours cannot be set on a contractor payment"}]},{"error_key":"contractor_payments","category":"nested_errors","metadata":{"contractor_uuid":"2d7bf62c-babf-4a12-8292-340e2d9cab28"},"errors":[{"error_key":"wage","category":"invalid_attribute_value","message":"Isaiah Berlin is paid hourly and wage cannot be set on a contractor payment"}]}]}}}}}}}}
\ No newline at end of file
diff --git a/docs/api/delete-department.api.mdx b/docs/api/delete-department.api.mdx
new file mode 100644
index 000000000..dc71f98e5
--- /dev/null
+++ b/docs/api/delete-department.api.mdx
@@ -0,0 +1,72 @@
+---
+id: delete-department
+title: "Delete a department"
+description: "Delete a department. You cannot delete a department until all employees and contractors have been removed."
+sidebar_label: "Delete a department"
+hide_title: true
+hide_table_of_contents: true
+api: eJztXOtvHDeS/1d4fR9sA9Ojh5/Rp/Na8q2AdWLE9noD2WhxmjUzjLrJDskeaSLofz9UkezXPKSRJeB2kQCBoWmy+GOxWC8WeZ1cpbPaOp1K5WBmuJNapW5ZQXJ0lkA5ASFAJKOEV1W3iU2+jxJdgf/rVCRHiYACHKQCKm5cCcolo8TxmUVCx82P1FGAzY2ssGtylBxTR8ZZ23XMftM1y7lS2jGx+p3VysmC8aJgUFaFXgJYxpVguVbO8NxpY9mcL4BNABQzUOoFiPE39U3ZXFdwxM5bYvbo0kgH599UMkoqbngJDgzivk4UL4HmFhtndS2RHxKRV9zNk1Fi4I9aGhDJkTM1jBKbz6HkydF14hmZWGekmiU3w5l/ngP78uX0mOkpc3PoTDC5GTWD/yv9X1qhtx9P03+Csdg3AJgDF2B6EKa8sLDKYgemlAqsH4c7SCfcgmBvP56yhSfKuLU6l9yBYJfSzdlS14Ya5Lwoxux0ypRWwKRlldELKUCMfBteVYXMSRSeWHZWSiXLuuzS/v507lxlj/b2hM7tmERunOtyL4pYWvGl0UVB3/d4JdPQU6rZfweCaefnZwijtiDGyWaGjxJQdYkCeLh/+DLdf5UevPTyN+V14ZKj7u83N9+Rj7bSyoJFYof7L/CfPit/1uydVs6vUfJifRPH3utaCfZNMfZN4TLjAoFF1hqwujY5MKHBMhRwuJLWjdkHfgHM1gZojSKLvYBIyxa8kCjCNOzh4eqwX1RldA7W8kkB7EQ56ZYNAmlZyZdszqsKFLucg6JRJlosUfpoGQNG2kRcKsvAGNxIts7njFt2LhWByLhzRk5qB9mCFzWcj5g2RC5SmHJZWCZqYE4zrtqejco4H7NP4Gd6duKHeccdzLSRYHeUFoKZ5k33Z2xWSwFsqg0rtcF95RDQmHZ4Hlbv6DrpyO3e7xaZeN2Rpdu5+xdzh8wN+09Pfofc9fTSWeInjPuvMgjVSb/Nwu/t7uXG8CWqOAdl9/fNVLMLwA4B5XLDGNRqjZLoL/SnCnI5lWBxIcNmpO5M53lt7Jh9XlYSVeKSOVz6C1gyKUA53wvbN2u419gTZqAg1ep0S3KMm7lBvQM0pIBtUbw8JYZaJpKK2iNIGZsZXVdSzYKR5IpNgLQnopnUshAsRzkoQ/s5V6KQasak8tLbMf1kCJqBpGXnihRb5tfxfETg/FqxS1kUUeQZZ74lOw9NWVikpbc34FWW/0isKXG/zeB2znyM8w3SyPhE166zdimbgQLTrlogHZlhazPluWcIVwyUQP6YgMJxwR1fJ4p9GO/i5jZQwIIrh6aWI80gIMuwk4MJkIrRnkbrS2ojaKRJAWP2XhsGV7ysChj1SBA+YtW5/zdDVOe0tvEXdFPOPfsnrTFBY6kV/DIl52b7XMq6cLIqwI+F+2iw8eLPq5stftlhS/fHtlLN4sjYjQsh8RMvPnZG8t7WmrE9Q26Xmp95CdH3Chx1c94Vm1wb7xIIy5wmaegw+PYRvij5Rw2tejCkN9vxiKLX3lOjy5bgWUtR1UWRfG/a1VXm9PaGPT23roF13MG2JjejxElX4Mw+BOlPv0o3T39RkHrjl9xsbvUhyI5vikuD/uxfa/7vv+ZIaaPB7vPhKyofrYqld3CZ3Go2xuzUUWihrZXoYjntI7hGDxWwgMLi2gUzEg1Fo1aSXJq8Lrh56uGm5Pykv5DAPUu6M1zTwAv0VRp0Lk1wwtVFxvNc18plPhDNajWtlQCRVXzpQ9qOE3PW8zUSDLK6jslRsuKsJR0zl7yvlZBq9gHcXAs255bF0VgzGq1BD9gCjJwuM6lIdHNEWmkrHxTZb+gG4KgsjBrD8wkwGl+CGLOPBXALLJ9DfuGdFPRYAxzGS+yIpn3TFHhhgItlFik+6gSQvWFAnydo5rEGYCktaqjM6NrhttkMLLTIVF1OKDhfA3Hg5PeA/ur7M98f90Q0uwFXkIQs12oqZ7aB1viaO3FttXcXzFvHcEkdw8i/dWbL2rquY7EeWJztlFsXd0tWyFK6LQjXNN6Zhe8RcaDBiAazc10XAjHzwNkGc1aBkVq0eEGJTARtuQFl02QttvW8PFGCUi+dnUMRlJtzxZ6zUis3t+gTTmtXG/D4cl1WXOHmFrV1ZplZKCBH6c4Ul7nNci0gax2zjYjb1rvz82fsy7DvGnG8G8IwzOMDjKIJf9S8QCvyigk5k43a2QLXRgD2DnCtzH3b3dF+kjlhtatgXwSwHquTJWR6Os0qXch8mWFG8G5rXd6LieW69R2CqBXtKBDNfuF5bmpeZGb7nuk120Fzv/X9GPZrODYpUJWjZ9XgYQRQgt0AvAIyrllIpGyzjoOuu6B9F7PWPHdygZA9DR/jBgwMB2B6Oo1ZnU2Ym/T2XZa9abz72p+0aXQDd5eACS+4yiGrq1v05WZrvQ3VO64oQ8rF77TsfjS7fdnnupACtTr+7wFHt4Ic0Yf0it55ZdK4EeRSsIAALVBY/M3QlHaPB6tJMZMnvQ7YiFXBZTOAsqoVbITamMdGzB5FFE99m+Zkh2HYZTs5DMKn1URzg254bPeQ/OudPDVDNZA8hJXJPCCCz5R7lJaSPRSWStXLAmNyeWDRvFuRgcL8UdYehWUYhG3BNmy5+zZtCPh4r/VvPBZBG5akHHWfx9tu2Ij/Mf3YwRzXmDnruCG/nU8dGIr17+IFrPbanX8fG7/6yRp6T9pt3KYmKE/JwkZZ4JGpn0VMLd4Vf6/9DyHvUboVc2zdhjR45JDNjLYW0x1xcAUUDGzzdUKL3d0doBih8ShiXDCARF4Lrshc1+YujuH9TN3fkXpn5yiYcScXQwaFPZ6jHSweUN989PQ7APwQzfaYGv0nqCzgeFBNh1mfMPxKSB4O3TC3cOqsT6e3GL3bIfCEjBcOzAa0WaCyPW7/IeDSsgmgcmsAx6OWAVRKNUpLDmAAW6tSCzmVpLYj5JjNfEiw8cSoWllsD8BzssdyrygtmEXQ4nZpHZRNo6jDh74BaQGbTbUp+bZov9/+RxRQn1K7qxWj9GTAWfIrLCUY4rS1qTjO+RGhnlzlAOhFBAy4Egf7+8TVQuuLutrGy0cEFh2uGANQycFT+2yc9M++2nOds0HSvQkfkkGuPI6f4p/pweFznGFPoU0KnV+AaYw/Jd2kmuqdhH9Aba0zTBIRHOFeHlAqpo0Ag/bJ1Cpuj+H0/dirOLfPp1kcC66uHmdSXIhOHdS9pjOAuX1OUxB4lJo5fvWY00K/kBzwMB5z/IrRePeb4yrsO4iizwn7IpEHn2ZPDKPGilnoH5DLHuj1k7S1xVzEjin2u0xKYlFLIN41grdOoYXkIdt6QrPSamVpmpzdNtd8pft9UnUNERaJsGbwNoZINgFurfKPou0dlw34F0cL2phS6DyfZ25uwM51ITIIxifpnN8NEdC0oMG6O68iX1AEKG2z4LLg4TAPPf5iAYxy82/f/Z19juBYtIyd8yOtLSUj0Eh+lQbYqRqxD3oB7LPG4jrDjjkdR3YNZqgNvJfb1IQvi6bEsnd2RHkx7hyUFQWxTgeXjvG2nqNG4USXQ9cu1dOUvgeCMcyUM8WdNpja47K4W1qPy+I+KT0ui26gOwQQ4+6YHZtzmzVfHz6b4k9zmwMPXNxmNEblQQFQIwa+btcfncfkQdtlAlMkhnUCyHSm4BKJRkdPXoHIhLST2ligw6T23HrDxLqtd9h9ndxCPLda6/1s2XubSPQxaJdNsa60x93jDmjaddTEc+GRpyf2xZQfHh6mXOy/SV8Af53y/Vc8fX3w+tWbN/nzycHrn7ZMOlIr6bT7Pr6/P+Dz/Rv76bXGETuWeBbOjv3h84i9w0PpcTLkSkSB9RH1vSIQj8L3j6rPe9To2ld9lE+Ct+2P+J+Mow5rF3dbsoZyf3eRig01x5fcDmUkmUol7TwLWU60rlhI4F2vR8hJBwb5GN9p3NmOtYMPcoKF9l5MRqRv88KsMwAuO9h9FT+g8EiVF7VAje4JoW4xYO2KzOS+ROnHxiAiQ8q+Smd304vdkLUhS3xptJqxEH0Px/hTVvcQc6+SQWGsHbN4f8rKH7o+hfFszA4On794+WzNFptrBfeuh/iIvWM1RNzkB/u9g1KsOChkvi3TsHbziNpXgMOmo8fO1sHjOzcH2ynvbZNV/ghnEMDfJZG9Ftb2OoLP3esBbU0Grb5fF6zN9p5y3OOFvuyUN1At17bihja2v3c2AYeM1XxDgejmCB5mgGaSwZJ5H9bebvNDw7ubQxolONpRS+FGs1ssHX6nPveKQLAmGASjT+xJ6POkvUmgNKvweo9zsZWNVmXCrcwfOTrnVOYX9Xf0NsnJ2C2EVQDCduxQCAPX+B+Rb5ehOHzD7Ojzzgz/imXhUc/M6FjUBJfVtIUa+42hWkH3iDl68iQ2J8kHOWePAHP4dGeJ547Zuqq0cUyQc1Qshyf8QR3FOfgT0AfPQw+KHzqQ/YBicJq1rVxMGuuy+xW8vMe+TA3KXla0lSD7MM0m0tB9vx1HOaZz9Smj7k1oHCwolU14B5B0zt2OaZta0Ps48cF5f33I4cWrg9ep4Pyn9AWI1+mbl7CfHrwB8VLsA7x5/nKLSqPTsHsEpUXB2Xvp/pxhKk5QxS9HZY7hGsMNSzI8H5yGWUAfkULE5qg5MGFNoPPAnDoUryfTV4d5OuGTafqCHxymbw5/Okyfv9iHQ/FTzieHb7Zw6n5a6NRyyefsb2AKqRo2IV+KJbHoMtxeuRuHok8Nynp/usl7bK/b2VyrtbWENXijXUnvFl2uRdIEl2prfWiv2b2jNew9iBgZHsGO2FeAC0w1KTenq3e/AV+HOiZNGt37wKFSHGibttcdg3rTK+Dv3VZM1xa7j5JuofvfoqPgWfbv7DHcjJJfO3bjtgn9hxiQm1Hyc2NBbpvzX6bkL1PyA6bE/4d3ZWwF/AK4Xaa4CVK9AGOkgOY5CDwPvnKgLMVYOB0/kY2vToyi7N7y+gSuUyS1CURDK4LBG/4h2dgBSK84HCV7i4O9zqMQe9eDRx9u8KEBrIMI61KbAmU33KXmlfRXqVMBJd2nXrkPdQylTvpM8/RSn0zFzzitDYTX0vxoKHG6iWaFn3HWFvLaUNB/dh2V8tscDcTbGmd/9r3b6hPegfd2YU3b5toXQoyvL+DfE+CG9P/wUiyRSOn+FuO1m2PQHg8nR8knqij5kRE8hQ0DUD7GlxNE60jvaeDzFCgi8cyo+xbEKMH3Muwv009gFjKHznq09+XpivEeNdwTODQa85T+xrMfG7quXIuDItclHYkRjieWnQRJZ7EKC1/OEDqvUfhoGv8VHi7gPsUVXgY5jqOyX/Fyechj+OMiFKjw9X9a+UFuVNq6kqsenZUXVoawr9t3E/5/PdgSJMXBldurCi5JpGgLXYedfZYsDmg67Rs0o+Ro+KTLdyx5tg6bX1+jk/PFFDc3+PMfNaCqPfuO+sRQlRZtIyHJu9rw5kqXYU9/DZ7BM7blyZcNc4l3LNWyo9CScOFz5WUaX7vtn4XZDeR/+Bsxa3nrebj+gZ2G1a2pQR1Vuc63lQdEehbm+OQfJ59Pkpub/wOwnIMc
+sidebar_class_name: "delete api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Delete a department. You cannot delete a department until all employees and contractors have been removed.
+
+scope: `departments:write`
+
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/delete-v-1-companies-company-id-bank-accounts-bank-account-id.ParamsDetails.json b/docs/api/delete-v-1-companies-company-id-bank-accounts-bank-account-id.ParamsDetails.json
new file mode 100644
index 000000000..216cfd537
--- /dev/null
+++ b/docs/api/delete-v-1-companies-company-id-bank-accounts-bank-account-id.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"X-Gusto-API-Version","in":"header","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"},"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."},{"name":"company_id","in":"path","description":"The UUID of the company","required":true,"schema":{"type":"string"}},{"name":"bank_account_id","in":"path","description":"The UUID of the company bank account","required":true,"schema":{"type":"string"}}]}
\ No newline at end of file
diff --git a/docs/api/delete-v-1-companies-company-id-bank-accounts-bank-account-id.RequestSchema.json b/docs/api/delete-v-1-companies-company-id-bank-accounts-bank-account-id.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/delete-v-1-companies-company-id-bank-accounts-bank-account-id.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/delete-v-1-companies-company-id-bank-accounts-bank-account-id.StatusCodes.json b/docs/api/delete-v-1-companies-company-id-bank-accounts-bank-account-id.StatusCodes.json
new file mode 100644
index 000000000..dc8762475
--- /dev/null
+++ b/docs/api/delete-v-1-companies-company-id-bank-accounts-bank-account-id.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"204":{"description":"successful"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided ID/UUID is valid.","type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["error_key","category"],"properties":{"error_key":{"type":"string","description":"Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error."},"category":{"type":"string","description":"Specifies the type of error. The category provides error groupings and can be used to build custom error handling in your integration."},"message":{"type":"string","description":"Provides details about the error - generally this message can be surfaced to an end user."}}}}},"x-examples":{"not_found":{"errors":[{"error_key":"request","category":"not_found","message":"The requested resource was not found."}]}},"title":"Not-Found-Error-Object"}}}},"422":{"description":"Cannot delete bank account with unfunded payments","content":{"application/json":{"schema":{"description":"Unprocessable Entity\n \nThis 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.\n","type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["error_key","category"],"properties":{"error_key":{"type":"string","description":"Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error."},"category":{"type":"string","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."},"message":{"type":"string","description":"Provides details about the error - generally this message can be surfaced to an end user."},"metadata":{"type":"object","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.","oneOf":[{"type":"object","description":"multiple entities","required":["entities"],"properties":{"entities":{"type":"array","items":{"type":"object","description":"single entity","additionalProperties":true,"properties":{"entity_type":{"type":"string","description":"Name of the entity that the error corresponds to."},"entity_uuid":{"type":"string","description":"Unique identifier for the entity."},"valid_from":{"type":["string","null"]},"valid_up_to":{"type":["string","null"]},"key":{"type":["string","null"]},"state":{"type":["string","null"]}},"title":"Metadata-With-One-Entity"}}},"title":"Metadata-With-Multiple-Entities"},{"type":"object","description":"single entity","additionalProperties":true,"properties":{"entity_type":{"type":"string","description":"Name of the entity that the error corresponds to."},"entity_uuid":{"type":"string","description":"Unique identifier for the entity."},"valid_from":{"type":["string","null"]},"valid_up_to":{"type":["string","null"]},"key":{"type":["string","null"]},"state":{"type":["string","null"]}},"title":"Metadata-With-One-Entity"}]},"errors":{"type":"array","description":"Will only exist if category is `nested_errors`. It is possible to have multiple levels of nested errors.","items":"circular(Entity-Error-Object)"}},"title":"Entity-Error-Object"}}},"x-examples":{"bank_account_delete_unfunded_payments":{"errors":[{"error_key":"base","category":"invalid_operation","message":"FundingMethod has unfunded payments"}]},"bank_account_verify_incorrect_deposits":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Your bank account cannot be verified. Please check the test deposit amounts."}]},"bank_account_verify_already_verified":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Your bank account has already been verified."}]},"bank_account_missing_routing":{"errors":[{"error_key":"routing_number","category":"invalid_attribute_value","message":"Routing number is required."}]},"payment_configs_missing_parameter":{"errors":[{"error_key":"base","category":"missing_parameter","message":"At least one parameter must be provided"}]},"payment_configs_invalid_fast_payment_limit":{"errors":[{"error_key":"fast_payment_limit","category":"invalid_attribute_value","message":"Fast payment limit should be a number"}]},"pay_periods_invalid_end_date":{"errors":[{"error_key":"end_date","category":"invalid_parameter","message":"End date cannot be more than 3 months in future"}]},"company_industry_selection_naics_code_required":{"errors":[{"error_key":"naics_code","category":"invalid_attribute_value","message":"Naics code is required."}]},"company_industry_selection_naics_code_invalid":{"errors":[{"error_key":"naics_code","category":"invalid_attribute_value","message":"Naics code must be equal to 6 digits."}]},"company_industry_selection_sics_codes_invalid":{"errors":[{"error_key":"sic_codes","category":"invalid_attribute_value","message":"Sic codes must be equal to 4 digits"}]},"time_off_policy_name_required":{"errors":[{"error_key":"name","category":"invalid_attribute_value","message":"Name is required."}]},"time_off_policy_unlimited_invalid_accrual_rate":{"errors":[{"error_key":"accrual_rate","category":"invalid_operation","message":"Accrual rate must be blank for unlimited policies."}]},"time_off_policy_pending_requests":{"errors":[{"error_key":"time_off_policy","category":"invalid_operation","message":"Cannot deactivate policy with pending time off requests."}]},"time_off_policy_employees_required":{"errors":[{"error_key":"employees","category":"invalid_attribute_value","message":"Employees are required."}]},"time_off_policy_unlimited_balance_update":{"errors":[{"error_key":"base","category":"invalid_attribute_value","message":"Can not adjust balances for unlimited policies."}]},"holiday_pay_policy_already_exists":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Company already has a holiday pay policy."}]},"holiday_pay_policy_not_exists":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Company does not have a holiday pay policy, please create one"}]},"holiday_pay_policy_invalid_employees":{"errors":[{"error_key":"employees","category":"invalid_attribute_value","message":"Invalid employee uuids provided."}]},"onboarded_employee":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Cannot delete onboarded employee"}]},"invalid_attribute":{"errors":[{"error_key":"base","category":"invalid_operation","message":"There is an error in the request body."}]},"company_cannot_enable_contractor_only":{"errors":[{"error_key":"contractor_only","category":"invalid_attribute_value","message":"Contractor only cannot be enabled for existing companies."}]},"company_missing_parameter":{"errors":[{"error_key":"base","category":"missing_parameter","message":"contractor_only is required."}]},"starting_after_uuid_invalid":{"errors":[{"error_key":"starting_after_uuid","category":"invalid_attribute_value","message":"Parameter 'starting_after_uuid' does not correspond to a valid event."}]},"resource_uuid_invalid":{"errors":[{"error_key":"resource_uuid","category":"invalid_attribute_value","message":"Parameter 'resource_uuid' does not correspond to a valid resource."}]},"payroll_gross_up_invalid_net_pay":{"errors":[{"error_key":"net_pay","category":"invalid_attribute_value","message":"Net pay must be a number."}]},"payroll_accruing_hours_invalid":{"errors":[{"error_key":"base","category":"invalid_attribute_value","message":"Hours cannot be negative."}]},"payroll_cannot_cancel":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Payroll cannot be canceled."}]},"frozen_payroll":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This payroll has already been processed. Its data cannot be updated or altered."}]},"frozen_payroll_processing":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This payroll is being processed and cannot be updated at this time."}]},"unmodifiable_payroll_type":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This type of payroll cannot be modified or processed. It is reserved for system processes."}]},"invalid_employee_uuids_format":{"errors":[{"error_key":"employee_uuids","category":"invalid_attribute_value","message":"Parameter employee_uuids must be an array."}]},"maximum_employee_uuids_surpassed":{"errors":[{"error_key":"employee_uuids","category":"invalid_attribute_value","message":"Exceeded maximum of 100 for lookup."}]},"invalid_employee_uuid":{"errors":[{"error_key":"employee_uuids","category":"invalid_attribute_value","message":"Invalid Employee UUID(s).","metadata":{"entities":[{"entity_type":"Employee","entity_uuid":"invalid-uuid-123"}]}}]},"payroll_blocker_missing_bank_info":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must have a bank account in order to run payroll.","metadata":{"key":"missing_bank_info"}}]},"payroll_blocker_missing_employee_setup":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must add employees in order to run payroll.","metadata":{"key":"missing_employee_setup"}}]},"payroll_blocker_missing_federal_tax_setup":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must complete federal tax setup in order to run payroll.","metadata":{"key":"missing_federal_tax_setup"}}]},"payroll_blocker_missing_bank_verification":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company bank account must be verified in order to run payroll.","metadata":{"key":"missing_bank_verification"}}]},"payroll_blocker_suspended":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company is suspended and cannot run payroll.","metadata":{"key":"suspended"}}]},"submission_blocker_missing_selection":{"errors":[{"error_key":"submission_blockers","category":"invalid_attribute_value","message":"Submission blockers selections required"}]},"submission_blocker_invalid_option":{"errors":[{"error_key":"submission_blockers","category":"nested_errors","metadata":{"blocker_type":"fast_ach_threshold_exceeded"},"errors":[{"error_key":"selected_option","category":"invalid_attribute_value","message":"Selection is not available to resolve Fast ACH Threshold Exceeded. Please choose one of Wire In, Move To Four Day"}]}]},"invalid_version":{"errors":[{"error_key":"base","category":"invalid_resource_version","message":"You are attempting to update a resource using an out-of-date version."}]},"signatory_email_required":{"errors":[{"error_key":"email","category":"invalid_attribute_value","message":"Email is required"}]},"signatory_company_already_has_signatory":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Cannot have more than one signatory in a company. Please remove the existing signatory before adding a new one."}]},"mixed_disbursement_errors":{"errors":[{"error_key":"disbursements","category":"nested_errors","metadata":{"contractor_payment_uuid":"invalid-uuid-1"},"errors":[{"error_key":"contractor_payment_uuid","category":"not_found","message":"Disbursement not found."}]},{"error_key":"disbursements","category":"nested_errors","metadata":{"contractor_payment_uuid":"d0dfa222-ad08-4ea7-a06a-717688c3b179"},"errors":[{"error_key":"payment_method","category":"invalid_attribute_value","message":"Payment method must be one of: Direct Deposit, Check."},{"error_key":"payment_status","category":"invalid_attribute_value","message":"Payment status is not valid for payment method 'InvalidMethod'."}]}]},"not_found":{"errors":[{"error_key":"request","category":"not_found","message":"The requested resource was not found."}]},"finish_onboarding_incomplete":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Company is not ready to exit onboarding."}]},"company_location_validation":{"errors":[{"error_key":"street_1","category":"invalid_attribute_value","message":"Must include a street address"},{"error_key":"city","category":"invalid_attribute_value","message":"Must include a city"},{"error_key":"state","category":"invalid_attribute_value","message":"State is in the wrong format"},{"error_key":"zip","category":"invalid_attribute_value","message":"Please enter a valid zip code (e.g. 12345)."},{"error_key":"phone_number","category":"invalid_attribute_value","message":"Phone number must be 10 digits"}]},"conflict":{"errors":[{"error_key":"request","category":"duplicate_operation","message":"A resource with these attributes already exists."}]},"invalid_parameter":{"errors":[{"error_key":"request","category":"invalid_parameter","message":"The provided parameter is invalid or missing."}]},"flow_invalid_entity":{"errors":[{"error_key":"entity_type","category":"invalid_attribute_value","message":"Invalid flow entity"},{"error_key":"entity_uuid","category":"invalid_attribute_value","message":"Invalid flow entity"}]},"flow_nested_options_errors":{"errors":[{"error_key":"options","category":"nested_errors","metadata":{"flow_type":"company_forms"},"errors":[{"error_key":"form_types","category":"invalid_attribute_value","message":"Supplied value 'invalid' contains no permitted values"}]}]},"basic":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must complete all onboarding requirements in order to run payroll.","metadata":{"key":"needs_onboarding"}}]},"contractor_payment_invalid_wage":{"errors":[{"error_key":"wage","category":"invalid_attribute_value","message":"Wage must be greater than or equal to 0."}]},"contractor_payment_cannot_cancel":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Payment has already been processed and cannot be cancelled. Contact support directly."}]},"time_off_request_cannot_delete":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This time off request cannot be deleted."}]},"resource":{"errors":[{"error_key":"first_name","category":"invalid_attribute_value","message":"First name is required"},{"error_key":"date_of_birth","category":"invalid_attribute_value","message":"Date of birth is not a valid date"}]},"nested":{"errors":[{"error_key":"contractor_payments","category":"nested_errors","metadata":{"contractor_uuid":"72ae4617-daa9-4ed7-85e0-18ed5d0ee835"},"errors":[{"error_key":"hours","category":"invalid_attribute_value","message":"Ella Fitzgerald is paid fixed wage and hours cannot be set on a contractor payment"}]},{"error_key":"contractor_payments","category":"nested_errors","metadata":{"contractor_uuid":"2d7bf62c-babf-4a12-8292-340e2d9cab28"},"errors":[{"error_key":"wage","category":"invalid_attribute_value","message":"Isaiah Berlin is paid hourly and wage cannot be set on a contractor payment"}]}]},"compensation_invalid_rate":{"errors":[{"error_key":"rate","category":"invalid_attribute_value","message":"Rate is not a valid number"}]},"compensation_invalid_payment_unit":{"errors":[{"error_key":"payment_unit","category":"invalid_attribute_value","message":"Payment unit must be one of Hour, Week, Month, or Year"}]},"compensation_already_processed":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Compensation has already been processed on payroll."}]}},"title":"Unprocessable-Entity-Error-Object"}}}}}}
\ No newline at end of file
diff --git a/docs/api/delete-v-1-companies-company-id-bank-accounts-bank-account-id.api.mdx b/docs/api/delete-v-1-companies-company-id-bank-accounts-bank-account-id.api.mdx
new file mode 100644
index 000000000..cb299269d
--- /dev/null
+++ b/docs/api/delete-v-1-companies-company-id-bank-accounts-bank-account-id.api.mdx
@@ -0,0 +1,73 @@
+---
+id: delete-v-1-companies-company-id-bank-accounts-bank-account-id
+title: "Delete a company bank account"
+description: "This endpoint disables a company bank account."
+sidebar_label: "Delete a company bank account"
+hide_title: true
+hide_table_of_contents: true
+api: eJztXOtvHDmO/1e0tR+SAF3tR5zH+NNmY+fWwGUmmCSbXThBWV1id2tcJdVIqrZ7DP/vB1JSvfoRt2Njb+92gMGMuyTqJ4qkSIrSTaIrMNxJrc5EcpwIKMBBujhIc11WXEmw4f+WmRTphKvLlOe5rpWz9FcW/sqkSEaJAJsbWSG55Dj5NJeWgRKVlsoxIS2fFGAZZ4EiQwIsEBh/VV/Vm95PLOdKaccmEDsLJqdMOiYtqy0INtWGIaFaVUbnYPG3ii9LUM4SQZvrCo7ZRZxDF7I9vjLSwUUyShyf2eT4PPkrjv4mfE6+jZLrdFZbp1OpHMw8n1K3rAAbQzkBIUBgu4obXoIDg2RuEsVLSI6Tf6T/Rb3ffDhL/w7GIltGiUTezIELMMkosfkcSp4c3ySebmKdkWqWjBJQdYnjHO4fvkj3X6YHL3AkAVNeFy457v5+O2T9CWIppQLL3ByY4A7SCUf2vPlwxhYeC+PW6lxyB4JdSTdnS10bapDzohizsylTWgFyuzJ6IQWIkW/Dq6qQObHjiWXnpVSyrMsu7W9P585V9nhvT+jcjomL41yXe5FracWXRhcFfd/jlUxDT6lmfw4E087Pz+Kij5PbUcPhVjYjYyvu5mskEdjnz2cnTE+JH6FbMkoM/F5LAyI5dqaGzctx2xl0Ve53Hrkn5zvB+DZKLOS1kW5JovbWE3yTo/i/qd08OT7/dtsRXWOv+CzSNWArrSxYJH24f4T/6QO2NVGa1gVK1dG6Jj9rx97pWuHMc60cKIeNOkKx95vFljedeWwgwb4qxr4qZBPyACwKowGra5MDExosQxMA19K6MXvPL4HZ2gDxMgolOzvZIx5Lyxa8kGKMKu35pie/Qd7n8HkCxmhD+l0ZtH9OeoaE31uuc2M4Sol0UHZ/30w1uwTskHMHM22WG8agVmtUvs+kjxXkcirBsqs5hDlTd6bzvDZ2zD4tK4m6umQObe0lLJkUoJzvhe25c0ZOagd7jYliBgrSeadbkqhVLeodoCEFbIsC7ikxXMxIKi6SDchnRteVVDPLuBJo4NG6ky13mk1qWQiWo9iWof2cK1FINWNSedPTscSEuQRr+Qy+D/lDBCLAcVlYxie6dh2mpmwGCkzLzkA6orS1mfLcI+UKNzYEjpzDf1Dh4JqXVeHXWWmXTUlJOoJ13lv/JEh8V16OOx07k0s2KMgV9/pBHcbJ7TcE4qQrwCtZSkqWnuKg6S9eaj3ao8PDVbV86zdc7wX092LaIGo1rZXobLL3twCf45aN+zo7VU66ZbQFyHu+ZHNeVaBQ+BUt00SLJYoZyUFgBsPhuVRBviyzdT5n3LILqcgWZI0GZAte1HAxYtoQuUhhStIgaggL2/RsXKOLMfsIXv/OT/0wb/2CSbA77nQEM82b7s/YrJYCyJUptYEonuOv6j9W7P+FFUM/qxlIWnahSMkzv44XIwLn14pdyaKIIs848y3ZRWjKwiItvbYCKVVQjP81xhJROC644+tEcWCPonIbKGDBMYrgjiPNICDLoMnBHErFSKfRuSWzESzSpIAxe6cNCxZ61CNB+IhVF/6/GaK6oLWNv9S1FBee/ZPW80BHQyv4ZUqmfftcyrpwsirAj4V6NFC8+POqssUvO6j0wKmTahZHxm5cCImfePGhM5J3EdeM7Rnyfan5mZcQHd3AUTfnXbHJtfEuqLDMaZKGDoO/P8JnJX+voTUPhuxmOx5R9NZ7anTZEjxvKaq6KJJvTbu6ypze3rBn59Y1sI472Naksyu/D9KffpFunv6iIPWbX3K7udX7IDu+KS4NhiP/WfN//zVHShs37D4fvqDx0apY+mgIUyFbto0xO6M8SaWtlehiOc3mfAGssUMFLKCwuHZhG4kbRWNWklyavC64eerh9vzIZ0l3hmsaJGu84l7o7N3MLDqVWeNUbvaYMYfRd5dXnLWe2/yuVkKq2Xtwcy3YnNs1LiytQQ/YAoycLjOpSHRzRFppKx8U2T/RDdiQ7aLxJYgx+1AAt8DyOeSX3klBjzXAYbykRNV48xR4YYCLZRYpPuoEkL1hQDYBUO081gAspUULlRldO1SbLVGSb5GpupxQymwNxIGT3wP6q+/PfH/UibjtBlxBErJcq6mc2QZa42vuxLXV3l0wbxzDJXUME2utM1vW1nUdi/XA4myn3LqoLVkhS+m2IFzTeGcWvkPEgQYjGszOdV0IxMwDZxvMWQVGatHiBSUyEazlBpRNk7XY1vPyVAnKbHY0hyIoN+eKPWelVm5u0Sec1q424PE1GUMlauvMMrNQQI7SnSkuc5vlWkDWOmYbEbetd+fnz9iXYd814ng3hGGYxwcYRRN+r3mBu8hLJuRMNmZnC1wbAdg7wLUy9213R/tR5oTVroI9CmA9VidLyPR0mlW6kPkyw4Tu3da6vBcTy3XrOwRRK9IoEI2+8Dw3NS8ys11nes12sNxvfD+G/RqOTQo05ehZNXgYAZRgNwCvgDbXLCRStu2Og667oG1yUjx3coGQPQ0f4wYMDAdgejqNWZ1NmKGsCr0EsHdZ9qbx7mt/GrsybuDuEjDhBVc5ZHX1HXu5ebfehuotV5Qu5OI3WnY/mt2+7HNdSIFWHf/1gKNbQY7oQ3pF4TSjcSPIpWABAe5AYfE3Q8P06aPBas4jyJNeB2zEquCyGUBZ1Qo2Qm22x0bMHkUUz3wbFkkwDLtsJ4dB+LSaaG7QDY/tHpJ/vbxyM1QDyUNYmcwDIvhEuUdpKdlDYalUvSwwJpcHO5p3KzJQmD9CJ8wZnjttMgzCtmAbttxdTRsCPt5r/RuPxR98k5Sj7WuO6gf4H9OPHcxxzTZnHTfkt/OpA0Ox/l28gNVeu/PvQ+NXP1lD70mrxm1qgvKULCjKApQLs4ipxbvi77X/IeQ9St/FHFu3IQ0eOWQzo63FdEccXAEFA9t8ndBid3cHKEZoPIoYFwwgkdeCKzLXtbmLY3i/re5vSL2jOQpm3MnFkEFBx3PcB4sHtDcfPP0OAD9Eox5To/8AlQUcD2rpMOsThl8JyZs6GcwPWZ9ObzF6t0PgCRkvHJgNaLNAZXvc/kPApWUTQOPWFvaEo5YBVEo1SksOYABbq1ILOZVktiPkmM18SLDxxKhaWWwPwHOyx3JvKC2YRbDidmkdlE2jaMOHvgFZAZtNtSn5tmi/3/5HDFCfUqvVilF6MuAs+TVW6gxx2tpUHOf8iFBPr3MA9CICBlyJg/194mqh9WVdbePlIwKLDleMAagA6Kl9Nk76Z1/tuc75IOnehA/JIFcex0/xz/Tg8Dkd+XcN2qTQ+SWYZvOnpJtUU72T8A+orXWGSSKCI9zLA0rFtBFgcH8ytYrqMZy+H3sV5/b5NItjwdXV40yKi9Y1tfebzgDm9jlNQeBRaub49WNOC/1CcsDDeMzxa0bj3W+Oq7DvIIo+J+yLRB58mj0xjBYrZqF/QC57oNdP0tYWcxE7ptjvMimJRS2BeHcT/O4UWkgesq0nNCutVpamydltc81Xut8nVdcQYZEIawZvY4hkE+B2V/5RtL3jsgH/4mjBGlMKnefzzM0N2LkuRAZh80k653dDBDQtaLDuzqvIFxQBStssuCx4OMxDj79YAKPc/Ju3f2OfIjgWd8bO+ZHWlpIRuEl+kQbYmRqx93oB7JPGSkzDTjgdR3Y3zFB6ey+3qQlfFk3hc+/siPJi3DkoKwpinQ4uHeNtPUeNwokuh65dqqcpfQ8EY5gpZ4o7bTC1x2Vxt7Qel8V9UnpcFt1Adwggxt0xOzbnNmu+Pnw2xZ/mNgceuLjNaIzKgwKgRgwMlLjidHQekwdtlwlMkRjWCSDTmYIrJBodPXkNIhPSTmpjgQ6T2nPrDRPrtt5B+zq5hXhutdb72aJ7m0jcodLypAN6UFs5euTpiX0x5YeHhykX+6/TI+CvUr7/kqevDl69fP06fz45ePXTlklHaiWddt/H9/cHfL5/s396q3HMTiSehbMTf/g8Ym/xUNpX469DgfUR9b0iEI/C94+mz3vU6NpXfZRPgrftj/ifjKMN+1fV346SqVTSzrOQ5cTdFQsJvOv1CDnpwCAf4zuNmu1YO/ggJ1ho78VkRPp7Xph1BsBlB7uv4nsUHqnyohZo0T0htC0GrF2RmdyXKP3YGERkSNlX6ey+9WI3ZG3IEl8ZrWYsRN/DMf6Q1T3E3JtkUBhrxyzeH7Lyh65PYTwbs4PD50cvnq1RsblWcO96iA/YO1ZDRCU/2O8dlGLFQSHzbZmGtcojal8BDpuOHjuqg8d3bg62U97bJqv8Ec4ggL9LInstrO11BJ+6d0namgxafb8uWJvtPeWo44W+6pQ3UC3XtuKGNra/dzYBh4zVfEOB6OYIHmaAZpJhJ/M+rP3+nh8a3n07pFGCox2tFCqa3bLT4Xfqc68IBGuCQTD6xJ6EPk/amwRKswpvzzkXW9m4q0y4lfkjR+ecyvyi/Y7eJjkZu4WwCkDYzj4UwsA1/kfk21UoDt8wO/q8M8O/YFl4tDMzOhY1wWU1baHGfrNRraB7xBw9eRKbk+SDnLNHgDl8RpXpuWO2ript8HYrOkfFcnjCH8xRnIM/AX3wPPSg+KF7cZYGFIPTrG3lYtJYl92v4OUd9mVqUPayYq0E7Q/TbCIN3ZjccZQTOlefMurehMZhB6WyCe8Aks252zFt9zrTzk58cN5fHXI4ennwKhWc/5QegXiVvn4B++nBaxAvxD7A6+cvtpg0Og27R1BaFJy9k+6PGabiBFX8cjTmGK4xVFiS4fngNMwC+ogUIjZHzYEJawKdB+bUoXg1mb48zNMJn0zTI35wmL4+/OkwfX60D4fip5xPDl9v4dT9rNCZ5ZLP2V/BFFI1bEK+FEti0VW4vXI3DkWfGpT1/nST99het7O5VmtrCWvwRruS3i26XIukCS7V1vrQXrN7R2vYexAxMjyCHbEvAJeYalJuTlfv/gl8HeqYNGls7wOHSnGgbdZedzbU/lXK3m3FdEOxO3aAawfKkgeEqD3eja8I0H2EevCaAGpfv5+/wt00xjsbeMM7xPnx1YZk5K+gHyd7i4O9pihk76a9JH+713sAYe9mcJX9Fh8kwLPJwPTaFGiawv1GXkl/vTEVUNIdx5U7CidQ6gSL/m0F/BK4XaaeXuoTHPgZ57eB8FqaHwwlMzbRrPBz91r8R7xx6oup1lyOby5Z4ODx/QW61Q/ckH82vIJGJFK6LcF47eboIsejgFHykc5vf2QET2HDABT9+MO7KIv0pgS+tYASETO03dcgRgk+/mB/mX4Es5A5dDjd3k6lC3171HBP4NCoOin9jZlWG7quXEKBItclJaAJxxPLToPksljzgM9ACJ3XaBhoGn8K14S5DyjDMwoncVT2K17lDFGDT86iqISvf2klA7lRaetKrnp0vNu86W2F3gRu2vvK/07vk3iBcnDt9qqCS5I80qGboPPnyYKyNFHrk1Fy3Hsco0cZvw5fsfiGNYrWIambG7Swn01xe4s//14DGtnzb2iBDJVVkHWIk06Op7ywsIXTT38NvuAztvkpjrWTjDeiqEWwf0kSrmd1n/9Aq/KQgIZSdA90Qw77OlD/8Mtu/Ps//ZzLBt56Hq5/QqdhdbtXogWuXOfbymMEvS3z5PS/Tz+d4rXIvs1ubHT4n8693v4q39z4Fp/0Jajb22bRHf5N3sPt/wCdtHoE
+sidebar_class_name: "delete api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+This endpoint disables a company bank account.
+
+A bank account cannot be disabled if it is used for any unprocessed payments.
+
+scope: `company_bank_accounts:write`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/delete-v-1-companies-company-id-contractor-payment-contractor-payment.ParamsDetails.json b/docs/api/delete-v-1-companies-company-id-contractor-payment-contractor-payment.ParamsDetails.json
new file mode 100644
index 000000000..fd9f3ec07
--- /dev/null
+++ b/docs/api/delete-v-1-companies-company-id-contractor-payment-contractor-payment.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"X-Gusto-API-Version","in":"header","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"},"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."},{"name":"company_id","in":"path","required":true,"description":"The UUID of the company","schema":{"type":"string"}},{"name":"contractor_payment_id","in":"path","required":true,"description":"The UUID of the contractor payment","schema":{"type":"string"}}]}
\ No newline at end of file
diff --git a/docs/api/delete-v-1-companies-company-id-contractor-payment-contractor-payment.RequestSchema.json b/docs/api/delete-v-1-companies-company-id-contractor-payment-contractor-payment.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/delete-v-1-companies-company-id-contractor-payment-contractor-payment.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/delete-v-1-companies-company-id-contractor-payment-contractor-payment.StatusCodes.json b/docs/api/delete-v-1-companies-company-id-contractor-payment-contractor-payment.StatusCodes.json
new file mode 100644
index 000000000..3972233d7
--- /dev/null
+++ b/docs/api/delete-v-1-companies-company-id-contractor-payment-contractor-payment.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"204":{"description":"No Content"},"404":{"description":"Not Found\n\nThe requested resource does not exist. Make sure the provided ID/UUID is valid.\n","content":{"application/json":{"schema":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided ID/UUID is valid.","type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["error_key","category"],"properties":{"error_key":{"type":"string","description":"Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error."},"category":{"type":"string","description":"Specifies the type of error. The category provides error groupings and can be used to build custom error handling in your integration."},"message":{"type":"string","description":"Provides details about the error - generally this message can be surfaced to an end user."}}}}},"x-examples":{"not_found":{"errors":[{"error_key":"request","category":"not_found","message":"The requested resource was not found."}]}},"title":"Not-Found-Error-Object"}}}},"422":{"description":"Unprocessable Entity\n\nThis 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.\n","content":{"application/json":{"schema":{"description":"Unprocessable Entity\n \nThis 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.\n","type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["error_key","category"],"properties":{"error_key":{"type":"string","description":"Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error."},"category":{"type":"string","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."},"message":{"type":"string","description":"Provides details about the error - generally this message can be surfaced to an end user."},"metadata":{"type":"object","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.","oneOf":[{"type":"object","description":"multiple entities","required":["entities"],"properties":{"entities":{"type":"array","items":{"type":"object","description":"single entity","additionalProperties":true,"properties":{"entity_type":{"type":"string","description":"Name of the entity that the error corresponds to."},"entity_uuid":{"type":"string","description":"Unique identifier for the entity."},"valid_from":{"type":["string","null"]},"valid_up_to":{"type":["string","null"]},"key":{"type":["string","null"]},"state":{"type":["string","null"]}},"title":"Metadata-With-One-Entity"}}},"title":"Metadata-With-Multiple-Entities"},{"type":"object","description":"single entity","additionalProperties":true,"properties":{"entity_type":{"type":"string","description":"Name of the entity that the error corresponds to."},"entity_uuid":{"type":"string","description":"Unique identifier for the entity."},"valid_from":{"type":["string","null"]},"valid_up_to":{"type":["string","null"]},"key":{"type":["string","null"]},"state":{"type":["string","null"]}},"title":"Metadata-With-One-Entity"}]},"errors":{"type":"array","description":"Will only exist if category is `nested_errors`. It is possible to have multiple levels of nested errors.","items":"circular(Entity-Error-Object)"}},"title":"Entity-Error-Object"}}},"x-examples":{"bank_account_delete_unfunded_payments":{"errors":[{"error_key":"base","category":"invalid_operation","message":"FundingMethod has unfunded payments"}]},"bank_account_verify_incorrect_deposits":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Your bank account cannot be verified. Please check the test deposit amounts."}]},"bank_account_verify_already_verified":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Your bank account has already been verified."}]},"bank_account_missing_routing":{"errors":[{"error_key":"routing_number","category":"invalid_attribute_value","message":"Routing number is required."}]},"payment_configs_missing_parameter":{"errors":[{"error_key":"base","category":"missing_parameter","message":"At least one parameter must be provided"}]},"payment_configs_invalid_fast_payment_limit":{"errors":[{"error_key":"fast_payment_limit","category":"invalid_attribute_value","message":"Fast payment limit should be a number"}]},"pay_periods_invalid_end_date":{"errors":[{"error_key":"end_date","category":"invalid_parameter","message":"End date cannot be more than 3 months in future"}]},"company_industry_selection_naics_code_required":{"errors":[{"error_key":"naics_code","category":"invalid_attribute_value","message":"Naics code is required."}]},"company_industry_selection_naics_code_invalid":{"errors":[{"error_key":"naics_code","category":"invalid_attribute_value","message":"Naics code must be equal to 6 digits."}]},"company_industry_selection_sics_codes_invalid":{"errors":[{"error_key":"sic_codes","category":"invalid_attribute_value","message":"Sic codes must be equal to 4 digits"}]},"time_off_policy_name_required":{"errors":[{"error_key":"name","category":"invalid_attribute_value","message":"Name is required."}]},"time_off_policy_unlimited_invalid_accrual_rate":{"errors":[{"error_key":"accrual_rate","category":"invalid_operation","message":"Accrual rate must be blank for unlimited policies."}]},"time_off_policy_pending_requests":{"errors":[{"error_key":"time_off_policy","category":"invalid_operation","message":"Cannot deactivate policy with pending time off requests."}]},"time_off_policy_employees_required":{"errors":[{"error_key":"employees","category":"invalid_attribute_value","message":"Employees are required."}]},"time_off_policy_unlimited_balance_update":{"errors":[{"error_key":"base","category":"invalid_attribute_value","message":"Can not adjust balances for unlimited policies."}]},"holiday_pay_policy_already_exists":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Company already has a holiday pay policy."}]},"holiday_pay_policy_not_exists":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Company does not have a holiday pay policy, please create one"}]},"holiday_pay_policy_invalid_employees":{"errors":[{"error_key":"employees","category":"invalid_attribute_value","message":"Invalid employee uuids provided."}]},"onboarded_employee":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Cannot delete onboarded employee"}]},"invalid_attribute":{"errors":[{"error_key":"base","category":"invalid_operation","message":"There is an error in the request body."}]},"company_cannot_enable_contractor_only":{"errors":[{"error_key":"contractor_only","category":"invalid_attribute_value","message":"Contractor only cannot be enabled for existing companies."}]},"company_missing_parameter":{"errors":[{"error_key":"base","category":"missing_parameter","message":"contractor_only is required."}]},"starting_after_uuid_invalid":{"errors":[{"error_key":"starting_after_uuid","category":"invalid_attribute_value","message":"Parameter 'starting_after_uuid' does not correspond to a valid event."}]},"resource_uuid_invalid":{"errors":[{"error_key":"resource_uuid","category":"invalid_attribute_value","message":"Parameter 'resource_uuid' does not correspond to a valid resource."}]},"payroll_gross_up_invalid_net_pay":{"errors":[{"error_key":"net_pay","category":"invalid_attribute_value","message":"Net pay must be a number."}]},"payroll_accruing_hours_invalid":{"errors":[{"error_key":"base","category":"invalid_attribute_value","message":"Hours cannot be negative."}]},"payroll_cannot_cancel":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Payroll cannot be canceled."}]},"frozen_payroll":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This payroll has already been processed. Its data cannot be updated or altered."}]},"frozen_payroll_processing":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This payroll is being processed and cannot be updated at this time."}]},"unmodifiable_payroll_type":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This type of payroll cannot be modified or processed. It is reserved for system processes."}]},"invalid_employee_uuids_format":{"errors":[{"error_key":"employee_uuids","category":"invalid_attribute_value","message":"Parameter employee_uuids must be an array."}]},"maximum_employee_uuids_surpassed":{"errors":[{"error_key":"employee_uuids","category":"invalid_attribute_value","message":"Exceeded maximum of 100 for lookup."}]},"invalid_employee_uuid":{"errors":[{"error_key":"employee_uuids","category":"invalid_attribute_value","message":"Invalid Employee UUID(s).","metadata":{"entities":[{"entity_type":"Employee","entity_uuid":"invalid-uuid-123"}]}}]},"payroll_blocker_missing_bank_info":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must have a bank account in order to run payroll.","metadata":{"key":"missing_bank_info"}}]},"payroll_blocker_missing_employee_setup":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must add employees in order to run payroll.","metadata":{"key":"missing_employee_setup"}}]},"payroll_blocker_missing_federal_tax_setup":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must complete federal tax setup in order to run payroll.","metadata":{"key":"missing_federal_tax_setup"}}]},"payroll_blocker_missing_bank_verification":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company bank account must be verified in order to run payroll.","metadata":{"key":"missing_bank_verification"}}]},"payroll_blocker_suspended":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company is suspended and cannot run payroll.","metadata":{"key":"suspended"}}]},"submission_blocker_missing_selection":{"errors":[{"error_key":"submission_blockers","category":"invalid_attribute_value","message":"Submission blockers selections required"}]},"submission_blocker_invalid_option":{"errors":[{"error_key":"submission_blockers","category":"nested_errors","metadata":{"blocker_type":"fast_ach_threshold_exceeded"},"errors":[{"error_key":"selected_option","category":"invalid_attribute_value","message":"Selection is not available to resolve Fast ACH Threshold Exceeded. Please choose one of Wire In, Move To Four Day"}]}]},"invalid_version":{"errors":[{"error_key":"base","category":"invalid_resource_version","message":"You are attempting to update a resource using an out-of-date version."}]},"signatory_email_required":{"errors":[{"error_key":"email","category":"invalid_attribute_value","message":"Email is required"}]},"signatory_company_already_has_signatory":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Cannot have more than one signatory in a company. Please remove the existing signatory before adding a new one."}]},"mixed_disbursement_errors":{"errors":[{"error_key":"disbursements","category":"nested_errors","metadata":{"contractor_payment_uuid":"invalid-uuid-1"},"errors":[{"error_key":"contractor_payment_uuid","category":"not_found","message":"Disbursement not found."}]},{"error_key":"disbursements","category":"nested_errors","metadata":{"contractor_payment_uuid":"d0dfa222-ad08-4ea7-a06a-717688c3b179"},"errors":[{"error_key":"payment_method","category":"invalid_attribute_value","message":"Payment method must be one of: Direct Deposit, Check."},{"error_key":"payment_status","category":"invalid_attribute_value","message":"Payment status is not valid for payment method 'InvalidMethod'."}]}]},"not_found":{"errors":[{"error_key":"request","category":"not_found","message":"The requested resource was not found."}]},"finish_onboarding_incomplete":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Company is not ready to exit onboarding."}]},"company_location_validation":{"errors":[{"error_key":"street_1","category":"invalid_attribute_value","message":"Must include a street address"},{"error_key":"city","category":"invalid_attribute_value","message":"Must include a city"},{"error_key":"state","category":"invalid_attribute_value","message":"State is in the wrong format"},{"error_key":"zip","category":"invalid_attribute_value","message":"Please enter a valid zip code (e.g. 12345)."},{"error_key":"phone_number","category":"invalid_attribute_value","message":"Phone number must be 10 digits"}]},"conflict":{"errors":[{"error_key":"request","category":"duplicate_operation","message":"A resource with these attributes already exists."}]},"invalid_parameter":{"errors":[{"error_key":"request","category":"invalid_parameter","message":"The provided parameter is invalid or missing."}]},"flow_invalid_entity":{"errors":[{"error_key":"entity_type","category":"invalid_attribute_value","message":"Invalid flow entity"},{"error_key":"entity_uuid","category":"invalid_attribute_value","message":"Invalid flow entity"}]},"flow_nested_options_errors":{"errors":[{"error_key":"options","category":"nested_errors","metadata":{"flow_type":"company_forms"},"errors":[{"error_key":"form_types","category":"invalid_attribute_value","message":"Supplied value 'invalid' contains no permitted values"}]}]},"basic":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must complete all onboarding requirements in order to run payroll.","metadata":{"key":"needs_onboarding"}}]},"contractor_payment_invalid_wage":{"errors":[{"error_key":"wage","category":"invalid_attribute_value","message":"Wage must be greater than or equal to 0."}]},"contractor_payment_cannot_cancel":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Payment has already been processed and cannot be cancelled. Contact support directly."}]},"time_off_request_cannot_delete":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This time off request cannot be deleted."}]},"resource":{"errors":[{"error_key":"first_name","category":"invalid_attribute_value","message":"First name is required"},{"error_key":"date_of_birth","category":"invalid_attribute_value","message":"Date of birth is not a valid date"}]},"nested":{"errors":[{"error_key":"contractor_payments","category":"nested_errors","metadata":{"contractor_uuid":"72ae4617-daa9-4ed7-85e0-18ed5d0ee835"},"errors":[{"error_key":"hours","category":"invalid_attribute_value","message":"Ella Fitzgerald is paid fixed wage and hours cannot be set on a contractor payment"}]},{"error_key":"contractor_payments","category":"nested_errors","metadata":{"contractor_uuid":"2d7bf62c-babf-4a12-8292-340e2d9cab28"},"errors":[{"error_key":"wage","category":"invalid_attribute_value","message":"Isaiah Berlin is paid hourly and wage cannot be set on a contractor payment"}]}]},"compensation_invalid_rate":{"errors":[{"error_key":"rate","category":"invalid_attribute_value","message":"Rate is not a valid number"}]},"compensation_invalid_payment_unit":{"errors":[{"error_key":"payment_unit","category":"invalid_attribute_value","message":"Payment unit must be one of Hour, Week, Month, or Year"}]},"compensation_already_processed":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Compensation has already been processed on payroll."}]}},"title":"Unprocessable-Entity-Error-Object"}}}}}}
\ No newline at end of file
diff --git a/docs/api/delete-v-1-companies-company-id-contractor-payment-contractor-payment.api.mdx b/docs/api/delete-v-1-companies-company-id-contractor-payment-contractor-payment.api.mdx
new file mode 100644
index 000000000..53b8ee64f
--- /dev/null
+++ b/docs/api/delete-v-1-companies-company-id-contractor-payment-contractor-payment.api.mdx
@@ -0,0 +1,71 @@
+---
+id: delete-v-1-companies-company-id-contractor-payment-contractor-payment
+title: "Cancel a contractor payment"
+description: "Cancels and deletes a contractor payment. If the contractor payment has already started processing ('may_cancel': true), the payment cannot be cancelled."
+sidebar_label: "Cancel a contractor payment"
+hide_title: true
+hide_table_of_contents: true
+api: eJztXGtv2ziX/itc7Ye2gJVb08vk03abdN8A25lg2m73RVootHhscyKRKkk58QT574tzSEqyLLtxLtjdwQwwmIlNHj48PHce+iaxkNdGukVydH6TvNdlxdXiXZ6Dte9qN0uOzr/ffh8l1+m0tk6nUjmYGu6kVqlbVJAcnSdQjkEIEMn3UeL41OJn77VyhudOG3bGFyUoZ5MOGWOv+DQ5cqaGUWLAVlpZsMnRTXKwd4j/EWBzIytcJzlKftUMCYJyye0oORwe4tgHXSvxTX1Tn2fADPyowToQzIDVtcmBCQ2WKe0YXEvrdthHfgnM1gaYmwGrjJ5LAYKdHu9++XJ6zKRlc15IsfNNJaMkDwCObhJeVYXMiQm7f1hc/iax+QxKvgEX+6YYe3RoySjxx5Do8R+QuwTZ+aOWBgQdjTHaEOcroyswTnouh8+PbuJsbgxfJKNEOii7n6+nml0CTsi5g6k2izVr0KiWnHVGqmky6jHpUwW5nEiw7GoGYc80nek8r43dYZ8Xlcx5USyYm0nLLmHBpADl/Cwcz50zclw72K244SU4MMxAwZHNTrckd1CEGtRbQEMKOJbpSaDE8DAjqXhINiCfGl1XUk0t40qwnCs2BlZbj2Zcy0KwHHWhDONnXIlCqimTii10bVhH1QhzCdbyKfwc8lkEIsBxWVjGx7p2HaambAoKTMvOQDqitLWZ8Nwj5YqBEggcOYf/oBbDNS+rwp+z0i6boIR3Bet86fyTIPFdeTnqTOxsLlmjIFfc6wdN2EluvyMQJ10BXslSUrL0BBdNf/NS69EeHhysquUXVRmNRo6PC2Anykm38JYD2cEXbMarChTKoyLOjbVY4MnT0QR8DG0ClyocuWW2zmeMW3YhFaln1ghlNudFDRcjpg2RixQmdECihsDrZiZqEp39xQ77BF4lzk/8Mu89DyXY789nzlX2aHdX6NzukHHdyXW5G21yWvGF0UVB3+8SzDRvpr9g01oKYBNtWKkNRIl5kMUbZq23fX8zNzL3b6v917fa7HTSLiQtu1Bk1DJ/jhcjAufPil3JoogizzjzI9lFGMrCIS3YlXQzBqRUQTH+zzgHROG44I4PieIyjPdRuQ0UMOfKMZyHNIOALIImB/MvFSOdljqYjWCRxgXssA/asOCRRkskCB+x6sL/N0NUF3S28ZO6luLCs3/cRloYWGkFv03IlW3eS1kXTlYF+LVQj3qKFz9eVbb4zRYqvby2lWoaV8ZpXAiJX/HirLOSj7MH1vYM+bnU/MpL0iASE89RN+Ndscm18XG8sMxpkoYOg3++whclf9TQmgdDdrNdjyh66z0xumwJnrcUVV0UyfdmXF1lTm8euGTnhgZYxx1sGtKJQj4G6U+/SjdLf1OQeueX3K4f9THIjh+KR3M7+vvM/wpnjpTWOuxlPnxF46NVsfDZH5Mb3cYOO3X4caWtlRhiOc1mfA6ssUMFzKGweHbBjURH0ZiVJJcmrwtunnu4S3Hzi6S7w4EByUAWMObqMuN5rmvlMgEFOMhqNamVAJFVsQSwPkMYcwvL6cFKsLaUJnyolZBq+hHcTAs245bF1VizGp3BErA5GDlZZFKR6OaItNJWPiqyf2IYgKuysCp6TkxdxsBofQlih50VwC2wfAb5pQ9SMGINcBgvcaLdWb8FXhjgYpFFik+6AWRvWJCNAVS7jwGApbRooTKja4dqsyEr9CMyVZdjMMMQe0H+EtDf/Xzm56NORLcbcAVJyHKtJnJqG2hNrLkV11Znd8G8cwyP1DGtgLXBbFlb1w0shoHF3U64dVFbskKW0m1AODB4axZ+QMSBBiMazM50XQjEzANnG8xZBUZq0eIFJTIRrOUalM2QQWzDvDxRAuNB6GgOZVBuxhV7yUqt3MxiTDipXW3A48t97TKTStTWmUVmoYAcpTtTXOY2y7WArA3M1iJuR2/Pz19xLsO5A+J4N4RhmacHGEUTftS8QC/ymgk5lY3Z2QDXRgD2DnCtzP3Y7dF+kjlhtatgDwNYj9XJEjI9mWSVLmS+yBQv73jW5b2YWA6dbx9ErUijQDT6wvPc1LzIzGadWRq2heV+5+cxnNdwbFygKcfIqsHDCKAEuwZ4BeRcs1BI2eQde1O3QfveK7cAnjs5R8iehs9xAwaGCzA9mcSqzjrMUFaFXgDYuxx7M3j7sz+JUxk3cHcJGPOCqxyyuvqJvVzvrTehes8VlUe5+IOO3a9mNx/7TBdSoFXHfz3gGFZQIPqYUVG4WWrCCAopWECAHigc/npoWC5+MljN/QtF0kPARqwKIZsBlFWtYC3Uxj02YvYkonjqx7BIgmHaZTs1DMKn1Vhzg2F4HPeY/Is6jAE/a5ZqIHkIK5t5RASfqfYoLRV7KC2VaqkKjMXlnkfzYUUGCutHGISFu8oMk7AN2Pojt1fT9lqU8r02vvFYBCksSTnaPo+3VdiI/ynj2N4eB9ycddxQ3M4nDgzl+neJAlZnbc+/syaufjZA71mrxm1pguqULCjKHJQLu4ilxbviXxr/IORLlH6KOY5uUxq8csimRluL5Y64uAJKBjbFOmHE9uEOUI7QRBQxL+hBoqgFT2Sma3OXwPB+ru4fSL2jOQqm3Ml5n0FBx3P0g8Uj2pszT78DwC/RqMfE6D9BZQHHo1o6rPqE5VdS8nDphrWFU2d9Ob3F6MMOgTdkvHBg1qDNApXNefuDgEvLxoDGrQEcr1p6UKnUKC0FgAFsrUot5ESS2Y6QYzXzMcHGG6Nq5bA9AM/JJZZ7Q2nBzIMVtwvroGwGRRvejw3ICthsok3JN2X7y+MfYoCWKbVarRiVJwPOkl/Lsi77OG1tKo57fkKoJ9c5AEYRAQOexP7eHnG10Pqyrjbx8gmBxYAr5gAMm3Ge2xc7yfLdV3uvc94rujfpQ9Krlcf1U/wz3T94SS0OXYM2LnR+CaZx/lR0k2qitxL+HrXBYJgkIgTCS3VAqZg2Agz6J1OrqB797fu1V3Fu3k9zOBZcXT3NprhoQ1N7v+30YG7e0wQEXqVmjl8/5bYwLqQAPKzHHL9mtN799rgK+w6i6GvCvknk0be5JIbRYsUq9APkcgn08CZtbbEWsWWJ/S6bktjUEoh3neBPt9BC8pBtPaZdabVyNE3NblNovjL9PqW6hgiLRFizeJtDJOsAt175oWiXrst6/IurBWtMJXSezzI3M2BnuhAZBOeTdO7v+ghoW9Bg3Z5XkS8oAlS2mXNZ8HCZhxF/MQdGtfl37//BPkdwLHrGzv2R1paKEegkv0oD7FSN2Ec9B/ZZY+epYcecriO7DnMOxm6rpnFuk75EIr27I6qLceegrCiJdTqEdIy3/Rw1CieGHLp2qZ6k9H0gGNNMOVXcaYOlPS6Lu5X1uCzuU9Ljsugmun0AMe+O1bEZt1nz7eNXU/xtbnPhgYfbrMaoPSgAasTAQIknTlfnsXjQThnDBIlhnwAynSm4QqIx0JPXIDIh7bg2Fugyqb23XrOx7ugttK9TW4j3VoPRzwbdW0fiDp2lxx3QvV7S0RNvT+yJCT84OEi52HubHgJ/k/K91zx9s//m9du3+cvx/ptfNmw6Uivptvs+sb+/4PPzG//prcYRO5Z4F86O/eXziL3HS+mdpM+ViAL7I+p7ZSAehZ8fTZ+PqDG0r5ZRPgvRtr/if7YTbdj/Vr/xKJlIJe0sC1VO9K7YSOBDryeoSQcG+RzfadRsx9rFezXBQvsoJiPSP4vCrDMALtvf/hQ/ovBIlRe1QIvuCaFtMWDtiszkvkXpYWsQkT5l36WzvevFacjaUCW+MlpNWci++2v8Kat7iLk3yaAw145VvD9l5S9dn8POdIftH7w8fPViQMVmWsG9+yHOcHbshohKvr+3dFGKHQeFzDdVGgaVR9S+AxzWXT12VAev79wMbKe9ty1W+SucXgJ/l0L2IKzNfQSfu29n2p4MOn1/Ltib7SPlqOOFvuq0N1Av16bmhja3v3c1AZeM3Xx9gejWCB5ngWaTwZP5GNb+3OeHgXd3h7RKCLSjlUJFsxs8HX5Pc+6VgWBPMAhGX7FnYc6z9iWB0qwCU0rn4igbvcqYW5k/cXbOqc0v2u8YbVKQsV0KqwCE7fihkAYOxB+Rb1ehOXzN7ujrrRn+FdvCo52Z0rWoCSGraRs19hpHtYLuCWv0FEmsL5L3as4eAdbw6aEhzx2zdVVp45ig4KhY9G/4gzmKe/A3oI9eh+41P3Qg+wVF7zZrU7uYNNZl92t4+YBzmeq1vaxYK0H+YZKNpXGz7Vc5pnv1CaPpTWocPCi1TfgAkGzO3a5pm17Q+wTxIXh/c8Dh8PX+m1Rw/kt6COJN+vYV7KX7b0G8EnsAb1++2mDS6DbsHklpUXD2Qbo/p1iKE9Txy9GYY7rGUGFJhme92zALGCNSithcNQcmDCQ6j8ypA/FmPHl9kKdjPp6kh3z/IH178MtB+vJwDw7ELzkfH7zdwKn7WaFTyyWfsX8HU0jVsAn5UiyIRVfh9crdOBRjalDWx9NN3WNz3876Xq2NLawhGu1KerfpchBJk1yqjf2hS8Puna3h7F7GyPAKdsS+AlxiqUm5GT29+yfwIdSxaNLY3kdOleJCm6y97jjU5aejS68V0zXN7jihAXBKCT1Z33S+nzY9GmnTLynSVb3qfJRGaVt5FEVeyD898wvYQTGlh2WYvKx+tcQEapHAyLe51GXPvyUlXwSP+y05YvhM5IV/iRZJDLlFfBtrc13BEbsInLRHplYXCRbMQ2Dtz5M8zFHy3+l/0FP/d2en6X81lUKJ+5wBFxQwtU9I+w9FQNUlPr042Dt4le69Tvdf4espARNeFw4tTfv5bZ+Nx4illCq8/kPHkaJgCfbu7DQWGRm3VueSbpopYaHXezgAHywShxVKu2z7qUZ+TOct7DPLzkup6I6yQ3vLh6O8kmmYKdX0XwPBtPPxC4SBrxB9xhg43MpbZGzFye22lVL/CGiZPZgU0Y8I6ChERGbDcdwuLboaYz50/RUzvAkK/YqErYBfAreLlB5sLuE6ax1ZdyDiT/UcjJECGg1GUbt2oCylNii+3hCt/b0LemhU9373AvmzPM//wEUzGPnQHdTH3wwc2sfwxOX9tATCvpBPoVzY2Ssd0FGyO9/fbezW7k0rSLe7AxEBDhg49Fs8Jmx3CHpfmwJ1O0g+r6QX/FRASdK/Yu6OodS9Q/L0Ul8zxa9x72sID9I8M1QfXUezwq+RNfFXTz6hnPn+zIHfPmmkDxePUol/j4EbsmD9V61EIqUHWIzXboZZd7xdHCWfqCXkISt4CmsWoIKK7weI7o1sMNomlJB46dO1nqMEjaX9bfIJzFzm0OF0a7fojfAuDdwVuDQ6w5T+xssbG6auvGuDItcl3WkRjmeWnQSdYbGNCs2m0HmNQkXb+JfwywPc16iC2TmOq7Lf8XV4KET4+x4UlfDtv7WSgdyotHUlVx063sUOB389+DftDyD8f/XMQbYcXLvdquCShJDU6SaYgvNkTjXgaAySUXK05FeGM4SjYTfwHbuhrUOyNzfocr+Y4vYWP/5RA4Zz59/RUBlq4CKjISQFXiI5mvDC9n1F9wie/x68ygu23oMNbji+vaQR0Uwm4SFo14uisXkkQAPCdS9sQ1z2Xec+htqOh3/pyGgNhz0nh6PRhuGti0XjXLnOdys/fbLkWY9P/vPk8wk+wl425435Dv/T+RWB5bO+ufEjPutLULe3zdE7/Jtyldv/ARrPUeM=
+sidebar_class_name: "delete api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Cancels and deletes a contractor payment. If the contractor payment has already started processing ("may_cancel": true), the payment cannot be cancelled.
+
+scope: `payrolls:run`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/delete-v-1-companies-company-id-earning-types-earning-type-uuid.ParamsDetails.json b/docs/api/delete-v-1-companies-company-id-earning-types-earning-type-uuid.ParamsDetails.json
new file mode 100644
index 000000000..fc73b287d
--- /dev/null
+++ b/docs/api/delete-v-1-companies-company-id-earning-types-earning-type-uuid.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"string"},"description":"The UUID of the company"},{"schema":{"type":"string"},"name":"earning_type_uuid","in":"path","required":true,"description":"The UUID of the earning type"},{"name":"X-Gusto-API-Version","in":"header","required":false,"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.","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"}}]}
\ No newline at end of file
diff --git a/docs/api/delete-v-1-companies-company-id-earning-types-earning-type-uuid.RequestSchema.json b/docs/api/delete-v-1-companies-company-id-earning-types-earning-type-uuid.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/delete-v-1-companies-company-id-earning-types-earning-type-uuid.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/delete-v-1-companies-company-id-earning-types-earning-type-uuid.StatusCodes.json b/docs/api/delete-v-1-companies-company-id-earning-types-earning-type-uuid.StatusCodes.json
new file mode 100644
index 000000000..256ec2e53
--- /dev/null
+++ b/docs/api/delete-v-1-companies-company-id-earning-types-earning-type-uuid.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"204":{"description":"No Content"},"404":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided UUID is valid.\n"}}}
\ No newline at end of file
diff --git a/docs/api/delete-v-1-companies-company-id-earning-types-earning-type-uuid.api.mdx b/docs/api/delete-v-1-companies-company-id-earning-types-earning-type-uuid.api.mdx
new file mode 100644
index 000000000..f0905dfb9
--- /dev/null
+++ b/docs/api/delete-v-1-companies-company-id-earning-types-earning-type-uuid.api.mdx
@@ -0,0 +1,71 @@
+---
+id: delete-v-1-companies-company-id-earning-types-earning-type-uuid
+title: "Deactivate an earning type"
+description: "Deactivate an earning type."
+sidebar_label: "Deactivate an earning type"
+hide_title: true
+hide_table_of_contents: true
+api: eJzdVk1v4zYQ/Svs9LC7gGglwW4POjXYpEWAfgSbpC2QGFlGHNtEJJLhhzaGof++GIqOrcRO0W5PPcWShjNvHt+byQoe+Tz6YLjSAedOBGU0D0uLUF0DtncoJUooQFi7HeJhWkAQc09hp8JppefscmkxfXDordEePVQrODp4T38k+topS4ehgt8M+2h0QB2gL+D97pDAfjJRS3ajGbvRlwtkDh8i+oCSOfQmuhqZNOiZNoHho/Jhwn4V98h8dMjCApl1plMSJbu6OjthyrNONEpObjT0fQHG4tDOmYQKJDYYkHeHvDatFVqhz7+Wt0pyHLq8JXL86Ok2RkUcjfGfoKiD6kRAJjTL8YziJzf6RvvaWKzYZyuWzjSNr744FfAzFGCFEy0GdETuCrRoESrYIIECFBWwIiyAyH6IyqGEKriIBfh6ga0gPodrBB+c0nPieQyQCE20mFniKleAvli9liTj2UXAa7Ber71NTwKQq/zFf07qPD4/43+g83Q611mgkOhGlWai8S9KnRCVrdLoUyUpAvI74VGy4/Mz1g1JmfDe1EqQtL6osGBLE10KqEXTTNjZjGmjkRS0llQxxAhrG1UnFb3x7LpVWrWx3c49fbsIwfqqLKWp/STZbVKbtlzbi2cNpO+lsIrnk0rPv88J+dbrdwQjepQT2H/dBaCOLdnz6ODoAz/4gR9+IG9KnInYBKi23/f9tIBH7i2KexR+yefORLu55cHZ4xC6IW46dE5JfLIP1X0MqH0aEqTfe1xCtX/MFNCJJv79uCFRrFM9x/mUY4x395Ex7s3RjJ+YaDEsjNzuKYm6grI7LJ+GQ7naeLIvR+OhXL2wR093ha5b2zq6hkSclSGsGoTBJbZJHTvmSWueXcGQj6sBamtSx3sS78x57ox8Jaelz0SIxzo6FZYJ+ceh6+O6Ru+PIxFzPd2OuiBJDsN/R+yTUAniWsD0fIfCJUOPMeYUvMEOGyZiWKAO2XE0jy6WPmD7LRWGDHsK9DRuZiZlVaGhNGkkkcNJPXkojexUAI0c//vsAl2naty6j437xZ2JoUyBpaTStI14euZmlu6Bjj4H+yc2tWmRBcMSjjeenWbfsPNhjqThI00dW9QhtfEdFFAbHUQdqJE8XE/WVdknbLLPCsBWqCYJKn/9caMfYsMaH1qhR3n2bbrn6FcJBW39b9iP+XIDPobSNkIlFSTVr7JPr6E7TB1np0IB1Wh/jsxKX19us2kBC+MDJVutaF9cuabv6fVDREdOmNLscErckSiuVyCVp9979tB2628/5ZX1ju1bwnvazC+HiPXkgiKPua0eaRL8J4CeXee/QPWS237aF+v9/c+Y+58v853sDizu/k/oiezR2jo5/eX08hT6/isDQiYV
+sidebar_class_name: "delete api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Deactivate an earning type.
+
+scope: `payrolls:write`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/delete-v-1-companies-company-id-payrolls.ParamsDetails.json b/docs/api/delete-v-1-companies-company-id-payrolls.ParamsDetails.json
new file mode 100644
index 000000000..04c7e634a
--- /dev/null
+++ b/docs/api/delete-v-1-companies-company-id-payrolls.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"company_id","in":"path","description":"The UUID of the company","required":true,"schema":{"type":"string"}},{"name":"payroll_id","in":"path","description":"The UUID of the payroll","required":true,"schema":{"type":"string"}},{"name":"async","in":"query","description":"When true, request an asynchronous delete of the payroll.","schema":{"type":"boolean"}},{"name":"X-Gusto-API-Version","in":"header","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"},"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."}]}
\ No newline at end of file
diff --git a/docs/api/delete-v-1-companies-company-id-payrolls.RequestSchema.json b/docs/api/delete-v-1-companies-company-id-payrolls.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/delete-v-1-companies-company-id-payrolls.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/delete-v-1-companies-company-id-payrolls.StatusCodes.json b/docs/api/delete-v-1-companies-company-id-payrolls.StatusCodes.json
new file mode 100644
index 000000000..f97a7ad1c
--- /dev/null
+++ b/docs/api/delete-v-1-companies-company-id-payrolls.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"202":{"description":"Accepted"},"204":{"description":"no content"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided ID/UUID is valid.","type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["error_key","category"],"properties":{"error_key":{"type":"string","description":"Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error."},"category":{"type":"string","description":"Specifies the type of error. The category provides error groupings and can be used to build custom error handling in your integration."},"message":{"type":"string","description":"Provides details about the error - generally this message can be surfaced to an end user."}}}}},"x-examples":{"not_found":{"errors":[{"error_key":"request","category":"not_found","message":"The requested resource was not found."}]}},"title":"Not-Found-Error-Object"}}}}}}
\ No newline at end of file
diff --git a/docs/api/delete-v-1-companies-company-id-payrolls.api.mdx b/docs/api/delete-v-1-companies-company-id-payrolls.api.mdx
new file mode 100644
index 000000000..33eb82c9a
--- /dev/null
+++ b/docs/api/delete-v-1-companies-company-id-payrolls.api.mdx
@@ -0,0 +1,73 @@
+---
+id: delete-v-1-companies-company-id-payrolls
+title: "Delete a payroll"
+description: "This endpoint allows you to delete an **unprocessed** payroll."
+sidebar_label: "Delete a payroll"
+hide_title: true
+hide_table_of_contents: true
+api: eJztWFtv2zYU/itn3EPbQLKSoN2DgAHLmmwIsLVBk2wDkqChxWOLjUSqvDgxDP/34ZCULTd2i7R7GpqX2NK5fDznOxd6wXSHhjup1algJRPYoMN8dpBXuu24kmjTp/l7KfKOz41uGssyJtBWRnakyUp2UUsLqESnpXLAm0bfW5hrD05DtAlcwd6eV53RFVqLYm8PkrnRtbpWv85B4IT7xoGrsX8FXAng1upKcocCBHccpE02Bdi5qmqjlfa2mY/gQoPBjx6tI3d88DZpZOAtBge34e3Pzni8hY8ezRw6bniLDs0IThWMtauh4hYtzHgjRQgS6AnwsWykmw+Odi+bBsYIHZqJNi2KCFvBZX9cPm4QTpQjPTRGm5WOQeeNQgFysnFwaUFpB0HRaZJMZx7BEVhfkdWJb+DxGaPpaBduD/dfFm80vNbKoXK3I/i7RgV85afmFsaIClB99OhRwESbLaGTWmVk7bA4qirsHIrbR2cIibSV7rCE254rpfHqlmXM8all5RU76zl0k7GHfOqt07lUDqeRhrmbd0hy2I5RCBQkt8oMWVgwxVtkJVsTk2VMEg077uot3ES4vDw9ptxRhJMayxhxRRoUrCQaZMxWNbaclQsWQTDrjFRTtlxmK6fpWE91mtS+0mlIR+8vkPWRw5DWYPELJfAJohHbAmGsdYNcbWD4J/895Oro7DT/C40ltwlRjVyg2WYonSVjqHxLWT3cP3yV7/+UH7yivKaKZ+Xw+fLTox1T5lup0AbggjvMx9yigKOzU5hFLMMucS9dTd3HBIGKN80ITiegtEKqq87omRQosijDu66RVSDfMwtXrVSy9e3Q9s3z2rnOlkUhdGVHgbOjSrdFz9G+MYb3Be9knjSlmv6YDOaDxy8IhrcoRmx5kzGLlTfSzQO5X0d6HoUKP/KuZuXVzXJQLMbe82nPHoO208qipaAf7h/Sv83o9eVKcT3cf/lYQGmoYncgkZfbRN5oB79pr4jzvWy5YIPIFR8sSS4GFNhhAq4VwLWiAklERQEGrfamQhAaY+PDB2ndCP7kdwjWm9i0+8zB6XERqkum5kwsTpTT4w9YuY1Cu2Kh54aW0xmaeE7GiKXna8JyYzgVl3TYDp/vtvr+Dkmh4g6n2sx3+AhSW+piM0jnHVZyItHCfY3pzHFc6Kryxo7gYt5JIvQcHI3cO5yDFKhc1CJ57pyRY++wWHVNMNiEwnB6bXJE2V6hfgI0skCy1EiiJaBk9qb6JNmEfGq076Sa2jAUK65oYhD3w1jzshFQEa/bJF9zJRqppiBVrM/BcAiYW5qnU/wy5LMeiEDHZWOBj7V3g6DmMEWFZh3OZLpHab2Z8Coi5TQhBQGnyNEfVSQ+8LZrYp6Vdu8noUgGxLrayD9LjB/ypRwoDg7HdhTIPY/1ERSofRAQJ12DscjyUGT5CTnN30bWruDaDvkdcjvPqanneobGSIGrxY8a9YNDRT0qgo+wd87pjM144z+Z1zQ0NvViy1oJU+saCu2CtVLo4VEbbNHVWgwhhwFcsmJ2UKy21mKx3g6WRb+LFIv1+F7SvEIz65cKbxoaZanR807GPp8LbEOzf0SvY2w124xqtJfLCK/VjE65w/BWm2dGi8/Y7Oj1cGKcU7eN9NsyN1YFQs778RzmO3ITBvam92Qib3CGDXDvauosscFT5Z3PrcP2WzxECzscLGmdmOhgNRE6rBw0iokLaenYWBYyRruBfTs5RzOTFQ4ivR7Toe6LIFgIck3tOQ/fcz0JESbVRysVNpVuw/odcDyzcJJIDmmLDVuC0JVvUblwjB/SiORVGJFpeTruvcI7asWhvDKGLZdNoEp6+8uaGRSNTlvXcrVhJ96lBvvkBubFejx/v5N9v5N98U4Wi9fhgyu6hstQ5aFfLVJXvWKzg8Do1FdZxsqNe9fgJ4FycDe6yVitrSMDiwUt65emWS7pcby+UMcVMuRAsHLCG4ufofK3XG62njFOnv5a1U+Z0Fpn3EiC9USIz9+lxfAF7L5wbsXSb55BYgWlxzgINg2T/wTQunl8BaBBkpc3y6y//D0tWv/rK91nObf9Gr1m4GotiiU9ePfotrWxDR2f/HFyccIyxjcH82oQpw+Up60JXiyixIW+Q7VcrvLt6HvYM5f/Ais1G+Q=
+sidebar_class_name: "delete api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+This endpoint allows you to delete an **unprocessed** payroll.
+
+By default the payroll and associated data is deleted synchronously. To request an asynchronous delete, use the `async=true` query parameter. In both cases validation of ability to delete will be performed and an Unprocessable Entity error will be returned if the payroll is not able to be deleted. A successful synchronous delete will return `204/No Content`. When a payroll has been enqueued for asynchronous deletion, `202/Accepted` will be returned.
+
+scope: `payrolls:run`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/delete-v-1-companies-company-uuid-holiday-pay-policy.ParamsDetails.json b/docs/api/delete-v-1-companies-company-uuid-holiday-pay-policy.ParamsDetails.json
new file mode 100644
index 000000000..e5b4000df
--- /dev/null
+++ b/docs/api/delete-v-1-companies-company-uuid-holiday-pay-policy.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"X-Gusto-API-Version","in":"header","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"},"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."},{"name":"company_uuid","in":"path","description":"The UUID of the company","required":true,"schema":{"type":"string"}}]}
\ No newline at end of file
diff --git a/docs/api/delete-v-1-companies-company-uuid-holiday-pay-policy.RequestSchema.json b/docs/api/delete-v-1-companies-company-uuid-holiday-pay-policy.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/delete-v-1-companies-company-uuid-holiday-pay-policy.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/delete-v-1-companies-company-uuid-holiday-pay-policy.StatusCodes.json b/docs/api/delete-v-1-companies-company-uuid-holiday-pay-policy.StatusCodes.json
new file mode 100644
index 000000000..3ec09df16
--- /dev/null
+++ b/docs/api/delete-v-1-companies-company-uuid-holiday-pay-policy.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"204":{"description":"successful"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided ID/UUID is valid.","type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["error_key","category"],"properties":{"error_key":{"type":"string","description":"Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error."},"category":{"type":"string","description":"Specifies the type of error. The category provides error groupings and can be used to build custom error handling in your integration."},"message":{"type":"string","description":"Provides details about the error - generally this message can be surfaced to an end user."}}}}},"x-examples":{"not_found":{"errors":[{"error_key":"request","category":"not_found","message":"The requested resource was not found."}]}},"title":"Not-Found-Error-Object"}}}},"422":{"description":"no policy exists","content":{"application/json":{"schema":{"description":"Unprocessable Entity\n \nThis 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.\n","type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["error_key","category"],"properties":{"error_key":{"type":"string","description":"Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error."},"category":{"type":"string","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."},"message":{"type":"string","description":"Provides details about the error - generally this message can be surfaced to an end user."},"metadata":{"type":"object","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.","oneOf":[{"type":"object","description":"multiple entities","required":["entities"],"properties":{"entities":{"type":"array","items":{"type":"object","description":"single entity","additionalProperties":true,"properties":{"entity_type":{"type":"string","description":"Name of the entity that the error corresponds to."},"entity_uuid":{"type":"string","description":"Unique identifier for the entity."},"valid_from":{"type":["string","null"]},"valid_up_to":{"type":["string","null"]},"key":{"type":["string","null"]},"state":{"type":["string","null"]}},"title":"Metadata-With-One-Entity"}}},"title":"Metadata-With-Multiple-Entities"},{"type":"object","description":"single entity","additionalProperties":true,"properties":{"entity_type":{"type":"string","description":"Name of the entity that the error corresponds to."},"entity_uuid":{"type":"string","description":"Unique identifier for the entity."},"valid_from":{"type":["string","null"]},"valid_up_to":{"type":["string","null"]},"key":{"type":["string","null"]},"state":{"type":["string","null"]}},"title":"Metadata-With-One-Entity"}]},"errors":{"type":"array","description":"Will only exist if category is `nested_errors`. It is possible to have multiple levels of nested errors.","items":"circular(Entity-Error-Object)"}},"title":"Entity-Error-Object"}}},"x-examples":{"bank_account_delete_unfunded_payments":{"errors":[{"error_key":"base","category":"invalid_operation","message":"FundingMethod has unfunded payments"}]},"bank_account_verify_incorrect_deposits":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Your bank account cannot be verified. Please check the test deposit amounts."}]},"bank_account_verify_already_verified":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Your bank account has already been verified."}]},"bank_account_missing_routing":{"errors":[{"error_key":"routing_number","category":"invalid_attribute_value","message":"Routing number is required."}]},"payment_configs_missing_parameter":{"errors":[{"error_key":"base","category":"missing_parameter","message":"At least one parameter must be provided"}]},"payment_configs_invalid_fast_payment_limit":{"errors":[{"error_key":"fast_payment_limit","category":"invalid_attribute_value","message":"Fast payment limit should be a number"}]},"pay_periods_invalid_end_date":{"errors":[{"error_key":"end_date","category":"invalid_parameter","message":"End date cannot be more than 3 months in future"}]},"company_industry_selection_naics_code_required":{"errors":[{"error_key":"naics_code","category":"invalid_attribute_value","message":"Naics code is required."}]},"company_industry_selection_naics_code_invalid":{"errors":[{"error_key":"naics_code","category":"invalid_attribute_value","message":"Naics code must be equal to 6 digits."}]},"company_industry_selection_sics_codes_invalid":{"errors":[{"error_key":"sic_codes","category":"invalid_attribute_value","message":"Sic codes must be equal to 4 digits"}]},"time_off_policy_name_required":{"errors":[{"error_key":"name","category":"invalid_attribute_value","message":"Name is required."}]},"time_off_policy_unlimited_invalid_accrual_rate":{"errors":[{"error_key":"accrual_rate","category":"invalid_operation","message":"Accrual rate must be blank for unlimited policies."}]},"time_off_policy_pending_requests":{"errors":[{"error_key":"time_off_policy","category":"invalid_operation","message":"Cannot deactivate policy with pending time off requests."}]},"time_off_policy_employees_required":{"errors":[{"error_key":"employees","category":"invalid_attribute_value","message":"Employees are required."}]},"time_off_policy_unlimited_balance_update":{"errors":[{"error_key":"base","category":"invalid_attribute_value","message":"Can not adjust balances for unlimited policies."}]},"holiday_pay_policy_already_exists":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Company already has a holiday pay policy."}]},"holiday_pay_policy_not_exists":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Company does not have a holiday pay policy, please create one"}]},"holiday_pay_policy_invalid_employees":{"errors":[{"error_key":"employees","category":"invalid_attribute_value","message":"Invalid employee uuids provided."}]},"onboarded_employee":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Cannot delete onboarded employee"}]},"invalid_attribute":{"errors":[{"error_key":"base","category":"invalid_operation","message":"There is an error in the request body."}]},"company_cannot_enable_contractor_only":{"errors":[{"error_key":"contractor_only","category":"invalid_attribute_value","message":"Contractor only cannot be enabled for existing companies."}]},"company_missing_parameter":{"errors":[{"error_key":"base","category":"missing_parameter","message":"contractor_only is required."}]},"starting_after_uuid_invalid":{"errors":[{"error_key":"starting_after_uuid","category":"invalid_attribute_value","message":"Parameter 'starting_after_uuid' does not correspond to a valid event."}]},"resource_uuid_invalid":{"errors":[{"error_key":"resource_uuid","category":"invalid_attribute_value","message":"Parameter 'resource_uuid' does not correspond to a valid resource."}]},"payroll_gross_up_invalid_net_pay":{"errors":[{"error_key":"net_pay","category":"invalid_attribute_value","message":"Net pay must be a number."}]},"payroll_accruing_hours_invalid":{"errors":[{"error_key":"base","category":"invalid_attribute_value","message":"Hours cannot be negative."}]},"payroll_cannot_cancel":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Payroll cannot be canceled."}]},"frozen_payroll":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This payroll has already been processed. Its data cannot be updated or altered."}]},"frozen_payroll_processing":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This payroll is being processed and cannot be updated at this time."}]},"unmodifiable_payroll_type":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This type of payroll cannot be modified or processed. It is reserved for system processes."}]},"invalid_employee_uuids_format":{"errors":[{"error_key":"employee_uuids","category":"invalid_attribute_value","message":"Parameter employee_uuids must be an array."}]},"maximum_employee_uuids_surpassed":{"errors":[{"error_key":"employee_uuids","category":"invalid_attribute_value","message":"Exceeded maximum of 100 for lookup."}]},"invalid_employee_uuid":{"errors":[{"error_key":"employee_uuids","category":"invalid_attribute_value","message":"Invalid Employee UUID(s).","metadata":{"entities":[{"entity_type":"Employee","entity_uuid":"invalid-uuid-123"}]}}]},"payroll_blocker_missing_bank_info":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must have a bank account in order to run payroll.","metadata":{"key":"missing_bank_info"}}]},"payroll_blocker_missing_employee_setup":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must add employees in order to run payroll.","metadata":{"key":"missing_employee_setup"}}]},"payroll_blocker_missing_federal_tax_setup":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must complete federal tax setup in order to run payroll.","metadata":{"key":"missing_federal_tax_setup"}}]},"payroll_blocker_missing_bank_verification":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company bank account must be verified in order to run payroll.","metadata":{"key":"missing_bank_verification"}}]},"payroll_blocker_suspended":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company is suspended and cannot run payroll.","metadata":{"key":"suspended"}}]},"submission_blocker_missing_selection":{"errors":[{"error_key":"submission_blockers","category":"invalid_attribute_value","message":"Submission blockers selections required"}]},"submission_blocker_invalid_option":{"errors":[{"error_key":"submission_blockers","category":"nested_errors","metadata":{"blocker_type":"fast_ach_threshold_exceeded"},"errors":[{"error_key":"selected_option","category":"invalid_attribute_value","message":"Selection is not available to resolve Fast ACH Threshold Exceeded. Please choose one of Wire In, Move To Four Day"}]}]},"invalid_version":{"errors":[{"error_key":"base","category":"invalid_resource_version","message":"You are attempting to update a resource using an out-of-date version."}]},"signatory_email_required":{"errors":[{"error_key":"email","category":"invalid_attribute_value","message":"Email is required"}]},"signatory_company_already_has_signatory":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Cannot have more than one signatory in a company. Please remove the existing signatory before adding a new one."}]},"mixed_disbursement_errors":{"errors":[{"error_key":"disbursements","category":"nested_errors","metadata":{"contractor_payment_uuid":"invalid-uuid-1"},"errors":[{"error_key":"contractor_payment_uuid","category":"not_found","message":"Disbursement not found."}]},{"error_key":"disbursements","category":"nested_errors","metadata":{"contractor_payment_uuid":"d0dfa222-ad08-4ea7-a06a-717688c3b179"},"errors":[{"error_key":"payment_method","category":"invalid_attribute_value","message":"Payment method must be one of: Direct Deposit, Check."},{"error_key":"payment_status","category":"invalid_attribute_value","message":"Payment status is not valid for payment method 'InvalidMethod'."}]}]},"not_found":{"errors":[{"error_key":"request","category":"not_found","message":"The requested resource was not found."}]},"finish_onboarding_incomplete":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Company is not ready to exit onboarding."}]},"company_location_validation":{"errors":[{"error_key":"street_1","category":"invalid_attribute_value","message":"Must include a street address"},{"error_key":"city","category":"invalid_attribute_value","message":"Must include a city"},{"error_key":"state","category":"invalid_attribute_value","message":"State is in the wrong format"},{"error_key":"zip","category":"invalid_attribute_value","message":"Please enter a valid zip code (e.g. 12345)."},{"error_key":"phone_number","category":"invalid_attribute_value","message":"Phone number must be 10 digits"}]},"conflict":{"errors":[{"error_key":"request","category":"duplicate_operation","message":"A resource with these attributes already exists."}]},"invalid_parameter":{"errors":[{"error_key":"request","category":"invalid_parameter","message":"The provided parameter is invalid or missing."}]},"flow_invalid_entity":{"errors":[{"error_key":"entity_type","category":"invalid_attribute_value","message":"Invalid flow entity"},{"error_key":"entity_uuid","category":"invalid_attribute_value","message":"Invalid flow entity"}]},"flow_nested_options_errors":{"errors":[{"error_key":"options","category":"nested_errors","metadata":{"flow_type":"company_forms"},"errors":[{"error_key":"form_types","category":"invalid_attribute_value","message":"Supplied value 'invalid' contains no permitted values"}]}]},"basic":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must complete all onboarding requirements in order to run payroll.","metadata":{"key":"needs_onboarding"}}]},"contractor_payment_invalid_wage":{"errors":[{"error_key":"wage","category":"invalid_attribute_value","message":"Wage must be greater than or equal to 0."}]},"contractor_payment_cannot_cancel":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Payment has already been processed and cannot be cancelled. Contact support directly."}]},"time_off_request_cannot_delete":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This time off request cannot be deleted."}]},"resource":{"errors":[{"error_key":"first_name","category":"invalid_attribute_value","message":"First name is required"},{"error_key":"date_of_birth","category":"invalid_attribute_value","message":"Date of birth is not a valid date"}]},"nested":{"errors":[{"error_key":"contractor_payments","category":"nested_errors","metadata":{"contractor_uuid":"72ae4617-daa9-4ed7-85e0-18ed5d0ee835"},"errors":[{"error_key":"hours","category":"invalid_attribute_value","message":"Ella Fitzgerald is paid fixed wage and hours cannot be set on a contractor payment"}]},{"error_key":"contractor_payments","category":"nested_errors","metadata":{"contractor_uuid":"2d7bf62c-babf-4a12-8292-340e2d9cab28"},"errors":[{"error_key":"wage","category":"invalid_attribute_value","message":"Isaiah Berlin is paid hourly and wage cannot be set on a contractor payment"}]}]},"compensation_invalid_rate":{"errors":[{"error_key":"rate","category":"invalid_attribute_value","message":"Rate is not a valid number"}]},"compensation_invalid_payment_unit":{"errors":[{"error_key":"payment_unit","category":"invalid_attribute_value","message":"Payment unit must be one of Hour, Week, Month, or Year"}]},"compensation_already_processed":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Compensation has already been processed on payroll."}]}},"title":"Unprocessable-Entity-Error-Object"}}}}}}
\ No newline at end of file
diff --git a/docs/api/delete-v-1-companies-company-uuid-holiday-pay-policy.api.mdx b/docs/api/delete-v-1-companies-company-uuid-holiday-pay-policy.api.mdx
new file mode 100644
index 000000000..4362cb758
--- /dev/null
+++ b/docs/api/delete-v-1-companies-company-uuid-holiday-pay-policy.api.mdx
@@ -0,0 +1,71 @@
+---
+id: delete-v-1-companies-company-uuid-holiday-pay-policy
+title: "Delete a company's holiday pay policy"
+description: "Delete a company's holiday pay policy"
+sidebar_label: "Delete a company's holiday pay policy"
+hide_title: true
+hide_table_of_contents: true
+api: eJztXFtvG7mS/ivc3gcngNq3OJfx08nGzo6BzYwxSTbnwAnaVLMkcdxNdki2bI3h/76oItk3XWI5NnZx9gwQTCKRxY/FurGqqNtEV2C4k1qdieQ4EVCAg3R+kOa6rLiSYMPfFlldS5HOdCEFX2QV/tGFzBfJKBFgcyMrpJIcJydEg3EWJu5YFmaxCv/QrK/qq7K5ruCYXS7RlGCPr410cJmMkpt0WlunU6kcTD3U1C0qSI4vEijHIASI5NsosZDXRrpFcnxxm7zzS7/Nc7D2be1myfHFt7tvLTVjr/k0OXamhlFiwFZaWbDJ8W1yuH+E/+vvydZEaVIXyd0oOVo15Dft2HtdK5GMklwrB8rhIF5VhcwJ9t6fFkfeJjafQck3kGBfFWNf1acZMAPfa7AOBDNgdW1yYEKDZUo7BjfSul32gV8Bs7UB5mbAKqPnUoBgZyd7nz+fnTBp2ZwXUuwmo8QzLtHjPyF3Ce78ey0NCGKmMdpYZGVlUCqc9AwJnx/fxtncGI7HLh2U3c/XU82uACfk3MFUm8WaNWhUS846I9V0Sbw+VpDLiQTLrmcQ9kzTmc7z2thd9mlRyZwXxYK5mbTsChZMClDOz8Lx3Dkjx7WDvYobXoIDwwwUHNnsdEtyF0+7Qb0FNKSAY5meBEoMDzOSiodkA/Kp0XUl1dQyrgTLuWJjYLX1aMa1LATLUWzLMH7GlSikmjKp2ELXhnWUgzCXYC2fwo8hn0cgAhyXhWV8rGvXYWrKpqDAtOwMpCNKW5sJzz1SrhgogcCRc/gfKhzc8LIq/Dkr7bIJKUlHsC56558Eie/Ky3FnYmdzyRoFueZeP2jCbnL3DYE46QrwSpaSkqWnuGj6u5daj/bo8HBZLZUORssrnH24gn9WldFoSPi4AHaqnHSLqOrIWr5gM15VoFC2FZ3CWIsFShEdc9grw+W5VEF8LLN1PmPcskupSNWzRsCzOS9quBwxbYhcpDChwxY1hHNrZjb+4HKXfQSvXhenfpl3/jwk2G/PZs5V9nhvT+jc7pJN3c11uRctclrxhdFFQd/vEcw0b6Y/Z9NaCmATbVipDUTp2/2q/mWk/l8YKXY2aReSll0q0uHMn+PliMD5s2LXsiiiyDPO/Eh2GYaycEgLdi3djAEpVVCM/zO2EFE4Lrjjq0SxD+NdVG4DBcy5cgznIc0gIIugycHaScVIp6UOZiNYpHEBu+y9NiwY4FGPBOEjVl36/2eI6pLONn6CEd+lZ/+4DSwwjtAKfp+Q5d68l7IunKwK8GuhHg0UL368rGzxmy1UehCzSTWNK+M0LoTEr3hx3lnJR4Ar1vYM+bHU/MZL0iASE89RN+Ndscm18RGmsMxpkoYOg3+8wmclv9fQmgdDdrNdjyh66z0xumwJXrQUVV0UybdmXF1lTm8e2LNzqwZYxx1sGtJxuh+C9KdfpJulvytIvfNL7taP+hBkxw/Fo7kb/evM/xnOHCmtddh9PnxB46NVEWIvJje6jV125vDjSlsrMcRyms34HFhjhwqYQ2Hx7IIbiY6iMStJLk1eF9w883B7YeLzpLvDFQOSFUHvmKurjOe5rpXL/A07q9WkVgIEXnpLUM5uCIjH3EI/Gl4K1npR8ftaCammH8DNtGAzbllcjTWr0Rn0gM3ByMkik4pEN0eklbbyUZH9A8MAXJWFVdFzYqQ+BkbrSxC77LwAboHlM8ivfJCCEWuAw3iJE+3u+i3wwgAXiyxSfNINIHvDgmwMoNp9rABYSosWKjO6dqg2Gy5BfkSm6nIMZjXEQZDfA/qHn8/8fNSJ6HYDriAJWa7VRE5tA62JNbfi2vLsLpi3juGROqYVsDaYLWvruoHFamBxtxNuXdSWrJCldBsQrhi8NQvfI+JAgxENZme6LgRi5oGzDeasAiO1aPGCEpkI1nINymbISmyreXmqBMaD0NEcukG5GVfsBSu1cjOLMeGkdrUBjy+m8KQStXVmkVkoIEfpzhSXuc1yLSBrA7O1iNvR2/PzN5zLcO4KcbwfwrDM0wOMognfa16gF3nFhJzKxuxsgGsjAHsPuFbmfuz2aD/KnLDaZbBHAazH6mQJmZ5MQr42U7y851mXD2Jiuep8hyBqRRoFotEXnuem5kVmNutMb9gWlvutn8dwXsOxcYGmHCOrBg+LGeg1wCsg55qFRMom7ziYug3ad165BfDcyTlCDhkouuMGDAwXYHoyiVmddZihrAq9ALD3OfZm8PZnfxqnMm7g/hIw5gVXOWR19QN7ud5bb0L1jivKBnLxJx27X81uPvblOkcTVoQk4OMFFaFY0YQRFFKsqJmsh4bZ0SeD1ZQbKJJeBWzEqhCyGUBZ1QrWQm3cYyNmTyKKZ34MiyQYXrtsJ4dB+LQaa24wDI/jHpN/UYepHNYs1UDyEJY284gIPlHuUVpK9tC1VKpeFhiTywOP5sOKDBTmjzAIc4bnTpsML2EbsA1Hbq+mDQF/32vjG49FkMKSlKPta+qTA/xPGccO9rjCzVnHDcXtfOLA0F3/PlHA8qzt+XfexNU7K+jttGrcpiYoT8mCosxBubCLmFq8L/7e+J9C3qP0Q8xxdHulwZJDNjXaWkx3xMUV0GVgU6wTRmwf7gDdEZqIIt4LBpAoasETmena3CcwfJir+xWpdzRHwZQ7OR8yKOh4jn6weER7c+7pdwD4JRr1mBj9F6gs4HhUS4dZn7D80pU8FN0wt3DmrE+ntxh92CGwQsYLB2YN2ixQ2Xxv/yng0rIxoHFrAMdSywAqpRqlpQAwgK1VqYWcSDLbEXLMZj4m2FgxqpYO2wPwnOyx3BtKC2YerLhdWAdlMyja8GFsQFbAZhNtSr7ptt8f/zMGqE+p1WrFKD0ZcJb8RpZ1OcRpa1Nx3PMTQj29yQEwiggY8CQO9veJq4XWV3W1iZdPCCwGXPEOwLD35Jl9vpv0a19tXedikHRvrg/JIFce10+pA+ng8AVV9LsGbVzo/ApM4/wp6SbVRG8l/ANqK4NhkogQCPfygFIxbQQY9E+mVlE9htv3ay/j3Lyf5nAsuLp6mk1x0Yam9mHbGcDcvKcJCCylZo7fPOW2MC6kADysxxy/YbTew/a4DPseouhzwr5J5NG32RPDaLFiFvon5LIHevUmbW0xF7Fliv0+m5LY1BKId53gD7fQQvKQbT2mXWm1dDRNzm5TaL40/SGpuoYIi0RYs3h7h0jWAW698s+i7ZXLBvyLqwVrTCl0ns8yNzNgZ7oQGQTnk3Tqd0MEtC1osG7Pq8gXFAFK28y5LHgo5mHEX8yBUW7+7btf2acIjkXP2KkfaW0pGYFO8os0wM7UiH3Qc2CfNDZaGnbCqRzZdZhzMHZbNY1zm+tLJDKoHVFejDsHZUWXWKdDSMd4289Ro3BiyKFrl+pJSt8HgvGaKaeKO20wtcdlcb+0HpfFQ1J6XBbdi+4QQLx3x+zYjNus+fbxsym+mtsUPPBwm9UYtQcFQI0YGCjxxKl0HpMH7ZQxTJAY9gkg05mCayQaAz15AyIT0o5rY4GKSW3des3GuqO30L5ObiHWrVZGPxt0bx2JezRSnnRAD1onR0+8PbEvJvzw8DDlYv9NegT8dcr3X/H09cHrV2/e5C/GB69/2bDpSK2kavdDYn9f4PPzG//prcYxO5FYC2cnvvg8Yu+wKL2bDLkSUWB/RP2gG4hH4edH0+cjagztqz7KnRBt+xL/zm60Yf9b7bWjZCKVtLMsZDnRu2IjgQ+9niAnHRjk7/hOo2Y71i4+yAkW2kcxGZH+URRmnQFw2cH2p/gBhUeqvKgFWnRPCG2LAWuXZCb3LUo/twYRGVL2XTrbu16chqwNWeJro9WUhdv3cI2/ZPUAMfcmGRTetWMW7y9Z+aLrM9id7rKDwxdHL5+vULGZVvDgfohznB27IaKSH+z3CqXYcVDIfFOmYaXyiNp3gMO60mNHdbB852ZgO+29bbLKl3AGF/j7JLJXwtrcR/Cp+1Sk7cmg0/fngr3ZPlKOOl7o6057A/VybWpuaO/2D84m4JKxm28oEN0cweMs0GwyeDIfw9of+/ww8P7ukFYJgXa0UqhodoOnw+9pzoNuINgTDILRV2wnzNlpXxLgIwcwpXQujrLRq4y5lfkT3845tflF+x2jTQoytrvCKgBhO34oXANXxB+Rb9ehOXzN7ujrrRn+BdvCo52ZUlnUhJDVtI0a+42jWkL3hDl6iiTWJ8kHOWePAHP4jDrTc8dsXVXaOCYoOCoWwwp/MEdxD74C+uh56EHzQweyX1AMqlmb2sWksS57WMPLe5zL1KDtZclaCfIPk2wsjZttv8oJ1dUnjKY3V+PgQaltwgeAZHPuV6ZtekEfEsSH4P31IYejVwevU8H5L+kRiNfpm5ewnx68AfFS7AO8efFyg0mjatgDLqVFwdl76f6aYipOUMcvR2OO1zWGCksyPBtUwyxgjEhXxKbUHJiw4qLzyJw6FK/Hk1eHeTrm40l6xA8O0zeHvxymL4724VD8kvPx4ZsNnHqYFTqzXPIZ+w8whVQNm5AvxYJYdB1er9yPQzGmBmV9PN3kPTb37azv1drYwhqi0a6kd5suVyJpLpdqY39ob9iDb2s4e3BjZFiCHbEvAFeYalJuRk/v/gF8FeqYNGls7yNfleJCm6y97jjU/kvJ3mvFdE2z+x2lhUP46FGTHT1O/p7+Jz21fnt+lv53kw+T2NU/Ay4oLGgfSg6fQ4CqS3xgcLh/+DLdf5UevMQ3QgImvC4c6lP7+d3yC3SHoYwKb9zQPKbIPsHenp/FVBrj1upcUj2VwnJ6o4YD8FkePVBTeKay7Roa+TGdF587ll2UUlElrkN7y+eRvJJpmCnV9N8DwbTz8XOEgW/t/L0ocLj7Mj+ytuLkXvoMwWCf3oKHNythYu8xln8Us+5A7vDxvONTPOHk19ABdo5/Qt9cQo/rbQX8CrhdpPRakEw8jT3ni2ZkfyDuJdVzMEYKaH6CACXgxoGyFFejVHktWPtrAPTKpR78KgDyqj/Pv/tvBuOmu4OG+JuBq/axemJ/Py2BsC/kY8hVdfZKp3ac7M0P9prGpr3b7vne7a386QUqqge9q02BQIPk8Up6wUsFlCR9K36podSD0/D0Up+Zw69xk2sIr6R5bigLt45mhV/fdX6u4SMKnO8CXPGjDY0Y4uLRXuC/x8ANWZDh20kikdIzH8ZrN8O7XaxhjZKP1HjwMyt4CmsWoGu7rzpHI0o2EG0DikIsLXSt1yhBY2V/n3wEM5c5dDjd2g16ibpHA/cELo02P6V/Y4nAhqlLr6egyHVJlRPCsWPZaVAOFpt10GwJndfo0Wgb/xbet3OfCQm25iSuyv7AN8jhuuurCigq4du/tZJBnkFbV3LVo3OPXwcZbuS2fXD/2D8vEk7fwY3bqwouSUxI4G+DVl4kc8oFRr1MRsnxwPKuUM1v+Kl1OP32Fp3PZ1Pc3eHH32tA933xDW2DoYYdUl8hydGK5HjCCwsbWPDsj2C1n7P1ln3lxuJbOxoRLVMSHv71/Ylv4PWOejt4/9Tudw1jPQNXhzwNn1uHgRaocp3vln5FoucnTk7/6/TTKb5n7dusxkaFv3QeZPeP+PbWj/ikr0Dd3TUn7vDfFPbd/Q8z+ATC
+sidebar_class_name: "delete api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Delete a company's holiday pay policy
+
+scope: `holiday_pay_policies:write`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/delete-v-1-companies-company-uuid-signatories-signatory-uuid.ParamsDetails.json b/docs/api/delete-v-1-companies-company-uuid-signatories-signatory-uuid.ParamsDetails.json
new file mode 100644
index 000000000..dc587f8c1
--- /dev/null
+++ b/docs/api/delete-v-1-companies-company-uuid-signatories-signatory-uuid.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"company_uuid","in":"path","description":"The UUID of the company","required":true,"schema":{"type":"string"}},{"name":"signatory_uuid","in":"path","description":"The UUID of the signatory","required":true,"schema":{"type":"string"}},{"name":"X-Gusto-API-Version","in":"header","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"},"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."}]}
\ No newline at end of file
diff --git a/docs/api/delete-v-1-companies-company-uuid-signatories-signatory-uuid.RequestSchema.json b/docs/api/delete-v-1-companies-company-uuid-signatories-signatory-uuid.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/delete-v-1-companies-company-uuid-signatories-signatory-uuid.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/delete-v-1-companies-company-uuid-signatories-signatory-uuid.StatusCodes.json b/docs/api/delete-v-1-companies-company-uuid-signatories-signatory-uuid.StatusCodes.json
new file mode 100644
index 000000000..2324dde17
--- /dev/null
+++ b/docs/api/delete-v-1-companies-company-uuid-signatories-signatory-uuid.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"204":{"description":"No Content"},"404":{"description":"Not Found\n\nThe requested resource does not exist. Make sure the provided UUID is valid.\n","content":{"application/json":{"schema":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided ID/UUID is valid.","type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["error_key","category"],"properties":{"error_key":{"type":"string","description":"Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error."},"category":{"type":"string","description":"Specifies the type of error. The category provides error groupings and can be used to build custom error handling in your integration."},"message":{"type":"string","description":"Provides details about the error - generally this message can be surfaced to an end user."}}}}},"x-examples":{"not_found":{"errors":[{"error_key":"request","category":"not_found","message":"The requested resource was not found."}]}},"title":"Not-Found-Error-Object"}}}}}}
\ No newline at end of file
diff --git a/docs/api/delete-v-1-companies-company-uuid-signatories-signatory-uuid.api.mdx b/docs/api/delete-v-1-companies-company-uuid-signatories-signatory-uuid.api.mdx
new file mode 100644
index 000000000..51c181ed7
--- /dev/null
+++ b/docs/api/delete-v-1-companies-company-uuid-signatories-signatory-uuid.api.mdx
@@ -0,0 +1,74 @@
+---
+id: delete-v-1-companies-company-uuid-signatories-signatory-uuid
+title: "Delete a signatory"
+description: "Deletes a company signatory."
+sidebar_label: "Delete a signatory"
+hide_title: true
+hide_table_of_contents: true
+api: eJzdV99v2zYQ/lc49qEtIFpN0e5BTwuabAiwrUGTbAMco6XFs8xGIlWSciII+t+LIylZSuJubQcMWF4iiffj4919d+eOWsgbI11Ls2VH3+iq5qo9znOw9rhxW5otV/0qoQJsbmTtpFY0oydQggNLOMmDArGyUNxp0y6u1bV68oS8g5I7EKRopAB7rRhZXgwy5HQHytnVM6HzbNRk4L8+RwM21zVk5MNwKMFmFVe8gA80oXesaKzTTCoHheEIirm2BpotKVRrEAIEXSVU1xBOzwTNqPCg2e6IBdASbHxq3zeNFGzibHwORxOfxt7ygmbONJBQA7bWyoKlWUdfvniF/+aR+l2TN1o5UI72CX31uIgjP+tGCbz45RaIgU8NWAyeAasbkwMRGixR2hG4k9YtyG/8BohtDBC3BVIbvZMCBLm6Ojsh0pIdL6VYXCua0Dx6zzrK67qUuQ9I+tGi747afAsV/wIocq0I+V5cZyfpHBpNaEgY1euPkDuKsfzUSAPCJ9EYbSymsDaYRCdDiOP3rBu0uTG8pQmVDqrp98NW398AKuTcQaFNe8CHl9qbs85IVdD7NLioIZcbCZbcbiHe2asTneeNsQty2dYy52XZEreVltxAS6QA5YIWynPnjFw3DtKaG16BA0NM5I7Te5MLrJ8R9VdAQwsoS/QmWiKYzMHUkCQbkRdGN7VUhSVcCZJzRdZAGhvQrBtZCpIjEaoov+VKlFIVRCrS6saQCSk95gqs5QX8PeTzAYgAx2VpCV/rxk2CykgBCsw+nNH0gNI2ZsPzgJQrAkogcIwc/iGF4Y5XdRnyrLR7v8EKnxbWcpZ/Git+Wi/ZRHFyOXqAILc88MMrLGi/QiBOuhICyZgnGTtFp+xtqNoId6yHgEvxCnWmHQsLHyNXc7d9EE4E5EmnNz6GUXHGidDF9j1gnqC+T0a3D/rhP3c8qn6j67/YL77zHp+fsT/AWPQS/W+BCzD0sJ2EgmoqJP/LFy9fsxc/sqPX1I+zDW9KR7Pp9/7hmHNgKqkiiwR3wNYcuXB8fkZ2AQvh1upcesLeSrcNLEABJP6CnG2I0gqw9w39MAkyk3781JJlJZWsmmpqe/Vs61xtszQVOrcLP4EWua7SYcqxmrdGl6U/T3ktWdSUqngSDbLJ5+cIA9mMpZhQxwssLnqxn3wYnTtma+A3wG3LMAlM78AYKWCcohjYOwcKbYbyDIQ5OJkTuuNlc29CY5LnemG6jsJYJFOhQ7BGhQEeXq4Ct9ViCtmXa0bT3VE6rgBpN2VUn06WgLSbV32PhQZmNzCyMSXWYMwQr2VIEBNQ+Sw9YMYJVJrOwxvsMRlwVpridQ8YftTmudHiCzZrPMZoDGveBTIldMBHlr2RP+h84BW+r4Ebz7S592iClbCDkvDGbXG4hZpGPl201kH1PR6ChQMOeuwDG+2txp7qewVyCIsidosZyxOKpLZvNxdgdjKHSaT3/PKjJ/WCqUDXuCEw/870xkcYVe+D/RPKXFeAA8jjeGrJaax2ch6Y6uktdN5UoJy/xg9xS+O539Ji1zsZvIZN2vMsoVBxWfpSiac/7SvDzwxtXcXVzA4WP+GzNjxD3e13xP96sY+l4eDOpXXJpa8hz4YukndJd0c+XpG+NKHZvZE4MY2n9ybXKqFbbR1a6jps5lem7Hv8/KkBnO/LFXYTI/ka62nZUSEtPguabXhp4QvRe/Yujrfn5PD0ffSOwzrrJYZeRpPY+GYXxAbxr0CaFsQ3gLoX137VJ8M8/rqo/a+n7IHQhhA+vtmMkd5PPmygtZucPfgpNxt4J6e/nl6e0oTyecsdW2x8wDw9muSuCxKX+gZU3485d/jul9j+M6cJtBY=
+sidebar_class_name: "delete api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Deletes a company signatory.
+
+## Related guides
+- [Signatory Events](doc:signatory-events)
+
+scope: `signatories:manage`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/delete-v-1-company-benefits-company-benefit-id.ParamsDetails.json b/docs/api/delete-v-1-company-benefits-company-benefit-id.ParamsDetails.json
new file mode 100644
index 000000000..97d758b98
--- /dev/null
+++ b/docs/api/delete-v-1-company-benefits-company-benefit-id.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"schema":{"type":"string"},"name":"company_benefit_id","in":"path","required":true,"description":"The UUID of the company benefit"},{"name":"X-Gusto-API-Version","in":"header","required":false,"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.","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"}}]}
\ No newline at end of file
diff --git a/docs/api/delete-v-1-company-benefits-company-benefit-id.RequestSchema.json b/docs/api/delete-v-1-company-benefits-company-benefit-id.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/delete-v-1-company-benefits-company-benefit-id.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/delete-v-1-company-benefits-company-benefit-id.StatusCodes.json b/docs/api/delete-v-1-company-benefits-company-benefit-id.StatusCodes.json
new file mode 100644
index 000000000..97bcd2626
--- /dev/null
+++ b/docs/api/delete-v-1-company-benefits-company-benefit-id.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"204":{"description":"No content"},"404":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided UUID is valid.\n"},"422":{"description":"Unprocessable Entity \n \nThis 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.\n","content":{"application/json":{"schema":{"description":"Unprocessable Entity\n \nThis 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.\n","type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["error_key","category"],"properties":{"error_key":{"type":"string","description":"Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error."},"category":{"type":"string","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."},"message":{"type":"string","description":"Provides details about the error - generally this message can be surfaced to an end user."},"metadata":{"type":"object","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.","oneOf":[{"type":"object","description":"multiple entities","required":["entities"],"properties":{"entities":{"type":"array","items":{"type":"object","description":"single entity","additionalProperties":true,"properties":{"entity_type":{"type":"string","description":"Name of the entity that the error corresponds to."},"entity_uuid":{"type":"string","description":"Unique identifier for the entity."},"valid_from":{"type":["string","null"]},"valid_up_to":{"type":["string","null"]},"key":{"type":["string","null"]},"state":{"type":["string","null"]}},"title":"Metadata-With-One-Entity"}}},"title":"Metadata-With-Multiple-Entities"},{"type":"object","description":"single entity","additionalProperties":true,"properties":{"entity_type":{"type":"string","description":"Name of the entity that the error corresponds to."},"entity_uuid":{"type":"string","description":"Unique identifier for the entity."},"valid_from":{"type":["string","null"]},"valid_up_to":{"type":["string","null"]},"key":{"type":["string","null"]},"state":{"type":["string","null"]}},"title":"Metadata-With-One-Entity"}]},"errors":{"type":"array","description":"Will only exist if category is `nested_errors`. It is possible to have multiple levels of nested errors.","items":"circular(Entity-Error-Object)"}},"title":"Entity-Error-Object"}}},"x-examples":{"bank_account_delete_unfunded_payments":{"errors":[{"error_key":"base","category":"invalid_operation","message":"FundingMethod has unfunded payments"}]},"bank_account_verify_incorrect_deposits":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Your bank account cannot be verified. Please check the test deposit amounts."}]},"bank_account_verify_already_verified":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Your bank account has already been verified."}]},"bank_account_missing_routing":{"errors":[{"error_key":"routing_number","category":"invalid_attribute_value","message":"Routing number is required."}]},"payment_configs_missing_parameter":{"errors":[{"error_key":"base","category":"missing_parameter","message":"At least one parameter must be provided"}]},"payment_configs_invalid_fast_payment_limit":{"errors":[{"error_key":"fast_payment_limit","category":"invalid_attribute_value","message":"Fast payment limit should be a number"}]},"pay_periods_invalid_end_date":{"errors":[{"error_key":"end_date","category":"invalid_parameter","message":"End date cannot be more than 3 months in future"}]},"company_industry_selection_naics_code_required":{"errors":[{"error_key":"naics_code","category":"invalid_attribute_value","message":"Naics code is required."}]},"company_industry_selection_naics_code_invalid":{"errors":[{"error_key":"naics_code","category":"invalid_attribute_value","message":"Naics code must be equal to 6 digits."}]},"company_industry_selection_sics_codes_invalid":{"errors":[{"error_key":"sic_codes","category":"invalid_attribute_value","message":"Sic codes must be equal to 4 digits"}]},"time_off_policy_name_required":{"errors":[{"error_key":"name","category":"invalid_attribute_value","message":"Name is required."}]},"time_off_policy_unlimited_invalid_accrual_rate":{"errors":[{"error_key":"accrual_rate","category":"invalid_operation","message":"Accrual rate must be blank for unlimited policies."}]},"time_off_policy_pending_requests":{"errors":[{"error_key":"time_off_policy","category":"invalid_operation","message":"Cannot deactivate policy with pending time off requests."}]},"time_off_policy_employees_required":{"errors":[{"error_key":"employees","category":"invalid_attribute_value","message":"Employees are required."}]},"time_off_policy_unlimited_balance_update":{"errors":[{"error_key":"base","category":"invalid_attribute_value","message":"Can not adjust balances for unlimited policies."}]},"holiday_pay_policy_already_exists":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Company already has a holiday pay policy."}]},"holiday_pay_policy_not_exists":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Company does not have a holiday pay policy, please create one"}]},"holiday_pay_policy_invalid_employees":{"errors":[{"error_key":"employees","category":"invalid_attribute_value","message":"Invalid employee uuids provided."}]},"onboarded_employee":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Cannot delete onboarded employee"}]},"invalid_attribute":{"errors":[{"error_key":"base","category":"invalid_operation","message":"There is an error in the request body."}]},"company_cannot_enable_contractor_only":{"errors":[{"error_key":"contractor_only","category":"invalid_attribute_value","message":"Contractor only cannot be enabled for existing companies."}]},"company_missing_parameter":{"errors":[{"error_key":"base","category":"missing_parameter","message":"contractor_only is required."}]},"starting_after_uuid_invalid":{"errors":[{"error_key":"starting_after_uuid","category":"invalid_attribute_value","message":"Parameter 'starting_after_uuid' does not correspond to a valid event."}]},"resource_uuid_invalid":{"errors":[{"error_key":"resource_uuid","category":"invalid_attribute_value","message":"Parameter 'resource_uuid' does not correspond to a valid resource."}]},"payroll_gross_up_invalid_net_pay":{"errors":[{"error_key":"net_pay","category":"invalid_attribute_value","message":"Net pay must be a number."}]},"payroll_accruing_hours_invalid":{"errors":[{"error_key":"base","category":"invalid_attribute_value","message":"Hours cannot be negative."}]},"payroll_cannot_cancel":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Payroll cannot be canceled."}]},"frozen_payroll":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This payroll has already been processed. Its data cannot be updated or altered."}]},"frozen_payroll_processing":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This payroll is being processed and cannot be updated at this time."}]},"unmodifiable_payroll_type":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This type of payroll cannot be modified or processed. It is reserved for system processes."}]},"invalid_employee_uuids_format":{"errors":[{"error_key":"employee_uuids","category":"invalid_attribute_value","message":"Parameter employee_uuids must be an array."}]},"maximum_employee_uuids_surpassed":{"errors":[{"error_key":"employee_uuids","category":"invalid_attribute_value","message":"Exceeded maximum of 100 for lookup."}]},"invalid_employee_uuid":{"errors":[{"error_key":"employee_uuids","category":"invalid_attribute_value","message":"Invalid Employee UUID(s).","metadata":{"entities":[{"entity_type":"Employee","entity_uuid":"invalid-uuid-123"}]}}]},"payroll_blocker_missing_bank_info":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must have a bank account in order to run payroll.","metadata":{"key":"missing_bank_info"}}]},"payroll_blocker_missing_employee_setup":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must add employees in order to run payroll.","metadata":{"key":"missing_employee_setup"}}]},"payroll_blocker_missing_federal_tax_setup":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must complete federal tax setup in order to run payroll.","metadata":{"key":"missing_federal_tax_setup"}}]},"payroll_blocker_missing_bank_verification":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company bank account must be verified in order to run payroll.","metadata":{"key":"missing_bank_verification"}}]},"payroll_blocker_suspended":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company is suspended and cannot run payroll.","metadata":{"key":"suspended"}}]},"submission_blocker_missing_selection":{"errors":[{"error_key":"submission_blockers","category":"invalid_attribute_value","message":"Submission blockers selections required"}]},"submission_blocker_invalid_option":{"errors":[{"error_key":"submission_blockers","category":"nested_errors","metadata":{"blocker_type":"fast_ach_threshold_exceeded"},"errors":[{"error_key":"selected_option","category":"invalid_attribute_value","message":"Selection is not available to resolve Fast ACH Threshold Exceeded. Please choose one of Wire In, Move To Four Day"}]}]},"invalid_version":{"errors":[{"error_key":"base","category":"invalid_resource_version","message":"You are attempting to update a resource using an out-of-date version."}]},"signatory_email_required":{"errors":[{"error_key":"email","category":"invalid_attribute_value","message":"Email is required"}]},"signatory_company_already_has_signatory":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Cannot have more than one signatory in a company. Please remove the existing signatory before adding a new one."}]},"mixed_disbursement_errors":{"errors":[{"error_key":"disbursements","category":"nested_errors","metadata":{"contractor_payment_uuid":"invalid-uuid-1"},"errors":[{"error_key":"contractor_payment_uuid","category":"not_found","message":"Disbursement not found."}]},{"error_key":"disbursements","category":"nested_errors","metadata":{"contractor_payment_uuid":"d0dfa222-ad08-4ea7-a06a-717688c3b179"},"errors":[{"error_key":"payment_method","category":"invalid_attribute_value","message":"Payment method must be one of: Direct Deposit, Check."},{"error_key":"payment_status","category":"invalid_attribute_value","message":"Payment status is not valid for payment method 'InvalidMethod'."}]}]},"not_found":{"errors":[{"error_key":"request","category":"not_found","message":"The requested resource was not found."}]},"finish_onboarding_incomplete":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Company is not ready to exit onboarding."}]},"company_location_validation":{"errors":[{"error_key":"street_1","category":"invalid_attribute_value","message":"Must include a street address"},{"error_key":"city","category":"invalid_attribute_value","message":"Must include a city"},{"error_key":"state","category":"invalid_attribute_value","message":"State is in the wrong format"},{"error_key":"zip","category":"invalid_attribute_value","message":"Please enter a valid zip code (e.g. 12345)."},{"error_key":"phone_number","category":"invalid_attribute_value","message":"Phone number must be 10 digits"}]},"conflict":{"errors":[{"error_key":"request","category":"duplicate_operation","message":"A resource with these attributes already exists."}]},"invalid_parameter":{"errors":[{"error_key":"request","category":"invalid_parameter","message":"The provided parameter is invalid or missing."}]},"flow_invalid_entity":{"errors":[{"error_key":"entity_type","category":"invalid_attribute_value","message":"Invalid flow entity"},{"error_key":"entity_uuid","category":"invalid_attribute_value","message":"Invalid flow entity"}]},"flow_nested_options_errors":{"errors":[{"error_key":"options","category":"nested_errors","metadata":{"flow_type":"company_forms"},"errors":[{"error_key":"form_types","category":"invalid_attribute_value","message":"Supplied value 'invalid' contains no permitted values"}]}]},"basic":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must complete all onboarding requirements in order to run payroll.","metadata":{"key":"needs_onboarding"}}]},"contractor_payment_invalid_wage":{"errors":[{"error_key":"wage","category":"invalid_attribute_value","message":"Wage must be greater than or equal to 0."}]},"contractor_payment_cannot_cancel":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Payment has already been processed and cannot be cancelled. Contact support directly."}]},"time_off_request_cannot_delete":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This time off request cannot be deleted."}]},"resource":{"errors":[{"error_key":"first_name","category":"invalid_attribute_value","message":"First name is required"},{"error_key":"date_of_birth","category":"invalid_attribute_value","message":"Date of birth is not a valid date"}]},"nested":{"errors":[{"error_key":"contractor_payments","category":"nested_errors","metadata":{"contractor_uuid":"72ae4617-daa9-4ed7-85e0-18ed5d0ee835"},"errors":[{"error_key":"hours","category":"invalid_attribute_value","message":"Ella Fitzgerald is paid fixed wage and hours cannot be set on a contractor payment"}]},{"error_key":"contractor_payments","category":"nested_errors","metadata":{"contractor_uuid":"2d7bf62c-babf-4a12-8292-340e2d9cab28"},"errors":[{"error_key":"wage","category":"invalid_attribute_value","message":"Isaiah Berlin is paid hourly and wage cannot be set on a contractor payment"}]}]},"compensation_invalid_rate":{"errors":[{"error_key":"rate","category":"invalid_attribute_value","message":"Rate is not a valid number"}]},"compensation_invalid_payment_unit":{"errors":[{"error_key":"payment_unit","category":"invalid_attribute_value","message":"Payment unit must be one of Hour, Week, Month, or Year"}]},"compensation_already_processed":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Compensation has already been processed on payroll."}]}},"title":"Unprocessable-Entity-Error-Object"},"examples":{"Basic":{"value":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must complete all onboarding requirements in order to run payroll.","metadata":{"key":"needs_onboarding"}}]}},"Resource":{"value":{"errors":[{"error_key":"first_name","category":"invalid_attribute_value","message":"First name is required"},{"error_key":"date_of_birth","category":"invalid_attribute_value","message":"Date of birth is not a valid date"}]}},"Nested":{"value":{"errors":[{"error_key":"contractor_payments","category":"nested_errors","metadata":{"contractor_uuid":"72ae4617-daa9-4ed7-85e0-18ed5d0ee835"},"errors":[{"error_key":"hours","category":"invalid_attribute_value","message":"Ella Fitzgerald is paid fixed wage and hours cannot be set on a contractor payment"}]},{"error_key":"contractor_payments","category":"nested_errors","metadata":{"contractor_uuid":"2d7bf62c-babf-4a12-8292-340e2d9cab28"},"errors":[{"error_key":"wage","category":"invalid_attribute_value","message":"Isaiah Berlin is paid hourly and wage cannot be set on a contractor payment"}]}]}}}}}}}}
\ No newline at end of file
diff --git a/docs/api/delete-v-1-company-benefits-company-benefit-id.api.mdx b/docs/api/delete-v-1-company-benefits-company-benefit-id.api.mdx
new file mode 100644
index 000000000..8ee91fcb8
--- /dev/null
+++ b/docs/api/delete-v-1-company-benefits-company-benefit-id.api.mdx
@@ -0,0 +1,76 @@
+---
+id: delete-v-1-company-benefits-company-benefit-id
+title: "Delete a company benefit"
+description: "The following must be true in order to delete a company benefit"
+sidebar_label: "Delete a company benefit"
+hide_title: true
+hide_table_of_contents: true
+api: eJztXFtv3LiS/itc7YMToOVbnMv4aTOxs8fAZsaYJJs9cAKZLVZ3cyKRGpJqu8fwf19UkZTUanXb7dgP5yADDAK3yOLHYt1YLPImuU6ntXU6lcrB1HAntUrdooLk+CKBcgxCgEhGCa+qbhObfBsljk8tNnuny4qrBfsVFEyko2+6At/yTCTHiYACHKTzgzT3bbNxaNv/IZM4mgCbG1lh/+Q4+TQDNtFFoa+kmrKyto6NgTlTA5OKaSPAMKeZH4RxFkiyQPKrYixln2ZggHEDTGkGZVXoBUBsYhm3VueSOxDsSroZczO4B52KL4wuCiYdlNvRiD8waZnSjpVc8SkINl4wzs65cQoM0wb//m9cH/YMF6WZ/M7ptQOjeLHz/Kv6qr7MQNFwvKoKmRPj2Yxb+u2yz/PjKyMdHEeOI+GskKV0IC6Z4I4zm+sKRisUc66YVsUisro3OcsmiDhMDMkiAO6IWxWYUjrkDTbqUd7FSdCgx+vgXiajpOKGl+DAoNjdJDafQcmT45vEC2xinZFqmtyOEsVL/GFQuCTKVMXdLBklBv6qpQGRHKM4DQne589nJ0xPhhYzuR3dxJH+L6VlSt+en6X/C8YigTDUDLgAszTYhBd2ZbQTnFkpFfhlE9xBOuYWBHt7fsbmnuiKkC10bahBzotil51NmNIKUKwqo+dSgBj5Nh1271h2UUoly7rs0v72bOZcZY/39oTO7S7Zhd1cl3vRDqRB3un7Hq9kGnpKNf3PQDDt/PwcYdQWxG4yWrtaowRUXaIdOdw/fJnuv0oPXqIFETDhdeGS4+7vt7ffkI+20sqCRWKH+0f4zzIrf9Ms18qBwjVKjoabOPZe10ow1MmvCtcaFwgsstaA1bXJgQkNXkHhWlq3yz7w78BsbYDWKLLYS4m0bM4LKXa/Khr28HB12M+qMjoHa/m4AHaqnHSLBoG0rOQLNuNVBYpdRaUea7FAEaRlDBhpflwqy8AYbSyzdT5j3LJLqQhExp0zclw7yOa8qOFyxILeRQoTLgvLRA1oPLlqeza2+3KXfQQ/04tTP8w77mCqjQS7pbQQzDRvuj9n01oKIGtQagNMgENAyLxRElfv+CbpyO3enxaZ2NX8u7n7k7l95gb90+M/IXdLduki8RNG/asMQnXSq1n4vdVebgxfoIlD19f5fT3V7Dtgh4BysWYMajVgJJYX+mMFuZxIsLiQQRmpO9N5Xhu7yz4tKokmccEcLv13WDApQDnfi/xPXMO9xq8wAwWZVqdbkruozA3qLaAhBfLaehIokeePpKL1CFLGpkbXlVRTy7gS5GvHQNYT0YxrWQiWoxyUof2MK1FgRCSVl95OfEaOoBlIWnapyLBlfh0vvW/3a8WuZFFEkWec+ZbsMjRlYZEW3t+AN1n+I7GmRH2bwt2cOY/zDdLI+FjXrrN2KZuCAtOuWiAdmWFrM+G5ZwhXDJRA/piAwnGMXYZEcRnGu6jcBgqYc+V8zON0FJBF0OTgAqRipNPofclsBIs0LmCXvdeGwTUvqwLjpQ4JwkesuvT/Upx1SWsbf6lrKS49+8etM0FnqRX8PqEgZ/NcyrpwsirAj4V61FO8+POqssUvW6j08thWqmkcGbtxISR+4sV5ZyQfVw2M7Rlyt9T8xkuIAVjgKAWVrdjk2viQQFjmNElDh8F3j/BZyb9wLxHNg2lCVE+GKHrrPTG6bAletBRVXRTJt6ZdXWVOb264ZOeGGljHHWxqcjtKnHQFzuxDkP70i3Sz9HcFqXd+ye36Vh+C7PimuDQYz/5c83/9NUdKax32Mh++oPGhPR0FuExudBu77Ix2rJW2VmKI5TSb8TnuS4MdKmAOhcW1C24kOorGrCS5NHldcPPMw00p+El/J4F7nnRnONDAC/R1GmwuTXDM1feM57mulcv81jSr1aRWAkRW8UUJyi0FMRdLsUaCm6xuYHKcrARrScfNJe9rJaSafgA304K22XE01oxGa7AEbA5GThaZVCS6OSKttJWPiuyfGAbgqCyMip4Tdy9jYDS+BLHLzgvgFlg+g/y7D1IwYg1wGC+xI7r2dVPghQEuFlmk+KQTQPaGAdkYQLXzGABYSosWKjO6dqg264GFFpmqyzFtzgcg9oL8JaB/+P7M90ediG434AqSkOVaTeTUNtCaWHMrrq327oJ56xguqWO482+D2ZgsioHFMLA42wm3LmqLTwdtQDjQeGsWvkfEgQYjGszOdF0IxMwDZxvMWQVGatHiBSUyEazlGpRNk0Fsw7w8VYJSLx3NoR2Um3HFXrBSKzezGBNOalcb8PhinkkqUVtnFpmFAnKU7kxxmdss1wKyNjBbi7htvT0/f8O+DPsOiOP9EIZhnh5gFE34q+YFepFXTMipbMzOBrg2ArD3gGtl7ttuj/ajzAmrXQV7FMB6rE6WkOnJJKt0IfNFhhnB+611+SAmlkPr2wdRq5DRbfSF57mpeZGZzTqz1GwLy/3W92PYr+HYuEBTjpFVg4cRQAl2DfAKyLlmIZGyyTv2um6D9p1XbgE8d3KOkD0Nv8cNGBgOwPRkErM66zDH4wR7n2VvGm+/9qexK2XU7y0BY15wlUNWV3fYy/XeehOqd1xRhpSLP2nZ/Wh287LPdCEFWnX83wOOYQUFoo8ZFcXzqRhGUEjBAgL0QGHx10NT2j0drCbFTJH0ELARq0LIZgBlVStYC7Vxj42YPYkonvk27UkabrtsJ4dB+LQaa24wDI/tHpN/UYfpLKoZqoHkIaxM5hER+LNAaSnZQ9tSqZaywJhc7nk0H1ZkoDB/hEGYMzx32mS4CduArd9yezVtCPj9XhvfeCz+YI6kHG2fx9sqbMT/lHFsb44Dbs46bihu5xMHhvb694kCVnttz7/zJq7eGaC306pxm5qgPCULijIH5cIsYmrxvviX2v8Q8iVKd2KOrdstDR45ZFOjrcV0RxxcAW0GNsU6ocX24Q7QHqGJKOK+oAeJohZckZmuzX0Cw4e5un8g9Y7mKJhyJ+d9BgUdz9EPFo9ob85DuUELwA/RqMfE6L9BZQHHo1o6zPqE4Ve25OHQDXMLZ876dHqL0YcdAk/IeOHArEGbBSqb9+0/BFxaNgY0bg3geNTSg0qpRmkpAAxga1VqISeSzHaEHLOZjwk2nhhVK4vtAXhOLrHcG0oLZh6suF1YB2XTKNrwfmxAVsBmE21Kvmm3v9z+RwzQMqVWqxWj9GTAWfJrLCXo47S1qTjO+Qmhnl7nABhFBAy4Egf7+8TVQuvvdbWJl08ILAZccQ9AJQfP7PPdZPnsqz3Xuegl3ZvtQ9LLlcfxU/wzPTh8gTNcMmjjQuffwTTOn5JuUk30VsLfozYYDJNEhEB4KQ/YrfQytYrq0Z++H3sV5+b5NItjwdXV00yKizY0tQ+bTg/m5jlNQOBRaub49VNOC+NCCsDDeMzxa0bjPWyOq7DvIYo+J+yLRB59mktiGC1WzEL/gFwugR6epK0t5iK2TLHfZ1ISi1oC8a4TvHMKLSQP2dZjmpVWK0vT5Ow2heYr3R+SqmuIsEiENYO3e4hkHeDWK/8o2qXjsh7/4mjBGlMKneezzM0M2JkuRAbB+SSd87s+ApoWNFi351XkS6w85XMuCx4O8zDiL+bAKDf/9t0/2KcIjkXP2Dk/0tpSMgKd5BdpgJ2pEfug58A+aSyuM+yE03Fk12GG2sAHhU3N9mXelFgunR1RXow7B2VFm1inQ0jHeFvPUaNwYsiha5fqSUrfA8G4zZRTxZ02mNrjsrhfWo/L4iEpPS6L7ka3DyDuu2N2bMZt1nx9/GyKP81tDjxwcZvRGJUHBUCNGBgoccXp6DwmD9ouY5ggMawTQKYzBVdINAZ68hpEJqQd18YCHSa159ZrJtZtvYX2dXIL8dxqMPrZoHvrSCxj0C6bYF3pEndPOqBJ66iJ58ITT0/siwk/PDxMudh/kx4Bf53y/Vc8fX3w+tWbN/mL8cHrXzZMOlIr6bT7IbG/P+Dz/Rv/6a3GMTuReBbOTvzh84i9w0Pp3aTPlYgC6yPqB+1APArfP5o+H1FjaF8to9wJ0bY/4t/ZjTasXdxNyRrK/d1HKtbUHF9x25eRZCKVtLMsZDnRu2IhgQ+9niAnHRjk9/hOo2Y71g7eywkW2kcxGZG+KwqzzgC47GD7VfyAwiNVXtQCLbonhLbFgLUrMpP7EqUfG4OI9Cn7Kp3tXS92Q9aGLPGV0WrKwu67P8bfsnqAmHuTDAr32jGL97es/KHrM9id7rKDwxdHL58PqNhMK3hwPcQ59o7VEFHJD/aXDkqx4qCQ+aZMw6DyiNpXgMO6o8eO6oR7N7ZT3tsmq/wRTm8Df59E9iCszXUEn7rXA9qaDFp9vy5Ym+0j5ajjhb7qlDdQLdem4oZ2b//gbAIOGav5+gLRzRE8zgDNJIMn8zGsvdvnh4b3d4c0Sgi0o5VCRbMbPB1+pz4P2oFgTTAIRp/YTuiz094kwNtizRUoamWjVxlzK/Mn3p1zKvOL9jtGmxRkbLeFVQDCdvxQ2AYOxB+Rb1ehOHzN7Ojz1gz/gmXh0c5M6VjUhJDVtIUa+42jWkH3hDl6iiTWJ8l7OWePAHP4jCrTc8dsXVXaOCYoOCoW/RP+YI7iHPwJ6KPnoXvFDx3IfkDRO83aVC4mjXXZwwpe3mNfpnplLyvWSpB/mGRjaehm35ajnNC5+oRR92ZrHDwolU34AJBszv2OaZta0IcE8SF4f33I4ejVwetUcP5LegTidfrmJeynB29AvBT7AG9evNxg0ug07AGb0qLg7L10f08xFSeo4pejMcftGkOFJRme9U7DLGCMSFvE5qg5MGFgo/PInDoUr8eTV4d5OubjSXrEDw7TN4e/HKYvjvbhUPyS8/Hhmw2cepgVOrNc8hn7FUwhVcMm5EuxIBZdhdsr9+NQjKlBWR9PN3mPzXU762u1Npawhmi0K+ndostBJM3mUm2sD11q9uDdGvbu7RgZHsGO2BeA75hqUm5GV+/+CXwIdUyaNLb3kbdKcaBN1l53HOrtUgH/0m3FdLDYfZR0C91/jYGCZ9m/csRwO0r+6PiNuyb0b+JAbkfJb40HuWvOP13JT1fyA67E/4d3ZWwF/Dtwu0hRCVI9B2OkgOZdjmS5Ed1DbfdNzaseaIscKEs7MZy0n+7aB0RGUcLveEgEVzOSWge1oRUhD3fy0NvG/Sng6wEhkdmZPL0FcZzszQ/2+m9P7N2sPiFxi48ZYK1FWPvaFKgf4b42r6S/rp0KKOnO9sqdqxModY/nnl7qE7b4Gee3hvAgzXNDydl1NCv8jLO3kNeGEgsXN9Hwv83RCb2tkQsX37qtPuI9e+97Bto2V8sQYnzhAf8eAzfkY/oXb4lESnfEGK/dDBMD8QB0lHykqpUfGcFTWDMA5Xx8yUL0wP5plbfnZygz8Vyq+97EKME3Oezvk49g5jKHznq0d/LpGvMeNdwTODQGDCn9jedLNnRduXoHRa5LOnYjHDuWnQY9YbHSC1/nEDqvUa1pGv8RHkfgPo0WXh85iaOyP/ACe8iV+CMpFKjw9b9a+UFuVNq6kqslOsNP6PSx37QPNPx8nefn6zz+dZ6gqg6u3V5VcEk6TTbsJpjYi2ROWf8eiWSUHA+81PMN69utw243NxjRfjbF7S3+/FcN6FcvvqGlN1SSR/ZMSAql1zyw0xXaZ3+EMPA5u+uRnzUTi7dq1aLjb5JwxXfo4SFfsO/fAtoO7L/5w0CD7PVsHH5VqeF2GwSg06hc59vKqzFLrv/k9H9OP50mt7f/Dwy50xU=
+sidebar_class_name: "delete api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+The following must be true in order to delete a company benefit
+ - There are no employee benefits associated with the company benefit
+ - There are no payroll items associated with the company benefit
+ - The benefit is not managed by a Partner or by Gusto (type must be 'External')
+
+When the application has the `company_benefits:write:benefit_type_limited` data scope, the application can only delete company benefits for benefit types that are permitted for the application.
+
+scope: `company_benefits:write`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/delete-v-1-compensations-compensation-id.ParamsDetails.json b/docs/api/delete-v-1-compensations-compensation-id.ParamsDetails.json
new file mode 100644
index 000000000..0b8396479
--- /dev/null
+++ b/docs/api/delete-v-1-compensations-compensation-id.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"X-Gusto-API-Version","in":"header","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"},"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."},{"name":"compensation_id","in":"path","description":"The UUID of the compensation","required":true,"schema":{"type":"string"}}]}
\ No newline at end of file
diff --git a/docs/api/delete-v-1-compensations-compensation-id.RequestSchema.json b/docs/api/delete-v-1-compensations-compensation-id.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/delete-v-1-compensations-compensation-id.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/delete-v-1-compensations-compensation-id.StatusCodes.json b/docs/api/delete-v-1-compensations-compensation-id.StatusCodes.json
new file mode 100644
index 000000000..2c4e3df8c
--- /dev/null
+++ b/docs/api/delete-v-1-compensations-compensation-id.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"204":{"description":"No Content"},"404":{"description":"Not Found\n\nThe requested resource does not exist. Make sure the provided UUID is valid.\n","content":{"application/json":{"schema":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided ID/UUID is valid.","type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["error_key","category"],"properties":{"error_key":{"type":"string","description":"Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error."},"category":{"type":"string","description":"Specifies the type of error. The category provides error groupings and can be used to build custom error handling in your integration."},"message":{"type":"string","description":"Provides details about the error - generally this message can be surfaced to an end user."}}}}},"x-examples":{"not_found":{"errors":[{"error_key":"request","category":"not_found","message":"The requested resource was not found."}]}},"title":"Not-Found-Error-Object"}}}},"422":{"description":"Unprocessable Entity\n\nThis 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.\n","content":{"application/json":{"schema":{"description":"Unprocessable Entity\n \nThis 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.\n","type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["error_key","category"],"properties":{"error_key":{"type":"string","description":"Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error."},"category":{"type":"string","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."},"message":{"type":"string","description":"Provides details about the error - generally this message can be surfaced to an end user."},"metadata":{"type":"object","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.","oneOf":[{"type":"object","description":"multiple entities","required":["entities"],"properties":{"entities":{"type":"array","items":{"type":"object","description":"single entity","additionalProperties":true,"properties":{"entity_type":{"type":"string","description":"Name of the entity that the error corresponds to."},"entity_uuid":{"type":"string","description":"Unique identifier for the entity."},"valid_from":{"type":["string","null"]},"valid_up_to":{"type":["string","null"]},"key":{"type":["string","null"]},"state":{"type":["string","null"]}},"title":"Metadata-With-One-Entity"}}},"title":"Metadata-With-Multiple-Entities"},{"type":"object","description":"single entity","additionalProperties":true,"properties":{"entity_type":{"type":"string","description":"Name of the entity that the error corresponds to."},"entity_uuid":{"type":"string","description":"Unique identifier for the entity."},"valid_from":{"type":["string","null"]},"valid_up_to":{"type":["string","null"]},"key":{"type":["string","null"]},"state":{"type":["string","null"]}},"title":"Metadata-With-One-Entity"}]},"errors":{"type":"array","description":"Will only exist if category is `nested_errors`. It is possible to have multiple levels of nested errors.","items":"circular(Entity-Error-Object)"}},"title":"Entity-Error-Object"}}},"x-examples":{"bank_account_delete_unfunded_payments":{"errors":[{"error_key":"base","category":"invalid_operation","message":"FundingMethod has unfunded payments"}]},"bank_account_verify_incorrect_deposits":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Your bank account cannot be verified. Please check the test deposit amounts."}]},"bank_account_verify_already_verified":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Your bank account has already been verified."}]},"bank_account_missing_routing":{"errors":[{"error_key":"routing_number","category":"invalid_attribute_value","message":"Routing number is required."}]},"payment_configs_missing_parameter":{"errors":[{"error_key":"base","category":"missing_parameter","message":"At least one parameter must be provided"}]},"payment_configs_invalid_fast_payment_limit":{"errors":[{"error_key":"fast_payment_limit","category":"invalid_attribute_value","message":"Fast payment limit should be a number"}]},"pay_periods_invalid_end_date":{"errors":[{"error_key":"end_date","category":"invalid_parameter","message":"End date cannot be more than 3 months in future"}]},"company_industry_selection_naics_code_required":{"errors":[{"error_key":"naics_code","category":"invalid_attribute_value","message":"Naics code is required."}]},"company_industry_selection_naics_code_invalid":{"errors":[{"error_key":"naics_code","category":"invalid_attribute_value","message":"Naics code must be equal to 6 digits."}]},"company_industry_selection_sics_codes_invalid":{"errors":[{"error_key":"sic_codes","category":"invalid_attribute_value","message":"Sic codes must be equal to 4 digits"}]},"time_off_policy_name_required":{"errors":[{"error_key":"name","category":"invalid_attribute_value","message":"Name is required."}]},"time_off_policy_unlimited_invalid_accrual_rate":{"errors":[{"error_key":"accrual_rate","category":"invalid_operation","message":"Accrual rate must be blank for unlimited policies."}]},"time_off_policy_pending_requests":{"errors":[{"error_key":"time_off_policy","category":"invalid_operation","message":"Cannot deactivate policy with pending time off requests."}]},"time_off_policy_employees_required":{"errors":[{"error_key":"employees","category":"invalid_attribute_value","message":"Employees are required."}]},"time_off_policy_unlimited_balance_update":{"errors":[{"error_key":"base","category":"invalid_attribute_value","message":"Can not adjust balances for unlimited policies."}]},"holiday_pay_policy_already_exists":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Company already has a holiday pay policy."}]},"holiday_pay_policy_not_exists":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Company does not have a holiday pay policy, please create one"}]},"holiday_pay_policy_invalid_employees":{"errors":[{"error_key":"employees","category":"invalid_attribute_value","message":"Invalid employee uuids provided."}]},"onboarded_employee":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Cannot delete onboarded employee"}]},"invalid_attribute":{"errors":[{"error_key":"base","category":"invalid_operation","message":"There is an error in the request body."}]},"company_cannot_enable_contractor_only":{"errors":[{"error_key":"contractor_only","category":"invalid_attribute_value","message":"Contractor only cannot be enabled for existing companies."}]},"company_missing_parameter":{"errors":[{"error_key":"base","category":"missing_parameter","message":"contractor_only is required."}]},"starting_after_uuid_invalid":{"errors":[{"error_key":"starting_after_uuid","category":"invalid_attribute_value","message":"Parameter 'starting_after_uuid' does not correspond to a valid event."}]},"resource_uuid_invalid":{"errors":[{"error_key":"resource_uuid","category":"invalid_attribute_value","message":"Parameter 'resource_uuid' does not correspond to a valid resource."}]},"payroll_gross_up_invalid_net_pay":{"errors":[{"error_key":"net_pay","category":"invalid_attribute_value","message":"Net pay must be a number."}]},"payroll_accruing_hours_invalid":{"errors":[{"error_key":"base","category":"invalid_attribute_value","message":"Hours cannot be negative."}]},"payroll_cannot_cancel":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Payroll cannot be canceled."}]},"frozen_payroll":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This payroll has already been processed. Its data cannot be updated or altered."}]},"frozen_payroll_processing":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This payroll is being processed and cannot be updated at this time."}]},"unmodifiable_payroll_type":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This type of payroll cannot be modified or processed. It is reserved for system processes."}]},"invalid_employee_uuids_format":{"errors":[{"error_key":"employee_uuids","category":"invalid_attribute_value","message":"Parameter employee_uuids must be an array."}]},"maximum_employee_uuids_surpassed":{"errors":[{"error_key":"employee_uuids","category":"invalid_attribute_value","message":"Exceeded maximum of 100 for lookup."}]},"invalid_employee_uuid":{"errors":[{"error_key":"employee_uuids","category":"invalid_attribute_value","message":"Invalid Employee UUID(s).","metadata":{"entities":[{"entity_type":"Employee","entity_uuid":"invalid-uuid-123"}]}}]},"payroll_blocker_missing_bank_info":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must have a bank account in order to run payroll.","metadata":{"key":"missing_bank_info"}}]},"payroll_blocker_missing_employee_setup":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must add employees in order to run payroll.","metadata":{"key":"missing_employee_setup"}}]},"payroll_blocker_missing_federal_tax_setup":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must complete federal tax setup in order to run payroll.","metadata":{"key":"missing_federal_tax_setup"}}]},"payroll_blocker_missing_bank_verification":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company bank account must be verified in order to run payroll.","metadata":{"key":"missing_bank_verification"}}]},"payroll_blocker_suspended":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company is suspended and cannot run payroll.","metadata":{"key":"suspended"}}]},"submission_blocker_missing_selection":{"errors":[{"error_key":"submission_blockers","category":"invalid_attribute_value","message":"Submission blockers selections required"}]},"submission_blocker_invalid_option":{"errors":[{"error_key":"submission_blockers","category":"nested_errors","metadata":{"blocker_type":"fast_ach_threshold_exceeded"},"errors":[{"error_key":"selected_option","category":"invalid_attribute_value","message":"Selection is not available to resolve Fast ACH Threshold Exceeded. Please choose one of Wire In, Move To Four Day"}]}]},"invalid_version":{"errors":[{"error_key":"base","category":"invalid_resource_version","message":"You are attempting to update a resource using an out-of-date version."}]},"signatory_email_required":{"errors":[{"error_key":"email","category":"invalid_attribute_value","message":"Email is required"}]},"signatory_company_already_has_signatory":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Cannot have more than one signatory in a company. Please remove the existing signatory before adding a new one."}]},"mixed_disbursement_errors":{"errors":[{"error_key":"disbursements","category":"nested_errors","metadata":{"contractor_payment_uuid":"invalid-uuid-1"},"errors":[{"error_key":"contractor_payment_uuid","category":"not_found","message":"Disbursement not found."}]},{"error_key":"disbursements","category":"nested_errors","metadata":{"contractor_payment_uuid":"d0dfa222-ad08-4ea7-a06a-717688c3b179"},"errors":[{"error_key":"payment_method","category":"invalid_attribute_value","message":"Payment method must be one of: Direct Deposit, Check."},{"error_key":"payment_status","category":"invalid_attribute_value","message":"Payment status is not valid for payment method 'InvalidMethod'."}]}]},"not_found":{"errors":[{"error_key":"request","category":"not_found","message":"The requested resource was not found."}]},"finish_onboarding_incomplete":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Company is not ready to exit onboarding."}]},"company_location_validation":{"errors":[{"error_key":"street_1","category":"invalid_attribute_value","message":"Must include a street address"},{"error_key":"city","category":"invalid_attribute_value","message":"Must include a city"},{"error_key":"state","category":"invalid_attribute_value","message":"State is in the wrong format"},{"error_key":"zip","category":"invalid_attribute_value","message":"Please enter a valid zip code (e.g. 12345)."},{"error_key":"phone_number","category":"invalid_attribute_value","message":"Phone number must be 10 digits"}]},"conflict":{"errors":[{"error_key":"request","category":"duplicate_operation","message":"A resource with these attributes already exists."}]},"invalid_parameter":{"errors":[{"error_key":"request","category":"invalid_parameter","message":"The provided parameter is invalid or missing."}]},"flow_invalid_entity":{"errors":[{"error_key":"entity_type","category":"invalid_attribute_value","message":"Invalid flow entity"},{"error_key":"entity_uuid","category":"invalid_attribute_value","message":"Invalid flow entity"}]},"flow_nested_options_errors":{"errors":[{"error_key":"options","category":"nested_errors","metadata":{"flow_type":"company_forms"},"errors":[{"error_key":"form_types","category":"invalid_attribute_value","message":"Supplied value 'invalid' contains no permitted values"}]}]},"basic":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must complete all onboarding requirements in order to run payroll.","metadata":{"key":"needs_onboarding"}}]},"contractor_payment_invalid_wage":{"errors":[{"error_key":"wage","category":"invalid_attribute_value","message":"Wage must be greater than or equal to 0."}]},"contractor_payment_cannot_cancel":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Payment has already been processed and cannot be cancelled. Contact support directly."}]},"time_off_request_cannot_delete":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This time off request cannot be deleted."}]},"resource":{"errors":[{"error_key":"first_name","category":"invalid_attribute_value","message":"First name is required"},{"error_key":"date_of_birth","category":"invalid_attribute_value","message":"Date of birth is not a valid date"}]},"nested":{"errors":[{"error_key":"contractor_payments","category":"nested_errors","metadata":{"contractor_uuid":"72ae4617-daa9-4ed7-85e0-18ed5d0ee835"},"errors":[{"error_key":"hours","category":"invalid_attribute_value","message":"Ella Fitzgerald is paid fixed wage and hours cannot be set on a contractor payment"}]},{"error_key":"contractor_payments","category":"nested_errors","metadata":{"contractor_uuid":"2d7bf62c-babf-4a12-8292-340e2d9cab28"},"errors":[{"error_key":"wage","category":"invalid_attribute_value","message":"Isaiah Berlin is paid hourly and wage cannot be set on a contractor payment"}]}]},"compensation_invalid_rate":{"errors":[{"error_key":"rate","category":"invalid_attribute_value","message":"Rate is not a valid number"}]},"compensation_invalid_payment_unit":{"errors":[{"error_key":"payment_unit","category":"invalid_attribute_value","message":"Payment unit must be one of Hour, Week, Month, or Year"}]},"compensation_already_processed":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Compensation has already been processed on payroll."}]}},"title":"Unprocessable-Entity-Error-Object"}}}}}}
\ No newline at end of file
diff --git a/docs/api/delete-v-1-compensations-compensation-id.api.mdx b/docs/api/delete-v-1-compensations-compensation-id.api.mdx
new file mode 100644
index 000000000..caf65b47f
--- /dev/null
+++ b/docs/api/delete-v-1-compensations-compensation-id.api.mdx
@@ -0,0 +1,74 @@
+---
+id: delete-v-1-compensations-compensation-id
+title: "Delete a compensation"
+description: "Compensations contain information on how much is paid out for a job. Jobs may have many compensations, but only one that is active. The current compensation is the one with the most recent `effective_date`. This endpoint deletes a compensation for a job that hasn't been processed on payroll."
+sidebar_label: "Delete a compensation"
+hide_title: true
+hide_table_of_contents: true
+api: eJztXGlvHDeT/ivczgfbwPTosHxEn9ZryftqsU6M2F7vC9locZo1M7S6yTbJljQR9N8XVST7mkMaWcLuBgkQJJohiw+LdbM414mFvDbSLZLD0+vkrS4rrhZv8hysfVO7eXJ4+u3m2ygRYHMjKye1Sg5pGCjL8U/Lcq0cl4pJNdWmpA+ZVmyuL1lZ53MmLau4FEzXjk21YZx915Mx+w89sazkCzbnF8BKrhYs79IdsUntmFbFgmkFzM25Q1I8d/ICxuzTHFheGwPK9ebhGDcHmnMp3Zz+KLV1zECOg89gOgUikgnu4AxJSctAiUpL5ZiAAhxYxvtkG+QeyZxb9cSxCYBildHILxC47YovjC6K8Vf1Vf3yyy/sC0zmWp/bryplZ1BWhV4AZN/1JOuSHwuwzugFiLND9k4asOxyDmoIQlpmazqcaV0Ui4BV4Fo21xUcsrMeDw8vjXRwloySq3RWW6dTqRzMDH2bukUFyeFpAuUEhACRjBJeVd0hNvnWTjX2ks+SQ2dqGCUGbKWVBZscXif7uwf4n76Q/KbZW60cKJfcjJKD1UMce6drRRvAAzXwowbrQDADVtcmByY0WKa0Y3AlrRuz9/wcmK0N0MFWRl9IAYJ9/nxyhOy54IUU468qGSV5WP3wGrdVyJy2tPPd4trXic3nUPINoNhXxdjP4jo52ulDS0aJ53uiJ98hdwny8kctDQg6C2O0IbZXRldgnPQsDp8fXsfZ3Bi+SEaJdFB2P19PNTsHnJBzBzNtFmvWoFEtOeuMVLNkaAE+VpDLqfRiGvZM05nO89rYMfu0qGTOUUgdqtc5LJgUoJyfheO5c0ZOagc7FTe8BAeGGSg4stnpluQY5adBvQU0pIBjmZ4GSt5qBFLxkGxAPjO6rqSaWcaVYDlXbAKsth7NpJaFYDkqQhnGz7kShVQzJhVb6NqwjuIQ5hKs5TO4HfKHCESA47KwjE/QWLZMTdkMFJiWnYF0RGlrM+W5R8oV2jIEjpzDf1CF4YqXVeHPWWmXTVHCu4J12jv/JEh8V14OOxM7m0vWKMgl9/pBE8bJzTcE4qQrwCtZSkqWHuOi6e9eaj3ag/39ZbX8rIKZ5ZMC2LFy0i282ZDRjVQVKG82kXMTLRZ48nQ0AV/0VeHIyZrOGbfsTCpSz6wRyuyCFzWcjZg2RC5SmNIBiRoCr5uZqEl09mdj9hG8Spwe+2Xeeh5KsN+ezp2r7OHOjtC5HZNlHee63IlGOA0OhL7fIZhp3kx/xma1FEDeqNQGosT8lMVbzVpv+/5mbmTu31b7r2+12cm0XUhadqbIqGX+HM9GPrKks2KXsiia2JczP5KdhaEsHNLCB6FAShUU4/+Mc0AUjgvu+CpRHMb8QbkNFHDBMVDmjiPNICCLoMnB/EvFSKcxbPWhrLdIkwLG7J02LHikUY8E4SNWnfn/ZojqjM42flLXUpx59k/aSAsDK63g9ym5ss17KevCyaoAvxbq0UDx4sfLyha/2UKl+2tbqWZxZZzGhZD4FS8+dFbyQfaKtT1Dbpea33hJGkRi4jlKeUsrNrk2PogXljlN0tBh8O0rfFbyRw2teTBkN9v1iKK33lOjy5bgaUtR1UWRfGvG1VXm9OaBPTu3aoB13MGmIZ0o5H2Q/vSLdPP0dwWpd37JzfpR74Ps+KF4NDejv8/8r3DmSGmtw+7z4QsaHypNUPbH5Ea3MWYnVLqotLUSQyynQ9Ej2qECLqCweHbBjURH0ZiVJJcmrwtunnq4vbj5WdLd4YoByYosYMLVecbzXNfKZb6QkNVqWisBIqv4ogTl7IYMYcIt9NODpWCtlya8q5WQavYe3FwLrJ+wuBprVqMz6AG7ACOni0wqEt0ckVbaygdF9k8MA3BVFlZFz4mpywQYrS9BjNmHArgFls8hP/dBCkasAQ7jJU604/Vb4IUBLhZZpPioG0D2hgV9jarZxwqApbRooTKja4dqsyEr9CMyVZcTMKshDoL8HtA//Hzm56NORLcbcAVJyHKtpnJmG2hNrLkV15Znd8G8cQyP1FGpsA1my9q6bmCxGljc7ZRbF7UlK2Qp3QaEKwZvzcJ3iDjQYESD2bmuC4GYeeBsgzmrwEgtWrygBJU9N6BshqzEtpqXx0pgPAgdzaEMys25Ys9ZqZWbW4wJp7WrDXh8ua82Z1KJ2jqzyCwUWJnVKlNc5jbLtYCsDczWIm5Hb8/P33Auw7krxPFuCMMyjw8wiib8qHmBXuQlE3ImG7OzAa6NAOwd4FqZ+7Hbo/0oc8Jql8EeBLAeq5MlZHo6zSpdyHyRKV7e8azLezGxXHW+QxC1Io0C0egLz3NT8yIzm3WmN2wLy/3Gz2M4r+HYpEBTjpFVg4cRQAl2DfAKyLlmoZCyyTsOpm6D9q1XbgF0CYOQPQ2f4wYMDBdgejqNVZ11mONliL3LsTeDtz/74ziVcQN3l4AJL7jKIaurW+zlem+9CdVbrqg8ysV3Ona/mt187HNdSIFWHf/1gGNYQYHoQ0ZF4S6wCSMopGABAXqgcPjroWG5+NFgNfcvFEmvAjZiVQjZDKCsagVroTbusRGzRxHFEz+GRRIM0y7bqWEQPq0mmhsMw+O4h+Rf1GEM+FmzVAPJQ1jazAMi+ES1R7zKVSEtlapXBcbi8sCj+bAiA4X1IwzCnOG50ybDJGwDtuHI7dW0IeDzvTa+8VgEKSxJOdo+j7dV2Ij/MePYwR5XuDnruKG4nU8dGMr17xIFLM/ann8fmrj6yQp6T1o1bksTVKdkQVEuQLmwi1havCv+3vifQt6jdCvmOLpNafDKIZsZbS2WO+LiCigZ2BTrhBHbhztAOUITUcS8YACJohY8kbmuzV0Cw/u5un8g9Y7mKJhxauLoowk6nqMfLB7Q3nzw9DsA/BKNekyN/hNUFnA8qKWj3he//FJK3rSNYH3I+nJ6i9GHHQJvyHjhwKxBmwUqm/P2nwIuLZsAGre2zyVctQygUqkR229kGc+2VqUWcirJbEfIsZr5kGDjjVG1dNgegOdkj+XeUFowF8GK24V1UDaDog0fxgZkBWzmm53uECf48T9jgPqUWq1WjMqTAWfJr2RZl0OctjYVxz0/ItTjqxwAo4iAAU9ib3eXuFpofV5Xm3j5iMBiwBVzAOoTemqfjZP+3Vd7r3M6KLo36UMyqJXH9VP8M93bf04tDl2DNil0fg6mcf5UdMMuua2Ef0BtZTBMEhEC4V4dUCqmjQCD/snUbXfaYPt+7WWcm/fTHI4FV1ePsyku2tDU3m87A5ib9zQFgVepmeNXj7ktjAspAA/rMcevGK13vz0uw76DKPqasG8SefBt9sQwWqxYhf4JueyBXr1JW1usRWxZYr/Lpqj/MhDvOsFbt9BC8pBtPaFdabV0NE3NblNovjT9PqW6hgiLRFizeJtDJOsAt175Z9H2rssG/IurBWtMJXSezzM3N2DnuhAZBOeTdO7vhghoW9Bg3Z5XkS8oAlS2ueCy4OEyDyP+4gIY1ebfvP0H+xTBsegZO/dHWlvfnqyn7Is0wE7UiL3XF8A+aew8NeyI03Vk12FegLHbqmmc26Qvkcjg7ojqYtw5KCtKYp0OIR3jbT9HjcKJIYeuXaqnKX0fCMY0U84Ud9pgaY/L4m5lPS6L+5T0uCy6ie4QQMy7Y3Vszm3WfPvw1RR/m9tceODhNqsxGdu4uVo0YmCgxBOnq/NYPGinTGCKxLBPAJnOFFwi0RjoySsQmZB2UhsLdJnU3luv2Vh39Bba16ktxHurldHPBt1bR+IOnaVHHdCDXtLRI29P7Iop39/fT7nYfZ0eAH+V8t2XPH219+rl69f588neq183bDpSK+m2+z6xv7/g8/Mb/+mtxiE7kngXzo785fOIvcVL6XEy5EpEgf0R9b0yEI/Cz4+mz0fUGNpXfZRPQrTtr/ifjKMN+9/qNx4lU6mknWehyoneFRsJfOj1CDXpwCCf4zuNmu1Yu/igJlhoH8VkRPq2KMw6A+Cyve1P8T0Kj1R5UQu06J4Q2hYD1i7JTO5blH5uDSIypOy7dLZ3vTgNWRuqxJdGqxkL2fdwjT9ldQ8x9yYZFObasYr3p6z8petTGM/GbG//+cGLZytUbK4V3Lsf4gPOjt0QUcn3dnsXpdhxUMh8U6VhpfKI2neAw7qrx47qhHdSttPe2xar/BXOIIG/SyF7JazNfQSfum9n2p4MOn1/Ltib7SPlqOOFvuy0N1Av16bmhja3v3c1AZeM3XxDgejWCB5mgWaTwZP5GNbe7vPDwLu7Q1olBNrRSqGi2Q2eDr+nOffKQLAnGASjr9iTMOdJ+5JAaVaBKaVzcZSNXmXCrcwfOTvn1OYX7XeMNinI2C6FVQDCdvxQSANXxB+Rb5ehOXzN7ujrrRn+BdvCo52Z0bWoCSGraRs1dhtHtYTuEWv0FEmsL5IPas4eAdbw6ZUhzx2zdVVp45ig4KhYDG/4gzmKe/A3oA9ehx40P3Qgh8eag9usTe1i0liX3a/h5R3OZWrQ9rJkrQT5h2k2kcbNt1/liO7Vp4ymN6lx8KDUNuEDQLI5d7umbXpB7xPEh+D91T6Hg5d7r1LB+a/pAYhX6esXsJvuvQbxQuwCvH7+YoNJo9uweySlRcHZO+n+nGEpTjTvnqeYrjFUWJLh+eA2zALGiJQiNlfNgQkrEp0H5tS+eDWZvtzP0wmfTNMDvrefvt7/dT99frAL++LXnE/2X2/g1P2s0Inlks/Zv4EppGrYhHwpFsSiy/B65W4cijF1fPXcmNBberbW92ptbGEN0WhX0rtNlyuRNMml2tgf2ht272wNZw8yRoZXsCP2BeAcS03Kzenp3T+Br0IdiyaN7X3gVKl5zr7B2nde0g+ejvZeK6Zrmt1xQgPghBJ6sr7pxV7aeyGf9s8LY7Ym7PS7Jft7mPx3+u/0Cv7Nh5P0v5o6msTXAHPggsKJ9oHl8BkFqLrEhwn7u/sv0t2X6d6LhH5VYcrrwqEetp/fDB8bHCGWUqrwNg7NaopsF+zNh5NYgmPcWp1LuoelcJ7etuEAfM5HD9sUyoJsu41GfkznpegTy05LqegGr0N7y2eVvJJpmCnV7JdAMO18/Axh4Bs9n08FDi+fBHG34uSZ+jzBPIHe1YfnLt25vcdc/lHNuoO5wd+2cHyGJ53QD1Kg+en9vIX/BQRbAT8HbhcpvTdMDpPvemLfKNEf2x+K+0r1BRgjBTQi+LYPFa4cKEuzUdq8Vq39tQZ6NVPf/qsNyNY+Kf/rDc185Et30HCDzcDVG109tb/hlsSKjSPjQ3Esfk+qhz85kuxc7O30tHTneiAcN6hteHMflLQ2BSpiEFNeSS+lqYCSRHVJgI6g1IPj8vRSX/7Dr3GTawivpPnBUKlvHc0Kv8Z9x59c+YhS6VsNV/zwSiOruHg0Lvj3BLghc7P8oyxcLVJ6S8R47eaYQMaLslHykbobfmYFT2HNAlQb8Ffb0VKTwURDgqIQ7y+6pm6UoGWzv08/grmQOXQ43RoZeu66QwN3BC6Ndj2lv/EewoapS0+0oMh1SdczhOOJZcdBY1jsCEIbJ3Reo9ukbfxLeETPfbklGKajuCr7Ax86B033VxcoKuHbf20lA7lRaetKrnp0fFI5tFY94NftK/6/f2fn/9/v7ASNcnDldqqCS1I9MiLXwbqdJhdUxB04jsOh+/uGjcrW4YTra/T3n01xc4Mf/6gBI63Tb2hhDfVWkREUkmIikRxOeWFhg2A9/SM4yGfsFk+6cj/xbaRadIx8Eh5qLvlx33PtY6TtYP6lI581vPU8XB1tNqxu3S/a88p1vlv64Y+epz06/s/jT8cYMvQ9QGPxw/903tD3T/n62o/4pM9B3dw0h+7wb4rUb/4HxcObMg==
+sidebar_class_name: "delete api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Compensations contain information on how much is paid out for a job. Jobs may have many compensations, but only one that is active. The current compensation is the one with the most recent `effective_date`. This endpoint deletes a compensation for a job that hasn't been processed on payroll.
+
+### Webhooks
+- `employee_job_compensation.destroyed`: Fires when a compensation is successfully deleted
+
+scope: `compensations:write`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/delete-v-1-contractor-payment-groups-contractor-payment-group-id.ParamsDetails.json b/docs/api/delete-v-1-contractor-payment-groups-contractor-payment-group-id.ParamsDetails.json
new file mode 100644
index 000000000..00fa9a90c
--- /dev/null
+++ b/docs/api/delete-v-1-contractor-payment-groups-contractor-payment-group-id.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"contractor_payment_group_uuid","in":"path","required":true,"description":"The UUID of the contractor payment group","schema":{"type":"string"}},{"name":"X-Gusto-API-Version","in":"header","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"},"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."}]}
\ No newline at end of file
diff --git a/docs/api/delete-v-1-contractor-payment-groups-contractor-payment-group-id.RequestSchema.json b/docs/api/delete-v-1-contractor-payment-groups-contractor-payment-group-id.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/delete-v-1-contractor-payment-groups-contractor-payment-group-id.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/delete-v-1-contractor-payment-groups-contractor-payment-group-id.StatusCodes.json b/docs/api/delete-v-1-contractor-payment-groups-contractor-payment-group-id.StatusCodes.json
new file mode 100644
index 000000000..fb72d2f7f
--- /dev/null
+++ b/docs/api/delete-v-1-contractor-payment-groups-contractor-payment-group-id.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"204":{"description":"Successfully cancelled"},"404":{"description":"Not Found\n\nThe requested contractor payment group does not exist. Make sure the provided UUID is valid.\n","content":{"application/json":{"schema":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided ID/UUID is valid.","type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["error_key","category"],"properties":{"error_key":{"type":"string","description":"Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error."},"category":{"type":"string","description":"Specifies the type of error. The category provides error groupings and can be used to build custom error handling in your integration."},"message":{"type":"string","description":"Provides details about the error - generally this message can be surfaced to an end user."}}}}},"x-examples":{"not_found":{"errors":[{"error_key":"request","category":"not_found","message":"The requested resource was not found."}]}},"title":"Not-Found-Error-Object"}}}},"422":{"description":"Unprocessable Entity\n\nThis may happen when trying to cancel a payment group that is not in a cancellable state, such as one that has already been funded or processed.\n","content":{"application/json":{"schema":{"description":"Unprocessable Entity\n \nThis 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.\n","type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["error_key","category"],"properties":{"error_key":{"type":"string","description":"Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error."},"category":{"type":"string","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."},"message":{"type":"string","description":"Provides details about the error - generally this message can be surfaced to an end user."},"metadata":{"type":"object","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.","oneOf":[{"type":"object","description":"multiple entities","required":["entities"],"properties":{"entities":{"type":"array","items":{"type":"object","description":"single entity","additionalProperties":true,"properties":{"entity_type":{"type":"string","description":"Name of the entity that the error corresponds to."},"entity_uuid":{"type":"string","description":"Unique identifier for the entity."},"valid_from":{"type":["string","null"]},"valid_up_to":{"type":["string","null"]},"key":{"type":["string","null"]},"state":{"type":["string","null"]}},"title":"Metadata-With-One-Entity"}}},"title":"Metadata-With-Multiple-Entities"},{"type":"object","description":"single entity","additionalProperties":true,"properties":{"entity_type":{"type":"string","description":"Name of the entity that the error corresponds to."},"entity_uuid":{"type":"string","description":"Unique identifier for the entity."},"valid_from":{"type":["string","null"]},"valid_up_to":{"type":["string","null"]},"key":{"type":["string","null"]},"state":{"type":["string","null"]}},"title":"Metadata-With-One-Entity"}]},"errors":{"type":"array","description":"Will only exist if category is `nested_errors`. It is possible to have multiple levels of nested errors.","items":"circular(Entity-Error-Object)"}},"title":"Entity-Error-Object"}}},"x-examples":{"bank_account_delete_unfunded_payments":{"errors":[{"error_key":"base","category":"invalid_operation","message":"FundingMethod has unfunded payments"}]},"bank_account_verify_incorrect_deposits":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Your bank account cannot be verified. Please check the test deposit amounts."}]},"bank_account_verify_already_verified":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Your bank account has already been verified."}]},"bank_account_missing_routing":{"errors":[{"error_key":"routing_number","category":"invalid_attribute_value","message":"Routing number is required."}]},"payment_configs_missing_parameter":{"errors":[{"error_key":"base","category":"missing_parameter","message":"At least one parameter must be provided"}]},"payment_configs_invalid_fast_payment_limit":{"errors":[{"error_key":"fast_payment_limit","category":"invalid_attribute_value","message":"Fast payment limit should be a number"}]},"pay_periods_invalid_end_date":{"errors":[{"error_key":"end_date","category":"invalid_parameter","message":"End date cannot be more than 3 months in future"}]},"company_industry_selection_naics_code_required":{"errors":[{"error_key":"naics_code","category":"invalid_attribute_value","message":"Naics code is required."}]},"company_industry_selection_naics_code_invalid":{"errors":[{"error_key":"naics_code","category":"invalid_attribute_value","message":"Naics code must be equal to 6 digits."}]},"company_industry_selection_sics_codes_invalid":{"errors":[{"error_key":"sic_codes","category":"invalid_attribute_value","message":"Sic codes must be equal to 4 digits"}]},"time_off_policy_name_required":{"errors":[{"error_key":"name","category":"invalid_attribute_value","message":"Name is required."}]},"time_off_policy_unlimited_invalid_accrual_rate":{"errors":[{"error_key":"accrual_rate","category":"invalid_operation","message":"Accrual rate must be blank for unlimited policies."}]},"time_off_policy_pending_requests":{"errors":[{"error_key":"time_off_policy","category":"invalid_operation","message":"Cannot deactivate policy with pending time off requests."}]},"time_off_policy_employees_required":{"errors":[{"error_key":"employees","category":"invalid_attribute_value","message":"Employees are required."}]},"time_off_policy_unlimited_balance_update":{"errors":[{"error_key":"base","category":"invalid_attribute_value","message":"Can not adjust balances for unlimited policies."}]},"holiday_pay_policy_already_exists":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Company already has a holiday pay policy."}]},"holiday_pay_policy_not_exists":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Company does not have a holiday pay policy, please create one"}]},"holiday_pay_policy_invalid_employees":{"errors":[{"error_key":"employees","category":"invalid_attribute_value","message":"Invalid employee uuids provided."}]},"onboarded_employee":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Cannot delete onboarded employee"}]},"invalid_attribute":{"errors":[{"error_key":"base","category":"invalid_operation","message":"There is an error in the request body."}]},"company_cannot_enable_contractor_only":{"errors":[{"error_key":"contractor_only","category":"invalid_attribute_value","message":"Contractor only cannot be enabled for existing companies."}]},"company_missing_parameter":{"errors":[{"error_key":"base","category":"missing_parameter","message":"contractor_only is required."}]},"starting_after_uuid_invalid":{"errors":[{"error_key":"starting_after_uuid","category":"invalid_attribute_value","message":"Parameter 'starting_after_uuid' does not correspond to a valid event."}]},"resource_uuid_invalid":{"errors":[{"error_key":"resource_uuid","category":"invalid_attribute_value","message":"Parameter 'resource_uuid' does not correspond to a valid resource."}]},"payroll_gross_up_invalid_net_pay":{"errors":[{"error_key":"net_pay","category":"invalid_attribute_value","message":"Net pay must be a number."}]},"payroll_accruing_hours_invalid":{"errors":[{"error_key":"base","category":"invalid_attribute_value","message":"Hours cannot be negative."}]},"payroll_cannot_cancel":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Payroll cannot be canceled."}]},"frozen_payroll":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This payroll has already been processed. Its data cannot be updated or altered."}]},"frozen_payroll_processing":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This payroll is being processed and cannot be updated at this time."}]},"unmodifiable_payroll_type":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This type of payroll cannot be modified or processed. It is reserved for system processes."}]},"invalid_employee_uuids_format":{"errors":[{"error_key":"employee_uuids","category":"invalid_attribute_value","message":"Parameter employee_uuids must be an array."}]},"maximum_employee_uuids_surpassed":{"errors":[{"error_key":"employee_uuids","category":"invalid_attribute_value","message":"Exceeded maximum of 100 for lookup."}]},"invalid_employee_uuid":{"errors":[{"error_key":"employee_uuids","category":"invalid_attribute_value","message":"Invalid Employee UUID(s).","metadata":{"entities":[{"entity_type":"Employee","entity_uuid":"invalid-uuid-123"}]}}]},"payroll_blocker_missing_bank_info":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must have a bank account in order to run payroll.","metadata":{"key":"missing_bank_info"}}]},"payroll_blocker_missing_employee_setup":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must add employees in order to run payroll.","metadata":{"key":"missing_employee_setup"}}]},"payroll_blocker_missing_federal_tax_setup":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must complete federal tax setup in order to run payroll.","metadata":{"key":"missing_federal_tax_setup"}}]},"payroll_blocker_missing_bank_verification":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company bank account must be verified in order to run payroll.","metadata":{"key":"missing_bank_verification"}}]},"payroll_blocker_suspended":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company is suspended and cannot run payroll.","metadata":{"key":"suspended"}}]},"submission_blocker_missing_selection":{"errors":[{"error_key":"submission_blockers","category":"invalid_attribute_value","message":"Submission blockers selections required"}]},"submission_blocker_invalid_option":{"errors":[{"error_key":"submission_blockers","category":"nested_errors","metadata":{"blocker_type":"fast_ach_threshold_exceeded"},"errors":[{"error_key":"selected_option","category":"invalid_attribute_value","message":"Selection is not available to resolve Fast ACH Threshold Exceeded. Please choose one of Wire In, Move To Four Day"}]}]},"invalid_version":{"errors":[{"error_key":"base","category":"invalid_resource_version","message":"You are attempting to update a resource using an out-of-date version."}]},"signatory_email_required":{"errors":[{"error_key":"email","category":"invalid_attribute_value","message":"Email is required"}]},"signatory_company_already_has_signatory":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Cannot have more than one signatory in a company. Please remove the existing signatory before adding a new one."}]},"mixed_disbursement_errors":{"errors":[{"error_key":"disbursements","category":"nested_errors","metadata":{"contractor_payment_uuid":"invalid-uuid-1"},"errors":[{"error_key":"contractor_payment_uuid","category":"not_found","message":"Disbursement not found."}]},{"error_key":"disbursements","category":"nested_errors","metadata":{"contractor_payment_uuid":"d0dfa222-ad08-4ea7-a06a-717688c3b179"},"errors":[{"error_key":"payment_method","category":"invalid_attribute_value","message":"Payment method must be one of: Direct Deposit, Check."},{"error_key":"payment_status","category":"invalid_attribute_value","message":"Payment status is not valid for payment method 'InvalidMethod'."}]}]},"not_found":{"errors":[{"error_key":"request","category":"not_found","message":"The requested resource was not found."}]},"finish_onboarding_incomplete":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Company is not ready to exit onboarding."}]},"company_location_validation":{"errors":[{"error_key":"street_1","category":"invalid_attribute_value","message":"Must include a street address"},{"error_key":"city","category":"invalid_attribute_value","message":"Must include a city"},{"error_key":"state","category":"invalid_attribute_value","message":"State is in the wrong format"},{"error_key":"zip","category":"invalid_attribute_value","message":"Please enter a valid zip code (e.g. 12345)."},{"error_key":"phone_number","category":"invalid_attribute_value","message":"Phone number must be 10 digits"}]},"conflict":{"errors":[{"error_key":"request","category":"duplicate_operation","message":"A resource with these attributes already exists."}]},"invalid_parameter":{"errors":[{"error_key":"request","category":"invalid_parameter","message":"The provided parameter is invalid or missing."}]},"flow_invalid_entity":{"errors":[{"error_key":"entity_type","category":"invalid_attribute_value","message":"Invalid flow entity"},{"error_key":"entity_uuid","category":"invalid_attribute_value","message":"Invalid flow entity"}]},"flow_nested_options_errors":{"errors":[{"error_key":"options","category":"nested_errors","metadata":{"flow_type":"company_forms"},"errors":[{"error_key":"form_types","category":"invalid_attribute_value","message":"Supplied value 'invalid' contains no permitted values"}]}]},"basic":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must complete all onboarding requirements in order to run payroll.","metadata":{"key":"needs_onboarding"}}]},"contractor_payment_invalid_wage":{"errors":[{"error_key":"wage","category":"invalid_attribute_value","message":"Wage must be greater than or equal to 0."}]},"contractor_payment_cannot_cancel":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Payment has already been processed and cannot be cancelled. Contact support directly."}]},"time_off_request_cannot_delete":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This time off request cannot be deleted."}]},"resource":{"errors":[{"error_key":"first_name","category":"invalid_attribute_value","message":"First name is required"},{"error_key":"date_of_birth","category":"invalid_attribute_value","message":"Date of birth is not a valid date"}]},"nested":{"errors":[{"error_key":"contractor_payments","category":"nested_errors","metadata":{"contractor_uuid":"72ae4617-daa9-4ed7-85e0-18ed5d0ee835"},"errors":[{"error_key":"hours","category":"invalid_attribute_value","message":"Ella Fitzgerald is paid fixed wage and hours cannot be set on a contractor payment"}]},{"error_key":"contractor_payments","category":"nested_errors","metadata":{"contractor_uuid":"2d7bf62c-babf-4a12-8292-340e2d9cab28"},"errors":[{"error_key":"wage","category":"invalid_attribute_value","message":"Isaiah Berlin is paid hourly and wage cannot be set on a contractor payment"}]}]},"compensation_invalid_rate":{"errors":[{"error_key":"rate","category":"invalid_attribute_value","message":"Rate is not a valid number"}]},"compensation_invalid_payment_unit":{"errors":[{"error_key":"payment_unit","category":"invalid_attribute_value","message":"Payment unit must be one of Hour, Week, Month, or Year"}]},"compensation_already_processed":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Compensation has already been processed on payroll."}]}},"title":"Unprocessable-Entity-Error-Object"}}}}}}
\ No newline at end of file
diff --git a/docs/api/delete-v-1-contractor-payment-groups-contractor-payment-group-id.api.mdx b/docs/api/delete-v-1-contractor-payment-groups-contractor-payment-group-id.api.mdx
new file mode 100644
index 000000000..eb04242ee
--- /dev/null
+++ b/docs/api/delete-v-1-contractor-payment-groups-contractor-payment-group-id.api.mdx
@@ -0,0 +1,71 @@
+---
+id: delete-v-1-contractor-payment-groups-contractor-payment-group-id
+title: "Cancel a contractor payment group"
+description: "Cancels a contractor payment group and all associated contractor payments. All contractor payments must be cancellable, unfunded."
+sidebar_label: "Cancel a contractor payment group"
+hide_title: true
+hide_table_of_contents: true
+api: eJztXFtv3DiW/itc7UMSoFS2K86l/TRZ25kxsOk2OslmBu5AZolHJbYlUk1SZVcb/u+Lw4ukUqlkl2NjZwfTQKPbJV4+Hp47D3kbyQoUNVyKMxYdRQwKMBAvD+JUCqNoaqRKKroqQZhkoWRd6a1fEs6iScRAp4pXOGJ0FB1TkUKhCSVtL+J7EduLUMEILQpCtZYppwbYQFs9JR+KYugDKWttyBxIaqcq6LyACalFVgsGbPqb+E3oVFZwRC4rulKyKPSRqsVlNIkMXejo6CI6bkc999D+apcafZ9EN/Gi1kbGXBhYOErFZlUBdoRyDowBw3YVVbQEAwqHvI0ELSE6irbSqq4ttTgSqaImjyaRgj9qroBFR0bV0KfklxzI169nJ0RmxOSwlZ7RJNJpDiWNjm4jBzTSRnGxiO7uJg2wv8d/tcv6cH4W/w8ojZN4ODlQBmpknEkEoi6RALP92Zt4/2188AZJwCCjdWGio+7vd/2FnCCRSi5A23UwaiCeUw2MfDg/I0uHpcsN19zkZCVrZRuktCim5CwjQgogXJNKySVnwCauDa2qgqd2n15oclFywcu67I79/WVuTKWP9vaYTPXUbu80leVe2M7YM4r9vkcrHvueXCz+0w8Yd35+hTBqDWwa3X2fRBrSWnGzsnxwLMuKitWHNAWtP9Qmj44uvt91+Erpa7oIW65AV1Jo0Ej02f4h/medep9rO1JWF8UqsDwwpPLhUPOfpSEfZS0YygGyEDIZ6GEh8wLJJGgipCFww7WZkk/0CoiuFdj9CuR2zMg1WdKCo5xFE8vtIAzC6GzD3u8asdx2+GkLSPKbIKSPU4GWtUrhobjOTvbWoaGkO/6V898hNWuidhGBUlJZUa8UKkPDHfn97y33U6XoCoXEQNn9ffuoyRVgh5QaWEi12jKHbTUgZL2NryDlGQdNrnPwa7bdiUzTWukp+bKqOErHipica3IFK8IZCON6YXtqjOLz2sBeo62IgsJKmZHtkFPkpwb1DtBwBGyLSsqNRHAzw1Bhk7RHbvmNi4W2RiClAvU4ChKimde8YCRFISl9+5wKVnCxIFw4Ye8oZYu5BK3pAu6HfB6AMDCUo4Gay9p0iBqTBQhQLTn90AGlrlVGU4eUCgKCIXCkHP6D4g03tKwKt89CmiRDDu8y1sXa/kee47v8ctTp2FlctEVArqmTD9sBdRECMdwU4IQstkIWn+Kk8S+Oax3aw9lsUyy/ikpJVDZoUsmpMNysnBpBctAVyWlVgUB+FMSoFW6MkV4pEdrTKianBmUSAXKBDkFrr4k21MCE6DrNCdUENbttn1NNaKGAshWZAwjirDpBneWwwY+pnuE1OiU0tMocyFyyFfK3ZUC/C1aZUi48Y+tmJZdcWCWUNKKXLGlRw+UE12DafSSZZUNWg+eopmfjoF1OyWdwgn9x6qY5dpzCQe9o1CzMOG26vyKLmjMgmVSklAqCXDji/lt9/uurT3Spmom4JpfCapfE7ePlxIJze0WuuffFqZVk15Jc+qbEb9LKeW5ghcoLxj+NlkYUhjJq6BAr9oKYINwKClhSYdBppTimZ5CVl2Svh7kgVqbRj7Vqw2ukeQFT8lEq4k3DZG0Ii8+S6tL9N0FUl3Zvwy8YNVw68s9blwc9HCngl8zalPG1lHVheFWAmwvlqCd44edNYQtfdhDp9bk1F4swM3ajjHH8RIvzzkzOEx6Y2xHkfq75mZYQoiRPUWtMWrZJpXKeNtPESMsNHQLfP8NXwf+ooVUPyurNdj47otPemZJlO+BFO6KoiyL63rSrq8TI8YZrem6ogbWiY0067sAnz/3xN27y+BcBsTN+0d32Vp8877imuDUYUP57z///7zmOtNVgr9PhGyofKYqVC8MIHzUbU3Jmvb5Kas3RxTKS5HQJpNFDBSwxQSSzYEaCoWjUSpRyldYFVS8d3DUH9lXUXeFAg2jAHZ9TcZXQNJW1MIlLeSUhYxTyNHrEVcd0xbqfvuGsrfnrH2vBuFh8ApNLZp3aMFuTxnJ7sAZsCYpnq4QLy7opIq2k5k+K7B/oBuCsxM+KlhNd9DkQOz8HNiXnBVANJM0hvXJOCnqsHg6hJXbU0+1L8C58EkZ81gVsxAzNOgYAllyjhkqUrA2KzUh45lokoi7nNjs2ALHn5K8B/dX1J64/ykQwux5XyA+mUmR8oRtoja+5E9U2e3fBfDAEt9TYSKt1ZkMqNTgWw8DCajOqTZPVLHjJzQjCgcY7k/AjIg5RpR2D6FzWBUPM1FO2wZxUoLhkLV4QLGFeW25B2TQZxDZMy1PBbBKzIzk2gjI5FeQ1KaUwuUafMKtNrcDhS11aMOGC1dqoVaKhgBS5OxGUpzpJJYOkdcy2Im5b707Pn7Evwb4D7PgwhH6a5wcYWBP+qGmBVuQtYXzBG7UzAlcHAPoBcDVPXdvd0X7mqcWqN8EeerAOq+ElJDLLkkoWPF0lmJJ/2F6XjyJiObS/fRC1sBIFrJEXmqaqpkWixmVmrdkOmvuD60ewX0OxeYGqHD2rBg+xADnoLcArsMY18YmUMevY67oL2mMn3AxoavgSIbsxXIzrMRCcgMgsC1mdbZihrAq5AtAP2fam8e57fxq6Eqrg4RwwpwUm55K6ukdfbrfWY6iOqbBpQMp+t9vuZtPj257LgjPU6vivAxzcCuuIPqVX5A9tGjfCuhTEI0AL5Dd/OzTM2z4brOYgxHrSQ8AmpPIumwLkVSlgK9TGPDZs9iyseObakDAEwbBLd3IYFp8Uc0kVuuGh3VPSL8gwOvykmaqB5CBsLOYJEXyxuUeubbLHhqVcrGWBMbncs2jOrUhAYP4o6RwoYxA2gq3fcncxbQ8IbbzX+jcOC7MCa7kcdZ/D2wpswP+cfmxvjQNmThuqrN9OMwPKxvoP8QI2e+1Ov/PGr34xMN6LVozb1ITNUxIvKEsQxq8ipBYfin+t/Q8hXxvpXsyhdRvS4JEDljxojemOMLkAGwyM+Tq+xe7uDtgYofEoQlzQg2S9FtyRXNbqIY7h40zd33D0juQIWFDDl30CeRl3R2JPqG/O3fgdAG6KRjwyJf8EkXgcT6rpMOvjp98IydvDO3JmtEuntxid22FP+WhhQG1Bm/hRxuP2HwLONZkDKrcGcDhq6UG1qUaurQPowdailIxn3KrtADlkM58SbDgxqjY22wHon5f6lJwCDWrptbheaQNl0yjo8L5vYLWATjKpSjoW7a+3/xEFtD5SK9WC2PSkx1nSGyzK6ePUtaoorvkZoZ7epADoRXgMuBMH+/uWqoWUV3U1RstnBBYcrhAD2IKdl/rVNFo/+2rPdS56SfcmfIh6ufIwf4x/xgez17bWoKvQ5oVMr0A1xt8m3bjI5E7M3xtt0Bm2HOEd4bU8IBdEKgYK7ZOqRRCP/vLd3Js4x9fTbI4GU1fPsyjKWtdUP245PZjja8qA4VFqYujNcy4L/ULrgPv5iKE3xM73uDVuwn4AK7qcsCsSefJlrrFh0FghC/0DfLkGeniRutaYi9gxxf6QRXEsavGDd43gvUtoITnIup7bVUmxsTVNzm7MNd/o/phUXTMICYOQZvI2hoi2AW6t8o+iXTsu69EvzOa1sU2h0zRPTK5A57JgCXjjE3XO7/oI7LKgwbo7rQJdQvUWXVLuyraQg0HLYgnE5uY/HP+NfAngSLCMnfMjKbVNRqCR/MYVkDMxIZ/kEsgXiSWgipxQexzZNZi+yvZRblMTviybGue1syObF6PGQFkZX7/mXDpC23qOGpkTXQ5Zm1hmsf3uBwxhJl8IaqTC1B7lxcPSepQXj0npUV50A90+gBB3h+xYTnXSfH36bIo7zW0OPHBzm9l8oZ8D1LCBghJ33B6dh+RB22UOGQ6GdQJIdCLgGgcNjh6/AZYwrue10mAPk9pz6y0L67beQfoGSvcHvZ8R2ds2xANKPE86oHtFnZNnXh7bZxmdzWYxZfvv40Og72K6/5bG7w7evX3/Pn09P3j308iiw2ilPe1+jO/vDvhc/8Z+Oq1xRE44noWTE3f4PCHHeCg9jfpUCSiwPqJ+VATiULj+QfU5jzrrlMx7lC+8t+2O+F9Mgw77vyr8nUQZF1znic9yonXFQgLnej1DTtoTyMX4RqJkG9JO3ssJFtJ5MYkd+j4vTBsFYJKD3XfxEzIPF2lRM9TobiDULQq03uCZ1JUo/dgcdpD+yK5KZ3fTi92QtD5LfK2kWBAffffn+JNXj2Bzp5JBYKwdsnh/8sodur6E6WJKDmavD9+8GhCxXAp4dD3EOfYO1RBByA/21w5KseKg4OlYpmFQeFjtKsBh29FjR3Tw+M7koDvlvW2yyh3h9AL4hySyB2GN1xF86V5iaWsy7O67fcHabOcpBxkv5HWnvMHWco0VN7Sx/aOzCThlqObrM0Q3R/A0EzSL9JbM+bD6fpvvGz7cHNpZvKMdtBQKmh6xdPjd9nlUBII1wcCI/URe+D4v2psEQpIKL8oZE1rpYFXmVPP0maNzasv8gv4O3qa7crlTCCsAmO7YIR8GDvgfgW7Xvjh8y+rs550J/g3LwoOeWdhjUeVdVtUWauw3hmoD3TPm6K0nsT1J3ss5N7f+psRWpqeG6LqqpDKEWeeoWPVP+L06CmtwJ6BPnofuFT90ILsJWe80a6xcjCttkscVvHzEvkT0yl42tBWz9iFL5lzZ67c7znJiz9UzYrs3obG3oLZswjmAVuc87Ji2qQV9jBPvnfd3MwqHbw/exYzSn+JDYO/i929gPz54D+wN2wd4//rNiEqzp2GPCEqLgpKP3Py5wFQcsxW/FJU5hmsEBdbycN47DdOAPuLg5fCBQOeJKTVj7+bZ21kaz+k8iw/pwSx+P/tpFr8+3IcZ+yml89n7EUo9TgudacppTv4LVMFFQyakS7GyJLr2t1ceRqHgU4PQzp9u8h7jdTvba7VGS1i9N9rl9G7R5SCSJrgUo/Wha80eHa1h717ESPAIdkK+AVxhqkmY3F69+wfQIdQhadLo3icOlcJEY9pedgzq+h3OtduK8ZZid1furiugV0D1KkZFGMslKMUZNE88ROuN3NMBXRnzJPUPIUwiuDEgtHWqkBCOBFsfR7BXHOreIwko0Ov93OX3pjFeA+k22raIpkNYzHCn8B5CaLxtcXgd32crOuSxrzIcRXvLg72tb2Hs3Y4+8HCHjyjgIavnnloVqGP9RU1acXdPM2ZQ2suaG5ctTqCUvZ1y48UuU4Ofce1bBh4c81zZrMy2MSv83H3G4DNenXVVYQOPGTS3RXDy8GYE/j0Hqqyj2b9LZ4eI7bUPQmuTo68fzjQm0Wd7EP0jM7gRtkxgwzh3ChmEyr6Dge9DIKeEVHP3BYtJhA9W6F+yz6CWPIUOpdtrtvZm4p5tuMdwatQBsf0bU8bad924TQNFKkubSbc4Xmhy6uWFhOINfLqCybRG5rLL+A9/35m6yNi/6HESZiW/4p1UH/64LDOyiv/6l5YzkBqV1KakojPOcbi/PfLCyNoibtvL1//k7704PjJwY/aqgnLLcFZ0br20X0TLg2jQ+18EPXg0/qTLd6yx1AaHur1FC/FVFXd3+PMfNaCRuPiOCknZshCrFBi36pxFRxktdP/dly5xX/7qfdlXZIfXYAZXHa54iVVHP0b+vtk9r9a4QlL3SMxuC/iXfvplC6UdRYef22kI39ov1HyV6XzbeM1gzVqdnP736ZdTvFe5risb3ej/p3MxeH3Pb29diy/yCsTdXcMCBv+27sfd/wLkHdLz
+sidebar_class_name: "delete api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Cancels a contractor payment group and all associated contractor payments. All contractor payments must be cancellable, unfunded.
+
+scope: `payrolls:run`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/delete-v-1-contractors-contractor-uuid.ParamsDetails.json b/docs/api/delete-v-1-contractors-contractor-uuid.ParamsDetails.json
new file mode 100644
index 000000000..ef8002261
--- /dev/null
+++ b/docs/api/delete-v-1-contractors-contractor-uuid.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"X-Gusto-API-Version","in":"header","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"},"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."},{"name":"contractor_uuid","in":"path","description":"The UUID of the contractor","required":true,"schema":{"type":"string"}}]}
\ No newline at end of file
diff --git a/docs/api/delete-v-1-contractors-contractor-uuid.RequestSchema.json b/docs/api/delete-v-1-contractors-contractor-uuid.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/delete-v-1-contractors-contractor-uuid.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/delete-v-1-contractors-contractor-uuid.StatusCodes.json b/docs/api/delete-v-1-contractors-contractor-uuid.StatusCodes.json
new file mode 100644
index 000000000..2c4e3df8c
--- /dev/null
+++ b/docs/api/delete-v-1-contractors-contractor-uuid.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"204":{"description":"No Content"},"404":{"description":"Not Found\n\nThe requested resource does not exist. Make sure the provided UUID is valid.\n","content":{"application/json":{"schema":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided ID/UUID is valid.","type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["error_key","category"],"properties":{"error_key":{"type":"string","description":"Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error."},"category":{"type":"string","description":"Specifies the type of error. The category provides error groupings and can be used to build custom error handling in your integration."},"message":{"type":"string","description":"Provides details about the error - generally this message can be surfaced to an end user."}}}}},"x-examples":{"not_found":{"errors":[{"error_key":"request","category":"not_found","message":"The requested resource was not found."}]}},"title":"Not-Found-Error-Object"}}}},"422":{"description":"Unprocessable Entity\n\nThis 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.\n","content":{"application/json":{"schema":{"description":"Unprocessable Entity\n \nThis 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.\n","type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["error_key","category"],"properties":{"error_key":{"type":"string","description":"Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error."},"category":{"type":"string","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."},"message":{"type":"string","description":"Provides details about the error - generally this message can be surfaced to an end user."},"metadata":{"type":"object","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.","oneOf":[{"type":"object","description":"multiple entities","required":["entities"],"properties":{"entities":{"type":"array","items":{"type":"object","description":"single entity","additionalProperties":true,"properties":{"entity_type":{"type":"string","description":"Name of the entity that the error corresponds to."},"entity_uuid":{"type":"string","description":"Unique identifier for the entity."},"valid_from":{"type":["string","null"]},"valid_up_to":{"type":["string","null"]},"key":{"type":["string","null"]},"state":{"type":["string","null"]}},"title":"Metadata-With-One-Entity"}}},"title":"Metadata-With-Multiple-Entities"},{"type":"object","description":"single entity","additionalProperties":true,"properties":{"entity_type":{"type":"string","description":"Name of the entity that the error corresponds to."},"entity_uuid":{"type":"string","description":"Unique identifier for the entity."},"valid_from":{"type":["string","null"]},"valid_up_to":{"type":["string","null"]},"key":{"type":["string","null"]},"state":{"type":["string","null"]}},"title":"Metadata-With-One-Entity"}]},"errors":{"type":"array","description":"Will only exist if category is `nested_errors`. It is possible to have multiple levels of nested errors.","items":"circular(Entity-Error-Object)"}},"title":"Entity-Error-Object"}}},"x-examples":{"bank_account_delete_unfunded_payments":{"errors":[{"error_key":"base","category":"invalid_operation","message":"FundingMethod has unfunded payments"}]},"bank_account_verify_incorrect_deposits":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Your bank account cannot be verified. Please check the test deposit amounts."}]},"bank_account_verify_already_verified":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Your bank account has already been verified."}]},"bank_account_missing_routing":{"errors":[{"error_key":"routing_number","category":"invalid_attribute_value","message":"Routing number is required."}]},"payment_configs_missing_parameter":{"errors":[{"error_key":"base","category":"missing_parameter","message":"At least one parameter must be provided"}]},"payment_configs_invalid_fast_payment_limit":{"errors":[{"error_key":"fast_payment_limit","category":"invalid_attribute_value","message":"Fast payment limit should be a number"}]},"pay_periods_invalid_end_date":{"errors":[{"error_key":"end_date","category":"invalid_parameter","message":"End date cannot be more than 3 months in future"}]},"company_industry_selection_naics_code_required":{"errors":[{"error_key":"naics_code","category":"invalid_attribute_value","message":"Naics code is required."}]},"company_industry_selection_naics_code_invalid":{"errors":[{"error_key":"naics_code","category":"invalid_attribute_value","message":"Naics code must be equal to 6 digits."}]},"company_industry_selection_sics_codes_invalid":{"errors":[{"error_key":"sic_codes","category":"invalid_attribute_value","message":"Sic codes must be equal to 4 digits"}]},"time_off_policy_name_required":{"errors":[{"error_key":"name","category":"invalid_attribute_value","message":"Name is required."}]},"time_off_policy_unlimited_invalid_accrual_rate":{"errors":[{"error_key":"accrual_rate","category":"invalid_operation","message":"Accrual rate must be blank for unlimited policies."}]},"time_off_policy_pending_requests":{"errors":[{"error_key":"time_off_policy","category":"invalid_operation","message":"Cannot deactivate policy with pending time off requests."}]},"time_off_policy_employees_required":{"errors":[{"error_key":"employees","category":"invalid_attribute_value","message":"Employees are required."}]},"time_off_policy_unlimited_balance_update":{"errors":[{"error_key":"base","category":"invalid_attribute_value","message":"Can not adjust balances for unlimited policies."}]},"holiday_pay_policy_already_exists":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Company already has a holiday pay policy."}]},"holiday_pay_policy_not_exists":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Company does not have a holiday pay policy, please create one"}]},"holiday_pay_policy_invalid_employees":{"errors":[{"error_key":"employees","category":"invalid_attribute_value","message":"Invalid employee uuids provided."}]},"onboarded_employee":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Cannot delete onboarded employee"}]},"invalid_attribute":{"errors":[{"error_key":"base","category":"invalid_operation","message":"There is an error in the request body."}]},"company_cannot_enable_contractor_only":{"errors":[{"error_key":"contractor_only","category":"invalid_attribute_value","message":"Contractor only cannot be enabled for existing companies."}]},"company_missing_parameter":{"errors":[{"error_key":"base","category":"missing_parameter","message":"contractor_only is required."}]},"starting_after_uuid_invalid":{"errors":[{"error_key":"starting_after_uuid","category":"invalid_attribute_value","message":"Parameter 'starting_after_uuid' does not correspond to a valid event."}]},"resource_uuid_invalid":{"errors":[{"error_key":"resource_uuid","category":"invalid_attribute_value","message":"Parameter 'resource_uuid' does not correspond to a valid resource."}]},"payroll_gross_up_invalid_net_pay":{"errors":[{"error_key":"net_pay","category":"invalid_attribute_value","message":"Net pay must be a number."}]},"payroll_accruing_hours_invalid":{"errors":[{"error_key":"base","category":"invalid_attribute_value","message":"Hours cannot be negative."}]},"payroll_cannot_cancel":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Payroll cannot be canceled."}]},"frozen_payroll":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This payroll has already been processed. Its data cannot be updated or altered."}]},"frozen_payroll_processing":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This payroll is being processed and cannot be updated at this time."}]},"unmodifiable_payroll_type":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This type of payroll cannot be modified or processed. It is reserved for system processes."}]},"invalid_employee_uuids_format":{"errors":[{"error_key":"employee_uuids","category":"invalid_attribute_value","message":"Parameter employee_uuids must be an array."}]},"maximum_employee_uuids_surpassed":{"errors":[{"error_key":"employee_uuids","category":"invalid_attribute_value","message":"Exceeded maximum of 100 for lookup."}]},"invalid_employee_uuid":{"errors":[{"error_key":"employee_uuids","category":"invalid_attribute_value","message":"Invalid Employee UUID(s).","metadata":{"entities":[{"entity_type":"Employee","entity_uuid":"invalid-uuid-123"}]}}]},"payroll_blocker_missing_bank_info":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must have a bank account in order to run payroll.","metadata":{"key":"missing_bank_info"}}]},"payroll_blocker_missing_employee_setup":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must add employees in order to run payroll.","metadata":{"key":"missing_employee_setup"}}]},"payroll_blocker_missing_federal_tax_setup":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must complete federal tax setup in order to run payroll.","metadata":{"key":"missing_federal_tax_setup"}}]},"payroll_blocker_missing_bank_verification":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company bank account must be verified in order to run payroll.","metadata":{"key":"missing_bank_verification"}}]},"payroll_blocker_suspended":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company is suspended and cannot run payroll.","metadata":{"key":"suspended"}}]},"submission_blocker_missing_selection":{"errors":[{"error_key":"submission_blockers","category":"invalid_attribute_value","message":"Submission blockers selections required"}]},"submission_blocker_invalid_option":{"errors":[{"error_key":"submission_blockers","category":"nested_errors","metadata":{"blocker_type":"fast_ach_threshold_exceeded"},"errors":[{"error_key":"selected_option","category":"invalid_attribute_value","message":"Selection is not available to resolve Fast ACH Threshold Exceeded. Please choose one of Wire In, Move To Four Day"}]}]},"invalid_version":{"errors":[{"error_key":"base","category":"invalid_resource_version","message":"You are attempting to update a resource using an out-of-date version."}]},"signatory_email_required":{"errors":[{"error_key":"email","category":"invalid_attribute_value","message":"Email is required"}]},"signatory_company_already_has_signatory":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Cannot have more than one signatory in a company. Please remove the existing signatory before adding a new one."}]},"mixed_disbursement_errors":{"errors":[{"error_key":"disbursements","category":"nested_errors","metadata":{"contractor_payment_uuid":"invalid-uuid-1"},"errors":[{"error_key":"contractor_payment_uuid","category":"not_found","message":"Disbursement not found."}]},{"error_key":"disbursements","category":"nested_errors","metadata":{"contractor_payment_uuid":"d0dfa222-ad08-4ea7-a06a-717688c3b179"},"errors":[{"error_key":"payment_method","category":"invalid_attribute_value","message":"Payment method must be one of: Direct Deposit, Check."},{"error_key":"payment_status","category":"invalid_attribute_value","message":"Payment status is not valid for payment method 'InvalidMethod'."}]}]},"not_found":{"errors":[{"error_key":"request","category":"not_found","message":"The requested resource was not found."}]},"finish_onboarding_incomplete":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Company is not ready to exit onboarding."}]},"company_location_validation":{"errors":[{"error_key":"street_1","category":"invalid_attribute_value","message":"Must include a street address"},{"error_key":"city","category":"invalid_attribute_value","message":"Must include a city"},{"error_key":"state","category":"invalid_attribute_value","message":"State is in the wrong format"},{"error_key":"zip","category":"invalid_attribute_value","message":"Please enter a valid zip code (e.g. 12345)."},{"error_key":"phone_number","category":"invalid_attribute_value","message":"Phone number must be 10 digits"}]},"conflict":{"errors":[{"error_key":"request","category":"duplicate_operation","message":"A resource with these attributes already exists."}]},"invalid_parameter":{"errors":[{"error_key":"request","category":"invalid_parameter","message":"The provided parameter is invalid or missing."}]},"flow_invalid_entity":{"errors":[{"error_key":"entity_type","category":"invalid_attribute_value","message":"Invalid flow entity"},{"error_key":"entity_uuid","category":"invalid_attribute_value","message":"Invalid flow entity"}]},"flow_nested_options_errors":{"errors":[{"error_key":"options","category":"nested_errors","metadata":{"flow_type":"company_forms"},"errors":[{"error_key":"form_types","category":"invalid_attribute_value","message":"Supplied value 'invalid' contains no permitted values"}]}]},"basic":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must complete all onboarding requirements in order to run payroll.","metadata":{"key":"needs_onboarding"}}]},"contractor_payment_invalid_wage":{"errors":[{"error_key":"wage","category":"invalid_attribute_value","message":"Wage must be greater than or equal to 0."}]},"contractor_payment_cannot_cancel":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Payment has already been processed and cannot be cancelled. Contact support directly."}]},"time_off_request_cannot_delete":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This time off request cannot be deleted."}]},"resource":{"errors":[{"error_key":"first_name","category":"invalid_attribute_value","message":"First name is required"},{"error_key":"date_of_birth","category":"invalid_attribute_value","message":"Date of birth is not a valid date"}]},"nested":{"errors":[{"error_key":"contractor_payments","category":"nested_errors","metadata":{"contractor_uuid":"72ae4617-daa9-4ed7-85e0-18ed5d0ee835"},"errors":[{"error_key":"hours","category":"invalid_attribute_value","message":"Ella Fitzgerald is paid fixed wage and hours cannot be set on a contractor payment"}]},{"error_key":"contractor_payments","category":"nested_errors","metadata":{"contractor_uuid":"2d7bf62c-babf-4a12-8292-340e2d9cab28"},"errors":[{"error_key":"wage","category":"invalid_attribute_value","message":"Isaiah Berlin is paid hourly and wage cannot be set on a contractor payment"}]}]},"compensation_invalid_rate":{"errors":[{"error_key":"rate","category":"invalid_attribute_value","message":"Rate is not a valid number"}]},"compensation_invalid_payment_unit":{"errors":[{"error_key":"payment_unit","category":"invalid_attribute_value","message":"Payment unit must be one of Hour, Week, Month, or Year"}]},"compensation_already_processed":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Compensation has already been processed on payroll."}]}},"title":"Unprocessable-Entity-Error-Object"}}}}}}
\ No newline at end of file
diff --git a/docs/api/delete-v-1-contractors-contractor-uuid.api.mdx b/docs/api/delete-v-1-contractors-contractor-uuid.api.mdx
new file mode 100644
index 000000000..545f6ae03
--- /dev/null
+++ b/docs/api/delete-v-1-contractors-contractor-uuid.api.mdx
@@ -0,0 +1,71 @@
+---
+id: delete-v-1-contractors-contractor-uuid
+title: "Delete a contractor"
+description: "A contractor can only be deleted when there are no contractor payments."
+sidebar_label: "Delete a contractor"
+hide_title: true
+hide_table_of_contents: true
+api: eJztXOtvGzmS/1e4fR+SAGrZVpzH6NNlY2fXwGXGmCSXW3iCNtWsljjuJjskW7bG8P9+KD76JaljyfbeYTADDJJIZPHHYlWxXtRtpCGtFDeraHpxG72XRUnF6l2agtbvKrOIphff7r6NIgY6Vbw0XIpoGr0jqRRG0dRIRVIqiBT5isyAMMjBACPXCxDELEABoQqIkO0JJV0VIIwe/yZ+EzqVJUzJZfO9nhZU0DlcRqPoJp5X2siYCwNzRXH52KxKiKYXERQzYAxY9G0UyRLct2csmkYORbw8iltUW39PqoqzFnWlr+k8mhpVwShSoEspNOhoehtNDo/xj+7uf5bkvRQGhInuRtHx5iGGfJCVYLjFzwsgCr5XoJE1CrSsVAqESdBESEPghmszJh/pFRBdKUDGkVLJJWfAyJcvZyeEa7KkOWfj30Q0ilK/+vQ2omWZ89Ru/eB3jWvfRjpdQEEHQJHfBCEPxXV2ctCFFo0idzSRnP0OqYmQl98rroDZ41JKKo2HVSo8LsMdi/3n09swmypFV9Eo4gaK9ufbqSZXgBNSamAu1WrLGnZUQ04bxcU86ov2pxJSnnHQKMN+z3Y6kWlaKT0mn1clT2mer4hZcE2uYEU4A2HcLBxPjVF8Vhk4KKmiBRhQREFOkc1GNiTHKD816h2gIQUcS2TmKRE8zEAqHJL2yOdKViUXc02oYFZfZ0Aq7dDMKp4zkqIiFH78ggqWczEnXJCVrBRpqZ/FXIDWdA4/hnwegDAwlOea0JmsTIupMZmDANWw05MOKHWlMpo6pFQQEAyBI+fwP1RhuKFFmbtzFtIkGUp4W7AuOucfeYlvy8u0NbG1uWiLglxTpx92wji6+4ZADDc5OCWLrZLFp7ho/IuTWof2eDJZV8svolQS7S2d5UBOheFm5cwGsoOuyIKWJYjappKZZCs8eXs0Hp+1r5QLf+Sa6CpdEKrJJRdWPZNaKJMlzSu4HBGpLLlAIbMHxCrwvK5n1sb1ckw+gVOJi1O3zHvHQw762/OFMaWeHhwwmeqxtazjVBYHwU7HJV0pmef2+wMLM07r6S/IvOIMSCYVKaSCIDEPsnibWets31/MDcz9y2r/+a02Ocuahbgml8IatcSd4+XIgnNnRa55ngeRJ5S4keTSDyX+kFbkmpsFAatUXjH+31wOiMJQRg3dJIpdGO+DcivIYUmFITgPaXoBWXlN9uafC2J1mktvNrxFmuUwJh+kIv5GGnVIWHyWVZfuzwRRXdqzDZ+gW3rp2D9rPC10rKSAXzJ7lQ3vpahyw8sc3FqoRz3FCx+vK1v4ZgeV7q6tuZiHlXEaZYzjVzQ/b63knOwNazuG/FhqfqaF1SArJo6jZkHbYpNK5Zx4pomRVhpaDP7xCl8E/15BYx6UtZvNepais96ZkkVD8KKhKKo8j77V46oyMXJ4YMfObRqgDTUwNKTlhXz00h9/5WYR/yIgdpdfdLd91EcvO24oHs3d6K8z/zOcOVLaemF3+fAVjY+N5m30R/jgtTEmZwY/LqXWHF0sI8mCLoHUdiiHJeQaz85fI+GiqM1KlHKVVjlVzx3cjt/8ImrvcMOAaEMUMKPiKqFpKithEpcLSCqRVYIBS0LyYSBCmFEN3fBgzVnrhAkfKsG4mH8Es5CMLKgmYbU61eHOoANsCYpnq4QLK7opIi2l5o+K7F/oBuCqxK+KNyeGLjMgdn0ObEzOc6AaSLqA9Mo5KeixejiEFjhRj7dvgeYKKFslgeKTbgDZ6xckMwDR7GMDwIJrtFCJkpVBtRmICt2IRFTFDNRmiD0nvwP0VzefuPmoE+Ha9bi8JCSpFBmf6xpa7WvuxLX12W0w7wzBIzVECiCNM1tU2rQdi83Awm4zqk3QliTnBTcDCDcM3pmFHxCxp0EsDaIXssoZYqaeszXmpATFJWvwgmAJ89ZyC8p6yEZsm3l5Khj6g9DSHBtBmQUV5CUppDALjT5hVplKgcOXujRqwgWrtFGrREMOKUp3IihPdZJKBknjmG1F3IzenZ8/41yCczeI4/0Q+mWeHmAQTfhe0RxvkdeE8Tmvzc4AXB0A6HvA1Tx1Y3dH+4mnFqteB3vswTqshheQyCxLSpnzdJUIWtzzrIu9mFhsOt8+iEpYjQJW6wtNU1XRPFHDOtMZtoPlfufmEZxXc2yWoylHz6rGQyxADnoL8BLs5Zr4RMrQ7dibugva9065GdDU8CVCdjRcjOsxEFyAyCwLWZ1tmKEoc7kC0Pc59nrw7md/GqbaIsu9JWBGcypSSKryB/Zy+209hOo9FTY9Stnv9tjdanr42Bcy5wytOv7vAAe3wjqij+kV+SJX7UZYl4J4BHgD+cPfDg3TxU8Gq66/WE96E7ARKb3LpgBlVQrYCrW+HmsxexJRPHNjSCBBMOzSrRyGxSfFTFKFbngY95j8CzqMDj+pl6ohOQhrm3lEBJ9t7pFrm+yxYSkXnSwwJpd7N5pzKxIQmD9KWjVKDMIGsPVH7q6mTUHWxnuNf+OwMKuwVsrR9jm8jcIG/E/px/b2uOGa04Yq67fTzICr697HC1iftTv/zmu/+tkGes8aNW5SEzZPSbyiLEEYv4uQWrwv/s74ByHvUPoh5jC6CWmw5JDMldQa0x1hcQE2GBjydfyI3d0dsDFC7VGEuKAHyXoteCILWan7OIb7XXX/ROotzREwp4Yv+wzyOp7iPZg/or05d/RbANwStXpkSv4BIvE4HtXSYdbHL78WkvuiG+YWzox26fQGo3M7GFbIaG5AbUGbeCrDcfuDgHNNZoDGrQYcSi09qDbVyLV1AD3YShSS8Yxbsx0gh2zmY4INFaNy7bAdAMfJDsudodSglt6K65U2UNSDgg3v+wbWCugkk6qgQ9F+d/xDDFCXUqPVgtj0pMdZ0BteVEUfp65USXHPTwj19CYFQC/CY8CTODo8tFzNpbyqyiFePiGw4HCFGMD2CT3XL8ZRt/bV1HUuekn3OnyIernysH6M/4yPJi9ti0PboM1ymV6Bqi9/m3TjIpM7CX+P2kZn2EqEd4Q7eUAuiFQMFN5PqhJBPfrbd2uv4xzeT304GkxVPs2mKGtcU73fdnowh/eUAcNSamLozVNuC/1C64D79YihN8Sut98e12HfQxRdTtg1iTz6NjtiGCxWyEI/QC47oDdvUlcacxE7ptjvsymOTS2eePsS/OEWGkgOsq5mdldSrB1NnbMbcs3Xpu+TqquJkECE1Is3MUS0DXBzKz8Ubadc1uNfWM1bY5tCp+kiMQsFeiFzloC/fKJW/a6PwG4Laqy78yrwBUXApm2WlOfUF/PQ48+XQGxu/t37f5LPARwJN2OrfiSltskIvCS/cgXkTIzIR7kE8lli56kiJ9SWI9sX5hKU3lVNw9w6fAlEerUjmxejxkBR2iDWSO/SEdr0c1QonOhyyMrEMovt955gCDP5XFAjFab2KM/vl9ajPN8npUd53g50+wBC3B2yYwuqk/rbx8+muGpuXfDAw61XI7Y9yAOqxUBBgSduS+chedBMmUGGxLBPAJlOBFwj0eDo8RtgCeN6VikNtpjU1K23bKw9egfta+UWQt1qo/czoHvbSNyjs/SkBbrXSzp64u2xQ5bRyWQSU3b4Nj4G+iamh69p/Obozeu3b9OXs6M3Pw1sOlArbLV7H9/fFfjc/Pr+dFZjSk441sLJiSs+j8h7LEqPoz5XAgrsj6j2ikAcCjc/mD7nUWfNE4WA8pn3tl2J/9k42LD/q37jUZRxwfUi8VlOvF2xkcC5Xk+Qk/YMcjG+kajZhjSL93KCuXReTGJJ/8gL00YBmORo91P8iMLDRZpXDC26I4S2RYHWazKTuhalh61hifQpuy6d3a9enIas9VniayXFnPjou7/GH7zcQ8ydSQaBsXbI4v3BS1d0fQ7j+ZgcTV4ev3qxQcUWUsDe/RDnODt0QwQlPzrsFEqx4yDn6VCmYaPysMp1gMO20mNLdbB8ZxagW+29TbLKlXB6Afx9EtkbYQ33EXxuv51pejLs6btzwd5s5ykHHc/ldau9wfZyDTU3NLH93tkEXDJ08/UFop0jeJwF6k36m8z5sPrHd74feP/r0K7iHe1gpVDR9MBNh9/bOXtFINgTDIzYr8gzP+dZ85JASFKCKrgxYZQOt8qMap4+cXRObZtfsN/B27ROxm4hrABgunUP+TBwg/8R+Hbtm8O37M5+vTPDv2JbeLAzc1sWVd5lVU2jxmF9Ua2he8IcvfUktifJezlnhwBz+PaVIU0N0VVZSmUIs85RvupX+L05CntwFdBHz0P3mh9akP2rz141a6hdjCttkv0aXj7gXCJ6bS9r1orZ+yFLZlyZxe6rnNi6ekbs9Do09jeobZtwDqC1Ofcr09a9oPs48d55fzOhcPz66E3MKP0pPgb2Jn77Cg7jo7fAXrFDgLcvXw2YNFsN2yMozXNKPnDzxxxTccx2/FI05hiuEVRYK8OLXjVMA/qINkTsv/3dEOg8Mqcm7M0sez1J4xmdZfExPZrEbyc/TeKXx4cwYT+ldDZ5O8Cp/azQmaacLsjfQeVc1GxCvuQry6Jr/3rlfhwKPjUI7fzpOu8x3LezvVdrsIXVe6NtSW83XW5EUgeXYrA/tDNs72gNZ/ciRoIl2BH5CnCFqSZhFvbp3b+AbkIdkia17X3kUCksNGTtZetC7T4d7bxWjLc0u9sJdI54Wy0c7kFP8CrdZqx5nUb/E//DPnJ/d34W/3edJuPY7L8Ayqy30Lyf7L+SAFEVuNTkcPIqPnwdH72K7K8BZLTKDapZ8/ld/y3BCWIpuPBP39BqxshVRt6dn4UMG6Fay5TbMqv11u3TNRyAr/XsuzWBR82bZqKRG9N6CPpMk4uCC1uga9He8dUkLXnsZ3Ix/w9PMG59/AJh4BM8Fy55Dq//sIDlbkntxdPlCYYB9tm8f83SzO281HIvZrYdyx3+IsNNrEugV0D1KkYgsVyCUpxB/QMIeHw3BoS2vjKKhJPsrT+qYF+uVL0fV8CNdue5n0uoByPW9qBtsOoJAR7uwqeRWpAt26bRwfLooPXrDQe3PS7fodhihdtLe6VylGh/3rTk7rhjBoU987WTOIFCRl02OnqxS5Ph17itLYQ30jxXkg3QLPFr3HX4zY1PeMCuJW/DL2/Ux46LBy3Ff8+AKqu3/YeMlkRs39wQWpkFBlqhoDSKPtkugIes4ChsWcDG0K4EHCyatTyokXj4Ic/fthmjCE2E/iX7BGrJU2hxutFW+yz0wA48YLg0GuDY/hvz9dpPXXvKBHkqC1vGsDieaXLqpZqEzhk0FkymFV4vdht/84/NqUtLeA0/CauSX/FBsI89XYofRcV/+5+NZCA3SqlNQUWHjgu+umrfgX3bvHX/9/3MipcCAzfmoMwpt+JiBf/W6+NFtDyK2oETMmDat3zfsAVVGxx+e4um/ovK7+7w4+8V4B168Q2tgLJdM1ZtGbe3HYumGc01DDDj+a/eOr4gg0Z0417CmzexapmhyD/AWzPgrpfWXY67gfxTX3lbeOt4uNnNqFndXBBof0rT+m7tBx0698LJ6X+dfj7Fp6Vdi1VbKP+X1tvo7inf3roRn+UViLu7+tAN/tt6YHf/C2ofYgg=
+sidebar_class_name: "delete api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+A contractor can only be deleted when there are no contractor payments.
+
+scope: `contractors:manage`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/delete-v-1-employee-benefits-employee-benefit-id.ParamsDetails.json b/docs/api/delete-v-1-employee-benefits-employee-benefit-id.ParamsDetails.json
new file mode 100644
index 000000000..c6d58d248
--- /dev/null
+++ b/docs/api/delete-v-1-employee-benefits-employee-benefit-id.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"employee_benefit_id","in":"path","required":true,"schema":{"type":"string"},"description":"The UUID of the employee benefit."},{"name":"X-Gusto-API-Version","in":"header","required":false,"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.","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"}}]}
\ No newline at end of file
diff --git a/docs/api/delete-v-1-employee-benefits-employee-benefit-id.RequestSchema.json b/docs/api/delete-v-1-employee-benefits-employee-benefit-id.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/delete-v-1-employee-benefits-employee-benefit-id.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/delete-v-1-employee-benefits-employee-benefit-id.StatusCodes.json b/docs/api/delete-v-1-employee-benefits-employee-benefit-id.StatusCodes.json
new file mode 100644
index 000000000..8c4f80195
--- /dev/null
+++ b/docs/api/delete-v-1-employee-benefits-employee-benefit-id.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"204":{"description":"No Content"},"404":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided UUID is valid.\n"},"422":{"description":"Unprocessable Entity \n \nThis 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.\n","content":{"application/json":{"schema":{"description":"Unprocessable Entity\n \nThis 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.\n","type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["error_key","category"],"properties":{"error_key":{"type":"string","description":"Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error."},"category":{"type":"string","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."},"message":{"type":"string","description":"Provides details about the error - generally this message can be surfaced to an end user."},"metadata":{"type":"object","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.","oneOf":[{"type":"object","description":"multiple entities","required":["entities"],"properties":{"entities":{"type":"array","items":{"type":"object","description":"single entity","additionalProperties":true,"properties":{"entity_type":{"type":"string","description":"Name of the entity that the error corresponds to."},"entity_uuid":{"type":"string","description":"Unique identifier for the entity."},"valid_from":{"type":["string","null"]},"valid_up_to":{"type":["string","null"]},"key":{"type":["string","null"]},"state":{"type":["string","null"]}},"title":"Metadata-With-One-Entity"}}},"title":"Metadata-With-Multiple-Entities"},{"type":"object","description":"single entity","additionalProperties":true,"properties":{"entity_type":{"type":"string","description":"Name of the entity that the error corresponds to."},"entity_uuid":{"type":"string","description":"Unique identifier for the entity."},"valid_from":{"type":["string","null"]},"valid_up_to":{"type":["string","null"]},"key":{"type":["string","null"]},"state":{"type":["string","null"]}},"title":"Metadata-With-One-Entity"}]},"errors":{"type":"array","description":"Will only exist if category is `nested_errors`. It is possible to have multiple levels of nested errors.","items":"circular(Entity-Error-Object)"}},"title":"Entity-Error-Object"}}},"x-examples":{"bank_account_delete_unfunded_payments":{"errors":[{"error_key":"base","category":"invalid_operation","message":"FundingMethod has unfunded payments"}]},"bank_account_verify_incorrect_deposits":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Your bank account cannot be verified. Please check the test deposit amounts."}]},"bank_account_verify_already_verified":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Your bank account has already been verified."}]},"bank_account_missing_routing":{"errors":[{"error_key":"routing_number","category":"invalid_attribute_value","message":"Routing number is required."}]},"payment_configs_missing_parameter":{"errors":[{"error_key":"base","category":"missing_parameter","message":"At least one parameter must be provided"}]},"payment_configs_invalid_fast_payment_limit":{"errors":[{"error_key":"fast_payment_limit","category":"invalid_attribute_value","message":"Fast payment limit should be a number"}]},"pay_periods_invalid_end_date":{"errors":[{"error_key":"end_date","category":"invalid_parameter","message":"End date cannot be more than 3 months in future"}]},"company_industry_selection_naics_code_required":{"errors":[{"error_key":"naics_code","category":"invalid_attribute_value","message":"Naics code is required."}]},"company_industry_selection_naics_code_invalid":{"errors":[{"error_key":"naics_code","category":"invalid_attribute_value","message":"Naics code must be equal to 6 digits."}]},"company_industry_selection_sics_codes_invalid":{"errors":[{"error_key":"sic_codes","category":"invalid_attribute_value","message":"Sic codes must be equal to 4 digits"}]},"time_off_policy_name_required":{"errors":[{"error_key":"name","category":"invalid_attribute_value","message":"Name is required."}]},"time_off_policy_unlimited_invalid_accrual_rate":{"errors":[{"error_key":"accrual_rate","category":"invalid_operation","message":"Accrual rate must be blank for unlimited policies."}]},"time_off_policy_pending_requests":{"errors":[{"error_key":"time_off_policy","category":"invalid_operation","message":"Cannot deactivate policy with pending time off requests."}]},"time_off_policy_employees_required":{"errors":[{"error_key":"employees","category":"invalid_attribute_value","message":"Employees are required."}]},"time_off_policy_unlimited_balance_update":{"errors":[{"error_key":"base","category":"invalid_attribute_value","message":"Can not adjust balances for unlimited policies."}]},"holiday_pay_policy_already_exists":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Company already has a holiday pay policy."}]},"holiday_pay_policy_not_exists":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Company does not have a holiday pay policy, please create one"}]},"holiday_pay_policy_invalid_employees":{"errors":[{"error_key":"employees","category":"invalid_attribute_value","message":"Invalid employee uuids provided."}]},"onboarded_employee":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Cannot delete onboarded employee"}]},"invalid_attribute":{"errors":[{"error_key":"base","category":"invalid_operation","message":"There is an error in the request body."}]},"company_cannot_enable_contractor_only":{"errors":[{"error_key":"contractor_only","category":"invalid_attribute_value","message":"Contractor only cannot be enabled for existing companies."}]},"company_missing_parameter":{"errors":[{"error_key":"base","category":"missing_parameter","message":"contractor_only is required."}]},"starting_after_uuid_invalid":{"errors":[{"error_key":"starting_after_uuid","category":"invalid_attribute_value","message":"Parameter 'starting_after_uuid' does not correspond to a valid event."}]},"resource_uuid_invalid":{"errors":[{"error_key":"resource_uuid","category":"invalid_attribute_value","message":"Parameter 'resource_uuid' does not correspond to a valid resource."}]},"payroll_gross_up_invalid_net_pay":{"errors":[{"error_key":"net_pay","category":"invalid_attribute_value","message":"Net pay must be a number."}]},"payroll_accruing_hours_invalid":{"errors":[{"error_key":"base","category":"invalid_attribute_value","message":"Hours cannot be negative."}]},"payroll_cannot_cancel":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Payroll cannot be canceled."}]},"frozen_payroll":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This payroll has already been processed. Its data cannot be updated or altered."}]},"frozen_payroll_processing":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This payroll is being processed and cannot be updated at this time."}]},"unmodifiable_payroll_type":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This type of payroll cannot be modified or processed. It is reserved for system processes."}]},"invalid_employee_uuids_format":{"errors":[{"error_key":"employee_uuids","category":"invalid_attribute_value","message":"Parameter employee_uuids must be an array."}]},"maximum_employee_uuids_surpassed":{"errors":[{"error_key":"employee_uuids","category":"invalid_attribute_value","message":"Exceeded maximum of 100 for lookup."}]},"invalid_employee_uuid":{"errors":[{"error_key":"employee_uuids","category":"invalid_attribute_value","message":"Invalid Employee UUID(s).","metadata":{"entities":[{"entity_type":"Employee","entity_uuid":"invalid-uuid-123"}]}}]},"payroll_blocker_missing_bank_info":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must have a bank account in order to run payroll.","metadata":{"key":"missing_bank_info"}}]},"payroll_blocker_missing_employee_setup":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must add employees in order to run payroll.","metadata":{"key":"missing_employee_setup"}}]},"payroll_blocker_missing_federal_tax_setup":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must complete federal tax setup in order to run payroll.","metadata":{"key":"missing_federal_tax_setup"}}]},"payroll_blocker_missing_bank_verification":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company bank account must be verified in order to run payroll.","metadata":{"key":"missing_bank_verification"}}]},"payroll_blocker_suspended":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company is suspended and cannot run payroll.","metadata":{"key":"suspended"}}]},"submission_blocker_missing_selection":{"errors":[{"error_key":"submission_blockers","category":"invalid_attribute_value","message":"Submission blockers selections required"}]},"submission_blocker_invalid_option":{"errors":[{"error_key":"submission_blockers","category":"nested_errors","metadata":{"blocker_type":"fast_ach_threshold_exceeded"},"errors":[{"error_key":"selected_option","category":"invalid_attribute_value","message":"Selection is not available to resolve Fast ACH Threshold Exceeded. Please choose one of Wire In, Move To Four Day"}]}]},"invalid_version":{"errors":[{"error_key":"base","category":"invalid_resource_version","message":"You are attempting to update a resource using an out-of-date version."}]},"signatory_email_required":{"errors":[{"error_key":"email","category":"invalid_attribute_value","message":"Email is required"}]},"signatory_company_already_has_signatory":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Cannot have more than one signatory in a company. Please remove the existing signatory before adding a new one."}]},"mixed_disbursement_errors":{"errors":[{"error_key":"disbursements","category":"nested_errors","metadata":{"contractor_payment_uuid":"invalid-uuid-1"},"errors":[{"error_key":"contractor_payment_uuid","category":"not_found","message":"Disbursement not found."}]},{"error_key":"disbursements","category":"nested_errors","metadata":{"contractor_payment_uuid":"d0dfa222-ad08-4ea7-a06a-717688c3b179"},"errors":[{"error_key":"payment_method","category":"invalid_attribute_value","message":"Payment method must be one of: Direct Deposit, Check."},{"error_key":"payment_status","category":"invalid_attribute_value","message":"Payment status is not valid for payment method 'InvalidMethod'."}]}]},"not_found":{"errors":[{"error_key":"request","category":"not_found","message":"The requested resource was not found."}]},"finish_onboarding_incomplete":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Company is not ready to exit onboarding."}]},"company_location_validation":{"errors":[{"error_key":"street_1","category":"invalid_attribute_value","message":"Must include a street address"},{"error_key":"city","category":"invalid_attribute_value","message":"Must include a city"},{"error_key":"state","category":"invalid_attribute_value","message":"State is in the wrong format"},{"error_key":"zip","category":"invalid_attribute_value","message":"Please enter a valid zip code (e.g. 12345)."},{"error_key":"phone_number","category":"invalid_attribute_value","message":"Phone number must be 10 digits"}]},"conflict":{"errors":[{"error_key":"request","category":"duplicate_operation","message":"A resource with these attributes already exists."}]},"invalid_parameter":{"errors":[{"error_key":"request","category":"invalid_parameter","message":"The provided parameter is invalid or missing."}]},"flow_invalid_entity":{"errors":[{"error_key":"entity_type","category":"invalid_attribute_value","message":"Invalid flow entity"},{"error_key":"entity_uuid","category":"invalid_attribute_value","message":"Invalid flow entity"}]},"flow_nested_options_errors":{"errors":[{"error_key":"options","category":"nested_errors","metadata":{"flow_type":"company_forms"},"errors":[{"error_key":"form_types","category":"invalid_attribute_value","message":"Supplied value 'invalid' contains no permitted values"}]}]},"basic":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must complete all onboarding requirements in order to run payroll.","metadata":{"key":"needs_onboarding"}}]},"contractor_payment_invalid_wage":{"errors":[{"error_key":"wage","category":"invalid_attribute_value","message":"Wage must be greater than or equal to 0."}]},"contractor_payment_cannot_cancel":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Payment has already been processed and cannot be cancelled. Contact support directly."}]},"time_off_request_cannot_delete":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This time off request cannot be deleted."}]},"resource":{"errors":[{"error_key":"first_name","category":"invalid_attribute_value","message":"First name is required"},{"error_key":"date_of_birth","category":"invalid_attribute_value","message":"Date of birth is not a valid date"}]},"nested":{"errors":[{"error_key":"contractor_payments","category":"nested_errors","metadata":{"contractor_uuid":"72ae4617-daa9-4ed7-85e0-18ed5d0ee835"},"errors":[{"error_key":"hours","category":"invalid_attribute_value","message":"Ella Fitzgerald is paid fixed wage and hours cannot be set on a contractor payment"}]},{"error_key":"contractor_payments","category":"nested_errors","metadata":{"contractor_uuid":"2d7bf62c-babf-4a12-8292-340e2d9cab28"},"errors":[{"error_key":"wage","category":"invalid_attribute_value","message":"Isaiah Berlin is paid hourly and wage cannot be set on a contractor payment"}]}]},"compensation_invalid_rate":{"errors":[{"error_key":"rate","category":"invalid_attribute_value","message":"Rate is not a valid number"}]},"compensation_invalid_payment_unit":{"errors":[{"error_key":"payment_unit","category":"invalid_attribute_value","message":"Payment unit must be one of Hour, Week, Month, or Year"}]},"compensation_already_processed":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Compensation has already been processed on payroll."}]}},"title":"Unprocessable-Entity-Error-Object"},"examples":{"Basic":{"value":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must complete all onboarding requirements in order to run payroll.","metadata":{"key":"needs_onboarding"}}]}},"Resource":{"value":{"errors":[{"error_key":"first_name","category":"invalid_attribute_value","message":"First name is required"},{"error_key":"date_of_birth","category":"invalid_attribute_value","message":"Date of birth is not a valid date"}]}},"Nested":{"value":{"errors":[{"error_key":"contractor_payments","category":"nested_errors","metadata":{"contractor_uuid":"72ae4617-daa9-4ed7-85e0-18ed5d0ee835"},"errors":[{"error_key":"hours","category":"invalid_attribute_value","message":"Ella Fitzgerald is paid fixed wage and hours cannot be set on a contractor payment"}]},{"error_key":"contractor_payments","category":"nested_errors","metadata":{"contractor_uuid":"2d7bf62c-babf-4a12-8292-340e2d9cab28"},"errors":[{"error_key":"wage","category":"invalid_attribute_value","message":"Isaiah Berlin is paid hourly and wage cannot be set on a contractor payment"}]}]}}}}}}}}
\ No newline at end of file
diff --git a/docs/api/delete-v-1-employee-benefits-employee-benefit-id.api.mdx b/docs/api/delete-v-1-employee-benefits-employee-benefit-id.api.mdx
new file mode 100644
index 000000000..34a331650
--- /dev/null
+++ b/docs/api/delete-v-1-employee-benefits-employee-benefit-id.api.mdx
@@ -0,0 +1,73 @@
+---
+id: delete-v-1-employee-benefits-employee-benefit-id
+title: "Delete an employee benefit"
+description: "Employee benefits represent an employee enrolled in a particular company benefit. It includes information specific to that employee's enrollment."
+sidebar_label: "Delete an employee benefit"
+hide_title: true
+hide_table_of_contents: true
+api: eJztXFtvG7mS/ivc3gcngFq+xLmMn04mdvYY2MwYk2RzDpygTTVLEsfdZIdky9YY/u+LKpLdrdbFlmNjsYMMMAgskcWPxbqxqqib5Dqd1NbpVCoHE8Od1Cp18wqSo/MEyhEIASIZJLyqukNs8m2QOD6xOOykrAo9B2C/goKxdPSlAVtpZcEmRzfJwd4h/iPA5kZWSCA5Sn7T7J1WDpRLbgfJ4eohjr3XtRLsq2Lsq/o0BWbgew3WgWAGrK5NDkxosExpx+BaWjdkH/glMFsbYG4KrDJ6JgUI9vnz6TGTls14IcXwq6JlDw6Wl/2sKqNzsJaPCmAnykk3bxBIy0o+Z1NeVaDY1RQUrTLSYs70mM11bSJGlmvluFSWgTHaWGbrfMq4ZRdSEYiMO2fkqHaQzXhRw8WAaUPkIoUxl4VlogbmNOOqnakr8EdxMWQfwe/0/MQv8447mGgjwX57NnWuske7u0LndkhHPcx1uRuPNq343OiioO93CWaaN9Ofs0ktBbCxNqzUBpgAh4CQeYMkD6d3dIPiUcic8Oz+aZGJN4nNp1Dy+3H3J3P7zPU6mOjRn5C7BPXpey0NCNJLQoJaVhmE6qRXs/D50U2czY3h82SQSAdl9/P1VLNLwAkB5XzNGjSqJWedkWqSDHoH/bGCXI4lWDzIoIw0nek8r40dsk/zSua8KObM4dFfwpxJAcr5WTi+OcPdihteggMUgIKj/jvdkhyiMjeot4CGFHAsipenxNDKRFLRegQpYxOj60qqiWVcCZZzxUbAauvRjGpZCJajHJRh/JQrUUg1YVJ56e0Y0SE7HbcLScsuFBm2zJ/jxYDA+bNiV7IoosgzzvxIdhGGsnBIc3Yl3ZSBN1n+S2JNifo2gbs5cxb3G6SR8ZGuXefsUjYBBaY9tUA6MsPWZsxzzxCuGCiB/DEBheOCO75KFBdhvIvKbaCAGVeO4TykGQRkHjQ5uACpGOm01MFsBIs0KmDI3mvD4JqXVQGDBRKEj1h14f/NENUFnW38pK6luPDsH7XOZJgMEq3g93FydH7XXsq6cLIqwK+FetRTvPjxsrLFb7ZQ6cW1rVSTuDJO40JI/IoXZ52VnKlh5dqeIXdLzW+8JA0iMfEcdVPeFZtcGx8SCMucJmnoMPjuFT4r+b2G1jwYspvtekTRW++x0WVL8LylqOqiSL414+oqc3rzwAU7t2qAddzBpiG3g8RJV+DOPgTpT79IN01/V5B655fcrh/1IciOH4pHczv4eeZ/hzNHSmsd9iIfvqDx0aqY+wCXyY1uY8hOHX5caWslhlhOsymfAWvsUAEzKCyeXXAj0VE0ZiXJpcnrgptnHm5KwU/6Ownc86S7wxUDvEBfp8Hm0gZHXF1mPM91rVwmoAAHWa3GtRIgsorPS1BuIYg5X4g1khG30A1MjpKlYC3puLnkfa2EVJMP4KZasCm3LK7GmtXoDBaAzcDI8TyTikQ3R6SVtvJRkf0bwwBclYVV0XPi7WUEjNaXIIbsrABugeVTyC99kIIRa4DDeIkT0bWv2wIvDHAxzyLFJ90AsjcsyEYAqt3HCoCltGihMqNrh2qzHlgYkam6HIFZDbEX5C8A/cPPZ34+6kR0uwFXkIQs12osJ7aB1sSaW3FteXYXzFvH8Egd0wpYG8yWtXXdwGI1sLjbMbcuaktWyFK6DQhXDN6ahe8RcaDBiAazU10XAjHzwNkGc1aBkVq0eEGJTARruQZlM2QlttW8PFEC40HoaA7doNyUK/aClVq5qcWYcFy72oDHl+uy4gqVW9TWmXlmoYAcpTtTXOY2y7WArA3M1iJuR2/Pz99wLsO5K8TxfgjDMk8PMIomfK95gV7kFRNyIhuzswGujQDsPeBamfux26P9KHPCapfBHgawHquTJWR6PM4qXch8nile3vOsywcxsVx1vn0QtSKNAtHoC89zU/MiM5t1ZmHYFpb7rZ/HcF7DsVGBphwjqwYPI4AS7BrgFZBzzUIiZZN37E3dBu07r9wCeO7kDCF7Gv6OGzAwXIDp8ThmddZhhpCltPc59mbw9mcfs6GWcQP3l4ARL7jKIaurO+zlem+9CdU7rihDysWfdOx+Nbv52Ke6kAKtOv7vAcewggLRx4yK3nlj0oQRFFKwgAA9UDj89dCUdk8Hq0kxUyS9CtiAVSFkM4CyqhWshdq4x0bMnkQUT/0YFkkwvHbZTg6D8Gk10txgGB7HPSb/og5jwM+apRpIHsLSZh4RwSfKPUpLyR66lkq1kAXG5HLPo/mwIgOF+SMMwpzhudMmw0vYBmz9kduraUPA3/fa+MZjEaSwJOVo+zzeVmEj/qeMY3t7XOHmrOOG4nY+dmDorn+fKGB51vb8O2vi6p0V9HZaNW5TE5SnZEFRZqBc2EVMLd4X/8L4H0K+QOlOzHF0e6XBkkM2MdpaTHfExRXQZWBTrBNGbB/uAN0Rmogi3gt6kChqwROZ6trcJzB8mKv7J1LvaI6CCXdy1mdQ0PEc/WDxiPbmzNPvAPBLNOoxNvovUFnA8aiWDrM+YfmlK3koumFu4dRZn05vMfqwQ2CFjBcOzBq0WaCy+d7+Q8ClZSNA49YAjqWWHlRKNUpLAWAAW6tSCzmWZLYj5JjNfEywsWJULR22B+A5ucBybygtmFmw4nZuHZTNoGjD+7EBWQGbjbUp+abb/uL4HzFAi5RarVaM0pMBZ8mvZVmXfZy2NhXHPT8h1JPrHACjiIABT2J/b4+4Wmh9WVebePmEwGLA1XREYMvBM/t8mCzWvtq6znkv6d5cH5Jerjyun+Kf6f7BC9zhgkEbFTq/BNM4f0q6STXWWwl/j9rKYJgkIgTCC3lAqZg2Agz6J1OrqB797fu1l3Fu3k9zOBZcXT3NprhoQ1P7sO30YG7e0xgEllIzx6+fclsYF1IAHtZjjl8zWu9he1yGfQ9R9Dlh3yTy6NtcEMNosWIW+gfkcgH06k3a2mIuYssU+302JbGpJRDvOsE7t9BC8pBtPaJdabV0NE3OblNovjT9Iam6hgiLRFizeHuHSNYBbr3yj6JdKJf1+BdXC9aYUug8n2ZuasBOdSEyCM4n6dTv+ghoW9Bg3Z5XkS8oApS2mXFZ8FDMw4i/mAGj3Pzbd/9knyI4Fj1jp36ktaVkBDrJL9IAO1UD9kHPgH3S2Fxn2DGncmTXYc7A2G3VNM5tri+RSK92RHkx7hyUFV1inQ4hHeNtP0eNwokhh65dqscpfR8IxmumnCjutMHUHpfF/dJ6XBYPSelxWXQvun0A8d4ds2NTbrPm28fPpvhqblPwwMNtVmPUHhQANWJgoMQTp9J5TB60U0YwRmLYJ4BMZwqukGgM9OQ1iExIO6qNBSomtXXrNRvrjt5C+zq5hVi3Whn9bNC9dSQWMWiXjbGvdIG7xx3QpHU0xHPhibcn9sSYHxwcpFzsvUkPgb9O+d4rnr7ef/3qzZv8xWj/9S8bNh2plVTtfkjs7wt8fn7jP73VOGLHEmvh7NgXnwfsHRalh0mfKxEF9kfUD7qBeBR+fjR9PqLG0L5aRLkTom1f4t8ZRhvWHu6mZA3l/u4jFWt6jq+47ctIMpZK2mkWspzoXbGRwIdeT5CTDgzyd3ynUbMdaxfv5QQL7aOYjEjfFYVZZwBctr/9KX5A4ZEqL2qBFt0TQttiwNolmcl9i9KPrUFE+pR9l872rhenIWtDlvjKaDVh4fbdX+MvWT1AzL1JBoV37ZjF+0tWvuj6DIaTIds/eHH48vkKFZtqBQ/uhzjD2bEbIir5/t5CoRQ7DgqZb8o0rFQeUfsOcFhXeuyoDpbv3BRsp723TVb5Ek7vAn+fRPZKWJv7CD51nwe0PRl0+v5csDfbR8pRxwt91WlvoF6uTc0N7d3+wdkEXDJ28/UFopsjeJwFmk0GT+ZjWHu3zw8D7+8OaZUQaEcrhYpmN3g6/J7mPOgGgj3BIBh9xXbCnJ32JYHSrAJTSufiKBu9yohbmT/x7ZxTm1+03zHapCBjuyusAhC244fCNXBF/BH5dhWaw9fsjr7emuFfsC082pkJlUVNCFlN26ix1ziqJXRPmKOnSGJ9kryXc/YIMIdPb5Z47pitq0obxwQFR8W8X+EP5ijuwVdAHz0P3Wt+6ED2C4peNWtTu5g01mUPa3h5j3OZ6rW9LFkrQf5hnI2kcdPtVzmmuvqY0fTmahw8KLVN+ACQbM79yrRNL+hDgvgQvL8+4HD4av91Kjj/JT0E8Tp98xL20v03IF6KPYA3L15uMGlUDXvApbQoOHsv3V8TTMUJ6vjlaMzxusZQYUmGp71qmAWMEemK2JSaAxNWXHQemVMH4vVo/OogT0d8NE4P+f5B+ubgl4P0xeEeHIhfcj46eLOBUw+zQqeWSz5lv4IppGrYhHwp5sSiq/B65X4cijE1KOvj6SbvsblvZ32v1sYW1hCNdiW923S5EklzuVQb+0MXhj34toazezdGhiXYAfsCcImpJuWm9PTu38BXoY5Jk8b2PvJVKS60ydrrjkO9XWjgX3itmK5sdh8k3Ub3X2Og4Fn2/zliuB0kf3T8xl0b+ps4kNtB8lvjQe7a809X8tOV/IAr8f8NksZ6nVI2kEK3dLafNsXEUXhav/RJRhe/xfdCTfk5zmIGKuw9UI664OLXoNAg+PoYx/uvk/ToJ6aP43zfvuDTLWhXfDYETar172hz/xaXu4b2jg3Uca/Dr+qr+hIfc3feipNJxs8uljZ6dGWkg6O4S7zyZaFN9cI3r9hcVzBYIplTRryYx55DWGIG5hLDH9TIYT10LEu0t7/40qxDmrZBqx6tBXyRYIEwJBK82JFB7PQWLBycVGT3yZi1BQz/Nq99QL/4TO62f96YxqAfN4iv8Xpb9nmkgONf6X/RDz68PTtN/6ep0BCOKXBBbqdFMuaFhf56x7i5UqrwfBoNZ4reTLC3Z6exSsO4tTqX1KpDGR96/owD8MU3vX1WGC7ItiF14Md0WL5j2XkpFTV5dGhv+fKeVzINM6Wa/GcgmHY+fo4w8Bk3esd1fMeOjLrEB38Hewcv071X6f5LfLMrYMzrwqFRaj+/vf2GT+BsBfwSuJ2n9HK8IwfNj2UsDsNTSvUMjJECGluAa187UJYyLChV3oyt/fWOQfRcd/yKBwpGJNXH2tBYxrx62iL2dnrYA3IkVCg6+yLhP0p2Z/u7Szq1e7NCa27xiLCNKuhXbQqU3SAQvJJeHlIBJQnFknk8hlL3uO7ppb4Wg1/jBtcQXknzzFDdZR3NCr/G/VvIa0M5w/ObGNO9zTG+fFsjH86/dUd9REn0YeWKsY18IsQot/j3CLghPe6/qScSKT3/ZLx2U8z5xd6GQfKRGtJ+ZAVPYc0ClM713UgxuCZLhIqNwhJLzl0tGiRoaezv449gZjKHznm0Sk+/ULBLA3cFLo3eNKW/sXRsw9SlV7VQ5Lqkijrh2LHsJKgKi02caHOEzmv0YrSN/wi/e8J9hjzY1OO4KvsDf5sipEF9tRkFKnz7j1Z+kBuVtq7kaoGOj+rVkgnvo79pf33lp7v/v3X3QUUcXLvdquCSdIlsx00wbufJbJ/koUcjGSRHq8KCb/hoxDqceHODjvWzKW5v8ePvNWCwev4NjauhPleyJELS/XSNw+4Ky7M/gm9/zu4OG9ZsLj5WV/OOkU/Cy/mVgY5/COPDi+3w/s1jjZX89XxcHag17G5dMFrsynW+W/o1pgXPe3zy3yefTpLb2/8FCy99FQ==
+sidebar_class_name: "delete api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Employee benefits represent an employee enrolled in a particular company benefit. It includes information specific to that employee's enrollment.
+
+When the application has the `employee_benefits:write:benefit_type_limited` data scope, the application can only delete employee benefits for benefit types that are permitted for the application.
+
+scope: `employee_benefits:write`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/delete-v-1-employee.ParamsDetails.json b/docs/api/delete-v-1-employee.ParamsDetails.json
new file mode 100644
index 000000000..c8985cf67
--- /dev/null
+++ b/docs/api/delete-v-1-employee.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"X-Gusto-API-Version","in":"header","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"},"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."},{"name":"employee_id","in":"path","description":"The UUID of the employee","required":true,"schema":{"type":"string"}}]}
\ No newline at end of file
diff --git a/docs/api/delete-v-1-employee.RequestSchema.json b/docs/api/delete-v-1-employee.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/delete-v-1-employee.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/delete-v-1-employee.StatusCodes.json b/docs/api/delete-v-1-employee.StatusCodes.json
new file mode 100644
index 000000000..5f01c08cf
--- /dev/null
+++ b/docs/api/delete-v-1-employee.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"204":{"description":"successful"},"404":{"description":"Not Found\n\nThe requested resource does not exist. Make sure the provided UUID is valid.\n","content":{"application/json":{"schema":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided ID/UUID is valid.","type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["error_key","category"],"properties":{"error_key":{"type":"string","description":"Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error."},"category":{"type":"string","description":"Specifies the type of error. The category provides error groupings and can be used to build custom error handling in your integration."},"message":{"type":"string","description":"Provides details about the error - generally this message can be surfaced to an end user."}}}}},"x-examples":{"not_found":{"errors":[{"error_key":"request","category":"not_found","message":"The requested resource was not found."}]}},"title":"Not-Found-Error-Object"}}}},"422":{"description":"cannot delete onboarded employee","content":{"application/json":{"schema":{"description":"Unprocessable Entity\n \nThis 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.\n","type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["error_key","category"],"properties":{"error_key":{"type":"string","description":"Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error."},"category":{"type":"string","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."},"message":{"type":"string","description":"Provides details about the error - generally this message can be surfaced to an end user."},"metadata":{"type":"object","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.","oneOf":[{"type":"object","description":"multiple entities","required":["entities"],"properties":{"entities":{"type":"array","items":{"type":"object","description":"single entity","additionalProperties":true,"properties":{"entity_type":{"type":"string","description":"Name of the entity that the error corresponds to."},"entity_uuid":{"type":"string","description":"Unique identifier for the entity."},"valid_from":{"type":["string","null"]},"valid_up_to":{"type":["string","null"]},"key":{"type":["string","null"]},"state":{"type":["string","null"]}},"title":"Metadata-With-One-Entity"}}},"title":"Metadata-With-Multiple-Entities"},{"type":"object","description":"single entity","additionalProperties":true,"properties":{"entity_type":{"type":"string","description":"Name of the entity that the error corresponds to."},"entity_uuid":{"type":"string","description":"Unique identifier for the entity."},"valid_from":{"type":["string","null"]},"valid_up_to":{"type":["string","null"]},"key":{"type":["string","null"]},"state":{"type":["string","null"]}},"title":"Metadata-With-One-Entity"}]},"errors":{"type":"array","description":"Will only exist if category is `nested_errors`. It is possible to have multiple levels of nested errors.","items":"circular(Entity-Error-Object)"}},"title":"Entity-Error-Object"}}},"x-examples":{"bank_account_delete_unfunded_payments":{"errors":[{"error_key":"base","category":"invalid_operation","message":"FundingMethod has unfunded payments"}]},"bank_account_verify_incorrect_deposits":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Your bank account cannot be verified. Please check the test deposit amounts."}]},"bank_account_verify_already_verified":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Your bank account has already been verified."}]},"bank_account_missing_routing":{"errors":[{"error_key":"routing_number","category":"invalid_attribute_value","message":"Routing number is required."}]},"payment_configs_missing_parameter":{"errors":[{"error_key":"base","category":"missing_parameter","message":"At least one parameter must be provided"}]},"payment_configs_invalid_fast_payment_limit":{"errors":[{"error_key":"fast_payment_limit","category":"invalid_attribute_value","message":"Fast payment limit should be a number"}]},"pay_periods_invalid_end_date":{"errors":[{"error_key":"end_date","category":"invalid_parameter","message":"End date cannot be more than 3 months in future"}]},"company_industry_selection_naics_code_required":{"errors":[{"error_key":"naics_code","category":"invalid_attribute_value","message":"Naics code is required."}]},"company_industry_selection_naics_code_invalid":{"errors":[{"error_key":"naics_code","category":"invalid_attribute_value","message":"Naics code must be equal to 6 digits."}]},"company_industry_selection_sics_codes_invalid":{"errors":[{"error_key":"sic_codes","category":"invalid_attribute_value","message":"Sic codes must be equal to 4 digits"}]},"time_off_policy_name_required":{"errors":[{"error_key":"name","category":"invalid_attribute_value","message":"Name is required."}]},"time_off_policy_unlimited_invalid_accrual_rate":{"errors":[{"error_key":"accrual_rate","category":"invalid_operation","message":"Accrual rate must be blank for unlimited policies."}]},"time_off_policy_pending_requests":{"errors":[{"error_key":"time_off_policy","category":"invalid_operation","message":"Cannot deactivate policy with pending time off requests."}]},"time_off_policy_employees_required":{"errors":[{"error_key":"employees","category":"invalid_attribute_value","message":"Employees are required."}]},"time_off_policy_unlimited_balance_update":{"errors":[{"error_key":"base","category":"invalid_attribute_value","message":"Can not adjust balances for unlimited policies."}]},"holiday_pay_policy_already_exists":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Company already has a holiday pay policy."}]},"holiday_pay_policy_not_exists":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Company does not have a holiday pay policy, please create one"}]},"holiday_pay_policy_invalid_employees":{"errors":[{"error_key":"employees","category":"invalid_attribute_value","message":"Invalid employee uuids provided."}]},"onboarded_employee":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Cannot delete onboarded employee"}]},"invalid_attribute":{"errors":[{"error_key":"base","category":"invalid_operation","message":"There is an error in the request body."}]},"company_cannot_enable_contractor_only":{"errors":[{"error_key":"contractor_only","category":"invalid_attribute_value","message":"Contractor only cannot be enabled for existing companies."}]},"company_missing_parameter":{"errors":[{"error_key":"base","category":"missing_parameter","message":"contractor_only is required."}]},"starting_after_uuid_invalid":{"errors":[{"error_key":"starting_after_uuid","category":"invalid_attribute_value","message":"Parameter 'starting_after_uuid' does not correspond to a valid event."}]},"resource_uuid_invalid":{"errors":[{"error_key":"resource_uuid","category":"invalid_attribute_value","message":"Parameter 'resource_uuid' does not correspond to a valid resource."}]},"payroll_gross_up_invalid_net_pay":{"errors":[{"error_key":"net_pay","category":"invalid_attribute_value","message":"Net pay must be a number."}]},"payroll_accruing_hours_invalid":{"errors":[{"error_key":"base","category":"invalid_attribute_value","message":"Hours cannot be negative."}]},"payroll_cannot_cancel":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Payroll cannot be canceled."}]},"frozen_payroll":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This payroll has already been processed. Its data cannot be updated or altered."}]},"frozen_payroll_processing":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This payroll is being processed and cannot be updated at this time."}]},"unmodifiable_payroll_type":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This type of payroll cannot be modified or processed. It is reserved for system processes."}]},"invalid_employee_uuids_format":{"errors":[{"error_key":"employee_uuids","category":"invalid_attribute_value","message":"Parameter employee_uuids must be an array."}]},"maximum_employee_uuids_surpassed":{"errors":[{"error_key":"employee_uuids","category":"invalid_attribute_value","message":"Exceeded maximum of 100 for lookup."}]},"invalid_employee_uuid":{"errors":[{"error_key":"employee_uuids","category":"invalid_attribute_value","message":"Invalid Employee UUID(s).","metadata":{"entities":[{"entity_type":"Employee","entity_uuid":"invalid-uuid-123"}]}}]},"payroll_blocker_missing_bank_info":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must have a bank account in order to run payroll.","metadata":{"key":"missing_bank_info"}}]},"payroll_blocker_missing_employee_setup":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must add employees in order to run payroll.","metadata":{"key":"missing_employee_setup"}}]},"payroll_blocker_missing_federal_tax_setup":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must complete federal tax setup in order to run payroll.","metadata":{"key":"missing_federal_tax_setup"}}]},"payroll_blocker_missing_bank_verification":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company bank account must be verified in order to run payroll.","metadata":{"key":"missing_bank_verification"}}]},"payroll_blocker_suspended":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company is suspended and cannot run payroll.","metadata":{"key":"suspended"}}]},"submission_blocker_missing_selection":{"errors":[{"error_key":"submission_blockers","category":"invalid_attribute_value","message":"Submission blockers selections required"}]},"submission_blocker_invalid_option":{"errors":[{"error_key":"submission_blockers","category":"nested_errors","metadata":{"blocker_type":"fast_ach_threshold_exceeded"},"errors":[{"error_key":"selected_option","category":"invalid_attribute_value","message":"Selection is not available to resolve Fast ACH Threshold Exceeded. Please choose one of Wire In, Move To Four Day"}]}]},"invalid_version":{"errors":[{"error_key":"base","category":"invalid_resource_version","message":"You are attempting to update a resource using an out-of-date version."}]},"signatory_email_required":{"errors":[{"error_key":"email","category":"invalid_attribute_value","message":"Email is required"}]},"signatory_company_already_has_signatory":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Cannot have more than one signatory in a company. Please remove the existing signatory before adding a new one."}]},"mixed_disbursement_errors":{"errors":[{"error_key":"disbursements","category":"nested_errors","metadata":{"contractor_payment_uuid":"invalid-uuid-1"},"errors":[{"error_key":"contractor_payment_uuid","category":"not_found","message":"Disbursement not found."}]},{"error_key":"disbursements","category":"nested_errors","metadata":{"contractor_payment_uuid":"d0dfa222-ad08-4ea7-a06a-717688c3b179"},"errors":[{"error_key":"payment_method","category":"invalid_attribute_value","message":"Payment method must be one of: Direct Deposit, Check."},{"error_key":"payment_status","category":"invalid_attribute_value","message":"Payment status is not valid for payment method 'InvalidMethod'."}]}]},"not_found":{"errors":[{"error_key":"request","category":"not_found","message":"The requested resource was not found."}]},"finish_onboarding_incomplete":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Company is not ready to exit onboarding."}]},"company_location_validation":{"errors":[{"error_key":"street_1","category":"invalid_attribute_value","message":"Must include a street address"},{"error_key":"city","category":"invalid_attribute_value","message":"Must include a city"},{"error_key":"state","category":"invalid_attribute_value","message":"State is in the wrong format"},{"error_key":"zip","category":"invalid_attribute_value","message":"Please enter a valid zip code (e.g. 12345)."},{"error_key":"phone_number","category":"invalid_attribute_value","message":"Phone number must be 10 digits"}]},"conflict":{"errors":[{"error_key":"request","category":"duplicate_operation","message":"A resource with these attributes already exists."}]},"invalid_parameter":{"errors":[{"error_key":"request","category":"invalid_parameter","message":"The provided parameter is invalid or missing."}]},"flow_invalid_entity":{"errors":[{"error_key":"entity_type","category":"invalid_attribute_value","message":"Invalid flow entity"},{"error_key":"entity_uuid","category":"invalid_attribute_value","message":"Invalid flow entity"}]},"flow_nested_options_errors":{"errors":[{"error_key":"options","category":"nested_errors","metadata":{"flow_type":"company_forms"},"errors":[{"error_key":"form_types","category":"invalid_attribute_value","message":"Supplied value 'invalid' contains no permitted values"}]}]},"basic":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must complete all onboarding requirements in order to run payroll.","metadata":{"key":"needs_onboarding"}}]},"contractor_payment_invalid_wage":{"errors":[{"error_key":"wage","category":"invalid_attribute_value","message":"Wage must be greater than or equal to 0."}]},"contractor_payment_cannot_cancel":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Payment has already been processed and cannot be cancelled. Contact support directly."}]},"time_off_request_cannot_delete":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This time off request cannot be deleted."}]},"resource":{"errors":[{"error_key":"first_name","category":"invalid_attribute_value","message":"First name is required"},{"error_key":"date_of_birth","category":"invalid_attribute_value","message":"Date of birth is not a valid date"}]},"nested":{"errors":[{"error_key":"contractor_payments","category":"nested_errors","metadata":{"contractor_uuid":"72ae4617-daa9-4ed7-85e0-18ed5d0ee835"},"errors":[{"error_key":"hours","category":"invalid_attribute_value","message":"Ella Fitzgerald is paid fixed wage and hours cannot be set on a contractor payment"}]},{"error_key":"contractor_payments","category":"nested_errors","metadata":{"contractor_uuid":"2d7bf62c-babf-4a12-8292-340e2d9cab28"},"errors":[{"error_key":"wage","category":"invalid_attribute_value","message":"Isaiah Berlin is paid hourly and wage cannot be set on a contractor payment"}]}]},"compensation_invalid_rate":{"errors":[{"error_key":"rate","category":"invalid_attribute_value","message":"Rate is not a valid number"}]},"compensation_invalid_payment_unit":{"errors":[{"error_key":"payment_unit","category":"invalid_attribute_value","message":"Payment unit must be one of Hour, Week, Month, or Year"}]},"compensation_already_processed":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Compensation has already been processed on payroll."}]}},"title":"Unprocessable-Entity-Error-Object"}}}}}}
\ No newline at end of file
diff --git a/docs/api/delete-v-1-employee.api.mdx b/docs/api/delete-v-1-employee.api.mdx
new file mode 100644
index 000000000..311e8a6dd
--- /dev/null
+++ b/docs/api/delete-v-1-employee.api.mdx
@@ -0,0 +1,73 @@
+---
+id: delete-v-1-employee
+title: "Delete an onboarding employee"
+description: "Use this endpoint to delete an employee who is in onboarding. Deleting"
+sidebar_label: "Delete an onboarding employee"
+hide_title: true
+hide_table_of_contents: true
+api: eJztXFtvHLeS/ivc3gfHwPRIGsuX6Ol4LXmPgHVixPb6HMhGi9OsmWHUTXZI9kgTQf99UUWyL3OTZixhdw8SIEg0zcvHurFYVeRtoisw3EmtzkVykggowEE6P0qhrAq9AEgGiQCbG1lho+Qk+WKBuZm0DJSotFSOOc18P8YVi/3Y9UwzaZlUTKux5kZINR2yU2wo1fSb4s0HEG0vaZnSjvGi0NcgGFeCXcuiYAZcbRTj7Hg0YgZspZWFIftYALfA8hnkV0zXjrkZsM9gSqloUZbxSn5TcsIWumYKQCBaFxoQ4FUQw2/qm7K5ruCEXcYf7UnJFZ/CZTJIHJ/a5OQiOYvfku+D5Cad1tbpVCoHU0/S1C0qwIZQjkEIEMkg4VXVbUJdLeS1kW6RnFzcJu90WXG1eJvnYO3b2s2Sk4vvd98HScUNL8GBsdRO8RKSk+Qf6X/StG8/nqf/DcYikwaJRE7NgAswySCx+QxKnpzcJh5QYp2RapoMElB1iQBHh6OX6eGr9Ogl4hEw4XXhkpPu73fLgnAKno5gieqCO0jH3IJgbz+es7nHwri1OpfcATLSzZAPhhrkvCiG7HzClFbE98rouRQgBr4Nr6pC5kSkZ5ZdlFLJsi67Y3//aeZcZU8ODoTO7ZDIP8x1eRDJnVZ8YXRR0PcDXsk09JRq+u9hwLTz83OEUVsQw+Ru0FA4SkAmRaRsxd1sRTE+z4B9+XJ+yvSECNLRIAN/1NKASE6cqWEzQ+7uOoJk7DWfxh5R5C12Gh0e43/609uaJGZSF8iq43VNftGOvde1EijgCBdxgUXeGLC6NjkwocGrINxI64bsA78CZmsDtKbII79QadmcF1IMv6HM5Vo5UA6n7fDu4HeLc9921rwBFPumGPtRXOenB31oqK6exnr8O+Sux42LBIzRhpSwMmgKnfQkDr+3HOLG8AXy30HZ/X3zqNkVYIecO5hqs9gwB7Vao5l9In2qIJcTCZZdzyCsmboznee1sUP2eVFJVKmFN85XsGBSgHK+F7bnzhk5rh0cNJaEGShINdEoxiFR+FvUO0DDEbAtKoAfiSEz41CRSTYgnxpdV1JNLVn5nCs2BtI+RDOuZSFYjopQhvYzrkQh1RS3FLIQHTNKmEuwlk/hfsgfIxABjsvCMj6Oe4efKmVTUGBacoahI0pbmwnPPVLc85RA4Eg5/AdVGG54WRWez0q7bIIS3hWsix7/kyDxXXk56XTsLC7ZoCDX3OsHdRgmd98RiJOuAK9kKSlZeoaTpr96qfVoj0ejVbXMucLRwsa+uknur/BfVGU0mio+LoCdKSfdIqo+kpov2IxXFSiUdUVcGWuxQKkitoe1M5yeSxXEyTJb5zPGLbuUilQ/awQ+m/OihssB04aGiyNMiPmihsDHpmfjFF0O2Sfw6nZx5qd55/kjwe64/xDMNG+6P2fTWgpgE21YqQ1EafTW9C+j9a9vtND7aSaSll0q0unM8/FyQOA8r7wXHESeceZbssvQlAUmLbyTBaRUQTH+z9hGROG44I6vE8U+jHdRuQ0UMOfKoX/JccwgIIugycH6ScVIp9HlJLMRLNK4gCF7rw0LBnnQG4LwEaku/X8zRHVJvI2/1LUUl57849bRQL9CK/h1QpZ8+1rKunCyKsDPhXq0pHjx51Vli192UOklr1CqaZwZu3EhJH7ixcfOTN7HXDO3J8j9UvMLL6Hxez1F3Yx3xSbXxvuwwjKnSRo6BL5/hi9K/lFDax4M2c12PhrRW++J0WU74EU7oqqLIvnetKurzOntDXt2bl0D67iDbU06m/CHIP3pV+lm6a8KUr/5JXebW30IsuObImvwZPIXz///8xxH2rhh9+nwFY2PVsXCH36Y3LptDNm5o/O0tlaii+U0m/E5sMYOFTCHwiLvwjYSN4rGrCS5NHldcPOTh9tzG58n3RWuaZCscYLHXF1lPM91rVzmvcqsVpNaCRBZxRclKGe3OMgYWeh7xyvOWs9Lfl8rjDh9ADfTgs24ZXE21sxGPOgBm4ORk0UmFYlujkgrbeWjIvsnugE4KwuzsuBrj4HR/BLEUmSLnBT0WAMcxkvsaIebl8ALA1wssjjiky4AyRsmZGMA1a5jDcBSWrRQmdE1RgK3HYp8i0zV5ZgCWWsgLjn5PaC/+f7M90ediNtuwBUkIcu1msipbaA1vuZOVFvt3QXz1jFkqWMY7mqd2bK2rutYrAcWVzvh1kVtyQpZSrcF4ZrGO5PwPSIOYzAag9mZrguBmHmgbIM5q8BILVq8oEQmgrXcgLJpshbbelqeKUHxxo7m0AnKzbhiL1iplZtR6HlSu9qAx5f7wGomlaitM4vMQgE5SnemuMxtlmsBWeuYbUTctt6dnr9gX4Z914jjwxCGaZ4eYBRN+KPmBe4ir5iQU9mYnS1wbQRgHwDXyty33R3tJ5kTVrsK9jiA9VidLCHTk0lW6ULmiwxjuw/jdbkXEct1/F0GUSvSKBCNvvA8NzUvMrNdZ3rNdrDcb30/hv0aio0LNOXoWTV4GAGUYDcAr4A21ywEUrbtjktdd0H7LoageO7kHCH7MfwZN2BgOAHTk0mM6mzC3CRyHsL2pvHuvG+SQowbeLgEjHnBVQ5ZXd1jLzfv1ttQvePKJ9bE78R2P5vdzvaZLqRAq47/esDRrSBH9DG9opD2atwIcilYQIA7UGD+ZmgYLX0yWE36gTzpdcAGrAoumwFOIVPYCLXZHhsxexJRPPdt2uwqHrtsJ4ZB+JrYbgPnMel3XxiZIKws5hERfKbYo7QU7KFjqVS9KDAGl5d2NO9WZKAwfoROmDM8d9pkeAjbgm255e5q2gzgz3utf+OxCFJYknK0fR5vq7AR/1P6sUtrXLPNWccN+e184sDQWf8hXsBqr93p97Hxq5+tGe9Zq8ZtaILilCwoyhyUC6uIocWH4u+1/yHkvZHuxRxbt0caTDlkU6OtxXBHnFwBHQa2+Tqhxe7uDtAZofEo4rlgCRJ5LciRma7NQxzD/ba6v+PoHc1RMOVOzpcJFHQ8x32weER789GP3wHgp2jUY2L0n6CygONRLR1GfcL0K0fykHTD2MK5sz6c3mL0bofADBkvHJgNaLMwyvZz+w8Bl5aNAY1bAzimWpagUqhRWnIAA9halVrIiSSzHSHHaOZjgo0Zo2qF2R6Ap2SP5N5QWjDzYMXtwjoom0bRhi/7BmQFbDbRpuTbTvv99j9igPojtVqtGIUnA86S32D9zDJOW5uK45qfEOrZTQ6AXkTAgJw4OjwkqhZaX9XVNlo+IbDocMUzAJXJ/GSfD5N+7qvN61wsBd2b40OyFCuP86f4Z3o0ekEZ/q5BGxc6vwLTbP4UdJNqoncS/qXR1jrDJBHBEe7FAbHYzwgwuD+ZWkX1WF6+n3sV5/b1NMyx4OrqaRbFReua2v2WswRz+5omIDCVmjl+85TLQr+QHPAwH3P8htF8+61xFfYDRNHHhH2RyKMvsyeG0WLFKPQPyGUP9PpF2tpiLGLHEPtDFiWxqCUM3t0E711CC8lDtvWYVqXVCmuamN0213yl+z6humYQFgdhzeTtGSLZBLjdlX8UbS9dtkS/OFuwxhRC5/ksczMDdqYLkUHYfJJO/m4ZAS0LGqy70yrSpamHnnNZ8JDMQ4+/mAOj2Pzbd39nnyM4FnfGTv5Ia0vBCNwkv0oD7FwN2Ac9B/ZZY+GlYaec0pHdDTMUxO7lNjXHl3lTjtzLHVFcjDsHZUWHWKeDS8d4W89Ro3BSeXbtUj1J6XsYMB4z5VRxpw2G9rgsHhbW47LYJ6THZdE96C4DiOfuGB2bcZs1Xx8/muKzuU3CA5nbzMaoPCgAasTAQIkcp9R5DB60XcYwwcGwTgCJzhRc46DR0ZM3IDIh7bg2FiiZ1OatNyys23oH7evEFmLeaq33s0X3Ng3xgMLK0w7opVLKwRMvTxyKCR+NRikXh2/SY+CvU374iqevj16/evMmfzE+ev3zlkXH0UrKdu/j+/sEn+/f7J/eapywU4m5cHbqk88D9g6T0r5Gfh0KrI+o9zqBeBS+fzR93qNG177qo3wWvG2f4n82jDbsf6vcdpBMpJJ2lrX3XaiQwLteTxCTDgTyZ3ynUbNd97JNPyZYaO/FZDT0fV6YdQbAZUe7c/EDCo9UeVELtOh+ILQtBqxdkZnclyj92Bw0yPLIvkpn960Xu4WLS2gur41WUxZO38tz/CmrPcTcm2RQeNaOUbw/ZeWTrj/BcDpkR6MXxy+fr1GxmVawdz3ER+wdqyGikh8d9hKlWHFQyHxbpGGt8ojaV4DDptRjR3UwfedmYDvlvW2wyqdwlg7wDwlkr4W1vY7gc/fqSFuTQdz3fMHabO8pRx0v9HWnvIFqubYVN7Rn+72jCThlrOZbFohujOBxJmgWGXYy78Pa+/f80PDh2yHNEhztaKVQ0eyWnQ6/U5+9TiBYEwyC0Sf2LPR51t4kUJpVeKfNudjKxl1lzK3Mn/h0zqnML9rv6G2Sk7HbERYvOtrOPhSOgWv8j0i361AcvmF19Hlngn/FsvBoZ6aUFjXBZTVtocZhs1GtoHvCGD15EpuD5EsxZ48AY/iMKtNzx2xdVdo4Jsg5KhbLGf5gjuIafAb00ePQS8UPHch+QrGUzdpWLiaNddl+BS/vsS9TS2UvK9ZK0P4wycbS0AXKHWc5pbz6hFH35mgcdlAqm/AOINmch6Vpm1rQfZz44Ly/HnE4fnX0OhWc/5weg3idvnkJh+nRGxAvxSHAmxcvt5g0yobtcSgtCs7eS/fnFENxgip+ORpzPK4xVFiS4dlSNswC+oh0RGxSzYEIaw46j0ypkXg9nrwa5emYjyfpMT8apW9GP4/SF8eHMBI/53w8erOFUvtZoXPLJZ+x/wBTSNWQCelSLPwF83B75WEUij41KOv96Sbusb1uZ3Ot1tYS1uCNdiW9W3S5FklzuFRb60N7zfY+rWHvpRMjwxTsgH0FuMJQk3Izunr3T+DrUMegSWN7H/moFCfaZu11Z0Pt35zs3VZMNxS7+3J3WwG/Am4XKRrCVM/BGCmgeVYBUzo3DpQlNwmX5he18eUAurRQ3/+CAGptfyh/d7zpj3c9uo02IW06RMR4Hz0EFTqroOvvJ8nB/OigSZYc3Hbuyd/howOY6QwsrE2Bhi7cluSV9JclUwEl3ZhcufFwCqVO+jT146U+XIKfcUEbBl475kdDoZFNY1b4+a7zGsMnvL/qS7PWvMnQXNnAyeMbC/j3GLghb2/5QhsNkdLdC8ZrN0OHOyYWBsknygb/yAx+hA0T0FnKpwKjZNO7EfieArI9xnu7Lz4MEnzgwf46+QRmLnPoULq960rXAw+o4YHAqVERU/ob47Y2dF250gJFrksKZxOOZ5adBRFnsYICn3oQOq/RzNAy/i1cOub+eBreZziNs7Lf8GJoOIP4UC+KSvj6t1YykBqVtq7kqjdOfMOk44Nvegbltr39/NeLKM1tZQc37qAquCSRJuW8DdbiIpkfEVvaasaT7ssa37FQ0jpseHuLZv6LKe7u8Oc/akBLf/EdrZOh2g4yKkKSTRbJyYQXFrYw6KffgkP6nG15pGPtGuK9LLXoGMckXBLrPQ3iaz39kyu7wfuXfkhlA109/dY/XtOQud2y0C5WrvNt5cGB3k51evZfZ5/PcK/sW9LGcob/6dzd7XP49ta3+KyvQN3dNQx3+Dd5CHf/A6GXcQ0=
+sidebar_class_name: "delete api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Use this endpoint to delete an employee who is in onboarding. Deleting
+an onboarded employee is not allowed and will return a 422 response. Please check out the Terminations api
+if you need to terminate an onboarded employee.
+
+scope: `employees:manage`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/delete-v-1-employees-employee-id-bank-accounts-bank-account-id.ParamsDetails.json b/docs/api/delete-v-1-employees-employee-id-bank-accounts-bank-account-id.ParamsDetails.json
new file mode 100644
index 000000000..7ff1a73ae
--- /dev/null
+++ b/docs/api/delete-v-1-employees-employee-id-bank-accounts-bank-account-id.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"employee_id","in":"path","required":true,"schema":{"type":"string"},"description":"The UUID of the employee"},{"name":"bank_account_uuid","in":"path","required":true,"schema":{"type":"string"},"description":"The UUID of the bank account"},{"name":"X-Gusto-API-Version","in":"header","required":false,"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.","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"}}]}
\ No newline at end of file
diff --git a/docs/api/delete-v-1-employees-employee-id-bank-accounts-bank-account-id.RequestSchema.json b/docs/api/delete-v-1-employees-employee-id-bank-accounts-bank-account-id.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/delete-v-1-employees-employee-id-bank-accounts-bank-account-id.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/delete-v-1-employees-employee-id-bank-accounts-bank-account-id.StatusCodes.json b/docs/api/delete-v-1-employees-employee-id-bank-accounts-bank-account-id.StatusCodes.json
new file mode 100644
index 000000000..8c4f80195
--- /dev/null
+++ b/docs/api/delete-v-1-employees-employee-id-bank-accounts-bank-account-id.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"204":{"description":"No Content"},"404":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided UUID is valid.\n"},"422":{"description":"Unprocessable Entity \n \nThis 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.\n","content":{"application/json":{"schema":{"description":"Unprocessable Entity\n \nThis 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.\n","type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["error_key","category"],"properties":{"error_key":{"type":"string","description":"Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error."},"category":{"type":"string","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."},"message":{"type":"string","description":"Provides details about the error - generally this message can be surfaced to an end user."},"metadata":{"type":"object","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.","oneOf":[{"type":"object","description":"multiple entities","required":["entities"],"properties":{"entities":{"type":"array","items":{"type":"object","description":"single entity","additionalProperties":true,"properties":{"entity_type":{"type":"string","description":"Name of the entity that the error corresponds to."},"entity_uuid":{"type":"string","description":"Unique identifier for the entity."},"valid_from":{"type":["string","null"]},"valid_up_to":{"type":["string","null"]},"key":{"type":["string","null"]},"state":{"type":["string","null"]}},"title":"Metadata-With-One-Entity"}}},"title":"Metadata-With-Multiple-Entities"},{"type":"object","description":"single entity","additionalProperties":true,"properties":{"entity_type":{"type":"string","description":"Name of the entity that the error corresponds to."},"entity_uuid":{"type":"string","description":"Unique identifier for the entity."},"valid_from":{"type":["string","null"]},"valid_up_to":{"type":["string","null"]},"key":{"type":["string","null"]},"state":{"type":["string","null"]}},"title":"Metadata-With-One-Entity"}]},"errors":{"type":"array","description":"Will only exist if category is `nested_errors`. It is possible to have multiple levels of nested errors.","items":"circular(Entity-Error-Object)"}},"title":"Entity-Error-Object"}}},"x-examples":{"bank_account_delete_unfunded_payments":{"errors":[{"error_key":"base","category":"invalid_operation","message":"FundingMethod has unfunded payments"}]},"bank_account_verify_incorrect_deposits":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Your bank account cannot be verified. Please check the test deposit amounts."}]},"bank_account_verify_already_verified":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Your bank account has already been verified."}]},"bank_account_missing_routing":{"errors":[{"error_key":"routing_number","category":"invalid_attribute_value","message":"Routing number is required."}]},"payment_configs_missing_parameter":{"errors":[{"error_key":"base","category":"missing_parameter","message":"At least one parameter must be provided"}]},"payment_configs_invalid_fast_payment_limit":{"errors":[{"error_key":"fast_payment_limit","category":"invalid_attribute_value","message":"Fast payment limit should be a number"}]},"pay_periods_invalid_end_date":{"errors":[{"error_key":"end_date","category":"invalid_parameter","message":"End date cannot be more than 3 months in future"}]},"company_industry_selection_naics_code_required":{"errors":[{"error_key":"naics_code","category":"invalid_attribute_value","message":"Naics code is required."}]},"company_industry_selection_naics_code_invalid":{"errors":[{"error_key":"naics_code","category":"invalid_attribute_value","message":"Naics code must be equal to 6 digits."}]},"company_industry_selection_sics_codes_invalid":{"errors":[{"error_key":"sic_codes","category":"invalid_attribute_value","message":"Sic codes must be equal to 4 digits"}]},"time_off_policy_name_required":{"errors":[{"error_key":"name","category":"invalid_attribute_value","message":"Name is required."}]},"time_off_policy_unlimited_invalid_accrual_rate":{"errors":[{"error_key":"accrual_rate","category":"invalid_operation","message":"Accrual rate must be blank for unlimited policies."}]},"time_off_policy_pending_requests":{"errors":[{"error_key":"time_off_policy","category":"invalid_operation","message":"Cannot deactivate policy with pending time off requests."}]},"time_off_policy_employees_required":{"errors":[{"error_key":"employees","category":"invalid_attribute_value","message":"Employees are required."}]},"time_off_policy_unlimited_balance_update":{"errors":[{"error_key":"base","category":"invalid_attribute_value","message":"Can not adjust balances for unlimited policies."}]},"holiday_pay_policy_already_exists":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Company already has a holiday pay policy."}]},"holiday_pay_policy_not_exists":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Company does not have a holiday pay policy, please create one"}]},"holiday_pay_policy_invalid_employees":{"errors":[{"error_key":"employees","category":"invalid_attribute_value","message":"Invalid employee uuids provided."}]},"onboarded_employee":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Cannot delete onboarded employee"}]},"invalid_attribute":{"errors":[{"error_key":"base","category":"invalid_operation","message":"There is an error in the request body."}]},"company_cannot_enable_contractor_only":{"errors":[{"error_key":"contractor_only","category":"invalid_attribute_value","message":"Contractor only cannot be enabled for existing companies."}]},"company_missing_parameter":{"errors":[{"error_key":"base","category":"missing_parameter","message":"contractor_only is required."}]},"starting_after_uuid_invalid":{"errors":[{"error_key":"starting_after_uuid","category":"invalid_attribute_value","message":"Parameter 'starting_after_uuid' does not correspond to a valid event."}]},"resource_uuid_invalid":{"errors":[{"error_key":"resource_uuid","category":"invalid_attribute_value","message":"Parameter 'resource_uuid' does not correspond to a valid resource."}]},"payroll_gross_up_invalid_net_pay":{"errors":[{"error_key":"net_pay","category":"invalid_attribute_value","message":"Net pay must be a number."}]},"payroll_accruing_hours_invalid":{"errors":[{"error_key":"base","category":"invalid_attribute_value","message":"Hours cannot be negative."}]},"payroll_cannot_cancel":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Payroll cannot be canceled."}]},"frozen_payroll":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This payroll has already been processed. Its data cannot be updated or altered."}]},"frozen_payroll_processing":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This payroll is being processed and cannot be updated at this time."}]},"unmodifiable_payroll_type":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This type of payroll cannot be modified or processed. It is reserved for system processes."}]},"invalid_employee_uuids_format":{"errors":[{"error_key":"employee_uuids","category":"invalid_attribute_value","message":"Parameter employee_uuids must be an array."}]},"maximum_employee_uuids_surpassed":{"errors":[{"error_key":"employee_uuids","category":"invalid_attribute_value","message":"Exceeded maximum of 100 for lookup."}]},"invalid_employee_uuid":{"errors":[{"error_key":"employee_uuids","category":"invalid_attribute_value","message":"Invalid Employee UUID(s).","metadata":{"entities":[{"entity_type":"Employee","entity_uuid":"invalid-uuid-123"}]}}]},"payroll_blocker_missing_bank_info":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must have a bank account in order to run payroll.","metadata":{"key":"missing_bank_info"}}]},"payroll_blocker_missing_employee_setup":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must add employees in order to run payroll.","metadata":{"key":"missing_employee_setup"}}]},"payroll_blocker_missing_federal_tax_setup":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must complete federal tax setup in order to run payroll.","metadata":{"key":"missing_federal_tax_setup"}}]},"payroll_blocker_missing_bank_verification":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company bank account must be verified in order to run payroll.","metadata":{"key":"missing_bank_verification"}}]},"payroll_blocker_suspended":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company is suspended and cannot run payroll.","metadata":{"key":"suspended"}}]},"submission_blocker_missing_selection":{"errors":[{"error_key":"submission_blockers","category":"invalid_attribute_value","message":"Submission blockers selections required"}]},"submission_blocker_invalid_option":{"errors":[{"error_key":"submission_blockers","category":"nested_errors","metadata":{"blocker_type":"fast_ach_threshold_exceeded"},"errors":[{"error_key":"selected_option","category":"invalid_attribute_value","message":"Selection is not available to resolve Fast ACH Threshold Exceeded. Please choose one of Wire In, Move To Four Day"}]}]},"invalid_version":{"errors":[{"error_key":"base","category":"invalid_resource_version","message":"You are attempting to update a resource using an out-of-date version."}]},"signatory_email_required":{"errors":[{"error_key":"email","category":"invalid_attribute_value","message":"Email is required"}]},"signatory_company_already_has_signatory":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Cannot have more than one signatory in a company. Please remove the existing signatory before adding a new one."}]},"mixed_disbursement_errors":{"errors":[{"error_key":"disbursements","category":"nested_errors","metadata":{"contractor_payment_uuid":"invalid-uuid-1"},"errors":[{"error_key":"contractor_payment_uuid","category":"not_found","message":"Disbursement not found."}]},{"error_key":"disbursements","category":"nested_errors","metadata":{"contractor_payment_uuid":"d0dfa222-ad08-4ea7-a06a-717688c3b179"},"errors":[{"error_key":"payment_method","category":"invalid_attribute_value","message":"Payment method must be one of: Direct Deposit, Check."},{"error_key":"payment_status","category":"invalid_attribute_value","message":"Payment status is not valid for payment method 'InvalidMethod'."}]}]},"not_found":{"errors":[{"error_key":"request","category":"not_found","message":"The requested resource was not found."}]},"finish_onboarding_incomplete":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Company is not ready to exit onboarding."}]},"company_location_validation":{"errors":[{"error_key":"street_1","category":"invalid_attribute_value","message":"Must include a street address"},{"error_key":"city","category":"invalid_attribute_value","message":"Must include a city"},{"error_key":"state","category":"invalid_attribute_value","message":"State is in the wrong format"},{"error_key":"zip","category":"invalid_attribute_value","message":"Please enter a valid zip code (e.g. 12345)."},{"error_key":"phone_number","category":"invalid_attribute_value","message":"Phone number must be 10 digits"}]},"conflict":{"errors":[{"error_key":"request","category":"duplicate_operation","message":"A resource with these attributes already exists."}]},"invalid_parameter":{"errors":[{"error_key":"request","category":"invalid_parameter","message":"The provided parameter is invalid or missing."}]},"flow_invalid_entity":{"errors":[{"error_key":"entity_type","category":"invalid_attribute_value","message":"Invalid flow entity"},{"error_key":"entity_uuid","category":"invalid_attribute_value","message":"Invalid flow entity"}]},"flow_nested_options_errors":{"errors":[{"error_key":"options","category":"nested_errors","metadata":{"flow_type":"company_forms"},"errors":[{"error_key":"form_types","category":"invalid_attribute_value","message":"Supplied value 'invalid' contains no permitted values"}]}]},"basic":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must complete all onboarding requirements in order to run payroll.","metadata":{"key":"needs_onboarding"}}]},"contractor_payment_invalid_wage":{"errors":[{"error_key":"wage","category":"invalid_attribute_value","message":"Wage must be greater than or equal to 0."}]},"contractor_payment_cannot_cancel":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Payment has already been processed and cannot be cancelled. Contact support directly."}]},"time_off_request_cannot_delete":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This time off request cannot be deleted."}]},"resource":{"errors":[{"error_key":"first_name","category":"invalid_attribute_value","message":"First name is required"},{"error_key":"date_of_birth","category":"invalid_attribute_value","message":"Date of birth is not a valid date"}]},"nested":{"errors":[{"error_key":"contractor_payments","category":"nested_errors","metadata":{"contractor_uuid":"72ae4617-daa9-4ed7-85e0-18ed5d0ee835"},"errors":[{"error_key":"hours","category":"invalid_attribute_value","message":"Ella Fitzgerald is paid fixed wage and hours cannot be set on a contractor payment"}]},{"error_key":"contractor_payments","category":"nested_errors","metadata":{"contractor_uuid":"2d7bf62c-babf-4a12-8292-340e2d9cab28"},"errors":[{"error_key":"wage","category":"invalid_attribute_value","message":"Isaiah Berlin is paid hourly and wage cannot be set on a contractor payment"}]}]},"compensation_invalid_rate":{"errors":[{"error_key":"rate","category":"invalid_attribute_value","message":"Rate is not a valid number"}]},"compensation_invalid_payment_unit":{"errors":[{"error_key":"payment_unit","category":"invalid_attribute_value","message":"Payment unit must be one of Hour, Week, Month, or Year"}]},"compensation_already_processed":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Compensation has already been processed on payroll."}]}},"title":"Unprocessable-Entity-Error-Object"},"examples":{"Basic":{"value":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must complete all onboarding requirements in order to run payroll.","metadata":{"key":"needs_onboarding"}}]}},"Resource":{"value":{"errors":[{"error_key":"first_name","category":"invalid_attribute_value","message":"First name is required"},{"error_key":"date_of_birth","category":"invalid_attribute_value","message":"Date of birth is not a valid date"}]}},"Nested":{"value":{"errors":[{"error_key":"contractor_payments","category":"nested_errors","metadata":{"contractor_uuid":"72ae4617-daa9-4ed7-85e0-18ed5d0ee835"},"errors":[{"error_key":"hours","category":"invalid_attribute_value","message":"Ella Fitzgerald is paid fixed wage and hours cannot be set on a contractor payment"}]},{"error_key":"contractor_payments","category":"nested_errors","metadata":{"contractor_uuid":"2d7bf62c-babf-4a12-8292-340e2d9cab28"},"errors":[{"error_key":"wage","category":"invalid_attribute_value","message":"Isaiah Berlin is paid hourly and wage cannot be set on a contractor payment"}]}]}}}}}}}}
\ No newline at end of file
diff --git a/docs/api/delete-v-1-employees-employee-id-bank-accounts-bank-account-id.api.mdx b/docs/api/delete-v-1-employees-employee-id-bank-accounts-bank-account-id.api.mdx
new file mode 100644
index 000000000..abf9f781a
--- /dev/null
+++ b/docs/api/delete-v-1-employees-employee-id-bank-accounts-bank-account-id.api.mdx
@@ -0,0 +1,72 @@
+---
+id: delete-v-1-employees-employee-id-bank-accounts-bank-account-id
+title: "Delete an employee bank account"
+description: "Deletes an employee bank account. To update an employee's bank"
+sidebar_label: "Delete an employee bank account"
+hide_title: true
+hide_table_of_contents: true
+api: eJztXFtvGzmy/is8fR6SAGr5kuv4aTNxctbAZiaYJCc7cII21SxJHHeTHZItW2P4vy+qSPZNF1uO/bCDGWCQRCKLH4t1Y1VRV8llOqut06lUDmaGO6lV6pYVJEenCZQTEAJE8m2U6Ar8tyciOUoEFOAgXRykUFaFXgLY5m+ZFOmEq/OM57mulbO9f2VSJKPEgK20smCTo6vkcP8Z/iHA5kZWuEZylPyi2RutHCiXXI+SZ+uHOPZO10qwr4qxr+rTHJiB7zVYB4IZsLo2OTChwTKlHYNLad2YvefnwGxtgLk5sMrohRQg2OfPJ8dMWrbghRTjr4qWPTxcXfazqozOwVo+KYC9VU66ZYNAWlbyJZvzqgLFLuagaJWJFkump2ypaxMxslwrx6WyDIzRxjJb53PGLTuTikBk3DkjJ7WDbMGLGs5GTBsiFylMuSwsEzUwpxlX7czmtM7G7CP4nZ6+9cu84Q5m2kiw3x7Pnavs0d6e0LkdkyCMc13uxYNPK740uijo+z2CmebN9CdsVksBbKoNK7UBJsAhIGTeKMnD6R1dJbyqCpkTnr0/LDLxKrH5HEp+O+7+zdwhc72GJnryB+SO9Ol7LQ0I0lpCgjpbGYTqpFez8PnRVZzNjeHLZJRIB2X3881Us3PACQHlcsMaNKolZ52RapaMBgf9sYJcTiVYPMigjDSd6TyvjR2zT8tK5rwolszh0Z/DkkkByvlZOL45w72KG16CAxSAgqP+O92SHKMyN6h3gIYUcCyKl6fE0MpEUtF6BCljM6PrSqqZZVwJlnPFJsBq69FMalkIlqMclGH8nCtRSDVjUnnp7VjhMTuZtgtJy84UGbbMn+PZiMD5s2IXsiiiyDPO/Eh2FoaycEhLdiHdnIE3Wf5LYk2J+jaDmznzIe43SCPjE127ztmlbAYKTHtqgXRkhq3NlOeeIVwxUAL5YwIKxwV3fJ0o9mG8icptoIAFV47hPKQZBGQZNDm4AKkY6bTUwWwEizQpYMzeacPgkpdVAaMeCcJHrDrzf2aI6ozONn5S11KcefZPWmcyTkaJVvDrNDk6vWkvZV04WRXg10I9Gihe/HhV2eI3O6h0f20r1SyujNO4EBK/4sWHzkrO1LB2bc+Qm6XmF16SBpGYeI66Oe+KTa6NDwmEZU6TNHQYfPMKn5X8XkNrHgzZzXY9ouit99TosiV42lJUdVEk35pxdZU5vX1gz86tG2Add7BtyPUocdIVuLP3QfrTL9LN018VpN75JdebR70PsuOH4tFcj/4+87/CmSOljQ67z4cvaHy0KpY+wGVyq9sYsxOHH1faWokhltNszhfAGjtUwAIKi2cX3Eh0FI1ZSXJp8rrg5rGHm1Lwk/5KAvck6e5wzQAv0JdpsLm0wd4NwV8uslpNayVAZBVflqBcL4g57cUayYRb6AYmR8lKsJZ03FzyrlZCqtl7cHMt2JxbFldjzWp0Bj1gCzByusykItHNEWmlrbxXZL9jGICrsrAqek68vUyA0foSxJh9KIBbYPkc8nMfpGDEGuAwXtK9a7x5C7wwwMUyixQfdAPI3rAgmwCodh9rAJbSooXKjK4dqs1mYGFEpupyAmY9xEGQ3wP6m5/P/HzUieh2A64gCVmu1VTObAOtiTV34trq7C6Y147hkTqmFbA2mC1r67qBxXpgcbdTbl3UlqyQpXRbEK4ZvDML3yHiQIMRDWbnui4EYuaBsw3mrAIjtWjxghKZCNZyA8pmyFps63n5VgmMB6GjOXSDcnOu2FNWauXmFmPCae1qAx5frsuKK1RuUVtnlpmFAnKU7kxxmdss1wKyNjDbiLgdvTs/f8G5DOeuEcfbIQzLPDzAKJrwveYFepEXTMiZbMzOFrg2ArC3gGtl7sfujvajzAmrXQX7LID1WJ0sIdPTaVbpQubLTPHylmdd3omJ5brzHYKoFWkUiEZfeJ6bmheZ2a4zvWE7WO7Xfh7DeQ3HJgWacoysGjyMAEqwG4BXQM41C4mUbd5xMHUXtG+8cgvguZMLhOxp+DtuwMBwAaan05jV2YS5SWPe5tibwbuf/ds4lXEDt5eACS+4yiGrqxvs5WZvvQ3VG64oQ8rFH3TsfjW7/djnupACrTr+7wHHsIIC0fuMit54Y9KEERRSsIAAPVA4/M3QlHYPB6tJMVMkvQ7YiFUhZDOAsqoVbITauMdGzB5EFE/8GBZJMLx22U4Og/BpNdHcYBgex90n/6IOY8DPmqUaSB7CymbuEcEnyj1KS8keupZK1csCY3J54NF8WJGBwvwRBmHO8Nxpk+ElbAu24cjd1bQh4O97bXzjsQhSWJJytH0eb6uwEf9DxrGDPa5xc9ZxQ3E7nzowdNe/TRSwOmt3/n1o4upHa+g9atW4TU1QnpIFRVmAcmEXMbV4W/y98T+EvEfpRsxxdHulwZJDNjPaWkx3xMUV0GVgW6wTRuwe7gDdEZqIIt4LBpAoasETmeva3CYwvJur+ydS72iOghl3cjFkUNDxHP1gcY/25oOn3wHgl2jUY2r0n6CygONeLR1mfcLyK1fyUHTD3MKJsz6d3mL0YYfAChkvHJgNaLNAZfu9/YeAS8smgMatARxLLQOolGqUlgLAALZWpRZyKslsR8gxm3mfYGPFqFo5bA/Ac7LHcm8oLZhFsOJ2aR2UzaBow4exAVkBm021Kfm2235//I8YoD6lVqsVo/RkwFnyS1nW5RCnrU3Fcc8PCPXtZQ6AUUTAgCdxsL9PXC20Pq+rbbx8QGAx4Ip3AGo5eGyfjJN+7aut65wOku7N9SEZ5Mrj+in+Mz04fIo77Bm0SaHzczCN86ekm1RTvZPwD6itDYZJIkIg3MsDSsW0EWDQP5laRfUYbt+vvYpz+36aw7Hg6uphNsVFG5rau21nAHP7nqYgsJSaOX75kNvCuJAC8LAec/yS0Xp32+Mq7FuIos8J+yaRe99mTwyjxYpZ6B+Qyx7o9Zu0tcVcxI4p9ttsSmJTSyDedYI3bqGF5CHbekK70mrlaJqc3bbQfGX6XVJ1DREWibBm8fYOkWwC3HrlH0XbK5cN+BdXC9aYUug8n2dubsDOdSEyCM4n6dTvhghoW9Bg3Z1XkS8oApS2WXBZ8FDMw4i/WACj3PzrN/9knyI4Fj1jp36ktaVkBDrJL9IAO1Ej9l4vgH3S2Fxn2DGncmTXYS7A2F3VNM5tri+RyKB2RHkx7hyUFV1inQ4hHeNtP0eNwokhh65dqqcpfR8IxmumnCnutMHUHpfF7dJ6XBZ3SelxWXQvukMA8d4ds2NzbrPm2/vPpvhqblPwwMNtVmPUHhQANWJgoMQTp9J5TB60UyYwRWLYJ4BMZwoukGgM9OQliExIO6mNBSomtXXrDRvrjt5B+zq5hVi3Whv9bNG9TST6GLTLpthX2uPucQc0aR0N8Vx44O2JfTHlh4eHKRf7r9JnwF+mfP8FT18evHzx6lX+dHLw8qctm47USqp23yX29wU+P7/xn95qHLFjibVwduyLzyP2BovS42TIlYgC+yPqO91APAo/P5o+H1FjaF/1UT4K0bYv8T8aRxvWHu62ZA3l/m4jFRt6ji+4HcpIMpVK2nkWspzoXbGRwIdeD5CTDgzyd3ynUbMdaxcf5AQL7aOYjEjfFIVZZwBcdrD7Kb5H4ZEqL2qBFt0TQttiwNoVmcl9i9KPrUFEhpR9l87urhenIWtDlvjCaDVj4fY9XONPWd1BzL1JBoV37ZjF+1NWvuj6GMazMTs4fPrs+ZM1KjbXCu7cD/EBZ8duiKjkB/u9Qil2HBQy35ZpWKs8ovYd4LCp9NhRHSzfuTnYTntvm6zyJZzBBf42iey1sLb3EXzqPg9oezLo9P25YG+2j5Sjjhf6otPeQL1c25ob2rv9nbMJuGTs5hsKRDdHcD8LNJsMnszHsPZmnx8G3t4d0ioh0I5WChXNbvF0+D3NudMNBHuCQTD6ij0Kcx61LwmUZhWYUjoXR9noVSbcyvyBb+ec2vyi/Y7RJgUZu11hFYCwHT8UroFr4o/It4vQHL5hd/T1zgz/gm3h0c7MqCxqQshq2kaN/cZRraB7wBw9RRKbk+SDnLNHgDl8erPEc8dsXVXaOCYoOCqWwwp/MEdxD74Ceu956EHzQweyX1AMqlnb2sWksS67W8PLO5zL1KDtZcVaCfIP02wijZvvvsox1dWnjKY3V+PgQaltwgeAZHNuV6ZtekHvEsSH4P3lIYdnLw5epoLzn9JnIF6mr57DfnrwCsRzsQ/w6unzLSaNqmF3uJQWBWfvpPtzhqk4QR2/HI05XtcYKizJ8HxQDbOAMSJdEZtSc2DCmovOPXPqULycTF8c5umET6bpM35wmL46/OkwffpsHw7FTzmfHL7awqm7WaETyyWfs5/BFFI1bEK+FEti0UV4vXI7DsWYGpT18XST99jet7O5V2trC2uIRruS3m26XIukuVyqrf2hvWF3vq3h7MGNkWEJdsS+AJxjqkm5OT29+x34OtQxadLY3nu+KsWFtll73XGo170G/t5rxXRts/so6Ta6/xwDBc+y/+aI4XqU/NbxGzdt6C/iQK5HyS+NB7lpz3+7kr9dyQ+4Ev/f8L3PMYVuvmMtVpK7Ba4xpu5jzrwd88jSqK8q1sHCE85RbL+jp9TdQhlprA91fdNim/v9qr4qm+sKjthZU9Ls5xnt0YWRDs4SrImFu7PnNNmATjmdLqdSkYkjvW1z9f4ZWvtWvP8ibIU1eGOnd/zx4VnTRzhqlu29Ngk34wdZvMvLLoB/p/9Hv7jw+sNJ+v9NEYQgzIELsuwtiCkvLKyKgMOLqAovlPGoU3QYgr3+cBILIYxbq3NJ3TCUVKEXxjgAH1XT82KFHlm2PZ8jP6bzXv+RZaelVNRH0aG94+N2Xsk0zJRq9r+BYNr5+AnCwJfS6IA2sRybHuoS39Qd7h8+T/dfpAfP8VmsgCmvC4d6335+ff1tlDg+Q5lr+iZYjEt8WhgnX6a2An4O3C5Ter/dEc0w+n1MnHfH4mmmegHGSAHNT2L8zNX563Dm6PkdKEt5DxR8b1w2/uLGKPqT7i9voODEeUOgzYQNgNfP7QNvaaxuADkYigbxa9JmN0+Okr3FwV7TDLF31dHm673ez3/sXa2o3DUeMvY6BYtQmwKlP4gUr6SXqFRASWK18ubxGEo9OA9PL/UFE/wad7+B8FqaH8zKGXdpVvg1csRCXhtK7J1excDrdY5B4OsaOXP6rTvqI8qyj/3WjG0kHCFGyScrBdyQJRg+fCcSKb3RZLx2c0zMxQaEUfKRusZ+ZAVPYcMClHP1LUMxAiZbhqYBJSnWhbt6OErQVtlfpx/BLGQOnfNozQb9jMAeDdwTuDQG7Cn9G+u7NkxdefoKRa5LKnsTjkeWvQ2aw2KnJVotofMa9YK28T/hx0m4T2MHq3wcV2W/4Q9IhFylLwmjQIVv/9HKD3Kj0taVXPXo+NB7g3MebuGq/Z2U/0LHHkTLwaXbqwouSQZJ566CmThNFgfEx/aZwlHf8fdsBX696qC/4TMJ65Da1RX6uc+muL7Gj7/XgOHZ6Tc0Y4Y6O0kthaQb2Qb/2WX649+Cq33CNkYPGzYaX2WrZceKJuGJeC+8QVN0L5AGonQHWKvc9c9QfOSxG+/+4mHIWu56Lq6P4Rpmt44XTXHlOt+t/BZSz8kev/3X209vk+vr/wCNwknB
+sidebar_class_name: "delete api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Deletes an employee bank account. To update an employee's bank
+account details, delete the bank account first and create a new one.
+
+scope: `employee_payment_methods:write`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/delete-v-1-employees-employee-id-i-9-authorization-documents-document-id.ParamsDetails.json b/docs/api/delete-v-1-employees-employee-id-i-9-authorization-documents-document-id.ParamsDetails.json
new file mode 100644
index 000000000..a254dd7f1
--- /dev/null
+++ b/docs/api/delete-v-1-employees-employee-id-i-9-authorization-documents-document-id.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"employee_id","in":"path","required":true,"schema":{"type":"string"},"description":"The UUID of the employee"},{"name":"document_id","in":"path","required":true,"schema":{"type":"string"},"description":"The UUID of the document"},{"name":"X-Gusto-API-Version","in":"header","required":false,"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.","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"}}]}
\ No newline at end of file
diff --git a/docs/api/delete-v-1-employees-employee-id-i-9-authorization-documents-document-id.RequestSchema.json b/docs/api/delete-v-1-employees-employee-id-i-9-authorization-documents-document-id.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/delete-v-1-employees-employee-id-i-9-authorization-documents-document-id.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/delete-v-1-employees-employee-id-i-9-authorization-documents-document-id.StatusCodes.json b/docs/api/delete-v-1-employees-employee-id-i-9-authorization-documents-document-id.StatusCodes.json
new file mode 100644
index 000000000..256ec2e53
--- /dev/null
+++ b/docs/api/delete-v-1-employees-employee-id-i-9-authorization-documents-document-id.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"204":{"description":"No Content"},"404":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided UUID is valid.\n"}}}
\ No newline at end of file
diff --git a/docs/api/delete-v-1-employees-employee-id-i-9-authorization-documents-document-id.api.mdx b/docs/api/delete-v-1-employees-employee-id-i-9-authorization-documents-document-id.api.mdx
new file mode 100644
index 000000000..3b4a819b6
--- /dev/null
+++ b/docs/api/delete-v-1-employees-employee-id-i-9-authorization-documents-document-id.api.mdx
@@ -0,0 +1,71 @@
+---
+id: delete-v-1-employees-employee-id-i-9-authorization-documents-document-id
+title: "Delete an employee's I-9 verification document"
+description: "An employee's I-9 verification documents are the documents an employee has provided the employer to verify their identity and authorization to work in the United States. This endpoint deletes a specific verification document."
+sidebar_label: "Delete an employee's I-9 verification document"
+hide_title: true
+hide_table_of_contents: true
+api: eJztVttu4zYQ/RV2+pBdQLKSYLdA9NRgnRYGegk2ybZAYmQZcWwRkUguSXmjGvr3YqiLZdVeoLeXok+WyeHM8MyZM9zCS7yunNexVB7XlnupVexrg5DeA5ZPKAQKWEbg+drR2iK+YB/QypXMgjHtWXRGK4cO0i2cn76hH4Eus9IEkxR+0uydVh6VhyaCN4dNPPtOV0qwB8XYg7rNkVn8VKHzKJhFpyubIRMaHVPaM3yRzs/Yj/wZmassMp8jM1ZvpEDB7u4WcyYd2/BCitmDgqaJQBtsb7gQkILAAj3Gm7MYS1PoGtENX49SxPLikVc+11b+1sIidFaVqLwbvh6lgGhyj0vFei8njhFcmxFcbHDCeJfzaGV3lOXc7W5DZt2OZV63HmtalpZJgcpLXzOuBNvLmEw/a/vMpAou7pQkLG889+hm7DaXjqESRkvlWQuHY5w5gxklfDjx2YN6UC7TBlP2cYqRS0uu+Bo/QgSGW16iR0u82YLiJUIKI4QhAkmIGe5zIBZ9qqRFAam3FUbgshxLTkRp+QjOW6nWRKB9xIkpod56NUYKoYmGsPsV+1fC9iHGYX+Nvw/ddXm9iD+gdXSyC58jF2j3EljxwuE0zJwgLKVC10bhHuMn7lCwy+sFlYicMu6cziSn8n6WPme1rmwwyHhRzNhixZRWSB3RkypqbbgxRVfiE8fuS6lkWZVj38tXuffGpUkidOZmQS5mmS6TXh5iw2uriyLsJ9zIuDsp1frrzmE8Wn5NaVQOxQyOwx0BqqokxTk/PX8bn34Tn70lrRG44lXhIR2vN80ygpfYGeTPyF0dr62uDKQgL/a0at+IahTrDVorBQ6CMO/LGAG+eFSUccvgZ6whPS6YEWx4UU2Ek7jQn5umNxyYpnn40H66u8OTtAmKEn2udxoXmtHnkEKyOUsGtUu2o2ZskmkvJ4MwJdtR+zRUNLSbvq8rWxCbO4pwI1uGxALLQJM/COQcSz2pROsvlm3KpQ4IHHF80Oe11eILPg1tEzAOs8pKX4fM3+nScFVfZhk6d1kRQPfLsdUNcbOdagdsB8ZSij2T6f8Tchs6ez/HzkVc4AaLINSk20PJ4aZ2Hsu/E6H1cCRAQ7qz0sGr9AW5CdpErU5s6tRpr68iIO1xP69u0G5khqN67GSAP+nKJ8EwERSaxmwc/sd6FepAR6fJ/oJFpkukGRXyOHHsqmsbdt0KSlChnnrhGl9BBJlWnmeeLtKp7LyPyt5j0c4h6t6SyyIQqtv9dscfQsNo50uu9vxQt4zH8Jcm+PRG25AZbfz/CBgeAR2BPb74xBRcBqaHzt52mnQPm7NQrU6VIIJ08kiY+Cfge7jIejzblxHk2nlyu93SmLyzRdPQ8qcKLfX9kpTTSv5ELXC/BSEdfR8Zv+OivnrfTerX7OiT48iNu0Wu6pFwQ9Sp/Pi6pHz/SEojmv6FlMaYNssm6p8rfw6x//jb5SCuLX6HH34DzHtDen71w9XtFTTN7+4mxUM=
+sidebar_class_name: "delete api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+An employee's I-9 verification documents are the documents an employee has provided the employer to verify their identity and authorization to work in the United States. This endpoint deletes a specific verification document.
+
+scope: `i9_authorizations:manage`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/delete-v-1-employees-employee-id-rehire.ParamsDetails.json b/docs/api/delete-v-1-employees-employee-id-rehire.ParamsDetails.json
new file mode 100644
index 000000000..230d65c22
--- /dev/null
+++ b/docs/api/delete-v-1-employees-employee-id-rehire.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"employee_id","in":"path","required":true,"schema":{"type":"string"},"description":"The UUID of the employee"},{"name":"X-Gusto-API-Version","in":"header","required":false,"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.","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"}}]}
\ No newline at end of file
diff --git a/docs/api/delete-v-1-employees-employee-id-rehire.RequestSchema.json b/docs/api/delete-v-1-employees-employee-id-rehire.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/delete-v-1-employees-employee-id-rehire.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/delete-v-1-employees-employee-id-rehire.StatusCodes.json b/docs/api/delete-v-1-employees-employee-id-rehire.StatusCodes.json
new file mode 100644
index 000000000..adc835de6
--- /dev/null
+++ b/docs/api/delete-v-1-employees-employee-id-rehire.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"204":{"description":"No Content"},"404":{"description":"Not Found\n\n* The requested resource does not exist. Make sure the provided UUID is valid.\n* The employee's employment is not in the right state.","content":{"application/json":{"schema":{"description":"Unprocessable Entity\n \nThis 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.\n","type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["error_key","category"],"properties":{"error_key":{"type":"string","description":"Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error."},"category":{"type":"string","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."},"message":{"type":"string","description":"Provides details about the error - generally this message can be surfaced to an end user."},"metadata":{"type":"object","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.","oneOf":[{"type":"object","description":"multiple entities","required":["entities"],"properties":{"entities":{"type":"array","items":{"type":"object","description":"single entity","additionalProperties":true,"properties":{"entity_type":{"type":"string","description":"Name of the entity that the error corresponds to."},"entity_uuid":{"type":"string","description":"Unique identifier for the entity."},"valid_from":{"type":["string","null"]},"valid_up_to":{"type":["string","null"]},"key":{"type":["string","null"]},"state":{"type":["string","null"]}},"title":"Metadata-With-One-Entity"}}},"title":"Metadata-With-Multiple-Entities"},{"type":"object","description":"single entity","additionalProperties":true,"properties":{"entity_type":{"type":"string","description":"Name of the entity that the error corresponds to."},"entity_uuid":{"type":"string","description":"Unique identifier for the entity."},"valid_from":{"type":["string","null"]},"valid_up_to":{"type":["string","null"]},"key":{"type":["string","null"]},"state":{"type":["string","null"]}},"title":"Metadata-With-One-Entity"}]},"errors":{"type":"array","description":"Will only exist if category is `nested_errors`. It is possible to have multiple levels of nested errors.","items":"circular(Entity-Error-Object)"}},"title":"Entity-Error-Object"}}},"x-examples":{"bank_account_delete_unfunded_payments":{"errors":[{"error_key":"base","category":"invalid_operation","message":"FundingMethod has unfunded payments"}]},"bank_account_verify_incorrect_deposits":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Your bank account cannot be verified. Please check the test deposit amounts."}]},"bank_account_verify_already_verified":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Your bank account has already been verified."}]},"bank_account_missing_routing":{"errors":[{"error_key":"routing_number","category":"invalid_attribute_value","message":"Routing number is required."}]},"payment_configs_missing_parameter":{"errors":[{"error_key":"base","category":"missing_parameter","message":"At least one parameter must be provided"}]},"payment_configs_invalid_fast_payment_limit":{"errors":[{"error_key":"fast_payment_limit","category":"invalid_attribute_value","message":"Fast payment limit should be a number"}]},"pay_periods_invalid_end_date":{"errors":[{"error_key":"end_date","category":"invalid_parameter","message":"End date cannot be more than 3 months in future"}]},"company_industry_selection_naics_code_required":{"errors":[{"error_key":"naics_code","category":"invalid_attribute_value","message":"Naics code is required."}]},"company_industry_selection_naics_code_invalid":{"errors":[{"error_key":"naics_code","category":"invalid_attribute_value","message":"Naics code must be equal to 6 digits."}]},"company_industry_selection_sics_codes_invalid":{"errors":[{"error_key":"sic_codes","category":"invalid_attribute_value","message":"Sic codes must be equal to 4 digits"}]},"time_off_policy_name_required":{"errors":[{"error_key":"name","category":"invalid_attribute_value","message":"Name is required."}]},"time_off_policy_unlimited_invalid_accrual_rate":{"errors":[{"error_key":"accrual_rate","category":"invalid_operation","message":"Accrual rate must be blank for unlimited policies."}]},"time_off_policy_pending_requests":{"errors":[{"error_key":"time_off_policy","category":"invalid_operation","message":"Cannot deactivate policy with pending time off requests."}]},"time_off_policy_employees_required":{"errors":[{"error_key":"employees","category":"invalid_attribute_value","message":"Employees are required."}]},"time_off_policy_unlimited_balance_update":{"errors":[{"error_key":"base","category":"invalid_attribute_value","message":"Can not adjust balances for unlimited policies."}]},"holiday_pay_policy_already_exists":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Company already has a holiday pay policy."}]},"holiday_pay_policy_not_exists":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Company does not have a holiday pay policy, please create one"}]},"holiday_pay_policy_invalid_employees":{"errors":[{"error_key":"employees","category":"invalid_attribute_value","message":"Invalid employee uuids provided."}]},"onboarded_employee":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Cannot delete onboarded employee"}]},"invalid_attribute":{"errors":[{"error_key":"base","category":"invalid_operation","message":"There is an error in the request body."}]},"company_cannot_enable_contractor_only":{"errors":[{"error_key":"contractor_only","category":"invalid_attribute_value","message":"Contractor only cannot be enabled for existing companies."}]},"company_missing_parameter":{"errors":[{"error_key":"base","category":"missing_parameter","message":"contractor_only is required."}]},"starting_after_uuid_invalid":{"errors":[{"error_key":"starting_after_uuid","category":"invalid_attribute_value","message":"Parameter 'starting_after_uuid' does not correspond to a valid event."}]},"resource_uuid_invalid":{"errors":[{"error_key":"resource_uuid","category":"invalid_attribute_value","message":"Parameter 'resource_uuid' does not correspond to a valid resource."}]},"payroll_gross_up_invalid_net_pay":{"errors":[{"error_key":"net_pay","category":"invalid_attribute_value","message":"Net pay must be a number."}]},"payroll_accruing_hours_invalid":{"errors":[{"error_key":"base","category":"invalid_attribute_value","message":"Hours cannot be negative."}]},"payroll_cannot_cancel":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Payroll cannot be canceled."}]},"frozen_payroll":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This payroll has already been processed. Its data cannot be updated or altered."}]},"frozen_payroll_processing":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This payroll is being processed and cannot be updated at this time."}]},"unmodifiable_payroll_type":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This type of payroll cannot be modified or processed. It is reserved for system processes."}]},"invalid_employee_uuids_format":{"errors":[{"error_key":"employee_uuids","category":"invalid_attribute_value","message":"Parameter employee_uuids must be an array."}]},"maximum_employee_uuids_surpassed":{"errors":[{"error_key":"employee_uuids","category":"invalid_attribute_value","message":"Exceeded maximum of 100 for lookup."}]},"invalid_employee_uuid":{"errors":[{"error_key":"employee_uuids","category":"invalid_attribute_value","message":"Invalid Employee UUID(s).","metadata":{"entities":[{"entity_type":"Employee","entity_uuid":"invalid-uuid-123"}]}}]},"payroll_blocker_missing_bank_info":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must have a bank account in order to run payroll.","metadata":{"key":"missing_bank_info"}}]},"payroll_blocker_missing_employee_setup":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must add employees in order to run payroll.","metadata":{"key":"missing_employee_setup"}}]},"payroll_blocker_missing_federal_tax_setup":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must complete federal tax setup in order to run payroll.","metadata":{"key":"missing_federal_tax_setup"}}]},"payroll_blocker_missing_bank_verification":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company bank account must be verified in order to run payroll.","metadata":{"key":"missing_bank_verification"}}]},"payroll_blocker_suspended":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company is suspended and cannot run payroll.","metadata":{"key":"suspended"}}]},"submission_blocker_missing_selection":{"errors":[{"error_key":"submission_blockers","category":"invalid_attribute_value","message":"Submission blockers selections required"}]},"submission_blocker_invalid_option":{"errors":[{"error_key":"submission_blockers","category":"nested_errors","metadata":{"blocker_type":"fast_ach_threshold_exceeded"},"errors":[{"error_key":"selected_option","category":"invalid_attribute_value","message":"Selection is not available to resolve Fast ACH Threshold Exceeded. Please choose one of Wire In, Move To Four Day"}]}]},"invalid_version":{"errors":[{"error_key":"base","category":"invalid_resource_version","message":"You are attempting to update a resource using an out-of-date version."}]},"signatory_email_required":{"errors":[{"error_key":"email","category":"invalid_attribute_value","message":"Email is required"}]},"signatory_company_already_has_signatory":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Cannot have more than one signatory in a company. Please remove the existing signatory before adding a new one."}]},"mixed_disbursement_errors":{"errors":[{"error_key":"disbursements","category":"nested_errors","metadata":{"contractor_payment_uuid":"invalid-uuid-1"},"errors":[{"error_key":"contractor_payment_uuid","category":"not_found","message":"Disbursement not found."}]},{"error_key":"disbursements","category":"nested_errors","metadata":{"contractor_payment_uuid":"d0dfa222-ad08-4ea7-a06a-717688c3b179"},"errors":[{"error_key":"payment_method","category":"invalid_attribute_value","message":"Payment method must be one of: Direct Deposit, Check."},{"error_key":"payment_status","category":"invalid_attribute_value","message":"Payment status is not valid for payment method 'InvalidMethod'."}]}]},"not_found":{"errors":[{"error_key":"request","category":"not_found","message":"The requested resource was not found."}]},"finish_onboarding_incomplete":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Company is not ready to exit onboarding."}]},"company_location_validation":{"errors":[{"error_key":"street_1","category":"invalid_attribute_value","message":"Must include a street address"},{"error_key":"city","category":"invalid_attribute_value","message":"Must include a city"},{"error_key":"state","category":"invalid_attribute_value","message":"State is in the wrong format"},{"error_key":"zip","category":"invalid_attribute_value","message":"Please enter a valid zip code (e.g. 12345)."},{"error_key":"phone_number","category":"invalid_attribute_value","message":"Phone number must be 10 digits"}]},"conflict":{"errors":[{"error_key":"request","category":"duplicate_operation","message":"A resource with these attributes already exists."}]},"invalid_parameter":{"errors":[{"error_key":"request","category":"invalid_parameter","message":"The provided parameter is invalid or missing."}]},"flow_invalid_entity":{"errors":[{"error_key":"entity_type","category":"invalid_attribute_value","message":"Invalid flow entity"},{"error_key":"entity_uuid","category":"invalid_attribute_value","message":"Invalid flow entity"}]},"flow_nested_options_errors":{"errors":[{"error_key":"options","category":"nested_errors","metadata":{"flow_type":"company_forms"},"errors":[{"error_key":"form_types","category":"invalid_attribute_value","message":"Supplied value 'invalid' contains no permitted values"}]}]},"basic":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must complete all onboarding requirements in order to run payroll.","metadata":{"key":"needs_onboarding"}}]},"contractor_payment_invalid_wage":{"errors":[{"error_key":"wage","category":"invalid_attribute_value","message":"Wage must be greater than or equal to 0."}]},"contractor_payment_cannot_cancel":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Payment has already been processed and cannot be cancelled. Contact support directly."}]},"time_off_request_cannot_delete":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This time off request cannot be deleted."}]},"resource":{"errors":[{"error_key":"first_name","category":"invalid_attribute_value","message":"First name is required"},{"error_key":"date_of_birth","category":"invalid_attribute_value","message":"Date of birth is not a valid date"}]},"nested":{"errors":[{"error_key":"contractor_payments","category":"nested_errors","metadata":{"contractor_uuid":"72ae4617-daa9-4ed7-85e0-18ed5d0ee835"},"errors":[{"error_key":"hours","category":"invalid_attribute_value","message":"Ella Fitzgerald is paid fixed wage and hours cannot be set on a contractor payment"}]},{"error_key":"contractor_payments","category":"nested_errors","metadata":{"contractor_uuid":"2d7bf62c-babf-4a12-8292-340e2d9cab28"},"errors":[{"error_key":"wage","category":"invalid_attribute_value","message":"Isaiah Berlin is paid hourly and wage cannot be set on a contractor payment"}]}]},"compensation_invalid_rate":{"errors":[{"error_key":"rate","category":"invalid_attribute_value","message":"Rate is not a valid number"}]},"compensation_invalid_payment_unit":{"errors":[{"error_key":"payment_unit","category":"invalid_attribute_value","message":"Payment unit must be one of Hour, Week, Month, or Year"}]},"compensation_already_processed":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Compensation has already been processed on payroll."}]}},"title":"Unprocessable-Entity-Error-Object"},"examples":{"Example":{"value":{"errors":[{"error_key":"employment","category":"incorrect_state","message":"The employee's employment is not in the right state."}]}}}}}},"422":{"description":"Unprocessable Entity \n \nThis 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.\n","content":{"application/json":{"schema":{"description":"Unprocessable Entity\n \nThis 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.\n","type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["error_key","category"],"properties":{"error_key":{"type":"string","description":"Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error."},"category":{"type":"string","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."},"message":{"type":"string","description":"Provides details about the error - generally this message can be surfaced to an end user."},"metadata":{"type":"object","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.","oneOf":[{"type":"object","description":"multiple entities","required":["entities"],"properties":{"entities":{"type":"array","items":{"type":"object","description":"single entity","additionalProperties":true,"properties":{"entity_type":{"type":"string","description":"Name of the entity that the error corresponds to."},"entity_uuid":{"type":"string","description":"Unique identifier for the entity."},"valid_from":{"type":["string","null"]},"valid_up_to":{"type":["string","null"]},"key":{"type":["string","null"]},"state":{"type":["string","null"]}},"title":"Metadata-With-One-Entity"}}},"title":"Metadata-With-Multiple-Entities"},{"type":"object","description":"single entity","additionalProperties":true,"properties":{"entity_type":{"type":"string","description":"Name of the entity that the error corresponds to."},"entity_uuid":{"type":"string","description":"Unique identifier for the entity."},"valid_from":{"type":["string","null"]},"valid_up_to":{"type":["string","null"]},"key":{"type":["string","null"]},"state":{"type":["string","null"]}},"title":"Metadata-With-One-Entity"}]},"errors":{"type":"array","description":"Will only exist if category is `nested_errors`. It is possible to have multiple levels of nested errors.","items":"circular(Entity-Error-Object)"}},"title":"Entity-Error-Object"}}},"x-examples":{"bank_account_delete_unfunded_payments":{"errors":[{"error_key":"base","category":"invalid_operation","message":"FundingMethod has unfunded payments"}]},"bank_account_verify_incorrect_deposits":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Your bank account cannot be verified. Please check the test deposit amounts."}]},"bank_account_verify_already_verified":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Your bank account has already been verified."}]},"bank_account_missing_routing":{"errors":[{"error_key":"routing_number","category":"invalid_attribute_value","message":"Routing number is required."}]},"payment_configs_missing_parameter":{"errors":[{"error_key":"base","category":"missing_parameter","message":"At least one parameter must be provided"}]},"payment_configs_invalid_fast_payment_limit":{"errors":[{"error_key":"fast_payment_limit","category":"invalid_attribute_value","message":"Fast payment limit should be a number"}]},"pay_periods_invalid_end_date":{"errors":[{"error_key":"end_date","category":"invalid_parameter","message":"End date cannot be more than 3 months in future"}]},"company_industry_selection_naics_code_required":{"errors":[{"error_key":"naics_code","category":"invalid_attribute_value","message":"Naics code is required."}]},"company_industry_selection_naics_code_invalid":{"errors":[{"error_key":"naics_code","category":"invalid_attribute_value","message":"Naics code must be equal to 6 digits."}]},"company_industry_selection_sics_codes_invalid":{"errors":[{"error_key":"sic_codes","category":"invalid_attribute_value","message":"Sic codes must be equal to 4 digits"}]},"time_off_policy_name_required":{"errors":[{"error_key":"name","category":"invalid_attribute_value","message":"Name is required."}]},"time_off_policy_unlimited_invalid_accrual_rate":{"errors":[{"error_key":"accrual_rate","category":"invalid_operation","message":"Accrual rate must be blank for unlimited policies."}]},"time_off_policy_pending_requests":{"errors":[{"error_key":"time_off_policy","category":"invalid_operation","message":"Cannot deactivate policy with pending time off requests."}]},"time_off_policy_employees_required":{"errors":[{"error_key":"employees","category":"invalid_attribute_value","message":"Employees are required."}]},"time_off_policy_unlimited_balance_update":{"errors":[{"error_key":"base","category":"invalid_attribute_value","message":"Can not adjust balances for unlimited policies."}]},"holiday_pay_policy_already_exists":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Company already has a holiday pay policy."}]},"holiday_pay_policy_not_exists":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Company does not have a holiday pay policy, please create one"}]},"holiday_pay_policy_invalid_employees":{"errors":[{"error_key":"employees","category":"invalid_attribute_value","message":"Invalid employee uuids provided."}]},"onboarded_employee":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Cannot delete onboarded employee"}]},"invalid_attribute":{"errors":[{"error_key":"base","category":"invalid_operation","message":"There is an error in the request body."}]},"company_cannot_enable_contractor_only":{"errors":[{"error_key":"contractor_only","category":"invalid_attribute_value","message":"Contractor only cannot be enabled for existing companies."}]},"company_missing_parameter":{"errors":[{"error_key":"base","category":"missing_parameter","message":"contractor_only is required."}]},"starting_after_uuid_invalid":{"errors":[{"error_key":"starting_after_uuid","category":"invalid_attribute_value","message":"Parameter 'starting_after_uuid' does not correspond to a valid event."}]},"resource_uuid_invalid":{"errors":[{"error_key":"resource_uuid","category":"invalid_attribute_value","message":"Parameter 'resource_uuid' does not correspond to a valid resource."}]},"payroll_gross_up_invalid_net_pay":{"errors":[{"error_key":"net_pay","category":"invalid_attribute_value","message":"Net pay must be a number."}]},"payroll_accruing_hours_invalid":{"errors":[{"error_key":"base","category":"invalid_attribute_value","message":"Hours cannot be negative."}]},"payroll_cannot_cancel":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Payroll cannot be canceled."}]},"frozen_payroll":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This payroll has already been processed. Its data cannot be updated or altered."}]},"frozen_payroll_processing":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This payroll is being processed and cannot be updated at this time."}]},"unmodifiable_payroll_type":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This type of payroll cannot be modified or processed. It is reserved for system processes."}]},"invalid_employee_uuids_format":{"errors":[{"error_key":"employee_uuids","category":"invalid_attribute_value","message":"Parameter employee_uuids must be an array."}]},"maximum_employee_uuids_surpassed":{"errors":[{"error_key":"employee_uuids","category":"invalid_attribute_value","message":"Exceeded maximum of 100 for lookup."}]},"invalid_employee_uuid":{"errors":[{"error_key":"employee_uuids","category":"invalid_attribute_value","message":"Invalid Employee UUID(s).","metadata":{"entities":[{"entity_type":"Employee","entity_uuid":"invalid-uuid-123"}]}}]},"payroll_blocker_missing_bank_info":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must have a bank account in order to run payroll.","metadata":{"key":"missing_bank_info"}}]},"payroll_blocker_missing_employee_setup":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must add employees in order to run payroll.","metadata":{"key":"missing_employee_setup"}}]},"payroll_blocker_missing_federal_tax_setup":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must complete federal tax setup in order to run payroll.","metadata":{"key":"missing_federal_tax_setup"}}]},"payroll_blocker_missing_bank_verification":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company bank account must be verified in order to run payroll.","metadata":{"key":"missing_bank_verification"}}]},"payroll_blocker_suspended":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company is suspended and cannot run payroll.","metadata":{"key":"suspended"}}]},"submission_blocker_missing_selection":{"errors":[{"error_key":"submission_blockers","category":"invalid_attribute_value","message":"Submission blockers selections required"}]},"submission_blocker_invalid_option":{"errors":[{"error_key":"submission_blockers","category":"nested_errors","metadata":{"blocker_type":"fast_ach_threshold_exceeded"},"errors":[{"error_key":"selected_option","category":"invalid_attribute_value","message":"Selection is not available to resolve Fast ACH Threshold Exceeded. Please choose one of Wire In, Move To Four Day"}]}]},"invalid_version":{"errors":[{"error_key":"base","category":"invalid_resource_version","message":"You are attempting to update a resource using an out-of-date version."}]},"signatory_email_required":{"errors":[{"error_key":"email","category":"invalid_attribute_value","message":"Email is required"}]},"signatory_company_already_has_signatory":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Cannot have more than one signatory in a company. Please remove the existing signatory before adding a new one."}]},"mixed_disbursement_errors":{"errors":[{"error_key":"disbursements","category":"nested_errors","metadata":{"contractor_payment_uuid":"invalid-uuid-1"},"errors":[{"error_key":"contractor_payment_uuid","category":"not_found","message":"Disbursement not found."}]},{"error_key":"disbursements","category":"nested_errors","metadata":{"contractor_payment_uuid":"d0dfa222-ad08-4ea7-a06a-717688c3b179"},"errors":[{"error_key":"payment_method","category":"invalid_attribute_value","message":"Payment method must be one of: Direct Deposit, Check."},{"error_key":"payment_status","category":"invalid_attribute_value","message":"Payment status is not valid for payment method 'InvalidMethod'."}]}]},"not_found":{"errors":[{"error_key":"request","category":"not_found","message":"The requested resource was not found."}]},"finish_onboarding_incomplete":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Company is not ready to exit onboarding."}]},"company_location_validation":{"errors":[{"error_key":"street_1","category":"invalid_attribute_value","message":"Must include a street address"},{"error_key":"city","category":"invalid_attribute_value","message":"Must include a city"},{"error_key":"state","category":"invalid_attribute_value","message":"State is in the wrong format"},{"error_key":"zip","category":"invalid_attribute_value","message":"Please enter a valid zip code (e.g. 12345)."},{"error_key":"phone_number","category":"invalid_attribute_value","message":"Phone number must be 10 digits"}]},"conflict":{"errors":[{"error_key":"request","category":"duplicate_operation","message":"A resource with these attributes already exists."}]},"invalid_parameter":{"errors":[{"error_key":"request","category":"invalid_parameter","message":"The provided parameter is invalid or missing."}]},"flow_invalid_entity":{"errors":[{"error_key":"entity_type","category":"invalid_attribute_value","message":"Invalid flow entity"},{"error_key":"entity_uuid","category":"invalid_attribute_value","message":"Invalid flow entity"}]},"flow_nested_options_errors":{"errors":[{"error_key":"options","category":"nested_errors","metadata":{"flow_type":"company_forms"},"errors":[{"error_key":"form_types","category":"invalid_attribute_value","message":"Supplied value 'invalid' contains no permitted values"}]}]},"basic":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must complete all onboarding requirements in order to run payroll.","metadata":{"key":"needs_onboarding"}}]},"contractor_payment_invalid_wage":{"errors":[{"error_key":"wage","category":"invalid_attribute_value","message":"Wage must be greater than or equal to 0."}]},"contractor_payment_cannot_cancel":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Payment has already been processed and cannot be cancelled. Contact support directly."}]},"time_off_request_cannot_delete":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This time off request cannot be deleted."}]},"resource":{"errors":[{"error_key":"first_name","category":"invalid_attribute_value","message":"First name is required"},{"error_key":"date_of_birth","category":"invalid_attribute_value","message":"Date of birth is not a valid date"}]},"nested":{"errors":[{"error_key":"contractor_payments","category":"nested_errors","metadata":{"contractor_uuid":"72ae4617-daa9-4ed7-85e0-18ed5d0ee835"},"errors":[{"error_key":"hours","category":"invalid_attribute_value","message":"Ella Fitzgerald is paid fixed wage and hours cannot be set on a contractor payment"}]},{"error_key":"contractor_payments","category":"nested_errors","metadata":{"contractor_uuid":"2d7bf62c-babf-4a12-8292-340e2d9cab28"},"errors":[{"error_key":"wage","category":"invalid_attribute_value","message":"Isaiah Berlin is paid hourly and wage cannot be set on a contractor payment"}]}]},"compensation_invalid_rate":{"errors":[{"error_key":"rate","category":"invalid_attribute_value","message":"Rate is not a valid number"}]},"compensation_invalid_payment_unit":{"errors":[{"error_key":"payment_unit","category":"invalid_attribute_value","message":"Payment unit must be one of Hour, Week, Month, or Year"}]},"compensation_already_processed":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Compensation has already been processed on payroll."}]}},"title":"Unprocessable-Entity-Error-Object"},"examples":{"Basic":{"value":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must complete all onboarding requirements in order to run payroll.","metadata":{"key":"needs_onboarding"}}]}},"Resource":{"value":{"errors":[{"error_key":"first_name","category":"invalid_attribute_value","message":"First name is required"},{"error_key":"date_of_birth","category":"invalid_attribute_value","message":"Date of birth is not a valid date"}]}},"Nested":{"value":{"errors":[{"error_key":"contractor_payments","category":"nested_errors","metadata":{"contractor_uuid":"72ae4617-daa9-4ed7-85e0-18ed5d0ee835"},"errors":[{"error_key":"hours","category":"invalid_attribute_value","message":"Ella Fitzgerald is paid fixed wage and hours cannot be set on a contractor payment"}]},{"error_key":"contractor_payments","category":"nested_errors","metadata":{"contractor_uuid":"2d7bf62c-babf-4a12-8292-340e2d9cab28"},"errors":[{"error_key":"wage","category":"invalid_attribute_value","message":"Isaiah Berlin is paid hourly and wage cannot be set on a contractor payment"}]}]}}}}}}}}
\ No newline at end of file
diff --git a/docs/api/delete-v-1-employees-employee-id-rehire.api.mdx b/docs/api/delete-v-1-employees-employee-id-rehire.api.mdx
new file mode 100644
index 000000000..4059d2cf8
--- /dev/null
+++ b/docs/api/delete-v-1-employees-employee-id-rehire.api.mdx
@@ -0,0 +1,71 @@
+---
+id: delete-v-1-employees-employee-id-rehire
+title: "Delete an employee rehire"
+description: "Delete an employee rehire. An employee rehire cannot be deleted if it's active (past effective date)."
+sidebar_label: "Delete an employee rehire"
+hide_title: true
+hide_table_of_contents: true
+api: eJztXelvGzmy/1e4/T44eVDLR5xj/Gm9sfPWwGbGyLHZhRO0qWa1xEk32SHZsjWG//dF8ehLhy3Hxj4M+sNgYoks/lisi8Uq+ya6jqeVNjLmwsBUUcOliM2ihOjoIoJiAowBi0YRLcv2EB19G0UMdKp4iT9HR9EJ5GCAUEGgKHO5ACAKZlzBmBwvfUZSKoQ0ZAKE2XmM8Ixws6MJTQ2fA3lWUm0IZBm4nxk18Hz8VXwVOpUlHJFLR7IAYfTRleIGLqNRJEtwCM9YdBQ52vF8Pw7r6/pfCWexAxONIgW6lEKDjo5uooO9Q/xfd3u/SvJWCgPCRLej6HD1EEPeyUowRPm/5NMMd/ujAo3bU6BlpVIgTIImuHe45tqMyXv6HYiuFBAzA1IqOecMGPn8+eyEcE3mNOdsHOgF8DuaNNvHYUiQC0tC8enMEG2ogXE0ilKP+ugGDzHnqWXP7u8aMd9EOp1BQZc381mUSqagNZ3kQE6F4WbxVRDyVXyacU0KuiAzWpYgyNUM3MITyRZEZmQhKxV2TnB5yoUmoJRUmugqnRGqySUXdmsJNUbxSWUgmdO8gssRkcrtw1PIKM81YRUQI1G86pn1WV+OyUdw/Ls4dcu8pQamUnHQ357NjCn10e4uk6keW2kfp7LYDdIdl3ShZJ7b73ctzDitpz8n04ozIJlUpJAK5dUgoPFXEY0ipymRnPwOqbFy9KPiCpjVHosEFaVUCNVwJ17+86ObMJsqRRfRKOIGivbn66km3wEneJSLNWvYUQ05bRQX06ivtx9LSHnGQeNBeim004lM00rpMfm0KHlK83xBDB79d1gQzkAYNwvH12e4W1JFCzCAApBTFHwjG5Jj1J0a9RbQkAKORfFylKw6BFJBbbyUkamSVcnFVBMqGNoaNDSVdmgmFc8ZSVEOCj9+RgXLuZiiClnpbZm6MTnLmoW4JpfCanTizvFyZMG5syJXPM+DyBNK3Ehy6YcSf0gLcsXNjIBVKq8YljUF6tsU7ubMedivl0ZCJ7IyrbOLyRQEqObUPOnADF2pjKaOIWiyBUP+KI/CUEYNXSWKXRhvg3IryGFOhUEzTZGmF5CF12Rv+7ggVqe59GbDW6RJDmPyTioC17Qocxh1SFh8llWX7v8Jorq0Zxs+qSrOLh37J40VRfsnBfyWRUcXd+2lqHLDyxzcWqhHPcULHy8rW/hmC5Xurq25mIaVcRpljONXND9vrWRUBSvXdgy5W2p+pYXVICsmjqNmRttik0rlXCHTxEgrDS0G373CZ8F/VNCYB2XtZrOepeisd6Zk0RC8aCiKKs+jb/W4qkyM3DywY+dWDbDOcNOQ21FkuMlxZ++99MdfuJnFvwmInfOLbtePeu9lxw3Fo7kdDWf+ZzhzpLTWYXf58AWNjxT5wkV2GNBucBtjcmYDt1JqzTHEMpLM6BxIbYdymEOu8ey8GwmOojYrUcpVWuVUPXNwYxv8xL9ZgXsetXe4YoAT6OvY21y7wQkV3xOaprISJnHRc1KJrBIMWFJSF223g5iLTqwRTaiGdmByFC0Fa1HLzUXvKsG4mL4HM5OMzKgmYTVSr2bPoANsDopni4QLK7opIi2l5o+K7N8YBuCqxK/aurLY9TmwMTnPgWog6QzS7y5IwYjVwyG0wIno2tdtgeYKKFskgeKTbgDZ6xckEwDR7GMFwIJrtFCJkpVBtVkPzI9IRFVMQK2G2AvyO0A/uPnEzUedCG7X4/KSkKRSZHyqa2h1rLkV15Znt8EcG4JHaogUQJpgtqi0aQcWq4GF3WZUm6AtSc4LbjYgXDF4axa+Q8SeBrE0iJ7JKmeImXrO1piTEhSXrMELgiXMW8s1KOshK7Gt5uWpYPba3tIce4MyMyrIC1JIYWYaY8KsMpUChy+VRUkFKjertFGLREOOKQApEkF5qpNUMkiawGwt4mb09vz8FecSnLtCHO+H0C/z9ACDaMKPiuboRV4Rxqe8Njsb4OoAQN8DruapG7s92o88tVj1MthDD9ZhNbyARGZZUsqcp4tE0OKeZ108iInFqvPtg6iE1Shgtb7QNFUVzRO1WWc6w7aw3MduHsF5NccmOZpyjKxqPMQC5KDXAC/BOtfEJ1I2ecfe1G3QvnXKzcAm7hCyo+HuuB4DwQWIzLKQ1VmHuc7T3efY68Hbn/1pmEqogvtLwITmVKSQVOUd9nK9t96E6i0VNpNH2e/22N1qevOxz2TOGVp1/M8BDmGFDUQfMyp664xJHUbYkIJ4BOiB/OGvhyakeTpYdW7VRtKrgI1I6UM2BSirUsBaqLV7rMXsSUTxzI1pUuR47dKtHIbFJ8VEUoVheBj3mPwLOmxT+PVSNSQHYWkzj4jgk809cm2TPfZaGrLZPguMyeWeR3NhRQIC80cYhBlFUyNVgpewDdj6I7dX05qAu+818Y3DwqzCWilH2+fwNgob8D9lHNvb4wo3pw1VNm6nmQFl7/r3iQKWZ23Pv/M6rt5ZQW+nUeMmNWHzlMQryhyE8bsIqcX74u+M/ynkHUp3Yg6jmysNPjkkUyW1xnRHWFyAvQxsinX8iO3DHbB3hDqiCPeCHiQbteCJzGSl7hMYPszV/R2ptzRHwJTiQ18PjdfxFP1g/oj25tzRbwFwS9TqkSn5B4jE43hUS4dZH7/80pXcP7phbuHMaJdObzC6sIPhCxnNDag1aBNPZfO9/aeAc00mgMatBhyeWnpQbaqRaxsAerCVKCTjGbdmO0AO2czHBBtejMqlw3YAHCc7LHeGUoOaeyuuF9pAUQ8KNrwfG1groJNMqoJuuu13x/+MAepSarRaEJue9DgLes2Lqujj1JUqKe75CaGeXqcAGEV4DHgS+3t7lqu5lN+rchMvnxBYCLjCHcC+tT/Tz8dR9+2rede56CXd6+tD1MuVh/Vj/DHeP3iBO+wYtEku0++gaudvk25cZHIr4e9RWxkMW4nwgXAnD8gFkYqBQv+kKhHUo799t/Yyzs37qQ9Hg6nKp9kUZU1oqh+2nR7MzXvKgOFTamLo9VNuC+NCG4D79Yih18Su97A9LsO+hyi6nLArEnn0bXbEMFiskIX+CbnsgF69SV1pzEVsmWK/z6Y4FrV44m0neOcWGkgOsq4mdldSLB1NnbPbFJovTX9Iqq4mQgIRUi/e3CGidYAbr/yzaDvPZT3+hdW8NbYpdJrOEjNToGcyZwl45xO13u/6COy2oMa6Pa8CX0IBFp1TnlP/mIcRfz4HYnPzx2//Tj4FcCR4xtb7kZTaJiPQSX7BArkzMSLv5RzIJ4lFZYqcUPsc2XaYc1B6WzUNc+vrSyDSezuyeTFqDBSlvcQa6UM6Qpt6jgqFE0MOWZlYZrH93hMM10w+FdRIhak9yvP7pfUozx+S0qM8b190+wDCvTtkx2ZUJ/W3j59Nca+59YMHHm69GrHlQR5QLQYKCjxx+3QekgfNlAlkSAzrBJDpRMAVEg2BHr8GljCuJ5XSYB+TmnfrNRtrj95C+1q5hfButTL62aB760h0MUiTZFhP2eHuSQu01To7xHHhibfH9lhGDw4OYsr23sSHQF/HdO8VjV/vv3715k36YrL/+pcNmw7UCvva/ZDY3z3wufm1/3RW44iccHwLJyfu8XlE3uKj9DjqcyWgwPqI6kE3EIfCzQ+mz0XUGNqXXZQ7Ptp2T/w742DDmsPdlKyxub/7SMWaYtsrqvsyEmVccD1LfJYTvSsWErjQ6wly0p5B7o5vJGq2Ic3ivZxgLl0Uk1jSd0Vh2igAk+xvf4rvUXi4SPOKoUV3hNC2KNB6SWZSV6L0c2tYIn3Krkpne9eL05C1Pkt8paSYEn/77q/xBy8fIObOJIPAu3bI4v3BS/fo+gzG0zHZP3hx+PL5ChWbSQEProc4x9mhGiIo+f5e56EUKw5ynm7KNKxUHla5CnBY9/TYUh18vjMz0K3y3iZZ5Z5wehf4+ySyV8LaXEfwqV0X39Rk2NN354K12S5SDjqey6tWeYOt5dpU3NDc7R+cTcAlQzVfXyDaOYLHWaDepPdkLobVd/t8P/D+7tCu4gPtYKVQ0fQGT4ff2zkPuoFgTTAwYr8iO37OTtNJICQpQRXcmDBKB68yoZqnT3w7p7bML9jvEG3aIGO7K6wAYLrlh/w1cEX8Efh25YvD1+zOfr01w79gWXiwM1P7LKp8yKqaQo292lEtoXvCHL2NJNYnyXs5Z4cAc/i2V4emhuiqLKUyhNngKF/0X/i9OQp7cC+gj56H7hU/LHc/9V6zNpWLcaVN8rCCl3c4l4he2cuStWLWP2TJhCsz236VE/uunhE7vb4aew9qyyZcAGhtzv2eaeta0IcE8T54f31A4fDV/uuYUfpLfAjsdfzmJezF+2+AvWR7AG9evNxg0uxr2AMupXlOyTtu/phiKo7Zil+KxhyvawQV1srwrPcapgFjRHtFrJ+aPRNWXHQemVMH7PUke3WQxhM6yeJDun8Qvzn45SB+cbgHB+yXlE4O3mzg1MOs0JmmnM7I30DlXNRsQr7kC8uiK9+9cj8OhZgahHbxdJ332Fy3s75Wa2MJq49G25LeLrpciaS+XIqN9aGdYQ++reHs3o2R4BPsiHwB+I6pJmFmtvXu30BXoQ5Jk9r2PvJVKSy0ydrLlkO97RTwd7oV45XF7qOoXeh+6v6N/3RMu+u5yQpWb0+h/DxcYroh69a9mrilW1uUf3hwcL+OTDK0ZPZbMod+16Hfdeh3Hfpdh37Xod916H0c+l2HMx/6XYd+16Hfdeh3Hfpdh37Xod916Hcd+l2Hfteh33Xodx36XYd+16Hfdeh3Hfpdh37Xod916Hcd+l2Hfteh33Xodx36XYd+16Hfdeh3Hfpdh37Xod916Hcd+l2Hftf756SHfteh33Xodx36XYd+16Hfdeh3Hfpdh37Xod916Hcd+l2Hftf/Zr/r30KgcFe36///iOF2FH1o+Y27NvQncSC3o+jX2oPctefBlQyu5CdcSWhDr++eDqnVodZztL3ccWFNhJX7Jtft2riaXutuR9Vtv5UIb7z2Dx6Hxq26Dm9UL/uv+P/sH6o+Pj+L/1nn8O3yM6DMGqYGQEZzDct/otrgPUr4BltUrRjtHSPH52chj0+o1jLltpjD5gRsgywOwJ5g2x0r0KHwpmRx5Ma02s13NLkouLBlAC3aW/Zm05LHfiYX0//xBOPWx88RBjb6ov1cx258s68KbAk72Dt4Ge+9ivdfur/fndEqNyi2zee3t99GkaFTPPL62d+XDjj1+IZNVLoE+h2oXsS297glFu2h3ZF4kLGcg1KcQf3XuT+Ev8EN1waEtpd1lDanEWv/PPkoGME7/kw5SlAg1Qdd01gJfvXM7iYaCp3NIA991jt8E42clhxFu/P93fo1f/empU63u/UfJLcVOV7vKpWjkHvJoSV3ghMzKKz0LHXmnUAhe7x39GKX1sevcXdrCK+kea5sCn8dzRK/xm1rSCtl008XNyE8OE4xVDmucPsX39qjPqLIughlxdhakBFiEHD8eQJUWYXvt2dbErHtJCS0MjNMH4Vn8lH00dY2/cwKjsKaBWxm0BW2hDjNmiy0ACgp4fWyrW6jCE2S/i37CGrOU2idR2MdbLP7rh24y3BpDCtj+zO+Qmo/dalBE/JUFvZx1uLY0eTUqwoJ9YBonJhMKxR5u42/+F+hQV2y1Rvfk7Aq+YC/5sBn1NzDJQqU//avjfxY/yG1Kajo0HEBomiqv2uR74C/aX6Px/pJY3K89NlyrgEbU7nZ0cQ2bAB5VuILNWQZuJ/RDTwffxVfhU5lCUfksvl1LfroSnEDl82vvjBwbXbLnHIrUVaDbrxmX0TzfcuVpjT+qOss/V6/Yfm9Njjj5gYd0GeV397ixz8qQLd/8Q0Ni7IVg1aRGLeR/hrH1mbWsw/eBz4na73qms2Ebl+xaNm1yLced9y+6yBwXnc7eH9yF7ySr45/q+OXms2Nt0H7VJrWd0u/xqbjXk5O/3H66TS6vf0P25K7ew==
+sidebar_class_name: "delete api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Delete an employee rehire. An employee rehire cannot be deleted if it's active (past effective date).
+
+scope: `employments:write`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/delete-v-1-employees-employee-id-terminations.ParamsDetails.json b/docs/api/delete-v-1-employees-employee-id-terminations.ParamsDetails.json
new file mode 100644
index 000000000..230d65c22
--- /dev/null
+++ b/docs/api/delete-v-1-employees-employee-id-terminations.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"employee_id","in":"path","required":true,"schema":{"type":"string"},"description":"The UUID of the employee"},{"name":"X-Gusto-API-Version","in":"header","required":false,"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.","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"}}]}
\ No newline at end of file
diff --git a/docs/api/delete-v-1-employees-employee-id-terminations.RequestSchema.json b/docs/api/delete-v-1-employees-employee-id-terminations.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/delete-v-1-employees-employee-id-terminations.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/delete-v-1-employees-employee-id-terminations.StatusCodes.json b/docs/api/delete-v-1-employees-employee-id-terminations.StatusCodes.json
new file mode 100644
index 000000000..adc835de6
--- /dev/null
+++ b/docs/api/delete-v-1-employees-employee-id-terminations.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"204":{"description":"No Content"},"404":{"description":"Not Found\n\n* The requested resource does not exist. Make sure the provided UUID is valid.\n* The employee's employment is not in the right state.","content":{"application/json":{"schema":{"description":"Unprocessable Entity\n \nThis 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.\n","type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["error_key","category"],"properties":{"error_key":{"type":"string","description":"Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error."},"category":{"type":"string","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."},"message":{"type":"string","description":"Provides details about the error - generally this message can be surfaced to an end user."},"metadata":{"type":"object","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.","oneOf":[{"type":"object","description":"multiple entities","required":["entities"],"properties":{"entities":{"type":"array","items":{"type":"object","description":"single entity","additionalProperties":true,"properties":{"entity_type":{"type":"string","description":"Name of the entity that the error corresponds to."},"entity_uuid":{"type":"string","description":"Unique identifier for the entity."},"valid_from":{"type":["string","null"]},"valid_up_to":{"type":["string","null"]},"key":{"type":["string","null"]},"state":{"type":["string","null"]}},"title":"Metadata-With-One-Entity"}}},"title":"Metadata-With-Multiple-Entities"},{"type":"object","description":"single entity","additionalProperties":true,"properties":{"entity_type":{"type":"string","description":"Name of the entity that the error corresponds to."},"entity_uuid":{"type":"string","description":"Unique identifier for the entity."},"valid_from":{"type":["string","null"]},"valid_up_to":{"type":["string","null"]},"key":{"type":["string","null"]},"state":{"type":["string","null"]}},"title":"Metadata-With-One-Entity"}]},"errors":{"type":"array","description":"Will only exist if category is `nested_errors`. It is possible to have multiple levels of nested errors.","items":"circular(Entity-Error-Object)"}},"title":"Entity-Error-Object"}}},"x-examples":{"bank_account_delete_unfunded_payments":{"errors":[{"error_key":"base","category":"invalid_operation","message":"FundingMethod has unfunded payments"}]},"bank_account_verify_incorrect_deposits":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Your bank account cannot be verified. Please check the test deposit amounts."}]},"bank_account_verify_already_verified":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Your bank account has already been verified."}]},"bank_account_missing_routing":{"errors":[{"error_key":"routing_number","category":"invalid_attribute_value","message":"Routing number is required."}]},"payment_configs_missing_parameter":{"errors":[{"error_key":"base","category":"missing_parameter","message":"At least one parameter must be provided"}]},"payment_configs_invalid_fast_payment_limit":{"errors":[{"error_key":"fast_payment_limit","category":"invalid_attribute_value","message":"Fast payment limit should be a number"}]},"pay_periods_invalid_end_date":{"errors":[{"error_key":"end_date","category":"invalid_parameter","message":"End date cannot be more than 3 months in future"}]},"company_industry_selection_naics_code_required":{"errors":[{"error_key":"naics_code","category":"invalid_attribute_value","message":"Naics code is required."}]},"company_industry_selection_naics_code_invalid":{"errors":[{"error_key":"naics_code","category":"invalid_attribute_value","message":"Naics code must be equal to 6 digits."}]},"company_industry_selection_sics_codes_invalid":{"errors":[{"error_key":"sic_codes","category":"invalid_attribute_value","message":"Sic codes must be equal to 4 digits"}]},"time_off_policy_name_required":{"errors":[{"error_key":"name","category":"invalid_attribute_value","message":"Name is required."}]},"time_off_policy_unlimited_invalid_accrual_rate":{"errors":[{"error_key":"accrual_rate","category":"invalid_operation","message":"Accrual rate must be blank for unlimited policies."}]},"time_off_policy_pending_requests":{"errors":[{"error_key":"time_off_policy","category":"invalid_operation","message":"Cannot deactivate policy with pending time off requests."}]},"time_off_policy_employees_required":{"errors":[{"error_key":"employees","category":"invalid_attribute_value","message":"Employees are required."}]},"time_off_policy_unlimited_balance_update":{"errors":[{"error_key":"base","category":"invalid_attribute_value","message":"Can not adjust balances for unlimited policies."}]},"holiday_pay_policy_already_exists":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Company already has a holiday pay policy."}]},"holiday_pay_policy_not_exists":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Company does not have a holiday pay policy, please create one"}]},"holiday_pay_policy_invalid_employees":{"errors":[{"error_key":"employees","category":"invalid_attribute_value","message":"Invalid employee uuids provided."}]},"onboarded_employee":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Cannot delete onboarded employee"}]},"invalid_attribute":{"errors":[{"error_key":"base","category":"invalid_operation","message":"There is an error in the request body."}]},"company_cannot_enable_contractor_only":{"errors":[{"error_key":"contractor_only","category":"invalid_attribute_value","message":"Contractor only cannot be enabled for existing companies."}]},"company_missing_parameter":{"errors":[{"error_key":"base","category":"missing_parameter","message":"contractor_only is required."}]},"starting_after_uuid_invalid":{"errors":[{"error_key":"starting_after_uuid","category":"invalid_attribute_value","message":"Parameter 'starting_after_uuid' does not correspond to a valid event."}]},"resource_uuid_invalid":{"errors":[{"error_key":"resource_uuid","category":"invalid_attribute_value","message":"Parameter 'resource_uuid' does not correspond to a valid resource."}]},"payroll_gross_up_invalid_net_pay":{"errors":[{"error_key":"net_pay","category":"invalid_attribute_value","message":"Net pay must be a number."}]},"payroll_accruing_hours_invalid":{"errors":[{"error_key":"base","category":"invalid_attribute_value","message":"Hours cannot be negative."}]},"payroll_cannot_cancel":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Payroll cannot be canceled."}]},"frozen_payroll":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This payroll has already been processed. Its data cannot be updated or altered."}]},"frozen_payroll_processing":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This payroll is being processed and cannot be updated at this time."}]},"unmodifiable_payroll_type":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This type of payroll cannot be modified or processed. It is reserved for system processes."}]},"invalid_employee_uuids_format":{"errors":[{"error_key":"employee_uuids","category":"invalid_attribute_value","message":"Parameter employee_uuids must be an array."}]},"maximum_employee_uuids_surpassed":{"errors":[{"error_key":"employee_uuids","category":"invalid_attribute_value","message":"Exceeded maximum of 100 for lookup."}]},"invalid_employee_uuid":{"errors":[{"error_key":"employee_uuids","category":"invalid_attribute_value","message":"Invalid Employee UUID(s).","metadata":{"entities":[{"entity_type":"Employee","entity_uuid":"invalid-uuid-123"}]}}]},"payroll_blocker_missing_bank_info":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must have a bank account in order to run payroll.","metadata":{"key":"missing_bank_info"}}]},"payroll_blocker_missing_employee_setup":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must add employees in order to run payroll.","metadata":{"key":"missing_employee_setup"}}]},"payroll_blocker_missing_federal_tax_setup":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must complete federal tax setup in order to run payroll.","metadata":{"key":"missing_federal_tax_setup"}}]},"payroll_blocker_missing_bank_verification":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company bank account must be verified in order to run payroll.","metadata":{"key":"missing_bank_verification"}}]},"payroll_blocker_suspended":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company is suspended and cannot run payroll.","metadata":{"key":"suspended"}}]},"submission_blocker_missing_selection":{"errors":[{"error_key":"submission_blockers","category":"invalid_attribute_value","message":"Submission blockers selections required"}]},"submission_blocker_invalid_option":{"errors":[{"error_key":"submission_blockers","category":"nested_errors","metadata":{"blocker_type":"fast_ach_threshold_exceeded"},"errors":[{"error_key":"selected_option","category":"invalid_attribute_value","message":"Selection is not available to resolve Fast ACH Threshold Exceeded. Please choose one of Wire In, Move To Four Day"}]}]},"invalid_version":{"errors":[{"error_key":"base","category":"invalid_resource_version","message":"You are attempting to update a resource using an out-of-date version."}]},"signatory_email_required":{"errors":[{"error_key":"email","category":"invalid_attribute_value","message":"Email is required"}]},"signatory_company_already_has_signatory":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Cannot have more than one signatory in a company. Please remove the existing signatory before adding a new one."}]},"mixed_disbursement_errors":{"errors":[{"error_key":"disbursements","category":"nested_errors","metadata":{"contractor_payment_uuid":"invalid-uuid-1"},"errors":[{"error_key":"contractor_payment_uuid","category":"not_found","message":"Disbursement not found."}]},{"error_key":"disbursements","category":"nested_errors","metadata":{"contractor_payment_uuid":"d0dfa222-ad08-4ea7-a06a-717688c3b179"},"errors":[{"error_key":"payment_method","category":"invalid_attribute_value","message":"Payment method must be one of: Direct Deposit, Check."},{"error_key":"payment_status","category":"invalid_attribute_value","message":"Payment status is not valid for payment method 'InvalidMethod'."}]}]},"not_found":{"errors":[{"error_key":"request","category":"not_found","message":"The requested resource was not found."}]},"finish_onboarding_incomplete":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Company is not ready to exit onboarding."}]},"company_location_validation":{"errors":[{"error_key":"street_1","category":"invalid_attribute_value","message":"Must include a street address"},{"error_key":"city","category":"invalid_attribute_value","message":"Must include a city"},{"error_key":"state","category":"invalid_attribute_value","message":"State is in the wrong format"},{"error_key":"zip","category":"invalid_attribute_value","message":"Please enter a valid zip code (e.g. 12345)."},{"error_key":"phone_number","category":"invalid_attribute_value","message":"Phone number must be 10 digits"}]},"conflict":{"errors":[{"error_key":"request","category":"duplicate_operation","message":"A resource with these attributes already exists."}]},"invalid_parameter":{"errors":[{"error_key":"request","category":"invalid_parameter","message":"The provided parameter is invalid or missing."}]},"flow_invalid_entity":{"errors":[{"error_key":"entity_type","category":"invalid_attribute_value","message":"Invalid flow entity"},{"error_key":"entity_uuid","category":"invalid_attribute_value","message":"Invalid flow entity"}]},"flow_nested_options_errors":{"errors":[{"error_key":"options","category":"nested_errors","metadata":{"flow_type":"company_forms"},"errors":[{"error_key":"form_types","category":"invalid_attribute_value","message":"Supplied value 'invalid' contains no permitted values"}]}]},"basic":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must complete all onboarding requirements in order to run payroll.","metadata":{"key":"needs_onboarding"}}]},"contractor_payment_invalid_wage":{"errors":[{"error_key":"wage","category":"invalid_attribute_value","message":"Wage must be greater than or equal to 0."}]},"contractor_payment_cannot_cancel":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Payment has already been processed and cannot be cancelled. Contact support directly."}]},"time_off_request_cannot_delete":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This time off request cannot be deleted."}]},"resource":{"errors":[{"error_key":"first_name","category":"invalid_attribute_value","message":"First name is required"},{"error_key":"date_of_birth","category":"invalid_attribute_value","message":"Date of birth is not a valid date"}]},"nested":{"errors":[{"error_key":"contractor_payments","category":"nested_errors","metadata":{"contractor_uuid":"72ae4617-daa9-4ed7-85e0-18ed5d0ee835"},"errors":[{"error_key":"hours","category":"invalid_attribute_value","message":"Ella Fitzgerald is paid fixed wage and hours cannot be set on a contractor payment"}]},{"error_key":"contractor_payments","category":"nested_errors","metadata":{"contractor_uuid":"2d7bf62c-babf-4a12-8292-340e2d9cab28"},"errors":[{"error_key":"wage","category":"invalid_attribute_value","message":"Isaiah Berlin is paid hourly and wage cannot be set on a contractor payment"}]}]},"compensation_invalid_rate":{"errors":[{"error_key":"rate","category":"invalid_attribute_value","message":"Rate is not a valid number"}]},"compensation_invalid_payment_unit":{"errors":[{"error_key":"payment_unit","category":"invalid_attribute_value","message":"Payment unit must be one of Hour, Week, Month, or Year"}]},"compensation_already_processed":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Compensation has already been processed on payroll."}]}},"title":"Unprocessable-Entity-Error-Object"},"examples":{"Example":{"value":{"errors":[{"error_key":"employment","category":"incorrect_state","message":"The employee's employment is not in the right state."}]}}}}}},"422":{"description":"Unprocessable Entity \n \nThis 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.\n","content":{"application/json":{"schema":{"description":"Unprocessable Entity\n \nThis 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.\n","type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["error_key","category"],"properties":{"error_key":{"type":"string","description":"Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error."},"category":{"type":"string","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."},"message":{"type":"string","description":"Provides details about the error - generally this message can be surfaced to an end user."},"metadata":{"type":"object","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.","oneOf":[{"type":"object","description":"multiple entities","required":["entities"],"properties":{"entities":{"type":"array","items":{"type":"object","description":"single entity","additionalProperties":true,"properties":{"entity_type":{"type":"string","description":"Name of the entity that the error corresponds to."},"entity_uuid":{"type":"string","description":"Unique identifier for the entity."},"valid_from":{"type":["string","null"]},"valid_up_to":{"type":["string","null"]},"key":{"type":["string","null"]},"state":{"type":["string","null"]}},"title":"Metadata-With-One-Entity"}}},"title":"Metadata-With-Multiple-Entities"},{"type":"object","description":"single entity","additionalProperties":true,"properties":{"entity_type":{"type":"string","description":"Name of the entity that the error corresponds to."},"entity_uuid":{"type":"string","description":"Unique identifier for the entity."},"valid_from":{"type":["string","null"]},"valid_up_to":{"type":["string","null"]},"key":{"type":["string","null"]},"state":{"type":["string","null"]}},"title":"Metadata-With-One-Entity"}]},"errors":{"type":"array","description":"Will only exist if category is `nested_errors`. It is possible to have multiple levels of nested errors.","items":"circular(Entity-Error-Object)"}},"title":"Entity-Error-Object"}}},"x-examples":{"bank_account_delete_unfunded_payments":{"errors":[{"error_key":"base","category":"invalid_operation","message":"FundingMethod has unfunded payments"}]},"bank_account_verify_incorrect_deposits":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Your bank account cannot be verified. Please check the test deposit amounts."}]},"bank_account_verify_already_verified":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Your bank account has already been verified."}]},"bank_account_missing_routing":{"errors":[{"error_key":"routing_number","category":"invalid_attribute_value","message":"Routing number is required."}]},"payment_configs_missing_parameter":{"errors":[{"error_key":"base","category":"missing_parameter","message":"At least one parameter must be provided"}]},"payment_configs_invalid_fast_payment_limit":{"errors":[{"error_key":"fast_payment_limit","category":"invalid_attribute_value","message":"Fast payment limit should be a number"}]},"pay_periods_invalid_end_date":{"errors":[{"error_key":"end_date","category":"invalid_parameter","message":"End date cannot be more than 3 months in future"}]},"company_industry_selection_naics_code_required":{"errors":[{"error_key":"naics_code","category":"invalid_attribute_value","message":"Naics code is required."}]},"company_industry_selection_naics_code_invalid":{"errors":[{"error_key":"naics_code","category":"invalid_attribute_value","message":"Naics code must be equal to 6 digits."}]},"company_industry_selection_sics_codes_invalid":{"errors":[{"error_key":"sic_codes","category":"invalid_attribute_value","message":"Sic codes must be equal to 4 digits"}]},"time_off_policy_name_required":{"errors":[{"error_key":"name","category":"invalid_attribute_value","message":"Name is required."}]},"time_off_policy_unlimited_invalid_accrual_rate":{"errors":[{"error_key":"accrual_rate","category":"invalid_operation","message":"Accrual rate must be blank for unlimited policies."}]},"time_off_policy_pending_requests":{"errors":[{"error_key":"time_off_policy","category":"invalid_operation","message":"Cannot deactivate policy with pending time off requests."}]},"time_off_policy_employees_required":{"errors":[{"error_key":"employees","category":"invalid_attribute_value","message":"Employees are required."}]},"time_off_policy_unlimited_balance_update":{"errors":[{"error_key":"base","category":"invalid_attribute_value","message":"Can not adjust balances for unlimited policies."}]},"holiday_pay_policy_already_exists":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Company already has a holiday pay policy."}]},"holiday_pay_policy_not_exists":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Company does not have a holiday pay policy, please create one"}]},"holiday_pay_policy_invalid_employees":{"errors":[{"error_key":"employees","category":"invalid_attribute_value","message":"Invalid employee uuids provided."}]},"onboarded_employee":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Cannot delete onboarded employee"}]},"invalid_attribute":{"errors":[{"error_key":"base","category":"invalid_operation","message":"There is an error in the request body."}]},"company_cannot_enable_contractor_only":{"errors":[{"error_key":"contractor_only","category":"invalid_attribute_value","message":"Contractor only cannot be enabled for existing companies."}]},"company_missing_parameter":{"errors":[{"error_key":"base","category":"missing_parameter","message":"contractor_only is required."}]},"starting_after_uuid_invalid":{"errors":[{"error_key":"starting_after_uuid","category":"invalid_attribute_value","message":"Parameter 'starting_after_uuid' does not correspond to a valid event."}]},"resource_uuid_invalid":{"errors":[{"error_key":"resource_uuid","category":"invalid_attribute_value","message":"Parameter 'resource_uuid' does not correspond to a valid resource."}]},"payroll_gross_up_invalid_net_pay":{"errors":[{"error_key":"net_pay","category":"invalid_attribute_value","message":"Net pay must be a number."}]},"payroll_accruing_hours_invalid":{"errors":[{"error_key":"base","category":"invalid_attribute_value","message":"Hours cannot be negative."}]},"payroll_cannot_cancel":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Payroll cannot be canceled."}]},"frozen_payroll":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This payroll has already been processed. Its data cannot be updated or altered."}]},"frozen_payroll_processing":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This payroll is being processed and cannot be updated at this time."}]},"unmodifiable_payroll_type":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This type of payroll cannot be modified or processed. It is reserved for system processes."}]},"invalid_employee_uuids_format":{"errors":[{"error_key":"employee_uuids","category":"invalid_attribute_value","message":"Parameter employee_uuids must be an array."}]},"maximum_employee_uuids_surpassed":{"errors":[{"error_key":"employee_uuids","category":"invalid_attribute_value","message":"Exceeded maximum of 100 for lookup."}]},"invalid_employee_uuid":{"errors":[{"error_key":"employee_uuids","category":"invalid_attribute_value","message":"Invalid Employee UUID(s).","metadata":{"entities":[{"entity_type":"Employee","entity_uuid":"invalid-uuid-123"}]}}]},"payroll_blocker_missing_bank_info":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must have a bank account in order to run payroll.","metadata":{"key":"missing_bank_info"}}]},"payroll_blocker_missing_employee_setup":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must add employees in order to run payroll.","metadata":{"key":"missing_employee_setup"}}]},"payroll_blocker_missing_federal_tax_setup":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must complete federal tax setup in order to run payroll.","metadata":{"key":"missing_federal_tax_setup"}}]},"payroll_blocker_missing_bank_verification":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company bank account must be verified in order to run payroll.","metadata":{"key":"missing_bank_verification"}}]},"payroll_blocker_suspended":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company is suspended and cannot run payroll.","metadata":{"key":"suspended"}}]},"submission_blocker_missing_selection":{"errors":[{"error_key":"submission_blockers","category":"invalid_attribute_value","message":"Submission blockers selections required"}]},"submission_blocker_invalid_option":{"errors":[{"error_key":"submission_blockers","category":"nested_errors","metadata":{"blocker_type":"fast_ach_threshold_exceeded"},"errors":[{"error_key":"selected_option","category":"invalid_attribute_value","message":"Selection is not available to resolve Fast ACH Threshold Exceeded. Please choose one of Wire In, Move To Four Day"}]}]},"invalid_version":{"errors":[{"error_key":"base","category":"invalid_resource_version","message":"You are attempting to update a resource using an out-of-date version."}]},"signatory_email_required":{"errors":[{"error_key":"email","category":"invalid_attribute_value","message":"Email is required"}]},"signatory_company_already_has_signatory":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Cannot have more than one signatory in a company. Please remove the existing signatory before adding a new one."}]},"mixed_disbursement_errors":{"errors":[{"error_key":"disbursements","category":"nested_errors","metadata":{"contractor_payment_uuid":"invalid-uuid-1"},"errors":[{"error_key":"contractor_payment_uuid","category":"not_found","message":"Disbursement not found."}]},{"error_key":"disbursements","category":"nested_errors","metadata":{"contractor_payment_uuid":"d0dfa222-ad08-4ea7-a06a-717688c3b179"},"errors":[{"error_key":"payment_method","category":"invalid_attribute_value","message":"Payment method must be one of: Direct Deposit, Check."},{"error_key":"payment_status","category":"invalid_attribute_value","message":"Payment status is not valid for payment method 'InvalidMethod'."}]}]},"not_found":{"errors":[{"error_key":"request","category":"not_found","message":"The requested resource was not found."}]},"finish_onboarding_incomplete":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Company is not ready to exit onboarding."}]},"company_location_validation":{"errors":[{"error_key":"street_1","category":"invalid_attribute_value","message":"Must include a street address"},{"error_key":"city","category":"invalid_attribute_value","message":"Must include a city"},{"error_key":"state","category":"invalid_attribute_value","message":"State is in the wrong format"},{"error_key":"zip","category":"invalid_attribute_value","message":"Please enter a valid zip code (e.g. 12345)."},{"error_key":"phone_number","category":"invalid_attribute_value","message":"Phone number must be 10 digits"}]},"conflict":{"errors":[{"error_key":"request","category":"duplicate_operation","message":"A resource with these attributes already exists."}]},"invalid_parameter":{"errors":[{"error_key":"request","category":"invalid_parameter","message":"The provided parameter is invalid or missing."}]},"flow_invalid_entity":{"errors":[{"error_key":"entity_type","category":"invalid_attribute_value","message":"Invalid flow entity"},{"error_key":"entity_uuid","category":"invalid_attribute_value","message":"Invalid flow entity"}]},"flow_nested_options_errors":{"errors":[{"error_key":"options","category":"nested_errors","metadata":{"flow_type":"company_forms"},"errors":[{"error_key":"form_types","category":"invalid_attribute_value","message":"Supplied value 'invalid' contains no permitted values"}]}]},"basic":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must complete all onboarding requirements in order to run payroll.","metadata":{"key":"needs_onboarding"}}]},"contractor_payment_invalid_wage":{"errors":[{"error_key":"wage","category":"invalid_attribute_value","message":"Wage must be greater than or equal to 0."}]},"contractor_payment_cannot_cancel":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Payment has already been processed and cannot be cancelled. Contact support directly."}]},"time_off_request_cannot_delete":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This time off request cannot be deleted."}]},"resource":{"errors":[{"error_key":"first_name","category":"invalid_attribute_value","message":"First name is required"},{"error_key":"date_of_birth","category":"invalid_attribute_value","message":"Date of birth is not a valid date"}]},"nested":{"errors":[{"error_key":"contractor_payments","category":"nested_errors","metadata":{"contractor_uuid":"72ae4617-daa9-4ed7-85e0-18ed5d0ee835"},"errors":[{"error_key":"hours","category":"invalid_attribute_value","message":"Ella Fitzgerald is paid fixed wage and hours cannot be set on a contractor payment"}]},{"error_key":"contractor_payments","category":"nested_errors","metadata":{"contractor_uuid":"2d7bf62c-babf-4a12-8292-340e2d9cab28"},"errors":[{"error_key":"wage","category":"invalid_attribute_value","message":"Isaiah Berlin is paid hourly and wage cannot be set on a contractor payment"}]}]},"compensation_invalid_rate":{"errors":[{"error_key":"rate","category":"invalid_attribute_value","message":"Rate is not a valid number"}]},"compensation_invalid_payment_unit":{"errors":[{"error_key":"payment_unit","category":"invalid_attribute_value","message":"Payment unit must be one of Hour, Week, Month, or Year"}]},"compensation_already_processed":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Compensation has already been processed on payroll."}]}},"title":"Unprocessable-Entity-Error-Object"},"examples":{"Basic":{"value":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must complete all onboarding requirements in order to run payroll.","metadata":{"key":"needs_onboarding"}}]}},"Resource":{"value":{"errors":[{"error_key":"first_name","category":"invalid_attribute_value","message":"First name is required"},{"error_key":"date_of_birth","category":"invalid_attribute_value","message":"Date of birth is not a valid date"}]}},"Nested":{"value":{"errors":[{"error_key":"contractor_payments","category":"nested_errors","metadata":{"contractor_uuid":"72ae4617-daa9-4ed7-85e0-18ed5d0ee835"},"errors":[{"error_key":"hours","category":"invalid_attribute_value","message":"Ella Fitzgerald is paid fixed wage and hours cannot be set on a contractor payment"}]},{"error_key":"contractor_payments","category":"nested_errors","metadata":{"contractor_uuid":"2d7bf62c-babf-4a12-8292-340e2d9cab28"},"errors":[{"error_key":"wage","category":"invalid_attribute_value","message":"Isaiah Berlin is paid hourly and wage cannot be set on a contractor payment"}]}]}}}}}}}}
\ No newline at end of file
diff --git a/docs/api/delete-v-1-employees-employee-id-terminations.api.mdx b/docs/api/delete-v-1-employees-employee-id-terminations.api.mdx
new file mode 100644
index 000000000..fcf94750a
--- /dev/null
+++ b/docs/api/delete-v-1-employees-employee-id-terminations.api.mdx
@@ -0,0 +1,71 @@
+---
+id: delete-v-1-employees-employee-id-terminations
+title: "Delete an employee termination"
+description: "Delete an employee termination."
+sidebar_label: "Delete an employee termination"
+hide_title: true
+hide_table_of_contents: true
+api: eJztXVlz3DiS/itY7oPtjaIuy0fraT2WvKOIcbejbY93QnZQKCKrCm0SoAFQUrVC/30iEwDJYh1SyVLsRgcfOtpS4fiQyAt5qK6Tq3RaW6dTqRxMDXdSq9TNK0iOzhIoxyAEiGSU8KrqDrHJt1GiK/A/nYrkKBFQgIP0Yj+Fsir0HMA2/8qkSB2YUqowe5QYsJVWFmxydJ0c7B3i/wTY3MgKhyRHya+avdXKgXLJzSg5XD3EsXe6VuKr+qr+i32aATPwowbrQDADVtcmByY0WKa0Y3Alrdth7/l3YLY2wNwMWGX0hRQg2OfPp8dMWnbBCyl24nrxCE9s+GcJyuEwXFAqWsLI6cwx67iDnWSU5AH10TWSrZA5HXr3D4uYrxObz6Dky4f5rCqjc7CWjwtgJ8pJN/+qGPuqPs2kZSWfsxmvKlDscgZ+47EWc6YnbK5rE0/OcHsulWVgjDaW2TqfMW7ZuVR0tIw7Z+S4dpBd8KKG8xHTxp8jrDDhsrBM1MCcZly1M5sbP99hH8HT7+zEb/OWO5hqI8F+ezpzrrJHu7tC53aH+Gsn1+Vu5Ke04nOji4I+3yWYad5Mf8amtRTAJtqwUhtgAhwC2vmqklHieTPR4z8gd8RHP2ppQBC/EhJkzcogVCc9e4XfH13H2dwYPk9GiXRQdn+/ftXsO+CEgHK+Zg8a1S5nnZFqmox6F/2xglxOJFi8yMCFNJ3pPK+N3WGf5pXMeVHMmcOr/w5zJgUo52fh+OYOdytueAkOkAEKjozvdLvkDspOg3oLaLgCjkX28iuROMSlotgELmNTo+tKqqllXAmWc8XGwGrr0YxrWQiWIx+UYfyMK1FINUURIu7tKJcddjppN5KWnSuS6Mzf4/mIwPm7YpeyKCLLM878SHYehrJwSXN2Kd2MAQlVEAwiTYnyNoXbKfMhnjdwI+NjXbvO3aVsCgpMe2th6UgMW5sJzz1BuGKgBNLHBBSOC+74KlZchPE2CreBAi64cgzn4ZqBQeZBkoPuk4qRTEsd1EbQSOMCdtg7bRhc8bIqYLSwBOEjUp37/2eI6pzuNv6mrqU49+Qft1oU9Z9W8NskOTq77SxlXThZFeD3QjnqCV789bKwxU+2EOnFva1U07gzTuNCSPyIFx86OzlTw8q9PUFu55pfeUkSRGziKepmvMs2uTbeFArLnCZu6BD49h0+K/mjhlY9GNKb7X60otfeE6PLdsGzdkVVF0XyrRlXV5nTmwcu6LlVA8gYbhpyM0qcdAWe7H3g/vSLdLP0NwWpN37JzfpR7wPv+KF4NTej4c7/CneOK6012It0+ILKR6ti7j07JjeajR12So5bpa2V6GI5zWb8Alijhwq4gMLi3QUzEg1Fo1aSXJq8Lrh56uGm5PykvxHDPUu6J1wxwDP0VRp0Lh1wzNX3jOe5rpXLvA+d1WpSKwEiqzi5mwtOzNmCr5GMuYWuY3KULDlrScfMJe9qJaSavgc304LNuGVxN9bsRnewAOwCjJzMM6mIdXNEWmkrHxTZv9ANwF1Z2BUtJ3rZY2C0vwSxwz4UwC2wfAb5d++koMca4DBe4kQ07euOwAsDXMyzuOKjHgDJGzZkYwDVnmMFwFJa1FCZ0bVDsVkPLIzIVF2OwayG2HPyF4D+7uczPx9lIprdgCtwQpZrNZFT20BrfM2tqLY8uwvmjWN4pY5pBax1Zsvauq5jsRpYPO2EWxelJStkKd0GhCsGb03Cd4g4rMFoDWZnui4EYuaBsg3mrAIjtWjxghKZCNpyDcpmyEpsq2l5ogT6g9CRHHpBuRlX7DkrtXIziz7hpHa1AY8v12XFFQq3qK0z88xCATlyd6a4zG2WawFZ65itRdyO3p6ev+JchnNXsOPdEIZtHh9gZE34UfMCrchLJuRUNmpnA1wbAdg7wLUy92O3R/tR5oTVLoM9DGA9VidLyPRkklW6kPk8U7y8412X9yJiuep++yBqRRIFopEXnuem5kVmNsvMwrAtNPcbP4/hvIZi4wJVOXpWDR5GACXYNcArIOOahUDKJuvYm7oN2rdeuAXw3MkLhOzX8G/cgIHhBkxPJjGqsw5zE627y7U3g7e/+5M4lXEDd+eAMS+4yiGrq1v05XprvQnVW64oksfFH3Ttfje7+dpnupACtTr+5wFHt4Ic0Yf0it56ZdK4EeRSsIAALVC4/PXQlHaPB6uJrZInvQrYiFXBZTOAvKoVrIXamMeGzR6FFU/9mCa2y/DZZTsxDMKn1Vhzg254HPeQ9IsyjA4/a7ZqIHkIS4d5QASfKPYoLQV76Fkao9khCozB5Z5F825FBgrjR+iEOcNzp02Gj7AN2PojtxfTZgH/3mv9G49FkMASl6Pu83hbgY34H9OP7Z1xhZmzjhvy2/nEgaG3/l28gOVZ29PvQ+NXP1mx3pNWjNvQBMUpWRCUC1AunCKGFu+Kf2H8TyFfWOlWzHF0+6TBlEM2NdpaDHfEzRXQY2CTrxNGbO/uAL0RGo8ivgt6kMhrwRuZ6drcxTG8n6n7O67ekRwFU+7kRZ9AQcZztIPFA+qbD379DgC/RSMeE6P/BJUFHA+q6TDqE7ZfepKHpBvGFk6d9eH0FqN3OwRmyHjhwKxBm4VVNr/bfwq4tGwMqNwawDHV0oNKoUZpyQEMYGtVaiEnktR2hByjmQ8JNmaMqqXL9gA8JRdI7hWlBXMRtLidWwdlMyjq8L5vQFrAZhNtSr7ptb84/mcU0OJKrVQrRuHJgLPkV7Ksyz5OW5uK45kfEerJVQ6AXkTAgDexv7dHVC20/l5Xm2j5iMCiwxXfAJRrf2qf7SSLua82r3PWC7o3z4ekFyuP+6f4Y7p/8BxPuKDQxoXOv4NpjD8F3aSa6K2Yv7faSmeYOCI4wgtxQKmYNgIM2idTqyge/eP7vZdxbj5PczkWXF09zqG4aF1Te7/j9GBuPtMEBKZSM8evHvNY6BeSAx72Y45fMdrvfmdchn0HVvQxYV8k8uDHXGDDqLFiFPon+HIB9OpD2tpiLGLLEPtdDiWxqCUs3jWCtx6hheQh23pMp9Jq6WqamN0m13xp+n1Cdc0iLC7Cms3bN0SyDnBrlX8W7UK6rEe/uFvQxhRC5/ksczMDdqYLkUEwPkknf9dHQMeCBuv2tIp0iQVY/ILLgodkHnr8xQUwis2/eft39imCY9EydvJHWlsKRqCR/CINsFM1Yu/1BbBPGovKDDvmlI7sGswLMHZbMY1zm+dLXKSXO6K4GHcOyooesU4Hl47xtp6jRuZEl0PXLtWTlD4PC8Znppwq7rTB0B6Xxd3CelwW9wnpcVl0H7p9APHdHaNjM26z5tOHj6b4bG6T8MDLbXZjVB4UADVsYKDEG6fUeQwetFPGMMHFsE4Aic4UXOKi0dGTVyAyIe24NhYomdTmrdccrDt6C+nrxBZi3mql97NB9tYtsYhBu2yC9ZQL1D3ugCapoyGeCo98PLEnJvzg4CDlYu91egj8Vcr3XvL01f6rl69f58/H+69+2XDouFpJ2e77+P4+wefnN/bTa40jdiwxF86OffJ5xN5iUnon6VMlosD6iPpeLxCPws+Pqs971OjaV4sonwRv26f4n+xEHdZe7qZgDcX+7sIVa4ptL7nt80gykUraWRainGhdsZDAu16PEJMOBPJvfKdRsh1rN+/FBAvtvZiMlr7NC7POALhsf/tbfI/MI1Ve1AI1ul8IdYsBa5d4JvclSj+3By3SX9lX6WxvenEakjZEiS+NVlMWXt/9Pf6U1T3Y3KtkUPjWjlG8P2Xlk65PYWe6w/YPnh++eLZCxGZawb3rIT7g7FgNEYV8f28hUYoVB4XMN0UaVgqPqH0FOKxLPXZEB9N3bga2U97bBqt8Cqf3gL9LIHslrM11BJ+6dfFtTQbdvr8XrM32nnKU8UJfdsobqJZrU3FD+7a/dzQBt4zVfH2G6MYIHmaD5pDBknkf1t5u88PAu5tD2iU42lFLoaDZDZYOP6c593qBYE0wCEYfsSdhzpO2k0BpVmH7hnNxlI1WZcytzB/5dc6pzC/q7+htkpOx3RNWAQjbsUPhGbjC/4h0uwzF4WtORx9vTfAvWBYe9cyU0qImuKymLdTYawzVErpHjNGTJ7E+SN6LOXsEGMOnXh2eO2brqtLGMUHOUTHvZ/iDOopn8BnQB49D94ofOpD9hqKXzdpULiaNddn9Cl7e4VymemUvS9pKkH2YZGNp3Gz7XY4prz5hNL15GgcLSmUT3gEknXO3NG1TC3ofJz44768OOBy+3H+VCs5/SQ9BvEpfv4C9dP81iBdiD+D18xcbVBplw+7xKC0Kzt5J9+cUQ3GCKn45KnN8rjEUWOLhWS8bZgF9RHoiNqnmQIQVD50HptSBeDWevDzI0zEfT9JDvn+Qvj745SB9frgHB+KXnI8PXm+g1P200Knlks/Y38AUUjVkQroUcyLRZeheuRuFok8Nynp/uol7bK7bWV+rtbGENXijXU7vFl2uRNI8LtXG+tCFYfd+reHs3ouRYQp2xL4AfMdQk3Izar37F/BVqGPQpNG9D/xUihtt0va6Y1BvFgr4F7oV05XF7qOkW+h+4v+N//REuy3dRIzVO1MsP4+PmEWXdeteTTzSDRXlHx4c3K0jkw0tmf2WzKHfdeh3Hfpdh37Xod916Hcdeh+Hftfhzod+16Hfdeh3Hfpdh37Xod916Hcd+l2Hfteh33Xodx36XYd+16Hfdeh3Hfpdh37Xod916Hcd+l2Hfteh33Xodx36XYd+16Hfdeh3Hfpdh37Xod916Hcd+l2Hfteh3/XuMemh33Xodx36XYd+16Hfdeh3Hfpdh37Xod916Hcd+l2Hfteh3/X/st/1b9FRuK3b9f+/x3AzSn7v2I3bDvQXMSA3o+TXxoLcdubBlAym5CdMSWxDX+z3OfbVcliwFhPJnW9R3sEvPba5ruCInbf97vbo0kgH5wlmqMJL1p+bJLKT3KanolSkcEiK2si5bwprO7cX+7OWgOL7mb4+ObaBNVV9o2bb/03/h75o+s2H0/SfTUaAtp8BF6TmWgATXlhYpoc/fmjXRUFNUXsK9ubDacwKMG6tziWVhlCEgdptcQB2GFOvrULzJNsCyJEf02lef2LZWSkVFRV01t6y05tXMg0zpZr+Z1gw7fz6GcLAtmHUxuvIjRUAdYkNZgd7By/SvZfp/gvsERUw4XXhUAja39/cfBsljk/xypsiglCI4IXtG7Zk2Qr4d+B2nlInc4ctukMXR+JFpvoCjJECmm/8/tRyJCK9cqAsvf+R5byQrf2O8VHUq7d81ziyUVyqj7xZY+UJVs9cPEm7wvKJkJohmh4/JsFys+Qo2b3Y322qBHavO4J1s9v7unOq9wlyWJsCmT5wEq+kZ6RUQEnctNT3dwyl7t2FXy/1SQP8GA+6ZuGVa34wlCBYt2aFH+PhLeS1oeDW2XV0Pt7k6Ai9qZEIZ9+6oz4iC3v/Z8XYhrERYmR4/HkM3JAC6Dd/0xIp9SkyXrsZBqdiEn6UfKTKqZ/Zwa+wZgOKO/qymegFkgpDjYBME3OjXfEbJXjx9rfJRzAXMofOfbTaglrpiUPsrsCt0WlN6WfMcdowdan9E4pcl5T6JRxPLDsJUsNitSEqK6HzGrmfjvEf4Q90cB/KDcr4OO7Kfsc/ohCY1KdFkaHCp//d8g9So9LWlVwtrLPJQvVPcN3+qZCftm3hnh1cud2q4JIYggTgOojnWXKxT4dq6+aPFm3fgox+wwp963De9TValc+muLnBX/+oAT2Ds2+oKAwVFZI0CEmPgTXWqnvYp78Hw/aMrTWVa44UG4LVvKOnktCdvGDLfZOBN6XbwfuL29WVdPX0W+2UNGRurQcqmcp1Plv6SzcLluL45B8nn06Sm5t/A+8ImT4=
+sidebar_class_name: "delete api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Delete an employee termination.
+
+scope: `employments:write`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/delete-v-1-external-payroll.ParamsDetails.json b/docs/api/delete-v-1-external-payroll.ParamsDetails.json
new file mode 100644
index 000000000..849144877
--- /dev/null
+++ b/docs/api/delete-v-1-external-payroll.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"company_uuid","in":"path","required":true,"schema":{"type":"string"},"description":"The UUID of the company"},{"name":"external_payroll_id","in":"path","required":true,"schema":{"type":"string"},"description":"The UUID of the external payroll"},{"name":"X-Gusto-API-Version","in":"header","required":false,"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.","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"}}]}
\ No newline at end of file
diff --git a/docs/api/delete-v-1-external-payroll.RequestSchema.json b/docs/api/delete-v-1-external-payroll.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/delete-v-1-external-payroll.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/delete-v-1-external-payroll.StatusCodes.json b/docs/api/delete-v-1-external-payroll.StatusCodes.json
new file mode 100644
index 000000000..8c4f80195
--- /dev/null
+++ b/docs/api/delete-v-1-external-payroll.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"204":{"description":"No Content"},"404":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided UUID is valid.\n"},"422":{"description":"Unprocessable Entity \n \nThis 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.\n","content":{"application/json":{"schema":{"description":"Unprocessable Entity\n \nThis 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.\n","type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["error_key","category"],"properties":{"error_key":{"type":"string","description":"Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error."},"category":{"type":"string","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."},"message":{"type":"string","description":"Provides details about the error - generally this message can be surfaced to an end user."},"metadata":{"type":"object","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.","oneOf":[{"type":"object","description":"multiple entities","required":["entities"],"properties":{"entities":{"type":"array","items":{"type":"object","description":"single entity","additionalProperties":true,"properties":{"entity_type":{"type":"string","description":"Name of the entity that the error corresponds to."},"entity_uuid":{"type":"string","description":"Unique identifier for the entity."},"valid_from":{"type":["string","null"]},"valid_up_to":{"type":["string","null"]},"key":{"type":["string","null"]},"state":{"type":["string","null"]}},"title":"Metadata-With-One-Entity"}}},"title":"Metadata-With-Multiple-Entities"},{"type":"object","description":"single entity","additionalProperties":true,"properties":{"entity_type":{"type":"string","description":"Name of the entity that the error corresponds to."},"entity_uuid":{"type":"string","description":"Unique identifier for the entity."},"valid_from":{"type":["string","null"]},"valid_up_to":{"type":["string","null"]},"key":{"type":["string","null"]},"state":{"type":["string","null"]}},"title":"Metadata-With-One-Entity"}]},"errors":{"type":"array","description":"Will only exist if category is `nested_errors`. It is possible to have multiple levels of nested errors.","items":"circular(Entity-Error-Object)"}},"title":"Entity-Error-Object"}}},"x-examples":{"bank_account_delete_unfunded_payments":{"errors":[{"error_key":"base","category":"invalid_operation","message":"FundingMethod has unfunded payments"}]},"bank_account_verify_incorrect_deposits":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Your bank account cannot be verified. Please check the test deposit amounts."}]},"bank_account_verify_already_verified":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Your bank account has already been verified."}]},"bank_account_missing_routing":{"errors":[{"error_key":"routing_number","category":"invalid_attribute_value","message":"Routing number is required."}]},"payment_configs_missing_parameter":{"errors":[{"error_key":"base","category":"missing_parameter","message":"At least one parameter must be provided"}]},"payment_configs_invalid_fast_payment_limit":{"errors":[{"error_key":"fast_payment_limit","category":"invalid_attribute_value","message":"Fast payment limit should be a number"}]},"pay_periods_invalid_end_date":{"errors":[{"error_key":"end_date","category":"invalid_parameter","message":"End date cannot be more than 3 months in future"}]},"company_industry_selection_naics_code_required":{"errors":[{"error_key":"naics_code","category":"invalid_attribute_value","message":"Naics code is required."}]},"company_industry_selection_naics_code_invalid":{"errors":[{"error_key":"naics_code","category":"invalid_attribute_value","message":"Naics code must be equal to 6 digits."}]},"company_industry_selection_sics_codes_invalid":{"errors":[{"error_key":"sic_codes","category":"invalid_attribute_value","message":"Sic codes must be equal to 4 digits"}]},"time_off_policy_name_required":{"errors":[{"error_key":"name","category":"invalid_attribute_value","message":"Name is required."}]},"time_off_policy_unlimited_invalid_accrual_rate":{"errors":[{"error_key":"accrual_rate","category":"invalid_operation","message":"Accrual rate must be blank for unlimited policies."}]},"time_off_policy_pending_requests":{"errors":[{"error_key":"time_off_policy","category":"invalid_operation","message":"Cannot deactivate policy with pending time off requests."}]},"time_off_policy_employees_required":{"errors":[{"error_key":"employees","category":"invalid_attribute_value","message":"Employees are required."}]},"time_off_policy_unlimited_balance_update":{"errors":[{"error_key":"base","category":"invalid_attribute_value","message":"Can not adjust balances for unlimited policies."}]},"holiday_pay_policy_already_exists":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Company already has a holiday pay policy."}]},"holiday_pay_policy_not_exists":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Company does not have a holiday pay policy, please create one"}]},"holiday_pay_policy_invalid_employees":{"errors":[{"error_key":"employees","category":"invalid_attribute_value","message":"Invalid employee uuids provided."}]},"onboarded_employee":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Cannot delete onboarded employee"}]},"invalid_attribute":{"errors":[{"error_key":"base","category":"invalid_operation","message":"There is an error in the request body."}]},"company_cannot_enable_contractor_only":{"errors":[{"error_key":"contractor_only","category":"invalid_attribute_value","message":"Contractor only cannot be enabled for existing companies."}]},"company_missing_parameter":{"errors":[{"error_key":"base","category":"missing_parameter","message":"contractor_only is required."}]},"starting_after_uuid_invalid":{"errors":[{"error_key":"starting_after_uuid","category":"invalid_attribute_value","message":"Parameter 'starting_after_uuid' does not correspond to a valid event."}]},"resource_uuid_invalid":{"errors":[{"error_key":"resource_uuid","category":"invalid_attribute_value","message":"Parameter 'resource_uuid' does not correspond to a valid resource."}]},"payroll_gross_up_invalid_net_pay":{"errors":[{"error_key":"net_pay","category":"invalid_attribute_value","message":"Net pay must be a number."}]},"payroll_accruing_hours_invalid":{"errors":[{"error_key":"base","category":"invalid_attribute_value","message":"Hours cannot be negative."}]},"payroll_cannot_cancel":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Payroll cannot be canceled."}]},"frozen_payroll":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This payroll has already been processed. Its data cannot be updated or altered."}]},"frozen_payroll_processing":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This payroll is being processed and cannot be updated at this time."}]},"unmodifiable_payroll_type":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This type of payroll cannot be modified or processed. It is reserved for system processes."}]},"invalid_employee_uuids_format":{"errors":[{"error_key":"employee_uuids","category":"invalid_attribute_value","message":"Parameter employee_uuids must be an array."}]},"maximum_employee_uuids_surpassed":{"errors":[{"error_key":"employee_uuids","category":"invalid_attribute_value","message":"Exceeded maximum of 100 for lookup."}]},"invalid_employee_uuid":{"errors":[{"error_key":"employee_uuids","category":"invalid_attribute_value","message":"Invalid Employee UUID(s).","metadata":{"entities":[{"entity_type":"Employee","entity_uuid":"invalid-uuid-123"}]}}]},"payroll_blocker_missing_bank_info":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must have a bank account in order to run payroll.","metadata":{"key":"missing_bank_info"}}]},"payroll_blocker_missing_employee_setup":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must add employees in order to run payroll.","metadata":{"key":"missing_employee_setup"}}]},"payroll_blocker_missing_federal_tax_setup":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must complete federal tax setup in order to run payroll.","metadata":{"key":"missing_federal_tax_setup"}}]},"payroll_blocker_missing_bank_verification":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company bank account must be verified in order to run payroll.","metadata":{"key":"missing_bank_verification"}}]},"payroll_blocker_suspended":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company is suspended and cannot run payroll.","metadata":{"key":"suspended"}}]},"submission_blocker_missing_selection":{"errors":[{"error_key":"submission_blockers","category":"invalid_attribute_value","message":"Submission blockers selections required"}]},"submission_blocker_invalid_option":{"errors":[{"error_key":"submission_blockers","category":"nested_errors","metadata":{"blocker_type":"fast_ach_threshold_exceeded"},"errors":[{"error_key":"selected_option","category":"invalid_attribute_value","message":"Selection is not available to resolve Fast ACH Threshold Exceeded. Please choose one of Wire In, Move To Four Day"}]}]},"invalid_version":{"errors":[{"error_key":"base","category":"invalid_resource_version","message":"You are attempting to update a resource using an out-of-date version."}]},"signatory_email_required":{"errors":[{"error_key":"email","category":"invalid_attribute_value","message":"Email is required"}]},"signatory_company_already_has_signatory":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Cannot have more than one signatory in a company. Please remove the existing signatory before adding a new one."}]},"mixed_disbursement_errors":{"errors":[{"error_key":"disbursements","category":"nested_errors","metadata":{"contractor_payment_uuid":"invalid-uuid-1"},"errors":[{"error_key":"contractor_payment_uuid","category":"not_found","message":"Disbursement not found."}]},{"error_key":"disbursements","category":"nested_errors","metadata":{"contractor_payment_uuid":"d0dfa222-ad08-4ea7-a06a-717688c3b179"},"errors":[{"error_key":"payment_method","category":"invalid_attribute_value","message":"Payment method must be one of: Direct Deposit, Check."},{"error_key":"payment_status","category":"invalid_attribute_value","message":"Payment status is not valid for payment method 'InvalidMethod'."}]}]},"not_found":{"errors":[{"error_key":"request","category":"not_found","message":"The requested resource was not found."}]},"finish_onboarding_incomplete":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Company is not ready to exit onboarding."}]},"company_location_validation":{"errors":[{"error_key":"street_1","category":"invalid_attribute_value","message":"Must include a street address"},{"error_key":"city","category":"invalid_attribute_value","message":"Must include a city"},{"error_key":"state","category":"invalid_attribute_value","message":"State is in the wrong format"},{"error_key":"zip","category":"invalid_attribute_value","message":"Please enter a valid zip code (e.g. 12345)."},{"error_key":"phone_number","category":"invalid_attribute_value","message":"Phone number must be 10 digits"}]},"conflict":{"errors":[{"error_key":"request","category":"duplicate_operation","message":"A resource with these attributes already exists."}]},"invalid_parameter":{"errors":[{"error_key":"request","category":"invalid_parameter","message":"The provided parameter is invalid or missing."}]},"flow_invalid_entity":{"errors":[{"error_key":"entity_type","category":"invalid_attribute_value","message":"Invalid flow entity"},{"error_key":"entity_uuid","category":"invalid_attribute_value","message":"Invalid flow entity"}]},"flow_nested_options_errors":{"errors":[{"error_key":"options","category":"nested_errors","metadata":{"flow_type":"company_forms"},"errors":[{"error_key":"form_types","category":"invalid_attribute_value","message":"Supplied value 'invalid' contains no permitted values"}]}]},"basic":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must complete all onboarding requirements in order to run payroll.","metadata":{"key":"needs_onboarding"}}]},"contractor_payment_invalid_wage":{"errors":[{"error_key":"wage","category":"invalid_attribute_value","message":"Wage must be greater than or equal to 0."}]},"contractor_payment_cannot_cancel":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Payment has already been processed and cannot be cancelled. Contact support directly."}]},"time_off_request_cannot_delete":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This time off request cannot be deleted."}]},"resource":{"errors":[{"error_key":"first_name","category":"invalid_attribute_value","message":"First name is required"},{"error_key":"date_of_birth","category":"invalid_attribute_value","message":"Date of birth is not a valid date"}]},"nested":{"errors":[{"error_key":"contractor_payments","category":"nested_errors","metadata":{"contractor_uuid":"72ae4617-daa9-4ed7-85e0-18ed5d0ee835"},"errors":[{"error_key":"hours","category":"invalid_attribute_value","message":"Ella Fitzgerald is paid fixed wage and hours cannot be set on a contractor payment"}]},{"error_key":"contractor_payments","category":"nested_errors","metadata":{"contractor_uuid":"2d7bf62c-babf-4a12-8292-340e2d9cab28"},"errors":[{"error_key":"wage","category":"invalid_attribute_value","message":"Isaiah Berlin is paid hourly and wage cannot be set on a contractor payment"}]}]},"compensation_invalid_rate":{"errors":[{"error_key":"rate","category":"invalid_attribute_value","message":"Rate is not a valid number"}]},"compensation_invalid_payment_unit":{"errors":[{"error_key":"payment_unit","category":"invalid_attribute_value","message":"Payment unit must be one of Hour, Week, Month, or Year"}]},"compensation_already_processed":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Compensation has already been processed on payroll."}]}},"title":"Unprocessable-Entity-Error-Object"},"examples":{"Basic":{"value":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must complete all onboarding requirements in order to run payroll.","metadata":{"key":"needs_onboarding"}}]}},"Resource":{"value":{"errors":[{"error_key":"first_name","category":"invalid_attribute_value","message":"First name is required"},{"error_key":"date_of_birth","category":"invalid_attribute_value","message":"Date of birth is not a valid date"}]}},"Nested":{"value":{"errors":[{"error_key":"contractor_payments","category":"nested_errors","metadata":{"contractor_uuid":"72ae4617-daa9-4ed7-85e0-18ed5d0ee835"},"errors":[{"error_key":"hours","category":"invalid_attribute_value","message":"Ella Fitzgerald is paid fixed wage and hours cannot be set on a contractor payment"}]},{"error_key":"contractor_payments","category":"nested_errors","metadata":{"contractor_uuid":"2d7bf62c-babf-4a12-8292-340e2d9cab28"},"errors":[{"error_key":"wage","category":"invalid_attribute_value","message":"Isaiah Berlin is paid hourly and wage cannot be set on a contractor payment"}]}]}}}}}}}}
\ No newline at end of file
diff --git a/docs/api/delete-v-1-external-payroll.api.mdx b/docs/api/delete-v-1-external-payroll.api.mdx
new file mode 100644
index 000000000..45ccb8942
--- /dev/null
+++ b/docs/api/delete-v-1-external-payroll.api.mdx
@@ -0,0 +1,71 @@
+---
+id: delete-v-1-external-payroll
+title: "Delete an external payroll"
+description: "Delete an external payroll."
+sidebar_label: "Delete an external payroll"
+hide_title: true
+hide_table_of_contents: true
+api: eJztXFtvGzmy/is8fR6SAGrfch0/bTZxzhrYzAST5GQHTtCmmiWJk26yh2TL1hj+74sqkn1TS7Yc+2EXM8AgsJqs+lgsVhWLRV4ll+m8tk6nUjmYG+6kVqlbVZAcnyVQTkEIEMm3SeL43OJvJ5cOjOIF+8BXRheFxY+6At/1VCTHiYACHKTLwxRC47TyjZNJIsDmRlbYODlO3lJTxhWLTVlouvdVfVU21xUcs/P4MQsf7fGFkQ7Ok0lSccNLcGAQ3VWieAnJcZLrsuJqldW1FMkkkcir4m6RTBIDf9TSgEiOnalhkth8ASVPjq8SP+zEOiPVPLkeYv20APb58+lbpmfMLYAFHsn1pGE7xJk9HPehvLow/pX+H83p6w+n6f+DsUghwFgAF2B6QGa8sLA+MQ5MKRVY4ia4g3TKLQj2+sMpW3qijFurc8kdCHYh3YKtdG2oQc6LYo+dzpjSCpi0rDJ6KQWIiW/Dq6qQOanMI8vOSqlkWZdd2t8eL5yr7PH+vtC53SMl3ct1uR+VMuoUfd/nlUxDT6nm/xsIpp2fnyCM2oLYSzaLfZKAqkvU86ODo+fpwYv08DkquIAZrwuXHHd/v77+hnK0lVYWLBI7OniG//RF+bNmb7RyoBzO6rPxJo6907US7Kti7KvCycYJAouiNWB1bXJgQoNlSjsGl9K6PfaefwdmawM0R1HEXk2kZUteSLH3VRHbo6N1tp9VZXQO1vJpAexEOelWDQJpWclXbMGrChS7WIAiLlMtVqiDNI0BI8u1clwqy8AYbSyzdb5g3LJzqQhExp0zclo7yJa8qOF8wrQhcpHCjMvCMlEDcxrNQdOzMS3ne+wj+JGenXg2b7iDuTYS7I7aQjDTvOn+hM1rKYDNtGGlNsAEOASEwpskeZi946uko7f7v1sU4lVHl26W7l/CHQo3rD89/R1y17NLZ4kfMK6/yiBUJ/0yC7+3q5cbw1do4hyU3d83U82+A3YIKFcbeFCrESPRn+iPFeRyJsHiRIbFSN2ZzvPa2D32aVVJNIkr5nDqv8OKSQHK+V7YvpnD/cahMQMFmVanW5J7uJgb1DtAQwrYFtXLU2JoZSKpaD2ClrG50XUl1dwyrgTLuWJTIOuJaKa1LATLUQ/K0H7BlSikmjOpvPZ24glyBA0jadm5IsOW+Xk8nxA4P1fsQhZFVHnGmW/JzkNTFiZp5f0NeJPlP5JoSlxvc7hZMh/ieIM2Mj7VtevMXcrmoMC0sxZIR2HY2sx47gWC8YsSKB8TUDguuONjqtiH8SYubgMFLLly6Go50gwKsgorObgAqRitafS+ZDaCRZoWsMfeacPgkpdVAZMeCcJHojr3/2aI6pzmNv6CodK5F/+0dSboLLWCX2YUXW0fS1kXTlYFeF64jgYLL/68vtjilx2WdJ+3lWoeOWM3LoTET7z40OHkY64R3l4gN2vNz7yEJgLzEnUL3lWbXBsfEgjLnCZt6Aj4Zg6flfyjhtY8GLKbLT+i6K33zOiyJXjWUlR1USTfmnZ1lTm9vWHPzo01sI472NbkepI46Qoc2fug/ekX6RbpLwpS7/yS682t3gfd8U1xajCe/WvO//PnHCltdNh9OXxB46NVsfIBLpNb3cYeO3W0tdDWSgyxnGYLvgTW2KECllBYnLvgRqKjaMxKkkuT1wU3jz3clIKf9BdSuCdJd4QjDbxCX6bB5tIAp1x9z3ie61q5zO+Es1rNaiVA4LawBOV6QcxZL9ZIcJPVDUyOk7VgLem4ueRdrYRU8/fgFlqwBbcscmMNN5qDHrAlGDlbZVKR6uaItNJW3iuy3zAMQK4scEXPibuXKTDiL0HssQ8FcAssX0D+3QcpGLEGOIyX2BFd+6Yh8MIAF6ssUnzQAaB4A0M2BVDtOEYAltKihcqMrh0um83AQotM1eWUNucjEAdBfg/or74/8/1xTUS3G3AFTchyrWZybhtoTay5k9TWe3fBvHYMp9Qx3Pm3wWxZW9cNLMaBxdHOuHVxtWSFLKXbgnCk8c4ifIeIAw1GNJhd6LoQiJkHyTaYswqM1KLFC0pkIljLDSibJqPYxmV5ogSlXjorh3ZQbsEVe8pKrdzCYkw4q11twOOLuS+pRG2dWWUWCshRuzPFZW6zXAvI2sBsI+K29e7y/Bn7Muw7oo63QxjYPDzAqJrwR80L9CIvmJBz2ZidLXBtBGBvAdfK3LfdHe1HmRNWuw72WQDrsTpZQqZns6zShcxXGWYEbzfX5Z2EWI7N7xBErWhFgWjWC89zU/MiM9vXTK/ZDpb7te/HsF8jsWmBphwjqwYPI4AS7AbgFZBzzUIiZZt3HHTdBe0bv7gF8NzJJUL2NPweN2BgyIDp2SxmdTZhhrIq9ArA3mbam8a7z/1J7Mq4gdtrwJQXXOWQ1dUN9nKzt96G6g1XlCHl4neads/Nbp/2hS6kQKuO/3vAMaygQPQ+o6I33pg0YQSFFCwgQA8UJn8zNKXdw8FqUswUSY8Bm7AqhGwGUFe1go1QG/fYqNmDqOKpb8MiCYbbLtvJYRA+raaaGwzDY7v7lF9cw3Se1bBqIHkIa4O5RwSfKPcoLSV7aFsqVS8LjMnlgUfzYUUGCvNHGIQ5w3OnTYabsC3Yhi13X6YNAb/fa+Mbj0XQgiUtR9vn8bYLNuJ/yDh2MMYRN2cdNxS385kDQ3v920QB6712l9+HJq5+NELvUbuM29QE5SlZWChLUC6MIqYWb4u/1/6HkPco3Yg5tm63NHTCOjfaWkx3ROYKaDOwLdYJLXYPd4D2CE1EEfcFA0gUteCMLHRtbhMY3s3V/QOpd1aOgjl3cjkUUFjjOfrB4h7tTTj/7wDwLJrlMTP6T1DxKPxeLR1mfQL7tS15OHTD3MKpsz6d3mL0YYfAEzJeODAb0GaByvZ9+w8Bl5ZNAY1bAzgetQygUqpRWgoAA9halVrImSSzHSHHbOZ9go0nRtXaZHsAXpI9kXtDacEsgxW3K+ugbBpFGz6MDcgK2GymTcm37fb77X/EAPUptataMUpPBpwlv8RSgiFOW5uK45gfEOrJZQ6AUUTAgDNxeHBAUi20/l5X22T5gMBiwBX3AFRy8Ng+2Uv6Z1/tuc7ZIOnebB+SQa488k/xz/Tw6CmOsGfQpoXOv4NpnD8l3aSa6Z2Uf0BtNBgmjQiBcC8PKBXTRoBB/2Rq1dQsDYbvea/j3D6eZnIsuLp6mEFx0Yam9m7DGcDcPqYZCDxKzRy/fMhhYVxIAXjgxxy/ZMTvbmNch30LVfQ5YV8kcu/D7KlhtFgxC/0DetkDPT5IW1vMReyYYr/NoCQWtQTiXSd44xBaSB6yrac0Kq3WpqbJ2W0Lzde63yVV1xBhkQhrmLd7iGQT4NYr/yja3nHZQH6RW7DGlELn+SJzCwN2oQuRQXA+Sef8boiAhgUN1t1lFeWCKkBpmyWXBQ+HeRjxF0tglJt//eYf7FMEx6Jn7JwfaW0pGYFO8os0wE7VhL3XS2CfNBbXGfaW03Fk12GG2sA7hU3N9mXZlFj2zo4oL8adg7KiTazTIaRjvK3nqFE5MeTQtUv1LKXvgWDcZsq54k4bTO1xWdwurcdlcZeUHpdFd6M7BBD33TE7tuA2a77efzbFn+Y2Bx44uQ03RuVBAVCjBgZKnHFfIBuSB22XKcyQGNYJoNCZggskGgM9eQkiE9JOa2OBDpPac+sNA+u23mH1dXIL8dxqNPrZsvY2kehj0C6bYV1pT7pvO6Bp1VETL4UHHp44EDN+dHSUcnHwKn0G/GXKD17w9OXhyxevXuVPp4cvf9oy6EitpNPuu8T+/oDP92/8p7cax+ytxLNw9tYfPk/YGzyU3kuGUokosD6ivtMOxKPw/aPp8xE1hvZVH+WjEG37I/5He9GGtZO7LVlDub/baMWGmuMLboc6ksykknaRhSwnelcsJPCh1wPkpIOA/B7faVzZjrXMBznBQvsoJiPSN0Vh1hkAlx3uPovvUXmkyotaoEX3hNC2GLB2TWdyX6L0YzyIyJCyr9LZ3fViNxRtyBJfGK3mLOy+hzz+lNUd1NybZFC4145ZvD9l5Q9dH8PefI8dHj199vzJyBJbaAV3rof4gL1jNURc5IcHvYNSrDgoZL4t0zC6eETtK8Bh09FjZ+ng8Z1bgO2U97bJKn+EM9jA3yaRPQprex3Bp+71gLYmg2bfzwvWZvtIOa7xQl90yhuolmtbcUO7t79zNgFZxmq+oUJ0cwT3w6AZZPBkPoa1N/v80PD27pC4hEA7WilcaHaLp8Pv1OdOOxCsCQbB6BN7FPo8am8SKM0qvN7jXGxlo1eZcivzB96dcyrzi/Y7RpsUZOy2hVUAwnb8UNgGjsQfUW4XoTh8w+jo884C/4Jl4dHOzOlY1ISQ1bSFGgeNo1pD94A5eookNifJBzlnjwBz+HRnieeO2bqqtHFMUHBUrIYn/MEcxTH4E9B7z0MPih86kD1DMTjN2lYuJo112d0KXt5hX6YGZS9r1kqQf5hlU2no1t+OXN7SufqMUfdmaxw8KJVN+ACQbM7tjmmbWtC7BPEheH95xOHZi8OXqeD8p/QZiJfpq+dwkB6+AvFcHAC8evp8i0mj07A7bEqLgrN30v05x1ScoIpfjsYct2sMFyzp8GJwGmYBY0TaIjZHzUEIIxude5bUkXg5nb04ytMpn87SZ/zwKH119NNR+vTZARyJn3I+PXq1RVJ3s0Knlku+YH8HU0jViAnlUqxIRBfh9srtJBRjalDWx9NN3mN73c7mWq2tJawhGu1qerfochRJs7lUW+tDe83uvFvD3oMdI8Mj2An7AvAdU03KLejq3W/Ax1DHpElje+95qxQZbbP2uuNQr3sF/L3biulosfsk6Ra6/z0GCl5k/8kRw/Uk+bXjN24a0H+JA7meJD83HuSmMf/lSv5yJT/gSvx/eFfGVsC/A7erlK6Ydh5NaB6U6DfDtZLqJRgjBTSvS+Cx8aUDZWkrhqP24934nMUkqnj3WQucu9hvCKzpsA5wvFsfaNs9AMbHAkLesjMIehbiONlfHu43RW77V93nK673116/2L8aeWjiGp81wKqLoAW1KXClhJvbvJL+4nYqoKTb2yNvcZR6IHtPL/WpW/yMI99AeJTmB0Np2k00K/yMgrGQ14ZSDGdX0QW8ztEdva5RQGffuq0+4o1774VG2jaXzBBifOsB/54CN+RthldwiURKt8UYr90CUwTxKHSSfKT6lR/h4ClsYEDZH1+8EH0xvd6Bj2GgFsUTqu7LE5MEX+ewv8w+glnKHDrz0d7OpwvN+9RwXyBrDB1S+htPmmzounYJD4pcl3QARzgeWXYSFkx884Xe6RA6r3GB0zD+JzyTwH1CLbxD8jZyZb/iVfaQNfGHU6hQ4evfWv1BaVTaupKrHp1Nr8QM0V+1jzXcw9syYZYdXLr9quCS1IHU/yos3LNkSanjuHSTSXI8eHtmjT62GXso5huWUFuHRK+uMGj6bIrra/z5jxrQdJ99Q6NiqOqLFoqQFK1teMOlK4vHv4ZI4wnb9IzNhuHGC5vUIpq0JNwe7b+zg8bhXiCNzPIdsI3J2Beq+zdwdpPgf/mDOKPy9XIcf02oEXfrDNFEVq7zbe21lJ4PfHvyz5NPJ8n19b8BnabnIQ==
+sidebar_class_name: "delete api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Delete an external payroll.
+
+scope: `external_payrolls:write`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/delete-v-1-home-addresses-home-address-uuid.ParamsDetails.json b/docs/api/delete-v-1-home-addresses-home-address-uuid.ParamsDetails.json
new file mode 100644
index 000000000..45f54008e
--- /dev/null
+++ b/docs/api/delete-v-1-home-addresses-home-address-uuid.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"X-Gusto-API-Version","in":"header","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"},"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."},{"name":"home_address_uuid","in":"path","description":"The UUID of the home address","required":true,"schema":{"type":"string"}}]}
\ No newline at end of file
diff --git a/docs/api/delete-v-1-home-addresses-home-address-uuid.RequestSchema.json b/docs/api/delete-v-1-home-addresses-home-address-uuid.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/delete-v-1-home-addresses-home-address-uuid.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/delete-v-1-home-addresses-home-address-uuid.StatusCodes.json b/docs/api/delete-v-1-home-addresses-home-address-uuid.StatusCodes.json
new file mode 100644
index 000000000..8df8a2066
--- /dev/null
+++ b/docs/api/delete-v-1-home-addresses-home-address-uuid.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"204":{"description":"successful"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided ID/UUID is valid.","type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["error_key","category"],"properties":{"error_key":{"type":"string","description":"Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error."},"category":{"type":"string","description":"Specifies the type of error. The category provides error groupings and can be used to build custom error handling in your integration."},"message":{"type":"string","description":"Provides details about the error - generally this message can be surfaced to an end user."}}}}},"x-examples":{"not_found":{"errors":[{"error_key":"request","category":"not_found","message":"The requested resource was not found."}]}},"title":"Not-Found-Error-Object"}}}},"422":{"description":"Unprocessable Entity\n\nThis 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.\n","content":{"application/json":{"schema":{"description":"Unprocessable Entity\n \nThis 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.\n","type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["error_key","category"],"properties":{"error_key":{"type":"string","description":"Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error."},"category":{"type":"string","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."},"message":{"type":"string","description":"Provides details about the error - generally this message can be surfaced to an end user."},"metadata":{"type":"object","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.","oneOf":[{"type":"object","description":"multiple entities","required":["entities"],"properties":{"entities":{"type":"array","items":{"type":"object","description":"single entity","additionalProperties":true,"properties":{"entity_type":{"type":"string","description":"Name of the entity that the error corresponds to."},"entity_uuid":{"type":"string","description":"Unique identifier for the entity."},"valid_from":{"type":["string","null"]},"valid_up_to":{"type":["string","null"]},"key":{"type":["string","null"]},"state":{"type":["string","null"]}},"title":"Metadata-With-One-Entity"}}},"title":"Metadata-With-Multiple-Entities"},{"type":"object","description":"single entity","additionalProperties":true,"properties":{"entity_type":{"type":"string","description":"Name of the entity that the error corresponds to."},"entity_uuid":{"type":"string","description":"Unique identifier for the entity."},"valid_from":{"type":["string","null"]},"valid_up_to":{"type":["string","null"]},"key":{"type":["string","null"]},"state":{"type":["string","null"]}},"title":"Metadata-With-One-Entity"}]},"errors":{"type":"array","description":"Will only exist if category is `nested_errors`. It is possible to have multiple levels of nested errors.","items":"circular(Entity-Error-Object)"}},"title":"Entity-Error-Object"}}},"x-examples":{"bank_account_delete_unfunded_payments":{"errors":[{"error_key":"base","category":"invalid_operation","message":"FundingMethod has unfunded payments"}]},"bank_account_verify_incorrect_deposits":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Your bank account cannot be verified. Please check the test deposit amounts."}]},"bank_account_verify_already_verified":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Your bank account has already been verified."}]},"bank_account_missing_routing":{"errors":[{"error_key":"routing_number","category":"invalid_attribute_value","message":"Routing number is required."}]},"payment_configs_missing_parameter":{"errors":[{"error_key":"base","category":"missing_parameter","message":"At least one parameter must be provided"}]},"payment_configs_invalid_fast_payment_limit":{"errors":[{"error_key":"fast_payment_limit","category":"invalid_attribute_value","message":"Fast payment limit should be a number"}]},"pay_periods_invalid_end_date":{"errors":[{"error_key":"end_date","category":"invalid_parameter","message":"End date cannot be more than 3 months in future"}]},"company_industry_selection_naics_code_required":{"errors":[{"error_key":"naics_code","category":"invalid_attribute_value","message":"Naics code is required."}]},"company_industry_selection_naics_code_invalid":{"errors":[{"error_key":"naics_code","category":"invalid_attribute_value","message":"Naics code must be equal to 6 digits."}]},"company_industry_selection_sics_codes_invalid":{"errors":[{"error_key":"sic_codes","category":"invalid_attribute_value","message":"Sic codes must be equal to 4 digits"}]},"time_off_policy_name_required":{"errors":[{"error_key":"name","category":"invalid_attribute_value","message":"Name is required."}]},"time_off_policy_unlimited_invalid_accrual_rate":{"errors":[{"error_key":"accrual_rate","category":"invalid_operation","message":"Accrual rate must be blank for unlimited policies."}]},"time_off_policy_pending_requests":{"errors":[{"error_key":"time_off_policy","category":"invalid_operation","message":"Cannot deactivate policy with pending time off requests."}]},"time_off_policy_employees_required":{"errors":[{"error_key":"employees","category":"invalid_attribute_value","message":"Employees are required."}]},"time_off_policy_unlimited_balance_update":{"errors":[{"error_key":"base","category":"invalid_attribute_value","message":"Can not adjust balances for unlimited policies."}]},"holiday_pay_policy_already_exists":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Company already has a holiday pay policy."}]},"holiday_pay_policy_not_exists":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Company does not have a holiday pay policy, please create one"}]},"holiday_pay_policy_invalid_employees":{"errors":[{"error_key":"employees","category":"invalid_attribute_value","message":"Invalid employee uuids provided."}]},"onboarded_employee":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Cannot delete onboarded employee"}]},"invalid_attribute":{"errors":[{"error_key":"base","category":"invalid_operation","message":"There is an error in the request body."}]},"company_cannot_enable_contractor_only":{"errors":[{"error_key":"contractor_only","category":"invalid_attribute_value","message":"Contractor only cannot be enabled for existing companies."}]},"company_missing_parameter":{"errors":[{"error_key":"base","category":"missing_parameter","message":"contractor_only is required."}]},"starting_after_uuid_invalid":{"errors":[{"error_key":"starting_after_uuid","category":"invalid_attribute_value","message":"Parameter 'starting_after_uuid' does not correspond to a valid event."}]},"resource_uuid_invalid":{"errors":[{"error_key":"resource_uuid","category":"invalid_attribute_value","message":"Parameter 'resource_uuid' does not correspond to a valid resource."}]},"payroll_gross_up_invalid_net_pay":{"errors":[{"error_key":"net_pay","category":"invalid_attribute_value","message":"Net pay must be a number."}]},"payroll_accruing_hours_invalid":{"errors":[{"error_key":"base","category":"invalid_attribute_value","message":"Hours cannot be negative."}]},"payroll_cannot_cancel":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Payroll cannot be canceled."}]},"frozen_payroll":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This payroll has already been processed. Its data cannot be updated or altered."}]},"frozen_payroll_processing":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This payroll is being processed and cannot be updated at this time."}]},"unmodifiable_payroll_type":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This type of payroll cannot be modified or processed. It is reserved for system processes."}]},"invalid_employee_uuids_format":{"errors":[{"error_key":"employee_uuids","category":"invalid_attribute_value","message":"Parameter employee_uuids must be an array."}]},"maximum_employee_uuids_surpassed":{"errors":[{"error_key":"employee_uuids","category":"invalid_attribute_value","message":"Exceeded maximum of 100 for lookup."}]},"invalid_employee_uuid":{"errors":[{"error_key":"employee_uuids","category":"invalid_attribute_value","message":"Invalid Employee UUID(s).","metadata":{"entities":[{"entity_type":"Employee","entity_uuid":"invalid-uuid-123"}]}}]},"payroll_blocker_missing_bank_info":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must have a bank account in order to run payroll.","metadata":{"key":"missing_bank_info"}}]},"payroll_blocker_missing_employee_setup":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must add employees in order to run payroll.","metadata":{"key":"missing_employee_setup"}}]},"payroll_blocker_missing_federal_tax_setup":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must complete federal tax setup in order to run payroll.","metadata":{"key":"missing_federal_tax_setup"}}]},"payroll_blocker_missing_bank_verification":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company bank account must be verified in order to run payroll.","metadata":{"key":"missing_bank_verification"}}]},"payroll_blocker_suspended":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company is suspended and cannot run payroll.","metadata":{"key":"suspended"}}]},"submission_blocker_missing_selection":{"errors":[{"error_key":"submission_blockers","category":"invalid_attribute_value","message":"Submission blockers selections required"}]},"submission_blocker_invalid_option":{"errors":[{"error_key":"submission_blockers","category":"nested_errors","metadata":{"blocker_type":"fast_ach_threshold_exceeded"},"errors":[{"error_key":"selected_option","category":"invalid_attribute_value","message":"Selection is not available to resolve Fast ACH Threshold Exceeded. Please choose one of Wire In, Move To Four Day"}]}]},"invalid_version":{"errors":[{"error_key":"base","category":"invalid_resource_version","message":"You are attempting to update a resource using an out-of-date version."}]},"signatory_email_required":{"errors":[{"error_key":"email","category":"invalid_attribute_value","message":"Email is required"}]},"signatory_company_already_has_signatory":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Cannot have more than one signatory in a company. Please remove the existing signatory before adding a new one."}]},"mixed_disbursement_errors":{"errors":[{"error_key":"disbursements","category":"nested_errors","metadata":{"contractor_payment_uuid":"invalid-uuid-1"},"errors":[{"error_key":"contractor_payment_uuid","category":"not_found","message":"Disbursement not found."}]},{"error_key":"disbursements","category":"nested_errors","metadata":{"contractor_payment_uuid":"d0dfa222-ad08-4ea7-a06a-717688c3b179"},"errors":[{"error_key":"payment_method","category":"invalid_attribute_value","message":"Payment method must be one of: Direct Deposit, Check."},{"error_key":"payment_status","category":"invalid_attribute_value","message":"Payment status is not valid for payment method 'InvalidMethod'."}]}]},"not_found":{"errors":[{"error_key":"request","category":"not_found","message":"The requested resource was not found."}]},"finish_onboarding_incomplete":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Company is not ready to exit onboarding."}]},"company_location_validation":{"errors":[{"error_key":"street_1","category":"invalid_attribute_value","message":"Must include a street address"},{"error_key":"city","category":"invalid_attribute_value","message":"Must include a city"},{"error_key":"state","category":"invalid_attribute_value","message":"State is in the wrong format"},{"error_key":"zip","category":"invalid_attribute_value","message":"Please enter a valid zip code (e.g. 12345)."},{"error_key":"phone_number","category":"invalid_attribute_value","message":"Phone number must be 10 digits"}]},"conflict":{"errors":[{"error_key":"request","category":"duplicate_operation","message":"A resource with these attributes already exists."}]},"invalid_parameter":{"errors":[{"error_key":"request","category":"invalid_parameter","message":"The provided parameter is invalid or missing."}]},"flow_invalid_entity":{"errors":[{"error_key":"entity_type","category":"invalid_attribute_value","message":"Invalid flow entity"},{"error_key":"entity_uuid","category":"invalid_attribute_value","message":"Invalid flow entity"}]},"flow_nested_options_errors":{"errors":[{"error_key":"options","category":"nested_errors","metadata":{"flow_type":"company_forms"},"errors":[{"error_key":"form_types","category":"invalid_attribute_value","message":"Supplied value 'invalid' contains no permitted values"}]}]},"basic":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must complete all onboarding requirements in order to run payroll.","metadata":{"key":"needs_onboarding"}}]},"contractor_payment_invalid_wage":{"errors":[{"error_key":"wage","category":"invalid_attribute_value","message":"Wage must be greater than or equal to 0."}]},"contractor_payment_cannot_cancel":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Payment has already been processed and cannot be cancelled. Contact support directly."}]},"time_off_request_cannot_delete":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This time off request cannot be deleted."}]},"resource":{"errors":[{"error_key":"first_name","category":"invalid_attribute_value","message":"First name is required"},{"error_key":"date_of_birth","category":"invalid_attribute_value","message":"Date of birth is not a valid date"}]},"nested":{"errors":[{"error_key":"contractor_payments","category":"nested_errors","metadata":{"contractor_uuid":"72ae4617-daa9-4ed7-85e0-18ed5d0ee835"},"errors":[{"error_key":"hours","category":"invalid_attribute_value","message":"Ella Fitzgerald is paid fixed wage and hours cannot be set on a contractor payment"}]},{"error_key":"contractor_payments","category":"nested_errors","metadata":{"contractor_uuid":"2d7bf62c-babf-4a12-8292-340e2d9cab28"},"errors":[{"error_key":"wage","category":"invalid_attribute_value","message":"Isaiah Berlin is paid hourly and wage cannot be set on a contractor payment"}]}]},"compensation_invalid_rate":{"errors":[{"error_key":"rate","category":"invalid_attribute_value","message":"Rate is not a valid number"}]},"compensation_invalid_payment_unit":{"errors":[{"error_key":"payment_unit","category":"invalid_attribute_value","message":"Payment unit must be one of Hour, Week, Month, or Year"}]},"compensation_already_processed":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Compensation has already been processed on payroll."}]}},"title":"Unprocessable-Entity-Error-Object"}}}}}}
\ No newline at end of file
diff --git a/docs/api/delete-v-1-home-addresses-home-address-uuid.api.mdx b/docs/api/delete-v-1-home-addresses-home-address-uuid.api.mdx
new file mode 100644
index 000000000..81a97adb0
--- /dev/null
+++ b/docs/api/delete-v-1-home-addresses-home-address-uuid.api.mdx
@@ -0,0 +1,71 @@
+---
+id: delete-v-1-home-addresses-home-address-uuid
+title: "Delete an employee's home address"
+description: "Used for deleting an employee's home address. Cannot delete the employee's active home address."
+sidebar_label: "Delete an employee's home address"
+hide_title: true
+hide_table_of_contents: true
+api: eJztXG1vGzmS/ivc3g9OALVsK87L+NPmYufWwGbGmDiXWzhBm2pWSxx3kz0kW7bG8H9fFF/6TS3ZUmzs3WIGGMxYTRYfFquKxaoi7yJZgqKGS3HGouOIQQ4G4sVhPJcFJJQxBVqD7vyZVBVn0ShioFPFS+wcHUdfNDCSSUUsDS5mhAoCRZnLJcCeJkiBeApj8oEKIY1rC8TMod2UpoYvoNvjm/gmdCpLOCZXoak+vlHcwFU0igyd6ej4Mjr1n8j7AD36Popu41mljYy5MDBz043NsgTsAcUUGAOcEC3LdhPbtaSKFmBAIfm7SNACouPof+P/tgTfn5/F/wNKIwtGEUc+zIEyUNEo0ukcChod30VuqEgbxcUsGkUgqgKHnhxMXscHb+LD1zgSg4xWuYmO27/f99l8glgKLkBbrjFqIJ5S5P378zOycFgI1VqmnBpg5IabOVnKStkGKc3zMTnLiJACCNekVHLBGbCRa0PLMuepnf6eJpcFF7yoijbt7y/mxpT6eH+fyVSPLWPHqSz2AyPjki6VzHP7fZ+WPPY9uZj91ROMWz+/RBiVBjaO7kc1h4cEzvK3pGa+InwXcyBfvpydEJlZtrRFJxpFCn6vuAIWHRtVwfqlub//Poo0pJXiZmnX+4MsSiqW79MUtH5fmXl0fPn9viVSSt/QWaCrQJdSoNAd30WTgyP8TxeoriylrMpxaY+GmvwsDfkoK4EzTqUwIAw2aq3M/m8aW9615rGGBPkmCPkmkD3IA9AoEQq0rFQKhEnQBNUQbrk2Y/KJXgPRlXIKGSSDnJ3sW95yTRY052yM+ub4Jqe/QWo6HL6MQCmpnPIoNC+GO4b43xuuU6XoEtfVQNH+fT3V5BqwQ0oNzKRarhnDthrQuy6TPpeQ8oyDJjdz8HO23YlM00rpMblYlhwVZknMnGtyDUvCGQjjemF7aozi08rAfm0niILcKp6RDUkU7Qb1FtCQArZFwXaUCC5mIBUWSXvkMyWrkouZJlQwklJBpmB1C9FMK54zkqLYFr79nAqWo63mwul/y/xZzAVoTWfwMOTzAISBoTzXhE5lZVpMjckMBKiGnZ50QKkrldHUIcWdQzAEjpzDf1Dh4JYWZe7WWUiTZFZJWoJ12Vn/yEt8W16OWx1bk4vWKMgNdfphO4yj++8IxHCTg1Oy2CpZfIqDxr84qXVojyaTVbX8IkolUf3pNAdyKgw3S9zXLiw76JLMaVmCQHkUlnNTyZa48nZpPD6CNoFy4ZdcE12lc0I1ueLCqmdSC2WyoHkFVyMilSUXKGR2gVgFntd1z9oZuBqTz+BU4vLUDfPB8ZCD3nIHsDDjtO7+kswqzsD6CoVUECRm/E3sbvGGWets35/MDcz902r/51ttdO7qgbgmV8IatcSt49XIgnNrRW54ngeRJ5S4luTKNyV+kZbOhwSrVF4x/s9sDojCUEYNHRLFLowPQbkV5LCgwqD7TJGmF5Cl12Rv/rkgVqfRo7Zmw1ukaQ5j8lEq4nekUYeExWdZdeX+myCqK7u24Rd0aK8c+6eNp4WOlRTwS2a3ss1zKarc8DIHNxbqUU/xws+ryha+bKHSPSeWi1kYGbtRxjh+ovl5ayTnEg+M7RjysNT8TAsIDr3nqJnTttikUjmXm2lipJWGFoMfHuGL4L9X0JgHZe1mM56l6Kx3pmTRELxsKIoqz6PvdbuqTIzc3LBj54YaaEMNbGrS8kI+eemPv3Izj38RELvNL7pf3+qTlx3XFJcGD15/rvn//zVHSms37C4fvqLxkSJfutMf4Ru3jTE5MzZcILXm6GIZSeZ0AaS2QzksINe4dn4bCRtFbVailKu0yql64eB2/OaXUXuGAw2igVPAlIrrhKaprIRJXCwpqURWCQYsKemyAGH0hhMCBk66x4MVZ61zTPhYCcbF7BOYuWRkTjUJo5F6NLsGHWALUDxbJlxY0U0RaSk1f1Jk/0Q3AEclflTcOfHoMgVix+fAxuQ8B6qBpHNIr52Tgh6rh0NogR31eP0UaK6AsmUSKD7rBJC9fkAyBRDNPAYAFlyjhUqUrDD2uOlU6FokoiqmNk43ALHn5HeA/ur6E9cfdSJsux6Xl4QklSLjM11Dq33Nrbi22rsN5r0huKSGYDSvcWaLSpu2YzEMLMw2o9oEbUlyXnCzAeFA461Z+BERexrE0iB6LqucIWbqOVtjTkpQXLIGLwiWMG8t16CsmwxiG+blqWA2nNrSHHuCMnMqyCtSSGHmGn3CrDKVAocvdfHBhAtWaaOWiYYcUpTuRFCe6iSVDJLGMVuLuGm9PT9/xr4E+w6I4+MQ+mGeH2AQTfi9ojnuIm8I4zNem50NcHUAoB8BV/PUtd0e7WeeWqx6FeyRB+uwGl5AIrMsKWXO02WCoevHrXWxExOLofXtg6iE1Shgtb7QNFUVzRO1WWc6zbaw3O9dP4L9ao5NczTl6FnVeIgFyEGvAV6C3VwTH0jZtDv2um6Dtk482SQTQnY03BnXYyA4AJFZFqI66zDXmajHLHvdePu1D2ktTaiCx0vAlOZUpJBU5QP2cv1uvQnVBypseJSy3+yyu9H05mWfy5wztOr4rwMc3ArriD6lV+SzN7UbYV0K4hHgDuQXfz00DBc/G6w6/2I96SFgI1J6l00ByqoUsBZqvT3WYvYsonjm2tT5WoLHLt2KYVh8UkwlVeiGh3ZPyb9O8rgeqobkIKxM5gkRXNjYI9c22GOPpVx0osAYXO7taM6tSEBg/AidMKNoaqRK8BC2AVu/5fZqWhNw573Gv3FYXNreSjnaPoe3UdiA/zn92N4cB7Y5baiyfjvNDCh71n+MF7Daa3v+ndd+9d4Avb1GjZvQhI1TEq8oCxDGzyKEFh+Lv9P+h5B3KD2IObRujjSYckhmSmI2vqxtjQB7GNjk6/gW27s7YM8ItUcRzgU9SNZrwRWZy0o9xjHcbav7O1JvaY6AGcUilR4ar+Mp7oP5E9qbc0e/BcANUatHpuQfIBKP40ktHUZ9/PArR3KfdMPYwpnRLpzeYHRuB8MMGc0NqDVoE09l87n9h4BzTaaAxq0GHFItPag21Mi1dQA92EoUkvGMW7MdIIdo5lOCDRmjcmWxHQDHyQ7LnaHUoBbeiuulNlDUjYIN7/sG1groJJOqoJtO+932P2KAupQarRbEhic9zoLeYnlQH6euVElxzs8I9fQ2BUAvwmPAlTg8OLBczaW8rspNvHxGYMHhqkvbsBjnhX45jrq5ryavc9kLutfHh6gXKw/jx/hnfDh5ZUsc2gZtmsv0GlS9+dugGxeZ3Er4e9QGnWErEd4R7sQBuSBSMVC4P6lKBPXoT9+NvYpz83zqxdFgqvJ5JkVZ45rq3abTg7l5ThkwTKUmht4+57TQL7QOuB+PGHpL7Hi7zXEV9iNE0cWEXZHIk0+zI4bBYoUo9A/IZQf08CR1pTEWsWWI/TGT4ljU4om3N8EHp9BAcpB1NbWzkmJlaeqY3SbXfKX7LqG6mggJREg9eHOGiNYBbnblH0XbSZf1+BdG89bYhtBpOk/MXIGey5wl4DefqJW/6yOw04Ia6/a8CnxBEbBhmwXlOfXJPPT48wUQG5t//+Hv5CKAI2FnbOWPpNQ2GIGb5FeugJyJEfkkF0AuJFaeKnJCbTqyvWH6et+d3Kb6+LKoq607uSMbF6PGQFHaQ6yR3qUjtKnnqLQvS5eViWUW2++eYDhm8pmgRioM7VGePy6sR3m+S0iP8rx90O0DCOfuEB2bU53UX58+muKyuXXCAxe3Ho3Y8iAPqBYDBQWuuE2dh+BB02UKGRLDOgFkOhFwg0SDo8dvgSWM62mlNNhkUpO3XjOxdusttK8VWwh5q0HvZ4PurSPxiMrSkxboXi3p6Jmnxw5YRieTSUzZwbv4COjbmB68ofHbw7dv3r1LX00P3/60YdKBWmGz3bv4/i7B5/rX+6ezGsfkhGMunJy45POIfMCktLsCMIQC6yOqnU4gDoXrH0yf86jRtS+7KPe8t+1S/HvjYMP+XfXGoyjjgut54qOcuLtiIYFzvZ4hJu0Z5M74RqJmG9IM3osJ5tJ5MYkl/ZAXpo0CMMnh9qv4CYWHizSvGFp0R6i+4NGXmdSVKP3YGJZIn7Kr0tl+68VuyFofJb5RUsyIP333x/iDlzuIuTPJIPCsHaJ4f/DSJV1fwHg2JoeTV0evXw6o2FwK2Lke4hx7h2qIoOSHB51EKVYc5DzdFGkYVB5WuQpwWJd6bKkOpu/MHHSrvLcJVrkUTu8A/5hA9iCszXUEF+27M01Nhl19ty5Ym+085aDjubxplTfYWq5NxQ3N2X7naAIOGar5+gLRjhE8zQD1JP1O5nxY/fCe7xs+fju0o3hHO1gpVDS9YafD77bPTicQrAkGRuwnsuf77DU3CYQkJV7ZMya00mFXmVLN02c+nVNb5hfsd/A2rZOx3RFWADDd2of8MXDA/wh8u/HF4WtmZz9vzfCvWBYe7MzMpkWVd1lVU6hxUG9UK+ieMUZvPYn1QfJezNkhwBg+sZXpqSG6KkupDGHWOcqX/Qy/N0dhDi4D+uRx6F7xQwuyG5D1slmbysW40ibZreDlI/Ylolf2smKtmN0fsmTKlb0ZuuUoJzavnhHbvT4a+x3Ulk04B9DanMelaeta0F2ceO+8v51QOHpz+DZmlP4UHwF7G797DQfx4Ttgr9kBwLtXrzeYNJsN2+FQmueUfOTmjxmG4pit+KVozPG4RlBhrQzPe9kwDegj2iNinWr2TBg46Dwxpybs7TR7M0njKZ1m8RE9nMTvJj9N4ldHBzBhP6V0Onm3gVO7WaEzTTmdk/8ClXNRswn5ki8ti2787ZXHcSj41CC086fruMfmup31tVobS1i9N9qW9HbR5SCS+nApNtaHdprtfFrD3r0TI8EU7Ih8BbjGUJMwc3v17p9Ah1CHoElte5/4qBQG2mTtZWtD7V4d7dxWjNcUu7tyd10CvQaql7G9JdbKJzUvHHTbocGM5QKU4gzqNx0w9XNrQGjrTiEL3OTXPo1gLzdUDz+RgNrdJeWuxNf98U5Iu1F/RnXDgZkN9+vOsOnvZ4rX833QojV7+27AcbS/ONzvvm2xf7fy1sA9Pt+ASVUvLZXK0ab6i5m05O5eZsygsJczVy5XnEAhe8vi6MUuMoOfcW5rCA/SPFc2CrOOZomf2+8XfMarsq4KbOAVg/p2CA4eXqvAv6dAlXUs+3fnLInYXvMgtDJz9O1DDmMUfbaJ5x8ZwVFYM4A9trmsY1Ai+wIHvkyBEhBCy+23M0YRPpWhf8k+g1rwFFqcbq7V2puI+7bhPsOhUedj+zeGiLXvunJ7BvIU35gwklgce5qcei0hoVgDH81gMq3Qotlp/MXfb6buJOxfujgJo5Jf8Q6qP+64qDKKiv/6t0YykBul1KagokPH+ftrX13pT+KuuWz97369xQmKgVuzX+aUW4myunHn9fYyWmDYqKu50Sg6Xn0n5Ds20wb73N2hbf+i8vt7/Pn3CtC8X35Hk6FsQYdVb8atIWbRcUZzDRvY9OJX74W+JA88OTI4pXAhSyxbVivyt8MGnjxxpZ7uQZntgP5HPxOzhruOi8NP89TMbnYUtFWlaX1beW+gs5GcnP7j9OIUt8Cudautmf+f1tXd7jrf3bkWF/IaxP19vewG/7YOwv2/AJQSkuc=
+sidebar_class_name: "delete api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Used for deleting an employee's home address. Cannot delete the employee's active home address.
+
+scope: `employees:write`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/delete-v-1-jobs-job-id.ParamsDetails.json b/docs/api/delete-v-1-jobs-job-id.ParamsDetails.json
new file mode 100644
index 000000000..ca3a5814e
--- /dev/null
+++ b/docs/api/delete-v-1-jobs-job-id.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"schema":{"type":"string"},"name":"job_id","in":"path","required":true,"description":"The UUID of the job"},{"name":"X-Gusto-API-Version","in":"header","required":false,"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.","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"}}]}
\ No newline at end of file
diff --git a/docs/api/delete-v-1-jobs-job-id.RequestSchema.json b/docs/api/delete-v-1-jobs-job-id.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/delete-v-1-jobs-job-id.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/delete-v-1-jobs-job-id.StatusCodes.json b/docs/api/delete-v-1-jobs-job-id.StatusCodes.json
new file mode 100644
index 000000000..8c4f80195
--- /dev/null
+++ b/docs/api/delete-v-1-jobs-job-id.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"204":{"description":"No Content"},"404":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided UUID is valid.\n"},"422":{"description":"Unprocessable Entity \n \nThis 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.\n","content":{"application/json":{"schema":{"description":"Unprocessable Entity\n \nThis 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.\n","type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["error_key","category"],"properties":{"error_key":{"type":"string","description":"Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error."},"category":{"type":"string","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."},"message":{"type":"string","description":"Provides details about the error - generally this message can be surfaced to an end user."},"metadata":{"type":"object","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.","oneOf":[{"type":"object","description":"multiple entities","required":["entities"],"properties":{"entities":{"type":"array","items":{"type":"object","description":"single entity","additionalProperties":true,"properties":{"entity_type":{"type":"string","description":"Name of the entity that the error corresponds to."},"entity_uuid":{"type":"string","description":"Unique identifier for the entity."},"valid_from":{"type":["string","null"]},"valid_up_to":{"type":["string","null"]},"key":{"type":["string","null"]},"state":{"type":["string","null"]}},"title":"Metadata-With-One-Entity"}}},"title":"Metadata-With-Multiple-Entities"},{"type":"object","description":"single entity","additionalProperties":true,"properties":{"entity_type":{"type":"string","description":"Name of the entity that the error corresponds to."},"entity_uuid":{"type":"string","description":"Unique identifier for the entity."},"valid_from":{"type":["string","null"]},"valid_up_to":{"type":["string","null"]},"key":{"type":["string","null"]},"state":{"type":["string","null"]}},"title":"Metadata-With-One-Entity"}]},"errors":{"type":"array","description":"Will only exist if category is `nested_errors`. It is possible to have multiple levels of nested errors.","items":"circular(Entity-Error-Object)"}},"title":"Entity-Error-Object"}}},"x-examples":{"bank_account_delete_unfunded_payments":{"errors":[{"error_key":"base","category":"invalid_operation","message":"FundingMethod has unfunded payments"}]},"bank_account_verify_incorrect_deposits":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Your bank account cannot be verified. Please check the test deposit amounts."}]},"bank_account_verify_already_verified":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Your bank account has already been verified."}]},"bank_account_missing_routing":{"errors":[{"error_key":"routing_number","category":"invalid_attribute_value","message":"Routing number is required."}]},"payment_configs_missing_parameter":{"errors":[{"error_key":"base","category":"missing_parameter","message":"At least one parameter must be provided"}]},"payment_configs_invalid_fast_payment_limit":{"errors":[{"error_key":"fast_payment_limit","category":"invalid_attribute_value","message":"Fast payment limit should be a number"}]},"pay_periods_invalid_end_date":{"errors":[{"error_key":"end_date","category":"invalid_parameter","message":"End date cannot be more than 3 months in future"}]},"company_industry_selection_naics_code_required":{"errors":[{"error_key":"naics_code","category":"invalid_attribute_value","message":"Naics code is required."}]},"company_industry_selection_naics_code_invalid":{"errors":[{"error_key":"naics_code","category":"invalid_attribute_value","message":"Naics code must be equal to 6 digits."}]},"company_industry_selection_sics_codes_invalid":{"errors":[{"error_key":"sic_codes","category":"invalid_attribute_value","message":"Sic codes must be equal to 4 digits"}]},"time_off_policy_name_required":{"errors":[{"error_key":"name","category":"invalid_attribute_value","message":"Name is required."}]},"time_off_policy_unlimited_invalid_accrual_rate":{"errors":[{"error_key":"accrual_rate","category":"invalid_operation","message":"Accrual rate must be blank for unlimited policies."}]},"time_off_policy_pending_requests":{"errors":[{"error_key":"time_off_policy","category":"invalid_operation","message":"Cannot deactivate policy with pending time off requests."}]},"time_off_policy_employees_required":{"errors":[{"error_key":"employees","category":"invalid_attribute_value","message":"Employees are required."}]},"time_off_policy_unlimited_balance_update":{"errors":[{"error_key":"base","category":"invalid_attribute_value","message":"Can not adjust balances for unlimited policies."}]},"holiday_pay_policy_already_exists":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Company already has a holiday pay policy."}]},"holiday_pay_policy_not_exists":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Company does not have a holiday pay policy, please create one"}]},"holiday_pay_policy_invalid_employees":{"errors":[{"error_key":"employees","category":"invalid_attribute_value","message":"Invalid employee uuids provided."}]},"onboarded_employee":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Cannot delete onboarded employee"}]},"invalid_attribute":{"errors":[{"error_key":"base","category":"invalid_operation","message":"There is an error in the request body."}]},"company_cannot_enable_contractor_only":{"errors":[{"error_key":"contractor_only","category":"invalid_attribute_value","message":"Contractor only cannot be enabled for existing companies."}]},"company_missing_parameter":{"errors":[{"error_key":"base","category":"missing_parameter","message":"contractor_only is required."}]},"starting_after_uuid_invalid":{"errors":[{"error_key":"starting_after_uuid","category":"invalid_attribute_value","message":"Parameter 'starting_after_uuid' does not correspond to a valid event."}]},"resource_uuid_invalid":{"errors":[{"error_key":"resource_uuid","category":"invalid_attribute_value","message":"Parameter 'resource_uuid' does not correspond to a valid resource."}]},"payroll_gross_up_invalid_net_pay":{"errors":[{"error_key":"net_pay","category":"invalid_attribute_value","message":"Net pay must be a number."}]},"payroll_accruing_hours_invalid":{"errors":[{"error_key":"base","category":"invalid_attribute_value","message":"Hours cannot be negative."}]},"payroll_cannot_cancel":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Payroll cannot be canceled."}]},"frozen_payroll":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This payroll has already been processed. Its data cannot be updated or altered."}]},"frozen_payroll_processing":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This payroll is being processed and cannot be updated at this time."}]},"unmodifiable_payroll_type":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This type of payroll cannot be modified or processed. It is reserved for system processes."}]},"invalid_employee_uuids_format":{"errors":[{"error_key":"employee_uuids","category":"invalid_attribute_value","message":"Parameter employee_uuids must be an array."}]},"maximum_employee_uuids_surpassed":{"errors":[{"error_key":"employee_uuids","category":"invalid_attribute_value","message":"Exceeded maximum of 100 for lookup."}]},"invalid_employee_uuid":{"errors":[{"error_key":"employee_uuids","category":"invalid_attribute_value","message":"Invalid Employee UUID(s).","metadata":{"entities":[{"entity_type":"Employee","entity_uuid":"invalid-uuid-123"}]}}]},"payroll_blocker_missing_bank_info":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must have a bank account in order to run payroll.","metadata":{"key":"missing_bank_info"}}]},"payroll_blocker_missing_employee_setup":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must add employees in order to run payroll.","metadata":{"key":"missing_employee_setup"}}]},"payroll_blocker_missing_federal_tax_setup":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must complete federal tax setup in order to run payroll.","metadata":{"key":"missing_federal_tax_setup"}}]},"payroll_blocker_missing_bank_verification":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company bank account must be verified in order to run payroll.","metadata":{"key":"missing_bank_verification"}}]},"payroll_blocker_suspended":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company is suspended and cannot run payroll.","metadata":{"key":"suspended"}}]},"submission_blocker_missing_selection":{"errors":[{"error_key":"submission_blockers","category":"invalid_attribute_value","message":"Submission blockers selections required"}]},"submission_blocker_invalid_option":{"errors":[{"error_key":"submission_blockers","category":"nested_errors","metadata":{"blocker_type":"fast_ach_threshold_exceeded"},"errors":[{"error_key":"selected_option","category":"invalid_attribute_value","message":"Selection is not available to resolve Fast ACH Threshold Exceeded. Please choose one of Wire In, Move To Four Day"}]}]},"invalid_version":{"errors":[{"error_key":"base","category":"invalid_resource_version","message":"You are attempting to update a resource using an out-of-date version."}]},"signatory_email_required":{"errors":[{"error_key":"email","category":"invalid_attribute_value","message":"Email is required"}]},"signatory_company_already_has_signatory":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Cannot have more than one signatory in a company. Please remove the existing signatory before adding a new one."}]},"mixed_disbursement_errors":{"errors":[{"error_key":"disbursements","category":"nested_errors","metadata":{"contractor_payment_uuid":"invalid-uuid-1"},"errors":[{"error_key":"contractor_payment_uuid","category":"not_found","message":"Disbursement not found."}]},{"error_key":"disbursements","category":"nested_errors","metadata":{"contractor_payment_uuid":"d0dfa222-ad08-4ea7-a06a-717688c3b179"},"errors":[{"error_key":"payment_method","category":"invalid_attribute_value","message":"Payment method must be one of: Direct Deposit, Check."},{"error_key":"payment_status","category":"invalid_attribute_value","message":"Payment status is not valid for payment method 'InvalidMethod'."}]}]},"not_found":{"errors":[{"error_key":"request","category":"not_found","message":"The requested resource was not found."}]},"finish_onboarding_incomplete":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Company is not ready to exit onboarding."}]},"company_location_validation":{"errors":[{"error_key":"street_1","category":"invalid_attribute_value","message":"Must include a street address"},{"error_key":"city","category":"invalid_attribute_value","message":"Must include a city"},{"error_key":"state","category":"invalid_attribute_value","message":"State is in the wrong format"},{"error_key":"zip","category":"invalid_attribute_value","message":"Please enter a valid zip code (e.g. 12345)."},{"error_key":"phone_number","category":"invalid_attribute_value","message":"Phone number must be 10 digits"}]},"conflict":{"errors":[{"error_key":"request","category":"duplicate_operation","message":"A resource with these attributes already exists."}]},"invalid_parameter":{"errors":[{"error_key":"request","category":"invalid_parameter","message":"The provided parameter is invalid or missing."}]},"flow_invalid_entity":{"errors":[{"error_key":"entity_type","category":"invalid_attribute_value","message":"Invalid flow entity"},{"error_key":"entity_uuid","category":"invalid_attribute_value","message":"Invalid flow entity"}]},"flow_nested_options_errors":{"errors":[{"error_key":"options","category":"nested_errors","metadata":{"flow_type":"company_forms"},"errors":[{"error_key":"form_types","category":"invalid_attribute_value","message":"Supplied value 'invalid' contains no permitted values"}]}]},"basic":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must complete all onboarding requirements in order to run payroll.","metadata":{"key":"needs_onboarding"}}]},"contractor_payment_invalid_wage":{"errors":[{"error_key":"wage","category":"invalid_attribute_value","message":"Wage must be greater than or equal to 0."}]},"contractor_payment_cannot_cancel":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Payment has already been processed and cannot be cancelled. Contact support directly."}]},"time_off_request_cannot_delete":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This time off request cannot be deleted."}]},"resource":{"errors":[{"error_key":"first_name","category":"invalid_attribute_value","message":"First name is required"},{"error_key":"date_of_birth","category":"invalid_attribute_value","message":"Date of birth is not a valid date"}]},"nested":{"errors":[{"error_key":"contractor_payments","category":"nested_errors","metadata":{"contractor_uuid":"72ae4617-daa9-4ed7-85e0-18ed5d0ee835"},"errors":[{"error_key":"hours","category":"invalid_attribute_value","message":"Ella Fitzgerald is paid fixed wage and hours cannot be set on a contractor payment"}]},{"error_key":"contractor_payments","category":"nested_errors","metadata":{"contractor_uuid":"2d7bf62c-babf-4a12-8292-340e2d9cab28"},"errors":[{"error_key":"wage","category":"invalid_attribute_value","message":"Isaiah Berlin is paid hourly and wage cannot be set on a contractor payment"}]}]},"compensation_invalid_rate":{"errors":[{"error_key":"rate","category":"invalid_attribute_value","message":"Rate is not a valid number"}]},"compensation_invalid_payment_unit":{"errors":[{"error_key":"payment_unit","category":"invalid_attribute_value","message":"Payment unit must be one of Hour, Week, Month, or Year"}]},"compensation_already_processed":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Compensation has already been processed on payroll."}]}},"title":"Unprocessable-Entity-Error-Object"},"examples":{"Basic":{"value":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must complete all onboarding requirements in order to run payroll.","metadata":{"key":"needs_onboarding"}}]}},"Resource":{"value":{"errors":[{"error_key":"first_name","category":"invalid_attribute_value","message":"First name is required"},{"error_key":"date_of_birth","category":"invalid_attribute_value","message":"Date of birth is not a valid date"}]}},"Nested":{"value":{"errors":[{"error_key":"contractor_payments","category":"nested_errors","metadata":{"contractor_uuid":"72ae4617-daa9-4ed7-85e0-18ed5d0ee835"},"errors":[{"error_key":"hours","category":"invalid_attribute_value","message":"Ella Fitzgerald is paid fixed wage and hours cannot be set on a contractor payment"}]},{"error_key":"contractor_payments","category":"nested_errors","metadata":{"contractor_uuid":"2d7bf62c-babf-4a12-8292-340e2d9cab28"},"errors":[{"error_key":"wage","category":"invalid_attribute_value","message":"Isaiah Berlin is paid hourly and wage cannot be set on a contractor payment"}]}]}}}}}}}}
\ No newline at end of file
diff --git a/docs/api/delete-v-1-jobs-job-id.api.mdx b/docs/api/delete-v-1-jobs-job-id.api.mdx
new file mode 100644
index 000000000..b95c24878
--- /dev/null
+++ b/docs/api/delete-v-1-jobs-job-id.api.mdx
@@ -0,0 +1,71 @@
+---
+id: delete-v-1-jobs-job-id
+title: "Delete an individual job"
+description: "Deletes a specific job that an employee holds."
+sidebar_label: "Delete an individual job"
+hide_title: true
+hide_table_of_contents: true
+api: eJztXFtvG7mS/iu1vQ9JALVvcS7jp82xnT1ebGaMSbLZA0/QppoliUk32SHZsjWG//uieOmbLrYc+2EHM0AmiEQWPxbrxqqibpLrdFobq1IhLU41s0LJ1C4qTI4uEizHyDnyZJSwquoOMcnXUWLZ1NCw/1JjA0xyOFZlhdK0IzSaSkmDJjm6SQ72DukvjibXoqIxyVHyq4JjJS1Km9yOksPVQyy8V7Xk8IcE+EN+miFo/FGjschBo1G1zhG4QgNSWcBrYewOfGDfEUytEewModJqLjhy+Pz57ASEgTkrBN/5Q7plDw6Wl/0sK61yNIaNC4RTaYVdNAiEgZItYMaqCiVczVC6VcaKL0BNYKFqHTFCrqRlQhpArZU2YOp8BszApZAORMas1WJcW8zmrKjxcgRKO3KRwoSJwgCvEawCJtuZqkJ/Hpc78BH9Ti9O/TLHzOJUaYHm6/OZtZU52t3lKjc77rx3clXuxvNNK7bQqijc97sOZpo301/AtBYcYaI0lEojcLQEiJg3SvJwekc3JCOFyB2e3W+GmHiTmHyGJbsfd/9m7pC5XhETNf6GuU1In37UQiN3yumQkJZVmqBa4dUsfH50E2czrdkiGSXCYtn9fD3V7DvShIBysWYNN6olZ6wWcpqMBgf9scJcTAQaOsigjG46qDyvtdmBT4tK5KwoFmDp6L/jAgRHaf0sGt+c4W7FNCvRIglAwUj/rWpJ7pAyN6i3gEYUaCyJl6cEZGUiqWg9gpTBVKu6EnLqrV7OJIwRauPRjGtRcMhJDsowfsYkL4ScgpBeejuWdAfOJu1CwsCldIYt8+d4OXLg/FnBlSiKKPLAwI+EyzAUwiEt4ErYGaA3Wf5Lx5qS9G2Kd3PmPO43SCOwsapt5+xSmKJE3Z5aIB2ZYWo9YblnCJOAkhN/dEBhGWeWrRLFPozjqNwaC5wzaYHmEc0gIIugycEFCAlOp4UKZiNYpHGBO/BeacBrVlYFjnokHD7Hqkv/d0aoLt3Zxk/qWvBLz/5x60x2klGiJP42SY4u7tpLWRdWVAX6tUiPBooXP15WtvjNFirdX9sIOY0r0zTGuaCvWHHeWcnqGleu7Rlyt9T8ykqnQU5MPEftjHXFJlfahwTcgFVOGjoMvnuFz1L8qLE1D9rZzXY9R9Fb74lWZUvwoqUo66JIvjbj6iqzavPAnp1bNcBYZnHTkNtRYoUtaGcfgvSnX4Sdpb9JTL3zS27Xj/oQZMcPpaO5Hf195n+FMydKax12nw9fyPgoWSx8gAtio9vYgTNLH1fKGEEhllUwY3OExg4VOMfC0NkFNxIdRWNWklzovC6Yfu7hpi74SX9zAvci6e5wxQAv0NdpsLlug2Mmv2csz1UtbcaxQItZLSe15Mizii1KlLYXxFz0Yo1kzAx2A5OjZClYSzpuLnlfSy7k9APameIwYwbiatCs5s6gB2yOWkwWmZBOdHNCWikjHhXZvygMoFUhrEqek24vYwS3vkC+A+cFMoOQzzD/7oMUilgDHGAlTSTXvm4LrNDI+CKLFJ90A8TesCCMEWW7jxUAS2HIQmVa1ZbUZj2wMCKTdTlGvRriIMjvAf3dzwc/n3Qiut2AK0hClis5EVPTQGtiza24tjy7C+adBTpSC0oitMFsWRvbDSxWA4u7nTBjo7ZkhSiF3YBwxeCtWfieEAca4GiAmam64ISZBc42mLMKtVC8xYuSZzxYyzUomyErsa3m5ankFA9iR3PcDcrOmISXUCppZ4Ziwklta40eX67KiklSbl4bqxeZwQJzku5MMpGbLFccszYwW4u4Hb09P3+luUBzV4jj/RCGZZ4eYBRN/FGzgrzIa+BiKhqzswGuiQDMPeAakfux26P9KHKH1SyDPQxgPVYrSszUZJJVqhD5IpOsvOdZlw9iYrnqfIcgauk0CnmjLyzPdc2KTG/Wmd6wLSz3Oz8PaF7DsXFBppwiqwYPOIACzRrgFTrnmoVEyibvOJi6Ddpjr9wcWW7FnCB7Gv6OGzAALQBqMolZnXWYsawKtUA09zn2ZvD2Z38apwLTeH8JGLOCyRyzurrDXq731ptQHTPpMqSMf3PH7lczm499pgrByarTHw84hhUuEH3MqOjYG5MmjHAhBQQE5IHC4a+HJpV9OlhNitlF0quAjaAKIZtGklUlcS3Uxj02YvYkonjmx0AkAXTtMp0chsOn5FgxTWF4HPeY/Is6TAE/NEs1kDyEpc08IoJPLvcojEv2uGupkL0sMCWXBx7NhxUZSsofURBmNcut0hldwjZgG47cXk0bAv6+18Y3Hgt3CuuknGyfx9sqbMT/lHHsYI8r3JyxTLu4nU0sanfXv08UsDxre/6dN3H1sxX0nrVq3KYmXJ4SgqLMUdqwi5havC/+3vifQt6jdCfmOLq90lDJIZtqZQylO+LiEt1lYFOsE0ZsH+6guyM0EUW8FwwguaiFTmSman2fwPBhru6fRL2jORKnzIr5kEFBx3Pyg8Uj2ptzT78DwC/RqMdEqz9RZgHHo1o6yvqE5Zeu5KHoRrmFM2t8Or3F6MMOThUyVljUa9Bmgcrme/tPARcGxkjGrQEcSy0DqC7VKIwLAAPYWpaKi4lwZjtCjtnMxwQbK0bV0mF7AJ6TPZZ7Q2lQz4MVNwtjsWwGRRs+jA2cFTDZROmSbbrt98f/jAHqU2q1WoJLTwacJbsWZV0OcZpaV4z2/IRQT69zRIoiAgY6if29PcfVQqnvdbWJl08ILAZc8Q7gWg6emxc7Sb/21dZ1LgZJ9+b6kAxy5XH9lP6Z7h+8pB32DNq4UPl31I3zd0k3ISdqK+EfUFsZDDuJCIFwLw8oJCjNUZN/0rWM6jHcvl97Gefm/TSHY9DW1dNsivE2NDUP284A5uY9TZBTKTWz7Popt0VxoQvAw3pg2TW49R62x2XY9xBFnxP2TSKPvs2eGEaLFbPQPyGXPdCrN2lqQ7mILVPs99mUoKaWQLzrBO/cQgvJQzb12O1KyaWjaXJ2m0LzpekPSdU1RCASgWbx9g6RrAPceuWfRdsrlw34F1cL1til0Fk+y+xMo5mpgmcYnE/Sqd8NEbhtYYN1e15FvpAIuLTNnImChWIeRfzFHMHl5t8d/xM+RXAQPWOnfqSUcckIcpJfhEY4kyP4oOYInxQ112k4Ya4c2XWYc9RmWzWNc5vrSyQyqB25vBizFsvKXWKtCiEdsLafoybhpJBD1TZVk9R9HwjGa6aYSmaVptQeE8X90npMFA9J6TFRdC+6QwDx3h2zYzNmsubbx8+m+GpuU/Cgw21WA9ceFAA1YqCxpBN3pfOYPGinjHFCxKhPgJgOEq+IaAz0xDXyjAszrrVBV0xq69ZrNtYdvYX2dXILsW61MvrZoHvrSPQxKJtNqK+0x92TDmindW6I58ITb4/v8Qk7ODhIGd97mx4ie5OyvdcsfbP/5vXbt/nL8f6bXzZsOlIrXbX7IbG/L/D5+Y3/9FbjCE4E1cLhxBefR3BMRemdZMiViIL6I+oH3UA8Cj8/mj4fUVNoX/VRPgvRti/xP9uJNqw93E3JGpf7u49UrOk5vmJmKCPJREhhZlnIcpJ3pUYCH3o9QU46MMjf8a0izbbQLj7ICRbKRzGZI31XFGasRrTZ/van+IGER8i8qDlZdE+IbItGY5ZkJvctSj+3hiMypOy7dLZ3vTSNWBuyxFdaySmE2/dwjT9F9QAx9yYZJd21YxbvT1H5outz3JnuwP7By8NXL1ao2ExJfHA/xDnNjt0QUcn393qFUuo4KES+KdOwUnl47TvAcV3psaM6VL6zMzSd9t42WeVLOIML/H0S2Sthbe4j+NR9HtD2ZLjT9+dCvdk+Uo46XqirTnuD6+Xa1NzQ3u0fnE2gJWM331AgujmCx1mg2WTwZD6GNXf7/DDw/u7QrRIC7WilSNHMBk9H37s5D7qBUE8wcnBfwbMw51n7kkAqqFCXwto4ykSvMmZG5E98O2euzS/a7xhtuiBjuyusROSm44fCNXBF/BH5dhWaw9fszn29NcO/UFt4tDNTVxbVIWTVbaPGXuOoltA9YY7eRRLrk+SDnLNHQDl892aJ5RZMXVVKW+AuOCoWwwp/MEdxD74C+uh56EHzQweyX5APqlmb2sWENjZ7WMPLe5oLctD2smStuPMPk2wstJ1tv8qJq6tPwE1vrsbBg7q2CR8AOptzvzJt0wv6kCA+BO9vDhgevt5/k3LGfkkPkb9J377CvXT/LfJXfA/x7ctXG0yaq4Y94FJaFAzeC/vnlFJx3HX8MjLmdF0DUlgnw7NBNcwgxYjuitiUmgMTVlx0HplTB/zNePL6IE/HbDxJD9n+Qfr24JeD9OXhHh7wX3I2Pni7gVMPs0Jnhgk2g3+gLoRs2ER8KRaORVfh9cr9OBRj6vjasTGhd/Rsre/V2tjCGqLRrqR3my5XImkul3Jjf2hv2INvazR7cGMEKsGO4Avid0o1STtzT+/+hWwV6pg0aWzvI1+V4kKbrL3qONTbXgN/77ViurLZfZR0G93/EQMFz7L/zxHD7Sj5veM37trQX8SB3I6SXxsPctee/3Ylf7uSn3Al/r9R0livM5cNdKFbOt9Pv6mxof9l7nrXfxV04kZRl6Txr1lz+KbG/g0W9brFGjQVBuhR8R/S5KrCI7gkqkdXWli8TKieFe69nkvts+3+4ywKrEi1j5IGj5DOaDlNbLPv/mFZHytdtN3z+/Be7JsaO90OFP83/U/3SwTvzs/S/2mqBo78DBl3prBdYMIKs7TCCe2gFDI86SVlTsnCcnh3fhYrB8CMUblw7SMuC+Ge5NIAeoXs3uNKcmGibZIc+TGdB+7PDFyUQrrGgw7tLV+Ds0qkYaaQ038PBNPOxy8IBj0tJou97lSoS6Au6RHawd7Bq3Tvdbr/it6RcpywurCkKO3nt7df6VmWqZB9R2YWqXvN7E/UvJO8/yMO/aF0Uqmao9aCYyOjtP61RWncDBIfr15rf1piFC3qHT8xQcIRSQ3xNjRW4149tY+/JRH2QZwJ2fPO3pxsHyW78/1dWmr3xov+LR0INfIElal1QZIajp9Vwp9+yrF0IrBCdUs14K+nl/pqAH1N21hDeCXNc+0y/+toVvQ17dJgXmuXtbq4iVHFu5winHc17fbia3fUR5I7H9isGNtII0GMUkr/HiPTTmuHr7odidQ9QARW2xllnWJ1fZR8dC1RP7OCp7BmAZdQ9P0wMbxzdofUmEQiFj27OjNKyK6Y3yYfUc9Fjp3zaFXcvZHfdQN3OS1N9jx1/6bipQlTl951YpGr0tV0HY5nBk6DUkBsIyQLw1Vek89w2/i38MsbzOdogwU9iavC7/TrCEGBfb2TBCp8+x+t/BA3KmVsyWSPjo8rJQjJxVxwStKQtR5gv2l//ePRHFE4aYvXdrcqmHAi4VTgJmjiRTKnigRNS0bJUXBEX6nH3lj6+uaGbP5nXdze0sc/aiTffvGV9F27tkAn9ly4cH6NL+nu7fnvwe28gFU+bA3o+JpXLjqWJglPi6P/9I8DvHvbDtRf3NetZKln3epAoeFwa/rJhlS2893SL9T0LP7J6X+ffjpNbm//D59FXos=
+sidebar_class_name: "delete api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Deletes a specific job that an employee holds.
+
+scope: `jobs:write`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/delete-v-1-recurring-reimbursements.ParamsDetails.json b/docs/api/delete-v-1-recurring-reimbursements.ParamsDetails.json
new file mode 100644
index 000000000..322fc00b5
--- /dev/null
+++ b/docs/api/delete-v-1-recurring-reimbursements.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"X-Gusto-API-Version","in":"header","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"},"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."},{"name":"id","in":"path","description":"The UUID of the reimbursement","required":true,"schema":{"type":"string"}}]}
\ No newline at end of file
diff --git a/docs/api/delete-v-1-recurring-reimbursements.RequestSchema.json b/docs/api/delete-v-1-recurring-reimbursements.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/delete-v-1-recurring-reimbursements.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/delete-v-1-recurring-reimbursements.StatusCodes.json b/docs/api/delete-v-1-recurring-reimbursements.StatusCodes.json
new file mode 100644
index 000000000..44a3da152
--- /dev/null
+++ b/docs/api/delete-v-1-recurring-reimbursements.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"204":{"description":"successful"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided ID/UUID is valid.","type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["error_key","category"],"properties":{"error_key":{"type":"string","description":"Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error."},"category":{"type":"string","description":"Specifies the type of error. The category provides error groupings and can be used to build custom error handling in your integration."},"message":{"type":"string","description":"Provides details about the error - generally this message can be surfaced to an end user."}}}}},"x-examples":{"not_found":{"errors":[{"error_key":"request","category":"not_found","message":"The requested resource was not found."}]}},"title":"Not-Found-Error-Object"}}}}}}
\ No newline at end of file
diff --git a/docs/api/delete-v-1-recurring-reimbursements.api.mdx b/docs/api/delete-v-1-recurring-reimbursements.api.mdx
new file mode 100644
index 000000000..ce0a89c87
--- /dev/null
+++ b/docs/api/delete-v-1-recurring-reimbursements.api.mdx
@@ -0,0 +1,71 @@
+---
+id: delete-v-1-recurring-reimbursements
+title: "Delete a recurring reimbursement"
+description: "Delete (soft delete) a recurring reimbursement for an employee."
+sidebar_label: "Delete a recurring reimbursement"
+hide_title: true
+hide_table_of_contents: true
+api: eJzdV99v2zYQ/lc47qEtINlN0e5BTwuWbAiwrUGTbgOcIKXFs8VGIlke6UQQ9L8XR8q21NgtigF7WF5iS3fHj9/9+M4dNxac8MroC8kLLqEGD/nmJHdQBueUXt85UM0yOIQGtEeecQlYOmXJiRf8LLqw52hWniX/F0ywnT+b+LOVcUxoBo2tTQswu9E3GktjoWAfpicVD055+MAz7sUaebHg76ZIbjP+mK8DepMr7WGd7pH71gJZQ7MEKUHyjAtrxybRFQmg8i0vFh3/xTRW6Pa0LAHxNPiKF4vb/jbjVjjRgAeH0U6LBnjB/8l/i8eeXl7kf4FDYiLjiuioQEhwPONYVtAIXnQ8AeLoiQ6ecdChIYCvXr56k7/8KT95Q3gkrESoPS/Gz/unbHtwjdKAzFfApPCQLwWCZKeXF2yTsDCBaEolPEj2oHzFWhNcNChFXc/YxYppo4EpZNaZjZIgs2QjrK1VGUl6hmzRKK2a0Ixj3z6vvLdYzOfSlDiL9M9K08y3dOdWtM7UdXw/F1blg6fS6x+HgPno8QuCERDkjPfZjmElt4Ra4asnRXddAXv//uKMmVXkYVI5POMOPgXlQPLCuwDHk9H3oyJy+CDWWw8HaI1GQHJ69fI1/ZtiwBCrZRVqStPrQyZ/Gs9+NUHTZUqjPYErOj5ief4RybIbITwSgt1oxm70dbztpwBI2XWAJrgSmDSATBvP4FGhn7E/xD0wDA4iPdsss4uzeaRNIduIWskZdVdixCw/QjnlbsHBOeNiu1hHk8KrRMjwfM+ncE60lDIPzfj58ah390AOpfCwNq49cka0OtBDU5KuLJRqpQDZQwXDnaM7M2UZHM7YdWsVFX/LfKWQ3UPLlATtkxfZC++dWgYP813PMwd1bCJv9iGpTPeovwMaRSBbqtkUiVEyt6G2ScIB+dqZYJVeIxNaslJotoTYJ4RmGVQtWUll2wz2ldCypnmrdOrl0cCLmBtAFGv4NuTLLRAJXqgamVia4Eek5mwNGtyeziH0FiUGtxJlQkqzXksCTszRHzUcPIrG1inP2vi7VWySUWEtJvnnQ8WP66UYOY4ux480yINI/REdZry/JSBe+RpSk+WxyfJzOjR/m6p2gAuPHjRG3SBcCdFR5cn4RtTh2wpEw24aKs2fnT/NIRpPDfjK7MWZZ2kkFny+OZkfk+l5p2RPKgRusxWv4GoSqGF8C6vS9M4lNHGEH5D2xnBKF1oQ9yCwzVO8XCU8jYkz+0jggzEvnZFfiWnpdT+S5yuai6lQDoj0rpTp8K3o0vclCBdleHr6ECKvYQM1E8FXNAPSKKYeuWrRQ/NvTkgRjhzQk6atTIw6lF5cJEhgKfHDKjFZATJOio9vV1fgNqqEEdN78Y0dOo+Gc0lH0yDN4/fcrCLD5Pol2L+hLk0D1KcRxzNk50PNsssk41H7pSkDlVW8xg+DmIkyitkg2GfbU9k7GpqxxjMOjVB1LJXh7c/7yiA2rEHfCD2JE9fJowvkl3fo9sL6n6yiqRg8PPq5rYWKVRPrvxvacsE3J1Hvju7PhZKkdpVBT+ZdRwvce1f3PT3+FICm2+KWBoFTYkllsui4VEifJS9Wokb4Cg3P3w1a+4J9a086eJ2tpOt2P4w4z4Zppag/+2y76H4ftP/1+nqEzkTb4Z8MO3b3akDDx/rRuyfb4kQUzs5/P78+J4WZjqvdeBo+UJ4OJrbrksW1uQfd97s8e/oedbL/DFTh+Ws=
+sidebar_class_name: "delete api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Delete (soft delete) a recurring reimbursement for an employee.
+
+scope: `reimbursements:write`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/delete-v-1-webhook-subscription-uuid.ParamsDetails.json b/docs/api/delete-v-1-webhook-subscription-uuid.ParamsDetails.json
new file mode 100644
index 000000000..1b2926457
--- /dev/null
+++ b/docs/api/delete-v-1-webhook-subscription-uuid.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"webhook_subscription_uuid","in":"path","required":true,"schema":{"type":"string"},"description":"The webhook subscription UUID."},{"name":"X-Gusto-API-Version","in":"header","required":false,"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.","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"}}]}
\ No newline at end of file
diff --git a/docs/api/delete-v-1-webhook-subscription-uuid.RequestSchema.json b/docs/api/delete-v-1-webhook-subscription-uuid.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/delete-v-1-webhook-subscription-uuid.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/delete-v-1-webhook-subscription-uuid.StatusCodes.json b/docs/api/delete-v-1-webhook-subscription-uuid.StatusCodes.json
new file mode 100644
index 000000000..9b2fca848
--- /dev/null
+++ b/docs/api/delete-v-1-webhook-subscription-uuid.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"204":{"description":"The resource was deleted successfully."},"404":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided UUID is valid.\n"}}}
\ No newline at end of file
diff --git a/docs/api/delete-v-1-webhook-subscription-uuid.api.mdx b/docs/api/delete-v-1-webhook-subscription-uuid.api.mdx
new file mode 100644
index 000000000..767bbb4c5
--- /dev/null
+++ b/docs/api/delete-v-1-webhook-subscription-uuid.api.mdx
@@ -0,0 +1,76 @@
+---
+id: delete-v-1-webhook-subscription-uuid
+title: "Delete a webhook subscription"
+description: "Deletes the Webhook Subscription associated with the provided UUID."
+sidebar_label: "Delete a webhook subscription"
+hide_title: true
+hide_table_of_contents: true
+api: eJztVk1vGzcQ/Svs9JAYWEq2kfSwh6Bu7bYG2tSI5aaAJCTUcuQlvEtu+CFbFfZX9NJb/2J/QjFcSl5ZUgMDPRU9SVpx3gxn3nuzK3jgt8F5w5X2eGuFV0Zzv2wQ8jFgPUMpUUIGomn6RxxMM7DoGqMdOshXcHr8ij4kusKqhs5ADqMSmUVngi2Q3QvHJFboUTIXigKdm4eqWg6gzeDVvvC3xrPvTNCSTTRjE93BfQroCGMDLA06po1n+KCcH7CfxB0yFywyXyJrrFkoiZLd3FyeM+XYQlRKDiYa2jYD02B3o0sJOXTl8cUJv8dZacwdd2G2qYiHoKgX20WexxgXc73voth1L4oJ50yhBJV8r3y5W9Rgoif6Dfvrz9//YNdL57FmZ7E97Cz4ErVXRSxxot/QuVGpHEMtG6O0Z8Gl3ONvUFi0MYa5osQaH/O5CMsrXGDFRAfuzR1qpnQ88MNodBVDjVW/xWysRCHRTl+W3jcuHw6lKdwgkmVQmHq4JgdvxNKaqor/D1OiLsVRvJkrTIM5+5ha+qHfUpffW+Xx40RDBo2wokaP1kE+XoEWNUIO+8I+pEkoGkAjfAnExk9BWZSQexswg9gCQaTq6AzOW6VviWy7JE1JWD9JNxtos00pv/Lvo1bOri75L2gdxaciumZtlTEXlcNdtni0tdJpaFJ45DPhULKzq0u26EB3KLM0wcYDhaiqAbucM200EpnXRMq6M6JpqsSWF46Na6VVHeo+9jPnKRrFU6TSt18mQN57fERlBIdyAIebngHqUJOnnB6fvubHX/GT12QhEuciVB7y/vO2nWbgsAhW+WWkQqeKThREUsjHUzrkxS1xBZLuois9cNeguEPhlpzmxs0CrVUSN/ruq5Mqe/CoXTQ1ynWHS8gP22IGC1GFz9sj0WYNdaigDda+wuh+NfrSPBpT1AjdHoaLk+FePQ1XB/XS0nzQLtb6CrYi4iY2iEZ1ZOAS68iIPU5XG9hucIfHVVdjbaJaDgDvxbyyRv4DZkN/9+lwHY0tbpxvTd0IveyzYkM7Sr6mI/2eRW/cyZ4g1r645bZkFLu8e26G6y3jfZKgJfOYm4iqfEUw0WBIr0SOZDFb4siADMT9PL9Gu1AF9jr9qGUxM8EP48GhpNS05nj8zc08dphCnxb7HqvC1Mi8YbGOF45dJI6zq84VopVIU4QatY/X+AIyKIz2ovB0kWSV5+us7B1WSRMZYC1UFamS/v36kRnUjcY4Xwu9hUPEZ2KvQz+9wCoWgtr/v5b/xbWcCO/xwQ+bSqiojKjxVbKjMSxOINu7qWnq+eEVPs2gNM4TxGpFe/DGVm1Ljz8FtGT+UzJJq8SM5DFegVSOvh/Yr30GvHyXVvER+8yKP3DH9FDoZc+pIUu2fvhS7bTN1i8Ezyv5P/52sLfLXTf3v1ptmr61DM8vfrwYXdDW3bbkjQWnL9T7vTNcrboTI5Ja225GGqVH42vbvwEE9KhT
+sidebar_class_name: "delete api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Deletes the Webhook Subscription associated with the provided UUID.
+
+> 📘 System Access Authentication
+>
+> This endpoint uses the [Bearer Auth scheme with the system-level access token in the HTTP Authorization header](https://docs.gusto.com/embedded-payroll/docs/system-access).
+
+scope: `webhook_subscriptions:write`
+
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/delete-v-1-work-addresses-work-address-uuid.ParamsDetails.json b/docs/api/delete-v-1-work-addresses-work-address-uuid.ParamsDetails.json
new file mode 100644
index 000000000..a30c71c44
--- /dev/null
+++ b/docs/api/delete-v-1-work-addresses-work-address-uuid.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"work_address_uuid","in":"path","description":"The UUID of the work address","required":true,"schema":{"type":"string"}},{"name":"X-Gusto-API-Version","in":"header","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"},"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."}]}
\ No newline at end of file
diff --git a/docs/api/delete-v-1-work-addresses-work-address-uuid.RequestSchema.json b/docs/api/delete-v-1-work-addresses-work-address-uuid.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/delete-v-1-work-addresses-work-address-uuid.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/delete-v-1-work-addresses-work-address-uuid.StatusCodes.json b/docs/api/delete-v-1-work-addresses-work-address-uuid.StatusCodes.json
new file mode 100644
index 000000000..6f53cdd9d
--- /dev/null
+++ b/docs/api/delete-v-1-work-addresses-work-address-uuid.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"204":{"description":"no content"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided ID/UUID is valid.","type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["error_key","category"],"properties":{"error_key":{"type":"string","description":"Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error."},"category":{"type":"string","description":"Specifies the type of error. The category provides error groupings and can be used to build custom error handling in your integration."},"message":{"type":"string","description":"Provides details about the error - generally this message can be surfaced to an end user."}}}}},"x-examples":{"not_found":{"errors":[{"error_key":"request","category":"not_found","message":"The requested resource was not found."}]}},"title":"Not-Found-Error-Object"}}}},"422":{"description":"unprocessable entity","content":{"application/json":{"schema":{"description":"Unprocessable Entity\n \nThis 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.\n","type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["error_key","category"],"properties":{"error_key":{"type":"string","description":"Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error."},"category":{"type":"string","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."},"message":{"type":"string","description":"Provides details about the error - generally this message can be surfaced to an end user."},"metadata":{"type":"object","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.","oneOf":[{"type":"object","description":"multiple entities","required":["entities"],"properties":{"entities":{"type":"array","items":{"type":"object","description":"single entity","additionalProperties":true,"properties":{"entity_type":{"type":"string","description":"Name of the entity that the error corresponds to."},"entity_uuid":{"type":"string","description":"Unique identifier for the entity."},"valid_from":{"type":["string","null"]},"valid_up_to":{"type":["string","null"]},"key":{"type":["string","null"]},"state":{"type":["string","null"]}},"title":"Metadata-With-One-Entity"}}},"title":"Metadata-With-Multiple-Entities"},{"type":"object","description":"single entity","additionalProperties":true,"properties":{"entity_type":{"type":"string","description":"Name of the entity that the error corresponds to."},"entity_uuid":{"type":"string","description":"Unique identifier for the entity."},"valid_from":{"type":["string","null"]},"valid_up_to":{"type":["string","null"]},"key":{"type":["string","null"]},"state":{"type":["string","null"]}},"title":"Metadata-With-One-Entity"}]},"errors":{"type":"array","description":"Will only exist if category is `nested_errors`. It is possible to have multiple levels of nested errors.","items":"circular(Entity-Error-Object)"}},"title":"Entity-Error-Object"}}},"x-examples":{"bank_account_delete_unfunded_payments":{"errors":[{"error_key":"base","category":"invalid_operation","message":"FundingMethod has unfunded payments"}]},"bank_account_verify_incorrect_deposits":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Your bank account cannot be verified. Please check the test deposit amounts."}]},"bank_account_verify_already_verified":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Your bank account has already been verified."}]},"bank_account_missing_routing":{"errors":[{"error_key":"routing_number","category":"invalid_attribute_value","message":"Routing number is required."}]},"payment_configs_missing_parameter":{"errors":[{"error_key":"base","category":"missing_parameter","message":"At least one parameter must be provided"}]},"payment_configs_invalid_fast_payment_limit":{"errors":[{"error_key":"fast_payment_limit","category":"invalid_attribute_value","message":"Fast payment limit should be a number"}]},"pay_periods_invalid_end_date":{"errors":[{"error_key":"end_date","category":"invalid_parameter","message":"End date cannot be more than 3 months in future"}]},"company_industry_selection_naics_code_required":{"errors":[{"error_key":"naics_code","category":"invalid_attribute_value","message":"Naics code is required."}]},"company_industry_selection_naics_code_invalid":{"errors":[{"error_key":"naics_code","category":"invalid_attribute_value","message":"Naics code must be equal to 6 digits."}]},"company_industry_selection_sics_codes_invalid":{"errors":[{"error_key":"sic_codes","category":"invalid_attribute_value","message":"Sic codes must be equal to 4 digits"}]},"time_off_policy_name_required":{"errors":[{"error_key":"name","category":"invalid_attribute_value","message":"Name is required."}]},"time_off_policy_unlimited_invalid_accrual_rate":{"errors":[{"error_key":"accrual_rate","category":"invalid_operation","message":"Accrual rate must be blank for unlimited policies."}]},"time_off_policy_pending_requests":{"errors":[{"error_key":"time_off_policy","category":"invalid_operation","message":"Cannot deactivate policy with pending time off requests."}]},"time_off_policy_employees_required":{"errors":[{"error_key":"employees","category":"invalid_attribute_value","message":"Employees are required."}]},"time_off_policy_unlimited_balance_update":{"errors":[{"error_key":"base","category":"invalid_attribute_value","message":"Can not adjust balances for unlimited policies."}]},"holiday_pay_policy_already_exists":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Company already has a holiday pay policy."}]},"holiday_pay_policy_not_exists":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Company does not have a holiday pay policy, please create one"}]},"holiday_pay_policy_invalid_employees":{"errors":[{"error_key":"employees","category":"invalid_attribute_value","message":"Invalid employee uuids provided."}]},"onboarded_employee":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Cannot delete onboarded employee"}]},"invalid_attribute":{"errors":[{"error_key":"base","category":"invalid_operation","message":"There is an error in the request body."}]},"company_cannot_enable_contractor_only":{"errors":[{"error_key":"contractor_only","category":"invalid_attribute_value","message":"Contractor only cannot be enabled for existing companies."}]},"company_missing_parameter":{"errors":[{"error_key":"base","category":"missing_parameter","message":"contractor_only is required."}]},"starting_after_uuid_invalid":{"errors":[{"error_key":"starting_after_uuid","category":"invalid_attribute_value","message":"Parameter 'starting_after_uuid' does not correspond to a valid event."}]},"resource_uuid_invalid":{"errors":[{"error_key":"resource_uuid","category":"invalid_attribute_value","message":"Parameter 'resource_uuid' does not correspond to a valid resource."}]},"payroll_gross_up_invalid_net_pay":{"errors":[{"error_key":"net_pay","category":"invalid_attribute_value","message":"Net pay must be a number."}]},"payroll_accruing_hours_invalid":{"errors":[{"error_key":"base","category":"invalid_attribute_value","message":"Hours cannot be negative."}]},"payroll_cannot_cancel":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Payroll cannot be canceled."}]},"frozen_payroll":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This payroll has already been processed. Its data cannot be updated or altered."}]},"frozen_payroll_processing":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This payroll is being processed and cannot be updated at this time."}]},"unmodifiable_payroll_type":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This type of payroll cannot be modified or processed. It is reserved for system processes."}]},"invalid_employee_uuids_format":{"errors":[{"error_key":"employee_uuids","category":"invalid_attribute_value","message":"Parameter employee_uuids must be an array."}]},"maximum_employee_uuids_surpassed":{"errors":[{"error_key":"employee_uuids","category":"invalid_attribute_value","message":"Exceeded maximum of 100 for lookup."}]},"invalid_employee_uuid":{"errors":[{"error_key":"employee_uuids","category":"invalid_attribute_value","message":"Invalid Employee UUID(s).","metadata":{"entities":[{"entity_type":"Employee","entity_uuid":"invalid-uuid-123"}]}}]},"payroll_blocker_missing_bank_info":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must have a bank account in order to run payroll.","metadata":{"key":"missing_bank_info"}}]},"payroll_blocker_missing_employee_setup":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must add employees in order to run payroll.","metadata":{"key":"missing_employee_setup"}}]},"payroll_blocker_missing_federal_tax_setup":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must complete federal tax setup in order to run payroll.","metadata":{"key":"missing_federal_tax_setup"}}]},"payroll_blocker_missing_bank_verification":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company bank account must be verified in order to run payroll.","metadata":{"key":"missing_bank_verification"}}]},"payroll_blocker_suspended":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company is suspended and cannot run payroll.","metadata":{"key":"suspended"}}]},"submission_blocker_missing_selection":{"errors":[{"error_key":"submission_blockers","category":"invalid_attribute_value","message":"Submission blockers selections required"}]},"submission_blocker_invalid_option":{"errors":[{"error_key":"submission_blockers","category":"nested_errors","metadata":{"blocker_type":"fast_ach_threshold_exceeded"},"errors":[{"error_key":"selected_option","category":"invalid_attribute_value","message":"Selection is not available to resolve Fast ACH Threshold Exceeded. Please choose one of Wire In, Move To Four Day"}]}]},"invalid_version":{"errors":[{"error_key":"base","category":"invalid_resource_version","message":"You are attempting to update a resource using an out-of-date version."}]},"signatory_email_required":{"errors":[{"error_key":"email","category":"invalid_attribute_value","message":"Email is required"}]},"signatory_company_already_has_signatory":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Cannot have more than one signatory in a company. Please remove the existing signatory before adding a new one."}]},"mixed_disbursement_errors":{"errors":[{"error_key":"disbursements","category":"nested_errors","metadata":{"contractor_payment_uuid":"invalid-uuid-1"},"errors":[{"error_key":"contractor_payment_uuid","category":"not_found","message":"Disbursement not found."}]},{"error_key":"disbursements","category":"nested_errors","metadata":{"contractor_payment_uuid":"d0dfa222-ad08-4ea7-a06a-717688c3b179"},"errors":[{"error_key":"payment_method","category":"invalid_attribute_value","message":"Payment method must be one of: Direct Deposit, Check."},{"error_key":"payment_status","category":"invalid_attribute_value","message":"Payment status is not valid for payment method 'InvalidMethod'."}]}]},"not_found":{"errors":[{"error_key":"request","category":"not_found","message":"The requested resource was not found."}]},"finish_onboarding_incomplete":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Company is not ready to exit onboarding."}]},"company_location_validation":{"errors":[{"error_key":"street_1","category":"invalid_attribute_value","message":"Must include a street address"},{"error_key":"city","category":"invalid_attribute_value","message":"Must include a city"},{"error_key":"state","category":"invalid_attribute_value","message":"State is in the wrong format"},{"error_key":"zip","category":"invalid_attribute_value","message":"Please enter a valid zip code (e.g. 12345)."},{"error_key":"phone_number","category":"invalid_attribute_value","message":"Phone number must be 10 digits"}]},"conflict":{"errors":[{"error_key":"request","category":"duplicate_operation","message":"A resource with these attributes already exists."}]},"invalid_parameter":{"errors":[{"error_key":"request","category":"invalid_parameter","message":"The provided parameter is invalid or missing."}]},"flow_invalid_entity":{"errors":[{"error_key":"entity_type","category":"invalid_attribute_value","message":"Invalid flow entity"},{"error_key":"entity_uuid","category":"invalid_attribute_value","message":"Invalid flow entity"}]},"flow_nested_options_errors":{"errors":[{"error_key":"options","category":"nested_errors","metadata":{"flow_type":"company_forms"},"errors":[{"error_key":"form_types","category":"invalid_attribute_value","message":"Supplied value 'invalid' contains no permitted values"}]}]},"basic":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must complete all onboarding requirements in order to run payroll.","metadata":{"key":"needs_onboarding"}}]},"contractor_payment_invalid_wage":{"errors":[{"error_key":"wage","category":"invalid_attribute_value","message":"Wage must be greater than or equal to 0."}]},"contractor_payment_cannot_cancel":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Payment has already been processed and cannot be cancelled. Contact support directly."}]},"time_off_request_cannot_delete":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This time off request cannot be deleted."}]},"resource":{"errors":[{"error_key":"first_name","category":"invalid_attribute_value","message":"First name is required"},{"error_key":"date_of_birth","category":"invalid_attribute_value","message":"Date of birth is not a valid date"}]},"nested":{"errors":[{"error_key":"contractor_payments","category":"nested_errors","metadata":{"contractor_uuid":"72ae4617-daa9-4ed7-85e0-18ed5d0ee835"},"errors":[{"error_key":"hours","category":"invalid_attribute_value","message":"Ella Fitzgerald is paid fixed wage and hours cannot be set on a contractor payment"}]},{"error_key":"contractor_payments","category":"nested_errors","metadata":{"contractor_uuid":"2d7bf62c-babf-4a12-8292-340e2d9cab28"},"errors":[{"error_key":"wage","category":"invalid_attribute_value","message":"Isaiah Berlin is paid hourly and wage cannot be set on a contractor payment"}]}]},"compensation_invalid_rate":{"errors":[{"error_key":"rate","category":"invalid_attribute_value","message":"Rate is not a valid number"}]},"compensation_invalid_payment_unit":{"errors":[{"error_key":"payment_unit","category":"invalid_attribute_value","message":"Payment unit must be one of Hour, Week, Month, or Year"}]},"compensation_already_processed":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Compensation has already been processed on payroll."}]}},"title":"Unprocessable-Entity-Error-Object"}}}}}}
\ No newline at end of file
diff --git a/docs/api/delete-v-1-work-addresses-work-address-uuid.api.mdx b/docs/api/delete-v-1-work-addresses-work-address-uuid.api.mdx
new file mode 100644
index 000000000..59aaeba5e
--- /dev/null
+++ b/docs/api/delete-v-1-work-addresses-work-address-uuid.api.mdx
@@ -0,0 +1,71 @@
+---
+id: delete-v-1-work-addresses-work-address-uuid
+title: "Delete an employee's work address"
+description: "Used for deleting an employee's work address. Cannot delete the employee's active work address."
+sidebar_label: "Delete an employee's work address"
+hide_title: true
+hide_table_of_contents: true
+api: eJztXOtvGzmS/1e4fR+cAGr5Eecx+rS+2Lk1sJkxJslmF07QpprVEsfdZA/Jlq0x/L8fio9+qSVbio3dvdsBBjNWk8Ufi1XFYlWRd5EsQVHDpThn0SRikIOBeHEY30h1nVDGFGgNuvNnUlWcRaOIgU4VL7FzNIm+aGAkk4pYGlzMCBUEijKXS4A9TZAC8RTG5D0VQhrXFoiZQ7spTQ1fQLfHN/FN6FSWMCFXoameFFTQGVxFo8jQmY4ml9GZ/0ZOAvbo+yi6jWeVNjLmwsDMzTc2yxKwBxRTYAxwRrQs201sVw1ppbhZRpPLu+i9LEoqlidpClqfVGYeTS6/338fRSVVtAADStt2ghYQTaIhrnFkVknNfIWDn+dAvnw5PyUysxxpzz8aRQp+r7gCFk2MqmAU6XQOBY0md5GbSaSN4mIW3d+PagB/j//Hzvvk4jz+GyiNA3kIc6AMVLSezigCURXIoaODo9fxwZv48DUyhEFGq9xEk/bv9/3JnCIzCi5A27kwaiCeUpSRk4tzsnBYCNVappwaYOSGmzlZykrZBinN8zE5z4iQAgjXpFRywRmwkWtDyzLnqV2lPU0uCy54URVt2t9fzI0p9WR/n8lUj+36j1NZ7If1jku6VDLP7fd9WvLY9+Ri9l+eYNz6+SXCqDSwcXTfEimlb+gsrIkCXUqBQje5i44OjvE/Xb4ISVIpDAiDPDseavKzNOSDrARKS2g7uYtaU97/TWPLu9barSFBvglCvgkULZQf0MhqBVpWKgXCJGiCegi3XJsx+UivgehKOY0MLCfnp/tWLrkmC5pzNkZ9c7Iip79BajrSeRmBUlJZ5SkV2hfDHUP8742kUaXoEgXSQNH+fT3V5BqwQ0oNzKRarhnDthoQ6C6TPpWQ8oyDJjdz8HO23YlM00rpMfm8LDlK4pKYOdfkGpaEMxDG9cL21BjFp5WB/doCEAW5lWgjG5JjXO0a9RbQkAK2RaPgKBFczEAqLJL2yGdKViUXM02oYCSlgkzBCi2imVY8ZyRFsS18+zkVLEdjzYVTrJb5s5gL0JrO4GHIFwEIA0N5rgmdysq0mBqTGQhQDTs96YBSVyqjqUOKW4dgCBw5h/+gwsEtLcrcrbOQJsmskrQE67Kz/pGX+La8TFodW5OL1ijIDXX6YTug3iMQw00OTsliq2TxGQ4a/+Kk1qE9PjpaVctKlEri1kGnORAUJLPcXcm/dKidWWpB3ZG9dEnmtCxBoHwLuxJTyZYoSXap/XytPaJceBHSRFfpnFBNrriw6p7UQp4saF7B1YhIZckFCpldcFaBX7u6Z+1dXI3JJ3Aqdnnmhnnv1oSD3tJUW5hxWnd/SWYVZ2Cdj0IqCBI4/ib+Y6j+XxgqdBTqgbgmV8LqceLW8Wpkwbm1Ijc8z4PIE0pcS3LlmxK/SEvnjzgV9YrxL2MPEYWhjBo6JIpdGO+DcivIYUGFQVeMIk0vIEuvyd7icUGsTqN3Zs2Gt0jTHMbkg1TEG+FRh4TFZ1l15f6bIKoru7bhF/R/rxz7p41zgb6EFPBLZq335rkUVW54GSwn6lFP8cLPq8oWvmyh0t2xNRezts2mjHH8RPOL1kjOCxwY2zHkYan5mRYQ/H/PUTOnbbFJpXJeJtPESCsNLQY/PMIXwX+voDEPytrNZjxL0VnvTMmiIXjZUBRVnkff63ZVmRi5uWHHzg010IYa2NSktfF+9NIff+VmHv8iIHabX3S/vtVHLzuuKS4NHpP+s+b//muOlNZu2F0+fEXjI0W+dAcewjduG2NybuzRU2rN0cUykszpAkhth3JYQK5x7fw2EjaK2qxEKVdplVP1wsHtuIovo/YMBxpEA47vlIrrhKaprIRJXPwkqURWCQYsKemyAGH0BqcYD+Fdj3jFWet4xh8qwbiYfQQzl4zMqSZhNFKPZtegA2wBimfLhAsruikiLaXmT4rsH+gG4KjEj4o7J3rrUyB2fA5sTC5yoBpIOof02jkp6LF6OIQW2FGP10+B5gooWyaB4rNOANnrByRTANHMYwBgwTVaqETJCuNtmw5CrkUiqmJqYz4DEHtOfgfor64/cf1RJ8K263F5SUhSKTI+0zW02tfcimurvdtgTgzBJTUEI0ONM1tU2rQdi2FgYbYZ1SZoS5LzgpsNCAcab83CD4jY0yCWBtFzWeUMMVPP2RpzUoLikjV4QbCEeWu5BmXdZBDbMC/PBLOhuZbm2BOUmVNBXpFCCjPX6BNmlakUOHypC4ImXLBKG7VMNOSQonQngvJUJ6lkkDSO2VrETevt+fkz9iXYd0AcH4fQD/P8AINowu8VzXEXeUMYn/Ha7GyAqwMA/Qi4mqeu7fZoP/HUYtWrYI89WIfV8AISmWVJKXOeLhMMND9urYudmFgMrW8fRCWsRgGr9YWmqaponqjNOtNptoXlPnH9CParOTbN0ZSjZ1XjIRYgB70GeAl2c018IGXT7tjrug3aOtliEysI2dFwZ1yPgeAARGZZiOqsw1xnXx6z7HXj7dc+ZHI0oQoeLwFTmlORQlKVD9jL9bv1JlTvqbARQcp+s8vuRtObl30uc87QquO/DnBwK6wj+pRekU9R1W6EdSmIR4A7kF/89dAwQvpssOqUg/Wkh4CNSOldNgUoq1LAWqj19liL2bOI4rlrU+coCR67dCuGYfFJMZVUoRse2j0l/zoJ03qoGpKDsDKZJ0Tw2cYeubbBHnss5aITBcbgcm9Hc25FAgLjR+iEGUVTI1WCh7AN2Pott1fTmoA77zX+jcPiUtVWytH2ObyNwgb8z+nH9uY4sM1pQ5X122lmQNmz/mO8gNVe2/Pvovar9wbo7TVq3IQmbJySeEVZgDB+FiG0+Fj8nfY/hLxD6UHMoXVzpMGUQzJTEpP3ZW1rBNjDwCZfx7fY3t0Be0aoPYpwLuhBsl4LrshcVuoxjuFuW91fkHpLcwTMKBZm9NB4HU9xH8yf0N5cOPotAG6IWj0yJf8AkXgcT2rpMOrjh185kvukG8YWzo124fQGo3M7GGbIaG5ArUGbeCqbz+0/BJxrMgU0bjXgkGrpQbWhRq6tA+jBVqKQjGfcmu0AOUQznxJsyBiVK4vtADhOdljuDKUGtfBWXC+1gaJuFGx43zewVkAnmVQF3XTa77b/EQPUpdRotSA2POlxFvQWS036OHWlSopzfkaoZ7cpAHoRHgOuxOHBgeVqLuV1VW7i5TMCCw5XXc2F9Scv9Mtx1M19NXmdy17QvT4+RL1YeRg/xj/jw6NXNqvfNmjTXKbXoOrN3wbduMjkVsLfozboDFuJ8I5wJw7IBZGKgcL9SVUiqEd/+m7sVZyb51MvjgZTlc8zKcoa11TvNp0ezM1zyoBhKjUx9PY5p4V+oXXA/XjE0Ftix9ttjquwHyGKLibsikSefJodMQwWK0Shf0AuO6CHJ6krjbGILUPsj5kUx6IWT7y9CT44hQaSg6yrqZ2VFCtLU8fsNrnmK913CdXVREggQurBmzNEtA5wsyv/KNpOuqzHvzCat8Y2hE7TeWLmCvRc5iwBv/lErfxdH4GdFtRYt+dV4AuKgA3bLCjPqU/mocefL4DY2PzJ+7+QzwEcCTtjK38kpbbBCNwkv3IF5FyMyEe5APJZYrGlIqfUpiPbG6avHd3JbaqPL4u6creTO7JxMWoMFKU9xBrpXTpCm3qOSvtSbFmZWGax/e4JhmMmnwlqpMLQHuX548J6lOe7hPQoz9sH3T6AcO4O0bE51Un99emjKS6bWyc8cHHr0YgtD/KAajFQUOCK29R5CB40XaaQITGsE0CmEwE3SDQ4evwWWMK4nlZKg00mNXnrNRNrt95C+1qxhZC3GvR+NujeOhKPKKY8bYHulU+Onnl67IBl9OjoKKbs4F18DPRtTA/e0Pjt4ds3796lr6aHb3/aMOlArbDZ7l18f5fgc/3r/dNZjQk55ZgLJ6cu+Twi7zEpPY76XAkosD6i2ukE4lC4/sH0OY8aXfuyi3LPe9suxb83Djbsn1ViO4oyLrieJz7KibsrFhI41+sZYtKeQe6MbyRqtiHN4L2YYC6dF5NY0g95YdooAJMcbr+KH1F4uEjziqFFd4Tq+yB9mUl9KfEPjWGJ9Cm7Kp3tt17shqz1UeIbJcWM+NN3f4w/eLmDmDuTDALP2iGK9wcvXdL1BYxnY3J49Or49csBFZtLATvXQ1xg71ANEZT88KCTKMWKg5ynmyINg8rDKlcBDutSjy3VwfSdmYNulfc2wSqXwukd4B8TyB6EtbmO4HP7ukhTk2FX360L1mY7TznoeC5vWuUNtpZrU3FDc7bfOZqAQ4Zqvr5AtGMETzNAPUm/kzkfVj+85/uGj98O7Sje0Q5WChVNb9jp8Lvts9MJBGuCgRH7iez5PnvNTQIhSYnXv4wJrXTYVaZU8/SZT+fUlvkF+x28TetkbHeEFQBMt/Yhfwwc8D8C3258cfia2dnPWzP8K5aFBzszs2lR5V1W1RRqHNQb1Qq6Z4zRW09ifZC8F3N2CDCGT2xlemqIrspSKkOYdY7yZT/D781RmIPLgD55HLpX/NCC7AZkvWzWpnIxrrRJdit4+YB9ieiVvaxYK2b3hyyZcmUvkm45yqnNq2fEdq+Pxn4HtWUTzgG0Nudxadq6FnQXJ94772+PKBy/OXwbM0p/io+BvY3fvYaD+PAdsNfsAODdq9cbTJrNhu1wKM1zSj5w88cMQ3HMVvxSNOZ4XCOosFaG571smAb0Ee0RsU41eyYMHHSemFNH7O00e3OUxlM6zeJjengUvzv66Sh+dXwAR+ynlE6P3m3g1G5W6FxTTufkv0HlXNRsQr7kS8uiG3975XEcCj41CO386TrusbluZ32t1sYSVu+NtiW9XXQ5iKQ+XIqN9aGdZjuf1rB378RIMAU7Il8BrjHUJMzcXr37B9Ah1CFoUtveJz4qhYE2WXvZ2lC7tyU7txXjNcXurtxdl0CvgeplbG+JtfJJzaX+bjs0mLFcgFKcQf2OwVeprk/q+/Nwa0Bo61khNxwf1j4MYO85VA8/EICK3iXlLoTX/fF6SLtRf3J1w4FJDvfrTrbpvzppvKfuQxnhczRyjw9Mov3F4X73lYf9u5UHC+7xgQBMtXoZqlSOltZf16Qld7c1YwaFvbK5cuXiFArZWyxHL3bxGvyM01xDeJDmhbKxmXU0S/x833q64RNeoHW1YQMPONR3RnDw8B4C/j0Fqqy72b9RZ0nE9vIHoZWZo8cfMhuj6JNNR//ICI7CmgHsYc7lIoNq2Tce8O0DFIYQcG6/zjCK8DEG/Uv2CdSCp9DidHPZ1t5P3LcN9xkOjZYgtn9j4Fj7rit3aiBPZWHj6RbHniZnXmFIKOHAZxmYTCu0c3Yaf/K3nqk7H/vXKk7DqORXvJnqD0Eu1oyi4r/+uZEM5EYptSmo6NBxp4C174/0J3HXXMH+p79j4iTFwK3ZL3PKrUhZ5bjzinsZLTCa1FXdaBRNVl8b+Y5Fk9pgn7s7NPlfVH5/jz//XgFa/cvvaD6UrfOw+s24tc8smmQ017CBTy9+9c7pS/LAwyWDUwr3tMSyZcEif2ls4OEUVwHq3izZDuj/6ZdI1nDXcXH49Zea2c3ugsaqNK1vK88QdHaS07O/nn0+w+2wa95qc+b/p3Wjt7vOd3euxWd5DeL+vl52g39bv+H+fwGlMzmE
+sidebar_class_name: "delete api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Used for deleting an employee's work address. Cannot delete the employee's active work address.
+
+scope: `employees:manage`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/departments.tag.mdx b/docs/api/departments.tag.mdx
new file mode 100644
index 000000000..ee86c113a
--- /dev/null
+++ b/docs/api/departments.tag.mdx
@@ -0,0 +1,20 @@
+---
+id: departments
+title: "Departments"
+description: "Departments"
+custom_edit_url: null
+---
+
+
+
+
+
+
+
+```mdx-code-block
+import DocCardList from '@theme/DocCardList';
+import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
+
+
+```
+
\ No newline at end of file
diff --git a/docs/api/earning-types.tag.mdx b/docs/api/earning-types.tag.mdx
new file mode 100644
index 000000000..148b87c39
--- /dev/null
+++ b/docs/api/earning-types.tag.mdx
@@ -0,0 +1,20 @@
+---
+id: earning-types
+title: "Earning Types"
+description: "Earning Types"
+custom_edit_url: null
+---
+
+
+
+
+
+
+
+```mdx-code-block
+import DocCardList from '@theme/DocCardList';
+import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
+
+
+```
+
\ No newline at end of file
diff --git a/docs/api/employee-addresses.tag.mdx b/docs/api/employee-addresses.tag.mdx
new file mode 100644
index 000000000..100e85fc8
--- /dev/null
+++ b/docs/api/employee-addresses.tag.mdx
@@ -0,0 +1,20 @@
+---
+id: employee-addresses
+title: "Employee Addresses"
+description: "Employee Addresses"
+custom_edit_url: null
+---
+
+
+
+
+
+
+
+```mdx-code-block
+import DocCardList from '@theme/DocCardList';
+import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
+
+
+```
+
\ No newline at end of file
diff --git a/docs/api/employee-benefits.tag.mdx b/docs/api/employee-benefits.tag.mdx
new file mode 100644
index 000000000..4411b819d
--- /dev/null
+++ b/docs/api/employee-benefits.tag.mdx
@@ -0,0 +1,20 @@
+---
+id: employee-benefits
+title: "Employee Benefits"
+description: "Employee Benefits"
+custom_edit_url: null
+---
+
+
+
+
+
+
+
+```mdx-code-block
+import DocCardList from '@theme/DocCardList';
+import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
+
+
+```
+
\ No newline at end of file
diff --git a/docs/api/employee-employments.tag.mdx b/docs/api/employee-employments.tag.mdx
new file mode 100644
index 000000000..b72ce71ed
--- /dev/null
+++ b/docs/api/employee-employments.tag.mdx
@@ -0,0 +1,20 @@
+---
+id: employee-employments
+title: "Employee Employments"
+description: "Employee Employments"
+custom_edit_url: null
+---
+
+
+
+
+
+
+
+```mdx-code-block
+import DocCardList from '@theme/DocCardList';
+import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
+
+
+```
+
\ No newline at end of file
diff --git a/docs/api/employee-forms.tag.mdx b/docs/api/employee-forms.tag.mdx
new file mode 100644
index 000000000..14a2f2eb1
--- /dev/null
+++ b/docs/api/employee-forms.tag.mdx
@@ -0,0 +1,20 @@
+---
+id: employee-forms
+title: "Employee Forms"
+description: "Employee Forms"
+custom_edit_url: null
+---
+
+
+
+
+
+
+
+```mdx-code-block
+import DocCardList from '@theme/DocCardList';
+import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
+
+
+```
+
\ No newline at end of file
diff --git a/docs/api/employee-payment-method.tag.mdx b/docs/api/employee-payment-method.tag.mdx
new file mode 100644
index 000000000..18f9cd2ed
--- /dev/null
+++ b/docs/api/employee-payment-method.tag.mdx
@@ -0,0 +1,20 @@
+---
+id: employee-payment-method
+title: "Employee Payment Method"
+description: "Employee Payment Method"
+custom_edit_url: null
+---
+
+
+
+
+
+
+
+```mdx-code-block
+import DocCardList from '@theme/DocCardList';
+import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
+
+
+```
+
\ No newline at end of file
diff --git a/docs/api/employee-tax-setup.tag.mdx b/docs/api/employee-tax-setup.tag.mdx
new file mode 100644
index 000000000..9d3692acd
--- /dev/null
+++ b/docs/api/employee-tax-setup.tag.mdx
@@ -0,0 +1,20 @@
+---
+id: employee-tax-setup
+title: "Employee Tax Setup"
+description: "Employee Tax Setup"
+custom_edit_url: null
+---
+
+
+
+
+
+
+
+```mdx-code-block
+import DocCardList from '@theme/DocCardList';
+import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
+
+
+```
+
\ No newline at end of file
diff --git a/docs/api/employees.tag.mdx b/docs/api/employees.tag.mdx
new file mode 100644
index 000000000..0fbbb0925
--- /dev/null
+++ b/docs/api/employees.tag.mdx
@@ -0,0 +1,20 @@
+---
+id: employees
+title: "Employees"
+description: "Employees"
+custom_edit_url: null
+---
+
+
+
+
+
+
+
+```mdx-code-block
+import DocCardList from '@theme/DocCardList';
+import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
+
+
+```
+
\ No newline at end of file
diff --git a/docs/api/events.tag.mdx b/docs/api/events.tag.mdx
new file mode 100644
index 000000000..f555efc42
--- /dev/null
+++ b/docs/api/events.tag.mdx
@@ -0,0 +1,20 @@
+---
+id: events
+title: "Events"
+description: "Events"
+custom_edit_url: null
+---
+
+
+
+
+
+
+
+```mdx-code-block
+import DocCardList from '@theme/DocCardList';
+import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
+
+
+```
+
\ No newline at end of file
diff --git a/docs/api/external-payrolls.tag.mdx b/docs/api/external-payrolls.tag.mdx
new file mode 100644
index 000000000..d2d0d42f1
--- /dev/null
+++ b/docs/api/external-payrolls.tag.mdx
@@ -0,0 +1,20 @@
+---
+id: external-payrolls
+title: "External Payrolls"
+description: "External Payrolls"
+custom_edit_url: null
+---
+
+
+
+
+
+
+
+```mdx-code-block
+import DocCardList from '@theme/DocCardList';
+import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
+
+
+```
+
\ No newline at end of file
diff --git a/docs/api/federal-tax-details.tag.mdx b/docs/api/federal-tax-details.tag.mdx
new file mode 100644
index 000000000..302ab38c3
--- /dev/null
+++ b/docs/api/federal-tax-details.tag.mdx
@@ -0,0 +1,20 @@
+---
+id: federal-tax-details
+title: "Federal Tax Details"
+description: "Federal Tax Details"
+custom_edit_url: null
+---
+
+
+
+
+
+
+
+```mdx-code-block
+import DocCardList from '@theme/DocCardList';
+import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
+
+
+```
+
\ No newline at end of file
diff --git a/docs/api/flows.tag.mdx b/docs/api/flows.tag.mdx
new file mode 100644
index 000000000..81ada27b7
--- /dev/null
+++ b/docs/api/flows.tag.mdx
@@ -0,0 +1,20 @@
+---
+id: flows
+title: "Flows"
+description: "Flows"
+custom_edit_url: null
+---
+
+
+
+
+
+
+
+```mdx-code-block
+import DocCardList from '@theme/DocCardList';
+import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
+
+
+```
+
\ No newline at end of file
diff --git a/docs/api/garnishments.tag.mdx b/docs/api/garnishments.tag.mdx
new file mode 100644
index 000000000..643be1984
--- /dev/null
+++ b/docs/api/garnishments.tag.mdx
@@ -0,0 +1,20 @@
+---
+id: garnishments
+title: "Garnishments"
+description: "Garnishments"
+custom_edit_url: null
+---
+
+
+
+
+
+
+
+```mdx-code-block
+import DocCardList from '@theme/DocCardList';
+import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
+
+
+```
+
\ No newline at end of file
diff --git a/docs/api/generated-documents.tag.mdx b/docs/api/generated-documents.tag.mdx
new file mode 100644
index 000000000..a1183656d
--- /dev/null
+++ b/docs/api/generated-documents.tag.mdx
@@ -0,0 +1,20 @@
+---
+id: generated-documents
+title: "Generated Documents"
+description: "Generated Documents"
+custom_edit_url: null
+---
+
+
+
+
+
+
+
+```mdx-code-block
+import DocCardList from '@theme/DocCardList';
+import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
+
+
+```
+
\ No newline at end of file
diff --git a/docs/api/get-ach-transactions.ParamsDetails.json b/docs/api/get-ach-transactions.ParamsDetails.json
new file mode 100644
index 000000000..3e55a4ebc
--- /dev/null
+++ b/docs/api/get-ach-transactions.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"company_uuid","in":"path","required":true,"schema":{"type":"string"},"description":"The UUID of the company"},{"name":"contractor_payment_uuid","in":"query","required":false,"schema":{"type":"string"},"description":"The UUID of the contractor payment"},{"name":"payroll_uuid","in":"query","required":false,"schema":{"type":"string"},"description":"The UUID of the payroll"},{"name":"transaction_type","in":"query","required":false,"schema":{"type":"string"},"description":"Used to filter the ACH transactions to only include those with a specific transaction type, such as \"Credit employee pay\"."},{"name":"payment_direction","in":"query","required":false,"schema":{"type":"string"},"description":"Used to filter the ACH transactions to only include those with a specific payment direction, either \"credit\" or \"debit\"."},{"schema":{"type":"integer"},"in":"query","name":"page","description":"The page that is requested. When unspecified, will load all objects unless endpoint forces pagination."},{"schema":{"type":"integer"},"in":"query","name":"per","description":"Number of objects per page. For majority of endpoints will default to 25"},{"name":"X-Gusto-API-Version","in":"header","required":false,"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.","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"}}]}
\ No newline at end of file
diff --git a/docs/api/get-ach-transactions.RequestSchema.json b/docs/api/get-ach-transactions.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-ach-transactions.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-ach-transactions.StatusCodes.json b/docs/api/get-ach-transactions.StatusCodes.json
new file mode 100644
index 000000000..729fddee9
--- /dev/null
+++ b/docs/api/get-ach-transactions.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"Example response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","x-examples":{"example":{"uuid":"123e4567-e89b-12d3-a456-426655440000","company_uuid":"456e7890-e12b-34c5-d678-901234567890","payment_event_type":"Payroll","payment_event_uuid":"789e0123-e45f-67ab-c890-123456789012","recipient_type":"Employee","recipient_uuid":"012e3456-f78d-90ab-12cd-345678901234","error_code":null,"transaction_type":"Credit employee pay","payment_status":"submitted","payment_direction":"credit","payment_event_check_date":"2023-10-02","payment_date":"2023-10-17","amount":"123.00","description":"PAY 380654"}},"description":"Representation of an ACH transaction","properties":{"uuid":{"type":"string","description":"Unique identifier of an ACH transaction"},"company_uuid":{"type":"string","description":"Unique identifier of the company to which the ACH transaction belongs"},"payment_event_type":{"type":"string","description":"The type of payment event associated with the ACH transaction","enum":["Payroll","ContractorPayment"]},"payment_event_uuid":{"type":"string","description":"Unique identifier for the payment event associated with the ACH transaction"},"recipient_type":{"type":["string","null"],"description":"The type of recipient associated with the ACH transaction","enum":["Employee","Contractor"]},"recipient_uuid":{"type":"string","description":"Unique identifier for the recipient associated with the ACH transaction"},"error_code":{"type":"string","description":"The error code associated with the ACH transaction, if any. If there is no error on the ACH transaction, this field will be nil. See [this article](https://engineering.gusto.com/how-ach-works-a-developer-perspective-part-2/) for a complete list of ACH return codes."},"transaction_type":{"type":"string","description":"The type of transaction associated with the ACH transaction"},"payment_status":{"type":"string","description":"The status of the ACH transaction","enum":["unsubmitted","submitted","successful","failed"]},"payment_direction":{"type":"string","description":"The direction of the payment","enum":["credit","debit"]},"payment_event_check_date":{"type":"string","description":"The date of the payment event check associated with the ACH transaction"},"payment_date":{"type":"string","description":"The date of the payment associated with the ACH transaction"},"amount":{"type":"string","description":"The amount of money moved by the ACH transaction. This amount is always non-negative."},"description":{"type":"string","description":"The description of the ACH transaction. Can be used to identify the ACH transaction on the recipient's bank statement."}},"required":["uuid"],"title":"Ach-Transaction"}},"examples":{"Example":{"value":[{"uuid":"123e4567-e89b-12d3-a456-426655440000","company_uuid":"456e7890-e12b-34c5-d678-901234567890","payment_event_type":"Payroll","payment_event_uuid":"789e0123-e45f-67ab-c890-123456789012","recipient_type":"Employee","recipient_uuid":"012e3456-f78d-90ab-12cd-345678901234","error_code":null,"transaction_type":"Credit employee pay","payment_status":"submitted","payment_direction":"credit","payment_event_check_date":"2023-10-02","payment_date":"2023-10-17","amount":"123.00","description":"PAY 380654"}]}}}}},"404":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided UUID is valid.\n"}}}
\ No newline at end of file
diff --git a/docs/api/get-ach-transactions.api.mdx b/docs/api/get-ach-transactions.api.mdx
new file mode 100644
index 000000000..6b253cd87
--- /dev/null
+++ b/docs/api/get-ach-transactions.api.mdx
@@ -0,0 +1,71 @@
+---
+id: get-ach-transactions
+title: "Get all ACH transactions for a company"
+description: "Fetches all ACH transactions for a company."
+sidebar_label: "Get all ACH transactions for a company"
+hide_title: true
+hide_table_of_contents: true
+api: eJztWVtz27oR/iso+pCTGUI3S77wqR7HSfPQU0/inHM6tscHAlYiYhJgAFC2xqP/3lmQkqCbI9tpT6dtHhyRBHY/LHa/XSwe6QMbV84bprSHseVeGc38tASaXlEohiAlSHqTUM/HDt+dnv2VXFquHRc41uE3U0I986OkKR2DZ1xkzMejEirBCatKfKQpfQ9eZOAIz3OCIuPBZGQs4USYouR62rrW19oJU0JKfuciu42Hpha4/J0mtOSWF+DBIshHqnkBNKWNiNuqUpImVKHmkvuMJtTCt0pZkDT1toKEOpFBwWn6SOvVU+et0mM6W0d+mQH58uXjO2JGxGcwh0lnSaRWe8uFN/a25NMCtF9B8K0CO12BMOK5ex2GuULSKIzhlHxqTZ7/izE0WmLF0U7dBmk/TPkXB5J4Q0Yq92CD/g0v8oYYnU+J0iKvJBCfGQfkXvmMcOJKEGqkRDyFoNKEuEpkhDtyTc8sSOUJFGVuphCWeE1ba6YN2yuVhSDjP3GJDUiyAJkQUD4DS66pCEu8psTgk4QhPtRL3EAaKAIsQl1Z48IWY9iI88vgGWOExj1RjqBBwHmQLfJrBppUusEJMiH3Ks9JbrgMvGCGX0F4Ryqdg3MEtCyN0h7pQYBDsUoH2nkhXrAbcH+uiiFYdOm58hJsWECLvDeWFPyrscpPccQcj6thSxjxKve4J71B7CO/sQ+BYU8vPrJfwLrISzLgMqDYcJNVWO+Q2QqlwQU/kNwDG3J0kNOLj2RSCyXcOSMU9yBrF5iayoYBgud5i3wcEW004CaU1kyURIuHMbwscyWCKd84clUorYqqiGXf/JR5X7q03ZZGuFZIGS1hivY8RbAm/MP3Ni8Va2YqPf5zI5BFr98ijMqBbNHdMZFQ0FWBWafX6Q1Y55B1B5hvGlPTNH4/m92gHV1ptAOHwnqdDv63asrzB16UOZD5SJoEukbKTB9pZIn2V4cTtvgVt5ajHykPhYve1y5DE/rAoNYSvja/8Wdg4JR2ewfQHxweMTg+GbJuTx4w3h8csn7v8HAw6Pc7nU4n4IqyV0r7g0M4Oj7pMOj2huygLwZMHh4ds5NOt3eA4o5POiET1pQEE/zbQLtoyHn9cyP66PgEUAqD/mDEDo/4kAnUtBTc7QUvFapUkdjzhhlXvjUyO90e4Gw2OjqW7KTDcaVCsqXEgz7usLXG3gojgaa6yvNkM2uk24g4Worz3FcO3aYaFsp7kNHHJTOnDdltGEFkIO5uMahqjzpg3Q7r9GIhq9+6RzShvDAVOg3uZivs16qjXZz+gxwcdw4HfTrbIPdPUFpwoH1wNWQTrtfpHfVbLK28qh2pNuxmkKzlDa2+VUCUBO2RVu0O6bN1B3uR4KgCQua7z5TItuUqMoTc6LFDtds89HvKMY/gCNQ5z2dh/gbrbVEeEckyEM4WNdNFUzLdbGB7qWGwgG1qomcinW1G2Vz91VI/BkpNhLtstBDyTPtEEb00ULDMeoC/3CrPwzZb5Yh9HCWMJzh+Hw0JURgg05AhsSwKKVKbRgzWhdsm+Uw5MlKQyzr/D4FolbfIZwByFT5y65XIYZk7QY+VBkDcUQrNzH04L90be+cYZxImkGPcsxIsFkdeTYCV3HrWa7+NDkc5eCC5ch43HPFZ8JXVYeEOa6ItVPqcOIvDd8+dWqfkfdTVY+dksts1Kx3z++pvIcC5UYVxPeIqxyPrbGsO2AfQYnh0tAkEscSyyCShYt7CHHFO2Usn97CmrmGNIOm59n+d4j2VzTPgPmrqsaioMBqmpDATkGQ43Sa7RS5D+NRT8Fd+z6cYkpppGHOMh9bGgWmvxS7f7PC3FjnjmKxCbYoZreGvrUDn3LAgtDeODLm+Cy4NaMpWyP3L6v6qTuLYT1Eea0J6KjJ2GdsV+S6qHs+X1eOE5xWE9sb/68j/zTryZob/Etrv9DdPNj8bT96bSktyrQm51pfBM5vTNp53TGUFEGkAQ8kTeFDOt8jf+B0QV1moKaA5GdatHeXIhOdKtq5rx3xgrgR+B9xN2diaqsTTkMguVzt98Sg8AzMzAWsV7gw2B0+D/8CDB+3CDPToO5jSdHczMlk4f9SUxDP2fN46rsWEDXzbZ63iXM5u8OLZsgCfmabBGfbUZzSl7Um3XQeYAtd+jGNt1l5vV2KuAjuZdykrm2MToKkOeKnqqoBJKEJpsOEL76Awawau5bEQKjgvrG+H4K0yL6yRT8gs8TMu34GosPURkJ/VyzwNefe0Qktc3cSjPuOhuWawLWMXXI0Q5w0AfB4Ct1vaMo0IlmNpRHjlMyTl+pyOieDz1HkoXqOhlrBDQWggjUyQ2tB2aOlghwR9pWnqrLQjEootG/f30WewEyUg2o9l6ceHpvLtMLC9LPvCMzOjsA84dR3sr5ALUwCmp4DjjSPnTVSQhqFD80YaURXzQ+afmk4HFyFlN82pd3Ot5BPkfO6kUHCVB4dqvv5l6T9ojdI4X3AdyfkAfo9e/vpKHpe9lx9+I9Dsv4cH3y5zroKjhMB4bGL3ik66i/SIZ+yEpms3BhsBfJPQzDiPkx8fsQX3xeazGb6uu4sYHFI5Psx3NfPiNe/Rx9+xkJrBdl80zPkr0MHLAZWLfP8EirX7hReq/kNb+k+ub8s1xh++xhf09L+3hxsXGa/woX9Dy/87yxm/Ypt+2C3A0xhDGlpCvMEHqxDjM2nkp0/NAeMt2XU7uQPJvKMdRiygLOklIsMZHnKbC4vnwfsvv714You3X/2seGU9EEuX0sdV6/pFxEoF+uH8ks5m/wQbKPr2
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Fetches all ACH transactions for a company.
+
+scope: `ach_transactions:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-companies-company-uuid-contractor-payments-preview.ParamsDetails.json b/docs/api/get-companies-company-uuid-contractor-payments-preview.ParamsDetails.json
new file mode 100644
index 000000000..9ff053362
--- /dev/null
+++ b/docs/api/get-companies-company-uuid-contractor-payments-preview.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"company_uuid","in":"path","required":true,"schema":{"type":"string"},"description":"The UUID of the company"},{"name":"X-Gusto-API-Version","in":"header","required":false,"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.","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"}}]}
\ No newline at end of file
diff --git a/docs/api/get-companies-company-uuid-contractor-payments-preview.RequestSchema.json b/docs/api/get-companies-company-uuid-contractor-payments-preview.RequestSchema.json
new file mode 100644
index 000000000..597424a5b
--- /dev/null
+++ b/docs/api/get-companies-company-uuid-contractor-payments-preview.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body","body":{"required":true,"content":{"application/json":{"schema":{"type":"object","x-examples":{"example-1":{"contractor_payments":[{"bonus":0,"check_date":"2022-09-2","contractor_uuid":"5376e95b-cca0-482b-bb81-aba5e360eb04","hours":0,"payment_method":"Check","reimbursement":0,"wage":123,"hourly_rate":0},{"bonus":0,"check_date":"2022-09-2","contractor_uuid":"0c984dce-de9a-47db-8bfb-5f0c823afe6f","hours":0,"payment_method":"Check","reimbursement":0,"wage":456,"hourly_rate":0}]}},"properties":{"contractor_payments":{"type":"array","items":{"type":"object","properties":{"bonus":{"type":"integer"},"contractor_uuid":{"type":"string"},"date":{"type":"string"},"hourly_rate":{"type":"integer"},"hours":{"type":"integer"},"payment_method":{"type":"string"},"reimbursement":{"type":"integer"},"wage":{"type":"integer"}}}}},"required":["contractor_payments"]}}},"description":"a list of contractor payments."}}
\ No newline at end of file
diff --git a/docs/api/get-companies-company-uuid-contractor-payments-preview.StatusCodes.json b/docs/api/get-companies-company-uuid-contractor-payments-preview.StatusCodes.json
new file mode 100644
index 000000000..6dd9ee6be
--- /dev/null
+++ b/docs/api/get-companies-company-uuid-contractor-payments-preview.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"expected_debit_date":{"type":"string","description":"The calculated debit date. If the payment method is Direct Deposit, the debit date will account for the company's ACH speed. If the payment method is Check, the debit date will be the same as the check date."}},"x-examples":{"example-1":{"expected_debit_date":"2022-08-16"}}}}}},"404":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided UUID is valid.\n"},"422":{"description":"Unprocessable Entity (WebDAV)","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"object","properties":{"base":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"message":{"type":"string"},"full_message":{"type":"string"}}}},"check_date":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"message":{"type":"string"},"full_message":{"type":"string"}}}}}}},"x-examples":{"example-1":{"errors":{"base":[{"type":"Invalid Object","message":"Please enter a contractor payment before continuing.","full_message":"Please enter a contractor payment before continuing."}],"check_date":[{"type":"Invalid Object","message":"Please enter a contractor payment before continuing.","full_message":"Please enter a contractor payment before continuing."}]}}}}}}}}}
\ No newline at end of file
diff --git a/docs/api/get-companies-company-uuid-contractor-payments-preview.api.mdx b/docs/api/get-companies-company-uuid-contractor-payments-preview.api.mdx
new file mode 100644
index 000000000..234c6daa4
--- /dev/null
+++ b/docs/api/get-companies-company-uuid-contractor-payments-preview.api.mdx
@@ -0,0 +1,73 @@
+---
+id: get-companies-company-uuid-contractor-payments-preview
+title: "Preview contractor payment debit date"
+description: "Returns a debit_date dependent on the ACH payment speed of the company."
+sidebar_label: "Preview contractor payment debit date"
+hide_title: true
+hide_table_of_contents: true
+api: eJzdWFFv2zYQ/isc99AWEG3HTdLET8uSrA2GrUHatAMSw6XIs81GIlWScmIY/u/DUbJky3LapXso6ofEFo/H48e77ztqQR/YJHfeMKU9TCz3ymjm5xnQwQ2FNAYpQdJhRD2fOHx2arS3XHhjySWfp6C9w2ELLjPagaODBe33evhPghNWZeiSDujbP2lEhdEetMdRnmWJEmHB7meHJgvqxBRSjt+KEKiJP4PwNKKZNRlYr4oF4CED4UGOJMTKjyT3sDbJeav0hEaNAN5PgQieiDzhHiQJUwlO7ZCLMfFTIFmxIZKCnxpJlCNnyoLw5Awy45SPglU9kdyrJCFcCJNrT8bGhnFh0ozr+TNHTk7fEJcByEdWOJ2CuGt3HEN47HgKhLvCN1oXQdPlMqIPDB54miUrWMJ3trcTI9rv9fusd8T2DukyfCK639vfPq2/jSd/mFxLcqsJudUInoUvOTjEzoIzuRVApAFHtPEEHpTzHfIXvwPicltEnlkzUxIkub6+OMPNzniiZOdWU1y2399e9lpn1ghwjscJkHPtlZ+T5x8hPjv58OJ/zB9rjXVft4u5W08sbi2f04gqD+k3zC5Gm2m5jGiKG5y0j43zJBntNggnFrKgmfU/RnDLr2VlhXyB7U3l5EKH7CBvV/FW69DLBLgDAtqDJZyImoJW9RTD2FgII0rnSk86tBnt07wsh5tw//jxLqtjwOMO9XEh6YBOwLOCmhS48tt8lOdKstr1qHTtWGZhpuAe84ZbnoIHPLabBdU8xejWHWDWYfVm3E8pasGXXFmQdOBtDtF2VdYJtc3QgSrMeJ1J6TKqlv2HvQ5ydXJ5wT6AdTixXH0KXILdWH/MEwfNVc5wL6nSUFAqnivDZJTk5PKCzAqnhDtnhApKca/8lMxNboOB4EkS+FwbDUhqK5aLCps1XnrmyE2qtErzdN338PnU+8wNul1phOsE/e0Ik3ZXessyPrcmScJ4l2eKlTOVnvxaOmRrj19gGLkDiVm0C+2Igs5TlPB+r3/Aeods7wCVW8KY54kvtGH1fLkcNmG7Ap9b7QgntaAQCRloiblodEATJW+VnkH6GmfZudW3+nExJMaSN8p5Y5XgycpqTSJHX5fIYBLWcsJkMCCfSkjdwAKXn8osAed/N3KOYDWT9slK8wj5tdRZKKnY6NzRQW+TakqtPmb9UvjKqaHiBvTg5atDOD6ImRC8x/aP+jGL46M9xmN+AC8PexD39mlEpya3he9yyVEBNx3QgHZAQqVxbh2kYcO9iN4HBtrrvyzmJ/ORDSH1sBKfFG1PHB/tSwFMwjFn+69kzI7iccwOxj1x1H/Jx3A4/r5o9w8Ot6IdIg1u6l7rGTxVREsoKrPQRINFZtuCoI39WvvWZWMbbd5LnNqGmsC1uG9A2OblflPhq5FCWepiuWkFdBisNvmDk0Q5j3SwrWSuQ0Pb4DLgd8DdnCHdMzMDa5XEAGo5WreaWJNnQYxWHqs7SUThwYNGeiyK7A7mdLD7uhPRGU/yxrUH0301b1ds1cQqxvZZRay1dUvMSLpVvk8g5BtK6oB2Z3vdSry7i3XxXXZbTqBb4+XAzlbandsEhbJUH56pQnyYhDQo0Nad6QxS08C88MdCVeO8sN0djlt9XlojH/GZ4TAi4UDkVvl5iPy02PGJwMvBSY6g3AzXrd4hIRdV2WJbJTKGuBJJ/B0Dt6Fp2IyxdMESmEFCeO6noH2pAZiq7+bOQ/o9KxQediywjCgKzVUtUeeFjnyjimzRb30lLsi6+r1JmI8ScDVnFwMj32IvNjYBDuUxXhr6NWx/MPfLjm2j14go9mPu7fgd2JkSsJZIdWvEY5P7bjDsSsQMaZiF38yMQwLh1CbKHyERJgXiDQlxPHPkvKxufH2BHUHozKQROe4m4P9LqWBcBHIsO8+z1arkCpJgF0gm5SoJlVCO/lYnfhAf43zK9Zqfy6Iy2/r5+gVAcyOLuh/56Rqxsm48PPhulnAVCiwQyqKkvxs62wtnUhIgjeigcf9oK4qoYuQhJrbz6GmxwF7/2ibLJT7+koNFhhkiMVuFrx1CMUkVXkHsuEOsH8fzq1IMX5Bd95cde1z1HMFiJQs0KrVjY4OhssoLzn8L7ye/7bQCWwDYflWscK5V+rQAi73f6AO22/56BhJ/5h+1XZfy1+fvaUTj8qaRmtDRWI7qjH/DoZusoBS8iuCzBU24nuTFq4DCJX7+Bet4lfI=
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Returns a debit_date dependent on the ACH payment speed of the company.
+
+If the payment method is Check or Historical payment, the debit_date will be the same as the check_date.
+
+scope: `payrolls:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-companies-company-uuid-paid-holidays.ParamsDetails.json b/docs/api/get-companies-company-uuid-paid-holidays.ParamsDetails.json
new file mode 100644
index 000000000..9ff053362
--- /dev/null
+++ b/docs/api/get-companies-company-uuid-paid-holidays.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"company_uuid","in":"path","required":true,"schema":{"type":"string"},"description":"The UUID of the company"},{"name":"X-Gusto-API-Version","in":"header","required":false,"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.","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"}}]}
\ No newline at end of file
diff --git a/docs/api/get-companies-company-uuid-paid-holidays.RequestSchema.json b/docs/api/get-companies-company-uuid-paid-holidays.RequestSchema.json
new file mode 100644
index 000000000..63d2a7757
--- /dev/null
+++ b/docs/api/get-companies-company-uuid-paid-holidays.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body","body":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"year":{"type":"string","description":"If a year is passed, paid holidays for that year will be returned. Otherwise, paid holidays for the next three years will be returned."}}},"examples":{"Example":{"value":{"year":"2023"}}}}}}}
\ No newline at end of file
diff --git a/docs/api/get-companies-company-uuid-paid-holidays.StatusCodes.json b/docs/api/get-companies-company-uuid-paid-holidays.StatusCodes.json
new file mode 100644
index 000000000..e354af391
--- /dev/null
+++ b/docs/api/get-companies-company-uuid-paid-holidays.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"Paid Holidays Object Example","content":{"application/json":{"schema":{"type":"object","description":"Representation of a company's paid holidays as descibed by their Holiday Pay Policy","properties":{"schema":{"type":"object","properties":{"holiday_key":{"type":"string","description":"the holiday's identifier"},"holiday_name":{"type":"string","description":"the holiday's official name"},"start_date":{"type":"string","description":"the holiday's start date (YYYY-MM-DD)"},"end_date":{"type":"string","description":"the holiday's end date (YYYY-MM-DD)"}}}},"title":"Paid-Holidays"},"examples":{"Example":{"value":{"holiday_key":"veterans_day","holiday_name":"Veterans Day","start_date":"2023-11-11","end_date":"2023-11-11"}}}}}},"404":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided UUID is valid.\n"},"422":{"description":"Unprocessable Entity \n \nThis 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.\n","content":{"application/json":{"schema":{"description":"Unprocessable Entity\n \nThis 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.\n","type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["error_key","category"],"properties":{"error_key":{"type":"string","description":"Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error."},"category":{"type":"string","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."},"message":{"type":"string","description":"Provides details about the error - generally this message can be surfaced to an end user."},"metadata":{"type":"object","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.","oneOf":[{"type":"object","description":"multiple entities","required":["entities"],"properties":{"entities":{"type":"array","items":{"type":"object","description":"single entity","additionalProperties":true,"properties":{"entity_type":{"type":"string","description":"Name of the entity that the error corresponds to."},"entity_uuid":{"type":"string","description":"Unique identifier for the entity."},"valid_from":{"type":["string","null"]},"valid_up_to":{"type":["string","null"]},"key":{"type":["string","null"]},"state":{"type":["string","null"]}},"title":"Metadata-With-One-Entity"}}},"title":"Metadata-With-Multiple-Entities"},{"type":"object","description":"single entity","additionalProperties":true,"properties":{"entity_type":{"type":"string","description":"Name of the entity that the error corresponds to."},"entity_uuid":{"type":"string","description":"Unique identifier for the entity."},"valid_from":{"type":["string","null"]},"valid_up_to":{"type":["string","null"]},"key":{"type":["string","null"]},"state":{"type":["string","null"]}},"title":"Metadata-With-One-Entity"}]},"errors":{"type":"array","description":"Will only exist if category is `nested_errors`. It is possible to have multiple levels of nested errors.","items":"circular(Entity-Error-Object)"}},"title":"Entity-Error-Object"}}},"x-examples":{"bank_account_delete_unfunded_payments":{"errors":[{"error_key":"base","category":"invalid_operation","message":"FundingMethod has unfunded payments"}]},"bank_account_verify_incorrect_deposits":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Your bank account cannot be verified. Please check the test deposit amounts."}]},"bank_account_verify_already_verified":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Your bank account has already been verified."}]},"bank_account_missing_routing":{"errors":[{"error_key":"routing_number","category":"invalid_attribute_value","message":"Routing number is required."}]},"payment_configs_missing_parameter":{"errors":[{"error_key":"base","category":"missing_parameter","message":"At least one parameter must be provided"}]},"payment_configs_invalid_fast_payment_limit":{"errors":[{"error_key":"fast_payment_limit","category":"invalid_attribute_value","message":"Fast payment limit should be a number"}]},"pay_periods_invalid_end_date":{"errors":[{"error_key":"end_date","category":"invalid_parameter","message":"End date cannot be more than 3 months in future"}]},"company_industry_selection_naics_code_required":{"errors":[{"error_key":"naics_code","category":"invalid_attribute_value","message":"Naics code is required."}]},"company_industry_selection_naics_code_invalid":{"errors":[{"error_key":"naics_code","category":"invalid_attribute_value","message":"Naics code must be equal to 6 digits."}]},"company_industry_selection_sics_codes_invalid":{"errors":[{"error_key":"sic_codes","category":"invalid_attribute_value","message":"Sic codes must be equal to 4 digits"}]},"time_off_policy_name_required":{"errors":[{"error_key":"name","category":"invalid_attribute_value","message":"Name is required."}]},"time_off_policy_unlimited_invalid_accrual_rate":{"errors":[{"error_key":"accrual_rate","category":"invalid_operation","message":"Accrual rate must be blank for unlimited policies."}]},"time_off_policy_pending_requests":{"errors":[{"error_key":"time_off_policy","category":"invalid_operation","message":"Cannot deactivate policy with pending time off requests."}]},"time_off_policy_employees_required":{"errors":[{"error_key":"employees","category":"invalid_attribute_value","message":"Employees are required."}]},"time_off_policy_unlimited_balance_update":{"errors":[{"error_key":"base","category":"invalid_attribute_value","message":"Can not adjust balances for unlimited policies."}]},"holiday_pay_policy_already_exists":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Company already has a holiday pay policy."}]},"holiday_pay_policy_not_exists":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Company does not have a holiday pay policy, please create one"}]},"holiday_pay_policy_invalid_employees":{"errors":[{"error_key":"employees","category":"invalid_attribute_value","message":"Invalid employee uuids provided."}]},"onboarded_employee":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Cannot delete onboarded employee"}]},"invalid_attribute":{"errors":[{"error_key":"base","category":"invalid_operation","message":"There is an error in the request body."}]},"company_cannot_enable_contractor_only":{"errors":[{"error_key":"contractor_only","category":"invalid_attribute_value","message":"Contractor only cannot be enabled for existing companies."}]},"company_missing_parameter":{"errors":[{"error_key":"base","category":"missing_parameter","message":"contractor_only is required."}]},"starting_after_uuid_invalid":{"errors":[{"error_key":"starting_after_uuid","category":"invalid_attribute_value","message":"Parameter 'starting_after_uuid' does not correspond to a valid event."}]},"resource_uuid_invalid":{"errors":[{"error_key":"resource_uuid","category":"invalid_attribute_value","message":"Parameter 'resource_uuid' does not correspond to a valid resource."}]},"payroll_gross_up_invalid_net_pay":{"errors":[{"error_key":"net_pay","category":"invalid_attribute_value","message":"Net pay must be a number."}]},"payroll_accruing_hours_invalid":{"errors":[{"error_key":"base","category":"invalid_attribute_value","message":"Hours cannot be negative."}]},"payroll_cannot_cancel":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Payroll cannot be canceled."}]},"frozen_payroll":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This payroll has already been processed. Its data cannot be updated or altered."}]},"frozen_payroll_processing":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This payroll is being processed and cannot be updated at this time."}]},"unmodifiable_payroll_type":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This type of payroll cannot be modified or processed. It is reserved for system processes."}]},"invalid_employee_uuids_format":{"errors":[{"error_key":"employee_uuids","category":"invalid_attribute_value","message":"Parameter employee_uuids must be an array."}]},"maximum_employee_uuids_surpassed":{"errors":[{"error_key":"employee_uuids","category":"invalid_attribute_value","message":"Exceeded maximum of 100 for lookup."}]},"invalid_employee_uuid":{"errors":[{"error_key":"employee_uuids","category":"invalid_attribute_value","message":"Invalid Employee UUID(s).","metadata":{"entities":[{"entity_type":"Employee","entity_uuid":"invalid-uuid-123"}]}}]},"payroll_blocker_missing_bank_info":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must have a bank account in order to run payroll.","metadata":{"key":"missing_bank_info"}}]},"payroll_blocker_missing_employee_setup":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must add employees in order to run payroll.","metadata":{"key":"missing_employee_setup"}}]},"payroll_blocker_missing_federal_tax_setup":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must complete federal tax setup in order to run payroll.","metadata":{"key":"missing_federal_tax_setup"}}]},"payroll_blocker_missing_bank_verification":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company bank account must be verified in order to run payroll.","metadata":{"key":"missing_bank_verification"}}]},"payroll_blocker_suspended":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company is suspended and cannot run payroll.","metadata":{"key":"suspended"}}]},"submission_blocker_missing_selection":{"errors":[{"error_key":"submission_blockers","category":"invalid_attribute_value","message":"Submission blockers selections required"}]},"submission_blocker_invalid_option":{"errors":[{"error_key":"submission_blockers","category":"nested_errors","metadata":{"blocker_type":"fast_ach_threshold_exceeded"},"errors":[{"error_key":"selected_option","category":"invalid_attribute_value","message":"Selection is not available to resolve Fast ACH Threshold Exceeded. Please choose one of Wire In, Move To Four Day"}]}]},"invalid_version":{"errors":[{"error_key":"base","category":"invalid_resource_version","message":"You are attempting to update a resource using an out-of-date version."}]},"signatory_email_required":{"errors":[{"error_key":"email","category":"invalid_attribute_value","message":"Email is required"}]},"signatory_company_already_has_signatory":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Cannot have more than one signatory in a company. Please remove the existing signatory before adding a new one."}]},"mixed_disbursement_errors":{"errors":[{"error_key":"disbursements","category":"nested_errors","metadata":{"contractor_payment_uuid":"invalid-uuid-1"},"errors":[{"error_key":"contractor_payment_uuid","category":"not_found","message":"Disbursement not found."}]},{"error_key":"disbursements","category":"nested_errors","metadata":{"contractor_payment_uuid":"d0dfa222-ad08-4ea7-a06a-717688c3b179"},"errors":[{"error_key":"payment_method","category":"invalid_attribute_value","message":"Payment method must be one of: Direct Deposit, Check."},{"error_key":"payment_status","category":"invalid_attribute_value","message":"Payment status is not valid for payment method 'InvalidMethod'."}]}]},"not_found":{"errors":[{"error_key":"request","category":"not_found","message":"The requested resource was not found."}]},"finish_onboarding_incomplete":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Company is not ready to exit onboarding."}]},"company_location_validation":{"errors":[{"error_key":"street_1","category":"invalid_attribute_value","message":"Must include a street address"},{"error_key":"city","category":"invalid_attribute_value","message":"Must include a city"},{"error_key":"state","category":"invalid_attribute_value","message":"State is in the wrong format"},{"error_key":"zip","category":"invalid_attribute_value","message":"Please enter a valid zip code (e.g. 12345)."},{"error_key":"phone_number","category":"invalid_attribute_value","message":"Phone number must be 10 digits"}]},"conflict":{"errors":[{"error_key":"request","category":"duplicate_operation","message":"A resource with these attributes already exists."}]},"invalid_parameter":{"errors":[{"error_key":"request","category":"invalid_parameter","message":"The provided parameter is invalid or missing."}]},"flow_invalid_entity":{"errors":[{"error_key":"entity_type","category":"invalid_attribute_value","message":"Invalid flow entity"},{"error_key":"entity_uuid","category":"invalid_attribute_value","message":"Invalid flow entity"}]},"flow_nested_options_errors":{"errors":[{"error_key":"options","category":"nested_errors","metadata":{"flow_type":"company_forms"},"errors":[{"error_key":"form_types","category":"invalid_attribute_value","message":"Supplied value 'invalid' contains no permitted values"}]}]},"basic":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must complete all onboarding requirements in order to run payroll.","metadata":{"key":"needs_onboarding"}}]},"contractor_payment_invalid_wage":{"errors":[{"error_key":"wage","category":"invalid_attribute_value","message":"Wage must be greater than or equal to 0."}]},"contractor_payment_cannot_cancel":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Payment has already been processed and cannot be cancelled. Contact support directly."}]},"time_off_request_cannot_delete":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This time off request cannot be deleted."}]},"resource":{"errors":[{"error_key":"first_name","category":"invalid_attribute_value","message":"First name is required"},{"error_key":"date_of_birth","category":"invalid_attribute_value","message":"Date of birth is not a valid date"}]},"nested":{"errors":[{"error_key":"contractor_payments","category":"nested_errors","metadata":{"contractor_uuid":"72ae4617-daa9-4ed7-85e0-18ed5d0ee835"},"errors":[{"error_key":"hours","category":"invalid_attribute_value","message":"Ella Fitzgerald is paid fixed wage and hours cannot be set on a contractor payment"}]},{"error_key":"contractor_payments","category":"nested_errors","metadata":{"contractor_uuid":"2d7bf62c-babf-4a12-8292-340e2d9cab28"},"errors":[{"error_key":"wage","category":"invalid_attribute_value","message":"Isaiah Berlin is paid hourly and wage cannot be set on a contractor payment"}]}]},"compensation_invalid_rate":{"errors":[{"error_key":"rate","category":"invalid_attribute_value","message":"Rate is not a valid number"}]},"compensation_invalid_payment_unit":{"errors":[{"error_key":"payment_unit","category":"invalid_attribute_value","message":"Payment unit must be one of Hour, Week, Month, or Year"}]},"compensation_already_processed":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Compensation has already been processed on payroll."}]}},"title":"Unprocessable-Entity-Error-Object"},"examples":{"Basic":{"value":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must complete all onboarding requirements in order to run payroll.","metadata":{"key":"needs_onboarding"}}]}},"Resource":{"value":{"errors":[{"error_key":"first_name","category":"invalid_attribute_value","message":"First name is required"},{"error_key":"date_of_birth","category":"invalid_attribute_value","message":"Date of birth is not a valid date"}]}},"Nested":{"value":{"errors":[{"error_key":"contractor_payments","category":"nested_errors","metadata":{"contractor_uuid":"72ae4617-daa9-4ed7-85e0-18ed5d0ee835"},"errors":[{"error_key":"hours","category":"invalid_attribute_value","message":"Ella Fitzgerald is paid fixed wage and hours cannot be set on a contractor payment"}]},{"error_key":"contractor_payments","category":"nested_errors","metadata":{"contractor_uuid":"2d7bf62c-babf-4a12-8292-340e2d9cab28"},"errors":[{"error_key":"wage","category":"invalid_attribute_value","message":"Isaiah Berlin is paid hourly and wage cannot be set on a contractor payment"}]}]}}}}}}}}
\ No newline at end of file
diff --git a/docs/api/get-companies-company-uuid-paid-holidays.api.mdx b/docs/api/get-companies-company-uuid-paid-holidays.api.mdx
new file mode 100644
index 000000000..6b4d94745
--- /dev/null
+++ b/docs/api/get-companies-company-uuid-paid-holidays.api.mdx
@@ -0,0 +1,71 @@
+---
+id: get-companies-company-uuid-paid-holidays
+title: "Preview a company's paid holidays"
+description: "Preview a company's paid holidays"
+sidebar_label: "Preview a company's paid holidays"
+hide_title: true
+hide_table_of_contents: true
+api: eJztXFlvHLey/iu8fR9sA9PaLC/R03Es+0QPjgUvx8eQjRanWTPDuJvskOyRJoL++0UVyd5mkUaWHm6QAIHtabL4sVgbi0VeJZfptLZOp1I5mBrupFapW1SQHJ0lUI5BCBDJ91GiK/BfT0RylEzBpbkuK64k2PC3RVbXUqQVlyKb6UIKvrDJKDFgK60s2OToKjnY28M/BNjcyArJJUfJKZeC/RZ6sPfjPyB37M0lL6sCklGSa+VAOezHq6qQOcHY/cNi56vE5jMoOf7Nw040EUhGg1E+QGXAgnLUnekJ4ywAf2QZomYRNeOWYWc5BsHGC+ZmIE1EyE7xf13IfJGMksogY5z001uPpd8uDJT9gEWnsXVGqukScDeDiOyRZVKAcnIiwSTXo4aQ4iVsS0lPJjKXvGDU+XqUWMeNywR3W5Oingx7ssdfv379mr57lx4fP0GioMSdSIISqwheX1+PEiddAUFw0ig4NJgXGuJxFKCjq2TOixqW+J7MwYHhymaC41L2eZn8J3xlx/S1y5zkYO/gabq/n+7vJ90Zdn+/vvZYD/cOlyX+d+3YW10rwb4pxr6pTzNgBv6swToQzIDVtcmBCQ2WKe0YXErrdtg7/gOYrQ2gRLLK6LkUINjnzyfHTFo254UUO98UcuLw4GB52M+qMjoHa/m4APZGOekWDQJpWckXbMarChS7mIGiUcZaLFBZFro2ESNDleRSWQbGaGOZrfMZKs25VAQi484ZOa4dZMT78xHThshFChMuC8tEDcxpxlXbs7Ez5zvsI/iZnr3xw7zmDqbaSLDfH8+cq+zR7q7Qud0hE7aT63I3mqy04guji4K+7xLMNG+6P2HTWgpgE21YqQ0wAQ4BIfO2MDg3c/cf5g6ZOzSMiFkaEORvCAl6m765DL+3FoQbQ0opHZR2lbldokoqP0oCysWaMW5nkD9WkKMFtriQQRmpO9N5Xhu7wz4tKpnzokDXIS37AYvWbltq36zhbsUNL9HWMAMFR/13uiW5g8rcoN4CGlLAtihenhJDKxNJResRpIxNja4rqaaWcSVYzhUbA6utRzOuZSFYjnJQhvYzrkQh1ZRJ5aW3Ez/ssJNJO5C07FyRYcv8Op6PCJxfK3YhiyKKPOPMt2TnoSkLi7RgF9LNGHiT5T8Sa0rUt+ktvMtpnG+QRsbHunadtUvZFBSYdtUC6cgMW5sJzz1DuCL/VFswAYXjgrtbRCGvo3IbKGDOFXlNjjSDgCyCJgcXIBUjncaQhcxGsEjjAnbYW21YcHmjHgnCR6w6939miOqc1jb+gsHauWf/uHUmO8ko0QreT5Kjs5vmUtaFk1UBfizUo4HixZ+XlS1+2UKl+2NbqaZxZOzGhZD4iRennZGcqWHl2J4hN0vN77wkDSIx8Rx1M94Vm1wbH+EKy5ze8SFPw+CbR/is5J81dMI6spvteETRW++J0WVL8KylqOqiSL437eoqc3pzw56dW9XAul7MttykE4a9C9KffpFulr5XkHrnl1yvb/UuyI5viktzPfpnzf8Oa46U1jrsPh++oPHRqlj4AJfJjW5jh504/LnS1koMsZxmMz4H1tihAuZQ4MYmupHoKBqzkuTS5HXBzWMPN6XgJ/V7TtxetDNc0cAL9GXa3WaMufqR8TzXtXKZgAIcZLWa1EqAyCq+KEG5XhBz1os1kjG30A1MjpKlYC3puLnkba2EVNN34GZasBm3LI7GmtFoDXrA5mDkZJFJRaKbI9JKW3mvyL5iGICjsjAqek7cvYyB0fgSxA47LYBbYPkM8h8+SMGINcBhvMSO6NrXTYEXBrhYZJHig04A2RsGZGMA1c5jBcBSWrRQmdG1Q7VZDyy0yFRdjsGshjgI8ntAP/j+zPdHnYhuN+AKkpDlWk3k1DbQmlhzK64t9+6CeeUYLqljWgFrg9mytq4bWKwGFmc74dZFbckKWUq3AeGKxluz8C0iDjQY0WB2putCIGYeONtgziowUosWbzersQZl02QlttW8fBOTHq3m0A7KzbhiT1mplZtZjAkntasNeHwx+yaVqK0zi8xCATlKd6a4zG2WawFZG5itRdy23p6fv2Nfhn1XiOPtEIZhHh5gFE34s+YFepHnTMipbMzOBrg2ArC3gGtl7ttuj/ajzAmrXQZ7GMB6rE6WkOnJJKsoI0nJq9utdXknJpar1ncIolakUSAafeF5bmpeZGazzvSabWG5X/l+DPs1HBsXaMoxsmrwMAIowa4BXgE51ywkUjZ5x0HXbdC+9sotgOdOzhGyp+H3uAEDwwEwRxuzOuswQ1kVegFgb7PsTePt1/5N7Mq4gdtLwJgXXOWQ1dUN9nK9t96E6jVXlCHl4g9adj+a3bzsMdNLlt0DjmEFBaL3GRW99sakCSMopIh5bvRAYfHXQ1PaPRysJsVMkfQqYCNWhZDNAMqqVrAWauMeGzF7EFE88W1YJMFw22U7OQzCp9VYc4NheGx3n/yLOowBP2uGaiB5CEuTuUcEnyj3KC0le2hbKlUvC4zJ5YFH82FFBgrzRxiEOcNzp02Gm7AN2IYtt1fThoDf77XxjcciSGFJytH2NUeLA/wPGccO5rjCzdEREBLgEweG9vq3iQKWe23Pv9Mmrn60gt6jVo3b1ATlKVlQlDkoF2YRU4u3xd9r/1PIe5RuxBxbt1saPHLIpkZbi+mOOLgC2gxsinVCi+3DHaA9QhNRxH3BABJFLbgiM12b2wSGd3N1vyH1juYomHIn50MGBR3P0Q8W92hvTj39DgA/RKMeE6P/ApUFHPdq6TDrE4Zf2pKHQzfMLZw469PpLUYfdgg8IeOFA7MGbRaobN63/xRwadkY0Lg1gONRywAqpRqlpQAwgK1VqYWcSDLbEXLMZt4n2HhiVC0ttgfgOdljuTeUFsw8WHG7sA7KplG04cPYgKyAzSbalHzTbr/f/mcMUJ9Sq9WKUXoy4Cz5pSzrcojT1qbiOOcHhPrmMgfAKCJgwJXY39sjrhZa/6irTbx8QGAx4Ip7ACo5eGyf7CT9s6/2XOdskHRvtg/JIFcex0+peGj/4CnOsGfQxoXOf4BpnD8l3aSa6K2Ef0BtZTBMEhEC4V4eUCqmjQCD/snUKqrHcPp+7GWcm+fTLI4FV1cPMyku2tDU3m06A5ib5zQBgUepmeOXDzktjAspAA/jMccvGY13tzkuw76FKPqcsC8Sufdp9sQwWqyYhf4JueyBXj1JW1vMRWyZYr/NpCQWtQTiXSd44xRaSB6yrcc0K62WlqbJ2W0KzZe63yVV1xBhkQhrBm/3EMk6wK1X/lm0veOyAf/iaMEaUwqd57PMzQzYmS5EBsH5JJ3zuyECmhY0WLfnVeQLigClbeZcFjwc5mHEX8yBUW7+1evf2KcIjkXP2Dk/0tpSMgKd5BdpgJ2oEXun58A+aSyuM1S4d/295zDnYOy2ahr7NtuXSGRwdkR5Me4clBVtYp0OIR3jbT1HjcKJIYeuXaonKX0PBOM2U04Vd9pgao/L4nZpPS6Lu6T0uCy6G90hgLjvjtmxGbdZ8/X+syn+NLc58MDFbUZjVB4UADViYKDEFaej85g8aLuMYYLEsE4Amc4UXCDRGOjJSxCZkHZcGwt0mNSeW6+ZWLf1FtrXyS3Ec6uV0c8G3VtHoo9Bu2yCdaU97h53QJPWURPPhQeentgTE35wcJBysfcyPQT+IuV7z3n6Yv/F85cv86fj/Re/bJh0pFbSafddYn9/wOf7N/7TW40jdizxLJwd+8PnEXuNh9I7yZArEQXWR9R32oF4FL5/NH0+osbQvuqjfBSibX/E/2gn2rB2cTclayj3dxupWFNzfMHtUEaSiVTSzrKQ5UTvioUEPvR6gJx0YJDf4zuNmu1YO/ggJ1hoH8VkRPqmKMw6A+Cy/e1X8R0Kj1R5UQu06J4Q2hYD1i7JTO5LlH5uDCIypOyrdLZ3vdgNWRuyxBdGqykLu+/hGH/J6g5i7k0yKNxrxyzeX7Lyh66PYWe6w/YPnh4+e7JCxWZawZ3rIU6xd6yGiEq+v9c7KMWKg0LmmzINK5VH1L4CHNYdPXZUB4/v3Axsp7y3TVb5I5zBBv42ieyVsDbXEXzqXg9oazJo9f26YG22j5Sjjhf6olPeQLVcm4ob2r39nbMJOGSs5hsKRDdHcD8DNJMMnszHsPZmnx8a3t4d0igh0I5WChXNbvB0+J363GkHgjXBIBh9Yo9Cn0ftTQKlWQWmlM7FVjZ6lTG3Mn/g3TmnMr9ov2O0SUHGdltYBSBsxw+FbeCK+CPy7SIUh6+ZHX3emuFfsCw82pkpHYuaELKatlBjr3FUS+geMEdPkcT6JPkg5+wRYA6fUWV67pitq0rjbS4KjorF8IQ/mKM4B38Ceu956EHxQweyH1AMTrM2lYtJY112t4KXt9iXLsj1t0nDuJn8wyQbS+Nm249yTOfqE0bdm61x8KBUNuEDQLI5tzumbWpB7xLEh+D9xQGHw+f7L1LB+S/pIYgX6ctnsJfuvwTxTOwBvHz6bINJo9OwO2xKi4Kzt9L9NcVUnKCKX7ycOcHtGkOFJRmeDU7DLGCMSFvE5qg5MGHFRueeOXUgXownzw/ydMzHk/SQ7x+kLw9+OUifHu7Bgfgl5+ODlxs4dTcrdGK55DP2K5hCqoZNyJdiQSy6CLdXbsehGFODsj6ebvIem+t21tdqbSxhDdFoV9K7RZcrkTSbS7WxPrTX7M67New92DEyPIIdsS8APzDVpNyMrt59Bb4KdUyaNLb3nrdKcaBN1l53HOp1r4C/d1sxXVns3r9P+2sMFJrbtP9vI4brUfKh4zdumtDfxIFcj5LfGw9y05z/cSX/uJKfcCXx9nsI337VgnaTbSrb39K689MO/etdCzTAN966OsEXH7CpnyDax9Hg3Qd/DYs73yzejTTgaqMwRn7vZmAupIXVHbEm5xKrNwwAkbDLNPwdopseKvAzovcEmpcEhvdZYS7hYv0jFt/UN2VzXcERO18q1ZRgj9BhnCMvY37AS1N4/qD7pgfen1Jkx8k4DVdxaZnCAixhxrQEPVYQbteFMcgahmH/m/6bniN5dXqS/qc5Z6HRZ8AFOY92/AkvLAxHOca5lFKFS9Bo/lL0SYK9Oj2JZy2MW6tzSQU3lLehS8zYAO9t0w1mhU5ftmWlI9+mI6iPLDsrpaJSjQ7tLe/P80qmoadU0/8NBNPOz08QBl7GRh+3jttYV1GXeG3vYO/gWbr3PN1/hjdvBUx4XTgvTfH36+vvo8TxKS55svSwSbize5naCvgP4HaR0v1wssTU9pQvmpb9hriOqZ6DMVIgusrLKT7V8Vv7KAxcOlCW0iooc952rX2KZhQVo/skDQpN7DfE2XRYhXd1xz7ulsAq/Mi8cCRBT+GQErlZcpTszvd3m+LV3auuEl3vDl/GoZqpoHW1KRBtkBteSS82qYCSZGfJmh1DqQes9/RSf/CCn3GmawivpHlq6JBlHc0KP+PcLeS1oQTh2VUM4F7lGEy+qpENZ9+7rT6iwHpTt6JtI8YIMYo3/nsM3JC6Dy/QE4mU7noyXrsZJvhiIcMo+UjVZz8zgqewZoDrUYLe6UPr1zrmO1jt1vzFKqUYdJNtQ1OBAhaPort6OUrQdtn3k49g5jKHztK1ZoReLtilhrsCUaIvTOnfeKRsQ9el27ZQ5Lqkk3bC8ciyN0GbWCzuRCsmdF6X8Z2k/wnvoXCfOQ9W+jiOyj7gmxUhPepPoVH2wtd/taKGjKu0dSVXHTo3OrHhJK7akOEePWCQDweXbrcquCRBIsW5Cop9lszpyCiqdjJKjgYesq/d3/F+hHXY8+oKvc9nU1xf489/1oBx2dl3tDGGSjpJj4Skrdgar9ad+OMPwQE+Yes86po5xdvY1CJauCRcDe+7fH/Fw7vc7eD9zf3vSsZ6Bq4OXho+t47ntWdW+qnn3ZZj4LYHGrTKbWzbdUr/fvMpGSXjEHaXmlyx4RcYPfELv+jxXAPjcvztKim4mtZ+R+BJ4n//B63DJ/c=
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Preview a company's paid holidays
+
+scope: `holiday_pay_policies:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-companies-company-uuid-report-templates-report-type.ParamsDetails.json b/docs/api/get-companies-company-uuid-report-templates-report-type.ParamsDetails.json
new file mode 100644
index 000000000..132caed96
--- /dev/null
+++ b/docs/api/get-companies-company-uuid-report-templates-report-type.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"company_uuid","in":"path","required":true,"schema":{"type":"string"},"description":"The UUID of the company"},{"schema":{"type":"string"},"name":"report_type","in":"path","required":true,"description":"The report type"},{"name":"X-Gusto-API-Version","in":"header","required":false,"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.","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"}}]}
\ No newline at end of file
diff --git a/docs/api/get-companies-company-uuid-report-templates-report-type.RequestSchema.json b/docs/api/get-companies-company-uuid-report-templates-report-type.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-companies-company-uuid-report-templates-report-type.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-companies-company-uuid-report-templates-report-type.StatusCodes.json b/docs/api/get-companies-company-uuid-report-templates-report-type.StatusCodes.json
new file mode 100644
index 000000000..b93bd20df
--- /dev/null
+++ b/docs/api/get-companies-company-uuid-report-templates-report-type.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"Example response","content":{"application/json":{"schema":{"type":"object","properties":{"columns":{"type":"array","description":"List of columns recommended","items":{"type":"string"}},"groupings":{"type":"array","description":"List of groupings recommended","items":{"type":"string"}},"company_uuid":{"type":"string","description":"Company UUID"},"report_type":{"type":"string","description":"Type of report template"}},"x-examples":{"example-1":{"columns":["regular_rate","regular_hours","regular_earnings"],"groupings":["payroll","employee"],"company_uuid":"p83d0ca8-7d41-42a9-834y-7d218ef6cb20","report_type":"payroll_journal"}},"title":"Report-Template"},"examples":{"Example":{"value":{"columns":["regular_rate","regular_hours","regular_earnings"],"groupings":["payroll","employee"],"company_uuid":"p83d0ca8-7d41-42a9-834y-7d218ef6cb20","report_type":"payroll_journal"}}}}}},"404":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided UUID is valid.\n"}}}
\ No newline at end of file
diff --git a/docs/api/get-companies-company-uuid-report-templates-report-type.api.mdx b/docs/api/get-companies-company-uuid-report-templates-report-type.api.mdx
new file mode 100644
index 000000000..b483dcc28
--- /dev/null
+++ b/docs/api/get-companies-company-uuid-report-templates-report-type.api.mdx
@@ -0,0 +1,71 @@
+---
+id: get-companies-company-uuid-report-templates-report-type
+title: "Get a report template"
+description: "Get a company's report template. The only supported report type is `payroll_journal`. The resulting columns and groupings from this endpoint can be used as a guidance to create the report using the POST create report endpoint."
+sidebar_label: "Get a report template"
+hide_title: true
+hide_table_of_contents: true
+api: eJztV21v2zYQ/isc96EdIFpOmraZPy1YuiLAtgZNug1wjIQWzxZbiWT54kYw9N+HoyhHtuOu6z5tWL5EEu+Nd889d17Te7YMzmsmlYel5V5qxXxjgE6mFOo5CAGCzjKqDXSnF4JO6BI8K3RtuJLg0lNzG4IUzILR1jMPtam4B5c+3EajGbXgjFYOHJ2s6fF4jP8EuMJKg9bphL6657WpgPSSNKOFVh6UR1luTCWLGEn+3qHCmrqihJrjUxc51fP3UHiaUWMxbi87d4WuQq3cQJBbyxua7UTws3Se6AVJ8sRCoesaFKYio9JDPbThvJVqSds2o0urg5Fq+eUuNhpf7mSY7X2JXUc/dtLk3buLc9pi/h+q8ZfK140BjLJTIn1NYxj3DLpCxTDTMzvayvOUWliGittbi2rZ5rXUwbrBO3CrYt5mW0mcUsMbq6uKZhR96wYARbZTQM3pMzEu+Cl7KU6O2Mkx/56dPjtp2EtxfHQKixfF/HhMd67eW759r4NVvIp38tJXePa2w/D15r4ZHV42IRQfV7wK8C++M/5l9GR8st+Hv2pPftJBCXKjCLlR1yX25McAzoPA7tTBFkCEBkeU9gTupfMj8gv/AMQFC8SXQIzVKylARPwR6ciKV1KMblTM97bD1+AJJ+meT9wu6kYEI9CqaogLBo9iGJ0MAlU6crdzw7tOyYILlZdquWlprsSg9xZW18SX0hFQwmipPCm4InMgwYEg3BFOlkEKrgogXpPCAvfdBVMAwaF1/HD55uq6F0iHvdHRjbpRrtAGJuSur2cn4yafrPRwh5zFLa/Bg0UwrKniNZZuq/wZlSqW05exxh+DtCDoxNsA2T4d9uSx194ldHXRixh68kHb7BFOfTCSItrm9c8FtO91ULboLZn8g72Ow+js8oL9BtahQjJdAhdgt4wveOX2rJ9j5mqpwMUrCe6BzTlW8ezygqw6o4Q7pwvJEUGfpC9Jo4ONAgWvqhG5WBClVURUD+CskxmMnyeOTGupZB3qoe3Z09J74yZ5LnThRnG6jgpd5/00ZQmj8TznRrKkKdXy22SQDT5/h2EgDkf0cG0zCirUyB7H4+PnbPyCHT1H1hCw4KHydDL83razjHresU3HdZGF7pkzwD8Adw3DijC9AmulgG7ib+gQ2dCDwuA6jH6Ahk4OrxJZT5PDlQLL3usdcrtR3HKP0dfgS502kdgzvqQTmq+O8s1akq+HPdPmPV77xSRfDxDcYm7BrvquC7ZC0KVKciO7QjIBdazm3qg8h1rT7RR29lika9SLSD9g+FGbl1aLz9g0eIzJcFAEK30TI08D/6wowLmzgHmZzoZSVwihbpA9IrsBFobYAw7f58BtbMBH9wtWwQoqwoMvQfnUIUgWV43zUP8TD52FAw5apIeFjlbT8I4Ugh2J8EkksgX/jCJFuDeLK7ArWcCgHg/dyuc6+DwK5gJd4yLJ4jvTi1gHVN0N9neoCl3HIRHjeOLIqwR5ctn1fSQLoYtQg/LxGt+kFZcXccVNZHjeeyVvoYpyLq4EXFYRUOn0hwf8YDaMdr7mamCnG6u7K9xO4OuHHfv/OdzN4YRSD/c+NxWXEc6xfdeJb6Z0dUT7zQx/Y2R0sjOnd0kHRYaDc5bRUjuPttZrnFPvbNW2+PljAIsdPUMStJLPEdzTNRXS4fOB+Tes49O3aVR+Rw5N+gO37H+6RImegmmW+HrrishpXx3ScA34qlCGqWxnbdavCX8vUf/xneHRvHb5e3zh2qT5YUYjgRs/ONv7Hb41lV+/uqZt+yevt8H+
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Get a company's report template. The only supported report type is `payroll_journal`. The resulting columns and groupings from this endpoint can be used as a guidance to create the report using the POST create report endpoint.
+
+scope: `company_reports:write`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-companies-company-uuid-suspensions.ParamsDetails.json b/docs/api/get-companies-company-uuid-suspensions.ParamsDetails.json
new file mode 100644
index 000000000..d8ab58890
--- /dev/null
+++ b/docs/api/get-companies-company-uuid-suspensions.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"X-Gusto-API-Version","in":"header","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"},"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."},{"name":"company_uuid","in":"path","required":true,"description":"The UUID of the company","schema":{"type":"string"}}]}
\ No newline at end of file
diff --git a/docs/api/get-companies-company-uuid-suspensions.RequestSchema.json b/docs/api/get-companies-company-uuid-suspensions.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-companies-company-uuid-suspensions.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-companies-company-uuid-suspensions.StatusCodes.json b/docs/api/get-companies-company-uuid-suspensions.StatusCodes.json
new file mode 100644
index 000000000..95eb6cbcf
--- /dev/null
+++ b/docs/api/get-companies-company-uuid-suspensions.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","description":"List of suspension records for a company.","items":{"type":"object","description":"Record representing the suspension of a company's Gusto account.","x-examples":{"switching_provider":{"uuid":"ade4528c-6cc4-4bd5-917a-9d636317e7d6","company_uuid":"3a0e3fb7-3d4b-4c7c-8ba0-9ce3c9f1f3be","effective_date":"2025-07-23","reason":"switching_provider","leaving_for":"adp","reconcile_tax_method":"refund_taxes","file_yearly_forms":false,"file_quarterly_forms":false,"comments":null,"tax_refunds":[]},"shutting_down":{"uuid":"5f04b8d0-1a41-40c6-9f5e-10b26ed89729","company_uuid":"3a0e3fb7-3d4b-4c7c-8ba0-9ce3c9f1f3be","effective_date":"2025-07-23","reason":"shutting_down","leaving_for":null,"reconcile_tax_method":"pay_taxes","file_yearly_forms":true,"file_quarterly_forms":true,"comments":null,"tax_refunds":[]}},"properties":{"uuid":{"type":"string","description":"Unique identifier for this suspension."},"company_uuid":{"type":"string","description":"Unique identifier for the company which is suspended."},"effective_date":{"type":"string","description":"Date that the suspension took effect."},"leaving_for":{"type":["string","null"],"description":"Which competitor the company is joining instead. Only required if `reason` is `'switching_provider'`."},"reason":{"type":"string","description":"Explanation for why the company's account was suspended."},"reconcile_tax_method":{"type":"string","description":"How Gusto will handle taxes already collected.","enum":["pay_taxes","refund_taxes"]},"file_quarterly_forms":{"type":"boolean","description":"Should Gusto file quarterly tax forms on behalf of the company? The correct answer can depend on why the company is suspending their account, and how taxes are being reconciled.\n"},"file_yearly_forms":{"type":"boolean","description":"Should Gusto file yearly tax forms on behalf of the company? The correct answer can depend on why the company is suspending their account, and how taxes are being reconciled.\n"},"comments":{"type":["string","null"],"description":"User-supplied comments describing why they are suspending their account."},"tax_refunds":{"type":"array","description":"Describes the taxes which are refundable to the company for this suspension. These may be refunded or paid by Gusto depending on the value in `reconcile_tax_method`.\n","items":{"type":"object","properties":{"amount":{"type":"string","description":"Dollar amount."},"description":{"type":"string","description":"What kind of tax this is."}}}}},"title":"Company-Suspension"},"x-examples":{"success_status":[{"uuid":"3bd0fa7c-071e-4e85-a6bf-f73a69797694","company_uuid":"3a0e3fb7-3d4b-4c7c-8ba0-9ce3c9f1f3be","effective_date":"2025-07-23","reason":"shutting_down","leaving_for":null,"reconcile_tax_method":"refund_taxes","file_yearly_forms":false,"file_quarterly_forms":false,"comments":null,"tax_refunds":[]},{"uuid":"2ad79a4e-2fbd-43ca-a77b-e9049e6cab15","company_uuid":"3a0e3fb7-3d4b-4c7c-8ba0-9ce3c9f1f3be","effective_date":"2025-07-23","reason":"switching_provider","leaving_for":"adp","reconcile_tax_method":"refund_taxes","file_yearly_forms":false,"file_quarterly_forms":false,"comments":"Company is transitioning to ADP for their payroll and HR needs","tax_refunds":[]}]},"title":"Company-Suspension-List"}}}},"404":{"description":"Not Found\n\nThe requested resource does not exist. Make sure the provided UUID is valid.\n","content":{"application/json":{"schema":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided ID/UUID is valid.","type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["error_key","category"],"properties":{"error_key":{"type":"string","description":"Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error."},"category":{"type":"string","description":"Specifies the type of error. The category provides error groupings and can be used to build custom error handling in your integration."},"message":{"type":"string","description":"Provides details about the error - generally this message can be surfaced to an end user."}}}}},"x-examples":{"not_found":{"errors":[{"error_key":"request","category":"not_found","message":"The requested resource was not found."}]}},"title":"Not-Found-Error-Object"}}}}}}
\ No newline at end of file
diff --git a/docs/api/get-companies-company-uuid-suspensions.api.mdx b/docs/api/get-companies-company-uuid-suspensions.api.mdx
new file mode 100644
index 000000000..5303cf172
--- /dev/null
+++ b/docs/api/get-companies-company-uuid-suspensions.api.mdx
@@ -0,0 +1,75 @@
+---
+id: get-companies-company-uuid-suspensions
+title: "Get suspensions for this company"
+description: "Get existing suspension records for this company. A company may have multiple suspension records if they have suspended their Gusto account more than once."
+sidebar_label: "Get suspensions for this company"
+hide_title: true
+hide_table_of_contents: true
+api: eJztWV9vG7kR/yos++A7QNQfW7YiPaQ16jRn4HoxYqdXwDFkLjkrMd4lNyRXtmDoU/Slb/2K/QjFkLur1b84d4cWh2vzEnl3ODP8ceY3w9lnagqw3CujLyWd0Bl4JkxecK3AVb+W07JUkrnSFaCdMtrRDpXghFUFLqQT+hY8gSflvNIzshYkFoSx0pHUWOLnypFKY5ec1z9JzpdkzhdA8jLzqshgnwKVEj+HSjC+lyDxmbLkbem8IVwIU2pPcmOB+DnXxGgB3Y/6o379r3/+/R/kxhAxB/GAymrjyhGeWeByudb6Ub/+qF+juAQPNlcacAlvL5qK0lrQPltO1ws7pHRoGsi9ctPm8T3hWpL7GkznuS/dPUkVZLgzHVbcIoSNibtv5t4XbtLrSSNcd4Yb7AqT9yBPQEqQrOBLa7KsZyEFC1pAD49uMVif3rcEtCyM0j5g4IQpYNJyY32cEwTgnnao5zNHJ7f0T7UOetehTyyYZ0p7mMVQYX5ZAArW7qBcwS3PETBU8Uw1z4FO6N9YOB12fnXJ/goW7dEOVRg0c+ASLO1QJ+aQczp5plEvdd4qPaMdCrrM0c5x//iU9c/Y4BQtSUh5mXk6aT9fbcfkRX14LgAsuQeWcAeSnF9dkkX0hXDnjFDcgySPys/J0pQ2CAieZV1ymRJt8PwdKaxZqHDKQYYXRaZEgOPIkdtcaZWXeVv31x8ivu/xQrFqpdKz31cKWevxt+hG6UB26arTINxO0hragvs57VALn0tlQdKJtyVsA3QzB/Lhw+UFMSG56tj7woGsVncd6kCUVvllOOUYKctzIcC589LP6eT2btWKGuse+ay2b8EVRjtwqPq438f/Nn26LoOmtMxILUw7VBjtQXsUb8He++RwzfOuu9xavtwhqe+V87jXA/zUJF8XUfSQu5ZGk3wC4XdUvg/riYXCggMd6A+hbJkwLeY4cptchZaeGDzxvMgiKO5ReTFXejatws3i03C0E8olDE+PXwl2JsSQDRN5ysaDEWdjeXZydjIYwUieBbRaATGhJ7wPJ2kyYidymLChGAn2KuF9NhZwIsbpID1JEGNIUxBeLWCKmdLk1ogdn4RI4gHsfQ52aAZ8gY9SY4ObRVghjBYqg6nnT9Mc/NygNxbSUkt8BlhGUhRYArfZElcj5inPHFRvPpfceth9KUyeg/aOTnSZZUhcT9Oo2YUA7FA3Lz0ex1SaR93C8DTtD5NXss8GfDhgw744Y+P0FNignxyfgXw1Hh2P/+MYbvi2BV/c0AH0Cr78EnQxy/YjF9+9BNyqQwuLLYFXMSAjALvMvJkHH7T6XAJREnMgVWDXFX+dCshaW8D+XL0NWZHHuRJz0tiRkRx3TuIlQxfch6bBb6evN+aBRG1B8cZZ1Vpv12oR1lij2up/DF6iz+CV39qCcuSTUUj6RGnngcsueaezJanpG7uP+xg99yh9f7SbhUf3wb06xl7a75unIuM60GiA9HG+bPt05Jp26pFvY7s/Nl+y+J15rMjvUWUZmXMtMyAhmJsWTJgsA+HRzrr2t2N+gz0wzffHeuNLYkwGXO84cz03ZSYrf1AHaXSgSyToIUaTBOY8S7cq5B/ITfjDWhCecO0ewRLBNZGAMOG6LTxbAVqVCGVrhDuhPZybxxoMCyQBFGuAlt2Pmq72pvzP2GpU8Gve55qlvjrDPjiwzJXYHYAktQIShRK0Urm6DIYPORkCfIMUX2gqLqKBqsmMO4uchGaiFp5gpJsNoPbxI8LtIFyIknotSGIsKbiSJFlWpxjhR99NvDwseIYsqZEldnPzHlH9QkuzSfg8Rxy+gjFNlnFLonh3p/1+afmPyLUPCqMoDaEYwFCuS1f4r0O98hmurzpMdt3ghLa2uqbYNVZXq9CY1oU7kf2UjwTrjwbAhvDqlPGzJGXp6ISfjUfj0dl4+Ost9/+lZqlB65jL0ZgPgR2niWTDE8EZH40SBuP+cAxngieD0/+1BrMOQKQ2b7l2yscbGmb0+cVV3ZEozNJwnQs89917ogGko7t4330xuhleU2jMgWF/uHtF+sF48mdTaom3eiRobBPA4Q3WgjOlFUCkAUe0qYYyXfIX/oCcZ+N0or7JxtufcsgfSkaW+Oqr1gGnyEdNyC/16/Kit+kaorjFWuu77S0Fa40Nw4pNLque73L4QS7c0Tp9AFwguIeZscsDNoLUi5x3XYDALhYrBFR7DsuJEaK0rktuloXCwcMy0uEDLNe9b6ww3HurktJDr5m3EAtZGGBUJSaojM127fVPcC2UsWUByMtRU+wCKlX1IbnK85k1ZaH0zIWox+YggTCjQG+SUmWSCCxaeSUf+r7Y6sY5SmusFHzOwTk++4qW/ap2RILnKnOEJ6b0LVAZmYEGu4azUl176UqbchE95RqnZei4bSrQZo3Rxk9TjPB2YN1unD+tIr4dL5PWwtbm6IEEwW4b8yMs6NLVXbsU/mA8C0nG3qBR9i5GbeOuK4A/AHdLFk6lmQ0pcN3N6W1bFsdIzCzAWiUhjoCRrZ98LY67jPs7OArs0NCCbI4EsbBsrovDoEYYr6RtoW3/G8ED+9i/dnM/ax24L5xMNZUibjSMyia0txj0Giu953aJW/U2wXNgF/WUs7QZTjKrOR8vVBzzMQl5mPXt6Rdzs3UAUR8LtRTXhX0dULxX55U18gs6C3zdntxdI4nHqN4zv2vyDo3Xw8BwwwBuQzXetF6XsAwWkBFe+jkSVqwbmNDXS+ch/yUWooYDBlY48kxN0FrlSeySz68u8fSrmfPGrLhDcTTs3qXXYBdKQAvp9ZQ20EkvCPYkmkbWZ+FvZtKAMC7daWwhEyYP/X7w48iRN1VKkKuqQcAhsTSixBYjbON3VeXlIlTearJ7UVsl75Hhq/CDnKsshEr19o/ryAjzG+N8znVLD35aaIXwzteY7T08r7uA/3/Z+Y182YkJ5+HJ94qMq5CZgWOeKwa8pYtB09ur0DtPtj4ttGnwrkPnxnlc9/yMn1U+2Gy1wsefS8C6d3uH1GsVXn4DVUrl8LdseuyDMffN+6oL+5Yc/kaxd0d1mxckauKnnapKbGwntOHVJ6if5t5v+sPSAWAjgPs/5jU4r+sxsn3hW+927hIblfjtmxvaoXyzODTFoPqBh7T3fJ+fo8SNeQC9WjXH7fHv0EKt/g0/5O1a
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Get existing suspension records for this company. A company may have multiple suspension records if they have suspended their Gusto account more than once.
+
+>📘 To check if company is already suspended
+>
+> To determine if a company is _currently_ suspended, use the `is_suspended` and `company_status` fields in the [Get a company](https://docs.gusto.com/embedded-payroll/reference/get-v1-companies) endpoint.
+
+scope: `company_suspensions:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-companies-company-uuid-wire-in-request-uuid.ParamsDetails.json b/docs/api/get-companies-company-uuid-wire-in-request-uuid.ParamsDetails.json
new file mode 100644
index 000000000..9ff053362
--- /dev/null
+++ b/docs/api/get-companies-company-uuid-wire-in-request-uuid.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"company_uuid","in":"path","required":true,"schema":{"type":"string"},"description":"The UUID of the company"},{"name":"X-Gusto-API-Version","in":"header","required":false,"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.","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"}}]}
\ No newline at end of file
diff --git a/docs/api/get-companies-company-uuid-wire-in-request-uuid.RequestSchema.json b/docs/api/get-companies-company-uuid-wire-in-request-uuid.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-companies-company-uuid-wire-in-request-uuid.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-companies-company-uuid-wire-in-request-uuid.StatusCodes.json b/docs/api/get-companies-company-uuid-wire-in-request-uuid.StatusCodes.json
new file mode 100644
index 000000000..3d811a506
--- /dev/null
+++ b/docs/api/get-companies-company-uuid-wire-in-request-uuid.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"Example response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","x-examples":{"example":{"uuid":"05ed3150-591e-4f8b-bfd5-55d478edd2d8","status":"awaiting_funds","origination_bank":"JP Morgan Chase","origination_bank_address":"1 Chase Plaza, New York, NY 10081","recipient_name":"Gusto, Inc","recipient_address":"525 20th Street, San Francisco, CA 94107","recipient_account_number":21911761,"recipient_routing_number":123454321,"additional_notes":"Additional Notes","bank_name":"JP Morgan Chase","date_sent":"2024-06-10","unique_tracking_code":"1trvxwxp57zf","payment_type":"Payroll","payment_uuid":"5faae454-e629-490b-a72a-c022c2c9e6bc","amount_sent":"1014500.00","requested_amount":"1014500.00","wire_in_deadline":"2024-06-21T18:00:00Z"}},"description":"Representation of a wire in request","properties":{"uuid":{"type":"string","description":"Unique identifier of a wire in request"},"status":{"type":"string","description":"Status of the wire in","enum":["awaiting_funds","pending_review","approved","canceled"]},"origination_bank":{"type":"string","description":"Name of bank receiving the wire in"},"origination_bank_address":{"type":"string","description":"Address of bank receiving the wire in"},"recipient_name":{"type":"string","description":"Name of the recipient of the wire In"},"recipient_address":{"type":"string","description":"Address of the recipient of the wire in"},"recipient_account_number":{"type":"string","description":"Recipient bank account number"},"recipient_routing_number":{"type":"string","description":"Recipient bank routing number"},"additional_notes":{"type":["string","null"],"description":"Notes for the wire in request"},"bank_name":{"type":["string","null"],"description":"Name of the bank initiating the wire in"},"date_sent":{"type":["string","null"],"description":"Date the wire in was sent"},"unique_tracking_code":{"type":"string","description":"Include in note with bank to track payment"},"payment_type":{"type":"string","description":"Type of payment for the wire in","enum":["Payroll","ContractorPaymentGroup"]},"payment_uuid":{"type":"string","description":"Unique identifier of the payment"},"amount_sent":{"type":["string","null"],"description":"Amount sent through wire in"},"requested_amount":{"type":"string","description":"Requested amount for the payment"},"wire_in_deadline":{"type":"string","description":"Deadline to submit the wire in"}},"title":"Wire-In-Request"}},"examples":{"Example":{"value":[{"uuid":"c5fdae57-5483-4529-9aae-f0edceed92d4","status":"awaiting_funds","origination_bank":"JP Morgan Chase","origination_bank_address":"1 Chase Plaza, New York, NY 10081","recipient_name":"Gusto, Inc","recipient_address":"525 20th Street, San Francisco, CA 94107","recipient_account_number":21911761,"recipient_routing_number":5773243,"additional_notes":"Additional Notes","bank_name":"Chase","date_sent":"2024-06-10","unique_tracking_code":"1trvxwxp57zf","payment_type":"Payroll,","payment_uuid":"5faae454-e629-490b-a72a-c022c2c9e6bc","amount_sent":"1054693.52","requested_amount":"1054693.52","wire_in_deadline":"2024-06-21T18:00:00Z"}]}}}}}}}
\ No newline at end of file
diff --git a/docs/api/get-companies-company-uuid-wire-in-request-uuid.api.mdx b/docs/api/get-companies-company-uuid-wire-in-request-uuid.api.mdx
new file mode 100644
index 000000000..d79e9d280
--- /dev/null
+++ b/docs/api/get-companies-company-uuid-wire-in-request-uuid.api.mdx
@@ -0,0 +1,71 @@
+---
+id: get-companies-company-uuid-wire-in-request-uuid
+title: "Get all Wire In Requests for a company"
+description: "Fetches all Wire In Requests for a company."
+sidebar_label: "Get all Wire In Requests for a company"
+hide_title: true
+hide_table_of_contents: true
+api: eJztWN9z47YR/ldQ9CHJDGmRtGhbfKrnfLlRZ3r12HdNU8ejQMRKQkwCPACUrWj4v3cWhCRSP2Lnmr506hdTwO63i8XiA3bX9CWc18aqUEgLc82sUDK0qwpo9kChnALnwOljQC2bGxz7QWggY0nu4EsNxhqcUxW0mmNOMzoHG+aqrJgUYPzXalLXgofPQsNEyIluld0gDSgHk2tRIQLN6Pdg8wUYwoqC7FsjM6UJIx707Cf5kzS5qiAjP1dspVVRmEwD4z/TgFZMsxIsaPR7TSUrgWa06w8NqECLFbMLGlD0SmjgNLO6hoCafAElo9matgGhxmoh57TZ9/jTAsjnz+MbombELmDjHm2Crdl/hh9cmK9vx+E/QBtU9NYXwDjonv0ZKwzsW7nBtZRCgnFGOLMQTpkBTq5vx2TZghJmjMoFs8DJs7ALslK1dgI5K4ozMp4RqSQQYUil1VJw4EErw6qqELnbxm8MeSiFFGVddrEfv11YW5lsMOAqN2cub85yVQ42eRL6PXDzA1aJ0GsKOf+zBww7w9+hG7UBfkZPRzugIOsSUy+JkjSMLsI4xaTjMGN1YWnWHW+aR4yjqZQ0YBAsiSL81w/l+xdWVgWQjSQNaK6kBWlRthOJwS8GFdaH3jGt2Qq30EJpOuNq+gvklgb0JYTWipv13/jpMi+jUQr8PE6jMB3FEA5nV9NwOuNpmKZ8eHkFnCf8CsNima0NGnxmwgo5n8xqyQ0NqNJiLqRzczJl8olm9K+35G9Kz5kk7xbMLWtfaMI412AQMG6FyG3BfmUB+QjP5EelnwLy8UcSR9FV7FIyF5UAaSc+j10WB2Qs897sDjVNUpJEdkHurQawAblnknyvmcyFyVVA3l2T0TCOLvvqea5qNFKXU9A0S+JRHF9exF0ZrWq3/I1MnJwP0+F5EgeUcS5whayYSGUx4PR6O0Q+uqGAuuX7ZRwGCo/TxLgMwIQauoSKaEBrKb7UMLGa5U9oP1ccEWKrly/PL1V6+evMkc2qRC99Fty2B6Ez4Xc9nTEGw3QYwkUyCoejaBqyy4SFeZQkeZKP4GKKkWWli4f3J47iYRpFZ1HkWQKMBT5phfbnNxzLgfFCSOisJ4k/xVdZFGVR9C/aHNDYHVQa0KRLFyQzRhCNCEm8VVyQRrq3os3rdlmHZ7aP/NnFkAgO0oqZAH0cvNml+2uI905uQ7geqMMVB6elAsnxt4algGcMcYUECHgJ5EzmUOA91xw7Vq/58pGVgJ6gNNGQg1gKOe85dgR3d2Zew79uBV83sX9a3+o4wmx1ezEd7+F+jc+n0fe93qeB14zcbVFdXLw68erNb7HH74T26h3oQ87ZQD7sMGVdFO1d1Qs7yruXTCcS3UPQYaq3g3b20rkspLCC2SNp0qG6N8PfMAs9d5+ZIQ6jOUWRr4V4LPOi5g4MI9g+V5zrVhGHRTx5oo0+wb6G/WlVuWh4rf1gd4hix9TvlESrVunbVuuDVnXlOKFP4l/Fdmi9s5wewb95F66dlos7sQut6vmif5L2r4bX09xrkFZjG6iOq4cXymuoN14SN9LU01LYfgo2AbXC4mvIlRPhWIZ3m+xvAtp9N73fvZuWrKjBPeX9XZqnM84gvQzT4dV5OEyTUThiDMJZBDwH4KOED///gjrNgenl5XkyPP+a99N/9dUU/GHPpnR4MTo/S5NTz6bO/JufTY+N+8MHvqmAPQEzq3DuqCJzKGO5rY37Qhi7UC1Ba+GCUQj3oIIXCxLLobZOfYIVzU6X5cH2HHTKcyw0N3r7Tm0V9p07rtR3cqfsnMXqqgS7UL7OdxtlFzSjg2U82Bb9g3W3ym4Ge2U/xsWAXm4q81oXWAb72pJVoi0tQw6lqy+P8Eup9mLb4oUuWVDPre4E8FHMW634b2BWOI3LN5DXWtiV8/xdu8zrPAdjrmuMxMNjV+oey8aWyY7IbnkUXdyUwPh7Cky7lkDfRw8RFrCEgrDaLvCGaStVZOr7lbFQ/icWWoQTBhpsWMyUQ/X07cgMewSYKb6t0SvIA4pNC/P32T3opcihsx+7/gGbqtoOnOCAo2msMEL3O1Qztw+ouu/sD1DkqnS3jPPjG0Pe+yNBPJW49gVXeV1uypo/+Vqf5e569Hx2s7FK7qBwcpikUDJRuITys3/Z5Q9Go1LGlkx2cD6AfUPfan8l61334Q/rfvl9t/BiB1XB2geCOxBrf2Yf6DJ2wfCnlgY02+uOHRzcx4AulLGovF5j8+mzLpoGh7/UoPFQPCJlaMGmRXtXc2Hw+0RTq7vyb+98/+s7cqqhdmJZm5aMk9gQFg08u/XW1OBzznfcfp97/+Ptt6OBbQN4vHe5jfPuHkHmqWxn7qCT1rtAPrz/RJvm3/yOw94=
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Fetches all Wire In Requests for a company.
+
+scope: `payrolls:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-companies-departments.ParamsDetails.json b/docs/api/get-companies-departments.ParamsDetails.json
new file mode 100644
index 000000000..9ff053362
--- /dev/null
+++ b/docs/api/get-companies-departments.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"company_uuid","in":"path","required":true,"schema":{"type":"string"},"description":"The UUID of the company"},{"name":"X-Gusto-API-Version","in":"header","required":false,"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.","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"}}]}
\ No newline at end of file
diff --git a/docs/api/get-companies-departments.RequestSchema.json b/docs/api/get-companies-departments.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-companies-departments.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-companies-departments.StatusCodes.json b/docs/api/get-companies-departments.StatusCodes.json
new file mode 100644
index 000000000..1a208eb85
--- /dev/null
+++ b/docs/api/get-companies-departments.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"List of departments","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","allOf":[{"type":"object","properties":{"version":{"type":"string","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."}},"title":"Versionable"},{"type":"object","properties":{"uuid":{"type":"string","description":"The UUID of the department"},"company_uuid":{"type":"string","description":"The UUID of the company"},"title":{"type":"string","description":"Name of the department"},"employees":{"type":"array","description":"Array of employees assigned to the department.","items":{"properties":{"uuid":{"type":"string"}}}},"contractors":{"type":"array","description":"Array of contractors assigned to the department.","items":{"properties":{"uuid":{"type":"string"}}}}}}],"title":"Department"}},"examples":{"Example":{"value":[{"uuid":"56260b3d-c375-415c-b77a-75d99f717193","company_uuid":"7087a288-8349-4632-b92e-bc94fb79f29e","title":"Stage Hand","version":"d90440dd464601d1c8f4e9e240dfb7a6","employees":[{"uuid":"41199375-a999-4414-9f40-d9bf596b134d"}],"contractors":[]},{"uuid":"ec5c8a85-3233-4f39-a9f5-fb1ab7b5f5f3","company_uuid":"7087a288-8349-4632-b92e-bc94fb79f29e","title":"Actors","version":"34f39a30b45d077cb83aed2df4810d74","employees":[{"uuid":"7ee4aca1-814b-4034-b0f8-07f93cc679d1"}],"contractors":[]},{"uuid":"1802465d-4f68-4865-920c-1307ab095f12","company_uuid":"7087a288-8349-4632-b92e-bc94fb79f29e","title":"Band","version":"1fe3076d35ef7c97d0ae68c5f4df0acd","employees":[{"uuid":"a73955be-c009-44dc-915e-6246e2bdedbb"}],"contractors":[{"uuid":"3488549f-60e4-494f-a34a-9d8aad3aabf5"}]}]}}}}},"404":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided UUID is valid.\n"}}}
\ No newline at end of file
diff --git a/docs/api/get-companies-departments.api.mdx b/docs/api/get-companies-departments.api.mdx
new file mode 100644
index 000000000..dbbf893fe
--- /dev/null
+++ b/docs/api/get-companies-departments.api.mdx
@@ -0,0 +1,71 @@
+---
+id: get-companies-departments
+title: "Get all departments of a company"
+description: "Get all of the departments for a given company with the employees and contractors assigned to that department."
+sidebar_label: "Get all departments of a company"
+hide_title: true
+hide_table_of_contents: true
+api: eJzdWN+P47YR/ldY9iE5wLQli7IsP3XbvV4XaJNDNpcU2DUaihzazEmiQlLOGob+94KUbMu768sd7qXo01oSOT+/mflmD/iJbFrrNFG1g41hTumauH0DePWAoSpACBB4glnTjI9YvJ5g3UD/dCfwCm/AEa6rhtUKLBHQMOMqqJ3FE9wwwypwYCxePRxwzSrAK9yf3v+nbZVXoWq8wg1zWzzBBn5rlQGBV860MMGWb6FieHXAvW3YOqPqDe4mWIDlRjXeDrzCP24Bffhwd4u0RG4LaNCBu8lJ7b/Ju+Dxzfs78hMY6y8O2rfABJgL/ZKVFp5rufW+VKoGG5QI5oAUzIJAN+/v0K4Xipi1mivmQKDflduivW5NOMBZWU7RnUS1rgEpixqjd0qAmPRnWNOUiofQfmPRQ6VqVbXVWPb6261zjV3NZkJzOw0pnHJdzY4pIw3bG12W4fuMNYoMN1W9+fMgkIxev/FmtBbEFF+P9gRD3VYeGfNonpJoQeLUA0GAZG3p8Gr8vuvWz8P2DhxiZXnMzQgjSGqDGNqoHdTHnPVB8wehakq9B7CI1QJxXTvDuNPG+hCrTQ0COY3clrmRzOlj/VhbrhtYoV9GqlYGmPgl5Ng2urZgvaPzKPJ/Lu39p7LOG3sJZq8fauePjxI1+9X6O4eXwWPGsL1HmIPKjt7r4lfgztdWWX4vQ2E8/9IYX2NO9TYOqXotLy+LgLfGQO1OYBxi3oueonuA8PxwhgXatErAFyJLCaga7aDm+zchiaqW2lQhJEjXaKt/97lprVenLJIKSjHFXTfBTrnSOzHUICtKCGX66SCEZvFZERi3gXMGfcu4aDxfLOvcUo4u/JGE71gFr1tyQvYreLmUcePfeiGjYrgA/1j0dAy3z4lf13Vdj+yhsj7fnuvl+NUWhRZyhMntKHA+ck+saspewtv+d6gRVrYQaqkXi9PFfBEViSA8yVJC45STIssYyVKR5zKLszhP8HNI4CxaZmy+XJJlQnNCF8mcFPkcSMFzKossl/Mc8Nm2e8c2gP7Baj/HTmWKRR5RGglBF3QRxSLmS0khhzmNhCwytsAXADjbTOM4z725LM9zQmlMSS5pREReyDRfFHFCBfaxuUjYw9pXzyACeMqXbJmSZJ4khMokJyyXKZFFzIqsSGUqv97tm17z2OXEq2JJVNBURFnGi2XCQMyFpMs4Ehm95nIGQBlnMVnGtCA0SigpIrkkUSbzhPNFlov4D1yOl9GcLlJBqFwsCV0uUpLPI07iJMpYEeWpjOdf7fJfn+c4lpBE2UIkKciM55mIGCyWPJVUyIhxcc1hliV5mhZAeBT5HAtO8jgFspjTBcwLAaIoXnH4dD+hy2VKc0kWEVBCcyoJSygjuVgyJhLGCpnibt2tu762aURfDrjvtEN/120t0GON0GPtW52nPmA9aTFgdWs4IKHBolo7BE/Kuin6F/sIyLamHyFH8tI3SWXRjpVKTB/rvsuzjbd7VL6BOz4R2wD7CMzuiedlRO/AGCWgZ5I3ZekD9+SgtoFues8/wh6vrhPWyan4P01cPWSOoq4ZcZJ1NMZnogK31QPVDaTWbfEKz3bx7MR7Z4cxvLrZJXOwYHZHDtya0hPOYdayRvWjlgiowrx90XBvodL4MnC9PBLw4O+F8XlF8Ksy3xstPiGz8Z+95xZ4a5TbB8v/1nt4wzlYe9P6IDysx6fuPQPqO/MrZ0+N3pt4JJv+uQBmAvm+tHEQQUrYQYlY67ZQu4F0+RF6v7cOqq/R0Eu4oqDzq4HUQerQA8L64Nn4RSMYUd8J9uuB/V7eg9kpDqN8nPkUK3TrZuHgTHjVfiaS8Ey0DHnwV58b+zOUXFfgJ2yw4xuL3g5oR+97ZhYWBaF563EX3PjTQFsZD7R1WIRuj1rRD1AO1eG7FVNlANTw9S9n/PhoNNq6itUjOUdaP+bzWiJ2YkrPfDicKfT/2Eow4MbBk5s1JVMBYKGgDkO5P+BdfBoinsBM8OrZHisuO91WW+fvHQ5+Q/xgyq7zr39rwfh6WvtWY1Rgv766hLL+95XNcxy6b38YltQ36BpFveLRkdiFE8dGhydDV7xwp1t3k+Na/GXm/Z/vyK8Gtg/g6/9gOMX5PH9802rc6NuLffJi7Lx7+yPuuv8CgdsGuw==
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Get all of the departments for a given company with the employees and contractors assigned to that department.
+
+scope: `departments:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-company-notifications.ParamsDetails.json b/docs/api/get-company-notifications.ParamsDetails.json
new file mode 100644
index 000000000..fc32df9b3
--- /dev/null
+++ b/docs/api/get-company-notifications.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"company_uuid","in":"path","description":"The UUID of the company for which you would like to return notifications","required":true,"schema":{"type":"string"}},{"name":"status","in":"query","schema":{"type":"string","enum":["open","expired","resolved"]}},{"name":"X-Gusto-API-Version","in":"header","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"},"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."},{"name":"page","in":"query","required":false,"description":"The page that is requested. When unspecified, will load all objects unless endpoint forces pagination.","schema":{"type":"integer"}},{"name":"per","in":"query","required":false,"description":"Number of objects per page. For majority of endpoints will default to 25","schema":{"type":"integer"}}]}
\ No newline at end of file
diff --git a/docs/api/get-company-notifications.RequestSchema.json b/docs/api/get-company-notifications.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-company-notifications.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-company-notifications.StatusCodes.json b/docs/api/get-company-notifications.StatusCodes.json
new file mode 100644
index 000000000..3c29bf3ff
--- /dev/null
+++ b/docs/api/get-company-notifications.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"successful","content":{"application/json":{"schema":{"type":"array","x-examples":{"success_status":[{"uuid":"d053ee2a-a80f-4a61-8bf8-6122c1f954dd","company_uuid":"46c8329d-ebd1-49ba-878c-810b481a34c9","category":"company_setup.missing_mandatory_sick_time_policy","title":"Set up a sick time off policy","message":"At least one company work location requires businesses to provide a sick time off policy.","actionable":true,"can_block_payroll":false,"published_at":"2025-06-09T13:42:59.000-07:00","due_at":null,"status":"open","resources":[],"template_variables":{}},{"uuid":"2edd148b-c4c3-4cda-b3e1-72b87399e6c8","company_uuid":"46c8329d-ebd1-49ba-878c-810b481a34c9","category":"bank_error.compensation_credit_failure","title":"Unable to deposit funds to Donn Cormier","message":"We were unable to deposit a recent paycheck to Donn’s bank account, so these funds of $100.00 will be returned to Luettgen-Gusikowski’s bank account. Once the funds are received, the payment should be made directly to Donn.","actionable":true,"can_block_payroll":false,"published_at":"2025-06-09T13:43:00.000-07:00","due_at":null,"status":"open","resources":[{"entity_type":"Employee","entity_uuid":"66a27bb8-be5b-42e5-82b8-b2d0044a7f9e"}],"template_variables":{"beneficiary_name":"Donn Cormier","amount":"$100.00","company_name":"Luettgen-Gusikowski"}}]},"items":{"type":"object","properties":{"uuid":{"type":"string","description":"Unique identifier of a notification."},"company_uuid":{"type":"string","description":"Unique identifier of the company to which the notification belongs."},"title":{"type":"string","description":"The title of the notification. This highlights the actionable component of the notification."},"message":{"type":"string","description":"The message of the notification. This provides additional context for the user and recommends a specific action to resolve the notification."},"status":{"type":"string","description":"Represents the notification's status as managed by our system. It is updated based on observable system events and internal business logic, and does not reflect resolution steps taken outside our system. This field is read-only and cannot be modified via the API.","enum":["open","resolved","expired"]},"category":{"type":"string","description":"The notification's category."},"actionable":{"type":"boolean","description":"Indicates whether a notification requires action or not. If false, the notification provides critical information only."},"can_block_payroll":{"type":"boolean","description":"Indicates whether a notification may block ability to run payroll. If true, we suggest that these notifications are prioritized to your end users."},"published_at":{"type":"string","description":"Timestamp of when the notification was published."},"due_at":{"type":["string","null"],"description":"Timestamp of when the notification is due. If the notification has no due date, this field will be null."},"template_variables":{"type":"object","description":"An object containing template variables used to render the notification. The structure of this object depends on the notification category. Each category defines a fixed set of variable names (keys), which are always present. The values of these variables can vary depending on the specific notification instance.","additionalProperties":{"type":"string"}},"resources":{"type":"array","description":"An array of entities relevant to the notification","items":{"type":"object","properties":{"entity_type":{"type":"string","description":"The type of entity being described.","enum":["BankAccount","Contractor","ContractorPayment","Employee","Payroll","PaySchedule","RecoveryCase","Signatory","Wire In Request"]},"entity_uuid":{"type":"string","description":"Unique identifier of the entity"},"reference_type":{"type":"string","description":"Optional. The type of a resource that is related to the one described by entity_type and entity_uuid. For instance, if the entity_type is “BankAccount”, the reference_type could be the “Employee” or “Contractor” to whom the bank account belongs."},"reference_uuid":{"type":"string","description":"Optional. Unique identifier of the reference."}},"required":["entity_type","entity_uuid"]}}},"required":["uuid","company_uuid","title","message","category","actionable","status","published_at","due_at","resources","can_block_payroll"],"title":"Notification"},"title":"Notifications-List"}}}}}}
\ No newline at end of file
diff --git a/docs/api/get-company-notifications.api.mdx b/docs/api/get-company-notifications.api.mdx
new file mode 100644
index 000000000..9a37ead9b
--- /dev/null
+++ b/docs/api/get-company-notifications.api.mdx
@@ -0,0 +1,71 @@
+---
+id: get-company-notifications
+title: "Get notifications for company"
+description: "Returns all notifications relevant for the given company."
+sidebar_label: "Get notifications for company"
+hide_title: true
+hide_table_of_contents: true
+api: eJzdWetuG7kVfpVTtkB2AY0sy5fY+lU3SRcGFrtGLk2BrKHlkGckrmfIWZIjWzUE5DUK7L5cnqQ4JEeakeTEyab90V82RfLwXL9zmXtmarTcK6MvJZuwGfpMmKrmeplp41WhRNh0bMAkOmFVTUs2YS/RN1Y74GUJvZNgscQF1x4KY8HPEWZqgRoS2eFP+ifthKlxAj/3Lk4scvkzGzDPZ45N3rEfegxcD9hdNmucN5nSHmeR68wva6TDWOUoJUo2YLyuu0fC1ZpbXqFHS5TvmeYVsglLPE2bRtFFRYLV3M93pH09R3jz5vI5mCKIlC4GEW/nSsxhaRq4NU0poVQ3CN6ADRqCbTVa/LVRFiWbeNvggDkxx4qzyT2LojDnrdIztloN1nw6z33jWg5/bdAu2cM3Bwx1U5FSTI2alnd1eJEed6ZcoGTXXfL/zL4Ler24usz+gdaRzOmtOXKJ9lGPjUfjk2x0mh2ekMIlFrwpPZt0f19t6/U5maRSGl1Qq+Qes5w7lHBxdQmLyAtw54xQ3KOEW+WDrm04IHhZDuGyAG00gnJQW7NQEuUgnuF1XSbVP3HwrlJaVU3VpX39zdz72k0ODqQRbhj8ayhMddD6U1bzpTVlGfYPeK2ydFPp2Z8Twazz87fERuNQDllHwzWf4bb5No5Q8NLhPpeja+Dn3BNROo/OoxzC2zlqaLSrUahCkbi3qiyhNFyGgDT5Lyi8g0aX6ByglrVRMSIFOiKrdNDKcJ9lQ+yg7XlgHZzgc/j/oalytBQwLTc12iDREP5uLFT8F2OVX9KJlkEX5Ui+Q0E0Pvk4h9cD5lA0RCgE9rMYmBdCoHMXjZ+zybvrVQc7rLvlszb2LLraaIeOaI9HI/rTl8I1gVLRlGzAhNEetadTHc86+MXR0ftdNrm1nDR1l+Edr+oyvpNITlNQE9cBfyZMjk6OEMc842ejIjvmp4fZWV6cZaeH47E4LM5PjqUMbHRQa8KOT8XZ0fhcZpjLw+z4POfZ2dMzkZ0djvLjs0N+dCzO6Rb3ODN22YE9h76ph5VyTunZtOJacm/scuqUuJl6VeG0NqUSJIJXviSRXqGHpgYOdAboDJiigPW5Cp0jX5+wCw8lcueBQrPFy1tjb6A0UXGQPMhB3jjCAEcwYNogfuARclku6D7PiaVoScH1NC+NuJmmeF17Zd3kpXJzlFPeRaPR+evDo8nxeHJyPhyNRtno6WQ0ItxvMBzUTVkOWuCdtEhK+NlQDJFbDZjHqi65x+mCW0XskIFD2CTbjFHKw+OzPBPH4ig7FpJn+REeZk/H+dnTo/NzPBVnX8OiOdc3U7TWWAKvGrULGp4Ki1L5acFV2Vjs2PFN0B5pW2JtnPJQNFoG9T83WsMzYysVYn5j0bcIt2gRmp27HCwK1B5qvhRzJKNFOh/e/9sBMQdcCNNoPwBnCOodpgdNAX85HI2Go1GM/RxT4kRJRL5v0PsZaspQ6sbcuhu1Q3MIP2qBIYFEmtxiYEgtCBp9ANJlRfy5eUjROULFJYJUFoUvly27X9e3jiZBri/xrXuG2iu/nCYkeVHVpVkihnQbNpKrnJ7y8dM8P8tyPMmz4zGeZGdjWo7laHR8zJ8W58hWD7kqy1FjoYTidjlNSL9lfl6RitmEJSt1vDVd2GMiAubVgCmPlevgYUwEbMBqS2WnV5GJKMpuYdFH4jda/dogKEkKKFRMLbxXXlHK3YqlL6LarfC8SQUe/dh9DHIsjZ658GgKq0+9Rjk9HG1f6XEPr+fKwVzN5qWazX0siTbuGFgymtx4321iYx2rj2EkHf4IKwmIHXApVWCjhJAD7zbFfePQAteSAs5UFYb4g1SZiMR+LIdD6bmf8TYWPsX3S6wtOtRJOV06TxxEKsAdVFzzGUrIl0B1oFs6j9UQLkMh1dQy1JKx0DQaTO7QLoKO40nARXiD5KJaw5LkbZKC0syUGIRNadARF2CxKFH4KGUTZHYeawee36AG03hHKa3LTFBxobCUsbrjMjO6XAa6gmuiSjhlZCjxYKF4kPni6nK4W+KvC/tNtU8RuEkRj/GILXW2l4OFurC4ppUbUyLXO8QutSQy6OB2jn5OHtKPnXXmT/5hLO2HUj5C6264rZ1RWOWV4CUoXRhbxV3SXAz/XbD+4+xWfAmBKPBclVS0kkM3GtIbgfGQLOAWwTWzGTofC/eY6/odMuWn2ioqf9W/Yp4L7QpqGeIpYko/uXzSfqpC53lVUzzfUn+wo8Fb7mBNNDzRJqSW+LsNdcpRsY/7zFeUA9lg1Mj23pxTtNB+aPXIyusYaLM/PRwxdW/G2k4lff4udOo2Ak5xRV0atIRgTSg0aBGUtES7F/8QnLeN8I1NEKlcS1tiHXDO7BF/HTTwgov5ekk9TWhzORTqDiU4DDDesgSUTB18c4NL9+0gpRzyE17e8iVBcYC9yNiClw26BNyuK5fgmlbLxCJJn5hcI3LfWNp5rgWGwmcN8le99LwzluhWKju9zo49wkZs8rwimpsBkTc7+mOPrhp6BdKjEu+yxjUfS8iRtBOP5RQPG0z9G9c3F7G2ZAP2zGhvufDG9hZXsaRkg25xdpUwJ/z3SsxRNiX9/hKFWaBdPuOOlq/UTIdWiw3YW2URLjW8jO19gO1ejffFJUykwoLBCrSoBT5SXT/W0RGiu7WK49AavjOTKEMqTZakVm+tUUq+HSOFvNYRLE4BWgccgOoyHW8oBx/e/9axxof3v8fM0BcIRFvV096H97+1Fvnw/ndKLR/e/7axG/0WijpThePdTqJX023eeJwdNkp70CJrksMUR+0E5V3PnfsOcL3aPpvGlVvTy1iDborATvbvpe/BZpzYSzHrdNAN8H0J9XrTRnZHtJ06uD+6zb5XzrPVKsiBdx61C7NQanNukNrXBwe7Axaw7pMDXmq5+6TinGd9n5IztUEV+rlJk25SAA17J+xgcXgQtanQHdx3Fbs62B7gUq3YzpEbW9KQNI0Qea3iBDGTWIUx4o6TPMfKhImQq5HfIHfLLNLL4gSItsP8YD/hvTSvrJEfoVnTdndQRrhURRDdMy5buzk93g7fQvWE3IaWsP96IpGVuMASeOPn5Lwbl3gVyt0/8kKk8MAD1GbqwgSqyfnCMJvqZDJ/Gmf3xtBUW9jK/Vi8QrtQAjua3gyAeW4afxAOHkh6mpJPFtaZKYKG6eo2s2+xFKYK05HAxxMHL5LnQsoOYf4sjWgofwQx/pSGi1yEYqztxNtX4SXBbHI/rLgqg6uk3b9uPIO0URvnK647dL5Dv1WAUvOWnHxbgPvNlPO/+o0negC1kgd1yVVwleD09yko37HF4RrkVICiyRbi6e0PRHPjPN28v6fe7o0tVyv6OU6sKV6lcoSBm5l1BI01ICa0YCEGdw4/qKj/2ax+r9qiDOkTwxdK8BWn9R/jMUT3hsVrWsTadb95HuT3m5cpH34LX/Hb3F7W2wI3xMqa91aknkuGqVf6ZPZ58vxffwj7qE/s//jYc+N4kFJI7Tt7O99gegn+uxevqVToZ5x1hkn/kJH22vf+Pp54bW5Qr1Zrc3tak51Xq/8AGr4AaQ==
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Returns all notifications relevant for the given company.
+
+scope: `notifications:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-department.ParamsDetails.json b/docs/api/get-department.ParamsDetails.json
new file mode 100644
index 000000000..c2fb5baa0
--- /dev/null
+++ b/docs/api/get-department.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"department_uuid","in":"path","required":true,"schema":{"type":"string"},"description":"The UUID of the department"},{"name":"X-Gusto-API-Version","in":"header","required":false,"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.","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"}}]}
\ No newline at end of file
diff --git a/docs/api/get-department.RequestSchema.json b/docs/api/get-department.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-department.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-department.StatusCodes.json b/docs/api/get-department.StatusCodes.json
new file mode 100644
index 000000000..96736bb54
--- /dev/null
+++ b/docs/api/get-department.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"Department Object Example","content":{"application/json":{"schema":{"type":"object","allOf":[{"type":"object","properties":{"version":{"type":"string","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."}},"title":"Versionable"},{"type":"object","properties":{"uuid":{"type":"string","description":"The UUID of the department"},"company_uuid":{"type":"string","description":"The UUID of the company"},"title":{"type":"string","description":"Name of the department"},"employees":{"type":"array","description":"Array of employees assigned to the department.","items":{"properties":{"uuid":{"type":"string"}}}},"contractors":{"type":"array","description":"Array of contractors assigned to the department.","items":{"properties":{"uuid":{"type":"string"}}}}}}],"title":"Department"},"examples":{"Example":{"value":{"uuid":"56260b3d-c375-415c-b77a-75d99f717193","company_uuid":"7087a288-8349-4632-b92e-bc94fb79f29e","title":"Stage Hand","version":"d90440dd464601d1c8f4e9e240dfb7a6","employees":[{"uuid":"41199375-a999-4414-9f40-d9bf596b134d"}],"contractors":[{"uuid":"3488549f-60e4-494f-a34a-9d8aad3aabf5"}]}}}}}},"404":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided UUID is valid.\n"}}}
\ No newline at end of file
diff --git a/docs/api/get-department.api.mdx b/docs/api/get-department.api.mdx
new file mode 100644
index 000000000..91f325b48
--- /dev/null
+++ b/docs/api/get-department.api.mdx
@@ -0,0 +1,72 @@
+---
+id: get-department
+title: "Get a department"
+description: "Get a department given the UUID"
+sidebar_label: "Get a department"
+hide_title: true
+hide_table_of_contents: true
+api: eJzdV9ty2zYQ/RUUfUgyQ+hKXcineuo09UMTT5y0nbE1CUgsJSQkwACgYo2G/95ZkJIo2cql6VOfbJLAwdnFnt2jLb1ny8o6zaRysDTcSa2Y25RA41sKRQJCgKAB5WXZXWLpIqC6hObpStCYLsExASU3rgDlaEAdX1pEudy/9LsE2NTIEvfRmL4ARzg57CNLuQZF3ArI27dXl3fqTtlUlxCT94dFNjbAxfs7RQNacsMLcGDwrC1VvAAa08Pad1UlMQCJp5XcrWhADXyqpAFBY2cqCKhNV1BwGm9pEzm1zki1pPUp2zctLaIzT7ETbx3sD/+bvfApvbi+Yn+Csbi3JbACLsAcUch4buH0oEuMqJAKbHMOd8ASbkGQi+srsm5ACbdWp5I7EOSzdCuy0ZXxC1Ke5z1ylRGlFRBpSWn0WgoQQbOGl2UuU393Tyy5LaSSRVV0sRdPV86VNu73hU5tz9dIL9VFf1cTrOQbo/Pcf+/zUrJ2p1TLn1tA1nn9DGlUFkSPnk94QEFVBRbNaDCasMGUDSdNzWS8yh2Nu+/reoF5tKVWFiyCjQYD/HOayn1tvUo+QOrI83telDnQgKZaOby8eEs7Kel/sLhz+5Cm9gAohzx/lfmCO/1SGpSFkw2jNvjHIn1YWWllDNLcXW9bZA10j9wA+OfbQ6LJspICvvOupICi1A5UunlGMm2IVJk2hQ+daEVW+jNxGu+KuJW0JJOQix6t64A66XIMoq1qnuTgC//LSfAK/KYMnNUWTXVRcrV59++w2t30EMLXEF7yAh5nAkWZ6w00obUg3Bi+eYBxgW8RZL8FFSuXCgQm+BgaZSEdFB72W/JX13XdVLDhqdPmO/h0Nv3XjLwod2VyeZy4RnYeYCdBlAjPKziA0sl0NB0kY8HS8WzCwuEkZclsxtlsIqIomw1nw2hMTwuCzgbzGR/N52w+DiMWTscjlkQjYEkahVkyi7JRhILfMbtxfAnkd65wNOxFSkU0CMOBEOE0nA6GYpjOsxAiGIUDkSUzPqVH13+75xwOh1GEdHkURSwMhyGLsnDARJRkk2iaDMehoJiZo+s67B+H8/kkjDI2HUDIwijMGB+HnEVizrkYc55kE1ovmgQHNByED/vcS+3Ib7pSgtwpQu4UagCnDFicDwasrkwKRGiwRGlH4F5a1yN/8I9AbGWa3rKbE416pCVrnkvRu1Ne/vfMlsA/ArcbhrOO6TUYIwU04x+zc+9AWW8QMLyPsKHxeYsR7C7/K1YDW8wO6hyDPZZngrkuwK202FPzsz+m/fWw33ES/e2JVahxPIFZ7wxFZXKc222D5aVs+isTUPgm+0Bll1BoepyrBo/5q8Z9vmeeAX4U89po8QXMEj9jyBbSyki38cx/bRRykaZg7UWF0d8uuqtucLw1enxk7V7dSHE3s/E5AW68hznm2EKwHNaQE165FSjXTlSU/83GOih+5IQG4cwBNTqsTHvUVuTehaGpOdJ4x0EEFF2WfZXdgFnLFDr3cRiiPNGV6/uFfYFHYyNk/pnpzN8Dbj0l+xfkqS4A26rn8cSS522Nk+tmHHu/JXRaYfH5MH5qPQlPvSdp/eTl7lTyGvJWE9iIuMx9QbVffznUD2aj1NYVXHVwTr32KeftwQ/9uC9vr9bBveuXOZe+BnzNb1sp3tL10FM4/DwIaHzq3BcBXWnrcPl2ixb4rcnrGl9/qsBgpS9Q+kZ6M4J1L6TF/89Y626QT1+3LvwZ+YL7OBPLbtSqTaf30KBtVKdh1Is62Ln/7yP5P/8p8Ghumxw+/jtqn+rDVMCmUrrOtwdm/mgevHj+htb1PzboK88=
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Get a department given the UUID
+
+scope: `departments:read`
+
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-employee-ytd-benefit-amounts-from-different-company.ParamsDetails.json b/docs/api/get-employee-ytd-benefit-amounts-from-different-company.ParamsDetails.json
new file mode 100644
index 000000000..7ac9d07b1
--- /dev/null
+++ b/docs/api/get-employee-ytd-benefit-amounts-from-different-company.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"employee_id","in":"path","required":true,"schema":{"type":"string"},"description":"The UUID of the employee"},{"schema":{"type":"integer","minimum":2000,"maximum":2999,"example":2024},"in":"query","name":"tax_year","description":"The tax year for which to retrieve YTD benefit amounts. Defaults to current year if not specified."},{"name":"X-Gusto-API-Version","in":"header","required":false,"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.","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"}}]}
\ No newline at end of file
diff --git a/docs/api/get-employee-ytd-benefit-amounts-from-different-company.RequestSchema.json b/docs/api/get-employee-ytd-benefit-amounts-from-different-company.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-employee-ytd-benefit-amounts-from-different-company.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-employee-ytd-benefit-amounts-from-different-company.StatusCodes.json b/docs/api/get-employee-ytd-benefit-amounts-from-different-company.StatusCodes.json
new file mode 100644
index 000000000..5e9b90d75
--- /dev/null
+++ b/docs/api/get-employee-ytd-benefit-amounts-from-different-company.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"List of Ytd Benefit Amounts From Different Company List","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","description":"Ytd Benefit Amounts From Different Company","properties":{"uuid":{"type":"string","description":"The unique identifier for this benefit amount record."},"benefit_type":{"type":"integer","description":"The benefit type supported by Gusto. See [Benefit Types](https://docs.gusto.com/embedded-payroll/reference/get-v1-benefits) for more information."},"ytd_employee_deduction_amount":{"type":"string","description":"The year-to-date employee deduction made outside the current company."},"ytd_company_contribution_amount":{"type":"string","description":"The year-to-date company contribution made outside the current company."}},"required":["uuid","benefit_type","ytd_employee_deduction_amount","ytd_company_contribution_amount"],"title":"Ytd-Benefit-Amounts-From-Different-Company"}},"examples":{"Example":{"value":[{"uuid":"c5fdae57-5483-4529-9aae-f0edceed92d3","benefit_type":1,"ytd_employee_deduction_amount":"5000.00","ytd_company_contribution_amount":"2500.00"},{"uuid":"1bfdb946-b2be-4909-ac46-9e7f73872d0a","benefit_type":5,"ytd_employee_deduction_amount":"2132.00","ytd_company_contribution_amount":"3345.00"}]}}}}},"404":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided UUID is valid.\n"}}}
\ No newline at end of file
diff --git a/docs/api/get-employee-ytd-benefit-amounts-from-different-company.api.mdx b/docs/api/get-employee-ytd-benefit-amounts-from-different-company.api.mdx
new file mode 100644
index 000000000..60726fbc6
--- /dev/null
+++ b/docs/api/get-employee-ytd-benefit-amounts-from-different-company.api.mdx
@@ -0,0 +1,74 @@
+---
+id: get-employee-ytd-benefit-amounts-from-different-company
+title: "Get year-to-date benefit amounts from a different company"
+description: "Retrieves year-to-date benefit amounts that were contributed at a different company for the specified employee."
+sidebar_label: "Get year-to-date benefit amounts from a different company"
+hide_title: true
+hide_table_of_contents: true
+api: eJztWF1v2zYU/Ssc99AEEG3FsZvaT8uWrAiwjyBJtxVJ4NLiVcxWIlWScm0Y/u/DpShZsZ3E3YY9DMtLIJG6vB/nnnvoJZ2zh9I6zaRy8GC4k1oxtyiAjm4p5BMQAgSNKC+K9hZL7yPq+IPFbed5kekFAPkeFKTS+UVdQLX1QtARfQDHIGxjCyfYpNrKeK5L5SxLjc6ZkGkKBpRjic4LrhY0ogJsYmSBluiIXoEzEmZgyQK4YU4zwR2QYI0Ea8RNuSNfwABJtHJGTkoHgnBHOGnOIOEMkmpD3BSILSCRqQRBak87d+oKXGmU3Tqh/sjA5xIsWnd87p0iBwJSXmbohiZJafxhfkWmRGm3Puiwc6fu1M1UWgJKFFoqR7TKFsSWRaGNs8RU8Ur1QHTprBStiLAM3o9+fHTw6bB20XqjNtEFjMiHOpRxvToywMUHGtGCG56DA4M1XFLFc6Aj2uyXWHWJOS+4m9KIYqTSgKAjZ0qIqE2mkHM6WtIKLtQ6I9UDXW3W7GYK5N27izOiU5+y+gi6ipbbVjzIwNCI5lLJvMzpqBfHcURzPg+Pw+EwojDneZEBrvb6q+Dq5xIMgiYE4/h8jInfghG61NQLU/hlKpMp1iskHMj7m7PNonfI2b6V7fjgght/sLe+xU4vL9hvYCz6EByeAhc+2HV2U55Z2HT4DAuVSwXWpxBBzybcgiCnlxdkVhkl3FqdSI5o/CLdlCx0afyGhGdZh1ygkwqItKQweiYFiKjaw4sik4lv11eW3IbMt23fH0ydK+yo2xU6sR3PGZ1E592aI1jBF0ZnmV/v8kKy8KVUD98Gg6z1+hDdKC2m6mksRRQUlvyW9uLegMWv2dEAySV0GB21369W95hHW2hlwaKxXhzjv8ep/Elah1B870RNWOQ0dPWPRufkrGGIHwJD4Cc0oth5oByabCWs+9Gi3R1Q5sZwRKN0kNvWez35CInbAuX+DmH3GiRYJ6tAy1KKXdnbRn2p5OcSiBSgHCLVBCaTmxRHDCTaeCDTsDKuzO9o1e1zamO4taYzEGSyIL4XOuQagNzW4d4sCrD7Q8yAz0cCXZwrs6N6mthDH02uDRCpUm1yXyEfw8KJcUNuAkSZ4NK4Cna/3D0aObUt0tgiORfQ0DS2aU0RYdI0foTncZvK/7on9RxrW9vHl1WbdW4rDG3U+qW0vRwOygTpkKcR3ywUnAV8M8Q3a/DNanyjb4HgPb7Pa7Jf0hnPSvATqwI9TQap4DA4YYP+m2PWH/SGbMg5sDQGkQCIYU8cb8Y1OnoREHQQx3EnjveIcUR7g2ovkn5w62iSismw/5pNehNg/WE8ZDzpv2ZDOElPjt+c9ETMt9wavOxW7+i4t69bx8f9gXfrfoV/Ee3H/W1C/EU78qMulSB3ihDUI21ZY8Dq0iRAhAbrhxzMpXUd8jP/hJ1tKnjVA6Wa9NKSGc+k6NwpX8s5swXwT8Dtgj0YXRYtpdGIxsfbcHYyPQNjpIBKQb53ImwO8EH0NOBZcyPMHSjrVSri5BMs6OhpnRs1kHpe72Jta1Ob0TQ2tqPa/dnj6Naf7x0lzroc3FQHde0FnZvSEe3Ojrq1F7a7bAm6VRchUyMuiJoxKu9xo4rHa+VtwcxqdViaDNVK4GdeyIqemYDcc/QWS51BrjcqWtljvjvwu6pbdhveafPSaPGMzQKXMS8WktJIt/Ceh4SdJglYe1piim7v27uucWxXNLNjb8PG6GKtVPB5AtzsmH3BBMtgBhnhpZvioK2UAtL/9cI6yP/OCZWFJw7wQjjV3mqgXT9vUcohzIL6fKSbIora0v6aXoOZyQRa9VjPYD7Rpev6jV2BR6P8YP6Z6dTXAT/ddPZ3yBKdA+pl78crS85Dk5HLapp7lSl0UuagnA/jm6C1eOLHYVDRZ/Wp5Aqy0JQRhZzLzAMqrH63xg9mo9DW5Vy17LwF9/zlERti10VxM7jlWhD+fy/95+6loRsczF23yLj0beNpYhko7pbOjnzpA8nRiI4e31u/gufuIzrV1qHV5RKvVO9Mtlrh6+oyiRwipOWT7KnLWRsH/8LF8okMVTOmdeOtR4qnxBk3EkP4ynAOroJAPCRP3uKf8Ke+A/m+aXyp/WyXa3W/iuqL8Ne59x+/FT9T590/KaxL3ogOnDSFa61t3VwfKYm35zd0tfoTJmYf2A==
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Retrieves year-to-date benefit amounts that were contributed at a different company for the specified employee.
+Returns benefit amounts for the requested tax year (defaults to current year if not specified).
+
+This endpoint only supports retrieving outside contributions for 401(k) benefits.
+
+scope: `employee_benefits:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-events.ParamsDetails.json b/docs/api/get-events.ParamsDetails.json
new file mode 100644
index 000000000..427f25937
--- /dev/null
+++ b/docs/api/get-events.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"X-Gusto-API-Version","in":"header","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"},"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."},{"name":"starting_after_uuid","in":"query","required":false,"description":"A cursor for pagination. Returns all events occuring after the specified UUID (exclusive). Events are sorted according to the provided sort_order param.","schema":{"type":"string"}},{"name":"resource_uuid","in":"query","required":false,"description":"The UUID of the company. If not specified, will return all events for all companies.","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"description":"Limits the number of objects returned in a single response, between 1 and 100. The default is 25","schema":{"type":"string"}},{"name":"event_type","in":"query","required":false,"description":"A string containing the exact event name (e.g. `employee.created`), or use a wildcard match to filter for a group of events (e.g. `employee.*`, `*.created`, `notification.*.created` etc.)","schema":{"type":"string"}},{"name":"sort_order","in":"query","required":false,"schema":{"type":"string","enum":["asc","desc"]},"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."}]}
\ No newline at end of file
diff --git a/docs/api/get-events.RequestSchema.json b/docs/api/get-events.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-events.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-events.StatusCodes.json b/docs/api/get-events.StatusCodes.json
new file mode 100644
index 000000000..124d4a90c
--- /dev/null
+++ b/docs/api/get-events.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"type":"array","description":"A list of events","x-examples":{"success_status":[{"uuid":"f7397a24-57ad-4fae-b011-d258e8232900","event_type":"employee.created","resource_type":"Company","resource_uuid":"92a20431-9489-4bde-ad27-6feb20b969d5","entity_type":"Employee","entity_uuid":"92a20431-9489-4bde-ad27-6feb20b969d5","timestamp":1686784995},{"uuid":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","event_type":"company.provisioned","resource_type":"Company","resource_uuid":"92a20431-9489-4bde-ad27-6feb20b969d5","entity_type":"Company","entity_uuid":"92a20431-9489-4bde-ad27-6feb20b969d5","timestamp":1686784994}]},"items":{"type":"object","x-examples":{"example":{"uuid":"f7397a24-57ad-4fae-b011-d258e8232900","event_type":"employee.bank_account.created","resource_type":"Company","resource_uuid":"92a20431-9489-4bde-ad27-6feb20b969d5","entity_type":"BankAccount","entity_uuid":"92a20431-9489-4bde-ad27-6feb20b969d5","timestamp":1686784995}},"description":"Representation of an Event","properties":{"uuid":{"type":"string","description":"Unique identifier for the event."},"event_type":{"type":"string","description":"Description of the event (e.g., payroll.submitted, or company.form.signed)."},"resource_type":{"type":"string","enum":["Company"],"description":"Name of the parent resource of the described entity."},"resource_uuid":{"type":"string","description":"Unique identifier for the parent resource."},"entity_type":{"type":"string","description":"Name of the entity that the event corresponds to."},"entity_uuid":{"type":"string","description":"Unique identifier for the entity."},"timestamp":{"type":"integer","description":"Time at which this event was created. Measured in seconds since the Unix epoch."}},"required":["uuid"],"title":"Event"},"title":"Event-List"}}}},"422":{"description":"Unprocessable Entity\n\nThis 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.\n","content":{"application/json":{"schema":{"description":"Unprocessable Entity\n \nThis 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.\n","type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["error_key","category"],"properties":{"error_key":{"type":"string","description":"Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error."},"category":{"type":"string","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."},"message":{"type":"string","description":"Provides details about the error - generally this message can be surfaced to an end user."},"metadata":{"type":"object","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.","oneOf":[{"type":"object","description":"multiple entities","required":["entities"],"properties":{"entities":{"type":"array","items":{"type":"object","description":"single entity","additionalProperties":true,"properties":{"entity_type":{"type":"string","description":"Name of the entity that the error corresponds to."},"entity_uuid":{"type":"string","description":"Unique identifier for the entity."},"valid_from":{"type":["string","null"]},"valid_up_to":{"type":["string","null"]},"key":{"type":["string","null"]},"state":{"type":["string","null"]}},"title":"Metadata-With-One-Entity"}}},"title":"Metadata-With-Multiple-Entities"},{"type":"object","description":"single entity","additionalProperties":true,"properties":{"entity_type":{"type":"string","description":"Name of the entity that the error corresponds to."},"entity_uuid":{"type":"string","description":"Unique identifier for the entity."},"valid_from":{"type":["string","null"]},"valid_up_to":{"type":["string","null"]},"key":{"type":["string","null"]},"state":{"type":["string","null"]}},"title":"Metadata-With-One-Entity"}]},"errors":{"type":"array","description":"Will only exist if category is `nested_errors`. It is possible to have multiple levels of nested errors.","items":"circular(Entity-Error-Object)"}},"title":"Entity-Error-Object"}}},"x-examples":{"bank_account_delete_unfunded_payments":{"errors":[{"error_key":"base","category":"invalid_operation","message":"FundingMethod has unfunded payments"}]},"bank_account_verify_incorrect_deposits":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Your bank account cannot be verified. Please check the test deposit amounts."}]},"bank_account_verify_already_verified":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Your bank account has already been verified."}]},"bank_account_missing_routing":{"errors":[{"error_key":"routing_number","category":"invalid_attribute_value","message":"Routing number is required."}]},"payment_configs_missing_parameter":{"errors":[{"error_key":"base","category":"missing_parameter","message":"At least one parameter must be provided"}]},"payment_configs_invalid_fast_payment_limit":{"errors":[{"error_key":"fast_payment_limit","category":"invalid_attribute_value","message":"Fast payment limit should be a number"}]},"pay_periods_invalid_end_date":{"errors":[{"error_key":"end_date","category":"invalid_parameter","message":"End date cannot be more than 3 months in future"}]},"company_industry_selection_naics_code_required":{"errors":[{"error_key":"naics_code","category":"invalid_attribute_value","message":"Naics code is required."}]},"company_industry_selection_naics_code_invalid":{"errors":[{"error_key":"naics_code","category":"invalid_attribute_value","message":"Naics code must be equal to 6 digits."}]},"company_industry_selection_sics_codes_invalid":{"errors":[{"error_key":"sic_codes","category":"invalid_attribute_value","message":"Sic codes must be equal to 4 digits"}]},"time_off_policy_name_required":{"errors":[{"error_key":"name","category":"invalid_attribute_value","message":"Name is required."}]},"time_off_policy_unlimited_invalid_accrual_rate":{"errors":[{"error_key":"accrual_rate","category":"invalid_operation","message":"Accrual rate must be blank for unlimited policies."}]},"time_off_policy_pending_requests":{"errors":[{"error_key":"time_off_policy","category":"invalid_operation","message":"Cannot deactivate policy with pending time off requests."}]},"time_off_policy_employees_required":{"errors":[{"error_key":"employees","category":"invalid_attribute_value","message":"Employees are required."}]},"time_off_policy_unlimited_balance_update":{"errors":[{"error_key":"base","category":"invalid_attribute_value","message":"Can not adjust balances for unlimited policies."}]},"holiday_pay_policy_already_exists":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Company already has a holiday pay policy."}]},"holiday_pay_policy_not_exists":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Company does not have a holiday pay policy, please create one"}]},"holiday_pay_policy_invalid_employees":{"errors":[{"error_key":"employees","category":"invalid_attribute_value","message":"Invalid employee uuids provided."}]},"onboarded_employee":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Cannot delete onboarded employee"}]},"invalid_attribute":{"errors":[{"error_key":"base","category":"invalid_operation","message":"There is an error in the request body."}]},"company_cannot_enable_contractor_only":{"errors":[{"error_key":"contractor_only","category":"invalid_attribute_value","message":"Contractor only cannot be enabled for existing companies."}]},"company_missing_parameter":{"errors":[{"error_key":"base","category":"missing_parameter","message":"contractor_only is required."}]},"starting_after_uuid_invalid":{"errors":[{"error_key":"starting_after_uuid","category":"invalid_attribute_value","message":"Parameter 'starting_after_uuid' does not correspond to a valid event."}]},"resource_uuid_invalid":{"errors":[{"error_key":"resource_uuid","category":"invalid_attribute_value","message":"Parameter 'resource_uuid' does not correspond to a valid resource."}]},"payroll_gross_up_invalid_net_pay":{"errors":[{"error_key":"net_pay","category":"invalid_attribute_value","message":"Net pay must be a number."}]},"payroll_accruing_hours_invalid":{"errors":[{"error_key":"base","category":"invalid_attribute_value","message":"Hours cannot be negative."}]},"payroll_cannot_cancel":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Payroll cannot be canceled."}]},"frozen_payroll":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This payroll has already been processed. Its data cannot be updated or altered."}]},"frozen_payroll_processing":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This payroll is being processed and cannot be updated at this time."}]},"unmodifiable_payroll_type":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This type of payroll cannot be modified or processed. It is reserved for system processes."}]},"invalid_employee_uuids_format":{"errors":[{"error_key":"employee_uuids","category":"invalid_attribute_value","message":"Parameter employee_uuids must be an array."}]},"maximum_employee_uuids_surpassed":{"errors":[{"error_key":"employee_uuids","category":"invalid_attribute_value","message":"Exceeded maximum of 100 for lookup."}]},"invalid_employee_uuid":{"errors":[{"error_key":"employee_uuids","category":"invalid_attribute_value","message":"Invalid Employee UUID(s).","metadata":{"entities":[{"entity_type":"Employee","entity_uuid":"invalid-uuid-123"}]}}]},"payroll_blocker_missing_bank_info":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must have a bank account in order to run payroll.","metadata":{"key":"missing_bank_info"}}]},"payroll_blocker_missing_employee_setup":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must add employees in order to run payroll.","metadata":{"key":"missing_employee_setup"}}]},"payroll_blocker_missing_federal_tax_setup":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must complete federal tax setup in order to run payroll.","metadata":{"key":"missing_federal_tax_setup"}}]},"payroll_blocker_missing_bank_verification":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company bank account must be verified in order to run payroll.","metadata":{"key":"missing_bank_verification"}}]},"payroll_blocker_suspended":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company is suspended and cannot run payroll.","metadata":{"key":"suspended"}}]},"submission_blocker_missing_selection":{"errors":[{"error_key":"submission_blockers","category":"invalid_attribute_value","message":"Submission blockers selections required"}]},"submission_blocker_invalid_option":{"errors":[{"error_key":"submission_blockers","category":"nested_errors","metadata":{"blocker_type":"fast_ach_threshold_exceeded"},"errors":[{"error_key":"selected_option","category":"invalid_attribute_value","message":"Selection is not available to resolve Fast ACH Threshold Exceeded. Please choose one of Wire In, Move To Four Day"}]}]},"invalid_version":{"errors":[{"error_key":"base","category":"invalid_resource_version","message":"You are attempting to update a resource using an out-of-date version."}]},"signatory_email_required":{"errors":[{"error_key":"email","category":"invalid_attribute_value","message":"Email is required"}]},"signatory_company_already_has_signatory":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Cannot have more than one signatory in a company. Please remove the existing signatory before adding a new one."}]},"mixed_disbursement_errors":{"errors":[{"error_key":"disbursements","category":"nested_errors","metadata":{"contractor_payment_uuid":"invalid-uuid-1"},"errors":[{"error_key":"contractor_payment_uuid","category":"not_found","message":"Disbursement not found."}]},{"error_key":"disbursements","category":"nested_errors","metadata":{"contractor_payment_uuid":"d0dfa222-ad08-4ea7-a06a-717688c3b179"},"errors":[{"error_key":"payment_method","category":"invalid_attribute_value","message":"Payment method must be one of: Direct Deposit, Check."},{"error_key":"payment_status","category":"invalid_attribute_value","message":"Payment status is not valid for payment method 'InvalidMethod'."}]}]},"not_found":{"errors":[{"error_key":"request","category":"not_found","message":"The requested resource was not found."}]},"finish_onboarding_incomplete":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Company is not ready to exit onboarding."}]},"company_location_validation":{"errors":[{"error_key":"street_1","category":"invalid_attribute_value","message":"Must include a street address"},{"error_key":"city","category":"invalid_attribute_value","message":"Must include a city"},{"error_key":"state","category":"invalid_attribute_value","message":"State is in the wrong format"},{"error_key":"zip","category":"invalid_attribute_value","message":"Please enter a valid zip code (e.g. 12345)."},{"error_key":"phone_number","category":"invalid_attribute_value","message":"Phone number must be 10 digits"}]},"conflict":{"errors":[{"error_key":"request","category":"duplicate_operation","message":"A resource with these attributes already exists."}]},"invalid_parameter":{"errors":[{"error_key":"request","category":"invalid_parameter","message":"The provided parameter is invalid or missing."}]},"flow_invalid_entity":{"errors":[{"error_key":"entity_type","category":"invalid_attribute_value","message":"Invalid flow entity"},{"error_key":"entity_uuid","category":"invalid_attribute_value","message":"Invalid flow entity"}]},"flow_nested_options_errors":{"errors":[{"error_key":"options","category":"nested_errors","metadata":{"flow_type":"company_forms"},"errors":[{"error_key":"form_types","category":"invalid_attribute_value","message":"Supplied value 'invalid' contains no permitted values"}]}]},"basic":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must complete all onboarding requirements in order to run payroll.","metadata":{"key":"needs_onboarding"}}]},"contractor_payment_invalid_wage":{"errors":[{"error_key":"wage","category":"invalid_attribute_value","message":"Wage must be greater than or equal to 0."}]},"contractor_payment_cannot_cancel":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Payment has already been processed and cannot be cancelled. Contact support directly."}]},"time_off_request_cannot_delete":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This time off request cannot be deleted."}]},"resource":{"errors":[{"error_key":"first_name","category":"invalid_attribute_value","message":"First name is required"},{"error_key":"date_of_birth","category":"invalid_attribute_value","message":"Date of birth is not a valid date"}]},"nested":{"errors":[{"error_key":"contractor_payments","category":"nested_errors","metadata":{"contractor_uuid":"72ae4617-daa9-4ed7-85e0-18ed5d0ee835"},"errors":[{"error_key":"hours","category":"invalid_attribute_value","message":"Ella Fitzgerald is paid fixed wage and hours cannot be set on a contractor payment"}]},{"error_key":"contractor_payments","category":"nested_errors","metadata":{"contractor_uuid":"2d7bf62c-babf-4a12-8292-340e2d9cab28"},"errors":[{"error_key":"wage","category":"invalid_attribute_value","message":"Isaiah Berlin is paid hourly and wage cannot be set on a contractor payment"}]}]},"compensation_invalid_rate":{"errors":[{"error_key":"rate","category":"invalid_attribute_value","message":"Rate is not a valid number"}]},"compensation_invalid_payment_unit":{"errors":[{"error_key":"payment_unit","category":"invalid_attribute_value","message":"Payment unit must be one of Hour, Week, Month, or Year"}]},"compensation_already_processed":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Compensation has already been processed on payroll."}]}},"title":"Unprocessable-Entity-Error-Object"}}}}}}
\ No newline at end of file
diff --git a/docs/api/get-events.api.mdx b/docs/api/get-events.api.mdx
new file mode 100644
index 000000000..2377df589
--- /dev/null
+++ b/docs/api/get-events.api.mdx
@@ -0,0 +1,75 @@
+---
+id: get-events
+title: "Get all events"
+description: "Fetch all events, going back up to 30 days, that your partner application has the required scopes for. Note that a partner does NOT have to have verified webhook subscriptions in order to utilize this endpoint."
+sidebar_label: "Get all events"
+hide_title: true
+hide_table_of_contents: true
+api: eJztXFtzG7eS/ivY2QdHpzg0Rev+tI4vJ646TlyxvNlTjmsEDnpIRDPABMBIol36Ffuyb/sX9ydsdQNz4fBikpZSm608pGJxgMaHRqOvAL5EAmxqZOmkVtFF9BpcOmM8zxncgHJ2wKZaqimb8PSaVSVzmj0bMcHndsDcjDs215VhJTdOgWG8LHOZcqTFZtwyNwNm4PdKGhDMproEyzJthuxH7cD3501nocGyH3+6ZDN+AzgQ/f8GjMwkCHYLk5nW18xWkwawZVIxbQQYbF85mcvPSFdaBkqUWio3/FX9qv7nv//zv9j7uXVQsOdpCtay55WbgXIBLTa67HZjlQWP/+P3wA0Y6sBsOoMC2K10M/poiWacww3kjHvKTl+DQmDY4IfLy3fUVRv5OTAGuADz6buZc6W9ePpU6NQOp5V1epjq4ikUExACRFzyudF5Tt+fhoH8EAcIl9h5wa78Ol0Y4OIqGkR3MZGKpXIwNTRi7OYlRBcfo5p0NIh4WXab2OjTIHJ8arHZK6KIv+gS/Pc3IrqIpuBiP1o0iCyklZFuHl18/BJ51nrO4mSji4+f7j8NopIbXoADY6mZ4gVEF9F/xH8niM/fvYn/HYxFyRtEEsXP8wbJI6N5dPEl8uAj64xU02gQgaoKRDkejY/j0Ul8eIxIBWS8yl100f39ftCT7peIpZAqLK3gDuIJtyDY83dvUNQQC+PW6lRyh0KHC00ijg1SnudD9iZjSitg0rLS6BspQAx8m474P7HsYyGVLKqiS3vHVeeljENPqab/GgjGnZ8PEEZlQQyj+0HDYeu4cVJNE545MElVSVFz+PcKzDwaRPW2jC4ynlvoc+o5SytjtcHtyko+lYqmNWQ/g6uMsh0VwXSKoqCmjEbz+6KE1G/bDx/evGTfwV2aV1bewMGQefFi3ACz2iCXeZpqI5CC09S95is1SPwGJ1kabhCN+w4DDFhdmRT2mfrlDDxqnRGYVBclV/Ow8K6d24DdyjxnhjjSZQjyDP/0PSXYbWHnspBuR7j/wD5enlVVTMAgbj35DVJnAzYQqI44s1JNc9TIttTKwoBNwN0CKHbIuBLscDQaMpx92EwoWuPjLaHT1BP6vqukeWos1cpxqUgMZsDgjqfOc5ThGOw7GE6H7AqKMtdzgGFqAPfo1cGAaYN7gHFcEJFyI1jB0Y45zTKZo1DSkrCp0VWJ/AkL1Sf5t6sBu/pbQ3nArpR2Mgt7eth+YeDS4cGWrGmF+Kus+bra4zaNPAujT0v6reGlVIJAqym7nYGbeQOJQHD1q5y+BCagaNgUFG3A77hND5CfSLj+Df99wNKZ0UrneipTnnuru2ozT+a4fNKwKycLsI4X5dWQvfQihdYRR2MyYzlkjkFRuvkwQmNRWy5jb/k0unCmAuSQl1WLPBmPRvi/xTm/r8jsZFUeDSKUIVAOW3WU8dPfLDb9ssxebgyfR8tszKV1rZyQWYU7XpS5B2L9mIl13FXetpGiuYiy02fnp3x8FB+fchEfZRziyejwMBbj4zM4Gz8bn49GuJrtbrmI+hJNghH0V2jywuug7pcw4PmYj0dHzw7j86Oz8/hoIiDmYnwan2QwGY8m5yfn4pjEx0k3r8m9CiO2H3aj1qxsdHF4cnZyenZ0fn6MEh/I8MPJOH0mjmI4zk7i07PzUcwnqYghOxw/Ozo+wV/6XKjVLOl+NG1/BCNacg/Gh6N73JfSQWE7guYV8pIghX/jPx9CgCZcXSdoTSvl/jhp+p6r6+d+0IcVqCX99jOUBiwo5z1pnTGuvAqKBlFp0F110nPWj7+sRxcJflDy9wqYFIg6k8FQkPlBquhULbD6a/Retn/V7oO3YGRpBix4d0NbTQrpHPoQ2jQeRqZNMbRyqkAc0NC9hVtvFeoV/dQH9CNazoCk5Aah1ETrn32HCQjml25x5G/lY29Qz9Gu+HyNdHcGvqMPHFveptp4MyHQvHRH+GYhaBnSkdCGHgVQZNV7HqQsgHHHbmcSnRCKKwnpLbcsbMshewvcVsb7ZhZSgm+lSoGG/qDkHYNSp7MhOhMdV+Gjl20M2KTLSZ3TDrjv/RD/Q1oX3d9j76PxeNlyflCl0WjH+CQH9orm2gTCBZ+zGS9LUOhB+GB2osUcl4KCHQQE1tVum2VgjDaW2QoTCJZdSXXDcykS7pyRk8pBcsPzCq5I5OvMAFLIuMwtExUF/Vy1PZvw82rI3oPny8dXfpgX3MFUGwl2x5iKYMZp0/2ATSspgNa80Ab3g0NAw1/VLg7FNqxl7C/mdpnbt41dGfcTRilf1Ovh92UXbq3FXaKaXAN2CCjna8agVl/VHe9DMGhxIY3nInX3UbEdsst5iQ5zPveK4BrmrabxYVuzhk+bfAkzkFMCIgTERJL0UIN6B2hIAduSR0uUKMyrSdXhdpAyHyVJNbUUFaZcsQlQjgHRTCqZC5aiHBSh/Ywrkfuow0tvJ7FEUXMzkLTsSoF1IBK/jlcDAufXyofTQeQZZ74luwpNWVikuc/KBFvgPxJrCtxv0y1Myrt6vkEaGZ/oynXWLmZTUGDaVQuka2bYymQ89QzhCpOGyB8TUDguuOOrRHERxot6cxvI4YYrhwkpjjSDgMzDTg72WipGexqdC1IbQSNNchiy19qw4E0OFkgQPmLVVcfuXtHaXnXs5JVn/6TNvmDWQiv4KaMAZ/NcCowpyzyYTNxHvY1X/7y82eovO2zpxbFDWsPPBXObQkj8xPN3nZF8PLli7AdxREhs/hBHxGvvzOiiJfixpaiqPKfMgG9XlYnTmxsu6LlVDTDKhU1NOp7H2yD98S/SzeKfFMTe+EX361u9DbLjm+LSYCj515r/+dccKa012It8+AWVj1b5nMEdJl/kRrMxZG8oPVlqayW6WHW5qNFDVJKxuHbBjNSGolErUSpNWuXcfOfhxuT8xD+RwB1E3RmuaOAFejGa74bfiYAcHCSVyiolQCQlnxeUTOo4MR8XfI0ISxFdxwQjjJ6zFnXMXPS6ogTdW3AzLajgVo/GmtFoDRaAUUVtnkhFopsi0lJb+aDI/oluAI7KwqhoOTF5PmkrekP2LgdugaUzSK+9k4Iea4DDeIEd0bSvmwLPseo1T2qKjzoBZG8YkE0wad7MYwXAQlrUUInRFaZaNwALLRKfu18NsefkLwD92fevc//SNgXXgCtIQpJqlcmpbaA1vuZOXFvu3QXz3DFcUsewPtY6s0VlXdexWA2snm3Grat3S+IrIusRrmi8MwtfI+JAgxENZme6ygVi5oGzDeakBCO1aPGCEokI2nINyqbJSmyreflKCSpQdnYORVBuxhV7xgqt3IyS91nlKgMeX8gkJVKJyjozTyzkkKJ0J4rL1CapFpC0jtlaxG3r3fn5I/Zl2HeFOG6HMAzz+ABr0YTfK56jFTlhQk5lo3Y2wLU1ALsFXCtT33Z3tO9lSljtMtijANZjxRRVorMsKXUu03mC5aft1rrYi4nFqvXtg6gU7SgQzX7haWoqnidm855ZaLaD5n7u+zHs13BskqMqR8+qwcMIIBVnVwIvffUrCYmUTdax13UXtC/85hbAUydvELKn4WPcgIHhAExnWZ3VWYe5LgTYbZa9abz72tf1I1/421oCJjznCnPK5Vf05XprvQnVC66oQM/Fb7TsfjS7edlnOpcCtTr+5wHXbgU5og/pFYUsfeNGkEvBAgK0QGHx10NT2j0eLDqAhQwkT3oVsAErg8tGSWw082uhNuaxEbNHEcU3vg2rSTAMu2wnh0H4tJpobtANr9s9JP/qPYwOP2uGaiB5CEuTeUAEl5R7lJaSPRSWhuNndRYYk8s9i+bdigQU5o/QCXOGp06bBIOwDdj6LXffpg0BH++1/o3HImjDkpT7YyHNIZoF/I/px/bmuMLMrThhtY0XsPJc1o78e9f41U9W0HvSbuM2NUF5ShY2SihsfupX+bbA3z9WtT/yBUpfxdypHgYvHEsOydRoazHdUQ+ugIKBTb5OaLG7uwMUIzQeRR0X9CCR14IrMtOV2cYx3M/U/YDUOztHwZQ7edNnUNjjKdrB/AH1zTtPvwPAD9Fsj8zoz6CSgONBNR1mfcLwSyF5KLphbuGNsz6d3mL0bodgdDrPgVmDNglUNsft3wRcWjYBVG4N4LrU0oNKqUZpyQEMYCtVaCEzSWq7hlxnMx8SbF0xKpcW2wPwnFxguVeUFsxN0OL+2HLTqNbhfd+AtIBN8PwD3xTtL7b/FgW0SKnd1YpRejLgLPgdHrjt47SVKTnO+RGhvrpLAdCLCBhwJQ5HI+JqrvV1VW7i5SMCqx2uOgags7Lf2YNhtFj7aus6H79se/wsjB/jn/Hh+BnOcEGhTXKdXoNpjD8l3aTK9E7C36O20hkmiQiO8EIesHvjwFSqOdLTm74fexnn5vk0i2PBVeXjTIqL1jW1+02nB3PznDIQWEpNHL97zGmhX0gOeBiPOX7HaLz95rgMewtR9Dlhf0jkwae5IIa1xmrux+wvlwugV0/SVhZzETum2LeZlMRDLYF41wh+dQotJA+ZjtRZPDi6tDRNzm6Ta77UfZ9UXUOE1URYM3gbQ0TrALdW+VvRLpTLevyrRwvamFLoPJ0lbmbAznQuEgjGJ+rU7/oIaFrQYN2dVzVfUAQobXPDZc5DMQ89/vwGGOXmn7/4gV3W4FhtGTv1I60tJSPQSP4iDbA3asDe6htgl5q9xlLOS07lyK7BDDdo9nKbmvDlprm/tFA7orwYdw6Pt4d7Ld6lY7w9z1FZujSjmK5crLOYvgeCdZgpp4o7bTC1x2W+XVqPy3yflB6XeTfQ7QOo4+46OzbjNmm+Pnw2xVdzm4IHLm4zmr/N0tzLCWJgoMAV93dHQvKg7TKBDInhOQFkOlNwi0RrR0/egUiEtJPKWKBiUlu3XjOxbusddl8nt1DXrVZ6Pxv23joSixi0SzJdKbHA3Zcd0LTrqInnwiNPT4xExsfjcczF6Cw+An4a89EJj08PT0/OztJnk8PT8w2TrqkVVO3ex/f3BT7fv7GfXmtcsJcSa+HspS8+D9gLLEr7S3WrUISbH3uj8P1r1ec9an/VbgHlk+Bt+xL/k2Gtw9rF3ZSsodzfNlJx2aYKoc220HHlnoxEmVTSzpKQ5UTrigcJvOv1CDnpwCAf4zuNO9uxdvBeTjDX3otJiPTXvDDrDIBLDndfxbcoPFKleSVQo3tCqFsMWLskM6k/ovRtYxCRPmV/Smd304vdkLUhS3xrtJqyEH33x/gsyz3E3KtkUBhr11m8z7L0RVd/7Y6uAh2s2GIzrWDv8xDvsHd9GqLe5IejhUIpnjjIZbop07By84jKnwCHdaXHztYJN8Rt53hvm6zyJZxeAL9NInslrM3nCC6792nbMxm0+n5d8Gy295TrPZ7r287xBjrLtelwQxvb751NwCHr03x9gejmCB5mgGaSwZJ5H9Z+3eaHhtubQxpl8YYbpbnsBkuH36nPXhEIngkGwegTexL6PGlvEijNSrwEj7ePfCtbW5UJtzJ95Oic0zG/Wn/X3mZR30TdPoRVAMJ27FAIA1f4HzXfbsPh8DWzo887M/wXPBZe65kplUVNcFlNe1Bj1BiqJXSPmKMnT2J9kryXc/YIMIfP6GR66pityhLvDAtyjvJ5v8If1FE9B18BffA8dO/wQweyH1D0qlmbjotJY12y34GX19jXX0VfCJP6fjPZhyyZSONmu4/ykurqGaPuTWgcLCgdm/AOIOmc7cq0zVnQfZz44LyfjjkcnRyexoLz8/gIxGl8dgyj+PAMxLEYAZw9O96g0qgatkdQmuecvZbu8xRTcYJO/HJU5hiuMdywJMOzXjXMAvqIFCI2pebAhBWBzgNzaixOJ9nJOI0nfJLFR/xwHJ+Nz8fxs6MRjMV5yifjsw2c2k8LvbFc8hn7HkwuVcMm5Es+Jxbdhtsr23Go9qlBWe9PN3mPzed21p/V2niENXijXUnvHrpciaQJLtXG86ELzfaO1rB3L2JkWIIdsF8ArjHVpNyMrt79E/gq1HXSpNG9Dxwq1QNt0va6Y1DvFw7wL9xWjNccdvfH3W0J/Bq4nceoCGN9A8ZIAf51IKzn3DlQlnwknJef0do3iejGQvX1t4lwyy6S8o9ENP3xoke30TqYTQeCi69OhHRCjb/k+HpR9PTm8GnnqSNzUz9hVJkc1Vm4E8lL6a9ExgIKuhe54kZ4oaNFznl6sU+K4Gd6OWE14ZU03xlKgKyjWeJnnFv9RtN7erWK/NrglHWfamouZuDg9ZMm+PeEHr5acW2NSNSPXi28o4WKbfkxqF1HeL/wqlZvAIqYfMGvll96TgqfWcL1rbO63YegBhG++2R/yt6DuZEpdDjd3milS4BPqeFTgUPjdovpb8zO2tB16eIK5KkuKGlNOJ5Y9irIMqvPSeALUEKnVVE/XfAv4Wox90FoeCjmZT0q+xmvf4ZIwyd0UVTC139rJQO5UWrrCq46dP6OyYjmOaI+4i/tpea/nnv7sz/3FjaWgzv3tMy5pB1IuuRL0GUfo5vD+sEQun4509bhz1++oKX5YPL7e/zZv0mEOk5IMgRrHmzqis//4VfCVjJm0ym82jCQNt6eBY/0WtgG+P1DeHsC/wPeDdswifqqzp7g/9yPhm3gy8Izat/KnD/bK2Cbd233FbWWM5/wD0On4ejVyUH9huRumuz/9cuQG/m6+jXOBdHzDdGSlt09u/QgyoI//fdXl+jLLzqAjcMX/tF5WMA/SFXT/vLFt7hE63p/H9VoydpS+HL/vw2eFWI=
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Fetch all events, going back up to 30 days, that your partner application has the required scopes for. Note that a partner does NOT have to have verified webhook subscriptions in order to utilize this endpoint.
+
+📘 System Access Authentication
+
+This endpoint uses the [Bearer Auth scheme with the system-level access token in the HTTP Authorization header](https://docs.gusto.com/embedded-payroll/docs/system-access)
+
+scope: `events:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-information-requests.ParamsDetails.json b/docs/api/get-information-requests.ParamsDetails.json
new file mode 100644
index 000000000..9ff053362
--- /dev/null
+++ b/docs/api/get-information-requests.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"company_uuid","in":"path","required":true,"schema":{"type":"string"},"description":"The UUID of the company"},{"name":"X-Gusto-API-Version","in":"header","required":false,"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.","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"}}]}
\ No newline at end of file
diff --git a/docs/api/get-information-requests.RequestSchema.json b/docs/api/get-information-requests.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-information-requests.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-information-requests.StatusCodes.json b/docs/api/get-information-requests.StatusCodes.json
new file mode 100644
index 000000000..7193fb9a7
--- /dev/null
+++ b/docs/api/get-information-requests.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"Example response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","x-examples":{"example":{"uuid":"704c1291-274d-4552-aa5d-e7031023c2e5","company_uuid":"3ac84ba3-87b3-40be-8523-d185dc243a6c","type":"account_protection","status":"pending_response","blocking_payroll":false}},"description":"Representation of an information request","properties":{"uuid":{"type":"string","description":"Unique identifier of an information request"},"company_uuid":{"type":"string","description":"Unique identifier of the company to which the information requests belongs"},"type":{"type":["string","null"],"description":"The type of information request","enum":["company_onboarding","account_protection","payment_request","payment_error"]},"status":{"type":"string","description":"The status of the information request","enum":["pending_response","pending_review","approved"]},"blocking_payroll":{"type":"boolean","description":"If true, this information request is blocking payroll, and may require response or requires review from our Risk Ops team."},"required_questions":{"type":"array","description":"The list of required questions for the information request","items":{"type":"object","properties":{"question_uuid":{"type":"string","description":"The UUID of the question"},"question_text":{"type":"string","description":"The text of the question"},"response_type":{"type":"string","description":"The type of response to the question","enum":["text","document","persona","radio_button"]}}}}},"title":"Information-Request"}},"examples":{"Example":{"value":[{"uuid":"e83d273e-4ae9-4b61-9c71-4030c2f73093","company_uuid":"c5e3e3e9-732f-4762-849e-20b5cec9036f","type":"company_onboarding","status":"pending_response","blocking_payroll":true}]}}}}},"404":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided UUID is valid.\n"}}}
\ No newline at end of file
diff --git a/docs/api/get-information-requests.api.mdx b/docs/api/get-information-requests.api.mdx
new file mode 100644
index 000000000..597bc8722
--- /dev/null
+++ b/docs/api/get-information-requests.api.mdx
@@ -0,0 +1,71 @@
+---
+id: get-information-requests
+title: "Get all information requests for a company"
+description: "Fetch all information requests for a company."
+sidebar_label: "Get all information requests for a company"
+hide_title: true
+hide_table_of_contents: true
+api: eJzdV99v2zYQ/lc47qEdIPq348RPC5a2yMPWIG22AYnh0uTJZiORKkm5MQz978NRki3HctZu2Mv6Uoc63h2/u/v4cUuf2DJ33jClPSwt98po5jcZ0Ok9hXQBUoKks4h6vnS4dq1jY9NgR27hSw7OO/xuMih3X0s6pUvwTO0tma0tIyrBCasyXKZT+ha8WBGeJKRhTmpzEhtLOBEmzbjedB70g3bCZDAlnxrm89p8aoHLTzSiGbc8BQ8WU95SzVOgU1q5mee5kjSiCuNn3K9oRNGDsiDp1NscIurEClJOp1taYkGdt0ovafE8/48rIHd311fExMSvoE6VFtEu7J/sXUD48uaa/Q7W4cYq+gq4BHsQP+aJg+dRrvAsqdLgQhDJPbAFdyDJ5c01WZdOCXfOCMU9SPJV+RXZmNwGA8GTpEOuY6KNBqIcyaxZKwkyKm14liVKBCxfOXKfKq3SPG36nr1eeZ+5abcrjXCd0DIdYdJu3SIs4xtrkiR87/JMsWqn0ssfK4essfwTppE7kB16Gu2Igs5T7LpBbzBmvTPWH2OvSYh5nng6ba4XxQxxdJnRDhw6G/R6+N8hlG+eeJolQGpLGlFhtAft0baBRPezww3b4+y4tXyDJfSQusa6WXwG4WlEnxiUUcLX6jf+DJ03pZPeSPQHF302mIwkG43HA8b5WDKY9Ib93mAoBjAOeTX6dUqHXJyPFnzIzieLIRv1FsDOx4Mhk/3zsRSD0ZCfCRrtkhTC5NrPM2s8CF82nfPc5w7bHrRUejlvoLBIjHjEtaqSVSsWRy1/C5kFB9qXs2piwnXb9OIcWqQFr0ogynMcF/nQ/Z1WX3IgSoL2KlZgX4hQPAfpHzlvzC3xhnxdKbEKi62UtIDE6KXD2GWsOub9PqjOk6Rs1OdcgaYYsx2vut3rQxm9MNzK0mlrRTO+SUH7eQPzagWsNZbOin3V/w4czK+0rVF5OcuWJtovrRV8xaQz5Bq8Qoq2FtultDAmAa6PcrqOSWBk4lfKteWDPFL7JZXfiHAtSco3pOLV3bQTY+s1R8okSWxNSpAGb5V7JO8zRzzwtIMFrml5HkIpo10LDRyDmCjnEcJ6O9ltDxfaaWRPMsrhINXuvrHpn99R9XY84c6Vhyf/ba7Qss1VjfH8cCxedFVNw6483hy63TdbyC+i0ogc2zv0mnVGc7w9uVRmvsi9N5rOCvwXUa88km5TsLDbmjeKiDYp+s2eotc8ySGohop24XwoB5MhsBGHCzZanPXZhZj02ag37IlBPBn2LobHZC3GMIQhXLDJcBCz0eRswM5HF8AGvcVYgLjoDc/iPVm3zvv3kTVOSVGffdQbHd98vxlP3ppcS/KgCXnQWICq9UBiCUxuBRBpwBFtPIEn5XyH/MofgbjcQqhMrRzKhlKOrHmiZOdBV5h60K6ck/stfYQNnZ5WmNEO7IbSxFs8Bb8ylYwMjOZXdEq76363BEqB626bgBfdNjmIGIJd1yowtwlKrkrH8EyVMoZJSIOWOerQK0hNuM1dBvwRuNuw0h8LJcZ9QeedcNzq88Ya+YLPDD8jBA5EbpXfhMx/KY96KQQ4d5kjGvezptUHlChlK7fY7iYRU6zlViBd4DbIz8McKxcsgTUkhOd+hbdlqYpw0D9snIf030QoPZwIUKA4jk3wWs1wENCoR7FnKgl9IP4iigLZvY8/gF0rAY167LUqX5jcd4NhV2Jo5FQW/mYmDnXArc+T/QMSYdLATSGPV468qdqV3JTjF6RyTU3hGD9UupKLwKrVU+CqjkpuIeHlhRJRSLlKQkNVX3/e9w+ikRnnU64bft6B/8Y30/PTbPdq9z96e1WdgHzdzRKuQsuEEdlWk3xP1/0dY+KVFtHp0dusZZxnEV0Z59HBdovPnzubFAUuf8nB4qjMkFKs4oukpHCpHP4+8axqYvH6trqrfyKnnnQnjlargWBRERqlUUV+B+cqUARVb77vS+9//gBsBbYEsP31vMMZ+bc0RD7KfOPb0Vvu4Gp59+YjLYq/AL399yM=
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Fetch all information requests for a company.
+
+scope: `information_requests:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-invoices-invoice-period.ParamsDetails.json b/docs/api/get-invoices-invoice-period.ParamsDetails.json
new file mode 100644
index 000000000..22b2fd46d
--- /dev/null
+++ b/docs/api/get-invoices-invoice-period.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"invoice_period","in":"path","required":true,"schema":{"type":"string","example":"2020-01"},"description":"The month we are calculating the invoice for. Must be in YYYY-MM format"},{"schema":{"type":"integer"},"in":"query","name":"page","description":"The page that is requested. When unspecified, will load all objects unless endpoint forces pagination."},{"schema":{"type":"integer"},"in":"query","name":"per","description":"Number of objects per page. For majority of endpoints will default to 25"},{"schema":{"type":"string"},"in":"query","name":"company_uuids","description":"Filter companies returned in the active_companies response, will return an error if company not active during provided invoice period. i.e. `?company_uuids=781922d8-e780-4b6b-bf74-ee303166d022,bbbca930-7322-491c-ba7f-98707a52a9c5`"},{"name":"X-Gusto-API-Version","in":"header","required":false,"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.","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"}}]}
\ No newline at end of file
diff --git a/docs/api/get-invoices-invoice-period.RequestSchema.json b/docs/api/get-invoices-invoice-period.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-invoices-invoice-period.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-invoices-invoice-period.StatusCodes.json b/docs/api/get-invoices-invoice-period.StatusCodes.json
new file mode 100644
index 000000000..6c077b774
--- /dev/null
+++ b/docs/api/get-invoices-invoice-period.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"Example response","content":{"application/json":{"schema":{"type":"object","x-examples":{"example":{"active_companies":[{"company_uuid":"05ed3150-591e-4f8b-bfd5-55d478edd2d8","active_employees":5,"active_contractors":3,"initial_invoice_period":"2022-01"},{"company_uuid":"9b37429c-e540-40fb-86b3-738ca9af65c7","active_employees":0,"active_contractors":1,"initial_invoice_period":"2023-05"}]}},"description":"Representation of a partners invoice data","properties":{"active_companies":{"type":"array","description":"The list of companies that are active within the invoice period","items":{"type":"object","properties":{"company_uuid":{"type":"string","description":"unique identifier for the company associated with the invoice data"},"active_employees":{"type":"integer","description":"The number of active employees the company was or will be invoiced for that invoice period. Active employees are calculated as the count of onboarded employees hired before the end of the invoice period and not terminated before the start of the invoice period."},"active_contractors":{"type":"integer","description":"The number of active contractors the company was or will be invoiced for that invoice period. Active contractors are calculated as any contractor with an active contractor payment during the invoice period."},"initial_invoice_period":{"type":"string","description":"The first invoice period for the company. This will either be the invoice period of the first invoice-able event (first payroll or contractor payment) or the date they migrated to embedded, whichever is later."}}}}},"title":"Invoice-Data"},"examples":{"example":{"value":{"active_companies":[{"company_uuid":"05ed3150-591e-4f8b-bfd5-55d478edd2d8","active_employees":5,"active_contractors":3,"initial_invoice_period":"2022-01"},{"company_uuid":"9b37429c-e540-40fb-86b3-738ca9af65c7","active_employees":0,"active_contractors":1,"initial_invoice_period":"2023-05"}]}}}}}},"404":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided UUID is valid.\n"},"422":{"description":"Unprocessable Entity \n \nThis 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.\n","content":{"application/json":{"schema":{"description":"Unprocessable Entity\n \nThis 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.\n","type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["error_key","category"],"properties":{"error_key":{"type":"string","description":"Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error."},"category":{"type":"string","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."},"message":{"type":"string","description":"Provides details about the error - generally this message can be surfaced to an end user."},"metadata":{"type":"object","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.","oneOf":[{"type":"object","description":"multiple entities","required":["entities"],"properties":{"entities":{"type":"array","items":{"type":"object","description":"single entity","additionalProperties":true,"properties":{"entity_type":{"type":"string","description":"Name of the entity that the error corresponds to."},"entity_uuid":{"type":"string","description":"Unique identifier for the entity."},"valid_from":{"type":["string","null"]},"valid_up_to":{"type":["string","null"]},"key":{"type":["string","null"]},"state":{"type":["string","null"]}},"title":"Metadata-With-One-Entity"}}},"title":"Metadata-With-Multiple-Entities"},{"type":"object","description":"single entity","additionalProperties":true,"properties":{"entity_type":{"type":"string","description":"Name of the entity that the error corresponds to."},"entity_uuid":{"type":"string","description":"Unique identifier for the entity."},"valid_from":{"type":["string","null"]},"valid_up_to":{"type":["string","null"]},"key":{"type":["string","null"]},"state":{"type":["string","null"]}},"title":"Metadata-With-One-Entity"}]},"errors":{"type":"array","description":"Will only exist if category is `nested_errors`. It is possible to have multiple levels of nested errors.","items":"circular(Entity-Error-Object)"}},"title":"Entity-Error-Object"}}},"x-examples":{"bank_account_delete_unfunded_payments":{"errors":[{"error_key":"base","category":"invalid_operation","message":"FundingMethod has unfunded payments"}]},"bank_account_verify_incorrect_deposits":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Your bank account cannot be verified. Please check the test deposit amounts."}]},"bank_account_verify_already_verified":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Your bank account has already been verified."}]},"bank_account_missing_routing":{"errors":[{"error_key":"routing_number","category":"invalid_attribute_value","message":"Routing number is required."}]},"payment_configs_missing_parameter":{"errors":[{"error_key":"base","category":"missing_parameter","message":"At least one parameter must be provided"}]},"payment_configs_invalid_fast_payment_limit":{"errors":[{"error_key":"fast_payment_limit","category":"invalid_attribute_value","message":"Fast payment limit should be a number"}]},"pay_periods_invalid_end_date":{"errors":[{"error_key":"end_date","category":"invalid_parameter","message":"End date cannot be more than 3 months in future"}]},"company_industry_selection_naics_code_required":{"errors":[{"error_key":"naics_code","category":"invalid_attribute_value","message":"Naics code is required."}]},"company_industry_selection_naics_code_invalid":{"errors":[{"error_key":"naics_code","category":"invalid_attribute_value","message":"Naics code must be equal to 6 digits."}]},"company_industry_selection_sics_codes_invalid":{"errors":[{"error_key":"sic_codes","category":"invalid_attribute_value","message":"Sic codes must be equal to 4 digits"}]},"time_off_policy_name_required":{"errors":[{"error_key":"name","category":"invalid_attribute_value","message":"Name is required."}]},"time_off_policy_unlimited_invalid_accrual_rate":{"errors":[{"error_key":"accrual_rate","category":"invalid_operation","message":"Accrual rate must be blank for unlimited policies."}]},"time_off_policy_pending_requests":{"errors":[{"error_key":"time_off_policy","category":"invalid_operation","message":"Cannot deactivate policy with pending time off requests."}]},"time_off_policy_employees_required":{"errors":[{"error_key":"employees","category":"invalid_attribute_value","message":"Employees are required."}]},"time_off_policy_unlimited_balance_update":{"errors":[{"error_key":"base","category":"invalid_attribute_value","message":"Can not adjust balances for unlimited policies."}]},"holiday_pay_policy_already_exists":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Company already has a holiday pay policy."}]},"holiday_pay_policy_not_exists":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Company does not have a holiday pay policy, please create one"}]},"holiday_pay_policy_invalid_employees":{"errors":[{"error_key":"employees","category":"invalid_attribute_value","message":"Invalid employee uuids provided."}]},"onboarded_employee":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Cannot delete onboarded employee"}]},"invalid_attribute":{"errors":[{"error_key":"base","category":"invalid_operation","message":"There is an error in the request body."}]},"company_cannot_enable_contractor_only":{"errors":[{"error_key":"contractor_only","category":"invalid_attribute_value","message":"Contractor only cannot be enabled for existing companies."}]},"company_missing_parameter":{"errors":[{"error_key":"base","category":"missing_parameter","message":"contractor_only is required."}]},"starting_after_uuid_invalid":{"errors":[{"error_key":"starting_after_uuid","category":"invalid_attribute_value","message":"Parameter 'starting_after_uuid' does not correspond to a valid event."}]},"resource_uuid_invalid":{"errors":[{"error_key":"resource_uuid","category":"invalid_attribute_value","message":"Parameter 'resource_uuid' does not correspond to a valid resource."}]},"payroll_gross_up_invalid_net_pay":{"errors":[{"error_key":"net_pay","category":"invalid_attribute_value","message":"Net pay must be a number."}]},"payroll_accruing_hours_invalid":{"errors":[{"error_key":"base","category":"invalid_attribute_value","message":"Hours cannot be negative."}]},"payroll_cannot_cancel":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Payroll cannot be canceled."}]},"frozen_payroll":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This payroll has already been processed. Its data cannot be updated or altered."}]},"frozen_payroll_processing":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This payroll is being processed and cannot be updated at this time."}]},"unmodifiable_payroll_type":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This type of payroll cannot be modified or processed. It is reserved for system processes."}]},"invalid_employee_uuids_format":{"errors":[{"error_key":"employee_uuids","category":"invalid_attribute_value","message":"Parameter employee_uuids must be an array."}]},"maximum_employee_uuids_surpassed":{"errors":[{"error_key":"employee_uuids","category":"invalid_attribute_value","message":"Exceeded maximum of 100 for lookup."}]},"invalid_employee_uuid":{"errors":[{"error_key":"employee_uuids","category":"invalid_attribute_value","message":"Invalid Employee UUID(s).","metadata":{"entities":[{"entity_type":"Employee","entity_uuid":"invalid-uuid-123"}]}}]},"payroll_blocker_missing_bank_info":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must have a bank account in order to run payroll.","metadata":{"key":"missing_bank_info"}}]},"payroll_blocker_missing_employee_setup":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must add employees in order to run payroll.","metadata":{"key":"missing_employee_setup"}}]},"payroll_blocker_missing_federal_tax_setup":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must complete federal tax setup in order to run payroll.","metadata":{"key":"missing_federal_tax_setup"}}]},"payroll_blocker_missing_bank_verification":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company bank account must be verified in order to run payroll.","metadata":{"key":"missing_bank_verification"}}]},"payroll_blocker_suspended":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company is suspended and cannot run payroll.","metadata":{"key":"suspended"}}]},"submission_blocker_missing_selection":{"errors":[{"error_key":"submission_blockers","category":"invalid_attribute_value","message":"Submission blockers selections required"}]},"submission_blocker_invalid_option":{"errors":[{"error_key":"submission_blockers","category":"nested_errors","metadata":{"blocker_type":"fast_ach_threshold_exceeded"},"errors":[{"error_key":"selected_option","category":"invalid_attribute_value","message":"Selection is not available to resolve Fast ACH Threshold Exceeded. Please choose one of Wire In, Move To Four Day"}]}]},"invalid_version":{"errors":[{"error_key":"base","category":"invalid_resource_version","message":"You are attempting to update a resource using an out-of-date version."}]},"signatory_email_required":{"errors":[{"error_key":"email","category":"invalid_attribute_value","message":"Email is required"}]},"signatory_company_already_has_signatory":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Cannot have more than one signatory in a company. Please remove the existing signatory before adding a new one."}]},"mixed_disbursement_errors":{"errors":[{"error_key":"disbursements","category":"nested_errors","metadata":{"contractor_payment_uuid":"invalid-uuid-1"},"errors":[{"error_key":"contractor_payment_uuid","category":"not_found","message":"Disbursement not found."}]},{"error_key":"disbursements","category":"nested_errors","metadata":{"contractor_payment_uuid":"d0dfa222-ad08-4ea7-a06a-717688c3b179"},"errors":[{"error_key":"payment_method","category":"invalid_attribute_value","message":"Payment method must be one of: Direct Deposit, Check."},{"error_key":"payment_status","category":"invalid_attribute_value","message":"Payment status is not valid for payment method 'InvalidMethod'."}]}]},"not_found":{"errors":[{"error_key":"request","category":"not_found","message":"The requested resource was not found."}]},"finish_onboarding_incomplete":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Company is not ready to exit onboarding."}]},"company_location_validation":{"errors":[{"error_key":"street_1","category":"invalid_attribute_value","message":"Must include a street address"},{"error_key":"city","category":"invalid_attribute_value","message":"Must include a city"},{"error_key":"state","category":"invalid_attribute_value","message":"State is in the wrong format"},{"error_key":"zip","category":"invalid_attribute_value","message":"Please enter a valid zip code (e.g. 12345)."},{"error_key":"phone_number","category":"invalid_attribute_value","message":"Phone number must be 10 digits"}]},"conflict":{"errors":[{"error_key":"request","category":"duplicate_operation","message":"A resource with these attributes already exists."}]},"invalid_parameter":{"errors":[{"error_key":"request","category":"invalid_parameter","message":"The provided parameter is invalid or missing."}]},"flow_invalid_entity":{"errors":[{"error_key":"entity_type","category":"invalid_attribute_value","message":"Invalid flow entity"},{"error_key":"entity_uuid","category":"invalid_attribute_value","message":"Invalid flow entity"}]},"flow_nested_options_errors":{"errors":[{"error_key":"options","category":"nested_errors","metadata":{"flow_type":"company_forms"},"errors":[{"error_key":"form_types","category":"invalid_attribute_value","message":"Supplied value 'invalid' contains no permitted values"}]}]},"basic":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must complete all onboarding requirements in order to run payroll.","metadata":{"key":"needs_onboarding"}}]},"contractor_payment_invalid_wage":{"errors":[{"error_key":"wage","category":"invalid_attribute_value","message":"Wage must be greater than or equal to 0."}]},"contractor_payment_cannot_cancel":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Payment has already been processed and cannot be cancelled. Contact support directly."}]},"time_off_request_cannot_delete":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This time off request cannot be deleted."}]},"resource":{"errors":[{"error_key":"first_name","category":"invalid_attribute_value","message":"First name is required"},{"error_key":"date_of_birth","category":"invalid_attribute_value","message":"Date of birth is not a valid date"}]},"nested":{"errors":[{"error_key":"contractor_payments","category":"nested_errors","metadata":{"contractor_uuid":"72ae4617-daa9-4ed7-85e0-18ed5d0ee835"},"errors":[{"error_key":"hours","category":"invalid_attribute_value","message":"Ella Fitzgerald is paid fixed wage and hours cannot be set on a contractor payment"}]},{"error_key":"contractor_payments","category":"nested_errors","metadata":{"contractor_uuid":"2d7bf62c-babf-4a12-8292-340e2d9cab28"},"errors":[{"error_key":"wage","category":"invalid_attribute_value","message":"Isaiah Berlin is paid hourly and wage cannot be set on a contractor payment"}]}]},"compensation_invalid_rate":{"errors":[{"error_key":"rate","category":"invalid_attribute_value","message":"Rate is not a valid number"}]},"compensation_invalid_payment_unit":{"errors":[{"error_key":"payment_unit","category":"invalid_attribute_value","message":"Payment unit must be one of Hour, Week, Month, or Year"}]},"compensation_already_processed":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Compensation has already been processed on payroll."}]}},"title":"Unprocessable-Entity-Error-Object"},"examples":{"Basic":{"value":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must complete all onboarding requirements in order to run payroll.","metadata":{"key":"needs_onboarding"}}]}},"Resource":{"value":{"errors":[{"error_key":"first_name","category":"invalid_attribute_value","message":"First name is required"},{"error_key":"date_of_birth","category":"invalid_attribute_value","message":"Date of birth is not a valid date"}]}},"Nested":{"value":{"errors":[{"error_key":"contractor_payments","category":"nested_errors","metadata":{"contractor_uuid":"72ae4617-daa9-4ed7-85e0-18ed5d0ee835"},"errors":[{"error_key":"hours","category":"invalid_attribute_value","message":"Ella Fitzgerald is paid fixed wage and hours cannot be set on a contractor payment"}]},{"error_key":"contractor_payments","category":"nested_errors","metadata":{"contractor_uuid":"2d7bf62c-babf-4a12-8292-340e2d9cab28"},"errors":[{"error_key":"wage","category":"invalid_attribute_value","message":"Isaiah Berlin is paid hourly and wage cannot be set on a contractor payment"}]}]}}}}}}}}
\ No newline at end of file
diff --git a/docs/api/get-invoices-invoice-period.api.mdx b/docs/api/get-invoices-invoice-period.api.mdx
new file mode 100644
index 000000000..8e1e60b0c
--- /dev/null
+++ b/docs/api/get-invoices-invoice-period.api.mdx
@@ -0,0 +1,75 @@
+---
+id: get-invoices-invoice-period
+title: "Retrieve invoicing data for companies"
+description: "Retrieve data for active companies used to calculate invoices for Gusto Embedded Payroll. A company is considered active for an invoice period if they are an active partner managed company, have run payroll or created contractor payments since becoming a partner managed company, and are not suspended at any point during the invoice period. This endpoint forces pagination, with 100 results returned at a time. You can learn more about our pagination here: [pagination guide](https://docs.gusto.com/embedded-payroll/docs/pagination)"
+sidebar_label: "Retrieve invoicing data for companies"
+hide_title: true
+hide_table_of_contents: true
+api: eJztXFlvHLl2/itM5cFjoKvVaknWAuQmvl7u6MEzhu2JY8hGi111qpvjKrKGZLXVI+hX5CVv+Yv5CcE5JGvrRWpZCnBvPMDAdheXj4eHZyevo6t4VhmrYiEtzDS3QsnYLkuIzi4iKKaQppBGXwaRKsF9PU+js2gGNhZyoUQCJvwlLkELlUaDyPKZwf7nvgX2T8EkWpQ4QnQWvQOrBSyApdxylinNeGLFAliiipJLAYZVBlJmFUt4nlQ5t8DChNT+b4iavfII2Vu+1CrPh+y5H2LJhGGJkkakoCEN49NUMgzFHGQmMmbnsGRcA371bUuurQTNCi75DNIw8IDN+QKYriQr3axMaZZo4JYaSat5YpXGrwVIa5gRMgE2hUQVQs4Y3zwylymBkMoyU5kSJC6OW4YLKpWQlqWVxkHsHHqrGDL2YS4MA5m6lpnSSK2Sz4SkrRuwb8LO2f5oxDSYKreGabCVln4OZkUBQ/ZJVSzhkuXAtWSFQqJMVWWZqnRrNDYHDWfsovXLrBIpfPlpbm1pzvb2UpWYIbHXMFHFXmCn2JONvu813Z+yz/Kz/Av7n//+z/9i75fGQsGeJwkYw55Xdg7SioQafpZ/wXbd1VYGDFHl4q/ANWjqw0wyhwLcuvGjoWHjHBaQM+4Gt+orIEtQg58/fHhLXZUWf4Z18hT0jsvyE7kpnuLCTKJKOGOXgY3PNPD0MhpEBpJKC7uMzi6uI7dut2yEEZ1dfLn5MohKrnkBFrShZpIXEJ1FfqxJffQEnq6S23k0iDT8UQkNaXRmdQWDiGjBo7PryB3wyFhkpWgQwRUvyhx/Go/Go3i0H930T+yHObBCSTtn34BYNJzLPjNmSg/Zm8pYNsUf2adPnz7Fb97g7wW30c3gehUICR/QOCst4I8K9DIahFWWfAbROkD4gdk5t3jYcblgLKRD9nEOklXSlJCITECKjJ/nLFc8ZRzP6/R3SKxhlcyRATafmOH98IJegftLVUxBM5XVk5dApwmG7LVCUfC7QibAFgGPcbBTyHiVWxSG46P1gPxObsDjxcukqkRqVpC9FrkF3ZK8tUzwR8KJw0m7gSmVNODJ6tqj4AStlUZpGmQwyjEvTb3cKrVaiJQG7wovMYQhu/zXDtZ/OT7ZPx2P05MYjk9G8eH02TSeZseHMcDB6GD/2bN0NB4PptNpwk8PRvHxwXgcH57uJ/GUH2fx6cnx6JgfjflpcnRJdPP0+I+YtEf8/O15/O+gDdLBU86d9c7hyXhuoE+0l3gUCyG9zEm5hXjKUWU9f3vOFm5Qxo1RiSC9QBJoiRIUGyQcddV5xqSSgMwbyDJwbXhZ5l7YPTHsohBSFFXRHntHccRLEfueQs7+2Q8Yt35+ijBQ6Q6jraJCVgXq9vFofBSPnsX7R067E4s6ARJ+v0G5FXjF4GDj0Qj/6JLylRM+NVdFgwiVKEiLbVuU2PvdYIc17O+OVDSIrmIvymi6WqxdR30eJiHa5rXoLBodQXqwfzSKj073IT7MTpDZ0qP46Cg9PD6BNB2nJ9EgDAVFmasl4FBHg2b8oP1NdHaAPCWs4PmkJ6eJTGMnZ1dgnE4Pjg/Hp0kMR4ej+HCUTeOTZ9OD+PjgJOGnPHt2lByvhTFaD2N/O4yDeHQU3Xy5WZH476DUYEBapwVV1hgupj69aL9Fg6jUaB9a4ei+Sux6p7jWfLlWlufCWJykETMk2MkkcxIEj5AXSV3hgYfXQmHWcUQXWZfUq9zdhVVJ8UcFTKRoemQCNJmPOH+Qb/0D3sZGpLlZt1EremQdPWStMPzy6wE6CL5xg+YnCeJpPXnqkaJm7MnZ5/3R2socDcEwfiVpP5ScKq5RYjdd5igZ2RQytA2xNcgU265uDVm0qAWcuKQZWv2M5dqu7zls0a7Dz/ejXmuIB6Ffe7xVCuLILU+AeKNxLFZ9hC1WvVPq68/vbQyMlMiENv1V9Pl46GxpIgIIOweNtFizm36nOmPGfJoDgwUu4yf3pe0Xraz1KfOTo9J0flch0PV0/l7QXwP2bS6SOSxAo2ZC0uphdIP/DSIrLJmr3sOMX/qztkH6L3he/VADd1MDjsCHo8NVTf2Lsuy1qmTKPkvGPktkr9rqRv2tKo2CT4GhMw9Xwtghe8O/AjOVP/K1Afjbb+cvcWcXPBfp8LPE/Tscj1en/U2WWqE/RIz2Slo0kwMCYVjBl2zOyxIk+4aGP84yVSmZ0mRNeYzEi1xI4+xUw0yVzPG0okuGICbcWi2mlYUJcczlILBqGCHjIjcsrQA5lcumZx0euRyy9+BWevHKTfOCW5gpLcDsaLQRzDipuz91DjadXnLLU7AICIm3g9F0O3V/ELdP3L5Z0bgHF5FbMJrBXWPD/75q/Gw0VlZGnXwF7OBRLjfMQa1uVQbvvTdscCOD3iaHTSVJpc2QfViWAj2TJbO49V9h2dg+TmvWe7hXxyOYhjzI7npI0lo16h2g4QjYltxgGomhlAlDBenhuYzNtKpKIWeG7AwMWk2hjhxOK5GnLEE+KHz7OZdpjopWSMe9rbAn+WP1RMKwS0mCbeL28XJA4NxeOVXpWZ5x5lqyS9+U+U1aOs0PTmS5j0SaAs/bDG6nzNuwXs+NPhLX7F3MZiBBN7vmhw7EMJXOeOIIgh66TJE+2qOwnKzUNazYhfEiHG4NOSw4GiwYuLUqMMjSn2SvAoRkdKbRcSCx4SXSNPfhDq+cB50hCB+R6tL9OUFUl7S34RfUjpe1uRaUCfqsSsKvGSn07WspqtwKdDhpRDxHvYMXfl49bOHLDke6O7cRchZmxm48TQV+4vnb1kwuXLdmbkeQ27nmF15AsNU8RcmWbdgmUdr52ynGP4kbWgS+fYbfNrpGbhga0UnvTKuiGfCiGVFWeR59qdtV5cSq7Q07cm5dA2O5hW1NWrbjG8/98Udh5/GvEmKn/KKbza3eeN5xTXFr0HL7sed//3uOI21U2F06fETho2S+dAYuxTs3q40hO6fwdKmMEWhiWeUSSLUcomSEwb3zaiQoilqsRInQ6F3qnxzcmIyf+FdiuKdRe4VrGjiG7obGplx+nfCEvPxJCjlYmFQyqzDfNAmJq7YRc9GxNSKMdbYNE0pFdI21qKXmoteVTIWcvQE7Vymbc4y9u9nqNJnbgw6wBWiRLSdCEusmiLRURjwosk9oBuCszM+KmhO9lykwml9gRuFtDtwAS+aQfHVGClqsHg7jBXZE1b5pCTzHbM9yEkZ81AUgef2EbAogm3WsAVgIgxJqolWFuZwtwHyLiYutrIfYM/I7QN+5/iE241M2qHY9Ls8J6LdmYmZqaLWtuRPVVnu3wTy3mN/EkKOkTK83ZgufuAqGxXpgYbUZNzaclkkuCmG3IFzTeGcSvuYuukIxIxqDmbmqcgyqoRnqdiZg9g5+gxdkOkm9tNyAsm6yFtt6Wr6SqQvmNCencBE+LtmBSxtiyJhlla00OHwh3CFkWhmrlxMDOSTI3RPJRWImiUph0hhmGxE3rXen5y/Yl2HfNex4N4R+mscHGFgT/qh4jlrkGUvFTNRiZwtcEwCYO8A1InFtd0f7XiSE1ayCPfRgHVYsNJioLJuUKhfJcoKJubvtdXEvIhbr9rcPopJ0oiCtzwtPEl3xfKK3n5lOsx0k93PXj2G/mmLTHEU5WlY1HkYABZgNwLFMhES4C6Rs0469rrugfeEOdwoUXUTIbgzn43oMVELCVJaFqM4mzHXA8i7b3kQ3d977V508x505YMpzLhOYVOUt8nKztt6G6gWXLjee/k7b7mYz27d9rnKRolTH/x3gYFaQIfqQVtGLkODyZgSZFMwjQA3kN38zNKns48GqQ8xkSa8DNmClN9moMAvV/EaotXpsp+genhXPXZs6j8aoxqEVwyB8db6thvOQ9AtnGA3+Nak9B2FlMQ+I4APFHoVplYvIThQYg8s9jebMiglIjB+1shoTdMK2YOu33P2YNskr8vca+8ZhcYk04nKUfXVaqYf/Me3Y3hrXqDnKseIAPLOgyde/ixWw2mt3+r2t7eona8Z70hzjJjRBcUrmDwrmFP0qQmjxrvg77b8LeWekWzGH1o1LgymHyUwrYzDcESaXQM7ANlvHt9jd3AHyEWqLIvgFPUhkteCOzFWl72IY3k/V/Yyjt06OhBnH7GQPjT/jCerB/AHljS8MbgFwU9THI9PqT5ATj+NBJR1Gffz0Ky65T7phbOHcGhdObzA6syPFDBnH6rwNaCd+lO1++3cBF4ZNwRfuOcAh1dKDSqFGYVwNsQNbyUKlIhMktgPkEM18SLAhY1SubLYD4CjZIbkTlAb0wktxV7BbNwoyvG8buMLEia9mvd1OqIsu7y2AuiM1p1oyCk96nAW/woq+Pk5T6ZLjmh8R6qurBACtCI8BdwJrzJGquVJfq3IbLR8RWDC4gg9AJQc/mafDqJv7avI6F72ge+0+RL1YeZg/xn/G++MDqp1oC7RprpKvoGvlT0E3ITO1E/P3RltrDBNHeEO4EwcUkimdgkb91Lqu0F++m3sV5/b11JtjwFbl4yyKp+2qs3stpwdz+5oySDGVOrH86jGXhXYhGeB+Pmb5FaP57rfGVdh3YEUXE3ZFIg++zA4bBokVotDfwZcd0OsXWV+befBFCdO+k9MowVuX0EBykE01pVUpubI1dcxum2m+0v0+obp6EBYGYfXkjQ8RbQLcaOXvRdtJl/XoF2bz0phC6DyZT+xcg5mrPJ2AVz5RK3/XR0DLghrr7rQKdEEWoLDNgouc+2QeWvz5AhjF5p+/+Jl9COBY0Iyt/JFShoIRqCQ/Cg3sXA7YG7UA9kFhcZ1mLzmlI9sK05fo38tsqt2XRX3ToZM7chXW1kJRurs8ypt0jDf1HJWhi2uSqcrGKovpux8wuJliJrlVGkN7XOR3C+txkd8npMdF3nZ0+wCC3x2iY3NuJvXXh4+muGxunfDAza1nY1QeVJfZejbQUOCOU+o8BA+aLr4+GusE6LaghG84aDD0xBWkk1SYaaUNUDKpyVtvWFi79Q6nrxVbCHmrtdbPlrO3aYguBmUnGdaVdqj7sgWaTh01cVR45OWlozTj4/E45unoJD4Efhzz0TMeH+8fPzs5SQ6m+8enWxYdRiso230f298l+Fz/Wn86qXHGXgrMhbOXLvk8YC8wKe1uqq1DgfUR1b08EIfC9Q+iz1nUWat03aN84q1tl+J/MgwyrNncbcEaiv3dhSs21BxjGX+PR6JMSGHmEx/lRO2KhQTO9HqEmLQnkPPxsZD9SljWTN6LCebKWTETGvo2K8xYDWAn+7vvIt3EFDLJqxQluhsIZYsGY1Z4JnElSt83Bw3SH9lV6eyuei3d/DYhSvxNKzlr3yVtz/GnKO/B5k4kg0RfO0Tx/hSlS7r+BMPZkO2PDw6Pnq45YnMl4d71EG+xd6iGCId8f9RJlGLFQS6SbZGGtYcnrVwFOGxKPbaOjr+4ZFrlvU2wyqVweg78XQLZa2FtryP40L4e0NRk0O67fcHabGcphzOeq2+t8gaq5dpW3ND49veOJuCUoZqvzxDtGMHDTFAv0msyZ8Oa23W+b3h3dUizeEM7SCk8aGaLpsPv1OdeHgjWBEPK6BN74vs8aW4SSIX3jgphbWhlglaZciOSR/bO6aZ4Lb+DtemedNjJhZUAqWnpIe8GrrE/At2++eLwDav75i7E70jwj1gWHuTMjNKi2pusuinUGNWKagXdI8boyZLYHCTvxZwdAozhM6pMT/C1jLJU2rKUjKN82c/we3EU1uAyoA8eh+4VP7QguwnTXjZrW7kY3qSb3K/g5TXdwpO9spcVaZWSfsgmU6HpwYgdZ3lJefWMUffaNfYalMomnAFIMuduadq6FvQ+Rrw33o/HHA6f7R/HKeen8SGkx/HJEYzi/RNIj9IRwMnB0RaRRtmwezilec7Za2H/nGEoLqWKX47CHN01hgeWeHjey4YZQBuRXMT+Pck1js4DU2qcHk+zZ2N8LmGaxYd8fxyfjE/H8cHhCMbpacKn45MtlLqfFDo3XPA5+yvoXMiaTEiXfEkk+uZvr9yNQsGmBmmcPV3HPbbX7Wyu1dpawuqt0Tant4su1yKpnUu5tT600+ze3hr27nmMDFOwA/YR4CuGmqSd09W7T8DXoQ5Bk1r2PrCrFCbaJu1VS6HedAr4O7cV47XF7t1bwH8NhkJ9B/jv1mK4GUTvWnrjtgX9gyiQm0H0S61BblvzD1XyQ5V8hyoJt9+vYlMC/wrcLGM8BLFagNYiBff0Hb2YZUEacrBwLW4VG9/SGwTGbb+phzsS+m2aru5I0+J7Oj6mGHDQU19n0d5ify+8K7Z33b3ff0NPjOlFeDqs0jnypr8rzUvhrkrHKRR0X3rlvtNLKFTUJYobL3bBUvyMi9kw8Nox32oKjG4as8TPuNzwNtp7eseNJLoXve0n0uoLWzh5eL4I/z2lp+DWXGelIcIzcJ3H5ZBLVx9h23WG95135noTUCTFFQIEveaeM3z+9hy3PGR72o8pDSJ8QcX8mr0HvRAJtCjd3HSny8F71HAvxalRDcf0b8zaGN915UIb5IkqKJlFOJ6YlYcV6empVCVVER4E+if/5AB3wSn/tNbLMCt7h9fCfQTCJXqQVfzXf2s4A6lRKmMLLlvj1A9EOl5GbVo/Fdm83tFbyHXzBsKPFyZ/vDD544XJ8MKkl10WruxemXNBQo7E9bXXIBfRYp/ewPMvtg6is94rMV+wdN5YbHp9jcbybzq/ucGf3WuDqFpSQXb5hkfz2sfz/+j1xg1LDw7XrK1hSYfdfQUP9qDjdoykW+4J8f/Jy45bCdh/+7Ih5Rf8h6bi1B2Z96d33iF6yh7qWdQNawj30OWyDT2srXdC3fUW94Dlbgv6B3/Ncgt7rH8KtHPeXENUE6VtfVt5Y6ljnf/t1Qd86qFrO9a2ov9L662S7g5fX7sWH1Bv3NzUG056xL3S9b9kDPvz
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Retrieve data for active companies used to calculate invoices for Gusto Embedded Payroll. A company is considered active for an invoice period if they are an active partner managed company, have run payroll or created contractor payments since becoming a partner managed company, and are not suspended at any point during the invoice period. This endpoint forces pagination, with 100 results returned at a time. You can learn more about our pagination here: [pagination guide](https://docs.gusto.com/embedded-payroll/docs/pagination)
+
+> 📘 System Access Authentication
+>
+> This endpoint uses the [Bearer Auth scheme with the system-level access token in the HTTP Authorization header](https://docs.gusto.com/embedded-payroll/docs/system-access)
+
+scope: `invoices:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-notifications-notification-uuid.ParamsDetails.json b/docs/api/get-notifications-notification-uuid.ParamsDetails.json
new file mode 100644
index 000000000..7cb4f1565
--- /dev/null
+++ b/docs/api/get-notifications-notification-uuid.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"notification_uuid","in":"path","required":true,"schema":{"type":"string"},"description":"The notification entity_uuid"},{"name":"X-Gusto-API-Version","in":"header","required":false,"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.","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"}}]}
\ No newline at end of file
diff --git a/docs/api/get-notifications-notification-uuid.RequestSchema.json b/docs/api/get-notifications-notification-uuid.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-notifications-notification-uuid.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-notifications-notification-uuid.StatusCodes.json b/docs/api/get-notifications-notification-uuid.StatusCodes.json
new file mode 100644
index 000000000..78368ef39
--- /dev/null
+++ b/docs/api/get-notifications-notification-uuid.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"Example response","content":{"application/json":{"schema":{"type":"object","properties":{"uuid":{"type":"string","description":"Unique identifier of a notification."},"company_uuid":{"type":"string","description":"Unique identifier of the company to which the notification belongs."},"title":{"type":"string","description":"The title of the notification. This highlights the actionable component of the notification."},"message":{"type":"string","description":"The message of the notification. This provides additional context for the user and recommends a specific action to resolve the notification."},"status":{"type":"string","description":"Represents the notification's status as managed by our system. It is updated based on observable system events and internal business logic, and does not reflect resolution steps taken outside our system. This field is read-only and cannot be modified via the API.","enum":["open","resolved","expired"]},"category":{"type":"string","description":"The notification's category."},"actionable":{"type":"boolean","description":"Indicates whether a notification requires action or not. If false, the notification provides critical information only."},"can_block_payroll":{"type":"boolean","description":"Indicates whether a notification may block ability to run payroll. If true, we suggest that these notifications are prioritized to your end users."},"published_at":{"type":"string","description":"Timestamp of when the notification was published."},"due_at":{"type":["string","null"],"description":"Timestamp of when the notification is due. If the notification has no due date, this field will be null."},"template_variables":{"type":"object","description":"An object containing template variables used to render the notification. The structure of this object depends on the notification category. Each category defines a fixed set of variable names (keys), which are always present. The values of these variables can vary depending on the specific notification instance.","additionalProperties":{"type":"string"}},"resources":{"type":"array","description":"An array of entities relevant to the notification","items":{"type":"object","properties":{"entity_type":{"type":"string","description":"The type of entity being described.","enum":["BankAccount","Contractor","ContractorPayment","Employee","Payroll","PaySchedule","RecoveryCase","Signatory","Wire In Request"]},"entity_uuid":{"type":"string","description":"Unique identifier of the entity"},"reference_type":{"type":"string","description":"Optional. The type of a resource that is related to the one described by entity_type and entity_uuid. For instance, if the entity_type is “BankAccount”, the reference_type could be the “Employee” or “Contractor” to whom the bank account belongs."},"reference_uuid":{"type":"string","description":"Optional. Unique identifier of the reference."}},"required":["entity_type","entity_uuid"]}}},"required":["uuid","company_uuid","title","message","category","actionable","status","published_at","due_at","resources","can_block_payroll"],"title":"Notification"},"examples":{"Example":{"value":{"uuid":"7b1d0df1-6403-4a06-8768-c1dd7d24d27a","company_uuid":"88f7cca1-dcad-4d20-84db-7fb80303d69f","title":"Action required: Additional information needed to process payroll","message":"If we do not receive this information as soon as possible, your payroll may not be processed on time.","status":"open","category":"information_request","actionable":true,"can_block_payroll":true,"published_at":"2022-01-01T00:00:00.000Z","due_at":"2022-02-01T00:00:00.000Z","template_variables":{"blocked_task":"Payroll"},"resources":[{"entity_type":"Employee","entity_uuid":"21b6f9ce-0ac4-4745-8d8a-127f8c0f00f2"}]}}}}}},"404":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided UUID is valid.\n"},"422":{"description":"Unprocessable Entity \n \nThis 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.\n","content":{"application/json":{"schema":{"description":"Unprocessable Entity\n \nThis 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.\n","type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["error_key","category"],"properties":{"error_key":{"type":"string","description":"Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error."},"category":{"type":"string","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."},"message":{"type":"string","description":"Provides details about the error - generally this message can be surfaced to an end user."},"metadata":{"type":"object","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.","oneOf":[{"type":"object","description":"multiple entities","required":["entities"],"properties":{"entities":{"type":"array","items":{"type":"object","description":"single entity","additionalProperties":true,"properties":{"entity_type":{"type":"string","description":"Name of the entity that the error corresponds to."},"entity_uuid":{"type":"string","description":"Unique identifier for the entity."},"valid_from":{"type":["string","null"]},"valid_up_to":{"type":["string","null"]},"key":{"type":["string","null"]},"state":{"type":["string","null"]}},"title":"Metadata-With-One-Entity"}}},"title":"Metadata-With-Multiple-Entities"},{"type":"object","description":"single entity","additionalProperties":true,"properties":{"entity_type":{"type":"string","description":"Name of the entity that the error corresponds to."},"entity_uuid":{"type":"string","description":"Unique identifier for the entity."},"valid_from":{"type":["string","null"]},"valid_up_to":{"type":["string","null"]},"key":{"type":["string","null"]},"state":{"type":["string","null"]}},"title":"Metadata-With-One-Entity"}]},"errors":{"type":"array","description":"Will only exist if category is `nested_errors`. It is possible to have multiple levels of nested errors.","items":"circular(Entity-Error-Object)"}},"title":"Entity-Error-Object"}}},"x-examples":{"bank_account_delete_unfunded_payments":{"errors":[{"error_key":"base","category":"invalid_operation","message":"FundingMethod has unfunded payments"}]},"bank_account_verify_incorrect_deposits":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Your bank account cannot be verified. Please check the test deposit amounts."}]},"bank_account_verify_already_verified":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Your bank account has already been verified."}]},"bank_account_missing_routing":{"errors":[{"error_key":"routing_number","category":"invalid_attribute_value","message":"Routing number is required."}]},"payment_configs_missing_parameter":{"errors":[{"error_key":"base","category":"missing_parameter","message":"At least one parameter must be provided"}]},"payment_configs_invalid_fast_payment_limit":{"errors":[{"error_key":"fast_payment_limit","category":"invalid_attribute_value","message":"Fast payment limit should be a number"}]},"pay_periods_invalid_end_date":{"errors":[{"error_key":"end_date","category":"invalid_parameter","message":"End date cannot be more than 3 months in future"}]},"company_industry_selection_naics_code_required":{"errors":[{"error_key":"naics_code","category":"invalid_attribute_value","message":"Naics code is required."}]},"company_industry_selection_naics_code_invalid":{"errors":[{"error_key":"naics_code","category":"invalid_attribute_value","message":"Naics code must be equal to 6 digits."}]},"company_industry_selection_sics_codes_invalid":{"errors":[{"error_key":"sic_codes","category":"invalid_attribute_value","message":"Sic codes must be equal to 4 digits"}]},"time_off_policy_name_required":{"errors":[{"error_key":"name","category":"invalid_attribute_value","message":"Name is required."}]},"time_off_policy_unlimited_invalid_accrual_rate":{"errors":[{"error_key":"accrual_rate","category":"invalid_operation","message":"Accrual rate must be blank for unlimited policies."}]},"time_off_policy_pending_requests":{"errors":[{"error_key":"time_off_policy","category":"invalid_operation","message":"Cannot deactivate policy with pending time off requests."}]},"time_off_policy_employees_required":{"errors":[{"error_key":"employees","category":"invalid_attribute_value","message":"Employees are required."}]},"time_off_policy_unlimited_balance_update":{"errors":[{"error_key":"base","category":"invalid_attribute_value","message":"Can not adjust balances for unlimited policies."}]},"holiday_pay_policy_already_exists":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Company already has a holiday pay policy."}]},"holiday_pay_policy_not_exists":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Company does not have a holiday pay policy, please create one"}]},"holiday_pay_policy_invalid_employees":{"errors":[{"error_key":"employees","category":"invalid_attribute_value","message":"Invalid employee uuids provided."}]},"onboarded_employee":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Cannot delete onboarded employee"}]},"invalid_attribute":{"errors":[{"error_key":"base","category":"invalid_operation","message":"There is an error in the request body."}]},"company_cannot_enable_contractor_only":{"errors":[{"error_key":"contractor_only","category":"invalid_attribute_value","message":"Contractor only cannot be enabled for existing companies."}]},"company_missing_parameter":{"errors":[{"error_key":"base","category":"missing_parameter","message":"contractor_only is required."}]},"starting_after_uuid_invalid":{"errors":[{"error_key":"starting_after_uuid","category":"invalid_attribute_value","message":"Parameter 'starting_after_uuid' does not correspond to a valid event."}]},"resource_uuid_invalid":{"errors":[{"error_key":"resource_uuid","category":"invalid_attribute_value","message":"Parameter 'resource_uuid' does not correspond to a valid resource."}]},"payroll_gross_up_invalid_net_pay":{"errors":[{"error_key":"net_pay","category":"invalid_attribute_value","message":"Net pay must be a number."}]},"payroll_accruing_hours_invalid":{"errors":[{"error_key":"base","category":"invalid_attribute_value","message":"Hours cannot be negative."}]},"payroll_cannot_cancel":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Payroll cannot be canceled."}]},"frozen_payroll":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This payroll has already been processed. Its data cannot be updated or altered."}]},"frozen_payroll_processing":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This payroll is being processed and cannot be updated at this time."}]},"unmodifiable_payroll_type":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This type of payroll cannot be modified or processed. It is reserved for system processes."}]},"invalid_employee_uuids_format":{"errors":[{"error_key":"employee_uuids","category":"invalid_attribute_value","message":"Parameter employee_uuids must be an array."}]},"maximum_employee_uuids_surpassed":{"errors":[{"error_key":"employee_uuids","category":"invalid_attribute_value","message":"Exceeded maximum of 100 for lookup."}]},"invalid_employee_uuid":{"errors":[{"error_key":"employee_uuids","category":"invalid_attribute_value","message":"Invalid Employee UUID(s).","metadata":{"entities":[{"entity_type":"Employee","entity_uuid":"invalid-uuid-123"}]}}]},"payroll_blocker_missing_bank_info":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must have a bank account in order to run payroll.","metadata":{"key":"missing_bank_info"}}]},"payroll_blocker_missing_employee_setup":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must add employees in order to run payroll.","metadata":{"key":"missing_employee_setup"}}]},"payroll_blocker_missing_federal_tax_setup":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must complete federal tax setup in order to run payroll.","metadata":{"key":"missing_federal_tax_setup"}}]},"payroll_blocker_missing_bank_verification":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company bank account must be verified in order to run payroll.","metadata":{"key":"missing_bank_verification"}}]},"payroll_blocker_suspended":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company is suspended and cannot run payroll.","metadata":{"key":"suspended"}}]},"submission_blocker_missing_selection":{"errors":[{"error_key":"submission_blockers","category":"invalid_attribute_value","message":"Submission blockers selections required"}]},"submission_blocker_invalid_option":{"errors":[{"error_key":"submission_blockers","category":"nested_errors","metadata":{"blocker_type":"fast_ach_threshold_exceeded"},"errors":[{"error_key":"selected_option","category":"invalid_attribute_value","message":"Selection is not available to resolve Fast ACH Threshold Exceeded. Please choose one of Wire In, Move To Four Day"}]}]},"invalid_version":{"errors":[{"error_key":"base","category":"invalid_resource_version","message":"You are attempting to update a resource using an out-of-date version."}]},"signatory_email_required":{"errors":[{"error_key":"email","category":"invalid_attribute_value","message":"Email is required"}]},"signatory_company_already_has_signatory":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Cannot have more than one signatory in a company. Please remove the existing signatory before adding a new one."}]},"mixed_disbursement_errors":{"errors":[{"error_key":"disbursements","category":"nested_errors","metadata":{"contractor_payment_uuid":"invalid-uuid-1"},"errors":[{"error_key":"contractor_payment_uuid","category":"not_found","message":"Disbursement not found."}]},{"error_key":"disbursements","category":"nested_errors","metadata":{"contractor_payment_uuid":"d0dfa222-ad08-4ea7-a06a-717688c3b179"},"errors":[{"error_key":"payment_method","category":"invalid_attribute_value","message":"Payment method must be one of: Direct Deposit, Check."},{"error_key":"payment_status","category":"invalid_attribute_value","message":"Payment status is not valid for payment method 'InvalidMethod'."}]}]},"not_found":{"errors":[{"error_key":"request","category":"not_found","message":"The requested resource was not found."}]},"finish_onboarding_incomplete":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Company is not ready to exit onboarding."}]},"company_location_validation":{"errors":[{"error_key":"street_1","category":"invalid_attribute_value","message":"Must include a street address"},{"error_key":"city","category":"invalid_attribute_value","message":"Must include a city"},{"error_key":"state","category":"invalid_attribute_value","message":"State is in the wrong format"},{"error_key":"zip","category":"invalid_attribute_value","message":"Please enter a valid zip code (e.g. 12345)."},{"error_key":"phone_number","category":"invalid_attribute_value","message":"Phone number must be 10 digits"}]},"conflict":{"errors":[{"error_key":"request","category":"duplicate_operation","message":"A resource with these attributes already exists."}]},"invalid_parameter":{"errors":[{"error_key":"request","category":"invalid_parameter","message":"The provided parameter is invalid or missing."}]},"flow_invalid_entity":{"errors":[{"error_key":"entity_type","category":"invalid_attribute_value","message":"Invalid flow entity"},{"error_key":"entity_uuid","category":"invalid_attribute_value","message":"Invalid flow entity"}]},"flow_nested_options_errors":{"errors":[{"error_key":"options","category":"nested_errors","metadata":{"flow_type":"company_forms"},"errors":[{"error_key":"form_types","category":"invalid_attribute_value","message":"Supplied value 'invalid' contains no permitted values"}]}]},"basic":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must complete all onboarding requirements in order to run payroll.","metadata":{"key":"needs_onboarding"}}]},"contractor_payment_invalid_wage":{"errors":[{"error_key":"wage","category":"invalid_attribute_value","message":"Wage must be greater than or equal to 0."}]},"contractor_payment_cannot_cancel":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Payment has already been processed and cannot be cancelled. Contact support directly."}]},"time_off_request_cannot_delete":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This time off request cannot be deleted."}]},"resource":{"errors":[{"error_key":"first_name","category":"invalid_attribute_value","message":"First name is required"},{"error_key":"date_of_birth","category":"invalid_attribute_value","message":"Date of birth is not a valid date"}]},"nested":{"errors":[{"error_key":"contractor_payments","category":"nested_errors","metadata":{"contractor_uuid":"72ae4617-daa9-4ed7-85e0-18ed5d0ee835"},"errors":[{"error_key":"hours","category":"invalid_attribute_value","message":"Ella Fitzgerald is paid fixed wage and hours cannot be set on a contractor payment"}]},{"error_key":"contractor_payments","category":"nested_errors","metadata":{"contractor_uuid":"2d7bf62c-babf-4a12-8292-340e2d9cab28"},"errors":[{"error_key":"wage","category":"invalid_attribute_value","message":"Isaiah Berlin is paid hourly and wage cannot be set on a contractor payment"}]}]},"compensation_invalid_rate":{"errors":[{"error_key":"rate","category":"invalid_attribute_value","message":"Rate is not a valid number"}]},"compensation_invalid_payment_unit":{"errors":[{"error_key":"payment_unit","category":"invalid_attribute_value","message":"Payment unit must be one of Hour, Week, Month, or Year"}]},"compensation_already_processed":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Compensation has already been processed on payroll."}]}},"title":"Unprocessable-Entity-Error-Object"},"examples":{"Basic":{"value":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must complete all onboarding requirements in order to run payroll.","metadata":{"key":"needs_onboarding"}}]}},"Resource":{"value":{"errors":[{"error_key":"first_name","category":"invalid_attribute_value","message":"First name is required"},{"error_key":"date_of_birth","category":"invalid_attribute_value","message":"Date of birth is not a valid date"}]}},"Nested":{"value":{"errors":[{"error_key":"contractor_payments","category":"nested_errors","metadata":{"contractor_uuid":"72ae4617-daa9-4ed7-85e0-18ed5d0ee835"},"errors":[{"error_key":"hours","category":"invalid_attribute_value","message":"Ella Fitzgerald is paid fixed wage and hours cannot be set on a contractor payment"}]},{"error_key":"contractor_payments","category":"nested_errors","metadata":{"contractor_uuid":"2d7bf62c-babf-4a12-8292-340e2d9cab28"},"errors":[{"error_key":"wage","category":"invalid_attribute_value","message":"Isaiah Berlin is paid hourly and wage cannot be set on a contractor payment"}]}]}}}}}}}}
\ No newline at end of file
diff --git a/docs/api/get-notifications-notification-uuid.api.mdx b/docs/api/get-notifications-notification-uuid.api.mdx
new file mode 100644
index 000000000..10bb7be57
--- /dev/null
+++ b/docs/api/get-notifications-notification-uuid.api.mdx
@@ -0,0 +1,75 @@
+---
+id: get-notifications-notification-uuid
+title: "Get a notification's details"
+description: "Upon receiving a notification webhook event, use this endpoint to fetch the notification's details. The notification details include basic suggested content that can help you build notifications in your platform."
+sidebar_label: "Get a notification's details"
+hide_title: true
+hide_table_of_contents: true
+api: eJztXN1yG7eSfhXsnAvbVRyZomVL0dU6tpPjCycu29nsWcdFg4MeEtEMMAEwkhmXqvIgOS+XJ9nqBjB/HFKULF3klKuSSsTBzweg0f11o4HPyad0WVunU6kcLA13UqvUrStITt8nUC5ACBDJh0ni+NLibz9oJ3OZUUGLH3QFvtpLkZwmS3Cp6hbp/TWvaymSSSLAZkZW+FNymvxUacUMZCDPpVoyzrpV2AUsVlqfMTgH5SastsDcSloGSlRaKsecZjm4bMXcCnpV71kmwHFZ2AP2bvAtfmFSZUUtgC24lRmz9XIJ1oFgmVYOsPUVdyzjiq2gqNha12xRy0L0GsNW8JNhVcFdrk158Iv6Rf2gHZyyihunwFjGDTADttLKykUBLNeGIAso5DmYNeNKMK7WLMMFKZl13AErueJLKBGKzjd7dSuQhvGqKsKvB+wN5GBwVhDQ+9B9f/DLWgr4cH/lXGVPHz4UOrMHJAYHmS4fxmVPK742uijo+8PQUH91H9AoSm2gmWoc+ct8YzHYTz+9fM6kxR9ZrmslJlQmzAiwC1kUbAHsaHrEftCOfYdlDthIU/css3VVaeNQXAR33LfLCq2WYNg5L+TW1mcz9pOqjM7AWo7L8EI56dYE22a6glP2sTfEUwNcfEwmScUNL8GBwX3wOVG8hOQ0GRNviVJdcbdKJomB32ppQCSnztQwSWy2gpInp58Tv8sS64xUy+RyuCs2JBYIqO/jctIA+N/0e9rAT1+/TP8HjMXaAcIKuADTA5HzwsKwq+c4qlIqsF4guYN0wS0I9vT1S3buG2XcWp1JjpvjQrqVF3gskPGioIVSWgEuRWX0uRQgJr5MRzrvWfa+lEqWddlt+5qiyCuZhppSLf8RGkw7Pz9AGLUFcZBsn/JJAqouUanNprPH6fRJevgYNZqAnNeFS067v19efsB59OJksbHZdIr/6U/li0+8rIpW8JJJEjQJlu3MxMNfLVb4vIlOL36FzKHAGdStTvruaN1HxjDQpUr+VgOTAqUll2BQa/Q16gHKWqbLiqsgTTdrFUUlNIPa5mIlR3QwWwDuSkudOukKuLo3lHwqGnvpoWfvUPuv5HJVyOXKeZHlGX6j/YyQtAr6cqM2wihx6y/3BBIK74ASpN0yLoQkGIW3Hp9co+NrC4b0u4FMlyUoYRlntoIMWwvwcRYNWF2cwzhwtAi1vRr3G6gMWFBhcoa6k1ph3AbbIthiTbbCrq2D8oC9dLR7KkF73SsCrZheWDDnNMe+pDfJlsaF9MHgyBe1RUViWaGXMpvQR6HB630DeQGZ86OsaczWQWWZ42egmK6dlQJ6YGiKcwmFQFCoi1OtCm8sM66w1QWwUguUS8HOJacxP3398qCzwXUFivQgzS7qaPhUkUb8gJuBO1hqs95PIgbTGSvTCrVy2GlroXUBXG009lIJbAYsu1iBW6GE9PdOUNs2yocmM06q1uvxze3WCGNmpJMZL5hUSEj8V5w5v/25mi8KnZ3Ng2K9DbglXzNqlPGFLKQjtWBqxUIf3pijFWQXEKmWJ1huBRYG7Ab5UmWkxoH8DgIbI3MCStB+8jqlqheFtCsQc+72WD9ZgnW8rHA/X6xAbc7gBbesaZS6EDX0Gn/ftq7qovAm45q9SMtEDaP0hq04sRlRe1M88XzX74HIY7Bjr1OhRNIJ83NuJAqeHTMlfXxPcTPjF9JTXKIVZbEh1jREBtQrJSXAjOo/YNaZOnO1CSpS2ti2gIr0nB4ZfrNp2AuerZo/mYCcaAhnufwEglkgNR4hMeQ8lt0/g7V9MAkmB+WEFxd8jaqY1J4Hds6LGmxQ3LY7LqTz55y6Q4g4+gCy0cj9xVLWcZUBapRWyb/umecBm7v0yqY2We8zN4avx9aDPiBWYnkSUNUVcM69fzOcPyR4DsrRpe6zhkAafaG9DO+6ggbHmi2AODYVW3g6FXXqt1ydPc0yXSvs9plWzvDMadP74zVfo++STJIXZVXoNSAjeh10Dv3f22wFoi7w9zeQafSEnnEiTm/lUnGHenmS/CwNsJeKvYHfarCO1HaXEN+cwvhWElqwHAyoDPacrh8rLwhe3OLEcRYX3qs2sloFmdKwksiSmxlF49tZJLJrnYEdsO+0aQRwwmQXtK8hLfvrjz87q/HXH/+O3k93QCzTdSFQeeC3v/74M67IX3/8G03LX3/82a4b/kakTpdUfMHVGeO+/R6na/vYbx3aSdu6Ik2TB2EfReflfU+c+wLw4XJYNjhjPaYbOWhLAjvWv2e+G7Y1MDGNOehu8DGD+qHhu72YCc4ZeCeBNmhwGPB/SWG1VD85XhyKqcgP0ydH00fpEZ8+SU+On5yk2aEQx2J2JGbHfDjA0+TkJD/OMn6YioyL9EjMpunJkVikx/niZPpo+kg8+SZPWmxPsy7VEKfsactiu9RBAQgvwsF5jla9M5enycscTbvQge1hSCeEa7ptccus9v+ttKVoSHAVQ5tEJQK1C915DupkSVo4MuFI7FoGl3Q6mpugLfrEzDviIxTIf+gzCvQBZ+n0MJ0evptOT+mfg+l0+n+tJMQys7Ey4/aZOgYxd9yeJaeNQuxbjfcD9d1VoT3dl8wOF0/ybzJIpzw7So+Ojx6nJ+KEp4ez4/wkm+bTaT5LLnGL0C45mh5teq5NzIX9ohj7Rb2jnUjzB6LVaQ2Xh0/SugP2ip8hlzNeq0TPv4n2UCzm4BcS+6PZbLPbsWBMg0BakoQVrypQLZNaaEG2kkQmYIxUxjIwRhsMESE3sOyjVARizp0zclHTUhQ1fJyw4JzFFnIKCCLtcppx1dZsQpwfD9hb8CN9/8J388xLngR7zSAGwUyzpvoDH5UbC6hdJ4hw9ex+ndzh5A4pVM/iEBLU5gNi5X/fpHZbidlGq/MzWHd113gfVOpKs/rWE1fvnIXNSNWZzrLaYAR8XaE/WKy9Pj6DdWt6QxAlruHDJtQ5pC7UZPAg9/WZW2iuyy+pJWJODftvnFePfGl0XUm1tNHZR3MQfRIfhQ+hcl9+xZUokK7GaHznTIM8raYjadlHRYpt7tfxoydMwXMhJyuIPDq5XgV+DEVZWKS1D4MGouw/Xi++9DqONx5G8IWuXWftUrYEBaZdtRiNCpNha5PzzE8IV41nHFA4jrHxq93BZ3FzNy4HxdSdjgKyjrF0bwKkYrSnyVtGtRE00qIAT1cDv5n0muAxgs0+dqzaR1rbjx1z9rHxcaMxQYOvFfyYk0ncPZayLpzEAGz0o4YbL/68udnil2ts6X7fVqpl0TgU21zFQDJu7qX9wEvoOy9NDCWITaaNjz8Ly5wmafhCXynGMX0z1KLX3rnR5Y7ISFOuruZO7y7Y03NjBehAbFeRNsScvArSn/4s3Sr9UUH6Ivh520u9CrLji+LS4DHL1zX/+685RQu2Gez+PPyMyocizERw0eHeYTZisDy6MajxVvwcWKOHCjiHgqJQwYxEQ9GolSSTJqsLbu57uCmRn/RHErgHSXeEIwW8QH9Kuz4lOuvz4KzPBRTgYF6rvFYCBHo7GJHpkZj3Pa6RLHz8pedUDchaz+v7rqYg2itwKy0ofBl7Y01vtAY9YOdgZL6eS0WimyHSSlt5q8j+hTSgF7tozwyofwnigL0ugFtg2QqyM09SkLEGOIyXWBFN+7Yh8ALPJdbz2OKdDgCnN3TIFgCqHccIwFJa1FBzo2s8LN8BLJSYq7pc0JnxCMQBye8BfePrM1/fR7282Q24giTMM61yubQNtIZrXmvWNmt3wTx1DJfUUaitJbNlbV2XWIwDi6PNuXVxt8wLWUq3A+FI4WtP4XeIOLTBqA1mVzFmx8PMNpjnFRipRYsXlJiLoC23oGyKjGIbn8sXeICH5wLd0zbyMLhij1iplVtRKkpe4ymAxxdjUlKJ2jqznlvAgz+MySguMzvPtIB5S8y2Im5LX38+f8C6DOuOiON+CEM3dw8wiib8VvMCrcgTJuRSNmpnB1wbAdg94FqZ+bLXR/tWZoTVboI9CmA9VgzSzXWezytdyGw9x0Ob/da6vNEklmPrOwRRK9pRIJr9wrPM1LyYm917plfsGpr7qa/HDGVxhRlbFKjKkVk1eBgBlGC3AA8nVDGWucs6DqpeB+0zv7kFYKD0HCH7NryPG0/JsAOm8zxGdbZhhhCotPsse1P4+msfA6IxuW5PCVjwgtOJRXWFvtxurXehesYVRUi5+JWW3fdmdy/7ShdSoFbHfz3gSCuIiN4mK3oWsnYijSBKwQICtEBh8bdDU9rdHawmxExMegzYhFWBshlAWdUKtkJtzGMjZnciii99GRabYOh22U4Mg/BptdDcIA2P5W5z/uIeRsLPmq4aSB7CxmBuEcE7ij1KS8Eeckt9imoTBcbg8sCieVoxBzqcQRIWTiDn6ITtwDYsef1t2jTg/b2W33gsgjYsSTnqPo+33bAR/13y2MEYR8ycdZzSYOc8d2DI19+HBWzWuv78vW549b2R9u6127gNTVCckoWNgsljYRQxtLgv/l75L0Lea+lKzLF069LgkcN8abS1GO6InSsgZ2AX1wklrk93gHyEhlFEv2AAiVgLrshK12YfYngzU/dPbL2zcxQsuZPnwwkKezxDO1jcor4J56YdAL6LZnvkRv8OqpvkdmuaTjYn4JsueXNmjfEh68PpLcaYWakN44UDswXtPLSy22//IuDShgSf9pC9n1cZoVKoUdpw/k5ga+WTLkltR8gxmnmbYOOJUbWx2E3Wpzb9KfeKEtNVgxYPCauxUNThQ25AWsDOfQLBHjzBl/8SBdRvqd3VISMs4Cz5J8xwH+K0tak4jvkOob74lPnMj4ABV+JwOqVZLbQ+q6tdc3mHwCLhij4ApRzctw8Okv7ZV3uus38+Reg/xT/Tw9kjyp3oKjSfv2Ea409BN8w8uZbwD1obJcMkEYEI9+KAEvOBhb/p002yHQzf972Jc/d4msWx4OrqbgbFRUtN7c2GM4C5e0w5CDxKnTv+6S6HhbyQCHjojzn+iVF/NxvjJuw9RNHHhEPG2W0PsyeGUWPFKPQXyGUP9PggbW0xFnHNEPs+g5KY1BIa7xrBK4fQQvKQbb2gUWm1sTRNzG4XNd+ofpNQXdMIi42wpvPWh0i2AW6t8pei7R2XDeYv9ha0MYXQebaau5UBu9KFmEMwPknn/G6IgIYFDdbrz1Wcl3g5kZ9zWfBwmBfv41Bs/umzf7J3ERyLlrFzfqS19em9OmchY3nCXulzYO80JtcZ9pzTcWTXYIYrazeiTY37ct7c/OudHfnkeIdJiOTEOh0oXTdNGW/sLJFy6NqlOk/pe2gwupkxFXsOJZfFfmE9LoubhPS4LLqO7hBA9LtjdGzF7bz5evvRFH+a2xx44OI2vTFKDwqAGjEwUOpwg6sJHrRVFpBjY5gn4O86wwU2Goke3nqYC2kXtbF06zdune0D65a+xu7rxBbiudUo+9mx97Y10ceg3Zzu+/Zm93kHdHsl2M/CHQ8Pc6r5bDZLuZiepEfAj1M+fcLT48PjJycn2aPF4fE3OwYdWyvptPsm3N8f8Pn6jf30WuOUPZd4Fs6e+8PnCXuGh9IHyXBWIoomSf2GKMJlwKD6PKNGal/1Ud4LbNsf8d87iDqsXdxdwZqYhH2lVGzJOb7gdigjSS6VtKt5iHKidcVEAk+97iAmLeMFRvTxncad7Vjb+SAmWOhwIZyavoqFWWcA3Pzw+qv4CoUnvmDAmW8IdYsBazdkJvMpSl/WR+Yvy2zEE7cdju00vfTCgYwPGbALo9WSBe972MfvsrqBmHuVDHg7tYni/S4rf+h6Hw6WB+xw9ujo8YORLbbSCm6cD/Eaa8dsiLjJD6e9g1LMOChktivSMLp5RO0zwGHb0WNn6+Dxnb//1qBtg1X+CGfgwO8TyB6FtTuP4F33ekCbk0Gr79cFc7M9U457vNAXnfQGyuXaldzQvRt0w2gCdtleCRvt4GYx59EOmkEGS+Y5rL3a5oeC+5tD6iUQ7ailcKPZHZYOv1OdG3kgmBOMF7LxE7sX6txrbxIozSp8dcK5WMpGq0Jvsdyxd84pzS/q78g2iWRcz4XFi1G2Y4eCGzjCP+K8XYTk8C2juxhcS9tvwn/GtPCoZ5Z0LGoCZTVtosa0MVQb6O4wRk9MYnuQfBBz9ggwhs8oMz1z8bkXJogcFevhCX9QR3EM/gT01uPQg+SHDmTfoRicZu1KF5PGuvnNEl6+w7p0E7rvJg15M9mHfL6Qhh6iuWYvz+lcPWdUvXGNgwWltAlPAEnn7HdM2+SC3oTExzuRMw5HTw6PU8H5N+kRiOP05DFM08MTEI/FFODk0eMdKo1Ow27glBYFZ99J9/sSQ3H0EkXFUZnTJXXcsCTDq8FpGN1e9y5ic9QcJmHE0bnlmZqJ40X+ZJalC77I0yN+OEtPZt/M0kdHU5iJbzK+mJ3smKmbaaGXlku+Yt+CKaRqpgnnJTzZcRFur+w3Q5FTg7KeTzdxj915O9tztXamsAY22pX0btLlKJLGuVQ780N7xW7srWHtgcfI8Ah2wn4GOMNQk3Irunr3L+BjqGPQpNG9t+wqxY52aXvdMaiXvQT+3m3FdDTZvX95+ttIFJqr039bxnCJzx+0duOqAf2HGJDLSfJDY0GuGvNXU/LVlHyBKYm33z+ltgJ+BtyuU9wEKb45YqQA/3zlc38Xk56IcqAs+Vk4JD+Yre9lTqL8dt/NxIWJ9bb12lTs9o6vzYUII/1O7w+6VXKaPDw/fNh7KOnh5403CC/xiQTMfgirUZsCJTbcoOaV9BeoUwEl3aLeuAX1HEqd9KfKt5f6ECp+xrFtaXi0zdeGwqXb2qzwMw7bQlYbcvXff46q+GmGZuFpjTPw/kO3FD4fU3prMFK2ueyFEONTgPTIFXBDWn94FZaaSOnWFuO1W6Gr3r7c8ZbySL6kB9/Clg4oCuOTCKJNpMcd8TkzlJN4UtR9mBCfmDCl/TF/C+ZcZtBZj/aWPF0sfkgFHwrsGk14Sn/jiY8NVTcuw0GR6ZIOwgjHPcteBNlmMfcKn3EUOqtxo9Ew/is8V8B9YCs8U/k89sre4JXyEL3wh0QoUOHrf7fyg7NRaetKrjrtfI8Bzi3PvA7xf26fTfj6yOzXR2b/Do/MBmWCj0c+rAouSeuQlv0cDMD75BxPCnrVk0lyuvkQ7QfMh7cOq3z+jAz4J1NcXuLPv9WAdvj9B7Q9/lka0rZCEtwt78R2t9P9N4E2PtiU+n6cdHRE8QquWnfMXzKJBHljKD653z9nez2g/+Fv247Orp/F8YeBm8luqQmas8p1vm28MNNjI9+/eJdcXv4/BWdIwA==
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Upon receiving a notification webhook event, use this endpoint to fetch the notification's details. The notification details include basic suggested content that can help you build notifications in your platform.
+
+Note: partners are responsible for the delivery and any custom state management of notifications in their application. Refer to our [partner notification guide](https://docs.gusto.com/embedded-payroll/docs/partner-notifications) for more details.
+
+If the notification UUID is not found, the response will be 404 Not Found. If the notification's supporting data is no longer valid, the response will be 422 Unprocessable Entity.
+
+scope: `notifications:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-recovery-cases.ParamsDetails.json b/docs/api/get-recovery-cases.ParamsDetails.json
new file mode 100644
index 000000000..9ff053362
--- /dev/null
+++ b/docs/api/get-recovery-cases.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"company_uuid","in":"path","required":true,"schema":{"type":"string"},"description":"The UUID of the company"},{"name":"X-Gusto-API-Version","in":"header","required":false,"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.","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"}}]}
\ No newline at end of file
diff --git a/docs/api/get-recovery-cases.RequestSchema.json b/docs/api/get-recovery-cases.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-recovery-cases.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-recovery-cases.StatusCodes.json b/docs/api/get-recovery-cases.StatusCodes.json
new file mode 100644
index 000000000..78768562c
--- /dev/null
+++ b/docs/api/get-recovery-cases.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"Example response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","x-examples":{"example":{"uuid":"e83d273e-4ae9-4b61-9c71-4030c2f73093","company_uuid":"c5e3e3e9-732f-4762-849e-20b5cec9036f","status":"open","latest_error_code":"R01","original_debit_date":"2023-10-11","check_date":"2023-10-13","payroll_uuid":"210f2034-fb4a-4059-b109-6c3b5efe499d","contractor_payment_uuids":null,"amount_outstanding":10499.43,"event_total_amount":5912.07}},"description":"Representation of a recovery case","properties":{"uuid":{"type":"string","description":"Unique identifier of an recovery case"},"company_uuid":{"type":"string","description":"Unique identifier of the company to which the recovery case belongs"},"status":{"type":"string","description":"Status of the recovery case","enum":["open","redebit_initiated","wire_initiated","recovered","lost"]},"latest_error_code":{"type":["string","null"],"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."},"original_debit_date":{"type":["string","null"],"description":"Date when funds were originally debited from the company's bank account"},"check_date":{"type":"string","description":"Check date for the associated payroll or contractor payments"},"payroll_uuid":{"type":"string","description":"The uuid of the associated payroll for which the recovery case was created. If the recovery case was created for a contractor payment, this field will be null."},"contractor_payment_uuids":{"type":["array","null"],"description":"The uuids of the associated contractor payments for which the recovery case was created. If the recovery case was created for a payroll, this field will be null.","items":{"type":"string"}},"amount_outstanding":{"type":"string","description":"Amount outstanding for the recovery case"},"event_total_amount":{"type":"string","description":"Total amount to be debited from the payroll or contractor payments"}},"required":["uuid"],"title":"Recovery-Case"}},"examples":{"Example":{"value":[{"uuid":"e83d273e-4ae9-4b61-9c71-4030c2f73093","company_uuid":"c5e3e3e9-732f-4762-849e-20b5cec9036f","status":"open","latest_error_code":"R01","original_debit_date":"2023-10-11","check_date":"2023-10-13","payroll_uuid":"210f2034-fb4a-4059-b109-6c3b5efe499d","contractor_payment_uuids":null,"amount_outstanding":"10499.43","event_total_amount":"5912.07"}]}}}}},"404":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided UUID is valid.\n"}}}
\ No newline at end of file
diff --git a/docs/api/get-recovery-cases.api.mdx b/docs/api/get-recovery-cases.api.mdx
new file mode 100644
index 000000000..58ae03fb9
--- /dev/null
+++ b/docs/api/get-recovery-cases.api.mdx
@@ -0,0 +1,71 @@
+---
+id: get-recovery-cases
+title: "Get all recovery cases for a company"
+description: "Fetch all recovery cases for a company."
+sidebar_label: "Get all recovery cases for a company"
+hide_title: true
+hide_table_of_contents: true
+api: eJztWEtz4zYS/isI9jCZKkKiHrYjntZlT2Z9SDJlz+xule1SIKApIiYBDgDKVqn437caJGXqNd5kc0qtL6aARnej++sXNvSFLSvnDVPaw9Jyr4xmfl0CTe4pFAuQEiR9jKjnS4drtyDMCuyaXHEHDndMCc25G0kTugTPbEvDRKCJqAQnrCqRiCb0R/AiIzzPSUdIAiFJjSWcCFOUXK8HD/pBO2FKSMivHeE8ECYWuPyVRrTklhfgwaJqG6p5ATShLYN5VSlJI6pQZsl9RiNq4WulLEiaeFtBRJ3IoOA02dDmztR5q/SS1vs6f86AfPlyc01MSnwGnZK0jrZi/80+Bktefrph/wTr8GArPQMuwe7IT3nuYF/KNd6lUBpcECK5B7bgDiS5/HRDVg1Twp0zQnEPkjwrn5G1qWwgEDzPB+QmJdpoIMqR0pqVkiCjhoaXZa5E8NU7R+4LpVVRFX3ej99n3pcuGQ6lEW4QoDEQphh2UGAlX1uT52F/yEvF2pNKL//WMmS95feoRuVADuhpa0cUdFUgusbx+IzF52x0hsiSkPIq9zTpr9f1I9rRlUYjuJINHccx/ts15YcXXpQ5kI6SRlQY7UF7pO1ZYvibwwObQ+24tXyNLvRQuN66WfwGwtOIvjBopITd9hs/A/ISCj9M5PhiAmzKYcami/MRm4mLEZvGk1iM04tJPJsEvXp4Tag4gwlMYMYuJuOUTS/Ox+yH6QzYOF6cCRCzeHKeojE995VDdUpAoOXcg/NzsNbYuTASNb2NRzSixqql0jyfS1goP0dUNSadsFHMRkgiMhBPBzuTEGLB351y41GcjuPJlKWLKWfT+GzGFqN4xs7FZHEGKUxnM9ma2nLhjZ2XfF2A9oGBo4mu8jyivDCV9nNTeee5lgiCZBRPZ7PBdBJRWOEBbzzP5w0lTc5mo/EgvqgPIvMWSgsOtA/exPjku3kFL2ExSXnVOKq5yiEId/l+0eprBURJ0F6lCmxgrfd41/vu+0NsexmFeEOeMyWysLgjjCwgN3rpUGjn/bfE3QW6Tsa+XbqwayFkoUGI0sqH/EIj+qws7Cy0PMJ3bpynj/VR8HWa3b+qhr5v4no/tTbnyYLrJxKYEGQSCsKB3gNyB0DufaYckUb83pQlMoa8HeNaMm+5dlxsq5573xahXDmPVhOmKIwml1f/IBZ8ZXVQzA3QB0fj6r++9jX3QJ4z0CSttHTkGSyQjmW+JoEpSJJaU/QB8s41ZuJChMiod6P3LUBcIW2oLFvr9upJayoSHNCFMGlDOABvNx+8JQ19i5QdAI+IQi1OAf6ZOyIsIH2oa9+k2LYP+3pHJGAlVZBjxcxzsgCCThk04XsqVb26sqsEpwEcjhy55REr/uk3bi35jWse1rCuz6mP5+K3/HoZzpDemeOxigY+ls3fxA1Sk4YaM+ICDuPhLazW/Xbrvsn62Mgqn4fa2DWpV0FPVLRXzD+8FvMVzysI/eX/y/ofKOu0q+v0OBRoW9lp/VjjX0Sn8fSwn/vZePKjqbQkD5qQB/05QO1rBQ5BYcGZygog0oAj2ngCL8r5AfmJPwFxlYUGMm0/3LTyypEVz5UcPOjg/xfmSuBPwN2aLa2pSpp01W591U4yfRrs+xnuWhXcsgRsCuHFg8bWt5lJnmBNk9NTVrSFV2/awqGiO7ev0vbAnmrHz+yq+HoWVcU+ugCfGbnVPUxJCR2uRsMGvQrccNMHcj3cHcUQsWBX3QRW2RzHnbYg81I19ZhJKEJRPgj0ayjMnlkbfizgEs+Fq51gfJTnJ2vkN3iWuI2XdyAqq/w6aH7VXPJSCHDuskI73D/2qe5wPGiSwxHabUJDFbtRB38vgNsw+u2V4YYFy2EFOeGVz7AfbCYSTJp3a+eh+F8kNBxOCKhxME1N4NrmwzC84iyIMGnH153BK6I4nLpf0juwKyWg54/XposvTOWHgXAoUTQ23iz8ZiYNfsCj+8r+C3JhCsBUH/R458iHNhzIpzbP45gqjaiKrtf/rs1IXISK0o7h151Ucgt5oEOQQsFVHgDV7v79FT9ojdI4X3Dd4/MR/JtvFPv32LzOmH/iK0frdw8vfljmXAWAhIDYtBF7T1ejbcVRISqTvVeQvbB9jGiGzXtyTzcbfGL4YvO6xuWvFVgMiUfMFlbxRd4UP6kcfp94uujf/Pvbtuy+J6eeTU5cqhu8A0WXq2jUJradG9U4drTvKr9Pvb/4I8tRwzYGPP5CtbXzawnBvFP63t7Be8lO8fj44TOt6/8ALZAHIg==
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Fetch all recovery cases for a company.
+
+scope: `recovery_cases:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-reports-request-uuid.ParamsDetails.json b/docs/api/get-reports-request-uuid.ParamsDetails.json
new file mode 100644
index 000000000..777331802
--- /dev/null
+++ b/docs/api/get-reports-request-uuid.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"request_uuid","in":"path","required":true,"schema":{"type":"string"},"description":"The UUID of the request to generate a document. Generate document endpoints return request_uuids to be used with the GET generated document endpoint."},{"name":"X-Gusto-API-Version","in":"header","required":false,"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.","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"}}]}
\ No newline at end of file
diff --git a/docs/api/get-reports-request-uuid.RequestSchema.json b/docs/api/get-reports-request-uuid.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-reports-request-uuid.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-reports-request-uuid.StatusCodes.json b/docs/api/get-reports-request-uuid.StatusCodes.json
new file mode 100644
index 000000000..9a1b73585
--- /dev/null
+++ b/docs/api/get-reports-request-uuid.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"Example response","content":{"application/json":{"schema":{"type":"object","properties":{"request_uuid":{"type":"string","description":"A unique identifier of the report request"},"status":{"type":"string","description":"Current status of the report, possible values are 'succeeded', 'pending', or 'failed'"},"report_urls":{"type":"array","description":"The array of urls to access the report","items":{"type":"string"}}},"x-examples":{"example-1":{"status":"succeeded","report_urls":["https://report.url.com"],"request_uuid":"p83d0ca8-7d41-42a9-834y-7d218ef6cb20"}},"title":"Report"},"examples":{"Example":{"value":{"report_urls":["https://report.url.com"],"request_uuid":"p83d0ca8-7d41-42a9-834y-7d218ef6cb20","status":"succeeded"}}}}}},"404":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided UUID is valid.\n"}}}
\ No newline at end of file
diff --git a/docs/api/get-reports-request-uuid.api.mdx b/docs/api/get-reports-request-uuid.api.mdx
new file mode 100644
index 000000000..f2ca70c34
--- /dev/null
+++ b/docs/api/get-reports-request-uuid.api.mdx
@@ -0,0 +1,73 @@
+---
+id: get-reports-request-uuid
+title: "Get a report"
+description: "Get a company's report given the `request_uuid`. The response will include the report request's status and, if complete, the report URL."
+sidebar_label: "Get a report"
+hide_title: true
+hide_table_of_contents: true
+api: eJztV21v2zYQ/is37oNbQLIdN20zf1rQZFmAbgvysg1IjIQWzzZbiWT44sYw9N+HIyVHTpwVwzBgGJYvkajj3cO757mj1+whnwfndS6Vx7nlXmqV+5VBNr5mWE1RCBQsY9yYroljk4xpg+ntVLAxm6PPLRptvcst3gd0/jYESZstOqOVQ8fGazYaDumfQFdYaWg7G7PjB16ZEqG1ZBkrtPKoPNlyY0pZxFCDT442rJkrFlhxekpomZ5+wsKzjBlLwLxM4bagPFo7b6Was+wJjkMISt4HBClQeTmTaEHPwC8IGp0NGn+szpjz3Af3dacfgrWoPCT7bX8ZGO2cnJYIS14GdMAtQs+FokAUKHoZ9AwqIdW8l4G20JtxWaLoEYDk4jbYsouCW8tXz0BcLhDiF4pPO8Br4EWBznXgsIxJj9WOQ9V1nbGHHFOhokHznO/FejTJYBvo7AnAa7bw3rjxYJCW+8GW/UJXRKXtKjFz8EYMC36Qvxf7e/n+iH+XH7zZX+XvxWjvAGfviuloyAiQl74kkOcJfZ2xLsCGVfQYk5v48A9CynaloY5/Gdsf7j8n/s/aww86KAE3CuBGXcZSxMgoSA462AJBaHSgtAd8kM734Sf+GcEFi7F2xuqlFCjg6ur0CKQjKknRv1ExR9sBT9ADh0JXhqtVz7W0nsslqujsrnvwuz4kREmW8EWWJUhVlEHgDlX0XEtyrkQGchYDlegx61pfnX/s36gblarmgKTOpZJqDmc/nkYFSJW4GZXxRfoF3DWYb5smM7bIxdhLtLejW63K1R0I7jm4Qhsk7/FhvHvfHfUJbnmFHi0RYc0Ur4hJT1qXpJwZ7hcsMUJaFGzsbcDseQtqpbJLe7E0G+nHGKTAOSpqoggchC5Chcr34aRdbJcAlTBaKk/18sEq6MKMUp4iBIci5YqCnBxfbryL5576rM42h/49P4lD4PDsNP8VrSPYzdkXyAXardPPeOnw6RmPKJOVVJjaieAe8yknRIdnp7BMToE7pwsZEUWgKx1sNCh4WfbhdAZKKyQKt5zOkk1nBPQcXFdSySpUXd+TV62WhS5cP0410vKgnWK54SuryzJ+H3Aj82anVPNvG4d5Z/k1waCc9tnLtc4YqlBRJxkNR2/z4bt87y11D4EzHkrPxt31up5kzPN57DwN+ckYHzwqF8cqMfEzrtj45cGctc3sKwOaglXoF7qZzpHyfsHGbLDcaxqeG6y7TKrppGiXrSaCLYkCTV65kSmtucAq5vbZlDnCSjOaE84g/4zcrfLkL49NlPZF3r3geKfPM6vFn/g09JnO6rAIVvpVRP4hif4wNpHDQMe+nnStLqigaUzssN2UmSC25af3KXIb5fBkxCcXeYlLLIEHv6DrQ+Ir9YOLlfNY/Z0IycMLAWoS60xHr81EjIImfRBfGklvkTFjJFj3y+wC7VIW2KnHo3b4VAc/iIYDQaHpapXH91zPYh1o61Owv2FZ6AqpL0UcPQfHDVXhLKkwSrftSvEY3zSXPl7ES1/Tmo7aqHCOZUPtjGHFZRkJ1Xz9/pE/lA2jna+46vhJc29zy9nCu368bP4/HzfzseGnxwc/MCWXkchRuOumkVyz5d7mlkdlGW9Nz0nGFtp5sluvaRZc2bKuafk+oCWdTqiXWcmnRNnrNRPS0fMLM6ZbplfnzTh6Df/O6fpC/to7ulo99nHGsqbnb6WvntRZO37/WnL+47N4Z2JTAndfZDZ5ptGTDKkVG9/59uw35tb4PDm+ZHX9B/LWV7w=
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Get a company's report given the `request_uuid`. The response will include the report request's status and, if complete, the report URL.
+
+Reports containing PHI are inaccessible with `company_reports:read:tier_2_only` data scope
+
+scope: `company_reports:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-benefits-benefit-id.ParamsDetails.json b/docs/api/get-v-1-benefits-benefit-id.ParamsDetails.json
new file mode 100644
index 000000000..7bde6fb3d
--- /dev/null
+++ b/docs/api/get-v-1-benefits-benefit-id.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"schema":{"type":"string"},"name":"benefit_id","in":"path","required":true,"description":"The benefit type in Gusto."},{"name":"X-Gusto-API-Version","in":"header","required":false,"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.","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"}}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-benefits-benefit-id.RequestSchema.json b/docs/api/get-v-1-benefits-benefit-id.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-benefits-benefit-id.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-benefits-benefit-id.StatusCodes.json b/docs/api/get-v-1-benefits-benefit-id.StatusCodes.json
new file mode 100644
index 000000000..52aa72579
--- /dev/null
+++ b/docs/api/get-v-1-benefits-benefit-id.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"Supported benefit response","content":{"application/json":{"schema":{"description":"","type":"object","properties":{"benefit_type":{"type":"integer","description":"The benefit type in Gusto.","readOnly":true},"name":{"type":"string","description":"The name of the benefit.","readOnly":true},"description":{"type":"string","description":"The description of the benefit.","readOnly":true},"pretax":{"type":"boolean","description":"Whether the benefit is deducted before tax calculations, thus reducing one’s taxable income","readOnly":true},"posttax":{"type":"boolean","description":"Whether the benefit is deducted after tax calculations.","readOnly":true},"imputed":{"type":"boolean","description":"Whether the benefit is considered imputed income.","readOnly":true},"healthcare":{"type":"boolean","description":"Whether the benefit is healthcare related.","readOnly":true},"retirement":{"type":"boolean","description":"Whether the benefit is associated with retirement planning.","readOnly":true},"yearly_limit":{"type":"boolean","description":"Whether the benefit has a government mandated yearly limit. If the benefit has a government mandated yearly limit, employees cannot be added to more than one benefit of this type.","readOnly":true},"category":{"type":"string","description":"Category where the benefit belongs to.","readOnly":true},"writable_by_application":{"type":"boolean","description":"Whether this benefit can be written (created, updated, or destroyed). Returns true if the benefit type is permitted for the application, false otherwise.","readOnly":true}},"x-examples":{"Example":{"benefit_type":1,"name":"Medical Insurance","description":"Deductions and contributions for Medical Insurance","pretax":true,"posttax":false,"imputed":false,"healthcare":true,"retirement":false,"yearly_limit":false,"category":"Health"}},"title":"Supported-Benefit"},"examples":{"Example":{"value":{"benefit_type":1,"name":"Medical Insurance","description":"Deductions and contributions for Medical Insurance","pretax":true,"posttax":false,"imputed":false,"healthcare":true,"retirement":false,"yearly_limit":false}}}}}},"404":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided UUID is valid.\n"}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-benefits-benefit-id.api.mdx b/docs/api/get-v-1-benefits-benefit-id.api.mdx
new file mode 100644
index 000000000..373da5139
--- /dev/null
+++ b/docs/api/get-v-1-benefits-benefit-id.api.mdx
@@ -0,0 +1,73 @@
+---
+id: get-v-1-benefits-benefit-id
+title: "Get a supported benefit by ID"
+description: "Returns a benefit supported by Gusto."
+sidebar_label: "Get a supported benefit by ID"
+hide_title: true
+hide_table_of_contents: true
+api: eJztWM1y2zYQfpUtekgyQ0p2JulBp7pxmvqQ1pOfpjOOJ1kRKxEJCTAAqJij0Uxfo6/XJ+ksAEqURefH7SlTX0yRwP5h99tvsRZX+bJ13uRKe1pa9Mro3HcNidmFoHpOUpIUmcCmGS5x4jITpqH460yKmViSz1fH+Zw0LZR3/cMbxdslucKqhheLmXhGvrXaAUJaBK5tGmM9SZh38IQNmrzWr/WLkrZLzPwdFR6Ujt+hMNqj0g5KtSyhohVVoPTC2DrYBDg3rQeEBq1XRVuh3Ypi/wC1BOUdeLxiWU7J5I2bwKuSNBSmblArclCUxjgCb8AsFmR3dmfgS+oALUFhCb3SS0B4FDZ28NO+5eicKRSykx+VL0dNC167wjQ0g7d9KGeWUL4VmWjQYk2erBOzi7VwRUk1itlaxAMTzlull2KTCY01v9g7A8Whb9CXIhOWPrTKkhQzb1u6fj7DsIdY9UGfiE227oX/kYd3+cn5Wf47Wcd7k5aSUJLd07PAyh0oOmVnaqXJcSBBoqd8jo4knJyfwSoKPQhcZ1obFhRYVRM4W4A2mkA5aKxZKUkyi2uwaSpVhEO94+CiVlrVbT2UfXm39L5xs+lUmsJNQilMClNP+9TPG+ysqarwfYqNytNOpZffJ4H54PU9NqN1JCciu/GAMkG6rbnC7h/df5gf/ZAfP+SCkrTAtvJiNny/2VxmwuOSz1xcS61QhpZcY7Qjx4ruHx3xv/0wP99VVzrVfo/IBNcRac+7BvGavnO8dZhk+zJF1jsV05vT0zIieBUt6XMvrtqGIIBIyI0vzjl2EeVvuupium7z+zCuhzJ5JZhFyK++yMYk7u38EsGDN18iv7Hk8Wogem5MRagPZL8qyZdkhwI5pyTJtohHuDCWImxhxegRQIuhqHVgeRnDkNH0959/BXjDecXhLExNo5YZ5/8b03Dh+es1y0bDoeqm9YwLt1XaQzZJSLKSi6PqSsLKlwVaur3GnQywVDEcjaqy5JWlOpXU7VRdR7ydTGgq1Aw+o7o7Qlt1bypVq9tqL5H78tKsyOqgsEYtgyVROAThAXW/flsGVDeV6YibKmptPMwJkIGWu2sdErtEzdm7a/ysSbmACqNeF+hpaWz3+bp9lFbCx5KCqp2WOVVGLx3cADgfrfJcR2/m3ZsBTH5VkJXbaitQs+cs1ZOGu4E9cN9qGxkfjGWE8dZ0JO9NoKdMbA6o/dhHuHTQcC/1HPOFiYc6sDSD0IHBsDEflRsL5SYTVzldYd1UEcMfx+dDOD/eUoynJFWBFZxp11rUBR0E4DTAAyNB4Fzcb6yat/ENWzomoofLSE+2EJVYxBY90u9heccdwypMi/aLI73c5Y74JQgRHAWvPHu9a5x5arjMrW4I0Aqr9tuN1Cb8ZeLB0YNDLvCr8fCzabWE1xog0nZmfuQ4GS0509qCQBpywDVPV8r5CTzF9wSuTYXYczd4+fLslNN5hZWSk9daxLx0DeF7QtflS2vaRsxEJOjdlgvtr+Ko54xHVkmK88n2OJmBXXnSLowyzKXfE6fAjcNQ1h/vZ4Yipse9qOsGb2UcGD6+a9+B3e49R5gc1uRLk0awMCX4UszEdHU87SeI6Xo3CWyYmJJd9VNEaytm7IkGY6MiC84l1YEKj2Rpba7FOsrLFRvB+4JHNwgelXlujfyEzIY/s6uOitYq3wXLExk+KQpy7qRlry8uh6ueM3eNhTqydovcbGLP1uPUhHaEoSYReRw1sfUlad/3gU0mnnfOU/1vNEQJNyhg0qQXJkhN8BQH4ZPzM86ONIHtzQ6Z4PnK/bZ4TnalChqcx27UCYPyNCycSlbNLD4Pv3OzCOegRsDqFVVMt7hvBzvuOHicSgPO49AUJi1pipbRJbjxXRo4sAj8JCHjaa8VnlEijVyhNaoqJFT6+uMufzaJt9aoB3KeEA/87mDamXdwdnrdgfVu8vn/QuKWFxIpvT1d+WlToQp1EOp+nWDoQqyORdb3RD7W2eBS4jITpXGel63XPPi/tNVmw68/tMRN+eKScc8qpl6h5qVy/HzDhcLwTO8+S3cP9+CTs+WoD+kl6m4AvCJLKD3wYHMZpwu+7vg6+77xu4/RsMbwjV8cbaO864aMpY0ffDu4oNhrf08evxCbzT9XEGFF
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Returns a benefit supported by Gusto.
+
+The benefit object in Gusto contains high level information about a particular benefit type and its tax considerations. When companies choose to offer a benefit, they are creating a Company Benefit object associated with a particular benefit.
+
+scope: `benefits:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-benefits-benefits-id-requirements.ParamsDetails.json b/docs/api/get-v-1-benefits-benefits-id-requirements.ParamsDetails.json
new file mode 100644
index 000000000..7bde6fb3d
--- /dev/null
+++ b/docs/api/get-v-1-benefits-benefits-id-requirements.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"schema":{"type":"string"},"name":"benefit_id","in":"path","required":true,"description":"The benefit type in Gusto."},{"name":"X-Gusto-API-Version","in":"header","required":false,"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.","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"}}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-benefits-benefits-id-requirements.RequestSchema.json b/docs/api/get-v-1-benefits-benefits-id-requirements.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-benefits-benefits-id-requirements.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-benefits-benefits-id-requirements.StatusCodes.json b/docs/api/get-v-1-benefits-benefits-id-requirements.StatusCodes.json
new file mode 100644
index 000000000..9906a9c7b
--- /dev/null
+++ b/docs/api/get-v-1-benefits-benefits-id-requirements.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"Benefit type requirements response","content":{"application/json":{"schema":{"description":"","type":"object","x-tags":["Company Benefits"],"properties":{"employee_deduction":{"type":"object","description":"The amount to be deducted, per pay period, from the employee's pay.","properties":{"required":{"type":"boolean"},"editable":{"type":"boolean"},"default_value":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string"}}},"choices":{"type":["array","null"],"items":{"type":"string"}}}},"contribution":{"type":"object","description":"An object representing the type and value of the company contribution.","properties":{"required":{"type":"boolean"},"editable":{"type":"boolean"},"default_value":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string"}}},"choices":{"type":"array","items":{"type":"string"}}}},"deduct_as_percentage":{"type":"object","description":"Whether the employee deduction amount should be treated as a percentage to be deducted from each payroll.","properties":{"required":{"type":"boolean"},"editable":{"type":"boolean"},"default_value":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string"}}},"choices":{"type":"array","items":{"type":"string"}}}},"catch_up":{"type":"object","description":"Whether the employee should use a benefit’s 'catch up' rate. Only Roth 401k and 401k benefits use this value for employees over 50.","properties":{"required":{"type":"boolean"},"editable":{"type":"boolean"},"default_value":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string"}}},"choices":{"type":"array","items":{"type":"string"}}}},"limit_option":{"type":"object","description":"Some benefits require additional information to determine their limit. For example, for an HSA benefit, the limit option should be either 'Family' or 'Individual'. For a Dependent Care FSA benefit, the limit option should be either 'Joint Filing or Single' or 'Married and Filing Separately'.","properties":{"required":{"type":"boolean"},"editable":{"type":"boolean"},"default_value":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string"}}},"choices":{"type":"array","items":{"type":"string"}}}},"company_contribution_annual_maximum":{"type":"object","description":"The maximum company contribution amount per year. A null value signifies no limit.","properties":{"required":{"type":"boolean"},"editable":{"type":"boolean"},"default_value":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string"}}},"choices":{"type":"array","items":{"type":"string"}}}},"coverage_salary_multiplier":{"type":"object","description":"The coverage amount as a multiple of the employee's salary. Only applicable for Group Term Life benefits. Note: cannot be set if coverage amount is also set.","properties":{"required":{"type":"boolean"},"editable":{"type":"boolean"},"default_value":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string"}}},"choices":{"type":"array","items":{"type":"string"}}}},"coverage_amount":{"type":"object","description":"The amount that the employee is insured for. Note: company contribution cannot be present if coverage amount is set.","properties":{"required":{"type":"boolean"},"editable":{"type":"boolean"},"default_value":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string"}}},"choices":{"type":"array","items":{"type":"string"}}}}},"title":"Benefit-Type-Requirements"},"examples":{"Example":{"value":{"employee_deduction":{"required":true,"editable":true,"default_value":null,"choices":null},"contribution":{"required":true,"editable":true,"default_value":{"type":"percentage","value":2},"choices":["percentage"]},"deduct_as_percentage":{"required":true,"editable":true,"default_value":null,"choices":null},"catch_up":{"required":true,"editable":true,"default_value":null,"choices":null},"limit_option":{"required":false,"editable":false,"default_value":null,"choices":null},"company_contribution_annual_maximum":{"required":false,"editable":false,"default_value":null,"choices":null},"coverage_salary_multiplier":{"required":false,"editable":false,"default_value":null,"choices":null},"coverage_amount":{"required":false,"editable":false,"default_value":null,"choices":null}}}}}}},"404":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided UUID is valid.\n"}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-benefits-benefits-id-requirements.api.mdx b/docs/api/get-v-1-benefits-benefits-id-requirements.api.mdx
new file mode 100644
index 000000000..94900d879
--- /dev/null
+++ b/docs/api/get-v-1-benefits-benefits-id-requirements.api.mdx
@@ -0,0 +1,71 @@
+---
+id: get-v-1-benefits-benefits-id-requirements
+title: "Get benefit fields requirements by ID"
+description: "Returns field requirements for the requested benefit type."
+sidebar_label: "Get benefit fields requirements by ID"
+hide_title: true
+hide_table_of_contents: true
+api: eJzlWd1y47YVfpVT9ELJDCnZO7u90FWdeL11p0l2bG/bGdujQMSRiCwIIAComKPRTF8jr5cn6RwQlEhJdr2texNfiSKA8//HD2v2kC9rH0wudcCl40EanYfGIpveMqzmKAQKljFubX+LZ/cZMxbbf5eCTdkSQ746zeeocSGD3z7MpMgd/lxLhxXq4FnGBPrCSUtH2ZRdYaid9rCQqAT0t8LCOAglxpfoAwpIVIFEHN/pO+0LY3EKP3bspg65+JFlzHLHKwzoPJverpkvSqw4m65Zqx3zwUm9ZJuMaV7Ri0RhJklfSZJZHkqWsSSSYNPgatwX/6bEgVQgNXwgk47ZJlt3xP+Zx3f52cfL/O/oPJ1NXErkAt2Az4Irf8DonJSppEYfbSJ4wHzOPQo4+3gJq5YocO9NITnZ6hcZSmhM7eKGgis1hssFaKMRpAfrzEoKFFm7h1urZBH9OfJwW0ktq7rq077/qgzB+ulkIkzhxzFuxoWpJl2c5JY3zigV1yfcyjydlHr5x0Qw773+msSoPYoxyx51UMZQ1xWF45uTN+/ykz/lp+8o+gQueK0Cm/bfbzb3GQt8ST5n35rKct3ANyk06JRDb4326InRm5MT+hma+Zu+LwfR2J1lGSuMDqgDne7ZbfKTJxL9YBvSZlmnnJn/hEVgGXvInxLXOkqyIFt5sbLKNIgzgaIuWprrA4qH4ckrU+sAwcAcoT1LbrfowPKGfqURGSycqWJodXxGntbJOUM5doG65T43RiHXlE4oZOBzhcdXk9tmK65qPCb+kNX+tl3Wti8OFjabjBWlkUV7vitl3DnesIzpWikyrAxY+aPHN613nZzXz7PwmYZ2BRxahx51kHoZDRljiGsBUQ0wi/i2SI7us/kdGHlr4ydt24bfjPuZRVegDnx5VMKhjf9RYijRDaITtlnQBbgvTa2oR0BwGEsg98Bhx2gvBdqIR16UkCrXq3FDwUNRzmr7X5o+Wbr2CLzrfr/961cPo0gYajsCxwOO4QetGrgyoYS3J6efYzLEh65fRxqhlD7lCLX8jo0Hs0IH705ejVuUrGSYGfu8ynNtKtwZMpkEuBCSNnAFUi+Mq2JvotAX3QRBzpQOIrcxXJDJH3hlFWbR/lzDX67POspZdH3cC61kvURDGYNjdMErqZoRGAejSy3kSoqaq1FLnMM5WtQCdYBvuUO4+ELqfzVSB7iQigqrcXAt9VJhy+077pykVNei23GNNPwFVM3o1UROaiqzflOZca1rrmYVf6DR63nDQtp8tEt1hZYmhwa5G8MZUEdNuevlUsuFRA/apOB6PeZfoeNLnHmuuGtmVa2CtEqie57Vu/OdhWPjSkS2g0NvLmvZpPKaRtC5asvnB2dqCzfoKvibXOwqxBi+NwGnUHCtTaD88hhALg6YSw9ceUPLr8+BrQ2+bLAueRj2R+lBal87mjGM2xr+WErtvJGGx0c88nqcQSRlILG7j7H8prGYX/VRBFKv7VmRyvv2eSDo8c+l/a/5nZG6r/uBWai89fSgv0e+EL6Q6Fbr3gycdYK/6dvttr/l/on5+WXU6k2FL0Jwf545gDh2VLeYx7PM/6xm92LcnqrtL81kV39ehPImZdTbk7eHeMT3JsCFqbWAOw1wp28GWJtDb2pXIAgTW3oAfJA+jOE7/hmBqlsseh2OBJ8+XZ5DO8hLMb7TjPg+5N4i/4zcN/mSGhObdu7bAh3DXYSY5WQNJwW2wOLVED/Eh4DaRxiSoL3P2LDp40DmNrH+A6BJaF1Hal/mLY0D2Y+fGuqwO72vC8FVFYbSJAQ14pahZFM2WZ1OusY9We+wyc1kD0z16FYdyFk7RYBiQum4lS1IlwusIlJ30MTOsTJ75m/p5ZIkonNRw0cIH6X50RnxBE1Ly6S3x6J2MjRR8gR+nRUFen9Wkwlu7/u7rglSa2v9kb3bgkoidmBiC+pyF8HVoYyJRK5whQp4HUpCbVoUj1rLdeMDVv8Lh5bCIww2BP0uTKSaOl2EhwltpWhJAPEA2swYfbz5HxbX6FaywJ4/dkgsn5s6TOLGiSDW1MHz+D83i+gHOnrwjY+qoG/JYFroeuThfUoV+NgiIxEIFqaoKe6iGn9IOCgvYrVKQPd5xxWuUKXUyhhWXKoYUGn1z7v4IWtY40PFdY/OBwxbWD3eDPghGDtv4PJ8X5H1Dpj9f10rpCgI+BAmVnEZwyWmxzql7i1bnbKsu04g7aeDq4VB/t5nrDQ+0Kn1mtD8T05tNvT65xod5cY9VQ8n27p/u2ZCenp+5Jagb4GvUqkRX8MTlxSPqNSNa7rplS+WpVrXU2hDU0m6w/gy+X7nFxpHzdqa7/ht0NbKu55CFciG3trBbcOgg3x4f8M2m38DZ03W3g==
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Returns field requirements for the requested benefit type.
+
+scope: `benefits:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-benefits-company-benefit-id-summary.ParamsDetails.json b/docs/api/get-v-1-benefits-company-benefit-id-summary.ParamsDetails.json
new file mode 100644
index 000000000..4a0a1f07d
--- /dev/null
+++ b/docs/api/get-v-1-benefits-company-benefit-id-summary.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"schema":{"type":"string"},"name":"company_benefit_id","in":"path","required":true,"description":"The UUID of the company benefit"},{"schema":{"type":"string","example":"2022-01-01"},"in":"query","name":"start_date","description":"The start date for which to retrieve company benefit summary"},{"schema":{"type":"string","example":"2022-12-31"},"in":"query","name":"end_date","description":"The end date for which to retrieve company benefit summary. If left empty, defaults to today's date."},{"schema":{"type":"boolean"},"in":"query","name":"detailed","description":"Display employee payroll item summary"},{"name":"X-Gusto-API-Version","in":"header","required":false,"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.","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"}}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-benefits-company-benefit-id-summary.RequestSchema.json b/docs/api/get-v-1-benefits-company-benefit-id-summary.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-benefits-company-benefit-id-summary.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-benefits-company-benefit-id-summary.StatusCodes.json b/docs/api/get-v-1-benefits-company-benefit-id-summary.StatusCodes.json
new file mode 100644
index 000000000..b89911c4a
--- /dev/null
+++ b/docs/api/get-v-1-benefits-company-benefit-id-summary.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"Benefit summary response","content":{"application/json":{"schema":{"description":"","type":"object","x-tags":["Company Benefits"],"properties":{"start_date":{"type":"string","description":"The start date of benefit summary."},"end_date":{"type":"string","description":"The end date of benefit summary."},"description":{"type":"string","description":"Description of the benefit."},"company_benefit_deduction":{"type":"string","description":"The aggregate of employee deduction for all employees given the period of time and the specific company benefit."},"company_benefit_contribution":{"type":"string","description":"The aggregate of company contribution for all employees given the period of time and the specific company benefit."},"employees":{"type":"object","description":"","properties":{"uuid":{"type":"string","description":"The UUID of the employee"},"company_benefit_deduction":{"type":"string","description":"The sum of employee deduction for this employee given the period of time and the specific company benefit."},"company_benefit_contribution":{"type":"string","description":"The sum of company contribution for this employee given the period of time and the specific company benefit."},"benefit_deduction":{"type":"string","description":"The sum of employee benefit deduction for this employee given the period of time and the benefit type."},"benefit_contribution":{"type":"string","description":"The sum of company contribution for this employee given the period of time and the benefit type."},"gross_pay":{"type":"string","description":"Gross pay for this employee given the period of time."},"imputed_pay":{"type":"string","description":"Total imputed pay for this employee given the period of time (not scoped to a benefit type)."},"payroll_benefits":{"type":"object","properties":{"payroll_uuid":{"type":"string"},"payroll_type":{"type":"string","description":"Whether it is regular or bonus payroll"},"check_date":{"type":"string","description":"Check date of this payroll."},"gross_pay":{"type":"string","description":"Gross pay for this employee on the payroll."},"imputed_pay":{"type":"string","description":"Total imputed pay for this employee on the payroll."},"company_benefit_deduction":{"type":"string","description":"The employee benefit deduction amount for this employee on the payroll."},"company_benefit_contribution":{"type":"string","description":"The company contribution amount for this employee on the payroll."},"pay_period":{"type":"object","properties":{"start_date":{"type":["string","null"],"description":"The beginning of the payroll's pay period."},"end_date":{"type":["string","null"],"description":"The end of the payroll's pay period."}}}}}}}},"title":"Benefit-Summary"},"examples":{"Example":{"value":{"start_date":"2022-01-01","end_date":"2022-12-31","description":"Simple IRA","company_benefit_deduction":"60.0","company_benefit_contribution":"30.0","employees":[{"uuid":"54b7114f-f5e2-4f4b-911b-5cd5ad9032b0","company_benefit_deduction":"60.0","company_benefit_contribution":"30.0","benefit_deduction":"660.0","benefit_contribution":"330.0","gross_pay":"18000.0","imputed_pay":"350.0","payroll_benefits":[{"payroll_uuid":"8cc3471b-9da5-47df-88ea-f238c7cb968b","payroll_type":"Regular","check_date":"2022-03-01","gross_pay":"3000.0","imputed_pay":"70.0","company_benefit_deduction":"10.0","company_benefit_contribution":"5.0","pay_period":{"start_date":"2022-02-01","end_date":"2022-02-28"}},{"payroll_uuid":"d9d92786-722b-4bf7-bb32-79140418d349","payroll_type":"Bonus","check_date":"2022-12-31","gross_pay":"3000.0","imputed_pay":"70.0","company_benefit_deduction":"20.0","company_benefit_contribution":"10.0","pay_period":{"start_date":"nil","end_date":"nil"}}]}]}}}}}},"404":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided UUID is valid.\n"}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-benefits-company-benefit-id-summary.api.mdx b/docs/api/get-v-1-benefits-company-benefit-id-summary.api.mdx
new file mode 100644
index 000000000..839f73a47
--- /dev/null
+++ b/docs/api/get-v-1-benefits-company-benefit-id-summary.api.mdx
@@ -0,0 +1,73 @@
+---
+id: get-v-1-benefits-company-benefit-id-summary
+title: "Get company benefit summary by company benefit id."
+description: "Returns summary benefit data for the requested company benefit id."
+sidebar_label: "Get company benefit summary by company benefit id."
+hide_title: true
+hide_table_of_contents: true
+api: eJzdWVtz2zYW/iso9iHJDGHdfdFTnTqb9UN3PXbSdsbxOCBxJKEhARYAVWs0+u87BwQlUqLkS9zpTPPiCATO+XBuOPiwpA9sWlinmVQOpoY7qRVzixzo+JZCFoMQIGhEeZ7Xp1h6F1GdQ/nrUtAxnYJj8x6LQcFEOssSneVcLe7DwL0UzBZZxs2CRlSATYzMcTEd02twhVGWhO8kLCGCO04m2hA3A2LgjwKsA0GC5PU0KY6+qC/qfdBMEq0cl0qqKbn6zyXhBohW6YLMpZVxCsRpwvM8lUm5FfKndDOv4usWZjs2wMU4n8mvxCY6B6/H/2+8Z/JXGtGcG56BA2Pp+HZJbTKDjNPxkpZ2pdYZqaZ0FVHFMxzYNRWNqETL5NzNaERx79KAoGNnCtg236cZkM+fLy+InvhtbNmHrqL9ICIKDzzLUxzqd/t91u2xbg+xef1/FOD9FYBax427F9zBjg8RhP+MXgPvtT9nMpmhtQ04I2G+g6xy+PMQ9vpssBchKLEfHyjxAnRH5HJCUpg4AlnuFhERMOFF6iwudlrwxRvrxR617yPWOgWu9iEW4LhMfZI1EV9Im6d8gVpTvQAgOV8YnaZEOsgapguSfmMffSqfX12yX8BYFBN0zoALMI1ImvDU7oTSBYZtJhVYH0m4KxZzC4KcX12SeSmUcGt1Ijnmos+dhS6Mn5DwNPXmUloBkZbkRs+lABGVc2pp98aS20wqmRVZXfbd25lzuR13OkIn9sjXpqNEZ52qFrFgBf+9w3PJwkqppv8KAllt+B3CKCyIIxodijFVZFjy+t3+iHWPWW+EFS54uoy8any1uouo41PMbvpTiJmq+OAqAzbXyoJFRf1uF/80zfy+GWGkWkEjisULlMM1NWt1fre4sB5dTYk0qrak498hcTSiD+wQyNxg+XayRFlL7BbjHMx0PdlJGAz1dSI+Sd46M/dIa6x4TODF5ldVEoNML2u72goQRfI0yQiVT6cGpgHrOjfXQnxt4Wm6/mTJVM5BeRg5GKmFByUzIFwJP2xzSOREJtsVqBUuBoiRcfFCxJWKuphXx7yWUwO4jsudwG2GYlFI8bR91c+8SuMrONgW2QHXupm0m29/t2sD1r1OfU20r2TOdXP3PWathKD6Bri/3YQ7yKZGW3uf88XjcD7iVDzmn6HY65BZXjgQT9PySTuekrDkmdrIW6Vd2QsL30c39vvOgwkH9LovbqsBzZSvVrSnfk1k+eGxDf46AzcDQ/BqYImBaZFyQ7QhsVaFrdoon4AzSL498Zj6CeeuDylvriDpNd2sg9Vrkl/duS06vrNkHkhunulCuZeheH4yt2bxcyDkfHFfhvzjYdvWNN1u0KkiTcsmchtlDFOp/P00nF4BwZsyKkr9e7qoJynAduqw6PAvok46f7UKvSG7Wd8rqnuX3+uH6g62pHOeFrC9//rlsQ67fmXbRnojUSS5vD6nByOQHnePui1TmuFBB+WsWu9xW3UTdDSMT3q94YRNRtBnw8kwZme9XsxGiRhxcdYd9OM2DS8G0SrguPlte2VYWisktHfa7ZajjSJAB6NydLfU3m5XU3qaJIPhSS9mZ4KP2PBETNjpKXA26Q9Ok5MkPjs+jel2iaXXZdWkzRoZvDwovVxHOmgHetJutLpZek+y66jaby07W+Kv3x5/3T7rn9IV3pW3rCPOxFn/5PSYnfT7MRvGkxMWx4M+OznrDbvD3qkYDM92rfMeD5JW21SR/jq26T/JNr3uY8ZRMm1aBQdWq7vVXVUGht3h7qXyv9qRf+tCCfJFEfJFfWrQcAasLkwCRGiwBPsCeJDWHZGf+TdsqwyUBShQAGW7Li2Z89QzdugP+sBsDvwbcLtgU6OLfEOHrW+rzVlIdjA9B2OkgJJ3vFnzivDgQFlPUGIqfAM09F6KM6pq2SNUJ8ZNJWob7lrGDuz2VU34m9W1bSC/kIGb6UCret+6GR3TzrzX2aYdO8td+nDV2VCtFsy8oiILkyIZFBgWnsuSYGECMs+ytFylM71l/1IeK7MHP+M+9whulXlltDggM8fPaAILSWGkW3jkgcI4TxKw9rxAa9ze1WfdIDFSnlUtc9dHOUKsiCBPzgE3nhjbavZKESyFOaSEF24GygUuBo/Gm4V1kH2PhlLCHgWeKpxoLzWcz57aQ6YMYyaQew1aKqJI3dn/TW7AzGUCNX9sWDQe68J1/MSOQNXYzzD/m+mJ9wMu3emoIU105plzj+ONJR9CwpCrwEoiiSd0UmSgnN/GD4HN4olnswJJeVFpJdeQhgTDQ5vL1AdU+PrjJn7QGrm2LuOqJucjuH2ELYkXbW8E27tabri2f9oLRAhFBw+uk6dc+pj1OboMpeSWznu7Jwu6Ytz6GlHVk7uIzrR1KGC5RGb4s0lXKxwuaW3MVSEtj9N9HHPd7N/1aLBnm2XJbbxUVDXWl6rnofvLnwwO7qL2mvHCPTztEeEgiNoDxQbEHf4wElE80+dvr8MTxDvy2MPVHlhhkKtFHVIFtyV8V3erqHoCeR7Yf/h7yAGvtz8mNaKwnIiHYO5q33aeLRr9zMcPn+hq9X+qOKfC
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Returns summary benefit data for the requested company benefit id.
+
+Benefits containing PHI are only visible to applications with the `company_benefits:read:phi` scope.
+
+scope: `company_benefits:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-benefits.ParamsDetails.json b/docs/api/get-v-1-benefits.ParamsDetails.json
new file mode 100644
index 000000000..49933cebe
--- /dev/null
+++ b/docs/api/get-v-1-benefits.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"X-Gusto-API-Version","in":"header","required":false,"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.","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"}}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-benefits.RequestSchema.json b/docs/api/get-v-1-benefits.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-benefits.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-benefits.StatusCodes.json b/docs/api/get-v-1-benefits.StatusCodes.json
new file mode 100644
index 000000000..c1ae8575a
--- /dev/null
+++ b/docs/api/get-v-1-benefits.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"Example response","content":{"application/json":{"schema":{"type":"array","items":{"description":"","type":"object","properties":{"benefit_type":{"type":"integer","description":"The benefit type in Gusto.","readOnly":true},"name":{"type":"string","description":"The name of the benefit.","readOnly":true},"description":{"type":"string","description":"The description of the benefit.","readOnly":true},"pretax":{"type":"boolean","description":"Whether the benefit is deducted before tax calculations, thus reducing one’s taxable income","readOnly":true},"posttax":{"type":"boolean","description":"Whether the benefit is deducted after tax calculations.","readOnly":true},"imputed":{"type":"boolean","description":"Whether the benefit is considered imputed income.","readOnly":true},"healthcare":{"type":"boolean","description":"Whether the benefit is healthcare related.","readOnly":true},"retirement":{"type":"boolean","description":"Whether the benefit is associated with retirement planning.","readOnly":true},"yearly_limit":{"type":"boolean","description":"Whether the benefit has a government mandated yearly limit. If the benefit has a government mandated yearly limit, employees cannot be added to more than one benefit of this type.","readOnly":true},"category":{"type":"string","description":"Category where the benefit belongs to.","readOnly":true},"writable_by_application":{"type":"boolean","description":"Whether this benefit can be written (created, updated, or destroyed). Returns true if the benefit type is permitted for the application, false otherwise.","readOnly":true}},"x-examples":{"Example":{"benefit_type":1,"name":"Medical Insurance","description":"Deductions and contributions for Medical Insurance","pretax":true,"posttax":false,"imputed":false,"healthcare":true,"retirement":false,"yearly_limit":false,"category":"Health"}},"title":"Supported-Benefit"}},"examples":{"Supported Benefits":{"value":[{"benefit_type":1,"name":"Medical Insurance","description":"Deductions and contributions for Medical Insurance","pretax":true,"posttax":false,"imputed":false,"healthcare":true,"retirement":false,"yearly_limit":false,"category":"Health"},{"benefit_type":2,"name":"Dental Insurance","description":"Deductions and contributions for Dental Insurance","pretax":true,"posttax":false,"imputed":false,"healthcare":true,"retirement":false,"yearly_limit":false,"category":"Health"},{"benefit_type":3,"name":"Vision Insurance","description":"Deductions and contributions for Vision Insurance","pretax":true,"posttax":false,"imputed":false,"healthcare":true,"retirement":false,"yearly_limit":false,"category":"Health"},{"benefit_type":6,"name":"Health Savings Account","description":"Health Savings Accounts (HSA) allow employees to be reimbursed for qualified medical expenses. Contributions are pre-tax and lower the total amount of tax paid by employees and the employer. Employers may also make tax-free contributions to employees' HSA. Remaining balances are carried over in next year.","pretax":true,"posttax":false,"imputed":false,"healthcare":false,"retirement":false,"yearly_limit":true,"category":"Health"},{"benefit_type":7,"name":"Health FSA","description":"Flexible Spending Accounts (FSA) allow employees to be reimbursed for qualified medical expenses. Contributions are pre-tax and lower the total amount of tax paid by employees and the employer. Employers may also make tax-free contributions to employees' FSA. Remaining balances are not carried over in next year.","pretax":true,"posttax":false,"imputed":false,"healthcare":false,"retirement":false,"yearly_limit":true,"category":"Health"},{"benefit_type":11,"name":"Dependent Care FSA","description":"Dependent Care FSA reimburses employees for expenses to care for dependents while the employee is at work (e.g. Daycares). Contributions are pre-tax and lower the total amount of tax paid by employees and the employer. Employers may also make tax-free contributions to employee FSA. Remaining balances are not carried over to the next year. Single parents or Married couples filing a joint return can elect up to $5000 per year. Married couples filing separate returns are limited to $2500 elections each.","pretax":true,"posttax":false,"imputed":false,"healthcare":false,"retirement":false,"yearly_limit":true,"category":"Health"},{"benefit_type":8,"name":"SIMPLE IRA","description":"The SIMPLE IRA is a tax-deferred retirement savings plan for employees. It is often used by small businesses as an alternative to 401(k) due to its relatively low operating cost. Employers are required to contribute a specific percentage to an employee's SIMPLE IRA.","pretax":true,"posttax":false,"imputed":false,"healthcare":false,"retirement":true,"yearly_limit":true,"category":"Savings and Retirement"},{"benefit_type":105,"name":"Roth 401(k)","description":"Roth 401(k) is an after-tax savings plan for employees. The standard maximum is $18,000, or $24,000 for employees over 50 years old.","pretax":false,"posttax":true,"imputed":false,"healthcare":false,"retirement":true,"yearly_limit":true,"category":"Savings and Retirement"},{"benefit_type":110,"name":"Roth 403(b)","description":"Roth 403(b) is an after-tax savings plan for certain clerics, employees of public schools, and employees of other types of tax-exempt organizations. Contributions made by employees are taxable for federal and state withholding. Often, employers contribute additional pre-tax dollars to the employee’s Roth account to encourage saving for retirement.","pretax":false,"posttax":true,"imputed":false,"healthcare":false,"retirement":true,"yearly_limit":true,"category":"Savings and Retirement"},{"benefit_type":5,"name":"401(k)","description":"401(k) is tax-deferred retirement savings plan for employees. The standard maximum is $18,000, or $24,000 for employees over 50 years old.","pretax":true,"posttax":false,"imputed":false,"healthcare":false,"retirement":true,"yearly_limit":true,"category":"Savings and Retirement"},{"benefit_type":9,"name":"403(b)","description":"403(b) is tax-deferred retirement savings plan for certain clerics, employees of public schools, and employees of other types of tax-exempt organizations.","pretax":true,"posttax":false,"imputed":false,"healthcare":false,"retirement":true,"yearly_limit":true,"category":"Savings and Retirement"},{"benefit_type":108,"name":"SEP-IRA","description":"A SEP-IRA is a pre-tax retirement savings plan where only the employer contributes. It is often used by small businesses as an alternative to 401(k) due to its relatively low operating cost. Employers are required to contribute the same percentage to all enrolled employees, with a maximum contribution of 25% of the employee’s compensation.","pretax":true,"posttax":false,"imputed":false,"healthcare":false,"retirement":true,"yearly_limit":true,"category":"Savings and Retirement"},{"benefit_type":109,"name":"SARSEP","description":"A SARSEP is a pre-tax retirement savings plan used by small businesses as an alternative to 401(k) due to its relatively low operating cost. While new SARSEP plans are not available, there are still some companies that are grandfathered into the plan. Employers are required to contribute the same percentage to all enrolled employees, with a maximum contribution of 25% of the employee’s compensation.","pretax":true,"posttax":false,"imputed":false,"healthcare":false,"retirement":true,"yearly_limit":true,"category":"Savings and Retirement"},{"benefit_type":107,"name":"Group-Term Life Insurance","description":"Group-Term Life Insurance for coverage in excess of $50,000 per employee is a taxable fringe benefit. See IRS Publication 15-B to determine the dollar value of the excess coverage.","pretax":false,"posttax":true,"imputed":true,"healthcare":false,"retirement":false,"yearly_limit":false,"category":"Health"},{"benefit_type":10,"name":"Commuter Benefits (pre-tax)","description":"Tax-free commuter benefits for transit, vanpooling, bicycling, and work-related parking costs. The annual maximum contribution for this pre-tax benefit is in the IRS publication 15-B.","pretax":true,"posttax":false,"imputed":false,"healthcare":false,"retirement":false,"yearly_limit":false,"category":"Transportation"},{"benefit_type":106,"name":"Personal Use of Company Car","description":"When an employee uses a company-owned car for personal matters, it is considered taxable benefit provided in-kind.","pretax":false,"posttax":true,"imputed":true,"healthcare":false,"retirement":false,"yearly_limit":false,"category":"Transportation"},{"benefit_type":111,"name":"529 College Savings","description":"529 College Savings is an after-tax savings plan for employees designed to encourage saving for future college costs. This benefit should be reported as a taxable benefit and will therefore be taxed.","pretax":false,"posttax":true,"imputed":true,"healthcare":false,"retirement":false,"yearly_limit":false,"category":"Other"},{"benefit_type":112,"name":"Student Loan Repayment","description":"Student Loan Repayment is an after-tax savings plan for employees to pay towards their outstanding student loans. An employee can choose to set aside after-tax dollars towards this benefit. These benefits should be reported as a taxable benefit and will therefore be taxed.","pretax":false,"posttax":true,"imputed":true,"healthcare":false,"retirement":false,"yearly_limit":false,"category":"Other"},{"benefit_type":998,"name":"Short Term Disability (post-tax)","description":"Third Party Disability or Third Party Leave are policies offered by employers that pay an employee for a specific life event (maternity leave, injury). All payments made to employees come from a third-party, such as an insurer. For more information on the taxation of these plans, please refer to publication 15-A for more details.","pretax":false,"posttax":true,"imputed":false,"healthcare":false,"retirement":false,"yearly_limit":false,"category":"Health"},{"benefit_type":999,"name":"Long Term Disability (post-tax)","description":"Third Party Disability or Third Party Leave are policies offered by employers that pay an employee for a specific life event (maternity leave, injury). All payments made to employees come from a third-party, such as an insurer. For more information on the taxation of these plans, please refer to publication 15-A for more details.","pretax":false,"posttax":true,"imputed":false,"healthcare":false,"retirement":false,"yearly_limit":false,"category":"Health"},{"benefit_type":996,"name":"Short Term Disability (pre-tax)","description":"Third Party Disability or Third Party Leave are policies offered by employers that pay an employee for a specific life event (maternity leave, injury). All payments made to employees come from a third-party, such as an insurer. For more information on the taxation of these plans, please refer to publication 15-A for more details.","pretax":true,"posttax":false,"imputed":false,"healthcare":false,"retirement":false,"yearly_limit":false,"category":"Health"},{"benefit_type":997,"name":"Long Term Disability (pre-tax)","description":"Third Party Disability or Third Party Leave are policies offered by employers that pay an employee for a specific life event (maternity leave, injury). All payments made to employees come from a third-party, such as an insurer. For more information on the taxation of these plans, please refer to publication 15-A for more details.","pretax":true,"posttax":false,"imputed":false,"healthcare":false,"retirement":false,"yearly_limit":false,"category":"Health"},{"benefit_type":991,"name":"Voluntary Short Term Disability (post-tax)","description":"Third Party Disability or Third Party Leave are policies offered by employers that pay an employee for a specific life event (maternity leave, injury). All payments made to employees come from a third-party, such as an insurer. For more information on the taxation of these plans, please refer to publication 15-A for more details.","pretax":false,"posttax":true,"imputed":false,"healthcare":false,"retirement":false,"yearly_limit":false,"category":"Health"},{"benefit_type":992,"name":"Voluntary Long Term Disability (post-tax)","description":"Third Party Disability or Third Party Leave are policies offered by employers that pay an employee for a specific life event (maternity leave, injury). All payments made to employees come from a third-party, such as an insurer. For more information on the taxation of these plans, please refer to publication 15-A for more details.","pretax":false,"posttax":true,"imputed":false,"healthcare":false,"retirement":false,"yearly_limit":false,"category":"Health"},{"benefit_type":993,"name":"Voluntary Life (post-tax)","description":"Third Party Disability or Third Party Leave are policies offered by employers that pay an employee for a specific life event (maternity leave, injury). All payments made to employees come from a third-party, such as an insurer. For more information on the taxation of these plans, please refer to publication 15-A for more details.","pretax":false,"posttax":true,"imputed":false,"healthcare":false,"retirement":false,"yearly_limit":false,"category":"Health"},{"benefit_type":113,"name":"Commuter Parking","description":"Tax-free commuter benefits allow employees to reduce their monthly commuting expenses for transit, carpooling, bicycling, and work-related parking costs. Please note that there is an annual maximum for this pre-tax benefit. The maximum dollar amount is found in IRS Publication 15-B.","pretax":true,"posttax":false,"imputed":false,"healthcare":false,"retirement":false,"yearly_limit":false,"category":"Transportation"},{"benefit_type":114,"name":"Commuter Transit","description":"Tax-free commuter benefits allow employees to reduce their monthly commuting expenses for transit, carpooling, bicycling, and work-related parking costs. Please note that there is an annual maximum for this pre-tax benefit. The maximum dollar amount is found in IRS Publication 15-B.","pretax":true,"posttax":false,"imputed":false,"healthcare":false,"retirement":false,"yearly_limit":false,"category":"Transportation"},{"benefit_type":100,"name":"Other (taxable)","description":"Other taxable benefit","pretax":false,"posttax":true,"imputed":true,"healthcare":false,"retirement":false,"yearly_limit":false,"category":"Other"},{"benefit_type":201,"name":"Cell Phone (taxable)","description":"Employer-sponsored benefits like this are called fringe benefits, and they don’t get special tax treatment—they’ll be reported as taxable wages on your employees’ paystubs.","pretax":false,"posttax":true,"imputed":true,"healthcare":false,"retirement":false,"yearly_limit":false,"category":"Transportation"},{"benefit_type":202,"name":"Gym & Fitness (taxable)","description":"Employer-sponsored benefits like this are called fringe benefits, and they don’t get special tax treatment—they’ll be reported as taxable wages on your employees’ paystubs.","pretax":false,"posttax":true,"imputed":true,"healthcare":false,"retirement":false,"yearly_limit":false,"category":"Transportation"},{"benefit_type":203,"name":"Housing (taxable)","description":"Employer-sponsored benefits like this are called fringe benefits, and they don’t get special tax treatment—they’ll be reported as taxable wages on your employees’ paystubs.","pretax":false,"posttax":true,"imputed":true,"healthcare":false,"retirement":false,"yearly_limit":false,"category":"Transportation"},{"benefit_type":204,"name":"Wellness (taxable)","description":"Employer-sponsored benefits like this are called fringe benefits, and they don’t get special tax treatment—they’ll be reported as taxable wages on your employees’ paystubs.","pretax":false,"posttax":true,"imputed":true,"healthcare":false,"retirement":false,"yearly_limit":false,"category":"Transportation"}]}}}}},"404":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided UUID is valid.\n"}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-benefits.api.mdx b/docs/api/get-v-1-benefits.api.mdx
new file mode 100644
index 000000000..06d330e80
--- /dev/null
+++ b/docs/api/get-v-1-benefits.api.mdx
@@ -0,0 +1,73 @@
+---
+id: get-v-1-benefits
+title: "Get all benefits supported by Gusto"
+description: "Returns all benefits supported by Gusto."
+sidebar_label: "Get all benefits supported by Gusto"
+hide_title: true
+hide_table_of_contents: true
+api: eJztHNty1Dj2V8562SVU2Ul3IDNDnra5BFLFLKk0DFsFFKO2T7cFsuSR5E57qVTxEfvC7/ElW0eS2+5uB0i4bJYJL6Rt6Ug695v8Nloks8pYlXBpcaaZ5Uomti4x2n8eYTHBLMMsiiNWlt0hJnoZRxpNqaRBE+2/jXYHA/ovQ5NqXtKYaD+6v2BFKRCakVEcpUpalJbGsrIUPHXwdl4bmvA2MmmOBaO//CYipjWrozjiFguzuUIUNwPV5DWmNoqjUqsSteV+XxOUOOX2lR+1BOvOgjqK1+A9yRHCFKChwCU8IARtR3Rglj2Woo72ra7wNI4kK7pAjdVcznph0khQU7At/F6IKzM/B3DnyefALzVatuiAniglkMkN2M9ytDnqLkDgBjLMqtRiBhOcKo1g2QJSJtJKeL6IweaVAU3DuJyBkvjh3XtD49hEEDpTVWDvzpSxX2drbGrp7drOetHBi7KymF180VRJwzPUmEGAFY7Yu1yOTNg8ZRovvmILAzQKZjHrXUqj5RqLIGoXW4oZo1JOS8AJtzm0MKEUTEouZ71r18i0qF8JXvCLrp4zAwxmao5augULJjO3Ew8cHPBtOJxeYFoMWJRC1YgGUialsjBBYKTqwCooHGPnTBL3LkE74eLGaYXeU6fM4kzp+tNyezeMhJMc3VLtKhMUSs4MnKFwTjS3JEevJvWrjvo8F5K5Wa6WMkknJ6gWJWylGglZMVRl5v9QmjSM1arG7MY2HKOttDRA2wG+inuvLg2UqAuCl8FUeaJ2dhrDlAmDoGgzJ9z0ofI0jhYJetPhdHgwI5vqfNio4OhXzHjKBBxKU2kmU9xAwD2nHkgTAJMZCa7VfFL5J7TTPhCNuqR9dVSUO0NHe4TfXfH2M7pSGAatCkd42PJO9NABiQgLlls6dTSuylJpi1lyxx/fve1iaDkCwgj3dM5ERYb8z4S2eP2wu8vD3kNpv+ysPRAu01FvLo/6GzfkEHzBUXsgXKaj/rQ8qh8CYzbnpDhHaaoqaTcO3D/MwNbD8egGMCHUSccqWEV6USMvJpU2QZX9UTHBpxwzKALP46JEcoC34e4KAsk4lxoT8kEIvUKdBPtmFTEQK2hxZ1LYAkrGM5jUneVpDo0OT/Q23A9/GShYDUwYBQV74/yvZKoR1yhoVQvtOjwcj0h1F4yTyYYJE0RRv82UaU1HIpNJzq7EhXXGcvuLKB4efZLkHvLnUPzndYofjEcbVD4QuODkZ45LlBkdtiX0wY9P6IOPEJq8nP8bYg+HHa1NpCRf7i4do4/qm0NaipoOtom2DSUJc86JnjoXJwAwcJJzgV2aOJ+GWThR+g1s4fZsG+6xmqaaG5eZHc7HDFa5hVuGgDGXM4FQMu3wQpY+TEhVRX4HTLkgwAxeKy4tRQeVls6nRIGphaoksNf2BoMBOYUB7hlQDJZMM4sBjN+m4xvvlF/b3RsMPGB3UmRpftm49pcl044Pfz16dB8OjzeZlYL29rVjLkfNDKeoKY7sRFkmWCuKtjz3NqyyDYcuRFNTctwr0lyTGkzBhIBJZbhEQ0xO4ZAEJixqySyfEyPCrcFw680NyCr3i1vjA0k+RwqQ1AlQ/oRZokqqjO0yoY86/6i49lRZch8CA1Niyqc8JWKn5CnN3ALED2Hb103n6F+deh7IJ4jXOAAkasft5B4VNNhbkvNY2TygbYOenXeOmNLnH5wO+Bj9iA+MpfBUZ1CwBS+qggBcG/4SDwYDF3pd271Ff69O9QK7N3DyZECJrIvJgJclKj0C/reYHA7WMXlza3ImJundpzGZoraMS0gFap6abkivplBWE8FTMGmulDCx2+PKAOWD4br0P0kAcYFFaUHpGZP83yFptKbgC5bhmsr2STCX3KJ9TTFDTapeZkReiy51kitB3sg2PCZ5XW5WmxUJyjJOyzCxNCKZEoKIHNRzs6xLqTl0Me/eOMUvU1VpEjqPLLedlqqXnElaYTtDzloRu4i2/EbSdgn11u0OInvFrJWwz0bkdxK2y43Y4aBj3+8fJX3GfQThjbfrjRifhVuf/1NS1CtuX0cpXEJDTzs1VM5YM/NCAEqthMAO+WOfOWZLmev6q8QMu3t/a+oWK9otVQU56o4zLj1jtDI3Hh2P7x/18YV78Xls8Y2p/MyFOBJPmk3Rom1cwOaMC7JnVMsh/qQXxnIhwKgCHWWY5BRC5cy6tzPNZDZlbjgVQIK5IrhXTHVRpmoTHg+0qsrkCeoCHvEpfiStd+ZIr8bJlhFmuQRcpGicOr62N4ibEG0l5m39GqpitHVFGCPC4fEYjpzid9iE4V5yhyiWoaX8v/Qk9f4LuET0kiJ+5WYz5/BL/M+LxHDnyCx2nNW7qigqqiU2SXXYCqK7aVWftAF5mDRpJrkyiGbSUOVpzmSpFIW8MUx4Wqf+T+IHyjAkoaZHcfebRmSD/8KkrJjoZ3pfaqHqS9AtnTIelw7vRLFyjWLfJ4LexP4TQgdVLHz5qo8KbYb3CLVxXvFT45jorlNANSV7+spcshtxki4lVvZKq07UiaTcA9MOY2UDuWDWojYxbFR1Gxlo8FlqNeeZ03LJGy7PE3t9Tfb9NAI7KbS93dtwl3ToDJsE+AbiesacI5ylIiGfSa/WewORaWUrSjeHJZZs3alGmlxVIvP52FDNYl011IxzskLmyNkb14YwcUEY/q+o8Zh20kuEtvo0tpVLUT5STMIxlqx2S6zToX/YeUhhFZSsBqtOmM7ISCPXoCrrwh+XagtLCMUowh11pIWSd+TGG2d9DVpgJAidhduItAHfUtCpKYOt5vvxKHr7dicIyJW24IztPW7YhAtua9ii7Z1hI3KuMzhi2tbdGUpD980jZHPvdJVK8JS7oGnqlFGbedDB+yJKd9UdsUInEyfICcA5UXurYOQ20oKCVoiBy9eVrm9sw0gICIwWUhzdsgLpTvIBVEGUo40mJW00BlOlefBJOTkalLA+UNo3UHA5VbrwpkZ5C0Rk7zQqGe8hmhhKgcwQk0x9KnrNTI3csRzUDC3jwnz1ZMaXeg23b7cxwCMlZ1dsccUWji1++qS6ONOjvGKLb8AW39PL/Qhb/PwpbXHFFX9Crmhd9t+UqKRluoYrL+NScMglMSe7PRxy5W9cMciSQW72MQih/4oh/owMMRze3ExnHvnc4nlymD19c+6OB4b8QqGkzUUdZlKWYdlotZL+TJm+SPrzyBNCKlcqYDZUJkJWZDUvelYq1CdRm1EhMx06sjhts5KU1evNbF/ePOnw1iZ9n3hsX9H3B6DvoC1HuJwUbIXk2aYa9+/XcmuXK322O2hd3LsoBBzldMfm7DM1xcPEXSBUztg0PCs4NUISJ/hGZlckXK1VhW4Em2MNmZIf3r23MEPrDRETrg3T0qUXOt2Hd/+hgR/evaeq62rOssHqCZuR3ZNQq6qTdP3w7j1ZKmOryXlswHetCOwOWufxQV3A3+GAWyosX6H/+6C/tcQPFdX0Z1eI/z6Ib03kMxTiiuW/EeZfntK/OLo1uLV5UfufysKBM8EvJMALSbaaekHQWNd8ZlSlU2oYQOO6UHDBqVflV2p2JxfeN5Q0xdenTw/vkVGfM8Gz7RfSXYgLfS5KHmbRfjRDm8yHSUOWzW7Tps/cob4pWC3v0U3qcO/7hfSbXd4DdffMl/fCXRmecWkg57McBM5RrMQYbKIqS00/TFtOt5H16o1J4hZa2t1XDnXnpvnUVbPbfpu2MucCL2ANpNjzm2NK4i3flt/Uye+s7nz9Vm/f1typTapK3IffG+zs0z3N3+nGPZsZ+j7A2gLuowDUxV9QD4hxFw+D3P0rcchKRkeHyW+o6WoZ3eknOuTIMncRv+kMWrLa+iWP0FhifGcJs5hMGHVKjY4OYe6BbhzOCQ0NIGF114UlORzOe/S8FPsxnTuq1w08L7h0bmQH9sut3NrS7O/sZCo12+6zCdupKnaazyQkJaupVcm932ElT8JMLmd/DQCTzmPXg0m9XiS/Gx8+WN4dRlkVhO3dwe5eMvgpGe4RnjOcskrYaL/7/PT0Jd2dNSWyN8hMncyoHyjaj0L7w51WGLqjiEgJteNonqEXnZEQtPTCojTuew9EzDdIYn/mFyPi5YXTj385glR0A2p9q0sYG1vun7W69XZ2OALho0Cbq6ARSFEym0f70c58uNPRDQb1vOHZSgviy0BsVnJP6yTDwhG85/5RodZQ6uElnNaleW77ZwDuhXmkVfYRmCW9ptMZTCvNbe12HgRylFKH1aiigz5/2R01Ji7zV4Z7xi55j7bY8KS7VI5M93wsI4BIvNJjlc1R2uZK+mkcjWtjsfiSFTyEMxag7zfIqXJQw01pr5JHR4fECkHPrEhIHJEWMY+nY9RznmKHHq1AO5W94wbuZLQ0WZbE/U7U1NGB9zTfPUPhUlJWedNw3cD9IAdw5FWD0yeZSisytO4YfwnfRGGp+1TC8tJbWBWOMXy/gsSxYFw4hgpv/9Hyz2n4hEbBZAfOA+rg+LiBWz/G2/YTLVc28gtspOdziwu7UwrGnUA4BfA2qKDn0XwYxdGkYzxzZSy9ePuWLNtTLU5P6fEfFZLD9fwl6TfNyS10gh03xpNkP6PErTjLfHap+oNb0l7Me8vR74Y0NqNjYkhnlbbzbuNbRSuW5cH9J9Hp6X8B1k80kw==
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Returns all benefits supported by Gusto.
+
+The benefit object in Gusto contains high level information about a particular benefit type and its tax considerations. When companies choose to offer a benefit, they are creating a Company Benefit object associated with a particular benefit.
+
+scope: `benefits:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-attachment-url.ParamsDetails.json b/docs/api/get-v-1-companies-attachment-url.ParamsDetails.json
new file mode 100644
index 000000000..ad13ac3b4
--- /dev/null
+++ b/docs/api/get-v-1-companies-attachment-url.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"string"},"description":"The UUID of the company"},{"schema":{"type":"string"},"name":"company_attachment_uuid","in":"path","required":true,"description":"The UUID of the company attachment"},{"name":"X-Gusto-API-Version","in":"header","required":false,"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.","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"}}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-attachment-url.RequestSchema.json b/docs/api/get-v-1-companies-attachment-url.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-companies-attachment-url.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-attachment-url.StatusCodes.json b/docs/api/get-v-1-companies-attachment-url.StatusCodes.json
new file mode 100644
index 000000000..d511a9d3e
--- /dev/null
+++ b/docs/api/get-v-1-companies-attachment-url.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"Example response","content":{"application/json":{"schema":{"type":"object","description":"The temporary url to download a Company Attachment File","properties":{"url":{"type":"string","description":"A full Url to download a Company Attachment File"}},"required":["url"]}}}},"404":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided UUID is valid.\n"}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-attachment-url.api.mdx b/docs/api/get-v-1-companies-attachment-url.api.mdx
new file mode 100644
index 000000000..3f2c1c2e6
--- /dev/null
+++ b/docs/api/get-v-1-companies-attachment-url.api.mdx
@@ -0,0 +1,72 @@
+---
+id: get-v-1-companies-attachment-url
+title: "Get a temporary url to download the Company Attachment file"
+description: "Retrieve a temporary url to download a attachment file uploaded"
+sidebar_label: "Get a temporary url to download the Company Attachment file"
+hide_title: true
+hide_table_of_contents: true
+api: eJzdV99v2zYQ/lc47qEtIFlJ0O5BTzOWNMjDtiBptgG2kdLi2WZDkSx/qDYM/e/FUVIk/8o6dMCAPdkmeXcfj999d97SdboMzutUKA9Ly7zQKvUbAzSfUCjnwDlwOkuoBWe0cuBovqUXZ2f4wcEVVhi0oTm9WrPSSCDdSZrQQisPyuNZZowURfSffXJosKWuWEHJ8FsTker5Jyg8TfY8f1gB8VAabZndkGAl8Zpw/UVJzThh5BddGqY2ZOw9K1YlKE/eC4kAjNUGrBcN7GDlIJjzVqjlQbAxWQQpycM3R6lrzM7nICxwzBpGmdU1Lr89e3uYp9+0J+91UJxMFSFThbdDe3AeOGZPB1sA4RocUdoTWAvnR+RX9gTEBQvEr4AYqyvBgZOHh5tLIhypmBR8NFURDl46pvqG05wuwafVeVpE/AJcyp5vkCLY/QzcgbcCKiDsxaz3XshCSCDB4AbwqZpvIsYm4GY0VVPlCm0gJx/btcfe2OUWGP+Ij8UsK8GDdTSfbKliJT5TZyE4TahAfIb5FR3m3NsAySGb2geuj9Eppk0vhjhpnRyhZO9kD09/g8cQ/hbcNyEYpDSCaSP+lV7HEh3f3qR/gHXoo422AsbB7sRbMOkOAl5iWkuhwMV4nHlI58wBJ+PbG1I1TglzTheCIQ2/CL8iGx1sPFAwKUfkZkGUVoBs6+iXNGcGxf3KkUkplChDOfQ9e73y3rg8y7gu3ChqzqjQZdZpTGrYxmop437GjEhbS6GWP7YO08HyG4QRHPARPf30CQUVSizKi7OLd+nZT+n5OxQzDgsWpKf5cL2uZwn1bInso4fFjnbr1BlgT8DcJl1aHUzPh8HB3XP4iKmuwFrBoanGy7aIHmLxwdqDwis1tH+CDc1Py3JCKybDnjwjWTq7fYTPBkeQHrfbRdzb7yHHdJXgV7rVmFjBfkVzmlXn2bPaZNu+gutsUPf9xl4p1VmnMo+NPDmwVacKUcNpRyZmRMOllEMZCXWgZpdQ6r0nafylAoGjXczDCcdHfd5azV/waXAb0+OgCFb4TUTeUmpcFODcOGCmJrPhqXtkcdOpjpx95jZC7DiPv+fAbNSAXYyti1RCBZKw4FegfFukKGf3G+eh/J4IjYcTAWpUqIWOXoWX6CaqGIoCcqrVsZ0KTCiqlPt9cQ+2EgUM3qMXDDbXwWfxYMYxNDa7NP5O9SK+A5rug/0TZKFLwB4Wcbxy5KqtH3LbSE/UK66LgEyM1/ihnWFYEWeYVo8vu6jkDmQ857CMSyZkJFS7+3PPH8yG0c6XTA38XIN/scWiUh8ZOhbNaLNzvW0/av1n7bslj4e1z4xkIrKsHbkaYZjQ6jxmtJUGmtB8p70P3A73DlvtjkDMErrSzqP/7Ra72oOVdY3LnwNYLL4ZipgVbI48nGwpFw6/n+iWw2S+vmsb6xtyamw4cfN2sTnRSShNWr0dXBvF598ENJwivgvbftrrWZ10E8c/y+L/fPw4muMml8dnt+eU9w0Yhdj4wd7BH6adfnt99YHW9Vetq9Wg
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Retrieve a temporary url to download a attachment file uploaded
+by the company.
+
+scope: `company_attachments:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-attachment.ParamsDetails.json b/docs/api/get-v-1-companies-attachment.ParamsDetails.json
new file mode 100644
index 000000000..ad13ac3b4
--- /dev/null
+++ b/docs/api/get-v-1-companies-attachment.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"string"},"description":"The UUID of the company"},{"schema":{"type":"string"},"name":"company_attachment_uuid","in":"path","required":true,"description":"The UUID of the company attachment"},{"name":"X-Gusto-API-Version","in":"header","required":false,"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.","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"}}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-attachment.RequestSchema.json b/docs/api/get-v-1-companies-attachment.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-companies-attachment.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-attachment.StatusCodes.json b/docs/api/get-v-1-companies-attachment.StatusCodes.json
new file mode 100644
index 000000000..8902e15ea
--- /dev/null
+++ b/docs/api/get-v-1-companies-attachment.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"Example response","content":{"application/json":{"schema":{"description":"The company attachment","type":"object","x-examples":{"success_status":{"uuid":"1263eae5-4411-48d9-bd6d-18ed93082e65","name":"Company_Attachment_File.pdf","category":"gep_notice","upload_time":"2024-09-10T01:54:20Z"}},"x-tags":["Company Attachment"],"properties":{"uuid":{"type":"string","description":"UUID of the company attachment"},"name":{"type":"string","description":"name of the file uploaded"},"category":{"type":"string","description":"The category of the company attachment","enum":["gep_notice","compliance","other"]},"upload_time":{"type":"string","description":"The ISO 8601 timestamp of when an attachment was uploaded"}},"title":"Company-Attachment"},"examples":{"Example":{"value":{"uuid":"1263eae5-4411-48d9-bd6d-18ed93082e65","name":"Company_Attachment_File.pdf","category":"gep_notice","upload_time":"2022-02-01T00:00:00.000Z"}}}}}},"404":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided UUID is valid.\n"}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-attachment.api.mdx b/docs/api/get-v-1-companies-attachment.api.mdx
new file mode 100644
index 000000000..f9cdb59e0
--- /dev/null
+++ b/docs/api/get-v-1-companies-attachment.api.mdx
@@ -0,0 +1,71 @@
+---
+id: get-v-1-companies-attachment
+title: "Get Company Attachment Details"
+description: "Retrieve the detail of an attachment uploaded by the company."
+sidebar_label: "Get Company Attachment Details"
+hide_title: true
+hide_table_of_contents: true
+api: eJzdV21v2zYQ/isc96EtINqy6wSpPi1Y2iIftgZNug1LDJcWzzZbiWRJyrFh6L8PR0mR5Nhp94INWGAgFnW8e+743HP0jm7YsnBeM6k8LC33UivmtwZockshn4MQIOg0ohac0cqBo8mOjuMY/wlwqZUG99CEvt7w3GRAGksa0VQrD8qjLTcmk2nwP/zkcMOOunQFOX/s6WYFJNW54WpLuPc8XeXoJaIVMKrnnyDF5w2DKmhA5Yo0BedmznNfhJWikIImdDQ+fQkcTthkMhqxyZl4xebiVLDRGYhXL+OzMZye0IgqnqP3H6vIs/OHyLM3MoOBEQtMiXtYarulCV2CmSntZYqpFibTXMy8DD7G8XjC4ldsFN/Eo+Rkkozj32lZImLPlw6LW4chbRgss7HagPUSOvh3Td7OW6mWNNor14cPlxdEL4g/XLayyexrftCq8bOQGZAqJxDoos37a27C6dXWT8CKKKgix0r06oiWmeQqPGi/Akun5V55vwXB5fU7cnYajwhucZ7nBrHcr0ARrjo4yD13nUTLiHrpsw4P2HmvlF3C1YzHr2ueFfBfU27M4jGLRzdxnITPII4D7fAvopN48rjVftaevNGFEuROEXKnsHQWvhTgPAhsZV3YFIjQ4IjSnsBGOj8gP/HPQFxhIZyusXotBQgSmCgdWfNMisGdCvVEQoe+vxQhA8/WI1YRQoJjPUr0wb0HbyWsqyACPJcZHmL//JqzI/Ntl2qDO3WnXKoNJORjvTZrt7nEAhcfaUQNtzwHDxa7ctecSLNDChpRiWAM9yuKOvilkBYETbwtIOpoWJ+T5SFSHuhUWka7p5zs4WkzmAWmPQ3umxD0teKhAr+xt2EwnF9dsl/AOvRRR1sBF2B78RY8c48CXmBZc6nAVSfIPbA5dyDI+dUlWVdOCXdOp5Ij3+6lX5GtLmwwSHmWDcjlgiitAGnV8CyqbDoj5Zkjt7lUMi/yru/p85X3xiXDodCpG4RJN0h1PmwmGzN8a3WWhfdDbiSrd0q1/L52yDrLLxBG4UAM6PGjb5VtHI9PWHzKRieo7QIWvMh81avNellOI/r0TNgwZ4B/Bu62bGl1YVo+tIaO9g3xFJleg7VSQNV3F6GD0BA2HhTmU3H+M6C2HL0JRI26dW8EyJRm3z68hw2HYB7e2IfbOujAxkLl4Fe6lpHQu35FEzpcj4YPgjLctb1bDjsd377Ya6ISzxLsupGAwmZI8po53MiKOExAHtjzSKcuINd75a/8sTALcF9I+4jjgz6vrBZP+DT4GiviIC2s9NuAvObPebgHnRdYnNtp1+oaKVsNrwO2D0RGiA3B8XkO3IaG72NsJmQGa8gIL/wKlK87ErXreus85H8nQuXhSIAS5Wihg9d6ZgfJQgVACtWi1Wu3iKIkuXeLa7BrHKPtebTqwOe68MNgOBQYGkcYC89ML8I5VBO4D/ZXyFKdA/GaBBzPHHld9wu5qnQmiJPQaYHkC2l8V1+TeRquybX4XjRRyXvIgl1o25zLLBCqfvtDyx+shtHO51x1/LwFTx6LCmmVoJfBrr2w/zuztyaDh40fmozLwJrQJbu6t2/pelTfCkN304gmvdnMewqYHJuT04iutPPocLfDGfTBZmWJy18KwKvV7RRFx0o+RyLd7qiQDr8fmW3dUj1/X4/BF+TYkD+Sar1YWTSSR6NaHzt5onr8k4AO/qz6K9j261ziZb2+H/y5Kv7PLwsHa1zV8vBN66Hk7cBEJTW+8+7Rj+rejHz7+oaW5R+BeIMg
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Retrieve the detail of an attachment uploaded by the company.
+
+scope: `company_attachments:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-attachments.ParamsDetails.json b/docs/api/get-v-1-companies-attachments.ParamsDetails.json
new file mode 100644
index 000000000..02a817035
--- /dev/null
+++ b/docs/api/get-v-1-companies-attachments.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"string"},"description":"The UUID of the company"},{"name":"X-Gusto-API-Version","in":"header","required":false,"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.","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"}}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-attachments.RequestSchema.json b/docs/api/get-v-1-companies-attachments.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-companies-attachments.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-attachments.StatusCodes.json b/docs/api/get-v-1-companies-attachments.StatusCodes.json
new file mode 100644
index 000000000..3d604561e
--- /dev/null
+++ b/docs/api/get-v-1-companies-attachments.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"Example response","content":{"application/json":{"schema":{"type":"array","items":{"description":"The company attachment","type":"object","x-examples":{"success_status":{"uuid":"1263eae5-4411-48d9-bd6d-18ed93082e65","name":"Company_Attachment_File.pdf","category":"gep_notice","upload_time":"2024-09-10T01:54:20Z"}},"x-tags":["Company Attachment"],"properties":{"uuid":{"type":"string","description":"UUID of the company attachment"},"name":{"type":"string","description":"name of the file uploaded"},"category":{"type":"string","description":"The category of the company attachment","enum":["gep_notice","compliance","other"]},"upload_time":{"type":"string","description":"The ISO 8601 timestamp of when an attachment was uploaded"}},"title":"Company-Attachment"}},"examples":{"Example":{"value":[{"uuid":"5de11791-98fd-4587-9ed0-d5d804b8e647","name":"Company_Attachment_File1.pdf","category":"gep_notice","upload_time":"2022-02-01T00:00:00.000Z"},{"uuid":"987058cc-23ee-46e9-81ef-5cee086cceca","name":"Company_Attachment_File2.pdf","category":"gep_notice","upload_time":"2022-02-01T00:00:00.000Z"}]}}}}},"404":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided UUID is valid.\n"}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-attachments.api.mdx b/docs/api/get-v-1-companies-attachments.api.mdx
new file mode 100644
index 000000000..bd78f8096
--- /dev/null
+++ b/docs/api/get-v-1-companies-attachments.api.mdx
@@ -0,0 +1,71 @@
+---
+id: get-v-1-companies-attachments
+title: "Get List of Company Attachments"
+description: "Retrieve a list of all the attachments uploaded by the company."
+sidebar_label: "Get List of Company Attachments"
+hide_title: true
+hide_table_of_contents: true
+api: eJzdV11v2zYU/Ssc99AWEG3JtR1bTwuWtgjQrUGTbsMSI6XFa4utRKok5dow9N+HS0m2HDvNig17mGHA+rhfvDznXHpL12xZWqeZVA6WhjupFXObAmh8SyGfgxAg6CygBmyhlQVL4y0dhCH+CLCJkQX60Ji+WvO8yIC0ljSgiVYOlENbXhSZTHz8/ieLDltqkxRyjld1RsqN4RsaUOkgt8cZblIgic4LrjaEO8eTNMfoQeuu558gwfs1g7oYH8SWSQLW3lvHXemflKUUNKbRYPwSOIzYcBhFbDgRUzYXY8GiCYjpy3AygPGIBlTxHKP/XGe+P99lvn8tM+gVYoFL5Q6W2mxoTJdQ3CvtZIItKItMc3HvpI8xCAdDFk5ZFN6EUTwaxoPwT1pVWLHjS4tNb9KQfRpsf2F0AcZJ6NS/a5t1RqolDR6068OHywuiF8SdblvVruypOGjVxlnIDEi9JhAYYr/up8L43Wusv1FWQEGVOXbioI9omUmu/I12KRg6qx609+9UcHn9jkzGYUTQxTqeF1jL1xQU4apTB/nKbWehVUCddFkHB6yzQfi6i7iGCni54lmJZNqBbiQgis6mEZtOFoINR5MzNgURMjESk3A4n8B4ePYk6KLvRd2AhQMWRjdhGPtvLwwRecGurOnkLBxNkoQNXgKw4RimbBLBgo0SgHAyThJI+JNlDf6lsmYVfgI6DIfHKvCrduS1LpUgd4qQO4W7auBLCdaBQPXRpUmACA2WKO0IrKV1PfIL/wzElgY88AqjV1KAIJ4k0pIVz6To3Sm/l8g1L1WXwi/BsVXEaqxKsGyPEnuEsffgjIQVEE4yaR2Ci2eZz9lx2yGLzDddIvTu1J2yiS4gJh+bZ/cdv9gAFx9pQAtueA4OjPXYaral9ZACRRTLKbhLKar3l1IaEDR2poTgWHkbxlSnKHNCRzxymqR/sDd+gpxfXbLfwFh0bLKnwAWYg/wLnll4mOUCV5JLBdYnEdwBm3MLgpxfXZJVHZRwa3UiOe7yV+lSstGl8QYJz7IeuVwQpRXgZra7G9Q2ndnzzJLbXCqZl3k39ux56lxh435f6MT2/EjsJTrvtyOQFXxjdJb5931eSNZ4SrX8sQnIOo9fYBmlBdGjj3d7L3WDcDBi4ZhFIxR7AQteZq6mSPu8qmYB/faQWDNbAP8M3G7Y0uiy2EPi/ACyXUPcRaZXYIwUUKP9rbReh9cOFC6mxthnQD4/el4IdlLXOTcgTFq/h7XtHE7VeNrxsNZ9gLZmbFEOLtUNbT1RXEpj2l9F/R2B+9s9Uar+IZstmFXLqtJkCOIGGbyQNTCYgNyj44j8F5DrB+2t4zGvsehXa+7pwCdjXhktvhGzwNe4bgtJaaTb+MobfJz7g895iS24nXWtrhGS9bA6YbsDKpbYAhjv58CNJ/Rhje1IzGAFGeGlS0G5hnGoKdcb6yD/JxnqCI8kqFBuFtpHbYa0lyRkOKKkEaUDOgUUJce+W1yDWeF02u/Hnv18rkvX94Z9galxMDB/z/TC70M92A6L/R2yROdAnCa+jmeWvGooQa5qHfHiI3RSIu78Mn5ozss88eflRlwv2qzkPWTeDkEKOZeZB1Tz9qc9frAbhbYu56oT5w048raZR8ficTTGtvuj+3810Ro8OFi7fpFx6YHjibJtSHxLV1FzEvQ0pgGNDyZel8mzgKbaOvTabnGWfDBZVeHjLyXgyeR2hvphJJ9n9flMSIvXj8yobkeev2/G2Qvy2Hx8ZD3t/xxv0aoXDRqp6yymwsNtMz6/r7j/+Sw92da6facPIrsu70cKClHhOu+O/pweDJI3r25oVf0FlGs5bA==
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Retrieve a list of all the attachments uploaded by the company.
+
+scope: `company_attachments:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-id-admins.ParamsDetails.json b/docs/api/get-v-1-companies-company-id-admins.ParamsDetails.json
new file mode 100644
index 000000000..3fe999b74
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-id-admins.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"string"},"description":"The UUID of the company"},{"schema":{"type":"integer"},"in":"query","name":"page","description":"The page that is requested. When unspecified, will load all objects unless endpoint forces pagination."},{"schema":{"type":"integer"},"in":"query","name":"per","description":"Number of objects per page. For majority of endpoints will default to 25"},{"name":"X-Gusto-API-Version","in":"header","required":false,"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.","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"}}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-id-admins.RequestSchema.json b/docs/api/get-v-1-companies-company-id-admins.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-id-admins.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-id-admins.StatusCodes.json b/docs/api/get-v-1-companies-company-id-admins.StatusCodes.json
new file mode 100644
index 000000000..8fa659d45
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-id-admins.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"Example response","content":{"application/json":{"schema":{"type":"array","items":{"title":"Admin","type":"object","description":"The representation of an admin user in Gusto.","x-examples":{"Example":{"uuid":"987058cc-23ee-46e9-81ef-5cee086cceca","first_name":"John","last_name":"Smith","email":"jsmith99@gmail.com"}},"properties":{"uuid":{"type":"string","description":"The unique id of the admin."},"email":{"type":"string","description":"The email of the admin for Gusto's system."},"first_name":{"type":"string","description":"The first name of the admin."},"last_name":{"type":"string","description":"The last name of the admin."},"phone":{"type":"string","description":"The phone number of the admin."}},"x-tags":["Admins"],"required":["uuid"]}},"examples":{"Example":{"value":[{"first_name":"Katherine","last_name":"Johnson","email":"Katherine@acmecorp.com","uuid":"987058cc-23ee-46e9-81ef-5cee086cceca"},{"first_name":"Anita","last_name":"Borg","email":"Anita@acmecorp.com","uuid":"5de11791-98fd-4587-9ed0-d5d804b8e647"}]}}}}},"404":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided UUID is valid.\n"}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-id-admins.api.mdx b/docs/api/get-v-1-companies-company-id-admins.api.mdx
new file mode 100644
index 000000000..c7d37d528
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-id-admins.api.mdx
@@ -0,0 +1,71 @@
+---
+id: get-v-1-companies-company-id-admins
+title: "Get all the admins at a company"
+description: "Returns a list of all the admins at a company"
+sidebar_label: "Get all the admins at a company"
+hide_title: true
+hide_table_of_contents: true
+api: eJzdV21v2zYQ/isc96EtIPolixNbn+qtL8iGdUHTrgMSo6XJs8VUIlmScmMY+u/DUZItJ3GQbsU+rF9SS6e7h3fPPXfc0Bu2LH0wTOkAS8eDMpqFtQWaXlIo5iAlSJpQbm3XxNNZQgNfejT7xRSWawXxoeWOFxDA4asN1bwAmlIRTdYfFfpSmqbU8pDRhDr4UioHkqbBlZBQLzIoOE03tAZBfXBKL2mVUAleOGUxPE3puwzI+/dnL4hZkJABaSLQKtncdRKRg0MvMfiXEtyaJi06y5dA7wuAL0jIeCDKE4QKPoDskQ8ZaFJqb0GohQKZkK8qz0luuCQ8z4mZX4MInpQ6B+8JaGmN0oEsjBPg0a3SMY+9f4YX3B24b8piDg6z0Qa34OIBeuSVcaTg18apsEaLFo+vYUtY8DIPJBhyNIqAmjh/sdeRG9PzM/YnOI+RGkQZcBlR7Aq44LmH27BeIBUKpcHHKkkegM25B0mm52dkVTsl3HsjFA8gyVcVMrI2pYsGgud5j5wtiDYasAjWmZWSmPFow63NlYipfOLJZaG0Ksqi63v2NAvB+rTfl0b4XiR7T5ii35KbWb52Js/j+z63ijVfKr38sXHIOo+fIYzSg+zRw3RNKOiywOY4GhyN2OCEDUfYHU2qadp9XlWzhBoLdWudSZrSJQS2GjLRdhbbNRDjslDax9R7a7QHj/GPBgP8s5/9lze8sDmQ1pImVBgdQAe07SSvf+3xg3uoyJ3jSD0VoIiBggo5vpgiDJq0djXr7u0iB9aBBx1iKCQg1ySeAvPoiNIk8gwTesOgxhxjNfjxv2WpMDGT8elgNBaCHf0EwI5PYMLGQ1iwkQAYjE+EAMFpQhfK+fCxofGvJkOgOd89uihUlB8ouMppSq89PphMni/xAfKDVlVCrcOyBFWjqSHcLfXdE5dafSmBKNmqUzwtNnsb8TFeoumeBxSQOldPPPFrH6CITrvHfYznaE/Q/i7ATpoe4wrND3iymdGP9BJNid5qWNdRhaxoZ820Jv+sKzyXdWVmaHmAPSuelxAH0h4zfuMhA6c03KIHMsZHsWsJsrV8zkUBwjgbSZJ8Ey9RWvfiT7UK/Fbsn41bdgJHkwNBRxKGw9PJkE3GC8mOR+NTNgE5YHIkx4Pj+RhOjk9pNavwX0KPB8d3FeKNCeSVKbUkV5qQK133azPoUDdM6QQQacATbQKBG+VDj/zOPwPxpYNYqVaU64GsPFnxXMnelY7F2w/4FkLptCec5MqHKAZ5vqu3JzwQ3k7zK32lvTAWUvKpVcBoljrg8lPUC2+Bfwbu1wwTyMwKnFMSM4kBpq1Ywk0A7ePqgjT4DGuaHl5+ki1jHl6CsKKtq0NAtr66gFDyCwiZadSeJvVGlNL+atjf6n5/sxP+qr9Vfg9u1W5YpUOatEOOW1XPOCahMA1dbo/kwtzKXO2PRVLhd5GpBxzf6/PcGfmAT4uv8cgeRIlbSERe743rqRDg/bTE01/OulYXOIzqXr7HdqsrCLGdxfh7DtzdsyE1LlgOK8gJL0MGOjTzD+XqIurpv4lQezgQIO5yC9MdoVHJcVlBjjT71d5mkFDcnvwfiwtwKyWgU4/dIsPnpgz9aNiXGBpnFou/mVnEOuCnt8F+gFyYAnDrayfKy4bq5LxeieIeJY0oi3Z4/9BsEFzEDaKRrBdtVPIW8qY1dgq2xfR8x584XI0PBdcdP68hPKQGt4+w2S0z31tWmroHuAl9m3MVCRIbYtP06SVdDWMy2rtPQtO9Ww7fTqrM+IAfbDa4+b53eVXh43qpx0aQyvN5fmiH7h7zP7qUHEhArXTNbakVtagVjz/Bd7unPIwxducO4gx/OIUYvzHjT982e8YzcujKeQBJu0BHiy2UFmGHK9WsStoL1beB+5/frh4o8P1X0z1O1oao5zZ03t259eyN4tcv39Gq+hsGneYw
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Returns a list of all the admins at a company
+
+scope: `company_admin:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-id-bank-accounts.ParamsDetails.json b/docs/api/get-v-1-companies-company-id-bank-accounts.ParamsDetails.json
new file mode 100644
index 000000000..f6a212df9
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-id-bank-accounts.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"X-Gusto-API-Version","in":"header","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"},"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."},{"name":"company_id","in":"path","description":"The UUID of the company","required":true,"schema":{"type":"string"}}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-id-bank-accounts.RequestSchema.json b/docs/api/get-v-1-companies-company-id-bank-accounts.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-id-bank-accounts.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-id-bank-accounts.StatusCodes.json b/docs/api/get-v-1-companies-company-id-bank-accounts.StatusCodes.json
new file mode 100644
index 000000000..ec44a5e8a
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-id-bank-accounts.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"successful","content":{"application/json":{"schema":{"type":"array","items":{"description":"The company bank account","type":"object","x-examples":{"success_status":{"uuid":"1263eae5-4411-48d9-bd6d-18ed93082e65","company_uuid":"e2c4c0ce-2986-48b9-86cf-ec27f6ed9a36","account_type":"Checking","routing_number":"851070439","hidden_account_number":"XXXX4087","verification_status":"verified","verification_type":"bank_deposits","name":"Employer Funding Account"}},"x-tags":["Company Bank Accounts"],"properties":{"uuid":{"type":"string","description":"UUID of the bank account"},"company_uuid":{"type":"string","description":"UUID of the company"},"account_type":{"type":"string","description":"Bank account type","enum":["Checking","Savings"]},"routing_number":{"type":"string","description":"The bank account's routing number"},"hidden_account_number":{"type":"string","description":"Masked bank account number"},"verification_status":{"type":"string","enum":["awaiting_deposits","ready_for_verification","verified"],"description":"The verification status of the bank account.\n\n'awaiting_deposits' means the bank account is just created and money is being transferred.\n'ready_for_verification' means the micro-deposits are completed and the verification process can begin by using the verify endpoint.\n'verified' means the bank account is verified."},"verification_type":{"type":"string","enum":["bank_deposits","plaid","plaid_external"],"description":"The verification type of the bank account.\n\n'bank_deposits' means the bank account is connected by entering routing and accounting numbers and verifying through micro-deposits.\n'plaid' means the bank account is connected through Plaid."},"plaid_status":{"anyOf":[{"type":"string","enum":["connected","disconnected"]},{"type":"null"}],"description":"The Plaid connection status of the bank account. Only applies when verification type is Plaid."},"last_cached_balance":{"type":["string","null"],"description":"The last fetch balance for the bank account. Please be aware that this amount does not reflect the most up-to-date balance and only applies when the verification type is Plaid."},"balance_fetched_date":{"type":["string","null"],"description":"The balance fetch date associated with the last_cached_balance. Only applies when verification type is Plaid."},"name":{"type":"string","description":"Name of bank account"}},"required":["uuid"],"title":"Company-Bank-Account"}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided ID/UUID is valid.","type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["error_key","category"],"properties":{"error_key":{"type":"string","description":"Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error."},"category":{"type":"string","description":"Specifies the type of error. The category provides error groupings and can be used to build custom error handling in your integration."},"message":{"type":"string","description":"Provides details about the error - generally this message can be surfaced to an end user."}}}}},"x-examples":{"not_found":{"errors":[{"error_key":"request","category":"not_found","message":"The requested resource was not found."}]}},"title":"Not-Found-Error-Object"}}}}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-id-bank-accounts.api.mdx b/docs/api/get-v-1-companies-company-id-bank-accounts.api.mdx
new file mode 100644
index 000000000..6512fe680
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-id-bank-accounts.api.mdx
@@ -0,0 +1,71 @@
+---
+id: get-v-1-companies-company-id-bank-accounts
+title: "Get all company bank accounts"
+description: "Returns company bank accounts. Currently, we only support a single default bank account per company."
+sidebar_label: "Get all company bank accounts"
+hide_title: true
+hide_table_of_contents: true
+api: eJzdWFtv2zgW/itc7kNmAMl20iRN/LSZtlPkYdqgSXcDJIGHJo9tNhKp4cWJYei/Lw5J2ZIvSbP7stgnW9K5fudGniXVFRjmpFaXgg7pFFw+P8y5LiumJNj0bzGSIh8z9ZgzzrVXztKMCrDcyAp56ZB+A+eNsiQxEKQmDXWPfPDGgHLFIiNPQLQqFsT6qtLGEUasVNMCiIAJ84XrsJIKTCOzd6/uleW6giH5szEMiUeNnqEBJv6kGXVsaunwjv6Goi4amx8y+pxPvXU6l8rBNDqeu0UFSAzlGIQAgXQVM6wEBwbFLKliJdAhvc0/B+6Lq8v8n2Asup5Rif7PgAkwNKOWz6BkdLikUS61zkg1pRkF5UvUczQ4OskHp/nhCWpKXtNh+329Ce9HtKWUCixxMyCCOcjHzIIgF1eXZB5tIcxazSVzIMiTdDOy0N4EAs6KokcuJ0RpBURaUhk9lwJEFmlYVRWSBzgOLLkrpZKlL9uyH36ZOVfZYb8vNLe9gGKP67LfoJZXbGF0UYTvfVbJPHFKNf17Epi3Xv+KZngLokfrbIXwOt8aYCvmZlvZdjMD8v375UeiJwGPxEYzauAvLw0IOnTGw/5w1PVDRi1wb6RbhBh/iDIuOAdrL7yb0eHdQ93KGWOf2LSRa8BWWlmwKPpoMMCfro3WB0kTX9CMcq0cKIdULaz7PyySLretZMYwdEc6KO227Ju1z51ywdSPAvT4B3B8fs7hmZVVES1NRo2sY86HN95LrPzDo9N3wOAkPz4+PMyPz8R5PhanIj88A3H+bnB2BKcnwY8Yn8QFR/yYDzjkR+dnp/nx2fg8Pzvlkxz40fvJKYhz9u6UZjRZN0q2fZgBf4w1YbR3Uk1HypdjMHRIz04OB+8Hx+/OaUZnUghQTXWvaW5vb2+PB2fvaUbnYOQkoblyKr0FsUmQ9IeeIaDSVoZOlnLvU1kVegGG/O6VkGraNA5a1whj01NSnpCt3lIZbKZOQgvX7S7QDWQ7iTuBrDexfoukphzqTehfE/Jbu/UG0nXbakXtms2lmlr6UG9H8DUVNxueHliSRJAkot4b+ddk/8HsI4juAFkL3Zkr+9s0e2IyeNbKFJwvi9FEm1Fb2CrN4uzY9rdNTKLmXUEPA+5gS+8BKYEpu0WODfSHt45wA6HnMyVIqRUs8MsYEFJnmLITMAZE714d7La/raCU3Oi8UU2YidlUQKPAbfpTGY0thXCmyBimUpHxgngbtDe0CwJKVFoGHw8asF5yrKHpbUVuXyY3cdus7qpgYZqE3xE8OzCKFT8RKFSwP0wdNS95wrVSwBG+McLgAO1d5TxCmojXJWDD64hcxNFoP51tBAehDE79nPZGyBWyBFgjIutKYGrxdRJm4T5sV9Kw9KRdPz7gDE9cyhcFrXfiG3Q3Nr1SDOQrnhLDtARLnmagdoRH2pY/BbNuxBmfgRiNWcEUbyXK3dqbYOBO+1ACmYDjM5IEkIk2O2y7KoBZIGMg7AlrxM2YI24mLWFlgF5osERpRwxMCuAuFpe2jvgqdzrHE9xKB0Zbb3m7VWnbHicBo2AyiBFKfaPLKz+D18GszWOkS8hsYPsfRChO2tfa+BdWhsLrDsS6fbi7i/P1IaNOuiIcKuLMy3GE5evJXSPf8eB4+wz1RTvyu/ZKvOV4tkcEuVeE3CvEE20Ei9gZsNobDutcgGdpXY/8wR6BWB/SBlZHcXL5sR+GOHY/ViBi26e5NgJgjDY7Th7p/QuHyVeljh4BGThzMNVmsUdHoHo1mtcVcGzlIUOSz4GdaM69sT1ys6gk3lAWsYIecYAJUC5yIT1zzsixd9BfXcyIgSKkqNNrkSHJVla/wTSU0PT7KImEM3YS1QTJJsunRvsKj0ChdOPkC5cZtGbsZSEIxztDmehnTIkCO7lU8cLVun8Gm0uwlk1/ojauGkMEOCYLS9hYe9cCNSdTUGDWcCbRjZXWmwnj0VKmcC6j4YhcrJXufUFpN5qEImkl1l0n/jRlfDtfhi3GlnN0T4E8sVgfgaFH6wc0pCnsL9rlocjyT6g0/xqzdmWurYA9ArOLPEQlne8v1ouKNgk2oFzPwRgpIC48cLw9O1B4KY3ORbf2rgoyOmeF31gZ4Pzr8sXr4ooYr41tok2zV4Rd83ezdN1Ys6I7OHlLcDMtVv6FO/SQ9ueH/dVqp79c37XrfmeNglsMMPNm+eFNgQuOdP1nlYy3/1xAGVYAWzn6EUq9gXuUl4dLI/IFv/YI3inzymjxgswKP7ev9NfYsmMO77jYr6oMlTdLm4A9MBPWOF3tzXApYA4FYd7NsD2l03+d0euFdVD+NxqihD0KatyFTHSQmqoiLKJwQRMvHzZKaa2QMoobI/t1cg1mLjm0kF4vb0Lz6AfCvkDV2OPz8JzrSUAYWTeN/RcUXJeALSTYcWDJp1QJ5CqugcLuSGjuS1AuuPG3NGcZD3M2Xbo/NlrJN+znoQYzCiWTRUiV9PUf68xANCptXclUS85ncIQVxe7946YDy/XA/19bXMakcfDs+ng8D9kV6mSZqviOzg9XixicxhkddrZm3VJ+yOhMW4d8yyVuDL+boq7x9V8esFPfPWD7MJKNMa/ulniux/+CDiessPACdL98S+eGX8n+hdxOj5qDSaBomhfNUqdruVPjiiHtVt9m3P/1xnQPrBG+3VvqFcrriYL9qnKtb1tn384s+fzpBnd53fa2amfpT+v22I3uchkpbvQjqLpeBdvhcxj59b8BPQio8A==
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Returns company bank accounts. Currently, we only support a single default bank account per company.
+
+scope: `company_bank_accounts:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-id-company-benefits.ParamsDetails.json b/docs/api/get-v-1-companies-company-id-company-benefits.ParamsDetails.json
new file mode 100644
index 000000000..787ce85f3
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-id-company-benefits.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"string"},"description":"The UUID of the company"},{"schema":{"type":"boolean"},"in":"query","name":"active","description":"Whether the benefit is currently active"},{"schema":{"type":"boolean"},"in":"query","name":"enrollment_count","description":"Whether to return employee enrollment count"},{"schema":{"type":"string"},"in":"query","name":"benefit_type","description":"Filter by benefit type. Comma-separated list of benefit type IDs, i.e. `?benefit_type=5,105`"},{"name":"X-Gusto-API-Version","in":"header","required":false,"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.","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"}}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-id-company-benefits.RequestSchema.json b/docs/api/get-v-1-companies-company-id-company-benefits.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-id-company-benefits.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-id-company-benefits.StatusCodes.json b/docs/api/get-v-1-companies-company-id-company-benefits.StatusCodes.json
new file mode 100644
index 000000000..c5a2cd331
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-id-company-benefits.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"Example response","content":{"application/json":{"schema":{"type":"array","items":{"description":"The representation of a company benefit.","type":"object","x-examples":{"Example":{"uuid":"54e37c27-43e6-4ae5-a5b2-e29895a133be","version":"98jr3289h3298hr9329gf9egskt3kagri32qqgiqe3872","benefit_type":1,"active":true,"description":"Kaiser Permanente","source":"external","partner_name":"XYZ Corp","deletable":true,"supports_percentage_amounts":true,"responsible_for_employer_taxes":false,"responsible_for_employee_w2":false,"catch_up_type":"elective"}},"properties":{"version":{"type":"string","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."},"enrollment_count":{"type":"integer","description":"The number of employees enrolled in the benefit, only returned when enrollment_count query param is set to true.","readOnly":true},"company_uuid":{"type":"string","description":"The UUID of the company.","readOnly":true},"uuid":{"type":"string","description":"The UUID of the company benefit.","readOnly":true},"benefit_type":{"type":"integer","description":"The type of the benefit to which the company benefit belongs.","readOnly":true},"active":{"type":"boolean","default":true,"description":"Whether this benefit is active for employee participation. Company benefits may only be deactivated if no employees are actively participating."},"description":{"type":"string","minLength":1,"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”."},"source":{"type":"string","enum":["internal","external","partnered"],"description":"The source of the company benefit. This can be \"internal\", \"external\", or \"partnered\". Company benefits created via the API default to \"external\". Certain partners can create company benefits with a source of \"partnered\".","readOnly":true},"partner_name":{"type":["string","null"],"description":"The partner name of the partner that created the company benefit. For example, \"XYZ Corp\".","readOnly":true},"deletable":{"type":"boolean","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"},"supports_percentage_amounts":{"type":"boolean","description":"Whether employee deductions and company contributions can be set as percentages of payroll for an individual employee. This is determined by the type of benefit and is not configurable by the company.","readOnly":true},"responsible_for_employer_taxes":{"type":"boolean","description":"Whether the employer is subject to pay employer taxes when an employee is on leave. Only applicable to third party sick pay benefits."},"responsible_for_employee_w2":{"type":"boolean","description":"Whether the employer is subject to file W-2 forms for an employee on leave. Only applicable to third party sick pay benefits."},"catch_up_type":{"type":["string","null"],"description":"The type of catch-up contribution for this benefit, as required by Section 603 of the SECURE 2.0 Act. Only applicable to pre-tax 401(k) and 403(b) benefits.","enum":["elective","deemed"]}},"required":["uuid"],"title":"Company-Benefit"}},"examples":{"Example":{"value":[{"uuid":"d2cec746-caee-464a-bcaf-00d93f7049c9","version":"98jr3289h3298hr9329gf9egskt3kagri32qqgiqe3872","company_uuid":"528cc543-8a41-497e-b479-23a4c5ec77ac","benefit_type":1,"active":true,"description":"Kaiser Permanente","source":"external","partner_name":"XYZ Corp","deletable":true,"supports_percentage_amounts":true,"responsible_for_employer_taxes":false,"responsible_for_employee_w2":false,"catch_up_type":"elective"}],"description":"OK"}}}}},"404":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided UUID is valid.\n"}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-id-company-benefits.api.mdx b/docs/api/get-v-1-companies-company-id-company-benefits.api.mdx
new file mode 100644
index 000000000..ef0d070b9
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-id-company-benefits.api.mdx
@@ -0,0 +1,75 @@
+---
+id: get-v-1-companies-company-id-company-benefits
+title: "Get benefits for a company"
+description: "Company benefits represent the benefits that a company is offering to employees. This ties together a particular supported benefit with the company-specific information for the offering of that benefit."
+sidebar_label: "Get benefits for a company"
+hide_title: true
+hide_table_of_contents: true
+api: eJztWetuG7kVfhWW/bExMCPJusSWgaJ17GzW2O7GiJNuW9twKM6RhvEMOSY5sgVDQB6k+3J5kuKQnItu3lzaHy02fyJrOOd+vvMd6pE+xLPSWBULaWGmmRVKxnZRAD26pJBPIEkgoRFlRdE+Yuh1RC2bGTx2ovKCyQV5ARKmwrpnGkyhpAFDjx5pv9fD/xIwXIsC36dH9OUDy4sMSHWSRpQraUFaPMuKIhPc6ep+MPjCIzU8hZzhJ28gZVqzBY2osJCbTQ1vU5ReaDAgrRNF1JQwwoO9E29vh0aVQDX5ANzSiD7E4M1zYoOp+LEsRUKP6GgIgwPeP4iHA3geDxmMYjaa9GPojw/HI7Y/GEzQoTlo420ZH37Qg/7hOB30x4epHg/649l0DDNzawe3bKbFoH93NxN3MDg86NOIBttuvGH7EWXcijnQI6tLiNYc/ZEJA5qcg86ZBGlRtVGl5ugTPFjQkmU0ogXTVoK+kSzHJ3//xz/JidIFRXkZWDbJagWmLAqlrbkpQHMM3wxuWK5KaU11JCROTDK4mSp9A3mRqQXoG8seMG5Tlpndx+Dmvl+f4czy9KYsgrsUMvDuLpcRLbQqQFvhc1GHtK4CY7WQM7oeFMw+L7UGaUl4CdNvUyA+zR1yAeD+vgzPhZyRWSkSuH6WWluYo243Udx0XId0uMq7VUfEBVtolWXueVckkBfKguSLPTJVmgg5VToPJSdJqu6JVaQ0qE4YMhWQJR26jChIlJKDtDccg9tyy3Ub6K1+yTKfgEZ3qmga4kVBQoR0ToUKioiS2YJosKWWkJD7FCRZV0vuStALUjDNciIMMWDRYMwzdocGlryW2cJnfomN6jroxnfD52Ti3buz0yr84e2tkr9JYrujNySvdtRnhRmPVCrC6xiW+1TwdJteMoFMyZnZqr9q4FrzRKkMmHSap6zM7Pbm/iUFm4L2lVMpEoZ4ea7cqiLABFrBReEqr0NOVs0zJGcLXw4TIAk4CcxiyUyJVK1aYhqC/GzRFipnrmpXDNzMVS7kX0HObOqAazOsrW92JZB8j2552I1akO0cmE5Bk7zMrMD5UTt3L2xKmCS+LPbJMwzNT5AIzjJyJk2pmeSw1yHrNtyrMkuIwS41KgebIg7kSgMxBXAxFZxk4hbIp4//2kDaTx9/JUrjoxdZCeREK2O6xH2+SLHNP3381cWswuPNcIEscxyjWIkBqDcxGxKcqpux9GJ3hvEtFg1nEhN+VWu4ohG5qpXgX0qTq0bVFd1SO1yDq5W5YE7X8fkZCYWLTdGW1yEnoC0TkgSR3gYvYd3IKnEtV1ZN2dZMq5OsiullE1RZZtn2iIVXCb5axa36zqbM1o7+dl1e1SN0h5mtsbq17Xf2+TqwhBQ6eZB0yGklmNyLLMNHLcjGdm5DVsoMkQrRCSQOITciwgCLwtMGQ+q0MGMUFxiKiDCZrIgUXqK6x5EyWZBXOCGxihg597F0Nf8UifjsgNSWJZCU3LFPZ08VI2SNWkxK/yRECsPBDGkUG8x1cNqBJpNEyETMRVKyrFYSWkYYkoAFnYvgoG2NgyoIaEQIBFdyKmaldikJx58ac7/Fnb6gWqCyXbvJXTpug6VQsEXzyMn1w5/JJqTCID/JgM2hQ9BCEog3+oHllAqduPZYECP4rRNaVYjDtSfp3X/CjanIgPwS9zFpualSV3vwjeavMc8vQpKqHpyMuCxWKtEZ2p7ZEdajhrtSaF9SF+CKmTzvDSocunh58u7NS9Lv9MgxEtQtLhUaYsseyLC3/+x2z9XgsDd4Ntlr+dXMlJpIo/2Q4xRZuqR5M/CIY1y4zQmLOFVtc3HY5hwF37EMzVlWYrDqtSjpc+AHw+cxZwDx8PmQxRPOpnGvl4wH04PecMzH37QWrRJPOuofcj4aDuJDNtyPh+MDiCfDg3HcH7AhHwE/OGD892WqXqY2qvj1j3SJ/yI67A03F+iflSXfq1Im5EoSciX9Qn1XgsH5qCFM7ESBR0F4EMZ2yE/sFogptV+uCq3mIoHEE3ZhyJxlIulcSVdZuNo5tnqG+ZyBjef7sc+yABNX+RZJ/bEq8w0s2WAs9e7fHl3GD/mGUiIEIqNE0mdbJDhMAtw7iVUzj1MssOEyY5qEtGI3h4ngmEwL++OaQLY3Qo8M0Kh13c9szTKu5JX8WVkIfGSDiVVkoCHwjtQ7dN/g8dVe6KS+qGUoiQQNtZ//cOYOOhlz4YoLI9G6gjGNZ+/X83CEw+2oSMV7YrgqwOlxn452HH7vu4flOGGNw4/QRE268VYHk1owm9I2YIWOWr8KCnC9vpzs2hTpMtpyn1RNqWVQ7rZiHAHeOtZA6a4Z1uJH4e4BATy031eo3Lgf2KlchRW/mYzNu8S/u9WAJnDb9K8g57ru70VmQeMoq5fjRQFudchZbABzjMWZCWPbvMnNzbNTExHRgQ55/+e2lj+Nov3e6L0ztoLW2NHL+Pj8LP5bGB3B3BRY4pb3pkACCq6aelqROePSlDAL8YQhFcY1proeahivr/eFKrU7wFmWdcgZbsnSkaYK1CJ/ptUq3xlymQsp8jJvy/7CGyVWiLi5lPpjEBi3vt5DM5DM47jfldWGCPR7/VHcex7vjzyXCRcO7e+XOB8eELLYLTCziGdalUXTlS8a4G2fwiTFag5aiwRVY7bDCiuNuyrGBr+FBT3afdkc1Vzi6UtnrIpK1LqhtYwNg7e/tWp487ZzAGOBVwEqjCUHWXijQbvz/W49oLqPDWQtu1tGlAE9r0Cu1BmWbKgDVghfBnECuauFjQY7hVytRdvLiz3bwsfo2w7BW2Wea5U8IbPAx+i8AV5qYRfO8jBajzkHY45LjMPldfvUBRag54dbztZliSZW5erhhektd28VBc1gDhlhpU1B2tBfiFQXC2Mh/xYNXsIOBQ4Lp8pJDaTY77fH52cr7LXVPBFFgDGvpxeg54JDKx9Nr7OJKm3XHewmqBrZT+z+jtXU5QFf3cB4yLjK3Ux2dnxnyMvQJOQ8bLTuNkbxMq9+6vhD+D2FcXepHKD0tNJK3kAWmiqikDORuYIKT//S1I+7gVfG5ky25LwC2/ARt5LVk3XjerD+Ved3hva/xNBCQ1l4sN0iY8J1nkOaxwCFl3S+X+9k+PNMRI9WGNwGHl5HNFXG4quPjzh/3+lsucSvPe9ArEmEwd1pxyRvl9PnEq8dvviJUJ+p4N8h6lcY8RkE7ElDtlC9rzTpv8rLnvRhjS429l/jH1r4pfiLkvzsTWB2e2QXl99hUvUjsTtRm1KZ2irU5fUyqpjklxn3f04rn8j0dk6+UrD+IE7pol3MG7/sr1CtVy/f0uXy39eThx4=
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Company benefits represent the benefits that a company is offering to employees. This ties together a particular supported benefit with the company-specific information for the offering of that benefit.
+
+Note that company benefits can be deactivated only when no employees are enrolled.
+
+Benefits containing PHI are only visible to applications with the `company_benefits:read:phi` scope.
+
+scope: `company_benefits:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-id-contractor-payment-contractor-payment.ParamsDetails.json b/docs/api/get-v-1-companies-company-id-contractor-payment-contractor-payment.ParamsDetails.json
new file mode 100644
index 000000000..fd9f3ec07
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-id-contractor-payment-contractor-payment.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"X-Gusto-API-Version","in":"header","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"},"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."},{"name":"company_id","in":"path","required":true,"description":"The UUID of the company","schema":{"type":"string"}},{"name":"contractor_payment_id","in":"path","required":true,"description":"The UUID of the contractor payment","schema":{"type":"string"}}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-id-contractor-payment-contractor-payment.RequestSchema.json b/docs/api/get-v-1-companies-company-id-contractor-payment-contractor-payment.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-id-contractor-payment-contractor-payment.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-id-contractor-payment-contractor-payment.StatusCodes.json b/docs/api/get-v-1-companies-company-id-contractor-payment-contractor-payment.StatusCodes.json
new file mode 100644
index 000000000..6df99c15f
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-id-contractor-payment-contractor-payment.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"successful","content":{"application/json":{"schema":{"description":"The representation of a single contractor payment.","type":"object","x-examples":{"success_status":{"uuid":"04552eb9-7829-4b18-ae96-6983552948df","contractor_uuid":"bc57832c-d8bc-43a7-ae99-3a03380ff037,","bonus":"20.0","date":"2020-10-19","hours":"40.0","payment_method":"Direct Deposit","reimbursement":"100.0","hourly_rate":"18.0","may_cancel":true,"status":"Funded","wage":"0.0","wage_type":"Hourly","wage_total":"740.00"}},"title":"Contractor Payment","properties":{"uuid":{"type":"string","description":"The unique identifier of the contractor payment in Gusto.","readOnly":true},"contractor_uuid":{"type":"string","description":"The UUID of the contractor.","readOnly":true},"bonus":{"type":"string","format":"float","description":"The bonus amount in the payment.","readOnly":true},"date":{"type":"string","description":"The payment date.","readOnly":true},"hours":{"type":"string","format":"float","description":"The number of hours worked for the payment.","readOnly":true},"payment_method":{"type":"string","description":"The payment method.","enum":["Direct Deposit","Check","Historical Payment","Correction Payment"],"readOnly":true},"reimbursement":{"type":"string","format":"float","description":"The reimbursement amount in the payment.","readOnly":true},"status":{"type":"string","description":"Contractor payment status","enum":["Funded","Unfunded"]},"hourly_rate":{"type":"string","format":"float","description":"The rate per hour worked for the payment.","readOnly":true},"may_cancel":{"type":"boolean","description":"Determine if the contractor payment can be cancelled.","readOnly":true},"wage":{"type":"string","format":"float","description":"The fixed wage of the payment, regardless of hours worked.","readOnly":true},"wage_type":{"type":"string","description":"The wage type for the payment.","enum":["Hourly","Fixed"],"readOnly":true},"wage_total":{"type":"string","format":"float","description":"(hours * hourly_rate) + wage + bonus","readOnly":true}},"x-tags":["Contractor Payments"],"required":["uuid"]}}}},"404":{"description":"Not Found\n\nThe requested resource does not exist. Make sure the provided ID/UUID is valid.\n","content":{"application/json":{"schema":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided ID/UUID is valid.","type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["error_key","category"],"properties":{"error_key":{"type":"string","description":"Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error."},"category":{"type":"string","description":"Specifies the type of error. The category provides error groupings and can be used to build custom error handling in your integration."},"message":{"type":"string","description":"Provides details about the error - generally this message can be surfaced to an end user."}}}}},"x-examples":{"not_found":{"errors":[{"error_key":"request","category":"not_found","message":"The requested resource was not found."}]}},"title":"Not-Found-Error-Object"}}}}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-id-contractor-payment-contractor-payment.api.mdx b/docs/api/get-v-1-companies-company-id-contractor-payment-contractor-payment.api.mdx
new file mode 100644
index 000000000..eaccc5316
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-id-contractor-payment-contractor-payment.api.mdx
@@ -0,0 +1,71 @@
+---
+id: get-v-1-companies-company-id-contractor-payment-contractor-payment
+title: "Get a single contractor payment"
+description: "Returns a single contractor payment."
+sidebar_label: "Get a single contractor payment"
+hide_title: true
+hide_table_of_contents: true
+api: eJzdWFtzGjkW/ita7cMkOy3A2I5tnjZlJxk/7MSVy+5WORQjWqdB426pows2RfV/3zpSNzTQ2LEzT/sEiHO/fOdIK2oh9Ua6JR3druilLkqulm/TFKx9692cjm7H1TihAmxqZOmkVnREP4HzRlnCiZVqlgNJtXKGp04bUvJlAcr1vqlvyqa6hBH5o+RLo/Pcjgxw8QdN6AObees0k8rBzHAUy9yyBDq6pVBMQQgQNKG8LNsklo4T6vjMItnlRuVNVBn+biQbe89ndOSMh4QasKVWFiwdrehwMMCPbY+sDy5nPqcJRW9AOaTiZZnLNGjv/2mRdEVtOoeC78v4MgdioDRgQbnAQnT2aIxoQqPXVE//hNSFyMADL8o82lqbNbGOOx9OvJeCjujg5PR0CNMLdnY+vGAn06NzxuHiDXtzcX58ejq8ODkXWe1J1DmpGafp6dn58TBl4nyaspNjfoaMF+yYD46PzwdZNjg+S2hCp1qhQjoc9AY0oYI7CL+GA3Y0YEcXNKFz7Q2SnESS2qlJAW6uUdWVNJA6cgWlthJ9MyCLqTcWihBdejSInCgoX05M1HF0Hg4LvpykXKWQN1lsgkDfexXr457PkCNKwR+TOpy/BYnrQ+14Tkf0DC0d0KpKqJMuR8L9KkJPjC7BOAmtiK+aTFlnpJrR3ZbA5Hslv3sgUoByMpNgMP9u3pV6IhX5gIXaC3Hh4qPKl9HRqiNtP6L969frq32FnfLr5O5LzbQpOKYmyzV3nWoCL+GF9tELVNeq5z1dsXJ+xIEmNMjRKaouuBeZrXwxjQkJUsi9NncgSKbNkx7sFvZzfIk8KBaULxC39rricg7pHU3ob9I6bWTK81YpXmqD5IglzeG4w8SdznpRhLZkPCPBG2x6PCyX+01Qs26Cs+7sryqLX8fVDj68zDfugJRgQvKfk/s2Cq01T7XOgas9TVfgwBRSAZEH+z7likyBRJk5iE6tEdde5GkmH0AQFNBgQa05IQZm3IgcrN1tg4NG1Hj6IxUfVCJZV1yb/K5x+T2a2VnKbcR+dgReRa/+QVol85r8Go37NWLXvq8Vjt0n9goD3700IJAkYPK4qpDxZHCyvwn8rh15r70SuATF3vruwToQxIDV3qRAhAZLlHYEHqR1PfIvfgfEegMxdkYvpABBrq/6AdilJQueS9H7pl6+oaztIt8UIX+5aR3rTDtsYIw2IZjbA7Y+32SbG8OxSKSDon1+WOrkDpAh5Q5m2iwP6AhUTxbz5xJSnN6W3M+h9jmwE52m3tge+bIsEabzJXFzackdLDcz3wZ67pyRU++gX3LDC8QFYiDnGGanNyJ7tGpZ/QzTUEJoNp3VkggmsxHVJMnWls+M9qVUM0u4Eg0GeRutmXqZC5LiNlLU9HOuRC7VDPF/iZDZ2sKDzQVYewCktk2+aQwR4LjMLeFT7V0rqIzMQIHZhLMW3Vhpvcl4Gi3lioASaDhGLjbg9sKstJtkWOHtwrrdyj+tK75dL6MWY8s5eqBB7nnsj8DQo9W4vVL+rh0LTcbeoVL2MVZtbS4WZQjjNa7IM3BsccTScO2SYOtvy4kUrLUE1kjaOmLlZlttKix6qniBVvyXhfWSvb25Zv8GYzEbCZWYkjlwAYYmLZjYzWGD18PB8JQN3rCjUxougRn3uYv3gOa8OjgFY5XiNsemHGvt7c01WURbCLdWpzI0xL1081hlSICN1SPXGVEaB6ld400SaVp494slt4VUsvBFW/b41dy50o76faFT2wv3wV6qi35zs2T1fTT83+elZDWnVLO/1wJZ6/g1moHdgqW/jvAmVU1gS+7mW+gU7y1PrepBzCPpqLaU7hbFz+vf3VEeNSVcsW0J/A64XTI0i+kFGCMFxIKm2xQBerYsX4/VhMKDA2XD1R5rN/bnwceBhC547p9+JMB4bYuKrwFr/rhqbIgO+bNmCH51c0T/NpQdfmLQ1rfiGKGQqhHtL4766+bvrzYlVfX3Mx0IOtJfYcLALBoE8AYvu00P8FLGFmACitAHHXtroXeyFuWx8GSAfMH5A4I7Zd4YLR6RWeLfGJfm+ekzVlzE8I5HqHUdovKmPsMqDtwELNu9awQRLIcF5IR7N8fxHFEDEevz0joofkZDlHBAQYUNmekgtZ4KAY0RpbBUajzewtGEImzaj9lnMAuZQivSGwQLw7MfCPsCVeM4YeE301mIMLLuGvsfyFNdAI7QYMcvlryrGwiXXMTCAKBCp75oHq/+Vu+ZPA17Zg1AV41W8gn3mdBwCYWCyzyUSv3vPzeVgdEotXUFVy05H8A99jS268Jqs/L+/OtjnWkHD65f5lyGkgjFvaob85YujoL7dWvShI628L6jOyNNFzyP8QprHYpdrXAUfjV5VeHxdw+4fdyOET+M5FOsldsVFdLid0FHGc/tLoa3g/HqU432r8nhydLpcLNsB4oGvWhSQ1zLW2z9v8igjjS/yLauKFfhqSDuNs+L4f/1xnIgwjGS3VviOuCbiYdQWbrWf3vXzq0h9+HdF5zM28i6RtL6CyapM9GrVaT4ou9AVdU67w5/h227+h+mJ6AL
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Returns a single contractor payment.
+
+scope: `payrolls:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-id-contractor-payment-groups.ParamsDetails.json b/docs/api/get-v-1-companies-company-id-contractor-payment-groups.ParamsDetails.json
new file mode 100644
index 000000000..a375630dd
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-id-contractor-payment-groups.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"company_id","in":"path","required":true,"description":"The UUID of the company","schema":{"type":"string"}},{"name":"start_date","in":"query","required":false,"description":"The time period for which to retrieve contractor payment groups. Defaults to 6 months ago.","example":"2020-01-01","schema":{"type":"string"}},{"name":"end_date","in":"query","required":false,"description":"The time period for which to retrieve contractor payment groups. Defaults to today's date.","example":"2020-12-31","schema":{"type":"string"}},{"name":"page","in":"query","required":false,"description":"The page that is requested. When unspecified, will load all objects unless endpoint forces pagination.","schema":{"type":"integer"}},{"name":"per","in":"query","required":false,"description":"Number of objects per page. For majority of endpoints will default to 25","schema":{"type":"integer"}},{"name":"X-Gusto-API-Version","in":"header","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"},"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."}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-id-contractor-payment-groups.RequestSchema.json b/docs/api/get-v-1-companies-company-id-contractor-payment-groups.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-id-contractor-payment-groups.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-id-contractor-payment-groups.StatusCodes.json b/docs/api/get-v-1-companies-company-id-contractor-payment-groups.StatusCodes.json
new file mode 100644
index 000000000..3b458fca3
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-id-contractor-payment-groups.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"List of Contractor Payment Groups","content":{"application/json":{"schema":{"type":"array","items":{"description":"Contractor payment group with submission and credit blockers, but without individual contractor payments.","type":"object","allOf":[{"description":"Base properties for contractor payment groups.","type":"object","properties":{"uuid":{"type":"string","description":"The unique identifier of the contractor payment group.","readOnly":true},"company_uuid":{"type":"string","description":"The UUID of the company.","readOnly":true},"check_date":{"type":"string","description":"The check date of the contractor payment group.","readOnly":true},"debit_date":{"type":"string","description":"The debit date of the contractor payment group.","readOnly":true},"status":{"type":"string","description":"The status of the contractor payment group. Will be `Funded` if all payments that should be funded (i.e. have `Direct Deposit` for payment method) are funded. A group can have status `Funded` while having associated payments that have status `Unfunded`, i.e. payment with `Check` payment method.","enum":["Unfunded","Funded"],"readOnly":true},"creation_token":{"type":["string","null"],"description":"Token used to make contractor payment group creation idempotent. Will error if attempting to create a group with a duplicate token.","readOnly":true}},"title":"Contractor-Payment-Group-Base"},{"type":"object","properties":{"partner_owned_disbursement":{"type":["boolean","null"],"description":"Whether the disbursement is partner owned.","readOnly":true},"submission_blockers":{"type":"array","description":"List of submission blockers for the contractor payment group.","readOnly":true,"items":{"type":"object","description":"A blocker that prevents payment submission.","properties":{"blocker_type":{"type":"string","description":"The type of blocker that's blocking the payment submission.","readOnly":true},"blocker_name":{"type":"string","description":"The name of the submission blocker.","readOnly":true},"unblock_options":{"type":"array","uniqueItems":true,"items":{"type":"object","properties":{"unblock_type":{"type":"string","description":"The type of unblock option for the submission blocker.","readOnly":true},"check_date":{"type":"string","description":"The payment check date associated with the unblock option.","readOnly":true},"metadata":{"type":"object","additionalProperties":true,"description":"Additional data associated with the unblock option.","readOnly":true}}},"description":"The available options to unblock a submission blocker.","readOnly":true},"selected_option":{"type":["string","null"],"description":"The unblock option that's been selected to resolve the submission blocker.","readOnly":false},"status":{"type":"string","description":"The status of the submission blocker.","enum":["unresolved","resolved"],"readOnly":true}},"title":"Payroll-Submission-Blocker-Type"}},"credit_blockers":{"type":"array","description":"List of credit blockers for the contractor payment group.","readOnly":true,"items":{"type":"object","description":"A blocker that prevents payment crediting.","properties":{"blocker_type":{"type":"string","description":"The type of blocker that's blocking the payment from being credited.","readOnly":true},"blocker_name":{"type":"string","description":"The name of the credit blocker.","readOnly":true},"unblock_options":{"type":"array","uniqueItems":true,"items":{"oneOf":[{"type":"object","description":"Unblock option to resolve a credit blocker by submitting a wire transfer","required":["unblock_type","check_date","metadata"],"properties":{"unblock_type":{"type":"string","enum":["submit_wire"],"description":"The type of unblock option for the credit blocker","readOnly":true},"check_date":{"type":"string","description":"The payment check date associated with the unblock option","readOnly":true},"metadata":{"type":"object","required":["wire_in_amount","wire_in_deadline","wire_in_request_uuid"],"properties":{"wire_in_amount":{"type":"string","description":"The amount to be wired in (decimal string)","readOnly":true},"wire_in_deadline":{"type":"string","format":"date-time","description":"Deadline for the wire transfer to be received","readOnly":true},"wire_in_request_uuid":{"type":"string","description":"UUID of the wire in request","readOnly":true}},"readOnly":true}},"title":"Payroll-Credit-Blocker-Unblock-Option-Submit-Wire"},{"type":"object","description":"Unblock option to resolve a credit blocker by submitting a bank screenshot","required":["unblock_type","check_date","metadata"],"properties":{"unblock_type":{"type":"string","enum":["submit_bank_screenshot"],"description":"The type of unblock option for the credit blocker","readOnly":true},"check_date":{"type":"string","description":"The payment check date associated with the unblock option","readOnly":true},"metadata":{"type":"object","required":["information_request_uuid"],"properties":{"information_request_uuid":{"type":"string","description":"UUID of the information request","readOnly":true},"bank_account_last_four_digits":{"type":["string","null"],"description":"Last 4 digits of the bank account number for the bank screenshot RFI","readOnly":true}},"readOnly":true}},"title":"Payroll-Credit-Blocker-Unblock-Option-Submit-Bank-Screenshot"},{"type":"object","description":"Unblock option to resolve a credit blocker by responding to high risk fraud RFI","required":["unblock_type","check_date","metadata"],"properties":{"unblock_type":{"type":"string","enum":["respond_to_high_risk_fraud_rfi"],"description":"The type of unblock option for the credit blocker","readOnly":true},"check_date":{"type":"string","description":"The payment check date associated with the unblock option","readOnly":true},"metadata":{"type":"object","required":["information_request_uuid"],"properties":{"information_request_uuid":{"type":"string","description":"UUID of the information request","readOnly":true}},"readOnly":true}},"title":"Payroll-Credit-Blocker-Unblock-Option-Respond-To-High-Risk-Fraud-Rfi"},{"type":"object","description":"Unblock option to resolve a credit blocker by waiting for reverse wire","required":["unblock_type","check_date","metadata"],"properties":{"unblock_type":{"type":"string","enum":["wait_for_reverse_wire"],"description":"The type of unblock option for the credit blocker","readOnly":true},"check_date":{"type":"string","description":"The payment check date associated with the unblock option","readOnly":true},"metadata":{"type":"object","properties":{"reverse_wire_detail_id":{"type":["integer","null"],"description":"ID of the reverse wire detail","readOnly":true},"bank_account_last_four_digits":{"type":["string","null"],"description":"Last 4 digits of the bank account number for the reverse wire","readOnly":true}},"readOnly":true}},"title":"Payroll-Credit-Blocker-Unblock-Option-Wait-For-Reverse-Wire"}],"discriminator":{"propertyName":"unblock_type","mapping":{"submit_wire":{"type":"object","description":"Unblock option to resolve a credit blocker by submitting a wire transfer","required":["unblock_type","check_date","metadata"],"properties":{"unblock_type":{"type":"string","enum":["submit_wire"],"description":"The type of unblock option for the credit blocker","readOnly":true},"check_date":{"type":"string","description":"The payment check date associated with the unblock option","readOnly":true},"metadata":{"type":"object","required":["wire_in_amount","wire_in_deadline","wire_in_request_uuid"],"properties":{"wire_in_amount":{"type":"string","description":"The amount to be wired in (decimal string)","readOnly":true},"wire_in_deadline":{"type":"string","format":"date-time","description":"Deadline for the wire transfer to be received","readOnly":true},"wire_in_request_uuid":{"type":"string","description":"UUID of the wire in request","readOnly":true}},"readOnly":true}},"title":"Payroll-Credit-Blocker-Unblock-Option-Submit-Wire"},"submit_bank_screenshot":{"type":"object","description":"Unblock option to resolve a credit blocker by submitting a bank screenshot","required":["unblock_type","check_date","metadata"],"properties":{"unblock_type":{"type":"string","enum":["submit_bank_screenshot"],"description":"The type of unblock option for the credit blocker","readOnly":true},"check_date":{"type":"string","description":"The payment check date associated with the unblock option","readOnly":true},"metadata":{"type":"object","required":["information_request_uuid"],"properties":{"information_request_uuid":{"type":"string","description":"UUID of the information request","readOnly":true},"bank_account_last_four_digits":{"type":["string","null"],"description":"Last 4 digits of the bank account number for the bank screenshot RFI","readOnly":true}},"readOnly":true}},"title":"Payroll-Credit-Blocker-Unblock-Option-Submit-Bank-Screenshot"},"respond_to_high_risk_fraud_rfi":{"type":"object","description":"Unblock option to resolve a credit blocker by responding to high risk fraud RFI","required":["unblock_type","check_date","metadata"],"properties":{"unblock_type":{"type":"string","enum":["respond_to_high_risk_fraud_rfi"],"description":"The type of unblock option for the credit blocker","readOnly":true},"check_date":{"type":"string","description":"The payment check date associated with the unblock option","readOnly":true},"metadata":{"type":"object","required":["information_request_uuid"],"properties":{"information_request_uuid":{"type":"string","description":"UUID of the information request","readOnly":true}},"readOnly":true}},"title":"Payroll-Credit-Blocker-Unblock-Option-Respond-To-High-Risk-Fraud-Rfi"},"wait_for_reverse_wire":{"type":"object","description":"Unblock option to resolve a credit blocker by waiting for reverse wire","required":["unblock_type","check_date","metadata"],"properties":{"unblock_type":{"type":"string","enum":["wait_for_reverse_wire"],"description":"The type of unblock option for the credit blocker","readOnly":true},"check_date":{"type":"string","description":"The payment check date associated with the unblock option","readOnly":true},"metadata":{"type":"object","properties":{"reverse_wire_detail_id":{"type":["integer","null"],"description":"ID of the reverse wire detail","readOnly":true},"bank_account_last_four_digits":{"type":["string","null"],"description":"Last 4 digits of the bank account number for the reverse wire","readOnly":true}},"readOnly":true}},"title":"Payroll-Credit-Blocker-Unblock-Option-Wait-For-Reverse-Wire"}}}},"description":"The available options to unblock a credit blocker.","readOnly":true},"selected_option":{"type":["string","null"],"description":"The unblock option that's been selected to resolve the credit blocker.","readOnly":false},"status":{"type":"string","description":"The status of the credit blocker","enum":["unresolved","pending_review","resolved","failed"]}},"title":"Payroll-Credit-Blocker-Type"}},"totals":{"type":"object","properties":{"amount":{"type":"string","description":"The total amount for the group of contractor payments.","readOnly":true},"debit_amount":{"type":"string","description":"The total debit amount for the group of contractor payments. Sum of wage & reimbursement amount.","readOnly":true},"wage_amount":{"type":"string","description":"The total wage amount for the group of contractor payments.","readOnly":true},"reimbursement_amount":{"type":"string","description":"The total reimbursement amount for the group of contractor payments.","readOnly":true},"check_amount":{"type":"string","description":"The total check amount for the group of contractor payments.","readOnly":true}},"readOnly":true}}}],"x-examples":{"success":[{"uuid":"94d9698e-9c95-45d6-b66e-d208258666ab","company_uuid":"5f5aaa38-f517-4f56-85e4-afdb83321663","check_date":"2025-09-22","debit_date":"2025-09-18","status":"Unfunded","creation_token":"94d9698e-9c95-45d6-b66e-d208258666ab","partner_owned_disbursement":false,"submission_blockers":[{"blocker_type":"fast_ach_threshold_exceeded","blocker_name":"Fast ACH Threshold Exceeded","selected_option":"wire_in","status":"resolved","unblock_options":[{"unblock_type":"wire_in","check_date":"2025-09-22","metadata":{"wire_in_deadline":"2025-09-22T18:00:00Z","wire_in_amount":"760000.0"}},{"unblock_type":"move_to_four_day","check_date":"2025-09-22","metadata":{"debit_date":"2025-09-16"}}]}],"credit_blockers":[{"blocker_type":"waiting_for_wire_in","blocker_name":"Waiting for Wire In","selected_option":"submit_wire","status":"unresolved","unblock_options":[{"unblock_type":"submit_wire","check_date":"2025-09-22","metadata":{"wire_in_deadline":"2025-09-22T18:00:00Z","wire_in_amount":"760000.0","wire_in_request_uuid":"96ea4784-979a-45aa-9ccb-83be86b6dcea"}}]}],"totals":{"amount":"760000.00","debit_amount":"760000.00","wage_amount":"10000.00","reimbursement_amount":"750000.00","check_amount":"0.00"}}]},"x-tags":["Contractor Payment Groups"],"title":"Contractor-Payment-Group-With-Blockers"}}}}},"404":{"description":"Not Found\n\nThe requested company does not exist. Make sure the provided UUID is valid.\n","content":{"application/json":{"schema":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided ID/UUID is valid.","type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["error_key","category"],"properties":{"error_key":{"type":"string","description":"Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error."},"category":{"type":"string","description":"Specifies the type of error. The category provides error groupings and can be used to build custom error handling in your integration."},"message":{"type":"string","description":"Provides details about the error - generally this message can be surfaced to an end user."}}}}},"x-examples":{"not_found":{"errors":[{"error_key":"request","category":"not_found","message":"The requested resource was not found."}]}},"title":"Not-Found-Error-Object"}}}}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-id-contractor-payment-groups.api.mdx b/docs/api/get-v-1-companies-company-id-contractor-payment-groups.api.mdx
new file mode 100644
index 000000000..c2c42b2f1
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-id-contractor-payment-groups.api.mdx
@@ -0,0 +1,71 @@
+---
+id: get-v-1-companies-company-id-contractor-payment-groups
+title: "Get contractor payment groups for a company"
+description: "Returns a list of minimal contractor payment groups within a given time period, including totals but not associated contractor payments."
+sidebar_label: "Get contractor payment groups for a company"
+hide_title: true
+hide_table_of_contents: true
+api: eJztXG1v2zgS/is8HnDdApbjpImb5NNlm7YbYK8t0vR6uLRQaHFscSORWpJyagT+74ch9WrLiZ2mafeaT20scubhvJPi6JqqDDSzQskTTg/pBGww3Q4ilWZMCjDF/2ah4EGkpNUsskqHGZulIG040SrPDO1RDibSIkM69JCegs21NISRRBhL1JikQoqUJaSmQQoaxNMgV8LGQhJGJmIKkliRAslAC8V7RMgoybmQE2KVZYkho9wSqSxhxqhIMAu8g7Lpf5KfpIlUBofkImMzrZLEHGpg/IL2qGUTQw/P6Yt64rsC0mu/rM89+iWY5MaqQEgLEy+nwM4ywImQjoBz4DguY5qlYEEjyWsqWQr0kNbCoz0qUDIZszHtUQ1/5kIDp4dW57AovrMYyIcPJ8coOBsDKcjQHjVRDCmjh9fUg6DGaiEndD7vVUyNZdqGnFkomf6Zg561uI5ZYjrZNsROxkqTq1hEMbGKaLBawBRWa7BPjmHM8sQaHD8kqZI2NoRNVJ/2KHxhaZYgvp3BziAYbAeD7TUXBJJ/9+VYxdnsiSGIo2M52zvBs3WXk7HJXZaC04iNmSXCEBwPxgLvk48xSJJLk0EkxgJ4j1yJJCGJYpywJCFq9AdE1pBcJmAMAckzJaRFcURgkKyQzq77Xfid3YNuLwD0hvjf5OkINJpziSYD7VbUJ6+UJin7Q2lhZziiBGj8OrhXAupgZ29dhP8JXjuvPXp3EvwbtEEUBeIYGHf4V6mqR0HmKfr3zmBnLxgMg+099PACiNd4+ft8caXHGANSIcE4z0VzCUbMACdH707I1GNphi0Me2Smcu0GRCxJ+uRkTKSSgIrOtJoKjlp1Y1iWJSJy6npiyLmLqnnapP35l9jazBxubXEVmb6LXv1IpVtltAqKQOieb7FMBMVMISd/LwgGjZ+fIozcAO/T+eceNRDlqCoX5l74wHQURWDMUW5jenj+ed4Im9pcsUkZ5DSYTEkDBoW+MxjgP23p/V5ki9UhuUfRYUFanNyQxtYfBilcL6uVac3QRIWF1CyzfLHC/71iTD5KhfE6k5xEGriwZJSo6BK06bk8hANVbomQXEwFzzuznEHvKhB5H6A9ypLk7dgJso3pV2YANZ+BtgKMi1yr41QH4XouLjjPBe+y8+UYk0vxZw5EcJAWg4muM1A3977zfcbfymTm1TzvVVlvfb4dya6bcgzRpc8Fa9F1450T3mkhHEbCbsDOjb87O2OZzc16rPzYW9kQ8hGD6AjIxatccuAXRIxdWijt0qcUE6s84Thu7IaRX0Qf+iRmUyAXx0JDZMkxZMoIe+HMsWSTgo0Vf0qYLqf2CTkqXChi0pMo0FYYrmKRAD7Ckq4RDNugWlM/SE/+okcctBKAc9OLF6joiwVU/UYsL6fTHvUgMKQv25cGF01Cqy5B1po4r1Uh8yTx6aClEhzvoiQmqpRdrtYJKZmgm6WZwmBW6gm0VtppyFpIM+srXj8DsDSuIxMjPPfRD4hD22FS8x61wroqpQ5zQRFRAxdRA4w1FFPnzTEkY9pK0KG6ksBDLswo1wbSIhCXUhoplQCTK8X0MQYbg/apsUHDZTrPgTgO3f5RBeOwjMAdcb47ozQCeTnX2fFmTtrIIoviarM9Krl4S840TJ1dl/RrOP0lURczQ89hnWCAI3CRTZ5PjP/TmZArH7s4L8m4ZO4LqXWY48gyDi1LuZNJLt3TUDk6XUr0iejEC/sWyS8ku4L25tIrZhKPqrKONde0aWoq9dFIUYtVoXUZuQmqk3MKlnFmWZdsGOcCJ7LkXUNKXXvOo2okgmF3AzNfqodxqWzKRMJGCRQT3YaqpMXWFbCBBCILvLCaTYLzEvTKQwAkKQn7baFRyRTWUrzb6XxV2u7mUKasXBZouGNb/Hc5bTWi/Dtf2gfvK8LBr55wcIbY5j7HcWE3j6ALte/3jJ4eipCThw6eY61SMgL82WNYkam+Loq2Jf0NIqiSUOw7btbDhwWnqf2DLYAko5m3ZutqFkauhAZiNZNm7Hbb9QHBeTtEtyJnI5h93jSwl27jYYQIoDsU3BLv2wv7bqF+00jfFDCuPRQyZKnKJT4sf+DAeCIkNH4qTpL8Zm1J6AuU1lquH4vWMgJnB5wISX7hELkTYD/zadf6lmB28BsrnTI8hXFHK3i+twTiuJheqbRljAUwDRGIMrauwNGSza1rb25iHUchy3O6ztL89jD+wpliFcILdwzeOo4+yNvgIxp6VwF/b748YvKSmEgDSBOrRWN7EG9GCGEDwk/q2EJ688ct0M2Ou3LkRmbcoLLalHvUaYdFEfp9mDBjw7HKdcjFRFizQaH2OzOW7BI/r8TgrK8gTqQ/SC5VumCZ5PTVybd0tV+ZvAze11Z4317nD0iL91wkFpOYaGEuyViznFeLeyjXK9CEVoUIJUQooYMS6rF4dMEfyAXvwcRPvbaDMxX8JiZxcCrMZfAKtR2cjsW9m/oVcwW8swws77XxSfNBLRxBhGOlwwLBT1c0tsXWlELIwTKRhE1zPa/eta0K4LXZNnVKPK0fKnMs2dx9+9NHJmzwSung1HMq6jRELhB5im9dlXZnq14Lszf+5eWCzacsy3Dp+G6rsbW5dRP9uHn76/jh4+bt5968rdrmfEsnf9zV/Sge/0OWlD/zru62rc89u+Xjtu/RR3/Ybd+KTdI9u8DjdvBHMPjH7eBDbwfv9sZ8jReED/62/CZMX/+mfMmhOl+SZ+CyKPqvgKvmW/MeHTOR4OvzNVRXvSr3zQa3e8omGyxHs9xmlebn73XhS/bui6MrbiZuztffUNyEO3mfp/jsCq+f/4NoEGl9bcsT6kSI4+8A0LH5Wum0QN4BRNci747Gh/rNUfhQ/3XcOyKXv55d9C8Yf6zk7m+7CwG+UqEHu/xgeLAPwUF0sBfs7vFhMBoOIeA7g/2dvf3hcMhGdPGmL90b7zHGnu0H473t58HueG8Y7O/BbsDGfLT/7NnO9nD4rJ22y8v0B8HODm1fuK2ebO/TOnQ0L3Iu3tZcF/VNdxmL9oXOq4bni9dL6BhTFIvi0MYaTKwSHsKXCMDja98Coa8wKR29+I2clYPJy3rwUsAuDzKai2/Es6UbIOeLhU6DwGqJN8uB5ROcxtiz7f3DweBwMPhv4/ypNGr6fDgYDAb9ge/CWMCRqingdsLncnc7ZT1A3eYwpPO5azJYusm0rKCirnRVXS2OBcV8bBSfmJbJiexUSPNwsqGUVgpaQy1tMg+nmlVHY/RgCGz3+f5ucPD8gAW7e4wFB1E0CvafjWB/OBryCFgp8zolLjEY0MW81HrUSgh0u37QHa3p8716SDuEUvcrAsJItlYb363XoD8KG5cFgHF12bxHdwe7yw0jb5Qlr1QuOTYXnrnasejFKlsXCFdgXHsifBHG9sm/8D64ybWvlMqWHt/1IAyZskTw/ie5SXPLCkzkkyRkERaaZ64jWBfXyfFWG1pHh0lzV+ZurZvlfVfx+w2tOLdSDS/BhQtmYaL0bAUPN+rWzPq+6JAz5CqGYs3+wr2KolybPjmbZQI7sGbExsKQS5jVrTC+n4tZq8Uot7BVNXwSDQkrCuKKZB93zhXqDaDZxubSUyKukaUgVSrJFMhdOSDkxPj2JCbxdLxsQxjlIuEkwkastBgfM4nxY4LH266hrNHX6jCnYAz2J94K+V0JxO/mDGEjbIKqhRqQCUjQtTgL0iVKk+sxizxSJrHtD4Gj5LzztWsUqdxeUPKmYZ239E/rc5Ja8o2JjcXRFQ5yxbx/uAnY79bcLbxRuIPLJQ9eItPgrbfaCq7JgF0CM7MA80qgpqC14OCbqvEWLW2PcrpzTcJlTCpCUtXqBl8sSFPlEb/KlR3JPTplSb7QmYzpuD3Pt+RVg32RWg9atYpqQrWa7ll+VfXoVavDZOLbdDxJV5dhAyHdmm5vVf3nW9d1D/V866YOdAN6WlYBuU6w1bNohGSZ8H2QAYfUNUN2vHVK1YJ6PL3AZUic59a7gnAnzXda8RtoZvi42VH5HoO7t/aOvsrKH5F52b6Kf4+AabclXuxrdCSCBKaQEJbbGAOZzyfo6O9nxkL6NRw8hRUM5j13EOqoFv7jWnKxVRWto2jKbTXT9ij2zpq34/egpyKChqTrNlYXZrbcwC2OrDEbBO7vQI2dhHHqUucRJJFKcWtFHI4nhrwsnIQUxwCui5arKEe7csv4W5GRWeQyclEuHpdcySlGfueePQopnmmhqRRP/1lbBkojU8amTDbovAZ7w+cQsBhljc7/1nKu60LhL/KtBW9ZFr7YrSxhwpmgc6brwu3P6XS72lFicu/Rw9bnE1b7/ucejZWxSOP6GputP+hkPseffXu6a7AVBs/TVjSoN+X5Tb+C0CkHH0Rbn20oo6cLOt8J++InD27A3vhCw1cgf5AvHNywiuLDDHdcwT1+4+AmjC4Q1xA/4x9aIMYN7fyX06LYfkpWf2+kE0lZzbsRFZQSYcNp3Q6t+ODCZuD+rz+jcKOCuz9d0bJJPxBTd2Ybz5Y2jK0S6/XLM+wHbGf6KrMX/2m0BLW1e33tR7g+5/m8UrY/ecM6ef4/jBqdog==
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Returns a list of minimal contractor payment groups within a given time period, including totals but not associated contractor payments.
+
+scope: `payrolls:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-id-contractor-payments.ParamsDetails.json b/docs/api/get-v-1-companies-company-id-contractor-payments.ParamsDetails.json
new file mode 100644
index 000000000..ff042fb21
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-id-contractor-payments.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"X-Gusto-API-Version","in":"header","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"},"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."},{"name":"company_id","in":"path","required":true,"description":"The UUID of the company","schema":{"type":"string"}},{"example":"2020-01-01","schema":{"type":"string"},"in":"query","name":"start_date","description":"The time period for which to retrieve contractor payments","required":true},{"example":"2020-12-31","schema":{"type":"string"},"in":"query","name":"end_date","description":"The time period for which to retrieve contractor payments. If left empty, defaults to today's date.","required":true},{"required":false,"schema":{"type":"string"},"in":"query","name":"contractor_uuid","description":"The UUID of the contractor. When specified, will load all payments for that contractor."},{"required":false,"schema":{"type":"boolean"},"in":"query","name":"group_by_date","description":"Display contractor payments results group by check date if set to true."},{"name":"page","in":"query","required":false,"description":"The page that is requested. When unspecified, will load all objects unless endpoint forces pagination.","schema":{"type":"integer"}},{"name":"per","in":"query","required":false,"description":"Number of objects per page. For majority of endpoints will default to 25","schema":{"type":"integer"}}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-id-contractor-payments.RequestSchema.json b/docs/api/get-v-1-companies-company-id-contractor-payments.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-id-contractor-payments.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-id-contractor-payments.StatusCodes.json b/docs/api/get-v-1-companies-company-id-contractor-payments.StatusCodes.json
new file mode 100644
index 000000000..d33b1b716
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-id-contractor-payments.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"A JSON object containing contractor payments information","content":{"application/json":{"schema":{"anyOf":[{"description":"The representation of the summary of contractor payments for a given company in a given time period.","type":"object","x-examples":{"success_status":{"total":{"reimbursements":"110.0","wages":"1840.0"},"contractor_payments":[{"contractor_uuid":"bc57832c-d8bc-43a7-ae99-3a03380ff037","reimbursement_total":"110.0","wage_total":"1840.0","payments":[{"uuid":"04552eb9-7829-4b18-ae96-6983552948df","contractor_uuid":"bc57832c-d8bc-43a7-ae99-3a03380ff037","bonus":"20.0","date":"2020-10-19","hours":"40.0","payment_method":"Direct Deposit","reimbursement":"100.0","hourly_rate":"18.0","may_cancel":true,"wage":"0.0","wage_type":"Hourly","wage_total":"740.00"},{"uuid":"25cfeb96-17fc-4fdf-8941-57f3fb9eea00","contractor_uuid":"bc57832c-d8bc-43a7-ae99-3a03380ff037","bonus":"100.0","date":"2020-10-19","hours":"0.00","payment_method":"Direct Deposit","reimbursement":"10.0","hourly_rate":"0.0","may_cancel":true,"wage":"1000.0","wage_type":"Fixed","wage_total":"1100.0"}]}]}},"properties":{"total":{"type":"object","description":"The wage and reimbursement totals for all contractor payments within a given time period.","properties":{"reimbursements":{"type":"string","format":"float","description":"The total reimbursements for contractor payments within a given time period.","readOnly":true},"wages":{"type":"string","format":"float","description":"The total wages for contractor payments within a given time period.","readOnly":true}},"readOnly":true},"contractor_payments":{"type":"array","uniqueItems":false,"description":"The individual contractor payments, within a given time period, grouped by contractor.","items":{"type":"object","description":"","properties":{"contractor_uuid":{"type":"number","description":"The UUID of the contractor.","readOnly":true},"reimbursement_total":{"type":"string","format":"float","description":"The total reimbursements for the contractor within a given time period.","readOnly":true},"wage_total":{"type":"string","format":"float","description":"The total wages for the contractor within a given time period.","readOnly":true},"payments":{"type":"array","uniqueItems":false,"description":"The contractor's payments within a given time period.","items":{"description":"The representation of a single contractor payment.","type":"object","x-examples":{"success_status":{"uuid":"04552eb9-7829-4b18-ae96-6983552948df","contractor_uuid":"bc57832c-d8bc-43a7-ae99-3a03380ff037,","bonus":"20.0","date":"2020-10-19","hours":"40.0","payment_method":"Direct Deposit","reimbursement":"100.0","hourly_rate":"18.0","may_cancel":true,"status":"Funded","wage":"0.0","wage_type":"Hourly","wage_total":"740.00"}},"title":"Contractor Payment","properties":{"uuid":{"type":"string","description":"The unique identifier of the contractor payment in Gusto.","readOnly":true},"contractor_uuid":{"type":"string","description":"The UUID of the contractor.","readOnly":true},"bonus":{"type":"string","format":"float","description":"The bonus amount in the payment.","readOnly":true},"date":{"type":"string","description":"The payment date.","readOnly":true},"hours":{"type":"string","format":"float","description":"The number of hours worked for the payment.","readOnly":true},"payment_method":{"type":"string","description":"The payment method.","enum":["Direct Deposit","Check","Historical Payment","Correction Payment"],"readOnly":true},"reimbursement":{"type":"string","format":"float","description":"The reimbursement amount in the payment.","readOnly":true},"status":{"type":"string","description":"Contractor payment status","enum":["Funded","Unfunded"]},"hourly_rate":{"type":"string","format":"float","description":"The rate per hour worked for the payment.","readOnly":true},"may_cancel":{"type":"boolean","description":"Determine if the contractor payment can be cancelled.","readOnly":true},"wage":{"type":"string","format":"float","description":"The fixed wage of the payment, regardless of hours worked.","readOnly":true},"wage_type":{"type":"string","description":"The wage type for the payment.","enum":["Hourly","Fixed"],"readOnly":true},"wage_total":{"type":"string","format":"float","description":"(hours * hourly_rate) + wage + bonus","readOnly":true}},"x-tags":["Contractor Payments"],"required":["uuid"]},"readOnly":true}}},"readOnly":true}},"x-tags":["Contractor Payments"],"title":"Contractor-Payment-Summary"},{"description":"The representation of the summary of contractor payments for a given company in a given time period.","type":"object","x-examples":{"success_status":{"total":{"reimbursements":"110.0","wages":"1840.0"},"contractor_payments":[{"check_date":"2020-10-19","reimbursement_total":"110.0","wage_total":"1840.0","payments":[{"uuid":"04552eb9-7829-4b18-ae96-6983552948df","contractor_uuid":"bc57832c-d8bc-43a7-ae99-3a03380ff037","bonus":"20.0","date":"2020-10-19","hours":"40.0","payment_method":"Direct Deposit","reimbursement":"100.0","hourly_rate":"18.0","wage":"0.0","wage_type":"Hourly","wage_total":"740.00"},{"uuid":"25cfeb96-17fc-4fdf-8941-57f3fb9eea00","contractor_uuid":"bc57832c-d8bc-43a7-ae99-3a03380ff037","bonus":"100.0","date":"2020-10-19","hours":"0.00","payment_method":"Direct Deposit","reimbursement":"10.0","hourly_rate":"0.0","wage":"1000.0","wage_type":"Fixed","wage_total":"1100.0"}]}]}},"properties":{"total":{"type":"object","description":"The wage and reimbursement totals for all contractor payments within a given time period.","properties":{"reimbursements":{"type":"string","format":"float","description":"The total reimbursements for contractor payments within a given time period.","readOnly":true},"wages":{"type":"string","format":"float","description":"The total wages for contractor payments within a given time period.","readOnly":true}},"readOnly":true},"contractor_payments":{"type":"array","uniqueItems":false,"description":"The individual contractor payments, within a given time period, grouped by check date.","items":{"type":"object","description":"","properties":{"contractor_uuid":{"type":"string","description":"The UUID of the contractor.","readOnly":true},"check_date":{"type":"string","description":"The payment check date.","readOnly":true},"reimbursement_total":{"type":"string","format":"float","description":"The total reimbursements for the contractor within a given time period.","readOnly":true},"wage_total":{"type":"string","format":"float","description":"The total wages for the contractor within a given time period.","readOnly":true},"payments":{"type":"array","uniqueItems":false,"description":"The contractor's payments within a given time period.","items":{"description":"The representation of a single contractor payment.","type":"object","x-examples":{"success_status":{"uuid":"04552eb9-7829-4b18-ae96-6983552948df","contractor_uuid":"bc57832c-d8bc-43a7-ae99-3a03380ff037,","bonus":"20.0","date":"2020-10-19","hours":"40.0","payment_method":"Direct Deposit","reimbursement":"100.0","hourly_rate":"18.0","may_cancel":true,"status":"Funded","wage":"0.0","wage_type":"Hourly","wage_total":"740.00"}},"title":"Contractor Payment","properties":{"uuid":{"type":"string","description":"The unique identifier of the contractor payment in Gusto.","readOnly":true},"contractor_uuid":{"type":"string","description":"The UUID of the contractor.","readOnly":true},"bonus":{"type":"string","format":"float","description":"The bonus amount in the payment.","readOnly":true},"date":{"type":"string","description":"The payment date.","readOnly":true},"hours":{"type":"string","format":"float","description":"The number of hours worked for the payment.","readOnly":true},"payment_method":{"type":"string","description":"The payment method.","enum":["Direct Deposit","Check","Historical Payment","Correction Payment"],"readOnly":true},"reimbursement":{"type":"string","format":"float","description":"The reimbursement amount in the payment.","readOnly":true},"status":{"type":"string","description":"Contractor payment status","enum":["Funded","Unfunded"]},"hourly_rate":{"type":"string","format":"float","description":"The rate per hour worked for the payment.","readOnly":true},"may_cancel":{"type":"boolean","description":"Determine if the contractor payment can be cancelled.","readOnly":true},"wage":{"type":"string","format":"float","description":"The fixed wage of the payment, regardless of hours worked.","readOnly":true},"wage_type":{"type":"string","description":"The wage type for the payment.","enum":["Hourly","Fixed"],"readOnly":true},"wage_total":{"type":"string","format":"float","description":"(hours * hourly_rate) + wage + bonus","readOnly":true}},"x-tags":["Contractor Payments"],"required":["uuid"]},"readOnly":true}},"readOnly":true},"readOnly":true}},"x-tags":["Contractor Payments"],"title":"Contractor-Payment-Summary-By-Dates"}]}}}},"404":{"description":"Not Found\n\nThe requested resource does not exist. Make sure the provided ID/UUID is valid.\n","content":{"application/json":{"schema":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided ID/UUID is valid.","type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["error_key","category"],"properties":{"error_key":{"type":"string","description":"Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error."},"category":{"type":"string","description":"Specifies the type of error. The category provides error groupings and can be used to build custom error handling in your integration."},"message":{"type":"string","description":"Provides details about the error - generally this message can be surfaced to an end user."}}}}},"x-examples":{"not_found":{"errors":[{"error_key":"request","category":"not_found","message":"The requested resource was not found."}]}},"title":"Not-Found-Error-Object"}}}}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-id-contractor-payments.api.mdx b/docs/api/get-v-1-companies-company-id-contractor-payments.api.mdx
new file mode 100644
index 000000000..c67d8ecbd
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-id-contractor-payments.api.mdx
@@ -0,0 +1,71 @@
+---
+id: get-v-1-companies-company-id-contractor-payments
+title: "Get contractor payments for a company"
+description: "Returns an object containing individual contractor payments, within a given time period, including totals."
+sidebar_label: "Get contractor payments for a company"
+hide_title: true
+hide_table_of_contents: true
+api: eJztW21z27gR/iso+iG5Hqk327GtT03jJOfONPHESa8zjscHkUsJMQkwAChb49F/7ywAUqREybbsy9y1+mSJBBbPLvblwQq+oxqiQnEzo8OLO/pGZjkTs9dRBFq/LsyEDi8u55cBvQ3HhTYy5MLAWDHDpQjNLAc6vKCQjSCOIaYBZXleH6LpZUANG2sc9kYKo1hkpCJnbJaBMPZ1KVnpGzamQ6MKCKgCnUuhQdPhHR30evgnBh0pnqNcOqSvyT/PP34gcvQNIkMiKQzjgoux/eiXyf0yhItEqsxCogHFESAMymR5nvLIvuh+0yj4jupoAhmzb8XsY2Lt0lz78wSIglyBBmHsZCITYiZAdJFlTM3waxuORCrCyJhPQZDImZpwUT0yPAOSg+Iy7tCAOvtSpyJFS8Ety/LUWUUXdpOutGGmsE+MNCzFDwp4NiqUBmfkIe33e50eDegNG4P9frSPD+bOFg7lVYnSKlx7XhQ8pkM6ig4Oj/YGURgfjaJwf48dhgyOj8M91tvbO+olSW/vkAbNta88pAaAxUOHIqCNlf1yvf2DgwGMjsPDo8FxuD/qH+Fyr8JXx0d7BweD4/2jOKHB9jhHUqDV6MBBiJkB+23QC/u9sH9MAzqRhcIhTZRXGZiJxJVOuELfO4Fcam6WdUcFe24mCkpnV8qt0T+yDzM2u4qYiCAtnR6Ng5rXLOU84Bc7f9l8h4gLN7Gy2eAgSmB0/CrsHyZRuJ/ESXh0vN8PDw6TvWR0DMB6veewWanXJqNZbNsZrcVmvc0m6/d6q1Z7x29tTmr6nMM+v5xfzucBzZXMQRkOzQBajrzV8EehhImYNOATK8HHeZq25oAbbibrY74JaDmQK2TaKC7GNKAur9EhTVLJ2qFaTE2cDuHj0Slg8UeRzpz551VCeQIuK+F54MxbALbmtwouU4phXBWCfy/g1ECm6TBhqYY2wFzEfMrjgrVubLABbEDGShY5xGQ0q81FHbhb9D6fW3GNlSCuJIgiG4FqNfmXL6cnZalqwlgxXGsef17/a6LYxvWeAdfC/54G58netVj6hX5oAFTO8xB+wojmYpxCi/NuwzZ+RJ0O/piFujQCfVeIuKoxW5TueUANNykOXGXHKyG/FOeVr69uvvM4wmMQhicc1GrQl1uP/PM9EvBWr16fZTas/ogs4zd3q/i1cwnLZOG0wOVq/ryylvOchyhQmgZntIryDrcVbJee0T5WCrmR6hriKgNt0mDZsR+ji5uDYkEUGZ7HVqLizQSiaxrQX7g2UvGIpTVXfCMVDsdcUj68vK9sbGmhJqV6+AbXTkIbzfJmNQj81IVxqsj+IhL38XK+lB+2040Zm8Dt5j9m7+tZqFp5JGUKTKysdAIGVMYFEL427iMmyAiIk5nC+iK7paYJ0m/Hk30u8CsHRMGYqTgFrZfDYEOltwge4vF2SRzWZtdyf6u87E4Jba78JILx0mn1N1JzmZ/Izw7czy53tTLY2/CefomC7wVXEOMQm5MvV3lvCxV+iOjVWhT61+G5a2zY0+b/XzMEE+NVG/PYdTseSKJ2vY17ehu7Tsauk/Gn62RgXqxY8vN3Mp7njFHP3o9hzE3tdg2SXYNk1yDZNUh2DZJdg2TXINk1SHYNkj91g6Q1Mn+Hhkn4j1l4wgxoPKjZvsx+b3+VkHyQhryThYi/iq/Chfj3ArQBPJZpWagISCxBEyENgVuuTYf8i11jj0WB20IlpzyGmJyedG194ZpMWcrjztdH3XlZg4t8FYQ8O7QWVlXfPVBKKmvoZp33z1eJ5NojyIrUq2vACREzMJZqtmYNO+remDrPIUISocnNBLzOdjqRUVQo3SGfZzlWi3RGzIRrcg2zBfXQdjwzRvFRYaCbM8UyTE9EQcrQzEYuRHZsn6pE/QhoKMHGvEy8JGJJtRdVbpL2yO0pj4uxtq0BnwoL7dCMCp7GJEJSlPnxEybiFK9fcUFmmLlrt8As5gy0XpMrm5DPSiAxGMZTTdhIFqZm1JCMQYBamNOLLlHqQiUsckiZICBiBI6WcwHY5O1CmqsEPbzuWBeN/afe4+v+MqxNrClH1wTIDXPxYSd0qGvZlNnjgzShDbLwLS4afnRe6+GiU1ozniJTH4MJp/3Q9Us5aP9pdsXjsK1DsGzdT2AKJXBXW67OPaUtwEWUFjFKcZ2jDmYyHckchuS3nM2UTFM9xBz7mz2BeCd3xhYsQ0P8J7REO3x9dhr+G5R21/U44p4Ai+2lhkWmWnajsnINeoODsPcq7B9gVMeQsCI17kRUPp+v5QMuUJDXhiOG7v767JRMHRbCtJYRtzGJpnCOjgMwtjvkNCFCIqXQVcoL3Jhayn2hyUXGBc+KrC778uXEmFwPu91YRrpjr0R2Ipl1y8uVobehfd9lOQ/9TC7Gf/UCw9rjnxAGBmzHdlG9hRfeUho2Z2bSSJDuBHffocWK2bAdc1zUx1l5Gu31w15/0xwP6XsBCmV7zNowZVz/prVLsfBCy2duJjyaYOwrMIrDtI3b6RWNW+D2B+HeFnBBxM8M1npWCokhkOVmFhDv09pWBhmz2QtdO4otq7V44lsrj1Ro+Yj7iBMt+XUCgmhfhGLMIGlKUsli21Ru/BRkJsw0TsMPw14y/DXgbR27Gs3at+SE6zxls9aGrQJtbWwlNLudeGjQYKz5VQGNCMuxDixhWdGi7RSKnBxNwPWigHgDFmKtCV0S16QQ9rQAIs4lF1hoVATYJhtz4Ytwi/FskQblorVUwKbZx+D/UB3YSzR4fkONOuSdVCRj3yTeMLfUwwPUTg/vyWjJwcFmhPaquM6BXQPTs9BuS8M7zxaxXR+IaoVyCkrxGCWm3FZyuDUgtL2jjhXIFfq1t9wDOmVpcf9td7RjU5S71l7NL4OyHLSsUDWwTbH2iU0FFwKsomi2qs03Btszw4w/pN1pv1vRiO7dojLMu+1EQoOalgW7UNilK0sWy7mrWGEMmS1bLQfuTC5tjJMX2l4nznO/9rULbpV5pmS8QWaOr1H/8j8cztG5HOtr+T+HyuVw8dIVbYYBplruU3oRYQpTSAkrzAQJvSvymI3OZ9pA9pQVnIQ1C9h8l0gr1fNIS56QVKATePrUoD0BRZajPybnoKY8gpqlF4TD0u2uHdiNcWkkoKH9HsrEWhinLoP9FdJIZvijgeuWvtDkrY8UPDIjdbF8J5ZRkZVd97/4kymL7MnUZ6CTclXyCU9ANrICChnjqXUV//bvC8+wP4BKbTImanLeg9lw8WDBYRqK3C2Oyn8Usuy9xsCt6eYp49a9bKDc+WC+oNO+NaUPZxrQYYPqtUX0JbbrtMHZd3dIdr+odD7Hxy7v2/974ZqN0nWZv26rl598kfiJPIWVterqcl6DB5ZJzl1I+aEoH0XHNuhTI4pbavN7Ma+NsFfp4Jbon4t8bUS7zP+eYOkfQtE2qOKZ5ZYaPCNJ24TRlrEFxEv8ojhifFo+aT99tiIpe4J2RAVl4b5VWpzbXyxcY+Fx4P6n2wUbN7i9RdPwSTcQiU9uau9W2s4Navr+7Wck1E2eVPEi/wE3qXV37+7ciM/yGsR8Xm22we+u8/5fDwdO3A==
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Returns an object containing individual contractor payments, within a given time period, including totals.
+
+scope: `payrolls:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-id-contractors-payment-details.ParamsDetails.json b/docs/api/get-v-1-companies-company-id-contractors-payment-details.ParamsDetails.json
new file mode 100644
index 000000000..6464dcfa0
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-id-contractors-payment-details.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"company_id","in":"path","description":"The UUID of the company. This identifies the company whose contractor payment details you want to retrieve.","required":true,"schema":{"type":"string"}},{"name":"contractor_uuid","in":"query","required":false,"description":"Optional filter to get payment details for a specific contractor. When provided, the response will only include payment details for this contractor.","schema":{"type":"string"}},{"name":"contractor_payment_group_uuid","in":"query","required":false,"description":"Optional filter to get payment details for contractors in a specific payment group. When provided, the response will only include payment details for contractors in this group.","schema":{"type":"string"}},{"name":"X-Gusto-API-Version","in":"header","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"},"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."}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-id-contractors-payment-details.RequestSchema.json b/docs/api/get-v-1-companies-company-id-contractors-payment-details.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-id-contractors-payment-details.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-id-contractors-payment-details.StatusCodes.json b/docs/api/get-v-1-companies-company-id-contractors-payment-details.StatusCodes.json
new file mode 100644
index 000000000..7c12c3dac
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-id-contractors-payment-details.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"successful","content":{"application/json":{"schema":{"type":"array","x-examples":{"success_status":[{"contractor_uuid":"e3d9487a-4ecb-49a3-b6ff-cf03ba7278b6","first_name":"Yael","last_name":"Kuvalis","payment_method":"Check","split_by":null,"splits":null},{"contractor_uuid":"577b6307-66e9-4926-a769-91f5c8b578aa","first_name":"Autumn","last_name":"Connelly","payment_method":"Direct Deposit","split_by":"Percentage","splits":[{"bank_account_uuid":"0aca4500-8ba4-48fc-adce-677fe7926b7b","name":"Cayman Island Checking","hidden_account_number":"XXXX1545","account_number":null,"encrypted_account_number":null,"routing_number":"055003201","priority":1,"split_amount":100,"account_type":"Checking"}]}]},"items":{"type":"object","properties":{"contractor_uuid":{"type":"string"},"payment_method":{"type":"string","enum":["Direct Deposit","Check"]},"first_name":{"type":"string"},"last_name":{"type":"string"},"split_by":{"anyOf":[{"type":"string","enum":["Amount","Percentage"]},{"type":"null"}],"description":"Describes how the payment will be split. If split_by is Percentage, then the split amounts must add up to exactly 100. If split_by is Amount, then the amount represents cents and the last split amount must be `null` to capture the remainder."},"splits":{"type":["array","null"],"items":{"type":"object","properties":{"bank_account_uuid":{"type":"string"},"name":{"type":"string"},"hidden_account_number":{"type":"string","description":"An obfuscated version of the account number which can be used for display purposes."},"encrypted_account_number":{"type":["string","null"],"description":"Ciphertext containing the full bank account number, which must be decrypted using a key provided by Gusto. Only visible with the `contractor_payment_methods:read:account_number` scope."},"routing_number":{"type":"string"},"priority":{"type":"integer","description":"The order of priority for each payment split, with priority 1 being the first bank account paid. Priority must be unique and sequential."},"split_amount":{"type":["number","null"],"description":"If `split_by` is 'Amount', this is in cents (e.g., 500 for $5.00) and exactly one account must have a `split_amount` of `null` to capture the remainder. If `split_by` is 'Percentage', this is the percentage value (e.g., 60 for 60%)."},"account_type":{"type":"string"}}}}}},"title":"Contractor-Payment-Details-List"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided ID/UUID is valid.","type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["error_key","category"],"properties":{"error_key":{"type":"string","description":"Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error."},"category":{"type":"string","description":"Specifies the type of error. The category provides error groupings and can be used to build custom error handling in your integration."},"message":{"type":"string","description":"Provides details about the error - generally this message can be surfaced to an end user."}}}}},"x-examples":{"not_found":{"errors":[{"error_key":"request","category":"not_found","message":"The requested resource was not found."}]}},"title":"Not-Found-Error-Object"}}}}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-id-contractors-payment-details.api.mdx b/docs/api/get-v-1-companies-company-id-contractors-payment-details.api.mdx
new file mode 100644
index 000000000..c93f2af20
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-id-contractors-payment-details.api.mdx
@@ -0,0 +1,95 @@
+---
+id: get-v-1-companies-company-id-contractors-payment-details
+title: "List contractor payment details"
+description: "Get payment details for contractors in a company. This endpoint returns a list of all contractors"
+sidebar_label: "List contractor payment details"
+hide_title: true
+hide_table_of_contents: true
+api: eJztWWtv3LgV/Sss0yIJIM2MHT/i+VTX3g2Mthsjj90UtmFT4tUM1xKp8DH2wJj/XlySes0j2aDdYlEkX2KNqMtzD++bT1TVoJkVSl5wOqUzsOliL81VVTMpwMS/lreCp7mSVrPcKm3Smi0rkPaWg2WiNDShHEyuRY2S6JS+AUviGhLXkEJp0pNBhCSMRPkj8mEuDAHJayWkJRqs09IQRkphLFEFYWXZ//paMmNULpgFTh6EnRM7B2JqyEUhgDdyEyJkXjou5AwXCN2iqsDOFTeESU4yJu8Jy3PlOrjXUhT4yZIwDaRmgpOFYIQLDTkuqpURdnQtr+WPa3r5tdlybWniAWowtZIGIiwwEdUAgZCF0pU/lGvpdTMgjbBiAYQzy0jFzD1wT6iB3GlhPYGwQTkrjWq26oslLFPOXsu5ehjSYry2pi6FJY3+c7YAUrnSirqEAVKDehdi5jTwL1KRzyG/T4iS5dLTkDEj8rWjGOATJppAFPzs2TPyruHuvDmhlOCGQ577+0+vJSEp+duW4yUvAokvw5LLCMVr3qkVzwBXvFPOohVJV2WA9oc/nkahdllDi8cr2xLaYtiiMQcjZjJuEpQ8U1WlJPlogJwxE4WCzee4d6daK6lPWhF+16osSa1VDsYIOUMJP4MWxXKHiOgJuO4dLAQ84Lq6T8iQD4NY70Dmellb4LeR2dvAzB2eHVswUbKshHDkrX8yzgWKYCUxuaqB3HV4bpuYEvFMNTA+HQo3d94a/LfTr358RxNq2czQ6RU966yC3iT0MZ05Y1UqpIVZUCvFQ8SlUGXAOXCaUFbX/SX+05ppVoEFjXKfqGQV0Cnt4iRNqMAQWDM734iL6KQfP16cY0RDQobhT3CQFuOX6b8kD3NlYNvJNba8VI48MLRDhW6jBSxgRBOq4bMTGjidWu0goSafQ8Xo9IkGXamxWsgZXa2SniItp8512nx2oJcDkQUrDazr97aOx1uI0oJGQLMdqYA10TrvqTYiv8xBovUuBAe+FjQfRFkGi2pi2jbBFqnsiaTfrHhjTDOtXP0707CREVtWmtUexX+DmLWtPE9B+G+k6FP6xnvN6eVF+jNog8pGYubAOOgvyEkoSFehf+1P9g/TyVG6d4juxKFgrrR02v99tU7oOTpcJWT0DM4spBkzwMnp5QVZBCxkvSRYKqf9gpyV5YhcFEQqCRigOh79GlbXpci9jz835KoSUlSu6su+eTG3tjbT8Zir3Ix89Bjlqho30SKNkde/H7NapPFLIWfPosC09/NLhOEM8BFd3SS0yeM+ppwFxz/NMYSfOjun06ubVS9safPAZo1XN1ZgkPT9yQT/G7JnnJdUuJIm3s5BWlzVU3v8q8GlT5vnx7RmaPKPKTyyqi7DPlHkrbHMuhAJ1yPHlMIrfnLw+pilB5Bn6cEJe5VmR0WR5sXkVcaO949fZ0c0oYXQxt5GG/sXA0RZsu6nv7sFKwUWmcMoT6f0DHMtWh2mqdtsSafSlWV8NuEJDXgT2+HxcXb0anKcHh3BSXpwsn+UsuOjk/RkrzjMX2eHx68ZW8d26qyr5Bq6MyUllOVyG7zzUJqch9JkgJNegs5BWjYD2uG9eqJYYLU5NYKdsJwdHE4m6euMHaQHr4s8ZTyH9Oj4uIDjk/2j7DijSeOmZ2xZMUkuTInFracoeOBccA5yLWGjX3/69Gnv8OAQM97au0DnrmTfvNehOOokTg4PJ5NX+5M9ZEULFUx7ryGAVSiETvcmk27LaG8t3tXN6maVUGGhMj17VNmvkFsvF3sXK4JBbpzwRiDbPJ/dMWrj4IKhIZ6+RWzZo2caW9525/9EmVy+LfyR70JxGmhK+rZyg+YcP0DyffRYD5b4lIEhsb5vs4HPE1ks8H1AbABhNOp28elFxpYKC8BwYIZUzlis4oirManBI8ttuSR7k8mGtAC+JynIIBpqDcb3GnnoOCT375G5wXZhtwzIHSp6hxvmrLZOQ8x+FROSgx61zPbs5KoNXJ6lm99sSFv8b8tB7jzhHT62ecjDMzuVRGWFM7nPXk1Ci1Vi07sEYeRhLvI5yZlEbjCF+OzOhalLtiS107UyYDwrux2346lF1BA1RHYm6jloC4+htWJCxmaaFA6tqd9cBeFJRNgcH4cIgjhsSAgj97BsUzD2h76sGJG3WMEshBHYObRNwzf2CHehtfDqr8elbTGhjU7tS1/x+2Jms3hXmoPGc2m+89wDy+fDlikJ+NtVeySDljeMIEPisFEekctmdcOck+KzA+8hBj477A5Y2Zl7G0e7w4ya7jrMi4LcNU7qO7XnwU2fJ6EcFL4yDH75AkazUUIOJxOv458PR5PJS4+lcXssphoNPGQ/KmDNFgHdHbL1NQ8mm8C6aNQD54NZ+4IsWOmgAXoUcB5N/vLSUzTMK5t1Lf5LqBW2jGk8GlkahwFpnDOk/xDG0rD6YHKwWV79pCz5UTnJv6W62iGC4LjgWn7w7Hx2YNBtNBjldA6EKzBEKkvgURg7Iv9k90BMQ2frURfnY99kCoMMCY71/XrQ6zqYKwpax754GArj75u14M5QuiH19h7wAwxrM6WXO/bwq74aI9/H6Z4hD3OIOvvPicpzp82IfFjWAmv9ZTAYDDNrPTWzVovMWRi3fTzRUPqoa1Un0ltQi/oboKEEXItWHyT5yVwjqjkkE5H7/kvIWUiD/ZhuFcmcKDnJMThWcf2cSV5iIBEytC698YTHXIExWCd8FfJlA6QdFuJMsEdqSmYgQXd0RtENSuN0wfKAlEmc3SJwZC74yrBhkMreFt5JeoZ1NTh/Gi2+by/T3oc95egOB3lgwT/8B9hZ9V38J2VT72TpD7hp+jZYbYQLjxanrDjlQVwB0c45UUJ97PnqvAirtaGo0Lu132MPhyVc2zPMwNckOD2a0vFib9wO48dP3ZRpNe518+PNcbwBvWhGVE6X2KHH/pXVIrSvKYfK97AbpnEOlfIdn6mB3QMzyzTIS303gt9RVGyH4K0yL7XiX5BZ4+t+I/weI2UwnS3tcGvcuHkzdcDnDJjekrqjiLSEBZSEOSxKbQzO6DXvl8ZC9Z/sECTs2ADbGFkoLzUaoy95cMKAphBnKYMZSEJx5GHeFu9BL0QOPaa76YP32bFfOOa4NYbW1D+nqvAM46frYH+BMlcVoOd6HM8N+SFaMY7C/QQZhx9c5Q4Ny6vxp5jeWO7TW2w2z5tdyTsMo97qE4qJvfSmEt/+tbMMZKNWxlZM9uRgkv3CjHNdhacu036/bPp+2fT9sun7ZdMf4LIpZAzslcd1yYRPLT5JPsWEfkUXez6MxpROEzodXB31DKo3UGyC4E1C58pYlPP0hPPvj7pcrfDncDGB2Z4Lg2TsuJrox80/6GXNVhZDDbV5ORWrKOrrkd9F9T/KBc1vo2Xr1VVH0g0+aIEsfaOxvHgXW7uX5H97iblV76Yflcu+eh0frUf5EXK8nPo2hf+vr5y+aE7br/kGnhYWYr1c2967jZHHoLN588MH7JGG5XVbTsc/evPw4ek+PYUVH9Q9yNWqPWyLz77TW/0b0GEtxA==
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Get payment details for contractors in a company. This endpoint returns a list of all contractors
+associated with the specified company, including their payment methods and bank account details
+if they are paid via direct deposit.
+
+For contractors paid by direct deposit, the response includes their bank account information
+with sensitive data masked for security. The payment details also include information about
+how their payments are split if they have multiple bank accounts configured.
+
+For contractors paid by check, only the basic payment method information is returned.
+
+### Response Details
+- For direct deposit contractors:
+ - Bank account details (masked)
+ - Payment splits configuration
+ - Routing numbers
+ - Account types
+- For check payments:
+ - Basic payment method designation
+
+### Common Use Cases
+- Fetching contractor payment information for payroll processing
+- Verifying contractor payment methods
+- Reviewing payment split configurations
+
+`encrypted_account_number` is available only with the additional scope `contractor_payment_methods:read:account_numbers`.
+
+scope: `contractor_payment_methods:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-id-custom-fields.ParamsDetails.json b/docs/api/get-v-1-companies-company-id-custom-fields.ParamsDetails.json
new file mode 100644
index 000000000..3fe999b74
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-id-custom-fields.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"string"},"description":"The UUID of the company"},{"schema":{"type":"integer"},"in":"query","name":"page","description":"The page that is requested. When unspecified, will load all objects unless endpoint forces pagination."},{"schema":{"type":"integer"},"in":"query","name":"per","description":"Number of objects per page. For majority of endpoints will default to 25"},{"name":"X-Gusto-API-Version","in":"header","required":false,"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.","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"}}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-id-custom-fields.RequestSchema.json b/docs/api/get-v-1-companies-company-id-custom-fields.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-id-custom-fields.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-id-custom-fields.StatusCodes.json b/docs/api/get-v-1-companies-company-id-custom-fields.StatusCodes.json
new file mode 100644
index 000000000..1270db3aa
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-id-custom-fields.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"Example response","content":{"application/json":{"schema":{"type":"object","properties":{"custom_fields":{"type":"array","items":{"type":"object","description":"A custom field on a company","x-tags":["Custom Fields"],"properties":{"uuid":{"type":"string","description":"UUID of the company custom field"},"name":{"type":"string","description":"Name of the company custom field"},"type":{"type":"string","description":"Input type for the custom field.","enum":["text","currency","number","date","radio"],"title":"Custom-Field-Type"},"description":{"type":["string","null"],"description":"Description of the company custom field"},"selection_options":{"type":["array","null"],"description":"An array of options for fields of type radio. Otherwise, null.","items":{"type":"string"}}},"required":["uuid","name","type"],"title":"Company-Custom-Field"}}}},"examples":{"Example":{"value":{"custom_fields":[{"uuid":"ea7e5d57-6abb-47d7-b654-347c142886c0","name":"employee_level","description":"Employee Level","type":"text","selection_options":null},{"uuid":"299650e4-e970-4acf-9bf0-6f05585d20ba","name":"t-shirt size","description":"What is your t-shirt size?","type":"text","selection_options":null},{"uuid":"024ec137-6c92-43a3-b061-14a9720531d6","name":"favorite fruit","description":"Which is your favorite fruit?","type":"radio","selection_options":["apple","banana","orange"]}]}}}}}},"404":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided UUID is valid.\n"}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-id-custom-fields.api.mdx b/docs/api/get-v-1-companies-company-id-custom-fields.api.mdx
new file mode 100644
index 000000000..6377e9997
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-id-custom-fields.api.mdx
@@ -0,0 +1,71 @@
+---
+id: get-v-1-companies-company-id-custom-fields
+title: "Get the custom fields of a company"
+description: "Returns a list of the custom fields of the company. Useful when you need to know the schema of custom fields for an entire company"
+sidebar_label: "Get the custom fields of a company"
+hide_title: true
+hide_table_of_contents: true
+api: eJzdV21v2zYQ/isc96EdIPotfmn8ZQuWpAiwtUHbrAMSI6XFc8yWIlWScuIZ+u/DkZItx3azdsMw7FNi6XT38OG9PLeiD+yucN4wqT3cWe6l0cwvc6DjawrZFIQAQRPK87xp4ugkoQJcamWOv+mYvgFfWO0IJ0o6T8yM+DmQFJ1nZCZBCbd+aLKc62WLXDmYFYrcz0GTpSmIBhDEG/JJm/tg6dI5ZBy/23Y0M5ZwTUB7adf+bvSNdqnJYUw+xEcS3NgCFx9oQk0OEfuFoGN6B54tumxtVv23vJWCxVC3MRRNqOd3Dun4uTbGw+fc8gw8WHy1oppnQMd044UmVCItOfdzmlALnwtpQdCxtwUkNB6Mjlc0kk2dt1Lf0fIxre/mQK6uLk4fcUfLZLXrJNwQWPQSgn8uwC5pUqPL+R3QfQHwBfFz7ol0BKGC8yBa5D1eTKFdDqmcSRAJuZdKEWW4IFwpYqYfIfWOFFqBcwS0yI3UHq8nBYdupQ6ct74NL9gduK+KbAoW2aiD52DDAVrk3FiS8Y/GSr9EixqPi7AFzHihPCZYbxAAVXF+Zy9DDZxcXrDfwDqMVCGaAxcBxeYCZ1w5eAzrFFMhkxpcuCXBPbApdyDIyeUFWUSnhDtnUsk9CHIv/Rxz3gaDlCvVIhczoo0GvITcmoUUyHiw4XmuZBqofObIdSa1zIqs6XvyfO597sbttjCpa4WibqUma9dFzHK+tEap8L7Nc8mqL6W++75yyBqPf0AYhQPRoofTNaGgiwyLo9fpDVhnyLqD2BoC1XTcfF6WE+TR5UY7cOis1+ngn20qzx54lisgtSVNaGq0B+3RtsFE+6PDD/bkVUwNmtDcYtl7GcNtF/bGnFvLMe2kh8ztc7MN8GSrGRG813VZJvSBrftFtDqP4SaP0RSFFPsY3Q62p/a3wmPtxDR+ytMrnsFTnqKHpzxd6LzwBG1CI37c51uNtPDwgASmhbWg01DboYDRJ/d4t5YLaZAdL73CoJE2Fmhj7xDI46ZY47veANSFUrsz6XTz66mTO1CQouGtyeOEa4SpE2R/lBNNgkFoSvHjwEtj6CFV4aAt8trPwd5LBwlBd609eVfPgrJs9p3rmDHVdVd31eQtnow1+UMfZUIhllSIUZUX/rvgqoA9hXFdJycFPoKBGIzYkE+nrD8SIzYdDvrsqD9Ku/3eixfDtLPp15DlyiwBbhUsQO2kzVn1mvxSva6OW+XInhtAgrBPV2h6x8fDQQf6DI5HHdbn6YwdT2cdNpx1BoMXA9HrTPkGjWduLq0nTv6xO/XeV8MudNem5Y/fgKvT60PaPRqxYXrcY/0jfsSmnWGXdfv8eNTrDI66YrjBNeMLnFBAZraQu93l/Vym8zW0beMGuFg2e9FdhyaJZ55yzTVSYizXd0An5aQsY0r0O/3d1vvKeHJuCi3IjSbkRqM2WMsBbMimsCkQYcARbTyBB+l8i/zKPwFxhYVQYfXoirJFOrLgSorWjaYY94G5HPgn4G7JkBBmFmCtFBBFWUze81p6wYMH7apjregnWNLxYcma1Bn9hHTFq6tdHUKz9rWDCqdYBn5uKh2JYwZF3pi2F932WlG2VxsxWLYfa0oHdlFrx8IqVBrV+Oa5jNObCcjCCN9JkVPIDN2mMvpjIR3xuyBvDjje6/PSGvEFnzm+xpM7SAvUVwF51XJO0hScOymQhOtJ0+otTubYd/bYrhseQqxVBv6eArd7tF/d4UJ7Ibzwc1wAohjAHv526TxkfydC9HAgQFCpMxO8Vj036EaUYZgvlXLc0jwJRV3oXs/egl3IFBr3sZFofGoK3w6GbYGhUSaw8JuZWbgH/HSnU4BKTQaoZwOOZ46cVWlPLqPYCwpRmLTIQPtwjO8qOcXTIKeqnnRaRyVvQFVlklDIuFQhoaq3P23yB9nIjfMZ1w0/L8HvX/uaCunRLF+Lu//8CtmYC+1ccRmSLhTZqmoB13TRDQTXm2JCx1s74XYfmCR0bpzH71YrXBeurCpLfBw3IawxIR2fqkOLR5O+f2mTO8BDbKjViln3ztCG/voJ/rHl7ssYQ+FvIE7wh5WI8SsZf/6mUmc/kEN7+gEk9eYRLNZQaoSNlCknZVJvoV8H7n++kn7hgvfv81s5GQ1xVOS+8W5nu9wa9i/P3tGy/BN7AapC
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Returns a list of the custom fields of the company. Useful when you need to know the schema of custom fields for an entire company
+
+scope: `companies:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-id-earning-types.ParamsDetails.json b/docs/api/get-v-1-companies-company-id-earning-types.ParamsDetails.json
new file mode 100644
index 000000000..02a817035
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-id-earning-types.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"string"},"description":"The UUID of the company"},{"name":"X-Gusto-API-Version","in":"header","required":false,"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.","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"}}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-id-earning-types.RequestSchema.json b/docs/api/get-v-1-companies-company-id-earning-types.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-id-earning-types.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-id-earning-types.StatusCodes.json b/docs/api/get-v-1-companies-company-id-earning-types.StatusCodes.json
new file mode 100644
index 000000000..c20cc298d
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-id-earning-types.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"Example response","content":{"application/json":{"schema":{"type":"object","properties":{"default":{"type":"array","description":"The default earning types for the company.","items":{"description":"","type":"object","x-examples":{"Example":{"name":"Cash Tips","uuid":"f5618c94-ed7d-4366-b2c4-ff05e430064f"}},"properties":{"name":{"type":"string","description":"The name of the earning type."},"uuid":{"type":"string","description":"The ID of the earning type.","readOnly":true}},"x-tags":["Earning Types"],"required":["uuid"],"title":"Earning-Type"}},"custom":{"type":"array","description":"The custom earning types for the company.","items":{"description":"","type":"object","x-examples":{"Example":{"name":"Cash Tips","uuid":"f5618c94-ed7d-4366-b2c4-ff05e430064f"}},"properties":{"name":{"type":"string","description":"The name of the earning type."},"uuid":{"type":"string","description":"The ID of the earning type.","readOnly":true}},"x-tags":["Earning Types"],"required":["uuid"],"title":"Earning-Type"}}}},"examples":{"Example":{"value":{"default":[{"name":"Bonus","uuid":"b82e35c5-d7c6-4705-9e16-9f87499ade18"},{"name":"Cash Tips","uuid":"f5618c94-ed7d-4366-b2c4-ff05e430064f"},{"name":"Commission","uuid":"60191999-004a-49d9-b163-630574433653"},{"name":"Correction Payment","uuid":"368226e0-8e8c-48f0-bc91-aee46caafbc9"},{"name":"Minimum Wage Adjustment","uuid":"88a2e519-9ff5-4c19-9071-6a709f3c2939"},{"name":"Paycheck Tips","uuid":"a3eaf03d-e712-4144-8f9b-71a85528adcf"},{"name":"Severance","uuid":"a6a2eba7-6c7d-4ced-bbe8-43452fbc9f63"}],"custom":[{"name":"Gym Membership Stipend","uuid":"6b4a8efb-db90-4c13-a75f-aae11b3f4ff9"}]}}}}}},"404":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided UUID is valid.\n"}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-id-earning-types.api.mdx b/docs/api/get-v-1-companies-company-id-earning-types.api.mdx
new file mode 100644
index 000000000..a2fcc95fd
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-id-earning-types.api.mdx
@@ -0,0 +1,77 @@
+---
+id: get-v-1-companies-company-id-earning-types
+title: "Get all earning types for a company"
+description: "A payroll item in Gusto is associated to an earning type to name the type of earning described by the payroll item."
+sidebar_label: "Get all earning types for a company"
+hide_title: true
+hide_table_of_contents: true
+api: eJztWN9v4zYS/ld4zEN3AdGWbVm2/HS5ZG8RoHsNmuy1QBK0FDmyuSuJKkn5LBj+3w9DybbsOG0PfTkUfYosDb/5/c0wW7phy9o6zVTpYGm4U7pkrqmALp4oFClICZIGlFdVX8TSl4A6vrQo9oGbUpVL8thU4D8YsJUuLVi62NJxGOIfCVYYVeFhuqAfNryociB7SRpQoUsHpUNZXlW5El7R8IvFA1tqxQoKjk+tdVSnX0A4GtDK6AqMU606CRmvc9cT5MbwhgZnFjyugHSyBDoH8IAlmTbErYAIXVS8bAY0oMpBYV97QYNXxmwYtK558c5NfCx5gYI33K7Io6osDWhdK0kXNJvGo7lIIgZyJlk0iWOWjkXEsiycQjQJwzjK6G537mgLePDSOqPK5UU3UZLozDvVd3VAd3sjfg/M3e1lEMw3l9+VeUMXztSApm7YrxTHL7UyIPGjV46VpBxGaS/MUNi7LLA2i9+VzFb0r1z+n+YSkd4I55rnNZz07tMhxv/QZd2Lbzofw2QqpkzORMyiWThlCYxilmTzWZQkXMJoTnfBH09RD0IXhbIWY3fAiMNRMkqShIVhxFmUyISlo3jC4kk4nUXRZBJPJ6cYxoDA+JN73hRIcwesSTwfj2MI2RzmgkXzLGSpSEaMA0Sx4DxLRdLH+qRKVdQF+YEvgVzLL7V1p4DzOR/DdJSwJMumLBL4FM5GLOazMMkmYpxMTgDveSNWIL6exYlPgGfhRDKYjcYsGkURm2dJymYjPp9Ox3MuxUmcHmANhpcCehAxH0PKZywWGGoBkqUpzFk0iaZj9CuLJ3T3cmzzY94/NgX5hPPH2JWqyINTFZSyl4E04nPIUibTJEQnJ4zPphnjHEajdJJFWZbQ3ctu11ZeFEavW/5f2pF/6rqU5Lkk5LnExsCKButA4mjStRFApAZLSu0IbJR1A/KJfwViawO+fyqj10qCJJ8/390SZcma50oOnkvf5tjkfo7dodFLcGw9Yi0ZKbDdU/OTkqzrw588b73q2WtS8cboPCdIX0SV5COGDPVxa7VQHE12mvDypKPxlacMNNW/0NlBoFWRgiRp0/rS0zF4Lp/Lq6urK3LbTcl+9z+XN2AcV+UZ33IDxFYgFM9JCoLX1qtuyIqvgTi+IUKXVskuKnZAHlfawgWUQluXt2ZZdACZHCus2XM5kYAlgad0SZSzJIclz4l1phYO0/Pu229vAnKjTaVbdQEBJwbvD57dtCPjzLFLcwQt4nnuzdFuBeb8O65JreeZEjzPG28wPwwe1GmFrmBBfu7CbBfItT/jBsMNL8CBsf0WOBYHTi2sgoq7Fe2zLlJ08Ho16oh/d4n5fZl23N9p6Hfxj8wXFru+v2P/BtPRnte+Ai7BnOjPeG7hXMstelKoEqxXIrkDlnILklzf35F1C9ov2/8otyKNro0XwOgNyF1GSl0CFvi+w4JWprccfmPJU9HRYQ/75d3KucouhkOphR34/XYgdDHc77Osy4D/PuSVYt1JVS6vOkDWe/0ezagtSByQb0U7oFDWyGF0HI6nLIzZaIrz8DDU+u93yHobZivgX4Hbhi2Nriu6oF1ZPXYs0BfBDDG9BmOURL25ssj6sHFQWr+TY/F8hYYu3t7qg/20/Y3tHktiD3Vu5QHj1NrLR06tPh711mMUCnAr3bGj7wW3ogs6XI+GB54cbo+9sBueM6UFs963Tm1yrNQu/bxSbfaZhMKXwCtivYVCn8W5xWN+zOA579gbwBcx742Wv4JZ4Wf03IKojXKNt/ym9fBaCLD2usYgPL30pR6w7trd6YLsoRrRxH2V4u8UuPFde2pjB8FyWENOeO1WULqurZA4HhrroPgjGlqENxTskFMy7VG7fbEdaNf3d1gkHfOc9ExAkVfsd9kDmLUS0MvHscV5qms39IJDiapxAjP/m+nM50H5FeXU2B8gF7rw49Lb8Y0lH7r2wI3NT0VkGKlFjduWd+Nv3a2VC9e7FdzutZLvIe/aKaBQcJX7guq+/v1YP/4+oK0reNnD+QjOj5zXF5rDVDl3Y3u8RP+1MfypN4auFR1s3LDKufI96zlq2zHoE12PfH12HEoDujjZKE5p9CWgK23x6kW3W5zWn02+2+HrX2owSFEvyN1G8RS79WlLpbL4/MYW0C/Fd993C8N78tYG8oZH+0u/l9hPDhp0Y6bnzu5lF+wXlP/NuD/5tnIxrG34Lq96hygfxzlOgcr1vr36/9zJHP/44ZHudv8FwLv4Wg==
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+A payroll item in Gusto is associated to an earning type to name the type of earning described by the payroll item.
+
+#### Default Earning Type
+Certain earning types are special because they have tax considerations. Those earning types are mostly the same for every company depending on its legal structure (LLC, Corporation, etc.)
+
+#### Custom Earning Type
+Custom earning types are all the other earning types added specifically for a company.
+
+scope: `payrolls:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-id-employees-payment-details.ParamsDetails.json b/docs/api/get-v-1-companies-company-id-employees-payment-details.ParamsDetails.json
new file mode 100644
index 000000000..56c2b2761
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-id-employees-payment-details.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"string"},"description":"The UUID of the company"},{"name":"employee_uuid","in":"query","required":false,"schema":{"type":"string"},"description":"The UUID of a specific employee to fetch payment details for."},{"name":"payroll_uuid","in":"query","required":false,"schema":{"type":"string"},"description":"The UUID of a specific payroll to fetch payment details for employees on that payroll."},{"schema":{"type":"integer"},"in":"query","name":"page","description":"The page that is requested. When unspecified, will load all objects unless endpoint forces pagination."},{"schema":{"type":"integer"},"in":"query","name":"per","description":"Number of objects per page. For majority of endpoints will default to 25"},{"name":"X-Gusto-API-Version","in":"header","required":false,"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.","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"}}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-id-employees-payment-details.RequestSchema.json b/docs/api/get-v-1-companies-company-id-employees-payment-details.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-id-employees-payment-details.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-id-employees-payment-details.StatusCodes.json b/docs/api/get-v-1-companies-company-id-employees-payment-details.StatusCodes.json
new file mode 100644
index 000000000..ac8283fde
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-id-employees-payment-details.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"A list of employee payment details.","content":{"application/json":{"schema":{"title":"EmployeePaymentDetailsList","type":"array","description":"A list of employee payment details.","items":{"title":"EmployeePaymentDetail","type":"object","description":"Represents an employee's payment method details.","properties":{"employee_uuid":{"type":"string","description":"The UUID of the employee.","readOnly":true},"payment_method":{"type":"string","description":"The type of payment method.","enum":["Direct Deposit","Check"],"readOnly":true},"split_by":{"anyOf":[{"type":"string","enum":["Percentage","Amount"]},{"type":"null"}],"description":"How the payment is split. This field is applicable when `payment_method` is \"Direct Deposit\".","readOnly":true},"splits":{"type":["array","null"],"description":"An array of payment splits. This field is applicable when `payment_method` is \"Direct Deposit\".","items":{"title":"DetailedPaymentAccountSplit","type":"object","description":"Details of a single payment split for a payment method.","properties":{"bank_account_uuid":{"type":"string","description":"The UUID of the bank account.","readOnly":true},"hidden_account_number":{"type":"string","description":"The masked account number.","readOnly":true},"name":{"type":"string","description":"The name of the bank account.","readOnly":true},"priority":{"type":"integer","description":"The priority of the payment split.","readOnly":true},"split_amount":{"type":["integer","null"],"description":"If `split_by` is 'Amount', this is in cents (e.g., 500 for $5.00) and exactly one account must have a `split_amount` of `null` to capture the remainder. If `split_by` is 'Percentage', this is the percentage value (e.g., 60 for 60%).","readOnly":true},"encrypted_account_number":{"type":["string","null"],"description":"Ciphertext containing the full bank account number, which must be decrypted using a key provided by Gusto. Only visible with the appropriate `read:account_number` scope (e.g., `employee_payment_methods:read:account_number`).","readOnly":true}},"x-examples":{"AmountSplitExample":{"value":{"bank_account_uuid":"1531e824-8d9e-4bd8-9f90-0d04608125d7","hidden_account_number":"XXXX1207","encrypted_account_number":"mbNLVOm7psP16ocqXso5ZtzOXBrA-5Q-.zarrdLBmyYDDK4kCkF2reKtzx8udK8iDabtW","name":"Primary Checking","priority":1,"split_amount":50000}},"PercentageSplitExample":{"value":{"bank_account_uuid":"e88f9436-b74e-49a8-87e9-777b9bfe715e","hidden_account_number":"XXXX5678","encrypted_account_number":"mbNLVOm7psP16ocqXso5ZtzOXBrA-5Q-.zarrdLBmyYDDK4kCkF2reKtzx8udK8iDabtW","name":"Savings Account","priority":1,"split_amount":100}}}},"readOnly":true}},"x-examples":{"DirectDepositExample":{"value":{"employee_uuid":"e2c4c0ce-2986-48b9-86cf-ec27f6ed9a36","payment_method":"Direct Deposit","split_by":"Percentage","splits":[{"bank_account_uuid":"1531e824-8d9e-4bd8-9f90-0d04608125d7","hidden_account_number":"XXXX1207","encrypted_account_number":"mbNLVOm7psP16ocqXso5ZtzOXBrA-5Q-.zarrdLBmyYDDK4kCkF2reKtzx8udK8iDabtW","name":"Primary Checking","priority":1,"split_amount":100}]}}}}}}}},"404":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided UUID is valid.\n"}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-id-employees-payment-details.api.mdx b/docs/api/get-v-1-companies-company-id-employees-payment-details.api.mdx
new file mode 100644
index 000000000..a94c11ed9
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-id-employees-payment-details.api.mdx
@@ -0,0 +1,78 @@
+---
+id: get-v-1-companies-company-id-employees-payment-details
+title: "Get employee payment details for a company"
+description: "Fetches payment details for employees in a given company. Results are paginated."
+sidebar_label: "Get employee payment details for a company"
+hide_title: true
+hide_table_of_contents: true
+api: eJztWVtz27oR/iso2k6SGVG36GY91YmT1JM0dnM5cWt7LIhYSYhJgAFAxYxH/72zAChRN9tJTvPQHr9YIoHdD4tvr7qlN9E0N1ZFQlqYamaFkpEtMqDDcwrpGDgHTi9rVGXg3x5zOqRTsNG8FcUqzZgUYMKn4krwCNIsUQWAiTJWpCDtFQfLRGJojVo2NSj5RbkGRXMwsRYZCqdD+hJsPANDwmYSNpOJ0mQpmghJGJmKOUgSVNfJOzB5Yg1hGkjGpkIyC7x+IS/kRwPEzoCMSgFXeS74iHzJQRckY5qlYEETq8hEJPgJtTFihJwmsFRbr0jKWKFVkjxI0Aq2Qtgmg1hMREyCjPqFPNVqLriQUzJWdraFk0m+qfGrSBKi3Ym9MTrNJgGtla5fyEOJOm1BmNasIMIQDTbXEjgRE4c/GI3MmCFSVRFqXLL2KGU2nrld4UyxFha0YM62H5xdZayLzAK/YnGscmmvZJ6OQY8Qm7OXyRJhzWiFSMmkIHNhxDiBEtXq3CV1UrAzxc1QA+PDTdkmVhmgrEyDAWkdnmfMgH8zvEfeiNbo8sqQlrdUshTokK7YTGtUICszZme0RjV8yYUGTodW51CjJp5ByujwlnqfocZqIad0sclqtNLHj8dHRK3Zny5qS6Vrd17qdcRaUzxhiflRzRXuldocVdHldjlcvYqvyr//Oryg7E50635lZ8wuPcrh3sLgYhxoBLGGfnnAKdBd+PCFl+886UsOBiML+TQDSXIZQAOvea9MFOOEJQlR488QW0NymYAxBCTPlJAWsccuwrkYJZT8Qbygt+C+da6BxiyVZ6DdAerkpdIkZZ+VFrbAFSUe42FzmDCMJlaRdrd68WfRK5ciDk+Po99AG9QUEM2AcYdiiwDrsI7QxVIhwTj2c2YhGjMDnByeHpO5F0qYMSoWGLXJV2FnpFC5dgtiliR1coxxSQaHx3iJFndrWJYlInamfGTIeSqkSPO0Kvvy8czazAwbDa5iU3c5rx6rtFHmuChQx71vsExEYaeQ0z8HgVHl8ROEkRvgdbqf7TUKMk8x4bWb7W7U7EWtrs94ztR0WH2+WFyiHU2mpAGDwtrNJv5bN+UhSYSx7v5KF97wDUQUK2lBWtxeMU7js0EZa1QTNkHEZUY+9bKOvKg3wlhM2/5ULnZvUe5hgISF1NyrcKXL03dL2TsIsd4QJpcKH63KBR/gq5ozjbWLFd6m61F2x43dHbeXpYDjPOMnMil8MlhgMqkmmYcJxxUofB1/vUKdI6EhtuQIMmUEWuT5DOJrerkDgEuyV+PCXbssTiYuqe3j5CnoGKT1Ue8wxdRKL9HvwwaZJwldbBVof1dfnSlKxMIQp7dOPsyEIRMBCceHgXeY3r9ioBytm2eEay42TndBdxrWFw8rg54vqegwbkE8lKHOqBjWy/j9QG4R2jMYeCD0oS9W3qPae2kd3C0kQV91rgEPBek2S9bZPWbyelmC/RjDUQQJInZexkxwDnKj0HuYnpSZa+CldOK37lTiU89DZOLKB2PPtHDpb0eS3Zn4w/JS/tqV7GfqFfPOVOHrSstuxh5PQol8NS4c6R55h3xUIxYJK1zLE7vA9xjq03qNdJtNx4q/dOvN5hPXI8ANi21SEMySpZHT3FgyY3MgrFTh4Y3wVCOEM8KcH7PM5tp3NxpSJiQH7ZLuBrBV2KiAc9ZZviBzluRQAu15nL3mX5/stNm+5qFqvyUBdpvvuchmoC3cWIKZjwlM275lyZNkjReBdTXydSbimTfPGAiHAILk6H+EkWsolnUGGRfEFUF1clLtW1yZgmpYho6osXghozualWCS72t0dpltUaM3EdywNEu863u+uHDzwj/Gp+4i9kQG2uo+bcGg3YkG/ACizpgPooPJQTNq8man1xy02l3ep3sdnp6dnZ212s0+vesKaTp+++a3k7SfmdNWT8Vfzozq/tt+Ozl7pg+j7j+j+jemNX/zLC3+dXT0unP9/PplW8Nr++1mkPPXA3HExvbTqug91SJluiAuCXpKrJy6temA3Waz2URbrUj7XRaCwWBy0Hnai8b9DkSdAzaIBn04iPr9/vhgPIF+qwv3WKjb6w9+qYXes7mQU0NCArrbQC00DxroPnr5FBgy4C7zbRRWFNpxJ27GELUPBr2oMxgfRINePIkgbvcnPeAH7GmPbtdM2+XOqqhZr1jKouD8/5XceHeXi/BXo51mZ7tbeKssealyycmFJMRPa5YdLM6PVK5jIFwBzoEsgRthbJ38g10DMWU6WEZBVycIg+Fd4GSNol64sSCxJfJ3cQ14U3vHirWSMdXxIhaZSwJMwXEWBy5D2pi3GsspY+N2NZhZNJbdf2N7zmhAz8uZTq4T7FRD+8cy4bu/iEPqWsAdxViqKPLfZMCugZki8vIiRyzc59rjPYJ3yjzVit8hM8PXaAUDce6v+/yWPvenPYxjMOYwR4OcX1ZXvcc2zvvnjrXLEgchll0qfh8D0zsqniAiSmAOCWG5nYG0oXPEGcT7wlhIf0aDl7BHgZtyTFS1pHYpF9t4pE2YPKz1zDWKcwVzMnkPei5iqNzHqsVnY5XbhlvY4KgaK+bIfY/UxN0Dbt0E+wmSWKVuQOZwPDLkRWAsOQ3jKZwwcBXnSD93jD+F3pvFrvwLfn1UaiXvIHHrkKRYZCWOUOHt31b8QWtkytiUyYqcV2D3NtmhQygHixunuV1NBP6YsP8xYf+FE/YQIbA2b2QJEy6UuNB5G4L8OZ23nNuEME9rdLg2gV8aqlIvlLH+skZnyliUcnuLI8WPOlks8LGflmIc5cJgh79nOFl1jZ8blu85rM+Im+P9kAapSyU/jfBn5+V3Qt+Y/P8E8l8wSb/nJFP48RP8bsP1uzG6xLmCeIlftECM38nmx+/CVP4J2ff70x4k5cDXrVhCKRFWnHNxiRMh/yvA94H7H/9J4I4L3v17yhon/UIstTJbebc1yl8rnF+9+EAXi/8APSwz0w==
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Fetches payment details for employees in a given company. Results are paginated.
+
+Use the `employee_uuid` query parameter to filter for a single employee.
+Use the `payroll_uuid` query parameter to filter for employees on a specific payroll.
+Providing both `employee_uuid` and `payroll_uuid` will result in a 400 error.
+An empty array is returned if the company has no employees or if no employees match the filter criteria.
+
+The `encrypted_account_number` in the `splits` array is only visible if the `employee_payment_methods:read:account_number` scope is present.
+
+Base scope: `employee_payment_methods:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-id-employees.ParamsDetails.json b/docs/api/get-v-1-companies-company-id-employees.ParamsDetails.json
new file mode 100644
index 000000000..a58fafdce
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-id-employees.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"X-Gusto-API-Version","in":"header","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"},"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."},{"name":"company_id","in":"path","required":true,"description":"The UUID of the company","schema":{"type":"string"}},{"name":"location_uuid","in":"query","required":false,"description":"Filter employees by a specific primary work location","schema":{"type":"string"}},{"name":"payroll_uuid","in":"query","required":false,"description":"Filter employees by a specific payroll","schema":{"type":"string"}},{"name":"search_term","in":"query","required":false,"description":"A string to search for in the object's names","schema":{"type":"string"}},{"name":"sort_by","in":"query","required":false,"description":"Sort employees by field. Cannot be used with search_term. Options: created_at, name, onboarding_status","schema":{"type":"string"}},{"name":"include","in":"query","explode":false,"required":false,"schema":{"type":"array","items":{"type":"string","enum":["all_compensations","all_home_addresses","company_name","current_home_address","custom_fields","portal_invitations"],"x-enumDescriptions":{"all_compensations":"Include all effective dated compensations for each job instead of only the current compensation. Requires `compensations:read` scope.","all_home_addresses":"Include all home addresses that have been associated to this employee","company_name":"Include the name of the company that the employee is associated with","current_home_address":"Include the employee's current home address","custom_fields":"Include employees' custom fields","portal_invitations":"Include portal invitation status information, including member portal invitation details and partner portal invitation status"}}},"description":"Include the requested attribute(s) in each employee response. Multiple options are comma separated."},{"name":"onboarded","in":"query","required":false,"description":"Filters employees by those who have completed onboarding","schema":{"type":"boolean"}},{"name":"onboarded_active","in":"query","required":false,"description":"Filters employees who are ready to work (onboarded AND active today)","schema":{"type":"boolean"}},{"name":"terminated","in":"query","required":false,"description":"Filters employees by those who have been or are scheduled to be terminated","schema":{"type":"boolean"}},{"name":"terminated_today","in":"query","required":false,"description":"Filters employees by those who have been terminated and whose termination is in effect today (excludes active and scheduled to be terminated)","schema":{"type":"boolean"}},{"name":"uuids","in":"query","explode":false,"schema":{"type":"array","items":{"type":"string"}},"required":false,"description":"Optional subset of employees to fetch."},{"name":"page","in":"query","required":false,"description":"The page that is requested. When unspecified, will load all objects unless endpoint forces pagination.","schema":{"type":"integer"}},{"name":"per","in":"query","required":false,"description":"Number of objects per page. For majority of endpoints will default to 25","schema":{"type":"integer"}}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-id-employees.RequestSchema.json b/docs/api/get-v-1-companies-company-id-employees.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-id-employees.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-id-employees.StatusCodes.json b/docs/api/get-v-1-companies-company-id-employees.StatusCodes.json
new file mode 100644
index 000000000..baec54e16
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-id-employees.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"successful","content":{"application/json":{"schema":{"type":"array","items":{"allOf":[{"title":"Employee","type":"object","description":"The representation of an employee in Gusto.","x-examples":{"success_status":{"uuid":"d7282d99-ab6b-42f5-ba45-f4a670e886a8","first_name":"Boaty","middle_initial":null,"last_name":"Koss","email":"keena.feest@kiehn.co.uk","company_uuid":"e904cc79-818a-4da8-9d37-0be0a86fdda8","manager_uuid":null,"version":"a5cec1f1c0135feb3e76ca6ea3c46176","current_employment_status":"full_time","onboarding_status":"onboarding_completed","preferred_first_name":null,"department_uuid":null,"employee_code":"46f036","payment_method":"Direct Deposit","department":null,"terminated":false,"two_percent_shareholder":false,"onboarded":true,"historical":false,"has_ssn":true,"onboarding_documents_config":{"uuid":null,"i9_document":false},"jobs":[{"uuid":"bc875f9d-adc5-40f6-99db-ed8470bda25f","version":"863bcd01c51fcfa2468d604cffec7413","employee_uuid":"d7282d99-ab6b-42f5-ba45-f4a670e886a8","current_compensation_uuid":"2ec164d0-808b-446c-8120-8cfb500945d0","payment_unit":"Year","primary":true,"two_percent_shareholder":false,"state_wc_covered":null,"state_wc_class_code":null,"title":"","compensations":[{"uuid":"2ec164d0-808b-446c-8120-8cfb500945d0","employee_uuid":"d7282d99-ab6b-42f5-ba45-f4a670e886a8","version":"db7bfb49a4f0893432cb562311bfcad9","payment_unit":"Year","flsa_status":"Exempt","adjust_for_minimum_wage":false,"minimum_wages":[],"job_uuid":"bc875f9d-adc5-40f6-99db-ed8470bda25f","effective_date":"2025-06-09","rate":"80000.00"}],"rate":"80000.00","hire_date":"2024-06-09"}],"eligible_paid_time_off":[],"terminations":[],"garnishments":[],"date_of_birth":"2005-06-09","ssn":"","phone":null,"work_email":null,"member_portal_invitation_status":{"status":"sent","token_expired":false,"welcome_email_sent_at":"2024-01-15T14:30:00Z","last_password_resent_at":null},"partner_portal_invitation_sent":true}},"properties":{"uuid":{"type":"string","description":"The UUID of the employee in Gusto.","readOnly":true},"first_name":{"type":"string"},"middle_initial":{"type":["string","null"]},"last_name":{"type":"string"},"email":{"type":["string","null"],"description":"The personal email address of the employee. This is provided to support syncing users between our system and yours. You may not use this email address for any other purpose (e.g. marketing)."},"company_uuid":{"type":"string","description":"The UUID of the company the employee is employed by.","readOnly":true},"manager_uuid":{"type":["string","null"],"description":"The UUID of the employee's manager.","readOnly":true},"version":{"type":"string","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.","readOnly":true},"department":{"type":["string","null"],"description":"The employee's department in the company.","readOnly":true},"terminated":{"type":"boolean","description":"Whether the employee is terminated.","readOnly":true},"two_percent_shareholder":{"type":["boolean","null"],"description":"Whether the employee is a two percent shareholder of the company. This field only applies to companies with an S-Corp entity type."},"work_email":{"type":["string","null"],"description":"The work email address of the employee. This is provided to support syncing users between our system and yours. You may not use this email address for any other purpose (e.g. marketing)."},"onboarded":{"type":"boolean","description":"Whether the employee has completed onboarding.","readOnly":true},"onboarding_status":{"description":"The current onboarding status of the employee","anyOf":[{"type":"string","enum":["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"]},{"type":"null"}],"readOnly":true},"onboarding_documents_config":{"type":"object","description":"Configuration for an employee onboarding documents during onboarding","properties":{"uuid":{"type":["string","null"],"description":"The UUID of the onboarding documents config","readOnly":true},"i9_document":{"type":"boolean","description":"Whether to include Form I-9 for an employee during onboarding","readOnly":true}}},"jobs":{"type":"array","items":{"title":"Job","type":"object","properties":{"uuid":{"type":"string","description":"The UUID of the job.","readOnly":true},"version":{"type":"string","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."},"employee_uuid":{"type":"string","description":"The UUID of the employee to which the job belongs.","readOnly":true},"hire_date":{"type":"string","readOnly":false,"description":"The date when the employee was hired or rehired for the job."},"title":{"type":["string","null"],"readOnly":false,"default":null,"description":"The title for the job."},"primary":{"type":"boolean","description":"Whether this is the employee's primary job. The value will be set to true unless an existing job exists for the employee.","readOnly":true},"rate":{"type":"string","description":"The current compensation rate of the job.","readOnly":true},"payment_unit":{"type":["string","null"],"description":"The payment unit of the current compensation for the job.","readOnly":true},"current_compensation_uuid":{"type":"string","description":"The UUID of the current compensation of the job.","readOnly":true},"two_percent_shareholder":{"type":"boolean","description":"Whether the employee owns at least 2% of the company.","readOnly":false},"state_wc_covered":{"type":["boolean","null"],"description":"Whether this job is eligible for workers' compensation coverage in the state of Washington (WA).","readOnly":false},"state_wc_class_code":{"type":["string","null"],"description":"The risk class code for workers' compensation in Washington state. Please 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.","readOnly":false},"compensations":{"type":"array","items":{"type":"object","description":"The representation of compensation in Gusto.","properties":{"uuid":{"type":"string","description":"The UUID of the compensation in Gusto.","readOnly":true},"version":{"type":"string","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."},"job_uuid":{"type":"string","description":"The UUID of the job to which the compensation belongs.","readOnly":true},"employee_uuid":{"type":"string","description":"The UUID of the employee to which the compensation belongs.","readOnly":true},"rate":{"type":"string","readOnly":false,"description":"The dollar amount paid per payment unit."},"payment_unit":{"type":"string","readOnly":false,"description":"The unit accompanying the compensation rate. If the employee is an owner, rate should be 'Paycheck'.","enum":["Hour","Week","Month","Year","Paycheck"]},"flsa_status":{"type":"string","enum":["Exempt","Salaried Nonexempt","Nonexempt","Owner","Commission Only Exempt","Commission Only Nonexempt"],"description":"The FLSA status for this compensation. Salaried ('Exempt') employees are paid a fixed salary every pay period. Salaried with overtime ('Salaried Nonexempt') employees are paid a fixed salary every pay period, and receive overtime pay when applicable. Hourly ('Nonexempt') employees are paid for the hours they work, and receive overtime pay when applicable. Commissioned employees ('Commission Only Exempt') earn wages based only on commission. Commissioned with overtime ('Commission Only Nonexempt') earn wages based on commission, and receive overtime pay when applicable. Owners ('Owner') are employees that own at least twenty percent of the company. ","title":"Flsa-Status-Type"},"effective_date":{"type":"string","readOnly":false,"description":"The effective date for this compensation. For the first compensation, this defaults to the job's hire date."},"title":{"type":"string","description":"The job title for this compensation."},"adjust_for_minimum_wage":{"type":"boolean","description":"Indicates if the compensation could be adjusted to minimum wage during payroll calculation.","readOnly":true},"minimum_wages":{"type":"array","readOnly":false,"description":"The minimum wages associated with the compensation.","items":{"type":"object","properties":{"uuid":{"type":"string","description":"The UUID of the minimum wage."},"wage":{"type":"string","description":"The wage amount."},"effective_date":{"type":"string","description":"The effective date of the minimum wage."}}}}},"required":["uuid"],"x-examples":{"success_status":{"uuid":"db4d41e5-813c-477e-bfae-38da2ae5e7a3","version":"56d00c178bc7393b2a206ed6a86afcb4","job_uuid":"c1fdb417-c34a-43a7-92f3-5e6c20c1d7a4","employee_uuid":"a7e8f9bc-0d12-4e56-b789-012345678901","rate":"70000.00","payment_unit":"Year","flsa_status":"Exempt","effective_date":"2023-01-01","adjust_for_minimum_wage":false,"minimum_wages":[],"title":"Software Engineer"},"hourly_compensation":{"uuid":"e5f6a7b8-c9d0-1234-e5f6-a7b8c9d01234","version":"98b7a6c5d4e3f2a1b0c9d8e7f6a5b4c3","job_uuid":"d2e5f8a1-b4c7-4d90-a3e6-f9b2c5d8e1a4","employee_uuid":"b8f9a0bc-1e23-4f67-c890-123456789012","rate":"25.00","payment_unit":"Hour","flsa_status":"Nonexempt","effective_date":"2023-01-01","adjust_for_minimum_wage":false,"minimum_wages":[],"title":"Associate"},"minimum_wage_adjusted":{"uuid":"a4d9ba9c-32cc-4cc1-a5bc-6ef4cd653e7a","version":"cc59bd3879d655fb940a1f6b675f2ad9","job_uuid":"d8f8fbe7-496d-4b69-86f0-1e2d1b73a086","rate":"5.00","payment_unit":"Hour","flsa_status":"Nonexempt","effective_date":"2018-12-11","adjust_for_minimum_wage":true,"minimum_wages":[{"uuid":"edeea5af-ecd6-4b1c-b5de-5cff2d302738","wage":"7.25","effective_date":"2018-12-11"}]}},"title":"Compensation"},"readOnly":true},"location_uuid":{"type":"string","nullable":false,"description":"The uuid of the employee's work location."},"location":{"description":"The representation of an address in Gusto.","type":"object","title":"Location","x-examples":{"success_status":{"created_at":"2025-06-09T13:43:49.000-07:00","updated_at":"2025-06-09T13:43:50.000-07:00","company_uuid":"10593a6a-505b-4aa6-bf31-15dcdceedbe3","version":"e1bdd845a493c74908f8e15d6114169b","uuid":"6b1351a2-de35-4499-b948-43abab274634","street_1":"300 3rd Street","street_2":"Apartment 318","city":"San Francisco","state":"CA","zip":"94107","country":"USA","active":true,"phone_number":"8009360383","filing_address":true,"mailing_address":true}},"properties":{"uuid":{"type":"string","description":"The UUID of the location object.","readOnly":true},"version":{"type":"string","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."},"company_uuid":{"type":"string","description":"The UUID for the company to which the location belongs. Only included if the location belongs to a company.","readOnly":true},"phone_number":{"type":"string","readOnly":false,"description":"The phone number for the location. Required for company locations. Optional for employee locations."},"street_1":{"type":"string","readOnly":false},"street_2":{"type":["string","null"],"readOnly":false},"city":{"type":"string","readOnly":false},"state":{"type":"string","readOnly":false},"zip":{"type":"string","readOnly":false},"country":{"type":"string","readOnly":false,"default":"USA"},"mailing_address":{"type":"boolean","description":"Specifies if the location is the company's mailing address. Only included if the location belongs to a company."},"filing_address":{"description":"Specifies if the location is the company's filing address. Only included if the location belongs to a company.","type":"boolean"},"created_at":{"type":"string","description":"Datetime for when location is created"},"updated_at":{"type":"string","description":"Datetime for when location is updated"},"active":{"type":"boolean","description":"The status of the location. Inactive locations have been deleted, but may still have historical data associated with them.","readOnly":true},"inactive":{"type":"boolean","description":"The status of the location. Inactive locations have been deleted, but may still have historical data associated with them.","readOnly":true}},"required":["uuid"]}},"description":"The representation of a job in Gusto.","required":["uuid"]}},"eligible_paid_time_off":{"type":"array","items":{"type":"object","description":"The representation of paid time off in Gusto.","properties":{"name":{"type":["string","null"],"description":"The name of the paid time off type.","enum":["Vacation Hours","Sick Hours","Holiday Hours"],"readOnly":true},"policy_name":{"type":["string","null"],"description":"The name of the time off policy.","readOnly":true},"policy_uuid":{"type":["string","null"],"description":"The UUID of the time off policy.","readOnly":true},"accrual_unit":{"type":["string","null"],"example":"Hour","description":"The unit the PTO type is accrued in.","readOnly":true},"accrual_rate":{"type":["string","null"],"description":"The number of accrual units accrued per accrual period.","readOnly":true},"accrual_method":{"type":["string","null"],"example":"unlimited","description":"The accrual method of the time off policy","readOnly":true},"accrual_period":{"type":["string","null"],"example":"Year","description":"The frequency at which the PTO type is accrued.","readOnly":true},"accrual_balance":{"type":["string","null"],"description":"The number of accrual units accrued.","readOnly":true},"maximum_accrual_balance":{"type":["string","null"],"description":"The maximum number of accrual units allowed. A null value signifies no maximum.","readOnly":true},"paid_at_termination":{"type":"boolean","description":"Whether the accrual balance is paid to the employee upon termination.","readOnly":true}},"title":"Paid-Time-Off"}},"terminations":{"type":"array","items":{"type":"object","description":"The representation of a termination in Gusto.","properties":{"uuid":{"type":"string","description":"The UUID of the termination object.","readOnly":true},"version":{"type":"string","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."},"employee_uuid":{"type":"string","description":"The UUID of the employee to which this termination is attached.","readOnly":true},"active":{"type":"boolean","description":"Whether the employee's termination has gone into effect.","readOnly":true},"cancelable":{"type":"boolean","description":"Whether the employee's termination is cancelable. Cancelable is true if `run_termination_payroll` is false and `effective_date` is in the future.","readOnly":true},"effective_date":{"type":"string","readOnly":false,"description":"The employee's last day of work."},"run_termination_payroll":{"type":"boolean","readOnly":false,"description":"If true, the employee should receive their final wages via an off-cycle payroll. If false, they should receive their final wages on their current pay schedule."}},"required":["uuid"],"title":"Termination"}},"garnishments":{"type":"array","items":{"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.","type":"object","properties":{"uuid":{"type":"string","description":"The UUID of the garnishment in Gusto.","readOnly":true},"version":{"type":"string","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."},"employee_uuid":{"type":"string","description":"The UUID of the employee to which this garnishment belongs.","readOnly":true},"active":{"type":"boolean","default":true,"description":"Whether or not this garnishment is currently active."},"amount":{"type":"string","format":"float","readOnly":false,"description":"The amount of the garnishment. Either a percentage or a fixed dollar amount. Represented as a float, e.g. \"8.00\"."},"description":{"type":"string","readOnly":false,"description":"The description of the garnishment."},"court_ordered":{"type":"boolean","readOnly":false,"description":"Whether the garnishment is court ordered."},"times":{"type":["integer","null"],"readOnly":false,"default":null,"description":"The number of times to apply the garnishment. Ignored if recurring is true."},"recurring":{"type":"boolean","readOnly":false,"default":false,"description":"Whether the garnishment should recur indefinitely."},"annual_maximum":{"format":"float","readOnly":false,"default":null,"description":"The maximum deduction per annum. A null value indicates no maximum. Represented as a float, e.g. \"200.00\".","type":["string","null"]},"total_amount":{"type":["string","null"],"format":"float","readOnly":false,"default":null,"description":"A maximum total deduction for the lifetime of this garnishment. A null value indicates no maximum."},"pay_period_maximum":{"type":["string","null"],"format":"float","default":null,"description":"The maximum deduction per pay period. A null value indicates no maximum. Represented as a float, e.g. \"16.00\"."},"deduct_as_percentage":{"type":"boolean","readOnly":false,"default":false,"description":"Whether the amount should be treated as a percentage to be deducted per pay period."},"garnishment_type":{"anyOf":[{"type":"string","enum":["child_support","federal_tax_lien","state_tax_lien","student_loan","creditor_garnishment","federal_loan","other_garnishment"]},{"type":"null"}],"description":"The specific type of garnishment for court ordered garnishments."},"child_support":{"description":"Additional child support order details","type":["object","null"],"properties":{"state":{"type":"string","readOnly":false,"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."},"payment_period":{"type":"string","readOnly":false,"enum":["Every week","Every other week","Twice per month","Monthly"],"description":"How often the agency collects the withholding amount. e.g. $500 monthly -> `Monthly`."},"fips_code":{"type":"string","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.","nullable":false,"readOnly":false},"case_number":{"type":["string","null"],"readOnly":false,"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."},"order_number":{"type":["string","null"],"readOnly":false,"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."},"remittance_number":{"type":["string","null"],"readOnly":false,"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."}},"title":"Garnishment-Child-Support"}},"required":["uuid"],"title":"Garnishment"}},"custom_fields":{"type":"array","description":"Custom fields are only included for the employee if the include param has the custom_fields value set","items":{"type":"object","description":"A custom field of an employee","properties":{"id":{"type":"string"},"company_custom_field_id":{"type":"string","description":"This is the id of the response object from when you get the company custom fields"},"name":{"type":"string"},"type":{"type":"string","description":"Input type for the custom field.","enum":["text","currency","number","date","radio"],"title":"Custom-Field-Type"},"description":{"type":"string"},"value":{"type":"string"},"selection_options":{"type":["array","null"],"description":"An array of options for fields of type radio. Otherwise, null.","items":{"type":"string"}}},"required":["id","company_custom_field_id","name","type","value"],"title":"Employee-Custom-Field"}},"date_of_birth":{"type":["string","null"],"readOnly":true},"has_ssn":{"type":"boolean","description":"Indicates whether the employee has an SSN in Gusto."},"ssn":{"type":"string","description":"Deprecated. This field always returns an empty string."},"phone":{"type":["string","null"]},"preferred_first_name":{"type":["string","null"],"description":""},"payment_method":{"type":"string","description":"The employee's payment method","enum":["Direct Deposit","Check"],"default":"Check","nullable":false},"current_employment_status":{"anyOf":[{"type":"string","enum":["full_time","part_time_under_twenty_hours","part_time_twenty_plus_hours","variable","seasonal"]},{"type":"null"}],"description":"The current employment status of the employee. Full-time employees work 30+ hours per week. Part-time employees are split into two groups: those that work 20-29 hours a week, and those that work under 20 hours a week. Variable employees have hours that vary each week. Seasonal employees are hired for 6 months of the year or less.","readOnly":true},"historical":{"type":"boolean","nullable":false},"employee_code":{"type":"string","description":"The short format code of the employee","nullable":false,"readOnly":true},"department_uuid":{"type":["string","null"],"description":"The UUID of the department the employee is under"},"title":{"type":"string","nullable":false},"hired_at":{"type":"string","nullable":false,"format":"date","description":"The date when the employee was hired to the company"},"hidden_ssn":{"type":"string","nullable":false},"flsa_status":{"type":"string","enum":["Exempt","Salaried Nonexempt","Nonexempt","Owner","Commission Only Exempt","Commission Only Nonexempt"],"description":"The FLSA status for this compensation. Salaried ('Exempt') employees are paid a fixed salary every pay period. Salaried with overtime ('Salaried Nonexempt') employees are paid a fixed salary every pay period, and receive overtime pay when applicable. Hourly ('Nonexempt') employees are paid for the hours they work, and receive overtime pay when applicable. Commissioned employees ('Commission Only Exempt') earn wages based only on commission. Commissioned with overtime ('Commission Only Nonexempt') earn wages based on commission, and receive overtime pay when applicable. Owners ('Owner') are employees that own at least twenty percent of the company. ","title":"Flsa-Status-Type"},"applicable_tax_ids":{"type":"array","nullable":false,"items":{"type":"number"}},"member_portal_invitation_status":{"type":["object","null"],"description":"Member portal invitation status information. Only included when the include param has the portal_invitations value set.","properties":{"status":{"type":"string","description":"The current status of the member portal invitation.","enum":["pending","sent","verified","complete","cancelled"]},"token_expired":{"type":["boolean","null"],"description":"Whether the invitation token has expired."},"welcome_email_sent_at":{"type":["string","null"],"format":"date-time","description":"The date and time when the welcome email was sent."},"last_password_resent_at":{"type":["string","null"],"format":"date-time","description":"The date and time when the password reset was last resent."}}},"partner_portal_invitation_sent":{"type":["boolean","null"],"description":"Whether an external partner portal invitation webhook has been sent for this employee. Only included when the include param has the portal_invitations value set."}},"required":["uuid","first_name","last_name"],"readOnly":true},{"type":"object","additionalProperties":true,"properties":{"current_home_address":{"type":"object","properties":{"street_1":{"type":["string","null"],"readOnly":false},"street_2":{"type":["string","null"],"readOnly":false},"city":{"type":["string","null"],"readOnly":false},"state":{"type":["string","null"],"readOnly":false},"zip":{"type":["string","null"],"readOnly":false},"country":{"type":["string","null"],"readOnly":false,"default":"USA"},"active":{"type":"boolean","description":"The status of the location. Inactive locations have been deleted, but may still have historical data associated with them.","readOnly":true},"uuid":{"type":"string","description":"Unique identifier for this address."},"id":{"type":"integer","description":"The internal ID of the address.","readOnly":true},"effective_from":{"type":"string","format":"date","description":"The date the address became effective."},"effective_to":{"type":"string","format":"date","description":"The date the address became inactive."},"effective_date":{"type":"string","format":"date","description":"The date the address became effective."}},"example":{"street_1":"412 Kiera Stravenue","street_2":"Suite 391","city":"San Francisco","state":"CA","zip":"94107","country":"USA","active":true,"uud":"sample-uuid-123231","id":3,"effective_from":"2024-01-01","effective_to":"2025-01-01","effective_date":"2024-01-01"},"title":"Employee-Home-Address"},"all_home_addresses":{"type":"array","items":{"type":"object","properties":{"street_1":{"type":["string","null"],"readOnly":false},"street_2":{"type":["string","null"],"readOnly":false},"city":{"type":["string","null"],"readOnly":false},"state":{"type":["string","null"],"readOnly":false},"zip":{"type":["string","null"],"readOnly":false},"country":{"type":["string","null"],"readOnly":false,"default":"USA"},"active":{"type":"boolean","description":"The status of the location. Inactive locations have been deleted, but may still have historical data associated with them.","readOnly":true},"uuid":{"type":"string","description":"Unique identifier for this address."},"id":{"type":"integer","description":"The internal ID of the address.","readOnly":true},"effective_from":{"type":"string","format":"date","description":"The date the address became effective."},"effective_to":{"type":"string","format":"date","description":"The date the address became inactive."},"effective_date":{"type":"string","format":"date","description":"The date the address became effective."}},"example":{"street_1":"412 Kiera Stravenue","street_2":"Suite 391","city":"San Francisco","state":"CA","zip":"94107","country":"USA","active":true,"uud":"sample-uuid-123231","id":3,"effective_from":"2024-01-01","effective_to":"2025-01-01","effective_date":"2024-01-01"},"title":"Employee-Home-Address"}},"member_portal_invitation_status":{"type":["object","null"],"description":"Member portal invitation status information. Only included when the include param has the portal_invitations value set.","properties":{"status":{"type":"string","description":"The current status of the member portal invitation.","enum":["pending","sent","verified","complete","cancelled"]},"token_expired":{"type":["boolean","null"],"description":"Whether the invitation token has expired."},"welcome_email_sent_at":{"type":["string","null"],"format":"date-time","description":"The date and time when the welcome email was sent."},"last_password_resent_at":{"type":["string","null"],"format":"date-time","description":"The date and time when the password reset was last resent."}}},"partner_portal_invitation_sent":{"type":["boolean","null"],"description":"Whether an external partner portal invitation webhook has been sent for this employee. Only included when the include param has the portal_invitations value set."}}}]},"x-examples":{"success_status":[{"uuid":"d7282d99-ab6b-42f5-ba45-f4a670e886a8","first_name":"Boaty","middle_initial":null,"last_name":"Koss","email":"keena.feest@kiehn.co.uk","company_uuid":"e904cc79-818a-4da8-9d37-0be0a86fdda8","manager_uuid":null,"version":"a5cec1f1c0135feb3e76ca6ea3c46176","current_employment_status":"full_time","onboarding_status":"onboarding_completed","preferred_first_name":null,"department_uuid":null,"employee_code":"46f036","payment_method":"Direct Deposit","department":null,"terminated":false,"two_percent_shareholder":false,"onboarded":true,"historical":false,"has_ssn":true,"onboarding_documents_config":{"uuid":null,"i9_document":false},"jobs":[{"uuid":"bc875f9d-adc5-40f6-99db-ed8470bda25f","version":"863bcd01c51fcfa2468d604cffec7413","employee_uuid":"d7282d99-ab6b-42f5-ba45-f4a670e886a8","current_compensation_uuid":"2ec164d0-808b-446c-8120-8cfb500945d0","payment_unit":"Year","primary":true,"two_percent_shareholder":false,"state_wc_covered":null,"state_wc_class_code":null,"title":"","compensations":[{"uuid":"2ec164d0-808b-446c-8120-8cfb500945d0","employee_uuid":"d7282d99-ab6b-42f5-ba45-f4a670e886a8","version":"db7bfb49a4f0893432cb562311bfcad9","payment_unit":"Year","flsa_status":"Exempt","adjust_for_minimum_wage":false,"minimum_wages":[],"job_uuid":"bc875f9d-adc5-40f6-99db-ed8470bda25f","effective_date":"2025-06-09","rate":"80000.00"}],"rate":"80000.00","hire_date":"2024-06-09"}],"eligible_paid_time_off":[],"terminations":[],"garnishments":[],"date_of_birth":"2005-06-09","ssn":"","phone":null,"work_email":null,"current_home_address":{"street_1":"412 Kiera Stravenue","street_2":"Suite 391","city":"San Francisco","state":"CA","zip":"94107","country":"USA","active":true,"uiud":"sample-uuid-123231"},"all_home_addresses":[{"street_1":"412 Kiera Stravenue","street_2":"Suite 391","city":"San Francisco","state":"CA","zip":"94107","country":"USA","active":true,"uiud":"sample-uuid-123231"},{"street_1":"123 Example Rd","street_2":null,"city":"Example City","state":"EX","zip":"12345","country":"USA","active":false,"uiud":"another-sample-uuid-456789"}],"member_portal_invitation_status":{"status":"sent","token_expired":false,"welcome_email_sent_at":"2024-01-15T14:30:00Z","last_password_resent_at":null},"partner_portal_invitation_sent":true}]},"title":"Show-Employees"}}}},"404":{"description":"Not Found\n\nThe requested resource does not exist. Make sure the provided UUID is valid.\n","content":{"application/json":{"schema":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided ID/UUID is valid.","type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["error_key","category"],"properties":{"error_key":{"type":"string","description":"Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error."},"category":{"type":"string","description":"Specifies the type of error. The category provides error groupings and can be used to build custom error handling in your integration."},"message":{"type":"string","description":"Provides details about the error - generally this message can be surfaced to an end user."}}}}},"x-examples":{"not_found":{"errors":[{"error_key":"request","category":"not_found","message":"The requested resource was not found."}]}},"title":"Not-Found-Error-Object"}}}}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-id-employees.api.mdx b/docs/api/get-v-1-companies-company-id-employees.api.mdx
new file mode 100644
index 000000000..7d31b49c3
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-id-employees.api.mdx
@@ -0,0 +1,73 @@
+---
+id: get-v-1-companies-company-id-employees
+title: "Get employees of a company"
+description: "Get all of the employees, onboarding, active and terminated, for a given company."
+sidebar_label: "Get employees of a company"
+hide_title: true
+hide_table_of_contents: true
+api: eJztfe2S2ziS4KvgOHdR5ThRpe+P+nGxdW27p3a3bUeXe3r23A4VSIAS2hShIcCStQ5F7Gvc692TXGQCIEGJUknl8t71jH+5TIGJRALI70x+CeSK51QLmd2y4DqYcx0+dMNYLlc0E1zZvzYzwUK+XKVyw7kKWgHjKs7FCt4LroMfuSY0TYlMiF5wUg5sEZlFkuZMZPMWobEWD5zQjBHN86XIqOasRRKZE0rm4oFnxM7W/i37LXsjNb8mP8jlimcKMSSMakouV3RDcqp5i6zoZskzTYpM6BYCznkKUEkieMrUC5LzVc4Vz7QiimdKIAYOP3ifiCyR+RLht8mvC56RnOtc8AeRzauRv8sIZ2/BAhW38MnlPSBy3yL3FpUZoAL/j4s8h//HHv6zohAMf/QeqvsXhOacyCzdwNRFnnFG1oAI0LI+9jrnlN0TFcsVJ0IRkcVpwThrk/cLoWAP5FqRjSyIloTGMVeqWgPQB9ax5JoiJddCL2ShCf+8kgqW6yircANwlmtyX26nmT1oBZrOVXD9IXhVnoiPreBzOC+UlqHINJ+bIxXqzYrDQL6MOGOcBa2Arlb+EHx1RXO65JrnAPVLkNElD66Dv4Y/IsCbd7fhX3iu4Ky1AgEHbsEp43nQClS84EsaXH8JzFSB0rnI5kEr4FmxhKl7nd4w7IzC7hBmYjyhRaqDa//5dvc8v+TmgHKFe8Co5mFEFWfk5t0teTC4EKqUjAUeN6AkkD3HATFN0za5TUgmM9ymVS4fBIPDjmPoapWKGJd/ociHpcjEslj6sD9eLrReqeurKyZj1UbCtmO5vHKEDFd0k8s0xd+v6EqE9k2Rzf9kAYbe4xeARqE4awfbVknh6nI7wq6oXgStIOd/K0TOWXCt84Lvkuf9gpNffrl96e67BXNkO7bepKmMq9vg5v1bwfNNbeKEpmpv5tci1TyvGAyJNoQSteKxSERMVrlY0nxD1jL/RNw8J6JlCfotsDKQT8RDcZrHixkcwDPRuCEGHNx9AwV5qzCMREa/81hfKALzqFORkbmeRZszEbmTua5TA9llm/xAs0xqEnE8iubWeOttk7crw+ZInHO4WDOqW4iwL0lmSlNdnLoEyyJ3l8A/r1LJeLmCvSXtwaZ5TpESmi/VMY5D07TG9gFTeLaQSz6jjOVcKdwBd/0Q01bgRIY/Dh8rLZczI3GCVrCSuabpTGQPQlcs9HMI07+s9gFR3EflOrg1BEGBzZOEG6nMkI/VxuLp4TReoNQQmdKcMrjzKKrw4huMa6+1yc+GlOqI7Go3k6SOHPxIyh+JXlBNFvSBk4jzGvfVkmgQf+7I7ZK2AgtIw6MdzmVg+6oLsMsd/n5oh+rQHYALVVLHX8feflZvlxfmgpgh5NiWV++ZH0n1IzH3w9dsWlZTAO6wBBmSN7zGuKYiVagnrGius8ZR9vJtt3tS0ycDXCeugHRU61xEheaX6gXwIjxQJZlzrlYyU7xNfipSLVYpJ9IcX1SKYrlcUqI4KAh6R3hZhsCfxq1VnUHphVScrBfSnDA4FykH9Cu208RvIilTTrMawynxmhmF96vRA6yAGHB/NnDYUbxdlvOQmzcvnXKtJaObF6eiWqnh34CGeEtBt885AWxYkZq7GnFSm/hMVGe4xm+FcDUP3oM1DnEP4fyj1m0ZpyE3ueSf8eQr38Q5vOSTtwdUEfWY4DpXTsG9fYRYRgrTlKgiUlwDs6zopiVJuI4Xtbu4ovNzzzkokfCa4b1CVSzDmmFFZjUo0JvXIk1JKikzdibqMooUWYoWTsZWUmQaBFbMFYC1u9VuIjVaHzyva39oTZyD/5sC2SiIQ4vNCvglnfM2eS1zsqS/y1zoDVLPIqjMOqwRAqTsDY9j+LEVKB4XAAhNox+MwLpB0+6m0Ivg+sPHrWd95WpN505td9wVj0Gv04F/6qtQBUJKihSFZqZ5plFxqEyUq98VDP1ywkmjafo2QTy10CkMeVWJZPuSodaeC+E9Cg1rrJubJhNCM08iZwTtQdjTzyH/TIFF47R2EU4vvP6CNye4Dti4N+mx6TSk0SgKB71kGEZ0MAyTAR2NO3wyGdFJ0AoSkSvtVIX/KamGRS0FYymfiUxoQdPgOivStBWktBr5LxLlOV9SkQbXwSfOM9pOOFf6nz4JvsjasWwXnzxlxGLFp51BHI+n4aQ7oeGA0Uk4Zf1x2Il4h05GCWOI1ZJmdM5z+5aZ3lpzQPthzONu0o073f4w4VGfj0cxHXHajwej7njkaSuGguidcBQKkiJNZ1qg3rmvWV/7z0pZCIpIzhOe55zNfJoZ3BhIaW2cIB7Kbv9mMXKtYDBKOn1Az3lMllwvJNDlpciBp77k4I0wJ8RBdMA8ueFupV7L2YrnMS5vQXO+kCn4BtzvlZpgL8VCKC1zEcOm2jELqmZKZW6Et3gm4wIQULNYZomYV4fLICSm5RALbdsKfpeRcWTYDY/iyXiYTFlIWTwMB51kFE6nLAo5mwzGnYjR3jAJ/M2djPpRzDrdeNhN4oT2BqMJG3UGMQid8aDbDzyynnfUD7qlwCPC4+5owDrhpDOJwsFgFIeTbq8TTuIkGnY608GQdbx9A09XcB38G6c5ngw0vR0JH9sVOGh8to5nsXzgyGQNPavnKVXKnhm795al2AvlmTQVpU9cwhOJV20Qi8ZREg2mdJB0JtP+oN+Lo+Go1+92oySmbHqQTEmqaHXLXn3myxWcdMp+L5SeJTKfWefNbA0i1ZHLfwgL/oiHbHbe+SqNvRkYe54LrAP45ubZpNPpdNqdTgBCZfcZXJ7cf31gX4fBPBVzEaV8tqKCIW+ZySQxyHoKlEV/TvNMqAXeLfMEoM5kMotEDmIN5FWFHd5O2PrVQmblkQBFeGb5r3lijJvZnsHkyYaS+iBpQC7JTzyb8c+rmrBf8zQGKw+hz2DojOpy0d2wO3zfHVz3O9edzv8KrFxYUaXWMmczI8XwBUBrix5OsKeaEEPWAbcGNLNVDv54LbgnxvY9DcfdcY0SE4yHt1lqL+i2LvT2dMR98eeGfKiwgKUFH7c1odgAye7PQQCNiiHPFWqg+LIznncXaL3enoMVXV/FCqhM1CaLwd4tFCj+EddrNEiKnKiN0nyJWjr4Y1Wb/JssyJJuCHinClD4jTvBnxvDFNmGSL0APa/IV2AZXPL2vE2WNP/EtcjmL0Ar3pH3525f5ZOouyPs34xEm8YNresLZ5G76fRcKGIhNs5W8sJTluc8Ic5zvrePd9y4DT5UXmwyLwTjZzrCBePLldQ8izcvrPOz9IEQmZGFXMMRKbfY+CWb1ufrHmfR0qNfBcM5YV18q2lGX7fZMwt3Z/p1wfEc7h6SCkjzHIfEcrXEasbmNR6amRK9lsQCJx7wnXNtLy1S3ngS0dYwlmUZdzS+YZqRu/AHma8IzzTYUoAkXjGf85+1Peg7+UNyFU+RfdrxWFDV6NhqPCkNRsGu7ejf7Gq48z7uUBWUnGzjrMMDnvMDVgdlS5HNvB9F5n4G1YCnif/jimd20INoHGB+YId/gRXnx0eA1sqKJugl4rNoM/NWvzuOrqnQ+AeuLucPgq9BnJbkwUOMatiRzWkyUI5b2j/guMKEX+0BrA6Jt5ElaMIKjCvVfKHHNJWzhU7jrHZBDeuvWV2nXwbp4uXgoFmS23C6t/ymle5Mvy0tvCMuN2ur/LOMGjwfz6Hk/S6jbyaXDaL/z6Xyds9Qe7ImDE7zhYgXjnQk4qnM5qqRhJ6Nsz9hNfqgVxNerRI4ShzWVBEAzcApnnPzJ1Cj3M5taeQeuUgNCNiUBueG2cUHYe7NVBrsZwgTIxZ3tEQXdAfABOZ7oGnBjacz4gQcyBCgywvu/LVw4T4LBdwPNwP/o0oMS0HctDn5gX05fLh9ZwFmtzx2heqW+3l2i5eQVOo9TXjUdqMBhyN+mrPtiab5HyHBo3rieZqHXEM8T5OUU6VJ77/tqoT792rb5CJ6ipIqlIleK+L8E0h7UAN5DqFWnyo4E8QkrLqOKACyv1K1ENlcy4xc/nrz4jGEPd/VWccnF+oTwbcJvH0EU5H5OOHMbfIO6MvJg1BCkw+7v18o8jPA/wHhQ6CiYuPr9bqdZqK9pu25fLgSmSpymsX8CrPBQsArRLy4uvL/EyYyDy2GoY+gNypMpfxUrP509QL4QMppnpGlzHkzEXdce49Gtc4KJ+ySsPSOPIdEPgj871xGV47IJ+gwdclcI+ExEf1N9IKTZz8kg07RDWSa0pzQpSwyTcBTasOGldww0rlRBp01FcogGlsei3lhu4vMkW3c7roNUULLdcbzlhGYaiGLlIE0v3hHN/GCx58u2p7d9mdZgHP7V84h3PWTzDBbxrq83RvoKqz5vw8bgqVj/I6mNBeckTcy4+6h//dbQDNoQWB0KRTeEKALKSHs/lC93MiCX//r3Y0zYY2QFmonv6nE6fLCzHLxwouPQ7oD7islifjMGVEwfEP4A883mGG74rmQzIODvg4QPeA0J5cX+4t+0gwuIzrmkJNQwocBqJ3aGG+U8jaBHUw35PLikSmd3rIADwf8ZZItz5mq2hDOvCkuL5q3EPAAkYGhD2KycNFthPLavbEDdpeiBw9BM3QP8Dkrw7MIK8E/Lkxet5c5AYkOcp1VmpBe80xvSqfZrqMsqIJer1NFwzs8luF7uDTb/XjOk7hEPQPw0JF/bbcdgwa131pmuDVClMnFQ9Z+YcwdhNtk2xxj1igZPLNlFyEAdzBm9qiOepsxyG3giogG0R07XmcmMO4/l6MNMzgngZWfkO4dF2mZb7LvmK8H7/ZUmhN2yZ9+LzFxbwntY3rSc6g6PjrGHVsn/BEwSEAj/tqnHeJHz2wzUtttPdPpg1nrx9OTR6IBG3T5MJx0+3E4GI95GCWUh/0Joz3Kh3xM+7Wg8HDEOp24O55E8bg/7Uc92uuMOBvRyYgmcTQIakHbuJuwaNAdh3F/QMNBn47DaS/ph0M+inuduMvGdNAQqqZjPkmmURx2WLcXDvhwFEbjyTTsdHv9wXA0nkw73SqaO64it2fFo5tCxX0IeyLwJ0SrHR+7k4leA1t8lc1FxiHHqRUsUPjUbF1vH/gwGdFxNAnjKeuEsMwQHoXwDB7Bk9o+TCfRmI7iIRvwftKj3agTT9mEj5MRHUaDuF/fB9bjw2RCu2E0iMfhgE07Ie3zUZhMo148ZBPebdyHaJJMaSeKwy7v9cNBMhqH8WRq8LPb0Kv2oTds3ASrN9U3wdduvtk+3DgWEuwwqJnjet4O0AGbRnQah/1eHIeDOO6GdBjF4Ygng5iNhn0+prUdiOPhNGL9yXjKRsNhEk0HHdpNRtFoPEx6Jj3C34FJMkkiPg4H0xELB9FoGk5GSQcoy7rRuE87k1FFyuejZHcSdnth9yglTTbLLiGrs8k4p0OahDxmo3AQdeMwGjIeDuMk6bF+pzfuQ+KIgRWM25judwyV7cdtJSkDv/gt2DaIlnotTQPzBF8DKCfH7IRCsIbgb62GBll1WVDTGAlqTN5zYS7fHN4VSG6x/1rV6zzGoavqkFoWy/tu/3rQvx5M251OJ+yMr/GkFCt2ZPCwUxu8k6rX7QynfTqi4bAzjMIBpaMwSvqQ/cFiFnPOIl6XAbwbMTYZDOlg2o/Hg2lnkkx4d8hG3e6gO5pCNMCCHkXd/rBLeyHj/WE4GEynYTQdTEASRDTqjQcjZGtK55zrWTe4DvqdDunnjNzho+q3HtznMtLc72KeFyaMBnc0I6/BkyNULAProoKDdRO0gn8XK+CWg25njCsvMg3+4OCXO/jVJq/bG4BpN7MMc15NRtC0P+r0J31Mn0xNHMvWQ9g7QxseP1eKizuKzg3y9+9leWJOibPXyqQS3+FRUtE5O4xx5IpKnXa8OwxrS4+mMtRPy5PsEgRBDIhyFSU7cjVGxiB1i3M/K1dIRlNTw+Q8G9WAYOtfrUcx3PqX7fTgzNZdxNMmOM2K29qbe8rA8lKftAeuNBYYwLbhBj9qWN3ZhH21d3Rs2MjuFOYWIXAnIZ529Lb7zGdXNJ2BUvIMGLV2SQSb4Emrxy7uS6o5OhjQ9Q8OBh9fCwmA+lLt64BaSGhSW57/6Ea/t8GRKs+jupq3ma2CKW+bV17DOOZGtEhUaMyNURrihDigSsw2hf4NZu6ykd2I7A+JeKN5ul9Wd0C5skWZfpihCdahrNznDaygbxCPmEySI5GVepLoSTExv1yzPo1JBqucxn+h9lCDMQCVGXci/lT+588yFVCsZf7flFWzkqmIN7OvxLFEz4Brlo9mpq9MmjllJhrHeUHTx2PZVuGuTKkDAQWY+N37t0h8jBTABMAem31fbv56yOQ0opYFVhYIIlDNCHET94t1qR/DwJWZnESDIkvF0iaJ7WPmZjUgD2zHMVwMuifiYj01+2gkWDGXxRtwKFdaXcPuHCVMRFMI9T7v7hzIUP6MZvTXzWyhHMYAmqBAFeENASA2HUWJeWb0gEw6EAeyPwRI1ZlXsnBm2oNDxy4PM0mRccl6nK1YycwvLW0WEc48fkcFC9+LJQ/fJglWcdaLKp6XodN6zeszh8p92P8wFtw3iFl7Cd9WmaNaUyg8PnDjT9SSmpJ4LupzQTLxHNvbZFpaj3xzJhPcAeuDeo6JQQ0uQWJLEfs3KvSQZSYScp8XmX+DZ3YP72EQ2jsY1ruvu+LubXE3RroKXezmqLjkg2eJu1Wrg/IZAqqJTNDrhqflwAIaafjIdBDfB5dM/RjZmL6LbOoFFzlJBNjMJsr0ICjmASRJGG/ilLt4FyYMmIlMAPhRSDKzD90dheipq49vB4fiNI7zvfc4MYytl44d5ns7Pcq8t1rE9wowzooYuWgLI7YmqG5iVApG2vgsrsUMBsdDLpd+6vD/+Y//DXwe6xv4Bs4oxBDL4V4/oEpwgcqAM0A3KSBgkWNkMaJKqDbxUUaANFW2V4ETghXuBsaGU4jjG6SBc4VG18DQtjJRcpkBezLpDT4tbceNItehzBmk3Lm8FDM2XoiUlYUQMicRjT8RTT8D4DtoclKVb9jSCSjZz1xQWOS7wXDT1QKFI5w2H5kmT/FziB5vjn+kJK1vI3x8Yh5LmDoqeKzXqanRmBMHMscamr05RdlkB8qIcBKTGoB3t2mZhlxQAJ9Kqk9j1TZZa/8AtckrgfhRj0VgyxPLQ2rZXuC0tGoW8AOomEIkWgSrfX4LJu1O57egvdeO7mmJZtWTJsyNS7nI9cxe9acIFl9a724LwCYWts3+WPrZDx/KJhdfk9q+y0rBGbda2e5UtZ26nWcyN268is9ajcEIXPf0VEpY1M6iTCUqC7i8jCdQYMtT48ukWYaWquHtgMcpx/UREu1JCmM4Z1mx3DGRRJkW45lIjx3aHuYXwLFtHTLiYPMlVD3vXssGc+8rF3xTLhdn9BZdhhBEwq2lvsdPTqGHTc60Jry/V6ev6Yl75ucOfv3GdUc+u4F5ZlTNKj723NfActEqlVQbZ7bBzeOfpl1SqTjtrDyoK4Azg+KXE4oLUX2ZWfUFRAFnPKfpTNPPs1TwzIVH6w8KBrOAGhOgJ58JLfOZh4EHyY7CWs7akMaqvgbHtNMQ0X0jkxrrMIEuj6vuqEvA0Gsr3NOAbxgTNiq2q8pBma5t/+bd41Lxcie5roCdGrBqrElaQymAhraZpsiCRhGUQNarY8xPQqmiTF/eR7xNbuboBUPfO9jAD1RYi9D20P3x1Xty9dC98il2VaPWPXRfrWVe7/rojiyvzFrGBNy1yYI2/zF1vfbR+7WIsbcBWdoUaUyVTjf7jq4/yzWRibY1ZNQsMJZpip2m4BlEFqAqB0NWVsHAq/1fh52OmSDdkPB/kHs7yb2Nl612S1OOKYGvb9/dmVqUpqRDWx+DBxMSWS2e/4kb1pDh0hAFpWo/Gn1aaV2tcBaXcmeX8irDbmN4N3+AshvbEGyfTqAO1akQpWJuTnpIcj+SvZRKG6qqkkolV7AjK1vt6w467sUzkOUtco9b4JPgYEVt3T57+XXUUGBT/idRI+dLoTU4k77pSfm5nOYPRB3PC+25JEJcZWhX+agXx3sTx+60Qd1z4+xQ1O+IWvVLL6Pzu7WjLlzvCr6xwzg6LU1JpDe3CxBgStWJTvObWovWnU51e56KJovbS+nxsZmdZp1XhbhV7p5r9me9DsZBhdF+6Ac/57qWCFRvMbttBQf79zgN6zhOt9mq0EZxKXOOvCn8OK3mn3XZigwDZfbGmR5QmOrJhPQPj9n+8DWAKusfjhrJ4MGBfW38RXGQo+BWlVWvZHfZ3QFsjkDdZAQHYONH26kWFmzPkjRhaYIraJO3IP7XAlylAK4pMb9sy7lzf7AL+aEjYrfLbo5bqkcw13cx9CmH926nzdZJTM4Vxrs2eWdUWKwPdSKB3i53bzwf3NZ2+Xo0mwXsmhhb3PitZGi6phtlv6Cg7H3UG9sT3ah2pnfYsVZWzQ0OT45P+grkbsD5aEWDV05vSwHt69W12WuP+IOpqvMzt8yjPaVoe7QZ5CnGk98vElJNTSZJkYEKYaqYZgubaFH9bH9YpYUqf32guUDM4BZSbPJ1qnnknKzVEg70mmmT10Wahmjme22UIaG53/nvtnZtZfXyNnlHc707GJsWr1KhTXwLzJV5LouVurZdg9F/jSB7nbA3tUApgjQ1Y7vjkFik16kNbZO/WIJ4k5ukIlthRzV5wOo+6JttXrmzhNvBt+ooMTL6f0kYiAqAWgbdFw60vKh6YjZc7v3jtNPV85QzrhagzxhniDEp9lsEHVHm9/pyfW36jNeda7f8FbfqaMnaPkWQ+gfS8faWVbqErMB7QhMRm03gvr2BGDDGs9kBJrqP8fda3O+1uN9rcZ+nFreaGt2HotGk2WMDu7qg1YNBTTuhkelBN139Jv106HsP+5+J2M15LvlPsxm1/1mKypbaTxU6zGkOi/q6fD/05QrfuLDd31C9QOfsA8+xh7zVpm3TOJNCknJmwxO1FrBPa4boURbhIZksTFMk29xS9pTIAX6ByqpfB2QFqhxwHcpNs/PZjoMgOZQL/R1sV/vNkHGTgZnKNWKDeS9m7raxfx7rknv+xmCrKc1z0JYOf9NkzaOFlJ9wxzDbWzmPe+27Ms96PRr9JbW2vH5j3QZzbN9HQUsH/zvv5tkCrtpdbP6QzWPF4vsFMyeVwDxL5cyJMz2WZvxILc1piO0W1ZzVpc1V1/whSxZaJ2bd/JKJv0FgsnIKl5fJldcADWqgqnyA/fXDb3iHK/W9hHM0Qw+cYEfzQI4r4N5EJOIxpPmXsHfaF2j5vPO4opYTuyQ8z4K2XuK5f9+DQbdH/kXwnEL1KX3gmel9WhWg3hVCc9Kfdr9B8WlRQMGsQrxCOIBQZd/rw1Rwgvr7G162acc6+fom2Rrgvd9qXe3x122DP+3PcsnDG8sxt81fMTs9Ffs7f/3OX7/z1+/89Tt/beav3w3h74bwd0P4790Q3sLRO97z5cP3b7p9/6bb92+6ff+m2/dvuv3DfdPtkLPy/xv1WRzSnw/4Bz78MXCvYdnt9ckrI6DJz6yGoN0lg5kb84NAiesQe/XXEjHskHgEMXs9LGY0wxTq0MfQNFjEA/qH/t7fR88AulvIdeisIPy8+rYVDDqD/TT+N1KT17LI2G/Zb9n72rfWc65kkcfQZhyLQbT5tEab/EQ/caKK3Bio5XetMB1CoDYmWPu37JxvAB9AivyWEfK1eN2+vKqj1lAM6sdOeJ5L09SlbmnZ52c45Pagzj7xDZpJms9lvjkwB4561KCrelGtF9yuGV8nMo7xi2HvNytQYrCATSjyiW8qH4/RpanWuYgKza9Qx+ZQQZHzlOoqJQRBmoIQh/UZqGF/Blt/YiDhR10cKLdJymKOWVECGmGBqWOrngtlP3teQCqzzQM14xc0Y9hmS2Beao6up3ledZlccqVO6ib8ziFiC1cIjWShPaKGZM4zKMxx5LSgHZaqyBMaG0zBPMoYftWt7B1ct0gyCbK8yJh/sD7U9j+wJ94/L9fei97iggMXBMxBuB/4QnunHegbqUO8ZOErmDR8a05tia5acfqJU7UJQYcPQQvLBSroqUCswALMVKlgGaTdl8O9jQhraaVwFWw5coCZDv5QZbL36qDMR8jL91280g06hGf5gsHX8HdrSMwxPXtFUY2AtPWy1vzqi7PFBNtelSke6PjIQb0zymQO9pyrtqYrYYqtQ8aXWHHdkGa6lEGdqgZeaNRL+BkWdQBwI8x3OWZ0HoK5gp/9T77fAbc1x6/hw+/lBYHJ3Wfk0dPNad7g6LUgwpQ/8JTQQi+As8Rld9k7/IDh18xgIByYABu1JcaL62oCgFJQZFBTxJ0K2wUtAbRM9Ta54/mDiLlH6apWHu/9FQ68YjA1sOcQ/x/KBCkMr+55RqxXSEuTgXyhyCt7zMk729r95t1t+UE6XMZ/sSKSxigirdfgpZuV/MxTey0qJ0KJ0z9VJwOdPFLpJc08OD9y7eUoYRsel9+3l+5eCmp8i6bpbjoldLkojd6WLY83DqnS4m6ZD+CRuXjgWZnsBIrFG6n5NfEbEJtAxiVkW4EN0ap9tMSlZhlBZJLhX1R9hdDjpgRiUOYyAqSaz/VXcCPlXOeCP4CIKEdCqzuYHRuOKO6S7S/vAZH7Frn3DTP4/0GTGH/0Lc37F1U1ickd9/1Z9bHXEAi5JyqWpruW83/ZPHRsPKWw2gIkCt6jag1AH1jHkmuKlIQ4EAgs/hl8I+Z7AkhZhRuAs1yT+3I7zeyVJgRlFFerlAq8vMiGvlgG+SF46JY+KoG88Lpikp6xjDrTQioN73z5Ajl3v+TpdguP/1ZwkF8fvgRMKEhbY83VTv5RfC1SUEiqMxxt/M4n7lNxtd7Sh1ZkpEW9w3UlIZD3Ph9itrvOUVTsoK/E5MZWJOBHZTnN44Xt5OF1DLlQ2FJQHcfHvI1dgp6Ozh0kZdfIYup1oLESKCJOm8OopTeja7GrrknV37SFaPt8x9lhxxcicz2LNk9fxK11O+uaUlWqypfqBdAXM+jL++jKpdrkpyLVAmxWV89j+uAsl5Qo8Fa6rykfWYHlBF97PlV9J0wFwXphe/40fbv3OFqVn/QZEQN8TOMeykxDabjNl+Vc5ObNSydttGR08+JEJGfWA/BNiYhRDZB5UOBhW1Ax23PA80Qfxbg27lvjWk2GImRtqkrqDdHgcKMj0BCcXPLPeB6VL/UPr/aRDaoGzhD80xddduVWRQTBLzAxq5RsSRKu48UjVw24r3o6CuYrnXNbmCNUxS+s/lFkViqAdoQfMU0lZUbBQuas3GdMecZWUpj4WMzxk4peJ8ejgmT+Faf8TdnzxuFjWmTMuflO05L+LsF4QOpaFJVZiU2SAVLjlyiO4YjqfYXiR6906zyd4NL1an9Bmj6ZaJTbRkyc0yarHTmHoafQoCdtwSlGI85C7iU3p9s6PjCiayoPQPV37bx2s3fQcQEDwFeD/fAybIVYfTK+ZcZ4LrQLRT64TxR5sM/sAEZXIqyaiP3JAgy9xy+wgEk9KrL+GqLVE968uw3/Ym2vnTNpBoJBiAEN99ueX7BmqP/46j14Cer2Y2kv2j+8UsP67n75Yka8ByftdltuNjpt0R2y/b89cMh5
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Get all of the employees, onboarding, active and terminated, for a given company.
+
+Note: Compensation data (pay rate, payment unit, and related fields) represents sensitive employee pay information. When retrieving employee job data, these fields (`rate`, `payment_unit`, `current_compensation_uuid`, `compensations`) are only returned when the `compensations:read` scope is included. This allows you to access employee and job metadata without exposing pay rates.
+
+scope: `employees:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-id-federal-tax-details.ParamsDetails.json b/docs/api/get-v-1-companies-company-id-federal-tax-details.ParamsDetails.json
new file mode 100644
index 000000000..02a817035
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-id-federal-tax-details.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"string"},"description":"The UUID of the company"},{"name":"X-Gusto-API-Version","in":"header","required":false,"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.","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"}}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-id-federal-tax-details.RequestSchema.json b/docs/api/get-v-1-companies-company-id-federal-tax-details.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-id-federal-tax-details.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-id-federal-tax-details.StatusCodes.json b/docs/api/get-v-1-companies-company-id-federal-tax-details.StatusCodes.json
new file mode 100644
index 000000000..941382eae
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-id-federal-tax-details.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"Example response","content":{"application/json":{"schema":{"title":"Federal-Tax-Details","type":"object","properties":{"version":{"type":"string","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."},"tax_payer_type":{"type":["string","null"],"description":"What type of tax entity the company is. One of:\n- C-Corporation\n- S-Corporation\n- Sole proprietor\n- LLC\n- LLP\n- Limited partnership\n- Co-ownership\n- Association\n- Trusteeship\n- General partnership\n- Joint venture\n- Non-Profit"},"taxable_as_scorp":{"type":"boolean","description":"Whether the company is taxed as an S-Corporation. Tax payer types that may be taxed as an S-Corporation include:\n- S-Corporation\n- C-Corporation\n- LLC"},"filing_form":{"type":"string","description":"The form used by the company for federal tax filing. One of:\n- 941 (Quarterly federal tax return form)\n- 944 (Annual federal tax return form)"},"has_ein":{"type":"boolean","description":"Whether company's Employer Identification Number (EIN) is present"},"ein_verified":{"type":"boolean","description":"Whether the EIN has been successfully verified as a valid EIN with the IRS."},"ein_verification":{"type":"object","nullable":false,"description":"Information about the status of verifying the company's Employer Identification Number (EIN)","properties":{"status":{"type":"string","nullable":false,"enum":["pending","verified","failed"],"description":"The status of EIN verification:\n- `pending`: The EIN verification process has not completed (or the company does not yet have an EIN).\n- `verified`: The EIN has been successfully verified as a valid EIN with the IRS.\n- `failed`: The company's EIN did not pass verification. Common issues are being entered incorrectly or not matching the company's legal name."}}},"legal_name":{"type":"string","description":"The legal name of the company"},"effective_date":{"type":"string","description":"The date that these details took effect."},"deposit_schedule":{"type":"string","description":"How often the company sends money to the IRS. One of:\n - Semiweekly\n - Monthly"}},"x-examples":{"Example":{"value":{"version":"string","tax_payer_type":"string","taxable_as_scorp":false,"filing_form":"string","has_ein":true,"ein_verified":true,"legal_name":"string","effective_date":"string","deposit_schedule":"string"}}},"x-tags":["Federal Tax Details"]},"examples":{"Example":{"value":{"version":"5521489cc7c93732300805dcf87a5fd3","tax_payer_type":"S-Corporation","taxable_as_scorp":true,"filing_form":"941","has_ein":true,"ein_verified":true,"ein_verification":{"status":"verified"},"legal_name":"Company Name LLC","effective_date":"2024-01-01","deposit_schedule":"Semiweekly"}}}}}},"404":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided UUID is valid.\n"}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-id-federal-tax-details.api.mdx b/docs/api/get-v-1-companies-company-id-federal-tax-details.api.mdx
new file mode 100644
index 000000000..19ae11b13
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-id-federal-tax-details.api.mdx
@@ -0,0 +1,71 @@
+---
+id: get-v-1-companies-company-id-federal-tax-details
+title: "Get Federal Tax Details"
+description: "Fetches attributes relevant for a company's federal taxes."
+sidebar_label: "Get Federal Tax Details"
+hide_title: true
+hide_table_of_contents: true
+api: eJzdWN9v2zgS/ld43IdNAct20uTa+umCJO350M3mmnT3gCRwaXFkcUORKn84Fgz/74chJUuynUWKBe7hnmxRw+HMNzPfDLWmq2ThrdOJUA4WhjmhVeKqEujknkIxB86B08cBNWBLrSxYOlnTk/EYfzjY1IgS99AJvVqxopRAGkk6oKlWDpRDWVaWUqRB/+gPixvW1KY5FAz/OeEk0An9CBwMk8kdWyWX4JiQlg5otIfq+R+QOjqgpdElGCeiMUswVkSFtaB1RqgFHewYeJcDSb0xoBypNxGdEZcDiaqH5BYgPN/X74VakIUXHB6PcudKOxmNuE7tMGA2THUxajBKSlYZLWV4PxIcilI7UGn1hmTaEKEybYrgPtGK5PqZOE28xeOEJZkAyYd0M6COrWYlq8DMojONU/etV8pLiSHpe/d7zhxB2eATWxFQTrgquJPqomSqIsIOya8KJSYPKiEXyYU2pY5Rx4XbvQUtgSDcRoDTBpc+f76IPzfhRxTCASclM06Bsbkog2ad6OfO87m1OhVbtXfGWwfQvP0ECqO+q+RfWoRIKecN4MK1VsmN0ZlwNVJsLmHG7Mym2pSdBJhrLYGpvQz4PQeXg9nBBNECTpglTPUhGJI7tiIhHAFaSxyiXLCKzOHlbUSoVHoOk4OY7qH++fMF+pMJKdRihnnyulxGSUwhTub9MGPCZbGSQiZEzb3Qfzg9Jkf/9sw4MLLqSRtw3qig/U0UPSVH50p5Jl+UQ/tzZmcg1A+Eobb3Z0uuilJqRHnKMW2zminItS/mYMjR1fT6DUaqNGCRUDYDCkLNlmBEJoD/YOivptckZ5bMARSxPk3B2sxLWZFGYYgqWTIpeJB+Fi4PW6dfbof906OlHQu2NIV1ihlKJxmTFnYtmnYogc21d+EA65jzFms4qK+QgTqxfSVWeyQZ1R7Kqz0rQfkC+aYExaPIFuYBzZiQsSHs52NrOkLWRSek3Lda4bcJuauD0JVBmsFAhMgo7YLHEpBcjnS/ZLmGKFKBIzlbAlYguj0M5zTmdg76C9EOKqPbtcJOKKbXhAsebCmZtT2HhuRCFwWygbUeLGEGyBwwnqAcGOBIE9oYSJ2siDZBS8Fcmu/HXMKCSaJYAUO62WwGNCzMcOF1XNEqaFperTwkc5ZB6sQSZpy5VypEyciGLgcLhMduTZzWTyQqDIXCodRWuBn2eu7lK7T/Uz8TnTlQvZhbUNySQiuosHM20Wk5jZCE3EIhngGeZBWff9HK5bKiiNgqgTighCqoh5UwPzDpoTdItJbtduPem53uU5dPj8Zb+S07OuNhl73iWjem7cbd4HRh24W2ebeJDju2sFjJ9VQVmlkzVT1i3F8NyNnZyfHp+w9p+i798Pbd25O34/H78RlPs/fv2FnG3x6Cqtf4DiIW3e4D9uH0+HVoHWLghuVaxtopFXpRp9M1VgI23gMAn4xPTpPxcTI+Pgxym2UIdMD6dHy6PxBfa0c+aq84wWx8UFg2Br57sEhqBqz2JoWWzWAlrBuSX9gTEOtNnERLo5eCAydfv04vsQUGmho+qJDUSPHB+ymnE7oAlyyPk1gyAmz9r5oJntSde4Zh4tvJum/wR3BpjkzlnBFz78ASAxKWTLkwU7AOI3UmAbDDB/WgbKpLmJBvzaGdE8FODDD+DdsSM6wABwYzc03rsLSG0gHFuNOSuZziteO7F6aNeufK0CvIzSGOCpDt0d320P8kn8LV5/xmmvxWp3p9eg6Mg+mdf7CHX6InhVBhMoykmMwZjmTnN9PtJYPV0y/w2Foq7U0QSJmUQzLNiNIK4nwToz2IMp1L08+W3BdCicIXXd0/eC9hpUjaq81PtcKksxzGLBwqh/RltNsh4WR8cpaM/54cn8WZIGNeulhDzfpm84jF/ydUhFxlS2BPwGyVLIz2JZ3QOn/u2Kq9CXblMIqJXoIxgkPMfjRs5UChIzG/nqCik5cvuYOG7LqXXUyRZt+uWdsNB8w7vK9vZrsfzUVkCnC55lv7Q95P6Gh5PNrW8Wjd1sdmdLiSLZhlU1TeSMzhOjFYKWJeJByKkBx7hX8Jhd5BN+pLBFqG+4J3Lyg+qPPGaP4nOkt8jf5bSL0RrgqW1/R8Hoa0c49Q3D92pW4xI2PHOiC7zVM0scnfcCsAZkI9922sVSQSliAJ8y7HibruJ5sBva2sg+KvnBA1vHDABtkm090PIIGRsMDj2F233041DSgyjv01uwWzFCl04tEWf7hOjILgiOPR2CeS8JzoLMQBt+7dkUCmugCcr4Id4bIRq4LcRBoJ3MN16gtQLrjxt/o7D0vDd56aWy+bU8kXkEEOkxQKJmRIqPrtP9r8QTRKbV3BVEfPJ3DkEGfsmL5uPzX9T7pYnQQOVm5USiZCtoTqWNcVfE+XxwGZuobpgE56Xe5QGT8OaK6tw93rNfaRr0ZuNrj83YPBEnlEAjEiXtju15QLi/9f6E9dWI6+1K3sDXmpN77gV70YJRr6ooOa6zpObXCorFvnjxn3f95HD8Ia4Ts8hGxRbnsKslDpOu/2vqj2usmnqzu62fwXADasHw==
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Fetches attributes relevant for a company's federal taxes.
+
+scope: `company_federal_taxes:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-id-locations.ParamsDetails.json b/docs/api/get-v-1-companies-company-id-locations.ParamsDetails.json
new file mode 100644
index 000000000..98c61c310
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-id-locations.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"X-Gusto-API-Version","in":"header","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"},"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."},{"name":"company_id","in":"path","description":"The UUID of the company","example":"7b1d0df1-6403-4a06-8768-c1dd7d24d27a","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","required":false,"description":"The page that is requested. When unspecified, will load all objects unless endpoint forces pagination.","schema":{"type":"integer"}},{"name":"per","in":"query","required":false,"description":"Number of objects per page. For majority of endpoints will default to 25","schema":{"type":"integer"}}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-id-locations.RequestSchema.json b/docs/api/get-v-1-companies-company-id-locations.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-id-locations.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-id-locations.StatusCodes.json b/docs/api/get-v-1-companies-company-id-locations.StatusCodes.json
new file mode 100644
index 000000000..ac1c7f62b
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-id-locations.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","x-examples":{"success_status":[{"uuid":"04552eb9-7829-4b18-ae96-6983552948df","version":"7d9753112507b9dda4fb97910f39b06e","company_uuid":"6bf7807c-a5a0-4f4d-b2e7-3fbb4b2299fb","phone_number":5825710808,"street_1":"412 Kiera Stravenue","street_2":"Suite 391","city":"San Francisco","state":"CA","zip":94107,"country":"USA","mailing_address":false,"filing_address":false,"created_at":{"type":"string","format":"date-time","description":"Datetime for when the resource was created.","readOnly":true,"title":"Created-At-Type"},"updated_at":"2023-09-12T16:42:25.000-07:00","active":true,"inactive":false},{"uuid":"fa94a2fd-11a8-4024-87ff-85c587d9d2b4","version":"15e6b9680e00f3122729e64e3cef3224","company_uuid":"6bf7807c-a5a0-4f4d-b2e7-3fbb4b2299fb","phone_number":2866070827,"street_1":"644 Fay Vista","street_2":"Suite 842","city":"Richmond","state":"VA","zip":23218,"country":"USA,","mailing_address":true,"filing_address":false,"created_at":{"type":"string","format":"date-time","description":"Datetime for when the resource was created.","readOnly":true,"title":"Created-At-Type"},"updated_at":"2023-09-12T16:42:25.000-07:00","active":true,"inactive":false}]},"items":{"description":"The representation of an address in Gusto.","type":"object","title":"Location","x-examples":{"success_status":{"created_at":"2025-06-09T13:43:49.000-07:00","updated_at":"2025-06-09T13:43:50.000-07:00","company_uuid":"10593a6a-505b-4aa6-bf31-15dcdceedbe3","version":"e1bdd845a493c74908f8e15d6114169b","uuid":"6b1351a2-de35-4499-b948-43abab274634","street_1":"300 3rd Street","street_2":"Apartment 318","city":"San Francisco","state":"CA","zip":"94107","country":"USA","active":true,"phone_number":"8009360383","filing_address":true,"mailing_address":true}},"properties":{"uuid":{"type":"string","description":"The UUID of the location object.","readOnly":true},"version":{"type":"string","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."},"company_uuid":{"type":"string","description":"The UUID for the company to which the location belongs. Only included if the location belongs to a company.","readOnly":true},"phone_number":{"type":"string","readOnly":false,"description":"The phone number for the location. Required for company locations. Optional for employee locations."},"street_1":{"type":"string","readOnly":false},"street_2":{"type":["string","null"],"readOnly":false},"city":{"type":"string","readOnly":false},"state":{"type":"string","readOnly":false},"zip":{"type":"string","readOnly":false},"country":{"type":"string","readOnly":false,"default":"USA"},"mailing_address":{"type":"boolean","description":"Specifies if the location is the company's mailing address. Only included if the location belongs to a company."},"filing_address":{"description":"Specifies if the location is the company's filing address. Only included if the location belongs to a company.","type":"boolean"},"created_at":{"type":"string","description":"Datetime for when location is created"},"updated_at":{"type":"string","description":"Datetime for when location is updated"},"active":{"type":"boolean","description":"The status of the location. Inactive locations have been deleted, but may still have historical data associated with them.","readOnly":true},"inactive":{"type":"boolean","description":"The status of the location. Inactive locations have been deleted, but may still have historical data associated with them.","readOnly":true}},"required":["uuid"]},"title":"Company-Locations-List"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided ID/UUID is valid.","type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["error_key","category"],"properties":{"error_key":{"type":"string","description":"Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error."},"category":{"type":"string","description":"Specifies the type of error. The category provides error groupings and can be used to build custom error handling in your integration."},"message":{"type":"string","description":"Provides details about the error - generally this message can be surfaced to an end user."}}}}},"x-examples":{"not_found":{"errors":[{"error_key":"request","category":"not_found","message":"The requested resource was not found."}]}},"title":"Not-Found-Error-Object"}}}}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-id-locations.api.mdx b/docs/api/get-v-1-companies-company-id-locations.api.mdx
new file mode 100644
index 000000000..fd4c21414
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-id-locations.api.mdx
@@ -0,0 +1,75 @@
+---
+id: get-v-1-companies-company-id-locations
+title: "Get all company locations"
+description: "Retrieves all company locations (addresses) associated with a company: mailing addresses, filing"
+sidebar_label: "Get all company locations"
+hide_title: true
+hide_table_of_contents: true
+api: eJztWVtv2zgW/itc7sO0gGlLsnyRnzaYTgfFzk6LJp1ZIA2ylHhkcyqRGpJy6g383xeHuliOnSbdGSz29pRYPDz8ePidCw/vqYWsNtLt6Or6nn6ry4qr3UWWgbUXtdvQ1fXN/mZEBdjMyMpJreiKvgdnJGzBEl4UJGsmkUJnHAUsecGFMGAt2JeEW6szyR0IcifdhvBOfkVKLgup1qSXHpHcf/moBp+0IXfafDqoH5MLYqVaF9DNJCXfEQtmC6SsCyerAvw8XhQjUtWm0hbs+KP6qC6lyuAR1NwAsXVqwVmi88PAiNQWiNsA+aGXBSUqLZWzxOmP6noN7uaFgXy1Bse2Ievn9v/dSvESIV3XleAOGumq/pI0V0QqIbdS1LwgBjJthN+EzXQFK/K3ZgsS7MoAF3+jI/qZrWvrNJPKwdp4VcztKqCrawplCkKAoCPKq2ooYunNiFbc8BIcGOuZoHgJdEX/yr73Ci/evWE/gbF4/iMqkQQb4AIMHVGbbaDkdHVPm6WodUaqNR1RUHWJS0dBNGPBnIUz6rmU87pwdDX8vn/IsVeIpZQKrDc9Go2l3IIgF+/ekG2D5YRdO10bL5DxohiTNzlRWgGRllRGb6UAMWpkeFUVsjH2N5Zcl1LJsi6Hum9ebJyr7GoyETqzY2/YcabLSWdIVvGd0UXhxye8kqydKdX6j61CNvj8EmHUFsSY7ke9hVse3krRGbbibkMfmuNqA+TDhzevkJloj3YaGvkzL6sCVS3SUAQiD9k8DqYs5sGcLRfzJctCIRYiikW04HREDfxaSwOCrpyp4fHz2w9QVnwNHb5fazC7Iz05LyycQ4zTiNtwh1tHebAOxJj8vAFFamUryGQu8VDuZFGQQnPhnVOnv0DmLKlVge7deRvJtcnAolqp/NmNz/HPUxvM8QY8Vb8G/491mYJBe3doKjB+R2PyWhtS8l80Bk6UOIQDv4+W4cRpEs2+jPDm4LTG3vF1dygGbKWVBYuzoiDAP8f4LmsfpemIZlo5UA5FBrSe/GJR7v50dW4M3/lo0XLHL2IbfbfWcVc3QaCupaArGsSzWQRpwhbLKGFxGi4Zh2TO5slyOptFSbwUOR3RluZIRJEsZtMwjGbBIk2E4HGeJoskDPJpkgZz8Jgb2rdLzNN8sQwWGeMzHrA4jwVLI1iwaZ6mcRpFSZKndESrjVZwq/zJ0NVsGc0WYbAMliPkLIC7DemKxmFE/izBcHLpDN+CqnHBViDylpMOyDQJEYdPffSSK/LacJVJm2kvzR2a6tsLOqJ/lxVdJXEYLBB3rZzBKR8ucazNYbdtJuq5lJ//nBnAYHXL3bl4mWtT4gj10c7JEk7iwCvuAAfQFcgduhFGAwNW1yYDcsctadcYe4pz8VYVu45VTjofKb5tRNiFY1eIYT+iTV5qkGFgnrIgYWF0Fc5XcbSKZuMgCFiwWAUBJpDMyS10WqXqfvtdote1x5rzJOZRLlgY8iWLgyhmy0Wes+Usmy0XIhFRGh8xJ5zBPE3mywCCIJ+GUbSIEpjHMM0gn0ZR/DsxJ1rO58EiWEaLI+bM45i85jvyk7SOn+PMMo4OnHkvs02plRjQ5aeeLtE0CpcP6DI6x5fGhP/LdLnZj6h0UNrTGHflwVYGLCjnoxpGW676wk8q4gsURN+ap4nW9IC+q9qejHj3R/buq5MguQqnq3i6ipOjXT00wbHwLDgSfsDaMJglUz7nbBbMUhZzPmdpPg1ZOBOZyABECtMjx4AwFWIZz3icTLNFnATLfAnhTMzDMA7nCVK8d4hwOgt5xARMZyyOk4SlSbxk8ZSnPI0W8Xwa0yPaT4OATI3AcAngjnl/UXHjSlCOTMPl18RL6gMmPY2Yx2Q49ku6DIJkOg+mS9z9Q6doZpz1oP1+RCujKzBONofbWOPUab5cVnUFeJvzT51iPziU5yjPamPQel3B2q7TqieX0Nwsrg+lI1nXUsBXVp9SQFlpByrbvfS+LlUTHfyaimz0HVYjzUVGWpJLKHwd+oCYz7YXrjGoQ1H53UZmm2MrplBotbZjggYkUmVFLUAQmZ8VQyX99fCs6Y/Zcgr2MOHxkhRVkEZFv4sOyZi8b4tCP3RyRxyTt14XL/w4lFWhdwADATTpwbWeRLgfOlsnfX0QV3VR4J3pdFrjiM9bwPvmc0S95z5HsHfqZ51Bd9/DALA/48G9klTrArg6od1le1GwJ9SRdkjDb+zDpsI/R739afA5Kb+fDyn/HRCNHppo/1R18FQhMMTbanqY2H+b0lYTKu1i/pMHjR7apOOHEXlM3rR1w6Bls+FbICmAIgIKcHiRTGvXtIMc3sS8wEZap43MeIFtBH7SNHAbKM+Gm0Ol8h8FfD+82143mRCLrL6ca0jF+nYW+0FaR/d7nBkH8SnZf9SOvNa1r3Wffdt8RAX5qAj5qJrSru0IHCpSocESpR2Bz9K6MfkL/4RdOdOkya6JQ968mvg0JC3Z8kKKc/Xf0AZgjDZNn+uoSmi/n96N+4L0Sa23nwAnZNzBWpvdI2t4qScd6hBU7jbQ7tlPJzrLamPH5GpXIR+KXZPHP8GOSAHKNbNQnjtnZFo7mPQtPWKg8Kxx+qCyyf4d6q+AhhpQ1jc+vCbiK51WVXdItkW+NrquJEY0rgTJOEY43wZDNGktC0EyrG7KVn7DlfDxUqqmVTfoVHrMJViL7agnIb/rgAhwXBaW8FTXbmBURtagwBzM2aruUNra5DxrkHKFXR4EjpZrfOX4OqG0u829kwyIdX10/rRl/JAvq8HEweboIw6CVzb0Dz9hTPc3+4Fn/6gd807GvsNF2duGtS1cJKU34xu8J7St6r6JzA6dyENHGt2Kr3Ef/TXKe9FnZivgn4DbHcMOG9NbMEYKaBT7tqQDZb08GqHZ/qP96RHd8qJ+uk+NvYVjVU3XrJ/fRO6D0GMw+wkeLrbhSnAbLXr8vgu7opNtOOlNNLk/2Gg/GRrJPz60512bAtvjbfnOK9lU70xA6Uv40zQKpabHNm30MX+hw3m+Y/yI4rM63xktvqCzwmHcdff8c4lhu+HxmUeg3tNw8a6h6dMhcOM7q8erdxmmgC0UhNdugyGqvYbvR/RyZx2Uv2WFRsMjC/jUnWuvtfUM3yXA9v7RrXrwADGi+N5g3+aXYLYyg4GlD5cvH0AmXnAicGl0KeZ/M517C+PUh2B/hiLTJWAY8Ti+seS7luXkXXON8y8PQmd12XU6/tDmWp75XNv2sV91q5L3GNNb+gFWvZ4q7eifDszwV2NtXcnVQM/34M4/gz0Ef39I+P9/9/t3ffdrfcfBZzepCi69k/lwcd8Gsmu6Dfs2FBYmI7o6enoqhuF9o63DOff3+OT2wRT7PX5uXk4wxglpeVo89nYy5My/7BnorA2aNNC+XnUR3wfT5+/gd3wI+hJGH+QOEG/wh5GI8Sst/qLrYbwkj78ankXS1cBeoofSIRzQxfds2wfgrwP3X/2s+8UDPv+UfsTJRhDTYuUGYyfXrKNy5fvvrrBUOs6ifdZs/8FDOnu69/eNxJX+BGq/7w/b4W9fXe7/AfPMwUQ=
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Retrieves all company locations (addresses) associated with a company: mailing addresses, filing
+addresses, or work locations. A single address may serve multiple, or all, purposes.
+
+Since all company locations are subsets of locations, use the Locations endpoints to
+[get](ref:get-v1-locations-location_id) or [update](ref:put-v1-locations-location_id) an individual record.
+
+scope: `companies:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-id-pay-periods.ParamsDetails.json b/docs/api/get-v-1-companies-company-id-pay-periods.ParamsDetails.json
new file mode 100644
index 000000000..f1b7c4234
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-id-pay-periods.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"X-Gusto-API-Version","in":"header","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"},"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."},{"name":"company_id","in":"path","description":"The UUID of the company","required":true,"schema":{"type":"string"}},{"name":"start_date","in":"query","required":false,"schema":{"type":"string","format":"date"},"description":"Start date (YYYY-MM-DD) for the pay periods range. Defaults to 6 months ago."},{"name":"end_date","in":"query","required":false,"schema":{"type":"string","format":"date"},"description":"End date (YYYY-MM-DD) for the pay periods range. Cannot be more than 3 months in the future. Defaults to today."},{"name":"payroll_types","in":"query","required":false,"schema":{"type":"string","enum":["regular","transition","regular,transition"],"description":"Comma-separated list of payroll types to include (regular, transition). Defaults to regular only."}}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-id-pay-periods.RequestSchema.json b/docs/api/get-v-1-companies-company-id-pay-periods.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-id-pay-periods.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-id-pay-periods.StatusCodes.json b/docs/api/get-v-1-companies-company-id-pay-periods.StatusCodes.json
new file mode 100644
index 000000000..e52b2f9c5
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-id-pay-periods.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"type":"array","items":{"description":"The representation of a pay period.","type":"object","properties":{"start_date":{"type":"string","description":"The start date, inclusive, of the pay period.","readOnly":true},"end_date":{"type":"string","minLength":1,"description":"The end date, inclusive, of the pay period."},"pay_schedule_uuid":{"type":"string","description":"A unique identifier of the pay schedule to which the pay period belongs.","readOnly":true},"payroll":{"type":"object","description":"Information about the payroll for the pay period.","properties":{"payroll_uuid":{"type":"string","readOnly":true,"description":"The UUID of the payroll for this pay period."},"check_date":{"type":"string","description":"The date on which employees will be paid for the payroll if the payroll is submitted on time.","readOnly":true},"processed":{"type":"boolean","readOnly":true,"description":"Whether or not the payroll has been successfully processed. Note that processed payrolls cannot be updated. Additionally, a payroll is not guaranteed to be processed just because the payroll deadline has passed. Late payrolls are not uncommon. Conversely, users may choose to run payroll before the payroll deadline."},"payroll_deadline":{"type":"string","format":"date-time","description":"The date by which payroll should be run for employees to be paid on time. Payroll data, such as time and attendance data, should be submitted on or before this date.","readOnly":true},"payroll_type":{"type":"string","description":"Whether it is regular pay period or transition pay period.","enum":["regular","transition"],"readOnly":true}},"readOnly":true}},"x-examples":{"typical_pay_period":{"start_date":"2024-01-01","end_date":"2024-01-15","pay_schedule_uuid":"7b1d0df1-6403-4a06-8768-c1dd7d24d27a","payroll":{"payroll_uuid":"8c2e1ef2-7514-5b17-9879-d2ee8e35e38b","check_date":"2024-01-19","processed":false,"payroll_deadline":"2024-01-17T18:00:00Z","payroll_type":"regular"}}},"x-tags":["Payrolls"],"title":"Pay-Period"}}}}},"404":{"description":"Not Found\n\nThe requested resource does not exist. Make sure the provided UUID is valid.\n","content":{"application/json":{"schema":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided ID/UUID is valid.","type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["error_key","category"],"properties":{"error_key":{"type":"string","description":"Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error."},"category":{"type":"string","description":"Specifies the type of error. The category provides error groupings and can be used to build custom error handling in your integration."},"message":{"type":"string","description":"Provides details about the error - generally this message can be surfaced to an end user."}}}}},"x-examples":{"not_found":{"errors":[{"error_key":"request","category":"not_found","message":"The requested resource was not found."}]}},"title":"Not-Found-Error-Object"}}}},"422":{"description":"Unprocessable Entity\n\nThis 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.\n","content":{"application/json":{"schema":{"description":"Unprocessable Entity\n \nThis 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.\n","type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["error_key","category"],"properties":{"error_key":{"type":"string","description":"Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error."},"category":{"type":"string","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."},"message":{"type":"string","description":"Provides details about the error - generally this message can be surfaced to an end user."},"metadata":{"type":"object","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.","oneOf":[{"type":"object","description":"multiple entities","required":["entities"],"properties":{"entities":{"type":"array","items":{"type":"object","description":"single entity","additionalProperties":true,"properties":{"entity_type":{"type":"string","description":"Name of the entity that the error corresponds to."},"entity_uuid":{"type":"string","description":"Unique identifier for the entity."},"valid_from":{"type":["string","null"]},"valid_up_to":{"type":["string","null"]},"key":{"type":["string","null"]},"state":{"type":["string","null"]}},"title":"Metadata-With-One-Entity"}}},"title":"Metadata-With-Multiple-Entities"},{"type":"object","description":"single entity","additionalProperties":true,"properties":{"entity_type":{"type":"string","description":"Name of the entity that the error corresponds to."},"entity_uuid":{"type":"string","description":"Unique identifier for the entity."},"valid_from":{"type":["string","null"]},"valid_up_to":{"type":["string","null"]},"key":{"type":["string","null"]},"state":{"type":["string","null"]}},"title":"Metadata-With-One-Entity"}]},"errors":{"type":"array","description":"Will only exist if category is `nested_errors`. It is possible to have multiple levels of nested errors.","items":"circular(Entity-Error-Object)"}},"title":"Entity-Error-Object"}}},"x-examples":{"bank_account_delete_unfunded_payments":{"errors":[{"error_key":"base","category":"invalid_operation","message":"FundingMethod has unfunded payments"}]},"bank_account_verify_incorrect_deposits":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Your bank account cannot be verified. Please check the test deposit amounts."}]},"bank_account_verify_already_verified":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Your bank account has already been verified."}]},"bank_account_missing_routing":{"errors":[{"error_key":"routing_number","category":"invalid_attribute_value","message":"Routing number is required."}]},"payment_configs_missing_parameter":{"errors":[{"error_key":"base","category":"missing_parameter","message":"At least one parameter must be provided"}]},"payment_configs_invalid_fast_payment_limit":{"errors":[{"error_key":"fast_payment_limit","category":"invalid_attribute_value","message":"Fast payment limit should be a number"}]},"pay_periods_invalid_end_date":{"errors":[{"error_key":"end_date","category":"invalid_parameter","message":"End date cannot be more than 3 months in future"}]},"company_industry_selection_naics_code_required":{"errors":[{"error_key":"naics_code","category":"invalid_attribute_value","message":"Naics code is required."}]},"company_industry_selection_naics_code_invalid":{"errors":[{"error_key":"naics_code","category":"invalid_attribute_value","message":"Naics code must be equal to 6 digits."}]},"company_industry_selection_sics_codes_invalid":{"errors":[{"error_key":"sic_codes","category":"invalid_attribute_value","message":"Sic codes must be equal to 4 digits"}]},"time_off_policy_name_required":{"errors":[{"error_key":"name","category":"invalid_attribute_value","message":"Name is required."}]},"time_off_policy_unlimited_invalid_accrual_rate":{"errors":[{"error_key":"accrual_rate","category":"invalid_operation","message":"Accrual rate must be blank for unlimited policies."}]},"time_off_policy_pending_requests":{"errors":[{"error_key":"time_off_policy","category":"invalid_operation","message":"Cannot deactivate policy with pending time off requests."}]},"time_off_policy_employees_required":{"errors":[{"error_key":"employees","category":"invalid_attribute_value","message":"Employees are required."}]},"time_off_policy_unlimited_balance_update":{"errors":[{"error_key":"base","category":"invalid_attribute_value","message":"Can not adjust balances for unlimited policies."}]},"holiday_pay_policy_already_exists":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Company already has a holiday pay policy."}]},"holiday_pay_policy_not_exists":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Company does not have a holiday pay policy, please create one"}]},"holiday_pay_policy_invalid_employees":{"errors":[{"error_key":"employees","category":"invalid_attribute_value","message":"Invalid employee uuids provided."}]},"onboarded_employee":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Cannot delete onboarded employee"}]},"invalid_attribute":{"errors":[{"error_key":"base","category":"invalid_operation","message":"There is an error in the request body."}]},"company_cannot_enable_contractor_only":{"errors":[{"error_key":"contractor_only","category":"invalid_attribute_value","message":"Contractor only cannot be enabled for existing companies."}]},"company_missing_parameter":{"errors":[{"error_key":"base","category":"missing_parameter","message":"contractor_only is required."}]},"starting_after_uuid_invalid":{"errors":[{"error_key":"starting_after_uuid","category":"invalid_attribute_value","message":"Parameter 'starting_after_uuid' does not correspond to a valid event."}]},"resource_uuid_invalid":{"errors":[{"error_key":"resource_uuid","category":"invalid_attribute_value","message":"Parameter 'resource_uuid' does not correspond to a valid resource."}]},"payroll_gross_up_invalid_net_pay":{"errors":[{"error_key":"net_pay","category":"invalid_attribute_value","message":"Net pay must be a number."}]},"payroll_accruing_hours_invalid":{"errors":[{"error_key":"base","category":"invalid_attribute_value","message":"Hours cannot be negative."}]},"payroll_cannot_cancel":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Payroll cannot be canceled."}]},"frozen_payroll":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This payroll has already been processed. Its data cannot be updated or altered."}]},"frozen_payroll_processing":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This payroll is being processed and cannot be updated at this time."}]},"unmodifiable_payroll_type":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This type of payroll cannot be modified or processed. It is reserved for system processes."}]},"invalid_employee_uuids_format":{"errors":[{"error_key":"employee_uuids","category":"invalid_attribute_value","message":"Parameter employee_uuids must be an array."}]},"maximum_employee_uuids_surpassed":{"errors":[{"error_key":"employee_uuids","category":"invalid_attribute_value","message":"Exceeded maximum of 100 for lookup."}]},"invalid_employee_uuid":{"errors":[{"error_key":"employee_uuids","category":"invalid_attribute_value","message":"Invalid Employee UUID(s).","metadata":{"entities":[{"entity_type":"Employee","entity_uuid":"invalid-uuid-123"}]}}]},"payroll_blocker_missing_bank_info":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must have a bank account in order to run payroll.","metadata":{"key":"missing_bank_info"}}]},"payroll_blocker_missing_employee_setup":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must add employees in order to run payroll.","metadata":{"key":"missing_employee_setup"}}]},"payroll_blocker_missing_federal_tax_setup":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must complete federal tax setup in order to run payroll.","metadata":{"key":"missing_federal_tax_setup"}}]},"payroll_blocker_missing_bank_verification":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company bank account must be verified in order to run payroll.","metadata":{"key":"missing_bank_verification"}}]},"payroll_blocker_suspended":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company is suspended and cannot run payroll.","metadata":{"key":"suspended"}}]},"submission_blocker_missing_selection":{"errors":[{"error_key":"submission_blockers","category":"invalid_attribute_value","message":"Submission blockers selections required"}]},"submission_blocker_invalid_option":{"errors":[{"error_key":"submission_blockers","category":"nested_errors","metadata":{"blocker_type":"fast_ach_threshold_exceeded"},"errors":[{"error_key":"selected_option","category":"invalid_attribute_value","message":"Selection is not available to resolve Fast ACH Threshold Exceeded. Please choose one of Wire In, Move To Four Day"}]}]},"invalid_version":{"errors":[{"error_key":"base","category":"invalid_resource_version","message":"You are attempting to update a resource using an out-of-date version."}]},"signatory_email_required":{"errors":[{"error_key":"email","category":"invalid_attribute_value","message":"Email is required"}]},"signatory_company_already_has_signatory":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Cannot have more than one signatory in a company. Please remove the existing signatory before adding a new one."}]},"mixed_disbursement_errors":{"errors":[{"error_key":"disbursements","category":"nested_errors","metadata":{"contractor_payment_uuid":"invalid-uuid-1"},"errors":[{"error_key":"contractor_payment_uuid","category":"not_found","message":"Disbursement not found."}]},{"error_key":"disbursements","category":"nested_errors","metadata":{"contractor_payment_uuid":"d0dfa222-ad08-4ea7-a06a-717688c3b179"},"errors":[{"error_key":"payment_method","category":"invalid_attribute_value","message":"Payment method must be one of: Direct Deposit, Check."},{"error_key":"payment_status","category":"invalid_attribute_value","message":"Payment status is not valid for payment method 'InvalidMethod'."}]}]},"not_found":{"errors":[{"error_key":"request","category":"not_found","message":"The requested resource was not found."}]},"finish_onboarding_incomplete":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Company is not ready to exit onboarding."}]},"company_location_validation":{"errors":[{"error_key":"street_1","category":"invalid_attribute_value","message":"Must include a street address"},{"error_key":"city","category":"invalid_attribute_value","message":"Must include a city"},{"error_key":"state","category":"invalid_attribute_value","message":"State is in the wrong format"},{"error_key":"zip","category":"invalid_attribute_value","message":"Please enter a valid zip code (e.g. 12345)."},{"error_key":"phone_number","category":"invalid_attribute_value","message":"Phone number must be 10 digits"}]},"conflict":{"errors":[{"error_key":"request","category":"duplicate_operation","message":"A resource with these attributes already exists."}]},"invalid_parameter":{"errors":[{"error_key":"request","category":"invalid_parameter","message":"The provided parameter is invalid or missing."}]},"flow_invalid_entity":{"errors":[{"error_key":"entity_type","category":"invalid_attribute_value","message":"Invalid flow entity"},{"error_key":"entity_uuid","category":"invalid_attribute_value","message":"Invalid flow entity"}]},"flow_nested_options_errors":{"errors":[{"error_key":"options","category":"nested_errors","metadata":{"flow_type":"company_forms"},"errors":[{"error_key":"form_types","category":"invalid_attribute_value","message":"Supplied value 'invalid' contains no permitted values"}]}]},"basic":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must complete all onboarding requirements in order to run payroll.","metadata":{"key":"needs_onboarding"}}]},"contractor_payment_invalid_wage":{"errors":[{"error_key":"wage","category":"invalid_attribute_value","message":"Wage must be greater than or equal to 0."}]},"contractor_payment_cannot_cancel":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Payment has already been processed and cannot be cancelled. Contact support directly."}]},"time_off_request_cannot_delete":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This time off request cannot be deleted."}]},"resource":{"errors":[{"error_key":"first_name","category":"invalid_attribute_value","message":"First name is required"},{"error_key":"date_of_birth","category":"invalid_attribute_value","message":"Date of birth is not a valid date"}]},"nested":{"errors":[{"error_key":"contractor_payments","category":"nested_errors","metadata":{"contractor_uuid":"72ae4617-daa9-4ed7-85e0-18ed5d0ee835"},"errors":[{"error_key":"hours","category":"invalid_attribute_value","message":"Ella Fitzgerald is paid fixed wage and hours cannot be set on a contractor payment"}]},{"error_key":"contractor_payments","category":"nested_errors","metadata":{"contractor_uuid":"2d7bf62c-babf-4a12-8292-340e2d9cab28"},"errors":[{"error_key":"wage","category":"invalid_attribute_value","message":"Isaiah Berlin is paid hourly and wage cannot be set on a contractor payment"}]}]},"compensation_invalid_rate":{"errors":[{"error_key":"rate","category":"invalid_attribute_value","message":"Rate is not a valid number"}]},"compensation_invalid_payment_unit":{"errors":[{"error_key":"payment_unit","category":"invalid_attribute_value","message":"Payment unit must be one of Hour, Week, Month, or Year"}]},"compensation_already_processed":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Compensation has already been processed on payroll."}]}},"title":"Unprocessable-Entity-Error-Object"}}}}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-id-pay-periods.api.mdx b/docs/api/get-v-1-companies-company-id-pay-periods.api.mdx
new file mode 100644
index 000000000..0a40fe8ea
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-id-pay-periods.api.mdx
@@ -0,0 +1,77 @@
+---
+id: get-v-1-companies-company-id-pay-periods
+title: "Get pay periods for a company"
+description: "Pay periods are the foundation of payroll. Compensation, time & attendance, taxes, and expense reports all rely on when they happened."
+sidebar_label: "Get pay periods for a company"
+hide_title: true
+hide_table_of_contents: true
+api: eJztXFtvG7mS/ivcPsAmAdSyrDix46fNiZNzDJzMGBNnZ7OeoE11lyROuskeki1bY/i/L6pI9k0XW469uxjkYTCxmix+LJJ1J28iA2mlhV1Gxxc30TtVlFwu36YpGPO2svPo+OLr7ddBlIFJtSitUDI6js74kpWghcoM4xqYnQObqkpmHBswNWUlX2qV50OGFEEa+jBgVhTA/p1xa0FmXKYwYJZfgxkwLjMG19gUmIZSaWsYz3OmIV8yJdnVHCSOs2RzXpYgIRv+Jn+T54pNYCYkM9WkENYKOWNCTpUuHJSp0oyzmViADJgG7AqYBMiYVYzPNADSxykQOjcvIv73JctgyqvcDpidC8NAZqUS0jINttLSIMmaEcZyTeNPtSrYa1YoaeeG8ZnCgZB+xi0wqzK+HLLPxrHtkrol+OmSmHAJMvN/llzzAixogxTSOZcz18mkqgRkM/6hwZRKGhiy9zKjMQxLuWQTYFWJHV8GKMJNc1rZSgMNZueggQnDpGK5KIRFVhAiR4jY8ClMTEi2AG2Qr+PR+GU8OohH+wM3DcjFTExySKAoc7UEMJe4zFpMKgvsihumoVALyBx7usDP58ACAVYT8Ivnl402WobcKISEjE2WRCS0TtLWRjN+gdqjXZx9Pmd7i/29lPa4ALN34/65TER2u+eHMXs3/l/uVw0l1/D1uYbpcVnZeLEf1wTipn8cusdN79h3flHvG2InLd4xuww9jjXw7DIaRNfxrDJWxUJamGmaSGyXJUTHFxEUE8gyyKJBxMuy3cREXweR5TODzc48TfwtkNPmis+iY6srGESB5yY6vonGoxH+r3u2P1V0+KdVHg2iVEkL0mIrXpa5SGnIvd8NNr2JTDqHguO/HM6Ia82X0SASFgqzSvucVr3UYEDaWlbw1jEaRoNAS01+h9RGg6jUqgRthQPdnJfWuMZqIWdRX07heM1uHjAh07wyYgGDcHi6I+NK/CzzpePW7SAKZ3HdUIWQ/wI5Qxm5v25g8KfxrmFvB1HJlwnyMqtySKpKZHdP7S2rpPijAiYykFZMBeg28UANz//VXKTz3rBsArmSM7N21n5ntkDUa9EFcdqStHyiKhtGoQOLx3eVx93VDKdl06S72Nax+fPn05PWzFsjC9PnczqH9NsOe4cENikf5GAjmK5EnqN8LbnI2tOkwUUXizBBN0FGikYUsJ7rWuHBgzYfJkrlwOWdjPh1DijKmdJMqu4qzLlhEwDUkOFg50tWDzZkPynUSnNumx9DZ1IkSJB0CXIjG7K3WSZwWJ7ny0FLPpMWsWxWcc2l9foVmVRT/b0ySCrllVd+oWsGPMuFBAJbcofrX8j8GghKfyRfyVQVhZJoWUjURoAoKoNKsuBLls6VMrTtdVWrfDaBqdLrxwwHkLZh+HHd9nBbPTqOkA8xLuPmPTNZ+j0TRjNzVeV46ggWbplmN3k24V4K+4OdBZTc8gEu3Zxx4wwU1NuNARVa1PQ7m03pZurCELZtJz5xc77raITdJiwuuoZZlXPdFi54IjSXhvZJ7/yDrApUVb4byvu6KaqtHrbbdb9cx3DNizJ3MsQuS5HyPEEp6sbp64loPBqjrRKP9qO2UK9/338VrZXC0eFkPxtl0/349cHoZXzAR6/jo8PXR3G6n2WH2fggGx/yqCMxuxItOkrHsA/TcXz4av8gfjXZP4zfHB2+ibMxwBG8fAUvjyZRVzI1qN5EHbEw5bmBdZu16XF4vn90PBodj0b/HfWXtWb5rePhOqPBCpuDs/DjM8fL21tqfzA6WFXoPynLPqDhT7Y4afc/KjC4+zQYVWncoAqcZIBrYeyQfeTfcJeG46jVQmSQOTkuDFvwXKD5vYv1sQEU+00y9r24Tk/2utDWWChIXWhcoosItFaaeNnVdP73LbbSnVSTb4AdUm5hpvRywxjU6s4z/KmEFK0Gg56VnzN1ZypNK22G7Nwdq3zpZMc3WDa2hqH2tX2/V3sq6K+hmgguD5F0ujeg3gEaOWVL5+o4SuQqBFJhkYxHPtOqKoWcGZKRwQcyXhNVIs9YiiZx4dvPucQDRI7NUlWatcxqwlyAMXx2D4l4FoBkYLlAdVVbQ26omM1Agm7Y6UkHlKbSU556n1SS7Yg6bRhOX1fiSWUT8rfbG+uis/6R3/Ht/XLc6tiaXLThgKDThueDOgyj268IJAiIn5SN6ZDF73HQ+Ge3a72sGI9Xj+Vn6UUZRy/vvbTCLp3YEE51O8e+9vTZRGVLXHlaGo+PoUzgQvolN7VqvBSSjmdSb8pkwfMKLgfM22eBwpQWKKvA87ruiSeJ1v5yyD6BOxIX790w7xwPBZivz+fWluZ4by9TqRmSjzVMVbEXXLTgAdL3PYIZp3X3F2xWiQzIBCiUc2kR0HdJvPWsdbLvB3MDc39I7b++1Gan02YgYdilJKGWuHW8dMEqt1bOi/NbnnHmWrJL35T5RVqyK2HnDOhQ+YPx/0Y5IArL0QW421l/Fw63hhwWXFJQhCNNv0GWISrnxL+QjM60CNFXL5EmOQzZB/RgnEYadEgQPmLVpfs/GZ91aJN+QdP4snGivaWFhpWS8POUVNn2uRRVbkWJwUKkiOeod/DCz6uHLXzZ4Uh3xzZCzsLI2I3X/vBZayTnpa8Ze3lPJ+snXtQhXs9RctKbbZMq7cJ5GfqQtBtaDL57hM8rAaQQynBkiKKT3hhFbQheNBRllefR17pdVSZWbW/YkXPrGhjbic+sNmlZIR/97o9/FXYe/ywhdsrPuTjrW330e8c1xaW5HfxY87/CmiOljQq7F8JA4aNkvnTeHwbttqiNITulUEepjKEchVVszhfAajmUwwJyg2vn1UhQFLVYiVKhU3S/nzu4Hbv5RdSe4ZoG0RovYMLlt4SnqaqkTTLIwUJSyWklM8gwGFKAtGaLhzDhBrruwYqx1nETPlQyE3L2EexcZRSqC6OxejRagw6wBWgxXSZC0tZNEWmpjHhUZF/QDMBRmR+1Fbek8QUGFM9y4AYYhVqckYIWq4fDeIEdzXDzFHiOkahlEig+6QSQvX5AF76t57EGYCEMSqhEqwoTddu8QtcikVUxAb0eYs/I7wD9xfVnrr8L/zm163H5nZCkSk7FzNTQaltzJ66t9m6DeWsZLikmLaFJlrLChZlrw2I9sDDbKTc2nJaEcqBbEK5pvDMLPyBiT8MnXZvoLfecrTH7iGaDt52S2oCybrIW23pehtxx6+QULm7MZSeD7LLHDl+d/5RZZaxeJgZySHF3J5KL1CSpyiBpDLONiJvWu/PzJ+zLsO+a7Xg/hH6YpwcYtib8UfEctchrlomZqMXOFrgmADD3gGtE6trujvaTSAmrWQV74ME6rJiMSNR0mpQqF+kykby451oXD2JisW59+yAqSScKsvq88DTVFc8Tvf3MdJrtILnfun4M+9Ucm+QoytGyqvEwAijAbABeAinXxAdStmnHXtdd0L5zhzsDnlqxoAQb0XA+rsfg0kxqOg1RnU2Y6xTWfZa9brz72r+vU2WYBbz3DpjwHDNkictcPkhbb0P1jksKj/LM5TXdaGb7ss9VLjKU6vifAxzMCjJEH9Mq8sVctRlBJgXzCFxWjhBshobh4ieDVedfyJJeB2zASm+yaXCZeNgItVaP9TZ7kq146trU2VuGbpdpxTAIn5ITxTWa4aHdY/IvnGE0+Fk9VA3JQViZzCMiOA9VYxjsIbfUV5aFKDAGl3sazZkVCUiMH6ERZjVPrdKJoszuRmz9lrsf05qA8/ca+8ZhcQUctMtR9tXFXT38T2nH9ua4Rs2F2sKETy1o8vXvYwWs9tqdf2e1Xf1sDb1nzTFuQhMUp2T+oCxAWj+LEFq8L/5O++9C3qF0J+bQunFpKIs+08oYDHeEwSWQM7DN1vEtdjd3gHyE2qIIfkEPElktuCJzVen7GIYPU3X/ROqtkyNhxq1Y9Bnkz3iKejB/RHkTimEaAG6I+nhMtfoTZNKqwng0SeeKyOpKqo5L3iqiOrXGhdNXCqYwQ8ZzC3oD2sRT2e63fxdwgRVgKNyaUiyfaulBpVCjML5GjcBWslCZmAoS2/0yoccEGzJG5cpiOwCOkx2WO0FpQC+8FDdLY6GoGwUZ3rcNSAqYJBR03WknuPbfI4C6lJpTLRmFJz3Ogl+Loir6OE2lXU3cE0J9f50CoBXhMeBK7I9GxNVcqW9VuY2XTwgsGFzBB6A6oefmxTDq5r6avM5FL+heuw9RL1Yexo/xz3h//JJKHNoCbZKr9BvoWvlT0A2vF+y0+XvU1hrDtCO8IdyJAwos4stA9yoa+9N3Y6/i3D6fenEM2Kp8mknxLGvVOj5oOj2Y2+c0hQxTqYnl1085LbQLyQD34+E9FkbjPWyOq7DvsRVdTNgViTz6NDvbMEisEIX+jn3ZAb1+kqYyGIvYMcR+n0lRNbYn3laCd06hgeQgU5mtwbswK0tTx+y2meYr3R8SqquJsECE1YM3PkS0CXCjlb8XbSdd1uNfGM1LYwqh83Se2LkGM1d5loBXPlErf9dHQNOCGuvuvAp8CXXqfMFFzn0yDy3+fAGMYvNv3/2TnQdwLGjGVv6IKswx56Cm7FehgZ3KAfuoFsDOFVaeanbCKR3ZVpj+5tSDzKbafQlEerkjiothTXhRkhNrlTfpGG/qOSrcnGhyqMrGahrTd08wuJliJrlVGkN7XOT3C+txkT8kpMdF3nZ0+wCC3x2iY3Nukvrr40dTXDa3Tnjg4tajMSoP8oDqbeCus7nUeQgeNF181T3WCSDTmYQrJBoMPXENWZIJM6m0AUomNXnrDRNrt97h9LViCyFvtdb62XL2NpG4R2XpSQt0r5Z08MTTw7J9Ph6PY56NjuID4IcxH73m8eH+4eujo/TlZP/wzZZJB2oFZbsfYvu7BJ/rX+tPJzWO2YnAXDg7ccnnAXuHSelh1OdKQIH1EdWDPBCHwvUPos9Z1Gjal12Uz7y17VL8z4ZBhv1f1RsPoqmQwswTH+VE7YqFBM70eoKYtGeQ8/GtwpNtWTN4LyaYK2fFJET6LivMWA1gk/3dV/Ejbh66RJihRHeEULZoMGZlz6SuROn7xiAifcquSmd31YvdkLU+SnylFd6Sdt53f4w/RfmAbe5EMkj0tUMU709RuqTrcxjOhmx//PLg1Ys1R2yuJDy4HuIMe4dqiHDI90edRClWHOQi3RZpWHt4sspVgMOm1GPr6GD6zs7BtMp7m2CVS+H0HPj7BLLXwtpeR3DevjvT1GTQ6rt1wdpsZymHM56rq1Z5A9VybStuaHz7B0cTcMhQzdffEO0YweMMUE/SazJnw5q7db5veH91SKN4QztIKTxoZoumw+/U50EeCNYEQ8boE3vm+zxrbhJIhXf//I1EamWCVplwI9In9s45lfkF+R2sTTIydnNh8cEI09JD3g1cY38Evl354vANs6PPOzP8VywLD3JmRmlR7U1W3RRqjGpFtYLuCWP0ZElsDpL3Ys4OAcbwGVWmp5aZqsSHP1hGxlG+7Gf4vTgKc3AZ0EePQ/eKH1qQ3YBZL5u1rVxMaGOThxW8fMC+TPbKXlakVUb6YZpMhLbz3Uc5obz6lFH32jX2GpTKJpwBSDLnfmnauhb0IUZ8uHY75nDwev8wzjh/Ex9AdhgfvYJRvH8E2atsBHD08tUWkUbZsAc4pXnO2Qdh/5xhKC6jil+64Y/uGsMDS3t43suGGaBnUzhr5hEM6zWOziNzapwdTqavx2k84ZNpfMD3x/HR+M04fnkwgnH2JuWT8dEWTj1MCp0aLvic/R10LmTNJuRLviQWXfnbK/fjULCpw/MttQi9o2Zrc63W1hJWb422d3q76HItktq5lFvrQzvNHuytYe+ex8gwBTtgvwJ8w1CTtHO6evcF+DrUIWjSeVLiEV2lMNA2aa9aCrV7dbRzWzHeUOyOHWoAp7jTZ7D19Z1QKEvX3sO7STRbkr/H0X/F/6D3cN6encb/WcfRBN4GmAPPyJxYedCmvocQni0Yj8av4tFrfDGAnsWi56HcDfzw+23/ssFJeLXI1M9Axcj2jL09O62fVOLGqFRQHpbMebrbhg3wOh9dbJO4F0RTbTRwbVo3RZ8ZdlEISRm8Fu0dr1XyUsS+p5Czv3mCcevnFwgD7+g5f8pzuFmQwNiSk1La/mqL79a5wuWu0mxajtvWoK13Hvygf1Sgu9T8wwmbV7fztsfqAn6q3xBiz798+fIl/vgxPjl5seaFG8M0vtI1ZCduZxhX5Nu8BdZhWKtQ+4mQ12Xd98X97o7y7+YBse4c3bNm7cm1iwXMd8xw64Mhg/DzoPuKSP/qY1Hw2OBrXHS+crzy06o1IIh0jdEHQJ4Hqq13TF50JxyePcGKLbymTy9umRL4N+BmGdOtVseFT/5NERN1myCfYrUArUUGTsCd8eVZLcbg2oI05ACiGHPieuMjYXQdq7r7sTBcoS4p90BY3d89CdM06s+pbtid2/ou3Tk2XbtzReb5QCt9IhmOD2tF2x9sa8l8qgLxAr/SOQp1L/J4KZzEizMoSOytSKQTKFRvcRy92IWS8TPObwPhtTTPNIWNN9Es8TPOO7y/iJwsXNnqmlcY62OBgwdFRS9EAdekulZ2PJKI6V4a45WdYzAiJF0H0SeqlPmeERyFDQNQnMmVSQStT8oXlRLugpALa6vNQYRa0vw8/QR6IVJocbpRWHR1eo8a7mU4NNoIMf2NOS3ju65c94M8VQWl+gjHM8Pe+0NSP7WE+jJTaVWEt+n+zT/IwF3ozou1kzAq+wUvzfv4jEuD4VbxX/+j2RnIjVIZW3DZovMPX+EX5K977LDRhZ0J3DQvQ/x4fPPH45s/Ht989Mc3vfCzcG33ypwLkpIk72+8LrqIFpS7CQCiQXTcsXjbCukrXlIwFnvd3KCt/1nnt7f4s7OAUE1lgjygxgbaeOQf1f7cMNdWyXiwSYOyJt13f7T/2zbn1gm1TOzt06kd+I7R2vT5in9oqoPdcfWe/+KN3Rdss+uzdgrhCju1qKEErK3N527FOC92N3B/ad90685YHw/obBLXEK2k0ra+rTzN1LFf//H+HA3vrlFVG1H+H60nTrqre3PjWpyrbyBvb+vFtvg3BVJu/weehfb6
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Pay periods are the foundation of payroll. Compensation, time & attendance, taxes, and expense reports all rely on when they happened.
+
+To begin submitting information for a given payroll, we need to agree on the time period.
+
+By default, this endpoint returns pay periods starting from 6 months ago to the date today. Use the `start_date` and `end_date` parameters to change the scope of the response. End dates can be up to 3 months in the future and there is no limit on start dates.
+
+Starting in version 2023-04-01, the `eligible_employees` attribute was removed from the response. The eligible employees for a payroll are determined by the employee_compensations returned from the [PUT /v1/companies/\{company_id\}/payrolls/\{payroll_id\}/prepare](ref:put-v1-companies-company_id-payrolls-payroll_id-prepare) endpoint.
+
+scope: `payrolls:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-id-pay-schedules-assignments.ParamsDetails.json b/docs/api/get-v-1-companies-company-id-pay-schedules-assignments.ParamsDetails.json
new file mode 100644
index 000000000..02a817035
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-id-pay-schedules-assignments.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"string"},"description":"The UUID of the company"},{"name":"X-Gusto-API-Version","in":"header","required":false,"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.","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"}}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-id-pay-schedules-assignments.RequestSchema.json b/docs/api/get-v-1-companies-company-id-pay-schedules-assignments.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-id-pay-schedules-assignments.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-id-pay-schedules-assignments.StatusCodes.json b/docs/api/get-v-1-companies-company-id-pay-schedules-assignments.StatusCodes.json
new file mode 100644
index 000000000..d6b1496a9
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-id-pay-schedules-assignments.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"Example response","content":{"application/json":{"schema":{"description":"The representation of a pay schedule assignment.","type":"object","x-examples":{"example-1":{"type":"by_employee","employees":{"employee_uuid":"f0238368-f2cf-43e2-9a07-b0265f2cec69","pay_schedule_uuid":"c277ac52-9871-4a96-a1e6-0c449684602a"}}},"properties":{"type":{"anyOf":[{"type":"string","enum":["single","hourly_salaried","by_employee","by_department"]},{"type":"null"}],"description":"The pay schedule assignment type.","readOnly":true},"hourly_pay_schedule_uuid":{"type":["string","null"],"description":"Pay schedule for hourly employees.","readOnly":true},"salaried_pay_schedule_uuid":{"type":["string","null"],"description":"Pay schedule for salaried employees.","readOnly":true},"default_pay_schedule_uuid":{"type":["string","null"],"description":"Default pay schedule for employees.","readOnly":true},"employees":{"type":["array","null"],"description":"List of employees and their pay schedules.","readOnly":true,"items":{"type":"object","x-examples":{"example-1":{"employee_uuid":"43b39ada-dc49-4879-9594-fe95f67ae434","pay_schedule_uuid":"3f029a58-155d-4c30-8361-cc266b2c1f11"}},"properties":{"employee_uuid":{"type":"string","description":"The UUID of the employee."},"pay_schedule_uuid":{"type":["string","null"],"description":"The employee's pay schedule UUID."}},"x-tags":["Pay Schedules"],"title":"Pay-Schedule-Assignment-Employee"}},"departments":{"type":["array","null"],"description":"List of departments and their pay schedules.","readOnly":true,"items":{"type":"object","x-examples":{"example-1":{"department_uuid":"43b39ada-dc49-4879-9594-fe95f67ae434","pay_schedule_uuid":"3f029a58-155d-4c30-8361-cc266b2c1f11"}},"properties":{"department_uuid":{"type":"string","description":"The UUID of the department."},"pay_schedule_uuid":{"type":"string","description":"The department's pay schedule UUID."}},"x-tags":["Pay Schedules"],"title":"Pay-Schedule-Assignment-Department"}}},"x-tags":["Pay Schedules"],"title":"Pay-Schedule-Assignment"},"examples":{"Example":{"value":{"type":"by_employee","employees":{"employee_uuid":"f0238368-f2cf-43e2-9a07-b0265f2cec69","pay_schedule_uuid":"c277ac52-9871-4a96-a1e6-0c449684602a"}}}}}}},"404":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided UUID is valid.\n"}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-id-pay-schedules-assignments.api.mdx b/docs/api/get-v-1-companies-company-id-pay-schedules-assignments.api.mdx
new file mode 100644
index 000000000..f6e28b509
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-id-pay-schedules-assignments.api.mdx
@@ -0,0 +1,71 @@
+---
+id: get-v-1-companies-company-id-pay-schedules-assignments
+title: "Get pay schedule assignments for a company"
+description: "This endpoint returns the current pay schedule assignment for a company, with pay schedule and employee/department mappings depending on the pay schedule type."
+sidebar_label: "Get pay schedule assignments for a company"
+hide_title: true
+hide_table_of_contents: true
+api: eJzdWFtv2zYU/isc99AOEH23E/tpwdIVAbY16GUbkBgpLR7ZbCVSJSkvgqH/PhxKsqTYbtp1xS5PlqXD79y+c5F29J6tM+s0k8rB2nAntWIuT4EubigkKxACBA0oT9O2iKXLgBqwqVYWLF3s6GgwwB8BNjQyRRm6oM/ueZLGQGpJGtBQKwfKoSxP01iGHq//zuKBHbXhBhJ+iPR6gyipAQvK+SNER4STlOcEz4gsBsKtlWuVgHI9GtDSC6pX7yB0NKD3DEpzvL3VNRvin0p0ld9BksY6B7S0vizFqz93WSYFXdBoMBqfj2fnLBqFEZuMYcTmfHDGVoPRbBqNQghncxrQlOd3tXn10XB0dsbD6YjNz8+GbMLnM8aHMGODcDKZz84ns8GI06IoApoanYJxsjShNHJHucpfRHRxszfbOiPVGi1WWYJ5s1KtY3RhozMT53eWx9xIn8eui6v8TkDKjcOY0WUR7DFVFse0WAZH0nAi5ARPYtwNcPFCxTldOJNBsbfiSCxqdTeND17xgd7rts5IG1Jikn2Ojiqu/f57VdeojygXEPEsdl+k+7LE6IYcbfi46g5za1XcGJ6f1PSTtA4ran+UcCWI24A0He1HFAZUOkhauj6p5B4W1GS8Gs+54EyEkzmbnJ/N2Xw6n7AI5tNodsZhMp6cKKhxNBjN+fScDadTwSbheMDOx7MhC8PRbLYahcNoOKSH9fTAgsNyOqT+mzdXlxglt4F9pHq0OGrWJyf5dQvsie3mGhX2vO33zPG1RTgk5Ks6HQjnpIuhZCqrH7CLfWGyZ3XBF56Wdb3/BXa0Dn9tfjSq/jmGHNjwuRxpAB5jyccQG5SvQo/LZgIUXwaFPrYTWo1/vNzyOIN/7agtvOOTweRw8fhFO/KjzpQgt4qQW1UuIh8ysA4ELjY6MyEQocESpR2Be2ldj/zM3wOxmQHPg9TorRQgSnJIS7Y8lqJ3q3zukHJ+pblCm9fg2HbIQp2kXEmw1VV+JwVr+2hZM3vtEd5IS0CJVEvliAGXGWW9LWFmDI7rU2McxwsnldKA/CHd5oGsakZfv+EmSXiaSrW2yFdQQqo10ap0v33crwm36lbZUKewIG87Ti2wd7z16TQ8AQfG+lVH8QRp08SCBlSioyl3G99yPmTSgKhbTrNHduureKxkKw0Ud6FK6e/suV+RL66v2K9gLB6stG+ACzAd/RGPLRwOcgcmkQrKHAjugK24BUEurq/ItgTFLOhQciSWD3uuM+MFQh7HPXIVEaUVIH9qQgWlTGuTfmLJTSKVTLKkjb18unEutYt+X+jQ9vzO3wt10q93fOSW0XHsn/d5Kll1Uqr1txUga93+Ds3ILAhs+Kei3ayko8FoygYzNpyW08XvNXTRvl/gunmy9dwzmwJ/D9zmbG10lvrc541MVwRTx/QWjJECyqq66JQL3DtQ1r/KIL/eQ04Xp1+GgrqBPfJShKypoR7au8fo2n38SNf+5ugDPzBkCbiNrjqHLxy3oQva3w77+x7S3zWFU/Q7BdfvdhELZlvXXGZipHjFG57KkjZMQOK5c9B0LiHRD/JQ4jHfjfGcd/cE8FHMa6PFRzBTfIxRsBBmRrrcW/5D6e1FGIK1FxkG5GbZlsLwJ+W4OSK7pzGaWNPbTy3gxpd718YKgsWwhZjwzG1AuaoeseO8yq2D5Es0lAgnFBTYjCLtUasB7RsW1j9Sp2pZnWILKDYk+yJ6BWYrQ2jlo+kNfKUz1/eCfYGqcVIx/5/pyOcBjz409jeIQ50AcZp4O55Y8qwqGnJddhnfmoQOs6R+nf+m+jbAQ/9toGq9l7VW8hLiqshwXeAy9oSqnn7f8Mdvcdq6hKsWznM4OfBsd+I99GbXfLH47w/VinQO7l0/jbn07PTVuKv6xg3dDn0mqs5BA7roDN0OMPbAVvtY4ru+dYiy2+F4e2PiosDbHzIwWJpL7GRG8hWy9GZHhbR4fWJstmP/9GU1Yb8jp0b2Cf+qm6VE3UdpUDXdlnPFEj9WlBP984z7n4/3o2Etw3d8N9pHuRlu2P1S13p28PWvM8ueP3tNi+JPVPgpIw==
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+This endpoint returns the current pay schedule assignment for a company, with pay schedule and employee/department mappings depending on the pay schedule type.
+
+scope: `pay_schedules:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-id-pay-schedules-pay-schedule-id.ParamsDetails.json b/docs/api/get-v-1-companies-company-id-pay-schedules-pay-schedule-id.ParamsDetails.json
new file mode 100644
index 000000000..274e97c02
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-id-pay-schedules-pay-schedule-id.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"string"},"description":"The UUID of the company"},{"name":"pay_schedule_id","in":"path","required":true,"schema":{"type":"string"},"description":"The UUID of the pay schedule"},{"name":"X-Gusto-API-Version","in":"header","required":false,"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.","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"}}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-id-pay-schedules-pay-schedule-id.RequestSchema.json b/docs/api/get-v-1-companies-company-id-pay-schedules-pay-schedule-id.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-id-pay-schedules-pay-schedule-id.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-id-pay-schedules-pay-schedule-id.StatusCodes.json b/docs/api/get-v-1-companies-company-id-pay-schedules-pay-schedule-id.StatusCodes.json
new file mode 100644
index 000000000..db25e224d
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-id-pay-schedules-pay-schedule-id.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"Example response","content":{"application/json":{"schema":{"allOf":[{"type":"object","title":"Pay Schedule","x-examples":{"Example":{"uuid":"f2a69c38-e2f9-4e31-b5c5-4754fc60a052","version":"68934a3e9455fa72420237eb05902327","frequency":"Twice per month","anchor_pay_date":"2020-05-15","anchor_end_of_pay_period":"2020-05-08","day_1":15,"day_2":31,"name":"Engineering","auto_pilot":false,"custom_name":"A new monthly pay schedule"}},"description":"The representation of a pay schedule.","properties":{"uuid":{"type":"string","description":"The unique identifier of the pay schedule in Gusto.","readOnly":true,"title":"Pay-Schedule-Uuid"},"frequency":{"type":"string","description":"The frequency that employees on this pay schedule are paid with Gusto.","enum":["Every week","Every other week","Twice per month","Monthly","Quarterly","Annually"],"readOnly":true,"title":"Pay-Schedule-Frequency"},"anchor_pay_date":{"type":"string","description":"The first date that employees on this pay schedule are paid with Gusto.","readOnly":true,"title":"Pay-Schedule-Anchor-Pay-Date"},"anchor_end_of_pay_period":{"type":"string","description":"The last date of the first pay period. This can be the same date as the anchor pay date.","readOnly":true,"title":"Pay-Schedule-Anchor-End-Of-Pay-Period"},"day_1":{"type":["integer","null"],"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.","readOnly":true,"title":"Pay-Schedule-Day-1"},"day_2":{"type":["integer","null"],"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, this field should be set 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.","readOnly":true,"title":"Pay-Schedule-Day-2"},"name":{"type":["string","null"],"description":"This field will be hourly when the pay schedule is for hourly employees, salaried when the pay schedule is for salaried employees, the department name if pay schedule is by department, and null when the pay schedule is for all employees.","readOnly":true,"title":"Pay-Schedule-Name"},"custom_name":{"type":"string","description":"A custom name for a pay schedule, defaults to the pay frequency description.","readOnly":true,"title":"Pay-Schedule-Custom-Name"},"auto_pilot":{"type":"boolean","description":"With Autopilot® enabled, payroll will run automatically one day before your payroll deadlines.","title":"Pay-Schedule-Auto-Pilot"},"active":{"type":"boolean","description":"Whether this pay schedule is associated with any employees. A pay schedule is inactive when it's unassigned.","readOnly":true,"title":"Pay-Schedule-Active"}},"x-tags":["Pay Schedules"],"required":["uuid"]},{"type":"object","properties":{"version":{"type":"string","example":"56d00c178bc7393b2a206ed6a86afcb4","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."}},"required":["version"],"title":"Versionable-Required"}]},"examples":{"Example":{"value":{"uuid":"f2a69c38-e2f9-4e31-b5c5-4754fc60a052","version":"68934a3e9455fa72420237eb05902327","frequency":"Twice per month","anchor_pay_date":"2020-05-15","anchor_end_of_pay_period":"2020-05-08","day_1":15,"day_2":31,"name":"Engineering","custom_name":"A new monthly pay schedule","auto_pilot":false,"active":true}}}}}},"404":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided UUID is valid.\n"}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-id-pay-schedules-pay-schedule-id.api.mdx b/docs/api/get-v-1-companies-company-id-pay-schedules-pay-schedule-id.api.mdx
new file mode 100644
index 000000000..7c8077e2c
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-id-pay-schedules-pay-schedule-id.api.mdx
@@ -0,0 +1,71 @@
+---
+id: get-v-1-companies-company-id-pay-schedules-pay-schedule-id
+title: "Get a pay schedule"
+description: "The pay schedule object in Gusto captures the details of when employees work and when they should be paid. A company can have multiple pay schedules."
+sidebar_label: "Get a pay schedule"
+hide_title: true
+hide_table_of_contents: true
+api: eJzlWd1y3LYVfhUUvXA8Q+6vVrL2qjuR7NFFYjW2285IGgVLHIqISYACwJU4mp3xg6Sv0Ifoo/hJOgcAl+TuylknTWfa5iYr8ODgO3/fOYCf6GN8VxmrYiEt3GlmhZKxrUug8ysKxRI4B04jysqyK2LoTUQ1mFJJA4bOn+hkNML/cTCJFiXK0Dk9f2RFmQNpJGlEEyUtSIuyrCxzkTh9w58MbniiJsmgYO5rnr9N6fzqiXo4VC1/gsTSiFphc1y4ZDV5l2TAqxw1P8bgj3N4wtH4s6oEp3OaTtjxaTJ9FcMkPY2PYDqOl7NkFh+dzI7S5HjERrMJjegKtPHoj1+dTo/YFE6PZrOUnUyOJqPJ9ASWo9npaDKdnNCIphruK5BJTef0/YNIgJSgSaGkzdBpMsmUvi1ZfcuZRciT0WQUj2bxeNZ+BslvVeqkStBC8Y7c6BWNKGf17ZjOxzP/c0Ln03FEJStQ47m8ExJAC3mHKiurbkuRK0vnKcsNRDTB8Ba3QXxBJDx4gHlNSlYT03hwvY62wvc+w9CVGgxI6+JEVEpYb9uARrTUqgRthfe8d/cmbMYGbLu6KynuKyCCg7QiFaBRvc2gdwARkrxBG/AkDYy/lXlN51ZX0EuFuEmF+AMCWPeCcwiajTixGbMEijJXNYAhShKbCdNHxTTCFJw8CJu1AEFWBZbO+Qp0TR4APtIo/KFsBrpZ2k2W73xMaET/XDFtQbvfCykrlue1r7cDjH+9MXq9JwEP8oPQxhKU/y2OOAjswuGLce0M8a2/VBSHYM9ZAz1kkjcGAXs1A/IeLUiYJEtwEoYV4Lcw4xY8ArcHl7/WmHPJ47eps+nSI19vSrgx4Yo6LgVNIyqrPMfo9o1ZSBJEyBLsA4AkY8IkJ9MxEZI72pR3HRM5qxubXUZtx64JU3BAKiDnRGBM85poyGHFpCVpMLyJrvFRRa2fP/28lbSfP/3dQfr86eeQvLjSlJEAMyAXljyIPEdfo53P6fel0d15qNPPWB2PGw9PficPG0iU5L/axR0VTVJ9ydHX2+RwTVtuGpDXShMDhYj3kbiJfIX6s02mqpyj8w1YYhWZjv1+t9XgdyQatEOi2ZzVJiIP4GPm9uyBbpVbDqXWd8l/KOITjLjvaG3AN7SwP96dmDQAM1XpvCYPGcg9bcc47EFmE+WIGJYzLYB/ed9GqrMTZTmUTNsCpCVoABHpzvZl3ZGKXE46V37xPJbn7VEHO/N79OF6a0j4JaJdEC/uDXCH9yBFhEPKqtyaJlfwa9teO9oOBvqtO3GDtzvnbOAulcqByR28f8WEW1RWuQ3//AcByZY58AhxaYWexYTQlSSot2BWJNhziZLgMnwJqdJAalXpzRYOjOdCel/v7weVVfGlw4iIEytWcAjaDFxt7HZaYQgzRiWCWQjtlslOag7IYmeDkP5gnzzCvjCkkswYcSeBH97aPHicEB9jy+4M1lt3/A73gftKaOD40Q2BN+tod3rvD4ubaXs36aCZ4OnsmI9Gyfjk1TI5mZ5OlxM2GR0DP2avjlmaLI/2jgJJpTVWWTihoSmPY0DegW//V+E7cv1dJTjcfJNZW5r5cMhVYgbudjRIVDFsbkNxSAH3fSg4FKWymNgvXS0ImSpdhGlZkkw9YBVUBjrMPHCu7Pqr8cNNG4G/+CVM1fiHRnR9s954Zvues2J59f924Tn4drP3btQUJab+2v0X0aPR0e5F9ntlyWtVSU6uJSHX0t+M7iswWIoajKp0AoQrMEQqS+BRGDsg37GPQEylfaqVWq0EB04+fLg4w+JcsVzwwbV02YBV4bLmAv1xBzZejeNEFSWTAkz4Vd8Kl3+3m3ba++tW8L210GMFXwGbaxVJWGkrDSa0J8tEbrBaHGO0082D0h9dL2raUN2ZL/zYsyABpZuvM7YCUlS5FfgE0JsBBtfyWppElTAnP/bMmSMf/Yg0wTQrwII27g0gBLj1Ao2oQPNK5jKvrSVPY+07Qp9W9t5xXTwCP4QTKFJXOHTXw7/Lyf3LeHv832IXp3hxeREHTmggZMC4G3FbECGz+0edoSML7FY+yMxCvGQGOFlcXmwYcru5uH6HAtgNB+QiJRI7IralkMmRl+k85Lww5KoQUhRV0dX9laTKShG3vPzHoDDuLL9EGJXxPew5l7fX8cloMotHx0hDbjB044mnnWZ9vUbufa63PcamBPYRmKljjEusVqC14OBrlfYl7rSqSp85rRbkbQvSuOczzOmPgCz67ANc1BD6LzzEYao0qp4DudHlwO7f4UG3kj3w6JwCbKb4xmCX/3M6XI2HG5oaPrUVuh72Knv4tFVHa4wc6FVT4pXOMaVDnrBS+DSJORQuV3aY7QwKteV4ry927Q/3OVOfUbxX56VW/As6S/yMvjCQVFrY2iH/1tu8SBIwZlGhW65uulLox8L36z2ym7RFiE06uxERmHbl3ccYVMQ5rCDHkTXD9zNff0gz72pjofgtJ3gNzxywRvJJldMaRhXfSBaXF71xolNcEUUCMm/Td6BXIoFOPFouYEtV2aETHHI8Glti7P6OVerigFt3BmbIE1W4e6nD8cKQ81Av5DJM60hFXCVV0Txk/iE8RbPE3SAC1Z41p5IfIA/1FVEomMhdQoWvf2rzB71RKmMLJjt63oDduhNto35qH8L/Wzt0SCkLj3ZY5ky43HO19hS44Yquxs7PgR1oROe9Dt5TjF+3W+1NRDNlLKp6esKO9UHn6zUu31egsfpukLC0wCnZ1SIXxl3u9nfCrtu/aYbql+S5IeAZI8Oil2jokkaBUzsWIvv8WwBtpdKvQLXtWXeRCPPD1/ntf3yY2Otb78P9k9jG1W1bRe4tbefbzj919frpm/P3dL3+Fzbuk5Y=
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+The pay schedule object in Gusto captures the details of when employees work and when they should be paid. A company can have multiple pay schedules.
+
+scope: `pay_schedules:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-id-pay-schedules-preview.ParamsDetails.json b/docs/api/get-v-1-companies-company-id-pay-schedules-preview.ParamsDetails.json
new file mode 100644
index 000000000..d03fcd939
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-id-pay-schedules-preview.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"string"},"description":"The UUID of the company"},{"name":"frequency","in":"query","description":"The frequency that employees on this pay schedule are paid with Gusto.","schema":{"type":"string","enum":["Every week","Every other week","Twice per month","Monthly"]},"required":true},{"name":"anchor_pay_date","in":"query","description":"The first date that employees on this pay schedule are paid with Gusto.","schema":{"type":"string","example":"2020-05-15"},"required":true},{"name":"anchor_end_of_pay_period","in":"query","description":"The last date of the first pay period. This can be the same date as the anchor pay date.","schema":{"type":"string","example":"2020-05-08"},"required":true},{"name":"day_1","in":"query","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.","schema":{"type":"integer"},"required":false},{"name":"day_2","in":"query","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.","schema":{"type":"integer"},"required":false},{"name":"X-Gusto-API-Version","in":"header","required":false,"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.","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"}}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-id-pay-schedules-preview.RequestSchema.json b/docs/api/get-v-1-companies-company-id-pay-schedules-preview.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-id-pay-schedules-preview.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-id-pay-schedules-preview.StatusCodes.json b/docs/api/get-v-1-companies-company-id-pay-schedules-preview.StatusCodes.json
new file mode 100644
index 000000000..5de8c5f5b
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-id-pay-schedules-preview.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"description":"Pay schedule preview","type":"object","properties":{"pay_periods":{"type":"array","description":"A list of pay periods for the previewed pay schedule","items":{"type":"object","properties":{"check_date":{"type":"string","description":"The payment date, \"Check date\", for the pay period"},"run_payroll_by":{"type":"string","description":"The deadline to run payroll for direct deposit on the check date"},"start_date":{"type":"string","description":"The first day of the pay period"},"end_date":{"type":"string","description":"The last day of the pay period."}}}},"holidays":{"type":"array","description":"A list of dates for bank closures","items":{"type":"string"}}}}}}},"422":{"description":"Unprocessable Entity \n \nThis 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.\n","content":{"application/json":{"schema":{"description":"Unprocessable Entity\n \nThis 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.\n","type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["error_key","category"],"properties":{"error_key":{"type":"string","description":"Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error."},"category":{"type":"string","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."},"message":{"type":"string","description":"Provides details about the error - generally this message can be surfaced to an end user."},"metadata":{"type":"object","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.","oneOf":[{"type":"object","description":"multiple entities","required":["entities"],"properties":{"entities":{"type":"array","items":{"type":"object","description":"single entity","additionalProperties":true,"properties":{"entity_type":{"type":"string","description":"Name of the entity that the error corresponds to."},"entity_uuid":{"type":"string","description":"Unique identifier for the entity."},"valid_from":{"type":["string","null"]},"valid_up_to":{"type":["string","null"]},"key":{"type":["string","null"]},"state":{"type":["string","null"]}},"title":"Metadata-With-One-Entity"}}},"title":"Metadata-With-Multiple-Entities"},{"type":"object","description":"single entity","additionalProperties":true,"properties":{"entity_type":{"type":"string","description":"Name of the entity that the error corresponds to."},"entity_uuid":{"type":"string","description":"Unique identifier for the entity."},"valid_from":{"type":["string","null"]},"valid_up_to":{"type":["string","null"]},"key":{"type":["string","null"]},"state":{"type":["string","null"]}},"title":"Metadata-With-One-Entity"}]},"errors":{"type":"array","description":"Will only exist if category is `nested_errors`. It is possible to have multiple levels of nested errors.","items":"circular(Entity-Error-Object)"}},"title":"Entity-Error-Object"}}},"x-examples":{"bank_account_delete_unfunded_payments":{"errors":[{"error_key":"base","category":"invalid_operation","message":"FundingMethod has unfunded payments"}]},"bank_account_verify_incorrect_deposits":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Your bank account cannot be verified. Please check the test deposit amounts."}]},"bank_account_verify_already_verified":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Your bank account has already been verified."}]},"bank_account_missing_routing":{"errors":[{"error_key":"routing_number","category":"invalid_attribute_value","message":"Routing number is required."}]},"payment_configs_missing_parameter":{"errors":[{"error_key":"base","category":"missing_parameter","message":"At least one parameter must be provided"}]},"payment_configs_invalid_fast_payment_limit":{"errors":[{"error_key":"fast_payment_limit","category":"invalid_attribute_value","message":"Fast payment limit should be a number"}]},"pay_periods_invalid_end_date":{"errors":[{"error_key":"end_date","category":"invalid_parameter","message":"End date cannot be more than 3 months in future"}]},"company_industry_selection_naics_code_required":{"errors":[{"error_key":"naics_code","category":"invalid_attribute_value","message":"Naics code is required."}]},"company_industry_selection_naics_code_invalid":{"errors":[{"error_key":"naics_code","category":"invalid_attribute_value","message":"Naics code must be equal to 6 digits."}]},"company_industry_selection_sics_codes_invalid":{"errors":[{"error_key":"sic_codes","category":"invalid_attribute_value","message":"Sic codes must be equal to 4 digits"}]},"time_off_policy_name_required":{"errors":[{"error_key":"name","category":"invalid_attribute_value","message":"Name is required."}]},"time_off_policy_unlimited_invalid_accrual_rate":{"errors":[{"error_key":"accrual_rate","category":"invalid_operation","message":"Accrual rate must be blank for unlimited policies."}]},"time_off_policy_pending_requests":{"errors":[{"error_key":"time_off_policy","category":"invalid_operation","message":"Cannot deactivate policy with pending time off requests."}]},"time_off_policy_employees_required":{"errors":[{"error_key":"employees","category":"invalid_attribute_value","message":"Employees are required."}]},"time_off_policy_unlimited_balance_update":{"errors":[{"error_key":"base","category":"invalid_attribute_value","message":"Can not adjust balances for unlimited policies."}]},"holiday_pay_policy_already_exists":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Company already has a holiday pay policy."}]},"holiday_pay_policy_not_exists":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Company does not have a holiday pay policy, please create one"}]},"holiday_pay_policy_invalid_employees":{"errors":[{"error_key":"employees","category":"invalid_attribute_value","message":"Invalid employee uuids provided."}]},"onboarded_employee":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Cannot delete onboarded employee"}]},"invalid_attribute":{"errors":[{"error_key":"base","category":"invalid_operation","message":"There is an error in the request body."}]},"company_cannot_enable_contractor_only":{"errors":[{"error_key":"contractor_only","category":"invalid_attribute_value","message":"Contractor only cannot be enabled for existing companies."}]},"company_missing_parameter":{"errors":[{"error_key":"base","category":"missing_parameter","message":"contractor_only is required."}]},"starting_after_uuid_invalid":{"errors":[{"error_key":"starting_after_uuid","category":"invalid_attribute_value","message":"Parameter 'starting_after_uuid' does not correspond to a valid event."}]},"resource_uuid_invalid":{"errors":[{"error_key":"resource_uuid","category":"invalid_attribute_value","message":"Parameter 'resource_uuid' does not correspond to a valid resource."}]},"payroll_gross_up_invalid_net_pay":{"errors":[{"error_key":"net_pay","category":"invalid_attribute_value","message":"Net pay must be a number."}]},"payroll_accruing_hours_invalid":{"errors":[{"error_key":"base","category":"invalid_attribute_value","message":"Hours cannot be negative."}]},"payroll_cannot_cancel":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Payroll cannot be canceled."}]},"frozen_payroll":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This payroll has already been processed. Its data cannot be updated or altered."}]},"frozen_payroll_processing":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This payroll is being processed and cannot be updated at this time."}]},"unmodifiable_payroll_type":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This type of payroll cannot be modified or processed. It is reserved for system processes."}]},"invalid_employee_uuids_format":{"errors":[{"error_key":"employee_uuids","category":"invalid_attribute_value","message":"Parameter employee_uuids must be an array."}]},"maximum_employee_uuids_surpassed":{"errors":[{"error_key":"employee_uuids","category":"invalid_attribute_value","message":"Exceeded maximum of 100 for lookup."}]},"invalid_employee_uuid":{"errors":[{"error_key":"employee_uuids","category":"invalid_attribute_value","message":"Invalid Employee UUID(s).","metadata":{"entities":[{"entity_type":"Employee","entity_uuid":"invalid-uuid-123"}]}}]},"payroll_blocker_missing_bank_info":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must have a bank account in order to run payroll.","metadata":{"key":"missing_bank_info"}}]},"payroll_blocker_missing_employee_setup":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must add employees in order to run payroll.","metadata":{"key":"missing_employee_setup"}}]},"payroll_blocker_missing_federal_tax_setup":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must complete federal tax setup in order to run payroll.","metadata":{"key":"missing_federal_tax_setup"}}]},"payroll_blocker_missing_bank_verification":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company bank account must be verified in order to run payroll.","metadata":{"key":"missing_bank_verification"}}]},"payroll_blocker_suspended":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company is suspended and cannot run payroll.","metadata":{"key":"suspended"}}]},"submission_blocker_missing_selection":{"errors":[{"error_key":"submission_blockers","category":"invalid_attribute_value","message":"Submission blockers selections required"}]},"submission_blocker_invalid_option":{"errors":[{"error_key":"submission_blockers","category":"nested_errors","metadata":{"blocker_type":"fast_ach_threshold_exceeded"},"errors":[{"error_key":"selected_option","category":"invalid_attribute_value","message":"Selection is not available to resolve Fast ACH Threshold Exceeded. Please choose one of Wire In, Move To Four Day"}]}]},"invalid_version":{"errors":[{"error_key":"base","category":"invalid_resource_version","message":"You are attempting to update a resource using an out-of-date version."}]},"signatory_email_required":{"errors":[{"error_key":"email","category":"invalid_attribute_value","message":"Email is required"}]},"signatory_company_already_has_signatory":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Cannot have more than one signatory in a company. Please remove the existing signatory before adding a new one."}]},"mixed_disbursement_errors":{"errors":[{"error_key":"disbursements","category":"nested_errors","metadata":{"contractor_payment_uuid":"invalid-uuid-1"},"errors":[{"error_key":"contractor_payment_uuid","category":"not_found","message":"Disbursement not found."}]},{"error_key":"disbursements","category":"nested_errors","metadata":{"contractor_payment_uuid":"d0dfa222-ad08-4ea7-a06a-717688c3b179"},"errors":[{"error_key":"payment_method","category":"invalid_attribute_value","message":"Payment method must be one of: Direct Deposit, Check."},{"error_key":"payment_status","category":"invalid_attribute_value","message":"Payment status is not valid for payment method 'InvalidMethod'."}]}]},"not_found":{"errors":[{"error_key":"request","category":"not_found","message":"The requested resource was not found."}]},"finish_onboarding_incomplete":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Company is not ready to exit onboarding."}]},"company_location_validation":{"errors":[{"error_key":"street_1","category":"invalid_attribute_value","message":"Must include a street address"},{"error_key":"city","category":"invalid_attribute_value","message":"Must include a city"},{"error_key":"state","category":"invalid_attribute_value","message":"State is in the wrong format"},{"error_key":"zip","category":"invalid_attribute_value","message":"Please enter a valid zip code (e.g. 12345)."},{"error_key":"phone_number","category":"invalid_attribute_value","message":"Phone number must be 10 digits"}]},"conflict":{"errors":[{"error_key":"request","category":"duplicate_operation","message":"A resource with these attributes already exists."}]},"invalid_parameter":{"errors":[{"error_key":"request","category":"invalid_parameter","message":"The provided parameter is invalid or missing."}]},"flow_invalid_entity":{"errors":[{"error_key":"entity_type","category":"invalid_attribute_value","message":"Invalid flow entity"},{"error_key":"entity_uuid","category":"invalid_attribute_value","message":"Invalid flow entity"}]},"flow_nested_options_errors":{"errors":[{"error_key":"options","category":"nested_errors","metadata":{"flow_type":"company_forms"},"errors":[{"error_key":"form_types","category":"invalid_attribute_value","message":"Supplied value 'invalid' contains no permitted values"}]}]},"basic":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must complete all onboarding requirements in order to run payroll.","metadata":{"key":"needs_onboarding"}}]},"contractor_payment_invalid_wage":{"errors":[{"error_key":"wage","category":"invalid_attribute_value","message":"Wage must be greater than or equal to 0."}]},"contractor_payment_cannot_cancel":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Payment has already been processed and cannot be cancelled. Contact support directly."}]},"time_off_request_cannot_delete":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This time off request cannot be deleted."}]},"resource":{"errors":[{"error_key":"first_name","category":"invalid_attribute_value","message":"First name is required"},{"error_key":"date_of_birth","category":"invalid_attribute_value","message":"Date of birth is not a valid date"}]},"nested":{"errors":[{"error_key":"contractor_payments","category":"nested_errors","metadata":{"contractor_uuid":"72ae4617-daa9-4ed7-85e0-18ed5d0ee835"},"errors":[{"error_key":"hours","category":"invalid_attribute_value","message":"Ella Fitzgerald is paid fixed wage and hours cannot be set on a contractor payment"}]},{"error_key":"contractor_payments","category":"nested_errors","metadata":{"contractor_uuid":"2d7bf62c-babf-4a12-8292-340e2d9cab28"},"errors":[{"error_key":"wage","category":"invalid_attribute_value","message":"Isaiah Berlin is paid hourly and wage cannot be set on a contractor payment"}]}]},"compensation_invalid_rate":{"errors":[{"error_key":"rate","category":"invalid_attribute_value","message":"Rate is not a valid number"}]},"compensation_invalid_payment_unit":{"errors":[{"error_key":"payment_unit","category":"invalid_attribute_value","message":"Payment unit must be one of Hour, Week, Month, or Year"}]},"compensation_already_processed":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Compensation has already been processed on payroll."}]}},"title":"Unprocessable-Entity-Error-Object"},"examples":{"Basic":{"value":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must complete all onboarding requirements in order to run payroll.","metadata":{"key":"needs_onboarding"}}]}},"Resource":{"value":{"errors":[{"error_key":"first_name","category":"invalid_attribute_value","message":"First name is required"},{"error_key":"date_of_birth","category":"invalid_attribute_value","message":"Date of birth is not a valid date"}]}},"Nested":{"value":{"errors":[{"error_key":"contractor_payments","category":"nested_errors","metadata":{"contractor_uuid":"72ae4617-daa9-4ed7-85e0-18ed5d0ee835"},"errors":[{"error_key":"hours","category":"invalid_attribute_value","message":"Ella Fitzgerald is paid fixed wage and hours cannot be set on a contractor payment"}]},{"error_key":"contractor_payments","category":"nested_errors","metadata":{"contractor_uuid":"2d7bf62c-babf-4a12-8292-340e2d9cab28"},"errors":[{"error_key":"wage","category":"invalid_attribute_value","message":"Isaiah Berlin is paid hourly and wage cannot be set on a contractor payment"}]}]}}}}}}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-id-pay-schedules-preview.api.mdx b/docs/api/get-v-1-companies-company-id-pay-schedules-preview.api.mdx
new file mode 100644
index 000000000..bfe155859
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-id-pay-schedules-preview.api.mdx
@@ -0,0 +1,71 @@
+---
+id: get-v-1-companies-company-id-pay-schedules-preview
+title: "Preview pay schedule dates"
+description: "Provides a preview of a pay schedule with the specified parameters for the next 18 months."
+sidebar_label: "Preview pay schedule dates"
+hide_title: true
+hide_table_of_contents: true
+api: eJztXOmOGzmSfhVu7g+3AWUd8tn1az0+ZoyFuwtt9/YOykYWlQxJbGeS2SRTVWqjgH6Q2ZfrJ1lEkMxLR0lyFQYzsP8YpSSDXwSDcfH4klyns9o6nUrlYGa4k1qlbllBcnaRQDkBIUAkn0ZJxQ0vwYGxydnFl0TxEpKzJNdlxdUykyIZJVIlZ0nF3TwZJQZ+q6UBkZw5U8MosfkcSp6cfUk88cQ6I9UsuRklAmxuZIUjJ2fJhzmwn39++4rpKXNzYGGE5GbUDDpF4qDyZRzztxoM/rFKqWnK3Jw7BmVV6CWAZVoxN5eWVXzJEJuoC2DcAKu4FOxKujn7K8rlKNmMfZSAqksU1OsFmCW7AvicjMIf2s3BxJ8+XMkcWAWGlVqRfN7h/8Uy+XQzlFWHUa7yuTZZxZeZ4A52YFca6xi2vSd+r3lZFfjT+GR8kp48SU+fJDtwAEpkekqMVGCkFrezUvDISVAEzxvi9ySO2AdkKOeKTYBaWF6C78It/eBHpz748768nTzfypvgy+x0OyMvFKN1BYZNwF0BKHbKuBLs0SmTSsicO6lmHfYEX0Z+SVOG0xhnLDA/lVAIJnF6iyUzUMCCK8emgek40dZPMFL9849/DJTxzz/+jyD9+cc/glLiL3HhSLBH7K1jV7IoUM6qLopN9L3Kd3uuE3gQSF+0U17YoWzHdyZbC7lW4mDhdkhEVdom4o/D5f4xae3QEXujDbNQyrT00u6TGTELzi9VP77T7NGp70UdLLNzbRwYRK+QWcGXdsSuwM+R774K2Gn6OSyrviD+GTP8vynZm/TF+dv0f8BYnNQw33PgAkyy0nuoAa/QHZVSgZ8iZDOdcAuCvTh/yxaeKOPW6lxyB8HMLXVtqEHOi+KIvZ0ypRXgPFdGL6QAMfJteFUVpEVaPbDsopRKlnXZpf3pu7lzlT07PhY6t0fkSI9yXR5Hx5lWfGl0UdD3Y17JNPSUavafgWDa+fkhwqgtiN3czvhk/CQ9eYpG+BMKZ8rrwnkDFn+/ufmEcrSVVhYsEhufnOB/fVH++N/JKMm1cqAcfu3wfvyrxSZfOnj6fc+7LqUysJBwlYwiaD35FXKXjJLK6AqMkx5F6wpsh0NuDF+z0lkhrUONba2/JRXFaQ8jgugpLOqSg7JLfAOSfA75Z+9f14h61TFVfFmC8r5pxD4mL7E//fUxGbWoGqS0DGqVBVXIJsvdxhHARSEVrVxTKxb60whCGsgdE1BpK5137sDyBgmOaR03bg++VhxQnwV04bsTG5qZjttObm5ubkbJXBcSLdces4/D+3mfcPWZ5YW2tQG7ZqpjcOn/jZLH4/Gq3v6sKqNzsJZPCmCvlZNuyT4qxj4qsv8lX7I5rypQ7GoOXsQTLYgnMhBkBq1juG64VJaBMdpYZut8jiHIpVQLXkiRceeMnNQOsgUvargcsaAlkcKUy8IyUdNkc9X2REWlVXh5xN6DD3MuXvthXnIHM20k2D3tEMFM86b7QzarpfA+rdQGVc8hoKOP6nCrsE6634Q7FO7QNLUe7yLxDFPu1TNY4ffVdbPR4K1QzT4DdggolxvGoFa3Lvf3FeRyKjFEmIPxUqTuTOd5bewR+7CsJDrbpY9rPsOSSQHK+V4UqMc5PG7STIxmyWmHwIVIHqElalDvAQ0pYFtUL0+JoZmKpKLrD1rGZkbXlVQzSwFlSDHQLyOaSS0LwXLUgzK0n3OFtnrGpPLa28mmKcRoBpKWXSqwDkTm5/FyROD8XPkgLKg848y3ZJehKQuTtPSRDHiT5T+SaEpcb7MdbPR55DdoI+MTXbvO3KVsBgpMO2uBdBSGrc2U514gXDFQAuVjAgrHBXd8nSr2YbyMi7tJXbAf0gwKsgwr2era5IDipTWNcR2ZjWCRJgX4EDkkcaMeCcJHorr0/2eI6pLmNv5S11JcNjFwjAQxDNMKfpxSzWM7L2VdOFkV4MeS5Jd6Cy/+vLrY4pc9lnR/bCvVLI6M3bgQEj/x4rwzkq/ErBnbC+R2rfkBE+zg0YNEKYVq1SbXxgebwjIsJlDg0Aj49hF+VvK3GlrzYJqAypMhit56T40uW4IXLUVMYKiu4tvVVeb09oY9O7eugXW9yGe1yc0ocdJR9eBd0P70F+nm6Y8KUu/8kpvNrd4F3fFNcWowU/o25//6c46UNjrsvhx+QeNDhRy4xohXbnUblLNj0qqtlRhiOc3mfAGssUMFLKCwOHfBjURH0ZiVJJcmrwtuvvNwUwp+0h9J4R4mXQ7XNPAKfZ0Gm0sMYmCe8TzXtXKZgAIcZLWa1kqAyELm1AtiLnqxRoLpezcwwWLCIFhLOm4ueVMrIdXsHbi5FmzOLYujsWY0moMesAUYOV1mUpHq5oiUEqm7RPZ3DAMoTwmjoudU2qF7ofEliCN2XgC3MXOjIAUj1pjX8RI7omvfxAIvDHCxzCLFe2UAxRsGZBOstzV8rAFYSosWKjO6xjrcFmChRabqckJlnzUQB0F+D+hPvj/z/XFNRLcbcAVNyHKtpnJmG2hNrLmX1FZ7d8G8cAynFHNyzHpjMFvW1nUDi/XAIrdTbl1cLVkhS+m2IFzTeG8RvuG+tE6FDaKBVca6EIiZB8k2mGPhpsHbrQ1sQNk0WYttvSxfU83WQWflUAblC5+xHCoVm9auNuDxNTtSStTWmWVmoYActTtTXOY2y7WArA3MNiJuW+8vzx+wL8O+a9RxN4RhmPsHGFUTfqt5gV7kKRNyJhuzswWujQDsDnCtzH3b/dG+lzlhtatgHwewHquTJWR6Os0qXch8mWGtebe5Lg8SYrlufocgakUrCkSzXniem5oXmdm+ZnrN9rDcL3w/hv0aiU0KNOUYWTV4GAGkKv5a4BWQc81CIWWbdxx03QftS7+4BfDcyQVC9jR8jhswMByA6ek0VnU2YW52c3aZ9qbx/nP/urdrtLMGTHjBVQ5ZXd1iLzd7622oXnLFUJhc/ErT7kez26c9VGL97qwHHMMKCkTvMip66Y1JE0ZQSMECAl8lJgSboSnt7g+W0GBJgBRJrwM2YlUI2QzQ5rSCjVAb99io2b2o4lvfptnIZJh22U4Ng/BpNdHcYBge292l/OIaxoCfNUM1kDyEFWbuEMEHqj1KS8UeSkul6lWBsbg88Gg+rMhAYf0IgzBneO60yTAJ24Jt2HL/ZdoQ8PleG994LIIWLGk52j6Pt12wEf99xrEDHte4OdpfQgJ86sBQrr9LFLDaa3/5nTdx9YM19B60y7gtTVCdkoWFsgDlAhextLgr/l77r0Leo3Qr5ti6TWloM3FmtLVY7oiDK6BkYFusE1rsH+6AP34TI4qYFwwgUdSCMzLXtdklMDzM1f0NqXdWjoIZd3IxFFBY4zn6weIO7c152I1tAfghmuUxNfp3aHZ979TS+WNcNPxKSh423bC28NZZX05vMfqwQ+AOGS8cmA1os0Ble97+VcClZRNA49YAjlstA6g8nIbBmCqArVWphZxKMtsRcqxm3iXYuGNUrUy2B+Al2RO5N5QWzCJYcbu0DsqmUbThw9iArIDNptqUfFu232//NQaoT6ld1YpReTLgLPk1HlIZ4rS1qTjyfI9QX1/nABhFBAw4E6cnJyTVQuvPdbVNlvcILAZcMQeg86rf2YdHSX/vq93XuRgU3Zv0IRnUyuP4Kf6Zno4fIYc9gzYpdP4ZTOP8qegm1VTvpfwDamuDYdKIEAj36oBSMW0EnkDrnUwZsu/HXsW5nZ9mciy4urofprgQnWN/B7EzgLmdpykI3ErNHL++T7YwLqQAPIzHHL9mNN5hPK7C3kEVfU3YHxK5czZ7ahgtVqxCf4Ve9kCvZ9LWFmsRe5bYd2FK4qGWQLzrBG9loYXkIdt6QlxptTI1Tc1uW2i+0v2QUl1DhEUirBm8zSGSTYBbr/y1aHvbZQP5xdGCNaYSOs/nmZsbsHNdiAyC80k6+3dDBMQWNFj3l1WUC6oAlW0WXBY8bOZhxF8sgFFt/sXLv7EPERyLnrGzf6S1pWIEOslfpAH2Vo3YO70A9kGzN7iV84rTdmTXYYZTpweFTU36smgO7/b2jqguxp2DsvLnsHUI6Rhvz3PUqJwYcujapXqa0vdAMKaZcqa40wZLe1wWu5X1uCwOKelxWXQT3SGAmHfH6tic26z5evfVFL+b22x44OQ2ozE6HhQANWpgoMQZp63zWDxou0xgisTwnAAKnSm4QqIx0JPXIDIh7aQ2Fmgzqd233sBYt/Ueq69TW4j7Vmujny1rbxOJPgbtsqmulehJ91UHNK06auKlcM/siRMx5ePxOOXi5Hn6GPizlJ885emz02dPnz/PH01On32/helIraTd7kNif7/B5/s3/tNbjTP2yh8qfuU3n0eMDjYfJUOpRBR4PqI+KAPxKHz/aPp8RB2uHXRRPgjRtt/if3AUbVg7uduKNVT720UrPrSlQmirLeyK26GOJFOppJ1nocqJ3hUPEvjQ6x5q0kFAPsd3Gle2Y+3gg5pgoX0UkxHp26Iw6wyAo1tMe87iO1QeqfKiFmjRPSG0LQasXdGZ3B9R+roxiMiQsj+ls7/rxW4o2lAlvjJazVjIvodj/C6rA9Tcm2RQmGvHKt7vsvKbrt/B0eyInY4fPX7ycM0Sm2sFB5+HOMfe8TREXOSnJ72NUjxxUMh8W6Vh7eIRtT8BDpu2HjtLJ9yHsp3jvW2xym/hDBL4XQrZa2FtP0dAtzbCbkjnTAbNvp8XPJvtI+W4xgt91TneQGe5th1uaHP7g6sJOGQ8zTdUiG6N4G4GaJgMnszHsPZ2nx8a7u4OaZQQaEcrhQvNbvF0+J36HJSB4JlgEIw+sQehz4P2JoHSeBellM7FVjZ6lQm3Mr/n7JzTMb9ov2O0SUHGfimsAhC244dCGrgm/ohyuwqHwzdwR5/3FvgveCw82pkZbYuGy4m4iRUPapw0jmoF3T3W6CmS2FwkH9ScPQKs4TM6mZ47Zuuq0saFG1fFcrjDH8xR5MHvgN55HXpw+KED2Q8oBrtZ246L4TWv7LADL2/oipgaHHtZsVaC/MM0m0hDd933HOVVuPRN3ZvUOHhQf7uNAkCyObtt0zZnQQ8J4kPw/mzM4fHT02ep4Pz79DGIZ+nzJ3CSnj4H8UScADx/9GSLSaPdsAOS0qLg7I10v8+wFEfXkenG/hTTNYYLlnR4PtgNw1vA2qeIzVZzEMKaROeOJTUWzybTp+M8nfDJNH3MT8fp8/H34/TR4xMYi+9zPhk/3yKpw6zQW8sln7O/gCmkasSEcimWJKKrcHtlNwnFmBqU9fF0U/fYfm5n81mtrUdYQzTa1fTuocu1SJrkUm09H9prdnC2hr0HGSPDLdgR+wXgM5aalJvT1bu/A1+HOhZNGtt7x6lSHGibtdcdh3rTO8Dfu62Yrj3s3rwQQdHRX2Kg4EX2rxwx3IySnzp+4zaG/k0cyM0o+aHxILfx/M2VfHMlX+FK4jX0xnq9Rd5m4NLFadqc7krbx5TwSnHWvL2Rto8qbLjFyeMrCKj2vP/IT/MuiQ23YTs5cPuKgoJrx06fh0P1Rx/VR2VzXcEZu+xhObsy0sElXl3mMxQ4Pf/wPn7Gy43Xqa2AfwZulyldpPU2r23Tb4LWINULMEYK8GI5b/iFawfKUsKJc+tndeOTVaO4kLtPV6GGxn5DYE2HPsD1XfpA264dwPjYRqjO0u/42AS+h3WWHC9Oj5uZPv7STvXNcU++x+1c0yGSoNS1KXDhh4vovJL+HnoqoKTL6Cuq8QpKPRC0p5f6SjR+RjY3EF5L89xQ1XkTzQo/owQs5LWhisnFl+jRXuToXV/UKIyLT91WKPbSO9U1bZs7cwgxPoqCf0+AG3KewxvFRCKly2+M126OFY+4sztK3tNxnK8ZwVPYMAAVs/xZjBha0DM3+GoMqkzccOs+0TJK8Bkb++P0PZiFzKEzH+1jA3Q/+5gaHgscGm1JSn/jxpkNXVfuFEKR65L2EwnHA8teh5XB4hE2fNBG6LxGe0Vs/Ed49YH7+mB4sOdVHJX9hDfzQxHI77WhQoWv/9XqD0qj0taVXHXohLXSN1L0tMcQ/Zf27Yl/sqnzCuLg2h1XBZekSbRyvoT1fZEsqIgeV3gySs56b+P1KNMbNH6Zf8KT49YhhS9fMFb82RQ3N/izf/UKl5CQFJZueAapK6Xvfgoh1UN2Z6/frWU+hIKdh/iiNSSrcjjiO3nAbgvk1Sf17gb4PT1Xdzsn657WO5Clb6/VbZN3fO7v/oX77bm6+3yu7pYpHvem+BP+Yeik8deZ4nVPmm7AEh8JUD2zGjF2vIq/d+Qfy9sP3L/5y3lbpnj9s4O9Ne0bYohYuc63lcevesH+X19/SG5u/h/R2WUc
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Provides a preview of a pay schedule with the specified parameters for the next 18 months.
+
+scope: `pay_schedules:write`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-id-pay-schedules.ParamsDetails.json b/docs/api/get-v-1-companies-company-id-pay-schedules.ParamsDetails.json
new file mode 100644
index 000000000..3fe999b74
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-id-pay-schedules.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"string"},"description":"The UUID of the company"},{"schema":{"type":"integer"},"in":"query","name":"page","description":"The page that is requested. When unspecified, will load all objects unless endpoint forces pagination."},{"schema":{"type":"integer"},"in":"query","name":"per","description":"Number of objects per page. For majority of endpoints will default to 25"},{"name":"X-Gusto-API-Version","in":"header","required":false,"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.","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"}}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-id-pay-schedules.RequestSchema.json b/docs/api/get-v-1-companies-company-id-pay-schedules.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-id-pay-schedules.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-id-pay-schedules.StatusCodes.json b/docs/api/get-v-1-companies-company-id-pay-schedules.StatusCodes.json
new file mode 100644
index 000000000..8c33a445e
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-id-pay-schedules.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"Example response","content":{"application/json":{"schema":{"type":"array","items":{"allOf":[{"type":"object","title":"Pay Schedule","x-examples":{"Example":{"uuid":"f2a69c38-e2f9-4e31-b5c5-4754fc60a052","version":"68934a3e9455fa72420237eb05902327","frequency":"Twice per month","anchor_pay_date":"2020-05-15","anchor_end_of_pay_period":"2020-05-08","day_1":15,"day_2":31,"name":"Engineering","auto_pilot":false,"custom_name":"A new monthly pay schedule"}},"description":"The representation of a pay schedule.","properties":{"uuid":{"type":"string","description":"The unique identifier of the pay schedule in Gusto.","readOnly":true,"title":"Pay-Schedule-Uuid"},"frequency":{"type":"string","description":"The frequency that employees on this pay schedule are paid with Gusto.","enum":["Every week","Every other week","Twice per month","Monthly","Quarterly","Annually"],"readOnly":true,"title":"Pay-Schedule-Frequency"},"anchor_pay_date":{"type":"string","description":"The first date that employees on this pay schedule are paid with Gusto.","readOnly":true,"title":"Pay-Schedule-Anchor-Pay-Date"},"anchor_end_of_pay_period":{"type":"string","description":"The last date of the first pay period. This can be the same date as the anchor pay date.","readOnly":true,"title":"Pay-Schedule-Anchor-End-Of-Pay-Period"},"day_1":{"type":["integer","null"],"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.","readOnly":true,"title":"Pay-Schedule-Day-1"},"day_2":{"type":["integer","null"],"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, this field should be set 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.","readOnly":true,"title":"Pay-Schedule-Day-2"},"name":{"type":["string","null"],"description":"This field will be hourly when the pay schedule is for hourly employees, salaried when the pay schedule is for salaried employees, the department name if pay schedule is by department, and null when the pay schedule is for all employees.","readOnly":true,"title":"Pay-Schedule-Name"},"custom_name":{"type":"string","description":"A custom name for a pay schedule, defaults to the pay frequency description.","readOnly":true,"title":"Pay-Schedule-Custom-Name"},"auto_pilot":{"type":"boolean","description":"With Autopilot® enabled, payroll will run automatically one day before your payroll deadlines.","title":"Pay-Schedule-Auto-Pilot"},"active":{"type":"boolean","description":"Whether this pay schedule is associated with any employees. A pay schedule is inactive when it's unassigned.","readOnly":true,"title":"Pay-Schedule-Active"}},"x-tags":["Pay Schedules"],"required":["uuid"]},{"type":"object","properties":{"version":{"type":"string","example":"56d00c178bc7393b2a206ed6a86afcb4","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."}},"required":["version"],"title":"Versionable-Required"}]}},"examples":{"Example":{"value":[{"uuid":"2097fe08-407a-46d7-b35c-a32402a2355e","version":"68934a3e9455fa72420237eb05902327","frequency":"Twice per month","anchor_pay_date":"2020-05-15","anchor_end_of_pay_period":"2020-05-08","day_1":15,"day_2":31,"name":"Engineering","custom_name":"Engineering department pay schedule","auto_pilot":false,"active":true},{"uuid":"8fc9f556-74fa-4271-97f6-4bfbfc5a5352","version":"68934a3e9455fa72420237eb05902320","frequency":"Monthly","anchor_pay_date":"2020-05-31","day_1":31,"day_2":null,"name":"Sales","custom_name":"Sales department monthly schedule","auto_pilot":false,"active":false},{"uuid":"0e07d35a-af11-4123-bfcb-4dd5f2f12ee1","version":"68934a3e9455fa72420237eb05902323","frequency":"Monthly","anchor_pay_date":"2020-05-31","day_1":31,"day_2":null,"name":"Staff","custom_name":"Staff department pay schedule","auto_pilot":true,"active":false}]}}}}},"404":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided UUID is valid.\n"}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-id-pay-schedules.api.mdx b/docs/api/get-v-1-companies-company-id-pay-schedules.api.mdx
new file mode 100644
index 000000000..4f4b16817
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-id-pay-schedules.api.mdx
@@ -0,0 +1,71 @@
+---
+id: get-v-1-companies-company-id-pay-schedules
+title: "Get the pay schedules for a company"
+description: "The pay schedule object in Gusto captures the details of when employees work and when they should be paid. A company can have multiple pay schedules."
+sidebar_label: "Get the pay schedules for a company"
+hide_title: true
+hide_table_of_contents: true
+api: eJzdWd1uI7cVfhWWvdgEGMrSSLJsXVXI/sAXybrZbFPANhxqeMbiLoeckBzZA0NAHiR9hT5EH2WfpDjkjDSyJFebdAuke7MWhzz8+PH885E+sLvKecOk9nBnuZdGM1+XQKdXFIo5CAGCJpSXZXeKozcJLbnlBXiwjk6vHqnmBdApzUxRcl3fSlwmNZ3SkvsFTaiFnytpQdCptxUk1GULKDidPtK4H3XeSn1HVwkV4DIrS9yJTukPCyDv31+8JCYnfgGk2YGuksddIQEkWJQSNv+5AlvTpEVX8jug+zbAD8QvuCfSEYQKzoPokR8XoEmlXQmZzCWIhNxLpYgyXBCuFDHzD5B5RyqtwDkCWpRGak9yYzNwKFbqQFnvt+EFuwP3u6qYg0U22s1LsOEAPfLaWFLwD8ZKX+OMFo+LsAXkvFKeeEPScQDU7PN39iaowezygv0NrMOdGkQL4CKg2FxgzpWDp7BeoioUUoMLtyS4BzbnDgSZXV6QZRRKuHMmk9yDIPfSL0htKhsmZFypHrnIiTYa8BJKa5ZSIONhDi9LJbNA5QtHrgqpZVEVXdk3Xy28L9305ESYzPWCXvcyU5y0esxKXlujVPh+wkvJmpVS3/25Ecg6w18jjMqB6NHD6ppQ0FWB5pL20zHrn7LBGK2joZpOu+Or1Q3y6EqjHTgUlvb7+N82la8eeFEqIO1MmtDMaA/a49wOEycfHC7Yo1fcWo56JD0UYSOu1Ns8GGozIyoPTaiXXuHAJa/Ju2wBolK44wODCCMsbyDhn1UlBZ3SPOWn59nwjEGan7MRDAdsPs7GbDQZj/LstM/745QmtOGSTunp2flwxIdwPhqPcz5JR2k/HU5g3h+f99NhOqEJzYPl6axGq7yXGQTVLowOHoTrbGHsbcnrW9SuSG2f9cdI7fozaHFr8jCrBCuN6Mzrn6E18fp2QKeDcfwzpdPhYG1wr/Sd1ADN1fLKm9tSKuPXSp+hWhW3zfQZ0XAfAaqalLwmrmVwtdeRWSgtONA+3B+aKN9ahqpWWlOC9TIyH+neVbtd2ZWWP1dApADt0VnZ1mN2NyBSk2DrvWDSXLzVqm59ckcVWKsK7D0CWG1dzjFo1tOjW4WiVKYGcMRo4hdo4F1U3CJM2XiFNcDWtl4twdbkHuAjTZofxi/AtkO7yvJtvBOa0L9W3Hqw4e+Z1hVXqqY3Rx7+9frQqz0KeBQP0jof3OHvIeIosLOAj+HYS8S3es4ojsGueAu90aR4GAQcxfTID3iCjGsyhzDD8SI6f8JjIIgIwhoc/tzDvNKCvc3DmS4j8tXahNsjXK3DaEJ1pVT0v93DzDRpppA5+HsATQaEa0GGAyK1CO5U33WOKHjdnjlo1NO7a6+pISCXoASGC6NVTSwoWPKYBWzdrou3ilI//fLrE6X99Ms/AqRPv/zaKC+OtGYkwfXIhY9xfA4Ez3lIfjSN7spjSX/JazZoGU6/EMMOMqPFb6a4I6JVqueIvn7qHK7pxjfFjMlBIdk+J+6SaKFxb7cwlRJIvoOQQw0HTcaFSx1+R0eD59B4bMFrl5B7iHcW1uyB7k0Ybkxtm5L/0Y2neOMxom0ufO0W9t93505agAtTWVWTe0yZd8OOC9ibOetbTojjiluJ+eBz69azOitDmgklt74A7QkegMh8Z/m87sxKgk4GKp/dD3P79VZHk/kdcrh6kiT8J0c7I3F6PEDYfAtS0qbtrtUV/LoJrx1pRwP9Juy4xtvNc9Zw58Yo4HoH74+ocLPKm7DgX/8koPlcYaLe5NdRIWylCcotuJeY3NcEE3vU8DnkxkJM69slArhQWDz06KF4UHnDLgNGRJx5uYRj0C4g2MZupJVupxrhuqOaPTLbWSB13Dgqj/QvsPLjzsk7HcuE40JbBI8Z4gPz/A4L6K3028X8pK23rmISeIMF29PsfTtZXGfbe8qUNoOn41PR72eDydk8mwzPh/OUp/1TEKf87JTn2Xy0NxXIKmvRytpCrnFTEUePvIMY/q82JRW5q6SAz6zKpICiNB4V++tgC1LnxhZNtqzJwtyjFVQOOp65F6js8tXycLO5gaasRVVl37dTVze48kChs+SqglAyNSVP2j+f5NA/Y6P+hLPRqZiw+XCcMT5MR/2Up8PxGP7oJc92fdP51nW1W4XO3jKptU+0AlTbhsGzPDvPx+NTNhnlnI3SyYCdT/JTNprn8zwb8/Hw84rG/hMGN1n/YeaGgw0jSEPDCMaENSfvOKrDUzbCaJeHNmc4jovws0NGH/oTMRxzxvPBgI0G6ZDN82zORkKM8zQfpACDzyFj+KXI8DzPd8nA0SOVIvrCbR5uVvgvoaP+aLcD8p3x5LWptCDXmpBrHUvnpiuHfRFT2QyIMOCINp7Ag3S+R77lH4G4ykZf1HaQYvdQOrLkSoretQ7uAt1mcCsXeBd34NlywGJvUYJjmz4mOqjbdb51oHvYCRPRJa7rbJLx0le2bYuB51I5dJ8hhGzS3XtjP4bkpM1L6k7CGfPgWdv7DAXXgi+BFJXyEntFW0lh71pfa5eZEqbkpy34UwxQP2GMPRR2HpgrgX8E7mp2Z01VhrZp/a5DQHcKagMzS7BWCohEzpQK8caDdqFZjC70I6BKHmw3J2tv+3zbGc2nFfUU51rGNt79S7Zxb5Y2+LFRV4BfmEY5MNJiH3tKT5aDk7WanDxu9GR18lRRHNhl2x6vrMJmahMLeSljKGQCihAPd/TqJRTmCddRHgvOA9eFox0QvFfmpTXiGZklfsaTO8gqbCEH5N/EE86yDJybVUjC1U13FlJdxOi5Z+46E0GIbSM1ZGzA7Z72diOCKViCwgxyge2s2O/EzO9d7TwUv2eHKOHABqERn5sgtckcohnPLi+2nHGnrZtQbH27t/k7sEuZQec+NvkOn5vKn4SJJwK3RgfEwm9m8nAPuHQnfwWVmSKUiQHHC0deNQZCLpvkGZvgwmRV0fYV/9R0jHkWEvrGY79sdyXfg2oMKqFQcKmCQjVf/7LRH2SjNM4XXHfkvGkq2e06NBYu7ePMk2M8bhrYf1iHGXXMw4M/KRWXQRmD8T02ruGKLgeB+MY50IROt57Dtv3DTUIXxnlc9/iILyXvrVqtcDg+AqHtCelCbbX/zWWX1S/+iHWAh+hfm9e11pUG93T8Cf5r71rPYwwOYQPxBn9YiRg/k/Gv2iria3LoifIAkvaNJsxYQ2kRdlRmdbNK2ge4zwP3f/4a98wF73/K3NLJOBFDSOk733Ye1raSgDevfqCr1b8BZ03Ftw==
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+The pay schedule object in Gusto captures the details of when employees work and when they should be paid. A company can have multiple pay schedules.
+
+scope: `pay_schedules:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-id-payroll-reversals.ParamsDetails.json b/docs/api/get-v-1-companies-company-id-payroll-reversals.ParamsDetails.json
new file mode 100644
index 000000000..3fe999b74
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-id-payroll-reversals.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"string"},"description":"The UUID of the company"},{"schema":{"type":"integer"},"in":"query","name":"page","description":"The page that is requested. When unspecified, will load all objects unless endpoint forces pagination."},{"schema":{"type":"integer"},"in":"query","name":"per","description":"Number of objects per page. For majority of endpoints will default to 25"},{"name":"X-Gusto-API-Version","in":"header","required":false,"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.","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"}}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-id-payroll-reversals.RequestSchema.json b/docs/api/get-v-1-companies-company-id-payroll-reversals.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-id-payroll-reversals.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-id-payroll-reversals.StatusCodes.json b/docs/api/get-v-1-companies-company-id-payroll-reversals.StatusCodes.json
new file mode 100644
index 000000000..598daa28f
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-id-payroll-reversals.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"Example response","content":{"application/json":{"schema":{"type":"object","properties":{"reversed_payroll_uuid":{"type":"string","description":"The UUID for the payroll run being reversed."},"reversal_payroll_uuid":{"type":"string","description":"The UUID of the payroll where the reversal was applied."},"reason":{"type":"string","description":"A reason provided by the admin who created the reversal."},"approved_at":{"type":["string","null"],"description":"Timestamp of when the reversal was approved."},"category":{"type":"string","description":"Category chosen by the admin who requested the reversal.","items":{"type":"integer"}},"reversed_employee_uuids":{"type":"array","description":"Array of affected employee UUIDs.","items":{"type":"string"}}},"title":"Payroll-Reversal"},"examples":{"Example":{"value":{"reversed_payroll_uuid":"09505984-8d8c-41a3-adbe-5740322ae8e9","reversal_payroll_uuid":"0424688e-0a2e-4cd0-ac86-42283e788fb3","reason":"Customer Request","approved_at":null,"category":"convert_check_ee_requested","reversed_employee_uuids":["5f036964-185e-4c85-bbf2-3873e1203b30"]}}}}}},"404":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided UUID is valid.\n"}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-id-payroll-reversals.api.mdx b/docs/api/get-v-1-companies-company-id-payroll-reversals.api.mdx
new file mode 100644
index 000000000..0c57d40c1
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-id-payroll-reversals.api.mdx
@@ -0,0 +1,71 @@
+---
+id: get-v-1-companies-company-id-payroll-reversals
+title: "Get approved payroll reversals"
+description: "Returns all approved Payroll Reversals for a Company."
+sidebar_label: "Get approved payroll reversals"
+hide_title: true
+hide_table_of_contents: true
+api: eJzdV0tz2zYQ/isoekg6Q0iyHo6sUz1xkvGhqcdJms7YGgUiliISEGAAULZGo//eWRCUaEtym/RxaC6OwMV++/j2gTW9Z4vKecOk9rCw3EujmV+VQCc3FIo5CAGCThPq+cLh2RVfWaOUw7OSW16AB4tf1lTzAuiEpqYouV7NpKAJlZpOaMl9ThNq4WslLQg68baChLo0h4LTyZrWgNR5K/WCbhIqwKVWlmgNndD3OZAPHy4viMmIz4FEBLpJ1vtKgiNgUUsA/1qBXdGksa7kC6CHAPAD8Tn3RDqCpoLzIDrkYw6aVNqVkMpMgkjInVSKKMMF4UoRM/8MqXek0gqcI6BFaaT2JDM2BYdqpQ5h7XyfvWD3zH1bFXOwGI0GvAQbHOiQ18aSgn82VvoVSjT2uNpsARmvlCfekP4oGBRxfmdvAg/Ory7Zb2AdIkWLcuAiWLFLYMaVg8dmXSAVCqnBhSwJ7oHNuQNBzq8uybJWSrhzJpXcgyB30udkZSobBFKuVIdcZkQbDZiE0pqlFBjxIMPLUsk0hPKZIzeF1LKoirbu6fPc+9JNul1hUtcJxO6kpug2RGZlzd7wvctLyeJNqRc/RoWsdfwTmlE5EB16nK4JBV0VWBv9Xn/EeqfsZITVEUNNJ+3zzWaKcXSl0Q4cKuv3evjnYShf3fOiVEAaSZrQ1GgP2qNsKxLdzw4vHOBVTQ2a0NKaEqyXNZwF9A3ELIZiVlVSHHLqSAlmxobsxuvEVprMQeoFaTQjzyMMV98LEyu9QbnLwUI4aRSTO+5qSmwReQzF0xDnpJbc0ovMV0EzF4XU5C43JLUQ+NnGCxi8xEsgZtzvgG52SLpSqk79A6dkAc7zokSv7rCdHHIkKA4oKfewMHb15768jJIkzY0Dve/Jto898iWh0kPhDrWhbfJAzKAolVkBhOy1pbm1fLUfWjxFJ3mWQYqojYKQVHcIt+n5iOulV3gWZwy7jvZiUKCuiHA1Vgf+d8lVBU/wmvbORr3R2XjIxmKcsuEJHzAu5sBGL4a9Qb/PYQxn9ChfaW/YH56Ox8B6vA9smIoe4+n4lA37/fEAXozH2XxAd+SjL7HnFGDJdR15+og0yJB2hrGsl2D9LM0h/TIDmG1TRp9IxA0dZb3B6dnpkJ2MR2jYeMTm86zPBuMXAzjp9wbzQY9ON+FfQoe94X6TeWs8eW0qLcitJuRWvw8UaQhjwZnKpkCEAUe08QTupfMd8gv/AsRVsR63VRTKVjqy5EqKzq0OTMLOE/rUJQZzAZ4tT1g9viU4tlsVms48axLh9th1Db6y2oWh28SURKqQhiouNChOXtaaO7f6VrvUlDAhnyKEm1jg4hNN6D1zJfAvwN2K4RhkZgnWSgG1recR5LplEtx70Dga6pXnC2AOj+5QScPP9i6FQ7e5dwx/e/GwHThECvC5iVHFLo871oR2lyfdbXy7612AN91DEXZgl836VlmFwz5OUF7KeoAyAUWYonsJuYDCPIpirY+F0sF7YcM4ovigzitrxBM6S/yM3jtIK1xxguUx2edpCs6dVxiIm2lb6h0Ox7p3HJDd9iI0sRn0+HsO3B5Yv6IKpmAJivDK56B9nMfYqt6tnIfi7yDUGo4AhEUxM0FrbJhhdcNNCIkTl7cHa0dCcTVzv2bvwC5lCq187LYkPjeV7wbBrkBorF4WfjOThTzg1cfGfgSVmgJwpQx2PHPkVST7tjxxSRMmrQrQPrjxQ9xoeBomaVxCLxpUcg0qyIWaK7hUgVDx6887/mA0SuN8wXVLzxvwuxax3VSOdZb1brf6F5pMzLyHe98tFZeBIqEk1rFob+jyJIQjli1N6OTBI2q/cqcJzY3zeHe9xh37g1WbDR7XzwesCiEdn6tj23rb6f/o+XMkFnUvjO+ypu2FxvHXPfjHXkRP2xhKdWfiFH9YiTZ+Y8SfX8en1E/k2OP2iCXNAhYktqY0FrZos5lukubp9m3G/c/fcU8k+PAj+AEna0Fs7qVvfdt7kj0Y0W9evaebzR9R+BXq
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Returns all approved Payroll Reversals for a Company.
+
+scope: `payrolls:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-id-payrolls-id-partner-disbursements.ParamsDetails.json b/docs/api/get-v-1-companies-company-id-payrolls-id-partner-disbursements.ParamsDetails.json
new file mode 100644
index 000000000..5966b196e
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-id-payrolls-id-partner-disbursements.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"company_id","in":"path","description":"The UUID of the company","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"The UUID of the payroll","required":true,"schema":{"type":"string"}},{"name":"X-Gusto-API-Version","in":"header","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"},"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."}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-id-payrolls-id-partner-disbursements.RequestSchema.json b/docs/api/get-v-1-companies-company-id-payrolls-id-partner-disbursements.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-id-payrolls-id-partner-disbursements.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-id-payrolls-id-partner-disbursements.StatusCodes.json b/docs/api/get-v-1-companies-company-id-payrolls-id-partner-disbursements.StatusCodes.json
new file mode 100644
index 000000000..41824827b
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-id-payrolls-id-partner-disbursements.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"successful","content":{"application/json":{"schema":{"type":"object","description":"Partner disbursements for a payroll","x-examples":{"success_status":{"payroll_uuid":"123e4567-e89b-12d3-a456-426655440000","disbursements":[{"employee_uuid":"123e4567-e89b-12d3-a456-426655440001","payment_method":"Check","payment_status":"Not partner managed"},{"employee_uuid":"123e4567-e89b-12d3-a456-426655440002","payment_method":"Direct Deposit","payment_status":"Pending"}]}},"properties":{"payroll_uuid":{"type":"string","description":"The UUID of the payroll"},"disbursements":{"type":"array","description":"List of disbursements for the payroll","items":{"type":"object","properties":{"employee_uuid":{"type":"string","description":"The UUID of the employee"},"payment_method":{"type":"string","description":"The payment method for the disbursement","enum":["Direct Deposit","Check"]},"payment_status":{"type":"string","description":"The status of the payment","enum":["Pending","Paid","Not partner managed","Converted to check"]}}}}},"title":"Payroll-Partner-Disbursements"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided ID/UUID is valid.","type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["error_key","category"],"properties":{"error_key":{"type":"string","description":"Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error."},"category":{"type":"string","description":"Specifies the type of error. The category provides error groupings and can be used to build custom error handling in your integration."},"message":{"type":"string","description":"Provides details about the error - generally this message can be surfaced to an end user."}}}}},"x-examples":{"not_found":{"errors":[{"error_key":"request","category":"not_found","message":"The requested resource was not found."}]}},"title":"Not-Found-Error-Object"}}}}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-id-payrolls-id-partner-disbursements.api.mdx b/docs/api/get-v-1-companies-company-id-payrolls-id-partner-disbursements.api.mdx
new file mode 100644
index 000000000..c839c6410
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-id-payrolls-id-partner-disbursements.api.mdx
@@ -0,0 +1,71 @@
+---
+id: get-v-1-companies-company-id-payrolls-id-partner-disbursements
+title: "Get partner disbursements for a payroll"
+description: "Get partner disbursements for a specific payroll."
+sidebar_label: "Get partner disbursements for a payroll"
+hide_title: true
+hide_table_of_contents: true
+api: eJzdWG1v2zYQ/isc96EdIFpOmmSbPy2ouyLA1hpNug1wjJQWzzIbiVRJyolh6L8PR1K2/NY23fZl/VJLOt7rc3cPs6K6AsOd1OpK0AHNwbHFCct0WXElwcZfyzspWMWXRheFZf63cQrMnZB2WhsLJShnaUIF2MzICvXRAX0NjkRJsiVJZtoQTmwFmZzJjETVvVt1q2ymKxiQDwdNDAxw8YEm1PHc0sGYjqJTdJLQR5bX1mkmlYM8BMXcsgKUg3IKQoBAuYobXoIDgxpWVPES6IBuIqUJleh+xd18L6abOZD376+GRM+ImwOJx2hCDXyqpQFBB87UkFCbzaHkdLCiwQlqnZEqp02TrI0+0VjM0zca+4u99vm5HF2xP8BYtBGtz4ELMPS4noSCqkvM5Gn/9Jz1L9jJOeZSwIzXhaOD7vtmN44hZruUCqwPQ3AHbMotCHI5uiKL4Avh1upMcgeCPEg3J0tdGy+Q8aLokasZUVoBkZZURi+kAJEEGV5Vhcx8wZ9ZMi6lkmVddnVPns+dq+wgTYXObM/jpJfpMm1x0aLbf095JVk8KVX+fVTIOq9/QDdqC6JHm0lCLWS1kW7pAfUyQOIyy8Day9rN6WA8aToANfaB523lDNhKKwsWk37a7+N/29mztdc0q7HwmVYOlEOpTtjpR4uiq/366elHyNweskafacsNyh4ZPPKyKoJz0Y8767ir/ZsoeVfXEqfHyekLODu/+JHBTz9P2cmpeMH42fkFOzu9uDg/Pzvr9/t99GRraGDGoKwKvQR4gqITio28RB13Jbi5xnMv55Dddz60ntI3ejOJSq54DoJiZ3yD4dNDhofSQObIECptpTvkwQiU8A05aZqEVgbnrpNwII37rfd1Q6HZy+xaEzeGL/cU/SatQyX7GNieNdJBaQ9BajuKnVw+NYz2OMaxm9+v0RXPkHBmHUY3uM4U2ytYgM6k2S/d1xgPsp2K7Jhrq5/QEfcz/xAgE/pSqwUYHIBOkyx6hP8S6qQrwDeuLwuLDcyGWyUPsmf9s/0pghZ/1bUSTxkiR1SQW0XIrcLIcRGBRZcNWF2bDIjQYInSjsCjtK5Hfuf3QGxtICQnzm5yNUx9/aUlC15I0cO1voOwzZobUzBGG7/od3AX3u+j/Shu97Te3QMeyLiDXJvlERte6otwuA6kBix5mEOM2R8nOstqY3vkZllJXGlL4ubSkntYEilAuXAK5blzRk5rB+maqxADBY/IWKvsYbOsvX6Ca6gBZRGxQRPBYraq2iLZ6HludF1JlVvClSAZV2QKfvuhN9NaFoJkuNnKKD/nShRS5USqsKE7lMz7XIK1PIcvuzxqHRHguCws4VNdu05SGclBgdmkM6puvbS1mfEseMoVASXQccxc6JXtFae0u5v5JukAa7xVfxoR38XLoHOwExw90iAPPPSHP9CLK6Ft8DfaMd9k7BUaZW8DaqO78OhAIQEJfgWPjhLfhC54Ue8QYNx72+cCH1kLIy9BurLebjmElYZMhqaLk3R9P0hXG9rcpO0NIV2Fp8N3BAtm0XLv2hTIPiM345UM1IwJKD0/28PDEErtiYmtgN8Dt0sW9DG/v/GcX+xHFB/UOTJafEZnhZ+7JO8ax2PAywGqt0Y0Gm8ZNT5PgRvPsbetRxWsgAUUhNdujqMgTGRsleuldVD+EwtBwxEDDd4AZtprjQj0twRkzwiJeE/Y4vcJRTpv386uwSxkBp1Mb5i1b9TUC6YCTeM8Zf6Z6ZnPMB7ddfZPKDJdArar9+OZJa8idEncfZ7YC53ViCgfxndxp/HM77R43xm2Vsk7nJ2+aRIKJZeFh0r8+ssGGZ6aaetKrjp6vnSN3TClrVBWmzX7n96EAxYcPLq0Krj0oPHwX8WWHdPFiU9QbFqa0MHWbbftW/wQXxxq3UlC59o6VLha4fXtvSmaBl9/qgGn4HiCM8RIPkUcjVfIR/G3oIMZLyx8JkHP38Wd/AM5fsM+GGq79L1EnGCUJnHEdeLEsfCvOLSp9zc4hI4gy4w37qdl6X99jz6SzpC2w3+7WGd3s9NwUFau822P4G6tttevbmhC+fZcXc/R+AOLdLCqq1WQuNH3oJpmXWSHz36vN38DUx/EKg==
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Get partner disbursements for a specific payroll.
+
+scope: `partner_disbursements:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-id-payrolls-payroll-id.ParamsDetails.json b/docs/api/get-v-1-companies-company-id-payrolls-payroll-id.ParamsDetails.json
new file mode 100644
index 000000000..f6029de22
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-id-payrolls-payroll-id.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"company_id","in":"path","description":"The UUID of the company","required":true,"schema":{"type":"string"}},{"name":"payroll_id","in":"path","description":"The UUID of the payroll","required":true,"schema":{"type":"string"}},{"name":"X-Gusto-API-Version","in":"header","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"},"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."},{"name":"include","in":"query","explode":false,"required":false,"schema":{"type":"array","items":{"type":"string","enum":["benefits","deductions","taxes","payroll_status_meta","totals","risk_blockers","reversals","payroll_taxes"]}},"description":"Include the requested attribute in the response, for multiple attributes comma separate the values, i.e. `?include=benefits,deductions,taxes`"},{"name":"page","in":"query","required":false,"description":"The page that is requested. When unspecified, will load all objects unless endpoint forces pagination.","schema":{"type":"integer"}},{"name":"per","in":"query","required":false,"description":"Number of objects per page. For majority of endpoints will default to 25","schema":{"type":"integer"}},{"name":"sort_by","in":"query","required":false,"schema":{"type":"string","enum":["first_name","last_name"]},"description":"Field to sort employee compensations by"}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-id-payrolls-payroll-id.RequestSchema.json b/docs/api/get-v-1-companies-company-id-payrolls-payroll-id.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-id-payrolls-payroll-id.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-id-payrolls-payroll-id.StatusCodes.json b/docs/api/get-v-1-companies-company-id-payrolls-payroll-id.StatusCodes.json
new file mode 100644
index 000000000..cfa312d4f
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-id-payrolls-payroll-id.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"successful with wait_for_reverse_wire credit blocker","content":{"application/json":{"schema":{"type":"object","x-examples":{"success_status":{"uuid":"b441a30b-2adb-489e-b7b7-9d094011a3f8","employee_compensations":[],"submission_blockers":[],"credit_blockers":[],"payroll_uuid":"b441a30b-2adb-489e-b7b7-9d094011a3f8","company_uuid":"9aa93530-43d5-484e-b608-33214109420d","off_cycle":false,"auto_pilot":false,"processed":true,"processed_date":"2025-06-16","calculated_at":"2025-06-16T16:58:03Z","pay_period":{"start_date":"2025-05-25","end_date":"2025-06-09","pay_schedule_uuid":"40ff5990-0191-4796-9717-32f7dd3e94d5"},"check_date":"2025-06-13","external":false,"payroll_deadline":"2025-06-17T23:00:00Z","totals":{"employee_bonuses":"0.00","employee_commissions":"0.00","employee_cash_tips":"0.00","employee_paycheck_tips":"0.00","additional_earnings":"0.00","owners_draw":"0.00","benefits":"0.00","check_amount":"0.00","child_support_debit":"0.00","company_debit":"0.00","deferred_payroll_taxes":"0.00","employee_benefits_deductions":"0.00","employee_taxes":"0.00","employer_taxes":"0.00","gross_pay":"0.00","imputed_pay":"0.00","net_pay":"0.00","net_pay_debit":"0.00","other_deductions":"0.00","reimbursement_debit":"0.00","reimbursements":"0.00","tax_debit":"0.00"},"processing_request":{"status":"submit_success","errors":[]},"created_at":"2025-06-16T16:58:03Z","partner_owned_disbursement":null},"with_submit_wire_credit_blocker":{"uuid":"b441a30b-2adb-489e-b7b7-9d094011a3f8","employee_compensations":[],"submission_blockers":[],"credit_blockers":[{"blocker_type":"waiting_for_wire_in","blocker_name":"Waiting for Wire In","unblock_options":[{"unblock_type":"submit_wire","check_date":"2025-06-13","metadata":{"wire_in_amount":"15000.00","wire_in_deadline":"2025-06-12T18:00:00Z","wire_in_request_uuid":"c1234567-89ab-cdef-0123-456789abcdef"}}],"selected_option":null,"status":"unresolved"}],"payroll_uuid":"b441a30b-2adb-489e-b7b7-9d094011a3f8","company_uuid":"9aa93530-43d5-484e-b608-33214109420d","off_cycle":false,"auto_pilot":false,"processed":true,"processed_date":"2025-06-16","calculated_at":"2025-06-16T16:58:03Z","pay_period":{"start_date":"2025-05-25","end_date":"2025-06-09","pay_schedule_uuid":"40ff5990-0191-4796-9717-32f7dd3e94d5"},"check_date":"2025-06-13","external":false,"payroll_deadline":"2025-06-17T23:00:00Z","totals":{"employee_bonuses":"0.00","employee_commissions":"0.00","employee_cash_tips":"0.00","employee_paycheck_tips":"0.00","additional_earnings":"0.00","owners_draw":"0.00","benefits":"0.00","check_amount":"0.00","child_support_debit":"0.00","company_debit":"0.00","deferred_payroll_taxes":"0.00","employee_benefits_deductions":"0.00","employee_taxes":"0.00","employer_taxes":"0.00","gross_pay":"0.00","imputed_pay":"0.00","net_pay":"0.00","net_pay_debit":"0.00","other_deductions":"0.00","reimbursement_debit":"0.00","reimbursements":"0.00","tax_debit":"0.00"},"processing_request":{"status":"submit_success","errors":[]},"created_at":"2025-06-16T16:58:03Z","partner_owned_disbursement":null},"with_submit_bank_screenshot_credit_blocker":{"uuid":"b441a30b-2adb-489e-b7b7-9d094011a3f8","employee_compensations":[],"submission_blockers":[],"credit_blockers":[{"blocker_type":"waiting_for_bank_screenshot","blocker_name":"Waiting for Bank Screenshot","unblock_options":[{"unblock_type":"submit_bank_screenshot","check_date":"2025-06-13","metadata":{"information_request_uuid":"d2234567-89ab-cdef-0123-456789abcdef"}}],"selected_option":null,"status":"unresolved"}],"payroll_uuid":"b441a30b-2adb-489e-b7b7-9d094011a3f8","company_uuid":"9aa93530-43d5-484e-b608-33214109420d","off_cycle":false,"auto_pilot":false,"processed":true,"processed_date":"2025-06-16","calculated_at":"2025-06-16T16:58:03Z","pay_period":{"start_date":"2025-05-25","end_date":"2025-06-09","pay_schedule_uuid":"40ff5990-0191-4796-9717-32f7dd3e94d5"},"check_date":"2025-06-13","external":false,"payroll_deadline":"2025-06-17T23:00:00Z","totals":{"employee_bonuses":"0.00","employee_commissions":"0.00","employee_cash_tips":"0.00","employee_paycheck_tips":"0.00","additional_earnings":"0.00","owners_draw":"0.00","benefits":"0.00","check_amount":"0.00","child_support_debit":"0.00","company_debit":"0.00","deferred_payroll_taxes":"0.00","employee_benefits_deductions":"0.00","employee_taxes":"0.00","employer_taxes":"0.00","gross_pay":"0.00","imputed_pay":"0.00","net_pay":"0.00","net_pay_debit":"0.00","other_deductions":"0.00","reimbursement_debit":"0.00","reimbursements":"0.00","tax_debit":"0.00"},"processing_request":{"status":"submit_success","errors":[]},"created_at":"2025-06-16T16:58:03Z","partner_owned_disbursement":null},"with_respond_to_high_risk_fraud_rfi_credit_blocker":{"uuid":"b441a30b-2adb-489e-b7b7-9d094011a3f8","employee_compensations":[],"submission_blockers":[],"credit_blockers":[{"blocker_type":"waiting_for_high_risk_fraud_rfi","blocker_name":"Waiting for High Risk Fraud RFI","unblock_options":[{"unblock_type":"respond_to_high_risk_fraud_rfi","check_date":"2025-06-13","metadata":{"information_request_uuid":"e3234567-89ab-cdef-0123-456789abcdef"}}],"selected_option":null,"status":"pending_review"}],"payroll_uuid":"b441a30b-2adb-489e-b7b7-9d094011a3f8","company_uuid":"9aa93530-43d5-484e-b608-33214109420d","off_cycle":false,"auto_pilot":false,"processed":true,"processed_date":"2025-06-16","calculated_at":"2025-06-16T16:58:03Z","pay_period":{"start_date":"2025-05-25","end_date":"2025-06-09","pay_schedule_uuid":"40ff5990-0191-4796-9717-32f7dd3e94d5"},"check_date":"2025-06-13","external":false,"payroll_deadline":"2025-06-17T23:00:00Z","totals":{"employee_bonuses":"0.00","employee_commissions":"0.00","employee_cash_tips":"0.00","employee_paycheck_tips":"0.00","additional_earnings":"0.00","owners_draw":"0.00","benefits":"0.00","check_amount":"0.00","child_support_debit":"0.00","company_debit":"0.00","deferred_payroll_taxes":"0.00","employee_benefits_deductions":"0.00","employee_taxes":"0.00","employer_taxes":"0.00","gross_pay":"0.00","imputed_pay":"0.00","net_pay":"0.00","net_pay_debit":"0.00","other_deductions":"0.00","reimbursement_debit":"0.00","reimbursements":"0.00","tax_debit":"0.00"},"processing_request":{"status":"submit_success","errors":[]},"created_at":"2025-06-16T16:58:03Z","partner_owned_disbursement":null},"with_wait_for_reverse_wire_credit_blocker":{"uuid":"b441a30b-2adb-489e-b7b7-9d094011a3f8","employee_compensations":[],"submission_blockers":[],"credit_blockers":[{"blocker_type":"waiting_for_reverse_wire","blocker_name":"Waiting for Reverse Wire","unblock_options":[{"unblock_type":"wait_for_reverse_wire","check_date":"2025-06-13","metadata":{"reverse_wire_detail_id":12345,"bank_account_last_four_digits":"1234"}}],"selected_option":null,"status":"resolved"}],"payroll_uuid":"b441a30b-2adb-489e-b7b7-9d094011a3f8","company_uuid":"9aa93530-43d5-484e-b608-33214109420d","off_cycle":false,"auto_pilot":false,"processed":true,"processed_date":"2025-06-16","calculated_at":"2025-06-16T16:58:03Z","pay_period":{"start_date":"2025-05-25","end_date":"2025-06-09","pay_schedule_uuid":"40ff5990-0191-4796-9717-32f7dd3e94d5"},"check_date":"2025-06-13","external":false,"payroll_deadline":"2025-06-17T23:00:00Z","totals":{"employee_bonuses":"0.00","employee_commissions":"0.00","employee_cash_tips":"0.00","employee_paycheck_tips":"0.00","additional_earnings":"0.00","owners_draw":"0.00","benefits":"0.00","check_amount":"0.00","child_support_debit":"0.00","company_debit":"0.00","deferred_payroll_taxes":"0.00","employee_benefits_deductions":"0.00","employee_taxes":"0.00","employer_taxes":"0.00","gross_pay":"0.00","imputed_pay":"0.00","net_pay":"0.00","net_pay_debit":"0.00","other_deductions":"0.00","reimbursement_debit":"0.00","reimbursements":"0.00","tax_debit":"0.00"},"processing_request":{"status":"submit_success","errors":[]},"created_at":"2025-06-16T16:58:03Z","partner_owned_disbursement":null}},"properties":{"payroll_deadline":{"type":"string","format":"date-time","description":"A timestamp that is the deadline for the payroll to be run in order for employees to be paid on time. If payroll has not been run by the deadline, a prepare request will update both the check date and deadline to reflect the soonest employees can be paid and the deadline by which the payroll must be run in order for said check date to be met.","readOnly":true,"title":"Payroll-Deadline-Type"},"check_date":{"type":"string","description":"The date on which employees will be paid for the payroll.","readOnly":true,"title":"Payroll-Check-Date-Type"},"processed":{"type":"boolean","description":"Whether or not the payroll has been successfully processed. Note that processed payrolls cannot be updated. Additionally, a payroll is not guaranteed to be processed just because the payroll deadline has passed. Late payrolls are not uncommon. Conversely, users may choose to run payroll before the payroll deadline.","readOnly":true,"title":"Payroll-Processed-Type"},"processed_date":{"type":["string","null"],"description":"The date at which the payroll was processed. Null if the payroll isn't processed yet.","readOnly":true,"title":"Payroll-Processed-Date-Type"},"calculated_at":{"type":["string","null"],"format":"date-time","description":"A timestamp of the last valid payroll calculation. Null if there isn't a valid calculation.","readOnly":true,"title":"Payroll-Calculated-At-Type"},"uuid":{"type":"string","description":"The UUID of the payroll.","readOnly":true,"title":"Payroll-Payroll-Uuid-Type"},"payroll_uuid":{"type":"string","description":"The UUID of the payroll.","readOnly":true,"title":"Payroll-Payroll-Uuid-Type"},"company_uuid":{"type":"string","description":"The UUID of the company for the payroll.","readOnly":true,"title":"Payroll-Company-Uuid-Type"},"off_cycle":{"type":"boolean","description":"Indicates whether the payroll is an off-cycle payroll","readOnly":true,"title":"Payroll-Off-Cycle-Type"},"off_cycle_reason":{"anyOf":[{"type":"string","enum":["Adhoc","Benefit reversal","Bonus","Correction","Dismissed employee","Hired employee","Wage correction","Tax reconciliation","Reversal","Disability insurance distribution","Transition from old pay schedule"]},{"type":"null"}],"description":"The off-cycle reason. Only included for off-cycle payrolls.","readOnly":true,"title":"Off-Cycle-Reason-Type"},"auto_pilot":{"type":"boolean","description":"Indicates whether the payroll is an auto pilot payroll","readOnly":true,"title":"Auto-Pilot-Type"},"external":{"type":"boolean","description":"Indicates whether the payroll is an external payroll","readOnly":true,"title":"Payroll-External-Type"},"final_termination_payroll":{"type":"boolean","description":"Indicates whether the payroll is the final payroll for a terminated employee. Only included for off-cycle payrolls.","readOnly":true,"title":"Payroll-Final-Termination-Payroll-Type"},"withholding_pay_period":{"type":"string","description":"The payment schedule tax rate the payroll is based on. Only included for off-cycle payrolls.","readOnly":true,"nullable":false,"enum":["Every week","Every other week","Twice per month","Monthly","Quarterly","Semiannually","Annually"],"title":"Payroll-Withholding-Pay-Period-Type"},"skip_regular_deductions":{"type":["boolean","null"],"description":"Block regular deductions and contributions for this payroll. Only included for off-cycle payrolls.","readOnly":true,"title":"Payroll-Skip-Regular-Deductions-Type"},"fixed_withholding_rate":{"type":["boolean","null"],"description":"Enable taxes to be withheld at the IRS's required rate of 22% for federal income taxes. State income taxes will be taxed at the state's supplemental tax rate. Otherwise, we'll sum the entirety of the employee's wages and withhold taxes on the entire amount at the rate for regular wages. Only included for off-cycle payrolls.","readOnly":true,"title":"Payroll-Fixed-Withholding-Rate-Type"},"pay_period":{"type":"object","readOnly":true,"properties":{"start_date":{"type":"string","description":"The start date, inclusive, of the pay period.","readOnly":true},"end_date":{"type":"string","description":"The start date, inclusive, of the pay period.","readOnly":true},"pay_schedule_uuid":{"type":["string","null"],"description":"The UUID of the pay schedule for the payroll.","readOnly":true}},"title":"Payroll-Pay-Period-Type"},"payroll_status_meta":{"type":"object","description":"Information about the payroll's status and expected dates","properties":{"cancellable":{"type":"boolean","description":"true if the payroll may be cancelled.","readOnly":true},"expected_check_date":{"type":"string","description":"The date an employee will be paid if the payroll is submitted now.","readOnly":true},"initial_check_date":{"type":"string","description":"The normal check date for the associated pay period.","readOnly":true},"expected_debit_time":{"type":"string","description":"The time the employer's account will be debited if the payroll is submitted now.","readOnly":true},"payroll_late":{"type":"boolean","description":"expected_check_date > initial_check_date.","readOnly":true},"initial_debit_cutoff_time":{"type":"string","description":"Payroll must be submitted at or before this time to avoid late payroll.","readOnly":true}},"title":"Payroll-Payroll-Status-Meta-Type"},"totals":{"type":"object","description":"The subtotals for the payroll.","properties":{"company_debit":{"type":"string","description":"The total company debit for the payroll.","readOnly":true},"net_pay_debit":{"type":"string","minLength":1,"description":"The total company net pay for the payroll."},"tax_debit":{"type":"string","description":"The total tax debit for the payroll.","readOnly":true},"reimbursement_debit":{"type":"string","description":"The total reimbursement debit for the payroll.","readOnly":true},"child_support_debit":{"type":"string","description":"The total child support debit for the payroll.","readOnly":true},"reimbursements":{"type":"string","description":"The total reimbursements for the payroll.","readOnly":true},"net_pay":{"type":"string","description":"The net pay amount for the payroll.","readOnly":true},"gross_pay":{"type":"string","description":"The gross pay amount for the payroll.","readOnly":true},"employee_bonuses":{"type":"string","description":"The total employee bonuses amount for the payroll.","readOnly":true},"employee_commissions":{"type":"string","description":"The total employee commissions amount for the payroll.","readOnly":true},"employee_cash_tips":{"type":"string","description":"The total employee cash tips amount for the payroll.","readOnly":true},"employee_paycheck_tips":{"type":"string","description":"The total employee paycheck tips amount for the payroll.","readOnly":true},"additional_earnings":{"type":"string","description":"The total additional earnings amount for the payroll.","readOnly":true},"owners_draw":{"type":"string","description":"The total owner's draw for the payroll.","readOnly":true},"check_amount":{"type":"string","description":"The total check amount for the payroll.","readOnly":true},"employer_taxes":{"type":"string","description":"The total amount of employer paid taxes for the payroll.","readOnly":true},"employee_taxes":{"type":"string","description":"The total amount of employee paid taxes for the payroll.","readOnly":true},"benefits":{"type":"string","description":"The total amount of company contributed benefits for the payroll.","readOnly":true},"employee_benefits_deductions":{"type":"string","description":"The total amount of employee deducted benefits for the payroll.","readOnly":true},"imputed_pay":{"type":"string","description":"The total amount of imputed pay for the payroll.","readOnly":true},"deferred_payroll_taxes":{"type":"string","description":"The total amount of payroll taxes deferred for the payroll, such as allowed by the CARES act.","readOnly":true},"other_deductions":{"type":"string","description":"The total amount of deductions for the payroll."}},"readOnly":true,"title":"Payroll-Totals-Type"},"company_taxes":{"type":"array","uniqueItems":false,"description":"An array of taxes applicable to this payroll in addition to taxes included in `employee_compensations`. Only included for processed or calculated payrolls when `taxes` is present in the `include` parameter.","items":{"type":"object","properties":{"name":{"type":"string","description":"The tax name"},"employer":{"type":"boolean","description":"Whether this tax is an employer or employee tax"},"amount":{"type":"string","description":"The amount of this tax for the payroll"}}},"title":"Payroll-Company-Taxes-Type"},"payroll_taxes":{"type":"array","uniqueItems":false,"description":"An array of tax totals applicable to this payroll. Only included for processed or calculated payrolls when `payroll_taxes` is present in the `include` parameter.","items":{"type":"object","properties":{"name":{"type":"string","description":"The tax name"},"employer":{"type":"boolean","description":"Whether this tax is an employer or employee tax"},"amount":{"type":"number","description":"The total tax for the payroll"}}},"title":"Payroll-Taxes-Type"},"payment_speed_changed":{"type":"object","description":"Only applicable when a payroll is moved to four day processing instead of fast ach.","properties":{"original_check_date":{"type":"string","description":"Original check date when fast ach applies.","readOnly":true},"current_check_date":{"type":"string","description":"Current check date.","readOnly":true},"original_debit_date":{"type":"string","description":"Original debit date when fast ach applies.","readOnly":true},"current_debit_date":{"type":"string","description":"Current debit date.","readOnly":true},"reason":{"type":"string","description":"The reason why the payroll is moved to four day.","readOnly":true}},"title":"Payroll-Payment-Speed-Changed-Type"},"created_at":{"type":"string","format":"date-time","description":"Datetime for when the resource was created.","readOnly":true,"title":"Created-At-Type"},"submission_blockers":{"type":"array","description":"Only included for processed or calculated payrolls","uniqueItems":true,"items":{"type":"object","description":"A blocker that prevents payment submission.","properties":{"blocker_type":{"type":"string","description":"The type of blocker that's blocking the payment submission.","readOnly":true},"blocker_name":{"type":"string","description":"The name of the submission blocker.","readOnly":true},"unblock_options":{"type":"array","uniqueItems":true,"items":{"type":"object","properties":{"unblock_type":{"type":"string","description":"The type of unblock option for the submission blocker.","readOnly":true},"check_date":{"type":"string","description":"The payment check date associated with the unblock option.","readOnly":true},"metadata":{"type":"object","additionalProperties":true,"description":"Additional data associated with the unblock option.","readOnly":true}}},"description":"The available options to unblock a submission blocker.","readOnly":true},"selected_option":{"type":["string","null"],"description":"The unblock option that's been selected to resolve the submission blocker.","readOnly":false},"status":{"type":"string","description":"The status of the submission blocker.","enum":["unresolved","resolved"],"readOnly":true}},"title":"Payroll-Submission-Blocker-Type"},"title":"Payroll-Submission-Blockers-Type"},"credit_blockers":{"type":"array","description":"Only included for processed payrolls","uniqueItems":true,"items":{"type":"object","description":"A blocker that prevents payment crediting.","properties":{"blocker_type":{"type":"string","description":"The type of blocker that's blocking the payment from being credited.","readOnly":true},"blocker_name":{"type":"string","description":"The name of the credit blocker.","readOnly":true},"unblock_options":{"type":"array","uniqueItems":true,"items":{"oneOf":[{"type":"object","description":"Unblock option to resolve a credit blocker by submitting a wire transfer","required":["unblock_type","check_date","metadata"],"properties":{"unblock_type":{"type":"string","enum":["submit_wire"],"description":"The type of unblock option for the credit blocker","readOnly":true},"check_date":{"type":"string","description":"The payment check date associated with the unblock option","readOnly":true},"metadata":{"type":"object","required":["wire_in_amount","wire_in_deadline","wire_in_request_uuid"],"properties":{"wire_in_amount":{"type":"string","description":"The amount to be wired in (decimal string)","readOnly":true},"wire_in_deadline":{"type":"string","format":"date-time","description":"Deadline for the wire transfer to be received","readOnly":true},"wire_in_request_uuid":{"type":"string","description":"UUID of the wire in request","readOnly":true}},"readOnly":true}},"title":"Payroll-Credit-Blocker-Unblock-Option-Submit-Wire"},{"type":"object","description":"Unblock option to resolve a credit blocker by submitting a bank screenshot","required":["unblock_type","check_date","metadata"],"properties":{"unblock_type":{"type":"string","enum":["submit_bank_screenshot"],"description":"The type of unblock option for the credit blocker","readOnly":true},"check_date":{"type":"string","description":"The payment check date associated with the unblock option","readOnly":true},"metadata":{"type":"object","required":["information_request_uuid"],"properties":{"information_request_uuid":{"type":"string","description":"UUID of the information request","readOnly":true},"bank_account_last_four_digits":{"type":["string","null"],"description":"Last 4 digits of the bank account number for the bank screenshot RFI","readOnly":true}},"readOnly":true}},"title":"Payroll-Credit-Blocker-Unblock-Option-Submit-Bank-Screenshot"},{"type":"object","description":"Unblock option to resolve a credit blocker by responding to high risk fraud RFI","required":["unblock_type","check_date","metadata"],"properties":{"unblock_type":{"type":"string","enum":["respond_to_high_risk_fraud_rfi"],"description":"The type of unblock option for the credit blocker","readOnly":true},"check_date":{"type":"string","description":"The payment check date associated with the unblock option","readOnly":true},"metadata":{"type":"object","required":["information_request_uuid"],"properties":{"information_request_uuid":{"type":"string","description":"UUID of the information request","readOnly":true}},"readOnly":true}},"title":"Payroll-Credit-Blocker-Unblock-Option-Respond-To-High-Risk-Fraud-Rfi"},{"type":"object","description":"Unblock option to resolve a credit blocker by waiting for reverse wire","required":["unblock_type","check_date","metadata"],"properties":{"unblock_type":{"type":"string","enum":["wait_for_reverse_wire"],"description":"The type of unblock option for the credit blocker","readOnly":true},"check_date":{"type":"string","description":"The payment check date associated with the unblock option","readOnly":true},"metadata":{"type":"object","properties":{"reverse_wire_detail_id":{"type":["integer","null"],"description":"ID of the reverse wire detail","readOnly":true},"bank_account_last_four_digits":{"type":["string","null"],"description":"Last 4 digits of the bank account number for the reverse wire","readOnly":true}},"readOnly":true}},"title":"Payroll-Credit-Blocker-Unblock-Option-Wait-For-Reverse-Wire"}],"discriminator":{"propertyName":"unblock_type","mapping":{"submit_wire":{"type":"object","description":"Unblock option to resolve a credit blocker by submitting a wire transfer","required":["unblock_type","check_date","metadata"],"properties":{"unblock_type":{"type":"string","enum":["submit_wire"],"description":"The type of unblock option for the credit blocker","readOnly":true},"check_date":{"type":"string","description":"The payment check date associated with the unblock option","readOnly":true},"metadata":{"type":"object","required":["wire_in_amount","wire_in_deadline","wire_in_request_uuid"],"properties":{"wire_in_amount":{"type":"string","description":"The amount to be wired in (decimal string)","readOnly":true},"wire_in_deadline":{"type":"string","format":"date-time","description":"Deadline for the wire transfer to be received","readOnly":true},"wire_in_request_uuid":{"type":"string","description":"UUID of the wire in request","readOnly":true}},"readOnly":true}},"title":"Payroll-Credit-Blocker-Unblock-Option-Submit-Wire"},"submit_bank_screenshot":{"type":"object","description":"Unblock option to resolve a credit blocker by submitting a bank screenshot","required":["unblock_type","check_date","metadata"],"properties":{"unblock_type":{"type":"string","enum":["submit_bank_screenshot"],"description":"The type of unblock option for the credit blocker","readOnly":true},"check_date":{"type":"string","description":"The payment check date associated with the unblock option","readOnly":true},"metadata":{"type":"object","required":["information_request_uuid"],"properties":{"information_request_uuid":{"type":"string","description":"UUID of the information request","readOnly":true},"bank_account_last_four_digits":{"type":["string","null"],"description":"Last 4 digits of the bank account number for the bank screenshot RFI","readOnly":true}},"readOnly":true}},"title":"Payroll-Credit-Blocker-Unblock-Option-Submit-Bank-Screenshot"},"respond_to_high_risk_fraud_rfi":{"type":"object","description":"Unblock option to resolve a credit blocker by responding to high risk fraud RFI","required":["unblock_type","check_date","metadata"],"properties":{"unblock_type":{"type":"string","enum":["respond_to_high_risk_fraud_rfi"],"description":"The type of unblock option for the credit blocker","readOnly":true},"check_date":{"type":"string","description":"The payment check date associated with the unblock option","readOnly":true},"metadata":{"type":"object","required":["information_request_uuid"],"properties":{"information_request_uuid":{"type":"string","description":"UUID of the information request","readOnly":true}},"readOnly":true}},"title":"Payroll-Credit-Blocker-Unblock-Option-Respond-To-High-Risk-Fraud-Rfi"},"wait_for_reverse_wire":{"type":"object","description":"Unblock option to resolve a credit blocker by waiting for reverse wire","required":["unblock_type","check_date","metadata"],"properties":{"unblock_type":{"type":"string","enum":["wait_for_reverse_wire"],"description":"The type of unblock option for the credit blocker","readOnly":true},"check_date":{"type":"string","description":"The payment check date associated with the unblock option","readOnly":true},"metadata":{"type":"object","properties":{"reverse_wire_detail_id":{"type":["integer","null"],"description":"ID of the reverse wire detail","readOnly":true},"bank_account_last_four_digits":{"type":["string","null"],"description":"Last 4 digits of the bank account number for the reverse wire","readOnly":true}},"readOnly":true}},"title":"Payroll-Credit-Blocker-Unblock-Option-Wait-For-Reverse-Wire"}}}},"description":"The available options to unblock a credit blocker.","readOnly":true},"selected_option":{"type":["string","null"],"description":"The unblock option that's been selected to resolve the credit blocker.","readOnly":false},"status":{"type":"string","description":"The status of the credit blocker","enum":["unresolved","pending_review","resolved","failed"]}},"title":"Payroll-Credit-Blocker-Type"},"title":"Payroll-Credit-Blockers-Type"},"processing_request":{"type":["object","null"],"properties":{"status":{"type":"string","description":"The status of the payroll processing request","readOnly":true,"enum":["calculating","calculate_success","submitting","submit_success","processing_failed"]},"errors":{"description":"Errors that occurred during async payroll processing","readOnly":true,"type":"array","items":{"type":"object","required":["error_key","category"],"properties":{"error_key":{"type":"string","description":"Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error."},"category":{"type":"string","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."},"message":{"type":"string","description":"Provides details about the error - generally this message can be surfaced to an end user."},"metadata":{"type":"object","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.","oneOf":[{"type":"object","description":"multiple entities","required":["entities"],"properties":{"entities":{"type":"array","items":{"type":"object","description":"single entity","additionalProperties":true,"properties":{"entity_type":{"type":"string","description":"Name of the entity that the error corresponds to."},"entity_uuid":{"type":"string","description":"Unique identifier for the entity."},"valid_from":{"type":["string","null"]},"valid_up_to":{"type":["string","null"]},"key":{"type":["string","null"]},"state":{"type":["string","null"]}},"title":"Metadata-With-One-Entity"}}},"title":"Metadata-With-Multiple-Entities"},{"type":"object","description":"single entity","additionalProperties":true,"properties":{"entity_type":{"type":"string","description":"Name of the entity that the error corresponds to."},"entity_uuid":{"type":"string","description":"Unique identifier for the entity."},"valid_from":{"type":["string","null"]},"valid_up_to":{"type":["string","null"]},"key":{"type":["string","null"]},"state":{"type":["string","null"]}},"title":"Metadata-With-One-Entity"}]},"errors":{"type":"array","description":"Will only exist if category is `nested_errors`. It is possible to have multiple levels of nested errors.","items":"circular(Entity-Error-Object)"}},"title":"Entity-Error-Object"}}},"title":"Payroll-Processing-Request"},"partner_owned_disbursement":{"type":["boolean","null"],"description":"Will money movement for the payroll be performed by the partner rather than by Gusto?","title":"Payroll-Partner-Owned-Disbursement-Type"},"employee_compensations":{"type":"array","uniqueItems":false,"items":{"type":"object","allOf":[{"allOf":[{"type":"object","properties":{"employee_uuid":{"type":"string","description":"The UUID of the employee.","readOnly":true},"excluded":{"type":"boolean","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.","readOnly":true},"first_name":{"type":["string","null"],"description":"The first name of the employee. Requires `employees:read` scope.","readOnly":true},"preferred_first_name":{"type":["string","null"],"description":"The preferred first name of the employee. Requires `employees:read` scope.","readOnly":true},"last_name":{"type":["string","null"],"description":"The last name of the employee. Requires `employees:read` scope.","readOnly":true},"gross_pay":{"type":["number","null"],"description":"The employee's gross pay, equal to regular wages + cash tips + payroll tips + any other additional earnings, excluding imputed income. This value is only available for processed payrolls.","readOnly":true},"net_pay":{"type":["number","null"],"description":"The employee's net pay, equal to gross_pay - employee taxes - employee deductions or garnishments - cash tips. This value is only available for processed payrolls.","readOnly":true},"check_amount":{"type":["number","null"],"description":"The employee's check amount, equal to net_pay + reimbursements. This value is only available for processed payrolls.","readOnly":true},"payment_method":{"type":["string","null"],"description":"The employee's compensation payment method. Is *only* `Historical` when retrieving external payrolls initially run outside of Gusto, then put into Gusto.","enum":["Direct Deposit","Check","Historical"]},"memo":{"type":["string","null"],"description":"Custom text that will be printed as a personal note to the employee on a paystub.","readOnly":true},"fixed_compensations":{"type":"array","uniqueItems":false,"description":"An array of fixed compensations for the employee. Fixed compensations include tips, bonuses, and one time reimbursements. If this payroll has been processed, only fixed compensations with a value greater than 0.00 are returned. For an unprocessed payroll, all active fixed compensations are returned.","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the compensation. This also serves as the unique, immutable identifier for this compensation."},"amount":{"type":"string","description":"The amount of the compensation for the pay period."},"job_uuid":{"type":"string","description":"The UUID of the job for the compensation.","readOnly":true}}}},"hourly_compensations":{"type":"array","uniqueItems":false,"description":"An array of hourly compensations for the employee. Hourly compensations include regular, overtime, and double overtime hours. If this payroll has been processed, only hourly compensations with a value greater than 0.00 are returned. For an unprocessed payroll, all active hourly compensations are returned.","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the compensation. This also serves as the unique, immutable identifier for this compensation."},"hours":{"type":"string","description":"The number of hours to be compensated for this pay period."},"amount":{"type":"string","description":"The amount of the compensation. This field is only available after the payroll is calculated and cannot be used for updating hourly compensations."},"job_uuid":{"type":"string","description":"The UUID of the job for the compensation.","readOnly":true},"compensation_multiplier":{"type":"number","description":"The amount multiplied by the base rate to calculate total compensation per hour worked.","readOnly":true},"flsa_status":{"type":"string","description":"The FLSA Status of the employee's primary job compensation","readOnly":true}}}},"paid_time_off":{"type":"array","uniqueItems":false,"description":"An array of all paid time off the employee is eligible for this pay period.","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the PTO. This also serves as the unique, immutable identifier for the PTO."},"hours":{"type":"string","description":"The hours of this PTO taken during the pay period."},"final_payout_unused_hours_input":{"type":["string","null"],"description":"The outstanding hours paid upon termination. This field is only applicable for termination payrolls."}}}},"reimbursements":{"type":"array","uniqueItems":false,"description":"An array of reimbursements for the employee.","items":{"type":"object","properties":{"amount":{"type":"string","description":"The dollar amount of the reimbursement for the pay period."},"description":{"type":["string","null"],"description":"The description of the reimbursement. Null for unnamed reimbursements."},"uuid":{"type":["string","null"],"description":"The UUID of the reimbursement. Null for unnamed reimbursements. This field is only available for unprocessed payrolls.","readOnly":true},"recurring":{"type":"boolean","description":"Whether the reimbursement is recurring. This field is only available for unprocessed payrolls.","readOnly":true}},"required":["amount","description"]}}},"title":"Payroll-Employee-Compensations-Base-Type"},{"type":"object","properties":{"version":{"type":"string","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."}},"title":"Versionable"},{"type":"object","properties":{"version":{"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."},"deductions":{"type":"array","uniqueItems":false,"description":"An array of deductions for the employee. This field is included by default for regular payrolls in version `v2025-06-15` and later.","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the deduction."},"amount":{"type":"number","description":"The amount of the deduction for the pay period."},"amount_type":{"type":"string","description":"The amount type of the deduction for the pay period. Only present for calculated or processed payrolls.","enum":["fixed","percent"]},"uuid":{"type":"string","description":"The UUID of the deduction. Only present for calculated or processed payrolls."}}}}}}],"title":"Payroll-Employee-Compensations-Type"},{"type":"object","additionalProperties":true,"properties":{"taxes":{"type":"array","uniqueItems":false,"description":"An array of employer and employee taxes for the pay period. Only included for processed or calculated payrolls when `taxes` is present in the `include` parameter.","items":{"type":"object","properties":{"name":{"type":"string","minLength":1},"employer":{"type":"boolean"},"amount":{"type":"number","minLength":1}},"required":["name","employer","amount"],"readOnly":true},"readOnly":true},"benefits":{"type":"array","uniqueItems":false,"description":"An array of employee benefits for the pay period. Benefits are only included for processed payroll when the include parameter is present.","items":{"type":"object","properties":{"name":{"type":"string","readOnly":true},"employee_deduction":{"type":"number","readOnly":true},"company_contribution":{"type":"number","readOnly":true},"imputed":{"type":"boolean"}},"readOnly":true},"readOnly":true},"deductions":{"type":"array","uniqueItems":false,"description":"An array of employee deductions for the pay period. Only included when `deductions` is present in the `include` parameter.","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the deduction."},"amount":{"type":"number","description":"The amount of the deduction for the pay period."},"amount_type":{"type":"string","description":"The amount type of the deduction for the pay period. Only present for calculated or processed payrolls.","enum":["fixed","percent"]},"uuid":{"type":"string","description":"The UUID of the deduction. Only present for calculated or processed payrolls.","readOnly":true}}}}},"title":"Payroll-Employee-Compensations-Included"}]}}},"title":"Payroll-Show"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided ID/UUID is valid.","type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["error_key","category"],"properties":{"error_key":{"type":"string","description":"Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error."},"category":{"type":"string","description":"Specifies the type of error. The category provides error groupings and can be used to build custom error handling in your integration."},"message":{"type":"string","description":"Provides details about the error - generally this message can be surfaced to an end user."}}}}},"x-examples":{"not_found":{"errors":[{"error_key":"request","category":"not_found","message":"The requested resource was not found."}]}},"title":"Not-Found-Error-Object"}}}}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-id-payrolls-payroll-id.api.mdx b/docs/api/get-v-1-companies-company-id-payrolls-payroll-id.api.mdx
new file mode 100644
index 000000000..6a8af9731
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-id-payrolls-payroll-id.api.mdx
@@ -0,0 +1,79 @@
+---
+id: get-v-1-companies-company-id-payrolls-payroll-id
+title: "Get a single payroll"
+description: "Returns a payroll. If payroll is calculated or processed, will return employee_compensations and totals. Results are paginated, with a maximum page size of 100 employee_compensations."
+sidebar_label: "Get a single payroll"
+hide_title: true
+hide_table_of_contents: true
+api: eJztPWtz3DaSfwXHrSvb2eFoJMtxrK29PcWPtaqSWCcr6621XSMMiZmBRQIMAEqaVakqP2T3z+WXXHUDIMEh52nZcTbKl1gcPBqNfqIbjetIFkxRw6U4SqODaMJMfLEbJzIvqOBMu3/NhjyNCzpTMsu0/8eQp1EvSplOFC9ghOggOmGmVEITSlyjPjka+38TrklCs6TMqGEpkYoUSiZMa5b2yCXPMqKwO2F5kckZY0OYnQmN8GlCRUqMNDTTfXLCdJkZTahipKATLmBIGMVMCSU5veJ5mcMvjGj+T0bkmOwOBgtG7r8T78QP0jB98E58RV7KUuFkqcwyqgjNZSncXBZClhKqiTaKiwlRrFBMM2EcmHJMRJkzxROSsoTnAK8f1g/iejBYEDFTRsxUlpqKVJMiown7U/fcrW4JEwYHf37B1IywjE/4KGMkXB6gvQJ7LBVhNJlWmMANEpKk1FAypZrMmCEjRrjQTBnXg5IJv2CCjDnL0h7hhqRsTHEDjCS//PyvQX8w+OXnf5P70HrMrwBBFvIHsM+uRd1kirh4gKC/mTJBuEiyMoW9VDRnhim7lSMm2JgbTS5oVjJYSUEtvVQ76ZscKEZTohNZMLvin0quLKYcWfmW7wQhX5Fv/dCJFIZyAVt5/PIIMS1FNiMXXCMuERBA9ln3nAfFlJ/ZiYGO8B8H5MyzC7Y5eyeiXmToREcHb6Nj91P0vhddxZNSGxlzYdjEcmJsZgWDdiwfsTRlwGa0KMIm2LXCFQx6HQmas+ggqjk26kUcmLKgZtri1NMpIz/+ePQMyBUpyXaLepHHXHRgVMl6kU6mLKfRwXVk4Yos3Uc3N71q0oZIWH9S123LSf8e/xVRd3h8FP+NKQ1zuNmnjKZMRYvH6UVMlDkgeW+w9ygefB3vPgKcOrqODsLvN/PreAZYz7lgGpeRUsPiEdUsJYfHR+TCwkKo1jLhKOuQhmYgV6BBQp1gFFJYolbygqdA1tiGFkXGE9zoe5q8zblAaRaM/f7+1JhCH+zspDLRfSShfiLzHU8yXkjj7zu04LHrycXkD27AOPj8AMAoNUv7UYBhx5Ueqz+VTAGFsKsikymLDsY00yzcPPehhXWqFIWe3LBcL9sNz1lIOmmZWGIH1rli8H9PaNpQU+phzgyFX1ErABlxfT4cZTI5B64AyGB99jff1Q71/qa1q0dOBsGWwpKYhq2jxig+Kg2IRPeTLqTQrIeiMS8zw4uM1e1AouQ5JZoBgxo7Hsov3SO8z/rk7C8OsX/2y+3Vi+0hfGdRg7smrT1o4bzNaaj9zJQaLw9xQX0rcEuhC5bwMa+UbyZpSmiWETn6wBKjSSkypjVhIi0kFwaWmzDt1S2Xot/FYCilmGqKB+TFTeD/ocxHTIGc8NAUTOGK+uQFoJ1+kIqbGbTwAGq7DsfCIPj3Hq0LoZbKDEezlVCulidjrrQZ4rC9KKP+3+9b5PYClClACXNX+ow0bZ7RLLp534s0S0pYLgr6p1ZUHyZgOx2WZhodvH1/E+gSpS/pxEtST67IdnuDAfyvCYgucaRxmVk5dUm5GY6lGlruYcNLrhhJFEu5IY65ol4EepMJA+MFAmvng4ZBr9uYshsZAZjsiuZFZkFyszuOhi9lycEWHe3v79KHg1G8R9NRvP/NExaPHo8ex0/SwZP9we4ufTj+BvDeadIBSnqRLkc51yDfaqGAP9jFzH30AmKz+b2+db2eUPrk4aOHg3j/Yfoo3v9mn8WjrwffxA8f7u3u7w6e7O8NQEfK8XiYzJKsFqK0NHJY8Eya6lNlHvu9rD4MQeWESuprgKSyrYe0ocG+Pt39+uDRNweDh/+wcnBYMMVliug3VJnmcI9i5BsmWtMMnrj+sLlpmTG/6v3BePzoyZNBPNh9shvvP37ydfzk8e7j+OHe+HGaPmRP9lNUo8mUJect4B+iTjFMCZrVi3e7kTKaZlw0Ojw+3Xt4MBgcDAb/qKX/wXVNCyMpSiT5COzOOSpxJNH5K9XToeFF128FnVnwm7/TNOVAcjQbMqpAvwY/ykvBlB6mil7WHysdV32x41qLOfzKs3Soy6IA4ZSyEQ9/dGQ39zllY6YUS4dNbddejQdiGKjZdqvu3mr++0RJrWHK+hPPi9JYOOqPgpnOD/OrkGbKVCdkivF8VCrNciZaOGn8GHQy9KrZ9KZiJS4mQ6caHTegELKSwwydcIKlKyWtoLhB8bEGmykjmBoCCaTDlOsKsuhAlFl204tA2g7dTCBjh02x9KvJwuvI/TF0ohs0AmAKlAICysHS9o2cCn1jG6FV9AY0xhE0KgU2G8rCw3JdffMqtMZAtExEgLEHbirgxUFR88zuo8HAbbf/rUty7J3uflNLDt/SUYCXZsnu3sP9R18/jr95QkdxkrJxPNjdexjDN/gEX6Ibq5czlgAlSKdMYWd7NRmVQjEtswuWohq/0zB3GuZOw9xpmF9Fw4yoOB/qRDEm9FSa34SymYN5udL5lopz8jpsvL7yaU+0nh7iYixVjkuf1yLp3p0WudMid1rkTov8R2gRe46UDo0cTvlkOsSj1rGiZTpUY/6b0CYdcC/XKC/5ZEpOuD4nL6ADOXlxtJ5WWY6s29Au7OFtaZeCidSS1wVnl3ca5k7D3GmYOw3zK2iYzrjDb0KxhAAv1ygntiUekK2nSjqxsrYGaaAyZYZyDNIf4AlXL0K3hyYJsNsQg1VjWaphyieWK6HZelrkzkO50x93+uNOf/wa+sMCUTBluI0ptym+Ha+3ljWc00D2juEYr28Gxg8JfNaG5kWVR4H5Pm5YlOhBHhME80eMqBLy2YhUKVM24c4RgXYNCspTIgWO3idhhiQk4AkJCXhM4DijWWPGHmRWKkgsqVJUbNJDWcAyyEi6XDXkA0xMspmMHmLMhhuDKMdmWkoBY9QQJlRUIGLCZbje0YxcTnkybSw6L7XpXLaGMQJA7OJzZvpIYTR9JbKZF8iGGxDhPjcufubmjE9h3+YEXns329kvOKUUDuB6gYguv8K5DVwHsKcAR/wMiMaDFmiXCrKRlBmjogXamykDloSsSNjoEJGw+bjxdUJGNqtzZPsEUlQtIVYffWfcOEs5jhbSPjmsBGo269U5uUDG0HRSUkWFYTZJElBSjfrB7mlCS80aMFakAMDaXMw++Q5QXQECtAnDlwI0hBR98lQKtEIAilIzpUlOZySZSqktRZaimmDExlJ1z7nO7hz7JbQ3Z4523tbEA0LEJv91EhE1HVR/SXVja0rAayOrkXAt7oVbNVuP8uslNIhsziZZsowNJZvLxQTrD9LUeEVTVbI2pHqFK1TMrY26DmHDdVioWkp8aKoFWgNoHdbuSCFdC7Hu/z+WPCCPhqn6uWdvmrybzu56byXFbNcmNIEpvVKOHYkUMr5AoDqJ1iR9QgWR43GM4zUSfZcD9mo8jp9CnzZUQ8WoSy6jYvZqjN7SojS8w3Qqk6gXuTRv4jNB4ROYtFEveiqVYmgWRb3oGddgzbK0UhVRL3qJGeTBhzeQUpmE/U7pFVEskSLhGafu40k92TOu6YhnkKrIhS4VFQkjKdc2WdSNoajQKKnJWMmcyAx5kHjfAJIHq5Uil990Sqsa3xZTfQKY9rn1Vtu19kQvI5d6N05wxGpTQh/rVmgFBiQ44BrEclgaGR9D4wqg2uu5FXD8cBtQ7nPXpQJpzMGVsZni9gzXD3YLMMKfOEH10V7U8NMFdPvxZOCX+ILj+uoVVVLNrxkOcqYywwPlpnu8WrQVdAZGfUX2xABv+QzqYO021f5j6BuYiI6CMwMvNuw9mkvGzqOe+wNdKP/p9JInDHORcynwhsP38P8MkoX/r6TKMIX/fs1yToUowfSKetGh/+f7NlLf1CgDdMbHiLIKo/qcF0PFJmVGm45cbQHURNRtyXwL50nEjUHqMdDAhzReL4u0UyV4z8bd37o14nl9zov4xAIRP6uACNjliqXDkIDUnMG2ap3PBewpQZfambQ4HORZU2trH528vhdcDkLqkmOyt/ffuLIxS5miGSxX5m6kPnltKKb/198qLwL+qgYHn5fd0wQOGjJ0UGlWEXGfvAJCuuRwc+CS3csyossc+zFhuGI2mR3/dox7T5NLOmF2nzxiHABSBF3dZSsPB64KluO3HEe5TTFwxdIG3Z403KEuvq+yv+cHb3ru4SHaOjID26OZ3rMr0/yC9QLzjFhI2su6Cc/lPvlUHUd9Gzkic0ZnLSNX2n5wOtJhi86Lma6LNR27N6+lqvgkoSNZNvxZYAQcDMmXXRV4fowIxOs4jX1PwC7yMnmldoR1zXtb4FKOGHEDsQU77qAYbnWaQOurqc1jhJbjR+ypF6xXyMtOULjghtNsY0gEYDwLz1U8CQT3zVYRvkcDnuUN0UVca3JoGYoodU8TFz6oMIJjsu2Q4qkwa6JjER10bCf5H9LG7NINsDhISgOOxnqoOJ47+qoXRg2c7FSHGGCoIcokoReSpyQLjkrW5lWrPpGX4u+ZoRXT1uf1y/kUxVc5ss27RMYcMzZPxNciDBi6ckix4xqiqXVs3Z4q5+I7JiZwyWl39cSCofvQnvqmcXa9/opAe6+/ms4z9fUna3TfYNrO8MYGuwbdieu+7Wo7b3WutdBOglxEKGvKSEcGzixaZ/wg8LLODNh80znaQbX1UVYpHtd3q3kbIbst5g76bzd/HRTcZnaqpwR6bzX3XNBxi/n9CBvD0BnYXB+Aujvx3TeZvRE5XX9W7HZPE+i3phQKQ6+biB/A6eZbWsVON8CknQTuDLsxrP1mXaqNyOnj52abzl1Hu7eZ1avIyt9naV1eYzPp1RXw/ihE2IE2BagRGN9mfjdAt8XQMeGilIBt5q5Cxrj9fuR5MHoQC5xCsRmaZfISMGQDwk8PT56/JjTpiCjddEX9twExOChq21M3q48JTtHcbMU65pHma0OUgv9UsiNbIaKzKMChINgYHWHEm7t4jqc+snFwBaFoLzjxN2xfHX5wEZRzaWSGnXWdk9RBPKnCGkZV0PMSaiqc2dINtqIHVurxNSPO3GhndYGbfkc5jMp8b9rjNo9srS2kVwRbB2Jyg6C0dVjolT8E90IyyGGAnzEAsIGcr0mqmmCOoKKbLtfHB6lOAa2tk4pboyNXVGoJMX0ESTSg/Z2ShsBiHiu8rLUookUJ6GjpguEZABUT1nnm2JwX9zLYbNyoRnZELi9sUgRkQ5KUVlkYkMbJhTZQakqOyRhi5jSZtl1oqfgEwz+bHO+8cp3Cwx0Ezs9joWYdh7QgX0ulABubzPjU9gkm7NYnfjX2rGTD1ViPcsvVbDKjX0094QK/1YeRV3ONbUsup7P5w6wWjax9nAM0G78Gmo2fWpqtdWSQDrdVyhqkjOCJE7ATYtuVLJKlShhmrbg5lh30P7VNwuyMzlTpluztYLSNhOa8+LZgLZSF80ktDjKfI8Uu8HihiitWS2jzazO5ey15OiswdBTOeU/bP0FMmDCi2Zi5bdg38sXXOuCgOfPhgHpwD0vnJK1U8+WKcwXmm9hrpqxvgj3Xk1ioKiWw5po2PTv3+xFmR84VaYPZm0B1zhzm2M/jpvbXjwMsWYTOUWzt2WP9xa2AaRcyQ5vrgnIMp7iOGBD1Y9F1EdzK+t8oaDW3uZ5DMMXRDWwTUvHqwFobj/bcTX3vYM3AHUShlrKLj/8HV6179Z2G9+tI9tfVwPG3duD6nH5lUx2qgObVk48Qsp9FrFqAuZh8bqmKuVIjBp8tDAuCfh8nXpt1zz6BaJWCNXPZFuzDj3PcVDMOnQMSDglcSAqQQwkWcDOQZTZGO7wua/e2KbsbIjWQcu83lfien8LaPp0yYoUiaFWd+3V0wKYqIETwXKmijvpECwoRtZA+X/RoA9/bZ8Moe/Zx31UmdjWMH3Str11GaTuLdP6yRIMY/ZUJljDuhe4COJoXoFetPUyYwBm58DcmOu301fL9KZJiJdsdO8avcEYr0k2M9/qCbM3b52W4skcalUo+OzfPF0v5nTL2wtv5Lfwuvse/CRkHoywm5ZV3Ote24L4DN32f2H4eBqQ+n/Fhz3WqLZ2jTFct4ZOxGpT7iYNyP7fNda6GA1odkkAZBwJlHMg4KAXx+VhvRUWJOxb8cljwFkj8xO52fCpjqEESQw2SGGuQxCdjfuukfhncUHc3xom7Zv75KLz7ovvviLCbaFt0c7+W376O9SIBXpNtuKfEjvVFaY4Wzd02P0EJhviFVLGrv+DsNICcA+R4n0FiPMTtwuwHW7xhjuZzWhSwdCxcXbs2K53oO+ftt8OHd87b79t5W+TmfEomv/PqvhSO/yJNyt+zV7fK9blltrxz++549It1+xY4SbfMAnfu4JdA8Hfu4Od2B7cLpa8RIPzsYfRlMH18CL3FUJ3R87m6skE4vReNKc8grr7G1i2KoTeb6fl6P3PlyDy6K+7y6G5dP94SJz4zLEgUXKQpanxVdXNwiiofKiiWVjsJ1R/Br8FaK4zWBdbm3/l6jt9tFF8mmGCXkrTER0ypnomkYxFdSWLN0PbCLIJQVSBIw3M2w2UaNpFq1sZ+3WrlBrx2j9dhmq2rF4Xd7cp0n5zOCg4PLc5s6uo5mxGewnV57IX3Zf2LfTv1q6OK2YQ0974qDtm35Zcc1BuAZgLdZEciQDh+KP/so3aQT5QsC3u7B+oy2EJs8CYj+tklXNJL4H233LWfUgHOOWSk2ncjgwdC8XnJaiKuyZnA1/+GljjOegic3St7c9c9g0oosS3JmWtK/ImYVWyAQjOzIGhETc60hhcKV1+b9eu1OkcHd8btimIyYQIKMPhdc0N7ZOhSjWliEQJJyCLFemIOisWqdC5N1K4UykBk7IIKY5OvjPQEMmsmTXJBkJE5JoJCrnCVO2wfI3TP2fUaQyB8iKoz+3+0eM5wb/0XsETP6qvk7hVQENfrJoVUz0/iiJzpecbzn9vM5n9pZ6usmRgE8sHPPFuR99Yx92zNtKAfgmQch1EUYTXZYEEmtJxBNSM1BAhew9TH7JxaPNSWiB0GR8RKZ0PIOVqivqt2ZTE0cnnDhpzraoDlRJY1CbTi9476sSpH/Eqw+LndlpvFrb53tGObwtasjivd7flvYc+bVsDS9ME3IHzwvWt2xbWBqg1L1EafHGEV1EJq+zg2HJHQC1Y/g5uxC5bZR9CtGvGKohIrUcIV2DnqvgU3RrskfoUE9yAKV9jRoPteyHFlsMQnzuq6WV44tsbwqqpCiKFcCjbDnH+bejhX+HWENaHgkKC+oudmh2o89gINxXKu+Gb1X6KumwHYPn4F0MbPAmjrImcLapmvdQdqoVSnWeZ0Tf2v5c5oBcd2dQurwmTdtUlsKusad5NOwURoVWTxA5D7UDqrYOkDmynaUdXSFVbKMld0t7soLHlqa8rYk/qqAKgssxSMBGbw1eSqwuy9GoIRhdvikuAOdK42eC14M6cQOzYSVetybyfWAND1FUf3Cr19pb678oryl1u3Bqka4taBq59R3gwirGl6e2B01Ih4W19uWwxGUM+rqhvRI+ynkmbWcQ+qdJE/BnUO/lhfE7Z/wgVuW4+uoyhAzxEeugTuarMtWgZ+B9f2EXIQ3yjv62ON7qTx9cpwbIoAV5ojWH6FVRI3rhIyHX4ILiODqwRL1lNbPiSuMXZ7C+2uZrDpasPaBsGSHRbJH+cqodwe+P5qZM7MVG5abCxcQKBoqmNPO2ifHGnyFYD4FTl7ybWRChzuM+sjKWYUZxdAi/O1NLWv0JTNsPSzLI3mKfIoKkf0TQUpSrgja6T9GF7SeMah/ip5xgqpOWgnrMmN9Vo9FGhM5SxfZo+1rw+ic23YlbHWZu2YgWed4jV80PMa2U5Iw6pzAk+m0t0k1aYcLRD4UOVwG/29+A4zjjn3cHxlzVYS70VHK3dvBHmn50vL9FAtSuHKfc2T6NG4edG+KltekWbPEm4XWHiEQB2FT/CaoTON4DkBYuvam1IJKKoNvjUVpBQtou+hyqWJ4Resc57GQJ/iOnXjikgwtWNhmmlJNFMXUKRAu2gA7GmP8DwvDfJzy/ngTYbrf8xF+yZYoVFTVYa76UUf5GhLI+6DHNURlgbQHTfUbnrRVJYqm90y5dtBV5L+y65mnvad+u0ReQGEkDNL/6ks8cjffcSpNqH+TtA+Bfl3TvSfQ/+I9zVhsmEkRxe+BGw1YlVexW5fyAa3w2Ru7WMOBWfb6puOTbuOc3AJ2p36+lcctIMXn3MAPdq10Z+PiW0BF99g6Bx+3igisaTQg8Na1a1yk6GYs6vyLGtsBHX9avODKcQBuZTqfMFdv3Gm6XCTKM6L714fkteNUE5g/hSK51TNEE8hLAtkHLiPWEJyKMfjjxZuwOO2RBRHXmtCB8TDMj7ho6oK7Bxdf2KuPz599VHMbkfYkMUtY/tKMsenr4ih50z4MFaHhrNV2As6k6UZlmDgpEMcZchFUS5/SaM9P9iqhtr0IAsL7lBZQGC2roveLQnqkiOIgbp5YMtbQlpYWnE7SlpQbzE8h1mTVDYRlKnMwK1tystmjcsFVkljrI32J/jSOaN7xwTlqgBqTuft2/ZTJBsXaN5wxuVaw3Zc0+1TDMK6LkF9xenZm+BhgeaucAiNuYFuD7qbZmSqyqgOoXrfebr73NEpFoSqVF/8LdVV0fFVdAtpHg1qWka4rvYMcZ38ttqh++Q1s/Hmt+53kAWTkqfs/f2pMYU+2NlJZaL7E/RbE5nvsHzE0pSlsUMP/r7DU5YX0jCRzB4gIsM0MynIVF5ipol2lYRxD/qNA/K/WQiwbPZGSFhz0eH56gaWjj2owGfKApL41REHe91REm87mdpRHa92OJrYqaozjKA08piWmWmU5w/ORSr0n11Ur+E9skFjMIs+TWmwUKtXy+q2i1dbePPjLJLxtvkGpSH8ZQiXULFyEluzzVdbGzcLDi08SfNnTHiogFlMKoGA0futX6iqMboNRDf4X8ezIQuE4kJ5uH6k9nYK61UV4rD6f/Ncd+Fu/QaKLoYFyZeX0lvKP41h5lQjTh0MXY3TrkOzXpnYj9pB1lmVtdq3b/2PcOQgVxejqauS+QOYOvuq3sNb2KjFBWwrjuzamE63F+qWhg/lrNXRxWC6KKNr3zrKzd6asuoKo6xmQstfdZdfs3zlnY76cnVU12HI+mb8kSM3SFvprKs1lZfOLd4f7LeN1x+kIS9kKVJ8y1kYl97hvG1otPPB1XuEV3NyumQI8k4Q8k7Yyo+YR4LumksETCWzL6diqkyffE/PMSfRPVDm0vfI0bMdxK2N5HE8iVmZHNuVobcog+cu5faLTLn9UnJhLa9cxS4t1Qpaibc3RBoS1tvG/kd1vnqN+aBjsLhoAYNcuuersUMfGbrm5x8k3LkoRdrK57Lg6oLRc0b1LAZZH0PgRfEUek6Yce/aC/d2xdtrm0oXXcXoLMbBPsTuPhIGWZATnBMJdlRRhE21fVmzOZTSl3RS97fKuG60CMyqA4ILFruPvTv4CwrGXrRzsbtjTQrO9M61ty54erPjJerOta8azdMbyPuHo1W3YaXKooPIu8u04NZbjlOWo8vccYU7l1ETv3a8GBRFBP3QX1gwcOeYx0qmS8Ys4GfAgIZTJG5mr0HuWkJ0Nb0P8QrDYQkoqVgFJoflYmswlxhVHYrclwXHVEN4OHQKMsaKeuDB1zNtWP4xM9gRFkyAT0eNbWKBI23MUCCHx3A3tDpkqZ+zfwQKgKlcvxq/ZuqCJyzAdH3YgRJgBxvupDA1COoY/47lGDEMXVvneCyzDxO6TIl7mjx3FE/8Q1WHx0cklUmJbxJCv/9yypImprbDomd+VnLCMschYDfDBTEgFffr/9aUgVEPqU1ORTDOXyEnjrhc4foF1blj3UpZRycYqdR1dh3GWbujZKEN0rMpGjbQSbqzI+0r9ljhHbK+dJk5X6WgE/tQas+HZXN6xfMSMgUnjGj+T9Qiu4PBgpH778Q7AW+y64N34isMMrvIcXDu3QzFQnjEKgSimDOyHJiQMVvmTPGEuPoOMIEd1g/ietTK0kxlqSnkQBcZTdifuududQNrEQe3L5xWYaRGuA1PgR3YYAcyKNldH3EdjYmQ9uYExMBnDKOWXGimfKSVkgm/gILfcBDWI1CT255+YWj2l5//BUHvX37+N7mPb29iGoeD/AHss2tRN7ERlwcI+htwTtouJG5l5bBWmVT2qfpevZO+CSb92Zw/u2L3Mijm5SFZ+ZZgGn5Vu7vuvgxs5fHLo9r7veA2M7q6BXrWPedBMeUu2RDoCP9xUL0X4JIR34nadoS8pJ0ioxyFHIrra6dU3kYXu5H3VO0lkINasUTVmwn4Q61bwBycSrgg9za6voZA7I8qu7mBzz+VDNT/22sokANnumm3lxly8ZFPJmoYB5XJ5z1Gm7YPr6DCllaJ41U7zAHIKdFwfuxf/8WN1D3C+6xPzv7i9v3PHqO92knt2fOgRXizatz1D5Q26sD112pvAU+YTRRzhIML7lvKLIV2RqmXUpmkKcZ0rbmuSSkypjVYboXk1tlKmPZyyUXhlywC5t9+BT9UyRIengKfQ5q4S005/SBBd6Ml7UB07976M2wjyd6jFTCidt0SxBd4gG4k0fAwXWcgQpPRbDkE0HeIjWoo3sMfitvXRjei8fsubzh9QOZ9aMdwi6DxPpxogOKhDLh1MxwtAahWvFsAFEgJvE4yZTSFU86NsPWM2SC3c8ywzpB9vBsMEh/qmL86j44VNABf0ikaYaW4c7F7tk3g4t/T5G3OBarvYOwNA0u04HEdm/qDGzAOPj8AMMBBXMGbf4/RFosPj49iF6Sb5wPbEMzUwgS/tc4tGq7EX5+fghvTtGorK9b9I7jA0dzd62vb4lSeM3FzU222gb/t+cv/A0uZha0=
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Returns a payroll. If payroll is calculated or processed, will return employee_compensations and totals. Results are paginated, with a maximum page size of 100 employee_compensations.
+
+Notes:
+* Hour and dollar amounts are returned as string representations of numeric decimals.
+* Hours are represented to the thousands place; dollar amounts are represented to the cent.
+* 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 ).
+* When include parameter with benefits value is passed, employee_benefits:read scope is required to return benefits
+ * Benefits containing PHI are only visible with the `employee_benefits:read:phi` scope
+
+scope: `payrolls:read`
+
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-id-payrolls.ParamsDetails.json b/docs/api/get-v-1-companies-company-id-payrolls.ParamsDetails.json
new file mode 100644
index 000000000..0441c80dc
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-id-payrolls.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"company_id","in":"path","description":"The UUID of the company","required":true,"schema":{"type":"string"}},{"name":"X-Gusto-API-Version","in":"header","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"},"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."},{"name":"processing_statuses","in":"query","required":false,"explode":false,"description":"Whether to include processed and/or unprocessed payrolls in the response, defaults to processed, for multiple attributes comma separate the values, i.e. `?processing_statuses=processed,unprocessed`","schema":{"type":"array","items":{"type":"string","enum":["processed","unprocessed"]}}},{"name":"payroll_types","in":"query","required":false,"explode":false,"description":"Whether to include regular and/or off_cycle payrolls in the response, defaults to regular, for multiple attributes comma separate the values, i.e. `?payroll_types=regular,off_cycle`","schema":{"type":"array","items":{"type":"string","enum":["regular","off_cycle","external"]}}},{"name":"processed","in":"query","required":false,"description":"Whether to return processed or unprocessed payrolls","schema":{"type":"boolean"}},{"name":"include_off_cycle","in":"query","required":false,"description":"Whether to include off cycle payrolls in the response","schema":{"type":"boolean"}},{"name":"include","in":"query","explode":false,"required":false,"schema":{"type":"array","items":{"type":"string","enum":["taxes","payroll_status_meta","totals","risk_blockers","reversals"]}},"description":"Include the requested attribute in the response. The risk_blockers option will include submission_blockers and credit_blockers if applicable. The reversals option will include reversal payroll UUIDs if applicable. In v2023-04-01 totals are no longer included by default. For multiple attributes comma separate the values, i.e. `?include=totals,payroll_status_meta`."},{"name":"start_date","in":"query","required":false,"example":"2020-01-31","description":"Return payrolls whose pay period is after the start date","schema":{"type":"string"}},{"name":"end_date","in":"query","required":false,"example":"2020-01-31","description":"Return payrolls whose pay period is before the end date. If left empty, defaults to today's date.","schema":{"type":"string"}},{"name":"date_filter_by","in":"query","required":false,"description":"Specifies which date field to use when filtering payrolls with start_date and end_date. This field applies only to regular processed payrolls and defaults to pay period if not provided.","schema":{"type":"string","enum":["check_date"]},"example":"check_date"},{"name":"page","in":"query","required":false,"description":"The page that is requested. When unspecified, will load all objects unless endpoint forces pagination.","schema":{"type":"integer"}},{"name":"per","in":"query","required":false,"description":"Number of objects per page. For majority of endpoints will default to 25","schema":{"type":"integer"}},{"name":"sort_order","in":"query","required":false,"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.","schema":{"type":"string","enum":["asc","desc"]},"example":"asc"}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-id-payrolls.RequestSchema.json b/docs/api/get-v-1-companies-company-id-payrolls.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-id-payrolls.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-id-payrolls.StatusCodes.json b/docs/api/get-v-1-companies-company-id-payrolls.StatusCodes.json
new file mode 100644
index 000000000..b8c3dc79e
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-id-payrolls.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"description":"A list of payrolls for a company.","type":"array","x-examples":{"success_status":[{"uuid":"3601a7a2-0562-4e4c-9559-20886658daac","payroll_uuid":"3601a7a2-0562-4e4c-9559-20886658daac","company_uuid":"b43e6012-bf6c-4752-b67b-5c8000595e0e","payroll_status_meta":{"cancellable":false,"expected_check_date":"2025-06-08","initial_check_date":"2025-06-27","expected_debit_time":"2025-06-12T23:00:00Z","payroll_late":false,"initial_debit_cutoff_time":"2025-06-12T23:00:00Z"},"off_cycle":false,"auto_pilot":false,"processed":true,"processed_date":"2025-06-11","calculated_at":"2025-06-11T19:40:51Z","pay_period":{"start_date":"2025-05-20","end_date":"2025-06-04","pay_schedule_uuid":"ded21d08-02d6-41cb-b211-8d8ca02f1c6a"},"check_date":"2025-06-08","external":false,"payroll_deadline":"2025-06-12T23:00:00Z","company_taxes":[],"created_at":"2025-06-11T19:40:51Z","partner_owned_disbursement":null}]},"items":{"type":"object","x-examples":{"success_status":{"uuid":"b441a30b-2adb-489e-b7b7-9d094011a3f8","employee_compensations":[],"submission_blockers":[],"credit_blockers":[],"payroll_uuid":"b441a30b-2adb-489e-b7b7-9d094011a3f8","company_uuid":"9aa93530-43d5-484e-b608-33214109420d","off_cycle":false,"auto_pilot":false,"processed":true,"processed_date":"2025-06-16","calculated_at":"2025-06-16T16:58:03Z","pay_period":{"start_date":"2025-05-25","end_date":"2025-06-09","pay_schedule_uuid":"40ff5990-0191-4796-9717-32f7dd3e94d5"},"check_date":"2025-06-13","external":false,"payroll_deadline":"2025-06-17T23:00:00Z","totals":{"employee_bonuses":"0.00","employee_commissions":"0.00","employee_cash_tips":"0.00","employee_paycheck_tips":"0.00","additional_earnings":"0.00","owners_draw":"0.00","benefits":"0.00","check_amount":"0.00","child_support_debit":"0.00","company_debit":"0.00","deferred_payroll_taxes":"0.00","employee_benefits_deductions":"0.00","employee_taxes":"0.00","employer_taxes":"0.00","gross_pay":"0.00","imputed_pay":"0.00","net_pay":"0.00","net_pay_debit":"0.00","other_deductions":"0.00","reimbursement_debit":"0.00","reimbursements":"0.00","tax_debit":"0.00"},"payroll_status_meta":{"cancellable":false,"expected_check_date":"2025-06-13","initial_check_date":"2025-06-13","expected_debit_time":"2025-06-17T23:00:00Z","payroll_late":false,"initial_debit_cutoff_time":"2025-06-17T23:00:00Z"},"processing_request":{"status":"submit_success","errors":[]},"created_at":"2025-06-16T16:58:03Z","partner_owned_disbursement":null}},"properties":{"payroll_deadline":{"type":"string","format":"date-time","description":"A timestamp that is the deadline for the payroll to be run in order for employees to be paid on time. If payroll has not been run by the deadline, a prepare request will update both the check date and deadline to reflect the soonest employees can be paid and the deadline by which the payroll must be run in order for said check date to be met.","readOnly":true,"title":"Payroll-Deadline-Type"},"check_date":{"type":"string","description":"The date on which employees will be paid for the payroll.","readOnly":true,"title":"Payroll-Check-Date-Type"},"processed":{"type":"boolean","description":"Whether or not the payroll has been successfully processed. Note that processed payrolls cannot be updated. Additionally, a payroll is not guaranteed to be processed just because the payroll deadline has passed. Late payrolls are not uncommon. Conversely, users may choose to run payroll before the payroll deadline.","readOnly":true,"title":"Payroll-Processed-Type"},"processed_date":{"type":["string","null"],"description":"The date at which the payroll was processed. Null if the payroll isn't processed yet.","readOnly":true,"title":"Payroll-Processed-Date-Type"},"calculated_at":{"type":["string","null"],"format":"date-time","description":"A timestamp of the last valid payroll calculation. Null if there isn't a valid calculation.","readOnly":true,"title":"Payroll-Calculated-At-Type"},"uuid":{"type":"string","description":"The UUID of the payroll.","readOnly":true,"title":"Payroll-Payroll-Uuid-Type"},"payroll_uuid":{"type":"string","description":"The UUID of the payroll.","readOnly":true,"title":"Payroll-Payroll-Uuid-Type"},"company_uuid":{"type":"string","description":"The UUID of the company for the payroll.","readOnly":true,"title":"Payroll-Company-Uuid-Type"},"off_cycle":{"type":"boolean","description":"Indicates whether the payroll is an off-cycle payroll","readOnly":true,"title":"Payroll-Off-Cycle-Type"},"off_cycle_reason":{"anyOf":[{"type":"string","enum":["Adhoc","Benefit reversal","Bonus","Correction","Dismissed employee","Hired employee","Wage correction","Tax reconciliation","Reversal","Disability insurance distribution","Transition from old pay schedule"]},{"type":"null"}],"description":"The off-cycle reason. Only included for off-cycle payrolls.","readOnly":true,"title":"Off-Cycle-Reason-Type"},"auto_pilot":{"type":"boolean","description":"Indicates whether the payroll is an auto pilot payroll","readOnly":true,"title":"Auto-Pilot-Type"},"external":{"type":"boolean","description":"Indicates whether the payroll is an external payroll","readOnly":true,"title":"Payroll-External-Type"},"final_termination_payroll":{"type":"boolean","description":"Indicates whether the payroll is the final payroll for a terminated employee. Only included for off-cycle payrolls.","readOnly":true,"title":"Payroll-Final-Termination-Payroll-Type"},"withholding_pay_period":{"type":"string","description":"The payment schedule tax rate the payroll is based on. Only included for off-cycle payrolls.","readOnly":true,"nullable":false,"enum":["Every week","Every other week","Twice per month","Monthly","Quarterly","Semiannually","Annually"],"title":"Payroll-Withholding-Pay-Period-Type"},"skip_regular_deductions":{"type":["boolean","null"],"description":"Block regular deductions and contributions for this payroll. Only included for off-cycle payrolls.","readOnly":true,"title":"Payroll-Skip-Regular-Deductions-Type"},"fixed_withholding_rate":{"type":["boolean","null"],"description":"Enable taxes to be withheld at the IRS's required rate of 22% for federal income taxes. State income taxes will be taxed at the state's supplemental tax rate. Otherwise, we'll sum the entirety of the employee's wages and withhold taxes on the entire amount at the rate for regular wages. Only included for off-cycle payrolls.","readOnly":true,"title":"Payroll-Fixed-Withholding-Rate-Type"},"pay_period":{"type":"object","readOnly":true,"properties":{"start_date":{"type":"string","description":"The start date, inclusive, of the pay period.","readOnly":true},"end_date":{"type":"string","description":"The start date, inclusive, of the pay period.","readOnly":true},"pay_schedule_uuid":{"type":["string","null"],"description":"The UUID of the pay schedule for the payroll.","readOnly":true}},"title":"Payroll-Pay-Period-Type"},"payroll_status_meta":{"type":"object","description":"Information about the payroll's status and expected dates","properties":{"cancellable":{"type":"boolean","description":"true if the payroll may be cancelled.","readOnly":true},"expected_check_date":{"type":"string","description":"The date an employee will be paid if the payroll is submitted now.","readOnly":true},"initial_check_date":{"type":"string","description":"The normal check date for the associated pay period.","readOnly":true},"expected_debit_time":{"type":"string","description":"The time the employer's account will be debited if the payroll is submitted now.","readOnly":true},"payroll_late":{"type":"boolean","description":"expected_check_date > initial_check_date.","readOnly":true},"initial_debit_cutoff_time":{"type":"string","description":"Payroll must be submitted at or before this time to avoid late payroll.","readOnly":true}},"title":"Payroll-Payroll-Status-Meta-Type"},"totals":{"type":"object","description":"The subtotals for the payroll.","properties":{"company_debit":{"type":"string","description":"The total company debit for the payroll.","readOnly":true},"net_pay_debit":{"type":"string","minLength":1,"description":"The total company net pay for the payroll."},"tax_debit":{"type":"string","description":"The total tax debit for the payroll.","readOnly":true},"reimbursement_debit":{"type":"string","description":"The total reimbursement debit for the payroll.","readOnly":true},"child_support_debit":{"type":"string","description":"The total child support debit for the payroll.","readOnly":true},"reimbursements":{"type":"string","description":"The total reimbursements for the payroll.","readOnly":true},"net_pay":{"type":"string","description":"The net pay amount for the payroll.","readOnly":true},"gross_pay":{"type":"string","description":"The gross pay amount for the payroll.","readOnly":true},"employee_bonuses":{"type":"string","description":"The total employee bonuses amount for the payroll.","readOnly":true},"employee_commissions":{"type":"string","description":"The total employee commissions amount for the payroll.","readOnly":true},"employee_cash_tips":{"type":"string","description":"The total employee cash tips amount for the payroll.","readOnly":true},"employee_paycheck_tips":{"type":"string","description":"The total employee paycheck tips amount for the payroll.","readOnly":true},"additional_earnings":{"type":"string","description":"The total additional earnings amount for the payroll.","readOnly":true},"owners_draw":{"type":"string","description":"The total owner's draw for the payroll.","readOnly":true},"check_amount":{"type":"string","description":"The total check amount for the payroll.","readOnly":true},"employer_taxes":{"type":"string","description":"The total amount of employer paid taxes for the payroll.","readOnly":true},"employee_taxes":{"type":"string","description":"The total amount of employee paid taxes for the payroll.","readOnly":true},"benefits":{"type":"string","description":"The total amount of company contributed benefits for the payroll.","readOnly":true},"employee_benefits_deductions":{"type":"string","description":"The total amount of employee deducted benefits for the payroll.","readOnly":true},"imputed_pay":{"type":"string","description":"The total amount of imputed pay for the payroll.","readOnly":true},"deferred_payroll_taxes":{"type":"string","description":"The total amount of payroll taxes deferred for the payroll, such as allowed by the CARES act.","readOnly":true},"other_deductions":{"type":"string","description":"The total amount of deductions for the payroll."}},"readOnly":true,"title":"Payroll-Totals-Type"},"company_taxes":{"type":"array","uniqueItems":false,"description":"An array of taxes applicable to this payroll in addition to taxes included in `employee_compensations`. Only included for processed or calculated payrolls when `taxes` is present in the `include` parameter.","items":{"type":"object","properties":{"name":{"type":"string","description":"The tax name"},"employer":{"type":"boolean","description":"Whether this tax is an employer or employee tax"},"amount":{"type":"string","description":"The amount of this tax for the payroll"}}},"title":"Payroll-Company-Taxes-Type"},"payroll_taxes":{"type":"array","uniqueItems":false,"description":"An array of tax totals applicable to this payroll. Only included for processed or calculated payrolls when `payroll_taxes` is present in the `include` parameter.","items":{"type":"object","properties":{"name":{"type":"string","description":"The tax name"},"employer":{"type":"boolean","description":"Whether this tax is an employer or employee tax"},"amount":{"type":"number","description":"The total tax for the payroll"}}},"title":"Payroll-Taxes-Type"},"payment_speed_changed":{"type":"object","description":"Only applicable when a payroll is moved to four day processing instead of fast ach.","properties":{"original_check_date":{"type":"string","description":"Original check date when fast ach applies.","readOnly":true},"current_check_date":{"type":"string","description":"Current check date.","readOnly":true},"original_debit_date":{"type":"string","description":"Original debit date when fast ach applies.","readOnly":true},"current_debit_date":{"type":"string","description":"Current debit date.","readOnly":true},"reason":{"type":"string","description":"The reason why the payroll is moved to four day.","readOnly":true}},"title":"Payroll-Payment-Speed-Changed-Type"},"created_at":{"type":"string","format":"date-time","description":"Datetime for when the resource was created.","readOnly":true,"title":"Created-At-Type"},"submission_blockers":{"type":"array","description":"Only included for processed or calculated payrolls","uniqueItems":true,"items":{"type":"object","description":"A blocker that prevents payment submission.","properties":{"blocker_type":{"type":"string","description":"The type of blocker that's blocking the payment submission.","readOnly":true},"blocker_name":{"type":"string","description":"The name of the submission blocker.","readOnly":true},"unblock_options":{"type":"array","uniqueItems":true,"items":{"type":"object","properties":{"unblock_type":{"type":"string","description":"The type of unblock option for the submission blocker.","readOnly":true},"check_date":{"type":"string","description":"The payment check date associated with the unblock option.","readOnly":true},"metadata":{"type":"object","additionalProperties":true,"description":"Additional data associated with the unblock option.","readOnly":true}}},"description":"The available options to unblock a submission blocker.","readOnly":true},"selected_option":{"type":["string","null"],"description":"The unblock option that's been selected to resolve the submission blocker.","readOnly":false},"status":{"type":"string","description":"The status of the submission blocker.","enum":["unresolved","resolved"],"readOnly":true}},"title":"Payroll-Submission-Blocker-Type"},"title":"Payroll-Submission-Blockers-Type"},"credit_blockers":{"type":"array","description":"Only included for processed payrolls","uniqueItems":true,"items":{"type":"object","description":"A blocker that prevents payment crediting.","properties":{"blocker_type":{"type":"string","description":"The type of blocker that's blocking the payment from being credited.","readOnly":true},"blocker_name":{"type":"string","description":"The name of the credit blocker.","readOnly":true},"unblock_options":{"type":"array","uniqueItems":true,"items":{"oneOf":[{"type":"object","description":"Unblock option to resolve a credit blocker by submitting a wire transfer","required":["unblock_type","check_date","metadata"],"properties":{"unblock_type":{"type":"string","enum":["submit_wire"],"description":"The type of unblock option for the credit blocker","readOnly":true},"check_date":{"type":"string","description":"The payment check date associated with the unblock option","readOnly":true},"metadata":{"type":"object","required":["wire_in_amount","wire_in_deadline","wire_in_request_uuid"],"properties":{"wire_in_amount":{"type":"string","description":"The amount to be wired in (decimal string)","readOnly":true},"wire_in_deadline":{"type":"string","format":"date-time","description":"Deadline for the wire transfer to be received","readOnly":true},"wire_in_request_uuid":{"type":"string","description":"UUID of the wire in request","readOnly":true}},"readOnly":true}},"title":"Payroll-Credit-Blocker-Unblock-Option-Submit-Wire"},{"type":"object","description":"Unblock option to resolve a credit blocker by submitting a bank screenshot","required":["unblock_type","check_date","metadata"],"properties":{"unblock_type":{"type":"string","enum":["submit_bank_screenshot"],"description":"The type of unblock option for the credit blocker","readOnly":true},"check_date":{"type":"string","description":"The payment check date associated with the unblock option","readOnly":true},"metadata":{"type":"object","required":["information_request_uuid"],"properties":{"information_request_uuid":{"type":"string","description":"UUID of the information request","readOnly":true},"bank_account_last_four_digits":{"type":["string","null"],"description":"Last 4 digits of the bank account number for the bank screenshot RFI","readOnly":true}},"readOnly":true}},"title":"Payroll-Credit-Blocker-Unblock-Option-Submit-Bank-Screenshot"},{"type":"object","description":"Unblock option to resolve a credit blocker by responding to high risk fraud RFI","required":["unblock_type","check_date","metadata"],"properties":{"unblock_type":{"type":"string","enum":["respond_to_high_risk_fraud_rfi"],"description":"The type of unblock option for the credit blocker","readOnly":true},"check_date":{"type":"string","description":"The payment check date associated with the unblock option","readOnly":true},"metadata":{"type":"object","required":["information_request_uuid"],"properties":{"information_request_uuid":{"type":"string","description":"UUID of the information request","readOnly":true}},"readOnly":true}},"title":"Payroll-Credit-Blocker-Unblock-Option-Respond-To-High-Risk-Fraud-Rfi"},{"type":"object","description":"Unblock option to resolve a credit blocker by waiting for reverse wire","required":["unblock_type","check_date","metadata"],"properties":{"unblock_type":{"type":"string","enum":["wait_for_reverse_wire"],"description":"The type of unblock option for the credit blocker","readOnly":true},"check_date":{"type":"string","description":"The payment check date associated with the unblock option","readOnly":true},"metadata":{"type":"object","properties":{"reverse_wire_detail_id":{"type":["integer","null"],"description":"ID of the reverse wire detail","readOnly":true},"bank_account_last_four_digits":{"type":["string","null"],"description":"Last 4 digits of the bank account number for the reverse wire","readOnly":true}},"readOnly":true}},"title":"Payroll-Credit-Blocker-Unblock-Option-Wait-For-Reverse-Wire"}],"discriminator":{"propertyName":"unblock_type","mapping":{"submit_wire":{"type":"object","description":"Unblock option to resolve a credit blocker by submitting a wire transfer","required":["unblock_type","check_date","metadata"],"properties":{"unblock_type":{"type":"string","enum":["submit_wire"],"description":"The type of unblock option for the credit blocker","readOnly":true},"check_date":{"type":"string","description":"The payment check date associated with the unblock option","readOnly":true},"metadata":{"type":"object","required":["wire_in_amount","wire_in_deadline","wire_in_request_uuid"],"properties":{"wire_in_amount":{"type":"string","description":"The amount to be wired in (decimal string)","readOnly":true},"wire_in_deadline":{"type":"string","format":"date-time","description":"Deadline for the wire transfer to be received","readOnly":true},"wire_in_request_uuid":{"type":"string","description":"UUID of the wire in request","readOnly":true}},"readOnly":true}},"title":"Payroll-Credit-Blocker-Unblock-Option-Submit-Wire"},"submit_bank_screenshot":{"type":"object","description":"Unblock option to resolve a credit blocker by submitting a bank screenshot","required":["unblock_type","check_date","metadata"],"properties":{"unblock_type":{"type":"string","enum":["submit_bank_screenshot"],"description":"The type of unblock option for the credit blocker","readOnly":true},"check_date":{"type":"string","description":"The payment check date associated with the unblock option","readOnly":true},"metadata":{"type":"object","required":["information_request_uuid"],"properties":{"information_request_uuid":{"type":"string","description":"UUID of the information request","readOnly":true},"bank_account_last_four_digits":{"type":["string","null"],"description":"Last 4 digits of the bank account number for the bank screenshot RFI","readOnly":true}},"readOnly":true}},"title":"Payroll-Credit-Blocker-Unblock-Option-Submit-Bank-Screenshot"},"respond_to_high_risk_fraud_rfi":{"type":"object","description":"Unblock option to resolve a credit blocker by responding to high risk fraud RFI","required":["unblock_type","check_date","metadata"],"properties":{"unblock_type":{"type":"string","enum":["respond_to_high_risk_fraud_rfi"],"description":"The type of unblock option for the credit blocker","readOnly":true},"check_date":{"type":"string","description":"The payment check date associated with the unblock option","readOnly":true},"metadata":{"type":"object","required":["information_request_uuid"],"properties":{"information_request_uuid":{"type":"string","description":"UUID of the information request","readOnly":true}},"readOnly":true}},"title":"Payroll-Credit-Blocker-Unblock-Option-Respond-To-High-Risk-Fraud-Rfi"},"wait_for_reverse_wire":{"type":"object","description":"Unblock option to resolve a credit blocker by waiting for reverse wire","required":["unblock_type","check_date","metadata"],"properties":{"unblock_type":{"type":"string","enum":["wait_for_reverse_wire"],"description":"The type of unblock option for the credit blocker","readOnly":true},"check_date":{"type":"string","description":"The payment check date associated with the unblock option","readOnly":true},"metadata":{"type":"object","properties":{"reverse_wire_detail_id":{"type":["integer","null"],"description":"ID of the reverse wire detail","readOnly":true},"bank_account_last_four_digits":{"type":["string","null"],"description":"Last 4 digits of the bank account number for the reverse wire","readOnly":true}},"readOnly":true}},"title":"Payroll-Credit-Blocker-Unblock-Option-Wait-For-Reverse-Wire"}}}},"description":"The available options to unblock a credit blocker.","readOnly":true},"selected_option":{"type":["string","null"],"description":"The unblock option that's been selected to resolve the credit blocker.","readOnly":false},"status":{"type":"string","description":"The status of the credit blocker","enum":["unresolved","pending_review","resolved","failed"]}},"title":"Payroll-Credit-Blocker-Type"},"title":"Payroll-Credit-Blockers-Type"},"processing_request":{"type":["object","null"],"properties":{"status":{"type":"string","description":"The status of the payroll processing request","readOnly":true,"enum":["calculating","calculate_success","submitting","submit_success","processing_failed"]},"errors":{"description":"Errors that occurred during async payroll processing","readOnly":true,"type":"array","items":{"type":"object","required":["error_key","category"],"properties":{"error_key":{"type":"string","description":"Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error."},"category":{"type":"string","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."},"message":{"type":"string","description":"Provides details about the error - generally this message can be surfaced to an end user."},"metadata":{"type":"object","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.","oneOf":[{"type":"object","description":"multiple entities","required":["entities"],"properties":{"entities":{"type":"array","items":{"type":"object","description":"single entity","additionalProperties":true,"properties":{"entity_type":{"type":"string","description":"Name of the entity that the error corresponds to."},"entity_uuid":{"type":"string","description":"Unique identifier for the entity."},"valid_from":{"type":["string","null"]},"valid_up_to":{"type":["string","null"]},"key":{"type":["string","null"]},"state":{"type":["string","null"]}},"title":"Metadata-With-One-Entity"}}},"title":"Metadata-With-Multiple-Entities"},{"type":"object","description":"single entity","additionalProperties":true,"properties":{"entity_type":{"type":"string","description":"Name of the entity that the error corresponds to."},"entity_uuid":{"type":"string","description":"Unique identifier for the entity."},"valid_from":{"type":["string","null"]},"valid_up_to":{"type":["string","null"]},"key":{"type":["string","null"]},"state":{"type":["string","null"]}},"title":"Metadata-With-One-Entity"}]},"errors":{"type":"array","description":"Will only exist if category is `nested_errors`. It is possible to have multiple levels of nested errors.","items":"circular(Entity-Error-Object)"}},"title":"Entity-Error-Object"}}},"title":"Payroll-Processing-Request"},"partner_owned_disbursement":{"type":["boolean","null"],"description":"Will money movement for the payroll be performed by the partner rather than by Gusto?","title":"Payroll-Partner-Owned-Disbursement-Type"}},"title":"Payroll"},"title":"Payroll-List"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided ID/UUID is valid.","type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["error_key","category"],"properties":{"error_key":{"type":"string","description":"Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error."},"category":{"type":"string","description":"Specifies the type of error. The category provides error groupings and can be used to build custom error handling in your integration."},"message":{"type":"string","description":"Provides details about the error - generally this message can be surfaced to an end user."}}}}},"x-examples":{"not_found":{"errors":[{"error_key":"request","category":"not_found","message":"The requested resource was not found."}]}},"title":"Not-Found-Error-Object"}}}}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-id-payrolls.api.mdx b/docs/api/get-v-1-companies-company-id-payrolls.api.mdx
new file mode 100644
index 000000000..c2dfedc57
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-id-payrolls.api.mdx
@@ -0,0 +1,77 @@
+---
+id: get-v-1-companies-company-id-payrolls
+title: "Get all payrolls for a company"
+description: "Returns a list of payrolls for a company. You can change the payrolls returned by updating the processing_status, payroll_types, start_date, & end_date params."
+sidebar_label: "Get all payrolls for a company"
+hide_title: true
+hide_table_of_contents: true
+api: eJztPf1z27aS/wqOb+7S3Iiy5K/Ennn3Lo3TPs+0Tc5xX95d6pEhEpJQkwALgHY0Hv/vN7sASJCiPu3m0mt+SkwBi93FYrFfAO4jWTBFDZfiPI1Ooykz8e0wTmReUMGZdv+bj3gaF3SuZJbpqBelTCeKF9AtOo0umCmV0ISSjGtD5IT4pmQiFaHEAemT/5YlSaggyYyKKSNmxuqmCqGwlIznpCxSariY2hZKJkxrLqYjbagpdc93Gpl5wXSPaEOVGaXUsB75N8JEiv8nBVU01/1fxC/i2zlJ2YSWmemRO55lbjQPm6U9oti0zKhq4m4x1IYck1wKM7PQfpKG6dNfxL+TM5lBH5rLUhhNqGI1HVQTbRRQoVihmGbCIKM1cEiUOVM8ISlLeE4z3XN9XUOWEiNx9IQJ04ehKrKAgWNGqCG51IYcOMwIF9hhUppSMUJFGvAF/wwhPDMAI5cKZoEKMiRzBoQUVBmkUSeyYKfk2rPjVDGaXke9yNCpjk4/Ru+8OFz1ok/xtNRGxlwYNrXiFMPcQDuWj1masjTqRbQowibYFSeJGaYA6H0kaM6i06gWu6gXcRCygprZguRdzhj5+efzM+AoMst2i3qRYr+VXLE0OjWqZL1IJzOW0+j0PrJ4RXZqooeHXjXoP+PvkYpX787jfzClYQw3+ozRlKloOZxexESZA737g/2jeHAcD4+APCd10Wn4/aFNxxkwIOeCaSQDJikeU81S8urdObm1uBCqtUw4BeG442ZG5rJU2CChWdYn5xMipGCEaxDrW56CVGMbWhQZT5DnzzT5mHPB8zIPYV99MzOm0Kd7e6lMdB9ns5/IfM/Pnl/9+PseLXjsenIx/YsDGAefnwMapWZpPwo4vLCUmfYc/q1kqjlxE5pp1ovYpyKTKav+bnLuw4yZGVOwWrhIsjJl9ZoGod+TipSi/lStbrdaFNOFFJr1vH7QACpQC6AF8jIzvMhgzRnFx6VhGkQtp0QzkF9jVdktzUpQR7zP+uT6bx3E/rUGHCB13SVXVCkK/OCG5XqVvFVgol4UAI2uHkLZbmjMp+e5V56O43IyGSXzJGMb8tt1fxS3QwL/6gFWiDyOxw5c1IsqgPDrJ8OUoFmb1cGErGbzUra2dyeyRIq7iBpLmTEqGprNTdMoxH5H1PyMy8mErJ7iLZFro9SWwQUUd59OQz/hIvAyY5fnKGeGwgYnDUXWKq5vRuNMJjewOwEGoNzgt6uHBRV+7vhiOfBbyTTo6UqE28zpE9i7GiMQibCsfeLZrMtxzjVo1Lod7OWJYik39Tc+8Vp+nHngHt1OwP5XP324jy7AORfkdn+wfxAPDuPBkFjWoKkiJMmkmDLlIaLh5hZ1n3y380J24P5qx+p1zNF1Y0+pjZwN1BrNi4zZzXgQD4bxwXCJNVtL9d1MahRyUjDFZQobG50YZo1DHJ240TcxMrwR9vmQHbOJNfMYWICIKxoLGZsYwvLCzJvK2MiUzp9p23BDqqDtaMIzw9RoPN9Su7wvWMInnAH6PJnhwGTCWYZGcKkZuZsxQSx4sKdrcsEMWmLlwiLg2sFBmWaaSJHNgw2HdBgGAKNhCwTMBAvLVNbVKubUyiaZseTGTvnVQzitwQ+NjXq6rXa+RCcF/SlqYMYr/dMnH4BzpdCOxalzfzJJU0KzjMjxrywxmpQiY1oD8wrJhYGNOGEawHKBhmMnsWjMM9UQhQLt5G3w/6nMxwyMhgqbgimkyOkR+qtU3MyhhUdQWzrcRME87R9tiqGWyoykSrdG9JV36LhI0Z4WUxBNvzUCXFDwoPbElLBbBnhyMNwTJlL49g3VyXPYzQGw/wb/f06SmZJCZnLKE5oRRK9P3lgYoHABulWyZsa4IteG50wbmhfXfXIWCCzVCUhqvbw3k1OqE6deWnIKPzxc9SLNkhKmAf2019bTepXA8nlVmll0+vHqIXAFlb6jU+99+V0Pd+X9wQD+aemAEiFNyizqRYkUhgkDrQLXZe9XDU3vA1ra07Mm/gCbe9NU+BQ7OhEzbZFwew3SWZYc4iIHx4MhfUH348HR8X58yA6T+OTo6CTeH7x8eXx89DKlNAkMiu16eWfX9RofHrDjwXA/Hk+Ok/jwxdF+PD5+MY6PkpeDweDo5IgN2BLj5fQ+SqhIWJbB9h2a8ywxLB0FKqd2SAcvcRlww2nW3WL/RRQASdmYmxFIX+jV7l/uH5wOBqeDwf8EyGUIyKHhx7AAktKAOboKzkNob3sotDRyVPBMmupTbXE7eas+tCkZwhaa0CwpAbN0RBue+fByeHJ6ODg9GjoaRlbxo2zUZobvcRTvD3ABLQwzOHT9QVTTMmN+blOW7g/Twct4sJ8ex4fDZByP94fD+GX6MqGD/ckwOaZA9vKJqpyOinjH6pTRNONixaR4ObPm7+nHq16UKLYBH5QRTI3knQCGcj0ulWY5LlBRZtkDqIu2zW01+doVVi2w8eHhkB4MxvE+Tcfx4csTFo9fjF/EJ+ng5HAwHNKDCVKfF5mcMzYCWpjQLo6EtHSYyhWRoa1sP7aW6objt5bqCaUnB0cHg/jwID2KD18esnh8PHgZHxzsDw+Hg5PD/UEaPb0QH68S4uPL4fHp0cvTwcGmQny0RIhPlgjx4WAyOTo5AZv0ZBgfvjg5jk9eDF/EB/uTF2l6wE4O06OlQjw82FaIXzSE2Hlnp/e1LIylwEjSaTToDwYtKXEi0fkr1bOR4UXXbwWdW/Sbv9M05SByNBsxqiD4FfwIC0TpUaroXf1xzASbcBM0s3BtyDj8yrN0pMuiAOsEVWTwoxO71ueUTZhSLB1VwQ+7sheo8UiMUpaWiVnCj+7eqv19qqTWMGT9iedFaSwe9UfBTOeHNhUS7KdOzBTjeaVs2t0aPwadDP3UbPrwhHslSu/KvdLJ98q98sUT7ZUvmntlEHB0HoBb86hqrX40I6eCAUulpFWHD8t2grYyWbMTWCQKpgy3+n5xXS8aoBOpchwVw95I46LhXRm7lZODgXIHNsjV2GCGkZDeUKUA8xttaWziRV27BgXlKZECofcJOMUewIxq9PXGjAmEY+3uasQeoaRQEMaowj3WI8HUFSNjaWY2JQFCQirvtMIYndBJxhJj4whSCoBRY+jSPIgi9GzQO547XzkkOi+16SRbA4wAEUt8zkwf1xFN34ps7rcdww2a/S6/E5+5MeNLmLeWWl+czUXXFIeE8BMiXBOI7PIUtiZwE8ReAx7xGQiNRy3YQxdCjstimlLhRIeMhMnHideVV5LN61hBn0AC0ApiRwAhocJKjpOFtE9eVdtGNkfJcQNxK2TTkioqDLNZv3GYwvjVzmlCIQwS4liJAiBbUIvXDzbt6SMZGKYzpBSwD0rRJ6+lgKgfAyxKDXHDnM5JMpMQNQKJLKtYUhg2ao+5yey88yQsTk5Ldj7WwgNKxGbNOoWImg6pv6O6MTUl8HXSaMI15Dtrps43k/yahIaQtSyvFWRsqdlcEjODfPMtzXglU8QPCXGYkELFHG3UdQgbbrKEKlLiV6Yi0Jp5myztMPe6xcr1//5c8kA8Ggb55x69adhvO7rrvZMWs12b2AQOw1o9dm5jURg9daGohugTKiBZEzeSNRsg9nYyiV9Dn0WsRopRF4uhYv52gpGSZXGlV+lMQpTjW2uDVokH+ASGe9SLXkulGBp/US864xpsdpZWW0XUi/4OUbnwwweIdyZhv0v6iSiWSJHwjFP38aIe7IxrOuYZxBG50KUC24+kXNvUhIOhqNCoqclEyZzIDNcg8R4QRMYqSnGVP3Rqq5rfllN9ApyuMyUTmyNtzoleJS71bFwgxGpSQk/ySWQFABIEuIGwvCqNjN9B4wqh2rd7EnQ8uC0k943rUqE04eCw2RILlAzvMD0FjlhzwwMMXdDRDxfI7ePFwJP4HUf6aooqreZphtTITGYQYR41gwDrVVtB52DUV2JPDKwtn68LaLc1Ko+Rb1hETf/LqY03t0zNyR1jN1HP/YGOov90eccThokCLH+KetGP8G8GUd3/KqkyTOH/37OcUyFKML2iXvTK//dqkakfapYBO+N3yLKKo/qGFyOXOGq4q7UFUAtRtyXzLYSgquRTDcOmdKWodJGvPoNaHreXkCcTnvc3vIgvLBLxWYVEsFw+sXQUCpBqGWzr6HwjYE4JBg6cSYvgMBVnbe3zi/fPbKYKVTtKl5yQ/f1/RcomLGWKYrpa5g5Sn7w3FFPp9bfKi4C/KuDg87JnmkA4JUMHlWaVEPfJWxCkOw5VKHfsWZYRXeYuP2q4YjbThH+7hftMkzs6ZXaePGMcAlIEXV0loMcDqQJy/JQjlKdUA59Y2pDbi4Y71LXuq8hsG3jTcw9DhZvojDoR3rOUaX7LeoF55pKoi2Q9hNHH332ojoDmVo5Iy+isdeRa2w+iIx22aFvNLIlVtWevvUtZXwPLBMeybPizsBAQmM2Pu9gUMhCrYBrz3oiJrd0dga62twUu5RiLTAEQWzLjXWG2jaMJYBe4pdkMIyw4fraAxgC9Qt51otIVztsEEwEcz8K4iheBoFBzneB3BQo3GRxahipKPdOEJgkqH88RhMl2Y0ozKLlWDjqmk/wHWeTsygnoiHWuY8W7VuirJowaiOxUQQww1JBlktBbyVOSBaGSjdeq3T5xLcU/MkOrRVtnJVavU1Rf5djVUXWojNZibMb9NxIMAF05pNhxA9W0EJxfHCrn4gcmppDpH64fWDB0HxaHfmhE6DenCHbvzanpzBxsPlij+xbDdiZxtpg16E5c912p7ax83IjQToFcJigb6kgnBs4s2gR+kF7aZARsvu0Yi6nDzVlWbTyu707jNhKTO4wd9N9t/Dr1ucvoVM8I9N5p7FZqdYfxPYStcehM326OQN2d+O7bjN7ID28+KnaDekxF7zbUQmGCeRv1AzzdfkqrDPEWnLSDQEGfg2HtN+tSbSVOjx+bbTt2ndPfZVS/RVb+PlT1OYhbaq+utP6jGGEBbYtQI/2/y/gOQLfF0DHgssKHXcauUsY4/R5yG40e5AJncKaPZpm8qwoxyetXF2/eE5p0ZJQeumobdkExCBQt2lMP68MEl2huLuQ62kzzRZGl4L+V7NxWdHUXwgqCjdERRr7VhwbswcU6cIUFsE5x4m/Yvgp+cEGuu6u6rrviJI0jMXUmLqyAZ4Jc4yDX9igcHqj05y+uHbRrUh087HccGanM96Y9bguIN5pC+olg60BNbpGUtg4L/eSD4F5JBjUM8DMmALbQ87VIVQO0BCp66HJ9fJLqEti6EKl4MjmqzpcsFaZHiEQD2z+paAistF/jZW0kEQuSgI6WLhjGAOB0d2fMsTkuzmUw2ThRjeqIXN7aoogJnGNN6Tw4DQ5pPMNoCsIzgZw5TWaLLrRUfIrpn23CO29dpzC4Y8+guHH8gZJu+6tUCrixzYivbZ9gwO79xFNjYyVbUmM9yh2p2WZET0094BK/1aeR168a25bczebtYNaCjGwczgGZjd+DzMavrczWe2RQDrdTyRqUjGDECZYTctsd/5OlShhWrbgxVgX6X9smYXVGZ5nzgu7tWGhbKc22+rZoLdWF7aIWh5mvkXJHYaq8YkXC4np1PUd2hI306bzA1FE45jNt/6zukOgcedGwd4NvrsyhpU8H1MA9Lp2DlAJ/HdlTmWs3zjWcb3LPw96ee66nPyvqN4ENado2du7nI6yObN1uAKM3keocGfIjKe3OkdT++ruAS5ahLYmtPXsAthsyi4eC0ea6pRzTKa4jJkQ9LLopgzXLbIBdOthbJa1ak+tXCJY4OsC2IFXL7JZtNPFozwFi1UmOjRJ3kIVauVx8/r8UDpsUh3X/vdpEs7+vAMffWsB1nH5tUx1uAc1jI49Qsp9FrVqEuZh+bq2KtVJjBp8tDkuSfo9Trxb076hapWDNWrYl8/BzazXVC4e2kIQggUtJAXMouYMaAQNVZhO0w+sDpx+buruhUgMtd7WtxvfryVX/AwLdOmLNRtAk7P9sD9h2CwgZDLSPuPCR0V71oTqdUH9yNf22QmCB6S1I2/jevhpG2djHN+4CKHey+HkXfQto7miRtg9LNITRH5lgCeNe6S7Bo8GbtbSHBRM4Ihf+xESnnb5ev79GUax0u1uO8Vsc0ap0E38AQQ+qNZ9+LY+puCE6UYwJPZNtYfssqxlQGAUo/EkXNq+rX9Ys3KUttxLjAMpyUe5FODuuKGMEVf0j8FBHKZ82cgdrLbgfwE0/JLafxwGlz1d82LhONaUtySQX353/nkvtWypu4ve1FD71qrO3B+BdCUaSGZ/O8OIcMlG0TCviPtfSc9iMjBwBKiO8wwdRGakJ/7oEv6Al+AQifmFnO76U8d/5dBZfcH0TfwezHV9M+JOL+h1FA97VjOJZLdw0P6uEAxKjiVQjh8Gfzmhssi3kwihlhvJs1Cwb9ZfMLFPgtdiGc0osrC9q51iQuadeTx8oN/F3UsX2ZA5zdhpgzgFzPM8gMR/iZmH+k721pyXzOS0KIB0vlahdm7VO9Ffn7Y+zDr86b39u522Zm/N7LvKvXt2XsuK/SJPyz+zVrXN9nnhZfnX7vq7RL9btW+IkPfES+OoOfgkC/9Ud/Nzu4G6p9A0ShJ89jb4Kp8en0BcWVGf2vLAXzcL65ewuTKf3ognlmX0sYO3ULcuhN5vp9n0/revIPLur1eXZvXD8eEee+MqwoFBw2U4RXNLs783BIap6qOCytNpJqP4Ifg1orThaX7DWvqj2DX63WXyZYIFdStISrxamei6SDiK6isSaqe2lVQThVoEojW7YHMk0bCrVfJH7dau1ExBe3s38NePQ3VKm++RyXsCVxnDxNpSu3rA54Skcl8deeF7W3w+/V1XeEsVsQZp7BgdB9u31Sw7rLVAzwd5kIeEN+R6Uv9FbO8ynSpaFPd0D9zLYi9jgMRP0s0s4pJfAJce5az+jApxzqEi1D64Ej9zgVevVQFyTa4FXc4+scFz3EDk7V/bkLpwLoVA0T2xLcu2aEh8RsxsbsNDMLQoaWZMzreH68PXHZj29ds/RwZlxS1FMpkzABQx+1hxozwxdqglNLEOgCFmkeJ+Yw2L5VtoqE7WUwjUQGbulwtjiK3hlwgrIvFk0yQXBhYyPGWCtcPBUAdwU7q6a7TVAIH7Iqmv7L1o81zi3/gtYotf1UfLggvdNi0Kqxw4QIme6vfD858XF5n9ZrFbZsDAI9IMfeb6m7q1j7PmGZUE/BcU4jqOowmqxwQuZ0HKGrRmlIWDwBqY+VufU6qG2RCwYhIg3nY2g5mjF9l21K4uRkasbNvRcVwO8TmRVk2BX/NFJP97KEb8VLH5jp+VheasfnezYpjA16/NKX+f8jzDnTStgZfngB1A++D4F+wTX2POV20afnOMtqIXUmruDMjN6y+pHVzJ2yzL71pzdRvxGUamVKOEK7Bz1jUU3RrskfosC9zwKKexo0H0u5F1lsMQXzup6WH1xbM3hdbcKIYdyKdgca/5t6WHr4tcx3gkFQYL6iJ4bHW7jsQdoKF7nio+9/S3qOhmA7eO3gG18FmDrbNtFurvs4h+4Ns6VORwcLlqBP0lDvpOlSHd/8aACQX4RhPwiLhuPD1X7ZiqZvWgUJatPfqQ3uIW7+7zcbkfOz/Yw1sK1vU0yeC9huS3ZtaEtE/ivFuoXaaF+KaajXSvNBwOExGCHSEPB+tiY/6h272rOBx0D4qIlC+TO3faMHfqgtoP1/JOEEEUp0gX1Z9HVBaM3jOp5DNXKsbxlSnF4uCyC50jcbffC3fXw8d5uPcufzMRNrFz/dCaYCE1Q9smVqr8NedSNluFZdbD4Qi4+Z2Ym3XuweO833PoS7d0O96qXYffu6zc6H/bCB+mYuvWveZYqg8cz3dOStOD2Zck4ZTk+L9mR5sxl1GSqhRe75zNyibbREsCdMN8pma6AWcDP4fs270HZWunreOWmWh8wuH9YB89tMqo6zlb6o7O4HcPlmjNQLFa/w8J7P9eG5Y8ZwUJYMgBerzSxxpCTZ9z34PFPmHn3zGnjedJeBHdX6reT90zd8oQFnK4fBsVlv4cN91IYGrRzjH/HcoIchq4LezjL7OV90u6/zzR546Sc+Muc4F3SVCZl7l/M/Re3Q9IEd0j3jNOZH5VcsMytCjhRC0FUEBX363/WkoH300ttcioCON8zg09hdT8a1Kbgvt6rvz58/Od6+NiuSsM+mb0ioxyXLyqie6chP0a3w+q1DhsCOG28ZFypyateNJMQEP0Y3d/DLao/q+zhAT7bp8hAeaZwYXG27DGyUA7/vzyC28lhu311vxzsNy7cEx7Frz/EA7ar+BP2fhLObPEG7fp5Qxvm6WZro8dnV2DV9R7ujth9fff1c777usms7j6Xj3j6dQVajQdqf0fMHvvO6woSgkdrdyTgj/zG6wrGLLx7uyN7PtsTriu3kOkjJvgJH3FdhSP6Pzui+Ad+vnWVeglfs605cwV/KG7vcd7KmvzmwkXjnpMl75wsQ8iH+0RjJXhEA0sY4+IzRgHp7ZA7Y/ZdBRcyw4Jp+woBeI3OnV2oAcKQFzSAKB8qRSEFs3dA2XXes22C4OszTT7mXPC8zEPYV994XziVia7DDns+WBM7LYO/Q2gidj25mP7FAYyDz88BDQjdrZnnf8boMMev3p3H/3Bue2sp2IYQSyhM8NtCRLkR4vn+zWWEz4iEoYcq1OD+E+Q/m7N7f29bXMobJh4eqsk28DcG0h7+F3lGQFA=
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Returns a list of payrolls for a company. You can change the payrolls returned by updating the processing_status, payroll_types, start_date, & end_date params.
+
+By default, will return processed, regular payrolls for the past 6 months.
+
+Notes:
+* Dollar amounts are returned as string representations of numeric decimals, are represented to the cent.
+* end_date can be at most 3 months in the future and start_date and end_date can't be more than 1 year apart.
+
+scope: `payrolls:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-id-unprocessed-termination-pay-periods.ParamsDetails.json b/docs/api/get-v-1-companies-company-id-unprocessed-termination-pay-periods.ParamsDetails.json
new file mode 100644
index 000000000..02a817035
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-id-unprocessed-termination-pay-periods.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"string"},"description":"The UUID of the company"},{"name":"X-Gusto-API-Version","in":"header","required":false,"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.","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"}}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-id-unprocessed-termination-pay-periods.RequestSchema.json b/docs/api/get-v-1-companies-company-id-unprocessed-termination-pay-periods.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-id-unprocessed-termination-pay-periods.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-id-unprocessed-termination-pay-periods.StatusCodes.json b/docs/api/get-v-1-companies-company-id-unprocessed-termination-pay-periods.StatusCodes.json
new file mode 100644
index 000000000..65322c954
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-id-unprocessed-termination-pay-periods.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"Example response","content":{"application/json":{"schema":{"type":"array","items":{"description":"The representation of an unprocessed termination pay period.","type":"object","properties":{"start_date":{"type":"string","description":"The start date of the pay period.","readOnly":true},"end_date":{"type":"string","description":"The end date of the pay period."},"check_date":{"type":"string","description":"The check date of the pay period.","readOnly":true},"debit_date":{"type":"string","description":"The debit date of the pay period."},"employee_name":{"type":"string","description":"The full name of the employee."},"employee_uuid":{"type":"string","description":"A unique identifier of the employee."},"pay_schedule_uuid":{"type":"string","description":"A unique identifier of the pay schedule to which the pay period belongs."}},"x-tags":["Employee Employments"],"title":"Unprocessed-Termination-Pay-Period"}},"examples":{"Example":{"value":[{"start_date":"2023-01-11","end_date":"2023-01-24","check_date":"2023-01-28","debit_date":"2023-01-26","employee_name":"Mary Warner","employee_uuid":"094f6ded-a790-4651-87e6-4a7f15dec7c6","pay_schedule_uuid":"00ebc4a4-ec88-4435-8f45-c505bb63e501"},{"start_date":"2023-01-25","end_date":"2023-02-07","check_date":"2023-02-10","debit_date":"2023-02-08","employee_name":"Mary Warner","employee_uuid":"094f6ded-a790-4651-87e6-4a7f15dec7c6","pay_schedule_uuid":"00ebc4a4-ec88-4435-8f45-c505bb63e501"}]}}}}},"404":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided UUID is valid.\n"}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-id-unprocessed-termination-pay-periods.api.mdx b/docs/api/get-v-1-companies-company-id-unprocessed-termination-pay-periods.api.mdx
new file mode 100644
index 000000000..89ff0de6a
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-id-unprocessed-termination-pay-periods.api.mdx
@@ -0,0 +1,73 @@
+---
+id: get-v-1-companies-company-id-unprocessed-termination-pay-periods
+title: "Get termination pay periods for a company"
+description: "When a payroll admin terminates an employee and selects 'Dismissal Payroll' as the employee's final payroll, their last pay period will appear on the list."
+sidebar_label: "Get termination pay periods for a company"
+hide_title: true
+hide_table_of_contents: true
+api: eJztWN9v2zYQ/lc47qEtIMayayepnxYsWZGHrkbbrAMSI6XFs8VGIhmSciIY+t+HoyRbju22QV+GYXmJbB6/+/3dySv6yBaF85pJ5WFhuZdaMV8aoONrCvkMhABBI8qN6Yo4Oo2o5wuHYhNeko9JCqLIIBxYcEYrB46OV3QQx/hPgEusNHiZjunFI89NBqSVpBFNtPKgPMpyYzKZBEW9rw4vrKhLUsg5PtXWUW4tL2lEpYfc7Wr4lCK6seBA+QBF9JxwRQplrE7AORDEg82lqk8NL4kBK7U4olGrRM++QuJpRI3VBqyXtU/Oc+tvBffQMch5K9WCRnsMCfIE5dEIn8ITbRa4eK+yko69LaCKKCjxDHhQ4iB4FdEkheTuGXBB/jnWCpjJ54QjyH/LYshNpkuAW8XzH8ScF1lGULyFbDG2AYtCiu8DnpFCyfsCiBSgvJxLsHthDS9vXVP5Pw+NQWjRiNfkIZVJ+iQ8ZAaZVgt3RKsqoo+s7cGLxixSP+SgfN2j0mdozdWm6tmnTdWzCS/ZJCAHQKj7MhR506P4uORZgYywXfl0EA9es7jP+n3aLdn194Mh3a6+zckp3S6bzckx3ck/fcdtST5zq8DSnWTS+M1wfixAMH7yJmbD41GfnZ7AMRvyk3l/JCA5SRB0T7JoHMMsGfIhg+T0lA2Hr0fsdD4csWQUj2az49cwivu0ig74PRjt83vA4pP9fg9YP97v94DFp/8+v6cV/kV0GA93CfZP7ckfulCC3ChCblRNuPcFOA8CiV0XNgEiNDiitCfwKJ0/Iu/4HRBXWKgL2+qlFCDI1dXlOZGOLHkmxdGNCtWIlBvK9BJtXoBnyz5LdG64kuCap/JWCtYh9dsOqd+i73XjuJ1O/JyCIhx7y+osI1zkUq0nAjicFW3ECVeCOMgg8Y7c0HPpcukcz8ikvnxDCXdb9PDCkblUPGvhIzyVlmTc+W47P0hUbQxwS7QKEBnG6UZhRKVDbjdaKk8s+MKqWkt3hm3AHJlrSwxqQHvnhQ9hbj0Sa+Mckej5Qi5BkSaKQaNLtIEx+dIY7cZI9V9CDVmegwfrAgs05blJAM5hjKnhPg0T4r6QFkQ9IaLd4d2QY7WPyUMpNJTYaAgt2Cj9m70NC8vZ5JL9BdbhxUZ7ClyETtnon/PMwVMt51AHBepoYieyGcdgnk0uybIGJdw5ncgQuAfpU1LqwgaBhGfZEbmcE6UVYNG2VRzVMp315YUj17lUMi/yLvb0Zeq9ceNeT+jEHYUN7CjRea/duFiTgXDe40ay5qZUi18bQNb5+hWaUTgI8/lQtJGrihynxSAejFh8zPojnBEC5rzIfE1G7fdVNcX54gzwO+CuZAurCxNSXG6WvW0RzBDTS7BWCqg7tjN3OmNnsm5JePSgXNgosbDuoKTjwztptJ5E395NsVxaqKcerDG2Pdl/ZdujzdXveobRy8GnumGu0EM+pWPaW/Z7aw7rrTY9VPU6bNX7MUZzYJdtUxY2wx5oCosbWdcVE5CH4tohwHPI9ZMM1ngszAi8F8JyAHgv5sRq8Q1Mg8cYGwdJYaUvg+W/1zE4S9DfswLDdD3tSmGa8nor2SO7rnM0sa1//DwDbgMfbNvYQLAMlpARXvgUN7G6YZGSPpbOQ/4zGmqEAwoqZKu5DqjNdhYYDQkCS6zhtK1ujCjWgHs//wh2KRPo5GNDHnymC98Lgj2BqnF+svCZ6XnIA17dmYOQJToPG2ew44UjF01ztfMtcJfQSZG3L1O/NG9sPAlvbA03n7dayQfImmbEvYXLLBRUc/rbpn4wGkY7n3PVwXkL/sC7WT3j+HowPHFmtXmN/H++P2O+N+Xt4dH3TMZl6IPQ96uGt67psh9y3jAXjeh4a/5vE9OP0Nc0oql2HrFXK5y/VzarKvz6vgCL1DBFxrWSz7L67UNIh88H5no3+S8/NCvAK3JopzjgdfvzQpBo+Z5GzXDouFxNq6hdOZ5n3H98/9gb1jp8+5e3dZQ3QxjZ1/jO2c5vQlsT9u3FJ1pV/wCu9olg
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+When a payroll admin terminates an employee and selects "Dismissal Payroll" as the employee's final payroll, their last pay period will appear on the list.
+
+This endpoint returns the unprocessed pay periods for past and future terminated employees in a given company.
+
+scope: `payrolls:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-uuid-contractors.ParamsDetails.json b/docs/api/get-v-1-companies-company-uuid-contractors.ParamsDetails.json
new file mode 100644
index 000000000..6eee84efb
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-uuid-contractors.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"X-Gusto-API-Version","in":"header","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"},"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."},{"name":"company_uuid","in":"path","required":true,"description":"The UUID of the company","schema":{"type":"string"}},{"name":"search_term","in":"query","required":false,"description":"A string to search for in the object's names","schema":{"type":"string"}},{"name":"sort_by","in":"query","required":false,"schema":{"type":"string","pattern":"^(type|onboarding_status|name|created_at)(:(asc|desc))?$"},"description":"Sort contractors. Options: type, onboarding_status, name, created_at"},{"name":"onboarded","in":"query","required":false,"description":"Filters contractors by those who have completed onboarding","schema":{"type":"boolean"}},{"name":"onboarded_active","in":"query","required":false,"description":"Filters contractors who are ready to work (onboarded AND active today)","schema":{"type":"boolean"}},{"name":"terminated","in":"query","required":false,"description":"Filters contractors by those who have been or are scheduled to be dismissed","schema":{"type":"boolean"}},{"name":"terminated_today","in":"query","required":false,"description":"Filters contractors by those who have been dismissed and whose dismissal is in effect today (excludes active and scheduled to be dismissed)","schema":{"type":"boolean"}},{"name":"page","in":"query","required":false,"description":"The page that is requested. When unspecified, will load all objects unless endpoint forces pagination.","schema":{"type":"integer"}},{"name":"per","in":"query","required":false,"description":"Number of objects per page. For majority of endpoints will default to 25","schema":{"type":"integer"}}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-uuid-contractors.RequestSchema.json b/docs/api/get-v-1-companies-company-uuid-contractors.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-uuid-contractors.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-uuid-contractors.StatusCodes.json b/docs/api/get-v-1-companies-company-uuid-contractors.StatusCodes.json
new file mode 100644
index 000000000..a02f48c9f
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-uuid-contractors.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"type":"array","items":{"description":"The representation of a contractor (individual or business) in Gusto.","type":"object","properties":{"uuid":{"type":"string","description":"The UUID of the contractor in Gusto.","readOnly":true},"company_uuid":{"type":"string","description":"The UUID of the company the contractor is employed by.","readOnly":true},"wage_type":{"type":"string","enum":["Fixed","Hourly"],"description":"The contractor's wage type, either \"Fixed\" or \"Hourly\"."},"is_active":{"type":"boolean","default":true,"description":"The status of the contractor with the company.","readOnly":true},"version":{"type":"string","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."},"type":{"type":"string","enum":["Individual","Business"],"description":"The contractor's type, either \"Individual\" or \"Business\". "},"first_name":{"type":["string","null"],"description":"The contractor’s first name. This attribute is required for “Individual” contractors and will be ignored for “Business” contractors."},"last_name":{"type":["string","null"],"description":"The contractor’s last name. This attribute is required for “Individual” contractors and will be ignored for “Business” contractors."},"middle_initial":{"type":["string","null"],"description":"The contractor’s middle initial. This attribute is optional for “Individual” contractors and will be ignored for “Business” contractors."},"business_name":{"type":["string","null"],"description":"The name of the contractor business. This attribute is required for “Business” contractors and will be ignored for “Individual” contractors."},"ein":{"type":["string","null"],"description":"The Federal Employer Identification Number of the contractor business. This attribute is optional for “Business” contractors and will be ignored for “Individual” contractors."},"has_ein":{"type":["boolean","null"],"description":"Whether company's Employer Identification Number (EIN) is present"},"email":{"type":["string","null"],"description":"The contractor’s email address. This attribute is optional for “Individual” contractors and will be ignored for “Business” contractors. "},"start_date":{"type":"string","description":"The contractor's start date.","readOnly":true},"address":{"type":["object","null"],"description":"The contractor’s home address.","properties":{"street_1":{"type":"string","readOnly":true},"street_2":{"type":["string","null"],"readOnly":true},"city":{"type":"string","readOnly":true},"state":{"type":"string","readOnly":true},"zip":{"type":"string","readOnly":true},"country":{"type":"string","readOnly":true}},"readOnly":true},"hourly_rate":{"type":"string","example":"50.0","description":"The contractor’s hourly rate. This attribute is required if the wage_type is “Hourly”."},"file_new_hire_report":{"type":["boolean","null"],"description":"The boolean flag indicating whether Gusto will file a new hire report for the contractor"},"work_state":{"type":["string","null"],"description":"State where the contractor will be conducting the majority of their work for the company.\nThis value is used when generating the new hire report."},"onboarded":{"type":"boolean","description":"The updated onboarding status for the contractor"},"onboarding_status":{"type":"string","description":"One of the \"onboarding_status\" enum values.","enum":["admin_onboarding_incomplete","admin_onboarding_review","self_onboarding_not_invited","self_onboarding_invited","self_onboarding_started","self_onboarding_review","onboarding_completed"]},"payment_method":{"anyOf":[{"type":"string","enum":["Direct Deposit","Check"]},{"type":"null"}],"description":"The contractor's payment method."},"has_ssn":{"type":"boolean","description":"Indicates whether the contractor has an SSN in Gusto."},"department_uuid":{"type":["string","null"],"description":"The UUID of the department the contractor is under"},"department":{"type":["string","null"],"description":"The contractor's department in the company.","readOnly":true},"department_title":{"type":["string","null"],"description":"The title of the contractor's department.","readOnly":true},"dismissal_date":{"type":["string","null"],"description":"The contractor's dismissal date.","readOnly":true},"upcoming_employment":{"type":["object","null"],"description":"The contractor's upcoming employment details, if a rehire is scheduled.","readOnly":true,"properties":{"start_date":{"type":"string","description":"The start date of the upcoming employment."},"setup_status":{"type":["string","null"],"description":"The setup status of the upcoming employment."}}},"dismissal_cancellation_eligible":{"type":"boolean","description":"Whether the contractor's pending dismissal can be cancelled.","readOnly":true},"rehire_cancellation_eligible":{"type":"boolean","description":"Whether the contractor's pending rehire can be cancelled.","readOnly":true}},"x-tags":["Contractors"],"required":["uuid"],"x-examples":{"Individual Contractor":{"uuid":"c9fc1ad3-c107-4e7b-aa21-2dd4b00a7a07","company_uuid":"b7457fec-3b76-43bb-9c6e-69cca4688942","wage_type":"Hourly","start_date":"2022-01-01","is_active":true,"version":"63859768485e218ccf8a449bb60f14ed","type":"Individual","first_name":"Kory","last_name":"Gottlieb","middle_initial":"P","business_name":null,"ein":null,"has_ein":false,"has_ssn":true,"department_uuid":"56260b3d-c375-415c-b77a-75d99f717193","email":"keira.west@mckenzie.org","file_new_hire_report":true,"work_state":"FL","onboarded":true,"onboarding_status":"onboarding_completed","address":{"street_1":"621 Jast Row","street_2":"Apt. 281","city":"Coral Springs","state":"FL","zip":"33065","country":"USA"},"hourly_rate":"60.00","payment_method":"Direct Deposit","department":"Engineering","department_title":"Engineering","dismissal_date":null,"upcoming_employment":null,"dismissal_cancellation_eligible":false,"rehire_cancellation_eligible":false},"Business Contractor":{"uuid":"c7c0659c-21a6-4b4e-b74c-9252576fc68c","company_uuid":"0ec4ae6e-e436-460d-b63c-94a14503d16f","wage_type":"Fixed","start_date":"2022-01-01","is_active":true,"version":"8aab307f1e8ed788697f8986346af559","type":"Business","first_name":null,"last_name":null,"middle_initial":null,"business_name":"Labadie-Stroman","ein":"XX-XXX0001","has_ein":true,"has_ssn":false,"email":"jonatan@kerluke.info","file_new_hire_report":false,"work_state":null,"onboarded":true,"onboarding_status":"onboarding_completed","address":{"street_1":"1625 Bednar Center","street_2":"Apt. 480","city":"Port Charlotte","state":"FL","zip":"33954","country":"USA"},"hourly_rate":"0.00","payment_method":"Direct Deposit","department_uuid":null,"department":null,"department_title":null,"dismissal_date":null,"upcoming_employment":null,"dismissal_cancellation_eligible":false,"rehire_cancellation_eligible":false}},"title":"Contractor"}}}}},"404":{"description":"Not Found\n\nThe requested resource does not exist. Make sure the provided UUID is valid.\n","content":{"application/json":{"schema":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided ID/UUID is valid.","type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["error_key","category"],"properties":{"error_key":{"type":"string","description":"Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error."},"category":{"type":"string","description":"Specifies the type of error. The category provides error groupings and can be used to build custom error handling in your integration."},"message":{"type":"string","description":"Provides details about the error - generally this message can be surfaced to an end user."}}}}},"x-examples":{"not_found":{"errors":[{"error_key":"request","category":"not_found","message":"The requested resource was not found."}]}},"title":"Not-Found-Error-Object"}}}}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-uuid-contractors.api.mdx b/docs/api/get-v-1-companies-company-uuid-contractors.api.mdx
new file mode 100644
index 000000000..f9152c177
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-uuid-contractors.api.mdx
@@ -0,0 +1,71 @@
+---
+id: get-v-1-companies-company-uuid-contractors
+title: "Get contractors of a company"
+description: "Get all contractors, active and inactive, individual and business, for a company."
+sidebar_label: "Get contractors of a company"
+hide_title: true
+hide_table_of_contents: true
+api: eJzdW/1uG7kRfxWWLRAb0MqSrO9/er44Sd1eE+Oc9ALYro67O5IYr8g9kmtH5wjIaxS4e7k8STHkfkorW3acK9C/7qwlZ34z5Hxycks1BIniZknH57f0uVzETCyPggC0PkrMnI7PL1eXDRqCDhSPDZeCjukrMIRFEQmkMIoFRirdICww/BoIEyHhwv3RIFyE/JqHCYvsBz/RXIDWDTKVijASOH7NC3EhdCBjGJOfS0THClj4M23Qj94s0UZ6XBiYKYYwPLOMgY7PKSx8CEMIaYOyOC4v0fSyQQ2baVz2vCCLP8dMsQUYUNoKLtgC6Ji+915ZPkenJ96/QGkUt0E5yjwHFoKiDaqDOSwYHd9Sh4Bqo7iY0QYFkSyQVafV6XmtvtfuUau6KUsiQ8fl31frKj1GLAtUDjFzICEz4PlMQ0iOTk/ItcNCmNYy4MxASG64mZOlTJRdELAoapKTKRFSAOGaxEpe8xDChlvD4jjigdXKM03OF1zwRbIo077cmxsT6/HBQSgD3bT6bgZycZDp14vZUskost8PWMy9dCcXsz+nBL3Sz/sII9EQNumqkWs4PfFJkvAwU23MzJw2qIJfEq4gpGOjElhX0Ns5kHfvTo6JnFoNpYTuOJBVia0GpoL5BHWccf0lAbWssJ2ySG/wPSKOHDGSOCr27nJhUUj/AwTmmSbIR+8KRioz8Zf3Atl+02JmDCjc/O89/PZJCl8yFXIxm2jDTKI/Ia9PgQK8LBNm9vfGe0wHn1C4/f2//mXzBp5JZcoW3SRv7Cc9JsiiQTZ4NKzUDVJwKZ90uhzCByr8JY/QLMtQiL8kZi41kJu5JHN27Y4/AjSEAlad+n0pI2Ciov8c2cS5qScAiLiYAoIOa4lX5UaqK7KXcyJHr48zD2lkyJb7u4J1bgH1+0306AMIgr5YAUE8YRJBiAL4QEKuF1xry/mBWCdWyG+HOIdmw8qNXZH+xiJ0PFwQmE4hME7dZA8+BlESgi7Hqa0C73w6MZs99PqgI8NtxMyZQai4HrSBsEl+moMgidAxBHzK0Xvf8CgikWShDbjO3WiSiAi0JiDCWHJh0CMFoJEsqp9L0awTwIZGUFUBbEx7CP7XycIHhW44QxODshI1yUupyIJ9kJhQ4IoMoHZypKEQtd3p3Y3wsgj6St+wWRYUFOhYCg0ad3VaLfzPmh9LbPYyTSLaoHiVQBhcVQqBBx80Lr3dBMCUctfWwEJv0sazUxAr0CCMJYVSstKNJXullEeqPOPZxxtpkws8mpSbUyD6cyVjUIY7sWxsrPH69wXEHEOZFXqkNyJaOgWuGtUI/AgudvcGR01gEUdyCSHxl7V8b9gMJo7Z9tTpJf9o3c3fZKKiJd3IPN9W2D7T5MZako1PwM0cFLlwRC4oqv8ipXRBMQuhXGcuf9OsS5natvzDhb0ahdtkrKSeWgWkedFuOg8SpUCYPPNLebob0yRnAPbv8yIHI7OEh/DANI6HsIilAREs99O8ZirVIr3agszlDVpropEd12TKIbIJHb3vJE9yM6AN+n1qBTsc6NpZFmSyA81oXdAmQSBTrrSZOHeWwTkv8Igkiu5j++Xzf1A0pY3NaJrkLcrKjFHcTwxkThqdolXSl8+/Fbi+fP69ErFsQEJv5wPhMyFLmzLoa1usPiP2JFIgmf+dEAsehhFMuOCGs+jrJHG0SEqrThxpd7Pom4mTOe/HnAtuqfEUGcldjmcLtLuk2aoCKw9w8UApXkIIikXkhXPuipyEIAyfpoGUFMnAA+RcP7cnl3PO9GRN1sLL1wv70xysx0kd+DN9n8h7L05e77tK22YDVr8Lxr/y1lsShIWh2lF5T3rprUPVhikzwQ7EjqGq7L7tZtu+qI2BqWBlHeVJ0M46mssF5CrayJ60UQBm0q4Dv4EnXdy589A2UyjbL9uJ/BYtbqz8lcc7rQtkIozahfuqZvfcJkMTtQUVfGRYVdMx7bWarXsOOz0KJEiQ4J0ejTsHkeeA+PHL599ccvbl8+9NF8kjmAi4mcy5gomCWCrzEBtGfOkaMo3YzHYf0WrFjNyk9m3zYmcWyI4wIuCGIEPiGFoTqTozxIb1/GTtOO+17zNcj6wVbGaMzjADKcIksBBxRbl4MnPgyjUSCkxZv9Tq+ppFCWRtNuQjyAwEKJbTWxPOqrlozNQnwesqTeKQVRstWSJcr6qNPtH9buSNyGPlxeb+C0owq3TiWovPkkwWLriYlDZwkTWGsB28/lXBNYcbLDwhmpY/CGkmXFxz12VZ/7r9i/V2tV9yVqXf8p4VvVxhD2+5AGEmCzBzac+CieWbqW1Hb0uqj7nClsYxxFJz9JnP5xBcIbl8j72Jmy37DUedsieOfR42tRY7XIsTZ1igc7tau95zhvGHnJ29LhWjtuUYM2Ws3NX6c6dYWS5EC0o1tWgisFdf4ffosPxMl3mlfd+76rySjIab6KGJo92zmVFVYNTzzfpfa7H7EfLmnbStgTyJA7nAS+3K/nUNPyioP9MkI0cKciQEw3ikGxg8GFFg/RjXRdduE9hmLvCwVKbIXrIDqAFmL7IGk8Qb/m0nVduta72EejaryqkGTAQQRTYLnUDEZ9yPtjUy6lLbjfsUg7DevDjugAkblBynOg3brMLG528GJz3pHbCssEm45YGv6GKeu4aa7SimGY49siJzJsXeov9Gg9E0aLPw0AvarYHXhYHvMdZpe50w7PqtFhuw1oCu99OoP+j2BlMIvEN/0Pe6h77vjYI+eP1RELBufzgcdTu00g3Lml3VzBtfCzteq+212rTSuHL3PG8m0f7hsDca9IfdYQ867WEQTIes2x35fr81bXdtcEr5VFoy5bYJ/Ye0nd9SD4K+ksZEHHy6WdXTU7pRG+N1TwtM9795DZY2kfPgkjXX1gIB7fU7/ZZ/GHrB4aDnddu9wPMHA+YNeuFoNB20B+3RIc1rLHoFXLHmDWjz3SK4AvErh6ZUM7otjXRsy2kcffkDrWRDbklN+lIfxCvVTFF10H6nTf6ObZgfpc018hKDHsWmSTpDPFBXQtDnEqvrsxidhqZ5weCg2ZqAHh62+j1ayvzpu7Mjup7M036r2WrRzbRiM2cox0T6Qsy4AMg94nroWl+wFmPcWdcGA/fpXveVXo+7nYpdtCr6iFsMdhC0+r1R4HXarO91/S54/qAbeKNOr9Mb9KdBfxhsGmwLgi6DPnjQPex73X4r9Pz+YeCNuqzd7bUOw3Z/umawWZf6UfY6ZMw/bA2mbRhCOBgO+6PBdDga9g+7fTbt9UaFveZd06q1OsWWbNX9sG6l7tc1M6U/MJ+FHLwzo+TCemdrpPT9e+/9+/etlkWf267DnptuelaZCX6QghkmvrsCFSVX0MTe8Vb7S/eWDdAhfHoDbPc7PfI9hIIp8hyEcWMba2bYHbYKMzzFwu/5nKlIGls61NrhqNe93w4fYYbpTUwNpmSd679kRrluWv8DW8QXgNRDlGxxtbI5S7fV3Xw7ey0NeSkTEeKwj3tIS989iQItExUACSVoIqQh8JFr0yT/ZFdAdJKWz9lMi6sDXP3Lw+aFeMhD3xZQ5EIQ8rW4To4PqtBqnvrKeQkolY0jVdLW9Pc7niXvpTq5AtyARdoMg3s9D7vq3sz4LH2O1qVWht1OZBAk2DZ8u4w5jiAt3SvRFSwJT7um6UBT3hY6yCeviILINhaMLEja5DpH/QBoSMF2lvDZ2VIitspISWWHpFPkMyWTGIOubZOmuaZto+AoQMKjkARYtS7S9XMmwgizUy7cRFVpzsw9fYDWOAxwL+TTDEha3xDmy8SUlOqlTZxcnSnpDKVO1JQFDikT+MaOwFUzs75qloutjSne8PLFOq+cP01vfPm+jEsbS8LRLQZyw5x92A1NurosO4jX0njWyLwXyNR7425tChcvpVXjCbrJGRjvuu25GM1Be+Vo7ZV61XYqUMfAroDppYfhzZPXoBQPkWfErTzw0YDQdhYQhXbibp0mbFDbYrp3qhDbLVVSbkYh3+8qpWLRNpz5BocX2zZ5wJiBcZNeczqmB9ftg1wnB7dlpawOqlrRoK6zscZEYZzOXoRZzN2DsBfCwr4Kb1zOY1jINc06ep7NlXCfnfHaQriW5qmS4R00Y/yMkmeTqGfoq93lrZlHzc0LmWczJLbeBKZspK9yT0l4EVxDRFhi5uiXXHhAuz1bagOLr+HgKGxhgEMHmBYh1dQcXAv66PSEltPC0nBoww5S6TfTM1DXPICSpov3fOs1DuzCgxBZox159m9PTq2GcetG9Q1RgM8nRrqunH3oclednLrJADsVGsogWWRDLn9KAywLbIBNU8njjCv5EaLUNIrkMMf0XXEzUBux1AYTz4IOThOX363SiZpsvLOC/7YI9H/8FHJ6LQx8NAdxxLi9P9YSblM7PafX7bzC4HYgdLw28RpU2xRzqQ3uu73Fad93Klqt8Gc3i4UmHHLN/GjbNFZZHw+cVK2Vxjms6rRs5qKs4e8O50nmSe+Gmc/RPhLiV42a3gGsPPr6hNAeNWS6C8xiDvabKnLXWdM7IFemYb892D9gzHQnYfNx2keK/IfNnN4hTToq+0gJnnDq9C6MNrwXEC/xD8WZLXwf5Iz3fkwrsn2y/V8u1CLJSj5ROe8MYSWarPAdMf2HKQ+D93/9z03uPOL6f+JTuZVuIaaEsSl92+grVNL1Vy/eYq1QzSDzjDH9n9LbbvV8b2/dirfyCsRqlR+3wb9tObX6L27O+uM=
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Get all contractors, active and inactive, individual and business, for a company.
+
+scope: `contractors:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-uuid-holiday-pay-policy.ParamsDetails.json b/docs/api/get-v-1-companies-company-uuid-holiday-pay-policy.ParamsDetails.json
new file mode 100644
index 000000000..e5b4000df
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-uuid-holiday-pay-policy.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"X-Gusto-API-Version","in":"header","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"},"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."},{"name":"company_uuid","in":"path","description":"The UUID of the company","required":true,"schema":{"type":"string"}}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-uuid-holiday-pay-policy.RequestSchema.json b/docs/api/get-v-1-companies-company-uuid-holiday-pay-policy.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-uuid-holiday-pay-policy.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-uuid-holiday-pay-policy.StatusCodes.json b/docs/api/get-v-1-companies-company-uuid-holiday-pay-policy.StatusCodes.json
new file mode 100644
index 000000000..09b8c2396
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-uuid-holiday-pay-policy.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"successful","content":{"application/json":{"schema":{"type":"object","x-examples":{"success_status":{"version":"1b37938b017c7fd7116bada007072290","company_uuid":"b7845189-f12b-4378-918a-d2b9de3dc4ea","federal_holidays":{"new_years_day":{"selected":true,"name":"New Year's Day","date":"January 1"},"mlk_day":{"selected":true,"name":"Martin Luther King, Jr. Day","date":"Third Monday in January"},"presidents_day":{"selected":false,"name":"Presidents' Day","date":"Third Monday in February"},"memorial_day":{"selected":true,"name":"Memorial Day","date":"Last Monday in May"},"juneteenth":{"selected":false,"name":"Juneteenth","date":"June 19"},"independence_day":{"selected":true,"name":"Independence Day","date":"July 4"},"labor_day":{"selected":false,"name":"Labor Day","date":"First Monday in September"},"columbus_day":{"selected":false,"name":"Columbus Day (Indigenous Peoples' Day)","date":"Second Monday in October"},"veterans_day":{"selected":true,"name":"Veterans Day","date":"November 11"},"thanksgiving":{"selected":true,"name":"Thanksgiving","date":"Fourth Thursday in November"},"christmas_day":{"selected":true,"name":"Christmas Day","date":"December 25"}},"employees":[{"uuid":"1ca3cd25-3eda-48c6-ac88-f0e7fb91a15a"}]}},"description":"Representation of a Holiday Pay Policy","properties":{"version":{"type":"string","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."},"company_uuid":{"type":"string","description":"A unique identifier for the company owning the holiday pay policy"},"federal_holidays":{"type":"object","description":"List of the eleven supported federal holidays and their details","properties":{"new_years_day":{"type":"object","properties":{"selected":{"type":"boolean"},"name":{"type":"string"},"date":{"type":"string"}}},"mlk_day":{"type":"object","properties":{"selected":{"type":"boolean"},"name":{"type":"string"},"date":{"type":"string"}}},"presidents_day":{"type":"object","properties":{"selected":{"type":"boolean"},"name":{"type":"string"},"date":{"type":"string"}}},"memorial_day":{"type":"object","properties":{"selected":{"type":"boolean"},"name":{"type":"string"},"date":{"type":"string"}}},"juneteenth":{"type":"object","properties":{"selected":{"type":"boolean"},"name":{"type":"string"},"date":{"type":"string"}}},"independence_day":{"type":"object","properties":{"selected":{"type":"boolean"},"name":{"type":"string"},"date":{"type":"string"}}},"labor_day":{"type":"object","properties":{"selected":{"type":"boolean"},"name":{"type":"string"},"date":{"type":"string"}}},"columbus_day":{"type":"object","properties":{"selected":{"type":"boolean"},"name":{"type":"string"},"date":{"type":"string"}}},"veterans_day":{"type":"object","properties":{"selected":{"type":"boolean"},"name":{"type":"string"},"date":{"type":"string"}}},"thanksgiving":{"type":"object","properties":{"selected":{"type":"boolean"},"name":{"type":"string"},"date":{"type":"string"}}},"christmas_day":{"type":"object","properties":{"selected":{"type":"boolean"},"name":{"type":"string"},"date":{"type":"string"}}}}},"employees":{"type":"array","description":"List of employee uuids under a holiday pay policy","items":{"type":"object","properties":{"uuid":{"type":"string"}}}}},"required":["version","company_uuid","federal_holidays","employees"],"title":"Holiday-Pay-Policy"}}}},"204":{"description":"no policy exists"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided ID/UUID is valid.","type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["error_key","category"],"properties":{"error_key":{"type":"string","description":"Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error."},"category":{"type":"string","description":"Specifies the type of error. The category provides error groupings and can be used to build custom error handling in your integration."},"message":{"type":"string","description":"Provides details about the error - generally this message can be surfaced to an end user."}}}}},"x-examples":{"not_found":{"errors":[{"error_key":"request","category":"not_found","message":"The requested resource was not found."}]}},"title":"Not-Found-Error-Object"}}}}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-uuid-holiday-pay-policy.api.mdx b/docs/api/get-v-1-companies-company-uuid-holiday-pay-policy.api.mdx
new file mode 100644
index 000000000..3bc44e87e
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-uuid-holiday-pay-policy.api.mdx
@@ -0,0 +1,71 @@
+---
+id: get-v-1-companies-company-uuid-holiday-pay-policy
+title: "Get a company's holiday pay policy"
+description: "Get a company's holiday pay policy"
+sidebar_label: "Get a company's holiday pay policy"
+hide_title: true
+hide_table_of_contents: true
+api: eJzdWdlv2zwS/1e43Ie0gOUjR5P4aYum7abbI2jSb3fhBvlocmyzkUiVhxPB8P++GIqSJR81il34YR+M2NJw7vnNcLKgOgfDnNTqWtAhnYJL5oOE6yxnSoKN34oH76VIZjqVghUPOX50KnlBO1SA5UbmyIIO6XtwhJF46siSeITk+AlHvqvvynKdw5D8ucFQgh0aYOJP2qHPydRbpxOpHExLHRNX5ECHIwrZGIQAQe871AL3RrqCDkcL+qaU/JpzsPa1dzM6HN0v71fcjH1iUzp0xkOHGrC5VhYsHS7ocb+Pf9r2WB84TXxKO5Rr5UA5pGJ5nkoelOr9sEi6oJbPIGP4rVST6vEP4C6YAs8sy9NSUOT5YB1zPjyZg7GlvMH45Pzy5GLcH5zz84k4HwxejZlg/f55//z4+LIftFiFhA7p+Pzi9GxwcZlMBsfj5PTk/CK5HFywRByPLwWcCH4KjHboBAQYlj5ElwexCp4eCmDGPghWBM0gBe5AVP5RLEM7PsMT+Tcwc2TJFQsxZw6ff2DKM1OQAV12aJY+7mHziRknFfno3QwM+YdU0w75YLptnnczaQT5pBVmjVQkykAJuQErBSi3Rd8JS+1K0k1NefRr7u9gbCr2GWTaSJbusyKStRl/ZNY1+H5igeUPr8ABKEzD3dp+WFGtXOsVkMElMpFKQA5KgOKwR7frBulaqHxakFNkl7KxNvsc+BGJ2hzeSdMy8RZyh2VokCnXqc/Gfm9g3kQ6ZE1eXCshp6C0t+QGNJZHCNfLldBb4Fo1A/aFOx1lzsGBYWpf8v4RydrWfNbzoDwZhOR1M6Ye7VTOpZr+gtddk2zlGe2Nm5G7mTc2qlmxD76ZGWldxvYp+qaia2t6BbzU9PiMLpcdClme6gIQSkYLGkFgwNkJF8dnyQkIlpxe8FcJ4xcXyaQP55Px5YANzhhd3uP5Nr59BawqUC5AGdETwsjfI2bf4KeC+dxgp3AS2oBVY511Jjqlxf9uBoR7Y0A5Eg+hEDcDUqJjl9wChN+j+F6qKZl6KeD+xcy53A57PaG57Qb87nKd9Sr0T3JWGJ2m4X1vdfyvJeskZQWYl2SiDZFqok0WjVRkpp+I08RbFC0tmUhIRbfM5Ca67jPvNfFK/vRAAtrIiQQTxKE9kRPRT8EkfLTZDVHkNmhe7yBtsR+ldZUbIYU5KGJ9nmvjQJDIrhJmCVMCKaUhAhyTqd0I50YjWBffJl8lcE051joFptCcMp3XPbesEnrjxbLdPA4terOrHNz4tcZzaPntLnVo6dva26F1aPXEQwtf752Hlr/eRw8tf733Htz/6/35sAqs9fSaghnDNu9XFfJXJwj2KUu8EmAI29ZgOlQ6yLY2lbZh2zte1NDATy8NWj2qm/9as9zSyJqW3Xeoky5F1nHASG7wE9tgkHLcP928gikdTSHwLK2z6M3TbYSftSPvtFfid65qO1iQ74qQ7wrHFzQdLHZWA1Z7w4EIDZYo7UqNuuQTewRivSkHmdzouRQgyPVV79u36ysiLZmzVIou7WzEoOlYMEab4Kl2ZOLzzdzYGdkNrg+PgAc4czDVptghI1DtHXpuc+A46ljyNINoczhONOfe2C65K3LJWZoW5XT1CMVqQLKBnjln5Ng76OXMsAwhiBhIGbrZ6RXLciartP4N1ZAD0oZiCZxImEUjqypINmo+NdrnUk3LaYkzRcaA42HQZuxlKgjH+TOL9DOmRIpjnVSk0B4HzHpL0S1vk9ay6ZaSX1f5plIkDmeEjbV3DacmZAoK66pyZ2RdaWm9mTBeasoUASVQcfRcWVTt5YPS7mESiqSRWKNW/GnM+Ga+DBsHG8bRHQXyxMr6CAe68eZRlf9n7ZJQZMlbFJp8KbM2qlvnQ6lXvBz9K3kf1jevb66TP2r8kejAGTABhnY29y+1x0H5DEvhuH98lvRfJYMzLAABE+ZTR4fN5xs3pCvUJZMq5hTieDJmmBmvb67rOw2zVnMZ0vdJulmZE0iAZdAl1xOitAJEggodOiVNA52OLBllUsnMZ03ev3kNYrlMGlehyDBpPH6JamBuY6LWHl7D8uDanJU7iY0rXYC1eAGJB1uoU15sdwVkiQs5x6YYYbpx25Rls3hObA7sEZgtklCdGOqS9oYVNWWbEG1J9ByMkQLKfSaG/9mBQsvLlCqTfOd6sUPnLPVra0Z0VPtcuUisidHiJtG68jXhNiO2H2wbs2KARqEHM3AzLWorQ7CGtDcf9Or9bW/RDOuyt3WDa8HMq3LzJkUVY8KxXJb5lgjIQtJtZMMVZHotCCW/JCwm8FwwbwfjrTxvjBa/4Jnj62Vj83uLeVbC25b9b519KLyCiTC2ATMBONrSI4sE79UpYbitVC6WKMLDbWEdZP+NhJLDDgHhSjTRgWsEzAB9CAmYBPWquAFaHYoYZb9MbsHMJYeGp1dwEfpKLxD2BIrG9p+E34meBA/j0XVl/wkp1xlgdwl6HFnyNpYF1iwCT0ArobnPqkXSX+IIxngYwSLEXFVSyVds9aEgcURkMg2pEt/+bZUZoSFonM5Vg8/+fzKsW7FYDYT/y39RxLA7eHa9PGUy5EfI9EUsxxGdD+pBucSr4RrSbqnJe3xqHR5fLLDZfDPpcomPf3rAbjy6Rzgwko0xQUYLKqTF76uF607zX3yNKP2S7EbyrYZVw2egqMCIdiJytaxa3i87VWP+PfX+r9vtDseWDtw+4tR+XvUIhJ7cNd5t3HBa3eH92zvaoayNVDUyxS8YpK3xXSxKijv9CGq5rMPt8HcY7Jb/AQzw28E=
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Get a company's holiday pay policy
+
+scope: `holiday_pay_policies:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-uuid-signatories.ParamsDetails.json b/docs/api/get-v-1-companies-company-uuid-signatories.ParamsDetails.json
new file mode 100644
index 000000000..aa8900eed
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-uuid-signatories.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"company_uuid","in":"path","description":"The UUID of the company","required":true,"schema":{"type":"string"}},{"name":"X-Gusto-API-Version","in":"header","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"},"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."}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-uuid-signatories.RequestSchema.json b/docs/api/get-v-1-companies-company-uuid-signatories.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-uuid-signatories.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-uuid-signatories.StatusCodes.json b/docs/api/get-v-1-companies-company-uuid-signatories.StatusCodes.json
new file mode 100644
index 000000000..c0484f79f
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-uuid-signatories.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"type":"array","items":{"description":"The representation of a company's signatory","type":"object","title":"Signatory","x-tags":["Signatories"],"properties":{"uuid":{"type":"string"},"first_name":{"type":["string","null"]},"last_name":{"type":["string","null"]},"title":{"type":["string","null"]},"phone":{"type":["string","null"]},"email":{"type":"string"},"birthday":{"type":["string","null"]},"is_admin":{"type":"boolean","description":"Whether or not the signatory is also the payroll admin of the company."},"has_ssn":{"type":"boolean","description":"Indicates whether the signatory has an SSN in Gusto."},"version":{"type":"string","description":"The current version of the signatory. See the [versioning guide](https://docs.gusto.com/embedded-payroll/docs/idempotency) for information on how to use this field."},"identity_verification_status":{"anyOf":[{"type":"string","enum":["Pass","Fail","Skipped"]},{"type":"null"}],"description":"| | |\n|---|---|\n|__Status__| __Description__ |\n| Pass | Signatory can sign all forms |\n| Fail | Signatory cannot sign forms |\n| Skipped | Signatory cannot sign Form 8655 until the form is manually uploaded as wet-signed |\n| null | Identity verification process has not been completed |"},"home_address":{"type":["object","null"],"properties":{"street_1":{"type":"string"},"street_2":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"zip":{"type":"string"},"country":{"type":"string","default":"USA"}}}},"required":["uuid"],"x-examples":{"typical_signatory":{"uuid":"7b1d0df1-6403-4a06-8768-c1dd7d24d27a","first_name":"Bob","last_name":"Jones","title":"CEO","phone":"4156051234","email":"bob@example.com","birthday":"1980-08-04","is_admin":true,"has_ssn":true,"version":"e1bdd845a493c74908f8e15d6114169b","identity_verification_status":"Skipped","home_address":null},"signatory_with_address":{"uuid":"8c2e1ef2-7514-5b17-9879-d2ee8e35e38b","first_name":"Rachel","last_name":"Greene","title":"Onboarding specialist","phone":"4155551234","email":"rachel@example.com","birthday":null,"is_admin":false,"has_ssn":false,"version":"def456","identity_verification_status":null,"home_address":{"street_1":"525 20th Street","street_2":"Apt. 1","city":"San Francisco","state":"CA","zip":"94107","country":"USA"}}}}}}}},"404":{"description":"Not Found\n\nThe requested resource does not exist. Make sure the provided UUID is valid.\n","content":{"application/json":{"schema":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided ID/UUID is valid.","type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["error_key","category"],"properties":{"error_key":{"type":"string","description":"Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error."},"category":{"type":"string","description":"Specifies the type of error. The category provides error groupings and can be used to build custom error handling in your integration."},"message":{"type":"string","description":"Provides details about the error - generally this message can be surfaced to an end user."}}}}},"x-examples":{"not_found":{"errors":[{"error_key":"request","category":"not_found","message":"The requested resource was not found."}]}},"title":"Not-Found-Error-Object"}}}}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-uuid-signatories.api.mdx b/docs/api/get-v-1-companies-company-uuid-signatories.api.mdx
new file mode 100644
index 000000000..046d4d015
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-uuid-signatories.api.mdx
@@ -0,0 +1,74 @@
+---
+id: get-v-1-companies-company-uuid-signatories
+title: "Get the signatories for a company"
+description: "Returns the signatories for a company. A company has at most one signatory."
+sidebar_label: "Get the signatories for a company"
+hide_title: true
+hide_table_of_contents: true
+api: eJzdWNty2zgS/RUs8pCkStAtki3raby5ladqx64o2d0q2aWBiKaIMQkwAChbK+vftxoEL5IlZ1LztPvgskg2Go3GOacb2FILUWGk29DpfEvf6yznanMZRWDtZeESOp3f7e46VICNjMyd1IpO6RdwhVGWuASIlSvFnTYSLIm1IZxEpZMuuax+koRbwh3JtHVEq2bQpnurbtWrV+QLpNyBIKtCCrC3ipH5rLIhH9egnL17I3Q0rUcy8G/fogMb6Rym5PdWLFMDXPxOO/SRrQrrNJPKwcpwXAFzmxzodE4hW4IQIOhdY2fsA1/RqTMFdKgBm2tlwdLplg77ffy3n4pZ4XMVFynt0EgrB8qhFc/zVEZ+ut4fFk231EYJZBx/lQFQbgzf0A6VDjL73PfXBIiB3IAF5bwrouMmwa9tk0faqXzq5R8QOXyWLsUXs5bNI3N8ZXHpsyZVuPrc6ByMk+VKi0KKVpjWGalWdNehsTTWLRTPoPk8r753qCrSlN7tOjTlf8oshPiSSZ5o9QMTyLhMj4a7lMYlgm9eHi/tgotMqpaLpdYpcEUPgf+vBFwChmhDlHZ7+N8QaQlPrfZvc74xOk2Jd4y7hi8rYmBoCbcLa//MnFdKIJDAkocw+/60nluKzGa/EanIZwSxn2ENxkqtnifmcAKEWVQYA8qRMKiKuOEpmQH4V/NgItWqZOvdm8S53E57PaEj2/Us6kY661XsYiEZ/ntPCshy7UBFm7deMKSKtckCvBVJ9ANxmhQWp5OWxBJS4RckBSgn3WaxBiPjQK6FddwVHrVcba5jL2OH6wVVZLj3N9xa2qGfEC8dOruXeY7k33XqIR4UzwXviRDi/27VE2PM/92qp8Vi5mdfLJ7IYvGhGbJYeFOCE5In0khZxJVPKuFpiqvPbGmIIR0aIsK8bcsuxHzS9JM2GZmcjcekUE6mfsdwOIIz46rgabohRZ5qLkAQbskDOIYj0SdOgAkgT+Qq5Jq0c01yo1HsPORwyiWA8qhOAcX7yQNbZ7DgQhiwts27WpdK3h1KjnUGwC0GR3kcPg6Pfox88To6ijs4+uU/Mj/uShfKmSPeEA8xL1JHp/Tb7JLudrsdVofvhTQgcHleMn0ZgUeOCakWLyOeLhqdrtWVni8Hoi/iATsb9d+xEe+fscn52YRFAyHOxXAkhuec7ksu/bte0j11pb9qBbal9u8/XtNaNeloMD7rjwfDdyNa6yRd6uUvIUjkKW3rJB1cTPqsP2F9HNEoY1kOa9EqH2uFoTBYCjEZjfno4l10PrroT+IJDMbibDAYDc4uMOiX2VuT8RBAiBbcyyqBiwfpkja+QjYn0RAGEA/Z+XgwYuPl4JxdTM4vmBgCTODdGN5NlofZ/MKjBNKDhH42AApaGb1WS82NQL2zOUSSp9K6/RyPx4c5Nt71yTTjqtrpjXlq2/kNz02CBcSj8dkP01j6PaRgwy06Ho7JsO8SMvPvaJtb9DJ3XTKgFaXojCvyyXAVSRtpWhOKvr+kgUP0YjTon9MWc2p6lBQZ9UfP+5rftCOfdKEE9m5lk/O9AIsSYsDqwkRAhIZSY+BRWtcl/+D3QGxhyiKUG72WqGDfvl19QG1b81SK7q36mSbsRFDkVhHyV+O6+tDbD+1Ig9aWDzBGmyOdWHj/Qsv4Q6+Le8AB2EKsUIGOz+GtftgqzJAAsSx7kbBmP5zoKCqM7ZKvpeKlm7J638OGlJD1o9CeO2fksnDQy7nhGTgwxIT23+nGpa/5ddQ/ERp6QFtsYkpPxLc4wVW1STZEvjK6yKVaYRclfIFeArYfPpplIVNBIuxpsmCfcCVSVAOpyEYX2MDUJwsfcwbW8tWRynMY8k0ViADHZWoJX+rCtZLKyAoUmCadwXUVpS1MzKMyUq4IKIGBY+ZK9u0XI6XdIkaEt4E139t/GhDfxsu0NbC1OHqCIA+hN/ADunR3t2safSQZ8yRjH3FSdl2iNoSLoPRpvEJFX4Fj6wErm2YJNvzaLFDxWeuoh1pcIalcUZDy9gCkDOY85y452gF7uu436ntsKkvesyNc1TxgDxmm/TfzTTi7vLli/wwKHmZPgAsw9LSfplcd9odj1j9jgzG9a7cfrfe7w3V8wBRkUgUSCO6ALTlC+fLmqu7tubU6kp5vWExLEKMB8rZLrmKi8IwubS1nndKmJaevLZlnUsmsyNq+f/IswHPJmuPEq+CQtV6/xTCQjF3flZ84vT4ymwO/B243DDeB6TUYIwUmNlRreHSg0GOJkBLtJ+8GOnTN0+LgjgC3eH9ceVdQGyNE2kangqoHlMHhwjJwiQ6o93jGqxfaWw96Nf572zaed719Blgw6wr+hcEWpNoJnstyI5iATIdW5BA3mab7aSz9Md9b4TiKCzvh+KjPG6PFCz5z/Iwrr+6fZsiIUqiO3ELVPMHJK/74UzNw4xm1P3twwVJYQ0p44RKsQSV2kTezjXWQ/ZUZSg8nJsDTqoq19xqkz2sCcoW2+7oWmzsUyWuv4xmYtYyglemGR75C9LxhT+DUqJnMPzMd+wzj0Gf3FpBGOgOsEz6O15Z8DLgmN+GqAmksdFRk1WXT30IzxSPfTAV1+1DNWt7ZeUY1fW8d0y8NMjAbubYu46rl5zO4l+8PDxexbTq7/6kLyAArB4+ul6dcevx5Jm0Dz+d07bvuium0Q6cHtcvuC16ircNx2y3K+zeT7nb4+nsBWLDnd6gwRvIlIm++pUJa/C3qg8XJxL75EgreW3K6KB5dUdWfeotK32gniOHecnZ46xZK4c+F939d4E4ktkzg8aaiznNTdlDTctf69uwQtFdvPn/8SjuU70tgLXnhR+tObX9/t9vS4qu+B7Xb1dvt8Nn3frv/AsWMfSU=
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Returns the signatories for a company. A company has at most one signatory.
+
+## Related guides
+- [Signatory Events](doc:signatory-events)
+
+scope: `signatories:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-uuid-tax-requirements-state.ParamsDetails.json b/docs/api/get-v-1-companies-company-uuid-tax-requirements-state.ParamsDetails.json
new file mode 100644
index 000000000..1feea2d46
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-uuid-tax-requirements-state.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"company_uuid","in":"path","required":true,"schema":{"type":"string"},"description":"The UUID of the company"},{"schema":{"type":"string"},"name":"state","in":"path","required":true,"description":"2-letter US state abbreviation"},{"schema":{"type":"boolean"},"in":"query","name":"scheduling","description":"When true, return \"new\" requirement sets with valid `effective_from` dates that are available to save new effective dated values."},{"name":"X-Gusto-API-Version","in":"header","required":false,"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.","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"}}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-uuid-tax-requirements-state.RequestSchema.json b/docs/api/get-v-1-companies-company-uuid-tax-requirements-state.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-uuid-tax-requirements-state.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-uuid-tax-requirements-state.StatusCodes.json b/docs/api/get-v-1-companies-company-uuid-tax-requirements-state.StatusCodes.json
new file mode 100644
index 000000000..29e02a623
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-uuid-tax-requirements-state.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"title":"Tax-Requirements-State","type":"object","x-examples":{"tax-requirements-state-ga-example":{"company_uuid":"6c14eac3-0da2-474d-bda1-786b3602d381","state":"GA","requirement_sets":[{"state":"GA","key":"registrations","label":"Registrations","effective_from":null,"requirements":[{"key":"71653ec0-00b5-4c66-a58b-22ecf21704c5","applicable_if":[],"label":"Withholding Number","description":"If you have run payroll in the past in GA, find your withholding number on notices received from the Georgia Department of Revenue, or call the agency at (877) 423-6711. If you don’t have a number yet, you should register the business online. The last two characters of your ID must be upper case letters.","value":"1233214-AB","metadata":{"type":"account_number","mask":"#######-^^","prefix":null}},{"key":"6c0911ab-5860-412e-bdef-6437cd881df5","applicable_if":[],"label":"DOL Account Number","description":"If you have run payroll in the past in GA, find your DOL account number on notices received from the Georgia Department of Labor, or call the agency at (404) 232-3300. If you don’t have an account number yet, please follow the instructions here to register your business with the Georgia Dept. of Labor.","value":"474747-88","metadata":{"type":"account_number","mask":"######-##","prefix":null}}]},{"state":"GA","key":"taxrates","label":"Tax Rates","effective_from":"2022-01-01","requirements":[{"key":"suireimbursable","applicable_if":[],"label":"SUI Reimburser","description":"Instead of paying state unemployment insurance (SUI) taxes quarterly, some businesses (like non-profits or government organizations) may be allowed to reimburse the state if one of their employees collects unemployment benefits.","value":false,"metadata":{"type":"radio","options":[{"label":"No, we cannot reimburse the state—we have to pay SUI taxes quarterly","short_label":"Not Reimbursable","value":false},{"label":"Yes, we can reimburse the state if an employee collects SUI benefits—we don’t have to pay SUI taxes quarterly","short_label":"Reimbursable","value":true}]}},{"key":"e0ac2284-8d30-4100-ae23-f85f9574868b","applicable_if":[{"key":"suireimbursable","value":false}],"label":"Total Tax Rate","description":"Haven't received your assigned rate yet? Find the new employer rate and enter it here.","value":"0.05","metadata":{"type":"tax_rate","validation":{"type":"min_max","min":"0.0004","max":"0.081"}}}]},{"state":"GA","key":"depositschedules","label":"Deposit Schedules","effective_from":"2022-01-01","requirements":[{"key":"6ddfcbeb-94d3-4003-bfc2-8c6e1ca9f70c","applicable_if":[],"label":"Deposit Schedule","description":"Georgia rejects payments made on the wrong schedule. GA employers receive their schedule on a registration verification letter after registering with the Georgia Dept. of Revenue. If you are unsure, call the agency at (877) 423-6711. If you did not register your business yet, please register the business with the Georgia Dept. of Revenue.","value":"Monthly","metadata":{"type":"select","options":[{"label":"Semiweekly","value":"Semi-weekly"},{"label":"Monthly","value":"Monthly"},{"label":"Quarterly","value":"Quarterly"}]}}]},{"state":"GA","key":"depositschedules","label":"Deposit Schedules","effective_from":"2022-07-01","requirements":[{"key":"6ddfcbeb-94d3-4003-bfc2-8c6e1ca9f70c","applicable_if":[],"label":"Deposit Schedule","description":"Georgia rejects payments made on the wrong schedule. GA employers receive their schedule on a registration verification letter after registering with the Georgia Dept. of Revenue. If you are unsure, call the agency at (877) 423-6711. If you did not register your business yet, please register the business with the Georgia Dept. of Revenue.","value":"Monthly","metadata":{"type":"select","options":[{"label":"Semiweekly","value":"Semi-weekly"},{"label":"Monthly","value":"Monthly"},{"label":"Quarterly","value":"Quarterly"}]}}]}]}},"description":"","properties":{"company_uuid":{"type":"string"},"state":{"title":"State","type":"string","description":"One of the two-letter state abbreviations for the fifty United States and the District of Columbia (DC)"},"requirement_sets":{"type":"array","items":{"type":"object","x-examples":{"tax-requirements-set-ga-registrations-example":{"state":"GA","key":"registrations","label":"Registrations","effective_from":null,"requirements":[{"key":"71653ec0-00b5-4c66-a58b-22ecf21704c5","applicable_if":[],"label":"Withholding Number","description":"If you have run payroll in the past in GA, find your withholding number on notices received from the Georgia Department of Revenue, or call the agency at (877) 423-6711. If you don’t have a number yet, you should register the business online. The last two characters of your ID must be upper case letters.","value":"1233214-AB","metadata":{"type":"account_number","mask":"#######-^^","prefix":null}},{"key":"6c0911ab-5860-412e-bdef-6437cd881df5","applicable_if":[],"label":"DOL Account Number","description":"If you have run payroll in the past in GA, find your DOL account number on notices received from the Georgia Department of Labor, or call the agency at (404) 232-3300. If you don’t have an account number yet, please follow the instructions here to register your business with the Georgia Dept. of Labor.","value":"474747-88","metadata":{"type":"account_number","mask":"######-##","prefix":null}}]}},"description":"","properties":{"state":{"title":"State","type":"string","description":"One of the two-letter state abbreviations for the fifty United States and the District of Columbia (DC)"},"key":{"title":"Tax-Requirement-Set-Key","type":"string","description":"An identifier for a set of requirements. A list of requirement sets can contain multiple sets with the same `key` and different `effective_from` values."},"label":{"type":"string","description":"Customer facing label for the requirement set, e.g. \"Registrations\""},"effective_from":{"title":"Tax-Requirement-Effective-From","type":["string","null"],"description":"An ISO 8601 formatted date representing the date values became effective. Some requirement sets are effective dated, while others are not. Multiple requirement sets for the same state/key can/will exist with unique effective dates. If a requirement set is has an `effective_from` value, all requirement sets with the same key will also have an `effective_from` value."},"requirements":{"type":"array","items":{"type":"object","x-examples":{"ga-withholding-requirement-example":{"key":"71653ec0-00b5-4c66-a58b-22ecf21704c5","applicable_if":[],"label":"Withholding Number","description":"If you have run payroll in the past in GA, find your withholding number on notices received from the Georgia Department of Revenue, or call the agency at (877) 423-6711. If you don’t have a number yet, you should register the business online. The last two characters of your ID must be upper case letters.","value":"1233214-AB","metadata":{"type":"account_number","mask":"#######-^^","prefix":null}}},"properties":{"key":{"title":"Tax-Requirement-Key","type":"string","description":"An identifier for an individual requirement. Uniqueness is guaranteed within a requirement set."},"applicable_if":{"type":"array","description":"An array of references to other requirements within the requirement set. This requirement is only applicable if all referenced requirements have values matching the corresponding `value`. The primary use-case is dynamically hiding and showing requirements as values change. E.g. Show Requirement-B when Requirement-A has been answered with `false`. To be explicit, an empty array means the requirement is applicable.","items":{"type":"object","properties":{"key":{"title":"Tax-Requirement-Key","type":"string","description":"An identifier for an individual requirement. Uniqueness is guaranteed within a requirement set."},"value":{"description":"The required value of the requirement identified by `key`","oneOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}]}}}},"label":{"type":"string","description":"A customer facing description of the requirement"},"description":{"type":["string","null"],"description":"A more detailed customer facing description of the requirement"},"value":{"oneOf":[{"type":"boolean"},{"type":"string"},{"type":"number"},{"type":"null"}],"description":"The \"answer\""},"metadata":{"type":"object","x-examples":{"select-example":{"type":"select","options":[{"label":"Semiweekly","value":"Semi-weekly"},{"label":"Monthly","value":"Monthly"},{"label":"Quarterly","value":"Quarterly"}]},"tax_rate-example":{"metadata":{"type":"tax_rate","validation":{"type":"min_max","min":"0.0004","max":"0.081"}}},"radio-example":{"metadata":{"type":"radio","options":[{"label":"No, we cannot reimburse the state—we have to pay SUI taxes quarterly","short_label":"Not Reimbursable","value":false},{"label":"Yes, we can reimburse the state if an employee collects SUI benefits—we don’t have to pay SUI taxes quarterly","short_label":"Reimbursable","value":true}]}},"account_number-example":{"metadata":{"type":"account_number","mask":"######-##","prefix":null}}},"properties":{"type":{"type":"string","enum":["text","currency","radio","select","percent","account_number","tax_rate","workers_compensation_rate"],"description":"Describes the type of requirement - each type may have additional metadata properties to describe possible values, formats, etc.\n\n- `text`: free-text input, no additional requirements\n- `currency`: a value representing a dollar amount, e.g. `374.55` representing `$374.55`\n- `radio`: choose one of options provided, see `options`\n- `select`: choose one of options provided, see `options`\n- `percent`: A decimal value representing a percentage, e.g. `0.034` representing `3.4%`\n- `account_number`: An account number for a tax agency, more information provided by `mask` and `prefix`\n- `tax_rate`: A decimal value representing a tax rate, e.g. `0.034` representing a tax rate of `3.4%`, see `validation` for additional validation guidance\n- `workers_compensation_rate`: A decimal value representing a percentage, see `risk_class_code`, `risk_class_description`, and `rate_type`\n","readOnly":true},"options":{"type":"array","description":"[for `select` or `radio`] An array of objects describing the possible values.","items":{"type":"object","properties":{"label":{"type":"string","description":"A customer facing label for the answer"},"value":{"oneOf":[{"type":"string"},{"type":"boolean"}],"description":"The actual value to be submitted"},"short_label":{"type":["string","null"],"description":"A less verbose label that may sometimes be available"}},"required":["label","value"]}},"risk_class_code":{"type":"string","description":"[for `workers_compensation_rate`] The industry risk class code for the rate being requested"},"risk_class_description":{"type":"string","description":"[for `workers_compensation_rate`] A description of the industry risk class for the rate being requested"},"rate_type":{"type":"string","description":"[for `workers_compensation_rate`] The type of rate being collected. Either:\n - `percent`: A percentage formatted as a decimal, e.g. `0.01` for 1%\n - `currency_per_hour`: A dollar amount per hour, e.g. `3.24` for $3.24/hr\n","enum":["percent","currency_per_hour"]},"mask":{"type":["string","null"],"description":"[for `account_number`] A pattern describing the format of the account number\n\nThe mask is a sequence of characters representing the requirements of the actual account number. Each character in the mask represents a single character in the account number as follows:\n- `#`: a digit (`\\d`)\n- `@`: a upper or lower case letter (`[a-zA-Z]`)\n- `^`: an uppercase letter (`[A-Z]`)\n- `%`: a digit or uppercase letter (`[0-9A-Z]`)\n- any other character represents the literal character\n\nExamples:\n- mask: `WHT-######` represents `WHT-` followed by 5 digits, e.g. `WHT-33421`\n- mask: `%####-^^` supports values of `75544-AB` and `Z7654-HK`\n"},"prefix":{"type":["string","null"],"description":"[for `account_number`] A value that precedes the value to be collected - useful for display, but should not be submitted as part of the value. E.g. some tax agencies use an account number that is a company's federal ein plus two digits. In that case the mask would be `##` and the prefix `XXXXX1234`."},"validation":{"type":"object","description":"[for `tax_rate`] Describes the validation required for the tax rate","properties":{"type":{"type":"string","description":"Describes the type of tax_rate validation rule","enum":["one_of","min_max"]},"min":{"type":"string","description":"[for `min_max`] The inclusive lower bound of the tax rate"},"max":{"type":"string","description":"[for `min_max`] The inclusive upper bound of the tax rate"},"rates":{"type":"array","description":"[for `one_of`] The possible, unformatted tax rates for selection.\n- e.g. [\"0.0\", \"0.001\"] representing 0% and 0.1%\n","items":{"type":"string"}}},"required":["type"]}},"required":["type"],"description":"","title":"Tax-Requirement-Metadata"}},"title":"Tax-Requirement"}}},"title":"Tax-Requirement-Set"}}}}}}},"404":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided UUID is valid.\n"}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-uuid-tax-requirements-state.api.mdx b/docs/api/get-v-1-companies-company-uuid-tax-requirements-state.api.mdx
new file mode 100644
index 000000000..f7600be56
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-uuid-tax-requirements-state.api.mdx
@@ -0,0 +1,111 @@
+---
+id: get-v-1-companies-company-uuid-tax-requirements-state
+title: "Get State Tax Requirements"
+description: "Get all tax requirements for a given state."
+sidebar_label: "Get State Tax Requirements"
+hide_title: true
+hide_table_of_contents: true
+api: eJztXHtzI7eR/yp9o7i0W8XhW49lJb4o3vVa5TjrWLvnXCRFBGeaJKwZYAxgKDEqVuVD3D/39fJJrhrAPEmu9uFU+VKSq7wSXt1o9OOHBjAPwX24yLWRIRcGF4oZLkVo1hkGk8sA0xnGMcbBdSeIUUeKZ1QfTILXaIAlCRh2Dwp/zrnCFIXRMJcKGCz4CgVowwx2r8SVODg4gO/QsJgZBq/uWZolqKliOp3+pKUAjQlG5ko8XAmAq4AYuAomcBX4iqDjKqRlQFPdJZUAPMBVkLAZJq79Bab8DvE2WV8FHYAVS3IsysOiAjadnZ2/k8Is2z3Lwn29/pwzZVC1+9WKfc/rK7GxU67mrVjM5Y5pu/IPnvWfZAfuECImhDSgkKezXGmsMzRnicYO6KVU5sZ2dR0N/OCbs1mC+2f536gLGrsJGJVvj79z7B1yYFEkc2FuRJ7OUO0QSKtBIZmU6VvX4MD+hAcHh74qUzjn91Qp8iTZJmnY/Y1iBncQK6sKMiuW8NjaBjV4cAKq90i5uEnZve8ArsRV9bv9fn9cr2H3Zc3p4Cqg8k3F35XQkcxwAtNIphkT6xvLTs3IJgpZPL0SQSfImGIpGlQ6mFw+BIKlGEyComOe8zjoBJwsNmNmGXQCP04cTOx6BTpaYsqCyUPgjD7QRnGxCDZti3+7RHj37vwlyDmYJYKnEWw6D+8bxHNkXcEjrDTpDcMEjUEF7y6cIwE2mylccbsMu8nOpEyQUaUj9HOOah1UTERLjPOEOGtT+3GJwmuwQpMrAVeBwLuroO7dQKPRcMfNEqxCwBTnc4wMX+HNXMl0CjEzqMEsmQGmENiK8YRUH4wEzVYIAu+g7GSbx85+dNdOyXP6l/C1dcpn35+H/4VKE5N+TktkMaqG+Jxpt2b0krQi5cLy40iFM6YxhrPvz2HlBgWmtYy4ZcPOay1zZRtELEm6cD4HIQUC15ApueIxxh3XhmVZwiO7FocaLlMueJqn9bGvny2NyfSk14tlpLs2ynQjmfaKqBJmbK1kktj6Hst46HtysTjwA4a14ufERq4x7gb79bYToMhTCl7D/vAo7B+HgyMXvuYsTwwpVlW+2Vx3AsMWZDzBW3YPP9SsjHop1JkUGjURGvb79E9TzG++DTpBJIVBYai2JpceuRkqq/HKTULMvmX3YZ1WeOHtw09Gzn7CyASd4D5EHy1td3Yf1h1BaA0jXLCiFTVqGP8kOI4GY2TRKOzHbBiOT8ZxOIvZIDw5PZ6NjvvDeHQ6IHlaBibB67NKtYjGDem89S2NFre4DiaBwgXXxoEGHXRcuAgmwQ+t8qaZBBNyyA0qjoIb9GRwfDTCqB/2+7OjcBwdH4fs6HQWDocYzYeDk/44Ogo6haBnCd7weTC5vK7I/8jNcimTmIsF/MnGiy17P5+TGsOSbFLlArwqAhfWWjKmDf3++qwDcy5ip/N3tXFdHAIpQEjDI9SgMEK+whhojnaU1yjVgjN4iRlTxnoQOYcfcIWCHI1U1spsU7ZAEa2BGXh2enLyHMbDUXh8MhhYEyROYyn++Y//NY5jVpBfo7H2SGE3T2L4LQPD1ALN7w5vZgkTt4dk+CycrTOmNSwVzn93WJjlwkTdWKrugnUXctW76R0MDr90S4rKcjXLNTkQDVIkXOBve+zLLlAgSEg+5k5CtGSKRRR/aGpWSucvIc21gRlCnmVIk9QIzplrMl3r74JJMBiORsPBODz7Q9AJUo8OaxbdDPnUhunbYOIj/UH4t79RALRR3qnUhjyoU6LjqP9iMGCz8Oj0uB+OB0MMZzHOw+Px6CSKT08H8fwRJXr55o9w5jj4RZWIxvUz+wwl+iObSbVXhcb98XMYjobhaNTv71Eh0ebC6lKWIK3WR+mRzrNMKlPz8MuohyLMdY8pw6MEdW846A9GL/qj04NCwWKZHH45l0ki7yz7XGij8si6DFiistpGcbPUSCu+UiVtuGoJyHRL2dQVbXxC/4Wnp5+iZ+HBwZaaXVv0se0PDbsn2Fh3hTaq+LK2G6RQNAz7g7A/CPa6Q02FFYh+v9JevDsv4fwuhRXaIItJSBlbkxtzyCoXmGaJXFvt4kLniokI4dnFu/PnhJNRw8/FbqYDWqaVa0ANzxJ+i4QTwkzJOTea1HIhV6iEU1e1YIL/3UWD55CyNfkGRiuPsVthz7FdT8cSnwMBDwc2uQLHIKKGSCa0JdRNrmcokGjX1t3Doh0rbndXQafYV1lpFyLcs5WqWPvnP/7nDp0RGUlyBJJ6S0oUUaudkB22udFqsUkKVTTdudNqioaJUiCVPIiNQgyOyYbFfwSzuxkleLy5rjlZ7LNoODwdh6fxiJxsvx8yHI7C+enR/MXRyfj0+HS2Q1/3a3ZDIjW1fisNS6AwpS21/oatUByaynk6hKo1XwiMgUySvNt/fq5b896sN+gfHw+Hw9HxoE8/PQvewro6hqURhdaIQsPuD7/8moIAraPdBbj1U5Y96+uYiAEFeTpurAes+7B+t3+0230Vm1XX2G9Ta/V+a0qd7QbC7Uetm7t3f54Ogs1+pxZjJjU3fvPUcG4vXRVc1Oo+yckdx/E8muEsfDGOR+G43x+Fs3k0DE+jYxxE7MX8pB89Eq5brGwpSREmFP5krSVja5exSlmMFIJpYe6UJKfox+jC67NyncrY7B1S0Yi6MqgjYdoA8bnfBHjgA2xO/y9iGbne/QHMI8QycNNWMieFws7HIEYeg3NhO+PnJ4f7bdg43AcbH52iRZQ1Lfe5tt2K7lKBe9x2lferDVdL+gV1D1uRaROut/pzzT8W7aoy8oT/WpM5eTKZJ5P59zMZQhAtRbMAW2aoDHeJjmYOY0da0RtdlVFpJVDKbFArW1NCStq9FhnG7fSiO8egZnM+N2t4JzilyCwRbQM11b0k/eWR3ZB9JZM8nXEGz15+9Zw43M6hVBsOpRhJiBtM6+UfnPVBQzmfRvalngF6ytQ8ZWqeMjVPmZqnTM0HBZtffyyxlrL39CC8QBN+i+tHOT4TwGMUhs85Kn9Sr9GSrHv4LpxBwnW73J1+UVKCjjsYF5DmieFZgrVzMZulYCnC9BbXUzu7mM/nqGiAreOy6uSrMObt45zmFL4izU2JexaRc7fdSgG3uO0Adhddewpdi3JXAdFrB7r90n1VtAy/ppaFkC8rFknVtq9InAk4v3gDp8f9ATGYMkPLTudwoDBTqGklxKI8nfPSgBlGJMCSwS5cUMJtayUI4raOEjtwt+SEr82S/Dy1ENJ04btiobYGKSRn18zqbu8W17TKvTueJID3pAh2aXPBf87bJLX1Waw9MJ3ULRlp955F79jbI7vPVkt+iBPLBUu0LJ3h7gG7Lcz1GXhrwcIafqhDrzrIeoJATxDo8yDQph2IHnHzn+jiBXAR8xWPc9awuC5Fop9ztDLjGhY5U0wY9FcBuNg2a2tkLV3esrIthmyFCyY2EJD+GemcVPPymKe7w5XTSnLdKOV2pddQ8WMz49ateDpxc3irjt7LpsxEy8L9RlK5k35rLVPbZOqUJ1M8ZWpN9w5CqxtcQ7wWLOVkDmtYctuHAp1eyjv6vUGT6YJitGRigV14RTHpYinv6rcNwj/AHV1BqRedWRc6QxTAhL5DVVzSmNoEOTEoSXHxngTATccfC5i1F3mKTOgtaXJdE1n3fW7x/6N2enttX9N4WwnBX7gpsFtDNAVzMczWDsJQ7kTgG3dusXXNaDszUZZ4R9AoSRKbA9l8ON45g6iFeGr1O6awdW/r4YPhCqRSIcRoGE8w/gS6peh/YYHtuol2FTiTcGBuhz/eE9tdQqwex3+tmbJOebBT5/ZfeP7Tcceij1B7Ojr9rKPTFk54RNgfv9/dwhRupP235Azek9ZHuaKISfMpVri0iAxVRCbeZj7o1HXvTqpbVPqGUrcotNVCV7dlwC/tXzN/M5E4a281Q0AWLV0V3RdwQDKOOY3AEihkBdVkaZFiPzBkUmtOiMDF3o7fgOkOoInsjfQQpjT16QTmCjGk34GLLDcdELJOqh7NbbdCVNMJMB9KGvs5BrFMEqaApSQsvwmdjk7G3aOjabPt9De+2I5sJT+dQLSUUmNx/8FbWu0CpkaEqS92Pd1afVJXv7rTCZxBjBFPWbJ7Vr4hW2AxpX63Pxq3ZzTqjr9wIze1hQhsZbJcDoIeEbg9RccFIS7celGsKXi3EZn032UVpk7vHaVCDR+fhH2vwMx7p1C1Ihm6CXnJVQ526niv9KSqgkXOYzr7t7zttYuPk7glr7i+vYkSpmm4GKedRlHNyKYdJySic0NW5G6L073xNyJZe4dU8+KPoPhLmmyhZbQX9Lp6DXV872KuLsywQNctY/wIyPnJIKmZFnJQ4f0QZRuPlKBlJwBhkcnLdTMWh+t8lnJK8tgDqnpU+AgQlhDeXaGakRm7adjr5OQF6eKV4anNEVV3y4PNpn4Z/NJLrZisjTotxXlcpG7B9+vutd0ccRHn2qg10Phgxwcav0rIkRHNsNgVofbS2a21vwRbZ7uA6i4+H2WxMJ1fSlhlnKsIevyBcRdecdoOT+gtSMspV16glkak3FrhPGq+bODc0uALP04Rq24yVDdLmSvndOrxicYHqioDVXc4dsP8hn7tLZX1HQVgqNDA1uABoVYHUT5Y453sWqGCljGjiSrRdiZOBMXCNsMJxXWSNLFgt7mgaUXpKqOc17M/W/nXxpa9HNtaeJNEF14RMCnHKnJwlmQ5rCXNxSLB7ZatCMhIE+loRU9suDiwsCLmC27g2fTqKp4+t+W/t+UuRyUV0N3JRrIKnk0vWfj3s/Cv177H36iHcF1aDWutvqjRk2pn6374ourAxNpnbqqZ1eZNM0y4QcWSqgGtS/Hoz86SpDWB6Y/fvA0dlJ3Wx7DlUy8WF/iPHIe60FFqMRqNh4NpbbgvfKJtCv6cq0y9UBg/OToaU/rOw4e/nhwfjcNvvqXAuKlQ9OfrrY8I5LMzyrLGHubWI0Vp9xBSYmmeu1gVc50lbN2BWW6KJCntpOqxhRSGErSFlrrkt0sq2Yu5JZgiTJzrXeeHljlrH/6exaGGOcZ20ZALyJJc24SpE3oXzoXrYxWjVPc7y+AMYUoLWBxkOUnC9C/0MxiOxtMiL7O9NS3D/i7ZlqDuGpobhhrSKlM6hTcvkNsWlPgwT757Z1Jw0qDsLkwVXlEKvJFzt8e2u23rCvkHhzTfrYyrUZJrOmNxdj6TuYjLw8Ziihu/hf88Cs6l7KXg7rN/GD50QvAUCtTXgVxUcasY2sVfByi5FF0yY2val/ZZJL0rdS8nB1fBddNf97+wutbvUpTbgSULJNeGRbb6enfpjjPifXnO4hmzhV17Gjni7zmupQYuDzjuj7ezlZTx+NquiH1+KorspQUnoFDLXEWUo0BtHYQ9pevCd+yWPIVCb4h+42RfbXLttLdL/s4if3Tnoef0SGyBJlwNQucOOOqwfgErbL8/DYvXnPehzpDdItPrcKFknrl0VOMVXbMVvW8M6WmA4gRDiTBZ0b1Boct8kjta2/swvYTx9Qfq1YWSbaaqDFubud29mkxWvYlZ2g2kaJYyLrm3z1knQW816JUC7D3UJbjptUXYe7Ay3Ng8i1oV73dzRTmk4syLZdxd1QhjTO19jR0OK5UtEbvxQvv4j/rZSe4ZeOeY3ysZv2fMjKpJDBqjXHGztpx/5aZ7FkWo9VlOErm8rreiW6apcyU72pbWSywWzzvtLgyZ2nEk6ocIE1xhAiw3S/IOUfE2OLhYa4Pp51BwI+whYB8Yz2X9PMQ+2KX3r6Qw/slu47FpJ6AHufrN/ALVikdYW4/aE4OZzE3PNuzFRJrsNLR/h3Ju14G6bj1fxiSywV+C5eNQwytvGvC9Py2mp7mxjHLSPzuN//AvV1lkX676p8cvC6rwAybVvcCU8cQqlK/9faU/NukotUmZqI1DX4iwd1xg62Ht1hFF+X726bsST9+VePquxK/guxLF2RLem16WMG6dqg0iDz7eXQargXUgPuIFnWDS+u5Ee3xq4qDDdSdYSm1olIcH+irBO5VsNlTsPtlAESXmdnX3fN+g7jR+DR9v2CMy/9Kt/uGJAk3YGLpiitsk3sfN+Jn3p/Fz2Pddjj0MFTBe1A8ey2vijQUk3PBJLD3y6Y5P4szpjT0X9V/A+DiJ/Zt/DuM9yrf7WyKVFpYQmNBSZmp1W9+yaIDf16/eBpvN/wGQpbJk
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Get all tax requirements for a given state.
+
+### Metadata Examples
+
+```json select
+{
+ "type": "select",
+ "options": [
+ { "label": "Semiweekly", value: "Semi-weekly" },
+ { "label": "Monthly", value: "Monthly" },
+ { "label": "Quarterly", value: "Quarterly" },
+ ]
+}
+```
+```json radio
+{
+ "type": "radio",
+ "options": [
+ { "label": "No, we cannot reimburse", value: false, short_label: "Not Reimbursable" },
+ { "label": "Yes, we can reimburse", value: true, short_label: "Reimbursable" },
+ ]
+}
+```
+```json account_number
+{
+ "type": "account_number",
+ "mask": "######-##',
+ "prefix": null
+}
+```
+```json tax_rate
+{
+ "type": "tax_rate",
+ "validation": {
+ "type": "min_max",
+ "min": "0.0004",
+ "max": "0.081"
+ }
+}
+```
+
+scope: `company_tax_requirements:read`
+
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-uuid-tax-requirements.ParamsDetails.json b/docs/api/get-v-1-companies-company-uuid-tax-requirements.ParamsDetails.json
new file mode 100644
index 000000000..9ff053362
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-uuid-tax-requirements.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"company_uuid","in":"path","required":true,"schema":{"type":"string"},"description":"The UUID of the company"},{"name":"X-Gusto-API-Version","in":"header","required":false,"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.","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"}}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-uuid-tax-requirements.RequestSchema.json b/docs/api/get-v-1-companies-company-uuid-tax-requirements.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-uuid-tax-requirements.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-uuid-tax-requirements.StatusCodes.json b/docs/api/get-v-1-companies-company-uuid-tax-requirements.StatusCodes.json
new file mode 100644
index 000000000..df4fc4016
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-uuid-tax-requirements.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","x-examples":{"example-1":[{"state":"CA","setup_complete":true},{"state":"GA","setup_complete":false}]},"items":{"type":"object","properties":{"state":{"title":"State","type":"string","description":"One of the two-letter state abbreviations for the fifty United States and the District of Columbia (DC)"},"setup_complete":{"type":"boolean","description":"If all requirements for the state have been satisfied such that the company can complete\nonboarding, the company is `setup_complete` in the state. A company must be `setup_complete` in\nall relevant states to complete the `state_setup` company onboarding step."}},"required":["state","setup_complete"]}}}}},"404":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided UUID is valid.\n"}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-uuid-tax-requirements.api.mdx b/docs/api/get-v-1-companies-company-uuid-tax-requirements.api.mdx
new file mode 100644
index 000000000..c2dfcc91a
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-uuid-tax-requirements.api.mdx
@@ -0,0 +1,71 @@
+---
+id: get-v-1-companies-company-uuid-tax-requirements
+title: "Get All Tax Requirement States"
+description: "Returns objects describing the states that have tax requirements for the company"
+sidebar_label: "Get All Tax Requirement States"
+hide_title: true
+hide_table_of_contents: true
+api: eJzdV91v2zYQ/1e420NbQLKTot2DnmYkXRAMW4Ok2QY4RkKLZ5stRarkSbVh6H8vjpJt+WvAsIcB84sd8r75u99d1rBM51Ugl2pLOPeStLMprUqEbAxYTFEpVDBJQGHIvS75HjK4R6q8DcJNP2NOQbS3U23nghYoAknCIGghSSxkjYLkUnj8WmmPBVoKYuZ8lMxdUUq7erJPNuSuxEy8dEfPJJfPfZ3Mo1QvkEApvSyQ0AfIxmuwskDIYKNWVVpBAprDLCUtIIHOioKMfIUJhHyBhYRsDW2mEMhrO4fmMM1PCxSPj7fXws360UKTbN3+ld7E+o3ubtM/0AdW7LwvUCr0e/5n0gQ89HLNuRTaxoqhUJIwncqASozubkXdGhUyBJdrSajEN00LsXKVjwK5NGYgbmfCOotCB1F6V2uFKmllZFkanceXfRXEuNBWF1XRtz15vSAqQzYcKpeHQQTEIHfFcAOAtJQr74yJ90NZ6rTT1Hb+Y2cw7R2/4TCqgGoA56udANqqYJy9vXj7Pr34Kb183yJtJitDkPXPm2aSAMk5Pzl8kktx30MGa3kMpbMBAzt6e3HBX/tl/vgrJJA7S2iJb3t1GX4OLLI+jlV6L1eQwDLFpSxK09rvfqeXEYAR7ZDB1YizRarKZwaKQT5lxDFcNkI3p4QiLJpJk4AmLELPf9tgDHrvSvSk2wA6a2sgTYblHuJBclTigxJY3ECZvrnUIBH6tluFnE491jrWY9efMz2jlXi0mnH30La1tCreXWt2kxObvHKmKqZaitfXV2+4kQ5T3GY0dc6gtEex3c6ENOY0S7QRRiaZIloRJOkw06hEqPJFyzO9/hS5tGLj+sk6O3XSK23nyZ6UDuJlP8wXoe3O4UCMtrJFFUhM8ZTCk23jNlhLS1vuc9sIosWXeP4c1V+2ZnehiUBYDqBp+nQx7h76qJyThj8JvLt4dwz03x2JX1xllXiyQjxZZjG2iYEf0WNwlc9RKIdBWEcClzrQQPwmv6AIlW/j3ZBIy386iFoarQZPNobIWIxIuVWQwRwprS/TNimNIe1zcXrI47GbQonyC8qwSufeVSVkQHJ5f16K2TZ1NXqvFbYuR8YwhywJLXNOOwy+4Aqy80MtgVqa6mC4cXtu9A7j2iocxXdaaz/OnXYXL7NYgbRwXdniNKMFZDCsL4fbAg7X/Qo2wxMlDOjrzQSsvOFx03G4LHVL4anCIvL4Ua9dY+EOCtzaSzUHxnoxvzOGT9q88079jc2Srzn9gHnlNa1i5FdtmqM8xxBGFVdiPOlLPTAht5x3QnZLKhziZtREkkHp4+jdj7EzkRqs0QhZ0QItdTOASethFQiLf+OhtXDGAfO7nbk+b8flgWcxY6VbH/YGXwK8HISPswf0tc6x9x67OS2nrqJhFBwqds39mca/UzeL78Cqh8H+iSZ3BTJXxTheBfGh6wpx1078uCYol1eMu5jGD90UlXmcot0adL3xKu7RtDOEm7OQ2kRAdbc/7/DD1ShdoELanp0bJDEyRhyM+G70HGaw3s3z/3Yl7UBCuKRhaaSOaIrds+4afAz1Zaxc1+KQQHawsh51+SSBhQvEyus1b4SP3jQNH3+t0HMHTZhhvJZTBtN4DUoH/n1m0+yX63VXXfVGnNtyz6S12YyixIbfIOnIcC+nuNJ0a/A/C+9/vhOfLGxbwNP/UGzrvBs7TFMl9e6OFtq9aXPz4RM0zXenO+xq
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Returns objects describing the states that have tax requirements for the company
+
+scope: `company_tax_requirements:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-uuid-time-off-policies.ParamsDetails.json b/docs/api/get-v-1-companies-company-uuid-time-off-policies.ParamsDetails.json
new file mode 100644
index 000000000..e5b4000df
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-uuid-time-off-policies.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"X-Gusto-API-Version","in":"header","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"},"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."},{"name":"company_uuid","in":"path","description":"The UUID of the company","required":true,"schema":{"type":"string"}}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-uuid-time-off-policies.RequestSchema.json b/docs/api/get-v-1-companies-company-uuid-time-off-policies.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-uuid-time-off-policies.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-uuid-time-off-policies.StatusCodes.json b/docs/api/get-v-1-companies-company-uuid-time-off-policies.StatusCodes.json
new file mode 100644
index 000000000..8532d408c
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-uuid-time-off-policies.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"successful","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","x-examples":{"success_status":{"uuid":"3f746cd0-dd08-408f-b712-8180c7c621e9","company_uuid":"de83cff2-8e7a-448e-a28c-14258a9971c3","name":"test policy","policy_type":"vacation","accrual_method":"per_hour_worked","accrual_rate":40,"accrual_rate_unit":40,"paid_out_on_termination":true,"accrual_waiting_period_days":10,"carryover_limit_hours":100,"max_accrual_hours_per_year":100,"max_hours":100,"complete":true,"version":"f5556bce3d75ec2b62bd11990aa7993a","is_active":true,"policy_reset_date":"01-01","employees":[{"uuid":"c61d1895-5cf8-4217-88c8-20d7c3132a04"},{"uuid":"3633ce57-abb7-422f-8c5a-455566618e6a"}]},"success_status_no_employees":{"uuid":"3f746cd0-dd08-408f-b712-8180c7c621e9","company_uuid":"de83cff2-8e7a-448e-a28c-14258a9971c3","name":"test policy","policy_type":"vacation","accrual_method":"per_hour_worked","accrual_rate":40,"accrual_rate_unit":40,"paid_out_on_termination":true,"accrual_waiting_period_days":10,"carryover_limit_hours":100,"max_accrual_hours_per_year":100,"max_hours":100,"complete":true,"version":"f5556bce3d75ec2b62bd11990aa7993a","is_active":true,"policy_reset_date":"01-01","employees":[]},"deactivated_status":{"uuid":"3f746cd0-dd08-408f-b712-8180c7c621e9","company_uuid":"de83cff2-8e7a-448e-a28c-14258a9971c3","name":"test policy","policy_type":"vacation","accrual_method":"per_hour_worked","accrual_rate":40,"accrual_rate_unit":40,"paid_out_on_termination":true,"accrual_waiting_period_days":10,"carryover_limit_hours":100,"max_accrual_hours_per_year":100,"max_hours":100,"complete":true,"version":null,"is_active":false,"policy_reset_date":"01-01","employees":[]}},"description":"Representation of a Time Off Policy","properties":{"uuid":{"type":"string","description":"Unique identifier of a time off policy"},"company_uuid":{"type":"string","description":"Unique identifier for the company owning the time off policy"},"name":{"type":"string","description":"Name of the time off policy"},"policy_type":{"type":"string","description":"Type of the time off policy","enum":["vacation","sick"]},"accrual_method":{"type":"string","description":"Policy time off accrual method"},"accrual_rate":{"type":["string","null"],"format":"float","description":"The rate at which the time off hours will accrue for an employee on the policy. Represented as a float, e.g. \"40.0\"."},"accrual_rate_unit":{"type":["string","null"],"format":"float","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\"."},"paid_out_on_termination":{"type":"boolean","description":"Boolean representing if an employee's accrued time off hours will be paid out on termination"},"accrual_waiting_period_days":{"type":["integer","null"],"description":"Number of days before an employee on the policy will begin accruing time off hours"},"carryover_limit_hours":{"type":["string","null"],"format":"float","description":"The max number of hours an employee can carryover from one year to the next"},"max_accrual_hours_per_year":{"type":["string","null"],"format":"float","description":"The max number of hours an employee can accrue in a year"},"max_hours":{"type":["string","null"],"format":"float","description":"The max number of hours an employee can accrue"},"policy_reset_date":{"type":["string","null"],"description":"The date the policy resets. Format MM-DD"},"complete":{"type":"boolean","description":"boolean representing if a policy has completed configuration"},"version":{"type":["string","null"],"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. The version will be null if the policy is no longer active."},"is_active":{"type":"boolean","description":"boolean representing if a policy is active or not"},"employees":{"type":"array","description":"List of employee UUIDs under a time off policy","items":{"type":"object","properties":{"uuid":{"type":"string"},"balance":{"type":"string","description":"The time off balance for the employee"}}}}},"required":["uuid","company_uuid","name","policy_type","accrual_method","is_active","employees"],"title":"Time-Off-Policy"}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided ID/UUID is valid.","type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["error_key","category"],"properties":{"error_key":{"type":"string","description":"Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error."},"category":{"type":"string","description":"Specifies the type of error. The category provides error groupings and can be used to build custom error handling in your integration."},"message":{"type":"string","description":"Provides details about the error - generally this message can be surfaced to an end user."}}}}},"x-examples":{"not_found":{"errors":[{"error_key":"request","category":"not_found","message":"The requested resource was not found."}]}},"title":"Not-Found-Error-Object"}}}}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-company-uuid-time-off-policies.api.mdx b/docs/api/get-v-1-companies-company-uuid-time-off-policies.api.mdx
new file mode 100644
index 000000000..04cd0dc49
--- /dev/null
+++ b/docs/api/get-v-1-companies-company-uuid-time-off-policies.api.mdx
@@ -0,0 +1,71 @@
+---
+id: get-v-1-companies-company-uuid-time-off-policies
+title: "Get all time off policies for a company"
+description: "Get all time off policies for a company"
+sidebar_label: "Get all time off policies for a company"
+hide_title: true
+hide_table_of_contents: true
+api: eJztWVtvG7sR/iss+5AE2NXNsi3rqWmdExhoYiOXtoBt6FDkrMTjXXJDcmULgv57MSR3tbrFMdIWxcHJS+RdzszHmW8uS66oLsEwJ7W6EnRMZ+DSRT/luiiZkmDjr+WkqqRInSxgorNsUupccgmWJlSA5UaWqIGO6XtwhOU5wZVEZxmpV5JMG8JIVHen7pTluoQx+XVP6dgAE7/ShD6ls8o6nUrlYBZApm5ZAh3fUiimIAQImlBWlu0llt4n1LGZxWVfEMd1lpGbGvF9Qi3wyki3pOPbFf1bQPSWc7D2beXmdHx7v77fWDf2kc3o2JkKEmrAllpZsHS8ooNeD//b9oCtvKasymlCuVYOlMNVrCxzyT3C7m8Wl66o5XMoGP4K26LMGLakCZUOCtt6rqe/AXfeJfDEijIPAKKtiXXMVf4JhomO6Ul2PjzjopcK0Rulw94oS6fn/UE66o96/JyfDfpw4eFtgkvHVMDohGfZIB3BOUuHwxGkbDDiaX84OB2xi4vzPj+hCVWsQEwOrAvhRcThxyTiXbCwU4wO56Zi+aQAN9dopQQzmevKTB61eQgBjEsMc0DHw972k0mlpAuPSybFRFduotXEgSmkClZicGqpRyadVLNJCUZqMRFsaem430soZ8Ys9QLMJJeFdB6Gf9VLaMGeJrUC/xzFJ0tgprWgLYDOywERB+sLMDZQIDs9PT2bcjgR56fAB9OzwVT0+xcXPcbOLy5OGAbYThh3ctFIR/8ZsOAmwjuC9vppr08TCkWZ6yVgzG+bEPOzvuiPLk7TU56N0uGgf56ORnyUDnrinJ/0TwasN6TrZEOJs5MTDqfnKZtOz9PhYJClI37K0iGCPTvrj+CM0fX9Otlh1UTpSQvAHxT73VMMOSDAyzIH4o/q8n8VelXl+VZwM5bbF0V3vdu0P0GJYsr5/RKdEUa2G6ePgcFRwcl2FWgalHVGqtneOPBVyW8VEClAOZlJMEH59nSwpOtdsrxcL44Xbg71gEH0o5Jq5h8dsBZI9pyVj8wLHlOyRcrndH1Zlkd1JRRUVeC40mK2lfyBYiruUvw5SyFgGyNRnkT59W5G1PpuNwqRYzgoZdoUzGG5yTVz+3uaA0EdhDnyOJd8vr07T2fyKPM8YIAwAypS05Fo5SWCGzqk4SEIwixhxJtNCHRmHXJHh71O7452dncQM/jntqGqYhrYGVC3Uc6ZJU4TLChEGzIFgpUiME7XW3MHlFhwRIYt1kFAwB1yrfIlqSwEJbg4X24m5ddNDUM7Cdn6E9sx1hj0cusVgtv5E7bWvnmJe49WwoZ7U61zYGrPl38Nz4mpbWESyqztz1c2+kwcpErtXl05z4+W+fUzRXhDAf85AKbFgZ3MbiKFkmQKmTZwnJo1splUAbsvLVvgfQ073AB+jpkFe/ouOzlTpDFMMqMLohUQbC1IT89LeHKI73tN6L8PMiYKutCjqxH9z7wUALQqd7tXfsf8vjUUadPDK7Id8osHSj58SC8v66YWmviziTM9lji1DaxCtT5BuFaZnFWmSYxmPnjRRnhlDChHonTdoMLnZod8hrDN2/geMc0qKeD+9dy50o67XaG57fgP5Q7XRbf+LE9LtjQ6z/377kb8z0F1mrMlmDe+/EkV4uvtKzLXj8jbyqJpaUkmIRcdgmhrlHWdwH2hj1qRkJYoTXKtZmBImJB8RWvNSz8fCmmjamwHSvvc2vpE2vma31b/d2kdOrrh5tevV5eWVEog5APDwdHDgB+ZyNYJnbKcKf4jM0q7e0epZrCq4dI1/sOTkG+VNCCQad70zgwXh6ztMWlvmmlHpu1EPMKRLkewOImm11mWxkk02h/2hvuHLx+1I7/oSomXnL0cUUHuFCF3yg858K0Ci3lnwOrKcCBCA1LNEXiS1nXIB/YAxFYm1gWjF1KAIFeXXQwvUmbBcik6NNkLY9uTYIw2fvvbwY3PX3BStKd18gAowJmDmTbLIzb8qmeZ8rkEjnO3JY9ziHv24kRzXhnbIV+WpeQsz5chix9guZnWbRiJnDNyWjnolsywAhwYYiDHT866cXmVndBaI+oXQPPDaBy7gyZfRWpVdZBsRD4zuiqlmmHjEL5hTCEMaU6TaSVzQTjWuSKunzMlcl8aFFnqCgtZcwbpMRdgLZv9QN7d1EAEOCZzS9gUp5+NU1MyAwVm486oukZpK5MxHpBi11MCgaPnQq5snxoq7SaZT5IWsW634k8j49t8GbcEW5ujRxLkkYX88AIdPFlab3L6o3apT7L0HRpNrwNrI9yGDwFXPBH4V/ren8e+vblK/xG7XUIlOnAOTPhpb+9AtfF4/YU16A1O095Z2j8NHTFjVY6jRev53vfxJYQpNHIKu386ZciMtzdXTVdi1mouPX0fpZsHTuACTIMOucqIwsFM2qY6JGFNqzq9suS2kEoWVdHW/cJ2y0qZtlpuVJi2Hr9BGMjtjj8ijB7eqd/etSVz84ONwpe1OC9Ewa2qE44tjgVkHU7YbQnsAZhdpj778NxHFnCdZTebC4b2KgSa4qBrpIBwXfE2x4N2eHKgrD/9R8oEEh+9P0joguXV8/cI6JttVeEyoJHHTbYX7e6nWbi3r8NS2/vbSMd9otOak64Z+BkA4zOm3UW/21zadFftSK67h65tLJhFnWCVyTGJIsVYKQPDUgGFp9le/C+h0DuRCfrSeNJX6HD0fFjxQZ03xo8Dx3SW+Hrdurz5jMwKBe3AFU7DNzReFwY/9AEzvlRsW48q0hwWkBNWuTn2Kt6M15+X1kHxMxaChiMGcEJVmfZaY4n0xQ6LAG2f+7bKVEKxKtnr7DOYheTQ8vSmQPhO0vULuwJNY8NP/d+pzryHUXQX7D8h57oA7CcexytL3sVEITeh1Pj6JDSvivrg8E9x6GLcD12xqFzWVsknbO4+sXDSYzL3VIlv/7Jhhm8B2rqCqZaeH7xZ3N3KajMH/mcvJ2P0HTy5bpkz6WniCb+KSXlLF/1mKg5ZN94psfuZeZ/QubYOpVcrbDJfTb5e4+NvFWAXvr3HsmAkmyJNbldUSIu/RXMSfHT/rz/F6vyGHK/gB/dVD51+RV2UaBIr2Nam/BVSbMgvg/e7brNHHBsceHi0afy86RVYgErXerf3ZbPVIt6/+4J9bbteNfUp/sAgHYzvahVWfNEPoNbrJtwO//YD3frfZ1E9Wg==
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Get all time off policies for a company
+
+scope: `time_off_policies:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-payroll-blockers-company-uuid.ParamsDetails.json b/docs/api/get-v-1-companies-payroll-blockers-company-uuid.ParamsDetails.json
new file mode 100644
index 000000000..e5b4000df
--- /dev/null
+++ b/docs/api/get-v-1-companies-payroll-blockers-company-uuid.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"X-Gusto-API-Version","in":"header","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"},"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."},{"name":"company_uuid","in":"path","description":"The UUID of the company","required":true,"schema":{"type":"string"}}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-payroll-blockers-company-uuid.RequestSchema.json b/docs/api/get-v-1-companies-payroll-blockers-company-uuid.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-companies-payroll-blockers-company-uuid.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-payroll-blockers-company-uuid.StatusCodes.json b/docs/api/get-v-1-companies-payroll-blockers-company-uuid.StatusCodes.json
new file mode 100644
index 000000000..c1ac20b6c
--- /dev/null
+++ b/docs/api/get-v-1-companies-payroll-blockers-company-uuid.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","required":["key","message"],"properties":{"key":{"type":"string","description":"A unique identifier for the payroll blocker reason. For a complete list of blockers and their meanings, see the [Payroll Blockers guide](https://docs.gusto.com/embedded-payroll/docs/payroll-blockers).","enum":["company_ownership_required","contractor_only_company","eftps_in_error","geocode_error","geocode_needed","invalid_signatory","missing_addresses","missing_bank_info","missing_bank_verification","missing_employee_setup","missing_federal_tax_setup","missing_forms","missing_industry_selection","missing_pay_schedule","missing_signatory","missing_state_tax_setup","needs_approval","needs_onboarding","pay_schedule_setup_not_complete","pending_information_request","pending_payroll_review","pending_recovery_case","soft_suspended","suspended"],"example":"needs_approval"},"message":{"type":"string","description":"A human-readable message describing the payroll blocker and what action is needed to resolve it.","example":"Company needs to be approved to run payroll."}},"x-examples":{"blockers_list":[{"key":"needs_approval","message":"Company needs to be approved to run payroll."},{"key":"missing_bank_info","message":"Company must have a bank account in order to run payroll."}],"empty_blockers_list":[]},"title":"Payroll-Blocker"}}}}},"404":{"description":"Not Found\n\nThe requested resource does not exist. Make sure the provided UUID is valid.\n","content":{"application/json":{"schema":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided ID/UUID is valid.","type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["error_key","category"],"properties":{"error_key":{"type":"string","description":"Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error."},"category":{"type":"string","description":"Specifies the type of error. The category provides error groupings and can be used to build custom error handling in your integration."},"message":{"type":"string","description":"Provides details about the error - generally this message can be surfaced to an end user."}}}}},"x-examples":{"not_found":{"errors":[{"error_key":"request","category":"not_found","message":"The requested resource was not found."}]}},"title":"Not-Found-Error-Object"}}}}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies-payroll-blockers-company-uuid.api.mdx b/docs/api/get-v-1-companies-payroll-blockers-company-uuid.api.mdx
new file mode 100644
index 000000000..a349500b8
--- /dev/null
+++ b/docs/api/get-v-1-companies-payroll-blockers-company-uuid.api.mdx
@@ -0,0 +1,71 @@
+---
+id: get-v-1-companies-payroll-blockers-company-uuid
+title: "Get all payroll blockers for a company"
+description: "Returns a list of reasons that prevent the company from running payrolls. See the [Payroll Blockers guide](doc:payroll-blockers) for a complete list of reasons. The list is empty if there are no payroll blockers."
+sidebar_label: "Get all payroll blockers for a company"
+hide_title: true
+hide_table_of_contents: true
+api: eJzlWN1z2zYS/1f20IcmM6TkZNp70FN9dZrxw7WeOLm7GcXDQsRSQk0CDBaQrdHwf+8sCErUV66+vl39YhFY7C7247e72ArCMjjtN2I234ofbdNKs7kuSyS6Dn4lZvOH7iETCql0uvXaGjETH9AHZwgk1Jo82AocSrKGwK+kh9bhGo0Hv0Ioe45QOduAC8Zos4RWbpyta5rAPWIkm9/1S/CP2paP6AiWQSt8eKVsOUvk+SLtvYbKOpCRd40ej7WYwMdVWtQE2LR+A7piOQ5BOgRjBxVg4Dn5bD4bKm2LM/h10G/mgvlVZOI5XwbyNtfG49JJtkLuNy2K2Vxgs0ClUImHTHi5JF5LlyFesy32J26VmIkl+nz9Ju+topHy47ulrU0RglYiE610skGPjqKDjGxQzMR/8vdRoeu72/xf6IjdkgnNvlmhVOhEJqhcYSPFbCt6VQV5p81SZAJNaFjNt1dvv8+v/p6/+V5EF1cy1F7MxuvdsetvWJdGG6ToNyU95gtJqOD67hbWvS4giWyppUcFT9qvYGODiwSlrOsJ3FZgrEH2TuvsWitUWU8j27bWZbTXtwTzRhvdhGbM++HVyvuWZtOpsiVNomMmpW2mgyMGk8b9qWx1nk5qs/wmMcxHy69ZjUCoJqLLdhY+ckM0bSv9ShwbhEPt06fbG46/UcCLTDj8ErRDJWbeBbzskI4TbAgxR09yOZxwSK01hMSH3l5d8b9D6fchpmoVapGJ0hqPxjPVyI7T34hJt6fypXOSFdUeGxqt28VvWPqDG8zFIzJpg0RyiRwvrePQ9rrXjrfPhNqhttcQjP4SELRC43Wl0cVUZrsdJWTK5Qn8dD7Vh3wBaRSf1w4alOxjyoD+G6q8KIRO4GcyyqEhTuyTQUcr3RY7o/UOcbL01hXW1JtiHxtY+ZYKbQp0znK2LtGWVuHJt0FU2EfgWtZaFaSXRnrrojc0kTbLQirlkDhO9msLaR4LbSp7vLZGp6sUG6M9bNrabhALQh/a0UaFCp2sCy+fT/esa8ZCtVGBvNsUhDWWRxJauSk4BlWocbR87kLkpccDiWwHKmTLeCHr3YI1Cyud6oNtLKA/WBjriyF2mAKN6vVkzaMJor+Q/Gg3ObxwuNb4NNpwWNo1uk1RSmJ2ZCtfUCDej07a/37IBD5LFixmx8p3+zz6AymzCo00uUOp5KJGSCehJ1twOT2XPpwWT1yMZXQDY1wfSuAtOCRbrxG0j6G80zOV/0hJTLhA6LVO54IZBE1E1zFqpcMRA4YEKThJY7mKqHDqu93tXygxGzieDfITpk0gDyu5RpDAlCDL0gbjQRuwTqE7lcBu436hOL7LQ5cJr300U0KVPKGK6PgvE99dfXcK0D9bDz/ZYBT3F1wrUrihil4IrkRQFgmM9YDPmvwE/ikfESi4HsSGCtlXGU0QcWDy2bwE8S8oBZ8NwJ/V6/ZmeqiayL5aSSLE0WkJSev/Y32Kp4u+SpXS45IR5byM4g8Vq/sWSy5RBE+xceQ7x+NgyzI47jI3reaGZgN+pQkecbMvbH17JL13ehE8Tnd9HDisY2Pk7Z4lx/Ze6xeoxhyYlktizyn2vgOrwUmUNF86G1qukREfSmk437j3iakXdK2g5GrYJPqVNKpmiNGm789GHfDkRTh2Nyii0EtdE8iFDX5k1ByWaLjQDOYcgC5pScFVsuw1lQbQKFacLddn3yEUMe5XHOHjwJof+F/sgX9v+dHBMaJcSJAn2edHPMDo0Y1Q4mfr85hk+TsWmv/SR+1OXWpRPqKkTc4tZ86FxWmF/ZAwNCwRnj0ablRpBKkXJ5JMrGUdjiaTPXAetpk7Ym43x0SXdNsdONCRUbNBv7JpwomlmGdHMV2/me5mnel23FR3Q19F08X+soRuPcw6wdU8z6RWTba679RyhU1s105i7AYbKw5N2/PLNWvG52INucD4LM87Z9VXeLa8zfcfxuh7htw+Bs8M07ssYeHDjMbfC5QuTm2H0hOLvMY11iCDXzG8pN6ty8T9hjw2f0ZCz+GCgI7bzspGrimq49zJ8xjHQpo8DybGTPCASL9U9+jWusSRpfeNdkz+aSScKhbNGJ3H79xW0cJ89FjZf2Nd2gYZAqIe3xK8S0EOQ6vPo6KyZWjQ+HiNv6U6KctYJ9N8dzNIhQ+MxzG9uPZLXcdQSbs/7CODrdFa8o00Iz7v0YOs65P3hNETRd/xH9xku6/cf7nHlBSfHp/9tK2ljoEcU3KbYGMu1m+i0xJwiEzMTp5F0gtLtus6udivbGzWxHbLbxKfXN11vPwlIIP7/IHxy2nuoyPCKE38W4lZJWvCrzjp1YfUaryGywP/2ZsNvUykGNBTZAlqD67VcZOZ3m9ept7/9avMBcP2Bjz/Eraz876oMUi2frR30jAflLH37z6KTMhDTN1haPrBTjrr3+22p/hoH9F03c7dnr9jn9D9DkICpdM=
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Returns a list of reasons that prevent the company from running payrolls. See the [Payroll Blockers guide](doc:payroll-blockers) for a complete list of reasons. The list is empty if there are no payroll blockers.
+
+scope: `payrolls:run`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies.ParamsDetails.json b/docs/api/get-v-1-companies.ParamsDetails.json
new file mode 100644
index 000000000..dd4392082
--- /dev/null
+++ b/docs/api/get-v-1-companies.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"company_id","in":"path","description":"The UUID of the company","required":true,"schema":{"type":"string"}},{"name":"X-Gusto-API-Version","in":"header","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"},"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."}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies.RequestSchema.json b/docs/api/get-v-1-companies.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-companies.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies.StatusCodes.json b/docs/api/get-v-1-companies.StatusCodes.json
new file mode 100644
index 000000000..69f39d776
--- /dev/null
+++ b/docs/api/get-v-1-companies.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"successful","content":{"application/json":{"schema":{"title":"Company","type":"object","description":"The representation of a company in Gusto.","properties":{"ein":{"type":"string","description":"The Federal Employer Identification Number of the company.","readOnly":true},"entity_type":{"type":["string","null"],"description":"The tax payer type of the company.","enum":["C-Corporation","S-Corporation","Sole proprietor","LLC","LLP","Limited partnership","Co-ownership","Association","Trusteeship","General partnership","Joint venture","Non-Profit"],"readOnly":true},"contractor_only":{"type":"boolean","description":"Whether the company only supports contractors."},"tier":{"type":["string","null"],"description":"The Gusto product tier of the company (not applicable to Embedded partner managed companies).","readOnly":true,"enum":["simple","plus","premium","core","complete","concierge","contractor_only","basic"]},"is_suspended":{"type":"boolean","description":"Whether or not the company is suspended in Gusto. Suspended companies may not run payroll."},"company_status":{"type":"string","description":"The status of the company in Gusto. \"Approved\" companies are approved to run payroll from a risk and compliance perspective. However, an approved company may still need to resolve other [payroll blockers](https://docs.gusto.com/embedded-payroll/docs/payroll-blockers) to be able to run payroll. \"Not Approved\" companies may not yet run payroll with Gusto and may need to complete onboarding or contact support. \"Suspended\" companies may not run payroll with Gusto. In order to unsuspend their account, the company must contact support.","enum":["Approved","Not Approved","Suspended"],"readOnly":true},"is_high_risk_business":{"type":"boolean","description":"Whether or not Gusto has identified the company as representing a high fraud risk.","readOnly":true},"is_marijuana_business":{"type":"boolean","description":"Whether or not the company is a marijuana-related business.","readOnly":true},"uuid":{"type":"string","description":"A unique identifier of the company in Gusto.","readOnly":true},"name":{"type":"string","description":"The name of the company.","readOnly":true},"slug":{"type":"string","description":"The slug of the name of the company.","readOnly":true},"trade_name":{"type":["string","null"],"description":"The trade name of the company.","readOnly":true},"is_partner_managed":{"type":"boolean","description":"Whether the company is fully managed by a partner via the API","readOnly":true},"pay_schedule_type":{"anyOf":[{"type":"string","enum":["single","hourly_salaried","by_employee","by_department"]},{"type":"null"}],"description":"The pay schedule assignment type.","readOnly":true},"join_date":{"type":["string","null"],"description":"Company's first invoiceable event date","readOnly":true},"funding_type":{"type":["string","null"],"description":"Company's default funding type","enum":["ach","reverse_wire","wire_in","brex"]},"locations":{"type":"array","uniqueItems":false,"description":"The locations of the company.","items":{"description":"The representation of a company's address in Gusto.","type":"object","properties":{"street_1":{"type":"string","readOnly":false},"street_2":{"type":["string","null"],"readOnly":false},"city":{"type":"string","readOnly":false},"state":{"type":"string","readOnly":false},"zip":{"type":"string","readOnly":false},"country":{"type":"string","readOnly":false,"default":"USA"},"inactive":{"type":"boolean","description":"The status of the location. Inactive locations have been deleted, but may still have historical data associated with them.","readOnly":true},"active":{"type":"boolean","description":"The status of the location. Inactive locations have been deleted, but may still have historical data associated with them.","readOnly":true}},"title":"Company-Address"},"readOnly":true},"compensations":{"type":"object","description":"The available company-wide compensation rates for the company.","properties":{"hourly":{"type":"array","uniqueItems":true,"description":"The available hourly compensation rates for the company.","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the hourly compensation rate.","example":"Overtime","readOnly":true},"multiple":{"type":"number","description":"The amount multiplied by the base rate of a job to calculate compensation.","example":1.5,"readOnly":true}},"readOnly":true},"readOnly":true},"fixed":{"type":"array","uniqueItems":true,"description":"The available fixed compensation rates for the company.","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the fixed compensation.","example":"Bonus"}},"readOnly":true},"readOnly":true},"paid_time_off":{"type":"array","uniqueItems":true,"description":"The available types of paid time off for the company.","items":{"type":"object","properties":{"name":{"type":"string","example":"Vacation Hours","description":"The name of the paid time off type.","readOnly":true}},"readOnly":true},"readOnly":true}},"readOnly":true},"primary_signatory":{"type":["object","null"],"description":"The primary signatory of the company.","properties":{"uuid":{"type":"string","readOnly":true,"description":"The UUID of the company's primary signatory."},"first_name":{"type":"string","readOnly":true,"description":"The company's primary signatory's first name."},"middle_initial":{"type":["string","null"],"readOnly":true,"description":"The company's primary signatory's middle initial."},"last_name":{"type":"string","readOnly":true,"description":"The company's primary signatory's last name."},"phone":{"type":"string","readOnly":true,"description":"The company's primary signatory's phone number."},"email":{"type":"string","readOnly":true,"description":"The company's primary signatory's email address."},"home_address":{"type":"object","properties":{"street_1":{"type":"string","readOnly":true},"street_2":{"type":["string","null"],"readOnly":true},"city":{"type":"string","readOnly":true},"state":{"type":"string","readOnly":true},"zip":{"type":"string","readOnly":true},"country":{"type":"string","readOnly":true}},"readOnly":true,"description":"The company's primary signatory's home address."}},"readOnly":true},"primary_payroll_admin":{"type":"object","description":"The primary payroll admin of the company.","properties":{"first_name":{"type":"string","readOnly":true,"description":"The company's primary payroll admin's first name."},"last_name":{"type":"string","readOnly":true,"description":"The company's primary payroll admin's last name."},"phone":{"type":["string","null"],"readOnly":true,"description":"The company's primary payroll admin's phone number."},"email":{"type":"string","readOnly":true,"description":"The company's primary payroll admin's email address."}}}},"x-examples":{"success_status":{"uuid":"c7a07c73-a703-4462-9343-1b181182b6e0","name":"Shoppe Studios LLC","trade_name":"Record Shoppe","is_partner_managed":true,"tier":"complete","locations":[{"street_1":"412 Kiera Stravenue","street_2":"Suite 391","city":"San Francisco","state":"CA","zip":"94107","country":"USA","active":true},{"street_1":"644 Fay Vista","street_2":"Suite 842","city":"Richmond","state":"VA","zip":"23218","country":"USA","active":true}],"ein":"00-0000001","entity_type":"C-Corporation","pay_schedule_type":"by_department","join_date":"2024-01-15","funding_type":"ach","slug":"shoppe-studios-llc","is_suspended":false,"company_status":"Approved","is_high_risk_business":false,"is_marijuana_business":false,"contractor_only":false,"compensations":{"hourly":[{"name":"Overtime","multiple":1.5},{"name":"Double overtime","multiple":2},{"name":"Regular","multiple":1},{"name":"Outstanding vacation","multiple":1},{"name":"Holiday","multiple":1},{"name":"Emergency sick - self care","multiple":1},{"name":"Emergency sick - caring for others","multiple":1},{"name":"FMLA Public Health Emergency Leave","multiple":1},{"name":"Regular Hours","multiple":1}],"fixed":[{"name":"Bonus"},{"name":"Commission"},{"name":"Paycheck Tips"},{"name":"Cash Tips"},{"name":"Correction Payment"},{"name":"Severance"},{"name":"Minimum Wage Adjustment"},{"name":"Reimbursement"}],"paid_time_off":[{"name":"Vacation Hours"},{"name":"Sick Hours"},{"name":"Holiday Hours"}]},"primary_signatory":{"uuid":"2d7cd96f-e2fb-4db7-8c04-99ef531b4527","first_name":"Alda","middle_initial":"","last_name":"Carter","phone":"4160000000","email":"louie.hessel7757869450111547@zemlak.biz","home_address":{"street_1":"524 Roob Divide","street_2":"Suite 565","city":"San Francisco","state":"CA","zip":"94107","country":"USA"}},"primary_payroll_admin":{"first_name":"Ian","last_name":"Labadie","phone":"1-565-710-7559","email":"louie.hessel7757869450111547@zemlak.biz"}}},"x-tags":["Companies"],"required":["uuid"]}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided ID/UUID is valid.","type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["error_key","category"],"properties":{"error_key":{"type":"string","description":"Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error."},"category":{"type":"string","description":"Specifies the type of error. The category provides error groupings and can be used to build custom error handling in your integration."},"message":{"type":"string","description":"Provides details about the error - generally this message can be surfaced to an end user."}}}}},"x-examples":{"not_found":{"errors":[{"error_key":"request","category":"not_found","message":"The requested resource was not found."}]}},"title":"Not-Found-Error-Object"}}}}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-companies.api.mdx b/docs/api/get-v-1-companies.api.mdx
new file mode 100644
index 000000000..bff340174
--- /dev/null
+++ b/docs/api/get-v-1-companies.api.mdx
@@ -0,0 +1,75 @@
+---
+id: get-v-1-companies
+title: "Get a company"
+description: "Get a company."
+sidebar_label: "Get a company"
+hide_title: true
+hide_table_of_contents: true
+api: eJztGmtvG7nxr7Dsh9wBWtlyJDvRp3Odl9tcYsRJroBjqNTuSGLMJff4kK0z/N+LIbkvaWXLuQRoi96HnCWRM8N5v26pgdRpbld0fHFLT1ReMLk6TlMw5tjZBR1fXN5d9mgGJtW8sFxJOqavwRJG0nC4/0V+kR8XQCAvhFoBmLEGlhGTqgIIN0TD745ryIhVRIN1WpKFymHCskyDMYTJjEglk2ulr4hQKUMsph+ARiQTluVcPgy40DxnejUp2EorIcK1CMrwuWRWab4LhSWg8lJ4pr8xJv8KVJWA/kV79CaZO2NVwqWFufZPSOyqADq+oJBPIcsgoz3KiqJ5xNDLHlUFhE+nGR3TOdhkOUgqDLRHC6ZZDha08UKSLAc6piVnOMLlKJaC2QVdlxW+/NOn0xdEzYitGUp7tHw1HVvtoEdNuoCc0fEtDYRTYzWXc3p316uQ/jN57Z95fHaafAZtEEfEvgCWgabb4fQoSJcjQw72D0bJ/mEyGFGvWzPmhKXj5vd36+94gQzIuQTjn5ExC8mUGcjI8dkpWQZaCDNGpZxZyMg1twuyUk77AykTok9OZ6hpXuaFVkueQdYLZ1hRCB5U74khFzmXPHd5E/blTwtrCzPe28tUavpe3P1U5XuleJOodP73PVbwJN7kcv7XCDBpfP0zkuEMZH2KJlZqkDbXbF7KRIMplDRgkJ0H+/v4vzZfjPPGOnOC9miqpAVp8VTjQXtfDR69bUqGW4GiOam0IcpKTb9Caju1SEOhwYC0HijqU+UDCJfEK0Yf1VWjRlseiAYuu1RhE/wryEAzQV4GN6LJaQbS8ll8BHnn8inoNTXuez1m2XspVoFnd6hmltvVJKAsUV/UuKUTgm44NaTBshtSMESOlzpwlRp8kpwoXahgt7RHz9c/KwGoYoXmYBVaxdu3J/7fM/yX5xxVtGDaStBmwQvaoycqUdf1x+OoygHgR+2MBYi/vQbpedUG8HfFpSVLkNZpoD36TsnkTKsZt/jaDTahsmiWWqUnyn9fSWmqlAAmN8T02wLsAplTM4XgVWJcUShtDalhmj7asOWgHykDr0fIu8ylliCANTmQn6SypcFOBaDXfhltsOQIyZlkc8hI5Ud/3lSVWpyG54VAlhXCeY+rIecu9xblWYlgBNjwp0w56Hn8u8XCHp0yw1N6edej3EyMMwVI9Py781Zpgs9rvpcbUkGqLY2cV99VjyQ5W/nr2kkS3ZGXQxksjGXWmd0MMpxdZ36N/ws9LtCLQvaFNkhgGlA4/gcfUGtSyEyrnDCiubnyYd+zlTOZAilAmwJSy5fQJ2/UNSxB9wiTNaySAnyjsVwIIqGM2UaJJRDlOXhRYpsKlV6BNo/03PFDUl7/GVFMgZS61uQt+ULfKUs6GVHKYgUteYTAFLQceeCPxYeUakaUnCqmMy7nqBCoZiy1pZkh1kr4nSi70fXJqSRKZ2jBijgZlQrFyzVhaaqctL2WtHNn7Ab6hh8sH+69Tc0H9ICV7nf5Hm4mCz5fTFATJlNnMK6bx1tJ4OKCGcJjsICsRT8zddhCZjKCaMlMM5d5NewMINxMcqb5V8ck+xPUrdkwIxXQRIPwSUoJvJMM53j2sKkeEyf57w5qFmw4zGZ03sASMrtdHAKe3CX+GuHmO7oY4eYlxF2hW80ymLSp3i2448Wd0XAzibFkEmPJNwZIbsjMCbGqQtJ0RVgVp5ac+dPHZ6ddVBRsNcGsLXMCqoSGydX7mS8FtiXYhsu5j2cL5bRYTQwTTHNvl9PVpCzUwqcMkJYc08ZLzPQjTM/HzdIPGVmgA45EYcbN5xKv+5ypk5dfFZcTzNgfIbGYmT4xZMa1sYTLpeIpeCcMmOP4EqAL28xJdJyPzf9qhLEgIRGQf1eDuSxdeLSYxsPkmvsEAf834agRUw03PgGoStmG4jCtGaYJwWRPLeSGjmdMGOhidAWhQ2F5uLteDjyQqD8xpCy7m05hPflvp/DGagA7GXTZdM19/wq0/nD64F7Wb15LfQ9iNwQtTbrv6B+82O2gD316FwKa9eqn82NMrrhkPm/ZwUFs5lWljDE4BzANsS/YEsgUQJIMMC/IemTqbCMD8gcW3GBbI2UCbYJtFMF2AXmnXf5Xku2rilb1mhwHlUZZdFQ5eQHSbFjiPYUuWzIuvKOJVpNc8yx8KCERzSwYMlN63S7bphP870MOIBQj9xES4OxIQuUa7jfrbwv82yjxWeEN83XUmL5fIp680z/nTljujzWCDdb23cLI0TRJvMRD/ERCsPnjMQcH91VNfQbNROowt2pR2CJu0B91KdUGnZuBhd+0soBvlKUH858gyk1C2kL8m5LO0N14UzCeTVDiEzWb/Xke4W3vaxAuQbhEzWY/gEP1az+z2Gh6o5w2DzKvTdiW1GcH1nUyc7353Iyl1QO3Z7rxftXxXnXkD232bCs11hsmO/WWn5hNCnwXwmdyk22ieBjXPfCrPBGhe2Q5zzKBORm3nIkds5FvwxxQkYjKYxfsB74UgdcPLRZK/hA0HjAJvtljgpxx8SMwecBlZupRNSdED1v3bhlqWZ4+LkEt84gH89MK/IPpaTz5YHZapTA7JKfdzuTxokDGNyRxn3tqDdl2S61KjGVzyl990Dt9f7/Rwr/pO7679a7ju9eCv5OHWsf5Y815Hdu6Sd+hKt0kMd4Gqw2jq0ZTOoQhmh6x/aP06GnCjvafJsPh4UHy/OnwaTKYDp4NBs8OpoewT8vOFT1fqKIAcm5dxpUhYdDS7BLRD5AqnZFwkHb3dsJLw7yi2e5vVPEXTUdDh4MD8g8OmpFzq9kSpMPjtXOh545bIE+fD2jpPeg5k+SVZjLlJlW08hX05JhGd0CfDwf7R7Rh9L7KrGu1YIMtSg6HQ/KKrchnbizrouHZ8KCm4QNPF7mSWQP95xr9wdODwbOH0F/2wliP7u8n+/6/AV0bu21MyDo6WWvdp1afCGfBw2R/gLPg9ZZO7MCENiM1XqqJCeJPhEjp+vAlFu7rQ5Bm93pLQzre3NIQruCuDdIa+FqlZ1kN1kP8Rp1Ul0WD/qgxcn+hHGbEquvkQePcB5g7wXQbUuP3984ay0JHaxlz3a2H3yjBM5+4d//+MscJmEwxdqRXJCEGxIykTMPuV1KG7sbn9H5wY7ZeffXr22Ny5qaCp+QNMGEXpIb2FthyO9bIlSqpb566rEq6WiCx5qkBnKg858YvOjS+PWOrdAHpFfnIi/ZxZhabXyqtcbSlJDljK6/sjV/PsZOIM7Dml7/GBYTf2BzIcfbVGbt+7wPwfOq0gfDD5UYRVr9qrbZpIkdZbHwbxV/+cLmtJon++iA7SrPnh7MEDmbTZJhNj5Jn6f4wef4cZqOng+lwdIAurRnG6bHI0FetZ+mUtqIvPWHa+s5AjJF0ODgMLgcjQIxgVCjHob8AY0AcHY2Onh0+H472B4PBaHj0yx+QC3bVn/I/6GZe2XCjo4Mh+aDUlLzguBnS5UhHh6Pv4Mzv7suhWkw69b24Jj/esinLODQYMkhGh6PkaLCfHI1Gz7+BKTEyWzY3frWh2jy6bO4IXQRhX4ZAPtwfbvaecQL4SjkfWnbeRNkCgnyRhIS9LaQBDLYFcc7rdAokU2D8iA1uuLF98iu7AmKchlCax9Uecvpiz5en3JAlEzzranU3XwhaK+3fvbbDEr7f7GpsbT5sQJ1cAV5ImYU5Gk83Dn/qwT7OeQEpzvkMuV5AfLO/TlSaOm365OOqwL6qwE4ZN+QKVvV0MOxPMWs1nzoLe9V2GSmHklbVIMP2QEn1I0hDCOUSTYBEfOIYQZVCMpHyuVau4HIe1gFTJnHijstRfvjuuMhIitOKPJ5fMJkJDB9chgWuxlZdKP/BGDbfoSt2VhKSgWVcGMKmytkGUxMyD+s2JTsj6JJK4/SMpYFSJglO1J3xKXZX0iuVncy8kTQU66Ilfxo1vqkv48bFxuPoFgO5ZsE+/AXcL2u2zd8pm3gjS14i0uR90NpIbqcfuElMAewKmFkl6IkSTEc0ekm/segbaRakqRLl8JCtW5E9umTCPbwdiTGpDSqsx1X3y3S4PLSNzOqCJxeDZQ52obKKfr88OaZ7y8FetU+xd1svWd6hhwe9LLcwnUYfWy6WsIKHvZIkg9wvl2zo2QvIFW1zMsBLfAzFez4EbwHcCfNMq+wemLhE5d9aLvmeo9sNetix6ltZCiIvFzl9ng5Md7Tny/GLgCUIwpxdoIuJmeVdj56vjIX8z2AIELYg8JO3mWquM4Z9kDBLj1uW7bXSHsUtUvN+dg56yVNocLpeC/IOYM8f3MsQNfrpxH9O1MxzGK9uDP9BpNg8sSoMVp+Yei3tLFbHuE+aqdTl5XT2LzFWstTWbWr6osRKPqBP9rZQB/aKpl9qzfA5hTI2Z7IBp7WovU7wbR2k/7/RvbnRHTXVwo3dKwTjXqW9cd5GZ3FBlwNalpVhVXvc2Mq+xGzTWDx3e4vTqk9a3N3h1787QJd+cYleSXOceHifknGDf2fdKwFNef30IT7wZ7J9wbvzBWUG40+UPpH2ogNtkO+z/rjU/Tji/qdXtbewNbCvez2+4nIdqNApFrbx20aS3ApRr19+xPDY9qGVz4x/NBaC2tK9vQ0nPqorkHd3lbAtfva5wd2/AfY4gVA=
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Get a company.
+
+The employees:read scope is required to return home_address and non-work locations.
+The company_admin:read scope is required to return primary_payroll_admin.
+The signatories:read scope is required to return primary_signatory.
+
+scope: `companies:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-company-benefits-company-benefit-id-contribution-exclusions.ParamsDetails.json b/docs/api/get-v-1-company-benefits-company-benefit-id-contribution-exclusions.ParamsDetails.json
new file mode 100644
index 000000000..97d758b98
--- /dev/null
+++ b/docs/api/get-v-1-company-benefits-company-benefit-id-contribution-exclusions.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"schema":{"type":"string"},"name":"company_benefit_id","in":"path","required":true,"description":"The UUID of the company benefit"},{"name":"X-Gusto-API-Version","in":"header","required":false,"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.","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"}}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-company-benefits-company-benefit-id-contribution-exclusions.RequestSchema.json b/docs/api/get-v-1-company-benefits-company-benefit-id-contribution-exclusions.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-company-benefits-company-benefit-id-contribution-exclusions.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-company-benefits-company-benefit-id-contribution-exclusions.StatusCodes.json b/docs/api/get-v-1-company-benefits-company-benefit-id-contribution-exclusions.StatusCodes.json
new file mode 100644
index 000000000..9b9cb79b0
--- /dev/null
+++ b/docs/api/get-v-1-company-benefits-company-benefit-id-contribution-exclusions.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"Example response","content":{"application/json":{"schema":{"type":"array","items":{"description":"The representation of a contribution exclusion for a company benefit.","type":"object","properties":{"contribution_uuid":{"type":"string","description":"The UUID of the contribution type."},"contribution_type":{"type":"string","description":"The name of the contribution type."},"excluded":{"type":"boolean","description":"Whether this contribution type is excluded from the benefit."}},"required":["contribution_uuid","contribution_type","excluded"],"x-tags":["Company Benefits"],"title":"Contribution-Exclusion"}},"examples":{"Example":{"value":[{"contribution_uuid":"b82e35c5-d7c6-4705-9e16-9f87499ade18","contribution_type":"Bonus","excluded":false},{"contribution_uuid":"f5618c94-ed7d-4366-b2c4-ff05e430064f","contribution_type":"Cash Tips","excluded":false},{"contribution_uuid":"60191999-004a-49d9-b163-630574433653","contribution_type":"Commission","excluded":false},{"contribution_uuid":"75a7a827-1f2d-4d6f-94f2-514c1fc32b13","contribution_type":"Regular","excluded":false},{"contribution_uuid":"eead3c7c-7964-4e3c-b609-670456127b09","contribution_type":"Life insurance imputed benefit","excluded":true}]}}}}},"404":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided UUID is valid.\n"}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-company-benefits-company-benefit-id-contribution-exclusions.api.mdx b/docs/api/get-v-1-company-benefits-company-benefit-id-contribution-exclusions.api.mdx
new file mode 100644
index 000000000..0eca43055
--- /dev/null
+++ b/docs/api/get-v-1-company-benefits-company-benefit-id-contribution-exclusions.api.mdx
@@ -0,0 +1,73 @@
+---
+id: get-v-1-company-benefits-company-benefit-id-contribution-exclusions
+title: "Get contribution exclusions for a company benefit"
+description: "Returns all contributions for a given company benefit and whether they are excluded or not."
+sidebar_label: "Get contribution exclusions for a company benefit"
+hide_title: true
+hide_table_of_contents: true
+api: eJzdV11v2zYU/Ssc99AOEG3Jlu3YT0uTrgiwjyBttwGJ0dLiVcRGIlWScmMY+u/DpaREju20xd6al1gSeQ55ee+5h1t6z24r6zSTysGt4U5qxdymBLq4plCsQAgQNKC8LPtDLF0GVJfQPF0IuqC34Ng6YokuSq42H1agIJXOPn3xQQqWaOWMXFU49wPcJ3llPWZABdjEyBI/0AW9AlcZZQnPc9KfY0mqDeHkVq5BkZaAtASEK0G+ZOAyMMRlsCHcAPEsAgTRhijtBjfqRp1VxoBy+Ya4TFoCSpRaKke0yjfkizZ3DU8cRuzOo15pl7WPHRmGyno0m+gSFuTj0wAsDHDxkQa05IYX4MBYurjeUptkUHC62NIm3NQ6I9UtrQOqeIEv9iNHAyoxMCV3GQ2ogc+VNCDowpkKnkbvXQbk/fuLc6JTjMPTONE62HZM/7I3PglOLy/Y32DwNDqqDLgAs0OW8tzusZ3jzgqpwHoywR2wFbcgyOnlBVk3oIRbqxPJHQjyRbqMbHRl/ICE5/mAXKREaQVEWlIavZYCRNCM4WWZy8Rn2wtLrgupZFEVfezly8y50i6GQ6ETO/BZPUh0MeyymJV8Y3Se++9DXkrWzpTq9ucWkPVe/4LLqCyIAQ2OnlZAQVUFFssoHE1YOGXRBGtDQMqr3NFF/31dLwPq+C0mAD1rj+NVmyc4y4AttbJgkWgUhvhvN8yv73lR5kC6kTSgWBmgHI7tRWn4yeKEA3nGjeEbPF4Hhd1nwLQxUBqwoJyHwgTiOwVIHoq2rcQnuYURa9n06hMkDtPfoF442WxuRwKqSopDof1aPvcWhFMHWDs7wA3gtwBjITwP3ClID2+ldQ5c7QH+86A+0u6jYVo9yFFqdOFJHyJX1/1auz4QqUOb7K1vGdB79lyWOelyXP5ZD4W97k7ULwCaNPNH1aYc/lzzvAKvXgfOj65ORjCeJBMmZsmUxbNwwuYQTdk8PZnF8zkXEJ0cXPyCvtKqsv1NNCKDEnWIKZ1Mo5NkHjMQM8Hi8XTKVqMkZmkaTiAeh+E0To8wnXGbkXey/A62aRjNo/l8zsIw5iyeizlbRdMxm47DySyOx+PpZHyMTReFtK2efiPdbMJn/GQ0Y1E6EiwW05TN43TEJlGcRGkyHq2iY3RXcFvl3Hw7FwAX42SWsNl8GrMYxglbTcM5m87CeDKNRrNVOD/C9btMgUhlK8NVAkQWZYWy3nWX/hKwO9XLGv8CGofxvuj8qR35TVdKkBtFyI1qROhzBRYxDVhdmQSI0GCxfRO4l9YNyB/8DoitDPgS6lpGoxLSkjXPpRjcdCntQDU+AxP4DjZ0cdz9BA+5/rwLQkUvwGW6tUC+z7uMLuhwHQ2feoHhdr+n18PjdsiCWXd+oTI5tuO2x/FSNi2OCSh8n9tToXMoNEUtsCXwO+B2wxo85o8e53kPcAT4IOal0eIZzBI/Y0gsJJWRbuNX3mrQaZKAtacVRud62R/1FltUIzYHxj7ILS6xa8VefoEbb01219hCsBzWkBNeuQyUa7siCvnbjXVQ/B+GBuEIQY3GKdUetRVab67Qq2BatfZqxxgEFM2T/St9C2YtE+idx6OP4StduaEfOBRIjf2U+WemU38OOHWvGUGe6AKI08Sv44Ulr9uMJpeNI/I2SuikKrqW/1Nb9DzxvqK1iecdK7mCvK2AgELBZe4Tqv3662P+YDRKbV3BVQ/nDbgjdsIe9hNPN7V9ND0/2CWhTUQH925Y5lz6jPUVum2F5ZquI386uwg0oIuDF4Zj6rIMaKatQ8DtFp36e5PXNb7+XIHByl2iCBrJV3nT84W0+PvIDaB/Ji+vWgPzC/naLeTIljuvqjaPUkxp0Mr2gY3WyzroLivft9gf/OZyMLxNGA9f+x6ijc2hGYhiWbret72Lxk4ffPP6Ha3r/wDIDrua
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Returns all contributions for a given company benefit and whether they are excluded or not.
+
+Currently this endpoint only works for 401-k and Roth 401-k benefit types.
+
+scope: `company_benefits:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-company-benefits-company-benefit-id-employee-benefits.ParamsDetails.json b/docs/api/get-v-1-company-benefits-company-benefit-id-employee-benefits.ParamsDetails.json
new file mode 100644
index 000000000..4eec5a468
--- /dev/null
+++ b/docs/api/get-v-1-company-benefits-company-benefit-id-employee-benefits.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"schema":{"type":"string"},"name":"company_benefit_id","in":"path","required":true,"description":"The UUID of the company benefit"},{"schema":{"type":"integer"},"in":"query","name":"page","description":"The page that is requested. When unspecified, will load all objects unless endpoint forces pagination."},{"schema":{"type":"integer"},"in":"query","name":"per","description":"Number of objects per page. For majority of endpoints will default to 25"},{"in":"query","name":"include","schema":{"type":"string","enum":["all_benefits"]},"description":"Available options:\n- all_benefits: Include all effective dated benefits for each employee instead of only the current benefits."},{"name":"X-Gusto-API-Version","in":"header","required":false,"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.","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"}}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-company-benefits-company-benefit-id-employee-benefits.RequestSchema.json b/docs/api/get-v-1-company-benefits-company-benefit-id-employee-benefits.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-company-benefits-company-benefit-id-employee-benefits.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-company-benefits-company-benefit-id-employee-benefits.StatusCodes.json b/docs/api/get-v-1-company-benefits-company-benefit-id-employee-benefits.StatusCodes.json
new file mode 100644
index 000000000..1bb56c18d
--- /dev/null
+++ b/docs/api/get-v-1-company-benefits-company-benefit-id-employee-benefits.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"Example response","content":{"application/json":{"schema":{"type":"array","items":{"description":"The representation of an employee benefit.","type":"object","title":"Employee-Benefit","x-examples":{"Example":{"version":"09j3d29jqdpj92109j9j2d90dq","employee_uuid":"73274962-63ce-4e5c-b689-1df8d4df09f4","company_benefit_uuid":"54e37c27-43e6-4ae5-a5b2-e29895a133be","active":true,"uuid":"e91ca856-a915-4339-9b18-29f9cd66b031","employee_deduction":"100.00","company_contribution":"100.00","employee_deduction_annual_maximum":"200.00","company_contribution_annual_maximum":"200.00","limit_option":null,"retirement_loan_identifier":null,"deduct_as_percentage":false,"contribute_as_percentage":false,"catch_up":false,"coverage_amount":null,"deduction_reduces_taxable_income":null,"coverage_salary_multiplier":"0.00","contribution":{"type":"amount","value":"100.00"},"elective":false,"effective_date":"2025-01-01","expiration_date":null},"Tiered Example":{"version":"09j3d29jqdpj92109j9j2d90dq","employee_uuid":"73274962-63ce-4e5c-b689-1df8d4df09f4","company_benefit_uuid":"54e37c27-43e6-4ae5-a5b2-e29895a133be","active":true,"uuid":"e91ca856-a915-4339-9b18-29f9cd66b031","employee_deduction":"100.00","employee_deduction_annual_maximum":"200.00","company_contribution_annual_maximum":"200.00","limit_option":null,"deduct_as_percentage":false,"catch_up":false,"coverage_amount":null,"deduction_reduces_taxable_income":null,"coverage_salary_multiplier":"0.00","elective":true,"contribution":{"type":"tiered","value":{"tiers":[{"rate":"100.0","threshold":"2.0","threshold_delta":"2.0"},{"rate":"50.0","threshold":"5.0","threshold_delta":"3.0"}]}},"effective_date":"2025-01-01","expiration_date":null}},"allOf":[{"description":"","type":"object","title":"Employee-Benefit-Base-Object","properties":{"version":{"type":"string","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."},"active":{"type":"boolean","default":true,"description":"Whether the employee benefit is active."},"employee_deduction":{"type":"string","default":"0.00","description":"The amount to be deducted, per pay period, from the employee's pay."},"deduct_as_percentage":{"type":"boolean","default":false,"description":"Whether the employee deduction amount should be treated as a percentage to be deducted from each payroll."},"employee_deduction_annual_maximum":{"type":["string","null"],"description":"The maximum employee deduction amount per year. A null value signifies no limit."},"contribution":{"type":"object","description":"An object representing the type and value of the company contribution.","properties":{"type":{"type":"string","description":"The company contribution scheme.\n\n\"amount\": The company contributes a fixed amount per payroll. If elective is true, the contribution is matching, dollar-for-dollar.\n\n\"percentage\": The company contributes a percentage of the payroll amount per payroll period. If elective is true, the contribution is matching, dollar-for-dollar.\n\n\"tiered\": The company contribution varies according to the size of the employee deduction."},"value":{"description":"For the `amount` and `percentage` contribution types, the value of the corresponding amount or percentage.\n\nFor the `tiered` contribution type, an array of tiers.","oneOf":[{"type":"string"},{"type":"object","properties":{"tiers":{"type":"array","description":"","items":{"type":"object","description":"A single tier of a tiered matching scheme.","properties":{"rate":{"type":"string","description":"The percentage of employee deduction within this tier the company contribution will match."},"threshold":{"type":"string","description":"Specifies the upper limit (inclusive) percentage of the employee contribution that this tier applies to.\n\nUse threshold to define each tier's end point, with tiers applied cumulatively from 0% upwards.\n\nFor example:\n\nIf the first tier has a threshold of \"3\", and `rate` of \"100\", the company will match 100% of employee contributions from 0% up to and including 3% of payroll.\n\nIf the next tier has a threshold of \"5\" and a rate of \"50\", the company will match 50% of contributions from above 3% up to and including 5% of payroll."},"threshold_delta":{"type":"string","description":"The step up difference between this tier's threshold and the previous tier's threshold. In the first tier, this is equivalent to threshold."}}}}}}]}}},"elective":{"type":"boolean","description":"Whether the company contribution is elective (aka matching). For \"tiered\" contribution types, this is always true.","default":false},"company_contribution_annual_maximum":{"type":["string","null"],"description":"The maximum company contribution amount per year. A null value signifies no limit."},"limit_option":{"type":["string","null"],"description":"Some benefits require additional information to determine their limit.\n\n`Family` and `Individual` are applicable to HSA benefit.\n\n`Joint Filing or Single` and `Married and Filing Separately` are applicable to Dependent Care FSA benefit."},"catch_up":{"type":["boolean","null"],"default":false,"description":"Whether the employee should use a benefit's \"catch up\" rate. Only Roth 401k and 401k benefits use this value for employees over 50."},"retirement_loan_identifier":{"type":"string","description":"Identifier for a 401(k) loan assigned by the 401(k) provider"},"coverage_amount":{"type":["string","null"],"description":"The amount that the employee is insured for. Note: company contribution cannot be present if coverage amount is set."},"deduction_reduces_taxable_income":{"type":["string","null"],"default":"unset","enum":["unset","reduces_taxable_income","does_not_reduce_taxable_income"],"description":"Whether the employee deduction reduces taxable income or not. Only valid for Group Term Life benefits. Note: when the value is not \"unset\", coverage amount and coverage salary multiplier are ignored."},"coverage_salary_multiplier":{"type":["string","null"],"default":"0.00","description":"The coverage amount as a multiple of the employee's salary. Only applicable for Group Term Life benefits. Note: cannot be set if coverage amount is also set."},"company_contribution":{"type":"string","default":"0.00","description":"The amount to be paid, per pay period, by the company. This field will not appear for tiered contribution types.","deprecated":true},"contribute_as_percentage":{"type":"boolean","default":false,"description":"Whether the company_contribution value should be treated as a percentage to be added to each payroll. This field will not appear for tiered contribution types.","deprecated":true},"effective_date":{"type":"string","format":"date","description":"The date the employee benefit will start."},"expiration_date":{"type":["string","null"],"format":"date","description":"The date the employee benefit will expire. A null value indicates the benefit will not expire."}}},{"type":"object","properties":{"employee_uuid":{"type":"string","description":"The UUID of the employee to which the benefit belongs.","readOnly":true},"company_benefit_uuid":{"type":"string","description":"The UUID of the company benefit.","readOnly":true},"uuid":{"type":"string","description":"The UUID of the employee benefit.","readOnly":true}}}],"required":["uuid"]}},"examples":{"Example":{"value":[{"version":"09j3d29jqdpj92109j9j2d90dq","employee_uuid":"8f9f3f68-8fd3-499d-ade7-4a052e56494e","company_benefit_uuid":"54e37c27-43e6-4ae5-a5b2-e29895a133be","active":true,"uuid":"e91ca856-a915-4339-9b18-29f9cd66b031","employee_deduction":"100.00","company_contribution":"100.00","employee_deduction_annual_maximum":"200.00","company_contribution_annual_maximum":"200.00","limit_option":null,"deduct_as_percentage":false,"contribute_as_percentage":false,"catch_up":false,"coverage_amount":null,"deduction_reduces_taxable_income":null,"coverage_salary_multiplier":"0.00"}]}}}}},"404":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided UUID is valid.\n"}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-company-benefits-company-benefit-id-employee-benefits.api.mdx b/docs/api/get-v-1-company-benefits-company-benefit-id-employee-benefits.api.mdx
new file mode 100644
index 000000000..6bf69c45d
--- /dev/null
+++ b/docs/api/get-v-1-company-benefits-company-benefit-id-employee-benefits.api.mdx
@@ -0,0 +1,75 @@
+---
+id: get-v-1-company-benefits-company-benefit-id-employee-benefits
+title: "Get all employee benefits for a company benefit"
+description: "Employee benefits represent an employee enrolled in a particular company benefit. It includes information specific to that employee’s enrollment."
+sidebar_label: "Get all employee benefits for a company benefit"
+hide_title: true
+hide_table_of_contents: true
+api: eJztWv1u2zgSfxUeD4u2gOXYSZzG/uu62203h9tt0bS3BySBQ4sjm6lEqiTlxBcYuNe417snOQxJfdiS3aRd7O595J9YEjnz43C+OJx7ehfNC2NVJKSFuWZWKBnZVQ50ckEhmwHnwGmPsjxvDjH0qkdVDv7pjNMJnYONlsMoVlnO5Go6AwmJsGb7xVTwCLI8VSuAahDtUQ4m1iJHcnRCvw8jSDmCaMg1GJCWMElKAgSkVmkKnAhJGMmZtiIuUqZJ4FrO75MzS4SM04KDIUImSmcOOjE5xCIRMbGK2AWzFe1//eOfJtDPQNr+pbyU78AWWhqEwLRmK6ISwtK0xlPBrYAlShO7EKaFCOl9Ww6PlbRMSCHn5O0PZ4RpIEqmK7IURsxSQHAsz1MRe+mTW2EXxC6AXLdkOdHA+CRfiGtiYpWDY+R+TXaNvqY9mjPNMrCgDZ1c3FMTLyBjdHJPvTJQY7WQc7ruUckyfNHeV9qjAjcvZ3ZBe1TDp0Jo4HRidQHbO/x+AeTDh7OXKEJcyJZ46LrXAcJpIGhE4Th9KkCvaAUpZ3NoqRIywg9+dwVq0qcCjAXeJz8vQJJCBh0A3iO3Ik1Jqhh3+6pmNxBbQwqZgsFN5bkS0uKmxmCQrJBuR/pfhhd0C+5PRTYDjVIpmeeg3QL65JXSJGM3SgvrVK/EYzxsDgkrUovKcjhygLqYBiugvZ173KMgiwwdAEvT2kav1ttYXyyZSBnqp3KvzORSRqQ5aULOPDtvJkkCsRVLIJxZ4LW1oJEAixe1IQlpLDDu5ICG4FSk0BodQDnNCz0s62/Ra+fHXrw9i/4K2iDCIPUFMO4kXWtkwlLTUsmXqP6ZkGAcO8QYzZgBTl68PSNLT5QwY1QsHH5nhStVaDcgZmnaJ2cJkUoCKlqu1VJw1Co3pmHATwy5yIQUWZE1aV89XVibm8nBAVex6TvH3I9VdlA64ihnK/Qr7vsBy0UUZgo5/2MgGDVeP0MYhQHef9B2Hw4OR9HgJBqO0L0HdaKT5vv1+qpHLZujl6DfBZv9tlIRlLHJlTRgkNHhYID/tnz7HcvyFEg5kvYouj+QFsc2pHRwY3BCh10554vbayEzbQ5o8lW88G4eHbVs+WkUSyDprQ2fhU2hEYKisDrao3cReOyOZ1gH/gziphM6GN8c8cPxzSee34wPh4PxzfjmkI8H/BPKufS+RSEwZD4/Onx+PD45jE6OYoiOYRRHs5PTcTTkySk/5slgnBw76Wx62jB7dAxHz+PD59HxEZxExwxGERvNDiM4HJ+OR2x4dDRD2TJncaUTDnNhPIzZ6egkYuPhKDo+OhpH49nwNDocJ+OYn5zMBkfDJmAOvIiDdIeDQX8waODC3dNiVmx/b8+eMikLlk4zdoeq6lRrD7E9w1ORCTtVYcdlkaaoelZowGA9TRWTU8FBWvTruhzhgUyZmeagY1SOOVTOoOIMuwYwGy+mRd6YsQTN5jBlmSpQfZtcEL/GX2Cmlt2hm5wKGSv0Vn5cNd2wlOnVNCtSK/LU4aWVWJqyrQ3AM+zRJUsLqIW+7lFIIex4QFl53Sl6tMqch9HAbfFdLnwWFz4jtnWPvheggZP/eSX/tZV4v4r+BhpY65MX7g6NtE5fao28d298Mqm93jmZooddaDALleIeHW6+mXJILQvvMbqHqaP2zNGOmUc482q9/jLFX/cw6XmTONybUeURsSL6lhmI3pTDco1HJSt83KjsqB2I22GszHnK7CNkyx5Bn5wDuOeLOg8g80JweGQqIThkubIg49Uzl401j0hKkoW6xbSyMOAPM4mAlGP+VVletZiZUikwSRsJRFf+//MC7AK0Q78dljFr8XQdiy4D7ZJdma4ExW0L0xsJLmQGxBPD7Mwn2Cv8LxTvkUSrbAPXE0z1Vw5Lt3nuW3xnqtm5+mp5JVCzUEWKaTKxGlzGyQwecyvOW0vxyF0iHXZ3h/xaPqlcwEUtTzQHnwZuizHM2gMcJboCpvvkBUE6xDkFYsRcYjw2RCrinJ/Dt8OjVFa2deiQQfvrFA+1HiWJEwmTPLDbOlk22fRbVumZPsgkO+gRl6L6s/ZliM6XdEI6xwNuYiLucD9reZU7hieI0ueiITjjCQtpMBSGZBgNhJz3CFdpynSUKB35nwFIrSn7wTQ0KggtoOkAGMzkF8Xpg8dOjEhnyTQqDotjpbnbcOWYGfH3CnRbIZ1+VRFpcy9fKW9/136N105zrmtRXG8CQMUwfoFb6qX9ScahCvJSuiFTt8iKm19rB/HeRlnJRU9UUyUhhKPtSkzbUrZU2gfg1qmpFdaqY9RnLI8YIedYjRK+QsGIX0y1w6UZtKD4MP4Q69pUxQ4Xg4duIX0YckB22bgvijhoTg0aycPngJyHgpAvBBQ5qr/zV+SpK58YsYRnHVZTwd3cXCw81XjdCRdJK6cYH1xMDdBQqzkkQoJ34zjhiSs8EVfp6YXKH+5sIMRJXGRFytAO05UPAYNvSJHfMs1NpXvh5DrB5zOPNhHaWI9p4QJLDUMl5JIeXdKeNwrcvmv/cjgY4Oum0Gs5k+Fg8M3GvjUFYRrgXEVT8lCTRdU5chNLL9iAKeFuH8rRJXWUGEGU4d0+jCMPsQMZm6klIJAufKMNfBsKVeaeD9FvYyFH+lwkCWiQMWY99hagodJPTGORiMJ5ZA1LoYr2iD45k1v72fO0hCFY8VqyFHzaU8+ha/d3tV5vHBk7E5ldiUun0SHPMio8ZR9Z5Rue+fpl7ex3uFePm6W3bOWDSr+VTa0feNL6oqymc1VflNdsHu8eDOZcZRv3Hq5mSRjnAgewdCM3d/4ilC1xU0RwVM6Arl+xTKSrENnOJBdLwQuWXrsLhlBpC9cLP5y/2LiauP6zq3S/Eikqv9Lk3Pn+QOtHpjW6HnwIQ84BrxAsOH4t8i8hB4n1GPIdfnzV4OZSwOpgW4upVsFaTo/OqUMKjQcXVnJ8Ysil50iK/JI6v9Enb7DM/E7ZBTkeDD+6lbkf1U5Uhx+/6a5mHdgYggdpMhq4xeyrQ33ORZxVYx0DhhiefnyGVxKu9CzmEgvnviAevoU6s/a59FZB4FE2UB6QfMBqiBGNUppC+wutPvlJWZh0m0rMpFRYpCflhZ1AZ+thlRyEIQZs40S1r1axdwnloa+QBmyjll0+7yDao1yBmUplA9vtAS35fObIFviQQIZ4Mmg4UtmgXUuWCn8j+FqrIifvQWfkLyKpzb2U7O0CZCPVFOhZLLn0q8LYti1QVNfqna/mkLqa4wxSzKXSwPsbatJR+HmQuHeesVvAMGQH8q086YkJWIOAGj7jIVKqVc3ALjVjqVGVrnVXrL++lpAz0VFHCFYamPbJ+6py4tMRxM7yHJi39ZBLt6OiD4C5hhhrAL6cst5Xr/6qckSXjMo498B6BMMCE/7eKEX80uvfLu+1t9GHSTqhbkDXLuKH7hKUQ2gs015zWtXCPVby1WwdM9hKMoTkeC8WziQb41GQYQ7mdZ89GG6V6B+Stjav6ivQVpHbhYgXG4hmkCo5d5uGvQVo1w2V7SryP5b/didFF6evXNlu0u4CtL5IvvCcfL15x+WgLz9cfPENymkyTo6Sk9PoNOFH0fF4zCPG4Xl0zAajQxidHI+P4Xd8g/J7uyb8T7sEdIc01K/jwXG7ivWTsuSVKiQnl5KQS+nvvkOHC96xq0LHQDDbCX5CGNsnP7KPQDChC2dL36ngjcGnuIL3LyVFvneRyYF9BGZWEXZbRAhZCw6+66u8/Ki6ADZnzDGI1/1CjVFwZ0Ea102G1vERVnSyux+tquN9pi8N3V9Jahfu+t60C383Bb+Oeub2etAvZGAXKjTDuZ4qu6ATerAcHmy3xR3ct/un1gddjXEG9LK8SCt0iv0s4WaH5cJf7EQcMne703JwLyFTW/vh6UXOvnGeW+4Owp0032rF99DM8TMKw0BcYKeSQx5aRV7EMRjzokC5XFw1R527yqHznR1jK0eOEMteFpfhANMdXVSBRJTCElLCCrvAY5VvK8Fwfr4yFrKv4eAp7GDg+r0S5Yuw/orQdSdhsw+qUBUHGp01PYrHePMmOQe9FDE09qO+vWMzVdgDN/CAI2sM65F7jlTi9gGntvI7SN1pxCricDwx5PtgQ+RtKOtjHxJXcZGVPTN/CO0HLHbHyNBn9bLkSt5BGmwOfTgTqVOo8PVPtf6gNHJlbMZkg85rsDtaJ/25d7sfcGtJ93XP0P+bRX/1ZtHyzh/u7EGeMuFsyvmQ++D0Luhy2M5JUFUmnY2jbc931aMLZSySur/HNrwPOl2v8bVvaHQX9MJgSN3R0NfUkV+pC3SHaHw0Ce2pZQBxjvfhK/jFGkP3Y3Su7gsh/ub9oHuXVje+1su7wgctEPMjFerpu3AGeEY+18q8A1V5KydXTUgl2g4rWWMHbmhmfRzY//LO1j2b3t0WvKHffiDmAnmzo67ViLqR4L3+/j1dr/8NoeFW8g==
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Employee benefits represent an employee enrolled in a particular company benefit. It includes information specific to that employee’s enrollment.
+
+Returns an array of all employee benefits enrolled for this company benefit.
+
+Benefits containing PHI are only visible to applications with the `employee_benefits:read:phi` scope.
+
+scope: `employee_benefits:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-company-benefits-company-benefit-id.ParamsDetails.json b/docs/api/get-v-1-company-benefits-company-benefit-id.ParamsDetails.json
new file mode 100644
index 000000000..53d9cbc41
--- /dev/null
+++ b/docs/api/get-v-1-company-benefits-company-benefit-id.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"schema":{"type":"string"},"name":"company_benefit_id","in":"path","required":true,"description":"The UUID of the company benefit"},{"schema":{"type":"boolean"},"in":"query","name":"with_employee_benefits","description":"Whether to return employee benefits associated with the benefit"},{"in":"query","name":"include","schema":{"type":"string","enum":["all_benefits"]},"description":"Available options:\n- all_benefits: If with_employee_benefits=true, include all effective dated benefits for each employee instead of only the current benefits."},{"name":"X-Gusto-API-Version","in":"header","required":false,"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.","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"}}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-company-benefits-company-benefit-id.RequestSchema.json b/docs/api/get-v-1-company-benefits-company-benefit-id.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-company-benefits-company-benefit-id.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-company-benefits-company-benefit-id.StatusCodes.json b/docs/api/get-v-1-company-benefits-company-benefit-id.StatusCodes.json
new file mode 100644
index 000000000..13c2ded46
--- /dev/null
+++ b/docs/api/get-v-1-company-benefits-company-benefit-id.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"Example response","content":{"application/json":{"schema":{"description":"The representation of a company benefit.","type":"object","x-examples":{"Example":{"uuid":"54e37c27-43e6-4ae5-a5b2-e29895a133be","version":"98jr3289h3298hr9329gf9egskt3kagri32qqgiqe3872","benefit_type":1,"active":true,"description":"Kaiser Permanente","source":"external","partner_name":"XYZ Corp","deletable":true,"supports_percentage_amounts":true,"responsible_for_employer_taxes":false,"responsible_for_employee_w2":false,"catch_up_type":"elective"}},"properties":{"version":{"type":"string","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."},"company_uuid":{"type":"string","description":"The UUID of the company.","readOnly":true},"uuid":{"type":"string","description":"The UUID of the company benefit.","readOnly":true},"benefit_type":{"type":"integer","description":"The type of the benefit to which the company benefit belongs (same as benefit_id).","readOnly":true},"active":{"type":"boolean","default":true,"description":"Whether this benefit is active for employee participation. Company benefits may only be deactivated if no employees are actively participating."},"description":{"type":"string","minLength":1,"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”."},"source":{"type":"string","enum":["internal","external","partnered"],"description":"The source of the company benefit. This can be \"internal\", \"external\", or \"partnered\". Company benefits created via the API default to \"external\". Certain partners can create company benefits with a source of \"partnered\".","readOnly":true},"partner_name":{"type":["string","null"],"description":"The partner name of the partner that created the company benefit. For example, \"XYZ Corp\".","readOnly":true},"deletable":{"type":"boolean","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"},"supports_percentage_amounts":{"type":"boolean","description":"Whether employee deductions and company contributions can be set as percentages of payroll for an individual employee. This is determined by the type of benefit and is not configurable by the company.","readOnly":true},"responsible_for_employer_taxes":{"type":"boolean","description":"Whether the employer is subject to pay employer taxes when an employee is on leave. Only applicable to third party sick pay benefits."},"responsible_for_employee_w2":{"type":"boolean","description":"Whether the employer is subject to file W-2 forms for an employee on leave. Only applicable to third party sick pay benefits."},"catch_up_type":{"type":["string","null"],"description":"The type of catch-up contribution for this benefit, as required by Section 603 of the SECURE 2.0 Act. Only applicable to pre-tax 401(k) and 403(b) benefits.","enum":["elective","deemed"]},"employee_benefits":{"type":"array","items":{"type":"object","properties":{"employee_uuid":{"type":"string","description":"The UUID of the employee to which the benefit belongs."},"company_benefit_uuid":{"type":"string","description":"The UUID of the company benefit."},"active":{"type":"boolean","default":true,"description":"Whether the employee benefit is active."},"deduct_as_percentage":{"type":"boolean","default":false,"description":"Whether the employee deduction amount should be treated as a percentage to be deducted from each payroll."},"employee_deduction":{"type":"string","default":"0.00","description":"The amount to be deducted, per pay period, from the employee's pay."},"company_contribution":{"type":"string","description":"The value of the company contribution"},"effective_date":{"type":"string","description":"The date when the employee benefit becomes effective. If not provided, the benefit will be effective from 1970-01-01 (unix epoch)."},"expiration_date":{"type":"string","description":"The date when the employee benefit expires. If not provided, the benefit will have no expiration date."},"contribution":{"type":"object","description":"An object representing the type and value of the company contribution.","properties":{"type":{"type":"string","description":"The company contribution scheme.\n\n\"amount\": The company contributes a fixed amount per payroll. If elective is true, the contribution is matching, dollar-for-dollar.\n\n\"percentage\": The company contributes a percentage of the payroll amount per payroll period. If elective is true, the contribution is matching, dollar-for-dollar.\n\n\"tiered\": The company contribution varies according to the size of the employee deduction."},"value":{"description":"For the `amount` and `percentage` contribution types, the value of the corresponding amount or percentage.\n\nFor the `tiered` contribution type, an array of tiers.","oneOf":[{"type":"string"},{"type":"object","properties":{"tiers":{"type":"array","description":"","items":{"type":"object","description":"A single tier of a tiered matching scheme.","properties":{"rate":{"type":"string","description":"The percentage of employee deduction within this tier the company contribution will match."},"threshold":{"type":"string","description":"Specifies the upper limit (inclusive) percentage of the employee contribution that this tier applies to.\n\nUse threshold to define each tier's end point, with tiers applied cumulatively from 0% upwards.\n\nFor example:\n\nIf the first tier has a threshold of \"3\", and `rate` of \"100\", the company will match 100% of employee contributions from 0% up to and including 3% of payroll.\n\nIf the next tier has a threshold of \"5\" and a rate of \"50\", the company will match 50% of contributions from above 3% up to and including 5% of payroll."},"threshold_delta":{"type":"string","description":"The step up difference between this tier's threshold and the previous tier's threshold. In the first tier, this is equivalent to threshold."}}}}}}]}}}}}}},"required":["uuid"],"title":"Company-Benefit-With-Employee-Benefits"},"examples":{"Example":{"value":{"uuid":"d2cec746-caee-464a-bcaf-00d93f7049c9","version":"98jr3289h3298hr9329gf9egskt3kagri32qqgiqe3872","active":true,"description":"Kaiser Permanente","source":"external","partner_name":"XYZ Corp","deletable":true,"supports_percentage_amounts":true,"responsible_for_employer_taxes":false,"responsible_for_employee_w2":false,"catch_up_type":"elective","employee_benefits":[{"employee_uuid":"ae44a0b2-3c89-41e1-91c8-5f8224a779ca","company_benefit_uuid":"d2cec746-caee-464a-bcaf-00d93f7049c9","active":true,"deduct_as_percentage":false,"employee_deduction":3,"company_contribution":0,"uuid":"9988f241-9aee-4383-bfca-eac79cf58135","contribution":{"type":"amount","value":0}}]}}}}}},"404":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided UUID is valid.\n"}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-company-benefits-company-benefit-id.api.mdx b/docs/api/get-v-1-company-benefits-company-benefit-id.api.mdx
new file mode 100644
index 000000000..cb68f57c1
--- /dev/null
+++ b/docs/api/get-v-1-company-benefits-company-benefit-id.api.mdx
@@ -0,0 +1,75 @@
+---
+id: get-v-1-company-benefits-company-benefit-id
+title: "Get a company benefit"
+description: "Company benefits represent the benefits that a company is offering to employees. This ties together a particular supported benefit with the company-specific information for the offering of that benefit."
+sidebar_label: "Get a company benefit"
+hide_title: true
+hide_table_of_contents: true
+api: eJztWutuG7kVfhWWxSI2oJF1c2wJKFBvkg2MdneD9abZ1jIUauaMhusZckJyZKuGgH2Q7svtkxSH5FykGTlOkx/FtvkTa4Y8/M79wnmg98Gq0EYGXBhYKWa4FIHZ5EBn1xSyJUQRRLRHWZ43l2h606OGrTQueyGznIkN+RoExNzYdwp0LoUGTWcPdDQY4H8R6FDxHPfTGX11z7I8BVKupD0aSmFAGFzL8jzloT3r5GeNGx6oDhPIWJvSjwlSyRVoEMZuITImjIQe19Lh6tMedZxRufwZQkN79D4AB8Pi9JDwz6LgEZ3R0wmMz8LRWTAZw/NgwuA0YKfLUQCj6fn0lA3H4yUCX4PSDsv0/Gc1Hp1Pk/Foep6o6Xg0XcVTWOlbM75lK8XHow8fVvwDjM/PRrRHPbaFAzbsURYavgY6M6qA3h6jf2FcgyJvQGVMgDB4tJaFCpEnuDegBEtpj+ZMGQFqIViGb376+z/IC6lyivRSMGyZVgfoIs+lMnqRgwpRfCtYsEwWwuhyiVcQX6awiKVaQJancgNqYdg9yi1mqT68DBZ3o2pNyEyYLIrcs0shBcfudtujuZI5KMOdLiqRPpRK00ZxsaL7QkHth4VSIAzxm1D9JgHi1NwnVwD297V/z8WKrAoewc1RYkyuZycnkQx133pCP5TZSWn5Qc42SqapfX/CI8hyaUCEm2MSS0W4iKXKvMkJksg7YiQpNB7HNYk5pFGfbtGyrSkunFk9haW3by9flnz43WjAClj0vUg3TjnbHv0sik3XaFHeNc3qBBsFQHUegUvKI/x2FMhdwsOk61yyhFSKlSZHmmVAmC5fLHh03AmqdI8KzlLKFJiwcGJWpKbbdd4lYBJQTi/l6VwTR88qszRYgu7DQ55bvfbJi13MmmRsQ6RI8QmJwFJgBiLCYyJkRUYTpsDTTzdNomJlbWIHYFuBGRd/BbEyiQ0LbVk3nhzSKvkG2XJBrdcIiJaBOAZFsiI1HKNwxdwdNwlhgjhbGZIjFM23EPGQpeRS6EIxEcJxn+xjuJNFGhGNPqBlBiZBL8ukAqJzCHnMQ5LyWyC//fKvVhz77ZdfiVT46uu0APJCSa1PiP37KkEn+u2XX63MymjXFheIIsNkhObpw2A7IkKEuaktS0f2oBh/RKMJmUCFz6sT5rRH5tUh+EsqMq+PmtMO2wkVWFtZc2bPunhzSbzhoqc06fXJC1CGcUE8SYfBUdgHWSquwcoulC5n2s0TpUyva6GKIk27Jea3Etxayq18ZhJmKkY/bpfzKkEdgNlIWp1uf9DP96ONV6GlB1GfvCwJkzuepvhKg1UDHozu3IxjCdNESAxZIDDER8RqxqaHnn9bx5BKLUxrGXIURY8wEe2Q5I6ivBMQkeWGvMb8g1bEyBsnS2vzj6XoJwukQhZBVIS2hrN4Shlh7aX4snBvvKRQHEyT+mCNuvZM26DJBOEi4mseFSytDvEuwzWJwIDKuGfQNHJEKQQE4QURShHzVaGsSvzyx3LfxyqTT7AWKLErBKMLWzmgKeRsU7+ydMldAgIZr0TKNWb/FNga+gQREl++Ih9oTglXkXWPDdE8vLVESwuxce3R4ulLsBHzFMi7YIRKy3SpuoqDz4S/V9d9UiQp7cHSCIp8xxIt0GbO7qE9KvhQcOVM6gqsMZPng3EZh65evXj7wysy6g/IBZZ/HSzlCgLD7slkMDy6PbY2OBmMj5bHDb7qnFKVqYgfMswi2x6tdFRuaWiKKcU2tEe5gaz5vGo8dovditR/Vs1VatyptfZqrJ06tCyzvlD1+EUKM2hFz7pA8wUTRq4Fa0bCxw/0bccTTqyiInGhFQsZrGeWQIzPZEwT1giFKOxluREiEiuZEWBhUsZHi7nSbHVAt7g9YDroDwad8vewdg/tIR7rjjkoLqOeQ9Hk7JnG9zvKbzrY05S/ZliK7Wl/hwyyGsfOTRYRM501WkcRi6WMjaed+l9CKDPQpCLdJ5exTRW5kmseoQSapl6m8Wq9k8dwejYIBsNgMCRHheD3BHIZJsdOQfc5dzONLwfb0gT9FLAJW4MtHCoYlrjXV6eeqhiyi+tC+H63noVgBV6lXIxxH9VjvxWa9rq/x5rwDnrEzmygPxdzMafOhud0RjrXY8tEYn6Pvuas3Vu39SYUZhmIMTDYYOIZaRzIsT8zIXYfPRLJNGUqiKUK3J8eSO3Fj4NpeHtV47rapw3Qu+AXxWm4q94PYEQ6a6Y4Yg1DqSKrcGkP0/yf0MoPVRCy9mWtoT1O+0a62Pje8fjeWs77WhTvdwGgYWjH4J55KVfVWFReXlI1ZGqZrE5zvHYQx7qZ2IRqSXNQNjlLAd/HdHa9b5rb3seyrSXRkax3xfBY9t7zPKK5WGFhwUG50aNjptJw6QYtKOrJIWfXFDvyFvZ/XLhiyQI55OMu8Fho1gxMokAnMn1CIXDlOnnQlniRo/mnPOOGHHERpoXmazju8JoK7q5ysU+s8doKDUlLaxhv7RTNQ0OrjiDmAlyKxQ3PNAERkVxyYXqu/bWa9YQiEhZZkTI/f7GJYPAVKfI7piJd2Z5vQ2f4+9KhjbnSxmFKbNKvYdi2eoy9vnUKVN9793A4GODjptBrOZPhYPDVjt52260aHDJqOyIUp/Wc8VeNnqvfgCng/jGUp3NqKTGCKP2zxzCeOogdyNhSrgGBdOE73cG3Y1CLCFLDnmbf2kCO9COOgykQISZKcwfQMOlnusFk2UznCtZcFu0VfXIp9vTZc7S4JthBrFkKrqSq99Ct/Xfj/rOdmes1sA+w1TJefHCDw4jy4iPwFx/BO26S4JVXcVBdh9gqo/OWoYrA/rohGoUQnk2eByEDCCbPJyxYhiwOBoNoOo7PBpNpOP2s64b/zduFzl7tutV2UQaTCRssR8E4PJ8GkyEMg+kwPA9O4/PRaMLOzqYho4eaqKcqb18FXT2NZ6ireRgfquMH5V0AnU7Pz+PRZBhMLZDx+ThYxiELgIVn0zA+PR+OT+nB8tLph1blwaDyhh6dDCbteuE7acg3shARmQtC5sJdx30oQGNbpMBPJCMJbsoD91ybPvmW3QLRhQLvxa5Edn0m11hL8Kg/F/ZqCFOmLY4vkb8VmGA9DPbUoPcfLHjUijSteWxVKzdLc+1SUz0wxwEPhiVfX1Ujfj/nMi5trVxfyfysv0iZIt4DcFZRlf1m5y4kqMbjzduk2JdF1bE2kzJT9dyYCL6TBvy0tTVnLked9fWEvbKwTUvrlgIEBm+ILNV3uARRLlpeg5yxDEd6ng2ck7qqj+NLrbHJaW2b4eSO6FDmdl01vjGSKDCFEu0tFondMSPv9zVt6b13ocjBcf5cXxDvl4TUB6tOE+FoGTkzCW2G+64Q+ZFBiK09WyDKucTWn/ShAIXlpofULenDM76WzLpmzbWVNaF1He8SuY31B6RXz8FYmtYAb/avsOjFmvHUTtikfaRncxGQ5qYZNkfdDP/J9UkeDu5qdPERa3iQm17aMrCewApt0MZk7MzcNC6Fm5PKh5LtnwI7bA8u3lwGf/Pp1OsnARbZ+83aFjrnSC/L0barhhFjsGR4MYCXOuVV9L5ONrJQdkHIfFMrpHDuU00J7JrGFxDPNLnOuOBZkTVpf+LtNct5UF+A/9ETDBqPjxEGXm30n2QOo8HoNBg8D4anbrJbzrAaz7fbG/zIQufAboHpTbBSsshrR/y6NvfmKlRSINegFI/ARXx/nye0/foEvf0WNnR2+PuVKoF95DsWNIqS1D7OikYLb/euXdz1bsSPksBrURlVDNmYM6Mn6+HJfog7eWiHqi1qBdS6DHeFStFcvQ2wnDsTCCLIrB20YshLyOSepB29wBUw+BoZO0C4k+YbJaNHaOb4GlnXEBaKm41F7tPwRRiC1hcFSuH6prnqyvbLtlzuWFuZJEIsTdWGWmCq49OEsk5PYQ0pYYVJcDjmfAvD8tVGG8g+5wRH4cABNvDH0o0eXOfgbvou3lzuVPMNx+lRDC76+/gK1JqH0NBH7edsKQtzYheeRHg01kmB/R3I2OoBt7ZSCaQ4VsVUYnE80+SV9xDyxg+z7L20DIus/KTqD75iZKH9PsuH0ZflqeQHSL1HYd3KeGoNyr/9c20/9ksfqU3GRIPOazDtD7b2gT/UH4j9v5D7fRVy3tsM3JuTPGXcuqUNQw8+Sl7T9bDde6G1zTqKupseTaQ2uO3hAZPyW5Vut/jYlT8YhCKusVg5kN6bxva5tdcB/lz+OFj/lcnDhuSng/2vr8IelUZdjtbs3+APxd1g4ZMUd/SDt9Bj8rHS/QCqsikWmyakEm2H5W2xLvYl5KeB/Z3Xk48ovbsY37F/txBTdN6YTbQ/E96psl6/+pFut/8GRxDy5Q==
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Company benefits represent the benefits that a company is offering to employees. This ties together a particular supported benefit with the company-specific information for the offering of that benefit.
+
+Note that company benefits can be deactivated only when no employees are enrolled.
+
+When with_employee_benefits parameter with true value is passed, employee_benefits:read scope is required to return employee_benefits.
+
+scope: `company_benefits:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-company-external-payrolls.ParamsDetails.json b/docs/api/get-v-1-company-external-payrolls.ParamsDetails.json
new file mode 100644
index 000000000..9ff053362
--- /dev/null
+++ b/docs/api/get-v-1-company-external-payrolls.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"company_uuid","in":"path","required":true,"schema":{"type":"string"},"description":"The UUID of the company"},{"name":"X-Gusto-API-Version","in":"header","required":false,"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.","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"}}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-company-external-payrolls.RequestSchema.json b/docs/api/get-v-1-company-external-payrolls.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-company-external-payrolls.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-company-external-payrolls.StatusCodes.json b/docs/api/get-v-1-company-external-payrolls.StatusCodes.json
new file mode 100644
index 000000000..90bad0f21
--- /dev/null
+++ b/docs/api/get-v-1-company-external-payrolls.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"Example response","content":{"application/json":{"schema":{"type":"array","items":{"description":"The representation of an external payroll with minimal information.","type":"object","x-tags":["External Payrolls"],"title":"External-Payroll-Basic","properties":{"uuid":{"type":"string","description":"The UUID of the external payroll.","readOnly":true},"company_uuid":{"type":"string","description":"The UUID of the company.","readOnly":true},"check_date":{"type":"string","description":"External payroll's check date.","readOnly":true},"payment_period_start_date":{"type":"string","description":"External payroll's pay period start date.","readOnly":true},"payment_period_end_date":{"type":"string","description":"External payroll's pay period end date.","readOnly":true},"status":{"type":"string","enum":["unprocessed","processed"],"description":"The status of the external payroll. The status will be `unprocessed` when the external payroll is created and transition to `processed` once tax liabilities are entered and finalized. Once in the `processed` status all actions that can edit an external payroll will be disabled.","readOnly":true}},"x-examples":{"Example":{"uuid":"c5fdae57-5483-4529-9aae-f0edceed92d4","company_uuid":"bcb305b0-2855-4025-8d22-e484a9e6b7c9","check_date":"2022-06-03","payment_period_start_date":"2022-05-15","payment_period_end_date":"2022-05-30"}},"required":["uuid"]}},"examples":{"Example":{"value":[{"uuid":"c5fdae57-5483-4529-9aae-f0edceed92d4","company_uuid":"bcb305b0-2855-4025-8d22-e484a9e6b7c9","check_date":"2022-06-03","payment_period_start_date":"2022-05-15","payment_period_end_date":"2022-05-30","status":"unprocessed"}]}}}}},"404":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided UUID is valid.\n"}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-company-external-payrolls.api.mdx b/docs/api/get-v-1-company-external-payrolls.api.mdx
new file mode 100644
index 000000000..c92590a97
--- /dev/null
+++ b/docs/api/get-v-1-company-external-payrolls.api.mdx
@@ -0,0 +1,71 @@
+---
+id: get-v-1-company-external-payrolls
+title: "Get external payrolls for a company"
+description: "Get an external payroll for a given company."
+sidebar_label: "Get external payrolls for a company"
+hide_title: true
+hide_table_of_contents: true
+api: eJzdV0tz2zYQ/isoekgyQ0qyLCU2T3VrN+NDGk8ebWdsjb0iVhJiEGAAUJGq4X/vLEhK1Mtt+rjEF9vEvrHf7ocVX8TTwnkTS+1xasFLo2O/zJEntxyzMQqBgo8i7mHq6NvVwqPVoNgNLK1RytGhybFSvRY84VP08fwkTk2Wg17GWGvEeaMR8RwsZOjRks0V15AhT3itcV8UUvCIS80TnoOf8Yhb/FxIi4In3hYYcZfOMAOerHgVLHfeSj3lZcQFutTKnMLhCf8wQ/bx4/UlMxPmZ8hqH7yM1m5/j1+HElzcXMe/onWkWHufIQi0W/4noBzuermkXDKp0QUnAjzGY3Ao2MXNNZtXRhk4Z1IJHgX7Iv2MLU1hg0AKSnXY9YRpo5FJx3Jr5lKgiCoZyHMl01DhZ47dZlLLrMjatkfPZ97nLul2hUldJ9xpJzVZt7nDpvrhvAu5jGtNqaff1wbj1ucXFEbhUHT48WpHHHWRUVv0e/1h3HsZnwypHwROoFCeJ+3vZTnaLdtr9Aw0azqE1TGyibEM2FTOUTcX1rnTd9qlJseEPTQK901LJRZBPIR7crnRDh0F2+/16Ne2z6sFZLlC1kjyiKdGe9SeZFuV7n5ypLDazx6shSW1iMfM7XuglrOYW3SofTBFzXcoz9AFofigmNQTY7MgTzWvfZnxJ0w9j/gifhKCXnqFIb0abfVh/CM4mRLkLKHUy6o0AWIH7vNp8Owm0AkVB/FWq2WFzDLaRvFXu2iu+6DlGaaP9wSuv7Z7tRPqM8eCesDmQes5LDPU/j5HK424dx6s/+fOcliyyhILlv62X9TiP/GKWhz36Tz4wj0F6ELn1qToHIqqeeq/9zBMF1iZO9olrCXzRSrFxsgeWg4e2JcZ6oO6NIVSi2FmghbMW9BOBkx5wx5aJoxOkXlYMCVhLJWkTmdgkaH2aGv1idSg5B8oOoy9JQVZuW0bqgMFpRik5IlmOniWEoKFPDyxmrSEdDBW1dTcqXpJGMZq+oTS15NoA0eeDicCcPgqHg7OTuPBsH8enwNgPOmhSBHFeV8M+C7C+Dgdn/aG417cPxsO4wFN3DPR78c4OBvAOb4cv0rP+TZ6aC73aS73TvmTnV8LDmmAP9Gqa7HTHqdEN+vytsptRF+PJD8HVWDgAd9SGTYg28JSOSrpJ+KD3mB/dfxiPPvZFFqwO83Yna5WyecCHQHAojOFTZEJg45p4xkupPMd9gYekbnCYmjmhjxUc1U6NgclRedO86oHXY7wiOCW8dSaIucJb9r5ZsPQ2mLEk2IzR2ulwIrg0aRYeNREFSoO94hLnhynk9H6mlu0kkhYo7cb1VphP7rDattRbtQpWqIeGfqZEevwA7FMeHd+0q0aSaLrrto9VXb3eAbdKtp5w1sLq4gk1swLclkRr1hgFtjX3si+xMzsFLeyF4cWJr2Q3RHDB23eWCOesJnTMeXvMC2s9MsQ+U9VnhcpteVFQaW4HbWl3hPpqaB6QHa9NyjEhiDS/2MEGwjzdoy1iVjhHBWDws9Q+5pnEWd/v3Qes3/jobJwxEFJdH5igtWaJwXKTwyaOqUm/Vt0NeJE6d3byXu0c5li6z427BrGpvDdINgV5Jo4Vhz+j80k3AOp7gb7G6rUZEgrLMTxzLGrGhQNqQvkXpi0yBoS+V3NVCENTLV+vFw2Xtk7VEGOmhQzkCo0VH36w6Z/qBq5cT4D3bJDVHx3q7maiDdvpp00Vhvi/D8w+fr6PS58N1cgQ58EXKxq7N7y+cl6DRCvjXiy84TcB/Ao4jPjPGmvVvRE+2hVWdLnzwVaAseIRoeVtMYDVJqVfvjp1y7C83f12nvBjj07j+TVPCyCRDO4eFRPua2kylEZNe/SrwvvG3+kHixsVcDDL/x1nTf7hCZQ7ltne+/BrU3y+uoDL8s/ATHC/lE=
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Get an external payroll for a given company.
+
+scope: `external_payrolls:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-company-finish-onboarding.ParamsDetails.json b/docs/api/get-v-1-company-finish-onboarding.ParamsDetails.json
new file mode 100644
index 000000000..79edf67e0
--- /dev/null
+++ b/docs/api/get-v-1-company-finish-onboarding.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"company_uuid","in":"path","description":"The UUID of the company","example":"7b1d0df1-6403-4a06-8768-c1dd7d24d27a","required":true,"schema":{"type":"string"}},{"name":"X-Gusto-API-Version","in":"header","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"},"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."}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-company-finish-onboarding.RequestSchema.json b/docs/api/get-v-1-company-finish-onboarding.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-company-finish-onboarding.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-company-finish-onboarding.StatusCodes.json b/docs/api/get-v-1-company-finish-onboarding.StatusCodes.json
new file mode 100644
index 000000000..2b6d8000b
--- /dev/null
+++ b/docs/api/get-v-1-company-finish-onboarding.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"description":"The representation of a company's onboarding status","type":"object","title":"Company-Onboarding-Status","x-examples":{"Example":{"uuid":"c44d66dc-c41b-4a60-9e25-5e93ff8583f2","onboarding_completed":false,"onboarding_steps":[{"title":"Add Your Company's Addresses","id":"add_addresses","required":true,"completed":true,"completed_at":"2025-02-18T10:00:00Z","skippable":false,"requirements":[]},{"title":"Add Your Employees","id":"add_employees","required":true,"completed":true,"completed_at":"2025-02-18T10:00:00Z","skippable":true,"requirements":["add_addresses"]},{"title":"Enter Your Federal Tax Information","id":"federal_tax_setup","required":true,"completed":true,"completed_at":"2025-02-18T10:00:00Z","skippable":false,"requirements":["add_addresses","add_employees"]},{"title":"Add Your Bank Account","id":"add_bank_info","required":true,"completed":true,"completed_at":"2025-02-18T10:00:00Z","skippable":false,"requirements":[]},{"title":"Select a Pay Schedule","id":"payroll_schedule","required":true,"completed":false,"completed_at":null,"skippable":false,"requirements":[]},{"title":"Sign Documents","id":"sign_all_forms","required":true,"completed":false,"completed_at":null,"skippable":false,"requirements":["add_employees","federal_tax_setup","state_setup","add_bank_info","payroll_schedule"]},{"title":"Verify Your Bank Account","id":"verify_bank_info","required":true,"completed":false,"completed_at":null,"skippable":false,"requirements":["add_bank_info"]}]}},"x-tags":["Companies"],"properties":{"uuid":{"type":"string","description":"the UUID of the company"},"onboarding_completed":{"type":"boolean","description":"a boolean flag for the company's onboarding status"},"onboarding_steps":{"type":"array","description":"a list of company onboarding steps","items":{"title":"Onboarding step","type":"object","properties":{"title":{"type":"string","description":"The display name of the onboarding step"},"id":{"type":"string","description":"The string identifier for each onboarding step","enum":["add_addresses","federal_tax_setup","select_industry","add_bank_info","add_employees","state_setup","payroll_schedule","sign_all_forms","verify_bank_info","external_payroll"]},"required":{"type":"boolean","description":"The boolean flag indicating whether the step is required or optional"},"completed":{"type":"boolean","description":"The boolean flag indicating whether the step is completed or not."},"completed_at":{"type":["string","null"],"description":"The ISO 8601 timestamp indicating when the onboarding step was completed."},"skippable":{"type":"boolean","description":"The boolean flag indicating whether the step can be skipped or not."},"requirements":{"type":"array","description":"A list of onboarding steps that are required to be completed in order to proceed with the current onboarding step.","items":{"type":"string","enum":["add_addresses","federal_tax_setup","select_industry","add_bank_info","add_employees","state_setup","payroll_schedule","sign_all_forms","verify_bank_info","external_payroll"]}}}}}},"required":["uuid"]}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided ID/UUID is valid.","type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["error_key","category"],"properties":{"error_key":{"type":"string","description":"Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error."},"category":{"type":"string","description":"Specifies the type of error. The category provides error groupings and can be used to build custom error handling in your integration."},"message":{"type":"string","description":"Provides details about the error - generally this message can be surfaced to an end user."}}}}},"x-examples":{"not_found":{"errors":[{"error_key":"request","category":"not_found","message":"The requested resource was not found."}]}},"title":"Not-Found-Error-Object"}}}},"422":{"description":"Unprocessable Entity\n\nThis 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.\n","content":{"application/json":{"schema":{"description":"Unprocessable Entity\n \nThis 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.\n","type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["error_key","category"],"properties":{"error_key":{"type":"string","description":"Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error."},"category":{"type":"string","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."},"message":{"type":"string","description":"Provides details about the error - generally this message can be surfaced to an end user."},"metadata":{"type":"object","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.","oneOf":[{"type":"object","description":"multiple entities","required":["entities"],"properties":{"entities":{"type":"array","items":{"type":"object","description":"single entity","additionalProperties":true,"properties":{"entity_type":{"type":"string","description":"Name of the entity that the error corresponds to."},"entity_uuid":{"type":"string","description":"Unique identifier for the entity."},"valid_from":{"type":["string","null"]},"valid_up_to":{"type":["string","null"]},"key":{"type":["string","null"]},"state":{"type":["string","null"]}},"title":"Metadata-With-One-Entity"}}},"title":"Metadata-With-Multiple-Entities"},{"type":"object","description":"single entity","additionalProperties":true,"properties":{"entity_type":{"type":"string","description":"Name of the entity that the error corresponds to."},"entity_uuid":{"type":"string","description":"Unique identifier for the entity."},"valid_from":{"type":["string","null"]},"valid_up_to":{"type":["string","null"]},"key":{"type":["string","null"]},"state":{"type":["string","null"]}},"title":"Metadata-With-One-Entity"}]},"errors":{"type":"array","description":"Will only exist if category is `nested_errors`. It is possible to have multiple levels of nested errors.","items":"circular(Entity-Error-Object)"}},"title":"Entity-Error-Object"}}},"x-examples":{"bank_account_delete_unfunded_payments":{"errors":[{"error_key":"base","category":"invalid_operation","message":"FundingMethod has unfunded payments"}]},"bank_account_verify_incorrect_deposits":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Your bank account cannot be verified. Please check the test deposit amounts."}]},"bank_account_verify_already_verified":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Your bank account has already been verified."}]},"bank_account_missing_routing":{"errors":[{"error_key":"routing_number","category":"invalid_attribute_value","message":"Routing number is required."}]},"payment_configs_missing_parameter":{"errors":[{"error_key":"base","category":"missing_parameter","message":"At least one parameter must be provided"}]},"payment_configs_invalid_fast_payment_limit":{"errors":[{"error_key":"fast_payment_limit","category":"invalid_attribute_value","message":"Fast payment limit should be a number"}]},"pay_periods_invalid_end_date":{"errors":[{"error_key":"end_date","category":"invalid_parameter","message":"End date cannot be more than 3 months in future"}]},"company_industry_selection_naics_code_required":{"errors":[{"error_key":"naics_code","category":"invalid_attribute_value","message":"Naics code is required."}]},"company_industry_selection_naics_code_invalid":{"errors":[{"error_key":"naics_code","category":"invalid_attribute_value","message":"Naics code must be equal to 6 digits."}]},"company_industry_selection_sics_codes_invalid":{"errors":[{"error_key":"sic_codes","category":"invalid_attribute_value","message":"Sic codes must be equal to 4 digits"}]},"time_off_policy_name_required":{"errors":[{"error_key":"name","category":"invalid_attribute_value","message":"Name is required."}]},"time_off_policy_unlimited_invalid_accrual_rate":{"errors":[{"error_key":"accrual_rate","category":"invalid_operation","message":"Accrual rate must be blank for unlimited policies."}]},"time_off_policy_pending_requests":{"errors":[{"error_key":"time_off_policy","category":"invalid_operation","message":"Cannot deactivate policy with pending time off requests."}]},"time_off_policy_employees_required":{"errors":[{"error_key":"employees","category":"invalid_attribute_value","message":"Employees are required."}]},"time_off_policy_unlimited_balance_update":{"errors":[{"error_key":"base","category":"invalid_attribute_value","message":"Can not adjust balances for unlimited policies."}]},"holiday_pay_policy_already_exists":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Company already has a holiday pay policy."}]},"holiday_pay_policy_not_exists":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Company does not have a holiday pay policy, please create one"}]},"holiday_pay_policy_invalid_employees":{"errors":[{"error_key":"employees","category":"invalid_attribute_value","message":"Invalid employee uuids provided."}]},"onboarded_employee":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Cannot delete onboarded employee"}]},"invalid_attribute":{"errors":[{"error_key":"base","category":"invalid_operation","message":"There is an error in the request body."}]},"company_cannot_enable_contractor_only":{"errors":[{"error_key":"contractor_only","category":"invalid_attribute_value","message":"Contractor only cannot be enabled for existing companies."}]},"company_missing_parameter":{"errors":[{"error_key":"base","category":"missing_parameter","message":"contractor_only is required."}]},"starting_after_uuid_invalid":{"errors":[{"error_key":"starting_after_uuid","category":"invalid_attribute_value","message":"Parameter 'starting_after_uuid' does not correspond to a valid event."}]},"resource_uuid_invalid":{"errors":[{"error_key":"resource_uuid","category":"invalid_attribute_value","message":"Parameter 'resource_uuid' does not correspond to a valid resource."}]},"payroll_gross_up_invalid_net_pay":{"errors":[{"error_key":"net_pay","category":"invalid_attribute_value","message":"Net pay must be a number."}]},"payroll_accruing_hours_invalid":{"errors":[{"error_key":"base","category":"invalid_attribute_value","message":"Hours cannot be negative."}]},"payroll_cannot_cancel":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Payroll cannot be canceled."}]},"frozen_payroll":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This payroll has already been processed. Its data cannot be updated or altered."}]},"frozen_payroll_processing":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This payroll is being processed and cannot be updated at this time."}]},"unmodifiable_payroll_type":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This type of payroll cannot be modified or processed. It is reserved for system processes."}]},"invalid_employee_uuids_format":{"errors":[{"error_key":"employee_uuids","category":"invalid_attribute_value","message":"Parameter employee_uuids must be an array."}]},"maximum_employee_uuids_surpassed":{"errors":[{"error_key":"employee_uuids","category":"invalid_attribute_value","message":"Exceeded maximum of 100 for lookup."}]},"invalid_employee_uuid":{"errors":[{"error_key":"employee_uuids","category":"invalid_attribute_value","message":"Invalid Employee UUID(s).","metadata":{"entities":[{"entity_type":"Employee","entity_uuid":"invalid-uuid-123"}]}}]},"payroll_blocker_missing_bank_info":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must have a bank account in order to run payroll.","metadata":{"key":"missing_bank_info"}}]},"payroll_blocker_missing_employee_setup":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must add employees in order to run payroll.","metadata":{"key":"missing_employee_setup"}}]},"payroll_blocker_missing_federal_tax_setup":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must complete federal tax setup in order to run payroll.","metadata":{"key":"missing_federal_tax_setup"}}]},"payroll_blocker_missing_bank_verification":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company bank account must be verified in order to run payroll.","metadata":{"key":"missing_bank_verification"}}]},"payroll_blocker_suspended":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company is suspended and cannot run payroll.","metadata":{"key":"suspended"}}]},"submission_blocker_missing_selection":{"errors":[{"error_key":"submission_blockers","category":"invalid_attribute_value","message":"Submission blockers selections required"}]},"submission_blocker_invalid_option":{"errors":[{"error_key":"submission_blockers","category":"nested_errors","metadata":{"blocker_type":"fast_ach_threshold_exceeded"},"errors":[{"error_key":"selected_option","category":"invalid_attribute_value","message":"Selection is not available to resolve Fast ACH Threshold Exceeded. Please choose one of Wire In, Move To Four Day"}]}]},"invalid_version":{"errors":[{"error_key":"base","category":"invalid_resource_version","message":"You are attempting to update a resource using an out-of-date version."}]},"signatory_email_required":{"errors":[{"error_key":"email","category":"invalid_attribute_value","message":"Email is required"}]},"signatory_company_already_has_signatory":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Cannot have more than one signatory in a company. Please remove the existing signatory before adding a new one."}]},"mixed_disbursement_errors":{"errors":[{"error_key":"disbursements","category":"nested_errors","metadata":{"contractor_payment_uuid":"invalid-uuid-1"},"errors":[{"error_key":"contractor_payment_uuid","category":"not_found","message":"Disbursement not found."}]},{"error_key":"disbursements","category":"nested_errors","metadata":{"contractor_payment_uuid":"d0dfa222-ad08-4ea7-a06a-717688c3b179"},"errors":[{"error_key":"payment_method","category":"invalid_attribute_value","message":"Payment method must be one of: Direct Deposit, Check."},{"error_key":"payment_status","category":"invalid_attribute_value","message":"Payment status is not valid for payment method 'InvalidMethod'."}]}]},"not_found":{"errors":[{"error_key":"request","category":"not_found","message":"The requested resource was not found."}]},"finish_onboarding_incomplete":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Company is not ready to exit onboarding."}]},"company_location_validation":{"errors":[{"error_key":"street_1","category":"invalid_attribute_value","message":"Must include a street address"},{"error_key":"city","category":"invalid_attribute_value","message":"Must include a city"},{"error_key":"state","category":"invalid_attribute_value","message":"State is in the wrong format"},{"error_key":"zip","category":"invalid_attribute_value","message":"Please enter a valid zip code (e.g. 12345)."},{"error_key":"phone_number","category":"invalid_attribute_value","message":"Phone number must be 10 digits"}]},"conflict":{"errors":[{"error_key":"request","category":"duplicate_operation","message":"A resource with these attributes already exists."}]},"invalid_parameter":{"errors":[{"error_key":"request","category":"invalid_parameter","message":"The provided parameter is invalid or missing."}]},"flow_invalid_entity":{"errors":[{"error_key":"entity_type","category":"invalid_attribute_value","message":"Invalid flow entity"},{"error_key":"entity_uuid","category":"invalid_attribute_value","message":"Invalid flow entity"}]},"flow_nested_options_errors":{"errors":[{"error_key":"options","category":"nested_errors","metadata":{"flow_type":"company_forms"},"errors":[{"error_key":"form_types","category":"invalid_attribute_value","message":"Supplied value 'invalid' contains no permitted values"}]}]},"basic":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must complete all onboarding requirements in order to run payroll.","metadata":{"key":"needs_onboarding"}}]},"contractor_payment_invalid_wage":{"errors":[{"error_key":"wage","category":"invalid_attribute_value","message":"Wage must be greater than or equal to 0."}]},"contractor_payment_cannot_cancel":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Payment has already been processed and cannot be cancelled. Contact support directly."}]},"time_off_request_cannot_delete":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This time off request cannot be deleted."}]},"resource":{"errors":[{"error_key":"first_name","category":"invalid_attribute_value","message":"First name is required"},{"error_key":"date_of_birth","category":"invalid_attribute_value","message":"Date of birth is not a valid date"}]},"nested":{"errors":[{"error_key":"contractor_payments","category":"nested_errors","metadata":{"contractor_uuid":"72ae4617-daa9-4ed7-85e0-18ed5d0ee835"},"errors":[{"error_key":"hours","category":"invalid_attribute_value","message":"Ella Fitzgerald is paid fixed wage and hours cannot be set on a contractor payment"}]},{"error_key":"contractor_payments","category":"nested_errors","metadata":{"contractor_uuid":"2d7bf62c-babf-4a12-8292-340e2d9cab28"},"errors":[{"error_key":"wage","category":"invalid_attribute_value","message":"Isaiah Berlin is paid hourly and wage cannot be set on a contractor payment"}]}]},"compensation_invalid_rate":{"errors":[{"error_key":"rate","category":"invalid_attribute_value","message":"Rate is not a valid number"}]},"compensation_invalid_payment_unit":{"errors":[{"error_key":"payment_unit","category":"invalid_attribute_value","message":"Payment unit must be one of Hour, Week, Month, or Year"}]},"compensation_already_processed":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Compensation has already been processed on payroll."}]}},"title":"Unprocessable-Entity-Error-Object"}}}}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-company-finish-onboarding.api.mdx b/docs/api/get-v-1-company-finish-onboarding.api.mdx
new file mode 100644
index 000000000..25d820e35
--- /dev/null
+++ b/docs/api/get-v-1-company-finish-onboarding.api.mdx
@@ -0,0 +1,85 @@
+---
+id: get-v-1-company-finish-onboarding
+title: "Finish company onboarding"
+description: "Finalize a company's onboarding process."
+sidebar_label: "Finish company onboarding"
+hide_title: true
+hide_table_of_contents: true
+api: eJztXG1zGzmO/iu8ng9OqtSyrPgt+nTeOLn1h0xcE2dze06qTTUhieMW2UOyZSsu//cr8KXf1JItx7692ZqpnZq1mgQfggAIgCDvIg1pobhZRqPLu+idnOdULE/SFLQ+KcwsGl1+v//eixjoVPHccCmiUfSBC5rxH0AoSV2PHU2kGEuqGBdTkiuJBPrfxDfxyy+/kJM8V3JRa064IAzmEhucTAyo+idNJlxwPQNWo9kj/1VoI4mCPwquQBMqCGWMIyKaEW0gJ/bzgsMNoYIR6gc1M2oC8f43cTGDcqgaZG2oKTQO/i2qfk6wZQYG2LdoRCY009AjhTA8I2YG5OT8jKQ0y7DbnDJABA57GOKbqIj1yZlA1rAiRdQExIIrKeYgjO4RM+PaTYPrMEtGJlIRxfV1TAXNlpprkhcqlxocc78CElxwHHoGBATLJReGXJ1/uSA7u4u9XYeDg96985CSouDsftezZ+fKgqYpz7ihpuKN+04zjWuFxHG96pgtgKurKz2DLPsmOkY8fnt0tEcnx/H47eF+vH80hPh4cLgfHxzss8k4HR8csrclDisr5DfQuRQaRuRdWKPx75CaHrnhpuRq4lZrRHa8ZLEdCwVp6FTmMCJXJYzRjeIGrqJedBtPUYZiLgxMFcVFiM0yh2h0GcF8DIwBi773IpmD+3rGolE0BRMv9mI/dOzWN66WNepFOVV0DgaUtlok6ByiUVTnd9SLOGpOTs0saqsTiuSXL2enRE4sp33HqBfBLUX5i0bR0XiPDdhkLz7cH7yJ9+ngMD4+OjyO0z3Gjthwnw2PaNSLguBEI6MK6EU6ncGcRqO7yE000kYh5vv7Xonzv2OrWvHJ+Vn8D1AaQXm4M6AMVLSeTi8CUcyRgcPB8CAeHMZ7B5G1FxNaZCYa1X+/b0/8FHk25wK0kzBqIB5TDcxq1sJhIVRrmXJqgDkhWMpClarXJ2cTIqQAVBuvC6zn2tA8z3hqV3JHk8s5F3xezOu0v7+aGZPr0e4uk6nuW/Hop3K+G8QhzulSySyz33dpzmPfk4vpL55gXPv5NcIoNLB+hGYzSJzSN3Qa1kR5GdfIzuFggP9p8uVzYQ1w1ItSKQwIg01qs9n9XWO7u9qyrEqUglyBBmFsF5StNdbaKVPUC0vrNA7/5sbKnlfF+FPZJ/4c+tzGXkbtbN4Heb2LrNSPonR/nx0esjRO9/fG8T49HMRvYXgQH8DbN5PJ8cHxm8kw6nWa3GjkDG79IxpIp2QB3Alj5J+42u/KuZ0wpkAjg3uRBUEZS2jtx7aW1IZs/ZDQSoaH8d7xxd5gNMD//Q8qxTXPczpGGB6pJ2xNut06ex1A38/zTC6hCQ9qPz4/vCB4DXQttjTAvhe4KVu4H4CBohm5oLfkTEykmluBCuAn7nNi6G2iwRT5/yF/Vxa2yclu9v+NimtykqayEKa+AmMqrhMuJvJfJSCfIYPUEErO6ZJ8TmfAigwCQm+HEl39vgGkH62JUhRZtjUmPhXkVKaF++rBaD4VCc2yBKXhAYn9GSgrmtElbGi+oPyrvZIrfGtM7x+g+GS5Xi4W9vtjReOnp1qN8/3++/09WldDp/bzu+DO4O6aK3RRDHdG11na1Z25uSWYNU7G/TrjWxIcS5kBFSsUKfFfyCSjU+uq1gh37jH3Xca8HIgqRZcdw2RcG4Td6bYjiV7EDcwdKb+yn5ptOna3JhN9v4e4iBsr4zrP6JKg+xS42YKEE33MoiA594lwBsLwCQdlOQk0na1QrbyttuHrVAxrTxIuWKGNWnYoR1u9mqrUYXJWFL9DQeDWgBI0S3x/1Lia1jwoVsiThmBxwazfI6bkZgZmBk7OVmIlqYjMXTyI/N9GlLcds6SNgwpp+o0Brd6HMS+rtUdTEK0E0zj22edP5PhwsEcMn4M2dJ63EIguKSM3tAbFYqjZmeeddEoFGQOx9JvTbhqyB5T5pFTmthK7OJ0qqBbUSByy4jUXRCqGqKRLMYSIwJqdQikQpk233zAOa2KXP5c22X/qKnXptoDv7vf9wf5qQPCrNOSDLAR7ekxRkiDfBCEukYIYQOPaKNCyUCkQJkGjbBC45dr0yUd6DUQXymUoQoRGzk537W7ENVnQjLN+h4WuzxCUkqpj8/O/r8pde9HXU02uATuk1MBUquWaMWyrBw365xxSNOIaNcjP2XYnMk0LpfvkYplzDFyXLuNzDcvK9LswmBqj+LgwsFvmFYiCzAbARlYkndEJqLeAhhSwLaqho0RsVsyTCoukPfKpkkXOxVTbtJo3BBjjWgUteMZIilHu3LefUcEyu6UJF4fX8i0W8xy0ptNH7LbnAQgDQ3mmCR3LwtSYGpMpCFTVwE5PujRXhZrQ1CGlmHFjCBw553SlGb0KaZKJVZKaYF021j/yEl+Xl1GtY21y0RoFQaON+mE7YJoAgQS35VdpYqtk8XscNP7kpNZr9nC4qpZfhM+2otUn74XhZol5sAvLDrokM5rnIKpNZCzZElfeLo3HR9AmUC78kmuii3RGqCZXXFj1TEqhTBY0K+CqR7y7FyhM7AKxAjyvy55lNu2qTz6DU4nL926Yd46HHPSWmRgLM07L7q/JtMAsKLpOc6kgSEz/m3i6xetmrbN9fzE3MPcvq/3vb7UxyVoOxDW5EtaoJW4dr3rOO7VrRW54lgWRJ5S4luTKNyV+kZbOcwOrVF4x/t9sDojCUEYN7RLFJox3QbkVZLCgwmAamyJNLyBLr8ne/HNBrE5jTtaaDW+Rxhn0yQeM/NyO1GuQsPgsq67cfxNEdWXXNvyCTuCVY/+48rT6NrsKnyYua7pxLvMiMzzPwI3FW8nIy6j8eVXZwpctVLo5tuZiGkb23rU/3DuvjeRyLh1jO4Y8LDW/1oJ2z1EbeFRik0rlMvRMEyOtNNQY/PAIXwT/o4B2PF+NZyk66z1Rcr4hUizbFXli5OaGDTvX1cBGI5ua1LyQj17646/czOJPAmK3+UX361t99LLjmuLS2ETbX2v+p19zpLR2w27y4SsaHymypYv+CN+4bfTJmbHHdlJrji6WkWRGF0BKO5TBAjKNa+e3kbBRlGYlSrlKi4yqVw5uw29+HdVn2NEg6ogCbPRNXR44YYCph6QQk0IwYBiFl4mONRECHmA2w4MVZ60RJnwoBGYrPoKZSUZmVJMwGilHs2vQAOZTBVxY0U0RaS41f1ZkNi2OoxI/Ku6cGLqMgdjxObA+Oc+AaiDpDNJr56Sgx+rhEDrHjrq/fgo0U0DZMgkUX3QCyF4/IBkDiGoeHQDnXKOFSpQsMCm2KSp0LRJRzMf2vLwDYsvJbwD9zfUnrn89q+lxeUlIUikmfKpLaKWvuRXXVnvXwZwYgkuKqTQglTM7L7SpOxbdwMJsJ1SboC1JxufcbEDY0XhrFn5AxJ4GsTSInskiY4iZes6WmJMcFJeswguCJcxbyzUoyyad2Lp5+V4wW9ZQ0xwbQZkZFeQNmUthZrbCZlKYQoHDFwpHQq4xcblHLkUiKE91kkoGST2lvgZx1Xp7fv6KfQn27RDHxyH0w7w8wCCa8EdBM9xFDgnjU16anQ1wdQCgHwFX89S13R7tZ55arHoV7L4H67DiCUAiJ5MklxlPlwmeMj1uredPYuK8a33bIAphNQpYqS80TVVBs0Rt1plGsy0s94nrR7BfybFxhqYcPasSD7EAOeg1wHOwm2viEymbdsdW123QvnPKzYCmhi8QsqPhYlyPwZ7tEDmZhKzOOszlGcJjlr1+4LDl2pd1KI1TlwclYEwzKlJIivwBe7l+t96E6h0VNj1K2e922d1oevOyz2TGGVp1/NcBDm6FdUSf0ysKhYnBjbAuBfEIcAfyi78eGqaLXwxWef5iPekuYD2Se5dNAcqqFLAWark9lmL2IqJ45tqQQIJg2KVrOQyLzx/tQQXnOfkXdBgdflIOVUJyEFYm84wILmzukdvSZheW+srbkAXG5HJrR3NuRQIC80fohBlFUyNVgkHYBmztlturaUnAxXuVf+OwuNJlK+Vo+8pq3Bb+l/RjW3Ps2Oa0ocr67RRr0G2s/xgvYLXX9vw7L/3qnQ56O5UaV6kJm6ckXlEWWIHtZhFSi4/F32j/U8gblB7EHFpXIY09EJ8qqTWmO8LgAmwwsMnX8S22d3fAxgilRxHighYk67XgisxkoR7jGD5tq/s7Uq9pjoApNXzRZpDX8RT3wewZ7c25o18D4IYo1WOi5A8QZeXBc1o6zPr44VdCcn/ohrmFM6NdOr3C6NwOW4FCMwNqDdrEU9kct/8UcK7JGGrXXYCFo5YWVJtq5No6gB5sIeaS8Qm3ZjtADtnM5wQbTozylcV2ABwnGyx3hlKDWngrrpfawLxsFGx42zewVkAnrkL4EX6Ca/8zBqhJqdJqQWx60uOc01ss02/j1IXKKc75BaG+v8UiJWDEY8CV2BsMLFczKa+LfBMvXxBYcLhCDGBLQ1/p1/2oefZVnetctpLuZfgQtXLlYfwY/4z3hm9siUPdoI0zmV6DKjf/qt5pG+FvUet0hq1EeEe4kQesl5KpQgT1aE/fjb2Kc/N8ysVxtV8vMinKKtdUP206LZib57RaEvci0wrFfsSPRwy9JXa8p81xFfYjRNHlhF2RyLNPsyGGwWKFLPRPyGUDdPckdaExF7Fliv0xk8Kri4F4fRN8cAoVJAdZF2M7KylWlqbM2W1yzVe6PyVVVxIhgQgpB69iiGgd4GpX/lm0jeOyFv/CaN4a2xQ6TWeJmSnQM5mxBPzmE9XO79oI7LSgxLo9rwJfUARs2mZBeUb9YR56/NkCiM3Nn7z7O7kI4EjYGWvnR1Jqm4zATfIrV0DORI98xCu8FxIrTxU5pfY4sr5h+nt3T3KbyvBlUd56bJwd2bwYNQbmuQ1ijfQuHaFVPUeBwokuhyxMLCex/e4JhjCTTwU1UmFqj/LscWk9yrOnpPQoz+qBbhtAiLtDdmxGdVJ+ff5sijvNLQ88cHHL0YgtDwoXs4MYKJi7S9tQJQ+qLmOYIDGsE0CmEwE3SDQ4evwWWMK4HhdK24L0oDrrJ1ZvvYX21XIL4dyq0/vZoHvrSDyisvS0BrpVS9p74enhJWQ6HA5jygbH8T7Qo5gODml8tHd0eHycvhnvHb3dMOlAbW5Pu5/i+7sDPte/3D+d1RiRU45n4eTUHT73yDs8lO5Hba4EFOXN1yeiqB4NwEVwHjW69nkT5Y73tt0R/04/2LB/Vb1xL3KX2JPaXSwsJHCu1wvkpD2DXIxvJGp2/aJGKyeYSefFJJb0Q16YNgrAJHvbr+JHFB4u0qxgaNEdIeLvgazITOpKlH5uDEukTdlV6Wy/9drnGnj5PsONksLewsPouz3GD54/QcydSQbhHuhw8v2D5+7Q9RX0p32yN3yzf/C6Q8VmUsCT6yHOsXeohghKvjdoHJRixUHG002Zhk7lYYWrAId1R4811fGXi3StvLdKVrkjnFYA/5hEdieszXUEF/W7M1VNhl19ty5Ym+085aDjmbyplTfYWq5NxQ1VbP/kbAIOGar52gJRzxE8zwDlJP1O5nxY/fCe7xs+fju0o3hHO1gpd2dr/U6H322fJ0UgWBMMjNhPZMf32aluEghJcnw6w5jQSoddZUw1T184Oqe2zK+8aFe/ArhdCCsAmK7tQz4M7PA/At9ufHH4mtnZz1sz/CuWhQc7M7XHosq7rKoq1BiUG9UKuhfM0VtPYn2SvJVzdggwh09sZXpqiC7yXCpDmHWOsmX7hN+bozAHdwL67HnoVvFDDbIbkLVOszaVi3GlTfK0gpcP2Ndd3W6ESW2/2e4Pk2TMlX2wZ8tRTu25+oTY7mVo7HdQWzbhHEBrcx53TFvWgj7FiffO+9GQwv7h3lHMKH0b7wM7io8PYBDvHQM7YAOA4zcHG0yaPQ17QlCaZZR84ObHFFNxzFb8UjTmGK4RVFgrw7PWaZgG9BFtiFgeNXsmdAQ6z8ypITsaTw6HaTym40m8T/eG8fHw7TB+sz+AIXub0vHweAOnnmaFzjTldEb+BirjomQT8iVbWhbd+Nsrj+NQ8KlBaOdPl3mPzXU762u1Npawem+0Lun1ostOJGVwKTbWhzaaPTlaw96tiJHgEWyPfAW4xlSTMDN79e6fQLtQh6RJaXufOVQKA22y9rK2oTavjjZuK8Zrit1th64nRW5jnQO9BqqXMVrHWC5AKc5sbtFGi5/qL57htXShrReFM3dzXvu+mr3TULTeWUMNbvZzr2SVjfHeR73ROoBlh1Wg+AaXTzWMorywz37gC2yjaOPbeCvhsb3/rxbhgbdCZWgO/Z1KmnN3pTLGJ/LwXuXKvYhTmMuoyWRHL3ZJFfyMU11DuJPmubIJlHU08aFBO//wwCO+KDR3BVwdzzyWFztw8PDgm309AqiyPmH72pt7E8ze0CC0MDN0y8PxQy/6bM+Mf2YER2HNADbicgeGQf7d+5An52fuIQWXFa4/P9eL8LU5/WnyGdSCp1DjdHUj1l4i3LUNdxkOjeoa278xu6t915WLL5Clcm6T3hbHjibvvaSTUGeB784x/5SSncZ/+KvJ1AWx/jm+0zAq+Q2vj/pIxSWEUVT81/+sJAO5kUtt5lTU6HxoPERJGsLcAH9X3Y/+62XPv172/DO+7Okti4Fbs5tnlFsTZI3pnTf4l9HCpgjLPa8XjVoPdK5a/e9YE6sN9r67wx39i8ru7/HnPwrATf3yO24+irsXdy7vMN9uqx/LZ77Watqr37wkvCbr3//snFe4gWdbhK0v8tcBm6+OurJe94jndvD+rZ/mXMNYx8Du51BLPlceCW5uual9W3lbouF+nH+5wCuuzb2w3Pv8/6nd0W6u792da3Ehr0Hc35fLbfBv6wne/y/X0k/B
+sidebar_class_name: "put api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Finalize a company's onboarding process.
+
+### Approve a company in demo
+
+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. In production environments, this step is required for risk-analysis purposes.
+
+We provide the endpoint `PUT '/v1/companies/{company_uuid}/approve'` to facilitate company approvals in the demo environment.
+
+```shell
+PUT '/v1/companies/89771af8-b964-472e-8064-554dfbcb56d9/approve'
+
+# Response: Company object, with company_status: 'Approved'
+```
+
+scope: `companies:write`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-company-form-pdf.ParamsDetails.json b/docs/api/get-v-1-company-form-pdf.ParamsDetails.json
new file mode 100644
index 000000000..5ff6eda10
--- /dev/null
+++ b/docs/api/get-v-1-company-form-pdf.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"form_id","in":"path","required":true,"schema":{"type":"string"},"description":"The UUID of the form"},{"name":"X-Gusto-API-Version","in":"header","required":false,"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.","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"}}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-company-form-pdf.RequestSchema.json b/docs/api/get-v-1-company-form-pdf.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-company-form-pdf.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-company-form-pdf.StatusCodes.json b/docs/api/get-v-1-company-form-pdf.StatusCodes.json
new file mode 100644
index 000000000..860e6309e
--- /dev/null
+++ b/docs/api/get-v-1-company-form-pdf.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"Example response","content":{"application/json":{"schema":{"title":"Form Pdf","type":"object","properties":{"uuid":{"type":"string","description":"the UUID of the form","readOnly":true},"document_url":{"type":["string","null"],"description":"the URL of the form"},"document_content_type":{"type":["string","null"],"description":"The content type of the associated document. Most forms are PDFs with a content type of `application/pdf`. Some tax file packages will be zip files (containing PDFs) with a content type of `application/zip`. This attribute will be `null` when the document has not been prepared.","readOnly":true,"title":"Form-Document-Content-Type-Type"}},"required":["uuid"]},"examples":{"Example":{"value":{"uuid":"48cdd5ec-a4dd-4840-a424-ad79f38d8408","document_url":"https://app.gusto-demo.com/assets/forms/7757842065202782/original/company_direct_deposit20211007-48226-gsqo8k.pdf?1633667020","document_content_type":"application/pdf"}}}}}},"404":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided UUID is valid.\n"}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-company-form-pdf.api.mdx b/docs/api/get-v-1-company-form-pdf.api.mdx
new file mode 100644
index 000000000..60594ed02
--- /dev/null
+++ b/docs/api/get-v-1-company-form-pdf.api.mdx
@@ -0,0 +1,71 @@
+---
+id: get-v-1-company-form-pdf
+title: "Get a company form pdf"
+description: "Get the link to the form PDF"
+sidebar_label: "Get a company form pdf"
+hide_title: true
+hide_table_of_contents: true
+api: eJzdV11v2zYU/Ssc99AWEG3HdWJPL1vQNEWAbg2adBvgGDEtXttsJJIlKTeuof8+XFKKZcceOvRteUhs6fLcr8N7Tzb0kS1K5zWTysPCci+1Yn5tgKZjCsUMhABBJwn1fOHw2RtdGK7W5FLbwuELbSAeuxI0pQvwbHXCsmjF5toWzIg5TajhlhfgwSLMhipeAE0pGtxLQRMqFU2p4X5JE2rhSyktCJp6W0JCXbaEgtN0Q2No1Hkr1YJWCRXgMisNBkBTersE8unT1QXRc+KXQBCeVsmTu7/Zu5Dt+fUV+xOsw1O16yVwAXbH+ZznDvZdXGAOhVTgggfBPbAZdyDI+fUVWUVQwp3TmeQeBPkq/ZKsdWmDQcbzvEOu5kRpBUQ6YqxeSQEiiTbcmFxmoaAvHBkXUsmiLNrYk5dL741Lu12hM9cJ7etkuug27WKGr63O8/C+y41k9UmpFj/XgKz1+BWGUToQHXq81AkFVRbIgH6vf8p6Z+zkFNsvYM7L3NO0/byqJvtlewc+1CuX6oF4/dQdcn1xeafulMu0gZRMa+bc4zuXWuBiGnrijFYOHAbW7/Xwzy7+20demBxIY0kTmmnlQXm0bVW1+9nhgU07U+lzTPUyxBPYWievZ58h88heizz3MkZQllIcKtFuSP4QGTEXLj6ofB3JjRTWWVmA8velzbeo4y2sKvOcPqtogP/4fo/qW7Q6/fsI992weIXqowSPNPgtRjcuOuR37Xzw7Ai3gL10ke/8Gca03QMj5tMOudEFEM8fyVzmQAzPHvgCECDPyQzIN2nCG0deIhiXSODg49V3OfkmzbRDbpfSEe69lbPSwxP4FLOfkq9LUPEe1zmRJXdEaU9mAIoYC4bbeDN2+5bssIZd1MfZmxgRu10bCL9oVbVnyjiSZ1IlFCJlA6Nq+uLHFc9L2LKMDkaZEKeQMT4Qgg1Ggx7jg/6AcTH8Zf56JEaD3ojus4g2M4IbE0cEE1DEOcGdA++6oW3d4fB0OBr0e2en/V5/OOp3tZULqXjebW6ikBYyfy/AaCd9v9c/Oen1hmww6vfP2MJ90aOHjhHzX0/OXr8+Oxv2+j16lIV0jwS0Cj8JHfQGz+/0H9qTS10qQe4UIXcKqYmVBIcstOB0aTNsHcSWwaN0SEr+AMSVFkJjm/kar6J0ZMVzKTp3KjTmkTkD/AG4WzPcEUyvwFopIO6yOAzaRgurS0NTWlcnrkHspQeFwzRutwdY0/T4bk2aJrd3LK6p5tyxoJ4ONsEdPhSD3BrvBIuzuQC/1PW+DrvZL2lKu6uTmhWbei9X3bi8HdhVs7n3+SX3+PVsDl5AofeqGPFY4DeeC3kcAT6IeW21+BdMg68xUQdZaaVfh8hr7XKeZeDceYk5jydtqxtcCfFCHrB9mvcYYrMq8fsMuA3SYTfGGoLlsIKc8NIvQfma/Dipb9bOQ/EjHiLCEQcVCpu5bi+4IH5QSyA3avmzs7gTiuLGfZjfgF3JDFr92OoMPtOl7wbDrkDXuBpZ+M70PPQBj+4H+xfkWRj4moQ4XjjytiY/uY6KJcicZnSENH6q9zjPwh6vZdxF45V8hDzYhTtYcJkHQtVvf9vyB6thtPMFVy0cFCW4RKKkDXIk8n0n8s1WSfygjKm76+HRd03OZaBBvfXjHRzT1QlNgizGlNKtPsbAJgldaufRbLNB0fnJ5lWFj7+UYJHkE7z0VvIZ9nu8oUI6/HxEzLYze/mx3lGvyEEVfST6Zq6rdWve0KQeSk34Fe67WmH/t7D+53L7YE1j7Q7/r/JU4u3kxwlifOvdM7W7M/Lfvb2lVfUPJyzXkw==
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Get the link to the form PDF
+
+scope: `company_forms:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-company-form.ParamsDetails.json b/docs/api/get-v-1-company-form.ParamsDetails.json
new file mode 100644
index 000000000..5ff6eda10
--- /dev/null
+++ b/docs/api/get-v-1-company-form.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"form_id","in":"path","required":true,"schema":{"type":"string"},"description":"The UUID of the form"},{"name":"X-Gusto-API-Version","in":"header","required":false,"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.","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"}}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-company-form.RequestSchema.json b/docs/api/get-v-1-company-form.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-company-form.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-company-form.StatusCodes.json b/docs/api/get-v-1-company-form.StatusCodes.json
new file mode 100644
index 000000000..2491346dd
--- /dev/null
+++ b/docs/api/get-v-1-company-form.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"Example response","content":{"application/json":{"schema":{"title":"Form","type":"object","properties":{"uuid":{"type":"string","description":"The UUID of the form","readOnly":true},"name":{"type":"string","description":"The type identifier of the form","readOnly":true},"title":{"type":"string","description":"The title of the form","readOnly":true},"description":{"type":"string","description":"The description of the form","readOnly":true},"draft":{"type":"boolean","description":"If the form is in a draft state. E.g. End of year tax forms may be provided in a draft state prior to being finalized.","readOnly":true},"year":{"type":["integer","null"],"description":"The year of this form. For some forms, e.g. tax forms, this is the year which the form represents. A W2 for January - December 2022 would be delivered in January 2023 and have a year value of 2022. This value is nullable and will not be present on all forms.","readOnly":true},"quarter":{"type":["integer","null"],"description":"The quarter of this form. For some forms, e.g. tax forms, this is the calendar quarter which this form represents. An Employer's Quarterly Federal Tax Return (Form 941) for April, May, June 2022 would have a quarter value of 2 (and a year value of 2022). This value is nullable and will not be present on all forms.","readOnly":true},"requires_signing":{"type":"boolean","description":"A boolean flag that indicates whether the form needs signing or not. Note that this value will change after the form is signed.","readOnly":true},"document_content_type":{"type":["string","null"],"description":"The content type of the associated document. Most forms are PDFs with a content type of `application/pdf`. Some tax file packages will be zip files (containing PDFs) with a content type of `application/zip`. This attribute will be `null` when the document has not been prepared.","readOnly":true,"title":"Form-Document-Content-Type-Type"}},"x-examples":{"Example":{"uuid":"48cdd5ec-a4dd-4840-a424-ad79f38d8408","name":"company_direct_deposit","title":"Direct Deposit Authorization","description":"We need you to sign paperwork to authorize us to debit and credit your bank account and file and pay your taxes.","draft":false,"year":null,"quarter":null,"requires_signing":true,"document_content_type":"application/pdf"}},"x-tags":["Forms"],"required":["uuid"]},"examples":{"Example":{"value":{"uuid":"48cdd5ec-a4dd-4840-a424-ad79f38d8408","name":"company_direct_deposit","title":"Direct Deposit Authorization","description":"We need you to sign paperwork to authorize us to debit and credit your bank account and file and pay your taxes.","draft":false,"quarter":null,"year":null,"document_content_type":"application/pdf","requires_signing":true}}}}}},"404":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided UUID is valid.\n"}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-company-form.api.mdx b/docs/api/get-v-1-company-form.api.mdx
new file mode 100644
index 000000000..460829e5c
--- /dev/null
+++ b/docs/api/get-v-1-company-form.api.mdx
@@ -0,0 +1,71 @@
+---
+id: get-v-1-company-form
+title: "Get a company form"
+description: "Get a company form"
+sidebar_label: "Get a company form"
+hide_title: true
+hide_table_of_contents: true
+api: eJztWFtTI7kV/isnysNAVbcNXk/C+inUAlNs1e6SGSabKqDguHVsa+mWeiS1wUP5v6eOpLbb2M6w2TylMg8MSOd+1dcv4jmfNs6bXGlPU4teGZ37RU1idCOoGpOUJMVdJjxOHZ/9YKoa9QIujK0cX5iaItulFCMxJZ/Pj/MiUuUTYyuRiRotVuTJsogXobEiMRJ8ea+kyITSYiRq9DORCUtfGmVJipG3DWXCFTOqUIxeRDRLOG+VnoplJiS5wqqalYuRuJ4RfP58eQZmAn5GEHQvs5W6f+YfgqenV5f5P8g65kqqZ4SS7IbyCZaOXqs4Yx8qpckFDRI95WN0JOH06hLmUSigc6ZQ6EnCk/IzWJjGBoICy7IHlxPQRhMoB7U1cyVJZpEG67pURQjmOwc3ldKqaqqu7LuDmfe1G/X70hSuF1LXK0zVb1OV17iwpizDfR9rlSdOpad/TgLzzvEhm9E4kj2xP9SZIN1UnP3B0eB9fvSX/Pg9p17SBJvSi1H3fLm8ex22D+QBIdVEyMutvtWuMDWN4CGd3/O5G1lC+RAy4WqjHTk2Z3B0xP9tSj1/xqouCVpKkYnCaE/aM20nlv3fHDO8dP1TvmQHL2J9JnfN+DcqPNer5ar2KmpvGiV3BeUN5cd+oPxFl4tYzsssVeNbpDEFKEnaq4ki+y3Byac3SWbSb8nbYHuL1M7JN2VbnPiO1LExJaHeEnu5FsOFqjQgBF5wHj314Lw37cG5lqxwQWjB43Mgd1DhAsa06rEtZqitMha8gTEpPYWJ0liqr7EVtixm4WuDb0SYl2Fm6KYsxVbNc0CCQSESygWjejw2wZkquuQyILZ/ZXMWSVUcL4H9aaaK2ToIlmpLjrR3PTiFXwd8Cj+ibtAuIIczKngSWBgcDQbwZJpScgwklWpONgahpR4cDb4D1BJmOCfAqG6OZRMqgwX04JrNiWfKAXuK45IC15MqS9DGxxgHm4CHX1lGX3ZG8UuD1tPvDmRi+wOxLLAkLdGuRLVxTdI2A6vhvKpLsyD7zsHfI0e5gAuSZLGEa3yGj+Qbq+GAJwh8Pzw+DJk4ra0qM/gJFxn82Gjq5iGFuTVgHWk44HjuSsDhfz8DacO5e6emvBTe0ISnkG5gUuIU/Aw9KC15upKDpxn5Gdl1iWoi6SCJB2PZxB78bDxFVr/2KHhQzFBPCXDiu1JUFLGnG6Upmoq0v08T/z66sK6q1ZjaX1SJNY7ZNK86q7tV0YOfjPNppqAluDq7cHGx45aMh+7aqeXkoQefuEJDVaqSoMbiEaccNnZ9TPBV1eHGwQELQxWixjoO36Tkq6ofUpWg91aNG08r4Q/s/QOnSMcHS/IJZuhS5ZDm2qnR7op0trEo87PEnv8QLcqvFzWFH2K5zMRzTnElh62Z1vN6gYrhSSHleypyHEqZD0+GRzkOB8Mc5V+/n3x3Ik+GRyeiXZCifRZIZanw95Jq4xQv59aks3ABZ/ECThs/M1Z9DWHZquFfKdQlv7N44nNpQY012SdjH/kEEztB4/hvSWPlQ5sVlqTy8YU2Rv0IWBSm0fEyJJV/qXERSTw+U2i9tOPSQzLuD85HZwrGP7dbMsZ+T5GLVzWWYt8+0FcP8/Vb9iZm4G6ZiT0ZCu34/1TFVL1KTzdzb03JvqQuw79MDI+G2w/an42HC9NoCbca4FbzkGIx5HgeWXKmsQU3McXmpWfleDzhI4FrLIUWXz13wls0Tlole7c6lYmrCR8J3SKfWtPU6+zFutkk4fzmZk7WKkkR3TEYePakGTxENPdICzHajyOztri6eJJhWcv32qIVw6Zlu1k2LVyzsqUMRCryMyNXpgeMORL9+XE/DPT+SwKhS4Y/ZOctRG1sybgwgS2sVcRauaQqAK6tqj2jyryKXpSXh4ZivuDCHsE7ZV5ZI/+NzJqv2UlHRWOVXwTLE0A/LQpyjjtNjG7uulSfGAXFCbCDdvUaYBNbTBheB4Q2PNM2bUwi8pLmVIbWZLwSW4Ex+qeF81T9EQ1Rwh4FS0bwE9PFdAHlM2jmckg4fwOhZoJRvPtl8onsXBXUyccaUOPYNL4fCPuSVTMizMPfuZmEPDDr9vAqi7DwDQQ73jk4T1UPVxGaBzzfDpLgxp8SdMUiYKI0Vc9arfCRykDH7UkVqjIUVLr927p+OBq1cb5C3ZGzjb5fW/2yBs7/EVZP+fT07Pt1iSokPhT6S+q4GzE/Fln44sNOjNpPP3eZmBnnmeDlhb+kfLblcsnHXxqyXNB33NNW8aM3lLdUjn/f84Wm68nBx7QAD2EPNt9pdzvR9aIzTkSWZk9r+JKXafps9PvM+h//hrQzpjF2uz/ArUK8HvA8LWrfudv6mLMx2j+cX4vl8l8Wvzz5
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Get a company form
+
+scope: `company_forms:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-company-forms.ParamsDetails.json b/docs/api/get-v-1-company-forms.ParamsDetails.json
new file mode 100644
index 000000000..28f350b60
--- /dev/null
+++ b/docs/api/get-v-1-company-forms.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"company_id","in":"path","required":true,"schema":{"type":"string"},"description":"The UUID of the company"},{"name":"sort_by","in":"query","required":false,"description":"Sort company forms. Options: name, year, quarter, draft, document_content_type, created_at (optionally with :asc or :desc suffix)","schema":{"type":"string","pattern":"^(name|year|quarter|draft|document_content_type|created_at)(:(asc|desc))?$"}},{"name":"X-Gusto-API-Version","in":"header","required":false,"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.","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"}}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-company-forms.RequestSchema.json b/docs/api/get-v-1-company-forms.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-company-forms.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-company-forms.StatusCodes.json b/docs/api/get-v-1-company-forms.StatusCodes.json
new file mode 100644
index 000000000..88b2ad1b2
--- /dev/null
+++ b/docs/api/get-v-1-company-forms.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"Example response","content":{"application/json":{"schema":{"type":"array","items":{"title":"Form","type":"object","properties":{"uuid":{"type":"string","description":"The UUID of the form","readOnly":true},"name":{"type":"string","description":"The type identifier of the form","readOnly":true},"title":{"type":"string","description":"The title of the form","readOnly":true},"description":{"type":"string","description":"The description of the form","readOnly":true},"draft":{"type":"boolean","description":"If the form is in a draft state. E.g. End of year tax forms may be provided in a draft state prior to being finalized.","readOnly":true},"year":{"type":["integer","null"],"description":"The year of this form. For some forms, e.g. tax forms, this is the year which the form represents. A W2 for January - December 2022 would be delivered in January 2023 and have a year value of 2022. This value is nullable and will not be present on all forms.","readOnly":true},"quarter":{"type":["integer","null"],"description":"The quarter of this form. For some forms, e.g. tax forms, this is the calendar quarter which this form represents. An Employer's Quarterly Federal Tax Return (Form 941) for April, May, June 2022 would have a quarter value of 2 (and a year value of 2022). This value is nullable and will not be present on all forms.","readOnly":true},"requires_signing":{"type":"boolean","description":"A boolean flag that indicates whether the form needs signing or not. Note that this value will change after the form is signed.","readOnly":true},"document_content_type":{"type":["string","null"],"description":"The content type of the associated document. Most forms are PDFs with a content type of `application/pdf`. Some tax file packages will be zip files (containing PDFs) with a content type of `application/zip`. This attribute will be `null` when the document has not been prepared.","readOnly":true,"title":"Form-Document-Content-Type-Type"}},"x-examples":{"Example":{"uuid":"48cdd5ec-a4dd-4840-a424-ad79f38d8408","name":"company_direct_deposit","title":"Direct Deposit Authorization","description":"We need you to sign paperwork to authorize us to debit and credit your bank account and file and pay your taxes.","draft":false,"year":null,"quarter":null,"requires_signing":true,"document_content_type":"application/pdf"}},"x-tags":["Forms"],"required":["uuid"]}},"examples":{"Example":{"value":[{"uuid":"48cdd5ec-a4dd-4840-a424-ad79f38d8408","name":"company_direct_deposit","title":"Direct Deposit Authorization","description":"We need you to sign paperwork to authorize us to debit and credit your bank account and file and pay your taxes.","draft":false,"quarter":null,"year":null,"document_content_type":"application/pdf","requires_signing":true}]}}}}},"404":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided UUID is valid.\n"}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-company-forms.api.mdx b/docs/api/get-v-1-company-forms.api.mdx
new file mode 100644
index 000000000..0ffd66ce2
--- /dev/null
+++ b/docs/api/get-v-1-company-forms.api.mdx
@@ -0,0 +1,71 @@
+---
+id: get-v-1-company-forms
+title: "Get all company forms"
+description: "Get a list of all company's forms"
+sidebar_label: "Get all company forms"
+hide_title: true
+hide_table_of_contents: true
+api: eJztWF9vG7kR/ypTtkBsYFeydUrr00trnO3AB9zFFzu9ArZrU8uRxDOX3JBcWYqt714MyZVWlpQ4uHsoiuYhtpczw/nzmxnOPLFZPq6dN7nUHseWe2l07ucVssE1w3KIQqBgtxnzfOzo2w+mrLiew5mxpaMDU2FkOxdswMbo8+lhXkSqfBSoMlZxy0v0aEnGE9O8RDZgiepOCpYxqdmAVdxPWMYsfqqlRcEG3taYMVdMsORs8MSiasx5K/WYLTIm0BVWVqQAG7CrCcLHj+cnYEbgJwjpBrbIlpc6Y/3dcN7c+KlGO1+7csSVw5eCL431jTQIVnXgfTh0AyDJGcyR2ww+1dx6tBkIy0c+A2GKukTt7wqjPf0kCzIoLHKP4o572DNBDldqDo/ST2DAXQHGwoBUAFePRnK2z3Z7gdzrPVrS8997pMwz6fKcVHkOmjxvVeR5pcf+3mCPu+KZLt3f//tf2KLltH/l7wJKji/O83+ideSU5MAJcoH26x48ofCXUqMLkRHcYz7kDgUcX5zDNAoF7pwpJKkUfTE3tQ0EBVeqA+cj0EYjSAeVNVMpUGSRhleVkkUA4hsH16XUsqzLtuzbvYn3lRt0u8IUrhNg3ylM2W1gnld8bo1S4bzLK5knTqnHf04C89bnfVKjdig6XwwO6rqkzOkd9N7mB3/ND99S2ggc8Vp5Nmh/XyxuX7rtHXrgoKTzhGmuVIPCNy7i8EbfaFeYCgdw3yRUOBhY5OI+BMZVRjt0pF3v4IB+rF9yOuNlpRAaSpaxhBKibbm2+5sjhqdNc7m1PCSVxzJc5KVXdECFgmUNmRn+hoUnyFoqHF5Grepaim2++3J2j6JosvO9VvNYLRZZAu1rpBEFSIHay5FE+zXByaZXSSbSr8lbY3uN1NaXr8qmrG9JHRqjkOsNsecrMYRnqYHH2gXOc48dOO2MO3CqBV1IdQU8n0XoQcnnMMRlKm4wQ2WlseANDFHqMYyk5kp+jhmzoTEJXyl8zUJLCqVF10qxjdQghwSFgidkzIcOdSZwpowmuQyQ9F/qnEVSGatQYH+cyGKycoLFyqJD7V0HjuHXHn2FH7muuZ1DDidYUMGw0Dvo9eDR1EqQDwQqOUUbndBQ9w563wHXAiZ8isDjdVOu6oAMEtCBK1InfpMOyFI+VBi4HqVSoI2PPg46AdVIpVIL2ubFVPW/1ZGJ7Xf4suAKteB2Karxa5K27lgNp2WlzBztGwe/RA41hzMUaLmCKz6DD+hrq2GPKgh83z/cD5E4rqxUGfzE5xn8WGtsxyG5uVFg5WnYI39uC8D+Hx+B1AjdnZNj6h2vSMJjSCcwUnwMfsI9SC2o6qKDxwn6CdoVRDWicJDE01NBG9+Bn43HyOpXFgULignXYwQ+8m0pMorYkY1b3wttVC3L1G5QJdZYZlO9anX45ooO/GScTzWFW4SLkzMX+z/fkHHfbkeVGN134JIQGlApFULFiwc+JreR6UOEz7IKJw72SBiXwWt0x/6rLvksq/uEEu69lcPa41L4PVl/TyHS8V2TbIIJdwk5qAk7FbfbPJ2tNcr8JLHnP0SN8qt5heE/eo+xWY6xVYeumdr2qoGy/lEhxFssct4XIu8f9Q9y3u/1cy7+9v3ouyNx1D84YtnL97eQFgt/J7AyTlJzblQ6CQdwEg/guPYTY+Xn4JYNDP+KAZf0HKOKT9CCildoH419oC88sSPUjv4WOJQ+pFlhUUgfH3JDrh+AF4WpdTwMQaVfKj6PJJ7PMKRe6nHpvRn7B8WjVQXjn5spGX2/A+TsBcaS75sZaDn7rJ681zECt0S4I0QhH8P48/9gbQSoHbvXBmVXWBe3C/qXsf5Bf/Ot+7PxcGZqLeBGA9xoqlMkBx2VJIvO1LagPMaYvziTjioUf0BwtcWQ5csXT3iOxmIrRedGJ6S4CvkDcjfPKXq5maK1UmAckI+VYutEY2vqahXjszQ148yjpkkjTs0POGeD3QN7tkRYa3CnGa7h26XUkrFRbjtTVHJFvKYsDS4l+olJS4A4lE7YgHWnh91IKtF1n1Yz/6LbbAcc2mmzGqitoqEyTWq8knFQywWWYVrbQPIJluaFO6O8PCQZ8QWDdgjeKvPCGvEFmRUdk8UOi9pKPw+ap83IcVGgc5R9bHB926a6pJkploUttMs3AqnYDJThzYDchsfbuo5JRK5wiiqkK00xMT1oMXI5dx7L33NDlLDjggWN/yPTnvTCioAmbgJJWhKsjbcZoxWAez+6RDuVBbbisZrG+dDUvhsIu4KupjkxD3/nZhTiQKybBU0V4RlgIOjxxsFpygK4iHN9WAY0xSWY8ac06PIiTEqp0p40t8IHVIEuJGPJpQqASqf/WOGHvFEZ50uuW3LC6L4a2KGB+4upbzlp/xGzfoqwx5nvVorLAIUA/aeUkNdsehjMTinJMjZYW8SNmu42Mc4T/dMT7Wk+WrVY0Oe4MSPEC+nopbxj49O27L9hfbbVNbHMrXaCTXEL6T3lVpKB32js3of0LNiHXfvIHdo0jU6vqdJo2YrS4naRNZu3b1Puf3wN94Ugb99hrgK+bHpUMyvfOttYgK11u3enV2yx+A+YvyKh
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Get a list of all company's forms
+
+scope: `company_forms:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-company-industry.ParamsDetails.json b/docs/api/get-v-1-company-industry.ParamsDetails.json
new file mode 100644
index 000000000..dd4392082
--- /dev/null
+++ b/docs/api/get-v-1-company-industry.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"company_id","in":"path","description":"The UUID of the company","required":true,"schema":{"type":"string"}},{"name":"X-Gusto-API-Version","in":"header","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"},"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."}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-company-industry.RequestSchema.json b/docs/api/get-v-1-company-industry.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-company-industry.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-company-industry.StatusCodes.json b/docs/api/get-v-1-company-industry.StatusCodes.json
new file mode 100644
index 000000000..11388f66c
--- /dev/null
+++ b/docs/api/get-v-1-company-industry.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"title":"Industry","type":"object","properties":{"company_uuid":{"type":"string","description":"Company UUID","readOnly":true},"naics_code":{"type":["string","null"],"example":611420,"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."},"sic_codes":{"type":"array","description":"A list of Standard Industrial Classification (SIC) codes, which are four digit numbers 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`.","items":{"type":"string","example":8243}},"title":{"type":["string","null"],"example":"Computer Training","description":"Industry title","readOnly":true}},"x-examples":{"Example":{"company_uuid":"423dd616-6dbc-4724-938a-403f6217a933","naics_code":"611420","sic_codes":["8243"],"title":"Computer Training"},"success_status":{"company_uuid":"423dd616-6dbc-4724-938a-403f6217a933","naics_code":"231208","sic_codes":["1500"],"title":"Construction"}},"x-tags":["Industry"]}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided ID/UUID is valid.","type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["error_key","category"],"properties":{"error_key":{"type":"string","description":"Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error."},"category":{"type":"string","description":"Specifies the type of error. The category provides error groupings and can be used to build custom error handling in your integration."},"message":{"type":"string","description":"Provides details about the error - generally this message can be surfaced to an end user."}}}}},"x-examples":{"not_found":{"errors":[{"error_key":"request","category":"not_found","message":"The requested resource was not found."}]}},"title":"Not-Found-Error-Object"}}}}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-company-industry.api.mdx b/docs/api/get-v-1-company-industry.api.mdx
new file mode 100644
index 000000000..5d59dbfc7
--- /dev/null
+++ b/docs/api/get-v-1-company-industry.api.mdx
@@ -0,0 +1,71 @@
+---
+id: get-v-1-company-industry
+title: "Get a company industry selection"
+description: "Returns the industry classification for a company, including NAICS code, SIC codes, and industry title."
+sidebar_label: "Get a company industry selection"
+hide_title: true
+hide_table_of_contents: true
+api: eJzdWN1z20YO/1fQvYcmM6S+7Lgpn85j5zJ6uMQTOb3OKBpnxYWkrclddj9kqxr+7x3skhIlS21z93LTJ1MkgAWwP/wAeMss5t5It2HZdMtudFlxtbnOc7T22rsVy6azepYwgTY3snJSK5axT+i8URbcCkEq4a0zG8gLbq1cyJyTFCy0AQ55NJiAVHnhhVRL+HA9vplArgUmMBnfhCebAFdib8tJV2Dvi/qibK4rzOBrNCTRZga5+MoS9pwuvXU6lcrh0oRDU7epkGVThuUchUDBZglzfGnp3bg1PsEC8xDJLGG6wqg7FixjS3Tpepg2XqetPyxhFTe8RIfGhkQpXiLLWCP4IAVLmKTUVNyt2HG+7lcInz+Pb0EvQs4aNZYwg796aVCwzBmPCbP5CkvOsi2LoTDrjFRLVtfJ7tCf0/ch8Ou7cfoTGktnNKevkAs07LydhKHyJaVjNBi9SQdX6fANC/e74L5wLOu+r4/juKUElFJhvHrBHaZzblHA9d0Y1tEX4NbqXHKHAp6kW8FGexMEcl4UPRgvQGmFIC1URq+lQJFEGV5VRQOf7y1MS6lk6cuu7dmrlXOVzfp9oXPbCwDo5brstxeeVnxjdFGE731eybTRlGr5j8Zg2nn9mtzwFkWPEcxbTBn7xJftnRi0lVYWLaVzNBjQn8O8THwomIUvWMJyrRwqR1KdgPq/WBLddm+GQM6yHTBZ0l6Wnv+CuSPUGcKnk/HsFm3eS3Hqag+damo5AC8gjYuPqtjEqOqEKS5z+0DVt7c13RtTvigIGfjMy4r8vBoOL0eD41M+aONWcF2ikTlXsCuym0M2mGyswxJeheLfJR2cbmljA3NvCVkWbYQNByufQcildKB8OUcDEWtaBfRVRpacuGJTIRXWkzaP4UNrCCo0C21K2yMkW5mHYG0nc9wYvnmRuGsopHVkcuK4EtyINizJi+PAXk3GN69bDntayXwF3CAsCM9d36liuIOcO1xqI3/DLnlKbD+3LAdzLLRaUoK6QUuzj47nTq4lYSPU1C4+Sq7SDipuSVGqBJ4QnmRRtAkBroBY0yheQKH1o69iyr/uMfG1R5zisLQnSaQFxdvR5UVdJy2W/wqOAjC9QwP3hkt1Crrjgz7wErw1VWpjMPj3rjV+XCTscnQhxNXwKr0S8zy9/GF0mf548Zanl4OLxdVo+AP/8eKCHRYDi0hnB5iZMgo19JOmbF+GQSiLTPBgHXf+RNH+V/6MLoajwdtjf4ZvBoNDf5R1xsfOFlN03PrYrK7py+Xg8iWJfdAO/qW9Et/CYWdMwBcF8EVR36MOh5aagUGrvckRhMYIUXyW1vXg3/wRwXqDTV3HpgDj235omtLCmhdS9E4Q5L5/Thkao42llBzSZvP+Zdkfw/u81YdHJIWmejdnzghSf8rLkwpzuaAaf1phE3NQB53n3tge3G8qSb1yA24lLTziBqRA5aIWyXPnjJx7h/3dXAIGi9Bznd6bDMy38/obXCMLLbFGS0CX2ZpqL8k2ni+N9pVUSxvGOGoEc9wx/NzLQkBOjbVs5FdciYKGQali6+8MccHnEq3lS/xzl+9aRwQ6LgsLfK696yQ1hSUqNPt0NqZbL603C55HT7kCVIIcp8zFWjkkGqXdwyIUSQdY04P7Zw3iu3jJOoqd4NiZAnnisT6CAk0mHYqlIktDkaXv6ND0Y0Ttzl1bIX9EbjdpuBWWsXaM3Q++h3I0V6Z6jcbIwDdLdIHjHSqakWKEMbazQ3fC1rzwR8M3Da2HenGw2gnHUWQvdOz7TvBEDKf1DmPZ61NMNOGV6FZa7IIM43rG+uthf9d7+9v9WF/324MfbCd7Fs26XQW8KWjybuZSXsk4lqYCyzCbvoDsLZb66AaivTR0CNILwZ0xfNLmndHiD2xW9JnCb7e9CTF4hPSJnW9XdHR4u03Q7zlyE/aLk6NmWuAaC+DerYitYtOgao7T3/9yQrRw5oCatp+F7s7UYUOizYEg0OxIB7tNwmiVsR8XEzRrmWMn0/utInBJPwj2BR1NlJ+G36lehAyT6rGz/8Ei1yUSowQ/vrfwrqkJuIv7SVhqhM59icqFML5r2i7PQ9ttdr3b9lT4RPQeqjFhWHJZBKg0X/+5RwZlo9LWlVx17LxHt9/G93t2F9MHMWz3I8D/x7bfwMXhs+tXBZcBV6FCtk0RT9l6GHLYqLKEZUf7+YtKniVspa0j5e2WBu3Ppqhrev2rR+Lt6YwoxEg+J1hNt0xIS8+CZQteWPyDtL361EwRr+H8/n8yrHZMCRItgbGkYbtOTPWsTtqd/9uc+1tv8mfSGtN3+r8nuyzvuwrRVeU6315Mwgf95P27e5YwfshuOzZrHuiSTt7udhsl7vUjqrreXbaj32EAqH8HEPTdoA==
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Returns the industry classification for a company, including NAICS code, SIC codes, and industry title.
+
+scope: `companies:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-company-onboarding-status.ParamsDetails.json b/docs/api/get-v-1-company-onboarding-status.ParamsDetails.json
new file mode 100644
index 000000000..2f7a1126e
--- /dev/null
+++ b/docs/api/get-v-1-company-onboarding-status.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"company_uuid","in":"path","description":"The UUID of the company","example":"7b1d0df1-6403-4a06-8768-c1dd7d24d27a","required":true,"schema":{"type":"string"}},{"name":"additional_steps","in":"query","required":false,"example":"external_payroll","description":"Comma-delimited string of additional onboarding steps to include. Currently only supports the value \"external_payroll\".","schema":{"type":"string"}},{"name":"X-Gusto-API-Version","in":"header","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"},"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."}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-company-onboarding-status.RequestSchema.json b/docs/api/get-v-1-company-onboarding-status.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-company-onboarding-status.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-company-onboarding-status.StatusCodes.json b/docs/api/get-v-1-company-onboarding-status.StatusCodes.json
new file mode 100644
index 000000000..85a159c68
--- /dev/null
+++ b/docs/api/get-v-1-company-onboarding-status.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"description":"The representation of a company's onboarding status","type":"object","title":"Company-Onboarding-Status","x-examples":{"Example":{"uuid":"c44d66dc-c41b-4a60-9e25-5e93ff8583f2","onboarding_completed":false,"onboarding_steps":[{"title":"Add Your Company's Addresses","id":"add_addresses","required":true,"completed":true,"completed_at":"2025-02-18T10:00:00Z","skippable":false,"requirements":[]},{"title":"Add Your Employees","id":"add_employees","required":true,"completed":true,"completed_at":"2025-02-18T10:00:00Z","skippable":true,"requirements":["add_addresses"]},{"title":"Enter Your Federal Tax Information","id":"federal_tax_setup","required":true,"completed":true,"completed_at":"2025-02-18T10:00:00Z","skippable":false,"requirements":["add_addresses","add_employees"]},{"title":"Add Your Bank Account","id":"add_bank_info","required":true,"completed":true,"completed_at":"2025-02-18T10:00:00Z","skippable":false,"requirements":[]},{"title":"Select a Pay Schedule","id":"payroll_schedule","required":true,"completed":false,"completed_at":null,"skippable":false,"requirements":[]},{"title":"Sign Documents","id":"sign_all_forms","required":true,"completed":false,"completed_at":null,"skippable":false,"requirements":["add_employees","federal_tax_setup","state_setup","add_bank_info","payroll_schedule"]},{"title":"Verify Your Bank Account","id":"verify_bank_info","required":true,"completed":false,"completed_at":null,"skippable":false,"requirements":["add_bank_info"]}]}},"x-tags":["Companies"],"properties":{"uuid":{"type":"string","description":"the UUID of the company"},"onboarding_completed":{"type":"boolean","description":"a boolean flag for the company's onboarding status"},"onboarding_steps":{"type":"array","description":"a list of company onboarding steps","items":{"title":"Onboarding step","type":"object","properties":{"title":{"type":"string","description":"The display name of the onboarding step"},"id":{"type":"string","description":"The string identifier for each onboarding step","enum":["add_addresses","federal_tax_setup","select_industry","add_bank_info","add_employees","state_setup","payroll_schedule","sign_all_forms","verify_bank_info","external_payroll"]},"required":{"type":"boolean","description":"The boolean flag indicating whether the step is required or optional"},"completed":{"type":"boolean","description":"The boolean flag indicating whether the step is completed or not."},"completed_at":{"type":["string","null"],"description":"The ISO 8601 timestamp indicating when the onboarding step was completed."},"skippable":{"type":"boolean","description":"The boolean flag indicating whether the step can be skipped or not."},"requirements":{"type":"array","description":"A list of onboarding steps that are required to be completed in order to proceed with the current onboarding step.","items":{"type":"string","enum":["add_addresses","federal_tax_setup","select_industry","add_bank_info","add_employees","state_setup","payroll_schedule","sign_all_forms","verify_bank_info","external_payroll"]}}}}}},"required":["uuid"]}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided ID/UUID is valid.","type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["error_key","category"],"properties":{"error_key":{"type":"string","description":"Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error."},"category":{"type":"string","description":"Specifies the type of error. The category provides error groupings and can be used to build custom error handling in your integration."},"message":{"type":"string","description":"Provides details about the error - generally this message can be surfaced to an end user."}}}}},"x-examples":{"not_found":{"errors":[{"error_key":"request","category":"not_found","message":"The requested resource was not found."}]}},"title":"Not-Found-Error-Object"}}}}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-company-onboarding-status.api.mdx b/docs/api/get-v-1-company-onboarding-status.api.mdx
new file mode 100644
index 000000000..bc3b54d40
--- /dev/null
+++ b/docs/api/get-v-1-company-onboarding-status.api.mdx
@@ -0,0 +1,72 @@
+---
+id: get-v-1-company-onboarding-status
+title: "Get company onboarding status"
+description: "Retrieves a company's onboarding status, including whether onboarding is complete and the list of"
+sidebar_label: "Get company onboarding status"
+hide_title: true
+hide_table_of_contents: true
+api: eJzdWW1v2zgS/is83ofuApJfUifN+tPlmmyRD7sJmnTvJQm8tDiyuZFIlaTcGIb/+2FIypIsOWmui1vcFgVaS+TwmbeHM6MNNZCUWtg1nd5t6HuVF0yuz5IEjDkr7ZJO7x62DxHlYBItCiuUpFP6EawWsAJDGEn8ljeGKDlXTHMhF8RYZksTESGTrHRPvizBLkE3FwnjNmdggTDJiV0CyYSxRKX3UsPnUmjgbalQGPJF2CWuFZpoMAUkVqygkiSUdIfD4F7eS5OoAqbk14BxVsuaeYRTDYz/SiP6FC9KY1UspIWFZigntusC6PSOQj4HzoHTh4iqAvzbS06ndAE2Xo3jID6uxcdePI1owTTLwYI2zsCS5UCntAJUloLTiAo0asHsku5b+nYJ5NOny3OiUmefsJFGFJ4Yakyn9N18zEc8Hccnk9HbeMJGJ/Hpu5PTOBlz/o4fTfjRO0YjWlmUTq0uIaImWULO6HRDvaLUWC3kgm630Q4n41wgEpbNnPErrJ9L0OuWzJRlBpqo4MmCxo0FW2uVZR3V3qs8ZzGHTOTCAif+eFS0PrXrfatCUMGAvC+1BmmzNVEyWxNTFoXS1jhDrVhWArnvwLinA/p1uv8z/uBC4uz6Mv4FtEHUQf0lMA76GTkRBVnmGDxHo6PjeHQSj4+pS6OUlZml0+bz7b5lzjFeciHBq8KZhXjODHBydn1JVh4LYcaoRDA0nUuJtSq1W5CwLBuQy5RIJQGzrNBqJTjwyK9hRZGJxEXxG0PuciFFXuZN2Q/fLa0tzHQ45CoxA5cag0TlwyoV4mBN937IChGHnUIu/hoExo3H3yOM0gAfUGSTKtu0+cIWVTxiMitpwKA5j0Yj/Kdtl5vS8RKNaKKkBWlxSUOb4W8G120abulmk4ZCgwFp3RYXbs9xGI0q16r5b5BY/C2si/BAlvFVnfY31Z6nOGSC0+aiyooNdRk/pclkwk9OeBInk/E8nrCTUfwDHB3Hx/DD2zQ9PT59mx7RiDYIq6LKOtdabIbJiQRTgTvjnPwLvf1+p9sZ5xoMGjiiDgTjfMYaD/cZonHk3oMZq2P4KB6f3o5H0xH+/TcmxaMoCjZHGAFpEJyDtMbdKFEP0Iu8yNQa2vCg8fD3h1cFXgvdnllaYC+kBe3h/ggcNMvILXsilzJVOncBVYFP/euZZU8zA7Ys/of27Ti2bcl+8/+dyUdyliSqlLbpgTmTjzMhU/VHBcgNZJBYwsg1W5ObZAm8zKBCGHhoZurnz4AMp7VRyjLLXo1JLCQ5V0np3wYwRizkjGXZDKPhhYj9FiidzOgLNlcF7X7te7Jjt5Z6v4AW6fpwXKzc+68NjW9WtT7nYfuw3SK7WrZwrz27CYzqiBYayzMrPOl6pu3ezO0rwR4osLaHyHcncK5UBkx2JDIS3pA0YwuSKt0U3HvHbPvIfHcQ05qte44JtXIluVMrobcs5F5U8OxVe03P7dY2Ytj3khXxYuXCFBlbEyyfKmvuQUJFv8YpKC6Ug4KDtCIVoJ0lgSXLjtS62tonvt7EcHwyE5KXxroqdj859tOrnUo9lNNJ/J4E6dTDD9tm1rwYVmiTVmAJyV3d02iurLMbFFht1Q2UJqrw5TTa/zWh/Nozd7LxUKnsoHWgy/vqzLva90gFtNNj4tmXN1fk9GQ0JlbkYCzLiz0Esi/KyBfWgOIwNHjm91U6YZLMgTj5bbXbRPZCMp/tkrnb8CyZJUxD7VCr8Mja1kISpTmiUljqJ1B1BI52fI+0L3fQIocDvcv/Vza5P82UuvNXwIN/PhlNug3Bz8qSH1Up+X/fU+xEkHtJyL30PcbnEgz6RoNRpU6AcAUGY4PAkzB2QH5ij0BMqcF5qerQyOX50N1GwmAHK/igh6GbGoLWSvdcfuF5N+72nX5Y6uwRcEPCLCyUXh84w616kdBvCkiQxA1mUNDZbScqSUptBuR2XQhsXNfELoUhj7Cuqd+3wcxaLealheFupkI0ZK4BtqoW6UmnQv0KaCgB12IaekkEnVmJqpxkAvKFVmUh5MK44VUgAuxxXYKWIuMkwS43D+uXTPLMXWnS9+GNWZPDnIMxbPEVt+11BYSDZSIzhM1VaRtGjckCJKZqZc4gekdXpU5Z4pEySUByBI6W87nS7l6lsrPUJUkjsO5a/qch4pvxMm1sbChHDyQIkjbmh9uAYwIEUpUtPysbuySLL/DQ+MpHbYDbWww+xaYA9gjMrGMsSWK1Aq0FBz+3qwuhXc+OnCJxWuHV84odHAxG1I2Y2gNCLKLb+/yIY7cYi+PmokMYdxt6seIMJQe7VGEI6XgUh7V0uBoPk8oMw01zzrgddsafjr/1qhpOljrD4VYY/bBC+MlPzCF3459OIJ5Drmjb1F5e7NoE3EdR2wOCe2Vea8WfkVnga9S/mltjR5j7QO2ZXu9SCQ+vBnbu9gem3QivM5R0M50MVpARVtolcpC/CjBHb9bGQv4tJ3gJBw7A+hgvuEbF7oaQOJzzF6HxUhrjw4jitNBcpTegVyKBhqXrwZ1jiKFbOOR4NBJ57H7HKnUWxq37YP8BWaJyQJ5wON4YchGCHdtxvHnd3JCHVtip8ZdwmbLEXaZhnHpenUo+Imm7NIso5ExkLlTC27/VkYHWKJSxOZMNOR/A9nc8IaBbCmzqW/1P+NEiBJ6FJzssMiZchLpc2wQ+uKOrMY3ojhFoRKd73x66pPAQ0aUyFndvNjh3/qSz7RYf+7E/UgUXBsvpurs/aPY/cszfayBPvT1fNirGdfSyYlr4huFV2n73MYTA9+Twp5teWFWd5lbsoFRwW07bYusYvkG8Dt6f+svCs/7u/5pTu3x3JyO3F7bxrtMMtG7fDxe32OO0r4Id9Yf/uMF8n383G7/iVj2C3G537rb429VA2/8A5GF05w==
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Retrieves a company's onboarding status, including whether onboarding is complete and the list of
+required onboarding steps with their respective completion state.
+
+scope: `company_onboarding_status:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-company-payment-configs.ParamsDetails.json b/docs/api/get-v-1-company-payment-configs.ParamsDetails.json
new file mode 100644
index 000000000..e5b4000df
--- /dev/null
+++ b/docs/api/get-v-1-company-payment-configs.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"X-Gusto-API-Version","in":"header","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"},"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."},{"name":"company_uuid","in":"path","description":"The UUID of the company","required":true,"schema":{"type":"string"}}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-company-payment-configs.RequestSchema.json b/docs/api/get-v-1-company-payment-configs.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-company-payment-configs.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-company-payment-configs.StatusCodes.json b/docs/api/get-v-1-company-payment-configs.StatusCodes.json
new file mode 100644
index 000000000..158f02651
--- /dev/null
+++ b/docs/api/get-v-1-company-payment-configs.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"title":"Payment-Configs","type":"object","properties":{"company_uuid":{"type":"string","description":"Company uuid","readOnly":true},"partner_uuid":{"type":"string","description":"Partner uuid","readOnly":true},"fast_payment_limit":{"type":["string","null"],"description":"Payment limit for 1-day or 2-day payroll (string representation of decimal).","readOnly":true},"payment_speed":{"type":"string","enum":["1-day","2-day","4-day"],"description":"Payment speed. READ-ONLY.\n- `1-day`: Next-day ACH (only for partners that opt in).\n- `2-day`: Two-day ACH.\n- `4-day`: Standard ACH.\n","readOnly":true},"partner_owned_disbursement":{"type":"boolean","description":"Whether the company is configured to use the partner-owned disbursement payment rail","readOnly":true},"earned_fast_ach_blockers":{"type":"array","description":"Blockers preventing the company from earning fast ACH payments","readOnly":true,"items":{"type":"object","properties":{"blocker_type":{"type":"string","description":"The type of blocker","enum":["minimum_days","minimum_funded_payments"],"readOnly":true},"threshold":{"type":"number","description":"The threshold needed to unblock","readOnly":true}}}}},"x-examples":{"typical_payment_config":{"company_uuid":"423dd616-6dbc-4724-938a-403f6217a933","partner_uuid":"556f05d0-48e0-4c47-bce5-db9aea923043","fast_payment_limit":"5000.0","payment_speed":"2-day","partner_owned_disbursement":false,"earned_fast_ach_blockers":[]},"payment_config_with_blockers":{"company_uuid":"423dd616-6dbc-4724-938a-403f6217a933","partner_uuid":"556f05d0-48e0-4c47-bce5-db9aea923043","fast_payment_limit":null,"payment_speed":"2-day","partner_owned_disbursement":false,"earned_fast_ach_blockers":[{"blocker_type":"minimum_days","threshold":15},{"blocker_type":"minimum_funded_payments","threshold":5}]}},"x-tags":["Payment Configs"]}}}},"404":{"description":"Not Found\n\nThe requested resource does not exist. Make sure the provided UUID is valid.\n","content":{"application/json":{"schema":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided ID/UUID is valid.","type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["error_key","category"],"properties":{"error_key":{"type":"string","description":"Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error."},"category":{"type":"string","description":"Specifies the type of error. The category provides error groupings and can be used to build custom error handling in your integration."},"message":{"type":"string","description":"Provides details about the error - generally this message can be surfaced to an end user."}}}}},"x-examples":{"not_found":{"errors":[{"error_key":"request","category":"not_found","message":"The requested resource was not found."}]}},"title":"Not-Found-Error-Object"}}}}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-company-payment-configs.api.mdx b/docs/api/get-v-1-company-payment-configs.api.mdx
new file mode 100644
index 000000000..5476897de
--- /dev/null
+++ b/docs/api/get-v-1-company-payment-configs.api.mdx
@@ -0,0 +1,74 @@
+---
+id: get-v-1-company-payment-configs
+title: "Get a company's payment configs"
+description: "Get payment speed configurations for the company: payment speed (1-day, 2-day, or 4-day ACH), fast payment limit, partner-owned disbursement setting, and earned fast ACH blockers when applicable. 1-day is only available to partners that opt in."
+sidebar_label: "Get a company's payment configs"
+hide_title: true
+hide_table_of_contents: true
+api: eJztWG1vGzcS/iss8yE2sJRkWXIafTrXTlMDd4kQO9ceFEGhliMt611yS3JlC4L++2FIrrR6c1MUvQMO5y+yxJnhzPCZZzhcUQtpZaRb0sFoRW90UXK1vE5TsPa6chkdjMbrcUIF2NTI0kmt6IC+B0dKvixAOWJLAEFSrWZyXhmOEpbMtCEuA5IGe4M96bMLJvgyId3woQ3p4X/k+uan84TMuN2az2UhXUJKbpwCw/STAkGEtNPKWAgmwTmp5gnhShDgBgW8ieubn8g01+kjGEueMlCEl2UuUz7NoUW8C0RaolW+JHzBZY4LxOl6M0tcxh3RpSNStb6oL+rVq1fkE+TcgSDzSgqwXxQjoyFfGp3nZGg05k2qObnHOO34TOh04KNkC8t8kOdoyKa6hAH5GvMzidFOQhrtwAAXX2lCn9m8sk4zqRzMQ3KZW5ZAByMKxRSEAEHHCXV8bvG3YczaTbCDS7qEoHgn6IDOwbHFBYv7srgvi/vShJbc8AIcGOsBoXgBdEB/Ye+9H9fDO/ZPMBZhkFCJWMiACzA0oTbNoOB0sKLBQ2qdkWpOEwqqKtC7bqfbZ50rdtGnHlIzXuWODpq/r/ehdou+FFKB9YAS3AGbcguCXA/vyCL4Qri1OpX+XJ6ky8hSV8YLpDzPW+RuRpRWgKddGr2QAkQSZCIicLPXlowKqWRRFU3b47PMudIO2m2hU9vy59FKddGu849JxOP3621eShY1pZq/igZZ4+dzdKOyIFp0nWwyXCOhqqSoU1tyl9H9hDxkQD5/vrsletYsMZpQA79V0oCgA2cqOH0gayzoGlnGPvF5rWHAllpZsKjU7XTwY3f3+8pTw6zKaUJTrRwoh1KNPLZ/tSi6au4vXY4ORHiymw3comd6+iukDuFnEK9OBhd2knIEWLu+RfIiMYVYQx9VvgzBrT20say/0dowSJ+0hhSzqVvPUlubo61RVeU5PSDQYZPdPFsGOtImcCKJmCJnwRAxUBqwoJxPMZ69gFQWPD9vHQ81+OXp9qWS9NvShHbjp6eo0/56ey3y6d31Lfv44e//aiH/ffVGvg7IB3h2NY+TM8+rGNoxOj0Pmt2o+fCka8Ww0IsL944rwY2IKy8dq28Nk2ZraAQ+1ToHrg5O+ecMXAY7zQrLs25nILAfVBa8wAtNqG5Xhsv8mJOhL008aHiaTeq+1HCRG+OPYNfBH+oGVhpYgMJOt+PszOjCdz1c2LS96I49cCWh0kHR3PZE6UUHJ0Hq94oFSQklEJhRswGySIITwZfoUf11VikBYrLxdXwkby4zYDOdN0GsqmLq7R/xoRYnCkDE01Peo8NTwT8kQnjmRZlDnRSZ8nyvIR9yEe11L4W4urhiV2Kast6bbo+9vfyes17ncnbVvXjD315e0n3Oof3+1azTFx3W+x46rJf23rBpCn0mpm858Lfdy04PtY5xC+13Op1Whx4U96Z2XyqEGc8tvATD0bhBGyHqCbbSHaT+t3OAZPpXxb8P+X3UNpB40cfGfUJ8H9U7mv31OGDu5IUtgLLX6R323g/akR91pQTeIBHt2PDB4qXHgNWVSYEIDZYo7Qg8S+ta5B/8EYitTCSwePkJFwhpyYLnUgRe/eZmfsIp8kUR8mf9urtt77p25IqwveaMKBijjWeOXfaKvx+S60n2O7A6eQRUSLmDuTbLE3t4qd+lx/sSUjmT4MeQGLNXJzpNK2Nb5CHwTr4kLpOWPMKSSIF077VQnjtn5LRy0N5c0YmJs4jTW5N4q9x6/Qdccw0OD5YIHmZtqj4kGz2fG12VUs2tn7tSrsgU/LUWvZlWMhckxRtmEeUzrkSOTUqqcPVuzDTe5wKs5fNvaDbD2hEBjsvcEj7VlWsklZE5KDDbdEbTtZe2MjOeBk+5IqAEOo6ZO9YSlHaTGSK8CazRzvnTiPgmXgYNxUZw9ESBPPFQH16hRQNP1PfmD9oxX2TsHW7KPgbUbty1JfBH4HbJcJpgegHGSAFh3qO7Ev7c/HDhmWd7FYdnBwoHlBBeCOzkAJrQBc+rvUEUaXFXL4wXG+HQ1bdCpxzfKPgAjmuEQLaSewHhkFOAy7TYpMHPUwPaXly0QyeTYNurZlNbt/cmcZxrwSzqFlGZHEfeOBDyUoZ5kAko/FB4gNVbKPTeAQR7zPdC1PPhnTB81ObQaPGCzRKXMfr6ZeceqTtg+cj7zqbacPN6jPdXZuDmyDUrmmA5LCAnvHIZ0lToFljG90vroPgzOwQLJzZY42w8082p0j9N4MiOYIiPEzuPCgnFNwT7cXYPZiFTaGR6O857Eml7wbbArZHrmf/O9MxnGFUPBgjIU134ZyPvx2tL3sV6IPW7EL4mCJ1WRT2/fRf7LU99v41PALf1ruGNyVdiQqHAkQKhElf/tkUGZqPU1hVcNezg6xyvB4TXdjObbCG9E8Jq2/r//7D3n3rYixXh4Nm1y5xLXzqeBFaRpkZ0ceFhEomKJnSw90i0z1XjhGbaOtRdrfCR7LPJ12v8+bcKsCWNxkiXRmI+PJ8JafF/sbkgn0TG2ad4QTonp1+gjkZV38C8RE3WNImMvhPSGoeQ+KD4x9z7n34mPJHYkMDjT7ObPG97J1Jy6RprB9f8nZb5/t0DTSjfZfANY8d/8JCOnu9qFSQe9COo9Xpz3A6/+9vN+t+4oJLX
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Get payment speed configurations for the company: payment speed (1-day, 2-day, or 4-day ACH), fast payment limit, partner-owned disbursement setting, and earned fast ACH blockers when applicable. 1-day is only available to partners that opt in.
+
+### Related guides
+- [Payroll Processing Speeds](doc:2-day-vs-4-day)
+
+scope: `company_payment_configs:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-compensations-compensation-id.ParamsDetails.json b/docs/api/get-v-1-compensations-compensation-id.ParamsDetails.json
new file mode 100644
index 000000000..0b8396479
--- /dev/null
+++ b/docs/api/get-v-1-compensations-compensation-id.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"X-Gusto-API-Version","in":"header","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"},"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."},{"name":"compensation_id","in":"path","description":"The UUID of the compensation","required":true,"schema":{"type":"string"}}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-compensations-compensation-id.RequestSchema.json b/docs/api/get-v-1-compensations-compensation-id.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-compensations-compensation-id.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-compensations-compensation-id.StatusCodes.json b/docs/api/get-v-1-compensations-compensation-id.StatusCodes.json
new file mode 100644
index 000000000..39d94f52d
--- /dev/null
+++ b/docs/api/get-v-1-compensations-compensation-id.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"type":"object","description":"The representation of compensation in Gusto.","properties":{"uuid":{"type":"string","description":"The UUID of the compensation in Gusto.","readOnly":true},"version":{"type":"string","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."},"job_uuid":{"type":"string","description":"The UUID of the job to which the compensation belongs.","readOnly":true},"employee_uuid":{"type":"string","description":"The UUID of the employee to which the compensation belongs.","readOnly":true},"rate":{"type":"string","readOnly":false,"description":"The dollar amount paid per payment unit."},"payment_unit":{"type":"string","readOnly":false,"description":"The unit accompanying the compensation rate. If the employee is an owner, rate should be 'Paycheck'.","enum":["Hour","Week","Month","Year","Paycheck"]},"flsa_status":{"type":"string","enum":["Exempt","Salaried Nonexempt","Nonexempt","Owner","Commission Only Exempt","Commission Only Nonexempt"],"description":"The FLSA status for this compensation. Salaried ('Exempt') employees are paid a fixed salary every pay period. Salaried with overtime ('Salaried Nonexempt') employees are paid a fixed salary every pay period, and receive overtime pay when applicable. Hourly ('Nonexempt') employees are paid for the hours they work, and receive overtime pay when applicable. Commissioned employees ('Commission Only Exempt') earn wages based only on commission. Commissioned with overtime ('Commission Only Nonexempt') earn wages based on commission, and receive overtime pay when applicable. Owners ('Owner') are employees that own at least twenty percent of the company. ","title":"Flsa-Status-Type"},"effective_date":{"type":"string","readOnly":false,"description":"The effective date for this compensation. For the first compensation, this defaults to the job's hire date."},"title":{"type":"string","description":"The job title for this compensation."},"adjust_for_minimum_wage":{"type":"boolean","description":"Indicates if the compensation could be adjusted to minimum wage during payroll calculation.","readOnly":true},"minimum_wages":{"type":"array","readOnly":false,"description":"The minimum wages associated with the compensation.","items":{"type":"object","properties":{"uuid":{"type":"string","description":"The UUID of the minimum wage."},"wage":{"type":"string","description":"The wage amount."},"effective_date":{"type":"string","description":"The effective date of the minimum wage."}}}}},"required":["uuid"],"x-examples":{"success_status":{"uuid":"db4d41e5-813c-477e-bfae-38da2ae5e7a3","version":"56d00c178bc7393b2a206ed6a86afcb4","job_uuid":"c1fdb417-c34a-43a7-92f3-5e6c20c1d7a4","employee_uuid":"a7e8f9bc-0d12-4e56-b789-012345678901","rate":"70000.00","payment_unit":"Year","flsa_status":"Exempt","effective_date":"2023-01-01","adjust_for_minimum_wage":false,"minimum_wages":[],"title":"Software Engineer"},"hourly_compensation":{"uuid":"e5f6a7b8-c9d0-1234-e5f6-a7b8c9d01234","version":"98b7a6c5d4e3f2a1b0c9d8e7f6a5b4c3","job_uuid":"d2e5f8a1-b4c7-4d90-a3e6-f9b2c5d8e1a4","employee_uuid":"b8f9a0bc-1e23-4f67-c890-123456789012","rate":"25.00","payment_unit":"Hour","flsa_status":"Nonexempt","effective_date":"2023-01-01","adjust_for_minimum_wage":false,"minimum_wages":[],"title":"Associate"},"minimum_wage_adjusted":{"uuid":"a4d9ba9c-32cc-4cc1-a5bc-6ef4cd653e7a","version":"cc59bd3879d655fb940a1f6b675f2ad9","job_uuid":"d8f8fbe7-496d-4b69-86f0-1e2d1b73a086","rate":"5.00","payment_unit":"Hour","flsa_status":"Nonexempt","effective_date":"2018-12-11","adjust_for_minimum_wage":true,"minimum_wages":[{"uuid":"edeea5af-ecd6-4b1c-b5de-5cff2d302738","wage":"7.25","effective_date":"2018-12-11"}]}},"title":"Compensation"}}}},"404":{"description":"Not Found\n\nThe requested resource does not exist. Make sure the provided UUID is valid.\n","content":{"application/json":{"schema":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided ID/UUID is valid.","type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["error_key","category"],"properties":{"error_key":{"type":"string","description":"Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error."},"category":{"type":"string","description":"Specifies the type of error. The category provides error groupings and can be used to build custom error handling in your integration."},"message":{"type":"string","description":"Provides details about the error - generally this message can be surfaced to an end user."}}}}},"x-examples":{"not_found":{"errors":[{"error_key":"request","category":"not_found","message":"The requested resource was not found."}]}},"title":"Not-Found-Error-Object"}}}}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-compensations-compensation-id.api.mdx b/docs/api/get-v-1-compensations-compensation-id.api.mdx
new file mode 100644
index 000000000..702b08726
--- /dev/null
+++ b/docs/api/get-v-1-compensations-compensation-id.api.mdx
@@ -0,0 +1,71 @@
+---
+id: get-v-1-compensations-compensation-id
+title: "Get a compensation"
+description: "Compensations contain information on how much is paid out for a job. Jobs may have many compensations, but only one that is active. The current compensation is the one with the most recent `effective_date`."
+sidebar_label: "Get a compensation"
+hide_title: true
+hide_table_of_contents: true
+api: eJzlWd1z27gR/1dQ9MHJjCBT35Kf6rkkV9/0Lplz0mvH8TggsJQQkwAPAGVrPPrfOwuSEklJcZK7vrR+sQgC+72/XSyfqANRWOU39OLmif5gspzrzaUQ4Nxl4Vf04uZ2e9ujEpywKvfKaHoRtoF2HB8dEUZ7rjRROjE2C4vEaLIyDyQrxIooR3KuJDGFJ4mxhJPPJu6Tn0zsSMY3ZMXXQDKuN0Q06fZIXHhidLohRgPxK+6RFBderaFP3q+AiMJa0L51Dvf4FYQzD8qvwkNmnCcWBG7+BEkCgcid5B4+9T/qj9oJk8MF+dSS4MICl59ojz6yZeG8YUp7WNrwkvlNDvTihkIWg5QgaY/yPG9ucfR2f9S6B76kF94W0KMWXG60A0cvnugwivBf28LXRXBBUqS0R9HAoD3u4nmeKhHIn392uPWJOrGCjOOvUiZq4s8gPO16DS1mIbfgQPvKTUnHdpr8iOL2aY/m1uRgvSqlLAolGyyct0ovj7L48OHqFRJGu58kjpZ9q9NNaZFtj67BOlXq8zyL2u/VoZpbqXefXAOE55vqvdJLsiyUhNsXK+9zd3F+Lo1w/eCZvjDZee1ElvONNWka3p8rCVluPGixeRki90iEe0MKh+yUI4mCVPbptkc/m/ju+yz22cRI82GlxOrQhDGkRi/dUQtClqdmA/CdjOvj38ndcg/HmO43Jjx1cEwKadKUW8IzU2hfQkUOluR8k6GTC618MGq1cIcL38kKjxIuRAlzGBcHSqIifXLVMQoCjybmQYPthS3ErUyRShIDOXvHN2IF4v4MLQO6yBAX/m4KS3v0N4B72qM/G+1XtEf/DRxX6xP0dtujSer4nfPcF+6YWjXB14+Q5ZjV1zzlVoEkvxgN9WLz91sUk/YQpjPlQoagXciOQvfF/vAB1KPV3vzj+pKUAoY0CMHeNFqf7GR6cVZyOXu5M54j3ELpV04S9QiSONy+IbAGu0FHo8OVkQ06AbrNGgEoA/Li7FDp7+LQI1zLUAnUGvb0ccPDCjSp8DVOoU/Qg+mGvDh7hmVpEiArU9hQezbkwdj7b2G1dwjIBosXZ8ddiHJwq8kDX4IjMXcg60KJfqlOdMh2LXoyCI5TbxD+Fs1CLKIm4cfZy2C2vYahqpsHTbgnKXDniX8A7YO7QrVuFBKuN31Ce9Qrn2KGvEkdZ9chLNl7TBoEwVZt/06U2BEhSORUyL+p3J4o69otSK/cLiHhReodImoF7WeOrJQt6QZMq3T5GrAOlQG3nxAIyXH5uXD+LjH2LlNaZUV2h15sMIiNSYHrAw5XWmJfAY6oI6Vb1FhXMgCJOlUcQpwQWaDgpKqfRPBUFGkl2JFy0ZSuiXrcWr75Oi812TvCnTNCcV8HelcFlEJ5yNyxPunPaHWa4gRfdAz/BTLBgGX5639dED8bs8eFwj+07e+FsiCxqARdQ5sKjzzL09ICruw+G0WptAmV8ViOBzBh88FIsPFsBixOOLDRXPIhhwnM+Ig2mjk6mcooEoPZPBaz0WIUD/kwmoKc8vmUJyIe02avRMUgkfF4MGNiNOZsPOIzthgmIzaBqRhGYiBnHE90Oh3KZzBPFrFgkRwM2RgmUxbP5gsWDYaj8WQ6my+iAa1bFDqLoijqRxHtdhR1cW7V433Z7XqFDqPhiEUDFoifzLwqfjsBf3O7x7Frk/gHhMXXeqk0gMUYWIXic9cM4YYfYJJM+SyeM7GQEUM1GS4xXMMlXGn5YTGPZ3wqJnIMo2TIB3EkFnIOs2TKJ/FYjNp+kEOYJHM+YPFYzNhYLiLGRzBlySIeiomcw+CoH+J5suBRLNgAhiM2TqYzJuaLUr7KDcO9H4aTo06o+qa2E5rdzX/ND5c1hNAOQN3VqNfwAB/LRcwXgo2GQrCxEAPGJ7FgU0jGQk4nI5jxlgeEmCxiOZrPFnI6mSTxYhzxQTKNp7NJMuRy0fHAPJknMczYeDGVbBxPF2w+TSK0rBzEsxGP5tO9Kf88Sw7mbDBkgy9asrzDdg25j00JwCc8YSDklI3jgWDxRAKbiCQZylE0nI3mtIZHOusPJ8+Isr3d7itla/ZAS0AbR+PDG/QvxpM3ptASr/fl1ff3AkLtsuBMYQXePMARbTyBR+V8n/zM74G4wpbXx9yatZIgS5hXjqx5qmT/o/6WK/kJochHTcgflevq1XlbNGyOOqWtCfZgrbFhKtEueNX6YRU+WTAPqN7dAx7ADmJp7OYEj7Dr2XJ2nYNQiQKH3WSlczhOjBCFdX3yfpMrwdN0U7ZB97AhSoL25Sncz723Ki48nOfc8gw8WGIh5VXrsiMZ6u1O6m8QDSngXqy0JaVyIlWRqp3kKsmX1hS50ksXWmfB8TKNg4MgTVyoVBKB04is2r/iWqbYUClNNqbA0cNurhRkzsC5r2ow3tWCSPBcpY7wGAdxe6MysgQNdm/OinQtpStswkUpKdcEtETB7a6daLcO2iBkFFo2A+um5X9aRXwzXi4aBxvK0RMJ8sDL/AgH+h2E+MV4FpKMvUam7G0ZtZW4GJTBjFcIVkvwbD1grbFf6+lOyYCsVRCVymieIaN/sTDPYpfvrtg/K6DvUYVWXwGX4Q5+MJw7uNcPo+GERVM2mJS373BpKMtavb7tOvUVypIpXQUiYiYrL2qX7652Y7FuTxwCCTdg7oQZh8YpKc5nK0jplXsakHbmyE3dRTZof+MkjeeK7Ydxf60IssbySxQDEwKje2fhQ08E6+Y8DFO+fvbYgqyyfp1yzBbH3Z4v0dM0zKgxY1sT77Jhdjnwe+Buw0Jy0wus3+5Sy/be9lbUi+GN2SoJZfz90JYTHj1oF45iqJUZc3IA3aNrnhbPD6LRpm1S5UB6d768l+03dbXbbTyu5fGjbW33JLpao8kz8CtTpWTIOPz4QM/Xg/NWcp4/dWJii0kGdl3nZmFTzL8qOnmuyuBkErIQoQdx8woy0/FSSY+VnRi+RvVOED5K85018gs0c3yNStcfX64xGEsAPfIJZheiyLzGlHCZB24Dyhx+nuF6w1JYQ0p44VdYG0Vl6x693jgP2R/hUFI4wWCLWZqYQLWC5ICTiB+tlriBcD2KgObeJtdg10pAw9J7bAmV6zxsPJfIGrGchWdmkmBhPNoV9jdIhcnCYDvIcebI6ypXyLtqXoHQJo0osvrTyF+qJo+L0ORVePSq5kp+hXSX4JBxlYZQqd7+bR8ZaI3cOJ9x3aDzI3jCuwjVkvpp32L+331uq2LRw6M/z1OuQtCG9HuqcOGGrgfBQW2kvejWi1u8SDuPB56esEB+sOl2i8u/F4BtB97/1twqHFYG+JDK4W95fPDU9MqLX6uK8pI8U3qO6lO32nrTAEbaq1C0q8gWPxRUTcW3ifk/3SqcsG1pw+Pt2c7U+5KFSBguxPW7gytdq0D9+Po91tg2cO6AsvqBTjrq4qencsd7cw96u9153ONz6GS3/wE2APrB
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Compensations contain information on how much is paid out for a job. Jobs may have many compensations, but only one that is active. The current compensation is the one with the most recent `effective_date`.
+
+scope: `compensations:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-contractor-document-pdf.ParamsDetails.json b/docs/api/get-v-1-contractor-document-pdf.ParamsDetails.json
new file mode 100644
index 000000000..202a6d1b0
--- /dev/null
+++ b/docs/api/get-v-1-contractor-document-pdf.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"document_uuid","in":"path","required":true,"schema":{"type":"string"},"description":"The UUID of the document"},{"name":"X-Gusto-API-Version","in":"header","required":false,"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.","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"}}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-contractor-document-pdf.RequestSchema.json b/docs/api/get-v-1-contractor-document-pdf.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-contractor-document-pdf.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-contractor-document-pdf.StatusCodes.json b/docs/api/get-v-1-contractor-document-pdf.StatusCodes.json
new file mode 100644
index 000000000..ff31f429c
--- /dev/null
+++ b/docs/api/get-v-1-contractor-document-pdf.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"Example response","content":{"application/json":{"schema":{"title":"Document Pdf","type":"object","properties":{"uuid":{"type":"string","description":"the UUID of the document","readOnly":true},"document_url":{"type":"string","description":"the URL of the document"}}}}}},"404":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided UUID is valid.\n"}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-contractor-document-pdf.api.mdx b/docs/api/get-v-1-contractor-document-pdf.api.mdx
new file mode 100644
index 000000000..ede01eebb
--- /dev/null
+++ b/docs/api/get-v-1-contractor-document-pdf.api.mdx
@@ -0,0 +1,71 @@
+---
+id: get-v-1-contractor-document-pdf
+title: "Get the contractor document pdf"
+description: "Get the contractor document pdf."
+sidebar_label: "Get the contractor document pdf"
+hide_title: true
+hide_table_of_contents: true
+api: eJzdVt1v2zYQ/1e420NbQLSSoN2DnhY0WRBgW4Ok2QY4RkuLZ4uNRLIkpdkw9L8PR0m27Nj7wPY0v9gm75u/+91tYMWXtQ+GKx1w6URQRvOwtgjZFLCao5QoYZZAEEtPZ++NDk7kwTh2ZfK6Qh083RuLnfathAyWGHhzzvOtMJe9MLdyAQlY4USFAR0Z3YAWFUIGg9CnulYSElAaMrAiFJCAw6+1cighC67GBHxeYCUg20AXLvjglF5Cm4BEnztlKRrI4GOB7PHx9oqZBQsFssEJtMnW8W/8Jlbh8u6W/4LOk2bvvkAh0e0FsBClx0M3V5RNpTT6zosIyOfCo2SXd7es6Ywy4b3JlQgo2e8qFGxtahcFclGWE3a7YNpoZMoz60yjJMqkkxHWliqPFX7l2bRSWlV1NbY9e12EYH2WptLkfhKfdZKbKh2ekVuxdqYs430qrOK9ptLLb3uDfHT8hsKoPcoJnC53AqjripBxcXbxjp99x8/fER4kLkRdBsjG5207OyzbDYZYrx1Utg/ErFxMnvST9rmxmLHPO5lPg4zPHAr5OT6Pt0Z79BTjxdkZfe27ul6JypbIBklIgCwSFLINjAqcfvGksBknrUJJWQ+YZ3cRxn0tzPwL5oFg7agPguqiiCg+UrH9sMIpfFJOQn7Q5brDPCF72yCu/JuW7398Cfz4SeDt2duXVfrZBPaDqbVkT5qxJ03tQ9BHT6B16E3tcjKGnmkTGK6UDxP2k3hG5muH0dUA3i4x5VkjSiUnTxrI74p7i+IZhV/zpTO1hQx2b7ujlX1JalVuGnROSew4pnsEXAXUBNiOS55xDdlpXkugEWV9wG9EBYPeYWxbhaMxHtfcj3VnoY+Z2qDCUJieKyMhhgIySJvzdIvtdLNHiG3acadH1wzEGXEAQ+MLq7q+5xKr2PwvMHGFlTkobGePE1aB9GJOJwwftXnnjPwTm5auKWWPee1UWMfI35vKCr2+zHP0/rKm7KezsdQDNV/XSEdkt9inEAd+ov9zFC7y9X6MvQleYoMlE3UoUIe+32lmPKx9wOrfeOgsnHDQ0jRZmDGVxIlDBE746GfOHlsmQBPFf1g8oGtUjqP32JG7mJs6pFEwleSaCIjH/9ws4juQ6mGwv2KZmwpZMCzG8cqz674b2F03JuJsGQAY0/imZ0yRR8bsZ+fV4JXdYxnlqHOxEqqMgOpvv9/hh6phjQ+V0CM7fzEJDlPY7Mj7vxsi/YsHXIXUlkJFaPRc23XoFJpz2BExpZodri0U7SyBwvhACpsN7QGPrmxbOv5ao6MWmBEtOCXmhIbpBqTy9PvEfjFO9/V9v4q8YSeXmxO59IdCr0esBElPYfuJtLM2Gdaffxbg/3wXOlrZroLHF8ltoXfTgpjGhtHdi/1jb0jcXH+Etv0DBU0Whw==
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Get the contractor document pdf.
+
+scope: `contractor_documents:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-contractor-document.ParamsDetails.json b/docs/api/get-v-1-contractor-document.ParamsDetails.json
new file mode 100644
index 000000000..202a6d1b0
--- /dev/null
+++ b/docs/api/get-v-1-contractor-document.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"document_uuid","in":"path","required":true,"schema":{"type":"string"},"description":"The UUID of the document"},{"name":"X-Gusto-API-Version","in":"header","required":false,"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.","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"}}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-contractor-document.RequestSchema.json b/docs/api/get-v-1-contractor-document.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-contractor-document.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-contractor-document.StatusCodes.json b/docs/api/get-v-1-contractor-document.StatusCodes.json
new file mode 100644
index 000000000..921c154be
--- /dev/null
+++ b/docs/api/get-v-1-contractor-document.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"Example response","content":{"application/json":{"schema":{"title":"Document","type":"object","properties":{"uuid":{"type":"string","description":"The UUID of the document","readOnly":true},"title":{"type":"string","description":"The title of the document","readOnly":true},"name":{"type":"string","description":"The type identifier of the document","readOnly":true},"recipient_type":{"type":"string","description":"The type of recipient associated with the document (will be `Contractor` for Contractor Documents)","enum":["Company","Employee","Contractor"],"readOnly":true},"recipient_uuid":{"type":"string","description":"Unique identifier for the recipient associated with the document","readOnly":true},"pages":{"type":"array","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.","items":{"type":"object","properties":{"image_url":{"type":"string","description":"Image URL for the page"},"page_number":{"type":"integer","description":"Page number"}}},"readOnly":true},"fields":{"type":"array","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.","items":{"type":"object","properties":{"key":{"type":"string","description":"Unique identifier of the field"},"value":{"type":["string","null"],"description":"Auto-filled value of the field"},"x":{"type":"integer","description":"X-coordinate location of the field on the page"},"y":{"type":"integer","description":"Y-coordinate location of the field on the page"},"width":{"type":"integer","description":"Width of the field"},"height":{"type":"integer","description":"Height of the field"},"page_number":{"type":"integer","description":"Page number of the field"},"data_type":{"type":"string","description":"The field's data type"},"required":{"type":"boolean","description":"Whether the field is required"}}},"readOnly":true},"signed_at":{"type":["string","null"],"description":"When the document was signed (will be `null` if unsigned)","readOnly":true},"description":{"type":"string","description":"The description of the document","readOnly":true},"requires_signing":{"type":"boolean","description":"A boolean flag that indicates whether the document needs signing or not. Note that this value will change after the document is signed."},"draft":{"type":"boolean","description":"If the document is in a draft state","readOnly":true},"year":{"type":["integer","null"],"description":"The year of this document. This value is nullable and will not be present on all documents.","readOnly":true},"quarter":{"type":["integer","null"],"description":"The quarter of this document. This value is nullable and will not be present on all documents.","readOnly":true}},"x-examples":{"Example":{"uuid":"e83b3c20-dc4f-4382-bee3-b478fc42c68b","title":"Taxpayer Identification (Form W-9)","name":"taxpayer_identification_form_w_9","recipient_type":"Contractor","recipient_uuid":"f079c253-29e2-45e2-b384-2cc615c9c568","pages":[{"image_url":"http://app.gusto-dev.com:3000/assets/document_templates/20/unmapped_template/images/0.jpg","page_number":0},{"image_url":"http://app.gusto-dev.com:3000/assets/document_templates/20/unmapped_template/images/1.jpg","page_number":1}],"fields":[{"key":"text1596141656513","value":null,"x":69,"y":94,"width":261,"height":13,"page_number":0,"data_type":"text","required":true},{"key":"optional_text1596141704672","value":null,"x":69,"y":118,"width":262,"height":13,"page_number":0,"data_type":"text","required":false}],"signed_at":null,"description":"Form W-9, Request for Taxpayer Identification Number and Certification","requires_signing":true,"draft":false,"year":null,"quarter":null}},"x-tags":["Documents"]}}}},"404":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided UUID is valid.\n"}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-contractor-document.api.mdx b/docs/api/get-v-1-contractor-document.api.mdx
new file mode 100644
index 000000000..ca2a9d06b
--- /dev/null
+++ b/docs/api/get-v-1-contractor-document.api.mdx
@@ -0,0 +1,71 @@
+---
+id: get-v-1-contractor-document
+title: "Get a contractor document"
+description: "Get a contractor document."
+sidebar_label: "Get a contractor document"
+hide_title: true
+hide_table_of_contents: true
+api: eJzdWVtv2zgW/itc7kNbQPIttpsYGGCDptMNMNsJ2mQ6iyRwaPHIYiuRCkk5MQL/98UhdXMsd5zO7mKxT0nEc+e58csTfQyXhbEqFNLCUjMrlAztOgc6u6aQLYBz4PQ2oJYtDX57p6TVLLJKkzMVFRlIa/Bc5eC5zzmd0SXYcDUMo5o45CUxDWjONMvAgkaBT1SyDOiMVgTzohCcBlRIOqM5swkNqIb7QmjgdGZ1AQE1UQIZo7Mn6k2lxmohl3QTUA4m0iJHS+iMXiZArq7Oz4iKiU2A1FZsglrx7+EHF4HTi/PwN9AGOUv1CTAOesuAmKUGnqs5Q28yIcF4LcxCuGAGODm9OCcrL5QwY1QkmAVOHoRNyFoV2hFELE175DwmUkkgwpBcq5XgwANPw/I8FZGL7itDrjMhRVZkbdm3rxNrczPr97mKTM9daS9SWb+6wjBna63S1J33WS7CklPI5V9LgWHr8xs0ozDAe3R/uAMKssgwK0aD0SQcTMPhBHOBQ8yK1NJZ+/tmc/s8bB/AEkaaJKmvp3cjb6SJVA4zctecz6tzM9PA+J27GJMracCgdaPBAH9sK3n/yLI8BVJR0oCiREyC2RNthbb/1SDDU9tdYVP096xJ3jICavEVIpfMGjPfCm+By92OOB2YlegP47/KdO0zfRNUJhwi0pEeItMn/kEi1zkQwUFaEQvQhwjXEIlcYCF78QerUTGpeXdqpa2VvH4QaUoWQO6abnRHYqVJV3d608rTdyrLmVzTgL7P8lStAdOhYcLk/Y5Dh93ulRT3xVbU0DJ04DD3uoKas6VPsFI105qtdzT/Iox9fkWvDHHMhEneVisytgRy9ekX0yOXiTBY70qma6LBFloCd1bXBefNvKv64NyIJbaOO/ITuUMb7wKnIGIS7wUbh+MvyUiuAbs+2okNRVjI2u7sqSZn47zQ6R8H/bxypw42ek3L0M1lkS1At8S4ceda+7acCxRTUm82m46riAWk/IfvwnM/vwzOLOuR31ha4EVpIAasc4QVVoWxSFOMp2P9372tb7D+keIoY+S8w/taYRQaQdeNJFmkKd0ZIqetEDneHYmPB9z772GklOZCMgskVX4ibEkiSm7l1foAqf98sdQHwW1ygOQvSLfjaQJimdgD2P/uCHf4f7hWdiRhRr9gADi+V8YVgpsGdNNeumoRC6VSYHI3HAnYBHQrrsKQmr+7kDHbgc+ZfUGyfUlAbs+iB2aIl9QaS8h8R0RMCunP3nQ19S3Rh0Sp9eWwSez8N1X5HxDHU1KekDhlS2ITZomQHDckMOShFeU6ABKAm7p1KE2ksj3yUVnw7BbblS9MF58oYXIJhMX2uSRRRbLnMkiz2B5g8nm8I0VIwojjJ8YyC13BWQPT7Ytvkrz75jH+yOMDL0yzq/qG7D0UhiA7W6TgOqzzWCqLWZFrMGggvgTStGnWvS7z7gumLbzYwpLtv2IkdtYQ/HbtBkC5aTd7MIXjo8VRNBqEPBrH4fjoeBQuAI7CxfjtcRyNR9H0eEHrHZdessecrUGT83I8lA3z9c9KZ+RLeIJlVL7abEk7F1u081jpbP4wP6G7m2h70dtd62g8eHsSjSZH4egERuF4AqNwcXQ8DkdRNB1OopNoMj2m9Sp2vbWeUHx+zfp9luf+8RVyWOEDbHY0GAz6zBiwpl8/cS1keYol1R8N+oXMWJ4Dr7/2nWDTH/S+5kv6rCsP8OX6n9Y87NI8xAdctf1cl/OeWni0w8nJdDgeTifTyfCI1iMck8xN3+mJG5cn43q+jabDZloNj577uDU/nIodEADD4C1QrgBYOm+Z8nYwnr4d7TdlODxu2TL6E7Y4PAAj0xonXtt2dVYpHJBPcF+A8fvdvoz/6KcqVuc73LCqA9rV1T0mUvbLEp/w7c0bUvcS/NOXbYXmtCCcjZuS48F49wn9UVnysyokJzeSkBt56d4yzgvg+LBWhY6wBYNxfQQehbE98g/2DYgpNPgNp8Q0/MvXNyPBezeSepNMDuwbMLMOscJDtQKtBQcPJtFtiqVWRU5ntIEGGkcCCo8WJIIY7Tzdi3PVOdLGu5rs2m9YzegM7ObwhjaUXQZj8mRgE8VrXx3sNaP91bCuXNN/2kLINojLgF5VKFrTDIzrBqLuBplDgnbm5hlk6llYvbzQdUPkc07tEdwp80Ir/h2ZOR67WoGo0MKuneXlm/w0isCY0wI9v75tU31GPMaPmA7aekFAEyuwyi0MwHTH1lqKCFNYQYoPrAQrryyvTUA/r42F7M9o8BL2KNggtBirNrrk4EdE8zBRSgByCzoLKMKL5tf4M+iViKB1Hw3SxxaqsH1H2OeoGt9mofs7VLG7B2Td2WghjVQGxCri7HhlyPuyDMiFxwwd0Fgln3PjLyWIxiK3oZUj+azSSj5B6uhcNWZMpC6hytO/NfmD0ciVsRmTLTl7YcHnxj81SN6/A0tstfh+njLh0qFEH3xFXtPVEI1oNZvZNm59G9BEGYukT08IAV/pdLPBz/cFaEz4W+wGWuD25dKfC4O/74GW2y6+/lROnTfkOwhipxcVVOGgr6oZ0aDsWNsubG7dS9Ih3y8z8P8cBu+MrI9g9/8Q6kA3wwH7Sm5bZzsA9NY4+PD+km42/wIt8vLK
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Get a contractor document.
+
+scope: `contractor_documents:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-contractor-documents.ParamsDetails.json b/docs/api/get-v-1-contractor-documents.ParamsDetails.json
new file mode 100644
index 000000000..e23083315
--- /dev/null
+++ b/docs/api/get-v-1-contractor-documents.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"contractor_uuid","in":"path","required":true,"schema":{"type":"string"},"description":"The UUID of the contractor"},{"name":"X-Gusto-API-Version","in":"header","required":false,"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.","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"}}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-contractor-documents.RequestSchema.json b/docs/api/get-v-1-contractor-documents.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-contractor-documents.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-contractor-documents.StatusCodes.json b/docs/api/get-v-1-contractor-documents.StatusCodes.json
new file mode 100644
index 000000000..fa959e3e6
--- /dev/null
+++ b/docs/api/get-v-1-contractor-documents.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"Example response","content":{"application/json":{"schema":{"type":"array","items":{"title":"Document","type":"object","properties":{"uuid":{"type":"string","description":"The UUID of the document","readOnly":true},"title":{"type":"string","description":"The title of the document","readOnly":true},"name":{"type":"string","description":"The type identifier of the document","readOnly":true},"recipient_type":{"type":"string","description":"The type of recipient associated with the document (will be `Contractor` for Contractor Documents)","enum":["Company","Employee","Contractor"],"readOnly":true},"recipient_uuid":{"type":"string","description":"Unique identifier for the recipient associated with the document","readOnly":true},"pages":{"type":"array","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.","items":{"type":"object","properties":{"image_url":{"type":"string","description":"Image URL for the page"},"page_number":{"type":"integer","description":"Page number"}}},"readOnly":true},"fields":{"type":"array","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.","items":{"type":"object","properties":{"key":{"type":"string","description":"Unique identifier of the field"},"value":{"type":["string","null"],"description":"Auto-filled value of the field"},"x":{"type":"integer","description":"X-coordinate location of the field on the page"},"y":{"type":"integer","description":"Y-coordinate location of the field on the page"},"width":{"type":"integer","description":"Width of the field"},"height":{"type":"integer","description":"Height of the field"},"page_number":{"type":"integer","description":"Page number of the field"},"data_type":{"type":"string","description":"The field's data type"},"required":{"type":"boolean","description":"Whether the field is required"}}},"readOnly":true},"signed_at":{"type":["string","null"],"description":"When the document was signed (will be `null` if unsigned)","readOnly":true},"description":{"type":"string","description":"The description of the document","readOnly":true},"requires_signing":{"type":"boolean","description":"A boolean flag that indicates whether the document needs signing or not. Note that this value will change after the document is signed."},"draft":{"type":"boolean","description":"If the document is in a draft state","readOnly":true},"year":{"type":["integer","null"],"description":"The year of this document. This value is nullable and will not be present on all documents.","readOnly":true},"quarter":{"type":["integer","null"],"description":"The quarter of this document. This value is nullable and will not be present on all documents.","readOnly":true}},"x-examples":{"Example":{"uuid":"e83b3c20-dc4f-4382-bee3-b478fc42c68b","title":"Taxpayer Identification (Form W-9)","name":"taxpayer_identification_form_w_9","recipient_type":"Contractor","recipient_uuid":"f079c253-29e2-45e2-b384-2cc615c9c568","pages":[{"image_url":"http://app.gusto-dev.com:3000/assets/document_templates/20/unmapped_template/images/0.jpg","page_number":0},{"image_url":"http://app.gusto-dev.com:3000/assets/document_templates/20/unmapped_template/images/1.jpg","page_number":1}],"fields":[{"key":"text1596141656513","value":null,"x":69,"y":94,"width":261,"height":13,"page_number":0,"data_type":"text","required":true},{"key":"optional_text1596141704672","value":null,"x":69,"y":118,"width":262,"height":13,"page_number":0,"data_type":"text","required":false}],"signed_at":null,"description":"Form W-9, Request for Taxpayer Identification Number and Certification","requires_signing":true,"draft":false,"year":null,"quarter":null}},"x-tags":["Documents"]}}}}},"404":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided UUID is valid.\n"}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-contractor-documents.api.mdx b/docs/api/get-v-1-contractor-documents.api.mdx
new file mode 100644
index 000000000..11d050840
--- /dev/null
+++ b/docs/api/get-v-1-contractor-documents.api.mdx
@@ -0,0 +1,71 @@
+---
+id: get-v-1-contractor-documents
+title: "Get all contractor documents"
+description: "Get a list of all contractor's documents"
+sidebar_label: "Get all contractor documents"
+hide_title: true
+hide_table_of_contents: true
+api: eJzdWVtvGzcW/itc7kMSQKORZFmxBRRYI05TA93USOymC9uQqeEZiQmHHJMc2YKh/7445Nx0sSunu0XRp0TDc+e58fMjfYhmhXU6EsrBzDAntIrcMgc6vqKQTYFz4PSmQx2bWfz2TitnWOK0Iac6KTJQzuK5ziFwn3E6pjNw0aIfJTVxxGviDuVgEyNypKZj+gEcYUQK64hOCZOSNGyvLKkZr9W1sonOYUxuG4pJfT42wPgt7dCcGZaBA4MGP1LFMqBj2mIpCsFphwrUnjM3px1q4K4QBjgdO1NAh9pkDhmj40cagkGtM0LN6GrT+os5kMvLs1O03c2hZTtddWrlv0UffJRPzs+iX8FY5C0NmAPjYNZMSJm0sKnoFD3KhALr9XDmIJoyC5ycnJ+RRRBKmLU6EcwBJ/fCzclSF8YTJEzKLjlLidIKiLAkN3ohOPBOoGF5LkXib/CVJVeZUCIrsrbsm9dz53I7jmOuE9v1adNNdBZXaRLlbGm0lP48ZrmISk6hZv8sBUatz2/QjMIC79KnA96hoIoMM2/QGxxGvVHUP8R845CyQjo6bn9frW4wjjbXyoJFYYNeD/9ZD+X7B5blEkhFSTs+O0A5pG1FIv5qkeFx2zpmDFviFTrIvCInnMSDqihopyLV06+Q4O/cYJE4ESzzSbjD3efTizfiMd1/UXIZUnbVqUzYR6Qn3UdmyN+9RC5zIIKDciIVYPYRbiARuQDlJkH83mp0SmrerZRvayWv74WUZArktmlctyTVhuxqZG9a6fZOZzlTeMfvs1zqJWCaNEz05lmH9rvdSyXuirWooWXowH7u7QpqzmYhwTYydV3zz2W7bUt7ZYlnJkzxtlqRsRmQy08/2y65mAuLZauVXBIDrjAKuLe67sPBzNuqnU2smGEHuCU/kFu08bbjFSRM4b1g/Xv+kozkBrCBo53dtQJ7tpq8jZPCyN8P+lnlTh1s9JqWoZuoIpuCaYnxk9F36HU55yimpF6tVjuuIhUg+XffReDevAzOHOuSX5ks8KIMEAvOO8IKp6NUSInx9Kx/3dv6BsvvKY4yRt47vK8FRqERdNVIUoWUYUq0JZ60QuR5tyQ+7HHvv0WJ1oYLxRwQqcOkWJNEtFrLq+UeUv/zYqn3grv5HpK/IN2Wp3MQs7nbg/0nT7jF/921siUJM/oFA8Dz4V7IHPPTgK7au1MtYqq1BKa2wzEHNwfTiquwpObfXciY7cAnzL0g2b7MQa3PontmSZDUGkvIfEtESgoVzt7sauproveJUuvLfpPY+2+r8t8jjiekPCGpZDPi5swRoThuTmDJfSvKdQAUALd169CGKO265KN2ENgdtqtQmD4+yZypGRCWuk1Joopk12eQYanbw+SzdEuKUIQRz0+sYw52BWcJzLQvvkny3TeP8UeeEHjRPGHKhhw8FJYgO5tK8B3We6y0w6zIDVg0EBd6KZtm3d1l3l3BjIMXW1iy/SlGYmeNIGzdfgCUG3izB1M4OpgeJINexJNhGg0PjgbRFOAgmg7fHqXJcJCMjqa03nHpBXvI2RIMOSvHQ9kwX/+oTUa+RMdYRuXjy5W0E7FGO0m1ySb3k2O6vYm2F73ttY6mvbfHyeDwIBocwyAaHsIgmh4cDaNBkoz6h8lxcjg6ovUqdrW2nlB8RY3jmOV5eENFHBb4jhof9Hq9mFkLzsZVNCcOslxiScWDXlyojOU58Ppr7AXbuNf9ms/oRlfu4QP0/625v0tzH99h1fZzVc576uDB9Q+PR/1hf3Q4Ouwf0HqEY5L56Ts69uPyeFjPt8Go30yr/sGmj2vzw6vYes1jGIIF2hcAk5OWKW97w9HbwdOm9PtHLVsGf8AW/6zHyLTGSdC2Xp1VCnfIJ7grwIb97qmM/ximKlbnO9ywqgO6q6sHcKPslyXMENpbMKTuJfgzlG0F/LTQntXKj8lhb7j9tv6oHflRF4qTa0XItbrwjxnvBnB8cevCJNiDwfpGAg/Cui75N/sGxBYGwopTYhPh6Ru6keDda0WDTTYH9g2YXUYzo4t8Dd05bQFNbUpsBpFegDGCQ4CoTqTEB9+DA4V4RDtXn4TF6jxpw2NNhm3bVjPstHE357qtjYTSZsyhDNxcl1CbLz/MTxov+nGjxsaPG6jXKm7jcBbMokLJmg5hfYsQdYvIPMqzNUxPIdMbIQ7yIt8ikc9794TgnTLPjebPyMzx2BcQJIURbuktLx/qJ0kC1p4UGIermzbVZwRvwtzZQVtvDWhiBUT5LQKY2bHKliIiCQuQ+OqaYzmWNbfq0M9L6yD7IxqChCcUrBA2THUbcvLQIiJ1mCkluLgGi3UoQof2l/QzmIVIoHUfDYrHprpwsSeMOarGB1vkf0c69feArFtrLshEZ0CcJt6OV5a8L+uCnAc80IOIVd55N/5RIm4s8WtbOadPK63kE0hPh0kKGRPSJ1R5+q8mfzAaubYuY6olxwPKazAyeRJ9fmyQv/89EN0aBHEumfD5UWIUoWCv6KJfxqIsWdqh422ourH/pkPn2jpkfXxE/PfSyNUKP98VYLAibrBfGIE7m68PLiz+/wlcuR2A15/KWfWGPANrP+FXBXF4yKxqWLRTdrdNl1Y3/g3qoe+XGfk3x8F3xjbEcPcfEepQN6MEm0/uWmdbkPbaBPnw/oKuVv8FQlAYhQ==
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Get a list of all contractor's documents
+
+scope: `contractor_documents:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-contractor-form-pdf.ParamsDetails.json b/docs/api/get-v-1-contractor-form-pdf.ParamsDetails.json
new file mode 100644
index 000000000..b408bbb04
--- /dev/null
+++ b/docs/api/get-v-1-contractor-form-pdf.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"contractor_uuid","in":"path","required":true,"schema":{"type":"string"},"description":"The UUID of the contractor"},{"name":"form_id","in":"path","required":true,"schema":{"type":"string"},"description":"The UUID of the form"},{"name":"X-Gusto-API-Version","in":"header","required":false,"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.","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"}}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-contractor-form-pdf.RequestSchema.json b/docs/api/get-v-1-contractor-form-pdf.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-contractor-form-pdf.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-contractor-form-pdf.StatusCodes.json b/docs/api/get-v-1-contractor-form-pdf.StatusCodes.json
new file mode 100644
index 000000000..860e6309e
--- /dev/null
+++ b/docs/api/get-v-1-contractor-form-pdf.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"Example response","content":{"application/json":{"schema":{"title":"Form Pdf","type":"object","properties":{"uuid":{"type":"string","description":"the UUID of the form","readOnly":true},"document_url":{"type":["string","null"],"description":"the URL of the form"},"document_content_type":{"type":["string","null"],"description":"The content type of the associated document. Most forms are PDFs with a content type of `application/pdf`. Some tax file packages will be zip files (containing PDFs) with a content type of `application/zip`. This attribute will be `null` when the document has not been prepared.","readOnly":true,"title":"Form-Document-Content-Type-Type"}},"required":["uuid"]},"examples":{"Example":{"value":{"uuid":"48cdd5ec-a4dd-4840-a424-ad79f38d8408","document_url":"https://app.gusto-demo.com/assets/forms/7757842065202782/original/company_direct_deposit20211007-48226-gsqo8k.pdf?1633667020","document_content_type":"application/pdf"}}}}}},"404":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided UUID is valid.\n"}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-contractor-form-pdf.api.mdx b/docs/api/get-v-1-contractor-form-pdf.api.mdx
new file mode 100644
index 000000000..90b85993c
--- /dev/null
+++ b/docs/api/get-v-1-contractor-form-pdf.api.mdx
@@ -0,0 +1,71 @@
+---
+id: get-v-1-contractor-form-pdf
+title: "Get the contractor form pdf"
+description: "Get the link to the form PDF"
+sidebar_label: "Get the contractor form pdf"
+hide_title: true
+hide_table_of_contents: true
+api: eJzdV99v2zYQ/lc47qEtIFqO6ySeXragaYsA2xo06TYgCRJaPNtcJJIlKTeuof99OJKKZScpunV7WR4cW+T9/u7u05resXnjvGZSeZhb7qVWzK8M0OKCQj0FIUDQq4x6Pnf47JVW3vLSa0veaFs7PNMGouSJoAWdg2fLPVbeX2QzbWtmxIxm1HDLa/BgUdmaKl4DLejm7nXTSEEzKhUtqOF+QTNq4WMjLQhaeNtARl25gJrTYk2jo9R5K9WcthkV4EorDfpCC3q+APLhw8kx0TPiF0A2Zmib3RtH767/O6Oovm/uD/Y2JPzo9IT9BtahVDK9AC7Abhmf8crBroljTGAtFbhgQXAPbModCHJ0ekKWUSnhzulScg+CfJJ+QVa6seFCyatqQE5mRGkFRDpirF5KASKLd7gxlSxDQZ85clFLJeum7uu+er7w3rgiz4Uu3SAgaFDqOu8QwwxfWV1V4TznRrIkKdX8+6SQ9R6/QDcaB2JAn051RkE1NYJwNBzts+EB29tH+AmY8abytOg/b9ur3bS9BR/yVUl1S7y+rw45PX5zqS6VK7WBgtz00IjHrrDAxU0oizNaOXDo22g4xH/bJl7f8dpUQLqbNAvYBuXxbi+x+Z8OBdb9YKWvMNo3waXQLSl+Pf0TSo/dY7HVvIwehFZ5JEvbLvnH8IixcPFOVauIb0SxLpsalL9ubLXRerFRq5qqog+SGtS//3kH7RttKfzrqO6r1Z6ndgXlCYp0+nug7kwMyC/a+WDZEW4By+ki5PkDHTf9GhgxuxmQM10D8fyOzGQFxPDyls8BFVQVmQL5LE04ceQ5KuMSMRxsvPgqI5+luRmQ84V0hHtv5bTxcK/8BqO/IZ8WoGIrp5jIgjuitCdTAEWMBcNtbI7tumVbqGHHSZy9ih6x85WB8EHbtj9WLiJ4rtqMQoRsQFSCL35d8qqBDcroeFIKsQ8l42Mh2HgyHjI+Ho0ZF4c/zF5OxGQ8nNBdFNFuTHBj4pRgAuo4Krhz4F0eypYfHu4fTsaj4cH+aDg6nIxybeVcKl7lpa4NV6trIS2U/lqA0U760XC0tzccHrLxZDQ6YHP3UU9uB0bMftw7ePny4OBwOBrSJ1FId0BA2/CX0fFw/LCnf9WevNGNEuRSEXKpEJqYSXCIQgtON7bE0kEsGdxJh6Dkt0BcYyEUthuxsRWlI0teSTG4VKEwd8wZ4LfA3YrNrW7M1k6Me3b7Fi4TppdgrRQQl24cGXDnQeFIjQv2Fla0eHrJZ12d+8sel1Unt+vXvcAD/x6X2vZzI538xSFdg1/oRBwCQ/ALWtB8uZdvTLh8vcMR2oScdVrfbR4JhgO77NjFLgblDgYfzMpjqPVOoqM+FnoA5UKcTyh+VOep1eILOg0eYxoclI2VfhU8fxVRf1SW4NxRgxm5uOrfOsO1EZv2kbv3OwFd7DYq/p4Ct4FhbPuYVLAKllAR3vgFKJ8aBKf52cp5qL/FQtTwhIEW+c9M95dg4EhIORAziSVt7feMIgdy72ZnYJeyhF49NnSET3Xj83AxF2ga1ycLv5mehTqg6K6zv0NVhqWgSfDjmSOvU3eQ00hsAhvqxksI47u063kZdn1ie8edVfIeqnAPOxlqLqsAqHT60wY/mA2jna+56unpuMumCyJ1iaDfcn+9oRzfTnlSlT3c+dxUXAY4JIYQO/WCLvdS6KlXaUaLh4x+lqZYseHb6PxVRhfaedSzXiOJ/WCrtsXHHxuw2A1XODWs5FMExsWaCunw+xPkuB/98/dp4b0gX3gVeCLIblWoVW9s0SzNuN34cCr8K44levYPXOry2uJWT68Sfy9f//P3ikdzGnP3+EvZfYo3uw1noPG9swecfmulvX19Ttv2L6OlWQw=
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Get the link to the form PDF
+
+scope: `contractor_forms:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-contractor-form.ParamsDetails.json b/docs/api/get-v-1-contractor-form.ParamsDetails.json
new file mode 100644
index 000000000..b408bbb04
--- /dev/null
+++ b/docs/api/get-v-1-contractor-form.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"contractor_uuid","in":"path","required":true,"schema":{"type":"string"},"description":"The UUID of the contractor"},{"name":"form_id","in":"path","required":true,"schema":{"type":"string"},"description":"The UUID of the form"},{"name":"X-Gusto-API-Version","in":"header","required":false,"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.","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"}}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-contractor-form.RequestSchema.json b/docs/api/get-v-1-contractor-form.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-contractor-form.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-contractor-form.StatusCodes.json b/docs/api/get-v-1-contractor-form.StatusCodes.json
new file mode 100644
index 000000000..1b36766da
--- /dev/null
+++ b/docs/api/get-v-1-contractor-form.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"Example response","content":{"application/json":{"schema":{"title":"Form","type":"object","properties":{"uuid":{"type":"string","description":"The UUID of the form","readOnly":true},"name":{"type":"string","description":"The type identifier of the form","readOnly":true},"title":{"type":"string","description":"The title of the form","readOnly":true},"description":{"type":"string","description":"The description of the form","readOnly":true},"draft":{"type":"boolean","description":"If the form is in a draft state. E.g. End of year tax forms may be provided in a draft state prior to being finalized.","readOnly":true},"year":{"type":["integer","null"],"description":"The year of this form. For some forms, e.g. tax forms, this is the year which the form represents. A 1099 for January - December 2022 would be delivered in January 2023 and have a year value of 2022. This value is nullable and will not be present on all forms.","readOnly":true},"quarter":{"type":["integer","null"],"description":"The quarter of this form. This value is currently always null since it is not present on any contractor forms.","readOnly":true},"requires_signing":{"type":"boolean","description":"A boolean flag that indicates whether the form needs signing or not. Note that this value will change after the form is signed.","readOnly":true},"document_content_type":{"type":["string","null"],"description":"The content type of the associated document. Most forms are PDFs with a content type of `application/pdf`. Some tax file packages will be zip files (containing PDFs) with a content type of `application/zip`. This attribute will be `null` when the document has not been prepared.","readOnly":true,"title":"Form-Document-Content-Type-Type"},"contractor_uuid":{"type":"string","description":"The contractor UUID","readOnly":true}},"x-examples":{"Example":{"uuid":"48cdd5ec-a4dd-4840-a424-ad79f38d8408","name":"US_1099","title":"Form 1099: 2020","description":"Form 1099 records your annual income as a contractor.","draft":false,"requires_signing":false,"year":2020,"quarter":null,"document_content_type":"application/pdf","contractor_uuid":"123dd616-6dbc-4724-938a-403f6217a933"}},"x-tags":["Forms"],"required":["uuid"]}}}},"404":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided UUID is valid.\n"}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-contractor-form.api.mdx b/docs/api/get-v-1-contractor-form.api.mdx
new file mode 100644
index 000000000..633087966
--- /dev/null
+++ b/docs/api/get-v-1-contractor-form.api.mdx
@@ -0,0 +1,71 @@
+---
+id: get-v-1-contractor-form
+title: "Get a contractor form"
+description: "Get a contractor form"
+sidebar_label: "Get a contractor form"
+hide_title: true
+hide_table_of_contents: true
+api: eJzdWG1vGzkO/is83YdtgRnbcdw08acLmrbIAbcbbNrbBZIgoUe0re2MNJU0TlzD//1ASbbHL9mm2Lsv9yUvMyL5kCIfkrMQT/mkcd7kSnuaWPTK6NzPaxLDG0HViKQkKe4y4XHi+Nk7o73FwhsLH4ytHL8zNUXJSymGYkI+nx3lxfpgPja2Epmo0WJFniwrWgiNFYmh2Jy7bxolRSaUFkNRo5+KTFj62ihLUgy9bSgTrphShWK4EBGkcN4qPRHLTEhyhVU14xBD8WlK8Pnz5QWYMfgpwcaMWGZr44zs/n9nNDjeMvd7/jEE+/zqMv83WcdSyfSUUJLdMj7G0tGuiQsOYKU0uWBBoqd8hI4knF9dwiwqBXTOFAo9SXhUfgpz09hwoMCy7MDlGLTRBMpBbc1MSZJZPIN1XaoiXOZPDm4qpVXVVG3dd6+m3tdu2O1KU7hOyJ5OYaruKlvyGufWlGV438Va5UlS6cnfk8K89fg1w2gcyY54PtSZIN1UnID9Xv9N3jvJj95w6kkaY1N6MWw/Xy7vdsP2kTxgKwnC1dzqW+0KU9MQHlppyK/c0BLKh3AfrjbakWNQ/V6Pf23rfv+EVV0SrE6KLCQ1ac9nWxHt/uFYYNH2UvmS3fwQSyQ5bUZ/UOG5ZCzXllfReqiPA6F5QRKyHyh/0eU8JvUySzn5Em18ApQk7dVYkf2e4uTTizTz0e/p2xJ7idbWk+/qtjj2La0jY0pCvaf2cqOG01VpQAiy4Dx66sD7zqQD77Vkg3NCCx6fwnEHFc5hROtK2xOG2ipjwRsYkdITGCuNpfoWC2IPMSvfAL4RgbgDc+imLMVe5nNAAqAQCeUCqA6TNzhTRZdcBsT415izeFRFkgnij1NVTDdBsFRbcqS968A5HPXOzvg5/BN1g3YOOVxQwYxgod/r9+HRNKXkKEgq1YxsDMPqdL/XPwbUEqY4I8BocIZlE3KDFXTgEwOKz5QD9hVHJQWpR1WWoI2PUQ6ogEmwLKM3B+P4tUHr6YdDmcR2orkNrmisJe3LOWD5iPOIFpzSBYHyAb7xW0j1fJebDoNOzcHdOzVhPn1B5p5DegPjEifgp+hBacmURA4ep+SnZDf3qomkg6QejGWoHfjZeIqifuNpCHsxRT0hwLFva1FRxTMpLE3RVKT9faLJ++jC5iLWtf38PSTRyE2pyFtdb2WiA/8yzqdCREtwdfHBxZ6Iezoe2lxdy/FDB665REJZqJKgxuILTjhs7PqI4JuqwxsHr1gZqhA1tvH6RUa+qfohZQ96b9Wo8bRW/sDeP/AV6djrk08wRZfSnTSnUY32UKSzre6SXyTx/F1ElH+a1xR+8CCzO4a9iGhbOcsdZ/+ul5l4yin2x9DCUq/cdDMxOC2kfENFjgMp88HpoJfjoD/IUb49Gx+fytNB71SsupX4fH3PXCO2fQv8M2Si6O3hXL8HS4Wx0qVBR+sGS1C64BtGtzUdcCxTZ0hD2H7hpReRjtlyi1L44p5Nc7GTZeJA8MVR/1jKk6OT/ESOinzwtj/Iz45PMR/0jscn/aO3eHZ8LGJ4V5P5ehzfTJA3Mch3yyUfHfQG+8PLz8bDB9NoCbca4FbztbICclxGlpxpbMG5RzHn6Ek5rir8QuAaSyEz160tzB2RIJTs3OoE0dWEXwjdPJ9Y09RbU3+EvX2KLzs3M7JWSYorBU+AT540T4xxf/hCczF8fn/JRGCp7T2GZ/GV3C6otcAeuMNS2yA30gyWB9CK/NTINfqwWwxFd3bU3eh33cXO3S+7gau6i7SaLHkoJjtbbU2NLXlbSCM41ipO4LmkKozhe/l/QZXZCW/Ul4dEY7ng4DOKD+q8skb+ic6aX3MIHBWNVX4ekL8zVY16fl4U5Nx5w9G4uWufuuapONLEgbNrPmKIq00hND5CG5r2NsakIi9pRiVg46c8v8ayY8K7njtP1V+xEDU8Y2DJe93YtGf8sPvxKsXJkra/rb0lE7zbuV/G12RnqqDWfWzWLByZxnfDwa5k07wh5OH/3IzDPbDoLtjfqAxM5w0EHD85eJ/KAq7iwha2vBVpBTf+lrgJizAjJw6+WFmFX6kM57h+qUJVhoRKb/+xyR+ORm2cr1C39BzcyXaBLza71F9Y4tLFenry3bpEFTIgZPwiFeaNmB1tMTH7NNz/ODFOdDVcfTq4y8TUOM8aFgvexD/bcrnkx18bspz6d8wNVvG4GgpBKsd/P7Phtx1+9Wui8tfwJ98znnFv1W30vEVOIktMtusZU8B/Bdh4a5P9EUiriC7vltnqe8iPxev//OPIwZjG2B3+srQO8aaDMeHVvvVu7/vEVu/6+P6TWC7/A8W3/kk=
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Get a contractor form
+
+scope: `contractor_forms:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-contractor-forms.ParamsDetails.json b/docs/api/get-v-1-contractor-forms.ParamsDetails.json
new file mode 100644
index 000000000..e23083315
--- /dev/null
+++ b/docs/api/get-v-1-contractor-forms.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"contractor_uuid","in":"path","required":true,"schema":{"type":"string"},"description":"The UUID of the contractor"},{"name":"X-Gusto-API-Version","in":"header","required":false,"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.","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"}}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-contractor-forms.RequestSchema.json b/docs/api/get-v-1-contractor-forms.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-contractor-forms.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-contractor-forms.StatusCodes.json b/docs/api/get-v-1-contractor-forms.StatusCodes.json
new file mode 100644
index 000000000..140b60021
--- /dev/null
+++ b/docs/api/get-v-1-contractor-forms.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"Example response","content":{"application/json":{"schema":{"type":"array","items":{"title":"Form","type":"object","properties":{"uuid":{"type":"string","description":"The UUID of the form","readOnly":true},"name":{"type":"string","description":"The type identifier of the form","readOnly":true},"title":{"type":"string","description":"The title of the form","readOnly":true},"description":{"type":"string","description":"The description of the form","readOnly":true},"draft":{"type":"boolean","description":"If the form is in a draft state. E.g. End of year tax forms may be provided in a draft state prior to being finalized.","readOnly":true},"year":{"type":["integer","null"],"description":"The year of this form. For some forms, e.g. tax forms, this is the year which the form represents. A 1099 for January - December 2022 would be delivered in January 2023 and have a year value of 2022. This value is nullable and will not be present on all forms.","readOnly":true},"quarter":{"type":["integer","null"],"description":"The quarter of this form. This value is currently always null since it is not present on any contractor forms.","readOnly":true},"requires_signing":{"type":"boolean","description":"A boolean flag that indicates whether the form needs signing or not. Note that this value will change after the form is signed.","readOnly":true},"document_content_type":{"type":["string","null"],"description":"The content type of the associated document. Most forms are PDFs with a content type of `application/pdf`. Some tax file packages will be zip files (containing PDFs) with a content type of `application/zip`. This attribute will be `null` when the document has not been prepared.","readOnly":true,"title":"Form-Document-Content-Type-Type"},"contractor_uuid":{"type":"string","description":"The contractor UUID","readOnly":true}},"x-examples":{"Example":{"uuid":"48cdd5ec-a4dd-4840-a424-ad79f38d8408","name":"US_1099","title":"Form 1099: 2020","description":"Form 1099 records your annual income as a contractor.","draft":false,"requires_signing":false,"year":2020,"quarter":null,"document_content_type":"application/pdf","contractor_uuid":"123dd616-6dbc-4724-938a-403f6217a933"}},"x-tags":["Forms"],"required":["uuid"]}}}}},"404":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided UUID is valid.\n"}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-contractor-forms.api.mdx b/docs/api/get-v-1-contractor-forms.api.mdx
new file mode 100644
index 000000000..460fc5029
--- /dev/null
+++ b/docs/api/get-v-1-contractor-forms.api.mdx
@@ -0,0 +1,71 @@
+---
+id: get-v-1-contractor-forms
+title: "Get all contractor forms"
+description: "Get a list of all contractor's forms"
+sidebar_label: "Get all contractor forms"
+hide_title: true
+hide_table_of_contents: true
+api: eJzdWN9vGzkO/ld4uoe2wIztOG6a+OmCJi2ywO0Gm/Z2gSRI5BHt0VYjTSWNE9fw/36gJNvjX20Wu0+bhyaVSOojRX4iZ86e80njvMml9jix3Eujcz+rkQ1vGVYjFAIFu8+Y5xNHa++N9pYX3lj4YGzlaM/UGDWvBBuyCfp8epQXK8F8HAQzJtAVVtYkyYbsI3rgoKTzYMbAlYK1yisHQelO32lXmBqH8LjefQh7Q4tcPLKM1dzyCj1aAjhnmlfIhqwl3jRSsIxJOrXmvmQZs/i1kRYFG3rbYMZcUWLF2XDOovPMeSv1hC22UX8qET5/vrogzL7EFma2yFaH/55/DFE9v77K/4fWkW4CUCIXaDcgjLlyuH3QBXlUSY0unCO4x3zEHQo4v76CaTQK3DlTSO5RwJP0JcxMY4NAwZXqwNUYtNEI0kFtzVQKFFmU4XWtZBFu7ZWD20pqWTVV2/b969L72g27XWEK1wlp0ilM1V2mRV7zmTVKhf0ur2WeNKWe/DsZzFvLbwhG41B02OGAZwx1U1Gm9Xv9t3nvJD96SzkmcMwb5dmwvb5Y3FMcXW20Q0fG+r0e/doM5eUzr2qFsJRkWcgO1J5kW5Ho/uFIYb6LjlvLZ3SFHqtwkJde0QYVAcuWYmb0BxaectJSUXgZUYUE3OPq91NrHE1Tmv+i1Sym6iJLOfYSayQBUqD2cizR/shw8ulFlkn0R/Y21F5itbXyQ9uWj33L6sgYhVzvmL1am6H0kxo4BF1wnnvswGVn0oFLLejAGXILnj9H8oGKz2CEq8rZUYbaSmPBGxih1BMYS82V/BYTfAcxGV8DvmWBcQMT6EapmOPbAQmAQiRkZMQOsS44U0WXXAZI+FeYsygqI2kE9adSFuU6CBZriw61dx04h6Pe2Rmtw09cN9zOIIcLLKjCLfR7/T48mUYJioJAJadoYxiW0v1e/xi4FlDyKQKPB065akJukIEOfCJAcU06IF/5SGHQepJKgTY+RjmgAiI1paI3e+P4teHW458OZVLbiuYmuKKxFrVXM+Dqic8iWnBSFwjSB/jGbyDVs9YL8B3Qiezdg5MT4scXZO45pB0YKz4BX3IPUguiKnTwVKIv0a7vVSMKB8k8GEtQO/Cz8RhV/drTEPai5HqCwMe+bUVGEwdSWJiiqVD7h0SfD9GF9UWsavvwPSTVyE2pyFuv2PKIDvzXOJ8KkVuE64sPLr5xfMfGY5vDazF+7MANlUgoC6kQal584RMKG7k+Qvgm67Dj4DUZ4zJEjc5486JDvsn6MWUP997KUeNxZfyRvH+kK9Lx7U4+QcldSnfUlEY1t/sinW28LvlFUs/fR0T5p1mN4R9qT7b7nBcRbStn6cXZvetFxp5zjO9meMLSG7p+zdjgtBDiLRY5HwiRD04HvZwP+oOci3dn4+NTcTronbLla8U+3zwQ17BN3wL/DIkoejs4V/tgsTBWuNS4aN1wBVIXdMPcpZuK3lAs08uQmqrdwksbkY7p5Bal0MUdTHO2lWVsT/DZUf9YiJOjk/xEjIp88K4/yM+OT3k+6B2PT/pH7/jZ8TGL4V221Ks+et0R3sYg3y/oJ2OD3mC3q/nZePhgGi3gTgPcabpXsoCO6siiM40tKPkwJh0+S0dlxb8guMZiSM3V2xYaj8gQUnTudMLoauRfkLtZPrGmqTf66g+prW9L0W3nZorWSkEho/aeerpnj5p6wNiif8EZGx4ePTIWeGpzBKHueqm3jWqlsINuv9YmyrV2QEs9ZYW+NGmYCROGL9mQdadH3fUBrjvfuv5FdznpOLTT5TzSWEVtf+qleS1jK50LrEI/vZP4F1iZrbBGe3nIMNILfh0wvNfmtTXiOzZr2ibHHRaNlX4WkL83Vc317Lwo0LnzhmJwe9+WuqE2OfLDHtkVERHEZcsfXjzkNrzWmxiTiVzhFBXwxpfUuMZ6I6a7mTmP1V85IVo4cMCCBrSxaTf3YYijmYhyJI1xGwNIxmhIc7+Mb9BOZYGt+1jPS3xkGt8Ngl1BR9NokIf/52Yc7oFUt8H+hipQnDcQcLxycJmqAa7j5BXGtSVbBTf+lUiJF6E5TuR7sTwVfkUV5ChJseJShYRKu/9Z5w9FozbOV1y37ISRfWNQh72z/Xw9X/19Y366ao/PvlsrLkNOhBqYpwK9ZdOjDVImYMPdDwHjJeGWxnlSm89psv5s1WJBy18btFQB98QMVlK7GupBSEd/H5jY206//jVR+Rv4zgeDAz4tXxs9a1ETyxKPbbuzuF9ky48Kfw7kP/wLw97Yxhju/zyzCvX60SCyqX1rb+djwcZr8fHyE1ss/g9FHrkv
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Get a list of all contractor's forms
+
+scope: `contractor_forms:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-contractor-payment-groups-contractor-payment-group-id.ParamsDetails.json b/docs/api/get-v-1-contractor-payment-groups-contractor-payment-group-id.ParamsDetails.json
new file mode 100644
index 000000000..00fa9a90c
--- /dev/null
+++ b/docs/api/get-v-1-contractor-payment-groups-contractor-payment-group-id.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"contractor_payment_group_uuid","in":"path","required":true,"description":"The UUID of the contractor payment group","schema":{"type":"string"}},{"name":"X-Gusto-API-Version","in":"header","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"},"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."}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-contractor-payment-groups-contractor-payment-group-id.RequestSchema.json b/docs/api/get-v-1-contractor-payment-groups-contractor-payment-group-id.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-contractor-payment-groups-contractor-payment-group-id.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-contractor-payment-groups-contractor-payment-group-id.StatusCodes.json b/docs/api/get-v-1-contractor-payment-groups-contractor-payment-group-id.StatusCodes.json
new file mode 100644
index 000000000..39c60f815
--- /dev/null
+++ b/docs/api/get-v-1-contractor-payment-groups-contractor-payment-group-id.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"description":"The full contractor payment group, including associated contractor payments.","type":"object","allOf":[{"description":"Base properties for contractor payment groups.","type":"object","properties":{"uuid":{"type":"string","description":"The unique identifier of the contractor payment group.","readOnly":true},"company_uuid":{"type":"string","description":"The UUID of the company.","readOnly":true},"check_date":{"type":"string","description":"The check date of the contractor payment group.","readOnly":true},"debit_date":{"type":"string","description":"The debit date of the contractor payment group.","readOnly":true},"status":{"type":"string","description":"The status of the contractor payment group. Will be `Funded` if all payments that should be funded (i.e. have `Direct Deposit` for payment method) are funded. A group can have status `Funded` while having associated payments that have status `Unfunded`, i.e. payment with `Check` payment method.","enum":["Unfunded","Funded"],"readOnly":true},"creation_token":{"type":["string","null"],"description":"Token used to make contractor payment group creation idempotent. Will error if attempting to create a group with a duplicate token.","readOnly":true}},"title":"Contractor-Payment-Group-Base"},{"type":"object","properties":{"partner_owned_disbursement":{"type":["boolean","null"],"description":"Whether the disbursement is partner owned.","readOnly":true},"submission_blockers":{"type":"array","description":"List of submission blockers for the contractor payment group.","readOnly":true,"items":{"type":"object","description":"A blocker that prevents payment submission.","properties":{"blocker_type":{"type":"string","description":"The type of blocker that's blocking the payment submission.","readOnly":true},"blocker_name":{"type":"string","description":"The name of the submission blocker.","readOnly":true},"unblock_options":{"type":"array","uniqueItems":true,"items":{"type":"object","properties":{"unblock_type":{"type":"string","description":"The type of unblock option for the submission blocker.","readOnly":true},"check_date":{"type":"string","description":"The payment check date associated with the unblock option.","readOnly":true},"metadata":{"type":"object","additionalProperties":true,"description":"Additional data associated with the unblock option.","readOnly":true}}},"description":"The available options to unblock a submission blocker.","readOnly":true},"selected_option":{"type":["string","null"],"description":"The unblock option that's been selected to resolve the submission blocker.","readOnly":false},"status":{"type":"string","description":"The status of the submission blocker.","enum":["unresolved","resolved"],"readOnly":true}},"title":"Payroll-Submission-Blocker-Type"}},"credit_blockers":{"type":"array","description":"List of credit blockers for the contractor payment group.","readOnly":true,"items":{"type":"object","description":"A blocker that prevents payment crediting.","properties":{"blocker_type":{"type":"string","description":"The type of blocker that's blocking the payment from being credited.","readOnly":true},"blocker_name":{"type":"string","description":"The name of the credit blocker.","readOnly":true},"unblock_options":{"type":"array","uniqueItems":true,"items":{"oneOf":[{"type":"object","description":"Unblock option to resolve a credit blocker by submitting a wire transfer","required":["unblock_type","check_date","metadata"],"properties":{"unblock_type":{"type":"string","enum":["submit_wire"],"description":"The type of unblock option for the credit blocker","readOnly":true},"check_date":{"type":"string","description":"The payment check date associated with the unblock option","readOnly":true},"metadata":{"type":"object","required":["wire_in_amount","wire_in_deadline","wire_in_request_uuid"],"properties":{"wire_in_amount":{"type":"string","description":"The amount to be wired in (decimal string)","readOnly":true},"wire_in_deadline":{"type":"string","format":"date-time","description":"Deadline for the wire transfer to be received","readOnly":true},"wire_in_request_uuid":{"type":"string","description":"UUID of the wire in request","readOnly":true}},"readOnly":true}},"title":"Payroll-Credit-Blocker-Unblock-Option-Submit-Wire"},{"type":"object","description":"Unblock option to resolve a credit blocker by submitting a bank screenshot","required":["unblock_type","check_date","metadata"],"properties":{"unblock_type":{"type":"string","enum":["submit_bank_screenshot"],"description":"The type of unblock option for the credit blocker","readOnly":true},"check_date":{"type":"string","description":"The payment check date associated with the unblock option","readOnly":true},"metadata":{"type":"object","required":["information_request_uuid"],"properties":{"information_request_uuid":{"type":"string","description":"UUID of the information request","readOnly":true},"bank_account_last_four_digits":{"type":["string","null"],"description":"Last 4 digits of the bank account number for the bank screenshot RFI","readOnly":true}},"readOnly":true}},"title":"Payroll-Credit-Blocker-Unblock-Option-Submit-Bank-Screenshot"},{"type":"object","description":"Unblock option to resolve a credit blocker by responding to high risk fraud RFI","required":["unblock_type","check_date","metadata"],"properties":{"unblock_type":{"type":"string","enum":["respond_to_high_risk_fraud_rfi"],"description":"The type of unblock option for the credit blocker","readOnly":true},"check_date":{"type":"string","description":"The payment check date associated with the unblock option","readOnly":true},"metadata":{"type":"object","required":["information_request_uuid"],"properties":{"information_request_uuid":{"type":"string","description":"UUID of the information request","readOnly":true}},"readOnly":true}},"title":"Payroll-Credit-Blocker-Unblock-Option-Respond-To-High-Risk-Fraud-Rfi"},{"type":"object","description":"Unblock option to resolve a credit blocker by waiting for reverse wire","required":["unblock_type","check_date","metadata"],"properties":{"unblock_type":{"type":"string","enum":["wait_for_reverse_wire"],"description":"The type of unblock option for the credit blocker","readOnly":true},"check_date":{"type":"string","description":"The payment check date associated with the unblock option","readOnly":true},"metadata":{"type":"object","properties":{"reverse_wire_detail_id":{"type":["integer","null"],"description":"ID of the reverse wire detail","readOnly":true},"bank_account_last_four_digits":{"type":["string","null"],"description":"Last 4 digits of the bank account number for the reverse wire","readOnly":true}},"readOnly":true}},"title":"Payroll-Credit-Blocker-Unblock-Option-Wait-For-Reverse-Wire"}],"discriminator":{"propertyName":"unblock_type","mapping":{"submit_wire":{"type":"object","description":"Unblock option to resolve a credit blocker by submitting a wire transfer","required":["unblock_type","check_date","metadata"],"properties":{"unblock_type":{"type":"string","enum":["submit_wire"],"description":"The type of unblock option for the credit blocker","readOnly":true},"check_date":{"type":"string","description":"The payment check date associated with the unblock option","readOnly":true},"metadata":{"type":"object","required":["wire_in_amount","wire_in_deadline","wire_in_request_uuid"],"properties":{"wire_in_amount":{"type":"string","description":"The amount to be wired in (decimal string)","readOnly":true},"wire_in_deadline":{"type":"string","format":"date-time","description":"Deadline for the wire transfer to be received","readOnly":true},"wire_in_request_uuid":{"type":"string","description":"UUID of the wire in request","readOnly":true}},"readOnly":true}},"title":"Payroll-Credit-Blocker-Unblock-Option-Submit-Wire"},"submit_bank_screenshot":{"type":"object","description":"Unblock option to resolve a credit blocker by submitting a bank screenshot","required":["unblock_type","check_date","metadata"],"properties":{"unblock_type":{"type":"string","enum":["submit_bank_screenshot"],"description":"The type of unblock option for the credit blocker","readOnly":true},"check_date":{"type":"string","description":"The payment check date associated with the unblock option","readOnly":true},"metadata":{"type":"object","required":["information_request_uuid"],"properties":{"information_request_uuid":{"type":"string","description":"UUID of the information request","readOnly":true},"bank_account_last_four_digits":{"type":["string","null"],"description":"Last 4 digits of the bank account number for the bank screenshot RFI","readOnly":true}},"readOnly":true}},"title":"Payroll-Credit-Blocker-Unblock-Option-Submit-Bank-Screenshot"},"respond_to_high_risk_fraud_rfi":{"type":"object","description":"Unblock option to resolve a credit blocker by responding to high risk fraud RFI","required":["unblock_type","check_date","metadata"],"properties":{"unblock_type":{"type":"string","enum":["respond_to_high_risk_fraud_rfi"],"description":"The type of unblock option for the credit blocker","readOnly":true},"check_date":{"type":"string","description":"The payment check date associated with the unblock option","readOnly":true},"metadata":{"type":"object","required":["information_request_uuid"],"properties":{"information_request_uuid":{"type":"string","description":"UUID of the information request","readOnly":true}},"readOnly":true}},"title":"Payroll-Credit-Blocker-Unblock-Option-Respond-To-High-Risk-Fraud-Rfi"},"wait_for_reverse_wire":{"type":"object","description":"Unblock option to resolve a credit blocker by waiting for reverse wire","required":["unblock_type","check_date","metadata"],"properties":{"unblock_type":{"type":"string","enum":["wait_for_reverse_wire"],"description":"The type of unblock option for the credit blocker","readOnly":true},"check_date":{"type":"string","description":"The payment check date associated with the unblock option","readOnly":true},"metadata":{"type":"object","properties":{"reverse_wire_detail_id":{"type":["integer","null"],"description":"ID of the reverse wire detail","readOnly":true},"bank_account_last_four_digits":{"type":["string","null"],"description":"Last 4 digits of the bank account number for the reverse wire","readOnly":true}},"readOnly":true}},"title":"Payroll-Credit-Blocker-Unblock-Option-Wait-For-Reverse-Wire"}}}},"description":"The available options to unblock a credit blocker.","readOnly":true},"selected_option":{"type":["string","null"],"description":"The unblock option that's been selected to resolve the credit blocker.","readOnly":false},"status":{"type":"string","description":"The status of the credit blocker","enum":["unresolved","pending_review","resolved","failed"]}},"title":"Payroll-Credit-Blocker-Type"}},"totals":{"type":"object","properties":{"amount":{"type":"string","description":"The total amount for the group of contractor payments.","readOnly":true},"debit_amount":{"type":"string","description":"The total debit amount for the group of contractor payments. Sum of wage & reimbursement amount.","readOnly":true},"wage_amount":{"type":"string","description":"The total wage amount for the group of contractor payments.","readOnly":true},"reimbursement_amount":{"type":"string","description":"The total reimbursement amount for the group of contractor payments.","readOnly":true},"check_amount":{"type":"string","description":"The total check amount for the group of contractor payments.","readOnly":true}},"readOnly":true},"contractor_payments":{"type":"array","items":{"description":"The representation of a single contractor payment.","type":"object","properties":{"uuid":{"type":"string","description":"The unique identifier of the contractor payment in Gusto.","readOnly":true},"contractor_uuid":{"type":"string","description":"The UUID of the contractor.","readOnly":true},"bonus":{"type":"string","description":"The bonus amount in the payment.","readOnly":true},"hours":{"type":"string","description":"The number of hours worked for the payment.","readOnly":true},"payment_method":{"type":"string","description":"The payment method.","enum":["Direct Deposit","Check","Historical Payment","Correction Payment"],"readOnly":true},"reimbursement":{"type":"string","description":"The reimbursement amount in the payment.","readOnly":true},"status":{"type":"string","description":"The status of the contractor payment. Will transition to `Funded` during payments processing if the payment should be funded, i.e. has `Direct Deposit` for payment method. Contractors payments with `Check` payment method will remain `Unfunded`.","enum":["Funded","Unfunded"]},"hourly_rate":{"type":"string","description":"The rate per hour worked for the payment.","readOnly":true},"may_cancel":{"type":"boolean","description":"Determine if the contractor payment can be cancelled.","readOnly":true},"wage":{"type":"string","description":"The fixed wage of the payment, regardless of hours worked.","readOnly":true},"wage_type":{"type":"string","description":"The wage type for the payment.","enum":["Hourly","Fixed"],"readOnly":true},"wage_total":{"type":"string","description":"(hours * hourly_rate) + wage + bonus","readOnly":true}},"x-tags":["Contractor Payment Groups"],"title":"Contractor-Payment-For-Group"}}}}],"x-examples":{"success":{"uuid":"f693e034-d833-46e3-88d4-2c820c383c57","company_uuid":"c54046f7-1be4-4c54-8194-f4842c30c86d","check_date":"2024-05-07","debit_date":"2024-05-01","status":"Unfunded","creation_token":"45ef81bb-ae24-4ad1-b2c6-6e563a4c30ed","contractor_payments":[{"uuid":"630dc982-f498-4ebc-a6dc-4d76711027ce","contractor_uuid":"2e6d0970-31bf-47ce-bdb4-713e4207ecf4","bonus":"0.0","hours":"40.0","hourly_rate":"18.0","may_cancel":false,"payment_method":"Direct Deposit","reimbursement":"75.0","status":"Unfunded","wage":"0.0","wage_type":"Hourly","wage_total":"720.0"},{"uuid":"12f51eba-d653-4357-8c05-1f1f8d0fd5e3","contractor_uuid":"a975fda0-fcf5-469a-a5fd-06e43d1cd99d","bonus":"0.0","hours":"0.0","hourly_rate":"0.0","may_cancel":false,"payment_method":"Check","reimbursement":"0.0","status":"Unfunded","wage":"1500.0","wage_type":"Fixed","wage_total":"1500.0"}],"totals":{"amount":"2295.0","debit_amount":"2295.0","wage_amount":"2220.0","reimbursement_amount":"75.0"}},"With submission blockers":{"uuid":"5ec3b582-7d04-4397-be1e-f0e79d00e1b7","company_uuid":"4a39b249-1e22-4fc9-a40f-cb07d2ab394e","check_date":"2025-08-21","debit_date":"2025-08-19","status":"Unfunded","creation_token":"5ec3b582-7d04-4397-be1e-f0e79d00e1b7","partner_owned_disbursement":false,"submission_blockers":[{"blocker_type":"fast_ach_threshold_exceeded","blocker_name":"Fast ACH Threshold Exceeded","selected_option":"wire_in","status":"resolved","unblock_options":[{"unblock_type":"wire_in","check_date":"2025-08-21","metadata":{"wire_in_deadline":"2025-08-21T18:00:00Z","wire_in_amount":"760000.0"}},{"unblock_type":"move_to_four_day","check_date":"2025-08-21","metadata":{"debit_date":"2025-08-15"}}]}],"credit_blockers":[{"blocker_type":"waiting_for_wire_in","blocker_name":"Waiting for Wire In","selected_option":"submit_wire","status":"unresolved","unblock_options":[{"unblock_type":"submit_wire","check_date":"2025-08-21","metadata":{"wire_in_deadline":"2025-08-21T18:00:00Z","wire_in_amount":"760000.0","wire_in_request_uuid":"7a31fef8-46c6-4114-9677-214b7a3cb532"}}]}],"contractor_payments":[{"uuid":"ca8c7899-c2dc-40bb-8b7e-08c1309f5135","contractor_uuid":"b4c6cd3c-4b45-4738-ad40-3da45b29a765","bonus":"0.0","hours":"0.0","hourly_rate":"0.0","may_cancel":false,"payment_method":"Direct Deposit","reimbursement":"750000.0","status":"Unfunded","wage":"10000.0","wage_type":"Fixed","wage_total":"10000.0"}],"totals":{"amount":"760000.00","debit_amount":"760000.00","wage_amount":"10000.00","reimbursement_amount":"750000.00","check_amount":"0.00"}}},"x-tags":["Contractor Payment Groups"],"title":"Contractor-Payment-Group"}}}},"404":{"description":"Not Found\n\nThe requested contractor payment group does not exist. Make sure the provided UUID is valid.\n","content":{"application/json":{"schema":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided ID/UUID is valid.","type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["error_key","category"],"properties":{"error_key":{"type":"string","description":"Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error."},"category":{"type":"string","description":"Specifies the type of error. The category provides error groupings and can be used to build custom error handling in your integration."},"message":{"type":"string","description":"Provides details about the error - generally this message can be surfaced to an end user."}}}}},"x-examples":{"not_found":{"errors":[{"error_key":"request","category":"not_found","message":"The requested resource was not found."}]}},"title":"Not-Found-Error-Object"}}}}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-contractor-payment-groups-contractor-payment-group-id.api.mdx b/docs/api/get-v-1-contractor-payment-groups-contractor-payment-group-id.api.mdx
new file mode 100644
index 000000000..5db6780a7
--- /dev/null
+++ b/docs/api/get-v-1-contractor-payment-groups-contractor-payment-group-id.api.mdx
@@ -0,0 +1,71 @@
+---
+id: get-v-1-contractor-payment-groups-contractor-payment-group-id
+title: "Get a contractor payment group"
+description: "Returns a contractor payment group with all associated contractor payments."
+sidebar_label: "Get a contractor payment group"
+hide_title: true
+hide_table_of_contents: true
+api: eJztPGlz2ziWfwWDrZpOdgSbkqjLnzaddLpdNdtJ5dhsjTulgMSjhDEJsAHQjsql/74FgKdE2VKSzmS28ymOCLz7wAMecIdlDooaLsUlwxd4BYbcDEkshVE0NlItc7rJQJjlSski1we/LDnDA8xAx4rnFhy+wK/AFEpoRFEzC5WzkJuFbrlZI5qmiGotY04NsJ7B+uw38ZvQsczhAn3I6UbJNNUXCij7gAfY0JXGF1f4aTPxZYnlZ0c1fj/AH8mq0EYSLgysPMfEbHKwEyGLgDFgdlxOFc3AgLIg77CgGeALfJDtonCMc8tvTs0aD7CC3wuugOELowrYFcqbNaC3by+fIZkgs4aDosEDrOM1ZBRf3GFPKNZGcbHC2+2gJux/yc+OrScvL8n/gNIWSUnOGigDdQ+cAQZRZFYAo2A0IcGUDCdWBAwSWqQGX7R/3+4y8swKKeMCtOODUQMkohoYevLyEt14Wtp6dbreyEK5ATFN0zN0mSAhBSCuUa7kDWfABn4MzfOUx05PP2h0lXHBsyJrw37/aG1Mri/Oz5mM9ZlT71kss/NKnaS0FPf9nOaclDO5WP1HCZC0fn5sySg0sDO8fT/AGuJCcbNxdvBUZjkVmydxDFo/KcwaX1y937bsSulbuqpUrkDnUmjQVuijILD/dKX3unCQkiJF1WA8cGYGwtjhLf7P/6ntnLuWIvdtKinS9KAxDRAXcVowLlYPeZr1J28lMvonxAYPME3TF4mTQhftj1SDVVsOynDQKJHqIAW9gJu5lifnSj1Gus9rIfjvBSDOQBiecFAPOdOZc0vKXoh043W0tcJ2Kl0ej7frt252P+Q1xNdL6xHHwXXjnQd9EiMMIm5OQOfGfzo6bagp9HGo/NgH0SD0jqcpigB9eF4IBuwD4onLC5VdIrOmBum1LFJmxyVuGHrEz+AMrekNoA/PuILYoGeQS83NB2eOFZoMzFqyx4iqauoZQk/KJBRT4UGU1NY03K55CvbTjt90iepMfSs8+A8D5EirCHDB78NTq+gPO1SdtQJxNR0PsCfCxuN9+1LgAsPSyGsQjSauGlWIIk19LO+oxI53IQ4ZiTJ6fVgnqEJi3SzLpY1LlZ5AKamchoyBLDdWPEb6GYBoJ7cjVvhABshR22NS2wE23KTWlJoUTsoUTlwKJzbWYJv37o8hOVVGgFrKWwFsybiOCqUhK2NqJaVIyhSoOCimd2swa1A+r7VguDTlMSCHod8/iijj2iaUZZTK+NotJWrCqVJ0s+crf+faWC9p5qJqrrPj05x0gLmBrI21FlcX7ZMKi7fkXMGNs+sKfkPO2Z6oy5lLj+GYYGBHWCbbOH/Q/r/OhNZwAPOejCvkfhV0DHI7sopD+1LuRVII93UpHZw+JfpEdOmF/YDkd5JdCft06ZUzkaeqto4jeTo1NVX6aKWo3SWdcRm5TVQv5gwMZdTQPtlQxridSNOXLSn1LZ+f1CMtMfTTiNnuLWYtq/SG8pRGKZQTtY1pFSx6rIA1pBAbYKXVnBKc90ivPQRAoAqwpUqBlukNHKX4hKb689J2P4YqZRWipIY5tOWf+2mrFeVf+nU5eV0DJj96wOSNpW3rcxzj5vQI6ud9E9HTk8LF6msHz0TJDEVgf/Y0HMhUnxdFu5L+AyKoFFDWHffr4e2O0zT+QXeIRNHGW7NxaxaKbrkCZBQVOnGlclO7X3VDdCdytoLZ+1MDe+U2noylJaA/FDwQ77uM/ctC/amRvi1gy/uSiyXNZCHsx+oHBpSlXEDrJzsPtPHF2p7QdyAdxa4fa60lAmcHDHGBHjGIeUZT5Gc+7uNvj8wefIlUGbVbKG5fxPAM9oh4Vk6vVdoxxpIwBTHwKrYeoKMjmwd5bxexDiMXqITQuzR/OIw/daZYh/DSHckLh9EHeUPeWUPvW8B/MV+OqLhGOlYAQq/lrrF9FW+2JCxbJPxJHZsLb/62BLrfcQ+OPMmMW1AOm/IAO+3QOLZ+v0ypNstEFmrJ+IobfcJC7e9UGxQiP6+iwVlfCRyJIotA1SrdsUz06vnlH+lqP1JxTV43Vvilvc5vWLKy6l/z1Roprq9RomjBaua+luuV1CyNXFpSlpaUpSNlqRL+3QW/IRf8Aib+ymubvJHkF75ak1dcX5PnVtvkVcK/uKnfUreAd5Zhl/dK+6T5VS3cErFMpFqWFPzpFo1dsbWlsGRgKE+XbXO1xm9g5fjrD+CN2bZ1ijysbypz7Nncl/and5Qb8lwq8spjKtdplnJuKc+4oEYqt7fqtbD51Z887th8RvPcsm6PqVqlzYNF9Pfi7d/HD78Xb3/u4u1QmfNHOvn3qu5b8fhvckn5Z67qHip9vrBbfi/7vvvoN1v2HSiSvrALfC8HvwWD/14Ofu1y8NNOzI84IPzqp+X30fT5J+V7DtV7SJ6Dy6LWfznctk/NBzihPLXH50eorj4qN9LQ9Iiek1MKLAezKrMq8/N9XfaQvb9x9EBn4ul4fYfiKdjR6yKz327pCtBfkQKeNW1bHlAvhXb8JxDo0HyudDpEfgIRfUx+OjU+1J9OhQ/1n4d9P3INelru+/oH6maBffIU5Ao0COOXJzKxTTxcrNK+ZpB/VXsyF8g18B/oUK5F8KlNyhWA/v4PKY6Nc25opWUu2u0mvaDXslBHgi5znEyQm4RupboGVpvSfViquxi+kfa0Jcp+8223gRgPsGvXxQP8C9dGKh7TtLpYYj9KZYdb06p+7OvV7TjpcRT2+vURMv+SjdlVq6/b0eLV2rjujGaFhdw0QudK2usM9jeedBs5d1q2y77oNdXHdGyfoaYjWDfo7ummRreWbAUZ5aLVjt3W8/Oqxbrutn5fWmy6Waqj17p2JMpBObM9xWozulnGVMSQthA1PckHrtlUgu0JIraBPQLkYaYHmr1syjqOsYR/tIt1m+JkR5kDpGBFFUtB611/PZxdj+9xcyhdzdIjxkp7vzg92QZ5S2avz3m0Njs9jPeRZ+I/UUv/j9HfPC1/83GvN2F9JEfdO7uns92us91At8B2d4ngI83y1Ccc7a8INbkHJ9PFGIJxSNh8PCbhFMZkPmchGcXzURCP5+N4MsO7F1twPAmDcJrMyDCCkITxJCTz4SIkSTgPR/E4iOdT1q1S3cWvkAQTEsxw935J82WIm4jTvrewezkBhxNI5sMoIhRGIQkpG5JoFE/JFCbTMQ3jceDn9eX7q5r36Thg8WI+Ikm4mJMQopjQKYtJyGbT2XAYjGYx4J6UiUcwZcFiFpDxMEpIOIuBRCwKyWw4hnAUzCBOQlznQhycBbhOXzhs/lvHBjycux/bbuxKh/18tJ9SdtIBnk0crD5BeoctCWp5UuMBbTvHs5EdaQ/AS8aHo2QyhIgSNp2MSTiezMg8DiZkmAyTOQsSNoFxr8ToYjZJGA1IEicTEk4XlNBJwkgwhXDMhjFbLNhBifUJLDhaXlXG3RVT8JCUhpNgX1A+QuzIqRxp/a0pnKplLx6NFl4j3dKl+b1TMODRaOTR9q/lvXpttHhnM1bP7Y6Wd08gHkeT+YjMWBCScLyYkQiGQJIAZgsWBDCMerw7pONFNAoXZAijEQmTeEFoGCQkjoIZG9FovAihx7snJJiT0bDHu92X4eJY7z6S6vsu5pTG0Htv5mq3Vxondr+FxuulWSvQa5myJXyMATx93ZZm/NzusDx5+gt6Uw1GPzWD93YfqlO5NvOt4nyvnflqd9euBeCwxNt7W/vHka2xb4bziyC4CIJ/tA5TG9uaBoE3Zef0XToyeWNNvtyYcqXScQT1m8MEb7fuuuteW/6+gspNUrdF2YhjRzHvWjupdo8JXYpehbRP2ltK6eynHKGWLpivp5pD57x4RsfDBJI5CafxlITDYUgW09mMjIZhNKPjOJqMR7XM78+MMZ3Hs/liQeKRzYdBFJF5NAMSzOPhOFgkk+F40hvnozCexmwckzAKJyScjeeEsjAgY0bDSTRa0Nl08gfF+SPyYi3B+6J+I+YHw37lLP1xv9JYT+hvf+pG/2Hz4WD8b4Z0N1iw+3X7ZVaSzSpygMMg3N8P+VUa9FwWgtmHFHyN6cyx9xJ4uXvDJGgkpEHwkWtzhv7bXhfVhfIbqdV1fb/fwDW6oSlnZ7+JT7/GXhOJfhMI7dJpHb5QMRxL1+Wz8y5pPTs87UMbd6lV7x/LlL/fs/X0INTlNbgATA2spNocwOFGPVivvM4htptKGt2uoeTZ38eVcVwofYbebHK7VZFukFlzja5h02xF+bcaqDGKR4WB8/q1C6QgpeV+eQ3yzB6s1VSfQJppnT15SMjdcy9BVUrSJeXO3rhYaUQFq6rZ6pZyVPCUodhukmXl+DUVNiKv7KaIeyyi9aiHozkDrY8qd19WhPjDHo1oJAvTEipBKxCgGnGWoCsqdaESGntKqUAgmCXcSm5b+na7pBPSHRUJ1jasq47+cXOM2ki+NbHFHD7gILfU+4ebYN+yaB8m/Cpt4VkIRn6ySMkLb7U1uToHeg1Ub4h/hqT99kkZbsqQ1B1t8zqRN6AUZ+BfkrFF+0cDQtdZ2XN48CmWAb6habHzJItd3HTn+ac26sG+6G8G7XJQDzzISf/sLkcNFMuZzSJ1MvOsutdfLvD5zfD84PM553f3PiSzdUsgdVMtrAplM1f1ygnNuX/khDDI3EsnPZtFmdzRi4dHXMK383yF2A+4F+ZLJdk9MHP7uf1cymsb3b259zyaUjukRV69TeP2v4Aqd2TWxV6CICncQIpoYdY2kvmEYj399UYbyD4Hg4dwAMF24BolHNTSgdx2vX2HxppE+eJO56WcAbY7dvpF8hrUDY+hJenmjRoXZ87dwHNmUdt0QNz/iUychHm833b4DtJYZvboxR8b/KDRT6WnoPKY0D2Rw2RcZNXRx1/KlExjl5LLFfizCit6ZUO/89EBtvumqTOV8ut/NZZhpZFLbTIqWnB+BnPPC0+7HNw1i4Ov9z6UtwcDH815nlLuDMe5wF3ptVf4Zti7BVX6LR7gi/ufgHpv18LaWFB3d/YZpLcq3W7tz78XYEP41XsbQRS3x+X+LR2u7d+sXiQflNOjV+WC4jE64fWoXq6rJYzYtAIaHpTR734Wt26X3D8qdRoD/6+fijogaS/R/ue5asE3icdGsNy0vu0tnDsp5+ef3thnE7oBrw5w5R+tm9Ndhd/d+RHuOZjttta/39Ox64Xt/wEMgnfC
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Returns a contractor payment group with all associated contractor payments.
+
+scope: `payrolls:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-contractor-payment-groups-id-partner-disbursements.ParamsDetails.json b/docs/api/get-v-1-contractor-payment-groups-id-partner-disbursements.ParamsDetails.json
new file mode 100644
index 000000000..1b9e38cc0
--- /dev/null
+++ b/docs/api/get-v-1-contractor-payment-groups-id-partner-disbursements.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"id","in":"path","required":true,"description":"The UUID of the contractor payment group","schema":{"type":"string"}},{"name":"X-Gusto-API-Version","in":"header","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"},"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."}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-contractor-payment-groups-id-partner-disbursements.RequestSchema.json b/docs/api/get-v-1-contractor-payment-groups-id-partner-disbursements.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-contractor-payment-groups-id-partner-disbursements.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-contractor-payment-groups-id-partner-disbursements.StatusCodes.json b/docs/api/get-v-1-contractor-payment-groups-id-partner-disbursements.StatusCodes.json
new file mode 100644
index 000000000..c226ec592
--- /dev/null
+++ b/docs/api/get-v-1-contractor-payment-groups-id-partner-disbursements.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"successful","content":{"application/json":{"schema":{"type":"object","description":"Partner disbursements for a contractor payment group","x-examples":{"success_status":{"contractor_payment_group_uuid":"123e4567-e89b-12d3-a456-426655440000","disbursements":[{"contractor_payment_uuid":"123e4567-e89b-12d3-a456-426655440001","contractor_uuid":"123e4567-e89b-12d3-a456-426655440002","payment_method":"Check","payment_status":"Not partner managed"},{"contractor_payment_uuid":"123e4567-e89b-12d3-a456-426655440003","contractor_uuid":"123e4567-e89b-12d3-a456-426655440004","payment_method":"Direct Deposit","payment_status":"Pending"}]}},"properties":{"contractor_payment_group_uuid":{"type":"string","description":"The UUID of the contractor payment group"},"disbursements":{"type":"array","description":"List of disbursements for the contractor payment group","items":{"type":"object","properties":{"contractor_payment_uuid":{"type":"string","description":"The UUID of the contractor payment"},"contractor_uuid":{"type":"string","description":"The UUID of the contractor"},"payment_method":{"type":"string","description":"The payment method for the disbursement","enum":["Direct Deposit","Check"]},"payment_status":{"type":"string","description":"The status of the payment","enum":["Pending","Paid","Not partner managed","Converted to check"]}}}}},"title":"Contractor-Payment-Group-Partner-Disbursements"}}}},"404":{"description":"Not Found\n\nThe requested contractor payment group does not exist. Make sure the provided UUID is valid.\n","content":{"application/json":{"schema":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided ID/UUID is valid.","type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["error_key","category"],"properties":{"error_key":{"type":"string","description":"Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error."},"category":{"type":"string","description":"Specifies the type of error. The category provides error groupings and can be used to build custom error handling in your integration."},"message":{"type":"string","description":"Provides details about the error - generally this message can be surfaced to an end user."}}}}},"x-examples":{"not_found":{"errors":[{"error_key":"request","category":"not_found","message":"The requested resource was not found."}]}},"title":"Not-Found-Error-Object"}}}}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-contractor-payment-groups-id-partner-disbursements.api.mdx b/docs/api/get-v-1-contractor-payment-groups-id-partner-disbursements.api.mdx
new file mode 100644
index 000000000..03c5ff088
--- /dev/null
+++ b/docs/api/get-v-1-contractor-payment-groups-id-partner-disbursements.api.mdx
@@ -0,0 +1,71 @@
+---
+id: get-v-1-contractor-payment-groups-id-partner-disbursements
+title: "Get partner disbursements for a contractor payment group"
+description: "Get partner disbursements for a specific contractor payment group."
+sidebar_label: "Get partner disbursements for a contractor payment group"
+hide_title: true
+hide_table_of_contents: true
+api: eJzdWFtv2zYU/isc99AWEG0ndbLNTwvqLgiwtUaTbAMcI6XFY5uNRKok5cQw9N+HQ1K2fMulHfawvjSWyHO+c/+OllQXYLiTWl0I2qNTcGx+xFKtnOGp0+a24IsclLudGl0WlknBCm6cAnMrpB2XxgK+tjShAmxqZIGyaI+egyPxJNk4SSbaEE5sAamcyJSsdZGoi3hdrRt1o2yqC+iRz3t19gxw8Zkm1PGppb0hfbcWNYiizj1sOkroA5uW1mkmlYNpMJm5RQF4EfIxCAECzxXc8BwcGBS5pIrnQHtUCppQiYYV3M1oQg18LaUBQXvOlLBt/dUMyPX1RZ/oCXEzOGgkTahNZ5Bz2lvSgIZaZ6Sa0qpKVtr/Zuce+9nggv0JxqKSCGcGXIB5RE5CQZU5WnncOT5hnVN2dIJ2CpjwMnO013xebRvSR0/kUoH1dgjugI25BUHOBhdkHrAQbq1OJXcgyL10M7LQpfEHUp5lLXIxIUorINKSwui5FCCScIYXRSZTH4xXlgxzqWRe5k3Zo9cz5wrba7eFTm3Lx7CV6rxdx4wVfGF0lvn3bV5IFm9KNf0xCmSNx28QRmlBtGg1SqiFtDTSLXyw3+m84GpxlqZg7VnpZrQ3HFWN5DH2nk/rkBuwhVYWLDr9uNPB/za9Z0svaVJmNKGYA6AcnmqY3f5i8ehyN356/AVSt1NYg0eK6pE0e2DwwPMiC2gjsFvruCv9k0Mlf1uWEjvD0fFb6J6c/sTg51/G7OhYvGW8e3LKusenpycn3W6n0+kg1o2mgD7dI/j5Io+i36KA5188pljJQV0Obqbx3rsZpHeNF7X19INeN6ucKz4FQbH8vgv722/F3t2HvS8NpI70odBWun1GDEAJ3zhGVZXQwmBndxKeE93dnvGN7azayYCVaG4MX+xI/l1ah1J3s/mJtikd5HZftTxp+L9lMhq7E99vF4vitqP+HGm1Y8KdleuaDm3MgJ00CjUxqnYT6jnKw9namNoxa3V1TiZ0wP0I3VdpCQ7uORgcH06TNCLCfwl10mUIYj3bWZztzM92Fvsh62/kXbjc7XR3mzJC+E2XSiDBQCNwlINF7YfyjQgNlijtCDxI61rkD34HxJYGgt1xqIXISkvmPJOidaNe0vUPgCQ3ipBtnAasLk0Kz8V10W9vQkPStFU3a0IzpGCMNp41bVZTfL5b1AercUfq7R3ghZQ7mGqzOKDDn3oyAy8DhwRL7mcQbfbXiU7T0tgWuVoUEjnIgriZtOQOFkQKUC7cwvPcOSPHpYP2ivgRAxmPybgS2fLlXqN+ATSUgGexSIIkgsGsRdVBshG5zzepppZwJUjKFRmDpyuIZlzKTJAUqUgez8+4EplUUyJVoFQNfusx52Atn8LTkAc1EAGOy8wSPtalaziVkSkoMGt3RtE1SluaCU8DUq4IKIHA0XOhGjcpiNLudoIZ3kys4Ub8acz4Zr70GhcbxtEDBXLPQ334C604G+ue8kE75ouMvUel7GPI2ggXHhwoZIwBV0B0cItI6Jxn5dY2gRxi814gkKvDSCSRX67G/BTCbEfqSdvzo/bBVay9lKJqH1rGLJh5vcKUJsNFIdJoXsjAopmA3FPpnUzoQ649ZbQF8DvgdsGCPOYpDN7z9OiA4L0yB0aLR2QW+LrJxy+xMYZM2cPKV7mMyuvlB3+PgRu/Dm1qjyJYBnPICC/dDJtA6MVYJJcL6yD/Hg1BwgEFFS5rE+2lxtzzCx0uOpgMcaXbWMUSipuX/Ti5BDOXKTQ8vV6CfIm2/cG2QNXYSZn/zfTEexivboP9C7JU54CF6nG8suR9TFrcnHGd8juY0GmJGeXN+CFOM576aRZX036tlXzCrunLJaGQc5n5VIlvf11nhmen2rqcq4acp74XPEIFN2xbrifuf/sNImSLgwfXLjIufVr5AlnGch7S+dY6s1nQNKE9z5H21/QooTNtHcpZLnEFvzZZVeHjryVgYxyOsK0YyceYYMMlMnH8W9DehGd2+xtF01GvP8Ux/Ya84MvFXpNrYqAW6y5HaRLboMQir5L6q8XLUP6vv0UccGdw2/7vPyvvrscMdrDCNd7tcM6NaXP+/oomlG82vFWDi39gkPZGdbkMJ670HaiqWgXZ4W8/aqt/AHI6JsU=
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Get partner disbursements for a specific contractor payment group.
+
+scope: `partner_disbursements:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-contractor-payments-contractor-payment-uuid-fund.ParamsDetails.json b/docs/api/get-v-1-contractor-payments-contractor-payment-uuid-fund.ParamsDetails.json
new file mode 100644
index 000000000..4cb54a60e
--- /dev/null
+++ b/docs/api/get-v-1-contractor-payments-contractor-payment-uuid-fund.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"contractor_payment_uuid","in":"path","required":true,"schema":{"type":"string"},"description":"The UUID of the contractor payment"},{"name":"X-Gusto-API-Version","in":"header","required":false,"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.","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"}}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-contractor-payments-contractor-payment-uuid-fund.RequestSchema.json b/docs/api/get-v-1-contractor-payments-contractor-payment-uuid-fund.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-contractor-payments-contractor-payment-uuid-fund.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-contractor-payments-contractor-payment-uuid-fund.StatusCodes.json b/docs/api/get-v-1-contractor-payments-contractor-payment-uuid-fund.StatusCodes.json
new file mode 100644
index 000000000..82c071b88
--- /dev/null
+++ b/docs/api/get-v-1-contractor-payments-contractor-payment-uuid-fund.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"Example response","content":{"application/json":{"schema":{"description":"The representation of a single contractor payment.","type":"object","x-examples":{"success_status":{"uuid":"04552eb9-7829-4b18-ae96-6983552948df","contractor_uuid":"bc57832c-d8bc-43a7-ae99-3a03380ff037,","bonus":"20.0","date":"2020-10-19","hours":"40.0","payment_method":"Direct Deposit","reimbursement":"100.0","hourly_rate":"18.0","may_cancel":true,"status":"Funded","wage":"0.0","wage_type":"Hourly","wage_total":"740.00"}},"title":"Contractor Payment","properties":{"uuid":{"type":"string","description":"The unique identifier of the contractor payment in Gusto.","readOnly":true},"contractor_uuid":{"type":"string","description":"The UUID of the contractor.","readOnly":true},"bonus":{"type":"string","format":"float","description":"The bonus amount in the payment.","readOnly":true},"date":{"type":"string","description":"The payment date.","readOnly":true},"hours":{"type":"string","format":"float","description":"The number of hours worked for the payment.","readOnly":true},"payment_method":{"type":"string","description":"The payment method.","enum":["Direct Deposit","Check","Historical Payment","Correction Payment"],"readOnly":true},"reimbursement":{"type":"string","format":"float","description":"The reimbursement amount in the payment.","readOnly":true},"status":{"type":"string","description":"Contractor payment status","enum":["Funded","Unfunded"]},"hourly_rate":{"type":"string","format":"float","description":"The rate per hour worked for the payment.","readOnly":true},"may_cancel":{"type":"boolean","description":"Determine if the contractor payment can be cancelled.","readOnly":true},"wage":{"type":"string","format":"float","description":"The fixed wage of the payment, regardless of hours worked.","readOnly":true},"wage_type":{"type":"string","description":"The wage type for the payment.","enum":["Hourly","Fixed"],"readOnly":true},"wage_total":{"type":"string","format":"float","description":"(hours * hourly_rate) + wage + bonus","readOnly":true}},"x-tags":["Contractor Payments"],"required":["uuid"]},"examples":{"Example":{"value":{"uuid":"04552eb9-7829-4b18-ae96-6983552948df","contractor_uuid":"bc57832c-d8bc-43a7-ae99-3a03380ff037","bonus":"20.0","date":"2020-10-19","hours":"40.0","payment_method":"Direct Deposit","reimbursement":"100.0","status":"Unfunded","hourly_rate":"18.0","may_cancel":true,"wage":"0.0","wage_type":"Hourly","wage_total":"740.00"}}}}}},"404":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided UUID is valid.\n"},"422":{"description":"Unprocessable Entity \n \nThis 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.\n","content":{"application/json":{"schema":{"description":"Unprocessable Entity\n \nThis 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.\n","type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["error_key","category"],"properties":{"error_key":{"type":"string","description":"Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error."},"category":{"type":"string","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."},"message":{"type":"string","description":"Provides details about the error - generally this message can be surfaced to an end user."},"metadata":{"type":"object","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.","oneOf":[{"type":"object","description":"multiple entities","required":["entities"],"properties":{"entities":{"type":"array","items":{"type":"object","description":"single entity","additionalProperties":true,"properties":{"entity_type":{"type":"string","description":"Name of the entity that the error corresponds to."},"entity_uuid":{"type":"string","description":"Unique identifier for the entity."},"valid_from":{"type":["string","null"]},"valid_up_to":{"type":["string","null"]},"key":{"type":["string","null"]},"state":{"type":["string","null"]}},"title":"Metadata-With-One-Entity"}}},"title":"Metadata-With-Multiple-Entities"},{"type":"object","description":"single entity","additionalProperties":true,"properties":{"entity_type":{"type":"string","description":"Name of the entity that the error corresponds to."},"entity_uuid":{"type":"string","description":"Unique identifier for the entity."},"valid_from":{"type":["string","null"]},"valid_up_to":{"type":["string","null"]},"key":{"type":["string","null"]},"state":{"type":["string","null"]}},"title":"Metadata-With-One-Entity"}]},"errors":{"type":"array","description":"Will only exist if category is `nested_errors`. It is possible to have multiple levels of nested errors.","items":"circular(Entity-Error-Object)"}},"title":"Entity-Error-Object"}}},"x-examples":{"bank_account_delete_unfunded_payments":{"errors":[{"error_key":"base","category":"invalid_operation","message":"FundingMethod has unfunded payments"}]},"bank_account_verify_incorrect_deposits":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Your bank account cannot be verified. Please check the test deposit amounts."}]},"bank_account_verify_already_verified":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Your bank account has already been verified."}]},"bank_account_missing_routing":{"errors":[{"error_key":"routing_number","category":"invalid_attribute_value","message":"Routing number is required."}]},"payment_configs_missing_parameter":{"errors":[{"error_key":"base","category":"missing_parameter","message":"At least one parameter must be provided"}]},"payment_configs_invalid_fast_payment_limit":{"errors":[{"error_key":"fast_payment_limit","category":"invalid_attribute_value","message":"Fast payment limit should be a number"}]},"pay_periods_invalid_end_date":{"errors":[{"error_key":"end_date","category":"invalid_parameter","message":"End date cannot be more than 3 months in future"}]},"company_industry_selection_naics_code_required":{"errors":[{"error_key":"naics_code","category":"invalid_attribute_value","message":"Naics code is required."}]},"company_industry_selection_naics_code_invalid":{"errors":[{"error_key":"naics_code","category":"invalid_attribute_value","message":"Naics code must be equal to 6 digits."}]},"company_industry_selection_sics_codes_invalid":{"errors":[{"error_key":"sic_codes","category":"invalid_attribute_value","message":"Sic codes must be equal to 4 digits"}]},"time_off_policy_name_required":{"errors":[{"error_key":"name","category":"invalid_attribute_value","message":"Name is required."}]},"time_off_policy_unlimited_invalid_accrual_rate":{"errors":[{"error_key":"accrual_rate","category":"invalid_operation","message":"Accrual rate must be blank for unlimited policies."}]},"time_off_policy_pending_requests":{"errors":[{"error_key":"time_off_policy","category":"invalid_operation","message":"Cannot deactivate policy with pending time off requests."}]},"time_off_policy_employees_required":{"errors":[{"error_key":"employees","category":"invalid_attribute_value","message":"Employees are required."}]},"time_off_policy_unlimited_balance_update":{"errors":[{"error_key":"base","category":"invalid_attribute_value","message":"Can not adjust balances for unlimited policies."}]},"holiday_pay_policy_already_exists":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Company already has a holiday pay policy."}]},"holiday_pay_policy_not_exists":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Company does not have a holiday pay policy, please create one"}]},"holiday_pay_policy_invalid_employees":{"errors":[{"error_key":"employees","category":"invalid_attribute_value","message":"Invalid employee uuids provided."}]},"onboarded_employee":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Cannot delete onboarded employee"}]},"invalid_attribute":{"errors":[{"error_key":"base","category":"invalid_operation","message":"There is an error in the request body."}]},"company_cannot_enable_contractor_only":{"errors":[{"error_key":"contractor_only","category":"invalid_attribute_value","message":"Contractor only cannot be enabled for existing companies."}]},"company_missing_parameter":{"errors":[{"error_key":"base","category":"missing_parameter","message":"contractor_only is required."}]},"starting_after_uuid_invalid":{"errors":[{"error_key":"starting_after_uuid","category":"invalid_attribute_value","message":"Parameter 'starting_after_uuid' does not correspond to a valid event."}]},"resource_uuid_invalid":{"errors":[{"error_key":"resource_uuid","category":"invalid_attribute_value","message":"Parameter 'resource_uuid' does not correspond to a valid resource."}]},"payroll_gross_up_invalid_net_pay":{"errors":[{"error_key":"net_pay","category":"invalid_attribute_value","message":"Net pay must be a number."}]},"payroll_accruing_hours_invalid":{"errors":[{"error_key":"base","category":"invalid_attribute_value","message":"Hours cannot be negative."}]},"payroll_cannot_cancel":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Payroll cannot be canceled."}]},"frozen_payroll":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This payroll has already been processed. Its data cannot be updated or altered."}]},"frozen_payroll_processing":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This payroll is being processed and cannot be updated at this time."}]},"unmodifiable_payroll_type":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This type of payroll cannot be modified or processed. It is reserved for system processes."}]},"invalid_employee_uuids_format":{"errors":[{"error_key":"employee_uuids","category":"invalid_attribute_value","message":"Parameter employee_uuids must be an array."}]},"maximum_employee_uuids_surpassed":{"errors":[{"error_key":"employee_uuids","category":"invalid_attribute_value","message":"Exceeded maximum of 100 for lookup."}]},"invalid_employee_uuid":{"errors":[{"error_key":"employee_uuids","category":"invalid_attribute_value","message":"Invalid Employee UUID(s).","metadata":{"entities":[{"entity_type":"Employee","entity_uuid":"invalid-uuid-123"}]}}]},"payroll_blocker_missing_bank_info":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must have a bank account in order to run payroll.","metadata":{"key":"missing_bank_info"}}]},"payroll_blocker_missing_employee_setup":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must add employees in order to run payroll.","metadata":{"key":"missing_employee_setup"}}]},"payroll_blocker_missing_federal_tax_setup":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must complete federal tax setup in order to run payroll.","metadata":{"key":"missing_federal_tax_setup"}}]},"payroll_blocker_missing_bank_verification":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company bank account must be verified in order to run payroll.","metadata":{"key":"missing_bank_verification"}}]},"payroll_blocker_suspended":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company is suspended and cannot run payroll.","metadata":{"key":"suspended"}}]},"submission_blocker_missing_selection":{"errors":[{"error_key":"submission_blockers","category":"invalid_attribute_value","message":"Submission blockers selections required"}]},"submission_blocker_invalid_option":{"errors":[{"error_key":"submission_blockers","category":"nested_errors","metadata":{"blocker_type":"fast_ach_threshold_exceeded"},"errors":[{"error_key":"selected_option","category":"invalid_attribute_value","message":"Selection is not available to resolve Fast ACH Threshold Exceeded. Please choose one of Wire In, Move To Four Day"}]}]},"invalid_version":{"errors":[{"error_key":"base","category":"invalid_resource_version","message":"You are attempting to update a resource using an out-of-date version."}]},"signatory_email_required":{"errors":[{"error_key":"email","category":"invalid_attribute_value","message":"Email is required"}]},"signatory_company_already_has_signatory":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Cannot have more than one signatory in a company. Please remove the existing signatory before adding a new one."}]},"mixed_disbursement_errors":{"errors":[{"error_key":"disbursements","category":"nested_errors","metadata":{"contractor_payment_uuid":"invalid-uuid-1"},"errors":[{"error_key":"contractor_payment_uuid","category":"not_found","message":"Disbursement not found."}]},{"error_key":"disbursements","category":"nested_errors","metadata":{"contractor_payment_uuid":"d0dfa222-ad08-4ea7-a06a-717688c3b179"},"errors":[{"error_key":"payment_method","category":"invalid_attribute_value","message":"Payment method must be one of: Direct Deposit, Check."},{"error_key":"payment_status","category":"invalid_attribute_value","message":"Payment status is not valid for payment method 'InvalidMethod'."}]}]},"not_found":{"errors":[{"error_key":"request","category":"not_found","message":"The requested resource was not found."}]},"finish_onboarding_incomplete":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Company is not ready to exit onboarding."}]},"company_location_validation":{"errors":[{"error_key":"street_1","category":"invalid_attribute_value","message":"Must include a street address"},{"error_key":"city","category":"invalid_attribute_value","message":"Must include a city"},{"error_key":"state","category":"invalid_attribute_value","message":"State is in the wrong format"},{"error_key":"zip","category":"invalid_attribute_value","message":"Please enter a valid zip code (e.g. 12345)."},{"error_key":"phone_number","category":"invalid_attribute_value","message":"Phone number must be 10 digits"}]},"conflict":{"errors":[{"error_key":"request","category":"duplicate_operation","message":"A resource with these attributes already exists."}]},"invalid_parameter":{"errors":[{"error_key":"request","category":"invalid_parameter","message":"The provided parameter is invalid or missing."}]},"flow_invalid_entity":{"errors":[{"error_key":"entity_type","category":"invalid_attribute_value","message":"Invalid flow entity"},{"error_key":"entity_uuid","category":"invalid_attribute_value","message":"Invalid flow entity"}]},"flow_nested_options_errors":{"errors":[{"error_key":"options","category":"nested_errors","metadata":{"flow_type":"company_forms"},"errors":[{"error_key":"form_types","category":"invalid_attribute_value","message":"Supplied value 'invalid' contains no permitted values"}]}]},"basic":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must complete all onboarding requirements in order to run payroll.","metadata":{"key":"needs_onboarding"}}]},"contractor_payment_invalid_wage":{"errors":[{"error_key":"wage","category":"invalid_attribute_value","message":"Wage must be greater than or equal to 0."}]},"contractor_payment_cannot_cancel":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Payment has already been processed and cannot be cancelled. Contact support directly."}]},"time_off_request_cannot_delete":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This time off request cannot be deleted."}]},"resource":{"errors":[{"error_key":"first_name","category":"invalid_attribute_value","message":"First name is required"},{"error_key":"date_of_birth","category":"invalid_attribute_value","message":"Date of birth is not a valid date"}]},"nested":{"errors":[{"error_key":"contractor_payments","category":"nested_errors","metadata":{"contractor_uuid":"72ae4617-daa9-4ed7-85e0-18ed5d0ee835"},"errors":[{"error_key":"hours","category":"invalid_attribute_value","message":"Ella Fitzgerald is paid fixed wage and hours cannot be set on a contractor payment"}]},{"error_key":"contractor_payments","category":"nested_errors","metadata":{"contractor_uuid":"2d7bf62c-babf-4a12-8292-340e2d9cab28"},"errors":[{"error_key":"wage","category":"invalid_attribute_value","message":"Isaiah Berlin is paid hourly and wage cannot be set on a contractor payment"}]}]},"compensation_invalid_rate":{"errors":[{"error_key":"rate","category":"invalid_attribute_value","message":"Rate is not a valid number"}]},"compensation_invalid_payment_unit":{"errors":[{"error_key":"payment_unit","category":"invalid_attribute_value","message":"Payment unit must be one of Hour, Week, Month, or Year"}]},"compensation_already_processed":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Compensation has already been processed on payroll."}]}},"title":"Unprocessable-Entity-Error-Object"},"examples":{"Basic":{"value":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must complete all onboarding requirements in order to run payroll.","metadata":{"key":"needs_onboarding"}}]}},"Resource":{"value":{"errors":[{"error_key":"first_name","category":"invalid_attribute_value","message":"First name is required"},{"error_key":"date_of_birth","category":"invalid_attribute_value","message":"Date of birth is not a valid date"}]}},"Nested":{"value":{"errors":[{"error_key":"contractor_payments","category":"nested_errors","metadata":{"contractor_uuid":"72ae4617-daa9-4ed7-85e0-18ed5d0ee835"},"errors":[{"error_key":"hours","category":"invalid_attribute_value","message":"Ella Fitzgerald is paid fixed wage and hours cannot be set on a contractor payment"}]},{"error_key":"contractor_payments","category":"nested_errors","metadata":{"contractor_uuid":"2d7bf62c-babf-4a12-8292-340e2d9cab28"},"errors":[{"error_key":"wage","category":"invalid_attribute_value","message":"Isaiah Berlin is paid hourly and wage cannot be set on a contractor payment"}]}]}}}}}}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-contractor-payments-contractor-payment-uuid-fund.api.mdx b/docs/api/get-v-1-contractor-payments-contractor-payment-uuid-fund.api.mdx
new file mode 100644
index 000000000..fa1f2dbd9
--- /dev/null
+++ b/docs/api/get-v-1-contractor-payments-contractor-payment-uuid-fund.api.mdx
@@ -0,0 +1,75 @@
+---
+id: get-v-1-contractor-payments-contractor-payment-uuid-fund
+title: "Fund a contractor payment [DEMO]"
+description: "> 🚧 Demo action"
+sidebar_label: "Fund a contractor payment [DEMO]"
+hide_title: true
+hide_table_of_contents: true
+api: eJztXFtz2ziW/itY7kOSHdGWZTu+PHRtJpftPKTj6iSbnXJSNEQeSeiQAAOAjtUp/5F9mcf5e/sTts4BQFIUJUuKPVXT1V3VlYQCDj4cnDsu36ObeFoZq2IhLUw1t0LJ2M5LiM4vIyjGkGWQRZ8HkeVTg9+eK2k1T63S7ILPC5DW4M+qBNf5dRadR1Ow8fVBnNZtk9K37fmWVJXI4kkls2gQZWBSLUqkFJ1HP7H/+/v//oO9gEIxnuLHT/KnT/In9n4mjP/ChGFK5nPGr7nI+TgHJiSzM3DdQF4LrSQO9El+ku9EUeXcAsPxhJwyzhpEzCPaY6/8r0RYpWmlDeOVVQW3IuV5Pg9jlFpllcPRGol9m4FkYy6/MKu5NA6pYVwDm4JEVkG2xz4YYLY9E0cz6+BmVjkyglr1IX5k2JWx3Fbmik20KtjVB4kzhOwKe1+9cn/fY8/qvzPXHtmn4WslNGRsonTAt4o3TEMKorR7yE2TqhLO2VXJ51rluTnXlbyKBpEGUyppwETn36PRcIh/LK7syxtelDmw0DIaRDgWSItteVnmIiV52v/NYIfvkUlnUPBlSu9nSKXUYEBa6sLUhHFmhJzm0Le60SByEh6p8W+Q2mgQ3cTgABFiU6UpGJM4DuEXFNHoPBoeHR+PYHwWn5yOzuKj8cFpzOHsafz07PTw+Hh0dnSaTfxMvIz7juP0+OT0cJTG2ek4jY8O+Ql2PIsP+fDw8HQ4mQwPTwbRIBoriQNGo+HeELWBW6B/jYbxwTA+OIsG0UxVGpscuSZBiQqwM4VDvRAaUsteQKmMsLQYohhX2kBB3I0Ohq4nEsrniXZjHJzSx4LPk5TLFPLo3OoKBlFgQuTkJhpE3/gUezgq+I/Es/Nnolh/VJbn0Xl0gkiH0e3tILLC5thw2YjgTDQaESugxfHvYaWM1UJOlwwELn4lxdcKmMhAWjERoHH9UY96hFdI9l9o7vaILzx7K/O5m+htz7JtMvqHD69fLA/YS98v7jLVidIFx6WZ5Irb3mGoL+OFqtwsyPY08rw0lpOcTSYQWIM9ekl5gdsJtqyKsVsQosK+Kf3F25m7ZtAV7G3m4vogWZBVgW5rSSuezyD9Eg2in4WxSqNRb4nic6WxOdqS8PFzD8SOZu3EoQUaWyxwY5vWs+X5shL4rg1zas0OTiP6fNuxD7vNDR1tCZoWf5u1b1uheuSxUjlwuTTSC7CgCyGBiZV6n3LJxsAczRyy3lGdXdtpphNxAxlDAsEW+JEHTMOU6ywHY7pqsBKEt6ebSDwNic36+BrWt7bLrxBmryi3LfbWHHjsZvUfrCUyT9hfHLi/ONu1PNdbdLt3hJUhMsEmZJNRMNuu2scR+Ndrnlfwz3LW/2RfXTvhWkM39t+7emv8bxAdDY+WQ65flGWvVCUz9kky9kk6O/a1AmMhw5BOVToFlikwTCrL4EYYu8fe8C/ATKUhRM7XIoPMeVBh2DXPRbb3SUY47Gi0POwHWWqFgRkF+S+lFXZeIxCGFXzOZrwsQbr425LfzOaod3O0QB4jGQgupGGgtdKGmSqdMW7YlZAEIuHWajGuLCQkVFcD5pUrUJhwkRuWVYDRNZdNzzoPutpj78DN9PKlG+Y5tzBVWoD5/HhmbWnO9/czlZo9ysD2UlXsh4wr9hE1/b5PMOO07v6ETSuROZUvlMaMwSIgZN7OcXQfd/9kbpe53cShbaDchNFsLYay/ntjV7nWHBVPWCja31dTTb4AdvAo5yvGoFZ3uo13JaQYJxtcSK+M1N0nunvs/bz0WS5lp19g3kTXhtrXa7hfcs0L9MBMAybWGWWrgeQeKnONegtoSIHcmpp4SgytTCAVrIeXMjbVqiqFnBrGZRa8fWUcmnEl8oylKAeFbz/jMssxxRXSSW+r/LHHXk+agYRhV5IMW+LW8WpA4NxasW8iz4PIM85cS3blmzK/SHP2TdgZA2ey3I/EmgL1rT/qWOTMRZivl0bGx6qyrbWLfeJer5onHZhhKj3hqWMIx2JFhvzRHoXlGbe8TxSXo0lSbg05XHOXNnCk6QVk7jXZuwAhGek0RtJkNrxFGuewx14pzbwvHyyQIHzEqiv3J7msK1rb8AV99ZVj/7hxJhj1KAlvJ9H55V1zKarcCqxBEEXUo47ihc/LyhZ+2UKlF8f2xQk3l2gQ8Syj4g7PL1ojOQfeM/Z8wwjxF17UAannqJ3xttikmOlgCSYzDNNiDK8aBt89woel5DvEoY4MUXTWG+tSDcHLhqKs8pwCO9euKhOr1jdcsHN9DTBegnVNWsWIN17644/CzuK3EmLn/KLb1a3eeNlxTXFpbgd/rvkfYc0pwVjlsBf58BGND1WIKcDF9HON29hjry1+LpUxAkMsq9iMXwOr7VAO15BTlujdSHAUtVmJUqHTKuf6sYMbU/ATvyWBe7JQYutp4AR6sdSJNeqEpymWHZIMcrCQVD7HqIv27SDmciHWiMbc1W5rFx8tBWtRy81FvrD+hjIgNuOGhdFYPRqtwQKwa9BiMk+ETF1hJslcxnSfyP6GYQCV7P2o6DkxexkDo/EFluwvcuAGWIrVIxekYMTq4fjyDbr2VVPgOWbB8yRQfNAJIHv9gGwMIJt59AAshEELlWhVYfF/DTDfInHFvX6InSB/Aeivrn8oDrY2IDyukCenSk7E1NTQ6lhzK64t926DeWYZLqllSmLtJASzRWVsO7DoBxZmO+HG1ttZuSiEXYOwp/HWLHyFiENxi2gwM1NVniFm7jlbY05K0EJlDV6QWRIqxCtQ1k16sfXz8qXMqIzc0hzKoOyMS3bICiXtzGBMOKlspcHhS1VRconKnVXG6nliIHe110RykZokVRkkTWC2EnHTent+/oJ9GfbtEcfNEPphHh5gEE34WvEcvchTlompqM3OGrgmADAbwDUidW23R/tOpITVLIM98mAdVisKSNRkkpQqF+k8kbzYcK2LnZhY9K1vF0QlSaMgq/WFp6mueF7XwlegWmi2heV+5vq5enng2DhHU46RVY2HEUABZgXwEsi5Jr6Qss47drpug/a5U+4McNf6mkr8RMPluB4DwwGYmkxCVWcVZijKXM0BzCbLXjfefu1fhq60Cb+xBIx5jtXUpCrvsJervfU6VM+5pAopz36jZXejmfXLPlO5yNCq4/8OcAgrKBC9z6jouTMmdRhBIQXzCNAD+cVfDU0q+3Cw6hIzRdJ9wAas9CGbBpRVJWEl1No91mL2IKL42rVhgQTDtMu0ahiET8mx4hrD8NDuPvkXdBgDflYPVUNyEJYmc48I3lPtEc++SJ+W+k3PUAXG4nLHo7mwIgGJ9aOktXGjaFdpJbZuy+3VtNmdonyviW8cFrerSVKOts/hbRQ24H/IOLYzxx43ZyzXFLfziQW32bVJFLDca3v+XdRx9aMeeo8aNW5KE1SnZF5RrmlDk2YRSoub4l9o/0PIFyjdiTm0blIa3HJIploZg+WOMLgESgbWxTq+xfbhDlCOUEcUIS/oQKKoBVeEdis3YOluru5n2iNuNEfClFtx3WWQ1/Fm9/+e7M2Fo98C4Iao1WOi1e8gE4/jXi0dVn388Espud90w9rCa2tcOb3B6MKODHfIeG5Br0CbeCrr8/YfAi4MGwMatxpw2GrpQKVSozAUAHqwlSxUJiaCzHaAHKqZ9wk27BiVS4vtADhOLrDcGUoD+tpbcTM3Foq6UbDh3diArIBJwsmIO+ME1/5HDNAipUarJaPypMdZ8BtRVEUXp6l0yXHODwj15U0KgFGEx4ArcTAcEldzpb5U5TpePiCwEHCFHICOHDw2T/aixb2vZl/nslN0r9OHqFMrD+PHdIj5YHSIM1wwaONcpV9A186fim5CTtRWwt+h1hsMk0T4QHihDigkUzoDjf5JVzKoR3f6buxlnOvnUy+OAVuVDzMpnjWhqdltOh2Y6+c0gQy3UhPLbx5yWhgXUgDux2OW3zAab7c5LsPeQBRdTdgdErn3aS6IYbBYoQr9A3K5ALp/kqYyWIvYssS+yaQEHmrxxNtO8M4pNJAcZFONaVZKLi1NXbNbF5ovdd+lVFcTYYEIqwdvcohoFeDGK/8o2oXtsg7/wmjeGlMJnaezxM40mJnKswS884la+3ddBDQtqLFuz6vAFxQBKtvUV05QgsGo/BoY1eafPf+ZvQ/gWPCMrf0jpQwVI9BJfhQa2Gs5YG/UNbD3Cg/XafaC03Zk22FegzbbqmnoW6cvgUhn74jqYtxaKEpKYq3yIR3jzXmOytC9EMlUZWM1iel3TzCkmWIquVUaS3tc5JuV9bjIdynpcZG3E90ugJB3h+rYjJuk/vX+qyluN7fe8MDFrUdjwl3cIUC1GGgocMVp6zwUD5ouY5ggMTwnQJdxJHxDoiHQw7O8SSZMfV40qM7qibVbb6F9K+5sLUU/a3RvFYlFDMomE+UugjXcfdECTVpHTRwXHnh62TCb8NFoFPNseBofAZ4EHj7l8cnBydPT0/RwfHBytmbSnfO+O8T+7esMtf90VuOcLZ4eHjC60rAXdbkSUNTH/ndE0dwXw0VwEfWkdcbeo3zko223xf9oL9iwZnHXFWuo9reJVKw4c/yNm66MRBMhhZklvsqJ3hUPErjQ6wFq0p5BLse3CjXbsmbwTk0wVy6KSYj0XVGYsRrAJgfbr+IbFB4h07zK0KI7QmhbNBizJDOpO6L0Y2MQkS5ld0pne9eL3ZC1vkr8TSs5ZT777o7xuyh3EHNnkkFirh2qeL+L0m26Poa96R47GB0eHT/pUbGZkrDzeYgL7B1OQwQlPxgubJTiiYNcpOsqDb3Kk1XuBDis2npsqQ5u39kZmNbx3qZY5bZwOgn8JoXsXljrzxG8b18PaM5k0Oq7dcGz2S5SDjqeq2+t4w10lmvd4YYmt9+5moBDhtN8XYFo1wjuZ4B6kt6TuRjW3O3zfcPN3SGN4gPtYKVQ0cwaT4e/U5+dMhA8EwwZo5/YI9/nUXOTQCq8RVYIa0MrE7zKmBuRPnB2zumYX7DfIdqkIGO7FFYCZKblh3wa2BN/BL6FK2krZkc/b83wj3gsPNiZKW2Lah+y6uagxrB2VEvoHrBGT5HE6iJ5p+bc3OdjdDI9tcxUZam0ZRkFR/m8u8PvzVGYg9sBvfc6dOfwQwuyGzDr7GatOy4mtLHJbgdeXmFfJjvHXpasVUb+YZKMhbaz7Ud5QfvqE0bd69TYe1A6NuECQLI5m23T1mdBdwniffB+MuJw9PTgJM44P4uPIDuJT49hGB+cQnacDQFOD4/XmDR3d2/7pDTPOXsl7O9TLMVldOKXozFvboiiDM86u2EGMEbsfXGhJ9G5Z06NspPx5Okojcd8PImP+MEoPh2djeLDoyGMsrOUj0enazi1mxV6bbjgM/ZX0LmQNZvcpUZi0Td/e2UzDoWYGqRx8XRd91h/bmf1Wa21R1h9NNqW9Pahy14kdXIp154PXWi2c7aGvTsZI8Mt2AH7CPAFS03Szujq3d+A96EORZPa9t5zqhQGWmftVcuh3i4c4F+4rRj3HnZfvCj81xAo1NeE/2UjhttB9GvLb9w1oT+IA7kdRL/UHuSuOf/pSv50JT/gSsLt9zr3dEhJh9bVMoUkc0E60NS9/Ts69b3rxdtVt5u/KtOAHNRg/iemB23iZxev4/+uK/sEZAY8I3PVQJnw3MDKBzTctVtUuBitYMaeXbwO1X3GjVGpoCMeVCmga7PYAG8K051ZiW5GNAcZB65N6xL6I8MuCyHpcECL9pY3tnkpYt9TyOm/e4Jx6/MThIHXf9GqrmJ88z7GaDg6jodP44NjvOuZwYRXuXVvOYTvt7ef8eqUKYF/AW7mMd04XhCGi0Z92g1xnWJ1DVqLjPauXCUTbixIQ5k5ipYT/5WPsQ2CxWs/yoZSEPp1gdUd+gD2d1wE2hAgwDj9+tmKsqL3mlDOz6P964P9HiOy/32Fmtzuew7QmRuvWZXGtyeCFPBSOCGI8Sk0lISeR18K1WG0oxe7wj3+jNNcQbiX5oWmIv0qmvjUG/HBQFppKjBdfg8BwDN6MexZhSy5/Nxu9Q7Fz8UgPW1roUSIQVjptRvgmpS3ewGbSMR0VxCfpJthgShshA+id3R66UdGcBRWDEC1P3d0JURiZH5Qm1Fkwv5kW3UGEZoX83byDvS1SKG1Ho2m03X2fWq4n+HQGDjG9G/cZzS+69IVTMhTVdD2K+F4ZNhLrx8snPhDQ5OptCrC+3D/5h/J4K6c6g3pizAq+xUfMvA1M7c1iQLlf/3PRn7IQyhjCy5bdPCGY//LeZcvXr55+7k7h+/Ngx1/vnf4L/reodcwCzd2v8y5IFUk0/Pdm8nL6Pog6iumoZCdr44oyFZ+xtsKxiKV79/RM3/Q+e0tfv5aAUZJl5/RXGs6YElWKROUGK3w+G2Re/yrZ8YTtkHgsWKq4Zq0nLf8RuTvbK+Ml9w1DBekbAf6Dx6x9PLY8bI/3KtZ3nh2dAGlbf229BbQgku/+PA+ur39f+mx5hI=
+sidebar_class_name: "put api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+> 🚧 Demo action
+>
+> This action is only available in the Demo environment
+
+Simulate funding a contractor payment. Funding only occurs automatically in the production environment when bank transactions are generated. Use this action in the demo environment to transition a contractor payment's `status` from `Unfunded` to `Funded`. A `Funded` status is required for generating a contractor payment receipt.
+
+scope: `payrolls:run`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-contractor-payments-contractor-payment-uuid-receipt.ParamsDetails.json b/docs/api/get-v-1-contractor-payments-contractor-payment-uuid-receipt.ParamsDetails.json
new file mode 100644
index 000000000..4cb54a60e
--- /dev/null
+++ b/docs/api/get-v-1-contractor-payments-contractor-payment-uuid-receipt.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"contractor_payment_uuid","in":"path","required":true,"schema":{"type":"string"},"description":"The UUID of the contractor payment"},{"name":"X-Gusto-API-Version","in":"header","required":false,"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.","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"}}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-contractor-payments-contractor-payment-uuid-receipt.RequestSchema.json b/docs/api/get-v-1-contractor-payments-contractor-payment-uuid-receipt.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-contractor-payments-contractor-payment-uuid-receipt.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-contractor-payments-contractor-payment-uuid-receipt.StatusCodes.json b/docs/api/get-v-1-contractor-payments-contractor-payment-uuid-receipt.StatusCodes.json
new file mode 100644
index 000000000..ee405b70c
--- /dev/null
+++ b/docs/api/get-v-1-contractor-payments-contractor-payment-uuid-receipt.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"Example response","content":{"application/json":{"schema":{"type":"object","x-examples":{"example-1":{"contractor_payment_uuid":"afccb970-357e-4013-81f5-85dafc74f9b6","company_uuid":"c827aa0d-3928-4d5a-ab1f-400641a7d2b8","name_of_sender":"Torp and Sons and Sons","name_of_recipient":"Patricia Hamill","debit_date":"2022-06-02","totals":{"company_debit":"748.34"},"contractor_payments":[{"contractor_uuid":"f83d0bd8-7e20-43b9-834c-6d514ef6cb47","contractor_first_name":"Patricia","contractor_last_name":"Hamill","contractor_business_name":"","contractor_type":"Individual","payment_method":"Direct Deposit","wage":"448.34","bonus":"248.00","reimbursement":"100.00"}],"licensee":{"name":"Gusto, Zenpayroll Inc.","address":"525 20th St","city":"San Francisco","state":"CA","postal_code":"94107","phone_number":"4157778888"},"license":"Your payroll provider partners with Gusto Inc. for payments processing. Gusto Inc. is a licensed money transmitter. Learn more on our license page.","license_uri":"https://gusto.com/about/licenses","right_to_refund":"https://gusto.com/about/licenses","liability_of_licensee":"https://gusto.com/about/licenses"}},"properties":{"contractor_payment_uuid":{"type":"string","description":"A unique identifier of the contractor payment receipt."},"company_uuid":{"type":"string","description":"A unique identifier of the company making the contractor payment."},"name_of_sender":{"type":"string","description":"The name of the company making the contractor payment."},"name_of_recipient":{"type":"string","description":"The individual or company name of the contractor receiving payment."},"debit_date":{"type":"string","description":"The debit date for the contractor payment.","format":"date","example":"2022-05-30"},"license":{"type":"string","description":"Always the fixed string \"Your payroll provider partners with Gusto Inc. for payments processing. Gusto Inc. is a licensed money transmitter. Learn more on our license page.\""},"license_uri":{"type":"string","description":"URL for the license information for the licensed payroll processor. Always the fixed string \"https://gusto.com/about/licenses\""},"right_to_refund":{"type":"string","description":"URL for information related to right to refund. Always the fixed string \"https://gusto.com/about/licenses\""},"liability_of_licensee":{"type":"string","description":"URL for information related to right to liability of licensee. Always the fixed string \"https://gusto.com/about/licenses\""},"totals":{"type":"object","description":"The subtotals for the contractor payment.","properties":{"company_debit":{"type":"string","description":"The total company debit for the contractor payment."}}},"contractor_payments":{"type":"array","description":"An array of contractor payments for this contractor payment.","items":{"type":"object","properties":{"contractor_uuid":{"type":"string","description":"The UUID of the contractor."},"contractor_first_name":{"type":"string","description":"The first name of the contractor. Applies when `contractor_type` is `Individual`."},"contractor_last_name":{"type":"string","description":"The last name of the contractor. Applies when `contractor_type` is `Individual`."},"contractor_business_name":{"type":"string","description":"The business name of the contractor. Applies when `contractor_type` is `Business`."},"contractor_type":{"type":"string","description":"The type of contractor.\n\n`Individual` `Business`"},"payment_method":{"type":"string","description":"The payment method.","enum":["Direct Deposit","Check","Historical Payment","Correction Payment"]},"wage":{"type":"string","description":"The fixed wage of the payment, regardless of hours worked."},"bonus":{"type":"string","description":"The bonus amount in the payment."},"reimbursement":{"type":"string","description":"The reimbursement amount in the payment."}}}},"licensee":{"type":"object","description":"The licensed payroll processor","properties":{"name":{"type":"string","description":"Always the fixed string \"Gusto, Zenpayroll Inc.\""},"address":{"type":"string","description":"Always the fixed string \"525 20th St\""},"city":{"type":"string","description":"Always the fixed string \"San Francisco\""},"state":{"type":"string","description":"Always the fixed string \"CA\""},"postal_code":{"type":"string","description":"Always the fixed string \"94107\""},"phone_number":{"type":"string","description":"Always the fixed string \"4157778888\""}}}},"title":"Contractor-Payment-Receipt"},"examples":{"Example":{"value":{"contractor_payment_uuid":"afccb970-357e-4013-81f5-85dafc74f9b6","name_of_recipient":"Patricia Hamill","totals":{"company_debit":"748.34"},"contractor_payments":[{"contractor_uuid":"f83d0bd8-7e20-43b9-834c-6d514ef6cb47","contractor_first_name":"Patricia","contractor_last_name":"Hamill","contractor_business_name":"","contractor_type":"Individual","payment_method":"Direct Deposit","wage":"448.34","bonus":"248.00","reimbursement":"100.00"}],"licensee":{"name":"Gusto, Zenpayroll Inc.","address":"525 20th St","city":"San Francisco","state":"CA","postal_code":"94107","phone_number":"4157778888"},"company_uuid":"c827aa0d-3928-4d5a-ab1f-400641a7d2b8","name_of_sender":"Torp and Sons and Sons","debit_date":"2022-06-02","license":"Your payroll provider partners with Gusto Inc. for payments processing. Gusto Inc. is a licensed money transmitter. Learn more on our license page.","license_uri":"https://gusto.com/about/licenses","right_to_refund":"https://gusto.com/about/licenses","liability_of_licensee":"https://gusto.com/about/licenses"}}}}}},"404":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided UUID is valid.\n"}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-contractor-payments-contractor-payment-uuid-receipt.api.mdx b/docs/api/get-v-1-contractor-payments-contractor-payment-uuid-receipt.api.mdx
new file mode 100644
index 000000000..bb80a2736
--- /dev/null
+++ b/docs/api/get-v-1-contractor-payments-contractor-payment-uuid-receipt.api.mdx
@@ -0,0 +1,78 @@
+---
+id: get-v-1-contractor-payments-contractor-payment-uuid-receipt
+title: "Get a single contractor payment receipt"
+description: "Returns a contractor payment receipt."
+sidebar_label: "Get a single contractor payment receipt"
+hide_title: true
+hide_table_of_contents: true
+api: eJztWu9y27gRfxUU/XBJh5QoWY4Ufaob5y6eubt67KT/Yo8NEisJZxJgAFC2RqOZe5D25e5JOguQFPWHts6+znTafIpMLHYXi93fLnazpA/htDBWhUJamGpmhZKhXeRAx58pZDFwDpxeB9SyqcFv75S0miVWaXLOFhlIa3BZ5eA3n3E6plOw4bwXJjXtTV7S7vl2UxSChxoSELmlAeVgEi1yZEbH9AJsoaUhjKx3knInKTd1ruSV/FFZMOMr+Qdy4b8awjQQJdMFYXMmUhanQCZKEy40JJZwyJURtmJmCJN83xYlEyB2pgysSWdsDiQGkGRSSA68g3LP2UKrNK3kEw1fCjDWOKG5XzTkfiaSGeGKSGU9H13rW8t8BZ1ppz5mvCDJDJK71+RepCnRziSEkUE0IMYyWxgn/4MqtDsEV2nKNGGZKmRpBr8HOGGGGKuFnBINuQYD0rp7M0RNiCwy0CIhHBKRsdSzPd3HrdwKnFhF7AxIAtI68rMJkYpwZhmZMUMWYEkMREgDGsnRFoxMxRxtJyDlARF4FxNWpNYgt19+/mfUiaJffv4XeYXUE/GAenvxr91dm0TlMCa3lVHHGhi/pQHNmWYZWNDoq0sqWQZ0TFt8jgZUoIvlzM5oQPG6hAZOx1YXEFCTzCBjdLykPh6otxtdbbvoxxmQT5/OTtGCzhQ7jkpXQa3M38LvXMCdnJ+FfwFtkEepyAwYB72hyoSlBrYFnuIJMyHBOHmcWQhjZoCTk/MzMvdMCTNGJYKh0e+FnZEFugcSJCxNO/6eJBBhSK7VXHDggadheZ6KxHnFN4Z8zoQUWZE1eV+/mlmbm3G3y1ViOg5BOonKuhVihOXNuPUuy0VY7hRy+vuSYdj4/BrVKAzwDm03fEBBFhmCUD/qH4fRm7B3jNhTOg8dN7+vVtdoR5MracAgs34U4T+bpnz/wLI8RY/2lDRw3oJ3Nl7ShiW6PxncsNzVTsU/QYLA9RCC5+bElb/DHv7R5oFjyiZJEr8dRuHR8RDCQdQ7Cke9yXE4OuZskgwHk7fxG6dUljO5qHYlo/6QsYiHR2/7o3DAj1nI4t4kHETRm0GPDXk/HtHAudyNmtwYkOhYY/pR6dxBxCVGfPWjQakhEblwx6fnzGqRCEY+sEykqYPmWNgb9Ddv7D4aO+rTgFplWWr8Ub2mjpaO6XAw6hwNMGr2pAMXpY3v5fEmoyMexXwUDqEfhYOj+G04Ohok4Rt+3BvA5E0SD4Z0g+FEaGNvyhCrFN8kSdmaoj5RYz0uDIaUqWg2V8vLPpNczAUvWOrQxl9lBnamUO9Tn1lOfWahAb1nU9w18DYIaKxkYdB2g1EnilykiywutIHM27wXIfZRdN5UJCANABq1VMkhR0D+AbKML3ImEwwZxrkGg5yP+8ekH9kZuUT5ibALOqaXTJJvNZOJMInCCLP+Ct+d4CmUsSy9SRTHT28HvQhtm8+UhBtZZLFznEHveDgcjkajEd5kqRod078jYFTKlDiCH7SVoI0HHqe107TKhD6J5lolYIyQ006TRmCyLyVwkikJC2I1kyYT1oLukO+BaUky5VI1QQVKapKzKaA5yr9vCi0QVkusWsMUi1VhuyUVur8W05m9sepGAyb0wzalgsUiFXaBgbO+rae3rlYBzTWWTFaAeRQfdjFwE79OSCHFlwKI4CCtmAjQ7Wmorpd8NDYR5UVyHCOSsTssK/aLdiK34egpoZhYcc/zJTXg7BBhoo5uonQtblOFWp4z5hwVaUpuQuQhIh29S+EuONrOFNCJ0hlDiHC8gyq/1EB8HB5FG7H55JWm92zhKwhfYpV14dV/Y1Bf0cbZfFw/db5PF9/XJq14CenNiPXR1hpvnhiPoHSHtNvoqSD3Cu/gyqFKNxXVkLKy0nb83A/H7+UKtmDYb6VmzR7jp2L/cq3X1cZ2DbYbYKaIPfkT8bUNyBtVzCGR7KTUoOHj+jGRq1VbTVRLY1qzxW7gSuIW0Ka7jKtzCtNyUGEh22u71pR0WIpofwZ1tqq/ZrF2CFdH3wLDHXKCRTrgwxokud0q2W4ReW7XVdvtti6NqvAQVZC8VZMXqrJVgB6iTrXlJcb5U8ljRx8v/iDXX+Sw6Y3umd48bEMOitkunQ+RUlUxfk+n8R7cqbvfYbuEBvSDMFZpkbC06lbhotJIjphVfbxeVbX6Yf6ImIX0lclL1QKiYco0T/FK1ITMVIH5Uuk7fNmu6vr/oKtF0rLtQYRsinGstl4Oh7Dc2NLK2uHSnlTwCMa2p9AdWDnMt9sTxP4nkE8L9Svo+ewbzyfP07+gns9w4+nlWZavr+fzfHfiGW283J7Pzj35So4br77ns1w/F5Gv8ygrrKtW1w3ksIy+sGyYogLNDsr7qsJd0jlLC/hNGimHNTq+tjP+n9oZ/+nmWnvb7Gsj5YWNFI8tg2iw29r9UVnyrSokJ1eSkCvpM6AbyQDHhq8qdAKEKzBuFgMPwtgO+YHd4aNBg0+LZWvcV7bCkDlLBY57XBPnITQ5sDtgZhGiO4RqDloL53lTsBf1TKtJONWqyDemEvUgDfHPgsSOuMeSO0B/b53RBRUwNmd1OGuo9rWpV29sqrl/o1d3vWGP2hjeNWhMwb0lcKYypt15r7sHJ7vLFhxfdddzQAN6Xg1yCp02/IHlws8cQg6Zc4yd1HQKmdqyu+cXuhDHfe68LYz38jzXij/CM8dlNIWBpNAOqT4v6TuPLScJRuhJgVb5fN2kusR5gk94e2jrFIwqVrMR/DsGpt2saFPHkkWYwhxSwgo7w3adH2Eg1F0ujIXsJRI8hxYBK5xkTZTjWuZ7D0gn52foQ+W8a2NSE1CcZpk/Ty5Bz0XyWOA7wi5H0VhThu7vUE3cPeDWbWX/CmmiMnybe2D8xpD3ZaDU41qca3GVFFk1Cv1dmSpZYhvJ6rSSSi6w0SE8tEPGROocqlz949p/VmWJljHZTHpgCSMI1uljPdrtoyzXc6mvM/GvM/FfMRMvw9vCg+3mKRMOBxzuLUuY/kznPbq/oA3ouH16XrnqdUBnylhktFziIPqTTlcr/PylAI04eI35Qwu8R4eKXBj83TLgbvr6q4tyFv6aHDBnbzlt1U6Ti0Yio0GZ7doOuMKuQDmT/3VK/48P6Pfa2Nty//9uqE2+LjEwBTmUq9Z2Zu0bVcV37z/S1erfKe7iqA==
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Returns a contractor payment receipt.
+
+Notes:
+* Receipts are only available for direct deposit payments and are only available once those payments have been funded.
+* Payroll Receipt requests for payrolls which do not have receipts available (e.g. payment by check) will return a 404 status.
+* Hour and dollar amounts are returned as string representations of numeric decimals.
+* Dollar amounts are represented to the cent.
+* If no data has yet be inserted for a given field, it defaults to “0.00” (for fixed amounts).
+
+scope: `payrolls:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-contractors-contractor-uuid-address.ParamsDetails.json b/docs/api/get-v-1-contractors-contractor-uuid-address.ParamsDetails.json
new file mode 100644
index 000000000..e23083315
--- /dev/null
+++ b/docs/api/get-v-1-contractors-contractor-uuid-address.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"contractor_uuid","in":"path","required":true,"schema":{"type":"string"},"description":"The UUID of the contractor"},{"name":"X-Gusto-API-Version","in":"header","required":false,"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.","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"}}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-contractors-contractor-uuid-address.RequestSchema.json b/docs/api/get-v-1-contractors-contractor-uuid-address.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-contractors-contractor-uuid-address.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-contractors-contractor-uuid-address.StatusCodes.json b/docs/api/get-v-1-contractors-contractor-uuid-address.StatusCodes.json
new file mode 100644
index 000000000..5b305afb4
--- /dev/null
+++ b/docs/api/get-v-1-contractors-contractor-uuid-address.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"Example response","content":{"application/json":{"schema":{"type":"object","allOf":[{"type":"object","allOf":[{"type":"object","properties":{"version":{"type":"string","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."}},"title":"Versionable"},{"type":"object","properties":{"street_1":{"type":["string","null"],"readOnly":false},"street_2":{"type":["string","null"],"readOnly":false},"city":{"type":["string","null"],"readOnly":false},"state":{"type":["string","null"],"readOnly":false},"zip":{"type":["string","null"],"readOnly":false},"country":{"type":["string","null"],"readOnly":false,"default":"USA"},"active":{"type":"boolean","description":"The status of the location. Inactive locations have been deleted, but may still have historical data associated with them.","readOnly":true}}}],"example":{"street_1":"412 Kiera Stravenue","street_2":"Suite 391","city":"San Francisco","state":"CA","zip":"94107","country":"USA","active":true},"title":"Address"},{"type":"object","properties":{"contractor_uuid":{"type":"string","description":"The UUID of the contractor"}}}],"title":"Contractor-Address"},"examples":{"Example":{"value":{"version":"23323096a8015e32d9795fadf1fd300d","contractor_uuid":"9779767c-6044-48e0-bf68-aeb370b9a2e7","street_1":"999 Kiera Stravenue","street_2":"Suite 391","city":"San Francisco","state":"CA","zip":94107,"country":"USA","active":true}}}}}},"404":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided UUID is valid.\n"}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-contractors-contractor-uuid-address.api.mdx b/docs/api/get-v-1-contractors-contractor-uuid-address.api.mdx
new file mode 100644
index 000000000..a7ee4311a
--- /dev/null
+++ b/docs/api/get-v-1-contractors-contractor-uuid-address.api.mdx
@@ -0,0 +1,71 @@
+---
+id: get-v-1-contractors-contractor-uuid-address
+title: "Get a contractor address"
+description: "The address of a contractor is used to determine certain tax information about them. Addresses are geocoded on create and update to ensure validity."
+sidebar_label: "Get a contractor address"
+hide_title: true
+hide_table_of_contents: true
+api: eJzdV21v2zYQ/isc96EtIPktTlz704wmLYJha1A32wAnaGnxZLGlSJUvbjxD/304SrLkJO4aDPuw5UtkiXc8Pvfc3cMdvYvX3jodC+VgbZgTWsVuWwCdLSnkK+AcOL2NqC6g+nrJ6YyuwcWbYZxo5QxLnDa28/zBe8FjxrkBa2lEHVtbdPeqXY0eOdjEiAJ90hl9nwGpTYhOCSOtPyIs8RY4cZpwcGByoYAkYBwTijh2R4RKtclDeISttHfEZZD3yLxyCJYwA2QNOtEcONGKJAaYA8IUJ77g+Og0AWW9AbJhUnDhtr0bdaNsoguYkY+do84MMP6RRrRghuUYEB5vRxXLgc7oPSBoRAUesGAuoxE18MULA5zOnPEQUZtkkDM629EKdWqdEWpNy8cAur6+PEd0XAYdfGgZ7Tf/I34T0jm/uox/A2PRtg4gA8bBHISQMmnh/kbnDcQ27IPgxCuG+M+vLsmmckqYtToRzAEnX4XLyFZ7ExYkTMoeuUyJ0gowdYXRG8GBR9UaVhRSJCFXzyxZ5kKJ3Odd37fPM+cKO+v3uU5sL/Czl+i83/AxLtjWaCnD9z4rRFxbCrX+sXYYd16/aBjUo8cBjygonyNPR4PRaTw4i4enFU1T5qWjs+77srxFHG2hlQWLzkaDAf47hPLijuWFBNKspFFgByiHaztI9D9ZNNg9jE6vPkHiaESZlG/TwLPv/1IYLFsnqhBrNB47+kOqJd4YUG6f75p1leseWQCE38sWebL2gsMTkyc45IV2oJLtC5JirXdKWSuS6a9Ymd7idsKSVIDkPVqWEXXCSTxETXO2khAq4dsgWGcA3Idhi8KyhUF5KWnILONvldzWFVJGjdnoiWaJcNsn78QcPNHmT1E8NTDtlTNPiq1bCteLOXYoljix6QRLV1pLYOpRRuHBvG2IJHXF/B65VJWb/StLMrYBsgJQhIMEh71j5R3J2ZZYJ6SsFmTCOm1EwiQ2KfagJYUZQLvnwJZbhtqFqjIPGUHHwxH5WYBhZOEM24DyWLJt7unCCwfkZDqkTW7pginy2jCVCJtous8ffTWndWLodDwcTGgH9IBfC18IqyV0PbW+g8z3R813VfaxIRJwaWJoZ3XchtOgFva+aBHcMOnhoMPQ0cnJ6GQwPWMvB8NTOBnx6WR6mjKeDlN+MhjwuhMeBE+nk8l0cjZJ4rPBeByPX8IgXqVnL2MGq5PJYDVlI5i0+cCETafTfyFhIV9/k67wF9HxYPyw7f+qHXmtveLkRhFyoxB1HLpgkZsGrPYmAcI1WKK0I3AnrOuRX9hnIEGBYGqasVnlS9hKlvRuVGh+d7EtgH0GZrcxjv5Yb8AYwaESZ/O9+II7BwqTUmmUz4DnOSr6oiaXXfGHPGzsju26N+zujoTKwWW6loxBMrmMzmh/M+x3FFV/d48MZb+VjxbMppFY3khUMvWEYYWoBkzMIQ9T5gHhzyHHHHcDr/zFgXFoF+rsiONHfV4Zzb/hs8DPeHQLiTeBc8sdfaXzgqntPEnA2rlHFJa33VULnPxVaT2ydl/YGGKjYkLHBWaCqjuMsXYRS9iAJMy7DJSrxQZW8mJrHeT/ZIfKw5ENStScqQ5e644SdCnKPORK2ydaTRVR1J32bboAsxEJdPLRqoig7vthYZ/j1tgO4/A71mnIA5reD/Z3kInOg8gPcTyz5KLmN7mq9EhQoFwnPgflwjF+qJsUS4JcqxX2ebMreQeymldYZjkTMhCq/vpTyx9Eo9DW5Ux1/LwBd3jLaRl/EPuulYz/yUtSzSoHd65fSCYC/UK57epusKSb4cE8QAxmD69RDUC3Ec20dWi42+HN5NrIssTXXzxgv17eYjsyIkhCLD4uLD4fufF0EX7+rr4cvSDfmJVHTlW/ZGrb6Yc0qpvn/QOVt2XUXMqeFuT//Ib2KLYVho9fb/dQt5MKO1vhOt8eXLYOhtObi/e0LP8C5MrqlQ==
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+The address of a contractor is used to determine certain tax information about them. Addresses are geocoded on create and update to ensure validity.
+
+scope: `contractors:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-contractors-contractor-uuid-bank-accounts.ParamsDetails.json b/docs/api/get-v-1-contractors-contractor-uuid-bank-accounts.ParamsDetails.json
new file mode 100644
index 000000000..e23083315
--- /dev/null
+++ b/docs/api/get-v-1-contractors-contractor-uuid-bank-accounts.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"contractor_uuid","in":"path","required":true,"schema":{"type":"string"},"description":"The UUID of the contractor"},{"name":"X-Gusto-API-Version","in":"header","required":false,"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.","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"}}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-contractors-contractor-uuid-bank-accounts.RequestSchema.json b/docs/api/get-v-1-contractors-contractor-uuid-bank-accounts.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-contractors-contractor-uuid-bank-accounts.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-contractors-contractor-uuid-bank-accounts.StatusCodes.json b/docs/api/get-v-1-contractors-contractor-uuid-bank-accounts.StatusCodes.json
new file mode 100644
index 000000000..819555de6
--- /dev/null
+++ b/docs/api/get-v-1-contractors-contractor-uuid-bank-accounts.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"Example response","content":{"application/json":{"schema":{"type":"array","items":{"title":"Contractor-Bank-Account","type":"object","x-examples":{"Example":{"value":{"uuid":"1531e824-8d9e-4bd8-9f90-0d04608125d7","employee_uuid":"9fcf1b1d-8886-4691-9283-383d3bdd4fd9","name":"BoA Checking Account","routing_number":"266905059","hidden_account_number":"XXXX1207","account_type":"Checking"}}},"x-tags":["Contractor Payment Method"],"properties":{"uuid":{"type":"string","description":"UUID of the bank account"},"contractor_uuid":{"type":"string","description":"UUID of the employee"},"account_type":{"type":"string","enum":["Checking","Savings"],"description":"Bank account type"},"name":{"type":"string","description":"Name for the bank account"},"routing_number":{"type":"string","description":"The bank account's routing number"},"hidden_account_number":{"type":"string","description":"Masked bank account number"}},"required":["uuid"]}},"examples":{"Example":{"value":[{"uuid":"1531e824-8d9e-4bd8-9f90-0d04608125d7","contractor_uuid":"9fcf1b1d-8886-4691-9283-383d3bdd4fd9","name":"BoA Checking Account","routing_number":"266905059","hidden_account_number":"XXXX1207","account_type":"Checking"}]}}}}},"404":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided UUID is valid.\n"}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-contractors-contractor-uuid-bank-accounts.api.mdx b/docs/api/get-v-1-contractors-contractor-uuid-bank-accounts.api.mdx
new file mode 100644
index 000000000..e8c2ddde4
--- /dev/null
+++ b/docs/api/get-v-1-contractors-contractor-uuid-bank-accounts.api.mdx
@@ -0,0 +1,71 @@
+---
+id: get-v-1-contractors-contractor-uuid-bank-accounts
+title: "Get all contractor bank accounts"
+description: "Returns all contractor bank accounts."
+sidebar_label: "Get all contractor bank accounts"
+hide_title: true
+hide_table_of_contents: true
+api: eJzdV9tu20YQ/ZXt9iEJwNXNsivpqUqcBn5IYsRJa8AWnBV3JG1E7jJ7US0I/PdilqRI3eIaRYGiT6bJnbNzOXNmtKGPbO6t00wqB3PDndSKuXUGdHRHIZ2CECDoJKKOzy2+e6OVMzx22pBrvk5BOfIe3EKHQzqDAuJK0BGdg2OrLou3Frbx/OC9FGzK1fKBx7H2ylkaUQE2NjJDCDqin8B5oyzhSUJqS4JGpDJq3at7ZWOdwYh8bcBnhXMPaXDOjgxw8ZVG1IDNtLJg6WhDe50O/tm99e0jT7MESHWSRhRxQTk8y7MskXEIsv3NosGG2ngBKcenInOUG8PXNKLSQRouctIl+KHOHnvN1ZKNiyhoVFnq6TeI8f9HBoUfwb70CR9XPPHhARNIR7R7ftaFQa/PBmIIrD8VAzacDTusIzr9i86g2zsXv9CIQpoleg3wUJoNZ/GsO+0KNhgMLlj/Ythlw97gjJ0NzsTZVIj+TAxpRBVP0a3XekzeLCBeSjUntdNGeyfV/EH5dAqGjmjv4mLYOe+co+lCCgGqqm595vb29rbb66BT1bcy+OoGmuc5ZuBvcS4zyDoni0QV0W0LYZ1BvH1ifflydUn0jLgF7LCJ5kWtGxR9HliVZQTaDe4QBZRPQ3RV1BG94Sup5hbD2r3jdcNJEoDyqjZPufeBp0Bm2hwNdr+AT4F93sN4YUkJQUqI/GThn8J+z+0SxA78FhRdhe9eGhCYslCYCb79cZPcPbdLDor/H++TSZ6HXul3+odC9kE78pv2SpB7Rci9wuJhFsE6EChv2psYiNBgidKOwKO0rkXe8yUQ6w0ExmRGr6QAQQLNpSUrnkjRulehKBk3PAUHxoZkl1nYz2JEJfqTcbegzUI64yE6VM+SH/kx8jWbrb6G5tH28lv2Lgy08fUV+x2MRdvSgQVwAWbHhRlPLOxfdIkRpVKBDfcI7oBNuQVBxtdXZFWAEm6tjiXHXP4p3YKstTfhQMyTpEWuZkRpBZiyKodRcaYxQl5YcpdKJVOfNrEnLxfOZXbUbgsd21aY0K1Yp+1qIrOMr41OkvC9zTPJSkup5j+XgKzx+hW64S2IFj2d8FqSep3eOetcsO55IUUz7hOHtK3f5/kEJdpmwJfA7Zph+plegTFSQDH9UbXG9XBvnp4b7bMdqpTKXgo7drYDhb4X1FrCmo5ObyvRtuUbWwuyorI75ejW8MDh49aF47XVqQAwPcXuUUDTqOD/iLZX3XZjJ2pv9tolb+9vRRbMqmoxbxJkckkPnsmCHUxAGihyIKuXkOq95Bd4LOgb2oVQTwAfxbw2oUSnMDNTJsBC7I106+D5G51mXK3HcQzWjj3m4m7SPHWDvCyk/MjZLVvRxYrF+P8UuAldvetjCcESWEFCuHcLUK5sO9SWm7V1kP6TGwqEExfkqDkz3Vz+gi5hmyN9SmXa6amIou7Yj7MbMCsZQ6MetQTwqfauHQ62BV6N6w8L/zM9C3VA031n/4Ak1ikQp0nw44Ulb8tGwaUKxSQokNCxRxqHMH4qRyKPw+5bKuxldSv5BEk4Z8OCyWUSCFV+/bXmTxgV2rqUqwbOO3A/XO33Y9jUe/i/8tOgrL6DR9fOEi4DTUJbbMrevaOr7s6WgD6ODsfdbgNPIrrQ1qH5ZoNz5ItJ8hxff/dgsDkmqCdG8mlSLC1CWnw+MZ+aeXj5qRxlr8gPxuOJ2KpfK2rdEDQalaq3H1Y+wd2uGKHPc/J/Pk+P5rbI4fFlZJvqesSgDmWu8e3gd+bOQHn39jPN878ADX10rQ==
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Returns all contractor bank accounts.
+
+scope: `contractor_payment_methods:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-contractors-contractor-uuid-onboarding-status.ParamsDetails.json b/docs/api/get-v-1-contractors-contractor-uuid-onboarding-status.ParamsDetails.json
new file mode 100644
index 000000000..e23083315
--- /dev/null
+++ b/docs/api/get-v-1-contractors-contractor-uuid-onboarding-status.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"contractor_uuid","in":"path","required":true,"schema":{"type":"string"},"description":"The UUID of the contractor"},{"name":"X-Gusto-API-Version","in":"header","required":false,"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.","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"}}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-contractors-contractor-uuid-onboarding-status.RequestSchema.json b/docs/api/get-v-1-contractors-contractor-uuid-onboarding-status.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-contractors-contractor-uuid-onboarding-status.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-contractors-contractor-uuid-onboarding-status.StatusCodes.json b/docs/api/get-v-1-contractors-contractor-uuid-onboarding-status.StatusCodes.json
new file mode 100644
index 000000000..6f424dd7b
--- /dev/null
+++ b/docs/api/get-v-1-contractors-contractor-uuid-onboarding-status.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"Example response.","content":{"application/json":{"schema":{"description":"The representation of an contractor's onboarding status.","type":"object","title":"Contractor-Onboarding-Status","x-tags":["Contractor"],"properties":{"uuid":{"type":"string","description":"Unique identifier for this contractor."},"onboarding_status":{"type":"string","description":"One of the \"onboarding_status\" enum values.","enum":["onboarding_completed","admin_onboarding_review","admin_onboarding_incomplete","self_onboarding_not_invited","self_onboarding_invited","self_onboarding_started","self_onboarding_review"]},"onboarding_steps":{"type":"array","description":"List of steps required to onboard a contractor.","items":{"title":"Onboarding step","type":"object","properties":{"title":{"type":"string","description":"User-friendly description of the onboarding step."},"id":{"type":"string","description":"String identifier for the onboarding step."},"required":{"type":"boolean","description":"When true, this step is required."},"completed":{"type":"boolean","description":"When true, this step has been completed."},"requirements":{"type":"array","description":"A list of onboarding steps required to begin this step.","items":{"type":"string"}}}}}},"required":["uuid"]},"examples":{"Example":{"value":{"uuid":"bc57832c-d8bc-43a7-ae99-3a03380ff037","onboarding_status":"admin_onboarding_incomplete","onboarding_steps":[{"title":"Basic details","id":"basic_details","required":true,"completed":false,"requirements":[]},{"title":"Enter compensation details","id":"compensation_details","required":true,"completed":false,"requirements":[]},{"title":"Add an address","id":"add_address","required":true,"completed":false,"requirements":[]},{"title":"Payment details","id":"payment_details","required":true,"completed":false,"requirements":[]},{"title":"Sign and acknowledge documents","id":"sign_documents","required":false,"completed":false,"requirements":["basic_details,","add_address"]},{"title":"File new hire report","id":"file_new_hire_report","required":false,"completed":false,"requirements":["basic_details"]}]}}}}}},"404":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided UUID is valid.\n"}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-contractors-contractor-uuid-onboarding-status.api.mdx b/docs/api/get-v-1-contractors-contractor-uuid-onboarding-status.api.mdx
new file mode 100644
index 000000000..dbd5422e1
--- /dev/null
+++ b/docs/api/get-v-1-contractors-contractor-uuid-onboarding-status.api.mdx
@@ -0,0 +1,102 @@
+---
+id: get-v-1-contractors-contractor-uuid-onboarding-status
+title: "Get the contractor's onboarding status"
+description: "Retrieves a contractor's onboarding status. The data returned helps inform the required onboarding steps and respective completion status."
+sidebar_label: "Get the contractor's onboarding status"
+hide_title: true
+hide_table_of_contents: true
+api: eJztWm1v27oV/itnLLAmgGSnTbu2/rTcm9wiwHYbNO3ugMRwafHY5o1EqiTlxEj834dDSRb14uZuLYZhiD/EEsnzwvP6kM49u4uXhXU6lsrh0nAntYrdJkc2uWKYzVEIFGwaMceXlsZ+1soZnjhtLA0btLlWFi2b3LOXR0f0JdAmRubEik3Y2R3P8hShXjliEUu0cqgcLeZ5nsrEyx3/bonintlkhRnvs/q0Ija5QYvKeRLQC+AKkp1Szy1oNdfcCKmWYB13hSWJ5ZaYnv+OiaN36VIaaLYTf9jRxZeejkXsLu7vm7adG52jcbLcd1FIQd+VEOuMVEsWdbT/rOTXAkEKVE4uJBpYaANuJW2g/4htI9bsYFbu4HHmHxSSLdwK4bpPf80AVZHBmqcFenvQK20rWJpo8pNDwSLGRSbVLJg0uJZ4OzQjVU3IImYxXYSTSruZVGtZcu3O7p+xjpvhmUqRaddMmIdW4sbwTc9If5PWkZX8ajD4tZAGBThdxwzwlisiJh1mJd8qXj6EwYX5QGS1Q6OiezQ2LJp4YSQqkW4gmKudqttyfZj8kaC79MP9oBvmWJsk4DvXOkWueox/W6ECZwqMyhAmHiAbq3p+TUj9hwxX3MIckTK84hTqmaFyj3v9BNLK750tt0NgjkupGtFt77dsvPWf0FpXZQmgoMSy3HmyqvTRo8+8plawefL6zdvjl0ks3s6T+NUxfxNzfPcuPuZHx8dvjxaLo+M3bLASPJKB/aS4aqL3J25lAgIdlymVt1IVGpw1g822vDdCJy54arFr/qvpNmpEnCmHxrsLlS1rdEdeOPfDxJ4IQY2AC2HQ7kRxIWbN0PdJuOAbGu/uJi+Hf9hGLuVSAVcCeHKj9G2KYokgdFKUqyupVi7VLBxthFYyHpXa9nvkS3tjrZZOv8gUQeEtrKTxHVgbV2uykCnOFN7OaG62m/tefdh0O63z7NXRqz4W+FU7+EUXSsC1ArhWJTb4WqB1KAhs6MIkZDm0oLQDvJPWjeDv/AbBFgZ9DcyNXkuBAj5/Pj+l6rXmqRSja8VILtVxH6XntNElunj9Im76gw2eZ5TWcT9bI5ZzwzN0aMpMVDxDnwMtSjKm8sHkVgMR1OChTiHqljoygt9K1TUaMYz8WQn/Z/zeQ76Ti/P4H2gs0VYKrJALNEP+aws6pR1lUqH1cgR3GM+5RQEnF+ewLpkCt1YnkpNDbqVbwUYXxi9IeJqO4HwBSisku9eOiMo1ASh8buEqk0pmRRbynh6snMvtZDwWOrEjj2FHic7GNWaNc74xOk39/JjnMq4opVo+qxjGwfAhqVFYajD7Dd7gppdHL1/HR3+JX7wmOChwwYvUsUk4vt1Ou2b7iM5IXKNtAY1BzAqfSrtyMOgKo1DACtPcglQLbTJv9l376jU2KiAEuDFxco119ySfVOyv1bWyic5xAl+CkJ4Y5OILTT57Bn0Y6cefwQl1oHjBE5lK593bLL1WD31CeIDTANM8XKuHSdz7PIQvE1oEX77R7L7AQ6kJKERhqYejbz6+kFR2KjsQn+vCdTJiBHsklAjTc0/TFps+GikrdVuJRKuFNFlghVrUENgmOc3ZohGxKNJ0U/OoBK3REIYTnl/pioCUkHIcOuKPugLiOAb/t/7sM80PN/43zguNBLIJkUt/aCSWTkO5qsOWJkIzwAGOlqMIMm5uKDk4JCtMbub67jCCeaWV3ViHmZdCjWKDDuh8WYlcy/KkuU/jQNshN3pOXAWMujruY1wdgQYYVzOl8m2nUyFN0Np9TIPYbjuvnAhMaZ/b0qMo2t5U4r8Z4dDFswNhTQXvAT42cOLAHpaIPkjU4Zrz0Btpf6oq1IImpfXIKkKupSh42q7lC2msA+q1EaR89+hbYQoWk8JItwFVZHM0oA38VFjqpNYv9GY4O/8VBOaovE8pZjphvslxl6M70FYrFiysZmr3DEHvAapwWU3awblEdaB9DeHpIVyigyJv20FIgwnh5Vxb6cBXKOcLJOXgLkJbSLYTKxR2tk7i394dAjcIS1SEy1DAn4GocZdCQ1i0w7GDYqnp7/iN4MFf+dgc+Q1yu4nJIbFeozFSYIkBmwuA3SUR3jlUhCFKiHeDGzbZf68W1WfB8H6N0FlNt0/8jnBQDQIbGbqVrrCqh55uxSZsvH4xDvJ6fN8Bn9vxEG61aNY1aC1MStiwAlw8lyXeigVmHnT1jtynmOmOKUt+sT8zEJ0HpHsYD/K8MFp8g2dO02SEOsG85j/rLOdqc5JQUTwpyB5X03DVJSG98rQ+sHaH/0jFGhf6SwzkxuPkto4VizjFNabAC7eihlUCWULrl77VfI+EksMeAXQnpBY6vK/ySJ+AM4VPhfVbKDVihOTth8UlmrVMMPBHA6p9Cx/7hWNBouloFPv3WC+8H4i0d6WDaaIzpJz3ejy3cFaFPFyU8Nxj+jr9/Tb+VN0P88TfD1dnltNaKnzE1K/zmZdxmfqAqmb/2sQPWSPX1mVcBXzeYxeKDKHv7k7umxvrJwz/hOGfMPwThn/C8E8Y/gnD/49i+ApTObxz4zzl0oMvDzbvK1R8xdYvKqBR/5odsUn/WrYPjacRW2nriMX9Pd15fjbpdkvDXws0BDunhNSN5HNCYFf3TEhLz3vuUkNscVAlgDiEb1zl7tlf/SOY2gRHBRZV54ru1rb0Y1V13fvvKfl/fvc7aNvShsMX5ztTN4c4Qvi5C+Z6/+XQOq69P/vEttt/AU8zAnQ=
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Retrieves a contractor's onboarding status. The data returned helps inform the required onboarding steps and respective completion status.
+
+scope: `contractors:read`
+
+## onboarding_status
+
+### Admin-facilitated onboarding
+| onboarding_status | Description |
+|:------------------|------------:|
+| `admin_onboarding_incomplete` | Admin needs to enter basic information about the contractor. |
+| `admin_onboarding_review` | All information has been completed and admin needs to confirm onboarding. |
+| `onboarding_completed` | Contractor has been fully onboarded and verified. |
+
+### Contractor self-onboarding
+
+| onboarding_status | Description |
+| --- | ----------- |
+| `admin_onboarding_incomplete` | Admin needs to enter basic information about the contractor. |
+| `self_onboarding_not_invited` | Admin has the intention to invite the contractor to self-onboard (e.g., marking a checkbox), but the system has not yet sent the invitation. |
+| `self_onboarding_invited` | Contractor has been sent an invitation to self-onboard. |
+| `self_onboarding_started` | Contractor has started the self-onboarding process. |
+| `self_onboarding_review` | Admin needs to review contractors's entered information and confirm onboarding. |
+| `onboarding_completed` | Contractor has been fully onboarded and verified. |
+
+## onboarding_steps
+
+| onboarding_steps | Requirement(s) to be completed |
+|:-----------------|-------------------------------:|
+| `basic_details` | Add individual contractor's first name, last name, social security number or Business name and EIN depending on the contractor type |
+| `add_address` | Add contractor address. |
+| `compensation_details` | Add contractor compensation. |
+| `payment_details` | (optional) Set up contractor's direct deposit or set to check. |
+| `sign_documents` | Contractor forms (e.g., W9) are generated & signed. |
+| `file_new_hire_report` | Contractor new hire report is generated. |
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-contractors-contractor-uuid-payment-method.ParamsDetails.json b/docs/api/get-v-1-contractors-contractor-uuid-payment-method.ParamsDetails.json
new file mode 100644
index 000000000..e23083315
--- /dev/null
+++ b/docs/api/get-v-1-contractors-contractor-uuid-payment-method.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"contractor_uuid","in":"path","required":true,"schema":{"type":"string"},"description":"The UUID of the contractor"},{"name":"X-Gusto-API-Version","in":"header","required":false,"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.","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"}}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-contractors-contractor-uuid-payment-method.RequestSchema.json b/docs/api/get-v-1-contractors-contractor-uuid-payment-method.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-contractors-contractor-uuid-payment-method.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-contractors-contractor-uuid-payment-method.StatusCodes.json b/docs/api/get-v-1-contractors-contractor-uuid-payment-method.StatusCodes.json
new file mode 100644
index 000000000..3a5195667
--- /dev/null
+++ b/docs/api/get-v-1-contractors-contractor-uuid-payment-method.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"Example response","content":{"application/json":{"schema":{"title":"Contractor-Payment-Method","type":"object","x-examples":{"Example-1":{"value":{"version":"63859768485e218ccf8a449bb60f14ed","type":"Direct Deposit","split_by":"Percentage","splits":[{"uuid":"e88f9436-b74e-49a8-87e9-777b9bfe715e","name":"BoA Checking Account","priority":1,"split_amount":100}]}},"Example-2":{"value":{"version":"63859768485e218ccf8a449bb60f14ed","type":"Check"}}},"description":"","properties":{"version":{"type":"string","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."},"type":{"anyOf":[{"type":"string","enum":["Direct Deposit","Check"]},{"type":"null"}],"description":"The payment method type. If type is Check, then `split_by` and `splits` do not need to be populated. If type is Direct Deposit, `split_by` and `splits` are required."},"split_by":{"anyOf":[{"type":"string","enum":["Amount","Percentage"]},{"type":"null"}],"description":"Describes how the payment will be split. If `split_by` is Percentage, then the `split` amounts must add up to exactly 100. If `split_by` is Amount, then values are in cents and the last split amount must be `null` to capture the remainder."},"splits":{"type":["array","null"],"items":{"type":"object","description":"Representation of a bank account item","properties":{"uuid":{"type":"string","description":"The bank account ID"},"name":{"type":"string","description":"The bank account name"},"hidden_account_number":{"type":"string","description":"Masked bank account number"},"priority":{"type":"integer","description":"The order of priority for each payment split, with priority 1 being the first bank account paid. Priority must be unique and sequential."},"split_amount":{"description":"If `split_by` is 'Amount', this is in cents (e.g., 500 for $5.00) and exactly one account must have a `split_amount` of `null` to capture the remainder. If `split_by` is 'Percentage', this is the percentage value (e.g., 60 for 60%).","type":["integer","null"]}},"required":["uuid"],"title":"Payment-Method-Bank-Account"}}},"x-tags":["Contractor Payment Method"]},"examples":{"Example":{"value":{"version":"63859768485e218ccf8a449bb60f14ed","type":"Direct Deposit","split_by":"Percentage","splits":[{"uuid":"e88f9436-b74e-49a8-87e9-777b9bfe715e","name":"BoA Checking Account","hidden_account_number":"XXXX0992","priority":1,"split_amount":100}]}}}}}},"404":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided UUID is valid.\n"}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-contractors-contractor-uuid-payment-method.api.mdx b/docs/api/get-v-1-contractors-contractor-uuid-payment-method.api.mdx
new file mode 100644
index 000000000..250d3fcc7
--- /dev/null
+++ b/docs/api/get-v-1-contractors-contractor-uuid-payment-method.api.mdx
@@ -0,0 +1,73 @@
+---
+id: get-v-1-contractors-contractor-uuid-payment-method
+title: "Get a contractor's payment method"
+description: "Fetches a contractor's payment method. A contractor payment method"
+sidebar_label: "Get a contractor's payment method"
+hide_title: true
+hide_table_of_contents: true
+api: eJzdWFtv4zYW/issd4tMAMmX1EkcPzWdTAd5mG0wl90AjhFT4rHNRiI1JOWxYei/Lw5JWfKtzaBPLRAguvDcv/OdI2/oKp6XxqpYSAtzzaxQMrbrAuhoTCFPgHPgdBJRy+YGn71V0mqWWqXJA1vnIC35AHah3CENplDSgKGjDb3o9fAfB5NqUaBiOqLvViwvMiD1SRrRVEkL0uJZVhSZSJ0T3d8NCmyoSReQM7yywmZARy0X4uBCHFyIqHedquR3SC2N6CoGb9G5FKzHfbxZsqwEdwHaeO+ufhpe3lxfDQfDS7joD9N0NmSDwU2SXPVm/QG0DNwJDakld1AoI9CQKTJhn5M1HdEH0ClIy+ZQP8fMbWhZCk5HFIbD2c3gp6s4uR5APLhhw3h4DTfx9fV1cpPM4Lp/iYKS5WjoF3VL3i4gfRFyTm7TVJUSzRVaKC3smo76tW2Wu3ejfq9XTaoq2kZ78ZejdQ7QCpXultN5ogrQVvgMb7VvalljtZBzui/5eQEkLbVGAAUhombELoD44nXIJwB3Pw7vMQPzUnCYvFlYW5hRt8tVajoOwJ1U5d0asHHB1lplmXvfFRzyQlmQ6fqczJQmQs6Uzh3MiJJkob4Rq0hp0JwwZCYg4x1a1eFvKJPr32auhvtBgSxzbIsDPPiUTapoKyPLLKPV5FgiitBJuYMxQYEOuZ+5CyKMB0CEyZBkWiNtSpjk4dZMCVdEKkskAMdoEiCFKsqMWeA7unY9jU7qYxq79GspNPhkNAh/TUJu84DUVje8Iht37i4B46vSys03kWUYlXPDRdTyXBjS2AmJQmF/ZEp8bxiSl8YSxjkpC0wSrFhqszXp93pHNPoQgjbXP8ZlRUiClozLF1rJmLHer2DI20mATDHMKZpKWWFL7QGtIWdCctBNXk3TMWPKtGZrpADM0SSiwkLeOtCw227uPkKhwWAObOgmRhImXwjztEFQz0HHelZ6Tbvu6Lq/Q989SX23sBOrIroQnIN8Do+fZZknoP9c3wdmXoDvqfSyVZsat3rccAN91DGlOWhMVi3nKAJYuthCz1UoIt+EXTSn+iQBZCQs6ExorHfbn4IJ3iEP9ekaEKUUX0twyDHwtQRpBcta7VWT+P7cPADnmUfnWeQ5C/9qWL6BzrwTkctez4Xy78tOr3fuTNZ4VxK2jjrPFmwJhNUmvBNTTMqfAfiwa86aRmw55zp5+8J3U+3olffzqvfjeWc7c8atovk+wOlTExK+d8DFzSSsBbu7QPwLky9xPTDd6FrFr1hiqoge2Rj+9vvCiU6jj4+Pj72bm4tXrRSVS+OgNzjE53+UJb+qUnLyJAl5kp8XfnqAscBx21OlToFwBcaNKVgJYzvkA3sBYmpYFVotBQdOvny5v0PULFkmeOdJUrSLpOWY7R6zMgcbL/txuq2kaV0/Y+ri0L7Peb0c7rr8K9h0gZROGsEzszeLO+S29Xrv5ZPkJ8eVWagy49uBRViqlfF9sGOOGaNSgVP6SbYJxHSe5JM0qSpgRKat0HajMiMNjE+xfEyzHCxoD54Ah72c0IgKjL1gdkHb7WR1CVF7194h4IO9D8vrihRWtsYMxRkfjD/G7923xe3Dffzf0DTBgQUw7nq7cWHGMgOH+4AFnQsJPnWcWYgTZoCT24f77eLYJNGT9FqV2h1IWZY5jpJIecJsIRb5M60PjjNDxrmQIi/ztu7v3DVZIeJmXf1XUBi3Hp+jG6XBpep0wps96qJ3cRn3ruL+JXXL0oyVmaWj9vMK16hVbApgL8DMOp5rVRY7xQ8st/1Map/GYsVqCVoLDr6z0P7KgkR/PZxeAJnq5MdiVLNj+6MRkVDL7Tu3FTjp5HHpXWcbLeg0piH0eh2Fw/mIdpf9bospupu9tqi6B1xhQC/rXip1hpANOGCF8DCIOeQOCwfUcge52suy1xc7Rkc5F98JxUd1PuiDyrV1FvgaM2AgLT2Njzf0rcoLJte3aQrG3JaYjPGkfeoTAtCPuiNnt7BEF2u44n0CTB/Zp4KKOIMlZISVuDnb0F9IIp/WxkL+Vyx4DScMVEguM9X+rcAREPYzYmU7t1vNE1EkGPPb7BPopUihVY+m11miStt1B7scTeMsit19rGauDii67+z/IEtVDrg9OT/ODHkXugP3DmQNRzVcpWVe7+0/hJ9EWOrWwECld7VV8hEyd85gk+ZMZA5Q4e3PDX4wG4UyNmeypec92D8eePtBbJrfZ/5pEzMgz8LKdouMCQdR15KbQBxjuuyHcgTqoBEdHc7UPfaYRHShjEX5zQan1RedVRU+/lqCxs6cIHNpwRIE6XhDuTB4fWIKtmvw5mMYmOfkD4bwieDCQybXLeqkUeDZ/bgqXIbDoP4+J//hU/tobn0Oj68821Q3Qw1JsLCtdwe/fe6Ms/fvPtOq+j9hDo9S
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Fetches a contractor's payment method. A contractor payment method
+describes how the payment should be split across the contractor's associated
+bank accounts.
+
+scope: `contractor_payment_methods:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-contractors-contractor-uuid.ParamsDetails.json b/docs/api/get-v-1-contractors-contractor-uuid.ParamsDetails.json
new file mode 100644
index 000000000..ef8002261
--- /dev/null
+++ b/docs/api/get-v-1-contractors-contractor-uuid.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"X-Gusto-API-Version","in":"header","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"},"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."},{"name":"contractor_uuid","in":"path","description":"The UUID of the contractor","required":true,"schema":{"type":"string"}}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-contractors-contractor-uuid.RequestSchema.json b/docs/api/get-v-1-contractors-contractor-uuid.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-contractors-contractor-uuid.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-contractors-contractor-uuid.StatusCodes.json b/docs/api/get-v-1-contractors-contractor-uuid.StatusCodes.json
new file mode 100644
index 000000000..c6b21bb9f
--- /dev/null
+++ b/docs/api/get-v-1-contractors-contractor-uuid.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"description":"The representation of a contractor (individual or business) in Gusto.","type":"object","properties":{"uuid":{"type":"string","description":"The UUID of the contractor in Gusto.","readOnly":true},"company_uuid":{"type":"string","description":"The UUID of the company the contractor is employed by.","readOnly":true},"wage_type":{"type":"string","enum":["Fixed","Hourly"],"description":"The contractor's wage type, either \"Fixed\" or \"Hourly\"."},"is_active":{"type":"boolean","default":true,"description":"The status of the contractor with the company.","readOnly":true},"version":{"type":"string","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."},"type":{"type":"string","enum":["Individual","Business"],"description":"The contractor's type, either \"Individual\" or \"Business\". "},"first_name":{"type":["string","null"],"description":"The contractor’s first name. This attribute is required for “Individual” contractors and will be ignored for “Business” contractors."},"last_name":{"type":["string","null"],"description":"The contractor’s last name. This attribute is required for “Individual” contractors and will be ignored for “Business” contractors."},"middle_initial":{"type":["string","null"],"description":"The contractor’s middle initial. This attribute is optional for “Individual” contractors and will be ignored for “Business” contractors."},"business_name":{"type":["string","null"],"description":"The name of the contractor business. This attribute is required for “Business” contractors and will be ignored for “Individual” contractors."},"ein":{"type":["string","null"],"description":"The Federal Employer Identification Number of the contractor business. This attribute is optional for “Business” contractors and will be ignored for “Individual” contractors."},"has_ein":{"type":["boolean","null"],"description":"Whether company's Employer Identification Number (EIN) is present"},"email":{"type":["string","null"],"description":"The contractor’s email address. This attribute is optional for “Individual” contractors and will be ignored for “Business” contractors. "},"start_date":{"type":"string","description":"The contractor's start date.","readOnly":true},"address":{"type":["object","null"],"description":"The contractor’s home address.","properties":{"street_1":{"type":"string","readOnly":true},"street_2":{"type":["string","null"],"readOnly":true},"city":{"type":"string","readOnly":true},"state":{"type":"string","readOnly":true},"zip":{"type":"string","readOnly":true},"country":{"type":"string","readOnly":true}},"readOnly":true},"hourly_rate":{"type":"string","example":"50.0","description":"The contractor’s hourly rate. This attribute is required if the wage_type is “Hourly”."},"file_new_hire_report":{"type":["boolean","null"],"description":"The boolean flag indicating whether Gusto will file a new hire report for the contractor"},"work_state":{"type":["string","null"],"description":"State where the contractor will be conducting the majority of their work for the company.\nThis value is used when generating the new hire report."},"onboarded":{"type":"boolean","description":"The updated onboarding status for the contractor"},"onboarding_status":{"type":"string","description":"One of the \"onboarding_status\" enum values.","enum":["admin_onboarding_incomplete","admin_onboarding_review","self_onboarding_not_invited","self_onboarding_invited","self_onboarding_started","self_onboarding_review","onboarding_completed"]},"payment_method":{"anyOf":[{"type":"string","enum":["Direct Deposit","Check"]},{"type":"null"}],"description":"The contractor's payment method."},"has_ssn":{"type":"boolean","description":"Indicates whether the contractor has an SSN in Gusto."},"department_uuid":{"type":["string","null"],"description":"The UUID of the department the contractor is under"},"department":{"type":["string","null"],"description":"The contractor's department in the company.","readOnly":true},"department_title":{"type":["string","null"],"description":"The title of the contractor's department.","readOnly":true},"dismissal_date":{"type":["string","null"],"description":"The contractor's dismissal date.","readOnly":true},"upcoming_employment":{"type":["object","null"],"description":"The contractor's upcoming employment details, if a rehire is scheduled.","readOnly":true,"properties":{"start_date":{"type":"string","description":"The start date of the upcoming employment."},"setup_status":{"type":["string","null"],"description":"The setup status of the upcoming employment."}}},"dismissal_cancellation_eligible":{"type":"boolean","description":"Whether the contractor's pending dismissal can be cancelled.","readOnly":true},"rehire_cancellation_eligible":{"type":"boolean","description":"Whether the contractor's pending rehire can be cancelled.","readOnly":true}},"x-tags":["Contractors"],"required":["uuid"],"x-examples":{"Individual Contractor":{"uuid":"c9fc1ad3-c107-4e7b-aa21-2dd4b00a7a07","company_uuid":"b7457fec-3b76-43bb-9c6e-69cca4688942","wage_type":"Hourly","start_date":"2022-01-01","is_active":true,"version":"63859768485e218ccf8a449bb60f14ed","type":"Individual","first_name":"Kory","last_name":"Gottlieb","middle_initial":"P","business_name":null,"ein":null,"has_ein":false,"has_ssn":true,"department_uuid":"56260b3d-c375-415c-b77a-75d99f717193","email":"keira.west@mckenzie.org","file_new_hire_report":true,"work_state":"FL","onboarded":true,"onboarding_status":"onboarding_completed","address":{"street_1":"621 Jast Row","street_2":"Apt. 281","city":"Coral Springs","state":"FL","zip":"33065","country":"USA"},"hourly_rate":"60.00","payment_method":"Direct Deposit","department":"Engineering","department_title":"Engineering","dismissal_date":null,"upcoming_employment":null,"dismissal_cancellation_eligible":false,"rehire_cancellation_eligible":false},"Business Contractor":{"uuid":"c7c0659c-21a6-4b4e-b74c-9252576fc68c","company_uuid":"0ec4ae6e-e436-460d-b63c-94a14503d16f","wage_type":"Fixed","start_date":"2022-01-01","is_active":true,"version":"8aab307f1e8ed788697f8986346af559","type":"Business","first_name":null,"last_name":null,"middle_initial":null,"business_name":"Labadie-Stroman","ein":"XX-XXX0001","has_ein":true,"has_ssn":false,"email":"jonatan@kerluke.info","file_new_hire_report":false,"work_state":null,"onboarded":true,"onboarding_status":"onboarding_completed","address":{"street_1":"1625 Bednar Center","street_2":"Apt. 480","city":"Port Charlotte","state":"FL","zip":"33954","country":"USA"},"hourly_rate":"0.00","payment_method":"Direct Deposit","department_uuid":null,"department":null,"department_title":null,"dismissal_date":null,"upcoming_employment":null,"dismissal_cancellation_eligible":false,"rehire_cancellation_eligible":false}},"title":"Contractor"}}}},"404":{"description":"Not Found\n\nThe requested resource does not exist. Make sure the provided UUID is valid.\n","content":{"application/json":{"schema":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided ID/UUID is valid.","type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["error_key","category"],"properties":{"error_key":{"type":"string","description":"Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error."},"category":{"type":"string","description":"Specifies the type of error. The category provides error groupings and can be used to build custom error handling in your integration."},"message":{"type":"string","description":"Provides details about the error - generally this message can be surfaced to an end user."}}}}},"x-examples":{"not_found":{"errors":[{"error_key":"request","category":"not_found","message":"The requested resource was not found."}]}},"title":"Not-Found-Error-Object"}}}}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-contractors-contractor-uuid.api.mdx b/docs/api/get-v-1-contractors-contractor-uuid.api.mdx
new file mode 100644
index 000000000..8a67f2333
--- /dev/null
+++ b/docs/api/get-v-1-contractors-contractor-uuid.api.mdx
@@ -0,0 +1,71 @@
+---
+id: get-v-1-contractors-contractor-uuid
+title: "Get a contractor"
+description: "Get a contractor."
+sidebar_label: "Get a contractor"
+hide_title: true
+hide_table_of_contents: true
+api: eJzdWutu2zgWfhUu90dbwHJsx9f8mkxvm93ZNpi0uwWSwENJRzYbidSQVFJPYKCvscDMy/VJFoekZFmWm0s7WGB/xZHIcw7P9TuHuqUaokJxs6JH57f0ucxyJlbHUQRaHxdmSY/OL9eXHRqDjhTPDZeCHtHXYAgjkRRGschI1b0QF0JHMocj8svmsT5SwOJfaId+ChaFNjLgwsBCMSQTmFUO9OicQhZCHENMO5TleX2JppcdathC47LnG7L4uKSo9A1b0COjCuhQBTqXQoOmR7d00Ovhn23Jzwp7tKRIaYeipCAMrmJ5nvLIcj34qHHpLdXREjK2S+PdEoiCXIEGYewWIpMtfZCnXMT8mscFS4lUJCw0F6D1M8IFeY1yd2mHOgVQGX6EyNAOzZXMQRnuxC8KHuNfv0obxcWCNi2Bsrx/f/ICJTBLqMtQZ4V2eCvSlVPUGo9uDT1/LBe7e4ejJpDlqVxBTMJVK98btoC5Y7bLFESRoalf8U/WHf4mC5Wu6I77vdti+0QTpEqQWocAN0tQ5MIRuaCo/gtP6YJ26bpDuZ6zyPDrugyhlCkwYU+esCI1pUvtctaGmUK3KPyGm2VdPa0KuAalufOvu3UeFUqBMMRvKnk6j+mSMwD7/7l/z8WCLAoew+XTpTG5Pjo4iGWkuzZSupHMDspYC3K2UjJN7fsDHkOWSwMiWj0jiXWdRKrMu7YgS3lDjCSFRnZck4RDGltV3mXJkyoMaIf+6KPgHgZt2HJDpjRoSeuCdgkKknClzVywrCbO+UYeUaTpXWy/fP4PHk1pQ5BOl7zDszJjFA8LA+jdCn4tuILYKunL5983cn35/EeNlCZMxOSGpykJgfCFkLVNpeiNLVafKfsup0Ay/7tDZDyOU5hzwQ1n6bedxNEinlbbcaTdzdI/7Thl8n6MXXBLS6YoSd7HPHtE+9pp9qrAnge4eOApXkEMiqXkpUvuipzEIAxPfMEkb4osBPXAczbt9t3PuWR63jjrJsu3H/bfS7AZxyfwJ/quIz99efLmGZ7GowGr34zxb/R6S4KwOFb3VN53dXqbULVhysxjZlrz+x3p224muLm1BvqD1XVUgaB762gpM6hUtIOetFEAZt5vE35HHr948FWj7UIoC5rvRX6PFndW/sbze62LZCGMug/3dcvupQVDc7VHKvjEsjzFR6Net3eHsb0pkCBBgl/NaNwliAoD4ssvn3934OzL5z+6rpKnMBdwM19yBXMFuVTmITGM8vk1JEnZgiAUx6gVC3Lj49viYhcWyI4wIuCGIEPiGNoQ2U5mKNuNVFfzhjnvjO8zXI+sFewiRheYkRRxEVkRcUXGPkpsyXxG5Yog45pMDl5eCKvra5YWVpWFhhj5CLIAAYpV9BqHs2qWIpRMYdvVDoKbKi1yDOeY+H1I2gPhdlVt1s3durvTyFtR1cqL3f0XlCCqdMe1EV+CTBZnXMxrG7hAFaVgAHvK5lsF1xxuaIdqSJP6CyHNnItrbmzz0Xy7/43Ndq1vKla1Z6VoMb1cd2jOVhkIM8/ALKW1BROrt4ltxveB6hdcQWTIC8il5pgzny8hukJy1R7ribt9+06i9uyJY1+VTa3FPdzixAUW6CquGu69ZFh/yNnZm1ozukYyOVPGnnu7/7xXraw3ohtKLb1oIWJQ2/weXZaf6DovLu7s82pnNNykDwWOds8uotoSo50v1xnXmqWN2v2I85aU9hfyIo9khk7t2v6mhh9U1J9oUpIjG3IkBsN4qjtYPBhRYPMY1wSHM3GRQrwr2C4WeBiU2aCX0gAtgllH1mCKfCe/3UvVdmtjltDOZr1l1YiJCNLUotA5pHzBw3TfIKMN2u74Uw7CZvONuSMmbFFynNo0bFGFrc9/mjje0veQZY3DwD1TwhJ64Cubauzk0CMca7INciabvZv5G41mSdRn8WEQ9XuTYAiTMGBs0A8GcTwMez02Yb0Jbc7TaDgZjiYJRMFhOBkHw8MwDGbRGILxLIrYcDydzoYDujUNK4dd28ibDnqDQdDrB70+3RpcOT+vhkl0fDgdzSbj6XA6gkF/GkXJlA2HszAc95L+0BYnz2drJFMfm9B/SIX8azMI+loak3II6W5XT0/pTm+M7u4bTPez6sESlmqoFZdyuNYoBHQ0Hox74WEcRIeTUTDsj6IgnExYMBnFs1ky6U/6s0Na9Vj0Crhi3RvQ5ocsugLxG4euVAu6D0Y6tnUYR1/9RLfQkFvSAl/ai/hWN7PpOuh40Cd/xzHMz9JijarFoMe56ZLBFA3qWgj6XGJ3fZZj0tC0ahicaLYnoIeHvfGI1pA/fX92TJtgno573R5C9ias2MUM9ZpIX4oFFwBVRmyWruaCRo1xtm4tBu7VnenLu8fXk4pdtN7MEfcE7CTqjUezKBj02TgYhkMIwskwCmaD0WA0GSfReBrtBmwPoiGDMQQwPBwHw3EvDsLxYRTMhqw/HPUO4/44aQRsOaV+VLxOGQsPe5OkD1OIJ9PpeDZJprPp+HA4ZsloNNvEazU13Y5Wp9harLoHzSh1TxthSn9iIYs5BGdGycxmZxuk9MOH4MOHD72elb6KXSd7FbreVmUIfpSCGSZ+uAKVFlfQxdnx3vjze+sB6CT8/gHYHw9G5EeIBVPkOQgDqiUMh9PeJgxPsfF7vmQqlca2Dq1xOBsN747DR4Sh90QfMLXobD4pg7IZWv+DWMQbAJ8harG4tpBl2BvuXp29kYa8koWI8cLQ3aP9WoDGxlKBloWKgMQSNBHSEPjEtemSf7IrILrw3XOu5DWPIXZtgGt/edy9EI+/z6uEIheCkG+V6+TFwbZoLTd9dVgCSnmwso1a/fMNlGJKMazP3EBWf76f6vwKcAP2aAus7e087Ko7gfFZDhFPuGv2/JntdiKjqMCp4btVziOWpit3SXQFK8L90BS0XV9NhQ5yplgGBhRRkNq5gpEbkhZbV1I/QDSkYAdLMvGUiG0yPKnSSNpLvlCyyLHm2imph5p2imIkCQuexiTCpjXz65dMxCmCUy7IShZ4T1bdVbubD9CaLe7RZpyWgvj2hrBQFqam1MDPcCp1etKllLpQCYucpEwQEDEKrmy74BBxHeTiZCNBD6871vmW/an3+Lq/HNU21g5H9wTIDXPxYTd06fqynh/eSBPYIAteItPgrfNaLy46pVXjCWbJBZjguh/UZtK13y5PYm71LuSO4ivbh8COGYLj05PgX77adqgtbktgsSsCVR7YN2EZ9AajoDcO+iPXvPkb4frzddOkL1CWDMusm0wwA0HI0JmOT0+qG1ymtYy49Xh7XWzdCBdg5HTJSUKEFOBuFFxC6bg1tYT2RJPzjAueFVmd9gMvfVnOg8298V89waD2+Fk5VETfrjS8awmr3ZyZ5QO+TthKV67i7zPLem2bNp0DuwKmVwEKEshrUIrH4NzFjq0NCG2/GkF/cE6997uTDrVzxDu/P8GDb5NyH5xU+107vFm0T8xqgxUXj1SBAie/VeARPbjuH9Qc/+C2oe+1HTOq69LvC4UgrLQ8y7kzfBBDZq2/Y5MXkEm6rVBHL7BAGPdZc+8h3ErzVMn4KzRzfI1HLr81OkNTu9TU8sVR5QDIvIxXO0wApmwEb3P3JIIUriElrDBLrDouVjBOz1baQPYtHByFPQzwixLEvEjVJzt3v3B8ekLrmL+WPToUk4V+m5yBuuYR1DS9iVtbEw7swoMYWWOWDOz/gUyshnHrzmgF0gjvxox0I1d7i+lcnJy6DGDTRiyjIiu/YPqLh08ssvDJx/qLkiv5GVIfEhvkX8n0w8YzUBu51Aa7ig2d5vdiTZlvN9Dt4d+WeVMa+GQO8pRxa3Prvbc+qM7pdd+fr5wNdehRM5FdIojXBpff3mLmfq/S9Rof/1oAVsPzSwxixZlFwOe3CKXxd1xh5r2HevqzT3bPyFdzYutZSvwnVrUsQjs+5TSPscZrBV/rHibk/3UF26Nbp8N21FCpepPfMYnkpvZup8/YyuyvX77DqrKdc6oc43/Urnq2TXx761a8k1cg1uvK4gb/t/Bq/V9ZXcgR
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Get a contractor.
+
+scope: `contractors:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-employee-benefits-employee-benefit-id.ParamsDetails.json b/docs/api/get-v-1-employee-benefits-employee-benefit-id.ParamsDetails.json
new file mode 100644
index 000000000..c6d58d248
--- /dev/null
+++ b/docs/api/get-v-1-employee-benefits-employee-benefit-id.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"employee_benefit_id","in":"path","required":true,"schema":{"type":"string"},"description":"The UUID of the employee benefit."},{"name":"X-Gusto-API-Version","in":"header","required":false,"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.","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"}}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-employee-benefits-employee-benefit-id.RequestSchema.json b/docs/api/get-v-1-employee-benefits-employee-benefit-id.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-employee-benefits-employee-benefit-id.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-employee-benefits-employee-benefit-id.StatusCodes.json b/docs/api/get-v-1-employee-benefits-employee-benefit-id.StatusCodes.json
new file mode 100644
index 000000000..91d600c42
--- /dev/null
+++ b/docs/api/get-v-1-employee-benefits-employee-benefit-id.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"Example response","content":{"application/json":{"schema":{"description":"The representation of an employee benefit.","type":"object","title":"Employee-Benefit","x-examples":{"Example":{"version":"09j3d29jqdpj92109j9j2d90dq","employee_uuid":"73274962-63ce-4e5c-b689-1df8d4df09f4","company_benefit_uuid":"54e37c27-43e6-4ae5-a5b2-e29895a133be","active":true,"uuid":"e91ca856-a915-4339-9b18-29f9cd66b031","employee_deduction":"100.00","company_contribution":"100.00","employee_deduction_annual_maximum":"200.00","company_contribution_annual_maximum":"200.00","limit_option":null,"retirement_loan_identifier":null,"deduct_as_percentage":false,"contribute_as_percentage":false,"catch_up":false,"coverage_amount":null,"deduction_reduces_taxable_income":null,"coverage_salary_multiplier":"0.00","contribution":{"type":"amount","value":"100.00"},"elective":false,"effective_date":"2025-01-01","expiration_date":null},"Tiered Example":{"version":"09j3d29jqdpj92109j9j2d90dq","employee_uuid":"73274962-63ce-4e5c-b689-1df8d4df09f4","company_benefit_uuid":"54e37c27-43e6-4ae5-a5b2-e29895a133be","active":true,"uuid":"e91ca856-a915-4339-9b18-29f9cd66b031","employee_deduction":"100.00","employee_deduction_annual_maximum":"200.00","company_contribution_annual_maximum":"200.00","limit_option":null,"deduct_as_percentage":false,"catch_up":false,"coverage_amount":null,"deduction_reduces_taxable_income":null,"coverage_salary_multiplier":"0.00","elective":true,"contribution":{"type":"tiered","value":{"tiers":[{"rate":"100.0","threshold":"2.0","threshold_delta":"2.0"},{"rate":"50.0","threshold":"5.0","threshold_delta":"3.0"}]}},"effective_date":"2025-01-01","expiration_date":null}},"allOf":[{"description":"","type":"object","title":"Employee-Benefit-Base-Object","properties":{"version":{"type":"string","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."},"active":{"type":"boolean","default":true,"description":"Whether the employee benefit is active."},"employee_deduction":{"type":"string","default":"0.00","description":"The amount to be deducted, per pay period, from the employee's pay."},"deduct_as_percentage":{"type":"boolean","default":false,"description":"Whether the employee deduction amount should be treated as a percentage to be deducted from each payroll."},"employee_deduction_annual_maximum":{"type":["string","null"],"description":"The maximum employee deduction amount per year. A null value signifies no limit."},"contribution":{"type":"object","description":"An object representing the type and value of the company contribution.","properties":{"type":{"type":"string","description":"The company contribution scheme.\n\n\"amount\": The company contributes a fixed amount per payroll. If elective is true, the contribution is matching, dollar-for-dollar.\n\n\"percentage\": The company contributes a percentage of the payroll amount per payroll period. If elective is true, the contribution is matching, dollar-for-dollar.\n\n\"tiered\": The company contribution varies according to the size of the employee deduction."},"value":{"description":"For the `amount` and `percentage` contribution types, the value of the corresponding amount or percentage.\n\nFor the `tiered` contribution type, an array of tiers.","oneOf":[{"type":"string"},{"type":"object","properties":{"tiers":{"type":"array","description":"","items":{"type":"object","description":"A single tier of a tiered matching scheme.","properties":{"rate":{"type":"string","description":"The percentage of employee deduction within this tier the company contribution will match."},"threshold":{"type":"string","description":"Specifies the upper limit (inclusive) percentage of the employee contribution that this tier applies to.\n\nUse threshold to define each tier's end point, with tiers applied cumulatively from 0% upwards.\n\nFor example:\n\nIf the first tier has a threshold of \"3\", and `rate` of \"100\", the company will match 100% of employee contributions from 0% up to and including 3% of payroll.\n\nIf the next tier has a threshold of \"5\" and a rate of \"50\", the company will match 50% of contributions from above 3% up to and including 5% of payroll."},"threshold_delta":{"type":"string","description":"The step up difference between this tier's threshold and the previous tier's threshold. In the first tier, this is equivalent to threshold."}}}}}}]}}},"elective":{"type":"boolean","description":"Whether the company contribution is elective (aka matching). For \"tiered\" contribution types, this is always true.","default":false},"company_contribution_annual_maximum":{"type":["string","null"],"description":"The maximum company contribution amount per year. A null value signifies no limit."},"limit_option":{"type":["string","null"],"description":"Some benefits require additional information to determine their limit.\n\n`Family` and `Individual` are applicable to HSA benefit.\n\n`Joint Filing or Single` and `Married and Filing Separately` are applicable to Dependent Care FSA benefit."},"catch_up":{"type":["boolean","null"],"default":false,"description":"Whether the employee should use a benefit's \"catch up\" rate. Only Roth 401k and 401k benefits use this value for employees over 50."},"retirement_loan_identifier":{"type":"string","description":"Identifier for a 401(k) loan assigned by the 401(k) provider"},"coverage_amount":{"type":["string","null"],"description":"The amount that the employee is insured for. Note: company contribution cannot be present if coverage amount is set."},"deduction_reduces_taxable_income":{"type":["string","null"],"default":"unset","enum":["unset","reduces_taxable_income","does_not_reduce_taxable_income"],"description":"Whether the employee deduction reduces taxable income or not. Only valid for Group Term Life benefits. Note: when the value is not \"unset\", coverage amount and coverage salary multiplier are ignored."},"coverage_salary_multiplier":{"type":["string","null"],"default":"0.00","description":"The coverage amount as a multiple of the employee's salary. Only applicable for Group Term Life benefits. Note: cannot be set if coverage amount is also set."},"company_contribution":{"type":"string","default":"0.00","description":"The amount to be paid, per pay period, by the company. This field will not appear for tiered contribution types.","deprecated":true},"contribute_as_percentage":{"type":"boolean","default":false,"description":"Whether the company_contribution value should be treated as a percentage to be added to each payroll. This field will not appear for tiered contribution types.","deprecated":true},"effective_date":{"type":"string","format":"date","description":"The date the employee benefit will start."},"expiration_date":{"type":["string","null"],"format":"date","description":"The date the employee benefit will expire. A null value indicates the benefit will not expire."}}},{"type":"object","properties":{"employee_uuid":{"type":"string","description":"The UUID of the employee to which the benefit belongs.","readOnly":true},"company_benefit_uuid":{"type":"string","description":"The UUID of the company benefit.","readOnly":true},"uuid":{"type":"string","description":"The UUID of the employee benefit.","readOnly":true}}}],"required":["uuid"]},"examples":{"Example":{"value":{"version":"09j3d29jqdpj92109j9j2d90dq","employee_uuid":908123091820398,"company_benefit_uuid":"54e37c27-43e6-4ae5-a5b2-e29895a133be","active":true,"uuid":"e91ca856-a915-4339-9b18-29f9cd66b031","employee_deduction":"100.00","employee_deduction_annual_maximum":"200.00","company_contribution_annual_maximum":"200.00","limit_option":null,"deduct_as_percentage":false,"catch_up":false,"coverage_amount":null,"deduction_reduces_taxable_income":null,"coverage_salary_multiplier":"0.00","contribution":{"type":"amount","value":"100.00"}}},"Tiered example":{"value":{"version":"string","employee_uuid":"8f9f3f68-8fd3-499d-ade7-4a052e56494e","company_benefit_uuid":"54e37c27-43e6-4ae5-a5b2-e29895a133be","active":true,"uuid":"e91ca856-a915-4339-9b18-29f9cd66b031","employee_deduction":"0.00","deduct_as_percentage":false,"employee_deduction_annual_maximum":"string","contribution":{"type":"tiered","value":{"tiers":[{"rate":"5.0","threshold":"2.0","threshold_delta":"2.0"},{"rate":"3.0","threshold":"5.0","threshold_delta":"3.0"}]}},"elective":false,"company_contribution_annual_maximum":"string","limit_option":"string","catch_up":false,"coverage_amount":"string","deduction_reduces_taxable_income":"unset","coverage_salary_multiplier":"0.00"}}}}}},"404":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided UUID is valid.\n"}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-employee-benefits-employee-benefit-id.api.mdx b/docs/api/get-v-1-employee-benefits-employee-benefit-id.api.mdx
new file mode 100644
index 000000000..697e6cf87
--- /dev/null
+++ b/docs/api/get-v-1-employee-benefits-employee-benefit-id.api.mdx
@@ -0,0 +1,73 @@
+---
+id: get-v-1-employee-benefits-employee-benefit-id
+title: "Get an employee benefit"
+description: "Employee benefits represent an employee enrolled in a particular company benefit. It includes information specific to that employee’s enrollment."
+sidebar_label: "Get an employee benefit"
+hide_title: true
+hide_table_of_contents: true
+api: eJztWutuG7kVfhV2ioUTQCPr6lj6VW9zWRfdTbBO2gK2IVPDMxKTGXJCcmSrhoC+Rl+vT1IcknORZiRfsmgX7eZP5Bny8OPhd66c++AuXOTayJALAwtFDZciNOsMgullAOkcGAMWdAKaZfUhOrjuBIYuNA57k2aJXAOQ70FAzI19qUBnUmjQwfQ+GPR6+B8DHSmeoYBgGry5o2mWAClGBp0gksKAMDiWZlnCI7vY8WeNE+4DHS0hpU1JH5coJVOgQRg7hciYUEGgQDZ3yLpBJ3CbC+T8M0QG/+YmwQfFLkK/i6AT3IXgMNpNeLz4cwVKu6V7k89DNph8/sqyz5NBvzf5PPk8YJMe+xp0gmL5WZ5zFkyDV8PBq9HkZBCeDCMIRzCOwvnJ6STss/iUjVjcm8Qjq4U0o2I986CL2eMRDF9Fg1fhaAgn4YjCOKTj+SCEweR0Mqb94XCOOqSR4SsIpkbl0An8XJj0I3o6PgnppD8OR8PhJJzM+6fhYBJPInZyMu8N+3XADFgeee32e71ur1fDhaek+Dzffd+cPaNC5DSZpfSOp3kaTJEJ+4UdGJ7wlJuZ9Ccu8iRBihmuIAVhZomkYsYZCMNjDqoY4YDMqJ5loCIkxwKCaUwTDY5sdmXYN4CaaDnLs9qMFSi6gBlNZY40ra+C+BX+Aj0z9I7OE5hxEckUinHldE0TqtazNE8MzxKLNyjVUtftfcFWv2AnWNEkh0rpm04ACfgT9yghjt2TGaMGrBIH47DXD3v2iO8y7mzYv0Zsm07wkYMCRv7vSf6fJvFhiv4XGFjxySl3DyON5UvFyHv7BOPBfaAc76xO0cMuFeilTPCMBttPZgwSQ/3zTaecOm7OHO+ZOcSZ15vN84i/6QQ0Sd7HFvd2VHlCrAi/pxrC98WwTMkMlOEubpR2VOpOG8XFIui0hLEoVwqEIX4SxjGzBOIQdMkFgP370r/nYkEWOWdw/WJpTKanx8dMRrprY3o3kulxEcPDjK6VTBL7/pgzSDNpQETrlySWinARS5X62CnIUt4SI0mucTmuScwhYV10N4XllZuZS5kAFXY3Mc0TUxBne3N/XYJZgrLod8My4Zo4uXaJNgNt051frSBuU5nOSHAjcyBOGLAOyUCRjK7xfy5Zh8RKplu4jjS+t1jazfPQ5r2lPmL35fYKoHop84QhWKOAGmCEakJJtfLOVhxyoNGS+NPdo7+GTyo2cFnpE80BE7emGv2sA8BRo2ugqkvOCMoh1ikQzRcC47EmQhLr/Cy+PR6ltLJtBGfCs79K8ZD1qEmcSKhgfjlvK94pk/oy3YZVukUfZZIt8ohNRaF7Ja7ElY/OV8GUtI4HPMSY3+F5VvoqToycx6TwuWgI1nj8RmoLck1SjAZcLDqEySShKoylCt1PD6RiymEwNUZ5pXk0LQC9mfyiOF3w2IsR5ayoQuLQKJKK2QOXdjHN/16CbhLS8quMSNtn+VY6+7txe7yxzLmpVHGzDQCJod0Gd+ilXMViUXl9SVXTqd1kuZrba4vwDlYoVCm6tqIxeiJNpQAfjrapidFx11J2KO0CcJU0ouwGpYNOwA2k+hGWRzQXiwQsNltREbeZ8oQLM2hAcWH8Mda1TcUWF3PLzZILF4YskH02Tm55kjholga15OEhIBcZRM5RofA8Q/pbf0VecBElueYreNliNSXc7cNdUlPDaytZFC0tMT7ZmOqhIasZxFyAc+M44UgTEIxkkgvTsdt35PCCGInyNE8o2mGydiGg9x3Js1uqmC655yvXKf597tDGXGnjMC1tYKlgyJhcBcOroOOMAo/vxj3s93r4uK70Ss+k3+t9t3VudUXoGjjcKIq26rSWM7QTCy9Ygyng7hDK8VVgJVGCKP2zQxjHDmILMjqXK0AgbfjGW/i2CFXkno/htzaQoXzG4xgUiAizHnMLUKP0ka5tElFYj6xgxWXeHNEl52LnPDtOFtcEvuZ8RRNwaU81J9jYf9ebzVbJ2JrI7EtcWo0O1yyiwgv6hZa+4WWXIA8rZ7/HvTrcNLmlaxdUuo1savPISutZWU3rrp6V12yXd48GcyHTMhPWROEJKiCUMY4DaLKVm1t/YUCl6DLMErh3VNaAbt7SlCdrH9nOBeMrznKa3BCKEl1HbZ7YNPKHi7OyK2bn/gn9DXnLEyS/VOTC+n4v60eqFLoe/MMPuYCMogXa9RriX0MGAvsx5I/48m1tNZsCloVtpaaKgpWenpxT+xQaCxdarHikyZVbkeTZVWD9Rpe8F8ma/CzNkox6/S92Z/ZHeRJl8eMOHaukYhlNsJAm457dzKE+1EMu4rwcaxegiOHFl5cEBRGqkWnAyHxtd+nfZUquOAPlcumdhsCTbKAokFzAqqkRjVLoHGN9LFWX/CQNTNtNJaJCSINlic/OCUdn62AVK3BNNJhaRXWoV3FwC0XRlwsNmLKAQMu/LP/eI7QTMAl6JqTxy+4OaOjngZLNr0O8GOLEoOEIaTy7VjThVoHknZJ5Rj6CSsmfeVyZe6HZ2yWIWqrJ0bMYcuV2hbFtV6FI1/KZ6+aQqptjDZIvhFTAuls0aWn8PErde2vsBjAM2V58I0860h6rV1DNZzxGSxXVNOyjGU20LLnW3rH+9l5CRnlLH8FbqV+0Sz6WnROXjiB2mmVAna37XLoZFV0AzBRE2ANw7ZTNoX71N7Uj2nRUxLlH9iMoNpjw91Yr4pfe/257r3mMLkwG08AOaDtFfNHegrIItaHKMafRLTxgJd+8rF0MdpIMLhjef/maZGs8KtLPwbzuwcJwp0X/mLT106fz140qx0hyu+RYptQQzSGRYmEPTQFlaNc1yrY1+Z+6fhF2apd4jZW+cWf7RW829jLTJmXMBhpc6dpSpP1usOg+PO/+ZNI77Q+GvUn/dNAbTk5/uyj51V6UPPWqblPdssFBupTk3b1aO40n8TA+OQ1PYzYMR5MJCymDV+GI9sYDGJ+MJiP49V2tlSH1wPk9hkylWp5/IzV+7n3U8DnXUbsXs48zgnKb20ZQ2/6DXK+7v4f4XibOD1PetRA6wag3anZXf5KGvJW5YORKEHIl3DcZX3PQmDco0DJXERDMwn384tp0yY/0CxAsNHzPw1Y2zDlpV3px1r0SAa6LIc2G5HM8gAWYcNUPS+YUyWLjyYyzRiB4s+P4dXW5sPXdCAhMZQD7Qpj4UGV4lCdUNWISOTe+dwR6q2DXrrUYuXYMNaXsf/3jn9rLx9LRFuHFBzQ2KaLcXu99+OHcpvPSVhRcc19h1z6Q0b5LiO3mhj6mGNCm2ZLfEB3JzHWn7a/pvtE3mEFQRVPsNDgDEtSSpV23HFWaUbMM6qHSOZDqm53ddvaTYzPao8fxt/Cd/Wrp7MN5+BfvOD2OJVCsjetIWnPg10UbxSVYmKKFc6qBkbMP5+X9K9VaRtzmvlbHa5krOyCi/u5GSGELtoK7HTemdjxHmlymXNhuU032E69sacbD6tb3915gWHv8EmHkGku+/XqvKmZ3O34S9sfbpV7tuU1+7kKdAf0CVK9DVH+IjkJxhkIVGMVhBcH2sAUWcjW6lB+GYdZkQGj7CRny6gusg+n+j9BKZ/7Ax2hIjULUPrRVRC5Rt09z6KvhjV2gVlIwS+n9kDUXswymwfGqf9ywqeP7FrPZ4BmBWhUGlqsEyesZQTPuCBEySC0rGi7sNaRyR+1OXmgjNs6z+9sjuFXmByXZAZkZvsbNa4hyxc3aIv+jc4VnUQRan+Woh8vr+qgLe0lk8+SWsSVBEWJBXFvMAlXWkLcxehFhAitICM3NEjtoztLQq1ystYH0W1ZwEvYssEE3E0uXXrivQawrQstGzpRZXM2MOgG6Gv0+vgC14hHUzqOyejqXuTm2A48ZLo3hLrR/hzK254BTG6U8JLbxZCSxOI40eeMthXzwN7jodJiM8rT4PPJ3Pouike0Yeqf6uliV/AyJtyxMzShPLKH82z9U/EFtZFKblIqanHdg2j6+3IV+X33u+Vs8fjAeF0ku3JnjLKHcct3a9r13PpfBaisHn1dOd9oWt687wVJqgxPv7zHyfVLJZoOPv+ag0Lav0Qcqjvmi+z6Ka/y9J6LWz/PFzz74viSPqblbN1fUU2Jd88VBxzvsth1tsCz38f9peP/Hk4FW/To9tmdSpbqrCIkeNavXtY0vtLfC4rs3H4PN5t/FakJl
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Employee benefits represent an employee enrolled in a particular company benefit. It includes information specific to that employee’s enrollment.
+
+Benefits containing PHI are only visible to applications with the `employee_benefits:read:phi` scope.
+
+scope: `employee_benefits:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-employee-form-pdf.ParamsDetails.json b/docs/api/get-v-1-employee-form-pdf.ParamsDetails.json
new file mode 100644
index 000000000..ace3132c7
--- /dev/null
+++ b/docs/api/get-v-1-employee-form-pdf.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"employee_id","in":"path","required":true,"schema":{"type":"string"},"description":"The UUID of the employee"},{"name":"form_id","in":"path","required":true,"schema":{"type":"string"},"description":"The UUID of the form"},{"name":"X-Gusto-API-Version","in":"header","required":false,"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.","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"}}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-employee-form-pdf.RequestSchema.json b/docs/api/get-v-1-employee-form-pdf.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-employee-form-pdf.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-employee-form-pdf.StatusCodes.json b/docs/api/get-v-1-employee-form-pdf.StatusCodes.json
new file mode 100644
index 000000000..860e6309e
--- /dev/null
+++ b/docs/api/get-v-1-employee-form-pdf.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"Example response","content":{"application/json":{"schema":{"title":"Form Pdf","type":"object","properties":{"uuid":{"type":"string","description":"the UUID of the form","readOnly":true},"document_url":{"type":["string","null"],"description":"the URL of the form"},"document_content_type":{"type":["string","null"],"description":"The content type of the associated document. Most forms are PDFs with a content type of `application/pdf`. Some tax file packages will be zip files (containing PDFs) with a content type of `application/zip`. This attribute will be `null` when the document has not been prepared.","readOnly":true,"title":"Form-Document-Content-Type-Type"}},"required":["uuid"]},"examples":{"Example":{"value":{"uuid":"48cdd5ec-a4dd-4840-a424-ad79f38d8408","document_url":"https://app.gusto-demo.com/assets/forms/7757842065202782/original/company_direct_deposit20211007-48226-gsqo8k.pdf?1633667020","document_content_type":"application/pdf"}}}}}},"404":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided UUID is valid.\n"}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-employee-form-pdf.api.mdx b/docs/api/get-v-1-employee-form-pdf.api.mdx
new file mode 100644
index 000000000..94b43851f
--- /dev/null
+++ b/docs/api/get-v-1-employee-form-pdf.api.mdx
@@ -0,0 +1,71 @@
+---
+id: get-v-1-employee-form-pdf
+title: "Get the employee form pdf"
+description: "Get the link to the employee form PDF"
+sidebar_label: "Get the employee form pdf"
+hide_title: true
+hide_table_of_contents: true
+api: eJzdV99v2zYQ/lc47qEtIFqO6ySeXragSYoA2xo06TbAMRJaPNtsJJIlKTeuof99OFKKZSceuq17WR4cW+T9/u7u05o+sHnlvGZSeZhb7qVWzK8M0GxMoZyCECDoJKGezx0+OytNoVcA5Fzb0uGJNhDlLgTN6Bw8Wx4waK6xmbYlM2JGE2q45SV4sKhoTRUvgWa0vXkrBU2oVDSjhvsFTaiFT5W0IGjmbQUJdfkCSk6zNY0OUuetVHNaJ1SAy6006AXN6PUCyIcPF6dEz4hfAGlN0Dp5NIt+/YcmUX3X3B/sbUjzyeUF+w2sQ6nG9AK4ALtlfMYLB7smTjF1pVTgggXBPbApdyDIyeUFWUalhDunc8k9CPJZ+gVZ6cqGCzkvih65mBGlFRDpiLF6KQWIJN7hxhQyD4V84ci4lEqWVdnVPXm58N64LE2Fzl0v4KaX6zJtccIMX1ldFOE85UayRlKq+feNQtZ5/ArdqByIHt2f6oSCqkqE3qA/OGT9I3ZwiLATMONV4WnWfV7Xk920vQUf8lVIdU+83gJEKBO5PD2/UTfK5dpARu4eAYmHLrPAxV2ojjNaOXDo4qDfx3/bls4eeGkKIO1NmtBcKw/K491OftOPDgXW3ZilLzDo8+BQaJcmDXr6EXKP7WOx07yMHlSVFM8la9sl/xwsMRYu3qliFWGOYNZ5VYLyt5UtNlrHG7WqKgr6JLdB/fufd0C/0daEfxvVfbVabKZGlKBIq7+D7dZEj/yinQ+WHeEWsJguIp8/0XHXrYERs7seudIlEM8fyEwWQAzP7/kcUEFRkCmQL9KEE0deojIuEcrBxquvMvJFmrseuV5IR7j3Vk4rD4/K7zD6O/J5ASp2dBMTWXBHlPZkCqCIsWC4jT2yXbdkCzXstBFnb6JH7HplIHzQuu5Ol3EEz6ROKETIBkQ18MWvS15UsEEZHY5yIQ4hZ3woBBuOhn3Gh4Mh4+L4h9nrkRgN+yO6iyLaTgtuTBwWTEAZJwZ3DrxLQ9nS4+PD49Fw0D86HPQHx6NBqq2cS8WLNNel4Wp1K6SF3N8KMNpJP+gPDg76/WM2HA0GR2zuPunRfc+I2Y8HR69fHx0d9wd9uheFdAcEtA5/CR32h097+lftybmulCA3ipAbhdDETIJDFFpwurI5lg5iyeBBOgQlvwfiKguhsO2kja0oHVnyQorejQqFeWDOAL8H7lZsbnVlOksxLtntO7hRmF6CtVJA3LhxYMCDB4VzNe7Xe1jRbP9+T9oqd/c8bqxWbterR4Ed756X2fZyI9t4i3O6BL/QDWcI9MAvaEbT5UHaGnDpukMP6gYv62Z312nkFQ7ssiUVu8iTO8h7MiFPodQ7CY76WEA+yoUI9yh+Vuel1eIvdBo8xgQ4yCsr/Sp4/iZi/STPwbmTCnMxnnRvXeGyiK36zN3HTYAutusUf0+B20Avtn1sVLACllAQXvkFKN+0Bc7wq5XzUP4bC1HDHgM1kp+Z7q6+QJCQbyBaGoq0tdwTigTIvZtdgV3KHDr12HARPtWVT8PFVKBpXJos/GZ6FuqAorvO/g5FHlaBJsGPF46cNV1BLiOrCVSoHSohjO+aDc/zsOEbqnfaWiXvoQj3sIOh5LIIgGpOf9rgB7NhtPMlVx09LXHZJisR8lvOrzc045uxnabUHh58agouAyYachAbdUyXByGuplVpQrNtLj9rhle24dro/SShC+08alivkcB+sEVd4+NPFVhshgmOCyv5FHExXlMhHX7fQ4y74b9832y5V2TvS8Ce4NrtoFadaUWTZrR1I8Nx8E1catjYP3CnzWiNS7x5gfh7mfqfv008m9OYu+dfxR5TvFlnOPyM75w9ofBbW+zt2TWt6z8BPPBPUw==
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Get the link to the employee form PDF
+
+scope: `employee_forms:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-employee-form.ParamsDetails.json b/docs/api/get-v-1-employee-form.ParamsDetails.json
new file mode 100644
index 000000000..ace3132c7
--- /dev/null
+++ b/docs/api/get-v-1-employee-form.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"employee_id","in":"path","required":true,"schema":{"type":"string"},"description":"The UUID of the employee"},{"name":"form_id","in":"path","required":true,"schema":{"type":"string"},"description":"The UUID of the form"},{"name":"X-Gusto-API-Version","in":"header","required":false,"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.","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"}}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-employee-form.RequestSchema.json b/docs/api/get-v-1-employee-form.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-employee-form.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-employee-form.StatusCodes.json b/docs/api/get-v-1-employee-form.StatusCodes.json
new file mode 100644
index 000000000..2491346dd
--- /dev/null
+++ b/docs/api/get-v-1-employee-form.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"Example response","content":{"application/json":{"schema":{"title":"Form","type":"object","properties":{"uuid":{"type":"string","description":"The UUID of the form","readOnly":true},"name":{"type":"string","description":"The type identifier of the form","readOnly":true},"title":{"type":"string","description":"The title of the form","readOnly":true},"description":{"type":"string","description":"The description of the form","readOnly":true},"draft":{"type":"boolean","description":"If the form is in a draft state. E.g. End of year tax forms may be provided in a draft state prior to being finalized.","readOnly":true},"year":{"type":["integer","null"],"description":"The year of this form. For some forms, e.g. tax forms, this is the year which the form represents. A W2 for January - December 2022 would be delivered in January 2023 and have a year value of 2022. This value is nullable and will not be present on all forms.","readOnly":true},"quarter":{"type":["integer","null"],"description":"The quarter of this form. For some forms, e.g. tax forms, this is the calendar quarter which this form represents. An Employer's Quarterly Federal Tax Return (Form 941) for April, May, June 2022 would have a quarter value of 2 (and a year value of 2022). This value is nullable and will not be present on all forms.","readOnly":true},"requires_signing":{"type":"boolean","description":"A boolean flag that indicates whether the form needs signing or not. Note that this value will change after the form is signed.","readOnly":true},"document_content_type":{"type":["string","null"],"description":"The content type of the associated document. Most forms are PDFs with a content type of `application/pdf`. Some tax file packages will be zip files (containing PDFs) with a content type of `application/zip`. This attribute will be `null` when the document has not been prepared.","readOnly":true,"title":"Form-Document-Content-Type-Type"}},"x-examples":{"Example":{"uuid":"48cdd5ec-a4dd-4840-a424-ad79f38d8408","name":"company_direct_deposit","title":"Direct Deposit Authorization","description":"We need you to sign paperwork to authorize us to debit and credit your bank account and file and pay your taxes.","draft":false,"year":null,"quarter":null,"requires_signing":true,"document_content_type":"application/pdf"}},"x-tags":["Forms"],"required":["uuid"]},"examples":{"Example":{"value":{"uuid":"48cdd5ec-a4dd-4840-a424-ad79f38d8408","name":"company_direct_deposit","title":"Direct Deposit Authorization","description":"We need you to sign paperwork to authorize us to debit and credit your bank account and file and pay your taxes.","draft":false,"quarter":null,"year":null,"document_content_type":"application/pdf","requires_signing":true}}}}}},"404":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided UUID is valid.\n"}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-employee-form.api.mdx b/docs/api/get-v-1-employee-form.api.mdx
new file mode 100644
index 000000000..628a16d7e
--- /dev/null
+++ b/docs/api/get-v-1-employee-form.api.mdx
@@ -0,0 +1,71 @@
+---
+id: get-v-1-employee-form
+title: "Get an employee form"
+description: "Get an employee form"
+sidebar_label: "Get an employee form"
+hide_title: true
+hide_table_of_contents: true
+api: eJztWFtvG7kV/iun7EMcYEayvUrr1VONtR14gd11E6dbwDbso+GRxPUMOSE5shVB/704JEcaWVLjdLcvRfPg2MNzv/LjQjznk8Z5kyvtaWLRK6NzP69JDG8EVSOSkqS4y4THieNv51VdmjkRXBhbOT4xNUW+SymGYkI+nx3llMjysbGVyESNFivyZFnIQmisSAxFS3WvpMiE0mIoavRTkQlLnxtlSYqhtw1lwhVTqlAMFyIaJ5y3Sk/EMhOSXGFVzRaIobieEnz6dHkGZgx+StCqEMtspZZt+i+qDC531P0zfx9CfHp1mf+DrGOupHpKKMluKB9j6eilijMOXaU0uaBBoqd8hI4knF5dwiwKBXTOFAo9SXhSfgpz09hAUGBZ9uByDNpoAuWgtmamJMks0mBdl6oISXzj4KZSWlVN1ZV9dzD1vnbDfl+awvVCzfQKU/XbGslrnFtTluG8j7XKE6fSkz8ngXnn81s2o3Eke2J/qDNBuqm47I4Pj9/lh3/Jj95xyUkaY1N6Mex+Xy7vXobtPXlAvaqBkJlbfatdYWoawsOq/vjADS2hfAjJcLXRjhxbdHx4yP9tCj5/xqouCVpKkYnCaE/aM20nnP3fHDMsui4qX7KPF7Ezksdm9BsVnjvFckN5FbU3jZK74vKKCmQ/UP6iy3ms6GWWCvI10pgClCTt1ViR/Zrg5NOrJDPp1+RtsL1GaufLV2VbHPuO1JExJaHeEnu5FsO1qjQgBF5wHj314Lw36cG5lqxwTmjB43Mgd1DhHEa0arMtZqitMha8gREpPYGx0liqL7Ebtixm4WuDb0SY1WFs6KYsxVbZc0CCQSESygWjejyxwZkquuQyILZ/ZXMWSVWcMIH9aaqK6ToIlmpLjrR3PTiFX4/5K/yIukE7hxzOqOBhYOH48PgYnkxTSo6BpFLNyMYgtNTHh8ffAWoJU5wRYFQ3w7IJlcECenDN5sRvygF7iqOSAteTKkvQxscYB5uA519ZRl92RvFzg9bTNwcysf2OWBZYkpZoV6LauCZpm4HVkFasfePg75GjnMMFSbJYwjU+wwfyjdVwwBMEvh8cvQ2ZOK2tKjP4CecZ/Nho6uYhhbk1YB1pOOB47krA2z8+A2nJuXunJrwXXtGEp5BOYFziBPwUPSgtebqSg6cp+SnZdYlqIukgiQdj2cQe/Gw8RVa/9ih4UExRTwhw7LtSVBSxpxulKZqKtL9PE/8+urCuqtWY2l9UiTWO2TSvOtu7VdGDn4zzaaagJbg6u3Bxt+OWjIfu2qnl+KEHH7lCQ1WqkqDG4hEnHDZ2fUTwRdXhxMEBC0MVosY63r5KyRdVP6QqQe+tGjWeVsIf2PsHTpGOd5bkE0zRpcohzbVTo90V6WxjUeZniT3/IVqUX89rCj/EcpmJ55ziSg5bM63n9QIVg5NCyndU5DiQMh+cDA5zHBwPcpR//X783Yk8GRyeiHZBisJUNer5vVSWCn8vqTZO8XJuTToLB3AWD+C08VNj1ZcQlq0a/pVCXfJViyc+lxbUWJN9MvaRv2BiJ2gc/y1ppHxos8KSVD5e0kaoHwGLwjQ6Hoak8i81ziOJx2cKrZd2XLpLxv3B+ehMwfjndkvG2O8pcvGixlLsW3CwwgTr6+xNzMDdMhN7MhTa8f+piql6kZ5u5l6bkn1JXYZ/mRgcDrYvtD8bDxem0RJuNcCt5iHFYsjxPLLkTGMLbmKKzUvPyvF4wkcC11gKLb667oS7aJy0SvZudSoTVxM+Erp5PrGmqTsAMBbOJg0nODczslZJisiSAcGzJ80AIgLJR5qL4X4Qm7XV1QWzDM1avpcmrRhemLabZ9PENS+bymikIj81cmV7AJpD0Z8d9Vvprr/ogOBlP4z6/iIh1CVjI7KzFjY3tmTQmJAY1ioCsVxSFdDYVj2fUWVehDXKy0OrMV9wbY/gnTKvrJH/RmbNx+y8o6Kxys+D5T/ENj0tCnKOe1AMb+66VB8ZH8XZsIN2dU9gE1vAGO4NhDZc4DZtTCLykmZUhqZlJBObhAH8x7nzVP0eDVHCHgVLhvdj00V74QmAETWXSXoE2ICvmWCI734ZfyQ7UwV18rFG2zgyje8Hwr5k1YwV8/B3bsYhD8y6PdbKIlwFDAQ73jg4T+0AVxG3B7Dfjpjgxp8SqMUioKU0b89arfCBykDHfUsVqjIUVDr927p+OBq1cb5C3ZGzC5q/tHuxBtX/KZRPSfX07Pt1iSpkP1T7IrXjjZgdBQ9SQ4pMDDffpcZpOA3bd6O7TEyN88y7WPAzzCdbLpf8+XNDlgv+jmeBVXxdDuUvlePf9zzvdP08+JBW51vY+5S1x612H+h5ZxSJLM2trk/c8n+ISeONN4xvMaeN5ZJvBukZ7Nsi9T/+JrYzpjF2ux8UVyFe7yoecLXvnG29TG1sqffn12K5/Beyxq7m
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Get an employee form
+
+scope: `employee_forms:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-employee-forms.ParamsDetails.json b/docs/api/get-v-1-employee-forms.ParamsDetails.json
new file mode 100644
index 000000000..230d65c22
--- /dev/null
+++ b/docs/api/get-v-1-employee-forms.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"employee_id","in":"path","required":true,"schema":{"type":"string"},"description":"The UUID of the employee"},{"name":"X-Gusto-API-Version","in":"header","required":false,"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.","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"}}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-employee-forms.RequestSchema.json b/docs/api/get-v-1-employee-forms.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-employee-forms.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-employee-forms.StatusCodes.json b/docs/api/get-v-1-employee-forms.StatusCodes.json
new file mode 100644
index 000000000..88b2ad1b2
--- /dev/null
+++ b/docs/api/get-v-1-employee-forms.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"Example response","content":{"application/json":{"schema":{"type":"array","items":{"title":"Form","type":"object","properties":{"uuid":{"type":"string","description":"The UUID of the form","readOnly":true},"name":{"type":"string","description":"The type identifier of the form","readOnly":true},"title":{"type":"string","description":"The title of the form","readOnly":true},"description":{"type":"string","description":"The description of the form","readOnly":true},"draft":{"type":"boolean","description":"If the form is in a draft state. E.g. End of year tax forms may be provided in a draft state prior to being finalized.","readOnly":true},"year":{"type":["integer","null"],"description":"The year of this form. For some forms, e.g. tax forms, this is the year which the form represents. A W2 for January - December 2022 would be delivered in January 2023 and have a year value of 2022. This value is nullable and will not be present on all forms.","readOnly":true},"quarter":{"type":["integer","null"],"description":"The quarter of this form. For some forms, e.g. tax forms, this is the calendar quarter which this form represents. An Employer's Quarterly Federal Tax Return (Form 941) for April, May, June 2022 would have a quarter value of 2 (and a year value of 2022). This value is nullable and will not be present on all forms.","readOnly":true},"requires_signing":{"type":"boolean","description":"A boolean flag that indicates whether the form needs signing or not. Note that this value will change after the form is signed.","readOnly":true},"document_content_type":{"type":["string","null"],"description":"The content type of the associated document. Most forms are PDFs with a content type of `application/pdf`. Some tax file packages will be zip files (containing PDFs) with a content type of `application/zip`. This attribute will be `null` when the document has not been prepared.","readOnly":true,"title":"Form-Document-Content-Type-Type"}},"x-examples":{"Example":{"uuid":"48cdd5ec-a4dd-4840-a424-ad79f38d8408","name":"company_direct_deposit","title":"Direct Deposit Authorization","description":"We need you to sign paperwork to authorize us to debit and credit your bank account and file and pay your taxes.","draft":false,"year":null,"quarter":null,"requires_signing":true,"document_content_type":"application/pdf"}},"x-tags":["Forms"],"required":["uuid"]}},"examples":{"Example":{"value":[{"uuid":"48cdd5ec-a4dd-4840-a424-ad79f38d8408","name":"company_direct_deposit","title":"Direct Deposit Authorization","description":"We need you to sign paperwork to authorize us to debit and credit your bank account and file and pay your taxes.","draft":false,"quarter":null,"year":null,"document_content_type":"application/pdf","requires_signing":true}]}}}}},"404":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided UUID is valid.\n"}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-employee-forms.api.mdx b/docs/api/get-v-1-employee-forms.api.mdx
new file mode 100644
index 000000000..f5518e9a4
--- /dev/null
+++ b/docs/api/get-v-1-employee-forms.api.mdx
@@ -0,0 +1,71 @@
+---
+id: get-v-1-employee-forms
+title: "Get all employee forms"
+description: "Get a list of all employee's forms"
+sidebar_label: "Get all employee forms"
+hide_title: true
+hide_table_of_contents: true
+api: eJztWFtTI7cS/isdnYeFqhkbHG8O8VOoAFukKgnZZZNUAQXyqO1R0EizksYwS/m/p1rS2GOMs6SSp1NnH1gYdbf68vVNT+wxnzfOm1xqj3PLvTQ6922NbHLFsJqiECjYTcY8nzv6dlrVyrSIcGZs5ejE1Bj5zgWbsDn6fHGYYyLLZ4EsYzW3vEKPlqQ8Mc0rZBPWkd1KwTImNZuwmvuSZczip0ZaFGzibYMZc0WJFWeTJxa1Y85bqedsmTGBrrCyJhXYhF2WCB8/np+AmYEvEbor2DJbXft7/i4YfXxxnv+K1hFnur5ELtBuKDDjyuHza07IlkpqdOEWwT3mU+5QwPHFOSyiUODOmUJyjwIepC+hNY0NBAVXagDnM9BGI0gHtTULKVBkkYbXtZJFcOsbB1eV1LJqqr7sm73S+9pNhkNhCjcIURwUphp2Uctr3lqjVDgf8lrmiVPq+X+SwLz3eZ/UaByKAdvt7oyhbioCwuhg9DY/+CY/fEsgEDjjjfJs0v++XN48d9s79MBBSecpPlypVXzeOAhYudbX2hWmxgncreARTiYWubgLoXG10Q4d6Tc6OKD/Nq85feRVrRA6SpaxwmiP2hNtz7nDPxwxPG0bzK3lLaHCYxUu8tIrOiDgs6wjM9M/sPAEcEuJ4GXUqmmkeMl7f43VWRRNdv6sVRuxv8wSbF8jjShACtReziTaLwlONr1KMpF+Sd4G22uk9r58UbblM9+TOjVGIddbYs/XYgjRUgOHwAvOc48DOB3MB3CqBV3YIrfg+WPEHlS8hSmuknGLGWorjQVvYIpSz2EmNVfyc8yZLY1J+FrhKxZqbCguulGKbSUHOSQoFDwhY0IMqNKCM1U0yWWApP9K5yySyliHAvtDKYty7QSLtUWH2rsBHMNvI/oKP3DdcNtCDidYUMmwMDoYjeDBNEqQDwQquUAbndBRjw5GXwPXAkq+QODxugVXTUAGCRjAJakTv0kHZCmfKgxcD1Ip0MZHHwedgKqkUtGWF734qeHW4992ZGL7B74suEItuF2J6vyapG06VkNqjfaNg18ih2rhDAVaruCSP8J79I3VsEcVBL4dH+6HSBzXVqoMfuRtBj80GvtxSG7uFFh7GvbIny8FYP/fj0Bqhe7WyTl1j1ck4TGkE5gpPgdfcg9SC6q66OChRF+iXUNUIwoHSTwYSyoO4CfjMbL6tUXBgqLkeo7AZ74vRUYRO7JRmKKpUPvb1AluowlrVK3K1G5QJdZYZlO96vX47ooB/GicTzWFW4SLkzMXJwC+JeOu345qMbsbwAdCaEClVAg1L+75nNxGpk8RPss6nDjYI2FcBq/RHfuvuuSzrO8SSrj3Vk4bjyvhd2T9HYVIx8km2QQldwk5qAk7NbcveTrbaJT5SWLPv48a5ZdtjeEHWy4z9phjbNWha6a2vW6gbHxUCPEWi5yPhcjHR+ODnI9H45yL/347+/pIHI0PjljXIFlhqprr9lZIi4W/FVgbJ6k5dyqdhAM4iQdw3PjSWPk5uGULw79hwCUNZFTxCVpQ8xrtg7H39IUndoTG0d8Cp9KHNCssCunjKDfl+h54UZhGx8MQVPql5m0k8fwRQ+qlHpcmztg/KB69Khj/3E7J6PsdIGfPMJZ83w31q1l+PfRexQjcEOGOEIV8DNP8/4O1FaB+7F4blF1hXd4s6V/Gxgfj7Vn3J+PhzDRawLUGuNZUp0gOOipJFp1pbEF5jDF/8VE6qlD8HsE1FkOWryaeMI7GYivF4FonpLga+T1y1+YUvdws0FopyAia5dkmydyapu5td2dpB8RHj5pWjbgD3mPLJrsX0GwFsN4iSktcx7dLpxVj1O1llqjjmnRTV1pcKvSlSSttWGB9ySZsuDgcdrRu+NRbYJfDbtd1aBfdottYRVtlWtV4LeOmlguswrq2BeQTrMwzf0Z5ecgx4gsm7RD8oswLa8RfyKzpmEx2WDRW+jZo/n3Mz+OiQOco+djk6qZP9YFWplgVXqBdjQikYrdRhpEBuQ2z26aOSUSucIEqZCstMTE7aMv/0DqP1T+5IUrYccGS9v+Z6S964Y2AVm6CSXol2NhvM0ZvAO7n2Qe0C1lgLx7rdZxPTeOHgXAo6GpaE/Pwd25mIQ7Eul3PVBGmAANBjzcOTlMWwEVc7MNrQFdbghlfpT2XF2FRSoX2pLsV3qMKdCEZKy5VAFQ6/W6NH/JGbZyvuO7JCbt7b2OHDu/Ptr7Vpv3vbPspyB4f/bBWXAY0BPQ/paS8YovDYFFKS5axyebL0qxrcKVxnhienuix5qNVyyV9/tSgJdTfUEGwksblkANCOvp9xyNQ39S996l17sPOF6gdtnTdQLe9esSyVLT6hixvlln3QvX31Psff6560a/Rfy+/9a3cvO4OVFpq3zvbeiba6ArvTi/Zcvkn6+5pOg==
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Get a list of all employee's forms
+
+scope: `employee_forms:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-employees-employee-id-bank-accounts.ParamsDetails.json b/docs/api/get-v-1-employees-employee-id-bank-accounts.ParamsDetails.json
new file mode 100644
index 000000000..d046850e0
--- /dev/null
+++ b/docs/api/get-v-1-employees-employee-id-bank-accounts.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"employee_id","in":"path","required":true,"schema":{"type":"string"},"description":"The UUID of the employee"},{"schema":{"type":"integer"},"in":"query","name":"page","description":"The page that is requested. When unspecified, will load all objects unless endpoint forces pagination."},{"schema":{"type":"integer"},"in":"query","name":"per","description":"Number of objects per page. For majority of endpoints will default to 25"},{"name":"X-Gusto-API-Version","in":"header","required":false,"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.","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"}}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-employees-employee-id-bank-accounts.RequestSchema.json b/docs/api/get-v-1-employees-employee-id-bank-accounts.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-employees-employee-id-bank-accounts.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-employees-employee-id-bank-accounts.StatusCodes.json b/docs/api/get-v-1-employees-employee-id-bank-accounts.StatusCodes.json
new file mode 100644
index 000000000..93f8dc142
--- /dev/null
+++ b/docs/api/get-v-1-employees-employee-id-bank-accounts.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"Example response","content":{"application/json":{"schema":{"type":"array","items":{"title":"Employee-Bank-Account","type":"object","x-examples":{"Example":{"value":{"uuid":"1531e824-8d9e-4bd8-9f90-0d04608125d7","employee_uuid":"9fcf1b1d-8886-4691-9283-383d3bdd4fd9","name":"BoA Checking Account","routing_number":"266905059","hidden_account_number":"XXXX1207","account_type":"Checking"}}},"properties":{"uuid":{"type":"string","description":"UUID of the bank account"},"employee_uuid":{"type":"string","description":"UUID of the employee"},"account_type":{"type":"string","enum":["Checking","Savings"],"description":"Bank account type"},"name":{"type":"string","description":"Name for the bank account"},"routing_number":{"type":"string","description":"The bank account's routing number"},"hidden_account_number":{"type":"string","description":"Masked bank account number"}},"x-tags":["Employee Payment Method"],"required":["uuid"]}},"examples":{"Example":{"value":[{"uuid":"1531e824-8d9e-4bd8-9f90-0d04608125d7","employee_uuid":"9fcf1b1d-8886-4691-9283-383d3bdd4fd9","name":"BoA Checking Account","routing_number":"266905059","hidden_account_number":"XXXX1207","account_type":"Checking"}]}}}}},"404":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided UUID is valid.\n"}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-employees-employee-id-bank-accounts.api.mdx b/docs/api/get-v-1-employees-employee-id-bank-accounts.api.mdx
new file mode 100644
index 000000000..1aedd3b80
--- /dev/null
+++ b/docs/api/get-v-1-employees-employee-id-bank-accounts.api.mdx
@@ -0,0 +1,71 @@
+---
+id: get-v-1-employees-employee-id-bank-accounts
+title: "Get all employee bank accounts"
+description: "Returns all employee bank accounts."
+sidebar_label: "Get all employee bank accounts"
+hide_title: true
+hide_table_of_contents: true
+api: eJzdV1tv2zYU/isc99AWEH2Lndl6mtukRR7SBU27BkiMlBaPLTYSqZKUG8PQfx8OJdnyLW23Yg99Siyey8dz/biij2yeW6eZVA7mhjupFXPLDGh4SyGdghAg6CSgjs8tfjtPs0QvAcgVX6agHLkEF2svknHDU3BgUHBFFU+BhhQqhXspaECloiHNuItpQA18yaUBQUNncgiojWJIOQ1XtARArTNSzWkRUAE2MjJDdDSk72MgHz5cnBE9Iy4GUrugRbDat+JvBgbNeO9fcjBLGtT4Mj4HesgDHhAXc0ekJYgVrAPRIh9jUCRXNoNIziSIgHyVSUISzQXhSUL09DNEzpJcJWAtASUyLZUjM20isGhWKh/n1r/DC2YP7ts8nYLBcNTOMzD+Ai3yWhuS8s/aSLdEiRqPLWELmPE8ccRp0ht4QJWfG/bGF8b46oL9DcaipwpRDFx4FJsMznhiYRfWGRZDKhVYnybBHbAptyDI+OqCLEqjhFurI8kdCPJVupgsdW68QMSTpEUuZkRpBZiEzOiFFBhxL8OzLJGRD+UzS25TqWSap03bk+exc5kN222hI9vyld6KdNquK5tlfGl0kvjzNs8kqzSlmv9eGWSNzy8QRm5BtOjxeg0oqDzFZul1egPWOWXdAfZHFWoaNr8XxSSgOoOy9S4EDekcHFt0WV3VljVaiE25erjnUaRz5exeIbwDlxtlfR3WWgRVSK3SulN3ykY6g5B8WhvOyma+T30z29AAF598gm2mlQWLt+x1Ovhn2+P5I0+zBEgtSQMaaeVAOZRtpKj92aLCgYLnxnAscOkg9Y6cdAke1LOGveTqgY3LG9Cg1itrnQb0kUGJwmtXiPDfBU9y/0+eS4xsd3DShWGvz4ZiBKw/FUM2mo06rCM6/dPOsNsbiD8wfXVYKrXRLJp1p13BhsPhKeufjrps1BuesJPhiTiZCtGfidGmQV/qMXkVQ/Qg1ZxsQBudO6nm98r3KhbB6emoM+gMUDWWQoCq87qRubm5uen2OgiqPqsuX3ugRVEENDNYQk6WEShh75flduaaE7RZIjh4diLwI6Yaw3gH8/E+WV8moNd8IdXclv3S9PGyAZF4Q0Ud8m/Be8tTwPF78Kq7efmWsfc7Np5ZUpkglYniaD6/ZfuS2wcQW+bXRgus8+/YwpuZfFsWwgRVn26Q21+7QyZF4buk3+nvD7C32pHXOleC3ClC7hTmd73tcazp3ERAhAZLlHYEHqV1LXLJH4DY3IAvqnozlbREWrLgiRStO1XlzWbAH4DbJZsbnWcNWlQlsMyfpdvCGC+mF2CMFFBuBmyD8Wb8w6MDhZup5FwPsKThcU4XrBPe4Ha482u9XZxrhWN4Dytv494Y2cWPu69cOeUhDUpuGNL2otteL8D2qrEBi/buCrRgFjXpzE2CBKXa+jyT5dJnAlK/+fda7gxSvRP10h7zhY16/pJHDB+0eWW0eMJmhsd4dQtRjrTMI3+l04yr5TiKwNpxjlG4nTSlrnFvlh18QHY9WhBiTU7w9xS4OUAZKxMsgQUkhOcuBuWqVY0T7HppHaT/xUNp4YgDT25nurntPd1E9oYFUxHOLaoUUKST9q/ZNZiFjKCRjw2z41Odu7YXbAt0jYuR+d9Mz3weUHUX7EdIIp0C0mCP45kl51WH4IxFjuiJpdBRjvXvr/FbRXZ45MlONd3Oaq/kHSRezjdqymXiC6o6/XNTP36Da+tSrhp23oB7gsft3mC1oV0/nQVWeXfw6NpZwqUvEN8Qq6pfb+mi21gLiC7cfvhtN+0koLG2DhVXK3wSfDBJUeDn8rWDDSGk5dPk2OOied//6bV2JBDl+KuekfWk8zPj+2/w0x5wT2P0XbqBOMEfRiLGH4z483cVy3hBjj7Gj0CpSb9aNrHUEJtFU0yQSZVvzR+D94s/PJ9I8eFX+1ZVloI42TPXONt7qm0t5zfn72lR/AOnPEmI
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Returns all employee bank accounts.
+
+scope: `employee_payment_methods:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-employees-employee-id-custom-fields.ParamsDetails.json b/docs/api/get-v-1-employees-employee-id-custom-fields.ParamsDetails.json
new file mode 100644
index 000000000..d046850e0
--- /dev/null
+++ b/docs/api/get-v-1-employees-employee-id-custom-fields.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"employee_id","in":"path","required":true,"schema":{"type":"string"},"description":"The UUID of the employee"},{"schema":{"type":"integer"},"in":"query","name":"page","description":"The page that is requested. When unspecified, will load all objects unless endpoint forces pagination."},{"schema":{"type":"integer"},"in":"query","name":"per","description":"Number of objects per page. For majority of endpoints will default to 25"},{"name":"X-Gusto-API-Version","in":"header","required":false,"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.","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"}}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-employees-employee-id-custom-fields.RequestSchema.json b/docs/api/get-v-1-employees-employee-id-custom-fields.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-employees-employee-id-custom-fields.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-employees-employee-id-custom-fields.StatusCodes.json b/docs/api/get-v-1-employees-employee-id-custom-fields.StatusCodes.json
new file mode 100644
index 000000000..bd8a7310b
--- /dev/null
+++ b/docs/api/get-v-1-employees-employee-id-custom-fields.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"custom_fields":{"type":"array","items":{"type":"object","description":"A custom field of an employee","properties":{"id":{"type":"string"},"company_custom_field_id":{"type":"string","description":"This is the id of the response object from when you get the company custom fields"},"name":{"type":"string"},"type":{"type":"string","description":"Input type for the custom field.","enum":["text","currency","number","date","radio"],"title":"Custom-Field-Type"},"description":{"type":"string"},"value":{"type":"string"},"selection_options":{"type":["array","null"],"description":"An array of options for fields of type radio. Otherwise, null.","items":{"type":"string"}}},"required":["id","company_custom_field_id","name","type","value"],"title":"Employee-Custom-Field"}}}}}}},"404":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided UUID is valid.\n"}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-employees-employee-id-custom-fields.api.mdx b/docs/api/get-v-1-employees-employee-id-custom-fields.api.mdx
new file mode 100644
index 000000000..f7d2b01e2
--- /dev/null
+++ b/docs/api/get-v-1-employees-employee-id-custom-fields.api.mdx
@@ -0,0 +1,71 @@
+---
+id: get-v-1-employees-employee-id-custom-fields
+title: "Get an employee's custom fields"
+description: "Returns a list of the employee's custom fields."
+sidebar_label: "Get an employee's custom fields"
+hide_title: true
+hide_table_of_contents: true
+api: eJzdV0tvGzcQ/itT9pAE2JVsI+lBpxpxHBhFE8NxmgKy4VDLkcSESzIcrmxB2P9eDHdXXr2Spg166EnQcjjzzcw3D67EQz6rKLpc24izIKN2No9Lj2I0FlhOUClUIhPS+74IidtMRDkjFntVeuOWiOmjl0GWGDHw0UpYWaIYCWxF7jQr01aMhJdxLjIR8EulAyoxiqHCTFAxx1KK0Uo0KATFoO1M1JlQSEXQnu2LkbieI7x/f3EGbgpxjtCZEHW22tWSsGNgNcn6lwrDUmQdPi9nKPZZ4AOIcxlBEzBWpIhqAB/maKGy5LHQU40qg3ttDBgnFUhjwE0+YREJKmuQCNAq77SNMHWhQGK12qZIDv4ZXgw7cN9U5QQDh6Mz7jEkBwZw7gKU8pMLOi5ZosNDDWyFU1mZCNHByYsEqLXzZ/46seP08iL/AwOxpRbRHKVKKB4zOJWGcBvWGZOh1BYppUnJiPlEEio4vbyARaMUJJErtIyo4F7HOSxdFZJAIY0ZwMUUrLPISfDBLbTiiCcZ6b3RRQrlE4Jxqa0uq7Kv+/bpPEZPo+FQuYIGie6DwpXDjt65l8vgjEnnQ+l13t7UdvZzqzDvfX7GMCpCNRCH+ZoJtFXJ5XFydPIiP/olP37B9dGGWoz63+v6luNI3llCYmUnR0f8sxnKt7+JTBTORrSRT3u+Dz8Ri+xhUkMGkQkfnMcQdWOg4DCUd1ONRlFPXIYgmWg6Ykn71GxCOoVGESRFTC1pH0tx26hWewu7cKWXdnnXx3S3T3a3QjVxMphYWnWdoAtkWwcwDa6Eey7YpatghjFJtUY38BOjaai/B2bz4VuYLqyvIrAMF3tjqmdi0GNGxAeOaFGFgLZI5Z1qmHXKyOELUmmXeq2Oho2+TKryc1aVXzOQ7ca4B/hCmmq/S4QGC75353zT19dS4zUVbGVMQ92NzFtIAqnhNJeTw00gUy44BsmDAbyNcwz3mjADVjfYw7AOVV33e8pYpJFxiCJtutrkdK72AtYNp7wfOTZSJ0PPj57v1tkbF+HcVVbBjQW4sdeJVG3vZ3q5KhQIyiGBdRHwQVMcwO/yMwJVAVPSuz7VDClNsJBGq8GNFWyXqyIV7oUSIzHDmC+O865uKO/Ny3yzUrfTcIWxCpZAgtEUt4fhE9rk9+DG3lgqnMcRfFybGwWU6qPIxENOHuVnlLTMOa65W2AIWmGDsQnheQcEHyJaalgzXonPuBSjw/vEmobf2Ct4+nSqDqFZ69pBxY20xDh3bVi5BfGiMRLDxfFw7fFw1YtwPdwOMWFYdBtMFQxPu3aESK+bCZIrLNMY2cnIGZZuK5aNvpxbmuB7acQeULxX52Vw6is6PR+z64RFxTM+IX/Z1MxpUSDRacVRGN/2pd7xrGg68x7ZdWEyxG7S8f8JyrBn/2hV5AYXaEBWcY42tuOJe827JUUs/42FRsMBA2lTmrqkta39tLvwKsCEabeXjbmbCd5N6O30HYaFLrCXj8c1QU5cFYdJcKjYNNdunv7nbprywFe3wX5AU7gSeadKOJ4QvGp5D5fNwpG2FOWKqkQbkxs/tQNeFmnAt1vYWWcVrtC0dZIJLKU2iVDt6a+P/OFoeEexlLan5zXG/njebg7bLqwed40f22barPP4G3ojdaJHKodVW61jsThOLnYvi0yMNt8QmyV7m4m5o8gXVyveLt8HU9f8uVmcuRyUJjkxh/bUvrP/0eJ/IBBN82tfJF2fSx3j73vww94CX8eYavQR4i3/CZoxfmfEn161A/8ZHHzXHYDS7a122cfSQeyTpr6ts+7Z8n3w/udvmK+keP8DcIOVjSD3dR97ZzuPk43R/PrVtajrvwB9YcM4
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Returns a list of the employee's custom fields.
+
+scope: `employees:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-employees-employee-id-employee-benefits.ParamsDetails.json b/docs/api/get-v-1-employees-employee-id-employee-benefits.ParamsDetails.json
new file mode 100644
index 000000000..bf63663b8
--- /dev/null
+++ b/docs/api/get-v-1-employees-employee-id-employee-benefits.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"employee_id","in":"path","required":true,"schema":{"type":"string"},"description":"The UUID of the employee"},{"schema":{"type":"integer"},"in":"query","name":"page","description":"The page that is requested. When unspecified, will load all objects unless endpoint forces pagination."},{"schema":{"type":"integer"},"in":"query","name":"per","description":"Number of objects per page. For majority of endpoints will default to 25"},{"in":"query","name":"include","schema":{"type":"string","enum":["all_benefits"]},"description":"Available options:\n- all_benefits: Include all effective dated benefits for each employee instead of only the current benefits."},{"name":"X-Gusto-API-Version","in":"header","required":false,"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.","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"}}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-employees-employee-id-employee-benefits.RequestSchema.json b/docs/api/get-v-1-employees-employee-id-employee-benefits.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-employees-employee-id-employee-benefits.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-employees-employee-id-employee-benefits.StatusCodes.json b/docs/api/get-v-1-employees-employee-id-employee-benefits.StatusCodes.json
new file mode 100644
index 000000000..1bb56c18d
--- /dev/null
+++ b/docs/api/get-v-1-employees-employee-id-employee-benefits.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"Example response","content":{"application/json":{"schema":{"type":"array","items":{"description":"The representation of an employee benefit.","type":"object","title":"Employee-Benefit","x-examples":{"Example":{"version":"09j3d29jqdpj92109j9j2d90dq","employee_uuid":"73274962-63ce-4e5c-b689-1df8d4df09f4","company_benefit_uuid":"54e37c27-43e6-4ae5-a5b2-e29895a133be","active":true,"uuid":"e91ca856-a915-4339-9b18-29f9cd66b031","employee_deduction":"100.00","company_contribution":"100.00","employee_deduction_annual_maximum":"200.00","company_contribution_annual_maximum":"200.00","limit_option":null,"retirement_loan_identifier":null,"deduct_as_percentage":false,"contribute_as_percentage":false,"catch_up":false,"coverage_amount":null,"deduction_reduces_taxable_income":null,"coverage_salary_multiplier":"0.00","contribution":{"type":"amount","value":"100.00"},"elective":false,"effective_date":"2025-01-01","expiration_date":null},"Tiered Example":{"version":"09j3d29jqdpj92109j9j2d90dq","employee_uuid":"73274962-63ce-4e5c-b689-1df8d4df09f4","company_benefit_uuid":"54e37c27-43e6-4ae5-a5b2-e29895a133be","active":true,"uuid":"e91ca856-a915-4339-9b18-29f9cd66b031","employee_deduction":"100.00","employee_deduction_annual_maximum":"200.00","company_contribution_annual_maximum":"200.00","limit_option":null,"deduct_as_percentage":false,"catch_up":false,"coverage_amount":null,"deduction_reduces_taxable_income":null,"coverage_salary_multiplier":"0.00","elective":true,"contribution":{"type":"tiered","value":{"tiers":[{"rate":"100.0","threshold":"2.0","threshold_delta":"2.0"},{"rate":"50.0","threshold":"5.0","threshold_delta":"3.0"}]}},"effective_date":"2025-01-01","expiration_date":null}},"allOf":[{"description":"","type":"object","title":"Employee-Benefit-Base-Object","properties":{"version":{"type":"string","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."},"active":{"type":"boolean","default":true,"description":"Whether the employee benefit is active."},"employee_deduction":{"type":"string","default":"0.00","description":"The amount to be deducted, per pay period, from the employee's pay."},"deduct_as_percentage":{"type":"boolean","default":false,"description":"Whether the employee deduction amount should be treated as a percentage to be deducted from each payroll."},"employee_deduction_annual_maximum":{"type":["string","null"],"description":"The maximum employee deduction amount per year. A null value signifies no limit."},"contribution":{"type":"object","description":"An object representing the type and value of the company contribution.","properties":{"type":{"type":"string","description":"The company contribution scheme.\n\n\"amount\": The company contributes a fixed amount per payroll. If elective is true, the contribution is matching, dollar-for-dollar.\n\n\"percentage\": The company contributes a percentage of the payroll amount per payroll period. If elective is true, the contribution is matching, dollar-for-dollar.\n\n\"tiered\": The company contribution varies according to the size of the employee deduction."},"value":{"description":"For the `amount` and `percentage` contribution types, the value of the corresponding amount or percentage.\n\nFor the `tiered` contribution type, an array of tiers.","oneOf":[{"type":"string"},{"type":"object","properties":{"tiers":{"type":"array","description":"","items":{"type":"object","description":"A single tier of a tiered matching scheme.","properties":{"rate":{"type":"string","description":"The percentage of employee deduction within this tier the company contribution will match."},"threshold":{"type":"string","description":"Specifies the upper limit (inclusive) percentage of the employee contribution that this tier applies to.\n\nUse threshold to define each tier's end point, with tiers applied cumulatively from 0% upwards.\n\nFor example:\n\nIf the first tier has a threshold of \"3\", and `rate` of \"100\", the company will match 100% of employee contributions from 0% up to and including 3% of payroll.\n\nIf the next tier has a threshold of \"5\" and a rate of \"50\", the company will match 50% of contributions from above 3% up to and including 5% of payroll."},"threshold_delta":{"type":"string","description":"The step up difference between this tier's threshold and the previous tier's threshold. In the first tier, this is equivalent to threshold."}}}}}}]}}},"elective":{"type":"boolean","description":"Whether the company contribution is elective (aka matching). For \"tiered\" contribution types, this is always true.","default":false},"company_contribution_annual_maximum":{"type":["string","null"],"description":"The maximum company contribution amount per year. A null value signifies no limit."},"limit_option":{"type":["string","null"],"description":"Some benefits require additional information to determine their limit.\n\n`Family` and `Individual` are applicable to HSA benefit.\n\n`Joint Filing or Single` and `Married and Filing Separately` are applicable to Dependent Care FSA benefit."},"catch_up":{"type":["boolean","null"],"default":false,"description":"Whether the employee should use a benefit's \"catch up\" rate. Only Roth 401k and 401k benefits use this value for employees over 50."},"retirement_loan_identifier":{"type":"string","description":"Identifier for a 401(k) loan assigned by the 401(k) provider"},"coverage_amount":{"type":["string","null"],"description":"The amount that the employee is insured for. Note: company contribution cannot be present if coverage amount is set."},"deduction_reduces_taxable_income":{"type":["string","null"],"default":"unset","enum":["unset","reduces_taxable_income","does_not_reduce_taxable_income"],"description":"Whether the employee deduction reduces taxable income or not. Only valid for Group Term Life benefits. Note: when the value is not \"unset\", coverage amount and coverage salary multiplier are ignored."},"coverage_salary_multiplier":{"type":["string","null"],"default":"0.00","description":"The coverage amount as a multiple of the employee's salary. Only applicable for Group Term Life benefits. Note: cannot be set if coverage amount is also set."},"company_contribution":{"type":"string","default":"0.00","description":"The amount to be paid, per pay period, by the company. This field will not appear for tiered contribution types.","deprecated":true},"contribute_as_percentage":{"type":"boolean","default":false,"description":"Whether the company_contribution value should be treated as a percentage to be added to each payroll. This field will not appear for tiered contribution types.","deprecated":true},"effective_date":{"type":"string","format":"date","description":"The date the employee benefit will start."},"expiration_date":{"type":["string","null"],"format":"date","description":"The date the employee benefit will expire. A null value indicates the benefit will not expire."}}},{"type":"object","properties":{"employee_uuid":{"type":"string","description":"The UUID of the employee to which the benefit belongs.","readOnly":true},"company_benefit_uuid":{"type":"string","description":"The UUID of the company benefit.","readOnly":true},"uuid":{"type":"string","description":"The UUID of the employee benefit.","readOnly":true}}}],"required":["uuid"]}},"examples":{"Example":{"value":[{"version":"09j3d29jqdpj92109j9j2d90dq","employee_uuid":"8f9f3f68-8fd3-499d-ade7-4a052e56494e","company_benefit_uuid":"54e37c27-43e6-4ae5-a5b2-e29895a133be","active":true,"uuid":"e91ca856-a915-4339-9b18-29f9cd66b031","employee_deduction":"100.00","company_contribution":"100.00","employee_deduction_annual_maximum":"200.00","company_contribution_annual_maximum":"200.00","limit_option":null,"deduct_as_percentage":false,"contribute_as_percentage":false,"catch_up":false,"coverage_amount":null,"deduction_reduces_taxable_income":null,"coverage_salary_multiplier":"0.00"}]}}}}},"404":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided UUID is valid.\n"}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-employees-employee-id-employee-benefits.api.mdx b/docs/api/get-v-1-employees-employee-id-employee-benefits.api.mdx
new file mode 100644
index 000000000..9415c5f2c
--- /dev/null
+++ b/docs/api/get-v-1-employees-employee-id-employee-benefits.api.mdx
@@ -0,0 +1,75 @@
+---
+id: get-v-1-employees-employee-id-employee-benefits
+title: "Get all benefits for an employee"
+description: "Employee benefits represent an employee enrolled in a particular company benefit. It includes information specific to that employee’s enrollment."
+sidebar_label: "Get all benefits for an employee"
+hide_title: true
+hide_table_of_contents: true
+api: eJztWntv2zgS/yo8HRZtActx4jiN/dd1t4/N4nZbNO3tAUng0OLIZkqRKkk58QUG7mvc17tPchiSetiS3bTd29175J/IEjnz43BeHM59dBfPC2NVzKWFuaaWKxnbVQ7R5CKCbAaMAYt6Ec3z5hATXfUiS+cGh73IcqFWAORbkJBy6z7mVNMMLGgcch9JmkE0iSAMnXIkymU0iXJqF1Ev0vCx4BpYNLG6gF5kkgVkNJrcRx5NZKzmch6texEDk2ieI45oEr1bAHn//uw5USmxCyAli2jdu29TcWsAjWQc948F6FXUK/HldA5RFwf8QOyCWsINQaxgLLA++XkBkhTS5JDwlAPrkVsuBBGKMkKFIGp2A4k1pJACjCEgWa64tCRVOgGDZLl0Eu1/GV7QLbg/FdkMNIqjZJ6Ddgvok5dKk4zeKM3tCkeUeIyHzSClhbDEKnI0coC6mHKZiIKhnHZtUi8CWWSoG1SI6axSi9bmPVtSLuhMAFHulZlcypg0J03ImWfnxAlpConlSyCMWmCkHIXyJECTRbX9hEtjgTInBylWTjeSQmuQtprmhR6W9df4lbOEZ2/O4r+ANogwSH0BlDlJ11qaUmFgeznPUeEzLsE4dogxnlEDjDx7c0aWniihxqiEO/y33C7IShXaDUioEH1ylhKpJKCi5VotOUOtcmNongueOHV5ZMhFxiXPiqxJ++rxwtrcTA4OmEpM35l2P1HZQWnKcU5XWgnhvh/QnMdhJpfzPwaCceP1E4RRGGD9B2330eBoFA9O4sMR+oCgTtGk+X69vkI5mlxJAwaJHQ0G+G9TlC/uaJYLIOXIqBclSlqQFsc2JHFwY3BCh+1QrSmqLbeQmTYHNGsNuQYD0jpSqCtU1ioU1ASXHkh6i8Lf3Ap8Ufq+OPi+qBfdxeCxO55hHfgYRBpNosH4ZsiOxjcfWX4zPjocjG/GN0dsPGAfUZaljywKzqJJ9HR49PR4fHIUnwwTiI9hlMSzk9NxfMjSU3bM0sE4PXbSyXIqV6XhlLNHxzB8mhw9jY+HcBIfUxjFdDQ7iuFofDoe0cPhcIaypc6qSucb5sL4MKGno5OYjg9H8fFwOI7Hs8PT+GicjhN2cjIbDA+bgBmwIgnSPRwM+oNBAxfunuazYvt7e/aUSllQMc3oHaqjU589xPYMFzzjdqrCjstCCFQ9yzVkIO1UKCqnnIG06Lt1OcIDmVIzzUEnqBxzqAy+4gy7BlCbLKZF3pixBE3nMKWZKlB9m1wQv8YnMFNL79AVTrlMFHokP66abqigejXNCmF5LhzeqBJLU7a1AXiGvWhJRQG10Ne9CASEHQ8oK886Ra9VmexhPHBbfJdzH/nDZ8S27kXvOGhg5H9eyX9tJd6vor+BBtb65IW7QyOt05daI+/dG58iaq93TqboYRcazEIJ3KOjzTdTBsLS8B4jeJg6as8c7Zg5xJlX6/WXKf66h4nN69Th3owqnxEr4m+pgfh1OSzXKgdtuY8blR21g207jJV5TZlhhFTYI+iTcwD3+6KO9WRecAafmS5wBlmuLMhk9cRlXFymSmchdkqyULeYOhYG2XFDUg6CYY5VWV61mJlSAqiMGkmCV5zNxf28ALsAvZHYl2EZMxNP17HoMtAu2ZUpSVDctjC9keBCZkA8MczAfBK9wv9csR5Jtco2cD3CdH7V9yeULvPct/jOdLJz9dXySqBmoQqBqTCxGlxWSQ2hpOa8tRSP3CXLYXd3yK/lk8oFXNTyRHPwqd62GMOsPcBRoiuguk+eEaRDnFMghs8lxmNDpCLO+Tl8OzxKZWVbBwsZtL9O8VDrUZI4kVDJArtgK8EpkyabfssqPdMHmWQHPeJSVOhfykt5GaLzZTQhneMBNzHld7iftbzKHcNTQulz0RCc8YSFNBhyQzKMBlzOe4QpIaiOU6Vj/xiA1JqyH0xDo4LQApoOgMFMflGcPnjsxIh0llSj4tAkUZq5DVeOmeF/g+0CQa2QTr+qiLS5l3hixlnXfo3XTnOua1FcbwJAxTB+gVvqpf1JxqEK8lK6IVO3yIqbX2sH8R6eUNzJxpHG6IlqqiSEcLRdLmlbypZK+wDcOjW1wlp1jPqE5RHD5VyAw+ZOVMQvptrh0gxaUHwYf4h1bapih4vBgzWXPgw5ILts3Bc+HDSnBo3k4VNAzkPRxx/2ixzV3/kr8tiVSAxfwpMOq6ngbm4uFpdqvO6Ei6SVU4z3LqYGaKjVDFIuwbtxnPDIFZeIq+b0fF3B7WwgxEhSZIWgaIdi5UPA4BtS5LdUM1PpXji5TvD3mUebcm2sx7RwgaWGoVJyGQ0vo543Cty+a//ycDDA102h13Imh4PBNxv71hSEaYDDhSJpX3FC1Rm6iaUXbMCUcLcP5egycpQoQZTh3T6MIw+xAxmdqSUgkC58ow18GwpV5p4P0W9jIUf6jKcpaJAJZj32FqCh0o9MY5GIwnlkDUuuivaIPjmTW/vZ87S4IVjVWlIBPu2p50Rr93e1Xm8cGTsTmV2JS6fRIc8yKjymH2jlG574GmXt7He4V4+bilu68kGl38qm1g88aX1RVtO5qi/KazaPdw8Gc64yqMufoS5JKGMcB1CxkZs7fxFKk7gpPDgqZ0DXL2nGxSpEtjPJ+JKzgoprQpGir7RhidYq8v35s6oq5ub+4KrZL7lA5VeanDvfH2j9SLVG14M/wpBzwIsBC45fi/xzyEFiPYZ8hx9fNri5FLA62NZiqlWwltNn59QhhcaDCy05PjLk0nMkRX4ZOb/RJ6+xlPxW2QU5Hhx+cCtzD9VOVIcfv+muLh3YGIIHaTIauMXsq0N9ykWcVWMdA4oYHn94gtcOrrzM5xKL477oHb6FWrL2ufRWQeCzbKA8IPmA1RAjGqU0Bcb6VOk++UlZmHSbSkKlVFiIJyE7JxydrYdVcuCGGLCNE9W+WsXeJZSHvkIasI16dfl7B9FexBSYqVQ2sN0e0JLPJ45sgQ8JZIgng4YjlQ3ataSCOwGSV1oVOXkHOiN/5mlt7qVkbxcgG6kmR89iyaVfFca2bYGiulbvfDWH1NUcZ5B8LpUG1t9Qk47Cz4PEvfOM3QKGITuQb+VJj0zAGgTU8BkPkVKtagZ2qRkVRlW61l2x/vpaQk55Rx0hWGlg2ifvqsqJT0cQO81zoN7WQy7djoo+AOYaEqwB+HLKel+9+qvKEV0yKuPcA+sRFAtM+LxRivil179d3mtvow+T0SRyA7p2ET90l6AcQmOp9prTqhbusZKvZuuYwVaSwSXDe7FwJtkYj4IMczCv++TBcKtE/5C0teseHnf4dsHxmNJANAOh5NxtmgbK0K4bKttV5P9c/mXYaVzitTh95cp2kw6XnOVl8YXn5OvNOy4Hffnh4otvUE7TcTpMT07j05QN4+PxmMWUwdP4mA5GRzA6OR4fw+/4BuX3dk34n3YJ6A5pqF/Hg+N2FesnZclLVUhGLiUhl9LffYcuFrxjV4VOgGC2E/wEN7ZPfqQfgGBCF86WvhvBG4NPcTnrX8oI+aLrcK7vDHViDjZeHsZV6ls9TTmrn6vOkG2Te7FlYqYu427c0IPEoAF4AscQQ7XlSSGoblk/ObPhlA5m42gUOncSf/CltqL9z7//wwT6mKS7485bsIWWZqME59pSWnBdqMJIVn7C6WV/lItelLt7mDffn7m8y/WoLLnh4SjU6HAwoZyDdcGW6CboeSb5gl8Tk6jclxHd02TX6GvXpGByoB+AmlU8xwSq0Zz1bb0rzWHYJhOjHmrOwG+xuyCzII1rCUPn9QFW0WR3U1lVZv1EcxlGp5LUNtD6OrsFuHvaJvB6Oi4A/XQGdqFYtSLXkDaJDpaHB5X6Htw39Hd90KXABvSyvMostMCuoXC3RnPur9ZiBpm7X2vp+3PI1Ja4Pb3YeVic5xa3g3AnzTdasT00c/yMyzeQFNgP5pB/5+3mWZKAMc8KlMTFVXPUuavduujVMbYKpQix7BhyOSZQ3dGrFkjEApYgCC3sAg+2Xu0xoTpfGQvZ13DwFHYwcF11qfJlcH9J63rAsKUKFaWKxI3+pV6EhRTzOj0HveQJNPajvj+lM1XYAzfwgCFr9I6x+x2r1O0DTm1l2CDcedAq4nA8MuRFMBPyJlysYLcXU0mRlV1LfwgNIDRxB/nQzfa85EregghmhVGUcuEUKnz9U60/KI1cGZtR2aDzCqxzcRuereGCt9dwX7dp/d+L/7u9eNlVAXf2IBeUO5txPuI+uLGLaNnMvVAHJptNuG1fdtWLFspYnHx/j+2L77VYr/G1bwR1TQ/cYJqyoxGyqQS/UvfsDmH4aBDaekvH71zpw1fwizXU7sfonNcXQvzN+2j3Lq1uGK6Xd4U/NEfMn6lQj9+Gc9UTsrP3ewec8opTrppYSphNu1hjr3Jo+/08eP/lPcB7trm7gXpDo/1AjOd5sy+x1c67kZa9evEuWq//BdlHHXk=
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Employee benefits represent an employee enrolled in a particular company benefit. It includes information specific to that employee’s enrollment.
+
+Returns an array of all employee benefits for this employee
+
+Benefits containing PHI are only visible to applications with the `employee_benefits:read:phi` scope.
+
+scope: `employee_benefits:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-employees-employee-id-employment-history.ParamsDetails.json b/docs/api/get-v-1-employees-employee-id-employment-history.ParamsDetails.json
new file mode 100644
index 000000000..c8985cf67
--- /dev/null
+++ b/docs/api/get-v-1-employees-employee-id-employment-history.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"X-Gusto-API-Version","in":"header","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"},"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."},{"name":"employee_id","in":"path","description":"The UUID of the employee","required":true,"schema":{"type":"string"}}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-employees-employee-id-employment-history.RequestSchema.json b/docs/api/get-v-1-employees-employee-id-employment-history.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-employees-employee-id-employment-history.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-employees-employee-id-employment-history.StatusCodes.json b/docs/api/get-v-1-employees-employee-id-employment-history.StatusCodes.json
new file mode 100644
index 000000000..a561a22f5
--- /dev/null
+++ b/docs/api/get-v-1-employees-employee-id-employment-history.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"successful","content":{"application/json":{"schema":{"type":"array","x-examples":{"success_status":[{"hire_date":"2015-06-09","termination_date":"2025-05-09","file_new_hire_report":false,"two_percent_shareholder":false,"employment_status":"full_time"}]},"items":{"description":"The representation of an employee's individual employements.","type":"object","properties":{"hire_date":{"type":"string","description":"The employee's start day of work for an employment."},"termination_date":{"type":["string","null"],"description":"The employee's last day of work for an employment."},"file_new_hire_report":{"type":"boolean","description":"The boolean flag indicating whether Gusto will file a new hire report for the employee."},"two_percent_shareholder":{"type":"boolean","description":"Whether the employee is a two percent shareholder of the company. This field only applies to companies with an S-Corp entity type."},"employment_status":{"type":"string","description":"The employee's employment status. Supplying an invalid option will set the employment_status to *not_set*.","enum":["part_time","full_time","part_time_eligible","variable","seasonal - not_set"]}}},"title":"Employment-History-List"}}}},"404":{"description":"Not Found\n\nThe requested resource does not exist. Make sure the provided UUID is valid.\n","content":{"application/json":{"schema":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided ID/UUID is valid.","type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["error_key","category"],"properties":{"error_key":{"type":"string","description":"Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error."},"category":{"type":"string","description":"Specifies the type of error. The category provides error groupings and can be used to build custom error handling in your integration."},"message":{"type":"string","description":"Provides details about the error - generally this message can be surfaced to an end user."}}}}},"x-examples":{"not_found":{"errors":[{"error_key":"request","category":"not_found","message":"The requested resource was not found."}]}},"title":"Not-Found-Error-Object"}}}}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-employees-employee-id-employment-history.api.mdx b/docs/api/get-v-1-employees-employee-id-employment-history.api.mdx
new file mode 100644
index 000000000..6ffdecbc8
--- /dev/null
+++ b/docs/api/get-v-1-employees-employee-id-employment-history.api.mdx
@@ -0,0 +1,71 @@
+---
+id: get-v-1-employees-employee-id-employment-history
+title: "Get employment history for an employee"
+description: "Retrieve the employment history for a given employee, which includes termination and rehire."
+sidebar_label: "Get employment history for an employee"
+hide_title: true
+hide_table_of_contents: true
+api: eJzdWN9v4zYS/lfmeA/bFpKdLLoH1E8XNLltgLs22GR7B2QDlxbHFhuK5JKUHcHw/34YUrLotb3bRR8OuKc40nB+cb6Zb7RlxqLjQRp9K9iMrTCU68sSG6tMh+j3v+ZS9L8b1GFeSx+M61jBBPrKSUsa2Iy9w+AkrhFCjTDKQy8PS+OAw0quUcOguoBNLasapK5UK9BDQNdIHZ0CrgU4rKXDyQf9QfvKWJzBb6NqP3PIxW+sYIGvPJs9spteL9yMQuypYC/lqvXBlFIHXKWYy9BZpDPYLFAIFKxg3NpcJB613PEGAzoysGWaN8hm7D/l26jw6u62/BWdpxQUTFIeauQCHSuYr2psOJttWTLFfHBSr1jBULcNmX598fpNefG38vINWRK45K0KbJY/332a5mtMOaJk1QiCBywX3KOAq7tbWCdfgHtvKskDCtjIUENnWhcFKq7UBG6XoI1GkB6sM2spUBRJhlurZBXDf+XhsZFaNm2T6376pg7B+tl0KkzlJzGxk8o00yGRpeWdM0rF91NuZdmflHr1115hmT3+ltxoPYoJ2xX7DGfVN2TW8lAfld1DjfD+/e01mGVWeYisYA4/ttKhYLPgWjx/IbvdU8E8Vq2ToYu3/KNpLNfdVVWh91dtqNns8WmXFZLzG74a9Dr01miPnlS/vrigP4dO+jZqWraKFawyOqAOJJVle/q7J9HtsZfcOU5weynxhTdWJTu9yrkPPLSpNgkqcyqIWEKXsYQufiB4jKga31OJvUnvl1LhXONmHjU4tMYFNlty5bFgYWPmFl1F2Pc1d1gbRQU+vM9aw+ALW7ZKzYNskO2edgWTARt/nBW6OofWoUcdEubNEvjYHl55kFrItRQtV8PTCOoJRZXSYxa/YxVYwayjhhZkyk+WjGMAHvuRmfSBuwCCd+TNxrjn1Lp01tSoUk9kdTD0OFrSrVIJ3J+xqLj/IwZPX9M+uoUxCrk+GV7/DpaKr2JOqej0CjY1hhodxG4GG6kUkBXgoHEDZAeSnehSjq+UgnO18UWn/t0bzlVSH+AQNgZ6nZDpHPBdJWhO4KGWHpYSlQCjVZc6F3VF08vQP7H5cQ335Y/GWUAdZOiAfIv+n6jdryyWbNAlDRO4b61VHWWXa5B6zZUUYOL5lGGP4ZMh2Vsn37/TJsw9hu8m2aCw3IWEpyLDVjE+n6OSK7lQ9HDNneTpp0fujeYKSujVsqfdji5OBkVBjnOy/CnN6fKf0ge2i1LfX3x/jNqfTYB/mFYLGsoJwh9b9DRqHHrTugpBGPRkEfBF+jCBf/FnBN+6RA6GkZP6tvQQUzT5oL+mOZ5xCj5ogD/r1+319NC1E91mHC6PDJ0zLrGFgx7UPz9u5fuG+EWt82ekAxUPuCLWddpGlPpi6d5brOQywqLGPuZ4HExVtc5P4KGzkhhCB4HQ9YwdSEGgiadInofg5KINON0TI3CoItMIZlQZ4bX3+itcIw0kS3hPmoAuc1A1XJLvPV8501qpVz7SxYprWGAkE+TNopVKQEW9renla66FImxKnQhPxveizw16z1d/YGrcDY4IDFwqD3xh2pAltYQVanRjOnvVg5e+dUteJU+p2WtBjlPmEvoO5z3hd0kVnhfW48H9s77i83qZZQez4NgZgGx4wkc8MKHpnTWLn00oI8jKGzJa/pKqdu+ut8ifkfuujLeSkbicjh9KEtsrzRqdkwLTFvLTfsHAl4DaRyZOoaYgz3J56nyq/TKnJ5J5qCqxuf15YnW50Kdx7QVPxnf65GGco4YsXuKXDYba9NtY7O9EPdl0fTnd72XTbUaNd9OTm5lHtx42ltYp2kp6zs6tTJS9FNhE3n5U2NfYmE9uKekrJXlG52KQZxSf1HnnjPiMTkuvcxZ+T30+Ff4JLr6HJhkfNq3INpC7uHsdWu9VlArXqIC3oaaelkYLYf6+8wGbP2MhaThjgBiwXpqotYdS4ltXd7dUCv3+eLD3JXrpf1neo1vLCrNMjxtX7DjTKDgVZJoGQxn/L80yZpiOHnEvVJVpkPpO9OOVh5seMHCXdre48AlTtc1Azf/SD2dexeHcb2nXg1V4R0MgAoxoFZcqlkr/9u9jZVA2rPGh4TrT8xbD2W8GOt/pDiLZjnThf/v5IdVKwJcwtYrLWFQRHtsewo9sfcmKfb+gJM0ON9wTOH4qWG18oNPbLe34753a7ejxxxaptz8+ZWyPsC6kp99iv5ydTdc373qm8S18ZoM+GdjAZXSX9TFW9E0vjyouf/33kK9z7//6K8eZvKb8nf6ytE/zOF2oXdmQvTviywcD5e3NA03Dw+6272b9D7qkk9e73SaJB/OMerfb33ag/yNN2P0Xeqgz6A==
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Retrieve the employment history for a given employee, which includes termination and rehire.
+
+scope: `employments:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-employees-employee-id-federal-taxes.ParamsDetails.json b/docs/api/get-v-1-employees-employee-id-federal-taxes.ParamsDetails.json
new file mode 100644
index 000000000..f3db089c4
--- /dev/null
+++ b/docs/api/get-v-1-employees-employee-id-federal-taxes.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"X-Gusto-API-Version","in":"header","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"},"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."},{"name":"employee_uuid","in":"path","description":"The UUID of the employee","required":true,"schema":{"type":"string"}}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-employees-employee-id-federal-taxes.RequestSchema.json b/docs/api/get-v-1-employees-employee-id-federal-taxes.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-employees-employee-id-federal-taxes.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-employees-employee-id-federal-taxes.StatusCodes.json b/docs/api/get-v-1-employees-employee-id-federal-taxes.StatusCodes.json
new file mode 100644
index 000000000..ec773b932
--- /dev/null
+++ b/docs/api/get-v-1-employees-employee-id-federal-taxes.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"title":"Employee-Federal-Tax","type":"object","description":"Federal tax information for an employee. The response structure varies based on the w4_data_type field.","oneOf":[{"title":"Employee-Federal-Tax-Pre2020","type":"object","description":"Federal tax information for employees using the pre-2020 W4 form.","properties":{"version":{"type":"string","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."},"employee_uuid":{"type":"string","description":"The UUID of the employee."},"employee_id":{"type":"integer","description":"The internal ID of the employee."},"company_id":{"type":"integer","description":"The internal ID of the company."},"w4_data_type":{"type":"string","description":"The version of w4 form.","enum":["pre_2020_w4"]},"filing_status":{"type":["string","null"],"description":"It determines which tax return form an individual will use and is an important factor in computing taxable income. One of:\n- Single\n- Married\n- Head of Household\n- Exempt from withholding\n- Married, but withhold as Single"},"federal_withholding_allowance":{"type":["number","null"],"description":"An exemption from paying a certain amount of income tax. May be null when filing_status is \"Exempt from withholding\"."},"additional_withholding":{"type":"string","description":"An additional withholding dollar amount."}},"required":["version","w4_data_type","additional_withholding"],"x-tags":["Employee Tax Setup"]},{"title":"Employee-Federal-Tax-Rev2020","type":"object","description":"Federal tax information for employees using the revised 2020 W4 form.","properties":{"version":{"type":"string","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."},"employee_uuid":{"type":"string","description":"The UUID of the employee."},"employee_id":{"type":"integer","description":"The internal ID of the employee."},"company_id":{"type":"integer","description":"The internal ID of the company."},"w4_data_type":{"type":"string","description":"The version of w4 form.","enum":["rev_2020_w4"]},"filing_status":{"type":["string","null"],"description":"It determines which tax return form an individual will use and is an important factor in computing taxable income. One of:\n- Single\n- Married\n- Head of Household\n- Exempt from withholding"},"extra_withholding":{"type":["string","null"],"description":"An employee can request an additional amount to be withheld from each paycheck."},"two_jobs":{"type":["boolean","null"],"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."},"dependents_amount":{"type":["string","null"],"description":"A dependent is a person other than the taxpayer or spouse who entitles the taxpayer to claim a dependency exemption."},"other_income":{"type":["string","null"],"description":"Other income amount."},"deductions":{"type":["string","null"],"description":"Deductions other than the standard deduction to reduce withholding."}},"required":["version","w4_data_type","filing_status","extra_withholding","two_jobs","dependents_amount","other_income","deductions"],"x-tags":["Employee Tax Setup"]}],"discriminator":{"propertyName":"w4_data_type","mapping":{"pre_2020_w4":{"title":"Employee-Federal-Tax-Pre2020","type":"object","description":"Federal tax information for employees using the pre-2020 W4 form.","properties":{"version":{"type":"string","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."},"employee_uuid":{"type":"string","description":"The UUID of the employee."},"employee_id":{"type":"integer","description":"The internal ID of the employee."},"company_id":{"type":"integer","description":"The internal ID of the company."},"w4_data_type":{"type":"string","description":"The version of w4 form.","enum":["pre_2020_w4"]},"filing_status":{"type":["string","null"],"description":"It determines which tax return form an individual will use and is an important factor in computing taxable income. One of:\n- Single\n- Married\n- Head of Household\n- Exempt from withholding\n- Married, but withhold as Single"},"federal_withholding_allowance":{"type":["number","null"],"description":"An exemption from paying a certain amount of income tax. May be null when filing_status is \"Exempt from withholding\"."},"additional_withholding":{"type":"string","description":"An additional withholding dollar amount."}},"required":["version","w4_data_type","additional_withholding"],"x-tags":["Employee Tax Setup"]},"rev_2020_w4":{"title":"Employee-Federal-Tax-Rev2020","type":"object","description":"Federal tax information for employees using the revised 2020 W4 form.","properties":{"version":{"type":"string","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."},"employee_uuid":{"type":"string","description":"The UUID of the employee."},"employee_id":{"type":"integer","description":"The internal ID of the employee."},"company_id":{"type":"integer","description":"The internal ID of the company."},"w4_data_type":{"type":"string","description":"The version of w4 form.","enum":["rev_2020_w4"]},"filing_status":{"type":["string","null"],"description":"It determines which tax return form an individual will use and is an important factor in computing taxable income. One of:\n- Single\n- Married\n- Head of Household\n- Exempt from withholding"},"extra_withholding":{"type":["string","null"],"description":"An employee can request an additional amount to be withheld from each paycheck."},"two_jobs":{"type":["boolean","null"],"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."},"dependents_amount":{"type":["string","null"],"description":"A dependent is a person other than the taxpayer or spouse who entitles the taxpayer to claim a dependency exemption."},"other_income":{"type":["string","null"],"description":"Other income amount."},"deductions":{"type":["string","null"],"description":"Deductions other than the standard deduction to reduce withholding."}},"required":["version","w4_data_type","filing_status","extra_withholding","two_jobs","dependents_amount","other_income","deductions"],"x-tags":["Employee Tax Setup"]}}},"x-examples":{"rev_2020_w4":{"value":{"version":"56a489ce86ed6c1b0f0cecc4050a0b01","filing_status":"Single","extra_withholding":"0.0","two_jobs":true,"dependents_amount":"0.0","other_income":"0.0","deductions":"0.0","w4_data_type":"rev_2020_w4","employee_uuid":"fa0dce23-e08d-427b-9b63-5c84dc0e3673","employee_id":12345,"company_id":67890}},"pre_2020_w4":{"value":{"version":"f642dbbd8e13487d589a00f4f81a2199","filing_status":"Married","federal_withholding_allowance":2,"additional_withholding":"3.3","w4_data_type":"pre_2020_w4","employee_uuid":"a2ce2b73-73d6-4e44-a260-e5396a24385b","employee_id":12345,"company_id":67890}}},"x-tags":["Employee Tax Setup"]}}}},"404":{"description":"Not Found\n\nThe requested resource does not exist. Make sure the provided UUID is valid.\n","content":{"application/json":{"schema":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided ID/UUID is valid.","type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["error_key","category"],"properties":{"error_key":{"type":"string","description":"Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error."},"category":{"type":"string","description":"Specifies the type of error. The category provides error groupings and can be used to build custom error handling in your integration."},"message":{"type":"string","description":"Provides details about the error - generally this message can be surfaced to an end user."}}}}},"x-examples":{"not_found":{"errors":[{"error_key":"request","category":"not_found","message":"The requested resource was not found."}]}},"title":"Not-Found-Error-Object"}}}}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-employees-employee-id-federal-taxes.api.mdx b/docs/api/get-v-1-employees-employee-id-federal-taxes.api.mdx
new file mode 100644
index 000000000..681899175
--- /dev/null
+++ b/docs/api/get-v-1-employees-employee-id-federal-taxes.api.mdx
@@ -0,0 +1,71 @@
+---
+id: get-v-1-employees-employee-id-federal-taxes
+title: "Get federal taxes for an employee"
+description: "Returns federal tax information for an employee. The response structure varies based on the w4_data_type (pre_2020_w4 or rev_2020_w4)."
+sidebar_label: "Get federal taxes for an employee"
+hide_title: true
+hide_table_of_contents: true
+api: eJztWltv2zgW/itc7sO0gGU7jnPz0wbbdiYP0wZNurNAEniOySObjURqSMoXGP7vg0NJtuTYTYKiwMyun2xJ5OF3bt85lLjkDkVulV/wwd2S/9ukGejFpRDo3GXuJ3xw97B6aHGJTliVeWU0H/DP6HOrHYtRooWEeZgzpWNjU6ARLDaWgWaYZolZILbZ7QSZRZcZ7ZA5b3Phc4tsClahYyNwKJnRzE+QzfpDCR6GfpEhe5NZHPa6ve5w1mfGMovT6vJt+17faydMhgP2e7XUsIQ09DBHN7AI8nfe4vNonDtvIqU9jm0AGdECfHDHMR2hlCj5Q4t7GDu6974Ux25hzm7Q5xk9raRYN4MxH3ibY4tXajk+WPJet0s/TWvd5MGccZ7wFhdGe9SeRkGWJUoEMJ2vjoYuuRMTTIH+eeUT5IM1lOhDoVl0C3Pe4gV6bkZfUXi+7aAPP9oxscJEtnmLG42f4hA73wIcXVskv30X8Aq1Y7lTehxAZRYjEsx+69OYlCBl1mRovSpcMkXrVGHccmnnrdLjJ0uTKURuLWrPyknMxGGVAmyb3SCG67vyOaEY50riw5uJ95kbdDrSCNcOYdIWJu1UwRVlsLAmScLzjpKYZsajFou3QbW6qkaziZkxb1juaDnlKmuvWnwd53mu5Mt0+vLl6l2lyNrxDVkNSSFF0O4URc+shoTtkSgK+vgugaWMIK8eci9Ttua42SYiUOcppXWNTfjDqsVjlSg9HjoPPnebBe42K+g8SfgT/rvyTKJHmyqNjs0mSkxCxNrAi2FZSjOlpZoqmUPCZipJgj9BS6ZceJpmxnrQnsUgfAiCoHzuQ3DDHEYJWUiYFNvsk0Zm4sG9jtiN0uME6d+vYK1CSX9/QZCk9S8mdzgxSbj5fo5p5llsTcpmyk/ovtLj2tQWG+V+/YyBK6WT9Ssqrc0cQpKYGWiBdWvpPB0FB++21qVmGICERCYsGSxIR2ACrQelGaQm157wF/qS+m32KyzYCBlJZbMJatbwF5nxnu9TkYcAAikVLdvU4vlQutRsM7Uul0mTJGBLwG2+WlEF+CNXFiWZomKbrdjdiyRUlW9VnVXrGWb9jNMfwqwWp4rY/8CuB3Z9GbvWmrP/Z3YNzp97C7sp51n1Lzf9GROgGdELOk9K1TipZExviCHDQpjIAguCmBDFigmKx+BpPzPDr2bUcMLImARB7/dCCBiLDCwyo5MF8zPDSAp7o9rYbrGFyYPBFya3zGVkmmLtCUyRAY1tUdNO48ItPzNvi2mkl0PPVNCAGumAU2KGWqL2bljo9xqzsfXsEAIsQ+soVkkL5idQdLEe5hks0BKwEvNsYhjqQLKuOcYbJhJQKYO1cLHYFLOAOcgfFoH0CrifAqyy2q2rCY2SuaAxr8mYd+tJ2+o6D1qClWwtl5SydIH1oH1FJWum9a5YrwXcLp9u2ayh8/P1kJRXpHyqNHhjyUxlTVp8BPLBNuAUsqxMwXoD+Mwe67BlORTVv0BRPWxZDluWv92WpdEKPsezhw3MgWv/Glx72MAcNjCHDcxhA/NjNzCEcx7hHNIsKWrQVrWcQpJjozbxk1Pon18IPD9FeSqORt24K1CIfvekC91R9+iJVgNeNkU7U5l32926kuWnrB3RW45sxkh5s+7p8laTkRuKPSlOPIauFNg7jrB7LqN+72wUXYxOj6MTcd6XoovHp2fHfKsOHfWO+yfNSnJ6dn7RJaNube52mDE+7ffkaCTP8ei4f34mT84voNuN+/H5EfSOLi52mLHkUP5sb9nb37rx4/bxU+PU4T41DvQE9kZnx9HZsTyN+tjvR9A77UZ4cnxxCr3+8fnJ6OXGWb0gKlct3u/2n36+/Gg8+2ByLel7a/G9MPA5SvpyaHIrkEmDjmnjGc6V89QGPyJz9CWx2PGaqZIoi15DOTaFRMn2vX7N99A9oNi9Zux7cV296zSh7WhG69SC1hobcr3ZTJb3N60IWAsL3uLKY1q/v1/q8BFpggCPY2MXe9YIo57teG4yFCpWoQfBUucwnRkhcuva7HaRKQEJ1UZqJB9xwRQRQDGLxoP3Vo1yj50MLKTU1jCLCZCZqfJVIosGr0L9CmihXtEnZROXksJH6UpU5SRXIh9bk9PbHBcqN5XhEVLnFNCMcpVIJqi9TsvxE9CSMprap1Dna0cAAuYUnYPxC/rH6wqIRA8qcQxGJvc1o0ZsjJooojJnKbpC6XIbgyiQ0kd4LQk4WW61oyho44cxRXg9sO4a/udlxNfjZVCbWFOO70mQGRT5ESa0+eqBgFTbtY/GRyHJove0aPSpiNoSLgVlMOMV8dUYfTQ9itYbsajGTFHjUAZtwapQKlTSxWu7/0Y/h+MVl9dX0X/WxVuR7ScIMuwRaucjtpxVNfG9bu8k6p5GRydFmxFDnlAhq91fPW0/1t06uVOCx6g4+3B5fbXeNIBzRqgQ+UTvRTjRAMqgNruKmTYaiUQqYmkVY2rE9pNjd6nSKs3TuuxXbhAhU9Fmj/nPUmBUu/2WYFBaUIyvLdwsMqVtM/CTF+8MG5RVdA37XLJahV7IZQiPCG4RhdStobiFeVF9msMIa2SmaK2SWERWufW/LcMH5x61KxqPuyUvcmHvEZ9W1QnUj/qQUZrzikM968GkW33QthrrgU/V2T2tqdZm+rZ6ZLUU/cSUWRXShQ5i8c70qLPOr86y4cxVZzvHHNpplWC5TSiJyhCDTBURFklMQ5g9cf87TM2WWwp5UWhOaF5Qc4/gnTKvrZHfkJnRY1K+OpB2Q3FVcOGOY2nraKPFK2Kg6xGC3fE6oRQRJTjFhEHuJ1TmiqQkQrhZOI/p96xQSNizwIqSLTb1l2GB7IgEKBjWLWqNplqcWMl9im/QTpXAmqU3BBGKUCcM7Ehammg5CteRiYOFaeo22N8wKV5aGhZw/OTY+zI52HVBNYGfpBF5itoHNf5R9msgQr9Wksq7alX2mfqCkJbUmIJKQqiUT/+1iYzQrBvnU9A1OT+jrx8oRLd9Wm1bieWmefz7nUgsY8vj3HeyBFQIwpBOyzLf7/j0qNbhk1EH2wTeTPqHFp8Y52nqckkqfLHJakW3/8iReoO7B+Idq+jVUSAGqRz9l3wQQ+LwGwZ+87mk/bfsG7Vhp1ZVL6wXNdrjrZIjmyqt6L1bWe1fB/B/uobvsWxhwd1909rQm3JE7Jb52rMnO65G8fn5/S19BWiS4Zr8yj/h5OcuBy+XxYhb84h6tVr729N1aDRXfwKiL52N
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Returns federal tax information for an employee. The response structure varies based on the w4_data_type (pre_2020_w4 or rev_2020_w4).
+
+scope: `employee_federal_taxes:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-employees-employee-id-garnishments.ParamsDetails.json b/docs/api/get-v-1-employees-employee-id-garnishments.ParamsDetails.json
new file mode 100644
index 000000000..d046850e0
--- /dev/null
+++ b/docs/api/get-v-1-employees-employee-id-garnishments.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"employee_id","in":"path","required":true,"schema":{"type":"string"},"description":"The UUID of the employee"},{"schema":{"type":"integer"},"in":"query","name":"page","description":"The page that is requested. When unspecified, will load all objects unless endpoint forces pagination."},{"schema":{"type":"integer"},"in":"query","name":"per","description":"Number of objects per page. For majority of endpoints will default to 25"},{"name":"X-Gusto-API-Version","in":"header","required":false,"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.","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"}}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-employees-employee-id-garnishments.RequestSchema.json b/docs/api/get-v-1-employees-employee-id-garnishments.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-employees-employee-id-garnishments.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-employees-employee-id-garnishments.StatusCodes.json b/docs/api/get-v-1-employees-employee-id-garnishments.StatusCodes.json
new file mode 100644
index 000000000..c7abd1b09
--- /dev/null
+++ b/docs/api/get-v-1-employees-employee-id-garnishments.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"Example response","content":{"application/json":{"schema":{"type":"array","items":{"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.","type":"object","properties":{"uuid":{"type":"string","description":"The UUID of the garnishment in Gusto.","readOnly":true},"version":{"type":"string","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."},"employee_uuid":{"type":"string","description":"The UUID of the employee to which this garnishment belongs.","readOnly":true},"active":{"type":"boolean","default":true,"description":"Whether or not this garnishment is currently active."},"amount":{"type":"string","format":"float","readOnly":false,"description":"The amount of the garnishment. Either a percentage or a fixed dollar amount. Represented as a float, e.g. \"8.00\"."},"description":{"type":"string","readOnly":false,"description":"The description of the garnishment."},"court_ordered":{"type":"boolean","readOnly":false,"description":"Whether the garnishment is court ordered."},"times":{"type":["integer","null"],"readOnly":false,"default":null,"description":"The number of times to apply the garnishment. Ignored if recurring is true."},"recurring":{"type":"boolean","readOnly":false,"default":false,"description":"Whether the garnishment should recur indefinitely."},"annual_maximum":{"format":"float","readOnly":false,"default":null,"description":"The maximum deduction per annum. A null value indicates no maximum. Represented as a float, e.g. \"200.00\".","type":["string","null"]},"total_amount":{"type":["string","null"],"format":"float","readOnly":false,"default":null,"description":"A maximum total deduction for the lifetime of this garnishment. A null value indicates no maximum."},"pay_period_maximum":{"type":["string","null"],"format":"float","default":null,"description":"The maximum deduction per pay period. A null value indicates no maximum. Represented as a float, e.g. \"16.00\"."},"deduct_as_percentage":{"type":"boolean","readOnly":false,"default":false,"description":"Whether the amount should be treated as a percentage to be deducted per pay period."},"garnishment_type":{"anyOf":[{"type":"string","enum":["child_support","federal_tax_lien","state_tax_lien","student_loan","creditor_garnishment","federal_loan","other_garnishment"]},{"type":"null"}],"description":"The specific type of garnishment for court ordered garnishments."},"child_support":{"description":"Additional child support order details","type":["object","null"],"properties":{"state":{"type":"string","readOnly":false,"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."},"payment_period":{"type":"string","readOnly":false,"enum":["Every week","Every other week","Twice per month","Monthly"],"description":"How often the agency collects the withholding amount. e.g. $500 monthly -> `Monthly`."},"fips_code":{"type":"string","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.","nullable":false,"readOnly":false},"case_number":{"type":["string","null"],"readOnly":false,"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."},"order_number":{"type":["string","null"],"readOnly":false,"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."},"remittance_number":{"type":["string","null"],"readOnly":false,"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."}},"title":"Garnishment-Child-Support"}},"required":["uuid"],"title":"Garnishment"}},"examples":{"Example":{"value":[{"uuid":"4c7841a2-1363-497e-bc0f-664703c7484f","version":"52b7c567242cb7452e89ba2bc02cb476","employee_uuid":"a6b53294-f871-4db2-bbd4-8c3d1fe56440","active":true,"amount":"8.00","description":"Company loan to employee","court_ordered":false,"times":5,"recurring":false,"annual_maximum":null,"total_amount":null,"pay_period_maximum":"100.00","deduct_as_percentage":true,"garnishment_type":null,"child_support":null},{"uuid":"4c7841a2-1363-497e-bc0f-664703c7481a","version":"52b7c567242cb7452e89ba2bc02cb383","employee_uuid":"a6b53294-f871-4db2-bbd4-8c3d1fe56440","active":true,"amount":"40.00","description":"Child support - AZ28319","court_ordered":true,"times":null,"recurring":true,"annual_maximum":null,"total_amount":null,"pay_period_maximum":"400.00","deduct_as_percentage":true,"garnishment_type":"child_support","child_support":{"state":"AZ","payment_period":"Monthly","case_number":"AZ28319","order_number":null,"remittance_number":null,"fips_code":"04000"}}]}}}}},"404":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided UUID is valid.\n"}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-employees-employee-id-garnishments.api.mdx b/docs/api/get-v-1-employees-employee-id-garnishments.api.mdx
new file mode 100644
index 000000000..1c2d5b92e
--- /dev/null
+++ b/docs/api/get-v-1-employees-employee-id-garnishments.api.mdx
@@ -0,0 +1,71 @@
+---
+id: get-v-1-employees-employee-id-garnishments
+title: "Get garnishments for an employee"
+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."
+sidebar_label: "Get garnishments for an employee"
+hide_title: true
+hide_table_of_contents: true
+api: eJztWm1v2zgS/is83gG7BSzbcZyX+sPhgjbbzYfdFk17e9gkcClxbLGlSC1JORECA/c37u/dLzkMScly5KTpyxXYxfZLaoqa12eGM0Pd0ptkWVmnE6EcLA1zQqvE1SXQ2QWFIgXOgdMBZWXZ3WLp1YA6trS47QUzSti8AOX8eskMK8CBwae3VLEC6IxCUUpdA8wF0hOKzmjJXE4H1MBvlTDA6cyZCgbUZjkUjM5uaRCEWmeEWtL1gHKwmRElikBn9E0O5O3bs+dEL4jLgTQs6Hpw26fixQeDZDz33yowNR008pVsCXQXB3xAXM4cEZagrGAd8CH5JQdFKmVLyMRCAB+QayElkZpxwqQkOn0PmbOkUhKsJaB4qYVyZKFNBhbJCuWNOfw8ecH0xP25KlIwaI6GeQnGKzAkP2hDCvZeG+Fq3NHIY4PYHBasko44TSYHXqDI51/JCw+Qk1dnyT/BWOQUJcqBcS/FxoMLJi3cFes5gqEQCqx3E2cOkpRZ4OTk1RlZBaKEWaszwRxwci1cTmpdGb8hY1IOydmCKK0AnVAavRIcLe73sLKUIvOm/M6Si0IoUVRFl/bV97lzpZ2NRlxndugRP8x0MWoQnpSsNlpK/3zESpHEN4Va/jUSTDrLT1CMygIf0vvxOqCgqgIjZDKeHCTjw2TvAOMjmprOuuvr9RXa0ZZaWbBIbDIe459tU57esKKUQJqddEAzrRwoh3s7lhi9t/jCDlwxYxjiSDgobJ9DN5oHRJs2qggHXmU++geEGSALcQOcsEJXiCJtEGwZKMeWYONm4GRhdEGYasn899//QfDXQ/Imh5pkTJEUNtsZiQGVEdWi2YkCPAeECTGQVQYtTFJmhR2SrsieIJNWk5ytgBTsxoNhI3ugUQMzso5Co/eTEozQHEmCHZJnuii0QhdbDFiy7LJA5TNdGZdow8EAR33CI9yb5UJyYquy1MYhi5RlH4hjN0j4XBf4clEyJaCFMmYNZTH4XA5iY3MbEg8yNFAywclKsC1hEIDRsSHm6YCWRpdgnAg4qirBd4Hz4Vza4UGEIj4HDH2oM/5SyTok6/WAxoh4HAd0HFJsYj4yC5IPyTmA/32xiT6yrASHTwxgwaEotQOV1U+8S4RaaFP4wED/5/oabV1ZZCcsWQiQHNPw5pT6PKu1seI0uc5Flgf6XWOmILVa2p22ZJkTK+iwTbWWwBTtJI1wRm6L8UsOLsdQMURp1+cpbGN5WZPAxGsbYneXmsFcdEYXUjO3JevOFI+GCNR2AGhIToWXj3VSBArLYg7hWkpmIoEheQ2lAQvK5wOLu1CIAYHhckgu6fFwPL6kw1490NfiEUJ3VnZJjkx8qM9jqO90zkf4NO7pxZUNaYRE2p6bz3UbLhdtHTCgqpKSXu1kF8GBO3ZpeTeVOu1PzbrvqbOl0pjRxKKTZ4UlCDsvX7v6WEtE0T7JMjbXleRBAiIUh4VQwoGsA2yVqpicx9yOcjwGrh8xUe+k8LUTsiqG5ITga2TFZAUoDx6yYInSzWsfBe1kPI6wHbSebXEaHIvO147J+d2w7O18XHw+oPBJq67n2FEasyV6Q4oFIFZCUGznk8fYA/1UsnoejtWurx6v02f6rGQ1CWy/huP2DrvpBvnMmZ1v8tjXDoOYRWMEpECcAdbK1smfTm8VTnc0R3E7LpsHEW8pU/XLhe/L7itWffkyj+ULHgXAwTA5d+xmLgWgetYxB9sLFUcuWMZgSWqAC6fNvCNBh1LcpVHnrS1X2HdEuTwq1le73N5WiLgVAdpNHb4C62bVO+USJvQtDXsV8AnnAv/LZK+U42AIB8eEtJ04bguvBsnbBZi31mceT+5aEwnOgSGeDGFpamAl2FawhkfC2gqzNa7sEHxITpZYEWH/xTClsxUTkqUSA8O/9O7F6RsyWu2NuhYbbVnrHbZVTXB7YAW8PUq9BmGnKzA1uQb4QAfxh8dCs/TmWmTgAV1o5UcEP+FfWdMeHH7U10QvHAQFWFAw01L67hfXsJfMteRomabA8KH9t4PxODCQNUn+Tt5FJu+8egtR2nmm+U7H9f30w9mrc4Lbe23sxj8BmMrVjZzf0GEBm/hu64077sG4YBbmoVR4MFF/BLfPvCrnUZVT5QcePjafMQskDin6dsJyaNsKqRTLgPSENDMGD/pCWxesalsrtVkh7tz0al8GdO+Lr2CWlz57nGGexHmRr9bj2vMvs4bFnvIbWcNAIZxjKvv/IuV1y+Z3ZB1fvTsMse4UJfFaJlFLv2szL7sI7fnVzjf9XggTH3+SxOkP/tdXNP4cD50qnWZHx9M9Nkn29g/3k+nTI0jSbLxIDg+nR+P97Gh6PF3QTrtODybpUXZweDSZTrL0aHowgeOnKZuk2XiSpdOjQ9rrhik7TA/2J0+nyeL4aC+Z8nSSpCmfJsfZPt9bwMHhdDqmmzY2tKpNNev7tl7yfOZHIbUfgGBJ085we31XRFDsjw62OpH47G5jEOrG7aI6rO0qTemer9HpfXVeUKdfVAWKd4oKXMRq5tHe2WOP987+8f5X9850vNM9W0GWkJNfJ8f7e0/73gnUonOCRTr+iby+zD3Tz3NPr6DtlX+xQKMnv9J+XdPWHnfOR7oxxfYJ0Sjfy5PhQaewoOPpeDzG0e8a/w3odDztl6M/a0d+0JXi5FIRcqmw3GivIXAQrCuTAeHa9zWOwI2wbkh+Yh+A2MqEiVozMg/TKmGxIxJ8eKl8jsFq1efOM1R4CS5Z7SXtDDLpXN0k3SzYQ8ufs+Pf1+z4Ul0qm+kSZuRd98EMz+13dEBvElsC+wDM1gneByV6BcYID14pLEYT3DhQ1t8J4mn0AWo6u/9WcdAeXA/fLmLqbEjdJ0JLK4iCvWIBLtcRwz6WXU5nFE/v1iqj2w6c16M7eLZgVs3FZWUkXnLFwTMrRZg7JxwKP3zuwf85FPqO0QK9xOdnfM/frN1DeCfNV0bzB2iW+Bg1twhs4WoveTxUT7IMrD2p0AgXV91d53gpFGqKHXvbhgdFbC64/IADmNlx7RhJJBJWIAmrXI41briHwprxvLYOii/hECjcw8BfkC60p9oUUWhPrMq2ztTOdduA4pWkfbk4B7MSGXT8sblcYKmu3MhvHHFkjXky8b8TvfB+wFd70xyQGUaq0+Ha5DtLTiPWyatwTeEvJ7nOKsSdV+Mv8SaPZf5Iipevzxuu5DXIGBt48DMhPaDi039s8IPWKLV1BVMdOi/AbachzDWdxHpXh9vNreKfSf2PltRj6Dm4caNSMuFj1Oek25gxL+hqr1NgIuZm299vbKXNqwHNtXX43u0t2uutkes1LodvFjAlcWGxq7rnE4Eu3r7RNxf32CEcOvFjkOZ88Vn78Rp8tc8wHpbR58mNiFf4w4gw4/kki3//OvajT8i9n9TcI0rzTYGqu7I0InYxs8b7jfjFyKeJ9wf/fOQBF+/+9mYLlWEjnq2l6zzrfQmyVR29OH1D1+v/ASu5YmI=
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+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.
+
+scope: `garnishments:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-employees-employee-id-home-addresses.ParamsDetails.json b/docs/api/get-v-1-employees-employee-id-home-addresses.ParamsDetails.json
new file mode 100644
index 000000000..fc5537e46
--- /dev/null
+++ b/docs/api/get-v-1-employees-employee-id-home-addresses.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"employee_id","in":"path","description":"The UUID of the employee","required":true,"schema":{"type":"string"}},{"name":"X-Gusto-API-Version","in":"header","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"},"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."}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-employees-employee-id-home-addresses.RequestSchema.json b/docs/api/get-v-1-employees-employee-id-home-addresses.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-employees-employee-id-home-addresses.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-employees-employee-id-home-addresses.StatusCodes.json b/docs/api/get-v-1-employees-employee-id-home-addresses.StatusCodes.json
new file mode 100644
index 000000000..a394d636c
--- /dev/null
+++ b/docs/api/get-v-1-employees-employee-id-home-addresses.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"successful","content":{"application/json":{"schema":{"type":"array","x-examples":{"success_status":[{"uuid":"d6b7472f-bb55-41ca-a55c-9adbd3c64e09","version":"7eee445be93fc50fd3cbb55b8d943fb3","employee_uuid":"d1a166b4-79b4-413f-b067-27534ec59ecd","street_1":"3121 Milky Way","street_2":"","city":"San Francisco","state":"CA","zip":"94107","country":"USA","active":false,"effective_date":"2024-06-09","courtesy_withholding":false},{"uuid":"1b59a593-d324-4d97-9296-99ecc95f81d1","version":"5147ad755821c4ba3dbc3afa1055ff4d","employee_uuid":"d1a166b4-79b4-413f-b067-27534ec59ecd","street_1":"3624 Victoria Ln","street_2":"","city":"Cincinnati","state":"OH","zip":"45208","country":"USA","active":true,"effective_date":"2025-05-26","courtesy_withholding":false},{"uuid":"69489b54-976d-4027-8b51-702e5c8c62d3","version":"f0765fa5a85f62723320763494a481a6","employee_uuid":"d1a166b4-79b4-413f-b067-27534ec59ecd","street_1":"Main st.","street_2":"","city":"New York","state":"NY","zip":"10011","country":"USA","active":false,"effective_date":"2025-07-09","courtesy_withholding":false}]},"items":{"type":"object","x-examples":{"success_status":{"uuid":"700af712-62ba-4dff-824f-97a3c6fda416","version":"6c3c23e4cc840bd3f1416f72b5380eff","employee_uuid":"78d20691-f1b4-4f74-bc4c-1d4db0099b00","street_1":"3121 Milky Way","street_2":"","city":"San Francisco","state":"CA","zip":"94107","country":"USA","active":true,"effective_date":"1970-01-01","courtesy_withholding":false}},"properties":{"uuid":{"type":"string","description":"The UUID of the employee address"},"employee_uuid":{"type":"string","description":"The UUID of the employee"},"effective_date":{"type":"string","format":"date","description":"The date the employee started living at the address."},"courtesy_withholding":{"type":"boolean","description":"Determines if home taxes should be withheld and paid for employee."},"street_1":{"type":"string","readOnly":false},"street_2":{"type":["string","null"],"readOnly":false},"city":{"type":"string","readOnly":false},"state":{"type":"string","readOnly":false},"zip":{"type":"string","readOnly":false},"country":{"type":"string","readOnly":false,"default":"USA"},"active":{"type":"boolean","description":"The status of the location. Inactive locations have been deleted, but may still have historical data associated with them.","readOnly":true},"version":{"type":"string","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."}},"required":["uuid","version"],"title":"Employee-Address"},"title":"Employee-Address-List"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided ID/UUID is valid.","type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["error_key","category"],"properties":{"error_key":{"type":"string","description":"Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error."},"category":{"type":"string","description":"Specifies the type of error. The category provides error groupings and can be used to build custom error handling in your integration."},"message":{"type":"string","description":"Provides details about the error - generally this message can be surfaced to an end user."}}}}},"x-examples":{"not_found":{"errors":[{"error_key":"request","category":"not_found","message":"The requested resource was not found."}]}},"title":"Not-Found-Error-Object"}}}}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-employees-employee-id-home-addresses.api.mdx b/docs/api/get-v-1-employees-employee-id-home-addresses.api.mdx
new file mode 100644
index 000000000..60cc7cf5b
--- /dev/null
+++ b/docs/api/get-v-1-employees-employee-id-home-addresses.api.mdx
@@ -0,0 +1,73 @@
+---
+id: get-v-1-employees-employee-id-home-addresses
+title: "Get an employee's home addresses"
+description: "The home address of an employee is used to determine certain tax information about them. Addresses are geocoded on create and update to ensure validity."
+sidebar_label: "Get an employee's home addresses"
+hide_title: true
+hide_table_of_contents: true
+api: eJzlWF9v4zYS/yo83kNbwIwlWbJjP12wu+0FaHcXzW57RTZIKXJks5FIlaS8cQ1/98NQsi3H9ma3V+CAu6c44nCG85v/s6amBsu9Mvpa0hmdg2fLmEFVl2YF4Ha/7pVkC1PBPZfSgnPg6IBKcMKqGm/TGX23AIIkpCMhpiBcky0HohxpHEjiDZHgwVZKAxFgPVeaeP5IlC6MrcJjCM9N44lfQHVBrrYiCbdA5mCEkSCJ0URY4B4I15I0tcSf3hDQrrFAlrxUUvnVxQf9Qd80dW2sd4cPhKIA4dUSiORe6XlgJExjPbgV+aj8YmFKqfQ88HDC1DAjv+7AmVng8lc6oJ7PHZ3d0ldbVXcvpncD+sjmjfOGKe1h3mLN/KoGvAFVDlKCpAPK67pPEq7W3PIKsUL2a6p5BXRGezahA6oQ+5r7xUmDvH9//RIN4RewswQdUAu/N8qCpDNvGxhQJxZQcTpb0/Zl1Hmr9JxuNoOd2H+x74IeV2+v2U9gHQrpxC+AS7D0PJ8BBd1UqHESJRmLxizOUEEJBW9KT2f975unirzcuosLeqChWc7Rl67eXpNl+xbCnTNCcQ8ymI6sTGMDgeBleUGuC6KNDm5YW7NUEuSgpeF1XSoRUP/KkdtKaVU1VZ/33dcL72s3Gw6lEe4i2PNCmGq4tR+r+cqasgznQ14r1t1Uev73jiHrff5mGw0XdHM3oA5EY5VfBSu/MFXN9epKCHDuqvELOru92/QcybqPfL61nAVXG42uNlvTJIrwzyF6rgmciqakAyqM9qA9UvXUHv7mkHR9bD9uLV9RlA2PvKrLVk7H8t557pvWN5tGYQKR43ySTpKC5XmWsTQWnPEsE2zKZS5HYpxCNKUD2sFAZ3QCAGma5TAdFSKLCjkSeDW/lNN0VOQjdJ2tv29lxDwej/OUTaZ5ytJ4VLA8Gk9YMslGKYhsCgIDw3kL4O9jOqOjOInJD6p8WJGfgzrdWUJnFEEJ0NMbrsm3lmuhnDCBiHvE4MUVHdA/VE1ndJrG0STA2Ghv8dL7GzzlIY3QWcFLBwO6Syz3smWRREmK3h2U32aY+16G6a5iuHVaxnk25dl0xOQoSVkqpxM2TaZjNp2CENOsuIxlfIBkFqcTLidZdpnEIs35SOZixAseR1lWFKn8a5AcJyn5SQlvrOLke30OyxdKC6U196oH5Jt/7oBMsyS6/ASQrXOfwjFjUcaS8WfjOJ6ml9M8S9l0MpYsjZIJu8yzmE2iBDJxKcaJHB3gWESTcVbwjF9mxTiZJKNREk3Go3Sa8vQy5uO/BMcfsOg5f3EOv9fwkfxi7EMPvde/7NCLoyiO/5wbZiyaPO+Gd5sBVR4q10sFJv8NhH82F+yAn0QRLyZxwsZJzlkqi4JdJmnBphM+EuNC8jQeHwA/FiORjCAV4jKNcjkq4jQeF5Mkz0aXERTFCeAnlzKJxtOYFTECX0xSlotUsFimMo+i6TSPov9SKjjjwfF0ErEoZlH8jAk2A1pb7M68gh6sx5X184r+tunB6voExT/LMrB6ot8xr7anwyBBglO828at/1bnucU6XqplaMtCJ7jV4ALlnkZuJz03pgSuj8T1OglVtM2g54/giFuYppQkh7btg1KGZrDmSpLC2N3TgvC9Ox2riz3hG12udomo52Bb6ts9uW7KEhuh42utJ36egDPQH5MG1/0cwp1XP0vcb+IwAjb7EHjWHGj9Nm9sfas0bUdyQa51y2b3yZEFXwLJATSRUILHBi5vPKn4ijivyrIlWCiH1UnwEj2LH/WFYag40ANDddPLRJ8TEKKxFrTfdZ/d+9skeUFuoHXp230fSOaNkvCFraSSUNXGgxarb4Ij9ocko8nCfMSZp3EoTjlSKCixqdz0e/zbNnfsNbwbUK98iSpuZxZ2tc8P587Y98p5utkg9zRKj1vN18aTb02j5Zd0mmdYkA+akA8asUZNwKEBLTjTWAFEGnBEG0/gUTl/QX7gD0DC3Ieobxt8cv1yGDKXcu08iHZ/Ws76OIG1xraj10Hu7b4f98Vni+QR1/sHwAuCe5gbuzojI1A964A3NQhVKHDk4wI6ncN1YoRorLsg71Y1RkC5at3iAVZESdC+vRWyqfdW5Y2H4W7KJBbKECfe7Fm26Xb76i94GnJAWgyNlhMJgdOx2hrJdS+fW9PUSs9dO4Vzjcl4uzDIG1VKIjBYqo5+wbUsMayUbse43vAc3lyBc3x+MjEePvnt9iESPFel2y8fOlGMzEGD3cPZsd6+0jW24KJ9KW48cB3hAJFrY+WwYdLG3xchSHqOdXtgf9p5fN9fZr2LPeXomQD5yNv4CBdwytz0Avu18SwEGXuFQtmb1mt3z3U18AfgbsWCVXo7h6ve+qdPhzsCZpZgrZLQLpKwXXv0oF3YZqCGrW5n9yEDuuRl8/xeBJv7Q1btRLy73+bzPdFTdXaEJ9Q6fe9Qvf19VBNH8wr8wsid3mEdM6PDZTzcbYuG697eZjM8WqY5sMvtoqexJW5VukLBa9XWCSahCsXiRF9TmScWafmxdj7B4zATnWZ8kudba+QneNZ43F9e3GBGb138xApjF4QofLspCr0BcBt2R4fSOxashCWUhDd+gdmrLSIY3Tcr56H6TyS0HM4IwPlHFyZw7YImbL9wK3QwtPT2VgOKzaV7U9yAXSoBPaT3ZT7klmEgHEoUjSWAhf+ZKQLCePXpY3+GUoRu1ZDwjq8cedXFCHnbNgxhYSWNaCrQPqjxt64McxHKcLfHe7mVSn7EdB9iCmcCrsrgKt3pP/aeEWYR43zFdY/Pd+D7+92vDperxwvi9b4l+H/eFbc+6uHRD+uSq+DMISzXXdq4pcu4N+oijrPDle+T3HGHX5zHm+s17kXf23Kzwc+/N4CV4/YOM5ZVPEdHvl1TqRz+lr0W/oyhvv6x62O+IZ9YJ59Uatsp6VUvYdJBl137GoV1Q7dD/rLn/U9vhs/g2uJ3ehu/g3lfxjBF1r53dtSNHxSw7169w6J7mFF3GbT7gUY6ad71uqV4Zx5AbzY7a3v8PzQhm38DtCYN2Q==
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+The home address of an employee is used to determine certain tax information about them. Addresses are geocoded on create and update to ensure validity.
+
+Supports home address effective dating and courtesy withholding.
+
+scope: `employees:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-employees-employee-id-i-9-authorization-document-options.ParamsDetails.json b/docs/api/get-v-1-employees-employee-id-i-9-authorization-document-options.ParamsDetails.json
new file mode 100644
index 000000000..230d65c22
--- /dev/null
+++ b/docs/api/get-v-1-employees-employee-id-i-9-authorization-document-options.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"employee_id","in":"path","required":true,"schema":{"type":"string"},"description":"The UUID of the employee"},{"name":"X-Gusto-API-Version","in":"header","required":false,"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.","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"}}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-employees-employee-id-i-9-authorization-document-options.RequestSchema.json b/docs/api/get-v-1-employees-employee-id-i-9-authorization-document-options.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-employees-employee-id-i-9-authorization-document-options.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-employees-employee-id-i-9-authorization-document-options.StatusCodes.json b/docs/api/get-v-1-employees-employee-id-i-9-authorization-document-options.StatusCodes.json
new file mode 100644
index 000000000..d1ba5a437
--- /dev/null
+++ b/docs/api/get-v-1-employees-employee-id-i-9-authorization-document-options.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"Example response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","description":"An employee's I-9 verification document option based on the authorization status","properties":{"section":{"type":"string","description":"The document option's section in the list of acceptable documents on the Form I-9","readOnly":true,"enum":["A","A1","A2","A3","B","C"]},"description":{"type":"string","description":"The document option's description","readOnly":true},"document_type":{"type":"string","description":"The document option's document type","readOnly":true},"document_title":{"type":"array","description":"The document option's document titles","readOnly":true,"items":{"type":"string"}},"common_choice":{"type":"boolean","description":"Whether the document is a common choice for I-9 verification","readOnly":true}},"required":["section","description","document_type","document_title","common_choice"],"x-tags":["I-9 Verification"],"title":"I9-Authorization-Document-Option"}},"examples":{"Example":{"value":[{"section":"A","description":"Foreign passport","document_type":"foreign_passport_w_i94","document_title":["Foreign passport"],"common_choice":true},{"section":"B","description":"Driver’s license or state-issued ID card","document_type":"driver_license","document_title":["Driver's license","State ID card"],"common_choice":true},{"section":"C","description":"Social Security card","document_type":"ssn_card","document_title":["Social Security card"],"common_choice":true}]}}}}},"404":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided UUID is valid.\n"}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-employees-employee-id-i-9-authorization-document-options.api.mdx b/docs/api/get-v-1-employees-employee-id-i-9-authorization-document-options.api.mdx
new file mode 100644
index 000000000..9136f68b2
--- /dev/null
+++ b/docs/api/get-v-1-employees-employee-id-i-9-authorization-document-options.api.mdx
@@ -0,0 +1,71 @@
+---
+id: get-v-1-employees-employee-id-i-9-authorization-document-options
+title: "Get an employee's I-9 verification document options"
+description: "An employee's I-9 verification documents are the documents an employee has provided the employer to verify their identity and authorization to work in the United States. This endpoint returns the possible document options based on the employee's authorization status. These options can then be used to create the I-9 verification documents."
+sidebar_label: "Get an employee's I-9 verification document options"
+hide_title: true
+hide_table_of_contents: true
+api: eJztWF9v2zYQ/yoc95AWkOwkSwdET3ObtvDDlqBpugGJ4TLi2WIjkSqPcuMZBvY19vX2SYajKFm27KLtHgYMy4MjU7y7H+/P745e8cd4XqEzsdIO5lY4ZXTsliXw5JZDcQ9SguSTiDsxR1obx+fsHVg1U6nfTO8sYGk0AvJkxU+Pj+mfBEytKv2WhL98FEWZA2t28oinRjvQjvaKssyDuuEHJIEVxzSDQtBTjYYLa8WSR1w5KLCzbu4/QOp4tGNxpBkUZW6WAEfICPWig5pJk1YFaMeMF2D3AkEyo5nLgInKZcaq3+ut6ISrkEe8tKYE61R9ToS0NtUiQWeVnveQvM1g19wRsiDOVG0yV+iYmTGRplA6cZ9vZLCB9crYgk7CyeNCXup8yRNnK4g46Kqg6Ix4xEcn9HFKHz/wiD/nEX/BJ+sdWN+GurtnFwVZCALTWvc32mhWvPBnrSiXw54U+TorpAT3+HQ30cIh1mvK3aIweppmRqVdAPfG5CB0D8KvGbgMrI9ia1ghE6zWxGpNbGZsL1X7HljTysdKWZAU8yYRt43uBqPntt1TTCL+GH+uyoO3+fg8HnULJL4IiuPL2jQBhLrgvf9C8dPjQuQVUUunfHzObrvrlbGg5pqVArE01vUOk/BZvWXabJl+mqrzs/4pk9u+tkkvgHVidUE974G6sGoB9q8//kSWqxQ0AjPWkwPECrECycYXLBVW7oErvfA0CO6FWes/arXziF+T8lbrl8B+0YN9bVIlcnYNaWWVWx4CiKinvVcNtL06DsCZrOkv4mfHZ/028Itx7JWptGR3mrE7TaVJqQzoQFJzMJVNqUQAmTaOwaNCN2A/iwdgWFnwBVRas1ASJLu5GV9QFS1EruTgrk48omiflmPJEz4HFy9O4qYTYPs0VTJW59Mtpo/bk9csgd/aVJCJgLWzshFlmcDNKWhbeGOZM7XGJS0ry5QE7cjlQsudtuQM+2TsQ9NAbrQiH/qUwQF7mylkoGVplHbMgqusxtp9BlF1+0vgRNzugZ1z7muHZAGoBIJsKryYZvfAKlLjDEstUP6StsOuGtzpO42pKSFh73cjgglR33vqvcKKAhxY9OyhRUFZ24kmTQYUolK4jHcJsibz3jjRsPm+buETy8y2/MCp0ILZ3+LXfmYaXY3jd2Cx5ltvPgMhwW4BmIkcoccmdJZCaaiDIolFav+PrsbkKlLKBCKVHgX2k3IZW5rK+g2pyPMBG8+YNhqoBpp0iuo9nYnqCNltobQqqqKre/Ikc67EZDiUJsWBHwIHqSmGzdAXl2JpTZ7790NRqjhIKj3/PiiMO8tPCQaFfsAPu3szqZwenz6Lj3+MT54Rk0iYiSp3POmur9e+J2EJ4gEELuO5NVXJE67O3203yO4milFsFmCtklBTQNOgLtuyhkcHGv0XSqcHWPLk8CgctX2rMxJTPjRyuxBbgV2o+4W2IW+E90AnlxTgMhPYzZeGy3jCh4uTYctzw1WnNNbD3boa7mE6BLtoyquyOeVySBBRqjo/YgmFT5J+c4TC7MSh1hcrAkpy/uwHFO/VeWWN/IzOkl6TOzC0JY/8hSlKoZejNAVEGlN4cjvp7rqmzKznkj1723wliE0e+8kOhPV1vY0xqIhzWEDuiZL4ug02v16ig+KfWKg1HDCwJtaZGa81TGeemajQKY8CN21VVcSJefBydg124ft2G48NCYh7U7mh3ziUZJraauy/x2bm40CivTkX8tQUQOTvcRwhexkKhl3VdOI5qEk/f4zvwmVQpP4yGDj2orHK3kAu2rothMp9QoW3P23yh7xRGnSF0B09r8F1e+8X3AV7bX+1uav+PwH8axNAKBsHj25Y5kL5+vJ8sgoUeMsXJz5HAgnyiCc7E8KO9u602wR/EvHMoCN1qxU55Mbm6zUtf6zAEstMiKGtoku65xypkJ4PtPpu9jx5E6aCp+zgnHHgpM0VVy87DYJHoZt0j7mmu36YQ74O3n98KNnr19p/+ye61s2btj3yv8903vV+u9rq0K9fvuXr9d+iHt8W
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+An employee's I-9 verification documents are the documents an employee has provided the employer to verify their identity and authorization to work in the United States. This endpoint returns the possible document options based on the employee's authorization status. These options can then be used to create the I-9 verification documents.
+
+scope: `i9_authorizations:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-employees-employee-id-i-9-authorization-documents.ParamsDetails.json b/docs/api/get-v-1-employees-employee-id-i-9-authorization-documents.ParamsDetails.json
new file mode 100644
index 000000000..230d65c22
--- /dev/null
+++ b/docs/api/get-v-1-employees-employee-id-i-9-authorization-documents.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"employee_id","in":"path","required":true,"schema":{"type":"string"},"description":"The UUID of the employee"},{"name":"X-Gusto-API-Version","in":"header","required":false,"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.","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"}}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-employees-employee-id-i-9-authorization-documents.RequestSchema.json b/docs/api/get-v-1-employees-employee-id-i-9-authorization-documents.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-employees-employee-id-i-9-authorization-documents.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-employees-employee-id-i-9-authorization-documents.StatusCodes.json b/docs/api/get-v-1-employees-employee-id-i-9-authorization-documents.StatusCodes.json
new file mode 100644
index 000000000..892e102c8
--- /dev/null
+++ b/docs/api/get-v-1-employees-employee-id-i-9-authorization-documents.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"Example response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","description":"An employee's I-9 verification document","properties":{"uuid":{"type":"string","description":"The UUID of the I-9 verification document","readOnly":true},"document_type":{"type":"string","description":"The document's document type"},"document_title":{"type":"string","description":"The document's document title"},"expiration_date":{"type":"string","description":"The document's expiration date"},"issuing_authority":{"type":"string","description":"The document's issuing authority"}},"required":["uuid","document_type","document_title","issuing_authority"],"x-tags":["I-9 Verification"],"title":"I9-Authorization-Document"}},"examples":{"Example":{"value":[{"uuid":"7f2337f9-9b78-44b9-aeed-be4777b833a8","document_type":"driver_license","issuing_authority":"USA","expiration_date":"2027-01-01","document_title":"Driver's license"},{"uuid":"9p2337f9-9b78-44b9-aeed-be4777b833a8","document_type":"ssn_card","issuing_authority":"USA","document_title":"Social Security card"}]}}}}},"404":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided UUID is valid.\n"}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-employees-employee-id-i-9-authorization-documents.api.mdx b/docs/api/get-v-1-employees-employee-id-i-9-authorization-documents.api.mdx
new file mode 100644
index 000000000..1571fc51b
--- /dev/null
+++ b/docs/api/get-v-1-employees-employee-id-i-9-authorization-documents.api.mdx
@@ -0,0 +1,71 @@
+---
+id: get-v-1-employees-employee-id-i-9-authorization-documents
+title: "Get an employee's I-9 verification documents"
+description: "An employee's I-9 verification documents are the documents an employee has provided the employer to verify their identity and authorization to work in the United States."
+sidebar_label: "Get an employee's I-9 verification documents"
+hide_title: true
+hide_table_of_contents: true
+api: eJzdV01z2zYQ/SsoenAyQ4jyRyqLp3oqN6NDG08Up52xNQ5ErCTEJMAAoCJVw//eWRCUqA+7dXKLL4aA3YfF4u1bcE2XbFZap5lUDmaGO6kVc6sCaHJHIZ+AECDoOKKOzyzODVmffAQjpzL1xrhmwBZaWbA0WdOzbhf/CbCpkYU3Sej1kudFBqSxpBFNtXKgHNryosgCXPzZosOa2nQOOcdRHQ3lxvAVjah0kNvWvJ58htTRaG/HK0UgLzK9AjixBKNetKImQqdljttHtDC6AONkHX5ZStFCt85INTtA/zAHcns7HBA9JW4Oz+Ib4OKdylY0caaEKqLN2kO9x//Zq3E5sZsh8V47cNJl34Pn3auIwrKQNRMeBHcvR9z6E+9fRVRaW0o1e+Clm2sj3erFoAGBbBGqCnP7pZQGBDLT39x+dg/ScyyWcUSX7DmCh8zSYZ9d1V7/1JUyaK658nnzJPc0CoTH4YJnJZZTwy3am56dn/emfdaf9C7ZxcWkzziAYBO46PV6k8vzc355cJCECiMXYB4ymUJdQUeSSm9HV/TIDdKz7lmPdU9Z9/QwJQkdeOgTSxrwKtpE2y++KVpr1UPKjXg2zoNARjqVPCMjSEs0JB6hGlf4F9GL7sWhtPypHfldl0qQe0XIvULeIC3AOhAoOLo0KVIJLFHaEVhK6zrkD/4IxJYGfP0WRi+kAFEXtbRkwTMpOvfKXyzqg8/mEBMyA8cWp6xRF7sZPUjBZL85ZmBIc0T7rQplCQ9Btma2rmTO7TZ8NAsrhjhdI65wWhoiBSiHWeVKkJ0o0fSrNo9EKg9xqyQmb+S4A9u5V/fKprqAhHzaP59NUN4+oYxyw3NwYKznuuI5XmgrN8gEPHfB3Zy2SxdlMToU/KAL1X9pb7OFJ23Y9m/21ne1q5sh+wjGomfYfg5cgNkJYMozC/vbDPAsuVRg6+RzB2zCLQhydTPExCIo4dYiZTFbX6Wbk5UujTdIeZZ1yHBKlFaAjGruKKptWj3vxJK7XCqZl3kbe/xq7lxhkzgWOrUd36Y7qc7jpi2zgq+MzjK/HvNCsuAp1eznAMha068xjNKC6NCn0x1RUGWOQnjWPXvDur+w0zcogQKmvMxcLSXNfFV56bQF8EfgdsVmRpcFTajs70jorhHeEdMLMEYKqAtq0KoSWDpQGG9NpEdAvXjymRJt9LX1XEEmNH77wW0c9oM87rQb7NZ5J2hMQw5uroM++HJwc5rQeHEab5QiXrfKoYr3aylua4UFs2hqqTQZEjewgReyJgMTkHtGHEjLAHK9l/Qaj3lJR79a4o8DH8W8MVo8g1ngMubBBu32kf+m84Kr1VWagrXYOmlyN25bjZCGdcs8YrshJ4bYkBZ/T4AbX8S7MQYIlsECMi9xqHib+6WjlXWQf88ONcITG+BDR021Rw0NzcsQVjVSJwjRTglFFGXGvpuOwCxkCq372FY8n+jSxd4wFrg1diTmfzM99feArvvB/gVZqnNAdfdxnFhyHWqE3NTa4QWn4Z0/xk/hbc5T/zYPgjpodiXvIauVH0s15zLzhAqrv275g9kotHU5Vy2ct+Da3evZxrd/nvX2m+FHa56BhA6WLi4yLj1bfXWug5Lc0cWpz3jQEhrRZK+57qG33lcWFXyurUOc9Rrb2K3Jqgqnv5RgsFjHqG1G8klWP1aFtDh+oj227+LV+9BJX5Mne/MTR2y+7dSqJa00CjrcPl81rqKmd78svB+8kR/Na52/46+gTZq3DQ8VsXCttYMv8p0O9/b6A62qfwH/BbHD
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+An employee's I-9 verification documents are the documents an employee has provided the employer to verify their identity and authorization to work in the United States.
+
+scope: `i9_authorizations:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-employees-employee-id-i-9-authorization.ParamsDetails.json b/docs/api/get-v-1-employees-employee-id-i-9-authorization.ParamsDetails.json
new file mode 100644
index 000000000..230d65c22
--- /dev/null
+++ b/docs/api/get-v-1-employees-employee-id-i-9-authorization.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"employee_id","in":"path","required":true,"schema":{"type":"string"},"description":"The UUID of the employee"},{"name":"X-Gusto-API-Version","in":"header","required":false,"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.","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"}}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-employees-employee-id-i-9-authorization.RequestSchema.json b/docs/api/get-v-1-employees-employee-id-i-9-authorization.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-employees-employee-id-i-9-authorization.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-employees-employee-id-i-9-authorization.StatusCodes.json b/docs/api/get-v-1-employees-employee-id-i-9-authorization.StatusCodes.json
new file mode 100644
index 000000000..0ee843f9d
--- /dev/null
+++ b/docs/api/get-v-1-employees-employee-id-i-9-authorization.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"Example response","content":{"application/json":{"schema":{"type":"object","description":"An employee's I-9 authorization","properties":{"uuid":{"type":"string","description":"The UUID of the I-9 authorization","readOnly":true},"form_uuid":{"type":["string","null"],"description":"The UUID of the Form associated with this I-9 authorization. Use this with \"Employee Forms\" API endpoints.","readOnly":true},"version":{"type":"string","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.","readOnly":true},"authorization_status":{"type":"string","description":"The employee's authorization status","enum":["citizen","noncitizen","permanent_resident","alien"]},"document_type":{"type":["string","null"],"description":"The document's document type","enum":["uscis_alien_registration_number","form_i94","foreign_passport"]},"has_document_number":{"type":["boolean","null"],"description":"Whether or not a `document_number` exists for this document."},"expiration_date":{"type":["string","null"],"description":"The document's expiration date"},"country":{"type":["string","null"],"description":"The document's country of issuance"},"employer_signed":{"type":"boolean","description":"Whether the employer has signed the Form I-9","readOnly":true},"employee_signed":{"type":"boolean","description":"Whether the employee has signed the Form I-9","readOnly":true},"additional_info":{"type":["string","null"],"description":"Any additional notes"},"alt_procedure":{"type":["boolean","null"],"description":"Whether an alternative procedure authorized by DHS to examine documents was used"}},"required":["uuid","version","authorization_status","employer_signed","employee_signed"],"x-tags":["I-9 Verification"],"title":"I9-Authorization"},"examples":{"Example":{"value":[{"version":"6ae7ff720107b356bf13b1606f60b24f","uuid":"7f2337f9-9b78-44b9-aeed-be4777b833a8","form_uuid":"c54046f7-1be4-4c54-8194-f4842c30c86d","authorization_status":"alien","document_type":"foreign_passport","has_document_number":true,"expiration_date":"2027-01-01","country":"Panama","employer_signed":false,"employee_signed":false,"additional_info":"Notes","alt_procedure":false}]}}}}},"404":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided UUID is valid.\n"}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-employees-employee-id-i-9-authorization.api.mdx b/docs/api/get-v-1-employees-employee-id-i-9-authorization.api.mdx
new file mode 100644
index 000000000..e339e0049
--- /dev/null
+++ b/docs/api/get-v-1-employees-employee-id-i-9-authorization.api.mdx
@@ -0,0 +1,73 @@
+---
+id: get-v-1-employees-employee-id-i-9-authorization
+title: "Get an employee's I-9 authorization"
+description: "An employee's I-9 authorization stores information about an employee's authorization status and I-9 signatures, information required to filled out the Form I-9 for employment eligibility verification."
+sidebar_label: "Get an employee's I-9 authorization"
+hide_title: true
+hide_table_of_contents: true
+api: eJztWE1z2zYQ/SsoekiTIfRl2bJ0qqd2Uh2aeOqk7YzlkUFiKaEhARYAFasa/vfOgqRIfSV1c+l06ospEthd7L59+8gNfWKL3DrNpHKwMNxJrZhbZ0An9xTSEIQAQR8C6vjC4r0pG5NfwMhYRn4xPjNgM60sWDrZ0EGvh/8E2MjIzC+Z0JsnnmYJkHolDWiklQPlcC3PsqQy1/3d4oYNtdESUo5XZTRUh79D5GiwZ/lKEUizRK8BXliC0fHcLbWRf5bhBTQzOgPjZBlenkvRsmqdkWpxYPX9EsiHD9NromPilnDUrgEu3qlkTSfO5FAENNYmne/av28cqDxJMFmfd/Ram5Rwa3UkuQNBPkm3JG4pjxytQz5YKJ/5VTN6UyXCW7EzSq5upwSUyLRUznaOxbwCY2WZ8S9nJMqNAeVItamOuaxMh9wB+N/31XOpFmSRSwEP3y2dy+yk2xU6sh0PuE6k024NMJbxtdFJ4p93pYA00w5UtH5JYm2IVJhaf2iiFVnqT8RpktenjyUk4ujpdvI1t4673P69o7YwtWOEVEYCCipPscCRdPJPQEAorZofGZiUK1BubsBKgUgPKE8kKPpQBFToKE/xaRnKs/BS731ht5fEb2+Cym0k7dy7mxtYSOvK1p6rPA3B0AqscjwsL0Eu1Dzj1mbaOB/gktv5NshqVyvMUOsEuDoZ569LcEswRBuitCOcPO4ZeyTwJK2zvsC+jPWCDi0CCk+ZrEIW3H1FhhpDxBsqkHly5cz6n9usDCD+pbU5V5G3W2HGzK1cKGizTJOt41lyDeIMWXJLSgsNI0zZ+Bi+a5R+lUd4jkcuhERTPJljVz4jh1dqTZrdiAqwmDWeuHlmdAQiN/BPIMYV4YkDo7iTKyBbW9vGBUHCNbn+8Q5ZA554KlVTTks+cYtcImhR4IH/yKXBVN6Xo6KhyBN0clj3w7o8BPSJfW6COukSLNt0zK52xoxvBT87PXFVcxQvVzzJMU+bhsPpBYdRHI8GvX5vFJ6dX4Rx/yzsX/Qu4oteOBjGNKjmHx3Fg7OzUTxm43B0yYbDcMw4gGAhDEejUXh5dsYv6c5Io9H5sDe8iEesH8KQDaPzIbvsj4csHl4OB9FZL7q8EKeSNKmo74D4DsnnBPUg/o7QAh30BiPW67Nen7Y6m95yxVN+pDiTmCcWjrROdf8A4PStR+oBUP364qHAv4AOe8ND1fNWO/Ja50qQmSJkppBGEGBgcbQbsDo3EUIRrGdJz4gd8hP/CMQigrEbM6NXUoAoZYK0ZMUTKToz5fGK0sbnY4olWoBjqz6rz2a3V3MpmBzP9yXMs6QUsU4bsDvTmIc6d9iBX5iXhCvhLWK2ucsN2GDHUN132KKxTBIQBC236chPitKPH3mQyIUMZSLdGhXJtp86MzVTr169fff+ZvLqFcGkP25x/Eik2qpQS2Kj03L61DKJRFyREDwjYDAGnJGwKmtxe/16X/xM2bhRPjOsQMOr6BX3zGhddn+GVBsgAhyXifXB2khnMCGP+xWyE+TfR1QT3PAUHBjrO17xFLHfqi4NqMQaZtwtaZvGyr45UNMVWRdf0qO1C1oEW7e/sTf+leHqdsp+2ZKjd78ELry8aAKo+mrXzTWeBXnYei/YyyzkmHKUrHWK93XwWufGL4h4knTINCZKK8CeqJskKNe0XiheWHKfSiXTPG3bfqYk5Zlkjar9tjLIWrdfYhgIGhSip9LdCLRBb3DOehesf14OtpjniSvprL5fFH5s2Az4R+B2zRZG5xmdUDneGR+7i7BGTK/AGCmgpISrva6HJwcKYy7B9BGQME++BwbbSdN6H0Q01Pv2A9xu2A/0+KbdgJvNB4FjOlJwS10xnW8Lt6QT2l31u1vO625abVF0j7CeBbOqOyk3CcK2wgLPZAkFJiD1eDggyWtI9V7KS3vMD0nc5w96wvBRm7dGi8/YzPAxnt5ClBvp1j7yH3SacbW+iiKwFjNFJ/cP7VV3CMJSNhxZu4UmhlhD1itH4Ma38G6MlQmWwAoSz/GgXFNZere2DtKv8VBaOOGgQIKp9GallTwJYU+3NNpOAwUUSca+i+/ArGQErXo0/e4nWNcv7Ap0jROV+d9Mx74OuPVAfEIS6RRwQvg4XlhyU3UHuS2Zw9NNrWP8Mb6pPnvwyH/2qOj0uvZKfoak5H2vW7hMPKCqp983+MFsZNq6lKuWnTewP4mPfbXYOcam+Qrz//T/907/qo8cPLlulnDpG84TzKaiwHu66rfeOxBAkz11sM+DDwFdautw72aDs/eDSYoCb/+RA2ro+wckYyN5mJTvGUJavD4x09tY+u7nqqAvyUlBceJY1U2u1q1ZQINqcLTPVPjPFKXgeF54/3H1cTSvZf6OS7dtmpsJjUSeudazg2+0O+P4zc17WhR/Aafw1rE=
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+An employee's I-9 authorization stores information about an employee's authorization status and I-9 signatures, information required to filled out the Form I-9 for employment eligibility verification.
+
+**NOTE:** The `form_uuid` in responses from this endpoint can be used to retrieve the PDF version of the I-9. See the "get employee form PDF" request for more details.
+
+scope: `i9_authorizations:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-employees-employee-id-jobs.ParamsDetails.json b/docs/api/get-v-1-employees-employee-id-jobs.ParamsDetails.json
new file mode 100644
index 000000000..095fdbb8d
--- /dev/null
+++ b/docs/api/get-v-1-employees-employee-id-jobs.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"employee_id","in":"path","required":true,"schema":{"type":"string"},"description":"The UUID of the employee"},{"schema":{"type":"integer"},"in":"query","name":"page","description":"The page that is requested. When unspecified, will load all objects unless endpoint forces pagination."},{"schema":{"type":"integer"},"in":"query","name":"per","description":"Number of objects per page. For majority of endpoints will default to 25"},{"in":"query","name":"include","schema":{"type":"string","enum":["all_compensations"]},"description":"Available options:\n- all_compensations: Include all effective dated compensations for each job instead of only the current compensation"},{"name":"X-Gusto-API-Version","in":"header","required":false,"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.","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"}}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-employees-employee-id-jobs.RequestSchema.json b/docs/api/get-v-1-employees-employee-id-jobs.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-employees-employee-id-jobs.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-employees-employee-id-jobs.StatusCodes.json b/docs/api/get-v-1-employees-employee-id-jobs.StatusCodes.json
new file mode 100644
index 000000000..2e8b97ab3
--- /dev/null
+++ b/docs/api/get-v-1-employees-employee-id-jobs.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"Example response","content":{"application/json":{"schema":{"type":"array","items":{"title":"Job","type":"object","properties":{"uuid":{"type":"string","description":"The UUID of the job.","readOnly":true},"version":{"type":"string","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."},"employee_uuid":{"type":"string","description":"The UUID of the employee to which the job belongs.","readOnly":true},"hire_date":{"type":"string","readOnly":false,"description":"The date when the employee was hired or rehired for the job."},"title":{"type":["string","null"],"readOnly":false,"default":null,"description":"The title for the job."},"primary":{"type":"boolean","description":"Whether this is the employee's primary job. The value will be set to true unless an existing job exists for the employee.","readOnly":true},"rate":{"type":"string","description":"The current compensation rate of the job.","readOnly":true},"payment_unit":{"type":["string","null"],"description":"The payment unit of the current compensation for the job.","readOnly":true},"current_compensation_uuid":{"type":"string","description":"The UUID of the current compensation of the job.","readOnly":true},"two_percent_shareholder":{"type":"boolean","description":"Whether the employee owns at least 2% of the company.","readOnly":false},"state_wc_covered":{"type":["boolean","null"],"description":"Whether this job is eligible for workers' compensation coverage in the state of Washington (WA).","readOnly":false},"state_wc_class_code":{"type":["string","null"],"description":"The risk class code for workers' compensation in Washington state. Please 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.","readOnly":false},"compensations":{"type":"array","items":{"type":"object","description":"The representation of compensation in Gusto.","properties":{"uuid":{"type":"string","description":"The UUID of the compensation in Gusto.","readOnly":true},"version":{"type":"string","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."},"job_uuid":{"type":"string","description":"The UUID of the job to which the compensation belongs.","readOnly":true},"employee_uuid":{"type":"string","description":"The UUID of the employee to which the compensation belongs.","readOnly":true},"rate":{"type":"string","readOnly":false,"description":"The dollar amount paid per payment unit."},"payment_unit":{"type":"string","readOnly":false,"description":"The unit accompanying the compensation rate. If the employee is an owner, rate should be 'Paycheck'.","enum":["Hour","Week","Month","Year","Paycheck"]},"flsa_status":{"type":"string","enum":["Exempt","Salaried Nonexempt","Nonexempt","Owner","Commission Only Exempt","Commission Only Nonexempt"],"description":"The FLSA status for this compensation. Salaried ('Exempt') employees are paid a fixed salary every pay period. Salaried with overtime ('Salaried Nonexempt') employees are paid a fixed salary every pay period, and receive overtime pay when applicable. Hourly ('Nonexempt') employees are paid for the hours they work, and receive overtime pay when applicable. Commissioned employees ('Commission Only Exempt') earn wages based only on commission. Commissioned with overtime ('Commission Only Nonexempt') earn wages based on commission, and receive overtime pay when applicable. Owners ('Owner') are employees that own at least twenty percent of the company. ","title":"Flsa-Status-Type"},"effective_date":{"type":"string","readOnly":false,"description":"The effective date for this compensation. For the first compensation, this defaults to the job's hire date."},"title":{"type":"string","description":"The job title for this compensation."},"adjust_for_minimum_wage":{"type":"boolean","description":"Indicates if the compensation could be adjusted to minimum wage during payroll calculation.","readOnly":true},"minimum_wages":{"type":"array","readOnly":false,"description":"The minimum wages associated with the compensation.","items":{"type":"object","properties":{"uuid":{"type":"string","description":"The UUID of the minimum wage."},"wage":{"type":"string","description":"The wage amount."},"effective_date":{"type":"string","description":"The effective date of the minimum wage."}}}}},"required":["uuid"],"x-examples":{"success_status":{"uuid":"db4d41e5-813c-477e-bfae-38da2ae5e7a3","version":"56d00c178bc7393b2a206ed6a86afcb4","job_uuid":"c1fdb417-c34a-43a7-92f3-5e6c20c1d7a4","employee_uuid":"a7e8f9bc-0d12-4e56-b789-012345678901","rate":"70000.00","payment_unit":"Year","flsa_status":"Exempt","effective_date":"2023-01-01","adjust_for_minimum_wage":false,"minimum_wages":[],"title":"Software Engineer"},"hourly_compensation":{"uuid":"e5f6a7b8-c9d0-1234-e5f6-a7b8c9d01234","version":"98b7a6c5d4e3f2a1b0c9d8e7f6a5b4c3","job_uuid":"d2e5f8a1-b4c7-4d90-a3e6-f9b2c5d8e1a4","employee_uuid":"b8f9a0bc-1e23-4f67-c890-123456789012","rate":"25.00","payment_unit":"Hour","flsa_status":"Nonexempt","effective_date":"2023-01-01","adjust_for_minimum_wage":false,"minimum_wages":[],"title":"Associate"},"minimum_wage_adjusted":{"uuid":"a4d9ba9c-32cc-4cc1-a5bc-6ef4cd653e7a","version":"cc59bd3879d655fb940a1f6b675f2ad9","job_uuid":"d8f8fbe7-496d-4b69-86f0-1e2d1b73a086","rate":"5.00","payment_unit":"Hour","flsa_status":"Nonexempt","effective_date":"2018-12-11","adjust_for_minimum_wage":true,"minimum_wages":[{"uuid":"edeea5af-ecd6-4b1c-b5de-5cff2d302738","wage":"7.25","effective_date":"2018-12-11"}]}},"title":"Compensation"},"readOnly":true},"location_uuid":{"type":"string","nullable":false,"description":"The uuid of the employee's work location."},"location":{"description":"The representation of an address in Gusto.","type":"object","title":"Location","x-examples":{"success_status":{"created_at":"2025-06-09T13:43:49.000-07:00","updated_at":"2025-06-09T13:43:50.000-07:00","company_uuid":"10593a6a-505b-4aa6-bf31-15dcdceedbe3","version":"e1bdd845a493c74908f8e15d6114169b","uuid":"6b1351a2-de35-4499-b948-43abab274634","street_1":"300 3rd Street","street_2":"Apartment 318","city":"San Francisco","state":"CA","zip":"94107","country":"USA","active":true,"phone_number":"8009360383","filing_address":true,"mailing_address":true}},"properties":{"uuid":{"type":"string","description":"The UUID of the location object.","readOnly":true},"version":{"type":"string","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."},"company_uuid":{"type":"string","description":"The UUID for the company to which the location belongs. Only included if the location belongs to a company.","readOnly":true},"phone_number":{"type":"string","readOnly":false,"description":"The phone number for the location. Required for company locations. Optional for employee locations."},"street_1":{"type":"string","readOnly":false},"street_2":{"type":["string","null"],"readOnly":false},"city":{"type":"string","readOnly":false},"state":{"type":"string","readOnly":false},"zip":{"type":"string","readOnly":false},"country":{"type":"string","readOnly":false,"default":"USA"},"mailing_address":{"type":"boolean","description":"Specifies if the location is the company's mailing address. Only included if the location belongs to a company."},"filing_address":{"description":"Specifies if the location is the company's filing address. Only included if the location belongs to a company.","type":"boolean"},"created_at":{"type":"string","description":"Datetime for when location is created"},"updated_at":{"type":"string","description":"Datetime for when location is updated"},"active":{"type":"boolean","description":"The status of the location. Inactive locations have been deleted, but may still have historical data associated with them.","readOnly":true},"inactive":{"type":"boolean","description":"The status of the location. Inactive locations have been deleted, but may still have historical data associated with them.","readOnly":true}},"required":["uuid"]}},"description":"The representation of a job in Gusto.","required":["uuid"]}},"examples":{"Example":{"value":[{"uuid":"d6d1035e-8a21-4e1d-89d5-fa894f9aff97","version":"6c0ed1521e8b86eb36bd4455a63a2dac","employee_uuid":"948daac8-4355-4ece-9e2a-229898accb22","current_compensation_uuid":"ea8b0b90-1112-4f9d-bb93-bf029bc8537a","payment_unit":"Year","primary":true,"title":"Client Support Director","state_wc_covered":"null,","state_wc_class_code":"null,","compensations":[{"uuid":"ea8b0b90-1112-4f9d-bb93-bf029bc8537a","version":"2cd4b18662395eb53bcf80d5b5447f36","payment_unit":"Year","flsa_status":"Exempt","job_uuid":"d6d1035e-8a21-4e1d-89d5-fa894f9aff97","effective_date":"2021-01-20","rate":"70000.00","adjust_for_minimum_wage":false,"minimum_wages":[]}],"rate":"70000.00","hire_date":"2020-01-20"}]}}}}},"404":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided UUID is valid.\n"}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-employees-employee-id-jobs.api.mdx b/docs/api/get-v-1-employees-employee-id-jobs.api.mdx
new file mode 100644
index 000000000..1c40a565d
--- /dev/null
+++ b/docs/api/get-v-1-employees-employee-id-jobs.api.mdx
@@ -0,0 +1,71 @@
+---
+id: get-v-1-employees-employee-id-jobs
+title: "Get jobs for an employee"
+description: "Get all of the jobs that an employee holds."
+sidebar_label: "Get jobs for an employee"
+hide_title: true
+hide_table_of_contents: true
+api: eJzdO/1z27ix/wrKTsfJjCCT4odI/VTPJbmXTnuXOeeadpyMCwJLCwkFsARoR8+j//3NgqRESbRs59I37939EosAdhf7vYu9e+8rvWmM1VQqCzc1s1IratcVeIsrD1Y5CAHCm3isqoZbjPdp4lWsZiuwUBtvcXXvKbYCb+HBqir1GuBa4jmpvIVXMbv0Jl4N/25kDcJb2LqBiWf4ElbMW9x7LULP2FqqG28z8QQYXssKUXkL7/0SyK+/vn1FdEHsEkiPwttM7o+hODKhRjAO+78bqNfepKevYjfgjWHABWKXzBJpCNIKxoKYkg9LUKRRpgIuCwliQu5kWZJSM0FYWRKdfwZuDWlUCcYQUKLSUllS6JqDQbBSOaZNv41eqI/I/alZ5VAjO3rkFdTuAlPyRtdkxT7rWto17ujpMS3ZAgrWlJZYTWaxI2gMqVS8bATy6SEhTTxQzQq1hJXlNderCpTpdeNIghe3TJYsL4Fo98ksPipKjk4uyNsWsWMsFAVwK2+BCGZBkL2tyF4CjC/JZ50TqYwFJhxHVLl2WsKbugZl9465C3d3/Af90Wn+xbu39O9QG1zuRLAEJhzbdypbsNLA4bVeofavpALjMCKZNGcGBLl495bctkAJM0Zz6a5wJ+2SrHVTuw2cleWUvC2I0gpQ66pa30qBKub2sKoqJXeEnxlytZJKrprVEPanF0trK7M4Pxeam6kz5SnXq/PedGnF1rUuS7d+zipJu5NS3fyxA0gHn18iGY0BMX2S7Gf+LKZ+QoMYHUKnW95i+H2z+YR8NJVWBgwCm/k+/rPPytdf2aoqgfQ7vYnHtbKgLO4dcOL8s8EDI4bE6pqhDksLK4fISlviwl907k36Xa3FeBOvqnUFtZUtUU0jxdhNT3uizzqfOjVh4mdVrlvPtpl4HTefBrBX1F5fOtgtoVNyCeB+X+0kR24aKeCZwpcCVpW2oPj6pbMeqQpdrxxTiVZkqe/QKzQG0UlDCgmlQJ+1c+nfxqT+OEK/W0q+7FlHcii1ujGjLFzKGq7RosYQ7naP2uX7zhjJHfruPRrumCEIWhBdkxraP5EbW3FuJr3i9HivdohVU5bep1ECOt3HHWP0OJhHmKparli9Htwx17oEpo64+mEJdgl1Kxtp9m51hq7DAXKACeK7ZWUDrc/PgRhwLh952wcqpgh8lcaiPqEw3A+zpbCHPSqc+gG5PKzcQy9M8PhjJlSx9QqUvW6UtCdFMRbJ3VGCR3s0o3TsSWOEhu7QXpD6RiMYxf8IC+ydvq6g5kiCWbIalrrEuPQcZRmovr5ThjBLSmDGktmftqTpVcXUenpsV5uJZyyzcH3Hr7m+BRcJd6LYYR+XxZ7KujBtCJTyRuadJdzp+gvU5myfKw4TJmOytV1HAhL7gZmlVDdWK/Liw8XLxwgumTHXXIvTlnwstlqaL8SdJnj6BKVSDWlymKfkHfIXyK000pKrw/UzQ35B+D84+Jiy7dz43d3dtFRyesemN/r2XCrT1ExxOEd7MRTpoo4uMOfDH7TQNe0opEMCB7toqfWXpvrj+Uv0AyWwWpGVrmGcifv53KkQexBUR7gJVQ0GlN2q/CELXRo2/U4R+UHgv/MY/Vnn3+iZ0DD3IvMeC0+F6P9IXvBk7A/FoKfkBrosWU3YSjfKkopJ0RVQu7jRRufRGPQsVC4GMd75WNSLo0vWzm28PWCKdBFa3ymoJ23ANEvdlAKj+dk7tuZL4F/OpoNk/L90gzXLB4Av3sT7m1au6v4nMPzan3DFWVEado3uqDGnsvvXX2FVoVVfspLVEgT5SSvoPw7//hnJ9CbeD3q1ksZZCPKFbCEcLuwOj7rgN3+9vCAtgV2QlmaPaVOypenFWYvl7OWWeYawGlq5MlLIryCIwe1rArdQr1HQKHCpxQCOq80w9Fi5AvLi7PjS34RhQpgSpAYOWMlu4eMGl512pU1ewpSgBMs1eXH2CMo+b1nqpnaZ4NoFqOeg2gkExADFi7NxESIdGDLu2A0Y0ta4rtJ28bo/cQD2kKMPKsE49AHg59zM6SLexP1x9tKxbXdD1+HRd2qXCdk7UNaJCzOtw6yIeNt6wHtTGkYvnVrS92g06AT7LsVvKVb2Wx0PqfybTuyFrM1+Jjlpt3dFiHGpfuvaz9pyx8Edq21OOWsXGQZlyyFBCI6Jz42x14Wur7t2wjVK8Qk56lslsKQHQ+RI6Oa9r2sRgMA79R0QxEBEg4STLn5iM4U3ZUfYSLgYUjeW0jxBSkP05qitc3iF6ak86XukOkNynCwOGH8CjGNgG/6mT1PiR3V2nCj8b9hGu2rv+mnifaXQtnwcB0zDORgzCEotTzyRRyIKIKZpEHIazedA84IBDVPBZgximLPQGyRzXpwI3+fBPM35PMzCfMZmfgIiYWnCCp5H3jBX8nhQiDwK5pSHEaNRyOY0mxUhjSHhM58HYs7wxEGm47E5pEWWc+qLYEYjiBOaz9OM+sEsjOJknmZ+4PUpijf3fd+f+r53mFH0wXkvHu/C7qFUsK0WUj+gDviDltfp74HCX33a+bFLXdg7dIuv1Y1U0Dafly747NW6AzlAXCRsnqeUZ8KneE2Knyh+w0/4ZU8OWZrPWcJjEUFYzFiQ+zwTKcyLhMV5xMN9OYgZxEXKAppHfE4jkfmUhZDQIstnPBYpBKNyyNMiY37OaQCzkEZFMqc8zVr6OjHMdnKYxaNC6PKmfSEMs5v/mBwuehfiHTio697rDSTAIpHlLOM0nHFOI84DyuKc0wSKiIskDmHO9iTAeZzlIkznmUjiuMizyGdBkeTJPC5mTGQHEkiLtMhhTqMsETTKk4ymSeEjZ0WQz0Pmp8mOld+Pk0FKgxkNTnKyfS86ZORONwUAi1lBgYuERnnAaR4LoDEvipkI/dk8TL3ePXrz6Sx+hJTNp80uUmLuOnxAOA4tpeanW0PYa8Dk5FSd0EhxWBidGZfWkR6+c9X9j+MW+ni1zRRhQtTY8RuWw4cBqb/sX3vwj3toXgNGv2s27Pj72fsgXEThIsqmvu9Tf75wmtJU4sTm2N/b3OVevWoGfpyFLGE09uOcRowlNC/CgAax4IIDiBz2YwAEuRBpFLMoC/k8yvy0SCGIRRIEUZBk+BrQgU7yIIwDNqMCwphGUZbRPItSjAQ5y2fzKHFuzdgawF4H3sILfZ+EtSCX7tNubYb2XLHauhIyDFDjuLRrdLdMkTfYyZGGa69rUaFiXXgT779lhd4yCvy5u3mjLPaDvV8vcZU5Fe0toFpqBdfKvf55Cy/1/SxM/DDF2xeylOrmupP11mbYyOfN5vskIL0q9m2Q33+XZV8xn8yvvl7rju83PLZc7JsdbXHUPcGKPjs+3IZA2Hjvtu+g72nLN9UlDgRpQWxvsXVH5Jcur3NL/eX6ZbyIg8XK9rG272zsNniboWk9SuFmaGxPf5zZ9Ib4NARPq+I2neU+ZePWqJ8kg/4NFR3AZsSCHy2sLrtJBXOkOt2zUSepM0M64H2E+DbV2xw7n8PQ9AySiu9A0eSQRSiEQbR6zHBfMQuuweBa/9hgGNLbQUKgw6j224B2kFxJ3fn8RwX9vnscacyhR56St6oFs7M2smS3QHIARQSUYHHMIG8sWbE1MRbfCd2GpTRW15KzEus6NlbmrkbdjVT/LwkfLU83ozNII8lVN30yfGYYgzVMpLpJB/zTvdEOM1mRiMAPY6ApmwU0gkDQNBMxLViaRUXGiiKb72U6CfdBBPEsgDRPE8jDJBdRFMcsCdlMMD5SM2VRKhjjmOPEMY2AA81gxuhslqVZyjjPZ1gznXj79ICluZ9jnRVg+VtkguZ5FtK88GdZztM4dKXIeLG7ffJuM5Rtll1KDP2XTVXp2pJXsgZude2NPUF67SP7A49929WDV6xBwfA0+ndsnnER5UGaJLMwiyGPw5wXqS/iPI6ieREmz63sh3XX00Q+VoNiAUpn/mij4dlVqRvTOQIzmMJAjH6HEQsk19mJ/OjY2/+kLXmjGyXIR0XIR9XaTjdQhxM+uqk5vsKAIUrbdvJgSv7GvgAxTd0mef0sVJtBSYMDDVJMPyoP8WLy6uT6Fnl4A5beBnTb5KWDIUT6WefmyAP9CLYd3tu+gXWdYZyK6BMVfG4304/qozJcV7Ag/8J9C3Qg/8IYw26QczheZFx/+of9KTisoEwF7Asws6Y4dUZRgWvplPQG7F9ayoa7bmrdYD2AiC6U2IeIfsSCMlt1/gJYKTw4wjnZOpjTo5w4FNeDeojgLawt4eOn2gvsdo9eBHVtBXapO+E587FLb+Gd3wbnWzGe3w/kuDnvBGmgvu1nTpu6xHG9LvlnlWxzfypg5QqA4yAMK33A8hYebY0Rl/FiDwAehfmu1uIEzAqX8cYGeFO7RPTq3jUVmFpfuKL6osHLtzbY77rE8bY2Yozs3YZYJLEf1XMhF1g9MjHagaAl3EJJWGOXoGw3UYc5x+XaWFj9FgwthAcQuPSg0MOhPBcxcZZx39HuBgcnHg5Xmp+LS6hvJYeBPHYFHst1Y8/dxnOBqNExUPeb6sLJAY8eTaZAyfXKvTw7Os4Med1ZCHnXPSjgmKXQvFn1Af8P3Uwi4y7b68ZIX/VYyS9Q7gwVM2unUN3qn3f648pvbeyKqQEc9EjODWF6OPBCh7Tf7+Yiv48Xa6Vs4as9r0omnTo49b/vjPLKuw0GeQReb7E/5e0s8xO2kI3F/ff3+Ib3a11uNvi5HS5GrRfSYB/sgXna4dX+lyayH7h/69e6UfHelTnH8PQbfLch7dM0OlP8RhL/z4xln7zibhh9d81P+KOWbVP1WYr1om9avCQP/n8FD5DTvxiq9ZCWnsyhSWxwyqKbIn8eeb/zkfITYh6fx9/T7HYjRimXRfdrR9Phe/nFj6/fe5vN/wB+NYwM
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Get all of the jobs that an employee holds.
+
+scope: `jobs:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-employees-employee-id-onboarding-status.ParamsDetails.json b/docs/api/get-v-1-employees-employee-id-onboarding-status.ParamsDetails.json
new file mode 100644
index 000000000..c8985cf67
--- /dev/null
+++ b/docs/api/get-v-1-employees-employee-id-onboarding-status.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"X-Gusto-API-Version","in":"header","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"},"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."},{"name":"employee_id","in":"path","description":"The UUID of the employee","required":true,"schema":{"type":"string"}}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-employees-employee-id-onboarding-status.RequestSchema.json b/docs/api/get-v-1-employees-employee-id-onboarding-status.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-employees-employee-id-onboarding-status.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-employees-employee-id-onboarding-status.StatusCodes.json b/docs/api/get-v-1-employees-employee-id-onboarding-status.StatusCodes.json
new file mode 100644
index 000000000..71fc78d53
--- /dev/null
+++ b/docs/api/get-v-1-employees-employee-id-onboarding-status.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"successful","content":{"application/json":{"schema":{"description":"The representation of an employee's onboarding status.","type":"object","title":"Employee-Onboarding-Status","x-examples":{"success_status":{"uuid":"8351cf2a-17cb-49e3-94a7-9986dcb11e84","onboarding_status":"onboarding_completed","onboarding_steps":[{"title":"Personal details","id":"personal_details","required":true,"completed":true,"requirements":[]},{"title":"Enter compensation details","id":"compensation_details","required":true,"completed":true,"requirements":[]},{"title":"Add work address","id":"add_work_address","required":true,"completed":true,"requirements":[]},{"title":"Add home address","id":"add_home_address","required":true,"completed":true,"requirements":[]},{"title":"Enter federal tax withholdings","id":"federal_tax_setup","required":true,"completed":true,"requirements":[]},{"title":"Enter state tax information","id":"state_tax_setup","required":true,"completed":false,"requirements":["add_work_address","add_home_address"]},{"title":"Direct deposit setup","id":"direct_deposit_setup","required":false,"completed":true,"requirements":[]},{"title":"Employee form signing","id":"employee_form_signing","required":true,"completed":false,"requirements":["federal_tax_setup","state_tax_setup"]},{"title":"File new hire report","id":"file_new_hire_report","required":true,"completed":false,"requirements":["add_work_address"]}]}},"properties":{"uuid":{"type":"string","description":"Unique identifier for this employee."},"onboarding_status":{"type":"string","description":"One of the \"onboarding_status\" enum values."},"onboarding_steps":{"type":"array","description":"List of steps required to onboard an employee.","items":{"title":"Onboarding step","type":"object","properties":{"title":{"type":"string","description":"User-friendly description of the onboarding step."},"id":{"type":"string","description":"String identifier for the onboarding step."},"required":{"type":"boolean","description":"When true, this step is required."},"completed":{"type":"boolean","description":"When true, this step has been completed."},"requirements":{"type":"array","description":"A list of onboarding steps required to begin this step.","items":{"type":"string"}}}}}},"required":["uuid"]}}}},"404":{"description":"Not Found\n\nThe requested resource does not exist. Make sure the provided UUID is valid.\n","content":{"application/json":{"schema":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided ID/UUID is valid.","type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["error_key","category"],"properties":{"error_key":{"type":"string","description":"Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error."},"category":{"type":"string","description":"Specifies the type of error. The category provides error groupings and can be used to build custom error handling in your integration."},"message":{"type":"string","description":"Provides details about the error - generally this message can be surfaced to an end user."}}}}},"x-examples":{"not_found":{"errors":[{"error_key":"request","category":"not_found","message":"The requested resource was not found."}]}},"title":"Not-Found-Error-Object"}}}}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-employees-employee-id-onboarding-status.api.mdx b/docs/api/get-v-1-employees-employee-id-onboarding-status.api.mdx
new file mode 100644
index 000000000..5344a3dd0
--- /dev/null
+++ b/docs/api/get-v-1-employees-employee-id-onboarding-status.api.mdx
@@ -0,0 +1,108 @@
+---
+id: get-v-1-employees-employee-id-onboarding-status
+title: "Get the employee's onboarding status"
+description: "# Description"
+sidebar_label: "Get the employee's onboarding status"
+hide_title: true
+hide_table_of_contents: true
+api: eJztWW1v2zgS/itzLLBtACluuu1u609XXLqLAnvboi+3BySBS4tjm41EqiTlxOf4vx+GpGTKspvtywF3h6QfakmcZ4Yzw3njmukaDXdSq5eCjdkcXb48ybGqS71CtN2viRS5VlPNjZBqPrGOu8ayjAm0hZE1AbAxuwen2+dz9QadkbhEC1xBi3TfwhYIAtAxvFsgCO44GHSNUShggWVtQaqZNhW4BYLBT400KPrkWBO6AIO2xsLJJUKhq7pEEqGFP1f07949GGwhvL8Hz0UlVT7jhSyl467H5VzdDAnhJt0r3Jyrm3E++LtJH8a0CD5wYjVJAKWKEuMHuAmSgEIUFpxuN4NeBbOmLDtFJvY4hgCdgLZ0gjBfRBJYcAtTROWRVu2uUHgVLtHImUTh0YJaOkKL5Sz/L1EJKocGptzKIvqHd2DgU904r6dWRa1eSPoUvkYV2SxlyoLUQ/RSOVQe02kIi3q49DrVCDzA4/lxBhU3l+SWHIoFFpdTfX2UwTQKZVfWYeV5KO1ghQ4sKhcZLsntpFaHRA5SHLCmx+EqgdmV8BZYsqDZBx/fhw30fQBqowu09jZovUQjGkyh70dgOvKBT82tRZF5P8S+ALIsvcI6j94V5JAAHcFkupq0oIMdbmG9X9HGpKL9SpN6VwhR0dHtQjelgClCUwsfLZaSw/PXL0nt52xXEH7FpfM/vJ8bXEq8OmcwM7qCBRrMQKsiuNjWEVvVh+Wf2ede+L5Td2bU4ZSveu583/Z3+h8JJv14gbUPvTeDt3ADb0Kgr1C5B/aIZJ5iYqb9ceVm8Kb/FyNNjcZqxcuJQMdlaYOaRKqKmTTWgeIVZlDy7idWXJZZ8Fg9g6k0bpGB1YXkJVgsGiPdClRTTdFEDZLMqKzXao+h9WSuH1A4fNRT+AFSqtYWXIjJlTaXEy6EQTsQG+gjxI8p0UJXeJCIPu4SzVCg4eXE8euJRdfURPUWHTQ1xG/g+DVcSbdY6JIMt40AlDn3UvovB+mENFi4icBaW+m2xA+0zyS8PGpxEjMFIohELVRXr5A7T6ycK6nmPa+lD7YN2H88znaAgDduoY38l9f/EXCDMEdFRRIK+AEIErtwOpMlThReTRbS4MRgrY0jbr/IEoGDwiugLxC+EG9wC2kHCWr/yQ3P1vuEmkmSu7NddCd4oFW52tZGxOFQ0j4KR9EWusbxVlV2bJCLDyxjjs8tG5+xFsCyi4xd5/PGOp1TTpyHUjF3qxppIVZTFAIFrau54RU6NASxZnRo2Jj9M//VUz9//TL/BxpLdWLGJBWLC+QCDcuYLRZYcTZes4DLrKMwzDKGqqmIz6OHj57kD3/KT54QJ4Ez3pSOjdP3m91a9JRkqaTCkNLp3OZTblH4OL0MsgBvj6Lwngkr3Ri/oOBleQwvZ6C0QpCWst1SCspRfg2v61IWXh33LZxVUsmqqVLsiwcL52o7Ho2ELuyx1+JxoatRq7W85iujy9J/H/Fa5pFSqvm9CJgnr49IjMaiOGabrNNwUqG3mq25Wwxqc0pf79+/PKXglQZ/lrHWe9jYmQYPG2SzuchYG+q8lf+mq5qr1fOCCoHnjVuw8dnFJvEaY6/4vMWlGl0ri5agHz18SP/1hbSNR5o1JctYoX0ZRqsSbY8+Wlq6TqQcbtRgbZCqolAM6dmtHQi5f9isnn7EwtGzdCW9aI9D/qqjyt+2DdB1jtecUpPfVJS/7Y/Ga9Y0khqrpz8+OSlmj3h+8nMxzR8/wx/zZ4/5z/mzZ09/EsX05ASfPmYZG7ZYY7YvD+8uxTqculbk1zHNtWGCPIPE2E1/e4y/5dFZrUvH1ps32/J54UvxNGPtctyXA7+VKyWxNOG1vHaz5Pfgk+bIlE+aWL+PFg9l15brIDN/H7bb1JzUgC3PnYz+eY4zXtohy31WGSiwJ9dpPyG3nL1A+0qFnlRRiC9TRFobQCwaWo57K4qvUsQ+A+4quCeXryJ2aojOG/ZUHt/HPBebi80mY7Wh0ZCTmISxYYbuh973Sn5qEKSg7nkmyakHFQ9l6j1h7jboVwrbzHU+pD9nQLUCLHnZoB3y8PGxY8GN4asBh9+kdcQitCFdReV0my3SHEL5QjqsAmy016s0q2C9J6X0lRrpbtWqRZPPjEQlyhUk31qF7AzE/Pb/jLneutDu7pprP+LWtTrcqdYlcjUA/mOBCrwDBuMTBhUvLYTHS1zz6wC7/rNDSuWMDn6L0Z9DGc0+mCqmHjDFuR8KRNZ96+/USPSXaussHJ6L8P7xw8fDkuV37eAX3ShB9fm7OOtEG7p/qxtTIAiNYXCE19K6Y/g7v0SwjQljg7Y6DSWetHQSpDg+V19fR3VCwbkC+Fa5Xp6O+qLtOR2pztAYbXwD0j8z8f3Qrrv2OIw6uUQiKLjDuTarAzz8qtuPUI0FHR0LVzTICZU1kYMuisbQZHtVS2omVsF9LnG1PXChNeHOGTltHI66HgoMljwObDrIcGpaqb9ANEKgteTmAckPs1qo1kg2Sj43uqmp8vCDnIIrP+iy8SQ0shRQUHFfxfULrkQZ52a+N0paRS9zhdby+Z+IdK9bQdruNhnpelZ57MU7dUboVkrbmBkvgqQUrZUgwUlz4fT1q3Wl3WRGHp461lnP/ix6fOov44Qw2Rw7cECu4sDXExyzkF3blPG7drk/ZPkLYpq/Cl7biWtr5JfI7Sqndi+nWaqRAsNVzTbfdO0IXjtU1CyGnYQ9HGzhM+YTZr+VpwqkTxeauG4xxeF00SEZO4K9slKXWKFb6HjvRNmR+tYxGy1PRt1wYrROGtzNaN8dlEWzbMcOjSlptBAbb17L0HfnAivffA9c7hQrzfqaDnh5qDfpM232APBezNdGi89g1vQ5baXfUgQOLrmnoe4ODTFvxyU+WSI3foDS5x4h8hKXWPpxFkWbEPTpNL719xDfwiEgHGBAtYea6bQu8iMgGo2QS8QhUG94kzGa1dhXs7dolrLARNPbsYmPBSO/cCSINYXs3D/neuY1TKSD0gHLgno4p8HLcd/Ci+jr8DoMYPzURuiiqdqJwV9i2uSFT5tx1HLacoU3FJ79KcuYHwx7V4lf/7r1DF9Ia+sqrhKcX9Htzt8HA4ndfay3afzumvXumvXumvXumvXumvXumvXumvXumvXumvV/7Jo1FNsOr92oLrn0VbnvL9axBTpjyxNfWbb3sBkb9+/5hn3QRcYW2joiXq/povO9KTcbev2pQepazy6oITOST6koP1szIS393o6GDxacD2KsEEfwmWvEvftqpzRqlfSDLIvNY7qpzcUmay+Fv0y8/+ur3gN6Dfrbf73eqXnbpVO7V7vk22AS2OvHf33xjq5p+t1h1w3GH/7CcZ951+uw4p2+RLXZdNZ29OwHIJt/AzQAORY=
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+# Description
+Retrieves an employee's onboarding status. The data returned helps inform the required onboarding steps and respective completion status.
+
+
+## onboarding_status
+
+### Admin-facilitated onboarding
+| onboarding_status | Description |
+|:------------------|------------:|
+| `admin_onboarding_incomplete` | Admin needs to complete the full employee-onboarding. |
+| `onboarding_completed` | Employee has been fully onboarded and verified. |
+
+### Employee self-onboarding
+| onboarding_status | Description |
+|:------------------|------------:|
+| `admin_onboarding_incomplete` | Admin needs to enter basic information about the employee. |
+| `self_onboarding_pending_invite` | Admin has the intention to invite the employee to self-onboard (e.g., marking a checkbox), but the system has not yet sent the invitation. |
+| `self_onboarding_invited` | Employee has been sent an invitation to self-onboard. |
+| `self_onboarding_invited_started` | Employee has started the self-onboarding process. |
+| `self_onboarding_invited_overdue` | Employee's start date has passed, and employee has still not completed self-onboarding. |
+| `self_onboarding_completed_by_employee` | Employee has completed entering in their information. The status should be updated via API to "self_onboarding_awaiting_admin_review" from here, once the Admin has started reviewing. |
+| `self_onboarding_awaiting_admin_review` | Admin has started to verify the employee's information. |
+| `onboarding_completed` | Employee has been fully onboarded and verified. |
+
+## onboarding_steps
+
+| onboarding_steps | Requirement(s) to be completed |
+|:-----------------|-------------------------------:|
+| `personal_details` | Add employee's first name, last name, email, date of birth, social security number |
+| `compensation_details` | Associate employee to a job & compensation. |
+| `add_work_address` | Add employee work address. |
+| `add_home_address` | Add employee home address. |
+| `federal_tax_setup` | Set up federal tax withholdings. |
+| `state_tax_setup` | Set up state tax withholdings. |
+| `direct_deposit_setup` | (optional) Set up employee's direct deposit. |
+| `employee_form_signing` | Employee forms (e.g., W4, direct deposit authorization) are generated & signed. |
+| `file_new_hire_report` | File a new hire report for this employee. |
+| `admin_review` | Admin reviews & confirms employee details (only required for Employee self-onboarding) |
+
+scope: `employees:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-employees-employee-id-payment-method.ParamsDetails.json b/docs/api/get-v-1-employees-employee-id-payment-method.ParamsDetails.json
new file mode 100644
index 000000000..c8985cf67
--- /dev/null
+++ b/docs/api/get-v-1-employees-employee-id-payment-method.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"X-Gusto-API-Version","in":"header","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"},"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."},{"name":"employee_id","in":"path","description":"The UUID of the employee","required":true,"schema":{"type":"string"}}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-employees-employee-id-payment-method.RequestSchema.json b/docs/api/get-v-1-employees-employee-id-payment-method.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-employees-employee-id-payment-method.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-employees-employee-id-payment-method.StatusCodes.json b/docs/api/get-v-1-employees-employee-id-payment-method.StatusCodes.json
new file mode 100644
index 000000000..125265029
--- /dev/null
+++ b/docs/api/get-v-1-employees-employee-id-payment-method.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"title":"Employee-Payment-Method","type":"object","x-examples":{"Example-1":{"value":{"version":"63859768485e218ccf8a449bb60f14ed","type":"Direct Deposit","split_by":"Amount","splits":[{"uuid":"e88f9436-b74e-49a8-87e9-777b9bfe715e","name":"BoA Checking Account","priority":1,"split_amount":50000},{"uuid":"0d2b7f73-05d6-4184-911d-269edeecc30a","name":"Chase Checking Account","priority":2,"split_amount":100000},{"uuid":"1531e824-8d9e-4bd8-9f90-0d04608125d7","name":"US Bank Checking Account","priority":3,"split_amount":null}]}},"Example-2":{"value":{"version":"63859768485e218ccf8a449bb60f14ed","type":"Direct Deposit","split_by":"Percentage","splits":[{"uuid":"e88f9436-b74e-49a8-87e9-777b9bfe715e","name":"BoA Checking Account","priority":1,"split_amount":60},{"uuid":"0d2b7f73-05d6-4184-911d-269edeecc30a","name":"Chase Checking Account","priority":2,"split_amount":40}]}},"Example-3":{"value":{"version":"63859768485e218ccf8a449bb60f14ed","type":"Check"}}},"description":"","properties":{"version":{"type":"string","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."},"type":{"type":"string","enum":["Direct Deposit","Check"],"description":"The payment method type. If type is Check, then `split_by` and `splits` do not need to be populated. If type is Direct Deposit, `split_by` and `splits` are required."},"split_by":{"anyOf":[{"type":"string","enum":["Amount","Percentage"]},{"type":"null"}],"description":"Describes how the payment will be split. If `split_by` is Percentage, then the split amounts must add up to exactly 100. If `split_by` is Amount, then the last split `amount` must be `null` to capture the remainder."},"splits":{"type":["array","null"],"items":{"type":"object","description":"Representation of a bank account item","properties":{"uuid":{"type":"string","description":"The bank account ID"},"name":{"type":"string","description":"The bank account name"},"hidden_account_number":{"type":"string","description":"Masked bank account number"},"priority":{"type":"integer","description":"The order of priority for each payment split, with priority 1 being the first bank account paid. Priority must be unique and sequential."},"split_amount":{"description":"If `split_by` is 'Amount', this is in cents (e.g., 500 for $5.00) and exactly one account must have a `split_amount` of `null` to capture the remainder. If `split_by` is 'Percentage', this is the percentage value (e.g., 60 for 60%).","type":["integer","null"]}},"required":["uuid"],"title":"Payment-Method-Bank-Account"}}},"x-tags":["Employee Payment Method"]}}}},"404":{"description":"Not Found\n\nThe requested resource does not exist. Make sure the provided UUID is valid.\n","content":{"application/json":{"schema":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided ID/UUID is valid.","type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["error_key","category"],"properties":{"error_key":{"type":"string","description":"Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error."},"category":{"type":"string","description":"Specifies the type of error. The category provides error groupings and can be used to build custom error handling in your integration."},"message":{"type":"string","description":"Provides details about the error - generally this message can be surfaced to an end user."}}}}},"x-examples":{"not_found":{"errors":[{"error_key":"request","category":"not_found","message":"The requested resource was not found."}]}},"title":"Not-Found-Error-Object"}}}}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-employees-employee-id-payment-method.api.mdx b/docs/api/get-v-1-employees-employee-id-payment-method.api.mdx
new file mode 100644
index 000000000..8fa11cc78
--- /dev/null
+++ b/docs/api/get-v-1-employees-employee-id-payment-method.api.mdx
@@ -0,0 +1,71 @@
+---
+id: get-v-1-employees-employee-id-payment-method
+title: "Get payment method for an employee"
+description: "Returns the payment method for an employee (e.g. Check or Direct Deposit with split configuration)."
+sidebar_label: "Get payment method for an employee"
+hide_title: true
+hide_table_of_contents: true
+api: eJzdWG1v27oV/isct6ENINlyYju2Py236Yp86G3QpPcOcIOEFo9s3kikSlJODMP/fTgkJct23Kwo9oIBAWJJ5Hl/nnPINTWQVlrYFZ1M1/SdKkomVxdpCsZcVHZBJ9O7zV1EOZhUi9IKJemEfgZbaWmIXQAp2aoAaUkBdqE4yZQmTBIoylytAMhb6Mw75N0C0keiNLkUGlJLLqFURljyJOyCmDIXlqRKZmJeaYY6Tjpf5VdpUlXChDzUwu6Drnuvy0w0MP5AI/oczytjVSykhbmXENtVCXQypVDMgHPg9C6ils0NvntfW3cdjP/oBOKSWpQ2T2xOJ1ZXEFENplTSgKGTNT1NEvy3G5GbyoUsq3Ia0VRJC9LiKlaWuUidRd0/DC5dU5MuoGD4ywqbA5009sTBnjjYE1HvBVWzPyC1zlN4ZkWZe1Pe+99xDx+WLK/A/QBtvFXDs9FgfD4c9UcDOO2N0jQbsX5/PJsNk6zXh5aC3bzQiLqk3M9WdEIvClXJ5p1xhVJVgtMJhdEoG/fPhvHsvA9xf8xG8egcxvH5+flsPMvgvDcAGlHJClTyi7rwlSDknFykaRBbaqF8BfZqvcyrnAySJEk2UaMv4aez8+z8LE4GfBj3e6N+PO71eHw6HAMHSNOzhG31vVswA9/XeLqvsZfsqewNznowOu3HIz6GuD/jo3icjZM44Ul/mIx6pwN+vlX55Yb8wuTj95We7SuVVZ5v7jabqMno6b81o9egU5CWzeG/ktXhfzal/WQ3tmc/HVunn25Q6C4NOENUCdoKj9BG+rrea6wWck73d94ugKSV1shGYRNRmWNYD/4OuQFwz9PwHQMwrwSHu7cLa0sz6Xa5Sk3HEVgnVUW35r64ZCut8tx97woORaksyHR14vhayEzpwpEUUZIs1BOxilQG1QlDMgE579BN7f6hKyCrAnn1oOZ8oA76x+1h30CRHXKVuR9EGJ/jCB2W5KGu3QfCJA+P5oFwRaSyRAJwtHgGpFRllTMLfEfWrl3RUXlMA9HwrRIavMNbzKwpk6tPmYPJMfcbomzh6w5LPWxAmNPDbnrpnmZgfORbsXkSeY5eOTOcRy3LhSFbPSFQuNm3U1/8hhSVsYRxTqoSQwTPLLX5ivSS5AV53oGWrJwZGwQ+eIkPXuIMyAO684BCU1baSvvi1FAwITnobfzMtmSmlGnNVohnjMVdRIWForVg2+n2J45Sg0FfbUAGIzMkWuYZgKCcA/R5ivlXoLcj6+oSbfeM88Ob3bZNRBeCc5D34fW9rIoZ6NflfWTmEfieSL9302a5Ro6beUC/aJjSHDQGq97n4A4sXTQl5jIU+UGsWdUjM0B2wYRmQmO+2/aUTPAOua5X1wVRSfGtAocoA98qkFawvAWjmo/3Z6eDMnzj6/BN5PkH/yTBQjd+nIzIIEmcK38ZdJLkxKmsK1tJaAx1li3YEgirVdRVrLJXC/gQH2+2gGsZ5xDbfCCus9SGDr2dw+SvJ52mf0xbSfM4wE5SEw9+d4WLA2sYEHfnwhhHjLjufa4NPcevzrYbt7Cf9A8z8Kuy5O+qkhyn7tuFJ0EwFjjRYFSlUyBcgXFsC8/C2A75yB6BmDpqpVZLwYGTL1+uLjEoS5YL3vkqf2QcPmIU+SoJ+Vm7ri67u6a9MFy3MwBaK20wB7uUEt5v8VcT2lEiO5B6/wi4IWUW5kqvjuhwq16li5sSUpEJMORpAcFnt52oNK206ZDbVSlSlucrX6+PsCKCIzbdLlzPrNViVlnolkyzAixoosF1UQRHI9JBubH6B0xDCa4VqyxIIm7cCaLqJJlg+VyrqhRybhyuUyYduZjQ4yuRc5LiiFOE9QsmeY50JSRZqQrnmeYY6GwuwBjsxa+afF0bwsEykRvCZqqyraDGZA4S9DacQXRtpal0xlJvKZ6CJUfDMXKbANP28U0qe59hhbcLa7qTfxoqvl0vk9bGlnP0CECemMeH29ChfhauieVXZWMHsvg9Ko0/+aoN5mJRujBe4aQ+Bxsve3F9GjfNr3vhJszW0Rw7cV1L3qcwv/8j/uCO1xfXV/FvYTaOqMDgL4BxR4mt8/GRQes0OR3EyTDuDfxsmbEqt3TSfn8wml+iLYWQoR45sxDPGFbVxfVVM3IzY1QqXOm7lujqCRcghFxHkNhghGmYJfJrWsz2xpBpIaQoqqIt+wendFaKeDvo/zkIjFuvT9AMxAUWeRPhVlLqyJbMLl6cDxwjhlNGvW+Hsfz1x7GEbDbuwsSUwB6BmVXskNuyIbSg5jajvRbNjdUStBYcfHVhhp8tSHTOV43HwNHrnag+xrWveTAWu/v8XU6zGJ1qL9q3v1l4xI+X9+76s5WBfmGcAjBqR11OJrS77HUbQHXXreRtugeQMqCXNZ4qnSNmQkWxUviCijkUrqoO8n0JhdpLgZcXu2M47nOeHRH8osxrfZDWtswSP6Pv9R3jDRaS574Xbhqb8kLlNQ/g8wyYfmHCDSLiHJaQE1bhqcUGDCL+b1bGQvEzGryEIwo2iK5Mte/xHLch5jH/zb1Ci5UiiiRkPmU3oJcihVakt3zgmk7XLexyVI00HLvnWGUuwrh139jfIU9VAdh6nB1vDHkfQIGzIDKLoyOu0qqoT1J/CvMZS918FjjkstZKPuMc4OAYURyMc1cq4evftpWB0SiVsQWTLTkfwL5yP7zvxXo7Lf7P3TKH2rHwbLtlzoQrMgeXdYDzlC57LlAB0DSik10+3sP0XUQXyljcuV5jN/qi880GX3+rAFv99A6ZRAs2wwKbrikXBn9zOslYbuA74Xv7OdD4CfkO17/oVD3aylWLyGgUWK/t0eYOj7q+c/+Yef/X/fhIXH38Xp6BmjBv2wtSV2lb3w6OTzuN5cP7WxpRtst0DbOFH637q930rtd+xa16BLnZNNm2+Oymxs0/AfMxDpY=
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Returns the payment method for an employee (e.g. Check or Direct Deposit with split configuration).
+
+scope: `employee_payment_methods:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-employees-employee-id-recurring-reimbursements.ParamsDetails.json b/docs/api/get-v-1-employees-employee-id-recurring-reimbursements.ParamsDetails.json
new file mode 100644
index 000000000..9f169f1b1
--- /dev/null
+++ b/docs/api/get-v-1-employees-employee-id-recurring-reimbursements.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"X-Gusto-API-Version","in":"header","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"},"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."},{"name":"employee_id","in":"path","description":"The UUID of the employee","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","required":false,"description":"The page that is requested. When unspecified, will load all objects unless endpoint forces pagination.","schema":{"type":"integer"}},{"name":"per","in":"query","required":false,"description":"Number of objects per page. For majority of endpoints will default to 25","schema":{"type":"integer"}}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-employees-employee-id-recurring-reimbursements.RequestSchema.json b/docs/api/get-v-1-employees-employee-id-recurring-reimbursements.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-employees-employee-id-recurring-reimbursements.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-employees-employee-id-recurring-reimbursements.StatusCodes.json b/docs/api/get-v-1-employees-employee-id-recurring-reimbursements.StatusCodes.json
new file mode 100644
index 000000000..9990ea977
--- /dev/null
+++ b/docs/api/get-v-1-employees-employee-id-recurring-reimbursements.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"successful","content":{"application/json":{"schema":{"type":"array","x-examples":{"success_status":[{"uuid":"04ca1051-dcec-4cb7-829c-dfbffdf4af23","employee_uuid":"73c96cc6-f8c9-4513-b3f1-4301351178d6","version":"3b8eda8460f7acabd86ceec924e0ae74","description":"Travel expenses","created_at":"2025-11-03T09:03:20.000-08:00","updated_at":"2025-11-03T09:03:20.000-08:00","amount":"100.00"},{"uuid":"e3fc7aae-5053-44bf-99e1-3636df0d1f5b","employee_uuid":"73c96cc6-f8c9-4513-b3f1-4301351178d6","version":"30c1aeb356a70e0a71275414e5f29b7e","description":"Meal allowance","created_at":"2025-11-03T09:03:20.000-08:00","updated_at":"2025-11-03T09:03:20.000-08:00","amount":"50.00"}]},"items":{"type":"object","x-examples":{"success_status":{"uuid":"b739f253-b028-443b-b6cf-97a555c3d493","employee_uuid":"346e1409-1c97-4524-9ebb-0c0c169e35cb","version":"cf9b64404e63d325c762aaad20ca7a39","description":"Office supplies","created_at":"2025-11-03T09:03:24.000-08:00","updated_at":"2025-11-03T09:03:24.000-08:00","amount":"75.50"}},"properties":{"uuid":{"type":"string","description":"The unique identifier of this recurring reimbursement.","readOnly":true},"employee_uuid":{"type":"string","description":"The UUID of the employee.","readOnly":true},"description":{"type":"string","description":"The description of the reimbursement."},"amount":{"type":"string","description":"The dollar amount of the reimbursement."},"version":{"type":"string","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."},"created_at":{"type":"string","description":"The timestamp when this reimbursement was created.","readOnly":true},"updated_at":{"type":"string","description":"The timestamp when this reimbursement was last updated.","readOnly":true}},"required":["uuid","employee_uuid","description","amount","version"],"title":"Recurring-Reimbursement"},"title":"Recurring-Reimbursement-List"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided ID/UUID is valid.","type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["error_key","category"],"properties":{"error_key":{"type":"string","description":"Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error."},"category":{"type":"string","description":"Specifies the type of error. The category provides error groupings and can be used to build custom error handling in your integration."},"message":{"type":"string","description":"Provides details about the error - generally this message can be surfaced to an end user."}}}}},"x-examples":{"not_found":{"errors":[{"error_key":"request","category":"not_found","message":"The requested resource was not found."}]}},"title":"Not-Found-Error-Object"}}}}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-employees-employee-id-recurring-reimbursements.api.mdx b/docs/api/get-v-1-employees-employee-id-recurring-reimbursements.api.mdx
new file mode 100644
index 000000000..2a4375899
--- /dev/null
+++ b/docs/api/get-v-1-employees-employee-id-recurring-reimbursements.api.mdx
@@ -0,0 +1,71 @@
+---
+id: get-v-1-employees-employee-id-recurring-reimbursements
+title: "Get recurring reimbursements for an employee"
+description: "Get all active recurring reimbursements for an employee."
+sidebar_label: "Get recurring reimbursements for an employee"
+hide_title: true
+hide_table_of_contents: true
+api: eJzdWFtv2zgW/itc7sNMAdOWLMmO/bTFtlME2GmDNt0ZIA0yFHlks5VIlaScGIb/++BQsiPXTppguvOwT4lt8lw+fue6oaYGy70y+lzSOV2AZ6uYQVWXZg3g9v/dKMksiMZapRc3FlSVN9ZBBdo7OqASnLCqRjl0Tt+AJ7wsCRderYDs75HDe6QwlnBNdjqGn/Qn7YSpYU7+ODw6t8DlH3RAPV84Or+i7w8tuB7QO7ZonDdMaQ+L1iXm1zXgaahykBIkHVBe1/0j4WrNLa/Ag0XRG6p5BXROf2dvgsCXF+fsv2Ad+jagCh1cApdg6YA6sYSK0/mGtqqo8+goHVDQTYWqx9E4Y9GExRlqklDwpvR03v9++y1+r9CWSmlwxC+BSO6B5dyBJC8vzsmqtYVw54xQ3IMkt8ovydo0NhwQvCyH5Lwg2mggypHampWSIAftGV7XpRLB/Z8cuaqUVlVT9WVf/7z0vnbz0Uga4YYB2KEw1WgHJKv52pqyDL+PeK1Yd1PpxT87gaz39Qs0o3Egh3Q72CPcI9cO2Zr75RGfLpdAPn48f0VMEQDZ3aMDauFroyxIOve2gYcfZNtTW/MF7PR9bcCuD+QUvHRwygK8RvySe/QFz4PzIIfktyVo0mhXg1CFQpRvVVmS0nAZosDkn0F4RxpdgnMEtKyN0h7ZL8ChWKXDYwxPESpwFeyhA4F7z7H/bVPlYBG/nTU12ODRkPxiLKn4Z2OVX+OJnYGu9aOjLPGGjLPHLbweUIexrvw6BNK/TVVzvX4pBDj3svFLOr+63vZi1bpbvtg9nQVXG+3AoexxFOGfQy9cEyQVTUkHVBjtQXs81SP06LPDo5tjM7m1HJG6Y3DHq7ps9XQib5znvmnDv2kUpsIoFTyOsphJAYKlIp+ys/FMMFnkRSGLlBfjBON8x+Hu2jQRs4kQE1aciRlLszhheVLELE2iOMnieHomJ3RAu7igc5rkZyD5WTqJiikXPJdnEwEgZuMUIg7T9DgaLF9BSeCuhoDWgAoLmAZu+D6xxDGLkstoNo+S+TgaRlHEorN5FNEBbWr59MO8Mg1iTOMIfwjB2zkKSSGmnAPLoixhaZoXbDaDmCWTZCKLSMZFlv8QfCIRc8iTbMKnEUR8Go+nWRqnkBXjWT6FI3x+BV5i4JlbrgX8PfBkLTrX2wFVHirX410bcN8l3h7XfJrMinGWsDwan7E0TXKWT0TBZlOeZZlIZDo7xbsknUCcRjMWi9mUpdk4ZTPIcxaJSMSTGSSZyA9wFcUsn6RplMIkkck4E9PJmHMux5HgU57MjnB9VxRKAHENRttTeJc+B9j0NLDTbJhFmPxobbFV8Qp6YB2X3eO03Wj1tQGiJGiP+dm2VSTk8JN9yTCkUy7f6XLd5qbtEdxPUXyqYp2UfXD1KZJ73+wUfOPB9h7CJwk0Zcktaa88LHJPnqfIRGxB+3270kltw2FIPgCEz1f3jQNZNErCM3sPJaGqjQct1i9CQ6l0YWzFW3A0WZpbLF2Ng/bRCwVl6EIO2PsUh7yqwHle1eQWK35HoR5G5JY70kk9+dD9EPhxGkvuPOlEn1C77TcHV23gfMvnQ+V77ty/+PWAeuVLtPf9LmrYQQ+OiH7nCPuPcp5ut2hSGqXH9f2t8eQX02j5nPL+gAjySRPySV8GIne9GrHgTGMFEh4c0cYTuFPOD8mv/AtmNttyctcvk/NXoxDFypEVL1WA99u03gcXrDW2HSkOslX3/XEz8mCxOJJ68wXwguAeFsauH9ARTn2XWx+6VtUhrzqfw3VihGisG5LLda1wjFi3pPsC6/sE2g4l3Hur8sbDaD89EQtlGEe8uRfZhtrO6meYhhLwbGhJgyQS0konavdIrrN8YU1TK71whGtJBNckhzBxoDV5o0pJBKaSqju/5FqWmHSUbqei3lAYbK7AORwUvmvyxc4QCZ6r0hGem8b3QGVkARrsPZyd6J2VrrEFF62lOA5riYYjcm2sHDYO2vibIgRJj1hXB+9PO8b3+TLvXew5Rx8IEEwsGB/hwhA7m158vzWehSBjr1Epe9eytjMX7jxoF2ZrtKu16MHpfEBXvGy+P6Vj53koqh0e9vdDsrtG1/zSdLsMOmgHyjkdreLRfqsx2vQmz+3okb2GA7varQUaW+Lo3xUnXqu2NjEJVShQR8R4BZUJfZ+rgX8B7taslcdCx4b32ob6tOCTMi+skY/IrPHn/hz2AfNkS5wT09ie2qh8N9vh5xy4DUPmofZOBCsBJxDe+CXmhDY1Y8x8WDsP1V/R0Ep4QAF217owQWpHxbCiwdXFQW/bW64MKO5S3LviA9iVEtBD+r61CBE7CgdHElVjYmXhMzNFQFiJ40njNyiFqQDjNtjxkyOvOw6Ti7ZJCVsVaUSDjApu/KMrblyE4taN9K92Wsl7TKKB81iluSoDVbpf/3XPjNATG+crrntycPX21H3bt/5s7ovu/3SF1xLCw50f1SVXgTkhBjZdtF7RVdzrURCJ+eGu6MGQvR7QpXEeZWw2uDP7aMvtFr9uNyUYyFI5npcP7Ur6KPxta5+TmLTprttWdVmOhozxdA9+4OLnMRtDJN+beI0frEIbn4n4z++7xucFeWTrd9KUXWul131bdib2+RPm9G6H+zzz/q83s48+8elt+AEr24OY/Wvf++2ofT+o0m9eX2K9PywW++LQ/YOPdPJ5N5v2xKX5Anq73b+2x8+ha9n+Cft6iL0=
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Get all active recurring reimbursements for an employee.
+
+scope: `reimbursements:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-employees-employee-id-rehire.ParamsDetails.json b/docs/api/get-v-1-employees-employee-id-rehire.ParamsDetails.json
new file mode 100644
index 000000000..230d65c22
--- /dev/null
+++ b/docs/api/get-v-1-employees-employee-id-rehire.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"employee_id","in":"path","required":true,"schema":{"type":"string"},"description":"The UUID of the employee"},{"name":"X-Gusto-API-Version","in":"header","required":false,"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.","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"}}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-employees-employee-id-rehire.RequestSchema.json b/docs/api/get-v-1-employees-employee-id-rehire.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-employees-employee-id-rehire.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-employees-employee-id-rehire.StatusCodes.json b/docs/api/get-v-1-employees-employee-id-rehire.StatusCodes.json
new file mode 100644
index 000000000..08db75319
--- /dev/null
+++ b/docs/api/get-v-1-employees-employee-id-rehire.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"Example response","content":{"application/json":{"schema":{"type":"object","properties":{"version":{"type":"string","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."},"effective_date":{"type":"string","description":"The day when the employee returns to work."},"file_new_hire_report":{"type":"boolean","description":"The boolean flag indicating whether Gusto will file a new hire report for the employee."},"work_location_uuid":{"type":"string","description":"The uuid of the employee's work location."},"employment_status":{"type":"string","description":"The employee's employment status. Supplying an invalid option will set the employment_status to *not_set*.","enum":["part_time","full_time","part_time_eligible","variable","seasonal","not_set"]},"two_percent_shareholder":{"type":"boolean","description":"Whether the employee is a two percent shareholder of the company. This field only applies to companies with an S-Corp entity type."},"employee_uuid":{"type":"string","description":"The UUID of the employee.","readOnly":true},"active":{"type":"boolean","description":"Whether the employee's rehire has gone into effect.","readOnly":true}},"x-examples":{"example-1":{"version":"2e930d43acbdb241f8f14a2d531fa417","employee_uuid":"8c290660-b6c9-4ad7-9f6e-ea146aaf79e8","active":false,"effective_date":"2024-06-30","employment_status":"seasonal","file_new_hire_report":false,"work_location_uuid":"8cb87e2e-5b30-4c13-a4f4-bfffcbed1188","two_percent_shareholder":false}},"title":"Rehire"},"examples":{"Example":{"value":{"version":"2e930d43acbdb241f8f14a2d531fa417","employee_uuid":"da441196-43a9-4d23-ad5d-f37ce6bb99c0","active":false,"effective_date":"2024-01-01","file_new_hire_report":false,"work_location_uuid":"d2c80d44-857b-4d4d-bce4-23ae52cc863b,","two_percent_shareholder":false,"employment_status":"full_time"}}}}}},"204":{"description":"No Content"},"404":{"description":"Not Found\n\n* The requested resource does not exist. Make sure the provided UUID is valid.\n* The employee's employment is not in the right state.","content":{"application/json":{"schema":{"description":"Unprocessable Entity\n \nThis 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.\n","type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["error_key","category"],"properties":{"error_key":{"type":"string","description":"Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error."},"category":{"type":"string","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."},"message":{"type":"string","description":"Provides details about the error - generally this message can be surfaced to an end user."},"metadata":{"type":"object","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.","oneOf":[{"type":"object","description":"multiple entities","required":["entities"],"properties":{"entities":{"type":"array","items":{"type":"object","description":"single entity","additionalProperties":true,"properties":{"entity_type":{"type":"string","description":"Name of the entity that the error corresponds to."},"entity_uuid":{"type":"string","description":"Unique identifier for the entity."},"valid_from":{"type":["string","null"]},"valid_up_to":{"type":["string","null"]},"key":{"type":["string","null"]},"state":{"type":["string","null"]}},"title":"Metadata-With-One-Entity"}}},"title":"Metadata-With-Multiple-Entities"},{"type":"object","description":"single entity","additionalProperties":true,"properties":{"entity_type":{"type":"string","description":"Name of the entity that the error corresponds to."},"entity_uuid":{"type":"string","description":"Unique identifier for the entity."},"valid_from":{"type":["string","null"]},"valid_up_to":{"type":["string","null"]},"key":{"type":["string","null"]},"state":{"type":["string","null"]}},"title":"Metadata-With-One-Entity"}]},"errors":{"type":"array","description":"Will only exist if category is `nested_errors`. It is possible to have multiple levels of nested errors.","items":"circular(Entity-Error-Object)"}},"title":"Entity-Error-Object"}}},"x-examples":{"bank_account_delete_unfunded_payments":{"errors":[{"error_key":"base","category":"invalid_operation","message":"FundingMethod has unfunded payments"}]},"bank_account_verify_incorrect_deposits":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Your bank account cannot be verified. Please check the test deposit amounts."}]},"bank_account_verify_already_verified":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Your bank account has already been verified."}]},"bank_account_missing_routing":{"errors":[{"error_key":"routing_number","category":"invalid_attribute_value","message":"Routing number is required."}]},"payment_configs_missing_parameter":{"errors":[{"error_key":"base","category":"missing_parameter","message":"At least one parameter must be provided"}]},"payment_configs_invalid_fast_payment_limit":{"errors":[{"error_key":"fast_payment_limit","category":"invalid_attribute_value","message":"Fast payment limit should be a number"}]},"pay_periods_invalid_end_date":{"errors":[{"error_key":"end_date","category":"invalid_parameter","message":"End date cannot be more than 3 months in future"}]},"company_industry_selection_naics_code_required":{"errors":[{"error_key":"naics_code","category":"invalid_attribute_value","message":"Naics code is required."}]},"company_industry_selection_naics_code_invalid":{"errors":[{"error_key":"naics_code","category":"invalid_attribute_value","message":"Naics code must be equal to 6 digits."}]},"company_industry_selection_sics_codes_invalid":{"errors":[{"error_key":"sic_codes","category":"invalid_attribute_value","message":"Sic codes must be equal to 4 digits"}]},"time_off_policy_name_required":{"errors":[{"error_key":"name","category":"invalid_attribute_value","message":"Name is required."}]},"time_off_policy_unlimited_invalid_accrual_rate":{"errors":[{"error_key":"accrual_rate","category":"invalid_operation","message":"Accrual rate must be blank for unlimited policies."}]},"time_off_policy_pending_requests":{"errors":[{"error_key":"time_off_policy","category":"invalid_operation","message":"Cannot deactivate policy with pending time off requests."}]},"time_off_policy_employees_required":{"errors":[{"error_key":"employees","category":"invalid_attribute_value","message":"Employees are required."}]},"time_off_policy_unlimited_balance_update":{"errors":[{"error_key":"base","category":"invalid_attribute_value","message":"Can not adjust balances for unlimited policies."}]},"holiday_pay_policy_already_exists":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Company already has a holiday pay policy."}]},"holiday_pay_policy_not_exists":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Company does not have a holiday pay policy, please create one"}]},"holiday_pay_policy_invalid_employees":{"errors":[{"error_key":"employees","category":"invalid_attribute_value","message":"Invalid employee uuids provided."}]},"onboarded_employee":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Cannot delete onboarded employee"}]},"invalid_attribute":{"errors":[{"error_key":"base","category":"invalid_operation","message":"There is an error in the request body."}]},"company_cannot_enable_contractor_only":{"errors":[{"error_key":"contractor_only","category":"invalid_attribute_value","message":"Contractor only cannot be enabled for existing companies."}]},"company_missing_parameter":{"errors":[{"error_key":"base","category":"missing_parameter","message":"contractor_only is required."}]},"starting_after_uuid_invalid":{"errors":[{"error_key":"starting_after_uuid","category":"invalid_attribute_value","message":"Parameter 'starting_after_uuid' does not correspond to a valid event."}]},"resource_uuid_invalid":{"errors":[{"error_key":"resource_uuid","category":"invalid_attribute_value","message":"Parameter 'resource_uuid' does not correspond to a valid resource."}]},"payroll_gross_up_invalid_net_pay":{"errors":[{"error_key":"net_pay","category":"invalid_attribute_value","message":"Net pay must be a number."}]},"payroll_accruing_hours_invalid":{"errors":[{"error_key":"base","category":"invalid_attribute_value","message":"Hours cannot be negative."}]},"payroll_cannot_cancel":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Payroll cannot be canceled."}]},"frozen_payroll":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This payroll has already been processed. Its data cannot be updated or altered."}]},"frozen_payroll_processing":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This payroll is being processed and cannot be updated at this time."}]},"unmodifiable_payroll_type":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This type of payroll cannot be modified or processed. It is reserved for system processes."}]},"invalid_employee_uuids_format":{"errors":[{"error_key":"employee_uuids","category":"invalid_attribute_value","message":"Parameter employee_uuids must be an array."}]},"maximum_employee_uuids_surpassed":{"errors":[{"error_key":"employee_uuids","category":"invalid_attribute_value","message":"Exceeded maximum of 100 for lookup."}]},"invalid_employee_uuid":{"errors":[{"error_key":"employee_uuids","category":"invalid_attribute_value","message":"Invalid Employee UUID(s).","metadata":{"entities":[{"entity_type":"Employee","entity_uuid":"invalid-uuid-123"}]}}]},"payroll_blocker_missing_bank_info":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must have a bank account in order to run payroll.","metadata":{"key":"missing_bank_info"}}]},"payroll_blocker_missing_employee_setup":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must add employees in order to run payroll.","metadata":{"key":"missing_employee_setup"}}]},"payroll_blocker_missing_federal_tax_setup":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must complete federal tax setup in order to run payroll.","metadata":{"key":"missing_federal_tax_setup"}}]},"payroll_blocker_missing_bank_verification":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company bank account must be verified in order to run payroll.","metadata":{"key":"missing_bank_verification"}}]},"payroll_blocker_suspended":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company is suspended and cannot run payroll.","metadata":{"key":"suspended"}}]},"submission_blocker_missing_selection":{"errors":[{"error_key":"submission_blockers","category":"invalid_attribute_value","message":"Submission blockers selections required"}]},"submission_blocker_invalid_option":{"errors":[{"error_key":"submission_blockers","category":"nested_errors","metadata":{"blocker_type":"fast_ach_threshold_exceeded"},"errors":[{"error_key":"selected_option","category":"invalid_attribute_value","message":"Selection is not available to resolve Fast ACH Threshold Exceeded. Please choose one of Wire In, Move To Four Day"}]}]},"invalid_version":{"errors":[{"error_key":"base","category":"invalid_resource_version","message":"You are attempting to update a resource using an out-of-date version."}]},"signatory_email_required":{"errors":[{"error_key":"email","category":"invalid_attribute_value","message":"Email is required"}]},"signatory_company_already_has_signatory":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Cannot have more than one signatory in a company. Please remove the existing signatory before adding a new one."}]},"mixed_disbursement_errors":{"errors":[{"error_key":"disbursements","category":"nested_errors","metadata":{"contractor_payment_uuid":"invalid-uuid-1"},"errors":[{"error_key":"contractor_payment_uuid","category":"not_found","message":"Disbursement not found."}]},{"error_key":"disbursements","category":"nested_errors","metadata":{"contractor_payment_uuid":"d0dfa222-ad08-4ea7-a06a-717688c3b179"},"errors":[{"error_key":"payment_method","category":"invalid_attribute_value","message":"Payment method must be one of: Direct Deposit, Check."},{"error_key":"payment_status","category":"invalid_attribute_value","message":"Payment status is not valid for payment method 'InvalidMethod'."}]}]},"not_found":{"errors":[{"error_key":"request","category":"not_found","message":"The requested resource was not found."}]},"finish_onboarding_incomplete":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Company is not ready to exit onboarding."}]},"company_location_validation":{"errors":[{"error_key":"street_1","category":"invalid_attribute_value","message":"Must include a street address"},{"error_key":"city","category":"invalid_attribute_value","message":"Must include a city"},{"error_key":"state","category":"invalid_attribute_value","message":"State is in the wrong format"},{"error_key":"zip","category":"invalid_attribute_value","message":"Please enter a valid zip code (e.g. 12345)."},{"error_key":"phone_number","category":"invalid_attribute_value","message":"Phone number must be 10 digits"}]},"conflict":{"errors":[{"error_key":"request","category":"duplicate_operation","message":"A resource with these attributes already exists."}]},"invalid_parameter":{"errors":[{"error_key":"request","category":"invalid_parameter","message":"The provided parameter is invalid or missing."}]},"flow_invalid_entity":{"errors":[{"error_key":"entity_type","category":"invalid_attribute_value","message":"Invalid flow entity"},{"error_key":"entity_uuid","category":"invalid_attribute_value","message":"Invalid flow entity"}]},"flow_nested_options_errors":{"errors":[{"error_key":"options","category":"nested_errors","metadata":{"flow_type":"company_forms"},"errors":[{"error_key":"form_types","category":"invalid_attribute_value","message":"Supplied value 'invalid' contains no permitted values"}]}]},"basic":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must complete all onboarding requirements in order to run payroll.","metadata":{"key":"needs_onboarding"}}]},"contractor_payment_invalid_wage":{"errors":[{"error_key":"wage","category":"invalid_attribute_value","message":"Wage must be greater than or equal to 0."}]},"contractor_payment_cannot_cancel":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Payment has already been processed and cannot be cancelled. Contact support directly."}]},"time_off_request_cannot_delete":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This time off request cannot be deleted."}]},"resource":{"errors":[{"error_key":"first_name","category":"invalid_attribute_value","message":"First name is required"},{"error_key":"date_of_birth","category":"invalid_attribute_value","message":"Date of birth is not a valid date"}]},"nested":{"errors":[{"error_key":"contractor_payments","category":"nested_errors","metadata":{"contractor_uuid":"72ae4617-daa9-4ed7-85e0-18ed5d0ee835"},"errors":[{"error_key":"hours","category":"invalid_attribute_value","message":"Ella Fitzgerald is paid fixed wage and hours cannot be set on a contractor payment"}]},{"error_key":"contractor_payments","category":"nested_errors","metadata":{"contractor_uuid":"2d7bf62c-babf-4a12-8292-340e2d9cab28"},"errors":[{"error_key":"wage","category":"invalid_attribute_value","message":"Isaiah Berlin is paid hourly and wage cannot be set on a contractor payment"}]}]},"compensation_invalid_rate":{"errors":[{"error_key":"rate","category":"invalid_attribute_value","message":"Rate is not a valid number"}]},"compensation_invalid_payment_unit":{"errors":[{"error_key":"payment_unit","category":"invalid_attribute_value","message":"Payment unit must be one of Hour, Week, Month, or Year"}]},"compensation_already_processed":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Compensation has already been processed on payroll."}]}},"title":"Unprocessable-Entity-Error-Object"},"examples":{"Example":{"value":{"errors":[{"error_key":"employment","category":"incorrect_state","message":"The employee's employment is not in the right state."}]}}}}}}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-employees-employee-id-rehire.api.mdx b/docs/api/get-v-1-employees-employee-id-rehire.api.mdx
new file mode 100644
index 000000000..313be3337
--- /dev/null
+++ b/docs/api/get-v-1-employees-employee-id-rehire.api.mdx
@@ -0,0 +1,71 @@
+---
+id: get-v-1-employees-employee-id-rehire
+title: "Get an employee rehire"
+description: "Retrieve an employee's rehire, which contains information on when the employee returns to work."
+sidebar_label: "Get an employee rehire"
+hide_title: true
+hide_table_of_contents: true
+api: eJztXFtvG7mS/ivc3odMBmpbkhVf8rTZXOb4IZMgyezsQSboUM1qiZMW2UOybWsC//eDKpLdrdbFkmNjgYM9wME4Eln8WKwbq4r6ntyks9o6nUrlYGa4k1qlbllB8vxzAospCAEiGSS8qrpDbPJlkDg+szjs9aIq9RKA+T8WoBx9b8BWWlmwyfPvyXg4xP8IsLmRFdJInievb/iiKoHFkckgybVyoByO5VVVypzWO/7T4oTvic3nsOD4lweZ6OmfkLtkkFRGV2Cc9MtdgbHSTwkDrTNSzZJBD8KnObC8NgaUY2ES0wVzc2Ce9BH7CED//hy+l2rGZrUU8OWnuXOVfX58LHRuj4iRR7leHEfGpRVfGl2W9P1xO/0/Pem05EswT1mhDZOq0GZBm2Vasbm+Zk6z2uLS0rJCQimOkttBAkUBuZNXkAnuYL8NCr5k13NQtA2Ix2XA1UZZXOdam29EvZAlZAqus7k0kBmotHGdNaZal8DVxkXCd6wo+YxJJejo1AwXdnMw7BdkD7uWZclwFcaZgmuG6zC/DvGhi5AQIbSs1F4OsrqWYr8948h4kpHgE0s7ZZGcZ2gjtZl13NV2P/odmi0F5ikcsY91VZVL3D5XTKorXiIamu9ZYMF1oHVWx+P4WWmXWXA/HyWDBFS9QDWruHGZkwvUkqIuy/h383kGpZzJaYkfXnEjuf/TArda8TIZJIFs8uV2kLhrnVVgclp5zg3MdSnA7HHYv4cDXREmaRln7lqzQJN1aMZjyPWi4mp5xD41Is20KpeMNB1o634M/uNaujly72P6UpuKgXLSLRli6xwbwAEi8dtvl6/6IoEcNsDFO1Uuk+fO1HA7SDgp2D1Z8cQyAyTWc27ZTCtgUjnNvOJuWO92kNyk4E0hCV/4Ox2tWLJkDBcnQzE54flUTMeTUXFejCZ8LJ6djAo+GZ0la0xJzvPxxfD0dJhOT/OLdMLFWXpRnEIKfDQ55bw4u4DzpN1vwUsL6yYmGQ/Hk3R4mp4Mk4360pWxzRYkUN6kzMl5Pj0/gzGkz6Ynw3SSj05SPikm6bQoinwKYjQ6R5BbBZZoIxeddCXC/UDsJyHpcDU4G+IpL2v4YeYKPpmMRhen6eSEX6QTMT5JuXgm0uLkLIfT6fTiIh/uzdxROhzdi3tinJ8PxWSSnj87m6YTMRHpNIdJOj7h8Gyc5+enJ9PBnezbfKytmbml/w2S8XCy7sZ/1exlcNu3g2SyeYhjb3StxB/qD/UzQ2008FcN1oFA969rkwMTGixT2jG4kdYdsbf8GzBbG+9/K6OvpADh9VhaRlb1KNLbbJClJyi97zNyNvdGmhR/72BjdTO/qcroHKxFC8tek2H6QzH2hyLDtuBLNudVBap1ulMtlmh6lro2cecMl+dSWQbGaGOZrfM545Z9DQ4j484ZOa0dZCSxXwcseMhIoeCytEzUgKaTq3YmxkK0ma+d+OW1X+YldzDTRoI9MIAhmGneTH/qwyDy2wttgAlwCOjoD7SU/QANMUsDgiJLQoJB4mrYFj5vDS83hi+TQSIdLOymsG+NavYNcEJAudyyBo2602l8rCCXBTmjOQQppOlM53lt7BH7tKxkzsty6cO0b7BkUqCrolk4vjnD44obvgAHKAAlR8F3uiVJTq1BfQA0pIBjUbw8JVKHSCqqTZAyNjO6rqSaWcaVYDlXbAoYZxKaaS1LwXKUg0UYP+dKlBjISOWlt3MNOGKXRbuQtOyrIo3O/Dl+HXTiaB/2BJGn4I90/2sYysIhLb3fD97ef0msWaC+zfYIeN/H/QZpZHyqa9c5u5TNQIFpTy2QjsywtSl47hnCFQMlkD8moHBccLfxBrIK42VUbgMlXHHlGM5DmkFAlkGTg+2TipFOU4SIZiNYpGkJR+yNNiz4ssEKCcJHrPrq/5shqq90tvETdBRfPfunrRVF+6cVvCuS55/v2suiLp3EixpRRD3qKV78eF3Z4jcHqPTq2laqWVwZp3EhJH7Fy/edlTCQ2ri2Z8jdUvMrX0ATG4ZQc867YpNr4++pAgNVH4O2DL57hd+U/KuG1jyY9r5DZIiit96F0YuW4OeWoqrLkqJ3P66uMqd3D1yxc5sGkDPcNaQTWL0N0p/+Lt08facg9c4vud0+6m2QHT8Uj+Z28P9n/u9w5khpq8Pu3ZPQ+NBVjyI7Jne6jSN2SYFbpa3F+yxavDm/AtbYoRKuoLR4dsGNREfRmJUklyavS25+8nBTCn7SdyRwT5PuDjcM8AK9eiubcvUt43mua+UyASU4yGpV1EqAyCoe8l6dIObzSqyRTLlPcDUuPlkL1pKOm0ve1EpINXsLbq4F3SXjaqxZjc5gBdgVGFksM6lIdHNEWmkrHxTZPzEMwFVZWBU9J0bZU2C0vgRxxN6XwC2wfA75Nx+kYMQa4DC+wIno2rdtgZd4T15mkeKjbgDZGxZkUwDV7mMDwIW0aKEyo2vMcO0AFkZkql5MwWyG2AvyV4B+8POZn486Ed1uwBUkIcu1KuTMNtCaWPMgrq3P7oJ54RgeqWOY0miD2UVtXTew2Aws7rbg1kVtyUq5kG4Hwg2DD2bhG0QcaDCiwexc16VAzDxwtsGMV2SpRYsXlGgSrVtQNkM2YtvMy9dKYDwIHc2hG5Sbc8VO2EIrN7cYExa1qzGXgfhC/iyTStTWmWVmocRcglaZ4jK3Wa4FJg1iYLYVcTv6cH7+inMZzt0gjvshDMs8PsAomvBXzUv0IqdMyJlszM4OuDYCsHvAtTL3Yw9H+1HmhNWug50EsB4rZXh1UWSVLmW+zBRf7HnWi3sxcbHpfPsgakUaBaLRF57npuZlZnbrzMqwAyz3Cz+P4byGY9MSTTlGVg0eRgAl2C3AKyDnmoVEyi7v2Jt6CNqXXrkFUA4QIXsa/o4bMDBcgOmiiFmdbZhjgsvuc+zN4MPPPtbzLOMG9peAKS+5yiGrqzvs5XZvvQvVS64ok8fFn3TsfjW7+9jnupQCrTr+3wOOYQUFog8ZFb30xqQJIyikYAEBeqBw+NuhYXnm0WA1uVWKpDcBG7AqhGwGUFa1gq1QG/fYiNmjiOJlqJw1ZSa8dtlODoPwaTXV3GAYHsc9JP+iDmPAz5qlGkgewtpmHhDBJ8o9YoFNhWtpzGaHLDAml3sezYcVGSjMH2EQ5gzPnTaZprrTVmz9kYeraUPA3/fa+MZjEaSwJOVo+5pyXw//Y8axvT1ucHPWcUNxOy8cGLrr7xMFrM86nH/vm7j6yQZ6T1o1blMTlKdkQVGuQLmwi5ha3Bf/yvgfQr5C6U7McXR7pcGSQzYz2lpMd8TFFdBlYFesE0YcHu4A3RGaiCLeC3qQKGrBE5nr2uwTGN7P1f0DqXc0R8GMY8WwhyboeI5+sHxAe/Pe0+8A8Es06lEY/TeoLOB4UEuHWZ+w/NqVPBTdMLdw6axPp7cYfdghsELGSwdmC9osUNl9b/8h4NKyKaBxawDHUksPKqUapaUAMICt1UILWVDvRgM5ZjMfEmysGFVrh+0BeE6usNwbSgvmKlhxu7QOFs2gaMP7sQFZAZv5/qY94gQ//kcM0CqlVqsVo/RkwLngN3JRL/o4bW0qjnt+RKivb3IAjCICBjyJ0XBIXC21/lZXu3j5iMBiwNX09GGt/Sf79ChZrX21dZ3PvaR7c31IernyuH6K/0xH4xPc4YpBm5Y6/wamcf6UdMPGuIOEv0dtYzBMEhEC4ZU8oFRMG2xZcpqZWkX16G/fr72Oc/d+msOx4OrqcTbFRRua2vttpwdz954KEFhKzRy/ecxtYVxIAXhYjzl+w2i9++1xHfYeouhzwr5J5MG3uSKG0WLFLPQPyOUK6M2btLXFXMSBKfZ9NiWxqSUQ7zrBO7fQQvKQbT2lXWm1djRNzm5XaL42/T6puoYIi0RYs3h7h0i2AW698o+iXSmX9fgXVwvWmFLoPJ9nbm7AYs9XBsH5JJ36XR8BbQsarIfzKvIlNmDxKy5LHop5GPGXV8AoN//i5T/YpwiORc/YqR9pbSkZgU7yd+yrvFQD9lZfAfuksanMsFecypFdh9lpAD84bGquL5FIr3ZEeTHuHCwqusRiozaFdIy3/Ry1Dd2/unapLlL6PhCM10w5U9xpg6k9Lsv90npclvdJ6XFZdi+6fQDx3h2zY3Nus+bbh8+m+GpuU/DAw21WY9Qe1PQKBzEwsMATp9J5TB60U6ZQIDHsE0CmU2e5VjGoXsgbEJmQdlobC1RMauvWWzbWHX2A9nVyC7FutTH62aF720isYtAuK7CfcoW7rzqgSetoiOfCI29PDEXBx+NxysXwPJ0AP0v58JSnZ6Oz0/Pz/GQ6OrvYselIbUHV7vvE/r7A5+c3/tNbjefslcRaOHvli88D9hKL0kdJnysRRWiAvTeK0MkfTJ+PqDG0r1ZRPgnRti/xPzmKNqw93F3JGsr97SMVW5ptr7nty0hSSCXtPAtZTvSu2EjgQ69HyEkHBvk7PrbI30jH2sV7OcGm85lI3xWFWWcAXDY6/BTfovBIlZe1QIvuCaFtMWDtmszkvkXpx9YgIn3KvkvncNeL05C1IUt8bbSasXD77q/xt6zuIebeJIPCu3bM4v0tK190/QmOZkdsND6ZPHu6QcXmWsG9+yHe4+zYDRGVfDRcKZRix0Ep812Zho3KI2rfAQ7bSo8d1cHynZuD7bT3tskqX8LpXeD3SWRvhLW7j+BTty++7cmg0w+PjgwLkXLU8VJfd9obqJdrV3NDe7e/dzYBl4zdfH2B6OYIHmaBZpPBk/kY1t7t88PA/d0hrRIC7WilUNHsDk+H39Oce91A6KGUYPQVexLmPGlfEih6gLWQzsVRNnqVKbcyf+TbOac2v2i/Y7RJQcZhV1gFIGzHD4Vr4Ib4I/LtOjSHb9kdfX0ww3/HtvBoZ2ZUFjUhZDVto8awcVRr6B4xR0+RxPYkeS/n7BFgDp/e6vDcMVtX9OxSUHBULvsV/mCO4h58BfTB89C95ocOZL+g6FWzdrWLSWNddr+Glzc4l6le28uatRLkH4psKo2bH77KK6qrF4ymN1fj4EGpbcIHgGRz9ivTNr2g9wniQ/B+NuYwOR2dpYLjSzYQZ+n5Mximo3MQz8QQ4Pzk2Q6TRtWwe1xKy5KzN9L9PcNUnKCOX47GHK9rDBWWZHjeq4bhy1ntr4hNqTkwYcNF54E5NRZn0+J0nKdTPi3SCR+N0/PxxTg9mQxhLC5yPh2f7+DU/azQpeWSz9l/gymlatiEfMG3syrwam8OxZgalPXxdJP32N23s71Xa2cLa4hGu5LebbrciKS5XKqd/aErw+59W8PZvRsjwxLsgP0O8A1TTcrN6endP4FvQh2TJo3tfeCrUlxol7XXHYd6u9LAv/JaMd3Y7H73Q9md5SYSrN6eYvt5vMSshqwHv9XELYUnqA2fLlEhZ+DSq1HalDyavzIpUv8Oe+01wgdwRsIVFQTXXm0P2PVc5vM2pOr9MsPdv6OAT1xtrit4zr62u7PP8dy++gf7Pkz3/CR/1ancURwsFYk3+Zg2LehfvKz9BkZ4vXG775t38mph2f9N6XcZ0hfvL9P/adKdtPwcuKCorwUQ3gqvLvMK97KQKrxFRDeWopgL9uL9ZfOjGtxanUuqe9P1id4S4gB8PkkPCRU9lW+7uwZ+TOdl7hPLPi+koopph/aBz1h5JdPOb3EEgmnn46cIA99EYnC6jd3tLzOMh+Nn+Dx+9AwfwAkoeF06/7I7fn57+wXfk9gK+DfgdpnSM8zOsXd/O2V1JB5Uqq/AGCnAS/yHKNdw40BZurSgKHml3PqTLoOoz3f8tAuKRyTVR9zQ2Ih888zVHbQU2p0gd0Lqjz4mLXHz5HlyfDU6bpT7+HtHS26PG/WmnoSgTrUpUXaDQPBKenlIBSxIKNaswStY6B7LPb3UJzbxa9zXFsIbab43lMTcRrPCr3HPFvLa0AX88/d4pXqRo7F+UeP2P3/pjvqIkuht9IaxjXwixCi39OMVwA3pcf+BKpFI6S0V47Wb4wU6FgoHyUfq7viRFTyFLQtQbsSX9qOn8r8Q8+L9JcpI+8sMrRYNErQ09l3xEcyVzKFzHq3S03PfYxp4LHBpdBgp/RvrMDZMXXuiBmWuF1SeIhxPLHsdlITFjii0OULnNQo7beM/wo8IcJ9uCjb1VVyVfcCH3iGn4Es3KFDh2/9q5Qe5UWnrFlx16PyCaUfVdTSb3Nn39mcM/q89WxAPBzfuuCq5JDkivfke9PlzcjXq/JQG8uX5qucLm/yCbcfW4Yzv39Gb/GbK21v8+K8aMMb4/KXzKzeoPkJShLPFS3W59NOH4NCesq0ucstm4itHtezYsSQ8uVzx4b5z2rvQw+D9m/vTjXz1/NscjDRsbr0LWqXKdb5b+/mOFY/yy+tPye3tvwA5SrRE
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Retrieve an employee's rehire, which contains information on when the employee returns to work.
+
+scope: `employments:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-employees-employee-id-state-taxes.ParamsDetails.json b/docs/api/get-v-1-employees-employee-id-state-taxes.ParamsDetails.json
new file mode 100644
index 000000000..f3db089c4
--- /dev/null
+++ b/docs/api/get-v-1-employees-employee-id-state-taxes.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"X-Gusto-API-Version","in":"header","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"},"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."},{"name":"employee_uuid","in":"path","description":"The UUID of the employee","required":true,"schema":{"type":"string"}}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-employees-employee-id-state-taxes.RequestSchema.json b/docs/api/get-v-1-employees-employee-id-state-taxes.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-employees-employee-id-state-taxes.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-employees-employee-id-state-taxes.StatusCodes.json b/docs/api/get-v-1-employees-employee-id-state-taxes.StatusCodes.json
new file mode 100644
index 000000000..569654027
--- /dev/null
+++ b/docs/api/get-v-1-employees-employee-id-state-taxes.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"successful","content":{"application/json":{"schema":{"type":"array","x-examples":{"success_status":[{"employee_uuid":"c963cb99-fe1c-4aa8-9d48-1ad211ad396f","state":"CA","file_new_hire_report":false,"is_work_state":true,"questions":[{"is_question_for_admin_only":false,"label":"Filing Status","description":"The Head of Household status applies to unmarried individuals who have a relative living with them in their home. If unsure, read the CA Filing Status explanation.\n","key":"filing_status","input_question_format":{"type":"Select","options":[{"value":"S","label":"Single"},{"value":"M","label":"Married one income"},{"value":"MD","label":"Married dual income"},{"value":"H","label":"Head of Household"},{"value":"E","label":"Do Not Withhold"}]},"answers":[{"value":"M","valid_from":"2010-01-01","valid_up_to":null}]},{"is_question_for_admin_only":false,"label":"Withholding Allowance","description":"This value is needed to calculate the employee's CA income tax withholding. If unsure, use the CA DE-4 form to calculate the value manually.\n","key":"withholding_allowance","input_question_format":{"type":"Number"},"answers":[{"value":1,"valid_from":"2010-01-01","valid_up_to":null}]},{"is_question_for_admin_only":false,"label":"Additional Withholding","description":"You can withhold an additional amount of California income taxes here.","key":"additional_withholding","input_question_format":{"type":"Currency"},"answers":[{"value":"0.0","valid_from":"2010-01-01","valid_up_to":null}]},{"is_question_for_admin_only":true,"label":"File a New Hire Report?","description":"State law requires you to file a new hire report within 20 days of hiring or re-hiring an employee.","key":"file_new_hire_report","input_question_format":{"type":"Select","options":[{"value":true,"label":"Yes, file the state new hire report for me."},{"value":false,"label":"No, I have already filed."}]},"answers":[{"value":false,"valid_from":"2010-01-01","valid_up_to":null}]}]}]},"items":{"type":"object","properties":{"employee_uuid":{"type":"string","description":"The employee's uuid"},"state":{"type":"string","description":"Two letter US state abbreviation"},"file_new_hire_report":{"type":["boolean","null"]},"is_work_state":{"type":"boolean"},"questions":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string","description":"A short title for the question"},"description":{"type":["string","null"],"description":"An explaination of the question - this may contain inline html formatted links."},"key":{"type":"string","description":"A unique identifier of the question (for the given state) - used for updating the answer."},"is_question_for_admin_only":{"type":"boolean"},"input_question_format":{"type":"object","properties":{"type":{"type":"string","description":"Describes the type of question - Text, Number, Select, Currency, Date"},"options":{"type":"array","uniqueItems":true,"description":"For \"Select\" type questions, the allowed values and display labels.","items":{"type":"object","properties":{"value":{"description":"An allowed value to answer the question","oneOf":[{"type":"string"},{"type":"boolean"},{"type":"number"}]},"label":{"type":"string","description":"A display label that corresponds to the answer value"}},"required":["label"]}}},"required":["type"],"title":"Employee-State-Tax-Input-Question-Format"},"answers":{"type":"array","items":{"type":"object","properties":{"value":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"}],"description":"The answer to the corresponding question - this may be a string, number, boolean, or null."},"valid_from":{"type":"string","description":"The effective date of the answer - currently always “2010-01-01”."},"valid_up_to":{"type":["string","null"],"description":"The effective end date of the answer - currently always null."}},"title":"Employee-State-Tax-Answer"}}},"required":["label","description","key","input_question_format","answers","is_question_for_admin_only"],"title":"Employee-State-Tax-Question"}}}},"required":["employee_uuid","state","questions"],"title":"Employee-State-Taxes-List"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided ID/UUID is valid.","type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["error_key","category"],"properties":{"error_key":{"type":"string","description":"Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error."},"category":{"type":"string","description":"Specifies the type of error. The category provides error groupings and can be used to build custom error handling in your integration."},"message":{"type":"string","description":"Provides details about the error - generally this message can be surfaced to an end user."}}}}},"x-examples":{"not_found":{"errors":[{"error_key":"request","category":"not_found","message":"The requested resource was not found."}]}},"title":"Not-Found-Error-Object"}}}}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-employees-employee-id-state-taxes.api.mdx b/docs/api/get-v-1-employees-employee-id-state-taxes.api.mdx
new file mode 100644
index 000000000..97611abec
--- /dev/null
+++ b/docs/api/get-v-1-employees-employee-id-state-taxes.api.mdx
@@ -0,0 +1,82 @@
+---
+id: get-v-1-employees-employee-id-state-taxes
+title: "Get an employee's state taxes"
+description: "Get attributes relevant for an employee's state taxes."
+sidebar_label: "Get an employee's state taxes"
+hide_title: true
+hide_table_of_contents: true
+api: eJztWutu3DYWfhUu+8MtIM3Y2bRoBk13jThpDGxSt3a2W9jGmCMezbCmSIWkZjwwBuiD7L5cn2RxDiWNNJfY2W7/FPnlsUQenst3rtQ9tyU4EZQ1p5KP+BRCOj9KoSi1XQL49tdYydQHEWAcxB14nnAJPnOqxK18xL+DwEQITk2qAJ450DAXJrDcOiYMa8gceEZUGFEZXJkrczEDJkUQzMH7SjmQLFiWWecgC3rJMqGzSuOWvWTYXDgFnk2WbGLDjM1sgaslW1h3y7TNSL4Bu5gpz47PTpmDUDnjmTK5dQW9ZWJiq8BAZDP2vgJPz8JMBFZUPrAJEvQLQPamzlYlSDyOmBiwN9YTq7YorNHLpMsq02oOvmUHD2VhBsyLAmoh6J3SmuFmNhNzaFnwUYHMKzPV0JyHKnPgS2s8sMyaIJTxrIAgSJE7REnozLAsgdm8FoXBXQlZAJkQB7ggq5wDE5oFPlgUWBn2XeWDJV5IJw1ZMuAxLfZMOOSqdODBhKgfYZhwTiwH7MJKsUQulI+PWCZMFHgCqKywZNY1wjC4E2R9a4CBhgJMSNikCkx5JsGrqYk4EVrbBfGVW7cQTqIRShHURGkVlmyhwoxBnkMW1BxSKZCxXIGWfsDemaD0+i2Lb0VHHF+VpXWkIlTPzVxoJce5s8UN6ax+UJXjYG8iUoReiKVHoW6u+JPDo8P08Cg9PLri9Q5TaX1D1oun6iUp8bPP2DGZLVdamSkzsGAzFTVqXfBX5kwsndWaHcsCrR21TRhQEw1RB3Gv2NxNLwkPL2tURgzd5ErD2MBijIvHcfHNGv9rUE4Qxx7Vo/LRlUmjOhqMD6yZWOGkMtMxQrTyN2goNJ7NaWlu0VDKTEdXhrGU3QiUYtzZpwxaTkOAm3qJB513V4iFUIF+0F4HcwWLm8iMCN3YQH4ffasOKn6vblD5PrMljNbyjDuRbuRAyBue8CCmno8ueaNCdiHu2DmEquTXCb9Lp+giqTIBpjGgpuhuuAOKCUgJEteVwokCAjikdc+NKICP+L9ScrD0+Ow0/Sc4jzE14QoD6wyEBMcT7rMZFIKP7nmky31wykx5wsFUBZ7z5PDJl+nhV+nRl3iShFxUOvBR9/lqM26fIC+FMuDJTugC6UR4kBQo55EXJry3mSL3II9a2srRgkxoPWCnOTNobOVZ6excSXQYWiPKUqsYfw88uyyUUUVVdGlffz4LofSj4VDazA9Ii4PMFsNGa2kZgU/vh6JUab1TmelnNcG08/gLZKPyIAd8lbQabk1bVUo2ui1FmG1lMnSMd+9OTxroNjt5wpsMxUfBVbDfJKvVdcI9ZJVTYUl2foFRySyPswy8P67CjI8ur1cd3Di/ENOGbhPbPZJ+cniIf/pM+ooo5ZXmCcegCSbgqo6+h794XHq/zSXFX45nw51An6NzapK1AxPXfaWNePbsq79mk2fP0hyOsvSpEF+nz+TTr9MjIZ8cHQn512df5YhU9B4+4i+OecJ3hRg+yoX2kHDlx+ir43pHlL7NfcSD8uPmwTi3btwEDr1sqWgxAc1H/FV08fMowC67vgYh0a6vbeVhZrVkUdqIU/QByypTCOcU5T2p5kpWQnu2mNmYmbFO0YLyhVZzPI88IsygqFO7clSBkFtUxlcOEoZBhND0jWBBuCmE5wfjiRbm9oCKn3SyLIWnuun5gbG2BAOOGesgB+fAHbAgJspIuHt+cHjAZg7y5weN4ywWi0EeJoNMDKZ2PkSND0tw3hqhhzHupVHOIZEYzEKhD759ccx6GsN6QAtD4PlmKL4dXGEQuoUlH/FIpcEGuk9ZhZ5hChE6EDsHDVngCbfl2pRzoSt6ydc2O6fChjy1ef2m8/pNbQqKLpghNpae7FiLBtu1+HVn7RYQeitfdlaeWPbWBvaTCrO47nqV8LpG6EmFbK/rAwq7TfJv31ChwEdYAyCdj0J3wwEa7BizqTAZ7EC5wnpYVxSNDYCsC+q2jO7GtAPPXhzXusJamrBcH9LDb+XhD4UvSNnAt5T5uKwm4yy4oYSng1LmhNWTl+lTLGQKxOa2SFHmQphKaKqpWux2ZBqLjuIewvDbqpiA47vNffTHGvtYSoXrhGYdu29Z+2dbUR3diEgF93qrKGxlAuL8hdAqt84o0bE2eDYDB4NWU+ut40Xv1IdU9YL6hmy5R1n8cHD4//aOmCs6oR9D81tYsNdY2/1IeeZvWwo7p6JQi8W6MFzaCtGURwqblTPqQRn25JBJLOttjm/RBa1jDtL6n06/N+jGzO3M9/tCZ1/on8EnkW9qKEm0XZV/AYNueNuA2lubsNM6t2nMU0uiieXTnlBXE/g4c14TNRWg8B1h7eSXKGzpcBARVKxFNgqP7ZJ3O7V3QhptWrV1yIO7F5ZpCAEce3fetOSTCfYXlAuR1O4qpqF8ySfWahAYc1BcTqL2a5uWi2bpqlfpbBVnj9RUbcWHZDxmfoZwCCrUvSJCpjl/qy1YC9bSi3Jt0TWxalCxbGhq5raDTGPHX2C/X7f2ymhlgGENwiL4sa3Qytx6hGl0noflqYx6j0lOggkqV+C2zv68EXOq5mCiYb9gKfUGpIKqlAIbSloUcU4cfCjs7DLjQx69x3Tx7UOSntB/k7o/ayY4HQVfwF1IWExWCYvRI2FNRE7YCcJv1QknW1CLqjyNgIshps/DK+vYVR2YrnhkosVuHI1QYgUZ03Acd0nlSy2WjCDqB4/HdB1mNnueY9M/heY/cVDVA3PCrYHvc4pYG31ZssN87SNT53t03ke7VU/IOIig2SU2cJL6iTW4Itt8tep2kpf1Wderzed09HXCyWexKq0jXEpJLL0Qd+kpIi/9oZY8fRWR143a/2tcaW3wCF02intAu1rz1VYAuVhrp9bVWn3omrsiCQ5jWWQjYaYGfn1kgokZzyJP7qaoRyWR3iywiSg1f2kzHtXLZsr326//Xie+3379T+fQOvs9OpL2jwf0n0exUMu6+iBO4oiWb0EsQq/PSozA+6LaGlofjJMfhu0Pbd7Z4mhzThOzZzdVfpA0+PQfyoea8NPDp9thBLu5V7Yy8mMmJ3tIMBxVxisMFAJoQurA28plwKQFz4wNDO6UDwP2RtziSNnFeq2ZlLHTkyHNm2LjpiRGyk3n7KnIOetIDxtFU3z+ES6/RXUcTZ+JAFPrlnvOGD8qRZ+XkGFixtkJ1DLTdmazrHJ+wC6WpcIB4jK69i0s1+k8prv2RmnYzk3j+CU2tS1J8ruW649grZtTIyUajDekGiP5mnO6+lFmGhMcdl4TiPVEsGxSKS1ZhuO8ol4/E0bShEWZOA/tjIeJ5wK8F9NHlAFnDSMSglDa15c8a6WmbIpN91qdNemGS1+5XGT1rYmhAFN5Kniir/SHgcaGcU5O0gHWZc/+vEZ8Fy+jzsaOcHyPgyxE9A/aQP1GJ4y9tSElJ0tf4qHp9xG1Lbu+BHELwi9Tskpnxnsh7uJcvr8MJ8GpnYNzSkK866S4cVFfaMJdAOPblisKuXeunzQpsjvfx3zX3xfnukm3gesu2hSiXbgtzO5tfaHW2/vCYd4tIMxsfceL6R5n3yM+nB8N29ve4X0v/K6G/RtfD27etIKVw96xGeGIUsXJfSqhoPH9jjq2sBsGifRSGi3jPhJxD+GdNM+clR+gWeLr7ij+HON5BPiOgXzrgnh4c+FC1QwIR1cw/dNrEqmGOWgmqjDD2JW1PeP50gcofs8JkcKeA6jxyGOJUbtMvKU9PjtFINTXSL3rn4TjbY//Pj8HN1cZdDS9vnihyDKkhUOJR2MCSOn/1OakYbVj8vgT6DhYsvG2+MCzl7VjsPbu8uyUSZtVeJ9LYvylTsIioyRcX9acNKeyH2nWji6ZcCiE0gSV+u3f18hAbZTWh0KYDh36KGHfVwObAtyvq4FPXzN8+prh09cMn75m+DN/zRATUYC7MKT5HWYsyr33dWlwyedHFHXr4oAnfLSzO6vrg+uEz6wPuPH+Hj8heOf0aoWP31eAteHlNZYnTokJJqvLey6Vx9+ynSjvjcef/1hH0y/YB67nd8rU9EJm2amO2hl9XyAa/dQfXHwcg3/qzyj2aDZqcPenK62i11UrFkJl6Lzb6rh7Vep3Ly9w2NCvm9o6qf7RGUv1DXx/H1dc2Fswq1Vr74D/U6Ox+i9nLI0d
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Get attributes relevant for an employee's state taxes.
+
+The data required to correctly calculate an employee's state taxes varies by both home and work location. This API returns information about each question that must be answered grouped by state. Mostly commonly, an employee lives and works in the same state and will only have questions for a single state. The response contains metadata about each question, the type of answer expected, and the current answer stored in Gusto for that question.
+
+Answers are represented by an array. Today, this array can only be empty or contain exactly one element, but is designed to allow for forward compatibility with effective-dated fields. Until effective dated answers are supported, the `valid_from` and `valid_up_to` must always be `"2010-01-01"` and `null` respectively.
+
+## About filing new hire reports
+Payroll Admins are responsible for filing a new hire report for each Employee. The `file_new_hire_report` question will only be listed if:
+- the `employee.onboarding_status` is one of the following:
+ - `admin_onboarding_incomplete`
+ - `self_onboarding_awaiting_admin_review`
+- that employee's work state requires filing a new hire report
+
+scope: `employee_state_taxes:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-employees-employee-id-terminations.ParamsDetails.json b/docs/api/get-v-1-employees-employee-id-terminations.ParamsDetails.json
new file mode 100644
index 000000000..230d65c22
--- /dev/null
+++ b/docs/api/get-v-1-employees-employee-id-terminations.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"employee_id","in":"path","required":true,"schema":{"type":"string"},"description":"The UUID of the employee"},{"name":"X-Gusto-API-Version","in":"header","required":false,"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.","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"}}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-employees-employee-id-terminations.RequestSchema.json b/docs/api/get-v-1-employees-employee-id-terminations.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-employees-employee-id-terminations.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-employees-employee-id-terminations.StatusCodes.json b/docs/api/get-v-1-employees-employee-id-terminations.StatusCodes.json
new file mode 100644
index 000000000..43aebab91
--- /dev/null
+++ b/docs/api/get-v-1-employees-employee-id-terminations.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"Example response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","description":"The representation of a termination in Gusto.","properties":{"uuid":{"type":"string","description":"The UUID of the termination object.","readOnly":true},"version":{"type":"string","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."},"employee_uuid":{"type":"string","description":"The UUID of the employee to which this termination is attached.","readOnly":true},"active":{"type":"boolean","description":"Whether the employee's termination has gone into effect.","readOnly":true},"cancelable":{"type":"boolean","description":"Whether the employee's termination is cancelable. Cancelable is true if `run_termination_payroll` is false and `effective_date` is in the future.","readOnly":true},"effective_date":{"type":"string","readOnly":false,"description":"The employee's last day of work."},"run_termination_payroll":{"type":"boolean","readOnly":false,"description":"If true, the employee should receive their final wages via an off-cycle payroll. If false, they should receive their final wages on their current pay schedule."}},"required":["uuid"],"title":"Termination"}},"examples":{"Example":{"value":[{"uuid":"da441196-43a9-4d23-ad5d-f37ce6bb99c0","employee_uuid":"da441196-43a9-4d23-ad5d-f37ce6bb99c0","version":"d487dd0b55dfcacdd920ccbdaeafa351","active":true,"cancelable":true,"effective_date":"2020-03-10","run_termination_payroll":false}]}}}}},"404":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided UUID is valid.\n"}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-employees-employee-id-terminations.api.mdx b/docs/api/get-v-1-employees-employee-id-terminations.api.mdx
new file mode 100644
index 000000000..d7b96075a
--- /dev/null
+++ b/docs/api/get-v-1-employees-employee-id-terminations.api.mdx
@@ -0,0 +1,73 @@
+---
+id: get-v-1-employees-employee-id-terminations
+title: "Get terminations for an employee"
+description: "Terminations are created whenever an employee is scheduled to leave the company. The only things required are an effective date (their last day of work) and whether they should receive their wages in a one-off termination payroll or with the rest of the company."
+sidebar_label: "Get terminations for an employee"
+hide_title: true
+hide_table_of_contents: true
+api: eJztWFlv20YQ/ivT7UNigJTkK6311KBJAz+0DZqkLWAb9mp3KG5D7jJ7yCYE/fdidkmJtKWm11NRvYjaY85vvhlqzR7yZXDe5Ep7XFruldG5bxtk8yuG9QKlRMkyxptmeMSxm4x5vnR07HXdVKZFhPRQo/Zx36JrjHbo2HzNTmYz+pLohFUNyWBz9vqB102F0J9kGRNGe9SezvKmqZSI+qa/ObqwZk6UWHN6SkYybi1vWcaUx9oN1s3iNxSeZY80vi9JW2PRofZRNJgCOHi0tdJpQWl4QzGZsIw11jRovUpOhKDkQIfzVunlXh0fPly+Ism+xJHsZBZJtsjlj7pq2dzbgJuMrdA6lbz8vHwRrEXtobvUq+rEwzvE+Puq21d6CcugJN48L71v3Hw6lUa4Scz9RJh62uc6b3hrTVXF/amSWDfGoxbtERTGgtKFsXXni4bS3IM3EBypUw4KhZWcsE3GsAPF7d+LWX+dpN+XSpRJ/ihNDrj3XJQo98aTC69WOFC9MKZCrp/o/qVEX6Id6X021lVyB0ujEZT2BrAoDiVRcC2w4ovqX1KsHOxETuDb7TPtkE5QBdzZoG8Ht267HN7RoYJXDoFrCXfJbrXCW8k9xl2lo/Yi+GBxr0fjS/syubsSde1L7cC7ijsPkreU6XtjP0a0HHBgbww/o+6yiHHJxjBypQmVBIsC1SrWhrJQKM0ruOdLdLBSHDjVUZGLVlQInQkTuCxSDKPE9vOSjO4W+xpteAvEWzJUOGEbchc/BWVREnvG+iA2VZ5Aw97vwhDPYuLIyD8dX9LjileBSLonJSb52dnx8cWL/OyUX+Rn8uQ05/Jc5sXpVwJfLBYXF2LGntTln722JScmz77+SsrZ4vxcFoILKS9OZkIsJEde8NPzY7arvJiHUUmklceQYiezk1k+O82PSdVBLMQsbG429MnY2ezsaUP5wXj4zgQt4VoDXOtE958COo+UM2eCFQjSoANtPOCDcn4C3/OPCC7YRJqNNSslUSZCUg5WvFJycp3yQf0gGnZJ4Vuiz1fHeR9Vt326VTIfeOGeMt5gE7hFEBY5WXlfosYVWoLjFr/KbSEkiRMr5Al8IEzdcN1OgHw1umqJKfXSQQ+yKJxk9VEHijo8TyB9XI5HkSrud8x0APEJ60oDB6MxN0Ux4q0uaWAs3CtfRkstOt/ze2/1tb7WPxhPUrkHZ2oE57nHrfnbEDhy+3DVkRal4eQMShOsg+dBV+hc8kDQcKE9GHLqXjnMjsj01FgEdwg26Ngkd970HtS8hUUKdYyuiQmMhjthGpzDHe7mnjmx0x0NDtzyGj1aF4tU85qAPkAHzSyEg4b7kg0pIdXIk0Gno9vNn+2cbJNt1f6ax4Emf/n2Mv+5q+ROfYlcoh0ZsJdWX2FKL8aQRgjlC+5Qwsu3l9sxhDtnhEowprS3Jth4QPCOSnXsom5bZFk6M5j1njm4qpVWdaiHsv/i5MIble+Gny87gflg+YjMCC5ND4fCnTHUoSaePpmdnOezF/nxObG1xIKHyifu6tc3m5uMPeSuQf4RuWvzpTWhGaR9OCCPT1KicrNCa5XExCvvx+yBDx61iz8IUB+xZfPD03u2bRB/PMUTSHpRj+3eythr//6bYz92Eh77Q5Gq0ZemI9FYMb5kczZdHU+3NT9dDypmM31EqA7tqi+wYCtCcwcR3qiEkFxiHWHyhH9fYW0eJSHJy1NfpG3y8YDgvTLfWiP/QGZD2+S5QxGs8m20/NtEhS+FQOdeBgrC1c3w1DvCZhoA9pzdIpZM7JEcJybkNlb22MZORF7hCivgwZeofVd6xC7vWuex/icakoQDCjbEO4WJUruJJ3ITlfpozhjUVcYo8e7H4h3alRI4yMeOBvjCBB8R4qaSVFOjji3Y5aaIeaCrT2ZwrAR1HW/SS98zB6+7goG3XQsgFpJGhLp/Z/yie1HlIr6odiz7qtcKP2G1q9uaqyoCqtv9ZocfikZjnK+5Hsh5g37YS1188RoMA499WO9emv+fKv7bU0VXiB4f/LSpuIoVGxlq3fHnFVsdD8Z8QuB8PHWMSPQmY6Vxnu6t19TPP9hqs6HlTwEtEdQNkbhVaX6/WjOpHD0fmBOGWHz+U4eVIzg4pBxwqf9zR7eDHsKyruEM/dncbLJ+iPlr5v3HJ5q9cU3x2z8ObsO86+zUBRo/2Hvyl9yoj795/Z5tNr8D+lMuVw==
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Terminations are created whenever an employee is scheduled to leave the company. The only things required are an effective date (their last day of work) and whether they should receive their wages in a one-off termination payroll or with the rest of the company.
+
+Note that some states require employees to receive their final wages within 24 hours (unless they consent otherwise,) in which case running a one-off payroll may be the only option.
+
+scope: `employments:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-employees-employee-id-work-addresses.ParamsDetails.json b/docs/api/get-v-1-employees-employee-id-work-addresses.ParamsDetails.json
new file mode 100644
index 000000000..fc5537e46
--- /dev/null
+++ b/docs/api/get-v-1-employees-employee-id-work-addresses.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"employee_id","in":"path","description":"The UUID of the employee","required":true,"schema":{"type":"string"}},{"name":"X-Gusto-API-Version","in":"header","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"},"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."}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-employees-employee-id-work-addresses.RequestSchema.json b/docs/api/get-v-1-employees-employee-id-work-addresses.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-employees-employee-id-work-addresses.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-employees-employee-id-work-addresses.StatusCodes.json b/docs/api/get-v-1-employees-employee-id-work-addresses.StatusCodes.json
new file mode 100644
index 000000000..f24618322
--- /dev/null
+++ b/docs/api/get-v-1-employees-employee-id-work-addresses.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"List of employee work addresses","content":{"application/json":{"schema":{"type":"array","x-examples":{"success_status":[{"uuid":"080b6254-ce7c-411f-9f7d-5a3ce3c51154","employee_uuid":"6747692e-d2c8-4472-9c5e-183c65404fbf","location_uuid":"9ccfade8-82ee-490c-8711-5c0787bccde8","effective_date":"2021-01-01","active":false,"version":"3097e9d0efb09ba2e00a8988a93b3091","street_1":"91678 Farrell Meadow","street_2":"Apt. 835","city":"Phoenix","state":"AZ","zip":"85016","country":"USA"},{"uuid":"35d62f15-75da-45aa-9c97-adc57342b925","employee_uuid":"6747692e-d2c8-4472-9c5e-183c65404fbf","location_uuid":"10330fe8-36ef-4713-aa59-9f8a432abd13","effective_date":"2022-01-01","active":false,"version":"5f48ce54afed81bb11dd89461bd0e214","street_1":"800 Adolfo Gardens","street_2":"Suite 419","city":"Bremen","state":"AL","zip":"35033","country":"USA"},{"uuid":"3f3ceaba-6b57-4039-a31a-0004bef83c6f","employee_uuid":"6747692e-d2c8-4472-9c5e-183c65404fbf","location_uuid":"98383e91-c67d-4b69-a617-5a57f91da48c","effective_date":"2023-01-01","active":true,"version":"a8a78c851337676137e22caf56ffe5b5","street_1":"2216 Icie Villages","street_2":"Apt. 798","city":"Big Delta","state":"AK","zip":"99737","country":"USA"}]},"items":{"type":"object","x-examples":{"success_status":{"uuid":"64ee5fd7-3eb2-4083-883c-95e93e181cc8","employee_uuid":"d773461f-848a-40a1-8f09-b2ee4249d5c7","location_uuid":"733ab2af-9510-408f-8d20-09196967174f","effective_date":"2020-01-31","active":true,"version":"3879823d440f3a3215d129ac73c58966","street_1":"977 Marks Viaduct","street_2":"Apt. 958","city":"Pink Hill","state":"NC","zip":"28572","country":"USA"}},"properties":{"uuid":{"type":"string","readOnly":true,"description":"The unique identifier of this work address."},"effective_date":{"type":"string","description":"The date the employee began working at this location."},"active":{"type":"boolean","readOnly":true,"description":"Signifies if this address is the active work address for the current date"},"location_uuid":{"type":"string","description":"UUID reference to the company location for this work address."},"employee_uuid":{"type":"string","description":"UUID reference to the employee for this work address."},"version":{"type":"string","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."},"street_1":{"type":"string","readOnly":true},"street_2":{"type":["string","null"],"readOnly":true},"city":{"type":"string","readOnly":true},"state":{"type":"string","readOnly":true},"zip":{"type":"string","readOnly":true},"country":{"type":"string","readOnly":true,"default":"USA"}},"required":["uuid","version"],"title":"Employee-Work-Address"},"title":"Employee-Work-Addresses-List"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided ID/UUID is valid.","type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["error_key","category"],"properties":{"error_key":{"type":"string","description":"Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error."},"category":{"type":"string","description":"Specifies the type of error. The category provides error groupings and can be used to build custom error handling in your integration."},"message":{"type":"string","description":"Provides details about the error - generally this message can be surfaced to an end user."}}}}},"x-examples":{"not_found":{"errors":[{"error_key":"request","category":"not_found","message":"The requested resource was not found."}]}},"title":"Not-Found-Error-Object"}}}}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-employees-employee-id-work-addresses.api.mdx b/docs/api/get-v-1-employees-employee-id-work-addresses.api.mdx
new file mode 100644
index 000000000..90d967443
--- /dev/null
+++ b/docs/api/get-v-1-employees-employee-id-work-addresses.api.mdx
@@ -0,0 +1,72 @@
+---
+id: get-v-1-employees-employee-id-work-addresses
+title: "Get an employee's work addresses"
+description: "Returns a list of an employee's work addresses. Each address includes its effective"
+sidebar_label: "Get an employee's work addresses"
+hide_title: true
+hide_table_of_contents: true
+api: eJzdWVtz47YV/iso+pBkRrB4FUk91c1utp7m4ol3k069HgcEDiXEFMAFQHtVjf57ByApUZa03m3z0s54xhKJc/vOBeccbbBqQFMrlLzieI4XYMljSGDV1GoNYHaf7gUnT0o/3FPONRgDBk8wB8O0aBw1nuOfwbZaGkRRLYxFqkJUooH+K4McOdqRX6DXlC2H70hIVrccDBLWIKgqYFY8wnvJqQVEJUcUlUrVQCUyYiFFtRZygUSFhEXCILsExFqtQdp6jagnPhB48V6+l4apBubot515cw2U/4Yn2NKFwfNb/Lp/gy53Zt5N8EeyaI1VREgLiw4tYtcNOApYlcA5cDzBtGnGRzxpQzVdgQXt2G+wpCvAczxCFU+wcOg11C6PIH27BPTu3dUrB6YzcaDDE6zhQys0cDy3uoUJNmwJK4rnG9xpho3VQi7wdjvZif0HeePtuLy+Ir+ANk5IL34JlIPG5/lMMMh25SyOgiglwYyEqTOQQ0Xb2uL5+Pn2uSGvHAQrIaFzlfMqKakBji6vr9BjpwuixigmqAWOnoRdorVqtT/AaF1foKsKSSXB+bvR6lFw4JPuDG2aWjCP+lcG3a6EFKt2NeZ99/XS2sbMp1OumLnw/rxgajUd/Ecautaqrv37KW0E6SmFXPy5Z0hGj79xarQG+AXe3k2wAdZqYdfey9+qVUPl+pIxMOaytUs8v73bjgJJmye6GDynwTRKulCbb3AUBO7fIXrf9/k0uP9ZKuEJZkpakNaRjrCY/m4c/ebYqVRrusZOIfhIV03dCTet1/jeWGrbLmDbVri6EORBOYvShDDIGEnCsCJFlXGS0phBzNIwTBMXIkNc92SzLMlmRQSERywnSZJFpGApkDCP2SxNgqQqKzzBter0HcgKxirKISd5BECSImAkz8KQpCzI8qxkjEPupA1l4t7FUxeBIQncn8tG/wrPK1obmODebXiO46DIoOABVGVQlDSCIKB5kee0iMs4KBytsRrA3odOl3CW5eg7qjXUNfoBKFdP+xMRnuPLxl6gPE6dG3wE4OulAik++mOdZpf/xBP8L9HgOc7TIJx5l7XSanf83c0ldlnaWx+nfBZVYUqylFOSpJSSghUZoZylWZxEZRGlfxzWYRDHQQU5iWdQkSQLY0JpWpCiymkSR7TkYXwG6+hlrNMqyRmkCa2A52FZhiHneZHMwpIHEIXJIdZ5EKBLrupKoTdUc5DmEOmbVlhASVjsof6rhhXIMdLf75CO0yCOP4l0FTOgJSWzMs1IEsQFoXFISRAESQmVA676A6M6j/MYipCwWcZJUs4KQmdhRlKaZlURcprk7AzS8RHSXenYA01zmuUsT8M4zmbZLIwziCJGq3RWVZCW6SHQURTO0BUTgH4RdU0XYE6EdFbkI5zFAr2C2tIx1H/fQV0UWZwdQ323nWBhYWVGpUeVvwOzL9aenZNmCUBa8YzEUEYkCfKY5HnMSJFCEUOYh4zlJ5zEsyxOZmFF8iSnJAloSPIqKEgZASRRUvCUZSeclMUxLSNakSINAyetIjmPAhIUYTErZlmYJdUZJwXOSfGnnBTnWZFHMU+SoIppHIUpD6OCsixmaV7MZs8qT5ahH6h+MOgXQXnrMXvuoyId+ehayAf0N1HXIx/9+O3OR1GeZtGxj7YT3GjXBVoBI9yP73/XK/0k6/Vg13Gr0krxoQUkOEgrKgG661vEYe934dqD5wAeiztm73vBcRuESlhQ6Zm7bpDaTtjgUy9o8MVOQN9GvmjQjW8zhWtJeyN2vWrXxJzoMlGl9LgX9So7LZ6F2UvW+p5PQwUaJANkVce0ayt29vXSTsJ7mA3/mbwdzOfl7GL7c/w3gDK0e31T2xWEC3QDnXdv940XWrSCwxf2boLDqlEWJFt/41UXslJ61UGmJFqqJ2dha6AzqhJQc2/NPvleiv7tOBWHw7f707Kta9cdH1F1qfpZ7M/kxdFJn92fcW6X95+T2kNTP5SI/bhx2xWIve/vJtgKWzuGw/hEflX6gfQzlEP2kwfAENfh4u3WSUqC5LgD/lFZ9J1qJf+SXvcMC/ReIvReuoh0VoFx84YGo1rNAHEFBkllEXwUxl6gH+gDINPqLjaHuQNdvZr6pBEGPdJa8As3RD674MaYgdZKdxPhQbHtnx935mevzSOu9w/gCBi1sFB6fUaGP/Vimt40wLqi97SE3mZPjhRjrTYX6O26EW4cW3fJ8wDrfb3v66K1WpSthelu+EUaaj/WDZXFsfQpt9P6C1RzHNxZPxJ5TsiXl57V4CTTa77Qqm2EXBi/R2BUohL85Oa0KVtRc8RcSVn155dU8tpvF2Q3XY5meq/zCoyhi8+4tK4HRThYKmqDaKlaOwKVoAVI0Hs4e9aDlqbVFWWdpm6ZIrlT3CHX5cphCyWVva98kowC6/bA/7iP+HG8zEeEI+PwmQR5ol1+eAI3/G5H+f2jssQnGXnthJKfuqjdqWsaoA9AzZp4r4xWIZejaXZ8zq0uiHoErQWHbkPlasf4OHy0II3fuDhzO0PP7mwm+JHW7cu7GzcnHLLqpvYdfVdW94ee27Y7eMLG03SHtu7pj2x2u4QV2KXqd3Z40u2P5nj6GE53663pZrRo2k6P9ncG9OOwmWp17dZA/UVLG9Hds4TDyl+2R8H9Clbqma86fqTrv91rP2udZnyS57VW/BM8G/d6vG25cbW+C/4TO5ddejrhw2rLt4BAtV92HUrvWZAaHqFGtLVLV9e668Xl/c3aWFj9NxI6DmcEuFlJVspz7dPJr+vcGguPx4jRom2C3V7N/FTdgH4UDEZI79skX3Wm/uCUO9HuciD+O1GVR9iRPlf2V6iZWvlu0OvxlUGv+4RB113D5TdsXLF2BdJ6M/7UX9CU+Qu6Xzy+GqSin91F4BPMNalU1D5U+rd/2UeGH0uUsSsqR3zegP3kUvm5DZt9s/C/vZ7uoszCRzttaip8OPrE2vSJf4sfw9EU7JCYH26Zn2X/3QQvlbGOcrNxq9h3ut5u3eMPLbhb4fbOFSAtaOlC8XaDuTDuM9+tec5C/fXPfY/yDfrEBvukUUMXJNej+ocnfbEcW+SXC/3a+svU+79eRp/BtcPv9A8AO5j3t5Irco0dvTvqtA+uoDev37o79LAm7mpg/8E56aR7N5vuxFv1AHK73Xnbuu++wdj+GxfdCFQ=
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Returns a list of an employee's work addresses. Each address includes its effective
+date and a boolean signifying if it is the currently active work address.
+
+scope: `employees:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-employees-employee-uuid-pay-stubs.ParamsDetails.json b/docs/api/get-v-1-employees-employee-uuid-pay-stubs.ParamsDetails.json
new file mode 100644
index 000000000..9f169f1b1
--- /dev/null
+++ b/docs/api/get-v-1-employees-employee-uuid-pay-stubs.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"X-Gusto-API-Version","in":"header","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"},"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."},{"name":"employee_id","in":"path","description":"The UUID of the employee","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","required":false,"description":"The page that is requested. When unspecified, will load all objects unless endpoint forces pagination.","schema":{"type":"integer"}},{"name":"per","in":"query","required":false,"description":"Number of objects per page. For majority of endpoints will default to 25","schema":{"type":"integer"}}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-employees-employee-uuid-pay-stubs.RequestSchema.json b/docs/api/get-v-1-employees-employee-uuid-pay-stubs.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-employees-employee-uuid-pay-stubs.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-employees-employee-uuid-pay-stubs.StatusCodes.json b/docs/api/get-v-1-employees-employee-uuid-pay-stubs.StatusCodes.json
new file mode 100644
index 000000000..a596d33b2
--- /dev/null
+++ b/docs/api/get-v-1-employees-employee-uuid-pay-stubs.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"successful","content":{"application/json":{"schema":{"type":"array","x-examples":{"success_status":[{"uuid":"d2cec746-caee-464a-bcaf-00d93f7049c9","check_date":"2023-11-24","gross_pay":880,"net_pay":541.02,"payroll_uuid":"a039cafb-745e-4af4-bf1e-935a86fc18e0","check_amount":500.2,"payment_method":"Direct Deposit"}]},"items":{"description":"The representation of an employee pay stub information.","type":"object","properties":{"uuid":{"type":"string","description":"The UUID of the employee pay stub.","readOnly":true},"check_date":{"type":"string","description":"The check date of the pay stub.","readOnly":true},"gross_pay":{"type":"string","description":"The gross pay amount for the pay stub.","readOnly":true},"net_pay":{"type":"string","description":"The net pay amount for the pay stub.","readOnly":true},"payroll_uuid":{"type":"string","description":"A unique identifier of the payroll to which the pay stub belongs.","readOnly":true},"check_amount":{"type":"string","description":"The check amount for the pay stub.","readOnly":true},"payment_method":{"type":"string","description":"The payment method for the pay stub.","enum":["Direct Deposit","Check"],"readOnly":true}},"x-tags":["Payrolls"],"required":["uuid"]},"title":"Employee-Pay-Stubs-List"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided ID/UUID is valid.","type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["error_key","category"],"properties":{"error_key":{"type":"string","description":"Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error."},"category":{"type":"string","description":"Specifies the type of error. The category provides error groupings and can be used to build custom error handling in your integration."},"message":{"type":"string","description":"Provides details about the error - generally this message can be surfaced to an end user."}}}}},"x-examples":{"not_found":{"errors":[{"error_key":"request","category":"not_found","message":"The requested resource was not found."}]}},"title":"Not-Found-Error-Object"}}}}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-employees-employee-uuid-pay-stubs.api.mdx b/docs/api/get-v-1-employees-employee-uuid-pay-stubs.api.mdx
new file mode 100644
index 000000000..f0497dede
--- /dev/null
+++ b/docs/api/get-v-1-employees-employee-uuid-pay-stubs.api.mdx
@@ -0,0 +1,71 @@
+---
+id: get-v-1-employees-employee-uuid-pay-stubs
+title: "Get an employee's pay stubs"
+description: "Get an employee's pay stubs"
+sidebar_label: "Get an employee's pay stubs"
+hide_title: true
+hide_table_of_contents: true
+api: eJzdWG1v2zgS/itc7ofuAqJfUqdt/OmCTbcIcNsGm/b2gDTw0uLIYiORKl+cCIb/+2JISZYSOy93h/1wnxJLw5mHw2eGz2hDdQWGO6nVuaBzugLH1lMGZVXoGsB2/y28l4JVvF5Y55eWJlSATY2scCmd0w/gCFekNX9lScVrEmy/qq/KprqCOfmzczA3wMWfNKF3bOWt00wqB6uIhLm6Ajq/olAuQQgQ9Dqhjq8sPrvgtdFFYfFZxQ0vwYHBNxuqeAl0Tv/NPgSPpxfn7F9gLAJMqESUOXABhibUpjmUnM43NMai1hmpVjShoHyJcY4mR8ds8oZNjzGSgIz7wtF5//n2fhLOEEspFVjiciCCO2BLbkGQ04tzso5YCLdWp5I7EORWupzU2ptgkPKiGJHzjCitgEhLKqPXUoBIog2vqkKmIUWvLLkqpZKlL/u+r3/KnavsfDwWOrWjkNlRqstxm0k8QUxfeD/mlWTNSqlWPzYOWe/xzwjDWxAjuk26DHekkKLNbMVd/oAUn3MgX76cnxGdhYS062hCDXz30oCgc2c8HD6QbS9sxVfQxvvuwdQDPxkvLOxDgMuIy7nDvaA9WAdiRP7IQRGvbAWpzCRm+VYWBSk0F4QXBdHLb5A6S7wqwFoCSlRaKkcybVJAfq+kCocx2keowGcwww0E7r0E/0dfLsFg/lo0FZiwoxH5VRtS8m/aSFejRQvQxn00lCVOk6PjxxFeJ9RC6tFRKKRfdFlxVZ+mKVh76l1O51fXaNUWq7G3fNUenQFbaWXBou+jyQT/DHdhffCU+YImNNXKgXJo1SP0+JtF081DmNwYXodGAXe8rIoYp3G5sI47H8sfOxSdU3GUQvp29oalHIDN3sw4W6Y8Y5OJOHmdvZ3MTtIThJFDerPAEo1F/ZpNp+xoRhO6MtraRcVrOn/3bpJQBS7+Op5NR5MjbDuhhhZNQD55fZLybMnezo6BzXg2Y8tsCuzk9TF/9yZLp+9g0gXkpfa4+ePJZBRdlaDcogSXa3R2Jg2kjpxBpa10dHu9Tah0UNqHWUVuG6gMWFAuJBFZ0GvCXQsmUmXalB1Zm8xGStGEVgZvASdjauO2HnbG59V2F3QU2M3FJ1XUkSrbYdafEyHYh0baxnnUfe/onuM9mAeP8ViwtJ8O0vHhOSEUuBcHGPLrqSinxCv53QORApTDTmZ6uUJH2AJuc5nmg9BkCYVWK/vIObVkff5JvXCbA+4/J0qzhsQ1e+O0F/i9SkroL4gQL/N7SLbYW/bJi11vvopFgcXopCsQ5PuG7+yC1+wSJQ37p7SObrfocDaZPSzYj9qRX7VX4iVd8IAL8lUR8lXFHtBcacSA1d6kQIQGS5R2BO6kdSPyG78BYr2BmK1GVpDzs3EoYWnJmhdS7OsN/SSAMdpE5TXoGM3zhz2761xPel3cAC5IuYOVNvWBGMHqSaJcNje6Jbc5NHsOy4lOU2/siHyuK4lqqyYul5bcQL2rnqjduHNGLr2DcScyiYEiqDandy5RF+1QvwAaekDbcHMHTySUUeOqPSTbIF8Z7SupVpZwJUjKFVlCEGaIZullIUiKV3PZ2OdciUKqFZEqiseevg6YS7AW9dSTkC9aIAIcl4UlfKm96yWVkRUoMLt0Nq5blNabjKcRKd5OSiBwzFysleHFrrRbZKFIesS6Gpw/bRjf58u8t7C3OXqgQG55rI+wYITXbK+0P2rHQpGx9xiUfYqs7eDaCvgNcFsz1HVMr8EYKSCOTxe8vmwmJLhzoFBFxx1E7AfnnYSueeHvzT0oHofrovTqjGMv3RkdwtYtGGBETddJjxUELYBCfk7H6+m4mwLHm57i3477U6AFs27nL28KnLGaCYRXMg4gTEAZppAH1DqDUtNhRqM/FpUcvsbNHXC81+eF0eIRnxW+7gveS+y0kXp7ZG9XHBi8FdH4ewncBDU/jN64YAWsoSDcuxy7SmzuWHWXtXVQ/jcRoocDAVAsqkwHrw2ZwyyMMyJSoJmGB1NsQnFotZ+ySzBrmUIv07v5MdT8OBiOBYbG1szCb6azkGFceh/sH1CkugSs/IDjlSXvG26T5qYN46vQqS9bFftDcz3yNFyPzex01kYlv2MbDlWVUCi5LAJVmrf/2DEDs1Fp60quen4e+VBxH/5md0v/5983mtN1cOfGVcFloEEg9KaptSu6noatNNVGEzofTti7grtOaK6tw0WbDX5a+GKK7RYfx4ESy1BIy5fFoZGyv6m/bTrem4TYspqhvu1Ood6fv4P/4Xz8GMZQhzuI1/jDSMT4woz/9HsjfH4mj3wc2QullVaq7mNpIfYJE4bG5lPXy+D9X3/AevSI9380HLAyGmLvrlzv3QP5PrhUP7z/TBPKh62+a+3NP3hIe493s4kWn/UNqO22O22Hv4Nq2f4FdWeV5w==
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Get an employee's pay stubs
+
+scope: `pay_stubs:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-employees-employee-uuid-section-603-high-earner-statuses-effective-year.ParamsDetails.json b/docs/api/get-v-1-employees-employee-uuid-section-603-high-earner-statuses-effective-year.ParamsDetails.json
new file mode 100644
index 000000000..ecbef50db
--- /dev/null
+++ b/docs/api/get-v-1-employees-employee-uuid-section-603-high-earner-statuses-effective-year.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"employee_uuid","in":"path","description":"The UUID of the employee","required":true,"schema":{"type":"string"}},{"name":"effective_year","in":"path","description":"The effective year for the Section 603 status","required":true,"schema":{"type":"integer"}},{"name":"X-Gusto-API-Version","in":"header","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"},"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."}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-employees-employee-uuid-section-603-high-earner-statuses-effective-year.RequestSchema.json b/docs/api/get-v-1-employees-employee-uuid-section-603-high-earner-statuses-effective-year.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-employees-employee-uuid-section-603-high-earner-statuses-effective-year.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-employees-employee-uuid-section-603-high-earner-statuses-effective-year.StatusCodes.json b/docs/api/get-v-1-employees-employee-uuid-section-603-high-earner-statuses-effective-year.StatusCodes.json
new file mode 100644
index 000000000..db398fa05
--- /dev/null
+++ b/docs/api/get-v-1-employees-employee-uuid-section-603-high-earner-statuses-effective-year.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"successful","content":{"application/json":{"schema":{"type":"object","description":"The representation of an employee's Section 603 high earner status for a specific year. Section 603 of the SECURE 2.0 Act requires employees aged 50 or older whose prior-year FICA wages exceed the IRS threshold to have their catch-up contributions to pre-tax retirement benefits designated as post-tax contributions.","x-examples":{"success_status":{"id":"f47ac10b-58cc-4372-a567-0e02b2c3d479","effective_year":2026,"is_high_earner":false}},"properties":{"id":{"type":"string","description":"The unique identifier of the Section 603 high earner status record","readOnly":true},"effective_year":{"type":"integer","description":"The year for which this high earner status applies","readOnly":true},"is_high_earner":{"type":["boolean","null"],"description":"Whether the employee is classified as a high earner for Section 603 purposes. Can be null if the status has not yet been determined.","readOnly":true}},"required":["id","effective_year","is_high_earner"],"title":"Employee-Section603-High-Earner-Status"}}}},"404":{"description":"Not Found - employee does not exist","content":{"application/json":{"schema":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided ID/UUID is valid.","type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["error_key","category"],"properties":{"error_key":{"type":"string","description":"Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error."},"category":{"type":"string","description":"Specifies the type of error. The category provides error groupings and can be used to build custom error handling in your integration."},"message":{"type":"string","description":"Provides details about the error - generally this message can be surfaced to an end user."}}}}},"x-examples":{"not_found":{"errors":[{"error_key":"request","category":"not_found","message":"The requested resource was not found."}]}},"title":"Not-Found-Error-Object"}}}},"422":{"description":"unprocessable entity - invalid effective_year","content":{"application/json":{"schema":{"description":"Unprocessable Entity\n \nThis 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.\n","type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["error_key","category"],"properties":{"error_key":{"type":"string","description":"Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error."},"category":{"type":"string","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."},"message":{"type":"string","description":"Provides details about the error - generally this message can be surfaced to an end user."},"metadata":{"type":"object","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.","oneOf":[{"type":"object","description":"multiple entities","required":["entities"],"properties":{"entities":{"type":"array","items":{"type":"object","description":"single entity","additionalProperties":true,"properties":{"entity_type":{"type":"string","description":"Name of the entity that the error corresponds to."},"entity_uuid":{"type":"string","description":"Unique identifier for the entity."},"valid_from":{"type":["string","null"]},"valid_up_to":{"type":["string","null"]},"key":{"type":["string","null"]},"state":{"type":["string","null"]}},"title":"Metadata-With-One-Entity"}}},"title":"Metadata-With-Multiple-Entities"},{"type":"object","description":"single entity","additionalProperties":true,"properties":{"entity_type":{"type":"string","description":"Name of the entity that the error corresponds to."},"entity_uuid":{"type":"string","description":"Unique identifier for the entity."},"valid_from":{"type":["string","null"]},"valid_up_to":{"type":["string","null"]},"key":{"type":["string","null"]},"state":{"type":["string","null"]}},"title":"Metadata-With-One-Entity"}]},"errors":{"type":"array","description":"Will only exist if category is `nested_errors`. It is possible to have multiple levels of nested errors.","items":"circular(Entity-Error-Object)"}},"title":"Entity-Error-Object"}}},"x-examples":{"bank_account_delete_unfunded_payments":{"errors":[{"error_key":"base","category":"invalid_operation","message":"FundingMethod has unfunded payments"}]},"bank_account_verify_incorrect_deposits":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Your bank account cannot be verified. Please check the test deposit amounts."}]},"bank_account_verify_already_verified":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Your bank account has already been verified."}]},"bank_account_missing_routing":{"errors":[{"error_key":"routing_number","category":"invalid_attribute_value","message":"Routing number is required."}]},"payment_configs_missing_parameter":{"errors":[{"error_key":"base","category":"missing_parameter","message":"At least one parameter must be provided"}]},"payment_configs_invalid_fast_payment_limit":{"errors":[{"error_key":"fast_payment_limit","category":"invalid_attribute_value","message":"Fast payment limit should be a number"}]},"pay_periods_invalid_end_date":{"errors":[{"error_key":"end_date","category":"invalid_parameter","message":"End date cannot be more than 3 months in future"}]},"company_industry_selection_naics_code_required":{"errors":[{"error_key":"naics_code","category":"invalid_attribute_value","message":"Naics code is required."}]},"company_industry_selection_naics_code_invalid":{"errors":[{"error_key":"naics_code","category":"invalid_attribute_value","message":"Naics code must be equal to 6 digits."}]},"company_industry_selection_sics_codes_invalid":{"errors":[{"error_key":"sic_codes","category":"invalid_attribute_value","message":"Sic codes must be equal to 4 digits"}]},"time_off_policy_name_required":{"errors":[{"error_key":"name","category":"invalid_attribute_value","message":"Name is required."}]},"time_off_policy_unlimited_invalid_accrual_rate":{"errors":[{"error_key":"accrual_rate","category":"invalid_operation","message":"Accrual rate must be blank for unlimited policies."}]},"time_off_policy_pending_requests":{"errors":[{"error_key":"time_off_policy","category":"invalid_operation","message":"Cannot deactivate policy with pending time off requests."}]},"time_off_policy_employees_required":{"errors":[{"error_key":"employees","category":"invalid_attribute_value","message":"Employees are required."}]},"time_off_policy_unlimited_balance_update":{"errors":[{"error_key":"base","category":"invalid_attribute_value","message":"Can not adjust balances for unlimited policies."}]},"holiday_pay_policy_already_exists":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Company already has a holiday pay policy."}]},"holiday_pay_policy_not_exists":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Company does not have a holiday pay policy, please create one"}]},"holiday_pay_policy_invalid_employees":{"errors":[{"error_key":"employees","category":"invalid_attribute_value","message":"Invalid employee uuids provided."}]},"onboarded_employee":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Cannot delete onboarded employee"}]},"invalid_attribute":{"errors":[{"error_key":"base","category":"invalid_operation","message":"There is an error in the request body."}]},"company_cannot_enable_contractor_only":{"errors":[{"error_key":"contractor_only","category":"invalid_attribute_value","message":"Contractor only cannot be enabled for existing companies."}]},"company_missing_parameter":{"errors":[{"error_key":"base","category":"missing_parameter","message":"contractor_only is required."}]},"starting_after_uuid_invalid":{"errors":[{"error_key":"starting_after_uuid","category":"invalid_attribute_value","message":"Parameter 'starting_after_uuid' does not correspond to a valid event."}]},"resource_uuid_invalid":{"errors":[{"error_key":"resource_uuid","category":"invalid_attribute_value","message":"Parameter 'resource_uuid' does not correspond to a valid resource."}]},"payroll_gross_up_invalid_net_pay":{"errors":[{"error_key":"net_pay","category":"invalid_attribute_value","message":"Net pay must be a number."}]},"payroll_accruing_hours_invalid":{"errors":[{"error_key":"base","category":"invalid_attribute_value","message":"Hours cannot be negative."}]},"payroll_cannot_cancel":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Payroll cannot be canceled."}]},"frozen_payroll":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This payroll has already been processed. Its data cannot be updated or altered."}]},"frozen_payroll_processing":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This payroll is being processed and cannot be updated at this time."}]},"unmodifiable_payroll_type":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This type of payroll cannot be modified or processed. It is reserved for system processes."}]},"invalid_employee_uuids_format":{"errors":[{"error_key":"employee_uuids","category":"invalid_attribute_value","message":"Parameter employee_uuids must be an array."}]},"maximum_employee_uuids_surpassed":{"errors":[{"error_key":"employee_uuids","category":"invalid_attribute_value","message":"Exceeded maximum of 100 for lookup."}]},"invalid_employee_uuid":{"errors":[{"error_key":"employee_uuids","category":"invalid_attribute_value","message":"Invalid Employee UUID(s).","metadata":{"entities":[{"entity_type":"Employee","entity_uuid":"invalid-uuid-123"}]}}]},"payroll_blocker_missing_bank_info":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must have a bank account in order to run payroll.","metadata":{"key":"missing_bank_info"}}]},"payroll_blocker_missing_employee_setup":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must add employees in order to run payroll.","metadata":{"key":"missing_employee_setup"}}]},"payroll_blocker_missing_federal_tax_setup":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must complete federal tax setup in order to run payroll.","metadata":{"key":"missing_federal_tax_setup"}}]},"payroll_blocker_missing_bank_verification":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company bank account must be verified in order to run payroll.","metadata":{"key":"missing_bank_verification"}}]},"payroll_blocker_suspended":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company is suspended and cannot run payroll.","metadata":{"key":"suspended"}}]},"submission_blocker_missing_selection":{"errors":[{"error_key":"submission_blockers","category":"invalid_attribute_value","message":"Submission blockers selections required"}]},"submission_blocker_invalid_option":{"errors":[{"error_key":"submission_blockers","category":"nested_errors","metadata":{"blocker_type":"fast_ach_threshold_exceeded"},"errors":[{"error_key":"selected_option","category":"invalid_attribute_value","message":"Selection is not available to resolve Fast ACH Threshold Exceeded. Please choose one of Wire In, Move To Four Day"}]}]},"invalid_version":{"errors":[{"error_key":"base","category":"invalid_resource_version","message":"You are attempting to update a resource using an out-of-date version."}]},"signatory_email_required":{"errors":[{"error_key":"email","category":"invalid_attribute_value","message":"Email is required"}]},"signatory_company_already_has_signatory":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Cannot have more than one signatory in a company. Please remove the existing signatory before adding a new one."}]},"mixed_disbursement_errors":{"errors":[{"error_key":"disbursements","category":"nested_errors","metadata":{"contractor_payment_uuid":"invalid-uuid-1"},"errors":[{"error_key":"contractor_payment_uuid","category":"not_found","message":"Disbursement not found."}]},{"error_key":"disbursements","category":"nested_errors","metadata":{"contractor_payment_uuid":"d0dfa222-ad08-4ea7-a06a-717688c3b179"},"errors":[{"error_key":"payment_method","category":"invalid_attribute_value","message":"Payment method must be one of: Direct Deposit, Check."},{"error_key":"payment_status","category":"invalid_attribute_value","message":"Payment status is not valid for payment method 'InvalidMethod'."}]}]},"not_found":{"errors":[{"error_key":"request","category":"not_found","message":"The requested resource was not found."}]},"finish_onboarding_incomplete":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Company is not ready to exit onboarding."}]},"company_location_validation":{"errors":[{"error_key":"street_1","category":"invalid_attribute_value","message":"Must include a street address"},{"error_key":"city","category":"invalid_attribute_value","message":"Must include a city"},{"error_key":"state","category":"invalid_attribute_value","message":"State is in the wrong format"},{"error_key":"zip","category":"invalid_attribute_value","message":"Please enter a valid zip code (e.g. 12345)."},{"error_key":"phone_number","category":"invalid_attribute_value","message":"Phone number must be 10 digits"}]},"conflict":{"errors":[{"error_key":"request","category":"duplicate_operation","message":"A resource with these attributes already exists."}]},"invalid_parameter":{"errors":[{"error_key":"request","category":"invalid_parameter","message":"The provided parameter is invalid or missing."}]},"flow_invalid_entity":{"errors":[{"error_key":"entity_type","category":"invalid_attribute_value","message":"Invalid flow entity"},{"error_key":"entity_uuid","category":"invalid_attribute_value","message":"Invalid flow entity"}]},"flow_nested_options_errors":{"errors":[{"error_key":"options","category":"nested_errors","metadata":{"flow_type":"company_forms"},"errors":[{"error_key":"form_types","category":"invalid_attribute_value","message":"Supplied value 'invalid' contains no permitted values"}]}]},"basic":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must complete all onboarding requirements in order to run payroll.","metadata":{"key":"needs_onboarding"}}]},"contractor_payment_invalid_wage":{"errors":[{"error_key":"wage","category":"invalid_attribute_value","message":"Wage must be greater than or equal to 0."}]},"contractor_payment_cannot_cancel":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Payment has already been processed and cannot be cancelled. Contact support directly."}]},"time_off_request_cannot_delete":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This time off request cannot be deleted."}]},"resource":{"errors":[{"error_key":"first_name","category":"invalid_attribute_value","message":"First name is required"},{"error_key":"date_of_birth","category":"invalid_attribute_value","message":"Date of birth is not a valid date"}]},"nested":{"errors":[{"error_key":"contractor_payments","category":"nested_errors","metadata":{"contractor_uuid":"72ae4617-daa9-4ed7-85e0-18ed5d0ee835"},"errors":[{"error_key":"hours","category":"invalid_attribute_value","message":"Ella Fitzgerald is paid fixed wage and hours cannot be set on a contractor payment"}]},{"error_key":"contractor_payments","category":"nested_errors","metadata":{"contractor_uuid":"2d7bf62c-babf-4a12-8292-340e2d9cab28"},"errors":[{"error_key":"wage","category":"invalid_attribute_value","message":"Isaiah Berlin is paid hourly and wage cannot be set on a contractor payment"}]}]},"compensation_invalid_rate":{"errors":[{"error_key":"rate","category":"invalid_attribute_value","message":"Rate is not a valid number"}]},"compensation_invalid_payment_unit":{"errors":[{"error_key":"payment_unit","category":"invalid_attribute_value","message":"Payment unit must be one of Hour, Week, Month, or Year"}]},"compensation_already_processed":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Compensation has already been processed on payroll."}]}},"title":"Unprocessable-Entity-Error-Object"}}}}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-employees-employee-uuid-section-603-high-earner-statuses-effective-year.api.mdx b/docs/api/get-v-1-employees-employee-uuid-section-603-high-earner-statuses-effective-year.api.mdx
new file mode 100644
index 000000000..1db8c35be
--- /dev/null
+++ b/docs/api/get-v-1-employees-employee-uuid-section-603-high-earner-statuses-effective-year.api.mdx
@@ -0,0 +1,74 @@
+---
+id: get-v-1-employees-employee-uuid-section-603-high-earner-statuses-effective-year
+title: "Get a Section 603 high earner status for a specific year"
+description: "Get a Section 603 high earner status for an employee for a specific year."
+sidebar_label: "Get a Section 603 high earner status for a specific year"
+hide_title: true
+hide_table_of_contents: true
+api: eJztXFtz27iS/itY7kMmVaIsy46d+GlzYmfGD5mk4mSzp5wUDRFNEWMS4ACgbY3L/32rcaFI6mJJsWvP7s7DVMYi0PjQ6BsaDdxHsgJFDZfinEUn0RRMfLMfQ1kVcgagm/9L6pqzWEOKTY9GB0nOp3kCVAlQiTbU1BpbZxm2uIFkBlRFg4iBThWvsFN0Ev0KhlBy4YiQo9EBQSrEUSGOCsmkIlSQMLD7m+gKUp7xlCDh4XfxXbTJyIyYHMjF2buvn8/IeDgib1NDaFUVHDQxsqGmCZ0CI69GRCoiCwaK3OZSA6kUlypG4uT9+bu35JZOQRO4SwGYpX3++YKYXIHOZcGG38WXHDS06SogaUG15hkHRqhuz00PCBWWDlckpSbN47oiqRRG8UmN07AoKwWxoXdEgeEKShCGTEBAxo0mZa3xL8JA86mgxo1RSW1slw4tyx+dygpOyFWzgoHUiQLKrqJBZOhURyeX0Vlg9T98i+jHILqLp7U2MubCwNRJSGxmFWAHKCfAGLBoENGqajexXSuqaAkGFFK/jwQtITqJOpIUDSKOElFRky+IyZccyNev56dhWUPPaBAp+LPmClh0YlQNg0inOZQ0OrmPHLZIG8XFNHp4GMwH7gvl+pGb5lbUrPhZ2WqJm5PUTeBY1oDq4Pmv+FfL2befzuP/BKVxaA8qB8oAIa6a1yACUZe4BuPR+FU8Oor3XyHLGWS0Lkx00v79oT+9U1yUkgvUiRwIowbiCdXAyNtP5+TGYSFUa5lyK2G33ORkJmtlG6S0KIbkPCNCCiBck0rJG86ADVwbq2+plYMXmlyWXPCyLtu0f/ySG1Ppk709JlM9tBI2TGW5FyQqruhMyaKw3/doxWPfk4vpv3uCcevnlwij1sCG0cOPQaQhrRU3Myt372RZUTF7m6ag9dva5NHJ5Y+HlmgrfUunYekU6EoKDRqZPh6N8J8u93RtKWV1EQ0i1DcQBlu1pr33h8am94vrJyd/QGqWCpyCSoEGYSwJFPqW+XuhN7KXPftIHjeOXnT1U5tGtGM5vYGfMnYbGbkIVxLuaFkVbtX8Anl3hL9w9GnZ4TFN90eT+NXrNI0PD47HMX11dByPYDSejNMDdnj8BhWrayZOxqPx0SDiuu3popOMFhoeHgZRpdBzGg7NQIu6urjWteB/1kA4A2HQUahmddYvsoJUKmYtDmUfRTFzYvuwCHvB9CyD0Vi225ynOTE518tG9Q502bB9voRhL6OJlAVQNGmiLgpnnNrjf8vB5KA6lh21uOs8aQcPQm1zqKpVJTXoIXlHBXpFHIpwx0oPPqeaCGnIDFCwQBAWrB8bLs7ooW3MLyProRYdR3fSPwaR4aZAZgcXGl80EVL8G5/m8ZltGl84kXx4wIEOR4eL1uV3ach7WQtG4jlbmAQ3Cbjj2mxjdlYR/y4IscGLNQCgUcUUaFmrtD/ckHyg10B0rawyN9aenJ/uWffMNbmhBbfs7Ju5NjNBKalcZNBRGv/7XGSpUnSGfDZQ6mXGc4Fqcg3YIaUGplLNVoxhWz2qnxfOhIImtzn4OdvuRKZprfSQfJlVHJ3gzGnMNczmmuxcKjXOQMFeEwQRBYW1ZEbOSQ7ROTeot4CGFLAt2g1HieBiBlJhkbRHPlWyrriYaht/pk5Z0F8imknNC0ZS9IWlb59TwQoupoQL59NbsZ3FXILWdAqPQ/4UgDAwlBea0ImsTYupMZmCADVnpycdUOpaZTR1SNEhCobAkXNOi7q2X0iTZCjhbcG67Kx/5CW+LS8nrY6tyUUrFOTW2xTbAUMOBBJswO/SxFbJ4jMcNP7opNbr/Hi8qJa1qJREl0UnBRAUJDMjMeHCqhVZsD87av/XzjBndphgB5DvdEZyWlUgUPCFXaKJZDMUMSsDnhHW/VIuvGxpous0R1t95QEnjfQnN7So4WpAfPAcKGRWElgNflGbns0u9ApjF6d7l2dumHdusTjoLcNHCzNOm+4vybTmzO0oS6kgiObwu/jbgv2/sGC4eWkG4ppcCavgiVvHq4EF59aK3PKiCCJPKHEtyZVvSvwizdweyeuu+/gvYygRhaGMmg12Iu+Cciso4IYKg9tDijS9gMy8JntTyAWxOo0hmTUb3iJNChiS91IRb50HHRIWn2XVlfs3QVRXdm3DL5gfuHLsn8yjDgwypICPmTXr6+dS1oXhVTCpIYJtKV74eVHZwpctVLq3S+Ri2hhzTJAwxvETLT61RnJ7ziVjO4Y8LjW/0xKa/IjjqMlpW2xSqdyeluF2y0pDi8GPj/B1YasSUiGOjKXorHemZNneAjQU3Q6gaVdXiZHrG3bs3LIGGN3DuiYtj/zBS3/8jZs8/iggds4veljd6oOXHdcUlwZTN3+v+f/+NUdKKx12b4+KxkeKYuZ2QrizXOM2huTc2HSY1JpjiBVSII0dKuAGCo1r591IcBSNWYlSrtK6oOoXB7cTQ76M2jNc0iBaEhFPqLhOaJrKWpiEQQEGklpktWDAkorOMOOi10TLmBjshsoLwVonZH5fC8bF9AOYXDK7+w6jkWY0uwYdYDegeDZLuLCimyLSSmr+pMj+iWEAjkr8qOg5MYyfALHjc2BD8qkAqoGkOaTXLkjBiNXDIbTEjnq4egq0wJTCLAkUn3UCyF4/oEtuNPNYArDkGi1UomRtUG3W7JBci0TU5cSmjpZA7AX5HaCfXX/i+qNOBLfrcXlJSFIpMj7VDbQm1tyKa4u922DeGoJLaghmq+fBbDhICYHFcmBhthnVJmhLUvCSmzUIlzTemoXvEbGnQSwNonNZFwwxU8/ZBnNSgeKSzfGCYAnz1nIFyqbJUmzLeXkmmD0uaGmO3UGZnApyQEopTK4xJsxqUytw+FKXgE+4YLU2apZoKFx6LBGUpzpJJYNkHpitRDxvvT0/f8e+BPsuEcfNEPphnh9gEE34s6YFepEjwviUN2ZnDVwdAOgN4Gqeurbbo73gqcWqF8EeerAOq+ElJDLLkkoWPJ0lePi12VqXOzGxXLa+fRC1sBoFrNEXmqaqpkWi1utMp9kWlvut60ewX8OxSYGmHCOrBg+xADnoFcArsM418YmUdd6x13UbtO+ccjOgmHZCyI6G2+N6DAQHIDLLQlZnFebmYGmTZW8ab7/2Z50z+I0lYEILKlJI6uoRe7naW69DhQcTyEzK/rDL7kbT65c9lwVnaNXxPwc4hBU2EH3KqMgfjzZhRO5OXRwC9EB+8VdDw9Tps8FqziJsJL0M2IBUPmRTgLIqBayE2rjHRsyeRRTPQ+Y2HODgtku3chgWnxQTSRWG4U1lwxPyL+gwBvykGWpeRGEhLEzmCRF8sblHrm2yx25LuehkgTG53PNoLqxIQGD+KLHnvDQ1UiXSHtGtxNZvub2aNgTcfm8e3zgszCqslXK0fQ7vXGED/ueMY3tzXOLmtKHKxu00M6DsXn+TKGCx1/b8+9TE1S+W0HsxV+N5asLmKYlXlBsQxs8ipBY3xd9p/1PIO5QexRxaz7c0eOSQTJXUGtMdYXABdjOwLtbxLbYPd8DuEZqIIuwLepBs1IIrkstabRIY7ubqfkPqLc0RMKV4bNVD43U8RT9YPKG9+eTotwC4IRr1yJT8C0TicTyppcOsjx9+YUvuD90wt3CONS2YTp9jdGEHwxMyWhhQK9Amnsr6fftPAeeaTACNWwM4HLX0oNpUI9c2APRga1FKxjNuzXaAHLKZTwk2nBhVC4vtADhOdljuDKUGdeOtuJ5pA2XTKNjwfmxgrYBOMqlKum63323/MwaoS2mu1YLY9KTHWdI7LH/r49S1qijO+RmhntliL2DEY8CV2B+NLFcLKa/rah0vnxFYCLiaElYsTPlFvxxG3bOv+bnOZS/p3mwfol6uPIwf28rn/fGBPe5vG7RJIdNrUI3zt0k3LjK5lfD3qC0Nhq1E+EC4kwfkgkiFpXpGElWLoB796buxF3Gun0+zOBpMXT3PpChjrQrEnabTg7l+ThkwPEpNDL17zmlhXGgDcD8ewfJFO95uc1yEvYEoupywKxJ58ml2xDBYrJCF/gm57IBePklda8xFbJli32RSHItaPPG2E3x0CnNIDrKuJ3ZWUiwsTZOzWxeaL3TfJVXXECGBCGkGn+8holWA5175Z9F2jst6/AujeWtsU+g0zZOmoDgB73yi1vldH4GdFjRYt+dV4AuKgE3b3FBeUH+YhxF/cQPE5ubfvvuNfGmqnYNnbJ0fSSyaxjMHmZFvXAE5FwPyQd4A+SKxClORU2qPI9sO09ez7xQ2NduXm+Y2QefsyObFqDFQVnYTa6QP6Qid13PUKJwYcsjaxDKL7XdPMGwzbU22VJjao7zYLK1HebFLSo/yor3R7QMI++6QHcupTpqvT59Ncae5zYEHLm4zGrHlQR5QIwYKSnnjK7BC8mDeZQIZEsM6AWQ6EXCLREOgx++AJYzrSa20rYwPqrN6Yu3WW2hfK7cQzq2WRj9rdG8ViQ2qLE9boHt1lYNnnh4bsYyOx+OYstHr+BDocUxHRzQ+3j8+ev06PZjsH79ZM+lArbSn3bvE/u6Az/Vv/KezGifklONZODl1h88D8g4PpYdRnysBRXMfaUcUvmLemz4XUWNoX3VRvvDRtjvifzEMNux/qvZ2EGVccJ0nPsuJ3hULCVzo9Qw5ac8gt8fHW4V33JD54L2cYCFdFJNY0o9FYdooAJPsb7+KH1B4uEiLmqFFd4TQtijQekFmUlei9HNjWCJ9yq5KZ3vXi92QtT5LfKukmBK/++6P8RevdhBzZ5JB4F47ZPH+4pU7dP0FhtMh2R8fHL56uUTFcilg53qIT9g7VEMEJd8fdQ5KseKg4Om6TMNS5WG1qwCHVUePLdXB4ztjL6w2aOfJKneE09vAb5LIXgprfR3Bl/Y9knlNhl19ty5Ym+0i5aDjhbxtlTfYWq51xQ3zvf3O2QQcMlTz9QWinSN4mgGaSXpP5mJY/bjP9w03d4d2FB9oByuFiqbXeDr8bvvstAOxF8gYsZ/IC9/nxfwmgZCkwktZxoRWOniVCdU8febdObVlfsF+h2jTBhnbbWEFANMtP+S3gUvij8C3W18cvmJ29vPWDP+GZeHBzkztsajyIauaF2qMGke1gO4Zc/Q2klidJO/lnB0CzOETW5meGqLrqpLKEGaDo2LWP+H35ijMwZ2APnkeulf80ILsBmS906x15WJcaZPsVvDyHvsS0St7WbBWzPqHLJlwZa+7bznKqT1Xz4jt3myNvQe1ZRMuALQ2Z7Nj2qYWdJcg3gfvx2MKh0f7xzGj9E18COw4fv0KRvH+a2Cv2Ajg9cGrNSbNnobtsCktCkrec/PXFFNxzFb8UjTmuF2zt6KtDOe90zANGCPaLWJz1OyZsGSj88ScGrPjSXY0TuMJnWTxId0fx6/Hb8bxweEIxuxNSifj12s4tZsVOteU05z8A1TBRcMm5Esxsyy69bdXNuNQiKlBaBdPN3mP9XU7q2u11paw+mi0LentosulSJrNpVhbH9pptvNuDXv3dowEj2AH5BvANaaahMnt1bt/4rXBRdQhadLY3ifeKoWB1ll72XKo3WuUnduK8Ypid+wAdwaEthEQonZ4Vz5bYu8j1I8/X4IK2SXlnolo+tvr4j+s4uHW376ZEw3ceyIn0d7N/l5znrF33znfeth75P2cvfvulc8HfAkEzy/9wtSqQPPl70DSirsrkDGD0t6DXLjHcAqltM8k6AroNVA9ix292CVB8DNOeAXhpTQ/KZvwWEWzws/ttzgu8FaqK7ha8iJHcxEDBw8Pn+DfE6BqyesFnkRsb1QQWpscw+hwXDCILuwZ78+M4CisGMDukNwBX5BX+5gLPnKCIhKyuO1nWAYRvjugP2YXoG54Ci1Oz2+w2kt/e7bhHsOhUb1i+zdmY7XvunBRBYpUljZJbXG80OTMSzcJdRH4/gqTaV2GJ0b+zV8lpm7T6Z+lOQ2jks943dPvLFwCF0XFf/2PuWTYZzCkNiUVLTqbP/LUfbSkP7f7+XXnvx+O+hd7OMoplIE7s1cVlFvNszbk3tvBy+hm30rPvJTypP8A1CPG0Hbp3oD/gbWd2iD5+3v0TF9V8fCAP/9ZAzqnyx9oppUtR7EWk3HrRph/uGWNiP3y2cfQL8ma96eWzjxcJROzuZeIIn+vrffuFVrbnUFt8zTVLki73Ha1tO5Fqu14+X/6nakVrHUsXP62V8PpeXCBHqoyrW8LDzp0Yoxfz75gtNJ1aI0D8//TuhjdXeH7e9fii7wG8fDQLLjBv2349fDf3EXUzg==
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Get a Section 603 high earner status for an employee for a specific year.
+
+Section 603 of the SECURE 2.0 Act applies to employees aged 50 or older whose prior-year FICA wages exceed the IRS threshold.
+These employees are classified as high earners, and their catch-up contributions to pre-tax retirement benefits must be designated as post-tax contributions.
+
+scope: `employee_benefits:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-employees-employee-uuid-section-603-high-earner-statuses.ParamsDetails.json b/docs/api/get-v-1-employees-employee-uuid-section-603-high-earner-statuses.ParamsDetails.json
new file mode 100644
index 000000000..2e582e14d
--- /dev/null
+++ b/docs/api/get-v-1-employees-employee-uuid-section-603-high-earner-statuses.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"employee_uuid","in":"path","description":"The UUID of the employee","required":true,"schema":{"type":"string"}},{"name":"X-Gusto-API-Version","in":"header","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"},"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."}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-employees-employee-uuid-section-603-high-earner-statuses.RequestSchema.json b/docs/api/get-v-1-employees-employee-uuid-section-603-high-earner-statuses.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-employees-employee-uuid-section-603-high-earner-statuses.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-employees-employee-uuid-section-603-high-earner-statuses.StatusCodes.json b/docs/api/get-v-1-employees-employee-uuid-section-603-high-earner-statuses.StatusCodes.json
new file mode 100644
index 000000000..71ab05a13
--- /dev/null
+++ b/docs/api/get-v-1-employees-employee-uuid-section-603-high-earner-statuses.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"successful - with records","content":{"application/json":{"schema":{"type":"array","x-examples":{"success_status":[{"id":"f47ac10b-58cc-4372-a567-0e02b2c3d479","effective_year":2026,"is_high_earner":false},{"id":"550e8400-e29b-41d4-a716-446655440000","effective_year":2027,"is_high_earner":true}]},"items":{"type":"object","description":"The representation of an employee's Section 603 high earner status for a specific year. Section 603 of the SECURE 2.0 Act requires employees aged 50 or older whose prior-year FICA wages exceed the IRS threshold to have their catch-up contributions to pre-tax retirement benefits designated as post-tax contributions.","x-examples":{"success_status":{"id":"f47ac10b-58cc-4372-a567-0e02b2c3d479","effective_year":2026,"is_high_earner":false}},"properties":{"id":{"type":"string","description":"The unique identifier of the Section 603 high earner status record","readOnly":true},"effective_year":{"type":"integer","description":"The year for which this high earner status applies","readOnly":true},"is_high_earner":{"type":["boolean","null"],"description":"Whether the employee is classified as a high earner for Section 603 purposes. Can be null if the status has not yet been determined.","readOnly":true}},"required":["id","effective_year","is_high_earner"],"title":"Employee-Section603-High-Earner-Status"},"title":"Employee-Section603-High-Earner-Status-List"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided ID/UUID is valid.","type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["error_key","category"],"properties":{"error_key":{"type":"string","description":"Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error."},"category":{"type":"string","description":"Specifies the type of error. The category provides error groupings and can be used to build custom error handling in your integration."},"message":{"type":"string","description":"Provides details about the error - generally this message can be surfaced to an end user."}}}}},"x-examples":{"not_found":{"errors":[{"error_key":"request","category":"not_found","message":"The requested resource was not found."}]}},"title":"Not-Found-Error-Object"}}}}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-employees-employee-uuid-section-603-high-earner-statuses.api.mdx b/docs/api/get-v-1-employees-employee-uuid-section-603-high-earner-statuses.api.mdx
new file mode 100644
index 000000000..858f800d1
--- /dev/null
+++ b/docs/api/get-v-1-employees-employee-uuid-section-603-high-earner-statuses.api.mdx
@@ -0,0 +1,74 @@
+---
+id: get-v-1-employees-employee-uuid-section-603-high-earner-statuses
+title: "Get all Section 603 high earner statuses for an employee"
+description: "Get all Section 603 high earner statuses for an employee across all years."
+sidebar_label: "Get all Section 603 high earner statuses for an employee"
+hide_title: true
+hide_table_of_contents: true
+api: eJztWG1v47gR/itT9sPeAaKteO3kzp+abnLbAO1tsMm2BbJBjhbHFi8SqeVQTgzD/70YSnLk2Nl0ey1QFP2U2OY88/7MkGvhKvQqGGcvtJiKBQa5PJJYVoVbIdL2v7u6NloSZnz0OH17l5tFfofKW/R3FFSoCUkkQiNl3lR8SkzFewygigKuGjk4Tt8CC0IjCJ0gzJ0HZaHTBirzjijKrlB5Gny2n20fxc0h5AhX5+8+fTyH0SCF0yyAqqrCIEFwWygCtUANkxScB1do9PCQO0KovHFeMjr8dPHuFB7UAgnwMUPUEfvi4xWE3CPlrtCDz/Y6R8I+rkfICkVk5gY1KOq7RgkoG3GMh0yFLJd1BZmzwZtZzW5EKyuPMqhH8BiMxxJtgBlanJtAUNbEn0AjmYVVodFROQpRZAcrxocyV+EUftnmrIOaelT6F5GIoBYkpjfivIvzH9sT4jYRj3JRU3DS2ICLpiZkWFXIAljOUGvUIhGqqvpHomilvCoxoGf0tbCqRDEVO7UjEmG4JCoV8r06uc4RPn26OOvS2kmKRHj8UhuPWkyDrzERlOVYKjFdi8Y2QcEbuxCbTbJV/Hf5Pnpyenkh/4qeWEmrPkel0YuXcRKBti7Z51E6msj0WB5N2EWNc1UXQUz732+eO3LGQSiN5RrMEbQKKGeKUMPp5QUsG1tAEbnMxIw+mJDDytU+HshUUQzgYg7WWQRDUHm3NBp10pyJ9Z3FuL8huCmNNWVd9rFvv8tDqGg6HGqX0SBmdJC5cthlUFZq5V1RxN+HqjKylTR28fsWUPa+/p7NqAn1QGxuE0GY1d6EVczzO1dWyq5OswyJTuuQi+nN7aZXSp4e1KLLnEeqnGWamK7FKE35z270qI5I87oA2UTGY+a8ZmLhckcbWKgXheGvxJLr/XQq79VKsCn4qMqqaNS2GlrGik4Y5r35+ERlR+lMTn7IMjl+ezKSanJ8IlNMR7NR9laPT37k0pjPmYOWeMe8IaajdHScCEN9NhTTuSoIuRwj9GSS4g/jNJU4+nEmx0d6LNXJ0bEcj4+PJ5PxOE3T9DD0yT40R3Jzu0mECVhSz103+xWzcLCxPFYeCW2IEeMW6zHtG3qFnBtqBqowM3OTRToewOtU3PYt/buJmFkzV0v8TdT6T1Hqq8Xzn6udTSIqz5M5GNwq2meq/VzX1nypEYxGG3gs+W12vp7kps8i3Sr9wRarttT2zd5aEWdApNJ9M2IyuXAecpPlEHJDh7S24/qQ2udx6dTeiJlzBSomdFsXRUPNff1/yzHk6HfmCHPY7qhWO/awqf0IVbWvHCEN4J2yPINZFZgmlK3xuSKwLsAKubDQgu64Xw/2Pdr0J9mNiPPwWWj3nL5NRDCh4GB3A1tebTcw+SezyOV5PCqvmpLcfKuE/LOhIDYbtm+cjvcp+WcX4CdXW/0tFPwCBHy2AHGPiuyAxP3nkVztMwTtsAkoPhoKA/iLukeg2sdO3w5CuDgbxk3BECxVYWKsn3NgP9LovfPNkrLTUe33+wPjRWbdQ727RxbIVMCF86sXdMRTrzbvVcOvSPCQY+tzFAeXZbWnAVyvKsP7wappp3tcPbV5s22o0LAXDrf7GHgsIs0F9wQ54DrZWv0NpjECn2VSaZCAk9lBdUmi1vKFd3Vl7ILiKpw1ncSrBFszq02hIeM1oWzP58rqwtgFGNusO701M9pcIpFa4OsmX3aGaAzKFARq5urQC6qEBVr0T+FsoTsrqfZzlTWW8rS0mg3nyDW9sjsYrAt389gkvcK62cm/aCu+Xy/TnmDPOfFCgzy0hBMFeBvb9Nr9ZxdkbDJ5zkrlh6ZqW3PxMaCluK2zXY1FL+77iViqon597+cVZxeq2fe28s22wq6F3LXXS5E0V4CpGC6PhtvlYLjeuS1shq9fNQn9srtx1L7g5b5dfVVlms1Xaizj+rtXIWdYujjgqUJ1j4pWssGTcaaznGD/XgA+iHnpnf4KZsU/93foKybMpoIObNLbGmfl3YWFP89Q+QNzt4WQBS6xAFWHnMmh4WhunqsVBSx/i4YG4QUFPLPt3EXUtibjJYwvJ1wR7TVs5/qUCJ6Y9GF+hX5pMuxF+uniElt3GA8ONatmhpXxs3TzGGEW3VsDsMhcidzA0Y43BOdtMcNlcwWK9ybtsrrsluPftVNOZXHKtdfJs04rfGQ2jcWfCCyVKWKptL/+4aky4gLnKJTK9nD+1deQ576tnybx/19Y/tteWJqOCvgYhlWhTGy9SCLrlvduxPIolk/rpUjE9PlLyWvkd5uI3FFgsPWa3xc++WKz4a+/1MiT5eaWSdgbNeNOvFkLbYj/1+0N4ysV9d3Hds/5Hr7yLHPQz26TsqunGSBE0g6JXSfjLbZ9jfk2A/+n31heiGwTwcPvWttAP81jZvkq9H7b29d3xvL782se8LtDYTsE2n84SQcTvF43J67dPdrNZpvvwJ/jmrL5B9GT2V0=
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Get all Section 603 high earner statuses for an employee across all years.
+
+Section 603 of the SECURE 2.0 Act applies to employees aged 50 or older whose prior-year FICA wages exceed the IRS threshold.
+These employees are classified as high earners, and their catch-up contributions to pre-tax retirement benefits must be designated as post-tax contributions.
+
+scope: `employee_benefits:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-employees.ParamsDetails.json b/docs/api/get-v-1-employees.ParamsDetails.json
new file mode 100644
index 000000000..8c88a7e67
--- /dev/null
+++ b/docs/api/get-v-1-employees.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"X-Gusto-API-Version","in":"header","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"},"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."},{"name":"employee_id","in":"path","description":"The UUID of the employee","required":true,"schema":{"type":"string"}},{"name":"include","in":"query","explode":false,"required":false,"schema":{"type":"array","items":{"type":"string","enum":["all_compensations","all_home_addresses","company_name","current_home_address","custom_fields","portal_invitations"],"x-enumDescriptions":{"all_compensations":"Include all effective dated compensations for each job instead of only the current compensation. Requires `compensations:read` scope.","all_home_addresses":"Include all home addresses that have been associated to this employee","company_name":"Include the name of the company that the employee is associated with","current_home_address":"Include the employee's current home address","custom_fields":"Include employees' custom fields","portal_invitations":"Include portal invitation status information, including member portal invitation details and partner portal invitation status"}}},"description":"Include the requested attribute(s) in each employee response. Multiple options are comma separated."}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-employees.RequestSchema.json b/docs/api/get-v-1-employees.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-employees.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-employees.StatusCodes.json b/docs/api/get-v-1-employees.StatusCodes.json
new file mode 100644
index 000000000..f2fe9ad7c
--- /dev/null
+++ b/docs/api/get-v-1-employees.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"successful","content":{"application/json":{"schema":{"title":"Employee","type":"object","description":"The representation of an employee in Gusto.","x-examples":{"success_status":{"uuid":"d7282d99-ab6b-42f5-ba45-f4a670e886a8","first_name":"Boaty","middle_initial":null,"last_name":"Koss","email":"keena.feest@kiehn.co.uk","company_uuid":"e904cc79-818a-4da8-9d37-0be0a86fdda8","manager_uuid":null,"version":"a5cec1f1c0135feb3e76ca6ea3c46176","current_employment_status":"full_time","onboarding_status":"onboarding_completed","preferred_first_name":null,"department_uuid":null,"employee_code":"46f036","payment_method":"Direct Deposit","department":null,"terminated":false,"two_percent_shareholder":false,"onboarded":true,"historical":false,"has_ssn":true,"onboarding_documents_config":{"uuid":null,"i9_document":false},"jobs":[{"uuid":"bc875f9d-adc5-40f6-99db-ed8470bda25f","version":"863bcd01c51fcfa2468d604cffec7413","employee_uuid":"d7282d99-ab6b-42f5-ba45-f4a670e886a8","current_compensation_uuid":"2ec164d0-808b-446c-8120-8cfb500945d0","payment_unit":"Year","primary":true,"two_percent_shareholder":false,"state_wc_covered":null,"state_wc_class_code":null,"title":"","compensations":[{"uuid":"2ec164d0-808b-446c-8120-8cfb500945d0","employee_uuid":"d7282d99-ab6b-42f5-ba45-f4a670e886a8","version":"db7bfb49a4f0893432cb562311bfcad9","payment_unit":"Year","flsa_status":"Exempt","adjust_for_minimum_wage":false,"minimum_wages":[],"job_uuid":"bc875f9d-adc5-40f6-99db-ed8470bda25f","effective_date":"2025-06-09","rate":"80000.00"}],"rate":"80000.00","hire_date":"2024-06-09"}],"eligible_paid_time_off":[],"terminations":[],"garnishments":[],"date_of_birth":"2005-06-09","ssn":"","phone":null,"work_email":null,"member_portal_invitation_status":{"status":"sent","token_expired":false,"welcome_email_sent_at":"2024-01-15T14:30:00Z","last_password_resent_at":null},"partner_portal_invitation_sent":true}},"properties":{"uuid":{"type":"string","description":"The UUID of the employee in Gusto.","readOnly":true},"first_name":{"type":"string"},"middle_initial":{"type":["string","null"]},"last_name":{"type":"string"},"email":{"type":["string","null"],"description":"The personal email address of the employee. This is provided to support syncing users between our system and yours. You may not use this email address for any other purpose (e.g. marketing)."},"company_uuid":{"type":"string","description":"The UUID of the company the employee is employed by.","readOnly":true},"manager_uuid":{"type":["string","null"],"description":"The UUID of the employee's manager.","readOnly":true},"version":{"type":"string","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.","readOnly":true},"department":{"type":["string","null"],"description":"The employee's department in the company.","readOnly":true},"terminated":{"type":"boolean","description":"Whether the employee is terminated.","readOnly":true},"two_percent_shareholder":{"type":["boolean","null"],"description":"Whether the employee is a two percent shareholder of the company. This field only applies to companies with an S-Corp entity type."},"work_email":{"type":["string","null"],"description":"The work email address of the employee. This is provided to support syncing users between our system and yours. You may not use this email address for any other purpose (e.g. marketing)."},"onboarded":{"type":"boolean","description":"Whether the employee has completed onboarding.","readOnly":true},"onboarding_status":{"description":"The current onboarding status of the employee","anyOf":[{"type":"string","enum":["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"]},{"type":"null"}],"readOnly":true},"onboarding_documents_config":{"type":"object","description":"Configuration for an employee onboarding documents during onboarding","properties":{"uuid":{"type":["string","null"],"description":"The UUID of the onboarding documents config","readOnly":true},"i9_document":{"type":"boolean","description":"Whether to include Form I-9 for an employee during onboarding","readOnly":true}}},"jobs":{"type":"array","items":{"title":"Job","type":"object","properties":{"uuid":{"type":"string","description":"The UUID of the job.","readOnly":true},"version":{"type":"string","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."},"employee_uuid":{"type":"string","description":"The UUID of the employee to which the job belongs.","readOnly":true},"hire_date":{"type":"string","readOnly":false,"description":"The date when the employee was hired or rehired for the job."},"title":{"type":["string","null"],"readOnly":false,"default":null,"description":"The title for the job."},"primary":{"type":"boolean","description":"Whether this is the employee's primary job. The value will be set to true unless an existing job exists for the employee.","readOnly":true},"rate":{"type":"string","description":"The current compensation rate of the job.","readOnly":true},"payment_unit":{"type":["string","null"],"description":"The payment unit of the current compensation for the job.","readOnly":true},"current_compensation_uuid":{"type":"string","description":"The UUID of the current compensation of the job.","readOnly":true},"two_percent_shareholder":{"type":"boolean","description":"Whether the employee owns at least 2% of the company.","readOnly":false},"state_wc_covered":{"type":["boolean","null"],"description":"Whether this job is eligible for workers' compensation coverage in the state of Washington (WA).","readOnly":false},"state_wc_class_code":{"type":["string","null"],"description":"The risk class code for workers' compensation in Washington state. Please 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.","readOnly":false},"compensations":{"type":"array","items":{"type":"object","description":"The representation of compensation in Gusto.","properties":{"uuid":{"type":"string","description":"The UUID of the compensation in Gusto.","readOnly":true},"version":{"type":"string","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."},"job_uuid":{"type":"string","description":"The UUID of the job to which the compensation belongs.","readOnly":true},"employee_uuid":{"type":"string","description":"The UUID of the employee to which the compensation belongs.","readOnly":true},"rate":{"type":"string","readOnly":false,"description":"The dollar amount paid per payment unit."},"payment_unit":{"type":"string","readOnly":false,"description":"The unit accompanying the compensation rate. If the employee is an owner, rate should be 'Paycheck'.","enum":["Hour","Week","Month","Year","Paycheck"]},"flsa_status":{"type":"string","enum":["Exempt","Salaried Nonexempt","Nonexempt","Owner","Commission Only Exempt","Commission Only Nonexempt"],"description":"The FLSA status for this compensation. Salaried ('Exempt') employees are paid a fixed salary every pay period. Salaried with overtime ('Salaried Nonexempt') employees are paid a fixed salary every pay period, and receive overtime pay when applicable. Hourly ('Nonexempt') employees are paid for the hours they work, and receive overtime pay when applicable. Commissioned employees ('Commission Only Exempt') earn wages based only on commission. Commissioned with overtime ('Commission Only Nonexempt') earn wages based on commission, and receive overtime pay when applicable. Owners ('Owner') are employees that own at least twenty percent of the company. ","title":"Flsa-Status-Type"},"effective_date":{"type":"string","readOnly":false,"description":"The effective date for this compensation. For the first compensation, this defaults to the job's hire date."},"title":{"type":"string","description":"The job title for this compensation."},"adjust_for_minimum_wage":{"type":"boolean","description":"Indicates if the compensation could be adjusted to minimum wage during payroll calculation.","readOnly":true},"minimum_wages":{"type":"array","readOnly":false,"description":"The minimum wages associated with the compensation.","items":{"type":"object","properties":{"uuid":{"type":"string","description":"The UUID of the minimum wage."},"wage":{"type":"string","description":"The wage amount."},"effective_date":{"type":"string","description":"The effective date of the minimum wage."}}}}},"required":["uuid"],"x-examples":{"success_status":{"uuid":"db4d41e5-813c-477e-bfae-38da2ae5e7a3","version":"56d00c178bc7393b2a206ed6a86afcb4","job_uuid":"c1fdb417-c34a-43a7-92f3-5e6c20c1d7a4","employee_uuid":"a7e8f9bc-0d12-4e56-b789-012345678901","rate":"70000.00","payment_unit":"Year","flsa_status":"Exempt","effective_date":"2023-01-01","adjust_for_minimum_wage":false,"minimum_wages":[],"title":"Software Engineer"},"hourly_compensation":{"uuid":"e5f6a7b8-c9d0-1234-e5f6-a7b8c9d01234","version":"98b7a6c5d4e3f2a1b0c9d8e7f6a5b4c3","job_uuid":"d2e5f8a1-b4c7-4d90-a3e6-f9b2c5d8e1a4","employee_uuid":"b8f9a0bc-1e23-4f67-c890-123456789012","rate":"25.00","payment_unit":"Hour","flsa_status":"Nonexempt","effective_date":"2023-01-01","adjust_for_minimum_wage":false,"minimum_wages":[],"title":"Associate"},"minimum_wage_adjusted":{"uuid":"a4d9ba9c-32cc-4cc1-a5bc-6ef4cd653e7a","version":"cc59bd3879d655fb940a1f6b675f2ad9","job_uuid":"d8f8fbe7-496d-4b69-86f0-1e2d1b73a086","rate":"5.00","payment_unit":"Hour","flsa_status":"Nonexempt","effective_date":"2018-12-11","adjust_for_minimum_wage":true,"minimum_wages":[{"uuid":"edeea5af-ecd6-4b1c-b5de-5cff2d302738","wage":"7.25","effective_date":"2018-12-11"}]}},"title":"Compensation"},"readOnly":true},"location_uuid":{"type":"string","nullable":false,"description":"The uuid of the employee's work location."},"location":{"description":"The representation of an address in Gusto.","type":"object","title":"Location","x-examples":{"success_status":{"created_at":"2025-06-09T13:43:49.000-07:00","updated_at":"2025-06-09T13:43:50.000-07:00","company_uuid":"10593a6a-505b-4aa6-bf31-15dcdceedbe3","version":"e1bdd845a493c74908f8e15d6114169b","uuid":"6b1351a2-de35-4499-b948-43abab274634","street_1":"300 3rd Street","street_2":"Apartment 318","city":"San Francisco","state":"CA","zip":"94107","country":"USA","active":true,"phone_number":"8009360383","filing_address":true,"mailing_address":true}},"properties":{"uuid":{"type":"string","description":"The UUID of the location object.","readOnly":true},"version":{"type":"string","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."},"company_uuid":{"type":"string","description":"The UUID for the company to which the location belongs. Only included if the location belongs to a company.","readOnly":true},"phone_number":{"type":"string","readOnly":false,"description":"The phone number for the location. Required for company locations. Optional for employee locations."},"street_1":{"type":"string","readOnly":false},"street_2":{"type":["string","null"],"readOnly":false},"city":{"type":"string","readOnly":false},"state":{"type":"string","readOnly":false},"zip":{"type":"string","readOnly":false},"country":{"type":"string","readOnly":false,"default":"USA"},"mailing_address":{"type":"boolean","description":"Specifies if the location is the company's mailing address. Only included if the location belongs to a company."},"filing_address":{"description":"Specifies if the location is the company's filing address. Only included if the location belongs to a company.","type":"boolean"},"created_at":{"type":"string","description":"Datetime for when location is created"},"updated_at":{"type":"string","description":"Datetime for when location is updated"},"active":{"type":"boolean","description":"The status of the location. Inactive locations have been deleted, but may still have historical data associated with them.","readOnly":true},"inactive":{"type":"boolean","description":"The status of the location. Inactive locations have been deleted, but may still have historical data associated with them.","readOnly":true}},"required":["uuid"]}},"description":"The representation of a job in Gusto.","required":["uuid"]}},"eligible_paid_time_off":{"type":"array","items":{"type":"object","description":"The representation of paid time off in Gusto.","properties":{"name":{"type":["string","null"],"description":"The name of the paid time off type.","enum":["Vacation Hours","Sick Hours","Holiday Hours"],"readOnly":true},"policy_name":{"type":["string","null"],"description":"The name of the time off policy.","readOnly":true},"policy_uuid":{"type":["string","null"],"description":"The UUID of the time off policy.","readOnly":true},"accrual_unit":{"type":["string","null"],"example":"Hour","description":"The unit the PTO type is accrued in.","readOnly":true},"accrual_rate":{"type":["string","null"],"description":"The number of accrual units accrued per accrual period.","readOnly":true},"accrual_method":{"type":["string","null"],"example":"unlimited","description":"The accrual method of the time off policy","readOnly":true},"accrual_period":{"type":["string","null"],"example":"Year","description":"The frequency at which the PTO type is accrued.","readOnly":true},"accrual_balance":{"type":["string","null"],"description":"The number of accrual units accrued.","readOnly":true},"maximum_accrual_balance":{"type":["string","null"],"description":"The maximum number of accrual units allowed. A null value signifies no maximum.","readOnly":true},"paid_at_termination":{"type":"boolean","description":"Whether the accrual balance is paid to the employee upon termination.","readOnly":true}},"title":"Paid-Time-Off"}},"terminations":{"type":"array","items":{"type":"object","description":"The representation of a termination in Gusto.","properties":{"uuid":{"type":"string","description":"The UUID of the termination object.","readOnly":true},"version":{"type":"string","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."},"employee_uuid":{"type":"string","description":"The UUID of the employee to which this termination is attached.","readOnly":true},"active":{"type":"boolean","description":"Whether the employee's termination has gone into effect.","readOnly":true},"cancelable":{"type":"boolean","description":"Whether the employee's termination is cancelable. Cancelable is true if `run_termination_payroll` is false and `effective_date` is in the future.","readOnly":true},"effective_date":{"type":"string","readOnly":false,"description":"The employee's last day of work."},"run_termination_payroll":{"type":"boolean","readOnly":false,"description":"If true, the employee should receive their final wages via an off-cycle payroll. If false, they should receive their final wages on their current pay schedule."}},"required":["uuid"],"title":"Termination"}},"garnishments":{"type":"array","items":{"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.","type":"object","properties":{"uuid":{"type":"string","description":"The UUID of the garnishment in Gusto.","readOnly":true},"version":{"type":"string","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."},"employee_uuid":{"type":"string","description":"The UUID of the employee to which this garnishment belongs.","readOnly":true},"active":{"type":"boolean","default":true,"description":"Whether or not this garnishment is currently active."},"amount":{"type":"string","format":"float","readOnly":false,"description":"The amount of the garnishment. Either a percentage or a fixed dollar amount. Represented as a float, e.g. \"8.00\"."},"description":{"type":"string","readOnly":false,"description":"The description of the garnishment."},"court_ordered":{"type":"boolean","readOnly":false,"description":"Whether the garnishment is court ordered."},"times":{"type":["integer","null"],"readOnly":false,"default":null,"description":"The number of times to apply the garnishment. Ignored if recurring is true."},"recurring":{"type":"boolean","readOnly":false,"default":false,"description":"Whether the garnishment should recur indefinitely."},"annual_maximum":{"format":"float","readOnly":false,"default":null,"description":"The maximum deduction per annum. A null value indicates no maximum. Represented as a float, e.g. \"200.00\".","type":["string","null"]},"total_amount":{"type":["string","null"],"format":"float","readOnly":false,"default":null,"description":"A maximum total deduction for the lifetime of this garnishment. A null value indicates no maximum."},"pay_period_maximum":{"type":["string","null"],"format":"float","default":null,"description":"The maximum deduction per pay period. A null value indicates no maximum. Represented as a float, e.g. \"16.00\"."},"deduct_as_percentage":{"type":"boolean","readOnly":false,"default":false,"description":"Whether the amount should be treated as a percentage to be deducted per pay period."},"garnishment_type":{"anyOf":[{"type":"string","enum":["child_support","federal_tax_lien","state_tax_lien","student_loan","creditor_garnishment","federal_loan","other_garnishment"]},{"type":"null"}],"description":"The specific type of garnishment for court ordered garnishments."},"child_support":{"description":"Additional child support order details","type":["object","null"],"properties":{"state":{"type":"string","readOnly":false,"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."},"payment_period":{"type":"string","readOnly":false,"enum":["Every week","Every other week","Twice per month","Monthly"],"description":"How often the agency collects the withholding amount. e.g. $500 monthly -> `Monthly`."},"fips_code":{"type":"string","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.","nullable":false,"readOnly":false},"case_number":{"type":["string","null"],"readOnly":false,"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."},"order_number":{"type":["string","null"],"readOnly":false,"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."},"remittance_number":{"type":["string","null"],"readOnly":false,"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."}},"title":"Garnishment-Child-Support"}},"required":["uuid"],"title":"Garnishment"}},"custom_fields":{"type":"array","description":"Custom fields are only included for the employee if the include param has the custom_fields value set","items":{"type":"object","description":"A custom field of an employee","properties":{"id":{"type":"string"},"company_custom_field_id":{"type":"string","description":"This is the id of the response object from when you get the company custom fields"},"name":{"type":"string"},"type":{"type":"string","description":"Input type for the custom field.","enum":["text","currency","number","date","radio"],"title":"Custom-Field-Type"},"description":{"type":"string"},"value":{"type":"string"},"selection_options":{"type":["array","null"],"description":"An array of options for fields of type radio. Otherwise, null.","items":{"type":"string"}}},"required":["id","company_custom_field_id","name","type","value"],"title":"Employee-Custom-Field"}},"date_of_birth":{"type":["string","null"],"readOnly":true},"has_ssn":{"type":"boolean","description":"Indicates whether the employee has an SSN in Gusto."},"ssn":{"type":"string","description":"Deprecated. This field always returns an empty string."},"phone":{"type":["string","null"]},"preferred_first_name":{"type":["string","null"],"description":""},"payment_method":{"type":"string","description":"The employee's payment method","enum":["Direct Deposit","Check"],"default":"Check","nullable":false},"current_employment_status":{"anyOf":[{"type":"string","enum":["full_time","part_time_under_twenty_hours","part_time_twenty_plus_hours","variable","seasonal"]},{"type":"null"}],"description":"The current employment status of the employee. Full-time employees work 30+ hours per week. Part-time employees are split into two groups: those that work 20-29 hours a week, and those that work under 20 hours a week. Variable employees have hours that vary each week. Seasonal employees are hired for 6 months of the year or less.","readOnly":true},"historical":{"type":"boolean","nullable":false},"employee_code":{"type":"string","description":"The short format code of the employee","nullable":false,"readOnly":true},"department_uuid":{"type":["string","null"],"description":"The UUID of the department the employee is under"},"title":{"type":"string","nullable":false},"hired_at":{"type":"string","nullable":false,"format":"date","description":"The date when the employee was hired to the company"},"hidden_ssn":{"type":"string","nullable":false},"flsa_status":{"type":"string","enum":["Exempt","Salaried Nonexempt","Nonexempt","Owner","Commission Only Exempt","Commission Only Nonexempt"],"description":"The FLSA status for this compensation. Salaried ('Exempt') employees are paid a fixed salary every pay period. Salaried with overtime ('Salaried Nonexempt') employees are paid a fixed salary every pay period, and receive overtime pay when applicable. Hourly ('Nonexempt') employees are paid for the hours they work, and receive overtime pay when applicable. Commissioned employees ('Commission Only Exempt') earn wages based only on commission. Commissioned with overtime ('Commission Only Nonexempt') earn wages based on commission, and receive overtime pay when applicable. Owners ('Owner') are employees that own at least twenty percent of the company. ","title":"Flsa-Status-Type"},"applicable_tax_ids":{"type":"array","nullable":false,"items":{"type":"number"}},"member_portal_invitation_status":{"type":["object","null"],"description":"Member portal invitation status information. Only included when the include param has the portal_invitations value set.","properties":{"status":{"type":"string","description":"The current status of the member portal invitation.","enum":["pending","sent","verified","complete","cancelled"]},"token_expired":{"type":["boolean","null"],"description":"Whether the invitation token has expired."},"welcome_email_sent_at":{"type":["string","null"],"format":"date-time","description":"The date and time when the welcome email was sent."},"last_password_resent_at":{"type":["string","null"],"format":"date-time","description":"The date and time when the password reset was last resent."}}},"partner_portal_invitation_sent":{"type":["boolean","null"],"description":"Whether an external partner portal invitation webhook has been sent for this employee. Only included when the include param has the portal_invitations value set."}},"required":["uuid","first_name","last_name"],"readOnly":true}}}},"404":{"description":"Not Found\n\nThe requested resource does not exist. Make sure the provided UUID is valid.\n","content":{"application/json":{"schema":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided ID/UUID is valid.","type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["error_key","category"],"properties":{"error_key":{"type":"string","description":"Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error."},"category":{"type":"string","description":"Specifies the type of error. The category provides error groupings and can be used to build custom error handling in your integration."},"message":{"type":"string","description":"Provides details about the error - generally this message can be surfaced to an end user."}}}}},"x-examples":{"not_found":{"errors":[{"error_key":"request","category":"not_found","message":"The requested resource was not found."}]}},"title":"Not-Found-Error-Object"}}}}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-employees.api.mdx b/docs/api/get-v-1-employees.api.mdx
new file mode 100644
index 000000000..69c36de73
--- /dev/null
+++ b/docs/api/get-v-1-employees.api.mdx
@@ -0,0 +1,73 @@
+---
+id: get-v-1-employees
+title: "Get an employee"
+description: "Get an employee."
+sidebar_label: "Get an employee"
+hide_title: true
+hide_table_of_contents: true
+api: eJztPe2S2zhyr4Lwkhq7Imqob2l+pM7xx94kt2vXjvc2F69LBglQwg5F6ABwZMWlqrxGXi9PkuoGSIISpdGMZy+1d/vLHgpsNLob/Q3wSyDXXFEjZH7NgqtgwU141wv5ap3JLec66ASM60SJNQwJroJvuCE0J+WA7k/5T/l30vAr8lKu1jzXCIswaih5tqZboqjhHbKm2xXPDSlyYTqE5owonlHDGUkFz5h+ThRfK655bjTRPNfCiDteTQPvE5GnUq0Qfpf8uOQ5Udwowe9EvqhH/ixjnL1DzJJr7uCTZ58AkU8d8smhMgdU4O+kUAr+Tjz850UhGP7oPdSfnhOqOJF5toWpC5VzRjaAiFnyvbFXilP2iehErjkRmog8yQrGWZe8XwpNaJbJjSZbWRAjCU0SrnW9BqAPrGPFDUVKboRZysIQ/nktNSy3pKxGBuAsV+RTxTY7e9AJDF3o4OpD8Lpi6MdO8DlcFNrIUOSGLyzzQ7NdcxjIVzFnjLOgE9D12h+Cr66poituuAKoX4KcrnhwFfxH+A0CfPHuOvwTVxpEpRMIkJclp4yroBPoZMlXNLj6EtipAm2UyBdBJ+B5sYKp+1F/FEbjsDeCmRhPaZGZ4Mp/vtsXx1eAy0rkXCMPGDU8jKnmjLx4d03uLC6Eai0TgeIGlASyKxyQ0CzrkuuU5DJHNq2VvBOMs44dQ9frTCS4/AtNPqxELlbFyof98dnSmLW+urxkMtFdJGw3kavLkpDhmm6VzDL8/ZKuRejeFPnidw5g6D1+DmgUmrNusOtUFC45OxespOyamuXB9ny/5OSHH65fEZkiQcr3gk6g+F8KoTgLrowq+HGG7LxpndSWU/6l4GoLHPu8ziTjwVVKM8190O7BAWyqFIU3heErfUoIaJY1diJoIHi2lCs+p4wprjWqJRhE8+0cMe0E5S72x+FjbeRqbpVA0AnWUhmazUV+J0wt1Z9DmP5VTUlE8RCVq+DaEgT2L+FpyhNUUwxFqzGWpFIRTpMlbmSRa8MpA66g9gDWOIwbr3XJ95aU+oQ66baTpIkc/EiqH4lZUkOW9I6TmPPGhjCSGNBInqQ0SFuDBaThUSlbbpiF7QsbSPDeljvGoSb0EsCFrqjjr+OAn/Xblea7IHYIOcXy+j37I6l/JNpQU2jf2HSc8ga9u4JtrVpeY9xQkWlU3WuqTN46ygIPdrsDReaTAbYT10A6aowScWH4M/2ciNwKVEVmxfVa5pp3ybdFZsQ640Ra8UU7lcjVihLNQWcb1CcfO4HmSaGE2aL6fmk5+ALNz4vCLIOrDx93noVQekMXpcIop8PN0Y8i+Ke5CF0gpLTIUIpyw3ODO6lWo5c/axj6xVcRwmQgZ69rCXTaQcY/88S0KrnKXbCElanvlQCp0CLBVvkc8s90tc4s3g7FuePE1ZcATH1wFbBJf9pns1lI43EcDvvpKIzpcBSmQzqeRHw6HdNp0AlSobQpd8a/SmpAq60EYxmfi1wYQbPgKi+yrBNktB757xLFl6+oyIKr4JbznHZTzrX5/a3gy7ybyG5x6+09hxWfRcMkmczCaW9KwyGj03DGBpMwinlEp+OUMcRqRXO64Mq9Zad39gSU7yjhSS/tJVFvMEp5POCTcULHnA6S4bg3GXub01IQ/aOSQkFaZNncCFSzMo8lVbAV6t+9Z4B9xg26D2vFU64UZ3OfZhY3BkJprBvmoVxZuQStSzAcp9EA0Ct9thU3Swl0eSUUTwx5xcEfshJSQiyBWccAJL8yS2Yj52uuElzekiq+lBl4J+XvbiW1jVwKbaQSCTDVjVlSPdc6L0d4i2cyKQABPU9knopFLVwWITGrhjhou07ws4ytK+UYHifTySidsZCyZBQOo3QczmYsDjmbDidRzGh/lAY+c6fjQZywqJeMemmS0v5wPGXjaJiAcZoMe4PAI+vDRP2oYww+GU964yGLwmk0jcPhcJyE014/CqdJGo+iaDYcscjjG/jawVXwZ04VSoZYUbUtSXgfV0DQ+HyTzBN5x9HLsPSsn2dUayczjvdOpbgN5VnwmtJnLuGRxKsZxOJJnMbDGR2m0XQ2GA76STwa9we9XpwmlM2OkinNNK132evPfLUGSafs50KbeSrV3LmP8w1d1M6Y/xAW/BGFbP4w+ap8mzn4Np4THgG+yj6bRlEUdaMIDcv+M9g8yn996F6HwTwTCxFnfL6mgqFumcs0tciW+9bx62MnWFCVC73EvWWfANS5TOexUGC0wBrV2OHuBNavlzKvRGIj1e3c6V/7xNry+YF/4NmGivpgacAuyVuez/nndcPb3fAsAacGoc9h6JyaatG9sDd63xteDaKrKPrPwNmFNdV6IxWbWyuGLwBaO4yxwH1oQwxVB+wacCDWCmJ3I7hnxg4d6/Pig4bFBF/zbZ65DbprGr2DcOHQ/JVDPtRYwNKCj7uGUWyB5PhzFEDbctZcaZnTjODLpa+4v0AXd3shHni+ulgDlYne5gm4d4XmSpOYmw14yRAB6q02fIVuHUSEukv+LAuyoluSSwPjS+/Znxt8f/CMpVmCG1iotdScPOPdRZesqLrlRuSL5xDg7dn7h7KvdsGb3rf7PyPxtpWhTX/hQeRuk54LTRzE1tkqXXjO8krHv4zdD/h4w62X/KGOo8miEIw/MBQXjK/W0vA82T5HjnkuP5E5WcoNiEjFYgwoWtfn+x4PoqVHvxoGbEWPt60z+r5NRdRYyozT/ICqPy45yuG+kNRA2uc4ZpbrJdYztq/x2MyUmI0kDjjxgO/Jtdu0SHkbOGMkAfGsdGPgD8zp0JzchC+lWhOeG2G2BJDELeZr/gexB178dWoVz5F9nHgsqSaVM09qJ7dVUlqCgv3I0N/Z9fAy2D5MVtF8+zZFb+1YouhI1EHZSuRz70eRlz+Da8Cz1P9xzXM36E60DrA/sOO/wIrV6RHgtbKiDXqF+Dzezr3V74+jGyoM/gdXp/id4BswpxV5UIjRDTvBnLYA5XSk/RLHFTYB7ASwFhKPkRVowgpglPdbcNpTebDRaZ3VLahl/Y2o6/zNIMuMPXkj1Ypch7OD5betdG/6XRXhnciEuljl32Tckvl4CifvZxn/YnbZIvr/bpV3B4Haoz1hI8lmKZJlSToS80zmC91KQi/GOZywHu0ChUMM4NW6hFThsKGaAGhGpCKK2/8CNSp27qog98RGakHAFVXKNMw+PgjzYKYqYH+AMbFmcc9LdIAQMIH57mhWcLIRWUZiTjQ3mI9WBSdFnoHRgw33WWjQfsgM/ENXGFaGuI056ghfjgu3nyzA+tp9W6gZuT8sbvFKopXf04ZHgxstOJzI0zw4nmib/x4S3OsnPszzkBtIXxuScaoN6f/Tvkt4uK92bSmixzipQttijSZlfgJpD24gV1BZ8KmCM9EFL911RAGQ/ZHqpcgXRubk2Y8vnt+HsJe7epD4KKFvCb5N4O0TmIrcxwln7pJ3QF9O7oQWhnzY//1Ck+8B/kuEv6YLT41vNptulovuhnYX8u5S5LpQNE/4JdajQ8ArRLy4vvT/CFOpQodh6CPojQozKW+L9e8un4MeyDhVOVlJxduJuJfau7fY+KBywj4Jq+zIU1jko8D/xm10nYh8hA/TtMwNEp4y0b+IX3D27Mds0Dm+gcwyqghdySI3BDKlEDI37Ia1zq026EFToQ2iidOxIBcHi1SoNq7304ZooeUm56pjDaZeyiJjYM0v3tFtsuTJ7UXXi9v+IAtIbv/IOZS7vpU5Foddyrt8A1OFjfz38UCwSozf0IwqwRn5Tua8fOj//y2gGXSg7LkSGncI0IVUEPZ/qF9uVcFv/njzogxhrZEWeq+cX+H07MLOcvG8rlVjlRb5SkkqPnNGNAzfEn7H1RZ7fNZcCck8OJjrANMDSXPy7OJw0Y+aoezJSjj0M1TwYQB6p66CG2e8S4CD2ZY8u7hnytJvWUKGA/63RQP1kKlqhnDmTfHsop2FgAeYDCx9ENsHhGkjtNflG3tg9yl6VAjaoXuAH7IylEVYCf7nwnaW1SvEngq5yWtPyGx4brZV0mw/URbURa83mabhDYpl+B42ze6wnvMoLdFseDkm8m8c27Fo0PitY4e7IETb1hNU7Rc23EG4bbHNKWWNlsELW/YRAnBHa2b3+qjXOYPOBa6JaDHdSanr7AQ2/Vd2icEMZZLA2U9oOEuKzCHWlphvFu8OXJozuORPf9CHc7CE7ik/6SlcHR8dm45tEv4EGCSgNX/d84T4XpltR2qHiZq6i+2DXevH85tH4iEb9vgonPYGSTicTHgYp5SHgymjfcpHfEIHjaLwaMyiKOlNpnEyGcwGcZ/2ozFnYzod0zSJh0GjaJv0UhYPe5MwGQxpOBzQSTjrp4NwxMdJP0p6bEKHLaVqOuHTdBYnYcR6/XDIR+MwnkxnYdTrD4aj8WQ6i3p1NXdSV24fVI9uKxUPoOyJwB9RrS712I1MzQbU4ut8IXLOFcjAEo1PI9b1+MBH6ZhO4mmYzFgUwjJDeBTCM3gETxp8mE3jCR0nIzbkg7RPe3GUzNiUT9IxHcXDZNDkA+vzUTqlvTAeJpNwyGZRSAd8HKazuJ+M2JT3WvkQT9MZjeIk7PH+IBym40mYTGcWP8eGfs2H/qiVCc5vajLB925+MT68KFVIsKeg5qXW8zhAh2wW01kSDvpJEg6TpBfSUZyEY54OEzYeDfiENjiQJKNZzAbTyYyNR6M0ng0j2kvH8XgySvu2PcLnwDSdpjGfhMPZmIXDeDwLp+M0AsqyXjwZ0Gg6rkn5dJTsTcNeP+ydpKTtZtknZC2bjHM6omnIEzYOh3EvCeMR4+EoSdM+G0T9yQAaRyysYNLtj+5BZfdxV1vKwG+/D3YtpiWTyenUEOQawDk5FScUgrUUf7FQVsJHVV3+0V4Jam3eK8tcfji8b5DKxf6xBH+/hk4UB+tXdWS4PpH3vcHVcHA1nHWjKAqjyRVKSrFmJwaPosbgvVa9XjSaDeiYhqNoFIdDSsdhnA6g+4MlLOGcxbxpA3gvZmw6HNHhbJBMhrNomk55b8TGvd6wN55BNcCBHse9wahH+yHjg1E4HM5mYTwbTsESxDTuT4ZjVGvaKM7NvBdcBYMoIgPFyA0+qn/rw36uKs2DHvZ5YTtocENz8gYyOUInMnApKhCsF0En+C+xBm057EUTXHmRG8gHBz/cwK8URbTcAdh2M88L6K6xHUGzwTgaTAfYPpnZOpZr/3V7hrY8fqoWl1IUyzTI336W5ZE9JWW8VjWV+AmPioplssMGR+WxltI73h+Gp1tOtjI0peVRcQmCIBZEtYpKHZUt9TYgLRdX/gwLQVg0sy37ZWajHhDs/K11L4Y7f7OdX5zZlRvxvAnOi+J2bueeM7Da1GfxoDycAwpg17KD7w2sbtY8EamoA6tKdFzZyHEKe4sQeGkhHid6u0Pls2+aHoBS+gQYdfZJBEzwrNV9G/cVNRwTDJj6hwSDj6+DBEB9q/Z1QB0kDKmdzr+X0e9dcaTu86i35nVuwdS7zTukwjj2RnRIXBjsjdEG6oQ4oG7MtkcNW8LcVau6EfmvEvHW8PTwFMkR58qdQfLLDG2wjnXlPm1hBXODKGIyTU9UVppNomfVxPzTSc1pbDNYnTT+E3VCDcEAnMy4Eclt9ccfZCYY3bq/27pq1jITyXb+lThW6Flw7fbRzvSVTTPnzESTRBU0u7+W7RzuOpQ6UlCAid+9f4vEx0oBTADqsT33Vc7fLJmcR1Rr+0HWLRBEoJ4R6iblLy6lfgqD8pjJWTQo8kysXJPYIWblrBbkEXacwsWieyYuLlNziEaKZ8ryZAsJ5dqra+HOScLENINS79Ny50iH8mcMo79uZgflOAZwDBsOZb8gAMS1o2ixyK0fkMsSxJHuDwFWde4dWXhg20OJjlsedpKi4pLNOluxljnxpmk3EWV4/I4KFr4XKx6+TdNgt9s/VPG0Cp36iD15qdyH/XcTwf0CNWuv4ds5c9QYmiyP7vgzvaS2Jp6L5lzQTLzAA/a5kS4j397JBHvA5aCeYmJwgyuQXfKy+j869NBlJlLySRW5v4PnjoefYBDGO1jW+9RMxX2ylzrYSldhiv0elbL54EnqbvXq4PgMAddEpph1Q2k5soBWGt4zHdT3ISXTFCNX0y8rm2bJhSKpgJjZVpnuBMU+gDQNk22S8bLehQ0DdiJbAL4Xkszdw3KPQvUUzgqzIsNSTXudptR87z1NDGObR8eO6729S068tzrEzwowzooEtWgHK7a2qG5rVBpGuvosrsUOhsSDkiu/dfh///t/QM/j+Qa+BRmFGmI1nBJtI9HEM1zgMuAMcJ8FELBQWFmMqRa6S3yUESDNtLQhR2kEa9wtjC2nUMe3SIPmCq2vgaVtbavkMgf1ZNsbfFq6A+aFMqFUDFruyr4UOzZZioxVByGkIjFNbomhnwHwDZzpr49vuKMTJJM0L4vCQu0Xw2FCxdE4grT5yLRlip/C9Hhz/D01af0yxscn5qmGqZOGx2WdbNa43RxIhWdoDuYU1Z0ScIwIJ7GtAbh325ZpyQUH4DNJzXmq2jVrHQpQl7wWiB/1VAQgWzbmNLq9IGnp3CzQB3BiCpHoEDzt81Mw7UbRT0H34EKcxzWa1U/aMLcp5UKZudvqjzEsvrXeZwvAJg626/5Y+d0PHwK8hgh7tx7f2r6vSiEZt167y1ganLpe5FLZNF6tZ53HYA1u+fRcSjjUHkSZ2lQWsHkZT+GALc9sLpPmOUaqVrcDHueI6z0kOrAUNnDO82K1FyKJqi3GC5HuE9o+9heA2HaOBXHAfAmnnve3ZUu495ULflEtF2f0Fl2VEETKXaR+oE/OoYdrznQhvM+r89f0SJ75vYNfz7je2Fc3MM+c6nmtx556GzgtWreSGpvMtrh5+tPIhuO0t/Kg6QDOLYpfzjhciO7L3LkvYAo444pmc0M/zzPB87I82nxQMJgF3JgAM/lMGKnmHgYeJDcKz3I2hrSe6mtJTJceIqZvZNpQHbbQ5WnVPXcJFHpjhQce8AvGhKuK7btycEzX3Xbk7ePK8SoluemAnVuwaj2TtIGjAMZw5Q5Z0DiGI5DN0zH2J6F1UbUvHyLeJS8WmAXD3DvEwHdUuIjQ3eL3zev35PKud+lT7LJBrU9w/1uj83o/R3dieVXXMjbgbmwXtP3Dnut1j95vRIJ3G5CVa5HGVulse5jo+oPcEJkad4aM2gUmMst4YmzdCioLcCoHS1bOwcCt/Y+jKLITZFsS/gv55Cb55Opl6/2jKaecwDfX727sWZS2pkN3PgYFExpZHZ5/RYa1dLi0VEGpPqxGn3e0rnFwFpdy45byGlzvhOPefAnHbr6zvsghncAdalIhzsTCSnpIlF/JXkltLFV1RaVKK7iRdaz2dYKOvHgCsrxF7XENehISrOitu2evvo4aGmLKvxI1FF8JYyCZ9ItKyvfVNL8i6nhZaC8lEeIqQ7fKe7M43ps4du/Wv4M0zh5F/QsA6xtbq+r8/tnRslxfHvjGO04xaWmPRHpzlwUCbKk6M2n+onEj4d5NdQeZiraI22vp8bGZnxed1wdx69698io/l3WwCSqs9sONtAtuGo1AzRsVd53g6P09pYd1GqfrfF0Y67hUPUfeFH6d1vDPprqKDAtlbsfZO6Cw1ZMJ6QuPZX/4BkBV5x9OBsmQwQG+tv6iOdhRSKvK+mrQcrOXAthegXqRExyA1366ixlhwU6WpC1LE1xBl7wF878RkCoFcG2N+dUNrXv7By+FPSYijl2OOeVSPYKV9y6GPuVw3+1ds3WWkisPxpfX5D3ghMXm2E0kcLfLzXdeDm7nbvm6t5sF4poEr7jxr5Kh2YZutbvDWbv9aKBPQ+EdJ7vq7rBTV1m1X3B4dn3SdyD3C84nTzR4x+ndUUD3er1tDq5HfGlP1fmdW/bRgVO0O3kZ5DnBk39fJLSa2k6SIgcXwp5imi9do0X9s/thnRW6+vWOKoGYwS6keMnXueFRmWStl3DkrpkueVNkWYhhfp1xxobmQfTP7uza2vnlXfKOKrM/GCyMXmfC2PoWhCsLJYu1viJmKTG/CkV3ANmPwv7MAaUI0p4Z2x+HxCL9qDG0S/7kCOJNbpuK3Ak7asgdnu6Da2LtKzeOcHv41jdKjK3/XxEGqgLglsHtC0euvKjvxGzZ3IfitHer5zkyrpfgz9hkiA0pDq8IOuHMH9zL9bXtM97tXPvHX5FVJ4+sHVIEqX+kHe9gWVVKyBm8R1wi4roJnIXAYzSCMZ7PjyjRQ4x/O4v721nc387iPs1Z3HpqTB+K1pDmQA3s+4LODwY37YyLTI+m6Zo76dtj15sf3oq+3/Nc6Z/2MOrwFvY6ljpsFTquaY6b+qZ9P3ZRux9cuNvf0L3A5OwdV5CWKL1pd2mcbSHJOHPlicYVsI+7DNGjLMJDMjmY9pBs+5Wy51QO8BsYzv06YivQ5YDtUDHNzeduHATLocvS39Hran8xZMrJIEzlBrHBvhc7d9fGP/fdkvtwxuBVU4Yr8JaOX+G/4fFSylvkGHZ76zLj3viMwpNuj9Z8SeNaXv9i3cNwDAk2jIaHef7vpCFvZJEz+IzM+8a3BxTXslAJ3EOC1SJj797qkm/pLSe6ULZPobr4Ev0lgXgL1v0pf8gnAI4gRX7KCflavK5fXTZRa+kW8YnLlZK267upk9zzBzRPHkCd3/ItKhTDF1Jtj8yBo+5VffVhlc2SuzXj60QmCV4p+n67Bi8dK9xCk1u+JaLMvFqpqz4vcVl916f6LlPZgQogbcWoxPoBqGEDpytQWUh461sJqmSSdphj2CTgpAwoBdcWBd/CwUJfAblOlyiy45c0Z3gOR+T2ez3e54oQ5xXX+qzrBt6ViFTf8Yjhe0s1UUOy4DlU7kpyOtAllrpQKU0spqBIcobXvlaXCzSPqeYSDhAXOfMF60OD/4GTeF9errwXvcUFRzYIKE7YH/hCd++88HfShLjJwtcwafjWSm2Frl5zesup3oagVELwoJTArzIsMPsJqjLX1aX6FuejX5aqMmz3fGEKovsmKPsJkup9G9rVg46hWb2A6EKSoPp2hMUfP590FUBWu3L1Lr9431naoV+g7spvXRUKvtxR9mDRtbAtWCHjK+zDakk+rWTQJKWFF9qj7PAzLOUI4FaY7xTmeY7BXMPP/mdebkDFWplr+dhLtStg8vIbXRjOc6r44UkCByLM+B3PCC3MEtRJUp05v8Frjb9mBgvhyAR4fCuVgXdpKuYDofTQOFntfTHMtr7rt+kNV3ci4R6l6w463OyXOPCSwdSgk0P8O5QpUhhePXAcnNNkpM1LXmjy2gk3eecufIFPhZX3z+Iy/sHZRZqY+pRT8KqclXzPs+rDV+XnYiqcfl9LBvpAUpsVzT04e5/n20f5S22Sf/uS36/sS352H0FB5HKdUYEbDlXHF6fLPgR3Pe/2ERCgK/+7cR/h9hRtYOCXLxAy/6Cy3Q4e2++6gZJjQkPUydqLlb74/DU+WHVk1Vb319+mKzU9ar4qafyw5TwrT4k/Jye+odeKTukO5lsflxJNnwM7CCDdFxEfht7f9HcOT7K5/duSNcsrXwDMDmYOy98OQo6GF/DN6/fggTStVGWV3H+8MkeTvV++2BHvIXrf7SpuYzSPntbu/wCCHkXT
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Get an employee.
+
+Note: Compensation data (pay rate, payment unit, and related fields) represents sensitive employee pay information. When retrieving employee job data, these fields (`rate`, `payment_unit`, `current_compensation_uuid`, `compensations`) are only returned when the `compensations:read` scope is included. This allows you to access employee and job metadata without exposing pay rates.
+
+scope: `employees:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-external-payroll-calculate-taxes.ParamsDetails.json b/docs/api/get-v-1-external-payroll-calculate-taxes.ParamsDetails.json
new file mode 100644
index 000000000..849144877
--- /dev/null
+++ b/docs/api/get-v-1-external-payroll-calculate-taxes.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"company_uuid","in":"path","required":true,"schema":{"type":"string"},"description":"The UUID of the company"},{"name":"external_payroll_id","in":"path","required":true,"schema":{"type":"string"},"description":"The UUID of the external payroll"},{"name":"X-Gusto-API-Version","in":"header","required":false,"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.","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"}}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-external-payroll-calculate-taxes.RequestSchema.json b/docs/api/get-v-1-external-payroll-calculate-taxes.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-external-payroll-calculate-taxes.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-external-payroll-calculate-taxes.StatusCodes.json b/docs/api/get-v-1-external-payroll-calculate-taxes.StatusCodes.json
new file mode 100644
index 000000000..e9e625c3a
--- /dev/null
+++ b/docs/api/get-v-1-external-payroll-calculate-taxes.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"Example response","content":{"application/json":{"schema":{"type":"array","items":{"description":"The representation of an external payroll with minimal information.","type":"object","x-tags":["External Payrolls"],"title":"External-Payroll-Tax-Suggestions","properties":{"employee_uuid":{"type":"string","description":"The UUID of the employee.","readOnly":true},"tax_suggestions":{"type":"array","description":"Possible tax liabilities selections.","readOnly":true,"items":{"type":"object","properties":{"tax_id":{"type":"integer","description":"The ID of the tax.","readOnly":true},"amount":{"type":"string","description":"Calculated tax amount.","readOnly":true}}}}},"x-examples":{"Example":{"employee_uuid":"d21848d5-446f-48a8-9430-30fbefeabda4","tax_suggestions":[{"tax_id":1,"amount":"500.0"},{"tax_id":2,"amount":"100.0"},{"tax_id":4,"amount":"30.0"}]}}}},"examples":{"Example":{"value":[{"employee_uuid":"d21848d5-446f-48a8-9430-30fbefeabda4","tax_suggestions":[{"tax_id":1,"amount":"500.0"},{"tax_id":2,"amount":"100.0"},{"tax_id":4,"amount":"30.0"}]}]}}}}},"404":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided UUID is valid.\n"},"422":{"description":"Unprocessable Entity \n \nThis 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.\n","content":{"application/json":{"schema":{"description":"Unprocessable Entity\n \nThis 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.\n","type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["error_key","category"],"properties":{"error_key":{"type":"string","description":"Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error."},"category":{"type":"string","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."},"message":{"type":"string","description":"Provides details about the error - generally this message can be surfaced to an end user."},"metadata":{"type":"object","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.","oneOf":[{"type":"object","description":"multiple entities","required":["entities"],"properties":{"entities":{"type":"array","items":{"type":"object","description":"single entity","additionalProperties":true,"properties":{"entity_type":{"type":"string","description":"Name of the entity that the error corresponds to."},"entity_uuid":{"type":"string","description":"Unique identifier for the entity."},"valid_from":{"type":["string","null"]},"valid_up_to":{"type":["string","null"]},"key":{"type":["string","null"]},"state":{"type":["string","null"]}},"title":"Metadata-With-One-Entity"}}},"title":"Metadata-With-Multiple-Entities"},{"type":"object","description":"single entity","additionalProperties":true,"properties":{"entity_type":{"type":"string","description":"Name of the entity that the error corresponds to."},"entity_uuid":{"type":"string","description":"Unique identifier for the entity."},"valid_from":{"type":["string","null"]},"valid_up_to":{"type":["string","null"]},"key":{"type":["string","null"]},"state":{"type":["string","null"]}},"title":"Metadata-With-One-Entity"}]},"errors":{"type":"array","description":"Will only exist if category is `nested_errors`. It is possible to have multiple levels of nested errors.","items":"circular(Entity-Error-Object)"}},"title":"Entity-Error-Object"}}},"x-examples":{"bank_account_delete_unfunded_payments":{"errors":[{"error_key":"base","category":"invalid_operation","message":"FundingMethod has unfunded payments"}]},"bank_account_verify_incorrect_deposits":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Your bank account cannot be verified. Please check the test deposit amounts."}]},"bank_account_verify_already_verified":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Your bank account has already been verified."}]},"bank_account_missing_routing":{"errors":[{"error_key":"routing_number","category":"invalid_attribute_value","message":"Routing number is required."}]},"payment_configs_missing_parameter":{"errors":[{"error_key":"base","category":"missing_parameter","message":"At least one parameter must be provided"}]},"payment_configs_invalid_fast_payment_limit":{"errors":[{"error_key":"fast_payment_limit","category":"invalid_attribute_value","message":"Fast payment limit should be a number"}]},"pay_periods_invalid_end_date":{"errors":[{"error_key":"end_date","category":"invalid_parameter","message":"End date cannot be more than 3 months in future"}]},"company_industry_selection_naics_code_required":{"errors":[{"error_key":"naics_code","category":"invalid_attribute_value","message":"Naics code is required."}]},"company_industry_selection_naics_code_invalid":{"errors":[{"error_key":"naics_code","category":"invalid_attribute_value","message":"Naics code must be equal to 6 digits."}]},"company_industry_selection_sics_codes_invalid":{"errors":[{"error_key":"sic_codes","category":"invalid_attribute_value","message":"Sic codes must be equal to 4 digits"}]},"time_off_policy_name_required":{"errors":[{"error_key":"name","category":"invalid_attribute_value","message":"Name is required."}]},"time_off_policy_unlimited_invalid_accrual_rate":{"errors":[{"error_key":"accrual_rate","category":"invalid_operation","message":"Accrual rate must be blank for unlimited policies."}]},"time_off_policy_pending_requests":{"errors":[{"error_key":"time_off_policy","category":"invalid_operation","message":"Cannot deactivate policy with pending time off requests."}]},"time_off_policy_employees_required":{"errors":[{"error_key":"employees","category":"invalid_attribute_value","message":"Employees are required."}]},"time_off_policy_unlimited_balance_update":{"errors":[{"error_key":"base","category":"invalid_attribute_value","message":"Can not adjust balances for unlimited policies."}]},"holiday_pay_policy_already_exists":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Company already has a holiday pay policy."}]},"holiday_pay_policy_not_exists":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Company does not have a holiday pay policy, please create one"}]},"holiday_pay_policy_invalid_employees":{"errors":[{"error_key":"employees","category":"invalid_attribute_value","message":"Invalid employee uuids provided."}]},"onboarded_employee":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Cannot delete onboarded employee"}]},"invalid_attribute":{"errors":[{"error_key":"base","category":"invalid_operation","message":"There is an error in the request body."}]},"company_cannot_enable_contractor_only":{"errors":[{"error_key":"contractor_only","category":"invalid_attribute_value","message":"Contractor only cannot be enabled for existing companies."}]},"company_missing_parameter":{"errors":[{"error_key":"base","category":"missing_parameter","message":"contractor_only is required."}]},"starting_after_uuid_invalid":{"errors":[{"error_key":"starting_after_uuid","category":"invalid_attribute_value","message":"Parameter 'starting_after_uuid' does not correspond to a valid event."}]},"resource_uuid_invalid":{"errors":[{"error_key":"resource_uuid","category":"invalid_attribute_value","message":"Parameter 'resource_uuid' does not correspond to a valid resource."}]},"payroll_gross_up_invalid_net_pay":{"errors":[{"error_key":"net_pay","category":"invalid_attribute_value","message":"Net pay must be a number."}]},"payroll_accruing_hours_invalid":{"errors":[{"error_key":"base","category":"invalid_attribute_value","message":"Hours cannot be negative."}]},"payroll_cannot_cancel":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Payroll cannot be canceled."}]},"frozen_payroll":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This payroll has already been processed. Its data cannot be updated or altered."}]},"frozen_payroll_processing":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This payroll is being processed and cannot be updated at this time."}]},"unmodifiable_payroll_type":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This type of payroll cannot be modified or processed. It is reserved for system processes."}]},"invalid_employee_uuids_format":{"errors":[{"error_key":"employee_uuids","category":"invalid_attribute_value","message":"Parameter employee_uuids must be an array."}]},"maximum_employee_uuids_surpassed":{"errors":[{"error_key":"employee_uuids","category":"invalid_attribute_value","message":"Exceeded maximum of 100 for lookup."}]},"invalid_employee_uuid":{"errors":[{"error_key":"employee_uuids","category":"invalid_attribute_value","message":"Invalid Employee UUID(s).","metadata":{"entities":[{"entity_type":"Employee","entity_uuid":"invalid-uuid-123"}]}}]},"payroll_blocker_missing_bank_info":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must have a bank account in order to run payroll.","metadata":{"key":"missing_bank_info"}}]},"payroll_blocker_missing_employee_setup":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must add employees in order to run payroll.","metadata":{"key":"missing_employee_setup"}}]},"payroll_blocker_missing_federal_tax_setup":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must complete federal tax setup in order to run payroll.","metadata":{"key":"missing_federal_tax_setup"}}]},"payroll_blocker_missing_bank_verification":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company bank account must be verified in order to run payroll.","metadata":{"key":"missing_bank_verification"}}]},"payroll_blocker_suspended":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company is suspended and cannot run payroll.","metadata":{"key":"suspended"}}]},"submission_blocker_missing_selection":{"errors":[{"error_key":"submission_blockers","category":"invalid_attribute_value","message":"Submission blockers selections required"}]},"submission_blocker_invalid_option":{"errors":[{"error_key":"submission_blockers","category":"nested_errors","metadata":{"blocker_type":"fast_ach_threshold_exceeded"},"errors":[{"error_key":"selected_option","category":"invalid_attribute_value","message":"Selection is not available to resolve Fast ACH Threshold Exceeded. Please choose one of Wire In, Move To Four Day"}]}]},"invalid_version":{"errors":[{"error_key":"base","category":"invalid_resource_version","message":"You are attempting to update a resource using an out-of-date version."}]},"signatory_email_required":{"errors":[{"error_key":"email","category":"invalid_attribute_value","message":"Email is required"}]},"signatory_company_already_has_signatory":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Cannot have more than one signatory in a company. Please remove the existing signatory before adding a new one."}]},"mixed_disbursement_errors":{"errors":[{"error_key":"disbursements","category":"nested_errors","metadata":{"contractor_payment_uuid":"invalid-uuid-1"},"errors":[{"error_key":"contractor_payment_uuid","category":"not_found","message":"Disbursement not found."}]},{"error_key":"disbursements","category":"nested_errors","metadata":{"contractor_payment_uuid":"d0dfa222-ad08-4ea7-a06a-717688c3b179"},"errors":[{"error_key":"payment_method","category":"invalid_attribute_value","message":"Payment method must be one of: Direct Deposit, Check."},{"error_key":"payment_status","category":"invalid_attribute_value","message":"Payment status is not valid for payment method 'InvalidMethod'."}]}]},"not_found":{"errors":[{"error_key":"request","category":"not_found","message":"The requested resource was not found."}]},"finish_onboarding_incomplete":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Company is not ready to exit onboarding."}]},"company_location_validation":{"errors":[{"error_key":"street_1","category":"invalid_attribute_value","message":"Must include a street address"},{"error_key":"city","category":"invalid_attribute_value","message":"Must include a city"},{"error_key":"state","category":"invalid_attribute_value","message":"State is in the wrong format"},{"error_key":"zip","category":"invalid_attribute_value","message":"Please enter a valid zip code (e.g. 12345)."},{"error_key":"phone_number","category":"invalid_attribute_value","message":"Phone number must be 10 digits"}]},"conflict":{"errors":[{"error_key":"request","category":"duplicate_operation","message":"A resource with these attributes already exists."}]},"invalid_parameter":{"errors":[{"error_key":"request","category":"invalid_parameter","message":"The provided parameter is invalid or missing."}]},"flow_invalid_entity":{"errors":[{"error_key":"entity_type","category":"invalid_attribute_value","message":"Invalid flow entity"},{"error_key":"entity_uuid","category":"invalid_attribute_value","message":"Invalid flow entity"}]},"flow_nested_options_errors":{"errors":[{"error_key":"options","category":"nested_errors","metadata":{"flow_type":"company_forms"},"errors":[{"error_key":"form_types","category":"invalid_attribute_value","message":"Supplied value 'invalid' contains no permitted values"}]}]},"basic":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must complete all onboarding requirements in order to run payroll.","metadata":{"key":"needs_onboarding"}}]},"contractor_payment_invalid_wage":{"errors":[{"error_key":"wage","category":"invalid_attribute_value","message":"Wage must be greater than or equal to 0."}]},"contractor_payment_cannot_cancel":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Payment has already been processed and cannot be cancelled. Contact support directly."}]},"time_off_request_cannot_delete":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This time off request cannot be deleted."}]},"resource":{"errors":[{"error_key":"first_name","category":"invalid_attribute_value","message":"First name is required"},{"error_key":"date_of_birth","category":"invalid_attribute_value","message":"Date of birth is not a valid date"}]},"nested":{"errors":[{"error_key":"contractor_payments","category":"nested_errors","metadata":{"contractor_uuid":"72ae4617-daa9-4ed7-85e0-18ed5d0ee835"},"errors":[{"error_key":"hours","category":"invalid_attribute_value","message":"Ella Fitzgerald is paid fixed wage and hours cannot be set on a contractor payment"}]},{"error_key":"contractor_payments","category":"nested_errors","metadata":{"contractor_uuid":"2d7bf62c-babf-4a12-8292-340e2d9cab28"},"errors":[{"error_key":"wage","category":"invalid_attribute_value","message":"Isaiah Berlin is paid hourly and wage cannot be set on a contractor payment"}]}]},"compensation_invalid_rate":{"errors":[{"error_key":"rate","category":"invalid_attribute_value","message":"Rate is not a valid number"}]},"compensation_invalid_payment_unit":{"errors":[{"error_key":"payment_unit","category":"invalid_attribute_value","message":"Payment unit must be one of Hour, Week, Month, or Year"}]},"compensation_already_processed":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Compensation has already been processed on payroll."}]}},"title":"Unprocessable-Entity-Error-Object"},"examples":{"Basic":{"value":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must complete all onboarding requirements in order to run payroll.","metadata":{"key":"needs_onboarding"}}]}},"Resource":{"value":{"errors":[{"error_key":"first_name","category":"invalid_attribute_value","message":"First name is required"},{"error_key":"date_of_birth","category":"invalid_attribute_value","message":"Date of birth is not a valid date"}]}},"Nested":{"value":{"errors":[{"error_key":"contractor_payments","category":"nested_errors","metadata":{"contractor_uuid":"72ae4617-daa9-4ed7-85e0-18ed5d0ee835"},"errors":[{"error_key":"hours","category":"invalid_attribute_value","message":"Ella Fitzgerald is paid fixed wage and hours cannot be set on a contractor payment"}]},{"error_key":"contractor_payments","category":"nested_errors","metadata":{"contractor_uuid":"2d7bf62c-babf-4a12-8292-340e2d9cab28"},"errors":[{"error_key":"wage","category":"invalid_attribute_value","message":"Isaiah Berlin is paid hourly and wage cannot be set on a contractor payment"}]}]}}}}}}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-external-payroll-calculate-taxes.api.mdx b/docs/api/get-v-1-external-payroll-calculate-taxes.api.mdx
new file mode 100644
index 000000000..70e0cdabc
--- /dev/null
+++ b/docs/api/get-v-1-external-payroll-calculate-taxes.api.mdx
@@ -0,0 +1,73 @@
+---
+id: get-v-1-external-payroll-calculate-taxes
+title: "Get tax suggestions for an external payroll"
+description: "Get tax suggestions for an external payroll. Earnings and/or benefits"
+sidebar_label: "Get tax suggestions for an external payroll"
+hide_title: true
+hide_table_of_contents: true
+api: eJztXFtz27iS/itY7kMmVaJ8iZM4ftqcXObkIRPXxNnsKSdFQ0RLwoQEGABUrHH5v291AyApipItx36YqZmqqZRFAP2h0egbGrhKLtNZbZ1OpXIwM9xJrVK3rCA5OU+gnIAQIJKvo8TxmcXf3lw6MIoX7JQvjS4Kix91Bb7rO5GcJDNw6eIghdAyrXzLNOdFXhfcQer4JdhklFTc8BIcGBz6KlG8hOQkyXVZcbXM6lqKZJRIlZwkFXfzZJQY+F5LAyI5caaGUWLzOZQ8OblKPObEOiPVLLkeJQJsbmSFqJKT5GwO7NOnd6+ZnjI3BxZoJNejhmzEmwW82cNRj6RYINWF8X/pr7QgL0/fpf8LxuIIAcYcuACzAmTKCwt9cq+RpaVUYImaQJZPuAXBXp6+Yws/KOPW6lxyB4L9kG7Olro21CDnRTFm76ZMaQVMWlYZvZACxMi34VVVyJzW+5Fl56VUsqzL7thff5k7V9mTvT2hczsmCRvnutyLEhVlgr7v8UqmoadUs/8OA6adnx8jjNqCGCeb2T5KQNUlCunh/uHTdP9ZevAUpVPAlNeFS066v19ff+2z7VdwzPFLZuvZDCz+aNlUG8bV2oKN2RtuEKxlXIk9bdgEFEyls1+U4I6zsraOTYBZvgDBKiO1YU570QvbANdAKqaNAPpmwBkJC2A8z2vDHXxRiKbTfPxFfVE21xWcsIu+uNoTA1xckHTYSisLFll0uL+P/6zO9M0lL6sCWGyZjJJcKwfKYdvO+u79YbHD1TrPuTF8iYLpoLTrFFDiDVQGLCjn56qnQ5z0skdLzgsm1VSb0k82GUVaevIH5C4ZJZfpVjXkpCuAphc0T/iYnvHL9GO7qqh5DOosJz2ToKwKvQTwKmdAsG7YzqH7mJjPxQdVLL2OuEbFeZl1JGqAhauDn2pr5aQAEsVC8oksJOJkFgrIaYx1Op116PNsdaaIZmWKpPdJqazPsZ2h45eDk+Olrr3QbOfYq6j6BU3LdxsYEf/DZQYvoAQ5COvAOiXi8OD46Fg8TY+Onk3To2N+nL44erKfPtmfTmAKfCL4UTKwBOctIw7aSSRP9/fH+6SL49fDzteDta9Hna9P6ONXP4EN8Be8qIGo/wUm8jUsxtH+0fr2/k079lbXSrAvirEvym/37zVYXGIDVtcmByY0WKa0Y3AprRuz9/wbMFsbIKGKZsXvJWnZghdSjL8oNKBHh4frZD+pyugcrOW4Qd4oJ92yQSAtK/mSzXlVgWI/5qCIykSLJYoxma6AkaG241JZBsZoY5mt8znjll1IRSAy7pyRk9pBRot2MWKowNtZsimXhWWiBlTdXLU9G1/oYsw+gp/p+RtP5hV3MNNGgt3RQhLMNG+6P2azWgog81RqA0yAQ0DIvB10+c3c/Ye5feb29Wvri50nfsJoinr2xf++xXreOGr2DbBDQLncQINa3aiNP1aQyynalB9zCJuRujONrocds7NlJdENXDKHS/8NlkwKUM73wvbNGu41TjwzEFS8bocc42ZuUO8AjczOsgIULz8SOyPvyQ8VtUeQMjYzuq6iQ8ZyrtD7Qo8R0UxqWQiWoxyUof2cK1FINUMXjKS3EwCR89sQkpZdKFJsmV/HixGB82vFfsiiiCLPOPMt2UVoysIiLb2fA15l+Y/EmhL32wxu5sxpnG+QRsYnunadtUvZDBSYdtXC0JEZtjZTnnuGoCOmBPLHBBSOo986JIo9Sx43t4ECFlw5Rv6u01FAlmEnBxMgFaM9jR4gqY2gkSYFjNlbbViwlaOVIQgfserC/5shqgta2/gLms4Lz/5Ja0zQqdAKPky9cdw6l7IunEQ/mEaUFJKubLz48/pmi1922NKrtK1Us0gZu3EhJH7ixWmHkvftBmh7htwsNb/xEho31XPUzXlXbHJtfBggLHOapKHD4JspfFLyew2tejCkN1t6NKLX3lOjy3bA83ZEVRdF8rVpV1eZ09sbrui5oQbWcQfbmly38cL7IP3pZ+nm6QcFqTd+yfXmVu+D7PimuDTkUP2z5n/5NceRNhrsVT58RuWjVbH0Di6TW83GmL1zlE5pIjzN5nwBrNFDBSygsLh2wYxEQ9GolSSXBiMp84uHm5Lzk34ggXucdGc40CAZCK8mXH3LeJ6j+58JKMBBVqtprQQIzC2UoNyKE3O+4mskmFjqOiYYUvactaRj5pK3tRJSzd6Dm2vB5tyySI011GgNVoAtwMjpMpOKRDdHpJW28l6R/QfdAKTKAlW0nBi9TIARfQlizE4L4BZYPof8m3dS0GMNcEJki6Z90xR4gTHvMosjPugEkL2BIJsAqHYeAwBLaVFDZUbXDrfNZmChRabqckK5gwGIPSd/Bejvvj/z/XFPRLMbcAVJyHKtpnJmG2iNr7kT19Z7d8G8dAyX1DHMdrbObMzgRcdiGFic7ZRbF3dLVshSui0IBxrvzMK3iDiMwWgMZue6LgRi5oGzDeasAiO1aPGCEpkI2nIDyqbJILZhXr5RgtLNnZ1DEZSbc8WesFIrN7foE05rVxvw+GK+XypRW2eWWZPpyhSXuc1yLSBrHbONiNvWu/PzN+zLsO+AON4OYSDz8ACjaML3mhdoRZ4xIWeyUTtb4NoIwN4CrpW5b7s72o8yJ6x2HexRAOuxOllCpqfTrNKFzJcZnoLcbq3LOzGxHFrfPoha0Y4C0ewXnuem5kVmtu+ZlWY7aO6Xvh/Dfg3HJgWqcvSsGjyMAEqwG4BXQMY1C4mUbdax13UXtK/85hbAcycXCNmP4WPcgIEhAaan05jV2YQ55kLtbZa9abz72r+JXRk3cHsJmPCCqxyyurpBX2621ttQveKKMqRc/EHL7qnZ7cs+14UUqNXxfw84uhXkiN6nV/TKK5PGjSCXggUEaIHC4m+GprR7OFhNipk86SFgI1YFl80AyqpWsBFqYx4bMXsQUXzn2zQHRwzDLtvJYRA+rSaaG3TDY7v75F/cw+jws4ZUA8lDWJvMPSI4o9yjtJTsobBUqpUsMCaXexbNuxUZKMwfoRPmDM+dNpmmM6SN2Potd9+mzQA+3mv9G49F0IYlKUfd5/G2Gzbif0g/tjfHATNnHTfkt/OpA0Ox/m28gPVeu/PvtPGrHw2M96jdxm1qgvKULGyUBeB5Ic0iphZvi3+l/U8hXxnpRsyxdRvSUFXJzGhrMd0RiSugYGCbrxNa7O7uAMUIjUcR44IeJPJacEXmuja3cQzvZur+jaN3do6CGXdy0WdQ2OM52sHiHvVNKAboAPAkmu0xNfpPULGe4l41HWZ9Avm1kDwcumFu4Z2zPp3eYvRuh8ATMl44MBvQZmGU7XH7TwGXlk0AlVsDOB619KBSqlFacgAD2FqVWsipJLUdIcds5n2CjSdG1dpiewCekyss94rSglkELW6X1kHZNIo6vO8bkBawmS9YuYWf4Nv/jAJaHand1YpRejLgLPkllk/1cdraVBzn/IBQ31zmAOhFBAy4Egf7+8TVQutvdbWNlw8ILDpcMQagkoNf7ONxsnr21Z7rnPeS7k34kPRy5ZF+in+mB4dPqAqkq9Amhc6/gWmMPyXdsNJpJ+HvjTboDJNEBEd4JQ+4UmdWq6aMrTd9T3sd5/b5NItjwdXVw0yKi9Y1tXebTg/m9jlNQeBRakYVNw83LfQLyQEP9Hz9IdK72xzXYd9CFH1O2BeJ3Ps0V8QwaqyYhf4JuVwBPTxJW1vMReyYYr/NpCQWtYTBu0bwxim0kDxkW09oVlqtLU2Ts9vmmq91v0uqrhmExUE6tYZNDJFsAtxa5Z9Fu3Jc1uNfpBa0MaXQeT7P3NyAnetCZBCMT9I5v+sjoGlBg3V3XkW+oAhQ2mbBZcHDYR56/MUCGOXmX776NzuL4Fi0jJ3zI60tJSPQSH6WBtg7NWLv9QLYmcbiOsNe86WvxGsNZqiHvpPb1IQvi6asfOXsiPJi3DkoKwpinQ4uHeNtPUeNwokuh65dqqcpfQ8DxjBTzhR32mBqj8vidmk9Lou7pPS4LLqBbh9AjLtjdmzObdZ8vf9sij/NbQ48cHEbaozKgwKgRgwMlLji/lJASB60XSYwxcGwTgCZzhT8wEGjoycvQWRC2kltLNBhUntuvWFi3dY77L5ObiGeWw16P1v23qYhVjFol02xrnSFu687oGnXURPPhQeentgXU354eJhysX+cHgF/nvL9Zzx9fvD82fFx/mRy8PzFlknH0Uo67b6L7+8P+Hz/xn56rXHCXks8C2ev/eHziL3CQ+lx0udKRIH1EfWdIhCPwvePqs971OjaV6soHwVv2x/xPxpHHdYu7rZkDeX+biMVG2qOf3Dbl5FkKpW08yxkOdG6YiGBd70eICcdGORjfKdxZzvWEu/lBAvtvZiMhr7JC7POALjsYPdVfI/CI1Ve1AI1uh8IdYsBa9dkJvclSj9Hgwbpj+yrdHY3vdgNWRuyxD+MVjMWou8+jT9ldQcx9yoZFMbaMYv3p6z8oesvMJ6N2cHhk6Onjwe22FwruHM9xCn2jtUQcZMf7K8clGLFQSHzbZmGwc0jal8BDpuOHjtbB4/v3Bxsp7y3TVb5I5xeAH+bRPYgrO11BGfd6wFtTQatvl8XrM32nnLc44X+0SlvoFqubcUNbWx/52wCkozVfH2B6OYI7odAM8lgybwPa2+2+aHh7c0hUQmOdtRSuNHsFkuH36nPnSIQrAkGwegTexT6PGpvEijNKrzS6FxsZaNVmXAr8weOzjmV+UX9Hb1NcjJ2C2EVgLAdOxTCwAH/I/LtRygO3zA7+rwzwz9jWXjUMzM6FjXBZTVtocZ+Y6jW0D1gjp48ic1J8l7O2SPAHD6jyvTcMVtXlTaOCXKOimX/hD+oozgHfwJ673noXvFDB7InKHqnWdvKxaSxLrtbwctb7MtUr+xlTVsJsg/TbCIN3XTekcprOlefMurehMbBglLZhHcASefc7pi2qQW9ixMfnPfnhxyOnh08TwXnL9IjEM/T46ewnx4cg3gq9gGOnzzdotLoNOwOQWlRcPZWuj9nmIoTVPHLUZljuMZww5IMz3unYRbQR6QQsTlqDkwYCHTumVOH4vlk+uwwTyd8Mk2P+MFhenz44jB9crQPh+JFzieHx1s4dTct9M5yyefsX2AKqRo2IV+KJbHoR7i9cjsORZ8alPX+dJP32F63s7lWa2sJa/BGu5LeLbocRNIEl2prfehKsztHa9i7FzEyPIIdsc8A3zDVpNycrt79B/gQ6pg0aXTvPYdKkdA2ba87BvV6pYB/5bZiOljsvnoR91/RUQjXcP/CHsP1KPm9YzdumtDfxIBcj5LfGgty05z/MSX/mJKfMCXXzVMEtgL+DbhdpnTFtPNQTPP0xGoz3CupXoAxUlAEFd8+OAuv3mB/ZZsL/H7eG9/hGTXPBnTe48E1jP36AJsO60CHu60Cbrv3gOODKSGPSW/80Ps9bp6cJHuLg72m4m3vqvt+z/Xe2jsle1cDL+1c7zXUsvg6EJVkBBGpTYHbKFzr5pX0t7pTASVd7V67mvUaSt1bGD9e6vO6+BnZsWHgwTFPDeVwN41Z4WfkkoW8NpR/OL+K9uFljrbqZY0MO//abfURr+N7EzXQtrmBhhDj4zf49wS4GXi3IwyR0lUyxms3x/xBPCcdJR+puOVnKPgRNhCg1JCvbIiGmp4zwteBULTi8VX3KZ5Rgs8V2Q/Tj2AWMofOerRX9+m28x413BNIGv2KlP7GYygbuq7d0IMi1yWdzhGOR5a9CbsoPh1DDxcJnddlfKrmv8IbCtxn28LDTK8jVfY7+Pd4aDPTyRUKVPj6P638IDcqbV3JVWecHZ4Z6k/nqn3a4W/zWlEQPgeXbq8quCQppV15FfTLebKgdHfUMMkoOem9EbY2PLYZftCrr2e+YiG4dUjm6gpdv0+muL7Gn7/XgAbo/CuqREO1a7SjhSSfc8PrW901+uX34C89ZpseINvAgHjtlFpEhZyEO7CrL6ShFrsXSAPSdwdsQ1z35fb+9bLdOPg3f8pskL+ej8PvwDXsbk056vLKdb6tvfmyYrl/fXOWXF//P5Gpzcs=
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Get tax suggestions for an external payroll. Earnings and/or benefits
+data must be saved prior to the calculation in order to retrieve accurate
+tax calculation.
+
+scope: `external_payrolls:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-external-payroll.ParamsDetails.json b/docs/api/get-v-1-external-payroll.ParamsDetails.json
new file mode 100644
index 000000000..849144877
--- /dev/null
+++ b/docs/api/get-v-1-external-payroll.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"company_uuid","in":"path","required":true,"schema":{"type":"string"},"description":"The UUID of the company"},{"name":"external_payroll_id","in":"path","required":true,"schema":{"type":"string"},"description":"The UUID of the external payroll"},{"name":"X-Gusto-API-Version","in":"header","required":false,"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.","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"}}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-external-payroll.RequestSchema.json b/docs/api/get-v-1-external-payroll.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-external-payroll.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-external-payroll.StatusCodes.json b/docs/api/get-v-1-external-payroll.StatusCodes.json
new file mode 100644
index 000000000..e4d1c2f7e
--- /dev/null
+++ b/docs/api/get-v-1-external-payroll.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"Example response","content":{"application/json":{"schema":{"description":"The representation of an external payroll.","type":"object","x-tags":["External Payrolls"],"title":"External-Payroll","properties":{"uuid":{"type":"string","description":"The UUID of the external payroll.","readOnly":true},"company_uuid":{"type":"string","description":"The UUID of the company.","readOnly":true},"check_date":{"type":"string","description":"External payroll's check date.","readOnly":true},"payment_period_start_date":{"type":"string","description":"External payroll's pay period start date.","readOnly":true},"payment_period_end_date":{"type":"string","description":"External payroll's pay period end date.","readOnly":true},"status":{"type":"string","enum":["unprocessed","processed"],"description":"The status of the external payroll. The status will be `unprocessed` when the external payroll is created and transition to `processed` once tax liabilities are entered and finalized. Once in the `processed` status all actions that can edit an external payroll will be disabled.","readOnly":true},"external_payroll_items":{"type":"array","description":"External payroll items for employees","readOnly":true,"items":{"type":"object","properties":{"employee_uuid":{"type":"string"},"earnings":{"type":"array","items":{"type":"object","properties":{"amount":{"type":"string","format":"float"},"hours":{"type":"string","format":"float"},"earning_type":{"type":"string"},"earning_id":{"type":"integer"}}}},"benefits":{"type":"array","items":{"type":"object","properties":{"benefit_id":{"type":"integer"},"company_contribution_amount":{"type":"string","format":"float"},"employee_deduction_amount":{"type":"string","format":"float"}}}},"taxes":{"type":"array","items":{"type":"object","properties":{"tax_id":{"type":"integer"},"amount":{"type":"string","format":"float"}}}}}}},"applicable_earnings":{"type":"array","description":"Applicable earnings based on company provisioning.","readOnly":true,"items":{"type":"object","properties":{"earning_type":{"type":"string"},"earning_id":{"type":"number"},"name":{"type":"string"},"input_type":{"type":"string"},"category":{"type":"string"}}}},"applicable_benefits":{"type":["array","null"],"description":"Applicable benefits based on company provisioning.","readOnly":true,"items":{"type":"object","properties":{"id":{"type":"integer"},"description":{"type":"string"},"active":{"type":"boolean"}}}},"applicable_taxes":{"type":"array","description":"Applicable taxes based on company provisioning.","readOnly":true,"items":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"employer_tax":{"type":"boolean","description":"Some taxes may have an amount withheld from the employee and an amount withheld from the employer, e.g. Social Security. A `true` value indicates this is the employer's amount."},"resident_tax":{"type":"boolean","description":"Some taxes may have different rates or reporting requirements depending on if the employee is a resident or non-resident of the tax jurisdiction."}}}},"metadata":{"type":"object","description":"Stores metadata of the external payroll.","readOnly":true,"properties":{"deletable":{"type":"boolean","description":"Determines if the external payroll can be deleted.","readOnly":true}}}},"x-examples":{"Example":{"uuid":"c5fdae57-5483-4529-9aae-f0edceed92d4","company_uuid":"bcb305b0-2855-4025-8d22-e484a9e6b7c9","check_date":"2022-06-03","payment_period_start_date":"2022-05-15","payment_period_end_date":"2022-05-30","status":"unprocessed","external_payroll_items":[{"employee_uuid":"44f7cba9-7a3d-4f08-b7bd-6fcf5211f8ca","earnings":[{"amount":10000,"hours":0,"earning_type":"CompanyPayType","earning_id":1},{"amount":500,"hours":0,"earning_type":"CompanyEarningType","earning_id":4}],"benefits":[{"benefit_id":22,"company_contribution_amount":100,"employee_deduction_amount":50},{"benefit_id":25,"company_contribution_amount":0,"employee_deduction_amount":300}],"taxes":[{"tax_id":1,"amount":400},{"tax_id":2,"amount":60}]}],"applicable_earnings":[{"earning_type":"CompanyPayType","earning_id":1,"name":"Regular Wages","input_type":"amount","category":"default"},{"earning_type":"CompanyEarningType","earning_id":4,"name":"Cash Tips","input_type":"amount","category":"default"}],"applicable_benefits":[{"id":22,"description":"Kaiser","active":true},{"id":25,"description":"HSA","active":true}],"applicable_taxes":[{"id":1,"name":"Federal Income Tax","employer_tax":false,"resident_tax":false},{"id":2,"name":"Social Security","employer_tax":false,"resident_tax":false}],"metadata":{"deletable":true}}},"required":["uuid"]},"examples":{"Example":{"value":{"uuid":"c5fdae57-5483-4529-9aae-f0edceed92d4","company_uuid":"bcb305b0-2855-4025-8d22-e484a9e6b7c9","check_date":"2022-06-03","payment_period_start_date":"2022-05-15","payment_period_end_date":"2022-05-30","status":"unprocessed","external_payroll_items":[{"employee_uuid":"44f7cba9-7a3d-4f08-b7bd-6fcf5211f8ca","earnings":[{"amount":"10000.0","hours":"0.0","earning_type":"CompanyPayType","earning_id":1},{"amount":"500.0","hours":"0.0","earning_type":"CompanyEarningType","earning_id":4}],"benefits":[{"benefit_id":22,"company_contribution_amount":"100.0","employee_deduction_amount":"50.0"},{"benefit_id":25,"company_contribution_amount":"0.0","employee_deduction_amount":"300.0"}],"taxes":[{"tax_id":1,"amount":"400.0"},{"tax_id":2,"amount":"60.0"}]}],"applicable_earnings":[{"earning_type":"CompanyPayType","earning_id":1,"name":"Regular Wages","input_type":"amount","category":"default"},{"earning_type":"CompanyEarningType","earning_id":4,"name":"Cash Tips","input_type":"amount","category":"default"}],"applicable_benefits":[{"id":22,"description":"Kaiser","active":true},{"id":25,"description":"HSA","active":true}],"applicable_taxes":[{"id":1,"name":"Federal Income Tax","employer_tax":false,"resident_tax":false},{"id":2,"name":"Social Security","employer_tax":false,"resident_tax":false}],"metadata":{"deletable":true}}}}}}},"404":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided UUID is valid.\n"}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-external-payroll.api.mdx b/docs/api/get-v-1-external-payroll.api.mdx
new file mode 100644
index 000000000..49447be42
--- /dev/null
+++ b/docs/api/get-v-1-external-payroll.api.mdx
@@ -0,0 +1,71 @@
+---
+id: get-v-1-external-payroll
+title: "Get an external payroll"
+description: "Get an external payroll for a given company."
+sidebar_label: "Get an external payroll"
+hide_title: true
+hide_table_of_contents: true
+api: eJztWl9v2zgS/yo83kN3ActWHDtN/HTBNtsLFncNmvb2AMdIaHFks5VIlaRc+wx/98NQlC3JchKn7T0c+tRGmv8c/mZG4zVdBrPcWBUIaWGmmRVKBnaVAR2NKaRT4Bw4nXSoZTODz66WFrRkCblhK62SxOBLlUHBes3piM7ABouTADxlkBWUtEMzplkKFjSKWlPJUqAjGqk0Y3J1n+eC0w4Vko5oxuycdqiGL7nQwOnI6hw61ERzSBkdrWlhIzVWCzmjmw7lYCItMrSCjuiHOZCPH6/fEBUTOwfiddBNZ6u2tO/e23f/47SXqkgZiooZ/w7eugO4vLkO/gXaoARvxhwYB10zJGaJgaa6NxjSVEgwThtnFoIpM8DJ5c01WRRCCTNGRYJZ4OSrsHOyUrl2BBFLki65jolUEogwJNNqITjwTkHDsiwRkTvfV4aMUyFFmqdV2ZNf5tZmZtTrcRWZrsuobqTSXplBZQ649z2WicBzCjn7qxcYVB7/imbkBniXHg57h4LMU0zKftgfBuFZcDLEbOQQszyxdFR9vtlMmmF7C5YwuXc4JFaaMDITC5Bl3nTv5J00kcpgRB6aiWNGGhh/cOdkMiUNGDS2H4b4T13n1ZKlWQKkpKQdGilpQVqkrUS698kgw7ri/X6Oacg0GJDWsWC2tfiDIfSBU9NPEFnaocvg0ftshU3AWeuv8M3uCmu87FYUPror23Iwx12Hrgsd4+9ksiru2qZTR4WjVZTn1ip5DtHne7wlT8u9apj6yhDH7i5Zq/SMrVKQ9j4DLRS/N5Zp+3JlGVuRQhJxkp6tFyT/LlpB8sM6jWU2N4/dzFxmWkVgDPAiefz/9y4jHmAh7mCWkArNV5EkZArkoaLggXydg2zlRTiJNDjwY5ITq5k0wl0aq8hDRYSSERDLliQRbCoSgZlOmAYC0oL27LGQLBH/Ad4l5B0yiEJtVZA3lCUJYRFqQnBmlkR4Rbloh57SLS4MmyYF/O1Ffb9wWUirp8C0Zqsnz5k4Nod2kGaJWgGYPXUd2hS+xZA6EpQiDtxXNJtphPs2Q5+pg6UqL4CymW6x0ilDxI8TxSxqm6tct2bmPqk37L6gPGz5fc0x1zCBppvNZtOhU5AQC/sNznkJB5Ts8BDLhRbTHE/1/piIbE+IA8+jI9mdk5Yt4Rs8tGx50LujLHHG+Fo5TeD+kcyqX4HLLQ8peUjRKKltqS+6H9+b7N+/51+IF2WVzNNpEZGiPWzhEzLL7WGxEbMwU3rV8rIZt/2kHW8DJ/Mk2UfpSgBL5h8WwEOpUrOoJQCItotqbKZKJcDkvv+H8vmgz47hf+7wwUzwN1qjIy3+Nh25VWnpQspWZM4WgEWouHpuJphDwkmsVVoUUQ8YruQ9g1B3CHRnXXKLY0ZCbiHKtbCrLrkkDxiIB7JgSY7FkmOT66YVYbA0V4W8Ml5RF13UYATHtublLnIRx6BBWqKdUqWxb1baCjkjfrLCzskQDhlIjo+VJCKuB0EYwkhpDgqRSga7vwtqbBw+5VoYLhzCdn3SpWAZZ5a1JUHDA6s0Wu8Znt8yN7OJQwIWs/YZYasMkKJdn2tbsDFBqa19ifNzGUAx4DgT/LCzGxRoNIw5g+HrYDg4Pw0Gw/5FcMEYBHEIPALgF30+oM3en06j6Wk4nIZB/3w4DAY41J3zfj+AwfmAXcDZ9HV0Qet9PY5+fRz9wlP6aE/uCYc4Iz7SRG/JTkO663sb7e2hxmy81x7RwSB+HU3ZRfCanfJgEIfnwfT1lAdncRQP+ycn8XnEaLVnGu/an5MwDMNthxM2Gxj6WxG9G7b6gA/qleYEPz2UkobPkXNVPG2RNcCZeldExvUmpt9/omk5Qe2PdCXDEG2tiRw+IfJxgadhuJls25jxriM52TUgg9BpLd/0d2/Ows0E2Vsbj3Gz4D9xCiWq0/cwyxOmyZ9s5trvanUvVVeL+vbrBlp59IFt1f7GzJx8ENlxKicH2odxUbzwxOvA8gcTxn3BKotyMcJ48mGT/O+3l03aSVvF9vp2UfwdOGiWkGsZYQX4wJa0WR79l7N6QXEPt/ZsxTUq2DGyJnWwr6CwR8nq17xxgYsTN9S14qarmD8B9PsCKHUI2kVDPPjR4q8XAykdHiHvhwEq+lXoPYyBdIgkRwMrfVrwqVP+JMDSQVha0AKy9KwQ8hNofwLtNwJt0ZEOwsH+t/N/Kkt+V7nk5E4ScieLb+lfcjD4gVCDUbmOgHAFhkhlCSyFsV3yD/YZiMk1uBa53JIU352FwelG8O4dDprYCZsM2GdgZhXMtMqzysZp+6m9ToYxCdQCtBYcg6PBagEL8MAoccIszuQzYLYcXN11yrJRXeFh8Eu+pmlbhn0T29nqpu7Ytyb745krvxB0pcHO6Yj2Fie9AmoEmN66Wqk2vb3VSm/dsqbbYAUBvSj3iLlOcFvmV1AsE8UGKuCQujVUy7yTqkbwC3mBqy3I5xw/ILhV5o1W/BGZGb7GqJgy19FyDySXEZbAyxwDNJ5UqW5x+1N0BS2028EOTSw3ZW7QA6YdHNRt9CKCBBaQEJbbOUjrF044bd+ujIX0WzQUEg4ocB+vYuWk+g2T233iKhGTyG8/a3u7DsXR1LyLb0EvRASV89itGdlU5bbnCHscVeMgHLi/AxW7c0DWprF/QuJQzCri7HhlyJW/L+U6zG05uYrytNyy/cWv7FjkPld6IHtTaiXvIXF0xoEZE4lLKP/2b7v8wWhkytiUyYqcAzvJpunr3dbwB6wx/ZFbWNpeljDhcsPdhbW/xWO6ONm2mcLV01Fjjb8nHmnadu4T7JqMRaHrNX5b+6iTzQYff8kBy+J4ggCjRYHu4zUttyPt6/BqbH5573vtX8mhXwQccLes0o6ihDfa8VhY8xWR4ruY1HLqL7CtLcYbHDH8zwmOi+D/+W8LWuNbxLH9hxnbcO8KI+JlZivv9tb4tWr49uoD3Wz+C2E0Whc=
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Get an external payroll for a given company.
+
+scope: `external_payrolls:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-garnishments-child-support.ParamsDetails.json b/docs/api/get-v-1-garnishments-child-support.ParamsDetails.json
new file mode 100644
index 000000000..49933cebe
--- /dev/null
+++ b/docs/api/get-v-1-garnishments-child-support.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"X-Gusto-API-Version","in":"header","required":false,"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.","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"}}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-garnishments-child-support.RequestSchema.json b/docs/api/get-v-1-garnishments-child-support.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-garnishments-child-support.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-garnishments-child-support.StatusCodes.json b/docs/api/get-v-1-garnishments-child-support.StatusCodes.json
new file mode 100644
index 000000000..91d521f5d
--- /dev/null
+++ b/docs/api/get-v-1-garnishments-child-support.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"Example response","content":{"application/json":{"schema":{"description":"Child Support agency data","type":"object","properties":{"agencies":{"type":"array","description":"State child support agencies","items":{"type":"object","properties":{"state":{"type":"string","description":"Two letter state abbreviation"},"name":{"type":"string","description":"Name of state child support agency"},"manual_payment_required":{"type":"boolean","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. "},"fips_codes":{"type":"array","description":"FIPS codes for state or county child support orders","items":{"type":"object","properties":{"code":{"type":"string","description":"FIPS code for state or county"},"county":{"type":["string","null"],"description":"Name of county in the state for the corresponding FIPS code. When `null` the FIPS code applies state wide."}}}},"required_attributes":{"type":"array","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.","items":{"type":"object","properties":{"key":{"type":"string","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.","enum":["case_number","order_number","remittance_number"]},"label":{"type":"string","description":"A human readable name of the attribute, e.g. CSE Case Number"}}}}}}}},"title":"Child-Support-Data"},"examples":{"Example":{"value":{"agencies":[{"state":"AK","name":"Alaska Child Support Services Division","manual_payment_required":false,"fips_codes":[{"county":null,"code":"0200000"}],"required_attributes":[{"key":"case_number","label":"CSE Case Number"}]},{"state":"OH","name":"Ohio Office of Child Support Enforcement","manual_payment_required":false,"fips_codes":[{"county":null,"code":"39000"}],"required_attributes":[{"key":"case_number","label":"CSE Case Number"},{"key":"order_number","label":"Order Identifier"}]}]}}}}}},"404":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided UUID is valid.\n"}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-garnishments-child-support.api.mdx b/docs/api/get-v-1-garnishments-child-support.api.mdx
new file mode 100644
index 000000000..a3300c20b
--- /dev/null
+++ b/docs/api/get-v-1-garnishments-child-support.api.mdx
@@ -0,0 +1,71 @@
+---
+id: get-v-1-garnishments-child-support
+title: "Get child support garnishment data"
+description: "Agency data and requirements to be used for creating child support garnishments"
+sidebar_label: "Get child support garnishment data"
+hide_title: true
+hide_table_of_contents: true
+api: eJzdWF1v4zYW/St32Ye2gGRn0ukC632pkaRTo+gkqGfaBRwjQ1PXFhuKVPnhxDD834tLUZbs2J0UW+zD5iW2dHl5P845l/SWPeer4LzJpfa4stxLo3O/qZGNZgyrBRYFFixjvK77Jo7NM2bR1UY7dGy0ZZcXF/SvQCesrMmGjdjNM69qhdBasowJoz1qT7a8rpUU0d/wN0cLtsyJEiv+0tNVKVUB01DXxnrgK9RiAwX3nGWsCZeZxW8oPMtYbU2N1ssmsGibPidLbi3fsOxoi6nnHkHEjVx/I1qcMemx6js5s50jLz0z563UqxebfXgyoNB7tBBXAF8sLK5lrAbbZUzz6hVu3vMKwSyTjxOxb8hXxXXg6qHmmwq1f7D4e5AWi577hTEKuX5ZkxqFXEp0IJdgsZLeS72C5Am8AV9i2w7poHUNJngnixjbO8LXACZL8DZg1nwHqYUKBTpYcaulK6M/XpmgvYOlseBL6faeNW1pjVIguBJBxTJlsAgeCoMOtPFQ4EL6uNTYJtYzcfLgTcW9FFypzQDGjqKcYu0J7xYuLy7fZmC02vRja4KamuBLuOLWKKk5TBIjsIBDgE7RrqXAfUGgaUEb0ACoLUtZuwdhildg8/vJ3RSiaQyjabexIKhem6PGG1ug/QuQJb+fh9o+hFMRUDrp097RrPOkg1KkGKfBm5KQOjap8dwgAEEY24hHQbjbxzCAX0vU8Ikcf4qGXXhRVtAlR0+ywAHb7XY7EqwGnQ/ceysXwb+i8tfx2wIdPJVSlEelFtwhyAK1l8sNRdh5Bm6x48MRoil+qRAq4zqRaTDXIoaDk3ql9u4l2gycqRC+wsFqALc/fN2hKygv6wNbN3g9AB5x8/n+j7tk9knCE3VBWORRFvgBmfcpJ4FLiX+grgZryWTNVUiVUtIRjbgDrgF1qP4NvjRhVULQSj6i2mStuTBBFbBA4DScSJn6O7RhNqQVJdcrbLG1DD5YpMrQDgRRauCDDkR8lrHInO5rI3hci73JfJcxxReoXlOvMlRcg0Ve8IVC0AnuUYnaCmYQm3k1vYErwtL7Zp9d+suYl15hOwDzpC/5NU2+XcawGbCxi2nY0sdYqMPhN9uPJjb+kbXzhY0Vd4/8nHpdy7V0lM6fzJAlVw4PxWy23YsBETRLCsMuLi/oj+3mZ7g4S1g8akuqOHtRpfku69K6/aFL67aUBm6XSyliyQ/Tu9FLY0UEyN+U2Df/+lvTylr7Izy2C27pMUz2XKdCzFvAvL14+/L49N54+N4EXcC9BrjXREIKFSPpLDoTrMBuluKzdH4AP/FHBBcsRtDW1qwlMe7jx8k1Tfs1V7IY3GsWgcpXlCp715uZpPkkNHFcTwo2Yiv0+fpN3h+seZTUhySpL3nUnfWA6+KQ3t6QDgSXFHavRIcq3d/tXt9rJ0yNI/jUfz4inn4iaeSWV+hpglLjEqD+k8djSz6+m+S/oE2kkBRgibxIcnEEneNJ4tFWUqOL1Sy4x3zBKfTx3QTWjVPgzhkh45HiSfoSNibYaECnlXiK0kYjVb9tR9bY9E7TXzqYVVLLKlR93/OvSu9rNxoOCyPcIJ77B8JUw/acn6dDVnw/5LXM00qpV18kh3nv8dcUBhWfFLU7uR/rYqu1lxeX3+YX/8zffNucBZY8KM9G/ec74tBz7mrkj8jdJqfy52aN1srItBX6SObE5evmBoDPHrWL95KObGdvNlmrj5+54XQ8PB/R3tfJyCibCn1pEvQjvHzJRmy4fjPsw294TAKHdt1iMFhifds8Xsumd3mBVWzgiUNLZdhhIRt/uaRIaF1UmTOOT/q8s6b4E581vaZ8HYpgJUnkbMuuTFVzvRkLgc6NA6U+m/etpoSaZn6dsN1jiUJsMRbvK8ht5NzRLbFxkStco6JzfkkSKfaXqunGeaz+mx0aD2c22JEiLE30msZ2c9kZ300IKUk3DhCfMVIFd7tMQ7fXj46gfGGCH0bDYUFbk6jm8XtulrEPtPQ42F9RCTowetNcur50cJMAD3fpPkX6UBgRCIUxjX+kSzoX8ZKe9O+63RV+RpUIkjGsuFQRUOntdx1+qBq1cb7iuufnHfrz4txe6A+y2HY/GfzPZ0HChsdnP6wVlxFEkTTbROQZW79hGeuvpvodkHmesdI4T8bbLSn+R6t2O3r8e0BLRJmTjFhJx8RIkKwdKsShQjp6cWas9Mvzfz5hTnajEejT47mV5t6Jirhf+967Fz9CHWj2u5sPbLf7A8uWxIw=
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Agency data and requirements to be used for creating child support garnishments
+
+scope: `garnishments:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-garnishments-garnishment-id.ParamsDetails.json b/docs/api/get-v-1-garnishments-garnishment-id.ParamsDetails.json
new file mode 100644
index 000000000..c790c571b
--- /dev/null
+++ b/docs/api/get-v-1-garnishments-garnishment-id.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"garnishment_id","in":"path","required":true,"schema":{"type":"string"},"description":"The UUID of the garnishment"},{"name":"X-Gusto-API-Version","in":"header","required":false,"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.","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"}}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-garnishments-garnishment-id.RequestSchema.json b/docs/api/get-v-1-garnishments-garnishment-id.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-garnishments-garnishment-id.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-garnishments-garnishment-id.StatusCodes.json b/docs/api/get-v-1-garnishments-garnishment-id.StatusCodes.json
new file mode 100644
index 000000000..9a937d826
--- /dev/null
+++ b/docs/api/get-v-1-garnishments-garnishment-id.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"Example response","content":{"application/json":{"schema":{"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.","type":"object","properties":{"uuid":{"type":"string","description":"The UUID of the garnishment in Gusto.","readOnly":true},"version":{"type":"string","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."},"employee_uuid":{"type":"string","description":"The UUID of the employee to which this garnishment belongs.","readOnly":true},"active":{"type":"boolean","default":true,"description":"Whether or not this garnishment is currently active."},"amount":{"type":"string","format":"float","readOnly":false,"description":"The amount of the garnishment. Either a percentage or a fixed dollar amount. Represented as a float, e.g. \"8.00\"."},"description":{"type":"string","readOnly":false,"description":"The description of the garnishment."},"court_ordered":{"type":"boolean","readOnly":false,"description":"Whether the garnishment is court ordered."},"times":{"type":["integer","null"],"readOnly":false,"default":null,"description":"The number of times to apply the garnishment. Ignored if recurring is true."},"recurring":{"type":"boolean","readOnly":false,"default":false,"description":"Whether the garnishment should recur indefinitely."},"annual_maximum":{"format":"float","readOnly":false,"default":null,"description":"The maximum deduction per annum. A null value indicates no maximum. Represented as a float, e.g. \"200.00\".","type":["string","null"]},"total_amount":{"type":["string","null"],"format":"float","readOnly":false,"default":null,"description":"A maximum total deduction for the lifetime of this garnishment. A null value indicates no maximum."},"pay_period_maximum":{"type":["string","null"],"format":"float","default":null,"description":"The maximum deduction per pay period. A null value indicates no maximum. Represented as a float, e.g. \"16.00\"."},"deduct_as_percentage":{"type":"boolean","readOnly":false,"default":false,"description":"Whether the amount should be treated as a percentage to be deducted per pay period."},"garnishment_type":{"anyOf":[{"type":"string","enum":["child_support","federal_tax_lien","state_tax_lien","student_loan","creditor_garnishment","federal_loan","other_garnishment"]},{"type":"null"}],"description":"The specific type of garnishment for court ordered garnishments."},"child_support":{"description":"Additional child support order details","type":["object","null"],"properties":{"state":{"type":"string","readOnly":false,"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."},"payment_period":{"type":"string","readOnly":false,"enum":["Every week","Every other week","Twice per month","Monthly"],"description":"How often the agency collects the withholding amount. e.g. $500 monthly -> `Monthly`."},"fips_code":{"type":"string","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.","nullable":false,"readOnly":false},"case_number":{"type":["string","null"],"readOnly":false,"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."},"order_number":{"type":["string","null"],"readOnly":false,"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."},"remittance_number":{"type":["string","null"],"readOnly":false,"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."}},"title":"Garnishment-Child-Support"}},"required":["uuid"],"title":"Garnishment"},"examples":{"Example":{"value":{"uuid":"4c7841a2-1363-497e-bc0f-664703c7484f","version":"52b7c567242cb7452e89ba2bc02cb476","employee_uuid":"a6b53294-f871-4db2-bbd4-8c3d1fe56440","active":true,"amount":"8.00","description":"Company loan to employee","court_ordered":false,"times":5,"recurring":false,"annual_maximum":null,"total_amount":null,"pay_period_maximum":"100.00","deduct_as_percentage":true,"garnishment_type":null,"child_support":null}},"Child-Support-Example":{"value":{"uuid":"4c7841a2-1363-497e-bc0f-664703c7481a","version":"52b7c567242cb7452e89ba2bc02cb383","employee_uuid":"a6b53294-f871-4db2-bbd4-8c3d1fe56440","active":true,"amount":"40.00","description":"Child support - AZ28319","court_ordered":true,"times":null,"recurring":true,"annual_maximum":null,"total_amount":null,"pay_period_maximum":"400.00","deduct_as_percentage":true,"garnishment_type":"child_support","child_support":{"state":"AZ","payment_period":"Monthly","case_number":"AZ28319","order_number":null,"remittance_number":null,"fips_code":"04000"}}}}}}},"404":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided UUID is valid.\n"}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-garnishments-garnishment-id.api.mdx b/docs/api/get-v-1-garnishments-garnishment-id.api.mdx
new file mode 100644
index 000000000..df552ee7e
--- /dev/null
+++ b/docs/api/get-v-1-garnishments-garnishment-id.api.mdx
@@ -0,0 +1,71 @@
+---
+id: get-v-1-garnishments-garnishment-id
+title: "Get a garnishment"
+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."
+sidebar_label: "Get a garnishment"
+hide_title: true
+hide_table_of_contents: true
+api: eJztWt1u2zgWfhUud4GZApZjO85PfbHYoM10czHToml3F5MEDiUe2ZxSpIaknAiBgX2Nfb19ksUhKVuynDbTdgeYwfQmCUWd3++c85HqA71PFpV1OhHKwcIwJ7RKXF0CnV1RKFLgHDgdUFaW7S2W3gyoYwuL214xo4RdFqCcXzdgS60sWDp7oJPRCH9wsJkRJb5LZ/T8nhWlBNLspAOaaeVAOdzLylKKzOs5+MniCw/UZksoWF9SW/eAaEOgKKWuAQgHXmXe1gFhBkgu7oETVuhKOYs7SzAZKMcWYONm4CQ3uiBMbcT899//saRk9ZC8W0JNMqZICtvtjNgSMpGLjKiqSMEQnRMnCvAatCKMGMgqY4RakJRZYYekbbIXyKTVZMlWQAp2L4qqaNkeZNTAjKyj0UnJ6qQEIzRHkWCH5IUuCq1IZcGSXBuyaKtA5zNdGZdow8EAR3/CI9ybLYXkxFZlqY1DFSnLPhDH7lHwpS7w5aJkSoAlpdErwYFIzZQlThO3BLGNuSVuyZxXaKBkgpOVYB1jhnRAA7qoTn+CzNEBLY0uwTgR8FJVguPPuMs6DB0d7KT93RLI+/cXL324l9DWQYQirxDSqMsA46+VrOnMmQrWA7oCY0WA1Kc1YOJQYnypURYsH5JLAP/3VXyOOV5UgsPNt0vnSjs7OOA6s0NfYMNMFwdNQWEKjZbSPz8QHIpSO1BZ/cynRKhcm8IXAOZ/qe8w1pVFdcKSXIDkQ7oe0Cbw88+L2qZWnCZ3S5Etg/x2MFOQWi3s3liyzIkVtNSmWktgyuvNWSVd2Lprxj+X4JZYKoYo7fo6hW0iL2sSlHhvQ+3uczOEi85oLjVzHVtzJm3PAgxEkLYHQENyLrx9rNUi0FgWewjXUjITBQzJWygNWFC+H1jchUYMCAwXQ3JNT4ej0TX1DnSM6HvxBKNbK/ssRyW+1Oex1Pcm5xN6mvT06sqGNkKibK/N97qtlivqhwQYOqCqkjKMg566CA7csc/L3VbqNMGZUPczdbFQGjuayFt9VliCsPP2bVafGolo2i+KjF3qSvJgARGKQy6UcCDrAFulKibnsbejHU+B6ydC1JsUiFWCqoohOSP4GlkxWQHag8MULFG6ee2ToJ2MRhG2g01mNzgNicXka8fkfLcsezufVp8fcfhs467X2HIauyVmQ4ocECuhKLr95CnxwDyVrJ6HsdrO1dN9+syclawmQe3XSNz4uN1uUM+c2fm2j33tMohdNFZACsQZYBvbWv3T6Q5x2vEczW2lbB5MfKBM1a9zOrvqN0tQmJ8r6unLPNIXHAXAwTA5d+x+LgWge9YxB92FiqMWpDFIPQ1w4bSZtyxoSYq7NPrc2XKzHmzs8qhY3+xL+4Yh4lYEaLt1eAbW7qo7dAkbesfDHgM+41zgr0z2qBwHQzg4JqRt1fGGeDVI7hIwH63PHE/uThMJzoEhXgxhaWpgJVinWMMjYW2F3RpX9hg+JGcLZESEM8ewpbMVE5KlEgvDv3T76vwdOViND9oRO+hE65acvbloitsDK+DtSe41CDtfganJHcAHOoh/eCw0S+/uRAYe0IVWbkkH9Hv8KWvag8Pf9R3RuYPgAAsOZlpKyJz1a3fCLZdacoxMQzB8af/laDQKCmRNkr+S26jk1ruXi9LOM833Jq6fp+8u3lwS3E6YtToTvmJRdSs/AZjK1Y2dv2LCAjbx3U02dtKDdcEszANV+Gij/gRuX3hXLqMr50i9M/C1+YJZID8ELtKPE9KhbhRSKRYB6Qkx8HMlsJwR9IW2LkTVbqK06Qpx5/as9mVA97n4CmF57bvHBfZJkYvA1uPayy+LhsUz5a8UDQOFcI6p7P+LlLcbNb+h6Hj27rDE2rcoifcyiV76XY19GDN/0LzZ+6Y/kIaLHT9I4iUP/uoJzfZ0T6fZyel0zCbJ+PD4MJk+P4EkzUZ5cnw8PRkdZifT02lOW4d1ejRJT7Kj45PJdJKlJ9OjCZw+T9kkzUaTLJ2eHNPeWZiy4/TocPJ8muSnJ+NkytNJkqZ8mpxmh3ycw9HxdDqi20NsOKg2XNaf2nqt84W/CKn99QcSmkYl7Z26In7i6eiocw6Jz3aPBYE1dil1WNtHTOnYM3T6GMsL7vQpVZC4QylwERPdSX3yRfkbs6fn7/D08Kvnbzram8BOESbk7MfJ6eH4eT9/QVpMX4hZK4NR15clcPp5CewR3h49jASOnv1I+7xnw0125ifdhqI7QRrne300PGgRDzqajkYjug7/BnQ6mvbZ6g/ake90pTi5VoRcK2Qj2F/AYrs0YHVlMiBc+2OPI3AvrBuS79kHILYy4cItXkPycJklLB6YBB9eK9+ukMz61nqB/i7AJatx0m6H7T/mgvdQ8sed8m/rTvlaXSub6RJm5Lb9YIbz/NYXgWEFODDWHyUVKxCuPRQITH7JPIXfzrxQiNvvD112vXur97GbaYrnxaj8X4m/o07O3lwk/4htMlqwBMb9BdrWhr105CV6VAgF4eTAmYMEc8dxvm/urHfJSK0r4zdkTMohuciJ0gpPY5uqGoQ9ra8w31hyVQjlYdSS/QuvuVkpku1N+Z+jwKS1/AzNqCxeLT4e8e3BbDKaHCWj42R8FE5a8c6ivb7GI/l9YktgH4DZOsHwJ3oFxgjfsxaAPRTuHSjrv2shQD5ATWePfxkbNPPwE1/IMN2NqMcs2MjylqC1Bbil5hvTPB5ntEfpHrrwXWPEwKwajFdGIpRiflgpQnoSDoXPUa/pvYRC026sgrzET2N8z+P3EcF7Zb4xmn9EZomP0WWL7Uy42lseSdZZloG1ZxV6f3XT3nWJwAgUc8/eDVzQxAZG/roLmPFltZfTJRJWIAmr3BJPPAH3WN2XtXVQfImGIOERBWss+lx7qQ2lxnhinXUYVAvUA4qFb1/nl2BWIoNWPrY1yFJduQO/8YCjahyLif870bnPA77au9sDmWF/djp8RPvGkvOIcfImVLNvAVxnFULPu/Gn+P2WZZ6AxBb3stFK3oKMNYE0jwnpARWf/m2LH4xGqa0rmGrJeQWOdDr+rtEP24/Hf8zu39vsjrXm4N4dlJIJX5S+CT3E3nhFV2PaocqIs9nOeL8Z0KW2Drc/PGCY3hu5XuPyzxUYbD032IuNCLdOVw+UC4u/PzJ+26D79m2c1M/Ix8b/I87ERabq1jSggzg6dtxY43eXyBB+mZG/c7qwN7QhhPu51ibS2zGNXb50rWe9/4nSGdCvzt/R9fp/3nlvZQ==
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+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.
+
+scope: `garnishments:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-generated-documents-document-type-request-uuid.ParamsDetails.json b/docs/api/get-v-1-generated-documents-document-type-request-uuid.ParamsDetails.json
new file mode 100644
index 000000000..ab22fe5c7
--- /dev/null
+++ b/docs/api/get-v-1-generated-documents-document-type-request-uuid.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"document_type","in":"path","required":true,"schema":{"type":"string","enum":["printable_payroll_checks"]},"description":"The type of document being generated"},{"name":"request_uuid","in":"path","required":true,"schema":{"type":"string"},"description":"The UUID of the request to generate a document. Generate document endpoints return request_uuids to be used with the GET generated document endpoint."},{"name":"X-Gusto-API-Version","in":"header","required":false,"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.","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"}}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-generated-documents-document-type-request-uuid.RequestSchema.json b/docs/api/get-v-1-generated-documents-document-type-request-uuid.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-generated-documents-document-type-request-uuid.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-generated-documents-document-type-request-uuid.StatusCodes.json b/docs/api/get-v-1-generated-documents-document-type-request-uuid.StatusCodes.json
new file mode 100644
index 000000000..a4b901c28
--- /dev/null
+++ b/docs/api/get-v-1-generated-documents-document-type-request-uuid.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"Example response","content":{"application/json":{"schema":{"type":"object","properties":{"request_uuid":{"type":"string","description":"A unique identifier of the Generated Document request"},"status":{"type":"string","description":"Current status of the Generated Document","enum":["pending","started","succeeded","failed"]},"document_urls":{"type":"array","description":"The array of urls to access the documents.","items":{"type":"string"}}},"x-examples":{"example-1":{"status":"succeeded","document_urls":["https://document.url.com"],"request_uuid":"p83d0ca8-7d41-42a9-834y-7d218ef6cb20"}},"title":"Generated-Document"},"examples":{"Example":{"value":{"document_urls":["https://document.url.com"],"request_uuid":"p83d0ca8-7d41-42a9-834y-7d218ef6cb20","status":"succeeded"}}}}}},"404":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided UUID is valid.\n"}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-generated-documents-document-type-request-uuid.api.mdx b/docs/api/get-v-1-generated-documents-document-type-request-uuid.api.mdx
new file mode 100644
index 000000000..72b5467e0
--- /dev/null
+++ b/docs/api/get-v-1-generated-documents-document-type-request-uuid.api.mdx
@@ -0,0 +1,71 @@
+---
+id: get-v-1-generated-documents-document-type-request-uuid
+title: "Get a generated document"
+description: "Get a document given the request_uuid. The response will include the generation request's status and urls to the document. A list of urls is returned as certain document types require several urls."
+sidebar_label: "Get a generated document"
+hide_title: true
+hide_table_of_contents: true
+api: eJzlV1tv2zYU/isc99AWEH1J0zbT04ImC/KwLWjSbUBipLR4bLOhSJUXNYah/z4cSrIlW9m6DgOGLS+hRZ7D79y+c7ihj2wZnDdMag9Ly700mvl1ATS9pZDPQQgQdJZQz5cOv12ABss9CHJmspCD9g63TQG18KWgKV2CZ+WULduz96I9y9rVPV7CLHwK4Px9CFLQhApwmZUF6qEpvQBPOGkFyFKWoIlfAelKjchN/OIKox2Qz1IpInWmgoB4tsEgjW7FnjniPPfBEa4FCVY54k082141IqdESeeJWdT70hELPlgNgnBHMrCeS72Dhra4qF9aIA5KsFxF0dGdvtMuMwWk5MOAP1ILXHygCS245Tl4sOjlDdU8B5rSnrdoQiX6peB+RRPaXCdo6m2AhLpsBTmn6YbW8aPOW6mXNKGgQ46xK6zUns8V3Bd8bY1S99kKsgdHZ9W+79GpqAZdsDVzDlIvydYKWiVboHuB/Bqcgxjev788QwydsGO0Wgyd/BiRNjV3gEGLwkjt2/D1MieGfQ4kOBDks/SreMnF+c3OwkNNo67Rv7GLWDunV5fsF7AOYTe2r4ALsD3rF1w52LfxDEOeSw2uzkDugc05Ijq9uiRlrZRw50wmI6IIdG2CjQcyrtSIXC6INhowTQtrSilAJPUZXhRKZjH9nzlym0st85B3dc+er7wvXDoeC5O5USSDUWbycVv8rMmVuD/mhWSNpNTLbxuFrPP5BcJAn47ol+Tk0eToFZu8ZtNXSCMCFjwoT9Pu96qaoR/rCneo7GgywX99V54/8rxQOy6gCc2M9qA9nu14YvzRocDmEJ2Zf4TMYzVaJDQv6+t6yT1gSx/HKQlafgpApADt5UKCbTP4kDzbjMTsr1npzy94G6xF0YbFntTdrXzQolblPLdYuwl1IcsARFwvuFTI81iDLeUgfXXAcGv5+gAL1mjc2XKlN4RnGTjXo1SH2SA95AP2VVWV0EcGdfzigWbNpjFMjV96iPdg3tJOGtd8EKzCRKazZC+AtDh5KSYZP2FvxPGUHR/x79jJy+M1eyOOpieweJ3NjyYUQXnpFcRO1PiWbX1bJbQLuEk+XJZchbj4xyEmQ66p4l9CjyfHhzXyk/HkBxO0IHeakDt9s6NVEFg5JtgMowaOaOMJPErnR+RH/gDEBVu31JZjanKWjpRcSTG607QOpCuAPwB3a7a0JhRxHmj8t5sZ+geRUJkpwVopoB4gMHsfPWjklLonPsCapk8PLEnr+e7ggmzdyu3j2goM4RsW7OPsKvAUWSoHvzJia0DsgCkdl9PxQO8fb3rtvRpvuklQYXjBlu1EEKzCvtKkEC9kzdVMQB4J+6A0zyA3e26u9bGYYSgXrXxC8aDOK2vEH+gscBv94CALVvp1RP7W5AXX69PICqcBXXI76566Rh6u62jg7JYuEGLbU/D3HLiNPXaPHmsVTEEJivDgV0jDNfVj2V6vnYf879xQa3jiggongIWJWlv6QH9i08WMaeaEXodLKE4B7ufFNdhSZtCJx64h87kJfhwPjgVejS2Kxd/MLGIcUHQf7K+gMpMD8nLE8cyR86Y8yFXd2uM80OZiNOObpnnyLDbPZt45a28l70DFc1jHkHOpYkI1u9/v8ge9URjnc647eurB/nDK2se+2TXw/9djoElHD49+XCguY97GOt00nHJLyylN6IASmtB0/9mQ9rrLLKEr4zwq2Wxw2HxvVVXh508BLNbsDJnNSnwqxAoW0uH6iSG2G6bn75p59wX5oifEE7a2M4ded0iWJg0j981DDvtqgP++98VXeaQX3wrHuOYB8tei9x9/jQw6tnbg8FNu6+fdNIB9o/CdvYOHRW8OuDi/oVX1O3MsIoI=
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Get a document given the request_uuid. The response will include the generation request's status and urls to the document. A list of urls is returned as certain document types require several urls.
+
+scope: `generated_documents:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-home-addresses-home-address-uuid.ParamsDetails.json b/docs/api/get-v-1-home-addresses-home-address-uuid.ParamsDetails.json
new file mode 100644
index 000000000..c9b63097f
--- /dev/null
+++ b/docs/api/get-v-1-home-addresses-home-address-uuid.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"home_address_uuid","in":"path","description":"The UUID of the home address","required":true,"schema":{"type":"string"}},{"name":"X-Gusto-API-Version","in":"header","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"},"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."}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-home-addresses-home-address-uuid.RequestSchema.json b/docs/api/get-v-1-home-addresses-home-address-uuid.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-home-addresses-home-address-uuid.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-home-addresses-home-address-uuid.StatusCodes.json b/docs/api/get-v-1-home-addresses-home-address-uuid.StatusCodes.json
new file mode 100644
index 000000000..551ba8a1e
--- /dev/null
+++ b/docs/api/get-v-1-home-addresses-home-address-uuid.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"successful","content":{"application/json":{"schema":{"type":"object","x-examples":{"success_status":{"uuid":"700af712-62ba-4dff-824f-97a3c6fda416","version":"6c3c23e4cc840bd3f1416f72b5380eff","employee_uuid":"78d20691-f1b4-4f74-bc4c-1d4db0099b00","street_1":"3121 Milky Way","street_2":"","city":"San Francisco","state":"CA","zip":"94107","country":"USA","active":true,"effective_date":"1970-01-01","courtesy_withholding":false}},"properties":{"uuid":{"type":"string","description":"The UUID of the employee address"},"employee_uuid":{"type":"string","description":"The UUID of the employee"},"effective_date":{"type":"string","format":"date","description":"The date the employee started living at the address."},"courtesy_withholding":{"type":"boolean","description":"Determines if home taxes should be withheld and paid for employee."},"street_1":{"type":"string","readOnly":false},"street_2":{"type":["string","null"],"readOnly":false},"city":{"type":"string","readOnly":false},"state":{"type":"string","readOnly":false},"zip":{"type":"string","readOnly":false},"country":{"type":"string","readOnly":false,"default":"USA"},"active":{"type":"boolean","description":"The status of the location. Inactive locations have been deleted, but may still have historical data associated with them.","readOnly":true},"version":{"type":"string","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."}},"required":["uuid","version"],"title":"Employee-Address"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided ID/UUID is valid.","type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["error_key","category"],"properties":{"error_key":{"type":"string","description":"Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error."},"category":{"type":"string","description":"Specifies the type of error. The category provides error groupings and can be used to build custom error handling in your integration."},"message":{"type":"string","description":"Provides details about the error - generally this message can be surfaced to an end user."}}}}},"x-examples":{"not_found":{"errors":[{"error_key":"request","category":"not_found","message":"The requested resource was not found."}]}},"title":"Not-Found-Error-Object"}}}}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-home-addresses-home-address-uuid.api.mdx b/docs/api/get-v-1-home-addresses-home-address-uuid.api.mdx
new file mode 100644
index 000000000..2f522a5b9
--- /dev/null
+++ b/docs/api/get-v-1-home-addresses-home-address-uuid.api.mdx
@@ -0,0 +1,73 @@
+---
+id: get-v-1-home-addresses-home-address-uuid
+title: "Get an employee's home address"
+description: "The home address of an employee is used to determine certain tax information about them. Addresses are geocoded on create and update to ensure validity."
+sidebar_label: "Get an employee's home address"
+hide_title: true
+hide_table_of_contents: true
+api: eJzlWFtz2zYW/itY7EOaGVI3K3bMp/U0adYPbTx1su2M4nEh4FBCDQIsLrK1Gv73nQOQEmVJddJ9232yTJ775TvncENNDZZ5afS1oAVdgM9X43xpKrhnQlhwDtzev/chSEEzKsBxK2vkpAX9tASCVKSlIqYkTBOoamXWAEQ6EhwI4g0R4MFWUgPhYD2Tmnj2RKQuja2iIYTNTfDEL6EakKvOCMIskAUYbgQIYjThFpgHwrQgoRb40xsC2gULZMWUFNKvB1/0F30b6tpY7/YNhLIE7uUKiGBe6kUUxE2wHtyaPEq/XBolpF5EGY6bGgryW+eQKyww8RvNqGcLR4sZfd+5urWY3mX0KV8E500utYdFinPu1zUgB1RzEAIwmKyu+ySRtWaWVRgrFL+hmlVAC3osFRIzUDO/PJqWz5+v32E6/LMU0Yxa+CNIC4IW3gbIqONLqBgtNjTZSJ23Ui9o02RbA37NP0SPrm6u83+BdaioNWEJTIClp+VkFHSo0PfJaPImH53n4zfoqoCSBeVp0X/ePHfmXVc4LvqCKc/nDKvq6uaarJIthDlnuGQeREwiWZtgIwFnSg3IdUm00bEga2tWUoDIEg2rayV5jP8rR2aV1LIKVV/23XdL72tXDIfCcDeImR1wUw27TOY1W1ujVHw/ZLXMW06pF39vBea9x6+7vhjQ5i6jDniw0q9jvr83Vc30+opzcO4q+CUtZndNr6Sse2SLLnMWXG00Fl2xoZPRCP/sR8+FKKkMimaUG+1Be6TquT383SHp5jB/Zv47cE9ROTyxqlZJUSvz3nnmQ3wSK7KgF6MRKy/Gk/x8Mmf5VJRl/nYyLfPLC3bGz0vBpuNzmtE2DLSg5/yMT85gyvnb6WguzsrxdHxeXkzmb87ejqAssXTaBrvvdLwVk9H55Tgvx/NpPi0vpvmcT3k+FlMxH40uL+ejEdaitwD+fkwLejaejMmPUj2syS9svXs3oQXFoMTQ01umyQ+WaS4dN5GIeYzB91c0o/+WNS3o5XQ8uohhDNpbZPp8i29ZBJQuJ1uEuRdJwvjyYpSPxvlonHgj1Nz3oIYWJVMOmiajtUVg9hJ6YT1spz/v9i36dh3fHETxr4qMop75dygrQTotaCQ4Jjvhdt9W55nF5lVyFVE5DoLOgwHqPR65rfa5MQqYPlDXgw9ZJiT07AkccUsTlCBzSKgPSsRZUDMpSGns1rSofFdOh+7iSPio1bpLY7/AOurZjlwHpRD9DtlSJX6dghOhPySNpfs1hNuqfpG4j9zYAc2uBV5MB2Y/4UZXW8okGBqQa53EbB85smQrIHMATQQo8Ija8+BJxdbEealUIlhK542VnCmsLHYwDOJOsecHtmrTQ6KvaQgerAXttyOntT+B5IDcQirp2Q78ySJIAd84P6SAqjYeNF+/joXY35GMJkvziCtPcKhOOlJKUDhJmv5gn9F2Seg8vMuol16hi93Kkl91+NAg83Q0PRwfPxlPfjBBi2+ZHidEkC+akC8aQ4mGgsP8WHAmWA5EGHBEG0/gSTo/ID+yByBxq8OgdkObXL8bRmCSLm17mNbn06ofBrDW2LRY7UFr+3yXeGZtHA7SQ+WOzcADqfcPgAyceVgYuz6hI1K9WF+3NXBZSnDkcQmtz5GdGM6DdQPyaV1jgat1yvoDrIkUoH3iimDpvZXz4GG43SGJBRXbwJudyISmndXfYBpKQFqs/CSJxL5oRXVJcq3lC2tCLfXCpR2bacTa7hyYB6kE4dgLVUu/ZFoo7Bqp02rWW42jzRU4xxZHcW/f5JvOEAGeSeV2p0WrKicL0GB34WxFd1a6YEvGk6V4z+Cx4QAjl3plfx/Sxt+XsUl6hTXbyz9tK75fL0WPseccPdEgjyz1R2TAzREN6Xr6J+Pz2GT5e1Saf0xVuzXX1cAegLl1HrNCi+1GsLtb9ulw78/NCqyVAqID3kpYwT9N1fHgdvbkQbt4u6DHydeT109GV0yFl68gvDv2RaWtd8uf4HtH9Ny9LeERN4/z7bu74z/mNq7jFfilaU9nmqUzrKDD1Xi4f0QPNwenW4PbJdhVd+IFq/CKamcEq2UaEbmAKs6JIytNZZ5lK8nL44aMfNHLE4KPyryxRvyJzBpf94+VW0T7VP5HTpZtg6Ly7jKMawEwG2/Ffe2tiFzBChRhwS8R2dKAwc6/XTsP1X+jIUk4oaDBS7Y0UWrbUPHaxStw717p3akZxb3SfSxvwa4kh16kdxM+4s4wEg4FqsbxkMf/c1PGCCPrc2N/AcXjompItOOVI+/bfiE3aVeIB6owPFSgfXTjb+2IZjyO6PZuf9dpJT/jKIj9hecAkyqWSvv2H7vKiGeIcb5iuifnA/j+l51X7vlHhT0PNrtl4f/5G1GqUA9PflgrJmMpx6bctIAxoys8Cvchg2a0OPzec4dkziPPZoPfPz5b1TT4+I8AOE1md4haVrI5FvBsQ4V0+Fv0tvYTKfru53a3eU1e+HR01KVug9LrHnDSrEXZQ1eauybrvhp9m6H/09+CTkQ3RfH497dtsHdDDUGy9r13B7v63vj68P4TjuB9TN1iaPsDk3Q0yZtNovhkHkA3zTbnHv+PK0rzHymM2l8=
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+The home address of an employee is used to determine certain tax information about them. Addresses are geocoded on create and update to ensure validity.
+
+Supports home address effective dating and courtesy withholding.
+
+scope: `employees:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-jobs-job-id-compensations.ParamsDetails.json b/docs/api/get-v-1-jobs-job-id-compensations.ParamsDetails.json
new file mode 100644
index 000000000..12553ada8
--- /dev/null
+++ b/docs/api/get-v-1-jobs-job-id-compensations.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"X-Gusto-API-Version","in":"header","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"},"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."},{"name":"job_id","in":"path","description":"The UUID of the job","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","required":false,"description":"The page that is requested. When unspecified, will load all objects unless endpoint forces pagination.","schema":{"type":"integer"}},{"name":"per","in":"query","required":false,"description":"Number of objects per page. For majority of endpoints will default to 25","schema":{"type":"integer"}},{"in":"query","name":"include","required":false,"description":"Available options:\n- all_compensations: Include all effective dated compensations for each job instead of only the current compensation\n","schema":{"type":"string","enum":["all_compensations"]}}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-jobs-job-id-compensations.RequestSchema.json b/docs/api/get-v-1-jobs-job-id-compensations.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-jobs-job-id-compensations.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-jobs-job-id-compensations.StatusCodes.json b/docs/api/get-v-1-jobs-job-id-compensations.StatusCodes.json
new file mode 100644
index 000000000..4bfae90e9
--- /dev/null
+++ b/docs/api/get-v-1-jobs-job-id-compensations.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","description":"The representation of compensation in Gusto.","properties":{"uuid":{"type":"string","description":"The UUID of the compensation in Gusto.","readOnly":true},"version":{"type":"string","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."},"job_uuid":{"type":"string","description":"The UUID of the job to which the compensation belongs.","readOnly":true},"employee_uuid":{"type":"string","description":"The UUID of the employee to which the compensation belongs.","readOnly":true},"rate":{"type":"string","readOnly":false,"description":"The dollar amount paid per payment unit."},"payment_unit":{"type":"string","readOnly":false,"description":"The unit accompanying the compensation rate. If the employee is an owner, rate should be 'Paycheck'.","enum":["Hour","Week","Month","Year","Paycheck"]},"flsa_status":{"type":"string","enum":["Exempt","Salaried Nonexempt","Nonexempt","Owner","Commission Only Exempt","Commission Only Nonexempt"],"description":"The FLSA status for this compensation. Salaried ('Exempt') employees are paid a fixed salary every pay period. Salaried with overtime ('Salaried Nonexempt') employees are paid a fixed salary every pay period, and receive overtime pay when applicable. Hourly ('Nonexempt') employees are paid for the hours they work, and receive overtime pay when applicable. Commissioned employees ('Commission Only Exempt') earn wages based only on commission. Commissioned with overtime ('Commission Only Nonexempt') earn wages based on commission, and receive overtime pay when applicable. Owners ('Owner') are employees that own at least twenty percent of the company. ","title":"Flsa-Status-Type"},"effective_date":{"type":"string","readOnly":false,"description":"The effective date for this compensation. For the first compensation, this defaults to the job's hire date."},"title":{"type":"string","description":"The job title for this compensation."},"adjust_for_minimum_wage":{"type":"boolean","description":"Indicates if the compensation could be adjusted to minimum wage during payroll calculation.","readOnly":true},"minimum_wages":{"type":"array","readOnly":false,"description":"The minimum wages associated with the compensation.","items":{"type":"object","properties":{"uuid":{"type":"string","description":"The UUID of the minimum wage."},"wage":{"type":"string","description":"The wage amount."},"effective_date":{"type":"string","description":"The effective date of the minimum wage."}}}}},"required":["uuid"],"x-examples":{"success_status":{"uuid":"db4d41e5-813c-477e-bfae-38da2ae5e7a3","version":"56d00c178bc7393b2a206ed6a86afcb4","job_uuid":"c1fdb417-c34a-43a7-92f3-5e6c20c1d7a4","employee_uuid":"a7e8f9bc-0d12-4e56-b789-012345678901","rate":"70000.00","payment_unit":"Year","flsa_status":"Exempt","effective_date":"2023-01-01","adjust_for_minimum_wage":false,"minimum_wages":[],"title":"Software Engineer"},"hourly_compensation":{"uuid":"e5f6a7b8-c9d0-1234-e5f6-a7b8c9d01234","version":"98b7a6c5d4e3f2a1b0c9d8e7f6a5b4c3","job_uuid":"d2e5f8a1-b4c7-4d90-a3e6-f9b2c5d8e1a4","employee_uuid":"b8f9a0bc-1e23-4f67-c890-123456789012","rate":"25.00","payment_unit":"Hour","flsa_status":"Nonexempt","effective_date":"2023-01-01","adjust_for_minimum_wage":false,"minimum_wages":[],"title":"Associate"},"minimum_wage_adjusted":{"uuid":"a4d9ba9c-32cc-4cc1-a5bc-6ef4cd653e7a","version":"cc59bd3879d655fb940a1f6b675f2ad9","job_uuid":"d8f8fbe7-496d-4b69-86f0-1e2d1b73a086","rate":"5.00","payment_unit":"Hour","flsa_status":"Nonexempt","effective_date":"2018-12-11","adjust_for_minimum_wage":true,"minimum_wages":[{"uuid":"edeea5af-ecd6-4b1c-b5de-5cff2d302738","wage":"7.25","effective_date":"2018-12-11"}]}},"title":"Compensation"}}}}},"404":{"description":"Not Found\n\nThe requested resource does not exist. Make sure the provided UUID is valid.\n","content":{"application/json":{"schema":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided ID/UUID is valid.","type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["error_key","category"],"properties":{"error_key":{"type":"string","description":"Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error."},"category":{"type":"string","description":"Specifies the type of error. The category provides error groupings and can be used to build custom error handling in your integration."},"message":{"type":"string","description":"Provides details about the error - generally this message can be surfaced to an end user."}}}}},"x-examples":{"not_found":{"errors":[{"error_key":"request","category":"not_found","message":"The requested resource was not found."}]}},"title":"Not-Found-Error-Object"}}}}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-jobs-job-id-compensations.api.mdx b/docs/api/get-v-1-jobs-job-id-compensations.api.mdx
new file mode 100644
index 000000000..3ad7336e6
--- /dev/null
+++ b/docs/api/get-v-1-jobs-job-id-compensations.api.mdx
@@ -0,0 +1,76 @@
+---
+id: get-v-1-jobs-job-id-compensations
+title: "Get compensations for a job"
+description: "Compensations contain information on how much is paid out for a job. Jobs may have many compensations, but only one that is active. The current compensation is the one with the most recent `effective_date`."
+sidebar_label: "Get compensations for a job"
+hide_title: true
+hide_table_of_contents: true
+api: eJztGmtz27jxr6DoByc3gqz3w5/qXpKrO70kc0567TgeGwSWEmIS4AGgHI1H/72zACmRsuzYubtOp3P5EpNc7PuFXd1RB6K0yq/pycUd/d7kBdfrUyHAudPSL+nJxeXmskMlOGFV4ZXR9CSAgXYcHx0RRnuuNFE6NTYPL4nRZGluSV6KJVGOFFxJYkpPUmMJJ59N0iV/N4kjOV+TJV8BybleE9HE2yFJ6YnR2ZoYDcQvuUdUXHi1gi75sAQiSmtB+9Y5hPFLCGdulV+Gh9w4TywIBL6GNIWA5EpyD9fdT/qT/u6t8XBCvo8Is3U4dfr+jEgDjmjjiSuLwlhPhAXulV6QvMy8KjJoc00KsCgfYTtI3mZwy5XjOSDsVVkqSbgjXBu/BEtuVZaRlKsswnJiIYMV156AtcZ2v0OWPzog12nm+JXz3JfumnhDJHiwudJAVEq4JpAXmVkDoFYgUwuVZBCMYFZgvcrhk/7rmkhIeZn5rdAWfGm1i8r3DymakdJB+HyttMhKCdek4JbnyAMyE9EQnmVtHQWNO2EKOCHXrS8nFri8ph36hS1K5w1T2sPCho/MrwugJxcU8gSkBEk7lBdFE8TRyw7dsuCCS2ueAz2h/2I/BISn78/YP8E6dOQOVejNS+ASLO1QJ5aQc3pyRyMp6rxVekE7FHSZI+lBbzBmvQnrj2kIiqA2etJ8v9kPlle1SaJfos+xhDuQQdWryAvhzhmhuAcZbb42pQ0AgmdZl5ylRKNHYyxZs1ISZCfC8KLIlAjiHzlykSut8jJv4r58sfS+cCfHx9II1w2K7QqTH9eKZAVfW5Nl4fsxLxSrTiq9+HOFkDVev0Q2SgeySzedrYbRkZWslVpwv6T7qsCY/fjx7BUxadDFZ5PQDrXwS6ksSHribQkPm2HTIFbwBdSkfinBrlt4Up45OEQcj20zCcKD8yC75OclaFJqV4BQqULdhhDMDJfBfU3yGYR3pNQZOEdAy8IoHdKZAExvC6WDCbqH3Ch4KNi2AMHjnsP/2zJPwKLqam4w1aBEXfLGWJLzzwYTOULUDLooxza+DRmMv8phi6mK3SrAv87l6YqrjGOWMUUM6U+aoQ6v2oFOziLGoN5tRg7RIfcyKqYr4GIZ0qrSzgOXQQ2PZadP+kkBfY8xernBelfnH+tu+aJ2TAuuMNqBQ4yDXg//a0t/XobKmZYZ7VCsi6A9QjWC9PizQ9C7+8xxazmqXHnIXeN9NPfBYLJQWHCgfVV1071SqEnIeuiVhTUFpvzIPVacQ3p5PF4fRI5p+53O1lFTmw6tMsXTSNT2q3NhRS3K3SXnEKvMxS4rkUWpJDwzsSkJeWE8aLF+GZzqQMPiTVXUlCOpgiykOFrX6OdrDF3WG3K7VGJ5X4UJZEYv3EEN1pX7GwlvC/+3UbfcwyGiO8AHc6w0WcYt4bkptY+dX0xU6xyNXGrlg1KrF1f44htJ4VHChYhdK/rFPSFRkFA+W0rBPlITc6vBdgIIcUtTZpIkQI7e87VYgrg56jYSxd9MiQn7Z4Ab2qE/Gh3K27+B49v6BL3cdGijJXss87z+AnmBUX3OM24VSPLWaKhfNv9+h2zSDnbduXIhQlAvZIth/8Pu8L3OHbX25h/npyQyGMIgOHtTaV2y5enFUaRy9HKrPEe4hWhXTlL1BSRxCL4msAK7RkOjwZWRDTyhp6l7TvLi6L7Q30ShQ7iWobHH4rHFjwC3WNKrvJtk0CVowWxNXhx9hWRUCZClKW1o2dbk1tib55DaGQRkg8SLo8MmRD641eSWL8CR2BtW9x60S3ViD+2+Rh90gsPYG4ifI1nwRZQk/HH0MqhtJ2ForcytJtyTDLjzxN+C9sFc4fLVKCRcr7uEdqhXPsMIeZM5zs6DW7IPGDSYBFtXtW/MEu3u4iGXf1OZPVXWtVuJTgSvmiiHGbVK7UeOLJWNeENOq2R5SrIOlQHBH2AI0XH5uXT+KjX2qmrDr9CKDQKJMRlwfY/CmZbYb4DDe+C9pCjqXBcJgESZ6psDUiCyRMZJVT/xEiLKbNvh3isXTe7cgZbmCVZqknf3rkP7InQf65N+i1anyU6wxZ7iH0ETFBjLX/dpTvxVnz3MFP5rNuQXUdbQvsIXnhdZ1ICLXWmjKEWdUJmM5KgPYzbrDwUbTafAkpQDG84kH3AYw5QPaaOZo+OJ7PVEfzpLxHQ4HyYDPuhNQE74bMJTkYxos1eiop/KZNSfMjEccTYa8imbD9IhG8NEDHqiL6ccT+x1OpRPYZbOE8F6sj9gIxhPWDKdzVmvPxiOxpPpbN7r07pFodNer9fr9np0v6Ooi3OrHu/K7r5V8A4/ZL0+C8gfjLzKf/cc/uJyl8fOTepvMS2+1gulAW9VHboMxad11WjYAcbphE+TGRNz2WMoJsNXDN/hK3zTssN8lkz5RIzlCIbpgPeTnpjLGUzTCR8nIzFs20EOYJzOeJ8lIzFlIznvMT6ECUvnyUCM5Qz6B+2QzNI57yWC9WEwZKN0MmViNo/8VWYY7OwwGB80QtU3tY3Q7G5+Nzuc1imE7iWoqzrrNSzAR3Ke8Llgw4EQbCREn/FxItgE0pGQk/EQprxlASHG80QOZ9O5nIzHaTIf9Xg/nSST6TgdcDnfs8AsnaUJTNloPpFslEzmbDZJe6hZ2U+mQ96bTXaq/O002Z+x/oD1H9VkvNvuK3LnmxKAj3nKQMgJGyV9wZKxBDYWaTqQw95gOpzROj3SaTcMGB5jZXO52VXK1ii5zmij3uj+1fqt8eSNKbXE4WG8+1bjG2LBmdIK2A1r4Ytyvkt+5DdAXGnj/bEenMU8rxxZ8UzJbpgUPPmu/gBT5JMm5NfydfbquM0adkd7ta2Z7cMwOM48WxWvev+MycI9rFc3gAewhVgYu36ARoD6aj07r6ZqDtvJSuZwnBghSuu65MO6UDjnXMc+6AbWREnQPp5CeO69VUnp4Xg3YbaQ8ap32aIMBXfL9TNYQwwIG6ZnAVPcMFSoaiO5ivOFNWWh9MKF3llwvE2HkShyk5Qqk0TgOCKv4Jdcyww7KqXj2LYxtQ485+DckzqM9zUjEjxXmSM8wcXKTqmMLECD3amzQl1z6UqbchE5xQ2Blsi43fYT7d5BG8wZpZZNx7po2Z9WHt/0l5PGwYZw9IEAueUxPsKB7l6KeGs8C0HGXiNR9i56bcUuOmVQ4xlmqwV4tuqzzyZxLA6kWXu816GeL1AEGvZPaL3v2/M/1IArgN8Ad2uG80+GdyKrJEQC3+8hbIIHv4jDcHeq5T4ofPGgXXhAJUb1Pbjr6NAVz8qv7zxwaNtGFceW2/OxS98BPSTe9sB9MQ8fj+Lujh0UG+epOfilqQwUShuuFunxqn+MR47voq02x/vGcmBX9SantBlua6qRHy9UnPgxCXkY+90LlVeQmz37RHwsFmX8jHI9gPggzvfWyEdwFvgZBa7XqudYOWIoHViuboMdidcD63CvA27D0Of+4pXrNctgBRnhpV9ilhRV9ezQ87XzkP8aChHDAwQ2uLFITcBaBWcYAeO2qdUdNfZhHYrrL/cuPQe7UgIamt4NbEMOOw6AxxJJY1Sz8MxMGjSMR/eZ/RkyYfIw4wx8HDnyugoU8r66usYlrijzekr+p6rccxHKfbXgeFVTJT9BtovXnKssuEr19S87z0BtFMb5nOsGnh/AH1hf8GrV1WL/btd1/LFR/2Oj/jtv1Ks04OGLPy4yrkK+CJnvrkrHF3TVj9cWdP2T7T5X7NfHpXEewe/ucJr40WabDb6OK0PM1FI5HBc+sCNs+v1/bSl7UPxY0Kpdcl3DQkl4ugS/4Vr2MR5Dqv5GFv+ndrKPCLlbMu8EvcQHq5D7Z7rWi5+qS81Lcvh3Bwc5qW9Met1ko+awiokN7nmqn408j6n/6x+DPGrcwz/AaXl0BMTuJcwz6m/3LuSthvKH1x+wKW43O9vmpvoDjXTQsnd3EeKDuQG92WwN7fE53EM2/wEGNa1B
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Compensations contain information on how much is paid out for a job. Jobs may have many compensations, but only one that is active. The current compensation is the one with the most recent `effective_date`.
+
+*Note: Currently the API does not support creating multiple compensations per job - creating a compensation with the same job_uuid as another will fail with a relevant error.*
+
+Use `flsa_status` to determine if an employee is eligible for overtime
+By default the API returns only the current compensation - use the `include` parameter to return all compensations.
+
+scope: `compensations:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-jobs-job-id.ParamsDetails.json b/docs/api/get-v-1-jobs-job-id.ParamsDetails.json
new file mode 100644
index 000000000..35522eb5f
--- /dev/null
+++ b/docs/api/get-v-1-jobs-job-id.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"schema":{"type":"string"},"name":"job_id","in":"path","required":true,"description":"The UUID of the job"},{"in":"query","name":"include","schema":{"type":"string","enum":["all_compensations"]},"description":"Available options:\n- all_compensations: Include all effective dated compensations for the job instead of only the current compensation"},{"name":"X-Gusto-API-Version","in":"header","required":false,"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.","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"}}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-jobs-job-id.RequestSchema.json b/docs/api/get-v-1-jobs-job-id.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-jobs-job-id.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-jobs-job-id.StatusCodes.json b/docs/api/get-v-1-jobs-job-id.StatusCodes.json
new file mode 100644
index 000000000..36daf4771
--- /dev/null
+++ b/docs/api/get-v-1-jobs-job-id.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"Example response","content":{"application/json":{"schema":{"title":"Job","type":"object","properties":{"uuid":{"type":"string","description":"The UUID of the job.","readOnly":true},"version":{"type":"string","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."},"employee_uuid":{"type":"string","description":"The UUID of the employee to which the job belongs.","readOnly":true},"hire_date":{"type":"string","readOnly":false,"description":"The date when the employee was hired or rehired for the job."},"title":{"type":["string","null"],"readOnly":false,"default":null,"description":"The title for the job."},"primary":{"type":"boolean","description":"Whether this is the employee's primary job. The value will be set to true unless an existing job exists for the employee.","readOnly":true},"rate":{"type":"string","description":"The current compensation rate of the job.","readOnly":true},"payment_unit":{"type":["string","null"],"description":"The payment unit of the current compensation for the job.","readOnly":true},"current_compensation_uuid":{"type":"string","description":"The UUID of the current compensation of the job.","readOnly":true},"two_percent_shareholder":{"type":"boolean","description":"Whether the employee owns at least 2% of the company.","readOnly":false},"state_wc_covered":{"type":["boolean","null"],"description":"Whether this job is eligible for workers' compensation coverage in the state of Washington (WA).","readOnly":false},"state_wc_class_code":{"type":["string","null"],"description":"The risk class code for workers' compensation in Washington state. Please 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.","readOnly":false},"compensations":{"type":"array","items":{"type":"object","description":"The representation of compensation in Gusto.","properties":{"uuid":{"type":"string","description":"The UUID of the compensation in Gusto.","readOnly":true},"version":{"type":"string","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."},"job_uuid":{"type":"string","description":"The UUID of the job to which the compensation belongs.","readOnly":true},"employee_uuid":{"type":"string","description":"The UUID of the employee to which the compensation belongs.","readOnly":true},"rate":{"type":"string","readOnly":false,"description":"The dollar amount paid per payment unit."},"payment_unit":{"type":"string","readOnly":false,"description":"The unit accompanying the compensation rate. If the employee is an owner, rate should be 'Paycheck'.","enum":["Hour","Week","Month","Year","Paycheck"]},"flsa_status":{"type":"string","enum":["Exempt","Salaried Nonexempt","Nonexempt","Owner","Commission Only Exempt","Commission Only Nonexempt"],"description":"The FLSA status for this compensation. Salaried ('Exempt') employees are paid a fixed salary every pay period. Salaried with overtime ('Salaried Nonexempt') employees are paid a fixed salary every pay period, and receive overtime pay when applicable. Hourly ('Nonexempt') employees are paid for the hours they work, and receive overtime pay when applicable. Commissioned employees ('Commission Only Exempt') earn wages based only on commission. Commissioned with overtime ('Commission Only Nonexempt') earn wages based on commission, and receive overtime pay when applicable. Owners ('Owner') are employees that own at least twenty percent of the company. ","title":"Flsa-Status-Type"},"effective_date":{"type":"string","readOnly":false,"description":"The effective date for this compensation. For the first compensation, this defaults to the job's hire date."},"title":{"type":"string","description":"The job title for this compensation."},"adjust_for_minimum_wage":{"type":"boolean","description":"Indicates if the compensation could be adjusted to minimum wage during payroll calculation.","readOnly":true},"minimum_wages":{"type":"array","readOnly":false,"description":"The minimum wages associated with the compensation.","items":{"type":"object","properties":{"uuid":{"type":"string","description":"The UUID of the minimum wage."},"wage":{"type":"string","description":"The wage amount."},"effective_date":{"type":"string","description":"The effective date of the minimum wage."}}}}},"required":["uuid"],"x-examples":{"success_status":{"uuid":"db4d41e5-813c-477e-bfae-38da2ae5e7a3","version":"56d00c178bc7393b2a206ed6a86afcb4","job_uuid":"c1fdb417-c34a-43a7-92f3-5e6c20c1d7a4","employee_uuid":"a7e8f9bc-0d12-4e56-b789-012345678901","rate":"70000.00","payment_unit":"Year","flsa_status":"Exempt","effective_date":"2023-01-01","adjust_for_minimum_wage":false,"minimum_wages":[],"title":"Software Engineer"},"hourly_compensation":{"uuid":"e5f6a7b8-c9d0-1234-e5f6-a7b8c9d01234","version":"98b7a6c5d4e3f2a1b0c9d8e7f6a5b4c3","job_uuid":"d2e5f8a1-b4c7-4d90-a3e6-f9b2c5d8e1a4","employee_uuid":"b8f9a0bc-1e23-4f67-c890-123456789012","rate":"25.00","payment_unit":"Hour","flsa_status":"Nonexempt","effective_date":"2023-01-01","adjust_for_minimum_wage":false,"minimum_wages":[],"title":"Associate"},"minimum_wage_adjusted":{"uuid":"a4d9ba9c-32cc-4cc1-a5bc-6ef4cd653e7a","version":"cc59bd3879d655fb940a1f6b675f2ad9","job_uuid":"d8f8fbe7-496d-4b69-86f0-1e2d1b73a086","rate":"5.00","payment_unit":"Hour","flsa_status":"Nonexempt","effective_date":"2018-12-11","adjust_for_minimum_wage":true,"minimum_wages":[{"uuid":"edeea5af-ecd6-4b1c-b5de-5cff2d302738","wage":"7.25","effective_date":"2018-12-11"}]}},"title":"Compensation"},"readOnly":true},"location_uuid":{"type":"string","nullable":false,"description":"The uuid of the employee's work location."},"location":{"description":"The representation of an address in Gusto.","type":"object","title":"Location","x-examples":{"success_status":{"created_at":"2025-06-09T13:43:49.000-07:00","updated_at":"2025-06-09T13:43:50.000-07:00","company_uuid":"10593a6a-505b-4aa6-bf31-15dcdceedbe3","version":"e1bdd845a493c74908f8e15d6114169b","uuid":"6b1351a2-de35-4499-b948-43abab274634","street_1":"300 3rd Street","street_2":"Apartment 318","city":"San Francisco","state":"CA","zip":"94107","country":"USA","active":true,"phone_number":"8009360383","filing_address":true,"mailing_address":true}},"properties":{"uuid":{"type":"string","description":"The UUID of the location object.","readOnly":true},"version":{"type":"string","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."},"company_uuid":{"type":"string","description":"The UUID for the company to which the location belongs. Only included if the location belongs to a company.","readOnly":true},"phone_number":{"type":"string","readOnly":false,"description":"The phone number for the location. Required for company locations. Optional for employee locations."},"street_1":{"type":"string","readOnly":false},"street_2":{"type":["string","null"],"readOnly":false},"city":{"type":"string","readOnly":false},"state":{"type":"string","readOnly":false},"zip":{"type":"string","readOnly":false},"country":{"type":"string","readOnly":false,"default":"USA"},"mailing_address":{"type":"boolean","description":"Specifies if the location is the company's mailing address. Only included if the location belongs to a company."},"filing_address":{"description":"Specifies if the location is the company's filing address. Only included if the location belongs to a company.","type":"boolean"},"created_at":{"type":"string","description":"Datetime for when location is created"},"updated_at":{"type":"string","description":"Datetime for when location is updated"},"active":{"type":"boolean","description":"The status of the location. Inactive locations have been deleted, but may still have historical data associated with them.","readOnly":true},"inactive":{"type":"boolean","description":"The status of the location. Inactive locations have been deleted, but may still have historical data associated with them.","readOnly":true}},"required":["uuid"]}},"description":"The representation of a job in Gusto.","required":["uuid"]},"examples":{"Example":{"value":{"uuid":"d6d1035e-8a21-4e1d-89d5-fa894f9aff97","version":"d0e719137f89ca3dd334dd4cc248ffbb","employee_uuid":"948daac8-4355-4ece-9e2a-229898accb22","current_compensation_uuid":"ea8b0b90-1112-4f9d-bb93-bf029bc8537a","payment_unit":"Year","primary":true,"title":"Account Director","state_wc_covered":"null,","state_wc_class_code":"null,","compensations":[{"uuid":"ea8b0b90-1112-4f9d-bb93-bf029bc8537a","version":"994b75511d1debac5d7e2ddeae13679f","payment_unit":"Year","flsa_status":"Exempt","job_uuid":"d6d1035e-8a21-4e1d-89d5-fa894f9aff97","effective_date":"2021-01-20","rate":"78000.00","adjust_for_minimum_wage":false,"minimum_wages":[]}],"rate":"78000.00","hire_date":"2020-01-20"}}}}}},"404":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided UUID is valid.\n"}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-jobs-job-id.api.mdx b/docs/api/get-v-1-jobs-job-id.api.mdx
new file mode 100644
index 000000000..610b13aa0
--- /dev/null
+++ b/docs/api/get-v-1-jobs-job-id.api.mdx
@@ -0,0 +1,71 @@
+---
+id: get-v-1-jobs-job-id
+title: "Get a job"
+description: "Get a job."
+sidebar_label: "Get a job"
+hide_title: true
+hide_table_of_contents: true
+api: eJzdOmuP2ziSf4XHxaETwHRLlmRL/Wkbk2Quh92dYDpzs4sk8FJkqc1EFjUk1R1fw//9UJRky7b6lckCe5MPHZmPqmK9q8g7+pVdN9ZppioH14Y7pSvmNjXQiw8U1jlICZJOKK/r4RJLP02oAVvryoKlF3d0FgT4nwQrjKpxDb2gr7/ydV0C6VfSCRW6clA5XMvrulTCwzv/bHHDHbViBWuOX065EugF/W+d0wltSaI6/wzC0Qmtja7BONUibxol/Z52lXVGVdd0ckTN+xWQX355+4rogrgVkM86n1I8Bpc/VeWGXjjTwHZCb8BY1ZLzOEDRGAOVI92mHnZL6JRcAfjfH7p5VV2T60ZJ+PRi5VxtL87PpRZ26oUwFXp93jOd1XxjdFn6+XMlYV1rB5XYvCSFNkRVhTZrzzyiK7LSt8Rp0lhEpywpFJRySrcTCuu61BuA5bcxqd+O0G9XSqx61pEcSl1d21EWrpSBpeQOxhDuVxe8tDBGAW4ltyuoDmm45ZYgaEm0IQbaT+TGTpzbSa84Pd4Pe8RVU5at4p4QUPCmdPQCV4zR42GeYKqNWnOzGZwx17oEXp1w9dcVuBWYVjbKHpzqzJIOkAdMEN8NLxsgt6osSQ7EgkP2I29JU5VgLeEVga/KOtQnFIb/YXcU9rBHhWPukcv9yi30uobKttqG2x8zoZpv1lC5ZVMp96AoTnF2Wwlu7dGM0nEgjREauk3L4aZvNIJR/I+wwN3qZQ1GIAl2xQ2sdCnBPEtZBqqvbytLuCMlcOvI7D93pOl1zavN9NSuthNqHXewvBVLoW/AgByKYo99XBYHKosqpiyBUl2rvLOEW22+gLFnh1zxmPg1ENXaricBif2V25Wqrp2uyItfL18+RnDJrV0KLR+25FOxGWW/EL+b4O4HKFXVkCaPeUreIX+B3CirHPlwPH9myc8I/wcPv+bXAzd+e3s7LSs1veXTa31zrirbGF4JOEd7sQzpYp4usOfDH6zQhnUUsiGBg1Ws1PpLU//p/CX6gRK4qchaGxhn4hCIHegbN4Zv6IQqB+vh+C6ojnATagMWKrdT+WMW/ugD13eKyPcC/4PH6M86/0bPhIZ5EJkPWPhQiP6X5AVPxn5fDHpKbqDLkhvC17qpHKm5kqQGcxA32ug8GoOehcrHIC46H4t6cXJI493G2yOmKB+h9W0FZtIGTLvSTSkxmp+94xuxAvHlDDkDVbNG1/ZfujF0Qn8F+EIn9K+6cis6of8AjqP9DvppO6FFafkS3VFjx47VA3z9FdY1WvUVL7lRIMnfdAX94PD7JySTTugPer1W1lsI8oXsIBxP7DePuuA3f7m6JC2BXZBW9oBpU7Kj6cVZi+Xs5Y55lnADrVw5KdRXkMTi8g2BGzAbFDQKXGk5gHOr3Ipg6HFqDeTF2emhvwnDhPBKEgMC1A3s4eMCn512JUxewpSgBMsNeXH2CMo+b1npxvhMcOMD1HNQ7QUCcoDixdm4CJEODBm3/BosybnFBBqnfbzudxyBPebovUowDn0A+Dkn87qIJ/EfZy892/YndCvu0Kz2mZC7hcp5cWGmdZwVEbqrB+ib0nJ25dWSvUejQSdYFCCcuvldxcoOSFu23KPybzqxF8rYw0xy0i7vihDrU/3WtZ+15Y6HO1bbPOSsfWQYlC3HBCE4Lj831i0LbZZrVal1s16iFJ+Qo76tJJbuYIkaCd2i93UtApB4pg6D1xMiGyScdPGTCF6KpuwIGwkXQ+rGUponSGmI3hJurRaKu17Rj48wfShP+h6pzpAcL4sjxj8AxjOwDX/Tpynxozo7ThT+Q97+1ihfPHxoz/ppQr8yaFs7ngO2EQKsHQSllidU5rGMQ0hYGkaCxYsFsLzgwKJU8hmHBBY8ooNkjiZzGQQiXKS5WERZlM/4LJiDnPN0zguRx3SYK1ERFjKPwwUTUcxZHPEFy2ZFxBKYi1kgQrnguOMo06F8AWmR5YIFMpyxGJI5yxdpxoJwFsXJfJFmQUj7FIUugiAIpkFAjzOKPjgfxON92D2WCp0Fs4gFIfPA77W8Tn+PFP7Dp70fu9KFu0W3+Lq6VhWAQR1Y+eBzUOsO5ABJMeeLPGUikwHDYzIcYjiGQzhyIIcszRd8LhIZQ1TMeJgHIpMpLIo5T/JYRIdykDNIipSHLI/FgsUyCxiPYM6KLJ+JRKYQjsohT4uMB7lgIcwiFhfzBRNp1tLXiWG2l8MsGRVClzcdCmGY3fzL5HDZuxB65KCWvdcbSIDHMst5Jlg0E4LFQoSMJ7lgcyhiIedJBAt+IAEhkiyXUbrI5DxJijyLAx4W83y+SIoZl9mRBNIiLXJYsDibSxbn84yl8yJAzsowX0Q8SOd7Vn4/ToYpC2csfJCT6MJPGbnXTQnAE14wEHLO4jwULE8ksEQUxUxGwWwRpbR3j3QxnSWPkLL9tN1HSsxd9xaxHQktpRYPt4aw14DJyUN1QqPkcWF0Zn1aR3r43lX3P05b5ePVNq8Il9Jgx29YDh8HpP6wf+nBP+6hhQGMfkvuWpNIWDBnQfY+jC7i6CLOpkEQsGBx4TWlqeUDi5PgYHGXe/WqGQZJFvE5Z0mQ5CzmfM7yIgpZmEghBYDM4TAGQJhLmcYJj7NILOIsSIsUwkTOwzAO5xneBnSg53kYJSGfMQlRwuI4y1iexSlGgpzns0U8927NOgPgliG9oFEQkMhIcuWH9nMztOeaG+dLyChEjRPKbdDd8oq8wU6OskLTrkWFinVJJ/R/VY3eMg6DhT95UznsB9NfrnCWexXtLaBe6QqWVbPOsQtI0yDIonkQpXj6QpWqul52st7ZDB8Z3m6/TwLSq2LfBvnjd1kOFfPJ/OrrtW77YcNjx8W+2dEWR6oSZSNB9tnx8TIEwsd7t30H/UBbvqku8SBIC2J3ip07Ij93eZ2f6g/XT+NBPCxe+vldZ2O/gG6HpvUohduhsT39cmbbG+LTEDytitt2lvuUhTujfpIMunsk7wC2Ixb8aGF1VYNQhdoXVjvV6a6NOkmdWdIB7yPEt6ne9tT5HIemZ5BUfAeKJscsQiEMotVjhvuKO/ANBt/6xwbDkN4OEgIdRrXfB7SD5Evqzuc/Kuj33eVIY4898pS8rVowe2sjK34DJAeoiIQSHMgJyRtH1nxDrMN7Qr9gpazTRgleYl3Hx8rc9ai7UdX/S8JHy1McfVJy1V5rHVwznMCa0GEe1T1owE9/RTusdecyDKIEWMpnIYshlCzNZMIKnmZxkfGiyBYHeY4MYBFmYbQo0kzwSMooiqWMhZjFaVHk+UjFlMWp5FxghpMkLAYBLIMZZ7NZlmYpFyKfYcX0wM0nBZ7mQY5VVojFb5FJludZxPIimGW5SJPIFyLjpe7uwrvNT3aVkPBOkrxSBoTTho7dPNL2bv2eO77d7NHl1aBOeBrhgxo2i/NFkoShDCXkXCRyATMpgUMYzRdZ8dyCflhuPU3WY6Un1p1sFgz6C+muv/DsYnT7aQzM4PEFYgw6jNuunxMH8amP/5t25I1uKkk+VoR8rFqL+a0B370zYHVjBN69gCWVdu17gyn5K/8CxDamTe1qo28UOnqfNymLzxiUnH6sKOLFlNWL9S2y8BocuwnZZ51b/LNU0svD8DU4MK3kB4+BDpzzdkIrvsaB3U6Fh6i5vzTZW3Grpo/eoNHt5K6F8FsDBvuJHfgucqHS3kPK/r6Fl+XyUHk/nfihyxuufC1JtB+yFx8rRk52XpC3LWKcOmrVyYM2pR2+giCqsg64r0R9e/++pwv+vN0R/86892OX796y/+lsp2PnCrj0F0N7ho7mmq9QYmtVQZsNIJWsvQa4fPd2Vw4ce/SNboxfIHhZ+hu0CtNVZXdqNGnXDJ6JnVnyoe9RDmA/s4LgtWL7IuRPHUA2GH7pg7oFOX2S6PuKOEzaC7E+CRyMb7cnV2U/gmtD0PRj9bGyQtdwQf6JBnGBUe6fmAjxa7QEfANn/SXKD4cKhmW+rYF/AW437Nropm6Nwl5W8nDt4VIUPkPPbJT3vtfg2nd28NVBZXe+9wtgNXvvG8FJHwUfeSuI+taDOqZ3B2Oc7vGth/TvQXTnQGavwa1052m8a3ErekHPb8JzxHN+17qOLQoYzE3vchpTouZ36sRr1WoTk7D2KnWaGMJaHzG3hcfaSIHTeIZ7AI/CfGe0fABmjdN4RAuiMb44+nDnG1282lz6Rs9lg6dtA0S/6gr1uE1jRtbutBtJ7LXep4HAjfcChzR2IFgJN1AS3rgVVK4zU3TQVxvrYP17MLQQ7kHgU9ZCDx+Kej+GbuEgCxjY4ISin7I/FVdgbpSAgTz2LoPnunHnfuG5RNQYtpj/zXTh5YBbT15LQSn02r+G8HScWfK6swjyrrvkQo8ltWjWfRL6H917WC58BdJ55Fc9VvIzlDvrBaz2vEJ1s3/e649vCWnr1rwawNn5l2Ni7/aPcJ/khFqpOfjqzuuSKy9er853nVV9oDdhmyAhpRddUP6EtxLW4fTdHcaDX0y53eJwG2VRaaWyGA7viSxDQv9dQuc9/Ghd1D5f6B2St9MbblTbQX7WkV/0HZqXZCxpuYeS/ma02gzJ6CnsZLPF3KSL788j6g8e7B8Q7nimtBf0LlCh0/MVQz938tD9ID79+Po93W7/DxYjWqc=
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Get a job.
+
+scope: `jobs:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-locations-location-id.ParamsDetails.json b/docs/api/get-v-1-locations-location-id.ParamsDetails.json
new file mode 100644
index 000000000..40eaa1cf5
--- /dev/null
+++ b/docs/api/get-v-1-locations-location-id.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"X-Gusto-API-Version","in":"header","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"},"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."},{"name":"location_id","in":"path","description":"The UUID of the location","required":true,"schema":{"type":"string"}}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-locations-location-id.RequestSchema.json b/docs/api/get-v-1-locations-location-id.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-locations-location-id.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-locations-location-id.StatusCodes.json b/docs/api/get-v-1-locations-location-id.StatusCodes.json
new file mode 100644
index 000000000..4dbb2455f
--- /dev/null
+++ b/docs/api/get-v-1-locations-location-id.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"successful","content":{"application/json":{"schema":{"description":"The representation of an address in Gusto.","type":"object","title":"Location","x-examples":{"success_status":{"created_at":"2025-06-09T13:43:49.000-07:00","updated_at":"2025-06-09T13:43:50.000-07:00","company_uuid":"10593a6a-505b-4aa6-bf31-15dcdceedbe3","version":"e1bdd845a493c74908f8e15d6114169b","uuid":"6b1351a2-de35-4499-b948-43abab274634","street_1":"300 3rd Street","street_2":"Apartment 318","city":"San Francisco","state":"CA","zip":"94107","country":"USA","active":true,"phone_number":"8009360383","filing_address":true,"mailing_address":true}},"properties":{"uuid":{"type":"string","description":"The UUID of the location object.","readOnly":true},"version":{"type":"string","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."},"company_uuid":{"type":"string","description":"The UUID for the company to which the location belongs. Only included if the location belongs to a company.","readOnly":true},"phone_number":{"type":"string","readOnly":false,"description":"The phone number for the location. Required for company locations. Optional for employee locations."},"street_1":{"type":"string","readOnly":false},"street_2":{"type":["string","null"],"readOnly":false},"city":{"type":"string","readOnly":false},"state":{"type":"string","readOnly":false},"zip":{"type":"string","readOnly":false},"country":{"type":"string","readOnly":false,"default":"USA"},"mailing_address":{"type":"boolean","description":"Specifies if the location is the company's mailing address. Only included if the location belongs to a company."},"filing_address":{"description":"Specifies if the location is the company's filing address. Only included if the location belongs to a company.","type":"boolean"},"created_at":{"type":"string","description":"Datetime for when location is created"},"updated_at":{"type":"string","description":"Datetime for when location is updated"},"active":{"type":"boolean","description":"The status of the location. Inactive locations have been deleted, but may still have historical data associated with them.","readOnly":true},"inactive":{"type":"boolean","description":"The status of the location. Inactive locations have been deleted, but may still have historical data associated with them.","readOnly":true}},"required":["uuid"]}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided ID/UUID is valid.","type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["error_key","category"],"properties":{"error_key":{"type":"string","description":"Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error."},"category":{"type":"string","description":"Specifies the type of error. The category provides error groupings and can be used to build custom error handling in your integration."},"message":{"type":"string","description":"Provides details about the error - generally this message can be surfaced to an end user."}}}}},"x-examples":{"not_found":{"errors":[{"error_key":"request","category":"not_found","message":"The requested resource was not found."}]}},"title":"Not-Found-Error-Object"}}}}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-locations-location-id.api.mdx b/docs/api/get-v-1-locations-location-id.api.mdx
new file mode 100644
index 000000000..ba12ba8a2
--- /dev/null
+++ b/docs/api/get-v-1-locations-location-id.api.mdx
@@ -0,0 +1,71 @@
+---
+id: get-v-1-locations-location-id
+title: "Get a location"
+description: "Get a location."
+sidebar_label: "Get a location"
+hide_title: true
+hide_table_of_contents: true
+api: eJzdWG1v47gR/iss+2FvAcmWYzsb61ODy94iwPU2uGTbAt4gR4ljixeJ1PLFiWvovxdDSrYcO5vkrl/aT4mpmYcPh/PCmQ1VNWhmhZKXnKZ0CTZejeJS5X7NbP+7E5xGlIPJtahxgab0E1jCSCcx+Cq/SpOrGlLyW66qmkkBJtXA+G80opYtDU3n9OcOmt5G9DFeOmNVLKSFZaAR23UNKAhVBpwDbsvqui/iVWumWQUWNKJuqGQV0JT+K/7kAc+vLuN/gDZINKIC2RbAOGgaUZMXUDGabmjYihqrhVzSiIJ0FW59kpxM4+Q0Hk1xJw4L5kpL0/5689QYF8ilEhIMsQUQzizEGTPAyfnVJVkFLoQZo3LBLHDyIGxB1sppL5CzshyQywWRSgIRhtRarQQHHgUZVtelCJZ7Z8i8ElJUrupj3/5QWFubdDjkKjcDb9hBrqphZ8i4ZmutytJ/H7JaxK2mkMu/toBxb/k90nAG+IA20dbC+w7hLVszWxw4x00B5MuXywuiFt4gnR6NqIZvTmjgNLXawfMX0jS3ETWQOy3s2t/yj96t1ud5DsacO1vQdH7b9BxJmwe27HA1mFpJAwahT5IE/+yTNM4jLVxJI5oraUFalOpZe/i7QdFNj+XhQTXUGgxI61XwyEwSxrkGY4iQxDvlAKMgHFBlv0Nu8bewJS78vLPOYwyPrKrLQLtleGcss86v5BrQf+5Y3yOT2c1onE7G6WQ2SJIkTj6kSUIj6mr+HeFpsiccgnZ955zAXDBKprMxO2XxNJlm8YSx0zhbjEfxaMpzngPwDMY0oq230JTCKOP8bDJlk9k4/zCZJWeLMxhN+eloNBmdzjLkE6BPs9F4OmInMYfxNJ5MZrM4m03O4smYZSw7+TA5HU8wUq0GsHcjmtJxkpCx5uTaL+2+ndCUntdM2wqkJePRGZ7Duwu9ZpL8pJnMhcmV12AWbf3jOY3ov0VNUzqbjJIP/uROWo1KX67xK8utWEHnR3WhJNxJV2WgaUrPkmQ2Pk3GZ3j6hSiFXN61d91pVOzIctNEtNaYb60IlxuscZiHXhdJJHjRwEcU459luW436l3Ka8BzpzVar0tS7T4tPLkG8L/nu3RBlk5weGPGERyqWlmQ+fo9WShNhFwoXbVnkaRQD8QqzDjEFsKQhYDS554njvlqe+EeSLxVR/CHQuTFvhUzKJVcmgFBAxIh89Jx4EQsjoohCOsQj5p+31sOye4UFqw0cIy9hyABYnuKbZ0lv7b503/qDrct2QPy2WOx0n+Hqi7VGqAngCbdhdaLDJt+sHXS8524dGWJdfJQLQTi6zbwsfkaUR+5rxHcBvWr7qCr8ZgAmiMRvAXJlCqByQO3u64hFwsB5sB1hOm74TtDWvCuQvwx12sOk8/T0vQGSov/AqPoqYnwEnrV6qXAvWAWrKjA++1DAXKPb4uEoP2q9udAWyQE7XL+ixeNERrK8dOMPCCXMsDsoo0UbAUkA5CEQwkWX3SZs6Ria2KsKMsgUAhjlRY5K/HpyA4eiraA6mi6EfJ/knjTfwbOQyW8bRpcnySTQ1f+RVnyk3KS//GH2haCfJWEfJXh4fbNgUGyGoxyOgfCFRgilSXwKIwdkL+zeyDG6VAEu2c5ubwY+iIjDFmxUvBjr7v+CUFrpUPnsvcGaNd3t8e0Zmt8Wluo+uvPo97dAyrkzMJS6fUze3ipF8NllzIeCmjP7NWJynOnzYDcrGu87XIdqvQ9rIngIG3QQnlmrRaZszDcNmlEQ+l9wqodZKjtHes3UEMElEU3DkjEv2NaqO6STMt8qZWrBeYrJjnJGeYv39ggm8yJkpMc3y5VK18wyX02FDI0X73e03OuwBi2PFqv9ilfdUQ4WCZKQ1imnO0ZNSZLkKB35myhO5bG6QXLA1MmCUiOxNFyIVb2mwWp7N3CB0nPseZ7909bj+/7S9pT7B2OPhMgDyzEh1cY0OYWiXSNzC/Kxj7I4o+4afw5eO2WrqmB3QMz6xj7yVitQGvBwROzWsAKsA9/tCCN7/SRfiD+7KwgoitWupdnBtjE7kOFbnGrHzLqTug5rluFHWfsQSuwhWqHKDQKXXFKh6vRcJtTh5te+9xgTwJ61Y0wnC5xTNE+qVktwos65lD5Z/VhaYNK0X2jBrzYN1mo5zv3Z4CPYl5pxb+DWePnflt+jck2eN+R5nwbH7h5N3rxJQqY9sOY/d1biLiEFZSEOVtgYmlb4yai12tjofozOwSEZzbw5XShPGrrz75zxzHLXqfbGwRFFOc+5vPiGvRK5NCz9K4h8mE/9IJDjltjdo7971gtvIVR9SnZf0KZqwow+D2Pd4Z8bD2cXIXWyk+AuMpd1U0f/tJWSJb7CtmObS66XcmvmIl9REQU8CXqXaX9+redZ/h2VRlbMdnD2Z/5PWW82dXmN04HwyVaeLTDumTC37b3200bSHO6GtFoO35C9ml/FnUb0UIZi4KbDQ7evuiyaXD5mwNMcvNbjFstWIYXO99QLgz+z483Yv2j/NB1XO/Jd8ZaR8/QFXW57qUNGrU5pn+A5raJuiHl2+j9X48en7FrsN/xce/WzLtkjimjtr1vBw/HvQz+6eMNlpD9DLPNKO0/eElHr3ezCRI36h5k02xv2+JvXy+b/wBEISYX
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Get a location.
+
+scope: `companies:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-locations-location-uuid-minimum-wages.ParamsDetails.json b/docs/api/get-v-1-locations-location-uuid-minimum-wages.ParamsDetails.json
new file mode 100644
index 000000000..e1bdcd594
--- /dev/null
+++ b/docs/api/get-v-1-locations-location-uuid-minimum-wages.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"location_uuid","in":"path","description":"The UUID of the location","required":true,"schema":{"type":"string"}},{"name":"X-Gusto-API-Version","in":"header","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"},"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."},{"name":"effective_date","in":"query","required":false,"example":"2020-01-31","schema":{"type":"string"}}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-locations-location-uuid-minimum-wages.RequestSchema.json b/docs/api/get-v-1-locations-location-uuid-minimum-wages.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-locations-location-uuid-minimum-wages.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-locations-location-uuid-minimum-wages.StatusCodes.json b/docs/api/get-v-1-locations-location-uuid-minimum-wages.StatusCodes.json
new file mode 100644
index 000000000..f96c5ab86
--- /dev/null
+++ b/docs/api/get-v-1-locations-location-uuid-minimum-wages.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"successful","content":{"application/json":{"schema":{"type":"array","x-examples":{"success_status":[{"uuid":"1b71bb5b-4811-46e9-8a8a-cf5521cbeda6","authority":"City","wage":"15.0","wage_type":"Regular","effective_date":"2017-01-01","notes":"large companies"},{"uuid":"87434623-b57d-4630-8da5-9dde599c7840","authority":"City","wage":"10.5","wage_type":"Regular","effective_date":"2017-01-01","notes":"large companies"},{"uuid":"fa055c11-bfe4-4ac3-84dd-8502cf046b20","authority":"State","wage":"10.5","wage_type":"Regular","effective_date":"2017-01-01","notes":"large companies"},{"uuid":"cdd9dfc2-6465-4693-ae60-0eecff35038c","authority":"Federal","wage":"10.5","wage_type":"Regular","effective_date":"2017-01-01","notes":"large companies"}]},"items":{"type":"object","description":"Representation of a Minimum Wage","properties":{"uuid":{"type":"string","description":"unique identifier of a minimum wage"},"wage":{"type":"string","format":"float","description":"The wage rate for a minimum wage record. Represented as a float, e.g. \"15.0\"."},"wage_type":{"type":"string","description":"The type of wage the minimum wage applies to, e.g. \"Regular\", \"Regular-Industry-Specific\"."},"effective_date":{"type":"string","format":"date","description":"The date the minimum wage rule is effective on."},"authority":{"type":"string","description":"The governing authority that created the minimum wage, e.g. \"City\", \"State\", or \"Federal\"."},"notes":{"type":"string","description":"Description of parties the minimum wage applies to."}},"required":["uuid","wage","wage_type","effective_date","authority"],"title":"Minimum-Wage"},"title":"Minimum-Wage-List"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided ID/UUID is valid.","type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["error_key","category"],"properties":{"error_key":{"type":"string","description":"Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error."},"category":{"type":"string","description":"Specifies the type of error. The category provides error groupings and can be used to build custom error handling in your integration."},"message":{"type":"string","description":"Provides details about the error - generally this message can be surfaced to an end user."}}}}},"x-examples":{"not_found":{"errors":[{"error_key":"request","category":"not_found","message":"The requested resource was not found."}]}},"title":"Not-Found-Error-Object"}}}}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-locations-location-uuid-minimum-wages.api.mdx b/docs/api/get-v-1-locations-location-uuid-minimum-wages.api.mdx
new file mode 100644
index 000000000..ea717590a
--- /dev/null
+++ b/docs/api/get-v-1-locations-location-uuid-minimum-wages.api.mdx
@@ -0,0 +1,71 @@
+---
+id: get-v-1-locations-location-uuid-minimum-wages
+title: "Get minimum wages for a location"
+description: "Get minimum wages for a location"
+sidebar_label: "Get minimum wages for a location"
+hide_title: true
+hide_table_of_contents: true
+api: eJzdWNtu4zgS/RUu92FmANGXxHYcP21j0tMIMJeg0729QBJkaLJkcyKRapJyYhj+90GRlCLbcbKNwezDPiWSyapTVadu2lBTgeVeGX0p6YwuwLPVkBVGhHeu/e++rpVkpdKqrMv7R74ARzMqwQmrKjxAZ/QDeJJOkHCC5MYSThoZt/pWO2EqmJHfhSkrrhW4mQUuf6cZ9Xzh6OyG/tzopncZfWKL2nnDlPawiDiZX1eAB6Gcg5QgaUZ5VXWPhKsVt7wEDxalbqjmJdAZ3bGHZlQh8Ir75YE1n5ZAPn++vCAmJ34JrRU0oxa+1sqCpDNva8ioE0soOZ1taMRGnbdKL+h2m7WK/8M+BEveXV2yf4N1UVJQvwQuwdLjcjIKui7R5pPByZgNJmw4RhMl5LwuPJ1132/3DblAJ5RKgwt2SO6BzbkDSd5dXZJVxEK4c0Yo7kGSR+WXZG1qGw4IXhQ9cpkTbTQQ5UhlzUpJkFk8w6uqUNE13zly0xCgI/vu+6X3lZv1+9II1wsR7QlT9psIsoqvrSmK8HufV4qlm0ov/pkEss7rHxBG7UD2aMfDkOcgvFrBPZrYOPdrDXa9E7OcFw4yCk+8rAqIzhuwwZCdDl+JwXZ7l1EHorbKrwOjfgwUXr8TApx7V/slnd3cbTukte6RLxqOWHCV0Q4cij4ZDPDPbpxcHSTldUEzKoz2oD2e6ji4/4fDo5tDlNxajmY+sWRX0JNE3jvPfR3zIPB+Rofzs+F8Pp6z0XQ4ZKMJnLMpn3Im8vH4ZCjmIPkEE6v2SxMtpj/in4xiZqOAcW+Qnu4Tho+wqAuORN4LBbp4eIYuHqCLtfEIjxbcLoC0lSDEMsGbno1OR5OTUzYfn0k2mpwO2FTyMTuXEsbn5+JsOhq8Dm/QG/998HI+GI/FcMjmOYzYiItTNh1JyabjwYnIB6PJ/GQf3rWPpPyf4BNSnstcnLDJaDJmo8n5KeMwGbABgMjz0/HgdCr28P0EEiwv/l6Ed9uMKg+l6zDXzP8A4Q/K70eoLDjQPhAfizAnv6Ta8gURZrSy2Ly8ilyPph+Wzl2xtVZfayBKgvYqV2Cj5G7bwgoafXAoLDe25Fhw88LwQ9DYM/AqsdxD6n5d0cSCMFb2SGsdSMId4STIywj0Fj1yG5LrlvYaJMn/b9mG2vEEmhS0YbnfUR9KCfYB06pKMb2l2fMDu9Sydt6u2XUFQuVKJDD7YX/FQakGHyLEHw6R2boIzaXVQIwOKjsc/W/sX5gVWOwbpL1I/JJ7IiyE5ravuXUE1o/ohZCq+K+x5LZJjOSBRO23oFw8P2E0Kh5o+lpAejgtdLrUDU0TymMk+zMPDsLQddJdRr3yoa2lbGFfEqdfes9+Vs7T7RZ1jwajw6b0q/HkJ1Nr+S096YgIcqsJudUYJrQTHMbDgjO1FUCkAUe08QSelPM98gt/AOJqG8nSDB3k8qIfpjLlyIoXSvZwdNyrJF0vgrXGxoFwp1yk94cd9Gh9OpB6/wB4QXAPC2PXR3SEU28SJiUaOPK4hGRzuE6MELV1PfJpXSmcxZDPypEHWD9Xscgs7r1V89pDv519iYUi0t48iwxEblF/AzTfKTBREsFgNqKaILmEfGFNXSm9cIRrSQTXZA5hbEM081oVkggclMp0fsm1LDB1lY6jZWekD5hLcO5IYd6FfNUAkeC5Khzhc1P7jlMZWYDGtG7cmUQ3KF1tcy4iUq4JaInA0XMxV3bHLG38fR6SpEOsm53408T4Ll9mnYsd4+iRBHnkMT/ChR42005S/2o8C0nG3qNS9ltkbQvXVcAfgLs1w2mZYZW0SkJc+VJF+JK2OnjyoF3Yo9CKiP/oJpbRFS/qtzcyHE92RcX5uL2Pc3L30DHI7YUD6Dh8l+CXJq2yOCPgajej/dWw3y61/c3OFrjt76+1Duyq2RtrW+CKlhYYXqm4vzAJZVhiXij9paG7Lo/yWBjN8F4c1V4W/KLMK2vkKzIr/Lm7n1xjKY7cfGFLabMHlTcrDz7PgduwiO5qTyJYASsoQl/FspO24W1Gr9fOQ/lXNEQJRxTgzKhzE6QmtodVGldMJENapneW4Izizut+y6/BrpSAjqef189QFPrhYF+iaqzdLDwzkwcP49V9sF+gEKYELA0Bx3eOvE/EJ1dxkQ3brzSiLpsB9h+pf3IR+mdaWS8areQj1umQKBmFkqsiUCX9+q9nZqA3KuN8yXVHzltfXvZt2Dz38r/61SbG2cOT71cFV4EQgdqblHs3dIU7QZt9NKOz/a8wuwl4l9GlcR6vbjb4peKzLbZbfB2XeUxLqRyfF511PlaNg8moKRUhPVbcKrz1soSjHvr+Y+r8P5BXPgq96IlmttDrLpYG7a4bwnaUvgV9G8D/6y88RzwbPfjyV7XnoLftBKtT5Tu/HUywO83jw/tPaazuFLO2eKV/MEgvBniziSc+mQfQ220bb4/PoXFv/wRxkWN3
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Get minimum wages for a location
+
+scope: `companies:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-partner-managed-companies-company-uuid-migration-readiness.ParamsDetails.json b/docs/api/get-v-1-partner-managed-companies-company-uuid-migration-readiness.ParamsDetails.json
new file mode 100644
index 000000000..9ff053362
--- /dev/null
+++ b/docs/api/get-v-1-partner-managed-companies-company-uuid-migration-readiness.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"company_uuid","in":"path","required":true,"schema":{"type":"string"},"description":"The UUID of the company"},{"name":"X-Gusto-API-Version","in":"header","required":false,"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.","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"}}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-partner-managed-companies-company-uuid-migration-readiness.RequestSchema.json b/docs/api/get-v-1-partner-managed-companies-company-uuid-migration-readiness.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-partner-managed-companies-company-uuid-migration-readiness.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-partner-managed-companies-company-uuid-migration-readiness.StatusCodes.json b/docs/api/get-v-1-partner-managed-companies-company-uuid-migration-readiness.StatusCodes.json
new file mode 100644
index 000000000..a0878fd0b
--- /dev/null
+++ b/docs/api/get-v-1-partner-managed-companies-company-uuid-migration-readiness.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"Example response","content":{"application/json":{"schema":{"description":"","allOf":[{"type":"object","properties":{"ready_to_migrate":{"type":"boolean","description":"Indicates if the company is ready to be migrated."},"company_uuid":{"type":"string","description":"The company UUID"}}},{"description":"Migration blocker that blocks company migration","type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"error_key":{"type":"string","description":"Error key"},"category":{"type":"string","description":"Error category"},"message":{"type":"string","description":"Blocker message"},"metadata":{"type":"object","properties":{"key":{"type":"string","description":"A categorization of the migration blocker, e.g. \"migrated_company\""}}}}}}},"title":"Migration-Blocker"},{"description":"Migration warning that does not block company migration","type":"object","properties":{"warnings":{"type":"array","items":{"type":"object","properties":{"error_key":{"type":"string","description":"Error key"},"category":{"type":"string","description":"Error category"},"message":{"type":"string","description":"Warning message"},"metadata":{"type":"object","properties":{"key":{"type":"string","description":"A categorization of the migration warning, e.g. \"marijuana_related_business\""}}}}}}},"title":"Migration-Warning"}]}}}},"404":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided UUID is valid.\n"}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-partner-managed-companies-company-uuid-migration-readiness.api.mdx b/docs/api/get-v-1-partner-managed-companies-company-uuid-migration-readiness.api.mdx
new file mode 100644
index 000000000..74396cbcb
--- /dev/null
+++ b/docs/api/get-v-1-partner-managed-companies-company-uuid-migration-readiness.api.mdx
@@ -0,0 +1,71 @@
+---
+id: get-v-1-partner-managed-companies-company-uuid-migration-readiness
+title: "Check company migration readiness"
+description: "Check if an existing Gusto customer is ready to be migrated to embedded payroll. This endpoint returns blockers and warnings associated with migrating the company and is recommended to be called before attempting to migrate a company."
+sidebar_label: "Check company migration readiness"
+hide_title: true
+hide_table_of_contents: true
+api: eJztV0tvGzcQ/ivs9JAE2JXsIOlBp7qxG+iQxsijLWAJymg5khgvyQ3JVawI+9+L4XLllS05aXsoENQHWdqdN7+Z+biFm3xZ+2BzZQItHQZlTR42FcHoCkjPSUqSMM3AVtS+HUsYwZJCvj7NK3TBkMs1GlySzAurKzSKfPq2yetayVyrZHnmCKUy5D1kEHDp2cuLTondSPKFUxULwwherKi4Fmoh0Ai6UT4osxQvOV5R8KcmJ5QXbHUjghVzEq0vkvyzi19UuHG2LAfi3Up5QUZWVpkgHIXaGS/mpS2uyXmBRorP6IwySy/Qe1uoaOuzCqtkmSMIKxIpwagSQyis1mRk63lOosCyJCnmtLCOBIZAumq1bRekwM7MYGImxhe2opH4kKo6S1Wd7ao64kQ/QAYVOtQUyHEBt2BQE4wg2ZpxzSEDxRWsMKwgA0efauVIwii4mjLwxYo0wmgL7VmDD06ZJTR3T+DdisT79+NzYRf9tKHJdm7/zOOJ5GeX4/x3cp4Vk/cVoSS353+Bpae7Xs45F83AiE4kBsrn6EmKs8uxWLdG7x3IxtYuCnCpB2K8EMYa4tOonF0rSTJrZbCqSlVEBD7y4koro3St+7anj1chVH40HEpb+EFsiUFh9bCDUJ4gFN8PsVJ50lRm+WMymPceP+Ewak9yAMernQGZWnMPPD15+jw/+Sk/fd42wQLrMsCo/7xpplxHX1njybOxpycn/G+/lBc3qKuSRCcJGRTWBDKBZXuVGH70rLDtRbdvCTLAsny9iBBLgdv5RyoCI9DxQAiqjSQ24CzYWQJ2L9W5tSUhI2Lf+thIDoQ8t3e/oY7084CxuYfwA+W8j93OKmMYmoZhuy/0qptN3RQQYYWh/eF36rsJxnPrwVKQc9b5XnDoHG64IQLp/vOH9GfXtPl6fhcsKliUS4OBltZ9s9pOvslAk/e4pK+r/pJK1ClE3YASA349s2/K6awLTH1pTyXNHX33mDJBg+VATKADSBqTmwnwOfNfBkGFkvqHnKcM4CEgpA3QAkFa8sLYhIh/AIhun3ynkPgjFeu/hEQq8S0k0KmPNRqcOSojNua1j7TjYXCkXKCZthLPTp7dH4u/2SB+tbWRYmKEmBieMrzeyPNicuRt7Qq6xU3kLQPxCq9J+NpRjL1bUO1uVV6ssVRyMDHAfukmkOEt0q73WKXjRC2DNZb1HcLGy0JTWNnE1iJpCCsYwXB9OjzKMIbb/ohthoeZmye37rhH7Upe9Gl7YqXa5ZlL0nGD3jvOc9IWMrjJfUV4Teg3eWsv55kOrBe784jhgzYvnZUP2Kz4NVfEU1E7FTYx8pZ3bs6Kgrw/q7k4V9O+1FtejC1QD8juYMshdks+bjxCF0nPHS6bGHFJayoF1mFFJqRdzF3zduMD6X/jobVwxEHDlGxho9UE/JZIn12OGUKJuO1RjgyYlvnXi7fk1qqg3nncMiSc2zoMo+BQsmtu8Dz+zu0ingOr3psbVBZWE2/5GMcjLy46un7Zcq1I0KQtak0mxDR+SGwGi8hmEgE977yKN9zusW8yII2qjIBKb3++xQ9Xo7I+aDQ9O+1t496EF33o7yWxvaVW/19VjlxVEoQD3YRhVaKKWI+9vU0T6QrWp+2d5rApyGB052pzaCxNM1hZH9jedsuXh/eubBp+/KkmXoJXU56UTuGc0X+1Bak8fz9yKekf7uM36f7yRBy7EB3JtNv4USLNaWbW7UzfS6uZNll3Y/p74X3n16eDhW0LePjuuasz75FWkOdqFXrv7t2E9jbmy4t30DR/AVwYDuQ=
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Check if an existing Gusto customer is ready to be migrated to embedded payroll. This endpoint returns blockers and warnings associated with migrating the company and is recommended to be called before attempting to migrate a company.
+
+scope: `partner_managed_companies:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-payment-receipts-payrolls-payroll-uuid.ParamsDetails.json b/docs/api/get-v-1-payment-receipts-payrolls-payroll-uuid.ParamsDetails.json
new file mode 100644
index 000000000..cbc883db2
--- /dev/null
+++ b/docs/api/get-v-1-payment-receipts-payrolls-payroll-uuid.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"payroll_uuid","in":"path","description":"The UUID of the payroll","required":true,"schema":{"type":"string"}},{"name":"X-Gusto-API-Version","in":"header","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"},"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."}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-payment-receipts-payrolls-payroll-uuid.RequestSchema.json b/docs/api/get-v-1-payment-receipts-payrolls-payroll-uuid.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-payment-receipts-payrolls-payroll-uuid.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-payment-receipts-payrolls-payroll-uuid.StatusCodes.json b/docs/api/get-v-1-payment-receipts-payrolls-payroll-uuid.StatusCodes.json
new file mode 100644
index 000000000..097672f2d
--- /dev/null
+++ b/docs/api/get-v-1-payment-receipts-payrolls-payroll-uuid.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"type":"object","x-examples":{"success_status":{"totals":{"company_debit":"0.00","net_pay_debit":"0.00","child_support_debit":"0.00","reimbursement_debit":"0.00","tax_debit":"0.00"},"taxes":[],"employee_compensations":[],"licensee":{"name":"Gusto, Zenpayroll Inc.","address":"525 20th St","city":"San Francisco","state":"CA","postal_code":"94107","phone_number":"4157778888"},"payroll_uuid":"9f624c0d-0d4f-499a-993a-846dfa47a48e","company_uuid":"0481a066-e26a-465b-a2c1-933bd5b03a69","name_of_sender":"Kiehn, Conroy and Prohaska","name_of_recipient":"Payroll Recipients","recipient_notice":"Payroll recipients include the employees listed below plus the tax agencies for the taxes listed below.","debit_date":"2025-06-12","license":"ZenPayroll, Inc., dba Gusto is a licensed money transmitter. For more about Gusto’s licenses and your state-specific rights to request information, submit complaints, dispute errors, or cancel transactions, visit our license page.","license_uri":"https://gusto.com/about/licenses","right_to_refund":"https://gusto.com/about/licenses","liability_of_licensee":"https://gusto.com/about/licenses"}},"properties":{"payroll_uuid":{"type":"string","description":"A unique identifier of the payroll receipt."},"company_uuid":{"type":"string","description":"A unique identifier of the company for the payroll."},"name_of_sender":{"type":"string","description":"The name of the company by whom the payroll was paid"},"name_of_recipient":{"type":"string","description":"Always the fixed string \"Payroll Recipients\""},"recipient_notice":{"type":"string","description":"Always the fixed string \"Payroll recipients include the employees listed below plus the tax agencies for the taxes listed below.\""},"debit_date":{"type":"string","description":"The debit or funding date for the payroll"},"license":{"type":"string","description":"Always the fixed string \"ZenPayroll, Inc., dba Gusto is a licensed money transmitter. For more about Gusto’s licenses and your state-specific rights to request information, submit complaints, dispute errors, or cancel transactions, visit our license page.\""},"license_uri":{"type":"string","description":"URL for the license information for the licensed payroll processor. Always the fixed string \"https://gusto.com/about/licenses\""},"right_to_refund":{"type":"string","description":""},"liability_of_licensee":{"type":"string","description":""},"totals":{"type":"object","description":"The subtotals for the payroll.","properties":{"company_debit":{"type":"string","format":"float","description":"The total company debit for the payroll."},"net_pay_debit":{"type":"string","format":"float","description":"The total company net pay for the payroll."},"child_support_debit":{"type":"string","format":"float","description":"The total child support debit for the payroll."},"reimbursement_debit":{"type":"string","format":"float","description":"The total reimbursements for the payroll."},"tax_debit":{"type":"string","format":"float","description":"The total tax debit for the payroll."}}},"taxes":{"type":"array","description":"An array of totaled employer and employee taxes for the pay period.","items":{"type":"object","properties":{"name":{"type":"string","description":"The amount paid for this tax."},"amount":{"type":"string","format":"float","description":"The total amount paid by both employer and employee for this tax."}}}},"employee_compensations":{"type":"array","description":"An array of employee compensations and withholdings for this payroll","items":{"type":"object","properties":{"employee_uuid":{"type":"string","description":"The UUID of the employee."},"employee_first_name":{"type":"string","description":"The first name of the employee."},"employee_last_name":{"type":"string","description":"The last name of the employee."},"payment_method":{"type":"string","description":"The employee's compensation payment method.","enum":["Direct Deposit","Check"]},"net_pay":{"type":"string","format":"float","description":"The employee's net pay. Net pay paid by check is available for reference but is not included in the `[\"totals\"][\"net_pay_debit\"]` amount."},"total_tax":{"type":"string","format":"float","description":"The total of employer and employee taxes for the pay period."},"total_garnishments":{"type":"string","format":"float","description":"The total garnishments for the pay period."},"child_support_garnishment":{"type":"string","format":"float","description":"The total child support garnishment for the pay period."},"total_reimbursement":{"type":"string","format":"float","description":"The total reimbursement for the pay period."}}}},"licensee":{"type":"object","description":"The licensed payroll processor","properties":{"name":{"type":"string","description":"Always the fixed string \"Gusto, Zenpayroll Inc.\""},"address":{"type":"string","description":"Always the fixed string \"525 20th St\""},"city":{"type":"string","description":"Always the fixed string \"San Francisco\""},"state":{"type":"string","description":"Always the fixed string \"CA\""},"postal_code":{"type":"string","description":"Always the fixed string \"94107\""},"phone_number":{"type":"string","description":"Always the fixed string \"4157778888\""}}}},"title":"Payroll-Receipt"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided ID/UUID is valid.","type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["error_key","category"],"properties":{"error_key":{"type":"string","description":"Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error."},"category":{"type":"string","description":"Specifies the type of error. The category provides error groupings and can be used to build custom error handling in your integration."},"message":{"type":"string","description":"Provides details about the error - generally this message can be surfaced to an end user."}}}}},"x-examples":{"not_found":{"errors":[{"error_key":"request","category":"not_found","message":"The requested resource was not found."}]}},"title":"Not-Found-Error-Object"}}}}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-payment-receipts-payrolls-payroll-uuid.api.mdx b/docs/api/get-v-1-payment-receipts-payrolls-payroll-uuid.api.mdx
new file mode 100644
index 000000000..032fc9d44
--- /dev/null
+++ b/docs/api/get-v-1-payment-receipts-payrolls-payroll-uuid.api.mdx
@@ -0,0 +1,76 @@
+---
+id: get-v-1-payment-receipts-payrolls-payroll-uuid
+title: "Get a single payroll receipt"
+description: "Returns a payroll receipt."
+sidebar_label: "Get a single payroll receipt"
+hide_title: true
+hide_table_of_contents: true
+api: eJztWtty47gR/ZUO8rC7KVKSPbbH1lNc493ElWTWNZ5JUmu5NBDRkrAmAS4Ayla5VJXfyO/lS1INgBSpy9hjb16SPFnGpbvRl4NGNx+ZLtFwJ7W6FGzIZujSxUFa8mWByqUGM5SlszRgdJ43P8ZVJQVLmECbGVnSfjZkH9BVRlngEJdBJNAbqZF6rx3a4Uj9Dv6oKwNcCRA6z7kBXuhKOQvcIBhPAwVwC9YZqWZgsDRoUTkvpwU9BVUVaGQGAjNZ8Nz2iOzFLmpxKwpwGtwcIUPl/PLLKSgNgjsOc25hiQ4mCFJZNLR8qg1wmMkFKphKzEUC0oHAKa9yZ4naiA16g8GIwbe0diofSOrA/Dt/YpvpEofwudbe0CAXn1nCHJ9ZNrxhV3GC3SbsIZ1V1ulUKoezYJLULUukdVhMUAgUtK7khhfo0BCFR6Z4gWzINuwilR9z8y0bfZwjfPp0eUFaJHXEjSxhBn+ppEHBhs5UmDCbzbHgbPjIghgsmIOtVknD9u/pH7zQ51eX6V/RWOIRuc+RCzRsP52EoaoKOt7h4PA4HZykB8d0wKhiNmyPrzbPcUEqKKRC648huMN0wi0KOL+6hEWQBbi1OpOc7Hkv3RyW5Hm0ION53gsuoBCkhdLohRQokrCGl2UuM2+FbyzcFFLJoiratG+/nTtX2mG/L3Rme954vUwX/dpYdaz4+T4vZRp3SjX7bSSYtoa/IzEqi6LHVrcJs5hVRrqlt/I7XZRcLc+zDK09r9ycDW9uVy2vMfaez2rLGbSlVhYtKf1wMKA/Xe1dV57StCLDZ1o5VI5WtY7d/9nS0sdt++nJz5g5RszxgRdlHhjZQHNsHXeVH3Ha8dz/yoL8Y4ETSZalwGEJU+jGJd8azuYyF2NblaU2bnPSoCwmlbFICLU56fhDd2jlx0jAm9uEYVHmeok4JnlQ2QAoYS6XGSqLSOJG7/a+ncBPqGo8u1RZjyWMC2HQWjZkx4fHcDhwc7gmhWTeXuyaK/jBcJVJm2mKAMcd0Xt3zhJWaut4Ps60oKGzo4PBWxqda4VjVRUTNGzIjg6O3759e3p6ekon6AT3kJ1NTw6PsoFIB+Jomh6dnfH07OwNT0+PTsSUH73lR6fozRp0HncNjk4P+ODkJMXDE54enRxPUn6YHaRnb95MxPFk8IafnJFJeIFjPR1bVMKL8ieJc5XAO62MXnrUvjJ6zu0db602mMlSeieqQQ0+1GPWWy3+M1bayQxb65opC1JleSXQR3RtKwu5tBTAE8z1PZR5FSLe8QfgM1SZROvBOg5ubOh5BJxINxbBCA2oHLLG6GzIfkIVBUq8lRMQEw7eAyguOcSlAgqtcAnOcGUL6RyaHvygDRTaIPCJrlzY9a9//NPWm6zXmwcW7wupLTGTU5mBkbN5uE0IftE6kGqqTeE9MwFbTQrpgEyZc6mcTUBIW1YOAY3RxiagDWRcZZgHkXjmfTqBhbTSAbGMQkDJZ9hbH3pcGUk4HVFsDWD+EP1adDIeCTl2emxwWinxvE255BOZS7ck/1gH19NbV+TxhvISJwOydP1/+x7pYts5VEr+UiFIgcrJqUSzcdk1aQkFVzdMXkE8Emp8MTLzTDaj6ik2dEvTnk3akyXcz3XROcw9t1ByKdp8WvH45Inye74MIRVSmJh1jXYE8ogRk+1Yfj2P/zAIBMHbOPAcC/j1FGDk9SQvbd20LxFuYOTlivhfwZ9giQ4EPaW0Tx/+3Ci9ptWScnNONJFRGk0ZiTY92K/4p/Ao+vwmBD4ldDjlTgh8ztZ16rSZdG27qa0mYfk29Gwi6UYeti1J0Cobsmmu+W52nleDSCFGdmJeN7n7FXgpdMRhJ7edOeNreBI9iPS+cMqd6egr+Hbo7bDoqpPkvoIRQee+Y63WaXPDgRvDl9uApsBP+IuK6KKoQTs88WsEj6jc4gUlGqkFOal0WOx09q73hrT8OcgdnuH+WowspSUJvP7C5KuU16Y/WcJEu/meY29w96rd9wz5Cl039DskPGt66M51TheWXbNfv/OfqexGyOclRpt1hXq713hDayqNdePn29Gv72RCu+nm/KvI0vL9VGP1a1ygm+tnHr0m8I3tWAQiLQi0eq2ix4U0mDm4wFJbSep/N8fsjt2ukfOFHtoSJQJmD95H5KwdNiNePq9YcJnzSR4c1eAUDaoMYVI5mlba1fmYAKm8rj7fjOL1NGK3N6Muzo/Y7ecYHb3mHhs7/vCqcFs7/LNBpeE940ZJO/dw+ioh2oT2sezeQq0dv+Jd1KL65ZN3rpJf71LazdQD244c5wt5y/587YXIvz/J213JCaldU8x5OflWFSjQDIWglxPsVJACyVhEejnNd+eBUKcA9XJyvnIVKXaKVy8nua56Ed2QhUiXt4pF6Yfwco+zR4Oj7drme+3gB01J+leUNveQgJECGCny1vg+QgEGra5MhiA0BojEB2ldD/7C7ygbN+HtWleU4fKi729GaWHBc+lvgc3oWBffb1h4Wflaf/dGDuPbacLeG32L6vgOaUPGHc60We7h4Vc9acfr8IZEC/dzjGf220FnWWVsDz4uS0mF9mVIQe5wuS6bBAfgzhk5qRz2m7YGGMx5q1/jSQZwraX+CtF8PWBZ+os+UAIyZk2qNpKNks+MrkqfONE1k3FFLSGqyZM0k4pgOCMoKeL6OVciJ+eVKjyvW90bL3OB1vLZMwLtqhZEoOMyt/Epv1ZqCjNUaNbqjKRrKW1lpjwLknIFqAQJbgI0rzaL9Uq78VTHl2ztWDcd+7Po8W1/GbY2tg7H9gQIlaYoPvwGamu0Q/q9dqkPsvR7Ypr+GLy2EdeWyO+Q22VK6J/qBRojfdF8hq7GgYThg0NlYx3/kQXR9zbTErbgebXRVKOGVndfaKc0i6mt0l60T7RmQ1tEatPUqSSN0+VGnbkh6y8O+nVvsP/YrnKu+qY5oEWzqLt9lclbJVReytB3SgUWvnax5VYXWGjW1Wagl/qmAO1jdLI9hHfSvDJafIFmSdPtDtY1oWxwux19rCYwiHndLqT/J8iNbyB2uUcSaY4LzIFXbk6IEoCdIu56aR0Wr+EQKOxhsKL25lR7qtGRQ5Hu/OqS7B+boJ3mZcKoV2l/nF6jWYTmx76qk1/YF8SaYDn1/6d66jVMWzeF/RvmmS4oUQtlv28sfB8dG+riKnUthc6qou6h/yZejTxzrXbXRc0VPhAE+5CiNxaXuXeVOPv7tWesYjpRcNVum6EDDlaqWb5Vct+U/3F9Rf//84Fnfz4Q3Nnhg+v7uiz5vY/gxwgtN2xxwJrGIZlxuPGFQG2P24TNtXW05fGRGuifTL5a0fAvFRLiU290wY2kR6LHICEt/RZsOOW5xS8Y9NsPMf/4DvZ/drDzMHWCo5YtTGVJBODOUVb0Yo4fG3ydeP/VnxDsUWxQ4O7PNho9r686glEftPXcVhbdud3+8P1H6o53UbdB2fiDjLTTvo+PYcVHfYdqtWrM7eh/nzys/g0smOg+
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Returns a payroll receipt.
+
+Notes:
+* Hour and dollar amounts are returned as string representations of numeric decimals.
+* Dollar amounts are represented to the cent.
+* If no data has yet be inserted for a given field, it defaults to "0.00" (for fixed amounts).
+
+scope: `payrolls:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-payrolls-payroll-uuid-employees-employee-uuid-pay-stub.ParamsDetails.json b/docs/api/get-v-1-payrolls-payroll-uuid-employees-employee-uuid-pay-stub.ParamsDetails.json
new file mode 100644
index 000000000..31fbb41b2
--- /dev/null
+++ b/docs/api/get-v-1-payrolls-payroll-uuid-employees-employee-uuid-pay-stub.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"X-Gusto-API-Version","in":"header","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"},"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."},{"name":"payroll_id","in":"path","description":"The UUID of the payroll","required":true,"schema":{"type":"string"}},{"name":"employee_id","in":"path","description":"The UUID of the employee","required":true,"schema":{"type":"string"}}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-payrolls-payroll-uuid-employees-employee-uuid-pay-stub.RequestSchema.json b/docs/api/get-v-1-payrolls-payroll-uuid-employees-employee-uuid-pay-stub.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-payrolls-payroll-uuid-employees-employee-uuid-pay-stub.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-payrolls-payroll-uuid-employees-employee-uuid-pay-stub.StatusCodes.json b/docs/api/get-v-1-payrolls-payroll-uuid-employees-employee-uuid-pay-stub.StatusCodes.json
new file mode 100644
index 000000000..e4043bdbd
--- /dev/null
+++ b/docs/api/get-v-1-payrolls-payroll-uuid-employees-employee-uuid-pay-stub.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"successful","content":{"application/pdf":{"schema":{"type":"string","format":"binary"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided ID/UUID is valid.","type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["error_key","category"],"properties":{"error_key":{"type":"string","description":"Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error."},"category":{"type":"string","description":"Specifies the type of error. The category provides error groupings and can be used to build custom error handling in your integration."},"message":{"type":"string","description":"Provides details about the error - generally this message can be surfaced to an end user."}}}}},"x-examples":{"not_found":{"errors":[{"error_key":"request","category":"not_found","message":"The requested resource was not found."}]}},"title":"Not-Found-Error-Object"}}}}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-payrolls-payroll-uuid-employees-employee-uuid-pay-stub.api.mdx b/docs/api/get-v-1-payrolls-payroll-uuid-employees-employee-uuid-pay-stub.api.mdx
new file mode 100644
index 000000000..e02a9d0a7
--- /dev/null
+++ b/docs/api/get-v-1-payrolls-payroll-uuid-employees-employee-uuid-pay-stub.api.mdx
@@ -0,0 +1,71 @@
+---
+id: get-v-1-payrolls-payroll-uuid-employees-employee-uuid-pay-stub
+title: "Get an employee pay stub (pdf)"
+description: "Get an employee's pay stub for the specified payroll. By default, an application/pdf response will be returned. No other content types are currently supported, but may be supported in the future."
+sidebar_label: "Get an employee pay stub (pdf)"
+hide_title: true
+hide_table_of_contents: true
+api: eJzlV0tv20YQ/ivT7SEJQIp2kPTAU906DXxoYsROW0AWnBV3KG5M7m72IZsQ+N+LWZISpVgp3PbUnkQt57XfzHwz3DBt0HIvtboQLGcr9On6NDW8tbqu3fhwG4IUKTam1i2i2z7154a3t86HJUuYQFdYacgey9lb9MAVjNLPHBjeAolCqS34CsEZLGQpUcDgagY/tSCw5KH2CWlzY2pZxBAzI0qw6IxWDuFe1jUsESz6YBWKGbzToH2FFgqtPCoPvjXogFuEIliLytctuGCMth5FAsvgoeEtGdmeglQxsDL4YHF2o26UK7TBHD6N93S5RS4+sYR5vnIsn7PLAS+2SNhDugrO61Qqj6se2pTiIDlsligECpIz3PIGPVqysGGKN8hy9kf6NmqfXV6kv6F1BGTCJKFZIRdoWcJcUWHDWb5hvV3mvJVqxRKGKjTk5+XJy9fpyQ/p6WvyNKDJ8ul5d5isc4qlkQpdvL/gHtMldyjg7PIC1n0swJ3TheQE1L30FbQ62ChQcMrdRQlKKwTpwFi9loJgjjKTND5zMG+kkk1oprYXzyvvjcuzTOjCzSKKs0I32YjaWI3xfcaNTAdNqVbfDwbTyfELCiM4FDPWJVuEx5KWYgTWcF99VbvXFcLHjxfnoMuIx6DGEmbxS5AWBcu9DXg8Hd3E6bZhnuh11HuS20XCHBbBSt/G0vpZN4ar9qwo0Lmz4CuWzxfdpFStu+er0e7YX45Mvzw5oZ/9IF2IlspAaAytRlIHnUpHx0u11LbhVJNLqbhtWdd1XcJenbz62t877eEXHZQ47u6zI8mpvyMm4EYB3CjCmQBFR5Vs0elgCwSh0YHSHvBBOj+DX/kdUYPFvgSGioaL8ywmSTpY81qKGVFBfz+9/IyF30vXnKG12kZyMJb41sse3eF8hw63lrdUIB6b6flxq7d3SAoF97jStj3iI0o9koR9kK4GLnZwX+Fw56gOuiiCdTO4bo2kRm/BV9LBHbYgBSrfa5E8997KZfCYbfkNLNaRMLzemaSW3EX9hNDIAslSh/SWgJI5mhqT5IbIV1YHI9XKAVcCCq6I7IkTKJplkLWAgnqgGeQrrkQt1YrGQOStCY3HmBt0jq/wr0O+HAMR6LmsHfClDn4CagorVGh3cA6mxyhdsCUv+khpiipBgRNyfa88pPjAG1P3eVba35axSSaFNd/LPxsqflov+URxcjl2pEHued8fUWHGugUF4qWvsW+yNDZZ+oacpu/7qt2G6wzyO+SuTYkVU71Ga6XAfu245O1Vv0Pgg0dF/N1foA/96FRN2JrX4WC6EvPu6/UUtxUmqpsKHQttqzANkaizQV/pYWNiSU/mOcvWp9m4O2Wb3aTpsu3ulG0ms6DLJruTQ7set4Fga5r4wzzkRvbjMBXYxJn4VbWdY6PZPsi9vVRSlKQXh+ARw4/avLRafMOmodfTYXNF5NtX4yMjZ9sv5HzcYuj/ErmNe82+98FEWuMaa+DBV0Q0Pd9TI161zmPzTzz0Fo446GhMlzpaHeo7bma0sVBZDLvZ3k6VMFqh3PvyCu1aFjhBerfNRBrIomAmyDWxdRr/p7qMCJPqYbC/Y13oBokMYhzPHLwZ6h2G9TMuU0IXoUHl4zW+GyYmL+LEHJaR89ErfCBmjp2WMGy4rGOpDG9/3FUGoWG08w1XEzsH6/1uuX9uRPni8Aab3ez+H3wY9IXo8cFnpuYyVmzsvc3AFXO2Po3EMXw5JCzf20y3hEFv9tfHLWcsElZp58nYZkO7+kdbdx0dfwlI5D5fEIFZyZdUwPMNE9LRs2B5yWuH30jR8w/DqvECjq/Cj15z3GVUO6FPlgxcO7kk8dG/EtBkS/4bEU3B7RZdMn5oPQ2v//Tn0xFce/we/2Tdwrwbs8TVxk/eHX4w7A3Wt2+uWcL4PrNvmXx4oBw9mt3Nppe41neoum6bbE//497S/QlrSfgY
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Get an employee's pay stub for the specified payroll. By default, an application/pdf response will be returned. No other content types are currently supported, but may be supported in the future.
+
+scope: `pay_stubs:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-people-batches-people-batch-uuid.ParamsDetails.json b/docs/api/get-v-1-people-batches-people-batch-uuid.ParamsDetails.json
new file mode 100644
index 000000000..183a1676c
--- /dev/null
+++ b/docs/api/get-v-1-people-batches-people-batch-uuid.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"people_batch_uuid","in":"path","description":"The UUID of the people batch","required":true,"schema":{"type":"string"}},{"name":"X-Gusto-API-Version","in":"header","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"},"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."}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-people-batches-people-batch-uuid.RequestSchema.json b/docs/api/get-v-1-people-batches-people-batch-uuid.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-people-batches-people-batch-uuid.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-people-batches-people-batch-uuid.StatusCodes.json b/docs/api/get-v-1-people-batches-people-batch-uuid.StatusCodes.json
new file mode 100644
index 000000000..2aa5b1f2f
--- /dev/null
+++ b/docs/api/get-v-1-people-batches-people-batch-uuid.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"successful","content":{"application/json":{"schema":{"type":"object","description":"A people batch with processing results.","x-examples":{"success_status":{"uuid":"f711ab7a-2d44-4556-b90c-9f883195f53a","idempotency_key":"95d84feb-3a17-4c0b-a00b-bf8d3dec3326","status":"pending","submitted_at":"2026-03-02T15:09:50-08:00","completed_at":null,"submitted_items":null,"processed_items":0,"excluded_items":0,"results":[]}},"properties":{"uuid":{"type":"string","format":"uuid","description":"The unique identifier of the people batch.","readOnly":true},"idempotency_key":{"type":"string","format":"uuid","description":"The idempotency key provided when creating the batch."},"status":{"type":"string","enum":["pending","processing","completed","failed","partial_success"],"description":"The current status of the batch processing."},"submitted_at":{"type":"string","format":"date-time","description":"The timestamp when the batch was submitted."},"completed_at":{"type":["string","null"],"format":"date-time","description":"The timestamp when the batch processing completed."},"submitted_items":{"type":["integer","null"],"description":"The number of items submitted in the batch."},"processed_items":{"type":"integer","description":"The number of items successfully processed."},"excluded_items":{"type":"integer","description":"The number of items excluded from processing."},"results":{"type":"array","description":"The results for each batch item.","items":{"type":"object","properties":{"external_id":{"type":"string","description":"The external ID provided in the batch request."},"role":{"type":"string","enum":["employee"],"description":"The type of person created."},"status":{"type":"string","enum":["success","partial_success","failed"],"description":"The status of this batch item."},"idx":{"type":"integer","description":"The index of this item in the original batch request."},"uuid":{"type":"string","format":"uuid","description":"The UUID of the created person."},"employee_uuid":{"type":"string","format":"uuid","description":"The UUID of the created employee (if role is employee)."},"errors":{"type":["array","null"],"description":"Errors encountered while processing this batch item.","items":{"type":"object","properties":{"error_key":{"type":"string","description":"The key identifying the error source."},"category":{"type":"string","description":"The error category."},"message":{"type":["string","null"],"description":"Human-readable error message."},"errors":{"type":["array","null"],"description":"Nested errors for sub-operations.","items":{"type":"object"}}}}}}}},"exclusions":{"type":["array","null"],"description":"Items excluded from processing due to validation errors.","items":{"type":"object","properties":{"external_id":{"type":"string","description":"The external ID of the excluded item(s)."},"reason_code":{"type":"string","description":"The reason code for exclusion."},"message":{"type":"string","description":"Human-readable explanation for exclusion."},"item_count":{"type":"integer","description":"Number of items affected by this exclusion."}}}}},"required":["uuid","idempotency_key","status"],"title":"People-Batch-Results"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided ID/UUID is valid.","type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["error_key","category"],"properties":{"error_key":{"type":"string","description":"Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error."},"category":{"type":"string","description":"Specifies the type of error. The category provides error groupings and can be used to build custom error handling in your integration."},"message":{"type":"string","description":"Provides details about the error - generally this message can be surfaced to an end user."}}}}},"x-examples":{"not_found":{"errors":[{"error_key":"request","category":"not_found","message":"The requested resource was not found."}]}},"title":"Not-Found-Error-Object"}}}}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-people-batches-people-batch-uuid.api.mdx b/docs/api/get-v-1-people-batches-people-batch-uuid.api.mdx
new file mode 100644
index 000000000..4ff482863
--- /dev/null
+++ b/docs/api/get-v-1-people-batches-people-batch-uuid.api.mdx
@@ -0,0 +1,73 @@
+---
+id: get-v-1-people-batches-people-batch-uuid
+title: "Get a people batch"
+description: "Returns the status and results of a people batch."
+sidebar_label: "Get a people batch"
+hide_title: true
+hide_table_of_contents: true
+api: eJzdWV1z27oR/Sso+nCTGdKSvxJbT3XrNPVDE0/i9N4ZR6MLEksJ1yTA4EOxRqP/3lkApEiJ8rVzO51p8xKJIs4uds+eBdZrqmrQzAolbzid0DnYdHmc1qDqEmYZs/kCTO/rzDnBaUI5mFyLGlfSCf0E1mlpiF0AMZZZZwiTnGgwrrSGqIIwElCIRzn6Kr/KW1WWxC6EISB5rYS0xCqSLyB/8ED+TVJrlYMxQs77yFYLWEJjwgOaXNUwIb/23Z9oYPxXmlDL5oZO7ultcOSv4Wc6TehjOnfGqlRIC/MQjtSuasC3ocqAc+D4Xs00q8CCRpw1lawCOqFD4REYlZrZxV6o7hZAvny5ucag4C67YaEJ1fDNCQ2cTqx2kFCTL6BidLKmwSFqrBZyTjebpHXgl/S9d//q9ib9F2iDhqILC2AcND2Mk1CQrsKNnoxPztPxm/T4HLfKoWCutHTSfb7Z3cw1BqMSEkLqObOQZswAJ1e3N2QZfCHMGJULZoGT78IuyEo57V/IWVkekZuCSCWBCIPJXgoOPAnvsLouRe7z8ZMh95WQonJVF3v6amFtbSajEVe5OfJpPMpVNWrSltZspVVZ+t9HrBZpXCnk/M8RMO08fo1uOAP8iG6mCTWQOy3syuf7b6qqmVxd5UjIK2cXdHI/3XT4o813Nm8yp8HUShowGPST8Rj/60fPOI9UuJImNFfSgrT4Vmfbo98Mvrrez5/KfoPc7tHrqkeoEO9OCTXlQtFpeGRVXQYHoy+zUGP4xDN5Qou3x8cse8vSE352lp6dn79Js8txnl4WFxenx5fnxfkpQ7ZxqGplQear2QOs6IRenvOLswKy9JQdv03P8nGWsvE4S7Pigp9yyE9PT94gMaNBWoPkgZHGZZWwFviMRQK+Scen6fjk7vh8Mr6cnI/T8cVkPPZRwx00r0pXlt3lwkJlmscxCtvH44TCY1463nsUI+RTu/GratBWQCcm+zVUKF15XwfVEUveSfHNAREcpBWFAD1U/0deABj/KMtVoNFmILI/Yr4DQh5g1RYa+b4ASXINzCI9Wtk9wlrfcuGQZmxztuVYNyvoGxOl/1AzbQUrZ5FpQWR2/cyd1iBtI/UxRrudIHjXY8kTQfGqZEUFg5HBH4xlVR1CsTX3nRnS2vAW+2RrLN5vTSLRcF9/1HSnYFubO3uOhN064XuXl/rGi32D0lVZYJ5fvt0eEXIn93vV0gZ4a+g5BhqFK1ekhfQGdkvvh/AbEFJoVe0SpK3kFpppzVaDwM1JpVCaAMsXMRFoBYty18dWfPvyAI8WtGTlbFgl9s02C8jN9bYku7kgeB4AY8OGVAlPVSNUdalWAMPJx1UYuRq0UbHmG1r9bqE3Rbtfxm2FDxrt1rEwvah6aXt8ZuKF5PDYwiBAEyalxVxgCPfj9eNq3T2gxUDFuAXuxkDP/rMWGljyShQEk41nkebh62BZa6V7dd9werjq3/n3CchcOWlBe8UXJXQlZi8zz+c7oh9qSvt7xsYTG+Cq6TYeghjldA5BZJmFudLPhAzLmzUeoAJj2ByeFOg+0D9cxWSKjZdlZYMZYX4o6h/A+HyG4KOmGJel7VXLPBHiTfwXBRKPpC8wfPOkKhLuAK9YS1YK7j2JLv63JC7yvfUPbb4yr6NaM6PkLFd8UOOGJJt5HVMcgmw38RpmwSGo3eQ/1iWTITj7qOjwzJfSM3Trw06zYkUBOfIiW8Vrbwc75Hx7+7tvpGP3+Neq9TShVljsCPFGm/obbfoptr2AeDY+2794fFCW/F05yV9y7zgAQb5KQr7KkBGvveAv/r6iCVdgiFSWwKMw9oj8kz0AMU5DOPs2Le/meuQFUZhATiTkLg+7sYkFOR0UpKGOf5Dde6gxyK0MDdt4nuh9riHHw77BA17cc1AXledOmyNyt6oF3oIjIzoKKeKdmlmrReYsjNrpA9FQ+oZh1RbyheK5dc12zgYBifiTeIRqkmSi53OtXC3kPMxhciZJBv7CjN5kTpSc5HgZruL7CyZ5ieIjZLjUd4YsL6vU28YRDpaJ0hCWKWc7QU3JHCTobTgjdOOlcbpgefCUSZw6oeO6rb7+jVgqOyt8kXSIdd/LP42M7/Jl0lnY2Rw9UCB4y8D68Atw5oCONHX9QdnUF1nq+3j6sdMjEi/FMjaI+zUNHh0cZSV0yUq3M9LCIVJ/XRhhtC/7O+gU92EXKk4I/SEQhx90tDwe9Ydto/XeNGyDkgV62UzNnC5xMBXHNqwWYWqTcqj86GYv79dQKT+vMDWwB2BmlQa81A8ocB3FjRwAHsS81Yo/gVnjz935z2eUwcCLgSlQy1w03gzb8HsGTA90hgiRlrCEkjBnF1jyQXmxJD6vjIXqj1gICAcMYCOThfKokWl+gIiDNUx9HCH2Rn8JxUmf+Vh8Br0UOXQivR26+YIc+RdHHE2jbqb+e6oKH2Fcuuvsz1DmqvJHE+/HT4a8ixQlt2F852d+XOWuAmn9Nv4UexfLfe+Ko9Drxir5hBrpiwPP60yUnirx179smeGHPMrYiskOznuwOyPrXa/X2875PzL+DgSy8GhHdcmEZ5qvmXWs53u6PMbi7q2nCZ3sT7inCV0oY3HNeo0T3y+63Gzw8TcHqIL3U9QQLfBQ5cueC4OfOZ0UrDTwRDRffYo9+TX5nWH54Jaazi9XWxmjNIk6t7+VzXSTNHPylzn6fz39PhDdEMXhvzi0wd62FdSw2nZ+2ztj9rrL+3d3NKGsL3mtxMUPmKTBJK/X4Y079QBys2lzbvG7b62bfwOTx3Jp
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Returns the status and results of a people batch.
+
+Poll this endpoint to check the batch processing status and retrieve results.
+
+scope: `people_batches:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-recurring-reimbursements.ParamsDetails.json b/docs/api/get-v-1-recurring-reimbursements.ParamsDetails.json
new file mode 100644
index 000000000..322fc00b5
--- /dev/null
+++ b/docs/api/get-v-1-recurring-reimbursements.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"X-Gusto-API-Version","in":"header","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"},"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."},{"name":"id","in":"path","description":"The UUID of the reimbursement","required":true,"schema":{"type":"string"}}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-recurring-reimbursements.RequestSchema.json b/docs/api/get-v-1-recurring-reimbursements.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-recurring-reimbursements.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-recurring-reimbursements.StatusCodes.json b/docs/api/get-v-1-recurring-reimbursements.StatusCodes.json
new file mode 100644
index 000000000..879212fed
--- /dev/null
+++ b/docs/api/get-v-1-recurring-reimbursements.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"successful","content":{"application/json":{"schema":{"type":"object","x-examples":{"success_status":{"uuid":"b739f253-b028-443b-b6cf-97a555c3d493","employee_uuid":"346e1409-1c97-4524-9ebb-0c0c169e35cb","version":"cf9b64404e63d325c762aaad20ca7a39","description":"Office supplies","created_at":"2025-11-03T09:03:24.000-08:00","updated_at":"2025-11-03T09:03:24.000-08:00","amount":"75.50"}},"properties":{"uuid":{"type":"string","description":"The unique identifier of this recurring reimbursement.","readOnly":true},"employee_uuid":{"type":"string","description":"The UUID of the employee.","readOnly":true},"description":{"type":"string","description":"The description of the reimbursement."},"amount":{"type":"string","description":"The dollar amount of the reimbursement."},"version":{"type":"string","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."},"created_at":{"type":"string","description":"The timestamp when this reimbursement was created.","readOnly":true},"updated_at":{"type":"string","description":"The timestamp when this reimbursement was last updated.","readOnly":true}},"required":["uuid","employee_uuid","description","amount","version"],"title":"Recurring-Reimbursement"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided ID/UUID is valid.","type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["error_key","category"],"properties":{"error_key":{"type":"string","description":"Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error."},"category":{"type":"string","description":"Specifies the type of error. The category provides error groupings and can be used to build custom error handling in your integration."},"message":{"type":"string","description":"Provides details about the error - generally this message can be surfaced to an end user."}}}}},"x-examples":{"not_found":{"errors":[{"error_key":"request","category":"not_found","message":"The requested resource was not found."}]}},"title":"Not-Found-Error-Object"}}}}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-recurring-reimbursements.api.mdx b/docs/api/get-v-1-recurring-reimbursements.api.mdx
new file mode 100644
index 000000000..d45a3f8a3
--- /dev/null
+++ b/docs/api/get-v-1-recurring-reimbursements.api.mdx
@@ -0,0 +1,71 @@
+---
+id: get-v-1-recurring-reimbursements
+title: "Get a recurring reimbursement"
+description: "Get a specific recurring reimbursement."
+sidebar_label: "Get a recurring reimbursement"
+hide_title: true
+hide_table_of_contents: true
+api: eJzdWE1v4zgS/Stc7mGmAclW/JGMddrGpreRw04HnfTuAu4gQ5ElmxOJVPPDiWHovy+KlG05tqfT2DntKZFEvioWX72q8obqBgxzUqsbQXO6AJeuLlID3Bsj1eLRgKwLbyzUoJylCRVguZEN7qA5/QiOMGIb4LKUnOz2kYN9g6/qq7JcN5CT3w4RcwNM/EYT6tjC0nxOPx8afEjoS7rw1ulUKgeL6Gvq1g3gaqgLEAIETShrmv6SsLVhhtXgwCD0hipWA83pf9KPAfD97U36LzAWj5JQiedZAhNgaEItX0LNaL6h0RS1Ds9FEwrK12h6lI2maXaZXkzRkoCS+crRvP++fR2ua/SllgoscUsggjlIC2ZBkPe3N2QVfSHMWs0lcyDIs3RLstbehAWcVdWA3JREaQVEWtIYvZICRBLXsKapJA/H/8mSeS2VrH3dx374eelcY/PhUGhuByGwA67r4TaQacPWRldV+D5kjUy7nVIt/toBpr3X79ANb0EMaJvsIizFNqANc8sj1twvgXz5cnNNdBnicEAJmlAD37w0IGjujIfzl9G2Dwm1yDnp1uGG/67rhqn1e87B2vfeLWk+f2h7JDL2mS22uAZso5UFi9CjLMM/h55aH5BKX9GEcq0cOphvaC/Sw98tLt0ce6mL34HjeV5SeGF1U0VDHeajdcz58MZ7iclXXI1n5Wg6Tots9Es6mYyLtLjkZTq7YtPplI/FZDZGAtZNpdcAj9228eQSLibZLL3gs6t0Mh1N0hkURZrxjF9czmA85QVNaHdhNKe8nBWXk0k2gcuxGI+m/OpyxBgTo4yzKzaeHd3Xp7KUHIj1eGpAFeAGkJ+PbMf4i4s0G99nszwb56PJIMuyNPslzzKaUN+Ity9mtfYYY3o1HUwz2rYJbQyKlJPQC9ZxXh5TzCv5zQORApSTpQQT+SbtWZ0K3GPik6rWkSPtUbjfYrjP7e32k9gHW9+C3HtzMnkwC3chfBOgripmSNxyHnJHnrdgYmxBuZ2edagxHQbkDiA8z/fKQhZeCvhBcZIC6kY7UHz9jpTaEKlKbWoWg6PIUj8Tp1Gc4qWXEqogUwfsfcuBnKzBOlY35HkJakuhXozIM7OkQz150f0U+PMsVsw60kGfMNv2lXQeE+c1nw+N77izv/GHhDrpKvT38zZr0oMiTdsWTU2yybF+/qod+Yf2SvyIfJ6BIF8VIV/VfSDoNw8WC6QBq73hSGSwRGlH4EVaNyD/ZE+oWCZybVsoyc31MGSntGTFKhnC9lqu+0EDY7SJvcSBCnXv95fJjGFrrHoOanuqCByhPj4BbuDMwUKb9RkbYdV3OXMXOzCwyJfuzGE70Zx7Ywfkft1I7B/WkUxPsN4LY+xGmHNGFt7BcNc2EQNV6EOc3kPGFNp6/QOuIQKuRUGISCTIRQe1vSTbeb4w2jdSLSxhShDOFCkgtBroTeFlJQhHiai79UumRIViIlVsh3rdYPC5BmvZAr7v8u3WEQGOycoSVmjvekFNyQIUmH04O+itl9abkvHoKVMElEDHMXIxVw4bAqXdYxmSpEes+cH9047xfb7kvY29w9EzCYKCgfkRNgxo+4CObFP7V+3SkGTpBzSafoqs7dyFFwfKhqYa/YoenW3LE7pilf9+e4794iFUbM52+4OIPeDR3FJ30wlNYkuZ0+HqYnhuThlupGixiwez2jb/3lTY4HcVhjUyFphUQB2qzBELrqHWoXmzDbAnYHadRrw0tF24L/S8Z4BPYt4aLf4As8HP/ab2DkUxsuREa7vjMRrfDi34XAAzYYw5tN5BpBWsoCLMuyUKQNRhTJC7tXVQ/y8WIsIZAy3OBKUOqB3vwiCGA8pBg9oboRKKE5P9VN6BWUkOvUjv+4OQnsOwcCjQNKpoGp5TXYYI49bXzv4bKq5rwCQNfvxkyYeOsOQ2dhphdhKae6RVOMZfukrGeKhk3cBzvbVKPqNiBoJjqWWyClTpvv5tz4zQ2GrraqZ6OHGePtOevj7AZl9S/8xBPF64gxc3bComAzMCxzdd6s3p6iIUtLM/EuRSYDlbautw+WaDQ+4XU7Utvv7mAeVr/oCZbiQrkArzDRXS4v+C5iWrLPzBaX/+3BXTd+R7s+TJ42xrtlrv1YbSpJMjiTnYJtsfA37Mtf/rEf9MOGPYTv+ssovuXu5RYBrX+3bUDh6o/scP91g/DvVopz/dP3hJJ291s4kr7vUTqLbdXbLD51AF2/8CUl+gyg==
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Get a specific recurring reimbursement.
+
+scope: `reimbursements:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-salary-estimates-id.ParamsDetails.json b/docs/api/get-v-1-salary-estimates-id.ParamsDetails.json
new file mode 100644
index 000000000..ce5d5820f
--- /dev/null
+++ b/docs/api/get-v-1-salary-estimates-id.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"X-Gusto-API-Version","in":"header","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"},"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."},{"name":"uuid","in":"path","required":true,"description":"The UUID of the salary estimate","schema":{"type":"string"}}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-salary-estimates-id.RequestSchema.json b/docs/api/get-v-1-salary-estimates-id.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-salary-estimates-id.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-salary-estimates-id.StatusCodes.json b/docs/api/get-v-1-salary-estimates-id.StatusCodes.json
new file mode 100644
index 000000000..92c855805
--- /dev/null
+++ b/docs/api/get-v-1-salary-estimates-id.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"successful","content":{"application/json":{"schema":{"type":"object","description":"A salary estimate calculation for an S-Corp owner based on occupation, experience level, location, and business revenue.","properties":{"uuid":{"type":"string","description":"The UUID of the salary estimate.","readOnly":true},"employee_uuid":{"type":["string","null"],"description":"The UUID of the employee this salary estimate is for.","readOnly":true},"employee_job_uuid":{"type":["string","null"],"description":"The UUID of the employee job this salary estimate is associated with (once accepted).","readOnly":true},"annual_net_revenue":{"type":["string","null"],"description":"The annual net revenue of the business used for salary calculations."},"zip_code":{"type":["string","null"],"description":"The ZIP code used for location-based salary calculations.","pattern":"^\\d{5}$"},"result":{"type":["integer","null"],"description":"The calculated reasonable salary estimate in cents. Null if not yet calculated.","readOnly":true},"accepted_at":{"type":["string","null"],"format":"date-time","description":"The timestamp when this salary estimate was accepted and finalized.","readOnly":true},"created_at":{"type":"string","format":"date-time","description":"The timestamp when this salary estimate was created.","readOnly":true},"updated_at":{"type":"string","format":"date-time","description":"The timestamp when this salary estimate was last updated.","readOnly":true},"occupations":{"type":"array","description":"Array of occupations with their experience levels and time allocations.","items":{"type":"object","properties":{"code":{"type":"string","description":"Bureau of Labor Statistics (BLS) occupation code."},"name":{"type":"string","description":"Occupation name."},"description":{"type":"string","description":"Occupation description."},"experience_level":{"type":"string","description":"Experience level for this occupation.","enum":["novice","intermediate","average","skilled","expert"]},"time_percentage":{"type":"string","description":"Percentage of time spent in this occupation (as decimal string, 0-1)."},"primary":{"type":"boolean","description":"Whether this is the primary occupation."}},"required":["code","experience_level","time_percentage"]}}},"required":["uuid","employee_uuid","annual_net_revenue","zip_code","created_at","updated_at","occupations"],"x-examples":{"success_status":{"uuid":"7f5d3d93-6d6f-48c0-9f4e-cd12c2d3e4b2","employee_uuid":"8c290660-b6c9-4ad7-9f6e-ea146aaf79e8","employee_job_uuid":null,"annual_net_revenue":"500000","zip_code":"94107","result":12000000,"accepted_at":null,"created_at":"2025-01-15T10:30:00.000-08:00","updated_at":"2025-01-15T10:30:00.000-08:00","occupations":[{"code":"15-1252","name":"Software Developers, Systems Software","description":"Research, design, develop, and test operating systems-level software.","experience_level":"skilled","time_percentage":"1.0","primary":true}]}},"title":"Salary-Estimate"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided ID/UUID is valid.","type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["error_key","category"],"properties":{"error_key":{"type":"string","description":"Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error."},"category":{"type":"string","description":"Specifies the type of error. The category provides error groupings and can be used to build custom error handling in your integration."},"message":{"type":"string","description":"Provides details about the error - generally this message can be surfaced to an end user."}}}}},"x-examples":{"not_found":{"errors":[{"error_key":"request","category":"not_found","message":"The requested resource was not found."}]}},"title":"Not-Found-Error-Object"}}}}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-salary-estimates-id.api.mdx b/docs/api/get-v-1-salary-estimates-id.api.mdx
new file mode 100644
index 000000000..0b7d49c49
--- /dev/null
+++ b/docs/api/get-v-1-salary-estimates-id.api.mdx
@@ -0,0 +1,71 @@
+---
+id: get-v-1-salary-estimates-id
+title: "Get a salary estimate"
+description: "Retrieve a salary estimate by its UUID. Returns the estimated salary calculation along with all occupation details, revenue, and location information."
+sidebar_label: "Get a salary estimate"
+hide_title: true
+hide_table_of_contents: true
+api: eJzdWW1v47gR/issr8AlgGTL2SS70afmLukiwN1usMm2RZPUR5NjmxuK1JGUE5+h/34YUrLlt6RBDwXafLEtDYcP5+WZ4WRBTQmWeWn0laA5nYBPZ4PUMcXsfAjOy4J5cKkUNKECHLeyRGGa0y/grYQZEEaiOGnFyWhOpHfk69erix75Ar6y2hE/haWEaJdwpnilwv6EKaMn5En6KWFKEcN5VcY3AjyTyiXEwgx0BQlhWhBleHwt9djYInzv3et77bgpISe/bJ4it8DELzShnk0cze/oTQRx2QrQh4Q+p5PKeZNK7WESLZP6eQkoD8UIhAC0BSvLrkhYWjLLCvBgUfmCalYAzek/0o9B4fn1Vfo3sA6tl1CJJpwCE2BpQh2fQsFovqBxK+q8lXpCEwq6KnDro+zoJM1O08EJ7iRgzCrlad59Xm966AKxFFJDNL5gHtIRcyDI+fUVmUUshDlnuAxOCbafm8oGAc6U6pGrMdFGA5GOlNbMpACRRBlWlkpGF3zvyF0htSyqoqv74WDqfenyfl8Y7nrBsD1uin5ryLRkc2uUCu/7rJRps1LqyXeNwrTz+BBhVA5Ej9bJ0sJVFcIzmLRkfkoTauHXSloQNPe2gk3D3E4hBCcx42CZjfh9wSF1/ZBQB7yy0s+Dl380Rcn0/JxzcO688lOa3z3UnUCy7olNWhwWXGm0A4eqj7IMP9axuSpoGleKJpQb7UF7lOpYu//NoehiG6UZfQPut1L1fCtDu3k3NpYwTW7SH40tiXnSYEkME6M7WZgQeC7BStAciIIZqGSZgjEhR5XDYHNtmvZoQkuLBONlPHHw1I4of5N7esG/THzWah7tWicUilKZOcBwfYu71R66Uirmzkt7tXqIn0q3ZTbp0FovA/hmRn8YiG9mtBfIZt4eGHQM4xxKD+JwJ0imdcXUUIMfNj56I8qogGjwrZNbzEvnY3qGmNqmeIdpS3+T5ZAb8dat/3l1TXDZaoM2+hpS27kfsrL3YFHLv+7vxeKk/jOCsOACga4gBDYPbLwfQ6sbBLHAnNFspLbik0hNOGjveuRTpRSRyKCezMF31u92T+O8IfMvGieWO5rTQOleFrAzh/CF86woydMU9O5AemJuGTMhicdSMyV/24OQW2CbAFf4/mBczWY7gVSl+O8BUcx50uy4E82KJV0HDrOWzbfJGJ9i1nQWxQz2U5B2i2VdcAtCxbaoCfkQ2dJD4Xax/zrprufaPtL9obLAKsT1ExsZS24889J5yR05+OGnm8NuP4YaQyrHAvya6s+rlbigt9WpvEFB50XQs7LWMFjrdWWXG/YNVBJcvzphr9N5aTOTHEJ/ge0UCBlbBDYDyyahWXiUSoWuMKDx9KFOKDpsWIJFJkCxV3FdL2UDpaK/XQnaI51swCMHzBEBXBZMkaguIVk6OAwmKa0smJ13dhwZo4DprS3/PgU/heb0MnaJzeo1Y9R1t6O6ixG1w/bbp36oN9c2zdp6vd5ZmTqVYo141pJ/PfdC2wXPrChVjP2mmxo6z3zVaUHo+/GJeCfO3qWn4nScHn/gWXo2PoaUi8ERPxLv4Hh0tAUzpx/40Vl2epqlo1N+lh4z8T49G59CCmxwfMrY+P0ZfKA7mwHk7t0FmJ5k+Nc9b07PjgfZe7qqU4OjIJRtFImotcvKzY1gkA5ObgdZ/i7Ls6yXZVmafcjDJl3mfFV4jdjuWi6hg5N0cHSCBmpa8Bsz9k/MArnAQED2cQm5mTtkKNK+3HGFdMAsnyaY1nKi8TMsj/2kB+dJcz/VE+KiujRmrWuU9nYFYt7Jya1EpINeRjtpEjj8oQ4561U4TagBaXsvpHWI4uPseLtd/2Q8+auptHhLt75HBbnXhNxrrEyYMeBin+FMZTkQYcCFRgKepfM98jN7BOIqC03axrsZubroh1ZSOjJjSoZ6tVkfuvkI1hobr69rVaN5vl3N9ladLa3DR8AFnHmYGDvfs0eQepUdb0rgcizBYaluzhyWB6Kyrkdu56XEK+s80tkjzIkUoH1chfLMeytHlYf+8qZOLMR2zpuVysCiS9RvgIYaUBYJPGoisWuMqlonuQb5xJqqlHoSKzxnmoya7tYbMqqkEoTjFbJo5KdMC4WZIHW8gXcGEAFzAc79e7WmBdJMVggbmcp3jJqSCWiwK3M2qluUrrJjxiNSpglogcDRcjFX1llYGz8chyTpBNbdmv9pE/HdeMk7CzuHo3sSBDs1zI+woEfXU/qT8WlIsvQSN00/x6ht4MKzB+2WLBcR7Z0EJXTGVPX6RAhHFOuq4ixguT4yDx7NT00zfos3linNaX826G+OsPoLrCY1Nh1gZ+2kqbJIee2shZUyjlpSAUWYt2z5/wIKQ9FLrgT2CMzN06gvDVUO14UByx7FO3VeWyNe0Fni6+705AbpMMbHjhnKMoJx83YgE3oZYDbc0tZ3b1Q0xYFVfoqpHxkYUyPWov9kh6hhzwY1todjE7Q2ERemfjgNQ383c7+1eV1CsZ90n8c3YEOLubL0alIWErMfBPuira1p+J2acbBw7E43OjtQ3BSA6RlwfO/IZROq5DrO3MKgThheFVgYcd2fmhrGeKhhTWlfVnTyBZprdehwmFQhVJq3f1lFBlqjNM4XTHf0fAS/PSreBL5YFdH/6QFzjCwPz75fKiZDCIZkWjTZfUdnAwy6DQ00oXnoFx8SOjXOo+BigfONr1bVNT7+tQLkxrsHpBErcQIRSEBIh98FzcdMuc2ZZ9ewB1+aSn1IXp+E7jxK2xLo+YrMKE0atgsHqPES1Ay43wbv/3psvceg0XC7/1WwtO+qnpyHO0Dn3Va/uVZWPl7eYoFap70lzTVf0Ek7/bpYRIlb8wi6rpdu9vg7lNn6d046L1c=
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Retrieve a salary estimate by its UUID. Returns the estimated salary calculation along with all occupation details, revenue, and location information.
+
+scope: `salary_estimates:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-salary-estimates-occupations.ParamsDetails.json b/docs/api/get-v-1-salary-estimates-occupations.ParamsDetails.json
new file mode 100644
index 000000000..f6e1aeb5c
--- /dev/null
+++ b/docs/api/get-v-1-salary-estimates-occupations.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"X-Gusto-API-Version","in":"header","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"},"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."},{"name":"search","in":"query","required":true,"description":"Search term for occupation (minimum 3 characters)","example":"software","schema":{"type":"string"}}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-salary-estimates-occupations.RequestSchema.json b/docs/api/get-v-1-salary-estimates-occupations.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-salary-estimates-occupations.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-salary-estimates-occupations.StatusCodes.json b/docs/api/get-v-1-salary-estimates-occupations.StatusCodes.json
new file mode 100644
index 000000000..475352fe0
--- /dev/null
+++ b/docs/api/get-v-1-salary-estimates-occupations.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"successful","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","description":"A Bureau of Labor Statistics occupation code with its title and description, used for salary estimate calculations.","properties":{"code":{"type":"string","description":"Bureau of Labor Statistics (BLS) occupation code.","example":"15-1252"},"title":{"type":"string","description":"Occupation title.","example":"Software Developers"},"description":{"type":"string","description":"Occupation description.","example":"Research, design, and develop computer and network software or specialized utility programs."}},"required":["code","title"],"x-examples":{"success_status":[{"code":"15-1252","title":"Software Developers","description":"Research, design, and develop computer and network software or specialized utility programs."},{"code":"15-1256","title":"Software Quality Assurance Analysts and Testers","description":"Develop and execute software tests to identify software problems and their causes."}]},"title":"BLS-Occupation"}}}}},"422":{"description":"unprocessable entity - search term too short","content":{"application/json":{"schema":{"description":"Unprocessable Entity\n \nThis 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.\n","type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["error_key","category"],"properties":{"error_key":{"type":"string","description":"Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error."},"category":{"type":"string","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."},"message":{"type":"string","description":"Provides details about the error - generally this message can be surfaced to an end user."},"metadata":{"type":"object","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.","oneOf":[{"type":"object","description":"multiple entities","required":["entities"],"properties":{"entities":{"type":"array","items":{"type":"object","description":"single entity","additionalProperties":true,"properties":{"entity_type":{"type":"string","description":"Name of the entity that the error corresponds to."},"entity_uuid":{"type":"string","description":"Unique identifier for the entity."},"valid_from":{"type":["string","null"]},"valid_up_to":{"type":["string","null"]},"key":{"type":["string","null"]},"state":{"type":["string","null"]}},"title":"Metadata-With-One-Entity"}}},"title":"Metadata-With-Multiple-Entities"},{"type":"object","description":"single entity","additionalProperties":true,"properties":{"entity_type":{"type":"string","description":"Name of the entity that the error corresponds to."},"entity_uuid":{"type":"string","description":"Unique identifier for the entity."},"valid_from":{"type":["string","null"]},"valid_up_to":{"type":["string","null"]},"key":{"type":["string","null"]},"state":{"type":["string","null"]}},"title":"Metadata-With-One-Entity"}]},"errors":{"type":"array","description":"Will only exist if category is `nested_errors`. It is possible to have multiple levels of nested errors.","items":"circular(Entity-Error-Object)"}},"title":"Entity-Error-Object"}}},"x-examples":{"bank_account_delete_unfunded_payments":{"errors":[{"error_key":"base","category":"invalid_operation","message":"FundingMethod has unfunded payments"}]},"bank_account_verify_incorrect_deposits":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Your bank account cannot be verified. Please check the test deposit amounts."}]},"bank_account_verify_already_verified":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Your bank account has already been verified."}]},"bank_account_missing_routing":{"errors":[{"error_key":"routing_number","category":"invalid_attribute_value","message":"Routing number is required."}]},"payment_configs_missing_parameter":{"errors":[{"error_key":"base","category":"missing_parameter","message":"At least one parameter must be provided"}]},"payment_configs_invalid_fast_payment_limit":{"errors":[{"error_key":"fast_payment_limit","category":"invalid_attribute_value","message":"Fast payment limit should be a number"}]},"pay_periods_invalid_end_date":{"errors":[{"error_key":"end_date","category":"invalid_parameter","message":"End date cannot be more than 3 months in future"}]},"company_industry_selection_naics_code_required":{"errors":[{"error_key":"naics_code","category":"invalid_attribute_value","message":"Naics code is required."}]},"company_industry_selection_naics_code_invalid":{"errors":[{"error_key":"naics_code","category":"invalid_attribute_value","message":"Naics code must be equal to 6 digits."}]},"company_industry_selection_sics_codes_invalid":{"errors":[{"error_key":"sic_codes","category":"invalid_attribute_value","message":"Sic codes must be equal to 4 digits"}]},"time_off_policy_name_required":{"errors":[{"error_key":"name","category":"invalid_attribute_value","message":"Name is required."}]},"time_off_policy_unlimited_invalid_accrual_rate":{"errors":[{"error_key":"accrual_rate","category":"invalid_operation","message":"Accrual rate must be blank for unlimited policies."}]},"time_off_policy_pending_requests":{"errors":[{"error_key":"time_off_policy","category":"invalid_operation","message":"Cannot deactivate policy with pending time off requests."}]},"time_off_policy_employees_required":{"errors":[{"error_key":"employees","category":"invalid_attribute_value","message":"Employees are required."}]},"time_off_policy_unlimited_balance_update":{"errors":[{"error_key":"base","category":"invalid_attribute_value","message":"Can not adjust balances for unlimited policies."}]},"holiday_pay_policy_already_exists":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Company already has a holiday pay policy."}]},"holiday_pay_policy_not_exists":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Company does not have a holiday pay policy, please create one"}]},"holiday_pay_policy_invalid_employees":{"errors":[{"error_key":"employees","category":"invalid_attribute_value","message":"Invalid employee uuids provided."}]},"onboarded_employee":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Cannot delete onboarded employee"}]},"invalid_attribute":{"errors":[{"error_key":"base","category":"invalid_operation","message":"There is an error in the request body."}]},"company_cannot_enable_contractor_only":{"errors":[{"error_key":"contractor_only","category":"invalid_attribute_value","message":"Contractor only cannot be enabled for existing companies."}]},"company_missing_parameter":{"errors":[{"error_key":"base","category":"missing_parameter","message":"contractor_only is required."}]},"starting_after_uuid_invalid":{"errors":[{"error_key":"starting_after_uuid","category":"invalid_attribute_value","message":"Parameter 'starting_after_uuid' does not correspond to a valid event."}]},"resource_uuid_invalid":{"errors":[{"error_key":"resource_uuid","category":"invalid_attribute_value","message":"Parameter 'resource_uuid' does not correspond to a valid resource."}]},"payroll_gross_up_invalid_net_pay":{"errors":[{"error_key":"net_pay","category":"invalid_attribute_value","message":"Net pay must be a number."}]},"payroll_accruing_hours_invalid":{"errors":[{"error_key":"base","category":"invalid_attribute_value","message":"Hours cannot be negative."}]},"payroll_cannot_cancel":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Payroll cannot be canceled."}]},"frozen_payroll":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This payroll has already been processed. Its data cannot be updated or altered."}]},"frozen_payroll_processing":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This payroll is being processed and cannot be updated at this time."}]},"unmodifiable_payroll_type":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This type of payroll cannot be modified or processed. It is reserved for system processes."}]},"invalid_employee_uuids_format":{"errors":[{"error_key":"employee_uuids","category":"invalid_attribute_value","message":"Parameter employee_uuids must be an array."}]},"maximum_employee_uuids_surpassed":{"errors":[{"error_key":"employee_uuids","category":"invalid_attribute_value","message":"Exceeded maximum of 100 for lookup."}]},"invalid_employee_uuid":{"errors":[{"error_key":"employee_uuids","category":"invalid_attribute_value","message":"Invalid Employee UUID(s).","metadata":{"entities":[{"entity_type":"Employee","entity_uuid":"invalid-uuid-123"}]}}]},"payroll_blocker_missing_bank_info":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must have a bank account in order to run payroll.","metadata":{"key":"missing_bank_info"}}]},"payroll_blocker_missing_employee_setup":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must add employees in order to run payroll.","metadata":{"key":"missing_employee_setup"}}]},"payroll_blocker_missing_federal_tax_setup":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must complete federal tax setup in order to run payroll.","metadata":{"key":"missing_federal_tax_setup"}}]},"payroll_blocker_missing_bank_verification":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company bank account must be verified in order to run payroll.","metadata":{"key":"missing_bank_verification"}}]},"payroll_blocker_suspended":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company is suspended and cannot run payroll.","metadata":{"key":"suspended"}}]},"submission_blocker_missing_selection":{"errors":[{"error_key":"submission_blockers","category":"invalid_attribute_value","message":"Submission blockers selections required"}]},"submission_blocker_invalid_option":{"errors":[{"error_key":"submission_blockers","category":"nested_errors","metadata":{"blocker_type":"fast_ach_threshold_exceeded"},"errors":[{"error_key":"selected_option","category":"invalid_attribute_value","message":"Selection is not available to resolve Fast ACH Threshold Exceeded. Please choose one of Wire In, Move To Four Day"}]}]},"invalid_version":{"errors":[{"error_key":"base","category":"invalid_resource_version","message":"You are attempting to update a resource using an out-of-date version."}]},"signatory_email_required":{"errors":[{"error_key":"email","category":"invalid_attribute_value","message":"Email is required"}]},"signatory_company_already_has_signatory":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Cannot have more than one signatory in a company. Please remove the existing signatory before adding a new one."}]},"mixed_disbursement_errors":{"errors":[{"error_key":"disbursements","category":"nested_errors","metadata":{"contractor_payment_uuid":"invalid-uuid-1"},"errors":[{"error_key":"contractor_payment_uuid","category":"not_found","message":"Disbursement not found."}]},{"error_key":"disbursements","category":"nested_errors","metadata":{"contractor_payment_uuid":"d0dfa222-ad08-4ea7-a06a-717688c3b179"},"errors":[{"error_key":"payment_method","category":"invalid_attribute_value","message":"Payment method must be one of: Direct Deposit, Check."},{"error_key":"payment_status","category":"invalid_attribute_value","message":"Payment status is not valid for payment method 'InvalidMethod'."}]}]},"not_found":{"errors":[{"error_key":"request","category":"not_found","message":"The requested resource was not found."}]},"finish_onboarding_incomplete":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Company is not ready to exit onboarding."}]},"company_location_validation":{"errors":[{"error_key":"street_1","category":"invalid_attribute_value","message":"Must include a street address"},{"error_key":"city","category":"invalid_attribute_value","message":"Must include a city"},{"error_key":"state","category":"invalid_attribute_value","message":"State is in the wrong format"},{"error_key":"zip","category":"invalid_attribute_value","message":"Please enter a valid zip code (e.g. 12345)."},{"error_key":"phone_number","category":"invalid_attribute_value","message":"Phone number must be 10 digits"}]},"conflict":{"errors":[{"error_key":"request","category":"duplicate_operation","message":"A resource with these attributes already exists."}]},"invalid_parameter":{"errors":[{"error_key":"request","category":"invalid_parameter","message":"The provided parameter is invalid or missing."}]},"flow_invalid_entity":{"errors":[{"error_key":"entity_type","category":"invalid_attribute_value","message":"Invalid flow entity"},{"error_key":"entity_uuid","category":"invalid_attribute_value","message":"Invalid flow entity"}]},"flow_nested_options_errors":{"errors":[{"error_key":"options","category":"nested_errors","metadata":{"flow_type":"company_forms"},"errors":[{"error_key":"form_types","category":"invalid_attribute_value","message":"Supplied value 'invalid' contains no permitted values"}]}]},"basic":{"errors":[{"error_key":"base","category":"payroll_blocker","message":"Company must complete all onboarding requirements in order to run payroll.","metadata":{"key":"needs_onboarding"}}]},"contractor_payment_invalid_wage":{"errors":[{"error_key":"wage","category":"invalid_attribute_value","message":"Wage must be greater than or equal to 0."}]},"contractor_payment_cannot_cancel":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Payment has already been processed and cannot be cancelled. Contact support directly."}]},"time_off_request_cannot_delete":{"errors":[{"error_key":"base","category":"invalid_operation","message":"This time off request cannot be deleted."}]},"resource":{"errors":[{"error_key":"first_name","category":"invalid_attribute_value","message":"First name is required"},{"error_key":"date_of_birth","category":"invalid_attribute_value","message":"Date of birth is not a valid date"}]},"nested":{"errors":[{"error_key":"contractor_payments","category":"nested_errors","metadata":{"contractor_uuid":"72ae4617-daa9-4ed7-85e0-18ed5d0ee835"},"errors":[{"error_key":"hours","category":"invalid_attribute_value","message":"Ella Fitzgerald is paid fixed wage and hours cannot be set on a contractor payment"}]},{"error_key":"contractor_payments","category":"nested_errors","metadata":{"contractor_uuid":"2d7bf62c-babf-4a12-8292-340e2d9cab28"},"errors":[{"error_key":"wage","category":"invalid_attribute_value","message":"Isaiah Berlin is paid hourly and wage cannot be set on a contractor payment"}]}]},"compensation_invalid_rate":{"errors":[{"error_key":"rate","category":"invalid_attribute_value","message":"Rate is not a valid number"}]},"compensation_invalid_payment_unit":{"errors":[{"error_key":"payment_unit","category":"invalid_attribute_value","message":"Payment unit must be one of Hour, Week, Month, or Year"}]},"compensation_already_processed":{"errors":[{"error_key":"base","category":"invalid_operation","message":"Compensation has already been processed on payroll."}]}},"title":"Unprocessable-Entity-Error-Object"}}}}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-salary-estimates-occupations.api.mdx b/docs/api/get-v-1-salary-estimates-occupations.api.mdx
new file mode 100644
index 000000000..f97739002
--- /dev/null
+++ b/docs/api/get-v-1-salary-estimates-occupations.api.mdx
@@ -0,0 +1,77 @@
+---
+id: get-v-1-salary-estimates-occupations
+title: "Search for BLS occupations"
+description: "Search for Bureau of Labor Statistics (BLS) occupations by name or keyword. This endpoint helps users find the appropriate occupation codes to use when creating or updating salary estimates."
+sidebar_label: "Search for BLS occupations"
+hide_title: true
+hide_table_of_contents: true
+api: eJztXNlyHLly/RW4/CApooub1uGTqe0OI0ZXvCJl+YZGUUQXsrsxrAJqAFSTLQa/wi9+8y/6ExyZAGrrRWyKfLBjJmJCUheQeZDIDYnlOtEVGO6kVsciOUym4NL5fmp5wc0iA+tkyR3YVOd5XVEzm4wSATY3ssJ/JofJKXCTz9hEG/a6NsBrpifsNz7Whp067qR1Mrfs8evfTp+wDh02XjDFS2DasAtYXGojdtjZTFoGSlRaKsdmUFSW1RaMZROpBHMzYLyqjK6M5A465FiuBVjmNDZnlzNQLDfAnVRTZFBXwv/dj4w1I9v5Xf2uPoGrjbKMs0Jah/BL7vIZ9e0AvpRuhhCk8dxGzElX4J9cCdYRiqf6P//9n//FThfWQcmO8hysZUe1m4FyMieK2Kg/4NriGGbAvr4GbsBQB2bzGZTQsGeWaKYFzKFg3FN2+gIUk4oa/Hp2dkJdtZHfvXhmwAWYb49nzlX2cHdX6NzuTGvr9E6uy10oxyAEiLTiC6OLgr7vBkaexROEa3NdwSE7HyrIoQEuzpNR4vjUJodfk1Mv53exQfJtlFylxDCVysHUK13qFhVg+wggGSW8qrpNqGvFDS/BgUHi1wnqTXKY/Ef6NyJ4dHKc/jsYi/o4SiQqpR9vMkpIeDw5vE48q8Q6I9U0GSWg6hJZH+wdPE/3XqT7z5GTgAmvC5ccdn+/Ger8W8RSShWmS3AH6ZhbEOzo5JjNPRbGrdU5Kqrwk7fQtaEGOS+KHXY8YUorYNKyyui5FCBGvg2vqiIoySPLvpZSybIuu7S3nEleyTT0lGr6r4Fg2vn5CcKoLYid5GbUSNiSbUeh/lmDWSSjxMCftTQgkkNnaljjD1BA5BQ6Rvo4juQpy2fc8Bxn9AnOxRUvq4I46om75AY2TN3NzbdRYiGvjXQL0gdvZd7IUO+Tw6/fbjoaZ+wln0a0BmyllQWLlA/29vCP/ghsTZQmdZGMklwrB8phq8607P5hsen1MkhuDEchSQel7fyux39A7pa859Empznwb16LpLPe8Qzdzojmj2Q+cHOocHldeHvaSUYJulAwTnohIO1VFtJHuoVzJ7Q7vXndf57uHzw/QFMi8D/m97ElRz369E6DnrC36AZxNHbJTLfg0PnQ5/MJvA2MsImcqujsiSnLdVnVDgz9qMBdanPBogpj4LEV5JIX8jsIVjtZSLdAY58aXtqd5Oama0xf/UREAZH+BiA0TUEtM+u4q70j9DPXCLeR7UrxDIf/sEMbDdC9WIXuHzWnfkfW1oarHNiR4sXCOktsz8C6VcjDoKgNXEFeO2ihOcDuTjMpMNZOFu2nyuhxAaUnHiI5x6C7k9x8azUzef3badoqR3KD/42SZwcHy76iVpXROC18XABDhm7BUmY7TtBpzexMG7eNN+lz+dzj8o64/K4YCwlEyRdsxqsKlE99MCaNtVigsVJAQSUD6xiy51JZBsZoY5mt8xnjlp1LNeeFFBl3zshx7SCb86KG8xHONJKLFCZcFpaJGlDCXLU9m0TyfIedAvg05p1n84Y7mGojwW4Ztwhmmjfdn7BpLQWQjyu1ASbAIaCd3zHyDz1t17T8gCmX6Pm+8PsW/nuJanYB2CGgXKzhQa1+6JJO0agmEixOpPFSpO7kXY3dYWeLSmL+sGAOp/4CFlHRZchGmjncbdImZqCgPMTpliQaaYt6C2hIAduienlK7GyGQcaTitlM0DI2NbqupJp6s8u5YmPwocppNq5lIViOelCG9jOuRIHJt1ReezvZIGVNDSNp2blCHyEyP4/nIwLn54pdyqKIKs848y3ZeWjKwiQtfFgNpus/kmhKtLfpLSLVSRxv0EbGx7p2nblL2RQUmHbWAukoDFubCc+9QLjC9QCtegIKxwV3/MepxJto3AYKmHPlMC/lPU/oLdnq2uSA4iWbxvhHbiN4pHEBO+y9NiwEn1GPBOEjUZ37PzNEdU5zG3+paynOvfjH0CS3GFi1go8TCl2bx1LWhZNV9KhoRwPDiz8vG1v8cueUzEo1bXw5LkiEkPiJFycdTj6ZXMHbC+THWvN3WvxOvJp4iboZ76pNro1PVgXGM9KGjoB/zOGzkn/W0LoHQ36z5UcUvfeeGF22BL+2FFVdFMm3pl1dZU5vbtjzc6saYP4Cm5p0IvGHoP3pF+lm6UcFqQ9+yc36Vh+C7vimODWYjPw15//35xwprQ3YfTl8QeejVbFgcIVFHbkxbOywY0frcG2txBTLaTbjc2CNH6Jqi8W5C2EkBorGrSS5NLjIMo893JSSn/QjKdyTpDvCFQ28QvcT/jFXFxnPc10rlwkowEFWq0mtBIis4osSlOslMV97uUaCFYluYnKYLCVrSSfMJe9rJaSafgA304LNuGWRG2u40Rz0gM3ByMkik4pUN0eklbbyXpH9E9MA5MoCV4ycSjsML8RfgthhJwVwCyyfQX7hkxTMWAMcxkvsGFP9VUPgBZaxFlmk+KADQPEGhmwMoNpxrABYSoseKjO6xjLmBmChRabqckwFsBUQB0l+D+gn35/5/mgTMewGXEETslyriZzaBlqTa24lteXeXTBHjuGUOoZlsjaZLWvruonFamBxtBNuXbSWrJCldBsQrmi8tQjfI+JAgxENXP7VhUDMPEi2wZxVYKQWLV5QIhPBW65B2TRZiW21LN/h2t7XgqLl0ArKzbhiT1mplZtZzAkntasNeHxYBOAKjVvU1plFZqGAHLU7U1zmNsMlftYmZmsRt623l+ffsa8vgC2r4+0QBjYPDzCqJvxZ8wKjyAsm5FQ2bmcDXBsB2FvAtTL3bbdHeyrzsFuyBPZZABurISVkejLJKl3IfJFhTfh2c13eSYjlqvkdgqgVWRSIxl54npuaF5nZbDO9Zlt47iPfj2G/RmLjAl05ZlYNHkYAZaeW1AdeAQXXLBRSNkXHQddt0L7xxi2A507OEbKn4de4AQNDBkxPJrGqsw4zlFWhFwD2NtPeNN5+7t/FrgyrdLfWgDEvsGaY0e7eprlfH603oXrDFUNhcvEHTbvnZjdP+0wXUqBXx/894JhWUCJ6n1nRG+9MmjSCUgoWEGAECpO/HprS7uFgCQ2WBEiZ9CpgI1aFlA33agHD/FqoTXhs1OxBVPHYt2GRBMNll+3UMAifVmPNDabhsd19yi/aMCb8rGHVQPIQlgZzjwjOqPYoLRV7aFkadpZjFRiLy4OI5tOKDBTWjzAJc7i/p02Gi7AN2IYttzfThoBf77X5jcfid8RIy9H3ebytwUb8D5nHDsa4IsxZxw3l7XziwNBa/zZZwHKv7eV30uTVj1bQe9SacVuaoDolC4YyB+XCKGJp8bb4e+1/CnmP0g8xx9btkga3HLKp0dZiuSMyV0CLgU25TmixfboDtEZoMoq4LhhAoqwFZ2Sma3ObxPBuoe5XpN6xHAVT7uR8KKBg4znGweIe/c2Jp98B4Fk05jEx+juoLOC4V0+HVZ/AfmlJHjbdsLZw7Kwvp7cYfdohcIeMFw7MGrRZoLJ53f5TwKVlY0Dn1gCOWy0DqFRqlJYSwAC2VqUWciLJbUfIsZp5n2DjjlG1NNkegJdkT+TeUVow83iuwR+nio2iDx/mBuQFbDbRpuSbVvv99j/jgPqUWqtWjMqTAWfJr/D4yxCnrU3FccwPCPXdVQ6AWUTAgDOxv7dHUi20vqirTbJ8QGAx4YprAPb58/Hbx/bJTtLf+2r3db4Oiu7N8iEZ1Moj/xT/me4fPMUR9hzauND5BZgm+FPRTaqJ3kr5B9RWJsOkESER7tUBpWLaCDAYn0ytonkMh+95L+PcPJ5mciy4unqYQXHRpqb2bsMZwNw8pgkI3ErNHL96yGFhXkgJeODHHL9ixO9uY1yGfQtV9DVhf0jk3ofZU8PosWIV+if0sgd69SBtbbEWsWWJ/TaDknioJRDvBsEfDqGF5CHbekyj0mppapqa3abUfKn7XUp1DREWibCGebuGSNYBbqPyz6LtbZcN5Be5BW9MJXSezzI3M2BnuhAZhOCTdPbvhghoWNBg3V5WUS6oAlS2mXNZ8LCZhxl/MQdGtfmjN7+yswiOxcjY2T/S2lIxAoPkF2mAHasR+6DnwM40e49bOW85bUd2A2Y4SHuntKlZvsybY8y9vSOqi3HnoKxoEYvn3CmlY7w9z1GjcmLKoWuX6klK3wPBuMyUU8WdxqPbJZfF7cp6XBZ3KelxWXQXukMAcd0dq2MzbrPm6/1XU/xubrPhgZPbcGN0PCgAatTAQIkzTlvnsXjQdhnDBInhOQEUOlNwiURjoievQGRC2nFtLNBmUrtvvWZg3dZbWF+nthD3rVZmPxtsbx2JPgbtsomulehJ920HNFkdNfFSeODhiT0x4QcHBykXe6/SZ8BfpnzvBU9f7r988epV/nS8//KXDYOO1Era7b5L7u83+Hz/Jn56r3HI3krcC2dv/ebziL3BTWl/LHYVinCm984ofP/o+nxGjal91Uf5KGTbfov/0U70Ye3kbirWUO3vNlpx1pYKoa22sEtuhzqSTKSSdpaFKidGVzxI4FOvB6hJBwH5Nb7TaNmOtcwHNcFC+ywmI9I/ysKsMwAu299+Fj+g8kiVF7VAj+4JoW8xYO2SzuT+iNLP8SAiQ8r+lM72oRe7oWhDlfjSaDVlYfU95PFdVndQc++SQdGB9KDf32XlN10fw850h+0fPH32/MkKE5tpBXc+D3GCveNpiGjk+3u9jVI8cVDIfFOlYaXxiNqfAId1W48d0wmXv2zneG9brPJbOIMF/G0K2SthbT5HgLYdd0M6ZzJo9v284NlsnylHGy/0Zed4A53l2nS4oV3b37magCzjab6hQnRrBPfDoBlkiGQ+h7U/jvmh4e3DIXEJiXb0UmhodkOkw+/U504rEDwTDILRJ/Yo9HnU3iRQmlV4F8652MrGqDLmVuYPvDrndMwv+u+YbVKSsd0SVgEI24lDYRm4Iv+IcrsMh8PXjI4+by3wL3gsPPqZKW2LmpCymvagxl4TqJbQPWCNnjKJ9UXyQc3ZI8AaPqOT6bljtq4qbRwTlBwVi+EOf3BHcQx+B/Te69CDww8dyJ6hGOxmbTouJo112d0OvLzHvv4KdG+ZNMybKT5MsrE0brY9l7e0rz5h1L1ZGocISscmfAJIPud227TNWdC7JPEheX95wOHZi/2XqeD8l/QZiJfpq+ewl+6/AvFc7AG8evp8g0uj3bA7LEqLgrP30n2fYilO0Ilfjs4cl2sMDZZ0eDbYDbOAOSItEZut5iCEFQude5bUgXg5nrw4yNMxH0/SZ3z/IH118MtB+vTZHhyIX3I+Pni1QVJ380LHlks+Y6/BFFI1YkK5FAsS0WW4vXI7CcWcGpT1+XRT99h8bmf9Wa2NR1hDNtrV9O6hy5VImsWl2ng+tNfszqs17D1YMTLcgh2xLwAXWGpSbkZX7/4JfBXqWDRpfO89L5Uio03eXncC6k3vAH/vtmK65rA7doArB8pSBoSoPd61zwTQfYT6x88FoEH2Sfn7301/vMaB18PD0p+evcBL0Rxvjie78/3d4fsGu/0HMGhHMoi6NgU6pHCrkVfSX2pMBZR0s3HF5dVSJ3jU31bAL4DbRerppb6sgZ9xCGsIr6R5YqiEsY5mhZ+7t+ZP6UkJykxDWtW9PN9crUDm8SI+/ntMr1KsuHhGJOKLFL1HLtA1LV/P35bDae/JiwEDWvP4LbuogfQuBL6XgJMe67LdFx1GCV7NtR8np2DmMoeOpNs7qXSNb5ca7op4jzqlf2N91YauS1dPoMh1SWVnwvHIsndBX1k86YBPOQid1+gOaBj/Ei4Hc7+MDO8vNLe32ScoGvXzJVlUlfD131rNQGlU2rqSqw6d7hstv52yDc+5XLdXlP962eWvl106L7t4g3Vw5XargkuybPJR18Fzfk3mWPsaUsBbnx19+4anO63D5tfXGJs+m+LmBn/2z4ugTxWSQodIDie8sMMXRroq+vhTyJufsLu8O7JyUHFDKjx9EoJGQg50zg2dlKEXRkbxmZntMP+/fjxmo0xXP9jTCrgJ3GhVlet8W3osoRe///buDDOBfmhpQkn4S+fSMVeLDu3ra9/iDC3t5iaJaMnyKLW5+V+W5i4M
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Search for Bureau of Labor Statistics (BLS) occupations by name or keyword. This endpoint helps users find the appropriate occupation codes to use when creating or updating salary estimates.
+
+Returns a list of matching occupations with their codes, titles, and descriptions.
+
+📘 System Access Authentication
+
+This endpoint uses the [Bearer Auth scheme with the system-level access token in the HTTP Authorization header](https://docs.gusto.com/embedded-payroll/docs/system-access)
+
+scope: `salary_estimates:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-tax-liabilities.ParamsDetails.json b/docs/api/get-v-1-tax-liabilities.ParamsDetails.json
new file mode 100644
index 000000000..9ff053362
--- /dev/null
+++ b/docs/api/get-v-1-tax-liabilities.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"company_uuid","in":"path","required":true,"schema":{"type":"string"},"description":"The UUID of the company"},{"name":"X-Gusto-API-Version","in":"header","required":false,"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.","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"}}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-tax-liabilities.RequestSchema.json b/docs/api/get-v-1-tax-liabilities.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-tax-liabilities.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-tax-liabilities.StatusCodes.json b/docs/api/get-v-1-tax-liabilities.StatusCodes.json
new file mode 100644
index 000000000..9fa5ba8a3
--- /dev/null
+++ b/docs/api/get-v-1-tax-liabilities.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"Example response","content":{"application/json":{"schema":{"type":"array","items":{"description":"The representation of tax liabilities selections.","type":"object","x-tags":["External Payrolls"],"title":"Tax-Liabilities-Selections","properties":{"tax_id":{"type":"integer","description":"The ID of the tax.","readOnly":true},"tax_name":{"type":"string","description":"The name of the tax.","readOnly":true},"last_unpaid_external_payroll_uuid":{"type":["string","null"],"description":"The UUID of last unpaid external payroll.","readOnly":true},"possible_liabilities":{"type":"array","description":"Possible tax liabilities selections.","readOnly":true,"items":{"type":"object","properties":{"liability_amount":{"type":"string","description":"Liability amount.","readOnly":true},"payroll_check_date":{"type":["string","null"],"description":"The external payroll check date.","readOnly":true},"external_payroll_uuid":{"type":["string","null"],"description":"The UUID of the external payroll.","readOnly":true}}}}},"x-examples":{"Example":{"tax_id":1,"tax_name":"Federal Income Tax","last_unpaid_external_payroll_uuid":null,"possible_liabilities":[{"liability_amount":"0.0","payroll_check_date":null,"external_payroll_uuid":null},{"liability_amount":"3000.0","payroll_check_date":"2022-06-01","external_payroll_uuid":"1bf1efe1-72d4-4e6e-a181-611f3ea66435"}]}}}},"examples":{"Example":{"value":[{"tax_id":1,"tax_name":"Federal Income Tax","last_unpaid_external_payroll_uuid":null,"possible_liabilities":[{"liability_amount":"0.0","payroll_check_date":null,"external_payroll_uuid":null},{"liability_amount":"3000.0","payroll_check_date":"2022-06-01","external_payroll_uuid":"1bf1efe1-72d4-4e6e-a181-611f3ea66435"}]},{"tax_id":2,"tax_name":"Social Security","last_unpaid_external_payroll_uuid":null,"possible_liabilities":[{"liability_amount":"0.0","payroll_check_date":null,"external_payroll_uuid":null},{"liability_amount":"50.0","payroll_check_date":"2022-06-01","external_payroll_uuid":"1bf1efe1-72d4-4e6e-a181-611f3ea66435"}]}]}}}}},"404":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided UUID is valid.\n"}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-tax-liabilities.api.mdx b/docs/api/get-v-1-tax-liabilities.api.mdx
new file mode 100644
index 000000000..3fe1ee4fd
--- /dev/null
+++ b/docs/api/get-v-1-tax-liabilities.api.mdx
@@ -0,0 +1,71 @@
+---
+id: get-v-1-tax-liabilities
+title: "Get tax liabilities"
+description: "Get tax liabilities from aggregate external payrolls for a company."
+sidebar_label: "Get tax liabilities"
+hide_title: true
+hide_table_of_contents: true
+api: eJztWG1v2zYQ/isc96EtIPklTbJBnxYsaRGgW4Mm3QYkhnsWzzYbilRJyrNh+L8PR0m2bMnpig4FNixfkkjH5+6ee+Gd1nwZzwrnTSy1x5kFL42O/SpHntxzzCYoBAo+iriHmaNnV0uPVoNiN7CyRilHL02O5dFrwRM+Qx8vhrGHZawkTKSSXqLjEc/BQoYeLSGtuYYMecJTk+WgV+OikIJHXGqe8Bz8nEfc4qdCWhQ88bbAiLt0jhnwZM1LE7nzVuoZ30RcoEutzMkInvC7ObL3768vmZkyP0dW6eCbaKv2j/h1cPzi5jr+Da2jg5X2OYJAu6d/CsrhoZZL8iWTGl1QIsBjPAGHgl3cXLNFCcrAOZNK8CjYn9LP2coUNgikoFSPXU+ZNhqZdCy3ZiEFiqiUgTxXMg28PnPsPpNaZkXWxB49n3ufu6TfFyZ1vRDJXmqyfh25OC+jFN73IZdxdVLq2fcVYNx4/ILMKByKHj/OdsRRFxklw8ng5CwenMfDM8oCgVMolOdJ8/lmMzqk7TV65mHJGsnBptZkDGYzizPwyLDOssp+x6bGMqjj2HvQD9qlJseEfahlx7VsYhHEhxA+lxvt0JEPJ4MB/do35WoJWa6Q1ZI84qnRHrUn2UYA+h8dHVi3SQFrYUWZ4zFzbQ2UiRZziw61D1AhJw/cd6gwpZeOiK+QzeQjpp5HfBk/WX1eekXyd7CM3+xA49stKNWepSINhUi2w3IsRcOLUP4h59vm78rIw7IXeAXxVqtVWZabKMCVZdXOlTYeSX4OUYHz40LnIMX4MMBlp9iqut/p0oVSvJVvzWZAuKzEbSVZpyG5cU5OFI6brawd/X2NN9Whz8R5X1kjhQ4TYD94NeBqDJkpylR9mvU6K1asPNHtacVuOsf0cUzN7As5PuSTBaTQFjsV/pNx9R36O5TSD9UTlnUf6Kx6QLMshs2U5q9QoAXFrnVqMmR3sOR/K0HJ6mMJdN8VRj7oDXh3IEqsJxTRzdaB+HIwOA5KffqE+vRgyI+C8+FkOsQpDuMfTsRpfIrnGMPwx2F8PhxOXyKcn5++POObUUntEWIXoAoMXv9P8VdQHO34O9nj75YmDMVuMS2s9Kt/D3ln34q6UVX7p4PT9iX9q/HslSm0YA+asQddXtqfCnQ0tVl0prApMmHQMW08w6V0vsd+gUdkrrAY2k89vZU9STq2ACVF70Hzsue4HOERwa3imTVFzpOtT9vLfF+MYhubBVorBfGhpPN3sHyzN1MThnbhkqegPeKKJ8eH+mhbiY3hnkJTnzs0cnugbWz3sX2jd8c7jKfJMEM/N9XSEPLAz3nC+4thvxz1JLr+urkhbPqtea9PhbC/aTi0i3rNKKyimb4alCGX5ZwcC8zCsNy6LS8xMwehKPHikHF0Ljh/BLgT88Ya8QRmTq+JD1dXMFn+c+n3RZqicxcFUXM/akrd0jBaNtsO2e1UQCbW8zz9P0GwHbNeBRErXKBiUPg5al/Nv7Ri3a6cx+xrNJQIRxRsaPuamoBaTbRhQ6OFhxKp2tH2touI0wbm3k5v0S5kio147JYhmJjC94NgX5BqGqbi8H9spiEOdPTQ2N9RhcvIGxbseObYVVUz9fgddjFh0iKrh/vvqg0C0jCWVe35stbK3qGCeiTHDKQKCVW9/WmXP5ty9PQZ6AZOx+Z0aPZ6t8B8u0WrygKPS9/PFciQLqE81lVJ3/PFMFBTFTWPeHKw+LfgeXnFNZ0dRXxunCe89ZpW7fdWbTb0+FOBlqpmRC3HSpioct4Q0tHfR1b4JlvP31Xb/gt27PPBEU/rXSBI1A2PR1V33HOTLvH6+8KXmfcf/9jQSWxJYPeXmi3Pu3uIWlPuG+9aC/zelfP66o5vNn8B+OisBQ==
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Get tax liabilities from aggregate external payrolls for a company.
+
+scope: `external_payrolls:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-time-off-policies-time-off-policy-uuid.ParamsDetails.json b/docs/api/get-v-1-time-off-policies-time-off-policy-uuid.ParamsDetails.json
new file mode 100644
index 000000000..088a4c64e
--- /dev/null
+++ b/docs/api/get-v-1-time-off-policies-time-off-policy-uuid.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"X-Gusto-API-Version","in":"header","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"},"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."},{"name":"time_off_policy_uuid","in":"path","description":"The UUID of the time off policy","required":true,"schema":{"type":"string"}}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-time-off-policies-time-off-policy-uuid.RequestSchema.json b/docs/api/get-v-1-time-off-policies-time-off-policy-uuid.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-time-off-policies-time-off-policy-uuid.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-time-off-policies-time-off-policy-uuid.StatusCodes.json b/docs/api/get-v-1-time-off-policies-time-off-policy-uuid.StatusCodes.json
new file mode 100644
index 000000000..5d58f3e15
--- /dev/null
+++ b/docs/api/get-v-1-time-off-policies-time-off-policy-uuid.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"successful","content":{"application/json":{"schema":{"type":"object","x-examples":{"success_status":{"uuid":"3f746cd0-dd08-408f-b712-8180c7c621e9","company_uuid":"de83cff2-8e7a-448e-a28c-14258a9971c3","name":"test policy","policy_type":"vacation","accrual_method":"per_hour_worked","accrual_rate":40,"accrual_rate_unit":40,"paid_out_on_termination":true,"accrual_waiting_period_days":10,"carryover_limit_hours":100,"max_accrual_hours_per_year":100,"max_hours":100,"complete":true,"version":"f5556bce3d75ec2b62bd11990aa7993a","is_active":true,"policy_reset_date":"01-01","employees":[{"uuid":"c61d1895-5cf8-4217-88c8-20d7c3132a04"},{"uuid":"3633ce57-abb7-422f-8c5a-455566618e6a"}]},"success_status_no_employees":{"uuid":"3f746cd0-dd08-408f-b712-8180c7c621e9","company_uuid":"de83cff2-8e7a-448e-a28c-14258a9971c3","name":"test policy","policy_type":"vacation","accrual_method":"per_hour_worked","accrual_rate":40,"accrual_rate_unit":40,"paid_out_on_termination":true,"accrual_waiting_period_days":10,"carryover_limit_hours":100,"max_accrual_hours_per_year":100,"max_hours":100,"complete":true,"version":"f5556bce3d75ec2b62bd11990aa7993a","is_active":true,"policy_reset_date":"01-01","employees":[]},"deactivated_status":{"uuid":"3f746cd0-dd08-408f-b712-8180c7c621e9","company_uuid":"de83cff2-8e7a-448e-a28c-14258a9971c3","name":"test policy","policy_type":"vacation","accrual_method":"per_hour_worked","accrual_rate":40,"accrual_rate_unit":40,"paid_out_on_termination":true,"accrual_waiting_period_days":10,"carryover_limit_hours":100,"max_accrual_hours_per_year":100,"max_hours":100,"complete":true,"version":null,"is_active":false,"policy_reset_date":"01-01","employees":[]}},"description":"Representation of a Time Off Policy","properties":{"uuid":{"type":"string","description":"Unique identifier of a time off policy"},"company_uuid":{"type":"string","description":"Unique identifier for the company owning the time off policy"},"name":{"type":"string","description":"Name of the time off policy"},"policy_type":{"type":"string","description":"Type of the time off policy","enum":["vacation","sick"]},"accrual_method":{"type":"string","description":"Policy time off accrual method"},"accrual_rate":{"type":["string","null"],"format":"float","description":"The rate at which the time off hours will accrue for an employee on the policy. Represented as a float, e.g. \"40.0\"."},"accrual_rate_unit":{"type":["string","null"],"format":"float","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\"."},"paid_out_on_termination":{"type":"boolean","description":"Boolean representing if an employee's accrued time off hours will be paid out on termination"},"accrual_waiting_period_days":{"type":["integer","null"],"description":"Number of days before an employee on the policy will begin accruing time off hours"},"carryover_limit_hours":{"type":["string","null"],"format":"float","description":"The max number of hours an employee can carryover from one year to the next"},"max_accrual_hours_per_year":{"type":["string","null"],"format":"float","description":"The max number of hours an employee can accrue in a year"},"max_hours":{"type":["string","null"],"format":"float","description":"The max number of hours an employee can accrue"},"policy_reset_date":{"type":["string","null"],"description":"The date the policy resets. Format MM-DD"},"complete":{"type":"boolean","description":"boolean representing if a policy has completed configuration"},"version":{"type":["string","null"],"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. The version will be null if the policy is no longer active."},"is_active":{"type":"boolean","description":"boolean representing if a policy is active or not"},"employees":{"type":"array","description":"List of employee UUIDs under a time off policy","items":{"type":"object","properties":{"uuid":{"type":"string"},"balance":{"type":"string","description":"The time off balance for the employee"}}}}},"required":["uuid","company_uuid","name","policy_type","accrual_method","is_active","employees"],"title":"Time-Off-Policy"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided ID/UUID is valid.","type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["error_key","category"],"properties":{"error_key":{"type":"string","description":"Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error."},"category":{"type":"string","description":"Specifies the type of error. The category provides error groupings and can be used to build custom error handling in your integration."},"message":{"type":"string","description":"Provides details about the error - generally this message can be surfaced to an end user."}}}}},"x-examples":{"not_found":{"errors":[{"error_key":"request","category":"not_found","message":"The requested resource was not found."}]}},"title":"Not-Found-Error-Object"}}}}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-time-off-policies-time-off-policy-uuid.api.mdx b/docs/api/get-v-1-time-off-policies-time-off-policy-uuid.api.mdx
new file mode 100644
index 000000000..668b6cf30
--- /dev/null
+++ b/docs/api/get-v-1-time-off-policies-time-off-policy-uuid.api.mdx
@@ -0,0 +1,71 @@
+---
+id: get-v-1-time-off-policies-time-off-policy-uuid
+title: "Get a time off policy"
+description: "Get a time off policy"
+sidebar_label: "Get a time off policy"
+hide_title: true
+hide_table_of_contents: true
+api: eJztWVtv2zgW/itc7kNbQPQtTuL4abubThFg2gS97C6QBB6aOrI5kUiVpJwYhv/74pCULN+aBsUuFoPpS2OK5/6di45WVJdguJNaXaV0TGfg2KLPnCxgorNsUupcCgl252Q5qSqZ0oSmYIWRJdLTMX0PjnCCV4nOMhKu3qk7ZYUuYUx+2+M7NsDT32hCn9issk4zqRzMgkLMLUug41sKxRTSFFAeL8v2FUvvE2pBVEa6JR3frug/dFFytXwrBFj7tnJzOr69X99vBBj7yGd07EwFCTVgS60sWDpe0UGvh/9tm2QrzymrcppQoZUD5fAWL8tcCq9E93eLV1fUijkUHP8KmlM9/R2E89bBEy/KPAiKPCfWcVf5E+/NMT3JzodnIu2xNO2N2LA3ytj0vD9go/6oJ87F2aAPF14Nb+MkUqUwOhFZNmAjOOdsOBwB44ORYP3h4HTELy7O++KEJlTxAnVyYF2MDE1ojGbUd8GDRehoIUzF80kBbq5RSglmMteVmTxq8xBiEa8Y7oCOh73tk0mlpAvHJZfpRFduotXEgSmkClJiEGqqRy6dVLNJCUbqdJLypaXjfi+hghuz1Aswk1wW0nk1/KNeQgv+NKkZ+HMknyyBm9aFNgE6LwfUOEhfgLEh1Nnp6enZVMBJen4KYjA9G0zTfv/iosf5+cXFCacJlXbChZOLhjr6z4AFN0m9I2ivz3p9mlAoylwvAWN+24RYnPXT/ujilJ2KbMSGg/45G43EiA166bk46Z8MeG9I18kGEmcnJwJOzxmfTs/ZcDDI2EiccjZEZc/O+iM443R9v052UDVRetJS4E+I/eEhhhhIwdNyB+mf1eX/KvSqyvOt4GY8ty+K7nq3236CEsmU8/YSnRFOvmDvvc4yctPEwGCHd7JdBZoGZZ2RarbXx78q+a0CIlNQTmYSTGC+09jpehcsL+ebaUPcHEjkQ/Sjkmrmjw5ICyB7TspH7gmPMdkC5XO8vizLo7wSCqoqcEBpIdtK8UAxFXch/pykELCNkEhPIv16NyNqfrcbhogxHIgybQrusNzkmrt9m+ZAkAfhjjzOpZhvW+fhTB5lngcdwAeJK1LDkWjlKYIbOqTBIaSEW8KJF5sQ6Mw65I4Oe53eHe3sWhAz+OfMUFUxDegMWre1nHNLnCZYUIg2ZAoEK0VAnK5NcweYWHBEBhPrIKDCHXKt8iWpLAQmeDlfknqSJa+bGoZyErL1E9sx1hj0cusRKrfzE7buvnmJe49WwgZ7U61z4GrPl38P58TUsjAJZdb25ysbfZYehErtXl05j4+W+PUzRXgDAT/Zg2lhYCezm0ghJZlCpg0ch2at2UyqoLsvLVvK+xp2uAH8HDIL/vRddAquSCOYZEYXRCsg2FoQnh6X8ORQv+81of++kjFR0IVeu1qj/5mXggKtyt3uld8Rvy8NSdrw8Ixsh/ziFSUfPrDLy7qphSb+bOJMjyVOLQOrUM0vJUKrTM4q0yRGMx+8yBBRGQPKkUhdN6jwutkhnyGYeRufo06zSqZw/3ruXGnH3W6qhe34F+KO0EW3fsNmJV8anef+eXdD/tfAmuV8CeaNL39Shfh6+YrM9SPitrIoWlqSScjTDkFtay3rOoF2oY9akZCWKE1yrWZgSJiQfEVrzUs/HwppI2tsB0r73Np6RYoCuDF8ucf+V2kdOrrB5tevV5eWVCpFlQ8MB9JBYQ8tA35kIlsndMpzrsSPzCjt7h2pmsGqVpeu8R9uPL5V0kCKSIs7nK0ZLg5Z22PS3jTTjkzbifcJddLlqCxOouw6y1icRIP4YW+4v2P5qB35RVcqfcmK5QgLcqcIuVN+xoFvFVhMOwNWV0YASTUg0hyBJ2ldh3zgD0BsZWJZMHohU0jJ1WUXo4uIWfBcph2a7EWx7UgwRhtv/XZs4/k+tI5iY4/r5AGQQHAHM22WR2T4W88C5XMJAsduSx7nEG325EQLURnbIV+WpRQ8z5chiR9guRnWbZiInDNyWjnoltzwAhwYYiDHN866b3mWndBZo9YvUM3PonHqDpx8EalZ1UGyUfOZ0VUp1Qz7Rur7xRTCjOY0mVYyT4nAMlfE+3Ou0txXBkWWusI61mwTvc4FWMtnP5B2N7UiKTguc0v4FIefjVMZmYECs3FnZF1raSuTcRE0xaanUlQcPRdyZXtpqLSbZD5JWsC63Yo/jYhv42XcImwZR48kyCMP+eEJOrhYWm9S+qN2zCcZe4dC2XVAbVS3wUPQKy4E/s3e+7Xr25sr9s/Y7BIq0YFz4Kkf9vb2po3H6xesQW9wynpnrH8aGmLGqxwni9b53uvxJYQhNGIKmz+bckTG25urpilxa7WQHr6P0s0DJvACpkGHXGVE4VwmbVMdknCnVZ1eWXJbSCWLqmjzfmG35aVkrY4bGbLW8RtUA7Hd8RvCeuVyeDPvXVxyNz/YL3x5O/peu6lCYYtxLEBrXKw7PsOI0+3Vgwzd4InZEvgDcLtkPlWjwtdZ1lzbvoVWMRyKjUwhfJFAIDw5UNZv/BFcAe5HvxkkdMHz6vlvB+jFbVbh60BDj+a3L+0a01zcM+ow1bZxG2o0En3Z7MOC1T58Y9pd9Lt7X066q0OBX2M6gVnUWViZHDMt4pCXMsCQpVB4LO6B4xIKvRORwI/FbWChw3r6MOODPG+MHxmO8Szx8br1Ieczwi1UvQOfcxoQovC6evjBELjx9WRbemTBclhATnjl5tjQRDOCf15aB8XPSAgcjgjAKVZl2nONddRXRKwUtL0bbtWyhGLpstfZZzALKaDl6U0V8e2m6y92UxSNUwHzv5nOvIeRdFfZf0EudAHYdLweryx5F3OE3IR65ItYqkVV1MvFv8TJjAs/mcXKc1lLJZ9wAvA5hdMgl7mHSnz6tw0yfJ/Q1hVctfgc/Gy4q/hqMxr+zHfGGFkHT65b5lx6CHgwr2K63dIFLl/3WNCEjg/W2vuEzrV1SLlaYYf5avL1Go+/VYAt+PYeM91IPsXw365oKi3+nTZb4KOWvv4US/Eb8nzZPmhbPXmqZave0CQWp4MG+c9JsTu/TN0/dM894uDgyMNzTuPvTTvAQlO61rO915ytRvD+3RdsXdt1qalD8Q8M0sE4r1bhxhf9AGq93oQdf/vpbv0fr0sopg==
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Get a time off policy
+
+scope: `time_off_policies:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-token-info.ParamsDetails.json b/docs/api/get-v-1-token-info.ParamsDetails.json
new file mode 100644
index 000000000..0621f37c4
--- /dev/null
+++ b/docs/api/get-v-1-token-info.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"X-Gusto-API-Version","in":"header","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"},"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."}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-token-info.RequestSchema.json b/docs/api/get-v-1-token-info.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-token-info.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-token-info.StatusCodes.json b/docs/api/get-v-1-token-info.StatusCodes.json
new file mode 100644
index 000000000..7a72dbca2
--- /dev/null
+++ b/docs/api/get-v-1-token-info.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"scope":{"type":"string","description":"Space-separated list of OAuth scopes granted to this access token.\n","example":"companies:read public"},"resource":{"type":["object","null"],"description":"The resource associated with this access token. Null when\nthe token has no associated resource.\n","properties":{"type":{"type":"string","description":"The type of resource associated with the access token, e.g. `Company` for a company-level token or `Oauth::Application` for a system-level token.\n","example":"Company"},"uuid":{"type":"string","format":"uuid","description":"The UUID of the associated resource","example":"7b1d0df1-6403-4a06-8768-c1dd7d24d27a"}}},"resource_owner":{"type":["object","null"],"description":"The resource owner (user) who authorized this access token. Null for\nsystem-level tokens or when the owner cannot be determined.\n","properties":{"type":{"type":"string","enum":["CompanyAdmin","Employee","Contractor"],"description":"The type of resource owner:\n- `CompanyAdmin`: A company administrator\n- `Employee`: An employee\n- `Contractor`: A contractor\n","example":"CompanyAdmin"},"uuid":{"type":"string","format":"uuid","description":"The UUID of the resource owner","example":"8fdc31f0-a8a7-4872-a9f1-dcb5e6f876e3"}}}},"x-examples":{"company_admin_token":{"scope":"companies:read public","resource":{"type":"Company","uuid":"7b1d0df1-6403-4a06-8768-c1dd7d24d27a"},"resource_owner":{"type":"CompanyAdmin","uuid":"8fdc31f0-a8a7-4872-a9f1-dcb5e6f876e3"}},"system_token":{"scope":"partner_managed_companies:create public","resource":{"type":"Oauth::Application","uuid":"9c2a1b3d-4e5f-6789-abcd-ef0123456789"},"resource_owner":null}},"title":"Token-Info"}}}}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-token-info.api.mdx b/docs/api/get-v-1-token-info.api.mdx
new file mode 100644
index 000000000..5c425e8b7
--- /dev/null
+++ b/docs/api/get-v-1-token-info.api.mdx
@@ -0,0 +1,71 @@
+---
+id: get-v-1-token-info
+title: "Get info about the current access token"
+description: "Returns scope and resource information associated with the current access token. Use this endpoint to verify the following for the current access token:"
+sidebar_label: "Get info about the current access token"
+hide_title: true
+hide_table_of_contents: true
+api: eJzlV0tz2zYQ/isoekjSIayHbUnhqZ44k9Gl8cRx2xlZY0PAUkJDAiwAylY1/O+dBUmJejnp49SebBGLfX67+2FNHYjCKr+i8WRN35ks53p1JQQ4d1X4BY0n03IaUQlOWJV7ZTSN6SfwhdWOOGFyIFxLYsGZwgogSifGZhwFCXfOCMU9SPKk/IL4BRBRWAvaEx5MEG++gD4jdw6IXyhHQMvcKO2JN2QJViWrcCsxaWqelJ6TxNiTeuJ7/QP51HjyWlTBRASyPDUrgIgIo73lwhsbEWMJz/NUieDsm90wzJMGi+qqVJAUlpDSiD6zeeG8YUp7mNtwk/lVDjSeUMhmICVIGlGe520RR6cR9XzuUGysvTUuBxGSOY1ozi3PwIN1oQaaZ0Bj+iv7ECxd3YzZz2AdCkdUYfoXwCVYGlEnFpBxGq9p5QN13io9pxEFXWRorN/tX7LugPUuaahiwovU07j9vdyv7jX6kikNLmRacg9sxh1IcnUzxqq4Y8VdmcIGAcHT9IyME6KNBqIcya1ZKgkyqmRaSX/lyCRTWmVF1tY9fb3wPndxpyONcGch42fCZJ0mwyznK2vSNJx3eK5YfVPp+fe1Qtb6/AbdKBzIM4pgbopo3ROf09jbAiJqweVGO3CYzn63i39283JbBCzQiCKMQHsUaUXT+c2h3PqwLGb2GwhPI5pbk4P1qrIS2udY9fbs5lwAc4A4wXSnynliEvIRG7TqQUfmlms89KZqpJ3+ukfowDPP8hTtVI2hwMUWuCR5MUuVQBw08N/6NNn6ros0pQej4PMCtl1z2PD7npCfijQlTwvQ9xrBFb6SBXdEm/b1RmXl+m7aKs++ljV0DCUwUy84CDv+RQTO5mfksZ6Dj2HccFJPEhamQO2zseTxIy/8Io6vthhobriV85C1L+wXoTaBaS8KJY8FVE1SGlcCxwK8uxtfY4AhjsPs7RgcznqyK5MeG1x0z9kF7w7YaDgYMdGTcij7F7I/5LQsWzB4CFPw74IhXCavCwf2DXlaGILJMlb9gSg9AYzE2Ht9mDuH2UbQhEArxYJrbTyZAZHNvJJ/BS3NhGxWnswUXn5f7woa0XebZXE80gN0Bcfie802AApaH2Ny1UCIcPyinLfcY6yMPDYWUUxvdlWtpfGg1tH8PI6lKoZ/DVC7ce0YHCVSnPeSLuMjPmQXo2Gf8bdJj0kxu4RBMhoO4ByxVOKwra+FatRpeAhpeAjFbU3CE5Pp2GDa9E8T7Tfi+zS695FQq/3GUCNawfYwppxbr8E+ZFzzOciHbYzCAvfwYpSHE2br2VvR573ZuWQXcJmwwXD0lvGZkAySbq9/fnGJX44FjL2LDnvlQzE/o8dsrBMTSlZGFPsnGBujnTl4tuyxEBhDfhd4kMuBfwHuVgwJCzNLsFZJqOTHlRQ8e9AuECBkNl9gRePTFCqiS54WX6dSZbSvqlrkm/u40NtCp1zdXNi4jOwgA78wddw4TTiyYNpZ9johAw91BhzYZUPZCpsiLatJC89VxVmYhCwQl4NWu4ZsP4uVPhYqi/coRnBC8VGdN9bIF3TmeIzxNYT/FllK1ZVHaP8GgWi8oZr4ewbchmmwa/3dzopE1IL2DWTLiN6G7vgnFm7ba2HfQInUODFBaw3rQJ+RVmKdawK9Q3wjinvDfUxuwS6VgFamt5STz0zhO0GwI9E09gYLv5lJQoZVWLS7zv4CqTAZ8hsS/HjlyPsa0+SmIq+B8Uojigy0D2F8V1NLLgK1rB8C141V8gnSugciChlXaYBKffrjFhmYjdw4n3Hd0vMBfHidkRDSyUfUfijrLdv9H7/7aqh6ePadPOX1msXuXNcTYkKXPRTczohpRBfGeTxar/EBdWfTssTPvxdg8cE9xQlkFZ8hYCfTMmqedjhUpHJ4IGmc8NTBC2X5Tz/YTuS+mu3HH8nNVKfbJYDlzH3r7ODdtjP6P7z/jKtnd05t5lL9DxapPqqISKN7va4kwmItS9p4W/VXOS3L8k+W4Rl2
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Returns scope and resource information associated with the current access token. Use this endpoint to verify the following for the current access token:
+* Resource (company, employee, contractor, or application) and resource owner
+* Access level
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-webhook-subscription-uuid.ParamsDetails.json b/docs/api/get-v-1-webhook-subscription-uuid.ParamsDetails.json
new file mode 100644
index 000000000..1b2926457
--- /dev/null
+++ b/docs/api/get-v-1-webhook-subscription-uuid.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"webhook_subscription_uuid","in":"path","required":true,"schema":{"type":"string"},"description":"The webhook subscription UUID."},{"name":"X-Gusto-API-Version","in":"header","required":false,"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.","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"}}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-webhook-subscription-uuid.RequestSchema.json b/docs/api/get-v-1-webhook-subscription-uuid.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-webhook-subscription-uuid.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-webhook-subscription-uuid.StatusCodes.json b/docs/api/get-v-1-webhook-subscription-uuid.StatusCodes.json
new file mode 100644
index 000000000..426a95c75
--- /dev/null
+++ b/docs/api/get-v-1-webhook-subscription-uuid.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"Example response","content":{"application/json":{"schema":{"description":"The representation of webhook subscription.","type":"object","x-tags":["Webhooks"],"title":"Webhook-Subscription","properties":{"uuid":{"type":"string","description":"The UUID of the webhook subscription.","readOnly":true},"url":{"type":"string","description":"The webhook subscriber URL. Updates will be POSTed to this URL.","readOnly":true},"status":{"type":"string","enum":["pending","verified","removed","unreachable"],"description":"The status of the webhook subscription.","readOnly":true},"subscription_types":{"type":"array","description":"Receive updates for these types.","readOnly":false,"items":{"type":"string","enum":["BankAccount","Company","CompanyBenefit","Contractor","ContractorPayment","Employee","EmployeeBenefit","EmployeeJobCompensation","ExternalPayroll","Form","Location","Notification","Payroll","PaySchedule","Signatory"]}}},"x-examples":{"Example":{"uuid":"c5fdae57-5483-4529-9aae-f0edceed92d4","url":"https://partner-app.com/subscriber","status":"verified","subscription_types":["BankAccount","Company","CompanyBenefit","Contractor","ContractorPayment","Employee","EmployeeBenefit","EmployeeJobCompensation","ExternalPayroll","Form","Location","Notification","Payroll","PaySchedule","Signatory"]}},"required":["uuid"]},"examples":{"Example":{"value":{"uuid":"c5fdae57-5483-4529-9aae-f0edceed92d4","url":"https://the-partner-app.com/subscriber","status":"verified","subscription_types":["BankAccount","Company","CompanyBenefit","Contractor","ContractorPayment","Employee","EmployeeBenefit","EmployeeJobCompensation","ExternalPayroll","Form","Location","Notification","Payroll","PaySchedule","Signatory"]}}}}}},"404":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided UUID is valid.\n"}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-webhook-subscription-uuid.api.mdx b/docs/api/get-v-1-webhook-subscription-uuid.api.mdx
new file mode 100644
index 000000000..73e0b4954
--- /dev/null
+++ b/docs/api/get-v-1-webhook-subscription-uuid.api.mdx
@@ -0,0 +1,76 @@
+---
+id: get-v-1-webhook-subscription-uuid
+title: "Get a webhook subscription"
+description: "Returns the Webhook Subscription associated with the provided UUID."
+sidebar_label: "Get a webhook subscription"
+hide_title: true
+hide_table_of_contents: true
+api: eJztWMFuGzcQ/RWWPSQBlpLt2m2jQ1CndlMXaSJYdlPAFhJqOfIy3iUZkqtIFfYreumtv9hPKIakpJUlJTHaU5CTdrnDmeHMm3lDzemU3dTOayaVhxvLvdSK+ZkB2ruiUI1ACBA0o9yYtoijw4xacEYrB4725vRgbw9/BLjcSoMytEdPp7wyJZCFJM1orpUH5VGWG1PKPOjrvnW4YU5dXkDFNzVdFKjFWHCgfNhC9Ji8h1Gh9S1x9Wgp3KEZjQegevQWck8zOmWe3zg80qu4I/jvpS9RLK2xQUsLzaix2oD1Mp6vrqXA36TaeSvVDc22uHl5eXaCzvkCdjpogYuXqpzRnrc1NBmtbflp2u9oHIEll+fPO+TSCO7BkfeyLMkISP/l4AIE8Zr4Qrogs82u89zXbptpUHWFETOgRFyZgJVjGeBgodKT8FQrCzwv+KgEjOmmw9HCvQPSFniNvrWd5Nby2UZ4ziEHOQFSp1CMtUWbDkjYv25mzEsHGZUeqg8e/ylXt8d5rmuFQPpRV4ar2erpKSgYy/hJectzr+3aS5/PKgh7TytT6hlA63G1e7Hyix6hZlCOJxieTj1Yxcs+n1ldljSjP2lb0Yw+1/lC5oX2ciyXryvRPp8N8gJEXaLZgbxR3Gs7o8OmabAsIBZoiEAq1hXYaX40FhyOvmNHh99/ww6PDh6zx5wDG++ByAHE4wNxSBN2aeG9cb1u13DrFVjGjenkuuqugEpXcGtjaVumP+O4Iwjf1dKCwGOGSA+bjO7IxISX9X9OiS+AfUnLR8ohVMTh3uEm97zQnvykayXItSLkWkUueleD8yCQ23RtcyBCgyNKewJT6XyH/MpvgbjaQmh8xuqJFCAiPUhHJryUonOtKNpFpgnunmGSb8CzyT5LvZK1M8ECDjY7n6+tcsFQYjPSZjPCndO55Ojve+mLTY861+paPSH//P3nX2Qwcx4qcpzn4Bw5rn0ByqdwXqsnKHeBnAJKGC2VJ7WDaPvqKXALNuwhgcphZc8FtayECZSER+Ve34IiUgWBny8u+mGrtvKPyPEFcAF2+HCBZKFz1wkDSwDxYkBhJqY4fO8mQ9HEo3Ayl2sDPfImhfR1O6Suh6zw5jpwPre8Ag8WwT6nildICtt2vU6JkBh/w31B24WNJJa1hpl1dmk+gdhj3kJqaJMtXfmdPQvj2nH/jP0G1kWEBydirNbcSCS3buwEz1dJlXKGXMlG3IEgx/0zMolKNxAz07UNAjkvyw45GxOlFSCQFzjKokxrqnvgyFUllazqqq37nunkRrK0U6qbr5NC1lp+hG7UDgRS/K6gryj9YO/giO19y/aP4sQy5nXpaa+93jTDjDrIayv9LEAhFkWsCcQo7V0NUWjbYDllzgC/Be5mDPPG9ASslQJibd+ZM2HqQbkwVKOhW5jR3u6xPFtQwkfGc8TMQtUub5a6NrzCk1XgC53aUSgNPDTtTva7W6uoO99ZJg2mBexkUVbr7MSNjBhgAqoAhI3+dgKVputxjfpYIEXcF4pkh+KtOvtWiw/oNPi5jYJBaGeBnxPZtcGwRBsaX6AQ30ehI25YTyoW3XCtx2J/2ITbfS0M1trtHQMN9oyxDlrTLSj0FSzTOOm7qKVVExnFvuFejgdgJzKHVqRXJcxHuvbdINgVaBqZjYV3pschwrj1rrOvoMx1BXhdCX48cOQ0oZsk+g4dROi8rhY3wK/SdZLn4TqZOuTJwio5hzJVQ0ah4rIMUElff1ghA6NhtPMVVy09z8ATvrUr3/V+vrrUfmHi/4uJE9g9TH3XlFyGqki35NiKruhkn2ZbyRkz3tvN2sOMFtp5VDGfI/Vd2rJpcPldDRb7/RBbo5XhVosdS0iHzzsotQ2Ah+eJfR+Rj7D6jjMurrhhrF70Z5qlZr77UA3eItIMcD+XP/OBYGuUYzS3T1PLoK84FCvQ+Na3jf+u1hjz2ekFkvJ631726fSASdqa7Pk8SlxgSTbNMvehRDHPTfMvG9b2Mg==
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Returns the Webhook Subscription associated with the provided UUID.
+
+> 📘 System Access Authentication
+>
+> This endpoint uses the [Bearer Auth scheme with the system-level access token in the HTTP Authorization header](https://docs.gusto.com/embedded-payroll/docs/system-access).
+
+scope: `webhook_subscriptions:read`
+
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-webhook-subscription-verification-token-uuid.ParamsDetails.json b/docs/api/get-v-1-webhook-subscription-verification-token-uuid.ParamsDetails.json
new file mode 100644
index 000000000..1b2926457
--- /dev/null
+++ b/docs/api/get-v-1-webhook-subscription-verification-token-uuid.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"webhook_subscription_uuid","in":"path","required":true,"schema":{"type":"string"},"description":"The webhook subscription UUID."},{"name":"X-Gusto-API-Version","in":"header","required":false,"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.","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"}}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-webhook-subscription-verification-token-uuid.RequestSchema.json b/docs/api/get-v-1-webhook-subscription-verification-token-uuid.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-webhook-subscription-verification-token-uuid.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-webhook-subscription-verification-token-uuid.StatusCodes.json b/docs/api/get-v-1-webhook-subscription-verification-token-uuid.StatusCodes.json
new file mode 100644
index 000000000..85719448c
--- /dev/null
+++ b/docs/api/get-v-1-webhook-subscription-verification-token-uuid.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"No Content. The `verification_token` is POSTed to the Subscription URL."},"404":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided UUID is valid.\n"}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-webhook-subscription-verification-token-uuid.api.mdx b/docs/api/get-v-1-webhook-subscription-verification-token-uuid.api.mdx
new file mode 100644
index 000000000..61932eac2
--- /dev/null
+++ b/docs/api/get-v-1-webhook-subscription-verification-token-uuid.api.mdx
@@ -0,0 +1,76 @@
+---
+id: get-v-1-webhook-subscription-verification-token-uuid
+title: "Request the webhook subscription verification_token"
+description: "Request that the webhook subscription `verification_token` be POSTed to the Subscription URL."
+sidebar_label: "Request the webhook subscription verification_token"
+hide_title: true
+hide_table_of_contents: true
+api: eJztVk1v4zYQ/Ssse9gNINpJsNuDDoumm+02QNs1Yme3gG0ktDi2iEikwg+tXUO/opfe+hf7E4qhaEdO7AS59FD0ZFki3wxn3nvDNV2yhbdOM6kcLAx3UivmVhXQdEyhnIEQIGhCeVV1l1g6TagBW2llwdJ0TU+Pj/FHgM2MrHANTemvmrzXyoFyPTLKgdzUYORcZgHj2ulbUDdEWjL4NByBIE4TlwMZ+tkWhFxd/tyjTULfHL/Zh+/Ij9orQSaKkInCGAbuPFgHghiw2psMiNBgidKOwFJa1yO/8Fsg1hsI4SqjaylAkKuri3PMpuaFFL2Jok2TUF1Be+QLQVO6AMfqE/YVZrnWt8x2MmXds7FwNua9xOLtJn3ZJkhczl1IIKKRLtr+Us3guVJN1ES9I3//9cefZLiyDkpylmVgLTnzLgflIuBEvcN1o1xaAkpUWipHvAUbUMc/ADdgwh5isxxKIF+ly8NHG2BZATUUhLfgIT0iVVjw02g0CFu1kb+HaCQHLsBMX+fOVTbt94XObC/wrpfpsr/hGav4yuiiCN/7MVAb4iiczGa6gpTcxIpddytmUwNc3EwUTWjFDS/BgbE0Ha+p4iXQlO7bdR1bJLEzFXc5RV7feWlA0NQZDwkNFeDIvlYY1Doj1QJZudvZ0aFmIrOQxdtUfmMfg+rOBhfsMxiL+2MSba120pjzwsLDYOd4vlKq2DPBHbAZtyDI2eCC1C0o4dbqTHKUQ+jgSnsTFmS8KHrkYk6UVoCs38ggadfwqioiWV5ZMi6lkqUvu9gvbCevJIs7pVp8GwFZ5/URpuEtiB49XPSEgvIlutPp8elbdvwdO3mLZiRgzn3haNp93zTThFrIvJFuFajQiqLVBHKUpuMpLnJ8gVyhX9r2BX9bMlsBvwVuVwz7xnQNxkiB2USX+dwR6QhFgPktHSgbTBIj3sKKpodtNqE1L/zzdovk2UAdSmuLdTg9PGsJLtfRzYJYsAy0X5/09+qqvz4onKYfA10/divsIZh6o0FvCiR3ZAyvZEsYJqAMrHlkk+dQarrbhBaPScwd9wVFHQDeizkwWjyBWeHnLmWGwfvCfHuvy4qrVZc5W2pi8A1l8f8s2Oej6BFiY507hoxm8pibL40w3PHmBwEaNJi5DqjSFQgTTAg1jdSJNrQjoISiydhP8yGYWmbQqfS93vlMe9cPC/sCQ+PMZOE/0/NQYdz6MNkvUGS6BBxlIY9XlnyICiCD1jmC3Qid+RKUC8f4hiY008rxzOFBop2eb6KSSyiiYhIKJZdFoEr8+v09M7Aalbau5KqDcz+aDxj5XprvHGsd0gPl/p/0/8akj/pwsHT9quAyCClYwjoa25jWJzTZO/yRJOlTt4In3G2a0Fxbh/jrNc7dK1M0Db6+82Bw2EzRjo3kM5TaeE2FtPh8YJ53efP6Mo7+I/LMleJAAeJLrladmUCTOEAOn7iZNsnmAvKylP/jt5G9VW6ruf8qty36zsD9+GGEw33X27deHh+w8HsbuF63K8Ikb5ptP12c7E3T/AOzH+7f
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Request that the webhook subscription `verification_token` be POSTed to the Subscription URL.
+
+> 📘 System Access Authentication
+>
+> This endpoint uses the [Bearer Auth scheme with the system-level access token in the HTTP Authorization header](https://docs.gusto.com/embedded-payroll/docs/system-access).
+
+scope: `webhook_subscriptions:read`
+
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-webhook-subscriptions.ParamsDetails.json b/docs/api/get-v-1-webhook-subscriptions.ParamsDetails.json
new file mode 100644
index 000000000..49933cebe
--- /dev/null
+++ b/docs/api/get-v-1-webhook-subscriptions.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"X-Gusto-API-Version","in":"header","required":false,"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.","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"}}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-webhook-subscriptions.RequestSchema.json b/docs/api/get-v-1-webhook-subscriptions.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-webhook-subscriptions.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-webhook-subscriptions.StatusCodes.json b/docs/api/get-v-1-webhook-subscriptions.StatusCodes.json
new file mode 100644
index 000000000..073bdaae0
--- /dev/null
+++ b/docs/api/get-v-1-webhook-subscriptions.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"Example response","content":{"application/json":{"schema":{"type":"array","items":{"description":"The representation of webhook subscription.","type":"object","x-tags":["Webhooks"],"title":"Webhook-Subscription","properties":{"uuid":{"type":"string","description":"The UUID of the webhook subscription.","readOnly":true},"url":{"type":"string","description":"The webhook subscriber URL. Updates will be POSTed to this URL.","readOnly":true},"status":{"type":"string","enum":["pending","verified","removed","unreachable"],"description":"The status of the webhook subscription.","readOnly":true},"subscription_types":{"type":"array","description":"Receive updates for these types.","readOnly":false,"items":{"type":"string","enum":["BankAccount","Company","CompanyBenefit","Contractor","ContractorPayment","Employee","EmployeeBenefit","EmployeeJobCompensation","ExternalPayroll","Form","Location","Notification","Payroll","PaySchedule","Signatory"]}}},"x-examples":{"Example":{"uuid":"c5fdae57-5483-4529-9aae-f0edceed92d4","url":"https://partner-app.com/subscriber","status":"verified","subscription_types":["BankAccount","Company","CompanyBenefit","Contractor","ContractorPayment","Employee","EmployeeBenefit","EmployeeJobCompensation","ExternalPayroll","Form","Location","Notification","Payroll","PaySchedule","Signatory"]}},"required":["uuid"]}},"examples":{"Example":{"value":[{"uuid":"dcceb38a-46be-4110-9d1d-1b3384c3b906","url":"https://6116-2603-6000-8900-3d42-58e7-f1e3-b394-1f21.ngrok.io/subscriber","status":"pending","subscription_types":["BankAccount","Company","CompanyBenefit","Contractor","ContractorPayment","Employee","EmployeeBenefit","EmployeeJobCompensation","ExternalPayroll","Form","Location","Notification","Payroll","PaySchedule","Signatory"]}]}}}}},"404":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided UUID is valid.\n"}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-webhook-subscriptions.api.mdx b/docs/api/get-v-1-webhook-subscriptions.api.mdx
new file mode 100644
index 000000000..c2d513a4a
--- /dev/null
+++ b/docs/api/get-v-1-webhook-subscriptions.api.mdx
@@ -0,0 +1,75 @@
+---
+id: get-v-1-webhook-subscriptions
+title: "List webhook subscriptions"
+description: "Returns all webhook subscriptions associated with the provided Partner API token."
+sidebar_label: "List webhook subscriptions"
+hide_title: true
+hide_table_of_contents: true
+api: eJztWM1y2zYQfhUUPaSZIfRvx9YhU6d2UnfSRBPZTWdsTwISKwkxCSAAqEjV6Cl66a2v2EfoLEhKlEVlmkMvaU8iwcXuYvfb/RZa0QWb5s5rJpWHqeVeasX80gAd3lDIYhACBI0oN6Yu4uhdRD2fOhR7C/FM6/uwZsEZrRw4OlzRXqeDPwJcYqXBfXRILxY8MymQSpJGNNHKg/Ioy41JZRJstD843LCiLplBxvGpcIxya/mSRlR6yNy+hasZajcWHCgfVBE9IZ8KL4nL441wi0aVTh1/gMTTiC5Y07m89CmKlWtsXNNCI2qsNmC9LM6d51LU3HXeSjWlUYOb19eX5+icn8FBBy1w8VqlSzr0Nod1RHOb/jPtDzTGYMn1m5ctcm0E9+DIJ5mmJAYyej2+AkG8Jn4mXZBpsus897lrMg0qzzBiBpQoVuZg5UQG6FjI9Dw85coCT2Y8TgFjuu9wYeGLA1IXeIe+uQaw7Fp7AwnIOZC8DMVEW7TpgIT9u2YmPHVQg9uh4z/j6v4sSXSuEEg/6Mxwtdw+PQMFE1l8Ut7yxGu78zLiywzC3ovMpHoJUHvc7q5WftIxagbleAnDi4UHq3g64kur05RG9Lm2GY3oS51UMq+0lxO5ed2KjvhynMxA5CmaHcup4l7bJb1br9dYFlAUbohAWcRbsNPkaCI4HD1hR4OTPhsc9U7ZKefAJh0QCYA47YkBLbFLZ94bN2y3DbdegWXcmFais/YWqHQLtzqWmjL9FccdQfgxlxYEHjNEOqweSMWcpzk27k1SRJJA3D/hbHAcAxt0ux12KrqCdeN+/2SQ9OPTzvFeUo673WPWO+702XGn02Enp50O64tBjx2dwBM26UKfxf3TAetOet2Wmlp935L6QOq2DeG/lTmsGUzUoDPY56dX2pPnOleC3CpCblXBVx9zcB4E8qLObQJEaHBEaU9gIZ1vkZ/5PRCXWwjN0Vg9lwJEQSHSkTlPpWjdKop2kY2Cv5cIgyl4Nu+ysp+yeipcQ2f0uVWO8DRt7MCOcOd0Ijk6+0n62a47o6Kkydnoknh9D6p1q27VU/LXn7//QcZL5yEjZ0kCzpGz3M9A+TKyt+opyl0hA4ESRkvlSe7ABf03z4BbVJv7GQkDAWyNu6CWpTCHlPBCebBNpAoCP15djcJWbeVvxUQwAy7A3n1XoV7oxLXCKBQ6UTX6MFNkO3xvl4YKE4/DyVyiDQzJ+zJU73ZCNUQOeY/ohyS30i9DcRZRKIKATtHhzd36LqKGW56BB+uCmOIZssyv7EUY0M5Gl+wXsK4AocRUFWeg9S5RUtVuSs9RaSZVGUtkPBZzByJkaV4o3UvrUudFGhOepi1yOSFKK0CoVcmOCpnazPbIkZtMKpnlWV33F4aZG8nKnVJNvy0VstryY3QjdyCQqPfmwz1i7nV6R6xzzLpHxdwx4Xnq6bC+vsYMLJgzwO+BuyXD8DM9B2ulQKWpdH78oHJg4UG58IIZu4clHR6eqKNNg/78ZL2OtqoO+bPR1eAXniQDP9Nl7eN8yhFmtD3vthuBGiBq5xX0dgmBG1mkjAnIQt72msY5ZJruxq/Qxwoews94rAOKG3WOrBaf0WnwMx61qq1x6AqBE0v6qJfYBhxovAINvsehsexZL1VUTWWnVdF11FDEX2phvNO1HhhYY4lPdNBaXj1CG8CqKsZrV2ipQTiiWObu9WQMdi4TqEV6W3E81rlvB8G2QNNIFSy8Mz0JEcatD519C2miM8A7QvDjkSMXJYZJSYih4IVO8qy6dn1T3u14Eu52ZUM7r6ySN5DyTSllXKYBKuXX77fIwGgY7XzGVU3PS+l8M0M99H61vWH+T2//Br2VwPew8G2TchkqpLymFq3nhs67NKLNzecuojPtPEqtVkhM1zZdr3H5Yw4WSfMO+52V4eaIbBlV3IfdSkiHHw6wXz35XzkRNqahYJLmKaLiELqlHASv8bVve//I7NDLi4sr5LDdBrhpeOUDJqm6jYfxvtK9WhUSV4jm9ZpW3gZ00zBF/w2bwYyk
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Returns all webhook subscriptions associated with the provided Partner API token.
+
+> 📘 System Access Authentication
+>
+> This endpoint uses the [Bearer Auth scheme with the system-level access token in the HTTP Authorization header](https://docs.gusto.com/embedded-payroll/docs/system-access).
+
+scope: `webhook_subscriptions:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-webhooks-health-check.ParamsDetails.json b/docs/api/get-v-1-webhooks-health-check.ParamsDetails.json
new file mode 100644
index 000000000..0621f37c4
--- /dev/null
+++ b/docs/api/get-v-1-webhooks-health-check.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"X-Gusto-API-Version","in":"header","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"},"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."}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-webhooks-health-check.RequestSchema.json b/docs/api/get-v-1-webhooks-health-check.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-webhooks-health-check.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-webhooks-health-check.StatusCodes.json b/docs/api/get-v-1-webhooks-health-check.StatusCodes.json
new file mode 100644
index 000000000..a1b275f10
--- /dev/null
+++ b/docs/api/get-v-1-webhooks-health-check.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"successful","content":{"application/json":{"schema":{"description":"The representation of a webhooks health check response","type":"object","x-examples":{"success_status":{"status":"healthy","last_checked_at":"2025-09-08T21:21:38.000Z"}},"properties":{"status":{"type":"string","description":"Latest health status of the webhooks system","readOnly":true,"enum":["healthy","unhealthy","unknown"]},"last_checked_at":{"type":"string","format":"date-time","readOnly":true,"description":"ISO8601 timestamp of the last successful health check with millisecond precision"}},"title":"Webhooks-Health-Check-Status"}}}}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-webhooks-health-check.api.mdx b/docs/api/get-v-1-webhooks-health-check.api.mdx
new file mode 100644
index 000000000..b10508643
--- /dev/null
+++ b/docs/api/get-v-1-webhooks-health-check.api.mdx
@@ -0,0 +1,75 @@
+---
+id: get-v-1-webhooks-health-check
+title: "Get the webhooks health status"
+description: "Returns the health status (`healthy`, `unhealthy`, or `unknown`) of the webhooks system based on the last ten minutes of activity."
+sidebar_label: "Get the webhooks health status"
+hide_title: true
+hide_table_of_contents: true
+api: eJztVl9v2zYQ/yrc7aEtIMV2hhadnpa1RRtgQIPGW4elRkJLZ4uNRGrkyYlr6FPsZW/7ivsIw5FULDnphj4NGOYXi+T9493vfscdmAatJGX0aQEZrJHSzSy9wWVpzLVLS5QVlZd5ifk1JFCgy61qWBwyeIfUWu0ElSiCoHAkqXXi8VVYb68ScdXq/cJYXl9rc6Ovngiz8rq9N+G2jrAWS+mwEEb7w0o6EoRa1Eq3hI6VZE5qo2h79EF/0H/+8dvv4jxonuQ5OidOWipRk8r9xVhoXionUBeNUZpE6zBEffE9SovWKwiXl1ijuFFU+sMQTVrhBishg2Uy16iFCqG9mc/PvKqx6pN3xWko0C4el0SNyyaTwuTuaN06Mke5qSdYL7EosEgbubWmqvz5JDoKLp5wuC43DWbiKmbm0rXLu8S7zKIsriABkmsH2QW8j/mDRQK3qfeWKk24DoVNadsgy/XeIQHZNEMRr9pIK2sktGx0B1rWCBn8nL72Bk/OTtOf0DoufQKK6x8uCwn4zEnIdhBcgSOr9BoSQN3W7Pp4evw0nT5LZ0/ZU4Er2VYE2XC/O4TXS46lVjrWqpCEaYDGydmp2IRYhHTO5EoSFqFyW9NaL5DLqjoSpyuhjUahnGis2agCiyTIyKapIkIeOXFRK63qth7a/sIyykalUVPp9dfRYDrYfsJhtA6LI+gWCTjMW6to69MdEBwAzJiC7GLRDQpq3Y1cQ0a2xQQsusZoh45zfjyd8t84ea71llZtBQnkRhNqYqnBrScfHYvuBuUb25iXKCw2Fh1qCvjm5tv3a2x6zw6ij4mBGVBglh8xJ+A74K2smyrEG0O7DFzhd+IXRKKABLjtA+1gcSn3UPk2nT6fH8+y41n2zfOj6XT6C3RdAo1lHiOFI3v38Ti+4A+S0NEBdz1MSsBJl8VbXW37IvTY3gd9x3T+27McLLoHLnM/sJWxtb+mhzmpGh/wOI7+9Pzt82fTmWBhR7Ju+tA9Ze4BMC6Tb5JaVZVymBtdiMZirnxbcyJJUcWB9ZySvvHK6QtWTs9DYjv+JYC3hNp5+mAEX+MWss8TUAIbWbX/TERdcmgqQP9On3PBnVEjlSYOLWD64qaByWY26Ws3ORhfDu2mp7fWVgy42OCyUaG/0wJr3+T3wPISa+Ox7BqU1yjdNg32UsVBsB5w7J8x/KDNM2uKv7HZ8PGQKc79iPLIfmHqRurtkDDuUMXOe1rm9dJPuXveo4l+wo2GJtPxfUr6Ug/noxF64KDjMbIy3mpEnR81TMFc7ThsRkMiAZ4J7u3qHO1G5TjI9J6e5dK0NPGCk4JdMzekfp2alc8wqx4G+x6r3NQoyAgfxyMnXkWgirNA9H46FCZv654Rv4r0KnPf1nFovuy9indYRWAngLVUlYdKPP1ujwxPYsZRLfXAzmukMRmNqOrwBrs90f//Nvu332ahTwhvadJUUvmG8tSwi0x1AZsZJNAnGBIYsdUigdI4YrndjrP+o626jrd/bdHym2HBjGiVXHLrXPCciQ8yprdCOT4oIFvJyh3OjiFS/tPPrM8UIsyXh5+2ccoA7AcRQ7ehwdm9V9RoHr1+NefJNmbMO4aMH1ykeCT1dmB7twsSc4Zz10EfrYc3dIuu6/4CQc3cew==
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Returns the health status (`healthy`, `unhealthy`, or `unknown`) of the webhooks system based on the last ten minutes of activity.
+
+📘 System Access Authentication
+
+This endpoint uses the [Bearer Auth scheme with the system-level access token in the HTTP Authorization header](https://docs.gusto.com/embedded-payroll/docs/system-access)
+
+scope: `webhook_subscriptions:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-v-1-work-addresses-work-address-uuid.ParamsDetails.json b/docs/api/get-v-1-work-addresses-work-address-uuid.ParamsDetails.json
new file mode 100644
index 000000000..a30c71c44
--- /dev/null
+++ b/docs/api/get-v-1-work-addresses-work-address-uuid.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"work_address_uuid","in":"path","description":"The UUID of the work address","required":true,"schema":{"type":"string"}},{"name":"X-Gusto-API-Version","in":"header","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"},"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."}]}
\ No newline at end of file
diff --git a/docs/api/get-v-1-work-addresses-work-address-uuid.RequestSchema.json b/docs/api/get-v-1-work-addresses-work-address-uuid.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-v-1-work-addresses-work-address-uuid.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-v-1-work-addresses-work-address-uuid.StatusCodes.json b/docs/api/get-v-1-work-addresses-work-address-uuid.StatusCodes.json
new file mode 100644
index 000000000..7f470380c
--- /dev/null
+++ b/docs/api/get-v-1-work-addresses-work-address-uuid.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"successful","content":{"application/json":{"schema":{"type":"object","x-examples":{"success_status":{"uuid":"64ee5fd7-3eb2-4083-883c-95e93e181cc8","employee_uuid":"d773461f-848a-40a1-8f09-b2ee4249d5c7","location_uuid":"733ab2af-9510-408f-8d20-09196967174f","effective_date":"2020-01-31","active":true,"version":"3879823d440f3a3215d129ac73c58966","street_1":"977 Marks Viaduct","street_2":"Apt. 958","city":"Pink Hill","state":"NC","zip":"28572","country":"USA"}},"properties":{"uuid":{"type":"string","readOnly":true,"description":"The unique identifier of this work address."},"effective_date":{"type":"string","description":"The date the employee began working at this location."},"active":{"type":"boolean","readOnly":true,"description":"Signifies if this address is the active work address for the current date"},"location_uuid":{"type":"string","description":"UUID reference to the company location for this work address."},"employee_uuid":{"type":"string","description":"UUID reference to the employee for this work address."},"version":{"type":"string","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."},"street_1":{"type":"string","readOnly":true},"street_2":{"type":["string","null"],"readOnly":true},"city":{"type":"string","readOnly":true},"state":{"type":"string","readOnly":true},"zip":{"type":"string","readOnly":true},"country":{"type":"string","readOnly":true,"default":"USA"}},"required":["uuid","version"],"title":"Employee-Work-Address"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided ID/UUID is valid.","type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["error_key","category"],"properties":{"error_key":{"type":"string","description":"Specifies where the error occurs. Typically this key identifies the attribute/parameter related to the error."},"category":{"type":"string","description":"Specifies the type of error. The category provides error groupings and can be used to build custom error handling in your integration."},"message":{"type":"string","description":"Provides details about the error - generally this message can be surfaced to an end user."}}}}},"x-examples":{"not_found":{"errors":[{"error_key":"request","category":"not_found","message":"The requested resource was not found."}]}},"title":"Not-Found-Error-Object"}}}}}}
\ No newline at end of file
diff --git a/docs/api/get-v-1-work-addresses-work-address-uuid.api.mdx b/docs/api/get-v-1-work-addresses-work-address-uuid.api.mdx
new file mode 100644
index 000000000..b51f851b1
--- /dev/null
+++ b/docs/api/get-v-1-work-addresses-work-address-uuid.api.mdx
@@ -0,0 +1,71 @@
+---
+id: get-v-1-work-addresses-work-address-uuid
+title: "Get an employee work address"
+description: "The work address of an employee is used for payroll tax purposes."
+sidebar_label: "Get an employee work address"
+hide_title: true
+hide_table_of_contents: true
+api: eJzdWEtz47gR/isIctidKkJvWRJPca0nEx92xrWe2U2VxuWFiKaENQlwAFC2VsX/nmqAlKhX7Ekql5xsEY1+99fd2FJdgOFOanUraEyX4Ni6z561eXrkQhiwFuzBz8eylIJGVIBNjCzwJo3p5xUQpCI1FdEp4YpAXmR6A0CkJaUFQVJtSME3RmcZcfyFFKUptAXb+aq+KpvoAmLye3PLxga4+J1G1PGlpfGcvm/4XTe60YeIvrBlaZ1mUjlYBmOY2xSANyBfgBCAGvOiaJP4qxaS0ki3ofF8S3/SecHV5jpJwNrr0q1oPH+oHiJacMNzcGCsp1M8BxrTc16R6IyCu9VZD335cnuDnnFH3qIRNfCtlAYEjZ0pIaI2WUHOabylwRJqnZFqSasq2inwT/bB2319d8t+BWNRUK3CCrgAQy/ziSioMkcPDXqDMetdsf4YHSIg5WXmaNz+Xh0bc4POyKUC620R3AFbcAzw9d0tWQddCLdWJ5I7EORZuhXZ6NJ4goRnWYfcpkRp5XOjMHotBYgo0PCiyGTio/SDJfNcKpmXeZv3w48r5wobd7tCJ7bj499JdN5t4s3qLPPnXV5IVt+UavnXmiFrfX7XpGiHVq2UMvaZL5uYGLCFVph08ZYOej38c+gXW/rcScuMRjTRyoFySNUyqPuHRdLtaWT04g9IHEXh8MLzIguCap6P1nFX+i8+12J6NQIYp2LChrAYsFFvOmTT6TBhszHMhtCf9pNkinGua+axviYmk+Hoqp+y6WjK2ajH+2ya9mZsMQAYDUYzMU4mNKKZDvo21ybDIV8MeMpm434PpaVsKgY91pv1Z1ezq0l/MkpRWppC4uQaHjEpQhr1WK/Phn0sQX/U+LN2PY3pcDqZTQdDMRr10iEfDvpj0R/MeDIZJuPp7OoKE9kZAPfYpzGdTSbkZ26eLPlVclF6n9XHAxrT68J1yGyMtie+tOmdVE/kHzLLPGHQ6+NPNKJ/ygJVnI4nAx+wUjmDF77cX2Ol0cIgPDoJLb+fVhKi1CeVbRq7Tgu/VPJbCUQKUE6mEkxAAWkPYKCDhXbswFNxp+yR0hfiDm8XsOTKM5dqSbgLwpqYekFNLHYCFlpnwNWrBt3LpUIjLJG1EQ3oywAHgfNhP0Dgx7OkNAaU8yqjFkdp9pq1HkENpGBAJUCcDkwDcO/sq6Wdde9hNfxn8nZuvixnl9tviV/jlAY46xYRAKFD7iFEd76HMLIspYDvREEpIC+0A5Vs3nnVpUq1yYPLtCIr/YwWlhaCUamETHhr9sX3WvZX7VJsiOd7alVmGfaZk1uhVN/E/kJdnFD66n4D3a7u31LaTXtsIGLfuOe0HgKa2D9E1EmXIcNmcGG/afPE6umFVhVyGPVGp53ko3bk77pU4nsayQUW5Ksi5KvCTENtwWJHNmB1aRIgQoMlSjsCL9K6DvmZPwGxpQk513RmcnvT9cUgLVnzTIoOjmVHjavtCzBGGz9jHYJo/X3va24M3+Dc4iC359rhCdfHJ8ALCXew1GZzQYanerX87gtIApg9r6C22V8nOklKYzvk86aQOLBsQlE8wWaP4zXeOWfkonTQ3Q2KxEDmB58GMZClL6Wd1t+hGnJAWgSGwIl42KhZNUGyteZLo8tCqqUlXAmScEUWEMZvp8milJkgCUJFXtOvuBIZgopUYf5qTcle5xys5cs3NKO7RhEBjsvMEr7QpWs5lZElKDB7d9asGy1taVKeBE1xf1ACFUfPhVo5HI2Udo+pL5JWYs0P4k/rjG/nS9y62DKOXiiQZx7qw1/A8RAVaQr7o3bMFxl7j0LZp5C1O3VtAfwJuN0wHxUa7zrQfoU5pMPhnuk1GCMFeAOckbAGRI7r3b4ALw6U9WsMWhxsvbgIRXTNs/L1hQiXi0NWYQDe3Q+IuSc6Nm9HeMbM8/cOzd3fP2c2TuY5uJWuV1UahV0rpt11v3u4tHa3J/tZheMfmHWzx5Umw1WpbqG8kKGDMgG5b6Mn6X0DuT6KVuDHwmSNx2jlBcZned4ZLf4NzwKPq9ameo9oH9L/zL66K1AU3qx/frgDbvxCeCi9ZsEyWENGeOlWiGyhwWDl32+sg/y/kRA4XBBQ4bqaas+1Lii/0uKqR9sLQmsZjSjunvZTeg9mLRNoeXo/AHnc6XrCrkDR2B6Y/8106j2MV4+V/Q2yROd+zvN6/GDJ+7peyF39bIFbqNBJmYNy3oy/1C2aJ75F18v5TSOV/IKtwNcXjp9cZj5V6tO/7TPDLxzaupyrFp8P4A5eUo7eDQ703+5Hhf/5i0xIAgcvrltkXPps8Xm/rWtyTte48h1WJY1ofPpu8hDRlbYO72y3+I7wxWRVhZ+/lYCAPX9AYDCSLzBH5lsqpMX/BY1TntnjFaXthx9/qceHd+SVJ5izJjVDitq0sIlGNZCdmlI9VFHz+vJ9iv5fv6lc8G7w4vl3rJ2z930DcahwrbOTcfigQ3x4/xm73CFs7WCq/geDdDbI222g+KyfQFXVLuYOf/spoPoXz0llDw==
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+The work address of an employee is used for payroll tax purposes.
+
+scope: `employees:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-version-employees-time-off-activities.ParamsDetails.json b/docs/api/get-version-employees-time-off-activities.ParamsDetails.json
new file mode 100644
index 000000000..be55541e6
--- /dev/null
+++ b/docs/api/get-version-employees-time-off-activities.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"employee_uuid","in":"path","required":true,"schema":{"type":"string"},"description":"The UUID of the employee"},{"schema":{"type":"string"},"required":true,"in":"query","name":"time_off_type","description":"The time off type name you want to query data for. ex: 'sick' or 'vacation'"},{"name":"X-Gusto-API-Version","in":"header","required":false,"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.","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"}}]}
\ No newline at end of file
diff --git a/docs/api/get-version-employees-time-off-activities.RequestSchema.json b/docs/api/get-version-employees-time-off-activities.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-version-employees-time-off-activities.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-version-employees-time-off-activities.StatusCodes.json b/docs/api/get-version-employees-time-off-activities.StatusCodes.json
new file mode 100644
index 000000000..de4bc728e
--- /dev/null
+++ b/docs/api/get-version-employees-time-off-activities.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"Example response","content":{"application/json":{"schema":{"type":"object","x-examples":{"example":{"policy_uuid":"a7838f74-4c29-4b70-9bfb-02a4e3e60709","time_off_type":"vacation","policy_name":"Paid Time Off","event_type":"TimeOffEvent::AddToPolicy","event_description":"Added to policy: Vacation Per Hour Worked","effective_time":"2022-09-27T13:43:03.000-07:00","balance":"0.0","balance_change":"0.0"}},"description":"Representation of a Time Off Activity","properties":{"policy_uuid":{"type":"string","description":"unique identifier of a time off policy"},"time_off_type":{"type":"string","description":"Type of the time off activity","enum":["vacation","sick"]},"policy_name":{"type":"string","description":"The name of the time off policy for this activity"},"event_type":{"type":"string","description":"The type of the time off event/activity"},"event_description":{"type":"string","description":"A description for the time off event/activity"},"effective_time":{"type":"string","description":"The datetime of the time off activity"},"balance":{"type":"string","format":"float","description":"The time off balance at the time of the activity"},"balance_change":{"type":"string","format":"float","description":"The amount the time off balance changed as a result of the activity"}},"title":"Time-Off-Activity"},"examples":{"example":{"value":[{"policy_uuid":"a7838f74-4c29-4b70-9bfb-02a4e3e60709","time_off_type":"vacation","policy_name":"Paid Time Off","event_type":"TimeOffEvent::AddToPolicy","event_description":"Added to policy: Vacation Per Hour Worked","effective_time":"2022-09-27T13:43:03.000-07:00","balance":"0.0","balance_change":"0.0"},{"policy_uuid":"a7838f74-4c29-4b70-9bfb-02a4e3e60709","time_off_type":"vacation","policy_name":"Paid Time Off","event_type":"TimeOffEvent::Accrual","event_description":"Accrual","effective_time":"2022-09-27T14:43:03.000-07:00","balance":"2.0","balance_change":"2.0"}]}}}},"headers":{}},"404":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided UUID is valid.\n"}}}
\ No newline at end of file
diff --git a/docs/api/get-version-employees-time-off-activities.api.mdx b/docs/api/get-version-employees-time-off-activities.api.mdx
new file mode 100644
index 000000000..43e53b515
--- /dev/null
+++ b/docs/api/get-version-employees-time-off-activities.api.mdx
@@ -0,0 +1,71 @@
+---
+id: get-version-employees-time-off-activities
+title: "Get employee time off activities"
+description: "Get employee time off activities."
+sidebar_label: "Get employee time off activities"
+hide_title: true
+hide_table_of_contents: true
+api: eJztWN9v2zYQ/lc47iEtINqK4zaNnmYsWZeHLUaatgMSI6WlU8xGIhWScm0Y+t+Hoyhb/pl23YBh2FMsivruePfdd8cs6Iw9lMYqJqSFB82tUJLZeQE0uqWQjyFJIKEB5UXR3mLoKKAaTKGkAUOjBe2FIf5JwMRaFLiHRvRixvMiA9LspAGNlbQgLe7lRZGJ2OF1Pxv8YEFNPIGc46/aCarGnyG2NKAzBjWaM+d/489CZSKe35elSGhE+embkzfpaZ/1494Z649PQ3Y2Tscs7PE+nMDr8DQ8owG1Iod7lab33syU147QoMGTPMcXQy4SciNyIFdpSgMKU5C2+QrXr9L0AteiaJAkN2rovl5uXI/HAKNJrCK1jYh88GbJEDT5VZWafFT60UUc0hRiK6Zwj77SiPbCXo+FZ6x3enN8EvVPovCkE4YhC0+jMKQBHfOMyxh3hp3W83084fKhWa6qYCNH11BoMCBt7YhKCV+elwzQA2HxPIVWBWgr6vivBX2ZLGO1kA9000QpxVMJRCQgrUgF6NoKnouoNPXRoNVWWp4DvpkXiEDsBFZofOUzyDJHIreya0T8SEfVRpqfNTQBgju3jNUoJFWa2IkwK+PVOlW+xoDddRoH0t2GXfv8OfQBaT17Zw/b2CDf17ifcAseck9CqhZJtxFTpXNuaUTTTHG7O0INpIch3LZNud87rC1L4C8Z5bkqpV0/UmO/Bk4IN4SjypWZ3fbD8dpmjWCwqzRlg3awd+valGclyvD/CvdtChf8mwIWx7rk2b5grd4eCkX/YCh6u0OBy9WoqpB9E+AJaOQXPvXD/nan/l1Z8osqZULuJCF3Eomv4akEYyFBZqtSx0ASBYZIZQnMhLEd8ht/BGJKDY7yhVZTgfl///7ynAhDpjwTSedOuhrA9uECeolJeQDLpqANzhuQF5maAxi2zIGvHuw2AS245jlYd4TbBfVpaL6q0xxQgecouJ1QHE2eSqEhoZHVJQTbY4UXgK1uiOd23vsqbow4Wh1A2TTonHkqQWOheIfXCXZQ31wrcA1nrkryhaP+KOLwUGc5aniHwCwiR9jQjojS5Kgh7JFz1hv9g711891geMk+1PFuYlXTYi1aKc8MbHp2jqHPhQTjQoI6z8bcQEIGw0vik0i4MSoWHOnyRdgJOq7dhphnWYdcpkQqCciKhiZBvac1Bh4ZcpsLKfIyb2OPXkysLUzU7SYqNh03sHZilXebAZUVfK5Vlrn3XV6IhlpCPvzoAVlr+SW6URpIOnQ/N1bjQy/svWLha3b8CsfeBFJeZrYu0ma9qkabYXsLdkmfrWYowHTu5J00sSogIp+WZN5RAZEGnnxCheIPWAH0oqkXdGfGTAH8EbiZM8w5U1PQWiRQF5nXo0G7nmBmQRo3xmM9PcKcRvsvAsGyEx2+ECDpGqh9Li2xdruGQczBTpRXCFf7dkIj2p0ed5cy0V2s1X7V3S0bBvS00YxSZ8h4TyNeiJpFLIHcUWmrHM8hV3Q9ujUecz0Fv3Nltgd4J+ZQq+QAZoGvMQQG4lLjcICe/6zygsv5II7BmEGJ0bgdtXe9Q/7W08OOvUtWo4sN2/F5DFy76l/30UOwDKaQEV7aCQ7tvhNWAX03Nxby77FQI+wxUKE2pcqh+pnJ6RfKAbLHK9ha7QUU9clcpe9AT0UMrXyspIKPVWm7bmM3QdPYjph7Zip1ecBPN539CFmsckD1dX4cGXLhi4AMa9FxSpWouMybS9QP/p7LY3fP9Up83lgl15D5ogko5FxkjlD+7U8r/lTummJszmUL5zld2TzDYnXn/ic0qc69hZntFhkXjiSuKBa+dm/p9NgdtBGtgEabvXtXAY8COlHGIsBigf3mvc6qCpfrvorFkQjDx9m+ztU++Ytr3+Rekr+z0+4JQK2Dmw2/0T5X5FOuBfr+fefYOavsccovcjlv+9I4u56SarScG7/Rwf/4tHAg3btHrVXSl/0R1bOwrXdb/wlba4RvL25oVf0JMQPIeA==
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Get employee time off activities.
+
+scope: `employee_time_off_activities:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/get-wire-in-requests-wire-in-request-uuid.ParamsDetails.json b/docs/api/get-wire-in-requests-wire-in-request-uuid.ParamsDetails.json
new file mode 100644
index 000000000..6742684e1
--- /dev/null
+++ b/docs/api/get-wire-in-requests-wire-in-request-uuid.ParamsDetails.json
@@ -0,0 +1 @@
+{"parameters":[{"name":"wire_in_request_uuid","in":"path","required":true,"schema":{"type":"string"},"description":"The UUID of the Wire In Request"},{"name":"X-Gusto-API-Version","in":"header","required":false,"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.","schema":{"type":"string","enum":["2025-06-15"],"default":"2025-06-15"}}]}
\ No newline at end of file
diff --git a/docs/api/get-wire-in-requests-wire-in-request-uuid.RequestSchema.json b/docs/api/get-wire-in-requests-wire-in-request-uuid.RequestSchema.json
new file mode 100644
index 000000000..c96bcede2
--- /dev/null
+++ b/docs/api/get-wire-in-requests-wire-in-request-uuid.RequestSchema.json
@@ -0,0 +1 @@
+{"title":"Body"}
\ No newline at end of file
diff --git a/docs/api/get-wire-in-requests-wire-in-request-uuid.StatusCodes.json b/docs/api/get-wire-in-requests-wire-in-request-uuid.StatusCodes.json
new file mode 100644
index 000000000..58a7d286c
--- /dev/null
+++ b/docs/api/get-wire-in-requests-wire-in-request-uuid.StatusCodes.json
@@ -0,0 +1 @@
+{"responses":{"200":{"description":"Example response","content":{"application/json":{"schema":{"type":"object","x-examples":{"example":{"uuid":"05ed3150-591e-4f8b-bfd5-55d478edd2d8","status":"awaiting_funds","origination_bank":"JP Morgan Chase","origination_bank_address":"1 Chase Plaza, New York, NY 10081","recipient_name":"Gusto, Inc","recipient_address":"525 20th Street, San Francisco, CA 94107","recipient_account_number":21911761,"recipient_routing_number":123454321,"additional_notes":"Additional Notes","bank_name":"JP Morgan Chase","date_sent":"2024-06-10","unique_tracking_code":"1trvxwxp57zf","payment_type":"Payroll","payment_uuid":"5faae454-e629-490b-a72a-c022c2c9e6bc","amount_sent":"1014500.00","requested_amount":"1014500.00","wire_in_deadline":"2024-06-21T18:00:00Z"}},"description":"Representation of a wire in request","properties":{"uuid":{"type":"string","description":"Unique identifier of a wire in request"},"status":{"type":"string","description":"Status of the wire in","enum":["awaiting_funds","pending_review","approved","canceled"]},"origination_bank":{"type":"string","description":"Name of bank receiving the wire in"},"origination_bank_address":{"type":"string","description":"Address of bank receiving the wire in"},"recipient_name":{"type":"string","description":"Name of the recipient of the wire In"},"recipient_address":{"type":"string","description":"Address of the recipient of the wire in"},"recipient_account_number":{"type":"string","description":"Recipient bank account number"},"recipient_routing_number":{"type":"string","description":"Recipient bank routing number"},"additional_notes":{"type":["string","null"],"description":"Notes for the wire in request"},"bank_name":{"type":["string","null"],"description":"Name of the bank initiating the wire in"},"date_sent":{"type":["string","null"],"description":"Date the wire in was sent"},"unique_tracking_code":{"type":"string","description":"Include in note with bank to track payment"},"payment_type":{"type":"string","description":"Type of payment for the wire in","enum":["Payroll","ContractorPaymentGroup"]},"payment_uuid":{"type":"string","description":"Unique identifier of the payment"},"amount_sent":{"type":["string","null"],"description":"Amount sent through wire in"},"requested_amount":{"type":"string","description":"Requested amount for the payment"},"wire_in_deadline":{"type":"string","description":"Deadline to submit the wire in"}},"title":"Wire-In-Request"},"examples":{"example":{"value":{"uuid":"c5fdae57-5483-4529-9aae-f0edceed92d4","status":"awaiting_funds","origination_bank":"JP Morgan Chase","origination_bank_address":"1 Chase Plaza, New York, NY 10081","recipient_name":"Gusto, Inc","recipient_address":"525 20th Street, San Francisco, CA 94107","recipient_account_number":21911761,"recipient_routing_number":123454321,"additional_notes":"Additional Notes","bank_name":"JP Morgan Chase","date_sent":"2024-06-10","unique_tracking_code":"1trvxwxp57zf","payment_type":"Payroll","payment_uuid":"5faae454-e629-490b-a72a-c022c2c9e6bc","amount_sent":"1014500.00","requested_amount":"1014500.00","wire_in_deadline":"2024-06-21T18:00:00Z"}}}}}},"404":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided UUID is valid.\n"}}}
\ No newline at end of file
diff --git a/docs/api/get-wire-in-requests-wire-in-request-uuid.api.mdx b/docs/api/get-wire-in-requests-wire-in-request-uuid.api.mdx
new file mode 100644
index 000000000..246c1551a
--- /dev/null
+++ b/docs/api/get-wire-in-requests-wire-in-request-uuid.api.mdx
@@ -0,0 +1,71 @@
+---
+id: get-wire-in-requests-wire-in-request-uuid
+title: "Get a single Wire In Request"
+description: "Fetch a Wire In Request."
+sidebar_label: "Get a single Wire In Request"
+hide_title: true
+hide_table_of_contents: true
+api: eJztWFFv4zYS/iss76EtIMWS19rEemqw2V34gOaCJHu9XhK4tDi22UiklqScuIb/+2Eo2pZku95u0ZdD8xKLnPlmOBx+5MyKvoazylgVCmlhppkVSoZ2WQJNHygUE+AcOH0KqGUzg2M/CQ1kJMktfK7AWINzqoRac8RpSmdgwxehYSzkWHup7sC4qgSnAeVgMi1K1KUp/QA2mxNGOjbOHuWjNJkqISW/lGypVZ6bVAPjv9CAlkyzAixodG9FJSuApvSIPYFmSmbnNKA4JTRwmlpdQUBNNoeC0XRF6/VTY7WQM7ruunk/B/Lp0+iKqCmxc+i6S9fB1o3/hB9ddC9vRuG/QRsE8F7MgXHQLT+mLDfQtXaFayuEBOOMcWYhnDADnFzejMiiBiXMGJUJZoGTF2HnZKkq7QQyludnZDQlUkkgwpBSq4XgwINahpVlLjK3e98a8lAIKYqqaGI/fTe3tjRpr8dVZs5cupxlquht0iP0e+Lme6wUodcUcvYPDxg2hr9HNyoD/Iwej3pAQVYFZlw/6idh9DaME8w1DlNW5ZamzfH1+gnjaEolDRgE60cR/muH8v0rK8ocyEaSBjRT0oK0KNuIRO9Xgwqrfe/U5FfILA3oawg1mjPnf+NPl2kpjRLgb+IkCpNhDOFgejEJJ1OehEnCB+cXwHmfX+DyLbOVoSllL0xYIWfjaSW5oQFVWsyEdO6MJ0w+05T+84b8qPSMSfJuzpz7XaEx41yDQcC4FiI3OfuNBeQaXsjPSj8H5PpnEkfRRexSLxOlAGnHPl9dtgZkJLPW7A416SekH9k5ubMawAbkjknyQTOZCZOpgLy7JMNBHJ231bNMVWikKiagadqPh3F8/jZuymhVueVvZOL+m0EyeNOPA8o4F7hClo+lshhwerkdItduKKBu+X4Z+4HCYzM2bqcxcQYucSIa0EqKzxWMrWbZM9rPFEeE2OrF68trmZz/NnUksyzQS58FN3XCNyb8ridTxmCQDEJ42x+Gg2E0Cdl5n4VZ1O9n/WwIbycYWVa4eHh/4igeJFF0FkWeDcBY4ONaqDu/ITYOjOdCQmM9/fg+vkijKI2i/9L1Hm3dQqkBTbp0QfJiBNGIkMRbxQVpZHMr6ryul7V/NtvIn1wMieAgrZgK0IfB17t0P4V45+Q2BOuBGpywd1pKkBy/NSwEvGCISyQ6QNLPmMwgx2tsfehYnfLlmhWAnqA00ZCBWAg5azl2AHd3Zk7hX9aCp010T+uXOo4wW91WTEcd3K/x+Th61+suDZwycrtFdXHx6sSrr3+PPf4gtFdvQO9zzgbyYYcpqzyv76RW2FGeTJVuRqJ5CBpM9eWgjb10LgsprGD2QJo0qO6L4a+YhZa7L8wQh7E+RpGnQjySWV5xB4YRrJ8lznWriMMinjzRRptgT2HfL0sXDa/VDXaDKHZM/U5JtGqVvqm1PmpVlY4T2iT+VWyH1hvLaRH8F+/CpdNycSd2rlU1m7dPUvdqOJ3mXoPUGttANVzdv1BOoV55SdxIU00KYdspuA6oFRZfQ65aCEcy3D2N6ZFn04LlVfP9lCVTziA5D5PBxZtwkPSH4ZAxCKcR8AyAD/t88Pf76e/301/3fsK/gA6iwX4hca0s+aAqycmjJORR3rs7cHPWNBhV6QwIV2CQ/Ai8CmPPyI/sGYipdE21m0KsriWFIQuWC372WJ+g19CUwJ6BmWU4c0xVF7Ujua2820K4daFagNbC7cAM8DkHrxYkFl11dfwMS5oer/mDzTFs1v5Yzm70uj5tFbq+HVZq+7hTRl+xhCvAzhXfOu8K9ZT2FnGv21DorQ5V+GtkBNCLTTOg0jlW2r58ZaWoq9eQQ+FK2APUVqhOXGu80KUn6rmlHQE+iHmjFf8dzBKncfEGskoLu3Sev1NFyeTyMsvAmMsK4/Dw1JS6w8q0ZtEDslsKRxc3VTZ+T4Bp13Vo++ghwhwWkBNW2TlebnUxjKR9tzQWij9joUY4YmCNPZGpcqj+5nBMim0ITBPfOWnV/AHFvoj51/QO9EJk0NiPXYuCTVRle06wx9E0Fjeh+w7V1O0Dqnad/QnyTBXugnN+fGvIe38eiOcu1yHhKquKTUX1jW8nsMzdzJ5KrzZWyS3kTg4PLhRM5C6h/OwPu/zBaJTK2ILJBs5HsIQRI+Qs3+84dfxf7doaX9dT81tr4dX2ypzVzw+X8yt/KB/oIm6wqd5xUnqw9fYU0LkyFhVXK2xffdL5eo3DnyvQmPNPSAdasAlu/8OKcmHw95G2WHOJ3936Dtr35FRr7sjS/CCTywYp0cAz2MEFrfHh6Ht4f8zd//OG3sEA14E83A3dxnt3ZyDRlLYxt9eba90WH9/f0/X6fydn3Go=
+sidebar_class_name: "get api-method"
+info_path: docs/api/gusto-api
+custom_edit_url: null
+---
+
+import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
+import ParamsDetails from "@theme/ParamsDetails";
+import RequestSchema from "@theme/RequestSchema";
+import StatusCodes from "@theme/StatusCodes";
+import OperationTabs from "@theme/OperationTabs";
+import TabItem from "@theme/TabItem";
+import Heading from "@theme/Heading";
+import Translate from "@docusaurus/Translate";
+
+
+
+
+
+
+
+
+
+
+Fetch a Wire In Request.
+
+scope: `payrolls:read`
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/gusto-api.info.mdx b/docs/api/gusto-api.info.mdx
new file mode 100644
index 000000000..213d25d99
--- /dev/null
+++ b/docs/api/gusto-api.info.mdx
@@ -0,0 +1,125 @@
+---
+id: gusto-api
+title: "Gusto API"
+description: "Welcome to Gusto's Embedded Payroll API documentation!"
+sidebar_label: Introduction
+sidebar_position: 0
+hide_title: true
+custom_edit_url: null
+---
+
+import ApiLogo from "@theme/ApiLogo";
+import Heading from "@theme/Heading";
+import SchemaTabs from "@theme/SchemaTabs";
+import TabItem from "@theme/TabItem";
+import Export from "@theme/ApiExplorer/Export";
+
+
+
+
+
+
+
+
+
+Welcome to Gusto's Embedded Payroll API documentation!
+
+
-
+
Get Started
@@ -147,16 +147,16 @@ function QuickLinksSection() {
Explore the SDK
-
-
Workflows
+
+
Components
- Employee onboarding, payroll, contractor payments, and more.
+ Flows and blocks for onboarding, payroll, contractors, and more.
-
-
Integration Guide
+
+
Concepts
- Events, composition, theming, routing, and error handling.
+ Events, composition, theming, authentication, and error handling.
From 237ce7a10a5df465a2317af689db12d21d6b0b11 Mon Sep 17 00:00:00 2001
From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com>
Date: Thu, 30 Apr 2026 19:02:31 +0000
Subject: [PATCH 3/3] ci: fix lint, format, and endpoint inventory failures
Agent-Logs-Url: https://github.com/Gusto/embedded-react-sdk/sessions/520ce5dc-71be-42ff-aeac-87f2234d1366
---
.prettierignore | 1 +
docs/components/company/assign-signatory.md | 26 +-
docs/components/company/bank-account.md | 24 +-
docs/components/company/company.md | 38 +-
docs/components/company/create-signatory.md | 22 +-
docs/components/company/document-list.md | 14 +-
docs/components/company/document-signer.md | 36 +-
docs/components/company/federal-taxes.md | 16 +-
docs/components/company/industry.md | 16 +-
docs/components/company/invite-signatory.md | 18 +-
docs/components/company/locations.md | 24 +-
docs/components/company/onboarding-flow.md | 10 +-
.../components/company/onboarding-overview.md | 14 +-
docs/components/company/pay-schedule.md | 16 +-
docs/components/company/signature-form.md | 20 +-
docs/components/company/state-taxes-form.md | 16 +-
docs/components/company/state-taxes-list.md | 14 +-
docs/components/company/state-taxes.md | 18 +-
docs/components/contractor/address.md | 16 +-
docs/components/contractor/contractor-list.md | 22 +-
.../contractor/contractor-profile.md | 22 +-
.../contractor/contractor-submit.md | 20 +-
docs/components/contractor/contractor.md | 30 +-
docs/components/contractor/create-payment.md | 24 +-
docs/components/contractor/new-hire-report.md | 16 +-
docs/components/contractor/onboarding-flow.md | 10 +-
docs/components/contractor/payment-flow.md | 8 +-
docs/components/contractor/payment-history.md | 14 +-
docs/components/contractor/payment-method.md | 18 +-
.../contractor/payment-statement.md | 10 +-
docs/components/contractor/payment-summary.md | 16 +-
docs/components/contractor/payments-list.md | 20 +-
docs/components/employee/compensation.md | 32 +-
docs/components/employee/deductions.md | 37 +-
docs/components/employee/document-signer.md | 30 +-
.../components/employee/employee-documents.md | 21 +-
docs/components/employee/employee-list.md | 25 +-
docs/components/employee/employee.md | 44 +-
.../employee/employment-eligibility.md | 23 +-
docs/components/employee/federal-taxes.md | 23 +-
docs/components/employee/landing.md | 22 +-
docs/components/employee/onboarding-flow.md | 22 +-
.../components/employee/onboarding-summary.md | 26 +-
docs/components/employee/payment-method.md | 27 +-
docs/components/employee/profile.md | 38 +-
.../employee/self-onboarding-flow.md | 12 +-
docs/components/employee/state-taxes.md | 25 +-
docs/components/employee/taxes.md | 19 +-
.../components/employee/terminate-employee.md | 24 +-
docs/components/employee/termination-flow.md | 42 +-
.../employee/termination-summary.md | 28 +-
.../information-request-form.md | 18 +-
.../information-request-list.md | 12 +-
.../information-requests-flow.md | 20 +-
.../information-requests.md | 8 +-
.../payroll/confirm-wire-details.md | 28 +-
docs/components/payroll/dismissal-flow.md | 16 +-
docs/components/payroll/off-cycle-creation.md | 14 +-
.../payroll/off-cycle-deductions-setting.md | 12 +-
docs/components/payroll/off-cycle-flow.md | 16 +-
.../payroll/off-cycle-reason-selection.md | 12 +-
docs/components/payroll/payroll-blocker.md | 10 +-
.../payroll/payroll-configuration.md | 36 +-
.../payroll/payroll-edit-employee.md | 24 +-
.../payroll/payroll-execution-flow.md | 18 +-
docs/components/payroll/payroll-flow.md | 44 +-
docs/components/payroll/payroll-history.md | 18 +-
docs/components/payroll/payroll-landing.md | 34 +-
docs/components/payroll/payroll-list.md | 22 +-
docs/components/payroll/payroll-overview.md | 36 +-
docs/components/payroll/payroll-receipts.md | 12 +-
docs/components/payroll/payroll.md | 44 +-
docs/components/payroll/recovery-cases.md | 18 +-
.../components/payroll/transition-creation.md | 18 +-
docs/components/payroll/transition-flow.md | 18 +-
docs/concepts/authentication-and-proxy.md | 14 +-
docs/concepts/composition.md | 11 +-
docs/concepts/error-handling.md | 18 +-
docs/concepts/events.md | 424 ++-
docs/concepts/flows-and-blocks.md | 28 +-
docs/concepts/i18n.md | 10 +-
docs/concepts/provider-and-configuration.md | 20 +-
docs/guides/component-adapter.md | 31 +-
docs/guides/guides.md | 20 +-
docs/guides/observability.md | 30 +-
docs/guides/request-interceptors.md | 12 +-
docs/guides/routing.md | 25 +-
docs/guides/theme-variables.md | 124 +-
docs/quickstart/first-flow.md | 7 +-
docs/reference/endpoint-reference.md | 2 +
docs/what-is-the-gep-react-sdk.md | 13 +-
.../information-requests.md | 32 +-
docs/workflows-overview/run-payroll.md | 50 +-
e2e/package-lock.json | 2439 -----------------
eslint.config.mjs | 1 +
website/docusaurus.config.ts | 18 +-
website/sidebars.ts | 12 +-
website/src/css/custom.css | 24 +-
website/src/pages/index.module.css | 18 +-
website/src/pages/index.tsx | 133 +-
website/src/theme/NotFound/Content/index.tsx | 10 +-
.../theme/NotFound/Content/styles.module.css | 8 +-
102 files changed, 1341 insertions(+), 3810 deletions(-)
delete mode 100644 e2e/package-lock.json
diff --git a/.prettierignore b/.prettierignore
index df0c0572c..d075a6526 100644
--- a/.prettierignore
+++ b/.prettierignore
@@ -5,4 +5,5 @@ src/generated
src/types/i18nresources.d.ts
docs/reference/endpoint-inventory.json
docs/reference/endpoint-reference.md
+docs/api/
.claude/settings.local.json
\ No newline at end of file
diff --git a/docs/components/company/assign-signatory.md b/docs/components/company/assign-signatory.md
index a23c914b9..4903e6846 100644
--- a/docs/components/company/assign-signatory.md
+++ b/docs/components/company/assign-signatory.md
@@ -24,19 +24,19 @@ function MyComponent() {
## Props
-| Name | Type | Required | Description |
-| --- | --- | --- | --- |
-| `companyId` | `string` | Yes | The associated company identifier. |
-| `signatoryId` | `string` | No | ID of the signatory. When set and matching the current signatory, the create form pre-populates with their information for editing. |
-| `defaultValues` | `object` | No | Default values containing `create` and/or `invite` objects for their respective forms. See [CreateSignatory](./create-signatory.md) and [InviteSignatory](./invite-signatory.md) for field details. |
-| `onEvent` | `(eventType: string, data?: unknown) => void` | Yes | Callback invoked when events are emitted. |
+| Name | Type | Required | Description |
+| --------------- | --------------------------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `companyId` | `string` | Yes | The associated company identifier. |
+| `signatoryId` | `string` | No | ID of the signatory. When set and matching the current signatory, the create form pre-populates with their information for editing. |
+| `defaultValues` | `object` | No | Default values containing `create` and/or `invite` objects for their respective forms. See [CreateSignatory](./create-signatory.md) and [InviteSignatory](./invite-signatory.md) for field details. |
+| `onEvent` | `(eventType: string, data?: unknown) => void` | Yes | Callback invoked when events are emitted. |
## Events
-| Event | Description | Data |
-| --- | --- | --- |
-| `COMPANY_ASSIGN_SIGNATORY_MODE_UPDATED` | Fired when the user switches between create and invite modes. | Mode string (`'createSignatory'` or `'inviteSignatory'`) |
-| `COMPANY_ASSIGN_SIGNATORY_DONE` | Fired when the signatory assignment process is complete. | None |
-| `COMPANY_SIGNATORY_CREATED` | Fired when a new signatory is created (create mode). | [Response from the create signatory API](https://docs.gusto.com/embedded-payroll/reference/post-v1-company-signatories) |
-| `COMPANY_SIGNATORY_UPDATED` | Fired when an existing signatory is updated (create mode). | [Response from the update signatory API](https://docs.gusto.com/embedded-payroll/reference/put-v1-companies-company_uuid-signatories-signatory_uuid) |
-| `COMPANY_SIGNATORY_INVITED` | Fired when a signatory invitation is sent (invite mode). | [Response from the invite signatory API](https://docs.gusto.com/embedded-payroll/reference/post-v1-companies-company_uuid-signatories-invite) |
+| Event | Description | Data |
+| --------------------------------------- | ------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `COMPANY_ASSIGN_SIGNATORY_MODE_UPDATED` | Fired when the user switches between create and invite modes. | Mode string (`'createSignatory'` or `'inviteSignatory'`) |
+| `COMPANY_ASSIGN_SIGNATORY_DONE` | Fired when the signatory assignment process is complete. | None |
+| `COMPANY_SIGNATORY_CREATED` | Fired when a new signatory is created (create mode). | [Response from the create signatory API](https://docs.gusto.com/embedded-payroll/reference/post-v1-company-signatories) |
+| `COMPANY_SIGNATORY_UPDATED` | Fired when an existing signatory is updated (create mode). | [Response from the update signatory API](https://docs.gusto.com/embedded-payroll/reference/put-v1-companies-company_uuid-signatories-signatory_uuid) |
+| `COMPANY_SIGNATORY_INVITED` | Fired when a signatory invitation is sent (invite mode). | [Response from the invite signatory API](https://docs.gusto.com/embedded-payroll/reference/post-v1-companies-company_uuid-signatories-invite) |
diff --git a/docs/components/company/bank-account.md b/docs/components/company/bank-account.md
index 90956761d..e3b21a8c5 100644
--- a/docs/components/company/bank-account.md
+++ b/docs/components/company/bank-account.md
@@ -24,18 +24,18 @@ function MyComponent() {
## Props
-| Name | Type | Required | Description |
-| --- | --- | --- | --- |
-| `companyId` | `string` | Yes | The associated company identifier. |
-| `defaultValues` | `object` | No | Default values for bank account form fields. **Note:** This prop is accepted by the type definition but is not currently forwarded by the BankAccount orchestrator component. |
-| `onEvent` | `(eventType: string, data?: unknown) => void` | Yes | Callback invoked when events are emitted. |
+| Name | Type | Required | Description |
+| --------------- | --------------------------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `companyId` | `string` | Yes | The associated company identifier. |
+| `defaultValues` | `object` | No | Default values for bank account form fields. **Note:** This prop is accepted by the type definition but is not currently forwarded by the BankAccount orchestrator component. |
+| `onEvent` | `(eventType: string, data?: unknown) => void` | Yes | Callback invoked when events are emitted. |
## Events
-| Event | Description | Data |
-| --- | --- | --- |
-| `COMPANY_BANK_ACCOUNT_CHANGE` | Fired when a user chooses to change the existing bank account. | None |
-| `COMPANY_BANK_ACCOUNT_CREATED` | Fired when a new bank account is created. | [Response from the create company bank account API](https://docs.gusto.com/embedded-payroll/reference/post-v1-companies-company_id-bank-accounts) |
-| `COMPANY_BANK_ACCOUNT_VERIFY` | Fired when a user chooses to verify a bank account (after micro-deposits are made). | None |
-| `COMPANY_BANK_ACCOUNT_VERIFIED` | Fired when a bank account has been successfully verified. | [Response from the verify company bank account API](https://docs.gusto.com/embedded-payroll/reference/put-v1-companies-company_id-bank-accounts-verify) |
-| `COMPANY_BANK_ACCOUNT_DONE` | Fired when the user chooses to proceed to the next step. | None |
+| Event | Description | Data |
+| ------------------------------- | ----------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `COMPANY_BANK_ACCOUNT_CHANGE` | Fired when a user chooses to change the existing bank account. | None |
+| `COMPANY_BANK_ACCOUNT_CREATED` | Fired when a new bank account is created. | [Response from the create company bank account API](https://docs.gusto.com/embedded-payroll/reference/post-v1-companies-company_id-bank-accounts) |
+| `COMPANY_BANK_ACCOUNT_VERIFY` | Fired when a user chooses to verify a bank account (after micro-deposits are made). | None |
+| `COMPANY_BANK_ACCOUNT_VERIFIED` | Fired when a bank account has been successfully verified. | [Response from the verify company bank account API](https://docs.gusto.com/embedded-payroll/reference/put-v1-companies-company_id-bank-accounts-verify) |
+| `COMPANY_BANK_ACCOUNT_DONE` | Fired when the user chooses to proceed to the next step. | None |
diff --git a/docs/components/company/company.md b/docs/components/company/company.md
index 7c760d841..66506a71a 100644
--- a/docs/components/company/company.md
+++ b/docs/components/company/company.md
@@ -7,26 +7,26 @@ The Company domain provides components for onboarding a company onto Gusto's emb
## Flow
-| Component | Description |
-| --- | --- |
+| Component | Description |
+| ---------------------------------------------- | ------------------------------------------------------------------------------------------ |
| [Company.OnboardingFlow](./onboarding-flow.md) | End-to-end company onboarding workflow that orchestrates all onboarding steps in sequence. |
## Blocks
-| Component | Description |
-| --- | --- |
-| [Company.AssignSignatory](./assign-signatory.md) | Allows users to choose between creating a new signatory or inviting someone else. |
-| [Company.CreateSignatory](./create-signatory.md) | Standalone form for creating a signatory with full personal details. |
-| [Company.InviteSignatory](./invite-signatory.md) | Standalone form for inviting someone to become the company signatory. |
-| [Company.Industry](./industry.md) | Industry selection for the company. |
-| [Company.DocumentSigner](./document-signer.md) | Interface for reading and signing required company documents. |
-| [Company.DocumentList](./document-list.md) | Displays the list of company forms available for signing. |
-| [Company.SignatureForm](./signature-form.md) | Form for reviewing and signing an individual company document. |
-| [Company.FederalTaxes](./federal-taxes.md) | Form for entering federal tax information (EIN, tax payer type, filing form). |
-| [Company.PaySchedule](./pay-schedule.md) | Manages company pay schedules with create, edit, and preview functionality. |
-| [Company.Locations](./locations.md) | Manages company addresses including mailing and filing locations. |
-| [Company.BankAccount](./bank-account.md) | Manages company bank account setup and verification. |
-| [Company.StateTaxes](./state-taxes.md) | Orchestrated state tax setup switching between list and edit views. |
-| [Company.StateTaxesList](./state-taxes-list.md) | Displays the list of state tax requirements for a company. |
-| [Company.StateTaxesForm](./state-taxes-form.md) | Form for editing state tax requirements for a specific state. |
-| [Company.OnboardingOverview](./onboarding-overview.md) | Displays onboarding progress and outstanding requirements. |
+| Component | Description |
+| ------------------------------------------------------ | --------------------------------------------------------------------------------- |
+| [Company.AssignSignatory](./assign-signatory.md) | Allows users to choose between creating a new signatory or inviting someone else. |
+| [Company.CreateSignatory](./create-signatory.md) | Standalone form for creating a signatory with full personal details. |
+| [Company.InviteSignatory](./invite-signatory.md) | Standalone form for inviting someone to become the company signatory. |
+| [Company.Industry](./industry.md) | Industry selection for the company. |
+| [Company.DocumentSigner](./document-signer.md) | Interface for reading and signing required company documents. |
+| [Company.DocumentList](./document-list.md) | Displays the list of company forms available for signing. |
+| [Company.SignatureForm](./signature-form.md) | Form for reviewing and signing an individual company document. |
+| [Company.FederalTaxes](./federal-taxes.md) | Form for entering federal tax information (EIN, tax payer type, filing form). |
+| [Company.PaySchedule](./pay-schedule.md) | Manages company pay schedules with create, edit, and preview functionality. |
+| [Company.Locations](./locations.md) | Manages company addresses including mailing and filing locations. |
+| [Company.BankAccount](./bank-account.md) | Manages company bank account setup and verification. |
+| [Company.StateTaxes](./state-taxes.md) | Orchestrated state tax setup switching between list and edit views. |
+| [Company.StateTaxesList](./state-taxes-list.md) | Displays the list of state tax requirements for a company. |
+| [Company.StateTaxesForm](./state-taxes-form.md) | Form for editing state tax requirements for a specific state. |
+| [Company.OnboardingOverview](./onboarding-overview.md) | Displays onboarding progress and outstanding requirements. |
diff --git a/docs/components/company/create-signatory.md b/docs/components/company/create-signatory.md
index 0d451b397..46801235a 100644
--- a/docs/components/company/create-signatory.md
+++ b/docs/components/company/create-signatory.md
@@ -24,17 +24,17 @@ function MyComponent() {
## Props
-| Name | Type | Required | Description |
-| --- | --- | --- | --- |
-| `companyId` | `string` | Yes | The associated company identifier. |
-| `signatoryId` | `string` | No | ID of the signatory. When set and matching an existing signatory, the form pre-populates with their information for editing. |
-| `defaultValues` | `object` | No | Default values for form fields: `firstName`, `lastName`, `email`, `title`, `phone`, `birthday`, `ssn`, `street1`, `street2`, `city`, `state`, `zip`. If signatory data is available via the API, `defaultValues` will be overwritten. |
-| `onEvent` | `(eventType: string, data?: unknown) => void` | Yes | Callback invoked when events are emitted. |
+| Name | Type | Required | Description |
+| --------------- | --------------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `companyId` | `string` | Yes | The associated company identifier. |
+| `signatoryId` | `string` | No | ID of the signatory. When set and matching an existing signatory, the form pre-populates with their information for editing. |
+| `defaultValues` | `object` | No | Default values for form fields: `firstName`, `lastName`, `email`, `title`, `phone`, `birthday`, `ssn`, `street1`, `street2`, `city`, `state`, `zip`. If signatory data is available via the API, `defaultValues` will be overwritten. |
+| `onEvent` | `(eventType: string, data?: unknown) => void` | Yes | Callback invoked when events are emitted. |
## Events
-| Event | Description | Data |
-| --- | --- | --- |
-| `COMPANY_SIGNATORY_CREATED` | Fired when a new signatory is created successfully. | [Response from the create signatory API](https://docs.gusto.com/embedded-payroll/reference/post-v1-company-signatories) |
-| `COMPANY_SIGNATORY_UPDATED` | Fired when an existing signatory is updated successfully. | [Response from the update signatory API](https://docs.gusto.com/embedded-payroll/reference/put-v1-companies-company_uuid-signatories-signatory_uuid) |
-| `COMPANY_CREATE_SIGNATORY_DONE` | Fired when the create signatory process is complete. | None |
+| Event | Description | Data |
+| ------------------------------- | --------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `COMPANY_SIGNATORY_CREATED` | Fired when a new signatory is created successfully. | [Response from the create signatory API](https://docs.gusto.com/embedded-payroll/reference/post-v1-company-signatories) |
+| `COMPANY_SIGNATORY_UPDATED` | Fired when an existing signatory is updated successfully. | [Response from the update signatory API](https://docs.gusto.com/embedded-payroll/reference/put-v1-companies-company_uuid-signatories-signatory_uuid) |
+| `COMPANY_CREATE_SIGNATORY_DONE` | Fired when the create signatory process is complete. | None |
diff --git a/docs/components/company/document-list.md b/docs/components/company/document-list.md
index 358114e97..4d4d4ba39 100644
--- a/docs/components/company/document-list.md
+++ b/docs/components/company/document-list.md
@@ -24,14 +24,14 @@ function MyComponent() {
## Props
-| Name | Type | Required | Description |
-| --- | --- | --- | --- |
-| `companyId` | `string` | Yes | The associated company identifier. |
-| `signatoryId` | `string` | No | The signatory identifier. When provided, filters the document list to forms for this signatory. |
-| `onEvent` | `(eventType: string, data?: unknown) => void` | Yes | Callback invoked when events are emitted. |
+| Name | Type | Required | Description |
+| ------------- | --------------------------------------------- | -------- | ----------------------------------------------------------------------------------------------- |
+| `companyId` | `string` | Yes | The associated company identifier. |
+| `signatoryId` | `string` | No | The signatory identifier. When provided, filters the document list to forms for this signatory. |
+| `onEvent` | `(eventType: string, data?: unknown) => void` | Yes | Callback invoked when events are emitted. |
## Events
-| Event | Description | Data |
-| --- | --- | --- |
+| Event | Description | Data |
+| --------------------------- | ---------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
| `COMPANY_VIEW_FORM_TO_SIGN` | Fired when a user selects a form to sign from the document list. | [Response from the get company form API](https://docs.gusto.com/embedded-payroll/reference/get-v1-company-form) |
diff --git a/docs/components/company/document-signer.md b/docs/components/company/document-signer.md
index cb89b25cf..5710a99e3 100644
--- a/docs/components/company/document-signer.md
+++ b/docs/components/company/document-signer.md
@@ -24,24 +24,24 @@ function MyComponent() {
## Props
-| Name | Type | Required | Description |
-| --- | --- | --- | --- |
-| `companyId` | `string` | Yes | The associated company identifier. |
-| `signatoryId` | `string` | No | ID of the signatory. When set and matching the current signatory, the signature form pre-populates with their information and they can sign documents. |
-| `onEvent` | `(eventType: string, data?: unknown) => void` | Yes | Callback invoked when events are emitted. |
+| Name | Type | Required | Description |
+| ------------- | --------------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `companyId` | `string` | Yes | The associated company identifier. |
+| `signatoryId` | `string` | No | ID of the signatory. When set and matching the current signatory, the signature form pre-populates with their information and they can sign documents. |
+| `onEvent` | `(eventType: string, data?: unknown) => void` | Yes | Callback invoked when events are emitted. |
## Events
-| Event | Description | Data |
-| --- | --- | --- |
-| `COMPANY_VIEW_FORM_TO_SIGN` | Fired when a user selects a form to sign from the document list. | [Response from the get company form API](https://docs.gusto.com/embedded-payroll/reference/get-v1-company-form) |
-| `COMPANY_FORM_EDIT_SIGNATORY` | Fired when user requests to change the document signatory. | [Response from the create signatory API](https://docs.gusto.com/embedded-payroll/reference/post-v1-company-signatories) |
-| `COMPANY_FORMS_DONE` | Fired when user completes the document signing process. | None |
-| `COMPANY_SIGN_FORM` | Fired when a form is successfully signed. | [Response from the sign company form API](https://docs.gusto.com/embedded-payroll/reference/put-v1-company-form-sign) |
-| `COMPANY_SIGN_FORM_DONE` | Fired when the form signing process is complete. | None |
-| `COMPANY_SIGN_FORM_BACK` | Fired when user navigates back from the signature form. | None |
-| `COMPANY_ASSIGN_SIGNATORY_MODE_UPDATED` | Fired when the signatory assignment mode changes. | Mode string (`'create_signatory'` or `'invite_signatory'`) |
-| `COMPANY_ASSIGN_SIGNATORY_DONE` | Fired when the signatory assignment process is complete. | None |
-| `COMPANY_SIGNATORY_CREATED` | Fired when a new signatory is created successfully. | [Response from the create signatory API](https://docs.gusto.com/embedded-payroll/reference/post-v1-company-signatories) |
-| `COMPANY_SIGNATORY_UPDATED` | Fired when an existing signatory is updated successfully. | [Response from the update signatory API](https://docs.gusto.com/embedded-payroll/reference/put-v1-companies-company_uuid-signatories-signatory_uuid) |
-| `COMPANY_SIGNATORY_INVITED` | Fired when a signatory is successfully invited to the company. | [Response from the invite signatory API](https://docs.gusto.com/embedded-payroll/reference/post-v1-companies-company_uuid-signatories-invite) |
+| Event | Description | Data |
+| --------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `COMPANY_VIEW_FORM_TO_SIGN` | Fired when a user selects a form to sign from the document list. | [Response from the get company form API](https://docs.gusto.com/embedded-payroll/reference/get-v1-company-form) |
+| `COMPANY_FORM_EDIT_SIGNATORY` | Fired when user requests to change the document signatory. | [Response from the create signatory API](https://docs.gusto.com/embedded-payroll/reference/post-v1-company-signatories) |
+| `COMPANY_FORMS_DONE` | Fired when user completes the document signing process. | None |
+| `COMPANY_SIGN_FORM` | Fired when a form is successfully signed. | [Response from the sign company form API](https://docs.gusto.com/embedded-payroll/reference/put-v1-company-form-sign) |
+| `COMPANY_SIGN_FORM_DONE` | Fired when the form signing process is complete. | None |
+| `COMPANY_SIGN_FORM_BACK` | Fired when user navigates back from the signature form. | None |
+| `COMPANY_ASSIGN_SIGNATORY_MODE_UPDATED` | Fired when the signatory assignment mode changes. | Mode string (`'create_signatory'` or `'invite_signatory'`) |
+| `COMPANY_ASSIGN_SIGNATORY_DONE` | Fired when the signatory assignment process is complete. | None |
+| `COMPANY_SIGNATORY_CREATED` | Fired when a new signatory is created successfully. | [Response from the create signatory API](https://docs.gusto.com/embedded-payroll/reference/post-v1-company-signatories) |
+| `COMPANY_SIGNATORY_UPDATED` | Fired when an existing signatory is updated successfully. | [Response from the update signatory API](https://docs.gusto.com/embedded-payroll/reference/put-v1-companies-company_uuid-signatories-signatory_uuid) |
+| `COMPANY_SIGNATORY_INVITED` | Fired when a signatory is successfully invited to the company. | [Response from the invite signatory API](https://docs.gusto.com/embedded-payroll/reference/post-v1-companies-company_uuid-signatories-invite) |
diff --git a/docs/components/company/federal-taxes.md b/docs/components/company/federal-taxes.md
index ec23a84e7..ac8ffa2c9 100644
--- a/docs/components/company/federal-taxes.md
+++ b/docs/components/company/federal-taxes.md
@@ -24,15 +24,15 @@ function MyComponent() {
## Props
-| Name | Type | Required | Description |
-| --- | --- | --- | --- |
-| `companyId` | `string` | Yes | The associated company identifier. |
-| `defaultValues` | `{ legalName?: string, taxPayerType?: string, filingForm?: string }` | No | Default values for the federal taxes form fields. If company data for these fields is available via the API, `defaultValues` will be overwritten. |
-| `onEvent` | `(eventType: string, data?: unknown) => void` | Yes | Callback invoked when events are emitted. |
+| Name | Type | Required | Description |
+| --------------- | -------------------------------------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `companyId` | `string` | Yes | The associated company identifier. |
+| `defaultValues` | `{ legalName?: string, taxPayerType?: string, filingForm?: string }` | No | Default values for the federal taxes form fields. If company data for these fields is available via the API, `defaultValues` will be overwritten. |
+| `onEvent` | `(eventType: string, data?: unknown) => void` | Yes | Callback invoked when events are emitted. |
## Events
-| Event | Description | Data |
-| --- | --- | --- |
+| Event | Description | Data |
+| ------------------------------- | -------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
| `COMPANY_FEDERAL_TAXES_UPDATED` | Fired when federal tax details are successfully updated. | [Response from the update federal tax details API](https://docs.gusto.com/embedded-payroll/reference/put-v1-companies-company_id-federal_tax_details) |
-| `COMPANY_FEDERAL_TAXES_DONE` | Fired when the federal tax update process is complete. | None |
+| `COMPANY_FEDERAL_TAXES_DONE` | Fired when the federal tax update process is complete. | None |
diff --git a/docs/components/company/industry.md b/docs/components/company/industry.md
index a9f0fb780..18935696c 100644
--- a/docs/components/company/industry.md
+++ b/docs/components/company/industry.md
@@ -24,14 +24,14 @@ function MyComponent() {
## Props
-| Name | Type | Required | Description |
-| --- | --- | --- | --- |
-| `companyId` | `string` | Yes | The associated company identifier. |
-| `onEvent` | `(eventType: string, data?: unknown) => void` | Yes | Callback invoked when events are emitted. |
+| Name | Type | Required | Description |
+| ----------- | --------------------------------------------- | -------- | ----------------------------------------- |
+| `companyId` | `string` | Yes | The associated company identifier. |
+| `onEvent` | `(eventType: string, data?: unknown) => void` | Yes | Callback invoked when events are emitted. |
## Events
-| Event | Description | Data |
-| --- | --- | --- |
-| `COMPANY_INDUSTRY_SELECTED` | Fired when an industry is selected. | Selected industry data |
-| `COMPANY_INDUSTRY` | Fired when the industry selection process is complete. | None |
+| Event | Description | Data |
+| --------------------------- | ------------------------------------------------------ | ---------------------- |
+| `COMPANY_INDUSTRY_SELECTED` | Fired when an industry is selected. | Selected industry data |
+| `COMPANY_INDUSTRY` | Fired when the industry selection process is complete. | None |
diff --git a/docs/components/company/invite-signatory.md b/docs/components/company/invite-signatory.md
index 29acac907..edf402d87 100644
--- a/docs/components/company/invite-signatory.md
+++ b/docs/components/company/invite-signatory.md
@@ -24,15 +24,15 @@ function MyComponent() {
## Props
-| Name | Type | Required | Description |
-| --- | --- | --- | --- |
-| `companyId` | `string` | Yes | The associated company identifier. |
-| `defaultValues` | `object` | No | Default values for form fields: `firstName`, `lastName`, `email`, `confirmEmail`, `title`. |
-| `onEvent` | `(eventType: string, data?: unknown) => void` | Yes | Callback invoked when events are emitted. |
+| Name | Type | Required | Description |
+| --------------- | --------------------------------------------- | -------- | ------------------------------------------------------------------------------------------ |
+| `companyId` | `string` | Yes | The associated company identifier. |
+| `defaultValues` | `object` | No | Default values for form fields: `firstName`, `lastName`, `email`, `confirmEmail`, `title`. |
+| `onEvent` | `(eventType: string, data?: unknown) => void` | Yes | Callback invoked when events are emitted. |
## Events
-| Event | Description | Data |
-| --- | --- | --- |
-| `COMPANY_SIGNATORY_INVITED` | Fired when a signatory is successfully invited to the company. | [Response from the invite signatory API](https://docs.gusto.com/embedded-payroll/reference/post-v1-companies-company_uuid-signatories-invite) |
-| `COMPANY_INVITE_SIGNATORY_DONE` | Fired when the invite signatory process is complete. | None |
+| Event | Description | Data |
+| ------------------------------- | -------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
+| `COMPANY_SIGNATORY_INVITED` | Fired when a signatory is successfully invited to the company. | [Response from the invite signatory API](https://docs.gusto.com/embedded-payroll/reference/post-v1-companies-company_uuid-signatories-invite) |
+| `COMPANY_INVITE_SIGNATORY_DONE` | Fired when the invite signatory process is complete. | None |
diff --git a/docs/components/company/locations.md b/docs/components/company/locations.md
index ce3929250..e482f33b1 100644
--- a/docs/components/company/locations.md
+++ b/docs/components/company/locations.md
@@ -24,18 +24,18 @@ function MyComponent() {
## Props
-| Name | Type | Required | Description |
-| --- | --- | --- | --- |
-| `companyId` | `string` | Yes | The associated company identifier. |
-| `defaultValues` | `object` | No | Default values for location form fields. **Note:** This prop is accepted by the type definition but is not currently forwarded by the Locations orchestrator component. |
-| `onEvent` | `(eventType: string, data?: unknown) => void` | Yes | Callback invoked when events are emitted. |
+| Name | Type | Required | Description |
+| --------------- | --------------------------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `companyId` | `string` | Yes | The associated company identifier. |
+| `defaultValues` | `object` | No | Default values for location form fields. **Note:** This prop is accepted by the type definition but is not currently forwarded by the Locations orchestrator component. |
+| `onEvent` | `(eventType: string, data?: unknown) => void` | Yes | Callback invoked when events are emitted. |
## Events
-| Event | Description | Data |
-| --- | --- | --- |
-| `COMPANY_LOCATION_CREATE` | Fired when a user chooses to add a new location. | None |
-| `COMPANY_LOCATION_CREATED` | Fired when a new location is created. | [Response from the create company location API](https://docs.gusto.com/embedded-payroll/reference/post-v1-companies-company_id-locations) |
-| `COMPANY_LOCATION_EDIT` | Fired when a user selects an existing location for editing. | `{ uuid: string }` |
-| `COMPANY_LOCATION_UPDATED` | Fired when a location has been successfully edited. | [Response from the update location API](https://docs.gusto.com/embedded-payroll/reference/put-v1-locations-location_id) |
-| `COMPANY_LOCATION_DONE` | Fired when the user chooses to proceed to the next step. | None |
+| Event | Description | Data |
+| -------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
+| `COMPANY_LOCATION_CREATE` | Fired when a user chooses to add a new location. | None |
+| `COMPANY_LOCATION_CREATED` | Fired when a new location is created. | [Response from the create company location API](https://docs.gusto.com/embedded-payroll/reference/post-v1-companies-company_id-locations) |
+| `COMPANY_LOCATION_EDIT` | Fired when a user selects an existing location for editing. | `{ uuid: string }` |
+| `COMPANY_LOCATION_UPDATED` | Fired when a location has been successfully edited. | [Response from the update location API](https://docs.gusto.com/embedded-payroll/reference/put-v1-locations-location_id) |
+| `COMPANY_LOCATION_DONE` | Fired when the user chooses to proceed to the next step. | None |
diff --git a/docs/components/company/onboarding-flow.md b/docs/components/company/onboarding-flow.md
index 315c18f50..78fa66c48 100644
--- a/docs/components/company/onboarding-flow.md
+++ b/docs/components/company/onboarding-flow.md
@@ -40,11 +40,11 @@ function MyApp() {
## Props
-| Name | Type | Required | Description |
-| --- | --- | --- | --- |
-| `companyId` | `string` | Yes | The associated company identifier. |
-| `defaultValues` | `object` | No | Default values for individual flow step components. |
-| `onEvent` | `(eventType: string, data?: unknown) => void` | Yes | Callback invoked when events are emitted. Receives events from all subcomponents. |
+| Name | Type | Required | Description |
+| --------------- | --------------------------------------------- | -------- | --------------------------------------------------------------------------------- |
+| `companyId` | `string` | Yes | The associated company identifier. |
+| `defaultValues` | `object` | No | Default values for individual flow step components. |
+| `onEvent` | `(eventType: string, data?: unknown) => void` | Yes | Callback invoked when events are emitted. Receives events from all subcomponents. |
## Events
diff --git a/docs/components/company/onboarding-overview.md b/docs/components/company/onboarding-overview.md
index 913895524..0cb1b0484 100644
--- a/docs/components/company/onboarding-overview.md
+++ b/docs/components/company/onboarding-overview.md
@@ -24,14 +24,14 @@ function MyComponent() {
## Props
-| Name | Type | Required | Description |
-| --- | --- | --- | --- |
-| `companyId` | `string` | Yes | The associated company identifier. |
-| `onEvent` | `(eventType: string, data?: unknown) => void` | Yes | Callback invoked when events are emitted. |
+| Name | Type | Required | Description |
+| ----------- | --------------------------------------------- | -------- | ----------------------------------------- |
+| `companyId` | `string` | Yes | The associated company identifier. |
+| `onEvent` | `(eventType: string, data?: unknown) => void` | Yes | Callback invoked when events are emitted. |
## Events
-| Event | Description | Data |
-| --- | --- | --- |
+| Event | Description | Data |
+| --------------------------- | ------------------------------------------------------------------------ | ---- |
| `COMPANY_OVERVIEW_CONTINUE` | Fired when the user chooses to continue with a specific onboarding step. | None |
-| `COMPANY_OVERVIEW_DONE` | Fired when all onboarding requirements are complete. | None |
+| `COMPANY_OVERVIEW_DONE` | Fired when all onboarding requirements are complete. | None |
diff --git a/docs/components/company/pay-schedule.md b/docs/components/company/pay-schedule.md
index 88d9e75e3..adbb61315 100644
--- a/docs/components/company/pay-schedule.md
+++ b/docs/components/company/pay-schedule.md
@@ -24,15 +24,15 @@ function MyComponent() {
## Props
-| Name | Type | Required | Description |
-| --- | --- | --- | --- |
-| `companyId` | `string` | Yes | The associated company identifier. |
-| `defaultValues` | `{ frequency?: string, anchorPayDate?: string, anchorEndOfPayPeriod?: string, day1?: number, day2?: number, customName?: string }` | No | Default values for the pay schedule form fields. `frequency` accepts `'Every Week'`, `'Every other week'`, `'Twice per month'`, or `'Monthly'`. If company data for these fields is available via the API, `defaultValues` will be overwritten. |
-| `onEvent` | `(eventType: string, data?: unknown) => void` | Yes | Callback invoked when events are emitted. |
+| Name | Type | Required | Description |
+| --------------- | ---------------------------------------------------------------------------------------------------------------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `companyId` | `string` | Yes | The associated company identifier. |
+| `defaultValues` | `{ frequency?: string, anchorPayDate?: string, anchorEndOfPayPeriod?: string, day1?: number, day2?: number, customName?: string }` | No | Default values for the pay schedule form fields. `frequency` accepts `'Every Week'`, `'Every other week'`, `'Twice per month'`, or `'Monthly'`. If company data for these fields is available via the API, `defaultValues` will be overwritten. |
+| `onEvent` | `(eventType: string, data?: unknown) => void` | Yes | Callback invoked when events are emitted. |
## Events
-| Event | Description | Data |
-| --- | --- | --- |
-| `PAY_SCHEDULE_CREATED` | Fired when a new pay schedule is successfully created. | [Response from the create pay schedule API](https://docs.gusto.com/embedded-payroll/reference/post-v1-companies-company_id-pay_schedules) |
+| Event | Description | Data |
+| ---------------------- | ------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `PAY_SCHEDULE_CREATED` | Fired when a new pay schedule is successfully created. | [Response from the create pay schedule API](https://docs.gusto.com/embedded-payroll/reference/post-v1-companies-company_id-pay_schedules) |
| `PAY_SCHEDULE_UPDATED` | Fired when an existing pay schedule is successfully updated. | [Response from the update pay schedule API](https://docs.gusto.com/embedded-payroll/reference/put-v1-companies-company_id-pay_schedules-pay_schedule_id) |
diff --git a/docs/components/company/signature-form.md b/docs/components/company/signature-form.md
index 4b784e461..ca522c56f 100644
--- a/docs/components/company/signature-form.md
+++ b/docs/components/company/signature-form.md
@@ -25,16 +25,16 @@ function MyComponent() {
## Props
-| Name | Type | Required | Description |
-| --- | --- | --- | --- |
-| `companyId` | `string` | Yes | The associated company identifier. |
-| `formId` | `string` | Yes | The identifier of the form to sign. |
-| `onEvent` | `(eventType: string, data?: unknown) => void` | Yes | Callback invoked when events are emitted. |
+| Name | Type | Required | Description |
+| ----------- | --------------------------------------------- | -------- | ----------------------------------------- |
+| `companyId` | `string` | Yes | The associated company identifier. |
+| `formId` | `string` | Yes | The identifier of the form to sign. |
+| `onEvent` | `(eventType: string, data?: unknown) => void` | Yes | Callback invoked when events are emitted. |
## Events
-| Event | Description | Data |
-| --- | --- | --- |
-| `COMPANY_SIGN_FORM` | Fired when a form is successfully signed. | [Response from the sign company form API](https://docs.gusto.com/embedded-payroll/reference/put-v1-company-form-sign) |
-| `COMPANY_SIGN_FORM_DONE` | Fired when the form signing process is complete. | None |
-| `COMPANY_SIGN_FORM_BACK` | Fired when the user navigates back from the signature form. | None |
+| Event | Description | Data |
+| ------------------------ | ----------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
+| `COMPANY_SIGN_FORM` | Fired when a form is successfully signed. | [Response from the sign company form API](https://docs.gusto.com/embedded-payroll/reference/put-v1-company-form-sign) |
+| `COMPANY_SIGN_FORM_DONE` | Fired when the form signing process is complete. | None |
+| `COMPANY_SIGN_FORM_BACK` | Fired when the user navigates back from the signature form. | None |
diff --git a/docs/components/company/state-taxes-form.md b/docs/components/company/state-taxes-form.md
index 34e5ad96b..bdde7b667 100644
--- a/docs/components/company/state-taxes-form.md
+++ b/docs/components/company/state-taxes-form.md
@@ -25,15 +25,15 @@ function MyComponent() {
## Props
-| Name | Type | Required | Description |
-| --- | --- | --- | --- |
-| `companyId` | `string` | Yes | The associated company identifier. |
-| `state` | `string` | Yes | The state abbreviation to edit tax requirements for (e.g. `"CA"`, `"NY"`). |
-| `onEvent` | `(eventType: string, data?: unknown) => void` | Yes | Callback invoked when events are emitted. |
+| Name | Type | Required | Description |
+| ----------- | --------------------------------------------- | -------- | -------------------------------------------------------------------------- |
+| `companyId` | `string` | Yes | The associated company identifier. |
+| `state` | `string` | Yes | The state abbreviation to edit tax requirements for (e.g. `"CA"`, `"NY"`). |
+| `onEvent` | `(eventType: string, data?: unknown) => void` | Yes | Callback invoked when events are emitted. |
## Events
-| Event | Description | Data |
-| --- | --- | --- |
+| Event | Description | Data |
+| --------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `COMPANY_STATE_TAX_UPDATED` | Fired when a state tax setup has been successfully submitted. | [Response from the update state tax requirements API](https://docs.gusto.com/embedded-payroll/reference/put-v1-companies-company_uuid-tax_requirements-state) |
-| `CANCEL` | Fired when the user cancels editing. | None |
+| `CANCEL` | Fired when the user cancels editing. | None |
diff --git a/docs/components/company/state-taxes-list.md b/docs/components/company/state-taxes-list.md
index fe86c1820..166cc767a 100644
--- a/docs/components/company/state-taxes-list.md
+++ b/docs/components/company/state-taxes-list.md
@@ -24,14 +24,14 @@ function MyComponent() {
## Props
-| Name | Type | Required | Description |
-| --- | --- | --- | --- |
-| `companyId` | `string` | Yes | The associated company identifier. |
-| `onEvent` | `(eventType: string, data?: unknown) => void` | Yes | Callback invoked when events are emitted. |
+| Name | Type | Required | Description |
+| ----------- | --------------------------------------------- | -------- | ----------------------------------------- |
+| `companyId` | `string` | Yes | The associated company identifier. |
+| `onEvent` | `(eventType: string, data?: unknown) => void` | Yes | Callback invoked when events are emitted. |
## Events
-| Event | Description | Data |
-| --- | --- | --- |
+| Event | Description | Data |
+| ------------------------ | -------------------------------------------------------------------- | ------------------- |
| `COMPANY_STATE_TAX_EDIT` | Fired when a user chooses to edit requirements for a specific state. | `{ state: string }` |
-| `COMPANY_STATE_TAX_DONE` | Fired when the user chooses to proceed to the next step. | None |
+| `COMPANY_STATE_TAX_DONE` | Fired when the user chooses to proceed to the next step. | None |
diff --git a/docs/components/company/state-taxes.md b/docs/components/company/state-taxes.md
index fc6b62886..800a29b83 100644
--- a/docs/components/company/state-taxes.md
+++ b/docs/components/company/state-taxes.md
@@ -24,15 +24,15 @@ function MyComponent() {
## Props
-| Name | Type | Required | Description |
-| --- | --- | --- | --- |
-| `companyId` | `string` | Yes | The associated company identifier. |
-| `onEvent` | `(eventType: string, data?: unknown) => void` | Yes | Callback invoked when events are emitted. |
+| Name | Type | Required | Description |
+| ----------- | --------------------------------------------- | -------- | ----------------------------------------- |
+| `companyId` | `string` | Yes | The associated company identifier. |
+| `onEvent` | `(eventType: string, data?: unknown) => void` | Yes | Callback invoked when events are emitted. |
## Events
-| Event | Description | Data |
-| --- | --- | --- |
-| `COMPANY_STATE_TAX_EDIT` | Fired when a user chooses to edit requirements for a specific state. | `{ state: string }` |
-| `COMPANY_STATE_TAX_UPDATED` | Fired when a state tax setup has been successfully submitted. | [Response from the update state tax requirements API](https://docs.gusto.com/embedded-payroll/reference/put-v1-companies-company_uuid-tax_requirements-state) |
-| `COMPANY_STATE_TAX_DONE` | Fired when the user chooses to proceed to the next step. | None |
+| Event | Description | Data |
+| --------------------------- | -------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `COMPANY_STATE_TAX_EDIT` | Fired when a user chooses to edit requirements for a specific state. | `{ state: string }` |
+| `COMPANY_STATE_TAX_UPDATED` | Fired when a state tax setup has been successfully submitted. | [Response from the update state tax requirements API](https://docs.gusto.com/embedded-payroll/reference/put-v1-companies-company_uuid-tax_requirements-state) |
+| `COMPANY_STATE_TAX_DONE` | Fired when the user chooses to proceed to the next step. | None |
diff --git a/docs/components/contractor/address.md b/docs/components/contractor/address.md
index 0455dc98c..d0fa95878 100644
--- a/docs/components/contractor/address.md
+++ b/docs/components/contractor/address.md
@@ -24,15 +24,15 @@ function MyComponent() {
## Props
-| Name | Type | Required | Description |
-| --- | --- | --- | --- |
-| `contractorId` | `string` | Yes | The contractor identifier. |
-| `defaultValues` | `object` | No | Default values for address fields: `street1`, `street2`, `city`, `state`, `zip`. |
-| `onEvent` | `(eventType: string, data?: unknown) => void` | Yes | Callback invoked when events are emitted. |
+| Name | Type | Required | Description |
+| --------------- | --------------------------------------------- | -------- | -------------------------------------------------------------------------------- |
+| `contractorId` | `string` | Yes | The contractor identifier. |
+| `defaultValues` | `object` | No | Default values for address fields: `street1`, `street2`, `city`, `state`, `zip`. |
+| `onEvent` | `(eventType: string, data?: unknown) => void` | Yes | Callback invoked when events are emitted. |
## Events
-| Event | Description | Data |
-| --- | --- | --- |
+| Event | Description | Data |
+| ---------------------------- | ------------------------------------------------------------ | ---- |
| `CONTRACTOR_ADDRESS_UPDATED` | Fired when the contractor's address is successfully updated. | None |
-| `CONTRACTOR_ADDRESS_DONE` | Fired when the address step is complete. | None |
+| `CONTRACTOR_ADDRESS_DONE` | Fired when the address step is complete. | None |
diff --git a/docs/components/contractor/contractor-list.md b/docs/components/contractor/contractor-list.md
index a01d9057d..ac16982a6 100644
--- a/docs/components/contractor/contractor-list.md
+++ b/docs/components/contractor/contractor-list.md
@@ -24,17 +24,17 @@ function MyComponent() {
## Props
-| Name | Type | Required | Description |
-| --- | --- | --- | --- |
-| `companyId` | `string` | Yes | The associated company identifier. |
-| `successMessage` | `string` | No | Optional success message to display at the top of the list. |
-| `onEvent` | `(eventType: string, data?: unknown) => void` | Yes | Callback invoked when events are emitted. |
+| Name | Type | Required | Description |
+| ---------------- | --------------------------------------------- | -------- | ----------------------------------------------------------- |
+| `companyId` | `string` | Yes | The associated company identifier. |
+| `successMessage` | `string` | No | Optional success message to display at the top of the list. |
+| `onEvent` | `(eventType: string, data?: unknown) => void` | Yes | Callback invoked when events are emitted. |
## Events
-| Event | Description | Data |
-| --- | --- | --- |
-| `CONTRACTOR_CREATE` | Fired when the user initiates creating a new contractor. | None |
-| `CONTRACTOR_UPDATE` | Fired when the user selects a contractor to edit. | `{ contractorId: string }` |
-| `CONTRACTOR_DELETED` | Fired when a contractor is deleted. | `{ contractorId: string }` |
-| `CONTRACTOR_ONBOARDING_CONTINUE` | Fired when the user continues onboarding for a contractor. | None |
+| Event | Description | Data |
+| -------------------------------- | ---------------------------------------------------------- | -------------------------- |
+| `CONTRACTOR_CREATE` | Fired when the user initiates creating a new contractor. | None |
+| `CONTRACTOR_UPDATE` | Fired when the user selects a contractor to edit. | `{ contractorId: string }` |
+| `CONTRACTOR_DELETED` | Fired when a contractor is deleted. | `{ contractorId: string }` |
+| `CONTRACTOR_ONBOARDING_CONTINUE` | Fired when the user continues onboarding for a contractor. | None |
diff --git a/docs/components/contractor/contractor-profile.md b/docs/components/contractor/contractor-profile.md
index 9b9077aaf..04eadecc5 100644
--- a/docs/components/contractor/contractor-profile.md
+++ b/docs/components/contractor/contractor-profile.md
@@ -24,17 +24,17 @@ function MyComponent() {
## Props
-| Name | Type | Required | Description |
-| --- | --- | --- | --- |
-| `companyId` | `string` | Yes | The associated company identifier. |
-| `contractorId` | `string` | No | ID of an existing contractor to edit. When omitted, renders in create mode. |
-| `defaultValues` | `object` | No | Default values for the profile form fields. |
-| `onEvent` | `(eventType: string, data?: unknown) => void` | Yes | Callback invoked when events are emitted. |
+| Name | Type | Required | Description |
+| --------------- | --------------------------------------------- | -------- | --------------------------------------------------------------------------- |
+| `companyId` | `string` | Yes | The associated company identifier. |
+| `contractorId` | `string` | No | ID of an existing contractor to edit. When omitted, renders in create mode. |
+| `defaultValues` | `object` | No | Default values for the profile form fields. |
+| `onEvent` | `(eventType: string, data?: unknown) => void` | Yes | Callback invoked when events are emitted. |
## Events
-| Event | Description | Data |
-| --- | --- | --- |
-| `CONTRACTOR_CREATED` | Fired when a new contractor is successfully created. | None |
-| `CONTRACTOR_UPDATED` | Fired when an existing contractor is successfully updated. | None |
-| `CONTRACTOR_PROFILE_DONE` | Fired when the profile step is complete. | None |
+| Event | Description | Data |
+| ------------------------- | ---------------------------------------------------------- | ---- |
+| `CONTRACTOR_CREATED` | Fired when a new contractor is successfully created. | None |
+| `CONTRACTOR_UPDATED` | Fired when an existing contractor is successfully updated. | None |
+| `CONTRACTOR_PROFILE_DONE` | Fired when the profile step is complete. | None |
diff --git a/docs/components/contractor/contractor-submit.md b/docs/components/contractor/contractor-submit.md
index f9f657f0c..94febd19b 100644
--- a/docs/components/contractor/contractor-submit.md
+++ b/docs/components/contractor/contractor-submit.md
@@ -24,16 +24,16 @@ function MyComponent() {
## Props
-| Name | Type | Required | Description |
-| --- | --- | --- | --- |
-| `contractorId` | `string` | Yes | The contractor identifier. |
-| `selfOnboarding` | `boolean` | No | When `true`, indicates the contractor is completing their own onboarding. |
-| `onEvent` | `(eventType: string, data?: unknown) => void` | Yes | Callback invoked when events are emitted. |
+| Name | Type | Required | Description |
+| ---------------- | --------------------------------------------- | -------- | ------------------------------------------------------------------------- |
+| `contractorId` | `string` | Yes | The contractor identifier. |
+| `selfOnboarding` | `boolean` | No | When `true`, indicates the contractor is completing their own onboarding. |
+| `onEvent` | `(eventType: string, data?: unknown) => void` | Yes | Callback invoked when events are emitted. |
## Events
-| Event | Description | Data |
-| --- | --- | --- |
-| `CONTRACTOR_ONBOARDING_STATUS_UPDATED` | Fired when the contractor's onboarding status is updated. | None |
-| `CONTRACTOR_SUBMIT_DONE` | Fired when the submission step is complete. | None |
-| `CONTRACTOR_INVITE_CONTRACTOR` | Fired when the user chooses to invite the contractor to self-onboard. | `{ contractorId: string }` |
+| Event | Description | Data |
+| -------------------------------------- | --------------------------------------------------------------------- | -------------------------- |
+| `CONTRACTOR_ONBOARDING_STATUS_UPDATED` | Fired when the contractor's onboarding status is updated. | None |
+| `CONTRACTOR_SUBMIT_DONE` | Fired when the submission step is complete. | None |
+| `CONTRACTOR_INVITE_CONTRACTOR` | Fired when the user chooses to invite the contractor to self-onboard. | `{ contractorId: string }` |
diff --git a/docs/components/contractor/contractor.md b/docs/components/contractor/contractor.md
index 5a319b43c..6d9a210fb 100644
--- a/docs/components/contractor/contractor.md
+++ b/docs/components/contractor/contractor.md
@@ -7,23 +7,23 @@ The Contractor domain provides components for managing contractors on Gusto's em
## Flows
-| Component | Description |
-| --- | --- |
+| Component | Description |
+| ------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
| [Contractor.OnboardingFlow](./onboarding-flow.md) | End-to-end contractor onboarding workflow that orchestrates profile creation, address, payment method, and submission steps. |
-| [Contractor.PaymentFlow](./payment-flow.md) | End-to-end contractor payment workflow that orchestrates payment creation and management. |
+| [Contractor.PaymentFlow](./payment-flow.md) | End-to-end contractor payment workflow that orchestrates payment creation and management. |
## Blocks
-| Component | Description |
-| --- | --- |
-| [Contractor.ContractorList](./contractor-list.md) | Displays a list of contractors for a company with options to create, edit, and delete. |
+| Component | Description |
+| ------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
+| [Contractor.ContractorList](./contractor-list.md) | Displays a list of contractors for a company with options to create, edit, and delete. |
| [Contractor.ContractorProfile](./contractor-profile.md) | Form for creating or editing a contractor profile, supporting both individual and business types. |
-| [Contractor.Address](./address.md) | Form for entering or updating a contractor's mailing address. |
-| [Contractor.PaymentMethod](./payment-method.md) | Manages contractor payment method setup including bank account details. |
-| [Contractor.NewHireReport](./new-hire-report.md) | Handles new hire reporting requirements for a contractor. |
-| [Contractor.ContractorSubmit](./contractor-submit.md) | Final submission step for contractor onboarding, including invitation options. |
-| [Contractor.PaymentsList](./payments-list.md) | Displays a list of contractor payments for a company. |
-| [Contractor.CreatePayment](./create-payment.md) | Form for creating a new contractor payment. |
-| [Contractor.PaymentHistory](./payment-history.md) | Displays the payment history for a specific contractor payment. |
-| [Contractor.PaymentSummary](./payment-summary.md) | Summary view of a contractor payment group. |
-| [Contractor.PaymentStatement](./payment-statement.md) | Displays a detailed payment statement for a contractor payment. |
+| [Contractor.Address](./address.md) | Form for entering or updating a contractor's mailing address. |
+| [Contractor.PaymentMethod](./payment-method.md) | Manages contractor payment method setup including bank account details. |
+| [Contractor.NewHireReport](./new-hire-report.md) | Handles new hire reporting requirements for a contractor. |
+| [Contractor.ContractorSubmit](./contractor-submit.md) | Final submission step for contractor onboarding, including invitation options. |
+| [Contractor.PaymentsList](./payments-list.md) | Displays a list of contractor payments for a company. |
+| [Contractor.CreatePayment](./create-payment.md) | Form for creating a new contractor payment. |
+| [Contractor.PaymentHistory](./payment-history.md) | Displays the payment history for a specific contractor payment. |
+| [Contractor.PaymentSummary](./payment-summary.md) | Summary view of a contractor payment group. |
+| [Contractor.PaymentStatement](./payment-statement.md) | Displays a detailed payment statement for a contractor payment. |
diff --git a/docs/components/contractor/create-payment.md b/docs/components/contractor/create-payment.md
index 332cb2cf6..5d26de9fc 100644
--- a/docs/components/contractor/create-payment.md
+++ b/docs/components/contractor/create-payment.md
@@ -24,18 +24,18 @@ function MyComponent() {
## Props
-| Name | Type | Required | Description |
-| --- | --- | --- | --- |
-| `companyId` | `string` | Yes | The associated company identifier. |
-| `onEvent` | `(eventType: string, data?: unknown) => void` | Yes | Callback invoked when events are emitted. |
+| Name | Type | Required | Description |
+| ----------- | --------------------------------------------- | -------- | ----------------------------------------- |
+| `companyId` | `string` | Yes | The associated company identifier. |
+| `onEvent` | `(eventType: string, data?: unknown) => void` | Yes | Callback invoked when events are emitted. |
## Events
-| Event | Description | Data |
-| --- | --- | --- |
-| `CONTRACTOR_PAYMENT_EDIT` | Fired when the user enters edit mode for the payment. | None |
-| `CONTRACTOR_PAYMENT_UPDATE` | Fired when the payment is updated. | None |
-| `CONTRACTOR_PAYMENT_PREVIEW` | Fired when the user previews the payment before submission. | None |
-| `CONTRACTOR_PAYMENT_BACK_TO_EDIT` | Fired when the user returns to edit mode from the preview. | None |
-| `CONTRACTOR_PAYMENT_CREATED` | Fired when the payment is successfully created and submitted. | None |
-| `CONTRACTOR_PAYMENT_RFI_RESPOND` | Fired when user clicks to respond to an information request. | None |
+| Event | Description | Data |
+| --------------------------------- | ------------------------------------------------------------- | ---- |
+| `CONTRACTOR_PAYMENT_EDIT` | Fired when the user enters edit mode for the payment. | None |
+| `CONTRACTOR_PAYMENT_UPDATE` | Fired when the payment is updated. | None |
+| `CONTRACTOR_PAYMENT_PREVIEW` | Fired when the user previews the payment before submission. | None |
+| `CONTRACTOR_PAYMENT_BACK_TO_EDIT` | Fired when the user returns to edit mode from the preview. | None |
+| `CONTRACTOR_PAYMENT_CREATED` | Fired when the payment is successfully created and submitted. | None |
+| `CONTRACTOR_PAYMENT_RFI_RESPOND` | Fired when user clicks to respond to an information request. | None |
diff --git a/docs/components/contractor/new-hire-report.md b/docs/components/contractor/new-hire-report.md
index e5ba62a04..77384d9d6 100644
--- a/docs/components/contractor/new-hire-report.md
+++ b/docs/components/contractor/new-hire-report.md
@@ -24,15 +24,15 @@ function MyComponent() {
## Props
-| Name | Type | Required | Description |
-| --- | --- | --- | --- |
-| `contractorId` | `string` | Yes | The contractor identifier. |
-| `selfOnboarding` | `boolean` | No | When `true`, indicates the contractor is completing their own onboarding. |
-| `onEvent` | `(eventType: string, data?: unknown) => void` | Yes | Callback invoked when events are emitted. |
+| Name | Type | Required | Description |
+| ---------------- | --------------------------------------------- | -------- | ------------------------------------------------------------------------- |
+| `contractorId` | `string` | Yes | The contractor identifier. |
+| `selfOnboarding` | `boolean` | No | When `true`, indicates the contractor is completing their own onboarding. |
+| `onEvent` | `(eventType: string, data?: unknown) => void` | Yes | Callback invoked when events are emitted. |
## Events
-| Event | Description | Data |
-| --- | --- | --- |
+| Event | Description | Data |
+| ------------------------------------ | ------------------------------------------------------ | ---- |
| `CONTRACTOR_NEW_HIRE_REPORT_UPDATED` | Fired when the new hire report information is updated. | None |
-| `CONTRACTOR_NEW_HIRE_REPORT_DONE` | Fired when the new hire report step is complete. | None |
+| `CONTRACTOR_NEW_HIRE_REPORT_DONE` | Fired when the new hire report step is complete. | None |
diff --git a/docs/components/contractor/onboarding-flow.md b/docs/components/contractor/onboarding-flow.md
index 20f20c022..6c96e8605 100644
--- a/docs/components/contractor/onboarding-flow.md
+++ b/docs/components/contractor/onboarding-flow.md
@@ -37,11 +37,11 @@ function MyApp() {
## Props
-| Name | Type | Required | Description |
-| --- | --- | --- | --- |
-| `companyId` | `string` | Yes | The associated company identifier. |
-| `defaultValues` | `object` | No | Default values for individual flow step components. Supports `profile` and `address` sub-objects. |
-| `onEvent` | `(eventType: string, data?: unknown) => void` | Yes | Callback invoked when events are emitted. Receives events from all subcomponents. |
+| Name | Type | Required | Description |
+| --------------- | --------------------------------------------- | -------- | ------------------------------------------------------------------------------------------------- |
+| `companyId` | `string` | Yes | The associated company identifier. |
+| `defaultValues` | `object` | No | Default values for individual flow step components. Supports `profile` and `address` sub-objects. |
+| `onEvent` | `(eventType: string, data?: unknown) => void` | Yes | Callback invoked when events are emitted. Receives events from all subcomponents. |
## Events
diff --git a/docs/components/contractor/payment-flow.md b/docs/components/contractor/payment-flow.md
index de2f25cdc..1ed4dd77a 100644
--- a/docs/components/contractor/payment-flow.md
+++ b/docs/components/contractor/payment-flow.md
@@ -24,10 +24,10 @@ function MyApp() {
## Props
-| Name | Type | Required | Description |
-| --- | --- | --- | --- |
-| `companyId` | `string` | Yes | The associated company identifier. |
-| `onEvent` | `(eventType: string, data?: unknown) => void` | Yes | Callback invoked when events are emitted. Receives events from all subcomponents. |
+| Name | Type | Required | Description |
+| ----------- | --------------------------------------------- | -------- | --------------------------------------------------------------------------------- |
+| `companyId` | `string` | Yes | The associated company identifier. |
+| `onEvent` | `(eventType: string, data?: unknown) => void` | Yes | Callback invoked when events are emitted. Receives events from all subcomponents. |
## Events
diff --git a/docs/components/contractor/payment-history.md b/docs/components/contractor/payment-history.md
index 0bf2c7a84..7e53b3b86 100644
--- a/docs/components/contractor/payment-history.md
+++ b/docs/components/contractor/payment-history.md
@@ -24,14 +24,14 @@ function MyComponent() {
## Props
-| Name | Type | Required | Description |
-| --- | --- | --- | --- |
-| `paymentId` | `string` | Yes | The payment identifier. |
-| `onEvent` | `(eventType: string, data?: unknown) => void` | Yes | Callback invoked when events are emitted. |
+| Name | Type | Required | Description |
+| ----------- | --------------------------------------------- | -------- | ----------------------------------------- |
+| `paymentId` | `string` | Yes | The payment identifier. |
+| `onEvent` | `(eventType: string, data?: unknown) => void` | Yes | Callback invoked when events are emitted. |
## Events
-| Event | Description | Data |
-| --- | --- | --- |
+| Event | Description | Data |
+| --------------------------------- | ------------------------------------------------------------------ | ---- |
| `CONTRACTOR_PAYMENT_VIEW_DETAILS` | Fired when the user requests to view detailed payment information. | None |
-| `CONTRACTOR_PAYMENT_CANCEL` | Fired when the user cancels the payment. | None |
+| `CONTRACTOR_PAYMENT_CANCEL` | Fired when the user cancels the payment. | None |
diff --git a/docs/components/contractor/payment-method.md b/docs/components/contractor/payment-method.md
index 9ae65bafb..ba0a57ba9 100644
--- a/docs/components/contractor/payment-method.md
+++ b/docs/components/contractor/payment-method.md
@@ -24,15 +24,15 @@ function MyComponent() {
## Props
-| Name | Type | Required | Description |
-| --- | --- | --- | --- |
-| `contractorId` | `string` | Yes | The contractor identifier. |
-| `onEvent` | `(eventType: string, data?: unknown) => void` | Yes | Callback invoked when events are emitted. |
+| Name | Type | Required | Description |
+| -------------- | --------------------------------------------- | -------- | ----------------------------------------- |
+| `contractorId` | `string` | Yes | The contractor identifier. |
+| `onEvent` | `(eventType: string, data?: unknown) => void` | Yes | Callback invoked when events are emitted. |
## Events
-| Event | Description | Data |
-| --- | --- | --- |
-| `CONTRACTOR_BANK_ACCOUNT_CREATED` | Fired when a bank account is successfully created for the contractor. | None |
-| `CONTRACTOR_PAYMENT_METHOD_UPDATED` | Fired when the contractor's payment method is updated. | None |
-| `CONTRACTOR_PAYMENT_METHOD_DONE` | Fired when the payment method step is complete. | None |
+| Event | Description | Data |
+| ----------------------------------- | --------------------------------------------------------------------- | ---- |
+| `CONTRACTOR_BANK_ACCOUNT_CREATED` | Fired when a bank account is successfully created for the contractor. | None |
+| `CONTRACTOR_PAYMENT_METHOD_UPDATED` | Fired when the contractor's payment method is updated. | None |
+| `CONTRACTOR_PAYMENT_METHOD_DONE` | Fired when the payment method step is complete. | None |
diff --git a/docs/components/contractor/payment-statement.md b/docs/components/contractor/payment-statement.md
index 82e8acd30..8fc6ee999 100644
--- a/docs/components/contractor/payment-statement.md
+++ b/docs/components/contractor/payment-statement.md
@@ -25,8 +25,8 @@ function MyComponent() {
## Props
-| Name | Type | Required | Description |
-| --- | --- | --- | --- |
-| `paymentGroupId` | `string` | Yes | The payment group identifier. |
-| `contractorUuid` | `string` | Yes | The contractor identifier. |
-| `onEvent` | `(eventType: string, data?: unknown) => void` | Yes | Callback invoked when events are emitted. |
+| Name | Type | Required | Description |
+| ---------------- | --------------------------------------------- | -------- | ----------------------------------------- |
+| `paymentGroupId` | `string` | Yes | The payment group identifier. |
+| `contractorUuid` | `string` | Yes | The contractor identifier. |
+| `onEvent` | `(eventType: string, data?: unknown) => void` | Yes | Callback invoked when events are emitted. |
diff --git a/docs/components/contractor/payment-summary.md b/docs/components/contractor/payment-summary.md
index dc4a19b99..bdde1f9cf 100644
--- a/docs/components/contractor/payment-summary.md
+++ b/docs/components/contractor/payment-summary.md
@@ -25,15 +25,15 @@ function MyComponent() {
## Props
-| Name | Type | Required | Description |
-| --- | --- | --- | --- |
-| `paymentGroupId` | `string` | Yes | The payment group identifier. |
-| `companyId` | `string` | Yes | The associated company identifier. |
-| `onEvent` | `(eventType: string, data?: unknown) => void` | Yes | Callback invoked when events are emitted. |
-| `alerts` | `array` | No | Optional array of alert objects to display above the payment summary. |
+| Name | Type | Required | Description |
+| ---------------- | --------------------------------------------- | -------- | --------------------------------------------------------------------- |
+| `paymentGroupId` | `string` | Yes | The payment group identifier. |
+| `companyId` | `string` | Yes | The associated company identifier. |
+| `onEvent` | `(eventType: string, data?: unknown) => void` | Yes | Callback invoked when events are emitted. |
+| `alerts` | `array` | No | Optional array of alert objects to display above the payment summary. |
## Events
-| Event | Description | Data |
-| --- | --- | --- |
+| Event | Description | Data |
+| ------------------------- | ---------------------------------------------- | ---- |
| `CONTRACTOR_PAYMENT_EXIT` | Fired when the user exits the payment summary. | None |
diff --git a/docs/components/contractor/payments-list.md b/docs/components/contractor/payments-list.md
index 8e19adb54..6ca978444 100644
--- a/docs/components/contractor/payments-list.md
+++ b/docs/components/contractor/payments-list.md
@@ -24,16 +24,16 @@ function MyComponent() {
## Props
-| Name | Type | Required | Description |
-| --- | --- | --- | --- |
-| `companyId` | `string` | Yes | The associated company identifier. |
-| `alerts` | `array` | No | Optional array of alert objects to display above the payments list. |
-| `onEvent` | `(eventType: string, data?: unknown) => void` | Yes | Callback invoked when events are emitted. |
+| Name | Type | Required | Description |
+| ----------- | --------------------------------------------- | -------- | ------------------------------------------------------------------- |
+| `companyId` | `string` | Yes | The associated company identifier. |
+| `alerts` | `array` | No | Optional array of alert objects to display above the payments list. |
+| `onEvent` | `(eventType: string, data?: unknown) => void` | Yes | Callback invoked when events are emitted. |
## Events
-| Event | Description | Data |
-| --- | --- | --- |
-| `CONTRACTOR_PAYMENT_CREATE` | Fired when the user initiates creating a new payment. | None |
-| `CONTRACTOR_PAYMENT_VIEW` | Fired when the user selects a payment to view. | `{ paymentId: string }` |
-| `CONTRACTOR_PAYMENT_RFI_RESPOND` | Fired when the user responds to a payment-related information request. | None |
+| Event | Description | Data |
+| -------------------------------- | ---------------------------------------------------------------------- | ----------------------- |
+| `CONTRACTOR_PAYMENT_CREATE` | Fired when the user initiates creating a new payment. | None |
+| `CONTRACTOR_PAYMENT_VIEW` | Fired when the user selects a payment to view. | `{ paymentId: string }` |
+| `CONTRACTOR_PAYMENT_RFI_RESPOND` | Fired when the user responds to a payment-related information request. | None |
diff --git a/docs/components/employee/compensation.md b/docs/components/employee/compensation.md
index 77d81e209..7a167ad95 100644
--- a/docs/components/employee/compensation.md
+++ b/docs/components/employee/compensation.md
@@ -18,23 +18,19 @@ function MyApp({ employeeId }) {
}
return (
-
+
)
}
```
## Props
-| Name | Type | Default | Required | Description |
-| --- | --- | --- | --- | --- |
-| **employeeId** | `string` | | Yes | The associated employee identifier. |
-| **startDate** | `string` | | Yes | The date the employee will start work. |
-| **onEvent** | `(eventType: string, data?: unknown) => void` | | Yes | Callback invoked when events are emitted. |
-| **defaultValues** | `object` | | No | Default values for the compensation form. If employee data is available via the API, these values are overwritten. |
+| Name | Type | Default | Required | Description |
+| ----------------- | --------------------------------------------- | ------- | -------- | ------------------------------------------------------------------------------------------------------------------ |
+| **employeeId** | `string` | | Yes | The associated employee identifier. |
+| **startDate** | `string` | | Yes | The date the employee will start work. |
+| **onEvent** | `(eventType: string, data?: unknown) => void` | | Yes | Callback invoked when events are emitted. |
+| **defaultValues** | `object` | | No | Default values for the compensation form. If employee data is available via the API, these values are overwritten. |
### defaultValues shape
@@ -49,10 +45,10 @@ function MyApp({ employeeId }) {
## Events
-| Event | Description | Data |
-| --- | --- | --- |
-| `EMPLOYEE_JOB_CREATED` | Fired after compensation form is submitted if the job is new | Response from the Create a job endpoint |
-| `EMPLOYEE_JOB_UPDATED` | Fired after compensation form is submitted if editing an existing job | Response from the Update a job endpoint |
-| `EMPLOYEE_JOB_DELETED` | Fired after successfully deleting a job | Response from the Delete a job endpoint |
-| `EMPLOYEE_COMPENSATION_UPDATED` | Fired after updating compensation details | Response from the Update a compensation endpoint |
-| `EMPLOYEE_COMPENSATION_DONE` | Fired when compensation setup is complete and ready to advance | None |
+| Event | Description | Data |
+| ------------------------------- | --------------------------------------------------------------------- | ------------------------------------------------ |
+| `EMPLOYEE_JOB_CREATED` | Fired after compensation form is submitted if the job is new | Response from the Create a job endpoint |
+| `EMPLOYEE_JOB_UPDATED` | Fired after compensation form is submitted if editing an existing job | Response from the Update a job endpoint |
+| `EMPLOYEE_JOB_DELETED` | Fired after successfully deleting a job | Response from the Delete a job endpoint |
+| `EMPLOYEE_COMPENSATION_UPDATED` | Fired after updating compensation details | Response from the Update a compensation endpoint |
+| `EMPLOYEE_COMPENSATION_DONE` | Fired when compensation setup is complete and ready to advance | None |
diff --git a/docs/components/employee/deductions.md b/docs/components/employee/deductions.md
index 5ae2ada16..b0ed7c8dd 100644
--- a/docs/components/employee/deductions.md
+++ b/docs/components/employee/deductions.md
@@ -17,32 +17,27 @@ function MyApp({ employeeId }) {
// Handle deduction events
}
- return (
-
- )
+ return
}
```
## Props
-| Name | Type | Default | Required | Description |
-| --- | --- | --- | --- | --- |
-| **employeeId** | `string` | | Yes | The associated employee identifier. |
-| **onEvent** | `(eventType: string, data?: unknown) => void` | | Yes | Callback invoked when events are emitted. |
+| Name | Type | Default | Required | Description |
+| -------------- | --------------------------------------------- | ------- | -------- | ----------------------------------------- |
+| **employeeId** | `string` | | Yes | The associated employee identifier. |
+| **onEvent** | `(eventType: string, data?: unknown) => void` | | Yes | Callback invoked when events are emitted. |
## Events
-| Event | Description | Data |
-| --- | --- | --- |
-| `EMPLOYEE_DEDUCTION_ADD` | Fired when user navigates to the deduction form | None |
-| `EMPLOYEE_DEDUCTION_CREATED` | Fired after a new deduction is created | Response from the Create a garnishment endpoint |
-| `EMPLOYEE_DEDUCTION_UPDATED` | Fired after a deduction is edited | Response from the Update a garnishment endpoint |
-| `EMPLOYEE_DEDUCTION_DELETED` | Fired after deleting a deduction | Response from the Update a garnishment endpoint with `active: false` |
-| `EMPLOYEE_DEDUCTION_EDIT` | Fired when user selects a deduction to edit | None |
-| `EMPLOYEE_DEDUCTION_CANCEL` | Fired when user cancels deduction editing | None |
-| `EMPLOYEE_DEDUCTION_INCLUDE_YES` | Fired when user opts to include deductions | None |
-| `EMPLOYEE_DEDUCTION_INCLUDE_NO` | Fired when user opts out of deductions | None |
-| `EMPLOYEE_DEDUCTION_DONE` | Fired when deductions setup is complete and the step is ready to advance | None |
+| Event | Description | Data |
+| -------------------------------- | ------------------------------------------------------------------------ | -------------------------------------------------------------------- |
+| `EMPLOYEE_DEDUCTION_ADD` | Fired when user navigates to the deduction form | None |
+| `EMPLOYEE_DEDUCTION_CREATED` | Fired after a new deduction is created | Response from the Create a garnishment endpoint |
+| `EMPLOYEE_DEDUCTION_UPDATED` | Fired after a deduction is edited | Response from the Update a garnishment endpoint |
+| `EMPLOYEE_DEDUCTION_DELETED` | Fired after deleting a deduction | Response from the Update a garnishment endpoint with `active: false` |
+| `EMPLOYEE_DEDUCTION_EDIT` | Fired when user selects a deduction to edit | None |
+| `EMPLOYEE_DEDUCTION_CANCEL` | Fired when user cancels deduction editing | None |
+| `EMPLOYEE_DEDUCTION_INCLUDE_YES` | Fired when user opts to include deductions | None |
+| `EMPLOYEE_DEDUCTION_INCLUDE_NO` | Fired when user opts out of deductions | None |
+| `EMPLOYEE_DEDUCTION_DONE` | Fired when deductions setup is complete and the step is ready to advance | None |
diff --git a/docs/components/employee/document-signer.md b/docs/components/employee/document-signer.md
index 9cdf879f8..34273a1b0 100644
--- a/docs/components/employee/document-signer.md
+++ b/docs/components/employee/document-signer.md
@@ -17,29 +17,23 @@ function MyApp({ employeeId }) {
// Handle document signing events
}
- return (
-
- )
+ return
}
```
## Props
-| Name | Type | Default | Required | Description |
-| --- | --- | --- | --- | --- |
-| **employeeId** | `string` | | Yes | The associated employee identifier. |
-| **onEvent** | `(eventType: string, data?: unknown) => void` | | Yes | Callback invoked when events are emitted. |
-| **withEmployeeI9** | `boolean` | `false` | No | When true, checks if the employee has I-9 enabled. If I-9 is needed, routes to Employment Eligibility first, then presents the I-9 form for signature. |
+| Name | Type | Default | Required | Description |
+| ------------------ | --------------------------------------------- | ------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| **employeeId** | `string` | | Yes | The associated employee identifier. |
+| **onEvent** | `(eventType: string, data?: unknown) => void` | | Yes | Callback invoked when events are emitted. |
+| **withEmployeeI9** | `boolean` | `false` | No | When true, checks if the employee has I-9 enabled. If I-9 is needed, routes to Employment Eligibility first, then presents the I-9 form for signature. |
## Events
-| Event | Description | Data |
-| --- | --- | --- |
-| `EMPLOYEE_EMPLOYMENT_ELIGIBILITY_DONE` | Fired when the employee completes the employment eligibility form | Response from the Create or update an employee's I-9 authorization endpoint |
-| `EMPLOYEE_VIEW_FORM_TO_SIGN` | Fired when the sign form CTA is selected for a given form | Response from the Get employee form PDF endpoint, aggregated with `{ pdfUrl }` |
-| `EMPLOYEE_SIGN_FORM` | Fired when the user submits the form to sign | Response from the Sign an employee form endpoint |
-| `EMPLOYEE_FORMS_DONE` | Fired when the user is done signing forms and is ready to advance | None |
+| Event | Description | Data |
+| -------------------------------------- | ----------------------------------------------------------------- | ------------------------------------------------------------------------------ |
+| `EMPLOYEE_EMPLOYMENT_ELIGIBILITY_DONE` | Fired when the employee completes the employment eligibility form | Response from the Create or update an employee's I-9 authorization endpoint |
+| `EMPLOYEE_VIEW_FORM_TO_SIGN` | Fired when the sign form CTA is selected for a given form | Response from the Get employee form PDF endpoint, aggregated with `{ pdfUrl }` |
+| `EMPLOYEE_SIGN_FORM` | Fired when the user submits the form to sign | Response from the Sign an employee form endpoint |
+| `EMPLOYEE_FORMS_DONE` | Fired when the user is done signing forms and is ready to advance | None |
diff --git a/docs/components/employee/employee-documents.md b/docs/components/employee/employee-documents.md
index 7f988fd09..74cdcbb98 100644
--- a/docs/components/employee/employee-documents.md
+++ b/docs/components/employee/employee-documents.md
@@ -19,25 +19,20 @@ function MyApp({ employeeId }) {
// Handle document configuration events
}
- return (
-
- )
+ return
}
```
## Props
-| Name | Type | Default | Required | Description |
-| --- | --- | --- | --- | --- |
-| **employeeId** | `string` | | Yes | The associated employee identifier. |
-| **onEvent** | `(eventType: string, data?: unknown) => void` | | Yes | Callback invoked when events are emitted. |
+| Name | Type | Default | Required | Description |
+| -------------- | --------------------------------------------- | ------- | -------- | ----------------------------------------- |
+| **employeeId** | `string` | | Yes | The associated employee identifier. |
+| **onEvent** | `(eventType: string, data?: unknown) => void` | | Yes | Callback invoked when events are emitted. |
## Events
-| Event | Description | Data |
-| --- | --- | --- |
+| Event | Description | Data |
+| ---------------------------------------------- | ----------------------------------------------------------------------------------------- | --------------------------------------------------------------------------- |
| `EMPLOYEE_ONBOARDING_DOCUMENTS_CONFIG_UPDATED` | Fired after the admin toggles I-9 inclusion and the configuration is successfully updated | Response from the Update an employee's onboarding documents config endpoint |
-| `EMPLOYEE_DOCUMENTS_DONE` | Fired when the admin clicks continue and is ready to advance | None |
+| `EMPLOYEE_DOCUMENTS_DONE` | Fired when the admin clicks continue and is ready to advance | None |
diff --git a/docs/components/employee/employee-list.md b/docs/components/employee/employee-list.md
index b7dd9bacc..ffbff76b4 100644
--- a/docs/components/employee/employee-list.md
+++ b/docs/components/employee/employee-list.md
@@ -17,26 +17,21 @@ function MyApp({ companyId }) {
// Handle employee list events
}
- return (
-
- )
+ return
}
```
## Props
-| Name | Type | Default | Required | Description |
-| --- | --- | --- | --- | --- |
-| **companyId** | `string` | | Yes | The associated company identifier. |
-| **onEvent** | `(eventType: string, data?: unknown) => void` | | Yes | Callback invoked when events are emitted. |
+| Name | Type | Default | Required | Description |
+| ------------- | --------------------------------------------- | ------- | -------- | ----------------------------------------- |
+| **companyId** | `string` | | Yes | The associated company identifier. |
+| **onEvent** | `(eventType: string, data?: unknown) => void` | | Yes | Callback invoked when events are emitted. |
## Events
-| Event | Description | Data |
-| --- | --- | --- |
-| `EMPLOYEE_CREATE` | Fired when user clicks the "Add employee" button | None |
-| `EMPLOYEE_UPDATE` | Fired when user selects "Edit" from employee actions menu | `{ employeeId: string }` |
-| `EMPLOYEE_DELETED` | Fired after selecting delete and the operation completes | API response from Delete an onboarding employee endpoint |
+| Event | Description | Data |
+| ------------------ | --------------------------------------------------------- | -------------------------------------------------------- |
+| `EMPLOYEE_CREATE` | Fired when user clicks the "Add employee" button | None |
+| `EMPLOYEE_UPDATE` | Fired when user selects "Edit" from employee actions menu | `{ employeeId: string }` |
+| `EMPLOYEE_DELETED` | Fired after selecting delete and the operation completes | API response from Delete an onboarding employee endpoint |
diff --git a/docs/components/employee/employee.md b/docs/components/employee/employee.md
index 1a36197bb..dcebc86b0 100644
--- a/docs/components/employee/employee.md
+++ b/docs/components/employee/employee.md
@@ -15,30 +15,30 @@ import { Employee } from '@gusto/embedded-react-sdk'
Flows are multi-step workflow components that orchestrate several blocks into a guided experience.
-| Flow | Description |
-| --- | --- |
-| [Employee.OnboardingFlow](./onboarding-flow.md) | Admin-driven multi-step employee onboarding |
-| [Employee.SelfOnboardingFlow](./self-onboarding-flow.md) | Employee-facing self-onboarding experience |
-| [Employee.TerminationFlow](./termination-flow.md) | Full employee termination workflow |
+| Flow | Description |
+| -------------------------------------------------------- | ------------------------------------------- |
+| [Employee.OnboardingFlow](./onboarding-flow.md) | Admin-driven multi-step employee onboarding |
+| [Employee.SelfOnboardingFlow](./self-onboarding-flow.md) | Employee-facing self-onboarding experience |
+| [Employee.TerminationFlow](./termination-flow.md) | Full employee termination workflow |
## Blocks
Blocks are individual components that can be used standalone or composed into custom workflows. For guidance on composing your own workflows, see the [composition guide](../../concepts/composition.md).
-| Block | Description |
-| --- | --- |
-| [Employee.EmployeeList](./employee-list.md) | Displays employees with names and onboarding status |
-| [Employee.Profile](./profile.md) | Collects employee personal information and addresses |
-| [Employee.Compensation](./compensation.md) | Job title, FLSA status, pay rate, and payment unit |
-| [Employee.FederalTaxes](./federal-taxes.md) | Federal tax form configuration |
-| [Employee.StateTaxes](./state-taxes.md) | State tax form configuration |
-| [Employee.PaymentMethod](./payment-method.md) | Bank accounts for direct deposit |
-| [Employee.Deductions](./deductions.md) | Additional withholdings configuration |
-| [Employee.EmployeeDocuments](./employee-documents.md) | Admin I-9 document configuration |
-| [Employee.DocumentSigner](./document-signer.md) | Read and sign employment documents |
-| [Employee.EmploymentEligibility](./employment-eligibility.md) | I-9 employment eligibility verification |
-| [Employee.OnboardingSummary](./onboarding-summary.md) | Onboarding completion status |
-| [Employee.Landing](./landing.md) | Self-onboarding welcome page |
-| [Employee.TerminateEmployee](./terminate-employee.md) | Termination form |
-| [Employee.TerminationSummary](./termination-summary.md) | Termination confirmation and offboarding checklist |
-| [Employee.Taxes](./taxes.md) | Combined federal and state taxes (legacy) |
+| Block | Description |
+| ------------------------------------------------------------- | ---------------------------------------------------- |
+| [Employee.EmployeeList](./employee-list.md) | Displays employees with names and onboarding status |
+| [Employee.Profile](./profile.md) | Collects employee personal information and addresses |
+| [Employee.Compensation](./compensation.md) | Job title, FLSA status, pay rate, and payment unit |
+| [Employee.FederalTaxes](./federal-taxes.md) | Federal tax form configuration |
+| [Employee.StateTaxes](./state-taxes.md) | State tax form configuration |
+| [Employee.PaymentMethod](./payment-method.md) | Bank accounts for direct deposit |
+| [Employee.Deductions](./deductions.md) | Additional withholdings configuration |
+| [Employee.EmployeeDocuments](./employee-documents.md) | Admin I-9 document configuration |
+| [Employee.DocumentSigner](./document-signer.md) | Read and sign employment documents |
+| [Employee.EmploymentEligibility](./employment-eligibility.md) | I-9 employment eligibility verification |
+| [Employee.OnboardingSummary](./onboarding-summary.md) | Onboarding completion status |
+| [Employee.Landing](./landing.md) | Self-onboarding welcome page |
+| [Employee.TerminateEmployee](./terminate-employee.md) | Termination form |
+| [Employee.TerminationSummary](./termination-summary.md) | Termination confirmation and offboarding checklist |
+| [Employee.Taxes](./taxes.md) | Combined federal and state taxes (legacy) |
diff --git a/docs/components/employee/employment-eligibility.md b/docs/components/employee/employment-eligibility.md
index 5225faba4..c54a096b3 100644
--- a/docs/components/employee/employment-eligibility.md
+++ b/docs/components/employee/employment-eligibility.md
@@ -17,25 +17,20 @@ function MyApp({ employeeId }) {
// Handle employment eligibility events
}
- return (
-
- )
+ return
}
```
## Props
-| Name | Type | Default | Required | Description |
-| --- | --- | --- | --- | --- |
-| **employeeId** | `string` | | Yes | The associated employee identifier. |
-| **onEvent** | `(eventType: string, data?: unknown) => void` | | Yes | Callback invoked when events are emitted. |
+| Name | Type | Default | Required | Description |
+| -------------- | --------------------------------------------- | ------- | -------- | ----------------------------------------- |
+| **employeeId** | `string` | | Yes | The associated employee identifier. |
+| **onEvent** | `(eventType: string, data?: unknown) => void` | | Yes | Callback invoked when events are emitted. |
## Events
-| Event | Description | Data |
-| --- | --- | --- |
-| `EMPLOYEE_EMPLOYMENT_ELIGIBILITY_DONE` | Fired when the employee completes the employment eligibility form | Response from the Create or update an employee's I-9 authorization endpoint |
-| `EMPLOYEE_CHANGE_ELIGIBILITY_STATUS` | Fired when the employee changes their eligibility status (e.g. citizenship or immigration status) | None |
+| Event | Description | Data |
+| -------------------------------------- | ------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------- |
+| `EMPLOYEE_EMPLOYMENT_ELIGIBILITY_DONE` | Fired when the employee completes the employment eligibility form | Response from the Create or update an employee's I-9 authorization endpoint |
+| `EMPLOYEE_CHANGE_ELIGIBILITY_STATUS` | Fired when the employee changes their eligibility status (e.g. citizenship or immigration status) | None |
diff --git a/docs/components/employee/federal-taxes.md b/docs/components/employee/federal-taxes.md
index 93ad850c8..fae8a5013 100644
--- a/docs/components/employee/federal-taxes.md
+++ b/docs/components/employee/federal-taxes.md
@@ -17,25 +17,20 @@ function MyApp({ employeeId }) {
// Handle federal tax events
}
- return (
-
- )
+ return
}
```
## Props
-| Name | Type | Default | Required | Description |
-| --- | --- | --- | --- | --- |
-| **employeeId** | `string` | | Yes | The associated employee identifier. |
-| **onEvent** | `(eventType: string, data?: unknown) => void` | | Yes | Callback invoked when events are emitted. |
+| Name | Type | Default | Required | Description |
+| -------------- | --------------------------------------------- | ------- | -------- | ----------------------------------------- |
+| **employeeId** | `string` | | Yes | The associated employee identifier. |
+| **onEvent** | `(eventType: string, data?: unknown) => void` | | Yes | Callback invoked when events are emitted. |
## Events
-| Event | Description | Data |
-| --- | --- | --- |
-| `EMPLOYEE_FEDERAL_TAXES_UPDATED` | Fired when federal taxes are successfully updated | Response from the Update federal taxes endpoint |
-| `EMPLOYEE_FEDERAL_TAXES_DONE` | Fired when the form is submitted, the API request completes, and the step is ready to advance | None |
+| Event | Description | Data |
+| -------------------------------- | --------------------------------------------------------------------------------------------- | ----------------------------------------------- |
+| `EMPLOYEE_FEDERAL_TAXES_UPDATED` | Fired when federal taxes are successfully updated | Response from the Update federal taxes endpoint |
+| `EMPLOYEE_FEDERAL_TAXES_DONE` | Fired when the form is submitted, the API request completes, and the step is ready to advance | None |
diff --git a/docs/components/employee/landing.md b/docs/components/employee/landing.md
index 2bfbf073f..1423f6e19 100644
--- a/docs/components/employee/landing.md
+++ b/docs/components/employee/landing.md
@@ -17,26 +17,20 @@ function MyApp({ companyId, employeeId }) {
// Handle landing events
}
- return (
-
- )
+ return
}
```
## Props
-| Name | Type | Default | Required | Description |
-| --- | --- | --- | --- | --- |
-| **employeeId** | `string` | | Yes | The associated employee identifier. |
-| **companyId** | `string` | | Yes | The associated company identifier. |
-| **onEvent** | `(eventType: string, data?: unknown) => void` | | Yes | Callback invoked when events are emitted. |
+| Name | Type | Default | Required | Description |
+| -------------- | --------------------------------------------- | ------- | -------- | ----------------------------------------- |
+| **employeeId** | `string` | | Yes | The associated employee identifier. |
+| **companyId** | `string` | | Yes | The associated company identifier. |
+| **onEvent** | `(eventType: string, data?: unknown) => void` | | Yes | Callback invoked when events are emitted. |
## Events
-| Event | Description | Data |
-| --- | --- | --- |
+| Event | Description | Data |
+| -------------------------------- | ----------------------------------------------------------------------------------------------- | ---- |
| `EMPLOYEE_SELF_ONBOARDING_START` | Fired when the employee selects the "Get started" CTA and is ready to navigate to the next step | None |
diff --git a/docs/components/employee/onboarding-flow.md b/docs/components/employee/onboarding-flow.md
index 7b7fc4a28..de8782cf8 100644
--- a/docs/components/employee/onboarding-flow.md
+++ b/docs/components/employee/onboarding-flow.md
@@ -33,25 +33,19 @@ function MyApp({ companyId }) {
// Handle events from all subcomponents
}
- return (
-
- )
+ return
}
```
## Props
-| Name | Type | Default | Required | Description |
-| --- | --- | --- | --- | --- |
-| **companyId** | `string` | | Yes | The associated company identifier. |
-| **defaultValues** | `object` | | No | Default values for individual flow step components. |
-| **onEvent** | `(eventType: string, data?: unknown) => void` | | Yes | Callback invoked when events are emitted from any subcomponent. |
-| **isSelfOnboardingEnabled** | `boolean` | `true` | No | When true, presents the self-onboarding toggle allowing the admin to opt the employee into self-onboarding. |
-| **withEmployeeI9** | `boolean` | `false` | No | When true, enables the Employee Documents step in the onboarding flow for I-9 configuration. |
+| Name | Type | Default | Required | Description |
+| --------------------------- | --------------------------------------------- | ------- | -------- | ----------------------------------------------------------------------------------------------------------- |
+| **companyId** | `string` | | Yes | The associated company identifier. |
+| **defaultValues** | `object` | | No | Default values for individual flow step components. |
+| **onEvent** | `(eventType: string, data?: unknown) => void` | | Yes | Callback invoked when events are emitted from any subcomponent. |
+| **isSelfOnboardingEnabled** | `boolean` | `true` | No | When true, presents the self-onboarding toggle allowing the admin to opt the employee into self-onboarding. |
+| **withEmployeeI9** | `boolean` | `false` | No | When true, enables the Employee Documents step in the onboarding flow for I-9 configuration. |
## Events
diff --git a/docs/components/employee/onboarding-summary.md b/docs/components/employee/onboarding-summary.md
index fefed8b99..1ac295726 100644
--- a/docs/components/employee/onboarding-summary.md
+++ b/docs/components/employee/onboarding-summary.md
@@ -17,27 +17,21 @@ function MyApp({ employeeId }) {
// Handle summary events
}
- return (
-
- )
+ return
}
```
## Props
-| Name | Type | Default | Required | Description |
-| --- | --- | --- | --- | --- |
-| **employeeId** | `string` | | Yes | The associated employee identifier. |
-| **onEvent** | `(eventType: string, data?: unknown) => void` | | Yes | Callback invoked when events are emitted. |
-| **isAdmin** | `boolean` | `false` | No | When true, configures for admin onboarding. When false, configures for self-onboarding. |
+| Name | Type | Default | Required | Description |
+| -------------- | --------------------------------------------- | ------- | -------- | --------------------------------------------------------------------------------------- |
+| **employeeId** | `string` | | Yes | The associated employee identifier. |
+| **onEvent** | `(eventType: string, data?: unknown) => void` | | Yes | Callback invoked when events are emitted. |
+| **isAdmin** | `boolean` | `false` | No | When true, configures for admin onboarding. When false, configures for self-onboarding. |
## Events
-| Event | Description | Data |
-| --- | --- | --- |
-| `EMPLOYEES_LIST` | Fired when user clicks to return to the employee list | None |
-| `EMPLOYEE_CREATE` | Fired when user clicks to add another employee | None |
+| Event | Description | Data |
+| ----------------- | ----------------------------------------------------- | ---- |
+| `EMPLOYEES_LIST` | Fired when user clicks to return to the employee list | None |
+| `EMPLOYEE_CREATE` | Fired when user clicks to add another employee | None |
diff --git a/docs/components/employee/payment-method.md b/docs/components/employee/payment-method.md
index 17f5cc03e..3e1f3696f 100644
--- a/docs/components/employee/payment-method.md
+++ b/docs/components/employee/payment-method.md
@@ -17,28 +17,23 @@ function MyApp({ employeeId }) {
// Handle payment method events
}
- return (
-
- )
+ return
}
```
## Props
-| Name | Type | Default | Required | Description |
-| --- | --- | --- | --- | --- |
-| **employeeId** | `string` | | Yes | The associated employee identifier. |
-| **onEvent** | `(eventType: string, data?: unknown) => void` | | Yes | Callback invoked when events are emitted. |
-| **isAdmin** | `boolean` | `false` | No | When true, configures the form for admin onboarding. When false, configures for self-onboarding. |
+| Name | Type | Default | Required | Description |
+| -------------- | --------------------------------------------- | ------- | -------- | ------------------------------------------------------------------------------------------------ |
+| **employeeId** | `string` | | Yes | The associated employee identifier. |
+| **onEvent** | `(eventType: string, data?: unknown) => void` | | Yes | Callback invoked when events are emitted. |
+| **isAdmin** | `boolean` | `false` | No | When true, configures the form for admin onboarding. When false, configures for self-onboarding. |
## Events
-| Event | Description | Data |
-| --- | --- | --- |
-| `EMPLOYEE_BANK_ACCOUNT_CREATED` | Fired after the add bank account form is submitted and a new account is created | Response from the Create a bank account endpoint |
-| `EMPLOYEE_BANK_ACCOUNT_DELETED` | Fired after deleting a bank account | Response from the Delete a bank account endpoint |
+| Event | Description | Data |
+| --------------------------------- | --------------------------------------------------------------------------------------------------------- | ------------------------------------------------ |
+| `EMPLOYEE_BANK_ACCOUNT_CREATED` | Fired after the add bank account form is submitted and a new account is created | Response from the Create a bank account endpoint |
+| `EMPLOYEE_BANK_ACCOUNT_DELETED` | Fired after deleting a bank account | Response from the Delete a bank account endpoint |
| `EMPLOYEE_PAYMENT_METHOD_UPDATED` | Fired when the employee updates the payment method by continuing or saving a split paycheck configuration | Response from the Update payment method endpoint |
-| `EMPLOYEE_PAYMENT_METHOD_DONE` | Fired when all API calls are finished and the step is ready to advance | None |
+| `EMPLOYEE_PAYMENT_METHOD_DONE` | Fired when all API calls are finished and the step is ready to advance | None |
diff --git a/docs/components/employee/profile.md b/docs/components/employee/profile.md
index 849c33be4..947662f84 100644
--- a/docs/components/employee/profile.md
+++ b/docs/components/employee/profile.md
@@ -35,14 +35,14 @@ function MyApp({ companyId, employeeId }) {
## Props
-| Name | Type | Default | Required | Description |
-| --- | --- | --- | --- | --- |
-| **companyId** | `string` | | Yes | The associated company identifier. |
-| **employeeId** | `string` | | No | The associated employee identifier. When omitted, the form creates a new employee. |
-| **onEvent** | `(eventType: string, data?: unknown) => void` | | Yes | Callback invoked when events are emitted. |
-| **isAdmin** | `boolean` | `false` | No | When true, configures the form for admin onboarding (shows work address, start date). When false, configures for self-onboarding. |
-| **isSelfOnboardingEnabled** | `boolean` | | No | When true, presents the self-onboarding toggle allowing the admin to invite the employee to self-onboard. |
-| **defaultValues** | `object` | | No | Default values for the profile form. Accepts `employee` and `homeAddress` sub-objects. If employee data is available via the API, these values are overwritten. |
+| Name | Type | Default | Required | Description |
+| --------------------------- | --------------------------------------------- | ------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **companyId** | `string` | | Yes | The associated company identifier. |
+| **employeeId** | `string` | | No | The associated employee identifier. When omitted, the form creates a new employee. |
+| **onEvent** | `(eventType: string, data?: unknown) => void` | | Yes | Callback invoked when events are emitted. |
+| **isAdmin** | `boolean` | `false` | No | When true, configures the form for admin onboarding (shows work address, start date). When false, configures for self-onboarding. |
+| **isSelfOnboardingEnabled** | `boolean` | | No | When true, presents the self-onboarding toggle allowing the admin to invite the employee to self-onboard. |
+| **defaultValues** | `object` | | No | Default values for the profile form. Accepts `employee` and `homeAddress` sub-objects. If employee data is available via the API, these values are overwritten. |
### defaultValues shape
@@ -67,14 +67,14 @@ function MyApp({ companyId, employeeId }) {
## Events
-| Event | Description | Data |
-| --- | --- | --- |
-| `EMPLOYEE_CREATED` | Fired after form submission when creating a new employee | Response from the Create an employee endpoint |
-| `EMPLOYEE_UPDATED` | Fired after form submission when updating an existing employee | Response from the Update an employee endpoint |
-| `EMPLOYEE_HOME_ADDRESS_CREATED` | Fired after form submission when creating a new employee's home address | Response from the Create an employee's home address endpoint |
-| `EMPLOYEE_HOME_ADDRESS_UPDATED` | Fired after form submission when updating an existing employee's home address | Response from the Update an employee's home address endpoint |
-| `EMPLOYEE_WORK_ADDRESS_CREATED` | Fired after form submission when creating a work address | Response from the Create a work address endpoint |
-| `EMPLOYEE_WORK_ADDRESS_UPDATED` | Fired after form submission when updating a work address | Response from the Update a work address endpoint |
-| `EMPLOYEE_PROFILE_DONE` | Fired after all API calls complete and the step is ready to advance | Aggregated response object from all create or update operations |
-| `EMPLOYEE_ONBOARDING_STATUS_UPDATED` | Fired when the employee's onboarding status is updated | API response |
-| `CANCEL` | Fired when user clicks the cancel button | None |
+| Event | Description | Data |
+| ------------------------------------ | ----------------------------------------------------------------------------- | --------------------------------------------------------------- |
+| `EMPLOYEE_CREATED` | Fired after form submission when creating a new employee | Response from the Create an employee endpoint |
+| `EMPLOYEE_UPDATED` | Fired after form submission when updating an existing employee | Response from the Update an employee endpoint |
+| `EMPLOYEE_HOME_ADDRESS_CREATED` | Fired after form submission when creating a new employee's home address | Response from the Create an employee's home address endpoint |
+| `EMPLOYEE_HOME_ADDRESS_UPDATED` | Fired after form submission when updating an existing employee's home address | Response from the Update an employee's home address endpoint |
+| `EMPLOYEE_WORK_ADDRESS_CREATED` | Fired after form submission when creating a work address | Response from the Create a work address endpoint |
+| `EMPLOYEE_WORK_ADDRESS_UPDATED` | Fired after form submission when updating a work address | Response from the Update a work address endpoint |
+| `EMPLOYEE_PROFILE_DONE` | Fired after all API calls complete and the step is ready to advance | Aggregated response object from all create or update operations |
+| `EMPLOYEE_ONBOARDING_STATUS_UPDATED` | Fired when the employee's onboarding status is updated | API response |
+| `CANCEL` | Fired when user clicks the cancel button | None |
diff --git a/docs/components/employee/self-onboarding-flow.md b/docs/components/employee/self-onboarding-flow.md
index 7d8ac1297..5e8c0d3d2 100644
--- a/docs/components/employee/self-onboarding-flow.md
+++ b/docs/components/employee/self-onboarding-flow.md
@@ -40,12 +40,12 @@ function MyApp({ companyId, employeeId }) {
## Props
-| Name | Type | Default | Required | Description |
-| --- | --- | --- | --- | --- |
-| **companyId** | `string` | | Yes | The associated company identifier. |
-| **employeeId** | `string` | | Yes | The associated employee identifier. |
-| **onEvent** | `(eventType: string, data?: unknown) => void` | | Yes | Callback invoked when events are emitted from any subcomponent. |
-| **withEmployeeI9** | `boolean` | `false` | No | When true, the Document Signer step checks if the employee has I-9 enabled and routes to the Employment Eligibility and I-9 signature form steps. |
+| Name | Type | Default | Required | Description |
+| ------------------ | --------------------------------------------- | ------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **companyId** | `string` | | Yes | The associated company identifier. |
+| **employeeId** | `string` | | Yes | The associated employee identifier. |
+| **onEvent** | `(eventType: string, data?: unknown) => void` | | Yes | Callback invoked when events are emitted from any subcomponent. |
+| **withEmployeeI9** | `boolean` | `false` | No | When true, the Document Signer step checks if the employee has I-9 enabled and routes to the Employment Eligibility and I-9 signature form steps. |
## Events
diff --git a/docs/components/employee/state-taxes.md b/docs/components/employee/state-taxes.md
index 16fa871d7..8417f394b 100644
--- a/docs/components/employee/state-taxes.md
+++ b/docs/components/employee/state-taxes.md
@@ -17,26 +17,21 @@ function MyApp({ employeeId }) {
// Handle state tax events
}
- return (
-
- )
+ return
}
```
## Props
-| Name | Type | Default | Required | Description |
-| --- | --- | --- | --- | --- |
-| **employeeId** | `string` | | Yes | The associated employee identifier. |
-| **onEvent** | `(eventType: string, data?: unknown) => void` | | Yes | Callback invoked when events are emitted. |
-| **isAdmin** | `boolean` | `false` | No | When true, configures the form for admin onboarding. When false, configures for self-onboarding. |
+| Name | Type | Default | Required | Description |
+| -------------- | --------------------------------------------- | ------- | -------- | ------------------------------------------------------------------------------------------------ |
+| **employeeId** | `string` | | Yes | The associated employee identifier. |
+| **onEvent** | `(eventType: string, data?: unknown) => void` | | Yes | Callback invoked when events are emitted. |
+| **isAdmin** | `boolean` | `false` | No | When true, configures the form for admin onboarding. When false, configures for self-onboarding. |
## Events
-| Event | Description | Data |
-| --- | --- | --- |
-| `EMPLOYEE_STATE_TAXES_UPDATED` | Fired when state taxes are successfully updated | Response from the Update state taxes endpoint |
-| `EMPLOYEE_STATE_TAXES_DONE` | Fired when the form is submitted, the API request completes, and the step is ready to advance | None |
+| Event | Description | Data |
+| ------------------------------ | --------------------------------------------------------------------------------------------- | --------------------------------------------- |
+| `EMPLOYEE_STATE_TAXES_UPDATED` | Fired when state taxes are successfully updated | Response from the Update state taxes endpoint |
+| `EMPLOYEE_STATE_TAXES_DONE` | Fired when the form is submitted, the API request completes, and the step is ready to advance | None |
diff --git a/docs/components/employee/taxes.md b/docs/components/employee/taxes.md
index c7121d64a..4325db741 100644
--- a/docs/components/employee/taxes.md
+++ b/docs/components/employee/taxes.md
@@ -17,24 +17,19 @@ function MyApp({ employeeId }) {
// Handle tax events
}
- return (
-
- )
+ return
}
```
## Props
-| Name | Type | Default | Required | Description |
-| --- | --- | --- | --- | --- |
-| **employeeId** | `string` | | Yes | The associated employee identifier. |
-| **onEvent** | `(eventType: string, data?: unknown) => void` | | Yes | Callback invoked when events are emitted. |
+| Name | Type | Default | Required | Description |
+| -------------- | --------------------------------------------- | ------- | -------- | ----------------------------------------- |
+| **employeeId** | `string` | | Yes | The associated employee identifier. |
+| **onEvent** | `(eventType: string, data?: unknown) => void` | | Yes | Callback invoked when events are emitted. |
## Events
-| Event | Description | Data |
-| --- | --- | --- |
+| Event | Description | Data |
+| --------------------- | ----------------------------------------------------------------------------------------- | ---- |
| `EMPLOYEE_TAXES_DONE` | Fired when both federal and state tax forms are complete and the step is ready to advance | None |
diff --git a/docs/components/employee/terminate-employee.md b/docs/components/employee/terminate-employee.md
index 8029bbe25..84dae1325 100644
--- a/docs/components/employee/terminate-employee.md
+++ b/docs/components/employee/terminate-employee.md
@@ -34,18 +34,18 @@ function MyApp({ companyId, employeeId }) {
## Props
-| Name | Type | Default | Required | Description |
-| --- | --- | --- | --- | --- |
-| **companyId** | `string` | | Yes | The associated company identifier. |
-| **employeeId** | `string` | | Yes | The employee identifier to terminate. |
-| **onEvent** | `(eventType: string, data?: unknown) => void` | | Yes | Callback invoked when events are emitted. |
-| **dictionary** | `object` | | No | Optional translations for component text. |
+| Name | Type | Default | Required | Description |
+| -------------- | --------------------------------------------- | ------- | -------- | ----------------------------------------- |
+| **companyId** | `string` | | Yes | The associated company identifier. |
+| **employeeId** | `string` | | Yes | The employee identifier to terminate. |
+| **onEvent** | `(eventType: string, data?: unknown) => void` | | Yes | Callback invoked when events are emitted. |
+| **dictionary** | `object` | | No | Optional translations for component text. |
## Events
-| Event | Description | Data |
-| --- | --- | --- |
-| `EMPLOYEE_TERMINATION_CREATED` | Fired when a new termination is created | `{ employeeId, effectiveDate, payrollOption }` |
-| `EMPLOYEE_TERMINATION_UPDATED` | Fired when an existing termination is updated | `{ employeeId, effectiveDate, payrollOption }` |
-| `EMPLOYEE_TERMINATION_DONE` | Fired when the termination form is completed | `{ employeeId, effectiveDate, payrollOption }` |
-| `EMPLOYEE_TERMINATION_VIEW_SUMMARY` | Fired when redirecting to view an existing termination | `{ employeeId, effectiveDate }` |
+| Event | Description | Data |
+| ----------------------------------- | ------------------------------------------------------ | ---------------------------------------------- |
+| `EMPLOYEE_TERMINATION_CREATED` | Fired when a new termination is created | `{ employeeId, effectiveDate, payrollOption }` |
+| `EMPLOYEE_TERMINATION_UPDATED` | Fired when an existing termination is updated | `{ employeeId, effectiveDate, payrollOption }` |
+| `EMPLOYEE_TERMINATION_DONE` | Fired when the termination form is completed | `{ employeeId, effectiveDate, payrollOption }` |
+| `EMPLOYEE_TERMINATION_VIEW_SUMMARY` | Fired when redirecting to view an existing termination | `{ employeeId, effectiveDate }` |
diff --git a/docs/components/employee/termination-flow.md b/docs/components/employee/termination-flow.md
index 6c01edc97..24c97bb1b 100644
--- a/docs/components/employee/termination-flow.md
+++ b/docs/components/employee/termination-flow.md
@@ -26,35 +26,31 @@ function MyApp({ companyId, employeeId }) {
}
return (
-
+
)
}
```
## Props
-| Name | Type | Default | Required | Description |
-| --- | --- | --- | --- | --- |
-| **companyId** | `string` | | Yes | The associated company identifier. |
-| **employeeId** | `string` | | Yes | The employee identifier to terminate. |
-| **onEvent** | `(eventType: string, data?: unknown) => void` | | Yes | Callback invoked when events are emitted. |
-| **dictionary** | `object` | | No | Optional translations for component text. |
+| Name | Type | Default | Required | Description |
+| -------------- | --------------------------------------------- | ------- | -------- | ----------------------------------------- |
+| **companyId** | `string` | | Yes | The associated company identifier. |
+| **employeeId** | `string` | | Yes | The employee identifier to terminate. |
+| **onEvent** | `(eventType: string, data?: unknown) => void` | | Yes | Callback invoked when events are emitted. |
+| **dictionary** | `object` | | No | Optional translations for component text. |
## Events
-| Event | Description | Data |
-| --- | --- | --- |
-| `EMPLOYEE_TERMINATION_CREATED` | Fired when a new termination is created | `{ employeeId, effectiveDate, payrollOption }` |
-| `EMPLOYEE_TERMINATION_UPDATED` | Fired when an existing termination is updated | `{ employeeId, effectiveDate, payrollOption }` |
-| `EMPLOYEE_TERMINATION_DONE` | Fired when the termination process is complete | `{ employeeId, effectiveDate, payrollOption, payrollUuid? }` |
-| `EMPLOYEE_TERMINATION_VIEW_SUMMARY` | Fired when viewing an existing termination summary | `{ employeeId, effectiveDate }` |
-| `EMPLOYEE_TERMINATION_EDIT` | Fired when user clicks to edit termination details | `{ employeeId }` |
-| `EMPLOYEE_TERMINATION_CANCELLED` | Fired when a termination is cancelled | `{ employeeId, alert? }` |
-| `EMPLOYEE_TERMINATION_RUN_PAYROLL` | Fired when user chooses to run termination payroll | `{ employeeId, companyId, effectiveDate }` |
-| `EMPLOYEE_TERMINATION_RUN_OFF_CYCLE_PAYROLL` | Fired when user chooses to run an off-cycle payroll | `{ employeeId, companyId }` |
-| `EMPLOYEE_TERMINATION_PAYROLL_CREATED` | Fired when an off-cycle payroll is created for termination | `{ employeeId, effectiveDate }` |
-| `EMPLOYEE_TERMINATION_PAYROLL_FAILED` | Fired when off-cycle payroll creation fails | `{ employeeId }` |
+| Event | Description | Data |
+| -------------------------------------------- | ---------------------------------------------------------- | ------------------------------------------------------------ |
+| `EMPLOYEE_TERMINATION_CREATED` | Fired when a new termination is created | `{ employeeId, effectiveDate, payrollOption }` |
+| `EMPLOYEE_TERMINATION_UPDATED` | Fired when an existing termination is updated | `{ employeeId, effectiveDate, payrollOption }` |
+| `EMPLOYEE_TERMINATION_DONE` | Fired when the termination process is complete | `{ employeeId, effectiveDate, payrollOption, payrollUuid? }` |
+| `EMPLOYEE_TERMINATION_VIEW_SUMMARY` | Fired when viewing an existing termination summary | `{ employeeId, effectiveDate }` |
+| `EMPLOYEE_TERMINATION_EDIT` | Fired when user clicks to edit termination details | `{ employeeId }` |
+| `EMPLOYEE_TERMINATION_CANCELLED` | Fired when a termination is cancelled | `{ employeeId, alert? }` |
+| `EMPLOYEE_TERMINATION_RUN_PAYROLL` | Fired when user chooses to run termination payroll | `{ employeeId, companyId, effectiveDate }` |
+| `EMPLOYEE_TERMINATION_RUN_OFF_CYCLE_PAYROLL` | Fired when user chooses to run an off-cycle payroll | `{ employeeId, companyId }` |
+| `EMPLOYEE_TERMINATION_PAYROLL_CREATED` | Fired when an off-cycle payroll is created for termination | `{ employeeId, effectiveDate }` |
+| `EMPLOYEE_TERMINATION_PAYROLL_FAILED` | Fired when off-cycle payroll creation fails | `{ employeeId }` |
diff --git a/docs/components/employee/termination-summary.md b/docs/components/employee/termination-summary.md
index 95a6b3f9c..05532be4c 100644
--- a/docs/components/employee/termination-summary.md
+++ b/docs/components/employee/termination-summary.md
@@ -39,20 +39,20 @@ function MyApp({ companyId, employeeId }) {
## Props
-| Name | Type | Default | Required | Description |
-| --- | --- | --- | --- | --- |
-| **companyId** | `string` | | Yes | The associated company identifier. |
-| **employeeId** | `string` | | Yes | The employee identifier. |
-| **payrollOption** | `PayrollOption` | | No | The selected payroll processing option. When provided, shows a success alert. |
-| **payrollUuid** | `string` | | No | UUID of the created payroll, if applicable. |
-| **onEvent** | `(eventType: string, data?: unknown) => void` | | Yes | Callback invoked when events are emitted. |
-| **dictionary** | `object` | | No | Optional translations for component text. |
+| Name | Type | Default | Required | Description |
+| ----------------- | --------------------------------------------- | ------- | -------- | ----------------------------------------------------------------------------- |
+| **companyId** | `string` | | Yes | The associated company identifier. |
+| **employeeId** | `string` | | Yes | The employee identifier. |
+| **payrollOption** | `PayrollOption` | | No | The selected payroll processing option. When provided, shows a success alert. |
+| **payrollUuid** | `string` | | No | UUID of the created payroll, if applicable. |
+| **onEvent** | `(eventType: string, data?: unknown) => void` | | Yes | Callback invoked when events are emitted. |
+| **dictionary** | `object` | | No | Optional translations for component text. |
## Events
-| Event | Description | Data |
-| --- | --- | --- |
-| `EMPLOYEE_TERMINATION_EDIT` | Fired when user clicks to edit termination details | `{ employeeId }` |
-| `EMPLOYEE_TERMINATION_CANCELLED` | Fired when a termination is successfully cancelled | `{ employeeId, alert? }` |
-| `EMPLOYEE_TERMINATION_RUN_PAYROLL` | Fired when user clicks to run termination payroll | `{ employeeId, companyId, effectiveDate }` |
-| `EMPLOYEE_TERMINATION_RUN_OFF_CYCLE_PAYROLL` | Fired when user clicks to run an off-cycle payroll | `{ employeeId, companyId }` |
+| Event | Description | Data |
+| -------------------------------------------- | -------------------------------------------------- | ------------------------------------------ |
+| `EMPLOYEE_TERMINATION_EDIT` | Fired when user clicks to edit termination details | `{ employeeId }` |
+| `EMPLOYEE_TERMINATION_CANCELLED` | Fired when a termination is successfully cancelled | `{ employeeId, alert? }` |
+| `EMPLOYEE_TERMINATION_RUN_PAYROLL` | Fired when user clicks to run termination payroll | `{ employeeId, companyId, effectiveDate }` |
+| `EMPLOYEE_TERMINATION_RUN_OFF_CYCLE_PAYROLL` | Fired when user clicks to run an off-cycle payroll | `{ employeeId, companyId }` |
diff --git a/docs/components/information-requests/information-request-form.md b/docs/components/information-requests/information-request-form.md
index 8c956401a..1791c5219 100644
--- a/docs/components/information-requests/information-request-form.md
+++ b/docs/components/information-requests/information-request-form.md
@@ -25,15 +25,15 @@ function MyComponent() {
## Props
-| Name | Type | Required | Description |
-| --- | --- | --- | --- |
-| `companyId` | `string` | Yes | The associated company identifier. |
-| `requestId` | `string` | Yes | The information request identifier. |
-| `onEvent` | `(eventType: string, data?: unknown) => void` | Yes | Callback invoked when events are emitted. |
+| Name | Type | Required | Description |
+| ----------- | --------------------------------------------- | -------- | ----------------------------------------- |
+| `companyId` | `string` | Yes | The associated company identifier. |
+| `requestId` | `string` | Yes | The information request identifier. |
+| `onEvent` | `(eventType: string, data?: unknown) => void` | Yes | Callback invoked when events are emitted. |
## Events
-| Event | Description | Data |
-| --- | --- | --- |
-| `INFORMATION_REQUEST_FORM_DONE` | Fired when the request response is successfully submitted. | None |
-| `INFORMATION_REQUEST_FORM_CANCEL` | Fired when the user cancels responding to the request. | None |
+| Event | Description | Data |
+| --------------------------------- | ---------------------------------------------------------- | ---- |
+| `INFORMATION_REQUEST_FORM_DONE` | Fired when the request response is successfully submitted. | None |
+| `INFORMATION_REQUEST_FORM_CANCEL` | Fired when the user cancels responding to the request. | None |
diff --git a/docs/components/information-requests/information-request-list.md b/docs/components/information-requests/information-request-list.md
index 696f0d6c7..a2b657db3 100644
--- a/docs/components/information-requests/information-request-list.md
+++ b/docs/components/information-requests/information-request-list.md
@@ -24,13 +24,13 @@ function MyComponent() {
## Props
-| Name | Type | Required | Description |
-| --- | --- | --- | --- |
-| `companyId` | `string` | Yes | The associated company identifier. |
-| `onEvent` | `(eventType: string, data?: unknown) => void` | Yes | Callback invoked when events are emitted. |
+| Name | Type | Required | Description |
+| ----------- | --------------------------------------------- | -------- | ----------------------------------------- |
+| `companyId` | `string` | Yes | The associated company identifier. |
+| `onEvent` | `(eventType: string, data?: unknown) => void` | Yes | Callback invoked when events are emitted. |
## Events
-| Event | Description | Data |
-| --- | --- | --- |
+| Event | Description | Data |
+| ----------------------------- | ---------------------------------------------------- | ---- |
| `INFORMATION_REQUEST_RESPOND` | Fired when the user selects a request to respond to. | None |
diff --git a/docs/components/information-requests/information-requests-flow.md b/docs/components/information-requests/information-requests-flow.md
index ee100f49d..011f8dfc4 100644
--- a/docs/components/information-requests/information-requests-flow.md
+++ b/docs/components/information-requests/information-requests-flow.md
@@ -24,16 +24,16 @@ function MyApp() {
## Props
-| Name | Type | Required | Description |
-| --- | --- | --- | --- |
-| `companyId` | `string` | Yes | The associated company identifier. |
-| `onEvent` | `(eventType: string, data?: unknown) => void` | No | Callback invoked when events are emitted. Receives events from all subcomponents. |
-| `withAlert` | `boolean` | No | Whether to display an alert banner for pending requests. Defaults to `true`. |
+| Name | Type | Required | Description |
+| ----------- | --------------------------------------------- | -------- | --------------------------------------------------------------------------------- |
+| `companyId` | `string` | Yes | The associated company identifier. |
+| `onEvent` | `(eventType: string, data?: unknown) => void` | No | Callback invoked when events are emitted. Receives events from all subcomponents. |
+| `withAlert` | `boolean` | No | Whether to display an alert banner for pending requests. Defaults to `true`. |
## Events
-| Event | Description | Data |
-| --- | --- | --- |
-| `INFORMATION_REQUEST_RESPOND` | Fired when the user selects a request to respond to. | None |
-| `INFORMATION_REQUEST_FORM_DONE` | Fired when a request response is successfully submitted. | None |
-| `INFORMATION_REQUEST_FORM_CANCEL` | Fired when the user cancels responding to a request. | None |
+| Event | Description | Data |
+| --------------------------------- | -------------------------------------------------------- | ---- |
+| `INFORMATION_REQUEST_RESPOND` | Fired when the user selects a request to respond to. | None |
+| `INFORMATION_REQUEST_FORM_DONE` | Fired when a request response is successfully submitted. | None |
+| `INFORMATION_REQUEST_FORM_CANCEL` | Fired when the user cancels responding to a request. | None |
diff --git a/docs/components/information-requests/information-requests.md b/docs/components/information-requests/information-requests.md
index bf01185df..682f33450 100644
--- a/docs/components/information-requests/information-requests.md
+++ b/docs/components/information-requests/information-requests.md
@@ -7,13 +7,13 @@ The Information Requests domain provides components for responding to tax agency
## Flow
-| Component | Description |
-| --- | --- |
+| Component | Description |
+| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------- |
| [InformationRequests.InformationRequestsFlow](./information-requests-flow.md) | End-to-end workflow for viewing and responding to information requests. |
## Blocks
-| Component | Description |
-| --- | --- |
+| Component | Description |
+| --------------------------------------------------------------------------- | ------------------------------------------------------ |
| [InformationRequests.InformationRequestList](./information-request-list.md) | Displays a list of information requests for a company. |
| [InformationRequests.InformationRequestForm](./information-request-form.md) | Form for responding to a specific information request. |
diff --git a/docs/components/payroll/confirm-wire-details.md b/docs/components/payroll/confirm-wire-details.md
index 7ca5fa56e..bf8bca6eb 100644
--- a/docs/components/payroll/confirm-wire-details.md
+++ b/docs/components/payroll/confirm-wire-details.md
@@ -24,20 +24,20 @@ function MyComponent() {
## Props
-| Name | Type | Required | Description |
-| --- | --- | --- | --- |
-| `companyId` | `string` | Yes | The associated company identifier. |
-| `wireInId` | `string` | No | The wire-in identifier. |
-| `onEvent` | `(eventType: string, data?: unknown) => void` | No | Callback invoked when events are emitted. |
-| `dictionary` | `object` | No | Custom label overrides for UI text. |
+| Name | Type | Required | Description |
+| ------------ | --------------------------------------------- | -------- | ----------------------------------------- |
+| `companyId` | `string` | Yes | The associated company identifier. |
+| `wireInId` | `string` | No | The wire-in identifier. |
+| `onEvent` | `(eventType: string, data?: unknown) => void` | No | Callback invoked when events are emitted. |
+| `dictionary` | `object` | No | Custom label overrides for UI text. |
## Events
-| Event | Description | Data |
-| --- | --- | --- |
-| `PAYROLL_WIRE_START_TRANSFER` | Fired when user initiates the wire transfer flow. | None |
-| `PAYROLL_WIRE_INSTRUCTIONS_SELECT` | Fired when user selects a wire-in request. | `{ selectedWireInId: string }` |
-| `PAYROLL_WIRE_INSTRUCTIONS_DONE` | Fired when user completes viewing wire instructions. | `{ selectedWireInId: string }` |
-| `PAYROLL_WIRE_INSTRUCTIONS_CANCEL` | Fired when user cancels viewing wire instructions. | None |
-| `PAYROLL_WIRE_FORM_DONE` | Fired when user completes the wire confirmation. | `{ wireInRequest: object }` |
-| `PAYROLL_WIRE_FORM_CANCEL` | Fired when user cancels the wire confirmation form. | None |
+| Event | Description | Data |
+| ---------------------------------- | ---------------------------------------------------- | ------------------------------ |
+| `PAYROLL_WIRE_START_TRANSFER` | Fired when user initiates the wire transfer flow. | None |
+| `PAYROLL_WIRE_INSTRUCTIONS_SELECT` | Fired when user selects a wire-in request. | `{ selectedWireInId: string }` |
+| `PAYROLL_WIRE_INSTRUCTIONS_DONE` | Fired when user completes viewing wire instructions. | `{ selectedWireInId: string }` |
+| `PAYROLL_WIRE_INSTRUCTIONS_CANCEL` | Fired when user cancels viewing wire instructions. | None |
+| `PAYROLL_WIRE_FORM_DONE` | Fired when user completes the wire confirmation. | `{ wireInRequest: object }` |
+| `PAYROLL_WIRE_FORM_CANCEL` | Fired when user cancels the wire confirmation form. | None |
diff --git a/docs/components/payroll/dismissal-flow.md b/docs/components/payroll/dismissal-flow.md
index 3c5a493bd..70fd714d6 100644
--- a/docs/components/payroll/dismissal-flow.md
+++ b/docs/components/payroll/dismissal-flow.md
@@ -24,15 +24,15 @@ function MyApp() {
## Props
-| Name | Type | Required | Description |
-| --- | --- | --- | --- |
-| `companyId` | `string` | Yes | The associated company identifier. |
-| `employeeId` | `string` | No | The employee identifier for the dismissed employee. |
-| `payrollId` | `string` | No | An existing payroll identifier to continue processing. |
-| `onEvent` | `(eventType: string, data?: unknown) => void` | Yes | Callback invoked when events are emitted. Receives events from all subcomponents. |
+| Name | Type | Required | Description |
+| ------------ | --------------------------------------------- | -------- | --------------------------------------------------------------------------------- |
+| `companyId` | `string` | Yes | The associated company identifier. |
+| `employeeId` | `string` | No | The employee identifier for the dismissed employee. |
+| `payrollId` | `string` | No | An existing payroll identifier to continue processing. |
+| `onEvent` | `(eventType: string, data?: unknown) => void` | Yes | Callback invoked when events are emitted. Receives events from all subcomponents. |
## Events
-| Event | Description | Data |
-| --- | --- | --- |
+| Event | Description | Data |
+| ------------------------------- | -------------------------------------------------------------- | ---- |
| `DISMISSAL_PAY_PERIOD_SELECTED` | Fired when a pay period is selected for the dismissal payroll. | None |
diff --git a/docs/components/payroll/off-cycle-creation.md b/docs/components/payroll/off-cycle-creation.md
index 89170d3fe..d35631f0b 100644
--- a/docs/components/payroll/off-cycle-creation.md
+++ b/docs/components/payroll/off-cycle-creation.md
@@ -24,14 +24,14 @@ function MyComponent() {
## Props
-| Name | Type | Required | Description |
-| --- | --- | --- | --- |
-| `companyId` | `string` | Yes | The associated company identifier. |
-| `payrollType` | `string` | No | The type of off-cycle payroll. Defaults to `'bonus'`. |
-| `onEvent` | `(eventType: string, data?: unknown) => void` | Yes | Callback invoked when events are emitted. |
+| Name | Type | Required | Description |
+| ------------- | --------------------------------------------- | -------- | ----------------------------------------------------- |
+| `companyId` | `string` | Yes | The associated company identifier. |
+| `payrollType` | `string` | No | The type of off-cycle payroll. Defaults to `'bonus'`. |
+| `onEvent` | `(eventType: string, data?: unknown) => void` | Yes | Callback invoked when events are emitted. |
## Events
-| Event | Description | Data |
-| --- | --- | --- |
+| Event | Description | Data |
+| ------------------- | --------------------------------------------------------- | ------------------------- |
| `OFF_CYCLE_CREATED` | Fired when the off-cycle payroll is successfully created. | `{ payrollUuid: string }` |
diff --git a/docs/components/payroll/off-cycle-deductions-setting.md b/docs/components/payroll/off-cycle-deductions-setting.md
index d52591c72..13538c831 100644
--- a/docs/components/payroll/off-cycle-deductions-setting.md
+++ b/docs/components/payroll/off-cycle-deductions-setting.md
@@ -24,13 +24,13 @@ function MyComponent() {
## Props
-| Name | Type | Required | Description |
-| --- | --- | --- | --- |
-| `skipRegularDeductions` | `boolean` | Yes | Whether to skip regular deductions in the off-cycle payroll. |
-| `onEvent` | `(eventType: string, data?: unknown) => void` | Yes | Callback invoked when events are emitted. |
+| Name | Type | Required | Description |
+| ----------------------- | --------------------------------------------- | -------- | ------------------------------------------------------------ |
+| `skipRegularDeductions` | `boolean` | Yes | Whether to skip regular deductions in the off-cycle payroll. |
+| `onEvent` | `(eventType: string, data?: unknown) => void` | Yes | Callback invoked when events are emitted. |
## Events
-| Event | Description | Data |
-| --- | --- | --- |
+| Event | Description | Data |
+| ----------------------------- | -------------------------------------------------- | ------------------------------------ |
| `OFF_CYCLE_DEDUCTIONS_CHANGE` | Fired when the user changes the deduction setting. | `{ skipRegularDeductions: boolean }` |
diff --git a/docs/components/payroll/off-cycle-flow.md b/docs/components/payroll/off-cycle-flow.md
index 10844929b..6401ca5be 100644
--- a/docs/components/payroll/off-cycle-flow.md
+++ b/docs/components/payroll/off-cycle-flow.md
@@ -24,15 +24,15 @@ function MyApp() {
## Props
-| Name | Type | Required | Description |
-| --- | --- | --- | --- |
-| `companyId` | `string` | Yes | The associated company identifier. |
-| `payrollType` | `string` | No | The type of off-cycle payroll. Defaults to `'bonus'`. |
-| `onEvent` | `(eventType: string, data?: unknown) => void` | Yes | Callback invoked when events are emitted. Receives events from all subcomponents. |
-| `withReimbursements` | `boolean` | No | Whether to include reimbursement inputs in the payroll. |
+| Name | Type | Required | Description |
+| -------------------- | --------------------------------------------- | -------- | --------------------------------------------------------------------------------- |
+| `companyId` | `string` | Yes | The associated company identifier. |
+| `payrollType` | `string` | No | The type of off-cycle payroll. Defaults to `'bonus'`. |
+| `onEvent` | `(eventType: string, data?: unknown) => void` | Yes | Callback invoked when events are emitted. Receives events from all subcomponents. |
+| `withReimbursements` | `boolean` | No | Whether to include reimbursement inputs in the payroll. |
## Events
-| Event | Description | Data |
-| --- | --- | --- |
+| Event | Description | Data |
+| ------------------- | --------------------------------------------------------- | ------------------------- |
| `OFF_CYCLE_CREATED` | Fired when the off-cycle payroll is successfully created. | `{ payrollUuid: string }` |
diff --git a/docs/components/payroll/off-cycle-reason-selection.md b/docs/components/payroll/off-cycle-reason-selection.md
index 000ff2416..3ff551e76 100644
--- a/docs/components/payroll/off-cycle-reason-selection.md
+++ b/docs/components/payroll/off-cycle-reason-selection.md
@@ -24,13 +24,13 @@ function MyComponent() {
## Props
-| Name | Type | Required | Description |
-| --- | --- | --- | --- |
-| `companyId` | `string` | Yes | The associated company identifier. |
-| `onEvent` | `(eventType: string, data?: unknown) => void` | Yes | Callback invoked when events are emitted. |
+| Name | Type | Required | Description |
+| ----------- | --------------------------------------------- | -------- | ----------------------------------------- |
+| `companyId` | `string` | Yes | The associated company identifier. |
+| `onEvent` | `(eventType: string, data?: unknown) => void` | Yes | Callback invoked when events are emitted. |
## Events
-| Event | Description | Data |
-| --- | --- | --- |
+| Event | Description | Data |
+| ------------------------- | --------------------------------------------------------------- | -------------------------------------- |
| `OFF_CYCLE_SELECT_REASON` | Fired when the user selects a reason for the off-cycle payroll. | `{ reason: string, defaults: object }` |
diff --git a/docs/components/payroll/payroll-blocker.md b/docs/components/payroll/payroll-blocker.md
index 837f2b6db..6e04b646d 100644
--- a/docs/components/payroll/payroll-blocker.md
+++ b/docs/components/payroll/payroll-blocker.md
@@ -24,11 +24,11 @@ function MyComponent() {
## Props
-| Name | Type | Required | Description |
-| --- | --- | --- | --- |
-| `companyId` | `string` | Yes | The associated company identifier. |
-| `onEvent` | `(eventType: string, data?: unknown) => void` | Yes | Callback invoked when events are emitted. |
-| `dictionary` | `object` | No | Custom label overrides for UI text. |
+| Name | Type | Required | Description |
+| ------------ | --------------------------------------------- | -------- | ----------------------------------------- |
+| `companyId` | `string` | Yes | The associated company identifier. |
+| `onEvent` | `(eventType: string, data?: unknown) => void` | Yes | Callback invoked when events are emitted. |
+| `dictionary` | `object` | No | Custom label overrides for UI text. |
## Events
diff --git a/docs/components/payroll/payroll-configuration.md b/docs/components/payroll/payroll-configuration.md
index 435924fb6..a3d3bb0b8 100644
--- a/docs/components/payroll/payroll-configuration.md
+++ b/docs/components/payroll/payroll-configuration.md
@@ -25,24 +25,24 @@ function MyComponent() {
## Props
-| Name | Type | Required | Description |
-| --- | --- | --- | --- |
-| `companyId` | `string` | Yes | The associated company identifier. |
-| `payrollId` | `string` | Yes | The payroll identifier to configure. |
-| `onEvent` | `(eventType: string, data?: unknown) => void` | Yes | Callback invoked when events are emitted. |
-| `alerts` | `ReactNode` | No | Optional alert content to display above the configuration form. |
-| `withReimbursements` | `boolean` | No | Whether to include reimbursement inputs. |
-| `dictionary` | `object` | No | Custom label overrides for UI text. |
+| Name | Type | Required | Description |
+| -------------------- | --------------------------------------------- | -------- | --------------------------------------------------------------- |
+| `companyId` | `string` | Yes | The associated company identifier. |
+| `payrollId` | `string` | Yes | The payroll identifier to configure. |
+| `onEvent` | `(eventType: string, data?: unknown) => void` | Yes | Callback invoked when events are emitted. |
+| `alerts` | `ReactNode` | No | Optional alert content to display above the configuration form. |
+| `withReimbursements` | `boolean` | No | Whether to include reimbursement inputs. |
+| `dictionary` | `object` | No | Custom label overrides for UI text. |
## Events
-| Event | Description | Data |
-| --- | --- | --- |
-| `RUN_PAYROLL_EMPLOYEE_EDIT` | Fired when user clicks to edit an employee's compensation. | `{ employeeId: string, firstName: string, lastName: string }` |
-| `RUN_PAYROLL_EMPLOYEE_SKIP` | Fired when user toggles an employee's excluded status. | `{ employeeId: string }` |
-| `RUN_PAYROLL_EMPLOYEE_SAVED` | Fired after an employee compensation update is saved. | `{ payrollPrepared: object }` |
-| `RUN_PAYROLL_CALCULATED` | Fired when payroll calculation completes successfully. | `{ payrollId: string, alert: object, payPeriod: object }` |
-| `RUN_PAYROLL_PROCESSING_FAILED` | Fired when payroll calculation fails or times out. | None |
-| `RUN_PAYROLL_BLOCKERS_VIEW_ALL` | Fired when user clicks to view all payroll blockers. | None |
-| `RUN_PAYROLL_GROSS_UP_SELECTED` | Fired when user selects an employee for gross-up calculation. | `{ employeeUuid: string }` |
-| `RUN_PAYROLL_GROSS_UP_CALCULATED` | Fired when a gross-up calculation completes. | `{ grossUp: string, netPay: number, employeeUuid: string }` |
+| Event | Description | Data |
+| --------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- |
+| `RUN_PAYROLL_EMPLOYEE_EDIT` | Fired when user clicks to edit an employee's compensation. | `{ employeeId: string, firstName: string, lastName: string }` |
+| `RUN_PAYROLL_EMPLOYEE_SKIP` | Fired when user toggles an employee's excluded status. | `{ employeeId: string }` |
+| `RUN_PAYROLL_EMPLOYEE_SAVED` | Fired after an employee compensation update is saved. | `{ payrollPrepared: object }` |
+| `RUN_PAYROLL_CALCULATED` | Fired when payroll calculation completes successfully. | `{ payrollId: string, alert: object, payPeriod: object }` |
+| `RUN_PAYROLL_PROCESSING_FAILED` | Fired when payroll calculation fails or times out. | None |
+| `RUN_PAYROLL_BLOCKERS_VIEW_ALL` | Fired when user clicks to view all payroll blockers. | None |
+| `RUN_PAYROLL_GROSS_UP_SELECTED` | Fired when user selects an employee for gross-up calculation. | `{ employeeUuid: string }` |
+| `RUN_PAYROLL_GROSS_UP_CALCULATED` | Fired when a gross-up calculation completes. | `{ grossUp: string, netPay: number, employeeUuid: string }` |
diff --git a/docs/components/payroll/payroll-edit-employee.md b/docs/components/payroll/payroll-edit-employee.md
index cfa62a28f..a69d1f968 100644
--- a/docs/components/payroll/payroll-edit-employee.md
+++ b/docs/components/payroll/payroll-edit-employee.md
@@ -26,18 +26,18 @@ function MyComponent() {
## Props
-| Name | Type | Required | Description |
-| --- | --- | --- | --- |
-| `employeeId` | `string` | Yes | The employee identifier. |
-| `companyId` | `string` | Yes | The associated company identifier. |
-| `payrollId` | `string` | Yes | The payroll identifier. |
-| `onEvent` | `(eventType: string, data?: unknown) => void` | Yes | Callback invoked when events are emitted. |
-| `withReimbursements` | `boolean` | No | Whether to include reimbursement inputs. |
-| `dictionary` | `object` | No | Custom label overrides for UI text. |
+| Name | Type | Required | Description |
+| -------------------- | --------------------------------------------- | -------- | ----------------------------------------- |
+| `employeeId` | `string` | Yes | The employee identifier. |
+| `companyId` | `string` | Yes | The associated company identifier. |
+| `payrollId` | `string` | Yes | The payroll identifier. |
+| `onEvent` | `(eventType: string, data?: unknown) => void` | Yes | Callback invoked when events are emitted. |
+| `withReimbursements` | `boolean` | No | Whether to include reimbursement inputs. |
+| `dictionary` | `object` | No | Custom label overrides for UI text. |
## Events
-| Event | Description | Data |
-| --- | --- | --- |
-| `RUN_PAYROLL_EMPLOYEE_SAVED` | Fired after the employee's compensation is saved. | `{ payrollPrepared: object, employee: object }` |
-| `RUN_PAYROLL_EMPLOYEE_CANCELLED` | Fired when the user cancels editing. | None |
+| Event | Description | Data |
+| -------------------------------- | ------------------------------------------------- | ----------------------------------------------- |
+| `RUN_PAYROLL_EMPLOYEE_SAVED` | Fired after the employee's compensation is saved. | `{ payrollPrepared: object, employee: object }` |
+| `RUN_PAYROLL_EMPLOYEE_CANCELLED` | Fired when the user cancels editing. | None |
diff --git a/docs/components/payroll/payroll-execution-flow.md b/docs/components/payroll/payroll-execution-flow.md
index 476f08f9d..dcce4dff8 100644
--- a/docs/components/payroll/payroll-execution-flow.md
+++ b/docs/components/payroll/payroll-execution-flow.md
@@ -25,15 +25,15 @@ function MyApp() {
## Props
-| Name | Type | Required | Description |
-| --- | --- | --- | --- |
-| `companyId` | `string` | Yes | The associated company identifier. |
-| `payrollId` | `string` | Yes | The payroll identifier to execute. |
-| `onEvent` | `(eventType: string, data?: unknown) => void` | Yes | Callback invoked when events are emitted. Receives events from all subcomponents. |
-| `initialState` | `'configuration' \| 'overview'` | No | Which step of the execution flow to start on. Defaults to `'configuration'`. |
-| `initialPayPeriod` | `object` | No | Initial pay period to use when starting the flow. |
-| `withReimbursements` | `boolean` | No | Whether to include reimbursement inputs in the payroll. |
-| `ConfirmWireDetailsComponent` | `React.ComponentType` | No | Custom component to render for wire transfer confirmation. |
+| Name | Type | Required | Description |
+| ----------------------------- | --------------------------------------------- | -------- | --------------------------------------------------------------------------------- |
+| `companyId` | `string` | Yes | The associated company identifier. |
+| `payrollId` | `string` | Yes | The payroll identifier to execute. |
+| `onEvent` | `(eventType: string, data?: unknown) => void` | Yes | Callback invoked when events are emitted. Receives events from all subcomponents. |
+| `initialState` | `'configuration' \| 'overview'` | No | Which step of the execution flow to start on. Defaults to `'configuration'`. |
+| `initialPayPeriod` | `object` | No | Initial pay period to use when starting the flow. |
+| `withReimbursements` | `boolean` | No | Whether to include reimbursement inputs in the payroll. |
+| `ConfirmWireDetailsComponent` | `React.ComponentType` | No | Custom component to render for wire transfer confirmation. |
## Events
diff --git a/docs/components/payroll/payroll-flow.md b/docs/components/payroll/payroll-flow.md
index e667ce24c..6c8d875b5 100644
--- a/docs/components/payroll/payroll-flow.md
+++ b/docs/components/payroll/payroll-flow.md
@@ -24,28 +24,28 @@ function MyApp() {
## Props
-| Name | Type | Required | Description |
-| --- | --- | --- | --- |
-| `companyId` | `string` | Yes | The associated company identifier. |
-| `onEvent` | `(eventType: string, data?: unknown) => void` | Yes | Callback invoked when events are emitted. Receives events from all subcomponents. |
-| `withReimbursements` | `boolean` | No | Whether to include reimbursement inputs in the payroll. Defaults to `true`. |
-| `defaultValues` | `object` | No | Default values for individual flow step components. |
-| `dictionary` | `object` | No | Custom label overrides for UI text within payroll components. |
-| `ConfirmWireDetailsComponent` | `React.ComponentType` | No | Custom component to render for wire transfer confirmation. |
+| Name | Type | Required | Description |
+| ----------------------------- | --------------------------------------------- | -------- | --------------------------------------------------------------------------------- |
+| `companyId` | `string` | Yes | The associated company identifier. |
+| `onEvent` | `(eventType: string, data?: unknown) => void` | Yes | Callback invoked when events are emitted. Receives events from all subcomponents. |
+| `withReimbursements` | `boolean` | No | Whether to include reimbursement inputs in the payroll. Defaults to `true`. |
+| `defaultValues` | `object` | No | Default values for individual flow step components. |
+| `dictionary` | `object` | No | Custom label overrides for UI text within payroll components. |
+| `ConfirmWireDetailsComponent` | `React.ComponentType` | No | Custom component to render for wire transfer confirmation. |
## Events
-| Event | Description | Data |
-| --- | --- | --- |
-| `RUN_PAYROLL_SELECTED` | Fired when a payroll is selected to run. | None |
-| `RUN_PAYROLL_CALCULATED` | Fired when payroll calculations are complete. | None |
-| `RUN_PAYROLL_EDIT` | Fired when the user enters edit mode for a payroll. | None |
-| `RUN_PAYROLL_EMPLOYEE_EDIT` | Fired when an employee's payroll details are opened for editing. | None |
-| `RUN_PAYROLL_EMPLOYEE_SAVED` | Fired when an employee's payroll edits are saved. | None |
-| `RUN_PAYROLL_EMPLOYEE_CANCELLED` | Fired when employee payroll editing is cancelled. | None |
-| `RUN_PAYROLL_SUBMITTED` | Fired when the payroll is submitted for processing. | None |
-| `RUN_PAYROLL_PROCESSED` | Fired when the payroll has been successfully processed. | None |
-| `RUN_PAYROLL_PROCESSING_FAILED` | Fired when payroll processing fails. | None |
-| `RUN_PAYROLL_CANCELLED` | Fired when the payroll is cancelled. | None |
-| `RUN_PAYROLL_SUMMARY_VIEWED` | Fired when the payroll summary is viewed. | None |
-| `RUN_PAYROLL_RECEIPT_VIEWED` | Fired when a payroll receipt is viewed. | None |
+| Event | Description | Data |
+| -------------------------------- | ---------------------------------------------------------------- | ---- |
+| `RUN_PAYROLL_SELECTED` | Fired when a payroll is selected to run. | None |
+| `RUN_PAYROLL_CALCULATED` | Fired when payroll calculations are complete. | None |
+| `RUN_PAYROLL_EDIT` | Fired when the user enters edit mode for a payroll. | None |
+| `RUN_PAYROLL_EMPLOYEE_EDIT` | Fired when an employee's payroll details are opened for editing. | None |
+| `RUN_PAYROLL_EMPLOYEE_SAVED` | Fired when an employee's payroll edits are saved. | None |
+| `RUN_PAYROLL_EMPLOYEE_CANCELLED` | Fired when employee payroll editing is cancelled. | None |
+| `RUN_PAYROLL_SUBMITTED` | Fired when the payroll is submitted for processing. | None |
+| `RUN_PAYROLL_PROCESSED` | Fired when the payroll has been successfully processed. | None |
+| `RUN_PAYROLL_PROCESSING_FAILED` | Fired when payroll processing fails. | None |
+| `RUN_PAYROLL_CANCELLED` | Fired when the payroll is cancelled. | None |
+| `RUN_PAYROLL_SUMMARY_VIEWED` | Fired when the payroll summary is viewed. | None |
+| `RUN_PAYROLL_RECEIPT_VIEWED` | Fired when a payroll receipt is viewed. | None |
diff --git a/docs/components/payroll/payroll-history.md b/docs/components/payroll/payroll-history.md
index 8f97f140c..13fe06e18 100644
--- a/docs/components/payroll/payroll-history.md
+++ b/docs/components/payroll/payroll-history.md
@@ -24,16 +24,16 @@ function MyComponent() {
## Props
-| Name | Type | Required | Description |
-| --- | --- | --- | --- |
-| `companyId` | `string` | Yes | The associated company identifier. |
-| `onEvent` | `(eventType: string, data?: unknown) => void` | Yes | Callback invoked when events are emitted. |
-| `dictionary` | `object` | No | Custom label overrides for UI text. |
+| Name | Type | Required | Description |
+| ------------ | --------------------------------------------- | -------- | ----------------------------------------- |
+| `companyId` | `string` | Yes | The associated company identifier. |
+| `onEvent` | `(eventType: string, data?: unknown) => void` | Yes | Callback invoked when events are emitted. |
+| `dictionary` | `object` | No | Custom label overrides for UI text. |
## Events
-| Event | Description | Data |
-| --- | --- | --- |
+| Event | Description | Data |
+| ---------------------------- | ----------------------------------------- | ---- |
| `RUN_PAYROLL_SUMMARY_VIEWED` | Fired when the payroll summary is viewed. | None |
-| `RUN_PAYROLL_RECEIPT_VIEWED` | Fired when a payroll receipt is viewed. | None |
-| `RUN_PAYROLL_CANCELLED` | Fired when a payroll is cancelled. | None |
+| `RUN_PAYROLL_RECEIPT_VIEWED` | Fired when a payroll receipt is viewed. | None |
+| `RUN_PAYROLL_CANCELLED` | Fired when a payroll is cancelled. | None |
diff --git a/docs/components/payroll/payroll-landing.md b/docs/components/payroll/payroll-landing.md
index 073d9b5a0..0d13dfff2 100644
--- a/docs/components/payroll/payroll-landing.md
+++ b/docs/components/payroll/payroll-landing.md
@@ -24,27 +24,27 @@ function MyComponent() {
## Props
-| Name | Type | Required | Description |
-| --- | --- | --- | --- |
-| `companyId` | `string` | Yes | The associated company identifier. |
-| `onEvent` | `(eventType: string, data?: unknown) => void` | Yes | Callback invoked when events are emitted. |
-| `withReimbursements` | `boolean` | No | Whether to include reimbursement inputs in the payroll. |
-| `showPayrollCancelledAlert` | `boolean` | No | Whether to display an alert indicating a payroll was cancelled. |
-| `dictionary` | `object` | No | Custom label overrides for UI text. |
-| `ConfirmWireDetailsComponent` | `React.ComponentType` | No | Custom component to render for wire transfer confirmation. |
+| Name | Type | Required | Description |
+| ----------------------------- | --------------------------------------------- | -------- | --------------------------------------------------------------- |
+| `companyId` | `string` | Yes | The associated company identifier. |
+| `onEvent` | `(eventType: string, data?: unknown) => void` | Yes | Callback invoked when events are emitted. |
+| `withReimbursements` | `boolean` | No | Whether to include reimbursement inputs in the payroll. |
+| `showPayrollCancelledAlert` | `boolean` | No | Whether to display an alert indicating a payroll was cancelled. |
+| `dictionary` | `object` | No | Custom label overrides for UI text. |
+| `ConfirmWireDetailsComponent` | `React.ComponentType` | No | Custom component to render for wire transfer confirmation. |
## Events
This flow component orchestrates several sub-components (PayrollList, PayrollHistory, PayrollOverview, PayrollReceipts) and forwards their events. The following events are handled internally for navigation between states:
-| Event | Description | Data |
-| --- | --- | --- |
-| `RUN_PAYROLL_SUMMARY_VIEWED` | Fired when user views a payroll summary from history. Navigates to the overview state. | `{ payrollId: string, startDate?: string, endDate?: string }` |
-| `RUN_PAYROLL_RECEIPT_VIEWED` | Fired when user views a payroll receipt from history. Navigates to the receipt state. | `{ payrollId: string, startDate?: string, endDate?: string }` |
-| `RUN_PAYROLL_RECEIPT_GET` | Fired from overview to navigate to the receipt state. | `{ payrollId: string }` |
-| `RUN_PAYROLL_BACK` | Fired to navigate back from overview or receipt to the previous state. | None |
-| `RUN_PAYROLL_CANCELLED` | Fired when a payroll is cancelled. Returns to the tabs state with a cancellation alert. | `{ payrollId: string, result: object }` |
-| `RUN_PAYROLL_CANCELLED_ALERT_DISMISSED` | Fired when the cancellation alert is dismissed. | None |
-| `RUN_PAYROLL_BLOCKERS_VIEW_ALL` | Fired when user clicks to view all payroll blockers. | None |
+| Event | Description | Data |
+| --------------------------------------- | --------------------------------------------------------------------------------------- | ------------------------------------------------------------- |
+| `RUN_PAYROLL_SUMMARY_VIEWED` | Fired when user views a payroll summary from history. Navigates to the overview state. | `{ payrollId: string, startDate?: string, endDate?: string }` |
+| `RUN_PAYROLL_RECEIPT_VIEWED` | Fired when user views a payroll receipt from history. Navigates to the receipt state. | `{ payrollId: string, startDate?: string, endDate?: string }` |
+| `RUN_PAYROLL_RECEIPT_GET` | Fired from overview to navigate to the receipt state. | `{ payrollId: string }` |
+| `RUN_PAYROLL_BACK` | Fired to navigate back from overview or receipt to the previous state. | None |
+| `RUN_PAYROLL_CANCELLED` | Fired when a payroll is cancelled. Returns to the tabs state with a cancellation alert. | `{ payrollId: string, result: object }` |
+| `RUN_PAYROLL_CANCELLED_ALERT_DISMISSED` | Fired when the cancellation alert is dismissed. | None |
+| `RUN_PAYROLL_BLOCKERS_VIEW_ALL` | Fired when user clicks to view all payroll blockers. | None |
Events from child components (e.g. `RUN_PAYROLL_SELECTED`, `RUN_OFF_CYCLE_PAYROLL` from PayrollList) are also forwarded through `onEvent`.
diff --git a/docs/components/payroll/payroll-list.md b/docs/components/payroll/payroll-list.md
index 169a44ca9..77aa0d6c1 100644
--- a/docs/components/payroll/payroll-list.md
+++ b/docs/components/payroll/payroll-list.md
@@ -24,17 +24,17 @@ function MyComponent() {
## Props
-| Name | Type | Required | Description |
-| --- | --- | --- | --- |
-| `companyId` | `string` | Yes | The associated company identifier. |
-| `onEvent` | `(eventType: string, data?: unknown) => void` | Yes | Callback invoked when events are emitted. |
-| `dictionary` | `object` | No | Custom label overrides for UI text. |
+| Name | Type | Required | Description |
+| ------------ | --------------------------------------------- | -------- | ----------------------------------------- |
+| `companyId` | `string` | Yes | The associated company identifier. |
+| `onEvent` | `(eventType: string, data?: unknown) => void` | Yes | Callback invoked when events are emitted. |
+| `dictionary` | `object` | No | Custom label overrides for UI text. |
## Events
-| Event | Description | Data |
-| --- | --- | --- |
-| `RUN_PAYROLL_SELECTED` | Fired when a payroll is selected to run. | None |
-| `REVIEW_PAYROLL` | Fired when the user selects a payroll to review. | None |
-| `PAYROLL_SKIPPED` | Fired when a payroll is skipped. | None |
-| `RUN_OFF_CYCLE_PAYROLL` | Fired when user initiates an off-cycle payroll. | None |
+| Event | Description | Data |
+| ----------------------- | ------------------------------------------------ | ---- |
+| `RUN_PAYROLL_SELECTED` | Fired when a payroll is selected to run. | None |
+| `REVIEW_PAYROLL` | Fired when the user selects a payroll to review. | None |
+| `PAYROLL_SKIPPED` | Fired when a payroll is skipped. | None |
+| `RUN_OFF_CYCLE_PAYROLL` | Fired when user initiates an off-cycle payroll. | None |
diff --git a/docs/components/payroll/payroll-overview.md b/docs/components/payroll/payroll-overview.md
index 8d4e13851..5995e1e98 100644
--- a/docs/components/payroll/payroll-overview.md
+++ b/docs/components/payroll/payroll-overview.md
@@ -25,24 +25,24 @@ function MyComponent() {
## Props
-| Name | Type | Required | Description |
-| --- | --- | --- | --- |
-| `companyId` | `string` | Yes | The associated company identifier. |
-| `payrollId` | `string` | Yes | The payroll identifier. |
-| `onEvent` | `(eventType: string, data?: unknown) => void` | Yes | Callback invoked when events are emitted. |
-| `alerts` | `array` | No | Optional array of alert objects to display. |
-| `withReimbursements` | `boolean` | No | Whether to include reimbursement details. |
-| `dictionary` | `object` | No | Custom label overrides for UI text. |
-| `ConfirmWireDetailsComponent` | `React.ComponentType` | No | Custom component to render for wire transfer confirmation. |
+| Name | Type | Required | Description |
+| ----------------------------- | --------------------------------------------- | -------- | ---------------------------------------------------------- |
+| `companyId` | `string` | Yes | The associated company identifier. |
+| `payrollId` | `string` | Yes | The payroll identifier. |
+| `onEvent` | `(eventType: string, data?: unknown) => void` | Yes | Callback invoked when events are emitted. |
+| `alerts` | `array` | No | Optional array of alert objects to display. |
+| `withReimbursements` | `boolean` | No | Whether to include reimbursement details. |
+| `dictionary` | `object` | No | Custom label overrides for UI text. |
+| `ConfirmWireDetailsComponent` | `React.ComponentType` | No | Custom component to render for wire transfer confirmation. |
## Events
-| Event | Description | Data |
-| --- | --- | --- |
-| `RUN_PAYROLL_EDIT` | Fired when user chooses to edit payroll. | None |
-| `RUN_PAYROLL_SUBMITTED` | Fired when payroll is successfully submitted. | API response |
-| `RUN_PAYROLL_PROCESSED` | Fired when payroll processing is completed. | None |
-| `RUN_PAYROLL_PROCESSING_FAILED` | Fired when payroll processing fails. | Error details |
-| `RUN_PAYROLL_CANCELLED` | Fired when a payroll is cancelled. | API response |
-| `RUN_PAYROLL_RECEIPT_GET` | Fired when user requests payroll receipt. | `{ payrollId: string }` |
-| `RUN_PAYROLL_PDF_PAYSTUB_VIEWED` | Fired when user views employee paystub PDF. | `{ employeeId: string }` |
+| Event | Description | Data |
+| -------------------------------- | --------------------------------------------- | ------------------------ |
+| `RUN_PAYROLL_EDIT` | Fired when user chooses to edit payroll. | None |
+| `RUN_PAYROLL_SUBMITTED` | Fired when payroll is successfully submitted. | API response |
+| `RUN_PAYROLL_PROCESSED` | Fired when payroll processing is completed. | None |
+| `RUN_PAYROLL_PROCESSING_FAILED` | Fired when payroll processing fails. | Error details |
+| `RUN_PAYROLL_CANCELLED` | Fired when a payroll is cancelled. | API response |
+| `RUN_PAYROLL_RECEIPT_GET` | Fired when user requests payroll receipt. | `{ payrollId: string }` |
+| `RUN_PAYROLL_PDF_PAYSTUB_VIEWED` | Fired when user views employee paystub PDF. | `{ employeeId: string }` |
diff --git a/docs/components/payroll/payroll-receipts.md b/docs/components/payroll/payroll-receipts.md
index 42fec6c87..56dbdfc4e 100644
--- a/docs/components/payroll/payroll-receipts.md
+++ b/docs/components/payroll/payroll-receipts.md
@@ -24,12 +24,12 @@ function MyComponent() {
## Props
-| Name | Type | Required | Description |
-| --- | --- | --- | --- |
-| `payrollId` | `string` | Yes | The payroll identifier. |
-| `onEvent` | `(eventType: string, data?: unknown) => void` | Yes | Callback invoked when events are emitted. |
-| `withReimbursements` | `boolean` | No | Whether to include reimbursement details. |
-| `dictionary` | `object` | No | Custom label overrides for UI text. |
+| Name | Type | Required | Description |
+| -------------------- | --------------------------------------------- | -------- | ----------------------------------------- |
+| `payrollId` | `string` | Yes | The payroll identifier. |
+| `onEvent` | `(eventType: string, data?: unknown) => void` | Yes | Callback invoked when events are emitted. |
+| `withReimbursements` | `boolean` | No | Whether to include reimbursement details. |
+| `dictionary` | `object` | No | Custom label overrides for UI text. |
## Events
diff --git a/docs/components/payroll/payroll.md b/docs/components/payroll/payroll.md
index 55b9e6ca3..9c720f507 100644
--- a/docs/components/payroll/payroll.md
+++ b/docs/components/payroll/payroll.md
@@ -7,29 +7,29 @@ The Payroll domain provides components for running payroll on Gusto's embedded p
## Flows
-| Component | Description |
-| --- | --- |
-| [Payroll.PayrollFlow](./payroll-flow.md) | End-to-end payroll workflow from landing through submission and receipts. |
+| Component | Description |
+| ----------------------------------------------------------- | ------------------------------------------------------------------------------------ |
+| [Payroll.PayrollFlow](./payroll-flow.md) | End-to-end payroll workflow from landing through submission and receipts. |
| [Payroll.PayrollExecutionFlow](./payroll-execution-flow.md) | Full payroll execution from configuration through submission for a specific payroll. |
-| [Payroll.OffCycleFlow](./off-cycle-flow.md) | Workflow for creating and running off-cycle payrolls such as bonuses. |
-| [Payroll.DismissalFlow](./dismissal-flow.md) | Workflow for processing dismissal (termination) payrolls. |
-| [Payroll.TransitionFlow](./transition-flow.md) | Workflow for creating transition payrolls when changing pay schedules. |
+| [Payroll.OffCycleFlow](./off-cycle-flow.md) | Workflow for creating and running off-cycle payrolls such as bonuses. |
+| [Payroll.DismissalFlow](./dismissal-flow.md) | Workflow for processing dismissal (termination) payrolls. |
+| [Payroll.TransitionFlow](./transition-flow.md) | Workflow for creating transition payrolls when changing pay schedules. |
## Blocks
-| Component | Description |
-| --- | --- |
-| [Payroll.PayrollLanding](./payroll-landing.md) | Landing page combining the payroll list with action options. |
-| [Payroll.PayrollList](./payroll-list.md) | Displays a list of payrolls for a company with status and actions. |
-| [Payroll.PayrollHistory](./payroll-history.md) | Displays historical payroll runs with summary and receipt access. |
-| [Payroll.PayrollConfiguration](./payroll-configuration.md) | Payroll preparation step for configuring employee hours, earnings, and deductions. |
-| [Payroll.PayrollEditEmployee](./payroll-edit-employee.md) | Form for editing an individual employee's payroll details. |
-| [Payroll.PayrollOverview](./payroll-overview.md) | Review and submission step showing payroll totals and confirmation. |
-| [Payroll.PayrollReceipts](./payroll-receipts.md) | Displays payroll receipts and payment details after submission. |
-| [Payroll.PayrollBlockerList](./payroll-blocker.md) | Displays blocking issues that must be resolved before running payroll. |
-| [Payroll.ConfirmWireDetails](./confirm-wire-details.md) | Wire transfer confirmation step for verifying payment details. |
-| [Payroll.OffCycleCreation](./off-cycle-creation.md) | Form for creating an off-cycle payroll with type and employee selection. |
-| [Payroll.OffCycleDeductionsSetting](./off-cycle-deductions-setting.md) | Configuration for deductions in off-cycle payrolls. |
-| [Payroll.OffCycleReasonSelection](./off-cycle-reason-selection.md) | Selection of the reason for running an off-cycle payroll. |
-| [Payroll.TransitionCreation](./transition-creation.md) | Form for creating a transition payroll when changing pay schedules. |
-| [Payroll.RecoveryCases](./recovery-cases.md) | Displays and manages payroll recovery cases requiring action. |
+| Component | Description |
+| ---------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
+| [Payroll.PayrollLanding](./payroll-landing.md) | Landing page combining the payroll list with action options. |
+| [Payroll.PayrollList](./payroll-list.md) | Displays a list of payrolls for a company with status and actions. |
+| [Payroll.PayrollHistory](./payroll-history.md) | Displays historical payroll runs with summary and receipt access. |
+| [Payroll.PayrollConfiguration](./payroll-configuration.md) | Payroll preparation step for configuring employee hours, earnings, and deductions. |
+| [Payroll.PayrollEditEmployee](./payroll-edit-employee.md) | Form for editing an individual employee's payroll details. |
+| [Payroll.PayrollOverview](./payroll-overview.md) | Review and submission step showing payroll totals and confirmation. |
+| [Payroll.PayrollReceipts](./payroll-receipts.md) | Displays payroll receipts and payment details after submission. |
+| [Payroll.PayrollBlockerList](./payroll-blocker.md) | Displays blocking issues that must be resolved before running payroll. |
+| [Payroll.ConfirmWireDetails](./confirm-wire-details.md) | Wire transfer confirmation step for verifying payment details. |
+| [Payroll.OffCycleCreation](./off-cycle-creation.md) | Form for creating an off-cycle payroll with type and employee selection. |
+| [Payroll.OffCycleDeductionsSetting](./off-cycle-deductions-setting.md) | Configuration for deductions in off-cycle payrolls. |
+| [Payroll.OffCycleReasonSelection](./off-cycle-reason-selection.md) | Selection of the reason for running an off-cycle payroll. |
+| [Payroll.TransitionCreation](./transition-creation.md) | Form for creating a transition payroll when changing pay schedules. |
+| [Payroll.RecoveryCases](./recovery-cases.md) | Displays and manages payroll recovery cases requiring action. |
diff --git a/docs/components/payroll/recovery-cases.md b/docs/components/payroll/recovery-cases.md
index 7519be62b..57ab13675 100644
--- a/docs/components/payroll/recovery-cases.md
+++ b/docs/components/payroll/recovery-cases.md
@@ -24,16 +24,16 @@ function MyComponent() {
## Props
-| Name | Type | Required | Description |
-| --- | --- | --- | --- |
-| `companyId` | `string` | Yes | The associated company identifier. |
-| `onEvent` | `(eventType: string, data?: unknown) => void` | No | Callback invoked when events are emitted. |
+| Name | Type | Required | Description |
+| ----------- | --------------------------------------------- | -------- | ----------------------------------------- |
+| `companyId` | `string` | Yes | The associated company identifier. |
+| `onEvent` | `(eventType: string, data?: unknown) => void` | No | Callback invoked when events are emitted. |
## Events
-| Event | Description | Data |
-| --- | --- | --- |
-| `RECOVERY_CASE_RESOLVE` | Fired when a recovery case is resolved. | None |
-| `RECOVERY_CASE_RESUBMIT` | Fired when a recovery case is resubmitted. | None |
-| `RECOVERY_CASE_RESUBMIT_DONE` | Fired when a recovery case resubmission is complete. | None |
+| Event | Description | Data |
+| ------------------------------- | ----------------------------------------------------- | ---- |
+| `RECOVERY_CASE_RESOLVE` | Fired when a recovery case is resolved. | None |
+| `RECOVERY_CASE_RESUBMIT` | Fired when a recovery case is resubmitted. | None |
+| `RECOVERY_CASE_RESUBMIT_DONE` | Fired when a recovery case resubmission is complete. | None |
| `RECOVERY_CASE_RESUBMIT_CANCEL` | Fired when a recovery case resubmission is cancelled. | None |
diff --git a/docs/components/payroll/transition-creation.md b/docs/components/payroll/transition-creation.md
index 1a835a637..eab32e5fe 100644
--- a/docs/components/payroll/transition-creation.md
+++ b/docs/components/payroll/transition-creation.md
@@ -27,16 +27,16 @@ function MyComponent() {
## Props
-| Name | Type | Required | Description |
-| --- | --- | --- | --- |
-| `companyId` | `string` | Yes | The associated company identifier. |
-| `startDate` | `string` | Yes | The start date of the transition period (ISO 8601 format). |
-| `endDate` | `string` | Yes | The end date of the transition period (ISO 8601 format). |
-| `payScheduleUuid` | `string` | Yes | The pay schedule identifier for the transition. |
-| `onEvent` | `(eventType: string, data?: unknown) => void` | Yes | Callback invoked when events are emitted. |
+| Name | Type | Required | Description |
+| ----------------- | --------------------------------------------- | -------- | ---------------------------------------------------------- |
+| `companyId` | `string` | Yes | The associated company identifier. |
+| `startDate` | `string` | Yes | The start date of the transition period (ISO 8601 format). |
+| `endDate` | `string` | Yes | The end date of the transition period (ISO 8601 format). |
+| `payScheduleUuid` | `string` | Yes | The pay schedule identifier for the transition. |
+| `onEvent` | `(eventType: string, data?: unknown) => void` | Yes | Callback invoked when events are emitted. |
## Events
-| Event | Description | Data |
-| --- | --- | --- |
+| Event | Description | Data |
+| -------------------- | ---------------------------------------------------------- | ---- |
| `TRANSITION_CREATED` | Fired when the transition payroll is successfully created. | None |
diff --git a/docs/components/payroll/transition-flow.md b/docs/components/payroll/transition-flow.md
index dda912c22..12cb048cc 100644
--- a/docs/components/payroll/transition-flow.md
+++ b/docs/components/payroll/transition-flow.md
@@ -27,16 +27,16 @@ function MyApp() {
## Props
-| Name | Type | Required | Description |
-| --- | --- | --- | --- |
-| `companyId` | `string` | Yes | The associated company identifier. |
-| `startDate` | `string` | Yes | The start date of the transition period (ISO 8601 format). |
-| `endDate` | `string` | Yes | The end date of the transition period (ISO 8601 format). |
-| `payScheduleUuid` | `string` | Yes | The pay schedule identifier for the transition. |
-| `onEvent` | `(eventType: string, data?: unknown) => void` | Yes | Callback invoked when events are emitted. Receives events from all subcomponents. |
+| Name | Type | Required | Description |
+| ----------------- | --------------------------------------------- | -------- | --------------------------------------------------------------------------------- |
+| `companyId` | `string` | Yes | The associated company identifier. |
+| `startDate` | `string` | Yes | The start date of the transition period (ISO 8601 format). |
+| `endDate` | `string` | Yes | The end date of the transition period (ISO 8601 format). |
+| `payScheduleUuid` | `string` | Yes | The pay schedule identifier for the transition. |
+| `onEvent` | `(eventType: string, data?: unknown) => void` | Yes | Callback invoked when events are emitted. Receives events from all subcomponents. |
## Events
-| Event | Description | Data |
-| --- | --- | --- |
+| Event | Description | Data |
+| -------------------- | ---------------------------------------------------------- | ---- |
| `TRANSITION_CREATED` | Fired when the transition payroll is successfully created. | None |
diff --git a/docs/concepts/authentication-and-proxy.md b/docs/concepts/authentication-and-proxy.md
index 82c13dc9a..47eaa2388 100644
--- a/docs/concepts/authentication-and-proxy.md
+++ b/docs/concepts/authentication-and-proxy.md
@@ -23,11 +23,7 @@ import { GustoProvider } from '@gusto/embedded-react-sdk'
import '@gusto/embedded-react-sdk/style.css'
function App({ children }) {
- return (
-
- {children}
-
- )
+ return {children}
}
```
@@ -128,8 +124,8 @@ Look up the components your app uses, substitute `:param` placeholders with sess
The tighter you resolve URL parameters, the more restrictive the allowlist:
-| What you resolve | Use case |
-| --- | --- |
-| Nothing | Generic allowlisting, no user scoping |
-| `:companyId` only | Admin who can access any employee in their company |
+| What you resolve | Use case |
+| ---------------------------- | --------------------------------------------------- |
+| Nothing | Generic allowlisting, no user scoping |
+| `:companyId` only | Admin who can access any employee in their company |
| `:companyId` + `:employeeId` | Self-service employee, restricted to their own data |
diff --git a/docs/concepts/composition.md b/docs/concepts/composition.md
index 026580f3e..ffce88a70 100644
--- a/docs/concepts/composition.md
+++ b/docs/concepts/composition.md
@@ -43,7 +43,7 @@ function App({ employeeId, startDate }) {
{
+ onEvent={eventType => {
if (eventType === 'employee/compensations/done') {
// Navigate to your next step
}
@@ -78,7 +78,7 @@ function ProfileStep({ companyId, employeeId }) {
{
+ onEvent={eventType => {
if (eventType === componentEvents.EMPLOYEE_PROFILE_DONE) {
navigate('/onboarding/taxes')
}
@@ -93,7 +93,7 @@ function TaxesStep({ employeeId }) {
return (
{
+ onEvent={eventType => {
if (eventType === componentEvents.EMPLOYEE_TAXES_DONE) {
navigate('/onboarding/payment')
}
@@ -110,10 +110,7 @@ function OnboardingApp({ companyId, employeeId }) {
path="/onboarding/profile"
element={}
/>
- }
- />
+ } />
{/* Additional steps... */}
diff --git a/docs/concepts/error-handling.md b/docs/concepts/error-handling.md
index 43d4b078a..1fb6214e2 100644
--- a/docs/concepts/error-handling.md
+++ b/docs/concepts/error-handling.md
@@ -19,12 +19,12 @@ interface SDKError {
}
```
-| Category | Description | Examples |
-| --- | --- | --- |
-| `api_error` | HTTP error from the Gusto API | 422 validation errors, 404 not found, 409 conflict |
-| `validation_error` | Client-side Zod schema failure | Request or response failed Zod validation |
-| `network_error` | Network connectivity failure | Connection refused, timeout, request aborted |
-| `internal_error` | Unexpected runtime error | Unhandled exceptions, initialization failures |
+| Category | Description | Examples |
+| ------------------ | ------------------------------ | -------------------------------------------------- |
+| `api_error` | HTTP error from the Gusto API | 422 validation errors, 404 not found, 409 conflict |
+| `validation_error` | Client-side Zod schema failure | Request or response failed Zod validation |
+| `network_error` | Network connectivity failure | Connection refused, timeout, request aborted |
+| `internal_error` | Unexpected runtime error | Unhandled exceptions, initialization failures |
### Field errors
@@ -68,7 +68,7 @@ import { GustoProvider } from '@gusto/embedded-react-sdk'
import type { ObservabilityHook } from '@gusto/embedded-react-sdk'
const observability: ObservabilityHook = {
- onError: (error) => {
+ onError: error => {
Sentry.captureException(error.raw ?? new Error(error.message), {
tags: {
error_category: error.category,
@@ -77,7 +77,7 @@ const observability: ObservabilityHook = {
},
})
},
- onMetric: (metric) => {
+ onMetric: metric => {
if (metric.unit === 'ms') {
datadogRum.addTiming(metric.name, metric.value)
}
@@ -118,7 +118,7 @@ Configure sanitization behavior:
```tsx
const observability: ObservabilityHook = {
- onError: (error) => errorTracker.capture(error),
+ onError: error => errorTracker.capture(error),
sanitization: {
enabled: true,
includeRawError: false,
diff --git a/docs/concepts/events.md b/docs/concepts/events.md
index 966107e88..bee6a8831 100644
--- a/docs/concepts/events.md
+++ b/docs/concepts/events.md
@@ -37,11 +37,7 @@ function App({ companyId, employeeId }) {
return (
-
+
)
}
@@ -61,214 +57,214 @@ function App({ companyId, employeeId }) {
All events emitted by SDK components are listed below. Import `componentEvents` and use the Key as the property name.
-| Key | Value |
-| --- | --- |
-| `BREADCRUMB_NAVIGATE` | `breadcrumb/navigate` |
-| `CANCEL` | `CANCEL` |
-| `COMPANY_ASSIGN_SIGNATORY_DONE` | `company/signatory/assignSignatory/done` |
-| `COMPANY_ASSIGN_SIGNATORY_MODE_UPDATED` | `company/signatory/assignSignatory/modeUpdated` |
-| `COMPANY_BANK_ACCOUNT_CANCEL` | `company/bankAccount/cancel` |
-| `COMPANY_BANK_ACCOUNT_CHANGE` | `company/bankAccount/change` |
-| `COMPANY_BANK_ACCOUNT_CREATED` | `company/bankAccount/created` |
-| `COMPANY_BANK_ACCOUNT_DONE` | `company/bankAccount/done` |
-| `COMPANY_BANK_ACCOUNT_VERIFIED` | `company/bankAccount/verified` |
-| `COMPANY_BANK_ACCOUNT_VERIFY` | `company/bankAccount/verify` |
-| `COMPANY_CREATE_SIGNATORY_DONE` | `company/signatory/createSignatory/done` |
-| `COMPANY_FEDERAL_TAXES_DONE` | `company/federalTaxes/done` |
-| `COMPANY_FEDERAL_TAXES_UPDATED` | `company/federalTaxes/updated` |
-| `COMPANY_FORM_EDIT_SIGNATORY` | `company/forms/editSignatory` |
-| `COMPANY_FORMS_DONE` | `company/forms/done` |
-| `COMPANY_INDUSTRY` | `company/industry` |
-| `COMPANY_INDUSTRY_SELECTED` | `company/industry/selected` |
-| `COMPANY_INVITE_SIGNATORY_DONE` | `company/signatory/inviteSignatory/done` |
-| `COMPANY_LOCATION_CREATE` | `company/location/add` |
-| `COMPANY_LOCATION_CREATED` | `company/location/add/done` |
-| `COMPANY_LOCATION_DONE` | `company/location/done` |
-| `COMPANY_LOCATION_EDIT` | `company/location/edit` |
-| `COMPANY_LOCATION_UPDATED` | `company/location/edit/done` |
-| `COMPANY_OVERVIEW_CONTINUE` | `company/overview/continue` |
-| `COMPANY_OVERVIEW_DONE` | `company/overview/done` |
-| `COMPANY_SIGN_FORM` | `company/forms/sign/signForm` |
-| `COMPANY_SIGN_FORM_BACK` | `company/forms/sign/back` |
-| `COMPANY_SIGN_FORM_DONE` | `company/forms/sign/done` |
-| `COMPANY_SIGNATORY_CREATED` | `company/signatory/created` |
-| `COMPANY_SIGNATORY_INVITED` | `company/signatory/invited` |
-| `COMPANY_SIGNATORY_UPDATED` | `company/signatory/updated` |
-| `COMPANY_STATE_TAX_DONE` | `company/stateTaxes/done` |
-| `COMPANY_STATE_TAX_EDIT` | `company/stateTaxes/edit` |
-| `COMPANY_STATE_TAX_UPDATED` | `company/stateTaxes/updated` |
-| `COMPANY_VIEW_FORM_TO_SIGN` | `company/forms/view` |
-| `CONTRACTOR_ADDRESS_DONE` | `contractor/address/done` |
-| `CONTRACTOR_ADDRESS_UPDATED` | `contractor/address/updated` |
-| `CONTRACTOR_BANK_ACCOUNT_CREATED` | `contractor/bankAccount/created` |
-| `CONTRACTOR_CREATE` | `contractor/create` |
-| `CONTRACTOR_CREATED` | `contractor/created` |
-| `CONTRACTOR_DELETED` | `contractor/deleted` |
-| `CONTRACTOR_INVITE_CONTRACTOR` | `contractor/invite/selfOnboarding` |
-| `CONTRACTOR_NEW_HIRE_REPORT_DONE` | `contractor/newHireReport/done` |
-| `CONTRACTOR_NEW_HIRE_REPORT_UPDATED` | `contractor/newHireReport/updated` |
-| `CONTRACTOR_ONBOARDING_CONTINUE` | `contractor/onboarding/continue` |
-| `CONTRACTOR_ONBOARDING_STATUS_UPDATED` | `contractor/onboardingStatus/updated` |
-| `CONTRACTOR_PAYMENT_BACK_TO_EDIT` | `contractor/payments/backToEdit` |
-| `CONTRACTOR_PAYMENT_CANCEL` | `contractor/payments/cancel` |
-| `CONTRACTOR_PAYMENT_CREATE` | `contractor/payments/create` |
-| `CONTRACTOR_PAYMENT_CREATED` | `contractor/payments/created` |
-| `CONTRACTOR_PAYMENT_EDIT` | `contractor/payments/edit` |
-| `CONTRACTOR_PAYMENT_EXIT` | `contractor/payments/exit` |
-| `CONTRACTOR_PAYMENT_METHOD_DONE` | `contractor/paymentMethod/done` |
-| `CONTRACTOR_PAYMENT_METHOD_UPDATED` | `contractor/paymentMethod/updated` |
-| `CONTRACTOR_PAYMENT_PREVIEW` | `contractor/payments/preview` |
-| `CONTRACTOR_PAYMENT_RFI_RESPOND` | `contractor/payments/rfi/respond` |
-| `CONTRACTOR_PAYMENT_SUBMIT` | `contractor/payments/submit` |
-| `CONTRACTOR_PAYMENT_UPDATE` | `contractor/payments/update` |
-| `CONTRACTOR_PAYMENT_VIEW` | `contractor/payments/view` |
-| `CONTRACTOR_PAYMENT_VIEW_DETAILS` | `contractor/payments/view/details` |
-| `CONTRACTOR_PROFILE_DONE` | `contractor/profile/done` |
-| `CONTRACTOR_SUBMIT_DONE` | `contractor/submit/done` |
-| `CONTRACTOR_UPDATE` | `contractor/update` |
-| `CONTRACTOR_UPDATED` | `contractor/updated` |
-| `DISMISSAL_PAY_PERIOD_SELECTED` | `dismissal/payPeriod/selected` |
-| `EMPLOYEE_BANK_ACCOUNT_CREATE` | `employee/bankAccount/create` |
-| `EMPLOYEE_BANK_ACCOUNT_CREATED` | `employee/bankAccount/created` |
-| `EMPLOYEE_BANK_ACCOUNT_DELETED` | `employee/bankAccount/deleted` |
-| `EMPLOYEE_CHANGE_ELIGIBILITY_STATUS` | `employee/employmentEligibility/change` |
-| `EMPLOYEE_COMPENSATION_CREATE` | `employee/compensations/create` |
-| `EMPLOYEE_COMPENSATION_CREATED` | `employee/compensations/created` |
-| `EMPLOYEE_COMPENSATION_DONE` | `employee/compensations/done` |
-| `EMPLOYEE_COMPENSATION_UPDATED` | `employee/compensations/updated` |
-| `EMPLOYEE_CREATE` | `employee/create` |
-| `EMPLOYEE_CREATED` | `employee/created` |
-| `EMPLOYEE_DEDUCTION_ADD` | `employee/deductions/add` |
-| `EMPLOYEE_DEDUCTION_CANCEL` | `employee/deductions/cancel` |
-| `EMPLOYEE_DEDUCTION_CANCEL_EMPTY` | `employee/deductions/cancelEmpty` |
-| `EMPLOYEE_DEDUCTION_CREATED` | `employee/deductions/created` |
-| `EMPLOYEE_DEDUCTION_DELETED` | `employee/deductions/deleted` |
-| `EMPLOYEE_DEDUCTION_DELETED_EMPTY` | `employee/deductions/deletedEmpty` |
-| `EMPLOYEE_DEDUCTION_DONE` | `employee/deductions/done` |
-| `EMPLOYEE_DEDUCTION_EDIT` | `employee/deductions/edit` |
-| `EMPLOYEE_DEDUCTION_INCLUDE_NO` | `employee/deductions/include/no` |
-| `EMPLOYEE_DEDUCTION_INCLUDE_YES` | `employee/deductions/include/yes` |
-| `EMPLOYEE_DEDUCTION_UPDATED` | `employee/deductions/updated` |
-| `EMPLOYEE_DELETED` | `employee/deleted` |
-| `EMPLOYEE_DISMISS` | `employee/dismiss` |
-| `EMPLOYEE_DOCUMENTS_DONE` | `employee/documents/done` |
-| `EMPLOYEE_EMPLOYMENT_ELIGIBILITY_DONE` | `employee/employmentEligibility/done` |
-| `EMPLOYEE_FEDERAL_TAXES_DONE` | `employee/federalTaxes/done` |
-| `EMPLOYEE_FEDERAL_TAXES_UPDATED` | `employee/federalTaxes/updated` |
-| `EMPLOYEE_FORMS_DONE` | `employee/forms/done` |
-| `EMPLOYEE_HOME_ADDRESS` | `employee/addresses/home` |
-| `EMPLOYEE_HOME_ADDRESS_CREATED` | `employee/addresses/home/created` |
-| `EMPLOYEE_HOME_ADDRESS_UPDATED` | `employee/addresses/home/updated` |
-| `EMPLOYEE_JOB_CREATED` | `employee/job/created` |
-| `EMPLOYEE_JOB_DELETED` | `employee/job/deleted` |
-| `EMPLOYEE_JOB_UPDATED` | `employee/job/updated` |
-| `EMPLOYEE_ONBOARDING_DOCUMENTS_CONFIG_UPDATED` | `employee/onboardingDocumentsConfig/updated` |
-| `EMPLOYEE_ONBOARDING_DONE` | `employee/onboarding/done` |
-| `EMPLOYEE_ONBOARDING_STATUS_UPDATED` | `employee/onboardingStatus/updated` |
-| `EMPLOYEE_PAYMENT_METHOD_DONE` | `employee/paymentMethod/done` |
-| `EMPLOYEE_PAYMENT_METHOD_UPDATED` | `employee/paymentMethod/updated` |
-| `EMPLOYEE_PROFILE_DONE` | `employee/profile/done` |
-| `EMPLOYEE_REHIRE` | `employee/rehire` |
-| `EMPLOYEE_SELF_ONBOARDING_START` | `employee/selfOnboarding/start` |
-| `EMPLOYEE_SIGN_FORM` | `employee/forms/sign` |
-| `EMPLOYEE_SPLIT_PAYCHECK` | `employee/bankAccount/split` |
-| `EMPLOYEE_SPLIT_PAYMENT` | `employee/paymentMethod/split` |
-| `EMPLOYEE_STATE_TAXES_DONE` | `employee/stateTaxes/done` |
-| `EMPLOYEE_STATE_TAXES_UPDATED` | `employee/stateTaxes/updated` |
-| `EMPLOYEE_SUMMARY_VIEW` | `employee/summary` |
-| `EMPLOYEE_TAXES_DONE` | `employee/taxes/done` |
-| `EMPLOYEE_TERMINATION_CANCELLED` | `employee/termination/cancelled` |
-| `EMPLOYEE_TERMINATION_CREATED` | `employee/termination/created` |
-| `EMPLOYEE_TERMINATION_DONE` | `employee/termination/done` |
-| `EMPLOYEE_TERMINATION_EDIT` | `employee/termination/edit` |
-| `EMPLOYEE_TERMINATION_PAYROLL_CREATED` | `employee/termination/payroll/created` |
-| `EMPLOYEE_TERMINATION_PAYROLL_FAILED` | `employee/termination/payroll/failed` |
-| `EMPLOYEE_TERMINATION_RUN_OFF_CYCLE_PAYROLL` | `employee/termination/runOffCyclePayroll` |
-| `EMPLOYEE_TERMINATION_RUN_PAYROLL` | `employee/termination/runPayroll` |
-| `EMPLOYEE_TERMINATION_UPDATED` | `employee/termination/updated` |
-| `EMPLOYEE_TERMINATION_VIEW_SUMMARY` | `employee/termination/viewSummary` |
-| `EMPLOYEE_UPDATE` | `employee/update` |
-| `EMPLOYEE_UPDATED` | `employee/updated` |
-| `EMPLOYEE_VIEW_FORM_TO_SIGN` | `employee/forms/view` |
-| `EMPLOYEE_WORK_ADDRESS` | `employee/addresses/work` |
-| `EMPLOYEE_WORK_ADDRESS_CREATED` | `employee/addresses/work/created` |
-| `EMPLOYEE_WORK_ADDRESS_UPDATED` | `employee/addresses/work/updated` |
-| `EMPLOYEES_LIST` | `company/employees` |
-| `ERROR` | `ERROR` |
-| `INFORMATION_REQUEST_FORM_CANCEL` | `informationRequest/form/cancel` |
-| `INFORMATION_REQUEST_FORM_DONE` | `informationRequest/form/done` |
-| `INFORMATION_REQUEST_FORM_SUBMIT` | `informationRequest/form/submit` |
-| `INFORMATION_REQUEST_RESPOND` | `informationRequest/respond` |
-| `OFF_CYCLE_CREATED` | `offCycle/created` |
-| `OFF_CYCLE_DEDUCTIONS_CHANGE` | `offCycle/deductionsChange` |
-| `OFF_CYCLE_SELECT_REASON` | `offCycle/selectReason` |
-| `PAY_SCHEDULE_CREATE` | `paySchedule/create` |
-| `PAY_SCHEDULE_CREATED` | `paySchedule/created` |
-| `PAY_SCHEDULE_DELETE` | `paySchedule/delete` |
-| `PAY_SCHEDULE_DELETED` | `paySchedule/deleted` |
-| `PAY_SCHEDULE_DONE` | `paySchedule/done` |
-| `PAY_SCHEDULE_UPDATE` | `paySchedule/update` |
-| `PAY_SCHEDULE_UPDATED` | `paySchedule/updated` |
-| `PAYROLL_DELETED` | `payroll/deleted` |
-| `PAYROLL_EXIT_FLOW` | `payroll/saveAndExit` |
-| `PAYROLL_SKIPPED` | `payroll/skipped` |
-| `PAYROLL_WIRE_FORM_CANCEL` | `payroll/wire/form/cancel` |
-| `PAYROLL_WIRE_FORM_DONE` | `payroll/wire/form/done` |
-| `PAYROLL_WIRE_INSTRUCTIONS_CANCEL` | `payroll/wire/instructions/cancel` |
-| `PAYROLL_WIRE_INSTRUCTIONS_DONE` | `payroll/wire/instructions/done` |
-| `PAYROLL_WIRE_INSTRUCTIONS_SELECT` | `payroll/wire/instructions/select` |
-| `PAYROLL_WIRE_START_TRANSFER` | `payroll/wire/startTransfer` |
-| `RECOVERY_CASE_RESOLVE` | `recoveryCase/resolve` |
-| `RECOVERY_CASE_RESUBMIT` | `recoveryCase/resubmit` |
-| `RECOVERY_CASE_RESUBMIT_CANCEL` | `recoveryCase/resubmit/cancel` |
-| `RECOVERY_CASE_RESUBMIT_DONE` | `recoveryCase/resubmit/done` |
-| `REVIEW_PAYROLL` | `payroll/review` |
-| `ROBOT_MACHINE_DONE` | `done` |
-| `RUN_OFF_CYCLE_PAYROLL` | `runPayroll/offCycle/start` |
-| `RUN_PAYROLL_BACK` | `runPayroll/back` |
-| `RUN_PAYROLL_BLOCKER_RESOLUTION_ATTEMPTED` | `runPayroll/blocker/resolutionAttempted` |
-| `RUN_PAYROLL_BLOCKERS_DETECTED` | `runPayroll/blockers/detected` |
-| `RUN_PAYROLL_BLOCKERS_VIEW_ALL` | `runPayroll/blockers/viewAll` |
-| `RUN_PAYROLL_CALCULATED` | `runPayroll/calculated` |
-| `RUN_PAYROLL_CANCELLED` | `runPayroll/cancelled` |
-| `RUN_PAYROLL_CANCELLED_ALERT_DISMISSED` | `runPayroll/cancelled/alertDismissed` |
-| `RUN_PAYROLL_DATES_CONFIGURED` | `runPayroll/dates/configured` |
-| `RUN_PAYROLL_EDIT` | `runPayroll/edit` |
-| `RUN_PAYROLL_EMPLOYEE_CANCELLED` | `runPayroll/employee/cancelled` |
-| `RUN_PAYROLL_EMPLOYEE_EDIT` | `runPayroll/employee/edit` |
-| `RUN_PAYROLL_EMPLOYEE_SAVED` | `runPayroll/employee/saved` |
-| `RUN_PAYROLL_EMPLOYEE_SKIP` | `runPayroll/employee/skip` |
-| `RUN_PAYROLL_GROSS_UP_CALCULATED` | `runPayroll/grossUp/calculated` |
-| `RUN_PAYROLL_GROSS_UP_SELECTED` | `runPayroll/grossUp/selected` |
-| `RUN_PAYROLL_PDF_PAYSTUB_VIEWED` | `runPayroll/pdfPaystub/viewed` |
-| `RUN_PAYROLL_PROCESSED` | `runPayroll/processed` |
-| `RUN_PAYROLL_PROCESSING_FAILED` | `runPayroll/processingFailed` |
-| `RUN_PAYROLL_RECEIPT_GET` | `runPayroll/receipt/get` |
-| `RUN_PAYROLL_RECEIPT_VIEWED` | `runPayroll/receipt/viewed` |
-| `RUN_PAYROLL_SELECTED` | `runPayroll/selected` |
-| `RUN_PAYROLL_SUBMITTED` | `runPayroll/submitted` |
-| `RUN_PAYROLL_SUBMITTING` | `runPayroll/submitting` |
-| `RUN_PAYROLL_SUMMARY_VIEWED` | `runPayroll/summary/viewed` |
-| `RUN_TRANSITION_PAYROLL` | `transition/runPayroll` |
-| `TIME_OFF_ADD_EMPLOYEES_DONE` | `timeOff/addEmployees/done` |
-| `TIME_OFF_ADD_EMPLOYEES_ERROR` | `timeOff/addEmployees/error` |
-| `TIME_OFF_BACK_TO_LIST` | `timeOff/backToList` |
-| `TIME_OFF_CREATE_POLICY` | `timeOff/createPolicy` |
-| `TIME_OFF_HOLIDAY_ADD_EMPLOYEES_DONE` | `timeOff/holidayAddEmployees/done` |
-| `TIME_OFF_HOLIDAY_ADD_EMPLOYEES_ERROR` | `timeOff/holidayAddEmployees/error` |
-| `TIME_OFF_HOLIDAY_CREATE_ERROR` | `timeOff/holidayCreate/error` |
-| `TIME_OFF_HOLIDAY_SELECTION_DONE` | `timeOff/holidaySelection/done` |
-| `TIME_OFF_POLICY_CREATE_ERROR` | `timeOff/policyCreate/error` |
-| `TIME_OFF_POLICY_DETAILS_DONE` | `timeOff/policyDetails/done` |
-| `TIME_OFF_POLICY_SETTINGS_DONE` | `timeOff/policySettings/done` |
-| `TIME_OFF_POLICY_SETTINGS_ERROR` | `timeOff/policySettings/error` |
-| `TIME_OFF_POLICY_TYPE_SELECTED` | `timeOff/policyTypeSelected` |
-| `TIME_OFF_VIEW_HOLIDAY_EMPLOYEES` | `timeOff/viewHolidayEmployees` |
-| `TIME_OFF_VIEW_HOLIDAY_SCHEDULE` | `timeOff/viewHolidaySchedule` |
-| `TIME_OFF_VIEW_POLICY` | `timeOff/viewPolicy` |
-| `TIME_OFF_VIEW_POLICY_DETAILS` | `timeOff/viewPolicyDetails` |
-| `TIME_OFF_VIEW_POLICY_EMPLOYEES` | `timeOff/viewPolicyEmployees` |
-| `TRANSITION_CREATED` | `transition/created` |
-| `TRANSITION_PAYROLL_SKIPPED` | `transition/payrollSkipped` |
+| Key | Value |
+| ---------------------------------------------- | ----------------------------------------------- |
+| `BREADCRUMB_NAVIGATE` | `breadcrumb/navigate` |
+| `CANCEL` | `CANCEL` |
+| `COMPANY_ASSIGN_SIGNATORY_DONE` | `company/signatory/assignSignatory/done` |
+| `COMPANY_ASSIGN_SIGNATORY_MODE_UPDATED` | `company/signatory/assignSignatory/modeUpdated` |
+| `COMPANY_BANK_ACCOUNT_CANCEL` | `company/bankAccount/cancel` |
+| `COMPANY_BANK_ACCOUNT_CHANGE` | `company/bankAccount/change` |
+| `COMPANY_BANK_ACCOUNT_CREATED` | `company/bankAccount/created` |
+| `COMPANY_BANK_ACCOUNT_DONE` | `company/bankAccount/done` |
+| `COMPANY_BANK_ACCOUNT_VERIFIED` | `company/bankAccount/verified` |
+| `COMPANY_BANK_ACCOUNT_VERIFY` | `company/bankAccount/verify` |
+| `COMPANY_CREATE_SIGNATORY_DONE` | `company/signatory/createSignatory/done` |
+| `COMPANY_FEDERAL_TAXES_DONE` | `company/federalTaxes/done` |
+| `COMPANY_FEDERAL_TAXES_UPDATED` | `company/federalTaxes/updated` |
+| `COMPANY_FORM_EDIT_SIGNATORY` | `company/forms/editSignatory` |
+| `COMPANY_FORMS_DONE` | `company/forms/done` |
+| `COMPANY_INDUSTRY` | `company/industry` |
+| `COMPANY_INDUSTRY_SELECTED` | `company/industry/selected` |
+| `COMPANY_INVITE_SIGNATORY_DONE` | `company/signatory/inviteSignatory/done` |
+| `COMPANY_LOCATION_CREATE` | `company/location/add` |
+| `COMPANY_LOCATION_CREATED` | `company/location/add/done` |
+| `COMPANY_LOCATION_DONE` | `company/location/done` |
+| `COMPANY_LOCATION_EDIT` | `company/location/edit` |
+| `COMPANY_LOCATION_UPDATED` | `company/location/edit/done` |
+| `COMPANY_OVERVIEW_CONTINUE` | `company/overview/continue` |
+| `COMPANY_OVERVIEW_DONE` | `company/overview/done` |
+| `COMPANY_SIGN_FORM` | `company/forms/sign/signForm` |
+| `COMPANY_SIGN_FORM_BACK` | `company/forms/sign/back` |
+| `COMPANY_SIGN_FORM_DONE` | `company/forms/sign/done` |
+| `COMPANY_SIGNATORY_CREATED` | `company/signatory/created` |
+| `COMPANY_SIGNATORY_INVITED` | `company/signatory/invited` |
+| `COMPANY_SIGNATORY_UPDATED` | `company/signatory/updated` |
+| `COMPANY_STATE_TAX_DONE` | `company/stateTaxes/done` |
+| `COMPANY_STATE_TAX_EDIT` | `company/stateTaxes/edit` |
+| `COMPANY_STATE_TAX_UPDATED` | `company/stateTaxes/updated` |
+| `COMPANY_VIEW_FORM_TO_SIGN` | `company/forms/view` |
+| `CONTRACTOR_ADDRESS_DONE` | `contractor/address/done` |
+| `CONTRACTOR_ADDRESS_UPDATED` | `contractor/address/updated` |
+| `CONTRACTOR_BANK_ACCOUNT_CREATED` | `contractor/bankAccount/created` |
+| `CONTRACTOR_CREATE` | `contractor/create` |
+| `CONTRACTOR_CREATED` | `contractor/created` |
+| `CONTRACTOR_DELETED` | `contractor/deleted` |
+| `CONTRACTOR_INVITE_CONTRACTOR` | `contractor/invite/selfOnboarding` |
+| `CONTRACTOR_NEW_HIRE_REPORT_DONE` | `contractor/newHireReport/done` |
+| `CONTRACTOR_NEW_HIRE_REPORT_UPDATED` | `contractor/newHireReport/updated` |
+| `CONTRACTOR_ONBOARDING_CONTINUE` | `contractor/onboarding/continue` |
+| `CONTRACTOR_ONBOARDING_STATUS_UPDATED` | `contractor/onboardingStatus/updated` |
+| `CONTRACTOR_PAYMENT_BACK_TO_EDIT` | `contractor/payments/backToEdit` |
+| `CONTRACTOR_PAYMENT_CANCEL` | `contractor/payments/cancel` |
+| `CONTRACTOR_PAYMENT_CREATE` | `contractor/payments/create` |
+| `CONTRACTOR_PAYMENT_CREATED` | `contractor/payments/created` |
+| `CONTRACTOR_PAYMENT_EDIT` | `contractor/payments/edit` |
+| `CONTRACTOR_PAYMENT_EXIT` | `contractor/payments/exit` |
+| `CONTRACTOR_PAYMENT_METHOD_DONE` | `contractor/paymentMethod/done` |
+| `CONTRACTOR_PAYMENT_METHOD_UPDATED` | `contractor/paymentMethod/updated` |
+| `CONTRACTOR_PAYMENT_PREVIEW` | `contractor/payments/preview` |
+| `CONTRACTOR_PAYMENT_RFI_RESPOND` | `contractor/payments/rfi/respond` |
+| `CONTRACTOR_PAYMENT_SUBMIT` | `contractor/payments/submit` |
+| `CONTRACTOR_PAYMENT_UPDATE` | `contractor/payments/update` |
+| `CONTRACTOR_PAYMENT_VIEW` | `contractor/payments/view` |
+| `CONTRACTOR_PAYMENT_VIEW_DETAILS` | `contractor/payments/view/details` |
+| `CONTRACTOR_PROFILE_DONE` | `contractor/profile/done` |
+| `CONTRACTOR_SUBMIT_DONE` | `contractor/submit/done` |
+| `CONTRACTOR_UPDATE` | `contractor/update` |
+| `CONTRACTOR_UPDATED` | `contractor/updated` |
+| `DISMISSAL_PAY_PERIOD_SELECTED` | `dismissal/payPeriod/selected` |
+| `EMPLOYEE_BANK_ACCOUNT_CREATE` | `employee/bankAccount/create` |
+| `EMPLOYEE_BANK_ACCOUNT_CREATED` | `employee/bankAccount/created` |
+| `EMPLOYEE_BANK_ACCOUNT_DELETED` | `employee/bankAccount/deleted` |
+| `EMPLOYEE_CHANGE_ELIGIBILITY_STATUS` | `employee/employmentEligibility/change` |
+| `EMPLOYEE_COMPENSATION_CREATE` | `employee/compensations/create` |
+| `EMPLOYEE_COMPENSATION_CREATED` | `employee/compensations/created` |
+| `EMPLOYEE_COMPENSATION_DONE` | `employee/compensations/done` |
+| `EMPLOYEE_COMPENSATION_UPDATED` | `employee/compensations/updated` |
+| `EMPLOYEE_CREATE` | `employee/create` |
+| `EMPLOYEE_CREATED` | `employee/created` |
+| `EMPLOYEE_DEDUCTION_ADD` | `employee/deductions/add` |
+| `EMPLOYEE_DEDUCTION_CANCEL` | `employee/deductions/cancel` |
+| `EMPLOYEE_DEDUCTION_CANCEL_EMPTY` | `employee/deductions/cancelEmpty` |
+| `EMPLOYEE_DEDUCTION_CREATED` | `employee/deductions/created` |
+| `EMPLOYEE_DEDUCTION_DELETED` | `employee/deductions/deleted` |
+| `EMPLOYEE_DEDUCTION_DELETED_EMPTY` | `employee/deductions/deletedEmpty` |
+| `EMPLOYEE_DEDUCTION_DONE` | `employee/deductions/done` |
+| `EMPLOYEE_DEDUCTION_EDIT` | `employee/deductions/edit` |
+| `EMPLOYEE_DEDUCTION_INCLUDE_NO` | `employee/deductions/include/no` |
+| `EMPLOYEE_DEDUCTION_INCLUDE_YES` | `employee/deductions/include/yes` |
+| `EMPLOYEE_DEDUCTION_UPDATED` | `employee/deductions/updated` |
+| `EMPLOYEE_DELETED` | `employee/deleted` |
+| `EMPLOYEE_DISMISS` | `employee/dismiss` |
+| `EMPLOYEE_DOCUMENTS_DONE` | `employee/documents/done` |
+| `EMPLOYEE_EMPLOYMENT_ELIGIBILITY_DONE` | `employee/employmentEligibility/done` |
+| `EMPLOYEE_FEDERAL_TAXES_DONE` | `employee/federalTaxes/done` |
+| `EMPLOYEE_FEDERAL_TAXES_UPDATED` | `employee/federalTaxes/updated` |
+| `EMPLOYEE_FORMS_DONE` | `employee/forms/done` |
+| `EMPLOYEE_HOME_ADDRESS` | `employee/addresses/home` |
+| `EMPLOYEE_HOME_ADDRESS_CREATED` | `employee/addresses/home/created` |
+| `EMPLOYEE_HOME_ADDRESS_UPDATED` | `employee/addresses/home/updated` |
+| `EMPLOYEE_JOB_CREATED` | `employee/job/created` |
+| `EMPLOYEE_JOB_DELETED` | `employee/job/deleted` |
+| `EMPLOYEE_JOB_UPDATED` | `employee/job/updated` |
+| `EMPLOYEE_ONBOARDING_DOCUMENTS_CONFIG_UPDATED` | `employee/onboardingDocumentsConfig/updated` |
+| `EMPLOYEE_ONBOARDING_DONE` | `employee/onboarding/done` |
+| `EMPLOYEE_ONBOARDING_STATUS_UPDATED` | `employee/onboardingStatus/updated` |
+| `EMPLOYEE_PAYMENT_METHOD_DONE` | `employee/paymentMethod/done` |
+| `EMPLOYEE_PAYMENT_METHOD_UPDATED` | `employee/paymentMethod/updated` |
+| `EMPLOYEE_PROFILE_DONE` | `employee/profile/done` |
+| `EMPLOYEE_REHIRE` | `employee/rehire` |
+| `EMPLOYEE_SELF_ONBOARDING_START` | `employee/selfOnboarding/start` |
+| `EMPLOYEE_SIGN_FORM` | `employee/forms/sign` |
+| `EMPLOYEE_SPLIT_PAYCHECK` | `employee/bankAccount/split` |
+| `EMPLOYEE_SPLIT_PAYMENT` | `employee/paymentMethod/split` |
+| `EMPLOYEE_STATE_TAXES_DONE` | `employee/stateTaxes/done` |
+| `EMPLOYEE_STATE_TAXES_UPDATED` | `employee/stateTaxes/updated` |
+| `EMPLOYEE_SUMMARY_VIEW` | `employee/summary` |
+| `EMPLOYEE_TAXES_DONE` | `employee/taxes/done` |
+| `EMPLOYEE_TERMINATION_CANCELLED` | `employee/termination/cancelled` |
+| `EMPLOYEE_TERMINATION_CREATED` | `employee/termination/created` |
+| `EMPLOYEE_TERMINATION_DONE` | `employee/termination/done` |
+| `EMPLOYEE_TERMINATION_EDIT` | `employee/termination/edit` |
+| `EMPLOYEE_TERMINATION_PAYROLL_CREATED` | `employee/termination/payroll/created` |
+| `EMPLOYEE_TERMINATION_PAYROLL_FAILED` | `employee/termination/payroll/failed` |
+| `EMPLOYEE_TERMINATION_RUN_OFF_CYCLE_PAYROLL` | `employee/termination/runOffCyclePayroll` |
+| `EMPLOYEE_TERMINATION_RUN_PAYROLL` | `employee/termination/runPayroll` |
+| `EMPLOYEE_TERMINATION_UPDATED` | `employee/termination/updated` |
+| `EMPLOYEE_TERMINATION_VIEW_SUMMARY` | `employee/termination/viewSummary` |
+| `EMPLOYEE_UPDATE` | `employee/update` |
+| `EMPLOYEE_UPDATED` | `employee/updated` |
+| `EMPLOYEE_VIEW_FORM_TO_SIGN` | `employee/forms/view` |
+| `EMPLOYEE_WORK_ADDRESS` | `employee/addresses/work` |
+| `EMPLOYEE_WORK_ADDRESS_CREATED` | `employee/addresses/work/created` |
+| `EMPLOYEE_WORK_ADDRESS_UPDATED` | `employee/addresses/work/updated` |
+| `EMPLOYEES_LIST` | `company/employees` |
+| `ERROR` | `ERROR` |
+| `INFORMATION_REQUEST_FORM_CANCEL` | `informationRequest/form/cancel` |
+| `INFORMATION_REQUEST_FORM_DONE` | `informationRequest/form/done` |
+| `INFORMATION_REQUEST_FORM_SUBMIT` | `informationRequest/form/submit` |
+| `INFORMATION_REQUEST_RESPOND` | `informationRequest/respond` |
+| `OFF_CYCLE_CREATED` | `offCycle/created` |
+| `OFF_CYCLE_DEDUCTIONS_CHANGE` | `offCycle/deductionsChange` |
+| `OFF_CYCLE_SELECT_REASON` | `offCycle/selectReason` |
+| `PAY_SCHEDULE_CREATE` | `paySchedule/create` |
+| `PAY_SCHEDULE_CREATED` | `paySchedule/created` |
+| `PAY_SCHEDULE_DELETE` | `paySchedule/delete` |
+| `PAY_SCHEDULE_DELETED` | `paySchedule/deleted` |
+| `PAY_SCHEDULE_DONE` | `paySchedule/done` |
+| `PAY_SCHEDULE_UPDATE` | `paySchedule/update` |
+| `PAY_SCHEDULE_UPDATED` | `paySchedule/updated` |
+| `PAYROLL_DELETED` | `payroll/deleted` |
+| `PAYROLL_EXIT_FLOW` | `payroll/saveAndExit` |
+| `PAYROLL_SKIPPED` | `payroll/skipped` |
+| `PAYROLL_WIRE_FORM_CANCEL` | `payroll/wire/form/cancel` |
+| `PAYROLL_WIRE_FORM_DONE` | `payroll/wire/form/done` |
+| `PAYROLL_WIRE_INSTRUCTIONS_CANCEL` | `payroll/wire/instructions/cancel` |
+| `PAYROLL_WIRE_INSTRUCTIONS_DONE` | `payroll/wire/instructions/done` |
+| `PAYROLL_WIRE_INSTRUCTIONS_SELECT` | `payroll/wire/instructions/select` |
+| `PAYROLL_WIRE_START_TRANSFER` | `payroll/wire/startTransfer` |
+| `RECOVERY_CASE_RESOLVE` | `recoveryCase/resolve` |
+| `RECOVERY_CASE_RESUBMIT` | `recoveryCase/resubmit` |
+| `RECOVERY_CASE_RESUBMIT_CANCEL` | `recoveryCase/resubmit/cancel` |
+| `RECOVERY_CASE_RESUBMIT_DONE` | `recoveryCase/resubmit/done` |
+| `REVIEW_PAYROLL` | `payroll/review` |
+| `ROBOT_MACHINE_DONE` | `done` |
+| `RUN_OFF_CYCLE_PAYROLL` | `runPayroll/offCycle/start` |
+| `RUN_PAYROLL_BACK` | `runPayroll/back` |
+| `RUN_PAYROLL_BLOCKER_RESOLUTION_ATTEMPTED` | `runPayroll/blocker/resolutionAttempted` |
+| `RUN_PAYROLL_BLOCKERS_DETECTED` | `runPayroll/blockers/detected` |
+| `RUN_PAYROLL_BLOCKERS_VIEW_ALL` | `runPayroll/blockers/viewAll` |
+| `RUN_PAYROLL_CALCULATED` | `runPayroll/calculated` |
+| `RUN_PAYROLL_CANCELLED` | `runPayroll/cancelled` |
+| `RUN_PAYROLL_CANCELLED_ALERT_DISMISSED` | `runPayroll/cancelled/alertDismissed` |
+| `RUN_PAYROLL_DATES_CONFIGURED` | `runPayroll/dates/configured` |
+| `RUN_PAYROLL_EDIT` | `runPayroll/edit` |
+| `RUN_PAYROLL_EMPLOYEE_CANCELLED` | `runPayroll/employee/cancelled` |
+| `RUN_PAYROLL_EMPLOYEE_EDIT` | `runPayroll/employee/edit` |
+| `RUN_PAYROLL_EMPLOYEE_SAVED` | `runPayroll/employee/saved` |
+| `RUN_PAYROLL_EMPLOYEE_SKIP` | `runPayroll/employee/skip` |
+| `RUN_PAYROLL_GROSS_UP_CALCULATED` | `runPayroll/grossUp/calculated` |
+| `RUN_PAYROLL_GROSS_UP_SELECTED` | `runPayroll/grossUp/selected` |
+| `RUN_PAYROLL_PDF_PAYSTUB_VIEWED` | `runPayroll/pdfPaystub/viewed` |
+| `RUN_PAYROLL_PROCESSED` | `runPayroll/processed` |
+| `RUN_PAYROLL_PROCESSING_FAILED` | `runPayroll/processingFailed` |
+| `RUN_PAYROLL_RECEIPT_GET` | `runPayroll/receipt/get` |
+| `RUN_PAYROLL_RECEIPT_VIEWED` | `runPayroll/receipt/viewed` |
+| `RUN_PAYROLL_SELECTED` | `runPayroll/selected` |
+| `RUN_PAYROLL_SUBMITTED` | `runPayroll/submitted` |
+| `RUN_PAYROLL_SUBMITTING` | `runPayroll/submitting` |
+| `RUN_PAYROLL_SUMMARY_VIEWED` | `runPayroll/summary/viewed` |
+| `RUN_TRANSITION_PAYROLL` | `transition/runPayroll` |
+| `TIME_OFF_ADD_EMPLOYEES_DONE` | `timeOff/addEmployees/done` |
+| `TIME_OFF_ADD_EMPLOYEES_ERROR` | `timeOff/addEmployees/error` |
+| `TIME_OFF_BACK_TO_LIST` | `timeOff/backToList` |
+| `TIME_OFF_CREATE_POLICY` | `timeOff/createPolicy` |
+| `TIME_OFF_HOLIDAY_ADD_EMPLOYEES_DONE` | `timeOff/holidayAddEmployees/done` |
+| `TIME_OFF_HOLIDAY_ADD_EMPLOYEES_ERROR` | `timeOff/holidayAddEmployees/error` |
+| `TIME_OFF_HOLIDAY_CREATE_ERROR` | `timeOff/holidayCreate/error` |
+| `TIME_OFF_HOLIDAY_SELECTION_DONE` | `timeOff/holidaySelection/done` |
+| `TIME_OFF_POLICY_CREATE_ERROR` | `timeOff/policyCreate/error` |
+| `TIME_OFF_POLICY_DETAILS_DONE` | `timeOff/policyDetails/done` |
+| `TIME_OFF_POLICY_SETTINGS_DONE` | `timeOff/policySettings/done` |
+| `TIME_OFF_POLICY_SETTINGS_ERROR` | `timeOff/policySettings/error` |
+| `TIME_OFF_POLICY_TYPE_SELECTED` | `timeOff/policyTypeSelected` |
+| `TIME_OFF_VIEW_HOLIDAY_EMPLOYEES` | `timeOff/viewHolidayEmployees` |
+| `TIME_OFF_VIEW_HOLIDAY_SCHEDULE` | `timeOff/viewHolidaySchedule` |
+| `TIME_OFF_VIEW_POLICY` | `timeOff/viewPolicy` |
+| `TIME_OFF_VIEW_POLICY_DETAILS` | `timeOff/viewPolicyDetails` |
+| `TIME_OFF_VIEW_POLICY_EMPLOYEES` | `timeOff/viewPolicyEmployees` |
+| `TRANSITION_CREATED` | `transition/created` |
+| `TRANSITION_PAYROLL_SKIPPED` | `transition/payrollSkipped` |
See the individual component and workflow documentation for details on which events each component emits and what data is included.
diff --git a/docs/concepts/flows-and-blocks.md b/docs/concepts/flows-and-blocks.md
index 13d045b51..b08161d7a 100644
--- a/docs/concepts/flows-and-blocks.md
+++ b/docs/concepts/flows-and-blocks.md
@@ -11,20 +11,20 @@ Flows are pre-built, multi-step components that handle an entire user journey. T
### Available Flows
-| Flow | Description |
-| --- | --- |
-| `Company.OnboardingFlow` | Company setup: locations, tax info, bank account, signatory, pay schedule |
-| `Employee.OnboardingFlow` | Admin-driven employee onboarding: profile, taxes, payment, documents |
-| `Employee.SelfOnboardingFlow` | Employee-facing self-service onboarding |
-| `Employee.TerminationFlow` | Employee termination and final pay |
-| `Contractor.OnboardingFlow` | Contractor profile and payment setup |
-| `Contractor.PaymentFlow` | Create and manage contractor payments |
-| `Payroll.PayrollFlow` | Full payroll run: configure, edit, review, submit |
-| `Payroll.PayrollExecutionFlow` | Payroll execution from an existing payroll |
-| `Payroll.OffCycleFlow` | Off-cycle payroll creation and execution |
-| `Payroll.DismissalFlow` | Dismissal payroll processing |
-| `Payroll.TransitionFlow` | Payroll transition between providers |
-| `InformationRequests.InformationRequestsFlow` | Respond to information requests from Gusto |
+| Flow | Description |
+| --------------------------------------------- | ------------------------------------------------------------------------- |
+| `Company.OnboardingFlow` | Company setup: locations, tax info, bank account, signatory, pay schedule |
+| `Employee.OnboardingFlow` | Admin-driven employee onboarding: profile, taxes, payment, documents |
+| `Employee.SelfOnboardingFlow` | Employee-facing self-service onboarding |
+| `Employee.TerminationFlow` | Employee termination and final pay |
+| `Contractor.OnboardingFlow` | Contractor profile and payment setup |
+| `Contractor.PaymentFlow` | Create and manage contractor payments |
+| `Payroll.PayrollFlow` | Full payroll run: configure, edit, review, submit |
+| `Payroll.PayrollExecutionFlow` | Payroll execution from an existing payroll |
+| `Payroll.OffCycleFlow` | Off-cycle payroll creation and execution |
+| `Payroll.DismissalFlow` | Dismissal payroll processing |
+| `Payroll.TransitionFlow` | Payroll transition between providers |
+| `InformationRequests.InformationRequestsFlow` | Respond to information requests from Gusto |
### Using a Flow
diff --git a/docs/concepts/i18n.md b/docs/concepts/i18n.md
index 8e2eadccb..57bedb4db 100644
--- a/docs/concepts/i18n.md
+++ b/docs/concepts/i18n.md
@@ -73,8 +73,8 @@ Control the active language and locale through `GustoProvider` props:
>
```
-| Prop | Default | Description |
-| --- | --- | --- |
-| `lng` | `'en'` | Language code for i18next |
-| `locale` | `'en-US'` | Locale for number and date formatting |
-| `currency` | `'USD'` | Currency code for monetary values |
+| Prop | Default | Description |
+| ---------- | --------- | ------------------------------------- |
+| `lng` | `'en'` | Language code for i18next |
+| `locale` | `'en-US'` | Locale for number and date formatting |
+| `currency` | `'USD'` | Currency code for monetary values |
diff --git a/docs/concepts/provider-and-configuration.md b/docs/concepts/provider-and-configuration.md
index b7cbf377d..6f542d116 100644
--- a/docs/concepts/provider-and-configuration.md
+++ b/docs/concepts/provider-and-configuration.md
@@ -93,15 +93,15 @@ config={{
Beyond `config`, `GustoProvider` accepts these props:
-| Prop | Type | Description |
-| --- | --- | --- |
-| `theme` | `GustoSDKTheme` | CSS variable overrides for colors, typography, shadows. See [Theming](./theming-and-customization.md). |
-| `components` | `Partial` | Override SDK UI primitives with your own. See [Theming and Customization](./theming-and-customization.md). |
-| `dictionary` | `ResourceDictionary` | i18n string overrides. See [Internationalization](./i18n.md). |
-| `lng` | `string` | Language code (default: `'en'`). |
-| `locale` | `string` | Locale for number/date formatting (default: `'en-US'`). |
-| `currency` | `string` | Currency code (default: `'USD'`). |
-| `queryClient` | `QueryClient` | Custom TanStack Query client instance. |
+| Prop | Type | Description |
+| ------------- | -------------------------------- | ---------------------------------------------------------------------------------------------------------- |
+| `theme` | `GustoSDKTheme` | CSS variable overrides for colors, typography, shadows. See [Theming](./theming-and-customization.md). |
+| `components` | `Partial` | Override SDK UI primitives with your own. See [Theming and Customization](./theming-and-customization.md). |
+| `dictionary` | `ResourceDictionary` | i18n string overrides. See [Internationalization](./i18n.md). |
+| `lng` | `string` | Language code (default: `'en'`). |
+| `locale` | `string` | Locale for number/date formatting (default: `'en-US'`). |
+| `currency` | `string` | Currency code (default: `'USD'`). |
+| `queryClient` | `QueryClient` | Custom TanStack Query client instance. |
## Full example
@@ -116,7 +116,7 @@ function App({ children }) {
baseUrl: '/api/gusto/',
headers: { 'X-Partner-Id': 'partner_123' },
observability: {
- onError: (error) => errorTracker.capture(error),
+ onError: error => errorTracker.capture(error),
},
}}
theme={{
diff --git a/docs/guides/component-adapter.md b/docs/guides/component-adapter.md
index d3dbb185f..5fe640abd 100644
--- a/docs/guides/component-adapter.md
+++ b/docs/guides/component-adapter.md
@@ -120,10 +120,7 @@ const myCustomComponents: Partial = {
### 3. Provide to Your App
```tsx
-
+
```
@@ -174,7 +171,12 @@ const materialUIComponents = {
variant === 'primary' ? 'contained' : variant === 'secondary' ? 'outlined' : 'text'
return (
-
+
{isLoading ? 'Loading...' : children}
)
@@ -183,10 +185,7 @@ const materialUIComponents = {
function App() {
return (
-
+ {}} />
)
@@ -226,13 +225,13 @@ Reference the [default implementations](https://github.com/Gusto/embedded-react-
The SDK expects specific value formats from each component's `onChange` handler:
-| Component | onChange parameter |
-| --- | --- |
-| Checkbox | `boolean` |
-| DatePicker | `Date \| null` |
-| NumberInput | `number` |
-| Select | `string` |
-| TextInput | `string` |
+| Component | onChange parameter |
+| ----------- | ------------------ |
+| Checkbox | `boolean` |
+| DatePicker | `Date \| null` |
+| NumberInput | `number` |
+| Select | `string` |
+| TextInput | `string` |
### What about accessibility?
diff --git a/docs/guides/guides.md b/docs/guides/guides.md
index 28b5ee813..31e8da4bc 100644
--- a/docs/guides/guides.md
+++ b/docs/guides/guides.md
@@ -5,13 +5,13 @@ sidebar_position: 1
Practical guides for integrating and customizing the Gusto Embedded React SDK.
-| Guide | Description |
-| --- | --- |
-| [Versioning](./versioning.md) | How the SDK follows SemVer and what to expect during pre-1.0 development |
-| [Routing](./routing.md) | Integrate the SDK with your routing library using event-driven navigation |
-| [Request Interceptors](./request-interceptors.md) | Hook into HTTP requests and responses for auth, logging, and error handling |
-| [Providing Your Own Data](./providing-your-own-data.md) | Pre-fill SDK forms with data from your application |
-| [Observability](./observability.md) | Capture errors and performance metrics for monitoring and alerting |
-| [Component Adapter](./component-adapter.md) | Replace SDK UI primitives with your own design system components |
-| [Proxy Setup](./proxy-setup.md) | Build a secure API proxy with endpoint allowlisting |
-| [Theme Variables](./theme-variables.md) | Customize colors, typography, spacing, and other visual properties |
+| Guide | Description |
+| ------------------------------------------------------- | --------------------------------------------------------------------------- |
+| [Versioning](./versioning.md) | How the SDK follows SemVer and what to expect during pre-1.0 development |
+| [Routing](./routing.md) | Integrate the SDK with your routing library using event-driven navigation |
+| [Request Interceptors](./request-interceptors.md) | Hook into HTTP requests and responses for auth, logging, and error handling |
+| [Providing Your Own Data](./providing-your-own-data.md) | Pre-fill SDK forms with data from your application |
+| [Observability](./observability.md) | Capture errors and performance metrics for monitoring and alerting |
+| [Component Adapter](./component-adapter.md) | Replace SDK UI primitives with your own design system components |
+| [Proxy Setup](./proxy-setup.md) | Build a secure API proxy with endpoint allowlisting |
+| [Theme Variables](./theme-variables.md) | Customize colors, typography, spacing, and other visual properties |
diff --git a/docs/guides/observability.md b/docs/guides/observability.md
index ee6fb5441..ebe8ca1f3 100644
--- a/docs/guides/observability.md
+++ b/docs/guides/observability.md
@@ -75,12 +75,12 @@ interface ObservabilityError extends SDKError {
### Error Categories
-| Category | Description | When it occurs |
-| --- | --- | --- |
-| `api_error` | HTTP error from the Gusto API | API returns 4xx or 5xx status codes |
-| `validation_error` | Client-side Zod schema validation | Request/response fails Zod validation |
-| `network_error` | Network connectivity failure | Connection refused, timeout, or request aborted |
-| `internal_error` | Unexpected runtime error | Unhandled exceptions caught by error boundaries or provider |
+| Category | Description | When it occurs |
+| ------------------ | --------------------------------- | ----------------------------------------------------------- |
+| `api_error` | HTTP error from the Gusto API | API returns 4xx or 5xx status codes |
+| `validation_error` | Client-side Zod schema validation | Request/response fails Zod validation |
+| `network_error` | Network connectivity failure | Connection refused, timeout, or request aborted |
+| `internal_error` | Unexpected runtime error | Unhandled exceptions caught by error boundaries or provider |
### Field Errors
@@ -106,10 +106,10 @@ For errors caught by React ErrorBoundaries, `error.componentStack` provides the
## Performance Metrics
-| Metric Name | Description | Unit | Tags |
-| --- | --- | --- | --- |
-| `sdk.form.submit_duration` | Form submission time | ms | `status` (success/error), `component` |
-| `sdk.component.loading_duration` | Time spent in loading/suspense state | ms | `component` |
+| Metric Name | Description | Unit | Tags |
+| -------------------------------- | ------------------------------------ | ---- | ------------------------------------- |
+| `sdk.form.submit_duration` | Form submission time | ms | `status` (success/error), `component` |
+| `sdk.component.loading_duration` | Time spent in loading/suspense state | ms | `component` |
```typescript
interface ObservabilityMetric {
@@ -291,11 +291,11 @@ const observability: ObservabilityHook = {
## Comparison with Other Tracking Mechanisms
-| Mechanism | Purpose | Use case |
-| --- | --- | --- |
-| `observability.onError` | Error tracking | Send errors to Sentry, Datadog, etc. |
-| `observability.onMetric` | Performance metrics | Track form submission times, component render times |
-| `onEvent` (component prop) | Business events | Track user actions, flow completions, API responses |
+| Mechanism | Purpose | Use case |
+| --------------------------- | ----------------------------- | --------------------------------------------------- |
+| `observability.onError` | Error tracking | Send errors to Sentry, Datadog, etc. |
+| `observability.onMetric` | Performance metrics | Track form submission times, component render times |
+| `onEvent` (component prop) | Business events | Track user actions, flow completions, API responses |
| `hooks.afterError` (config) | Request/response interception | Modify requests, add auth tokens, log all API calls |
## TypeScript Types
diff --git a/docs/guides/request-interceptors.md b/docs/guides/request-interceptors.md
index 26cc07926..0d69f5788 100644
--- a/docs/guides/request-interceptors.md
+++ b/docs/guides/request-interceptors.md
@@ -7,12 +7,12 @@ Request interceptors let you customize HTTP requests and responses in the Gusto
## Hook Types
-| Hook | When it runs | Use case |
-| --- | --- | --- |
-| `beforeCreateRequest` | Before the `Request` object is created | URL modification, method changes |
-| `beforeRequest` | Before the request is sent | Add headers, auth tokens, logging |
-| `afterSuccess` | After a successful response (2xx) | Response logging, analytics |
-| `afterError` | After an error response (4xx, 5xx) or network failure | Error tracking, retry logic |
+| Hook | When it runs | Use case |
+| --------------------- | ----------------------------------------------------- | --------------------------------- |
+| `beforeCreateRequest` | Before the `Request` object is created | URL modification, method changes |
+| `beforeRequest` | Before the request is sent | Add headers, auth tokens, logging |
+| `afterSuccess` | After a successful response (2xx) | Response logging, analytics |
+| `afterError` | After an error response (4xx, 5xx) or network failure | Error tracking, retry logic |
For complete hook interface details, see the [Speakeasy SDK Hooks documentation](https://www.speakeasy.com/docs/customize/code/sdk-hooks).
diff --git a/docs/guides/routing.md b/docs/guides/routing.md
index 1322343fa..b310a7955 100644
--- a/docs/guides/routing.md
+++ b/docs/guides/routing.md
@@ -67,7 +67,7 @@ function EmployeeLandingWrapper({ companyId, employeeId }) {
{
+ onEvent={eventType => {
if (eventType === componentEvents.EMPLOYEE_SELF_ONBOARDING_START) {
navigate('/profile')
}
@@ -86,11 +86,7 @@ Here is the full working example with all wrapper components and the router conf
```tsx
import { Employee, componentEvents, GustoProvider } from '@gusto/embedded-react-sdk'
import '@gusto/embedded-react-sdk/style.css'
-import {
- createBrowserRouter,
- RouterProvider,
- useNavigate,
-} from 'react-router-dom'
+import { createBrowserRouter, RouterProvider, useNavigate } from 'react-router-dom'
interface AppProps {
companyId: string
@@ -110,7 +106,7 @@ function EmployeeLandingWrapper({
{
+ onEvent={eventType => {
if (eventType === componentEvents.EMPLOYEE_SELF_ONBOARDING_START) {
navigate('/profile')
}
@@ -132,7 +128,7 @@ function EmployeeProfileWrapper({
{
+ onEvent={eventType => {
if (eventType === componentEvents.EMPLOYEE_PROFILE_DONE) {
navigate('/taxes')
}
@@ -147,7 +143,7 @@ function EmployeeTaxesWrapper({ employeeId }: { employeeId: string }) {
return (
{
+ onEvent={eventType => {
if (eventType === componentEvents.EMPLOYEE_TAXES_DONE) {
navigate('/payment_method')
}
@@ -162,7 +158,7 @@ function EmployeePaymentMethodWrapper({ employeeId }: { employeeId: string }) {
return (
{
+ onEvent={eventType => {
if (eventType === componentEvents.EMPLOYEE_PAYMENT_METHOD_DONE) {
navigate('/document_signer')
}
@@ -177,7 +173,7 @@ function EmployeeDocumentSignerWrapper({ employeeId }: { employeeId: string }) {
return (
{
+ onEvent={eventType => {
if (eventType === componentEvents.EMPLOYEE_FORMS_DONE) {
navigate('/onboarding_summary')
}
@@ -187,12 +183,7 @@ function EmployeeDocumentSignerWrapper({ employeeId }: { employeeId: string }) {
}
function EmployeeOnboardingSummaryWrapper({ employeeId }: { employeeId: string }) {
- return (
- {}}
- />
- )
+ return {}} />
}
const createEmployeeSelfOnboardingRouter = ({
diff --git a/docs/guides/theme-variables.md b/docs/guides/theme-variables.md
index 60ef2d6be..9a1f9301b 100644
--- a/docs/guides/theme-variables.md
+++ b/docs/guides/theme-variables.md
@@ -36,79 +36,79 @@ When customizing colors, ensure sufficient contrast ratios between foreground an
### Colors
-| Variable | Type |
-| --- | --- |
-| **colorBody** | `string` |
-| **colorBodyAccent** | `string` |
-| **colorBodyContent** | `string` |
-| **colorBodySubContent** | `string` |
-| **colorBorder** | `string` |
-| **colorError** | `string` |
-| **colorErrorAccent** | `string` |
-| **colorErrorContent** | `string` |
-| **colorInfo** | `string` |
-| **colorInfoAccent** | `string` |
-| **colorInfoContent** | `string` |
-| **colorPrimary** | `string` |
-| **colorPrimaryAccent** | `string` |
-| **colorPrimaryContent** | `string` |
-| **colorSecondary** | `string` |
-| **colorSecondaryAccent** | `string` |
+| Variable | Type |
+| ------------------------- | -------- |
+| **colorBody** | `string` |
+| **colorBodyAccent** | `string` |
+| **colorBodyContent** | `string` |
+| **colorBodySubContent** | `string` |
+| **colorBorder** | `string` |
+| **colorError** | `string` |
+| **colorErrorAccent** | `string` |
+| **colorErrorContent** | `string` |
+| **colorInfo** | `string` |
+| **colorInfoAccent** | `string` |
+| **colorInfoContent** | `string` |
+| **colorPrimary** | `string` |
+| **colorPrimaryAccent** | `string` |
+| **colorPrimaryContent** | `string` |
+| **colorSecondary** | `string` |
+| **colorSecondaryAccent** | `string` |
| **colorSecondaryContent** | `string` |
-| **colorSuccess** | `string` |
-| **colorSuccessAccent** | `string` |
-| **colorSuccessContent** | `string` |
-| **colorWarning** | `string` |
-| **colorWarningAccent** | `string` |
-| **colorWarningContent** | `string` |
+| **colorSuccess** | `string` |
+| **colorSuccessAccent** | `string` |
+| **colorSuccessContent** | `string` |
+| **colorWarning** | `string` |
+| **colorWarningAccent** | `string` |
+| **colorWarningContent** | `string` |
### Typography
-| Variable | Type |
-| --- | --- |
-| **fontFamily** | `string` |
+| Variable | Type |
+| ------------------------- | -------- |
+| **fontFamily** | `string` |
| **fontLineHeightRegular** | `string` |
-| **fontSizeHeading1** | `string` |
-| **fontSizeHeading2** | `string` |
-| **fontSizeHeading3** | `string` |
-| **fontSizeHeading4** | `string` |
-| **fontSizeHeading5** | `string` |
-| **fontSizeHeading6** | `string` |
-| **fontSizeLarge** | `string` |
-| **fontSizeRegular** | `string` |
-| **fontSizeRoot** | `string` |
-| **fontSizeSmall** | `string` |
-| **fontWeightBold** | `string` |
-| **fontWeightMedium** | `string` |
-| **fontWeightRegular** | `string` |
-| **fontWeightSemibold** | `string` |
+| **fontSizeHeading1** | `string` |
+| **fontSizeHeading2** | `string` |
+| **fontSizeHeading3** | `string` |
+| **fontSizeHeading4** | `string` |
+| **fontSizeHeading5** | `string` |
+| **fontSizeHeading6** | `string` |
+| **fontSizeLarge** | `string` |
+| **fontSizeRegular** | `string` |
+| **fontSizeRoot** | `string` |
+| **fontSizeSmall** | `string` |
+| **fontWeightBold** | `string` |
+| **fontWeightMedium** | `string` |
+| **fontWeightRegular** | `string` |
+| **fontWeightSemibold** | `string` |
### Focus and Shadows
-| Variable | Type |
-| --- | --- |
+| Variable | Type |
+| ------------------ | -------- |
| **focusRingColor** | `string` |
| **focusRingWidth** | `string` |
-| **shadowResting** | `string` |
-| **shadowTopmost** | `string` |
+| **shadowResting** | `string` |
+| **shadowTopmost** | `string` |
### Component-Specific
-| Variable | Type |
-| --- | --- |
-| **badgeRadius** | `string` |
-| **buttonRadius** | `string` |
-| **inputAdornmentColor** | `string` |
-| **inputBackgroundColor** | `string` |
-| **inputBorderColor** | `string` |
-| **inputBorderWidth** | `string` |
-| **inputContentColor** | `string` |
-| **inputDescriptionColor** | `string` |
+| Variable | Type |
+| -------------------------------- | -------- |
+| **badgeRadius** | `string` |
+| **buttonRadius** | `string` |
+| **inputAdornmentColor** | `string` |
+| **inputBackgroundColor** | `string` |
+| **inputBorderColor** | `string` |
+| **inputBorderWidth** | `string` |
+| **inputContentColor** | `string` |
+| **inputDescriptionColor** | `string` |
| **inputDisabledBackgroundColor** | `string` |
-| **inputErrorColor** | `string` |
-| **inputLabelColor** | `string` |
-| **inputLabelFontSize** | `string` |
-| **inputLabelFontWeight** | `string` |
-| **inputPlaceholderColor** | `string` |
-| **inputRadius** | `string` |
-| **transitionDuration** | `string` |
+| **inputErrorColor** | `string` |
+| **inputLabelColor** | `string` |
+| **inputLabelFontSize** | `string` |
+| **inputLabelFontWeight** | `string` |
+| **inputPlaceholderColor** | `string` |
+| **inputRadius** | `string` |
+| **transitionDuration** | `string` |
diff --git a/docs/quickstart/first-flow.md b/docs/quickstart/first-flow.md
index 267686f77..e9584216e 100644
--- a/docs/quickstart/first-flow.md
+++ b/docs/quickstart/first-flow.md
@@ -65,12 +65,7 @@ If you need more control over layout or step ordering, you can use the individua
```jsx
import { Employee } from '@gusto/embedded-react-sdk'
-
-
+;
```
Each step of a flow is available as a standalone component. You can rearrange them, mix them with your own UI, or integrate them into your existing routing. See [Composition](../concepts/composition.md) for details.
diff --git a/docs/reference/endpoint-reference.md b/docs/reference/endpoint-reference.md
index f500e4a2c..b10e8d167 100644
--- a/docs/reference/endpoint-reference.md
+++ b/docs/reference/endpoint-reference.md
@@ -4,6 +4,8 @@ title: 'Endpoint Reference'
+# Endpoint Reference
+
Every SDK component ("block") makes a specific set of API calls. This reference lists them all. For a concise overview, see the [Proxy Security: Partner Guidance](../getting-started/proxy-security-partner-guidance.md).
Paths use named parameters (`:companyId`, `:employeeId`, etc.) that correspond to real IDs at runtime. This data is also available as a machine-readable JSON file at [`endpoint-inventory.json`](./endpoint-inventory.json), which includes the list of variables each block expects. For programmatic access, import it directly from the package:
diff --git a/docs/what-is-the-gep-react-sdk.md b/docs/what-is-the-gep-react-sdk.md
index fd52805ce..3aed82971 100644
--- a/docs/what-is-the-gep-react-sdk.md
+++ b/docs/what-is-the-gep-react-sdk.md
@@ -17,8 +17,7 @@ Pre-built workflow components encapsulate multi-step processes like employee onb
```jsx
import { Employee } from '@gusto/embedded-react-sdk'
-
-
+;
```
### Full UI control
@@ -49,12 +48,12 @@ The SDK manages API calls, form validation, error handling, and state transition
## How it compares
-| | React SDK | Flows (iframes) | Raw API |
-| --- | --- | --- | --- |
+| | React SDK | Flows (iframes) | Raw API |
+| -------------------- | ----------------------------------------------- | ----------------------- | -------------------- |
| **UI customization** | Full (theming, component adapters, composition) | Limited (CSS overrides) | You build everything |
-| **Build effort** | Low-medium | Low | High |
-| **Business logic** | Included | Included | You implement |
-| **Framework** | React required | Any (iframe) | Any |
+| **Build effort** | Low-medium | Low | High |
+| **Business logic** | Included | Included | You implement |
+| **Framework** | React required | Any (iframe) | Any |
## Next steps
diff --git a/docs/workflows-overview/information-requests.md b/docs/workflows-overview/information-requests.md
index e253aad64..76514fe9e 100644
--- a/docs/workflows-overview/information-requests.md
+++ b/docs/workflows-overview/information-requests.md
@@ -24,19 +24,19 @@ function MyApp() {
#### Props
-| Name | Type | Default | Description |
-| ------------------------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------- |
-| **companyId** (Required) | string | | The associated company identifier. |
-| **onEvent** | function | | Event handler for information request events. |
+| Name | Type | Default | Description |
+| ------------------------ | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **companyId** (Required) | string | | The associated company identifier. |
+| **onEvent** | function | | Event handler for information request events. |
| **withAlert** | boolean | true | When true, displays a success alert at the top of the component after a request is submitted. Set to false when embedding in a parent that renders alerts elsewhere. |
#### Events
-| Event type | Description | Data |
-| -------------------------------- | -------------------------------------------------------- | ---------------------------------- |
-| INFORMATION_REQUEST_RESPOND | Fired when user clicks to respond to a request | { requestId: string } |
-| INFORMATION_REQUEST_FORM_DONE | Fired when a request is successfully submitted | The updated information request |
-| INFORMATION_REQUEST_FORM_CANCEL | Fired when user cancels the response form | None |
+| Event type | Description | Data |
+| ------------------------------- | ---------------------------------------------- | ------------------------------- |
+| INFORMATION_REQUEST_RESPOND | Fired when user clicks to respond to a request | { requestId: string } |
+| INFORMATION_REQUEST_FORM_DONE | Fired when a request is successfully submitted | The updated information request |
+| INFORMATION_REQUEST_FORM_CANCEL | Fired when user cancels the response form | None |
## Using Information Request Subcomponents
@@ -66,10 +66,10 @@ function MyComponent() {
#### Props
-| Name | Type | Description |
-| ------------------------ | -------- | ---------------------------------------------- |
-| **companyId** (Required) | string | The associated company identifier. |
-| **onEvent** (Required) | function | See events table for available events. |
+| Name | Type | Description |
+| ------------------------ | -------- | -------------------------------------- |
+| **companyId** (Required) | string | The associated company identifier. |
+| **onEvent** (Required) | function | See events table for available events. |
#### Events
@@ -105,7 +105,7 @@ function MyComponent() {
#### Events
-| Event type | Description | Data |
-| ------------------------------- | ---------------------------------------------- | ------------------------------- |
+| Event type | Description | Data |
+| ------------------------------- | ------------------------------------------------ | ------------------------------- |
| INFORMATION_REQUEST_FORM_DONE | Fired when the request is successfully submitted | The updated information request |
-| INFORMATION_REQUEST_FORM_CANCEL | Fired when user cancels the response form | None |
+| INFORMATION_REQUEST_FORM_CANCEL | Fired when user cancels the response form | None |
diff --git a/docs/workflows-overview/run-payroll.md b/docs/workflows-overview/run-payroll.md
index 67db14266..911a5b116 100644
--- a/docs/workflows-overview/run-payroll.md
+++ b/docs/workflows-overview/run-payroll.md
@@ -400,12 +400,12 @@ function MyComponent() {
#### Props
-| Name | Type | Description |
-| ------------------------ | -------- | -------------------------------------------------------------------------------------------------- |
-| **companyId** (Required) | string | The associated company identifier. |
+| Name | Type | Description |
+| ------------------------ | -------- | --------------------------------------------------------------------------------------------------- |
+| **companyId** (Required) | string | The associated company identifier. |
| **employeeId** | string | The employee being terminated. Used to scope the pay period selection. |
| **payrollId** | string | When provided with `employeeId`, skips pay period selection and goes directly to payroll execution. |
-| **onEvent** (Required) | function | See events table for available events. |
+| **onEvent** (Required) | function | See events table for available events. |
#### Events
@@ -488,13 +488,13 @@ function MyComponent() {
#### Props
-| Name | Type | Description |
-| ------------------------------- | -------- | ----------------------------------------------- |
-| **companyId** (Required) | string | The associated company identifier. |
-| **startDate** (Required) | string | The start date of the transition pay period. |
-| **endDate** (Required) | string | The end date of the transition pay period. |
-| **payScheduleUuid** (Required) | string | The pay schedule identifier for the transition. |
-| **onEvent** (Required) | function | See events table for available events. |
+| Name | Type | Description |
+| ------------------------------ | -------- | ----------------------------------------------- |
+| **companyId** (Required) | string | The associated company identifier. |
+| **startDate** (Required) | string | The start date of the transition pay period. |
+| **endDate** (Required) | string | The end date of the transition pay period. |
+| **payScheduleUuid** (Required) | string | The pay schedule identifier for the transition. |
+| **onEvent** (Required) | function | See events table for available events. |
#### Events
@@ -524,13 +524,13 @@ function MyComponent() {
#### Props
-| Name | Type | Description |
-| ------------------------------- | -------- | ----------------------------------------------- |
-| **companyId** (Required) | string | The associated company identifier. |
-| **startDate** (Required) | string | The start date of the transition pay period. |
-| **endDate** (Required) | string | The end date of the transition pay period. |
-| **payScheduleUuid** (Required) | string | The pay schedule identifier for the transition. |
-| **onEvent** (Required) | function | See events table for available events. |
+| Name | Type | Description |
+| ------------------------------ | -------- | ----------------------------------------------- |
+| **companyId** (Required) | string | The associated company identifier. |
+| **startDate** (Required) | string | The start date of the transition pay period. |
+| **endDate** (Required) | string | The end date of the transition pay period. |
+| **payScheduleUuid** (Required) | string | The pay schedule identifier for the transition. |
+| **onEvent** (Required) | function | See events table for available events. |
#### Events
@@ -558,13 +558,13 @@ function MyComponent() {
#### Props
-| Name | Type | Description |
-| ------------------------------- | ---------------------------------------- | ------------------------------------------------------------------ |
-| **companyId** (Required) | string | The associated company identifier. |
-| **payrollId** (Required) | string | The associated payroll identifier. |
-| **onEvent** (Required) | function | See events table for available events. |
-| **withReimbursements** | boolean | Optional flag to show/hide reimbursements fields. Defaults to true.|
-| **ConfirmWireDetailsComponent** | `ComponentType` | Optional custom component to replace the default wire details UI. |
+| Name | Type | Description |
+| ------------------------------- | ---------------------------------------- | ------------------------------------------------------------------- |
+| **companyId** (Required) | string | The associated company identifier. |
+| **payrollId** (Required) | string | The associated payroll identifier. |
+| **onEvent** (Required) | function | See events table for available events. |
+| **withReimbursements** | boolean | Optional flag to show/hide reimbursements fields. Defaults to true. |
+| **ConfirmWireDetailsComponent** | `ComponentType` | Optional custom component to replace the default wire details UI. |
### Payroll.RecoveryCases
diff --git a/e2e/package-lock.json b/e2e/package-lock.json
deleted file mode 100644
index 244c8924c..000000000
--- a/e2e/package-lock.json
+++ /dev/null
@@ -1,2439 +0,0 @@
-{
- "name": "embedded-react-sdk-e2e",
- "lockfileVersion": 3,
- "requires": true,
- "packages": {
- "": {
- "name": "embedded-react-sdk-e2e",
- "dependencies": {
- "@gusto/embedded-react-sdk": "file:gusto-embedded-react-sdk-0.34.0.tgz"
- }
- },
- "node_modules/@babel/runtime": {
- "version": "7.29.2",
- "resolved": "https://registry.npmjs.org/@babel/runtime/-/runtime-7.29.2.tgz",
- "integrity": "sha512-JiDShH45zKHWyGe4ZNVRrCjBz8Nh9TMmZG1kh4QTK8hCBTWBi8Da+i7s1fJw7/lYpM4ccepSNfqzZ/QvABBi5g==",
- "license": "MIT",
- "engines": {
- "node": ">=6.9.0"
- }
- },
- "node_modules/@formatjs/ecma402-abstract": {
- "version": "2.3.6",
- "resolved": "https://registry.npmjs.org/@formatjs/ecma402-abstract/-/ecma402-abstract-2.3.6.tgz",
- "integrity": "sha512-HJnTFeRM2kVFVr5gr5kH1XP6K0JcJtE7Lzvtr3FS/so5f1kpsqqqxy5JF+FRaO6H2qmcMfAUIox7AJteieRtVw==",
- "license": "MIT",
- "dependencies": {
- "@formatjs/fast-memoize": "2.2.7",
- "@formatjs/intl-localematcher": "0.6.2",
- "decimal.js": "^10.4.3",
- "tslib": "^2.8.0"
- }
- },
- "node_modules/@formatjs/fast-memoize": {
- "version": "2.2.7",
- "resolved": "https://registry.npmjs.org/@formatjs/fast-memoize/-/fast-memoize-2.2.7.tgz",
- "integrity": "sha512-Yabmi9nSvyOMrlSeGGWDiH7rf3a7sIwplbvo/dlz9WCIjzIQAfy1RMf4S0X3yG724n5Ghu2GmEl5NJIV6O9sZQ==",
- "license": "MIT",
- "dependencies": {
- "tslib": "^2.8.0"
- }
- },
- "node_modules/@formatjs/icu-messageformat-parser": {
- "version": "2.11.4",
- "resolved": "https://registry.npmjs.org/@formatjs/icu-messageformat-parser/-/icu-messageformat-parser-2.11.4.tgz",
- "integrity": "sha512-7kR78cRrPNB4fjGFZg3Rmj5aah8rQj9KPzuLsmcSn4ipLXQvC04keycTI1F7kJYDwIXtT2+7IDEto842CfZBtw==",
- "license": "MIT",
- "dependencies": {
- "@formatjs/ecma402-abstract": "2.3.6",
- "@formatjs/icu-skeleton-parser": "1.8.16",
- "tslib": "^2.8.0"
- }
- },
- "node_modules/@formatjs/icu-skeleton-parser": {
- "version": "1.8.16",
- "resolved": "https://registry.npmjs.org/@formatjs/icu-skeleton-parser/-/icu-skeleton-parser-1.8.16.tgz",
- "integrity": "sha512-H13E9Xl+PxBd8D5/6TVUluSpxGNvFSlN/b3coUp0e0JpuWXXnQDiavIpY3NnvSp4xhEMoXyyBvVfdFX8jglOHQ==",
- "license": "MIT",
- "dependencies": {
- "@formatjs/ecma402-abstract": "2.3.6",
- "tslib": "^2.8.0"
- }
- },
- "node_modules/@formatjs/intl-localematcher": {
- "version": "0.6.2",
- "resolved": "https://registry.npmjs.org/@formatjs/intl-localematcher/-/intl-localematcher-0.6.2.tgz",
- "integrity": "sha512-XOMO2Hupl0wdd172Y06h6kLpBz6Dv+J4okPLl4LPtzbr8f66WbIoy4ev98EBuZ6ZK4h5ydTN6XneT4QVpD7cdA==",
- "license": "MIT",
- "dependencies": {
- "tslib": "^2.8.0"
- }
- },
- "node_modules/@gusto/embedded-api": {
- "version": "0.12.4",
- "resolved": "https://registry.npmjs.org/@gusto/embedded-api/-/embedded-api-0.12.4.tgz",
- "integrity": "sha512-xYlRcfZhb7qllQDV2ASKCXMONZ2onTyCnHR8Bi+IXGm8MErUrOwxVMe+RysP/0u717ArBumoNtYxiVlykYT5Aw==",
- "dependencies": {
- "zod": "^3.25.0 || ^4.0.0"
- },
- "peerDependencies": {
- "@tanstack/react-query": "^5",
- "react": "^18 || ^19",
- "react-dom": "^18 || ^19"
- },
- "peerDependenciesMeta": {
- "@tanstack/react-query": {
- "optional": true
- },
- "react": {
- "optional": true
- },
- "react-dom": {
- "optional": true
- }
- }
- },
- "node_modules/@gusto/embedded-react-sdk": {
- "version": "0.34.0",
- "resolved": "file:gusto-embedded-react-sdk-0.34.0.tgz",
- "integrity": "sha512-HODOYlJ8A2EJ3XwsVuLwquOeqzFGIvCmIKQk75lqDxFnOS1RTvngjiigAck+DEdtuufIb259rEjfbcnpcF3mxg==",
- "license": "MIT",
- "dependencies": {
- "@gusto/embedded-api": "^0.12.2",
- "@hookform/error-message": "^2.0.1",
- "@hookform/resolvers": "^5.2.2",
- "@internationalized/date": "^3.12.0",
- "@internationalized/number": "^3.6.5",
- "classnames": "^2.5.1",
- "deepmerge": "^4.3.1",
- "dompurify": "^3.3.2",
- "i18next": "^25.8.17",
- "react-aria": "^3.47.0",
- "react-aria-components": "1.13.0",
- "react-error-boundary": "^6.1.1",
- "react-hook-form": "^7.71.2",
- "react-i18next": "^16.5.6",
- "react-robot": "^1.2.0",
- "robot3": "^1.2.0",
- "zod": "^4.3.6"
- },
- "peerDependencies": {
- "@tanstack/react-query": "^5",
- "react": "^18.0.0 || ^19.0.0",
- "react-dom": "^18.0.0 || ^19.0.0",
- "typescript": "^5.8.3"
- }
- },
- "node_modules/@hookform/error-message": {
- "version": "2.0.1",
- "resolved": "https://registry.npmjs.org/@hookform/error-message/-/error-message-2.0.1.tgz",
- "integrity": "sha512-U410sAr92xgxT1idlu9WWOVjndxLdgPUHEB8Schr27C9eh7/xUnITWpCMF93s+lGiG++D4JnbSnrb5A21AdSNg==",
- "license": "MIT",
- "peerDependencies": {
- "react": ">=16.8.0",
- "react-dom": ">=16.8.0",
- "react-hook-form": "^7.0.0"
- }
- },
- "node_modules/@hookform/resolvers": {
- "version": "5.2.2",
- "resolved": "https://registry.npmjs.org/@hookform/resolvers/-/resolvers-5.2.2.tgz",
- "integrity": "sha512-A/IxlMLShx3KjV/HeTcTfaMxdwy690+L/ZADoeaTltLx+CVuzkeVIPuybK3jrRfw7YZnmdKsVVHAlEPIAEUNlA==",
- "license": "MIT",
- "dependencies": {
- "@standard-schema/utils": "^0.3.0"
- },
- "peerDependencies": {
- "react-hook-form": "^7.55.0"
- }
- },
- "node_modules/@internationalized/date": {
- "version": "3.12.0",
- "resolved": "https://registry.npmjs.org/@internationalized/date/-/date-3.12.0.tgz",
- "integrity": "sha512-/PyIMzK29jtXaGU23qTvNZxvBXRtKbNnGDFD+PY6CZw/Y8Ex8pFUzkuCJCG9aOqmShjqhS9mPqP6Dk5onQY8rQ==",
- "license": "Apache-2.0",
- "dependencies": {
- "@swc/helpers": "^0.5.0"
- }
- },
- "node_modules/@internationalized/message": {
- "version": "3.1.8",
- "resolved": "https://registry.npmjs.org/@internationalized/message/-/message-3.1.8.tgz",
- "integrity": "sha512-Rwk3j/TlYZhn3HQ6PyXUV0XP9Uv42jqZGNegt0BXlxjE6G3+LwHjbQZAGHhCnCPdaA6Tvd3ma/7QzLlLkJxAWA==",
- "license": "Apache-2.0",
- "dependencies": {
- "@swc/helpers": "^0.5.0",
- "intl-messageformat": "^10.1.0"
- }
- },
- "node_modules/@internationalized/number": {
- "version": "3.6.5",
- "resolved": "https://registry.npmjs.org/@internationalized/number/-/number-3.6.5.tgz",
- "integrity": "sha512-6hY4Kl4HPBvtfS62asS/R22JzNNy8vi/Ssev7x6EobfCp+9QIB2hKvI2EtbdJ0VSQacxVNtqhE/NmF/NZ0gm6g==",
- "license": "Apache-2.0",
- "dependencies": {
- "@swc/helpers": "^0.5.0"
- }
- },
- "node_modules/@internationalized/string": {
- "version": "3.2.7",
- "resolved": "https://registry.npmjs.org/@internationalized/string/-/string-3.2.7.tgz",
- "integrity": "sha512-D4OHBjrinH+PFZPvfCXvG28n2LSykWcJ7GIioQL+ok0LON15SdfoUssoHzzOUmVZLbRoREsQXVzA6r8JKsbP6A==",
- "license": "Apache-2.0",
- "dependencies": {
- "@swc/helpers": "^0.5.0"
- }
- },
- "node_modules/@react-aria/autocomplete": {
- "version": "3.0.0-rc.3",
- "resolved": "https://registry.npmjs.org/@react-aria/autocomplete/-/autocomplete-3.0.0-rc.3.tgz",
- "integrity": "sha512-vemf7h3hvIDk3MxiiPryysfYgJDg8R72X46dRIeg0+cXKYxjPYou64/DTucSV2z5J6RC5JalINu0jIDaLhEILw==",
- "license": "Apache-2.0",
- "dependencies": {
- "@react-aria/combobox": "^3.14.0",
- "@react-aria/focus": "^3.21.2",
- "@react-aria/i18n": "^3.12.13",
- "@react-aria/interactions": "^3.25.6",
- "@react-aria/listbox": "^3.15.0",
- "@react-aria/searchfield": "^3.8.9",
- "@react-aria/textfield": "^3.18.2",
- "@react-aria/utils": "^3.31.0",
- "@react-stately/autocomplete": "3.0.0-beta.3",
- "@react-stately/combobox": "^3.12.0",
- "@react-types/autocomplete": "3.0.0-alpha.35",
- "@react-types/button": "^3.14.1",
- "@react-types/shared": "^3.32.1",
- "@swc/helpers": "^0.5.0"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1",
- "react-dom": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-aria/breadcrumbs": {
- "version": "3.5.32",
- "resolved": "https://registry.npmjs.org/@react-aria/breadcrumbs/-/breadcrumbs-3.5.32.tgz",
- "integrity": "sha512-S61vh5DJ2PXiXUwD7gk+pvS/b4VPrc3ZJOUZ0yVRLHkVESr5LhIZH+SAVgZkm1lzKyMRG+BH+fiRH/DZRSs7SA==",
- "license": "Apache-2.0",
- "dependencies": {
- "@react-aria/i18n": "^3.12.16",
- "@react-aria/link": "^3.8.9",
- "@react-aria/utils": "^3.33.1",
- "@react-types/breadcrumbs": "^3.7.19",
- "@react-types/shared": "^3.33.1",
- "@swc/helpers": "^0.5.0"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1",
- "react-dom": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-aria/button": {
- "version": "3.14.5",
- "resolved": "https://registry.npmjs.org/@react-aria/button/-/button-3.14.5.tgz",
- "integrity": "sha512-ZuLx+wQj9VQhH9BYe7t0JowmKnns2XrFHFNvIVBb5RwxL+CIycIOL7brhWKg2rGdxvlOom7jhVbcjSmtAaSyaQ==",
- "license": "Apache-2.0",
- "dependencies": {
- "@react-aria/interactions": "^3.27.1",
- "@react-aria/toolbar": "3.0.0-beta.24",
- "@react-aria/utils": "^3.33.1",
- "@react-stately/toggle": "^3.9.5",
- "@react-types/button": "^3.15.1",
- "@react-types/shared": "^3.33.1",
- "@swc/helpers": "^0.5.0"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1",
- "react-dom": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-aria/calendar": {
- "version": "3.9.5",
- "resolved": "https://registry.npmjs.org/@react-aria/calendar/-/calendar-3.9.5.tgz",
- "integrity": "sha512-k0kvceYdZZu+DoeqephtlmIvh1CxqdFyoN52iqVzTz9O0pe5Xfhq7zxPGbeCp4pC61xzp8Lu/6uFA/YNfQQNag==",
- "license": "Apache-2.0",
- "dependencies": {
- "@internationalized/date": "^3.12.0",
- "@react-aria/i18n": "^3.12.16",
- "@react-aria/interactions": "^3.27.1",
- "@react-aria/live-announcer": "^3.4.4",
- "@react-aria/utils": "^3.33.1",
- "@react-stately/calendar": "^3.9.3",
- "@react-types/button": "^3.15.1",
- "@react-types/calendar": "^3.8.3",
- "@react-types/shared": "^3.33.1",
- "@swc/helpers": "^0.5.0"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1",
- "react-dom": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-aria/checkbox": {
- "version": "3.16.5",
- "resolved": "https://registry.npmjs.org/@react-aria/checkbox/-/checkbox-3.16.5.tgz",
- "integrity": "sha512-ZhUT7ELuD52hb+Zpzw0ElLQiVOd5sKYahrh+PK3vq13Wk5TedBscALpjuXetI4pwFfdmAM1Lhgcsrd8+6AmyvA==",
- "license": "Apache-2.0",
- "dependencies": {
- "@react-aria/form": "^3.1.5",
- "@react-aria/interactions": "^3.27.1",
- "@react-aria/label": "^3.7.25",
- "@react-aria/toggle": "^3.12.5",
- "@react-aria/utils": "^3.33.1",
- "@react-stately/checkbox": "^3.7.5",
- "@react-stately/form": "^3.2.4",
- "@react-stately/toggle": "^3.9.5",
- "@react-types/checkbox": "^3.10.4",
- "@react-types/shared": "^3.33.1",
- "@swc/helpers": "^0.5.0"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1",
- "react-dom": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-aria/collections": {
- "version": "3.0.3",
- "resolved": "https://registry.npmjs.org/@react-aria/collections/-/collections-3.0.3.tgz",
- "integrity": "sha512-lbC5DEbHeVFvVr4ke9y8D9Nynnr8G8UjVEBoFGRylpAaScU7SX1TN84QI+EjMbsdZ0/5P2H7gUTS+MYd+6U3Rg==",
- "license": "Apache-2.0",
- "dependencies": {
- "@react-aria/interactions": "^3.27.1",
- "@react-aria/ssr": "^3.9.10",
- "@react-aria/utils": "^3.33.1",
- "@react-types/shared": "^3.33.1",
- "@swc/helpers": "^0.5.0",
- "use-sync-external-store": "^1.6.0"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1",
- "react-dom": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-aria/color": {
- "version": "3.1.5",
- "resolved": "https://registry.npmjs.org/@react-aria/color/-/color-3.1.5.tgz",
- "integrity": "sha512-eysWdBRzE8WDhBzh1nfjyUgzseMokXGHjIoJo880T7IPJ8tTavfQni49pU1B2qWrNOWPyrwx4Bd9pzHyboxJSA==",
- "license": "Apache-2.0",
- "dependencies": {
- "@react-aria/i18n": "^3.12.16",
- "@react-aria/interactions": "^3.27.1",
- "@react-aria/numberfield": "^3.12.5",
- "@react-aria/slider": "^3.8.5",
- "@react-aria/spinbutton": "^3.7.2",
- "@react-aria/textfield": "^3.18.5",
- "@react-aria/utils": "^3.33.1",
- "@react-aria/visually-hidden": "^3.8.31",
- "@react-stately/color": "^3.9.5",
- "@react-stately/form": "^3.2.4",
- "@react-types/color": "^3.1.4",
- "@react-types/shared": "^3.33.1",
- "@swc/helpers": "^0.5.0"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1",
- "react-dom": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-aria/combobox": {
- "version": "3.15.0",
- "resolved": "https://registry.npmjs.org/@react-aria/combobox/-/combobox-3.15.0.tgz",
- "integrity": "sha512-qSjQTFwKl3x1jCP2NRSJ6doZqAp6c2GTfoiFwWjaWg1IewwLsglaW6NnzqRDFiqFbDGgXPn4MqtC1VYEJ3NEjA==",
- "license": "Apache-2.0",
- "dependencies": {
- "@react-aria/focus": "^3.21.5",
- "@react-aria/i18n": "^3.12.16",
- "@react-aria/interactions": "^3.27.1",
- "@react-aria/listbox": "^3.15.3",
- "@react-aria/live-announcer": "^3.4.4",
- "@react-aria/menu": "^3.21.0",
- "@react-aria/overlays": "^3.31.2",
- "@react-aria/selection": "^3.27.2",
- "@react-aria/textfield": "^3.18.5",
- "@react-aria/utils": "^3.33.1",
- "@react-stately/collections": "^3.12.10",
- "@react-stately/combobox": "^3.13.0",
- "@react-stately/form": "^3.2.4",
- "@react-types/button": "^3.15.1",
- "@react-types/combobox": "^3.14.0",
- "@react-types/shared": "^3.33.1",
- "@swc/helpers": "^0.5.0"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1",
- "react-dom": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-aria/datepicker": {
- "version": "3.16.1",
- "resolved": "https://registry.npmjs.org/@react-aria/datepicker/-/datepicker-3.16.1.tgz",
- "integrity": "sha512-6BltCVWt09yefTkGjb2gViGCwoddx9HKJiZbY9u6Es/Q+VhwNJQRtczbnZ3K32p262hIknukNf/5nZaCOI1AKA==",
- "license": "Apache-2.0",
- "dependencies": {
- "@internationalized/date": "^3.12.0",
- "@internationalized/number": "^3.6.5",
- "@internationalized/string": "^3.2.7",
- "@react-aria/focus": "^3.21.5",
- "@react-aria/form": "^3.1.5",
- "@react-aria/i18n": "^3.12.16",
- "@react-aria/interactions": "^3.27.1",
- "@react-aria/label": "^3.7.25",
- "@react-aria/spinbutton": "^3.7.2",
- "@react-aria/utils": "^3.33.1",
- "@react-stately/datepicker": "^3.16.1",
- "@react-stately/form": "^3.2.4",
- "@react-types/button": "^3.15.1",
- "@react-types/calendar": "^3.8.3",
- "@react-types/datepicker": "^3.13.5",
- "@react-types/dialog": "^3.5.24",
- "@react-types/shared": "^3.33.1",
- "@swc/helpers": "^0.5.0"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1",
- "react-dom": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-aria/dialog": {
- "version": "3.5.34",
- "resolved": "https://registry.npmjs.org/@react-aria/dialog/-/dialog-3.5.34.tgz",
- "integrity": "sha512-/x53Q5ynpW5Kv9637WYu7SrDfj3woSp6jJRj8l6teGnWW/iNZWYJETgzHfbxx+HPKYATCZesRoIeO2LnYIXyEA==",
- "license": "Apache-2.0",
- "dependencies": {
- "@react-aria/interactions": "^3.27.1",
- "@react-aria/overlays": "^3.31.2",
- "@react-aria/utils": "^3.33.1",
- "@react-types/dialog": "^3.5.24",
- "@react-types/shared": "^3.33.1",
- "@swc/helpers": "^0.5.0"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1",
- "react-dom": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-aria/disclosure": {
- "version": "3.1.3",
- "resolved": "https://registry.npmjs.org/@react-aria/disclosure/-/disclosure-3.1.3.tgz",
- "integrity": "sha512-S3k7Wqrj+x0sWcP88Z1stSr5TIZmKEmx2rU7RB1O1/jPpbw5mgKnjtiriOlTh+kwdK11FkeqgxyHzAcBAR+FMQ==",
- "license": "Apache-2.0",
- "dependencies": {
- "@react-aria/ssr": "^3.9.10",
- "@react-aria/utils": "^3.33.1",
- "@react-stately/disclosure": "^3.0.11",
- "@react-types/button": "^3.15.1",
- "@swc/helpers": "^0.5.0"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1",
- "react-dom": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-aria/dnd": {
- "version": "3.11.6",
- "resolved": "https://registry.npmjs.org/@react-aria/dnd/-/dnd-3.11.6.tgz",
- "integrity": "sha512-4YLHUeYJleF+moAYaYt8UZqujudPvpoaHR+QMkWIFzhfridVUhCr6ZjGWrzpSZY3r68k46TG7YCsi4IEiNnysw==",
- "license": "Apache-2.0",
- "dependencies": {
- "@internationalized/string": "^3.2.7",
- "@react-aria/i18n": "^3.12.16",
- "@react-aria/interactions": "^3.27.1",
- "@react-aria/live-announcer": "^3.4.4",
- "@react-aria/overlays": "^3.31.2",
- "@react-aria/utils": "^3.33.1",
- "@react-stately/collections": "^3.12.10",
- "@react-stately/dnd": "^3.7.4",
- "@react-types/button": "^3.15.1",
- "@react-types/shared": "^3.33.1",
- "@swc/helpers": "^0.5.0"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1",
- "react-dom": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-aria/focus": {
- "version": "3.21.5",
- "resolved": "https://registry.npmjs.org/@react-aria/focus/-/focus-3.21.5.tgz",
- "integrity": "sha512-V18fwCyf8zqgJdpLQeDU5ZRNd9TeOfBbhLgmX77Zr5ae9XwaoJ1R3SFJG1wCJX60t34AW+aLZSEEK+saQElf3Q==",
- "license": "Apache-2.0",
- "dependencies": {
- "@react-aria/interactions": "^3.27.1",
- "@react-aria/utils": "^3.33.1",
- "@react-types/shared": "^3.33.1",
- "@swc/helpers": "^0.5.0",
- "clsx": "^2.0.0"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1",
- "react-dom": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-aria/form": {
- "version": "3.1.5",
- "resolved": "https://registry.npmjs.org/@react-aria/form/-/form-3.1.5.tgz",
- "integrity": "sha512-BWlONgHn8hmaMkcS6AgMSLQeNqVBwqPNLhdqjDO/PCfzvV7O8NZw/dFeIzJwfG4aBfSpbHHRdXGdfrk3d8dylQ==",
- "license": "Apache-2.0",
- "dependencies": {
- "@react-aria/interactions": "^3.27.1",
- "@react-aria/utils": "^3.33.1",
- "@react-stately/form": "^3.2.4",
- "@react-types/shared": "^3.33.1",
- "@swc/helpers": "^0.5.0"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1",
- "react-dom": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-aria/grid": {
- "version": "3.14.8",
- "resolved": "https://registry.npmjs.org/@react-aria/grid/-/grid-3.14.8.tgz",
- "integrity": "sha512-X6rRFKDu/Kh6Sv8FBap3vjcb+z4jXkSOwkYnexIJp5kMTo5/Dqo55cCBio5B70Tanfv32Ev/6SpzYG7ryxnM9w==",
- "license": "Apache-2.0",
- "dependencies": {
- "@react-aria/focus": "^3.21.5",
- "@react-aria/i18n": "^3.12.16",
- "@react-aria/interactions": "^3.27.1",
- "@react-aria/live-announcer": "^3.4.4",
- "@react-aria/selection": "^3.27.2",
- "@react-aria/utils": "^3.33.1",
- "@react-stately/collections": "^3.12.10",
- "@react-stately/grid": "^3.11.9",
- "@react-stately/selection": "^3.20.9",
- "@react-types/checkbox": "^3.10.4",
- "@react-types/grid": "^3.3.8",
- "@react-types/shared": "^3.33.1",
- "@swc/helpers": "^0.5.0"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1",
- "react-dom": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-aria/gridlist": {
- "version": "3.14.4",
- "resolved": "https://registry.npmjs.org/@react-aria/gridlist/-/gridlist-3.14.4.tgz",
- "integrity": "sha512-C/SbwC0qagZatoBrCjx8iZUex9apaJ8o8iRJ9eVHz0cpj7mXg6HuuotYGmDy9q67A2hve4I693RM1Cuwqwm+PQ==",
- "license": "Apache-2.0",
- "dependencies": {
- "@react-aria/focus": "^3.21.5",
- "@react-aria/grid": "^3.14.8",
- "@react-aria/i18n": "^3.12.16",
- "@react-aria/interactions": "^3.27.1",
- "@react-aria/selection": "^3.27.2",
- "@react-aria/utils": "^3.33.1",
- "@react-stately/list": "^3.13.4",
- "@react-stately/tree": "^3.9.6",
- "@react-types/shared": "^3.33.1",
- "@swc/helpers": "^0.5.0"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1",
- "react-dom": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-aria/i18n": {
- "version": "3.12.16",
- "resolved": "https://registry.npmjs.org/@react-aria/i18n/-/i18n-3.12.16.tgz",
- "integrity": "sha512-Km2CAz6MFQOUEaattaW+2jBdWOHUF8WX7VQoNbjlqElCP58nSaqi9yxTWUDRhAcn8/xFUnkFh4MFweNgtrHuEA==",
- "license": "Apache-2.0",
- "dependencies": {
- "@internationalized/date": "^3.12.0",
- "@internationalized/message": "^3.1.8",
- "@internationalized/number": "^3.6.5",
- "@internationalized/string": "^3.2.7",
- "@react-aria/ssr": "^3.9.10",
- "@react-aria/utils": "^3.33.1",
- "@react-types/shared": "^3.33.1",
- "@swc/helpers": "^0.5.0"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1",
- "react-dom": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-aria/interactions": {
- "version": "3.27.1",
- "resolved": "https://registry.npmjs.org/@react-aria/interactions/-/interactions-3.27.1.tgz",
- "integrity": "sha512-M3wLpTTmDflI0QGNK0PJNUaBXXfeBXue8ZxLMngfc1piHNiH4G5lUvWd9W14XVbqrSCVY8i8DfGrNYpyyZu0tw==",
- "license": "Apache-2.0",
- "dependencies": {
- "@react-aria/ssr": "^3.9.10",
- "@react-aria/utils": "^3.33.1",
- "@react-stately/flags": "^3.1.2",
- "@react-types/shared": "^3.33.1",
- "@swc/helpers": "^0.5.0"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1",
- "react-dom": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-aria/label": {
- "version": "3.7.25",
- "resolved": "https://registry.npmjs.org/@react-aria/label/-/label-3.7.25.tgz",
- "integrity": "sha512-oNK3Pqj4LDPwEbQaoM/uCip4QvQmmwGOh08VeW+vzSi6TAwf+KoWTyH/tiAeB0CHWNDK0k3e1iTygTAt4wzBmg==",
- "license": "Apache-2.0",
- "dependencies": {
- "@react-aria/utils": "^3.33.1",
- "@react-types/shared": "^3.33.1",
- "@swc/helpers": "^0.5.0"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1",
- "react-dom": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-aria/landmark": {
- "version": "3.0.10",
- "resolved": "https://registry.npmjs.org/@react-aria/landmark/-/landmark-3.0.10.tgz",
- "integrity": "sha512-GpNjJaI8/a6WxYDZgzTCLYSzPM6xp2pxCIQ4udiGbTCtxx13Trmm0cPABvPtzELidgolCf05em9Phr+3G0eE8A==",
- "license": "Apache-2.0",
- "dependencies": {
- "@react-aria/utils": "^3.33.1",
- "@react-types/shared": "^3.33.1",
- "@swc/helpers": "^0.5.0",
- "use-sync-external-store": "^1.6.0"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1",
- "react-dom": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-aria/link": {
- "version": "3.8.9",
- "resolved": "https://registry.npmjs.org/@react-aria/link/-/link-3.8.9.tgz",
- "integrity": "sha512-UaAFBfs84/Qq6TxlMWkREqqNY6SFLukot+z2Aa1kC+VyStv1kWG6sE5QLjm4SBn1Q3CGRsefhB/5+taaIbB4Pw==",
- "license": "Apache-2.0",
- "dependencies": {
- "@react-aria/interactions": "^3.27.1",
- "@react-aria/utils": "^3.33.1",
- "@react-types/link": "^3.6.7",
- "@react-types/shared": "^3.33.1",
- "@swc/helpers": "^0.5.0"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1",
- "react-dom": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-aria/listbox": {
- "version": "3.15.3",
- "resolved": "https://registry.npmjs.org/@react-aria/listbox/-/listbox-3.15.3.tgz",
- "integrity": "sha512-C6YgiyrHS5sbS5UBdxGMhEs+EKJYotJgGVtl9l0ySXpBUXERiHJWLOyV7a8PwkUOmepbB4FaLD7Y9EUzGkrGlw==",
- "license": "Apache-2.0",
- "dependencies": {
- "@react-aria/interactions": "^3.27.1",
- "@react-aria/label": "^3.7.25",
- "@react-aria/selection": "^3.27.2",
- "@react-aria/utils": "^3.33.1",
- "@react-stately/collections": "^3.12.10",
- "@react-stately/list": "^3.13.4",
- "@react-types/listbox": "^3.7.6",
- "@react-types/shared": "^3.33.1",
- "@swc/helpers": "^0.5.0"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1",
- "react-dom": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-aria/live-announcer": {
- "version": "3.4.4",
- "resolved": "https://registry.npmjs.org/@react-aria/live-announcer/-/live-announcer-3.4.4.tgz",
- "integrity": "sha512-PTTBIjNRnrdJOIRTDGNifY2d//kA7GUAwRFJNOEwSNG4FW+Bq9awqLiflw0JkpyB0VNIwou6lqKPHZVLsGWOXA==",
- "license": "Apache-2.0",
- "dependencies": {
- "@swc/helpers": "^0.5.0"
- }
- },
- "node_modules/@react-aria/menu": {
- "version": "3.21.0",
- "resolved": "https://registry.npmjs.org/@react-aria/menu/-/menu-3.21.0.tgz",
- "integrity": "sha512-CKTVZ4izSE1eKIti6TbTtzJAUo+WT8O4JC0XZCYDBpa0f++lD19Kz9aY+iY1buv5xGI20gAfpO474E9oEd4aQA==",
- "license": "Apache-2.0",
- "dependencies": {
- "@react-aria/focus": "^3.21.5",
- "@react-aria/i18n": "^3.12.16",
- "@react-aria/interactions": "^3.27.1",
- "@react-aria/overlays": "^3.31.2",
- "@react-aria/selection": "^3.27.2",
- "@react-aria/utils": "^3.33.1",
- "@react-stately/collections": "^3.12.10",
- "@react-stately/menu": "^3.9.11",
- "@react-stately/selection": "^3.20.9",
- "@react-stately/tree": "^3.9.6",
- "@react-types/button": "^3.15.1",
- "@react-types/menu": "^3.10.7",
- "@react-types/shared": "^3.33.1",
- "@swc/helpers": "^0.5.0"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1",
- "react-dom": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-aria/meter": {
- "version": "3.4.30",
- "resolved": "https://registry.npmjs.org/@react-aria/meter/-/meter-3.4.30.tgz",
- "integrity": "sha512-ZmANKW7s/Z4QGylHi46nhwtQ47T1bfMsU9MysBu7ViXXNJ03F4b6JXCJlKL5o2goQ3NbfZ68GeWamIT0BWSgtw==",
- "license": "Apache-2.0",
- "dependencies": {
- "@react-aria/progress": "^3.4.30",
- "@react-types/meter": "^3.4.15",
- "@react-types/shared": "^3.33.1",
- "@swc/helpers": "^0.5.0"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1",
- "react-dom": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-aria/numberfield": {
- "version": "3.12.5",
- "resolved": "https://registry.npmjs.org/@react-aria/numberfield/-/numberfield-3.12.5.tgz",
- "integrity": "sha512-Fi41IUWXEHLFIeJ/LHuZ9Azs8J/P563fZi37GSBkIq5P1pNt1rPgJJng5CNn4KsHxwqadTRUlbbZwbZraWDtRg==",
- "license": "Apache-2.0",
- "dependencies": {
- "@react-aria/i18n": "^3.12.16",
- "@react-aria/interactions": "^3.27.1",
- "@react-aria/live-announcer": "^3.4.4",
- "@react-aria/spinbutton": "^3.7.2",
- "@react-aria/textfield": "^3.18.5",
- "@react-aria/utils": "^3.33.1",
- "@react-stately/form": "^3.2.4",
- "@react-stately/numberfield": "^3.11.0",
- "@react-types/button": "^3.15.1",
- "@react-types/numberfield": "^3.8.18",
- "@react-types/shared": "^3.33.1",
- "@swc/helpers": "^0.5.0"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1",
- "react-dom": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-aria/overlays": {
- "version": "3.31.2",
- "resolved": "https://registry.npmjs.org/@react-aria/overlays/-/overlays-3.31.2.tgz",
- "integrity": "sha512-78HYI08r6LvcfD34gyv19ArRIjy1qxOKuXl/jYnjLDyQzD4pVb634IQWcm0zt10RdKgyuH6HTqvuDOgZTLet7Q==",
- "license": "Apache-2.0",
- "dependencies": {
- "@react-aria/focus": "^3.21.5",
- "@react-aria/i18n": "^3.12.16",
- "@react-aria/interactions": "^3.27.1",
- "@react-aria/ssr": "^3.9.10",
- "@react-aria/utils": "^3.33.1",
- "@react-aria/visually-hidden": "^3.8.31",
- "@react-stately/flags": "^3.1.2",
- "@react-stately/overlays": "^3.6.23",
- "@react-types/button": "^3.15.1",
- "@react-types/overlays": "^3.9.4",
- "@react-types/shared": "^3.33.1",
- "@swc/helpers": "^0.5.0"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1",
- "react-dom": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-aria/progress": {
- "version": "3.4.30",
- "resolved": "https://registry.npmjs.org/@react-aria/progress/-/progress-3.4.30.tgz",
- "integrity": "sha512-S6OWVGgluSWYSd/A6O8CVjz83eeMUfkuWSra0ewAV9bmxZ7TP9pUmD3bGdqHZEl97nt5vHGjZ3eq/x8eCmzKhA==",
- "license": "Apache-2.0",
- "dependencies": {
- "@react-aria/i18n": "^3.12.16",
- "@react-aria/label": "^3.7.25",
- "@react-aria/utils": "^3.33.1",
- "@react-types/progress": "^3.5.18",
- "@react-types/shared": "^3.33.1",
- "@swc/helpers": "^0.5.0"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1",
- "react-dom": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-aria/radio": {
- "version": "3.12.5",
- "resolved": "https://registry.npmjs.org/@react-aria/radio/-/radio-3.12.5.tgz",
- "integrity": "sha512-8CCJKJzfozEiWBPO9QAATG1rBGJEJ+xoqvHf9LKU2sPFGsA2/SRnLs6LB9fCG5R3spvaK1xz0any1fjWPl7x8A==",
- "license": "Apache-2.0",
- "dependencies": {
- "@react-aria/focus": "^3.21.5",
- "@react-aria/form": "^3.1.5",
- "@react-aria/i18n": "^3.12.16",
- "@react-aria/interactions": "^3.27.1",
- "@react-aria/label": "^3.7.25",
- "@react-aria/utils": "^3.33.1",
- "@react-stately/radio": "^3.11.5",
- "@react-types/radio": "^3.9.4",
- "@react-types/shared": "^3.33.1",
- "@swc/helpers": "^0.5.0"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1",
- "react-dom": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-aria/searchfield": {
- "version": "3.8.12",
- "resolved": "https://registry.npmjs.org/@react-aria/searchfield/-/searchfield-3.8.12.tgz",
- "integrity": "sha512-kYlUHD/+mWzNroHoR8ojUxYBoMviRZn134WaKPFjfNUGZDOEuh4XzOoj+cjdJfe6N3mwTaYu6rJQtunSHIAfhA==",
- "license": "Apache-2.0",
- "dependencies": {
- "@react-aria/i18n": "^3.12.16",
- "@react-aria/textfield": "^3.18.5",
- "@react-aria/utils": "^3.33.1",
- "@react-stately/searchfield": "^3.5.19",
- "@react-types/button": "^3.15.1",
- "@react-types/searchfield": "^3.6.8",
- "@react-types/shared": "^3.33.1",
- "@swc/helpers": "^0.5.0"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1",
- "react-dom": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-aria/select": {
- "version": "3.17.3",
- "resolved": "https://registry.npmjs.org/@react-aria/select/-/select-3.17.3.tgz",
- "integrity": "sha512-u0UFWw0S7q9oiSbjetDpRoLLIcC+L89uYlm+YfCrdT8ntbQgABNiJRxdVvxnhR0fR6MC9ASTTvuQnNHNn52+1A==",
- "license": "Apache-2.0",
- "dependencies": {
- "@react-aria/form": "^3.1.5",
- "@react-aria/i18n": "^3.12.16",
- "@react-aria/interactions": "^3.27.1",
- "@react-aria/label": "^3.7.25",
- "@react-aria/listbox": "^3.15.3",
- "@react-aria/menu": "^3.21.0",
- "@react-aria/selection": "^3.27.2",
- "@react-aria/utils": "^3.33.1",
- "@react-aria/visually-hidden": "^3.8.31",
- "@react-stately/select": "^3.9.2",
- "@react-types/button": "^3.15.1",
- "@react-types/select": "^3.12.2",
- "@react-types/shared": "^3.33.1",
- "@swc/helpers": "^0.5.0"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1",
- "react-dom": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-aria/selection": {
- "version": "3.27.2",
- "resolved": "https://registry.npmjs.org/@react-aria/selection/-/selection-3.27.2.tgz",
- "integrity": "sha512-GbUSSLX/ciXix95KW1g+SLM9np7iXpIZrFDSXkC6oNx1uhy18eAcuTkeZE25+SY5USVUmEzjI3m/3JoSUcebbg==",
- "license": "Apache-2.0",
- "dependencies": {
- "@react-aria/focus": "^3.21.5",
- "@react-aria/i18n": "^3.12.16",
- "@react-aria/interactions": "^3.27.1",
- "@react-aria/utils": "^3.33.1",
- "@react-stately/selection": "^3.20.9",
- "@react-types/shared": "^3.33.1",
- "@swc/helpers": "^0.5.0"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1",
- "react-dom": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-aria/separator": {
- "version": "3.4.16",
- "resolved": "https://registry.npmjs.org/@react-aria/separator/-/separator-3.4.16.tgz",
- "integrity": "sha512-RCUtQhDGnPxKzyG8KM79yOB0fSiEf8r/rxShidOVnGLiBW2KFmBa22/Gfc4jnqg/keN3dxvkSGoqmeXgctyp6g==",
- "license": "Apache-2.0",
- "dependencies": {
- "@react-aria/utils": "^3.33.1",
- "@react-types/shared": "^3.33.1",
- "@swc/helpers": "^0.5.0"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1",
- "react-dom": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-aria/slider": {
- "version": "3.8.5",
- "resolved": "https://registry.npmjs.org/@react-aria/slider/-/slider-3.8.5.tgz",
- "integrity": "sha512-gqkJxznk141mE0JamXF5CXml9PDbPkBz8dyKlihtWHWX4yhEbVYdC9J0otE7iCR3zx69Bm7WHoTGL0BsdpKzVA==",
- "license": "Apache-2.0",
- "dependencies": {
- "@react-aria/i18n": "^3.12.16",
- "@react-aria/interactions": "^3.27.1",
- "@react-aria/label": "^3.7.25",
- "@react-aria/utils": "^3.33.1",
- "@react-stately/slider": "^3.7.5",
- "@react-types/shared": "^3.33.1",
- "@react-types/slider": "^3.8.4",
- "@swc/helpers": "^0.5.0"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1",
- "react-dom": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-aria/spinbutton": {
- "version": "3.7.2",
- "resolved": "https://registry.npmjs.org/@react-aria/spinbutton/-/spinbutton-3.7.2.tgz",
- "integrity": "sha512-adjE1wNCWlugvAtVXlXWPtIG9JWurEgYVn1Eeyh19x038+oXGvOsOAoKCXM+SnGleTWQ9J7pEZITFoEI3cVfAw==",
- "license": "Apache-2.0",
- "dependencies": {
- "@react-aria/i18n": "^3.12.16",
- "@react-aria/live-announcer": "^3.4.4",
- "@react-aria/utils": "^3.33.1",
- "@react-types/button": "^3.15.1",
- "@react-types/shared": "^3.33.1",
- "@swc/helpers": "^0.5.0"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1",
- "react-dom": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-aria/ssr": {
- "version": "3.9.10",
- "resolved": "https://registry.npmjs.org/@react-aria/ssr/-/ssr-3.9.10.tgz",
- "integrity": "sha512-hvTm77Pf+pMBhuBm760Li0BVIO38jv1IBws1xFm1NoL26PU+fe+FMW5+VZWyANR6nYL65joaJKZqOdTQMkO9IQ==",
- "license": "Apache-2.0",
- "dependencies": {
- "@swc/helpers": "^0.5.0"
- },
- "engines": {
- "node": ">= 12"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-aria/switch": {
- "version": "3.7.11",
- "resolved": "https://registry.npmjs.org/@react-aria/switch/-/switch-3.7.11.tgz",
- "integrity": "sha512-dYVX71HiepBsKyeMaQgHbhqI+MQ3MVoTd5EnTbUjefIBnmQZavYj1/e4NUiUI4Ix+/C0HxL8ibDAv4NlSW3eLQ==",
- "license": "Apache-2.0",
- "dependencies": {
- "@react-aria/toggle": "^3.12.5",
- "@react-stately/toggle": "^3.9.5",
- "@react-types/shared": "^3.33.1",
- "@react-types/switch": "^3.5.17",
- "@swc/helpers": "^0.5.0"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1",
- "react-dom": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-aria/table": {
- "version": "3.17.11",
- "resolved": "https://registry.npmjs.org/@react-aria/table/-/table-3.17.11.tgz",
- "integrity": "sha512-GkYmWPiW3OM+FUZxdS33teHXHXde7TjHuYgDDaG9phvg6cQTQjGilJozrzA3OfftTOq5VB8XcKTIQW3c0tpYsQ==",
- "license": "Apache-2.0",
- "dependencies": {
- "@react-aria/focus": "^3.21.5",
- "@react-aria/grid": "^3.14.8",
- "@react-aria/i18n": "^3.12.16",
- "@react-aria/interactions": "^3.27.1",
- "@react-aria/live-announcer": "^3.4.4",
- "@react-aria/utils": "^3.33.1",
- "@react-aria/visually-hidden": "^3.8.31",
- "@react-stately/collections": "^3.12.10",
- "@react-stately/flags": "^3.1.2",
- "@react-stately/table": "^3.15.4",
- "@react-types/checkbox": "^3.10.4",
- "@react-types/grid": "^3.3.8",
- "@react-types/shared": "^3.33.1",
- "@react-types/table": "^3.13.6",
- "@swc/helpers": "^0.5.0"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1",
- "react-dom": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-aria/tabs": {
- "version": "3.11.1",
- "resolved": "https://registry.npmjs.org/@react-aria/tabs/-/tabs-3.11.1.tgz",
- "integrity": "sha512-3Ppz7yaEDW9L7p9PE9yNOl5caLwNnnLQqI+MX/dwbWlw9HluHS7uIjb21oswNl6UbSxAWyENOka45+KN4Fkh7A==",
- "license": "Apache-2.0",
- "dependencies": {
- "@react-aria/focus": "^3.21.5",
- "@react-aria/i18n": "^3.12.16",
- "@react-aria/selection": "^3.27.2",
- "@react-aria/utils": "^3.33.1",
- "@react-stately/tabs": "^3.8.9",
- "@react-types/shared": "^3.33.1",
- "@react-types/tabs": "^3.3.22",
- "@swc/helpers": "^0.5.0"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1",
- "react-dom": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-aria/tag": {
- "version": "3.8.1",
- "resolved": "https://registry.npmjs.org/@react-aria/tag/-/tag-3.8.1.tgz",
- "integrity": "sha512-VonpO++F8afXGDWc9VUxAc2wefyJpp1n9OGpbnB7zmqWiuPwO/RixjUdcH7iJkiC4vADwx9uLnhyD6kcwGV2ig==",
- "license": "Apache-2.0",
- "dependencies": {
- "@react-aria/gridlist": "^3.14.4",
- "@react-aria/i18n": "^3.12.16",
- "@react-aria/interactions": "^3.27.1",
- "@react-aria/label": "^3.7.25",
- "@react-aria/selection": "^3.27.2",
- "@react-aria/utils": "^3.33.1",
- "@react-stately/list": "^3.13.4",
- "@react-types/button": "^3.15.1",
- "@react-types/shared": "^3.33.1",
- "@swc/helpers": "^0.5.0"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1",
- "react-dom": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-aria/textfield": {
- "version": "3.18.5",
- "resolved": "https://registry.npmjs.org/@react-aria/textfield/-/textfield-3.18.5.tgz",
- "integrity": "sha512-ttwVSuwoV3RPaG2k2QzEXKeQNQ3mbdl/2yy6I4Tjrn1ZNkYHfVyJJ26AjenfSmj1kkTQoSAfZ8p+7rZp4n0xoQ==",
- "license": "Apache-2.0",
- "dependencies": {
- "@react-aria/form": "^3.1.5",
- "@react-aria/interactions": "^3.27.1",
- "@react-aria/label": "^3.7.25",
- "@react-aria/utils": "^3.33.1",
- "@react-stately/form": "^3.2.4",
- "@react-stately/utils": "^3.11.0",
- "@react-types/shared": "^3.33.1",
- "@react-types/textfield": "^3.12.8",
- "@swc/helpers": "^0.5.0"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1",
- "react-dom": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-aria/toast": {
- "version": "3.0.11",
- "resolved": "https://registry.npmjs.org/@react-aria/toast/-/toast-3.0.11.tgz",
- "integrity": "sha512-2DjZjBAvm8/CWbnZ6s7LjkYCkULKtjMve6GvhPTq98AthuEDLEiBvM1wa3xdecCRhZyRT1g6DXqVca0EfZ9fJA==",
- "license": "Apache-2.0",
- "dependencies": {
- "@react-aria/i18n": "^3.12.16",
- "@react-aria/interactions": "^3.27.1",
- "@react-aria/landmark": "^3.0.10",
- "@react-aria/utils": "^3.33.1",
- "@react-stately/toast": "^3.1.3",
- "@react-types/button": "^3.15.1",
- "@react-types/shared": "^3.33.1",
- "@swc/helpers": "^0.5.0"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1",
- "react-dom": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-aria/toggle": {
- "version": "3.12.5",
- "resolved": "https://registry.npmjs.org/@react-aria/toggle/-/toggle-3.12.5.tgz",
- "integrity": "sha512-XXVFLzcV8fr9mz7y/wfxEAhWvaBZ9jSfhCMuxH2bsivO7nTcMJ1jb4g2xJNwZgne17bMWNc7mKvW5dbsdlI6BA==",
- "license": "Apache-2.0",
- "dependencies": {
- "@react-aria/interactions": "^3.27.1",
- "@react-aria/utils": "^3.33.1",
- "@react-stately/toggle": "^3.9.5",
- "@react-types/checkbox": "^3.10.4",
- "@react-types/shared": "^3.33.1",
- "@swc/helpers": "^0.5.0"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1",
- "react-dom": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-aria/toolbar": {
- "version": "3.0.0-beta.24",
- "resolved": "https://registry.npmjs.org/@react-aria/toolbar/-/toolbar-3.0.0-beta.24.tgz",
- "integrity": "sha512-B2Rmpko7Ghi2RbNfsGdbR7I+RQBDhPGVE4bU3/EwHz+P/vNe5LyGPTeSwqaOMsQTF9lKNCkY8424dVTCr6RUMg==",
- "license": "Apache-2.0",
- "dependencies": {
- "@react-aria/focus": "^3.21.5",
- "@react-aria/i18n": "^3.12.16",
- "@react-aria/utils": "^3.33.1",
- "@react-types/shared": "^3.33.1",
- "@swc/helpers": "^0.5.0"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1",
- "react-dom": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-aria/tooltip": {
- "version": "3.9.2",
- "resolved": "https://registry.npmjs.org/@react-aria/tooltip/-/tooltip-3.9.2.tgz",
- "integrity": "sha512-VrgkPwHiEnAnBhoQ4W7kfry/RfVuRWrUPaJSp0+wKM6u0gg2tmn7OFRDXTxBAm/omQUguIdIjRWg7sf3zHH82A==",
- "license": "Apache-2.0",
- "dependencies": {
- "@react-aria/interactions": "^3.27.1",
- "@react-aria/utils": "^3.33.1",
- "@react-stately/tooltip": "^3.5.11",
- "@react-types/shared": "^3.33.1",
- "@react-types/tooltip": "^3.5.2",
- "@swc/helpers": "^0.5.0"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1",
- "react-dom": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-aria/tree": {
- "version": "3.1.7",
- "resolved": "https://registry.npmjs.org/@react-aria/tree/-/tree-3.1.7.tgz",
- "integrity": "sha512-C54yH5NmsOFa2Q+cg6B1BPr5KUlU9vLIoBnVrgrH237FRSXQPIbcM4VpmITAHq1VR7w6ayyS1hgTwFxo67ykWQ==",
- "license": "Apache-2.0",
- "dependencies": {
- "@react-aria/gridlist": "^3.14.4",
- "@react-aria/i18n": "^3.12.16",
- "@react-aria/selection": "^3.27.2",
- "@react-aria/utils": "^3.33.1",
- "@react-stately/tree": "^3.9.6",
- "@react-types/button": "^3.15.1",
- "@react-types/shared": "^3.33.1",
- "@swc/helpers": "^0.5.0"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1",
- "react-dom": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-aria/utils": {
- "version": "3.33.1",
- "resolved": "https://registry.npmjs.org/@react-aria/utils/-/utils-3.33.1.tgz",
- "integrity": "sha512-kIx1Sj6bbAT0pdqCegHuPanR9zrLn5zMRiM7LN12rgRf55S19ptd9g3ncahArifYTRkfEU9VIn+q0HjfMqS9/w==",
- "license": "Apache-2.0",
- "dependencies": {
- "@react-aria/ssr": "^3.9.10",
- "@react-stately/flags": "^3.1.2",
- "@react-stately/utils": "^3.11.0",
- "@react-types/shared": "^3.33.1",
- "@swc/helpers": "^0.5.0",
- "clsx": "^2.0.0"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1",
- "react-dom": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-aria/virtualizer": {
- "version": "4.1.13",
- "resolved": "https://registry.npmjs.org/@react-aria/virtualizer/-/virtualizer-4.1.13.tgz",
- "integrity": "sha512-d5KS+p8GXGNRbGPRE/N6jtth3et3KssQIz52h2+CAoAh7C3vvR64kkTaGdeywClvM+fSo8FxJuBrdfQvqC2ktQ==",
- "license": "Apache-2.0",
- "dependencies": {
- "@react-aria/i18n": "^3.12.16",
- "@react-aria/interactions": "^3.27.1",
- "@react-aria/utils": "^3.33.1",
- "@react-stately/virtualizer": "^4.4.6",
- "@react-types/shared": "^3.33.1",
- "@swc/helpers": "^0.5.0"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1",
- "react-dom": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-aria/visually-hidden": {
- "version": "3.8.31",
- "resolved": "https://registry.npmjs.org/@react-aria/visually-hidden/-/visually-hidden-3.8.31.tgz",
- "integrity": "sha512-RTOHHa4n56a9A3criThqFHBifvZoV71+MCkSuNP2cKO662SUWjqKkd0tJt/mBRMEJPkys8K7Eirp6T8Wt5FFRA==",
- "license": "Apache-2.0",
- "dependencies": {
- "@react-aria/interactions": "^3.27.1",
- "@react-aria/utils": "^3.33.1",
- "@react-types/shared": "^3.33.1",
- "@swc/helpers": "^0.5.0"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1",
- "react-dom": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-stately/autocomplete": {
- "version": "3.0.0-beta.3",
- "resolved": "https://registry.npmjs.org/@react-stately/autocomplete/-/autocomplete-3.0.0-beta.3.tgz",
- "integrity": "sha512-YfP/TrvkOCp6j7oqpZxJSvmSeXn+XtbKSOiBOuo+m2zCIhW2ncThmDB9uAUOkpmikDv/LkGKni40RQE8USdGdA==",
- "license": "Apache-2.0",
- "dependencies": {
- "@react-stately/utils": "^3.10.8",
- "@swc/helpers": "^0.5.0"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-stately/calendar": {
- "version": "3.9.3",
- "resolved": "https://registry.npmjs.org/@react-stately/calendar/-/calendar-3.9.3.tgz",
- "integrity": "sha512-uw7fCZXoypSBBUsVkbNvJMQWTihZReRbyLIGG3o/ZM630N3OCZhb/h4Uxke4pNu7n527H0V1bAnZgAldIzOYqg==",
- "license": "Apache-2.0",
- "dependencies": {
- "@internationalized/date": "^3.12.0",
- "@react-stately/utils": "^3.11.0",
- "@react-types/calendar": "^3.8.3",
- "@react-types/shared": "^3.33.1",
- "@swc/helpers": "^0.5.0"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-stately/checkbox": {
- "version": "3.7.5",
- "resolved": "https://registry.npmjs.org/@react-stately/checkbox/-/checkbox-3.7.5.tgz",
- "integrity": "sha512-K5R5ted7AxLB3sDkuVAazUdyRMraFT1imVqij2GuAiOUFvsZvbuocnDuFkBVKojyV3GpqLBvViV8IaCMc4hNIw==",
- "license": "Apache-2.0",
- "dependencies": {
- "@react-stately/form": "^3.2.4",
- "@react-stately/utils": "^3.11.0",
- "@react-types/checkbox": "^3.10.4",
- "@react-types/shared": "^3.33.1",
- "@swc/helpers": "^0.5.0"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-stately/collections": {
- "version": "3.12.10",
- "resolved": "https://registry.npmjs.org/@react-stately/collections/-/collections-3.12.10.tgz",
- "integrity": "sha512-wmF9VxJDyBujBuQ76vXj2g/+bnnj8fx5DdXgRmyfkkYhPB46+g2qnjbVGEvipo7bJuGxDftCUC4SN7l7xqUWfg==",
- "license": "Apache-2.0",
- "dependencies": {
- "@react-types/shared": "^3.33.1",
- "@swc/helpers": "^0.5.0"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-stately/color": {
- "version": "3.9.5",
- "resolved": "https://registry.npmjs.org/@react-stately/color/-/color-3.9.5.tgz",
- "integrity": "sha512-8pZxzXWDRuglzDwyTG7mLw2LQMCHIVNbVc9YmbsxbOjAL+lOqszo60KzyaFKVxeDQczSvrNTHcQZqlbNIC0eyQ==",
- "license": "Apache-2.0",
- "dependencies": {
- "@internationalized/number": "^3.6.5",
- "@internationalized/string": "^3.2.7",
- "@react-stately/form": "^3.2.4",
- "@react-stately/numberfield": "^3.11.0",
- "@react-stately/slider": "^3.7.5",
- "@react-stately/utils": "^3.11.0",
- "@react-types/color": "^3.1.4",
- "@react-types/shared": "^3.33.1",
- "@swc/helpers": "^0.5.0"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-stately/combobox": {
- "version": "3.13.0",
- "resolved": "https://registry.npmjs.org/@react-stately/combobox/-/combobox-3.13.0.tgz",
- "integrity": "sha512-dX9g/cK1hjLRjcbWVF6keHxTQDGhKGB2QAgPhWcBmOK3qJv+2dQqsJ6YCGWn/Y2N2acoEseLrAA7+Qe4HWV9cg==",
- "license": "Apache-2.0",
- "dependencies": {
- "@react-stately/collections": "^3.12.10",
- "@react-stately/form": "^3.2.4",
- "@react-stately/list": "^3.13.4",
- "@react-stately/overlays": "^3.6.23",
- "@react-stately/utils": "^3.11.0",
- "@react-types/combobox": "^3.14.0",
- "@react-types/shared": "^3.33.1",
- "@swc/helpers": "^0.5.0"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-stately/data": {
- "version": "3.15.2",
- "resolved": "https://registry.npmjs.org/@react-stately/data/-/data-3.15.2.tgz",
- "integrity": "sha512-BsmeeGgFwOGwo0g9Waprdyt+846n3KhKggZfpEnp5+sC4dE4uW1VIYpdyupMfr3bQcmX123q6TegfNP3eszrUA==",
- "license": "Apache-2.0",
- "dependencies": {
- "@react-types/shared": "^3.33.1",
- "@swc/helpers": "^0.5.0"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-stately/datepicker": {
- "version": "3.16.1",
- "resolved": "https://registry.npmjs.org/@react-stately/datepicker/-/datepicker-3.16.1.tgz",
- "integrity": "sha512-BtAMDvxd1OZxkxjqq5tN5TYmp6Hm8+o3+IDA4qmem2/pfQfVbOZeWS2WitcPBImj4n4T+W1A5+PI7mT/6DUBVg==",
- "license": "Apache-2.0",
- "dependencies": {
- "@internationalized/date": "^3.12.0",
- "@internationalized/number": "^3.6.5",
- "@internationalized/string": "^3.2.7",
- "@react-stately/form": "^3.2.4",
- "@react-stately/overlays": "^3.6.23",
- "@react-stately/utils": "^3.11.0",
- "@react-types/datepicker": "^3.13.5",
- "@react-types/shared": "^3.33.1",
- "@swc/helpers": "^0.5.0"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-stately/disclosure": {
- "version": "3.0.11",
- "resolved": "https://registry.npmjs.org/@react-stately/disclosure/-/disclosure-3.0.11.tgz",
- "integrity": "sha512-/KjB/0HkxGWbhFAPztCP411LUKZCx9k8cKukrlGqrUWyvrcXlmza90j0g/CuxACBoV+DJP9V+4q+8ide0x750A==",
- "license": "Apache-2.0",
- "dependencies": {
- "@react-stately/utils": "^3.11.0",
- "@react-types/shared": "^3.33.1",
- "@swc/helpers": "^0.5.0"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-stately/dnd": {
- "version": "3.7.4",
- "resolved": "https://registry.npmjs.org/@react-stately/dnd/-/dnd-3.7.4.tgz",
- "integrity": "sha512-YD0TVR5JkvTqskc1ouBpVKs6t/QS4RYCIyu8Ug8RgO122iIizuf2pfKnRLjYMdu5lXzBXGaIgd49dvnLzEXHIw==",
- "license": "Apache-2.0",
- "dependencies": {
- "@react-stately/selection": "^3.20.9",
- "@react-types/shared": "^3.33.1",
- "@swc/helpers": "^0.5.0"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-stately/flags": {
- "version": "3.1.2",
- "resolved": "https://registry.npmjs.org/@react-stately/flags/-/flags-3.1.2.tgz",
- "integrity": "sha512-2HjFcZx1MyQXoPqcBGALwWWmgFVUk2TuKVIQxCbRq7fPyWXIl6VHcakCLurdtYC2Iks7zizvz0Idv48MQ38DWg==",
- "license": "Apache-2.0",
- "dependencies": {
- "@swc/helpers": "^0.5.0"
- }
- },
- "node_modules/@react-stately/form": {
- "version": "3.2.4",
- "resolved": "https://registry.npmjs.org/@react-stately/form/-/form-3.2.4.tgz",
- "integrity": "sha512-qNBzun8SbLdgahryhKLqL1eqP+MXY6as82sVXYOOvUYLzgU5uuN8mObxYlxJgMI5akSdQJQV3RzyfVobPRE7Kw==",
- "license": "Apache-2.0",
- "dependencies": {
- "@react-types/shared": "^3.33.1",
- "@swc/helpers": "^0.5.0"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-stately/grid": {
- "version": "3.11.9",
- "resolved": "https://registry.npmjs.org/@react-stately/grid/-/grid-3.11.9.tgz",
- "integrity": "sha512-qQY6F+27iZRn30dt0ZOrSetUmbmNJ0pLe9Weuqw3+XDVSuWT+2O/rO1UUYeK+mO0Acjzdv+IWiYbu9RKf2wS9w==",
- "license": "Apache-2.0",
- "dependencies": {
- "@react-stately/collections": "^3.12.10",
- "@react-stately/selection": "^3.20.9",
- "@react-types/grid": "^3.3.8",
- "@react-types/shared": "^3.33.1",
- "@swc/helpers": "^0.5.0"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-stately/layout": {
- "version": "4.6.0",
- "resolved": "https://registry.npmjs.org/@react-stately/layout/-/layout-4.6.0.tgz",
- "integrity": "sha512-kBenEsP03nh5rKgfqlVMPcoKTJv0v92CTvrAb5gYY8t9g8LOwzdL89Yannq7f5xv8LFck/MmRQlotpMt2InETg==",
- "license": "Apache-2.0",
- "dependencies": {
- "@react-stately/collections": "^3.12.10",
- "@react-stately/table": "^3.15.4",
- "@react-stately/virtualizer": "^4.4.6",
- "@react-types/grid": "^3.3.8",
- "@react-types/shared": "^3.33.1",
- "@react-types/table": "^3.13.6",
- "@swc/helpers": "^0.5.0"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1",
- "react-dom": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-stately/list": {
- "version": "3.13.4",
- "resolved": "https://registry.npmjs.org/@react-stately/list/-/list-3.13.4.tgz",
- "integrity": "sha512-HHYSjA9VG7FPSAtpXAjQyM/V7qFHWGg88WmMrDt5QDlTBexwPuH0oFLnW0qaVZpAIxuWIsutZfxRAnme/NhhAA==",
- "license": "Apache-2.0",
- "dependencies": {
- "@react-stately/collections": "^3.12.10",
- "@react-stately/selection": "^3.20.9",
- "@react-stately/utils": "^3.11.0",
- "@react-types/shared": "^3.33.1",
- "@swc/helpers": "^0.5.0"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-stately/menu": {
- "version": "3.9.11",
- "resolved": "https://registry.npmjs.org/@react-stately/menu/-/menu-3.9.11.tgz",
- "integrity": "sha512-vYkpO9uV2OUecsIkrOc+Urdl/s1xw/ibNH/UXsp4PtjMnS6mK9q2kXZTM3WvMAKoh12iveUO+YkYCZQshmFLHQ==",
- "license": "Apache-2.0",
- "dependencies": {
- "@react-stately/overlays": "^3.6.23",
- "@react-types/menu": "^3.10.7",
- "@react-types/shared": "^3.33.1",
- "@swc/helpers": "^0.5.0"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-stately/numberfield": {
- "version": "3.11.0",
- "resolved": "https://registry.npmjs.org/@react-stately/numberfield/-/numberfield-3.11.0.tgz",
- "integrity": "sha512-rxfC047vL0LP4tanjinfjKAriAvdVL57Um5RUL5nHML8IOWCB3TBxegQkJ6to6goScC/oZhd0/Y2LSaiRuKbNw==",
- "license": "Apache-2.0",
- "dependencies": {
- "@internationalized/number": "^3.6.5",
- "@react-stately/form": "^3.2.4",
- "@react-stately/utils": "^3.11.0",
- "@react-types/numberfield": "^3.8.18",
- "@swc/helpers": "^0.5.0"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-stately/overlays": {
- "version": "3.6.23",
- "resolved": "https://registry.npmjs.org/@react-stately/overlays/-/overlays-3.6.23.tgz",
- "integrity": "sha512-RzWxots9A6gAzQMP4s8hOAHV7SbJRTFSlQbb6ly1nkWQXacOSZSFNGsKOaS0eIatfNPlNnW4NIkgtGws5UYzfw==",
- "license": "Apache-2.0",
- "dependencies": {
- "@react-stately/utils": "^3.11.0",
- "@react-types/overlays": "^3.9.4",
- "@swc/helpers": "^0.5.0"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-stately/radio": {
- "version": "3.11.5",
- "resolved": "https://registry.npmjs.org/@react-stately/radio/-/radio-3.11.5.tgz",
- "integrity": "sha512-QxA779S4ea5icQ0ja7CeiNzY1cj7c9G9TN0m7maAIGiTSinZl2Ia8naZJ0XcbRRp+LBll7RFEdekne15TjvS/w==",
- "license": "Apache-2.0",
- "dependencies": {
- "@react-stately/form": "^3.2.4",
- "@react-stately/utils": "^3.11.0",
- "@react-types/radio": "^3.9.4",
- "@react-types/shared": "^3.33.1",
- "@swc/helpers": "^0.5.0"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-stately/searchfield": {
- "version": "3.5.19",
- "resolved": "https://registry.npmjs.org/@react-stately/searchfield/-/searchfield-3.5.19.tgz",
- "integrity": "sha512-URllgjbtTQEaOCfddbHpJSPKOzG3pE3ajQHJ7Df8qCoHTjKfL6hnm/vp7X5sxPaZaN7VLZ5kAQxTE8hpo6s0+A==",
- "license": "Apache-2.0",
- "dependencies": {
- "@react-stately/utils": "^3.11.0",
- "@react-types/searchfield": "^3.6.8",
- "@swc/helpers": "^0.5.0"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-stately/select": {
- "version": "3.9.2",
- "resolved": "https://registry.npmjs.org/@react-stately/select/-/select-3.9.2.tgz",
- "integrity": "sha512-oWn0bijuusp8YI7FRM/wgtPVqiIrgU/ZUfLKe/qJUmT8D+JFaMAJnyrAzKpx98TrgamgtXynF78ccpopPhgrKQ==",
- "license": "Apache-2.0",
- "dependencies": {
- "@react-stately/form": "^3.2.4",
- "@react-stately/list": "^3.13.4",
- "@react-stately/overlays": "^3.6.23",
- "@react-stately/utils": "^3.11.0",
- "@react-types/select": "^3.12.2",
- "@react-types/shared": "^3.33.1",
- "@swc/helpers": "^0.5.0"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-stately/selection": {
- "version": "3.20.9",
- "resolved": "https://registry.npmjs.org/@react-stately/selection/-/selection-3.20.9.tgz",
- "integrity": "sha512-RhxRR5Wovg9EVi3pq7gBPK2BoKmP59tOXDMh2r1PbnGevg/7TNdR67DCEblcmXwHuBNS46ELfKdd0XGHqmS8nQ==",
- "license": "Apache-2.0",
- "dependencies": {
- "@react-stately/collections": "^3.12.10",
- "@react-stately/utils": "^3.11.0",
- "@react-types/shared": "^3.33.1",
- "@swc/helpers": "^0.5.0"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-stately/slider": {
- "version": "3.7.5",
- "resolved": "https://registry.npmjs.org/@react-stately/slider/-/slider-3.7.5.tgz",
- "integrity": "sha512-OrQMNR5xamLYH52TXtvTgyw3EMwv+JI+1istQgEj1CHBjC9eZZqn5iNCN20tzm+uDPTH0EIGULFjjPIumqYUQg==",
- "license": "Apache-2.0",
- "dependencies": {
- "@react-stately/utils": "^3.11.0",
- "@react-types/shared": "^3.33.1",
- "@react-types/slider": "^3.8.4",
- "@swc/helpers": "^0.5.0"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-stately/table": {
- "version": "3.15.4",
- "resolved": "https://registry.npmjs.org/@react-stately/table/-/table-3.15.4.tgz",
- "integrity": "sha512-fGaNyw3wv7JgRCNzgyDzpaaTFuSy5f4Qekch4UheMXDJX7dOeaMhUXeOfvnXCVg+BGM4ey/D82RvDOGvPy1Nww==",
- "license": "Apache-2.0",
- "dependencies": {
- "@react-stately/collections": "^3.12.10",
- "@react-stately/flags": "^3.1.2",
- "@react-stately/grid": "^3.11.9",
- "@react-stately/selection": "^3.20.9",
- "@react-stately/utils": "^3.11.0",
- "@react-types/grid": "^3.3.8",
- "@react-types/shared": "^3.33.1",
- "@react-types/table": "^3.13.6",
- "@swc/helpers": "^0.5.0"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-stately/tabs": {
- "version": "3.8.9",
- "resolved": "https://registry.npmjs.org/@react-stately/tabs/-/tabs-3.8.9.tgz",
- "integrity": "sha512-AQ4Xrn6YzIolaVShCV9cnwOjBKPAOGP/PTp7wpSEtQbQ0HZzUDG2RG/M4baMeUB2jZ33b7ifXyPcK78o0uOftg==",
- "license": "Apache-2.0",
- "dependencies": {
- "@react-stately/list": "^3.13.4",
- "@react-types/shared": "^3.33.1",
- "@react-types/tabs": "^3.3.22",
- "@swc/helpers": "^0.5.0"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-stately/toast": {
- "version": "3.1.3",
- "resolved": "https://registry.npmjs.org/@react-stately/toast/-/toast-3.1.3.tgz",
- "integrity": "sha512-mT9QJKmD523lqFpOp0VWZ6QHZENFK7HrodnNJDVc7g616s5GNmemdlkITV43fSY3tHeThCVvPu+Uzh7RvQ9mpQ==",
- "license": "Apache-2.0",
- "dependencies": {
- "@swc/helpers": "^0.5.0",
- "use-sync-external-store": "^1.6.0"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-stately/toggle": {
- "version": "3.9.5",
- "resolved": "https://registry.npmjs.org/@react-stately/toggle/-/toggle-3.9.5.tgz",
- "integrity": "sha512-PVzXc788q3jH98Kvw1LYDL+wpVC14dCEKjOku8cSaqhEof6AJGaLR9yq+EF1yYSL2dxI6z8ghc0OozY8WrcFcA==",
- "license": "Apache-2.0",
- "dependencies": {
- "@react-stately/utils": "^3.11.0",
- "@react-types/checkbox": "^3.10.4",
- "@react-types/shared": "^3.33.1",
- "@swc/helpers": "^0.5.0"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-stately/tooltip": {
- "version": "3.5.11",
- "resolved": "https://registry.npmjs.org/@react-stately/tooltip/-/tooltip-3.5.11.tgz",
- "integrity": "sha512-o8PnFXbvDCuVZ4Ht9ahfS6KHwIZjXopvoQ2vUPxv920irdgWEeC+4omgDOnJ/xFvcpmmJAmSsrQsTQrTguDUQA==",
- "license": "Apache-2.0",
- "dependencies": {
- "@react-stately/overlays": "^3.6.23",
- "@react-types/tooltip": "^3.5.2",
- "@swc/helpers": "^0.5.0"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-stately/tree": {
- "version": "3.9.6",
- "resolved": "https://registry.npmjs.org/@react-stately/tree/-/tree-3.9.6.tgz",
- "integrity": "sha512-JCuhGyX2A+PAMsx2pRSwArfqNFZJ9JSPkDaOQJS8MFPAsBe5HemvXsdmv9aBIMzlbCYcVq6EsrFnzbVVTBt/6w==",
- "license": "Apache-2.0",
- "dependencies": {
- "@react-stately/collections": "^3.12.10",
- "@react-stately/selection": "^3.20.9",
- "@react-stately/utils": "^3.11.0",
- "@react-types/shared": "^3.33.1",
- "@swc/helpers": "^0.5.0"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-stately/utils": {
- "version": "3.11.0",
- "resolved": "https://registry.npmjs.org/@react-stately/utils/-/utils-3.11.0.tgz",
- "integrity": "sha512-8LZpYowJ9eZmmYLpudbo/eclIRnbhWIJZ994ncmlKlouNzKohtM8qTC6B1w1pwUbiwGdUoyzLuQbeaIor5Dvcw==",
- "license": "Apache-2.0",
- "dependencies": {
- "@swc/helpers": "^0.5.0"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-stately/virtualizer": {
- "version": "4.4.6",
- "resolved": "https://registry.npmjs.org/@react-stately/virtualizer/-/virtualizer-4.4.6.tgz",
- "integrity": "sha512-9SfXgLFB61/8SXNLfg5ARx9jAK4m03Aw6/Cg8mdZN24SYarL4TKNRpfw8K/HHVU/bi6WHSJypk6Z/z19o/ztrg==",
- "license": "Apache-2.0",
- "dependencies": {
- "@react-types/shared": "^3.33.1",
- "@swc/helpers": "^0.5.0"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1",
- "react-dom": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-types/autocomplete": {
- "version": "3.0.0-alpha.35",
- "resolved": "https://registry.npmjs.org/@react-types/autocomplete/-/autocomplete-3.0.0-alpha.35.tgz",
- "integrity": "sha512-Wv5eU4WixfJ4M+fqvJUQqliWPbw7/VldRlgoJhqAlPwlNyLlHYwv5tlA64AySDXHGcSMIbzcS38LaHm44wt0AQ==",
- "license": "Apache-2.0",
- "dependencies": {
- "@react-types/combobox": "^3.13.9",
- "@react-types/searchfield": "^3.6.6",
- "@react-types/shared": "^3.32.1"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-types/breadcrumbs": {
- "version": "3.7.19",
- "resolved": "https://registry.npmjs.org/@react-types/breadcrumbs/-/breadcrumbs-3.7.19.tgz",
- "integrity": "sha512-AnkyYYmzaM2QFi/N0P/kQLM8tHOyFi7p397B/jEMucXDfwMw5Ny1ObCXeIEqbh8KrIa2Xp8SxmQlCV+8FPs4LA==",
- "license": "Apache-2.0",
- "dependencies": {
- "@react-types/link": "^3.6.7",
- "@react-types/shared": "^3.33.1"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-types/button": {
- "version": "3.15.1",
- "resolved": "https://registry.npmjs.org/@react-types/button/-/button-3.15.1.tgz",
- "integrity": "sha512-M1HtsKreJkigCnqceuIT22hDJBSStbPimnpmQmsl7SNyqCFY3+DHS7y/Sl3GvqCkzxF7j9UTL0dG38lGQ3K4xQ==",
- "license": "Apache-2.0",
- "dependencies": {
- "@react-types/shared": "^3.33.1"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-types/calendar": {
- "version": "3.8.3",
- "resolved": "https://registry.npmjs.org/@react-types/calendar/-/calendar-3.8.3.tgz",
- "integrity": "sha512-fpH6WNXotzH0TlKHXXxtjeLZ7ko0sbyHmwDAwmDFyP7T0Iwn1YQZ+lhceLifvynlxuOgX6oBItyUKmkHQ0FouQ==",
- "license": "Apache-2.0",
- "dependencies": {
- "@internationalized/date": "^3.12.0",
- "@react-types/shared": "^3.33.1"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-types/checkbox": {
- "version": "3.10.4",
- "resolved": "https://registry.npmjs.org/@react-types/checkbox/-/checkbox-3.10.4.tgz",
- "integrity": "sha512-tYCG0Pd1usEz5hjvBEYcqcA0youx930Rss1QBIse9TgMekA1c2WmPDNupYV8phpO8Zuej3DL1WfBeXcgavK8aw==",
- "license": "Apache-2.0",
- "dependencies": {
- "@react-types/shared": "^3.33.1"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-types/color": {
- "version": "3.1.4",
- "resolved": "https://registry.npmjs.org/@react-types/color/-/color-3.1.4.tgz",
- "integrity": "sha512-s+Xj4pvNBlJPpQ1Gr7bO1j4/tuwMUfdS9xIVFuiW5RvDsSybKTUJ/gqPzTxms94VDCRhLFocVn2STNdD2Erf6A==",
- "license": "Apache-2.0",
- "dependencies": {
- "@react-types/shared": "^3.33.1",
- "@react-types/slider": "^3.8.4"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-types/combobox": {
- "version": "3.14.0",
- "resolved": "https://registry.npmjs.org/@react-types/combobox/-/combobox-3.14.0.tgz",
- "integrity": "sha512-zmSSS7BcCOD8rGT8eGbVy7UlL5qq1vm88fFn4WgFe+lfK33ne+E7yTzTxcPY2TCGSo5fY6xMj3OG79FfVNGbSg==",
- "license": "Apache-2.0",
- "dependencies": {
- "@react-types/shared": "^3.33.1"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-types/datepicker": {
- "version": "3.13.5",
- "resolved": "https://registry.npmjs.org/@react-types/datepicker/-/datepicker-3.13.5.tgz",
- "integrity": "sha512-j28Vz+xvbb4bj7+9Xbpc4WTvSitlBvt7YEaEGM/8ZQ5g4Jr85H2KwkmDwjzmMN2r6VMQMMYq9JEcemq5wWpfUQ==",
- "license": "Apache-2.0",
- "dependencies": {
- "@internationalized/date": "^3.12.0",
- "@react-types/calendar": "^3.8.3",
- "@react-types/overlays": "^3.9.4",
- "@react-types/shared": "^3.33.1"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-types/dialog": {
- "version": "3.5.24",
- "resolved": "https://registry.npmjs.org/@react-types/dialog/-/dialog-3.5.24.tgz",
- "integrity": "sha512-NFurEP/zV0dA/41422lV1t+0oh6f/13n+VmLHZG8R13m1J3ql/kAXZ49zBSqkqANBO1ojyugWebk99IiR4pYOw==",
- "license": "Apache-2.0",
- "dependencies": {
- "@react-types/overlays": "^3.9.4",
- "@react-types/shared": "^3.33.1"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-types/form": {
- "version": "3.7.18",
- "resolved": "https://registry.npmjs.org/@react-types/form/-/form-3.7.18.tgz",
- "integrity": "sha512-0sBJW0+I9nJcF4SmKrYFEWAlehiebSTy7xqriqAXtqfTEdvzAYLGaAK2/7gx+wlNZeDTdW43CDRJ4XAhyhBqnw==",
- "license": "Apache-2.0",
- "dependencies": {
- "@react-types/shared": "^3.33.1"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-types/grid": {
- "version": "3.3.8",
- "resolved": "https://registry.npmjs.org/@react-types/grid/-/grid-3.3.8.tgz",
- "integrity": "sha512-zJvXH8gc1e1VH2H3LRnHH/W2HIkLkZMH3Cu5pLcj0vDuLBSWpcr3Ikh3jZ+VUOZF0G1Jt1lO8pKIaqFzDLNmLQ==",
- "license": "Apache-2.0",
- "dependencies": {
- "@react-types/shared": "^3.33.1"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-types/link": {
- "version": "3.6.7",
- "resolved": "https://registry.npmjs.org/@react-types/link/-/link-3.6.7.tgz",
- "integrity": "sha512-1apXCFJgMC1uydc2KNENrps1qR642FqDpwlNWe254UTpRZn/hEZhA6ImVr8WhomfLJu672WyWA0rUOv4HT+/pQ==",
- "license": "Apache-2.0",
- "dependencies": {
- "@react-types/shared": "^3.33.1"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-types/listbox": {
- "version": "3.7.6",
- "resolved": "https://registry.npmjs.org/@react-types/listbox/-/listbox-3.7.6.tgz",
- "integrity": "sha512-335NYElKEByXMalAmeRPyulKIDd2cjOCQhLwvv2BtxO5zaJfZnBbhZs+XPd9zwU6YomyOxODKSHrwbNDx+Jf3w==",
- "license": "Apache-2.0",
- "dependencies": {
- "@react-types/shared": "^3.33.1"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-types/menu": {
- "version": "3.10.7",
- "resolved": "https://registry.npmjs.org/@react-types/menu/-/menu-3.10.7.tgz",
- "integrity": "sha512-+p7ixZdvPDJZhisqdtWiiuJ9pteNfK5i19NB6wzAw5XkljbEzodNhwLv6rI96DY5XpbFso2kcjw7IWi+rAAGGQ==",
- "license": "Apache-2.0",
- "dependencies": {
- "@react-types/overlays": "^3.9.4",
- "@react-types/shared": "^3.33.1"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-types/meter": {
- "version": "3.4.15",
- "resolved": "https://registry.npmjs.org/@react-types/meter/-/meter-3.4.15.tgz",
- "integrity": "sha512-9WjNphhLLM+TA4Ev1y2MkpugJ5JjTXseHh7ZWWx2veq5DrXMZYclkRpfUrUdLVKvaBIPQCgpQIj0TcQi+quR9A==",
- "license": "Apache-2.0",
- "dependencies": {
- "@react-types/progress": "^3.5.18"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-types/numberfield": {
- "version": "3.8.18",
- "resolved": "https://registry.npmjs.org/@react-types/numberfield/-/numberfield-3.8.18.tgz",
- "integrity": "sha512-nLzk7YAG9yAUtSv+9R8LgCHsu8hJq8/A+m1KsKxvc8WmNJjIujSFgWvT21MWBiUgPBzJKGzAqpMDDa087mltJQ==",
- "license": "Apache-2.0",
- "dependencies": {
- "@react-types/shared": "^3.33.1"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-types/overlays": {
- "version": "3.9.4",
- "resolved": "https://registry.npmjs.org/@react-types/overlays/-/overlays-3.9.4.tgz",
- "integrity": "sha512-7Z9HaebMFyYBqtv3XVNHEmVkm7AiYviV7gv0c98elEN2Co+eQcKFGvwBM9Gy/lV57zlTqFX1EX/SAqkMEbCLOA==",
- "license": "Apache-2.0",
- "dependencies": {
- "@react-types/shared": "^3.33.1"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-types/progress": {
- "version": "3.5.18",
- "resolved": "https://registry.npmjs.org/@react-types/progress/-/progress-3.5.18.tgz",
- "integrity": "sha512-mKeQn+KrHr1y0/k7KtrbeDGDaERH6i4f6yBwj/ZtYDCTNKMO3tPHJY6nzF0w/KKZLplIO+BjUbHXc2RVm8ovwQ==",
- "license": "Apache-2.0",
- "dependencies": {
- "@react-types/shared": "^3.33.1"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-types/radio": {
- "version": "3.9.4",
- "resolved": "https://registry.npmjs.org/@react-types/radio/-/radio-3.9.4.tgz",
- "integrity": "sha512-TkMRY3sA1PcFZhhclu4IUzUTIir6MzNJj8h6WT8vO6Nug2kXJ72qigugVFBWJSE472mltduOErEAo0rtAYWbQA==",
- "license": "Apache-2.0",
- "dependencies": {
- "@react-types/shared": "^3.33.1"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-types/searchfield": {
- "version": "3.6.8",
- "resolved": "https://registry.npmjs.org/@react-types/searchfield/-/searchfield-3.6.8.tgz",
- "integrity": "sha512-M2p7OVdMTMDmlBcHd4N2uCBwg3uJSNM4lmEyf09YD44N5wDAI0yogk52QBwsnhpe+i2s65UwCYgunB+QltRX8A==",
- "license": "Apache-2.0",
- "dependencies": {
- "@react-types/shared": "^3.33.1",
- "@react-types/textfield": "^3.12.8"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-types/select": {
- "version": "3.12.2",
- "resolved": "https://registry.npmjs.org/@react-types/select/-/select-3.12.2.tgz",
- "integrity": "sha512-AseOjfr3qM1W1qIWcbAe6NFpwZluVeQX/dmu9BYxjcnVvtoBLPMbE5zX/BPbv+N5eFYjoMyj7Ug9dqnI+LrlGw==",
- "license": "Apache-2.0",
- "dependencies": {
- "@react-types/shared": "^3.33.1"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-types/shared": {
- "version": "3.33.1",
- "resolved": "https://registry.npmjs.org/@react-types/shared/-/shared-3.33.1.tgz",
- "integrity": "sha512-oJHtjvLG43VjwemQDadlR5g/8VepK56B/xKO2XORPHt9zlW6IZs3tZrYlvH29BMvoqC7RtE7E5UjgbnbFtDGag==",
- "license": "Apache-2.0",
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-types/slider": {
- "version": "3.8.4",
- "resolved": "https://registry.npmjs.org/@react-types/slider/-/slider-3.8.4.tgz",
- "integrity": "sha512-C+xFVvfKREai9S/ekBDCVaGPOQYkNUAsQhjQnNsUAATaox4I6IYLmcIgLmljpMQWqAe+gZiWsIwacRYMez2Tew==",
- "license": "Apache-2.0",
- "dependencies": {
- "@react-types/shared": "^3.33.1"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-types/switch": {
- "version": "3.5.17",
- "resolved": "https://registry.npmjs.org/@react-types/switch/-/switch-3.5.17.tgz",
- "integrity": "sha512-2GTPJvBCYI8YZ3oerHtXg+qikabIXCMJ6C2wcIJ5Xn0k9XOovowghfJi10OPB2GGyOiLBU74CczP5nx8adG90Q==",
- "license": "Apache-2.0",
- "dependencies": {
- "@react-types/shared": "^3.33.1"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-types/table": {
- "version": "3.13.6",
- "resolved": "https://registry.npmjs.org/@react-types/table/-/table-3.13.6.tgz",
- "integrity": "sha512-eluL+iFfnVmFm7OSZrrFG9AUjw+tcv898zbv+NsZACa8oXG1v9AimhZfd+Mo8q/5+sX/9hguWNXFkSvmTjuVPQ==",
- "license": "Apache-2.0",
- "dependencies": {
- "@react-types/grid": "^3.3.8",
- "@react-types/shared": "^3.33.1"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-types/tabs": {
- "version": "3.3.22",
- "resolved": "https://registry.npmjs.org/@react-types/tabs/-/tabs-3.3.22.tgz",
- "integrity": "sha512-HGwLD9dA3k3AGfRKGFBhNgxU9/LyRmxN0kxVj1ghA4L9S/qTOzS6GhrGNkGzsGxyVLV4JN8MLxjWN2o9QHnLEg==",
- "license": "Apache-2.0",
- "dependencies": {
- "@react-types/shared": "^3.33.1"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-types/textfield": {
- "version": "3.12.8",
- "resolved": "https://registry.npmjs.org/@react-types/textfield/-/textfield-3.12.8.tgz",
- "integrity": "sha512-wt6FcuE5AyntxsnPika/h3nf/DPmeAVbI018L9o6h+B/IL4sMWWdx663wx2KOOeHH8ejKGZQNPLhUKs4s1mVQA==",
- "license": "Apache-2.0",
- "dependencies": {
- "@react-types/shared": "^3.33.1"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@react-types/tooltip": {
- "version": "3.5.2",
- "resolved": "https://registry.npmjs.org/@react-types/tooltip/-/tooltip-3.5.2.tgz",
- "integrity": "sha512-FvSuZ2WP08NEWefrpCdBYpEEZh/5TvqvGjq0wqGzWg2OPwpc14HjD8aE7I3MOuylXkD4MSlMjl7J4DlvlcCs3Q==",
- "license": "Apache-2.0",
- "dependencies": {
- "@react-types/overlays": "^3.9.4",
- "@react-types/shared": "^3.33.1"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/@standard-schema/utils": {
- "version": "0.3.0",
- "resolved": "https://registry.npmjs.org/@standard-schema/utils/-/utils-0.3.0.tgz",
- "integrity": "sha512-e7Mew686owMaPJVNNLs55PUvgz371nKgwsc4vxE49zsODpJEnxgxRo2y/OKrqueavXgZNMDVj3DdHFlaSAeU8g==",
- "license": "MIT"
- },
- "node_modules/@swc/helpers": {
- "version": "0.5.19",
- "resolved": "https://registry.npmjs.org/@swc/helpers/-/helpers-0.5.19.tgz",
- "integrity": "sha512-QamiFeIK3txNjgUTNppE6MiG3p7TdninpZu0E0PbqVh1a9FNLT2FRhisaa4NcaX52XVhA5l7Pk58Ft7Sqi/2sA==",
- "license": "Apache-2.0",
- "dependencies": {
- "tslib": "^2.8.0"
- }
- },
- "node_modules/@tanstack/query-core": {
- "version": "5.91.0",
- "resolved": "https://registry.npmjs.org/@tanstack/query-core/-/query-core-5.91.0.tgz",
- "integrity": "sha512-FYXN8Kk9Q5VKuV6AIVaNwMThSi0nvAtR4X7HQoigf6ePOtFcavJYVIzgFhOVdtbBQtCJE3KimDIMMJM2DR1hjw==",
- "license": "MIT",
- "peer": true,
- "funding": {
- "type": "github",
- "url": "https://github.com/sponsors/tannerlinsley"
- }
- },
- "node_modules/@tanstack/react-query": {
- "version": "5.91.0",
- "resolved": "https://registry.npmjs.org/@tanstack/react-query/-/react-query-5.91.0.tgz",
- "integrity": "sha512-S8FODsDTNv0Ym+o/JVBvA6EWiWVhg6K2Q4qFehZyFKk6uW4H9OPbXl4kyiN9hAly0uHJ/1GEbR6kAI4MZWfjEA==",
- "license": "MIT",
- "peer": true,
- "dependencies": {
- "@tanstack/query-core": "5.91.0"
- },
- "funding": {
- "type": "github",
- "url": "https://github.com/sponsors/tannerlinsley"
- },
- "peerDependencies": {
- "react": "^18 || ^19"
- }
- },
- "node_modules/@types/trusted-types": {
- "version": "2.0.7",
- "resolved": "https://registry.npmjs.org/@types/trusted-types/-/trusted-types-2.0.7.tgz",
- "integrity": "sha512-ScaPdn1dQczgbl0QFTeTOmVHFULt394XJgOQNoyVhZ6r2vLnMLJfBPd53SB52T/3G36VI1/g2MZaX0cwDuXsfw==",
- "license": "MIT",
- "optional": true
- },
- "node_modules/classnames": {
- "version": "2.5.1",
- "resolved": "https://registry.npmjs.org/classnames/-/classnames-2.5.1.tgz",
- "integrity": "sha512-saHYOzhIQs6wy2sVxTM6bUDsQO4F50V9RQ22qBpEdCW+I+/Wmke2HOl6lS6dTpdxVhb88/I6+Hs+438c3lfUow==",
- "license": "MIT"
- },
- "node_modules/client-only": {
- "version": "0.0.1",
- "resolved": "https://registry.npmjs.org/client-only/-/client-only-0.0.1.tgz",
- "integrity": "sha512-IV3Ou0jSMzZrd3pZ48nLkT9DA7Ag1pnPzaiQhpW7c3RbcqqzvzzVu+L8gfqMp/8IM2MQtSiqaCxrrcfu8I8rMA==",
- "license": "MIT"
- },
- "node_modules/clsx": {
- "version": "2.1.1",
- "resolved": "https://registry.npmjs.org/clsx/-/clsx-2.1.1.tgz",
- "integrity": "sha512-eYm0QWBtUrBWZWG0d386OGAw16Z995PiOVo2B7bjWSbHedGl5e0ZWaq65kOGgUSNesEIDkB9ISbTg/JK9dhCZA==",
- "license": "MIT",
- "engines": {
- "node": ">=6"
- }
- },
- "node_modules/decimal.js": {
- "version": "10.6.0",
- "resolved": "https://registry.npmjs.org/decimal.js/-/decimal.js-10.6.0.tgz",
- "integrity": "sha512-YpgQiITW3JXGntzdUmyUR1V812Hn8T1YVXhCu+wO3OpS4eU9l4YdD3qjyiKdV6mvV29zapkMeD390UVEf2lkUg==",
- "license": "MIT"
- },
- "node_modules/deepmerge": {
- "version": "4.3.1",
- "resolved": "https://registry.npmjs.org/deepmerge/-/deepmerge-4.3.1.tgz",
- "integrity": "sha512-3sUqbMEc77XqpdNO7FRyRog+eW3ph+GYCbj+rK+uYyRMuwsVy0rMiVtPn+QJlKFvWP/1PYpapqYn0Me2knFn+A==",
- "license": "MIT",
- "engines": {
- "node": ">=0.10.0"
- }
- },
- "node_modules/dompurify": {
- "version": "3.3.3",
- "resolved": "https://registry.npmjs.org/dompurify/-/dompurify-3.3.3.tgz",
- "integrity": "sha512-Oj6pzI2+RqBfFG+qOaOLbFXLQ90ARpcGG6UePL82bJLtdsa6CYJD7nmiU8MW9nQNOtCHV3lZ/Bzq1X0QYbBZCA==",
- "license": "(MPL-2.0 OR Apache-2.0)",
- "optionalDependencies": {
- "@types/trusted-types": "^2.0.7"
- }
- },
- "node_modules/html-parse-stringify": {
- "version": "3.0.1",
- "resolved": "https://registry.npmjs.org/html-parse-stringify/-/html-parse-stringify-3.0.1.tgz",
- "integrity": "sha512-KknJ50kTInJ7qIScF3jeaFRpMpE8/lfiTdzf/twXyPBLAGrLRTmkz3AdTnKeh40X8k9L2fdYwEp/42WGXIRGcg==",
- "license": "MIT",
- "dependencies": {
- "void-elements": "3.1.0"
- }
- },
- "node_modules/i18next": {
- "version": "25.8.18",
- "resolved": "https://registry.npmjs.org/i18next/-/i18next-25.8.18.tgz",
- "integrity": "sha512-lzY5X83BiL5AP77+9DydbrqkQHFN9hUzWGjqjLpPcp5ZOzuu1aSoKaU3xbBLSjWx9dAzW431y+d+aogxOZaKRA==",
- "funding": [
- {
- "type": "individual",
- "url": "https://locize.com"
- },
- {
- "type": "individual",
- "url": "https://locize.com/i18next.html"
- },
- {
- "type": "individual",
- "url": "https://www.i18next.com/how-to/faq#i18next-is-awesome.-how-can-i-support-the-project"
- }
- ],
- "license": "MIT",
- "dependencies": {
- "@babel/runtime": "^7.28.6"
- },
- "peerDependencies": {
- "typescript": "^5"
- },
- "peerDependenciesMeta": {
- "typescript": {
- "optional": true
- }
- }
- },
- "node_modules/intl-messageformat": {
- "version": "10.7.18",
- "resolved": "https://registry.npmjs.org/intl-messageformat/-/intl-messageformat-10.7.18.tgz",
- "integrity": "sha512-m3Ofv/X/tV8Y3tHXLohcuVuhWKo7BBq62cqY15etqmLxg2DZ34AGGgQDeR+SCta2+zICb1NX83af0GJmbQ1++g==",
- "license": "BSD-3-Clause",
- "dependencies": {
- "@formatjs/ecma402-abstract": "2.3.6",
- "@formatjs/fast-memoize": "2.2.7",
- "@formatjs/icu-messageformat-parser": "2.11.4",
- "tslib": "^2.8.0"
- }
- },
- "node_modules/react": {
- "version": "19.2.4",
- "resolved": "https://registry.npmjs.org/react/-/react-19.2.4.tgz",
- "integrity": "sha512-9nfp2hYpCwOjAN+8TZFGhtWEwgvWHXqESH8qT89AT/lWklpLON22Lc8pEtnpsZz7VmawabSU0gCjnj8aC0euHQ==",
- "license": "MIT",
- "peer": true,
- "engines": {
- "node": ">=0.10.0"
- }
- },
- "node_modules/react-aria": {
- "version": "3.47.0",
- "resolved": "https://registry.npmjs.org/react-aria/-/react-aria-3.47.0.tgz",
- "integrity": "sha512-nvahimIqdByl/PXk/xPkG30LPRzcin+/Uk0uFfwbbKRRFC9aa22a6BRULZLqVHwa9GaNyKe6CDUxO1Dde4v0kA==",
- "license": "Apache-2.0",
- "dependencies": {
- "@internationalized/string": "^3.2.7",
- "@react-aria/breadcrumbs": "^3.5.32",
- "@react-aria/button": "^3.14.5",
- "@react-aria/calendar": "^3.9.5",
- "@react-aria/checkbox": "^3.16.5",
- "@react-aria/color": "^3.1.5",
- "@react-aria/combobox": "^3.15.0",
- "@react-aria/datepicker": "^3.16.1",
- "@react-aria/dialog": "^3.5.34",
- "@react-aria/disclosure": "^3.1.3",
- "@react-aria/dnd": "^3.11.6",
- "@react-aria/focus": "^3.21.5",
- "@react-aria/gridlist": "^3.14.4",
- "@react-aria/i18n": "^3.12.16",
- "@react-aria/interactions": "^3.27.1",
- "@react-aria/label": "^3.7.25",
- "@react-aria/landmark": "^3.0.10",
- "@react-aria/link": "^3.8.9",
- "@react-aria/listbox": "^3.15.3",
- "@react-aria/menu": "^3.21.0",
- "@react-aria/meter": "^3.4.30",
- "@react-aria/numberfield": "^3.12.5",
- "@react-aria/overlays": "^3.31.2",
- "@react-aria/progress": "^3.4.30",
- "@react-aria/radio": "^3.12.5",
- "@react-aria/searchfield": "^3.8.12",
- "@react-aria/select": "^3.17.3",
- "@react-aria/selection": "^3.27.2",
- "@react-aria/separator": "^3.4.16",
- "@react-aria/slider": "^3.8.5",
- "@react-aria/ssr": "^3.9.10",
- "@react-aria/switch": "^3.7.11",
- "@react-aria/table": "^3.17.11",
- "@react-aria/tabs": "^3.11.1",
- "@react-aria/tag": "^3.8.1",
- "@react-aria/textfield": "^3.18.5",
- "@react-aria/toast": "^3.0.11",
- "@react-aria/tooltip": "^3.9.2",
- "@react-aria/tree": "^3.1.7",
- "@react-aria/utils": "^3.33.1",
- "@react-aria/visually-hidden": "^3.8.31",
- "@react-types/shared": "^3.33.1"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1",
- "react-dom": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/react-aria-components": {
- "version": "1.13.0",
- "resolved": "https://registry.npmjs.org/react-aria-components/-/react-aria-components-1.13.0.tgz",
- "integrity": "sha512-t1mm3AVy/MjUJBZ7zrb+sFC5iya8Vvw3go3mGKtTm269bXGZho7BLA4IgT+0nOS3j+ku6ChVi8NEoQVFoYzJJA==",
- "license": "Apache-2.0",
- "dependencies": {
- "@internationalized/date": "^3.10.0",
- "@internationalized/string": "^3.2.7",
- "@react-aria/autocomplete": "3.0.0-rc.3",
- "@react-aria/collections": "^3.0.0",
- "@react-aria/dnd": "^3.11.3",
- "@react-aria/focus": "^3.21.2",
- "@react-aria/interactions": "^3.25.6",
- "@react-aria/live-announcer": "^3.4.4",
- "@react-aria/overlays": "^3.30.0",
- "@react-aria/ssr": "^3.9.10",
- "@react-aria/textfield": "^3.18.2",
- "@react-aria/toolbar": "3.0.0-beta.21",
- "@react-aria/utils": "^3.31.0",
- "@react-aria/virtualizer": "^4.1.10",
- "@react-stately/autocomplete": "3.0.0-beta.3",
- "@react-stately/layout": "^4.5.1",
- "@react-stately/selection": "^3.20.6",
- "@react-stately/table": "^3.15.1",
- "@react-stately/utils": "^3.10.8",
- "@react-stately/virtualizer": "^4.4.4",
- "@react-types/form": "^3.7.16",
- "@react-types/grid": "^3.3.6",
- "@react-types/shared": "^3.32.1",
- "@react-types/table": "^3.13.4",
- "@swc/helpers": "^0.5.0",
- "client-only": "^0.0.1",
- "react-aria": "^3.44.0",
- "react-stately": "^3.42.0",
- "use-sync-external-store": "^1.4.0"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1",
- "react-dom": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/react-aria-components/node_modules/@react-aria/toolbar": {
- "version": "3.0.0-beta.21",
- "resolved": "https://registry.npmjs.org/@react-aria/toolbar/-/toolbar-3.0.0-beta.21.tgz",
- "integrity": "sha512-yRCk/GD8g+BhdDgxd3I0a0c8Ni4Wyo6ERzfSoBkPkwQ4X2E2nkopmraM9D0fXw4UcIr4bnmvADzkHXtBN0XrBg==",
- "license": "Apache-2.0",
- "dependencies": {
- "@react-aria/focus": "^3.21.2",
- "@react-aria/i18n": "^3.12.13",
- "@react-aria/utils": "^3.31.0",
- "@react-types/shared": "^3.32.1",
- "@swc/helpers": "^0.5.0"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1",
- "react-dom": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/react-dom": {
- "version": "19.2.4",
- "resolved": "https://registry.npmjs.org/react-dom/-/react-dom-19.2.4.tgz",
- "integrity": "sha512-AXJdLo8kgMbimY95O2aKQqsz2iWi9jMgKJhRBAxECE4IFxfcazB2LmzloIoibJI3C12IlY20+KFaLv+71bUJeQ==",
- "license": "MIT",
- "peer": true,
- "dependencies": {
- "scheduler": "^0.27.0"
- },
- "peerDependencies": {
- "react": "^19.2.4"
- }
- },
- "node_modules/react-error-boundary": {
- "version": "6.1.1",
- "resolved": "https://registry.npmjs.org/react-error-boundary/-/react-error-boundary-6.1.1.tgz",
- "integrity": "sha512-BrYwPOdXi5mqkk5lw+Uvt0ThHx32rCt3BkukS4X23A2AIWDPSGX6iaWTc0y9TU/mHDA/6qOSGel+B2ERkOvD1w==",
- "license": "MIT",
- "peerDependencies": {
- "react": "^18.0.0 || ^19.0.0"
- }
- },
- "node_modules/react-hook-form": {
- "version": "7.71.2",
- "resolved": "https://registry.npmjs.org/react-hook-form/-/react-hook-form-7.71.2.tgz",
- "integrity": "sha512-1CHvcDYzuRUNOflt4MOq3ZM46AronNJtQ1S7tnX6YN4y72qhgiUItpacZUAQ0TyWYci3yz1X+rXaSxiuEm86PA==",
- "license": "MIT",
- "engines": {
- "node": ">=18.0.0"
- },
- "funding": {
- "type": "opencollective",
- "url": "https://opencollective.com/react-hook-form"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17 || ^18 || ^19"
- }
- },
- "node_modules/react-i18next": {
- "version": "16.5.8",
- "resolved": "https://registry.npmjs.org/react-i18next/-/react-i18next-16.5.8.tgz",
- "integrity": "sha512-2ABeHHlakxVY+LSirD+OiERxFL6+zip0PaHo979bgwzeHg27Sqc82xxXWIrSFmfWX0ZkrvXMHwhsi/NGUf5VQg==",
- "license": "MIT",
- "dependencies": {
- "@babel/runtime": "^7.28.4",
- "html-parse-stringify": "^3.0.1",
- "use-sync-external-store": "^1.6.0"
- },
- "peerDependencies": {
- "i18next": ">= 25.6.2",
- "react": ">= 16.8.0",
- "typescript": "^5"
- },
- "peerDependenciesMeta": {
- "react-dom": {
- "optional": true
- },
- "react-native": {
- "optional": true
- },
- "typescript": {
- "optional": true
- }
- }
- },
- "node_modules/react-robot": {
- "version": "1.2.1",
- "resolved": "https://registry.npmjs.org/react-robot/-/react-robot-1.2.1.tgz",
- "integrity": "sha512-FGX25Z1VFLxB05uFLRqg+MUqtcv1ZiugNjdIu35EYcJ0zDoc40H6yKi4VrEq+v49YTAa14khgTzRb+IM8YG/LA==",
- "license": "BSD-2-Clause",
- "dependencies": {
- "robot-hooks": "^1.1.0"
- },
- "peerDependencies": {
- "react": "^16.9.0 || ^17.0.0 || ^18.2.0 || ^19.0.0",
- "robot3": "^1.0.0"
- }
- },
- "node_modules/react-stately": {
- "version": "3.45.0",
- "resolved": "https://registry.npmjs.org/react-stately/-/react-stately-3.45.0.tgz",
- "integrity": "sha512-G3bYr0BIiookpt4H05VeZUuVS/FslQAj2TeT8vDfCiL314Y+LtPXIPe/a3eamCA0wljy7z1EDYKV50Qbz7pcJg==",
- "license": "Apache-2.0",
- "dependencies": {
- "@react-stately/calendar": "^3.9.3",
- "@react-stately/checkbox": "^3.7.5",
- "@react-stately/collections": "^3.12.10",
- "@react-stately/color": "^3.9.5",
- "@react-stately/combobox": "^3.13.0",
- "@react-stately/data": "^3.15.2",
- "@react-stately/datepicker": "^3.16.1",
- "@react-stately/disclosure": "^3.0.11",
- "@react-stately/dnd": "^3.7.4",
- "@react-stately/form": "^3.2.4",
- "@react-stately/list": "^3.13.4",
- "@react-stately/menu": "^3.9.11",
- "@react-stately/numberfield": "^3.11.0",
- "@react-stately/overlays": "^3.6.23",
- "@react-stately/radio": "^3.11.5",
- "@react-stately/searchfield": "^3.5.19",
- "@react-stately/select": "^3.9.2",
- "@react-stately/selection": "^3.20.9",
- "@react-stately/slider": "^3.7.5",
- "@react-stately/table": "^3.15.4",
- "@react-stately/tabs": "^3.8.9",
- "@react-stately/toast": "^3.1.3",
- "@react-stately/toggle": "^3.9.5",
- "@react-stately/tooltip": "^3.5.11",
- "@react-stately/tree": "^3.9.6",
- "@react-types/shared": "^3.33.1"
- },
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
- }
- },
- "node_modules/robot-hooks": {
- "version": "1.1.0",
- "resolved": "https://registry.npmjs.org/robot-hooks/-/robot-hooks-1.1.0.tgz",
- "integrity": "sha512-42LgnUjW0gL0CZw9v9GJz+JtjAG4L+IluuhlA0jRgmYH1L+JqcyKKRQ4RSrZgyFJcStOYPKSqd5GneCDkdzZhw==",
- "license": "BSD-2-Clause",
- "peerDependencies": {
- "robot3": "^1.0.2"
- }
- },
- "node_modules/robot3": {
- "version": "1.2.0",
- "resolved": "https://registry.npmjs.org/robot3/-/robot3-1.2.0.tgz",
- "integrity": "sha512-Xin8KHqCKrD9Rqk1ZzZQYjsb6S9DRggcfwBqnVPeM3DLtNCJLxWWTrPJDYm3E+ZiTO7H3VMdgyPSkIbuYnYP2Q==",
- "license": "BSD-2-Clause"
- },
- "node_modules/scheduler": {
- "version": "0.27.0",
- "resolved": "https://registry.npmjs.org/scheduler/-/scheduler-0.27.0.tgz",
- "integrity": "sha512-eNv+WrVbKu1f3vbYJT/xtiF5syA5HPIMtf9IgY/nKg0sWqzAUEvqY/xm7OcZc/qafLx/iO9FgOmeSAp4v5ti/Q==",
- "license": "MIT",
- "peer": true
- },
- "node_modules/tslib": {
- "version": "2.8.1",
- "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.8.1.tgz",
- "integrity": "sha512-oJFu94HQb+KVduSUQL7wnpmqnfmLsOA/nAh6b6EH0wCEoK0/mPeXU6c3wKDV83MkOuHPRHtSXKKU99IBazS/2w==",
- "license": "0BSD"
- },
- "node_modules/typescript": {
- "version": "5.9.3",
- "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.9.3.tgz",
- "integrity": "sha512-jl1vZzPDinLr9eUt3J/t7V6FgNEw9QjvBPdysz9KfQDD41fQrC2Y4vKQdiaUpFT4bXlb1RHhLpp8wtm6M5TgSw==",
- "license": "Apache-2.0",
- "peer": true,
- "bin": {
- "tsc": "bin/tsc",
- "tsserver": "bin/tsserver"
- },
- "engines": {
- "node": ">=14.17"
- }
- },
- "node_modules/use-sync-external-store": {
- "version": "1.6.0",
- "resolved": "https://registry.npmjs.org/use-sync-external-store/-/use-sync-external-store-1.6.0.tgz",
- "integrity": "sha512-Pp6GSwGP/NrPIrxVFAIkOQeyw8lFenOHijQWkUTrDvrF4ALqylP2C/KCkeS9dpUM3KvYRQhna5vt7IL95+ZQ9w==",
- "license": "MIT",
- "peerDependencies": {
- "react": "^16.8.0 || ^17.0.0 || ^18.0.0 || ^19.0.0"
- }
- },
- "node_modules/void-elements": {
- "version": "3.1.0",
- "resolved": "https://registry.npmjs.org/void-elements/-/void-elements-3.1.0.tgz",
- "integrity": "sha512-Dhxzh5HZuiHQhbvTW9AMetFfBHDMYpo23Uo9btPXgdYP+3T5S+p+jgNy7spra+veYhBP2dCSgxR/i2Y02h5/6w==",
- "license": "MIT",
- "engines": {
- "node": ">=0.10.0"
- }
- },
- "node_modules/zod": {
- "version": "4.3.6",
- "resolved": "https://registry.npmjs.org/zod/-/zod-4.3.6.tgz",
- "integrity": "sha512-rftlrkhHZOcjDwkGlnUtZZkvaPHCsDATp4pGpuOOMDaTdDDXF91wuVDJoWoPsKX/3YPQ5fHuF3STjcYyKr+Qhg==",
- "license": "MIT",
- "funding": {
- "url": "https://github.com/sponsors/colinhacks"
- }
- }
- }
-}
diff --git a/eslint.config.mjs b/eslint.config.mjs
index 445c6256c..3ec5e2f26 100644
--- a/eslint.config.mjs
+++ b/eslint.config.mjs
@@ -76,6 +76,7 @@ export default [
'**/.prettierrc.js',
'.storybook/**/*',
'storybook-static/**/*',
+ 'website/**/*',
],
},
{
diff --git a/website/docusaurus.config.ts b/website/docusaurus.config.ts
index f16b3a2d9..5e0c33990 100644
--- a/website/docusaurus.config.ts
+++ b/website/docusaurus.config.ts
@@ -1,8 +1,8 @@
-import type { Config } from '@docusaurus/types';
-import type * as Preset from '@docusaurus/preset-classic';
-import type * as Plugin from '@docusaurus/types/src/plugin';
-import type * as OpenApiPlugin from 'docusaurus-plugin-openapi-docs';
-import { themes as prismThemes } from 'prism-react-renderer';
+import type { Config } from '@docusaurus/types'
+import type * as Preset from '@docusaurus/preset-classic'
+import type * as Plugin from '@docusaurus/types/src/plugin'
+import type * as OpenApiPlugin from 'docusaurus-plugin-openapi-docs'
+import { themes as prismThemes } from 'prism-react-renderer'
const config: Config = {
title: 'Gusto Embedded',
@@ -66,9 +66,9 @@ const config: Config = {
path: require.resolve('path-browserify'),
},
},
- };
+ }
},
- };
+ }
},
[
'docusaurus-plugin-openapi-docs',
@@ -164,6 +164,6 @@ const config: Config = {
additionalLanguages: ['bash', 'json', 'ruby', 'python', 'java'],
},
} satisfies Preset.ThemeConfig,
-};
+}
-export default config;
+export default config
diff --git a/website/sidebars.ts b/website/sidebars.ts
index ee1fc005a..cb4366e4e 100644
--- a/website/sidebars.ts
+++ b/website/sidebars.ts
@@ -1,5 +1,5 @@
-import type { SidebarsConfig } from '@docusaurus/plugin-content-docs';
-import apiSidebar from '../docs/api/sidebar';
+import type { SidebarsConfig } from '@docusaurus/plugin-content-docs'
+import apiSidebar from '../docs/api/sidebar'
const sidebars: SidebarsConfig = {
docs: [
@@ -202,9 +202,7 @@ const sidebars: SidebarsConfig = {
{
type: 'category',
label: 'Flows',
- items: [
- 'components/information-requests/information-requests-flow',
- ],
+ items: ['components/information-requests/information-requests-flow'],
},
{
type: 'category',
@@ -259,6 +257,6 @@ const sidebars: SidebarsConfig = {
},
],
api: apiSidebar,
-};
+}
-export default sidebars;
+export default sidebars
diff --git a/website/src/css/custom.css b/website/src/css/custom.css
index df72e6ce0..4baeddf58 100644
--- a/website/src/css/custom.css
+++ b/website/src/css/custom.css
@@ -13,8 +13,9 @@ html {
--ifm-color-primary-lighter: #f7836d;
--ifm-color-primary-lightest: #faa595;
- --ifm-font-family-base: 'Inter', -apple-system, BlinkMacSystemFont, 'Segoe UI',
- Roboto, Oxygen, Ubuntu, Cantarell, 'Helvetica Neue', sans-serif;
+ --ifm-font-family-base:
+ 'Inter', -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Oxygen, Ubuntu, Cantarell,
+ 'Helvetica Neue', sans-serif;
--ifm-heading-font-family: var(--ifm-font-family-base);
--ifm-font-size-base: 15px;
--ifm-code-font-size: 95%;
@@ -103,7 +104,7 @@ html {
color: #ffffff;
}
-.navbar__link[href*="://"]::after {
+.navbar__link[href*='://']::after {
background-color: currentColor;
}
@@ -132,7 +133,9 @@ nav .search-bar-container input {
border: 1px solid rgba(255, 255, 255, 0.15);
color: #ffffff;
font-size: 0.85rem;
- transition: background-color 0.15s ease, border-color 0.15s ease;
+ transition:
+ background-color 0.15s ease,
+ border-color 0.15s ease;
}
.navbar .DocSearch-Button:hover,
@@ -165,7 +168,9 @@ nav .search-bar-container input:focus {
border-radius: 0;
padding: 7px 12px;
border-left: 3px solid transparent;
- transition: background-color 0.15s ease, color 0.15s ease,
+ transition:
+ background-color 0.15s ease,
+ color 0.15s ease,
border-color 0.15s ease;
}
@@ -361,13 +366,14 @@ code {
border-top: 1px solid rgba(255, 255, 255, 0.06);
}
-
/* ── Pagination ── */
.pagination-nav__link {
border-color: var(--gusto-pagination-border);
border-radius: 8px;
- transition: border-color 0.15s ease, box-shadow 0.15s ease;
+ transition:
+ border-color 0.15s ease,
+ box-shadow 0.15s ease;
}
.pagination-nav__link:hover {
@@ -496,7 +502,9 @@ code {
.docItemContainer article .card {
border-radius: 10px;
border: 1px solid #ebedf0;
- transition: border-color 0.15s ease, box-shadow 0.15s ease;
+ transition:
+ border-color 0.15s ease,
+ box-shadow 0.15s ease;
overflow: hidden;
}
diff --git a/website/src/pages/index.module.css b/website/src/pages/index.module.css
index 012664015..421801c69 100644
--- a/website/src/pages/index.module.css
+++ b/website/src/pages/index.module.css
@@ -91,7 +91,9 @@
font-weight: 600;
font-size: 1rem;
text-decoration: none;
- transition: background-color 0.15s ease, transform 0.1s ease;
+ transition:
+ background-color 0.15s ease,
+ transform 0.1s ease;
}
.heroPrimary:hover {
@@ -112,7 +114,10 @@
font-weight: 600;
font-size: 1rem;
text-decoration: none;
- transition: border-color 0.15s ease, color 0.15s ease, transform 0.1s ease;
+ transition:
+ border-color 0.15s ease,
+ color 0.15s ease,
+ transform 0.1s ease;
}
.heroSecondary:hover {
@@ -197,7 +202,9 @@
background-color: #faf9f8;
border: 1px solid #dfe1e5;
border-radius: 12px;
- transition: border-color 0.15s ease, box-shadow 0.15s ease;
+ transition:
+ border-color 0.15s ease,
+ box-shadow 0.15s ease;
}
.featureCard:hover {
@@ -301,7 +308,10 @@
border-radius: 10px;
text-decoration: none;
box-shadow: 0 1px 3px rgba(0, 0, 0, 0.04);
- transition: border-color 0.15s ease, box-shadow 0.15s ease, transform 0.1s ease;
+ transition:
+ border-color 0.15s ease,
+ box-shadow 0.15s ease,
+ transform 0.1s ease;
}
.quickLinkCard:hover {
diff --git a/website/src/pages/index.tsx b/website/src/pages/index.tsx
index 364dd7aec..123202043 100644
--- a/website/src/pages/index.tsx
+++ b/website/src/pages/index.tsx
@@ -1,13 +1,20 @@
-import Link from '@docusaurus/Link';
-import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
-import Layout from '@theme/Layout';
-import clsx from 'clsx';
-import type { ReactNode } from 'react';
-import styles from './index.module.css';
+import Link from '@docusaurus/Link'
+import useDocusaurusContext from '@docusaurus/useDocusaurusContext'
+import Layout from '@theme/Layout'
+import clsx from 'clsx'
+import type { ReactNode } from 'react'
+import styles from './index.module.css'
function WorkflowIcon({ className }: { className?: string }) {
return (
-
- A React component library for building embedded payroll experiences on
- top of the Gusto Embedded API.
+ A React component library for building embedded payroll experiences on top of the Gusto
+ Embedded API.
@@ -120,7 +173,7 @@ function HeroSection() {
- );
+ )
}
function FeaturesSection() {
@@ -128,7 +181,7 @@ function FeaturesSection() {