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! + +
+ + + + + + Company-level authentication + +
+ + + + + + + + +
+ Security Scheme Type: + + http +
+ HTTP Authorization Scheme: + + bearer +
+
+
+ + + System-level authentication + +
+ + + + + + + + +
+ Security Scheme Type: + + http +
+ HTTP Authorization Scheme: + + bearer +
+
+
+
+
+

+ Contact +

+ Developer Relations: [developer@gusto.com](mailto:developer@gusto.com) + +
+ \ No newline at end of file diff --git a/docs/api/holiday-pay-policies.tag.mdx b/docs/api/holiday-pay-policies.tag.mdx new file mode 100644 index 000000000..bd795d7ba --- /dev/null +++ b/docs/api/holiday-pay-policies.tag.mdx @@ -0,0 +1,20 @@ +--- +id: holiday-pay-policies +title: "Holiday Pay Policies" +description: "Holiday Pay Policies" +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/i-9-verification.tag.mdx b/docs/api/i-9-verification.tag.mdx new file mode 100644 index 000000000..3369b3e6b --- /dev/null +++ b/docs/api/i-9-verification.tag.mdx @@ -0,0 +1,20 @@ +--- +id: i-9-verification +title: "I-9 Verification" +description: "I-9 Verification" +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/industry-selection.tag.mdx b/docs/api/industry-selection.tag.mdx new file mode 100644 index 000000000..a3d2a6967 --- /dev/null +++ b/docs/api/industry-selection.tag.mdx @@ -0,0 +1,20 @@ +--- +id: industry-selection +title: "Industry Selection" +description: "Industry Selection" +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/information-requests.tag.mdx b/docs/api/information-requests.tag.mdx new file mode 100644 index 000000000..a39c86bdd --- /dev/null +++ b/docs/api/information-requests.tag.mdx @@ -0,0 +1,20 @@ +--- +id: information-requests +title: "Information Requests" +description: "Information Requests" +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/introspection.tag.mdx b/docs/api/introspection.tag.mdx new file mode 100644 index 000000000..3d6824222 --- /dev/null +++ b/docs/api/introspection.tag.mdx @@ -0,0 +1,20 @@ +--- +id: introspection +title: "Introspection" +description: "Introspection" +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/invoices.tag.mdx b/docs/api/invoices.tag.mdx new file mode 100644 index 000000000..84918f89f --- /dev/null +++ b/docs/api/invoices.tag.mdx @@ -0,0 +1,20 @@ +--- +id: invoices +title: "Invoices" +description: "Invoices" +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/jobs-and-compensations.tag.mdx b/docs/api/jobs-and-compensations.tag.mdx new file mode 100644 index 000000000..931e641d8 --- /dev/null +++ b/docs/api/jobs-and-compensations.tag.mdx @@ -0,0 +1,20 @@ +--- +id: jobs-and-compensations +title: "Jobs and Compensations" +description: "Jobs and Compensations" +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/locations.tag.mdx b/docs/api/locations.tag.mdx new file mode 100644 index 000000000..95bd8b5b9 --- /dev/null +++ b/docs/api/locations.tag.mdx @@ -0,0 +1,20 @@ +--- +id: locations +title: "Locations" +description: "Locations" +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/notifications.tag.mdx b/docs/api/notifications.tag.mdx new file mode 100644 index 000000000..9c3059745 --- /dev/null +++ b/docs/api/notifications.tag.mdx @@ -0,0 +1,20 @@ +--- +id: notifications +title: "Notifications" +description: "Notifications" +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/oauth-access-token.ParamsDetails.json b/docs/api/oauth-access-token.ParamsDetails.json new file mode 100644 index 000000000..0621f37c4 --- /dev/null +++ b/docs/api/oauth-access-token.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/oauth-access-token.RequestSchema.json b/docs/api/oauth-access-token.RequestSchema.json new file mode 100644 index 000000000..54e542f3b --- /dev/null +++ b/docs/api/oauth-access-token.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"Refresh Token Request","required":["client_id","client_secret","grant_type","refresh_token"],"properties":{"client_id":{"type":"string","description":"Your client ID","example":"qr6L_9FRkbMVL_GdwvrMW6Ef8tcU6NUxjWpOfqXqOG8"},"client_secret":{"type":"string","description":"Your client secret","example":"3aQSHRB3596nZhm6NdNBELZ1u9xbZmvCrKpBhbZYq6w"},"grant_type":{"type":"string","enum":["refresh_token"],"description":"Set system_access to create a system access token, refresh_token to refresh an existing token"},"refresh_token":{"type":"string","descrition":"The refresh token being exchanged for an access token code","example":"iEjL96L9Pndwmi-xVX3Q-xbrvvhnjHYGX87sopgGJ8E"},"redirect_uri":{"type":"string","description":"The redirect URI you set up via the Developer Portal"}}},{"type":"object","title":"System Access Token Request","required":["client_id","client_secret","grant_type"],"properties":{"client_id":{"type":"string","description":"Your client ID","example":"qr6L_9FRkbMVL_GdwvrMW6Ef8tcU6NUxjWpOfqXqOG8"},"client_secret":{"type":"string","description":"Your client secret","example":"3aQSHRB3596nZhm6NdNBELZ1u9xbZmvCrKpBhbZYq6w"},"grant_type":{"type":"string","description":"Set system_access to create a system access token, refresh_token to refresh an existing token","enum":["system_access"]}}}]}}}}} \ No newline at end of file diff --git a/docs/api/oauth-access-token.StatusCodes.json b/docs/api/oauth-access-token.StatusCodes.json new file mode 100644 index 000000000..a996e18d2 --- /dev/null +++ b/docs/api/oauth-access-token.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"description":"","type":"object","oneOf":[{"description":"","type":"object","required":["access_token","token_type","expires_in","created_at"],"properties":{"access_token":{"type":"string","description":"A new access token that can be used for subsequent authenticated requests"},"token_type":{"type":"string","default":"Bearer","description":"The literal string 'Bearer'"},"expires_in":{"type":"number","default":7200,"description":"The TTL of this token. After this amount of time, you must hit the refresh token endpoint to continue making authenticated requests."},"created_at":{"type":"number","description":"Datetime for when the new access token is created."},"refresh_token":{"type":["string","null"],"description":"A token that must be passed to the refresh token endpoint to get a new authenticated token. Only present when refresh token is provided."}},"title":"Create-Token-Authentication"},{"description":"","type":"object","allOf":[{"description":"","type":"object","required":["access_token","token_type","expires_in","created_at"],"properties":{"access_token":{"type":"string","description":"A new access token that can be used for subsequent authenticated requests"},"token_type":{"type":"string","default":"Bearer","description":"The literal string 'Bearer'"},"expires_in":{"type":"number","default":7200,"description":"The TTL of this token. After this amount of time, you must hit the refresh token endpoint to continue making authenticated requests."},"created_at":{"type":"number","description":"Datetime for when the new access token is created."},"refresh_token":{"type":["string","null"],"description":"A token that must be passed to the refresh token endpoint to get a new authenticated token. Only present when refresh token is provided."}},"title":"Create-Token-Authentication"},{"type":"object","properties":{"refresh_token":{"type":"string","description":"A token that must be passed to the refresh token endpoint to get a new authenticated token."},"scope":{"type":"string","description":"All of the scopes for which the access token provides access."}}}],"title":"Refresh-Token-Authentication"}],"x-examples":{"create_token":{"access_token":"As8qKfNObHbwe7abbJqF0WUF6iCQoIW2R664TFzXd-A","token_type":"Bearer","created_at":1767644464,"expires_in":7200},"refresh_token":{"access_token":"As8qKfNObHbwe7abbJqF0WUF6iCQoIW2R664TFzXd-A","refresh_token":"As8qKfNObHbwe7abbJqF0WUF6iCQoIW2R664TFzXd-A","scope":"public payroll:read","token_type":"Bearer","created_at":1767644464,"expires_in":7200}},"title":"Authentication"}}}}}} \ No newline at end of file diff --git a/docs/api/oauth-access-token.api.mdx b/docs/api/oauth-access-token.api.mdx new file mode 100644 index 000000000..7a8504617 --- /dev/null +++ b/docs/api/oauth-access-token.api.mdx @@ -0,0 +1,69 @@ +--- +id: oauth-access-token +title: "Create a System Access Token or Refresh an Access Token" +description: "Creates a system access token or refreshes an oauth access token" +sidebar_label: "Create a System Access Token or Refresh an Access Token" +hide_title: true +hide_table_of_contents: true +api: eJztWFtTGzcU/iuq+pB2ZhcTQgz4qYYQQkoD4RJIPIxHu3vsFexKi6Q1dj3+750jyeyubaBM2j50wgwY63J0bt+RzjelsgDFDJfiMKEdKllp0pDFMWgdGnkLggZUQ1wqbia007sOaAI6VrzALbRD9xQwA5owoifaQE7cXmL3EqmIgoECneISQaz4xhIa0HE4LLWRIRcGhk6X0EwKoJ0ehTyCJIGEBpQVRX2JptcBLZhiORhQmnZ6UypYDrRDr8IDK7B7chh+AaVR04ByVDcFloBCm+IUckY7U+qOotooLoY0oCDKHI/eWN94G663w9dvqbV6wMrM0E59fLbojXeoS84FaGJSIAkzEEZMQ0K6J4dk5HQhTGsZc2YgIffcpGQiS2UXxCzL1sjhgAgpgHBNCiVHPIEkcGtYUWQ8tua/0qSXc8HzMq/Lvv4lNabQnVYrkbFes45di2XemjsyLNhEySyz8y1W8NDv5GL4sxcY1oZ/RTVKDckanV1XsVL6ng1px6gSAqrgrgRtdmUyQYfiV64gmU/HUhgQBqdqBrRuNLpsWouEFHA8sIH0MZHRDcSGBtRwk+HAqUsmcm6z69SdS4PakT0aZxyE6XPMGf+/hlgBrhsqJkzfSsdNVljf5SFmk0IwGA4atankrEiSZti/YnDcenL4DnNozPLCanyn2kf9nfent9EfX476B8n9SP1x2d4fbJv4ov3pYnxzWRwP7q7ujg+2MZ2aCr/o4Acjq8PfsM9nH05337zdaYtvad7+lHza3T/69rrcGUff8tGe+r3YTaNvX+/a93h4zTtP4GLJbU2VzsD4UtB/wDmJbZVYXSQC0pCIy/0AVgwYc224GPpqMVsM26Mu8uqcp/AgzsmPAMXBOE6ZGEJCBlLhQY26FcsEGp7k+zdHO+2jnROR3Oc8HH+5evM5HEdqNErFzYevB1fbW1oWw4OP2/tOx4QriE2/VPz5KDod3Q5ycXqIYCcaDCkLMuLMlpJ3MIIM05OcSGVYRmezWfA4UM6cn7vOqH8ALj/g8Qw8/ksUVGBsnEGvZ7MZ/s4CatgQ70R6KIySuoDYKnaNsdeFFNoFcWN9HT8WdC+dtBdU7qYAzMOFvKxK+7NL68np7OrPrbaf8/IN44Ir0H2OM861SZ+Z5UxtCHk2cl0i4L5ZDUzKDIkZlg57FdqSoctII6CEIfioAWHQPZAQfxtqTJmawisPnr8pdoEp+yxZLgwZN6BYRtwu8sotfYXSax6opIsyj7woL31rY319leTz8yMiB8Sk3Bu6RroDA8qNsFyWwtgFPAf7ACF5qQ1JubEVqVlVQSSF5MLYPJfCcFECydkt6rzaP2sW0FXcVprQeFwxA6iLdf99agMDy9Hi2gMtWXviuuhVYRBlli3fY9168K3hEZCCaYy/kc94YAiGMKdaw3bv5mORTUihQGP2WEuaomovvzVq0ezLuntth7aeh91KNKqM18Gz4GJZ9gOHP3D4A4f/Lg4XsdQEwt98wf4HHsDA6Fj+nRdNN8tclgKxO7QPP49TO9iIvfea9qPoPOweF9q4R/xn20z/SnNPTevtyl3NQkK7evvu98Gn4+hDdA9bLIo+3r1fv7x43+Z7n+Xh5cZpu715/v7PqyTsNmtXDe/1/H+91d5qb25utjeb0Eb8rkrk71JnQdoLd/vY0aKMMh4T39t3FLDk+02t5ftiiNwbE8YGhLZcDN4otzChncfZnICOWFY+z+ogfpqiHNnwsB9ZBUySHEwqkbQqpO1qCmZS2qEtSzK1KvJKjeb8UKky5IA8Q8IK7giSMIHcsiTLpQ5yaRkqXQC7BaYnoZMXYt9DcZ/F+yOCV8o8UTJ5QmaB02jenHU7w1e2A8KezAsmJq6rw5jUYIuHz3kt/B6tvsq8iDDDfrJeE1zp8o3j95zgJDxywCyg2D2cVozR/rwda7SUL2oMl/rCF3V2zcZuAZDLAH0JE7BIBMxr6wzZyIG0vvUIs4wlMnmY556zbHCNAUVqUR8PzkCNeAy1fKtYPhbJ0rTswlYyZwxC+z2UA5tnuHUxZJeQxTIHvC+sHq802fcQJSeupliSMZFxmYMwNpg/+QaRxfbN4LnXiqc4hcxDOqCQM55ZwPjZ3yp8YE4ggnMmanL25r3yKiZDovSH5rg+tWjatOph/wmq2ueIgbFpFRnjFjIW/FNffnqOQp9XX3zPpFieOj06nSIVfKGy2QyH70pQnlIfMcVZhHnQu54Fc5LavtK5xomEdgYs0/CEdf9r6vkRz7trYjXd7y8LSqv7ZM85KzxvXEfL1Ea1A1OrME+urV9EJ8dn5zSgkSfCc2QRO1QxLDL41/ZZsnCowIcgjk1pxsSwZENc62Tiz18phvTr +sidebar_class_name: "post 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"; + + + + + + + + + + +Creates a system access token or refreshes an oauth access token + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/patch-v-1-companies-company-id-payrolls-id-partner-disbursements.ParamsDetails.json b/docs/api/patch-v-1-companies-company-id-payrolls-id-partner-disbursements.ParamsDetails.json new file mode 100644 index 000000000..5966b196e --- /dev/null +++ b/docs/api/patch-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/patch-v-1-companies-company-id-payrolls-id-partner-disbursements.RequestSchema.json b/docs/api/patch-v-1-companies-company-id-payrolls-id-partner-disbursements.RequestSchema.json new file mode 100644 index 000000000..a2731860d --- /dev/null +++ b/docs/api/patch-v-1-companies-company-id-payrolls-id-partner-disbursements.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"disbursements":{"type":"array","items":{"type":"object","properties":{"employee_uuid":{"type":"string","description":"UUID of the employee","example":"1a2b3c4d-5e6f-7890-abcd-ef1234567890"},"payment_method":{"type":"string","enum":["Direct Deposit","Check"],"description":"Payment method for the employee"},"payment_status":{"type":"string","enum":["Pending","Paid","Not partner managed","Converted to check"],"description":"Status of the payment disbursement"}},"required":["employee_uuid"]}}},"required":["disbursements"]}}}}} \ No newline at end of file diff --git a/docs/api/patch-v-1-companies-company-id-payrolls-id-partner-disbursements.StatusCodes.json b/docs/api/patch-v-1-companies-company-id-payrolls-id-partner-disbursements.StatusCodes.json new file mode 100644 index 000000000..75a366488 --- /dev/null +++ b/docs/api/patch-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"}}}},"422":{"description":"mixed single and multiple errors example","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/patch-v-1-companies-company-id-payrolls-id-partner-disbursements.api.mdx b/docs/api/patch-v-1-companies-company-id-payrolls-id-partner-disbursements.api.mdx new file mode 100644 index 000000000..b3bdeaef4 --- /dev/null +++ b/docs/api/patch-v-1-companies-company-id-payrolls-id-partner-disbursements.api.mdx @@ -0,0 +1,71 @@ +--- +id: patch-v-1-companies-company-id-payrolls-id-partner-disbursements +title: "Update partner disbursements for a payroll" +description: "Update partner disbursements for a specific payroll." +sidebar_label: "Update partner disbursements for a payroll" +hide_title: true +hide_table_of_contents: true +api: eJztXOlvGzmW/1e4tR+SACrZVnzFnzZjJ9sGJt1GJ9nswDHKVPFJYqeKrCZZstWG//fF41GXSrKk2NhrBhh0rOLx4+O7+ciHSBagqOFSXLLoLCqoSWfx/CBOZV5QwUH7fy0SzuKCLpTMMh3bfysjQCWM63GpNOQgjI4GEQOdKl7giNFZ9LVg1ADxjUmrMZlIRSjRBaR8wlPiRx9+F9+FTmUBZ+S2d5azO8UN3EaDyNCpjs6uoysPLLoZRPfxtNRGxlwYmLqlxWZRALaDfAyMAcN2BVU0BwMKR3iIBM0hOovq1UaDiAtHktnSur7MgHz9enlB5ISYGRDfLRpECv4suQIWnRlVwiDS6QxyGp09RA5EpI3iYho9Pg6qSbeczBNqx8n+M/53S5/3V5fxf4DSOIeffQaUgYpWjzOIQJQ5UnK0PzqK94/jgyOkJYMJLTMTnTV/f+yu4wKpnXMB2i4DOSMeUw2MvL+6JHOHhVCtZcqpAUbuuJmRhSyVbZDSLBuSywkRUgDhmhRKzjkDNnBtaFFkPLUb/kqT65wLnpd5c+yb1zNjCn22t8dkqoeWT4apzPcCXwQOt9/3aMFj35OL6b/6AePGz28QRqmBDaPHm0GkIS0VNwvLUOeOJd6nKWj9vjSz6Oz65rHBoErf0WnYOQW6kEKDRqKP9vfxP23q6dKONClx41MpDAiDrRrL3vtDY9OH5f2T4z8gNUucdbVGLmsuu4/hnuZF5sB5HIk21JT2F98yKUuOOuRg9BYOj45PYjh9N44PRuxtTA+PjuPD0fHx0dHh4f7+/j4iaSkOpBjkRSYXAFsMdBChIC9wjCQHM5PY73wG6Y/Gh4A0+lWaShXlVNApsAglY4eJR30TX3AFqSEXUEjNTR+CKxDMCuTN4+MgKhRqX8Ohh4zLoreZUnhcomw1ElWKLpYG+jvXBgdZ5oG2ruEGct3HUu1VdGi57TJCd1xHl76bjOX7ENenWkZzcQ0ttrRhjnVuHpe3bpPJXdvGjnSmC7s/iK6o1fl9DDmIzqWYg0IFaCRJPSL83yAy3GRgBdduS+wFOL5obblre7h/uKxFcMaPshRsGyWyYgjyXRDyXeDK0RCBRsgKtCxVCoRJ0ERIQ+CeazMkn+gPILpU4IjjdTe5vNiz+881mdOMsyGa9Q6H1WbuOgKlpLKGvsN37vdlbl/Jt0ujJj8AO6TUwFSqxYo5bKsn2eGz82pAk7sZ+DXb7kSmaan0kHxZFBxN2oKYGdfkBywIZyCM64XtqTGKj0sDe5WvQhRk1HNGNeQQhaVCvQU0HAHbIse6kQhuZhgqbJL2yKdKlgUXU02oYCSlgozBWj9EMy55xkiKli337WdUsIyLKeHCWeiGS2Yx56A1ncLTkK8CEAaG8kwTOpalaRA1JlMQoGpy+qEDSl2qCU0dUioICIbAkXJOVtomTkiTTKyQNBjrurX/kef4Jr+cNTo2FhetEJA76uTDdhh6kxAE/FdpYitk8QecNP7Nca2X7NFoWSxzfg+MaC6mGdgNysvM8CLzJNLEr3B3wf8qCiXR9tNxBuSDMNwsggpAktMFmdGiAIE8L+zujCVbIHfZ7fc0IDg95UIHYLpMZ4RqcsuFVQFJxfjJnGYl3A6IV+NhhIllAlaC38+qZxXN3A7JZ3Bid/3BTXPu9omD3tIPtDDjtOr+hkxLzsAal1wqCFw5/C7+qbz+XygvjEKqibgmt8LKduL28XZgwbm9Inc8ywLLE0pcS3LrmxK/SQsX7IAVKi8Y/2N0JKIwlFGzQUhxHoRbQQZzKgzGeRTH9Ayy8JLstSAXxMo0hn5WbXiNNM5gSD5KFdTWoDWExWdJdev+myCqW7u34Rd0QG8d+ce1w4H+hRTw28Rq9PVrqTUojohy1BG88POysIUvW4h0J9xzitytJRpElDGOn2h21ZjJBY89czuCPM01v9IcKt/bUdTMaJNtUqlccMo0MdJyQ4PAT8/wVfA/S6jVg6qccjeMHdFp74mSeT3gdT2iKLPMeuWuXVkkRq5v2NJzfQ3QV4d1TRrG+JPn/vgbN7P4NwGxM37R4+pWnzzvuKa4NRhp/nPP//fvOY600mC36fANlY8U2cIFQYSvNRtDcmlsXktqzdHFMpLM6BxqTy6DOWQ2wPRmJBiKSq1EKVdpmVH12sFtuY9vouYKexpEPc7wmIofCU1TWQqTMMjAQFKKSSkYsMTHuHqNo4wZvraXvOSstbzlj6UNkj+5AH5GNQmzkWo2uwctYHNQfLJIuLCsmyJSG9M/J7J/oBuAsxI/K1pO9ODHQOz8HNiQXGVANbi43Tkp6LF6OITm2FEPVy+BZgooWyRhxBddAJLXT0jGAKJeRw/AnGvUUImSpUGxWRMcuRaJKPOxTSj3QOw4+S2gv7v+xPVHmQhm1+MK2ZlUigmf6gpa5WtuRbXl3k0w7w3BLTUE0861M5uX2jQdi35gYbUTqk2QliTjOTdrEPY03pqEHxFxyIbZMYieyTJjiJl6ylaYkwIUl6zGC4IlzGvLFSirJr3Y+mn5QTCb929Ijo2gzIwK8pbkUpiZRp9wUppSgcNXnckIVmqjFomGDFLk7kRQnuoklQyS2jFbibhuvT09f8W+BPv2sONmCP00Lw8wsCb8WdIMrcgxYXzKK7WzBq4OAPQGcDVPXdvt0X7mqcWql8EeerAOq+E5JHIySQqZ8XSR4CnWZnud70TEvG9/uyBKYSUKWCUvNE1VSbNErZeZVrMtNPd7149gv4pi4wxVOXpWFR5iAXLQK4AXLgOd+ETKOuvY6boN2nMn3AxoavjcHgDbMVyM6zEQnIDIySRkdVZhDkcCepNtrxpvv/cfQldCFWzOAWOaUZFCUhZP6MvV1nodqnMqbJaQsj/strvZ9Pptn8mMM9Tq+H8HOLgV1hF9Tq/In3NWboR1KYhHgBbIb/5qaJg1fTFY1TGE9aT7gA1I4V02BcirUsBKqJV5rNjsRVjx0rWpTsMIhl26kcOw+KQYS6rQDa9OzZ6RfkGG0eEn1VSNAzqEsLSYZ0TwxeYeubbJHhuWctHKAmNyuWPRnFuRgMD8ETphRtHUSJVgELYGW7fl9mJaDeDivdq/cVjcUaTlctR9VXlNB/9L+rGdNfaYOW2osn47nRhQNtbfxAtY7rU9/a4qv/pVz3ivajGuUxM2T0m8oMxBGL+KkFrcFH+r/U8hb430JObQug5p7PH/VEmtMd0RJhdgg4F1vo5vsb27AzZGqDyKEBd0IFmvBXdkJku1iWO4m6n7BUdvSI6AKTV83iWQl/EU7WD2jPrGn6k3ALgpKvGYKPkXiCSURDynpsOsj59+KST3h26YW7g02qXTa4zO7WB4QkYzA2oF2sSPsj5u/yngXJMxoHKrAIejlg5Um2rk2jqAHmwpcsn4hFu1HSCHbOZzgg0nRsXSZjsAjpItkjtFqUHNvRbXC20grxoFHd71DawW0MlEqpyui/bb7X9GAbVHqqVaEJue9Dhzeo91bF2culQFxTW/INQP9ykAehEeA+7Ewf6+pWom5Y+yWEfLFwQWHK4QA9iapNf6zTBqn33V5zrXnaR7FT5EnVx5mD/GP+OD0Vt70t9UaONMpj9AVcbfJt24mMitmL8zWq8zbDnCO8KtPCAXRCoGCu2TKkVVi9tZvpt7Gef69VSbo8GUxcssirLaNdW7LacDc/2aJsDwKDUx9P4ll4V+oXXA/XzE0Hti59ttjcuwN2BFlxN2RSLPvswWGwaNFbLQP8GXLdD9i9SlxlzElin2TRbFsajFD940gk8uoYbkIOtybFclxdLWVDm7da75UvddUnXVICQMQqrJ6xgiWgW4tso/i7Z1XNahX5jNa2ObQqfpLDEzBXomM5aANz5R4/yui8AuCyqs29Mq0AVZwKZt5pRn1B/mocefzYHY3Pz781/IlwCOBMvYOD+SUttkBBrJb1wBuRQD8knOgXyRWICpyAW1x5FNg+kL03dym6rwZV5dC2idHdm8GDUG8sIGsUZ6l47Qup6jROZEl0OWJpaT2H73A4Ywk08FNVJhao/ybLO0HuXZLik9yrNmoNsFEOLukB2bUZ1UX58/m+JOc6sDD9zcajZiy4M8oIoNFOS44/boPCQP6i5jmOBgWCeARCcC7nDQ4OhhRWDr6kwQndUL617n2VD6GrmFcG7V6/2skb1VQ2xQYNmsfu6UVA5eeHlsn03oaDSKKds/jQ+BnsR0/5jGJwcnx6en6dvxwcm7NYvulLjv4Pu3yt2D/XRa44y069sHxJa3D6MuVTq17juj8PXvXvU5jxpd+05R/ivvbbsj/lfDoMP+u8puB9GEC65nic9yonXFQgLner1ATtoTyMX4RqJkG1JP3skJZtJ5MYkd+ikvTBsFYJKD7XfxEzIPF2lWMtTobiDULQq0XuKZ1JUo/dwcdpDuyK5KZ3vTi92QtD5LfKekmBIffXfn+IsXO7C5U8kgMNYOWby/eOEOXV/DcDokB6O3h0dvekRsJgXsXA9xhb1DNUQQ8oP91kEpVhxkPF2XaegVHla6CnBYdfTYEB08vjMz0I3y3jpZ5Y5wOgH8JonsXljr6wi+NK+Q1DUZdvfdvmBttvOUg4xn8q5R3mBrudYVN9Sx/c7ZBJwyVPN1GaKZI3ieCapFekvmfFj9tM33DTc3h3YW72gHLYWCptdYOvxu++wUgWBNMDBiP5FXvs+r+iaBkKTAu6XGhFY6WJUx1Tx94eic2jK/oL+Dt+lu0m0VwgoApht2yIeBPf5HoNudLw5fsTr7eWuCf8Oy8KBnpvZYVHmXVdWFGvuVoVpC94I5eutJrE6Sd3LODgHm8ImtTE8N0WVRSGUIs85Rtuie8Ht1FNbgTkCfPQ/dKX5oQHYTss5p1rpyMa60SXYrePmIfYnolL0saStm7cMkGXNlL6hvOcuFPVefENu9Co29BbVlE84BtDpns2PaqhZ0FyfeO+8nIwqHxwcnMaP0XXwI7CQ+PYL9+OAU2BHbBzh9e7RGpdnTsB2C0iyj5CM3f00xFcdsxS9FZW4vcKHAWh6edU7DNKCPaEPE6qg5XDFdDnSemVIjdjKeHI/SeEzHk/iQHozi09G7Ufz2cB9G7F1Kx6PTNZTaTQtdasrpjPwNVMZFRSakS7awJLrzt1c2o1DwqUFo509XeY/1dTura7XWlrB6b7TJ6c2iy14kVXAp1taHtprtHK1h707ESPAIdkC+AfzAVJMwM3v17h9A+1CHpEmle585VAoTrdP2smFQ2zcoW7cV4xXF7o+Pg+B+/k2yRWD+nZ5WaN/IeOoS/stcp++9Sj+IwtXPs+iAjsZv00MWH8HxJD45fbcf03HKYpjYyOUYf9ns7v1Td+iX35rovZnfd+F/9Z37Z7hJv3SjsO/SfvvBgMAl1b2v1qbcPHa/t/f+xrEZ3BsQ2jraKBxOLFY+VmOvvZSdR2tQybf7uTdEqsZ4NQifGKlepLDv+diHKPD9kWhvfrBXlR7tPdSP3Tzuhbd99h7cX/2v+9hTcC/epcrQCPqbtLTg7iJtzCC3t2mXmPMCcmmfE9EF0B9A9SJ248UulYafcYkrBu4d80rZtNmqMQv83Hya5TOKrxOtngdaKobDycM7OPj3GKiykUD3sqMdIrb3cggtzQyDsXDoNIg+20qBn5nBjbBigsdBhGrp91qBfQiCvqSA+t5X2UQX/OwzJ5gKcCfZQTHb54fwWR7k23Bc0Xw4aBDhO0H6t8lnUHOeQoMZ6qva9nbrnm24x5A6qDVj+zceO2jfdelGFmSpzO1pjMXxSpMPXr5IKADCF4OYTEtck6X0v/g789RlV/xDShdhVvI73mv2IbQ7qUBu9l//rWZe++aL1CanojHOBm9k1a+wtFbTMFYv/tKW41oD92avyCi37G0F9cErl+tobpOOQb1Eg+is9ZpW0DD4wf/Qp2RusPBWGxzw4QHdhq8qe3zEn/8sAT2H6xvUd8rWClm+ZtzaeBadTWimYQ2RXv/utfQbsvoFr96lButtW3htG0X+zmHz1TBUYM8CqN7zHQBxf9LlX/Tajkr/p9/pWkFOR7b+t9Eq6tb299wRK/7SstXLDmPdA41AYda2bRruq/dfzn+JBtHYe6U53gnCWOQO76DTO7fZIXN39uB+e4gyKqalc6HdoKhzaNv0VKbG/6NxEb7NTg8PrsUX+QPE42PFXQb/tu72438BsvHWsA== +sidebar_class_name: "patch 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"; + + + + + + + + + + +Update partner disbursements for a specific payroll. + +scope: `partner_disbursements:write` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/patch-v-1-contractor-payment-groups-id-partner-disbursements.ParamsDetails.json b/docs/api/patch-v-1-contractor-payment-groups-id-partner-disbursements.ParamsDetails.json new file mode 100644 index 000000000..1b9e38cc0 --- /dev/null +++ b/docs/api/patch-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/patch-v-1-contractor-payment-groups-id-partner-disbursements.RequestSchema.json b/docs/api/patch-v-1-contractor-payment-groups-id-partner-disbursements.RequestSchema.json new file mode 100644 index 000000000..b525db475 --- /dev/null +++ b/docs/api/patch-v-1-contractor-payment-groups-id-partner-disbursements.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"disbursements":{"type":"array","items":{"type":"object","properties":{"contractor_payment_uuid":{"type":"string","description":"UUID of the contractor payment","example":"9f8e7d6c-5b4a-3928-1c2d-3e4f5a6b7c8d"},"payment_method":{"type":"string","enum":["Direct Deposit","Check"],"description":"Payment method for the contractor"},"payment_status":{"type":"string","enum":["Pending","Paid","Not partner managed","Converted to check"],"description":"Status of the payment disbursement"}},"required":["contractor_payment_uuid"]}}},"required":["disbursements"]}}}}} \ No newline at end of file diff --git a/docs/api/patch-v-1-contractor-payment-groups-id-partner-disbursements.StatusCodes.json b/docs/api/patch-v-1-contractor-payment-groups-id-partner-disbursements.StatusCodes.json new file mode 100644 index 000000000..f31f59fdf --- /dev/null +++ b/docs/api/patch-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","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/patch-v-1-contractor-payment-groups-id-partner-disbursements.api.mdx b/docs/api/patch-v-1-contractor-payment-groups-id-partner-disbursements.api.mdx new file mode 100644 index 000000000..e51ada7ee --- /dev/null +++ b/docs/api/patch-v-1-contractor-payment-groups-id-partner-disbursements.api.mdx @@ -0,0 +1,71 @@ +--- +id: patch-v-1-contractor-payment-groups-id-partner-disbursements +title: "Update partner disbursements for a contractor payment group" +description: "Update partner disbursements for a specific contractor payment group." +sidebar_label: "Update partner disbursements for a contractor payment group" +hide_title: true +hide_table_of_contents: true +api: eJztXOtvG7ey/1d4935IA2hlW37Gn26OnZwaOGmNxrm5B46xppYjic0uuSW5slVD//vF8LEvPSwp9n0ctEDRWksOfxzODGeGQz5FsgBFDZfiikXnUUFNOomnB3EqhVE0NVIlBZ3lIEwyVrIsdMxZXFBlBKiEcT0slQb8rKNexECnihdILTqPvhSMGiC+MWk1JiOpCCW6gJSPeErq4Ygfjtjh+t/EN6FTWcA5uV867PmD4gbuo15k6FhH57fRRU3r2tP6u4Ue3fWix3hcaiNjLgyM3cRjMysAO0I+BMaAYbuCKpqDAYUknyJBc4jOI86iXsSFY9Qk6kUK/ii5AhadG1VClwM3EyBfvlxdEjkiZgIrZxn1Ip1OIKfR+VPk0ETaKC7G0Xzeq0b/r/jvFvv766v4P0FpHMTDmQBloNbQ6UUgyhxnOdgfHMf7J/HBMc6TwYiWmYnOm7/PuxO5RE7kXIC288B1jYdUAyPvr6/I1GEhVGuZcmqAkQduJmQmS2UbpDTL+uRqRIQUQLgmhZJTzoD1XBtaFBlP7WK80eQ254LnZd6kfffTxJhCn+/tMZnqvl3DfirzvbBmcUFnSmaZ/b5HCx77nlyM/90TjBs/v0UYpQbWj+Z3vUhDWipuZnaxL2ReUDF7n6ag9fvSTKLz27t5Q3iUfqDjsOQKdCGFBo1MH+zv43/a3NOlpTQqs6gXoQyAMNiqMe293zU2fVpcPzn8HVKzoFzXa7RqjZg9xvBI8yJzaD2wRBtqSvvLKrVPypKjfTgYHMLR8clpDGfvhvHBgB3G9Oj4JD4anJwcHx8d7e/v7yPWlmFAni4hvDnJA883T2DzjoMINdkNl4OZSOx3MYH0e+NDmH30izSVtcqpoGNgEarfD2E/3BX70TLsl1xBasglFFJzs2wS1yCYNRx383kvKhTad8Nhk9VdtBk7mrP5ggRUpKlSdLZA+R9cG6S6KM3PmE1uINfLtOXZib/UlHGyC+u7O1kk1131TagFxrg+FeuaDG3sAQti5HTibr4oUJsM7tqGyQTG1MMFmexF19Ruocs0rYcb9xQUbh9GktQjwn96keEmQxD13h77vT22e3vs7WF82ZI71/lo/2jRKCOEj7IUbBubvIIE+SYI+SaQFegQgMY5KNCyVCkQJkETIQ2BR65Nn3yi34HoUoHjlt8KydXlnhUJrsmUZpz10aXpSHXtbtxGoJRU1qdpy7r/fVHlVurKAtXkO2CHlBoYSzVbMYZt9ax8fHYuHmjyMAE/Z9udyDQtle6Tm1nB0UOYETPhmnyHGeEMhHG9sD01RvFhaWCvcsuIgox6UalI9q0yBtRbQEMK2BZF2FEiuJiBVFgk7ZFb68PFWBMqGEmpIEOwzgSiGZY8YyRFRyH37SdUsIyLMeHCOTwN79NizkFrOobnIV8HIAwM5ZkmdChL02BqTMYgQNXs9KQDSl2qEU0dUioICIbAkXNOV9oOgpAmGVklaQjWbWv9Iy/xTXk5b3RsTC5aoSAP1OmH7dD3O1fQ+F+kia2SxR9w0PhXJ7VesweDRbX8Igol0a+hwwzIB2G4mWEYcWPZQWdkQosCBMqjsJwbSjbDlbdL4/FZk0y58EuuiS7TCaGa3HNh1TOphDKZ0qyE+x7xNjdQGNkFYiV4Xlc9q5Drvk8+g1OJ2w9umAvHQw56S5fXwozTqvtbMi45A7sT5FJBkJj+N7G7xVvOWmf7/mJuYO5fVvtf32pjNFsNxDW5F9aoJW4d73sWnFsr8sCzLIg8ocS1JPe+KfGLNHNBM1il8orxf2ZzQBSGMmo2CE0vgnIryGBKhcF8AUWaXkBmXpO9+eeCWJ3GFII1G94iDTPok49SEb8j9VokLD7Lqnv33wRR3du1Db+gM37v2D+sPS10rKSAX0d2K1s/l7zMDC8ycGOhHnUUL/y8qGzhyxYq3UkbcDEOI2M3yhjHTzS7bozkkhBLxnYMeV5qfqE5BNfdc9RMaFNsUqlckoNpYqSVhgaDnx/hi+B/lFCbB1WFJ46Mpeis90jJvCZ4W1MUZZbZ+MS1K4vEyPUNW3ZuWQOMWmBdk4YX8slLf/yVm0n8q4DYbX7RfHWrT152XFNcGkwm/LXm///XHCmt3LDbfPiKxkeKbOaiP8LXbht9cmVsflRqzdHFMpJM6BRIZYcymEJmQ22/jYSNojIrUcpVWmZU/eTgtvzmt1FzhksaREuigCEV3xOaprIUJmGQgYGkFKNSMGAhn6LXRAiYKW6HBwvOWitM+FjadMEnl8qYUE3CaKQaza5BC9gUFB/NEi6s6KaI1GY3XhLZP9ENwFGJHxV3TgxdhkDs+BxYn1xnQDW4DIZzUtBj9XAIzbGj7q+eAs0UUDZLAsVXnQCy1w9IhgCinscSgDnXaKESJUuDarMmKnQtElHmQ3swsQRix8lvAf3N9SeuP+pE2HY9rpCnSqUY8bGuoFW+5lZcW+zdBPPeEFxSQ/D4onZm81KbpmOxHFiY7YhqU2UfM55zswbhksZbs/AjIg55QUuD6IksM4aYqedshTkpQHHJarwgWMK8tVyBsmqyFNtyXn4QzJ4fNTTHRlBmQgU5JLkUZqLRJxyVplTg8KXuRCbhgpXaqFmiIYMUpTsRlKc6SSWDpHbMViKuW2/Pz1+wL8G+S8RxM4R+mNcHGEQT/ihphrvICWF8zCuzswauDgD0BnA1T13b7dF+tse+GK4sgD3yYB1Ww3NI5GiUFDLj6SzB09DN1jrfiYn5svXtgiiF1Shglb7QNFUlzRK1Xmdazbaw3O9dP4L9Ko4NMzTl6FlVeIgFyEGvAF64XHziEynrdsdO123QXjjlZkBTw6e2DMDScDGux0BwACJHo5DVWYUZ8iKTMwC9ybJXjbdf+w+hK6EKNpeAIc2oSCEpi2fs5erdeh2qCypsepSy3+2yu9H0+mWfyIwztOr4rwMc3ArriL6kV+TPyys3wroUxCPAHcgv/mpomC5+NVjV+Yv1pJcB65HCu2wKUFalgJVQq+2xErNXEcUr14YEEgTDLt3IYVh8UgwlVeiGh3Yvyb+gw+jwk2qoCpKDsDCZF0RwY3OPXNtkjw1LuWhlgTG53NnRnFuRgMD8UdI4mcUgbA22bsvt1bQ+GrbxXu3fOCzuUNZKOdo+h7dW2ID/Nf3YzhyXbHPaUGX9djoy4E6zN/ECFnttz7/ryq9+s4Tem1qN69SEzVMSryhTEMbPIqQWN8Xfav9DyFuUnsUcWtchDR45YE2G1pjuCIMLsMHAOl/Ht9je3QEbI1QeRYgLOpCs14IrMpGl2sQx3G2r+xmpNzRHwJgaPu0yyOt4ivtg9oL25trRbwBwQ1TqMVLyTxCJx/Gilg6zPn74hZDcH7phbuHKaJdOrzE6t4PhCRnNDKgVaBNPZX3c/kPAuSZDQONWAQ5HLR2oNtXItXUAPdhS5JLxEbdmO0AO2cyXBBtOjIqFxXYAHCdbLHeGUoOaeiuuZ9pAXjUKNrzrG1groJORVDldF+232/+IAWpTqrVaEJue9Dhz+oj1kF2culQFxTm/ItQPjykAehEeA67Ewf6+5Wom5feyWMfLVwQWHK4QA9j6rJ/0237UPvuqz3VuO0n3KnyIOrnyMH6Mf8YHg0Nb4tA0aMNMpt9BVZu/TbpxMZJbCX+H2lJn2EqEd4RbeUAuiFQMFO5PqhRBPbrTd2Mv4lw/n2pxNJiyeJ1JUVa7pnq36XRgrp/TCBgepSaGPr7mtNAvtA64H48Y+kjseLvNcRH2BqLocsKuSOTFp9kSw2CxQhb6B+SyBXr5JHWpMRexZYp9k0lxLGrxxJub4LNTqCE5yLoc2llJsbA0Vc5unWu+0H2XVF1FhAQipBq8jiGiVYDrXflH0baOyzr8C6N5a2xT6DSdJGaiQE9kxhLwm0/UOL/rIrDTggrr9rwKfEERsGmbKeUZ9Yd56PFnUyA2N//+4mdyE8CRsDM2zo+k1DYZgZvkV66AXIke+SSnQG4kVp4qckntcWRzw/QXHHZym6rwZVpdL2mdHdm8GDUG8sIGsUZ6l47Qup6jROFEl0OWJpaj2H73BEOYyceCGqkwtUd5tllaj/Jsl5Qe5Vkz0O0CCHF3yI5NqE6qry+fTXGnudWBBy5uNRqx5UEeUCUGCnJccXt0HpIHdZchjJAY1gkg04mAByQaHD3+CKx1XyqozuqJdS91bah9qy9JtL2fNbq3isQGlaXNsu9OLWnvlafH9tmIDgaDmLL9s/gI6GlM909ofHpwenJ2lh4OD07frZl0p9h/B9+/Vfgf9k9nNc5Ju9K/R2yhfz/qcqVT9b8zCn8TwJs+51GPGvc2PMo33tt2R/xv+sGG/W/VG/eiERdcTxKf5cTdFQsJnOv1CjlpzyAX4xuJmm1IPXgnJ5hJ58UklvRzXpg2CsAkB9uv4icUHi7SrGRo0R0htC0KtF6QmdSVKP3YGJZIl7Kr0tl+68VuyFqfJX5QUoyJj767Y/zJix3E3JlkEBhrhyzen7xwh64/QX/cJweDw6Pjt0tUbCIF7FwPcY29QzVEUPKD/dZBKVYcZDxdl2lYqjysdBXgsOrosaE6eHxnJqAb5b11ssod4XQC+E0S2Uthra8juGnenalrMuzqu3XB2mznKQcdz+RDo7zB1nKtK26oY/udswk4ZKjm6wpEM0fwMgNUk/Q7mfNh9fN7vm+4+XZoR/GOdrBSqGh6zU6H322fnSIQrAkGRuwn8sb3eVPfJBCSFHhH2ZjQSoddZUg1T185Oqe2zC/Y7+BtunuMW4WwAoDpxj7kw8Al/kfg24MvDl8xO/t5a4Z/xbLwYGfG9lhUeZdV1YUa+9VGtYDuFXP01pNYnSTv5JwdAszhE1uZnhqiy6KQyhBmnaNs1j3h9+YozMGdgL54HrpT/NCA7AZkndOsdeViXGmT7Fbw8hH7EtEpe1mwVszuD6NkyJV9+WDLUS7tufqI2O5VaOx3UFs24RxAa3M2O6atakF3ceK98346oHB0cnAaM0rfxUfATuOzY9iPD86AHbN9gLPD4zUmzZ6G7RCUZhklH7n5c4ypOGYrfikacwzXCCqsleFJ5zRMA/qISy/4Lwl0XphTA3Y6HJ0M0nhIh6P4iB4M4rPBu0F8eLQPA/YupcPB2RpO7WaFrjTldEL+BirjomIT8iWbWRY9+Nsrm3Eo+NQgtPOnq7zH+rqd1bVaa0tYvTfalPRm0eVSJFVwKdbWh7aa7RytYe9OxEjwCLZHvgJ8x1STMBN79e6fQJehDkmTyva+cKgUBlpn7WVjQ21fHW3dVoxXFLvP573gfv5NslkQ/p2e6GjfyHjuCYTXfrvgmXcLepGv8Y/Oo3ejMzhlJ2l8PDyi8eG7wVl8kA5YfAhHo2N6MjxNz9hmLxM898LA4jsmS98tWP4gwuo3CV7gpYGFe4bLHjVoP6gQZCfcBlu1VHfzbsu2bNw5MYRHA0JbRxyVx6nNygeL7LWYsvNwEW4C7X7urZqqMV4dwqdsqhdF7ItP9iERfOcm2pse7K18+2nvibP53qrXn+z5uFf8UmW4Pfo7trTg7optzCC392wXhPUScmnfp9EF0O9A9Sx29GKXZMPPOLkVhJfSvFY2obaKZoGfm4//fEbFdkq35AmgSuhw8PDSEv49BKpsjNC9BmlJxPbGDqGlmWCYFo6jetFnW0PwIyM4CisGmPciNFi/1abtQ1D3BdO09n2ejWzDjz5Vg+kCd9odjLd96gqfgELZDUcazUeqehG+SaV/HX0GNeUpNMSivs5tb8Du2YZ7DPmEljW2f+PRhPZdF25tQZbK3J7YWBxvNPngdYyEIiF8nYrJtMQ5WZ7/m79XT10Gxj/adRlGJb/h3WcfZrvTDJRr//U/ajG27/ZIbXIqGnQ2eE1tzTs5rek1drj/+UfanIQbeDR7RUa5VQWr1E/eBN1G0857T20jFPWic+4kbpkdusOqXW2QztMT+hxfVDaf489/lIBux+0dGkNlC42s6DNuHQQWnY9opruPuDWZ9dNv3oS/JVs87bZ0ysEXELPaNkeRv8GI78y5+mP3rNt2KP+lH2tbwU7HtuUP5FXcrTfHC8es+Ka1kS56e3UPtNOFWdu2uatev7+5+DnqRUPvUuZ4oQcDiQe8QE4f3GKHtNv5k/vtKcqoGJfO/3VE0RjQ9u5Q7Qb+fxq32Nvi9PTkWtzI7yDm80q6DP5tfeX5fwM4r4R6 +sidebar_class_name: "patch 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"; + + + + + + + + + + +Update partner disbursements for a specific contractor payment group. + +scope: `partner_disbursements:write` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/patch-v-1-employees-employee-uuid-section-603-high-earner-statuses-effective-year.ParamsDetails.json b/docs/api/patch-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/patch-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/patch-v-1-employees-employee-uuid-section-603-high-earner-statuses-effective-year.RequestSchema.json b/docs/api/patch-v-1-employees-employee-uuid-section-603-high-earner-statuses-effective-year.RequestSchema.json new file mode 100644 index 000000000..3c75051f8 --- /dev/null +++ b/docs/api/patch-v-1-employees-employee-uuid-section-603-high-earner-statuses-effective-year.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","description":"Request body for updating an employee's Section 603 high earner status","properties":{"is_high_earner":{"type":"boolean","description":"Whether the employee is classified as a high earner for Section 603 purposes","example":true}},"required":["is_high_earner"],"title":"Employee-Section603-High-Earner-Status-Update-Request"}}},"required":true}} \ No newline at end of file diff --git a/docs/api/patch-v-1-employees-employee-uuid-section-603-high-earner-statuses-effective-year.StatusCodes.json b/docs/api/patch-v-1-employees-employee-uuid-section-603-high-earner-statuses-effective-year.StatusCodes.json new file mode 100644 index 000000000..d7bb37cf5 --- /dev/null +++ b/docs/api/patch-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 is_high_earner","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/patch-v-1-employees-employee-uuid-section-603-high-earner-statuses-effective-year.api.mdx b/docs/api/patch-v-1-employees-employee-uuid-section-603-high-earner-statuses-effective-year.api.mdx new file mode 100644 index 000000000..2ca08278c --- /dev/null +++ b/docs/api/patch-v-1-employees-employee-uuid-section-603-high-earner-statuses-effective-year.api.mdx @@ -0,0 +1,74 @@ +--- +id: patch-v-1-employees-employee-uuid-section-603-high-earner-statuses-effective-year +title: "Update a Section 603 high earner status" +description: "Update a Section 603 high earner status for an employee for a specific year." +sidebar_label: "Update a Section 603 high earner status" +hide_title: true +hide_table_of_contents: true +api: eJztXFtz27iS/itY7kMmVaIsK06c+GkzjrPjh0xcibPZU06KhoimiAkJcADQtsal/36qcaFI6mJJsWvP7s7DVMYi0PjQ6BsaDdxHsgJFDZfinEUnUUVNmsc3hzGUVSFnALr5v6SuOYs1pNj41ehFkvNpngBVAlSiDTW1xtZZhi1uIJkBVdEgYqBTxSvsFJ1EXypGDRBKPjs65NXoBUFCxBEijhDJpCJUkDC2+5voClKe8ZQg7eE38U20yciMmBzI57PTL5/OyHg4Im9TQ2hVFRw0MbKhpgmdAiMvR0QqIgsGitzmUgOpFJcqRuLk/fnpW3JLp6AJ3KUAzNI+//SZmFyBzmXBht/EZQ4a2nQVkLSgWvOMAyNUt+emB4QKS4crklpG1xVJpTCKT2qchkVZKYgNvSMKDFdQgjBkAgIybjQpa41/EQaaTwU1boxKamO7dGhZ/uhUVnBCrptFDKRObhU3cB0NIkOnOjq5is4Cr3/1TaLvg+guntbayJgLA1MnJ7GZVYAdoJwAY8CiQUSrqt3Edq2ooiUYUEj9PhK0hOgk6khTNIi4cFKXL4nKZQ7ky5fzd2FdQ89oECn4s+YKWHRiVA2DSKc5lDQ6uY8ctkgbxcU0ms8Hi4H7grl55Ka5lTUrf1a4WvLmRHUbOJY1oDp4/jv+T8vZtxfn8X+B0ji0B5UDZYAQ181rEIGoS1yD8Wj8Mh69ig9fIssZZLQuTHTS/n3en947XJSSC1SKHAgqZDyhGhh5e3FObhwWQrWWKbcidstNTmayVrZBSotiSM4zIqQAwjWplLzhDNjAtbEKl1o5eKbJVckFL+uyTfv7L7kxlT45OGAy1UMrYcNUlgdBouKKzpQsCvv9gFY89j25mP67Jxi3fn6OMGoNbBjNvw8iDWmtuJlZuTuVZUXF7G2agtZva5NHJ1ff5y3RVvqWTsPSKdCVFBo0Mn08GuE/Xe7p2lLK6iIaRKhwIAy2ak374A+NTe+X109O/oDUrBQ4BZUCDcJYEij0Lfv3TG9lMHsGkjxsHb3o6se2jWjIcnoDP2XttrJyEa4k3NGyKtyq+QXyLgl/4ejZsqNjmh6OJvHL12kaH704Hsf05avjeASj8WScvmBHx29Qsbpm4mQ8Gr8aRFy3vV10ktFCw3w+iCqF/tNwaAZa1tXlta4F/7MGwhkIg55CNauzeZEVpFIxa3Eo+yiKmRPb+TLsJdOzCkZj2W5znubE5FyvGtV70FXD9vkShr2KJlIWQNGkiboonHFqj/81B5OD6lh21OKu96QdPAi1zaGqVpXUoIfklAp0izgU4Y6VHnxONRHSkBmgYIEgLFg/Nlye0bxtzK8i66GWHUd30t8HkeGmQGYHFxp/bqKk+Dc+zeMz2zT+7ERyPseBjkZHy9bld2nIe1kLRuIFW5gENwm449rsYnbWEf8mCLHRizUAoFHFFGhZq7Q/3JB8oD+A6FpZZW6sPTl/d2DdM9fkhhbcsrNv5trMBKWkcpFBR2n87wuRpUrRGfLZQKlXGc8lqskPwA4pNTCVarZmDNvqQf387EwoaHKbg5+z7U5kmtZKD8nlrOLoBGdOY37AbKHJzqVS4wwUHDRBEFFQWEtm5ILkEJ1zg3oHaEgB26LdcJQILmYgFRZJe+RTJeuKi6m2AWjqlAX9JaKZ1LxgJEVfWPr2ORWs4GJKuHA+vRXbWcwlaE2n8DDkiwCEgaG80IROZG1aTI3JFASoBTs96YBS1yqjqUOKDlEwBI6cc1rUtf1CmiRDCW8L1lVn/SMv8W15OWl1bE0uWqMgt96m2A4YciCQYAN+lya2Shaf4aDxRye1XufH42W1rEWlJLosOimAoCCZGYkJF1atSM/c7K39XzrDnNlhgh1AvtMZyWlVgUDBF3aJJpLNUMSsDHhGWPdLufCypYmu0xxt9bUHnDTSn9zQoobrAfHBc6CQWUlgNfhFbXo2e9FrjF2c7l2duWFO3WJx0DuGjxZmnDbdn5NpzZnbUpZSQRDN4TfxtwX7f2HBcPPSDMQ1uRZWwRO3jtcDC86tFbnlRRFEnlDiWpJr35T4RZq5PZLXXffxX8ZQIgpDGTVb7EROg3IrKOCGCoPbQ4o0vYDMvCZ7U8gFsTqNIZk1G94iTQoYkvdSEW+dBx0SFp9l1bX7N0FU13Ztwy+YH7h27J8sog4MMqSAj5k165vnUtaF4VUwqSGCbSle+HlZ2cKXHVS6t0vkYtoYc0yQMMbxEy0uWiO5PeeKsR1DHpaa32kJTX7EcdTktC02qVRuT8twu2WlocXgh0f4srRVCakQR8ZSdNY7U7JsbwEaim4H0LSrq8TIzQ07dm5VA4zuYVOTlkf+4KU//spNHn8UEDvnF83Xt/rgZcc1xaXB1M3fa/6/f82R0lqH3dujovGRopi5nRDuLDe4jSE5NzYdJrXmGGKFFEhjhwq4gULj2nk3EhxFY1ailKu0Lqj6xcHtxJDPo/YMVzSIVkTEEyp+JDRNZS1MwqAAA0ktslowYElFZ5hx0RuiZUwMdkPlpWCtEzK/rwXjYvoBTC6Z3X2H0Ugzml2DDrAbUDybJVxY0U0RaSU1f1Rk/8AwAEclflT0nBjGT4DY8TmwIbkogGogaQ7pDxekYMTq4RBaYkc9XD8FWmBKYZYEik86AWSvH9AlN5p5rABYco0WKlGyNqg2G3ZIrkUi6nLidhzLEHtBfgfoJ9efuP6oE8HtelxeEpJUioxPdQOtiTV34tpy7zaYt4bgkhqC2epFMBtOUkJgsRpYmG1GtQnakhS85GYDwhWNd2bhe0TsaRBLg+hc1gVDzNRztsGcVKC4ZAu8IFjCvLVcg7JpshLbal6eCWaPC1qaY3dQJqeCvCClFCbXGBNmtakVOHypS8AnXLBaGzVLNBQuPZYIylOdpJJBsgjM1iJetN6dn79jX4J9V4jjdgj9ME8PMIgm/FnTAr3IK8L4lDdmZwNcHQDoLeBqnrq2u6P9zFOLVS+DPfJgHVbDS0hkliWVLHg6S/Dwa7u1LvdiYrlqffsgamE1ClijLzRNVU2LRG3WmU6zHSz3W9ePYL+GY5MCTTlGVg0eYgFy0GuAV2Cda+ITKZu8Y6/rLmhPnXIzoJj2RsiOhtvjegwEByAyy0JWZx3m5mBpm2VvGu++9medQ/itJWBCCypSSOrqAXu53ltvQoUHE8hMyv6wy+5G05uXPZcFZ2jV8T8HOIQVNhB9zKjIH482YUTuTl0cAvRAfvHXQ8PU6ZPBas4ibCS9CtiAVD5kU4CyKgWshdq4x0bMnkQUz33mtjnAwW2XbuUwLD4pJpIqDMObyoZH5F/QYQz4STPUoojCQliazCMiuLS5R65tssduS7noZIExudzzaC6sSEBg/iix57w0NVIl0h7RrcXWb7m7mjYE3H5vEd84LMwqrJVytH0O70JhA/6njGN7c1zh5rShysbtNDOg7F5/myhgudfu/Lto4upnK+g9W6jxIjVh85TEK8oNCONnEVKL2+LvtP8p5B1KD2IOrRdbGjxySKZKao3pjjC4ALsZ2BTr+Ba7hztg9whNRBH2BT1INmrBFcllrbYJDPdzdb8h9ZbmCJhSPDbvofE6nqIfLB7R3lw4+i0AbohGPTIl/wKReByPaukw6+OHX9qS+0M3zC2cY00LptMXGF3YwfCEjBYG1Bq0iaeyed/+U8C5JhNA49YADkctPag21ci1DQA92FqUkvGMW7MdIIds5mOCDSdG1dJiOwCOkx2WO0OpQd14K65n2kDZNAo2vB8bWCugk0yqkm7a7Xfb/4wB6lJaaLUgNj3pcZb0Dsvf+jh1rSqKc35CqGe22AsY8RhwJQ5HI8vVQsofdbWJl08ILARcTQkrFqb8op8Po+7Z1+Jc56qXdG+2D1EvVx7Gj2318+H4hT3ubxu0SSHTH6Aa52+Tblxkcifh71FbGQxbifCBcCcPyAWRCkv1jCSqFkE9+tN3Yy/j3DyfZnE0mLp6mklRxloViHtNpwdz85wyYHiUmhh695TTwrjQBuB+PILli3a8/ea4DHsLUXQ5YVck8ujT7IhhsFghC/0TctkBvXqSutaYi9gxxb7NpDgWtXjibSf44BQWkBxkXU/srKRYWpomZ7cpNF/qvk+qriFCAhHSDL7YQ0TrAC+88s+i7RyX9fgXRvPW2KbQaZonTUFxAt75RK3zuz4COy1osO7Oq8AXFAGbtrmhvKD+MA8j/uIGiM3Nvz39jVw21c7BM7bOjyQWTeOZg8zIV66AnIsB+SBvgFxKrMJU5B21x5Fth+nr2fcKm5rty01zm6BzdmTzYtQYKCu7iTXSh3SELuo5ahRODDlkbWKZxfa7Jxi2mbYmWypM7VFebJfWo7zYJ6VHedHe6PYBhH13yI7lVCfN18fPprjT3ObAAxe3GY3Y8iAPqBEDBaW88RVYIXmw6DKBDIlhnQAynQi4RaIh0ON3wBLG9aRW2lbGB9VZP7F26x20r5VbCOdWK6OfDbq3jsQWVZbvWqB7dZWDJ54eG7GMjsfjmLLR6/gI6HFMR69ofHx4/Or16/TF5PD4zYZJB2qlPe3eJ/Z3B3yuf+M/ndU4Ie84noWTd+7weUBO8VB6GPW5ElA095H2ROEr5r3pcxE1hvZVF+UzH227I/5nw2DD/qdqbwdRxgXXeeKznOhdsZDAhV5PkJP2DHJ7fLxWeMcNWQzeywkW0kUxiSX9UBSmjQIwyeHuq/gBhYeLtKgZWnRHCG2LAq2XZCZ1JUo/N4Yl0qfsqnR2d73YDVnrs8S3Soop8bvv/hh/8WoPMXcmGQTutUMW7y9euUPXX2A4HZLD8Yujl89XqFguBexdD3GBvUM1RFDyw1HnoBQrDgqebso0rFQeVrsKcFh39NhSHTy+M/bGaoN2kaxyRzi9Dfw2ieyVsDbXEVy275EsajLs6rt1wdpsFykHHS/kbau8wdZybSpuWOzt984m4JChmq8vEO0cweMM0EzSezIXw+qHfb5vuL07tKP4QDtYKVQ0vcHT4XfbZ68diL1Axoj9RJ75Ps8WNwmEJBVeyjImtNLBq0yo5ukT786pLfML9jtEmzbI2G0LKwCYbvkhvw1cEX8Evt364vA1s7Ofd2b4VywLD3Zmao9FlQ9Z1aJQY9Q4qiV0T5ijt5HE+iR5L+fsEGAOn9jK9NQQXVeVVIYwGxwVs/4JvzdHYQ7uBPTR89C94ocWZDcg651mbSoX40qbZL+Cl/fYl4he2cuStWLWP2TJhCt73X3HUd7Zc/WM2O7N1th7UFs24QJAa3O2O6ZtakH3CeJ98H48pnD06vA4ZpS+iY+AHcevX8IoPnwN7CUbAbx+8XKDSbOnYXtsSouCkvfc/DXFVByzFb8UjTlu1+ytaCvDee80TAPGiHaL2Bw1eyas2Og8MqfG7HiSvRqn8YROsviIHo7j1+M34/jF0QjG7E1KJ+PXGzi1nxU615TTnPwKquCiYRPypZhZFt362yvbcSjE1CC0i6ebvMfmup31tVobS1h9NNqW9HbR5UokzeZSbKwP7TTbe7eGvXs7RoJHsAPyFeAHppqEye3Vu3/gteVl1CFp0tjeR94qhYE2WXvZcqjda5Sd24rxmmL3cF8btPlVslkQ/kd4keFTq0jFFWthqsznxrZ+lSFaeiBgzX351nX5p7smj0db7mbAmtvuP3mvPXaP+8Sed9G8O0B4qeDOgNA2YkUpc/K19pkZe3+kfvi5GTSgXVLuWY+mvx39uzWUmKrxLx3hAuELMCfRwc3hQXMCdXDfOZGcHzzw6tHBffeRgDm+3YInzl6ValWgw/G3VmnF3aXVmEFpb64uLfs7KKV92EJXQH8A1bPY0Ytd2go/45TXEF5J80LZFNU6mhV+br+e8hlVxYntijdUGsnFwcNTNVaSgaoV7014ErG9A0NobXLc+IQDnkH02Z7K/8wIjsKaAeaDCE3Ap4WxOAuqsKyV4XELf4YbtMC+14Pv2KBUhUR9+6WdQYRPS+iP2WdQNzyF1tIsLinbe50HtuEBQ6xoH2L7Nybcte+6ZAigSGVpzyEsjmeanHmFIKH0BZ/YYTKty/CKzL/52+LU5RX8y0PvwqjkE97o9ZtHl6NH2fJf/2MhSvalE6lNSUWLzpZvefWn0rLRfz8H9i/4HJhTOgN35qAqKLfaae3MvbeVV9HNoRWYRYHsSf9ZrwcMpu3SfVflO1bsaoPk7+8x3viiivkcf/6zBgw5rr6jMVe2yMhaVcZtcMD8czwbxOyXT94LPScbXhVbOfNwQVDMFr4kivxtxd5rZmiR9wa1y4Nj+yDtcttVSLt3xnbj5f/p18PWsNaxcPWLbQ2nFyHIqWNWfNmJYJbj0UUP9HuV2di2HbtcvL08/S0aRBMf9JZ45Qi3Ord4xZ3euoUPicGTe/fbfVRQMa1dhO6IomGnXW/beFf/P6179l3Rur93LS7lDxDzeSNpBv+20fz8nySpqYc= +sidebar_class_name: "patch 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"; + + + + + + + + + + +Update 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:write` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/pay-schedules.tag.mdx b/docs/api/pay-schedules.tag.mdx new file mode 100644 index 000000000..df0f07d92 --- /dev/null +++ b/docs/api/pay-schedules.tag.mdx @@ -0,0 +1,20 @@ +--- +id: pay-schedules +title: "Pay Schedules" +description: "Pay Schedules" +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/payment-configs.tag.mdx b/docs/api/payment-configs.tag.mdx new file mode 100644 index 000000000..2f4c244aa --- /dev/null +++ b/docs/api/payment-configs.tag.mdx @@ -0,0 +1,20 @@ +--- +id: payment-configs +title: "Payment Configs" +description: "Payment Configs" +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/payrolls.tag.mdx b/docs/api/payrolls.tag.mdx new file mode 100644 index 000000000..219ec1ded --- /dev/null +++ b/docs/api/payrolls.tag.mdx @@ -0,0 +1,20 @@ +--- +id: payrolls +title: "Payrolls" +description: "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/people-batches.tag.mdx b/docs/api/people-batches.tag.mdx new file mode 100644 index 000000000..54bc56e39 --- /dev/null +++ b/docs/api/people-batches.tag.mdx @@ -0,0 +1,20 @@ +--- +id: people-batches +title: "People Batches" +description: "People Batches" +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/post-companies-company-uuid-reports.ParamsDetails.json b/docs/api/post-companies-company-uuid-reports.ParamsDetails.json new file mode 100644 index 000000000..9ff053362 --- /dev/null +++ b/docs/api/post-companies-company-uuid-reports.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/post-companies-company-uuid-reports.RequestSchema.json b/docs/api/post-companies-company-uuid-reports.RequestSchema.json new file mode 100644 index 000000000..487876bf1 --- /dev/null +++ b/docs/api/post-companies-company-uuid-reports.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"columns":{"type":"array","description":"Columns to include in the report","readOnly":false,"items":{"type":"string","enum":["bank_account_account_number","bank_account_routing_number","bank_account_type","bank_account","bonus","cash_tips","check_amount","check_date","commission","date_of_birth","double_overtime_earnings","double_overtime_hours","double_overtime_rate","employee_additional_taxes","employee_benefit_contributions","employee_compensation_time_period","employee_compensation","employee_deductions","employee_department","employee_donations","employee_email","employee_federal_income_tax","employee_first_name","employee_last_name","employee_middle_initial","employee_medicare_additional_tax","employee_medicare_tax","employee_phone_number","employee_social_security_tax","employee_taxes","employee_work_email","employer_additional_taxes","employer_benefit_contributions","employer_cost","employer_futa_tax","employer_medicare_tax","employer_social_security_tax","employer_suta_tax","employer_taxes","employment_type","employment","end_date","garnishments","gross_earnings","holiday_earnings","holiday_hours","home_address_city","home_address_state","home_address_street","home_address_zip","home_address","job_title","net_pay","one_time_reimbursements","overtime_earnings","overtime_hours","overtime_rate","paid_time_off_earnings","paid_time_off_hours","paid_time_off_rate","pay_period_end","pay_period_start","paycheck_tips","payment_method","payroll_type","preferred_first_name","recurring_reimbursements","regular_earnings","regular_hours","regular_rate","reimbursements","risk_class_code","sick_rate","sick_time_off_earnings","sick_time_off_hours","start_date","total_employer_benefit_contributions","total_time_off_earnings","total_time_off_hours","work_address_city","work_address_street","work_address_zip"]}},"groupings":{"type":"array","description":"How to group the report","readOnly":false,"items":{"type":"string","enum":["payroll","employee","work_address","work_address_state"]}},"custom_name":{"type":"string","description":"The title of the report"},"file_type":{"type":"string","description":"The type of file to generate","enum":["csv","json","pdf"]},"with_totals":{"type":"boolean","description":"Whether to include subtotals and grand totals in the report","default":false},"start_date":{"type":"string","format":"date","description":"Start date of data to filter by","example":"2024-01-01"},"end_date":{"type":"string","format":"date","description":"End date of data to filter by","example":"2024-04-01"},"dismissed_start_date":{"type":"string","format":"date","description":"Dismissed start date of employees to filter by","example":"2024-01-01"},"dismissed_end_date":{"type":"string","format":"date","description":"Dismissed end date of employees to filter by","example":"2024-04-01"},"payment_method":{"type":"string","description":"Payment method to filter by","enum":["check","direct_deposit"]},"employment_type":{"type":"string","description":"Employee employment type to filter by","enum":["exempt","salaried_nonexempt","nonexempt","commission_only_exempt","commission_only_nonexempt"]},"employment_status":{"type":"string","description":"Employee employment status to filter by","enum":["active_full_time","active_part_time","active_part_time_eligible","active_variable","active_seasonal","active","dismissed"]},"employee_uuids":{"type":["array","null"],"description":"Employees to filter by","readOnly":false,"items":{"type":"string"}},"department_uuids":{"type":"array","description":"Departments to filter by","readOnly":false,"items":{"type":"string"}},"work_address_uuids":{"type":"array","description":"Work addresses to filter by","readOnly":false,"items":{"type":"string"}}},"required":["columns","groupings","file_type"]}}}}} \ No newline at end of file diff --git a/docs/api/post-companies-company-uuid-reports.StatusCodes.json b/docs/api/post-companies-company-uuid-reports.StatusCodes.json new file mode 100644 index 000000000..bc96517a9 --- /dev/null +++ b/docs/api/post-companies-company-uuid-reports.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"},"company_uuid":{"type":"string","description":"Company UUID"},"custom_name":{"type":["string","null"],"description":"Title of the report"},"file_type":{"type":"string","description":"File type"}},"x-examples":{"example-1":{"request_uuid":"p83d0ca8-7d41-42a9-834y-7d218ef6cb20","company_uuid":"w83d0ca8-7d41-42a9-834y-7d218ef6cb20","custom_name":"Custom Report","file_type":"csv"}},"title":"Create-Report"},"examples":{"Example":{"value":{"file_type":"csv","request_uuid":"p83d0ca8-7d41-42a9-834y-7d218ef6cb20","company_uuid":"z83d0ca8-7d41-42a9-834y-7d218ef6cb20","custom_name":"CustomReport"}}}}}},"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/post-companies-company-uuid-reports.api.mdx b/docs/api/post-companies-company-uuid-reports.api.mdx new file mode 100644 index 000000000..165c800e1 --- /dev/null +++ b/docs/api/post-companies-company-uuid-reports.api.mdx @@ -0,0 +1,71 @@ +--- +id: post-companies-company-uuid-reports +title: "Create a custom report" +description: "Create a custom report for a company. This endpoint initiates creating a custom report with custom columns, groupings, and filters. The `request_uuid` in the response can then be used to poll for the status and report URL upon completion using the [report GET endpoint](https://docs.gusto.com/embedded-payroll/reference/get-reports-request_uuid). This URL is valid for 10 minutes." +sidebar_label: "Create a custom report" +hide_title: true +hide_table_of_contents: true +api: eJztXOlvHLeS/1e4vR8cA9O6LNuKPq3j4z0Dz7HhY70PitHiNGtmGHWTHZIteWLof19UkexrekYzOoDdIAECj9g8isVi1Y9VRf5Ivqfz2jqdSuVgbriTWqVuWUFyepZAOQUhQCTfJomuwH99K5LTpNLWpbkuK64k2PBrmdW1FKmBShtnk0liwFZaWbDJ6Y/k6OAA/xFgcyMr7Ck5TV5/52VVAIs1k0mSa+VAOazLq6qQOY26/7vFBj8Smy+g5PjLU5no6e+Qu2SSVAZpdNIPZ+CPGqwjkjq1rTNSzZPJgI4XrFbyjxqYFKCcnEkwTM+YWyBpOB0W+kuukcJ2tjd3/dLXZl++vH1FrZHdZaZ4CW3js7a1qosCGd7v5bN0BfRJws5msoDMd3ETHW9kAYyqXF9Pku8peNYTs8Lv9HCVc0l18kQc5PwkfS6OD9PjI/5zevLkeJk+F0eHJzB7lk+PDpIhU5KrLVt1mZG8pL/YRz+93uyS3F4S4Q4ZgXUNcAfpx4YV3fkEscKfl7yo6cews8n9TPTP20800k7/TZLjg+PVDfKrduyNrpVgvynGflOfafmJbhC4bXRtcmBCg2VKOwbfpXV77B2/AGZrAyQvldGXUoAgGWTSskteSLH3m0K+HR8drQ77RVVG52AtnxbAXisn3bKhQFpW8iVb8KoCxa4WoGiUqRZLlNClrk2kkeFu5lJZBsZoY5mt8wXjlp1LRURk3Dkjp7WDjFbqfMK0CULue5hxWVgmamBOM67alo1GOt9jn8DP9Oy1H+YldzDXRoL99tPCucqe7u8Lnds9UnZ7uS73o3JLK740uijo+z6RmeZN88dsXksBbKYNK7UBJsAhQci8HXTVzdz9m7lD5g71O9IsDQiyTEQJqsm+1g/lrTLkxvBlMkmkg9KOWY2VXrMLwAaByuWaMajWjTr3UwU5GhOLCxk2IzVnOs9rY/fY52Ulc14US+Zw6S9g2ZogS/WbNdyvuOElOEABKDjuf6fbLvfIuESqdyANe8C6KF6+J4ZaJnYVtUeQMjY3uq6kmlvGlWA5V2wKrLaemmktC8G8sgv1F1yJQqo5k8pLbwdp7LG3s3Ygadm5IsWW+XU8nxBxfq3YlSyKKPKMM1+TnYeqLCzSkl1Jt2DgVZb/SKwpcb/NtzCUH+J8gzQyPtW166xdyuagwLSrFrqOzLC1mfHcM4QrBkogf0ygwnHB3SiAGeKGsLkNFHDJlWPYDvsMArIMOzmYAKkY7Wmpg9oIGmlawB57ow0LBnLS64LoI1ad+3/JRJ7T2sYStHTnnv3T1pjsJZNEK3g/S07PbppLWRdOIs6jHnEfDTZeLF7dbPHLDlu6P7aVah5HxmZcCImfePGhM5IzNYyOvdwSXv3KywafBY66Be+KTa6Nh7nCMqdJGjoMvnmELysIdRa0ue+GevTae2Z0uQFcNvXqKnN6c8WenhurYB13m5BsF7S9C9KffpVukb5XkHrjl1yvr/UuyI6viktzPfl7zf8Ka449rTXYfT58ReWjVbH0AJfJjWZjj711WFxpayVCLKfZgl8Ca/RQAZdQWFy7YEaioWjUSpJLk9cFNz95clMCP+l7ErjHvaPISAUv0P1D1pSri4znua6VywQU4CCr1axWAkRW8WUJyvVAzFkPayRT7s/HjYlPVsBa0jFzyZtaCanm78AttGALblkcjTWj0Rr0CLsEI2fLTCoS3RwprbSV90rZvxEG4KgsjIqWE08vU2A0vgSxxz4UwC2wfAH5hQcpiFgDOYyX2BBN+7op8MIAF8ss9vigE0D2hgHZFEC18xghsJQWNVRmdO1w26wnLNTIVF1OwYyTOAD5PUI/+vbMt8c9Ec1uoCtIQpZrNZNz25DWYM2duLbaukvMC8dwSR3TClgLZsvaui6wGCcsznbGrYu7JStkKd0GCkcq78zCN0hx6INRH8wudF0IpJkHzjY0ZxUYqUVLLyiRiaAt11DZVBmlbZyXr5VAPAidnUMnKLfgij1hpVZuYRETzmpXG/D0RdeFVKK2ziwzCwXkKN2Z4jK3Wa4FZC0wW0txW3t3fv6KbRm2HRHH7SgMwzw8gVE04Y+aF2hFnjEh57JROxvItZEAuwW5Vua+7u7UfpI50WpXiT0OxHpanSwh07NZVulC5ktyRW231uWtmFiOre+QiFrRjgLR7Bee56bmRWY275letR009wvfjmG7hmPTAlU5IquGHkYESrBrCK+AjGsWHCmbrOOg6S7UvvSbWwDPnbxEkn0f/owbaGA4ANOzWfTqrKMZyqrQSwC7zbI3lXdf+9exKeMGtpeAKS+4yiGrqxv05XprvYmql1yRh5SL32nZ/Wh287IvdCEFanX83xMcYQUB0ftERTFQEGEEQQoWKEALFBZ/PWlKu4cjq3ExE5IeI2zCqgDZyDePZn4tqY15bMTsQUTxra/DYhcMj12248Mg+rSaam4Qhsd698m/uIcR8LNmqIYkT8LKZO6Rgs/ke5SWnD10LJWq5wVG5/LAonlYkYFC/xGCMGd47rTJ8BC2gbZhzd23adOBP++1+MbTImjDkpSj7mtikAP6HxLHDuY4Yuas44ZwO585MHTW3wYFrLbanX8fGlz9aKS/R+02bl0T5KdkYaNcgnJhFtG1uC39vfp3orzX0400x9rtkQZDDtncaGvR3REHV0CHgU1YJ9TYHe4AnREaRBHPBQOSCLXgiix0bbYBhrczdf/E3js7R8GcO3k5ZFDY4znaweIe9c0H33+HAD9Esz1mRv8JKgt03KumQ69PGH7lSB6CbuhbeOusd6e3NHrYITBCxgsHZg21Wehl87n9ToRLy6aAyq0hOIZaBqSSq1FaAoCB2FqVWsiZJLUdSY7ezPskNkaMqpXF9gR4TvZY7hWlBXMZtLhdWgdlUynq8CE2IC1gs5k2Jd902u/Xv4sC6vfU7mrFyD0Z6Cz5d1nW5ZBOW5uK45wfkNTX33MARBGBBlyJw4MD4mqh9UVdbeLlAxIWAVc8A1DKwU/28V7Sj321cZ2zgdO9OT4kA195HD+lLKPDoyc4w55CmxY6vwDTGH9yukk10zsJ/6C3UTBMEhGAcM8PKBXTRoBB+2RqFbfHcPp+7FU6N8+nWRwLrq4eZlJctNDU3m46AzI3z2kGAkOpmePfH3JaiAsJgIfxmOPfGY13uzmukr2FKHqfsE8Sufdp9sQwaqzohb6DXPaIHp+krS36InZ0sW8zKYlJLaHzrhG8cQotSZ5kW09pVlqtLE3js9sEzVea38ZV13TCYiesGbw9QyTrCG6t8l2p7YXLBvyLowVtTC50ni8ytzBgF7oQGQTjk3Tid0MKaFrQ0Lo7ryJfUATIbXPJZcFDMA8Rf3EJjHzzL17+k32OxLFoGTvxI60tOSPQSH6VBthbNWHv9CWwzxqT6wx7xSkc2TWYl2Dsrts0tm2OL7GTQeyI/GLcOSgrOsQ6HSAd420+R43CiZBD1y7Vs5S+hw7jMVPOFXfaoGuPy2I7tx6XxW1celwW3YPukIB47o7esQW3WfP1/r0pPprbBDxwcZvRGKUHBYIaMTBQ4opT6Dw6D9omU5hhZ5gngExnCq6w0wj05HcQmZB2WhsLFExq49ZrJtatvcPu6/gWYtxqFP1s2HvruujToF02w7zSHndfdYimXUdVPBceeHriQMz40dFRysXBSXoM/HnKD57x9Pnh82cnJ/mT6eHznzdMOvZWUrT7NtjfB/h8+8Z+eq1xyl5JjIWzVz74PGEvMSi9lwy5EqnA/Ij6VicQT4VvH1WfR9QI7as+lY8C2vYh/kd7UYe1i7vJWePz2beQijU5x1fcDmUkmUkl7SILXk60rphI4KHXA/ikA4P8Gd9p3NmOtYMPfIKF9igmo65vQmHWGQCXHe6+iu9QeKTKi1qgRvcdoW4xYO2KzOQ+ReluY1Anw559ls7uphebIWuDl/jKaDVn4fQ9HONPWd1CzL1KBoVn7ejF+1NWPuj6E+zN99jh0ZPjp49HtthCK7h1PsQHbB2zIeImPzzoBUox46CQ+SZPw+jmEbXPAId1ocfO1sHwnVuA7aT3ts4qH8IZHOC3cWSPkrU5j+Bz93pAm5NBq+/XBXOzPVKOe7zQV530Bsrl2pTc0J7tb+1NwCFjNt9QILo+gvsZoJlksGQew9qbbX6ouL05pFHinZSgpXCj2Q2WDr9Tm1udQDAnGASjT+xRaPOovUmgNKvAlNK5WMtGqzLlVuYPfDrnlOYX9XdEmwQydjvCKgBhO3YoHANH8Efk21VIDl8zO/q8M8O/Ylp41DNzCouaAFlNm6hx0BiqFeoe0EdPSGK9k3zgc/YUoA+fUWZ67pitK7oaJwgcFcthhD/erwpz8BHQe/dDD5IfOiT7AcUgmrUpXUwa67LbJby8wbZMDdJeVrSVIPswy6bSuMXuo7yiuPqMUfPmaBwsKKVNeABIOme7MG2TC3obEB/A+/MjDsfPDp+ngvOf02MQz9OTp3CQHp6AeCoOAE6ePN2g0igadotDaVFw9ka6P+foihOU8ctRmeNxjeGGJRleDKJhFhAj0hGxCTUHJowcdO6ZU0fi+XT27ChPp3w6S4/54VF6cvTzUfrk+ACOxM85nx6dbODU7bTQW8slX7BfwBRSNWxCvhRLYtFVuL2yHYcipgZlPZ5u/B6b83bW52ptTGENaLQr6d2ky1FKmsOl2pgf2qt269Math6cGBmGYCfsK8AFupqUW9DVu38DH6M6Ok0a3XvPR6U40CZtrzsG9bqXwN+7rZiOJrv3b9/+EoFCc/f2/y1iuJ4kHzt246YJ/UUMyPUk+bWxIDfN+W9T8rcpuYMpibffA3z7RYtlfITAu7L9La17ehUi10VdqpvvG7309eiqZHCyNDlz4XEC1KLvKRluxgsLq/cRmztRoOoSL0n17oDEfxtPRu/ryr2P3tdwmO6W4Z9aBZ+jXWROVvQb/ZSZvyvT/BnvGugyRIlw+gO1InSNGST6EnlXQgbcKLz0O/IpbrlheTD3TTS4vYSHUVM6vjbfpqBgJp1PNETZC+fopkLPXlL3/qLFujrdcgGizld6FFBx40gQu6Va8ZWqMWjSFMToLzk3AafT+9q1Ak1pwUcKSylEgRcapJO8N0QJQubcDNk2WmVQPnCRteF4nUteZBby2pBPpt9sZVGutLkYzt1sWEZz0zKaLNfWdf+e1Y736TBrpmU2k49B6NWu+gQS1At7py2hDdpcwJmjnNtFVM4+h7Aj/DGVeaQo7oMFikTw9mbBu9sri37ZQSF6iYel3r3aLUomye96mnlwNulkLOKa+30HsuzFZsY28cruHW5b1OtZc5TvtOx/iM37pU0f8T4UXoPqF1Byqi/yWilorJVATi+JDfU5zMAYEP1tZlAqjL+RMZi+gTne4+zOIRZF6uPfge7VLqS9yPKC2+ZOkZX5RaxOv8dY1f8QB6OZR3lz2vEiu3ED+WpjYwy+xEFo7w6EsFfWyFuvFOWN8F/zysONpvKf+grNJDW4q4WMGaGtEhoQuDoLZCNRPPqu0rp71ej2dnd+Uulz5+WMmfSpCf5pCG/5wqz8a0MEVSZJJWZ0hRpDABktXpcjU60L4Gr1/vMC3MIfZCIesfXUNyfYNTeckqKpYAhVBMx4XbiwDtc9ERyZZEy0TIKMDh4Owbb+7qGeNW9SzCTmzLIpygfE15eSo4Oj4/TgMD3w8erOVcjdxmxuO2454nEYUUiLEAeCurnl6K9iL8z25t6myW3JgJac27OiJQY6TNmalMiZgZq9+VGUfuR5OEqUdNTk2FZ2r46TvA9N8I0jNhmkbUu/2daMDd8xnQb1Ky+4kSAypVVT2P3dAl+6v5Gt/dA2GswgxPdvNYcQ218zC7roB9msLrxSx8crfBGi1XVFGRRyji8dtN8uuaEk8LbEArcI25qSpCORnRk2yb+d9x2i6h9/nO71Ounb1gKg/m7x+HD4NYbnVdPgTuP27Ml2I3/V5iLG8+8y6ev+KzjxcNq1vl179M2flAcnVX/XjsdHl8JzhZgt0kmColAJKFFpSUnKeNzAkDPd1PMpT/32FKEORYGuSfv004Rsjp+09c9FnXdf0ztvTZB/15GeRnL4KlHnsagK7w3E90zCtsB+AwlfPv6L1ZVW0deHDkyfFEePkYVa/3j9uZnY9s+REYgElcP+HFx8sTLtTuFxYBpSEV/MI2IPD1gpFQbs935Tvymb6wpO2XkM34a+Tq+MdHBO+DUE1b0LJrwA2HtFEKP85Pyko/fQ9bHi24jyMwZH6IW/gGnCGORCDMP+T/oPeu3zxYe36X83yYk0+gK4oPNiO36Q3+G2cxggVuHlMLRAKTpyBXvx4W1MUGTc0nENo8gkSvTyF1bAx87o2S9UruRACtkHE1+n4915ZNlZKRXdb+j0veOjc7ySaWgp1fw/Q4dpp/gxkoFCiY7hddxuVfTRwdHT9OBZevjUa8KArbrl19ffJonjiJ7Pko/hPdRv+CCMrYBfALfLFFckxVOXkYIkgjayfxmSDLcDZQn+o9h4n93ax1on0U3bfbQV1z22Wzdu07A/PtIfoQE99kqC7BbJabJ/ebjf3Lrc/9EV5Ov99u1XuuYTZL42BQpYWDVeSb9oqYCSVm5EtZc66bPL95f6XEH8jLNb0/Fonx8MHSfX9VnhZ5x29C8Q5SHm8CLH+MeLGhlw9q1b6xOKi/ctjtRthAhJjMJFOB+4oc02+lZsSs8TMV6jxnRN7v0k+UQXpu4ygu9hzQDX/pTysXXFdh5SbVynmx2Z33pnx/ZI9234BmqLd1ceZu2djYIS6gL4LqzuHiu6GHcd+O+3HUPk/V6GQLnBuCuAtkWgI0hxDNgN4VbyRV0ofaXwUUg49VfNJoS4xtBR8+jWt3EM036nLDJ/CSrG9MgKoFJFBRAz3bsabJKglrfvZ5/AXMocOtusVbj0MOI+VdwXKFHoak/pb8xYt6HpCnyCAt2mCAGIjkeWvQ5Ki8W7o6jvhc5rnDFJ53+E51a5T8wLQvQqjso+4pOYjbsRfZaoJ8LX/2rVAgo5KrSSq04/4yhqSPmPNgzxN+76v467wqZ08N3tVwWXpEDJYPwIpuwsuTxsHnT2j1KeDnCZaW33Aq3g6Vny4weinS+muL7G4j9qwODZ2Te0pOHIhZZDSIqXr0FRXUn66WMAXI/ZOgS3ZjbxkEI1oh1Pwvt9fYjp3+HwEG838v7ieG+UsZ6B42C54XMLr156ZqWfe1BsNVDZtkATTqZifd0uAvvw/tNnivD54GipCTEafoUiyq/8qsfsU4yeYtmPpOBqXvu4re8T//tfDr6TDw== +sidebar_class_name: "post 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"; + + + + + + + + + + +Create a custom report for a company. This endpoint initiates creating a custom report with custom columns, groupings, and filters. The `request_uuid` in the response can then be used to poll for the status and report URL upon completion using the [report GET endpoint](https://docs.gusto.com/embedded-payroll/reference/get-reports-request_uuid). This URL is valid for 10 minutes. + +scope: `company_reports:write` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/post-companies-company-uuid-suspensions.ParamsDetails.json b/docs/api/post-companies-company-uuid-suspensions.ParamsDetails.json new file mode 100644 index 000000000..d8ab58890 --- /dev/null +++ b/docs/api/post-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/post-companies-company-uuid-suspensions.RequestSchema.json b/docs/api/post-companies-company-uuid-suspensions.RequestSchema.json new file mode 100644 index 000000000..cf5fdc987 --- /dev/null +++ b/docs/api/post-companies-company-uuid-suspensions.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","required":["file_quarterly_forms","file_yearly_forms","reconcile_tax_method","reason"],"properties":{"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."},"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."},"reconcile_tax_method":{"type":"string","enum":["pay_taxes","refund_taxes"],"description":"How Gusto will handle taxes already collected."},"comments":{"type":"string","description":"User-supplied comments describing why they are suspending their account. Required if the user is leaving for another provider and selects \"other\" instead of a defined provider."},"reason":{"type":"string","enum":["switching_provider","shutting_down","acquired","no_more_employees","changing_ein_or_entity_type"],"description":"Explanation for why the company is suspending their account.\n\n> 🚧 FEIN or entity type changes require Customer Support\n> If a company is switching FEIN or changing their entity type, this change must be performed by Gusto Customer Support and cannot be performed via the API at this time.\n"},"leaving_for":{"type":"string","enum":["accountant","adp","adp_total_source","bamboo_hr","bank_or_financial_institution","check","deel","gusto_com","homebase","insperity","intuit_or_quickbooks","justworks","manual","namely","onpay","other","oyster","patriot","paychex","paycom","paylocity","remote","rippling","square","surepayroll","trinet","velocity_global","zenefits"],"description":"The competitor the company is switching to. Required if `reason` is `'switching_provider'`.\n\n> 🚧 Switching to Gusto requires Customer Support\n> If `'gusto_com'` is selected, this change must be completed by Gusto Customer Support and cannot be performed via the API. This endpoint will return a 422 error in that case.\n"}}}}},"required":true}} \ No newline at end of file diff --git a/docs/api/post-companies-company-uuid-suspensions.StatusCodes.json b/docs/api/post-companies-company-uuid-suspensions.StatusCodes.json new file mode 100644 index 000000000..e7b943ab9 --- /dev/null +++ b/docs/api/post-companies-company-uuid-suspensions.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"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"}}}},"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":{"type":"object","allOf":[{"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"}],"x-examples":{"missing_required_fields":{"errors":[{"error_key":"reconcile_tax_method","category":"invalid_attribute_value","message":"Reconcile tax method is required"},{"error_key":"reason","category":"invalid_attribute_value","message":"Reason is required"},{"error_key":"file_yearly_forms","category":"invalid_attribute_value","message":"File yearly forms is required"}]},"gusto_com_requires_support":{"errors":[{"error_key":"leaving_for","category":"invalid_attribute_value","message":"Switching to Gusto.com must be processed by our Customer Support team"}]},"leaving_for_required":{"errors":[{"error_key":"leaving_for","category":"invalid_attribute_value","message":"Leaving for is required when switching providers"}]}},"title":"Company-Suspension-Creation-Errors"}}}}}} \ No newline at end of file diff --git a/docs/api/post-companies-company-uuid-suspensions.api.mdx b/docs/api/post-companies-company-uuid-suspensions.api.mdx new file mode 100644 index 000000000..aa79db8c3 --- /dev/null +++ b/docs/api/post-companies-company-uuid-suspensions.api.mdx @@ -0,0 +1,71 @@ +--- +id: post-companies-company-uuid-suspensions +title: "Suspend a company's account" +description: "Use this endpoint to suspend a company. After suspension, company will no longer be able to run payroll but will retain access to their information, such as retrieving employee info or retrieving past payrolls." +sidebar_label: "Suspend a company's account" +hide_title: true +hide_table_of_contents: true +api: eJztPNtu5Lhyv8IoD94FWr6P7fFDkjlzOWsguzNYezI5mB3IbLHUzbWa1JCU7V7DP5KXPOb38glBFUlJrb642xcgyZ4DHKynRRaLxbqzWHeJrsBwJ7U6E8lpUmnr0lxPKq4k2PDXNKtrKVJb2wqUlVrZZJAIsLmRFc5MTpPPFpgbS8tAiUpL5ZjTzE8QjLMAZ5u9KRwY1kIaxE/sRpYlU5qVWo3AsCEwPiwBwZhasYpPjS5LNqydH2nAcakYz3OwFke5MUjDpCq0mdB+BszW+Zhxi2ONhGupRgwmVamnADSQadP9VnHr4kJ2+zf1m7K5ruCUXUYydChwemOkg8tkkDg+ssnp1+RtpFrybZDcpqPaOp1K5WDk6Zu6aQU4ECZDEAIEjrOQ10a6aXL69S5AmL6hPb2p3Tg5/frt/tsgqbjhE3BgLI1TfALJafLv6V9pjTefztJ/A4NoJYNE4nGMgQswySCx+RgmPDm9S/zqiXVGqlEySEDVE8Rmf3f/Vbp7lO69QnwEFLwuXXLa/f2+f9rvEJeJVGCR7ExwB+mQWxDszaczdu1xYdxanUvuQLAb6cZsqmtDA3JeltvsrGBKK2DSssroaylADPwYXlWlzIloW5Z9nUglJ/WkC/vbD2PnKnu6syN0breJ1tu5nuxE2qbhHOn7Dq9kGmZKNfrHADDt/PwjolFbENvJ/aChcJf9I2kr7sbJIDHwvZYGRHLqTA19Al2MgX3+fPaO6YIoFACtOJD7+w7XGHvDRxGyAVtpZcHipP3dXfzP7GrnNXFMUaNY+MHJIMm1cqAcDu8QdOd3i3Pu5hHRw98hd3OS/Svk2ghmoDJgQTmUFNxSKwu4yUbEtywjrkTJ1LVy2wluC275pCr9FuyNdPlYqlEWjt3gr0Ti04QLOHy1f5KnR3l+mB4Oxav09d4xT1+Lo4Ojg71jOBZHtLfOwZwmB3wXDorhcXogDofpYX6cpydDvpu+zuEgf13sFQdDpAgUBeROXkOGHNvw+HG6f0Anyok0ixAcJCVwVBJZoQ2hWdGMXKtclpA5fptNwI01YmOgqJXA3wAVZYEDpsBNOcXZE5ucFry0EL58r7lxMP8x15MJKGeTU1WXJaqZ28xDtqQWBokd1w6PIxP6RnVo+KrYPRyeiN10jx/upYe7+VH6ungF6d7ucP8IxMnr4/3XL07DGdx65PMbWkK9ik9Xkc7LxGLK+W8PEe5+kFQGrZ6TniE9AeY1ZM/CKfm9BiYFykAhwbBCG2/zWlFA7dEj7GPhQmsZxzIfs2Yd4ZXU3Ek8tNA77tBGc9cXX6f1FfPQCPDMWUWoX1uwSFZvK7rgvxCWiDM46XpbkJb9riUqXyaVdcDFNvuoyimLapTJgl167rnE0Zdb81K4dUnoRR57aL/vb6uSK1J6RNKb8bSL05aNKord8D5tF/PmQyv+pG+C8iMXZcyVQA8GmZnx0gAXU5brsoTc4TqtDe7y/Iz2QDFfzOsNLkOtS+BqDpnzsa5LEfBBGKyBgSgxgsO0YkMY87LoWap/Zhf0D2Mgd4wrewOG5VwxAeTSadWnZ4dBg4mQJlJ4wLgSbKxvIjEMsCHgsIbQYvs3ldwvFPlHbNUD+N+8z1ZLrS1hny2Y1NZoy0GwCID5QUNcJaA6pYWXIUkMPqMUGwJzY/h0XnH4BYKz53fmdRIu46FEX71LqEX6EcltgU34FD18PxcEOuIVl4INp+EUPfkRd1RQY2DXvEQtqVBLzMvmJVJ1kEgHMwzTuDSzCp9PkA5raExdltwwP3x7zg1+aPoX1LVXErmoIFYkYki7ndzj/waJk67E+cHvT88bOiV+wOH+/ry391lVRqO/RzR/r5x0UwxWLhA6EnbMqwqQb8GTbqjFFFEg3xoVLljH0DvkUlkGxmhjm1jpUqprXkqRceeMHNYOMiL95YAFnR4hFFyWlomazp2rdmYTUV5us3MAmvT1vV/mLXcw0kaC3dCFJzTTvJn+IxvVUgAx2UQbYAIDQorbnuL78rL8WFCQtQ7RGfs72btk71OzDZK+Jn7DqNVmhTH8Pq+ElgrzHNTsCnBCwHK6ZA0a9aDQnleQoxuGKg6MpyJNZzrPa2O32cW0khjBTr08X8G0dd68imzOcKcJ3JmBkiLhoCMJpPcWI9YboEZ6eFoBspeH5M1YABXj6cBlbGR0XUk1smSe0LoNgYJdxGZYy1KwHPlgEsaT4+J9Nc+9nSwGxe3NQuipKbAORObP8XJAyPmz8m5QYHnGmR/JLsNQFg5p6tMDQEIVBINIM0F5G63h2n6K+w3cyPhQ165zdikbgQLTnloAHYlha1Pw3BOEK0xiIX1MwMJxwd0aofLbKNwGSrjmymFmhCPMwCDTIMlW1yYna0YyLXVQG0FXDUvYZh+0YSFsHsyAIPyIVJf+vxlidUlnG3/B0OPSk38ITXoFXU6tICi41XuZ1KWTVQl+LRlc047gxZ/nhS1+2UCkZ9e2Uo3iyjiNCyHxEy8/dVby0d6CtT1BHuaaX/gEojsYKNqER55tyC/EhIrAFKOPuloCPyW282AIotfehdGTFb5gM66uMqdXD5zRc4sGWDcTMM4P6fgmPwfuT79IN04/Kki98Uvul4/6OfCOH4pHgzm1v5/5//0zR0hLDXbP+0XlozHGh1tpHQb4K8zGNjtzlAnW1soQS4z5NbBGD5VwDaXFswtmJBqKRq0kuTR5XXLzg0c3Jecn/UgM92PS3eGCAZ6hZ1OVQ66ushA2ZQJKcJDVyscsWcWnTQQXafJ1xtdIMCfedUxOkzlnLemYueRDTTHPzxTTsDG3LK7GmtXoDGYQuwYji2kmVQhjMwGVtvJZMfsbugG4apM0yblS2qF5ofUliG32qQRugeVjyK+8k4Iea0AnxFFo2pdtISRJsgjxRTeA5I1ZmSGAavexAMGJtKihMqNrTGuuQCyMyFQ9GVLmeAGKPSd/BtFf/Xzm56NMRLMb8AqckOVaFXJkG9QaX3Mjqs3P7iLzxjE8UsfwoqZ1Zie1dV3HYjFicbcFty5KS1bKiXQrMFwweGMSfggXeQiDEQxmfYoIbxUDZRucswqM1KLFF5RoUqpLsGyGLMRtMS3fK0E3ZR3JoQjKjbliB2yilRtb9AmL2tUGPH4xlyyVqK0z08wCpg+lVpniMrdZrgVkrWO2FON29Ob0/AXnMpy7gB3XwzAs8/IIRtaE7zUv0YocMSFHslE7K9C1EQG7BrpW5n7s5tiey5xwtfPIHgZkPa5OTiDTRZFVupT5NMNbyfXOevIoIk4WnW8fiVqRRIFo5IXnual5mZnVMjMzbAPN/cbPYzivodiwRFWOnlWDDyMEJdgliIeEYhYSKausY2/qJti+9cItgOPdDKLsYfgYt0nISnJDi5jVWYZzLFew6xx7M3jzs38fp4aU7pocMOQlVzlkdfWAvlxurVdh9ZYrhsTk4nc6dr+aXX3sY11KgVod/+8Rjm4FOaLP6RWFxG3jRpBLwQIGaIHC4S9HTWn3cmgJDZYISJ70IsQGrAoumwHkVa1gKaqNeWzY7EVY8cyPaSt1MOyynRwG4afVUHODbngc95z0izKMDj9rlmpQ8ijMbeYZMbig3KO0lOyhsFSqmSwwJpd7Fs27FRkozB+hE+YMz502GQZhK3Drj9xcTBsAPt5r/RuPiyCBJS5H3ddUl/Xwf0k/trfHBWbOOm7Ib+dYoUax/jpewPyszen3qfGrtxbA22rFuE1NUJ6SBUG5Brqd+kb31j61uC7+M+OfhPkMpAdxjqPbkAavHLKR0dZiuiMuroCCgVW+ThixubsDFCM0HkWMC3ookdeCJzLWtVnHMXycqfsJoXckR8GIY21HD5sg4znawfIZ9c2nUF7ZIuCXaMSjMPoPUFnA41k1HWZ9wvJzIXm4dMPcwhledWM6vcXRux10e8xLB2YJtlmAsjpufxLi0oZ7/gbheNXSQ5VSjdKSAxiQrdVEC1lIUtsR5ZjNfE5k441RNXfYHoFwD98luVeUFsx10OJ2ah1MmkFRh/d9A9ICNvO1uGv4CX78UxTQLKRWqhWj9GTAc8JvsfKzj6etTcVxzy+I6vvbHAC9iIADnsTe7i5RtdT6qq5W0fIFEYsOV4wBqHD1B/vjdjJ799Xe63ztJd2b8CHp5crj+inVj+/tH+AOZxTasNT5FZjG+FPSDWuzN2L+HrSFzjBxRHCEZ/KAUjFtBJheqXl/+37teTxX76c5HAuurl5mU1y0rql93HZ6aK7eUwECr1Kp/OYFt4V+ITngYT0qoaH1HrfHebTXYEWfE/blI8++zRk2jBorZqGfwJczSC/eZFPu+Oyb6tapdo3gg1toUfIo23pIu9Jq7mianN0q13xu+mNSdQ0QFoGwZvE2hkiWIdxa5adiO3Nd1qNfXC1oY0qh83ycubEBO9alyCAYn6Rzf9fHAHxdasR1c1pFuiALUNrmmsuyecQDVpfXwCg3/+btT+wiIseiZezcH2ltKRmBRvKLNMDO1ID9rK+BXWj2Aa9y3nG6juwazPCU41FuUxO+XDcPaWbujigvxp2DSeVfQOjg0jHe1nPUyJzocujapbpI6XsAGMNMOVLcaYOpPS7L9dJ6XJaPSelxWXYD3T4CMe6O2bExt1nz9fmzKf42t7nwwMNtVmNUHtQ8EgtsYGCCJ05X5zF50E4ZQoHAsE4Aic4U3CDQ6OjJWxCZkHZYGwt0mdTeWy/ZWHf0BtLXyS3Ee6uF3s8K2VsGYhYH7bJC10rMUPddB2mSOhriqfDC2xO7ouD7+/spF7sn6SHw45TvHvH0eO/46OQkPxjuHb9esekILVTXP8L39xd8fn5jP73WOGXvJJV0v/OXzwP2Fi+l/euuRVhgfUT9qAjEY+HnR9XnPeqCyppnsNwK3ra/4t/ajjqsPdxVyRrK/a3DFRdtqhDabAs9dOjxSFJIJe04C1lOtK5YSOBdrxfISQcC+RjfaZRsx9rFeznBUnsvJiPQD3lh1hkAl+1tfoo/I/NIlZe1QI3uAaFuMWDtHM/kvkTpaWsQkD5kX6WzuenFaUjakCW+MVqNWIi++2v8IatHsLlXyaAw1o5ZvD9k5S9df4Dt0Tbb2z84fPXjAhEbawWProf4hLNjNUQU8r3dmYtSrDgoZb4q07BQeETta8Nh2dVjR3Tw+s7R44UG2zZZ5a9wegH8OonshWitriNA2Y63IZ2aDDp9fy5Ym+095Sjjpb7plDdQLdeq4oY2tn90NgGXjNV8fYbo5gieZ4Fmk8GSeR/WPmzzw8D1zSGtEhztqKX8O6Xllg6/05xHRSDhvY9/ALMV5my1LwmUZhW+xnYujrLRqgy5lfkLR+ecyvyi/o7epn+atFEIqwCE7dihEAYu8D8i3W5CcfiS3dHnjQn+BcvCo54Z0bWoCS6raQs1dhtDNYfdC+boyZNYniTv5Zw9BpjDZ1SZnjuGr8e0cUyQc1RO+zf8QR3FPfgb0GfPQ/eKHzoo+wVF7zZrVbmYNNZljyt4+YBzmeqVvcxpK0H2ociG0tDL/w1XoWe3umA0vQmNgwWlsgnvAJLOWe+atqkFfYwTH5z3430Oh0d7x6ng/HV6COI4PXkFu+neCYhXYhfg5ODVCpVGt2GPCErLkrMP0v0xwlScoIpffPdXYLjGUGDDC8rZ2zAL6CNSiNhcNQciLAh0nplS++J4WBzt5+mQD4v0kO/tpyf7r/fTg8Nd2Bevcz7cP1lBqcdpoTPLJR+zv4AppWrIhHQpp0Sim/B6ZT0KRZ8alPX+dJP3WF23s7xWa2UJa/BGu5zeLbpciEkTXKqV9aEzwx4dreHsXsTI8Ap2wL4AXGGqSbkxPb37G/BFWMekSaN7nzlUigut0va6Y1DvZwr4Z14rpguL3b/1a92bCuegB7NCQilW+U4LH8lvziwRCuX3Q5i8Sh+H9/+PWAjnrQQ9//j8EUalfX7un57PpeDozSWm3yKt8QKS7PIKYnebMmzuRMZeCui6/DU++eyWcQeWGk4ZJlff0mtAMOw8+AsO+MQj38FjneTlk9D+Vz+Z8igdKvq3ck1/iBgMGduTgvln1elb9OfwD/8uNj7EDo7IX7SYRhvwqNfD3QdyC9s2LOpvsKTbRNPoYu6B3Z+lIcSfox3EJu1GHu4X8sSWJAsbUyx96fZM/SjYr50mMEhafHqLdC078s+VdmMwjbATaf2dlWW/JfTxtyR2l/EtqQQUUmGSJMx5oH1MpO7C/k/9hkY8D6KOudsM7zWymaLXMVcjulmXKtMm6+ZU5g7pgU41q1iM2tT9E/vv//yP/2If3p/9QkFqeNeI5T6EBzS6c06z4+SzTvsuWqvRrBFi3E1Yu7PAwJcz+WVagwIG5Qw6DT3mTMpsrNrOuJacNo/d3maqpXzflIXNiebPMJCHK2rqQN26uMBnlI6XWYgqMT8yGWqdjU0SnntpkxVScZVLXmbIS9LV8TYU7w9IBgBv4xojnmCx9ASCkyeVxedElB+WytXSIczvtcyvhlpfIWtgLfuNNvT3hKuaIziMQqn2VitfzUgMjf/Fgiv8o+LOSE3NTPg0H8Nt+IswqPi01CEtjddm5LUbiaJJZLGo6vE3WxuIRXyDBKkGCPIa/PRsVOohIfQHKCgwwTrHrReBMxe3ebIdV2NWstdo79Rh5nmXJfKwXcbEl1vNoWzRKvFKezGTxgzWE5kUWy90+17G7pS1wXDscH+/W8DNMdlhPS+3rkfbR5BeoNoK+BVwO02pcUOTaMSS6dkenN2xyEGpvgZjpIC2nAJl4tbFKeieecdsaYNKenRc9xpVoqM8O8+3KGwGe+TbQf09NAOX7GXx3Nk9tTDi3jCKaRvHaeulA/tmJjvXezvNUjt33Z5s9zuzVKTyxuC71qbE7EZokcIr6TukpAIm5DMvaI400b2T8PBSf0eKn3FzSwAvhPnJkP+3DGaFn+87zUPP0SH1vuGCFqKNksTFYwdK8p+AG1It/S4W3m2mB9eM126M+j5WEw2ScyoBfcoKHsKSBe4HCTrav7Yu+XsfpS53fTs9ARc1C1yj0WDr9LSmZKN+kK25oQsgX78YAxGvXN58OiNNG4pUug1WBwn2U7Ufi3Mw1zKHDqe0DXqop8kODdwRSDqMCVL6Nxab2DB17h0+lLmeQKNGtyx7H+SaxbJvtLVC5zXSgI7hH0IPJe7v1EI71HdxVfYrdrMJ4uPrU5DVw9d/aTmbmi1q6yZcdeCc9/sCt734+uh3grE/dY9hL18Obt1OVXJJgkgq5S4ovK/J9V7T1NO3azntta/tar1v6LVYh/Pu7tB3+WzK+3v8+XsNGKB//Ybq1lBVuu+HJSmbJJoGpUvP6Ydo9X9ky/vgLtxRbChBI6KyT0J3i9m+mv6Vmm9zvBl6/6+bFy8hrCfg4obRDZ1bG/zWEyu9mHEI5pMh7Qw0B5VbObZrqz99PL9AnzskXCaaXBbDb1Dv8ht/6vFu9vTO/3aXlFyNap8b8jBRv/BZG9TYnPBHp9XRLF/d3fkRF/oK1P19w2YO/02ppPv/AYuRo5c= +sidebar_class_name: "post 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 suspend a company. After suspension, company will no longer be able to run payroll but will retain access to their information, such as retrieving employee info or retrieving past payrolls. + +scope: `company_suspensions:write` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/post-companies-payroll-skip-company-uuid.ParamsDetails.json b/docs/api/post-companies-payroll-skip-company-uuid.ParamsDetails.json new file mode 100644 index 000000000..9ff053362 --- /dev/null +++ b/docs/api/post-companies-payroll-skip-company-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/post-companies-payroll-skip-company-uuid.RequestSchema.json b/docs/api/post-companies-payroll-skip-company-uuid.RequestSchema.json new file mode 100644 index 000000000..adc0a95e6 --- /dev/null +++ b/docs/api/post-companies-payroll-skip-company-uuid.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"required":true,"content":{"application/json":{"schema":{"description":"","type":"object","properties":{"payroll_type":{"type":"string","description":"Payroll type","enum":["Regular","Hired employee","Dismissed employee","Transition from old pay schedule"]},"start_date":{"type":"string","description":"Pay period start date"},"end_date":{"type":"string","description":"Pay period end date. If left empty, defaults to today's date."},"pay_schedule_uuid":{"type":"string","description":"The UUID of the pay schedule"},"employee_uuids":{"type":["array","null"],"description":"An array of employees. This field is only applicable to new hire payroll and termination payroll","items":{"type":"string"}}},"required":["payroll_type"]},"examples":{"Example":{"value":{"payroll_type":"Regular","start_date":"2023-05-26","end_date":"2023-06-25","pay_schedule_uuid":"85100524-4b42-4d2d-bd62-9d864f9aea64"}}}}}}} \ No newline at end of file diff --git a/docs/api/post-companies-payroll-skip-company-uuid.StatusCodes.json b/docs/api/post-companies-payroll-skip-company-uuid.StatusCodes.json new file mode 100644 index 000000000..a0550cc47 --- /dev/null +++ b/docs/api/post-companies-payroll-skip-company-uuid.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"202":{"description":"Accepted"},"404":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided UUID is valid.\n"},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"anyOf":[{"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"},{"description":"Payroll Blockers Error\n\nFor detailed information, see the [Payroll Blockers guide](https://docs.gusto.com/embedded-payroll/docs/payroll-blockers)","type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"error_key":{"type":"string","description":"The string \"base\""},"category":{"type":"string","description":"The string \"payroll_blocker\""},"message":{"type":"string","description":"Human readable description of the payroll blocker"},"metadata":{"type":"object","properties":{"key":{"type":"string","description":"A categorization of the payroll blocker, e.g. \"geocode_error\""}}}}}}},"title":"Payroll-Blockers-Error"}]}}}}}} \ No newline at end of file diff --git a/docs/api/post-companies-payroll-skip-company-uuid.api.mdx b/docs/api/post-companies-payroll-skip-company-uuid.api.mdx new file mode 100644 index 000000000..58cdb787b --- /dev/null +++ b/docs/api/post-companies-payroll-skip-company-uuid.api.mdx @@ -0,0 +1,73 @@ +--- +id: post-companies-payroll-skip-company-uuid +title: "Skip a payroll" +description: "Submits a $0 payroll for employees associated with the pay schedule to skip payroll. This submission is asynchronous and a successful request responds with a 202 HTTP status. Upon success, the payroll is transitioned to the `processed` state." +sidebar_label: "Skip a payroll" +hide_title: true +hide_table_of_contents: true +api: eJztXFlvHLeT/yrc3gUcA9M6xrJs62kdHxs/ODFsebN/yEaL06yZYdRNdki2pLGg776oItnXHJqRpYddJIARe5rHj8W6WFXkTXKdzmrrdCqVg5nhTmqVukUFyclZAuUEhACRfB8ljs8s/vaJL4wuCou/6Qp8jw8iOUkqbV2a67LiSoJNK98wtReyCj8vsrqWIhklAmxuZIVdk5PkSz0ppbOMs/84YKEbm2rDoKwKvQCwjFurc8kdCHYl3Zy5OWBLZvM5iLoA5jTDiWL3PXY6l5ZZHNlaqRWTOMhC5XOjla4t40owzmyd52DttC6Ygb9rsI4ZsJVWwvqJOBsfjNlvp6efmHXc1XaPfa20ih1HEQlhlpY5w5WVuDAQCAo/n1dGY2MQ5zQI7H1T39SHKX0MlMG+k0LnFyDY1OiSmVopqWbN2KKmRUpra7CskBfApMLOBThgFlxdjRgtVs2YVFNtStoapg3Tbg6GZiokVzmEUTx4v14L7EoWBZsAOxqP2VcVMPNJAeydctItIkFy7mCmjfwRxvfr8OANUpn57Z2AYFLRRzBGm2YmS+u3ua7ghJ2HBdoTU6vzZJRU3PASHBhkt5tE8RKSk2TAQBL5puJunowS3DhpQCQnztQwSpAnSp6c3CSejxPrjFSz5HbId6dzYF+/fngblxDmSG5HzbT/k/4XScfrTx/S/waDnBRnnwMXYHrzT3lhYTjLW1xLKRVYmkRwB+mEWxDs9acP7NIPusTgC10bapBz5OYPU6a0wo1jldGXUoAY+Ta8qgqZ01Y8seyslEqWddkd+/svc+cqe7K/L3Ru90jc93Jd7kfxjqJK3/d5JdPQU6rZv4cB087PTxFGbUHsJeupPUpA1SVqjPHB+Hl6cJwePkedIWDK68IlJ93fb2+/ezqCdb9qscDhhtuaa+VAOfzUWfP+XxapfNPB0Sd/MorA9OQvyB1ymEHF5SRYbB4Wn/lWy8voDxfUH6NW7Ro/w6wuOHLDb4i50VzJKHkrLYpl/8fTRk14adeF6Omz5PvtKLGOG5chw2yFi1VgpBaMuhGfIcuDErsPAUrQAMR4BUwdYneLEQu7Z0m1acEXT6xviFNVfJHFBXhBvXPOoQj2aIDoA8loONuOd5ZwY/giGSWqLgrPV91xXytGDXDcxooEozCVUAhkYa2KRZSfibchCq7YXJpWpaOZ8PLrtV34HZWAg9Ku0DK3t12VcNbnL9xWuOaotanvO/93/OslL2pYZsgOa3X5AaXnWXrwPB0fJ91NDr8fp+PnycodSV4+Pzw4eD4+So8mR+P0SIxFOhHH4/SVeHl8NH3FgR8f4SrCQoLKRmDjg/GyfL3Oc6gcCNyto4Oj5Qa/a8fe61oJ9k0x9k2dks0hUQeBNkHXJgcmNFimtGNwLa3bYx/5BTBbG/B8EZSeZxZp2SUvpNj7pmja8QpcqyxYsoMW4Wrxx5Qs0N3jxoVJy0q+YHNeVaDY1Ry89ZtoQYxI+jq6GQiES2W9bURXJZ+j7TyXitaWceeMnNQOMuKM8xFactcSj025LGz0C7hqezZu2fke+wKegGfv/DRvgvEGu6NZIJhp3nR/yma1FEB+WqkNMAEOAeGeLKvcrkD4BaPM9hVx+L2VqCjiQ0lbP2p2AbTJHuVizRzU6k7V9KWCXE4lWNzIwIbej9F5XhvUJotKonleMIdbfwELJgUo53th+2YP9xuvhhkoyMwH55CGJPXZoN4BGo6AbUnP0UgM5SsOFeUmcBmbGV1XUs28+5tzhf4eWnJEM6llIViOfFCG9nOuROEdSs+9nVMC2YZmImnZuSKRzvw+nnvv0u+V9y0DyzPOfEt2HpqysEnBxQTvbvqPRJoS5W22jQ2L6w3cyPhE166zdymbgQLT7loYOhLD1mbKc08QrsgQ1hZMQOG44I6vYsU+jDdRuA0UcMkVmWNO/rtnkEV0vb3yk4qRTKOFIbXRWqU99h5PQt5OjHpDED4i1bn/P5mMc9rb+Asq/fPGtY9qFB03rSAouM1rKevCyaoAPxfK0UDw4s/Lwha/7CDS/bnxMBNnxm5cCHKaePGpM5P3D1fMvdjSqfudlxA9kEBRN+ddtsm1ac6FTu95x6oh8N0zfFXy7xpa9WBIb7bz0Yhee6M/2HV0mhG9p9O0q6vM6c0Ne3puVQM6jW5qcjtKnHTooCQfA/enf0o3T/9QkAajeru+1cfAO74pbg2erf7Z8//7e06O7DqD3afDn6h8yNcm147JjWZjj31wdMzV1srglc/5JbBGDxVwCYXFvQtmJBqKRq0kuTQ5Os2/eLgpOT/pH8RwT5PuClc08Ax9nXb99AlXFxnPc10rlwnAmEtWq2mtBIis4osSlOs5MWc9XyPBA3/XMTlJlpy1pGPmkve1ElLNPoKba8Hm3LI4G2tmoz3oAbsEI6eLDONCxkCOSCtt5YMi+xe6ATgrC7Oi5US/fQKM5pcg9tinArgFls8hv/BOCnqsAQ7jJXZE075uCbwwwMUiiyM+6gKQvGFCNgFQ7TpWAAwhtszo2qHYrAcWWmSqLicUKFoBceDk94B+9v2Z748yEc1uwBU4Icu1msqZbaA1vuZOVFvu3QXz2jHcUscwCtU6s2VtXdexWA0srnbKrYvSkhWylG4DwhWNdybhe0QcxmA0BrNzXRcCMfNA2QZz5qMfLd5u7GQNyqbJSmyrafkuRFc6kkMnKDfnij1jpVZubtEnnNauNuDxxQCoVKK2ziwyCwXkyN2Z4jK3Wa4FZK1jthZx23p3ev6OfRn2XcGO2yEM0zw+wMia8HfNC7Qix0zImWzUzga4NgKwW8C1Mvdtd0f7ReaE1S6DPQpgPVYnS8j0dJpVupD5IsPo9HZ7Xd6LiOWq/R2CqBVJFIhGXniem5oXmdksM71mO2ju174fw34NxSYFqnL0rBo8jABKsGuAV0DGNQuBlE3WcdB1F7RvvHAL4LmTlwjZj+HPuAEDwwmYnk5jVGcd5iaIuc22N4133/t3bcrNwPYcMOEFJpayurpDX6631ptQveGKYoNc/EXb7mezm7d9rgspUKvjHw84uhXkiD6kV/QmZPGiG0EuBQsIKKrtEayHprR7PFhNcJU86VXARqwKLpsB5FWtYC3Uxjw2bPYorPjBt2ni94xyAJ0YBuHTaqK5QTe8Sa88IP2iDFOStZmqzeQQhKXFPCCCU4o9YvJahWNpSKnGKDAGlwcWzbsVGSiMH6ET5gzPnTYZHsI2YBu23F1MmwH8ea/1bzwW4bP6yOWo+5pagQH+x/RjB2tcYeYoy4ID8KkDQ2f9bbyA5V670+9T41c/WTHek1aM29AExSlZEJRLUC6sIoYWt8Xfa/9TyHsj3Yk5tm6PNJT7mhltLYY74uQK6DCwydcJLXZ3d4DOCI1HEc8FA0jkteCOzHVttnEM72fqfsPRO5KjYMadvBwSKMh4jnaweEB9E/PbLQA/RSMeU6N/gMpiHvQhNR1GfcL0S0fypoQG40PWh9NbjN7tEJgh44UDswZtFkbZfG7/KeBYxgNUtxMBx1TLACqFGrFgSJZxb2tVaiGnktT2sCzhIcHGjFG1tNkegKdkj+ReUVowl0GL24V1UDaNog4f+gY+cZ/5cqQt/ISQ6P8JBdQfqZXqUBEQcJb8GstahjhtbSqOa35EqO+ucwD0IgIG3InDgwOiaqH1RV1touUjAosOVzwDULL9F/t0L+nnvtq8ztkg6N4cH5JBrDzOn+I/08PxM1xhT6GF+rHG+FPQDevYdmL+wWgrnWHiiOAI9+KAEovlBBi0T6Zuaj2Gy/dzL+PcvJ5mc6hU73EWxYXo1EzeazkDmJvXNAWBqdTM8evHXFZT5RjmY45f+4rH+61xGfYWrOhjwr5c5MGX2WPDqLFiFPon+LIHevUibW0xFrFjiH2bRVH9bRi8awTvXEILyUNuq3iXtqaJ2W1yzZe63ydU11YSN5WuzeTtGSJZB7i1yj+LtpcuG9Avzha0MYXQeT7P3NyAnetCZBCMT9LJ3w0R0LKgwbo7rSJdkAUobHPJZRFL7NDjLy6BUWz+9Zvf2GkEx6Jl7OSPtLYUjEAj+ScW5n1QI/ZRXwI71VhWZthbTunIrsEMdar3cpua48tlU+7byx1RXIw7hwWRFMDTwaVjvK3nqKkKmyuma5fqaUrfw4DxmClnijttMLTHZbFdWI/L4j4hPS6L7kF3CCCeu2N0bM5t1nx9+GiKz+Y2CQ/c3GY2RuVBAVDDBgZK3HFKncfgQdtlAlMcDOsEkOhUw6lVdKpLeQ0iE9JOamOBkklt3nrNwrqtd5C+Tmwh5q1Wej8bZG/dEH0M2mVTrKjsUfdtBzRJHTXxVHjk5YkDMeXj8Tjl4uBlegT8RcoPjnn64vDF8cuX+bPJ4YtXGxYdRysp230f398n+Hz/xn56rXHC3krMhbO3Pvk8Ym8wKb2XDKkSUfhrHvdH4ftH1ec9anTtqz7KJ8Hb9in+J3tRh7WbuylYQ7G/bbhiTbXtFbdDHkmmUkk7z0KUE61re8HkEWLSgUD+jO80SrZj7eSDmGChvReT0dB3eWHWGQCXHe6+ix+ReaTKi1qgRvcDoW4xYO0Sz+ShqPin5qBBhiP7Kp3dTS92Q9KGKPGV0WrGwul7OMcPWd2Dzb1KBoVn7RjF+yErn3T9BfZme+xw/Ozo+dMVIjbXCu5dD/EJe8dqiCjkhwe9RClWHBQy3xRpWCk8ova14LAu9dgRnXD/zHbKe9tglU/hDA7w2wSyV8LaXEdw2i2Mb2syaPf9vmBttveUo4wX+qpT3kC1XJuKG9qz/b2jCThlrOYbMkQ3RvAwEzSLDJbM+7D2bpsfGm5vDmmW4GhHLYWCZjdYOvxOfe51AsGaYBCMPrEnoc+T9iaB0nh/p5TOxVY2WpUJtzJ/5NM5pzK/qL+jt0lOxm5HWAUgbMcOhWPgCv8j0u0qFIevWR193pngf2JZeNQzM0qLmuCymrZQ46AxVEvoHjFGT57E+iD5IObsEWAMn1Fleu6YratK4zUxco6KxTDDH9RRXIPPgD54HHpQ/NCB7CcUg2zWpnIxaazL7lfw8h77MjUoe1nSVoLswzSbSEMXT3ec5S3l1aeMujdH42BB/XU9cgBJ52yXpm1qQe/jxAfn/cWYw9Hx4YtUcP4qPQLxIn35HA7Sw5cgnosDgJfPnm9QaZQNu8ehtCg4ey/djxmG4ug6XsVRmeNxjaHAEg/PB9kwC+gj0hGxSTUHIqw46DwwpcbixWR6PM7TCZ9M0yN+OE5fjl+N02dHBzAWr3I+Gb/cQKn7aaEPlks+Z7+CKaRqyIR0wcuLKtBqawpFnxqU9f50E/fYXLezvlZrYwlr8Ea7nN4tulyJpDlcqo31ob1m9z6tYe/BiZFhCnbE/gS4wFCTcnO6evcv4KtQx6BJo3sf+KgUJ9qk7XXHoN72Cvh7txXTlcXuo+ENx5gC/jXGOak9XtnHm0j+YhVFpZs3BkbMxmuGS53pluCOdw3j0xExAPr0zkvcrXu37UWje98LRK/bf2LfaEe/Jbvd3usNMHCz/FhbX3f7rS65oiM0RVc7HzsXqmk/oht3xzW2PlW2osfrNQ9CDGYeMToafktmoKkQmEiO6413jSPPBhZKIwt5fiXGDjczbAX8ArhdpGizU30JxkhBGC/oTAvXDpQlfx5l0Evf2pdORvHudffFE5SL2G/dfE1HPy8+YhBiWP41FLqB7ebJSbJ/ebjflDvt33Rfs7iN7G73A3rKsgf1UZsCjWyQHl5JLzypgJIkaGk73kKpkz6R/HipD9XhZ1zbmoFXjvnJUFhu3ZgVfsbFW8hrQ0fKs5t4SHhN76S8rpEMZ9+7rb7gXWvPaCvaNmyHEOM7E/jvCXBD55HhlUsaIqXbQYzXbo5Hwpj6GiVfqF7hZ2bwI6yZ4HaU4B3yz+0bFp2r/dvd6O88nCGWflt1k7/tMHglIfmqLpS+UnhDGU583cOIbndRUMLn1KO40QMn+F4IsnNMnHQf5xgl+ACC/WP6BcylzKHDNq0ip3u2+9RwXyCFUI+k9G9MgNjQdeluGBS5LikvRDieWPYuiCCLpgSfMhE6r9FeE7X/Ldzj5z7OE55qeRtnZZ/xhnU4zPucCfJ9+PqfLZvjpqGYllx1xvmCzwjxzkMPPcQ37QsC/7xb9M+7RZ13i4JwO7h2+1XBJWkd0rI3wQqcJZcUkY52IBklJ4N3jeKgqBvQGHzHAmzrsO/NDTobX01xe4s//10DOhtn39EIGaoZ869VSFr7mteIuuz7y+dw0H3K1r2EtGZV0ceiFtEEJuHuaf+pJl9D7p9K2g3e//N3k1YS1hNw9aNTDZ1bz+SNJ1Z62vNilh82aXv411o2tu06MZ/++HKajJJJeJKp1ORkGX6FbwDwK7/rMXKKbzbhbzdJwdWs9kcYPyb+97927UfZ +sidebar_class_name: "post 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"; + + + + + + + + + + +Submits a $0 payroll for employees associated with the pay schedule to skip payroll. This submission is asynchronous and a successful request responds with a 202 HTTP status. Upon success, the payroll is transitioned to the `processed` state. + +If the company is blocked from running payroll due to issues like incomplete setup, missing information or other compliance issues, the response will be 422 Unprocessable Entity with a categorization of the blockers as described in the error responses. + +scope: `payrolls:run` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/post-departments.ParamsDetails.json b/docs/api/post-departments.ParamsDetails.json new file mode 100644 index 000000000..9ff053362 --- /dev/null +++ b/docs/api/post-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/post-departments.RequestSchema.json b/docs/api/post-departments.RequestSchema.json new file mode 100644 index 000000000..b8a3b0c62 --- /dev/null +++ b/docs/api/post-departments.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string"}}},"examples":{"Example":{"value":{"title":"Stage Hand"}}}}}}} \ No newline at end of file diff --git a/docs/api/post-departments.StatusCodes.json b/docs/api/post-departments.StatusCodes.json new file mode 100644 index 000000000..a31c28fb1 --- /dev/null +++ b/docs/api/post-departments.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"201":{"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"},"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/post-departments.api.mdx b/docs/api/post-departments.api.mdx new file mode 100644 index 000000000..f228921c2 --- /dev/null +++ b/docs/api/post-departments.api.mdx @@ -0,0 +1,71 @@ +--- +id: post-departments +title: "Create a department" +description: "Create a department" +sidebar_label: "Create a department" +hide_title: true +hide_table_of_contents: true +api: eJztXFtz3Day/is4PA+Oq4bSzGh0GT0dx7LP+sGJK3ZOzpbiokCiOYOYBBgAlDRR6b9vNS68zUUaWXrYrWzVVqwh0PjQ6BsaDdxFt/Gi1kbGXBhYKGq4FLFZVRCdX0ZQpsAYsGgU0arqNtHR11EkK3B/fWDReVRJbWIGFVWmBGF0NIoMXWikc9H59esoYqAzxSvsGZ1HbxVQA4SStu/v4nehM1nBObnqUDy/UdzAVTSKFPxZgzY/SraKzu/sn1wBi86NqmEUZVIYEAY/0aoqeGZRHv6hccC7SGdLKCn+y000kukfkJloFFUK52Q4aPuVmwI6zbRRXCyi+/v7UQS3tKwK1+6d+zf+85oWNXT6Rp8NXQD5BxUM+9muFVW0BAMKeXMXCVpiw0yWFRWrpK458psjaypqln623emt4Q/Ahqz9sgTy668fLojMiVkC8WNE96Nm2P+P/9cu/5tPH+L/A6Wxox99CZSB6o2f00LDcJQLnEvJBWg7CKMG4pRqYOTNpw/k2hElVGuZcWqAkRtulmQla2UbZLQoDsiHnAgpgHBNKiWvOQM2cm06K/hKk8uSC17WZZf21x+WxlT6/PCQyUwfWHk+yGR5GOQ3ruhKyaKw3w9pxWPfk4vFf3uCcefn1wij1sAOou3cHkUg6hLFezqeHsfjk3hy7KQ7p3VhovPu7/f3X5GPupJCO6GZjif4nyErg7CTn61MkiBb3yHUtCh+zq2o7RZ3P/lNM10Xq6xWCmGG5fUS5kgfkM8A9u/LltFkUXMGe64VZ1BW0oDIVq9JLhXhIpeqtFMnUpClvCFG4loRs+Sa5BwKdhChmgUN9FJN0wKs4O9mglW/R3Ggq1itkUIl7Kny3rRaJd1mgIYUfqIlbEYCZVXIFXhz5ohQpehqjcYb/BWJNF1QY/lCAEMG90mjWnADpSX7GP45w4cSrGhmpNoDT6fTcyOyShnE5KLPuAfMuyMaHZ9MT8bpEYuzo9PjeDY5zuL09JTGp8dsPs9PJ6eT+VE0FIjodHx2SqdnZ/HZ0Wwez06OpnE6n0KcZvNZnp7O8+kcFX6DCxm1Shqx+Xg2GzM2O5mdjCdskp3lM5jDdDZmeXpKT6Le8l82mGeTyXyOcOl8Po9ns8ksnuezcczmaX48P0knRzMWIWd6y9X2P5qdnR3P5nl8MoZZPJvP8pgezWg8Z2eUsiNK0/w4uv8avN1sPFu3cz9JQ97LWjDyuyDkd4E64H06MKJAy1plQJgETYQ0BG65NgfkI/0GRNfK2ZbgJ5z2cE2uacHZwe8CF3A2na4P+6uolMxAazQG5J0w3KwaBFyTkq7IklYVCHKzBGFHSSWzcmh9kcdohZJyoQkohYKp62xJqCZXXFgQCTVG8bQ2kFiRuRoRqSy5QCGnvNCE1YCyTEXbswmqrjpW9J0b5i01sJCKg97TjFqYcdZ0f+2MsbWopVSoSQYBIfP28DQPc/dv5g6ZO3Q/bXB1GbkJYxDRN2H+93Wb2Zi8B6km3wA7eJSrLWPYVg/6m88VZDznoHEhvTLa7kRmWa30AfmyqjjGdSvnlb/BinAGwrhe2L5Zw8MmHCYKChsfeutuSR5YhxpQ7wENKWBb69MsJWLjFk8qWA8vZWShZF1xsdCECkYyKkgKNgRENGnNC0YylIPSt19SwQqMarhw0tvZHNlothmIa3IlrGFL3DpejTqhErnhRRFEnlDiWpIr35T4RVq5oBmcyXIfLWtK1LfFI4KET2G+XhoJTWVtOmsXkwUIUO2qedKBGbpWOc0cQ6ggIBjyR3kUhjJqNoafg91eUG4FBVxTYXC/QJGmF5CV12TvArggVqcx3rNmw1uktIAD8l4q4j31qEfC4rOsunL/TRDVlV3b8Au6syvH/rR1JhhISAFbAub+XMq6MLwqwI2FejRQvPDzurKFL3uodH9szcUijIzdKGMcP9HiU2ckt1/cMLZjyH6hpeeoWdKu2GRSuX0N08RIKw0dBj88wq+C/1lDax6UtZvteJais965kmVL8LKlKOqiiL427eoqMXJ3w56d29RAG2pgV5PODuOjl/74N26W8c8CYuf8XKZgc6uPXnZcU1yaTXuTv9f832/NkdJWh93nw29ofKQoVi7AJXyn2zggH4zNj0itOYZYRpIlvQbS2KECrqHQuHbejQRH0ZiVKOMqqwuqfnBwYxv8xC7Z8Lq3b97QwAn0bdzdHaVUfEtolslamIRBAQaSWuS1YMCSiq5c1q8TxFz2Yo0IM0XdwOQ8WgvWoo6bi97XgnGx+AhmKRlZUk3CaKQZza5BD9g1KJ6vEi6s6GaItJKaPyuyf2IYgKMSPyp6Tty9pEDs+BzYAflUANVAsiVk31yQghGrh0NoiR3RtW+bAi0UULZKAsUXnQCy1w9IUgDRzmMDwJJrtFCJkrVBtdkOzLdIRF2mNsO4AeIgyO8B/cX1J64/6kRwux6Xl4QkkyLnC91Aa2LNvbi23rsL5o0huKSGYPqyDWbLWptuYLEZWJhtTrUJ2pIUvORmB8INjfdm4XtE7GkQS4PopawLhpip52yDOalAcclavCBYwry13IKyabIR22ZevhPM5o87mmN3UGZJBTkipRRmqTEmzGtTK3D4QnaFC1Zro1aJhgIylO5EUJ7pJJMMkjYw24q4bb0/P3/CvgT7bhDHxyH0w7w8wCCa8GdNC/QiJ4TxBW/Mzg64OgDQj4Creeba7o/2M88sVr0OdubBOqyGl5DIPE8qWfBsleCxxuPWunwSE8tN6zsEUQurUcAafaFZpmpaJGq3zvSa7WG537h+BPs1HEsLNOUYWTV4iAXIQW8BXoF1rolPpOzyjoOu+6B965SbAc0Mv0bIjobb43oMBAcgMs9DVmcb5ibJ+ZhlbzOie6/9uzYxruDxEpDSgooMkrp6wF5u99a7UL2lwmZIKfvDLrsbTe9e9qUsOEOrjv93gENYYQPR54yK3jpj0oQRNqQgHgF6IL/426EJaV4OVpNitpH0JmAjUvmQzR1USwFboTbusXvu8vyi+MG1ac5qCG67dCeHYfFJkUqqMAwP7Z6Tf0GHMeAnzVANJAdhbTLPiOCLzT1ybZM9dlvKRS8LjMnlgUdzYUUC9jQwaQ84EtyE7cA2bLm/mjYE3H6vjW8cFmYV1ko52j6Ht1XYgP8l49jBHDe4OW2osnE7zQ0ou9d/TBSw3mt//n1q4upXG+i9atW4TU3YPCXxinJtzwjtLEJq8bH4e+2/C3mP0oOYQ+t2S4NHDslCSa0x3REGF2A3A7tiHd9i/3AH7B6hiSjCvmAAyUYtuCJLWavHBIZPc3X/QOodzRGwoIZfDxnkdTxDP1g8o7355Oh3ALghGvXIlfwLROJxPKulw6yPH35tS+4P3TC38MFol05vMbqwg+EJGS0MqC1oE09l9779u4BzTVJA49YADkctA6g21ci1DQA92FqUkvGcW7MdIIds5nOCDSdG1dpiOwCOkz2WO0OpQV17K65X2kDZNAo2fBgbWCugE1fO8og4wbX/HgPUp9RqtSA2PelxlvQW66GGOHWtKopzfkGo724zAIwiPAZcicl4bLlaSPmtrnbx8gWBhYAr7AFsycEP+vVB1D/7as91LgdJ92b7EA1y5WH8GP+MJ9MjWzvRNWhpIbNvoBrnb5NuWAe1l/APqG0Mhq1E+EC4lwfkgkjFQKF/UrUI6jGcvht7Hefu+TSLo8HU1ctMijLWqWx60nQGMHfPKQeGR6mJobcvOS2MC20A7scjht4SO97T5rgO+xGi6HLCrkjk2afZE8NgsUIW+jvksgd68yR1rTEXsWeK/TGT4ljU4ol3neCDU2ghOci6Tu2spFhbmiZntys0X+v+lFRdQ4QEIqQZvN1DRNsAt175e9H2jssG/AujeWtsU+g0WyZmqUAvZcES8M4n6pzfDRHYaUGDdX9eBb6gCNi0zTXlBfWHeRjxF9dAbG7+zdt/kC8BHAmesXN+JKW2yQh0kr9xBeSDGJGP8hrIF4nFdYpcUHsc2XWYnRrfvcOmZvty3dSJ986ObF6MGgNlZTexWJdrQzpC23qOGoUTQw5Zm1jmsf3uCYZtJl8IaqTC1B7lxePSepQXT0npUV50N7pDAGHfHbJjS6qT5uvzZ1PcaW5z4IGL24xGbHmQB9SIgYISV9wenYfkQdslhRyJYZ0AMp0IuEGiIdDjt8ASxnVaKw32MKk9t94ysW7rPbSvk1sI51Ybo58dureNRB+DNEmOdaU97l50QFuts00cF154emzMcjqdTmPKxmfxDOhpTMcnND6dnJ6cnWVH6eR0vmPSgVppT7ufEvu7Az7Xv/GfzmqckwuOZ+Hkwh0+j8hbPJQ+iIZcCSiwPqJ+0g7EoXD9g+lzETWG9lUf5Ssfbbsj/lcHwYa1i7srWWNzf4+Rii01xzdUD2Ukyrngepn4LCd6VywkcKHXC+SkPYPcHt9I1GxD2sEHOcFCuigmsaQfisK0UQAmmey/ih9ReLjIipqhRXeE0LYo0HpNZjJXovR9Y1giQ8quSmd/14vdkLU+S3yjpFgQv/sejvEXr54g5s4kg8C9dsji/cUrd+j6AxwsDshkejQ7fr1BxZZSwJPrIT5h71ANEZR8Mu4dlGLFQcGzXZmGjcrDalcBDtuOHjuqg8d3Zgm6U97bJqvcEc5gA/+YRPZGWLvrCL50rwe0NRl29d26YG22i5SDjhfyplPeYGu5dhU3tHv7J2cTcMhQzTcUiG6O4HkGaCbpPZmLYfXDPt83fLw7tKP4QDtYKVQ0vcPT4Xfb50k7EKwJBkbsJ/LK93nV3iQQklR4R9GY0EoHr5JSzbMX3p1TW+YX7HeINm2Qsd8WVgAw3fFDfhu4If4IfLvxxeFbZmc/783w37AsPNiZhT0WVT5kVW2hxrhxVGvoXjBHbyOJ7UnyQc7ZIcAcPrGV6Zkhuq4qqQxhNjgqVsMTfm+OwhzcCeiz56EHxQ8dyG5ANjjN2lUuxpU2ydMKXt5jXyIGZS9r1opZ/5AnKVf2xvKeo1zYc/Wc2O7N1th7UFs24QJAa3Med0zb1II+JYgP9/SmFGYnk9OYUTqPZ8BO47NjGMeTM2DHbAxwdnS8w6TZ07AnbEqLgpL33Py1wFQcsxW/FI05btcIKqyV4eXgNEwDxoh2i9gcNXsmbNjoPDOnpuw0zU+mWZzSNI9ndDKNz6bzaXw0G8OUzTOaTs92cOppVuiDppwuyY+gCi4aNiFfipVl0Y2/vfI4DoWYGoR28XST99hdt7O9VmtnCauPRruS3i263Iik2VyKnfWhvWZP3q1h78GOkeAR7Ij8BvANU03CLO3Vu38C3YQ6JE0a2/vMW6Uw0C5rLzsO9b5XwN+7rRhvLHbvXwP+MQQKzSXgf9uI4X4U/dLxGw9N6D/EgdyPop8aD/LQnP92JX+7ku9wJeH2+22sK6DfgOpVjEoQy2tQijO7NbKBM54H3xoQ2u6xcDpuIlvf5RkF2X3gfR5cp0BqG4iGVgCD9/59stG96IMPZOArNOfR4fXksKlLO7zrvmlwf9h/98cWQ4RXA1SBAuwvVNOKu/vUMYPSXqpeuxR1AaWM+pxz9GKXUcXPOLcthDfS/KRs9nQbzQo/49Q1ZLWyO//Lu2CZ32ToJd7UyITLr91Wn/EivHMOG9o2d78QYnhHBv9OgSrrBIY3Yy2J2F7iIrQ2S9y5hxPKUfTZlpV8zwiOwpYB7kcRXvD/pX1ZqfPuRXCa7UNDof4gfLGvCOGjPL03Kjov4IwifCVI/5x/BnXNM+isXXvB3t5JPrQNDxnCRO8f27/xsEj7rmv36KDIZGnP0CyOV5q886pBQtkWvhfEZFajjNop/5d/6YC6nJh/D+kijEp+wdvoPvHhzpdQ+PzX/2llzT7pJLUpqejQ2fCq1RD2XfvQwpMewfKLb+DWHFYF5VZKrFbceZ29jK4nzfMj7n7y+eCdKdZ/mmuJKn9+Gd3dYRTzqyru7/HnP2tAW3r5FQ2GsmVYVkUYt+HTlpehuhP84Rfv+l+TbQ/ebJlRuEFpWwRzFfnrnP2nVVxZtnu2aj94/+FvWG1krGPg5gfAGj63XuStY1b8peeE1l8IaXugrarMzrZdd/Pp589folGU+kfdSmm9pKI3eK2e3rhVD8lIfPUNf7uLCioWtXPjjib+718hr1h/ +sidebar_class_name: "post 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"; + + + + + + + + + + +Create a department + +scope: `departments:write` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/post-employee-ytd-benefit-amounts-from-different-company.ParamsDetails.json b/docs/api/post-employee-ytd-benefit-amounts-from-different-company.ParamsDetails.json new file mode 100644 index 000000000..230d65c22 --- /dev/null +++ b/docs/api/post-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"},{"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/post-employee-ytd-benefit-amounts-from-different-company.RequestSchema.json b/docs/api/post-employee-ytd-benefit-amounts-from-different-company.RequestSchema.json new file mode 100644 index 000000000..726ce4730 --- /dev/null +++ b/docs/api/post-employee-ytd-benefit-amounts-from-different-company.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"benefit_type":{"type":"integer","description":"The benefit type supported by Gusto."},"tax_year":{"type":"number","minimum":2000,"maximum":2999,"description":"The tax year for which this amount applies."},"ytd_employee_deduction_amount":{"type":"string","default":"0.00","description":"The year-to-date employee deduction made outside the current company."},"ytd_company_contribution_amount":{"type":"string","default":"0.00","description":"The year-to-date company contribution made outside the current company."}},"required":["benefit_id","tax_year","ytd_employee_deduction_amount","ytd_company_contribution_amount"]}}}}} \ No newline at end of file diff --git a/docs/api/post-employee-ytd-benefit-amounts-from-different-company.StatusCodes.json b/docs/api/post-employee-ytd-benefit-amounts-from-different-company.StatusCodes.json new file mode 100644 index 000000000..8c4f80195 --- /dev/null +++ b/docs/api/post-employee-ytd-benefit-amounts-from-different-company.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/post-employee-ytd-benefit-amounts-from-different-company.api.mdx b/docs/api/post-employee-ytd-benefit-amounts-from-different-company.api.mdx new file mode 100644 index 000000000..58949b2e9 --- /dev/null +++ b/docs/api/post-employee-ytd-benefit-amounts-from-different-company.api.mdx @@ -0,0 +1,73 @@ +--- +id: post-employee-ytd-benefit-amounts-from-different-company +title: "Create year-to-date benefit amounts from a different company" +description: "Year-to-date benefit amounts from a different company represents the amount of money added to an employee's plan during a current year, made outside of the current contribution when they were employed at a different company." +sidebar_label: "Create year-to-date benefit amounts from a different company" +hide_title: true +hide_table_of_contents: true +api: eJztXFlvGzkS/ivc3ockgFqWHefy02bsZNcPmRg5NjvwBG2qWS1x3E32kGzZGsP/fVE8+lJLthT7YRcZYBBYTRY/Futiscib6DqeVdrImAsDM0UNlyI2yxKio/MIiikwBiwaRbQs20109H0UGTrT2OxdUeZyCUB+AQEZN/ajLME1PWXRUVRKbWLw7eKlYfHUtY1pISthdJwpWcSMZxkoECZOZVFSsYxGEQOdKl4iqego+g2oio2MGTVAPA3iaRCkQSipqRBPhSgoFWjANmYOvj2RGSmkgCWhOEliJKGCBJBPNClzKgirFBczQklaKUtzCVSNSEEZEFkZzfHfzJINLVIpjOLTCiGTqzkI/LokV6AgkGeEmiGk49/F7+LLnGsCgpWSI0qRL4muylIqo0lJtUY8Yej2WJpkUpHDyf7Ty2eBN9pS1Kks4YhchMkl4evRleIGLqJRVFJFCzCgcElvIkELiI6iugNHIeC4AiU182gUKfiz4gpYdGRUBaNIp3MoaHR0EznpibRBxkW3/RX8Mgfy9evpSeBaGCK6HdXD/if+pxXKt2en8b9Baezph58DZaA6ADKaa+gPc4JzKbgAt+QoL/GUamDk7dkpWTiihGotU04NMHLFzZwsZaVsg5Tm+ZicZkRIAYRrUiq54AzYyLWhZZnz1Ar4E03OCy54URVt2t+fzo0p9dHeHpOpHlstG6ey2AtaFZd0qWSe2+97tOSx78nF7O+eYNz6+RnCqDSwcbSe3aMIRFWgVh5MDl7Ek5fx/gtURwYZrXITHbV/v7397vgI2vwi2RLJ9dcVBQyEwU+tOe/9oZHLN6s45PQPSA0KlEITYDho/OoFLnGt6tbWpNjlXBWSoN3YNCgAMDJdEiscYxQtQ68TVMgWSVEVU0vRszA6OphMJqOooNf+zzdv3gyNZ+i1VW6rRVdzns6JQU301sLOHrQddmlYUqsGA1alSCdxLYcWpWH/ZDyZDE532bZsgTipiXctTtfcONMRgPm/k7ZpeEBowaZ2rNw9wN22Vfa8FghrWOplvIu1d8/w++2tG0qXUmgnfAeTQ/ynO7FfJTn2sn07ig6HmxjyXlaCkd8FIWiYgXh1AUYUaFmpFAiToImQhsA112ZMPtBLFFjlOBEMhzN6XJMFzTkb/y7ssAcHq8N+FaWSKWhNpzmQd8Jws6wRcE0KuiRzWpbQeBcylWyJFtUaJ4/RLhHlQhNQSipNdJXOCdXkggsLIqHG8Q+SBc0ruBgRqSy5QCGjPNeEVeC9Y92zdu8XY/IZ3EzP37lhjqmBmVQc9JY20MKM07r7MzKrUKBQIQupUBsMAkLmbWGZ7ubuT+b2mdu35m3VdRNGr9K18f73xsZQpSiGcNxAoYd8xArV5BKwg0e5XDOGbTVoytoL/bmElGccNC6kV0bbncg0rZQeky/LkqOjXzpDfwlLwhkI43rZSDGs4V4dHxEFuQ0YjGxIWuNbo94CGlKwDk5mnhJBKxNIBevhpYzMlKxKLmaaUMFISgWZgo0JEM204jkjKcpB4dvPqWA5xotcOOltxfA2vKkH4ppcCGvYEreOFyMLzq0VueJ5HkSeUOJakgvflPhFWrooCpzJch8tawrUtxnczZmzMF8vjYROZWVaaxeTGQhQzap50oEZulIZTZtwXjDkj/IoDGXUDIYrXRjHQbkV5LCgwmAASZGmF5Cl12TvArggVqfriN9bpGkOY/JeKgLXtChzGHVIWHyWVRfuXxseXdi1Db9UFWcXjv3TxplgCCgFfMxssL55LkWVG17m4MZCPeopXvh5VdnCly1Uujs27lXCyNiNMsbxE83PWiO5SHNg7GU/XlwjNb/Sot6FeY6aOW2LTSqVCwmYJj52bDH47hG+Cv5nBY15cFFiM56l6Kw37kIbgucNRVHlefS9bleViZGbG3bs3FADbaiBTU0wRuYmx5l98NIff+NmHn8UEDvnF92ub/XBy45rikuDu7Sfa/6/v+ZIaa3D7vLhGxofm4awAS7hG93GmJwau2GWWnMMsYwkc7oAUtuhHBaQa1w770aCo6jNSpRylVY5VU8d3NgGP/FHK3DPovYMBxo4gb6Ovc11+08qLhOaprhHSBjkYCCpRFYJBiwp6bLA5FA7iDnvxBoRpg7agQluXXvBWtRyc9H7SjAuZh/AzCUjc6pJGI3Uo9k16ABbgOLZMuHCim6KSEup+YMi+w3DAByV+FHRc+LuZQrEjs+BjclZDlQDSeeQXrogBSNWDyck3Mbrp0BzBZQtk0DxUSeA7PUDkimAaOYxALDgNoOWKFkZVJv1wHyLpM4oDEDsBfkdoJ9cf+L6o04Et+txeUnAfWzGZ7qGVseaW3FttXcbzFtDcEkxnwikCWaLSpt2YDEMLMw2o9oEbUlyXnCzAeFA461Z+B4RexrE0iB6LqucIWbqOVtjTkpQXLIGLwiWMG8t16CsmwxiG+blO8GIy4XUmmN3UGZOBXmOSWUz1xgTZpWpFDh8IWnBBau0UctEQw4uuSEoT3WSSgZJE5itRdy03p6fv2Jfgn0HxPF+CP0wjw8wiCb8WdEcvchLwviM12ZnA1wdAOh7wNU8dW23R/uZpxarXgV76ME6rIYXkMgsS0qZ83SZYJ77fmtd7MTEYmh9+yAqYTUKWK0vNE1VRfNEbdaZTrMtLPdb149gv5pj0xxNOUZWNR5iAbpk6xDwEqxzTXwiZZN37HXdBu2xU24GNDV8gZAdDbfH9RgIDkBkloWszjrMIaep77PsdePt1z4cxmlCFdxfAqY0pyKFpCrvsJfrvfUmVMdU2AwpZX/YZXej6c3LPpc5Z2jV8X8HOIQVNhB9yKjo2Ge1QxhhQwriEaAH8ou/HpqQ5vFg1SlmG0kPARuR0odsClBWpYC1UGv3WIvZo4jiqWvTHGbgtku3chgWnxRTSRWG4fVJ4APyL+gwBvykHqp16IgQVibzgAi+2NwjHiMJvy3lopMFxuRyz6O5sCIBgfkjd8pBUyNVgpuwDdj6LbdX05qA2+818Y3DwqzCWilH2+fwNgob8D9mHNub44Cb04YqG7fTzICye/37RAGrvbbn31kdVz8ZoPekUeMmNWHzlMQrygKE8bMIqcX74u+0/yHkHUp3Yg6tmy0NHjkkMyW1xnRHGFyA3QxsinV8i+3DHbB7hDqiCPuCHiQbteCKzGWl7hMY7ubq/oXUW5ojYEYNX/QZ5HU8RT+YP6C9OXP0WwDcELV6ZEr+BSLxOB7U0mHWxw+/siX3h26YWzg12qXTG4wu7GB4QkZzA2oN2sRT2bxv/yHgXJMpoHGrAYejlh5Um2rk2gaAHmwlCsl4xq3ZDpBDNvMhwYYTo3JlsR0Ax8kOy52h1KAW3orrpTZQ1I2CDe/HBtYK6CSTqqCbdvvd9j9igLqUGq0WxKYnPU5fztHHqSuFJVL3iq53hfruOgXAKMJjwJXYn0wsV3MpL6tyEy8fEVgIuOqCPCw5eKqfjaPu2VdzrnPeS7rX24eolysP48f4Z7x/8Bxn2DFo01yml6Bq52+Tblxkcivh71EbDIatRPhAuJMH5IJIxUChf1KVCOrRn74bexXn5vnUi6PBVOXjTIqyJjTVu02nB3PznDJgeJSaYP3NI04L40IbgPvxbKmVHW+3Oa7CvocoupywKxJ58Gl2xDBYrJCF/gG57IAenqSuNOYitkyx32dSHItaPPG2E7xzCg0kB1lXUzsrKVaWps7ZbQrNV7rvkqqriZBAhNSDN3uIaB3gxiv/KNrOcVmPf2E0b41tCp2m88TMFei5zFkC3vlErfO7PgI7Laixbs+rwBcUAZu2WVCeU3+YhxF/vgBic/Nvj/9FvgRwJHjG1vmRlNomI9BJfuMKyKkYkQ9yAeSLxOI6RU6oPY5sO0xf8bpT2FRvXxZ14XDn7MjmxagxUJR2E2ukD+kIbeo5KltkTQXWNMYyc5WPnmDYZvKZoEYqTO1Rnt8vrUd5vktKj/K8vdHtAwj77pAdm1Od1F8fPpviTnPrAw9c3Ho0YsuDQtVnEAMFBa64PToPyYOmyxQyJIZ1ArbSXsAVEg2BHr8GljCup5XSYA+TmnPrNRNrt95C+1q5hXBuNRj9bNC9dSS6GKRJMqwr7XD3pAXaap1t4rjwyNNjE5bRg4ODmLLJ6/gQ6KuYTl7S+NX+q5evX6fPp/uv3myYdKBW2NPuXWJ/d8Dn+tf+01mNI3LC8SycnLjD5xE5xkPpcdTnSkCB9RHVTjsQh8L1D6bPRdQY2pddlE98tO2O+J+Mgw1rFndTssbm/u4jFWtqjq+o7stIlHHB9TzxWU70rlhI4EKvR8hJewa5Pb6RqNmGNIP3coK5dFFMYknfFYVpowBMsr/9Kn5A4eEizSuGFt0RQtuiQOsVmUldidKPjWGJ9Cm7Kp3tXS92Q9b6LPGVkmJG/O67P8ZfvNxBzJ1JBoF77ZDF+4uX7tD1KYxnY7J/8PzwxbMBFZtLATvXQ5xh71ANEZR8f9I5KMWKg5ynmzINg8rDKlcBDuuOHluqg8d3Zg66Vd7bJKvcEU5vA3+fRPYgrM11BF/a1wOamgy7+m5dsDbbRcpBx3N51SpvsLVcm4obmr39ztkEHDJU8/UFop0jeJgB6kl6T+ZiWH23z/cN7+8O7Sg+0A5WChVNb/B0+N322WkHYm8QMWI/kSe+z5PmJoGQpMRLa8aEVjp4lSnVPH3k3Tm1ZX7Bfodo0wYZ221hBQDTLT/kt4ED8Ufg25UvDl8zO/t5a4Z/w7LwYGdm9lhU+ZBVNYUak9pRraB7xBy9jSTWJ8l7OWeHAHP49s4STU24EEeYDY7yZf+E35ujMAd3Avrgeehe8UMLshuQ9U6zNpWLcaVNslvBy3vsS0Sv7GXFWjHrH7JkypW9w7rlKCf2XD0jtnu9NfYe1JZNuADQ2pz7HdPWtaC7BPE+eH91QOHw5f6rmFH6Jj4E9ip+/QIm8f5rYC/YBOD18xcbTJo9DdthU5rnlLzn5q8ZpuKYrfilaMxxu0ZQYa0Mz3unYRowRrRbxPqo2TNhYKPzwJw6YK+m2cuDNJ7SaRYf0v2D+PXBm4P4+eEEDtiblE4PXm/g1G5W6FRTTufkF1A5FzWbkC/50rLoyt9euR+HQkwNQrt4us57bK7bWV+rtbGE1UejbUlvF10OIqk3l2JjfWin2c67Nezd2zESPIIdkW8Al5hqEmZur97h0wEDqEPSpLa9D7xVCgNtsvay5VBvOwX8nduK8WCx+yhqF7r/EgIFx7L/5YjhdhR9avmNuyb0f+JAbkfRr7UHuWvOP13JT1fyA67E/Yd3ZXQJ9BKoXsb2imnrMLp+1KXbDHUllgtQijO7g7Lx9W+G+fZv3RWR90oWJ+GVk+P6URe4NiC03a8haxxT1j5FMwp6cMeTNLjmgVR/QjWN1YkNd+tOsOm+zUTxfQ2fFHVv4NiHVsw8Oor2Fvt79VHv3k3roZXbPXzjILyP4K/a2BtmSf1eTNK8j2NLOryIVSpHNfTXwmnJ3a3wmEFhr4avXO06gUL2FtbRi11eGD8je9YQHqR5pmwOeB3NEj8jYzSklbL5i/Ob4F/epujr3lbIovPv7Vaf8Tq/c3EDbesbbAgxPI+Cf0+BqoH3RTyJ2F5FI7Qyc8w/hHPWUfTZFsf8yAiOwpoBbkcRPlPwqXl65Z1z4atPpUzaj5xM7nx6JDzicedDIK6hzXG5Eo0QcdjHVfAhG5T5cA7XfjVmFOHLOvpj9hnUgqfQEozmDQJ7bXvPNtxjyAMMkGL7N56nad915aoh5Kks7DGjxfFEk3de40mobMM3dphMKzRjlp9/849BUJc29G8InYRRySe8sO9zQ+4IDiXbf/1HI8i4LKikBRUtOseunnq5y8NT/fndNI9W/HzJ6rFesvJ6auDa7JU55VahrQG78cb3PFrsW1loStuPui9dbWGBv2OJvTZI9eYGg+qvKr+9xZ//rABd+/l3dB7KVgVaW8e4jebXvFzVlpGnn3wk+oysfTZrzYTDjV4rhMF3Rf56ceddL3dLwD2rtR28//M3tgb56vg3/EBZzeYmovBPDMVfOnHM6oM1TQ90OqXZ2LYdVZx9/PwlGkVT/3xXIW00pugVvvJAr9yih9w4vu+Fv91EORWzykWVjib+91/75PC8 +sidebar_class_name: "post 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"; + + + + + + + + + + +Year-to-date benefit amounts from a different company represents the amount of money added to an employee's plan during a current year, made outside of the current contribution when they were employed at a different company. + +This endpoint only supports passing outside contributions for 401(k) benefits. + +scope: `employee_benefits:write` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/post-partner-managed-companies-company-uuid-accept-terms-of-service.ParamsDetails.json b/docs/api/post-partner-managed-companies-company-uuid-accept-terms-of-service.ParamsDetails.json new file mode 100644 index 000000000..9ff053362 --- /dev/null +++ b/docs/api/post-partner-managed-companies-company-uuid-accept-terms-of-service.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/post-partner-managed-companies-company-uuid-accept-terms-of-service.RequestSchema.json b/docs/api/post-partner-managed-companies-company-uuid-accept-terms-of-service.RequestSchema.json new file mode 100644 index 000000000..1073200f7 --- /dev/null +++ b/docs/api/post-partner-managed-companies-company-uuid-accept-terms-of-service.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"required":true,"content":{"application/json":{"schema":{"type":"object","description":"","properties":{"email":{"type":"string","description":"The user's email address on Gusto. You can retrieve the user's email via company's `/admins`, `/employees`, `/signatories`, and `/contractors` endpoints."},"ip_address":{"type":"string","description":"The IP address of the user who viewed and accepted the Terms of Service."},"external_user_id":{"type":"string","description":"The user ID on your platform."}},"required":["email","ip_address","external_user_id"]},"examples":{"Example":{"value":{"ip_address":"192.168.1.2","external_user_id":"2005648946132","email":"jsmith99@gmail.com"}}}}}}} \ No newline at end of file diff --git a/docs/api/post-partner-managed-companies-company-uuid-accept-terms-of-service.StatusCodes.json b/docs/api/post-partner-managed-companies-company-uuid-accept-terms-of-service.StatusCodes.json new file mode 100644 index 000000000..a5efab223 --- /dev/null +++ b/docs/api/post-partner-managed-companies-company-uuid-accept-terms-of-service.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Example response","content":{"application/json":{"schema":{"description":"","type":"object","properties":{"latest_terms_accepted":{"type":"boolean","description":"Whether the latest terms have been accepted by the user."}}}}}},"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/post-partner-managed-companies-company-uuid-accept-terms-of-service.api.mdx b/docs/api/post-partner-managed-companies-company-uuid-accept-terms-of-service.api.mdx new file mode 100644 index 000000000..75792de8d --- /dev/null +++ b/docs/api/post-partner-managed-companies-company-uuid-accept-terms-of-service.api.mdx @@ -0,0 +1,72 @@ +--- +id: post-partner-managed-companies-company-uuid-accept-terms-of-service +title: "Accept terms of service for a company user" +description: "Accept the Gusto Embedded Payroll's [Terms of Service](https://flows.gusto.com/terms)." +sidebar_label: "Accept terms of service for a company user" +hide_title: true +hide_table_of_contents: true +api: eJztXFtz27iS/itY7oMnVaJsK07i+Olkctnjh0xcuWx2yknRENGSMCEBDgDK1rj837e6AZAUdbHl2A9nalyVii0B6A+NvqHRwHVylU5r63QqlYOp4U5qlbpFBcnJeQLlGIQAkXwfJLoC/+2pSE6SSluXVtw4BSYtueJTEGmuy4orCTb8tsjqWoqU5zlULnNgSpvpSWbBzGUOySBxfGqRzuvYEQkJsLmRFZJKTpJX1Jm5GbD/QZzsbcDEzvjC6KLYs+z8Mw7N9IR98kN//2XmXGVP9vcnhb60Q5rhMNflPoF4MvymPs+A1RYMK2vr2IzPgXFmdAFMKqIWpoB/aiPAMKcZb8H0SQ6/qW/K5rqCE3bRn6o9uTTSwUUySCpueAkODE78OlG8hOQk6fIrGSQSZ15xN0sGiYE/a2lAJCfO1DBIbD6Dkicn14lfpcQ6I9U0uelzDmf45cvpGwTZmVByM2jI/l9KPE1fnZ2m/wvGYsdAfQZcgFmiP+GFhT6VNziXUiqwRERwB+mYWxDs1dkpm/tBGbdW55I7EOxSuhlb6NpQg5wXxZCdTpjSCpi0rDJ6LgWIgW/Dq6qQOckdLnQplSzrsjt2u9ZC592ljsKbVl5Q6Pt9Xsk09JRq+t9hwLTz8ROEUVsQw2QztwcJqLpE2R0djJ6lB8/Tw2deeCe8Llxy0v385ua75yNY96sWCxyuv6y5Vg6Uw686c97/wyKXr1dx6PEfkLukvxwoYQZV1aE2nVwnUHJZrMO/KiyoDnuWUQ/GhTBgLdPK692Q/a5rlnPFDDgjYQ603kt95pJHKduz7GKfi1IqezFgF/tQVoVeAPi/rJwq7rSR9DdXgl3sIwMMz5029oKBEpWWytkhyrWssgDnbhM5PWvhTxqY7HKm2VzCJQgi6ZUZxHp1Rrpw5cAoXmTYPZPi7mxkqHbKi3BVcDfRphwmNzdddToPa7M0vzVEvxMSXlaFX9G3/nf8dc6Lmn7pcig5fDkaHj4/Hh4OR+vGQ9E8ePb86Pjl0fPDp9TEy0jyhy2lm718+a8pfoBKlNzQD8K2lVbWIxgdHOB/y1MPsFhsmewg0ysy3BfyZZkuuAMbHUpcxs7ijLUugKuV1fk6AzdDSz4D5sdgNIY3/2MA1QrFeNEIzrDhwtHB0Src37Rj73StBPumGPOeJSg7CGSHrk0OTGiwTGnH4EpaN2Tv+Q9gtjZej6LZ8xZbWjbnhRTDbwrl8Gg0WiX7RVVG52AtHxfA3ion3aJBIC0r+YLNeFWBYpcz8D5trMUChZzkMmBkuEpcKsvAGG0ss3U+Y9yyC6kIRMadM3JcO8hI3i4GTHsexhEmXBaWiRrIR6q2ZxMzXAzZJ/AzPX/rybzmDqZkAna04AQzzZvuT9i0lgLYRBtWagNMgENAyLx7y+A67v7D3D5z+2q6ZNwICfrEnkPyn7fayo3hC7SCDkq7zsOtjJr9AOwQUC420KBWt1rsTxXkciLB4kIGZaTuTOd5beyQfV5UEsMUNAjSsh+wYFKAcr4Xtm/WcL+J7piBgsIdp9shyak0qHeAhiNgWxQvPxJDKxOHitYjSBmbGl1XUk0t+Tn02WOyZIRmXMtCsBzloAztZ1yJQqopxrokvZ29AAVnDSFp2YUiw5b5dbwYEDi/VuxSFkUUecaZb8kuQlMWFmnhY0DwJst/SawpUd+mcDtnzuJ8gzQyPta166xdyqagwLSrFoaOzLC1mfDcM4QrDDeipUcUjgvu7hBsvY7KbaCAOVcOw1+OYwYBWQRNDi5AKkY6jRExmY1gkcYFDNk7bVhw84OlIQgfserC/58hqgsfNoVPcN9w4dk/bp0JBrBawYcJbTW2z6WsCyfRf9OIqEc9xYsfrypb/GYHlV6mbaWaRsrYjQsh8StenHUo+Th5DW3PkNul5jdeQgwIA0fdjHfFJtfGhy/CMqd9DNgy+HYKX5T8s4bWPBiymy09GtFb74nRZTvgeTuiqouCYj7frq4yp7c3XLJz6xpYxx1sa3IzSJx0GFMm74P0p1+lm6UfFKTe+SU3m1u9D7Ljm+LS4B7znzX/z19z2ntscti94BqNj1bFwge4TG51G0N26mi7r62VGGI57aPwxg4VMIeCtmTBjURH0ZiVJJcmrwtufvFwUwp+0g8kcE+S7gzXNPACfZV2t1Zjrn7ghkLXymUCCnCQ1WpSKwEiq/iiBOWWgpjzpVgjwcRHNzA5SVaCtaTj5pJ3tRJSTd+Dm2nBZtyySI011GgNloDNwcjJIpOKRDdHpJW28kGR/Y5hAFJlgSp6Tty9jIERfQliyM4K4BZYPoP8hw9SMGINcBgvsSO69k1T4IUBLhZZHPFRJ4DsDQT9Xq+ZxxqApbRooTKja4dqsxlYaJGpuhxTwmwNxF6QvwT0o+/PfH/Uieh2A64gCVmu1URObQOtiTV34tpq7y6YV47hkjqG2bg2mKUcaSewWA8sznbCrYvakhWylG4LwjWNd2bhO0QcxmA0BrMzXRcCMfPA2QZzVoGRWrR4QYlMBGu5AWXTZC229bx8qwSlQzuaQzsoN+OKPWWlVm5mMSac1K424PHFRLBUorbOLDILBeQo3ZniMrdZrgVkbWC2EXHbend+/oZ9GfZdI453QxjIPD7AKJrwZ80L9CLPmZBT2ZidLXBtBGDvANfK3LfdHe0nmRNWuwr2KID1WJ0sIdOTSVbpQuaLDLP0d1vr8l5MLNetbx9ErUijQDT6wvPc1LzIzHadWWq2g+V+5fsx7NdwbFygKcfIqsHDCKAEuwF4BeRcs5BI2eYde113QfvaK7cAnjs5R8h+DL/HDRgYEmB6MolZnU2YmzT5XZa9abz72r+NXRk3cHcJGPOCqxyyurrFXm721ttQveaKMqRc/EHL7qnZ7cs+04UUaNXxnwccwwoKRB8yKnodzgRjGEEhBQsI0AOFxd8MTWn3eLCaFHM4zlwFNmBVCNkMoKxqBRuhNu6xEbNHEcVT34bFIRhuu2wnh0H4tBprbjAMj+0ekn9RhzHgZw2pBpKHsDKZB0TwmXKP0lKyh7al4RQ6ZoExudzzaD6syEBh/ihrj88y3IRtwdZvubuaNgP4/V4b33gsghSWpBxtX1MV0MP/mHFsb45r3Jx13FDczicODO317xIFrPbanX9nTVy9t2a8vVaN29QE5SlZUJQ5KBdmEVOLd8W/1P6nkC+NdCvm2Lrd0uCRQzY12lpMd0TiCmgzsC3WCS12D3eA9ghNRBH3BT1IFLXgisx0be4SGN7P1f0bR+9ojoIpd3LeZ1DQ8Rz9YPGA9ibUznQAeBKNekyM/gtUFnA8qKXDrE8gv7IlD4dumFs4ddan01uMPuwQeELGCwdmA9osjLJ93/5TwKVlY0Dj1gCORy09qJRqlJYCwAC2VqUWciLJbEfIMZv5kGDjiVG1stgegOfkEsu9ocSqpWDF7cI6KJtG0Yb3YwOyAjbDMge+bbe/3P5nDNDySK1WK0bpyYCz5FdY3tPHaWtTcZzzI0J9e5UDYBQRMOBKHB4cEFcLrX/U1TZePiKwGHDFPQCVHPxinwyT5bOv9lznvJd0b7YPSS9XHumnVPd3OHqKM1wyaONC5z/ANM6fkm5STfROwt8bbW0w3K3rW8oDdgv6TK2ievSn72mv4tw+n2ZxLLi6epxJcdGGpvZ+0+nB3D6nCQg8Ss0cv3rMaWFcSAF4oMccv2JE735zXIV9B1H0OWFfJPLg01wSw2ixYhb6J+RyCfT6SdraYi5ixxT7XSYlsaglDN51grdOoYXkIdt6TLPSamVpmpzdttB8pft9UnXNICwOwhri7R4i2QS49co/i3bpuKzHv0gtWGNKofN8lrmZATvThcggOJ+kc37XR0DTggbr7ryKfEERoLTNnMuCh8M8jPiLOTDKzb96/W/2OYJj0TN2zo+0tpSMQCf5VRpgp2rA3us5sM8ai+sMe8PpOLLrMEO97r3Cpmb7Mm/KnpfOjigvxp2DsqJNrNMhpMMq8VjPUaNwYsiha5fqSUrfhwHjNjNUumJqj8vibmk9XxW6c0oPS3DlipA2AOK+O2bHZtxmzbcPn03xp7nNgQcubkONUXlQANSIgYFSh7LiJnnQdhnDBAfDOgFkOlNwiYPGQE9egciEtOPaWKDDpPbcesPEuq130L5ObiGeW62Nfrbo3qYhljFol02wrnSJu286oEnrqInnwiNPTxyICR+NRikXB8fpEfAXKT94ztMXhy+eHx/nT8eHL15umXQcraTT7vvE/v6Az/dv/Ke3GifsjcSzcPbGHz4P2Gs8lB4mfa5EFFgfUd9rB+JR+P7R9PmIGkP7ahnlXoi2/RH/3jDasHZxtyVrKPd3F6nYUHN8yW1fRpKJVNLOspDlRO+KhQQ+9HqEnHRgkN/jO42a7VhLvJcTLLSPYjIa+rYozDoD4LLD3VfxPQqPVHlRC7TofqB4aWBFZnJfovRzNGiQ/si+Smd314vdkLUhS3xptJqysPvu0/hLVvcQc2+SQeFeO2bx/pKVP3T9BYbTITscPT169mSNis20gnvXQ5xh71gNEZX88GDpoBQrDgqZb8s0rFUeUfsKcNh09NhRHTy+czOwnfLeNlnlj3B6G/i7JLLXwtpeR/C5ez2grcmg1ffrgrXZPlKOOl7oy055A9VybStuaPf2984mIMlYzdcXiG6O4GEINJMMnszHsPZ2nx8a3t0dEpUQaEcrhYpmt3g6/J763GsHgjXBIBh9xfZCn732JoHSrMIrd87FVjZ6lTG3Mn/k3TmnMr9ov2O0SUHGbltYBSBsxw+FbeCa+CPy7TIUh2+YHX29M8O/Yll4tDNTOhY1IWQ1baHGQeOoVtA9Yo6eIonNSfJeztkjwBw+o8r03DFbV5U2jgkKjopF/4Q/mKM4B38C+uB56F7xQweyJyh6p1nbysWksS67X8HLO+zLVK/sZcVaCfIPk2wsDV3A3ZHKGzpXnzDq3myNgwelsgkfAJLNudsxbVMLep8gPgTvL0Ycjp4fvkgF5y/TIxAv0uNncJAeHoN4Jg4Ajp8+22LS6DTsHpvSouDsnXR/TTEVJ6jil6Mxx+0aQ4UlGZ71TsMsYIxIW8TmqDkwYc1G54E5NRIvxpPnozwd8/EkPeKHo/R49HKUPj06gJF4mfPx6HgLp+5nhU4tl3zGfgVTSNWwCflSLIhFl+H2yt04FGNqUNbH003eY3vdzuZara0lrCEa7Up6t+hyLZJmc6m21ocuNbv3bg1793aMDI9gB+wrwA9MNSk3o6t3vwNfhzomTRrb+8BbpUhom7XXHYd6s1TAv3RbMV1b7L58h/jXGCg0N4j/YyOGm0HyseM3bpvQ38SB3AyS3xoPctuc/3El/7iSn3Al8fb7VWor4D+A20WKSpDqORgjBfhiX6gcvaLwYfKpeeAFHx9QlnZcODk/rY0vzgyiJHdfnsEliv020W86rseBz2+ErKN/uYbeYXGz5CTZnx/uh2dssvCMTdYUrO1fd99ludnf/JANVUyEFawNvqUQb13zSvpL16mAkm5er9ycegOlTpbZ68dLfdoVv0YubBh47ZhnhlKsm8as8Gtki4W8NpQeOL+O5huf3LH2VY0MOv/ebfUJb8t7D7KmbXNBDCHGt1PoPQbghjxF//osDZHSTS/GazfD7X08xhwkn6j25Gco+BE2ELgZJPgKwMf2XZbOyxrxSYzm1tzSCxvtIzCrj2u0z/HEsobopf37Ra/OTlFe49lV952YQeKWBbdd7fbePl119u8Y7QucGAYVKf2NZ1CtTPau50GR65KO5gjHnl15SYle1RE6r1H1iUn/FR5Q4D7VFl4NehOpso94yT3kUyLHGkz/aqUTeY16V3LVGSc+7RSfXgnQKY3enA7Rvez+bK7bZx3+dg9EBQl3cOX2q4JLUgVS/etgtM6T+aF/SWq92UoGyUnvQalNlus7Vn5bh2NeX2Os98UUNzf48Z81oMc5/4621VCxGtkIISnI3PAcVHdhfvkYAqQnbNNTVBtmG++ZUoto2ZNw6XX5rSxfvO7fqtoN3t/84aq1jPUMXP/qV8Pn1uG+9sxKPy8559V3VNoeXhm3tu364rMPnz4ng2Qc3sQqNcUShl/i4wP80q96TNnio1n4Gb7/o6a1D3b8mPjz/+X9awQ= +sidebar_class_name: "post 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"; + + + + + + + + + + +Accept the Gusto Embedded Payroll's [Terms of Service](https://flows.gusto.com/terms). +The user must have a role in the company in order to accept the Terms of Service. + +scope: `terms_of_services:write` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/post-partner-managed-companies-company-uuid-retrieve-terms-of-service.ParamsDetails.json b/docs/api/post-partner-managed-companies-company-uuid-retrieve-terms-of-service.ParamsDetails.json new file mode 100644 index 000000000..9ff053362 --- /dev/null +++ b/docs/api/post-partner-managed-companies-company-uuid-retrieve-terms-of-service.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/post-partner-managed-companies-company-uuid-retrieve-terms-of-service.RequestSchema.json b/docs/api/post-partner-managed-companies-company-uuid-retrieve-terms-of-service.RequestSchema.json new file mode 100644 index 000000000..cb6e41a24 --- /dev/null +++ b/docs/api/post-partner-managed-companies-company-uuid-retrieve-terms-of-service.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string","description":"The user's email address on Gusto. You can retrieve the user's email via company's `/admins`, `/employees`, `/signatories`, and `/contractors` endpoints."}},"required":["email"]},"examples":{"Example":{"value":{"email":"jsmith99@gmail.com"}}}}}}} \ No newline at end of file diff --git a/docs/api/post-partner-managed-companies-company-uuid-retrieve-terms-of-service.StatusCodes.json b/docs/api/post-partner-managed-companies-company-uuid-retrieve-terms-of-service.StatusCodes.json new file mode 100644 index 000000000..8e1ae9a7a --- /dev/null +++ b/docs/api/post-partner-managed-companies-company-uuid-retrieve-terms-of-service.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Example response","content":{"application/json":{"schema":{"description":"","type":"object","properties":{"latest_terms_accepted":{"type":"boolean","description":"Whether the latest terms have been accepted by the user."}},"required":["email","ip_address","external_user_id"]}}}},"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/post-partner-managed-companies-company-uuid-retrieve-terms-of-service.api.mdx b/docs/api/post-partner-managed-companies-company-uuid-retrieve-terms-of-service.api.mdx new file mode 100644 index 000000000..7444e4af6 --- /dev/null +++ b/docs/api/post-partner-managed-companies-company-uuid-retrieve-terms-of-service.api.mdx @@ -0,0 +1,71 @@ +--- +id: post-partner-managed-companies-company-uuid-retrieve-terms-of-service +title: "Retrieve terms of service status for a company user" +description: "Retrieve the user acceptance status of the Gusto Embedded Payroll's [Terms of Service](https://flows.gusto.com/terms)." +sidebar_label: "Retrieve terms of service status for a company user" +hide_title: true +hide_table_of_contents: true +api: eJztXFlvHDmS/iuxuQ9uA5Wlw/Klp3H72NGD24KP9TZkI8VKRlWxnUlmk8ySqgX990HwyKsOqWQJ2Bm0gUbblWTwYzAuBoO8Si7TWW2sSoW0ONPMCiVTu6wwOT5LsJwg58iT76NEVei/nvDkOKmUsWnFtJWo05JJNkOe5qqsmBRowt+WWV0Lnmq0WuACM4u6NJmaZgb1QuSYjBLLZoZGeh270lAcTa5FRYMlx8nH0B3sHKE2qIHlOVaWyRzBWGZrA2rqvv4PzQTeBtRwypZaFcUjA2efaWhq9skP/f2XubWVOd7bmxbqwowdD8a5KvccyMfjb/KbNLmq8BjOh7jNsUbGz5NRUjHNSrSoaRJXiWQlJsdJd/bJKBE0i4rZeTJKNP5ZC408Oba6xlFi8jmWLDm+SjzPE2O1kLPkesiFz3OEL19O3sSphjGS61Ez7P+lbv7pq9OT9H9RG+oYRp8j46h7409ZYXA4yhuaSykkGjcIZxbTCTPI4dXpCSw8UWDGqFwwixwuhJ3DUtXaNchZUYzhZApSSQRhoNJqITjykW/DqqoQuZMiWpRSSFHWZZd2uy5c5d1liaKYVn5R3fc9Vok09BRy9t+BYNr5+THBqA3ycbKZ26MEZV2SHB7uHz5N95+lB0+9IE5ZXdjkuPv79fV3z0c09lfFl0RuuKy5khalpU+dOe/9YYjLV6s41OQPzC0JlCY9s6QIx1cJlkwU6+CuygYpxiMDrgcwzjUaA0p6lRjD76qGnEnQQ2Vq+iwEi0L1yMD5HuOlkOZ8BOd7WFaFWiL6fxkxk8wqLdy/meRwvkfz1Sy3SptzQMkrJaQ14+T6uityZ2FC369HCV6ysir8NN/6v9NfF6yosTP15A9TCjt/+fIfM/qBRCG5dn+IsKmUNJ7G4f4+/a/PmEAYYstkh5XpUyJTtXWpCmbR2GDivIGiKTdLN1GqQCZX1u7rHO0ctVsPTwMcDZizBcIEUUKkBpNls2ybWDtKRJWF5SexvrSoJSsy6pMJnnz3rDvaP1qd42/KwjtVSw7fJMA3SWIV5Bw58VDVOkfgCg1IZQEvhbFjeM9+IJhae5mKGu+NlTCwYIXg42+STNrR4eHqsF9kpVWOxrBJgfBWWmGXDQJhoGRLmLOqQgkXc5RulIniS7KEzqoEjEBLy4Q0gForbcDU+RyYgXMhHYiMWavFpLaYOTE7H4HyjI8UpkwUBniNYBUw2fZsnN/5GD6hn+nZWz/Ma2Zx5tRhR+PlYKZ50/0xzGrBEaZKQ6k0AkdLgIh5dxbcddz9m7lD5g51u6dYDgm5g4Fx9r+3Ks60ZkvSQIulWWfcV6hmP5A6BJTLDWO4Vjc6gU8V5mIq0NBCBmV03UHlea3NGD4vK0EemqyIMPADlyA4Sut7UftmDfeawAY0Fs7TW9WSHJMyN6h3gEYUqC2Jl6cEZGUiqWg9gpTBTKu6EnJmnJsh/zVx5s+hmdSi4JCTHJSh/ZxJXgg5AyG99HaCWheXNAMJA+fSGbbMr+P5yIHzawUXoiiiyAMD3xLOQ1MIi7T04Q96k+U/OtaUpG8zvJkzp3G+QRqBTVRtO2uXwgwl6nbVAunIDFPrKcs9Q5gk1xvdA6GwjDO7Ns7ow3gdlVtjgQsmLUV+jGgGAVkGTQ4uQEhwOk3BoDMbwSJNChzDO6UhePdRj4TD51h17v+fEapzH0KEXyhkPvfsn7TOhGI3JfHD1EXZ2+dS1oUV5PQdRdKjgeLFn1eVLX7ZQaX7YxshZ3Fk6sY4F/SJFaedkXyIuGZsz5CbpeY3VmLcBwSO2jnrik2utI95uAGrnDR0GHzzCF+k+LPG1jxoZzfb8RxFb72nWpUtwbOWoqwLH+r5dnWVWbW9Yc/OrWtAuz3c1uR6lFhhKZRM3gfpT78KO08/SEy980uuN7d6H2THN6Wloe3V32v+77/mbsuxyWEPInIyPkoWSx/ggtjqNsZwYt1OVxkjKMSyyofujR0qcIGFyz0ENxIdRWNWklzovC6Y/sXDTV3wk35wAvc46c5wTQMv0Jdpd0c1YfIH7UJULW3GsUCLWS2nteTIs4otS5S2F8Sc9WKNhPb83cDkOFkJ1pKOm0ve1ZILOXuPdq44zJmBOBo0o7k16AFboBbTZSakE92ckFbKiHtF9juFATQqhFHJc9LuZYLgxhfIx3BaIDMI+RzzHz5IoYg1wAFWUkdy7ZumwArKCC2zSPFBJ0DsDQP6DWIzjzUAS2HIQmVa1ZbUZjOw0CKTdTlxuaI1EAdBfg/oR98ffH/Sieh2A64gCVmu5FTMTAOtiTV34tpq7y6YVxZoSS1QIqoNZsva2G5gsR5YnO2UGRu1JStEKewWhGsa78zCd4Q40ABHA8xc1QUnzCxwtsGcVaiF4i1elDzjwVpuQNk0WYttPS/fSu4ygR3NcTsoO2cSnkCppJ0bigmnta01enwxByokr43Vy8xggTlJdyaZyE2WK45ZG5htRNy23p2fv1FfoL5rxPF2CMMwDw8wiib+WbOCvMgz4GImGrOzBa6JAMwt4BqR+7a7o/0kcofVrII9CmA9VitKzNR0mlWqEPkyowT17da6vBMTy3XrOwRRS6dRyBt9YXmua1ZkervO9JrtYLlf+X5A/RqOTQoy5RRZNXjAARRoNgCv0DnXLCRStnnHQddd0L72ys2R5VYsCLKn4fe4AQPQAKCm05jV2YS5SRnfZtmbxruv/dvYFZjG20vAhBV0fJTV1Q32crO33obqNZMuQ8r4H27Z/Whm+7LPVSE4WXX6zwOOYYULRO8zKvLHbcsmjHAhBQQE5IHC4m+GJpV9OFhNitlF0uuAjaAKIZtGklUlcSPUxj02YvYgonji20AkAbTtMp0chsOn5EQxTWF4bHef/Is6TAE/NEM1kDyElcncI4LPLvcojEv2uG2pkL0sMCWXBx7NhxUZSsofZe1RUkabsC3Yhi13V9OGgN/vtfGNx8KdwjopJ9vXHG8P8D9kHDuY4xo3ZyzTLm5nU4va7fVvEwWs9tqdf6dNXP1oDb1HrRq3qQmXp4SgKAuUNswiphZvi7/X/qeQ9yjdiDm2brc0dOSQzbQyhtIdcXCJbjOwLdYJLXYPd9DtEZqIIu4LBpBc1EIrMle1vk1geDdX90+i3tEciTNmxWLIoKDjOfnB4h7tTSjx6ADwQzTqMdXqL5RZwHGvlo6yPmH4lS15OHSj3MKJNT6d3mL0YQenEzJWWNQb0GaByvZ9+08BFwYmSMatARyPWgZQXapRGBcABrC1LBUXU+HMdoQcs5n3CTaeGFUri+0BeE72WO4NJdXrBCtulsZi2TSKNnwYGzgrYLKp0iXbttvvt/8ZA9Sn1Gq1BJeeDDhLdkmVLUOcptYVozk/INS3lzkiRREBA63Ewf6+42qh1I+62sbLBwQWA664B3AlB7+Yx+Okf/bVnuucDZLuzfYhGeTK4/ipK2A7OHxCM+wZtEmh8h+oG+fvkm5CTtVOwj+gtjYYdhIRAuFeHlBIUJpT7YgCXcuoHsPp+7FXcW6fT7M4Bm1dPcykGG9DU3O36Qxgbp/TFDkdpWaWXT7ktCgudAF4GA8suwQ33t3muAr7FqLoc8K+SOTep9kTw2ixYhb6J+SyB3r9JE1tKBexY4r9NpMSVNQSiHed4I1TaCF5yKaeuFkpubI0Tc5uW2i+0v0uqbqGCEQi0Aze7iGSTYBbr/yzaHvHZQP+xdGCNXYpdJbPMzvXaOaq4BkG55N0zu+GCNy0sMG6O68iX0gEXNpmwUTBwmEeRfzFAsHl5l+9/id8juAgesbO+ZFSxiUjyEl+FRrhRI7gvVogfFZUXKfhDXPHkV2HGUpV7xQ2NduXRVPx2zs7cnkxZi2WldvEWhVCOmBtPUdNwkkhh6ptqqap+x4Ixm1mqPqk1B4Txe3Ser4iceeUHpWjihUhbQDEfXfMjs2ZyZqv959N8ae5zYEHLW4zGrjyoACoEQONpQoltk3yoO0ywSkRozoBYjpIvCCiMdATl8gzLsyk1gbdYVJ7br1hYt3WO2hfJ7cQz63WRj9bdG8TiT4GZbMp1ZX2uPumA9ppnWviufDA0+P7fMoODw9TxvdfpEfInqds/xlLnx88f/biRf5kcvD85ZZJR2qlO+2+S+zvD/h8/8Z/eqtxDG8EnYXDG3/4PILXdCg9ToZciSj8DYi7owg3KILp8xE1hfZVH+WjEG37I/5H42jD2sXdlqxxub/bSMWGmuMLZoYykkyFFGaehSwneVcqJPCh1wPkpAOD/B7fKtJsC+3gg5xgoXwUkznSN0VhxmpEmx3svorvSXiEzIuak0X3hGL9/4rM5L5E6efGcESGlH2Vzu6ul7oRa0OW+EIrOYOw+x6O8Zeo7iDm3iSjpL12zOL9JSp/6PoLjmdjODh8cvT08RoVmyuJd66HOKXesRoiKvnBfu+glCoOCpFvyzSsVR5e+wpw3HT02FEdOr6zczSd8t42WeWPcAYb+NskstfC2l5H8Ll7PaCtyXCr79eFarN9pBx1vFAXnfIGV8u1rbih3dvfOZtAQ8ZqvqFAdHME9zNAM8ngyXwMa272+aHh7d2hGyUE2tFKkaKZLZ6Ovrs+d9qBUE0wcnCf4FHo86i9SSAVVHTbzNrYykSvMmFG5A+8O2euzC/a7xhtuiBjty2sROSm44fCNnBN/BH5dhGKwzfMzn3emeFfqSw82pmZOxbVIWTVbaHGfuOoVtA9YI7eRRKbk+SDnLNHQDl8cJXpuQVTV5XSFrgLjorl8IQ/mKM4B38Ceu956EHxQweyH5APTrO2lYsJbWx2t4KXd9QX5KDsZcVacecfptlEaHf3dMdR3rhz9Sm47s3WOHhQVzbhA0Bnc253TNvUgt4liA/B+/NDhkfPDp6nnLGX6RHy5+mLp7ifHrxA/pTvI7548nSLSXOnYXfYlBYFg3fC/jWjVBx3Fb+MjDlt14AU1snwfHAaZpBiRLdFbI6aAxPWbHTumVOH/Plk+uwwTydsMk2P2MFh+uLw5WH65GgfD/nLnE0OX2zh1N2s0Ilhgs3hV9SFkA2biC/F0rHoItxeuR2HYkyN0vh4usl7bK/b2VyrtbWENUSjXUnvFl2uRdJsLuXW+tBeszvv1qj3YMcIdAQ7gq+IPyjVJO3cXb37Hdk61DFp0tjee94qxYG2WXvVcajXvQL+3m3FdG2xe//q8K8xUGgvDv+7RgzXo+Rjx2/cNKH/EAdyPUp+azzITXP+25X87Up+wpXEhwMuU1Mh+4HMLFNSglQtUGvB0e1r/QMJ7sGQD9NPzUsldJVeGrfnoun5iW18PGUUZbn7iAotUuy3CUHTcRMSen0iZB79MyzuGRI7T46TvcXBXniTJQtvsmRN0dreVfdZkuu9ba+yuLqJsI61pmcY4t1rVgl/9TrlWLr71yv3p95gqZI+kz291Cdf6TNxYgPhtTRPtUu0bqJZ0WdijMG81i5JcHYVjfirnBzKq5pYdPa92+oT3Zn3fmRN2+aaGEGMj4e4pxyQaecvhpdoHYnU3fcCVts5bfLjYeYo+eQqUH5mBE9hwwDXo4TeAvjYPkzSeVYjvqbRvi4TSxWi5/VP57w6PSEJjOdR3WdPRontC2K7du1dfHd92T+hs8cJJgUKqfs3nSu1Eja4codFrkp33OZwPDIrj/i4R2K4ymtSZzfl/wqPIjCfPguP4LyJo8JHurgeciRx/g2mf7SyRpwjPSqZ7NBpXx2KLwcF8DFhTjny5ujHXboeTuuqfbPh//UjRkEILV7avapgwkmr086rYFnOksWBf+1ovW1JRsnx4NGjzeblOxVpG0tUr64oLPuii+tr+vnPGsk5nH0nI6hdXZlTZC5cPLjh0aIum3/5GGKZx7DpwaQN841XQl2LaIKTcD+1/6KTrzP3LyrtBu8//HmltYz1DFz/NlXD59YzvvbMSj/3vOjqkydtj1dOkba27brM0w+fPiejZBJebiqVd/vsgoSWXfhVj9lVetqJfqP3feSs9nGJp0l//gXyrOZc +sidebar_class_name: "post 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 user acceptance status of the Gusto Embedded Payroll's [Terms of Service](https://flows.gusto.com/terms). + +scope: `terms_of_services:read` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/post-payrolls-gross-up-payroll-uuid.ParamsDetails.json b/docs/api/post-payrolls-gross-up-payroll-uuid.ParamsDetails.json new file mode 100644 index 000000000..495c36e59 --- /dev/null +++ b/docs/api/post-payrolls-gross-up-payroll-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":"payroll_uuid","in":"path","description":"The UUID of the payroll","required":true,"schema":{"type":"string"}}]} \ No newline at end of file diff --git a/docs/api/post-payrolls-gross-up-payroll-uuid.RequestSchema.json b/docs/api/post-payrolls-gross-up-payroll-uuid.RequestSchema.json new file mode 100644 index 000000000..f7d344a23 --- /dev/null +++ b/docs/api/post-payrolls-gross-up-payroll-uuid.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"required":true,"content":{"application/json":{"schema":{"type":"object","description":"Request body for calculating gross up amount","properties":{"employee_uuid":{"type":"string","description":"The UUID of the employee"},"net_pay":{"type":"string","format":"float","description":"Employee net earnings"}},"required":["employee_uuid","net_pay"],"title":"Payroll-Gross-Up-Request"}}}}} \ No newline at end of file diff --git a/docs/api/post-payrolls-gross-up-payroll-uuid.StatusCodes.json b/docs/api/post-payrolls-gross-up-payroll-uuid.StatusCodes.json new file mode 100644 index 000000000..ae9d0928b --- /dev/null +++ b/docs/api/post-payrolls-gross-up-payroll-uuid.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"type":"object","description":"Response containing the calculated gross up amount","x-examples":{"success_status":{"gross_up":"1234.56"}},"properties":{"gross_up":{"type":"string","format":"float","description":"Gross up earnings."}},"title":"Payroll-Gross-Up-Response"}}}},"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/post-payrolls-gross-up-payroll-uuid.api.mdx b/docs/api/post-payrolls-gross-up-payroll-uuid.api.mdx new file mode 100644 index 000000000..9000f6306 --- /dev/null +++ b/docs/api/post-payrolls-gross-up-payroll-uuid.api.mdx @@ -0,0 +1,73 @@ +--- +id: post-payrolls-gross-up-payroll-uuid +title: "Calculate gross up for a payroll" +description: "Calculates gross up earnings for an employee's payroll, given net earnings. This endpoint is only applicable to off-cycle unprocessed payrolls." +sidebar_label: "Calculate gross up for a payroll" +hide_title: true +hide_table_of_contents: true +api: eJztXFtz3LaS/itY7oPjquHo4mv0tI5l5+jBscqW13tKcVEYojmDmAQYABxpotJ/3+oGQHI4F2lkqXbPqTykHA2BxodG39Bo4DqxkDdGukVydH6dvNVVzdXiTZ6DtW8aN0uOzr/dfBslV+m0sU6nUjmYGu6kVqlb1JAcnSdQTUAIEMm3UeL41OJvp3xhdFla/E3X4HuciOQoqbV1aR0+p1OjrU2bOv6SNY0UySgRYHMja+yVHCVveZk3JXdgGXVgTc2AGyXV1LJCG8YVg6ou9QLgiWWB1ohN5RwUU+Da1mN2NpOWgRK1lsoxaZlW5YLxui5lziclMKeZLoo0X+QlsEbVRiMzQESydvy7+l2dzaDDwivdKMeqxjrmZqDYBFjF6xoEUnMzYLk2BmytlZBqygp5BYLluqpBWWJNBMiQqdhpCq7rmLs4eBhqzN5rw+CKV3UJI2LBRKvGdsjtiLoPIdqZbkqB+Cw4dindjJr9Qp2XMEhFX+K4F4Q562O2F6yQUArih811DUfsIjLpyDTqIhklNTe8AgfGkoApXkFylPxP+iuJ05vTk/S/wVhc5lEica1nwAWYZJTYfAYVT46uEy9oiXVGqmkySkA1FQrZ4f7hi3T/ZXrwAsVMQMGb0iVH/d9vhqJ0jFgqqcDS9AR3kE44Lu+b0xM291gYt1bnkjsQnkcL3RhqkPOyHLOTgimtAKWnNnouBYiRbxPkCAd7Ytl5JZWsmqpP+9tPM+dqe7S3J3Rux6RW41xXe1GNoirQ9z1eyzT0lGr6n4Fg2vv5KcJoLIhxcjNqOTzQJ2Jtzd1sRbdQkL98OTlmuugveDJKDPzZSAMiOXKmgc0LctM3EMZe8mnsgRTAul+0WGC3IcFcKwfK4ace3/b+sAjsenU8PfkDcrcyg09+FDbRYkGqkAdzgbI8UACUSIMGyUmwSDqaDc+oNcK2nVuxOwqaApfVfLGOSKFNxVE0i1Lz1Rm8C1SWTFVyc9Nfg/MB1G48NLvSlThgMLvpr2RWv9Rp4E1yc+OpoQmyfuaH+/v4zzKSzw2Z/qJBAXiw9fGjMqTHpTcxaNqiVRdrVukqDdaNsFoPK7OOu4Z+oR5ZUydHycHhs+fjFy+JX8uL2zXaeUl+HfqZMdHfwmg/ycDp5/vPV5n7m3bsvW6U2IW3G0iw3xVj3g0FLQPBDFjdmByY0GCZ0o7BlbRuzD7w78BsY8CreLBZ7OR4j4RZWjbnpRTjZLSylksSaIw25NMHSuR/77jMjeELNDsOKrtOQlaoZt8BO+TcwVSbxYYxqNWtSvq5hlwWEiy7nEGYM3VnOs8bg0HAopZoyhfMYTjwHRZMClDO98L23DkjJ42DvdaDMQNeWoNPJ5JodDvUO0BDCuRodREosTNSCk8qLpINyKdGNzXFO1wJlnOKMdDqI5pJI0vBcjTAVWg/40qUqGlSec/Ui9wIcwXW8incDvk0AhHguCwt4xPduB5TUzYFBaZjZyAdUdrGFDz3SDFQUwKBI+e8riyrutIuK0hJeoJ1vrT+0a/05eWo17E3uWSDglxyrx/UYZzcfOsr92/apaRk6TscNP3opTZo9uHhqlp+iWEiRZDvlJNu4aNEZAdfsBlGgwrl0YdV5Kt04Zcm4Iv2MSy5ZbbJZ4xbdiEVqWfWCmU252UDFyOmDZGLFApaINFA4HXbs43BL8bsM3iVOH/nh3nreSjB7hibEMw0b7s/ZdNGCiAfXGkDUWLGv6v7W7z1rPW272/mRub+bbX//a02bjvagaRlF4qMWubX8cJv+PxasUtZllHkGWe+JbsITVlYpIXf3QApVVCM/zfOAVE4Lri7Q4j5Niq3gRLmXDnc2HGkGQRkETQ5mH+pGOk07vXIbHT7/8HWuk+C8BGrLvy/GaK6oLWNv2BsfuHZP+kiLQystIKPBbmy7XOpmtLJugQ/FurRQPHiz6vKFr/soNLLY1uppnFk7MaFkPiJl6e9kfzubc3YniG3S81vvIJ2B+U56ma8LzZdvsQyp0kaegy+fYQvSv7ZQGceDNnNbjyi6K13YXTVETzvKKqmLJNvbbumzpze3nDJzq1rgPsX2NakF4V8CNKffpVuln5UkHrnl9xsbvUhyI5vikuDKYG/1/xff82R0kaHvcyHr2h8KKtJuz8mt7qNMTuhNGitrZUh/znjc2CtHSphDiWmFqMbiY6iNStJLg1u5c1PHu5S3Px0aeO8pkGyZhcw4ep7xvMcswGZgBIcZI0qGiVAYNKjAuXslh0CpvSWtwcrwdrSNuF9Q5nZD+BmWrAZtyyOxtrRaA2WgM3ByGKRSRWytJmAWlv5oMj+iWEAjsrCqOg5cesyAUbjSxBjdloCxwzLDPLvPkjBiDXACVkVO948BV4a4GKRRYqPOgFkbxiQTQBUN481ACtp0UJlRjeY0Nu2K/QtMtVUE8ogr4E4CPKXgH7y/ZnvjzoR3W7AFSQhy7Uq5NS20NpYcyeurfbug3njGC6pY5hn7oJZOmLoBRbrgcXZFty6qC1ZKSvptiBc03hnFr5HxIEGIxq9EwceONtizmowUosOLyiRiWAtN6Bsm6zFtp6X75SgRH9Pc2gH5WZcsWes0srNLMaEReMaAx5f7o/CMqlEY51ZZBZKyFG6M8VlbrNcC8i6wGwj4q717vz8Dfsy7LtGHO+GMAzz+ACjaMKfDS/Ri7xkQk5la3a2wLURgL0DXCtz33Z3tJ9lTljtKtjnAazH6mQFmS6KrNalzBcZHqrcba2rezGxWre+QxCNIo0C0eoLz3PT8DIz23VmqdkOlvuN78ewX8uxSYmmHCOrFg8jgBLsBuA1kHPNQiJlm3ccdN0F7Vuv3AJ47uQcIXsafo8bMDAcAE9JY1ZnE+Z42GLvsuxt493XPh79WMYN3F0CJrzkKoesqW+xl5u99TZUb7mi9CgXf9Cy+9Hs9mWf6VIKtOr4nwccwwoKRB8yKgqFCm0YQSEFCwjQA4XF3wwN08WPBqs9f6FIeh2wEatDyGYAZVUr2Ai1dY+tmD2KKJ74Nu2ZJsNtl+3lMAifVhPNDYbh7dnnA/Iv6jAG/KwdqnfMihBWJvOACM4o9ygtJXtoWxoKIUzvlHng0XxYkYHC/BEGYc7w3GmT4SZsC7Zhy93VtCXg93tdfOOxCFJYknK0fR5vp7AR/2PGsYM5rnFz1nFDcTsvHBja698lCljttTv/Ttu4+skaek86Ne5SE5SnZEFR5qBcmEVMLd4V/1L7H0K+ROlWzLF1t6WhMpF4Ut7aml4xw6ZYJ7TYPdwB2iO0EUXcFwwgUdSCKzLTjblLYHg/V/cPpN7THAVT7uR8yKCg4zn6wfIB7U0oJOgB8EO06lEY/ReoLJblPKSlk22p3OqWvC17w/yQ9en0DqMPOwSekPHSgdmANgtUtu/bfwi4tGwCaNy6Or1w1DKASqlGaSkADGAbVWkhC0lmO0KO2cyHBBtPjOqVxfYAPCeXWO4NpQUzD1bcLqyDqm0UbfgwNiArYLNY3XJrnODb/4gBWqbUabVilJ4MOCt+hYVrQ5y2MTXHOT8i1HdXOQBGEQEDrsTB/j5xtdT6e1Nv4+UjAosBV1v+hcU4P9mn42T57Ks71zkfJN3b7UMyyJXH8VP8Mz04fEYlDn2DNil1/h1M6/wp6SZVoXcS/gG1tcEwSUQIhJfygFIxbQQY9E+mUVE9htP3Y6/i3D6fdnEsOF8B9vCT4qILTe39pjOAuX1OBQg8Ss0cv3rMaWFcSAF4GI85fsVovPvNcRX2HUTR54R9kciDT3NJDKPFilnoH5DLJdDrJ2kbi7mIHVPsd5mUxKKWQLzvBG+dQgfJQ7bNhGal1crStDm7baH5Svf7pOpaIiwSYe3g3R4i2QS488o/inbpuGzAvzhasMaUQuf5LHMzA3amS5FBcD5J7/xuiICmBS3W3XkV+YIiQGmbOZdlvMyAEX85B0a5+Tdv/8HOIjgWPWPv/EhrS8kIdJJfpQF2okbsg54DO9NYeWrYMafjyL7DDJXo9wqb2u3LvL0HsHR2RHkx7hxUNW1inQ4hHeNdPUeDwokhh25cqouUvgeCcZspp4o7bTC1x2V5t7Qel+V9Unpclv2N7hBA3HfH7NiM26z9+vDZFH+a2x544OK2ozEqDwqAWjEwUOGK09F5TB50XSZQIDGsE0CmMwWXSDQGenRPREg7aYwFOkzqzq03TKzfegft6+UW4rnV2uhni+5tInGHytLjHuhBLenokacn9kXBDw8PUy72X6fPgb9K+f5Lnr46ePXy9ev82eTg1c9bJh2pVXTafZ/Y3x/w+f6t//RW44gdS7qxdOwPn0fsLR5K+8sp61CEmv57o/D9o+nzETWG9vUyyich2vZH/E/G0Yb9X9Ubj5JCKmlnWchyonfFQgIfej1CTjowyO/xnUbNdqwbfJATLLWPYjIifVsUZp0BcNnB7qv4AYVHqrxsBFp0TwhtiwFrV2Qm9yVKPzYGERlS9lU6u7te7IasDVniS6Pxfp/ffQ/H+EvW9xBzb5JB4V47ZvH+krU/dP0JxtMxwxswL56uUbGZVnDveohT7B2rIaKSH+wvHZRixUEp822ZhrXKIxpfAQ6bjh57qhMuKdpeeW+XrPJHOIMN/F0S2Wthba8jOOvfnelqMmj1/bpgbbaPlKOOl/qyV95AtVzbihu6vf29swk4ZKzmGwpEP0fwMAO0kwyezMew9nafHxre3R3SKCHQjlYKFc1u8XT4nfrcaweCNcEgGH1iT0KfJ91NAqVZjZdJnYutbPQqE25l/si7c05lftF+x2iTgozdtrAKQNieHwrbwDXxR+TbZSgO3zA7+rwzw79iWXi0M1M6FjUhZDVdocZ+66hW0D1ijp4iic1J8kHO2SPAHD6jyvTcMdvUtTaOCQqOysXwhD+YozgHfwL64HnoQfFDD7IfUAxOs7aVi0ljXXa/gpf32JepQdnLirUS5B+KbCINXVzecZRjOlcvGHVvt8bBg1LZhA8Ayebc7Zi2rQW9TxAfgvdXhxyevzx4lQrOf06fg3iVvn4B++nBaxAvxD7A62cvtpg0Og27x6a0LDl7L91fU0zFCar45WjM6SkCVFiS4dngNAxfCdB+i9geNQcmrNnoPDCnDsWrSfHyME8nfFKkz/nBYfr68OfD9NnzfTgUP+d8cvh6C6fuZ4VOLJd8xn4BU0rVsgn5gs9EqMCrO3MoxtTx0YTWhN5Ss7W5VmtrCWuIRvuS3i+6XIuk3VyqrfWhS83uvVvD3oMdI8Mj2BH7CvAdU03Kzejq3T+Br0Mdkyat7X3grVL7IscWa697DnX56ujSbcV0Q7G7L3e3NfDvwO0iRUOY6jkYIwVFN/FiPN0u/4KbBrhyoCwFTDhJP72Nj7LQ9YVm8DgLKutyP/9WQ9sYr3j0G20C2HZYBYovQYSsgn/phV4AwWdkkr35wV58HGTvuv88xc1ee09/lNCJZ1jKxpRo8MKtSV5Lf2kyFVDRzcmVmw/HUOlkmbeeXurTJvgZZ7iB8Fqap4ZSJJto1vgZpx3f0fmM91h9idaa13Taqxs4eHzkBP+eADcU9Q0vthGJlO5gMN7g6zKuPWAYJZ/pVPhHRvAUNgxwM0rwfu6n7h2Pd/6SRrL6dEbvXkusHWlfCMGtmT9ZjIpC77/guygoTjF93H+5ZZTgQy32Y/EZzFzm0Fuw7uos3Tbco4Z7AmeAep3S35gGtqHryg0ZKHNdUXaccDyx7F3QExYLMvDJFqHzBq0WceM/wh1m7ne74Z2V4zgq+4T3TMOWxmeOUeLC1//qBIyeqdDWVVz16LRPHHVvYdDDRr33WJbmcN3dp/77eaR/3eeRgq46uHJ7dcklKTWZp+tgOM+T+UHSHiOicB0N3vZprec3rB61DvtcX6Pv+2LKmxv8+c8G0P2df0PbbajghSyskOSoRHJU8NLCFhn76VOI0p+yzS8GrZ1NvKumFj3PkYSLc8vvFPkCWP8A1G7w/q2fddrAWM/A9U9ptXzuHPpbz6z0bClCWH2LoeuBbqV2W9v2/f3px89nySiZhNeeKk3BjOGXeIGZX/pVj2kffA4Kf7tOSq6mjY+/PE00kHzZl7W+K/xP7xb1slxdX/sWZ/o7qJubVswc/k2x2s3/Ar2Jhuc= +sidebar_class_name: "post 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"; + + + + + + + + + + +Calculates gross up earnings for an employee's payroll, given net earnings. This endpoint is only applicable to off-cycle unprocessed payrolls. + +The gross up amount must then be mapped to the corresponding fixed compensation earning type to get the correct payroll amount. For example, for bonus off-cycles, the gross up amount should be set with the Bonus earning type in the payroll `fixed_compensations` field. + +scope: `payrolls:run` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/post-payrolls-payroll-uuid-reports-general-ledger.ParamsDetails.json b/docs/api/post-payrolls-payroll-uuid-reports-general-ledger.ParamsDetails.json new file mode 100644 index 000000000..0b6eb4397 --- /dev/null +++ b/docs/api/post-payrolls-payroll-uuid-reports-general-ledger.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"payroll_uuid","in":"path","required":true,"schema":{"type":"string"},"description":"The UUID of the 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/post-payrolls-payroll-uuid-reports-general-ledger.RequestSchema.json b/docs/api/post-payrolls-payroll-uuid-reports-general-ledger.RequestSchema.json new file mode 100644 index 000000000..6bfd7ddca --- /dev/null +++ b/docs/api/post-payrolls-payroll-uuid-reports-general-ledger.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["aggregation"],"properties":{"aggregation":{"type":"string","enum":["default","job","department","integration"],"description":"The breakdown of the report. Use 'default' for no split."},"integration_type":{"type":["string","null"],"enum":["xero","qbo"],"description":"The kind of integration set up for the company. Required when `aggregation` is 'integration'. Must be null if `aggregation` is not 'integration'."}}}}}}} \ No newline at end of file diff --git a/docs/api/post-payrolls-payroll-uuid-reports-general-ledger.StatusCodes.json b/docs/api/post-payrolls-payroll-uuid-reports-general-ledger.StatusCodes.json new file mode 100644 index 000000000..ddc8a2eac --- /dev/null +++ b/docs/api/post-payrolls-payroll-uuid-reports-general-ledger.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Successful response for general ledger report generation","content":{"application/json":{"schema":{"type":"object","properties":{"payroll_uuid":{"type":"string","format":"uuid","description":"The UUID of the payroll record for which the report was generated"},"aggregation":{"type":"string","enum":["default","job","department","integration"],"description":"The breakdown level used for the report"},"integration_type":{"type":["string","null"],"enum":["xero","qbo"],"description":"The `integration_type` used for the report, if `aggregation` was 'integration.' Otherwise, this will be null."},"request_uuid":{"type":"string","format":"uuid","description":"UUID to use for polling the report status"}}},"examples":{"Example":{"value":{"payroll_uuid":"a83d0bd8-7d20-43b9-834c-6d514ef6cb20","aggregation":"integration","integration_type":"xero","request_uuid":"p83d0ca8-7d41-42a9-834y-7d218ef6cb20"}}}}}},"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/post-payrolls-payroll-uuid-reports-general-ledger.api.mdx b/docs/api/post-payrolls-payroll-uuid-reports-general-ledger.api.mdx new file mode 100644 index 000000000..40ab58f10 --- /dev/null +++ b/docs/api/post-payrolls-payroll-uuid-reports-general-ledger.api.mdx @@ -0,0 +1,73 @@ +--- +id: post-payrolls-payroll-uuid-reports-general-ledger +title: "Create a general ledger report" +description: "Create a general ledger report for a payroll. The report can be aggregated by different dimensions such as job or department." +sidebar_label: "Create a general ledger report" +hide_title: true +hide_table_of_contents: true +api: eJztXOtv2zqy/1d4dT+kBSwncdM2zafb08duF7cP9LG9i7RQaHFss5FIlaSS+AT53xczJCVZfiROkwucRQscnNYiOT8O58XhkJfJRTqtrdOpVA6mhjupVermFSRHxwmUYxACRDJIeFV1m9jk+yDRFfh/vRHJUVJp69KKz40uChv/ktW1FKmBShtn0ykoMLzIChBTMMkgEWBzIyscIzlKXhjgDhhnoR3z7ZjvzibaMM7CwEP2eQbxS84VGwPj06mBKXcg2HjOhJxMwIByTMgSlEXUzNb5jHHLfugx04YJqLhxJSg3/Ka+qS8WmJsBOzHwswbrCP0Jk4p+NWArrSywc+lm9MtxoP+3V58ZKFFpqdz3B8PhrgEincPuFFwz/e6oD5nTrNJFQdPCwazjrraMKxGn9eXj/7K60orluqwKQC7FaTsj4QyalueyKJADnnHIAKkYZ//49P4djl9yPz+b6wqO2AmOx9U8C8COzo10cMLef1zz6Whx4U6SQVJxw0twYGxydHyZKF4CykBn1ZNBIhX95mbJIMHJSwMiOXKmhkFi8xmUPDm6TLy0JdYZqabJVV8qcMJfvrx5yfSE+BRoJFeDhuz/pX8jGX7+4U36TzC41JH6DLggUWvpT3hhoU/lJc6llAosERHcQTrmFgR7/uENO/ODMm6tziUxmIRgrmtDDXKOIvlmwpRWwKRlldFnUoAY+Da8qgqZk7LsWHZcSiXLuuyO/f3BzLnKHu3uCp3bISnlMNflblTCqFL0fZdXMg09pZr+dxgw7fz8EGHUFsQwWc/tQQKqLlHXR3ujx+nek3T/Maq2gAmvC5ccdX+/uvru+QjW/aHFHIfrL2uulQPl8FNnzrs/LHL5chmHHv+A3C2sz3ESFRmX5vsgqQxaGifB0rCdjxvmE2cwSH7oMZmaqOokGo0l87PtC9zYAD8V+lxFqfP6MGRoInbC2Duku0ozWxXSDVF0OwNnHllEeNxCVHVRINkI9QKMTgbJz7FeDeZUKoE4OoMzC47VVWM8gtoO2cfARnY+A8VOOsw6QXnY6YyxM2Rva+vQbiAiJifL7ZV2vT7JFf3BBfPmkBZltLeH/1vE/qnOc7B2Uhet7UTAq817sF1ed28tRouysmCPVgiLt43JURIM1o0sDzOQayNoKuczmc86AsLOuW2tMErE/7O4FnAGBal9Ixse2b1J50l/1JNV5AfL4oWs6srWcIe9dzMw59LCgLmZtI1fQ0ykX10Xuv2C0mI6jfgIHvpfqabd9fNeOCEJhwuOfpck6ZX/O/71jBc1LEtXwg8fib2xOEyfitFeevBo/Cw9fHSQp0/E4/0DmDzJx6O9pCcQC0u7aoEi+xcnnlRIK+dI62A/PRhxojVH0vuHkVbU1IO9g2XlfKcde61rJdg3xdg35eMKIkJxhdW1yYEJDd4KwIW0bsje8lNgtjY+UIpezquJtOyMF1IMvylcq4PRaJnsF1UZjVaBjwtgr5STbt4gkJaVfM5mvKpAeQuGVMZazFEHyZMGjAwtBJfKMjBGmzayO5GKQGTcOSPHtYOMFuxkwBqB9CNMuCwsEzWgSHDV9mzi2pMh+wR+psevPJkX3MFUGwl2S4dNMNO86f6QTWspvByW2gAT4BAQMm8L+3c9d38zt8/cTaGHn/By1BF+b00ON4bPUWUdlPa6gIZ6Z6eAHQLK+Roa1GqFZeu51gpyOZFgcSGDMlJ3pvO8NnbIPs8riVHp3FvSU5gzKUA53wvbN2u42wTzzEBB0a3T7ZBkeBvUW0DDEbAtipcfiXYvcahoPYKUsanRdSXV1O+Bwp6OXInTbFzLQrAc5aAM7WdcCTLfUnnp7foSjMUbQtKyE0WGLfPreDIgcH6tvJcJIs848y3ZSWjKwiLNfcgP3mT5j8SaEvVtCtdz5kOcb5BGxse6dp21S2NoFFctDB2ZYWsz4blnCFe45UT+mIDCccHdyqCot82Oym2ggDOOG2TuOI4ZBGQet7veBUjFSKcx7CSzESzSuIAhe60NC35ysDAE4SNWnfj/h9gA1zb+4rfX0clHZ4L7Fa3g/YR2lpvnUtaFk1UBnhbqUU/x4s/Lyha/bKHSi7StVNNIGbtxISR+4sWHDiW/LVpBe94LwdZJzTteQoxAA0fdjHfFJtfGx9fCMqdJGjoMvp7CFyV/1tCaB9PEbn4YGtFb74nR5YaosWlXV5nTmxsu2LlVDTAU2xSiYmjjpMOgLHkbpD/9Kt0sfa8g9c7PB3KrW70NsuOb4tJgSuH3mv/11xxHWuuwF/nwFY2PVsXcB7i4S9ngNobsjaPsjrZWYojlNJvxM2CNHaL9l8W1C24kOorGrCS5NHldcPPAw00p+Enfk8A9TLozXNHAC/RF2t2bjLk6zXie61q5TEABDrJaTWolQGQVn+MuciGIOV6INRLMc3UDE9yV9IK1pOPmkte1ElJN34KbacFm3LJIjTXUaA0WgJ2BkZN5JhWJbo5IK23lnSL7F4YBSJUFqug5cfcyBkb0JYgh+1AAt8DyGeSnPkjBiDXAYbzEjuja102BFwa4mGdxxHudALI3EGRjANXOYwXAUlq0UJnRtUO1WQ8stMhUXY4pP7oCYi/IXwD60fdnvj/qRHS7AVeQhCzXaiKntoHWxJpbcW25dxfMc8dwSR3D5GsbzJYhuxUDi9XA4mwn3LqoLVkhS+k2IFzReGsWvkbEYQxGYzA703Uh6CwjcLbBnFVgpBYtXlAiE8FarkHZNFmJbTUvXylB2e+O5tAOys24Yo9YqZWbWYwJJ7WrDXh88dRAKlFbZ+aZhQJySmMoLnOb5VpA1gZmaxG3rbfn5zvsy7DvCnG8GcJA5v4BRtGEnzUv0Is8YUJOZWN2NsC1EYC9AVwrc992e7SfZE5Y7TLYgwDWY3WyhExPJlmlC5nPMzyUudlal7diYrlqffsgakUaBaLRF57npuZFZjbrzEKzLSz3c9+PYb+GY+MCTTlGVg0eRgAl2DXAKyDnmoVEyibv2Ou6DdoXXrkF8NzJM4Tsx/B73ICBIQGmJ5OY1VmHGcqq0HMAe5Nlbxpvv/avYlfGDdxcAsa84CqHrK6usZfrvfUmVC+4ogwpFz9o2T01u3nZZ7qQAq06/ucBx7CCAtG7jIpeeGPShBEUUrCAAD1QWPz10JR29werSTFTJL0K2IBVIWTzFQJawVqojXtsxOxeRPGNb8PiEAy3XbaTwyB8Wo01NxiGx3Z3yb+owxjws4ZUA8lDWJrMHSL4TLlHaSnZQ9vSplTCZ4ExudzzaD6syEBh/giDMGd47rTJcBO2AVu/5fZq2gzg93ttfOOx+BMrknK0fR5vq7AR/33Gsb05rnBz1nFDcTufODC0179JFLDca3v+fWji6p0V4+20atymJihPyYKinGGVjZ9FTC3eFP9C+19CvjDStZhj63ZLQ+d9U6OtxXRHJK6ANgObYp3QYvtwB2iP0EQUcV/Qg0RRC67ITNfmJoHh7Vzd33H0juYoOsg86zMo6HiOfrC4Q3vzIRzAtwA8iUY9Jkb/CSqLJUJ3aekw6xPIL23Jw6Eb5hbeOOvT6S1GH3YIPCHjhQOzBm0WRtm8b/8l4NKyMaBxawDHo5YeVEo1SksBYABbq1ILOZFktiPkmM28S7DxxKhaWmwPwHNygeXeUFowZ8GK27l1UDaNog3vxwZkBWwWiwaujRN8+18xQIsjtVqtGKUnA86SX2A1Vx+nrU3Fcc73CPXVRQ6AUUTAgCuxv7dHXC20Pq2rTby8R2Ax4Ip7ACo5eGAfDpPFs6/2XOe4l3Rvtg9JL1ce6adUrLo/eoQzXDBo40Lnp2Aa509JN6kmeivh7422MhgmiQiB8EIeUCqmjQCD/snUqqmD7U3f017GuXk+zeJYcHV1P5Piog1N7e2m04O5eU4TEFSz6vjFfU4r1OYCC/SY4xeM6N1ujsuwbyCKPiecN1VmdzrNBTGMFitmoX9BLhdAr56krS3mIrZMsd9kUhKLWsLgXSd47RRaSB6yrcc0K62WlqbJ2W0KzZe63yZV1wzC4iCsId7uIZJ1gFuv/KtoF47LevyL1II1phQ6z2eZmxmwM12IDILzSTrnd30ENC1osG7Pq8iXWN7Kz7gseDjMw4i/OANGufnnL/7OPkdwLHrGzvmR1paSEegkv0oD7I0asLf6DNhnjcV1hr3kdBzZdZihPPtWYVOzfTlrqtwXzo4oL8adg7KiTSzWOlJIx3hbz1GjcGLIoWuX6klK38OAcZspp4o7bTC1x2Vxs7Qel8VtUnpcFt2Nbh9A3HfH7NiM26z5evfZFH+a2xx44OI21PyliqbUOoiBgRJXnI7OY/Kg7TKGCQ6GdQLIdKbgHAeNgZ68AJEJace1sUCHSe259ZqJdVtvoX2d3EI8t1oZ/WzQvXVDLGLQLptgXekCd192QJPWURPPhXuentgTEz4ajVIu9g7TA+BPU773hKdP958+OTzMH433nz7bMOk4Wkmn3beJ/f0Bn+/f+E9vNY7YS4ln4eylP3wesBd4KD1M+lyJKEJ58q1RhEtGwfT5iJoqoRdR7oRo2x/x7wyjDWsXd1OyhnJ/N5GKNTXHWBjek5FkIpW0syxkOdG7YiGBD73uIScdGOT3+E6jZjvWEu/lBAvto5iMhr4uCrPOALhsf/tVpOsaUuVFLdCi+4HQthiwdklmcl+i9Gs0aJD+yL5KZ3vXi92QtSFLfG60mob7aUs0/pTVLcTcm2RQuNeOWbw/ZeUPXR/AcDpk+6NHB48frlCxmVZw63qID9g7VkNEJd/fWzgoxYqDQuabMg0rlUfUvgIc1h09dlQnXE20nfLeNlnlj3B6G/ibJLJXwtpcR/C5ez2grcmg1ffrgrXZPlKOOl7o8055A9VybSpuaPf2t84mIMlYzdcXiG6O4G4INJMMnszHsPZ6nx8a3twdEpUQaEcrhYpmN3g6/E59brUDwZpgEIw+4bUe6rPT3iRQmlV4w9K52MpGrzLmVub3vDvnVOYX7XeMNinI2G4LqwCE7fihsA1cEX9Evp2H4vA1s6PPWzP8K5aFRzszpWNRE0JW0xZq7DWOagndPeboKZJYnyTv5Zw9AszhM6pMzx2zdUWXsQQFR8W8f8IfL0OFOfgT0DvPQ/eKHzqQPUHRO83aVC4mjXXZ7QpeXmNfpnplL0vWSpB/mGRjaei+9ZZUXtK5+oRR92ZrHDwolU34AJBszs2OaZta0NsE8SF4fzricPBk/2kqOH+WHoB4mh4+hr10/xDEY7EHcPjo8QaTRqdht9iUFgVnr6X7c4qpOEEVvxyNOW7XGCosyfCsdxqGd3K13yI2R82BCSs2OnfMqZF4Op48GeXpmI8n6QHfH6WHo2ej9NHBHozEs5yPR4cbOHU7K/TGcsln7A8whVQNm5AvxZxYdB5ur9yMQzGmBmV9PN3kPTbX7ayv1dpYwhqi0a6kd4suVyJpNpdqY33oQrNb79awd2/HyPAIdsC+Apxiqkm5GV29+xfwVahj0qSxvXe8VYqENll73XGoVwsF/Au3FdOVxe6Ll3D/iIFCcwX3LxsxXA2Sjx2/cd2E/kMcyNUgedd4kOvm/NuV/HYlv+BK4u13x6eIMfnoX7Shpw0uXHgQiMB72GsfQhpESb3mQSR8HSVkCf1rSPRMjpslR8nu2f5ufBpp97L7bsDVbnhpZ3fpcSSqZwj8rU2BMhjuRPNK+ivRqYCS7kUv3Wt6CSU+G3CR2gr4KXA7T/14qU+K4mcUozUDrxzzg6EE6LoxK/yMTLCQ14Y278eX0bg+p6dAntfIjuPv3Vaf8C67t+8r2jbXtxBifMgG/z0Gbla9IeWHSP07GLx2M9x8x0PGQfKJKkN+hYIfYQ2Bq0GCd/Q/to/kdB6OWHz5oX3xY92rD5Sk8TUG0WXSO0f4bBBKZTxI6r7RM0jwHSP7fvIJzJnMobO47SV6une8Sw13Bc4DPXxK/8YDIRu6Lt2VgyLXJZ2TEY4dy14FhWCxNAtfNBI6r1EPaUb/FV4z4D7vFV5sehmpso944zwkN/wZErImfP2fVhiRtahUJVedcTY/GdafwWX7rsLvx8b+Qo+NBaVwcOF2q4JL0mSyXJfBwh4nZ/tJUz+AsnTUe4ss0EgGSc/QfscycutwjMtLDBy/mOLqCn/+WQO6r+Pv6AEMVb6RSROSItY1T4l1hexBfI7pIVv3jNma2cVLq2re+p8kCTdoF1+e8ZXw/p2z7eD9hz96tpKxnoGrX4xr+Iye0Td84ZmVfl6IBJYfZWl7oG+p3Ma23UDhw/tPn5NBMg7vqZV4swx3tOcos/zcr3rM/+KDa/jbZVJwNa195OTHxD//BiZzf/A= +sidebar_class_name: "post 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"; + + + + + + + + + + +Create a general ledger report for a payroll. The report can be aggregated by different dimensions such as job or department. + +Use the `request_uuid` in the response with the [report GET endpoint](../reference/get-reports-request_uuid) to poll for the status and report URL upon completion. The retrieved report will be generated in a JSON format. + +scope: `company_reports:write` OR `company_reports:write:general_ledger` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/post-v-1-companies-attachment.ParamsDetails.json b/docs/api/post-v-1-companies-attachment.ParamsDetails.json new file mode 100644 index 000000000..02a817035 --- /dev/null +++ b/docs/api/post-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"},{"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/post-v-1-companies-attachment.RequestSchema.json b/docs/api/post-v-1-companies-attachment.RequestSchema.json new file mode 100644 index 000000000..c5f5fa8c8 --- /dev/null +++ b/docs/api/post-v-1-companies-attachment.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"required":true,"content":{"multipart/form-data":{"schema":{"description":"The binary payload of the file and the company attachment category.","type":"object","properties":{"document":{"type":"string","format":"binary","description":"The binary payload of the file to be uploaded."},"category":{"type":"string","description":"The category of a company attachment.","enum":["gep_notice","compliance"]}},"required":["document","category"]}}}}} \ No newline at end of file diff --git a/docs/api/post-v-1-companies-attachment.StatusCodes.json b/docs/api/post-v-1-companies-attachment.StatusCodes.json new file mode 100644 index 000000000..8a655e785 --- /dev/null +++ b/docs/api/post-v-1-companies-attachment.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"201":{"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"},"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/post-v-1-companies-attachment.api.mdx b/docs/api/post-v-1-companies-attachment.api.mdx new file mode 100644 index 000000000..83191176c --- /dev/null +++ b/docs/api/post-v-1-companies-attachment.api.mdx @@ -0,0 +1,73 @@ +--- +id: post-v-1-companies-attachment +title: "Create Company Attachment and Upload File" +description: "Upload a file and create a company attachment. We recommend uploading" +sidebar_label: "Create Company Attachment and Upload File" +hide_title: true +hide_table_of_contents: true +api: eJztXNtyGzeTfhXs7IXjKg5F0bIt62odHza6cKyKnfX+K7vG4KBJIp4BJgBGEuPSu291A5gTDxJlqbY2lZQjWyTQ+NDoExoNfE+u0kVtnU6lcrAw3EmtUreqIDk5T6CcgRAgki+jxICttLJgk5PvyXRyiH8JsLmRFfZJTpI3V7ysCmCxZTJKcq0cKIdteVUVMif6B39Y7PA9sfkSSr5O6eMSWK7LiqsV487xfFkilVHigSV69gfk+PtVCn5QQmXrPAdrM+u4q+mTupYiOUkOp8+eAIen6dHR4WF6dCxepDPxTKSHxyBePJkcT+HZ02SUKF4i9Vd+5OxlM3L2VhYwrsQcp8QdLLRZJSfJAqpMaSdznGpdFZqLzEmiMZ1Mj9LJi/Rw8nFyePL06GQ6+Z/k+hoRO76wyNwwDGuHQTZXRldgnIQO/u9x3tYZqRbJaMCu338/fc30nLnNbLuOM7uJDraKdOayAObnBAJJtPO+iQytXmi9A9YoAVWXyIkeH7FlIbmiX7Rbgkm+XA/YexsEpx/es+Nnk0OGXazjZYVYLpegGFcdHOyS285Er0eJk67oyEH6ssfKrsAFicd/XvCihv9rkZumk2k6Ofw4mZzQn/FkQmKH/42So8nRuqr9qh17q2sl2GfF2GeFrDPwZw3WgUBV1rXJgQkNlintGFxJ68bsHf8GzNYGaHUroy+kAMFIEqVlF7yQYvxZIcOOptP1YX9XldGorHxWAHujnHSrBoG0rOQrtuRVBcovGY4y04LkaaVrEzEytDBcKsvAGG0ss3W+ZNyyr1IRiIw7Z+SsdpDREn0dMW2IXKQw57KwTNTAnEbRaHqiIpK9+jpmH8DP9PyNH+aVXxIJ9stPS+cqe3JwIHRux2RMx7kuD6LxTCu+Mroo6PsDgpnmTffHbFFLAWyuDSu1ASbAISBk3p3t5ybu/sPcIXOHzgQxSwOCPB8hWTfI4fPWAnFj+CoZJdJB2f18O9XsG6y6Sr15DGp1o6H7UEEu5xIsLmRQRurOdJ7Xxo7Zx1Ulc14UK+Zw6b/BikkByvle2L5Zw4OKG16CAxSAgqP+O92SHO/nBVpoSAHbonh5SqznIoL1CFLGFkbXlVQLy7gSLOeKzYDV1qOZ1bIQLEc5KEP7JVeikGrBpPLS24lkxux03g4kLfuqyLBlfh2/jgicXyt2KYsiijzjzLdkX0NTFhZpxS6lWzLwJst/SawpUd8Wt/BOZ3G+QRoZn+naddYuZQtQYNpVC6QjM2xt5jz3DOGKgRLIHxNQOC6445tEsQ/jVVRuAwVccOUY9kOaQUBWQZODC5CKkU5LHcxGsEizAsbsrTYseMZRjwThI1Z99X9niOorrW38BF3mV8/+WetMxuj/FbyfJyfnN82lrAsnMfYkiqhHA8WLH68rW/xmD5Xuj22lWsSRsRsXQuJXvDjrjORMDRvH9gy5WWp+7QRngaNuybtik2vjQ29hmdMkDR0G3yKMVPLPGlrzYMhutuMRRW+950aXLcHzlqKqi4LiNd+urjKndzfs2blNDTCah11NOiHbuyD96Sfplul7Bal3fsn19lbvguz4prg016N/1vzvsOZIaavD7vPhExofrYqVD3CZ3Ok2xuzU4ceVtlZiiOU0W/ILYI0dKuACCotrF9xIdBSNWUlyafK64OYnDzel4Cd9TwL3uLcR2dDAC3R/+zvj6lvG81zXymUCCnCQ1WpeKwEiq/gKtxW9IOa8F2skM+737O1uYy1YSzpuLnlbKyHV4h24pRZsiduoMBprRqM16AG7ACPnq0wqEt0ckVbayntF9i8MA3BUFkZFz4m7lxkwGl+CGLOzArgFli8h/+aDFIxYAxzGS+yIrn3bFHhhgItVFik+6ASQvWFANgNQ7Tw2ACylRQuVGV07VJvtwEKLTNXlDMxmiIMgvwf0N9+f+f6oE9HtBlxBErJcq7lc2AZaE2vuxbX13l0wLx3DJXVMK2BtMFvW1nUDi83A4mzn3LqoLVkhS+l2INzQeG8WvkXEgQYjGswudV0IxMwDZxvMWQVGatHiBSUyEazlFpRNk43YNvPyjRIYD0JHc2gH5ZZcsSes1MotLcaE89rVBjy+kOXJpBK1dWaVWSggR+nOFJe5zXItIGsDs62I29b78/NX7Muw7wZxvB3CMMzDA4yiCX/WvEAv8owJuZCN2dkB10YA9hZwrcx92/3RfpA5YbXrYI8CWI8V01CZns+zShcyX2WY2rrdWpd3YmK5aX2HIGpFGgWi0Ree56bmRWZ260yv2R6W+6Xvx7Bfw7FZgaYcI6sGDyOAEuwW4BWQc81CImWXdxx03QftK6/cAnju5AVC9jT8HjdgoAwq0/N5zOpswwxlVegVgL3NsjeN91/7N7Er4wZuLwEzXmBaOaurG+zldm+9C9UrrihDysUftOx+NLt72Ze6kAKtOv7vAcewggLR+4yK4oFDDCMopGABAXqgsPjboSntHg5Wk2KmSHoTsBGrQshmAGVVK9gKtXGPjZg9iCie+jYskmC47bKdHAbh02qmucEwPLa7T/5FHcaAnzVDNZA8hLXJ3COCj5R7lJaSPbQtlaqXBcbk8sCj+bAiA4X5IwzCnOG50ybDTdgObMOW+6tpQ8Dv99r4xmMRpLAk5Wj7PN5WYSP+h4xjB3Pc4Oas44bidj53YGivf5soYL3X/vw7a+LqRxvoPWrVuE1NUJ6SBUW5AOXCLGJq8bb4e+1/CHmP0o2YY+t2S4NHDtnCaGsx3REHV0CbgV2xTmixf7gDtEdoIoq4LxhAoqgFV2Spa3ObwPBuru4XpN7RHAUL7uTFkEFBx3P0g8U92pszT78DwA/RqMfc6L9AZQHHvVo6zPqE4de25OHQDXMLp876dHqL0YcdAk/IeOHAbEGbBSq79+0/BFxaNgM0bg3geNQygEqpRmkpAAxga1VqIeeSzHaEHLOZ9wk2nhhVa4vtAXhO9ljuDaUFcxGsuF1ZB2XTKNrwYWxAVsBmc21Kvmu332//IwaoT6nVasUoPRlwlvxKlnU5xGlrU3Gc8wNCfXOVA2AUETDgShxOJsTVQutvdbWLlw8ILAZccQ9AJQc/2cfjpH/21Z7rnA+S7s32IRnkyuP4Kf6aHk6f4Ax7Bm1W6PwbmMb5U9JNqrneS/gH1DYGwyQRIRDu5QGlYtoIMOifTK2iegyn78dex7l7Ps3iWHB19TCT4qINTe3dpjOAuXtOcxB4lJo5fvWQ06KyJQzAw3jM8StG491tjuuwbyGKPifsi0TufZo9MYwWK2ahf0Aue6A3T9LWFnMRe6bYbzMpiUUtgXjXCd44hRaSh2zrGc1Kq7WlaXJ2u0Lzte53SdU1RFgkwprB2z1Esg1w65V/FG3vuGzAvzhasMaUQuf5MnNLA3apC5FBcD5J5/xuiICmBQ3W/XkV+YIiQGmbCy4LHg7zMOIvLoBRbv7lq1/YxwiORc/YOT/S2lIyAp3kJ2mAnaoRe6cvgH3UWFxn2GtOx5Fdh3kBxu6rprFvs32JRAZnR5QX485BWdEm1ukQ0jHe1nPUKJwYcujapXqe0veBYNxmyoXiThtM7XFZ3C6tx2Vxl5Qel0V3ozsEEPfdMTu25DZrvr3/bIo/zW0OPHBxm9EYlQcFQI0YGChxxenoPCYP2i4zmCMxrBNApjMFl0g0BnryCkQmpJ3VxgIdJrXn1lsm1m29h/Z1cgvx3Gpj9LND97aR6GPQLptjXWmPu687oEnrqInnwgNPT0zEnE+n05SLyXF6BPx5yifPePr88Pmz4+P8yezw+Ysdk47USjrtvkvs7w/4fP/Gf3qrccJeSzwLZ6/94fOIvcJD6XEy5EpEESrc74zC94+mz0fUGNpXfZSPQrTtj/gfjaMNaxd3V7KGcn+3kYotNcdYmD2QkWQulbTLLGQ50btiIYEPvR4gJx0Y5Pf4TqNmO9YOPsgJFtpHMRmRvikKs84AuOxw/1V8h8IjVV7UAi26J4S2xYC1azKT+xKlHxuDiAwp+yqd/V0vdkPWhizxpdFqwcLuezjGX7K6g5h7kwwK99oxi/eXrPyh608wXozZ4fTJ0dPHG1RsqRXcuR7iDHvHaoio5IeT3kEpVhwUMt+VadioPKL2FeCw7eixozp4fOeWYDvlvW2yyh/hDDbwt0lkb4S1u47gY/d6QFuTQavv1wVrs32kHHW80Jed8gaq5dpV3NDu7e+cTcAhYzXfUCC6OYL7GaCZZPBkPoa1N/v80PD27pBGCYF2tFKoaHaHp8Pvqc+ddiBYEwyC0VfsUejzqL1JoDSrwJTSudjKRq8y41bmD7w751TmF+13jDYpyNhvC6sAhO34obAN3BB/RL5dhuLwLbOjr/dm+CcsC492ZkHHoiaErKYt1Jg0jmoN3QPm6CmS2J4kH+ScPQLM4TOqTM8ds3VVaeOYoOCoWA1P+IM5inPwJ6D3noceFD90IPsBxeA0a1e5mDTWZXcreHmLfZkalL2sWStB/mGezaRxy/1HeU3n6nNG3ZutcfCgVDbhA0CyObc7pm1qQe8SxIfg/fmUw9Gzw+ep4PxFegTieXr8FCZ0m+6pmAAcP3m6w6TRadgdNqVFwdlb6f5aYCpOUMUvR2OO2zWGCksyvBychlnAGJG2iM1Rc2DCho3OPXNqKp7P5s+meTrjs3l6xA+n6fH0xTR9cjSBqXiR89n0eAen7maFTi2XfMl+BlNI1bAJ+VKsiEWX4fbK7TgUY2pQ1sfTTd5jd93O9lqtnSWsIRrtSnq36HIjkmZzqXbWh/aa3Xm3hr0HO0aGR7Aj9gngG6aalFvS1bt/Ad+EOiZNGtt7z1ulONAua687DvW6V8Dfu62Ybix271+7/TkGCs2l2/+3EcP1KPmt4zdumtDfxIFcj5JfGw9y05z/cSX/uJIfcCXx9ntjvU5xbpW2Lr04TJvyrrT3MsHgkhTds2fcP4pAYasvQOQb3jUYs0+Yzcp1WdLFTOor1eKzOnv9lij4klDcy5W88BScnMkCr1uxX/QlXIDxF1Pnuij0JZodGpk2ZZjb/6w4fgHihI3/nM1G+LMcsfFCzkds/Ee1GLFxpeinwE+uCut/Xo3YWOic5oD/uBqzz+qzsrmu4IR9bZLszWzsyaWRDr4meCgXNu9+qcPLBU2FOm6OpSITS3ajPSvw1+Dau+r9G2nXmx5v2PCiBRmqMOh/p/9Jb5a8PDtN/6s5AqHRl8AF2fV2/DkvLAxHeY0zKaUK95PRMqXoLgR7eXYaj0EYt1bnkmphKKVC94uxAV6ppsvFCv2xbCs+R75N57b+I8vOS6moiqJDe8+r7bySaegp1eLfA8G08/FjhIH3pNH9bON2++jGdDJ9mk6epYdP8VKsgDmvC+efkYifX19/GSW7nysJm6KftaAczXDRO+8X+Ktx3LgDTDCk0ezsegJmJhU3VABM+td9mQQFePO7Is29vfGGK/79u5hC53UZ4A3ZFIuBEg9i4xMjO/DhVfX2/ZQ9r84PH1DZaGZu8X4KOdruNehmwt3nB67DVUJbAf8G3K5SuoHf6na74jbpN0R1TPUFGCMFGQMyi4jsyoGylKtCW+EdwtaXhkYxBui+OITqHvsNoTUdNkHc3LEPtUPAQ0ZJD0c73jmQwXPL5CQ5uDg8aNzEwffW4F0f8B5nqPAsWMfaFGiMgobzSnoFTwWUpOVra/4aSj3grqeX+tMr/BpntoXwRppnhk6qttGs8GucuIW8NpRlPf8e9fwlPaX0skYWnH/ptvqAGusVaEPbRrYRYjRE+PsMuCHDPHyFwD+yQxdmGa/dErOksRpklHygEr4fGcFT2DIAJcB9/VbcjpBrQUuNUhIP6btmcZSg67Dv5x/AXKDStevRWnF60+GAGh4IHBoNT0q/42G7DV3X7iFDkeuS7AfheGTZm6ASLJa9ohOJmkzT+LfwUgz3ZwrBSb6Oo7Lf8DWPkDj25/MoUOHb/2jlB7mBsl9y1aHzysc66/afjHCIjfC1ouFkvrfm/58QikKoILgOrtxBVXBJEk4a/T1Ym/Pk4jCJJ4r+HYuTXojVNTlf8OaLddjr+3cMXn43xfU1fvxnDehozr+goTNUrEvKLSRtsrcERd0F++m34Dces20B2Zb5xHv21CKa2SRc+u/Gi/7qjo/X9gP3Nw/eNrLVs29z5NtwufV9rzyz0o89B7sxCms7oZmtXKf52qNTPT959v7Dx2SUzELwV2oKApAw0R21/0QXcn39v/Uv55g= +sidebar_class_name: "post 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"; + + + + + + + + + + +Upload a file and create a company attachment. We recommend uploading +PDF files for optimal compatibility. However, the following file types are +allowed: .qbb, .qbm, .gif, .jpg, .png, .pdf, .xls, .xlsx, .doc and .docx. + +scope: `company_attachments:write` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/post-v-1-companies-company-id-admins.ParamsDetails.json b/docs/api/post-v-1-companies-company-id-admins.ParamsDetails.json new file mode 100644 index 000000000..02a817035 --- /dev/null +++ b/docs/api/post-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"},{"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/post-v-1-companies-company-id-admins.RequestSchema.json b/docs/api/post-v-1-companies-company-id-admins.RequestSchema.json new file mode 100644 index 000000000..30d60d888 --- /dev/null +++ b/docs/api/post-v-1-companies-company-id-admins.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"required":true,"content":{"application/json":{"schema":{"description":"","type":"object","properties":{"first_name":{"type":"string","description":"The first name of the admin."},"last_name":{"type":"string","description":"The last name of the admin."},"email":{"type":"string","description":"The email of the admin for Gusto's system. If the email matches an existing user, this will create an admin account for them."}},"required":["first_name","last_name","email"]},"examples":{"Example":{"value":{"first_name":"John","last_name":"Smith","email":"jsmith99@gmail.com"}}}}}}} \ No newline at end of file diff --git a/docs/api/post-v-1-companies-company-id-admins.StatusCodes.json b/docs/api/post-v-1-companies-company-id-admins.StatusCodes.json new file mode 100644 index 000000000..8f0737f3c --- /dev/null +++ b/docs/api/post-v-1-companies-company-id-admins.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Example response","content":{"application/json":{"schema":{"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":"John","last_name":"Smith","email":"jsmith99@gmail.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"},"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/post-v-1-companies-company-id-admins.api.mdx b/docs/api/post-v-1-companies-company-id-admins.api.mdx new file mode 100644 index 000000000..4e17e3f76 --- /dev/null +++ b/docs/api/post-v-1-companies-company-id-admins.api.mdx @@ -0,0 +1,72 @@ +--- +id: post-v-1-companies-company-id-admins +title: "Create an admin for the company" +description: "Creates a new admin for a company." +sidebar_label: "Create an admin for the company" +hide_title: true +hide_table_of_contents: true +api: eJztXFtvHLeS/ivc3gfHwLRulqzL03FsZ48WcGzE9noPZKPFadbMMO4mOyRb0kTQf19UkezbXDQjS4vdIAaC2D1k8WORdWFVkbfJTTqtrdOpVA6mhjupVermFSRnFwmUYxACRPJtlDg+tfjttS4rriRY/Kgr8F3ORXKWVNq69Go/zWOT8Ld5JkXKRSmVTUaJAVtpZcEmZ7fJwd4e/k+AzY2skFJylry94WVVAIstk1GSa+VAOWzLq6qQOY26+7vFDreJzWdQcvybk66A5Cx5hcMlo8RPJdHj3yF3yWgw0qcZjlIZsKAckWR6wrhihJbVFgyTiv0HcmgnGSU3KXhsBD7gxL/WtUQOnJ4c7x2d5Hl68AIgPXwJp+nJPkzSoxxg7+RlnkPOk1Eykca6TPESof2nniHQgrefPpbSzZJRAiWXRXKW/G7xw+npP6b4YSfXZXJ3N0oqg/x30qPxEG7jjK0zUk2XzrhW8o8amBQ4WTcDP9ud5K4ZcRMq1LRHgU208bx6ZpmdWwclEe1OdxPK1J5h+0WAHTZtQgqbr6BUzbTakAo1Zaoux2CGhO5wV0TheOU3+Tfc5X/U0oDAr7Qy35C7yzfPFS9q+ssj7ItR3IpHAvb3j0/309OTiUgPj06O01MQe6k4Eid7h+MTeHl4nNzRn1FyuHe4KIa/asd+0bUS7Kti7KvywvJHDdaBQOHUtcmBCQ2WKe0Y3Ejrdtg7/h2YrQ0Qmyqjr6QAwT5/Pn/DpGVXvJBi56vCJTg8OFgc9rOqjM7BWj4ugL1VTrp5g0BaVvI5m/GqAsWuZ6BolLEWc1yYua5NxMhQZ3CpLANjtLHM1vmMccsupSIQGXfOyHHtIKMVuBwxbYhcpDDhsrBM1MCcRq3Q9Gz03uUO+wh+phdv/TCvuYOpNhLst59mzlX2bHdX6NzukJ7FRdqNejWt+NzooqDfdwlmmjfdn7NpLQWQVJXaABPgEBAybwuNeD93/2bukLlDq9GVZj9hlPG+/g3fW4XCjeHzZJRIB2X3+2qq2XfADgHlfMUY1OpevfWxglxOJFhcyCCM1J3pPK+N3WGf5pXMeVHMmcOl/w5zJgUo53uRjotruFtxw0twgBug4Cj/TrckSZ82qLeAhhSwLW4vT4mhlomkovYIu4xNja4rqaaWcSVYzhUbAxppQjOuZSFYjvugDO1nXIlCqinacNq9HSdnh51P2oGkZZeKFFvm1/FyROD8WrFrWRRxyzPOfEt2GZqysEhzdi3djIFXWf5HYk2J8jbdwNh8iPMNu5Hxsa5dZ+1SNgUFpl21QDoyw9ZmwnPPEK4YKEFOTEDhuOCOL9uKfRivo3AbKOCKK8ewH9IMG2QeJDmYAKkYyTT6T6Q2gkYaF7DDftGGBcM36pEgfMSqS///DFFd0trGL2jMLj37x60xQVdMK3g/Sc4u7ptLWRdOojdJFFGOBoIXPy8KW/xlC5Huj22lmsaRsRsXQuJPvPjQGcmZGpaO7Rly/675tePfBI66Ge9um1wb70wLy9CTRV+kZfD9I3yOHmNQD4b0ZjseUfTae2J02RK8aCmquijIC/Lt6ipzen3Dnp5b1sA67mBdk7tRcyB4F3Z/+kW6WfpeQeqNX3K3utW7sHd8U1yau9Hfa/5XWHPyxlcZ7D4fvqDy0aqYeweXybVmY4edO/xcaWslulhOsxm/AtbooQKuoLC4dsGMREPRqJUklyavC25+8nBTcn7S97ThnifdGS5p4Dd0/6Q65up7xvNc18plAgpwkNVqUisBIqv4vATlek7MRc/XSMbcn8IbE58sOGtJx8wlv9RKSDV9B26mBZtxy+JorBmN1qAH7AqMnMwzqWjr5oi00lY+KrJ/oRuAo7IwKlpOPL2MgdH4EsQO+1AAt8DyGeTfvZOCHmuAw3iJHdG0r5oCLwxwMc8ixSedALI3DMjGAKqdxxKApbSooTKja4disxpYaJH5Y+9yiAMnvwf0N98/HpulZdHsBlxhJ2S5VhM5tQ20xtfcimuLvbtgXjmGS+oYHuRbZ7asres6FsuBxdlO8CgefyxkKd0ahEsab83CXxBxoMGIBrMzXRcCMfPA2QZzVoGRWrR4QYlMBG25AmXTZCm25bx8qwT6g9CRHDpBuRlX7AUrtXIziz7hpHa1AY+viQQqUVtn5pmFAnLc3ZniMrdZrgVkrWO2EnHbent+/op9GfZdsh03QxiGeXqAcWvCHzUv0Iq8ZEJOZaN21sC1EYDdAK6VuW+7PdqPMiesdhHsYQDrsTpZQqYnk6zShcznFM7abK3LBzGxXLa+QxC1IokC0cgLz3NT8yIz62Wm12wLzf3K92PYr+HYuEBVjp5Vg4cRQAl2BfAKyLhmIZCyzjoOum6D9rUXbgE8d/IKIXsa/owbMDAcgOnJJEZ1VmGGsir0HMBusuxN4+3X/m3syriBzXfAmBdc5ZDV1T36crW1XofqNVcUIeXid1p2P5pdv+wzXUiBWh3/84CjW0GO6GN6RT6pM2/cCHIpWECAFigs/mpoSrung9WEmMmTXgZsxKrgshnAvYqh/VVQG/PYbLMn2Yrnvg2LJBgeu2wnhkH4tBprbtANj+0ek39RhtHhZ81QDSQPYWEyj4jgE8UepaVgDx1LpepFgTG4PLBo3q3IQGH8CJ0wZ3jutMnwELYG27Dl9mLaEPDnvda/8VgECSztctR9TZpzgP8p/djBHJeYOeu4Ib+dTxwYOutv4gUs9tqefx8av/rZEnrPWjFuQxMUp2RBUK5AuTCLGFrcFH+v/Q8h71G6F3Ns3R5pMOWQTY22FsMdcXAFdBhY5+uEFtu7O0BnhMajiOeCASTyWnBFZro2mziGDzN1/0TqHclRMOVOXg0ZFGQ8RztYPKK++eDpdwD4IRrxmBj9J6gs4HhUTYdRnzD8wpE8JN0wtnDurA+ntxi92yEwQ8YLB2YF2ixQWX9u/yHg0rIxoHJrAMdUywAqhRqlJQcwgK1VqYWcSFLbEXKMZj4m2JgxqhYW2wPwnOyx3CtKC+YqaHFfntA0ijp86BuQFrDZRJuSrzvt99v/iALqU2qlWjEKTwacJb+RZV0OcdraVBzn/IRQ397kAOhFBAy4Evt7e8TVQuvvdbWOl08ILDpc8QxAJQc/2ec7ST/31eZ1LgZB9+b4kAxi5XH8FP+Z7h+8wBn2FNq40Pl3MI3xp6CbVBO91eYfUFvqDNOOCI5wLw4oFdNGgEH7ZGoVxWM4fT/2Is7182kWx4Krq6eZFBeta2ofNp0BzPVzmoDAVGrm+M1TTgv9QnLAw3jM8RtG4z1sjouwN9iKPibsi0QefZq9bRg1VoxC/8C+7IFePklbW4xFbBli32RSEotaAvGuEbx3Ci0kD9nWY5qVVgtL08Ts1rnmC90fEqpriLBIhDWDt2eIZBXg1ir/KNpeumzAvzha0MYUQuf5LHMzA3amC5FBMD5JJ383REDTggbr9ryKfMEtQGGbKy4LHpJ56PEXV8AoNv/q9T/ZpwiORcvYyR9pbSkYgUbyizTAztWIvdNXwD5pLK4z7A2ndGTXYF6BsduKaezbHF8ikUHuiOJi3DkoKzrEOh1cOsbbeo4aNye6HLp2qZ6k9HsgGI+Zcqq40wZDe1wWm4X1sGrxASE9rDOVC5u0ARDP3TE6NuM2a359/GiKz+Y2CQ9c3GY0RuVBAVCzDQyUuOKUOo/Bg7bLGCZIDOsEkOlMwTUSjY6evAGRCWnHtbFAyaQ2b71iYt3WW0hfJ7YQ81ZLvZ81sreKRB+DdtkE60p73H3TAU1SR008F554emJPTPjBwUHKxd5Jegj8OOV7L3l6vH/88uQkfzHePz5dM+lIraRs90N8f5/g8/0b++m1xhl7IzEXzt745POIvcak9E4y5EpEgfUR9YNOIB6F7x9Vn/eo0bWv+iifBW/bp/if7UQd1i7uumANxf422RUrao6vuR3ukWQilbSzLEQ50bpiIYF3vZ4gJh0Y5M/4TqNkO9YOPogJFtp7MRmRvs8Ls84AuGx/+1V8h5tHqryoBWp0Twh1iwFrF/ZM7kuUfmwMIjKk7Kt0tje92A1ZG6LE10arKQun7+EYf8rqAdvcq2RQeNaOUbw/ZeWTrj/BznSH7R+8ODx6vkTE8BrAg+shPnQvEUQh39/rJUqx4qCQ+bpIw1LhEbWvAIdVqceO6GD6zs3Adsp722CVT+EMDvCbBLKXwlpfR/Cpez2grcmg1ffrgrXZ3lOOMl7o6055A9VyrStuaM/2D44m4JCxmm+4IboxgscZoJlksGTeh7X32/zQcHNzSKMERztqKRQ0u8bS4e/U50EnEKwJBsHoJ/Ys9HnW3iRQmlVgSulcbGWjVRlzK/MnPp1zKvOL+jt6m+RkbHeEVQDCduxQOAYu8T8i365DcfiK2dHPWzP8C5aFRz0zpbSoCS6raQs19hpDtYDuCWP05EmsDpIPYs4eAcbwGVWm547Zuqq0cUyQc1TMhxn+oI7iHHwG9NHj0IPihw5kP6AYZLPWlYu1V7+2LxNr78v1jklDv5nswyQbS0O3yLYc5Q3l1SeMujdH42BBqWzCO4CkczZL0za1oA9x4oPzfnzA4fDl/nEqOD9ND0EcpydHsJfun4A4EnsAJy+O1qg0yoY94FBaFJz9It2fUwzFCar45ajM8bjGUGBpD88G2TAL6CPSEbFJNQcmLDnoPDKnDsTxePLyIE/HfDxJD/n+QXpycHqQvjjcgwNxmvPxwckaTj1MC51bLvmM/QymkKphE/KlmBOLrsPtlc04FH1qUNb7003cY33dzuparbUlrMEb7e70btHlUiTN4VKtrQ/tNXvwaQ17D06MDFOwI/YF4DuGmpSb0dW7fwFfhjoGTRrd+8hHpTjQOm2vOwb1rlfA37utmC4tdu/fqv05OgrNndr/tx7D3Sj5rWM37pvQX8SA3I2SXxsLct+c/zYlf5uSHzAl8fb74PIjuco2RGLbhw3auO5XdR4uXlFouuQun4EvcYvhXbx0OfIVEv7uqC9LbF6WiMmyeKUqr40hfY6XNdl7NwNzLS0sI0GwqN1X9VXZXFdwxi6bIDiSP7s20sFlgumycKz2ixDeEWif5cBLR4qUH0l0G8X3F9Q672r07ootMA3P8nTDP1xJCyOQCgmD/ndKT0Okrz6cp//VJCdo9BlwQRq3HX/CCwvDUd7gTEqpws1h1BkpKnLBXn04jwkKxq3VuaQqFQp20M1fbICXnenar0JLKdtazJFv07lH/8yyi1Iqqm/o0N7y0jmvZBp6SjX990Aw7Xx+jjDwBjMahlXcxmKEusS7bgd7B0fp3st0/wivqwqY8LpwKI/t97u78PoEWPezFhQfGS7rA98OWHIxvn+D8f/mQx+P/qYJe2zxL/07It1ryT1z3vIizuZ/6TWRqCFvUlsB/w7czlPsneorMEYKUiY0t/jeDtw4UJZCUahwvL5f+cbQKKLtvjWEOiP2WzVs07E3PG79kIXxrxGRBnSz5CzZvdrfbQp2d29bDXi327xMROVhQVPWBlkSpZ1X0gt7KqDU4aGVoW4qddLnlKeX+hwT/owzW0F4Kc0PhvJJq2hW+DPO2UJeG4qFXtxGX/VVjn7zqxpnf/Gt2+ojirffNkvaNmKCEKNSwn+PgRtS0sO3AohEStdaGa/dDGOZsWZjlHwkmfmRETyFFQPcjRJUW7+1Cq8jCj0JaMS+KwOthg1C0Bq4WLwVzyKkBNAY4OaLGfqu5h0laJ3s+8lHMFcyh84yt4aCHnTYpYa7AmeE+jOlf2Om3YauC5eQoch1SQUIURm9DQLDYs0r2imh87qMb1n9W3gmhvuEQpjymzgq+w2f8ghR4zj/BtM/2m1Jb01p60quOnReD3Ra48oE0z+Ywm1rdf5aLlbYzA5u3G5VcEm7nqT8Niifi+SKUnnNy2mj5KzngvHm2agZKq2zi+T2Fv2az6a4u8PPf9SAbvLFN9R7hipsSdaFpJPxCn+py/KffgvG5Tlb5autmEq8HE8totZNwk39rivp79t4V247cH9xv24pWz37ljvFDZdbU/jaMyv91DObi+5b2wNVbuXWtu2ayw/vP35KRsk4uIylJuNu+DW65fzar3nMMqFPid9uk4Krae3PZ54m/vkf3EzgQQ== +sidebar_class_name: "post 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"; + + + + + + + + + + +Creates a new admin for a company. +If the email matches an existing user, this will create an admin account for the current user. Otherwise, this will create a new user. + +scope: `company_admin:write` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/post-v-1-companies-company-id-bank-accounts.ParamsDetails.json b/docs/api/post-v-1-companies-company-id-bank-accounts.ParamsDetails.json new file mode 100644 index 000000000..f6a212df9 --- /dev/null +++ b/docs/api/post-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/post-v-1-companies-company-id-bank-accounts.RequestSchema.json b/docs/api/post-v-1-companies-company-id-bank-accounts.RequestSchema.json new file mode 100644 index 000000000..c11609891 --- /dev/null +++ b/docs/api/post-v-1-companies-company-id-bank-accounts.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"routing_number":{"type":"string","description":"The bank routing number"},"account_number":{"type":"string","description":"The bank account number"},"account_type":{"type":"string","description":"The bank account type","enum":["Checking","Savings"]}},"required":["routing_number","account_number","account_type"],"title":"Company-Bank-Account-Request"}}},"required":true}} \ No newline at end of file diff --git a/docs/api/post-v-1-companies-company-id-bank-accounts.StatusCodes.json b/docs/api/post-v-1-companies-company-id-bank-accounts.StatusCodes.json new file mode 100644 index 000000000..659eec497 --- /dev/null +++ b/docs/api/post-v-1-companies-company-id-bank-accounts.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Bank account unchanged","content":{"application/json":{"schema":{"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"}}}},"201":{"description":"created","content":{"application/json":{"schema":{"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"}}}},"422":{"description":"Invalid Attribute","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/post-v-1-companies-company-id-bank-accounts.api.mdx b/docs/api/post-v-1-companies-company-id-bank-accounts.api.mdx new file mode 100644 index 000000000..e6cdfb784 --- /dev/null +++ b/docs/api/post-v-1-companies-company-id-bank-accounts.api.mdx @@ -0,0 +1,81 @@ +--- +id: post-v-1-companies-company-id-bank-accounts +title: "Create a company bank account" +description: "This endpoint creates a new company bank account." +sidebar_label: "Create a company bank account" +hide_title: true +hide_table_of_contents: true +api: eJztXNtyGzlzfhVkcqF1FUcHWpZkXWzF60N+X3jtsr3x/mW7xuBMk8R6BpgFMJK4Kr5IbnKZ18sjpLoBzIlDipSlSv5EF1tecYDGh0af0A3gOlIlaG6Fkq+z6DwqlbHxxVGcqqLkUoDx/7dIRBZPuPwe8zRVlbQmGkUZmFSLEjtH59HHuTAMZFYqIS1LNXALhnEm4ZJ5IgwpME9h/4v8In8rlWQTEHLme2QjZi8VuwAtpiIlYCyDUhlhDeMaGK+sKrgVKc/zBTMgLbOK2Tl0iI8Yl9nKr3umQzgxltvKMGHYHr/kwgo5S8Jge4Tv0xwkkelgMFWagjHTCiFYzaWZgtaEfQ6DQ6RzLmdgEOqeBp4tkqnSSbvl3ohxyy7nIp0zx8Ka1qLFVo7sYpWBDGn5z/157n+Rz6YWdAtoB9VoF8643yFzDPkif/6v//j3/2SfuJZCzr7In7/In9nrKeMsgymvctuhy+BKGGtGTFh2KfIcwWfC8EkOWb1EKCGdTtRSQ5nzFLAnN9TOS9GeqYeaVjJD2SnAzlVGAE2qSjhn34LcIuEkCO35pRYWvkWjyPKZic4/R7/guM+CTH8dRVfxrDJWxUJamDnNiO2iBGwMxQSyDDJsV3LNC7Cgkcx1JHkB0Xn0e/yv1PvZu9fxv4E2qBqjSKB+zIFnoKNRZNI5FDw6v44c3chYLeQsGkUgqwLHGR+On8SHJ/HRExzJTzY6b/++7KvfC8RSCAmOVxm3EE84ysmzd69xcREL48aoVKCesUth52yhKk0NUJ32cR2lkoDrXmp1ITKUaWrDyzIPkmrY50JIUVRFm/bXn+bWlub84CBTqdknLu6nqjgIXItLvtAqz+n7AS9F7HsKOftnTzBu/fwIYaCk70fLUc3hxh4FxpbczgesEbDffnv9gqlpW3aiUaThz0poyKJzqytYvxzL5ddRZCCttLALWuPnjsYz0qlnlZ1H55+/Llsyo80lnwW6GkyppAGDpMeHh/hPF+MvbZmvpLMROK1USQvSYo8W3w/+MNjtuoV4dc5DlhbF3U1NTf6AFP++iuGKF2Xu0Hkz4bUef6kqge7gaHzyGDg8iY+Pj47i47PsaTzJTrL46Ayyp48Pz8Zw8oTwujXxvWCcHqeHKcTjp2cn8fHZ5Gl8dpJOY0jHp9MTyJ7yxyfRKPLoEo/t+RzS704PtKrIFsuqmICOzqOzJ0eHp4fHj59Go2gusgxkUOmmze+///778eHZaTSKBkxZdB4FQ9Zv4McnQxHMfDQK8vayKHO1AM1eeVvjjUW0XCIbgx3xssFW7Emp0cNaAS2+rmp+dyHbgttZyGWf17tQCiqw7LP+JiIdOaWmjalqrdoHfiHkzERfl6sreNMQH1f9kSfBPInl2pW/ifYbbr5D1vUwDdFBWVlvmlfiBLIoQw69FjPnL1bn24lxvMMdWHTyagPxCSuAS7PSHI3mH5UJEZjzsoWSsMAvLtRqhSz7X+S6gKQ1QCFSreJODITSlINtufHOfEqt0KT4gGUmJJssWGVo9NW4BlHUccaGiYU2+ysrt06Sw7r1tbvMOXkQ+jeBKwta8nyLhcIB1i9TZ5hNM0mVlJAi+ybIBguIt5Z5ZKlv3KiAoZ8d5xwftapm897iICtpUtuNHoi8wy7EVseRRhO4XLydkv9bx9uaGqqeMM2fX9Fv+16yyvNoOchfGjtgukEZ2FuZL1w0AoZdYni+ujzCtOaTc2OTlKdzyJIJz7lMW4LyuZkNARzEhxTYFGw6Z54Amyo9gO1dDtwAxrj8EnXEzjmG8cIwXhDrMwWGSWWZhmkOqYvxC2Usq8rYqhijtnoMXG21MtsVTVudsSeQEGTIEqS645TredKsCVY/dLSeMz3e3mKFnKe9yYz/ygtSvK5DXLYDus/Ov34dRVbYnIIK5/NidGFx47mx2/jwaDWE8kbzIQZ7iMEeYrCHGOwhBnuIwR5isIcY7CEGu58Y7PjweDWE+lVZ9kpV8geisJoE+yIZ+yKRnQgRDLJOg1GVTqERBcpS77M3/Dsm90lqoM6AstcvDsiHo/HjOTJsNZhrMwC0Vnog8PC/N1zmWnNMSQoLRfv39VST74AdUm5hpvRizRjU6sbF/FBCipacBMTPmbozlaaVNvvs46L0dRZSoO/ovzKQ1vXC9txaLSaVhYM6H8405CShvixDJEnGatQ7QEMKwdw7SoxCbE8qLJLxyGdaVSVGQKS5vWrJpBJ5xlJM1Ra+/ZzLLEdDLqTLc7fS/oS5AGP4bAvVeBeAZGC5yA3jE1XZFlNjNgMJumGnJx1QmkpPeeqQcoluGYEj55yudLcLUtlkSkrSEqzPnfWPvMS35eW81bE1uWiNglxypx/UYT9afkUgQa9/VTYmJYtf4qDxWye1XrPH41W1fC1Jf9izIDW31/DfpI9usJTEXkor7CLoOvKWL9iclyXIxmJPVLZAMaJ19pNFj2e5kF5+DFbM5lhv+iYc1qSW8OSC5xV8GzHvdgKFKa12VoFfuLpnXVn9ts8+gNOvzy/dMM/dgggwO5ZNCGac1t0fsVklMucMC6UhiN/+F/lgpf5fWCks2tUDCcO+SVLixK3jN1frdWvlCqte5Kk0T+r+zTdlfpEWLrgAUiqvGP9rjCGisDzjlg+JYhfG86DcGnK44Bj8ccuRpheQhddkb+6EZKTTGCKR2fAWaZLDPnulNPMWeNQhQfiIVd/cv7QR+kZrG37BmOhbXQEPkQUGEkpCN7RfM5eiyq0oc3BjoR71FC/8vKps4csOKt0dG7eMYWTsxrNM4Ceev2uN5MqeA2MvtsxxhOiSxMRx1EfvQWxSpV1ZNcOjFCQNLQZvkYqR4s8KGvOg602EI+P2tGS9p1oVGwL2ul1VJlZtbtixc0MNcK+1aXfQ9rpvvPTHn4Sdx28lxM75Rcv1rd542XFNcWlam8KHNf8HXnOktNZhd/nwCY0P7WVpt8PERrexz15TlqJUxggMsaxic34BrLZDOVxATgkC70aCo6jNSpQKnVY51z85uJ048VHUnuFAg2gg6m0f5kkywNxXUkk8BQRZUvJFAZjxXR8R44GYbji8Eqx1wmKfb35Dx4vYnBsWRmP1aLQGHWAuPZQISaKb2ibndXfI/o5hQCellHKJofoEmgxdSIakmCB2QQpGrB6OT4iY/fVT4LnLS9ZJ1PucALLXD8gmUKcsIBsCWAiDFirx2bpNu6BuGnwQYi/I7wB938mBo04Et+txeUlIUiWnYmZqaHWsuRPXVnu3wTyzDJfUMjyl1QSzBSabW4HFMLAw2ylmjMLHXBTCbkA40HhnFr5CxJ4GIxrMzFWVZ5SmqwsBHnNSghYqa/CCbPJna1DWTQaxDfPypcxcVq3RHNpB2TmX7DHm6+3cYEw4rWylweGrj5/JrDJWLxIDucuYJpKL1CSpyiBpArO1iJvWu/PzV+zLsO+AOG6H0A9z/wCDaMKfFc/Ri5ywTMxEbXY2wDUBgNkCrhGpa7s72g8iJaxmFeyxB+uwWlFAoqbTpFS5SBcJJk23W+viVkwshta3D6KSpFGQ1frC01RXPE/0Zp3pNNvBcj9z/Rj2qzk2ydGUY2RV42EEUIBZA7wEcq6JT6Rs8o69rrugfe6UOwOeWnGBkB0Nt8f1GBgOwNR0GrI66zCDq0SD2WbZ68a7r/3L0JXqfFtLQKg6VOUN9nK9t96E6jmXlA7kGVU3/Whm87LPVS4ytOr4nwMcwgp3OPwOg4pwAiCEERRSMI8APZBf/PXQMD16b7DqegNF0kPARqz0IRtVjtHNr4Vau8dazO5FFEPSNpBguO0yrRwG4VNyorjGMDy0u0v+BR3GgJ/VQ9WQHISVydwhgo+Ue8QiovTbUiE7WWBMLvc8mgsrEpCYP8IgzGqeWqUT3IRtwNZvubua1gTcfq+JbxyWjBSWpJwu3oS7Pj389xnH9uY44OaM5Zrido43WWivv00UsNprd/69q+PqvQF6e40aN6kJylMyrygXIK2fRUgtbou/0/6HkHco3Yg5tG62NFhySGZaGYPpjjC4BNoMbIp1fIvdwx2gPUIdUYR9QQ8SRS24InNV6W0Cw9u5ur8h9ZbmSJhxKy76DPI6nqIfzO/Q3rxz9FsA3BC1eky1+gtk4nHcqaXDrI8ffmVL7otumFt4bY1LpzcYXdiRYYWM5xb0GrSJp7J53/5DwOtjVjXgUGrpQQ2HQzCm8mArWahMTAWZ7QA5ZDPvEmyoGJUri+0AOE52WO4MpQF94a24WRgLRd0o2PB+bEBWwOD5soJv2u132/+IAepSarRaMkpPepwFv8JrX32cptIlxznfI9SXVykARhEeA67E0eEhcTVX6ntVbuLlPQILAVfYA9A9tp/Mo/2oW/tq6jqfe0n3evsQ9XLlYfwY/4yPxo+ppN82aJNcpd9B186fkm5CTtVOwt+jNhgMk0T4QLh7Nk4ypTPQ6J90JYN69Kfvxl7FuXk+9eIYsFV5P5PiWROamttNpwdz85ymkGEpNbH86j6nFU6bMj8es/yK0Xi3m+Mq7C1EsXO6966n2RHDYLFCFvoH5LIDeniSpjKYi9gxxb7NpAQeavHE207wxik0kBxkU01oVkquLE2ds9sUmq90v02qribCAhFWD97sIaJ1gBuv/KNoO+WyHv/CaN4aUwqdp/PEzjWYucrxsLNzPlGrftdHQNOCGuvuvAp8QRGgtM0FFzn3xTyM+PMLYJSbf/b8b+xjAMeCZ2zVj5QylIxAJ/lJaGCv5Yi9URfAPio8aanZC07lyLbD9Pe4bxU21duXi/oWfad25N6CsBaKkjaxVvmQjvHmPIc7684lU5WN1dQd7fUEwzZTzCS3SmNqj4t8u7QeF/ltUnpc5O2Nbh9A2HeH7Nicm6T+evfZFFfNrQseuLj1aIyOB3lAtRhoKHDFqXQekgdNlwlMkRieE0Cm06sOSoaguhBXeApamEmlDVAxqalbr5lYu/UO2tfKLYS61WD0s0H31pHY4iTlixbo3tnJ0T1PLzvMpnw8Hsc8OzyLj4GfxvzwhMenR6cnZ2fp48nR6dMNkw7U3GMat4n9XYHP9a/9p7Ma5+yFwFo4e+GKzyNGt5bc0w5DKPzlh1ujaF4wwUVwETWG9mUX5Z6Ptl2Jf28/2LD/qfO1o2gqpDDzxGc50bviQQIXet1DTlqEyxC4x7cKNduyZvBeTjBX/q4Pkb4pCjNWA9jkaPdVfIPCI2SaVxladEcIbYsGY1ZkJnVHlH5sDCLSp+xO6ezuerEbstZniS+1kjPmd9/9Mf4S5S3E3JlkurVUZ/H+EqUruv4E+7N9djR+fPzk0YCKzZWEW5+HeIe9w2mIoORHh51CKZ44yEW6KdMwqDxZ5U6Aw7rSY0t1/P0X0zre2ySrXAmnt4HfJpE9CGvzOYKP7bsizZkMWn23Lng220XKQcdzddk63kBnuTYdbmj29rfOJuCQ4TRfXyDaOYK7GaCepPdkLoY1N/t833B7d0ij+EA7WClUNLPB0+F36nOrHQjdqsoYfWJ7vs9ec5NAKlbiU0zWhlYmeJUJNyK95905p2N+wX6HaJOCjN22sBIgMy0/5LeBA/FH4NulPxy+Znb0eWeGf8Jj4cHOzKgsqn3IqpuDGoe1o1pBd485eook1ifJezlnhwBz+IxOpqeWmaoslbYso+AoX/Qr/N4chTm4Cuid56F7hx9akN2AWa+atem4mNDGJrc78PIK+zLZO/ayYq0y8g/TZCI0Pfy14ygvqK4+ZdS93hp7D0rHJlwASDZnuzJtfRb0NkG8D95PxxyOT45O44zzp/ExZKfx2RM4pGcenmSHAGePn2wwaVQNu8WmNM85eyXsXzNMxWV04hcvAk9xu8ZQYUmG571qmAGMEWmLWJeaPRMGNjp3zKlxdjqZnozTeMIn0/iYH43js/HTcfz4+BDG2dOUT8ZnGzh1Oyv02nDB5+wX0LmQNZuQL3jRVnpebc2hEFODNC6ervMem8/trD+rtfEIq49G25LePnQ5iKTeXMqN50M7zW69W8PevR0jwxLsiH0C+I6pJmnndPXu78CHUIekSW1773irFAbaZO1Vy6F2r0p2bivGaw67h3vUYOwvKlsE4d/qcmT/Lkf3RsatXwJZff9j14c/+o+KDJDa7qLICqFtHkHp3UxfOQrem00P0w132OP3fq+w7I6Dd2Lo5oIpgX8HbhYxXfjz79vUD9N0m6Dbi9UFaC0yqF8iwgleWZCGgmIUZCfCa18ppSsqVe+1UjTI3X7upcq6sYPcNOojrxt2ZzDcpTuTpqufEb4/4VNM7r1hFFd8wvM8Org4OqhPIx1cN099Lg86z7jiI6pYAve6XekcPaC/RstL4W7RxhkUdJV2RZZeQKF67Hf0YpdHw884tzWEB2m+05QzW0ezxM/tF0U/oO469Rx4V7TWBhw8vBlL/AeuSVL7Nx2dfNKlHHwjeY47sVBxGkUf6JjAj4zgKKwZYDmK0Ca9b6zXS3drZ8j6NBq+8n7Uypf+u1S0m3fF6KCa9OAuPkTrHvtxFYf2U7mjCF/GNW+nH0BfiBRaS9rctqYLqgfU8CDDOaL9jOlvrBwY33XlUhXkqSqooEI49gx76dWOhTM8+EZuptIKHR3x65/8tXfuEiT+kasXYVT2Hq8m+12wKzagTPqv/9KIILIdFajgskXnuTs5ytc9Q9aZQMvFPDzg/fCA9z/SA97OMli4sgf4XBKZOTLY196dfI4ujuqH8dyF6fPO69Fdn/IVD1kbi/2urzFE/E3nyyX+/GcFGCV+/oq+TNO5MPI7gQ/R+ZTnBjao1k/vfXTwiK1/mHpwRuFKJ7UInjTy90vbj2G7U+LujfHdwP2ffjl8DVsd+4Zfa6+53IQ3zx2z4o+dEGs1Jm96oKst7ca27Tjo3dsPH1EifdxfKIoBNb/EW/780q15yI2iT8XfrqOcy1nlNimOJroE3vXvtT/3/9N6aqArVdfXrsVH9R3kclkLmcW/aUOz/G9pp1uc +sidebar_class_name: "post 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 creates a new company bank account. + +Upon being created, two verification deposits are automatically sent to the bank account, and the bank account's verification_status is 'awaiting_deposits'. + +When the deposits are successfully transferred, the verification_status changes to 'ready_for_verification', at which point the verify endpoint can be used to verify the bank account. +After successful verification, the bank account's verification_status is 'verified'. + + +>🚧 Warning +> +> If a default bank account exists, it will be disabled and the new bank account will replace it as the company's default funding method. + +scope: `company_bank_accounts:write` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/post-v-1-companies-company-id-company-benefits.ParamsDetails.json b/docs/api/post-v-1-companies-company-id-company-benefits.ParamsDetails.json new file mode 100644 index 000000000..02a817035 --- /dev/null +++ b/docs/api/post-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"},{"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/post-v-1-companies-company-id-company-benefits.RequestSchema.json b/docs/api/post-v-1-companies-company-id-company-benefits.RequestSchema.json new file mode 100644 index 000000000..384558dd0 --- /dev/null +++ b/docs/api/post-v-1-companies-company-id-company-benefits.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"required":true,"content":{"application/json":{"schema":{"description":"","type":"object","properties":{"benefit_type":{"type":"integer","description":"The ID of the benefit to which the company benefit belongs."},"active":{"type":"boolean","default":true,"description":"Whether this benefit is active for employee participation."},"description":{"type":"string","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”."},"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":["description"]}}}}} \ No newline at end of file diff --git a/docs/api/post-v-1-companies-company-id-company-benefits.StatusCodes.json b/docs/api/post-v-1-companies-company-id-company-benefits.StatusCodes.json new file mode 100644 index 000000000..51ad1baac --- /dev/null +++ b/docs/api/post-v-1-companies-company-id-company-benefits.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"201":{"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."},"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":"881ce3f2-e3e1-49c9-8ad4-0bcf515f5618","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"}}}}}},"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/post-v-1-companies-company-id-company-benefits.api.mdx b/docs/api/post-v-1-companies-company-id-company-benefits.api.mdx new file mode 100644 index 000000000..ae35a161c --- /dev/null +++ b/docs/api/post-v-1-companies-company-id-company-benefits.api.mdx @@ -0,0 +1,75 @@ +--- +id: post-v-1-companies-company-id-company-benefits +title: "Create 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: "Create a company benefit" +hide_title: true +hide_table_of_contents: true +api: eJztXOtuHLlyfhWm88M2MK3LSLIk/4ote3OExGvBlzgb22hzumtmuOom2yRb8qwgYB8k5+X2SYIqkn2bnpFGlhLkwAYWa0/z8rFYrBuLdRV9j2eVsSoW0sJMcyuUjO2ihOjZpwiKCWQZZNEo4mXZbmKiL6PI8pnBZieqKLlcsBcgYSosfdNgSiUNmOjZVTTe2cX/ZWBSLUrsHz2LXn3nRZkDCy2jUZQqaUFabMvLMhcpzbX9u8EOV5FJ51Dw5ZHez3GUUoMBaakLU1PGWepxTRyurWgUuZVFavI7pDYaRd9jcDAIp4eEf60qkUXPooN92DtMx4fx/h48jfc5HMT8YDKOYXx8dHzAd/f2Jgj8ArRxWI6Pftd746Pj+d74+Giuj/fGx7PpMczMud075zMt9sbfvs3EN9g7OhxHo8hjSxyw3VHEUysuIHpmdQWj3kL/jQsDmp2BLrgEaXFqoyqd4prguwUteR6NopJrK0Enkhf45T9/+y92onQZ4Xg5WD7J6wlMVZZKW5OUoFMk3wwSXqhKWhOa+A0SkxySqdIJFGWuFqATy78j3aY8N6ubQXI5rtuk3KbzpCr9ciPIwS33+noUlVqVoK1we1GT9CpsmrFayFnUJwruflppDdIy3wm3386BuW3eYu8A6N+f/HchZ2xWiQy+PJ5bW5pn29uZSs0WnYStVBXbgfPjki+0ynP6vi0yKEplQaaLJ2yqNBNyqnThWU6yubpkVrHK4HTCsKmAPNuKrkcRSBylAGmTFInbWhadKtCD65JVMQGNywnUNMwNBRkTkhblOWjElMwXTIOttISMXc5Bsv607FsFesFKrnnBhGEGLALGfcbToYFnb2S+cDt/jQeSTlDiTsNtduLDh9OXgfy+9+DIPzRi+0Qvjdw9UbciMzYJU/juSJbLuUjnQ/OyCeRKzszg/OEA1zNPlMqBS5p5yqvcDh/uj3Owc9COc8JEwjA3HrFbYALcQCtSURLnbbGTLjzDCr5w7DABlgGNwC2yzJRJ1eIlrsGPny/ag8oZcW0H4PJeFUL+O8iZnZPgWiZr65dVG8h+wWU5sTtqiWxawHQKmhVVbgXqiXpxl8LOGZfMscUue4ykeQ2ZSHnOTqWpNJcpPNlifQyXqsozZvCUGlWAnaMcKJQGZkpIxVSkLBfnwP7687+XJO1ff/6dKY2fXuQVsBOtjNlm9Pd3czzmf/35d6JZkMfL5AJZFagukRO9oF6W2ZCh9lympRt2JRnfI9OkXOKGf65n+ByN2Od6EvyX0uxzM9XnaIB3Ug3EKxeC01zPz06ZZ1w8FO3xttgJaMuFZH5Ih8GN0AcZNq61lC6UocPU1WSBpp8aosoqz4cp5rsy7BroFn6zc27rhd7Ml59rFboCZkutDh77lee8L1j8FtJ4kG2xl2FgdinyHD+1RDYe57bImnPDpELpBBKVEKkIr8BG/msjQ+pt4caoVCApRozLrDOkcCOqS1QpkwX7V9SQyEWcnTlaEs+vMyJuTZAaWQZZlZKVSXgCjdA61GJSuS+eUkgOblgzscG99osmocklEzITFyKreF5P4o+MMCwDC7oQfoG2pQ4CERCEJ0Sq5FTMKk1b4puvU3M32U4bcAsE7Jo0d0W2DbJCyRfNJxrXKX8uG5IKg/ZJDvwCthgiZN7AxnUgO82Fzuh4LJgR6TkNGjiE5Npa8+4+ljEVObCP8Rg3rTBh6+oV/CD8nuW5kSQJ/EBjxFXZ4UQC2tbZI+RHDd8qoR1LvQNiZvZ0Zy/IoXevTj68fcXGWzvsORqoA0sqNcSWf2f7O7uPz58QD+7v7D2ePGmtq9EptSGN+KFALXJNm+ZgYBOyuNBrExblVPDaYu+1kZU67Atd8LxqO0XZOIX0cP9pnHKAeP/pPo8nKZ/GOzvZ8d70cGf/OD3+Iaeoa3ZGR0e7KexNxzHswW6Mo8dHPNuPdybp9GD3YHrwdPfopyvVuFL4ZxTt7+wvu8q/Kst+UZXM2GfJ2GfpXOdvFRjUhBq8bs4UOHkH34WxW+w1PwdmKu3cqFKrC5FB5kxzYdgFz0W29VkiD+2Px8vTfpClVikYQ9z9SlphFzUC4ezVOS9LkE50kQpSGdqAbKEqHTDSyeNCGgZaK43yI53jefsqJIFIuHUnExLi2q9k8thmlWzKRW5YVtEh47Lpic4n2dNfWw7jKzfNCbcwU1qA2dBjJJhxWnd/4vxOEhpkeWZgERAS787xjyHq/iRun7j90E9bNroFo3TsBiH8741+41rzRTSKhIWi/fvqUZNzwA4e5WLFHNTqRnf4nXNTnIL3h5G6M5WmlTZb7P2iRDcoXziVdA4LJjKQ1vXC9vUeblMUAI0fpiF3lrBqhgxa06HeAFrbgnIjkSMWhgrSw3MZm2lVlULOvK3nrDoyXq1ik0rkGUuRDwrffs5llqPjJqTj3lZUcoudTpuJhGFfJQm2xO3j11ErKuQMas/yjDPXkn31TZnfpIXzWsCJLPeRSFPgeZsNOnpdypyF9XpuZHyiKtvau5jNQIJuds0PXZu4lZ7y1BEELSKZIX20R2F5xi0fYsUujJNwuDXkcMGlZdgPx/QMsvAn2asAIRmdaXKcyZyszZOed9QegvARqb66/5N6+kp7G35Brf619meCMkFrRkl4M42efbppLXVMgEbEc9Q7eOHn5cMWvmxwpLtzGyFnYWbsxrNM4Ceen7Vmcup+YO5FPy61gmt+bXmtnqLktDZskyrt7ITMMKt8lLEm8M0zfJDiG/qQQTxob8mG+WhEJ72nWhVrbOa6HVojan3DjpwbamAst+sMdDRtggn72nN//FHYefxGQuyUX3S9utVrzzuuKW7N9ejnnv8j7DmOtFJh99xRFD4UICUDFwMpa9TGFjulSEipDNnkKPHm/AKa2GQOF5BT5MGrkaAoarESpUKnVc71Ywc3JuMnfkMM9yRqr3CggWPo7mXVhMvzhKcU109cwCip5LSSGWRJyRcY9e8YMZ86tkY04e7OrVbx0ZKxFrXUXPRLJTMhZ6/BzlVG0aQwG6tnoz3oALsALaaLREhi3RSRlsqIe0X2G5oBOCvzs6LmdIEwRvMLDKWd5cANsHQO6bkzUtBi9XCYd9S2Vi+B5xjdWSRhxAddAJLXT+jCefU6BgAWwqCESrSqMHS/Bphvkbh7pWGIPSO/A/St6x/upUQT6PC4PCckLk5mami1rbkR1ZZ7t8E8txgRMpYpCawxZovK2LZhMQwsrHbKjQ2nJclFIewahAONNybhL4jYj8FoDLyRwIuJCaAZ6nYmYMZYglBZgxdklmReWq5AWTcZxDZMy1cyQ3sQWieHPCg755LtsUJJOzdoE04rW2lw+EKYRsisMlYvEuOCEEomkovUJKnKIGkMs5WIm9ab0/NX7Muw7wA73g6hn+bhAQbWhG8YiraKPWWZmIla7KyBawIAcwu4RqSu7eZo34mUsJplsPserMNqRQGJmk6TUuUiXVCA7HZ7XdyJiMXQ/vZBVJJOFGT1eeFpqiueJ3r9mek020ByP3f9GParKTbJUZSjZVXjYQRQgFkBvARSrokPpKzTjr2um6A9cYe7uRF2sLyP6zEwnAAvX0NUZxXm+hr5NtteN9587191rqtvzQETnuM9cFKVN8jL1dp6HaoTLilCyrPfadvdbGb9ts9VLjKU6vifAxzMCjJE79MqChe7wYwgk4J5BHRB4hCshiaVfThYdYiZLOkhYCNWepPN3ScrCSuh1uqxZrMHYcVT16a5lUK3y7RiGIRPyYniGs3w0O4+6RfOMBr8rJ6qhuQgLC3mHhG8p9gjZqZI75b6TKQQBcbgck+jObMiAYnxo4Tuz3hqlU4U3ZauxNZvufkxrQdw/l5j3zgsmUusQS5H2efwNgc24H9IO7a3xgE1Zyym5shZwqcWNPn6t7EClnttTr+z2q5+NDDeo+YYN6EJilMyf1AuQFq/ihBavC3+TvsfQt4Z6UbMoXXj0uCVQzLDlB8Md4TJJZAzsM7W8S02N3eAfITaogh+QQ8SWS24I3NV6dsYhndTdX/D0VsnR8KM41VjD40/4ynqwfwe5c2ZT+ZoALgp6uMx1eoPkInHca+SDqM+fvoll9xfumFs4dQaF05vMDqzI6NcmdyCXoE28aOs99t/CDilJqBwqwGHq5YeVAo1CkMGoAdbyUJlYipIbAfIIZp5n2DDjVG5tNkOgKNkh+ROUBrQF16Km4WxUNSNggzv2wYkBUziMndvYSe49j8igLojNadaMgpPepwF/y6KqujjNJUuOa75AaG++p4CoBXhMVBi5c4OUTVX6rwq19HyAYEFgyv4AJRy8Ng82Yq6d1/Nvc6nXtC9dh+iXqw8zB/jP+Pd8R6usCPQJrlKz0HXyp+CbpjyvRHz90YbNIaJI7wh3IkDCsmUzjBxSjFd1dl8/eW7uZdxrl9PvTkGbFU+zKJ4lrXyje+0nB7M9WuaQoZXqZhQ85DLQruQDHA/H+bdMZrvbmtchn0LVnQxYZckcu/L7LBhkFghCv0DfNkBPbxIUxmMRWwYYr/Noijj0A/eVoI3LqGB5CCbakKrUnJpa+qY3TrTfKn7XUJ19SAsDMLqyRsfIloFuNHKP4q2c13Wo1+YzUtjCqHzdJ7YuQYzV3mWgFc+Uev+ro+AlgU11s1pFegSEnn5BRd5yLVEiz+/AEax+ecnf2PvAzgWNGPr/kgpQ8EIVJIfhQZ2KkfstboA9l5hcp1mLzldR7YVZus508ZmU+2+hEF6d0fuGYe1UJTkxOITJDLpGG/yOSpkTjQ5VGVjNY3pux8wuJliJrlVGkN7XOS3C+txkd8lpMdF3nZ0+wCC3x2iY3Nukvrr/UdT3G1ufeGBm1vPxig9KCR5BzbQUOCO09V5CB40XSYwxcEwTwCJziRc4qDB0BPfIUsyYSaVNkCXSc299YqFtVtvcPpasYVwbzVo/aw5e6uG6GJQNpliXmmHui9boOnUURNHhQdeXraTTfl4PI55tnMU7wM/jPnOUx4f7h4+PTpK9ya7h8drFh1GK+i2+y62v7vgc/1r/emkxjP2UuBdOHvpLp9H7AQvpbeiPlUCCsyPqO7kgTgUrn8Qfc6iRtO+7KJ85K1td8X/aCvIsGZz1wVrKPZ3G65YkXN86V+vtHgkmgopzDzxUU7UrphI4EyvB4hJewI5H98qPNmWNZP3YoK5clZMQkPfZIUZqwFssrv5Lr5G5hEyzasMJbobCGWLBmOWeCZ1KUo/NgcN0h/ZZelsrnqxG5LWR4kvtZIz5r3v/hx/iPIObO5EMmbx6zqK94co3aXrY9iabbHd8d7+wZOBIzZXEu6cD3GGvUM2RDjkuzudi1LMOMhFui7SMHh4ssplgMOqq8fW0cHrOzsH00rvbYJV7gqn58DfJpA9CGt9HsH79vOAJieDdt/tC+ZmO0s5nPFcXbbSGyiXa11yQ+Pb3zmagFOGbL4+Q7RjBPczQb1Ir8mcDWtu1vm+4e3VIc3iDe0gpeg11RpNh9+pz508EMwJxrei+Ik98n0eNS8JpMKneYWwNrQyQatMuBHpA3vnnNL8gvwO1iYZGZu5sBIgMy095N3AAfsj0O3SJ4evWB193pjgHzEtPMiZGV2Lam+y6iZRY6dWVEvoHjBGT5bE6iB5L+bsEGAMn1FmemqZfz/FMjKO8kX/ht+Lo7AGdwN673HoXvJDC3J4lNu9zVqXLia0scndEl5+wb7u7XLHTerbzaQfpslEaDvffJaXdK8+ZdS9do29BqW0CWcAksy53TVtnQt6FyPeG++HYw77T3cP44zz43gfssP46AB24t0jyA6yHYCjvYM1Io1uw+7glOY5Z78I+8cMQ3H05LfkKMzRXWN4YImH573bMHyBrJyLWF81eyIMODr3TKlxdjiZPh2n8YRPpvE+3x3HR+Pjcby3vwPj7Djlk/HRGkrdTQqdGi74nL0AnQtZkwnpgq9YpafVrSkUbGqQxtnTddxjfd7O6lyttSms3hptc3o76XIQSe1cyrX5oZ1md/bWsHfPY2R4BTtiHwHOMdQk7Zye3v0GfAh1CJrUsveeXaUw0Tppr1oK9bqTwN95rRgPJrt3XyK/CIZC/Q75/63FcD2K3rb0xk0L+gdRINej6Ndag9y05p+q5Kcq+QFVEl6/19LrFNdWKmPji924Tu+K61TrrP5rqKsw8HSyV8imLjbXrpVi3GOtpoYR1tzAEkY+JF/fgvrSI5Yey6qZK4zBffklfCIULGEsH+FLkAQPPwwe1xWL2iXIwmOuelp6TMZtXdbms/wsf1UWfAGcpdI/ofpMUzGKMtLo/edS4ahQiIxG/RhelrcerpN+wN++9kn87FILC8/aFRsSnzL71SXSmFSVMFoaMaXoPObxragxhCSoS3ihV+t3RUPLEQ10ao1Mi6BJn62C+9WVg3AhDXcAfFWIhpnwwZckxUPStLlB8SUi6hf83Xd6/VpbqwqfkfgOpShiKsYTPz87jf+jvhii2efAM9J2zfy+akR3lpeh9I3bJpTXMSrRjIo+hWJ6TX0gx4b06hob4ENzenIt0UoRTR7syLVpkfeRYZ8KISm3pDX2hg/+eSnipoTfP/sB49bPTxAGvh5HpbyK2k3ZlPHO+CDeeRrvHrjKL748W/v36+svoxAJe6Eyik31t/WOdRsGihJ0X4/eoZRdwzKbFbL7Pylcd4sacz+ryq2rvvSzjtTPOlL/23Wk2uv6cu0fJpsS+Dlws4ipnkejE180RlW7FeqwWF2A1iIjDUrq3FdElIbC3qhgnW25skbxKLgTN9QqRrUZhupDrcdYgjzcqwu91dstAdWFvzV2didZDVgjM9q+2N2uLdDtq8ZquN4esEEpsdXbGZXOUa17XclL4VRlnEFB+nLpnLyEQvVI7saL3e04fsblrRh4cMwzTTfhq8Ys8TOu3kBaabrF+XQVbOfnKXr8zyukw6cv7VbvUDk6ETbQthYICDGodBIQwPWACgxFzehBPuOVneMtTMg2G0XvKEX4R2ZwI6yY4HoUodJ/25gLrTJqXW2+s74+WS1ObpL8awuLOanqjZSVBcPQanRJrSFG48o8Pj877ZRxa1lFowgtR/Nm+g70hUihxUSNEUeFbrap4XaG9ELbJqZ/YwaS8V2XZDzkqSpIeBGOR4a98oebhbcAVJRUpVURKn7/ky+fxd1Fq7eRX4ZZ2VssceRv01zSEp4C//VfGqanQtTK2ILL1jgnzttYKinex37VmII/vcafXmPwGv2Js/Ddbpc5FySKSPReed3wKbrYrQsfuoJGzzpe5ZKC+ILvII3FrldX6LR90Pn1Nf5MNb5RzKJu0sKVKPx0hTlW9OJt2Blss+7jt17fP2GrHNEViwpVV6hF0IyRLwHT9pPdQ07np24G7h/caR0kqyPfsMdfU7kxV04cseL3HRtp2TdteqBGLO3atm275uzNu/dYcdP7w4UiI07zS1RY/NLteUhfQIcZf7uKci5nlQv8uTHxz/8ATqGAFQ== +sidebar_class_name: "post 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 the application has the `company_benefits:write:benefit_type_limited` data scope, the application can only create 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/post-v-1-companies-company-id-contractor-payment-groups-preview.ParamsDetails.json b/docs/api/post-v-1-companies-company-id-contractor-payment-groups-preview.ParamsDetails.json new file mode 100644 index 000000000..74ca07acc --- /dev/null +++ b/docs/api/post-v-1-companies-company-id-contractor-payment-groups-preview.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"}}]} \ No newline at end of file diff --git a/docs/api/post-v-1-companies-company-id-contractor-payment-groups-preview.RequestSchema.json b/docs/api/post-v-1-companies-company-id-contractor-payment-groups-preview.RequestSchema.json new file mode 100644 index 000000000..ddc5e1069 --- /dev/null +++ b/docs/api/post-v-1-companies-company-id-contractor-payment-groups-preview.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","required":["contractor_payments"],"properties":{"contractor_payments":{"type":"array","items":{"type":"object","properties":{"contractor_uuid":{"type":"string","description":"The contractor receiving the payment"},"payment_method":{"type":"string","enum":["Direct Deposit","Check","Historical Payment"],"default":"Direct Deposit"},"wage":{"type":"string","format":"float","description":"If the contractor is on a fixed wage, this is the fixed wage payment for the contractor, regardless of hours worked","example":"5000.0"},"hours":{"type":"string","format":"float","example":"40.0","description":"If the contractor is on an hourly wage, this is the number of hours that the contractor worked for the payment"},"bonus":{"type":"string","format":"float","example":"500.0","description":"If the contractor is on an hourly wage, this is the bonus the contractor earned"},"reimbursement":{"type":"string","format":"float","example":"20.0","description":"Reimbursed wages for the contractor"}}}},"check_date":{"type":"string","format":"date","description":"Date when payments should be processed"}}}}},"required":true}} \ No newline at end of file diff --git a/docs/api/post-v-1-companies-company-id-contractor-payment-groups-preview.StatusCodes.json b/docs/api/post-v-1-companies-company-id-contractor-payment-groups-preview.StatusCodes.json new file mode 100644 index 000000000..98eb5bd1d --- /dev/null +++ b/docs/api/post-v-1-companies-company-id-contractor-payment-groups-preview.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Full contractor payment group object with null uuid","content":{"application/json":{"schema":{"description":"Preview of a contractor payment group","type":"object","properties":{"uuid":{"type":["string","null"],"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},"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":"Preview representation of a single contractor payment with nullable uuid.","type":"object","properties":{"uuid":{"type":["string","null"],"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-Preview"}}},"x-examples":{"success":{"uuid":null,"company_uuid":"450ddadf-69da-4f37-92e5-8d78b94bffec","check_date":"2025-08-21","debit_date":"2025-08-19","status":"Unfunded","creation_token":"025e79ac-824d-4d3e-b819-8f265c3edb72","partner_owned_disbursement":null,"submission_blockers":[],"credit_blockers":[],"contractor_payments":[{"uuid":null,"contractor_uuid":"e894e72b-0aef-4856-9082-9c7826db998d","bonus":"0.0","hours":"0.0","hourly_rate":"0.0","may_cancel":true,"payment_method":"Direct Deposit","reimbursement":"750.0","status":"Unfunded","wage":"10000.0","wage_type":"Fixed","wage_total":"10000.0"}],"totals":{"amount":"10750.00","debit_amount":"10750.00","wage_amount":"10000.00","reimbursement_amount":"750.00","check_amount":"0.00"}},"With submission blockers":{"uuid":null,"company_uuid":"450ddadf-69da-4f37-92e5-8d78b94bffec","check_date":"2025-08-21","debit_date":"2025-08-19","status":"Unfunded","creation_token":"8f3ced95-ccba-4ace-ac5d-03c1080bb768","partner_owned_disbursement":null,"submission_blockers":[{"blocker_type":"fast_ach_threshold_exceeded","blocker_name":"Fast ACH Threshold Exceeded","selected_option":null,"status":"unresolved","unblock_options":[{"unblock_type":"wire_in","check_date":"2025-08-21","metadata":{"wire_in_deadline":"2025-08-21T18:00:00Z","wire_in_amount":"1000750.0"}},{"unblock_type":"move_to_four_day","check_date":"2025-08-21","metadata":{"debit_date":"2025-08-15"}}]}],"credit_blockers":[],"contractor_payments":[{"uuid":null,"contractor_uuid":"e894e72b-0aef-4856-9082-9c7826db998d","bonus":"0.0","hours":"0.0","hourly_rate":"0.0","may_cancel":true,"payment_method":"Direct Deposit","reimbursement":"750.0","status":"Unfunded","wage":"1000000.0","wage_type":"Fixed","wage_total":"1000000.0"}],"totals":{"amount":"1000750.00","debit_amount":"1000750.00","wage_amount":"1000000.00","reimbursement_amount":"750.00","check_amount":"0.00"}}},"title":"Contractor-Payment-Group-Preview"}}}},"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/post-v-1-companies-company-id-contractor-payment-groups-preview.api.mdx b/docs/api/post-v-1-companies-company-id-contractor-payment-groups-preview.api.mdx new file mode 100644 index 000000000..32f5da3af --- /dev/null +++ b/docs/api/post-v-1-companies-company-id-contractor-payment-groups-preview.api.mdx @@ -0,0 +1,73 @@ +--- +id: post-v-1-companies-company-id-contractor-payment-groups-preview +title: "Preview a contractor payment group" +description: "Preview a group of contractor payments. Request will validate inputs and return preview of the contractor payment group including the expected debit_date. Uuid will be null in the response." +sidebar_label: "Preview a contractor payment group" +hide_title: true +hide_table_of_contents: true +api: eJztPWlzGzeyfwVvturZ3uVQFC1Zx6en+NioahOrfKx3n+IagQOQxGoITACMZMal//6qG8BcHI5IHVnviz8lFnE0Gn2ju+drpHKuqRVKnrLoOMqVsfHVbpyqRU6l4Mb/3zIRLE6VtJqmVukkp8sFlzaZaVXkJs41vxL8OhpEjJtUixwWjI6jM/d3QgkOJGpKqkWIX8QMyTv+a8GNJdciy8gVzQSjlhMh88IaQiUjmttCS+L3gXXsnHes5fcRMs0KJuQMh/EvOU8tZ4TxibAJrD0k5GMhmNtwwokssowIicM1N7mShg9/kR/wn7A1ZyTVHBGVWHXJJRGGUKL5r4XQnJGcarrglmtYRWnGNbHKTeG9sA5/kb9Ik6qcH5OLnC61yjJzrDllF7/IaBBZOjPR8Xn0spp/5uf/FZEffR5EX+JZYayKhbR85q4ztsucw0S+mHDGOINxJZSw5NdI0gWPjqN/xH/F2Sdnp/HfuTZwd4NIwAXOOWVcR4PIpHO+oNHx18itGxmrhZxFg4jLYgH7jEfj/Xj0It7dh50Yn9Iis9Fx/e83bfp4BbAshOQGcQQ3E0+o4YycnJ2SKwcLocaoVFC4wWth52SpCo0DUpplQ3I6JVJJDheSa3UlGGcDN4bmeSZSRMcTQ84XQopFsaiv/fnp3NrcHO/sMJWaIWJxmKrFTsBa7K8Ef9+huYj9TCFnf/ILxrU/PwMwCsPZMLoZlBiumCggNqd2Hg2iQD/RsdUFb6MHyO/jx9NXFb3jMj3XcXPzeRAZnhZa2CXe8Us35yRNuTEnhZ1Hx+efb2o0o801nYX9A+0bWHo8GsF/mjC9AU5Zy3hq8i+eWndNyFNFgWeGCVxaWK52KTv/MrDm19pxuuWHmhK6dlNgEocEt3s0iHINYs0Kdw6EoUTVeUW6AKEj1jbWCyl+LTgRjEsrpoLr20TOEC+TsrcyWzpk3gzKa28CUO2/0W13rzzn6SVKss3WxfHIX3c6SCU4N9sOx999O2OpLcxmW7mxt25DyCcv6i/eFJJxdkHElNAsK7UQsXNqiZmrImMwborDyFMx5EMyp1ecXLwSGqj7Fc+VEfaCTGvbLLidK/aMUB2mDgk58WyRUumW8NCWMFzPRcbhJ9BVNTnXBKox9aN0y18MCIIWAECeu3gJF33RgmpYE9NhejSIHBDAAKv01dB12zAP6kYQgKD/FvSyR0uHTYDNFrkCARHuiWutNN6QtXyRW1TlpT4N5gQemRJWOInCCULbSVI51VZynahryVnChJkU2vCFl0nhcBOlMk7l2tN9mnM7B9UONF5bA3WP24HgDt1kXUwWwoCWSCaZSi9RDZc0TrWmyxUS/5swFoi7mkvCXCS/7XhrEAnLF/VdS5HZ3PYk7OIIEOwuJMewfgXOcEXc+pmJ22ETHoYRcMj6nk+M+2cw4rp3XsFx2Nwp3k02h5FBfKxiuXOTQuKvicJ1ui7R6Y9Th+xbMN9SVn7t7bHnZxIHVUkdG55pW40S7qOmWdp2mkVFWgeqc+cFt5RRS7twQxkTMJFmZzUsddlKJ+VIAIbeDZibFQsVjkqvqMjoJON+ogFRFNaimyLY8Ay9EE81WxskjcsNHMK5JGFhgEpzo7IrvtHFT2lm7qdtu3cImqaQHhqG2/r/XdU2N4PICpvBzmfO2I7flwvHP7iF4w8A241TTUzY7SWom/dNSE8HipCz31t4TrVakAmHPzsY1miq+0nRJqYfQYIqyd9O0bvpv4ePLaap+IO2gCSTpaNmi6YGJddCc2I1lWaK/m/lqJ03RXRDctaE2edtBXtgGwdGAgB0i4Jb5H3zYP82Ub+tpK8jGM6eCJnQhSok/Bj+wDhlmZC89iftQkfOx1pBemuljY7rxgK1TDjSAYOYzlPGU7GgGXEzn3WdbwXMjv2mSi8oxEUw2GHFgq8A8cpPL6+0QYweMM1TLoJsXQNHAze3nr3ue+KOQhK/Qoem3ESMv0RSLEW4Z8f4Le7ohLyNPwGhQ6zk0Xh5QuUlManmXJq5ahPb78LNAEJSA+EPythCOvIHF6ifcdeO3IqMa6usJ+VBhLdD0xT4PsmosclUFTphYias2cJQ+xs1luwRNy/AgNTnFyeyWEy4Lq+0RZnk3ZvTx2S1H6i8jN9XVPjQXOeih8w763MxmxMtzCWZalqw8nC/F+t5aBKrEgAlAVASBCXRU/GdBb8hFnwAEn/nbjv+oOIfxWwevxPmMn4Dtx2/m4oHJ/VrigY8UgaY99o4pfm7UjgAkUyVTjwEfzijsYm2OhYSxi0VWdKM/OP7GJ6vW4BXZFu/U+LW+qY0xwrNPTQ/faLCxm+Ujt+5nbydBpALgHwhJLVKwxn9LSx/do9dLZpf0DyHo8MzT821udWJ/u68/efw4Xfn7Y/tvK1zcx6Tyb97dd8Kx3+TJuUf2au7zfV5YLb87vZ959Fv1u1b4yQ9MAt8dwe/BYL/7g7+3u7g3V7MN3gg/N1fy/tguv9L+QpDdT6S5xy1aFJmU9d+m1KRwfP5BldXPpVbZWm2Qc7JNg4WrhncrEB+vdnd6xMKt9/XJRZuszt5Xyzgt2s64+S/ieZiUaVtuYU6IYTxdwAQt7kvdhpA3gGIrkPeHRon6reHwon6++2+KrlcLnGzDKErf6BMFujOKNY819xwaZ2JggnGRshZ1pkQUuYzo0wDa2j47846FpJg1v6axOMSRXfNPQ4LdOeHKLmpHMShgQp8hYU/Q+fSc1XoDZf2OlBNCU4i10pfclaSWt8uoX7F5cduZ8Ks5tQ284KjQYRZuNEg+lEYq7RIaRaKNuBHpWE4kF34Y1cKboOJN4Owk+83wPlD5luHDF6MeIlgO5cJz6yAlav85lwrKEyAv4lpM9GzlYnt053n1GySiD0kVcGMqbbrSZJ2tUCaL6iQtSzr+j2/CZnTZRL1Z0+x2TLRG9vCMJLkXCPZbkO1C7pMUipTntU2qnKW19TWBMR2CBHIS59w4tbM1iSDgUrb7GBT8QWMeVCBqnGZA6L5jGqWcWPa/Lpe+26eA4dbok/TgcZwez/iPUHeO4DZyXNuW9Bet+/71B3iz6R2/8/IXxwsf3Fyr1OhfYk3qukKRl41KPaD0A7HgbFXZ9GNW5h/oYs8c/rHFFjyU6ki0DvtmpRob3/EGGXT+MURo/He9PlBfDTm+/EhOzicHO1NplOeNj3VUNF1GI93o2ZpSPnL7lFUSZV6yUG7riAajff5wRFN48PxHov32HMeTw53j+LD6fjFfvqcs8nBOOpP33fn6kyuP//ckS+Kf+yyIc7bmGop0YgfHu3xg/EkHlE+jfcO91/ER6PDcXyUHhyOX7DJ0dEhHNJrx2g0HEWlQqv9qxQW/m91tnaZjm31tKphWtohOth3a3Uh3TFwtDsajdygGnd5ZmiSfjkUnvsqJyKYgNHuCLcbRW1Dvv5Lw4AOK47aoFcjyolNezPCvwJ5fwLZ3VEH8Y1T+OH0ecrZ0X6cphMa79GUxzTdZ/Hoebo7OhxNJgcvDu9B4e2U4WgKYQeazhM719zMVcYS/iXl3IHXzOyN3kCg4eTlj+RDGExeV4NXnHAPSDh2w3ldSek9b0euwtNWL7br8Z3VJ7na2A+7h8ej0fFo9L+1B8UGvTmeuIHUjxYgC3UFxO6jM+gvbAZRNy3sQ93lzXdZ05I1W0mbfnkz6pE4o16Zcz+pc9Orh1d08M0g2hvtrXqdPytL3qhCMij2dpY6hsQ5wxhUoVNOmOKGSGUJ/yKMHZKfoHbOFNqFp0JlMzl9tYOOmjCuUH6IVeJ3rK8t4SK/SEIeHLQOH7keDcciP7Ma7/Z/7/Hpb101ueTI1NTymdLLNXvgqFsNvfc5T8EbN+R6zv2ZXX2iStNCmyH5sMzBx8uWxM6FIZd8WfnwrrKdWqvFpLB8p2oUoHlGfSCyXBKqxiuotwDN1oL6biWCdb9+qXBJxkOOYRghZ667gncDQtXmpBAZIylEFxZ+/JxKkMAz8CaxtL7WaQBhXnBjNvITzgIgLopuCJ2owtaQGpMZl1xX6PRLByhNoac0dZBSSbhkADhg7qbDCpYKY/CS1QnrvHH/UfU+VWG+NrF2uGgNg1xTxx84YRjdNKK0Pyuw2AvJ4tewafzWUa0XF+PxKlt+lN4txnDTa2mFXTrJAeigSzKnec4l0KNz7ieKLeHm8Wo8fOjvUSH9lRtiinROwHsWEtkzKYkyuaJZwS8GpHxNcCtM8YJYwT2uy5ll05CLIXnPHUucv3bbvHQ4FNxs2VwBwYzTcvozMisEcy7dQpXvLuZeEq8btU72fUduQO53qf3/X2pD35RyI2HIhUShlrh7vBggcGU/D9/0A2JjlLiR5MIPJSEB1IXXODKVZ4xvRjn0vxw3wXgZmFvzjF9RaV1JsVWBQJahUZAT/0IS5GnwSlFseIk0yfiQvFGaeI00aCyB8CGqLtx/0Ui+wLsNfwFn4KLsUhQsLTCsNq2BXBSZFXnG3V7ARy3GC39eZbbwyxYs3dzbP6i4s9xSzd2x93LDCODPtdpTj1Gsu63IJoWQOyaKwEs0UkMNwRtktqw8zIQ4o1sGV3TSG0pse559ynFFnljVP7Ah57oGgAPG+4bUrJCfPPXHEEaJ30oeO+XXdHKao37ytOOGwtXcXkbx/c7/E+4cVlqrsFs9T0D4KJktnfcHrwk9amNITl03FGWMABMLMgKhfU0phzJ+xTN8BfBqJCiKUqxEqdBpkVH91IHbsJufRfUTdgzoioU38nIYz7jlSeGDFo1H5DUeAvQka7oHK8Zaw02AhyIhZz+5hyV4sgq7lU9R7g4agF1xLabLRMjUvRAmzIVgHhKyf4IZ0MgkSqkE12XCCe4voHHRWcapCV2j0EgBi9WD4x8WzXD9EWgGzx7LJKz4qAcA9PoNXYpPeY4OADGCCik2qrC+KmWdV+hGJO6VuRvElpHfAPSdmx9eqYUpmwV6uELgLVVyKmamBK20NbfC2ursOjAnlsCVWgKN8ipjdlEYWzcsugELp8XIcvgxEwtheyDsGLw1CjE6Hd4qcY3aqzD1mC1hTnKuhWIVvFyyMkNxDZTlkE7YunH5WjKXwFhxDnpQdk4leU4WStq5AZtwWtgCa6ZqreCEZIWxepm42DoE8yUVqUlSxXhSGWZrIa5Gb4/Pn2Eugbkd5LgZhH6bxwcwkCb/taAZaJEXPh3ydnBNAMBsAK4RqRu7PbTvRYqwmlVgQ+6mgxUKhRI1nSa5ykS6xMeXze56cSckLrrutw1EIZGjOCv5haapLmhWZjKsgaoxbAvJfeLmufSHgLFJBqIcLKsSHoIACm7WAF5lSaLT1acdW1O3gfalY27GaWrFFWZs4BrOx/UwENiAqOk0RHXWwcwXeaaWnJtNrr0cvP3dvw5TsQ/hxhQwoRm8CSVFfou8XK+t+6B6SSWGRyn7F1672830X/tcQRvgZYKS3QEczAo0RB/SKvJNUkszAk0K4iEADeQvfz1oEC5+NLDK9xe0pLsAG5Dcm2yuQ6KSfC2opXosyexRSPHUjSFhCUybNLUYBsKn5ERRDWZ4GPeQ+As8DAY/KbcqQXIgrBzmASH4gLFHaBUtQ09L2YgCQ3C5pdGcWZFwCfGjpPYyrDCNaC1s7ZHbs2mVjoT+XmXfOFhckhpSOXYQCz3CW/A/ph3bOmOHmjOWarTb6dRy95q+iRWwOmt7/J2VdvWTjvWeVGxchSYwTkk8o1xhwhqeIoQWN4W/Mf5ekDdWuhXmMLpyaeDJAdrCGwPhjrC55OgM9Nk6fsT25g5HH6G0KIJf0AIJrRa4EcyR2ACld1N1P2JSYMU5ks+oFVdtBHker5I5H0je+IqQGgBui5I9plr9xmXi4XhQSYc9cN32Ky65f3SD2MKpNS6cXsHozA4GL2Q0s1yvgTapkoUfC3BhfHvEEuDw1NICFUONwqAB6IEt5EIxMRUotgPIIZr5kMCGF6N85bIdAA6TDZQ7QWm4vvJS3CyN5YtyUJDhbdsApYBJQt+DW+0EN/4+Aqi5UsXVkmB40sO5oF+g834bTlPonMKZHxHUkB9HPAxwE7ujEWI1U+oSOoeux+UjAhYMruADYEHHU/Ns2Mphq951zltB99J9iFqx8rB/DP+Md8fPMcWhLtBCXmFQ3xh0gyLgrYi/tVqnMYwU4Q3hRhyw/uENXcjAHu3ju71X4ew/T3k5htsif5xDUVaZpuZux2mB2X+mKWfwlJpY+uUxjwV2IRrgfj9i6ReC+93tjKtgb0CKLibskkQe/JgNMgwSK0Sh70GXDaC7D2kKA7GILUPsmxxKQFKLX7yuBG89QgWSA3k1b7m8mjJm12ead6Q9bx+q62ifX25e+RDROoArrXxfaBvPZS38bZHJXXu/a0PQStreHlcBL0ACGLYpq7lrNdM9meO19yOlDAYjQElCxTg5lQPyk7ri5IOCzFNNXlF8jqwrTP8pnTuZTaX7clV+yKjxdoRxseZHJZxJhx9z8vkcBdajUUlUYWM1jfF3v2BwM8UM+59BaA8aC2wU1nNdA7YO6VGR1R3dNgDB7w7RsTk1Sfnrw0dT3Gtu+eABl1vuRjA9KHy4JpCB5pBv7z/F5YMH1ZQJn8JikCeAfZ0kfO9HBqN6AQnjjXKIwDrrD1YfvQX3dXzerNP66eG9dUtskFn6qv45kWYu6eCRj8dGbErH43FM2egw3uP0IKajFzQ+2D14cXiYPp/sHhz1HLpVQHAH279Rhhn0p5Max6RZjjAgWLzpvq7VBYUvSrgzFL6+1Ys+Z1GvlpeSJ97adk/8T4ZBhv278o0H0VRIYeaJj3KCdoVEAmd6PUJM2iPI+fhWAWdbUm3eiglmylkxif+43y1K1GrObbK7/S3+BMTjvv4HEt0tBLJFQylkm2ZSl6J0vz1wkfbKLktne9Vr8buHJkSJr7VyTYXA+27v8ZvI70DmTiRzCb52iOL9JnL36PqUD2dDsjt+vrf/rIPF5kryO+dDnMHskA0RmHx31HgohYyDTKR9kYZO5im/ALXu6bHGOr7VkKml91bBKveE03LgNwlkd4LVn0fwoV47U/t+JNy+uxfIzXaWcuDxTF3X0hswl6svuaHy7e8cTYAtQzZfmyDqMYKH2aA8pNdkvpjwdp0fqg43Voe4ize0g5QCRjM9mg5+xzl38kAgJ5gzgj+RJ37Ok6qSQCpoCgANLsMoE7TKhBqRPrJ3TjHNL8jvYG26tglbubCSc2Zqesi7gR32R8Bb6DCw5nT489YI/wRp4UHOzPBZVHuTVVeJGqNSUa1A94gxerQk1gfJWzHnqj0DNrWgKXwFLc+VtoShcZQt2y/8oXGfP4N7AX3wOHQr+aEGstuQtV6z+tLFhDY2uVvCyxuY675A1HCT2nYz6odpMhEav7265S6v/NcscXrpGnsNimkTzgBEmbPZM22ZC3oXI94b7wdjyvde7B7EjNKjeI+zg/hwn4/i3UPO9tmI88Pn+z0izVUMb++UZhklb4T9bQahOOa+fwjCvOoAAjQ8b72GGQ42Yue3XDscnQfG1JgdTKYvxmk8oZNpvEd3x/Hh+GgcP98b8TE7SulkfNiDqbtJoVNDBZ2TH7jOhCzR5CqzEUXXvnplMwwFm5pL4+zpMu7Rn7ezPlerN4XVW6N1Sq8nXXZCUjqXsjc/tDHszt4azG55jASeYAfkE+eXEGqSdo6ld//ktAvqEDQpZe8Du0phoz5pr2oKtVk62qhWjNcku7smaSiBf1BsGYh/o+LIvpK8LvZbKRLashlbf8u0O7UtqzGKa6ve+uhdtFG7r7u08mp85rw1sadvUtlEfpopulpAc7rSrUkYJxIq4Tpwj8/CVRDWhG75ob+Vjxv2tWCC87tqieg42vetGHpasa2coJq953o+bHgkGSTh6qHazd3K6p7aKt2ts6K+BnU9oO+PHgp21/OuNY1TLV3g/tbObj1AjrtgfBcWdFTQ9W1LX27e37a38XmD1YZioA2wvLFsp1Zl41fysyaRqi/bY0WOyTm95NQsY/fd9rqG9zzl2181R4NlF6srrrVgAG9e9kflXyyXpmw348R0+LB9rdg19j6wUyRQ9eiLpCM0OprztLmms2qwA78a1D5FOXDtabpnN09VrRJOB71Qyp4sucLYQk7tPDqOdq52d8rsu52vZSo8u9np8GMQTLNTYQ3TQLx+KzR0YAml5DQXrpI8ZnyB5eQdbeUWqnU/br3YxZLhZ+y4071w55pnGuPG69bM4WdAh+FpoYVdvgf95VSG92VPsNfZSQHoKekaNofj4mjQ35xqdIXb1b64RIyFaYQWdg7RiPDqOojeY6rMfXZwK6zZ4GYQgV5+V2nw14Hb16jX8y7rtmTi2/v5+B49+6FBT+ga5GV3aCkU5GG7/c84dOppt0zai0cH8RifCkLmRzBksFUpOTmDTwGUz3u+gdILaKA0iKBboXk7fc/1lUh5jXaq1gZYDb6DA3cYIBOMhxj/Dc90xk9dqWDkWaoW+HqJcDwx5LXnfxIS5k7OTglTabEILWH/y/eYoC4a6ftlvQq7knfQB8CHnNzLHhC///V/KlqH+wXuXVBZWye0oe2y80mQK41T1Iy62uz+1seeplz9uI+8Q7V6XljXQkBzW2hJvGjo6Tbr9nFB72Bf8S+566RdNcUaEvKxEKwsWIeS1CrjGbJHDR+GNkOwNWek2TANc6VLH74eFq2FoHySe+/Xm6FfiklVzo/JhbeuzTGY3xf1DheWf7E7eUYFcjrKrK9eyp5HV/gAEeRsNIiOK0kbdYaMZkF9BWH7GbjLWFjt61fwHz7q7OYG/vxrwcGFgAZhV1Rj0iByNhNo7DPfdbyHCp6+81h6Rlbb9yKc684ZrHMcEfRO5IuPo9ohXQkBpwxi31sBV3YfdXYQfi8Jzs+Q07wIWPkEADapgAHQlwM7VEhw6kRVNjBwY2pezRNDzhdCYipebe0t+6PQXMR+ppCzP/kF49qfnwEY0GxjuA6tDn3/iFHIxCdnp/HfyySEEsuVMfDSIcu1a69GrDhs1QzQQbntHVs3Gs7evv+A8tw5hQuF1pOm2FmeXrs7r32BG//2NcqonBVORbg1QYTRpuIrFZ3/n1ofiiZVff3qRnwA5r65KYnMdUcEb/fm/wDh0z5Q +sidebar_class_name: "post 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 group of contractor payments. Request will validate inputs and return preview of the contractor payment group including the expected debit_date. Uuid will be null in the response. +The returned creation_token is a required parameter in order to create the contractor payment group. + +scope: `payrolls:read` + + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/post-v-1-companies-company-id-contractor-payment-groups.ParamsDetails.json b/docs/api/post-v-1-companies-company-id-contractor-payment-groups.ParamsDetails.json new file mode 100644 index 000000000..74ca07acc --- /dev/null +++ b/docs/api/post-v-1-companies-company-id-contractor-payment-groups.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"}}]} \ No newline at end of file diff --git a/docs/api/post-v-1-companies-company-id-contractor-payment-groups.RequestSchema.json b/docs/api/post-v-1-companies-company-id-contractor-payment-groups.RequestSchema.json new file mode 100644 index 000000000..7acfdff31 --- /dev/null +++ b/docs/api/post-v-1-companies-company-id-contractor-payment-groups.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","required":["check_date","contractor_payments","creation_token"],"properties":{"check_date":{"type":"string","format":"date","description":"The payment check date","example":"2020-01-01"},"creation_token":{"type":"string","description":"Required token used to make contractor payment group creation idempotent. String must be unique for each group you intend to create.","example":"1d532d13-8f61-4a57-ad3c-b5fac1c6e05e"},"submission_blockers":{"type":"array","description":"Optional array of submission blockers with selected unblock options. Returned from the preview endpoint and can be submitted with selected_option to resolve blockers.","items":{"type":"object","properties":{"blocker_type":{"type":"string","description":"The type of blocker that is blocking the payment submission"},"selected_option":{"type":["string","null"],"description":"The unblock option selected to resolve the submission blocker"},"message":{"type":"string","description":"Optional message related to the blocker"},"options":{"type":"array","description":"Optional array of additional options for the blocker","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of option"},"message":{"type":"string","description":"Message for the option"}}}}}}},"contractor_payments":{"type":"array","items":{"type":"object","properties":{"contractor_uuid":{"type":"string","description":"The contractor receiving the payment"},"payment_method":{"type":"string","enum":["Direct Deposit","Check","Historical Payment"],"default":"Direct Deposit"},"wage":{"type":"string","format":"float","description":"If the contractor is on a fixed wage, this is the fixed wage payment for the contractor, regardless of hours worked","example":"5000.0"},"hours":{"type":"string","format":"float","example":"40.0","description":"If the contractor is on an hourly wage, this is the number of hours that the contractor worked for the payment"},"bonus":{"type":"string","format":"float","example":"500.0","description":"If the contractor is on an hourly wage, this is the bonus the contractor earned"},"reimbursement":{"type":"string","format":"float","example":"20.0","description":"Reimbursed wages for the contractor"}}}}}}}},"required":true}} \ No newline at end of file diff --git a/docs/api/post-v-1-companies-company-id-contractor-payment-groups.StatusCodes.json b/docs/api/post-v-1-companies-company-id-contractor-payment-groups.StatusCodes.json new file mode 100644 index 000000000..174e15b12 --- /dev/null +++ b/docs/api/post-v-1-companies-company-id-contractor-payment-groups.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"201":{"description":"Full contractor payment group object","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 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"}}}},"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/post-v-1-companies-company-id-contractor-payment-groups.api.mdx b/docs/api/post-v-1-companies-company-id-contractor-payment-groups.api.mdx new file mode 100644 index 000000000..c8729f409 --- /dev/null +++ b/docs/api/post-v-1-companies-company-id-contractor-payment-groups.api.mdx @@ -0,0 +1,71 @@ +--- +id: post-v-1-companies-company-id-contractor-payment-groups +title: "Create a contractor payment group" +description: "Pay a group of contractors. Information needed depends on the contractor's wage type (hourly vs fixed)" +sidebar_label: "Create a contractor payment group" +hide_title: true +hide_table_of_contents: true +api: eJztPWtzGzeSfwU3W3W2dwmaT5HSp3P82Khqk6hsZ717josCBxgS6yHADDCSGZf++1U3gHlxSJGylPVe/CEVi4NHo9FvNBqfI70WGbNSq3MenUVrbSy96tNYr9ZMSWH8vzYzyWmslc1YbHU2W7PNSig7W2Q6X5uoE3Fh4kyuYaDoLLpgG8IIfiQ6IWVH0yXnKtHZCqckSgguOOFiLRQ3RCtil6LS/JEh12whiN2sBXm81HmWbsiVIYn8JPiTX9QvysR6Lc7I5ZptMp2m5izL1WXUiSxbmOjsffS8GItcOJjJXx3MHzrRJ7rIjdVUKisWDgsUpoKOYjUXnAsO7dYsYythRQZDfo4UW4noLPoH/Sv2fnZxTv8uMgNL70QS1r8UjIss6kQmXooVi84+R27cyNhMqkXUiYTKVzDPoDcY094J7Y9hJi4Slqc2Oqv+ftNE7wuAZSWVMIgvzqygc2YEJ88uzsmVg4UwY3QsmRWcXEu7JBudZ9ggZmnaJecJUVoJIg1ZZ/pKcsE7rg1br1MZIzoeGfJ+JZVc5avq2B8eL61dm7OnT7mOTRex2I316mnAGvX7gd+fsrWkvqdUiz/5AWnl5ycARm4E70Y3nQLDJe0FxK6ZXUadKBO/5jITPDqzWS6a6Hm7FOTnn89fAOk5esJh9mzHzc2HTmREnGfSbnCPn7s+z+JYGPMst8vo7P2HmwrNZOaaLcL8mTBrrYwwMPSg14f/1WF6ladphbCJZ6DAI/N/idhGnQhaCGWhf2UXnv7LwCCfK/BvrzjZN0OHSBWnOZdqUaWL7eamC8zjkFNAxdL0pwTRUp/2O2YEEM9aZFYKQxKd7YSgdeCyL6wpzyVvY5XtteZK/poLIrlQViZSZOVWt8/eRaJh/CeVbtym3XQK8jp83haqah95KeKPM+DLw8bF9sjHd1oIF3Npj5gO2999OmOZzc1hU7m2t05DyDuZpmQuyOWrXHHBL4lMCEvTgi6JXTJLzFLnKYd2CTYjj2VXdMmSXQly+UJmIrbkhVhrI+0lkmOYZiXsUvMnhGWha5eQZ579YqbcEB7aAobrpUwFfGrwTR2oWteflRv+skMQtAAAiuDL57DRlw2ouhV1ELpHncgBAVphm74ygYJhZvVHocqdeF9uhcrT1GmU2pZAexS0xGqyYh937wkJkwCbrdYa5FLYJ5FlOsMdslas1hbQY7XrIQrNj0tmhOdOkAmC0LaQ1E0nstKmQEqlvqZeX1PU1xRkDeqG/TJkzTKrRDbT10rwGZdmnmdGrLxMDViaa50Kpnai6d1S2KXInHatjIHK0s1AcIZ2/sjnK2lArc3mqY4/ot1QAM6yjG22eOVv0ljgkrIvCX2Rjo9j0k4krVhVZy3QVZ/2WZjFUfI6E1dI12H8EpzuFqp9z5mb4RBhgGacTmpzPjLuTyShpdgx8xaOw+TOUjhkcmgZ5NA2llsnyRV+nWkcp20TnSI6d8i+BfMNZefHPh57vidxUBXUceCajlVNYT8qKqppWFrUyFWgWmdeCcs4s6wNN4xzCR1ZelHBUptx96xoCcCwuwFzs2VSw1LZFZMpm6fCdzQg08JY7FAEG5GK2AruqeYY4bwFesEhQigSBgaoMmF0eiUO2viEpebL1Hb7DEFl5cpDw3Fa/89ttVWR8hfOO6BvioHpd25g+hZgu3E6jkt7vAR1/b4K6elAkWrxewvPJNMrMhfws4Nhh6b6Milax/QDSFCthPc79u/Dzw2mKfmDNYAk842jZos2CyPXMhPEZkyZBB320rN8XxfRNclZEWYfjhXsgW0cGDMAoF0U3CLv6wv7t4n6YyV9FcGw9plUM7bSuYKP4QcuGE+lEpWfoJ8w1jlrW0hvjHTQcl1boJa5QDrgRCrymItYrlhKXM8nbevbArNlPhfkis4ijM5YuRJbQLzw3YstrRGjBywTsZBBtu6Ao4abW9dedWJxRqmIH6HVNL9djD9HUixEuGdH+hPO6IS8pe+A0NsM+Hvj5TlTH4mJMyGUWeomsf0u3AwgzCog/EEZW5Yx3lsYd2fLo8i4MspuUu5EuDssjoHvZykzdpboPJtxuZDWHGGo/Y0ZS0bE9QswIPX5wYnKV3ORFVvaoEzy+tX5Q7Lad0x9pG9KKrxvrnPhTu69/qVcLEkmzUeSZCznxeJ+L9bz0MysngEoMwBlhqDMskR+Y8GviAXvgcRfu92mbzX9Xi6W9LU0H+kr2G36OpH3TurXDA14pAww7zPjlObvSuEAxCzR2cxD8IczGutoq2JhxoVlMp1VyRWI34oFrq9dgJdkW91T4sb6qjTHFs3dNz+9Y9LSVzqjr91M3k4DyCVAvpKKWZ1hbNXtwuZHdzrXoPkVW69h6XBMVXFtbnWivzlv/zl8+M15+2M7b7vcnIdk8m9e3dfC8V+lSflH9upuc33umS2/uX3fePSrdft2OEn3zALf3MGvgeC/uYO/tzt4txPzAw4If/fT8n0wfflJ+RZDtR6SQ7azVAvgXymuq6fmnShhMoXj8wO2rjgqt9qy9ICck2McLBwzuFmB/FoyumuJozsyE4+f12UoHjM7eZOv4Bvmi/83yYRclWlbbqBWCKH9HQDEab4UOzUg7wBE2yLvDo0T9cdD4UT9l82+LblcLnT9ukFb/kCRLLANXibWmTBCWWee6ASSeKRapG3JIP+u9GSpCF4j2JGhXKDgrknKYYD2/A+tDpVz2DTsslTVdJPWoeGyxoFDex2nE4KdyLXOPgpekNK+WcI9FJdIe5yJsp18W08gjjoRputGneh7aazOZMzScIsEPuoMmgNphR/bcnVrTHoYhK18fQDO7zMxO6T6YkRLBtu4yIzmOYxcJkKvMw03JeA3mdQTORsp2z4vesnMIRnbXVJmBJtyuj3Z1OQawM7EiklVSceu7vOrkGJdZFt/8BSbbmbZwbYutCRrkSHZHkO1K7aZxUzFIq1MVOYk77jsExDbIkQggX0uiBsz3ZHsBSrrsIXh9Sqn4nRtMzskEwuW8VQY0+TX3dr18By38rJXCxrD7n2P+wQJ8gBmK8+5aUE73T7vY7eIP5PK/j8hf3Gw/MXJvVaF9YkedMlsT2Y72NnYEA1svFwkPrHVOnUKx+R4+6jUPVFycjoUveGI8ulwSEcnYkinUz6ig3g66MXD6TAeT6LmxZYoHo96o5NkQvtzMaKjeDyi0/7piCaj6WgQD3vx9ITXvVS8fjaivTHtTaL6/ZLySz8qJU713kLzckI0Gotk2p/PKRODER0x3qfzQXxCT8T4ZMhG8bDn+rXp+/fF2k+GPR6fTgc0GZ1O6UjMY8pOeExHfHIy6fd7g0ksohaVGQ3ECe+dTnp02J8ndDSJBZ3z+YhO+kMxGvQmIk5GUaELo163FxXqKxqVfxayIepP8ccqG6PrsK2PtlVKQx1EkzGO1YZIx7AeoAonlRxQpfNoMoCWcADuF94fJOO+mDPKT8ZDOhqOJ3Qa98a0n/STKe8lfCyGrRhjp5NxwlmPJnEypqOTU0bZOOG0dyJGQ96P+ekp34mxNoT1DsZX0LhNNPVuw1J/3NtGlJMQDTz5lsBvpeMUzN5oMDh1O1J3Xcrfaw5DNBgM3LTttrzbXpAW70BjtdzuqHD3WMTD+Xg6oBPeG9HR8HRC56IvaNITk1Pe64n+vIW7R2x4Oh+MTmlfDAZ0lMSnlI16CY3nvQkfsPnwdCRauHtMe1M66LdwN37pnx7K3QdCve9ijieG1nsz75u50lEC8RYWL2d2mQmz1CmfiU8x3iSOminN0SuIsDx7/j15GxqTl2XjrehDOJWrLr7inG+lM79vRu0qA+zGeDW2tX0cWWn7tj896/XOer3/rRymlrR10us5Ukamr8Ox0ldA8j4wha7SYQC1k8MY7sgCy2yl5W9vkA+SYoiyREdjY95VIqkQYyLnqnVDqiftlU2pxVMO2Jb6ML/f1uw6540mbNhPRDKlo5P4hI76/RE9PZlM6KA/mk/YMJ6Ph4MC5/s1Y8ym8WR6ekrjAejD3nxOp/OJoL1p3B/2TpNxfzhulfPzUXwS82FMR/PRmI4mwyllfNSjQ85G4/nglE1Oxg8k5w/QiwUG90n9Es23iv3ALO1yP+xYi+ivfqpL/375Yaf8L5vUAywR/npzP5ZkaUV2olFvtB0P+VFb8krnikPRBOdjIjniJXDUJ4RrYYjSlohP0tgu+QFuh5o8c3HTUCPAhRekIVcslbz7i7r7rfUCJvKLIqQJFvB3nsXiULjOXzytg9YS0Kme0eAdVrN9CuN/3xNpunXU2UeB8pZZsdDZZscc2OpW9+TNWsQQQzLkein8mt31Wx3HORTUeLtZQ2Qi3RC7lIZ8FJsy8uQKRDBrMznPrXhaVLIgmUiZD48XQ0LxhRLqI0CzlaMmNxLBa+1+qLBJxkOOwUGpFoYwxYPzGi4lz3OZchJDTGzl2y+ZAgG8gBgIVqioFOxAmFfCmIO824sAiDvbMYTNdW4rSKVkIZTISnT6oQOUJs8SFjtImSJCcQAcMHfjWbnqwSmNJ0OKVwnrfW3/o/LUtMR8pWNlcdEOBrlmjj+wQze6qZ0d/KjBz8wVpy9hUvqTo1ovKgaDbbb8WflgDh7svFRW2o2TGoAOtiFLtl4LBfToQlJzzTew87g1Hj6MUjCp/JYbYvJ4SSDmIxWy56wgytkVS3Nx2SHFGZcbIcEN4rnwuC56FiVrLrvkjXAs8f6lm+a5w6EU5sgaJQgmjYvuT8gil9wFIla6OA00XyTx2lHrZN835AbkfpPa//+lNpQfKiaShlwqFGozt4+XHQTO7ZUL6HqSJ4y4luTSNw0FaDYuKCyQqTxjfDXKYX8+Qx2M54G5M5GKK6asu+hudSCQjedkL/6lIsjTEFVAseEl0jwVXfJKZ8RrpE5tCIQPUXXp/o/G8yXubfgF3IRLh/55aWmBYXXozdxVnlq5ToWbC/iowXjh521mC1+OYOn63P6oz63llhoDLXNvDoxb/1i5Ee0xirfBS7KJ4aAI05cgPwKpoYLgA/Ktto4TQ3TcDYMjOukNF7/35FAU7fL1zOr9DWtyrq0BuGViX5OKFfKDp34KYTD6kxLUKT/n/7S3+sHTjmsKW3P75Z5ve/6fsOcw0k6F3ajEA8JHq3TjvD84A9ujNrrk3NXo0cZIMLEgTxWqMxVyKBVXIsWzK69GgqIoxEoUyyzOU5Y9duDW7OYnUXWFLQ2iFi+gli3GRSqsmOU+lFFLbdjhIUBpv7p7sGWs1dwEON6UavGDOw6Fg9YwW3GA6vagBtiVyGSymUkVu3PtGXexmfuE7J9gBtTy22KmwHWZC4LzS6jLdZEKKCzn8krQSAGL1YPjj8NNd/cSWAqHdZtZGPFBFwDo9RO6xLNiHS0AYngbEr90bv1dqV1eoWsxc7kR7SA2jPwaoK9d/5BbIQ0JatfDFSJysVaJXJgCtMLWPApr272rwDyzBLbUEqg3WRqzq9zYqmHRDlhYLYb9w8dUrqTdA2FL46NRiEcH4YQdx6jkMjCP2QLm2VpkUvMSXqF4kTe7A8qiSSts7bh8qbhLqy05Bz0ou2SKDMlKK7s0YBMmuc3xJl+l0qFUPDc228xcnB1OWhSTsZnFmotZaZjthLhsfTw+f4S+BPq2kONhEPppHh7AQJri15yloEVOfJLu7eCaAIA5AFwjY9f2eGjfyBhhNdvAhoxiBytcX5vpJJmtdSrjDR7AHLbXqzshcdW2v00gcoUcJXjBLyyOs5ylRf7NDqhqzY6Q3M9cP5e0EzA2T0GUg2VVwEMQQCnMDsDL3F10uvZpx0bXY6B97pibCxZbeYV5RjiG83E9DAQmIDpJQlRnF8xitU71RghzyLYXjY/f+5ehK5bZPJgC5iyF06JZvr5FXu7W1vuges4UhkcZ/xduu5vN7N/2pU4lB6kO/zmAg1mBhuh9WkW+1nBhRqBJQTwEoIH85u8GDcLFDwZWcf6ClnQbYB2y9iabKwCqldgJaqEeCzJ7EFI8d21IGIKA22UqMQyET6u5ZhmY4aHdfeIv8DAY/KSYqgDJgbC1mHuE4C3GHqXBYI8r2apqUWAILjc0mjMrZkJB/GhWOTPWmPy2E7Zmy+PZtDz6RH+vtG8cLC61Eqkc69qFCvUN+B/Sjm2ssUXNGcsytNtZYoU7Zz/ECtjudTz+Lgq7+lHLeI9KNi5DExinJJ5RrjDNElcRQouHwl9r/0WQ10a6FebQunRp4MgBHiUwBsIdYXIl0BnYZ+v4FsebOwJ9hMKiCH5BAyS0WmBHMHviAJTeTdV9j6msJecosWBWXjUR5Hm8TEG+J3nj7ylVAHBTFOyRZPo3oWYejnuVdFiZ2U2/5ZL7QzeILZxb48LpJYzO7OBwQsZSK7Id0M7KFPeHAlwaX7SzADgctTRAxVCjNGgAemBztdJcJhLFdgA5RDPvE9hwYrTe2mwHgMNkDeVOUBqRXXkpbjbGilXRKMjwpm2AUsDMQjWOW+0E1/5LBFB9pJKrFcHwpIdzxT7BAxZNOE2erRms+QFBDcmLxMMAO9Hv9RCrqdYfoZ7tblw+IGDB4Ao+AOYJPTZPuo2kuvJc530j6F64D1EjVh7mp/An7Q+GmOJQFWghtzCobwy6wdX0o4i/MVqrMYwU4Q3hWhxQKqIz7iq/ZLkK7NFcvpt7G8796yk2xwibrx9mUYyXpqm523IaYO5fUyI4HKXOLPv0kMsCuxANcD8fsewTwfnutsZtsA8gRRcTdkki977MGhkGiRWi0F9AlzWg2xdpcgOxiCND7IcsSkJSix+8qgRvXUIJkgN5O6m82JoiZrfPNG/JST8+VNfyqEMxeelDRLsALrXyl0JbOy5r4O+INPvK+V0TgkYC9/G4CngBEsCwTVFjoHKTf09af+X8SGuDwQhQkj7HvEN+0FeCvNWQeZqRFwyPI6sK079IdSezqXBfror3wGpnRxgXq7+Z4kw6wsp8jhxvUTJFdG6pTih+9wMGN1MusCofhPag3MVBYT1Xy+LokB6TadXRbQIQ/O4QHVsyMyu+3n80xZ3mFgcesLnFbATTg8K7TIEMMgFXIdzReQgelF3mIoHBIE8Aq40pcQ2DBkMPEslrl1UC6+xeWLX1EdzX8rheq/Wzh/d2DXFAZumL6iM39VzSzgMvj/d4wgaDAWW8B/f62ISy3gmjk/7kZDqNh/P+5HTPohs3C+5g+9cuDwf96aTGGanfU+gQvJ/mHqlrg8JfVbgzFP5Wthd9zqLevhRNHnlr2x3xP+oGGfbvyjfuRIlU0ixnPsoJ2hUSCZzp9QAxaY8g5+NbDZxtSTl5IyaYamfFzHDo26wwYzMh7Kx//C7+AMTjHtoDie4GAtmSwTXeJs3ELkXpy+bAQZojuyyd41UvdAPU+ijxdabdBS3wvptz/CbXdyBzJ5KFAl87RPF+k2t36PpYdBdd0h8MR+MnLSy21ErcOR/iAnqHbIjA5P1e7aAUMg5SGe+LNLQyT/HA2a6jxwrr+AJYppLeWwar3BFOw4E/JJDdCtb+PIK31bszZU4G7r7bF8jNdpZy4PFUX1fSGzCXa19yQ+nb3zmaAFOGbL4mQVRjBPczQbFIr8n8fcLbdX64eHiwOsRZvKEdpBQwmtmj6eA79rmTBwI5wYIT/EQe+T6PypsESkMpCyi7GlqZoFXmzMj4gb1zhml+QX4Ha9MV+zjKhYUnhU1FD3k3sMX+CHgLdTF2rA4/H43wd5AWHuTMAo9FM2+yZmWiRq9QVFvQPWCMHi2J3UHyRsy5LCqCpVhYDG/zrdc6s4SjcZRumif84aqrX4M7Ab33OHQj+aECspuQN06z9qWLyczY2d0SXl5BX/cuVs1NatrNqB+S2Vxm+ITxkbO88I+1YvfCNfYaFNMmnAGIMuewY9oiF/QuRny4xTxgYnTSn1DO2CkdCT6h07Ho0f5U8DHvCTEdjveINHeX+HinNE0ZeSXtbwsIxXH3KicI87JuDdDwsnEaZgTYiOgiNivotDg694ypAZ/Mk5NBTOcMqpCw/oBOB6cDOhz1xICfxmw+mO7B1N2k0Llhki3JdyJLpSrQ5N9RBxRd+9srh2Eo2NRCGWdPF3GP/Xk7u3O19qawemu0SunVpMtWSArnUu3ND601u7O3Br0bHiOBI9gOeSfERwg1KbvEq3f/FKwN6hA0KWTvPbtKYaJ90l5XFGr96mjttiLdkezuSvehBP5O800g/oMuR+67klermbuDF+ulSLauEO2vXVur8X9gLVs4mXKJ/a4WRI/2+lAIac+TzLsueLz2a3WPIn/Jk8xvcIKCDn3xQUyWYfHS99zoHO/fuQQKl6fVrS2nz8fDAe8P6TQ56dMRG08og9oQ83HC4n58Inrj8gmAI183dsVloZ4ofN71zjE6R0Xd1nptV9Mlr4XNMwUnyPC6pbv7jwVU4aLdWksolVdeTPRvCISiw424dDWWHObv7rta9hCvd+J5f9vznSVyovsukXv4I7JHXZ0sNjjciGxcVK2Mufsp0NtoprzMVZQbLkrxF47GgTt4/M557B+DlR88MgKUYYgbLzePrHC6f0V3qhVakTTurZIGKUYH1di8S/1MJNaE5andrgazp1hhIbWTVLPt+3/nWyUSpXEWTWkbdlzujHQXoCs2Y/F67taLwfvqHtaE6NjXmNlT/3RrBWVvX2zuwCWpYMhtL6pZUbW4nFgZpb1eZbSvKuwe0EP1tS+H3RWabXQTDCR/dEg51T1ADtpgfB0GdFTQ9mB04NibqoniS01+omYt2EfBzIaiqq25Dp7afQ2femtwGam+ElkmOcaBUCkjwFYoU1SycubfJ4pFFmjlEj31sTVnoMJtal98IUJnpt4vM9dsUTZ20JeNmosoGu5cTHvv+qIqo7jFQfGlogbUWmPIcs3sMjqLnl71nxZJvU8/Fzds+M3TlvDIImAUs8q8uZxnUOgpVKZga+kKU1AuVlidoqW26ko3dsWNR93RFHzG2mrtA7eOeZHhMdSuMdfwGdBgRJxn0m7egDnsRLgPjT3Dsp/PckBLQd8wOSwXW4M7IFiGCq9ZPACHoHjPlbDcLiG4GZI4OtEbzLz7khncCDsmuOlEYOa/Lh2Cl4H7Pm9VXQvWc0tRwYOM0YMrBhayoaW8XPhUOk7FT9Vycs2Rtprvr9S2HQ8oRrq9NJqvdTYOpc4atUlDebYggpuV1FxZUHek4DLigoOHhcfJswt4uKdIe/A17k6g5l8ngtrD5qfkjciuZCwqTFCWfMEqGU+x4VMOVAFWCcW/IX3B+K5bN7tFGusVZnUgHI8MeenlFwmJxM8uzgnXcb4KRdz/yzuDzJ3S+FqCL8Ks5DWYnT4U7zIegIv91/8pmRYIFcTPiqnKOM/d9ZW28AcJYrG2iIqvC0EBwtrq3psuOa+8kqNc/iYXkKaE2rCubB6ZShnkx15NXhlnqDyBQkwm1mtxRi69227OslxdlnVzrPhkn65TJpHhUXR99kL2fXTVLyqIumocZ6WgbXW0g6T9AHRnLIzx+TPEIn7O0psb+PnXXEA44v0HkPYZJiAjzXOJgQNeFAHcibrHwRl+QrYL2CN0u1YXTGVsEXRN5AsZRJWluetIgnE4RzsKuKL+tjNK8EVAWD9H6vRss/XIDRa8gQZQ4wer3SgIEMnyClLHtalESB4Z8n4lFab1VsY+stYSW0vqe0q1+JMfkFZ+fgJgQMChuwutDn3/oMiY9NnFOf17kdBUYLk0AJ47ZLkHScoWW8GfsgcooLXd27ZqKVz89OYtSjoXYFppNJgyhm+nsGu35xXHEn/7HKVMLXInPN2YwPasrvUKLef/URH2dar6/Nm1eAsq6uamIDKnsiBydvN/+gdyeQ== +sidebar_class_name: "post 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 a group of contractors. Information needed depends on the contractor's wage type (hourly vs fixed) + +scope: `payrolls:run` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/post-v-1-companies-company-id-contractor-payments.ParamsDetails.json b/docs/api/post-v-1-companies-company-id-contractor-payments.ParamsDetails.json new file mode 100644 index 000000000..74ca07acc --- /dev/null +++ b/docs/api/post-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"}}]} \ No newline at end of file diff --git a/docs/api/post-v-1-companies-company-id-contractor-payments.RequestSchema.json b/docs/api/post-v-1-companies-company-id-contractor-payments.RequestSchema.json new file mode 100644 index 000000000..ea5e7298b --- /dev/null +++ b/docs/api/post-v-1-companies-company-id-contractor-payments.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"required":true,"content":{"application/json":{"schema":{"description":"Request body for creating a contractor payment.","type":"object","required":["contractor_uuid","date"],"properties":{"contractor_uuid":{"type":"string","description":"The contractor receiving the payment."},"date":{"type":"string","format":"date","description":"Date of contractor payment.","example":"2020-01-01"},"payment_method":{"type":"string","enum":["Direct Deposit","Check","Historical Payment"],"default":"Direct Deposit"},"wage":{"type":"string","format":"float","description":"If the contractor is on a fixed wage, this is the fixed wage payment for the contractor, regardless of hours worked.","example":"5000"},"hours":{"type":"string","format":"float","description":"If the contractor is on an hourly wage, this is the number of hours that the contractor worked for the payment.","example":"40"},"bonus":{"type":"string","format":"float","description":"If the contractor is on an hourly wage, this is the bonus the contractor earned.","example":"500"},"reimbursement":{"type":"string","format":"float","description":"Reimbursed wages for the contractor.","example":"20"}},"x-tags":["Contractor Payments"],"title":"Contractor-Payment-Body"}}}}} \ No newline at end of file diff --git a/docs/api/post-v-1-companies-company-id-contractor-payments.StatusCodes.json b/docs/api/post-v-1-companies-company-id-contractor-payments.StatusCodes.json new file mode 100644 index 000000000..6407298fb --- /dev/null +++ b/docs/api/post-v-1-companies-company-id-contractor-payments.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"}}}},"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/post-v-1-companies-company-id-contractor-payments.api.mdx b/docs/api/post-v-1-companies-company-id-contractor-payments.api.mdx new file mode 100644 index 000000000..ada230cc8 --- /dev/null +++ b/docs/api/post-v-1-companies-company-id-contractor-payments.api.mdx @@ -0,0 +1,71 @@ +--- +id: post-v-1-companies-company-id-contractor-payments +title: "Create a contractor payment" +description: "Pay a contractor. Information needed depends on the contractor's wage type (hourly vs fixed)" +sidebar_label: "Create a contractor payment" +hide_title: true +hide_table_of_contents: true +api: eJztXFtz2ziy/is4PA9Jzoq2LNvx5elkc9nxQyauXHbOVibFQGRLwoQEOABoR+PSf9/qBkBSFCVLil17amoepjKmgMaHRqNvaOAuMpBWWth5dPn5LnqpipLL+Ys0BWNeVHYWXX7+svgyiL7H08pYFQtpYaq5FUrGdl5CdPk5gmIMWQZZ9GUQWT41+O2lklbz1CrNrvm8AGlN1CKjzS2fRpdWVzCINJhSSQMmuryLRsMh/pOBSbUocZzoMjIVAZpUeTSIUiUtSIuteFnmIiU0h78ZbHoXmXQGBV+l8XEGTEOpwYC01IWpCePMCDnNgaUN4NIBPogGkZtipMa/QWojxA/feVHmDquHlRjLbUVfqkpk0WU0PDk9HcH4Ij47H13EJ+Oj85jDxfP4+cX58enp6OLkPJv4mbgxE99xnJ6enR+P0jg7H6fxyTE/w44X8TEfHh+fDyeT4fHZIBpEYyVxwGg0PBhGgyjjFuiv0TA+GsZHF9EgmqlKY5MT18RPKinAzhQO9UpoSC17BaUyAuemQRTjShsoiLvR0dD1REL5PNFujKNz+ljweZJymUIeVjEwIXpTSRSGQXTLp9jDUcE/Es/On4hi/VFZnkeX0RkiHUaLxSCywubYcFWKcCZalaCtgBbH78JKGauFnCJLVha/kuL3CpjIQFoxEaBx/e2sb+mZkOwfKKgHxBeevZP53E100bNs24z+6dPVq9UBe+n7xV2lOlG64Lg0k1xx2zsM9WW8UJWbBQ7XkueVsZzkbDOBwBrs0UvKC9xesGVVjN2CEBV2q/Q3yNhE6Xtn0BXsXebi+iBZkFWBemtlV7ycQfotGkQ/CWOVFinPW6L4UmlsjrokfPzSA7Gzs/bi0BKNHRa40U2b2fJydRP4rg1z6p39SU7c/35ZdPTDfnPjFlgJmhZ/l7Vva6F65LFSOXC5MtIrsKALIYGJtfs+5ZKNgTmaOWS9ozq9ttdMJ+I7ZAwJBF3gRx4wDVOusxyM6W6DtSC8Pt1G4mlIbNbH17C+tV5+gzB7RbmtsXfmwFM3q/9hLZF5xv7mwP3N6a7VuS7Q7N7jV2j4vRIaMmxCOvnLYoEdT4Ynq57Az8qyN6qS2a/yV+n21u8VGAsZ02BUpVNgmQLDpLIMvgtjD9hb/g2YqTQ43ml1IzLI2NWrQ1LswrAbnovs4Fe5v4dS42K/SsYeHFqPO9NmG2itNDFz2cD6781qc605ComwULS/r6eafAPskHILU6Xna8agVvcK84cSUrTeht3OwM+ZujOVppU2B+zjvEQ1nc+ZnQnDvsG8sfmG2nNrtRhXFg5LrnmBeoFpyDmy2aqG5EG0aKHeARpSoM2mJp4Sw8UMpMIiGY98qlVVCjk1jMss6KDKODTjSuQZS9EbKXz7GZdZLuQU9f8cVWbLKyfMBRizRkktQ74OQDKwXOSG8bGqbIupMZuCBN2w05MOKE2lJzx1SLlkIDMEjpxzG3DZYZbKJhOU8LZgfV5a/8hLfFteLlsdW5OL1myQW+72B3U4iBZf2i7lz8rGtMni1zho/M5JrVcXo9HqtvwkS63Qz+fjHNhraYWdO82B7OBzNuNlCRLl0ZnjscrmuPK0NB4fGRsupF9yw0yVzhg37KuQtD2TWiiTG55X8HXAvKIOFCa0QFkFntd1T9xJtPZfD9gHcFvi82s3zEvHQwHmy9OZtaW5PDzMVGoOKA47SFVxGMK3uORzrfKcfj8kmHFad3/GppXInPkolIYgMT+k8fpZ63TfX8wNzP1La//5tTa7mjQDCcO+SlJqiVvHrwMC59aK3Yo8DyLPOHMt2VfflPlFmrNbYWcMaFP5jfH/xjggCsszbnmfKK5GJrS5NeRww10IypGmF5C538le/QvJaE9jVEZqw2ukcQ4H7I3SzFukwRIJwkes+ur+Jef6K61t+IKe5VfH/nHjaaFjpSS8m5Ap2zyXosqtKHNwY+E+6my88Hl1s4VfdtjSnSSaS3S5uUSDiGeZwJ94ft0aySVzesaebxlt/MyLOrjxHLUz3habFKNmTPllhmGKZTGIWgy+f4RPK4mcENM4MkTRae+JVkVD8HNDUVZ5TtGra1eViVWbGy7pub4GGC7DpiYtL+Stl/74F2Fn8TsJsTN+0WJ9q7dedlxTXJrF4K81/zOsOVJaa7CX+fALKh8l87mL/jCVscFsHLAri59LZYxAF8sqNuM3wGo9lMMN5JRx8GYkGIparUSp0GmVc/3UwV3ym58tpWt7GkQ9UcCYy28JT1NMYSUZ5GAhqXxGKSlDVL8+QhhzA8vhwYqzthQmYNpKyOlbSvaxGTcsjMbq0WgNloDdgBaTeSJk6pJ8SeZygg+J7F/oBuCozI+KlhNDlzEwGl9AdsCuc+AGWIqZSOekoMfq4fhUoDlYPwWeY0ZlngSKjzoBZK8fkI0BZDOPHoCFMKihEq0qi9tmQ1ToWiQuUdwPsePkLwF97/qHRLMwLJhdjyukkVMlJ2Jqami1r7kT11Z7t8G8sAyX1DIlMQ8XnNmiMrbtWPQDC7OdcGPDbklyUQi7AWFP451Z+AYRh0Qp0WBmpqo8Q8zcc7bGnJSghcoavCCzJJw2rEFZN+nF1s/L1zKjI4nWzqEIys64ZMesUNLODPqEk8pWGhy+1B1zJkJmlbF6nhjIXR4/kVykJklVBknjmK1F3LTenZ8/Y1+GfXvEcTuEfpjHBxhEE36veI5W5DnLxFTUamcDXBMAmC3gGpG6truj/SBSwmpWwZ54sA6rFQUkajJJSpWLdJ5IXmy51sVeTCz61rcLopK0oyCr9wtPU13xvD5XWYNqqdkOmvuF6+fOXgLHxjmqcvSsajyMAAowa4CXQMY18YmUTdax03UXtC/d5s6Ap1bc0HER0XAxrsfAcACmJpOQ1VmHGYoyV3MAs82y1413X/vXoSvjGraXgDHP8fwpqcp79OV6a70J1UsuKT3Ks99o2d1oZvOyz1QuMtTq+J8DHNwKckQf0ivyRSi1G0EuBfMI0AL5xV8PDdPFjwarPn8hT7oP2ICV3mXTgLKqJKyFWpvHWsweRRSvXBsWSDAMu0wrh0H4lBwrrtEND+0ekn9hD6PDz+qhakgOwspkHhDBR8o9CkPJHgpL/QF6yAJjcrlj0ZxbkYDE/FHSKv1QdEK5Flu35e7btDnppHiv8W8cFndCTlKOus/hbTZswP+Yfmxnjj1mzliuyW/nEwuuXGYbL2C11+78u6796ic99J4027hJTVCekvmNckOH4zSLkFrcFv9S+x9CvkTpXsyhdRPS4JFDMtXKGEx3hMElUDCwydfxLXZ3d4BihNqjCHFBBxJ5LbgiVBGwBUv3M3U/Ub1Bs3MkTLkVN10G+T3eVJI8kL65dvRbANwQ9faYaPUHyMTjeFBNh1kfP/xKSO4P3TC3cGWNS6c3GJ3bkeEJGc8t6DVoE09lc9z+Q8CFYWNA5VYDDkctHaiUahSGHEAPtpKFysREkNoOkEM28yHBhhOjcmWxHQDHySWWO0VpQN94LW7mxkJRNwo6vOsbkBYwSaiyuddPcO1/RAEtU2p2tWSUnvQ4C/5dFFXRxWkqXXKc8yNCff09BUAvwmPAlTgaDomruVLfqnITLx8RWHC4QgxABaBPzbODaPnsqznX+dxJutfhQ9TJlYfxY/wzPhodU4lDW6GNc5V+A10bf0q6CTlROwl/h1qvM0wS4R3hpTygkEzpDDTaJ13JsD2603djr+LcPJ96cQzYqnycSfGscU3NftPpwNw8pwlkeJSaWP79MaeFfiE54H48Zvl3RuPtN8dV2FuIossJuyKRB5/mkhgGjRWy0D8gl0ug+ydpKoO5iB1T7NtMSmBRiyfeNoL3TqGB5CCbakyzUnJlaeqc3SbXfKX7Pqm6mggLRFg9eBNDROsAN1b5R9EuHZd1+BdG89qYUug8nSV2psHMVJ4l4I1P1Dq/6yKgaUGNdXdeBb6gCFDa5oaLnPvDPPT48xtglJt/8fIn9jGAY8Eyts6PlDKUjEAj+YvQwK7kgL1VN8A+Kqw81ewVp+PItsG8AW123aahbx2+BCKdsyPKi3FroSgpiLXKu3SMN/UcFQonuhyqsrGaxPS7JxjCTDGV3CqNqT0u8u3Selzk+6T0uMjbgW4XQIi7Q3Zsxk1S//rw2RR3mlsfeODi1qMxKg/ygGox0FDgitPReUgeNF3GMEFiWCeATGcSbpFocPSwLjzJhKlvIoSts35i7dY77L5WbiGcW/V6Pxv23joSW1SWvmqB7tSSDh55etkwm/DRaBTzbHgenwBeARs+5/HZ0dnz8/P0eHx0drFh0p3rMHv4/u2rMbX9dFrjki3fjxkwuh5zEHW5ElDUV0j2ROH6B9XnPOpJ676GR/nEe9vuiP/JQdBh/6l640E0EVKYWeKznGhdsZDAuV6PkJP2DHIxvlW4sy1rBu/kBHPlvJiESN/nhRmrAWxytPsqvkXhETLNqww1uiOEukWDMSsyk7oSpR8bg4h0Kbsqnd1NL3ZD1vos8a1Wcsp89N0d4w9R7iHmTiWDxFg7ZPH+EKU7dH0KB9MDdjQ6Pjl91rPFZkrC3vUQ19g7VEOETX40XDooxYqDXKSbMg29myerXAU4rDt6bG0dPL6zMzCt8t4mWeWOcDoB/DaJ7F5Ym+sIPrbvzjQ1GbT6bl2wNtt5ymGP5+q2Vd5AtVybihua2H7vbAIOGar5ugLRzhE8zAD1JL0lcz6sud/m+4bbm0MaxTvaQUvhRjMbLB3+Tn32ikCwJhgyRj+xJ77Pk+YmgVR4I7EQ1oZWJliVMTcifeTonFOZX9DfwdskJ2O3EFYCZKZlh3wY2ON/BL6F641rZkc/78zwX7AsPOiZKR2Lau+y6qZQY1gbqhV0j5ijJ09ifZK8k3Nu7oYyqkxPLTNVWSptWUbOUT7vnvB7dRTm4E5AHzwP3Sl+aEF2A2ad06xN5WJCG5vsV/DyBvsy2Sl7WdFWGdmHSTIW2s52H+UVnatPGHWvQ2NvQalswjmApHO2O6ata0H3ceK983424nDy/Ogszji/iE8gO4vPT2EYH51DdpoNAc6PTzeoNHeFfvegNM85eyPsH1NMxWVU8ctRmTe3jVGGZ53TMAPoI1KI2L0I3RPoPDCnRtnZePJ8lMZjPp7EJ/xoFJ+PLkbx8ckQRtlFysej8w2c2k8LXRku+Iz9HXQuZM0mdxuZWHTrb69sx6HgU4M0zp+u8x6b63bW12ptLGH13mhb0ttFl71I6uBSbqwPXWq2d7SGvTsRI8Mj2AH7BeAbppqkndHVu38B70Mdkia17n3gUCkMtEnbq5ZBXb46unRbMV5T7I4dagBXKOmlMja+OYrrCo24rpbM4v5d1bmHxedLInjArqSLQnAq0p1/ZYBpXoPwl982eGJal/+felm/MU45PMOLrCZVJVyyr37a5lJX8is9GeO9YMd8MgeX0f/F9DJK/OL6Kv5nndYTCHQGPCPvprnv2b3VEZ4aGA1Hp/HweXx0iledMpjwKrfuCZvwfbH2AQd3VQ+1fIxSkLEX11chI8i4MSoVdCxM0QVdtcMGeLuQ7tlJFE3RFD8NXJvWxdUnhn0uhKQDxRbtHW958lLEvqeQ0//2BOPW52cIA68MuvDOc7gRj8DYkpONbNKa7sbOfa/MEJkNy7FY+KcTwNi/q4yil+4Ye97sfd+qqKKMDZXCuZzidk8tta/Fdc2Hf7dm5ZLcXi/ztOBoSEHcUCa6/ULGhndy6hcvfN16R2K9l9I/Y38nJjzcNDyKh5TOvP9Fm31eq1naZp2O+z9qcrXylIowzmQ2zsfAFWcIt21bTknI4oWrXA2V+55DaVh3OsQ3o/Z/fWjtBGTwC1an0H2tqL7r1qKy/hWbBvsJId/3uad9kLvnoTrdgGvZw9boAV4ueh/6uxU3PUvd3QnRVg++rL4QFvufY9Jk4fUJUwL/BtzMY7quveTHXjcGt90QtXCsbkBrkZE6pmiVUFqQhhIbaA+dG7L2YTy6Zlh1HshDLb/cz72EVzd2z+w0jbr464Z98+jvuDyfFgE3L7QB9aNw6KuQ5ceX/6LDm6PD2ms5vGvs0uKw32+hkibvLlQaH3ULBpOXwtnLOIOCjGbP+0yF6iyFoxe7cxH8GWe4hnAvzWtNZyDraJb4MzIgPIL4Ac2ZsyU9TyHW4o+DB7tKT04B1+T4dG+uE4mYLlkyXtkZZtZCBcEg+kBlXz8ygqOwZoDFIEIz/b4x8K/DPuuLyBoT2XpN0BmlbZ4P9K/9kT5uvz7Yeq3wlH7qvjM4Ik0TqpPCxiYnE50vlNhwBN12DwcReoPm3eQD6BuRQksmGseMXiw4pIaHGTIJvYWY/sajZOO7rtyyhTxVBZ2wE44nhr32e5iFok70CzOVVkV4TvK//Dso3GXMvTP3KozK3uNbFT4t6k6fUaj9r//byDCuG+7DgssWnZfuKkFvKNqBf9c4bf+x2MGLsYXv9rDMuSB5p51757XL5+iGjpSCfokG0eWS59unYr6gZBmLve/u0Pf/pPPFAj//XgEGgZ+/oILTVPZJaigTFK5l0eWE56brNLdZ9fS99zifsfWudO+8wo1tahHUa+Svj7fdeXcJxEVJu4H7U8c+a9jq2Ncfb9ZcbmzeS8es+OOS9V2NWpoeqHlLu7Ft2zhev/vwkbSZi5QKRe6B5reo1PitW/Nw9IGhFH67i3Iup5VTjo4mbnC+rO5r9e7/p/WSyLJU3d25Fh/VN5CLRS1kFv+mfMXi3ycteD4= +sidebar_class_name: "post 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 a contractor. Information needed depends on the contractor's wage type (hourly vs fixed) + +scope: `payrolls:run` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/post-v-1-companies-company-id-earning-types.ParamsDetails.json b/docs/api/post-v-1-companies-company-id-earning-types.ParamsDetails.json new file mode 100644 index 000000000..02a817035 --- /dev/null +++ b/docs/api/post-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/post-v-1-companies-company-id-earning-types.RequestSchema.json b/docs/api/post-v-1-companies-company-id-earning-types.RequestSchema.json new file mode 100644 index 000000000..32d696828 --- /dev/null +++ b/docs/api/post-v-1-companies-company-id-earning-types.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"The name of the custom earning type."}},"required":["name"]},"examples":{"Example":{"value":{"name":"Gym Membership Stipend"}}}}}}} \ No newline at end of file diff --git a/docs/api/post-v-1-companies-company-id-earning-types.StatusCodes.json b/docs/api/post-v-1-companies-company-id-earning-types.StatusCodes.json new file mode 100644 index 000000000..26692c3e8 --- /dev/null +++ b/docs/api/post-v-1-companies-company-id-earning-types.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"201":{"description":"Example response","content":{"application/json":{"schema":{"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":{"name":"Gym Membership Stipend","uuid":"f4dc8972-8830-4c07-b623-349a04b040d7"}}}}}},"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/post-v-1-companies-company-id-earning-types.api.mdx b/docs/api/post-v-1-companies-company-id-earning-types.api.mdx new file mode 100644 index 000000000..1af19abbf --- /dev/null +++ b/docs/api/post-v-1-companies-company-id-earning-types.api.mdx @@ -0,0 +1,73 @@ +--- +id: post-v-1-companies-company-id-earning-types +title: "Create a custom earning type" +description: "Create a custom earning type." +sidebar_label: "Create a custom earning type" +hide_title: true +hide_table_of_contents: true +api: eJztXFlvGzkS/ivc3ockgNqWZcV2/LSZONn1QyZGjs0unKBNNaslTrrJHpItW2P4vy+KR186LDn2ww4mwCATiSx+LNbFqqJuo5t4WmkjYy4MTBU1XIrYLEqITi8jKCbAGLBoENGybA/R0fdBZOhU47C3VAkupuTzogT7hQJdSqFBR6e30Wh4gH8x0KniJU6OTqO3N7QocyBhZDSIUikMCINjaVnmPLUL7f+mccJtpNMZFHSZUjSIHNxITn6D1ESD6CYGR96u75fC/xW0wIFvqJ6Rz7zU0SCqKs6i0yh7eXRwkr4ax8COWTw+PDqKJ6N0HGfZ8CWMD4fDo3EW3d0NolLJEpThjrYjeBsQaKO4mEaDHsTPMyA4ksiMmBkQ8PzCWXvRXQCxDZnzs9VEkOeUfRD5Ijo1qgKEehNvOKDfK66A4Zd2cTxNbpBLYXCMgxHcGl7OaV61mfrPRUHeo8AoPeMl+WR4CYK1ODxm6cmr41F8cnI4jMfp8DieHI0O48PxKzocT4bjITuO7uyfQTQejpdP+ldpyDtZCUa+CUK+CeQHbgS0AYaSJCuVAmESNBHSELjh2uyR9/QHEF0psGwrlZxzBox8+XJ+Rrgmc5pztvdN4FbHo9Hysl9EqWQKWtNJDuStMNwsagRck4IuyIyWJQhyPQNhV5lItsCDWshKBYwEBZxyoQkoJZUmukpnhGpyxYUFkVBjFJ9UBhLL3KsBkcqSCxQyynNNWAXESEJFMxNl0qrL1R75BG6nl2/dMm+ogalUHPT35zNjSn26v89kqves3u+lstgPeh6XdKFkntvv9y3MOK2nvyDTijMgmVSkkAoIA4OAkHkPVt9V3P2LuX3m9i1cW3/dhlGDu7bJf96YFaoUXUSDiBso2p+vp5r8AJzgUS7WrGFH3Wu9PpWQ8oyDxoP0yminE5mmldJ7aJ14SvN8QQwe/Q9YEM5AGDcLx9dnuF9SRQswgAKQU9R/IxuS1qjWqHeAhhRwLIqXo0TQygRSwXp4KSNTJauSi6kmVDCSUkEmQCrt0EwqnjOSohwUfvyMCpajIebCSW/Lo+6R86xZiGtyJaxhS9w5Xg0sOHdW5JrneRB5QokbSa78UOIPaUGuuZkRcCbLfWlZU6C+TbfwXBdhv14aCZ3IyrTOLiZTEKCaU/OkAzN0pTKaOoZQQUAw5I/yKAxl1NBVotiF8SYot4Ic5lQYgvOQpheQhddk7wK4IFanufRmw1ukSQ575J1UxPu0QYeExWdZdeX+ThDVlT3b8Ak6syvH/knjTND/SgEfsuj08r69FFVuOIY+liLqUU/xwsfLyha+2UGlu2trLqZhZZxGGeP4Fc0vWith/LBybceQ+6Xm13as4zhqZrQtNqlULvJjmhhppaHF4PtX+CL47xU05kFZu9msZyk6650pWTQELxuKosrz6Hs9rioTIzcP7Ni5VQO0oQY2Dblrwqz3Xvrjr9zM4g8CYuf8orv1o9572XFD8WjuBn+d+Z/hzJHSWofd5cNXND5S5AsX4BK+0W3skXODH5dSa44hlpFkRudAajuUwxxyjWfn3UhwFLVZiVKu0iqn6rmDG9vgJ/5gBe5F1N7higFOoLt3sgkVPxKaprISJmGQg4GkElklGLCkpIsChOkEMZedWCOaUHdlrF18tBSsRS03F72rBONi+h7MTDIyo5qE1Ui9mj2DDrA5KJ4tEi6s6KaItJSaPyqy/2IYgKsSvyp6Try9TIDY9TmwPXKRA9VA0hmkP1yQghGrh0NogRPRta/bAs3xerhIAsUn3QCy1y9IJgCi2ccKgAXXaKESJSuDarMemB+RiAovmash9oL8DtCPbj5x81Engtv1uLwkJKkUGZ/qGloda+7EteXZbTCvDcEjNUQKIE0wW1TatAOL1cDCbjOqTdCWJOcFNxsQrhi8MwvfIWJPg1gaRM9klTPETD1na8xJCYpL1uAFwRLmreUalPWQldhW8/KtYBgPQktz7A3KzKggh6SQwsw0xoRZZSoFDl8qi5IKVG5WaaMWiYYcUpTuRFCe6iSVDJImMFuLuBm9Oz9/xbkE564Qx+0Q+mWeHmAQTfi9ojl6kSPC+JTXZmcDXB0A6C3gap66sbuj/cRTi1Uvgx17sA6r4QUkMsuSUuY8XSSYwtrurIsHMbFYdb59EJWwGgWs1heapqqieaI260xn2A6W+7WbR3BezbFJjqYcI6saD7EAOeg1wDHPZ024S6Rs8o69qbugfeOUmwFNDZ8jZEfD3XE9BoILEJllIauzDjMUZS4XAHqbY68H7372b8NUQhVsLwETmlORQlKV99jL9d56E6o3VNgMKWW/2WN3q+nNxz6TOWdo1fE/BziEFTYQfcyo6I0zJnUYYUMK4hGgB/KHvx6akObpYNUpZhtJrwI2IKUP2RSgrEoBa6HW7rEWsycRxXM3hgQSBK9dupXDsPikmEiqMAwP4x6Tf0GHMeAn9VI1JAdhaTOPiOCzzT1ybZM99lrKRScLjMnlnkdzYUUCAvNHGIQZRVMjVSJtuWUttv7I3dW0JuDue01847Awq7BWytH2ObyNwgb8TxnH9va4ws1pQ5WN22lmQNm7/jZRwPKs3fl3UcfVz1bQe9aocZOasHlK4hVlDsL4XYTU4rb4O+N/CnmH0r2Yw+jmSoMlh2SqpNaY7giLC7CXgU2xjh+xe7gD9o5QRxThXtCDZKMWPJGZrNQ2geHDXN2/kHpLcwRMqeHzPoO8jqfoB/NHtDcXjn4LgFuiVo9MyT9AJB7Ho1o6zPr45Zeu5L7ohrmFc6NdOr3B6MIOhhUymhtQa9Amnsrme/tPAeeaTACNWw04lFp6UG2qkWsbAHqwlSgk4xm3ZjtADtnMxwQbKkbl0mE7AI6THZY7Q6lBzb0V1wttoKgHBRvejw2sFdBJJlVBN932u+N/xgB1KTVaLYhNT3qcBb3hRVX0cepKlRT3/IRQ396kABhFeAx4EgfDoeVqLuWPqtzEyycEFgKucAewLQfP9Yu9qFv7auo6l72ke319iHq58rB+jP+MD0aHuMOOQZvkMv0Bqnb+NunGRSZ3Ev4etZXBsJUIHwh38oBcEKkYKPRPqhJBPfrbd2sv49y8n/pwNJiqfJpNUdaEpvph2+nB3LynDBiWUhNDb55yWxgX2gDcr0cMvSF2vYftcRn2FqLocsKuSeTRt9kRw2CxQhb6J+SyA3r1JnWlMRexY4p9m01xbGrxxNtO8N4tNJAcZF1N7K6kWDqaOme3KTRfmv6QVF1NhAQipF68uUNE6wA3Xvln0XbKZT3+hdW8NbYpdJrOEjNToGcyZwl45xO16nd9BHZbUGPdnVeBLygCNm0zpzynvpiHEX8+B2Jz86/f/It8DuBI8Iyt+pGU2iYj0El+5QrIuRiQ93IO5LPE5jpFzqgtR7Yd5hyU3lVNw9z6+hKI9GpHNi9GjYGitJdYI31IR2jTz1GhcGLIISsTyyy233uC4ZrJp4IaqTC1R3m+XVqP8vwhKT3K8/ZFtw8g3LtDdmxGdVJ/+/jZFFfNrQseeLj1asS2B3lAtRgoKPDEbek8JA+aKRPIkBj2CSDTiYBrJBoCPX4DLGFcTyqlwRaTmrr1mo21R++gfa3cQqhbrYx+NujeOhJdDNIkGfaVdrh71gJttc4OcVx44u2xIcvoaDSKKRuexGOgxzEdHtH4+OD46OQkPZwcHL/asOlArbDV7ofE/q7A5+bX/tNZjVNyxrEWTs5c8XlA3mBRei/qcyWgwP6I6kE3EIfCzQ+mz0XUGNqXXZTPfLTtSvzP9oINaw53U7LG5v62kYo1PcfXVPdlJMq44HqW+CwneldsJHCh1xPkpD2D3B3fSNRsQ5rFeznBXLooJrGk74vCtFEAJjnY/RTfo/BwkeYVQ4vuCKFtUaD1ksykrkXp59awRPqUXZfO7q4XpyFrfZb4WkkxJf723V/jD14+QMydSQaBd+2QxfuDl67o+hz2pnvkYHQ4fvlihYrNpIAH90Nc4OzQDRGU/GDYKZRix0HO002ZhpXKwyrXAQ7rSo8t1cHynZmBbrX3NskqV8LpXeC3SWSvhLW5j+Bz+3lA05NhT9+dC/Zmu0g56Hgur1vtDbaXa1NzQ3O3f3A2AZcM3Xx9gWjnCB5ngXqT3pO5GFbf7/P9wO3doV3FB9rBSqGi6Q2eDr+3cx50A8GeYGDEfkWe+TnPmpcEQpISVMGNCaN08CoTqnn6xLdzatv8gv0O0aYNMna7wgoAplt+yF8DV8QfgW/Xvjl8ze7s1zsz/Cu2hQc7M7VlUeVDVtU0agxrR7WE7glz9DaSWJ8k7+WcHQLM4RPbmZ4aoquylMoQZoOjfNGv8HtzFPbgKqCPnofuNT+0ILsFWa+ataldjCttkoc1vLzDue7FW+ea1I+brX/IkglXZrb7Kme2rp4RO72+GnsPatsmXABobc52Zdq6F/QhQbwP3o9HFMZHB8cxo/RVPAZ2HJ+8hGF8cALsJRsCnBy+3GDSbDXsAZfSPKfkHTd/TDEVx2zHL0Vjjtc1ggprZXjWq4ZpwBjRXhHrUrNnwoqLziNzasSOJ9nRKI0ndJLFY3owik9Gr0bx4XgII/YqpZPRyQZOPcwKnWvK6Yz8AirnomYT8iVfWBZd+9cr23EoxNQgtIun67zH5r6d9b1aG1tYfTTalvR20+VKJPXlUmzsD+0Me/BtDWf3bowES7AD8hXgB6aahJnZp3f/BboKdUia1Lb3ka9KYaFN1l62HOpdp4G/81oxXtns3n0w+0sIFOrnsv+3EcPdIPrY8hv3behP4kDuBtGvtQe5b89/uZK/XMlPuJLw+r22Xue4t1JqE88P4rq9K65brVnsfwWgvgT13k265kNav0Jt/2bAN/FNnGeYVefC9tR2f1PAX73r+znRqI6okwPXaWEfQaqmHZdjEkYboAyVyvY9dhPIuKBOZQmn5MqbH316rbiBqwgLaf7C7Y7H/6pAs1V8jiSsWbS63uT33dO15n159xXZ3apfUbBv//1jNb+CNS5+0f/E/7Q/ifH64jz+d122sKvPgDJri5v1M5pr6K9yhjspuPBvitGaxGjiGXl9cR5KF4RqLVNu+1csm+2bYByAz6Dtg2CBPpQ3XZoDN6b1wv6ZJpcFF7bzoUV7x+fotOSxn8nF9O+eYNz6+AXCwLfN6DLWcRvbFKoCX8GNhqOX8fAoPniJD1kZZLTKDWpq8/ndnf8lCtDmF8ls5qR/rFv/qkD/EeRj/E7HKq2xr93a73Ut6e8//TsZQfdvYl0C/QFUL2L7vBzTOg7AZ6/j7SFINJZzUIozqy9W4/EcbgwIbVMwqE7Ozq39rZdBgHnPb76gkgRSfZw1jS7e1VO6uJupHj9Khi9fOANoDYSZRafR/vxgvzaF+7eNgbjb7xtD217l7UmlclRfrxO05E4lYgaF1YslYTiDQvaY7ejFrkaDX+Pe1hBeSfNC2XrMOpolfo1b15BWyuYSL29DrPc6xbjzdYVMuPzeHvUJlcDJ3YqxtdAjxKC6+O8JUGVNWf+tvSUR22ehhFZmhrnA0PMwiD7ZRrWfWcFRWLPA3SBC5f7YmIXl3+9pTHtoaArxubXbaAZRpELVum1zBhHaZf0h+wRqzlNoHV1jIu2PHOzbgfsMUaIpie2/sfqs/dSlh7mQp7KwRXmL45kmb70ykdAHihaaybRCp293/Df/0ynUJdn9Ds/CquQj/ryFz6S6gjXKnv/2H42o2d8mktoUVLTobAoA+vhvG2P7fxU4eOEzcGP2y5xyK6VWK2+9zbiM5rZ0FaxGNIhOO4FF13B8x1ca2uC821t02l9UfneHH/9eAUaHl9/RYCnbWGpVlHF7IVwTDLQZ+/yjdx0vyLpAZM2OwptwOyKYy8g/UG/HSe6ZiYtTdgP3Jw9aVrLVsW91xFdzufFhbxyz3I9jNSOWYpNmBlrK0mwc23Z2Fx8+fY4G0cTHQ4W0bl3Ra4w56bU781BcwYAJP7uNciqmlbuWOJr453+izQew +sidebar_class_name: "post 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"; + + + + + + + + + + +Create a custom earning type. + +If an inactive earning type exists with the same name, this will reactivate it instead of creating a new one. + +scope: `payrolls:write` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/post-v-1-companies-company-id-locations.ParamsDetails.json b/docs/api/post-v-1-companies-company-id-locations.ParamsDetails.json new file mode 100644 index 000000000..f6a212df9 --- /dev/null +++ b/docs/api/post-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","required":true,"schema":{"type":"string"}}]} \ No newline at end of file diff --git a/docs/api/post-v-1-companies-company-id-locations.RequestSchema.json b/docs/api/post-v-1-companies-company-id-locations.RequestSchema.json new file mode 100644 index 000000000..386c92a87 --- /dev/null +++ b/docs/api/post-v-1-companies-company-id-locations.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"required":true,"content":{"application/json":{"schema":{"type":"object","description":"Request body for creating a company location (company address).","properties":{"street_1":{"type":"string","description":"Street address line 1.","example":"300 3rd Street"},"street_2":{"type":["string","null"],"description":"Street address line 2.","example":"Apartment 318"},"city":{"type":"string","description":"City.","example":"San Francisco"},"state":{"type":"string","description":"State code (e.g. CA). Must be a valid two-letter state code.","example":"CA"},"zip":{"type":"string","description":"ZIP code. Must be a valid US zip (e.g. 12345 or 12345-6789).","example":"94107"},"country":{"type":"string","description":"Country code. Defaults to USA.","default":"USA","example":"USA"},"phone_number":{"type":"string","description":"Phone number. Must be 10 digits.","pattern":"[0-9]{10}","example":"8009360383"},"mailing_address":{"type":"boolean","description":"Specify if this location is the company's mailing address."},"filing_address":{"type":"boolean","description":"Specify if this location is the company's filing address."}},"required":["phone_number","street_1","city","state","zip"],"x-examples":{"typical_location":{"street_1":"300 3rd Street","street_2":"Apartment 318","city":"San Francisco","state":"CA","zip":"94107","country":"USA","phone_number":"8009360383","mailing_address":false,"filing_address":false}},"title":"Company-Location-Request"}}}}} \ No newline at end of file diff --git a/docs/api/post-v-1-companies-company-id-locations.StatusCodes.json b/docs/api/post-v-1-companies-company-id-locations.StatusCodes.json new file mode 100644 index 000000000..b17c832c7 --- /dev/null +++ b/docs/api/post-v-1-companies-company-id-locations.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"201":{"description":"Created","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"}}}},"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/post-v-1-companies-company-id-locations.api.mdx b/docs/api/post-v-1-companies-company-id-locations.api.mdx new file mode 100644 index 000000000..67533fd5c --- /dev/null +++ b/docs/api/post-v-1-companies-company-id-locations.api.mdx @@ -0,0 +1,75 @@ +--- +id: post-v-1-companies-company-id-locations +title: "Create a company location" +description: "Create a company location, which represents any address associated with a company: mailing" +sidebar_label: "Create a company location" +hide_title: true +hide_table_of_contents: true +api: eJztXFlzGzmS/ivY2gfbESyKlKiLT6vxsaOIddvRsqd3VlaUwUKSRLsKqAZQktkK/veJxFEXD5GytLvd0Q8dbRWBxIcE8kQC95GGtFTcLKLx9X30WuYFFYuLNAWtL0ozj8bXN8ubXsRAp4oXhksRjaPXCqgBQknq2pNMphR/65G7OU/nREGhQIMwmuDPlDEFWhOqtUw5NcDIHTfzmsCY5JRnXMy+CN8WdI9M7SfS+CIVuZPqWzWe7pMLormYZVANktMF0aBugeRlZniRge1Hs6xHilIVUoPufxFfxBUXKeD3lWloQhUQXU40GE3ktP6hR0oNxMyB/FfVFgQrJMe5GvlFXM/A3LxUMB3PwMS3w7jqW/0r4ewVQrouC0YNuNZFua01FYQLxm85K2lGFKRSMTsJncoCxuSrmwIHPb5T3MDXqBd9j2elNjLmwsBMWVqxWRQQja8jyCfAGLCoF9GiaDbR0U3dVek7OovGRpXQixToQgoNOhrfR4eDIf5v3b5AoqkUBoTBJrQoMu6mcvCrxnb3kU7nkNNVAp/mUO8d2wW5T0W1uFyQ/0Rk/agXublEcvIrpAb/5ibDD2FlLAvgO82LzGHWpd3XiTbUlPZL6gAn1ETj6HBweBwPTuLB+afh0Xh0NB6d9weDQTw4HQ8GUS9yq7Wp8fGg1dhvqaQsOYvG0XBwfH5ET2h8PDiexCNKT+LJ9GgYD49ZylIANoGjqBfdgtKOEzCcMHY2Oqaj86P0dHQ+OJuewfCYnQyHo+HJ+QTxONInk+HR8ZAexgyOjuPR6Pw8npyPzuLREZ3QyeHp6ORoFPUibRSASYbRODoaDMiRYuTKfqp/O4zG0UVBlclBGHI0PMN5WNUQXVFB3ikqUq5TaXtQg7x+fRH1ot95EY2j89FwcGpnXgqjsNPnK/yVpobfQthExVwKSESZT0BF4+hsMDg/OhkcneHsnbwnfq1DD68Z2p+Xy15UKFmAMtwtruPGfdgV2iguZlFXc+EG+/z58g1uK5TiIGTE7SLcVgoo+yCyhR+osSi7EE9LpZB7vlMYx5MnV+C0x7X/HfXbrOQMbl7OjSn0+OCAyVT3rfj1U5kfBEmNC7pQMsvs7wecQV5IAyJdvCJTqQgXU6lyPxdB5vKOGOmVFddkyiFj/WjZ3Zg78wvHQOBBVRrpVX2LixPIpJjpPkEGEi7SrGTACJ+ubYZEKhOwlvXt3bIKtu4wpZmGdegtCeJIVLMISPrkZ/it5AqY/WnFDvTJB0uLZvZ3yItMLgAaDZCltWg9iHDZFLbQ+rpuLsosQwW82s0J4m4DWNncpamV3F0aVkK90xpMaZkZrwCWayS4IjKRMgMqVrbdVQEpn3LQK1uH6+Y2fKGD4xAsxOO23nJV+XRN0x6Qpk+AqNdlES5Cw1o9JLhvqAHDc7D79m4OooXXU0KiTav2Y0Q9JSQadP6DC40S6sxxVyP3yaVwZBpu2ZzeApkACMIgAwOsRyalcS6f4VnmGsy5NlLxlGaEUUNX3E4zh3ytuuHiDwl8iV+cGkNlYjX7zXKJ30eD0epW/kka8k6W4gcctYoE+SII+SKc4/ZbCRrBKtCyVCkQJkETIQ2B71ybPnlPv6FfrZwRLJS85SgSl28OrJHhmtzSjLN13l1zhqCUVNZRbfsA/nu9elQpuoh6ETeQN79vppp8A+yQUgMzqRYbxrCtHhSXWmXczcHP2XYnMk1Lpfvk06LA1c4Wzkp/gwXhDIRxvbA9NUbxSWngoKCK5mBAEQWZ3RNG1iSdbQ+o94CGFLAtbmNHiVg/xpMKi6Q98pmSZcFRX1HBSEpRf6GbYdFMSp4xkqLvkvv2cyqY1YZckIUs0VGpQg2LOQet6WytvWpD/hiAMDCUZ5rQiSxNg6kxmYEAVbPTkw4odammNHVIqcCwDYEj55ystIMFIU0ytULS2FjXrfWP/I5v7pdxo2NjctEGAbmjTj5sh360vEEgIZD5SZrYCln8FgeNP7hd6yX78HBVLD+LQkmMcegkA/JWGG4WGCV+suygCzKnRQHC6W7k3ESyBa68XRqPj6BOoFz4JddEl+mcUE2+cmHFM6k2ZXJLsxK+2gDb1DMkU7tArATP66onSpJd+68NX/itG+a14yEHvaczbGHGadX9lXOprZXKpYKwY/pfxOM13nrWOt33F3MDc//S2n9+rU0up/VAXJOvwiq1xK3j114j4CV33KbX7JYnlLiW5KtvSvwiLZx7A1aovGD8vzEOiMJQ9MfWbcVOAiwIt4IMbqkwzo8zMmyQhZdkr/65IFam0YO2asNrpEkGffIOI05nkXotEhafZdVX9/8EUX21axu+oBP41bF/Unta6FhJAR+m1pRtn0vInrqxUI46ghc+rwpb+GUPkW6P7VO6bi6YQ2KMuzj8Y2Mkn1FaHdsx5OFd8xPNIbjvnqNmTpvbJpXKpT0ZBmh2NzQY/PAInwX/rYRaPdQpCEfGUnTae6pkviUnULUri8TI7Q1bem5dg06KYLVJwwt573d//As38/iDgNgZv2i5udV7v3dcU1yaZe+vNf8zrDlS2miw23z4BZWPxNyHjf4w8bHFbPTJpcHPhdSao4tlpAuKKz2UwS1kNtz2ZiQYikqtRClXaZlR9dLBbfnNr6LmDNc0iNZEARMqviU0temvxIXuSSmmpWDAkoIuMFOut0QIE6qhHR6sOGutMOFdKRgXs/dg5pKROdUkjEaq0ewatIDdguLTRcKF3bopIi2k5k+K7J/oBuCoxI+KlhNDlwkQOz4H1icfM6AaSDqH9JtzUtBj9XAIzbGj7m+eAs0wt7FIAsVnnQCy1w/ocjPVPNYAzLlGDZUoWRoUmy1RoWsR0tZrIXac/BbQn13/kLPmmgSz63H5nZCkUkz5TFfQKl9zL66t9m6CuTAEl9QQzKLXzmxeatN0LNYDC7OdUm2CtCQZz7nZgnBN471Z+A4RexrE0iB6LsuMIWbqOVthTgpQXLIaLwiWMK8tN6CsmqzFtp6XbwVDfxAakmMjKDOnghyRXAozt0ec09KUChy+cF7DBSu1UYtEQwapPRgWlKc6SSWDpHbMNiKuW+/Pz5+wL8G+a7bjbgj9MM8PMGxN+A2Pyo0kJ4TxGa/Uzha4OgDQO8DVPHVt90d7xVOLVa+CHXmwDism2xM5nSaFzHi6SATNd1zr/FFMzNetbxdEKaxEAavkhaapKmmWqO0y02q2h+a+cP0I9qs4NslQlaNnVeEhFiAHvQF4Ada4Jj6Rss06drrug/a1E24G9hAAITsaLsb1GIg9RpHTacjqbMIcjhz1LsteNd5/7d+Grrb0ZecdMKEZFSkk7uznUdZ6G6rXVNj0KGW/2mV3o+ntyz6XGWeo1fE/Bzi4FdYRfUqvyBdMVW6EdSmIR4AWyC/+ZmiYLn42WNX5i/Wk1wHrkcK7bK6mSwrYCLUyj9U2e5ateOna1KftGHbpRg7D4pNiIqlCNzy0e0r+BRlGh59UQ1WQHISVyTwhgk8298i1TfbYsJSLVhYYk8sdi+bcigQE5o/QCTOKpkaqRNqzwo3Yui33F9OKgIv3av/GYXHVFXaXo+6ratU6+J/Tj+3McY2Z04Yq67fTqQFlY/1dvIDVXvvz72PlV79YQ+9FLcZ1asKVC3hBuQVh/CxCanFX/K32P4S8RelBzKF1HdLgkUMyU1JrTHeEwQXYYGCbr+Nb7O/ugI0RKo8ixAUdSNZrwRWZy1Lt4hg+ztT9Hak3JEfAjGIRQQeNl/EU7WD2hPrmo6PfAOCGqMRjquTvIBKP40k1HWZ9/PArIbk/dMPcwqXRLp1eY/QlJ66+14DagDbxVLbH7T8EnGsyAVRuFeBw1NKBalONWDLE87C2pcgl41Nu1XaAHLKZTwk2nBgVK4vtADhOtljuFKWtp3ZaXC+0gbxqFHR41zewWkAnrihxBz/Btf8RBdSmVEu1IDY96XHm9DvPy7yLU5eqoDjnZ4T69jsW+gIjHgOuxHAwsFzNpPxWFtt4+YzAgsMVYgBb8flSv+pH7bOv+lznupN0r8KHqJMrD+PH+Gc8PDyyJQ5NhTbJZPoNVGX8bdINq1n32vwdamudYbsjvCPcygNyQaRioNA+qVIE8ehO3429inP7fKrF0WDK4nkmRVntmurHTacDc/ucpsDwKDUx9PtzTgv9QuuA+/GIod+JHe9xc1yFvcNWdDlhf6PgqafZ2oZBY4Us9A/syxbo9ZPUpcZcxJ4p9l0mxbGoxRNvGsEHp1BDcpB1ObGzkmJlaaqc3TbXfKX7Y1J1FRESiJBq8DqGiDYBrq3yj6JtHZd1+BdG89rYptBpOk/MXIGey4wl4I1P1Di/6yKw04IK6/68CnzBLWDTNreUZ9Qf5qHHn90Csbn5i9d/J58COBIsY+P8SEptkxFoJH/hCsil6JH38hbIJ4mVp4q8ofY4smkwGzc19nabqvAlEOmcHdm8GDUG8sIGsXi7wrp0hNb1HKW2hd+CyNLEchrb3z3BEGbymaBGKkztUZ7tltajPHtMSo/yrBnodgGEuDtkx+ZUJ9WvT59Ncae51YEHLm41GrHlQaH6PWwDBTmuuD06D8mDussEpkgM6wSQ6UTAHRINjh7/DixhXE9KpcEeJtXn1hsm1my9h/Q1cgvh3Gqt97NF9jaR2KGy9E0DdKeWtPfM02MDNqWHh4cxZYOzeAT0NKaDExqfDk9Pzs7So8nw9HzLpAO13J52P8b3dwd8rn9lP53WGJM3HM/CyRt3+Nwjr/FQuh91uRJQ+FuBj0bhbwN41ec8anTtizbKF97bdkf8L/pBh/1f1RvjzRfB9TzxWU60rlhI4FyvZ8hJewa5GN9IlGxD6sE7OcHqFqwl/ZAXVt3E2nsV3+Pm8Xd0CCWOULjCs7JnUlei9GNjWCJdyq5KZ3/Ti92QtT5LfKekmBEffXfHwFtf+29zp5JBYKwdsni/88Idur6E/qxPhodHo+NXa0SseY1v/5GbN/iCkA8HrYNSrDjIeLot07BWeFjpKsBh09FjQ3T8DRzdKO+tk1XuCKcTwO+SyF4La3sdwafm3Zm6JsOuvlsXrM12nnKQ8UzeNcobjL9MuLG4oY7tH51NwCFDNV93QzRzBE8zQDVJb8mcD6sftvm+4e7m0I7iHe2gpVDQ9BZLh7/bPo+KQLAmGBixP5EXvs+L+iaBkKQAlXNjQisdrMqEap4+c3RObZlf0N/B27ROxn4hrABgumGHfBi4xv8IfLvzxeEbZmd/3pvhv2BZeNAzM3ssqrzLqupCjUFlqFbQPWOO3noSm5PknZyzQ4A5fGIr01NDdFkUUhnCrHOULbon/F4dhTm4E9Anz0N3ih8akP31yM5p1rZyMa60SR5X8PIO+xLRKXtZ0VbM2odpMuHKzPcf5Y09V58S270Kjb0FtWUTzgG0Ome3Y9qqFvQxTrx33k8PKYxOhqcxo/Q8HgE7jc+OYRAPz4AdswHA2dHxFpVmT8MeEZRmGSXvuPl9hqk4Zit+KSpzDNcICqzdw/POaZgG9BFtiFgdNXsmrAl0nphTh+x0Mj05TOMJnUzjER0exmeH54fx0WgAh+w8pZPDsy2cepwWutSU0zn5G6iMi4pNyJdsYVl052+v7Mah4FOD0P5VmZD32F63s7lWa2sJq/dGmzu9WXS5FkkVXIqt9aGtZo+O1rB3J2IkeATbI78AfMNUkzBze/Xun0DXoQ5Jk0r3PnGoFAbapu1lw6C2r462bivGG4rdsUMF4BJ3eiG1fYWoqtCIq2pJVj9NFGE22XudbrJW/Y6j/47t4zzxxcfL+B9VGo3jZYA5UGa9ifp+ZfcWBYgyx3sJ4Wmd4XF003xNovF9ufIyAWLJufBX41Crxsh1Ri4+XlaPsXTv09urbdgAb/PZe20CtwKvi416rk3jougLTa5zLuwBXoP2nrcqacHj+gmYf/cE48bnV/ZJBW1NYa/icL0cgbEFtTZp+zM3vlvrBpe7SbNpOZbLm16ITf4mmY0Wun13vkm7/eLPz42KJvcMC/pcLqfXfZGFvAxffGhuDynb14G2PcfSuU/ZivJJxgWQIRL0V0BW30ra9f2Wh8c5bI/Tfndpy3svnQuH9j5Rk1D7paZtz8F0MdrK9DqYf33xqk/eV7UxTombOxlnYNAj1lWHNoDX9s2XDS/LtMf8n8uPjsDKOJ+vbG6hkVZAVWz/EZ+cnp2/ao/p3p7a/k5N96ambeiHf+OUjH2E5fPVRT/qvmLTHMy/avPQ20SdC6qNJEY93SqLYXcxni4obHw9iM9v7oeDZWvcxltZP/CozsI9QMP1Hm/qrH8f58mGm3ZH6zxo0kkfNZN8Lg8Xkma46W66V7iMu61dZRLbKuJ/+TG0bc+frayof0+py3n3JlPD2PuwPA4P38Veo/qXIgydoZWu3sXzL/zpAug3oHoRo22J5S0oxZk1MjbmtXvPgNC2C1p558xsfFbQXlYsH35eEM1Zm5R7ZrDq717jqRttQlp1CIjRZvnDBOfLOKmaR+Po4HZ4UHk1B/e1HV0eNP0aW+jknZpSZei4eLNOC+6seswgt6Z99XkkyGXUZq2jF7vTEvwZ57WB8FqaH5U9GdlEs8CfcdrhGc8rNLpu4695zLMSWhw8OGNWiIEqK1xdLel2lr16SWhp5phvC3UFvejKFoP9yAiOwoYBlr0InYmfazfkbdCGfxQZdp7SupcNbZ7YlTkFQbbeM3qVracgG35vL0I3V3+YXoG65Sk0tlHtcdqnDw5swwOGfEXnKLZ/45m09l1XrutClsrcHtVbHC80eevFmITqUHR4mUzLPDzP+W/+QRXqUu/eS30TRiU/46MXXrbcMTbKgf/1P+ptb99zlNrkVDTobHxntgv+vvZF/3qc9g/xOK3XEga+m4Mio9yqE6sY773Kvo5uh9VDqu75iXEr/Mma9myO2n58Hd3fY9j3WWXLJX7+rQSU3OsbtBXKVtha3c64jYzZ+ocjm9vpZXgh8hXZHFWtnU24HG9bBEsV+Zv6zUjO3bdxAfJ+4P7UYe8Gtjr2rU81VFyu3YfXjlnxp5aLshqw1j3QnBVma9umn/Hxw9WnqBdNfJCcS+tDKXqH0Ta9c2seTpkwisZv91FGxax06R5HE1UgbdvQymb6fzQebWnvqvt71+KT/AZiuaw2mcG/bWpo+S9WhtqG +sidebar_class_name: "post 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"; + + + + + + + + + + +Create a company location, which represents any address 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:write` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/post-v-1-companies-company-id-pay-schedules-assign.ParamsDetails.json b/docs/api/post-v-1-companies-company-id-pay-schedules-assign.ParamsDetails.json new file mode 100644 index 000000000..02a817035 --- /dev/null +++ b/docs/api/post-v-1-companies-company-id-pay-schedules-assign.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/post-v-1-companies-company-id-pay-schedules-assign.RequestSchema.json b/docs/api/post-v-1-companies-company-id-pay-schedules-assign.RequestSchema.json new file mode 100644 index 000000000..8afb1e976 --- /dev/null +++ b/docs/api/post-v-1-companies-company-id-pay-schedules-assign.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"anyOf":[{"type":"string","enum":["single","hourly_salaried","by_employee","by_department"]},{"type":"null"}],"description":"The pay schedule assignment type."},"hourly_pay_schedule_uuid":{"type":"string","description":"Pay schedule for hourly employees."},"salaried_pay_schedule_uuid":{"type":"string","description":"Pay schedule for salaried employees."},"default_pay_schedule_uuid":{"type":"string","description":"Default pay schedule for employees."},"partial_assignment":{"type":"boolean","description":"Indicates whether the request provides pay schedule assignments for a partial list of employees or departments of the company. By default, this is set to false."},"employees":{"type":"array","description":"List of employees and their pay schedules.","items":{"type":"object","properties":{"employee_uuid":{"type":"string","description":"Employee UUID"},"pay_schedule_uuid":{"type":"string","description":"Pay schedule UUID"}}}},"departments":{"type":"array","description":"List of departments and their pay schedules.","items":{"type":"object","properties":{"department_uuid":{"type":"string","description":"Department UUID"},"pay_schedule_uuid":{"type":"string","description":"Pay schedule UUID"}}}}},"required":["type"],"title":"Pay-Schedule-Assignment-Body"},"examples":{"Example":{"value":{"type":"by_employee","employees":{"employee_uuid":"f0238368-f2cf-43e2-9a07-b0265f2cec69","pay_schedule_uuid":"c277ac52-9871-4a96-a1e6-0c449684602a"}}}}}}}} \ No newline at end of file diff --git a/docs/api/post-v-1-companies-company-id-pay-schedules-assign.StatusCodes.json b/docs/api/post-v-1-companies-company-id-pay-schedules-assign.StatusCodes.json new file mode 100644 index 000000000..c798ffe95 --- /dev/null +++ b/docs/api/post-v-1-companies-company-id-pay-schedules-assign.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"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/post-v-1-companies-company-id-pay-schedules-assign.api.mdx b/docs/api/post-v-1-companies-company-id-pay-schedules-assign.api.mdx new file mode 100644 index 000000000..4cb81957e --- /dev/null +++ b/docs/api/post-v-1-companies-company-id-pay-schedules-assign.api.mdx @@ -0,0 +1,72 @@ +--- +id: post-v-1-companies-company-id-pay-schedules-assign +title: "Assign pay schedules for a company" +description: "This endpoint assigns employees to pay schedules based on the schedule type." +sidebar_label: "Assign pay schedules for a company" +hide_title: true +hide_table_of_contents: true +api: eJztXOtvGzmS/1d4fR+SAGrZVhzb8afN5HFr4DIx8rjswjHaVHdJ4qSb7JBs2xrD//uhimS/9LDkB3A3mAEWs2ORxR+L9Waxb6LreFoZq2IhLUw1t0LJ2M5LiI7PIijGkGWQReeDSIMplTRgouObaLS7i//KwKRalDgnOo5+V+ytkhakjW4H0f7u/rIhln1QlczYD8nYD/l1BkzDrwqMhYxpMKrSKbBMgWFSWQbXwtgh+8h/AjOVBmZnwEqtLkUGGfv27eQdE4Zd8lxkwx+Slh2NFpf9JkutUjCGj3Ng76UVdl4jEIYVfM5mvCxBsqsZSFplrLI5UxM2V5UOGFmqpOVCGgZaK22YqdIZ44ZdCEkgEm6tFuPKQnLJ8wouBkxpIhcoTLjIDcsqYFYxLpuZqgTH/Ysh+wJup2fv3TJvuYWp0gLM+fOZtaU53tnJVGqGdHTDVBU74ajiks+1ynP6fYdgxmk9/QWbViIDNlGaFUoDy8AiIGTeIEr96R3fRLwsc5ESnp0/DDLxJjLpDAq+GXf/Zm6fuU6nIjX+A1IboT79qoSGjPSMkKCWlRqhWuHUzP/9+CbM5lrzeTSIhIWi/ffVVJOfgBM8yvmKNWhUQ85YLeQ0GvQO+ksJqZgIMHiQXhlpOlNpWmkzZF/npUh5ns+ZxaP/CXMmMpDWzcLx9RnulFzzAiygAOQc9d+qhuQQlblGvQU0pIBjUbwcJYZWJpAK1sNLGZtqVZVCTg3jMmMpl2wMrDIOzbgSecZSlIPCj59xmeVCTpmQTnpbdnPITibNQsKwC0mGLXHneDEgcO6s2JXI8yDyjDM3kl34ocwf0pxdCTtj4EyW+5FYU6C+TeFuzpyG/XppZHysKts6u5hNQYJuTs2TDswwlZ7w1DGESwYyQ/5oj8LyjFu+TBS7MN4G5daQwyWXluE8pOkFZO412bsAIRnptFDebHiLNM5hyD4ozeCaF2UOgw4JwkesunD/ThDVBZ1t+EtViezCsX/cOJNhNIiUhE+T6Pjsrr0UVW5FmYNbC/Wop3jhz4vKFn7ZQqW7axshp2FlnMazTOBPPD9trWR1BUvXdgy5W2p+5wVpEImJ46id8bbYpEq7kCAzzCqShhaD717hmxS/KmjMgya72axHFJ31nmhVNATPGoqyyvPovB5XlYlV6wd27NyyAcZyC+uG3A4iK2yOO/vopT/+Luws/iQhds4vul096qOXHTcUj+Z28PeZ/xXOHCmtdNhdPnxH46NkPncBLhNr3caQnVj8c6mMERhiWcVm/BJYbYdyuITc4Nl5NxIcRW1WolTotMq5fu7gxhT8xJ9I4F5E7R0uGeAE+jr2Npc2OObyZ8LTVFXSJhnkYCGp5KSSGWRJyecFSNsJYs46sUY05gbagclxtBCsRS03F32oZCbk9CPYmcrYjBsWVmP1anQGHWCXoMVknghJopsi0lIZ8ajI/o1hAK7K/KroOTF7GQOj9QVkQ3aaAzfA0hmkP12QghGrh8N4gRPRta/aAs818GyeBIpPugFkr1+QjQFks48lAAth0EIlWlUW1WY1MD8ikVUxBr0cYi/I7wD97OYzNx91Irhdj8tLQpIqORFTU0OrY82tuLY4uw3mjWV4pJYpCawJZovK2HZgsRxY2O2EGxu0JclFIewahEsGb83CD4jY02BEg5mZqvIMMXPP2RpzUoIWKmvwgsySzFvLFSjrIUuxLefle5lhPAgtzaEMys64ZC9ZoaSdGYwJJ5WtNDh8qSpKLlG5s8pYPU8M5JCidCeSi9QkqcogaQKzlYib0dvz83ecy3DuEnHcDKFf5ukBBtGEXxXP0YscsExMRW121sA1AYDZAK4RqRu7PdovIiWsZhHsvgfrsFpRQKImk6RUuUjnieTFhmdd3IuJxbLz7YOoJGkUZLW+8DTVFc8TvV5nOsO2sNxv3DyG82qOjXM05RhZ1XgYARRgVgAvgZxr4gsp67xjb+o2aN865c6Ap1ZcImRHw+W4HgPDBZiaTEJVZxVmKMpczQHMJsdeD97+7N+HqYxr2FwCxjznMoWkKu+wl6u99TpUb7mkCinP/qBjd6uZ9cc+U7nI0Krj/xzgEFZQIPqYUdFbZ0zqMIJCCuYRoAfyh78amlT26WDVJWaKpJcBG7DSh2waUFaVhJVQa/dYi9mTiOKJG8MCCYZpl2nVMAifkmPFNYbhYdxj8i/oMAb8rF6qhuQgLGzmERF8pdqjMFTsobRUyE4VGIvLPY/mwooEJNaPMAizmqdW6QSTsDXY+iO3V9OagMv3mvjGYclIYUnK0fY5vI3CBvxPGcf29rjEzRnLNcXtfGJBU66/SRSwOGt7/p3WcfWzJfSeNWrclCaoTsm8olyCtH4XobS4Kf7O+Ach71C6E3MY3aQ0eOWQTLUyBssdYXEJlAysi3X8iO3DHaAcoY4oQl7Qg0RRC57ITFV6k8Dwfq7un0i9pTkSptyKyz6DvI6n6AfzR7Q3p45+C4BbolaPiVZ/gkw8jke1dFj18csvpOT+0g1rCyfWuHJ6g9GFHRnekPHcgl6BNvFU1uftDwIuDBsDGrcacLhq6UGlUqMwFAB6sJUsVCYmgsx2gByqmY8JNtwYlQuH7QA4TnZY7gylAX3prbiZGwtFPSjY8H5sQFbAJBOlC74u2++Of4gB6lJqtFoyKk96nAW/FkVV9HGaSpcc9/yEUN9fpwAYRXgMeBJ7u7vE1Vypn1W5jpdPCCwEXCEHoJaD5+bFMOrefTX3Ome9onudPkS9WnlYP8b/jPdGL3GHHYM2zlX6E3Tt/KnoJuREbSX8PWpLg2GSCB8Id+qAQjKlM9Don3Qlg3r0t+/WXsS5fj/14RiwVfk0m+JZE5qa+22nB3P9niaQ4VVqYvn1U24L40IKwP16zPJrRuvdb4+LsDcQRVcTdk0ij77NjhgGixWq0A+Qyw7o5Zs0lcFaxJYl9k02JbCpxRNvO8E7t9BAcpBNNaZdKblwNHXNbl1ovjD9PqW6mggLRFi9eJNDRKsAN175oWg712U9/oXVvDWmEjpPZ4mdaTAzlWcJeOcTte7v+ghoW1Bj3Z5XgS8oAlS2ueQi5/4yDyP+/BIY1ebfvP0n+xrAseAZW/dHShkqRqCT/C40sBM5YB/VJbCvCpvrNHvH6Tqy7TAvQZtt1TTMrdOXQKR3d0R1MW4tFCUlsVb5kI7xpp+jQuHEkENVNlaTmH73BEOaKaaSW6WxtMdFvllZj4v8PiU9LvJ2otsHEPLuUB2bcZPUvz5+NcXd5tYXHni49WqM2oM8oFoMNBR44nR1HooHzZQxTJAY9gkg05mEKyQaAj1xDVmSCTOutAG6TGrurVdsrD16C+1r1RbCvdXS6GeN7q0i0cWgbDLBvtIOd9+1QJPW0RDHhSfeXrabTfhoNIp5tnsU7wM/jPnuAY8P9w4Pjo7Sl+O9w9drNh2oFXTbfZ/Y313wufm1/3RW45i9E3gXzt65y+cBe4uX0sOoz5WAAvsjqntlIA6Fmx9Mn4uoMbQvuyif+WjbXfE/GwYb1hzuumIN1f42kYoVPcdX3PRlJJoIKcws8VVO9K7YSOBCryeoSXsGuRzfKtRsy5rFezXBXLkoJiHSd0VhxmoAm+xtf4ofUXiETPMqQ4vuCKFt0WDMgsykrkXpYWsQkT5l16WzvevFachaXyW+0kpOmc+++2v8Kcp7iLkzySAx1w5VvD9F6S5dn8NwOmR7o5f7r14sUbGZknDvfohTnB26IYKS7+12Lkqx4yAX6bpKw1LlySrXAQ6rrh5bqoPXd3YGptXe2xSr3BVOL4HfpJC9FNb6PoKv7ecBTU8Gnb47F+zNdpFy0PFcXbXaG6iXa11zQ5Pb37uagEuGbr6+QLRrBI+zQL1J78lcDGvu9vl+4ObukFbxgXawUqhoZo2nw99pzr0yEOwJhozRT+yZn/OseUkgFStBF8LaMMoErzLmRqRPnJ1zavML9jtEmxRkbJfCSoDMtPyQTwOXxB+Bb1e+OXzF7ujnrRn+HdvCg52Z0rWo9iGrbho1dmtHtYDuCWv0FEmsLpL3as4OAdbw6c0STy0zVVkqbVlGwVE+79/we3MU9uBuQB+9Dt1rfmhBdgtmvdusde1iQhub3K/h5QPOZbLX9rJgrTLyD5NkLLSdbb/KO7pXnzCaXqfG3oNS24QLAMnmbHZNW/eC3ieI98H74YjD/sHeYZxx/jreh+wwPnoFu/HeEWSvsl2Ao5ev1pg0ug27R1Ka55x9EPbPKZbiMur45WjMMV1jqLAkw7PebZgBjBEpRayvmj0TliQ6j8ypUXY4nhyM0njMx5N4n++N4qPR61H8cn8XRtnrlI9HR2s4dT8rdGK44DP2G+hcyJpNyJd8Tiy68q9XNuNQiKlBGhdP13WP9X07q3u11raw+mi0LentpsulSOrkUq7tD+0Mu3e2hrN7GSPDK9gB+w7wE0tN0s7o6d2/gS9DHYomte195FQpLLTO2quWQ73tNPB3XivGS5vdB1G70f23ECg4lv1/jhhuB9Hnlt+4a0N/EQdyO4h+rz3IXXv+25X87Uoe4ErcP4Ootl4nuLdSGRtf7sV1e1dct1rTm+IEn1ZnVQ4m5gbLuAsvhig4BJmVSkjL3CDTutm0ihp2ajoMjRGZQax5hD9Tm8Pwh8T3kxfjpoXWP5Acz/F5DNcW93PREBvgg08idIG/Cp4nDoEb1+TZVjnGqNy99a0HMZOqEvDttWXC4rgLfK524cuARLM13LDn1IpmVAGtTSrNGnwG+0U4BcwvHPwJz40nOanyHj00rOsoKZnCi+EP+UMS1GPcautcjq+0sHAR4W2h362TQbKOTbpLWbuQZPvJoDWXGO59XvOIvvtU7nbxxF23QXiR51cgC+oX/Vf8X/TphjenJ/H/1HcztPoMeEYOp1mf2NNf5R3upBDSP5xGkxk70XlzehLuZ5CTKhXUpEO1Hnr4jAPwrTe9epYYKIimFXXgxrQ+I/DMsLNCSGrvaNHe8s09L0XsZwo5/U9PMG79+QXCwAfc6BdXcRt7MaoCn/qNdkev4t2DeO8VvtbNYMKr3KI5av5+e3s+iCyf4oFjlMS+BKlw38WgRO03lVHdqH/eG39Tof8EtPuQM/Q8cTnvPlFe2JB7LBoNImfFEsNzrvG92CBqabz7r0YHovPWM1R69Xh7vkwi20amrd9kWKLbetW28mz4OPS0TRqV2JvhWmuJftjOo6wQiPXW8FJwnyXeualdPlGLb2eFRTPaIj1WKge+6ANOZEYFWfr8gp1B99sX9XcNVhyRexrAa2ub48NT/EbCKqPYtTtD9tucecYMXJ8edjMAGXMyLe45cLsBfu0b2P9eWB+NuJ2B0F1XNlz3OL733LnfFrb+sDpdXZF/8fYQmXJ0KABocXJjVnRc0oOZ0VDbWHbDhMdnyG33CwlE4rxJyk75PA5WNX5Ty2xMVrWXj713/78TzAfN6Ri47mOMrmhEk93Ry6OXB0fxZJRO4v2XMIpf893DeLw7Ong1GaWQHryOljIgSkeHhzx9NYpfHx3uxfv89UHM9+Ag3k33918fHO0f7I54VEeC17Epgf8EbuYxfWzE5YWND+kOQdceq0vQWmQkMSEehGsL0lBBHs2/i3pXfrxpEHjT/ogTmvgwrw+qntAFt3xKF2Qz1YNF1+Fvrl3sS4y0s+g42rnc26mj4J2bJmy63enEWzv1vqnB1gdblc4xtvEBAy+FixfiDAoKGpaIdKF6DHb0YndLjz/jFlcQXkrzVNON/CqaJf6MHDCQVppuk85uQrb/JsXKw5sKeXF23h6FLC+cqC4ZW0s4QgxxDUk8cE1xXv9rK0Qipg8DMF7ZGd4Gha63QfSFWpUfsoKjsGKB20GEAc7nJjRqKW0wH704ZZmm1SZmnddvG6KVfrsZtMz1ulCtZS/OFg1Gi8BK6i5mahn+syVmeENKdFnqen2DlaRoH4NnVLnQ0NWOVAcRRvPm0+QL6EuRQkumm8Cavv+zQwN3Mjw+dBox/Tc2Zhk/deGbFZCnmI5ZxQjHM8Pee8vCwhMJjOszlVa4WxKF//BfFePu/tnnLe/CquwzfvnJXzK6Xi5USv/rPxodRIlCQ1Jw2aLjHEUv8XVRTsiWeru4aeLxv1Pq/zMptbcIFq7tTplzQSaKTPKN9xtn0SV1rgTPEQ2i407K3aGMn8hx7uMczYuxSODmBs/vm85vb/HPvyrAKtHZOXovTQ9MnLoKKgyvyJfb8vP8sw9oXrBVufqKrYVgkEYE3xn5D9W0SwnuualL5bcD9xfP65ey1bFveVGk5nIT0PhvVcZfO/HSYpbezEB/Wdq1Y9uRz+mnL18xz/aVgUJRQKf5FZZl+JU789BkgaUD/NtNlHM5rVx50tHEf/4XT10vNA== +sidebar_class_name: "post 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 assigns employees to pay schedules based on the schedule type. +For `by_employee` and `by_department` schedules, use the `partial_assignment` parameter to control the assignment scope. Set it to `true` for partial assignments (only some employees or departments at a time) and `false` for full assignments (all employees or departments at once). + +scope: `pay_schedules:write` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/post-v-1-companies-company-id-pay-schedules-assignment-preview.ParamsDetails.json b/docs/api/post-v-1-companies-company-id-pay-schedules-assignment-preview.ParamsDetails.json new file mode 100644 index 000000000..02a817035 --- /dev/null +++ b/docs/api/post-v-1-companies-company-id-pay-schedules-assignment-preview.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/post-v-1-companies-company-id-pay-schedules-assignment-preview.RequestSchema.json b/docs/api/post-v-1-companies-company-id-pay-schedules-assignment-preview.RequestSchema.json new file mode 100644 index 000000000..8afb1e976 --- /dev/null +++ b/docs/api/post-v-1-companies-company-id-pay-schedules-assignment-preview.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"anyOf":[{"type":"string","enum":["single","hourly_salaried","by_employee","by_department"]},{"type":"null"}],"description":"The pay schedule assignment type."},"hourly_pay_schedule_uuid":{"type":"string","description":"Pay schedule for hourly employees."},"salaried_pay_schedule_uuid":{"type":"string","description":"Pay schedule for salaried employees."},"default_pay_schedule_uuid":{"type":"string","description":"Default pay schedule for employees."},"partial_assignment":{"type":"boolean","description":"Indicates whether the request provides pay schedule assignments for a partial list of employees or departments of the company. By default, this is set to false."},"employees":{"type":"array","description":"List of employees and their pay schedules.","items":{"type":"object","properties":{"employee_uuid":{"type":"string","description":"Employee UUID"},"pay_schedule_uuid":{"type":"string","description":"Pay schedule UUID"}}}},"departments":{"type":"array","description":"List of departments and their pay schedules.","items":{"type":"object","properties":{"department_uuid":{"type":"string","description":"Department UUID"},"pay_schedule_uuid":{"type":"string","description":"Pay schedule UUID"}}}}},"required":["type"],"title":"Pay-Schedule-Assignment-Body"},"examples":{"Example":{"value":{"type":"by_employee","employees":{"employee_uuid":"f0238368-f2cf-43e2-9a07-b0265f2cec69","pay_schedule_uuid":"c277ac52-9871-4a96-a1e6-0c449684602a"}}}}}}}} \ No newline at end of file diff --git a/docs/api/post-v-1-companies-company-id-pay-schedules-assignment-preview.StatusCodes.json b/docs/api/post-v-1-companies-company-id-pay-schedules-assignment-preview.StatusCodes.json new file mode 100644 index 000000000..e139df814 --- /dev/null +++ b/docs/api/post-v-1-companies-company-id-pay-schedules-assignment-preview.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Example response","content":{"application/json":{"schema":{"description":"The representation of a pay schedule assignment preview.","type":"object","x-examples":{"example-1":{"type":"hourly_salaried","employee_changes":{"employee_uuid":"43b39ada-dc49-4879-9594-fe95f67ae434","first_name":"Penny","last_name":"Parker","pay_frequency":"Twice per month — Salaried pay schedule","first_pay_period":{"pay_schedule_uuid":"3f029a58-155d-4c30-8361-cc266b2c1f11","start_date":"2023-07-01","end_date":"2023-08-01","check_date":"2023-08-02"},"transition_pay_period":{"start_date":"2023-06-20","end_date":"2023-06-30"}}}},"properties":{"type":{"anyOf":[{"type":"string","enum":["single","hourly_salaried","by_employee","by_department"]},{"type":"null"}],"description":"The pay schedule assignment type.","readOnly":true},"employee_changes":{"type":"array","description":"A list of pay schedule changes including pay period and transition pay period.","items":{"type":"object","x-examples":{"example-1":{"employee_uuid":"43b39ada-dc49-4879-9594-fe95f67ae434","first_name":"Penny","last_name":"Parker","pay_frequency":"Twice per month — Salaried pay schedule","first_pay_period":{"pay_schedule_uuid":"3f029a58-155d-4c30-8361-cc266b2c1f11","start_date":"2023-07-01","end_date":"2023-08-01","check_date":"2023-08-02"},"transition_pay_period":{"start_date":"2023-06-20","end_date":"2023-06-30"}}},"properties":{"employee_uuid":{"type":"string","description":"The UUID of the employee.","readOnly":true},"first_name":{"type":"string","description":"The employee's first name.","readOnly":true},"last_name":{"type":"string","description":"The employee's last name.","readOnly":true},"pay_frequency":{"type":"string","description":"New pay schedule frequency and name.","readOnly":true},"first_pay_period":{"description":"Pay schedule assignment first pay period information.","type":"object","x-examples":{"example-1":{"pay_schedule_uuid":"3f029a58-155d-4c30-8361-cc266b2c1f11","start_date":"2023-07-01","end_date":"2023-08-01","check_date":"2023-08-02"}},"properties":{"pay_schedule_uuid":{"type":"string","description":"The pay schedule UUID."},"start_date":{"type":"string","description":"Pay period start date."},"end_date":{"type":"string","description":"Pay period end date."},"check_date":{"type":"string","description":"Pay period check date."}},"x-tags":["Pay Schedules"],"title":"Pay-Schedule-Assignment-Pay-Period"},"transition_pay_period":{"description":"Pay schedule assignment transition pay period information.","type":"object","x-examples":{"example-1":{"start_date":"2023-07-01","end_date":"2023-08-01"}},"properties":{"start_date":{"type":"string","description":"Pay period start date."},"end_date":{"type":"string","description":"Pay period end date."}},"x-tags":["Pay Schedules"],"title":"Pay-Schedule-Assignment-Transition-Pay-Period"}},"x-tags":["Pay Schedules"],"title":"Pay-Schedule-Assignment-Employee-Change"}}},"x-tags":["Pay Schedules"],"title":"Pay-Schedule-Assignment-Preview"},"examples":{"Example":{"value":{"type":"hourly_salaried","employee_changes":{"employee_uuid":"43b39ada-dc49-4879-9594-fe95f67ae434","first_name":"Penny","last_name":"Parker","pay_frequency":"Twice per month — Salaried pay schedule","first_pay_period":{"pay_schedule_uuid":"3f029a58-155d-4c30-8361-cc266b2c1f11","start_date":"2023-07-01","end_date":"2023-08-01","check_date":"2023-08-02"},"transition_pay_period":{"start_date":"2023-06-20","end_date":"2023-06-30"}}}}}}}},"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/post-v-1-companies-company-id-pay-schedules-assignment-preview.api.mdx b/docs/api/post-v-1-companies-company-id-pay-schedules-assignment-preview.api.mdx new file mode 100644 index 000000000..9af47a0b1 --- /dev/null +++ b/docs/api/post-v-1-companies-company-id-pay-schedules-assignment-preview.api.mdx @@ -0,0 +1,71 @@ +--- +id: post-v-1-companies-company-id-pay-schedules-assignment-preview +title: "Preview pay schedule assignments for a company" +description: "This endpoint returns the employee changes, including pay period and transition pay periods, for changing the pay schedule." +sidebar_label: "Preview pay schedule assignments for a company" +hide_title: true +hide_table_of_contents: true +api: eJztXP1uHDeSfxVe3x9OgGlpNPrWX+fYzq2BdSzEzuUWitHmdNfMcN1Ndki2pIkh4B7invCe5FBFsr+mZzSjDyBZeIFsommyWCwWq35VLPJrdBvPK2NVLKSFueZWKBnbZQnRxVUExRSyDLLo0yjSYEolDZjo4ms0GY/xXxmYVIsS+0QX0ZtbXpQ5sNAyGkWpkhakxba8LHOREv39fxrs8DUy6QIKvkrp4wKplBoMSEtdmJoxzkq+ZNgnq3Jg3BgxlwVIy0oN1wJu9qJR5FiP1PSfkNpoFN3G4Ngivv1/xwf4h2+6UJXOl4nhOdcCsmgUQVHmagmQpAsu575n+K2qRBZdREeH08NznvE4S4/O46Oz0/P4/Pj8KJ7B+fHs5JTD0eFRNIpmQhubSF7gSJcg5TIaRTlv/cb1F9DRKCr5Mplp+L0CmS5RBjciBVaCZoWSdsH+73/+l33wPHYEUY+CFErQQmXIMP4VmgSmD2fjyTk/PosPjo+z+Cg9HMdnhycHcZpOTk6mk/RgdnAQjSJjubZJxi0yOBlPDuPxaTzGLyCz7u9n7vd0AemXlS+T6G4UWc2lEbiGPQYHRjmJJ+OhUU7iw3F0d3d3N4pKrUrQVrhVcUv4NeJy+X4WXVzVi2qsFnJOtKoCVdkIOSdZrS73dJmE1XV/ZVBybVGzok93o5qmrPI8uvs0GlDWdYqJPVErNfDsvcyX0YXVFdwNq5gfhmvNUUu6o7xkuTAWt0FnLN+dCZnmVSbknD47ITMuM9aIv/UFWRIWivaw2+yYb5vgT7AJ+nugtyirW2BVXX/55e1rVCW7ABa6D6ppe+W2IRyIvTCMujLsOki5tfw7Esae6+n2NOg+2j/BTXdD1X1p96wdZkjZupQv15gEJ5fWLhVypnRBXm5HB/bn0O4VhRxga5sl7iwDauge7pw2o/dRuWyESt0YdiMqzaR2oAEyayi0p78DDeoWqNzhalo+N+iQsNEHP12DAMsKmztjuIzDh/hlrTgx/n7plG2TRdlOCwfdwiNUcVd9WtWaP8dCP26JPtZS7azW44i+8aYvfkW+3rmAx+iRA8skrdZyevSO/3nN86otwW8I+S8DDu4cSj4aH63agp+UZT+qSmbsN8nYb9JFWb9XYCxkGLWpSqfAMgWGSWUZ3Apj99g7/gWYqTQQXCi1uhYZZA5DCMOueS6yvd8kzuRoMlkd9hdZapWCMXyaA3sjrbDLmgNhWMGXbMHLEiS7WYCkUaYqWyJAWapKBx4ZBpNcSMNAa6UNM1W6YNywz0ISEwm3VotpZSEhDf48YkoTuUBhxkVuWFYBs4px2fREQ0Rm7/Me+wBupldv3DCvuIW50gLMp+8W1pbmYn8/U6nZo7h5L1XFfoiT45Ivtcpz+r5PbMZp3f17Nq9EBmymUGM1sAwsMoTCe3CoPCTdb8LtC7fvyZBnoSGjJAdxgpazh6vd76uB2drIaYVq8gWwg+dyuWYManWvv/pQQipmAgwupN+M1J2pNK202WMfl6VIeZ4vmcWl/wJLJjKQ1vXC9vUa7pdc8wIsoALkHPe/VQ1Jh3gC1zuwhhSwLaqXo8TQygRSwXp4LWNzrapSyLkhsJ1yyabAKuO4mVYiz1iKelD49gsusxyDXCGd9raSVnvs7awZSBj2WZJhS9w6fh4Rc26t2I3I86DyjDPXkn32TZlfpCW7EXbBwJks95FEU+B+m28DMsJ8vTYyPlWVba1dzOYgQTer5kkHYZhKz3jqBMIlIZXKgPZcWJ5xy4dUscvGq7C5NeRwzSUBJo40vYIs/U72LkBIRnsa4SGZDW+RpjnssR+VZh44jDokiD8S1Wf37wS5+kxrG35BN/vZiX/aOBMEm0pCN4WzZi5FlVuBaUaiiPuot/HCz6ubLXzZYUt3x3ZJJD/LaBTxLCO/zfPL1kgYIg6O7QSyRVDKC6jDcydRu+BttUmVdlnWzDCrPPKtBXz/CL9I8XsFjXnQZDeb8Yiis94zrYqG4FVDkdJhn+p2VZlYtblhx84NNTC2A91Xm9w18Pad1/74V2EX8XsJsXN+Dh8Pt3rndcc1xaVppfe+rflfeM2R0lqH3ZXDr2h8lMyXDuAysdFt7LG3Fn8ulTECIZZVbMGvgdV2KIdryA2unXcjwVHUZiVKhU6rnOvvHLsxgZ/4PSnc91F7hgMNQsDXDtamXH5JeJqqStokgxwsJJWcVTKDDIMIDPQ6IOaqgzWiKXfHM7WLj1bAWtRyc9GPlcTk8juwC5WxBTcsjMbq0WgNOoxdgxazZSIkqW6KnJbKiCfl7B8IA3BU5kdFz4nRyxQYjS8g22OXOXADPhtDIAURq2eH8QI7omtfNwWeYwZwmQSKzzoBFK8fkE0BZDOPAQYLYdBCJVpVFrfNesZ8i0RWxZTi6QEWeyC/w+jPrj9z/XFPBLfr+fKakKRKzsTc1KzVWHMnqa32bjPz0jJcUsuUxMxhALNFZWwbWAwzFmY74y4nQB9zUQi7gcOBxjuL8EfuUr+UgiMazCxUlWfIM/eSrXn2mYCG33Zyaw2XdZNB3oZl+canv1o7hyIou+CSHbrkCp4wsVllKw2Ov1QVJZe4ubPKWL1MDOSQUhJDcpGaJFUZJA0wW8tx03p3ef6EfRn2HVDH7Tj0wzw/g0E14feK5+hFTlgm5qI2OxvYNYEBswW7RqSu7e7cfhAp8WpWmT3yzDperSggUbNZUqpcpEvK1G231sWDhFgMrW+fiUrSjoKs3i88TXXF80Rv3jOdZjtY7peuH8N+tcSmOZpyRFY1P4wYFGDWMF4COdfEJ1I2ecde1124feU2dwY8teIaWXY0XIzreWA4AFOzWcjqrOM5JHvNNsteN9597UPy2zCuYXsNmPKcyxSSqrzHXq731pu4esUlZUh59k9adjea2bzsC5WLDK06/uMYDrCCgOhToqJXzpjUMIIgBfMcuBMf4mA9a1LZ52OrTjETkh5ibMRKD9k0oK4qCWtZrd1jrWbPoopvXZv6KJph2GVaOQziT8mp4hpheF1T8oTyC3sYAT+rh6pZciysTOYJOfhIuUdhKNlDYamQnSwwJpd7Hs3BigQk5o8QhFnNU6t0ouhEfS1v/Za7b9OagIv3GnzjeMlow5KWo+1z/DYbNvD/nDi2N8cBN0eHQEiAzyxoivW3QQGrvXaX32WNq18M0HvRbOMmNUF5SuY3yjVI62cRUovb8t9p/yjOO5Tu5Tm0bkIaPHJI5loZg+mOMLgECgY2YR3fYne4A648JCCKEBf0WCLUgiuCp7PbAMOHubq/IfXWzpEw51Zc9wXk93iKfjB/Qntz6ei3GHBD1NtjptUfQAen2O5JLR1mffzwKyG5P3TD3MJba1w6veHRwY4MT8h4bkGv4TbxVDbH7Y9iXBg2BSoLDAyHo5Yeq5RqFIYAoGe2koXKxEyQ2Q4sh2zmUzIbTozKlcV2DDhJdkTuDKUBfe2tuFkaC0XdKNjwPjYgK2ASV+ayBU5w7R9jgLqUml0tGaUnPZ8FvxVFVfT5NJUuOc75GVl9c5sCIIrwPOBKHIzHJNVcqS9VuUmWz8hYAFwhBqCSg+/M93tR9+yrOde56iXd6/Ah6uXKw/gx/hkfTA5xhh2DNs1V+gV07fwp6Yb1UTspf4/aIBgmjfBAuJMHFJIpnYFG/6QrGbZHf/pu7FU+N8+nXhwDtiqfZ1I8a6Cpedh0emxuntMMMjxKTSy/fc5pIS4kAO7HY5bfMhrvYXNcZXsLVXQ5YVck8uTT7KhhsFghC/0IvewwPTxJUxnMReyYYt9mUgKLWjzxthO8dwoNS45lU01pVkquLE2ds9sEzVe6PyRVVxNhgQirB29iiGgdw41Xfiy3neOynvzCaN4aUwqdp4vELjSYhcqzBLzziVrnd30OaFpQ87q7rIJcUAUobXPNRc79YR4i/vwaGOXmX776G/sYmGPBM7bOj5QylIxAJ/mr0MDeyhF7p66BfVRYXKfZa07HkW2HeQ3a7LpNQ986fAlEemdHlBfj1kJRUhBrlYd0jDf1HBUqJ0IOVdlYzWL67gmGMFPMJbdKY2qPi3y7tB4X+UNSelzk7UC3z0CIu0N2bMFNUn99+myKO82tDzxwcevRGJUHeYZqNdBQ4IrT0XlIHjRdpjBDYlgngEJnEm6QaAB64hayJBNmWmkDdJjUnFuvmVi79Q67r5VbCOdWg+hnw95bR6LLg7LJDOtKO9J93WKadh01cVJ45ull42zGJ5NJzLPxWXwE/DTm4xMenx6cnpydpYfTg9PzDZMO1Ao67X4I9ncHfK5/7T+d1bhgrwWehbPX7vB5xF7hofRe1JdK4ALrI6oHRSCOC9c/mD6HqBHal10uX3i07Y74X+wFG9Ys7qZkDeX+ttGKNTXHN9z0dSSaCSnMIvFZTvSuWEjgoNcz5KS9gFyMbxXubMuawXs5wVw5FJMQ6ftQmLEawCYHu6/iO1Qed7kPLbojhLZFgzErOpO6EqXHjUFE+pRdlc7urhe7oWh9lvhGKzlnPvruj/GHKB+g5s4kg8RYO2Tx/hClO3T9Dvbme+xgcnh0/P3AFlsoCQ+uh7jE3qEaImzyg3HnoBQrDnKRbso0DG6erHIV4LDu6LG1dfD4zi7AtMp7m2SVO8LpBfDbJLIH2dpcR/CxfT2gqcmg1XfrgrXZDimHPZ6rm1Z5A9VybSpuaGL7B2cTcMhQzddXiHaO4GkGqCfpPZnDsOZ+n+8bbu8OaRQPtIOVwo1mNng6/E59HhSBYE0wZIw+sRe+z4vmJoFUeDmnENaGViZ4lSk3In3m6JxTmV+w3wFtEsjYLYSVAJlp+SEfBg7gjyC3G18cvmZ29Hlngf+KZeHBzszpWFR7yKqbQo1x7ahWuHvGHD0hifVJ8l7O2XGAOXxGlempZaYqS4UX+Qgc5cv+Cb83R2EO7gT0yfPQveKHFstuwKx3mrWpXKy51rZ7mVh9dbobJvVxM/mHWTIV2i52H+U1navPGHWvQ2PvQalswgFAsjnbHdPWtaAPAfEevJ9OOBydHJzGGefn8RFkp/HZMYzjgzPIjrMxwNnh8QaTRqdhDwhK85yzH4X9Y46puIwqfjkacwzXGG5Y0uFF7zTMAGJEChHro2YvhIFA54klNclOp7OTSRpP+XQWH/GDSXw2OZ/Eh0djmGTnKZ9OzjZI6mFW6K3hgi/YD6BzIWsxuRuiJKIbf3tlOwkFTA3SODxd5z021+2sr9XaWMLq0Whb09tFl4Oc1MGl3Fgf2mn24GgNe/ciRoZHsCP2K8AXTDVJu6Crd/8APsR1SJrUtveJQ6Uw0CZrr1oO9a5TwN+5rRgPFrt3byX/EIBCfSf5L4sY7kbRzy2/cd+E/kUcyN0o+qn2IPfN+Zsr+eZKHuFKwu332nq9xbmVytj4+iCuy7viutSa7hTXbwCYuHkgI/FPig28VCIMXsMslZCYLbKVlqbzkE54k2m046NMZkR5OepNmfzemyh7v8nfpElVCRfsc4fvixstLHymJxJ81O3WyL+g0MwX7yRJso204Zskv7u/1lwy714lu7vvESE/AlkYP+h/x/9J78q9vHwb/1d9dkGjL4BnZJCb8Wc8N9Af5TXOpBDSXyxGkxKjnc/Yy8u34fwCXzVRqaAiFsqF0MVgbIB3oelWsERHKppSzZFr07pm/8Kwq0JIKn9o0d7xTjovRex7Cjn/d08wbv38PbKBF5zRb6yTdvNo2WQ8Oca3HQ6OI3p2bMar3Lo3H8Lvd/gg2dq3QHwg84PKKK/SX++t3xzoX5H8K77CdleP+oAHijrv6OA29WaqLm9wjxX56TzJCIFYbwyvBQ8Z4rXr2nvwSuneCCh2wfOkkWCL9FSpHLhcof1WZpSwpOcJ7AK6b0PU9/7XLJErnccHHmno+q27pnpEadYohOnZnT32w5J5wYxcHRue9oNFtEamxV2XbReIb7wj+veV8clsL0DozhTMxpf0HvVOW6fqKfI3wh6jU44OOciWJLcWRVv6jxdGQ21r3Q0dnl4gd90XBIjEFg8pkVXd/hWlroHrXlboPZ00G08Ozw5PzuLZJJ3FR4cwic/5+DSejicnx7NJCunJeTQogCidnJ7y9HgSn5+dHsRH/Pwk5gdwEo/To6Pzk7Ojk/GERzVSuo1NCfwLcLOM6TEOFzc1PqTbBF17rK5Ba5HhlDxIamSCE7u1IA3lrtETOIC49pHZURBT+7FZtPahX5+/ukOXz+EuXX5bXVf4Rofiz3sdYiTx2kV0Ee1fH+zX2HH/awOm7vY7KGx/ED1SiaqHY5XOEf14SMFL4RBFnEFBsGJA6QvVWwJHL3bn3PgZZ76G8CDNS01n2utolvgZpWEgrTSdx1x9DfHyyxRj95cVyuXqU7sVrkThlHmgbfOSmLVlQD60J4BrQoL990qIRExX6xmv7ALPU0Ld2Cj6QMW+jxnBUVgzwN0oQgj0cwOeWts6GJgekhnai7UR2oQL2qZqrWdvGg05ZwfmWhblatWktAispe5QVcs1XA0Y6i0p0XGjq5YNdpTiAYTXuBNDSVQby44ixPvm/ewD6GuRQkunG+hNL+jsU8P9DJcP3UpMf2Npk/FdV159gDxVBVV8ER8vDHvjDQ4LlwwQ+WcqrYrw6vS/+Xe5uDvB9ZHN6zAq+xnfTvLHdK4aCjel//ofzR6k1w6VsQWXLTr+Ib77MFGIrXoz+tqg9z95UOp3jIVbu1/mXNAWJpP11dvYq+iaaiOClY1G0UUnaO1QxkdYVk3tJ9yKxiKxr18xSvxF53d3+PPvFWBO4uoTOgBN1xmcagtKQ66JPtvy/e5nDw++Z+si3zXTDNCKWgT3E/lnUdqBubvc6ALj3Zj7F4+SB8XqxDecYqil3GCCV05Y8ccO5FiNeZse6FtKu7FtGzFcvv/wEaNWH2cXiuCR5ogA8P9pzcORPgbi+NvXKOdyXrlkmKOJ//t/m2shFA== +sidebar_class_name: "post 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 employee changes, including pay period and transition pay periods, for changing the pay schedule. + +scope: `pay_schedules:write` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/post-v-1-companies-company-id-pay-schedules.ParamsDetails.json b/docs/api/post-v-1-companies-company-id-pay-schedules.ParamsDetails.json new file mode 100644 index 000000000..02a817035 --- /dev/null +++ b/docs/api/post-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"},{"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/post-v-1-companies-company-id-pay-schedules.RequestSchema.json b/docs/api/post-v-1-companies-company-id-pay-schedules.RequestSchema.json new file mode 100644 index 000000000..56923818b --- /dev/null +++ b/docs/api/post-v-1-companies-company-id-pay-schedules.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"required":true,"content":{"application/json":{"schema":{"description":"","type":"object","properties":{"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"]},"anchor_pay_date":{"type":"string","description":"The first date that employees on this pay schedule are paid with Gusto.","example":"2020-05-15"},"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.","example":"2020-05-08"},"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."},"day_2":{"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.","type":["integer","null"]},"custom_name":{"type":"string","description":"A custom pay schedule name, defaults to the pay frequency description."}},"required":["frequency","anchor_pay_date","anchor_end_of_pay_period"]},"examples":{"Example":{"value":{"frequency":"Twice per month","anchor_pay_date":"2021-10-15","anchor_end_of_pay_period":"2021-10-15","day_1":15,"day_2":31,"custom_name":"demo pay schedule","auto_pilot":false,"version":"68934a3e9455fa72420237eb05902327"}}}}}}} \ No newline at end of file diff --git a/docs/api/post-v-1-companies-company-id-pay-schedules.StatusCodes.json b/docs/api/post-v-1-companies-company-id-pay-schedules.StatusCodes.json new file mode 100644 index 000000000..e43b7c903 --- /dev/null +++ b/docs/api/post-v-1-companies-company-id-pay-schedules.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"201":{"description":"Example response","content":{"application/json":{"schema":{"type":"object","title":"Pay Schedule","x-examples":{"Example":{"uuid":"f2a69c38-e2f9-4e31-b5c5-4754fc60a052","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"],"readOnly":true,"title":"Pay-Schedule-Frequency-Create-Update"},"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"]},"examples":{"Example":{"value":{"uuid":"f2a69c38-e2f9-4e31-b5c5-4754fc60a052","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"},"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/post-v-1-companies-company-id-pay-schedules.api.mdx b/docs/api/post-v-1-companies-company-id-pay-schedules.api.mdx new file mode 100644 index 000000000..03e1c1705 --- /dev/null +++ b/docs/api/post-v-1-companies-company-id-pay-schedules.api.mdx @@ -0,0 +1,81 @@ +--- +id: post-v-1-companies-company-id-pay-schedules +title: "Create a new pay schedule" +description: "If a company does not have any pay schedules, this endpoint will create a single pay schedule and assign it to all employees. This is a common use case during company onboarding." +sidebar_label: "Create a new pay schedule" +hide_title: true +hide_table_of_contents: true +api: eJztXM1yHDlyfhW4fNBooovsbpIixcOGOfrx8qARYyR5vEEpWuiq7G6sqoASgGKzR8GIOfjuF1i/gs/21Y8yL+BXcGQCqL/+YTdF2rtj6SKpCz8fEon8QyK/RNfxtDRWxUJamGpuhZKxXRQQnV5GkI8hTSGNPvQiDaZQ0oCJTr9Ew/4A/0rBJFoU2Cc6jV5c87zIgIWWUS9KlLQgLbblRZGJhMbf/7PBDl8ik8wg5/gvN2Okxn+GxEa9yAqb4Q8XfMHeJDNIywzHu47BTUIo/IT4z7IUaXQaTYb8ydPk4CSG4eRpfAgHg3h8lBzFh8dHh5PkSZ/3j4ZRL5po+FyCTBbRafR2LhJgBWiWK2lnUS/iMpkpPSr4YpRyiyiG/WE/7h/Fg6P6M8h0pCbUqgAtVNpo1z+JelHKF6NBdDo4cv8cRqcHg14keY4jvpBTIQG0kFMcsrRqVIhM2eh0wjMDvSjBTclHvvkZkzB3ALMFK/iCmUCUm5teZx/eznAPCg0GpCWCMzVhvNVtL+pFhVYFaCscMR0Fq50w1mNbHruU4nMJTKQgrZgI0Di8nUFrAiYk+0dcA86kgaevZbaITq0uobW7cdjd+B0CuGltzjZoqubMzrhlkBeZWgAYpiSzM2HaqLhGmCJlc2FnNUCQZY4M/+IK9ILNAT5FPf8fZWegw0/LzPLK7Yk7IVus8mWAGz/TwC3E7wpispsVfLfV8oU2lmH7r1n/VtDPCF+Mvz1vQ15xFrbBnvEA3TOQWwwCdsPssbe4goRLNgZqYXgOrgs39INDQH3w510X80Km8esJrenCIb+pTm5YwmVEshF01ItkmWW41+3FnEnmm7Ax2DmAZAPGZcoOBkzIlMSenDaWmPJFWDMxUnfvwjZ5AkwEZCkTuKfZgmnI4IpLyyZ+4WF3jdtVHPW3X//S4dXffv03gvTbr3/xPIu/hNMjwOyxc8vmIsuQ1rjOdeO7E9HsuS3Rn/NFPAgUHj4QhQ0kSqZ3JnFjiMBUmwj9visT3ke1SNpjL5VmBnIRr5LdpudOqJvbzFSZpUh8A5ZZxQ4Grj91NfhdW9C4DonLTvnC9Ngc3J5RnxXQraKf/VFrk+R/aceHuONOkdUbXomF1fvd2JMAcKZKnS3YfAZyhbYxhN23qXa5xwzPuBaQbu5XtWr0xLYpFFzbHKRluAAmJkvdx4tGqx7xJJFy43w8y+qptibmj0jDm45tcJugPWOuuVsATd6C1GMpTHiZWRN4Bb/WWrUx2tZAn9GMFd6meVPBHSuVAZdLeH9GhjsrraIO//XvDCQfZ5D2EJdWSFlkCF1KhuPm3IqEZ9mCKQnE4WOYKA1soUpddUmBp5mQjtar9UFpVXxBGBFxYsUVbIN2BnQ2ljWtMIwboxLBLXh1y2WDNffY2VIHId3EjnmEfWRYKbkxYioh3V61OfBoGF7Hlk8NnremIW2ctfK5FBpS/Ei234ebXrTGur7iWfk7MLO3tqlXWuSBJ5DyN/SnFx32D5f9oB+VZS9VKVP2XjL2Xjp7/HMJBjlBg1GlToClCgyTyjK4FsbusVf8EzBTamfoFFpdiRRS9u7d+XPkjSueiXTvvUT2PBwOl6d9JwutEjAGjwt7Ia2wiwqBMCznCzbjRQGylk1jlZJKoMPiMTJ02riQhoHWShtmymSG5tZHIQnEiFurxbi0MCLG+NhjStNwYYQJF5lhaUnqh8u6Jzoc5JF83GNvwK308oWb5hm3MFVagPnw3czawpzu76cqMXvkn+4lKt8P/mjszzV93yeYcVJ1f8ympUidrMtRFKRgERASbweX9HbqfiNul7hdN74pZNyCUfS0HU//ey1rudZ8EfUiYSE3q4IDS6OOPgF28CgXa+agVrfqyzcFJOjVGtxIfxipO1NJUmqzx94uCq9ySOp/gkXtC3unJOzhfsE1zwHNNg0ZaQKvZGnIPdLmAfUO0HAEbIvs5UZiKGXCUEF6eC5jU63KQsipIfPEu1OlcWjGpcjSYCS49jMuUV1O0Ykn7m0Eh/bY+aSeSBj2UZJgG7l9/OgMJ7dXTlV7lmecuZbso2/K/CYtnHoEJ7LcRyJNjudtuoWRcxHW67mR8bEqbWPvYjYFCbreNT90IIYp9YQnjiBcMpAp0kd7FJan3K6MU7VhPAuHu3LRsB+O6Rlk4U+yVwFCMjrTGKIhseEl0jgDZ/p7fdxrDUH4iFQf3d8jRPWR9jb8gor6Y2U6B2WCJoSS8HoSnV7etpa8zKzAcB6NiOeoc/DCz8uHLXzZ4Ui35zZCTsPM2I2nqcBPPLtozORMoBVzO4LczjVonwaHyFOUnMSabRKlXTQzReuYuKFB4NtneLcUKpt4ae6GoRGd9J5olW9wkKp2ZTGyanPDlpxb1cDYVnxpuclNbVq+8twfo2Eev5YQO+UX3axv9crzjmuKW3PT+7bnv4c9JydhncLuOnJZ5gJWZOCi77xBbVAsAn0oZYxAE8sqNuNXwCo5lMEVZAb3zquRoCgqsRIlQidlxvV3Dm5Mxk/8mhjucdRc4YoGjqHbNwxjLj+NeJKoUtpRChlYGJVyUsoUUvRJ0OdvGTGXLVsjGnN3DVKp+GjJWIsaai56WcpUyOkrsDOVshlH/8/NxqrZaA9awK5Ai8liJCSxboJIC2XEvSL7E5oBOCvzs6LmRO9lDIzmF5DusYsMuAGWzCD55IwUtFg9HMZz7Iiqfd0SeIYe7mIURnzQBSB5/YRsjBHFah0rAObCoIQaaVVipHEDMN9iJMt8TBHNFRA7Rn4L6E+uP3P98UwEtetxeU4YJUpOxNRU0CpbcyeqLfdugjmzDLfUUnSlNmbz0timYbEaWFjthBsbTssoE7mwGxCuaLwzCV9yd41AgTsaoxFd5Z6yFWYfWKjxYswh3MCsQVk1WYltNS1fUFTaQuPkkAflArohzCskm5S21ODwJSovuMTDnZbG6sXIQAYJcvdIcpGYUaJSGNWG2VrEdevd6fkj9mXYdwU7bofQT/PwAANrwueSZ6hFnrBUTEUldjbANQGA2QKuEYlruzvaNyIhrGYZ7KEH67BakcNITSajQmUiWVDkaru9zu9ExHzV/nZBlJJOFKTVeeFJokuejfTmM9NqtoPkPnP9GParKDbOUJSjZVXhYQSQbidWAi+AlOvIB1I2acdO113QPnOHOwWKFyJkN4bzcT0GhhMwNZmEqM46zFW4eJttrxrvvvcvWvdiW3PAmGdcJjAqi1vk5XptvQnVMy4pQsrTP9O2u9nM5m2fqUxgJJgkuwMczAoyRO/TKnrmhEllRpBJwTwCd5FNCNZDk8o+HKwqxEyW9CpgPVZ4k42yEVDNr4VaqceKzR6EFc9dm+qmhKHbZRoxDMKn5FhxjWZ4aHef9AtnGA1+Vk1VQXIQlhZzjwjeUuwR75Ckd0uFbEWBMbjc0WjOrBi5+zI0wqzmiVV6pOjGaC22bsvdj2k1gPP3avvG393RgSUuR9nn8NYHNuB/SDu2s8YVas5Yrslu5xMLmnz9bayA5V670++isqsfrRjvUX2M69AExSmZPyhXIK1fRQgtbou/1f6rkLdGuhVzaF27NHjlMJpqZQyGO8LkEsgZ2GTr+Ba7mzvgUo2CRRH8gg4kslpwRzC3YBvD8G6q7o84euPkSJhyvG/soPFnPEE9mN2jvLnwF+U1ADdFdTwmWv0CcuRx3KukczfnNP2SS+4v3TC2cG6NC6fXGJ3ZkTLKqLCg16Ad+VE2++1fBRwTQQCFWwU4XLV0oFKoEdOMRB72tpS5SsVEkNgOkEM08z7BhhujYmmzHQBHyRbJnaA0oK+8FDcLYyGvGgUZ3rUNSAqY0UTpnG/y9tvtv0YAtUeqT7VkFJ70OHN+LfIy7+I0pS44rvkBob64TgDQivAYcCcG/T5RNVPqU1lsouUDAgsGV/ABKOXgO/N4L2rffdX3OpedoHvlPkSdWHmYP8b/xoPhAa6wJdDGmUo+ga6UPwXdhJyonZi/M9pKY5g4whvCrTigkEzpFJN4FKUV+cG6y3dzL+PcvJ5qcwzYsniYRfG0kbh2t+V0YG5e0wRSvEodWX79kMtCu5AMcD8fs/ya0Xx3W+My7C1Y0cWEXZLIvS+zxYZBYoUo9FfwZQv06kWa0mAsYscQ+zaLEpjU4gdvKsFbl1BDcpBNOaZVKbm0NVXMbpNpvtT9LqG6ahAWBmHV5LUPEa0DXGvlr0Xbui7r0C/M5qUxhdB5MhvZmQYzU1k6Aq98osb9XRcBLQsqrLvTKtAFWYDCNldcZNxf5qHFn10Bo9j82bM/srcBHAuasXF/pJShYAQqyZ+FBnYue+yVugL2VmFynWbPOV1HNhXmFWiz6zENfSv3JQzSuTuiuBi3FvLCZZorb9IxXudzlMicaHKo0sZqEtN3P2BwM8VUcqs0hva4yLYL63GR3SWkx0XWdHS7AILfHaJjM25G1df7j6a429zqwgM3t5qNUXqQB1SxgYYcd5yuzkPwoO7i83wxTwCJTtmcSgajOhfXkI5SYcalNkCXSfW99ZqFNVvvcPoasYVwb7XS+tlw9tYN0cag7GiCeaUt6j5vgKZTR00cFR54eWk/nfDhcBjztH8SHwI/jnn/CY+PB8dPTk6Sg/Hg+OmGRYfRcrrtvovt7y74XP9KfzqpccqeC7wLZ8/d5XOPPcNL6b2oS5WAAvMjyjt5IA6F6x9En7Oo/XOKJspH3tp2V/yP9oIMqzd3U7CGYn/bcMWanOM5N10eiSZCCjMb+SgnaldMJHCm1wPEpD2BnI9vFZ5sy+rJOzHBTDkrZkRD32aFGasB7Giw+y6+QuYRMsnKFCW6GwhliwZjlngmcSlKXzcHDdId2WXp7K56sZt7QUDicq6VnDLvfXfn+EUUd2BzJ5JBoq8doni/iMJdun4He9M9NhgeHB49XnHEZkrCnfMhLrB3yIYIh3zQb12UYsZBJpJNkYaVhyctXQY4rLt6bBwd/+LLNNJ762CVu8LpOPDbBLJXwtqcR/C2+Tygzsmg3Xf7grnZzlIOZzxT80Z6A+VybUpuqH37O0cTcMqQzddliGaM4H4mqBbpNZmzYc3tOt833F4d0ize0A5SCg+a2aDp8Dv1uZMHgjnBkDL6xB75Po/qlwRS4buaXFgbWpmgVcbciOSBvXNOaX5Bfgdrk4yM3VxYCZCahh7ybuAK+yPQbe6Tw9esjj7vTPCfMS08yJkpXYv6R5d4iRUSNfqVolpC94AxerIk1gfJOzFnhwBj+Iwy0xPLTFkUSluWknGULbo3/F4chTW4G9B7j0N3kh8akN2Eaec2a1O6GL6nHt0t4eUlvcWWnbSXJWmVkn6YjMZC08O1HWd57h+4U/fKNfYa1L39JwOQZM5217RVLuhdjHhvvB8PORw+GRzHKef4hi89jk+OoB8PTiA9SvsAJwdHG0Qa3YbdwSnNMs5eCvvLFENx9OCayhFM0F1jeGCJh2ed2zB83ayci1hdNXsirHB07plSw/R4PHkyTOIxH0/iQz4YxifDp8P44LAPw/RpwsfDkw2UupsUOjdc8Bn7AXQmZEUm/74ZSTT3r1e2o1CwqUEaZ09XcY/NeTvrc7U2prB6a7TJ6c2ky5VIKudSbswPbTW7s7eGvTseI8Mr2B77GeAThpqkndHTuz8BX4U6BE0q2XvPrlKYaJO0Vw2FetNK4G+9VoxXJru3H/v+EAyF6qnv36zFcNOLfmrojdsW9DtRIDe96MdKg9y25m+q5Jsq+QpVEl6/V9LrHNdWKGPjq0FcpXfFVao1vSkeVUVFlp4KnU/q6G83aVGurpkCMi2UkOGJqcte5My/ImvXPJIpc0UUmKDCKu3qG67+C6baIYRcSXz5yRKMdqSlrhPWFs0o1Xv5XrZQk5iWdZzaF3JYAjLHV6FWVYZ49bxph0W2BqXXa0Eo+FIR7hVrXWyC4P4Qqgso9v33l+6JDoWbWMbnjWfh8/l8L1XZ3lRd7fOpq/eyP5+l+9R4v+CLlC8ef/89DvRJqjmbI4JmGQstpjNXnYgeD7unxaANwTCJKuCUfWxxxOlcCwsf8fsf2G//8p///R//yloVK+iBPaZztEp+uLxgSN/LP2BH3BDZSNcMe4OxEPdoWuhGjSkUnT1XA8sReNXgyyVc/ANuCdfNG66qAJXHgg/wL5+t2rEP3615au/2N+b4axxaP65f2mO2AQb0fCWWKvLj5ISvalGfOXwXJ0k/k9KpL5rcG8ql2nv+PeDKcnJUhMK/mvQzkJbzk/5zTFSMzy7O43+q7s9o9hnwlIyCen5fT6M9y3NcSY4lWlzhHaQE2hopO7s4D3doSxVViL+wAW4ZvUyXaMyJOl2459o0Sj08MuwyF5JScBpj71gXgRci9j2FnP69HzBu/PwYYeAje9ysddSuS88N+8OjuP8Ei59QNSSqyeOKnYTfb24+9KKNBV3A2B9USrG97n7fse7FiqIO7de3f6Pl+v5v6+1BqK3TrHnz11pPbxls/+Rbmby7FE1rVr77/1HfzpWlq+b/669qt46X71x2rSUOsO9OBddubtpVN2ppuyy/NoiPbWp73aFa1yAe9Lep1lW3W12tq12YK4VcbVGPq8r2iZ6cPD045Afw9PDoaMKPh4fD/vDgGMb9o6f94cHwOAoOy3VsCuCfgJtFTDVxXPjiTcMxaTZBPLG6Aq1FSrYVGWgkES1IQ/dGaHo552xtIeVeoHGzoDJaT6FfF1TVoQ1udZc2yLqrB4smg0+wcC4aWY52Fp1G+1eD/cpZ2/9SW443+113jRLAvaFZ6gztOm8s8UI4WynGbUODaekoPIdcdSjrxotdFgl+xrWtGXjlmBeaMkbWjVngZ1y6gaTUdNt5+SVEo84SjIydlUiEyw/NVkjr3J2QFW2rI48Qg01HxQGBaxIV3WpANERMhSvQuZjhbWXIyuxFbyiV/mtmcCOsmeCmF6Fx91NtFjZOffOwt6yo+63K16+Oeb97ymt3I2R7h+Cl88jOLs6j5iFv2MG9CH0F83ryBvSVSKDBNbXZThWg9qnhfooEQqM1pv9jap7xXZeqlkCWqJw0DOF4ZNgLf2hZeCSDXkOqkjIP9bX/zteV4y4Dwa/weZiV/YS1v/w1s8vmQ7b3X/+h5nLcMzyjOZeNcSovEjPcOnKxBf5LbeR/C6l8C6l8C6nsGlLx0tfCtd0vMi5ITJNa+uKV5mV0RdllQW1Gvei0FXJpa84P+JDaWOz35QuGM97p7OYGf/5cAgZwLz+gxtb09ot0VCrozmZNmKR5wr/7yduFj9m6EM2aFYWyTdQi2AuRryHVjCC5l+AugrMbuN95OGclWR35VsfCKirXRtwzR6z4bctGXA7O1D3QVCjsxrZNa+/i9Zu3US8a+4BQrsiI1XyO0Tg+d3se8p8wYoS/fYkyLqeluzlwY+Kf/wFifueN +sidebar_class_name: "post 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"; + + + + + + + + + + +If a company does not have any pay schedules, this endpoint will create a single pay schedule and assign it to all employees. This is a common use case during company onboarding. + +If a company has an existing active pay schedule and want to support multiple pay schedules, this endpoint will create a pay schedule that is not assigned to any employee. + +Be sure to **[check state laws](https://www.dol.gov/agencies/whd/state/payday)** to know what schedule is right for your customers. + +scope: `pay_schedules:write` + +> ℹ️ Pay Schedules may be automatically adjusted +> +> If an onboarded company misses their first pay date, Gusto will automatically adjust the pay schedule to the next available pay date. +> +> See [Create a pay schedule](/embedded-payroll/docs/create-a-pay-schedule) for more information. + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/post-v-1-companies-company-id-payrolls.ParamsDetails.json b/docs/api/post-v-1-companies-company-id-payrolls.ParamsDetails.json new file mode 100644 index 000000000..f6a212df9 --- /dev/null +++ b/docs/api/post-v-1-companies-company-id-payrolls.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/post-v-1-companies-company-id-payrolls.RequestSchema.json b/docs/api/post-v-1-companies-company-id-payrolls.RequestSchema.json new file mode 100644 index 000000000..855f5b441 --- /dev/null +++ b/docs/api/post-v-1-companies-company-id-payrolls.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","required":["off_cycle","off_cycle_reason","start_date","end_date"],"properties":{"off_cycle":{"type":"boolean","description":"Whether it is an off cycle payroll."},"off_cycle_reason":{"type":"string","enum":["Bonus","Correction","Adhoc","Dismissed employee","Transition from old pay schedule"],"description":"An off cycle payroll reason. Select one from the following list."},"start_date":{"type":"string","format":"date","description":"Pay period start date."},"end_date":{"type":"string","format":"date","description":"Pay period end date."},"pay_schedule_uuid":{"description":"A pay schedule is required for transition from old pay schedule payroll to identify the matching transition pay period.","type":"string"},"employee_uuids":{"description":"A list of employee uuids to include on the payroll.","type":["array","null"],"items":{"type":"string"}},"check_date":{"type":"string","format":"date","description":"Payment date."},"withholding_pay_period":{"description":"The payment schedule tax rate the payroll is based on.","type":"string","enum":["Every week","Every other week","Twice per month","Monthly","Quarterly","Semiannually","Annually"]},"skip_regular_deductions":{"description":"Block regular deductions and contributions for this payroll.","type":"boolean"},"fixed_withholding_rate":{"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.","type":"boolean"},"is_check_only_payroll":{"description":"When true, all employees in the payroll will be paid by check and the check date can be set to today or any future business day (rather than requiring ACH lead time). Payment methods cannot be changed on check-only payrolls.","type":"boolean"}}}}}}} \ No newline at end of file diff --git a/docs/api/post-v-1-companies-company-id-payrolls.StatusCodes.json b/docs/api/post-v-1-companies-company-id-payrolls.StatusCodes.json new file mode 100644 index 000000000..209638cdb --- /dev/null +++ b/docs/api/post-v-1-companies-company-id-payrolls.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"description":"An unprocessed payroll with employee compensations.","x-examples":{"success_status":{"uuid":"4428f108-e46e-4ab6-ba20-03cea031cfc0","employee_compensations":[],"payroll_uuid":"4428f108-e46e-4ab6-ba20-03cea031cfc0","company_uuid":"42b5333b-ee39-493a-bf7e-f41f2bd67848","payroll_status_meta":{"cancellable":false,"expected_check_date":"2025-06-17","initial_check_date":"2025-06-17","expected_debit_time":"2025-06-11T23:00:00Z","payroll_late":false,"initial_debit_cutoff_time":"2025-06-11T23:00:00Z"},"off_cycle":true,"auto_pilot":false,"off_cycle_reason":"Bonus","withholding_pay_period":"Twice per month","skip_regular_deductions":true,"fixed_withholding_rate":true,"final_termination_payroll":false,"processed":false,"processed_date":null,"calculated_at":null,"pay_period":{"start_date":"2025-06-10","end_date":"2025-06-16","pay_schedule_uuid":null},"check_date":"2025-06-17","external":false,"payroll_deadline":"2025-06-11T23:00:00Z","fixed_compensation_types":[{"name":"Bonus"},{"name":"Commission"},{"name":"Paycheck Tips"},{"name":"Cash Tips"},{"name":"Correction Payment"},{"name":"Reimbursement"}],"created_at":"2025-06-11T19:40:52Z","partner_owned_disbursement":null}},"type":"object","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"},"employee_compensations":{"type":"array","uniqueItems":false,"items":{"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/api-fundamentals#optimistic-version-control) for information on how to use this field."}}}],"title":"Payroll-Unprocessed-Employee-Compensations-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"},"fixed_compensation_types":{"type":"array","items":{"type":"object","readOnly":true,"properties":{"name":{"description":"The name of an available type of fixed compensation.","type":"string","readOnly":true}}},"title":"Payroll-Fixed-Compensation-Types-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-Unprocessed"}}}},"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/post-v-1-companies-company-id-payrolls.api.mdx b/docs/api/post-v-1-companies-company-id-payrolls.api.mdx new file mode 100644 index 000000000..776004618 --- /dev/null +++ b/docs/api/post-v-1-companies-company-id-payrolls.api.mdx @@ -0,0 +1,78 @@ +--- +id: post-v-1-companies-company-id-payrolls +title: "Create an off-cycle payroll" +description: "Creates a new, unprocessed, off-cycle payroll." +sidebar_label: "Create an off-cycle payroll" +hide_title: true +hide_table_of_contents: true +api: eJztPWtzG7mRfwU3W1deJxxakuWXPtydLNu3qorXOtubTc52UeBMU8RqCMwOMJIZlf77VTceg3mQImUpl8v5QyprCtNoNBr9QnfjKlElVNwIJY/z5CAplTbpxW6aqUXJpQDt/ms5EXla8mWlikInoyQHnVWixO+Sg+SoAm5AM84kXI5YLctKZaA15COmZrM0W2YFMPf5+LP8LH/4gZ2q2WxCf5lUwLWSp5/lyyXLYcbrwhx8lil7/dVAJXnBpiBhJoxmXOYsh7zOcGbNLkWBf2RCZkWdQ84u5yCZmcMAdCY002CYUez0SFUVEIzTMU50WKyeg1fApoXKzjcH/1LJWp/SQj/OQQODAhy0jEtEWF1AVYk8B8kuhZlbmPpclJMKzuqCV5MGg1M2VaoALgmgzlQJB+zUb8ZBVcvTZJQYfqaTg0/Jid+kL6Pka3pWa6NSIQ2c2V1OzbIEHAeLKeQ55Diu5BVfgIEKIVwlki8gOUj+kv4nfX14cpz+GSqNez1KBG74HHgOVTJKdDaHBU8OrhILN9GmEvIsGSUg6wXOs7ez9yTdeZruPsGZ3O4mB/Hv111+eoW4LIQETYTJuYF0yjXk7PDkmF1YXBjXWmWCG9wXpOFS1RUNyHhRjNnxjEklAfelrNSFyJEbaQwvy0JkRI4Hmn1aCCkW9SKG/eXHuTGlPnj0KFeZHhMVx5laPPJU82eB/v6IlyJ1Xwp59oMDmEY/P0Q0ag35OLkeBQo3Z8sTtuRm3jteH+fAfvnl+BVTM6KH+ywZJRX8XosK8uTAVDWs3o7r6y+jRENWV8IsaY+PLIzDDM/pYW3mycGnL9cRz1T6kp95uBXoUkkNGkHv7ezg/7Vx/FATpFldJKMkU9KANDgqovWj3zQOvYqwbMM4lLHo8PLCbi4sykItwS4epCaIepwgwvCVL8rCIqctHhNtuKnpl7oWKNn29/eez3Z3nqew/xTSfT59mk753k668zgDvvN4N5tlO8i2bp5Jax4kDh4TQmiyHUS/yf6rvemTx48fT1OAxy/S/RePeTqdPYN0tr8725vmT58933+eNHPZdUwWYIhgGZcZFAWfFpAczHihYZTA1xIyA/kkm0N2PsHTEp+vZ8RbwgherBkRgOQwFWZixKI1ZPfj3uODnZ2DnZ3/jpArCJBDw89hAWS1QRG5Ds71KAlS1DMar42alKJQJsDtStrkICH5mowS5Iy5KnIhzyYlX05KqIRCIn+8FBmwEiq2UJJO1ArZ6uedia+QT2J4Fa3N/1XyYmJlEjHExFEgIBm4tv+LI7esi2KUZLzIaiRbPuHG/xijfpVowyvT2yPiTZn3fn9qt2OCZyqvC3BshoCvR8m6/baqtcHX7WkOPC+EXLP7llbx+ZigtGnpDrtDkag7UouF0KRDol9P+JJQZB9F2R7O9bz/Y9Da7IQvFyhhor++B7GY1pUG+4cvoyQjs8RSOl7M7ouD/Z2DJ3uWlSsjoZqoS4lbJXQDwhLxeuRlqZr+BplJaGtLqIywEqdPuL4ynKlqQViQKqND0RXyhwx/1oYvSmbm3KDCIOXnwLKZqugHLxaNQkOiqiUTkqkqh4qGeAGm3YCSi5wpSdDHDLWiBzDnmkll2BRAEpzpsjXjiHFWVlCiAYSKBrSxBldd4jLYVDnDxW4h/WZtJ4exUayCGZo+NEwrJRFGg6EzhghF/LK13umSXc5FNm8telFrM7hsjTAiROziF2DGpCZ5/k4WS3+ejTCFYz+Emr5yc6Yfcd8656a/m33tTFMq6RBuFujtU1phZwM3QewI8UhfIdN41CJJEzBz9mEPtV/nYOZQMVXRRseExM2njddBcRdLFoCP2c8KqYiM2NPItHGWcxwv5GN2mOcCp+VFsSTOcRMJy2RnNa+4NAC558sA9Te7pxmvNbRwDKyAyJbc4vUnJHVABHkTwdcyU4uFkmN2pCTaXIBY1BoqzRZ8ybK5UtpyZC3DBFOYqWp4zk1258Qvob85Hd751DAPChVrCQ8yETcDXH/JdWtraqTrrDVEaPkg3qrlZpzfLKHFZB01tWYZW0o2Z8EWXBt2wQvRWHl+SoGbGK2wArc27j6IB25yhMJS0kMTFmi15CZHOza8tzi5/v9/qUXEHi0D8u89e9sQ3XZ29/WtpJj9tI1NZPrdKMeOZY4+BApUJ9HarM+47McZNkDs3WyWHuE3fayCsXmVcLl8NyPjZpWPe5jPVZaMkpc2hMAqQBHEEQVvqja2SzJKXgmNxhDkQVUko+QndOTiH37lZ0j26LuP/CurIFMyE4Xg7sf3zWSvhOZTUQizZELqukJngeUC8Z3WHkbFpSZJzWaVWjBV0Blk3oBMvqBN5VZKp/x6UFo19LaUGjOkdBOJQT7p7Ylexy7NbrwniGFTYqfgTngFATICuAGzHNZGpSc4OCDUGM93go4HtwXn+shYQGmNi/LtOOI/aYLwI+4uZ366iG+/nQ38Et8IWl+zoiDV/JpXuX+biLbSOhCB7ZnBs0WWY3vtNu70LfyNh6jtsDux8foCqiW7BDhPRu4fisjvfup7sW/x/wuM/PxXzSsDFf33B1gILmWNplcySg79f37pE/XXhmRIzvSESBYoutJLbiyAhomGLZmXGCplDkYrjipzhoEhL4u0UyUYn3O6hN0Z83w4F2X63iKRvgpIRMdl2N/ffJ2vJe4psk1wtQgcFDkacchFx+8/PNDMx+gsd6kZ29v7V1rZDHKoeIHLVQsHacw+GBwW/xa8CPxXAI6BIXigma7LsiCHlReBicfsHTLSpdAwYpfwoCiYrhf0HUgjKjBLr9f9wX2g2SU/A7tPnjAOASWjTxlfqFoajwetCpfjt5yg3KUY+Ap5i2/ft9yhoXMfPPUu8LbnHkdaNpEZNJ7M9JFdmRYXMIrMM2Yx6S/rOg7e3PtUA/GgrRyRjtHZyMgbbT+KlvRt0a6YWRHc7O5eV0tZX4NC/1NVt/xZPAgEjNjXBzOJgLoXsWkFUW/UjriurreFLuUUmAMEK3Z8KC67cTQB7QIf826FEXqOH9P1dCEMrleqy0FUhuK/m2AikeJFHFfxLBBdvtzE+EOR5U0mx5GxiKoeaMazjISPpwjBhNsRpR3FvpEPBraT/RvrU3btBgwEx28ixUkn9NUsjBuM7IQgBhpqRDLF+IUSOSuiUMnGZ9WqTzpL6VswvDF6V9yMBPx5VXG0P2opfq/h2MBCN5cD9l9XCS+KtjO1IqoaZrudtxrM0WGOtFppg03/iFTtnUMPgP2IBlMJ+UPrSw3EMpw6LQoXah0OBbIjK0mEPItCZ5eqLnJWAV4r86Jo4ooPGgymPDvHHSc6D652JiptJjZIvpUaoA8ZftijKntvjRrNTgNSBzjzKaP76eHzVsEMqgryya1RCiDuHDmMSN0GI4pk3R0aZ5XSGp2ZGA1ZL6Z0274ajciKIxDIQyMGv9e8sGH4yDZjf2QZXq8YUeJ/h/sE+0+M8VgvhIeILgNe4c22HjnGQz4Vi7Im0Uum6pjRUbngRU1X7grNP37BBalZYvh+HHmQBBLMtxFAguksP1CVpc1htqZt9EPkq6iKneGS9RwNaxwVKHZ3C7Uqw1rTt1+t1c0WSrRkR0X2R1bF92J3iL7zoNF6m6ttTcx4AZE6CW65BTpmx5r9AVH8Azv9SWijKpHx4tTm4VRgKgEXyIvdCIr2erlYUsBf1UaLnM4o5bSM8KhKVtaGCWmU/XEcRfReCYy6sVdQKi1QO9FNDEXpPBYYKEsWsFBbLP0I51kwA1+NvVsJll2FOTo545hEVUKl6dhJZW+yYrmCzhipCG3q6QqB372f3VRL99IxaDBSjWC2cy+CEmsk3puBUc4FpLMzYlMMh4IekVrE7ByyWLosejxrxQWay6o4rwwZdwgtShfhjsPP6AoY8eSS7Yx3dpi9zTR1JfEq5Q3GsQbTTkakcnlmxAUMztMClEQmznrDpq1j1hrfkVaJp3ZHmBdaMQ3VBfrsNkZn93TExGJRGzrPIkenfSbcLSlRtQWL4qsdEbQOKef8D6AVGzXBH7geJb+p6S2NuN/UNABtI923ZdGanau6KpZ3zPkW6I2s/9PQMM/7Tv2OKO0POd7yf65q3CP/I021DfcPonYf7D840T8P/xPdN8SJdLPnCx/4CxAhbwU142NwN4fMrX0mMMzYV998ZvrR++Yy18Zgm7t77fClS3zUo0Mb/fc7xPaKMiQVLerCiLIQUEWzBuNoJdXCZ7lPaMEQvovtq4YazCgMmbbND6iIBuxSVecrwjqzQvMovfBmarz504dDZj3qgaBrWYkFr5ZEpxiXFTIO3UcKHEzUbPbNwg3PODmkJH/UrI0dMg8U4kxMQ+yvw9f3fOpPPr77psNuIWx5xO3BVk4In3x8xww/B8nyGj8Z0nD27q3kS1WbSY0GTj4hKBMhy3p9/sTAxWpttOEy9+dR2x2qS4zCN7dhw5LAZtuG/WqGR7a8ZaS2zfXNnNQG11eQm7PKNoIyVwW6tW152UJllVXSgrVdmk7zy+CMLnuF5KpEbs679m0/AWXrsPyWM67XGvbDDd2+CrPICdfN88/6uyLwXswBujvsruOM+E+ek9pYfbkeCny+dnxKuSpB9aUvuQ5XTTfxrcv034xxcelIB1/L4LbVgh6zD2Aj35+aqgJ2VosctixMEDksSmVAZsuHREgRXaIoyebqEnWiTbzze4ASoqGQq/ygy5KtiLDhouP46haWjg1UUHJqxBJ3Rjgs3ZjVMuf2YlX/oEojFkIbkfmSjpQus1WxHWGvBy7lf2m4exUjWh6Moi66BLqK4PIMBq8+2+R/19EOFEBpJWku1IXNzZyh/ZPzkAxKsT6pDfCcIgEY8OTZfNzbe1WJM9KE29wyvXMfxXdMhJyfx2INK0JolqO2mvHIcWEz4SDosBp7ZbPlauij265mmxn9apoJV0htn812s2yyY9nlfNn1JHo8svGtEvJs+gF5Nj2yPNukJUZZ+rfKnMfMVbJf8RyGCr0KtKqrDCh51s2xLt/A1jC2kkRXFzr0jKWVts36DARvFq82gzFbLQg9BD4cjcOVdUnXcx9WJVfEooYWr7sJzZQgY0sAYqMlrNIbLb38io2dJN3yjzzPRSLIT98nqY/Zhls3miL4eROX4Y5FQPbq1A6w/4j+Gq11xkWBpZF4WVhVyroOnfwf+t1GcVVGRzf3PgLXS5kNLGKI/Tbmo8auIZQm57CkZRo4U9WyT/1m1I0b8KGEDP0mSgB0CfH0uV0Z2o/LEmPexdKqs3NYNt6Wdce4sZld8ChUk7IKbNjBh7AR5Njmlzust0ANIfgDYCExMiocKF/kqR3mZ5WqS7yz8kGPEPHAmE0tipxlNhpvx8+5zAur62yVaFQ0SzG5MJHQ7BQLWSCfWOY4HUXGmw3po23AhaSKaBzJTt1Q5jZp6coapcFsXftHIs0CtOZnm+QF+PXmYLjAWoiQFGNXlLIzkJhh5nfNgfbE0HU145klCGabyJwKJhwWhud8k7ScI7tStOcLuOCSlBBHmI5Blm1xLCSjgyxIxaAVEqwSG4901ZyjFgjCj0h1av+fJPEp7a3/BV2q0+hGxdb8omRUElYkHbTX4kJHNtONzlHn4Pmf+4fN/2UL1dCeG+WDnxk/a25fT6KZhpRIRJCbuebn+KraUpREWMM2lHGO5b45hjeJGyIC3zzDLxQ3GArGWDAEkUo5Jpg0scYJDuPqcmLWXbNdj5KWnBsaQPmS64ZE6vGt435KO0zfSUhf2225Xj3qreMdOxS3Zshb+r7n//f2vG0FdE53J+CBwoc8VfgqtMG0tDVqY8yOKRJSKq0pxmoUm/MLYEEOFXABBVlFTo14RRHESpKJCu2c6keLbkp2SfqOGO5hy5MfGJAMWoUnwWBJ3zur63p9pezmadNEoYWSsCRvohuic2V5GKlDy7+J4bvZMYw/9xda06W9uP/3ZMjnoPHpO8Q2fRVh2/jSa/xwFyTd39nvW34/K8PeqFrmt+90EECwz5Ix6hLiDVwK3jldmSuw1ZPETWP2lp+T2nZFCk7DseNXjyg2aPM6RB45A6vtxyEltorJv1ul/5BW6T+KuWjPSrsPh1RmMqNDEjHWp9b+J41L11A++jBaXLLigFy6Enb6YIyiOjrWPyuT0iHriTw82Xt7/WMZBAB521Ze2iY+wpYRz3lZgmyCDFOV0+0HbY2vkc+8RWyXjRXWc7y0OhXSqrbAlBO6pT8dMeVj5BbCjDYor8HROnwZmjWdRqFO54keWRoK0FvGOgnNNAufP7QRUxLLC0wtdhwz/ixvL/GGSWtl33fieuJ+l9r//FL7eyzheyzheyzhu1/5PZbw/3DP/+ljCW0vYMrl+cTV7E1yKMDApJZ4sQ75xF1l6zUeAmbutd2DnrHWchPe1JQ39ZaqByhx1s/Gwmy0By3ELqASs+UEC1mo2cYkt2n/d4nZX9EMwFlDCWOTh0nzC8zHPSkAcxXt1TQZKWixOnRcmpMer14CL/B+aTnxEO91AUheN6HNTw7rGECQmr/hLaKqjUseWuUV2hGTkOk5gGLHyG8h+t5+71N1RVOB7/DyKRSZkjNxpgNqwdbcimr9r2NkDg3DLTVU69AYs76W0xsWw4j51WLygD8tk0IshFmD4cDgrUn4BjH2pTgEg+k5FSNOAc1QuzMeZ1d/3+Abl7qvwDIMGcRtmJavpS3ojk7Owla+cske2x4ZmHPPZrWpK7D4hRarMq+1qZYT7XvxTiQXmZ5kKodJY5itxLgZvT09f8ZvGX47wI6bYeimuX8EPWuGSrKnLBdnIoidNehqj4DeAF0tMjt2e2w/iIxw1X1k9x2yFlefJz0pVSGyJdV3brbXi1sRcTG0v10kakknCvJwXniWVTUvQguSFVi1hm0huQ/tdzYD3lNsWqAot7mVDh9GCFJy0iDiJcg8SgRZpx07n26D7ZE93DlQ7QlVsBMM6+M6HJp8dY/MCpxD5e0m2x4Gb7/3Pm3Pl8VsyAFTXmDh98R2UbyVtl6H1RGXFB7lue2xaGfT67d9rgqRo1TH/1mEvVlBhuhdWkWuM1wwI8ikYA4Dm7JNGKxGDcPF94ZWuH8hS3oIsRErnclG6WOo5leiGtRjYLN7YcVjO6bJqkW3S0cxDMJPyaniFZrhoePcHdLPn2E0+FmYqmluRyj0FnOHGHx0jSMp2ENuqZCtKDAGlzsazZoVE6Bc5wll9/LMqGqiKF9rJW7dkdsf0wDA+nuNfWNxsUVaxOUo+8LbDB3879OO7axxQM1RxyIEQDVo5OtvYgX0v9qefifBrn4wAO9Bc4yb0ATFKV1DUbjAGgq7Ch9a3BT/1vhvwrwF6Uac/ejGpaFWNrbRQV0GWRM1U1hl67gR25s7ts1CsCi8X9BBiawW3BFfEXUTSW+n6n6iSqnm5Eg441i72sHGnXHbuOkO5Y1v0tMgYKcIx2NWqb9BqynjnUm6TqlwyyWPugYfG23D6b3mzXhDxgsD1QpsJ1EG6z0hjo0WAYVbU+fTqVV1qFKo0XU6csjWcqFyMRMktj3KPpp5l8j6G6Oyt9kWAUvJFsmtoKTCRSvF9VIbWIRBXoZ3bQOSAnris99vtBPs+G8RQG1Izal2NX4OzwX/ik+bdPHUdWX7c98jqq+/ZgBoRTgccCd2d3aIqoVS53W5jpb3iJg3uLwPQIV6P+qH46R999Xc63zqBN2D+5B0YuV+/hT/me7uPaYUh1ig2ZeJqqD8KeiGxUhbMX8H2qAxTBzhDOFWHDD04W93V+8u387dx3P9esLmaDB1eT+L4nke9ey/1XI6aK5fk2v8OTH8630uC+1CMsB9o1HsDkrz3W6NfbQ3YEUbE7ZJIne+zBYbeonlo9DfwJctpIcXqWuNsYgtQ+ybLIp6FzrgsRK8cQkNShZlKnChJ1d6WxNidutM897ntwnVBSDMA2G6eQ0tBGVWIdxo5W/FtnVd1qGfn81JYwqh82w+MfMKNLadnYBTPkl0f9fFgJYFAdftaeXp4t/MiAq/FFn8xQUwis0fHv3EPnrkmNeM0f0RvXaBdw5qxn7Fpr3HcsTeqgtgHxVmnlbsFafryFhhRsW7W5tNwX25CC/Fte6OKC7GjYFFSU4sFsfaZ2R4k89RU6UXp35dqZql9HcH0LuZ4kxyoyoM7XFRbBbW46K4TUiPiyJ2dLsIeL/bR8fmXE/CX+8+mmJvc8OFB25umI1RepBDKLBBBZhiba/OffCg+cT1DcU8Aeo6KeESgXpDj2of4yxvf3RWLywevcXpi2IL/t5q0PpZc/ZWgdggszRODe/kko7ueXn5Tj7je3t7Kc93nqf7wJ+lfOcpT5/tPnv6/Hn2eLr77MWaRXca8N3C9o977QX9aaXGAWu3wBsx6oBnny8cwsIVe94aC1cA6kSftaipyL+N5QNnbdsr/gdjL8P+t/KNqfuL0POJi3KidqWOmGR63UNM2hHI+vhG4ck2rJm8ExMslLViJgT6JitMmwrATHa338W3yDy+3RlnFhDKlgpra7s8k9kUpW+bg4B0Idssne1Vr226r32U+LJS8ow577s7x99EeQs2tyIZJPraPor3N1HaS9cfYXw2Zrt7j/efPBw4YnMl4db5ECf4tc+G8Id8d6d1UYoZB4XI1kUaBg9PXtsMcFh19RgdHffMrY7Se5tglb3C6TjwmwSyB9Fan0fwMa6daXIyaPftvmButrWU/Rkv1GWU3kC5XOuSGxrf/tbRBJzSZ/N1GSKOEdzNBGGRTpNZG1bfrPPdwM3VIc3iDG0vpfCg6TWaDv/uWi/cwgMpbTM42xHxgfvmQVNJIBWWm7me6jRKe60y5Vpk9+ydc0rz8/LbW5u2jdZWLqwEyHWkh5wbOGB/eLpduuTwFaujP29NcHq2ysuZVgNKvMTyiRo7QVH1sLvHGD1ZEquD5J2Yc/O8A6PM9MzQaysKX+Yg46hYdm/4nTjya7A3oHceh+4kP0Qo2wnzzm3WunSxphX79mliTQ/2lpvUtZtJP8wmU1HRI0ZbzvLKPZtDnwfX2GlQSpuwBiDJnM2uaUMu6G2MeGe8P9vjsP9091mac/4i3Yf8Wfr8Ceyku88hf5LvADx//GSNSLMNCbd3SouCszfC/O0MQ3HUGMs+KEAdYfDAEg/PO7dh+IKAsi5iuGou/RO6PUfnjim1lz+bzp7uZemUT2fpPt/dS5/vvdhLH+/vwF7+IuPTvedrKHU7KXSsueBz9hKqQshAJtfflN5kcNUrm1HoS7c5aYh7rM/bWZ2rtTaF1VmjMafHSZeDmATnUq7ND20Nu7W3hl93PEZqgTxivwKcY6hJmjmV3v0V+BDWPmjSes72Dl2l0NJ1jbRXkUJtl462qhXTFcnuvt0gaPNS5UvP/BsVR64ryWtexhx4j3IUv1oVvSrVqyLa5n1N36dRmOYxTdZ6qmu86nHMbi2Hb8Y0+O6lfydz8P3Lmx+mHOg/2kM0vEZpo6nEmwSO3jBURaEu0coqsJ4+uR7d8AZYq/vY0Ms8rqVo9F6XK3hZ/djXxjDB5TuPk1VvenXf2W091hWpZFtBcwN944fFW+V2C26yOcVsGwjtJsDtJcZvBdkr1QFUcQOo+rKdpYZzOw/fPToXmby+8sbXy/gOE92qOI/HjQ9537gVJOvCHqx+b/Iu3pcc6OD2d3socv3Tj3f3wGOzRi+K1r7F+P3FxS1eXBykrdCuNyZm7cXZRz0FIBnVBrYfmvLxsPAiVfwQ3XTpH5/B3LQ5xC08fVkwGCrYVpg1S28NLF11BpviZQ9oTa1Gf4zbutjtQ4GD11wF9h1Fj+fhmLUj1rGB6xqhIt0Ii5SyFONWwV3ahK4VugR+DlwvU/RkUnyNoRI5hSfIeX03mx05bYzPzEhtj8Un73Z/TakHQBrVeKcu9GPtJyz2db0B7OPK7e8qfcnPmsG2YWczaBV64YMumthh1r/Jk5SKYmMlN/PkIHl0sfsoZI8+ugqlHPn1I08qNDAwW8mZYXVVoLPiOh7wUtiGB2kOC+p60G/GiQ/itMlq4aX2ygP/jMtbAXgQ5klF1xurYJb4Z1y1xo7Swiw/oJllrSAXcjmkHo+HNVIhqAGcHJdLo5E1gFcDTwv418upfhKfjp7jqfTJAaPkA2V0fcsMFsKKCfDxBa3k+8bQfG0LLDtGnq3s7ZtowRKLLZ1kb2dvP915lu69iI3Izu8DNkekmzoqPvlFnkt1KbG9AxzYpLERaei2Fm5PsUqltlXeSt1kF71Kgdi/rhCB4WFGmyrlLX9qKMUOT47xgPn7cMT5SbrzNN19gpIEqoV+N/sA1YXIIOLiphcItU94RAMf5bitaJmn9G+819bu054dDoVVQu5FqgeavXaSg/kM08OTY5arrCb9g9/9i2vKwm343raUTV75Wdl7KLiP0dqrcDyG7q//0Zw66i6ttFlwGcGxbXGdT9B+vreLfuT+uM+0vVYexf3bR31AY+yx88MP7LTLvaef5csly2HG68IcfJYp8++esylImAljlWdkhHgNFV4eDu1k+tAp1cZqqNPGTzkd40SHxeo5MJXBxnc3Bk+H8HRsmwnhHUiTA+NUpRPsOXbAcVcl7HQF458yp8YIIL0meMBOvQg/qGp52mg8fGzsUVlwQdKK5O6VUwifkgu66/MqIRklB41SSELWEzWpmKMqOfiUXF2hyfpLVVxf48+/14Au+acvqJAqYR/V/XSFt+VUuzD8dkTMKz+6hxLzh6z7zIFDZtVifP08jfDqMHHF/Em0EluSAzzHu6StkHsF9hEN1zSGulBbkx0Pou9kH72GS5tHTV9wAPa5oY4vEh1R0ZThjOyYKErwQLNPCyEptTWCfYvG9U3v+x8cwDT6+SGigc1rxqvIasn3l5RkUHp4cpz+OST1BCo3NsqRJZbtq9eM6AVAmi9QWZZm7djYiDl59+FjMkqmLsiyUGSdVfwSAyf80u65v4g6uLK/XSUFl2e1jQhZmCjheFtDB43s/iPq69LmqqsrO+KjOgd5fR2YzOC/KXp0/T/fMYcL +sidebar_class_name: "post 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"; + + + + + + + + + + +Creates a new, unprocessed, off-cycle payroll. + +## `off_cycle_reason` +By default: +- External benefits and deductions will be included when the `off_cycle_reason` is set to `Correction`. +- All benefits and deductions are blocked when the `off_cycle_reason` is set to `Bonus`. + +These elections can be overridden with the `skip_regular_deductions` boolean. + +scope: `payrolls:run` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/post-v-1-companies-company-id-people-batches.ParamsDetails.json b/docs/api/post-v-1-companies-company-id-people-batches.ParamsDetails.json new file mode 100644 index 000000000..dd4392082 --- /dev/null +++ b/docs/api/post-v-1-companies-company-id-people-batches.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/post-v-1-companies-company-id-people-batches.RequestSchema.json b/docs/api/post-v-1-companies-company-id-people-batches.RequestSchema.json new file mode 100644 index 000000000..eb88ace88 --- /dev/null +++ b/docs/api/post-v-1-companies-company-id-people-batches.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","required":["idempotency_key","batch_action","batch"],"properties":{"idempotency_key":{"type":"string","format":"uuid","description":"A unique identifier to ensure idempotency of the batch request","example":"550e8400-e29b-41d4-a716-446655440000"},"batch_action":{"type":"string","enum":["create"],"description":"The action to perform on the batch","example":"create"},"batch":{"type":"array","description":"Array of people to create","items":{"type":"object","required":["entity_type","person"],"properties":{"entity_type":{"type":"string","enum":["employee"],"description":"The type of entity to create","example":"employee"},"person":{"type":"object","required":["external_id","first_name","last_name"],"properties":{"external_id":{"type":"string","description":"External identifier for the person"},"first_name":{"type":"string","description":"Legal first name"},"last_name":{"type":"string","description":"Legal last name"},"middle_initial":{"type":["string","null"],"maxLength":1,"minLength":1,"description":"Middle initial"},"preferred_first_name":{"type":["string","null"],"description":"Preferred first name"},"email":{"type":["string","null"],"format":"email","description":"Personal email address"},"work_email":{"type":["string","null"],"format":"email","description":"Work email address"},"ssn":{"type":["string","null"],"description":"Social Security Number (format: xxx-xx-xxxx)"},"date_of_birth":{"type":["string","null"],"format":"date","description":"Date of birth (YYYY-MM-DD)"},"self_onboarding":{"type":["boolean","null"],"description":"Whether the employee will complete their own onboarding"}}},"home_address":{"type":"object","description":"Home address for the employee","required":["street_1","city","state","zip"],"properties":{"street_1":{"type":"string","description":"Street address line 1"},"street_2":{"type":"string","description":"Street address line 2"},"city":{"type":"string","description":"City"},"state":{"type":"string","description":"State abbreviation"},"zip":{"type":"string","description":"ZIP code"},"country":{"type":"string","description":"Country (defaults to USA)"},"work_from_home":{"type":"boolean","description":"If true, a company work address will be created based on this home address and the `work_address` property is not allowed."}}},"work_address":{"type":"object","description":"Specify the company work location for the employee","required":["location_uuid"],"properties":{"location_uuid":{"type":"string","format":"uuid","description":"UUID of an existing company work location"}}},"job":{"type":"object","description":"Job details for the employee (required if compensation is provided)","required":["title","hire_date"],"properties":{"title":{"type":"string","description":"Job title"},"hire_date":{"type":"string","format":"date","description":"The date when the employee was hired or rehired for the job."},"two_percent_shareholder":{"type":"boolean","description":"Whether the employee owns at least 2% of the company. Can only be `true` for S-Corp companies."},"state_wc_covered":{"type":["boolean","null"],"description":"Whether this job is eligible for workers' compensation coverage in the state of Washington (WA)."},"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."}}},"department":{"type":"object","description":"Department details for the employee","required":["department_uuid"],"properties":{"department_uuid":{"type":"string","format":"uuid","description":"UUID of an existing company department"}}},"compensation":{"type":"object","description":"Compensation details for the employee (requires job to be provided)","required":["rate","payment_unit","flsa_status"],"properties":{"rate":{"type":"string","description":"The dollar amount paid per payment unit."},"payment_unit":{"type":"string","enum":["Hour","Week","Month","Year","Paycheck"],"description":"The unit accompanying the compensation rate. If the employee is an owner, rate should be `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. If selecting `Owner`, `payment_unit` must be `\"Paycheck\"`."}}},"bank_accounts":{"type":"array","description":"Creates employee bank account(s) and payment method(s) for direct deposit. Payments can be split across accounts by Percentage or by Amount. If splitting payments by `Percentage`, all splits must have a `split_amount` and the percentages must add up to `100`.\nIf splitting payments by `Amount`, the priority is set based on the order of the bank accounts in the array and the last bank account is the remainder account (should have `split_amount` set to `null`).","items":{"type":"object","required":["type","account_type","routing_number","account_number","split_by"],"properties":{"name":{"type":["string","null"],"description":"Account nickname"},"account_type":{"type":"string","enum":["Checking","Savings"],"description":"Type of bank account"},"routing_number":{"type":"string","description":"Bank routing number"},"account_number":{"type":"string","description":"Bank account number"},"type":{"type":"string","enum":["Direct Deposit"],"description":"Payment type (must be Direct Deposit)"},"split_by":{"type":"string","enum":["Amount","Percentage"],"description":"How to split deposits, must be the same for all bank accounts. If split_by is `Percentage`, then the split_amounts must add up to exactly 100."},"split_amount":{"type":["string","null"],"description":"Split amount in percentage or CENTS (`null` for remainder account)"}}}}}}}}}}},"required":true}} \ No newline at end of file diff --git a/docs/api/post-v-1-companies-company-id-people-batches.StatusCodes.json b/docs/api/post-v-1-companies-company-id-people-batches.StatusCodes.json new file mode 100644 index 000000000..d30cabd19 --- /dev/null +++ b/docs/api/post-v-1-companies-company-id-people-batches.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"201":{"description":"created","content":{"application/json":{"schema":{"type":"object","description":"A batch for bulk people creation.","x-examples":{"success_status":{"uuid":"191e7162-3026-497e-aca2-f81b7e93204e","idempotency_key":"80a74f8b-2c16-45e5-9038-aa108849c6e6","status":"pending","batch_action":"create"}},"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."},"batch_action":{"type":"string","description":"The action being performed on the batch."}},"required":["uuid","idempotency_key","status","batch_action"],"title":"People-Batch"}}}},"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"}}}},"409":{"description":"conflict - idempotency key already used","content":{"application/json":{"schema":{"type":"object","description":"Error response when a people batch idempotency key conflict occurs.","x-examples":{"conflict":{"errors":[{"error_key":"idempotency_key","category":"invalid_attribute_value","message":"Idempotency token already used","metadata":{"entity_uuid":"14c53a55-0a80-4d46-a866-f5f64bc06486","entity_type":"PeopleBatch"}}]}},"properties":{"errors":{"type":"array","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","description":"Human-readable error message."},"metadata":{"type":"object","properties":{"entity_uuid":{"type":"string","format":"uuid","description":"The UUID of the existing entity."},"entity_type":{"type":"string","description":"The type of the existing entity."}}}}}}},"title":"People-Batch-Conflict-Error"}}}},"422":{"description":"unprocessable entity - validation errors","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/post-v-1-companies-company-id-people-batches.api.mdx b/docs/api/post-v-1-companies-company-id-people-batches.api.mdx new file mode 100644 index 000000000..5128dc171 --- /dev/null +++ b/docs/api/post-v-1-companies-company-id-people-batches.api.mdx @@ -0,0 +1,73 @@ +--- +id: post-v-1-companies-company-id-people-batches +title: "Create a people batch" +description: "Creates a batch for bulk employee creation." +sidebar_label: "Create a people batch" +hide_title: true +hide_table_of_contents: true +api: eJztPf1vG7eS/wpvHw62Aa0sK/6Kf3quk159aNqgTi/XS4MVtTuSWK/ILcm1rQb+3w8zJPdLH5YcB3fv7gEBYu2Sw+GQ8z3kfolUAZpboeR1Fl1EhTI2vjuKUzUvuBRg/F+LRGRxAarIIRlzm87ARL0oA5NqUWDv6CK60sAtGMYZtWATpdm4zG8ZzItcLQBYii2Ekv3f5e/ywwx8Q2FYoVUKxkDGuFnIdKaVVKXJF332qwFmZ8A02FJLyHyfX3+9fsOsYoXKcxrJWG5Lw7jMmAZT5tbQKCZVBVywURv3i3stLIyiXmT51EQXn6L39J595+f2uRc9xNPSWBULaWHqSBTbRQHYGuZjyDLIsF3BNZ+DBY1wvkSSzyG6iGqyRb1IIHkKbmdLNEMi0FTUhGbpu0W9SMOfpdCQRRdWl9CLTDqDOY8uvkQOichYLeQ0enzsVYP+Z/xvhPLl++v4P0AbHMOPPgOegY7Ww+lFIMs5Tm44GJ7Eg9P46ASnl8GEl7mNLprPH7vzeIMEmAsJhqaRcQvxmON6Xr6/ZncOF8aNUangFjJ2L+yMLVSpqUHK87zPridMKgl+P9yJDLKea8OLIhcprcGeYZ/mQop5OW/C/rw/s7YwF4eHmUpNn5aun6r5YViquOALrfKc3h/yQsS+p5DTv3mAcePxAaJRGsj60ePnXmQgLbWwC1rjK7dKlynu2cvSzqKLT58fG3tGm3s+DSunwRRKGjBI9OHgCP9rU4/4AnCnpEpakBabNOZ8+IfBdl+WF0+N/4DULm2ryy4Luu1fM2CEuMIDnxe5w8uUNJnEsRE+KUuBEuHo9RGcHZ0O41eD4Wl8/PoMYp7yYTw5PxqfwetXw8Ex4CbLYF4oCzJdJLewiC6i8wE/O56cj+NhenQaH5/ASfx68Oo85vxocH5+/Do9hVPcj37AqACZuY1IuCc8bVEHN3pUaBRXVkADw+WNPFF6znHHUoNVLFdK8WcJTGQgrZgI0IH/PJ0Igz5xIc9+lvnCreXjink+Z/gGEHYLi2q3s/sZSL9IckoIeUwea0KtZ9yagl6cuh8oU3Jw+2vCRU5/FFxbwfPEr7vj9C6eaak1SBtkq6eR21r1EIRde82WcVwG7tqyMeBUC9BINsiYkq15PzYl4adA0u4qVNTpIPK5F1lhc8TECfiYBHz0+IiAjwfHy7z4k7Lse1XKnbhxDQj2u2TMaTqcBBiUfBqMKnUKLFNgmFSWwYMwts/e8VtgptRO31V74vrNIWkIYdgdz0WG27LL/U0SgdZK04K2ucU/r9eGa82RdMLC3KySKUtQPa1TbmGq9GLNGOv4ok2kmwJSZD2Dm97PmbozlaalNn32YVEIVAwLZmfCEKNUDOvUDLdWi3Fp4bBSwkxDTgrGqhok7dAK6x1QQwjYFre+g8SILzyosEjGYz7VqiyEnDozJOW4u0mHIDbjUuQZS1E/zH37GZdZjttfSKfnGrYG4TwHY/gUnkb5fUAkA8tFbhgfq9I2iBqzKUjQNTk96IClKfWEpw5TLhnIDBFHyjleaWsLqWwyISZpbKxPrfWP/I5v7peLRsfG5KI1DHLPHX9QB1TDiEjg55+UjYnJ4rc4aPyz27WBs1+v0LJKTnKRWhYvCWCeo6Bf0Fq9nBYmxFhQ/06485aKWUKkwtEzwZKeDg02EH5ZODYWQEgSIknFOskdz0toLcd1AymrbhHrNn3mYHnGLZEAGdIukmAtHKcnr/jJSTzg54P4ODs+jfn56Wk8OZmcHo/Twenx+SlpLOrkyedEc5DMn5cV/e6i69liCbdiQ9Isgh52XOQ25o7i5EPVPfTZjbd/KOdcxrgAfJwHUL63h1QvxxOEaC7WcyyXpq9Cagvp46ASKq2F3YYwQbquBvjopc8qJR5feVZwAiBw/nC4zPml9NaKIyBBZ7FTp8TazO+wZ6v8X1sjvKURgvJHYcsXbMaLAqSTAmThqGyBMyfB76Uf8r/lQnqFYpgp0xnjho3W8O2ox5T2/rGDMCHxn5XgJXnVs3L0R312A07hfnrrhrlyG1OA2dGPIjTjtOp+wKalyIAcj7nSEPRR/3f5T7Pl/4XZgl58NZAwbCRJqyduHUc9Qs6tFbsXeR62POPMtWQj35T5RVq4YIFnW/fyf411tFn6dgJkgbk15HDHpcU4CUeYQdt4Tvb2j5CMeBoFlDMenEQa59Bn3yvNvGHQa4Eg/IhUo4Y0HtHajhoKYOTIP65dDbQ2lISfJ2RSbJ7LvMytKII0FRQObDFeeLzMbOHNDizdHhudzkqOR72IZ5nAVzx/3xjJBV9W6r/t1NNPfF6rJkdRO+PNbZMq7ay7zDCrmgpwnYbtao1uGGLipXlDpTrpPdFqXgP8VEOUZZ5Hn6t2ZZFYtblhS86taoC+NGxq0tDI7/zujz8KO4t/lhA75Rc9rm/1zu8d1xSXBmOY/1zzf/w1R0hrFXabDh9R+CiZL5zZx8RGtdFn15biwsoYgSaWVWzG74BVciiHO8gpRuXVSFAUlViJUqHTMud636HbchwPouYMVzSIVrjBYy5vE56mqpQ2yQCDbEkpJ6XMIEsKvpiDtC0jpuOpYYR8tXtWGWstx+z7kgJ878DOVMZm3LAwGqtGozVoIXYHWkwWiZC0dVPEtFBGvChmv6EZgKMyPypqTvTdx8BofAFZn73PgRtg6QzSW2ekoMXq0WF8jh1Nf/0UvBuaBIjfdAJI3uD3jgFkPY8VCM4FhUITrUr0YDaFRVyLRJbzMSVkdnTOf3H9meuPPBHUrsfL74QEIwViairUKltzJ6ot924ic2kZLqllmLapjdl5aWzTsFiNWJjthBsbuCXJxVxsCm6saLwzCb9HjD0MRjCYmakyzxBn7ilb4ZwUoIXKanxBZknmpeUaLKsmK3FbTcu3MqO8WYNzyIOyMy7ZKzZX0s4M2oST0pYaHH5VmlFmpbF6kRjIgWLfieQiNUmqMkhqw2wtxnXr3en5E/Zl2HfFdtwOQz/Mt0cwbE34s+Q5apFTlompqMTOBnRNQMBsga4RqWu7O7Y3IiVczTKyxx5Zh6sVc0jUZJIUKhfpIsEs8HZrPX8WEeer1reLRCmJoyCr+IWnqS55nujNPNNqtoPkvnT9GParKDbOUZSjZVXhwwhBAWYN4j57lvhAyibt2Om6C7ZXjrkzwAzVHaLsYDgf1+PAcACmJpMQ1VmHc6isMNsse9V497V/G7oyrmH7HTDmOZcpJGXxhLxcr603YXXFJeUHePYHLbsbzWxe9pnCoN8iIcnuEA5mBRmiL2kV+TqByowgk4J5DFAD+cVfjxrmS74ZWlUCkizpVYj1WOFNNsrBo5pfi2qlHqtt9k224rVrUxcVodtlGjEMwk/JseIazfDQ7iXpF3gYDX5WDVWh5FBYmswLYvCBYo/CULCH3FIhW1FgDC53NJozKxKQGD9CI8xqnlqlE0X1DWtx67bcnU0rAM7fq+0bh0tGDFsF/6vSsw7+39KO7cxxhZozFgsm5DThEwuafP1trIDlXrvT731lV++tgLdXs3EdmqA4JfOMcgfS+lmE0OK2+LfafxXmLUhP4hxa1y4NphySqVbGYLgjDC6BnIFNto5vsbu5A+QjVBZF8As6KJHVgisyU6XexjB8nqr7AaE3OEfClFtx1yWQ5/EU9WD+gvLmvYPfQMANUbHHRKu/QCYejxeVdBj18cMvueRV2SjGh4wLp9c4OrMjwwwZzy3oNdgmjWqpb4S4MKHOqa5zdamWDqoUahSGDECPbCnnKhMTQWI7oByimS+JbMgYFUuL7RBwlGyR3AlKA/rOS3GzMBbmVaMgw7u2AUkBk4R885N2gmv/NQKoDanmaskoPOnxnPMHrAPt4mlKXXCc8zdE9e1DCoBWhMcBV+JoMCCq5krdlsUmWn5DxILBFXwAqgHYNwf9VYUgFHP/1Am6V+5D1ImVh/Fj/BkfDV9RjU9ToI1zld6CrpQ/Bd2EnKidNn8H2kpjmHaEN4RbcUAhmdIZaNRPupSBPbrTd2Mv47l5PtXiGLBl8W0mxbPaNDXPm04Hzc1zmkCGqdTE8odvOa1Q1sr8eMzyB0bjPW+Oy2hvsRVdTNgVibz4NFvbMEisEIX+in3ZQnr1JE1pMBaxY4h9m0kJLGrxwJtK8Mkp1Cg5lE05plkpubQ0Vcxuk2m+1P05oboKCAtAWDV47UNE6xCutfLXYttKl3XoF0bz0phC6DydJXamwcxUniXglU/UyN91MaBpQYXr7rQKdMEtQGGbOy5y7pN5aPHnd8AoNn959QP7EJBjQTM28kdKGQpGoJL8KDSwa9lj79QdsA8KS681e8MpHdlUmP5gx7PMpsp9uauO1bRyRxQX49bCvHCl+8qbdIzX9Rwlbk40OVRpYzWJ6b0HGNxMMZXcKo2hPS7y7cJ6XOTPCelxkTcd3S4Cwe8O0bEZN0n19uWjKS6bWyU8cHGr0RiVB3mEqm2gYY4r3qocrLuMYYLAsE4Aic4k3CPQYOiJB8iSTJhxqQ1QMqnOW6+ZWLP1DtzXiC2EvNVK62cD760DsUVp9ZsG0p1i6t43nl42yCZ8OBzGPBucx8fAz2I+OOXx2dHZ6fl5+mp8dPZ6w6QDtDllu59j+7sEn+tf6U8nNS7YG4G5cPbGJZ977AqT0v2oS5WARXW+5JlY+CM0XvQ5ixpN+6KN5Z63tl2Kf68fZNj/VMF9L5oIKcws8VFO1K5YSOBMr28Qk/YEcj6+VcjZltWDd2KCuXJWTFKX8m6MxmkAmxztvorvcPMImeZlhhLdAULZovHsVHfPpK5E6evGICBdyK5KZ3fVi92QtD5KfK+VnDLvfXfH+EsUz9jmTiSDRF87RPH+EoVLuu5Df9pnR8NXxycHK1hspiQ8ux7iPfYO1RCByY8GrUTpFocmVjJPVroKcFiXemywDqbv7AxMo7y3Dla5FE7Hgd8mkL0Src11BB+ah8fqmgxafbcuWJstwtE94vFc3TfKG6iWa1NxQ+3bPzuagEOGar7uhmjGCF5mgGqSXpM5G9Y8rfN9w+3VIY3iDe0gpZDRzAZNh++pz7M8EKwJhozRK7bn++zVJwmkwtOVc2FtaGWCVhlzI9Jv7J1zKvML8jtYm2Rk7ObCSoDMNPSQdwNX2B+Bbve+OHzN7Oj1zgT/iGXhQc5MKS2qvcmq60KNQaWolrD7hjF6siTWB8k7MWeHAcbwGVWmp5aZsiiUtiwj4yhfdDP8XhyFObgM6IvHoTvFDw2U3YBZJ5u1qVxMaGOT5xW8fI99meyUvSxJq4z0wyQZC00XPOw4yhvKq08Yda9cY69BqWzCGYAkc7ZL01a1oM8x4r3xfjbkcHx6dBZnnL+OjyE7i89PYBAfnUN2kg0Azl+dbBBplA17hlOa55x9L+xfUwzFZVTxy1GYo7vGkGFpD8862TADaCOSi1ilmj0RVjg6L0ypYXY2npwO03jMx5P4mB8N4/Ph62H86ngAw+x1ysfD8w2Uep4UujZc8Bn7DnQuZEUmpEu+IBLd+9Mr21Eo2NQgjbOnq7jH5rqd9bVaG0tYvTXa3OnNosuVmFTOpdxYH9pq9mxvDXt3PEaGKdge+whwi6EmaWd09O434KuwDkGTSva+sKsUBtok7VVDobbPTrdOK8Zrit3D1Qtg7HcqW4TN/6xz0c2TQcvHk1tXNvify+eGvvrmjcsV136ghynpzoXmSezWRRe1Ce5L/6OL6ORkAOfHg0EMw9fj+PgoO475Gd5ycnx6enJyfDwYDAbb3IoRbu7wV5ysvITD35NhVbgko3VFRgutcFNKoOFTZzAu8SmlfN2ZdKt8odfWxytbrkAB2rhLN3Y6gROIUJVPrSRDdZ7Rn8ppoFoToK7AqrB5agYPFrTkubuoqWUu5Dz8vTyjRq8nT/y89Y1XnfnxSD62hn4S4o8w5TmbVPYJ9q+x3bI7dqh6z0WW5ViGLfBWmA3ngChH/iPIKV56dIQdZeNXe5x3BJQFoHSsHyagNWTJqumuGKx7jtN378zdhcA3wakkQ4iWdwDTMvCc0etGYCe6V/o2+Wr4H5W+XYZtjNxh8jd4dVbObvxFVOwnF/LYd0NfsIeHh5j+PTwc0AVdLbt0K+T9kYXO1V4tA3X/t99++y1+9y5+84ZGMZBPmk5ZY5yxUjlwuXZCH2dgZ+DPvoXiAn8k2DuPdgZCM3UvWcvvowLUOSSBlk+eGP1BzSFQvj5vV1clNCVCM0roAnkh6oaRsSVRUDV/+nx2K2rIciGBHbmbnQjE8HkghnRK3IdsNne/ctGW7mG/9aNRAms81nAnfLbYUeHJrv91/Z5Cf4Qb5q+3OcB+5RqyfX/nHB6wZL/eXB5UjIgnIhNc+gawepu1oV1PGB0HrTNHDGFUxAunn/3la8xdV0e6VRg2a+4YNKhxx4wICf+0cT492LJ5ru7JO30MCG+9Q93h/UXzEkCHbghxP7Vtq1A42T5L27T9emfbKdz7gfXG7ULdDppu7n+o8dNT/nc1rg7kdyfH9sPc6GBo0+Jt3A540KGBs2970UxocOevlujgTeCntiLi5po+NsFtottK4fnBX4ZYX/tRSzpu2IxmSJcEuT8DHf5QYzoIbO8Vnj9LKQU14xowI+4ixk9s/5XSVd1LgzWG7tDe8F8710722RWlXnP0JdgI2WdEKN3EV0oXrdJsL0WSezzndAc+R7277BcGJ4urCrmY0tleHBE3FWiz1157Ggk9W5/IIBSoCICbmZBTqyTb/3h50MEv58YfHdte3VKKTJhbRr1dHmM9YkI2UaCRqzz1ncDTrZ+67/cM+wXhXxH8gk+hvnvl/v6+n0vRv+f9qbo7FOiiYLTuEB1uEyNeMeEF5rD5I54oHXsM4yaCjVaxqyb82+EBitccuJaUd/diKwO8GnDu3bzNHPymaruWkTscWkNfI6e6DV5UUjXmRnNtUujp2bb87icFl9vWeIEKrJVXPnzSiVlMcsNDvnmJPnorzU1iR+U51/5UtYsPFVAnnHEwYpNuYGWde4bxj6gXYQAk6kUUAYl6EcU/ehg4oVPdq/mIwilYyEbLEK7UajGQJo65nrSJ6U64qHsJuucO+NUHdUdhzBFNo0m1DbN4+4AlOlEvuuE515g4+UlJCA+bf/+Mo0Y9XPZQ44U3gbIKQvdF3XklEb7/8eYylAG4XSNMiwZ9VuG0v+dG2TtoVG5iiREtI/fxUIPNF3jAQ/tDW3RSuQGHspIoMymmvr+3POlnjdDz1yynIO6gho8Nlu6p+cHFJPfZ3hNjBk5ywV07A2dZ7DJWvSLQLHnd31u9hogHSj+MlZrK/ssXjDRN6NEB2yXp2l2wGnoD8C4zo82IM6E/9g6IbPUM6Y4SdJMq3W7vQVpaL7QdlvT89STUKcopGxHQUY+NmrJgVAVAR79X/P17NPJ6onn9wdO3fYS7wSvObta27psDIkW7Fgaf4p5wuahwS0Sf+Ritqe5mKnKSLng2KEA0bLxg793c0VzAa5AX7JJEoZs8dqLJhxQANhjVXUY9ylxSO9MqDh/Rs8TJ1VHlGxRVV1OXXZcFaoDR0WAw6v8u14/rMPOXYxVaKPLwsVQWbNMxAZ8vrQKUNRGr4g5agAotivK069mNPyk450IisPBi38tWmmdnlogHzgRtpdFBf9v4oA8Mhlsy/M+lKzDC++qBG3y84qq2HSNGl35uUqS3IVrUwmaDqqCKMPfoht/h/WgrBLuPSjYpjGN0pvikwv4O++vW1R5NVHcCE9azBvPUTNu1cCvibp4xKQa7H8RCu5eLBoV12zCY2+toM1QcszziD+oe95vj7XBfTa+SSGT7Y2J2Qme78jYn1ByejN1lQi2+tsEVa27xJaaFB44ZcDyD06+n5hrvErVz0mkejpIULaF09fanDzds37EVTWaJLQ/CLZh1Rqb+LADGPh8sSENFKphYcimltd8uoCujys43DDBB2u7n7q+vGtNQnykRiqWY7jMRZLhiZDE6vDs6rFzDwy/1pw8eD5c+GUFnxXwSrNQ5poq9z8ML4a6bjDOY052TK/yNuaIbcU0B/Ba4WcQOXuwKTvE1TmYN4JUw32sqLl0Hs8DXzQ8A3GCSy8miFZ8BqLY9Dh6+tkBuOnBNom3Zp+ByEdPtVYyXuDdtdTSjF93QebqvGcFBWDMAhmqMkr/Uab63IZeyIuG2Xdpr3f39VVJq6XhYw1eskzatFEvD+WvkDeqnjeRH/bCb06jfrE5DNESVi/dHeMfj3312yW+eZj5g1XuK6TfEczsIj9/QOI4HZ/HwdbQidu5ZuhvbrkPMNeA6Zlw/c0HgZhtyFusHFLpttA+B2fpRN8rqMerGMjvRxOjVhJ/jDc/xydnRWXx8cjqMx68maTxMX5++mpye8gk/jRpxQZ+HroZtRNjaJFob//IfRVkKQXWfN0I/1RdTukGOpZjD1vPpBhB0h+Bt3zq40C1XNXikyyZ1/TGZCl7bdGlaKF2DY7nP8hsPpaP9m1q8VtZt9VeRMpywcQcyw7rSV2jw6yyoQsKpm+b3Y3oRfi7G/Dy5AX0nUmhI6/rGYbqk9ZAaHmYovtAOjOk3np4xvutSaBHyFIP3VjHCY8+wt17VsXCOHT8ck6m0xMWhxfsXf/Uzd0XCnu5vwqjsF7ye11eCBu6vcPp7rV3o7nJl7JzLBhzn/XTufu8i3iiv+Af9lJLbThYe7GGRc0EKjFTxF28pfIrujqJQve/ujL1ofSipYy58RlloLHb88gXdoF91/viIj/8sAQXXp89oo2g6G08MkwmqacmiiwnPDWwg8f4v3pI6YOs/wrRySsHRpRbeQooif8dm88NP7qYc9+Gl3ZD7P/05pTVkdeRb/Qmrisq1qXrliBV/aJm1y3VJdQ+0oihwt75t08Z9//PNBzRafO3T3OkQze9R2vJ7t+ahPpxk/z2pRi6npSvUcjBRJPC26VaZav6PxnXL7V315Ytr8QG/wvD4WG0y+ioDFXU9/jc8WDve +sidebar_class_name: "post 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"; + + + + + + + + + + +Creates a batch for bulk employee creation. + +The batch is processed asynchronously. Use the returned batch UUID to poll for status and results. + +scope: `people_batches:write` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/post-v-1-companies-company-id-reports-employees-annual-fica-wage.ParamsDetails.json b/docs/api/post-v-1-companies-company-id-reports-employees-annual-fica-wage.ParamsDetails.json new file mode 100644 index 000000000..74ca07acc --- /dev/null +++ b/docs/api/post-v-1-companies-company-id-reports-employees-annual-fica-wage.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"}}]} \ No newline at end of file diff --git a/docs/api/post-v-1-companies-company-id-reports-employees-annual-fica-wage.RequestSchema.json b/docs/api/post-v-1-companies-company-id-reports-employees-annual-fica-wage.RequestSchema.json new file mode 100644 index 000000000..af8ea06d3 --- /dev/null +++ b/docs/api/post-v-1-companies-company-id-reports-employees-annual-fica-wage.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","required":["start_year","end_year"],"properties":{"start_year":{"type":"integer","description":"The start year for the report (must be 2011 or later)","example":2023},"end_year":{"type":"integer","description":"The end year for the report (must be the current year or earlier, and must be >= start_year)","example":2024}}}}},"required":true}} \ No newline at end of file diff --git a/docs/api/post-v-1-companies-company-id-reports-employees-annual-fica-wage.StatusCodes.json b/docs/api/post-v-1-companies-company-id-reports-employees-annual-fica-wage.StatusCodes.json new file mode 100644 index 000000000..4ecde6c05 --- /dev/null +++ b/docs/api/post-v-1-companies-company-id-reports-employees-annual-fica-wage.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"202":{"description":"accepted","content":{"application/json":{"schema":{"type":"object","required":["request_uuid","company_uuid","start_year","end_year"],"properties":{"request_uuid":{"type":"string","format":"uuid","description":"The UUID of the report request. Use this to poll for report completion."},"company_uuid":{"type":"string","format":"uuid","description":"The UUID of the company"},"start_year":{"type":"integer","description":"The start year for the report"},"end_year":{"type":"integer","description":"The end year for the report"}},"example":{"request_uuid":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","company_uuid":"12345678-abcd-ef12-3456-7890abcdef12","start_year":2023,"end_year":2024}}}}},"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 - start year before minimum","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/post-v-1-companies-company-id-reports-employees-annual-fica-wage.api.mdx b/docs/api/post-v-1-companies-company-id-reports-employees-annual-fica-wage.api.mdx new file mode 100644 index 000000000..f49aae66e --- /dev/null +++ b/docs/api/post-v-1-companies-company-id-reports-employees-annual-fica-wage.api.mdx @@ -0,0 +1,75 @@ +--- +id: post-v-1-companies-company-id-reports-employees-annual-fica-wage +title: "Create an employees annual FICA wage report" +description: "Generates a report containing annual FICA (Federal Insurance Contributions Act) wage data for all employees in a company over a specified year range." +sidebar_label: "Create an employees annual FICA wage report" +hide_title: true +hide_table_of_contents: true +api: eJztXOtvGzmS/1d4fR+SAGrZVpyXgTuc10lm/SGTII/LLTxBm2qWJI67yR6SLVtj+H8/VJHsh162HBu3dzcLLCZWk8Ufi/ViscjrRFdguJNanYrkKKm0den8IM11WXElwYZ/LTIpUgOVNs6mUFaFXgDYjCtV8yKbyJxnl3wKySARYHMjK6SYHCW/gELyYBlnvjvLtXJcKqmmzHdn709PjtnT9yDA8IKdKlsbrnJgJ1o5I8c10rLsOHfPGA7CBHecTbRhvChYA4ZJxTgLcJmeg2Gc2QpyOZEg2AK4YYarKQx/U7+przNpI6LK6LkUYJkAx2UBwg8j1USbknjDbD3+HXLHnGZfdC55wb5AXhvpFowrwT6AkDk3wBy/AjtgtYVJXRDGMSiYSIfwHEw9qy1zM+6YAhBIcQ5GThbNTBhwg+yx1B8nVEjiB44UyLGcF3ldeGphQhDnIy2bBr4Lxu1C5TOjla5tsRiy44kDw0p+gQvgPBf+qMG6AVvoml3KomAGcpBzYJydh49ZXUtxzi5nMp+xnCs2Bpwkwa90UTA3A3b2C7hmnX88NTA5mgKJU5ScLrVnDJSotFTE1XwG+QVRsY672tJkDTgjYQ70e5jc5QyUZwo4v5Q21xUcsfMoqWGwo0sjHZwng8TxqU2OzpLP/kPyY5BcpdPaOp12FiV1iwqwGZRjEAJEMkh4VXWbUNeKG16CA4M0rxPFS0iOkv9KfyGCx59O0/8EY1H8B4lEHZgBF2CSQWLzGZQ8ObpO/FCJdUaqaTJIQNUlDj3aH71I91+mBy9wJAETXhcuOer+frOsYm8RSykVWGKT4A7SMce1Of50irKFWBi3FuUWJeJSuhmutaEGOS+KITudMKUVoOgEbRAD34ZXVSFzmv4Ty85KqWRZl13aP57OnKvs0d6e0LkdEmOHuS73IiPTii+MLgr6vscrmYaeUk3/NRBMOz8/QxgoXcPkZtBwuDVEkbEVd7NkkKBQSQMiOXKmhmX2oF58+3b6lukJ8SeQ2bIcNzc/BokN6k1rfOL7HOc5WHtcu1lydPbjpiNGxl7yaRzfgK20smCR9Gh/hP/pY+J5DpUjCUNrCMphmw6n93632PB6FaMmO9Sb9VnSVSui6TkV/rSOG5eh/SNJE/6fKMkGjb+THmmPyBoZ9cYwOUoC2e1sDtoaiA7ZNwve2kSDgbat8QikzVIrXPA+/J8GEtf7pseIliypN6nnKh3q4D0Hwm3nhdQaTt6NFiixnhKSuuLIgdVVSPjBeJQ/F4cpvJi8TF+9frOf8nEuUpgcjJ4fvniJvyyv+FESv7VtU/yB+uNP+EtfMI5G+6Pn3TmN9keHN/i/QXK4f7gqwr9qx97rWu0kwxtIsN8UY9GD0fQBbb/VtcmBCQ2WKe0YXEmUpA/8ApitjfcK0Vqx07d7tOzSsjkvpBii4d+iM2CMNnZVDcLv7aJyYziaC+mgtLdpIvXOLgA75NzBVJvFhjGo1Rrx7jPpSwhgLDq+MGfqznSe18YO2ddFJdGIL7x+XcCCSQHK+V7YnjsfRsFe47uYgYKcgdMtSa99EfUO0JACtkWd85QYLmYk1QZYHvnU6LqiAAed/FI0Ma5lIViOZrUM7WdciQLDFam8T+q4ZMJcgrUYfd4K+VM/0rOMj3XtOkxNQ+TUsDOQjihtbSY890i5IqWuLSDnvK5cpUGXaZ2VdtmElKQjWGe99Y8K35WXo07HzuSSDQpyyb1+UIdhcvMDgTjp0KCgkqWkZOk7HDT96KU2aPZojXOqVWU0Ojo+LtBsOQxy064tHMNEG2DBc9/fAHzrjfSORoqmAFnPF2zGqwqUD/pwlcZaLFDKSAwCL+KOIoiXZbbOZ4xbdi4VmYKsUYBszosazgesscGewoSEQdQQ1rXp2eyOzofsC3j1O3vnhznx6yXB7hgBEcw0b7o/Y9NaCiDPUCJng3QOf1N/GbH/F0YM4+9mIGnZuSIdz/w6ng8InF8rv0MLIs848y3ZeWjKwiItfJgf1Nd//KexlYjCcdzGrxPFPoyTqNwGCphz5fz23+koIIugycEaSsVIp3HTQ2YjWKRxAUP2XhsWDPSgR4LwEavO/X8zRHVOaxt/CVtgZP+4DTwwztAKPk7Ism+fS1kXTlbRqqIeLSle/HlV2eKXHVS6P7aVatrYc9zaCiHxEy8+dUbyO5g1Y3uG3C41v/ISYugdOEq5jlZscm38DkngZmDoQ+mGwbeP8E3JP2pozUMbUXsyRNFb74nRZUvwrKWo6qJIfjTt6ipzenvDnp1b1wDTFrCtSccpfwjSn36XbpZ+VJB655fcbG71IciOb4pLg3vjv9b8f/+aI6WNDrvPh+9ofLQqFn4zxORWtzFkp5QMrLS1EkMsp9mMz4E1dqiAORQW1y64kegoGrOS5NJgotE89XB7YeSzpDvDNQ2SNUHxmKuLjOe5rpXLBGAaL6vVpFYCRFbxRQnK2S0BM+a2+tHySrDWi5rf10pINf0AbqYFm3HL4misGY3WoAfM52QzqUh0c0RaaSsfFNk/MAzAUVkYFT0nRvJj8DlhCWLIPhXALXQSpA4j1gCH8RI72uHmKfDCABeLLFJ81Akge8OAbAyg2nmsAVhKixYqM7p2qDZbNkm+Rabqckz5lTUQl4L8HtDPvj/z/VlIeqPbDbiCJGS5VhM5tQ20JtbciWurvbtgjh3DJXUME65tMFvW1nUDi/XA4mwn3LqoLVkhS+m2IFzTeGcWvkfEgQYjGszOdF3gkQSGoX5lIuasAiO1aPFiZkkEa7kBZdNkLbb1vHynBGW8O5pDOyg344o9Z6VWbkYnQ5Pa1QY8viaTrERtnVlkFgrIUbozxWVus1wLyNrAbCPitvXu/PwV+zLsu0Yc74YwDPP4AKNowh94XOc0e8mEnMrG7GyBayMAewe4Vua+7e5ov8icsNpVsIcBrMfqZAmZnkyyShcyX2R4unC3tS7vxcRy3foug6gVaRSIRl94nhs8WjXbdabXbAfLfez7MezXcGxcoCnHyKrBwwigBLsBeAXkXLOQSNnmHZe67oL2xCu3AJ47OUfInobf4wYMDAdgejKJWZ1NmNvj6zsse9N497V/15xM48nwnSVgzAs87c3q6hZ7udlbb0N1whVlC7n4nZbdj2a3L/tMF1KgVcf/e8AxrKBA9CGjonDY1oQRFFKwgAA9UFj8zdAwe/posJrjCIqk1wEbsCqEbAZQVrWCjVAb99iI2aOI4qlv05YY4LbLdnIYhE+rseYGw/DY7iH5F3UYA37WDNVA8hBWJvOACL5S7lFaSvbQtlSqXhYYk8tLHs2HFRkozB9hEOYMz502GW7CtmBbbrm7mjYE/H6vjW88FkEKS1KOtq+p11nC/5hx7NIc17g5OjNAAhyLTmivf5coYLXX7vz71MTVT9bQe9KqcZuaoDwlC4oyB+XCLGJq8a74e+1/CnmP0q2YY+t2S4NHDtnUaGsx3REHV0CbgW2xTmixe7gDtEdoIoq4L1iCRFELrshM1+YugeH9XN3fkXpHcxRMuZPzZQYFHc/RDxYPaG8+efodAH6IRj0mRv8JKgs4HtTSYdYnDL+yJQ+HbphbOHXWp9NbjD7sEIzK6xyYDWizQGX7vv2ngEvLxoDGrQEcj1qWoFKqEUtLZBnXtlalFnIiyWxHyDGb+ZBg44lRtbLYHoDnZI/l3lBaMPNgxe3COiibRtGGL8cGZAVsFstfbo0TfPufMUB9Sq1WK0bpyYCz5Fd4DryM09am4jjnR4T67ioHwCgiYMCVONjfJ64WWl/U1TZePiKwGHDFPQCVJD21z4ZJ/+yrPdc5W0q6N9uHZClXHsdP8c/0YPScTvy7Bm1c6PwCTOP8KemG1aw7Cf8StbXBMElECIR7eUCpmDYCDPonU6uoHsvT92Ov4tw+n2ZxLLi6epxJcSH6pcW7T2cJ5vY5TXz1c+b41WNOKxbOsjAeFiwzGu9+c1yFfQdR9DlhXyTy4NPsiWG0WDEL/RNy2QO9fpK2tpiL2DHFfpdJSSxqCcS7TvDWKbSQPGRbj2lWWq0sTZOz2xaar3S/T6quIcIiEdYM3u4hkk2AW6/8s2h7x2VL/IujBWtMKXSezzI3M2BnuhAZBOeTdM7vlhHQtKDBujuvIl9QBChtM+ey4OEwDyP+Yg6McvPHJ39nXyM4Fj1j5/xIa0vJCHSS36UBdqoG7IOeA/uqsRDTsLecjiO7DjOUZN8rbGq2L/OmIL53dkR5Me4clBVtYp0OIR1dIgj1HLX1N0WYrl2qJyl9DwTjNlNOFXfaYGqPy+JuaT0ui/uk9LgsuhvdZQBx3x2zYzNus+brw2dT/Gluc+CBi9uM1rsP04iBgVKHCxVN8qDtEir7sE4Amc4UXCLRGOjJKxCZkHZcGwt0mNSeW2+YWLf1DtrXyS3Ec6u10c8W3dtE4g6Flm87oJdKKwePPD2xLyZ8NBqlXOy/Tg+Bv0r5/kuevjp49fL16/z5+ODVmy2TjtRKOu2+T+zvD/h8/8Z/eqtxxN5KPAtnb/3h84Cd4KG0v6WxDoW/ynN/FOEqUDB9PqLG0L7qo3wSom1/xP9kGG3Y/1T57SCZSCXtLAtZTvSuWEjgQ69HyEkHBvk9vtOo2Y61gy/lBAvto5iMSN8WhVlnAFx2sPsqfkDhkSovaoEW3RNC22LA2hWZyX2J0s+NQUSWKfsqnd1dL3ZD1oYs8aXRasrC7nt5jD9ldQ8x9yYZlKO7il6+/5SVP3R9CsPpkNFVjmdrVGymFdy7HuIT9o7VEFHJD/Z7B6VYcVDIfFumYa3yiNpXgMOmo8eO6uDxnZuB7ZT3tskqf4SztIG/SyJ7LaztdQRfu1dJ2poMWn2/Llib7SPlqOOFvuyUN1At17bihnZvf+9sAg4Zq/mWBaKbI3iYAZpJBk/mY1h7u88PDe/uDmmUEGhHK4WKZrd4OvxOfe61A8GaYBCMPrEnoc+T9iaB0qzCW5XOxVY2epUxtzJ/5N05pzK/aL9jtElBxm5bWLxibDt+KGwD18QfkW+XoTh8w+zCLe8dGf4dy8KjnZnSsagJIatpCzX2G0e1gu4Rc/QUSWxOki/lnD0CzOHT9XSeO2briq4xCgqOisXyCX+80hfm4E9AHzwPvVT80IHsBxRLp1nbysWksS67X8HLe+zL1FLZy4q1EuQfJtlYGrrDu+Mob+lcfcKoe7M1Dh6UyiZ8AEg2527HtE0t6H2C+BC8vxpxOHx58CoVnL9JD0G8Sl+/gP304DWIF2If4PXzF1tMGp2G3WNTWhScvZfuzymm4gRV/HI05rhd808ZoAzPlk7DLGCMSFvE5qg5MGHNRueBOTUSr8aTl6M8HfPxJD3kB6P09egNXlPdh5F4k/Px6PUWTt3PCp1aLvmM/Q1MIVXDJuRL4Z9xuAy3V+7GoRhTg7I+nm7yHtvrdjbXam0tYQ3RaFfSu0WXa5E0m0u1tT601+zeuzXsvbRjZHgEO2DfAS4w1aTcjK7e/QOvGK+ijkmTxvY+8FYpDrTN2uuOQ+3fpOzdVkw3FLvf3Axi+Pk3LRZR+H/6hv8d7/A/3A139jSu5Gj/4AAXDa/amWdJ57Y63hl/sIvw7YB0a782BmWKGmKMwE0hwQxITWPDf/831k54GdlhZzXa1yHosr0DZSlARaHy4rTxPRC6LlLf/i4I2ss+Kf8mRNOfRv9BdhEzM/6pnWTgH7E4SvbmB3tNEc/edfvYxc1eeM9kb+uzO3ScHPSkNgV6k3AllVfS30hNBZR0LXVlWd5CqRO8p2Er4BfA7SL19FKfk8LPOMENhNfS/GQo/7SJZoWfuw9tfEE98FK85rmNRrJw8Ph2B/49Bm7WCFogkdIFF8ZrN8NdTTy9GSRf6Mj9Z0bwFDYMcDNIUL8/t5bgXfvEw63PLuBu1x/WRttDb8vgmysoTzEj330VZpDgIzD24+QLmLnMobNM7W1kusC5Rw33BOJG05HS35hZt6HryqUjKHJd0oED4Xhi2bugCizWuOBzMELnNToC4sG/hGvh3CcQwhsub+Oo7DOEx4tQbSkZj3IWvv5HK1bIStSUkqsOnRNfWYmFfG2RbecxKXLk4YGNpel0DPJfr1P99TrVP8HrVN7sOLhye1XBJdknsrTXwTmcJfOD5pEXf2v4qPcaUqBJqrTRR/zAAmTrkNz1NYZP30xxc4M//1EDRlBnP9BZGaqZIj8iJMU6Ijma8MIuv6zUVaSnn4OXfcY2v7e0dqLxuiO1CK4yScLdy+6bT76C2j+ltRu4/9MPZG1gq2ff+kfJGi63McuJZ1b6tRfyrMarbY9jesJqa9tusPPp45evySAZh5i4xBtJuBO6ROnll37NY94Qn0HC366Tgqtp7QN4TxPdAe/768Y/h390ruH3per62rf4qi9A3dw0Qubwbwr2b/4bzcg53A== +sidebar_class_name: "post 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"; + + + + + + + + + + +Generates a report containing annual FICA (Federal Insurance Contributions Act) wage data for all employees in a company over a specified year range. + +This report provides detailed wage information subject to Social Security and Medicare taxes, useful for benefits integrations that need to verify employee earnings for compliance and benefit calculations. + +The report is generated asynchronously. After making this request, you will receive a `request_uuid` which can be used to poll the [Get a report](ref:get-v1-reports-request_uuid) endpoint to check the status and retrieve the report when complete. + +scope: `company_reports:write` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/post-v-1-companies-company-uuid-contractors.ParamsDetails.json b/docs/api/post-v-1-companies-company-uuid-contractors.ParamsDetails.json new file mode 100644 index 000000000..d8ab58890 --- /dev/null +++ b/docs/api/post-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"}}]} \ No newline at end of file diff --git a/docs/api/post-v-1-companies-company-uuid-contractors.RequestSchema.json b/docs/api/post-v-1-companies-company-uuid-contractors.RequestSchema.json new file mode 100644 index 000000000..86c634280 --- /dev/null +++ b/docs/api/post-v-1-companies-company-uuid-contractors.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"required":true,"content":{"application/json":{"schema":{"description":"Request body for creating a contractor.","type":"object","required":["type","wage_type","start_date"],"allOf":[{"type":"object","properties":{"type":{"type":"string","description":"The contractor type.","default":"Individual","enum":["Individual","Business"]},"wage_type":{"type":"string","description":"The contractor’s wage type.\n","enum":["Fixed","Hourly"]},"start_date":{"type":"string","description":"The day when the contractor will start working for the company.\n","example":"2020-01-11"},"hourly_rate":{"type":"string","description":"The contractor’s hourly rate. This attribute is required if the wage_type is `Hourly`.","example":"40.0"},"self_onboarding":{"type":"boolean","default":false,"description":"Whether the contractor or the payroll admin will complete onboarding in Gusto.\nSelf-onboarding is recommended so that contractors receive Gusto accounts.\nIf self_onboarding is true, then email is required."},"email":{"type":"string","description":"The contractor’s email address."},"first_name":{"type":"string","description":"The contractor’s first name.\nThis attribute is required for `Individual` contractors and will be ignored for `Business` contractors."},"last_name":{"type":"string","description":"The contractor’s last name.\nThis attribute is required for `Individual` contractors and will be ignored for `Business` contractors."},"middle_initial":{"type":"string","description":"The contractor’s middle initial.\nThis attribute is optional for `Individual` contractors and will be ignored for `Business` contractors."},"file_new_hire_report":{"type":"boolean","default":false,"description":"The boolean flag indicating whether Gusto will file a new hire report for the contractor.\nThis attribute is optional for `Individual` contractors and will be ignored for `Business` contractors."},"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.\nThis attribute is required for `Individual` contractors if `file_new_hire_report` is true and will be ignored for `Business` contractors."},"ssn":{"type":"string","pattern":"[0-9]{9}","description":"This attribute is optional for `Individual` contractors and will be ignored for `Business` contractors.\nSocial security number is needed to file the annual 1099 tax form."},"business_name":{"type":"string","description":"The name of the contractor business. This attribute is required for `Business` contractors and will be ignored for `Individual` contractors."},"ein":{"type":"string","description":"The employer identification number of the contractor business.\nThis attribute is optional for `Business` contractors and will be ignored for `Individual` contractors."},"is_active":{"type":"boolean","description":"The status of the contractor. If the contractor's start date is in the future, updating this field to true means we are setting the start date to today."}},"title":"Contractor-Body"}],"x-examples":{"create_individual_contractor":{"type":"Individual","wage_type":"Fixed","first_name":"Johnson","last_name":"Johnson","start_date":"2020-04-01","self_onboarding":true,"email":"johnson@johnson.com","file_new_hire_report":true,"work_state":"CA"},"create_business_contractor":{"type":"Business","wage_type":"Fixed","business_name":"Johnson-Johnson Contractors","start_date":"2020-04-01"}},"title":"Contractor-Create-Request-Body"}}}}} \ No newline at end of file diff --git a/docs/api/post-v-1-companies-company-uuid-contractors.StatusCodes.json b/docs/api/post-v-1-companies-company-uuid-contractors.StatusCodes.json new file mode 100644 index 000000000..5193e228f --- /dev/null +++ b/docs/api/post-v-1-companies-company-uuid-contractors.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"201":{"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"}}}},"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/post-v-1-companies-company-uuid-contractors.api.mdx b/docs/api/post-v-1-companies-company-uuid-contractors.api.mdx new file mode 100644 index 000000000..8605909a7 --- /dev/null +++ b/docs/api/post-v-1-companies-company-uuid-contractors.api.mdx @@ -0,0 +1,71 @@ +--- +id: post-v-1-companies-company-uuid-contractors +title: "Create a contractor" +description: "Create an individual or business contractor." +sidebar_label: "Create a contractor" +hide_title: true +hide_table_of_contents: true +api: eJztXetyGzeWfhVs7w/bVWqKpChK8q84vsxodmK7ImeTKctFgd2HJKIm0AHQkhWXqvIaWzXzcnmSrXMA9I1NipSlzO7U/JhxROLy4QDn4Nxw+CUykBRa2Jvo+ccv0Uu1zLm8eZEkYMyLwi6i5x8/3X7ai1IwiRa5FUpGz6OXGrgFxiUTMhVXIi14xpRm08IICcawREmreWKV7p3Lc2kSlcNzdlF9bJ4vueRzuIj2os/xvDBWxUJamGuOc8T2Jofo+ccIllNIU0ijvYjneb2JiT7tRZbPDTZ7WQ2MH4cRtbnm8+i51QXsRRpMrqQBEz3/Eg37A/ynuayzgtY9K7JoL0KsIC224nmeiYRm3f/ZYNMvkUkWsOSrY3xYANOQazAgLXVhasZ4jSLsaTfRnjEh2Z8Qdy/aixwBIjX9GRIb7UW5VjloKxz8ohAp/utbGauFnEftbUIsP/xw+goR2AXUMdSn0sDTdzK7cYS6xaXTKZjcdxbqvTKjYbDMM3UDKZvedM57zecwcZOtTgqyWOJWvxGf6Tj8WRU6u4lWzuaHxrRPDMNRGY62x0DYBWh27gY5j5D8536k86gX3e5Fwkx4YsVVHcNUqQy4pJXPeJHZcKRWZzaW28J0EPxa2EWdPJ0EuAJthDtfd9M8KbQGaZnvFOZ0J6bHzgDo74/+eyHnbF6IFD49XVibm+f7+6lKTI84pZeo5X7gtTjnN1plGX2/L1JY5sqCTG6esRkdnZnSS3+0JVuoa2YVKwxOJwybCchSIuVdO3laskG0F33ruWCLDW3tZTVM2NAw1nnUYwhkJrSxE8mXNTgfKzyyyLK7pv39t//BpWljGY7TYx9wrdxaLaaFBTzdGn4phIaUiPT7b3+vcP3+2z9qQxnGZcquRZaxKTAxl6rWKUBvdSF6ZvxBVoHD/PMWsRRpmsFESGEFz75uJW4s5sfqWo6i3jx7tOUE4X2ffcEuHZIiDLnN9qyBtmk1a0lA6wEhd1zFG0hB84y9dsJds9MUpBUzf2Gyt8VyCnrHdbb37cHXueBm0lprJeW7F/vjAkjieAH+xNy15KevT98+w9V4bYDou+TiK089DcF4muotifegh54EqrFc20nKbad8v0N8U2eGnTvvQL+wOo1KJWhrGi3UEkoSrWhPxmoAOxl0gV/B4xsPN27aqgpFGvVWw6+h4krLX0W+VbtEFdLqbWa/7ei9IGVooteggs98mWf40WG/179js/1W4IAMB9wo0YQTEKUOiF/+/tvfnXL2+2//6LmbPIOJhOvJQmiYaMiVtrvwMOLzbdgs43OyX5Br5Zxde/4mvdixBU7HOJNwzXBC5iYkFmkKM8R2rfTlpLWdd/L3GbbHqTWsaoyOMRMl0yIhiNhiyX9WaK95iSo0w4lrmJx6eS6J1lc8K4iUhYEU55FsDhI0L8drLY7IrORUcY1mV7cS3CZpkSM7p8z3w6G9ItxNqqrdxLW7W4y8k+Vdeb7a/zxiqFW65RLHByWTp0shJ7UOQiKJMrCANmX7Ww1XAq6jvchANqt/IZWdCHklLBkf7W/Xf0PSrvObcqraZwFaGn263YtyfrMEaSdLsAtFe8HlzbsZWerrlOpXQkNi2SvIlREoM18uILnE4co+dBJXjfoVQe2nZ2768to0Rm5xLE4dY4Ep+ap1vBcc7x92dva2Zoze4jA515bW3bQ/t7or64ZoNVKHLVrIFHRzvntfy09MfS4h77Tzamu0wma7Ko7UZ1WjasDonleYpTCGZ627+x7rDSOtv8iLPFFLPNTO7G9TeKdL/YlhYThWDcdSsFxkZg8vD840kBwThqFzJi0ySFeBreoCu6kylfYSNqADGB1kA7bIV+TbVqSmri1fQvc0t41dTbhMIMtIC51AJuZimq1zZHSptivnKQdJ0rza7oRLupTcTF0UJq2C7udHg+N3egsst+gMXOMlDKoHfkWihjyHXsOhLas0Z1b1rfxvUXIySwY8PYiTQf8oHsHRNOZ8OIiHaTqa9vv8iPePorY/LZoejQ6PZpDEB9OjcTw6mE7jk2QM8fgkSfhofHx8MhpGDW9YcHY1Ne9o2B8O4/4g7g+ihuPKnfPSmRSND44PT47Gx6PjQxgOjpNkdsxHo5PpdNyfDUZ0Ofl5Gi6Zutsk+i+lcf6aDyL6k7I2EzCNVq366H20YhvjcfcGpvvP0gab8cxA7XIJzrXWRRAdjofj/vQgjZODo8N4NDhM4unREY+PDtOTk9nR4GhwchCVNlZ0CULz3jUY+80yuQT5q4Ce0vNonRrppq2rcdGbv0YNbcg16VBfui/xhjVTWR3ReDhgf0E3zPeKdI3SxIhe5LbHhse4oc6EiF4qtK7PchQaJioNBgeNbILo4KA/Poxqmn/0w9mLqK3MR+N+r48qe1utWNUZ6ndi9FrOhQQoJWL76mo3aN0xbq87LwP31Z3iyx+PzUKFGt1WfsQ1DHuU9MeHJ0k8HPBxPJqOIJ4ejZL4ZHg4PDwaz5LxcbLKsH1IRhzGEMPoYByPxv00no4PkvhkxAejw/5BOhjPWgwbvNT34tdjzqcH/aPZAI4hPTo+Hp8czY5PjscHozGfHR6eVPxaek2b3OoIW+NV90GbS92nLTaN/sqnPBUQn1mtliSdiUmjn36Kf/rpp36f0Je867CXrOv3KrDgz0pyy+U3l6Cz4hJ66Dtey3++b50BHcKHZ8DBeHjIvoVUcs1egrSgO9hwdNyv2PA9Gn4vF1xnypLp0MmHJ4eju/nwHmzoT6JnmBp3tj8JTNlmrX8CL2IEwEuIGi/eksoy6o9WQ2dvlWVvVCFTDBm6ONovBRg0LDUYVegEWKrAMKksg8/C2B77jl8CM4W3nnOtrkQKqTMDnPkr0t65vH88rwTFziVjX4vr9NV+E1pHpK+uloDWXllpaq3+80qV4lpzvJ+FhWX98/WjTi4BO6CNNse7vXsOanWnYnyWQyJmwhl7fs3UnakkKdBr+OEmFwnPshsXJLqEGya80xQMtS+9Qvs513wJFjTTkJFfwapqSNKtS9Q7QMMRyLGkZn4kRkaGHypskvHI51oVOd655CX1qiZ5Uaxi00JkKUvQaF369gsu0wyVUyHZjSowTlbGql3kA4zh8y3MjPcBiDdvGJ+qwtaIGnsfTklOP3RAaQo944lDyiUDmSJwTeaC04jrSi56NmZ4wusH62Nj/yN/4uvn5XmtY21x0RoGueaOP6hDL7r9VJcPb5WNicni1zhp/M6dWi8rhsNVtvxB5lphsJ5PM2CvpRX2xokNJAe/YQue5yCdx8uS1y8llxltjcdHxgUX0m+5YaZIFowbdiEkseekPJQT8ixd7DHvzwojzGiD0gI8rcueyEm09xe1UOxrN81LR0MBZsdYLMGMk7L7MxfRJS/bUmkIJ+arJF43aZ3s+zdxA3H/LbX/9aU2O51VEwnDLiQJtYnbx4u9Wr6F89b7I08hAxJ/F74p85t04/JAgJjKM8b/mcsBUViecsu7jmIrAywwt4YMrrgklxjHMf0BufGc7MW/kIx4GsOjJDa8RJpm0GNvlGb+RtprDEH4iFQX7l8yry5ob8MnqBlflMGSoGn1yG6HprN8zVqWRWZFnoGbC/moxXjh41VmC9/swNLNuY2Q8zDzjTNXhIvevq/N1OW4rBHk7lPztpZq4ClqF7x+bBKlXYJcapj3xNcIfPcMP0jxC0aagnjQZejHDUMjOuk902q5wSFativyiVWbGzbkXFeDu+JxdS3kO3/64x+FXcTvJMTu8nNe1u5W3/mz45ri1tQCLf/e8//He44jrb2wW/5qFD5KZjfO+sNoxIZro8dOLWWFKGPQXkaJt+BXwEo5lMEVZOT499dIuChKsRIlQidFxvVTB7ehNz+L6ivsaBB1WAFTLi8nPCHXxSQFdJ9MCjnDMFk68a4Ks8FCmHIDTfNgRVlrmAlvCnLlf0fODwoGhtlYORvtQQPYFWgxu6EYrkZnySR1zpKHRPY3VANwVuZnxZsTTZcpMJpfQNpj7zPgBliC0VWnpKDG6uEwvsSOprd+CTzDSMXNJIz4qAugWKubkE0BZLWODoDoAKL4tCowSWCTVehaTCTlO3VDbCn5DaDfu/7M9a9ng3hcwUWWKDkTc1NCK3XNnai22rsO5oVluKWWKQmsUmaXhbF1xaIbWFjtDF2u4ctMLIXdgLCj8c4kfIOIQ6CexmBmoYosRczcU7bEPMlBC5VWeEGmZexzDcqySSe2blq+lqkLkVacQxaUXXDJDthSSbswqBPOCltocPiC013ItDBW30wMZJCQa1FykZhJolJ0FgfFbC3iqvXu9HyLfRn27TiO2yH00zw+wHA04RcMUFrFxiwVc1GKnQ1wTQBgtoBrROLa7o72TCSE1ayCHXmwDqsVS5io2WySq0wkNxSL2G6vl/ci4rJrf9sgCkkcBWnJLzxJdMGzMj1uDapGsx0k9wvXj5LlSopNMxTlqFmVeBgBFGDWAPdx8ol3pGy6HVtdd0H70jF3ChTHQshuDGfjhlg9TsDUbBa8Ousw+8chYLbZ9rLx7nv/OnRlXMP2J2DKMwx2TFyq271u602oXnJJ7lGe/kzb7mYzm7d9oTKRolTH/znAQa0gRfQhtSL/MqxUI0ilYB4B3kB+89dDQ3fxo8Eq4y+kSXcB22O5V9nc4zUlYS3U8nosj9mjHMVT1ya8iwKGZpep+TAIXxn9LOE8JP0CD6PCz8qpSkgOwspiHhDBB/I9CkoGdGapT6ALXmB0LrduNKdWTECi/2hSpQhNFGX+rMXWbrk7m1Y5hGTvVfqNw+LS5+mUo+xzeCuGDfgfU49trbHjmqOcBByAzyxosvW30QJWe+1Ov/elXv2kY7wnFRtXrgnyUzLPKFcu6+0T5Zg51+K2+Bvtvwp5Y6Q7MYfWlUmDIYfJXCtj0N0RJpdAxsAmXce32F3dAbIRSo0i2AUtSKS14I5gusI2iuH9rjrMZTM1zpEw55gH00LjedylGDygvHnvxq8BcFOU7DHT6leQE4/jQSWdoKRqmn7FJPdBN/QtnFrj3OkVxjLDXjOeWdBr0E78KJvt9q8CLgybAgq3EnAItbSgkqtRGFIAPdhCLlUqZoLEdoAcvJkPCTZEjPKVzXYAHCUbJHeC0oC+8lLc3BgLy7JRkOFt3YCkgJm4N7Fb6Amu/dcIoOZIFVdLRu5Jj3PJP4tlsWzjNIXOOa75EaG+/pwAoBbhMeBODPp9omqm1GWRb6LlIwILClewAShP6Kl51ouasa8qrvOx5XQvzYeo5SsP88f4ZzwYHlCKQ12gTTOVXIIuL39yulFC3C6HvzVapzJMJ8Irwg0/oJBM6RQzqxXThQzs0V6+m3sV5+b1lJtD2euPsyieVqqpud9yWjA3r2nmHrdOLP/8mMsKCYvMz8cs/+wfAdxrjauwtziKzifskkQefJmNYxgkVvBCf8W5bIDuXqQpDPoidnSxb7MofGkSBq9fgncuoYLkIJtiSqtScmVrSp/dJtV8pft9XHXlICwMwsrJKxsiWge4upW/Fm0jXNaiX5jNS2NyofNkMbELDWahsnQC/vKJavG7NgJaFpRYd6dVoAseAXLbXHGRcR/MQ40/uwJGvvkXL//MPgRwLNyMtfiRUoacEXhJ/oivWk7lHvtOXQH7oDDzVLNXnMKR9QuzVihkZ7WpNF/CIK3YEfnFuLWwzN0jUeVVOnpi5fM5MGd8jiqHKmysZjF97wcMZqaYS26VRtceF9l2bj1MG7+HSw9fxIuVQ1oCCHZ38I5Runr49uG9KS6aWwY8cHPL2RilB4XHgeEYaFjijlPoPDgPqi5TmOFgmCeARKcnu0oGpXqJTw0mqTDTQhugYFIVt16zsHrrHbiv5lsIcatO7WcD760bYovM0lc10K1c0r1HXl7aT2d8OBzGPO0fxyPgRzHvj3l8NDgaHx8nB9PB0cmGRbdS/e+h+9df4pb3p5Maz1nz4cAeoye/vahNlYDCP5m4Nwr/LtGLPqdRo2rffC/Mnnht24X4n/SCDPtn5RvjsxMpzGLNY/CH90l7Ajkb3yrkbFt7It/yCWbKaTETGvouLax8y7LzLn6Hh0fIJCtSlOhuoFArY+XMJC5F6evmoEHaI7ssnd2vXiqYIEzwEl9rJefMW9/tOfBZzu7H3IlkehVUevF+FbkLuj6F3rzHBsOD0eGzDhZbKAn3zod4j71DNkRg8kG/ESjFjINMJJs8DZ3MkxYuAxzWhR5rrONLlZlaem/lrHIhnJYBv40juxPW5jyCD/W3M1VOBu2+2xfMzXaacuDxTF3X0husr8OyNrmhsu3v7U3AKUM2X/tA1H0EDzNBuUh/kzkd1tx95/uG21+HNItXtIOUQkYzG246/J763MsCwZxgSH3Rkie+z5PqJYFULAe9FNaGVibcKlNuRPLI1jmnNL+yxInXNknJ2M2ElQCpqd1D3gzs0D8C3a59cvia1dHXOxP8R0wLD3JmTmFR7VVWXSVq9MuLagXdI/roSZNY7yRv+ZyrEgD07pcnlpkip2I9KSlH2U07wu/FUViDi4A+uB+6lfxQg+wmTFvRrE3pYtUD393TxMrKhU0zqa030/0wm0yFtovdZ3nlq2JQ99I09jcopU04BZBkznZh2jIX9D5KvFfej4YcRuPBUZxyfhKPID2Kjw+hHw+OIT1M+wDHB4cbRBpFw+5hlGYZZ2+E/XWOrriUMn45CnM011xRUjzDi1Y0zADqiM2CsZ4IHYbOA1NqmB5NZ+NhEk/5dBaP+GAYHw9PhvHBqA/D9CTh0+HxBkrdTwqdGi74gn0LOhOyJJMvG0YV6vzrle0oFHRqkMbp06XfY3PezvpcrY0prF4brZ/0etJlJ5LSuJQb80Mbze5trWHvlsXIMAS7x34EuERXk7QLenr3N+BdqIPTpJS9D2wqhYk2SXtVu1CbT0cbrxXjNcnu2KEEcIonPVfGxleDuMzQiOs1H+JaxUN6qe81T7dgXyfhp5iKVsUv3p/G/1260qhUwgJ46koKlG8s19XrGvaHh3F/HA8OXSkgX1+4/vlt+73BK8SyxKINrs4VtxAj5VP24v1pWQ+YG6MSQaFY0ujpeRs2wBd99LZN4nEQVcLRnmtTeyz6xLCPSyEpiFcbe8eXlTwXcVWF+D/9gHHt42ehRJ0zqTyFG2U4PGlzTjdT5UxcV4m5oyT1hg25vfUFgcDYb1VKNkN7jnu+p/2+lsdEfhJKQHOevFqd9DvelHoTpaox0qgt8mkv4lm25rVb8w3Rdo+HmuW3KJ7eq9e/blYKuqOi812lve+sIVmW8HZvb9eVAr9HZVLMESyfMbeLL7paX1iPRDgfQ6vCYqMe5rA/7GNxl8FgpeLHPVb8NVUzLxw9LnoNfCOs13m7Uoawhq6jzLkv97FNea7weDukXFBpxfAs1htQNeOprPl3Ls8gm8X1r3B9iVouXWDNKPdurV64VkMC4gp8rU4fV8SX2acz1logDkf8i+ikr57bTIpbKcu7w0Y1q/Guqza+w4C1IuP+xf36CtAXFcNdbFXY9yIwZaP5uuriO6Cuior/oaDXVRPfAXmriHgX/EZB5YeEv7mc7dYM+VhVbf9YYvyL1M+9//kXM3bRdSIuggi7D1Wb1VpLauYY4NVIwY/9+OTTl5PbDl75Q7b+XJ6hmpqx8EM0teeA0qWRWeXOLBWckBL9UoP+yQllyaDDcVMl/k2S4GsL8HevaD0B1lBstfD+JtAQis6LZtF5eWed/bu5+QHXc9fvqGz7wylkqKwUAq1VYa1CQe4x4Z7LVnDsGX6PhGqRIActgUvDroGSHAzYko1rI2JblVIiZWcNs5gMhNuVaqHuYcmk+nWf2suEGhUaSnJXzcBG3c2/qIU0ZFnWS29Wn7YLDPbj/sgVGFxR9JwVU5XmoyG+8f+i+bZLZcyXVNjOL7nkvc4F14oUdi23XX/Qry32/7J61db1612zVe6XqmJvg/md88/fTQ78Eri5iXHmWF2B1iIlw5N6kfpsQRoKm6Bl5Zwca3+viooYFHf/bhWauM2h3A9Vlf1dGd2q0TqkZYeAGA9lWU8QfRxO1C+i59H+1WC/9Hbsf6nb1rf7TX8HJUF7Z0eh8bAEc5/nwln7cQpL5c9M2zmxVFGTvG682GVS4Ne4tjUDd475XlPWxLoxc/walx6ukDM0xR1TdvyiWXkwcfLgEyD5BFyT26Zd64aGiKksA+MF2hG2zDnci84oUfxrZnAjrJngdi9CF8P3lXPidTDqtpcpHWxDpmq7NuXI/arDiuxo1fUs76eGrCo/rYuq8sOVGsG1QbYsB1p1IbWm+rMtQyo3m2i0axVdpQi2S8AOssPpyS/en0b1iqw1b9xehM438252BvpKJFA7xJUfjIoy7VPD/RR3FT0wMf2N2XLGd12xrCFL8JdLrHL6Ov3GjBMkLLxbQTdcqpJiGX5f7j98qTfukgI8BV6FWdn3kPEQ+Q37V2L6pmI6PGgoMrDmazVO+Km/+i84tGB/qTxjD/zLgP4QW/hs9/OMC2I3EhxfvFj7GF0NyoK9rnTT85bbsC7bPuF5Nxb7ffmCLtMfdHZ7ix//UgD6qz9+Qpmq6YUKyb9UkGc57Ta96kt/+r3XDZ+x9f7HzhWF4jLUIkj0yFe6aXpB3YtV517eDd6/tNN4DWEdAbsd9SWdq4v2pSNW/KFxma86e6seKPRzu7Ft/UZ+/+7sA0or72BeKtI2NMci4Pj/tOshTwM90PjZlyjjcl64gIkbE1mVN2+a8mbx/1FzBDfP1ZcvrsUHdQny9rY8Zhb/puDK7f8CSOnAfA== +sidebar_class_name: "post 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"; + + + + + + + + + + +Create an individual or business contractor. + +scope: `contractors:manage` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/post-v-1-companies-company-uuid-holiday-pay-policy.ParamsDetails.json b/docs/api/post-v-1-companies-company-uuid-holiday-pay-policy.ParamsDetails.json new file mode 100644 index 000000000..e5b4000df --- /dev/null +++ b/docs/api/post-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/post-v-1-companies-company-uuid-holiday-pay-policy.RequestSchema.json b/docs/api/post-v-1-companies-company-uuid-holiday-pay-policy.RequestSchema.json new file mode 100644 index 000000000..7699247c9 --- /dev/null +++ b/docs/api/post-v-1-companies-company-uuid-holiday-pay-policy.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","description":"Request body for creating or updating a holiday pay policy","properties":{"federal_holidays":{"type":"object","description":"An object containing federal holiday objects, each containing a boolean selected property.","properties":{"new_years_day":{"type":"object","properties":{"selected":{"type":"boolean"}}},"mlk_day":{"type":"object","properties":{"selected":{"type":"boolean"}}},"presidents_day":{"type":"object","properties":{"selected":{"type":"boolean"}}},"memorial_day":{"type":"object","properties":{"selected":{"type":"boolean"}}},"juneteenth":{"type":"object","properties":{"selected":{"type":"boolean"}}},"independence_day":{"type":"object","properties":{"selected":{"type":"boolean"}}},"labor_day":{"type":"object","properties":{"selected":{"type":"boolean"}}},"columbus_day":{"type":"object","properties":{"selected":{"type":"boolean"}}},"veterans_day":{"type":"object","properties":{"selected":{"type":"boolean"}}},"thanksgiving":{"type":"object","properties":{"selected":{"type":"boolean"}}},"christmas_day":{"type":"object","properties":{"selected":{"type":"boolean"}}}}}},"title":"Holiday-Pay-Policy-Request"}}}}} \ No newline at end of file diff --git a/docs/api/post-v-1-companies-company-uuid-holiday-pay-policy.StatusCodes.json b/docs/api/post-v-1-companies-company-uuid-holiday-pay-policy.StatusCodes.json new file mode 100644 index 000000000..55a028e7f --- /dev/null +++ b/docs/api/post-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"}}}},"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":"company already has a policy","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/post-v-1-companies-company-uuid-holiday-pay-policy.api.mdx b/docs/api/post-v-1-companies-company-uuid-holiday-pay-policy.api.mdx new file mode 100644 index 000000000..295ad2f4c --- /dev/null +++ b/docs/api/post-v-1-companies-company-uuid-holiday-pay-policy.api.mdx @@ -0,0 +1,71 @@ +--- +id: post-v-1-companies-company-uuid-holiday-pay-policy +title: "Create a holiday pay policy for a company" +description: "Create a holiday pay policy for a company" +sidebar_label: "Create a holiday pay policy for a company" +hide_title: true +hide_table_of_contents: true +api: eJztXFtz27iS/itY7kOSKtG2ZCe+PG2Ok+x4dpK4Es+ZPeVJ0RDRkjAmAQ4Ayta4/N+3GhfeRMmWI2e3zp6HVBIR6P7QAPqGBu4iWYCihktxxqKTqJDaxPNhnMq8oIKD9v9aJGXJWTyTGWd0kRT4R2Y8XUSDiIFOFS+QRnQSnSqgBgglvi0p8I9tSyZSEUo8xd/F70KnsoATcrVEl4M+uVHcwFU0iG7jaamNjLkwMHVgY7MoIDq5jCAfA2PAom+DSENaKm4W0cnlXXTquLxNU9D6bWlm0cnlt/tvNTWlb+g0OjGqhEGkQBdSaNDRyV002tvDv9rj0qWlNCmzaBClUhgQBlvRosh4akHt/qGx6V2k0xnkFP/lYEZy/Aekxg4FbmleZI6Rp5loQ01pf5mD0o7fcLx/eLx/NN4bHqaHE3Y4HL4ZU0b39g73Dkej4z2Lop6a6CQaHx4dvB4eHceT4WgcH+wfHsXHwyMas9H4mME+Sw+ARoNoAgwUzRIvc8tWwE2yAKp0wujCIoMMUgMsyEfQHMfxCW7IP4CqF5q8o3buqcHff6aipGpBhtH9IMqz6wfIfKTKcEF+Kc0MFPkvLqYD8rPaadO8mHHFyEcpcBFxQTwP5FAo0JyBMD14JzTTNafzquWL9dQ/wFgF8jnkUnGaPTQK36xN+BeqTYPuR2pJ/lEKMAACl+FqtD/XrWrRlgLI8BiJcMGgAMFApPAAtrNG085UldmCHCC5jI6lekiAv2CjNoUPXLWG+BUKg9tQIdFUZmU+Lh+cmFPfDkmTl2eC8SkIWWpyDhK3h52uVzXTr5BK0Zywz6mRnuccDCgqHlq8f/fN2qP5JOcWPBnaxWtmVFzrKZ9zMV1D66LZrJaMLJWZkYtZqbSHGchb2cwU1yanDwE9De3aSN9B6pCOXkf394MI8iKTC0BVcnkXeSUwTOl+ykav431gND44St/END06iid7cDgZHw/p8DWN7r9h/7Z++wK4q0AYq8qInBBKfvIq/Bz/BHVfKDQZhkNbYVW6ThvlhdKifzEDkpZKgTDEd0ImZgbEaccd8hXA/v/Sf+diSqYlZ/Dt5cyYQp/s7jKZ6h2rv3dSme8G7R8XdKFkltnvu3X3f3ek44wuQL2y9oeLiVS5H6QgM3lDjCSlRtZckwmHjO24ldzUrg8N7y0pBf+zBGK1DZ9wUJYdjsdTIvLGDgl/WjaOyLJPNXctSJvtL1ybIEbIYA6C6LIopDLAiCcXmGlCBcOWXBEGhvJML03nkiHosm83rxdw1XIsZQZU4HDccu5K7j4s6KUP923j8aNZL1uVHz74juH50fzbVupHc+8zbz8aQ8sm/mjmXdv5o/l37eiP5t+1vT9c/l37/GMBdGx61YIqRZfjrKD5Qw+CdkqTUjBQvdFXNIi4gbzXqLQH1m/xPEIFf5Zc4agvK+PfMZY9hqw5sm+DyHCTIWnvYMTn+MebQcvlYO9gOQT7JA35IEvBNonAVpAgvwtCfhfoleCIQKPBVKBlqVIgTIImQhoCt1ybHfKRXgPRpXL+SaHknDNg5Ozd7q+/nr0jXJM5zTjbiQZLom3KC5SSygqgLXD/+/KUr5ywJarJNWCHlBqYSrVYwcO2etCX+VpAih6MJjcz8GO23YlM01LpHXKxKHhKs2zhnKZrWNR+j7btqTGKj0sDuwVVNEfNQhRkFMVsZE3SuVoB9QbQkAK2tXvAUiLWxfSkwiRpj3yqZFlwMXVOUEoFGQN6fRbNuOQZIym6lblvP6OCZeitcUEWskS/sUo+7LggUWs67dnJXcjnAYj3uQgdy9I0hBqTKQjcLkGcnnRAqUs1oalDSgUBwRA4Ss7tlXZOQUiTTOwmaSysy9b8R37FN9fLSaNjY3DRig1yQ93+sB12fEARdvUnaWK7yeL3yDT+7Fat39mj0fK2DB4yzRRQtiAzqgmt9dYTN/uvolASEyx0nAF5Lww3i7DtUcwUGRUFCFznws7IWLIFrig75X7cBNlTLvxS0kSX6YxQTa64sNs+qRZ7MqdZCVcD4j3/QGFiJ56V4Oew6lll364a4c97x+bUzQ0HvWH8Y2HGadX9lYuibDySSwVhJe78Lv6lsP5fKCxyNqkZcU2uhN3PiZvHq0EjDCc3PMvCkieUuJbkyjclfpIW5IabGQG7qfzG+D+jFxGFoYya3hxsJ18dNrfC+JkKQ7Af0vQLZOF3std8XBC7pzF/YNWG10jjDHbIB6mIV8aDFgmLz4rqyv2dIKorO7fhF/Sdrpz4x7WTgT6FFPB5YrX4+rHkZWZ4kYHjhfuos/HCz8ubLXzZYEt38uNcTANn7EYZ4/iJZucNTi7P1cPbCeThVfOJ5lAlPJxEzYw2l00qlcvmM02MtKuhIeCHOfy6Mo/jyFiKTntPlMxrgpc1RVFmWfStalcWiZHrG7b0XF8DPCOAdU0aBvijX/3xb9zM4s8CYmf8fJjV2+qjXzuuKU7N/eBfc/7PMOdIaaXBbsvhN1Q+UmQLF/gQvtZs7JAzgz8XUmuOLpaRZEbnQCo9hBnJTOPceTMSDEWlVqKUq7TMqHrp4LZcxldRc4Q9DaIeB3hMxXVC01SWwiQMMjCQlGKCgTHDA8YcM3xrnOMx1dD2jJectZaH/KEUjIvpRzAzyaznGriRipudgxawOSg+WSRc2KWbItJCar5VZP9ANwC5Es8VLSd67WMglj8HtkPOM6AaSDqD9No5KeixejiE5thR76wegvfZk0DxWQdgAwMfJIwBRD2OHoA516ihEiVL41NKqwIi1yIRpT2r6YXYcfJbQL+4/sT1xz0RzK7H5VdCkkox4VNdQat8zY2ktty7CeatITilhkgBpHZm81KbpmPRDyyMdkK1CbslyXjOzRqEPY03FuEHROxpEEuD6JksM4aYqZdshTkpQHHJarwgWBIyaytQVk16sfXL8r1g6A9CY+fYCApTlWSf5FKYmUafcFKaUoHDF5JhXLBSG7VIXKaQS5EIylOdpJJBUjtmKxHXrTeX5yfsS7Bvz3J8HELP5vkBhqUJf5Y0QyvyhjA+5ZXaWQNXBwD6EXA1T13bzdF+5anFqpfBHniwDqvhOSRyMvH1MQnmgR831/mThJj3zW8XRCnsjgJW7ReapqqkWaLW75lWsw0091vXj2C/SmLjDFU5elYVHhKqfVYAx/Mgq8JdImWddex03QTtqdvcDGhq+Bwh+4IlG+N6DAQZEDmZhKzOKsxVpvsx016nxTee+/ehK6EKHr8CxjSjeMJWFg/oy9XWeh2qUypsZpCyP+y0O256/bQv15VVboV1RLfpFZ325hqXz0tWQ8NM6bPBqo4erCfdB2xACu+yuVI7KWAl1Mo8Ns+Vtr8Uz1yb7mFUncOw+KQYS6rQDQ/ttim/sIfR4ScVqwqSg7A0mC0iuLC5R65tsseGpVy0ssCYXO5YNOdWJCAwf4ROmFE0NVIlGIStwdZtufk2rQi4eK/2bxwWZjesXeWo+6p60A7+5/RjO2PsMXPa2ELCaUInBpSN9R/jBSz32lx+55Vf/aKH3ot6G9epCZunJH6jzEEYP4qQWnws/lb770LeovQg5tC6DmnwyCGZKqk1pjsCcwE2GFjn6/gWm7s7YGOEyqMIcUEHkvVacEZmslSPcQyfZup+QuqNnSNgSg2fdwXk93iKdjDbor45d/QbAByLantMlPwLROJxbFXTYdbHs18Kyf2hG+YWzox26fQao3M7GJ6Q0cyAWoE28VTWx+3fBZxrMgZUbhXgcNTSgWpTjVxbB9CDLUUuGZ9wq7YD5JDN3CbYcGJULE22A+Ak2RK5U5Qa1Nxrcb3QBvKqUdDhXd/AagGduPLIR/gJrv33KKA2pXpXC2LTkx5nTm95XuZdnLpUBcUxPyPU97cpAHoRHgPOxHBvz0o1k/K6LNbJ8hmBBYcrxAAE61Be6lc7Ufvsqz7Xuewk3avwIerkygP/2N74GI727el+U6GNM5leg6qMv026YV3tRou/Q63XGbYrwjvCrTwgF0QqrHQykqhShO3RHb7jvYxz/XiqydFgyuJ5BkVZ7Zrqpw2nA3P9mEJFlqG3zzks9AutAx5qjw29JZbf08a4DPsRS9HlhF2RyNaH2VqGQWOFLPR3rMsW6P5B6lLb+tjNPJnHDIpjUYsn3jSCDw6hhuQg63JsRyXF0tRUObt1rvlS96ek6ioiJBAhFfM6hohWAa6t8veibR2XdeQXuHltbFPoNJ0lZqZAz2TGEvDGJ2qc33UR+BLUgHVzWQW54BKwaZs55Rn1h3no8WdzIDY3//b0J3IRwJFgGRvnR1Jqm4xAI/kbV0DOxIB8lHMgFxKLLt01ovtvLYPZuD+ysdtUhS91HWrr7MjmxagxkBc2iMV7HtalI7Su5yhxcaLLIUsTy0lsv3uCIczkU0GNVJjaozx7XFqP8uwpKT3Ks2ag2wUQ4u6QHZtRnVRft59Ncae51YEHTm7FjdjyIA+oWgYKcpxxe3Qekgd1lzFMkBjWCaDQiYAbJBocPX4LLGFcj0ulwR4m1efWKwbWbL3B7mvkFsK5Va/3s2bvrSLxiKLKdw3QnTLKwTMPj+2xCR2NRjFle0fxAdDDmO69ofHh8PDN0VG6Px4eHq8ZdKCW29Pup/j+7oDP9a/sp9MaJ+Qdx7Nw8s4dPg/IKR5K70RdqQQU/t7sk1G4/kH1OY8aXfuijfKF97bdEf+LnaDD/rdKbQfRhAuuZ4nPcqJ1xUIC53o9Q07aC8jF+EbizjakZt7JCWbSeTGJJf2QF6aNAjDJcPNZ/IiLh4s0KxlqdEcIdYsCrZfWTOpKlL6PhyXSpeyqdDY3vdgNReuzxDdKiinx0XeXx1+8eMIydyoZhLFXQtz6/osX7tD1JexMd8hwtH/w+lXPFptJAU+uhzjH3qEaImzy4V7roBQrDjKerss09G4eVroKcFh19NjYOnh8Z2agG+W9dbLKHeF0AvjHJLJ7Ya2vI7hoXhupazLs7Lt5wdps5ymHPZ7Jm0Z5g63lWlfcUMf2T84mIMtQzdddEM0cwXYYVIP0lsz5sPphm+8bPt4cWi7e0Q5aCjeaXmPp8Lvt86QIBGuCgRH7ibzwfV7UNwmEJAWonBsTWulgVcZU8/SZo3Nqy/yC/g7epnUyNgthBQDTDTvkw8Ae/yPI7cYXh68Ynf28scB/w7LwoGem9lhUeZdV1YUae5WhWkL3jDl660msTpJ3cs4OAebwia1MT0240E2YdY6yRfeE36ujMAZ3Arr1PHSn+KEB2TFkndOsdeVi+IBE8rSCF/f4hOiUvSxpK2btwyQZc2Uf09iQyzt7rj4htnsVGnsLassmnANodc7jjmmrWtCnOPHeeT8cUTh4MzyMGaXH8QGww/joNezFwyNgr9kewNH+6zUqzZ6GPSEozTJKPnDz1xRTccxW/FJU5hiuEdywdg3POqdhGtBHtCFiddTshdAT6GxZUiN2OJ68GaXxmI4n8QEdjuKj0fEo3j/YgxE7Tul4dLRGUk/TQmeacjojfwOVcVGJCeWSLayIbvztlcdJKPjUILTzp6u8x/q6ndW1WmtLWL032lzpzaLLXiRVcCnW1oe2mj05WsPenYiR4BHsgPwGcI2pJmFm9uodPlHUgzokTSrdu+VQKTBap+1lw6C2b022bivGK4rdww1s0OZvki3C4n/SW1Td91/qIhUbBNvqIvQOsHAL02YuZdN7sbx9uWPzZ0zeinD7zHtIyKvzfIlvoQcEaDprNqTE37snIR9a3VLbec4XTrb2Xsm2Xx/Z7lsi23wZZPvvfGzx1Y7tvsGx3Rc1tvs+xpZfu/CKafWrDrHXLv4OeBUAO73rn7367/g/7cN8b8/P4r9XGX2O+mEGlNnAZkmbVTeiQJQ5XpEa7Y1ex3tv4uFrvOXIYELLzKBHUP++9PbVO8SSc+Fv6aKDF6MBYOTt+Vn1WhXVWqbcVoTYxIK9ZYsN8GKxvWIr0Crxuu5x4No01PILTS5zLmwtQYP2hhe8acHjxiNXnmDc+PkVwsDbwi6z4yXceaXDirag7rW5pce67MsW/tad79i6Tuqu9a2akHt8atHQKc5wtPSOmL+DehvrAug1UL2I7X1n66Tatud0UbVsN8SxxHIOSnFmB2XDPVwBtwaEtpkBXFXOjq98O9Le0ys7b0iirNr93CuRVWMcdLNRF3/VsG8c/R3b46kJ+HGhHH223T3PiTsT5+wk2p0Pd6vCzN275uze7/Y+1WmLgvyuK1WGMP26owV3yy5mkNu1t7Qo3kEuO3Ph6MXuZAE/4xBXEO6lea7sKcIqmgV+vm887fkVl5tTSD0PfFaLEJkHbWE1FVBl9Uf37rclEdtrioTic5TCVGfwg+irLZz6Hg6OwgoGaFe1FF9qf+69u8e4yol64JnOdW9vPvBqZui+9uXLNe9Y+s8Pv1C5+t1J/3X1A5K+wfrXHh98wvHhdxi9k+LKmYJNs6YJVTbu0OqR1oZRGURoQ/TnyVdQc55CYwvU6tw+cbBrG+4yXBNoYWP7fzx71r7r0rVcyFKZ2yN5i+OFJu+9ziKhChStCZNpmYcnHP/NP5xCXYrdm4B3gSv5go9b+DyqO67GPey//ke9Za3Bligv0aDz6Gd+u4NpBCzP8Vaw354Gbs1ukVFu97HVSHdebV5G82H1YpUzLycdw9ijO7/hr9pg97s79A1+Vdn9Pf78ZwkYH15+Q9WtbEWo1a+M20iufvl0pRhefvFG9RVZbXh7BxYuc9sWwXBE/mZ529y7GyLOj9oM3j+1d7RCsE6A/R5pJefanp86YcUXLc9iOR6ve6BRKczatk3Df/7560U0iMY+5s+ldX0UvUGXjN64WQ/nIid37re7KKNiWroEhaOJm5m2LVllufw/Gs+MtNfV3Z1rcSGvQdzfV8vM4P9tMuP+fwCmOB06 +sidebar_class_name: "post 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"; + + + + + + + + + + +Create a holiday pay policy for a company + +scope: `holiday_pay_policies:write` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/post-v-1-companies-company-uuid-signatories-invite.ParamsDetails.json b/docs/api/post-v-1-companies-company-uuid-signatories-invite.ParamsDetails.json new file mode 100644 index 000000000..aa8900eed --- /dev/null +++ b/docs/api/post-v-1-companies-company-uuid-signatories-invite.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/post-v-1-companies-company-uuid-signatories-invite.RequestSchema.json b/docs/api/post-v-1-companies-company-uuid-signatories-invite.RequestSchema.json new file mode 100644 index 000000000..959d8c59f --- /dev/null +++ b/docs/api/post-v-1-companies-company-uuid-signatories-invite.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"required":true,"content":{"application/json":{"schema":{"type":"object","description":"Request body for inviting a signatory.","properties":{"first_name":{"type":"string","description":"The signatory's first name."},"last_name":{"type":"string","description":"The signatory's last name."},"title":{"type":"string","description":"The signatory's title (e.g. CEO, President)."},"phone":{"type":"string","description":"The signatory's phone number."},"birthday":{"type":"string","format":"date","description":"The signatory's date of birth."},"email":{"type":"string","format":"email","description":"The signatory's email address."},"ssn":{"type":"string","description":"The signatory's SSN. Required for create with complete information; not used for invite."},"home_address":{"type":"object","description":"The signatory's home address.","properties":{"street_1":{"type":"string"},"street_2":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"zip":{"type":"string"},"country":{"type":"string","default":"USA"}}}},"required":["first_name","last_name","email"],"x-tags":["Signatories"],"title":"Signatory-Invite-Request"}}}}} \ No newline at end of file diff --git a/docs/api/post-v-1-companies-company-uuid-signatories-invite.StatusCodes.json b/docs/api/post-v-1-companies-company-uuid-signatories-invite.StatusCodes.json new file mode 100644 index 000000000..da603ed94 --- /dev/null +++ b/docs/api/post-v-1-companies-company-uuid-signatories-invite.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"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"}}}},"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/post-v-1-companies-company-uuid-signatories-invite.api.mdx b/docs/api/post-v-1-companies-company-uuid-signatories-invite.api.mdx new file mode 100644 index 000000000..26395d2fa --- /dev/null +++ b/docs/api/post-v-1-companies-company-uuid-signatories-invite.api.mdx @@ -0,0 +1,74 @@ +--- +id: post-v-1-companies-company-uuid-signatories-invite +title: "Invite a signatory" +description: "Creates a signatory with minimal information. This signatory can be invited to provide more information through the [Update a signatory](ref:put-v1-companies-company_uuid-signatories-signatory_uuid) endpoint. This will start the identity verification process and allow the signatory to be verified to sign documents." +sidebar_label: "Invite a signatory" +hide_title: true +hide_table_of_contents: true +api: eJztXFtz27iS/itYzkOSKtGWFN/ifTmZXM7xVmWSGic7eypJMRDRknBCAhwAtKNJ/N+3ugGQFHWJ5Ni1Z6fmITVjCmh8aKCvaOBrYiGvjXSL5Pz91+SZLiuuFk/zHKx9Wrt5cv7+483HQSLA5kZWTmqVnCfPDHAHlnFm5Uxxp82CXUs3Z6VUsuQFk2qqTcmx+QF7O5e20zDnik2ASXUlHQjmNKuMvpICWKkNdLsyNze6ns2ZmwN7/64S3EF3zI8PDUzPq9qlV6M0J+gSbPi/RVbXUqSxMf7QdKSfHjFQotJSuQDxWhYFs44bRwNKAcpJt2BXYORU5h5SZTTyhnElGC8KfU1t29k5jZPzXfzs8DcmdF6XoJw9+KA+qJ9+Yr9CwXH6s1oKsB9Uyt5fNkReXGHTjw+Fzs8b0inQ10dIwOa6gnP2qTO785IrPoNPySD5ks5q63QqlYOZIdypW1SQnL9PoJyAECCSj207Y6/5LDl3poZBYsBWWlmwyfnXZDwc4n+WV/+ypu0xrYtkkORaOVAOW/GqKgKbDv9lsenXxOZzKPkqjbdzYAYqAxaU85zVU8ZZWLsHnQ2TDBIPPtGTf0Hu8G/pCvxw2WnzJXV8ZnGKly1TcJaV0RUYJ/2McOXxv4GkdUaqWXIzSKbSWJcpXkL78/v4+yBRdVEkH28GScF3ahYgbmtSzbX6ThMouSzWwp1I4+aCL7b3lzbjopSqQ2KidQFcJX2Z/m0Obg6GacOUdr1dLS3jhdX0teILo4uCEWFcNfwY1u0Aoc25zazdZcwLJXDDgGXXYfTlYeccBY1dXv7CpGJ/x81KI1yBsVKrVcb0B8BtltfGgHIsdIqIm1EO2CWAVzGhiVQzL5cfH86dq+z54aHQuT0gaTnIdXkYpSgNzKDfD6WAstIOVL54xKbaLOkyrdgctYVmtcXhpGVTCYWgCUVdk3V1TWYddzXtWq4Wr6ekofvzBVWXuPZvuLXJIHmJ+2WQXH6WVYVCfjNoutCmWNXl3xhj9O+D+pamKf37oL5l2SWNnmXfWJY9b7tkGTVlOCD7xi6X9DrpOl4UOPvS+oYIqd8Qdxi17bQLmDc2falNyc5Ojo9ZrZwsaMWwO27OkquaF8WC1VWhuQDBuGXX4EjlI00cABnAvrGLrXodtxwOOQFQtKsLQDX9jTa2LiHjQhiwtit3jV7yctdXOdYZAJeN1spx+HG89sec7PLaXtzB2l/+kNV6UrpWzqyhhvthyuvCJefJu8unyc3NzQ1agd9raUDg9EhlkrmALxwZEicvc15krZ5utGtyOhmJoZiO0pOj4eP0iA9P0rPTk7M0HwlxKsZHYnzKk2WVm/ysJ8mSdk3+SyuwHW3/7MXrpNGaydHo+GR4PBo/PkoaPZlM9ORvASTKadLVk8noydkwHZ6lQ+zRakZv9hql5f9sNEwCo4kQZ0fH/OjJ4/z06MnwbHoGo2NxMhodjU6eIOjt0tsIY38D4W7BtWy8EnShuvsrcPMsH8MIpuP09Hh0lB5PRqfpk7PTJ6kYA5zB42N4fDbpc/NXns+h6DH07wZAQYejr9VEcyNQ39kKcskLad0yj4+P+zw2RHojm3FWXfZOeWG7/A1/twwWMD06PvkuGz3dvgi2spUcj4/ZeOjm7JK+JV3ZSp5W7oCNkihSySVX7KXhKpc210kjUMmzp0mQoeTJ0Wh4mnQkpxEPkpCj4dGqW/OLduylrpVAJ837OL/XYFGDGLC6NjkwocGrGPgirTtgr/hnYLY23gYFX1iwd+8unqNqu+KFFAcf1O19rQYU+6AY+1FcF88Pl6Gt8c+62gOM0WaNIxa+t/qIG8PRkZMOyu73zVSzz4Ad0IOYoQJaPwa1+q6ncIn7fyq9KxLmTN2ZzvPa2AP21iu8YuGN92dYhBCBemF77pyRk9rBYcUNL8GBYSb4+U63JMnkN6j3gIYUsC36MJ4SIw8nkIqLZAPymdF1JdXMRysh7qqtRzOpZSFYji5NGdrPuRIFKgOp2ELX6L80AQRhLsFaPltjePqQ30QgAhyXhWV8omvXYWrKZqDAtOwMpCNKW5spzz1SrjBSQ+DIOS99y7ZIaZdNcYd3N9b7pfVPwo7v7pfzTsfO5JINAnIdXAPqcJDcfLxp/XwUspSELH2Bg6av/a4NumI8XhXLdyr4HHxSAHtBqs+rDXJo0PutKlC4HxVxbqLFAleelibgY6gTuFRhyS2zdT5H5+eTVCSeWbMpsyte1PBpgB6+a2fIprRAoobA66YnShKt/aeOi/zCD/PM81CC3dNHJphp3nR/5D1tcpcp/g875oc03nrWet33F3Mjc//S2n9+rc0upu1A0rJPipRa5tfx04DA+bXy+a+w5RlnviX7FJqysEgh0xdiKP/jv41xQBSOC+74uq3YS2JG4TZQwBVXjmE/pBk2yCJIclD/UjGSaYwWSW0EjTQp4ACDUxYs0mCJBOEjVn0K3i2i+kRrG7+gn//Js3/SelroWGkFy3H/hrmUdeFkVYAfS1LYtCR48fOqsMVf9hDp5bGtVLM4MnbjQkj8iRdvOiP5sGrN2J4h3981v/ASYu4mcNTNeXfb5Nr45KWwLCSKOgz+/gjvlPy9hlY9GNKb7Xg+9UTae2p0uT3z5tvVVeb09oZLem5dg16sv9qk44W8Crs//U26efpaQeqNX3KzudWrsHd8U1yaTtLorzX/f7zmlEHeZLB72V9UPloVCx/9MbnVbBywC4efK22tRBfLaTbnV8AaPVTAFRQW1y6YkWgoGrWS5NLkdcHNQw93yW9+lHRnuKZBsiYKmHD1OeM5xeuZAEzcZbWa1kqAyCq+oPOXLRHChFtYDg9WnLWlMOFlrTB18grcXAtKHMbRWDMarcESMEpuLDKpaOvmiLTSVt4psn+iG4CjsjBqTKR2jqYO2JsCuAWWzyH/7J0U9FgDHMZL7GgPNk+BFwa4iOka2BZ8/fgE6CjAD+hzs8081gAspUUNlRldOxSbLVGhb5GpupyAWQ+x5+QvAf3V92e+P8pENLsBV9gJWa7VVM5sA63xNffi2mrvLpinjuGSOqYVHtNEZ7asres6FuuBxdlOMWEYfyxkKd0WhGsa783Cl4g40GBEg9m5rguBmHngbIM5q8BILVq8oEQmgrbcgLJpshbbel6+UILReXMrORRBuTlX7DErtXJziz7htHa1AY8vnjxLJWrrzCKzUEBOaUzFZW6zXAvIWsdsI+K29f78/AX7Muy7ZjvuhjAMc/8A49aE32teoBU5YULOZKN2tsC1EYDdAa6VuW+7P9pLmRNWuwr2KID1WJ0sIdPTaVbpQuYLSrrvttblrZhYrlvfPohakUSBaOSF57mpeZGZ7TKz1GwPzf3U92PYr+HYpEBVjp5Vg4cRQAl2A/AKyLhmIZGyzTr2uu6D9pkXbgE8d/IKIXsaPsYNGBgOwPR0GrM6mzBDWRV6AWB3Wfam8f5r/yJ2ZdzA7jtgwguucsjq6jv6crO13obqGVeUHuXiX7TsfjS7fdnnupACtTr+84CjW0GO6F16RaG4qXEjyKVgAQFaoLD4m6FhuvjeYDXnL+RJrwM2YFVw2aj+Cs38RqiNeWy22b1sxQvfhkUSDMMu28lhED7tzxmhhXOX/IsyjA4/a4ZqIHkIK5O5QwRvKfcoqVbFh6VSLWWBMbncs2jerchAYf4InTBneO60yTAI24Kt33J/MW0I+Hiv9W88FkECS7scdV9TVtfDf59+bG+Oa8wcVekhAT51YCjW38ULWO21P//eNH71gzX0HrRi3KYmKE/JgqBgEV+YRUwt7op/qf0PIV+i9F3MsXUb0uCRQzYz2lpMd8TBFVAwsM3XCS32d3eAYoTGo4hxQQ8SeS24InNdm10cw9uZun8g9Y7kKJhxJ6/6DAoynqMdLO5Q37wJFXgtAD9EIx5To/8AlQUcd6rpMOsThl8JycOhG+YWLpz16fQWo3c7BJ6Q8cKB2YA2C1S2x+0/BFxaNgFUbg3geNTSg0qpRmnJAQxga1VqIaeS1HaEHLOZdwk2nhhVK4vtAXhOLrHcK0oL5ipocbuwDsqmUdThfd+AtIDNfK3iDn6Cb/8jCmiZUivVilF6MuAs+RdZ1mUfp61NxXHO9wj1xZccAL2IgAFXYjQcElcLrT/X1TZe3iOw6HDFGIDqhB7aRwfJ8tlXe67zvpd0b8KHpJcrj+OnVDg/Gj+mEoeuQpsUOv8MpjH+lHTDIte9Nn+P2lpnmHZEcISX8oBYcmwEVgprZmoVxaM/fT/2Ks7t82kWx4Krq/uZFBeta2pvN50ezO1zmoLAo9TM8S/3Oa1YKsvCeMzxL4zGu90cV2HvsBW7hYN3Ps2lbRg1VnPR4/b7cgn0+kna2mIuYs8U+y6Twps5kXjXCH53Ci0kD9nWE5qVVitL0+TstrnmK91vk6priLBIhDWDtzFEsglwa5V/FO3ScVmPf3G0oI0phc7zeebmBuxcFyKDYHySzvldHwFNCxqs+/Mq8gW3AKVtrrgseDjMQ4+/uAJGufmnz/7B3kZwLFrGzvmR1paSEWgkf5MG2IUasFf6CthbjZWnhj3ndBzZNZidOxx7u01N+BKJ9M6OKC/GnYOyoiAWL13E22NNPUeNmxNdDl27VE9T+j0QjGFmU5pNxc+7pfX8DYy9U3p4S0KubNIGQIy7Y3aM6qm7pfd3m03xp7nNgQcubuc2kGpvajXbwECJK05H5zF50HaZwBSJYZ0AMp0puEai0dGTX0BkQtpJbSzQYVJ7br1hYt3We0hfJ7cQz63Wej9bZG8TiR0qS593QPdqSQf3PD28kMHH43HKxfAsPQJ+mvLhCU9PR6cnZ2f548no9MmWSUdqJZ1238b39wd8vn9jP73WOGfPJZ6Fs+f+8HnAnuGh9EHS50pEES4F3BqF7x9Vn/eo0bWvllE+CN62P+J/cBB12P9VvTFe8lDSzjPdXNygQgLvet1DTjowyMf4TqNkO9YO3ssJFjrc2SDS3/PCmqsbe6/iK9w8UuVFLeg+MBFi8VZIf8/kvkTpx8YgIn3Kvkpnf9OL3ZC1IUt8bbSasRB998fAuyj7b3OvkkFhrB2zeH/Iyh+6PoSD2QHDWz3Hj9aIGN79uXU9xBvsHashopCPhksHpVhxUMh8W6ZhrfCI2leAw6ajx47o4PGdm4PtlPe2ySp/hNML4HdJZK+Ftb2O4G337kxbk0Gr79cFa7O9pxxlvNDXnfIGFy4BbixuaGP7W2cTcMhYzdffEN0cwd0M0EwyWDLvw9rv2/zQcHdzSKMERztqKbpyusXS4e/U51YRCNYEg2D0E3sQ+jxobxIozSowpXQutrLRqky4lfk9R+ecyvyaW3/B2yQnY78QVgEI27FDIQxc439Evl2H4vANs6Of92b4b1gWHvXMjI5FTXBZTVuoMWwM1Qq6e8zRkyexOUneyzl7BJjDZ1SZnjtm66rSxjFBzlGx6J/wB3UU5+BPQO88D90rfuhA9gOK3mnWtnKx9orq/mVi2JepXtnLirYSZB+mGV1I3X+U53SuPmXUvQmNgwWlsgnvAJLO2e2YtqkFvY0THy9UjzkcnYxOU8H5k/QIxGl6dgzDdHQG4lgMAc4eH29RaXQadougtCg4eyndHzNMxQmq+OWozDFcYyiwtIfnvdMwC+gjUojYHDUHJqwJdO6YU2NxOpmejPN0wifT9IiPxunZ+Mk4fXw0hLF4kvPJ+GwLp26nhS4sl3zOfgZTSNWwCflSLIhF1+H2ym4cij41KOv96Sbvsb1uZ3Ot1tYS1uCNdnd6t+hyLZImuFRb60OXmt06WsPevYiR4RHsgP0G8BlTTcrN6erdP4GvQx2TJo3uveNQKQ60TdvrjkFdvjq6dFsx3VDsjh0aABe40yttd334yL+1hBf7owPq5x3eBej2wwJ9RStH6nP1ORW6/L386svSZSN/6aO9mdl7iQLFPwz7Pym96JI+fXOR/neTyKPR58AF+TOb6LQPn4yH4+N0eJKOjpOP3bcsOt9v+vN4jiwopQqX81Cvp7jugj19c9E8FMOt1bmkg2CKJ+hyHTbA+4R0s07hZpRtudPAt+lcVX1g2Xt6FKsuu7T3vNfJK5m2b9P8FAimnc+PEAZeEjygJ16Crf5ZCwod+quz87Xa7beAfu2UN4X3bq6k8wm+9nmdpH8FaN1LS9se8GlIPcAnc6IXQDdz1jzGtCsl7NoS6j3XtCsR6hYC6mcvXg/YGwOWLhNRZN1/4mlXslUnij5Y/9pTSyoe2yehxH07adF1cPx9qfVvTHUIx5z2dsrUKmZhiPLyI1A7zv3y8pcD9mvYsLSrQrUjyWATyHSeVvpPMl10Q7bZhH5V1z/Ys2k795Fg73Y+f7ZXfZZ88VaO4n74uOVFtZXn19IL4nkaFEIYbUPvL6mtgH8GbhcpDpnqKzBGCvCm1hsq+OJAWQr20VB507zxXTu6elf33rdDS7Pcz79z1zRGXdhttAlW0yHCQw0b8uDeDJNlxccSk8Or0WFjkA+/di3rzWHHJB82M6VynWCPa4MP7ETTwCvpLUMqoNThoZ2+ISt1ssxSTy/1OX/8Gae4gfBamm8M5fc30azwZ+RAfDjyEq2Fl4k1z0c2GxMHjwYd/54AN2Ti+7eyiURKFwgZr90cs0bxdHyQXFJJ04+M4ClsGOBmkKAV/LW1ny/8DcO+4WoFrfvCUvMxikjzIT6p1HzoPEw1Ho6P0uFpOn7SeWYJb7T3HlkifdpS2PIWUtOm8wRS8y08gdRp498+aj7494/a9r0HkNBH8yU/cZbkx6F/k3Qfdup4YIMEHS77enoJ5krm0NmMre9DzwAcUsNDgauD6jalv/F81oauK1dXochRUzvtXwh8YNmLoARYrJRE1ys+wUkr/R/hcRHu09Bh+Z7HUf3znCHXGFekwfS3VniQG6gBSq46dLw67HpBfdRfWx/sr9dU/71fUw3axcEXd1gVXJIaIoX6NWj998kVnWJFniWD5LwXU3VIU4xDyv8jyrB1SODrV4w/3pni5gY//14DCtz7j2h7DBWbkoEQkoJE0TyjtnFTPYwu1CO2OWpbO7V4T5xaRMuXhEvry7Giv3ziY7X94P2pI7ANjPUMXB/1NnxuHZJnnlnp2yUPZzVga3ugVazc1rZdz+XN68u3aIhCkFhqcsEMv8Z4nl/7VY9HLhhF4revScHVrPa5D08TdSBfNsWN6Q3/03nBZHlfff3qW7zVn0Hd3DTbzOHflCe5+V97foMy +sidebar_class_name: "post 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"; + + + + + + + + + + +Creates a signatory with minimal information. This signatory can be invited to provide more information through the [Update a signatory](ref:put-v1-companies-company_uuid-signatories-signatory_uuid) endpoint. This will start the identity verification process and allow the signatory to be verified to sign documents. + +## Related guides +- [Signatory Events](doc:signatory-events) + +scope: `signatories:manage` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/post-v-1-companies-company-uuid-time-off-policies.ParamsDetails.json b/docs/api/post-v-1-companies-company-uuid-time-off-policies.ParamsDetails.json new file mode 100644 index 000000000..e5b4000df --- /dev/null +++ b/docs/api/post-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/post-v-1-companies-company-uuid-time-off-policies.RequestSchema.json b/docs/api/post-v-1-companies-company-uuid-time-off-policies.RequestSchema.json new file mode 100644 index 000000000..6a9bd7aa2 --- /dev/null +++ b/docs/api/post-v-1-companies-company-uuid-time-off-policies.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"required":true,"content":{"application/json":{"schema":{"type":"object","description":"Request body for creating a time off policy","allOf":[{"type":"object","description":"Base Request Objectfor creating or updating a time off policy","properties":{"name":{"type":"string","description":"Name of the time off policy","example":"Vacation Policy"},"policy_type":{"type":"string","description":"Type of the time off policy. Currently only \"vacation\" and \"sick\" are supported","enum":["vacation","sick"]},"accrual_method":{"type":"string","description":"Accrual method of the time off policy","enum":["unlimited","per_pay_period","per_calendar_year","per_anniversary_year","per_hour_worked","per_hour_worked_no_overtime","per_hour_paid","per_hour_paid_no_overtime"]},"accrual_rate":{"type":["string","null"],"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"],"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. If accrual_method is per_anniversary_year, per_calendar_year, or unlimited, then accrual_waiting_period_days should be 0."},"carryover_limit_hours":{"type":["string","null"],"description":"The max number of hours an employee can carryover from one year to the next. If accrual_method is unlimited, then carryover_limit_hours must be blank."},"max_accrual_hours_per_year":{"type":["string","null"],"description":"The max number of hours an employee can accrue in a year. If accrual_method is yearly (per_anniversary_year, per_calendar_year) or unlimited, then max_accrual_hours_per_year must be blank."},"max_hours":{"type":["string","null"],"description":"The max number of hours an employee can accrue. If accrual_method is unlimited, then max_hours must be blank."},"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"}},"title":"Time-Off-Policy-Request-Base"},{"type":"object","required":["name","policy_type","accrual_method"]}],"title":"Time-Off-Policy-Request"}}}}} \ No newline at end of file diff --git a/docs/api/post-v-1-companies-company-uuid-time-off-policies.StatusCodes.json b/docs/api/post-v-1-companies-company-uuid-time-off-policies.StatusCodes.json new file mode 100644 index 000000000..dcf685d92 --- /dev/null +++ b/docs/api/post-v-1-companies-company-uuid-time-off-policies.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"201":{"description":"created","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"}}}},"422":{"description":"Policy name required","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/post-v-1-companies-company-uuid-time-off-policies.api.mdx b/docs/api/post-v-1-companies-company-uuid-time-off-policies.api.mdx new file mode 100644 index 000000000..cf643d6cc --- /dev/null +++ b/docs/api/post-v-1-companies-company-uuid-time-off-policies.api.mdx @@ -0,0 +1,71 @@ +--- +id: post-v-1-companies-company-uuid-time-off-policies +title: "Create a time off policy" +description: "Create a time off policy" +sidebar_label: "Create a time off policy" +hide_title: true +hide_table_of_contents: true +api: eJztXelzG7eS/1ewsx9sV3Eokrr1aR3L3ueqdeyKnZd9ZbvG4EwPiXgITACMJEal/32rG8BcPCTq2H0v61SlYg9x/AD0jUbnOlIlaG6Fkm+z6CwqlbHxxThO1aLkUoDxf1omVSWy2IoFJCrPk1IVIhVgokGUgUm1KHGI6Cx6pYFbYJxhU6bynFHT5Rf5RZpUlXDGvq2McnaphYVv0SC6imeVsSoW0sLM4YrtsoTo7HMEiylkGWTR10FkIK20sMvo7PN19MpBfJmmYMzLys6js89fb742o2lzyWfRmdUVDCINplTSgInOrqPJaIz/6a4hpTVk0SBKlbQgLTbhZVmIlBDt/W6w3XVk0jksOP7JYYzU9HdILa0DrviiLNwspiJoibHcVvQFdzM6i/bz44OjNBvFWTY6iQ9GJ3k8PR5P4pPxySg9To8mYzglGM0ZRGdRBif7aZ5P4hM45vHBwQnEfHKSxuODyeEJPz09Hqf70SCSfIGYLBjrDyEaRO4Picd7wd2KokHE01RXvEgWYOeKSAF0MleVTi6V/k67EZpobiE6Oxh1vySVFNZ9LrnIElXZRMnEgl4I6WbxJxB6XXJhhZwlJWihsiTjSxOdjUeDKOVaL9UF6KQQC2EJBv00GkQLfpWEAeg7dk+WwHWrQbsDbl4BiNjNfgHauHPODw8Pj6Yp7GfHh5BOpkeTaTYen56OOD8+Pd3n0SASJuGpFRd1b79/GgzYJKONiEbjeDSOBhEsykItAc/8c33E6dE4G5+cHsaHaX4SH0zGx/HJSXoST0bZcbo/3p/w0UF0M2hI4mh/P4XD45hPp8fxwWSSxyfpIY8PEOzR0fgEjnh08/Vm0KOqRKqkBeAHif3lSQxpIAPqi+Lqh3T5pzp6WRVF53BzXpidTvemr1t/gRK7SUvrZSpnnH1CNfs+z9mH+gw0qnQr2lKgVlDGaiFnK1r7Vyn+qICJDKQVuQDtBu/p8OimTyy7j5srzewcmB+HqUsp5Iw+rZnNEdlts/zMqeOmQTpEedtYn5blxrEGEchqgaZIi7KNSL9HyIp9Er9tJndgzSS+P/P9b/ocEcb73AyINIbWUK70glsUN4XidnVNc2CarDLLLucinXdXR+TMLkVROAxAh8QlC+TIlKQebhuGrKZDyBg3jDOadsBgOBuyL9HBaDj6Eg37K/Ac/LBlyGoxddTpULdRzrlhVjEUKExpNgWGksJRnApLs2sGMWCZcEsMh4CAh+y9LJasMuAGwcbFkgWjlT2vZRjOM2Cdv6I6RhmDu9z6CcH1/gqdti922d6NkrCmvalSBXC5spc/ue9Mh7mQCUXe3s9nxu9ZtpZUwvaqyhJ9tKa/uUUINyRAZj7oFg30OLs+KezJppArDZtJMyCbCemwk2jpgCcZtl4BPIwyF/xqK3WmXLJ6YpZrtWBKAkPVguRJdAlXFvFtU0JPD9IzCm4hoQuI/td2yQFoSe62rtwy/eps2KVNHjSQGbI3BJS9exefnwel5pT4rYwz3cQ4YQ6UQmG8jKVK5mJW6Zoxavtgp4WkldYgLfO9g4Jy7uaQfQS3zM/+d8Q0q0QGX5/PrS3N2d5eplIzJG94mKrFXvCl45IvtSoK+n2v6f7vbui44EvQL0j8CenOl+aXbK4ukW4rg1MLw3IBRTZkiDagDHIC14V71DoJYZhUrFByBpo5C4kkWsteevhRCOOHRnUgFfFWx0XyE3Ct+XJl+P8SxuJG17T5669vzw2rZIaQ1xgHwsLCrAsG3MUiuxlEU15wmd7FRmlrb9+rNqwC3OgG/8Fwxx+V0JAhpdHUPRvOG1ldM2nFmmmfTHsTvw4iK2yBYNESjd/neewtUTf9wehgNcDys7LsjarkTiGWDUOwL5KxL5JsHPijAoNsp8GoSqfAMgVIaZbBlTB2yN7x78BMpb1Y0OpCZJCxt+d7eLpIMRe8ENkwGqycYnsjQWulafXds/XfV0lrI22sjJp8B+yQcgszpZcb5qBWtxLKxxJSNLsNu5yDXzN1ZypNK22G7NOyFCkviqVj4u+wbIx14ywia7WYVhb2Sq75AixopqFAjzPoLRpy6DSrR70DNLJFvdXtRiIhEoYKh2Q88plWVSnkDPVGRvpiCs5Gs4pNK1FkLEUxt/Dt51xmBUkGyZaqQjlWhxYJ8wKM4bM7sN2HACQDy0VhGJ+i8dNsasxmIEE32+mHDihNpXOeOqSo9GSGwHHnHK90g4ZS2SQnJmkR1ufO+Uee4tv0ctbq2FpctIFBLrnjD+owxMDSTcPSPysbE5PFr3HS+L2jWs/Zk8kqW3qnBkUKq0n73kz+qyy1whgXnxbAXksr7DKwO24vR3VbliCRvp0hOFXZEimJjtqvF7Ww5UJ6EjLMVOkcTetvQhK7JzWRJxe8qODbgHlpGkbI6cAzdCDo7Oqedfj8W0sNv3bTvHJnIsDsqIcJZpzW3V84bU4yfoEWsKfA4Rf5Q1D9vxBU7G3eTCQM+yaJjxN3jt8GLXPQmV2e5BlnriX75psyf0joLNk5A2Iqzxj/NPIQUViecbv2cqV34xSYW0MBF1xaNPs5jukJZOk52Us8IRnxNFmoKDa8RJoWQJ4B80J40BmC8NFWfXP/JUPpG51t+IL21LfGO/bGBdoSSsL7nKT39rUsqsKKsgA3l7tf6zBe+LzKbOGXHVi6O7cRchZmxm48ywT+xIsPrZl8iHp17rsG2NrBOr+jds7bZJMq7e7oMoznEDW0NvghQUc3DI3opDe64VtcsbpdVSZWbW/YkXPrGmB4fpsD21a87zz1x78JO4/fS4id8otuNrd652nHNcWjwVulH2f+r3/mONJGhd3dh99Q+CgMW5LDg+7wFrUxZG8tfi6VMQJNLKvYnF8Aq+VQARdQGDw7r0aCoqjFSpQKnVYF188d3I6p+CJqr3BNg2iN4Tvl8jvGv1QlbZIBBlKSSuboeGdJyZcLkNZsMYqn3EDXIl4x1jqW8ZtKZkLO3pGnS/GbMBurZ6Mz6AC7AC3yZSIkkW6KSEtlxKMi+weaATgr87Oi5kRrfUpBFiT0bMg+FMANsHQO6XdnpKDF6uEwvsCOZrh5CbzQwLNlEkZ80gXg9voJ2RRANutYA3AhDEqoRKsKgzvbHCHXInGxxfUQe0Z+B+gvrn+ITQpTey8el6eExAX0TA2ttjV32rXV3m0wLy3DI7UUIG6M2UVlbNuwWA8srDbnxgZucXHuLQjXNN55C98gYj8GozGYmauqyBAz9ztbY/Y3Ag1ekFkd4t2Asm6yFtv6vXwtMxcGbjiHPCg755Lts4WSdm7QJswrW2lw+EKATMisMlYvEwMFpEjdieQiNUmqMkgaw2wj4qb17vv5M/Zl2HcNOd4NoZ/m6QEG0oQ/8PLMKnbEMjETtdjZAtcEAOYOcI1IXdvd0X4UKWE1q2APPFiHtZudtkwwlnG3s17caxMX6863D6KSxFGQ1fzSvxzegKrTbAfJ/bJ1EVrv2LRAUY6WVY2nvg7dALwEUq6JD6Rs0469rrugfeWYu8mGaS4E7Zx5DE3MPIDZgLkOb9/l2JtY+M5n/zp0ZVzD3SnAR/yTqrxFXm7W1ttQveKSIoI8+52O3c1mth/7XBUiQ6mO/zrAwawgQ/QxrSKf7lmbEWRSMI8ANVBIVNgIDSOkTwarvnIgS3odsAErvcnmkmWVhI1Qa/XYvrd6fFJ869o0l13odplWDIPwKTlVXKMZXt8yPeL+BR5Gg5/VU7UutBDCymIeEcEnij0KdyNNbqnPCglRYAwu9zSaMysSkBg/QiPMap5apRN0wrZg67fcnU3rAZy/19g3DovLWSEqR9lXJ3T38D+lHdtb4xo1ZyzXZLfz3IImX/8uVsBqr93370NtVz9bM96zho2b0ATFKZlnlAuQ1q8ihBbvir/T/kHIOyPdijm0blwavHJIZloZg+GOMLkEcga22Tq+xe7mDpCPUFsUwS/oQQrJOz795fYtvZ+q+xvlnzScI2HGfSpCG43n8RT1YPGI8uaDG78FwE1Rs0eu1Z8gE4/jUSUdRn389Csuub90w9jCW2tcOL3B6MyODG/IeGFBb0Cb+FG2++0PAi4wIwyFWw04XLX0oFKoURgyAD3YSi5UJnJBYjtADtHMxwQbbozKlcN2ANxOdrbcCUoD+sJLcbM0FhZ1oyDD+7YBSQGThDSsW+0E1/4hAqg7UsPVklF40uNc8CuxqBZ9nKbSJcc1PyHU11cpAFoRHgOexHg0ol0tlPpeldv28gmBBYPrdTu76Ll5MYy6d1/Nvc7nXtC9dh+iXqw8zB/Tk63xZJ9u9dsCbVqo9DvoWvlT0A3zu3Yi/t5oa41hoghvCHfigEIypTGTyiqmKxnYo798N/cqzu3rqQ/HgK3Kp1kUzxrT1NxvOT2Y29eUQ4ZXqYnlV0+5rJC6yPx8zPIrRvPdb42rsO9Aii4mnNbJzI+6zA4ZBokVotAPoMsO6PWLNJXBWMSOIfa7LEpgUosfvK0Eb11CA+nGPyqb0qqUXDmaOma3zTRf6X6fUF09CAuDsHryxoeINgFutPJD0Xauy3r7F2bz0phC6DydJ3auwcxVkSXglU/Uur/rI6BlQY11970K++JSai3jF1wU3F/mocVfXACj2PzLV39jnwI4FjRj6/5IKUPBCFSSvwkN7K0csHfqAtgnhcmWmp1zuo5sK8xWQvPOZlPtvoRBendHFBfj1sKiJCcW843JpGO8yeeokDjR5FCVjVUe0+9+wOBmipnkVmkM7XFR3C2sx0Vxn5AeF0Xb0e0DCH53iI7NuUnqXx8/muJuc+sLDzzcejaX4u8B1WSgYYEnTlfnIXjQdAkvMDIKqGJy0SUOGgw9cQVZkgkzrbQBukxq7q03LKzdegfua8UWwr3VWutnC+9tGuIOyZTnLdC99MnBEy8vG2U5n0wmMadHncCPYz464vHx+Pjo5CTdn46PT7csOoxW53XvbPu7Cz7Xv9afTmqcsXOBd+Hs3F0+D9grvJQeRv1dCSj8k9V7o3D9g+hzFjWa9mUX5TNvbbsr/mfDIMP+r1JsB1EupDDzxEc5UbtiIkHzCuWRY9J+g5yPbxVytmXN5L2YYKGcFZPQ0LdZYcZqAJuMdz/Fd0g8QqZFlaFEdwOhbNFgzArNpC5F6WFz0CD9kV2Wzu6qF7vh1voo8aVWcsa8992f409R3oPMnUjGp4C6juL9KUp36fqcHgSOJ/sHhy/WsNhcSbh3PsQH7B2yIQKTj0edi1LMOChEui3SsJZ5ssplgMOmq8cW6+D1nZ2DaaX3NsEqd4XTc+DvEsheC2t7HsGn9nORJieDTt+dC+ZmO0s58HihLlvpDZTLtS25ofHt7x1NwClDNl+fINoxgseZoF6k12TOhjW363zf8O7qkGbxhnaQUshoZoumw9+pz708EMwJhozRT+yZ7/OseUkgFb7iXQhrQysTtMqUG5E+sXfOKc0vyO9gbZKRsZsLKwEy09JD3g1cY3+Efbv0yeEbVkc/77zhv2FaeJAzM7oW1d5k1U2ixqhWVCvonjBGT5bE5iB5L+bsEGAMn1FmemqZqcpSacsyMo6KZf+G34ujsAZ3A/rocehe8kMLspsw691mbUsXE9rY5H4JL2+wr3sg1HGT+nYz6Yc8mQpt57vPck736jmj7rVr7DUopU04A5Bkzt2uaetc0PsY8d54P55wODgaH8cZ56fxAWTH8ckhjOLxCWSH2QjgZP9wi0hzT7B3d0qLgrM3wv45w1BcRhm/VBkB3TWGDEs0PO/dhmFZBOVcxPqq2W/CGkfnkXdqkh1P86NJGk/5NI8POJatmZxO4v2DEUyy05RPJydbdup+Uuit4YLP2U+gCyHrbfJ1H3CLLv3rlbvtULCpQRpnT9dxj+15O5tztbamsHprtE3p7aTLtUhq51JuzQ/tNLu3t4a9ex4jwyvYAfsN4DuGmqSd09O7f1DdgRXUIWhSy95HdpXCRNukvWop1O5ryc5rxXhDsvsNhYW9+ehQ+0pK/x3/JxWre/nhbfz3Oh4mMKt/Djwjs2Cl4Fz9niBUppmMJofx6CgeH7pKAjmvCizJ0Pq+UlfoHFz1Dv/GDcVjjNuXsZcf3tav+bkxKhV0n0pmOb1Rwwb4LI8eqEk8U9FkDQ1cm9aLz2eGfV4ISTdxrbF3fB7JSxG3ShX4AePW5xcIA9/aOb/I73Dv3TttbclJvaw+sKf34P7Niu/YeYzlHsVsOpAbLD/oNe1PKiPDv9/33sUF+1WhmuQkCn5QVpkLz60WKeBFcaeXaD+h4xmGduTbGRuTATEUu2me7muhh9dxGkT+iUh0Fv3dV18KNa8escbTkL1ypTaKpUur+lLXevoSkQr4QhWf8C8agmVHb5wfszbUy04tqNvrUdV5mbjzoJMmwd5/SHkBMuO+ioz7xqUUyC9cL9ufu1XZtpQqav+KirL/907br7vUs/rXLF/1o1rVj2pVj1ytitRqV3iQgl3Dve6cOnxOplQtGuiNuGRb1tp6rzMa3q9Q1pPVxdqwE/3VrUXcfb8wfECJrcepqLVhLfhTsXSMeofTfbHudDeva8MmPNWRujXf8dRqIGtA/uVqgN1sLJkUe3srRuNr7evtdi2Au5RtoirYt8zmy7lYPkN3JOoWFPW1Bq5iUwL/DtwsY5w3RhbTIoO6WnbUbUTFL/ybnvd5Xo+FZpwFaSj8i1aoc9Y2lv2mx9hVr/w37ky3nyvwXTdG+7rdaBP4ukNYxPpObjFN4/6icJObwraKLhbIrziL9i7Ge3Xq/d512wO52VtXTZ2yPr1jWOkCnT/vGvFSOM8ozmBB7tEKYZ7DQvUOwo0X+8q+C+VKTa8feO2YHzQZkZvGLPHnm1ZF9o/otjirf01d9pqkcfLg0BKvAdekWvvFPWiImN6hM16huLB1ktUg+kiZsQ+ZwY2wYYKbQYTu2C+NI/c6eCG1V9n3Rnapgty227vWcSPa1hihzY8PqYW8uRRyM/42PdlttdJ1XaHj+sdu2WS6vnPZp0FYUSwEYwRRu5x2K4oxiHC95n3+EfSFSKFF0E38gCrS7FHDvQxPGJ3SmP6OqULGd12pogBFqhaUQUU4nhn22ksfFpL2MXyRqbRahHrM/+brXHF3I+qp4zzMyn7BWkT+2stlFyFH+l//o2FAihApYxdctsbZ9P9V6GO/bsIKD/1/MXj6tXBl98qCC2I4Eh3XXrx9ji7GdT1BJ7/OekGWVRn3Fd+5GYu9r68xzPSrLm5u8PMfFWCg7vNXFLWaUvNJDmaCQmpZXUN744qf/+IV5Au2OYazdl2hqga1CII+8iU+upEj91TPheR2g/eXDrRt2Fi3geuDm/U+N3r3ldus+FNH+68GyJoeKPxLu7VtWz9/eP/xUzSIpj4ot1BkxGh+ieYVv3SnHi6oMWqH366jgstZ5SLFbkxkU97VOLWG8X9oRdm6dHV97Vp8Ut9B3tzUZGbx7xRVvvkf7dtlmw== +sidebar_class_name: "post 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"; + + + + + + + + + + +Create a time off policy + +scope: `time_off_policies:write` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/post-v-1-company-flows.ParamsDetails.json b/docs/api/post-v-1-company-flows.ParamsDetails.json new file mode 100644 index 000000000..e5b4000df --- /dev/null +++ b/docs/api/post-v-1-company-flows.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/post-v-1-company-flows.RequestSchema.json b/docs/api/post-v-1-company-flows.RequestSchema.json new file mode 100644 index 000000000..6cd68dec0 --- /dev/null +++ b/docs/api/post-v-1-company-flows.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"required":true,"content":{"application/json":{"schema":{"description":"Request body for creating a flow.","type":"object","required":["flow_type"],"properties":{"flow_type":{"type":"string","description":"The type of flow to generate. Multiple flow types can be combined by separating them with commas (e.g., \"add_addresses,add_employees,sign_all_forms\").","example":"company_onboarding"},"entity_uuid":{"type":"string","description":"UUID of the target entity applicable to the flow. This field is optional for company flows."},"entity_type":{"type":"string","description":"The type of target entity applicable to the flow. This field is optional for company flows.","enum":["Company","Employee","Contractor","Payroll"]},"options":{"type":"object","description":"Optional configuration object that varies based on the flow_type. This can contain arbitrary key-value pairs specific to the flow being generated.","additionalProperties":true}},"x-examples":{"example":{"flow_type":"company_onboarding"},"with_entity":{"flow_type":"employee_form_signing","entity_uuid":"1b71bb5b-4811-46e9-8a8a-cf5521cbeda6","entity_type":"Employee"},"with_options":{"flow_type":"company_retirement_benefits","options":{"provider":"guideline"}}},"title":"Create-Flow-Request"}}}}} \ No newline at end of file diff --git a/docs/api/post-v-1-company-flows.StatusCodes.json b/docs/api/post-v-1-company-flows.StatusCodes.json new file mode 100644 index 000000000..df79f239c --- /dev/null +++ b/docs/api/post-v-1-company-flows.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"description":"The representation of a flow in Gusto white-label UI.","type":"object","x-examples":{"success_status":{"url":"https://flows.gusto-demo.com/flows/lO2BHHAMCScPVV9G5WEURW0Im_nP9mGYloQgjUWbenQ"}},"title":"Flow","x-tags":["Flows"],"properties":{"url":{"type":"string"}}}}}},"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/post-v-1-company-flows.api.mdx b/docs/api/post-v-1-company-flows.api.mdx new file mode 100644 index 000000000..dd27a43a6 --- /dev/null +++ b/docs/api/post-v-1-company-flows.api.mdx @@ -0,0 +1,87 @@ +--- +id: post-v-1-company-flows +title: "Create a flow" +description: "Generate a link to access a pre-built workflow in Gusto white-label UI. For security, all generated flows will expire within 1 hour of inactivity or 24 hours from creation time, whichever comes first." +sidebar_label: "Create a flow" +hide_title: true +hide_table_of_contents: true +api: eJztXFtz3LaS/is43AfHVUPdLNuyno7jS6IHxzq2HG9KdlEg0TNERAIMAI48cem/n+oGQHKu1shS7e5ZpypxzMHlQ6O70Tfga2KhaI10s+T4/GvyQtcNV7PnRQHWPm9dmRyff77+PEoE2MLIxkmtkuPkF1BguAPGWSXVJXOacerCOGsMpHkrK8eutLkcV/qKScV+aa3T7KqUDtKK51CxDyc77LU2LM4/Yryq2CSMLBj2tOxKVhWDL400wK6kK6Vi+6zUrWF6zKTihZNT6WZMG3ZwSD9YNja6ZoUBjmiZkzWMcOaihCkYVugaLBtLY93OJ/VJ/aFbVnDFLPjlWIdDI5ZGWyvzCggKc7MGLC4FJz9/jZ/O8NPnn0rnGnu8uyt0YXcmuNCdQte7UOcgBIi04TOjq4p+38WxUhrrIZu0UsAcCF5ZzWr5hXElWM1dUdLkWTe5K4FZXgMruIOJNjOkPa0VWIFT14FwtpWOE3ht2AwxKwBhaTYku1TWcVXAaDAAj0NolWtuhFSTsPaSO6ZVNWNSFVUrwLILLkTGhTBgLdiLkf8AdVPpGdAHXMKFlROV8arKxtrU9oJZB40dMSvrppox6yQu0ZXawnChTk/AlYAokbVwz2rOBFSylsgb1hmpJse4louLiz+tVp/U10+KsU9JN8qn5Jh9SuZQjuYgjuaxfUo+qWsaD4c9rYBbYDmwWioxbitkCsEdomhACVCF9DsCvChpWV4KSglToG3KwTrWWjDIv2AkqAI68tfaAJMKZ/ZsitSSKhXQuNIzhmUGphKuaLDzX8A53I/3jhsH4hZcZ9OJHyO1fozAgMQh1IDQ2UI3cMwu6MvxlZEOLpJR8iWlOVKpHEwMYSY2To7Pkzhn8nmUOD6x+A0FxOIH3YBvfiKS46TR1qXT/bTwiialWZJR0nDDa3BgLOkhxWtIjpP/TklvpM9PT9LfwVjUPqNEogoqgQswySixRQk1T46/Jh5O4pkjGSWg2hqhHOwdPE73nqT7jxPSZGPeVi45Hn6/XtRwLxFLLRUyYwm485Dm3IJgz09P2NRjYdxaXUhSV6icvJxhg4JX1Q47GTOlFTBpWWP0VAoQI9+GN00lCyLLA8vOa6lk3dbDsbfcYN7INPSUavJfYcB08PkhwmgtiJ3ketRROOxD1rZSRNI23JXJIkHOSmAfPpy8RDlAioSOySgx8FcrDYjk2JkW1m/INZ4jkY2MveKT2MOAbbSyYLHTwd4+/jE/+wtSUIiw0MqBcthkQMRd1AH4rZ98Gb6BxoAF5bzEoZZnG8+nZBSXoPM/oXAkBvCF103lsdqWTr3MOu5a+tKaCpkzbJ2XKr9iAbXfQPq4W709+PnXX5+/efG+OP3992e/PP746sO7j3sndaZOn9W//FHpf03+/PAxB/Wv5Pp6lDjpKkSCckU4lgStMShqTkIPZHkL8J9Rcrh3uEyi37Rjr3WrvoPK3RCMlLHyVP+rBYsiYsDq1hTAhAbLlHYMvkjrdtgbfgnMtsbrzSgq7OTlLnGctGzKKylW7UfPfOcJGKPNClKE7z01uDEcOVc6qIff14+aXQJ2iIfumjmo1QpFNE+k9w0Ucoynx1UJYc3UnemiaI3dQbtCogaZMVdKyy5hxqQA5XwvbM+dMzJvHex2ipMZqEgTOd0PibLeo94CGo6AbVFK/EgMN7OzOsIm2YB8YnTbSDWxdI6hJZMDKRtEg9agiKaFb19yJSo8zqTyCnFwrBDmGqzlE/g25NMIRIDjsrKM57p1A6KmwabsyBmGjihta8a88Ei5YqAEHdo7SZCVeYlX2mVjEpIBY53P7X8SOH7IL8eDjoPFJWsE5Ip7+aAOO8n156EG+E27lIQsfYWTpm891wbJPjhYFssPqjEaFRUZhK+Uk26GR/0ZkYPPWMmbBhTyo7cwcy1muPO0NQEfQ53ApQpbjhZmUTJu2YVUJJ5Zx5TZlFctXIzQKnf9CtmYNki0EGjd9exshIsd9h68SJy/8tO88DSUW1vaBDMtuu5Dc4fMr8AxO5/U7TXeatJ63feDuJG4P7T2f77WRmu3m0hadqFIqWV+Hy9GBM7vlffqA8szznxLdhGasrBJM29UAwlVEIz/NYcDonAcPcJVrLhgvUbhNlDBlCvnPUmnI4PMgiQH9S8VI5lGK5XURtBIeQU+ZhJOpNHcEISPSHXh/yQ3+ML74eELmvkXnvx5b2mhYaUVvB3TUbZ5LXVbOdlU4OdCOVoQvPh5WdjiL1uI9PzcVqpJnBm7cSEk/sSr08FM3qdYMbcnyLe55jeMrwQ3J1CUAiA92xTaeJ9FYKyCuGFA4G/P8EHJv1ro1YMhvdnPRyN67Y3BrH7A835E1VZV8rlr1zaZ05sbzum5VQ3QjYFNTQZWyJvA/elH6cr0rYLUH37J9fpWbwLv+Ka4NeiJ/tjz//t7jiOtPbDn6fARlQ/FEsn7Y3LjsbHDThzFT2Is1mlW8imwTg9VMIXK4t6FYyQeFJ1aSQppirbi5icPd85ufjjnXa9okKzwAnKuLjNeFLpVLhNQgYOsVeNWCRBZw2c1KGc3eAgYSZp3D5aMtTk34XWrMBj7BlypBSu5ZXE21s1GezAHbApGjmeZVMS6BSJttJV3iuwPNANwVhZmxZMTXZccGM0vQeywEE0tSiguvZGCFmuAw3iNHe3O+iXwygAXsyyOeK8LQPKGCVkOoPp1rABYS4saKjO6xdDqJq/Qt8hUW+cUuFwBccHInwP6zvdnvj/KRDx2A67ACVmh1VhObAetszW3otpy7yGY547hlmJSAFhvzNatdUPDYjWwuNoxty5KS0ah/Q0IVzTemoSvEXEYg9EYzJa6rQRi5oGyHeYMg/Za9HhBiUwEbbkGZddkJbbVtHylBMWXB5JDHpQruWKPWK2VKynTMG5da8Dji3FbqURrnZllFiookLszxWVhs0ILyHrDbC3ivvX29PwN+zLsu4Idb4YwTHP/ACNrwl8tr/AUecKEnMhO7WyAayMAewO4Vha+7fZo38uCsNplsIcBrMeKKc1Mj8dZoytZzDKM5d9sr+tbEbFetb+LIFoVsnOdvPCiMC2vMrNZZuaabaG5n/t+jBLRkWJ5haocLasODyOAEuwa4JjOIxXuAymbTseFrtugfeGFWwClrBGyH8P7uAEDJauZHo9jVGcd5i6JeZNt7xpvv/evYlfGDdycA3JeYW45a5tv6Mv1p/UmVC+4ovAoF3/StvvZ7OZtL3UlBWp1/NcDjmYFGaJ3aRWFMorOjCCTggUEeAKFzV8PDcPF9wary7+QJb0K2Ig1wWTzlQFawVqo3fHYsdm9sOKJb8PiEAzdLjuIYRC+ULkAPZy7pF+UYTT4WTdVB8lDWFrMHSI4o9ijtBTsIbc01ITEKDAGlxdONG9WZKAwfoRGmDO8cNpk6IRtwLbYcnsx7Qbw/l5v33gsggSWuBx1n8fbC2zEf5927MIaVxxzVCuBA/CxA0O+/k2sgOVe29PvtLOrH6wY70Evxn1oguKULAjKFJQLq4ihxZvin2v/XcjnRvom5ti6d2kw5ZBNjLYWwx1xcgXkDGyydUKL7c0dIB+hsyiiX7AAiawW3BGqObsBSW931P1KFW295CiYcCeniwQKMl7gOVjdob459eMPAPgpOvEYG/03qCzguFNNh1GfMP2SSx6SbhhbOHHWh9N7jN7sEJgh45UDswZtFkbZ7Ld/F3BpWQ6o3DrAMdWyAJVCjdKSARjAtqrWQo4lqe0IOUYz7xJszBg1S5vtAXhKzpHcK0oLZhq0uJ1ZB3XXKOrwRduAtIDNfNnbDewE3/57FND8SL1UK0bhyYCz5l+wXmoRp21Nw3HN9wj11ZcCAK2IgAF3Yn9vj6haaX3ZNptoeY/AosEVfQAq//rJPtxJ5nNffV7nfCHo3rkPyUKsPM6f4l/T/YNHVOIwVGh5pYtLMN3hT0E3rJfcivkXRltpDBNHBEN4Lg6Ipb5GgMHzybQqisfi8v3cyzg3r6fbHAuube5nUVz0pqm93XIWYG5e0xgEplIzx7/c57LQLiQDPMzHHP/CaL7brXEZ9g1Y0ceEfZHInS9zjg2jxopR6O/gyznQqxdpW0vlzdtZMjdZlMSiljD48BD85hJ6SB6ybXNalVZLW9PF7DaZ5kvdbxOq6wZhcRDWTd77EMk6wP2p/L1o59JlC/SLswVtTCF0XpSZKw3YUlcig3D4JIP83SICWhZ0WLenVaQLsgCFbaZcVjwk89Dir6bAKDb//MWv7CyCY/FkHOSPNF4UwJyDHrOPeCfkRI3YGz0Fdqax8tSwl5zSkcMDMxRA38ps6tyXaVd+Ppc7orgYdw7qhpxYp4NJx3hfz9Eic6LJoVuX6nFKv4cBo5spJ4o7bTC0x2V1s7Ael9VtQnpcVkNHdxFA9LtjdKzkNut+vftois/mdgkP3NxuNkblQQFQxwYGah3uWHTBg75LDmMcDOsEkOhMwRUOGg09+QVEJqTNW2OBkkl93nrNwoatt5C+QWwh5q1WWj8bZG/dEDeoLH05AL1QSzq65+WJPTHmBwcHKRd7R+kh8Kcp33vC06f7T58cHRWP8v2nzzYsOo5WU7b7Nra/T/D5/t356bXGMXspMRfOXvrk84i9wKS0vxOxCkUo7b81Ct8/qj5vUaNp38yjfBCsbZ/if7ATddj/VL3xKBlLJW2Z9VfBqJDAm173EJMOBPI+vtMo2W5wD20hJlhpb8VkNPS3rDDrDIDL9rffxTfIPOHOG+PMD8TChbIlnil8idL3zUGDLI7sq3S2P3qxG5I2RImvjMYrfd77Xpzjb9ncgs29SgaFvnaM4v0tG590/Ql2Jjts/+DR4eOHK0Ss1ApuXQ9xir1jNUQU8v29uUQpVhxUstgUaVgpPKL1FeCwLvU4EB1M37kS7KC8tw9W+RTOggN/k0D2Slib6wjOhndn+poM2n2/L1ib7S3lKON4WbIvb6Bark3FDb1vf+toAl24ClMtMsQwRnA3E3SLDCeZt2Htt8/80PDmx2F373RwqY7ulW446fB3f+P1Nh4I1gSDYPQTexD6POhvEijNGrzD6FxsZeOpknMri3v2zjmV+XX3iIO1SUbGdi4s3VsenEPBDVxhf0S6XYXi8DWro5+3JvhHLAuPemZCaVETTFbTF2rsdQfVErp7jNGTJbE+SL4Qc/YIMIbPqDK9cMy2TaONY4KMo2q2mOEP6iiuwWdA7zwOvVD8MIDsJxQL2axN5WJ4vz+7XcHLa+zL1ELZy5K2EnQ+jLNcGrovu+UsLymvPmbUvXONwwlKZRPeACSdc7M0bVcLehsjPhjvTw84HD7Zf5oKzp+lhyCepkePYS/dPwLxWOwBHD16vEGlUTbsFk5pVXH2Wrq/JxiKE1Txy1GZo7vGUGCJh8uFbJgFtBHJRexSzYEIKxydO6bUgXiaj58cFGnO83F6yPcP0qODZwfpo8M9OBDPCp4fHG2g1O200InlkpfsZzCVVB2ZkC7VjEh0FW6v3IxC0aYGZb093cU9NtftrK/V2ljCGqzRIacPiy5XIumcS7WxPnSu2a29Ney94DEyTMGO2EeASww1KVfS1bs/gK9CHYMmne69Y1cpTrRJ2+vBgTp/dXTutmK6ptj9+noUzc+ftSCDcPGK/y0vS74bFKmQE+wfaaEwDdpP37rg3dtYS5eLBubXty5inA0uyfnXTXT37MwOi3dUho++hMtgha5zqUCwfMYsoIXtQ34l1N4NoGdKrPd6Rls+PkJptXDHYGBCDs2ebS+cDF5rcNxMwMWbLf11snjtkKjP6BQeS/AK2JvAvPI7FWw8/6LBAMv2NL9rLP1DHy+6NykGice+CikZxXoGuvkSTfxvXjt7Gyf3BeytCe9H+LuMdE1oyvESLPMvhGjVrYPIExaDXNTdeTS5dIabGV4TTb0J33CJWQR/mbMYUiPUEHRvI+1svAe1fF2lY6vVbso8jyEnD3zBYYcuG0iOC3JwfGhlmNvdz5/u5/njPD082t9PD5/As/SIH/G0GD9+fLBf5CD4k2S0LlMcEQx2ZxVmAy54E1kOCsaSzvJBp+AJm+Q4oZvJlcQSxqEy9G+KpPh+Rho0UxKv/NsG+CVwO0vRDEz1FIyRggBQL5JVB8r66c6jr7L2lRy6stUuvJaDBsp8P/8sSteYtnPQaB2srkOEh0+thPipf3OHntjB57yS3en+bldqt/t1+ADM9W58jocqO8KRNf+kCW/kwoMmS/LyEmqdzFPRj5f68DD+jKtaM/DKMU8NhYLXjdngz7jo+JrYezyCPPeveNOsk3icPL4hhH/PgRvybhcv8PrXiuiuGeOtK5F7YyJ1lLyn6pfvmcGPsGaC61GCR+u7/lB+dWOJXpTOwetIQ/nrVWcvQ9cUs/IlF1Fo/Ds5z09PkOdiXm34ktIowYeT7NvxezBTWcBgh/s3Bega9i413BW4ZNRgKf0d82M2dF26OggVvt6GqpFwPLDsVRAmFivV8AkloYu2ju/8/CM87sB9GDC8e/Qyzsre4QX8EOvxKTVk0fDrP3uORGqgJNVcDcZ5EV9OG/t3eeYAf+0NpR9P5v14Mu/Hk3n/v57MC6rVwRe321Rc0lER3uXyh/F5MqWkVDyOk1FyvPAi2zg+71XiKX58nnz9ilbmB1NdX+Pnv1pA1/H8M9oAhopF6dQWkpw8kRyPeWVhg2b66V1wsR6y9Y+8rVxLvOdNLaIFkoRL5/NPy/nLI/7Nvu3g/Ue/xLeGsJ6Aq18/7OjcG4YvPLHSszlLc9k173ugqdK4jW2HFuTp2/dnySjJQzig1mQKG44nHv6Xdn1gfNO3r0nF1aT1sQs/Jp6hfN4+6uyh8D+DF0jm+errV9/iTF+Cur7u2Mzh3ynOcf1vs3ZdxQ== +sidebar_class_name: "post 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"; + + + + + + + + + + +Generate a link to access a pre-built workflow in Gusto white-label UI. For security, all generated flows will expire within 1 hour of inactivity or 24 hours from creation time, whichever comes first. + +You can see a list of all possible flow types in our [Flow Types](https://docs.gusto.com/embedded-payroll/docs/flow-types) guide. + +You can also mix and match flow_types in the same category to create custom flows suitable for your needs. + +For instance, to create a custom onboarding flow that only includes `add_addresses`, `add_employees`, and `sign_all_forms` steps, simply stitch those flow_types together into a comma delimited string: + +```json +{ + "flow_type": "add_addresses,add_employees,sign_all_forms" +} +``` + +Please be mindful of data dependencies in each step to achieve the best user experience. + +For more information and in-depth guides review the [Getting Started](https://docs.gusto.com/embedded-payroll/docs/flows-getting-started) guide for flows. + +scope: `flows:write` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/post-v-1-company-signatories.ParamsDetails.json b/docs/api/post-v-1-company-signatories.ParamsDetails.json new file mode 100644 index 000000000..aa8900eed --- /dev/null +++ b/docs/api/post-v-1-company-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/post-v-1-company-signatories.RequestSchema.json b/docs/api/post-v-1-company-signatories.RequestSchema.json new file mode 100644 index 000000000..ebc687d13 --- /dev/null +++ b/docs/api/post-v-1-company-signatories.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"required":true,"content":{"application/json":{"schema":{"type":"object","description":"Request body for creating a signatory with complete information. All listed required fields must be provided.","properties":{"first_name":{"type":"string","description":"The signatory's first name."},"last_name":{"type":"string","description":"The signatory's last name."},"title":{"type":"string","description":"The signatory's title (e.g. CEO, President)."},"phone":{"type":"string","description":"The signatory's phone number."},"birthday":{"type":"string","format":"date","description":"The signatory's date of birth."},"email":{"type":"string","format":"email","description":"The signatory's email address."},"ssn":{"type":"string","description":"The signatory's SSN."},"home_address":{"type":"object","description":"The signatory's home address.","properties":{"street_1":{"type":"string"},"street_2":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"zip":{"type":"string"},"country":{"type":"string","default":"USA"}},"required":["street_1","city","state","zip"]}},"required":["first_name","last_name","email","title","phone","birthday","ssn","home_address"],"x-tags":["Signatories"],"title":"Signatory-Create-Request"}}}}} \ No newline at end of file diff --git a/docs/api/post-v-1-company-signatories.StatusCodes.json b/docs/api/post-v-1-company-signatories.StatusCodes.json new file mode 100644 index 000000000..da603ed94 --- /dev/null +++ b/docs/api/post-v-1-company-signatories.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"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"}}}},"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/post-v-1-company-signatories.api.mdx b/docs/api/post-v-1-company-signatories.api.mdx new file mode 100644 index 000000000..ace624638 --- /dev/null +++ b/docs/api/post-v-1-company-signatories.api.mdx @@ -0,0 +1,79 @@ +--- +id: post-v-1-company-signatories +title: "Create a signatory" +description: "Creates a company signatory with complete information. The company must not already have a signatory." +sidebar_label: "Create a signatory" +hide_title: true +hide_table_of_contents: true +api: eJztPGtzGzeSfwU3+eC4iiORtF7Wp1X82NXWJnZFzuW2FNcYHDRJrIfABMBIZmz996tuAPPiw6Qs1d1u5YMr0RBoNBr9RqM/Jxbyyki3TM6vPycv9KLkanmR52DtReXmyfn1+7v3g0SAzY0sndQqOU9eGOAOLOMs9xOYlTPFnTZLdivdnD4X4IBJNdVmwXHeAXs3h3rCorKOKe0YLwxwsWRzfgOMN4AOflO/qYsW4JwrVsCMF4VfjiFky7TKgbk5MClAOemW7AaMnMqcFmWl0bgXJi2zFW1rWhUelQa0neuqEGwCjCump1OZgxkwfavwPzNQYHjBSm6cAsO0Yf/4xwu2gMUEDFtwxWc4rCy4YlwspJLWGYQ7YFMpqlxysxzgLPy9cnNt5B8gmIHSgAXluJM3wG7nGnEU4LECwZz22+QzA7AA5XCvtNNAwyeWTWDOi+kBu6jRRiA4BoETRQbsRuadv50BbiuDSOdzCVPG81xXykk1azYPLicqGSDCa1UsiT7MSjUrEJ5ccNM+eKkafqDD++6779ivMJlr/dH+plL2oTnbnBhIfDhnr6UBy27noNqH3z2uYsnChBruz1AQkWaVFEDQr6/qya9ukFrvvxc6P69BpkBfnyIEm+sSzhuEJNhzf5AfkkHyKZ1V1ulUKgczQ2yUumUJyfl1gocuBIjk/SBxfGbx21UDBT/rEvykS5GcJ6W2Lr0ZpYEwaWvJZJCU3PAFODCWxE/xBSTnSRibVZUUySCRKHIld/OkL4fIxb/8cvmS6WmbMZJBYuD3ShoQybkzFQwSm89hwZPzz4nfSWKdkWqW3N0N6mX/J/0r7fvi7WX632AsrhFWnwMXYJLNcAYJqGqB1BgPx8fp8CQdHSekN6a8Klxy3v5+19/HSyTBQirwvCu4g3TCLQh28fYS5RlxYdxanUs6dlIyS10ZGpDzojhgl1OmtAJkndLoGylADPwYXpZF0AdPLLtGEV1Uizbs99/PnSvt+eGh0Lk9oPM/yPXiMJ53WvKl0UVBvx/yUqZhplSz7wLAtPX5KaJRWRAHCarPyFLG3vJZPBMDttTKgkVyjodD/E+XLle1CCSDJNfKgXI4qrWhw39ZHPq5dTKrPNLWNRpVRSOpT2wjdckgnqqe/Atyh39LV+CHq9aYT+kGzi8N8r6TfkfEvasMN0im0liXeaaLP183jKSqokje3w2Sgu80LKC4bUg51+orQ2DBZbEW3Yk0bi74cvt8aTNS/i0QE60L4GpFan+dg5t7Q4IG0HVMkbSMF1Z7He55zluVnowfIGpzbjNrd1nzUglkGK9qafXusnNu0T5dXf2Eepz0AK0Q2HmdwK+yWV4ZA8rVAhswbtQ+uwJvq68b6fEqfE8BlAIWpXag8uVT9APafgZaybm+RftZWVxOWjaVUAjaUPQSsraXkFnHXUVcy9XyzZSU8SYF95ZbVN2vkV8GydVHWZZoD1CRhinEFKte0xfGGP37TX1J05T+/aa+ZNkVrZ5lX1iWvWymZBkNZbgg+8KuOp6Qdw2KInhBNBBR6g9EDmt5SzQu4Lxx6GttFuzs5PiYoVdQ0InhdGTOBVcVuWBVWWguQDBu2S04MmwIExdAArAv7HKrR4Ysh0tOAFTtMAr2hRhbLyDjQhiwti13tV7yctdXOdYZAJeN1spx+HG89secPOC1s7iDtb/8Icv1oNCXMmugta3hL1cXyd3d3V3bUl97lUnmAj5xJEjcvMx5kTV6utauyelkJIZiOkpPjobP0iM+PEnPTk/O0nwkxKkYH4nxKU+6Kjf5QU+SjnZN/q4VuSNR27949SaptWZyNDo+GR6Pxs+OklpPJhM9+UtAEuU0aevJZPT8bJgOz9Ihzmg0ozd7tdLyf9YaJoHRRIizo2N+9PxZfnr0fHg2PYPRsTgZjY5GJ88R6e3SWwtjn4GQW/AsIwEz9B/a/BWoeZaPYQTTcXp6PDpKjyej0/T52enzVIwBzuDZMTw7m/Sp+TPP51D0CPpXA6CgRdE3aqK5EajvbAm55IW0rkvj4+M+jQ2B3khm3FWbvFNe2DZ9w98NgQVMj45PvkpGD7cvgo1sJcfjYzYeujm7om9JW7aSi9IdsFESRSq54oq9Nlzl0uY6qQUqeXGRBBlKnh+NhqdJS3Jq8SAJORoerbo1P2nHXutKCfTnvY/zewXWUWRldWVyYEKDVzHwSVp3wH7kH4Fh5BMiJO8keg9aWnbDC4kRxv19rRop9pti7Fvxunx52EVtjX/W1h5gjDZrHLHwvdFH3BiOjpx0sGh/3ww1+wg4AT2IGSqg9WvQqK96ClfI/1PpXZGwZ5rOdJ5Xxh6wd17hFUtvvD/CMgT3NAvHc+eMnFQODusIipkQEjrdgCSTX2O9B2oIAceiD+Mh+exFABUPyQbMZ0ZXpVQzdKIE2ecJkPuP2EwqWQiWo0uzCOPnXIkClYFUPkRpxZqE8wKs5bM1hqeP8tuIiADHZWEZn+jKtYiaxgRGJGcAHbG0lZny3GPKFQMlEHGknJe+ri1S2mVT5PA2Y113zj8JHN/ml/PWxNbmkg0CchtcA5qAEdRd4+ejkKUkZOkrXDR947k26IrxeFUsf1HB5+CTAtgrUn1ebZBDg95vWYLyWQik3ESLJZ48HU3Aj6FO4FKFI6f8xBydnw9SkXhmNVNmN7yo4AMlfVyzQzalAxIVBFrXM+uUwYeWi/zKL/PC01CC3dNHJjTTvJ7+1Hva5C4vtIHIMd+k8daT1uu+P4kbifun1v7P19qYf6oXkpZ9UKTUMn+OHwaEnD8rdiuLIrI848yPZB/CUBYOKeTSQwzlf/x/YxwQC8cFd3wdK/auC6JwGyjghiuHGT6OMAODLIMkB/UvFSOZxmjRZ4a9RpoUcIDBKQsWadABQfgRqT4E7xax+kBnG7+gn//Bk3/SeFroWGkF3bh/w14WVeFkWYBfy2dxO4IXP68KW/xlD5Hurh1S734vySDhQkj8iRdvWyv5sGrN2p4gX+ean/gCYu4mUNTNeZttcm188lJYFhJFLQJ/fYVflPy9gkY9GNKbzXo+9UTae2r0YnvmzY+ryszp7QM7em7dgF6svzqk5YX8GLg//VW6efpGQeqNX3K3edSPgXf8UDyaVtLozzP/Nz5zyiBvMti97C8qH7pOo+iPya1m44BdOrrR0NZKdLGc9jeltR4q4AYKi2cXzEg0FLVaSXJp8qrg5nuPbsdvfpq0d7hmQLImCphw9TELt4aZAEzcZZWaVkqAyEq+pNvKLREC3u10w4MVZ60TJryuFKZOfgQ314ISh3E1Vq9GZ9BBjJIby0wqYt0cMS21lQ+K2T/RDcBV4yVqTKROIGQ9QRywtwVwCyyfQ/7ROynosQZ0GF/gRHuweQvhjjyLEB91A3QVEC7lKTdb72MNggtpUUNlRld4f7wtKvQjMlXhvfl6FHtOfgfRn/185uejTESzG/AKnJDlWk3lzNao1b7mXlRbnd1G5sIxPFLH8MKxcWapqKHlWKxHLO52ignD+GMhF9JtwXDN4L1J+BoxDjAYwWhXPgTK1jhnJRipRYMvKJGJoC03YFkPWYvbelq+UoJufFuSQxGUm3PFnrGFVm5u0SecVq4y4PGLV+RSico6s8wsFJBTGlNxmdss1wKyxjHbiHEzen96/oRzGc5dw467YRiWeXwEI2vC7xUv0IqcMCFnslY7W9C1EQG7A7pW5n7s/theyZxwtavIHgVkPa5OLiDT02lW6kLmS0q673bWi3sRcbHufPtIVIokCkQtLzzPTcWLzGyXmc6wPTT3hZ/HcF5NsUmBqhw9qxofRghKsBsQL4GMaxYSKdusY2/qPti+8MItgOdO3iDKHoaPcQMODBfAGqSY1dmEMyzKQi8B7C7HXg/e/+xfxamMG9idAya84CqHrCq/oi83W+ttWL3gypfOiX/RsfvV7PZjn+tCCtTq+M8jHN0KckQf0isKZYSt2j6sFQwYoAUKh78ZNUwXPxpa9f1LqDlcRQzL+bzLRnVnaOY3olqbx5rNHoUVL/0YFkEwDLtsK4dB+Gl/zwgNOg9JvyjDVNpZL1Wj5FFY2cwDYuALEiXVqviwVKpOFhiTyz2L5t2KDBTmj9AJc4bnTpsMg7AtuPVH7i+mNQAf7zX+jcdFkMASl6Pu8/g2Ahvxf0w/trfHNWbOOm7Ib+dTB4Zi/V28gNVZ+9Pvbe1XP1kD70kjxk1qgvKULAgK1nuGXcTU4q74d8Z/E+YdSF/FOY5uQhq8cshmRluL6Y64uAIKBrb5OmHE/u4OUIxQexQxLuihRF4LnshcV2YXx/B+pu5vCL0lOQpmVC/dwybIeI52sHhAffM2VOA1CPglavGYGv0HqCzg8aCaDrM+YfmVkDxcumFu4dJZn05vcPRuh6Ca88KB2YBtFqBsj9u/CXGJJeqo3GqE41VLD1VKNWLpulzEs63UQgs5laS2I8oxm/mQyMYbo3LlsD0CnpIdkntFacHcBC1ul9bBoh4UdXjfNyAtYDNfq7iDn+DHf4sC6kJqpFoxSk8GPBf8E1Yw9/G0lSk57vkRUX31KQdALyLggCcxGg6JqoXWH6tyGy0fEbHocMUYgOqEvrdPD5Lu3Vdzr3PdS7rX4UPSy5XH9VP8Mx2Nn1GJQ1uhTQqdfwRTG39KumGR617M34O21hkmjgiOcCcPiCXHRmClsGamUlE8+tv3a6/iuX0/9eFYcFX5OJvionFN7f2200Nz+56mIPAqNXP802Nuq35bFdZjjn9itN799riK9g6s2C4cfPBtdtgwaqyYhf4GvuwgvX6TtrKYi9gzxb7LpuhFUwDeNoJf3UKDkkfZVhPalVYrR1Pn7La55ivT75Oqq4GwCITVizcxRLIJ4cYqfyu2neuyHv3iakEbUwqd5/PMzQ3YuS5EBsH4JK37uz4GtC2ocd2fVpEuyAKUtrnhsuDhMg89/uIGGOXmL178jb2LyLFoGVv3R1pbSkagkfxVGmCXasB+1DfA3mmsPDXsJafryLbBbL3h2NttqsOXm/pBWOfuiPJi3DlYlBTE4qMLcukYb+o5KmROelpZuVRPU/o9AIxhZl2aTcXPu6X1/AuMvVN6+EpCrjBpjUCMu2N2jOqp26X3D5tN8be59YUHHu6GN5WRDQws8MTp6jwmD5opE5giMKwTQKIzBbcINDp68hOITEg7qYylV6VRdDZvrD16D+lr5RbivdVa72eL7G0CsUNl6csW0r1a0sEjbw8fZPDxeJxyMTxLj4Cfpnx4wtPT0enJ2Vn+bDI6fb5l0xHagm677+P7+ws+P7+2n15rnLOXEu/C2Ut/+TxgL/BS+iDpUyViER4F3BsLPz+qPu9Ro2tfdrF8Erxtf8X/5CDqsP+remN85KGknWe6frhBhQTe9XqEnHQgkI/xnUbJdqxZvJcTLHR4s0Ggv+aF1U839j7FH5F5pMqLStDbbwLE4quQPs/kvkTp29YgIH3Ivkpnf9OL05C0IUt8a7SasRB999fAtyj7s7lXyaAw1o5ZvD9k6S9dv4eD2QHDVz3HT9eIGL79uXc9xFucHashopCPhp2LUqw4KGS+LdOwVnhE5SvAYdPVY0t08PrOzcG2ynubZJW/wukF8Lsksteitb2O4F377UxTk0Gn788Fa7O9pxxlvNC3rfIGFx4BbixuaGL7e2cTcMlYzddniHaO4GEWqDcZLJn3Ye3XbX4YuLs5pFWCox21FD053WLp8Heac68IBGuCQTD6iT0Jc540LwmUZiV2FXAujrLRqky4lfkjR+ecyvzqV3/B2/R9PPYKYRWAsC07FMLANf5HpNttKA7fsDv6eW+C/4pl4VHPzOha1ASX1TSFGsPaUK1g94g5evIkNifJezlnjwHm8BlVpueO2aostXFMkHNULPs3/EEdxT34G9AHz0P3ih9aKPsFRe82a1u5WPNEdf8yMZzLVK/sZUVbCbIP04wepO6/yku6V58yml6HxsGCUtmEdwBJ5+x2TVvXgt7HiY8Pqsccjk5Gp6ng/Hl6BOI0PTuGYTo6A3EshgBnz463qDS6DbtHUFoUnL2W7o8ZpuIEVfxyVOYYrjEUWOLhee82zAL6iBQi1lfNgQhrAp0HptRYnE6mJ+M8nfDJND3io3F6Nn4+Tp8dDWEsnud8Mj7bQqn7aaFLyyWfsx/AFFLVZEK6FEsi0W14vbIbhaJPDcp6f7rOe2yv29lcq7W1hDV4o21ObxddrsWkDi7V1vrQzrB7R2s4uxcxMryCHbBfAT5iqkm5OT29+yfwdVjHpEmtex84VIoLbdP2umVQu09HO68V0w3F7rEpA1j3gxbkEPa7Ke38WHL7246fW0UrFBRTtZFP2+zUUO2iKBg2EqBY1qPoW53YlVJk9C2670PWteHZ1t2lxugJ9lOJJoKebazp1LMrJJzaAOr18tkVCE0L0daLV28G7G3sdkZhV7//z65gy1aIdbC+FVADKt7pJqH+eTto0bZ+/jHN+gZELcAx4bkdMo2KITpB7nYI2nHvV1c/HWzuxLKJo/tQcHaDy797u5buS792VsUnPmKWApd63x/e8cgagRnUx+p5PzJri9n8CfaO4v2WPlwrTbtS37AxDQoniS/7bQn8I3C7TBGXVN+AMVJQCEcTELtPDpSlWBD1t9fcGzvk0cusqtcpD/2Q7jzfBq0ejEq1PWgTWvWEiB72WAppUt9pj1rqYdfK5PBmdFhX1B1+brfUuzvsNuGjMo5gnyqDjVfiU3BeSv8SPBWw0KEBS7913UInXVp6eKnPBePPuLcNgNfCfGso77sJZok/49Zj684rtDdepNY08Kz5GhePLfzw7wlwQ6Fs/7Wu71RID8uoYyVmE+Kt6SC5olKXb1nBQ9iwwN0gQTv6c2OBX/mXZ32b1chpu/NO/TEKQf0httqpP7QaFo2H46N0eJqOn7fa7+BL517zHVKlDYQtPXLqMa3WOPW30BqnNcb3xKk/+L44zfheYxzMpflSkLhL6tiGHQ2TdsOfVs/FQYItFu2b6RUYbAjaYsam1wE9Dz+kgYcCTwe1dUp/472dDVNXnjRCkaOid9p3jnti2asg/SxW0GGzRaHzahG7EP5XaDrBfXoyHN/LuKrv8BlyUPFEapz+0ggPUgNFf8FVC45XeG0/qo/158aL+7Of7Z/9bP+D+9kG5ezgkzssCy5Ji5M9+hys5XVyQ25MtJfJIDnvNaG1XRdjjsb2/Dr5/BmjuF9McXeHn3+vANXU9Xs01YZKN8msCkkhl6ibkm0Uxe9/Dj7TU7a5u+3aHcVX1zQiOgpJeALe7anrn3L4nrb7ofcf3al2A2E9Add3B67p3PhvLzyx0ncdh3A1UG5moC9Ruq1j247e2zdX79B8h+B8ocljNfwWW3HwW3/q8QIDo3f89jkpuJpVPpPgYaLl4F0HpnZYwv+0+oF0+erzZz/inf4I6u6uZjOHf1PW4e5/Aab3eIU= +sidebar_class_name: "post 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"; + + + + + + + + + + +Creates a company signatory with complete information. The company must not already have a signatory. + +A signatory can legally sign forms once the identity verification process is successful. The signatory should be an officer, owner, general partner or LLC member manager, plan administrator, fiduciary, or an authorized representative who is designated to sign agreements on the company's behalf. An officer is the president, vice president, treasurer, chief accounting officer, etc. There can only be a single primary signatory in a company. + +### Webhooks +- `signatory.created`: Fires when a signatory is successfully created. + +### Related guides +- [Signatory Events](doc:signatory-events) + +scope: `signatories:manage` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/post-v-1-compensations-compensation-id.ParamsDetails.json b/docs/api/post-v-1-compensations-compensation-id.ParamsDetails.json new file mode 100644 index 000000000..535d0e4eb --- /dev/null +++ b/docs/api/post-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":"job_id","in":"path","description":"The UUID of the job","required":true,"schema":{"type":"string"}}]} \ No newline at end of file diff --git a/docs/api/post-v-1-compensations-compensation-id.RequestSchema.json b/docs/api/post-v-1-compensations-compensation-id.RequestSchema.json new file mode 100644 index 000000000..b4027e087 --- /dev/null +++ b/docs/api/post-v-1-compensations-compensation-id.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"required":true,"content":{"application/json":{"schema":{"description":"Request body for creating a compensation.","type":"object","required":["rate","payment_unit","flsa_status"],"allOf":[{"type":"object","properties":{"rate":{"type":"string","description":"The dollar amount paid per payment unit.","example":"70000.00"},"payment_unit":{"type":"string","description":"The unit accompanying the compensation rate. If the employee is an owner, rate should be 'Paycheck'.","enum":["Hour","Week","Month","Year","Paycheck"],"example":"Year"},"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","description":"The effective date for this compensation.","example":"2023-01-01"},"title":{"type":"string","description":"The job title for this compensation.","example":"Software Engineer"},"adjust_for_minimum_wage":{"type":"boolean","description":"Whether the compensation should be adjusted to minimum wage during payroll calculation."},"minimum_wages":{"type":"array","items":{"type":"object","properties":{"uuid":{"type":"string","description":"The UUID of the minimum wage."}}}}},"title":"Compensations-Body"}],"x-examples":{"create_compensation":{"rate":"70000.00","payment_unit":"Year","flsa_status":"Exempt","effective_date":"2023-01-01","title":"Software Engineer"}},"title":"Compensations-Request-Body"}}}}} \ No newline at end of file diff --git a/docs/api/post-v-1-compensations-compensation-id.StatusCodes.json b/docs/api/post-v-1-compensations-compensation-id.StatusCodes.json new file mode 100644 index 000000000..fd49870e9 --- /dev/null +++ b/docs/api/post-v-1-compensations-compensation-id.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"201":{"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"}}}},"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/post-v-1-compensations-compensation-id.api.mdx b/docs/api/post-v-1-compensations-compensation-id.api.mdx new file mode 100644 index 000000000..29fcc10b7 --- /dev/null +++ b/docs/api/post-v-1-compensations-compensation-id.api.mdx @@ -0,0 +1,78 @@ +--- +id: post-v-1-compensations-compensation-id +title: "Create 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: "Create a compensation" +hide_title: true +hide_table_of_contents: true +api: eJztXOlvG7mS/1e4PR+cAGpFknXZnzYvx74sNpNgktnsQxLI7Ga1xaRF9pBsO5rA//uiePSlw5Ziv7c7yAAZ2xJZ/LFI1sVifY80pKXiZh2df/wePZOrgor10zQFrZ+WZhmdf/x887kXMdCp4oXhUkTnthkITfFPTVIpDOWCcJFJtbIfEinIUl6TVZkuCdekoJwRWRqSSUUo+SKTPvlPmWiyomuypFdAVlSsSdqk2yNJaYgU+ZpIAcQsqUFSNDX8Cvrk/RJIWioFwrT6YRuzBNvnmpul/WMltSEKUmx8AVkGlsiCUQMX/U/ik/jll1/IWwUK/ii55gb0J/E3yKQCktI85+KSmCXXBAQrJBfm/JMY9slT8vGLTD4/UpCdF1Kb+GoYf5GJxv8tOHtMVqU2BL5x7SaOSGBV5HINEAb9AMlSyq/6k4jJRfhygQSak+qnCqgBdnFOXnIFmlwvQRC6MXFd2pXLyjxfE98HR9KpLOCcXLQYfH6tuIGLqBd9iy9LbWTMhYFLZb+NzbqA6PxjBKsEGAMW9SJaFM0mOvpcd1X6ml5G50aV0IsU6EIKDTo6/x6NBkP80d5B7yqgUS/CDQTCYCtaFDlPLfknXzQ2/R7pdAkrir85TJFMvkBqou6uxB2hoFCgQRi/DbMOiwT5D4Tbj3pRoWQBynCHsiw5awyhjeLicusQv//+6jkSxtXcSVwBZW9EvnYcuelFV6A0d/O5fYiwr32nMJqbd5+8A7B/f/Tf4/a8LDmDz4+WxhT6/MkTJlPdtyvTT+XqSVjEuKBrJfPcfv+EM1gV0oBI14/tBt1ygo0kpQa3+zMOOetHN70I9+dxHPsiE6R5veTpcpOFCeRSXOqtHKwOx3EDh+5Hjq6ogW2D1g0zmmvYhoLJPKeK0JUshXGisABFCrpe4SKXghvLVP/BAj84cijsSmiaOjHuxFZnkjiRPnnVYQoKVkHktQDVs02IXsoyZyQBcvKWrtMlpF9PkDMgyhXKhb/LUkW96APA16gXvZbCLKNe9A+g+GnoEX2+6UVZrulCG2pKvW1ageCLb7Aq8FS/ozlVHBj5VQoIHzZ/f4Mwox6qoRXX9oQgX0hFoftF3XlDlSHXXv7Xu6fEAfRymusW0/qkwvToxI1y8rhiniZUgVtXSjL+DRjR2HxN4ArUGhcaF5xL1qBjVZO8QgG0AvLoZHPSR43QI1Qwq+n4FdT0sYFTGU6+Jjn0Ca5gviaPTm4ZMqiupSyV1a1rci3V10OGqhcEWGOIRyfblxBxUCXINb0ETRKqgQVDANfF9+iQ7XJ05ybYTr1B+JCZ2b2IM7G/nDy2bKtnaK0WeS0INSQHqg0x1yCMXS5rjTQUCRXrPol6keEmxxPyMtc0fme3ZfweDw0KwZbtcqSUqIgQJLJry7/0y55xpdsmVs81Z5DRMjcaJaoX7SeaLLlydK1M83O5i7C2mgGb7wCE5Cj7UmqzyKRarLjgq3K1wFVsDJBImQMVGyO8EgztCtCEb1HdaZB1bgBgOCc/gt0nhJUInHj9iVZhWuYe2BZ10UTXlHpUKbq+2yo1h9eEai1TjvZcbdW22dOLuIGV3mYn3Yep04Rj16LD+D1kLAOd+uvfbRPfume3g8L/kLd/lFwBQ6Vi52rNVPhGV0XuOODN5IZScjyJWDJm4yFM4vnwNI3HsxnESUYhPp0zOqIwgRk9jRrGXDSZssEgHc7mSTo7PTtNRnQ0mAKb0vmUZmkyjpq2UpQOM5aMh7M4PR3TeHxKZ/HZKDuNJzBNR4N0yGYUe3QsnYjOYJ6dJWk8YMNRPIbJNE5m87N4MBydjifT2fxsMIyCiRLNBoPBoD8YRF2LIijnlj6u1W53VaLRYHQaD4axJb7z5Pn929nwHz/XcuydzMw1isUX4pILAIV7YGmVT8vJaawDTLIpnSXzOD1jgxinGeNHMX6GH+EnrXU4myczOk0nbAyn2YgOk0F6xuYwy6Z0kozT0/Y6sBFMsjkdxsk4ncVjdjaI6SlM4+wsGaUTNofh1nVI5tkZHSRpPITRaTzOprM4nZ85fH4ZRvU6jCZbF8HbTe1FaFo3D7YOT4MIiToCahGkXmMF6JidJfQsjU9HaRqP03QY00mSxlPIximbTk5hRlsrkKaTs4SdzmdnbDqZZMnZeECH2TSZzibZiLKzzgrMs3mWwCwen01ZPE6mZ/F8mg2Qs2yYzE7pYD6tWXl/nBzO4+EoHu7lpPNhu4ys9yYDoBOaxZCyaTxOhmmcTBjEkzTLRux0MJqdzqMgHqNZfzS5BcrN55taU7ZiK5ETaOPBeNOD/lUa8lKWwvr3zvX9owSruxRoWaoUPQ/QREgfg+iT1/QrEF0q5z4WSl5xBsyJea7JFc05638Sh7jkO0CRT4KQH8X16vmTNjQ0jjqqrSnsQSmpbFSirfD855taeKfC3KC6+ArYAS2IS6nWO8awrW5VZ+8KSHnGXRTHz9l2JzJNS6X75P264Bh3Wjsz6CusCWcgjOuF7akxiielgScFVXQFBhRRkFNvulQkrb6tUB8ADSlgW9S0jpKLuHlSYZG0R36pZFlwcamt6ZxSdKYxcGDRJCXPGUkxGrHy7ZdUMBtW44KsZYmhhyquZDGvQOs7GRhvAxAGhvJcE5pgoLFmakwuQYCq2elJB5S6VBlNHVIqMMSHwFVlTrRNByFRZJSCNTfWx9b6R37HN/fLeaNjY3LRjgNyTd35sB36HQnxqzSxPWTxCxw0fuN2rZcVo9HmsfxdFEqixYM+C3khDDdrJzZ4CMEWBQjn3SDnEsnWuPJ2aTy+EOf1S26DjUtCNbngwh7PRbUpF1c0L+GiR7wLEShkdoFYCZ7XVU88SXbtLxrRrRdumGeOhxz0geEtCzNOq+6PXZDMuhcrDO36HfNDEm87a53s+8ncwNyfUvuvL7UxplgNxDW5EFaoLdw6XvQaIWxyzdGH9vdGlLiW5MI3JX6R1s7VBXuo/MH4P6McEIWhjJo73Ew8C4dbQQ5XVBh0YinS9Btk7U+yF/9cEHumMTSxEXHCuIzXSL0WCYvPsurC/Vwgqgu7tuETtGEvHPuT2tJCw0oKeJNZVbZ/LqsyN7zIwY2F56hz8MLHm4ctfHPAkW6Prbm4DCOvrQnPOH5F87eNkZz9vmVsx5Dbd82vdFVFGDxHbRyv3japVO6Oi2H0ywU1agbfPsLvgv9RQi0eVH0/aMlYik56Z0quaoIfa4qizHMbX3ftymJh5P6GLTm3rQF6UbCvScMKee13f/yBm2X8RkDslF90s7vVa793XFNcmpvezzX/K6w5UtqpsNt8+IDCx0bz3c0436s2+uSVvfYvpNYcTSwjfcJAkEM5XEGuce28GgmKohIrUcoVRmvVIwe3ZTc/jpoz3NIg2uIFJFR8XeA9WynMgkEOBhalyErBgC18mELv8RDw0qHtHmwYay034WUpGBeXr8EsJSNLqkkYjVSj2TVoAbsCxbP1ggu7dVNEWkjN7xXZP9AMwFGJHxU1J7ouCRA7PgfWJ2/x7gOIvRN0RgparB6ODw3r/u4p0BwD5utFoPigE0D2+gFJAiDqeWwBaK+MxOVCydLgsdnjFboWC1GuEnt9uQVix8hvAf3N9SeuP56JoHY9rhAeS6XI+KWuoFW25kFc2+zdBPM0XGdhmk1tzNqEl4ZhsR1YmG1GtQmnZZHzlbv23oFwS+ODWfgSEYd7d0ujcc1NPWcrzAt3pVrjBcGqG4sdKKsmW7Ft5+ULwdylRn1yrAdlllSQU7LCq3WNNmFWmlKBw+cvDBdcsFIbtV5oyDHCKMVCUJ7qRSoZLGrDbCfiuvXh/PwV+xLsu2U73g2hH+bhAYatCX+UNEctMiWMX/JK7OyBqwMAfQe4mqeu7eFo3/HUYtWbYMcerMOK19ELmWWLQuY8XS8EXd1xrVdHMXG1bX27IEphTxSw6rzQNFUlzRdq/5lpNTtAcj91/Vy6SuBYkqMoR8uqwkMsQA56B/ACrHJd+EDKPu3Y6XoI2mfucDOwCYwI2dFwPq7HQGyigcyyENXZhbnKMLjLsleND1/7F610kDvvgITmVKSwKItb5OVubb0P1TMqbHjUXeEQP5rev+xLmXOGUh3/OcDBrLCG6H1aRT6PtjIjrElBPAKXrmMR7IaG4eIHg1Xdv1hLehuwHim8yWaTSFHN74Raqcdqmz3IVnzl2tQ5a+h26UYMw+KTIpFUoRke2t0n/8IZRoOfVENVkByEjcncI4L3NvbosvWcW8pFKwqMweWORnNmxQIExo/QCDOKpkaqhbQJKDuxdVsefkwrAs7fq+0bh8WlltldjrLP4a0PbMD/kHZsZ45b1Jw2VFm7nWYGlPX172IFbPY6nH9vK7v6ZAu9k/oY16EJG6ck/qBcgU24+WxzYlxo8a74W+1/CHmL0q2YQ+vapcErh8WlklpjuCMMLsA6A/tsHd/icHMHrI9QWRTBL+hAslYLrohNi7wDS49TdX+3SZf1yRFwSe0DiDYaf8ZT1IP5Pcqbt1W+WwDghqiOR6bknyAWHse9Sjr7bsQNv+GS+0s3jC28MtqF02uMzuxgeENGcwNqB9qFp7Lfb/8h4FyTBGziYAAcrlo6UG2oEZ+u8FVY21KsJOMZt2I7QA7RzPsEG26Mio3FdgAcJ1ssd4JSg7ryUlyvtYFV1SjI8K5tYKWAXrhnBnewE1z7HxFAbUr1qRbEhic9zhX9ZrN9Ojh1qQqKc35AqC++pQBoRXgMuBLDwcByNZfya1ns4+UDAgsGV/ABbJ7QI/24H7Xvvup7nY+doHvlPkSdWHkYP8Y/MX/Opjg0BVqSy/QrqEr526Abvk85aPN3qG01hu2O8IZwKw7IBZGKgUL9pEoRjkd3+m7sTZz751MtjgZTFg8zKcqayfZHTacDc/+cMmB4lbow9NtDTgvtQmuA+/GIod+IHe+4OW7CvsNWdDHhtEpcvddptrZhkFghCv0D+7IFevskdakxFnFgiP0uk7LPEz3xphK8dQo1JAdZl4l/qLGxNFXMbp9pvtH9mFBdRYQEIqQavPYhol2Aa638o2hb12Ud/oXRvDS2IXSaLhdmqUAvZc4W4JVP1Li/6yKw04IK6+G8CnzBLWDDNleU59Rf5qHFn18BsbH5p8/+Tt4HcCRoxsb9kZTaPe2VGfmAL01eiR55La+AvJeYearIc2qvI5sKs/H28mCzqXJfApHO3ZGNi1FjMOXYBvCkN+kIrfM5Styc9oFdaWKZxfZ7TzC4mfxSUCMVhvYoz+8W1qM8PyakR3nedHS7AILfHaJjS6oX1bf3H01xt7nVhQcubjUa4eGVs30c5beBghWuuL06D8GDukvi3m1jngAynQi4RqLB0MPXcwvGdVIqDfYyqb633jGxZusDTl8jtlBlrm+zfvacvV0k7pBZ+rwBupNL2nvg6bEBy+hoNIopG8zjMdBZTAdTGs+Gs+l8np4mw9nZnkkHait7232M7e8u+Fz/Sn86qXFOnnO8CyfP3eVzjzzDS+l+1OVKQOFfFhyNwr8r9aLPWdRo2hdtlCfe2nZX/Cf9IMP+VfnGvSjjguvlwkc5UbtiIoEzvR4gJu0Z5Hx8I/FkG1IP3okJ5tJZMQtL+jYrTBsFYBbDw1fxNW4eLtK8ZCjRHSGULQq03tgzqUtR+rExLJEuZZelc7jqxW7IWh8lvlZSXBLvfXfH+JMXR2xzJ5JBoK8donh/8sJduj6C/mWf2PdRj7ccsaUUcHQ+xFvsHbIhwiEfDloXpZhxkPN0X6Rh6+FhpcsAh11Xj42j419j6kZ6bx2sclc4HQf+LoHsrbD25xG8b76dqXMy7Oq7dcHcbGcphzOey+tGeoPN5dqX3FD79kdHE3DIkM3X3RDNGMH9DFBN0msyZ8Pq23W+b3h3dWhH8YZ2kFJ40PQeTYff2z5HeSCYEwyM2K/Iie9zUr8kEBJfma+4MaGVDloloZqnD+ydU5vmF+R3sDatkXGYCysAmG7oIe8GbrE/At/C0+Qds7NfH8zwD5gWHuTMpb0WVd5kVXWixqBSVBvoHjBGby2J3UHyTszZIcAYPrGZ6akhuiwKqQxh1jjK190bfi+OwhzcDei9x6E7yQ8NyG5A1rnN2pcuhlULFsclvLy0FQ9EJ+1lQ1oxqx+yRcKVrX1y4CjP/Tt2271yjb0GtWkTzgCE8DL3zj7CcUa8N95nIwrj6XAWM0rP4jGwWTyfwCAezoFN2ABgfjrZI9LsbdgRTmmeU/KSmz8vMRTHqpphrtiJKyAgmC9BUm8LDWgjWhexumr2TNji6Nwzp0ZslmTTURonNMniMR2O4vnobBSfjgcwYmcpTUbzPZw6Tgq90pTTJfkbqJyLik3uNb1l0bV/vXI3DgWbOrw4rkToLTlbu3O19qawemu0udObSZdbkXTLIt3iNdpmR3trtoBS22O0dXJ6BAsdYahJmKV9emeLKWyiDkGTSvbes6tUlSzZI+1lQ6G2n462XivGO5LdsUMF4BXu9FDcrlU+Lm6vFrMP9L3R6eZqpe959D+xLYsWP337Kv7vKorG8S3AEiizxsRGjbeN8lCjwWgSD6bxcOKKONnaM646Qvj8pvvU4DliWXHhX8ahUI1dvZ+nb19V1dW6pVXsyzZsgI/57LM2gTuB17lGPdem8U70RJOPoRhJg/aBjyppweO6ptsvnmDc+PgxwsAXes6b8hx29QYDUwtq1dGtddhaD7fcA5pdy3CDNSC9Vv6bZNZJ6PY98gHtb43EJRsYsRlnLnTXLXCz78Gnl0gdMdAsDvG5F9E83/HIrf10aFe1tyOLu/Ui/3ikWZ7lDhXf/j8UeGvOzcnEnxXfflZ8+1nx7Z9X8e3IAm8tqdSoMXTPVduao2ytBHV8TbcPSzBLUJsisPGo55h6bneo3/bPLLV2c7OrPpCOrTK+2Shw5rK2N6prPWiFsD3lvnbC98rfT8PNk16i9RjZ8tB4Kls9XC03XQD9ClSvY1vBwFlA+qlg7bbtpmgrxXi0FWc2SGd51Cq3hHvVgNC2N1oJzk7fWR7ZvsMtby+TjKZam5Qrl1z1d1UD60bdCVYNt090e9f2hGsSWyaOO8hftzlr324NLP8dPbkaPsFBn3x3VubNk7TDZJsF6E3+UuVo1nujlxbc2bwxg5U1fDf2/nNYyc5COXqxu0rEr3F6OwhvpflW2WvDXTQL/BpnHEqfv0PT1B2cLQXQq9OLgwdXxYoloMpaJZvF0alYx/ZdMqGlWWIwOiTd9KJ3NlPyR0ZwFHYMgNWZtRS/1cb6iyB//2UC4Phia8H/cNcnLvsvjGO9SvS2WnXoGv5gL0L3T7/J3oG64ik0NlDtidmKIE9swycMOYryO7Z/Y6qG9l03dA/kqVzZDBaL40STF14EkJA0jY4gk2m5CvXI/83XGaLuRsp7b8/DqOQ3yKtT5bI78AT4b/+93vC4yHhKV1Q06DxzT3XablMX+PfaT/tZxv8vVsbfSxED38yTIqfcihsrOL97af4xuhq6Qoy4xc6ruEHa1bFL1AHnH6Pv39Fa/l3lNzf48R8lYJwKq0peUWUz0+1pZdxGlNj2crbNPffoN++zPybbQxJbJxGsL7Fu6LHIV7cI4Q/3Ps1FlA4D9ZeOE+1gqWPd9thcxeHasHjmmOXckrrFRqSn7oEazmqN3W2bVsfbN+/eR70o8dGllbRGmqLXtgzotVvvcCtrVdk1/sipuCxdeNTRRNlI22q1UqP+l0b8p72jvn93Ld7LryBubqoNZvBvG0q9+V/wlyiw +sidebar_class_name: "post 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`. + +### Prerequisites +Before calling this endpoint: +1. A [job](ref:post-v1-jobs-job_id) must exist for the employee + +### Webhooks +- `employee_job_compensation.created`: Fires when a compensation is successfully created + +scope: `compensations:write` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/post-v-1-contractors-contractor-uuid-bank-accounts.ParamsDetails.json b/docs/api/post-v-1-contractors-contractor-uuid-bank-accounts.ParamsDetails.json new file mode 100644 index 000000000..e23083315 --- /dev/null +++ b/docs/api/post-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/post-v-1-contractors-contractor-uuid-bank-accounts.RequestSchema.json b/docs/api/post-v-1-contractors-contractor-uuid-bank-accounts.RequestSchema.json new file mode 100644 index 000000000..479c9ec67 --- /dev/null +++ b/docs/api/post-v-1-contractors-contractor-uuid-bank-accounts.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"routing_number":{"type":"string"},"account_number":{"type":"string"},"account_type":{"type":"string","enum":["Checking","Savings"]}},"required":["name","routing_number","account_number","account_type"]},"examples":{"Example":{"value":{"name":"BoA Checking Account","routing_number":"266905059","account_number":"5809431207","account_type":"Checking"}}}}}}} \ No newline at end of file diff --git a/docs/api/post-v-1-contractors-contractor-uuid-bank-accounts.StatusCodes.json b/docs/api/post-v-1-contractors-contractor-uuid-bank-accounts.StatusCodes.json new file mode 100644 index 000000000..9b548ee12 --- /dev/null +++ b/docs/api/post-v-1-contractors-contractor-uuid-bank-accounts.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"201":{"description":"Example response","content":{"application/json":{"schema":{"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"},"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/post-v-1-contractors-contractor-uuid-bank-accounts.api.mdx b/docs/api/post-v-1-contractors-contractor-uuid-bank-accounts.api.mdx new file mode 100644 index 000000000..9c4c33546 --- /dev/null +++ b/docs/api/post-v-1-contractors-contractor-uuid-bank-accounts.api.mdx @@ -0,0 +1,73 @@ +--- +id: post-v-1-contractors-contractor-uuid-bank-accounts +title: "Create a contractor bank account" +description: "Creates a contractor bank account." +sidebar_label: "Create a contractor bank account" +hide_title: true +hide_table_of_contents: true +api: eJztXFlvG7mW/iu8NQ/pACpZkpfYfrpZ5/ohiZFlkgsnKFPFI4ntKrKaZMlWG/7vF4dLbVosOTYw09MNNJKoyMOPhzwrD3kb3cTTUhsZc2FgqqjhUsRmUUB0ehFBPgbGgEU/e5EswH09Y9FpVEht4vkwTqUwiqZGKt34e1KWnMVjKq4SmqayFEZHvUiBLqTQoKPT22g0GOIfDHSqeIF0o9Po7Q3NiwxIaBn1IiQKwmBbWhQZTy2Gvd81driNdDqDnOLfDDcZRKfR6wpF/IqKq/ilAxD1IjerSI5/hxT/fRODG88C8mPjX+c0K+1fcBrRaTQ83B/C8eggPmYnEB+M2XF8MjkZxAM2ODgaHA9Hh+xF1IsgLzK5AEh8t5NJOhmOhyw+Pj4+ig+OTobxyeh4P94/3mf7Y8YOJuwk6kWC5gjrlXxJXs8gveJiSmrQSpaGi2kiynwMKjqNRkdHJ4PDwSF2nXHGQAQe122+f//+fTgaIKjwzU8+jBDd3d0hBwydalzpmmvknC5yEIa8BzOTdukLhYtvuGOUm91tYKc2Cun1Okv59evZGyInxMyA4EYgHkh059a0sVF2Ixa4jITak1umAqLM7ezCrHvRZzrnYqpxWu0xXjVAEkvoLqzNffA+0BzIRKqVk+0u4H3EvnRoPNPEkyCexN3ahb+P9nuqr4C1yFdEESr8UXIFDFlmF+bnXS96XBlZWvr/9VJiBeVgcLCsrT5IQ97JUjDyQxDyQ+DKIQtBG2Cow2SpUiBMgiZCGgI3XJs+eU+vgOhSgd0uhZJzzoARu8e5JnOacdb/IXCZD0aj5WG/ikLJFLSm4wzIW2G4WVQIuCY5XZAZLQoQ5HoGwm1KyRYoQAtZqoCR4FpQLjQBpaTSRJfpjFBNLrmwIBJqjOLj0kBiV/uyR/weDxQmlGeasBKIkYSKumdlLC775DO4mV68dcO8pgamUnHQP3+bGVPo0709JlPdt3aon8p8L9iduKALJbPMft+zMOO06v6cTEvOnOTlUgFhYBAQMm8Hw3E/d/9mbpe5XVPa1Bxuwst2w/9eKymqFF1EvYgbyJu/r6eaXAF28CgXa8awre7VhZ8LSPmEg8aF9MJouxOZpqXSffJlUfCUZtmCGFz6K1gQzkAY1wvbV2u4V1BFczCAGyCjKP9G1iT71uoF1DtAQwrYFreXo0RQywRSQXv4XUamSpYFmjdCBSMpFWQMpNQOzbjkGSMp7oPct59RwTLUpFy43dtwAvvkbFIPxDW5FFaxJW4dL3sWnFsrcs2zLGx5QolrSS59U+IXaUGuuZkRcCrLfbSsyVHepltY2vMwX78bCR3L0jTWLiZTEKDqVfOkAzN0qSY0dQyhgoBgyB/lURjKqKGrtmIbxusg3AoymFNhCPZDmn6DLLwkexPABbEyzaVXG14jjTPok3dSEW9key0SFp9l1aX705qnS7u24Rc0opeO/ePamPSjXiQFfJxEpxf3zSUvM8PR6bYUUY46ghd+Xha28GUHkW6PrbmYhpGxG2WM4yeanTdGMqqElWMv1jp+K/yz4D46jpoZbW6bVCoXczBNjLS7ocHgLRxUwf8ooVYPqnIHHRlL0WnviZJ5TfCipijKLLMel2tXFomRmxu29NyqBtpQA5ua3PWquOm93/3xN25m8UcBsTN+LlJY3eq93zuuKS7NXe/vNf8rrLn1/NcZ7DYfvqHykSJbOAeX8I1mo0/ODP5cSK05ulhGkhmdA6n0UAZzyDSunTcjwVBUaiVKuUrLjKrfHNzYOj/xR7vhnkfNGa5oEELfZmDTTFUkDDIwkJRiUgoGLClcQNxyYi5avkY0pi5ZUZn4aMlZixpmLnpXCsbF1IXYZEY1CaORajS7Bi1gc1B8ski4sFs3RaSF1PxRkf0b3YBWgJhSgdHLGIgdnwPrk/MMqAaSYpzknBT0WD0cQnOb8umvnwLNFFC2SALFJ50AstcPSMYAop7HCoA516ihEh9RbgDWiTlXQuw4+S2gn1pRPcpEMLsel98JSSrFhE91Ba3yNXfi2nLvJpiXhuCSGiIFkNqZzUttmo7FamBhthOqTZCWJOM5NxsQrmi8MwvfIWJPg1gaRM9kmTHETKvUhsecFKC4ZDVeECxhXluuQVk1WYltNS/fCob+IDQkx0ZQZkYF2Se5FGam0SeclKZU4PClMi+oQOFmpTZqkWjIIMXdnQjKU52kkkFSO2ZrEdetd+fnB+xLsO+K7bgdQj/M0wMMWxP+KGmGVuSIMD7lldrZAFcHAHoLuJqnru3uaD/z1GLVy2APPFiH1fAcEjmZJIXMeLpIMNm13VrnD2Jivmp9uyBKYSUKWCUvNE1VSbNEbZaZVrMdNPdL149gv4pj4wxVOXpWFR5iAXLQa4AXYI1r4hMpm6xjp+suaF874WZAU8PnCNnRcDGux0BwACInk5DVWYc5ZLX1NsteNd597d+GroQq2H4HjGlGRQpJWdyjL9db602oXlNhM6SU/W6X3Y2mNy/7TGacoVbH/x3g4FZYR/QxvaLXTplUboR1KYhHgBbIL/56aEKap4NVpZitJ70KWI8U3mVTgHtVClgLtTKP1TZ7kq145tpUBzoEwy7dyGFYfFKMJVXohlcHP4/IvyDD6PCTaqjGGRNCWJrMIyL4YnOPXNtkjw1LuWhlgTG53LFozq1IQGD+KGmcqGAQtgFbt+XuYlofEtp4r/ZvHBZmBdbuctR9Dm8tsAH/U/qxnTmuMHPaUGX9djox4E6htvEClnvtzr/zyq9+toLes1qM69SEzVMSLyhzEMbPIqQWt8Xfav9LyFuU7sUcWtchDR45JFMltcZ0RxhcgA0GNvk6vsXu7g7YGKHyKEJc0IFkvRZckZks1TaO4cNM3b+QekNyBEyp4fMug7yMp2gHs0fUN+eOfgOAG6ISj4mSf4JIPI5H1XSY9fHDL4Xk/tANcwtnRrt0eo3RuR0MT8hoZkCtQZt4Kpvj9l8CzjUZAyq3CnA4aulAtalGrq0D6MGWIpeMT7hV2wFyyGY+JthwYlQsLbYD4DjZYrlTlBrU3GtxvdAG8qpR0OFd38BqAZ1MpMrppmi/3f5XFFCbUi3Vgtj0pMeZ0xuel3kXpy5VQXHOTwj17U0KgF6Ex4ArMRwMLFczKa/KYhMvnxBYcLhCDGBLDn7Tz/tR++yrPte56CTdq/Ah6uTKw/ixLfwajvZxhi2FNs5kegWqMv426cbFRO60+TvUVjrDdkd4R7iVB+SCSMVAoX1SpQji0Z2+G3sZ5+b5VIujwZTF00yKsto11Q+bTgfm5jlNgOFRamLozVNOC/1C64D78YihN8SO97A5LsPeYiu6nLArEnn0aba2YdBYIQv9C/uyBXr1JHWpMRexY4p9m0lxLGrxxJtG8N4p1JAcZF2O7aykWFqaKme3yTVf6v6QVF1FhAQipBq8jiGidYBrq/yraFvHZR3+hdG8NrYpdJrOEjNToGcyYwl44xM1zu+6COy0oMK6O68CX3AL2LTNnPKM+sM89PizORCbm3/5+l/kSwBHgmVsnB9JqW0yAo3kN66AnIkeeS/nQL5ILK5T5A21x5FNgzkHpXcV09C3Cl8Ckc7Zkc2LUWMgL2wQa6R36Qit6zlK3JzocsjSxHIS2++eYAgz+VRQIxWm9ijPtkvrUZ49JKVHedYMdLsAQtwdsmMzqpPq6+NnU9xpbnXggYtbjUZseZAHVG0DBTmuuD06D8mDussYJkgM6wSQ6UTANRINjh6/AZYwrsel0mAPk+pz6zUTa7beQfoauYVwbrXS+9kge+tItDFIk0ywrrTF3TcN0FbqbBPHhSeeHhuwCR2NRjFlg+P4AOiLmA6OaPxi+OLo+DjdHw9fnGyYdKCWu4LyB/j+7oDP9a/sp9Map+QNx7Nw8sYdPvdceXA/6nIloMD6iPJBEYhD4foH1ec8anTtizbKZ97bdkf8z/pBh9WLuylZY3N/2+yKNTXH11R390g04YLrWeKznGhdsZDAuV5PkJP2DHIxvpEo2YbUg3dygpl0XkxiSd/nhWmjAEwy3H0V3+Pm4SLNSoYa3RFC3aJA66U9k7oSpV8bwxLpUnZVOrubXuyGrPVZ4mslxZT46Ls7xp+8eMA2dyoZBMbaIYv3Jy/coetv0J/2yXC0f3D4fIWIzaSAB9dDnGPvUA0RhHw4aB2UYsVBxtNNmYaVwsNKVwEO644eG6KDx3dmBrpR3lsnq9wRTieA3yaRvRLW5jqCL83rAXVNhl19ty5Ym+085SDjmbxulDfYWq5NxQ11bP/gbAIOGar5uhuimSN4nAGqSXpL5nxYfb/N9w23N4d2FO9oBy2FgqY3WDr8bvs8KALBmmBgxH4iz3yfZ/VNAiFJASrnxoRWOliVMdU8feLonNoyv6C/g7dpnYzdQlgBwHTDDvkwcIX/Efh27YvD18zOft6Z4d+wLDzomak9FlXeZVV1ocagMlRL6J4wR289ifVJ8k7O2SHAHD6xlempIbosCqkMYdY5yhbdE36vjsIc3Anoo+ehO8UPDchuQNY5zdpULsaVNsnDCl7eYV8iOmUvS9qKWfswScZcmdnuo7yx5+oTYrtXobG3oLZswjmAVudsd0xb1YI+xIn3zvuLEYWDo+GLmFF6Eh8AexEfH8IgHh4DO2QDgOP9ww0qzZ6GPSAozTJK3nHz5xRTccxW/FJU5hiuERRYu4dnndMwDegj2hCxOmr2TFgR6Dwyp0bsxXhyNErjMR1P4gM6HMXHo5NRvH8wgBE7Sel4dLyBUw/TQmeacjojr0BlXFRsQr5kC8uia397ZTsOBZ8ahHb+dJX32Fy3s75Wa2MJq/dGmzu9WXS5EkkVXIqN9aGtZg+O1rB3J2IkeATbI98ArjDVJMzMXr37N9BVqEPSpNK9jxwqhYE2aXvZMKh3rQL+1m3FeGWxe/sG76vgKFT3d//Pegx3vehTw27cN6G/iAG560UfKgty35z/NiV/m5JfMCXh9nvn8qN1lXW7X/OEq/9D/BAfpIFT8g1IWioFwmQLVzMWHFPUxa1jsQJUg2CffLU5dltDAYIVkotltNcz2SnJbJG01yJtRamCIqN4EdOB06ks4JRcrnDqXfpOn14rbuAywgM1H3i7ZfLvEHSXHJMBVkdawa+T/e4eW+OVktaVsiXeYsjffOyiHsYqGz/49/i/7ZMtL8/P4v+pjjEsgBlQZnVzDWFCMw3dgd7gjHIu/B1j1C4xqnxGXp6fhaMMQrWWKbf1LDYtYu8IYwO8Fm0vCAtcR15XbfZcm8aN+2eaXORc2EqIBu0dr6fTgse+JxfT//IE48bPzxEG3nVGE7KO4fWTIKPB6DAeHMXDQ/cUyISWmUHJrX+/u/vZC3mbV5LZTEp3Zbd/nqZzKbJ9tXH1OyNbvB7SeARliyYPeSel+zCIt6BLt586MDqDbvOSyC888bH0tsfh8eDkYH/L1z22egTnJtYF0CugehHbe/YtLeDbu+Y6ajfHicVyDkpxZpWH1aD44Ew9PbgxILRNUaGacXZg7dtMvcC15htNqCFCvy7WqsN6zKu7t7E3yCzNAaXFH/G496Gs8jSz6DTamw/3Gi9F7d121OfdXvetKFuJ5lVuqTLUbF5d0II7bREzyK3KWLqR+gZy2VkCRy92x1n4GWe7hvBKmufKHl2to1ngZ+SAhrRUNu16cRvc4pcpuugvS+TFxc9mq8+oH5xErGhbCSpCDFoN/z0GqqyMdZ8lsCRie4OW0NLMMG0aykN60Wdb0/crIzgKawa460Wo9z7VGrMh5V64K5WzJM7VlyVZXvqyJMdo/FwlWQiMrIFEe4NbNpQLNJV7L0IDqD9OPoOa8xQaG6G2RfZ1iT3bcI/hnFFnx/bfeOyvfdelG9GQpTK31RAWxzNN3nopJaEAF00hk2mJEmj59w//Zg11pxueX2/CqOQTviviU9iuUgB3sv/6z3rj4jKg9OVUNOg4p229z9adw21t2f6/OXx+dxm4MXtFRrkVHasqbr0+u4jmw9ZbVrgmp8suYVup/cTLNtpg99tb9LW+quzuDn/+owR08i9+onpVtj7Yqg/GbVy/xodrLtFvn7yFfk42uJBr5hZu94tFQ79H/qmBJU/X3RpybuZuIP/iPudK3joernbYK1bXlve1Y1b8pWXkl13Lugdq88JsbNu0y+cfP3/Bnend2Vxah0TRa1TJ9NotfDgrQ38Xf7uNMiqmpYsyHU387z9UIo/b +sidebar_class_name: "post 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"; + + + + + + + + + + +Creates a contractor bank account. + +Note: We currently only support one bank account per contractor. Using this endpoint on a contractor who already has a bank account will just replace it. + +scope: `contractor_payment_methods:write` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/post-v-1-employees-employee-id-bank-accounts.ParamsDetails.json b/docs/api/post-v-1-employees-employee-id-bank-accounts.ParamsDetails.json new file mode 100644 index 000000000..230d65c22 --- /dev/null +++ b/docs/api/post-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"},{"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/post-v-1-employees-employee-id-bank-accounts.RequestSchema.json b/docs/api/post-v-1-employees-employee-id-bank-accounts.RequestSchema.json new file mode 100644 index 000000000..479c9ec67 --- /dev/null +++ b/docs/api/post-v-1-employees-employee-id-bank-accounts.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"routing_number":{"type":"string"},"account_number":{"type":"string"},"account_type":{"type":"string","enum":["Checking","Savings"]}},"required":["name","routing_number","account_number","account_type"]},"examples":{"Example":{"value":{"name":"BoA Checking Account","routing_number":"266905059","account_number":"5809431207","account_type":"Checking"}}}}}}} \ No newline at end of file diff --git a/docs/api/post-v-1-employees-employee-id-bank-accounts.StatusCodes.json b/docs/api/post-v-1-employees-employee-id-bank-accounts.StatusCodes.json new file mode 100644 index 000000000..ebe20cbff --- /dev/null +++ b/docs/api/post-v-1-employees-employee-id-bank-accounts.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"201":{"description":"Example response","content":{"application/json":{"schema":{"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"},"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/post-v-1-employees-employee-id-bank-accounts.api.mdx b/docs/api/post-v-1-employees-employee-id-bank-accounts.api.mdx new file mode 100644 index 000000000..4cf8ed872 --- /dev/null +++ b/docs/api/post-v-1-employees-employee-id-bank-accounts.api.mdx @@ -0,0 +1,73 @@ +--- +id: post-v-1-employees-employee-id-bank-accounts +title: "Create an employee bank account" +description: "Creates an employee bank account. An employee can have multiple" +sidebar_label: "Create an employee bank account" +hide_title: true +hide_table_of_contents: true +api: eJztXNlvGzmT/1e4vQ+eAGpZko/Yftqc+/khiZFkNvngBG2qWZI47iZ7SLZsjeH/fVE8+tJhybEfdnYGGCRRk8Ufi6yDVUXeRbfxtNRGxlwYmCpquBSxWRQQnV1GkI+BMWDRz14kC3Bfz1l0FhVSm3g+jCEvMrkA0NXfEs7iMRXXCU1TWQqjo16kQBdSaNDR2V00GgzxDwY6VbxAitFZ9O6W5kUGJLSMelEqhQFhsC0tioyndvT9PzR2uIt0OoOc4t8MNxkgDY8gfk3FdfzKDR/1IjebSI7/gBT/fRuDG83C8SPjX+c0K+1fypLjJIdHB0M4GR3GJ+wU4sMxO4lPJ6eDeMAGh8eDk+HoiL2MelE1c9/tdJJOhuMhi09OTo7jw+PTYXw6OjmID04O2MGYscMJO416kaA5wnotX5E3M0ivuZiSGrSSpeFimogyH4OKzqLR8fHp4GhwhF1nnDEQgcN1m+/fv38fjgYIKnzzkw8jRPf3972oULiahjsOONh3gU/aKGzY66zQ77+fvyVyQswMCK4v8SNE90sc2IVU6Ipk2piXqYAoc9yW1WR60Rc652KqcYO2x3jdgEgsofvA8ofgfaQ5kIlUK6faXZeHiH3t0NjTxJMgnsT92vV8iPYHqq+BtchXRO9xnxs61ciwIBnkgi5yEIZ8ADOTVqwV/FlyBQyb2dX7iev5/1o+rIgcDg6XtdRHach7WQpGfghCfghcXGQgaAMMdZcsVQqESdBESEPglmvTJx/oNRBdKrA7qlByzhkwYsWAazKnGWf9HwJ3wuFotDzs76JQMgWt6TgD8k4YbhYVAq5JThdkRosCBLmZgXD7VrIFythClipgJKhSKReagFJSaaLLdEaoJldcWBAJNUbxcWkgsWt91SNeDAKFCeWZJqwEYiShou5ZmYerPvkCbqaX79wwb6iBqVQc9M/fZsYU+mx/n8lU963l6acy3w+WJi7oQskss9/3Lcw4rbq/INOSMyecuVRAGBgEhMzbwWA8zN1/mNtlbteINvWGmzBqk7Zh8b/XeowqRRdRL+IG8ubv66km14AdPMrFmjFsqwfV5ZcCUj7hoHEhvTDa7kSmaal0n3xdFDylWbYgBpf+GhaEMxDG9cL21RruF1TRHAzgBsgoyr+RNck+CnOFegdoSAHb4vZylAhqmUAqaA+/y8hUybJAC0ioYCSlgoyBlNqhGZc8YyTFfZD79jMqWIaalAu3extuX5+cT+qBuCZXwiq2xK3jVc+Cc2tFbniWhS1PKHEtyZVvSvwiLcgNNzMCTmW5j5Y1OcrbdAtjfBHm63cjoWNZmsbaxWQKAlS9ap50YIYu1YSmjiFUEBAM+aM8CkMZNXTVVmzDeBOEW0EGcyoMwX5I02+QhZdkbwK4IFamufRqw2ukcQZ98l4q4k1sr0XC4rOsunJ/WvN0Zdc2/IJG9Mqxf1wbk37Ui6SAT5Po7PKhueRlZjg625YiylFH8MLPy8IWvuwg0u2xNRfTMDJ2o4xx/ESzi8ZIRpWwcuzFWt9whQsXPEzHUTOjzW2TSuXOGkwTI+1uaDB4Cx9W8D9LqNWDqjxGR8ZSdNp7omReE7ysKYoyy6y/5dqVRWLk5oYtPbeqgTbUwKYm973qvPTB7/74Gzez+JOA2Bk/d0ZY3eqD3zuuKS7Nfe+fNf87rLn1+9cZ7DYfvqHykSJbOAeX8I1mo0/ODf5cSK05ulhGkhmdA6n0UAZzyDSunTcjwVBUaiVKuUrLjKrfHNzYOj/xJ7vhXkTNGa5o4DZ0+9jfDFEkDDIwkJRiUgoGLCncManlxFy2fI1oTF2QojLx0ZKzFjXMXPS+FIyLqTt4kRnVJIxGqtHsGrSAzUHxySLhwm7dFJEWUvMnRfZvdANaZ8iUCjy9jIHY8TmwPrnIgGogKZ6TnJOCHquHQ2huQz399VOgmQLKFkmg+KwTQPb6AckYQNTzWAEw5xo1VOJPlBuAdc6cKyF2nPwW0M+tgz/KRDC7HpffCUkqxYRPdQWt8jV34tpy7yaYV4bgkhoiBZDamc1LbZqOxWpgYbYTqk2QliTjOTcbEK5ovDML3yNiT4NYGkTPZJkxxEyr6IfHnBSguGQ1XhAsYV5brkFZNVmJbTUv3wmG/iA0JMeeoMyMCnJAcinMTKNPOClNqcDhS2VeUIHCzUpt1CLRkEGKuzsRlKc6SSWDpHbM1iKuW+/Oz4/Yl2DfFdtxO4R+mOcHGLYm/FnSDK3IMWF8yiu1swGuDgD0FnA1T13b3dF+4anFqpfBHnqwDqvhOSRyMkkKmfF0kWCwa7u1zh/FxHzV+nZBlMJKFLBKXmiaqpJmidosM61mO2juV64fwX4Vx8YZqnL0rCo8xALkoNcAL8Aa18QHUjZZx07XXdC+ccLNgKaGzxGyo+HOuB4DwQGInExCVGcd5ipzss2yV413X/sQ+9WEKth+B4xpRkUKSVk8oC/XW+tNqN5QYSOklP1hl92Npjcv+0xmnKFWx/8d4OBWWEf0Kb2iN06ZVG6EdSmIR4AWyC/+emhCmueDVYWYrSe9CliPFN5lU4B7VQpYC7Uyj9U2e5ateO7aVDkfgscu3YhhWHxSjCVV6IZXuaEn5F+QYXT4STVUIw2FEJYm84QIvtrYI9c22GOPpVy0osAYXO5YNOdWJCAwfoROmFE0NVIleAjbgK3bcncxrQi4817t3zgszAqs3eWo+xzeWmAD/uf0YztzXGHmtKHK+u10YkDZs/42XsByr935d1H51Xsr6O3VYlyHJmycknhBmYMwfhYhtLgt/lb7X0LeovQg5tC6PtJgyiGZKqk1hjvC4ALsYWCTr+Nb7O7ugD0jVB5FOBd0IFmvBVdkJku1jWP4OFP3L6TekBwBU2r4vMsgL+Mp2sHsCfXNhaPfAOCGqMRjouRfIBKP40k1HUZ9/PBLR3KfdMPYwrnRLpxeY3RuB8MMGc0MqDVoE09l87n9l4BzTcaAyq0CHFItHag21Mi1dQA92FLkkvEJt2o7QA7RzKcEGzJGxdJiOwCOky2WO0WpQc29FtcLbSCvGgUd3vUNrBbQyUSqnG467bfb/4oCalOqpVoQG570OHN6y/My7+LUpSoozvkZob67TQHQi/AYcCWGg4HlaibldVls4uUzAgsOV1X/gSUHv+kX/aid+6rzOpedoHt1fIg6sfIwfoz/jIejA5xhS6GNM5leg6qMvw26cTGRO23+DrWVzrDdEd4RbsUBuSBSMVBon1Qpgnh0p+/GXsa5eT7V4mgwZfE8k6Ksdk3146bTgbl5ThNgmEpNDL19zmmhX2gdcD8eMfSW2PEeN8dl2FtsRRcTdkUiTz7N1jYMGitEoX9hX7ZAr56kLjXGInYMsW8zKY5FLZ540wg+OIUakoOsy7GdlRRLS1PF7Da55kvdHxOqq4iQQIRUg9dniGgd4Noq/yraVrqsw78wmtfGNoRO01liZgr0TGYsAW98okb+rovATgsqrLvzKvAFt4AN28wpz6hP5qHHn82B2Nj8qzf/Il8DOBIsYyN/JKW2wQg0kt+4AnIueuSDnAP5KrG4TpG31KYjmwZzDkrvKqahb3V8CUQ6uSMbF6PGQF7YQ6yR3qUjtK7nKHFzosshSxPLSWy/e4LhmMmnghqpMLRHebZdWI/y7DEhPcqz5kG3CyCcu0N0bEZ1Un19+miKy+ZWCQ9c3Go0YsuDPKBqGyjIccVt6jwED+ouY5ggMawTQKYTATdINDh6/BZYwrgel0qDTSbVees1E2u23kH6GrGFkLda6f1skL11JNoYpEkmWFfa4u7bBmgrdbaJ48IzT48N2ISORqOYssFJfAj0ZUwHxzR+OXx5fHKSHoyHL083TDpQy12Z8SN8f5fgc/0r++m0xhl5yzEXTt665HPPlQf3oy5XAgqsjygfdQJxKFz/oPqcR42ufdFGuee9bZfi3+sHHVYv7qZgjY39bbMr1tQc31Dd3SPRhAuuZ4mPcqJ1xUIC53o9Q0zaM8id8Y1EyTakHrwTE8yk82ISS/ohL0wbBWCS4e6r+AE3DxdpVjLU6I4Q6hYFWi/tmdSVKP3aGJZIl7Kr0tnd9GI3ZK2PEt8oKabEn767Y/zFi0dsc6eSQeBZO0Tx/uKFS7r+Bv1pnwxHB4dHL1aI2EwKeHQ9xAX2DtUQQciHg1aiFCsOMp5uijSsFB5WugpwWJd6bIgOpu/MDHSjvLcOVrkUTucAv00geyWszXUEX5vXA+qaDLv6bl2wNtt5ykHGM3nTKG+wtVybihvqs/2jowk4ZKjm626IZozgaQaoJuktmfNh9cM23zfc3hzaUbyjHbQUCpreYOnwu+3zqBMI1gQDI/YT2fN99uqbBEKSAlTOjQmtdLAqY6p5+sync2rL/IL+Dt6mdTJ2O8IKAKYbdsgfA1f4H4FvN744fM3s7OedGf4Ny8KDnpnatKjyLquqCzUGlaFaQveMMXrrSawPkndizg4BxvCJrUxPDdFlUUhlCLPOUbboZvi9OgpzcBnQJ49Dd4ofGpDdgKyTzdpULsaVNsnjCl7eY18iOmUvS9qKWfswScZcmdnuo7y1efUJsd2ro7G3oLZswjmAVudsl6atakEf48R75/3liMLh8fBlzCg9jQ+BvYxPjmAQD0+AHbEBwMnB0QaVZrNhjziUZhkl77n5a4qhOGYrfikqczyuERRYu4dnnWyYBvQR7RGxSjV7Jqw46Dwxp0bs5XhyPErjMR1P4kM6HMUno9NRfHA4gBE7Tel4dLKBU4/TQueacjojr0FlXFRsQr5kC8uiG397ZTsOBZ8ahHb+dBX32Fy3s75Wa2MJq/dGmzu9WXS5Ekl1uBQb60NbzR59WsPenRMjwRRsj3wDuMZQkzAze/Xu30BXoQ5Bk0r3PvFRKQy0SdvLhkG9bxXwt24rxiuL3dv3d18HR6G6vft/1mO470WfG3bjoQn9TQzIfS/6WFmQh+b8jyn5x5T8gikJt987lx+tq+wq1kImuZng6pNXjS9477J1v+eHaDbWffJRGnB3s2xtoo+sryTtLjrSTIeg/A/RfDViT3eicP0f4ofQqSzgjFxVqc92PFKf3Shu4CrC3Jk/Y7sV8U8ONJ4ywStIwqpCK991TN9dV2s8QtK6ObbEQjzZr3n2ohr2e/zf9iWWVxfn8f9UuQo7/Awoswq4BjChmYbuMG9xLjkX/iIxMixGvc7Iq4vzkK8gVGuZclu0YmMf9iIwNsC7z/YWsEDDyevSzJ5r07hWv6fJZc6FLXdo0N7xDjoteOx7cjH9T08wbvz8AmHghWa0E+vYXT8NMhqMjuLBcTw8ck+CTGiZGRTP+vf7e//sBWjzWjIbLumu6/Zvz3RuPrbvL65+b2SLV0Qaj6Fs0eQx76Xc37cv/XozuXTFqQOjM+g2j4X8wjseSw94HJ0MTg8PtnzCY4vXT25jXQC9BqoXsb1K35B+3/pDyGE02+KcYjkHpTiz4SKrIZHltwaEtnEnVChOua99YqkXuNR8agk1QujXRVd1WINydd822pqGR43y4DM17mEnqxjNLDqL9ufD/ar+ZP+uoRjv97uPPNlSMq9IS5Wh1vKqgBbcaYKYQW7VwdKV0reQyw6PHb3Y5aPwM05uDeGVNC/U0ro1aRb4GeeuIS2VjZte3gW/9lWKPvarErlw+bPZ6gvKvtvtK9pWQogQg8bCf4+BKis/3XcFLInYXoEltDQzjHuG+o5e9MUW5f3KCI7CmgHuexHqtM+1NmxIsBfcSp0siWr1ZUlOl74sySgaNlcKFk421vihLcEdGvL9TcXdi9C46U+TL6DmPIXGRqjtjH0eYt823Gc4Z9THsf035u2177p0pRmyVOa2nMHi2NPknZdIEipo0cwxmZYob5Z//+EfnaEuPeH59TaMSj7jwyA+Bu1S/biT/df/qjeufZJLapNT0aDjvK61nlF3Cne10fobO2x+Hxm4NftFRrkVEqsU7rzOuozmw8ajU8j7s7ZD11ZcP/FGjDbY8e4OfaXfVXZ/jz//WQJ64pc/UWMqW8RrVQTj9vC9xgdrrsNvn72FfUHWOoBr5hQu4ItFQ2FH/jWAlofqLvU4B3E3eH9zb3ElXx3/VrvaFZtrM/rGMSv+2jLXy05h3QN1dWE2tm3a24tPX77invSOaC6tP6HoDSpceuMWPaSy0FPF3+6ijIpp6Q6Bjib+97/HemNR +sidebar_class_name: "post 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"; + + + + + + + + + + +Creates an employee bank account. An employee can have multiple +bank accounts. Note that creating an employee bank account will also update +the employee's payment method. + +scope: `employee_payment_methods:write` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/post-v-1-employees-employee-id-employee-benefits.ParamsDetails.json b/docs/api/post-v-1-employees-employee-id-employee-benefits.ParamsDetails.json new file mode 100644 index 000000000..230d65c22 --- /dev/null +++ b/docs/api/post-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"},{"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/post-v-1-employees-employee-id-employee-benefits.RequestSchema.json b/docs/api/post-v-1-employees-employee-id-employee-benefits.RequestSchema.json new file mode 100644 index 000000000..d2d258a72 --- /dev/null +++ b/docs/api/post-v-1-employees-employee-id-employee-benefits.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"required":true,"content":{"application/json":{"schema":{"description":"","type":"object","properties":{"company_benefit_uuid":{"type":"string","description":"The UUID of the company benefit."},"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 company contribution type and value.","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 size of the company contribution corresponds to the size of the employee deduction relative to a tiered matching scheme.","enum":["tiered","percentage","amount"]},"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","description":"For the `amount` and `percentage` contribution types, the value of the corresponding amount or percentage."},{"type":"array","description":"For `tiered` contribution types, an array of tiers.","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."}}}}]}}},"elective":{"type":"boolean","description":"Whether the company contribution is elective (aka \"matching\"). For `tiered`, `elective_amount`, and `elective_percentage` contribution types this is ignored and assumed to be `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\ntheir limit.\n\n`Family` or `Individual`: Applicable to HSA benefit.\n\n`Joint Filing or Single` or `Married and Filing Separately`: Applicable to Dependent Care FSA benefit.","enum":["Family","Individual","Joint Filing or Single","Married and Filing Separately"]},"catch_up":{"type":"boolean","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."},"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."},"coverage_salary_multiplier":{"type":"string","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."},"deduction_reduces_taxable_income":{"type":["string","null"],"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."},"company_contribution":{"type":"string","default":"0.00","description":"The amount to be paid, per pay period, by the company.","deprecated":true},"contribute_as_percentage":{"type":"boolean","default":false,"description":"Whether the company contribution amount should be treated as a percentage to be deducted from each payroll.","deprecated":true},"effective_date":{"type":"string","format":"date","default":"1970-01-01","description":"The date the employee benefit will start. If not provided, the benefit will be effective from 1970-01-01 (unix epoch)."},"expiration_date":{"type":["string","null"],"format":"date","default":null,"description":"The date the employee benefit will expire. A null value indicates the benefit will not expire."}},"required":["company_benefit_uuid"]},"examples":{"Example":{"value":{"company_benefit_uuid":"f68abb42-431e-4392-bc3f-2795627e00f3","active":true,"employee_deduction":"100.00","contribution":{"type":"amount","value":"100.00"}}}}}},"description":""}} \ No newline at end of file diff --git a/docs/api/post-v-1-employees-employee-id-employee-benefits.StatusCodes.json b/docs/api/post-v-1-employees-employee-id-employee-benefits.StatusCodes.json new file mode 100644 index 000000000..1f1e6d4c1 --- /dev/null +++ b/docs/api/post-v-1-employees-employee-id-employee-benefits.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"201":{"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"},"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/post-v-1-employees-employee-id-employee-benefits.api.mdx b/docs/api/post-v-1-employees-employee-id-employee-benefits.api.mdx new file mode 100644 index 000000000..c18891397 --- /dev/null +++ b/docs/api/post-v-1-employees-employee-id-employee-benefits.api.mdx @@ -0,0 +1,73 @@ +--- +id: post-v-1-employees-employee-id-employee-benefits +title: "Create 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: "Create an employee benefit" +hide_title: true +hide_table_of_contents: true +api: eJztXetuG7mSfhVuLw6SAGpHkq/yr83kco4Xm5lgktnZgziQqe5qi0mL7JBsO5rAwL7Gvt4+yaKKZN/UkiXHnplzNgMMYku8fCwWq4pVxfLX6Et8WRqrYiEtXGpuhZKxXRYQnb6PYDGDNIU0GkS8KJpNTPRhEFl+abDZy0WRqyUA+wEkZMLSlxpMoaQBE51+jcbDEf6Tgkm0KHCA6DR6+YUvihxYaBkNokRJC9JiW14UuUhosqcfDXb4GplkDgu+OtK7OY5SaDAgLXVhKmNcMgjIZg7ZXjSI3OIiNfsIicXfhc3xg7CK2K8iGkRfYnAYaREeL/54Bdq4qYeTj/vpePLxc1p8nIxHw8nHycdxOhmmn6NBFKaflqVIo9PoeH98fDA5GsdH+wnEB3CYxLOjk0k8SrOT9CDNhpPsgKiwKLhcTj3o0PvwAPaPk/FxfLAPR/EBh8OYH87GMYwnJ5NDPtrfnyENeWLFFUSnVpcwiHxfmIwSfnJ4FPPJ6DA+2N+fxJPZ6CQeT7JJkh4dzYb7oybgFNIy8dQdDYd7w2EDF+6SFrOy+/1q7ymXsuT5dMG/iEW5iE6j8abBNjTPxULYqfI7Lss8RxazQsMCpJ3misupSEFakQnQoYUDMuVmWoBOkDkuITrNeG7AMRvNDOsacJvMp2XR6HEFml/ClC9UiWzanAXxa/wJzNTyL3yWw1TIRC0gtKu6G55zvZwuytyKIie8UUWWJm2/Bm71Ew6iK56XUBP9ZhBBDn7HPUrIMvfJNOUWiIjjw3g4ioe0xV8K4c6w/xqx3QyidwI0pOz/PZP/3ky8mUX/AA6s+ckRdw1HWuKXmiO/0ieoD75G2vEd0RQl7FyDmasc92jc/mSaQm65//xmUHU9XO15uKbnPvb8cHNzN8a/GUQ8z3/KCHdbq+ygK+IfuIH4p9Cs0KoAbYXTG9U5qmhnrBbyMhr0qLGk1BqkZb4T6jE7B+YQ7LG3APT7e/+9kJfsshQpfHg8t7Ywp0+fpioxe6TT9xK1eBp0eFzwpVZ5Tt8/FSksCmVBJssnLFOaCZkpvfC6U7K5umZWsdLgdMKwTECe7qG4CSevWsxMqRy4pNVkvMxtYJz24n6dg52DJvRdtcyEYW5cmqLvgPbRzs8WGHeVmO6Q4EJmwNxgkA5YAZoVfIn/CpUOWKbVooXrkcHvCUv/8dy0eH9St1h9tbwA1MxVmacI1mrgFlLGDeOsnrmzFIcceDJnfnfX0G9FJoUFvK/piccBDbdVMvpeG4AjRZfA9R57xnAcRkKBGXEpUR8bJhUj4Uf41kiU6pS1ETyTnvtrEw+5HimJHRmXqZ/OnxUvlFlzmr2VU+km3epI9ozHyBSFvXN5Ls+9dj6PTllve8BNzMQX3M+aXmHH2FnGgszFg0CHxy+kMaEwbIHaQMjLAUtVnnMdZ0rH7kcPpOaUzWAaHOWJ5tH0APTH5F5xOuWxFiOOc8U1Mg5PEqVT2nBFkxnxWwV6lSGJvyqN1N7LV8qdvwu3xgvinIuaFBdtAMgYxi2ww17a3VgIlaeX0g2a0iKr2dxaewYf4A2Fa82XNDRqT2RTJcGrozZronbsnpQOSzsFXBuNOPYKS0eDSFhYmC1OHjNCXuZA2OhGxdxiqh0Ox2AFilPj25yuNiv2iJhrYedCOjVEQNadcXYt8txBIzZoGA+3AXlbQOIEFQ5eFsj+JK/YYyGTvDTiCp70nJoKbntz59w28NJNFodWxBi/kE710JCrU8iEBCfGscMjw0CmrFBC2gEt3zGHHyhlSbkoc47nMF86FTD8CyuLa65TU/Gev7me4u9nDm0mtLEO05wUSw1DZew82j+PBu5Q4PZduA9HwyF+3CR6TWc2Gg7/0tq3JiFMAxwuFIcmctLJ2aeOQQo2YEr4sgnl4XlEI3GGKP1nmzAeOog9yPhMXQEC6cN32MLXYqhge27D38ZCgeOnIstAg0zQ6rHXAA2WfmQai0QUJJE1XAlVrrbYY2eys58DN5YwDD6X4orn4Myeuk90Q/99uLlpXRl7DZl1hkvvocM5g1Z4zD/xSjY82WPIh7WwXyNeHW6eX/OlUyp7K9bUzZY3rTtZNb2rupNd077ebQ3mrVpUlrBhGndQA+NpKrABz1u2OckLC3qBIsPOQXhBRQfo4hVfiHzpNduZTMWVSEueXzCOIzqP2iwnM/Jvb59VXjHq++8ob9grkSPzK83ekuz3Y73mWqPowV98k7dQcDyBNN/K8C+gAIn+GPYcv3zVmI1MwOpiW5OpZsGaTjvb1N6ExosLDzM+MuzczcjK4jwiubHHfpL5kv2s7JwdDEefaGX0Q7UT1eXHbTreksI0huFFmh0OaTGb/FC3iYizqi1NwBHD409PGA7EuEFOg5TNlrRK/12h1ZVIQTtbuuMQ2OkMhAuSU1gNMuKhlKZEXZ8pvcd+VBZO+49KwqVUFq8l3jpnAoWtgxVmEIYZsI0b1SZfxcYlhEtfKQ2gyQIST/776vc1gw6iVIGZSmX9tN0GK/S55crm52F+GOaGwYMjlfXcdcVzQQRkf9WqLNg70Av2HyKrj3ug7PUcZMPUFChZLDt3q0Ld1iUosmv1mfPmsNqbQwdSXEqlId1rsUmP42crcq+9Y68AQ5Xth1+xkx4Zj9UTqCEztqFSzWoG1rEZz42qeK3fY/3tvoSCix4/gj+lftI99q7ynDhzBLHzogDuzrq3pVe1olOAhYYEfQDOnXKzyV/9Te6IPhoFPbelP4Kjgwl/brki7nv9Xffe6jY6NRmdRtSgbxfxi34XFCE0lmvHOSvewg2n5JunpcmgY2QImWL8y99JWu2RkL4P2nW3Xgw7LvptzNZffjl7sXLLsYpdzwVeUxqIZpAreUmbpoGneK4bLNvn5N91/qB2GkG8lZm+cWXrh765oWAmGWUpKRqc6QOxSH9sMHgf7hY/mQxPRuP94WR0Mh7uT06+B0r+tIGSXUN1N3WUDTayS8W83dDaSTbJ9rOjk/gkS/fjg8kkjXkKx/EBHx6O4fDoYHIAf77QWqVSN+zfNsxUkeXuEanDu8aj9u8SjuoGZrc7BNUy24egsfxbeb0p/m7j98pwvp3lnQthEB0MD1a9qz8qy16pUqbsXDJ2Ll1OxucSDNoNGowqdQIMrXCvv4Sxe+w1/wQMLxre50E3m9QJaXf1EuneuUSVfDAer077iyy0SsAYMiJfSivsskJAvuglm6PRIWsbe6ZScrkuVakDRjJDuJCGgdZKG2bKZI7mzoWQBGLKbbC+iL8uBsx7eMMIGRe5YWkJzpdU90RVTKbERSOA99JN85xbuFTo6t4xgkcw46Tq/sTFAcmyWiiNVxWLgJB4d06s6aPud+J2ids1vprWglswWokdk8x9vuqsX+ubXxl1+gmWThwgyuWaOajVDg7w6zn4w0jdmUqSUps99m5ZiITn+dL5RD7BklV+DmeiVnv4FB1DC/RSMQ053Rt88IaGDA4gh3pH3zyF/NDhTCO58JEfKkgPz2XsEm+TQl4ad1nmEq8qpXFoZqXI0ZNuLEZQqf2cy5Q8W0I67m3ku1H0q5pIGHYhSbBN3T5eDBpRemeje5ZnnLmW7MI3ZX6Tls61D05kuS+JNAs8b5dbhE/ehPV6bkR/dmkbexezS5Cg613zQwdimFJnPHEEwWw5SY4z7VFYnvKWl3tNmOh5ONwacrji0uJ1h+OYnkGW/iR7FSAkozNNIRsUG7UXwLmMvXU0aA1B+IhUF+7fKaLy7kn/CRorF478s1qZ9AbV1qylclzQiHiOOgcvfLx62MI3Oxzp9tw+2ObWgoZY5QF+05jJmWU9czuC3M41P/JF7ZdxFK39f8Q2dYSTglZ0Ha4JfPsMv0jxGS+wbddmPV8I0op0imGYDXfrql1ZTK3a3LAl5/oaGLv5Io+mTUjwee25P/5V2Hn8k4TYKT9nxfe3eu15xzXFrem7mX/f83+8Pafb/jqF3fGsofBR6NskA5eclOvVxh47I6dloYwRPnIy51dQO1BzuILc4N55NRIURSVWokTopMy5fuzgxmT8+GS0J1FzhT0NHEO3E51nXH6aYuJFKS3ea8DCtJRZKVNIpwVfYqSjZcS8b9ka0Yy7ZO5KxUcrxlrUUHPRq5JyKV6DnauUgr5hNlbNRnvQAnYFWmRLusdoDQkiLZQR94rs72gG4KzMz9pwQdP8AtI99iYHboAlc0g+OSMFLVYPxzuOUbWvWwLP0ee0nIYRH3QBFFN3E7IZRqGrdfQAXAiDEmqqVYlJVxuA+RZTWS5moPshdoz8FtCfXX/m+uOZCGrX4/KcgJfnTFyaClpla+5EtdXeTTDPLMMttUxJ9PUHY3ZRGts0LPqBhdVm3NhwWqZ0l9+AsKfxziR8hYj9GD57pXbgc0/ZCvPURS1qvCDTytW9BmXVpBdbPy1fytS5v+uTQzcoO+eS7bOFknaOwUaWlbbU4PAFT4mQaWmsXk6Nc6YoOZVcJGaaqBSmtWG2FnHdend6/oh9GfbtYcftEPppHh5gYE34XPIctcgRS8WlqMTOBrgmADBbwDUicW13R/tWJITVrII98GAdVisWMFVZNi1ULpLlVPLFlnu9uBMRF3372wVRSjpRkFbnhSeJRs+d3nxmWs12kNzPXD+X5BQoNstRlKNlVeFhBFCAWQMc0zBIhDtHyibt2Om6C9rn7nCnQN5jhOzGcHdcj4HhBExlWfDqrMNcpVlss+1V4933/mWVzoHx8q05YMZzLhOYlsUt8nK9tt6E6jmXLlSafqRtd7OZzds+V7lIUarj/w5wMCvIEL1Pq+i5j8cFM8Kl6XkELiJOCNZDwzSMB4NVuZjJku4DNmCFN9korI1qfi3USj1WbPYgrHjm2tQRSbx2mYYPg/ApOVNcoxke2t0n/cIZRoOfVVNVkByElcXcI4J35HvEJA7pr6VCtrzA6FzuaDRnVkxBUlSDQis8sUpPFcVw12Lrttz9mFYDuPtebd84LC7xh7gcZZ/DWx/YgP8h7djOGnvUHCU84AA8s6Dprr+NFbDaa3f6vans6kc94z2qj3HtmiA/pc+qgiuQ1q8iuBa3xd9q/03IWyPdijm0rq80GHKYXmplDLo7wuQS6DKwydbxLXY3d4DuCJVFEe4FHUhkteCOzFWptzEM76bq/oajN06OhEvun4E10fgznqAezO9R3rzxL1xqAG6K6nhkWv0Gcupx3KukE6Z6YLNyJfdBN/QtnFnj3Ok1Rmd2pBgh47kFvQbt1I+y+d7+TcCFYTNA4VYBDqGWDtT6PcQi7G0pFyoVmSCxHSAHb+Z9gg0Ro2Jlsx0AR8kWyZ2gNKCvvBQ3S2NhUTUKMrxrG5AUMNOQD3arneDaf4sAao9Un2r/sMjj9MkFXZym1AXHNT8g1JdfEoCUngy5dHuV4aMRomqu1Key2ETLBwQWDK6qeAWmHDw2T/aiduyrjuu87zjdq+tD1PGVh/lj/DUejfcpIaQp0Ga5Sj6BrpQ/Od0wzX8n5u+M1msME0d4Q7jlBxSSKZ1iDqhiupT1Q5f28t3cqzg3r6faHAPWJfnf/6J4mjby8e+0nA7MzWvKIMVQKibQPOSy0C4kA9zPhwnmjOa72xpXYW/Bis4n7JJE7n2ZLTYMEit4ob+BL1ug+xdpSkPPUnazZLZZFD5wCIM3leCtS6ghOcimnNGqlFzZmspnt8k0X+l+F1ddNQgLg7Bq8voOEa0DXGvlb0XbCpd16Bdm89KYXOg8mU/rnDzwyidqxO+6CGhZUGHdnVaBLuHRBr/iIg/PoNDiz6+AkW/+2fO/sXfVO7+gGRvxI6UMOSNQSf6Kj8DO5IC9xjeK7xQm12n2glM4sqkwG+UldjabqutLGKQTO3IPu6yFRWH9G2xn0uHry5DPURp6CC2ZKm2sspi+9wOGa6a4lNwqja49LvLt3Hpc5Hdx6XGRNy+6XQDh3h28Y3NuptW39+9NcdHcKuCBm1vNxig9qHou4tlAwwJ3nELnwXlQd5lBpvzrQCQ6k3CNgwZDD4sMTFNhZqU27kVaHbdes7Bm6x1OX8O3EOJWvdbPhrO3bog2BmWnGeaVtqj7ogGaTh01cVR44OWlwzTj4/E45unwJD4Afhzz4RGPj0fHRycnyf5sdDzZsOgw2oKi3Xex/V2Az/Wv9KeTGqfshcBYOD6/xODzgD3HoPRe1KVKQIH5EeWdbiAOhesfRF/93q1oo3zkrW0X4n+0F2RYvbmbnDXk+9uGK9bkHF9z0+WRKBNSmPnUezlRu1JCNJleD+CT9gRyd3x8KPVFWFZP3vEJ5spZMVMa+jYrzFgNYKej3XfxNTKPe/GOEt0NhLJFgzErPJO4FKVvm4MG6Y7ssnR2V73YzT1VJXF5rZW8ZP723Z3jN1Hcgc2dSAaJd+3gxftNFC7o+hj2LvfYaLx/cPik54jNlYQ750O8wd4hGyIc8tGwFSjFjINcJJs8Db2HJy1dBjisCz02jg5Vn5iDaaT31s4qF8LpXOC3cWT3wtqcR/Cu+Tygzsmg3Xf7grnZzlIOZzxX1430Bsrl2pTcUN/t7+xNwClDNl+XIZo+gvuZoFqk12TOhjW363zfcHt1SLN4QztIKTxoZoOmw++pz51uIL7WiXsL+cj3eVS/JJAK36EuhLWhlQlaZcaNSB74ds4pzS/I72BtkpGx2xVWAqSmoYf8NbDH/gh0u/bJ4WtWR1/vTPBfMS08yJlLCotqb7LqOlFjWCmqFXQP6KMnS2K9k7zjc3YI0IfPKDM9scyURaG0ZSkZR/myG+H34iiswUVA790P3Ul+aEB2E6adaNamdDGs/DK9W8LLK6oaIztpLyvSKiX9kE1nQtv57rO88LV5qHt1NfYalNImnAFIMme7MG2VC3oXIz4UJx1zODgaHccp55P4ANLj+OQQhvHoBNLDdAhwsn+4QaRRNOwOl9I85+yVsL9doisupYxfjsKcasJdUwEDmbJ5JxqGRQ6UuyJWoWZPhJ6Lzj1Tapwez7KjcRLP+CyLD/hoHJ+MJ+N4/2AI43SS8Nn4ZAOl7iaFzgwXfM5+AJ0LWZEJ6YLFIqSn1dYUCjY1SOPs6crvsTlvZ32u1sYUVm+NNjm9mXTZi6S6XMqN+aGtZne+rWHvzo2RYQh2wH4F+ISuJmnn9PTu78D7UAenSSV77/mqFCbaJO1VQ6HetBL4W68V495k9/ar/R+CoVC9GP6HtRhuBtHPDb1x24L+SRTIzSD6sdIgt635uyr5rkq+QZWE1++V9DrDtRXK2PhqFFeRyOqnqUjrn0Mlo5X3Qi87FUhMXeW29QcMQKJAcPExjvdfK+jRz0pxFEpfcO4W06ocZ9w72sS9xeW2WZTJjY5rpVpwv4bH3I234iSSqaDpyqJOr7WwcBrKTeCVb+rTVC9c8opJVOGLxTaHTMgjjrlzLg+zW47F5byGQjN0lXTQMSxR3/7CS7PG0LQMmvV0LeALrJMTHAmO7UggNnIL6KYuJMl7EmJ14MK9yasfzneLtW5ZeYbEpp/2v+K/0p/iePbmLP7PKiBD08+Bp6RlagC9hZ1ehNqAbq9QTsaovFL27M1ZVVScG6MSQZk55OCh187YAB9401NnidaBqPNPB65Ng8KPDHu/EJJyOhpj7/jQnhcirkuZ/6sfMG58/ARh4KttVIbryF2XgXMl34/i0WG7flnj86qiDxj7g0rJJ9Td1zvWS+gpBtB+tflABZG+12X/Xpf9T1SXvbdOZLtY+0MWZA8Fvv/gcuzN0uJ/3mLsoT65Q9isrt5f7bP1TnyLiuyuBAjCpETo9QXEgwSvyjg1DvYgVNX68E9b3r3L6L/fcpplCvoftSOW9Qs1a1b6vcr89yrzm6rM1+Xbv9eY9zbC71Oh/TwKJ+s88lXaw+kesIvQ1leTu/B/EqD6eLMIqgq6++rDjozGlAtfdwlFpi7h4nuV9y2rvJ/LtWXeceMaVd5P2bO7lXjHcTZXeO8Ovam8e63KHc5oENUgo0HUjyIaRBshkOpfLRv/bZZ+X7X4//3v/3ngevH/eDXbtykfvtMNcKeq4bQjv2vd8G+qUf+9Iv12Fen/wNLsf0SB9V7Vcx+ehXsrlh4IPZocD6s/m3jHGurOiWgbDsSVKub4UjqgdOuqJ2aPSym+MChUMn9yDwXZ/dJCEejftT57u4Jgrwdwm3Lia6o6Z0cnfDY7GMcH+yOID/Yn43iW7Gfx+HhyeDQ+huEw21+p6nzb3/ndtbA12awdVyiVFTMF8E/AzTJGH3eM4kGLlLLIiN+jdiMq2dlwwP9Qh03giwVpKGsNL88uNLT2j1dXIG/5I9Z49Q1DrcNaL9hj7u/ksNeNV9aAbmef9e3iRhR/sPPoNHp6NXpa2QpPvzbiDzdP+2JI9DTVxyxKnWOAwHvdeSGc0z1OYUGe95Uz/AIWqkN3N17s8tvxa1zimoF7x3yjKZd93ZgFfo3rN5CUmvIw338NcfJnCcbsn5VIifcfmq3e0r2fTkRP24oxEWIIDpCQBq4pWNKtU0pDxFRSj/HSztFlGd6LDaK39Mj3W2ZwI6yZ4GYQYfjg5zrw0Djlaw53Jdm2OL5/VJn1RsjrniueV9eHXSqeb1O5f4eq6Ct/U7ilHNf9Me3wlDdkplBcD8NkSLaqzn8jJjWI8LZnfsregr4SCTQOXh1Co/K+T6nh0xR5DH1hMf2O766M77pii0BOhqBVjHA8Muyll4ksVEDACF6qkhJDwLSef/EMwF16uY9Qvgizsp/Jq+tyiN1TLZQc/tt/qwUFsj3KugWXjXGeu3hvM8DtOb+L/msdivseK/9jY+Xh/MMX+7TIuSChSUriq9dj76Or5l+BQN44bcfSV5XZB6y6ZCx2/voVQ9W/6PzmBj/+XAJme7z/gKJGU6EI91e6BSV4rQmBNxnm8c/e8HrC1sbf16wr2Dxy2ZB0ka8420oQcIWjXHx+N3j/5MH6Xro6+vVnOlRkrg2s545Y8buWUbcak697oP4u7Ma2TTvszU9v30WDaObzABaKjFPNr/Hizq/dpofnEhRyuMZ/ci4vS5do5MbE//4Pc0GpCg== +sidebar_class_name: "post 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 create 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/post-v-1-employees-employee-id-garnishments.ParamsDetails.json b/docs/api/post-v-1-employees-employee-id-garnishments.ParamsDetails.json new file mode 100644 index 000000000..230d65c22 --- /dev/null +++ b/docs/api/post-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"},{"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/post-v-1-employees-employee-id-garnishments.RequestSchema.json b/docs/api/post-v-1-employees-employee-id-garnishments.RequestSchema.json new file mode 100644 index 000000000..19969bff1 --- /dev/null +++ b/docs/api/post-v-1-employees-employee-id-garnishments.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"required":true,"content":{"application/json":{"schema":{"description":"","type":"object","properties":{"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."},"garnishment_type":{"type":["string","null"],"readOnly":false,"description":"The specific type of garnishment for court ordered garnishments.","enum":["child_support","federal_tax_lien","state_tax_lien","student_loan","creditor_garnishment","federal_loan","other_garnishment"]},"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,"type":["string","null"],"description":"The maximum deduction per annum. A null value indicates no maximum. Represented as a float, e.g. \"200.00\"."},"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."},"total_amount":{"type":["string","null"],"format":"float","readOnly":false,"description":"A maximum total deduction for the lifetime of this garnishment. A null value indicates no maximum."},"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":["amount","court_ordered"]},"examples":{"Example":{"value":{"amount":"150.00","description":"Back taxes","court_ordered":true,"recurring":true,"deduct_as_percentage":false}},"Child-Support-Example":{"value":{"court_ordered":true,"garnishment_type":"child_support","amount":"40","recurring":true,"deduct_as_percentage":true,"pay_period_maximum":"500.00","child_support":{"state":"FL","fips_code":"12011","payment_period":"Monthly","case_number":"CS1234"}}}}}}}} \ No newline at end of file diff --git a/docs/api/post-v-1-employees-employee-id-garnishments.StatusCodes.json b/docs/api/post-v-1-employees-employee-id-garnishments.StatusCodes.json new file mode 100644 index 000000000..7ac83b0a3 --- /dev/null +++ b/docs/api/post-v-1-employees-employee-id-garnishments.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"201":{"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"},"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/post-v-1-employees-employee-id-garnishments.api.mdx b/docs/api/post-v-1-employees-employee-id-garnishments.api.mdx new file mode 100644 index 000000000..8ba781316 --- /dev/null +++ b/docs/api/post-v-1-employees-employee-id-garnishments.api.mdx @@ -0,0 +1,71 @@ +--- +id: post-v-1-employees-employee-id-garnishments +title: "Create 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: "Create a garnishment" +hide_title: true +hide_table_of_contents: true +api: eJztPWtvG7eWf4U7u0AaQCNLsvyIPyzWdZLWwE0TJOl273WCMTVzJPFmRE5Jjm3VMLB/Y//e/pLF4WPekiXZbreFCxSOZzg8h4eH583j2+AmnOVKi5BxDTNJNRM81MsMgpOLABYTSBJIgl5As6w6RAVfe4GmM4XDfqCSMzVfANfmuQSVCa5ABSe3wWgwxB8JqFiyDL8NToI3N3SRpUD8yKAXxIJr4BrH0ixLWWzg7P1T4Qe3gYrnsKDtmaqwe0RIAossFUsAkkCSxwbXHqESyJTdQELoQuRcKxyZgYyBazoD5QZDQqZSLAjlxTT/+9//o0hGl33yeQ5LElNOJlAOp0RlELMpiwnPFxOQREyJZgswEAQnlEiIcykZn5EJVUz1SRVlMyFNlSBzegVkQW/YIl9UcLdzLIHKdOmQDjO6DDOQTCQ4Jag+OROLheAkV6DIVEgyq4LAxccilzoUMgEJCa7HvsKx8ZylCVF5lgmpEcSExt+Ipjc48SexwI8XGeUMFMmkuGIJkFRQrogWRM+BlTRXRM+pNgAlZJQl5IrRGjL9oBdY7grE5J8Q66AXZFJkIDWz/JLnLMGfbpTSSLqg19j2z3MgP/98/tqQew5VGIRx8gOyNMKSQJP3PF0GJ1rmcNcLrkAqZlnqfgi4cTij+8gDs5j3yScA8/uFe497PMtZAl+/m2udqZO9vUTEqm8OWD8Wiz1/oHALpUhT836PJbDIhAYeL1+aLWF8KuTCHADc/7m4RlrnCsExRaYM0qQf3PUCT/hoN6oVZ0ULcj1n8dzOXyXmBFLBZ6qTljTW7AoqYCdCpEC5gTuleart0CYav8xBz/GoSMKFbsNkylM+XRILxKzWnt2uZVpyBSfBNBVU13Cd0lS1MEBC2Nk6GKhP3jCDH62ICESWOhmSiDSl0k3QJx8hk6CAG3mgcBQi0SPQn/XJl+C4Pxh8CcwCaki0V7EB0pUnXZgjEHPUI3fUOzfnHjh+e1rnSlkxQtzcBpqRdSWUi8AoCZBBL+B5mlp10ALnmANHdK2yKUq1IKgTlu2dOp9xgRKNTStylimCbGfwK55uSgmH2laUUXORp4nFgDCewJRxpiFdWrblPKdp5GQ74rEJu95DopamQF4lCGrRJ6cEPyNXNM0B8UFlCopw4T+7l2lHg4Fj216xswWf2o3FzReaplHzWLZGbnY+1yz4tFiugVhZNEpL3I2UTQF5xR6KujzZhB64TxldRlatVvdq8zXtuGcZXRIL9jE2bnhYFTcIJ6IqKuXYYx8DJ0XdCZgA0RJogVtFfmpRM5waK0d0K1sWWRRvA8qX76fByUVbWALH/bkIjPkSOfMFVQEkIGkaaXoTpQxweUpTDfUHeYJQ0IxB01NCwrSQUQWDykxulMA114Z8vesVeBmuuPvate2FhYhDkUGrosNYYFWp2jCXUKDXVtiygE+ThOE/adoy5RKQJAFNWaoq57gwvDwn1w0wQ60d1ZO+FiQFrUESMw2hk4mEK0Zrh9W+YkrlKK3xSQfifXI6Q4uIJFRTFOn0irKUTlI8GOajyx/efCZ7V8O9KsX2atS6JKcfzv3hNoxl+W2j5XkOe3MFckmuAb4FPfeL4QX/6PM1i8Ew9EJwPQ96wTv8mS6DFjv8KK6JmGqwC6B2gbFIU4i1Ms+umZ7PRZogZbyBYY72vx0MBhZAuiThv5NLB+TSLG/KMhXFIuncuPY+vT3/8IngcEKVEjEzJxZBV/bHMibXS4/n77hhljfx22I3GtuD54IqiKypsFZQ38O3Z2Ypn9xS3qDpHYM5m2dUAfnJ2iJtOqE5VKfCJGUzy+khkfBrzvA4I9MvhNKWqqqgUiEV3MjSV3sYo5u9eASyvDfS4xzlJJsya627Z68fRg2FPuXvRA0JC6Y15fHTcsrHAsyfiDrGetd4xKpRlNCsMnSrNKM8fkgz42h+7fzSOKQ2sGMUiQvy4D+NQVN698E4PjoeD+koHO4f7ofjV0cQTuLBNDw8HB8N9uOj8fF4GlSc9eBgNDmKDw6PRuNRPDkaH4zg+NWEjibxYBRPxkeHQcsXDujh5GB/9GocTo+PhuE4mYzCySQZh8fxfjKcwsHheDwISifWOqreljVeW0t0nplAyNKEP9Cg8SCDltfl+Md5Rwc1P8S9a7oF1mqsm9T2WZdhGgyNhR6ssvLsctomlZ2xYVLgQ9zo2taHD9q/Id18//aP9x99/8aDzg2sHcKQnP5jdLw/fNXePzub2z5Ls8oOOlgP28DxbhvYMnhb5qEz4ILTfwRtu6ewTRr6MyhJUdcgfvEtOWpfVAyPYDAeDAbBnf2vF4wH47a1+pPQ5K3IeUK+cEK+cLRGUL6AQnEpQYlcxkASYdweTeCGKd0n7+g3ICqXNuDmwpCJDWYxhQ4TS/pfOIqg8WjUBvszz6SIQSkjK99wzfSywIApsqBLMqdZBpxcz515NhHJEs31pcilx5FgmJoyrghIKaQiKo/n6OtcMm6QiKjWkk1yDZE5NJcmKK3LVZIpmuMkyY1LRHn5JRrhRiVcVkKLbyyYM6phJiQDtWVs0aAZxsXnL22E0pklErx/gMTbOQjfRd1n4jaJ24x7V9WqXXDbGXPPS6OeSknx8DINi+rz1bNG38CedoPlcgUMM+pe3+GTNURA4Ua6w2g+JyKOc6n65PMyYzFNTayOKfINloR5G9J6OMUe7mVU0gWgsyghNeaSzSjYKa3v67HeAjWcwbvadiZigvluKi89HJeRmRR5xvhMEcoTn+DJlcVmkqPCiJEPFm78nPIkNWFGbrm3khbrk/NpCYgpcsmNYIvsPl72KvkDcs3S1LM8ocSOJJduKHGbtLQ2JFiRZV8a0izwvM02cPg++PU6biR0InJd2buQzIBjqMPvmpvaE0PlckpjSxBMjfEE6SMdFpqiw9fFik3jyR1uCSlcUa6to6iFZ5ClO8lOBTBOzJlGG9mIDSeRJin0yVvM9Fn7pFebwuBnSHVpfxq1eWn21j9BA+PSkn9SKhP0OgWHerhpxVoWeaoZJjDNjHiOGgfPP24fNv9miyNdh60Yn3nI+Bkt4j8fKpCs+dABe1nE1tZzzU/UR1M9LJvcK9kmFtLmbxOM0Nt8VEng+yH8zNmvGOYsXUwfILLTmBmt9Mas7BrPrRiXZ5EW6wfW5FzXgEb8qz2k4je9c9wf/sL0PHzPIbTKL7hbPeqd4x07FLemEkZ83vM/8Z7jTCsVdiOEjsJH8HRpDVzMX61RG31ybtJvmVCKoYmlfb2Al0MpXEGqcO+cGvGKohArQcxknKdUfmfRDY3xE743DPeyFg3oGGAZ+ias+vcTyr9FNDZBwiiBFDREOZ/mPIEk8iUGVSPmomZrBFi7UDVMToKWsRZU1FzwNucYFn0Hei4SMqeKeGhFQYPdgxpiVyDZdBkxblg3RkwzodijYvZ3NAMQKnFQUXOi9zIBYuAzSPrkQwoYUIzngPUVaKSgxerQ8YUp/dVLoCnGp5aRn/FJF4DkdQDJBICX6+hAcMEUSqhIily7VOsKxNwI70R2otgw8muIfrTf+wwxU0XwzOHl/d1Y8CmbqQK1wtbcimrtr6vInGqCW6qJ4EBKY3aRK101LLoR86udUqX9aYlStmB6DYYdg7cm4VvE2M1BzByV7B11lC1wdoGDEl/gSZQ4abkCy2JIJ27dtHzDE7QHoXJyjAel55STfZv4UGgTTnOdS7D42cIkPNxJrrRcRgowk8IEjzhlsQ1MRKVhthLjcvT29PwJv7XJlDY7boahA/P0CHrWhF9zmqIWOSQJm7FC7KxBV3kE1AboKhbbsdtj+4nFBlfVRnbskLW4YnAuEtNplImUxcuI08WGe73YiYiLrv1tIpFzc6IgKc4LjWOJYUK5/szUhm0huU/tdwS/Kyg2SVGUo2VV4EMMggzUCsQzMMo1coGUddqx8ek22J7Zw52AidoiynYO6+M6HIgr5Jj6qM4qnIuyw022vRi8/d6/KcobbWXjhhwwoakJmObZPfJytbZeh9UZ5SZCSpN/mm230NT6bZ+LlCUo1fF/i7A3K4wh+phWkc+WeDPCmBTEYWCLPwwGq1HjQj8dWkWI2VjSXYj1SOZMNlPTgmp+JaqFeizY7ElY8dyOKSs30e1SlRiGwU/wiaASzfAiQ/WI9PNnGA1+UoAqk2EGhdZiHhGDzyb2iBUG3LmlLvnpo8AYXG5oNGtWRMAxfoRGmJY0xpofYfK9K3Frjtz+mBYTWH+vtG8sLjbra7gcZV9Ra93A/ynt2MYaO9Sc0lQau51ONUjj629iBbS/2p5+Hwq7+kXHfC/KY1yGJkyckriDcmXrYr+aPLYNLW6Kf238gzCvzXQvzn506dJgyiGaSaEUhjs8cA7GGVhn67gR25s7YHyEwqLwfkEDJWO14I7MRS43MQx3U3U/4uyVk8MBayeumgRyZzxGPZg+orz5YOevIGBBFMdjKsVvwCOHx6NKOmZunxjwLZfcJd0wtnCulQ2nlzhasyMxheupBrkC28jNst5vfxDiTJEJoHArEPaplgaq1F0GQJvKIZvzhUjYlBmx7VH20czHRNZnjLLWZlsELCVrJLeCUoG88rU7S6VhUQzyMrxpGxgpoCJfQHyvnWDHP0QA1WcqTzUnJjzp8HS1CU08VS4zimt+QlTf3MQAaEX4GmkxJcPBwFA1FeJbnq2j5RMi5g0u7wOYkoPv1Mt+UM99lXmdi0bQvXAfgkas3MMP8ddwONrHFdYE2iQV8TeQhfI3QTe8HLQV8zdm6zSGDUc4Q7gWB2Tc1RFrQWTO/fFoLt/CbuO5fj3F5ijQefY0i6JJUrmfttNyGmiuX1O1/vwJl4V2oTHAHTy8sEcMvN3W2EZ7A1a0MWFbJPLoy6yxoZdYPgr9AL6sId29SJUrjEVsGWLfZFEMi1rc5FUleO8SSpQsyiqfmFUJ3tqaIma3zjRvfb5LqK6YhPhJSAG89CGCVQiXWvmh2NbSZQ36eWhOGpsQOo3nkZ5LUFhqH4FTPkElf9fEwCwLCly3p5WnC7KACdsUlbvIwaBEegXExOZPz34knz1yxGvGSv5ICGWCEagkf2ESyDnvkXfiCshngcV1krymJh1ZVZiVi69bm02F++InaeSObCmy1rDIjBOLl1WNSWeuP7t6jlyZOw2ciFyHYhqa925C72ayGadaSAztUZZuFtajLN0lpEdZWnV0mwh4v9tHx+ZURcXbx4+m2GxukfDAzS2gEVMe5BAq2EDCAnfcpM598KD8ZAJTnAzrBJDohMM1TuoNPbzGGiVMTXKpTDW5PzqrF1YdvcXpq8QWfN6q0/pZc/ZWTVHHQehoinWlNeq+riBtTp0ZYqnwxMtLBsmUjkajkCaD43AM9Cikg0MaHg2PDo+P4/3J8OjVmkX72RYm272L7W8TfPb7Qn9aqXFCXjPMhZPXNvncI2eYlO4HTap4LLA+It/JA7FY2O+96LMWNZr2WR3LF87atin+F30vw8rNXResMbG/TbhiRc3xNVVNHgnwIq+aRy7KidoVCwms6fUEMWlHIOvj4wWDG6ZJCbwRE0yFtWIiM/V9VpjSEkBHw+138R0yD+NxmuOFMWInQtkiQakWz8S2ROlhMMwkzZltlc72qtddN/RR4msp+Iw477sJ4zeW7cDmViTjpVxZRPF+Y5lNun5n7u8NR/vjg5cdR2wuOOxcD/EBv/bVEP6QDwe1RClWHKQsXhdp6Dw8SW4rwGFV6rFydNzVQVUp7y2DVTaF03DgNwlkd6K1vo7gc/V6QFmTYXbf7gvWZltL2Z/xVFxXyhtMLde64obSt985moAgfTVfkyGqMYLHAVAs0mkya8Oq+3W+G7i5OjRQ/D0VJ6XwoKk1mg7fm2928kCwJhgSd2P+hfvmRXmTgAu8mYuXV/wo5bUKtuOJn9g7p6bMz8vv+v29rVxYDpCoih5ybmCH/eHpdu2Kw1eszrzemuC/YFm4lzMzkxaVzmSVZaHGoFBULeyeMEZvLInVQfJGzNligDF8YirTY13cC0uMcZQumxl+J478GmwG9NHj0I3ihwrKFmDSyGatKxdjUulot4KXt/gt4Y2yl5a0Sox+mEYTJs3V9y2hvDZ59SkxnxeusdOgpmzCGoBG5myWpi1qQXcx4p3xfjSiMD4cHoUJpa/CMSRH4fEBDMLhMSQHyQDgeP9gjUgz2bAdnNI0peQt07/NMBSXmIpfbKJluw7hgTU8PG9kwxRo2yWsXIc3rDscnUem1Cg5mkwPR3E4oZNpOKbDUXg8ejUK98cDGCWvYjoZHa+h1G5S6FxRRufke5Ap4wWZkC7YMIo7Wm1MIW9TA1fWni7iHuvrdlbXaq0tYXXWaJXTq0WXnZgUziVfWx9aG7azt4ZfNzxGginYHvkF4BuGmriem6t3fwfahbUPmhSy95FdJQ9onbQXFYV6Vyvgr91WDDuL3esX2b/3hkJxDfpPazHc9YKPFb1x34L+Igrkrhf8VGiQ+9b8rEqeVckDVIm//V5Ir3NcWyaUDq+GYZGJLP4VsSSs9upoXRV67nD65+pw+oV/4SoWGZyQy+qLk2vJNFyangwuLGGZ2IjXSqWC8fsZN9rDiMQyDWJv+JXX8OuX7ZodJlf2+zRC2IH9r9A0Sw1PP5yH/1mkdwz4OdDE6KwSgc6+OK9xLQvG3d1rlLohbluCjWaK5qnNrjjm7jQOwOvi5uI0R1uDldWsPTum0onghSIXC8YNB1Xm3vLaPs1YWLZs/Vc3YVh5/BLRwDvgqFpXkbvsEDYajA7CwWE4PLAtv1zzvOrzu7uvPR/P+l4kJsLU3Ncduy/c21L3uU/rc5/WruaKu/bBenBTw/8v3Rufu9f+Lt1rV/LZH9jW9rnf6x/e7/VRuwf//u2Cn9uyPrdlfW7L+tyW9bkt63Nb1j+8LavTok2v4usGLVmLlpnDg86emd8XwZJVbTJbnTG7DRErIDZqM9oJZoNemJX2n8HGeLm2SV09Og98j86VTTbf/i2oN8EcjgbD4TaNN88+YWlQ2TbzJlQZ0G9A1TLEGE0orkBKZia3F5HRf7rRwJUpzsAQko2ArvxTTj1P2Xv+pBOGhfxUq5Ao5vLIYGDDVSnaOKdZvJ4HJwEyfBE527utRLju9hoxT3OLygXEcpli9MmFdGjGbEQnTGBhwjotFn0NCxHUKWfnC20pJr7Gta2YuHPOD9KUXa6aM8PXuHSFTGZKhi5ufUrnNMb00mmORLj4Wh31CWM49ix2jC1sBETRR56M6Q5UGq+0sx9xaLo/EZrrOaoFf7WhF3wy99EeAsHOsALAXS/A2NTHMqpVOcsr+vKusH6Kx7ue/FWtetc2W+46896ZWynBmo5LBfe6kAh+5t+4uObYExNOXNfHnv1DERhhtde4ClmPnIgqoNY3uRJB7AUYZVXvp59AXrEYKpxcBjxNa8c9M3AvwU1DFyI0v2PNvXKftjw8SGNUcFrYP531QpE3TlAQf/sV462JiHPcBcMA/+IaxlJbWujiya89VPIRm3q6+jFbpo9H0b39j/LkIR+h3FhQXpnnzPZcqAXXm3jfliHT5zTJXy5N4k66hhu9l6WUGZFmRPitUzAXwdWw0jkcGe2knkapaZmv2LlDafzu9hYJ9rNM7+7w8a85YMbw4itqN8msh3Nxi7cCTI+Gbsuzyn7ffXTW2EuyMuuyYkm+USBfVpRr4LoW1tJCtvmIzcpsh95fPEXTSVdLv+78VkHm0uQ5s8QKP9cspnYmpvwCFWum146t2kYf3n/6HPSCicv+LKy9KOk1mqr02m66L7nF9BA+uw1Syme5TVbbOfG//wOWEIAh +sidebar_class_name: "post 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:write` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/post-v-1-employees-employee-id-home-addresses.ParamsDetails.json b/docs/api/post-v-1-employees-employee-id-home-addresses.ParamsDetails.json new file mode 100644 index 000000000..fc5537e46 --- /dev/null +++ b/docs/api/post-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/post-v-1-employees-employee-id-home-addresses.RequestSchema.json b/docs/api/post-v-1-employees-employee-id-home-addresses.RequestSchema.json new file mode 100644 index 000000000..163f9ba45 --- /dev/null +++ b/docs/api/post-v-1-employees-employee-id-home-addresses.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"street_1":{"type":"string","example":"300 3rd Street"},"street_2":{"type":["string","null"]},"city":{"type":"string","example":"San Francisco"},"state":{"type":"string","example":"CA"},"zip":{"type":"string","example":"94107"},"effective_date":{"type":["string","null"],"format":"date","example":"2022-01-31"},"courtesy_withholding":{"type":"boolean"}}}}},"required":true}} \ No newline at end of file diff --git a/docs/api/post-v-1-employees-employee-id-home-addresses.StatusCodes.json b/docs/api/post-v-1-employees-employee-id-home-addresses.StatusCodes.json new file mode 100644 index 000000000..9db2a8cf1 --- /dev/null +++ b/docs/api/post-v-1-employees-employee-id-home-addresses.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"201":{"description":"created","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"}}}},"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/post-v-1-employees-employee-id-home-addresses.api.mdx b/docs/api/post-v-1-employees-employee-id-home-addresses.api.mdx new file mode 100644 index 000000000..faba56688 --- /dev/null +++ b/docs/api/post-v-1-employees-employee-id-home-addresses.api.mdx @@ -0,0 +1,73 @@ +--- +id: post-v-1-employees-employee-id-home-addresses +title: "Create 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: "Create an employee's home address" +hide_title: true +hide_table_of_contents: true +api: eJztXFtz27iS/itY7kMmVaItyYrt6Gl9nGSPHzJxjZPNnkpSNEQ0JYxJgAOAtjUu//dTjQtvuthy7Nrds/OQSiLi8qHRN3Q3cBfJEhQ1XIozFk2jUmoTX49iKMpcLgF0/a+Es3ghC0goYwq0Bh0NIgY6VbzE7tE0+rwAgk2Ib0JkRqggYQTCNak0MGIkYWBAFVwASUEZygUx9JZwkUlVWDSEzmRliFlAsUdOwpSEKiBzkKlkwIgUJFVADRAqGKlKhv80koDQlQJyTXPOuFnufRffxUVVllIZ3QUIWQap4ddAGDVczO1AqayUAb0kN9wsFjJnXMztGDqVJUzJZU2c6Y3iBi6jQWToXEfTb9H7sNYacvRjEN3G80obGXNhYO6oHZtlCdgDihkwBiwaRLQs201s15IqWiCxcPi7SNAComnU2pRoEHEkfknNYu2OfPly9g53wiyg3opoECn4o+IKWDQ1qoJBpNMFFDSa3kUOWaSN4mIe3d8P6mn/O/5Pu46T87P4v0BpnMRPvwDKQEWbxxlEIKoCVzwejt/Ew8N49AYXyCCjVW6iafv3+/5C3gV+0XYduNPxjCIznZyfkWuHhVCtZcqpAWb3jixlpWyDlOb5HjnLiJDC8mGp5DVnwAauDS3LnKeW6q80+VZwwYuqaI/945eFMaWe7u8zmeo9u597qSz2w/7FJV0qmef2+z4teex7cjH/dz9g3Pr5dRCHvej+xyDSkFaKm6Xd5VNZlFQsT9IUtD6pzCKafvtx32IkpW/oPOycAl1Kgaw2vYvGwxH+1aWekxJklVQKA8Jgk9aa93/X2O5udfPk7HdITYQzwy0tytzNoisLLdGGmsr+UlUc9cfRcEizo9E4PhzPaDxhWRYfjydZ/PaIHqSHGaOT0WE0iDwNoml0mB6k4wOYpOnxZDhjB9loMjrMjsazNwfHQ8gy5JvA7GGOYzYeHr4dxdloNokn2dEknqWTNB6xCZsNh2/fzoZDZESjAEwyiqbRwWg8Ih95frUkX+my+TaOphESxdI9uqCCfFBUpFyn0jaiBmlwehINoj95GU2jt5PR8MiSsRJGYacvF/iVWiUSNqTWKglzI4zeHg3j4Sgejlxfq16SlnqJphnNNdzfD6JSoUY2HFpkXZWlx4l50HMoTz0qPnVIO1RvfatjOTUeTSPbYN3YTle3sWpDFUpuzq+tJrbKP6xgD+ddT7l69pmUOVCxMl1Ld/DM6X9Db0ETvZBVzsgMnKaHnFn9X1LOSCZVDc1O3rDT6nIVUPZJ5MuwjW0GC62/Nc1Fleeo+la7OU583AQbSL/a1LLuYxrWXP1g47baRgm4b0Tgwe3A3Xd6I/BWLp0a2iNnwg1T/6TJgl4DmQEIwiAHgyp7VhlS0CXRhue5a7Dg2kjFU5ojZ9EVS2D9iM46UFTvW5roMQKRVkqBMLW98fidktwjF+BY+luj+cm84gx2NB6cQVFKAyJdvraM2PaLpCALeYNuTqVxOq5JxiFHM3LfturfnO5oVvhjEBluclxi8FLik6Af7rHzZDhZtR2/SkM+yErsZD02DEG+C0K+CyQlAgWN+6NAy0qlQJgETYQ0BG65NnvkI70CYj05JGqw2OTs3b5VTFw7Dw+3tW+t2mQApaRyvlRHtfrfm42nSlnjwA0Uep0NXBk1uQLskFIDc6mWG+awrR7kr4sSUp5x0ORmAX7NtjuRaVopvUc+L0tk8Hzpdv0KloQzEMb1ssrSGMVnlYH92m0kCnIrBkY2QzptGlDvAA1HwLbI+W4kYuXCDxU2SXvkcyWrkou5dn41FahrwxFgVvGckRRlofDtF1SwHKWGC+eXtbxhi7kArel8rd7rQj4PQBgYynPdHCf8VDGZgwDVkNMPHVDqSmU0dUjxDIMHDA1IOScrXX9ISJNkVkhajPWts/+R5/g2v0xbHVuLizYIyA118mE7oNuIQIJM/ypNbIUsfo+Txp8c13rJHo9XxfKLKJVEN47OciDvheFmicecz5YcdEkWtCxBID8KS7mZZEvcebs1Hh9BnUC58Fuuia7SBaGaXHJhxTOpmTK5pnkFlwMilR0ujJDZDWIVeFrXPeuj6WVLt75305w6GnLQOypXCzNO6+6vnYq2eraQCgLH7H0XT9d460nrdN9fxA3E/Utr/+trbTx01xNxTS6FVWqJ28fLQcuBIjfoznmWJ5S4luTSNyV+k1xchoAVKi8Y/2uMA6IwFF3QdazYhXEahFtBDtdUGOe6GhkYZOkl2at/LoiVafQCrdrwGmmWwx75gOcVZ5EGnSEsPkuqS/d3gqgu7d6GX9BTvHTknzWeFjpWUsCnzJqy7WspqtzwMgc3F7fBwY7ghZ9XhS182UGku3NrLuZhZuxGGeP4iebnrZnc0XzN3I4gD3PNr7SA+jTsKGoWtM02qVQuFsM0MdJyQ4vAD8/wRfA/KmjUg7J6s5nPjui0d6ZkseVsWberysTI7Q07em5dg95Rc7VJywv56Lk//srNIv4kIHbGL7rf3Oqj5x3XFLcGQ45/7fn//T3HkTYa7C4dvqLykSJfutMfRmq2mI09cmZsGFdqzdHFMtLFAWo9lMM15DbC4M1IMBS1WolSrtIqp+oXB7fjN7+O2itc0yBacwqYUXGV0NSGURIXrUgqkVWCAUtKuixAGL3lhIAB7e7xYMVZ6xwTPlQCQ2AfwSwkIwuqSZiN1LPZPegAuwbFs2XChWXdFJGWUvNnRfYPdANwVuJnRcuJR5cZEDs/B7ZHznOgGki6gPTKOSnosXo4hBbYUe9tXgLNMZyzTMKIL7oAJK+f0IWj6nWsAVhwjRoqUbIyPki56VToWiSiKmY2f7IGYs/J7wD9zfUnrj/KRDC7HpfnhCSVIuNzXUOrfc2dqLbauw3mxBDcUkMwy9I4s0WlTduxWA8srDaj2gRpSXJecLMF4ZrGO5PwAyL2YxA7RisyTD1la8xJCYpL1uAFweo4+AaUdZO12NbT8r1gLkjeSI49QZkFFeSAFFKYhUafMKtMpcDhS13iKOGCVdqoZaIhx1C9FImgPNUJJk6TxjHbiLhpvTs9f8W+BPuuYcfHIfTTvDzAwJrwR0VztCKHhPE5r9XOFrg6ANCPgKt56trujvaCpxarXgU78WAdVsMLSGSWJaXMebpMMGn7uL0unkTEYt3+9kFUwkoUsFpeaJqqiuaJ2i4znWY7aO4T149gv5pisxxVOXpWNR5iAXLQG4CXYI1r4gMp26xjr+suaE+dcDOweQ+E7MZwZ1yPgeAERGZZiOpswlwXJjxm2+vGu+99yB+4eoxHc8CM5lSkkLhKjSdZ622oTqmw4VHKfrfb7mbT27d9IXPOUKvjHwc4uBXWEX1Or8in9Ws3wroUxCNAC+Q3fzM0DBe/GKw6/2I96XXABqT0Lpsru5ECNkKtzWPNZi/CimeuTZNGxmOXbsUwLD4pZpIqdMPrPPYz0i/IMDr8pJ6qlTJHCCuLeUYEn23skWsb7LHHUi46UWAMLvcsmnMrEhAYP0InzCiaGqkSadOjG7H1W+4upvUA7rzX+DcOi8+9I5ej7nN4G4EN+F/Sj+2tcY2Zs8UKOADNDCh71n+MF7Daa3f6ndd+9as1471qxLgJTdg4JfGCcg3C+FWE0OJj8Xfa/xTyzkgPYg6tmyMNphySuZJaY7gjTC7AHga2+Tq+xe7uDtgzQu1RhHNBD5L1WnBHFrJSj3EMn2bq/o6jtyRHwJxi3UQPjZfxFO1g/oz65tyN3wLgpqjFI1PyTxCJx/Gsmg6jPn76lSO5T7phbOHMaBdObzA6t4NhhozmBtQGtIkfZfu5/aeAc01mgMqtBhxSLT2oNtTItXUAPdhKFJLxjFu1HSCHaOZzgg0Zo3Jlsx0AR8kOyZ2i1KCuvRbXS22gqBsFHd73DawW0EmoGnvQT3Dtf0YBdUdqpFoQG570OAt6i2WbfZy6UiXFNb8g1Pe3KQB6ER4D7sRoOLRUzaW8qspttHxBYMHhqiudsRjnF/16L+rmvpq8zrde0L0+PkS9WHmYP8b/xqPxgS1xaCu0WS7TK1C18bdBN6yO2on5e6OtdYYtR3hHuBMH5IJIxUChfVKVCOLRX76bexXn9vXUm6PBVOXLLIqyxjXVT1tOD+b2NWXAMJWaGHr7kstCv9A64H4+e6HAzve0Na7CfgQrupiwKxJ59mV22DBorBCF/gm+7IBev0hdaYxF7Bhif8yiOBa1+MHbRvDBJTSQHGRdzeyqpFjZmjpmt801X+n+lFBdPQgJg5B68uYMEW0C3Fjln0XbSZf16Bdm89rYhtBpukjMQoHGsuoEvPGJWvm7PgK7LKix7k6rQBdkARu2uaY8pz6Zhx5/fg3ExuZPTv9OPgdwJFjGVv5ISm2DEWgkv3IF5EwMyEd5DeSzxMpTRd5Rm45sG8xW5e/OblN9fLmub8F0ckc2LkaNgaK0h1is1nXXk2hTz1Fpd+OIyMrEMovtdz9gOGbyuaBGKgztUZ4/LqxHef6UkB7lefug2wcQzt0hOragOqm/Pn80xWVz64QHbm49G7HlQR5QzQYKCtxxmzoPwYOmywwyHAzrBJDoRMANDhocPX4LLGFczyqlwSaTmrz1hoW1W+8gfa3YQshbrfV+tsjepiEeUVn6rgW6V0s6eOHlsSHL6Hg8jikbHscToEcxHR7S+Gh0dHh8nB7MRkdvtyw6jFbYbPdTfH+X4HP9a/vptMaUvOOYCyfvXPJ5QE4xKb0X9akSUPiLT09G4S9AeNXnPGp07csuylfe23Yp/ld7QYf9T9UbD6KMC64XiY9yonXFQgLner1ATNoTyJ3x8WrnLTekmbwXEwy3RhI79ENeWH2jZ+dd/IjMw0WaVww1uhuoddmqJ66uROnn5rCD9Ed2VTq7m17shqT1UeIbJcWc+NN3fw68PbQ7mzuVDALP2iGK9ycvXdL1F9ib75HR+GDy5vUaEVtIAU+uhzjH3qEaIgj5aNhJlGLFQc7TbZGGtcLDKlcBDptSjy3R8ZeOdKu8twlWuRRO7wD/mED2Wljb6wg+t+/ONDUZdvfdvmBttvOUg4zn8qZV3mD8pbSNxQ3N2f7J0QScMlTz9RmiHSN4ngnqRXpL5nxY/bDN9w0fbw7tLN7RDloKBU1vsXT43fZ50gkEa4KBEfuJvPJ9XjU3CYQkJV6HNCa00sGqzKjm6Qufzqkt8wv6O3ib1snY7QgrAJhu2SF/DFzjfwS63fji8A2rs593JvhXLAsPemZu06LKu6yqKdQY1oZqBd0LxuitJ7E5SN6LOTsEGMMntjI9NUS7RxMIs85Rvuxn+L06CmtwGdBnj0P3ih9akP2N0F42a1u5GFfaJE8rePmAfYnolb2saCtm7UOWzLiyDzLsOMs7m1fPiO1eH429BbVlE84BtDrncWnauhb0KU58uHM/pjA5HB3FjNK38QTYUXz8Bobx6BjYGzYEOD54s0Wl2WzYEw6leU7JB27+nGMojtmKX3s5G49rBAXW8vCilw3TgD6iPSLWqWZPhDUHnWem1JgdzbLDcRrP6CyLJ3Q0jo/Hb8fxwWQIY/Y2pbPx8RZKPU0LnWnK6YL8DVTORU0mpEu+tCS68bdXHkeh4FOD0M6fruMe2+t2NtdqbS1h9d5om9PbRZdrkdSHS7G1PrTT7MmnNezdOzESTMEOyFeAKww1CbOwV+/+AXQd6hA0qXXvMx+VwkTbtL1sGdTu1dHObcV4Q7F7uF0O2vxNsmVg/ic9JtK9kbHtZQVfXo9veAyH5EAxcmFbR497Y2HLkwrNyN13P7a9rdD0ObVvHmx4WaFp5t4L2fJkxppXIfpvZzSjjYfjMT4jcjDa4TWM1tY1z/3Yqwu6BHoFVC9je+OvlRs8aT3x1G6Hxi+W16AUZ1C/K2MxGhDausbIzo6RN756ZC+qVA+/foSaujuUe/em7u+W0jTqr6huuGZl6/t1V9j09yvFN3h8AMq9lYXMjA8vTaP969F+nVbbv2u90HS/v/Julk2Re9mvVI4W0l+zpSV3t2xjBoW9arvmPZNC9jbGjRe7OBt+xtVtGHjtmOfKxtQ2jVni5/YzRRco20581zxWVDMhTh7ehLJMCVTZY0L/JqQdIraXdgitzAJPaiEjNYgubBnBz8zgRtgwwf0gQp31W6Pd3geZa2unvgrqPCNUi/HujwmtPBfUkvNNYu6FOKS+gya3z3Phs1WdN5ZaD2sNInwLR3/KLkBd8xRaDNLc7bbXYfdtw32GFENtHdv/Y55C+64rV7ggT+3jOpJYHK80ee/Fm4SKIXxRi8m0QrNqqf9v/pI9deEY/9DYuzAr+Q0vQvszt0ttIIf7r//RMLR9OklqU1DRGuc0PA9XZ7xfdV+A6y+iZdT+Xz9n54TLwK3ZL3PKrRRafXLn9d236HrUepsLCTntvkrXU3o/8BdtsOfdHfo4X1R+f48//1EBujnffqC6VbawySpGxq1DwlpvDm3YqV9+89btNdny4t3aRYVLiWLZ0vaRvyHZeWfPFTq7Z+52g/cv/XjdBro6+q1/MLAmc2ODTx2x4s8d/2DVrWx6oDUozda2bWN9/uniczSIZt51LaR1YBS9wYvq9MZtegjvTe/cb3dRTsW8cn62GxP1DO2aoNrk+H+0bst32eruzrX4LK9A3N/XXGbw/9Ynv/8nBJP/7A== +sidebar_class_name: "post 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:write` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/post-v-1-employees-employee-id-recurring-reimbursements.ParamsDetails.json b/docs/api/post-v-1-employees-employee-id-recurring-reimbursements.ParamsDetails.json new file mode 100644 index 000000000..c8985cf67 --- /dev/null +++ b/docs/api/post-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"}}]} \ No newline at end of file diff --git a/docs/api/post-v-1-employees-employee-id-recurring-reimbursements.RequestSchema.json b/docs/api/post-v-1-employees-employee-id-recurring-reimbursements.RequestSchema.json new file mode 100644 index 000000000..314645790 --- /dev/null +++ b/docs/api/post-v-1-employees-employee-id-recurring-reimbursements.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","required":["description","amount"],"properties":{"description":{"type":"string","description":"The description of the reimbursement"},"amount":{"type":"number","description":"The dollar amount of the reimbursement"}}}}},"required":true}} \ No newline at end of file diff --git a/docs/api/post-v-1-employees-employee-id-recurring-reimbursements.StatusCodes.json b/docs/api/post-v-1-employees-employee-id-recurring-reimbursements.StatusCodes.json new file mode 100644 index 000000000..ba79f5bc2 --- /dev/null +++ b/docs/api/post-v-1-employees-employee-id-recurring-reimbursements.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"201":{"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"}}}},"422":{"description":"invalid attributes","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/post-v-1-employees-employee-id-recurring-reimbursements.api.mdx b/docs/api/post-v-1-employees-employee-id-recurring-reimbursements.api.mdx new file mode 100644 index 000000000..39c81a42e --- /dev/null +++ b/docs/api/post-v-1-employees-employee-id-recurring-reimbursements.api.mdx @@ -0,0 +1,71 @@ +--- +id: post-v-1-employees-employee-id-recurring-reimbursements +title: "Create a recurring reimbursement" +description: "Create a recurring reimbursement for an employee." +sidebar_label: "Create a recurring reimbursement" +hide_title: true +hide_table_of_contents: true +api: eJztWNty47gR/RUEedidKlKidbFXfMpkPEn5Ydcu25OkSqPygkRLwpoEOLjIVqn476kGSImyJI9ns3lIap5sSegLGuccNHpDVQWaWaHkFacprZSx8eoshrIq1BrAbP97EDzWkDuthVw8aBBl5rSBEqQ1NKIcTK5FhY5oSj9oYBYII1sLsmdB5koTJknrvPdZfpYmVxWk5Nd93+mTFhZ+pRG1bGFoOqW3+7FnEX2OF85YFQtpYRF2E9t1Bbgaygw4B04jyqqqu8SbGkxQ2DVNpxv6QZUVk+v3eQ7GvHd2SdPprJ5FtGKalWBBG79OshJoSv8V/92HfX9zFf8DtMG9R1RgAZbAOGgaUZMvoWQ03dCQEDUWy0EjCtKVmOAgGYzj5Dw+G2M+HObMFZam3e/rl/W9xFxKIcEQuwTCmYU4YwY4eX9zRVYhF8KMUblgFjh5EnZJ1sppvyBnRdEjV3MilQQiDKm0WgkOPAprWFUVIvdF+sGQaSmkKF3Z9T37cWltZdJ+n6vc9Hz5e7kq+22544qttSoK/3ufVSJuLIVc/LlxGHe+fodpOAO8R+toW+EO+NrKVswuD/B2vwTy6dPVJVFzX5DWjkZUwxcnNHCaWu3g9IHUdQdI2jyxRWuhwVRKGjBoNEjO8M9+eOM8YuauoBHNlbQgLa7q1LH/m8Glm8P4KvsNcksxODyzsipCoMbng7HMOv+NcwIpml0MJ/PBeBhnyeCneDQaZnF2ns/jyQUbj8f5kI8mQ4RXW7rGbDg6h7NRMonP8slFPBoPRvEEsixO8iQ/O5/AcJxnNKLNcdCU5vNJdj4aJSM4H/LhYJxfnA8YY3yQ5OyCDScHh3A9n4sciHG4a0BRyL0M8Ae2xfPZWZwM75NJmgzTwaiXJEmc/JQmCY2oq/jbF7NSOawxvRj3xgmt64hWGqXMCugU65B1h7hxUnxxQAQHacVcgA4gEuaUePU8qhi/lsU6YKQ+KPdbAh8D7FHfe6Zv8dz5pg3wYgf1roRvcqiKgmkSTE673ILnLT6xtngVtGrVeA106JE7AP95utMNsnCCwzdKj+BQVsqCzNfv/LUj5FzpkoXiSLJUT8QqlJ5w6HMBhRehPfS+ZUNWlGAsKyvytATZQqh76z0xQxqvRw+6S4E/LmLBjCWN6yNh665GTgNxXuJ5P/gWO7sTn0XUCltgvrcta+K9i5rWNYYaJaND/fxFWfI35ST/Fvk84YJ8loR8lvceoF8cGLz+NBjldI5ABkOksgSehbE98jN7RMXSAWvtNUiuLvuencKQFSuEL9tLue4WDbRW2vcT+yrUfL87TKY1W+NVZqE0xy6BA68Pj4AGObOwUHp9IoZf9VXM3FWQo8QZxEuzZ29OVJ47bXrkfl0J7A7WAUyPsN4JY+g1mLVaZM5Cf9sUEQ2F7zKs2rkMFGqz/obU0AOuRUEInoiXi8ZVe0imyXyhlauEXBjCJCc5kyQD30hgNpkTBSc5SkTZrF8yyQsUEyFDs9PpCH3OJRjDFvD1lG/aRDhYJgpDWKac7RQ1JguQoHflbFy3WRqn5ywPmWIzLDkmjpULXNlvCKSyD3NPkg6wpnvnTxvEd/GSdgw7m6MnCIKCgfzwBj1azzCRltq/KBt7ksUfMWh8HVDbMHswOKSlkJ4/O9SY7xT/TvHvFP9fpHjTKICxf1Xcn/fvfup0KXC0szigwB/eAx9tgaUrM/9s/z0tcLdIuxcnvg2eLUjjJw54muEcT84sIrpihfv67AKfyfuuwqt1a++jzxAQdqna4Q6Nwgs6pf3VWX875ulvOk/tuv/KoMeAXrVzEKcLnHU07TirROjGYw6lb8kPCnkJpfIvXVMBewRm1nHwF/s3Ktr55/8Jx0d93mjFX/FZ4c91Z9Jzh6gMoDoy79lCAYO38xv8nAHTR6DRuIgLWEFBmLNLlNJABITY3dpYKP+TCMHDiQB1RJFttztefgx6cmRI0XKlRX1S40hlrnxKDf39QAsHPXujgM4oKqI4eTLX8zvQK5FD55h2LzGvkn2/sM8xb2Ry7D/Hau6PB01f7vSfUOSqBNRKn8cPhnxsGEBuwpvOz6C4yh3C0dfgT01DwXJP5GZwdNlGJbd4cXnG4KOGicLjrPn1LztY+RGCMrZksuPna4PMl3voaOJ/aQgasGPh2farggkPMk+XTUPsKV2ddR5wuO90f452kt2ziC5RI9Ip3WxwnvhJF3WNX39xgBfNdIbqogXLEC3TDeXC4P+cpnNWGHilGj/eNrL4jrwyrTu6vbaxkuuduFEaNerX3Vs9q6N29vpt6f1fT1RP1DXU7/gUe1vm3TXzIRQrvt+7pQ5v/p0Fyl5lX13bvZ9uru/uaUSzprsoFUcbzZ4Qs+wpHLqqApvTTfhuQwsmFy50PMEnUpnta+1WW5t/EBxHYbXZhBX36hFkXW9RZvGz75XqfwMLONgc +sidebar_class_name: "post 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"; + + + + + + + + + + +Create a recurring reimbursement for an employee. + +scope: `reimbursements:write` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/post-v-1-employees-employee-id-rehire.ParamsDetails.json b/docs/api/post-v-1-employees-employee-id-rehire.ParamsDetails.json new file mode 100644 index 000000000..230d65c22 --- /dev/null +++ b/docs/api/post-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/post-v-1-employees-employee-id-rehire.RequestSchema.json b/docs/api/post-v-1-employees-employee-id-rehire.RequestSchema.json new file mode 100644 index 000000000..e92121e06 --- /dev/null +++ b/docs/api/post-v-1-employees-employee-id-rehire.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"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."}},"required":["effective_date","file_new_hire_report","work_location_uuid"],"title":"Rehire-Body"},"examples":{"Example":{"value":{"effective_date":"2023-06-30","work_location_uuid":"b6ae9d93-d4b8-4119-8c96-dba595dd8c30","file_new_hire_report":true}}}}}}} \ No newline at end of file diff --git a/docs/api/post-v-1-employees-employee-id-rehire.StatusCodes.json b/docs/api/post-v-1-employees-employee-id-rehire.StatusCodes.json new file mode 100644 index 000000000..b296270a2 --- /dev/null +++ b/docs/api/post-v-1-employees-employee-id-rehire.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"201":{"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"}}}}}},"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/post-v-1-employees-employee-id-rehire.api.mdx b/docs/api/post-v-1-employees-employee-id-rehire.api.mdx new file mode 100644 index 000000000..ee7007c0e --- /dev/null +++ b/docs/api/post-v-1-employees-employee-id-rehire.api.mdx @@ -0,0 +1,71 @@ +--- +id: post-v-1-employees-employee-id-rehire +title: "Create an employee rehire" +description: "Rehire is created whenever an employee is scheduled to return to the company." +sidebar_label: "Create an employee rehire" +hide_title: true +hide_table_of_contents: true +api: eJztXFtz27iS/itY7kMmp0RbkuVbnjaTyx4/ZOJKMjt7ypNiQKIpYUICHAC0rUn5v59qXEiKomTJsbdqp5KqqZEloPGhgb6igW/RbTyvtZExFwbmihouRWyWFUQvriIoU2AMWDSKaFV1m+jo8ygydK6x2ZuyKuQSgLgPJQhjf1egKyk06OjFt2g6nuD/GOhM8QppRC+iN7e0rAogoWU0ijIpDAiDbWlVFTyz4x3+obHDt0hnCygpfnIgI5n+AZmJRlGlZAXKcDfcNSjNXRffUBvFxTwa9SB8WgDJaqVAGOI7EZkTswDiSB+QjwD27yv/OxdzMq85g88/LYyp9IvDQyYzfWAZeZDJ8jAwLq7oUsmisL8ftt3/05GOC7oE9ZzkUhEucqlKO1kiBVnIG2IkqTUOzTXJORTsILobRZDnkBl+DQmjBnabIKNLcrMAYacBYbkUmFoJjePcSPXVUs95AYmAm2TBFSQKKqlMZ4xUygKoGBzE/0bygs4JF8wunZjjwGYBivw3sofc8KIgOAqhRMANwXGIG8fyoYvQIkJoSSHdPkjqmrPd5owtw0oGgs+0nSkJ5BxDm12baENNrXej36HZUiCOwgH5WFdVscTpU0G4uKYForH9HQs0mA60zui4HP8Q0iQazD8OolEEoi5RzCqqTGJ4iVKS10URPjffJ1DwOU8L/PKaKk7dRw1US0GLaBR5stHnu1FkbmRSgcrsyAuqYCELBmqHxf7NL+jKZuKaUGJuJPE0SYdmWIZMlhUVywPyqdnSRIpiSaykg526a4N/3HCzQO59jF9JVREQhpslQWydZQPYY0v8+uvF6/6WQA4roOy9KJbRC6NquBtF1ArYA1nxTBMFdlsvqCZzKYBwYSRxgjsw3t0ouo3BqUK7+fzneLKiyaIpnB+N2eyIZilLp7NJfpZPZnTKjo8mOZ1NTqM1pkRn2fR8fHIyjtOT7DyeUXYan+cnEAOdzE4ozU/P4Sxq55vTQsO6iomm4+ksHp/ER+NoUF66e2xYg3jKQ8IcnWXp2SlMIT5Oj8bxLJscxXSWz+I0z/MsBTaZnCHIjRvW0kYuGm4KhPvBst9ukg5XvbGxPKVFDd/NXEZns8nk/CSeHdHzeMamRzFlxyzOj04zOEnT8/NsvDNzJ/F48iDusWl2NmazWXx2fJrGMzZjcZrBLJ4eUTieZtnZyVE6upd9w8vaqpk7+28UzcazdTP+izTkrawFI78LQn4XKGsK/qxBG2Bo3GWtMiBMgiZCGgK3XJsD8o5+BaJr5axrpeQ1Z8CclHJNrM48+F3gOs6m0/VhfxWVkhlojYqOvHH6ISDgmpR0SRa0qkC0xi+VbIkqYClrFTAS9DkoF5qAUlJpoutsQagmX7ziTqgxiqe1gcTunC8j4i1VoJBTXmjCakAVRkXbE30Su1xfOn7EGzfMK2pgLhUHvacjYWHGWdP9uXNHrP0spQLCwCAgZN4eHtX93P3B3D5z+14oYuYKmHWfLRL0hFd9U/99a12oUnQZjSJuoNRDvu0a1eQrYAePcrlhDNvqXsv4sYKM59biLsALo+1OZJbVSh+QT8uKZ7Qols4X/QpLwhnaY9sL2zdreFhRRUswgBugoCj/RrYkreVuUO8BDSlgW9xejhKxnrsnFbSH32VkrmRdcTHXhApGMipICuhMWzRpzQtGMtwHpW+/oIIV6K1x4XZvJ9Y5IBd5OxDX5Iuwii1x6/hl1AkWnG/nt7z1cK0K/OKbEr9IS+fceJfG/WhZU6K8zXfw6i/DfP1uJDSVtemsXUzmIEC1q+ZJB2boWuU0cwyhgoBgyB/lURjKqBkMs1ZhvArCraCAayoMwX5I02+QpZdkbwK4IFamrRuMasNrpLSAA/JWKuIN9miFhMVnWfXF/T9BVF/s2oZv0Bp+cexPW2OC3pYU8D6PXlzdN5eyLgzHaNRSRDnqCV74el3Ywi97iPTq2JqLeRgZu1HGOP5Ei8vOSOgtDo7tGHL/rvmFltA4wN6fXtDutsmkcsE4Q2/cOdotg+8f4VfB/6yhVQ+qDeosGUvRae9cybIleNVSFHVR2BDFtaurxMjtDVf03FAD9GhgW5OO9/jO7/74N24W8XsBsTN+0d3mVu/83nFNcWnuRj/W/O+w5khpo8HuBYOofGw8ax1cwreajQNyYfDrSmqNQTtqvAW9BtLooQKuodC4dt6MBEPRqJUo4yqrC6p+cnBj6/zE7+2Gex51ZzjQwG3o1dAzpeJrQrNM1sIkDAowkNQirwUDllTUJ/c6TszViq8RpdRl8RoTH605a1HHzEVva8G4mL8Ds5DMBsxhNNKMZtdgBdg1KJ4vEy7s1s0QaSU1f1Rk/0I3AEclflS0nBi9pEDs+BzYAbksgGog2QKyr85JQY/VwyG0xI5o2jdNgRaYDFgmgeKTTgDZ6wckKYBo5zEAsOQaNVSiZI1pvC3AfItE1GUKahhiz8lfAfrB9SeuP8pEMLsel98JSSZFzue6gdb4mntxbb13F8xLQ3BJDcG8TevMlrU2XcdiGFiYbU61CdKSFLzkZgvCgcZ7s/AtIvY0iKVB9ELWBUPM1HO2wYx5AC5ZixcEa7LJG1A2TQaxDfPyjWDoD0JHcmwEZRZUkCNSSmEWGn3CvDY1JmwQn08SJlywWhu1TDQUmDCRIhGUZzrJJMPMSHDMNiJuW+/Pz1+wL8G+A9txN4R+mKcHGLYm/FnTAq3ICWF8zhu1swWuDgD0DnA1z1zb/dF+5JnFqtfBzjxYh9WmsWWeJ5UseLZMBC13XOvyQUwsh9a3D6IWVqKANfJCs0zVtEjUdplZabaH5n7p+hHs13AsLVCVo2fV4CEWIAe9AXgF1rgmPpGyzTr2uu6D9pUTbgY20YmQHQ0X43oMBAcgMs9DVmcT5pBk1bsse9N4/7UPh5aaUAW774CUFlRkkNTVPfpys7XehuoVFTZDStkfdtndaHr7si9kwRlqdfzPAQ5uhXVEH9MreuWUSeNGWJeCeARogfzib4aGZ1BPBqtJMVtPegjYiFTeZVOAe1UK2Ai1MY/NNnuSrXjhjwebszQMu3Qnh2HxSZFKqtAND+0ek39BhtHhJ81QDSQHYW0yj4jgk8094imi8GEpFytZYEwu9yyacysSEJg/QifMKJoZqRJpD9c2Yuu33F9MGwIu3mv9G4eFWYG1uxx1X3Om2cP/lH5sb44DZk4bqqzfTnMDysb6u3gB6732599l41c/G6D3rBXjNjVh85TEC8o1CONnEVKLu+Jfaf9dyFco3Ys5tG5DGjxySOZKao3pjjC4ABsMbPN1fIv93R2wMULjUYS4oAfJei24IgtZq10cw4eZun8i9Y7kCJhTPBbtofEynqEdLB5R31w6+h0AbohGPHIl/wKReByPqukw6+OHXwvJ/aEb5hYujHbp9BajczsYnpDRwoDagDbxVLbH7d8FnGuSAiq3BnA4aulBtalGrq0D6MHWopSM57ZApYEcspmPCTacGFVri+0AOE6usNwpSg3q2mtxvdQGyqZR0OF938BqAZ24Iq4d/ATX/nsU0CqlVqoFselJj7Okt7ysyz5OXauK4pyfEOqb2wwAvQiPAVdiMh5brhZSfq2rbbx8QmDB4WoKF7Hk4Cf9/CBaPftqz3Wuekn3JnyIernyMH6Mf8aT6RHOcEWhpYXMvoJqjL9NumH1316bv0dt0Bm2O8I7wit5QC6IVFiXZSRRtQji0Z++G3sd5/b5NIujwdTV00yKstY11Q+bTg/m9jnlwPAoNTH09imnhX6hdcD9eMTQW2LHe9gc12HvsBVdTtgViTz6NFe2YdBYIQv9HftyBfTwJHWtMRexZ4p9l0lxLGrxxLtG8N4ptJAcZF2ndlZSrC1Nk7Pb5pqvdX9Iqq4hQgIR0gzexhDRJsCtVf5etCvHZT3+hdG8NrYpdJotErNQoLGwLQFvfKLO+V0fgZ0WNFj351XgC24Bm7a5pryg/jAPPf7iGojNzb989U/yKYAjwTJ2zo+k1DYZgUbyNywevRAj8k5eA/kksbhOkdfUHkd2DWanyn1vt6kJXwKR3tmRzYtRY6CsbBCL1ejWpSO0reeotS9xlrWJZR7b3z3BEGbyuaBGKkztUV7sltajvHhISo/yohvo9gGEuDtkxxZUJ82vj59Ncae5zYEHLm4zGrHlQU1BtN8GCkpccXt0HpIHbZcUciSGdQLIdFs+L0Vwqkt+CyxhXKe10mAPk9pz6w0T67beQ/o6uYVwbjXo/WyRvU0kVjFIk+RYV7rC3dcd0FbqbBPHhSeeHhuznE6n05iy8Vk8A3oa0/EJjU8npydnZ9lROjk93zLpQK20p90P8f3dAZ/r39hPpzVekNccz8LJa3f4PCKv8FD6IOpzJaDwVb4PRuGvK3jV5zxqdO2rVZTPvLftjvifHQQd1i7utmSNzf3tsis21BzfUN3fI1HOBdeLxGc50bpiIYFzvZ4gJ+0Z5GJ8vAdwyw1pB+/lBJvybkv6Pi9MGwVgksn+q/gONw8XWVEz1OiOEOoWBVqv7ZnMlSh93xiWSJ+yq9LZ3/RiN2StzxLfKCnmxEff/TH+4tUDtrlTySAw1g5ZvL945Q5df4KD+QGZTI9mx88HRGwhBTy4HuISe4dqiCDkk/HKQSlWHBQ825ZpGBQeVrsKcNh09NgRHTy+MwvQnfLeNlnljnB6AfwuiexBWNvrCD51rwe0NRl29f3NKkW8pxxkvJA3nfIGW8u1rbihje0fnE3AIUM1X39DdHMEjzNAM0lvyZwPq++3+b7h7ubQjuId7aClUND0FkuHv9s+D4pA7G0wRuxP5Jnv86y9SSDsLbOSGxNa6WBVUqp59sTRObVlfkF/B2/TOhn7hbACgOmOHfJh4ID/Efh244vDN8zO/rw3w3/DsvCgZ+b2WFR5l1W1hRrjxlCtoXvCHL31JDYnyXs5Z4cAc/jEVqZnhui6sndLmXWOimX/hN+rozAHdwL66HnoXvFDB7IbkPVOs7aVi3GlTfKwgpe32JeIXtnLmrZi1j7kScqVWew/ymt7rp4T270Jjb0FtWUTzgG0Ome3Y9qmFvQhTrx33k+nFGYnk9OYUbyuB+w0PjuGcTw5A3bMxgBnR8dbVJo9DXtAUFoUlLzl5q85puKYrfilqMwxXCMosHYPL3qnYXg9WLoQsTlq9kwYCHQemVNTdprmJ9MsTmmaxzM6mcZn0/NpfDQbw5SdZzSdnm3h1MO00IWmnC7Iz6AKLho2IV/wgrDwvNqZQ8GnBqGdP93kPbbX7Wyu1dpawuq90e5O7xZdDiJpgkuxtT50pdmDozXs3YsYCR7BjshvAF8x1STMwl69+xfQIdQhadLo3kcOlcJA27S97BjUu5UC/pXbivFgsfvqbeCfg6PQ3AX+f+sx3I2iDx27cd+E/iYG5G4U/dJYkPvm/MOU/DAl32FKwu33Rntd4NwqqU18PYmbk8jmU8JZ7N6AWLsk5N4mQFCuAJHZe5BwjUkGsfKcBl7MZnXhrmi6t1rCXdqQN/5d/C50Jit4Qb609/f1ixvFDXxxb4O4YNmx1gp95/zcRqNcWJ1mBbVNzrt7Z2vP7fg7VHe7Pq9hVYMf9n9j+wRM/PLyIv6f5tDBDr8AyqwmbQH4ZwlWh3mNcym58DeCURfEqKAZeXl50bzfQ7WWGXfMxSSGvdGLDfASs73OK+yrHG2N5ci16dyPf6bJVcmFrVvo0N7zMjmteNx59scTjDtfP0cYeDMZFf4mdrePwEzH02N8iWNyjNdQGeS0Lox7RCJ8f3f3eRSyLD9LZvMe/XV9pFeWfrxFtNucf7xF9Hd+i+iud098VSg27OPBzfS5/4ZNbAV4h4dshl6VOWqe7Bl8OCY9oXDOzo9iNkvPYnzJJj7Lzk9iltLj82PGzjLbd1gK3cNFd/4Gqa6AfgWql7F9eKFjYrpPwq22RKMQy2tQijObWrTm8EOwmnBrQGibqUTL5dyBjY/VjQIn7nm0Dq1RINUH3dAYBD/cc3USLYWVyaA+9kd+zmmwgmIW0Yvo8Hpy2LgPh986hvnusHEgbDGit+C1KtBcehtEK+5MUMygtHZoTUBeQyl7nHf0YneiiT/j3DYQHqR5qezp5SaaFf6Mk9aQ1cpm3q++hcjoZYZR2ssap3/1udvqIxodt8MH2jaaACEGU2k1A1BlXYf+yxSWRGwvURNamwUKbagQGkUfbVnn94zgKGwY4G4UoTH90JrhjtSuCWuj2jcL2wYhbh2Egeebulp6o4r1T56FCsSgf5yFfHl5gbu6fSWrdTNGEbpi+n3+EdQ1z6Cze1qvyL5KcmgbHjJkFHoPsf0by0W077qm1aHIZGmraCyOZ5q88WJNQuE2OmVMZjVO2bLkP/xbR9Sdinmn83UYlXzA92j80YerMMHt73/9r3a349qhlJZUdOi8cteFuj76sIf/rXWu/o+dfb99Ddyaw6qg3O5zK9ffvL65iq4nnYfMkBMvVoMBP6fPeB9KG+zx7Rs62L+q4u4Ov/6zBozDrj537DqKN+M29bLBce8y5acP3lg+Jxujhg2TCc8viGVH10b+LYiVsMZd6XJRxX7w/uYhxiBfHf+G47OGza0FfOWYFX9aMb3rkUTbA/VsZba27RrJy/cfP0WjKPXRSymth6DoDe5QeuMWPRxkYniD332LCirmtUsBOJr4799dqkPd +sidebar_class_name: "post 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"; + + + + + + + + + + +Rehire is created whenever an employee is scheduled to return to the company. + +scope: `employments:write` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/post-v-1-employees-employee-id-salary-estimates.ParamsDetails.json b/docs/api/post-v-1-employees-employee-id-salary-estimates.ParamsDetails.json new file mode 100644 index 000000000..7c63442dd --- /dev/null +++ b/docs/api/post-v-1-employees-employee-id-salary-estimates.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","required":true,"description":"The UUID of the employee","schema":{"type":"string"}}]} \ No newline at end of file diff --git a/docs/api/post-v-1-employees-employee-id-salary-estimates.RequestSchema.json b/docs/api/post-v-1-employees-employee-id-salary-estimates.RequestSchema.json new file mode 100644 index 000000000..2adbe47ff --- /dev/null +++ b/docs/api/post-v-1-employees-employee-id-salary-estimates.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","required":["zip_code","occupations"],"properties":{"annual_net_revenue":{"type":["number","null"],"description":"The annual net revenue of the business (must be greater than 0)","example":500000},"zip_code":{"type":"string","description":"The ZIP code for location-based salary calculations","pattern":"^\\d{5}$","example":"94107"},"occupations":{"type":"array","description":"Array of occupations. Time percentages must sum to 100%.","minItems":1,"items":{"type":"object","required":["code","experience_level","time_percentage"],"properties":{"code":{"type":"string","description":"Bureau of Labor Statistics (BLS) occupation code","example":"151252"},"experience_level":{"type":"string","description":"Experience level for this occupation","enum":["novice","intermediate","average","skilled","expert"],"example":"skilled"},"time_percentage":{"type":"string","format":"float","description":"Percentage of time spent in this occupation (as decimal, e.g., 1.0 = 100%)","minimum":0,"maximum":1,"example":1},"primary":{"type":"boolean","description":"Whether this is the primary occupation","example":true}}}}}}}},"required":true}} \ No newline at end of file diff --git a/docs/api/post-v-1-employees-employee-id-salary-estimates.StatusCodes.json b/docs/api/post-v-1-employees-employee-id-salary-estimates.StatusCodes.json new file mode 100644 index 000000000..136c2ccbd --- /dev/null +++ b/docs/api/post-v-1-employees-employee-id-salary-estimates.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"201":{"description":"successfully created","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"}}}},"422":{"description":"unprocessable entity - invalid parameters","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/post-v-1-employees-employee-id-salary-estimates.api.mdx b/docs/api/post-v-1-employees-employee-id-salary-estimates.api.mdx new file mode 100644 index 000000000..3c15166d8 --- /dev/null +++ b/docs/api/post-v-1-employees-employee-id-salary-estimates.api.mdx @@ -0,0 +1,78 @@ +--- +id: post-v-1-employees-employee-id-salary-estimates +title: "Create a salary estimate for an employee" +description: "Create a salary estimate for an employee. This endpoint helps calculate a reasonable salary for S Corp owners based on their occupation, experience level, location, and business revenue." +sidebar_label: "Create a salary estimate for an employee" +hide_title: true +hide_table_of_contents: true +api: eJztXItvGzlz/1fYbYskgFaWHNtJBBRoLo9+Br5cgrOv169JuqF2RxIvu+QeybWjGP7fixmS+9JKthy7zzvgkERLDn8k58XhcK4iVYLmVih5mkWzqFTGxhfTGIoyV2sAU/8tEVlseM71OgFjRcEtmGgUZWBSLUokEM2iVxq4BcaZa8lCS7ZQmnHJArExO18Jw0BmpRLSshXkpWEpz9MqdwQ0cKMkn+cQaCGJM/ZK6ZKpSwnasDk3kDElmV2B0EylaVXSVEYMvpWgBcgUWA4XkI9YrlL/jcuMzSsjJBjDNFyArGD8SX6SLzdgF5WxTMg0rzKYfZIxeyllxXMmwYaeTC1w/Joitvr30w8sVZmbdhg4dnD9EBm3HJu+l8CUZoXS0JqAYZfCrjZmYQi7FQWwEnQK0vIlGPaYYJqqYFax6WTyj09wNu9lvmZKAhMyLrVaapxuf4Ipbso3YSwSrLeHccs4jTNmpwvcuDaNujPPNfBs7QiYEVuryq0YCLsCzXiaQmmZsDjDygCtU1Vm2DdsPS28SVUJM/alz1+zSy0sfIlGkeVLE80+RmcO/5uaAz+Pom/xsjJWxUJaWDpeju26BGwPxRyyDLJoFPGybDehriXXvAALGolfRZIXEM2if4v/hQi+/HAa/ytog7w9igQy+Ap4BjoaRSZdQcGj2VXkhoqM1UIuo1EEsipw6MPJ4XE8OYmnxzhSBgte5TaatX+/7svPa8RSIB/RWuFKebZ5+eGUXTgsjBujUsEtZI5N1qrS1CDleU47JmnfDSu1uhAZZCPXhpdlLhw3PjLsYyGkKKqiTfvz45W1pZkdHGQqNWNa2HGqioOwkHHJ11rlOX0/4KWIfU8hl3/vCcatn58gjMpANo6uR/UKt5RKWNmS21U0ijT8UQkNWTSzuoL++pyvgP366+nrIHSBzo4Nub7+PIoMpJUWdk27/EoVJZfrl2kKxrys7Cqaffx83WIkbS75MgDQYEolDRgkfTiZ4h9dUKYiSosqz9csJQ2Is0qVtCAttm+t+8HvBjtdbeJV898htRsqdVMpBTWJrOD16lnc6MVGLf6QQoxGUanROFjh5l5VIhvi99071AM/pi3mGSont8LXo4YbukN8bMaQVZ47KboNNzCLxqW/bMLgau0G8Lua3xuI39V8K5C+BD9WuDFOX0L2ZBAkJ9OTSLCJ36M9UfIbbRcJKvGUx9xiNYMCHH0XZYKWbc+ha4NYDzBsFbvjoX62FjRS+Y9Pn7Kr4+t/QBAaDKnSBgLpddLL2zHU3kU24Fw0myMZ2lUzZj9Xec4E6lLL1mBb/Ye3x29ewu3OxVkoXWCTiJQ72thBGcIPxvKiZJcrkMOMdMlNzTMkxAsheS6+b0HoVVMHYIPvnnH5wQaBOBfgvwhIzo31TscwmpbX1YLDtebrTWWMv6LUbLhqzgXd4bDxPLA8cbawUJgh7d9Vul1Z26Z0f6o08Apx/ZXP0U223ApjRWrY45/+evakBZfEkETZmeKbSL9vemKH8YbPsgeB1gei06xWQqt1M7E3vfUlVUJb38xw3PLBpLoQKZCLgY4VZKhz0Re8AM2X5DZ8FXlO9prQ2Ojz9SjCDUsaD/tmXB/qtqRScb9NCRLPDn147DE3LINUFDxnjtyITeLpE1qSUouC63VrxLlSOXC5MeRvKyAnm8gL5y/63p3FuL5uO1UfHUcNrP3mrD9f9/uSaezb60HL1LIUHcXTEf6u7JEDBt94UeaO971flRjLbdVyQaJni+PsafbiaXySnSzio+fpJH6xOII4zaaH6WH2FI7mhxswZ9Hz9PDF5ORkEs9P0hfxEc+exS8WJxADnx6dcL549gKeR4POAOruYQMcHU/wv/Z8Z9GLo+nkWdTYqekhNZr0jISj2tbK/mwwjafH59PJ7OlkNpmMJ5NJPHk+o0HamvPGxh3F9jHokmh6HE8Pj3GBvDN+phb2kmtgr5ERUPuYETtbG9RQLHzc4L9fwADX6WqEYi2WEv+k7s6ftGAs87EFuWTGkYud1BpPdDzEiLOWTG4IYjQdT6KWmJAO/3xNMmtzmg3ZgDicEKNr4uKjydGm4/6zsuytquRe3voWEuyTZOyTRMuEEgPG+RlGVToFlikw5EjQUXnM3vGvwEylwYutO6Wx09cH5EoKwy54Lshe9e1DWx5Ba6XdQbZjNfzvm9Zsq9XZoJp8BeyQcgtLpddbxqBWN2rHsxJSsRBg0FT7OVN3UlTajNn5uhR4eF07dfYV1kxkIK3rhe25tVrMKwsH9ZmdaXDunFUNSdKiNeo9oCEFbIsK3FFizmt0pMImGY98qVVVCrl0Fh7DKHPv3VrF5pXIM5biYbLw7VdcZjlKgpDuLN4KRRDmAoy5na0JQDKwXKCLMVeVbS1qzJYgQTfL6UkHlKbSC546pBj+kRkCx5VzstLVwlLZZEFC0mKsj539jzzHt/ll1urYmly0RUDQU0P5oA7jqCvSPysbk5DFb3DQ+L3jWi/Zh4ebYlnJUis0HuTjIyPZNYuZkCRWrBX2ubPk/9oZ4g0NEXQArjlfsxUvS5DBPwU2Vxk5j7T/fhEYDs+F9HxlmKnSFeOGffFgk5rzkwueV/BlxMjnqZeRLYgLsgr8htY969DulzE7Ayd3H9+4YV65jRJg9gz5EMw4rbs/YctK+FAnRTE9W44/yT+11/8L7YUBx3ogYdgXScKduH38MiJwbq/YpcjzwPKMM9eSffFNmd+ktQ9/O7l1H//HKElEYTnG728O3r0Kwq0hhwsuLcX9kaZnkLWXZK8GhWQk03hOILXhNdI8hzF7q/CASZp51CFB+Gipvrg/E0T1hfY2/IKO7Be3/PPG40AHQ0l4vyCVvnsuRZVbUQZ1Kuj2pyN44edNYQtf9hDpXohVyGWtyPHEkWUCP/H8Q2skF7AdGNstyM1c8zMv6piYX1G74m22SZV2AeHMMKvcKbZZ4JtH+FWKPypo1IP2J9gwHlF02nuhVbEjklS3q8rEqt0NO3puqAEesXbF9NrW+J3n/vg3YVfxewmxM37R9fZW7zzvuKa4NXgZ8Oee/+/fc6S01WD3IhaofBTeSrobR7HTbIzZqaUrLGWMQBfLKrbiF3gn6/WQj7CpRTAjwVDUaiVKhcaYrX7s4Hb8xydRe4YDDaIBb3jO5deEp6mqpE0yyMFCUslFJTPIkpKvC4wd7/CUMdrddZM3nLWOu/y2kpmQy3dgVypjK25YGI3Vo9EedIBdgBaLdSIksW6KSEtlxL0i+xu6ATgq86Oi5UQXfg6MxheQjdmHHLgBlq4g/eqcFPRYPRzGC+xoxtun4K+Yk0DxQSeAyxvutOcAspnHAMBCGNRQiVYVRjh2nY5ci0RWxZzuKAYg9pz8DtBfXH/m+qNMBLPrcXlOSFIlF2Jpami1r7nXqm32boN5aRluqaXMgsaZpWv/lmMxDCzMdsGNDdKS5KIQdgfCgcZ7L+FbROxpMKLBzEpVeYaYuV/ZGjNGnITKGrwgsyTz2nILyrrJILbhtXwjM7rib0kOnaDsikv2lBVK2pVBn3BR2UqDw5e62+tEyKwyVq8TAzmkyN2J5CI1FIRMGsdsK+Km9f7r+TP2dTd6m+x4O4R+mIcHGFgT/sDbT6vYCcvEUtRqZwdcEwCYW8A1InVt90d7JlLCajbBHnmwDivFQ9VikZQqF+k6wQju7fa6uNMiFkP72wdRSZIoyGp54WmqMVSud8tMp9kemvul68d0naI1BzbPUZWjZ1XjYQRQgNkCvAQyrokPpOyyjr2u+6B95YQ7A55acYGQHQ13xvUY3J2RWixCVGcb5jox7zbbXjfef+/fhK4MbwZuzQFznnMM5buLijtZ612oXnFJYUKe/U7b7kYzu7d9pXKRoVbH/x3g4Fa4zLV7dCp8blHtRpBLwTwCtEB+87dDw7Dpg8Gq7yHIkx4CNmKld9lcKqeSsBVqbR5rNnsQVjz1Uds6swaPXaYVwyB8Ss4V1+iG10lh97h+QYbR4Wf1UE3+GUHYmMw9Ijin2COmDkl/LBWyEwXG4HLPojm3IgHKdEEnzGqeWqUTRfkPW7H1W+4vpjUBd95r/BuHxaUAEZej7nN4G4EN+B/Sj+3NccDMGcs1+e18YUHTWf82XsBmr/3X70PtVz8aoPeoEeMmNEFxSuYF5QKk9bMIocXb4u+0/yHkHUo3Yg6tmyMNXjkkS62MwXBHGBxv30u+i3tDi/3dHaAzQu1RhHNBDxJ5LbgjK1Xp2ziGdzN1f0HqLcmRsORWXPQXyMt4inYwv0d988HRbwFwQ9TisdDqO8jE47hXTYdRHz/8xpHcX7phbOHUGhdObzD6/Ai8IeO5Bb0FbeKp7D63/xBwYdgcULnVgMNVSw8qhRoxf0cUYW8rWahMLASp7QA5RDPvE2y4MSo3NtsBcCvZWXKnKA3oi5ApSpkddaOgw/u+AWkBk4Tkvhv9BNf+RxRQl1Ij1ZJReNLjLPg3TFnv4zSVLjnO+QGhvvmWAqAX4THgTkwnE58eq75W5a61fEBgweEKZwDKb35sKC25fffV3Ot87AXd6+ND1IuVh/Fj/Gc8PXxKV/1thTbPVfoVdG38Kegm5ELtxfw9aoPOMHGEd4Q7cUAhmdIZ5tYppisZxKM/fTf2Js7d86k3x4CtyoeZFM8a19TcbTo9mLvntIAMr1ITy7895LTQLyQH3I/HLP/GaLy7zXET9i1Y0cWEXZLIvU+zw4ZBY4Uo9A/wZQf08CRNhRmr2Z4h9ttMChOzA/G2EbxxCg0kB9lUc5qVkhtbU8fsdrnmG93vEqqribBAhNWDN2eIaBvgxir/KNrOdVlv/cJoXhtTCJ2nq8SuNJiVyrMEvPGJWvd3fQQ0Laix7r9WYV2QBShsc8FFzv1lHnr8+QUwis2/fPUXdh7AsWAZW/dHShkKRqCR/E1oYKdyxN6pC2DnCjMwNXvN6TqybTD9G7Q7uU318eWifgHYuTuiuBg+TylKOsRaFZ428iafA9/VLNHlUJWN1SKm755gOGaKpeRW4bPHgov8dmE9LvK7hPS4yNsH3T6AcO4O0bEVN0n99f6jKe42t77wwM2tR2OUHuQB1WygocAdp6vzEDxousxhgcQwTwAXnUm4RKLB0RPfIEsyYeaVNkCXSc299ZaJtVvvIX2t2EK4txr0fnbI3jYSt8iwfN0C3cupHD3w9LJJtuCHh4cxzybP4yPgz2I+OeHxs+mzk+fP06fz6bMXOyYdqBV0230X399d8Ln+tf10WmPGXgu8C2ev3eXziL3CS2n3LHUIhX92cGcUrn9Qfc6jRte+7KJ85L1td8X/aBx02H9X3u0oWggpzCrxUU60rphI4FyvB4hJ+wVyZ3yrULItawbvxQTDI6qESN/khRmrAWwy3X8X37Ve/mM9AyKEugWfwG/wTOpSlH5sDCLSp+yydPY3vda/NPVR4kut5JL503d/jO+ivAObO5UM+LCqjuJ9F6W7dH0M4+WYTQ+fHh0/GRCxlZJw53yID9g7ZEMEIZ9OOhelmHGQi3RXpGFQeLLKZYDDtqvHluj4Z3+mld5rejURegf42wSyB2HtziM4b78haXIyaPfdvmButvOUg4zn6rKV3kC5XLuSG5qz/Z2jCThkyObrM0Q7RnA/A9ST9JbM+bDmZpvvG97eHNIo3tEOWgoFzeywdPid+tzpBII5wZAx+sQe+T6PmpcEUmE1j0JYG1qZYFXm3Ij0gU/nnNL8gv4O3iY5GfsdYSVAZlp2yB8DB/yPsG6XPjl8y+wu3ZvPPRf8N0wLD3pmSdei2rusuknUmNSGagPdA8boyZPYHiTvxZwdAozhM8pMT7FqTFkqbVlGzlG+7t/we3UU5uBuQO89Dt1LfmhBdgNmvdusXeliQhub3C3h5S32pXfO3WNS328m+7BI5kJTzZI9R3lN9+oLRt3ro7G3oJQ24RxA0jm3u6atc0Hv4sSHV7WHHI5Ops/ijPMX8RFkz+LnxzCJp88hO84mAM+fHu9QaXQbdodDaZ5z9lbY70sMxWWU8ctRmeNxjaHAEg+verdhBtBHpCNifdXsF2HgoHPPK3WYPZsvTg7TeM7ni/iITw/j54cvDuOnRxM4zF6kfH74fMdK3U0LnRou+Ir9BDoXsl4mXJd8TUt06V+v3G6Fgk8N0jh/uo577M7b2Z6rtTOF1XujbU5vJ10OIqkPl3Jnfmin2Z1Pa9i7d2JkeAU7Yr8BfMVQk7Qrenr3N+BDqEPQpNa993xUCgPt0vaqZVC7Tyg7rxXjLcnu4bk/GPuTytaB+e9UxKj9MqhVCqD34L/7bmN3hZv6uPBDFW4eDxryyRN6iU55/tHMvekfrHazq+zRLaq+tevbDJe3acHwdQTuoUTJmJ33a8b1S8aRBybkqXs4Mb3lY8s9ikn811Q26azf9JgKHTxYpZEfLDTShhq+3q74SF0iZ5Ervvly6o7VSEYMD+0jNh1P2D+5OoKOKfByOppN6sty4o8a+/QBypa0t5FKPPj/+vXhaGstSFMXuXAKdmtJQHpAVd1cGhA9iC4pVxSu7u8KT5CngLFKVznTifQqmkUHF9OD+gb24KpV7+76YKCKJuVTeENRaayBEd5k81K4J9lxBgW9y95Y0tdQqAgfKpkS+FfgZh07erELyuJnnM8WwoM0P2gKwG6jWeLndmG9MzQETrAHyuvVXIGDh1p9xCXANen0/rNZIuGrhfDKrvBYH64vR5ErTvIjIzgKWwa4HkVo4H5pTOGbwIzDRurYl3cZqAGztQiLr8GyX/mT6WbpE1Q5Ljki2HoqXolFHZFbww1Yu+zkKEIdZd4vzkCT2mq4onn9Tw+mD6jhQRYKw8T0b7zJMr7rhnxDnqqCLvgIxyPD3nhBYyGnDOtNZiqt0PGipfk7X4aBu4Cdr0tTl6Nhv0BjM93lF7K1//rPDRfjzqEcFly26Ny2KG1/Li3v58/Ctn8Wtn2gwrZObVn4Zg/KnAvSb6Spr7wt+RhdTFtlqVAGZt36qRsG5TOm6xuLfa+ucHd+1fn1Nf78RwWoOz5+RkOmKcOQ1FIm6GSQRbMFz02/7mpbEh7/4i3wE7ajGuvgtILfKteNHY0i/1S5UxPWvThwtXb3g/d/uoLulnV16zdctbhe5sajeeUWKz7vOESb57umx0vi951t267Qh/dn59EomvszZOFMnuaXeHrgl27TQ5x9duV+u4pyLpeVO/A6mqjOede81+bc/6VVtqLLVldXrsW5+gry+rrmMov/psPx9X8Ca1ZVnA== +sidebar_class_name: "post 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"; + + + + + + + + + + +Create a salary estimate for an employee. This endpoint helps calculate a reasonable salary for S Corp owners based on their occupation, experience level, location, and business revenue. + +A salary estimate must include: +- Annual net revenue of the business +- ZIP code for location-based salary data +- One or more occupations with experience levels and time percentages (must sum to 100%) + +Only one in-progress salary estimate can exist per employee at a time. If an in-progress estimate already exists, you must either accept it or use the update endpoint. + +scope: `salary_estimates:write` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/post-v-1-employees-employee-id-terminations.ParamsDetails.json b/docs/api/post-v-1-employees-employee-id-terminations.ParamsDetails.json new file mode 100644 index 000000000..230d65c22 --- /dev/null +++ b/docs/api/post-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/post-v-1-employees-employee-id-terminations.RequestSchema.json b/docs/api/post-v-1-employees-employee-id-terminations.RequestSchema.json new file mode 100644 index 000000000..2c929970a --- /dev/null +++ b/docs/api/post-v-1-employees-employee-id-terminations.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"required":true,"content":{"application/json":{"schema":{"description":"","type":"object","properties":{"effective_date":{"type":"string","description":"The employee's last day of work."},"run_termination_payroll":{"type":"boolean","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":["effective_date"]},"examples":{"Example":{"value":{"effective_date":"2020-06-30","run_termination_payroll":true}}}}}}} \ No newline at end of file diff --git a/docs/api/post-v-1-employees-employee-id-terminations.StatusCodes.json b/docs/api/post-v-1-employees-employee-id-terminations.StatusCodes.json new file mode 100644 index 000000000..b5f1bd287 --- /dev/null +++ b/docs/api/post-v-1-employees-employee-id-terminations.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"201":{"description":"Example Response","content":{"application/json":{"schema":{"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"},"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/post-v-1-employees-employee-id-terminations.api.mdx b/docs/api/post-v-1-employees-employee-id-terminations.api.mdx new file mode 100644 index 000000000..8249776ad --- /dev/null +++ b/docs/api/post-v-1-employees-employee-id-terminations.api.mdx @@ -0,0 +1,73 @@ +--- +id: post-v-1-employees-employee-id-terminations +title: "Create an employee termination" +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: "Create an employee termination" +hide_title: true +hide_table_of_contents: true +api: eJztXFlvHLey/iu8fR9sA9NaRvKmp+N4uUcPjg0v1+dAMVqcZs0M426yQ7JHmgj67wdVJHubRRpZejhBAgRRpsmqj0XWwmKRV8llOqut06lUDmaGO6lV6pYVJCdnCZQTEAJEMkp4VXWb2OT7KHF8ZrHZ27Iq9BKA+T9KUI6+G7CVVhZscnKVjA8O8T8CbG5khTSSk+TtJS+rAtin0DIZJblWDpTDtryqCpkTv/3fLXa4Smw+h5LjXx5koie/Q+6S0YDylzkwA5UBC8oRCaanjDMHppTK/yAV+z8c+14ySiqjKzBOerB1LUWHh3VGqtlaHl+/nr5Bym4OPdoeFlI2wMUHVSyTE2dquB4lCzBW+tHcTD+vjQHlWOgUWQXy7DMA/f9Z+C7VjM1qKeD747lzlT3Z3xc6t3s0x3u5LvfjnKYVXxpdFPR9XwooK+1A5csnbKoNk2qqTRnGothcXzCnWW2RnbRsKqEQe8n1KIEw+dndZBa7I/WLucznnn5vmizjzvF8DmKtPHnu5AI6rCdaF8DVCu9vc3BzMD2+j/q85tyymVbApHKawXS6aRJzrnIo+KS4J8bSspbkHnvd/I1fkCeTU3ZuapV1emVhDs+x0ZQXFhhXgp173HIBmeAO6KtUxH1au9rA2hH1O62bybYL8Vo3tZ3RFdw6JvgSZ/pCmx+0WjYMYK0Mb2B3OiW5jPrLyM51XQhmIAe5IN2Qhk2l4gW74DOwbCE546hH0zRf5gWwAGGPnU69DIni8mZKWoUfo45WfMnQPom6gL3kGocLf9TSgEArSfqBVlM6XDTJl1YMpEfeFJL5CWYR/1zwoobWJCWCHx8fHr58lh4f8ZfpsRgfpVw8Fen06HkOzyaTly/zg2RFK2/brTFNiTh+8VyIg8nTp2Ka81yIl+ODPJ8IDnzKj54eJq3e0Sz0FML/MlxQyfhgfJAeHKWHyGrjSqA5uKZ/RsnxwfGq1/hVO/ZO10qw3xRjvylv6/+owTrACbO6NjkwocEypR2DS2ndHnvPfwCztfEWszJ6IQUIb42kZQteSLH3G03G8Xi8yvarqozOwVpSy7fKSbdsEEjLSr5kc15VoNjFHLy+TbQgBVjq2kSMDF0cl8oyMEYby2ydzxm37FwqApFx54yc1A4ymv7zEdPeeEQKUy4Ly0RNZpOrtic6MZLnecc3vPVsXnMHM20k2B2dA8FM86b7E+9iyE+U2gAT4BAQCm8HB36zdP8W7lC4w6Cna2D8gNHE9IOZ8HtrYrkxfJmMEumgtOtCqRWq2Q/ADgHlcgMPanVjBPC5glxOJVicyKCM1J3pPK+N3WNflpXMeVEsfSzwA5ZMClDO98L2zRzuV9zwEhzgAig46r/TLUnyOQ3qHaBROLesAJeXp8QoGgukovUIq4zNjK4rqWaW/G/OFZsABkuEZlLLQrAc10EZ2s+5EgXGalL51dsJrckRNYykZeeKDFvm5/F81AkA2YUsirjkGWe+JTsPTVmYpCW7kG7OwJss/5FEU6K+zdY6+75kPsbxhtXI+ETXrjN3KZuBAtPOWiAdhWFrM+W5FwhXDJRA+ZiAwnHB3S2i+tdRuQ0UsOAKAwzHkWZYIMugycEFSMVIpzHCIrMRLBLFWO+0YcHrjnokCB+J6tz/N0NU5yG28r+gXz334p+0zgQDK63gwzQ5ObtpLGVdOImbH6KIejRQvPjzqrLFLzuodJ+3lWoWOWM3LoTET7z42OHk3fga3l4gN6+aX3kJTaDvJermvLtscm38LlFYhhsxDIRaAd/M4auSf2BsHM2DIbvZ8iOK3npPjS5bgmctRVUXRfK9aVdXmdPbG/bs3LoG1vVC6NUm120c+D6s/vSbdPP0g4LUO7/kenOr92Ht+KY4Ndejv+f8rzDnSGmjwx7sKtH4aFUsfYCLG8QtbmOPnTr8udLWSgyxnGZzvgDW2KECFlBYnLvgRqKjaMxKkkuT1wU3jz3clIKf9AMtuCdJd4RrGvgFfZl2dzoTrn5kPM91rVwmoAAHWa2mtRIgcEvgc0mdIOasF2skE+6TRo2LT1aCtaTj5pJ3tRJSzd6Dm2tBu/3IjTXcaA56wBZg5HSZSUVLN0eklbbyXpH9G8MA5MoCV/ScuHuZACP+EsQe+1gAt8DyOeQ/Qs4Jd9keDuMldkTXvmkIvMBd9TKLFB90ACjewJBNAFQ7jjUAS2nRQmVG1w7VZjOw0CJTdTkBsx7iIMjvAf3k+zPfH3Uiut2AK6yELNdqKme2gdbEmjtJbbV3F8wrx3BKHcOkUxvMlrV13cBiPbA42im3LmpLVshSui0I1zTeWYTvEHGgwYhGTJdMAMNQPzMRc1aBkVq0eEGJJsm0AWXTZC229bJ8qwTGg9DRHNpBuTlX7IiVWrk5ZcJ8Fszjy3VZcYXKLWrrzDKzUGDaQqtMcZnbLNcCsjYw24i4bb27PH/Fvgz7rlmOt0MY2Dw8wLg04Y+aF+hFnjEhZ7IxO1vg2gjA3gKulblvuzvazzInrHYV7HEA67E6WUKmp9Os0oXMl5ni5S3nuryTEMt18zsEUSvSKBCNvvA8NzUvMrNdZ3rNdrDcr3w/hv0aiU0KNOUYWTV4GAGUYDcAr4CcaxYSKdu846DrLmhfe+UWQPlHhOxp+D1uwMCQASZ5Y1ZnE+aYKLW3mfam8e5zH8/ILOMGbr8CJrzAvGpWVzfYy83eehuq11xRhpSL32naPTe7fdrnupACrTr+6wHHsIIC0fuMil57Y9KEERRSsICAEu4ewWZoSruHg9WkmCmSXgdsxKoQshnAtaoVbITauMdmmT3IUjz1bdozE9x22U4Og/BpNdHcYBge292n/KIOY8DPGlYNJA9hZTD3iOAL5R7xaFGFbWk4IYtZYEwuDzyaDysyUJg/wiDMGZ47bTJNp1QbsQ1b7q6mDQG/32vjG49FkMLSKkfb5/G2ChvxP2QcOxjjGjdnHTcUt/OpA0N7/dtEAau9dpffxyaufrSG3qNWjdvUBOUpWVCUBSgXRhFTi7fF32v/U8h7lG7EHFu3Wxo8cshmRluL6Y7IXAFtBrbFOqHF7uEO+CPRGFHEfcEAEkUtOCNzXZvbBIZ3c3X/ROodzVEw43g4OUATdNyfZt6jvfno6XcAeBaNekyN/hN6B+L3Zukw6xPYr2zJw6Eb5hZOnfXp9BajDzsEnpDxwoHZgDYLVLbv238KuLRsAmjcGsDxqGUAlVKNWDMhyzi3tSq1kFNJZjtCjtnM+wQbT4yqlcn2ALwkeyL3htKCWQQrbpfWQdk0ijZ8GBuQFbCZL9K5RZzg2/+MAepTarVaMUpPBpwlv5RlXQ5x2tpUHMf8gFDfXuYAGEUEDDgThwcHJNVC6x91tU2WDwgsBlxNnRyWHDy2T/aS/tlXe65zNki6N9uHZJArj/xT/N/0cHyEI+wZtEmh8x9gGudPSTes7tpp8Q+orQ2GaUWEQLiXB5SKaSOw/kkzU6um4mYwfM97Fef28TSTY8HV1cMMios2NLV3G84A5vYxTUHgUWrm+OVDDgvjQgrAAz/m+CUjfncb4yrsWyxFnxP2RSL3PszeMowWK2ahf2Jd9kCvH6StLeYidkyx32ZQEotaAvGuE7xxCC0kD9nWExqVVitT0+TstoXmK93vkqpriLBIhDXM2z1Esglw65V/Fm3vuGwgv8gtWGNKofN8nrm5ATvXhcggOJ+kc343REDDggbr7rKKcsElQGmbBZe+SBRXMFhdLIBRbv7V63+yLxEci56xc36ktaVkBDrJb9IAO1Uj9l4vgH3RWFxn2BtOx5Fdh9mpXN45bGq2L5HI4OyI8mLcOSgr2sRitTGFdIy39Rw1Lk4q36xdqqcpfQ8E4zZTzhR32mBqj8vidmk9Lou7pPS4LLob3SGAuO+O2bE5t1nz9f6zKf40tznwwMltuDEqDwqAmmVgoNSLUIEVkwdtlwlMkRjWCaDQmYILJBoDPXkJIhPSTmpjgQ6T2nPrDQPrtt5B+zq5hXhutTb62aJ7m0j0MWiXTbGutCfdNx3QpHXUxEvhgYcnDsSUj8fjlIuDF+kx8OcpP3jG0+eHz5+9eJEfTQ6fv9wy6EitpNPuu8T+/oDP92/8p7caJ+yNxLNw9sYfPo/YazyU3kuGUokosD6ivtMOxKPw/aPp8xE1hvZVH+WjEG37I/5He9GGtZO7LVlDub/brIoNNccX3A7XSDKVStp5FrKc6F2xkMCHXg+Qkw4C8nt8vMRwKR1rmQ9ygoX2UUxGpG+KwqwzAC473H0W3+PikSovaoEW3RNC22LA2pU1k/sSpZ/jQUSGlH2Vzu6uF7t17lFcGK1mLOy+hzz+lNUdlrk3yaBwrx2zeH/Kyh+6Poa92R47HB8dP32yRsXmWsGd6yE+Yu9YDRGV/PCgd1CKFQeFzLdlGtYqj6h9BThsOnrsqA4e37k52E55b5us8kc4gw38bRLZa2FtryP40r0e0NZk0Oz7ecHabB8pRx0v9EWnvIFqubYVN7R7+ztnE5BlrOYbLohujuB+GDSDDJ7Mx7D2Zp8fGt7eHRKXEGhHK4WKZrd4OvxOfe60A8GaYBCMPrFHoc+j9iaB0qzCmyrOxVY2epUJtzJ/4N05pzK/aL9jtElBxm5bWAUgbMcPhW3gmvgjyu0iFIdvGB193lng37AsPNqZGR2LmhCymrZQ46BxVCvoHjBHT5HE5iT5IOfsEWAOn1Fleu6YratKG8cEBUfFcnjCH8xRHIM/Ab33PPSg+KED2TMUg9OsbeVi0liX3a3g5R32ZWpQ9rJirQT5h2k2kcbNd+fyhs7Vp4y6N1vj4EGpbMIHgGRzbndM29SC3iWID8H78zGH42eHz1PB8codiOfpi6dwkB6+APFUHAC8OHq6xaTRadgdNqVFwdk76f6cYSpOUMUvR2OO2zW6uEhreD44DbOAMSJtEZuj5iCENRude5bUWDyfTJ+N83TCJ9P0mB+O0xfjl+P06PgAxuJlzifjF1skdTcrdGq55HP2C5hCqkZMKJdiSSK6CLdXbiehGFODsj6ebvIe2+t2NtdqbS1hDdFod6V3iy7XImk2l2prfWiv2Z13a9h7sGNkeAQ7Yt8AfmCqSbk5Xb37N/B1qGPSpLG997xVioy2WXvdcajXvQL+3m3FdG2xe/9K7y8xUGgu9P7XRgzXo+RTx2/cNKC/iAO5HiW/Nh7kpjH/7Ur+diU/4Uri7ffGep3i2CptXbo4TJuTyOavTIq0c5ferr660flIiXZfjSjoUiQsMOOg2npAPGAKzxhQTVEBPGSJmwQybpGpzsvN6dprVE2fxVesufvvC/If+4cShk9CPPHSaV/H2PDqgn9vgVLYWkGKkW337YxYbqFNk0TAtIKL19Ai6t/Ub+pX7cBfSLO6BEoqQgO/c8hLByqbXn5ALlKx8XFY/I9rVYC1fgQ5PmSjHNM4qAtpYfQEofvHTXJKu9dK+ZR6HE0cAd5yn3hRk3T95pmA21xXcMLOoX1j5+TCSAfn+HpNTFL4JU3GtlO3QFkAqciXkIFsD0X8fb+VV3XC3bXr2z7fQiY5sP1XSq/qpK8+nqb/3xz2EPs5cEEerAWw9m2PN+DnN9zExjWUomMU7NXH0+YtHG6tzqVfxzjvdJMaG+DlcbpGregpl7a2deTbdN4leGTZWSkV1Yt0aO94iZ9XMm1f4PnfQDDt/PwEYeCNcHS0m8SNxR11iXcHxwfjp+nBs/TwKV7/FTDldeH8Exrx9+vr76OY3fpFC8o3Def1jm8xrHloYHAj9Ma3Yh72aZj/7pdgBtL7fovXXza8pfIsPdr6lgo97ROcyWVqK+A/gNtlipqa6gUYIwXl2cgddF+k6ben9w06FqX70BeCd6AsOR60Pt6VbnxXbBRHdcP7YmhRIqlNyBtaa0awvr8fSdtv3YhQscKZmfe6ZGHdPDlJ9heH+42T2L/qWNjr/YEHppq+YJBrU6D1CyaFV9JblFRASWZlZUm/gVIP5sDTS/3BIH7GAW4gvJbmR0OHgJtoVvgZh24hrw0lsM+u4gbjVY6bnVc1CuHse7fVZ7QhfuGuadvoLkKMlo90GbghTzB84IFIpHQXmfHazTEBHQttRslnqo78GQ6ewgYG16MEbeOn1qp2lHFFB9uHsbbqH/o+X24Xd4/kH9Hd9J5c6tj2UYLk7IfpZzALmUNnjltXRE9w0Kqz+wKHgxaa4kCLtRE2dF25Ng5FjqGP0/71u0eWvQ16yGKVMnpCofO6jI/n/U942If7I6Dg6d9EruwTPr4SFr4vp8BFGr7+o12TKGHUqJKrDp3X/m5MNwZ1PVvUG8FV69b+Dmz/4oFt0G0Hl26/KrgkI0BG7yqY5LNkcdh58AwX4Ek/8O3Z5e9488o67Hd1hSHlV1NcX+PPf9SAO76z7+gcjPQvmZ1dYVUH3bFZH6p2F+PjT2GxPGEb4+QNQ4oPPahlxzcl4dWJXiDvL4/5OHo3eH/xoHqtXL381u9IGjG3kcJrL6z0Sy9QWY2d2x7oiiq3tW03mvj44fOXZJRMQrxeagq/DL9AL8Iv/KTHI1MM6PG3q6Tgalb7ZIOnif/8BzSY6bs= +sidebar_class_name: "post 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:write` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/post-v-1-employees-employee-id-work-addresses.ParamsDetails.json b/docs/api/post-v-1-employees-employee-id-work-addresses.ParamsDetails.json new file mode 100644 index 000000000..fc5537e46 --- /dev/null +++ b/docs/api/post-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/post-v-1-employees-employee-id-work-addresses.RequestSchema.json b/docs/api/post-v-1-employees-employee-id-work-addresses.RequestSchema.json new file mode 100644 index 000000000..c4778f69d --- /dev/null +++ b/docs/api/post-v-1-employees-employee-id-work-addresses.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"location_uuid":{"type":"string","description":"Reference to a company location","example":"6a119be7-b4b0-4e27-aaa0-89d5f2524635"},"effective_date":{"type":"string","format":"date","description":"Date the employee began working at the company location","example":"2023-05-15"}}}}},"required":true}} \ No newline at end of file diff --git a/docs/api/post-v-1-employees-employee-id-work-addresses.StatusCodes.json b/docs/api/post-v-1-employees-employee-id-work-addresses.StatusCodes.json new file mode 100644 index 000000000..cfb2b6b14 --- /dev/null +++ b/docs/api/post-v-1-employees-employee-id-work-addresses.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"201":{"description":"created","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"}}}},"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/post-v-1-employees-employee-id-work-addresses.api.mdx b/docs/api/post-v-1-employees-employee-id-work-addresses.api.mdx new file mode 100644 index 000000000..13dc2f984 --- /dev/null +++ b/docs/api/post-v-1-employees-employee-id-work-addresses.api.mdx @@ -0,0 +1,71 @@ +--- +id: post-v-1-employees-employee-id-work-addresses +title: "Create an employee work address" +description: "The work address of an employee describes when an employee began working at an associated company location." +sidebar_label: "Create an employee work address" +hide_title: true +hide_table_of_contents: true +api: eJztXFlzGzmS/ivY2ge3I1gSSVESpafV+NjWg9uKtnu8E25HCSxkkWhVAdUASjJbof++kTjq4iFSlmJnd+fBYZuF40MiL2QmcB/JEhQ1XIpLFp1HpdQmvh3FUJS5XALo+l8JZ/GdVDcJZUyB1qCjQcRAp4qX2D06jz4vgGAT4psQmREqSBiBuNYz0ORuAaLzaQZzKmxnLuaEGvxItZYppwYYSWVRUrEkuUwt1oPfxe9Cp7KEc3JdYz0vqKBzuI4GkaFzHZ1/jd6FCS5q1N8G0fd4XmkjYy4MzN3qY7MsAXtAMQPGgEWDiJZlu4ntWlJFCzCgcPj7SNACovOoRaRoEHEkRknNYi2Ffvvt8i1SxiygXn80iBT8WXEFLDo3qoJBpNMFFDQ6v48cskgbxcU8engY1NP+V/yfdh0XV5fx30FpnMRPvwDKQEWbxxlEIKoCVzwejo/j4Uk8OsYFMsholZvovP37Q38hb5EEBReg7ToYNRDPqAZGLq4uya3D0t7BO24WZCkrZRukNM8PyGVGhBRAuCalkrecARu4NrQsc+62+pUmXwsueFEV7bG//bQwptTnh4dMpvrA7udBKovDsH9xSZdK5rn9fkhLHvueXMz/3Q8Yt35+jTAqDewgevg2iDSkleJmaXf5jWO/izQFrS8qs4jOv357aDGS0nd0HnZOgS6lQFY7v4/GwxH+1aVeqgCJEg2iVAoDwmCT1poP/9DY7n518+TsD0hNhDPDd1qUuZtFVxZaog01lf2lqjjK88kE4Dhjp/ERzMbxZDg9iqfTozQ+O4azIxhNR2k6RVYI/Ou7sdPTo8nJKIunkymNJ0M6iqfZ8CyejQEm48kZO05Po0EUxDF0Oz06orMxzeKz49EQZ8viKRsP4+HZ6Ozk7OR0dDrJcLYsg9TwW0iQbxynDePhKD4aodTZT4GYfnei8+hoeno2HR+xyWSYHdGj8eiYjcZnND09So+nZycnyOtGAZhkFJ1HZ6en5ANVN5r8nVNWWZr5z+PoPLoozQE5O8a1p3aXoysubsjPPM9tQ4frlzfRIPqLlwhxenw6thtWCaOww2+fLlAYo1KhCjUcWnRfFTYFlH0U+TKsa1UvVIL/WQHhDIThGQfllATXHZ16gLLYJ+DqdKvDY8uOzlnVuXayWsXiRGEv6glmUuZAxaML+sTnAhehCfeLCDaBO43hRu6ai0wq+y2tlAJhLGRE0WOzx1ZrFayCDBSIFIiRbtCeCfGzrSVvVxqeNl9N5s3z1Ly9y/4FogTd6i2IUwgH5BO43f3aaDkyrziDPRUlZ1CU0oBIl68tdC4yqQpHMinIQt7hCisNblEZh5zZ1TTC9xj3P7RFMTT+2rQWVZ6jKVrp5UR1p+E3yMVKSyvdO7Sr5X4X0Q4WNKiIxrZ/dQqi2ftvg8hwk+OAwVeJv0h1E3uHJXp4wBEmw8mqGflFGvJeVmIvQ7JhCPK7IOR3gZyGaEGj0VagZaVSIEyCJkIaAt+5NgfkA70BoivleC4Yb3L59tAKA9fkluacHaAn1jNcbVqAUlI5t6qjRP3vDa2pUnSJro2BQq8zhyujJjeAHVJqYC7VcsMcttWj4vephNQps7sF+DXb7kSmaaX0Afm8LDn6NEsnFDewbPS413fGKD6rDBzWHiRRkFvfKGgMHNKKUo16D2g4ArZFxeBGIlZt+KHCJmmPfK5kVXIx14QKRlIqyAys+4NoZhXPGUlRVRS+/YIKlqNS4cK5aC3H2GIuQGs638EYXQUgDAzluSZ0JivTImpM5iBANeT0QweUulIZTR1SPEMIhsCRck5Wuq6RkCbJrJC0GOtrZ/8jz/FtfjlvdWwtLtogIHfUyYftgB4kAgmC/Ys0sRWy+B1OGn90XOslezxeFctKlEqiR0dnORBkJLN8upD/1hntnR0tiDuSly7JgpYlCHcuw52YSbZETrJb7ddLcHrKhWchTXSVLgjV5JoLK+5JzeTJLc0ruB4Qb9HDCJndcFaB37u6Z30KvW6ZsndumjduTzjoPW2ZhRmndffXziJas1ZIBYEDD34X/1JU/y8UFR4564m4JtfCynHi9vF60HKpyB3P88DyhBLXklz7psRv0tKdbJ2IesH4p9GHiMJQRs3aI2QXxpsg3ApyuKXO/aY4pmeQpZdkr/G4IFam0S904RynkWY5HJD3UhGvhAedISw+S6pr93eCqK7t3oZf0EO6duSfNc4F+hJSwMfMau/taymq3PAyaE5uQ1UdwQs/rwpb+LKHSHfn1lzM2zqbMsbxE82vWjM5T3HN3I4gj3PNL7SAOorkKGoWtM02qVQuEsE0MdIdbBoC73CsWTmPhvOZG8YdYaz2zpQstnjydbuqTIzc3rCj59Y16Ln2q01ahveD5/74CzeL+KOA2Bm/6GFzqw+ed1xT3BoMuP1rz//37zmOtNFgd+nwBZWPFPnSHXgwiLHFbByQS2ODmFJrji6WkWRBb4HUeiiHW8htPNybkWAoarUSpVylVU7VTw5ux1V8HbVXuKZBtMbxnVFxk9DUHlwTBjkYSCqRVYIBS0q6LEAYvcUpxnBu1yNecdY6nvH7SjAu5h/ALCQjC6pJmI3Us9k96AC7BcWzZcKFZd0UkZZS82dF9g90A3BW4mdFy4ne+gyInZ8DOyBXOVANJF1AeuOcFPRYPRxCC+yoDzYvgeYYCFgmYcQXXQCS109IZgCiWccagAXXqKESJSuDYrPlIORaJKIqZjZ7sAZiz8nvAP3V9SeuP8pEMLsel+eEJJUi43NdQ6t9zb2ottq7DebCENxSQzDH0DizRaVN27FYDyysNqPaBGlJcl5wswXhmsZ7k/A9IvZjEDsG0QtZ5QwxU0/ZGnNSguKSNXhBsDoovAFl3WQttvW0fCeYiyA3kmNPUGZBBTkihRRmodEnzCpTKXD4fMg14YJV2qhloiHHuLUUiaA81UkqGSSNY7YRcdN6f3r+gn0J9l3Djrsh9NO8PMDAmvBnRXO0IieE8Tmv1c4WuDoA0DvA1Tx1bfdH+4mnFqteBTvxYB1WwwtIZJYlpcx5ukwwZbnbXhdPImKxbn/7ICphJQpYLS80TVVF80Rtl5lOsz0094XrR7BfTbFZjqocPasaD7EAOegNwEuwxjXxgZRt1rHXdR+0b5xwM7DZGYTsxnBnXI+B4AREZlmI6mzCXOfld9n2uvH+ex/i5ppQBbtzwIzmVKSQVOUj+nKztd6G6g0VNiJI2R92291sevu2L2TOGWp1/OMAB7fCOqLP6RX5pHbtRliXgngEaIH85m+GhhHSF4NVpxysJ70O2ICU3mWz6XQ08xuh1uaxZrMXYcVL16ZJ/uGxS7diGBafFDNJFbrhdf3HM9IvyDA6/KSeqik1sRBWFvOMCD7b2COmfIU/lnLRiQJjcLln0ZxbkYDA+BE6YUbR1EiVSJtY24it33J/Ma0HcOe9xr9xWJgVWMvlqPsc3kZgA/6X9GN7a1xj5rShyvrtNDOg7Fl/Fy9gtdf+9Luq/epXa8Z71YhxE5qwcUriBeUWhPGrCKHFXfF32v8Q8s5Ij2IOrZsjDaYckrmSWmO4I0wuwB4Gtvk6vsX+7g7YM0LtUYRzQQ+S9VpwRxayUrs4hk8zdT/j6C3JETCnWN3RQ+NlPEU7mD+jvrly47cAuClq8ciU/AtE4nE8q6bDqI+ffuVI7pNuGFu4NNqF0xuMzu1gmCGjuQG1AW3iR9l+bv8h4FyTGaByqwGHVEsPaigRQp/Kg61EIRnPuFXbAXKIZj4n2JAxKlc22wFwlOyQ3ClKDerWa3G91AaKulHQ4X3fwGoBnbiylx38BNf+RxRQd6RGqgWx4UmPs6DfsWixj1NXqqS45heE+u57CoBehMeAOzEaDi1VcylvqnIbLV8QWHC46jpfrD/5Sb8+iLq5ryav87UXdK+PD1EvVh7mj/G/8Wh8ZLP6bYU2y2V6A6o2/jbohvVSezF/b7S1zrDlCO8Id+KAXBCpGCi0T6oSQTz6y3dzr+Lcvp56czSYqnyZRVHWuKb6acvpwdy+pgwYplITQ7+/5LLQL7QOuJ+PGPqd2PmetsZV2DuwoosJuyKRZ19mhw2DxgpR6B/gyw7o9YvUlcZYxJ4h9l0WxbGoxQ/eNoKPLqGB5CDramZXJcXK1tQxu22u+Ur3p4Tq6kFIGITUkzdniGgT4MYq/yjaTrqsR78wm9fGNoRO00ViFgr0QuYsAW98olb+ro/ALgtqrPvTKtAFWcCGbW4pz6lP5qHHn98CsbH5izc/k88BHAmWsZU/klLbYAQayS9cAbkUA/JB3gL5LLHYUpG31KYj2wazVQu8t9tUH19u6zsgndyRjYtRY6Ao7SEW63etS0doU89RaVsFLoisTCyz2H73A4ZjJp8LaqTC0B7l+W5hPcrzp4T0KM/bB90+gHDuDtGxBdVJ/fX5oykum1snPHBz69mILQ/ygGo2UFDgjtvUeQgeNF1mkOFgWCeARCcC7nDQ4Ojx78ASxvWsUhpsMqnJW29YWLv1HtLXii2EvNVa72eL7G0aYodiyrct0L3yycELL48NWUbH43FM2XAaT4CexnR4QuPT0enJdJoezUanZ1sWHUYrbLb7Kb6/S/C5/rX9dFrjnLzlmAsnb13yeUDeYFL6IOpTJaDw136ejML1D6rPedTo2pddlK+8t+1S/K8Ogg77nyqxHUQZF1wvEh/lROuKhQTO9XqBmLQnkDvjG4mSbUgzeS8mWF9bsUM/5oXV1yf23sUPyDxcpHnFUKO7gcJFkxWeSX0p8Q/NYQfpj+yqdPY3vdgNSeujxHdKijnxp+/+HHhdY382dyoZBJ61QxTvL166pOtPcDA/IKPx0eT49RoRW0gBT66HuMLeoRoiCPlo2EmUYsVBztNtkYa1wsMqVwEOm1KPLdHB9J1ZgG6V9zbBKpfC6R3gdwlkr4W1vY7gc/u6SFOTYXff7QvWZjtPOch4Lu9a5Q3G3wHaWNzQnO2fHE3AKUM1X58h2jGC55mgXqS3ZM6H1Y/bfN9wd3NoZ/GOdtBSKGh6i6XD77bPk04gWBMMjNhP5JXv86q5SSAkKfEisTGhlQ5WZUY1T1/4dE5tmV/Q38HbtE7GfkdYAcB0yw75Y+Aa/yPQ7c4Xh29Ynf28N8G/YFl40DNzmxZV3mVVTaHGsDZUK+heMEZvPYnNQfJezNkhwBg+sZXpqSG6KkupDGHWOcqX/Qy/V0dhDS4D+uxx6F7xQwuym5D1slnbysW40iZ5WsHLe+xLRK/sZUVbMWsfsmTGlX2OYM9Z3tq8ekZs9/po7C2ou55rHUCrc3ZL09a1oE9x4sM98zGFycnoNGaUnsUTYKfx9BiG8WgK7JgNAaZHx1tUms2GPeFQmueUvOfmrzmG4pit+KWozPG4RlBgLQ8vetkwDegj2iNinWr2RFhz0HlmSo3Z6Sw7GafxjM6yeEJH43g6PhvHR5MhjNlZSmfj6RZKPU0LXWrK6YL8DVTORU0mpEu+tCS687dXdqNQ8KlBaOdP13GP7XU7m2u1tpawem+0zentosu1SOrDpdhaH9pp9uTTGvbunRgJpmAH5AvADYaahFnYq3f/ALoOdQia1Lr3mY9KYaJt2l62DGr3tmTntmK8odg93KoGbf4m2TIw/5Oe0ujeyNjzsYFf2/f+6corA5hUcjX5+BgHHY3OZnAazyazYTyB8WlMKR3G0zN2nI2Px5MTr7Yefd4h5CYjX8fbe5xll6ceVl9E6GAdD8dH8fDYPv7SkLt5oMZeN9Al0BugehnbW3qtfN5F65Ggdjs0WLG8BaU4g/olFLzwHu67IwgDQlvPFrnR8eHGJ3vsPZPq8ad7UNF2h3KPttT93aqaRv3F1Q3XLHJ9v+5im/6ri8a3ZHwoyb3BhGyJDwidR4e3o8M6QXZ433pp6OFw5T0mm+z2UlypHG2dvzBLS+7uy8YMCntpdpVtoJC97XLjxS5ihp9xoRsGXjvmlbLRsU1jlvi5/dzOJ5RSJ4hrHt2pBQEnD28b2WdJgCrr8PfvNNohYnv9htDKLPDMFXJLg+iTLQj4kRncCBsmeBhEqH1+bfTUuyBfK3pmN+Ww/u2cWlDx+O6yz0GZ2veh8N2kqP2UTutlp0GEDznpj9knULc8hdbONter7Y3UQ9vwkOFSUWHG9v+YKtC+68otKshTWVjNaHG80uSdF1ESinbwSScm0wotm6XHv/l77tRFRPxLV2/DrORXvIvsj70uu4Cs6b/+R8OJ9mkeqU1BRWucN65UtP30WPtZlv4SWlbln+p1M8ejBr6bwzKn3DKzFct7rza+Rrej1rtOuLDz7iNlPd3xDctmtcGe9/do9H9T+cMD/vxnBWj3v35DBaZspY/VL4xbC82i84zmuv8CUJtyP/3qTcdrsuUBtLWLCrf0xLKlPyN/ZbDz7Jqr/HWvnu0H7//0W2Yb6Orot/79uJrMjVV744gVf+5Y3FU/q+mBSrU0W9u2bd7Vx0+fo0E0875cIa13oOgd3tymd27TQ7zr/N79dh/lVMwr53i6MVHqaVeT15rb/6N1fbzLVvf3rsVneQPi4aHmMoP/t07qw38DN6sdnA== +sidebar_class_name: "post 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 describes when an employee began working at an associated company location. + +scope: `employees:manage` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/post-v-1-employees-employee-uuid-section-603-high-earner-statuses.ParamsDetails.json b/docs/api/post-v-1-employees-employee-uuid-section-603-high-earner-statuses.ParamsDetails.json new file mode 100644 index 000000000..2e582e14d --- /dev/null +++ b/docs/api/post-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/post-v-1-employees-employee-uuid-section-603-high-earner-statuses.RequestSchema.json b/docs/api/post-v-1-employees-employee-uuid-section-603-high-earner-statuses.RequestSchema.json new file mode 100644 index 000000000..89447ad52 --- /dev/null +++ b/docs/api/post-v-1-employees-employee-uuid-section-603-high-earner-statuses.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","description":"Request body for creating an employee's Section 603 high earner status","properties":{"effective_year":{"type":"integer","description":"The year for which this high earner status applies","example":2026},"is_high_earner":{"type":"boolean","description":"Whether the employee is classified as a high earner for Section 603 purposes","example":true}},"required":["effective_year","is_high_earner"],"title":"Employee-Section603-High-Earner-Status-Create-Request"}}},"required":true}} \ No newline at end of file diff --git a/docs/api/post-v-1-employees-employee-uuid-section-603-high-earner-statuses.StatusCodes.json b/docs/api/post-v-1-employees-employee-uuid-section-603-high-earner-statuses.StatusCodes.json new file mode 100644 index 000000000..b697e132b --- /dev/null +++ b/docs/api/post-v-1-employees-employee-uuid-section-603-high-earner-statuses.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"201":{"description":"created","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","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"}}}},"409":{"description":"conflict - record already 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"}}}},"422":{"description":"unprocessable entity - invalid is_high_earner","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/post-v-1-employees-employee-uuid-section-603-high-earner-statuses.api.mdx b/docs/api/post-v-1-employees-employee-uuid-section-603-high-earner-statuses.api.mdx new file mode 100644 index 000000000..0866843f0 --- /dev/null +++ b/docs/api/post-v-1-employees-employee-uuid-section-603-high-earner-statuses.api.mdx @@ -0,0 +1,74 @@ +--- +id: post-v-1-employees-employee-uuid-section-603-high-earner-statuses +title: "Create a Section 603 high earner status" +description: "Create a Section 603 high earner status for an employee for a specific year." +sidebar_label: "Create a Section 603 high earner status" +hide_title: true +hide_table_of_contents: true +api: eJztPV1z2ziSfwXHfcikSpRlxY4zfjqP4+z4IRNXnOzsVpKiIaIlYkIBHAC0o3H5v291A6Coz1iOfbdXx4epTGyg0Wj090d4m+gKDHdSq3ORHCeVti693k9hWpV6BmCb/8vqWorUQo5rXw5eZIWcFBlwo8Bk1nFXW7BJLxFgcyMrXJUcJ6cGuAPG2aXfyF4OXjDcyfxO5neysTaMKxYP839ntoJcjmXOZsBN/7P6rNpg9Ji5Atjl2enH92ds2B+wk9wxXlWlBMucbqBZxicg2OGAacN0KcCwm0JbYJWR2qQInL05Pz1hN3wClsG3HEAQ7PP3l8wVBmyhS9H/rD4UYKEN1wDLS26tHEsQjNv23WyPcUVwpGE5d3mR1hXLtXJGjmq8BmFZGUgd/8YMOGlgCsqxESgYS2fZtLb4NybAyonizp9Bj4RbFmARfWyuKzhmV82rRVDHN0Y6uEp6ieMTmxx/Ss4irX8JS5IvveRbOqmt06lUDiaeL1I3qwA3wHQEQoBIegmvqvYS2lpxw6fgwCD020TxKSTHyQL7JL1EIldU3BUrrPKhAPbx4/nr+K5xZ9JLDPxZSwMiOXamhl5i8wKmPDm+TTxuiXVGqklyd9drDv5n+ne6ycnFefoPMBYPCccXwAWYZDOcXgKqnuKdh4PhYTp4me4f4hUFjHlduuS4/fO75Yu8RiJMpUImLIAJ7iAdcQuCnVycs2uPC+PW6lzSk95IV7CZrg0tyHlZ9tn5mCmtgEnLKqOvpQDR82uIwXOi+zPLPk2lktN62ob95afCucoe7+0Jnds+vWg/19O9+IJpxWdGlyX9fo9XMg07pZr8LQBMWz9+jmjUFkQ/ufvSSyzktZFuRu98qqcVV7OTPAdrT2pXJMefvty1WMnYGz6JL2fAVlqhpji+TYaDffxjkXo5aQxkFeRuUA6XtO6894fFdberj6dHf0Du1vKVgcqABeUIBHJYS9k8s/fSTkvaiH1fFQW2tY+tiFBrFPwafki13EulJPiM8I1Pq9I/ma3pnYPCx59INBvjgyOe7w9G6eGrPE8PXhwNU3748igdwGA4GuYvxMHRzyhV4zES7RoyvGpyPBwMX/YSadu2JDke89LC3V0vqQwaJyehOWhVUFffulbyzxqYFKAcqmXTvM72RzaQayNI23DxTpUzz7N3q2g3WJAKJE2yigY9JjLOTSHzgrlC2nWnBnO17thlusRjPyUjrUvgqM9UXZZeM7XP/70AV4BZUKMowoumii/gg6i2KVTVptIWbJ+dcoU2CI9i0pMyIF9wy5R2bAbIWKCYiKpP9FdvdNdW5J8SMgdLpF259Jde4qQrkdjRXqWXjQ+S/ionRXpGS9NLz5J3d3jQweBgVbX8ph17o2u1k3LZAIJ9VoyRQ0BiDhYFyYDVtcmBCQ2eMvBNWtdnb/lXYLY2JLKNQmfnr/fI4knLrnkpiWjLyqxNMjBGG29sF0Qj/HzOmNwYPkNqOpjadSpyBWr2FXBDzh1MtJltOINWfVcKL72iBMtuCgh3pu1M53ltbJ99mFUS7dzMy8VXmM3l1VtN7rwagr3Gr2AGStJXTs9B9tH+NljvgBpCwLWoHTwkho8ZQcVHsgHzidF1JdXEkk+Xe5FAk4jYjGpZCpajuZuG9QVXopRqwqTyZrvlLhHOU7CWT+D7KF9ERAQ4LkvL+EjXrkXUlE1AgZmTM4COWNrajHnuMUWzpwQijpTzsrKo4ZV22ZiEpMVYnxbePwkc3+aX49bG1uWSDQJyEzQHbUCvAhGJkv6bdikJWXqGh6bvPNdGyf55jdOg1biUuWNpUOOMl6h9Zl4A7cMF/qOqjEaTx0clsDPlpJtF0UdS8xkreFWBQl5X9CojLWbIVfTs4e5kV7lUgZ0ss3VeoBK+kopEP2sYPrvmZQ1XPfQR3Jx6bEyPL2oI79jsbCK4K3RKvLh9OvPHnPr3kWB3dAoJzTRvtj9nk1oKH5hNtYHIjf3PqlNa/y+UFoYkzUHSsitFMp35d7zqEXL+rdiNLMvI8owzv5JdhaUsPNLMRz5AQhUE4z9GNyIWjgvu7hFinEbhNlDCNVcOgz6OMAODzIIkB+0nFSOZRl+L1EbQSKMS+uyNNiwo5N4CCMKPSHXl/8wQqyt62/gTjLKvPPlHc0cD/Qqt4N2YNPn2u0zr0smqBH9WdE1bghd/vCps8Tc7iPTi2VaqSTwZt3EhJP6Klxetk3wkueZsT5Dvc81vfApNlsFT1BW8zTa5Nj5SFRhHETe0CPz9Ez6uxCDjoM09GILotffY6Gnbt28gete+WVdXmdPbFy7ouXUL0G2HbUtaRvht4P70d+mK9J2C1Bu/5G7zqreBd/xSfBpMyHRv/n//zRHSRoO9FHyi8tGqDL4XhoxbzEafnTtKcmlrJbpYMbfR6KESrqG0+HbBjERD0aiVJJcmr0tufvLoLriNz5P2DdcsSNY4wSOuvmY8z3WtXCagBAdZrca1EiCyis8wlWK3OMiY7lv0jlectQUv+U2thFSTt+AKLSisjqex5jR6gwXErsHI8SyTilg3R0wrbeWjYvYvdAPwVBZORcuJnvsIGJ0vQfTZRQncAssLyL96JwU91oAO41PcaPubrxC89SxCfNILIHljeEBZi+YeaxCcSosaKjO6dig2W4IivyJT9XREOaE1KC45+QuIvvf7md+PMhHNbsArcEKGwY6c2Aa1xtfciWqru9vInDiGT+oY5qDnzmysR0THYj1i8bZjbl2UlqyUU+m2YLhm8c4kfIMYBxiMYDBb6LoUiDMPlG1wziowUos5vqBEJoK23IBls2QtbutpeaYEFQFakkMRlCu4Yi/YVCtXWPQJx7WrDXj8cp9Wz6QStXVmllkofd4rU1zmNsu1gGzumG3EeL56d3r+hnsZ7l3DjvfDMBzz9AhG1oQ/a16iFXnJhJzIRu1sQddGBOw90LUy92t3x/ZS5oSrXUX2ICDrcXVyCpkej7NKlzKfZVjSut9bTx9ExOm6911GolYkUSAaeeF5bmpeZma7zCws20Fzn/h9DPc1FBuVqMrRs2rwYYSgBLsB8QrIuGYhkbLNOi5t3QXbUy/cAjjmsxFlD8PHuAEHhgcwPR7HrM4mnJuK0X2evVm8+9ufLZSy780BI15ylUNWV9/Rl5ut9TassOKAxOTiD3p2f5rd/uyFLqVArY7/eYSjWxGSgI/nVISiZ+NGFL6c4jFACxQefzNqmC19MrSa8gN50usQ67EquGy+QUMr2IhqYx4bNnsSVjz3a+YFKwy7bCuHQfhpNdLcoBve9Ac8Iv2iDKPDz5qj5q0IhMLKZR4Rgw+Ue5SWkj0Ulkq1kAXG5PKSRfNuRQYK80cZFXB57rTJNNXeNuK2vHJ3MW0A+Hhv7t94XAQJLHE56j6P71xgI/5P6ccu3XGNmbOOG/Lb+diBoVj/Pl7A6q7d6XfR+NXP1sB7NhfjeWqC8pQsCMo1KBduEVOL98V/Yf0PYb4A6bs4x9XzkAZLDtnEaGsx3REPV0DBwDZfJ6zY3d0BihEajyLGBUsokdeCL1Lo2tzHMXyYqfsVobckR8GEYz18CZsg4znawfIR9c2Fh99CwB/RiMfY6L9AZQGPR9V0mPUJx6+E5KHohrmFc2xWwXT6HEfvdgiskPHSgdmAbRagbI/bfwhxadkIULk1CMdSyxKqlGqUlhzAgGytplrIsSS1HVGO2czHRDZWjKqVx/YIeEoukNwrSgvmOmhxO7MOps2iqMOXfQPSAjYbazPl26L9xfU/ooAWIc2lWjFKTwY8p/wbNrUt42lrU3G88xOiekZdXCBYwAFfYn8wIKqWWn+tq220fELEosPVNIJiL8pP9nk/Wax9zes6n5aS7k34kCzlyuP5KTUN7w9fUIW/rdBGpc6/gmmMPyXdpBrrnZh/CdpaZ5g4IjjCC3lAqZg22IPnNDO1iuKxfH1/9iqe2+/TPI4FV1dPcykuRKu18EHXWUJz+53GILCUmjn+7SmvhX4hOeDhPIZ9iXTew+64ivY9WNHnhH2TyKNfc4ENo8aKWegf4MsFpNdf0tYWcxE7ptjvcymJTS0BeNsIfvcKc5Q8yrYe0a20WnmaJme3zTVf2f6QVF0DhEUgrDl8HkMkmxCeW+UfxXahXLZEv3ha0MaUQud5kTWdwhkE45O06nfLGNC1oMF1d1pFuiALUNrmmsuSh2IeevzlNTDKzZ+c/so+NG3M0TK26kcau6Gx5qDH7HdpgJ2rHnurr4F90Nh4adhrTuXItsEMXeoPcpua8OW6mRFYqB1RXow7B9OKgling0vH+Lyfo0bmRJdD1y7V45R+HwDGMJOarbXB1B6X5f3SelyWD0npcVm2A91lBGLcHbNjBbdZ89vHz6b4am5T8MDHbU5j1B4UEGrYwMBUX4cOrJg8mG8ZwRiBYZ8AEp0puEGg0dGT30BkQtpRbSy1vEfR2Xyx9uodpK+VW4h1q7XezxbZ2wTiHo2Vr1tIL7VS9p74emIgxnw4HKZcDF6lB8CPUj54ydOj/aOXr17lL0b7Rz9vuXSENqVq90N8f1/g8/sb++m1xjF7LbEWzl774nOPnWJRup8sUyViESYZHoxFaIUPqs971OjaV4tYPgveti/xP+tHHfa/1W7bS8ZSSVtkIcuJ1hUbCbzr9QQ56UAgH+PjcN436dj88KWcYKm9F5MR6O95YdYZAJft7/6Kb5F5pMrLWqBG94BQtxiwdoVnct+i9GNnEJBlyL5LZ3fTi9uQtCFLfGO0mrAQfS+f8ZesHsDmXiWDwlg7ZvH+kpUvuv4E/Umf7Q9fHBw+XyNihVbw4H6IC9wduyGikO8PFgqlse97V+ERte8Ah02lx5boYPnO0dxng61dai9fCuDvk8hei9b2PoIP7dGReU8Gvb5/F+zN9p5ylPFS37TaG6iXa1tzwzy2f3A2AY+M3XzLDNHOETzOAc0lgyXzPqz9vs0PC+9vDumU4GhHLYWCZrdYOvw97XlQBEKTYYLRr9izsOfZfJJAaVbhtJVzcZWNVmXErcyfODrn1OYX9Xf0NsnJ2C2EVQDCtuxQCAPX+B+RbjehOXzD7ejXOxP8d2wLj3pmQmVRE1xWM2/UGDSGagW7J8zRkyexOUm+lHP2GGAOn1Fneu6YratKG8cEOUflbLnCH9RRvIOvgD56Hnqp+aGFsj9QLFWztrWLSWNd9rCGlze4l6mltpcVbSXIPoyzkTQ0rr7jKa+prj5mtL0JjYMFpbYJ7wCSzrlfmbbpBX2IEx+c96Mhh4OX+0ep4Pzn9ADEUfrqEAbp/isQh2IA8OrF4RaVRtWwBwSlZcnZG+n+mmAqTlDHL0dljuEajTsTDxdL1TAL6CNSiNiUmgMR1gQ6j0ypoTgajV8O83TER+P0gO8P01fDn4fpi4MBDMXPOR8NX22h1MO00LnlkhfsFzClVA2ZkC7ljEh0E6ZX7keh6FODst6fbvIe2/t2NvdqbW1hDd5om9PbTZdrMWmCS7W1P3Rh2YOjNdy9FDEyLMH22O8AXzHVpFxBo3f/wnnkVaxj0qTRvY8cKsWDtml73TKoi5OTC9OK6YZmdxyiHA5XRx3rhVHHMCSRNs7l0mR2N1HZTVR2E5XdRGU3UdlNVHbTdd1EZffm3URlN1HZTVR2E5XdRGU3UdlNVHYTld1EZTdR2U1UdhOV3URlN1HZTVR2E5XdRGU3UdlNVHYTld1EZTdR2U1UdhOV3URlN1HZTVR2E5XdRGU3UdlNVHYTld1EZTdR2U1UdhOV3URlN1HZTVRu6GnpJiq7icpuorKbqOwmKruJym6ispuo/M+YqAyftgXrftFiFpn/ET5e/b7VpEJBMHUXhdzYvT9gnawMevyPfNE49P/77zxv+aBx63vGT/cd4zY+6z5H/OhfIk5PyeNJwxMmd4snxm9Lf3OgLDnOyOyezeOn01vDgmmIIbwgIr5hyBQHfKqqvdQmpMcXQfmvsDf76fQvpK8xY3Sc4AfAkU04fsA92bve32vqYHu3C3XRuz3bXLtNoZD3IUpTmTvIb21KtHJhVJZX0k/KpgKmNC678uqvYarpw+O2Av4VuJ2lHl7qc2X4a7zgBsBrYV4Yyottglnhr9uftr9E+fSysuYD9w3j4uF4XVqNjAzcrJGeACKlwRvGa1dgtBWrSr3kkloBfuQED2HDAXe9BPXO+7mGOouSsKoK1n+TPX6SPJSToyT8HQnOTi7OkbNizSAZDoaH6eBlun+Ig8xgpvbd+BLMtcyh9WDzeWkaMd2jhXsCb4CqKqW/Y+7fhq0r2gHKXE+pJEJ4PLPsLAgFi104JxfnTOi8RlNF1PivMLjOfYqD3F1kuXAqe4/DxSGO9eUC5Ljw2/+eMxh9n15bN+WqBceLPOPf18cLV2mZi/uCID3XsgH+78z6weaclHX/s/qs2mDCtN7l2enH92ds2B+wk9xFhU0pxHnz8gQEOxyg3dYlxp03BRaSKiO1SckSvDk/PSHfyTJfEyPY5+8vWVMs69MH0i204RpYUt+tu9keOWSuAGlwxC0v0rryfhi6IVQodJpVBlKsYBtwIT5mI1Awlm7erSLA1zf8GfhStGUBFtHH5rqCY3bV6LgI6vjGSAdX81l8B9/cXlVySTJL2uc2KMxPyfU+Mcy8V/d4semEVMtWrfkFW4WtQ2C3t+jofDTl3R3++M8a0Nf59AXVt6HuJtKsQpJXIpLjMS8tbGGqn94Hu/Ocptvpo/NxdHPecLL2nnEyUc3m1iNJwpjkYsdM6HcGLlBl7ITga0y8TaUKE/kYzKVIA0ESHFQL49bqXNKjUhKRJupxAf4jAjROr9ADlfMe555f03LBnln2aSoV9Q21YO/4jznwSqZhp1STvwWAaevHzxEN/JcB+pso6yn4z5SUV3pycZ7+o6mYNoSeW/JTT6z0w4IjsOpdznegQanc1rVtF+Di3eWHpJeMggc7xfkhjFtucF6d3/hnj1m+41v/s9uk5GpSe3fbw0TVyBetWGO1wv+0huYXGev21q/4oL+Curtr+Mzh38k1v/s3fjcnoA== +sidebar_class_name: "post 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"; + + + + + + + + + + +Create 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:write` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/post-v-1-employees.ParamsDetails.json b/docs/api/post-v-1-employees.ParamsDetails.json new file mode 100644 index 000000000..a85ea2c41 --- /dev/null +++ b/docs/api/post-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":"company_id","in":"path","required":true,"description":"Company ID","schema":{"type":"string"}}]} \ No newline at end of file diff --git a/docs/api/post-v-1-employees.RequestSchema.json b/docs/api/post-v-1-employees.RequestSchema.json new file mode 100644 index 000000000..e5e7c14e4 --- /dev/null +++ b/docs/api/post-v-1-employees.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","required":["first_name","last_name"],"properties":{"first_name":{"type":"string"},"middle_initial":{"type":"string"},"last_name":{"type":"string"},"email":{"type":["string","null"],"format":"email","description":"The employee's personal email address. Required if self_onboarding is true."},"work_email":{"type":"string","format":"email","description":"The employee's work email address."},"date_of_birth":{"type":"string","format":"date"},"ssn":{"type":"string","pattern":"[0-9]{9}"},"preferred_first_name":{"type":"string"},"self_onboarding":{"type":"boolean","description":"If true, employee is expected to self-onboard. If false, payroll admin is expected to enter in the employee's onboarding information"}}}}}}} \ No newline at end of file diff --git a/docs/api/post-v-1-employees.StatusCodes.json b/docs/api/post-v-1-employees.StatusCodes.json new file mode 100644 index 000000000..218d8c0c0 --- /dev/null +++ b/docs/api/post-v-1-employees.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"201":{"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"}}}},"422":{"description":"invalid attributes","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/post-v-1-employees.api.mdx b/docs/api/post-v-1-employees.api.mdx new file mode 100644 index 000000000..ecf458f17 --- /dev/null +++ b/docs/api/post-v-1-employees.api.mdx @@ -0,0 +1,71 @@ +--- +id: post-v-1-employees +title: "Create an employee" +description: "Create an employee." +sidebar_label: "Create an employee" +hide_title: true +hide_table_of_contents: true +api: eJztfe2S2ziS4KvgOHdRdpyoor6l+nExNf6Yqb3ttqPLPb1zbgcLJEAJbYrQEGTJGkdF3Gvc692TXGQCIEGKUknl8u7N7PxyWQQTiQSQ35n86skNz2khZHbDvCtvI1Xh3w98vt6kcse58noe4yrOxQbGeFfeq5zTghOaETum/2v2a6ZiueFX5K568WpNM7rkd17PK+hSeVcfvTcV0E8974u/LFUhfZEVfKkx8IvdhsNAvo44Y5x5PY9uNu4QfFXxuMxFsfOuPn71Xsn1hma76zjmSl2Xxcq7+vjp4VPP29CcrnnBc4XjMrrm3pX3b/4fcdrr9zf+n3muYFE9T8DKVpwynns9T8Urvqbe1VdPI+SpIhfZ0ut5PCvXgOAwGE78YOoPJoAP4wkt08K7cn9/aBPuNeCyFhlXpFhxwmjB/Ygqzsj1+xtyr3EhVCkZC1pwRraiWJGdLHMcENM07ZObhGQy40QossnlvWCc9fQYutmkIkYiXSjycS0ysS7XLuxPL1ZFsVFXl5dMxqqP5O/Hcn1pye1v6C6XaYrPL+lG+OZNkS1/ZwD6zs8vAY1Scdb3HnoVhWO9IaFglrAbWqy8npfzv5Yi58y7KvKS750r/Rq5eX1kBx4enJOTqy1dWmA5VxuZKa7gpWEwgH+aE6gSj0hSpl7Pi2VW8KyAUQ7hLn9TMPSrO78oUkDAnl04zholGf3G42LvfnxYcZLzTc4VzwqESmTiXhciMoJnsO/BWvgXut6kGm+DYqgKWpT4S1kKuJZsNpwP2WLh02ga+eNhMvEjOp74yZhOZwGfz6d07vW8ROSqCM0+/EHSYuf1vLVgLOWhyEQhaOpdZWWa9ryU1iP/p1Rwz/maitS78j5zntF+wrkqfv9Z8FXWj2W//IxU01trsOKLYBzHs4U/H8ypP2Z07i/YaOYHEQ/ofJowhlhpRpCbt/T05gR5Vx6dxDweJIM4GIwmCY9GfDaN6ZTTUTyeDmZTmLbMc54VoabgGv60FPKSMk3DQqxhY2QWSZozkS3r585vgH3KC2Qrm5wnPM85C12aadwY39C8wGlclO3+hbFkQLXxNAlGgN6GapzWvFhJoMtrkfO4IK/5RiqhT4iFaIFpVgDX3LtKaKp4zyu2MtzwPMblrWjOVzIFfmSfm5XU92clVCFzEcOmmjErqkKlMjvCWTyTcQkIqDCWWSKW9eHSCIlFNcRAe+h5v8lIM0+z4VE8n02SBfMpiyf+OEim/mLBIp+z+XgWRIwOJ4nnbu58OopiFgziySCJEzocT+dsGozjJOHxbDwYeQ5Zzzvq9kzApvJM4UWzIIY8HkzHLPDnwTzyx+Np7M8Hw8Cfx0k0CYLFeMICZ9/KTADv/gunOZ4Msab5zpLwsV2Bg8bDbRzG8p4jc9P0rH9PqVLmzJi9NyzFXCiLfYPSJy7hicSrN4hFsyiJxgs6ToL5YjQeDeNoMh2OBoMoiSlbHCRTkipa37I3X/h6Ayedst9KVYSJzEMjMMItXfKKXO6PsOBPeMjC884Xh+NTiHseghB1xG4A+Ob6t3kQBEE/CDwQGe3f4PLk7utj8zoM5qlYiijl4YYKhrwllEmikbX31uzXp563pHkm1Arvlv4FoIYyCSORgzbiDYOgxg5vJ2z9ZiWz6khsZf45NPxX/7IGoZyHG5kXNA1Fdi+0MHFkQ0V9kDQgl+RnnoX8y0YLWUPxLU9jueYaeghDQ1pUix74g8mHwfhqFFwFwf/yjFzYUKW2MmehlmL4AqD1gFpVkXUjhqwDbs0DjMtBsSwEd8TYvj61Lzp//vnmNQhMUJE6JWbOKXuXpeaCPjSF3p6+sC/+7JCPNRawNO/TQ0ModkAy+3MQQNdyNjxXMqMpwZcJZSznSrUX2CcfVkK5Sh0pJFHlBqhM1C6LRbYETStXJOLFlvOMgM6ndqrga0Izhjqg6pO/yJKs6Y5ksoDxpAC4zbkTmRNQtGSx4jnZlPlGKk5e8P6yT9Y0/8wLkS1fgkrXkvfnbp95u7WVyv7NSLTr3NCmvnAWubtOz4UiBmLnbBUvPGV5RupU2vrePt5yjr98rDVnsiwF42cq34Lx9UYWPIt3L3HHRJbIfG30yYys5BaOSLXFieAp61yfq3ucRUuHfjUMuIrO3nbO6Oo2FVEjKVNOsz2q/rLieA7bh6QG0j3HIbFcL7GesXuNh2ampNhKYoATB3jrXJtLi5QnMkt32gQD806aMfAftOJoRm79VzLfEJ4VotgRQBKvmMv5z9oeePHvk6s4iuzTjseKKlIp86RWcjtPSodR0LYM3ZtdDyd6eJuqoORku3cJamuH/AMHrA7K1iILnYcis49BNeBp4j7c8MwMuhedA/QDdvgJrDg/PgK0VlZ2Qa8QD6Nd6Ky+PY5uqSjwD1xdzu8F34I4rciDhxjVsCOb02WgHLe0X+G4UjuGzAGsD4mzkRVowkrYKOeZd1xTOVvodM5qFtSx/obVdfplkERkcVoyTt7KfE1u/MXe8rtW2pr+obLwqplpnlPwGYiCr5Xr/vgXGXV4Pp5DyftNRt9NLmtE/8Ol8sOeofZkTbiQZLsS8cqSjkQ8ldlSdZLQsXH2J6xHG0NhHwN4lWxXPGvisKWKAGhGZE5yrv8EalTb+VAZuUcuUgcCxo1q3TBtfBDm3kyVwX6GMNFisaUlGkAImMB89zQtOdmKNCURJ4oXQH6gLSmzFIQeXLgvQgH3w83A/6gKw0oQd21OfmBfDh9u11lA4PXHrlDTcj/PbtGvEni10nu68GjsRgcOR/w0Z9sTXfM/QoJH9cTzNA+5zRShBUk5VQUZ/re2Srh/rx66XERPUVKFwiMGipfxTyDtQQ3kubpoUgVnoktu1XVEAZD9haqVyJaFzMiLX65fPoaw47s66/jkQn0m+DaBt49gKjIXJ5y5T94DfTm5F0oU5GP7+YUiPwH8Vwh/Q5cOG99ut/00E/0t7S/l/aXIVJnTLOaXcF+UD3j5iBdXl+5//ETmvsHQdxF0RvmplJ/Lze8uXwIfSDnNM7KWOe8mYsu1d0TEPiGc0CZh5R15Dol8EPg/uIyuHZFP0GGakrlBwmMi+rvoBSfPfkgGnaIbyDSlOaFrWWYFAU8pmMwNuaGlc6cMOmsqlEE0NjwWzsXeInNkGzdttyFKaLnNeN7TAlOtZJkykOYX7+kuXvH480Xfsdv+JEtwbv/COYS7fpAZBi6Ny9u+ga7Chv/7sCFYOcZvaUpzwRn5UWbc/uj+/Q7Q9HoQB10LhTcE6EIqCO0H9cudLPjtv95eWxNWC2mhGkTrkwqnFxd6louXFfEUoTnX+0pJIr5wRhQM3xF+z/MdbDRsuJDMgYO+DhA94DQnLy72F/2kGXroi8h5zMU9r+HDANROTQQ3SnmfwA6mO/Li4pEprd6yAg8H/LVDAXXOVPWGcOZM8eKiewsBDxAZGPogOvKPbiOU1/aNFtg2RQ8egm7oDuBzVoZnEVaCf1y8RLLVKyxWtIBrVWtCxZZnxa5ymrUdZV4d9HqbKurf4rH0P8ClediP5zyJS1RAtNly4Mi/NduOQYPGs54ebowQdOIZ1n6hzR2E22XbHGPWKBkcs6WNEIA7GDN7VEe9yRhkLnBFRIfoji2v0xNo95/NC4EZrJPAyE9IMYnL1CDW5ZhvBu/2VJoTdsmdXu0lu7SX0D+mJz2HquOio92xTcIfAYME1OKvf9ohfvTMdiP1gI6aOnnmo17rp9OTR6IxGw/4xJ8PRrE/ns24HyWU+6M5o0PKJ3xGR42g8GTKgiAezOZRPBstRtGQDoMpZ1M6n9IkjsZeI2gbDxIWjQczPx6NqT8e0Zm/GCYjf8Kn8TCIB2xGxx2hajrj82QRxX7ABkN/zCdTP5rNF34wGI7Gk+lsvggGdTR3Vkduz4pHd4WKRxD2ROBPiFZbPnYrk2ILbPFNthQZ5zmcgRUKn4at6+wDnyRTOovmfrxggQ/L9OEnH36Dn+CXxj4s5tGMTuMJG/NRMqSDKIgXbM5nyZROonE8au4DG/JJMqcDPxrHM3/MFoFPR3zqJ4toGE/YnA869yGaJwsaRLE/4MORP06mMz+eLzR+ZhuG9T4MJ52bYPSm5ia42s1324dry0K8FoMKLddzdoCO2SKii9gfDePYH8fxwKeTKPanPBnHbDoZ8Rlt7EAcTxYRG81nCzadTJJoMQ7oIJlG09kkGer0CHcH5sk8ifjMHy+mzB9H04U/nyYBUJYNotmIBvNpTcrno+Rg7g+G/uAoJXU2S5uQ9dlknNMJTXwes6k/jgaxH00Y9ydxkgzZKBjORpA4omF5s/5w8ggqD58eakmJyX3VjXjoEC2pjI+7hsDXAMrJMTuhFKwj+IuBMgsfWbX9T3ckqDN5z4a5XHO4LZDsYv/Vgn+cQ8eYTMuqjAyTJ/JhMLoaj67Gi34QBH4wu8KTUm7YkcGToDG4lao3CCaLEZ1SfxJMIn9M6dSPkhFkf7CYxZyziDdlAB9EjM3HEzpejOLZeBHMkzkfTNh0MBgPpguIBhjQ02gwmgzo0Gd8NPHH48XCjxbjOUiCiEbD2XiKbE0VOedFOPCuvFEQkFHOyC3+VD8bwn2uIs2jAeZ5YZ6vd0sz8hY8OULF0jMuKjhY117P+5vYALccD4IZrrzMCvAHez/fwlOKR9TeAEy7CbMSsmt0RtBiNA1G8xGmT6Y6joV7Xd0Z2vHzc6W42KNo3SD/+F6WJ+aUWHutSipxHR4VFa2zQxtHJkjGrHbcHgZA6NFUhuZpeZJdgiCIBlGtomJH5Cej1+Ejuzj7GBaCsGiKzyvPRj3Ae3Cv1qMYPriX7fTgzIO9iKdNcJoV92Bu7ikDq0t90h7YdHxgAA8dN/hRw+p2w2ORiNqwqo6OCRuZncLcIgRuJcTTjt7DPvNpi6YzUEqeAaNem0SwCY60euzivqYFRwcDuv7BweDiayABUFeqfRtQAwlNasPzH93oDyY4Uud51FfzJtNg6ttGVvSekwgSZRjH3IgeicoCc2NUAXFCHFAnZoNdR7vM3HUnuxHZ3yXinebpw14BzAHlSoe1GmGGLliHsnKfN7CCvkE8YjJJjkRWmkmiJ8XE4BW7V81pdDJY7TT+MzWHGowBqMy4FfHn6j9/kqlgdGf+35VVs5GpiHfhN+JYoafBdctHPdM3Js2cMhON47yk6eOxbKNw16bUgYACTPz+wzskPkYKYAJgj92+Lzt/M2RyGlG17IezroEgAvWMEDexT4xL/RgGtszkJBqUWSrWJklsHzM7qwZ5YDuO4aLRPREX46nZRyOBGw+qJDiUa62uY3eOEiaiKYR6n3d3DmQof0Ez+ttmNlAOY5CmcstZn1wTAGLSUZRYZloPyKQFcSD7Q4BUDZ2ShTPTHiw6ZnmYSYqMSzbjbOVGZsSZpltEWPP4PRXM/yDW3H+XJN7DQ7uo4nkZOnURe/ZQuQv7P40F9x1i1k7Ct1HmaFHQeHXwxp+oJXUl8Vw054Jk4iWW1GaFNB757kwmuAPGB/UcE4MaXIHsk1fV36jQQ5aZSMhdXmbuDQ7NHt7BILR3MKx313TF4VOT+pOURdnOUbHJB88Sd6tXB+UzBFQTmaDXDU/LgQV00vCR6SC+Dy6Z5jEyMX0b2SxWXOQkEWAz6yjTvaCYB5AkfryLU27jXZgwoCfSAeBHIcnM/GjvKERPoVaYlSmGarrjNJbzfXA4MYxtlo4d5ntNKvzReatHXK8A46yMkYv2MGKrg+o6RqVgpInP4lr0YHA85HLtpg7/3//9f4DPY30D38EZhRhiNZwSpS3R2BFcoDLgDFDBDgQsc4wsRlQJ1ScuygiQpkpqk8MKwRp3DWPHKcTxNdLAuXyta2BoW+koucyAPen0BpeWuPhYlnnhy5xByp3NS9Fj45VIWVUIIXMS0fgzKegXAHwr19wp3zClEySVNLNBYZG3g+EwYc5ROMJpc5Hp8hQ/h+hx5vjPlKT1fYSPS8xjCVNHBY/xOnU1N7DiQOZYQ7M3J8gCTXkoI8JJdGoA3t2uZWpyQQF8KmlxGqs2yVr7B6hP3gjEjzosApC1iTmNbC9wWho1C/gBVEwhEj2C1T6/evN+EPzq9fdaYDwt0az+pQtz7VIu8yI0V/0pgsWV1u1tAdjEwDbZH2s3++Gjh+1JMHfr6antbVYKzrjNJt3t79TNMpO5duPVfNZoDFrg2l9PpYRB7SzK1KKyhMvLeAIFtjzVvkyaZWipat4OeJxyXB8h0Z6k0IZzlpXrlokkqrQYx0R67NAOMb8Ajm3vkBEHmy+h6rl9LTvMvW9c8HW1XJzRWXQVQhAJN5b6Hj85hR4mOdOY8O5enb6mJ+6Zmzv47Rs3mLrsBuYJqQprPvbc18Bw0TqVtNDObI2bwz8L2VCcWiv3mgpgqFH8ekJxIaovoVFfQBRwxnOahgX9EqaCZzY82vyhZDALqDEeevKZKGQeOhg4kMworOVsDOms6utwTFsNEd03MmmwDh3ocrhqS10Cht5Y4Z4GfM2YMFGxtioHZbqMF1SkyrnHleJlT3JTATs1YNVZk7SFUoCi4LkpsqBRBCWQzeoY/UgoVVbpy/uI98n1Er1g6HsHG/ieCmMRalvu7o9vPpDL+8GlS7HLBrXuoONTI/O67aM7srwqaxkTcLc6C1r/R9f1mp8+bEWMvQ3I2qRIY6p0utt3dP1JbolMClNDRvUCY5mmPC503AoiC1CVgyEro2Dg1f6vkyDQE6Q74v8PcmcmuTPxsk27NOWYEvj25v2trkXpSjo09TF4MCGR1eD577hhHRkuHVFQqvaj0aeV1jUKZ3Ept2Ypb0D1jjnezVdQdvOj1kX26QTqUJMKUSqW+qT7JHcj2WupCk1VVVGp4gpmZG2rfdtBx714BrK8Q+5xA3wSHKyorZvfXn8bNRTYlP9O1Mj5WhQFOJO+60n5qZrm74g6jhfacUn4uErfrPJRL47zJo6NwdZdh2iidrlxWhTF0dqg1QuSjeh8u3bUhuttwTd2NUSnpS6JdOa2AQJMqTrRaX5tQNg2Fo1OdXueii6L20npcbEJT7PO60LcOnfPtvIzXgftoMJo/06WZMmLRiKQi78CbA7277Ea1nGcbrJNWWjFpco5cqZw47QF/1JUrcgwUGZunO4BhameTEj38Ojt998CqKr+4aiRDB4c2NfOJ4qDHAW3qty0wicfqwPYHYG6zggOAKqbl3HB5ixJHZYmuII+eQfifyvAVQrguhLzqxaNrfuDfSAPHRGzXWZz7FIdgtm+i75LObx3rTZbJzE5Wxhv2+SdUWGxPdSJBHq73P7o+OAeTJevR7NZwK6JscWN20qGplu6UyTnRZlnytzHAvI0cuxx8lD1DjvWyqq7weHJ8UlXgWwHnI9WNDjl9KYU0LxeX5u99oivdFWdm7mlf9pTih6ONoM8xXhy+0VCqqnOJCkzUCF0FVO4MokW9WPzYJOWqnp6T3OBmMEtpNjk61TzyDpZ6yUc6DXTJ2/LNPXRzK89zpjQPAr+u6ld2xi9vE/e07xoDwYJozapKHR8C8yVZS7LjboixUqifxWC7gByGPjDhQFKEaSuGWuPQ2KRYdAY2id/NgRxJtdJRabCjhbkHqv7aLwyr9wawrXwrTtKTLX+XxEGogKglkH3hQMtL+qemB2Xe/84tbp6nnLG1Qr0Ge0M0SbFfougI8r8Xl+ub02fcbpztctfcauOlqztUwSpfyAdb29ZlUvICLwnNBEx2QRGQmAZjWCMZ+EBJrqP8T9rcf9Zi/vPWtznqcWtp0b3oeg0afbYQFsXNHowqGknNDI96KZr3qQfEBLRkEgNyd4sJ4bYznmu+E+3GbWHnGNL7acKHeY0h0V9U76vD6zENS5M9zdUL9A5e89zcEtYbdo0jdMpJClnJjzRaAH7tGaIDmURHpLJwNRFst0tZU+JHGDXe6N+HZAVqHLAdag2zcxnOg6C5FA29HewXe13Q8ZOBmYqLxAbzHvRc/e1/fNYl9zzNwZbTRU8B23JQO+4CVseraT8jDuG2d7KetxNy0arVz7j9ej0lzTa8rqNdffNMSTYOBjv+/l/lAV5K8uMwQcmdHrfX0uOlew5V7LMY+hDgtGiQvfe6pMf6GdOVJnrPIWq8SXqSwLxFqz/a3bOJwAOIEV+zQj5VrxuXl82UevIFnGJy/Nc6qzvJk8yv5+RPLkHNfzMd8hQCr6U+e7AHDjqUdZXF6tsV9ysGV8nMo6xpeiH3Qa0dIxwC0U+8x0R1vOqTx0tilxEZcEvqy95kJyntKh1RgSpI0YW6zNQwwROE6DSkLDrmwVlN0kZzNFsElApA0zBpEXB1y8w0FeCr9M4ivT4Fc0Y1uGITH+hw/mMCeK85kqd1G7gvUXERLYIjWRZOET1yZJnELmz5DSgLZaqzBMaa0yBkWQM275WzQWaZaqZhALiMmPuwfrY2H/PnHj3vFw5LzqL8w5cEGCccD/whX6rXvhHWfh4yfw3MKn/Tp9awyuGw/1rKTK8P/WpUU+/4j9nm1xCpS6as2+wY6+97EBcuiMrutnwrGackWToScONNquFvp8FFZk5QIqoMl5BlPjOIBtWyIbIT+8wna+o6UUS3G5WcrNz1ZvVV3vunKSsN3qaV3pHBFdnZmUhmn5cvf5S53aZgA50QNHnT/PPf7Kpf3w2BRmy1URCkbsMb3Go9/Gu5yQH6j6Z5sgTSvRIcmeGErNJO21GmTbY+uH/N9wQsCgoRHMfj5y8spc75ym/p1mho8DQm1cfkJ0NZmh+JzKCdxrVtLaRB22JDAvuNUAgfkiqO/0v5oncmaRv/QsoXHdVm1KrWvTxgzi86Q49sJZ1mRZiA647gCiQdzYunv15/7LZJ08u21AiW9qZd9jBwiZ3vHdmMsX7+3PvqsSZ46fmR6eyzfZgB9O5PjaxzHXkiUH6nU42rQn8+Aw/Z+KvkMNUx4+rWB6C6ZtQjmAhRLSOu+/1uHITFvL4wAaf6xrQSm7ZH+KI3R/M6fd/EcXKf5dxXws/bdR0j/rBnB09FLbGcYL/c8//jvccIB0U2C0rFZgPOtDQ3IGg9RGx0Sc3mFu7kUphI9vCFgNYPpTye56iu8SIESsoKrbixSKHZmX5C41uQ1F82Qj1dwzwOtTeiGafoaIPMoBCXSUdllkCLnQW2vqBIyox+Pma+vCestbQi9+W6OD5Qddegq1tZ6uqFfQeNBBDL9AOPxyQQxgtZDqM9pyY/QXUAJiVmFlBcoKuHnFivVBVk15siWmK4aD8R6Njq076h5dAU3AE7MLKr/U9F4CBWj2hdoxU6+hAEL202TLMZVmYPOpDZpAeEVZx/w4UW0p+A9Gf9Ps2/VuoKjPG4GVjsPoTAqpCrdI1z6La/tsuMtfWgwzVcLUyuy5V4SoW3YjZ1SbaIacfYu3xEQw7Bp9NwreAsY01IwwnNZcS64n+1Eh3rvHlGauq3w5gWQ3pxK2blm8yph2I9c1BC6pY0YyMbFRTZKY8T+NXfTkzY6Uq8l1Yp3dkVMQ63TGsFbODGNejz6fnj/CuDmvuH8fTMDTTfH8E7dHkf4Uy5UKSKWFiKSq2cwRdZRFQJ6CrRKzHno/trYgRV7WP7Nggq3G1HS1Cp3vDaXu9fhIR113720aiah9Q3Zd2H4QDWDWGncG5r03JOXZrthSLUmDloFlV+OjeBIKrA4jbb+cYR8ox6dh69RxsX+nLzTiWbAHKGoa2cQ0OdT8Fi8wBnKug3inb7n6g+cy9f9OIwJ58AkwXgFC32XmStD6G1SuaoT9QdzC0PQfU8W1f6V4oIXJ2jbBVK/S3OJ5RqbAfKLZqBKoUxGCgI+Smfckh1MA/+t3QqgIOqEl3IdYjG6Oy6U94Qw7ZIVQr8Vgds+9yFG+M17ZuJVEKphwfBuJXfTCs/gzVM9LP3mFQ+Ek1VZ3MgyjsLeYZMfiAvkfdrF6bpSaz2XqBwbnckmharQh5hpF68LrlNIaCHomBtYO4tUeef00rANreq/UbjYvO5qi+ilMVUrfw/556bGuNHWIOP4uG3daSwnxo8hQtYP+t8+n3vtKrLzrgXdTXuHZN6M5s5qLc6yDzJwy6atfiqfg3xn8T5g1Ij+JsR9cmDYQcwmUulQJ3h50842gMHNN1zIjz1R2uezVYjcLaBS2UUGuBHcFMpBNI+jRRh527nJuTcSiMuG8TyNxxneHxjPzmfdXu3SKgp6iuR5LLv/FGp45n43TYQkhPv2eSm6Ab+BZu4Ft94E6vcTTd/bAqPS14fgDb0EA5brd/E+ICciuwb75F2IZaWqhSU+kPOpVBtszWkokEE2UrlK038zmRtRGjzd5mawQ0JRsk14xS8fzeFuboD4HaQZaHt3UD5AIqtGk1j+oJevy3MKAmpPpWm5IGg6ft0tXCU5U55PCcpF0/FdU3X6CnMmdVAbRMyCAIkKr6K1LHaPkdEbMKl7UBMDHmhcIPgbmxrzqu87HldK/MB6/lK7fz+/BfaB+PMX2XoUWpjD/zvBL+6HSDrL2zDn8LWqcyjCfCKMINP6DITJFwIUleZlUroNby9dz7eB5fT7U5ihfl5vssijI3v/VJy2mheXxNbnH5d1yWzWgkZj7oxkNwvqetcR/tE46i9gnXveGfdZmNY2g5lvVCf8O5bCDdvUhVKvBFnOliP2VRApJaDHBXCD66hBoljbIqI5Mbvbc1lc/umGq+9/pTXHUVEGKBkGry2obwDiFcS+VvxbYRLmvRz85muDG60Gm8CotVzhXU0YfcCB/Pid+1McBl8QrX82ll6QJHAN02VVkunGCuZHrPCfrmr1/9iXywyBErGZ34kYTyIog5wPcp4UNLN1mP/CDvOfkgIdUyJ68phiNdgel0tTpbbarMFwukFTvSdcZFAbn86MCTRqXD3mYmn6NU2LAAPple+DLx8bkBaM1MscxoIfOdyZQ+ya0HX4J/gksPMqPF3iGtELB2t/WOYQWkffr83hQdza0CHrC51WwE04OqegRzDHK+lvcmA8s6D+pXIp4AMMgTAKKTjG8BqFX0oGAlZEJFZa6wVNxencMLc0efcfsc30L14ZYu7efI3TsE4oRUytcO0q3kyd53Xh4LWEKHw6FPWTD3x5zOfBpMqT8bzKbzeTyKBrPFkUW3akmfoPu7xaSV/NRc44o0S0p7BMtH+16bKhYLU8HxZCxswYlmfVqjBtW+WfJKLoy2rUP8F33Lw/6jEmwhKR9aF4T1V+ExkcAUkzy/T9oQSNv40F31C3xNupq85ROsvgGEoB/TwqqPXpy9iz/A4bGVDpRoQPZrCXtnJtYpSt82BwJpQ9ZZOueLXtNLyHqJt7nMlqYcdW8O+MDG+cdcs2TouJVXXry/iY0Our7A5jz4ebCXHVfM/WLK+TO7H0uxl3wQNAKlkHGQiviYp6Hz8rBSZ4DzQ6FH5+qYvkDKSe+tnVU6hNMy4E9xZHeidTyP4INbLFLnZODu632B3GytKds7nsqtk95QmO+2HExuqG37J3sTYEqbzdc+EK6P4HkmqBZpJJnpXvG4zLc9Mk4WhziLUbQtl4KLpo5IOniO7zzJAoGcYM5MedWFeeeiriTIJBR2QusdO0pZqQK9duPvbJ1TTPOz/LvZnOcsEzbjnClHDhkzsEP/sHSzX+Y8sDp8fDbBf4G0cMtnlhgWzY3KmteJGkElqPaw+44+etQkDjvJWz7nqg4UipazgsZF1XmJoXKU7toRfsOO7Bp0BPTZ/dCt5AcHZfMlmlY061i6mFtSeG6aGH7wN2ulvexxq2ZTmbNneW0+44qvV6axkaCYNqEVQG4/THmyjfA0Jd4o77Mh5ePpYOYzShf+mLOZP5/wwB/MOZuwgPP5aHKEpdmWJ+capWlKyVtR/G0JrjhWfT5C9xfQ38/NmKn6r48FVNVKbSJWoWZDhA5D55kpNWSzKJkOYz+iUeKP6WDoz4eLoT8aB3zIFjGNhvMjlHoaF7pRVNAV+QPPU5FVZNIfk0USbU31ymkUsjq1bS5RsdBHcrYO52odTWE12qh70t2ky05Mmh89PYhRY9iTrTX83E/TYsTWFD3yC/a4wbaSWHqHX6jZx9o6TSre+8ymUvXF7iPcXjoCtVkr2ahW9A8ku9siba6KP0i2s4f/pOLIYyV5h6u8m3UbXU2onD5ma8FYComjohCN1j31kBp411PtNzup6t+62I43r+K57UwEnrXqU3rV5xpFAr7hxFFhGk24oX9J2EKqo3n7Sbhg06UmHt7h/mcdszDzeeQDDXU24OrMYeKPgb/49HXx4D3aQKzZg84lgzPmYFM1+x0Pt1UR/7JBlzQoXADSNyDdr3TYYDZla80o3Ze0uSqafYYulKuvOh1C9KXAIhC14fQzp2rnwxp9aMeSC4Y6P2qEEOj8UvBM6QZ7H60O+8XHglrfKZj0G23soHLOFNp62FnFHap0t7AmqFxt6bJ+X7eKqgcdwrR6wWIMfcds2zZvI9Hm3FA4Jh50yqyysi6/VinS7OHSTeTDNADD38o8BS3AlBLTjdCVxD7jaywn7uhst5Zek7Qanq99ifAY1nUAcCfM9zn6DQ/B3MBjWLaClvSi2N0C/9LMx9gy1/j15euycVtgclgujoYzy2nO9z9TZkD4WJhEaFmswBq1Ubeed4upEt8yg4ZwYIKHngd8+aeag7+xn1Vr8tb6VrdZav3E4aROkyzNqzyohP29KYsy++Dysq7nLUYEn6Ye+8HMH8Ln0ZHnOLymk6vUz/eYSfVlTJ0lUDVhhXMCXV0bH622H8UewNfJ4aND6l1yy/N7EXPnnNVl8Fg5fIkDLxkQHkSWj/+HkI4yr+5Vu5l+NIXULR8vFHlj7jmxyVXX728Ik3G5th8j+y+mHwHVniuz8Nd2VvIT1Iwb94QldoXT7+t7ge1lpCrWNHPgvNIpvc3mra2+opXA7xjdhxYrKpYbfkXuKj5wtaYZXfK7utofWp5eblIq8NTj/f1qOMtH735QdfrUNcRXNXfxek6e8CfIOVYFvPP1K2hMP+fpwwP8/NeSg9L08ZPTYBFYEBOo3rDuPsXu2l5YEf2SWB/GzetDC7BFjdnO4aGeqbD0HOx1njSn0E7vPHxec/31K1PJjz2HdEswOCL2OzvtBspYiQ8DoPkAisAMv1FW50b39BhHdbtQ5ONaZJhv5MA+swkE3Qi//rrP7wxA3/n5JXYWVNxtVtMkqybfv/l4O/zr9zf+n6tIa0XlWrC90sTSPcjqEXtaaf0GMFpsxHd4rCsB37+7/eD1vMhovmts9ejldIsterd6z50OuvjbVy+l2bLUarqGCXePNrl7xc3NH06xffNUff2qR3yAlloPD9UhwxZbqNI//D/OOeO0 +sidebar_class_name: "post 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"; + + + + + + + + + + +Create an employee. + +scope: `employees:manage` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/post-v-1-external-payroll.ParamsDetails.json b/docs/api/post-v-1-external-payroll.ParamsDetails.json new file mode 100644 index 000000000..9ff053362 --- /dev/null +++ b/docs/api/post-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":"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/post-v-1-external-payroll.RequestSchema.json b/docs/api/post-v-1-external-payroll.RequestSchema.json new file mode 100644 index 000000000..83aafb3af --- /dev/null +++ b/docs/api/post-v-1-external-payroll.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"required":true,"content":{"application/json":{"schema":{"description":"","type":"object","properties":{"check_date":{"type":"string","description":"External payroll's check date."},"payment_period_start_date":{"type":"string","description":"External payroll's pay period start date."},"payment_period_end_date":{"type":"string","description":"External payroll's pay period end date."}},"required":["check_date","payment_period_start_date","payment_period_end_date"]},"examples":{"Example":{"value":{"check_date":"2022-06-01","payment_period_start_date":"2022-05-15","payment_period_end_date":"2022-05-30"}}}}}}} \ No newline at end of file diff --git a/docs/api/post-v-1-external-payroll.StatusCodes.json b/docs/api/post-v-1-external-payroll.StatusCodes.json new file mode 100644 index 000000000..cb3134496 --- /dev/null +++ b/docs/api/post-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"},"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/post-v-1-external-payroll.api.mdx b/docs/api/post-v-1-external-payroll.api.mdx new file mode 100644 index 000000000..bf780852d --- /dev/null +++ b/docs/api/post-v-1-external-payroll.api.mdx @@ -0,0 +1,71 @@ +--- +id: post-v-1-external-payroll +title: "Create a new external payroll for a company" +description: "Creates a new external payroll for the company." +sidebar_label: "Create a new external payroll for a company" +hide_title: true +hide_table_of_contents: true +api: eJztXG1vGzmS/iu8vg+ZAGpblu3Y8afL5OU2OGRiJJmbW3gMmWqWJE5aZA/Jtq0J/N8PVST7TS1ZcuwBdpEFFhmryaqHRbKqWFXkt+Q2nZXW6VQqBzPDndQqdcsCkrOLBBYTEAJEcjlIHJ9Z/O3trQOjeM7O+dLoPLf40YAttLJgk7NvyWg4xH8E2MzIAgkmZ8nbW74ocmCxZTJIMq0cKIdteVHkMiPm+39Y7PAtsdkcFnyV0pc5UikMWFCOujA9ZVwxiMgKj2wvGSR+JIme/AGZSwbJbbpxHE66HAit/5iGj8kgKYwuwDjpx1iWUuC/gb51RqpZMuiB+uuv798gQDeHXoQGuPio8mVy5kwJdyiWRcHVcvwwFqF3P+U5ZF/Hgju4n+7bDtRnllF3ht17qRd8uQDlxgUYqcXYOm7cw5kVfMk8JUaUtuYLSjwKV1BiPU/ruCttHwtQ5QKXV6kKozOwFoRfPOG/L/sm0JNbu0pYo82NzHM2AXbVYHDFbuagevsyaVlmgDsQjCvBnOHKSto0TrOrBgmtMmCO37Jc8onMJa50xg0wUA5M6D6ViufyLxB7jH3EDtKzbRIKQHmeM54hJ8vcnDuW4RYV0vVt1WpYQlo+yUH0Sj32GodeY+lg0ZwFbgxf3jvPjLqxqTYMFkWulwB2hd0g6RKvdEhbE0QSa/YrwuZGSTXrA7olD77QpVeU3eU21WbBXXKWTHPNHXKb69L0rszVpgHY2Ldcj3zcGhgZCjDJ3d3d3SCZgIKpdN8xuEBhDZNaH6K5MHJS4qyOd5FINUMCRJnt2J0G6fgtfMcIHb9dO7qdkBCYYCsnOYw3rKz2FnhV9WGxD5twC4JpFU0GK4y+llZq/Ly6/7bfEA9aVapcTLxEFF/095OqKN16shl3MNNm2fOxK7fVRXtRCU6Veb6qpRsCjJ2fTIDrlkoLUY8AUNteN2Uz0ToHrlbHv249rx0zdfjbB7x2JYQdbXAgPePtDuSzXsQhLPiSzfk1oBHyW4/dSDefQy7Y1OiFN6JBYZDJ26KhGTDYm+2xzzqTPGefISuNdMs99opdoSCu2DXPSzSWAp1cQIMoLZrmJpFnNjDawyEasFKgW/PwIQo5nYIB5Zghptqg36yNk2rGDPxZSgPoOVkmoAAl8GetmJy2hSAt4yzCQSJKq7T+27dGx+GP0kgrJGnYvbDoFuC44I73LYLOCJw2iD502N5l7q4mATk4XLVbiO0NODALqcBWw+46C+i2oGOCVHv9EhrnbQr+gEMQwmGnPigk2fFUcDg+SY+PTg/To+PRy/Ql55BOhyAyAPFyJI6Sru+fTLLJ4fB4MkxHp8fH6dFwdJyeitEohaPTI/4SXkxOspdJ269PRsPRKB2+SIeHyUafPDQ8Tg+OVxvWTnTV7HCY1H5vx71d55hdrLhHydHR9CSb8JfpCT8U6dF0eJpOTiYifTHNpsejg4PpacaTps90Ubs/B8PhcFh5OMOuA5O89tI758sv+EPb0hzcDWpKx9vQeet/7aF1dHfZ9Hwu2k7MaHSP03KA3Dd4JcdDxNoieXwPyc0ED4fDu8vKjbmoPZKD2gE5GhLX+GVUf3kxvLvE7r2Ox0XX4N8zC1GrJ59gVubcsN/4jNzvpnWPrJtGPREw5WWOHt06lhsmrGL7mts5+yKL3VhernEfLrzxwhlvK5b/4dKCSWqj7I8woflxt/k/Pr/qtr3ss9iBXy3FdyDA8Jy9VxlagC/8NumaxynPLXQNCv1Y4anIdSzYLrQu28q+oYWDlsRuZHMEnY9RHVzSoa5Xb5LF/KFAH1eBJqRB9xBIUH6J/+vBijQ53oHekylUHJfnu14HJsfYZGfFmtxP+JCY36tgk6NhRNCjZJMXnsgPRftD0X6novUe6dHwaDV2/ot27J0ulWC/K8Z+Vz6W/mcJFgOEBqwuTQZMaLBMacfgVlq3xz7wr8BsaYBcZDr1CRA+7iwtnm6k2Ptd4bnlaDRaZftrVHZ0mHyrnHTLCoGMR5aiAFVHMidaLPEQsNSliRgZblEulWVgjDaW2TKbM27ZlVQEYsyd38IwJgNyNcADi6tHyaZc5paJEjD+yVXdE48QlE242mOfwY/04q1n89qvVAn28qe5c4U9298XOrN7lDrZy/RiP6ZK0qDB6fs+wUyzqvtzNiulAIo9LrTBY4VDQCi8BydE+qT7Q7hd4XZPn01nxA8Yoz6dUJb/fYfA3wrV8VdYNnVdPw9qdW/C4nMBmZxiXP5mDmEzUnems6w0do99WRYy43m+9BGGr7BkpD98L2xfzeF+wQ1f4PmXGcgpQeB0TXJvc0htPTSKBiwLwOXlKVH6IpKK2iOsMjYzuiwoHonBlnDYLq1HMyllLliG62AR2s+5EjlGKqTyq7eRt9xj76c1I2nZlSLFNvbzeDUgcH6ufMYhLHnGmW/JrkJTFiZpSVEfzIGgyvIfSTQL3G+zLbJM53G8YTUyPtGla8xdymag0LbEWQukozBsaaY88wLB1IkSKB8TUGwbXnkdN7eBHK65ooQaR5phgSzDTg4mQCpGexozRaQ2ahu5x95h6sT76oMWCcJHorry/5LRv6K5jb+gH3tVJXyiMcHAilbwcerdp41jWZS5k5hMJooyZG8aGy/+vLrZ4pcdtnSbt5VqFjljNy4EpdN4ft7g1BeXagjk/lXzC19AFQLzEqUkWr1sMm18Ll1Y5jSthoaA7+fwq5J/YkwyqgdDerPmRxS99sZ4ZzNUXlH0sfKqXVmMnd7csKXn+hrgAQk2Nbmrs/QfwupPf5Nunn5UkHrjl9ytb/UhrB3fFKeGHPIfc/4vP+cUTFhnsNty+A2Vj1b50ju4GPvdYDb22HuHPxfaWknZEO0D7JUeyuEacsrfBzMSDUWlVpJMmgyPYT95uCk5P+lHWnDPk+YIexokPTHmCVdfxzzL8DA19tHpcammpRIgxiEa0XJiLlq+RoLJnPYhbMVZSxpmLnlXUobgA7i5FmzOLYvcWMWN5qAF7BqMnC7HUtHSzRBpoa18VGT/RDcAubLAFS0nnl4mwIi/xHqF8xy4hVDEQk4KeqwBTsi8oGlfNwSeY9x/OY4Un3QAKN7AkE0AVD2OHoALaVFDjY0uMbWzAVhoMQ7J1l6IHSe/BfST7898f9wT0ewGXDEKlmk1lTNbQat8zZ2kttq7CeaVYziljmkFrHZmF6V1TceiH1gc7ZRbF3fLOJcL6TYg7Gm8swjfIeJAgxENZue6zAVi5iymwQPmEE6s8Tarm9agrJr0YuuX5dtQ7NTYOXSCcnOu2CFbaOXmFn3CaelKAx5fjJtJJUrrzHJsIQcfG1NcZnacaQHj2jFbi7huvbs8f8G+DPv2LMftEAY2Tw8wLk34s+Q5WpEXTMiZrNTOBrg2ArBbwLUy8213R/tZZoTVroI9CmA9VicXMNbT6bjQucyWY4xrbTfXiwcJcdE3v10QpaIdBaLaLzzLTMnzsdm8Z1rNdtDcr3w/SrBXEpvkqMrRs6rwMAIowa4BHtLv4xBI2WQdO113Qfvab24BFP9EyJ6GP+PGEgBkwPR0GqM66zBXtXPbTHuz0G7HuX8bu1I14tYrYMJzrjIYl8U9+nK9td6E6jVXFCHl4g+ads/Nbp72uc6lQK2O//eAo1tBjuhjekUhVF+5EeRSsIDAF7oSgvXQlHZPB6sKMftqnB5gA1YEl43qV9HMr4VamcdqmT3JUnzv29S1MXjsso0YBuHTaqK5QTc8tntM+cU9jA4/q1hVkDyElcE8IoIvFHvEqiAVjqWhCDhGgTG43LFo3q0Yg6IcCyXaeOa0GWuqo1mLrdty921aEfDnvdq/8ViELwPGVY66z+OtN2zE/5R+bGeMPWaOss5IgE8dGDrrb+MFrPbaXX7nlV/9rIfes3ob16EJilOysFGugerZLn1FG4UWt8Xfav9dyFuU7sUcW9dHGsrIz4y2FsMdkbkCOgxs8nVCi93dHaAzQuVRxHNBBxJ5LTgjlHzfQqQPM3X/QOqNnaNgxjF/2kET9niGdjB/RH1zXhfiBQCeRbU9pkb/BSqWTjyqppO2qgNcOZJX9RsYH7I+nF5j9G6HwAwZz+kCRS/acaCy+dz+XcClZRNA5VYBjqmWDlQKNWJRqlzEuS3VQgs5laS2I+QYzXxMsDFjVKxMtgfgJdkSuVeUFsx10OJ2aR0sqkZRh3d9A9ICdhzL6+/1E3z771FAbUr1rlaMwpMB54LfykW56OK0pSk4lQk9HdS3t1hCBYIFDDgTB8MhSTXX+mtZbJLlEwKLDlc8A1DJwU/2+V7Szn3VeZ2LTtC9Oj4knVh55J/in+nB6BBH2FJok1xnX8FUxp+CblJN9U6Lv0Ot1xmmFREc4VYcUCqmjQCD9smUqlkE3Ry+572Kc/N4qsmx4MriaQbFRe2a2ocNpwNz85imvkwH62WecljoF5IDHvhR/Tvxe9gYV2FvsRR9TNgXiTz6MFvLMGqsGIX+jnXZAt0/SFtajEXsGGLfZlASi1oC8aYRvHcINSQP2ZYTGpVWK1NTxew2ueYr3R8SqquIsEiEVczrM0SyDnBtlb8XbStd1pFf5Ba0MYXQeTYfu7kBO9e5GEMwPkkjf9dFQMOCCuvusopywSVAYZtrLnMeknno8efXwCg2/+r1P9iXCI5Fy9jIH2ltKRiBRvI3aYC9VwP2QV8D+6KxuM6wN5zSkU2DeQ3G7rpNY9/q+BKJdHJHFBfjzsGioEOs08Gl8/d2fD1HiYsTXQ5dulRPU/oeCMZjppwp7rTB0B6X+XZhPS7zh4T0uMybB90ugHjujtGxObfj6uvjR1N8NrdKeODkVtwYlQfFa/VxGRhY4Iz7G0MheFB3mcAUiWGdAAqdKbhBotHRk7cgxkLaSWks3cCKW2f9wJqtd9h9jdhCzFv1ej8b9t46Em0M2o2nWFfaku6bBmjaddTES+GJhyeGYspHo1HKxfA0PQJ+kvLhC56eHJy8OD3NDicHJy83DDpSW1C2+yG+v0/w+f6V/fRa44y9kZgLZ2988nnAXmNSei/pSiWiCJcGHowi3MgPqs971OjaF22Uz4K37VP8z/aiDqsnd1OwhmJ/26yKNTXHN9x210gylUra+ThEOanGXEXX6wli0kFA/ozvNO5sx2rmnZhgrr0XMybS93lh1hkANz7YfRY/4OKRKstLgRrdE0LdYsDalTWT+RKl7+NBRLqUfZXO7qYXu6FoQ5T4xmg1Y+H03eXxlywesMy9SqZ3Kqoo3l+y8EnXn+hq7sHo8Oj4ec8Wm2sFD66HOMfesRoibvKDYStRihUHucw2RRp6N48ofQU4rEs9NrYOpu/cHGyjvLcOVvkUTucAv00guxfW5jqCL83rAXVNBs2+nxeszfaectzjub5plDdQLdem4ob6bP/gaAKyjNV83QXRjBE8DoNqkMGSeR/W3m/zQ8PtzSFxCY521FK40ewGS4ffqc+DTiBYEwwiXG9/Fvo8q28SKI3P6Sykc7GVjVZlwq3Mnvh0zqnML+rv9p33nY6wCkDYhh0Kx8Ae/yPK7SYUh68ZHX3eWeB4havSMzNKi5rgspq6UGNYGaoVdE8YoydPYn2QvBNz9ggwhs+oMj1zzJYFPk7ABDlH+bKb4Q/qKI7BZ0AfPQ7dKX5oQK5eAGhlszaVi0lj3fhhBS/vsC9TnbKXFW0lyD5MxxNp3Hx3Lm8orz5l1L06GgcLSmUT3gEknbNdmraqBX2IEx+c95MRh6MXByep4PxlegTiJD09hmF6cAriWAwBTg+PN6g0fxV190NpnnP2Trq/ZhiKE1Txy1GZ43GN4YalNTzvZMMsoI9IR8Qq1RyE0HPQeWRJjcTJZPpilKUTPpmmR/xglJ6OXo7Sw6MhjMTLjE9Gpxsk9TAt9N5yyefsZzC5VJWYUC75kkR0E26vbCeh6FODst6fruIem+t21tdqbSxhDd5oc6U3iy57kVSHS7WxPrTV7MGnNezdOTEyTMEO2G8AXzHUpNycrt79E3gf6hg0qS+YP+5RKTLapO11w6DetQr4W7cV095i9/ajAD9HR6F6EuBf1mO4GySfGnbjvgH9mxiQu0HyS2VB7hvzD1Pyw5R8hymJt98r7fUex1Zo69LrgzQ+sxHvEa/ekiSf2oaQ7cpbUPG2VIwG/65+VzbTBZyxq+4THvbsxkgHV/Q2SDgIe7GFJwBaT5XgyZwUFu3COvLuL5XVN79XnkLb6jVY2vaB7f+l/03v/b46f5/+b5VQIO5z4IK0ZM0/vEOw9tUsZIL7PPVvw706fx+TCoxbi48c4MmPAhR0Wxcb4AVluqqr0LrJun5y4Ns07r4/s+xiIRXVJDRo73hRnBcyDT2lmv1nIJg2fn6OMPDWMSrzddKuH3cd4UMywxf48gu9FOgfrzhr/n53dzmIEZSftaCYRndaH3jfv+cye/vW4SO+8/t3vev7d7zj232CqCGmTaNcj2yb54v6nxY6ePSnhaLiu01tAfwrcLtM6W49xrSCgKqXrtvNUDGk+hqMkYIUEynB8CqRshSDQr3lFf3a98IHcdDNd8NR8cR+XWBVh1WA/d3aQOvuAXB4GQUTNl7lk+zcPDlL9q8P9qva3v1vTdV7t7+iuVEHYFlZ0NelyVE5Bo3DC+kVTipgQVqn51XBhe7I2NNLfW4KP+MI1xDupXluKA+1jmaBn1EANr4og8iDj/sqQ3/7VYmiuLhstvqMKsYv3p621cZDiFEx4t8T4IYMRfeNASKR0nVYxks3xxhorPUYJJ+pQO97OHgKaxjcDRJUnZ9qpdvYkK19WCmSTXtwXaPG/mu+TevLwuIph2wsmixcpjH337QPgwRtqP04/QzmWmbQWAi1OaOnIvap4b7AMaOWT+lvzOHb0HXlejPk9EiR04xwPLPsbdiR8bV7sqZCZ+UiPqL/H+EBGu5TFcFbeBO5sk/4SEiIR/u0P67k8PW/6oWL04Cbb8FVg453rDb5VVWOvTucb7WdfCL/LKxBB7duv8i5pMVKm/NbUCAXyfVB9bqcf3DirOO/rWqRS7yqYh32/vYN/aNfTX53hz//WQK6yBeXqMOM9K83XXxL4uvn/X5XUxA/fQqG7Dlb5/OtGVe8GE8togZNwi39tlPqb9t4p3A3eP/mHmKvYL0A+93rSs61YXvthZV+adnOVUew7oGKs3Ab2zYt4PnHz1+SQTIJzudCk3E3/AYdfH7jZz3mmNA7xd++JTlXs9KfzjxN/N//A9f/0L0= +sidebar_class_name: "post 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"; + + + + + + + + + + +Creates a new external payroll for the company. + +scope: `external_payrolls:write` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/post-v-1-historical-employees.ParamsDetails.json b/docs/api/post-v-1-historical-employees.ParamsDetails.json new file mode 100644 index 000000000..9ff053362 --- /dev/null +++ b/docs/api/post-v-1-historical-employees.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/post-v-1-historical-employees.RequestSchema.json b/docs/api/post-v-1-historical-employees.RequestSchema.json new file mode 100644 index 000000000..7eca7cd8b --- /dev/null +++ b/docs/api/post-v-1-historical-employees.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"first_name":{"type":"string"},"middle_initial":{"type":"string"},"last_name":{"type":"string"},"preferred_first_name":{"type":"string"},"date_of_birth":{"type":"string"},"ssn":{"type":"string","pattern":"[0-9]{9}"},"work_address":{"type":"object","properties":{"location_uuid":{"type":"string","description":"Reference to a company location"}}},"home_address":{"type":"object","properties":{"street_1":{"type":"string"},"street_2":{"type":["string","null"]},"city":{"type":"string"},"state":{"type":"string"},"zip":{"type":"string"}},"required":["street_1","city","state","zip"]},"termination":{"type":"object","properties":{"effective_date":{"type":"string","format":"date","description":"Date the employee was terminated from the company"}}},"email":{"type":"string","description":"Optional. If provided, the email address will be saved to the employee."},"job":{"type":"object","properties":{"hire_date":{"type":"string","format":"date","description":"The date when the employee was hired to the company"}}},"employee_state_taxes":{"type":"object","description":"","properties":{"wc_covered":{"type":"boolean","description":"Whether this job is eligible for workers' compensation coverage in the states of Washington (WA) or Wyoming (WY)."},"wc_class_code":{"type":"string","description":"The risk class code for workers' compensation in Washington or Wyoming state. For Washington, visit [Washington state's Risk Class page](https://www.lni.wa.gov/insurance/rates-risk-classes/risk-classes-for-workers-compensation/risk-class-lookup#/) to learn more. For Wyoming you can search for the code online using [WY Workforce Services website](https://dws.wyo.gov/dws-division/workers-compensation/) or call the agency at (307) 235-3217."}}}},"required":["first_name","last_name","date_of_birth","ssn","work_address","home_address","job","termination"],"title":"Historical-Employee-Body"},"examples":{"Example":{"value":{"first_name":"Soren","middle_initial":"A","last_name":"Kierkegaard","date_of_birth":"1995-05-05","preferred_first_name":"Angel","ssn":123456294,"work_address":{"location_uuid":"1da85d35-1910-4d5e-8e94-39e8cdfe8c9a"},"home_address":{"street_1":"300 3rd Street","street_2":null,"city":"San Francisco","state":"CA","zip":94107},"job":{"hire_date":"2018-05-09"},"termination":{"effective_date":"2022-09-15"},"employee_state_taxes":{"wc_covered":true,"wc_class_code":20992}}}}}},"description":"Create a historical employee."}} \ No newline at end of file diff --git a/docs/api/post-v-1-historical-employees.StatusCodes.json b/docs/api/post-v-1-historical-employees.StatusCodes.json new file mode 100644 index 000000000..d95f5f522 --- /dev/null +++ b/docs/api/post-v-1-historical-employees.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"201":{"description":"Example response","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},"examples":{"Create Historical Employee Example":{"value":{"uuid":"ad85459f-8bf5-4a8f-9079-3b3fa790799e","first_name":"Karl","middle_initial":null,"last_name":"Jaskolski","email":null,"company_uuid":"3c69d228-a250-49b4-9946-24e4e4294da4","manager_uuid":null,"employee_code":"eh3st1","version":"dedac972dd28945fcd6cd941723cc71a","department":null,"department_uuid":null,"terminated":true,"two_percent_shareholder":false,"onboarded":true,"historical":true,"onboarding_status":"onboarding_completed","onboarding_documents_config":{"uuid":null,"i9_document":false},"jobs":[{"uuid":"f0be5480-7a15-4583-b0d0-789c02a1afe4","version":"1c0722f3e090713b6a0db7c39904693e","employee_uuid":"ad85459f-8bf5-4a8f-9079-3b3fa790799e","current_compensation_uuid":"1a1faa42-274b-4440-b200-a5d81df14af2","payment_unit":"Year","primary":true,"title":"Client Support Director","compensations":[{"uuid":"145660ed-6fcc-4211-8915-18e2786290a2","version":"2cd4b18662395eb53bcf80d5b5447f36","payment_unit":"Year","flsa_status":"Exempt","job_uuid":"857feae3-414e-445d-b28b-2eb3ef50155e","effective_date":"2023-11-01","rate":"70000.00","adjust_for_minimum_wage":false,"minimum_wages":[]}],"rate":"70000.00","hire_date":"2023-11-01"}],"eligible_paid_time_off":[],"terminations":[{"uuid":"ad85459f-8bf5-4a8f-9079-3b3fa790799e","employee_uuid":"ad85459f-8bf5-4a8f-9079-3b3fa790799e","active":false,"effective_date":"2023-12-31","run_termination_payroll":false,"cancelable":true,"version":"e6c865df784842196d411c1466b01686"}],"garnishments":[],"date_of_birth":"1986-06-25","has_ssn":false,"ssn":"","phone":null,"preferred_first_name":null,"work_email":null}}}}}},"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/post-v-1-historical-employees.api.mdx b/docs/api/post-v-1-historical-employees.api.mdx new file mode 100644 index 000000000..aa0590f7f --- /dev/null +++ b/docs/api/post-v-1-historical-employees.api.mdx @@ -0,0 +1,71 @@ +--- +id: post-v-1-historical-employees +title: "Create a historical employee" +description: "Create a historical employee, an employee that was previously dismissed from the company in the current year." +sidebar_label: "Create a historical employee" +hide_title: true +hide_table_of_contents: true +api: eJztfe2S2ziS4KvgOHdhO7YokxT1VT8u1uO2Z7y73XZ0uad3zu2QQQIsoYsiNARZssZREfsa+3r3JBeZAEiQolRSubwXPdsdjmgVCQKJBJDfmfjiffava1VJXxQVvy5pJWThV7sN9y4/eHydcMY48z5eeHLD9ds3zLv0NlJV/m3or4SqZClSmi/5epPLHefKu/BK/reaq+qPku28yy/4pyg58y6rsuYXXiqLihcVvKKbTS5S7Pj5r0oW8EylK76m8EsD4snkV55W3oW3KQGMSnAFbzNRqmpZ0DV32qqqFMW1d3fhrQVjOV+KQlSC5oNNcnqsg03JM16WnC3vGYnRii9ltkxEWa0GWyhV7D+/8Da0qnhZeJfeh8BffPyyuIPGW1neLCljJVfqfizkUqNvWdeCDQ3CuEpLsYE23qX3I8yJFyknlSSUpHK9ocWO2F68u7u7C28l1/x0CFRVcl4tw+GZ65dR+/JDC1pR57n38e7CS0W1O/A5rYaR/nexGXh+d+Hstg8taGYI26H+HEaueLkWhZ77vTPlWcbTStzyJRsE68LLZLmmlXeJe2IP+d/RipNqxYk9LGRLFbEgcEayUq6xgVkXvRx8TcXABu73/hZ/0HxE3mRkU8pbwTi7MONRkROzomQr8pwknCh6yxnsAxekESD3V5ncj42VKB+KiPcrTuAF2a54sY8R6LkBrIcK3WyJ67is6Gc+uEO7w+2Bvk2XqbzluEuajxMpc06Lva9/XvFqxUtSrYQiv8qECEV4Lq5FknOSyZLAgeWleoKg8kLhbiI4AL3mROgZIsSKyIz8TNVKFNeVLMjTn188I7IkP+/kWhTX5OnPf32GKwAQ5lSpZSrZIIL3EVoKdUPwIwIfHQFNFC4MzvAI44i8hkdNgwtyK5SoyAfnG2z4RJEfYcyXOOaGXvOPT1dVtVGXz59vt9tRXojRlo6u5e1zUai6pEXKn5eABR9g9RFWrp67f/iZLH0Dte8C7bTycylv6s0fnj+DPZJzWhZkLUsLuJnLTtYkpQVRnJbpCrGhtxPjRBa5KDipFTT88PNfyc+yvMlkmXJyxctbkXJFtjxRonKmxLZqtN1JnA/bKp8JwIssng+Ci8ua0jzHUek1L9IdoRV5Og5mz0g0nvjjKJyNYFv3iJbDbVwW1eczmqv02EWPduuT3KVyHy+8SlQ5bKY/N+zbf2UOlo9MG07aZ7re5Pq4vNK/4ectzWve577elSw5wNLnud6LzhQuvX8VvLzh15SWbG9Cl164WEz8AP55h9iv96K45rmZ/GUYjePJNFrE+1yzxxe9kNH5hI0nfrgIAz9mE+7P+SL2xws+T1nG5+mCegO8r+Vu3jgIyLhk5AofeS5zA05m2Zh3RQvyGna7UKlseM6l9/KFYTyXizgMZi2ddSipFwXhHHGw8PbZU58BeVEQRX6w8MOJd4Q6uuROi2A98hIFi0V0d6f3YpeyvCw5EGpKWlmvyys2tKRrXvFSeZcfvnhmmQzV1ti/8AR0taG4bfvi4J6850hWe0Tup5/efAc0tMMZLpph/93/E4qzL9698f/CSziedvQVp4yXnfEzmiu+x6S5RjpXOAgg2k+o4oy8ePeG3OpOCVVKpgKZ9lZUK6A2JTaAI48cuJAFB1bRcmJs40i8TxT5sBaFWNdrt2+H4shUjVA+H6Vy/dzK4/6G7kqZ5/j+Od0I33wpius/mA595/EzAKNWnI28w9i+8HhRr4H+REE08YMp7KmPgJyM1nml95p9fnf38Zx9ckFo0XL4akUrZPObkt8KWat8R5hQa6HUgAhk2WdalyUvKrLjtBz9UvxSqFRu+CX51Cgel2ta0Gv+CZdYbWSh9O6PAhRNu+AakkZsS+8ctcSQT0szgcAelT+QO/NNyRUvKs2CZdbBiSgIblxYoc++S3tVnaZcKTzSNT4xBI3NonnEFgufJtPEj6Ns4ic0nvhZTKezgM/nUzoHQcwlnn+UFKXgPp3W5KtDqCWyDyN6ejecF3SUca6qf74RfFWMUjmqbxBrzkG/9PgiiNN0tvDn4Zz6MaNzf8HGMz9IeEDn04wxhEovVWm+0sOb3epdenSS8jTMwjQIx5OMJ2M+m6Z0yuk4jafhbArD6u1g1M41/LQY8rI6z5eVQJ4pi0TSkoniun3vPAPoc15xdpDhaNgY39CywmFckBuCq8moF0+zYDxFzU7DtObVSgJevhMlTyvyHd9IJfQOsT3azlo9oKFM1VYuN7xMcXorWvKVzIGI2fdmJi0tbQ9f02ZF1RKZpW7hTJ7JtAYAgAsUmbhuN5cGSCyaJqY3zbI0oTcLnqTz2SRbMJ+ydOLHQTb1FwuW+JzN41mQMBpNMs9d3Pl0nKQsCNNJmKUZjeLpnE2DOAXWNovDseeg9bytbveEK4fZLiKehtOYBf48mCd+HE9Tfx5GgT9Ps2QSBIt4wgJn3epCAMn7K6cl7gyxpuXOovC+VdHc12W6Gp/tc4f1mrU3JMUcKAt9B9MnTuGByGsXiCWzJEviBY2zYL4Yx+MoTSbTaByGSZZStjiIpixXtD1lrz7z9QZ2OmW/1qpaZrJcGua03NJr3qDLfQgT/oibbHne/hqSjJBbBQBvqZ/NgyAIRkHgAfvqP7voiWFRbD6HxlbfW26oYEhbljLLNLCOjGbAv6ZlIdQKz5Z+0pd0oyBoocPTiUrqShbNlkCB1tBf/WQNAkC53MiyovlSFLdCMxOHNzTYB04DfEne8GLJP286As+W5ymIudj7EpouadVMOvTDyfswvhwHl0Hwf6wAv6FKbWXJlpqL4QcAlpYAq2IYMCQdcGru7vo6+Gn2qr7MN8gxS07Z2yI3B/Tu4qGmwSHT1HEbYc80s9fB0HQ2vFRgp+lZZXoTHJH3YG9wBEhQdlW9ASwTtStS0F1rxUtFEl5tOS8IyJdqpyq+JrRgKG+qEfmrrMma7kghK2iv7RjdsUE5BllLoqFjU5cbqTh5ykfXI7Km5Q2vRHGtDRNdfn/u8lmhrruUyv5mJNkNLmhXXjgL3UO754kipsfB0RpaeMr0rGBqNYO9dbzi2uj3oZXSyXUtGD9T0BeMrzeyAkPCM1wxUWgrG45akJXcwhZpljgTPGeD83Nlj7Nw6eCv7aOR0PXaDo7oyjZnGNy6m6TtZHiMQ2y5nWI74vAcD41MSbWVxHROnM57+9ocWsQ8GJl2Wt0DVVKaNvAHaoy0IFf+S1luCC8qUe0IADlqHAAPoSzw4W+TqjiC7MO2x4oq0gjzpBVyB3fKgFLQ1w/dk902J7p5H6sg5BS7txlKa4fU6gNaB2VrUSydl6Kwr0E04HnmvtzwwjS6FYMN9At2+A3MuDzeAqRWVg/13gC+THZLZ/b9dnRLRYU/cHag5/MtsNMGPbiJUQw7sjhDCspxTfsltqu1q9JswHaTOAvZdE1YDQvlvNvzFnwl0xkc1UxoYP4drev0wyCJKNK8ZhyM4Gvyxl/sTX9opr3h7xoNrxmZliUFm4Go+Fq55o9/0abloz6ih0kJv8rkm/FlDej/d658t6eoPVgSriTZrkS6sqgjCc9lca0GUXjUade2HrSMnuS1kyUpuf5pXS64nHeNknvkIA0AYKyP1gzThwf73BupUdjPc+4J1ZcSTUfYMYHx0P/RelB5hW7KsuakLnJgenDgPgsF1A8XA/9QDYSt6XxgccoD63J4c3fcevD5fUeoq7mfp7foTwl82sg9Q3B0VmMAhiN2mrP1iaHx70HBvXLieZKH3BYKHHs5p6oi0f/qi4T75+puyET0ECH16/3RA+7o+wAe8EqftH0e6p42Pul3gF/+m3FFDyKxZ9o7wmIf4E7oo7CxjjwGRz7Y+T84j24NkQ+QYbqcuYPCYyz6m8gFJ49+iAedIhvIPKcloWtZFxUBSymozB2+YTzGQzzorKGQB9HU0FjYF3uTLJFsvOmbDZFDy23BywvNMNVK1jkDbv7kHd2lK57ePBk5etufZQ3G7Z85B3fX97JAJ7Yxedsv0FTYsX8fVgQbw/gVzWkpOCM/yILbh+7vtwCmd+G9lGvwjsKsAC+k6aH/ov14kAS//rerF1aF1UxaqA7SRqSB6ekTPcqTZw3yFKEl1+tKSSY+c0YUNN8RfsvLHSw0LLiQzOkHbR3AesBoTp4+2Z/0g0a4QFtEyVMubnnbPzRA6dR4cJOcjwisYL4jT5/cM6SVW1Zg4YBfO2RQ5wzVLghnzhBPnwwvIcABLANdH0RHGaDZCPm1/aLXbR+jBzfBcO9Ox+fMDPcizAR/PHmGaGtniE59uS1aSaja8qLaNUazvqHMa51er3NF/Svclv57ODR3+/6cB1GJphOtthzY8q/NsqPToPPuQjc3SoiyEYm/yuSJVnew3yHd5hixRs7gqC19gKC7gz6ze2XUNwWDyAWuiBhg3amldXoAbf6zMSgwgjUSGP4J4SxpnRvAhgzzXefdnkhzwiq5w6u9wJr+FEbH5KTHEHVccLQ5tov4I90gAjX7G522ie/ds8NA7QcN4lw/nh48ksQsDvnEn4fj1I9nM+4nGeX+eM5oRPmEz+i44xSeTFkQpOFsnqSz8WKcRDQKppxN6XxKszSJvY7TNg0zlsThzE/HMfXjMZ35iygb+xM+TaMgDdmMxgOuajrj82yRpH7AwsiP+WTqJ7P5wg90nN9svgjC1ps7az23Z/mjh1zFY3B7YucP8FZbOnYls2oLZPFVcS0KzksdTwjMp6PrOuvAJ9mUzpK5ny5Y4MM0fXjkwzN4BE8667CYJzM6TScs5uMsomESpAs257NsSidJnI6768AiPsnmNPSTOJ35MVsEPh3zqZ8tkiidsDkPB9chmWcLGiSpH/Jo7MfZdOan84WGzyxD1K5DNBlcBCM3dRfBlW6+2Tq8sCTE6xGopaV6zgrQmC0Sukj9cZSmfpymoU8nSepPeRanbDoZ8xntrECaThYJG89nCzadTLJkEQc0zKbJdDbJIh0e4a7APJtnCZ/58WLK/DiZLvz5NAsAsyxMZmMazKctKh8Pk+HcDyM/PIpJHc3SR2S7NxnndEIzn6ds6sdJmPrJhHF/kmZZxMZBNBtD4Ijuy5uNosk9oNx9vGs5Jciu7Ym4G2At92a2gK0BhJNjekIt2IDzFx1ltn8k1U0CzKAnaDB4z7q5XHW4z5DsZP/Ndn8/hU4xkJI1ERkmTuR9OL6Mx5fxYhQEgR/MLnGn1Bt2pPEk6DTuheqFwWQxplPqT4JJ4seUTv0kG0P0B0tZyjlLeJcH8DBhbB5PaLwYp7N4EcyzOQ8nbBqGcThdgDfAdD1NwvEkpJHP+Hjix/Fi4SeLeA6cIKFJNIunSNZOi632XjSe5nE4984Is/YwzhpnXhcV2IO9n67gLcUtak8Aht0sixqia3RE0GI8DcbzMYZP5tqPZQLCzZmhA48fK8TFbkVrBvnHt7I8MKakTekwQSWuwaPBojV2aOXIOMmYlY77zTppccMW9M5ueZBegl0Q3UUzi4YckR+NXIev+hl6MBGT6IXvG8tG28DJuxtIyhu27t6bpTdozxxM2ztoPj6t6WBi37A11Rzqk9bARrEDAbgbOMH3KlZXG56KTLSKVbN1jNvIrBTGFmHnlkM8bOvd7ROfPms6A6TsESC66KMIFsHhVvcdXEh/RAMDmv7BwODCa3qCTl2u9nWdmp5QpTY0/96Ffm+cI22cR3s03xS6m/a0kRW95SSBQBnGMTbigiR1hbExqgI/ITZwsiIYreiQmrseJDei+E0CPqie7mcXHRCutFur42YY6utQVO7jOlbQNohbTGbZEc9KN0j0JJ8YfGLXqjuMDgZrjcZ/oWZTgzIAmRlXIr1p/vizzAWjO/P3UFTNRuYi3S2/EsYGPN3dMH/UI31l0MwpI9E0LWua3+/L5jZ/0apSBxwKMPC7928R+egpgAGAPA7bvuz4XZfJaUjVvB/2uu4EAWhHBL+JfWNM6scgsGkmJ+GgLnKxNkFi+5DZUXWXB5bjGCwa3BNhMZaafTAyrCFhcmZbqW5gdY4iJqE5uHofd3UORCh/RjX660Y2vRyGIM/llrMReUGgExOOosR1oeWAQtouDkR/COCqy+GqB6eEPVhwzPQwkhQJV7eKAKk3siDOMMMswqrH76hg/nux5v7bLMMqDt2kiscl6NQF7NFd5W7f/200uG/gs3YCvo0wR6uKpquDJ/5EKWkoiOdJdywIJr7G9N2iksYiPxzJBGfA2KAeY2AQg5suR+Rl8xsFeogyExn5VNaFe4KXZg0/QSPUd9Ct96lrisO3JvQnq6u6H6Nigw8exe/Wzg7SZwiIJjJDqxvulgMTGMThPcOBfx9MMt1tZHz61rNZrbgoSSZAZ9ZepltBMQ4gy/x0l+bc+rswYEAPpB3A9/YkC/PQnlHwnkKuMKtzdNUM+2ks5XvvUGJo200dO0z3ulj4k/PVBXGtAoyzOkUqeoEeW+1U1z4qBS2NfxbnohvbJGwndPj//sd/Ap3H/Aa+w7IaCW+bU6K0Jpo6jAtEBhwBsuUBgXWJnsWEKqFGxAUZO6S5klrlsEywhV33Aanf4BtHoIFy+VrWQNe20l5yWQB50uENLi5x8qmsy8qXJYOQOxuXotumK5GzJhFCliSh6Q3BCgojciXX3EnfMKkTJJe0sE5hUfad4TBgyZE5wm5zgRmyFD8G63HG+O8UpPVtmI+LzGMBU0cZj7E6aavxMDuQJebQ7I0JvEBjHtKIcBAdGoBnd2iaTc2lLJe0Oo1Um2Ct/Q00Iq8EwkcdEgHA2sCcTrQXGC2NmAX0ADKmEIgLgtk+v3jzURD84o32ino8LNCsfTIEuTYp12W1NEf9IYzF5db9ZYG+ienbRH+s3eiHDx6W08PYrYeHtvdJKRjjNpt8t79Sb64LWWozXktnjcSgGa59eiomDGhnYaZllTUcXsYzSLDlubZl0qJATVXTdoDjlO16D4r2OIVWnIuiXvdUJNGExTgq0n2bNsL4Ati2F4eUOFh8CVnP/WM5oO595YRfNNPFEZ1JNy4EkXGjqe/Rk1PwYYIzjQrvrtXpc3rgmrmxg1+/cOHUJTcwzpKqZUvHHvsYGCrahpJW2pitYXPoZyU7glNv5l5XAFxqEL+ckFyI4svSiC/ACjjjJc2hBNQyF1ibq6kJ1T6oGYwCYoyHlnwmKlkuHQicnkwrzOXsNBnM6hswTFsJEc03MuuQDu3ocqhqT1wCgt6Z4Z4E/IIxYbxifVEO0nQZr6jIlXOOG8HL7uR+UcuHqz+QK5xzKO1pkixokkAKZDc7Rr8SStVN+PI+4CPyQleOQ9s76MC3VBiNUOtyn/706j15fhs+dzH2vIOtT1BdqhN53bfRHZleE7WMAbhbHQWt/9B5vebR+61IsbYBWZsQaQyVznf7hq4/yy2RWWVyyExpvFTmOU8r7bcCzwJk5aDLyggYeLT/5yQI9AD5jvj/m3wyg3wy/rLNOQUTX795d6VzUYaCDk1+DG5MCGQ1cP4XLthAhMuAF5SqfW/0aal1ncRZnMqVmcqrAosh4tl8CWk3P2hZZB9PIA51sZDk4lrvdJ+Urid7LVVlqmA2WGqogmnZ6mpft9FxLR4BLW+RerwBOgkGVpTWzbPvvg4bCnTK/yJslHwtqgqMSd90p/zYDPMbwo5jhXZMEj7O0jezvNeK43yJbVPQdddLVFGHzDg9jGJrrdDqCcmOd76fO2rd9TbhGyswotFSp0Q6Y1sHAYZUnWg0f2G6sGUsOpXq9iwVQxq3E9LjQrM8TTtvE3Hb2D1bps9YHbSBCr39UOb1mledQCAXfgXQHKzfYyWs4zC9KTZ1pQWXJubIGcL101b8c9WUIkNHmTlxF7YSckmZkO7m0cvvv4aumvyHo0oyWHBsHda9N4oDHwWzqtz03Ccfmg047IF6URBsAFg3H+OEzV6S2i1NcAYj8hbY/1aAqRS6GwrMb8py984P1gQ9tEXMcpnFsVN1ENbUqnUxh+fuQCX2o0TOJsbbMnlnZFhsD1UigdouVz84NrjDNeD7xUc3JU+xxI1bSobmW7pTpORVXRbKnMcK4jRKrHFy19QOO1bK6nhB+3v9k64A2Xc4H81ocNLpTSqg+bw9NnvlEV/qrDo3cks/2hOK7o4WgzxFeXLrRUKoqY4kqQsQIXQW03JlAi3a1+bFJq9V8/aWlgIhg1NIscjXqeqRNbK2UzhQa2ZEXtd57qOa31qcMaB5HPyTyV3bGLl8RN7Rsuo3Bg6jNrmotH8L1JXrUtYbdUmqlVS2Qit0GQV+tDCdUuxS54z12yGySBR0mo7IXwxCnMF1UJHJsKMVucXsPpquzCdXBnE9eNuKElMt/zeIAa8AiGVQfeFAyYu2JubA4d7fTr2qnqfscbUCeUYbQ0yJ8b0SQUeE+b26XF8bPuNU5+qnv+JSHU1Z28cIYv9AON7etL5B6X+AgDFeLA8Q0X2If8/F/T0X9/dc3MfJxW2HRvOhGFRp9shAXxY0cjCIaScUMj1opuuepO+xJ6J7Im1P9mQ5PsR+zHNDf4bVqD3gHF1qP1ToMKU5zOq7/H19YCaucmGqv6F4gcbZW16CWcJK06ZonA4hyeHipru9ErAPK4boYBb7QzSZPnWS7HBJ2VM8B1hh34hfB3gFihxwHJpFM+OZioPAOZR1/R0sV/vNgLGDgZrKdW17jHvRY4+0/nNfldzzFwZLTcEFUhAkqnsfOAlbnqykvMEVw2hvZS3upmSjlSsf8XgM2ksuDt1sMqSOuTly5mqB9rYSYjVAMnQziU3sZPNJPFlk/jzJJn5M55m/CGYLf5yMMzqDnwver4//r7TMTyqP/y9U3chc3Yi2Rr65AqSbYzdOpwsWRXOfRpPAjxdJ7C8W8dSPYh7zOFrEDBNwh8rh92vL89VYVWG3UjdnNF3MIsai+SKeZCmbpmwRh7NonKazkA6WmT9Qyt6t0HpamfOjxef3is3fV33/sevSZ0HCJ/E88Gc0nPjxZD72k4AF/my+SIOIhjTj3czqMA1mUZSNebAIZuE4mdKAJbN0vFgE8XQx5kP56qdtsWN16UMaZpTGkR/NYijqHgd+EgWBTydsHrIsjGkWnVyX3hqUwMFXNSZarVvL8lht+TCeTKcBZ/40gyzoKAz9+SKc+OGcR7P5NFoENOpgK0pZnITz6TQaLyY8mYyTNJsHbJJM4niWde5AOCkp30mZnk9mGad87MdhzP04njA/ieaJH8FFENkkCCcTfjB9PDTp4/s1As5OKHeKxM8OFom3I55ZJP5cKvXAnWdjk6wvbxhlkT9GlB2KyjRfu8GuesM5qcHTdD6dsGw2j+dxFC6mLA7DNIyn0yQIp/Mp4uf+svjhYj6FDGZMJW8scvZahcEy+cdu7eiX0Lc3HMVBvO9B/kFW5LWsC0Z+KQj5pdCx43iRJUfOLmu4H4xJDEWodGHHEfme3nCi6lIHwTVVlVEZF8gUBRv9grlycRTtD/tTsSklpICjneSVLgVtIRAK07FWdLPhRcuSE8nQRosXChkYoaJsRUWhCC9LWSqi6nQF8QefRIFALGlVlSKpK75EVvkJA0WrdpYkAxc5YbW+G7Jov2wu//zkhPu90sO8pBW/lqXg6sx4PwTTT5vPn+moQeMqhNo62mcPyDvjcp77sfs7cvvI7fuDXNFNT3g/QMI8PyM1Y6/X5Q3fobqCUO4OjIGt7lWs2lTY7Yqbw4ifE5mmWLD8/W4DognGzwlFbviOCOvX1TJts4bPmzvNSMlzWjm3ZEKXOh7FQn0GaJgeYsJfdE9YU9Z2ZamH2WXaKCsgDxdUDhN0Dfd4YRhRDZ5U44bS7Ve0YJjlKwq9e51LfTGwvRlIKPKpQMK21Ov46cKJ6dXlbc2WJ5ToluSTaUrMIu209cNUr9cvETVrOG+n1Ex6Z+drdiOhiawrZ+18cs0LCD+yq2a6tshQdZnRVCMEtKGCYe16A0VFIQjjfofnS3u4S57zW1pUOngDSmrrDbKzPkjNAkRB8EyjdtW3zUA1MaO8XHS6QPgQVZ/0/zG865PJ1dBPgLt/aqoLW2YyQvGYd70YB+ayrvNKwMVm2KNormNuDp59vH/Y7JsHZ1vBbZp25B1KXDYm650zkqm5sT/2rol3O75rfnASUu3VCWDxardNKkvtMGYQNatjxFsE3z/CT4X4G4QetmEfjQseuxkZD6xgS3BEH/e66Xb1ZlnJ4w07dG6oQS8mbb+JE8vwvdn9/s+iWvlvC+5r5qdtEcOtvjd7RzeFpXF8V7+v+W94zaGngwy7Z1wC4oN2bxRwIdbkCNsYkTcYEr+RSmH96crm8Fg6lPNbnqOV07ARyygasuKlooQag+VTDa6Pwo//Fjfcs06EzkADvaG7RZUSWtxAIi4E7i11cYNlXWTg+WJLm/bjCjEfOrKGB+Z5VzC59PaENc9hc97rGu2y3+uUaTCR2dGaJCO9Bh3A0Hi7w/s+StDQl0x7vx8Tsr+CGACjEjMqcE7QXhJOrPG4qa2NlWxNDitk7WlwbLLY6PAUaA72u92yMUd/ywlgfIUeUNszm3kMAIjOleJ6Wcq6MukPBwAzLZZNuM4AiD0hvwPoj/p7m7UhVBPQZuCy5hBt01INaI2seRbW9r92gXlhHT+QxNoKs+taVa5gMQyYnW2m7ej6JZYMOALhQOOzUfgaILYhItiHE1FPiXUgfexkKbTw8oI1SasHoGyaDMI2jMtXBdN2//bkoAZVrWhBxjYYQRQmq1bDZ83AomC1qsrdso3KKqhIdZTyshXMDkLctj4fnz/AtzoaYX87ngahGebbA2i3Jv8bVBeoJJkSJq5FQ3aOgKssAOoEcJVIddvzob0SKcKq9oGNDbAaVmv5WzpFV05b6/WDkLgeWt8+EE3Vj+a89MuXHICq0+wMyv3CVIrAIusWY0kOpBwkqwYeXVJEcHUAcHvllTGkHOOOvU/PgfalPtyMo8kUQNZ9aB3XwNCWQbHAHIC58cWfsuxN4/PX/lUncOLkHWCKdyx1dawHcetjUL2kBVpItcXdlgpRx5d9pUsYLZGya4CtWKGv0HlEoeKliRO2YgSKFMRAoANbTNWhQ6AVsvp2YDUmZpSkhwC7IBsjsmnXKNjDD4HasMdmm32TrfhGt3EqwNSCKceGgfA1PsP29rhHxJ89wyDwk2aoNgYPQdibzCNC8B5tj/qOCa2WmoQEawUG43KPo2mxYskLDLABq1tJwV23lOgPPwhbv+X5x7TpQOt7rXyjYdFBWM1lVk39gx7831KO7c1xgM3hbYZYJDGrjAP9FClg/6vz8feukaufDPT3pD3GrWlCF1Q0B+VWx4Z8xFgJbVo8Ff5O+6+CvNPTvTDb1q1KAy6H5XUplQJzhx284KgMHJN1TIvzxR2uS6xYicLqBT2QUGqBFcEAwhNQ+jBWhwX3nJNTcMhnuu0jyJxx7UF9RHrzrrmlwQKgh2iOR1bKv/NOgZ1Ho3RY+UsPv6eSG6cb2BbewBWbYE5vYTRFObGYRF7x8gC0S9PLcb39qwAXEBKF111YgK2rpQcqNQU6QKYywNbFWjKRYXx7A7K1Zj4msNZjtNlbbA2AxmQH5ZpQKl7e2nw6fX+vbWRpeF82QCqgljYa7l45Qbf/GgLU7ak91SYTycBpi+v14FR1CaF3J0nXDwX11Wcohc5ZU7dAZiQMAsSqvvztGC6/IWBW4Gpi4SDk4KnC+/tc31fr1/nQM7o36oPXs5Xb8X34E259wNL9LkFLcpne8LJh/mh0g2DbszZ/r7dBYRh3hBGEO3ZAUZjc/kqSsi6aCl696eux9+E8Pp9mcRSv6s23mRRlblj6g6bTA/P4nNyaEN9wWjaoj5jxoIgWwfEeNsd9sE/Yitom3F7p8KjT7GxDS7GsFfor9mUH6OFJqlqBLeJME/spkxIQ1GI6d5ngvVNoQdIgqzoxKQ17S9PY7I6J5nufP8RU13RCbCekGbzVIbxDALdc+Wuh7bjLevizoxlqjCZ0mq6W1arkCoJtl9wwH8/x3/UhwGnxBtbzcWXxAlsAzTZNNj3sYK5kfssJ2uZfvPwzeW+BI5YzOv4jCVmB4HOAa2XhfrQ3xQX5Xt5y8l5CcF1JvqPojnQZplOM7myxqVFfbCc935EuD1BVEGWKBjxpRDosSWjiOWqFdUYKIuvKl5mP702HVs0U1wWtZLkzCQ4nmfUg7vABJj1IaBB7m7QBwOrd1jqGYZL27eNbU7Q3t3F4wOI2oxEMD2rSiMw2KPla3poILGs8aD9JeAadQZwAIJ0UfAudWkEP8syWTKikLhVWeLBH5/DE3NZnnD7HttBEKg9JP0fO3qEuujBICDquC9bB7ncO0HjqsInGwjeeHgtYRqMo8ikL5n7M6cynwZT6s3A2nc/TcRLOFkcm3UsBf4Ds7+aAN/xTU41L0s0EvyCY9T3y+lixUJhI8gdDYfPENOnTEjWI9t1MdfLESNvaxf9kZGlYu7jHjDVo+ztlVxyIOYaEot4e8aC4nlotnbQJCCQwOWCPb5M2CNI6PhRF/gyXwDeD92yCzdVd2PV9UlhzV83Zq/g9bB6boESJ7shecrK3Z1IdovR1Y2An/Z51lM75rNeUALNW4m0pi2uTRb43BtyLc/421yQZCuWVjRXv72Kjna5PsaYW3ur3bOCIuRcdnT+ye8eRPeRh0HGUQsRBLtJjlobBw8NqHQHOD7kenaNjynkpJ7y3NVZpF05PgT/FkD0I1vE4gvduekAbk4Grr9cFYrO1pGzPeC63TnhDZa5bOhjc0Or2D7YmwJA2mq+/IVwbweMM0EzScDJTdOZ+nm9L25zMDnEUI2hbKgUHTR3hdPAev3mQBgIxwZyZrMgn5psnbSZBISEfGypm2VbKchUokZ1+Y+2cYpifpd/dmlpnqbAF50w5fMiogQPyh8WbvVD3wOzw9dkI/xnCwi2duUa3aGlE1rIN1AgaRrUH3Te00aMkcdhI3rM5N+nbUGugqGhaNQXTGApH+a7v4TfkyM5Be0Af3Q7dC35wQDYXSPW8WcfCxdxM4HPDxPCe7qIX9rJHrbq5ZWeP8p25fRk/b1Rjw0ExbEILgNzeJ3uyjvAwId4I77OI8ngaznxG6cKPOZv58wkPIFGTTVjA+Xw8OULSbKWic5XSPKfktaj+fg2mONbc+qLLguhrrwtminW02wKS4aVWERtXs0HCgKLzyJiK2CzJplHqJzTJ/JiGkT+PFpE/jgMesUVKk2h+BFMPo0JvFBV0Rf7Iy1wUDZr0HdCIoq3JXjkNQ1ambrKGG7vH8bidw7FaR0NYjTTq7nQ36HIQkm6W70GIOs0erK3hLV1djRErylyQn7E0FVaDxdQ7zDbeh9oaTRra+8iqkh3oGLWXDkPtXoncyVb0B4Pdu5UR/mgFhab4wW9WYri78H50+MZ9E/oHYSB3F94PDQe5b86/s5LfWclXsBKb/V7Ra4W1z5pgv4+QQKM2nN5wqnY+nAwfKlCVAiuP6CDDtvwKuIs/V7xQTTEDPc/PPqYl+07aqd+p4Qn5hyZdWddFtN8dGrv5cB8GKChgq1B6G4m6+IZiFQEo/NtEqz3/4pZkuXveFilZutGOGCth1q4uc9jfJt+aboROt/YZX2PO9UDVzrX0ujjU/fna4AqvYboHOh7s812JxtVDfW7gNeBAwXUbaBj48MUS7hd4p/yLGrCh61jYVleQJ2+q6uy3bVLDAERACrYG9sFpyfcvajRd+JjjRWhdrUCxtw7MC+8Ko06+ZgTdw4EBoOqLksWPWh35o2Q7pxxQp65PkzTXr+zTvnGr+zQPh4tLOCmEvfoVzQtdq6L5EwtRONc4N/ZRQ2Da6r0rKKLltGzv8XY6b27rbp/pq7jdNrrCR/MAr9V2Kx93r4AcKg0S+8HMj7QvQBfRaLv7VSbwWa8aSucLG5pg753Q224L+Re3+lYenRYKT3KqbOX+tmgwmOR0RElTZxuOCxTu7taiCaIJVA0JoWoIzEu9za54eStS7hy3tmQCZpk/x4bPGewskOd8/Bvcf8p8upcZaUqOVVJX9X2iyCtDzYgNxHvx7g2xtYkQt//D1K6g2sppNtB3dlTyI9QXMKYsi+QGpn9uyQNWEJOqWtPC6cdUxqLuLc1OxdFeEemmhsbR7y7cct+mxCuFQG5+K2St8h1hQoGd0t4T51beNoZsW+IOarOOfil+KVQqN/ySfGpI7qUuefWprT4BlbOfb3IqkHQgqfxiKPoH7zZsCkbrnPbLTqEtt/aUQ9Y/wnlSFXTw5QuIwD+V+d0dPP5bzYERQw2apmgvEFAmUPZmw7XvXRQ+/dHIjc9Iv/iqLVt6YGo2/RZbWP7mmVzgbgExHdPPKZbdOgu877g+4KbqBJa101UnYYvaq9z6NfqxagQ0gEIZWDKiwGsw2zj+C93GqcHyRJEPpnaS2/eZBUvoRvjtBXJ/MB36zuNnWLxW6XIIg4jVCPx3H0+n/+LdG/8vTVRAg+dW7HipkaXLXLYt9srLtF8AJ8NqVYfbulLJu7dX770LD2L+YXHWmryVdIv1qbZ61Z0i7fjsi5fT4rrWMqDuE/77fwW4WGE= +sidebar_class_name: "post 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"; + + + + + + + + + + +Create a historical employee, an employee that was previously dismissed from the company in the current year. + +scope: `employees:manage` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/post-v-1-jobs-job-id.ParamsDetails.json b/docs/api/post-v-1-jobs-job-id.ParamsDetails.json new file mode 100644 index 000000000..230d65c22 --- /dev/null +++ b/docs/api/post-v-1-jobs-job-id.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/post-v-1-jobs-job-id.RequestSchema.json b/docs/api/post-v-1-jobs-job-id.RequestSchema.json new file mode 100644 index 000000000..94347b60b --- /dev/null +++ b/docs/api/post-v-1-jobs-job-id.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"required":true,"content":{"application/json":{"schema":{"description":"","type":"object","properties":{"title":{"type":"string","description":"The job title"},"hire_date":{"type":"string","description":"The date when the employee was hired or rehired for the job."},"two_percent_shareholder":{"type":"boolean","description":"Whether the employee owns at least 2% of the company."},"state_wc_covered":{"type":["boolean","null"],"description":"Whether this job is eligible for workers' compensation coverage in the state of Washington (WA)."},"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."}},"required":["title","hire_date"]},"examples":{"Example":{"value":{"title":"Regional Manager","hire_date":"2020-12-21"}}}}},"description":"Create a job."}} \ No newline at end of file diff --git a/docs/api/post-v-1-jobs-job-id.StatusCodes.json b/docs/api/post-v-1-jobs-job-id.StatusCodes.json new file mode 100644 index 000000000..b7d4e78d3 --- /dev/null +++ b/docs/api/post-v-1-jobs-job-id.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"201":{"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"},"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/post-v-1-jobs-job-id.api.mdx b/docs/api/post-v-1-jobs-job-id.api.mdx new file mode 100644 index 000000000..9702b0d49 --- /dev/null +++ b/docs/api/post-v-1-jobs-job-id.api.mdx @@ -0,0 +1,71 @@ +--- +id: post-v-1-jobs-job-id +title: "Create a job" +description: "Create a job." +sidebar_label: "Create a job" +hide_title: true +hide_table_of_contents: true +api: eJztXXuT2zaS/yo4bl2NXSXOiHpr/jqvH7e+Wieu2LncluOSQaIpIaYABQBnrHXNd79qPEiKojTSeHx1m0qqktgk2Pih0egXGtDX6Eu8LLWRMRcGlooaLkVsthuIrj9EsE6BMWBRL6KbTbOJjj72IgV6I4UGHV1/jQb9BP/HQGeKb7BNdB29/ELXmwJIaBn1okwKA8JgW7rZFDyz9K5+0/jB10hnK1hT/JPhpoDoOvovmUa9yEGKZPobZCbqRRslN6AMd52XJWf2G9dKG8XFMuq10LxfAfn559cviMyJWQH5TaaXEQ6Dsh9FsY2ujSrhrhfdgNLcwbmfYFYqBcIQ/1Gg7YBekncA9u8f/HsulmRZcgYfn6yM2ejrqysmM31pJ+Eyk+urwPR4Q7dKFoV9f8UZrDfSgMi2T0kuFeEil2ptmUekICt5S4wkpcbuuCY5h4JdRne9CNabQm4BFg9jUvgcqd+ueLYKrCMpFFIsdScLV1zBglEDXR3WrXNaaOhCgJ+S2xWIXQy3VBMkzYhURIH7I3Kjms67XhCc0O+HumNRFoUT3D0AOS0LE11jiy48luZeTxvF11RtG2NMpSyAij2u/rICswLl5obrnVFdaOIJWcIE+7uhRQnklhcFSYFoMMh+5C0pRQFaEyoIfOHaoDzhZNi/6AphoN05OerAvBwW7kyuNyC0kzb8/L4ltKHbNQizKAU3R6div0//KcFPQzedOHZmowOD/2jR/OiBi6Cz/3tYYG7lYgMqQwh6RRWsZMFAnSUsDdGXt0ITakgBVBsy+PcKmlxvqNhe7q+ru16kDTWwuM0WmbwBBaw5FXXv3XOxI7IoYlwTKPiSp34l3Er1GZS+2OWK7YkugXC3di0EBPsL1SsulkYK8uSXZ0/vA1xQrReZZMdX8v60Ka4/E/s1wa+PIOWiicn2fEneIn+B3HDNDfnQfn+hyU9I/7mlv6HLhhq/vb29LAS/vKWXS3lzxYUuFRUZXOF60THiii0u0FfNv8S5VLFHGDcBNlrFhZSfy81frp6iHiiAKkHWUkE3E5tEdEPeqFJ0G/UibmDdfF4Z1Q5uwkaBBmEqkW+z8D+t4Xoki3yQ+B/cRv8m0wdqJlyYO5Z5h4XHTPR38QtO7v2QDTrFN5BFQRWha1kKQzaUM7IBtWM3nHXutEFndWVtEM28jkW52BuksmrjdYsp3FpoeStA9ZzB1CtZFgyt+cVbus1WkH2+QM6AKNeo2v4mSxX1ol8APke96I0UZhX1on8Axafhi+jjXS/KC00XqI5K3TWsQPDlF1hvcFW/owVVHBj5QQoID5t//hFhRr3ouVyvubYrBPlCKgrtF/XHnSr41d/fPSMOoDfSXO8w7ZJUmJ5cuF4unlbM04QqcPNKSc6/ACMam28J3IDa4kTjhHPJGnRuuVkRND2Gr4E8udgf9IN66BEqGFGQAb+Bmj42sN6pD2HSAi4JzmCxJU8u7uky+C0rWSrrCW6tgTqnq3pCgDW6eHLRPYWIA03GLV2CJinV6EDja2uvwxctsm2OHhSCbuoNwueMzMoijsT+4eKpZVs9QrOiBpdV7QmZWxDGThd6Wm2viERVPBC9KjSN31mxjN/jokElmOeQGX7zTcFKRcSFLQdE/pWf9pwrvetJ9lxzH4Ro6+o71X7hwh1Ltyu2OaasrWVohC1tQEiOst9KbRa5VIs1F3xdrhc4iyf4qK8Fw9AdNOEdpjsLus51AAzH5HuwckJYicCJt58ko0VWFh5Yh7looutyaU6YpWb3mlCtZcapCYLeHsLlMT/pMVydJhw7Fy3GHyFjGejM3+VpQnyvzHaDwn+Qt7+X3AYPH9xYP/aiLzG41I7lgC6zDLRuGCXHk4ilIzZKYBzPkmEWj6ZTiNOcQjycMTqgMIYpHUYNZy4aT1i/nyXTWZpNh/NhOqCD/gTYhM4mNM/SUdT0laIsyVk6SqZxNhzReDSk03g+yIfxGCbZoJ8lbErxi5anE9EpzPJ5msV9lgziEYwncTqdzeN+MhiOxpPpbN5PouCiRNN+v9+/7PejtkcRjPOOPa7NbntWokF/MIz7SWyJH1x5Xn5bAv/hY63H3snc3KJafCmWXAAolIGVNT47sW5jHmCcT+g0ncXZnPVjHGaMj2J8ho/wyc48zGfplE6yMRvBMB/QJO1nczaDaT6h43SUDXfngQ1gnM9oEqejbBqP2Lwf0yFM4nyeDrIxm0HSOQ/pLJ/TfprFCQyG8SifTONsNnf4/DQM6nkYjDsnwftNu5PQ9G6+2zw8CyokaimoRdB6jRmgIzZP6TyLh4Msi0dZlsR0nGbxBPJRxibjIUzpzgxk2XiesuFsOmeT8ThP56M+TfJJOpmO8wFl89YMzPJZnsI0Hs0nLB6lk3k8m+R95CxL0umQ9meTmpWPx8lkFieDODnKSVTh+4ysZZMB0DHNY8jYJB6lSRanYwbxOMvzARv2B9PhLArqMZpeDsb3QLn7eFdbSvRd6xVx12FaCpkdTw1hrgGdk2NxQslZOzC60NatI4G+VdXhL/up8u5omwpCGVOY8WuGw22DFAb790D+fg2dKUDrt6DGLYlx3J/E/fn7ZHg9Gl6P5pf9fj/uT6+tpJQbdqTxuL/T2PteQTST/ng+pBMaj/vjNB5ROonTfJjEyZhlLANgKezaAEhSxmajMR3Nh9l0NO/P8hkkYzZJklEymeNugCc9SZPhOKGDmMFwHI9G83mczkcztAQpTQfT0cSqNW0UgFkk0XU07PfJUDHyzj6q3w1wPW+oMjaEHCYocRk3W1S3VJBXmMnhOpORT1GhYD2LetE/+Qa15SjpT+3IS2EwHxz9/A7fUiuiYQVsVlLAQpTrFLOA0azfnw8n/eEMR5/zgovlws91tWZox+O7u8dxQIIohjTIHz/LsiuYJ/MrxGv+892ER8XFkOxwwREXWVEyYME7bjdDIrQ7dxsy6DvS8qC4xJIgjkQ1ikodkZ+8X2dfhcGF1zgQS4sW9n2V2agbRHfNpXUvwrvmYjt9c+YuLMTTOjgtirvzK/eUhtWiPmkO/D6SVQB3HSv43sDq3QYynvM6sKpEx28b+Zm60MQTDxbiYaJ3t6982qbpDEj5IyDqtVmEk9CwVvct3BfUgE0w2NQ/JhiaeD0lJNq0at9G1FOyIbXX+fdO9Hu/OVLqtka+JK+FI1OvNrKiN0BSAEEYFGCA9UhaGrKmW6IN7hPaBiuujVQ8owXGdbQrzF13qhsu/iWBd4an+PQk58pta+1sM+zR6kVNP8oXNOAf7RZtM9adsKQ/HEM8o4MkHkHC4tmcjeOczuajfE7zfD7d8XNYH6bJPBlO89k8o0PGhsMRY6MsG4xmeZ6mHRHTfDRjlGbo4YzH8QgyiOcwoPFgMJ/NZzTL0gFGTEd2PiOgs7SfYpSVYPCbz1mcpvNhnOb9wTzNZuOhDUS6Q91qw9v5J1UklFklSV5wBZmRKuraeYzc3vqBPb7qbWvzqhEnnAa8EcPOR+l0PE4SljBIaTZmUxgwBhSS4WQ6z88N6Jvh1mlz3RV6YtwZD/qN/MKsyi+cHYzefewi0yi+wB77vsc7n88Z9Uf7Ov4HacgrWQpGfhWE/Crcivm9BJu9U6BlqTLcewFNhDSu3uCSvKGfgehSOdduo+QNR0Vv/SausYyBs8tfrQofDQb73f4sNkpiZIIBFnkpDDfbCgHXVkus6GYDoq4GSSXb4vLdylIFjATLiigXmoBSUmmiy2xFqCafuLAgFtQYxdPSwMIu3E894h2iQCGnvNCElXZHi4r6S3S1rTh+ajixL103z6mBpVQc9JlerIUZZ9XnT50vbM0L7uwSBgYBIfPOKJq6n7t/MrfN3HYw3TQCbsDolu6GXP75GXvre1QXnwE/8Ci3B/qwre71TmoP7XYFfjHaz4nMslLpS/J+u0HjWmxdUPQZtoQzEMZ9he2rObzaUEXXYAAFoKA+e1+RdKFUQH0GNKSAbVG8HCVb6hRIBe3hpYwslSw3HN1D3D3KKLqLGNVZNGnJC0YylIO1b7+iglnnkwsnvY1yRbtBW3XENfkkrGJbuHn81GtEqq7qyos8ocS1JJ98U+Inaev8EnAqy720rFnjejsllf82jNdLI6GpLE1j7mKyBAGqnjVPOjBDlyqnmWMI1oMJhvxRHoWh6EjdX+bxPCxuBQXcUGGcA2ZkEJCtX8neBHBB7JpGJ2pv+w43uby/1NshYfFZVn1y/18gqk92bsMTNK6fqqK3YEzQL5MCfsytM3B8LOuyMBwLTi1FXEethRce7y+28ObB5TKai2XoeWuNOeMugH7b6Mmngvb7dgy5X2p+oOtqu8Zz1G6K1mKTSeXqbRlGVm6HqGbw/T38LPjvJdTqoc4dODKWotPeuZLrI8F81a7cLIw83nBHz3U1aMX2+00aSd83XvrjX7hZxT8KiJ3xi+4Ot3rjZcc1xam56/0553+EObdB3CGD3Sp6ROVjSyOsg4sZiyNm45K8Nvh4I7W2ZZFGumi20kMF3EBh42RvRoKhqNRKlHGFW9/qiYMbW+cn/tEK3NOoOcKOBk6gd3P9KRWfF9SFZAsXcy9KkZeCAVv4iGfHifmw42tEWMHRdEyuoz1nLWqYuehVKRgXyzdgVpKRFdUk9Eaq3uwc7AC7AcXz7YILK7oZIt1IzR8V2T/QDcBeie8VLSdGLykQ2z8HVpV82gIr56Sgx+rh+H12NO2HhkALTEpsF4Hidx0Astd36JIq1Tg6ANr6G7FcKFliofgRYL5FyDd3Qmw5+TtAf3Lfh2Qz1ySYXY8rRNqZFDlf6gpa5WuexbX9r5tgnoXaIEx/187sutSm6Vh0Awujzak2YbUsCr52NYQHEHY0PpuFrxBxKGK0NBo1g9RztsK8cPVpNV4QrCr/OICyatKJrZuXLwVzFSL1yrERlFlRQYZkjXWKdm8yL02pwOELGy1csFIbtV1oKDARIsVCUJ65nM+idswOIq5bn8/PH/BbVwO+L46nIfTdfH+AQTTh95IWaEUmhPElr9TOEbg6ANAnwNU8c23PR/uOZxar3gc78mAdVsySL2SeLzay4Nl2Iej6xLleP4iJ6675bYMohV1RwKr1QrNMlbRYqONrZqfZGZr7mfvO1f4GjqUFqnL0rCo8xALkoA8A34A1rgufSDlmHVufnoP2uVvcDGz2HiE7Gi7G9RiI3f+QeR6yOocwV+Wap0x71fj8uX+5U1t7sgSktMBzGQu3afMga30M1XMqbIbUJXOJ700fn/aVLDhDrY7/OsDBrXAnux7RqXjut3qDG2FdCuIRuNpni+AwNCHN94NVpZitJ90FrEc23mWze3lo5g9CrcxjJWbfRRRfuzb1NjmGXbqRw7D4pEglVeiGh3aPyb+whtHhJ1VXFSQHYW8wj4jgvc09uqMPLiz1Z8BCFhiTyy2L5tyKBQjMH6ETZhTFLaSFtJt8B7G1W56/TCsCLt6r/RuHxZVFVGcsHd56wQb839OPbY2xw8xpQ5X122luQNlY/xQvYP+r8/n3tvKrLzroXdTLuE5NuH1+v1BuwFYvf7Q7uC61eCr+nfbfhHyH0r2YQ+s6pMEth8VSSa0x3RE6F2CDgWO+jm9xvrsDNkaoPIoQF7QgWa8FZ8SeMTmBpQ8zdX+zJ1jqlSNgSXG7s4XGr/EM7WDxiPrmbXV4IABwXVTLI1fynyAWHsejajrM+vju90Jyv+mGuYXXRrt0eo3R14rgDhktDKgDaBeeyvG4/ZuAc01SsKcwAuCw1dKCalONWOvD12FuS7GWjOfcqu0AOWQzHxNs2DHa7E22A+A4ucNypyg1qBuvxfVWG1hXjYIOb/sGVgvohasmPMFPcO2/RQHtUqpXtSA2PelxrukXu+3fwqlLtcETxKd41w+F+vILVugCIx4DzkTS71uuujPJx3j5HYEFhyvEALbk4Im2x8qbe1/1vs6HVtK9Ch+iVq489B/jX/Ewgq0obyq0tJDZZ1CV8bdJNyxDPUv4W9Q6nWErEd4R3skDckGkYng8XxJVirA82sN3fe/jPD6eanI0mHLzfQZFWfPk4oOG04J5fEw5MNxKXRj65XsOC/1C64D7/oihX4jt72Fj3Id9gii6nHB90uBRh7kjhkFjhSz0N8jlDujuQepSYy7izBT7KYPiWNTiiTeN4L1DqCE5yLpM/anXvampcnbHXPO9zx+SqquIkECEVJ3XMUR0CHBtlb8V7c52WYt/oTevjW0KnWarhVkp0HhXygK88Yka+3dtBHZYUGE9n1eBLygCNm1zQ7k97mMlGLQsboDY3Pyz538j7wM4EixjY/9ISm2TEfa2Ezy2+1r0yBt5A+S9xOI6RV5Qux3ZNJiNIxZnu01V+BKItPaObF6MGoMFjDaBJ71LR2hdz1FqW7EtiCxNLPPYvvcEQ5jJl4IaqTC1R3lxWlqP8uIhKT3Ki2ag2wYQ4u6QHVtRvajePn42xe3mVhseOLlVb8SWB1Unzb0YKFjjjNut85A8qD9JIUdiWCeATCcCbpFocPTwKoIF4zotlQa7mVTvWx8YWLP1GauvkVuoimC7vJ8ja+8QiV0MEutZS8F2uPuiAdquOtvEceE7D4/1WU4Hg0FMWX8Wj4BOY9qf0HiaTCezWTZMk+n8yKADtbXd7X6I7+82+Nz3lf10WuPaV1CTF27zuUee46b0ZdTmSkDhi5QfjMKX8XvV5zxqdO03uygvvLfttvgvLoMOqyf3WLLG5v5OkYoDNcd46VtLRqKcC65XC5/lROuKhQTO9foOOWnPIBfjG4kr25C681ZOsDpRaknf54VVR6jOnsU3KDz+cA2hxBEKZ2/2ZCZzJUrf1ocl0qbsqnTON732ZjCuQ5b4VkmxJD76bveBx7XOF3OnkkFgrB2yeP/kG7fp+gQul5fEHjZ/2rHEmufvzu+5efQuLPKkv7NRihUHBc+OZRo6Fw8rXQU4HNp6bCwdf3RGN8p762SV28JpBfCnJLI7YR2vI3jfPB5Q12TY2XfzgrXZzlMOa7yQt43yBuNPAR4sbqhj+wdnE7DLUM3XFohmjuBxOqgG6S2Z82H1/TbfNzzdHNpevKMdtBQuNH3E0uF7+82DIhCsCQbm77G88N9c1CcJhMQre9bcmNBKB6uSUs2z7xydU1vmF/R38Datk3FeCCsAmG7YIR8GdvgfgW/hnpcDo7Ovz2b4L1gWHvTM0m6LKu+yqrpQo18Zqj103zFHbz2Jw0nyVs7ZIcAcPrGV6ZkhutxspDKEWeeo2LZ3+L06CmNwO6CPnoduFT80IPtzja3drGPlYngF1OJhBS+v7PVRolX2sqetmLUP+SLlyl4kd2YvL/ylQPbzKjT2FtSWTTgHEMI1JyfHCA9z4r3zPh1QGE2SacwonccjYNN4NoZ+nMyAjVkfYDYcH1FpdjfsAUFpUVDyipt/LjEVx2zFr73Izd4c525jEszf51aLBd7aK12IWG01eyZ0BDqPzKkBm6b5ZJDFKU3zeESTQTwbzAfxcNSHAZtnNB3MjnDqYVrotaacrshfQRVcVGxyVxNZFt360yuncehj6y7TSoXeU7N1uFbraAmr90abkt4suuxE0r5j8p6o0TZ7cLRmb6PcjRjtpYM9grdGYqpJmJU9emcPsu6jDkmTSvc+cqhU3f92RNvLhkHdvaln57Ri3FnsvnsY+6/BUaiOYv/Legx3veinht24b0B/EANy14t+qCzIfWP+05T8aUq+wZSE0++V9nqNY9tIbeKbJP5Nphr/s7DBXeuApKsytLdFXP4qfhU6kxu4Jp/wo+tbxQ18sncJ+KDWscAuzsY+tyXMhdU9dkHVSXR3Pqzxyxc7R7U6L7PouonZLmHf7f/E9k6L+Nnb1/F/V5sDtvsVUGY1Xg2g8wahFziWNRf+5C6u2dhd7vrs7evqkqf2PR325C02wMPG9titQEvF61rInmvTOMd+ocmHcPNkg/aZh77phsf11VJ/8QTjxuOn9qoW7Y6UHmJ3fYFyuOcsGbtrjsPVPo3nd/YCBhcQ/FUym59oz+sDz+7f+5snD7kKNrrvpzke+Zc4/o9/AuH/+y8e/PkDB+f/wEH7ih8nx00xPuWOnuBj/gRLd6fZGyro0qrBvdtSkkE8SMLlt0dMgZVwukR1jz9S5O4peL5zfY29KVdvgH4GqrexvdIgusabZPQzwXbb7jZFPR6jYClur8dxpe7ut5DgiwGhq/txnJk9+DtOvcCFe37PCa1HINWGXNHoht796e4QahL1UFB7+o00Z4qtGTWr6Dq6ukmuqvKgq68NM3p3hRhQg2OBn7e2pSrQtHlJpRvuzEXMYG1txv59XrCWLZY7erHbJcTXOKwDhDtpvlV2R/AQzQ2+xiFryEpls9kfvoZo45m9n/NZiYN39/qEVu/QQDjJ7mhbaVKEGMya1axAlZXv9m0PlkRsDyYTWpoVZqND1U0vemdLJb+lB0fhQAf4Wxdaip9qk9lYrWGRVkqwuTSrhweNinej9gxA+3nz1qnaxwrlewGE9Z/QHdm5U6ph+3sR+kf6x/wdqBueQUNMalfFXulxZRteMeQIWvDY/h1rLbT/dM8SQZHJtS1BsTguNHnp1y4JVc/oKTGZletwpdm/+YuCqNtS8p7gi9Ar+QmKStW48gyUc//2P2qxtheMSm3WVDToNFVfG+/X2sk51Vv2MmXgi7naFJRb4bOL7atXAR+im6RxBRqivt71pq0e+IjHfrTB9l+/on/6syru7vDx7yVguIFXNt9Qxd0Vvh++YkmBPeDR7fc2x/IkXJH5lBx0ug8MJdwyILYNzRf5Kw92ogJ3csk55efB+4N76J18dfzrDm8qNtf26Lljlvu9h7rFniNef4Gqz173drht02q9/fHd+6gXpd75Xzu1ouitveDt1k162K/D6ACffY0KKpali3QdTfznfwFzNEud +sidebar_class_name: "post 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"; + + + + + + + + + + +Create a job. + +scope: `jobs:write` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/post-v-1-partner-managed-companies.ParamsDetails.json b/docs/api/post-v-1-partner-managed-companies.ParamsDetails.json new file mode 100644 index 000000000..49933cebe --- /dev/null +++ b/docs/api/post-v-1-partner-managed-companies.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/post-v-1-partner-managed-companies.RequestSchema.json b/docs/api/post-v-1-partner-managed-companies.RequestSchema.json new file mode 100644 index 000000000..8fe161da8 --- /dev/null +++ b/docs/api/post-v-1-partner-managed-companies.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"user":{"type":"object","description":"Information for the user who will be the primary payroll administrator for the new company.","required":["first_name","last_name","email"],"properties":{"first_name":{"type":"string","description":"The first name of the user who will be the primary payroll admin."},"last_name":{"type":"string","description":"The last name of the user who will be the primary payroll admin."},"email":{"type":"string","description":"The email of the user who will be the primary payroll admin."},"phone":{"type":"string","description":"The phone number of the user who will be the primary payroll admin."}}},"company":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"The legal name of the company."},"trade_name":{"type":"string","description":"The name of the company."},"ein":{"type":"string","description":"The employer identification number (EIN) of the company."},"contractor_only":{"type":"boolean","description":"Whether the company only supports contractors. Should be set to true if the company has no W-2 employees. If not passed, will default to false (i.e. the company will support both contractors and employees)."}}}},"required":["user","company"]},"examples":{"Example":{"value":{"user":{"first_name":"Frank","last_name":"Ocean","email":"frank@example.com","phone":"2345558899"},"company":{"name":"Frank's Ocean, LLC","trade_name":"Frank’s Ocean","ein":"123456789","contractor_only":false}}}}}}}} \ No newline at end of file diff --git a/docs/api/post-v-1-partner-managed-companies.StatusCodes.json b/docs/api/post-v-1-partner-managed-companies.StatusCodes.json new file mode 100644 index 000000000..a6a7889dd --- /dev/null +++ b/docs/api/post-v-1-partner-managed-companies.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"description":"Object returned when creating a partner managed company","type":"object","properties":{"access_token":{"type":"string","description":"Access token that can be used for OAuth access to the account. Access tokens expire 2 hours after they are issued.","readOnly":true},"refresh_token":{"type":"string","description":"Refresh token that can be exchanged for a new access token.","readOnly":true},"company_uuid":{"type":"string","description":"Gusto’s UUID for the company","readOnly":true},"expires_in":{"type":"integer","description":"Time of access_token expiration in seconds","readOnly":true}}}}}},"401":{"description":"Authorization information is missing or invalid."},"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/post-v-1-partner-managed-companies.api.mdx b/docs/api/post-v-1-partner-managed-companies.api.mdx new file mode 100644 index 000000000..2fe7c6298 --- /dev/null +++ b/docs/api/post-v-1-partner-managed-companies.api.mdx @@ -0,0 +1,80 @@ +--- +id: post-v-1-partner-managed-companies +title: "Create a partner managed company" +description: "Create a partner managed company. When you successfully call the API, it does the following:" +sidebar_label: "Create a partner managed company" +hide_title: true +hide_table_of_contents: true +api: eJztXN1uHLlyfhWmc2E7mJYl+U/WxcHR+icr5NgWbG2cA9loc5o1M1x1k70ke6SxICDvkJvkKu+WJ8gjBFUk+2f+NCNLF1n4AAcrT5PFYrFY9VWxyKvkMh3X1ulUKgdjw53UKnWzCpLDswTKIQgBIvk6SHQF/uuxSA6TSluXTvfSihunwKQlV3wMIs11WXElwSaDxPGxRSqvmt++DhIBNjeyQkLJYfLKAHfAOAt0WKDDPJ3ZDvs8AcVmuma2znOwdlQXxYzlvCiYmwA7OjkeMOmY0GDph5EuCn0h1fjwi/on5ulbxpmCi0iUScX+Gee82KK2YFhtpRoTscroqRQgGJRcFkyO6FdqRAMq7RgvDHAxY3AprdtBku/4eWCGWnpCsuRmxio+M7ooGBelVNI6w502THu6HRZ3vqgv6lgxA7bSysKARHAhi4IZyEFOgWleuwnjJBTm9Dkoy0baD5fTpESf2ruTDx9Pj96fHlITA642CkSkwJVgBkYG7CRS4wabWTBTEIG0tI0QtSpmO+x0ArgaCiUxpAkL5nQkqt0EDGt0gh29f80qA1Opa1vM2Nhw5agDjbeSTHdcmstf2P/+93/8J/s0sw5KduRbHdVuAsrJnLT0i/oLtqOuoESlpXJI1y/M2S/ADRjqw2w+gRLYhXQT+miJbFrAFIqegFFxsMGvp6cn1FUb+Z1GYxPgAszXhxPnKnv4+LHQud2hjbWT6/Jx3EhpUAD6/jgM5Id4lAwSA3/UYN0vWsySwyv6pzQgkkNnahgkuVYOlMNPvKqKMNPHv1vcS1cJzYPjX37/Jnr4O+QuGSSVwd3rcAseXiWolcta9bfmsRppU/rZRb0ifb6YaK+JQ9hAt2PXrnKHmfqpnSUjaazLFC8hGSQFb/+mXYdGo89/p307C+uMVOOFWZyiScD2DNvHnbb5PHaS6y5PG42HzX9kOD/tjYbydul2w1QTrTacETVlqi6HYG412vU1ai+t/jLN62oDyXlhzbeQPox50RN/o3bXg8QZLmCLtVxFB6TadIWqQs/AMCnQOI3Cpo3CfPjm+P2jZQPgXjc8d9pkaGk7gw21LoCrhdE+T4DMbYcSGWlm66rSxqEJjTTtDvs00XUhcOEsODS2aGOii4v9JxydHPuc7seJgN1hxyPyfBW3FsTAK4CAEa8LIjTihQX2UO7ATo8YtQvMsKF2ky5D5ICaMR6Rzlz3NYPsVqtHX3EZLnlZFV5F3vi/8c8pL2romrquyUjeGq7Oe6bmMPmQe5GGvZeMsM1fA3k04UmzYZL9J0+fPXt2cPDyZdJX6y79B5YRzQH7299eJX3F8y3+59//K7RJgj4le0j6+YuDl8kSBSCxXvv/DRILeW2kmyWHZ1eJd4TeD6JfSg7Pvl5/Rel5+EDy2d/dxf/0lebDvyRb+JW5vrR9WyRxgVCNoAfip5WYDoWx1j95f5iRy715kx11HbSbcIc4ogER6H4+HPWQEukkz3NdK7fDjnoACi4raYDts4muUSdHzm+oGYEhaW0NwrsvLj7QquCuIT0l6LQp0x+7SKvHNVzmE67GgXWPSrsYZOnoQbJZXUtx8+CEfUn7fvvt+HULGpvlWaDvxWKzntGjgIF25JzVk95kdpfRC9ZbPqmYhVwrYReHCsr9dHdvUd36gEt24Im0rJSWULs2TKopL6QgK/p0f3+R0G+qMhp548MC2BvlpJuxL4qxL+oU4WLJ0fBVFSiv0iicoRYznNRM14YFmEbmi0tUG2PQhNk6nzBu2bfAQsadM3JYO8jIIn0bsCDrSGHEZWGZqIHQrmp7NtHWtx32CbxzPXvjh3nFHYy1kWC3xJvEZpo33R+xcS0FkAaU2gAT4JChnS/q9lZhmXR/CndeuOsQkJ/wIgYKv7c7kBvDcb9KB6W9CVdR7+wcsEPgcrZiDGp1oxn5VEEuRxjWXUzAeClSd6bzvEaIcTqrJEbqMx+GncOsQUEhDmvW8HHFDS8Bza2BgvuosCXpIVHkegvWkAK2RfXylDBkZZFUjPCDlrGx0XUl1djDka4jcZoNa1kIlqMelKH9hCtRoN2RymtvJ4tCOKkZSFr2TYF1IDK/jt8GxJxfK4+NgsqT1ceW7FtoysIizXyQCt5k+Y8kmhL323gDTHsS5xu0kfGhrl1n7VI2BgWmXbVAOgrD1mbE8xCeKwytKRIIXDguuFsags7lfeLmNlDAlCvHsB/SDAoyCzvZ6trkgOKlPY3WnsxGsEjDAnbYW21YQGqDHgnij0T1zf83Q66+0drGX9BlfmtimJjwQS+rFXwYEbxaP5eyLpysCvBj+dRXb+PFnxc3W/yyxZbuj40+L46M3bgQEj/x4qQzks8eLBnbC+RmrXnfiYKCRAmztGqTa+PBpkCc4kOkVsA3j/Cbkn9g+BHNQ5s48GSIorfeI6PLluBZS1HVRUFRgW9XV5nT6xv27NyyBtZxB+uaYEgpHUYdybug/eln6SbpBwWpd34++l3e6l3QHd8Ul+Z68HPN/wxrTtHpKoc9F7ij8aFInXLIGIOvcRs77Njhz5W2ViLEcppN+BRYY4cocWlx7YIbiY6iMStJLk1eF9w89OymBH5SH9A9SrozXNLAK/Rl2g2+h1ydZyGoygQU4CCr1ahWAkRW8VkJyvVAzFkPayRDbqELTDC8mANrScfNJW9rJaQavwM30YLSFHE01oxGa9BjbApGjmaZVKS6OXJaaSvvlLO/IwzAUWOM2clr0/gSxA47KYBbYPkE8nMPUhCxBnYYL7EjuvZVUwinDlmkeK8TQPHGY44hgGrnsYTBEIllRteYB1jDWGiR+VTYchbnQH6P0Y++f0ylScui2w18BU3Icq1Gcmwb1hqsuZXUFnt3mTlyDJfUMcyUtmC2rK3rAovljMXZjjAjFT8WspRuDYdLGm8twrfIcaDBiAazTV6QB8k2PGcVGKlFyy8okYlgLVdw2TRZyttyWb5RAvEgdHYORVBuwhV7wkqt3MQiJhzVrjbg+Ys5EKlEbZ2ZZRYKyFG7M8VlbrNcC8haYLaS47b19vJ8j30Z9l2ijptxGIa5fwajasIfNS/QizxnQo5lY3bWsGsjA3YDdq3Mfdvtuf0kc+LVLjL7NDDreXWyhEyPRlmlC5nPKM+62VqXtxJiuWx955moFe0oEM1+4Xlual5kZv2e6TXbwnIf+X4M+zUSGxZoyhFZNfwwYlCCXcF4BeRcs5BIWecd57puw+0rv7kF8NzJKbLsafgYN/DAnM8mjmJWZxXPzdHBJsveNN5+7d/EruF4fEMNGPKCqxyyurrBXq721uu4esWVL0YQv9Oy+9Hs+mWf6EIKtOr4f89whBUERO8SFb0KZ0ARRhCkYIED9EBh8VezprS7P7aaag5C0ssYG7AqQDZfsoJHQatYbdxjo2b3oorHvk1zasYw7LKdHAbxp9VQc4MwPLa7S/nFPYyAnzVDNSx5FhYmc4ccnFLuUVpK9lBYGoo0YhYYk8tzHs3DigwU5o+yJSetK3ibb7n9Nm0I+HivxTeeF3/oQ1qOtq8pnJnj/z5x7Nwcl7g567gh3E6nYxTrb4ICFnttL7+TBlc/WELvQbuN29QE5SlZ2ChTUC7MIqYWN+W/1/6HOO9RupHn2LoNafDIIRsbbS2mO+LgCigYWId1Qovt4Q5QjNAgihgXzLFEqAVXhM5ONxDp7Vzdr3Qy2+4cBWPu5HReQGGP5+gHizu0NyehsqVlwA/RbI+R0d9BZYGPO7V0mPUJwy+E5OHQDXMLx876dHqnoI5gh8ATMl44MCu4zQKV9XH7DzEuLRsCGreG4XjUMscqpRqlJQAYmK1VqYUcSTLbkeWYzbxLZuOJUbWw2J4BL8meyL2h7BRL+uK+plG04fPYgKyAzfxh9gY4wbf/EQPUp9TuasUoPRn4LPmlLOtynk9bG1/2c4+svrnMARBFBB5wJfZ2d0mqhdbndbVOlvfIWARcMQag+omHWKzUP/tqz3XO5pLuTfiQzOXK4/gp/jPd23+CM+wZtGGh83MwjfOnpBtWQWyl/HPUloJh0ogAhHt5QKmYNgIrYjQztYrbY376fuxFPtfPp1kcC66u7mdSXHRqzG43nTk2189pBAKPUjPHL+9zWogLCYCH8Zjjl4zGu90cF9neQBV9TtgXidz5NHtqGC1WzEL/gF72mF4+SVtbzEVsmWLfZFISi1oC8a4TvHEKLUueZVsPaVZaLSxNk7NbB80Xut8mVdcQYZEIawZvY4hkFcOtV/5RbnvHZXPyi6MFa0wpdJ5PMjfBcjxdiAyC80k653fzHNC0oOF1e1lFuaAKUNpmymXBw2EeIv5iCoxy80evfmWnkTkWPWPn/EhrS8kIdJKfsXbxWA3YOz0FdqrZWzzKec3pOLLrMKdg7LbbNPZtwpdIZO7siPJi3DkoKwpinQ6QjvG2nsNfseGK6dqlepTS90AwhplyrPAGAab2uCw2S+th8e4tUnp0uWdBSRsGYtwds2MTbrPm691nU/xpbnPggYvbjMaoPKi5HRXUwECJK05H5zF50HYZwgiJYZ0A1eViSalWEVSX8hJEJqQd1sYCHSa159YrJtZtvcXu6+QW4rnVUvSzZu+tItHnQbtspGsletJ93WGadh018VK45+mJXTHi+/v7KRe7B+lT4C9Svvucpy/2Xjw/OMifDPdevFwz6UitpNPu22B/f8Dn+zf+01uNQ/Za4lk4e+0PnwfsFR5K7yTzUolcYH1EfasIxHPh+0fT5xE1Qvuqz+WDgLb9Ef+DnWjD2sVdl6yh3N8mWnHapgqhzbawC27ndSQZ4bWmSRaynOhdsZDAQ697yEkHAfkY32nc2Y61g8/lBAvtUUxGpG9CYdYZAJftbb+K71B5pMqLWqBF94TQthiwdkFncl+i9GNjEJF5yr5KZ3vXi91QtCFLfGG0GrMQfc+P8V1Wt1Bzb5JBYawds3jfZeUPXR/CzniH0T2PR0u2GN4wuXU9xEn3llbc5Hu7vYNSrDgoZL4u07B084jaV4DDqqPHztYJ9yhtp7zX9q/JzidDNklkL2VrfR3BafcKb1uTQavv1wVrsz1Sjnu80Bed8gaq5VpX3NDG9rfOJuCQsZpvXiG6OYK7GaCZZPBkHsPam31+aLi5O6RRAtCOVgo3ml3j6fA79blVBII1wSAYfWIPQp8H7U0CpVkFppTOxVY2epUhtzK/5+icU5lftN8RbRLI2C6EVQDCdvxQCAOX4I8ot4tQHL5idvR5a4F/xrLwaGfGdCxqAmQ1baHGbuOoFri7xxw9IYnVSfK5nLPnAHP4jCrTc9fcUxQEjorZ/Al/MEdxDv4E9M7z0HPFDx2W/YBi7jRrXblY95b1tmVi7Q3qXpg0j5vJP4yyoTRusv0or+lcfcSoexMaBw9KZRMeAJLN2eyYtqkFvQ2ID+D9xT6Hp8/3XqSC85fpUxAv0oNnsJvuHYB4JnYBDp48W2PS6DTsFkFpUXD2VrrvY0zFCar45WjMMVxjuGFJhydzp2F4l1f7ELE5ag5CWBLo3LGk9sWL4ej5fp4O+XCUPuV7++nB/sv99MnTXdgXL3M+3D9YI6nbWaFjyyWfsF/AFFI1YkK5FDMS0UW4vbKZhCKmBmU9nm7yHuvrdlbXaq0tYQ1otKvp3aLLpZw0waVaWx/aa3braA17z0WMDI9gB+wzwDmmmpSb0NW7vwNfxnVMmjS2945DpTjQOmuvOw71ulfA37utmC4tdu/fMv8lAoXmjvn/W8RwPUg+dvzGTRP6kziQ60HyvvEgN835pyv56Up+wJXE++xN7Ok5Da9A/FtKN/HTo5Pj9F+bZDo9BOGfE+pdJKTnH+avDr1GoqVU4aYr6niKhkfgw1gxoc64tTqXVFVBwTndVMUGeDk3POehaGfGaHng23TufT+w7Azf9cHz+A7tLS9J80qmoadU438MBNPOz4+QDbxxi4Zs4UWj5ioWqLrEu1n7u/vP0t3n6d4z/7gYPUKC+tP+fo0vYVymtgJ+DtzOUhR/qqdgjBQUnFLocuJfq3jnH6vAIS4dKEsxLy6aV6yVr6UNoi3pvpqGmyT2WzV+03E5H8h8yPv6V9fwuQyOT3wkj6d7j8MbG1l4YyPrvr9GxShB5WqDr5rEteKV9EuVCih1eN5kXrNKnfTl5umlPqONn3F6KwgvpXliKHu9imaFn3G+8W2TT/QwF7nd4B+7T5w0SoGDR2WhB3Loba8ld46JRHzXq/daGJqSxUdUth3hU+/hsLkBrgcJPp3wsX3iq/NgzdJ3ahpl7z5U0+6A8FJN80N8nib8sPRpmqZx7zmaliYZn+afC5Wx/o0OtFG+7CSiKLJjaBZQm+PZYncPDhK0U/bD6BOYqcyhozKtyaCr6I+p4WOBMkTQl9K/8YzQhq4L1yehyHVJR6fExwPL3oQdyGK1HlosofMaTTOtxz+E6XGfCg2CeB1HZR/xEYKQ74qSbnj6a6viZN21dSVXHTo3PWs4P4er9rGNn08i/nwS8eeTiO2TiMECO7h0j6uCSzLV5HSugh88S6Z75BRXecKveEnDOmx5dYXo6DdTXF/jz3/UgODw7Cs6YUN1pfR01iACMHSdQlJwuAKCdbfunxyNLV0KD2+WQ9kIbJIWB73ywkpPe5hp8YGhtgeqcuXWtu1CpJMPn06TQTIMT2iWmiCe4RcIpvkFcjNozjLwjU387SopuBrXPgrwNNGw8z4KaLx++KPzNIi36ZHDqyvf4hR3yPV1EqXkHwejuOD/APaCigA= +sidebar_class_name: "post 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"; + + + + + + + + + + +Create a partner managed company. When you successfully call the API, it does the following: +* Creates a new company in Gusto +* Creates a new user using the provided email if the user does not already exist. +* Makes the user the primary payroll administrator of the new company. + +In response, you will receive oauth access tokens for the created company. + +IMPORTANT: the returned access and refresh tokens are reserved for this company only. They cannot be used to access other companies AND previously granted tokens cannot be used to access this company. + +> 📘 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) + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/post-v-1-payrolls-payroll-id-calculate-accruing-time-off-hours.ParamsDetails.json b/docs/api/post-v-1-payrolls-payroll-id-calculate-accruing-time-off-hours.ParamsDetails.json new file mode 100644 index 000000000..31fbb41b2 --- /dev/null +++ b/docs/api/post-v-1-payrolls-payroll-id-calculate-accruing-time-off-hours.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/post-v-1-payrolls-payroll-id-calculate-accruing-time-off-hours.RequestSchema.json b/docs/api/post-v-1-payrolls-payroll-id-calculate-accruing-time-off-hours.RequestSchema.json new file mode 100644 index 000000000..e4a68fef4 --- /dev/null +++ b/docs/api/post-v-1-payrolls-payroll-id-calculate-accruing-time-off-hours.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","description":"Request body for calculating accruing time off hours","properties":{"regular_hours_worked":{"type":["string","null"],"format":"float","description":"Regular hours worked in this pay period"},"overtime_hours_worked":{"type":["string","null"],"format":"float","description":"Overtime hours worked in this pay period"},"double_overtime_hours_worked":{"type":["string","null"],"format":"float","description":"Double overtime hours worked in this pay period"},"pto_hours_used":{"type":["string","null"],"format":"float","description":"Paid time off hours used in this pay period"},"sick_hours_used":{"type":["string","null"],"format":"float","description":"Sick hours used in this pay period"}},"title":"Payroll-Calculate-Accruing-Time-Off-Hours-Request"}}}}} \ No newline at end of file diff --git a/docs/api/post-v-1-payrolls-payroll-id-calculate-accruing-time-off-hours.StatusCodes.json b/docs/api/post-v-1-payrolls-payroll-id-calculate-accruing-time-off-hours.StatusCodes.json new file mode 100644 index 000000000..9d0ffa517 --- /dev/null +++ b/docs/api/post-v-1-payrolls-payroll-id-calculate-accruing-time-off-hours.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"type":"object","description":"Response containing the calculated accruing time off hours","x-examples":{"success_status":{"hours_earned":[{"time_off_policy_uuid":"7c8d9e0f-1a2b-3c4d-5e6f-7a8b9c0d1e2f","hours":"3.0"},{"time_off_policy_uuid":"1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d","hours":"20.0"}]}},"properties":{"hours_earned":{"type":"array","description":"Accruing time off hours earned for each time off policy","items":{"type":"object","properties":{"time_off_policy_uuid":{"type":"string","description":"The UUID of the time off policy"},"hours":{"type":"string","format":"float","description":"Hours accrued during this pay period."}}}}},"required":["hours_earned"],"title":"Payroll-Calculate-Accruing-Time-Off-Hours-Response"}}}},"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/post-v-1-payrolls-payroll-id-calculate-accruing-time-off-hours.api.mdx b/docs/api/post-v-1-payrolls-payroll-id-calculate-accruing-time-off-hours.api.mdx new file mode 100644 index 000000000..34c4ca351 --- /dev/null +++ b/docs/api/post-v-1-payrolls-payroll-id-calculate-accruing-time-off-hours.api.mdx @@ -0,0 +1,80 @@ +--- +id: post-v-1-payrolls-payroll-id-calculate-accruing-time-off-hours +title: "Calculate accruing time off hours" +description: "Returns a list of accruing time off for each time off policy associated with the employee." +sidebar_label: "Calculate accruing time off hours" +hide_title: true +hide_table_of_contents: true +api: eJztXFlvHDmS/ivc3AfbQGVJKsuXnsbjY1sPbgu2ej0D20ixkpFVbGWS2SRTcrWg/z6IIJlHXVLJEmZ30A00bFeSwY/BuBhB8iqxkDdGukVy9PUqeaOrmqvF6zwHa183bp4cff1+/X2UCLC5kbWTWiVHySdwjVGWcVZK65guGM9z00g1Y05WwHRRsEIbBjyfd7/UupT5gnFrdS65A8EupZszNwcGVV3qBcD4m/qm3vPcaWMZLwrIHRGdgx8BBJvrxtgjbJfS7yvksR0vWQVurgV7fDkHNweDbRdsBo7VfMFqMESIXWpzDmLU/VBzKUYe2B79oRvH9AUYHGeE1JuqKbnrDTzlFgTTKlKWWrA9lvMSlOCGLYAbtse4UvICjOVm8QSxz/Ulq7ha+AkhDxELE43xM5a2R299h5PTj2yPWZmfh98cPwe1gQR7jCsymKdnmQTLtCo9qtwLAPWz+RxEUwIrDPzRgMoXHY2O7hNciuOCKa2QHbQmNTe8AgfGMsJgkUFSjQYL2fLPL4QsSzYFtk8iYHNdwxE7q/nC6LK0Rwa4OEtGyY901linU6kczAxHeUzdoobk6GsC1RSEAJGMEl7X/SY2+T5KHJ9ZbHaK434sCnYSZo8fI11jL/ksOXKmgVFiwNZaWbDJ0VUy2d/HP4aK8LkhTSmaMhkluVYOlMNWvK5LmdPYe79bbHqVIDsrjn/zgBM9/R1yl6wqlx+VIT0uVVSAnJc5SZ5Yo220/sQf+MGruvSYrYeXWcddQ79Quwy4USBI45FCposi8+qTNY0UyVHyIn8pXsF+kR7wyTR9mh+K9Bk8L9IX/OX0Vb4vDmBSJCNPLjlKno73k+vRRmpIZEgjRSIpUnnKD6fP8ueiR22yj+S+X1+PktroGnUP1qBvGcmN4YsVPr5ezyTmu2+0T8kokQ4qu26hhmjWT7btZR2q4Qqs0zmw3347fht1ZXn465YPq5QKbSrukqOkKDVflZxfaH5Rv9abgXFyjf+hcP/RSENSMOQrqop0JQ584tUvfRNFL41MTVGL0o9FkdKgaRTaxBM/3D9cVZZftWPvdaPELrqygQT7phj7ppCZZJwsqoUBqxuTAxMaLFPaMfghrRuzD/wcmG0MeOtk9IUUINjx2z1aCWnZBS+lGCejlSXvswmM0YbMxVAQwu+rArlRkFaoZueAHXLuYKbNYsMY1OpGCftcQy4LNOuXcwhzpu5M53lj7JidLmqZ87JceOk4hwWTApTzvchIO2fktHGw19pyZsBbH6c7kmOU1xb1DtBI9Bc1uQxPiZ2SkfOk4iLZgHxmdFNLNbOMK8FyrtBXNNajmTayFCxHA16F9nOuRIniLxVboH/peQPCXIG1fAY3Qz6JQAQ4LkvL+BRDgo6pKZuBAtOxM5COKG1jCp57pFwxUAKBm1YRhyZbaZcVpCQ9wfo6WP8kSHxfXo56HXuTSzYoyCX3+kEdxsHWRq3/VbuUlCx9h4OmH73UBs2eTFbV8jdVG42ehk9LYO+Uk26BbvyU2MEXbM7rGhTKoyLOTbVY4MrT0gR80d+FJbfMNvmcccvOpCL1zFqhzC542cDZiGmK61oKBS2QaCDwuu2JmkRrfzZmn8GrxNd3fpg3nocS7PfHc+dqe7S3J3RuxxQRjHNd7cXIIg3xCH3fI5hp3nZ/wmaNFECepdIGosSMv6m7W7z1rPW27y/mRub+ZbX/8602Oy66gaRlZ4qMWubX8cxvLvxa+d1EEHnGmW/JzkJTFhZp4fd5QEoVFOP/jHNAFI4L7m6xZXgTldtACRdcOYb9kGYQkEXQ5GD+pWKk01IHsxEs0rSEMXuPgbH3SKMBCcJHrDrzf2aI6ozWNv6CMfBZu5mLkRYGVlrBx8JvObbOpWpKJ+sS/FioR0uKF39eVbb4ZQeVHo5tpZrFkbEbF0LiJ16e9Ebym8M1Y3uG3Cw1v/Kq3SoHjro574tNro3ffArLnCZp6DH45hF+U/KPBjrzYMhuduMRRW+9C6OrjuDXjqJqyjL53rZr6szp7Q0Hdm5dA9yHwrYmvSjkQ5D+9It08/SjgtQ7v+R6c6sPQXZ8U1wa2pT+teb/79ccKW102EM+fEHjgwktv/tjcqvbGLNjR0kqba3EEMtpNucXwFo7VMIFlJRvC24kOorWrCS5NLg/No893EHc/CTpz3BNg2TNLmDK1XnG81w3ymUCSnCQNapolACR1XxRgXJ2yw4BU5LD7cFKsDbYJrxvlJBq9sHnTOfcsjgaa0ejNRgAuwAji0UmFYlujkhrbeW9IvsnhgE4KgujoufErcsUGI0vQYzZSQkcM2ZzyM99kIIRa4DDeIUd7XjzFHiJCcZFFik+6ASQvWFANgVQ3TzWAKykRQuVGd1gKnzbrtC3yFRTTcGsh7gU5A+AfvL9me+POhHdbsAVJCHLtSrkzLbQ2lhzJ66t9u6Dee0YLqljmFXugtmqsa4fWKwHFmdbcOuitmSlrKTbgnBN451Z+B4RBxqMaDA7100pEDMPnG0xZz4j1+EFJTIRrOUGlG2TtdjW8/KdEhgPQk9zaAfl5lyxp6zSys0txoRF4xoDHl8oBGRSicY6s8gslFiN0SpTXOY2y7WArAvMNiLuWu/Oz1+xL8O+a8TxdgjDMA8PMIom/IHVJ6fZcybkTLZmZwtcGwHYW8C1Mvdtd0f7WeaE1a6CPQxgPdblzLbi1S3XuroTE6t167uSXlekUSBafQmlvsxs15lBsx0s9+tQScR+LcemJZpyjKxaPG0ZbQPwGsi5ZiGRss07LnXdBe0br9wCeO7kBUIOBVHa4wYMXbUhgtmAORZk7W2WvW28+9q/i10ZN3B7CZjykqscsqa+wV5u9tbbUL3hitKjXPxOy+5Hs9uXfa5LKdCq4/8ecAwrKBC9z6go1OnbMIJCChYQ+GoPIdgMDdPFDwarrb9QJL0O2IjVIWQzgLKqFWyE2rrHVsweRBSPfZv2LALDbZft5TAIn1ZTzQ2G4bHdffIv6jAG/KwdqoXkIaxM5h4RnFLuUVpK9tC2VKpBFhiTy0sezYcVGSjMH2EQ5gyd4MhwE7YF23LL3dW0JeD3e11847GEIi9KOdo+j7dT2Ij/IePYpTmucXPWcUNxOy8cGNrr3yYKWO21O/9O2rj60Rp6jzo17lITlKdkQVEuQLkwi5havC3+QfufQj6gdCPm2Lrb0mDJIZsZbS2mO+LgCmgzsC3WCS12D3fCGaQYUcR9wRKkeMYj88X5m1l6N1fnzwx0mqNgxp28WGZQ0PEc/WB5j/YmnDDoAfBDtOpRGP0nqCzguFdL589F0PArW/JQdMPcwrGzPp3eYfRhh8AKGS8dmA1os0Bl+779p4BLy6aAxq0FHEstS1Ap1SgtBYABbKMqLWQhyWxHyDGbeZ9gY8WoXllsD8BzcsBybygtmItgxe3COqjaRtGGL8cGZAVsFg/K3Bgn+PY/Y4CGlDqtVozSkwFnxX/IqqmWcdrG+NNxDwj13Y8cAKOIgAFX4mB/n7haan3e1Nt4+YDAYsAV9wB0LOqxfTJOhrWvrq7zdSnp3m4fkqVceRw/xX+mB5OndMShb9Cmpc7PwbTOn5JuUhV6J+FforY2GCaJCIHwIA8oFdNG4NFUzUyjonosT9+PvYpz+3zaxbHgmvphJsVFF5rau01nCeb2ORUgsJSaOf7jIaeFcSEF4GE85vgPRuPdbY6rsG8hij4n7A+J3Ps0B2IYLVbMQv+EXA5Ar5+kbSzmInZMsd9mUhIPtQTifSd44xQ6SB6ybaY0K61WlqbN2W0LzVe63yVV1xJhkQhrB+/2EMkmwJ1X/lm0g3LZEv/iaMEaUwqd5/PMzQ3YuS5FBsH5JL363TICmha0WHfnVeQLigClbS64LHko5mHEX14Ao9z86ze/sNMIjkXP2KsfaW0pGYFO8os0wI7ViH3QF8BONZ48Newtp3Jk32Hisf5d1TT2bbcvkchS7YjyYtw5qGp/FUKHkI7x7jxHg8KJIYduXKqLlL4HgnGbKWeKO20wtcdlebu0HpflXVJ6XJb9je4ygLjvjtmxObdZ+/X+sym+mtsWPHBx29EYHQ8KgFoxMFDhilPpPCYPui5TKJAYnhNApjMFl0g0BnryB4hMSDttjAUqJnV16w0T67feQft6uYVYt1ob/WzRvU0kbnGy9G0P9NJZ0tEDT0/si4JPJpOUi/2X6SHwFynff87TFwcvnr98mT+dHrx4tWXSkZq/IXSX2N8X+MINo+g/vdU4Ym8l1sLZW198HrE3WJQeJ8tciSjC3Yw7o/D9o+nzETXd0hmifBSibV/ifzSONuzfdd54lBRSSTvPQpYTvSseJPCh1wPkpAOD/B7fadRsx7rBl3KCpfZRTEakb4rCrDMALjvYfRU/oPBIlZeNQIvuCaFtMWDtiszk/ojSz41BRJYp+1M6u7te7IasDVniS6PVjIXd9/IYf8r6DmLuTTIo3GvHLN6fsvZF18cwno3ZweTp4bMna1RsrhXc+TzECfaOpyGikh/sDwqleOKglPm2TMNa5RGNPwEOm0qPPdUJdyRt73hvl6zyJZylDfxtEtlrYW0/R3DavzvTncmg1ffrgmezfaQcdbzUl73jDXSWa9vhhm5vf+dsAg4ZT/MtC0Q/R3A/A7STDJ7Mx7D2Zp8fGt7eHdIoIdCOVgoVzW7xdPid+txpB4JngkEw+sQehT6PupsESuOdsko6F1vZ6FWm3Mr8gXfnnI75Rfsdo00KMnbbwioAYXt+KGwD18QfkW+X4XD4htnR550Z/gWPhUc7M6OyqAkhq+kOauy3jmoF3QPm6CmS2JwkX8o5ewSYw2d0Mj13zDZ1rY1jgoKjcrFc4Q/mKM7BV0DvPQ+9dPihB9kPKJaqWduOi0ljXXa3Ay/vsS9TS8deVqyVIP9QZFNp3Hz3Ud5SXb1g1L3dGgcPSscmfABINud2Zdr2LOhdgvh4s3jC4fD5wYtUcP4qPQTxIn35DPbTg5cgnol9gJdPn20xafGi866b0rLk7L10f84wFSf8tXQ05rhdY6iwJMPzpWqYBYwRaYvYlpoDE9ZsdO6ZUxPxYlo8n+TplE+L9JAfTNKXk1eT9OnhPkzEq5xPJy+3cOpuVujYcsnn7O9gSqlaNiFfygWx6DLcXrkdh2JMDcr6eLrNe2w/t7P5rNbWI6whGu1Lev/Q5Vok7eZSbT0fOmh2590a9l7aMTIswY7YF4BzTDUpN6erd/8Evg51TJq0tveet0pxoG3WXvcc6vDq6OC2YrrhsDt2aAEco6TX2rr04iDeALTxL5kUafvsQVcRb71GNAbBnv9di0VUpXt5iKE78kJb6giF8j4bn2AYXhIxMMObAaGK758b2XIb4sY7/p88vWCpPD2/+xpc80e7EF8tubexPwaCtxlc6AbLyveO4S3RbV9kuQ2U2ukwfGN/bvATtIVLz0k0duPA+DLLPY38uXvkZeOA13d7uMHvA71adg+3kDGh8OYo+Uf6P/Q4yuuT4/R/2zS1RFxz4IKi9RWlamcIqqlwypP9ybN0/3l68CyhB4UK3pSOXvtof79eWW3EUkkVrp5i1JL653ZenxzHDPfKi0J0dRQb4G1ZujdKj9PI7jDfyLfpWYdHln2tpKICeY/2jreWeS3T0FOq2X8Hgmnv5ycIA5fQpysChzt7Fxlbc4r5tr8dEk/F9G9I+ptqm5bjujdoW3vdcVToiu63H5be2LE18HPgdpHSzeBw4PljUbRP8QxbIdAUVd1IQfveKM5Rmk9991+C6YUfDpSlfTWKr/eCG58Moltuzc1PByHLhqT8K0Ftf5x7v9HyNNuGK9Nd32s47a739ukji0NK23tU9EW4nkfJ3sXBXvSte1edsF3vteX7vaueOFzv3cbr0umcYCkaU6I1CLrCa+lVJRVQkb6s2nGo9NJqe3qpT/HjZ+TOBsJraZ4YSudvolnjZ+RSfPLsM0qrd9NrHj5rZRgHjxYO/z0FbsjmLV/CJhIp3RdkvHFzTBLFYvgo+UwnmH5mBE9hwwDXowQDnE9dKPTOXyjcHIV0NnqDm+5dNd3qzrt2y762+7LiDFvbgLbHn7uJ7ovcDZphFP5YXO07ilGCfsF+LD6DuZA59ESkM9F0F3+PGu4J5BnGZSn9G4ukNnRduT8KZa4rqh0TjkeWvQvmgcXjiughhM4bjOmJ//8VXvjgPhccLOzbOCr7hK8whISfr6uijIevf+tEmpywtq7iqkendeNbws7BJHox8F+P9f31WN+/6bG+YN0c/HB7dcklmUEy6FfBM31NLg6S9pAQivHRIBTqX+c4GsYrN3uo73ibxDoc5eoK1/03U15f489/NIDb4a/f0bcaOgBLXkxI2riK5KjgpYUtSvX4U4h8nrDNQdna+ce762rR8+xJuEjfDwTR+90LoF68dgdEfa77Gzo+5N+NX//RgfwGvnr+rd88tWzuIsA3nlnp6SA2Xc1gdD0wlqjd1rb9mPDk4+fTZJRMQ5ak0hRTG36JgTy/9Ise61IYNOBvV0nJ1azxCSJPE30UHwYwbcAS/tJ75mUoVldXvsWpPgd1fd1KmcN/UzLp+l8svzTA +sidebar_class_name: "post 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 accruing time off for each time off policy associated with the employee. + +Factors affecting the accrued hours: + +- the time off policy accrual method (whether they get pay per hour worked, per hour paid, with / without overtime, accumulate time off based on pay period / calendar year / anniversary) +- how many hours of work during this pay period +- how many hours of PTO / sick hours taken during this pay period (for per hour paid policies only) +- company pay schedule frequency (for per pay period) + +If none of the parameters is passed in, the accrued time off hour will be 0. + +scope: `payrolls:read` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/post-v-1-payrolls-payroll-uuid-generated-documents-printable-payroll-checks.ParamsDetails.json b/docs/api/post-v-1-payrolls-payroll-uuid-generated-documents-printable-payroll-checks.ParamsDetails.json new file mode 100644 index 000000000..0b6eb4397 --- /dev/null +++ b/docs/api/post-v-1-payrolls-payroll-uuid-generated-documents-printable-payroll-checks.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"payroll_uuid","in":"path","required":true,"schema":{"type":"string"},"description":"The UUID of the 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/post-v-1-payrolls-payroll-uuid-generated-documents-printable-payroll-checks.RequestSchema.json b/docs/api/post-v-1-payrolls-payroll-uuid-generated-documents-printable-payroll-checks.RequestSchema.json new file mode 100644 index 000000000..63c332a83 --- /dev/null +++ b/docs/api/post-v-1-payrolls-payroll-uuid-generated-documents-printable-payroll-checks.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"printing_format":{"type":"string","description":"The type of check stock being printed. Check the \"Types of check stock\" section in this [link](https://support.gusto.com/article/999877761000000/Pay-your-team-by-check) for more info on check types","enum":["top","bottom"]},"starting_check_number":{"type":"integer","description":"The starting check number we will start generating checks from. Use to override the sequence that will be used to generate check numbers."}},"required":["printing_format"]}}}}} \ No newline at end of file diff --git a/docs/api/post-v-1-payrolls-payroll-uuid-generated-documents-printable-payroll-checks.StatusCodes.json b/docs/api/post-v-1-payrolls-payroll-uuid-generated-documents-printable-payroll-checks.StatusCodes.json new file mode 100644 index 000000000..3cdf11014 --- /dev/null +++ b/docs/api/post-v-1-payrolls-payroll-uuid-generated-documents-printable-payroll-checks.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Example response","content":{"application/json":{"schema":{"type":"object","properties":{"payroll_uuid":{"type":"string","description":"A unique identifier of the payroll."},"printing_format":{"type":"string","description":"The format the checks will be printed."},"starting_check_number":{"type":["integer","null"],"description":"The starting check number for the checks being printed."},"request_uuid":{"type":"string","description":"A unique identifier of the Generated Document request"},"status":{"type":"string","description":"Current status of the Generated Document"},"employee_check_number_mapping":{"type":"array","description":"An array of mapping employee uuids to their check numbers","items":{"type":"object","properties":{"employee_uuid":{"type":"string","description":"The UUID for an employee"},"check_number":{"type":"number","description":"The check number for the relevant employee"}}}}},"x-examples":{"example-1":{"payroll_uuid":"a83d0bd8-7d20-43b9-834c-6d514ef6cb20","printing_format":"top","starting_check_number":10,"request_uuid":"p83d0ca8-7d41-42a9-834y-7d218ef6cb20","status":"pending","employee_check_number_mapping":[{"employee_uuid":"f83d0bd8-7e20-43b9-834c-6d514ef6cb47","check_number":10}]}},"title":"Payroll-Check"},"examples":{"Example":{"value":{"payroll_uuid":"a83d0bd8-7d20-43b9-834c-6d514ef6cb20","printing_format":"top","starting_check_number":10,"request_uuid":"p83d0ca8-7d41-42a9-834y-7d218ef6cb20","status":"pending","employee_check_number_mapping":[{"employee_uuid":"9fcf1b1d-8886-4691-9283-383d3bdd4fd9","check_number":10}]}}}}}},"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/post-v-1-payrolls-payroll-uuid-generated-documents-printable-payroll-checks.api.mdx b/docs/api/post-v-1-payrolls-payroll-uuid-generated-documents-printable-payroll-checks.api.mdx new file mode 100644 index 000000000..ee7772fd0 --- /dev/null +++ b/docs/api/post-v-1-payrolls-payroll-uuid-generated-documents-printable-payroll-checks.api.mdx @@ -0,0 +1,71 @@ +--- +id: post-v-1-payrolls-payroll-uuid-generated-documents-printable-payroll-checks +title: "Generate printable payroll checks (pdf)" +description: "This endpoint initiates the generation of employee checks for the payroll specified by payroll_uuid. A generation status and corresponding request_uuid will be returned. Use the generated document GET endpoint with document_type: `printable_payroll_checks` and request_uuid to poll the check generation process and retrieve the generated check URL upon completion." +sidebar_label: "Generate printable payroll checks (pdf)" +hide_title: true +hide_table_of_contents: true +api: eJztPGtv27iyf4VX90NbwEpsJ83r0+32sSfA6TZo09NzkBYKLY5sbiRSS1JOvEH++8XwIcmy7MRpAtxz7hZYbGuRM8PhvDnkbXQTTyttZMyFgamihksRm0UJ0clFBMUEGAMW/RhEhk41/nZGF0rmucbfZAluximLTqJSahPPR3HpR4S/JFXFWTwFgYOBJUymVQHC6LhUXBg6ySEJQ9MZpFc6GkQMdKp4icCjk+h8xjUBwUrJhSFccMOpAU3MDIgHzKUgMiNQlLlcABAHiWRS2VEeAdElpDzjwMhkQdoE7pA3bVDaUFNpQgUjqVQKdCkF42JKFPxRgTZ2DrnmeU4mQBSYSglgO+SrhjZVwEhYLvn1/XmzhmtuZvWnBBl+Qi7X8ePS0rGE2UhS4noQlx3UJr5UMgWt/SyjOMy7VLk5Xz//nVSlFCSVRZkDTt75Lr4LnUpLUM+mnVwrbuAyGkQlVbQAAwrl4jYStACUghZPo0HEhf3NzKJBhAvgClh0YlQFg0inMyhodHIbOYGLtFFcTKO71e0H8vXr6Tvc4NZmRneDGu0/41+tGL85O43/AUrjRI99BpSBWsKf0VxDF8s7XEvBhZcrRg3EE6qBkTdnp2TugBKqtUy55aHdw4WslB2Q0jzfIacZEVIA4Rp3Yc4ZsIEbQ8sy56ndoBeaXBRc8KIq2rB/vJwZU+qT3V0mU71j9XInlcVu0MOgUfb7Li157GdyMf1vDzBu/fwKyag0sJ1oPbcHEYiqQNUeD8ev4+FBPHqNys0go1VuopP273d3P5CPqA0aNAIbD4f4v2VWvr+hKE8kjIwGUSqFAWFwbIsTu79rnHC7Sp2c/A6pQTFTaGYMd+iWxKtnLct0vCGV4H9UQDgDYVDvVUeGdlDarN5xMU0yqQpq7oeLAunGNgqoa2tgwSHT7waRNlRZ0HZMIqpiAqpBcBFZu2vFU1R57hjfRRWAeK11QGrT5rFPAEe0cbcNxk/x6tfabLwLxszD9ks0lb4fwdtKKZzqTeta2AgzmPEltiUFLUuE3KCiStHF6lIEsR8Qh5/TOAbkhkb7aWbA1RJL0fFwA4W+Xw5rAh/G3NqC4aZRUVODa+2XjMj/0AepVwwU5DCnwrRg459BdBODU0dHuPt7PFrVpoge7bHhhB3Fh2w8jPf3Jsfx0d5+Gh+w16N9yA7SyXgY9ahLZGQZrZX10bArilGJiFKKiPZH8f6YWkQLxDs6ahAFyYpKsM43ulcwLlZ2JsrqRcGaRe0fRt1dGA3vfiDvDDc5boaPeuK3OMoKaIul3trhX+c0r+D/C2ePszQbTUYsPjo6Ooj3D45H8fH4aC/eO9pjexPG9jN2vIazTjL3h/urvuM3acgHWQlGvgtCvotzK9t2kYDhjJaVSoEwCZoIaQjccG12yEd6BURXygU6wfc6peOazGnO2c53gXu3Px6vov0qfNSE8Rd5Lww3i5oCrklBF2RGyxIEuZ6BsFgmklkbY/27p5Ggo6NcaAJKSaWJrtIZoZpccmGJSKgxik8qA4mVlssBqTXYQcgozzVhFaCVoqKZWcfblzvkC7iVXrx3aN5SA1OpOOgtwwhLZpzW01+RacWZ9W+kkAoIA4MEIfO2cOP3c/cv5naZ23U5TcB6EbkFY3zQcUTu91WXuNaRrUBNrgAneCoXa3DYUfc6ui8+v9K4kV4Z7XQi07RSeoecL0qOsfKCGNz6K1g0EYeLvOs93K1TDPRuNkhwftuBtEFOTfUWpCEEHGsTRguJWLfqQQXr4aWMTJWs0Aj6dJAKDPIwrEZqJhXPGUlRDgo/fkYFyzHm4MJJbyu3thlCjYhrcimsYUvcPl4OLHFur1xA6UWeUOJGkks/lPhNWrhEBJzJch8tawrUtyncz5mzsF4vjYROZGVaexf7zLHeNQ86MENXKqOpYwhGN4Ihf5SnwlBGTW9s3wkQg3LXoQzOQ5heQBZek70L4IJYnca0zJoNb5EmOeyQD1IR76QHSyAsfZZVl+7/Nvt2KXb4BR3cZSued84Esygp4FNmveHmtRRVbjimQBYi6lFH8cLPq8oWvmyh0su4NRfTgBmnUcY4fqL5WQuTy8F7cDuG3C81v9ECQhTvOWpmtC02TeUEA24rDS0G34/h60pCEoJdB8ZCdNY7U7Jop1U1RJdV1eOqMjFy88AlO9c3AIMn2DSkFTh+9NIff+NmFn8SEDvnF92tH/XRy44biluDhY6/9vzff88R0lqHvcyHb2h8pMgXLsAlfKPb2CGnxtacpNYcQywjyYzOgdR2KIc55Dbr9m4kOIrarEQpV2mVU/XSkRvb4Cf+ZAXuVdReYc+AqCfXnFBxldA0lZUwCYMcDCSVyCrBgGGJ0xYU20HMxVKsEWH1rR2YnEQrwVrUcnPRh8omMx/BzCQjM6pJwEZqbHYPlgibg+LZIuHCim6KlJZS8yel7F8YBiBW4rGi58TsZQLE4udYPD7LgeqQ3tsgBSNWTw6hBU5E175uCTRXQNkiCRCfdQHIXo+QTABEs44eAguu0UIlSlbGV3DWEOZHJHX5o4fETpC/ROhnNz9UR7gmwe16urwkJKkUGZ/qmrQ61tyKa6uz28S8MQS31BAsCTfBbFFp0w4s+gkLq82oNkFbkpwX3GygsGfw1iz8gBR7GMTCIHomq5whzdRztqY5KUFxyRp6QbCEeWu5hsp6SC9t/bx8L5itybc0x2ZQZkYF2SOFFGamMSbMKlMpcPThuQYVqNys0kYtEg05pCjdiaA81UkqGSRNYLaW4mb09vz8DecSnNsjjg+j0KN5fgKDaMIfFc3RixwQxqe8NjsbyNWBAP0AcjVP3djtqf3CU0urXiV23xPraDW8gERmWVLKnKeLBI+KHrbXxaOYWPTtb5eISliNAlbrC01TVdE8UZt1ZmnYFpb7jZtHcF7NsUmOphwjq5oeYgnkoNcQ7iuFiS+kbPKOnanbUPvWKTcDmho+R5IdDJfjehoIIiAyy0JVZx3NoWKpH7Lt9eDt9/59mEqogodLwITmVKSQVOU99nK9t95E1VsqbIWUst/ttjtsevO2z2TOGVp1/M8RHMIKG4g+ZVT01hmTOoywIQXxFKAH8pu/njQhzfORVZeYbSTdR9iAlD5kU4CyKgWsJbV2j7WYPYsonrox3fOupoZh6ZNiIqnCMLw+LXpC/gUdxoCf1KhaB1NIwspinpCCc1t75NoWe2xaysVSFRiLyx2P5sKKBIRtwMCqm6KpkSrBJGwDbd2R26tpDcDle01842hhVmGtlNszYEtvo7CB/ueMYztr7HFz9QkVzQwom+s/JApYnbU9/87quPpFD7wXjRo3pQlbpyReUeYgjF9FKC0+lP6l8T9F+RKke2kOo5uUxh42TpXUGssdAbkAmwxsinX8iO3DHbA5Qh1RhLygQ5KNWnBHZrJSDwkMH+fq/obQW5ojYEoNn3cZ5HU8RT+YP6G98cfDLQIcilo9MiX/BBHaup7U0mHVx6NfScn9oRvWFk6NduX0hkYXdjA8IaO5AbWG2sRD2Zy3/xThvGlf8QSHo5YOqbbUyLUNAD2xlSgk4xlf6psL1cynJDacGJUrm+0IcJxcYrkzlBrU3FtxvdAGinpQsOHd2MBaAd1qR7onTnDjf8YALUNqtNp30ng6C3qDPWZdOnWlSoprfkZS39+kABhFeBpwJ0bDoeVqLuVVVW7i5TMSFgKukAPYloOX+tVOtHz21ZzrXHSK7nX6EHVq5QF/bDtoR+M9XOGSQZvkMr3CNg3vvm3RjYtMbiX8HWi9wbCVCB8IL9UBuSBSMVDon1Qlmsa65eU73Kt0bl5PvTkaTFU+z6Ioa0JT/bjldMjcvKYMGB6lJobePOeyfEsvEI+PGHpDLL7HrXGV7AeIoqsJuyaRJ1/mkhgGixWq0D8hl0tE9y9SVxprEVuW2B+yKI5NLR542wneu4SGJEeyriZ2VVKsbE1ds9sUmq9Mf0yprgZCAhBSI29yiGgdwY1X/llql47LOvwL2Lw1tiV0ms4SM1OgZzJnCXjnE7XO77oU2GVBTev2vAp8QRGwZZs55Tn1h3kY8edzILY2/+bt38h5II4Ez9g6P5JS22IEOslvXAE5FQPyUc6BnEtsrlPkHbXHkW2H6ZvGHxU21enLvO69Xzo7snUxagwUpU1ijfQhHaFNP0eFwokhh6xMLLPYfvcAQ5rJp4IaqbC0R3n+sLIe5fljSnqU5+1Et0tAyLtDdWxGdVJ/ffpqijvNrQ88cHNrbMS2B3mCajFQUEh/76MuHjRTJpAhMOwTQKYTAdcINAR6/AYvfXA9qZQGe5jUnFuvWVh79Bba16othHOr3uhng+6tA7FMgzRJhn2lS9x91yLaap0d4rjwzMtjQ5bR8XgcUzY8iveBHsZ0eEDjw9HhwdFRujcZHR5vWHSAVtjT7sfE/u6Az82v/aezGifkHcezcPLOHT4PiO183om6XAlU+IbiR1PhLwV40+ciagzty2UqX/ho2x3xv9gJNqzZ3E3FGndl4QFSsabn+JrqroxEGRdczxJf5UTvio0ELvR6hpq0Z5DL8Y1EzTakQd6pCebSRTGJBX1fFKaNAjDJaPtd/IjCw0WaVwwtugOEtkWB1isyk7oWpZ/DYYF0Ibsune1dL05D1voq8bWSYuov+Kzg+JOXjxBzZ5JBYK4dqnh/8tIdur6EnekOGY339l+/6lGxmRTw6H6IM5wduiGCko+GSwel2HGQ83RTpaFXeVjlOsBh3dFjS3Xw+M7MQLfae5tilTvC6STwDylk95K1uY/gvH09oOnJsLvv9gV7s12kHHQ8l9et9gbby7WpuaHJ7R9dTUCUoZuvKxDtGsHTIKgX6T2Zi2H1/T7fD3y4O7RYfKAdrBQqmt7g6fC7nfOoDAR7goER+4m88HNeNDcJhCQl3vs0JozSwatMqObpM2fn1Lb5Bfsdok0bZGyXwgoAplt+yKeBPfFH4Nu1bw5fszr7eWuGf8O28GBnpvZYVPmQVTWNGsPaUa1Q94w1ehtJrC+Sd2rOjgKs4RPbmZ4aoquylMoQZoOjfNE94Q+Xsfwa3Anok9ehO80PLZIdQtY5zdrULsaVNsnjGl4+4FwiOm0vK9aKWf+QJROu7C3wLbG8s+fqGbHT69TYe1DbNuECQGtzHnZMW/eCPiaI98H74ZjC/sHoMGaUHsf7wA7jo9cwjEdHwF6zIcDR3usNJs2ehj0iKc1zSj5w8+cUS3HMdvxSNOaYrhFUWCvDs85pmAaMEW2KWB81eyb0JDpPzKkxO5xkB+M0ntBJFu/T0Tg+Gh+P4739IYzZcUon46MNnHqcFTrVlNMZ+QVUzkXNJuRLvrAsuva3Vx7GoRBTg9Aunq7rHpv7dtb3am1sYfXRaFvS202XvZTUyaXY2B+6NOzR2RrO7mSMBI9gB+QbwBWWmoSZ2at3/wLaR3UomtS294lTpYBok7WXLYe6fNt36bZi3NvsvnwD+JcQKNT3f/9tI4a7QfS55TfuW9B/iAO5G0S/1R7kvjX/5Ur+ciU/4UrC7Xcfvv0imc0mu6/jPNWDKY952yS0OribKNrI9KrzvoirB9pqyffoHHOzzvjvEdHhPEO4po2LnIur5gK1D6Zbd6ixeSvNYff4+Pjo8PDwYDS0f3bP6CLGi7SxAVrEk0Vs8bxqblHjSTIy3d+c8alieNfGvaEwkcbIIlzm2vQoS+tNloe+xXIN7rao/Vo/xRRGaYJX1fzjUJLIOSiFt8CRexqlQKTg7tGFK6fhdnF4gGn5mZKdKMhPuE7a3eUf4ekPXQK9AqoXMdrZOKCOTqIA+iw8OvU2vL0FNwaEtnk9qpBTnrXvhA2CvWy/F4aGIMxbR0I9cS0p+NiQL2+758Xsq1NmFp1Eu/PRbnhobPe2/drG3W7Pq1W7G54as+053lxUKkeT6iWUltxJZ8ygsCK6IhLvoJDRMqMdvNjV+PEzMmMN4F6YZ8rW89fBLPEzskZDWilbi7q4DbHCmxTjljcVMuniR3vUFzQYzib0jK1lH0kMr0XhvydAVY8qeBCxvVZIaGVmWEsKZ+aD6IttdPoZDA7CGgR3gwgN4efGhLYeYdnyFZWhrTm6lpkQAdrHxPBtLpTScC7afghrEOFjYfpT9gXUnKfQ2tyWPcNr9Lt24C7DdaBhju2/8XxT+6krVz8hT2VhTYWl44Um771mkdBpiM+GBem2PPkv/zgHdWVc/yzau4CVfMYHFHytzh2JonT6r//TCCOyFlWtoKIFJ7zSRGo9atrgnIV7WbLsVXcpt40X++sNv/+Lb/h5lTRwY3bLnHKru9ZW3XpLexHNR1HdAIPSc9J54q8HQXjKqM/g/sDbEdog5NtbzIe+qvzuDn/+owKMyi5+oGdQtqHTmjbGbSK25t2+toy9/Ox94iuy7s3ANWsOd7HFouWXIn8xfPk1J3fBwz0quB15/+EvDPYy1jGw/3nGms9NuPDWMSs+XwotViPgZgb6mNJsHNsOI84+fTm30aCLugtpgyFFr/GBDnrtdj0ca2BYjr/dRjkV08olBA4m/vlfBjK5Tw== +sidebar_class_name: "post 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 initiates the generation of employee checks for the payroll specified by payroll_uuid. A generation status and corresponding request_uuid will be returned. Use the generated document GET endpoint with document_type: `printable_payroll_checks` and request_uuid to poll the check generation process and retrieve the generated check URL upon completion. + +scope: `generated_documents:write` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/post-v-1-plaid-processor-token.ParamsDetails.json b/docs/api/post-v-1-plaid-processor-token.ParamsDetails.json new file mode 100644 index 000000000..49933cebe --- /dev/null +++ b/docs/api/post-v-1-plaid-processor-token.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/post-v-1-plaid-processor-token.RequestSchema.json b/docs/api/post-v-1-plaid-processor-token.RequestSchema.json new file mode 100644 index 000000000..e954976dc --- /dev/null +++ b/docs/api/post-v-1-plaid-processor-token.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["owner_type","owner_id","processor_token"],"properties":{"owner_type":{"description":"The owner type of the bank account","type":"string","enum":["Company"]},"owner_id":{"description":"The owner UUID of the bank account","type":"string"},"processor_token":{"description":"The Plaid processor token","type":"string"}}},"examples":{"Create a company bank account":{"value":{"owner_type":"Company","owner_id":"ef279fbd-0fc6-4cf1-a977-6939d621c429","processor_token":"processor-sandbox-0asd1-a92nc"}}}}}}} \ No newline at end of file diff --git a/docs/api/post-v-1-plaid-processor-token.StatusCodes.json b/docs/api/post-v-1-plaid-processor-token.StatusCodes.json new file mode 100644 index 000000000..067041db8 --- /dev/null +++ b/docs/api/post-v-1-plaid-processor-token.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"201":{"description":"A JSON object containing bank information","content":{"application/json":{"schema":{"oneOf":[{"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 \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/post-v-1-plaid-processor-token.api.mdx b/docs/api/post-v-1-plaid-processor-token.api.mdx new file mode 100644 index 000000000..0796994d9 --- /dev/null +++ b/docs/api/post-v-1-plaid-processor-token.api.mdx @@ -0,0 +1,78 @@ +--- +id: post-v-1-plaid-processor-token +title: "Create a bank account from a plaid processor token" +description: "This endpoint creates a new **verified** bank account by using a plaid processor token to retrieve its information." +sidebar_label: "Create a bank account from a plaid processor token" +hide_title: true +hide_table_of_contents: true +api: eJztXM1y3DiSfhUs56B2R1E/JVl/h4l1+2fGG+G2ou1e94TsoFFksgptEmADoKRqh55iLxNz2eO+3j7CRiYAksVilapk6TCz3REdtotA4stEIjORSOBrdBNPa2NVLKSFqeZWKBnbeQXR+WUE5QSyDLLo0yhSFbivr7PoPKqUsfHVQVwVXGRxpVUKxiidWPUFZDSKLJ8apPADl1/YszRVtbQGyWgwlZIGTHT+NRrvH+AfGZhUiwqJR+fRM/Yf797+yNTkV0gtS5W0XEghp2yCtITMlS4JSDSK8CtIi0R4VRUipQ97vxqk9DUy6QxKjn9TEt7m0fllf7D3M2CpKisu544+d1iRBRJC5HBEo+gmhhteVoWDbuoUWU6M5bamX+paoGQOxseHwOFpfHR0cBAfnWZn8SQ7zuKDU8jODvdPx3D8lJDToInvBeP0KN1PIR6fnR7HR6eTs/j0OM1jSMcn+TFkZ/zwOBpFHl3isT2fQfpFyGk0irSqrZDTRNblBHR0Hp0+Pdg/2T86PItG0UxkGcgk9G7a/PLLL78c7Z+eRKPoCrTIvfwapvyvkPUb+PFRYkkGlTLCmmgUSV7izy/LqlBz0OxVLTOcOa8A0e0tijHoxnMv9yUdqTQqmxXQkevXMB/Gasfx4kT+/PPrF0zlzM5gcSJv+7LehpLviUQWRX8XkR86EBg1HUUg65L4bmftHb8ScmqiT7fLM3jXEO97nO4Y5kkwT+J25czfRfsNN18gWyDfITqoK8skA7/8mgvirKMpGng2T3Klky6xRs2cyVnmt9uYuZGHJn33o/wod5bG3WElcGmWmjNh2K+1sSzVwC1kjMuMlUrCHL9MAEVqNZcmB60h2/0od4bxdwcoRapVHIZmXDttKiAMYPv8eCvKUi7ZBKZCssmc1YZGD23nDGRWKUE87gRhrWMstNldmrlVmhzmrb+6ydaHPxO4saAlLzaYKBxg9TQtDLOOk1RJCSmKb4JisIB4G51HkfrG7RIw9LOTnJOjVvV01pscFCUxtdnogcgFdiGxOom0K4HLufc2q2TbUMOlJ0z7z0+3o6aXrIsiuh2UL40dMN2xGNhbWcwZ+Ucw7HoGcmB6hOnwU3Bjk5SnM8iSCS+4TDuKctlyQwAH8SEFloNNZ8wTYLnSA9guCuAG2AQYv8Y1YmfcMjsThvGSRJ8pMEwqyzTkBUYEtLiUsayuYqvijFtoxsDZVkvcLq20ZY49gYQgQ5Yg1S1ZbvgkrgkWN0algkzKtbAzAjIg23vMkPO0d5nxH3lJC2/RIaKvgd9qoSFD1sgrfhpFVtiCggrn82J0YXHjuT/d3mLHo/2j5YjtR2XZK1XLjH2UjH2UKA0cAQxyrsGoWqfQziTcCGN32Rv+BZipadIBrd+VyCBj5H/RcPFCoK1Fdo/G4+Vhf5beYvJJAeyltMLOGwTCsJLP2YxXFchWDSYqm6NE5qrWAWOIMQ0DrZU2zNTpjHHDPgtJIBJurRaT2kJyxYsaPo+Y1+VAIeeiMCyrgVnFuGx7NlHz5132Dhynly/dMM+5hanSAsyn72bWVuZ8by9TqdmlgHw3VeVeCMDjis+1Kgr6vkcw47Tp/oRNa5G5FVYqDSwDi4BQeFvEyHdL9w/h9oXb3yR0F5ZjeDmg9b+3q5drzefRKBIWyu7vq6kmXwA7eJTzFWNQqzuNxLsKUowQyPD4xUjdmUrTWptd9n5eiZQXxdwZ5i8YF2UgreuF7Zs53Ku45iVYQAUoyPJZ1ZIk29Wg3gIaUghhhKPEaOvmSQXr4bWMTbWqK4ysySO4gIrVxqGZ1KLIWIp6UPr2My6zAgMEIZ32dnbDu+x13g4kDPssybAlbh4/jwic365ei6IIKs84cy3ZZ9+U+UmaO3cAzmS5jySaEtfbdAPLfhH49drI+ETVtjN3MZuCBN3OmicdhGFqnfPUCYRLjCpRPtqjsDzjlg+p4iKM52FxayjgiqO75pYjTa8gc7+SvQsQktGaRqdGZsNbpEkBu+yV0sxvsUcLJAgfieqz+5NC1880t+EX9GKfnfgnrTPZjUadrf96Xsq6sKIqwI2F66i38MLPy4stfNliSS+OjUF+GBm78SwT+IkXF52RrK5hcOz5hrvSEA+QmjiJ+ngrqE2qtMvQZIZZRdrQEfAGm2cpfquhNQ+6CfscGbcLIeuda1WuCbGadnWVWLW+4YKdG2qA0fG6eA5DmxD/vPHaH38Qdha/lRA75xfdrm71xuuOa4pT0wnj/5jzf+I5R0orHfaiHD6g8aHdBwW4TKx1G7vsNe0rK2WMwBDLKjbjV8AaO1TAFRS0pfNuJDiKxqxEqdBpXXD9nYMbU/ATvyWFexJ1ORxo4BR6Ma1Jm/GQLcoAsxVJLfNaZpAlFZ+XgDm6ThBzuRBrRBNuoBuYnEdLwVrUcXORzxC+ATtTGZtxw8JorBmN5mABmNvQJ0KS6qa2zVI8HLK/YRiwkARIucTdywTanErYvqaY0nNBCkasHo7fwqJrX8UCL1wmqUl7PSYDKF4/IJtAs8mk3NASwFIYtFCJz6+sAdZLXA5C7AX5C0B/Wsha4poIbtfj8pqQpErmYmoaaE2suZXUlnt3wTyzDKfUMiWBtcFsienBTmAxDCxwm+MeP3wsRCnsGoQDjbcW4StE7GkwosHMTNVFRomVJnXrMScVaKGyFi/INuOxAmXTZBDbsCxfyszlQdqVQzsoO+OSHWKG1c4MxoR5bWsNDl9I1guZ1cbqeWKgcDmuRHKRmiRVGSRtYLYScdt6e3n+iH0Z9h1Qx80Q+mEeH2BQTfit5gV6kWOWialozM4auCYAMBvANSJ1bbdH+06khNUsgz3yYB1WK0pIVJ4nlSpEOk8wzbXZXJf3EmI5NL99ELWkFQVZs154muqaF4lev2YWmm1huZ+5fgz7NRKbFGjKMbJq8DACKMCsAF4BOdfEJ1LWecde123QPneLOwOeWnGFkB0Nt8f1GBgOwFSeh6zOKszgzg7BbDLtTePt5/5l6EonMxtrQMgT19Ud9nK1t16H6jmXlCHlGZ1H+dHM+mmfqUJkaNXxfwc4hBUUiD5kVBTObEMYQSEF8wjQA/nJXw1NKvt4sJoUM0XSQ8BGrPIhG531oZtfCbVxj42aPYoqvnZtWCDBcNtlOjkMwqfkRHGNYXho95DyC2sYA37WDNVAchCWmHlABO8p94jHPtJvS4VcyAJjcrnn0VxYkYDE/BEGYVbz1Cqd4CZsDbZ+y+2XaUPA7ffa+MZhyWjBkpaj7XN42wUb8D9mHNvjccDNGcs1xe08t6Bpr79JFLDca3v5XTRx9c4AvZ12GbepCcpTMr9QrkBaz0VILW6Kf6H9NyFfoHQn5tC63dLgkUMy1coYTHeEwSXQZmBdrONbbB/uAO0Rmogi7At6kChqwRmZqVpvEhjez9X9Fal3Vo6EKbfiqi8gv8ZT9IPFA9qbC0e/A8AN0SyPXKvfQSYex4NaOsz6+OGXtuT+0A1zC6+tcen0FqMLOzI8IeOFBb0CbeKprN+3fxPwpjCmARyOWnpQw3E+xlQebC1LlYlckNkOkEM28yHBhhOjammyHQAnyQWRO0NpQF95K27mxkLZNAo2vB8bkBUwiStO3CBOcO2/xQAtUmpXtWSUnvQ4S34jyrrs4zS1rjjy/IhQX96kABhFeAw4Ewf7+yTVQqkvdbVOlo8ILARcYQ9AJQffmSe70eLZV3uuc9lLujfbh6iXKw/jx/jP+GB8SJUTXYM2KVT6BXTj/CnphlWtWyl/j9pgMEwa4QPhxWomyZTOQKN/0rUMy6PPvht7Ged6fprJMWDr6nGY4lkbmpr7sdODuZ6nHDI8Sk0sv3lMtkJ9IPPjMctvGI13Px6XYW+gigv1mA/N5oIaBosVstDfoJcLoIeZNLXBXMSWKfZNmBJY1OKJd53gnSy0kBxkU0+IKyWXpqbJ2a0LzZe63ydV1xBhgQhrBm/3ENEqwK1X/la0C8dlPfmF0bw1phQ6T2eJnWkwM1VgeapzPlHn/K6PgNiCBuv2sgpyQRWgtM0VFwX3h3kY8RdXwCg3/+z5X9n7AI4Fz9g5P1LKUDICneQHoYG9liP2Rl0Be6+wuE6zF5yOI7sO8wq02XaZhr7N9iUQ6Z0dUV6MWwtlRZtYq3xIx3hbz+Gqk7lkqraxyl0xpicYtpliKrlVGlN7XBSbpfW4KO6T0uOi6G50+wDCvjtkx2bcJM3Xh8+muNPc5sADJ7cZjVF5kAfUqIGGEmecjs5D8qDtMoEciWGdAAqdSbhGoiHQEzdYtyrMpNYG6DCpPbdewVi39Rarr5NbCOdWg9HPmrW3isQiBmWTHOtKF6T7ogOaVh01cVJ4ZPay/Szn4/E45tn+aXwE/CTm+8c8Pjk4OT49TQ8nBydna5gO1Eo67b5P7O8O+Fz/xn86q3HOXgg8C2cv3OHziNE9k92oL5WAwper3xuFrzj3ps9F1BjaV4sod3y07Y74d3aDDWsnd12yhnJ/m2jFiprja276OhLlQgozS3yWE70rFhK40OsRctIilK/jHt8qXNmWtYP3coKF8rcziPRdUZixGsAmB9vP4htUHiHTos7QojtCaFs0GLOkM6krUfq2MYhIn7Kr0tne9WI3FK3PEl9rJafM7777Y/wuqnuouTPJdM+kyeL9Lip36Pod7E532cH48Ojpk4ElNlMS7l0PcYG9QzVEWOQH+wsHpVhxUIh0XaZhcPFktasAh1VHj52l428smE55b5usckc4vQ38JonsQVjr6wjed68HtDUZNPtuXrA220XKYY0X6rpT3kC1XOuKG9q9/b2zCThkqObrK0Q3R/AwAzRMek/mYlhzt8/3DTd3hzSKD7SDlcKFZtZ4OvxOfe61A6F7MBmjT2zH99lpbxJIxSrQpbA2tDLBq0y4Eekj7845lfkF+x2iTQoyttvCSoDMdPyQ3wYOxB9Bbte+OHwFd/R5a4F/wLLwYGemdCyqfciq20KN/cZRLaF7xBw9RRKrk+S9nLNDgDl8RpXpqWWmriqlLcsoOCrm/RN+b44CD+4E9MHz0L3ihw5kN2DWO81aVy4mtLHJ/QpeXmFfJntlL0vWKiP/kCcToe1s+1Fe0Ll6zqh7szX2HpTKJlwASDZns2Paphb0PkG8D95PxhyOjg9O4ozzs/gIspP49Cns08X8p9k+wOnh0zUmjU7D7rEpLQrOXgn7+xRTcRlV/OLVzRy3awwXLOnwrHcaZgBjRNoiNkfNXggDG50HltQ4O5nkx+M0nvBJHh/xg3F8Oj4bx4dH+zDOzlI+GZ+ukdT9rNBrwwWfsR9AF0I2YkK54NVI6WW1sYRCTA3SuHi6yXusr9tZXau1toTVR6NdTe8WXQ4iaTaXcm196EKze+/WsHdvx8jwCHbEPgB8wVSTtDO6evc34EOoQ9Kksb0PvFUKA62z9qrjUG8XCvgXbivGg8Xuo6hb6P5DCBScyP6ZI4bbUfRTx2/cxdC/iAO5HUU/Nh7kLp7/cCV/uJJvcCXuv+VL/8I0z3H4ekLj87Lffx9Otb7/fvHUq3nTgzN6NoI1jycxejzJHR1YLeAKmCAD0bx4RA9mmFRVcM4+u0cnmt7n11pY+Iwt/sz+97//6+/453sV6hy5p+6rH2vjr0s7DLwS7TVp+oluSNOFaF6JvWYUs/en5u9E0JF/QmJ1ByrsY0R3rD9GeM27ab0bkP3jf9gHrulFp5gNvgH0Uf4Zm77OGWcZ5Lwu7OAjTT4JMWLCNjc/M2FcBV54YgVnY6ETtdRQFRwvpFoE2XnqZ8c0Q+b+9SKXyNz110HB2B9URtmE9ijD3dLb+Kb9uvvd6lqGg62R/4d7daX3xtbSLdROx6XL/JhBoe8r32Jp77IvvVXi54gu1TWA1gyx8imm/hC3y1wNkr0YWifL1G57Lv550PzBB766XqMruobdLrMR5OOTs3ySxft5ehwfpflBzM9OTuLjs8Oz7Hh8kB6NzwYm6bz9JTZcZhN1E+9zk2HvsUyjYFiapJYzgf4drV/iv9DTbM8uXsf/2ZzSCSQ7A55R6NGqTs4LA30b9QKJlkL6K/ToPGOMaDL27OJ1OKlbeqeErsBjA7z1T/ffJYaMoi1KHrk2HTXfMeyyFJIKfTq0t3x9gVci9j2FnP7JE4w7Pz9BGHiVHxfk0pJaUt7x/vhpvH8cHzx1r7bQ0kbH1P5+i0/s3MSmAv4FuJnH9HqAf96seZdssQnOUKyuQGuRUWKMdO2VViUp63uvofhIkjSUb8N5dU5t5Yt7o6CR3Zf30EGHfn2ITYdFqMNdFiG3XQeho0j8MZV77A+Vm9tZdB7tXR04F7G3/Owf1c15Ja51gYrqZ59Xwk1+nEFJGrB0f/YFlKonZkcvdodv+BlZW0F4kOaFpoO2VTQr/Iy8GkhrTUniy6/BAjyjF/6e1cj15aduq3eodt7ILLdtlBEhBiWlSQKuadH2H1FwD+7QfV/GazvDJG8oZhlF76gC8VtGcBRWDHA7itBD/dT6tpfOiG5mGZsVt2z7WjMf6tvCdo3sGpoJ9+KbK2LorslRhHbLvM3fgb4SKXQmvDUh9ObFHjXcy5A3dIcx/RuLEYzvunRPG4pUlVSjQTh2DHvplxsLZcFowTKV1hgDkpz+zb+kw92Zi7fQL8Ko7Cd87cQn1l39Amqs//rvrYKStVfGllx26DSuaiFSwdvyq8LEPldf2+jjj8D0/11g6heohRtLUiK7QXbyqzfbl9HVQfcNv+VocoZW/vwy+voVA4SfdXF7iz//VgNuvC4/ocfQVLNN5nAUYhB6VNUzNxyFdHXzXzwgGZwI54uHo7nghTtO+7kTVvx+ISZY3lK0PdA3VHZt264/v3j77n00iiZ+G1MqCmE0v8Z4kl8jmlFzToj7HPzta1RwOa3dDtvRxP/+D0pgzwo= +sidebar_class_name: "post 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 creates a new **verified** bank account by using a plaid processor token to retrieve its information. + +scope: `plaid_processor:write` + +> 📘 +> To create a token please use the [plaid api](https://plaid.com/docs/api/processors/#processortokencreate) and select "gusto" as processor. + +> 🚧 Warning - Company Bank Accounts +> +> If a default company bank account exists, it will be disabled and the new bank account will replace it as the company's default funding method. + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/post-v-1-salary-estimates-uuid-accept.ParamsDetails.json b/docs/api/post-v-1-salary-estimates-uuid-accept.ParamsDetails.json new file mode 100644 index 000000000..ce5d5820f --- /dev/null +++ b/docs/api/post-v-1-salary-estimates-uuid-accept.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/post-v-1-salary-estimates-uuid-accept.RequestSchema.json b/docs/api/post-v-1-salary-estimates-uuid-accept.RequestSchema.json new file mode 100644 index 000000000..0bf5ac89a --- /dev/null +++ b/docs/api/post-v-1-salary-estimates-uuid-accept.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","required":["employee_job_uuid"],"properties":{"employee_job_uuid":{"type":"string","description":"The UUID of the employee job to associate with this salary estimate","example":"7f5d3d93-6d6f-48c0-9f4e-cd12c2d3e4b2"}}}}},"required":true}} \ No newline at end of file diff --git a/docs/api/post-v-1-salary-estimates-uuid-accept.StatusCodes.json b/docs/api/post-v-1-salary-estimates-uuid-accept.StatusCodes.json new file mode 100644 index 000000000..099cd34e9 --- /dev/null +++ b/docs/api/post-v-1-salary-estimates-uuid-accept.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"}}}},"422":{"description":"unprocessable entity - invalid employee job","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/post-v-1-salary-estimates-uuid-accept.api.mdx b/docs/api/post-v-1-salary-estimates-uuid-accept.api.mdx new file mode 100644 index 000000000..0e05a1ea5 --- /dev/null +++ b/docs/api/post-v-1-salary-estimates-uuid-accept.api.mdx @@ -0,0 +1,73 @@ +--- +id: post-v-1-salary-estimates-uuid-accept +title: "Accept a salary estimate" +description: "Accept and finalize a salary estimate. This associates the estimate with an employee job and marks it as accepted." +sidebar_label: "Accept a salary estimate" +hide_title: true +hide_table_of_contents: true +api: eJztXH1v2ziT/yo83QFtAcux3SRN89d12+49AZ5ui0339p5reyotjW1uJFJLUkndIN/9MENSb5adOE3u9Vlg0dYihz8O543DIa8jVYLmVih5lkWnUamMjS+nseE51+sEjBUFt2DiqhJZzNMUShuNogxMqkWJ3aLT6BX9zLjM2EJInovvwDhzJFggMWYfV8IwboxKBZJkdgX1V3Yl7IpxyaAoc7UGYH+oOVEsuL4wTFjGDXPjQzb+LD/L9zKF+pcRUesNyeaQqgIM08CzWMl8zRZKMw2p0ll8AVAKuWRlpUtlwCDAhmCglXKJpCWbA6sMZMwqZsCyqmSpKkqQhphHhGlCHj9BNKkq4ZR97XPz9EoLC1+jUWT50kSnn6JzN9rb0CL6Moq+xcvKWBULaWHp1ii26xKwPRRzyDLIolHEy7LdhLqWXPMCLGgkfh1JXkB0Gv1b/C9E8NWHs/hfQRtcvVEkcAlXwDPQ0Sgy6QoKHp1eR26oyFgt5DIaRSCrAoeeTWZH8eQ4nh7hSBkseJXb6LT9+01fQt4glkJIv+oZtxDPObLz1YczdumwNLKROXFYq0pTg5Tn+ZidLZhUEpgwrNTqUmS47NSGl2UuUpr+E8M+FUKKoiratL88XVlbmtODg0ylZkyMHaeqOAiMjEu+1irP6fsBL0Xsewq5/EdPMG79/AxhoECMo5tRzWHUksDSkttVNIo0/FkJDVl0anUFfcagyP3229kbphZDErxjQW5uvowiA2mlhV3TKr9WRcnlGrXRmFeVXUWnn77ctARJmyu+DDg0mFJJAwZJzyYT/KOLzVREaVHl0ShKlbQgLbZqcfvgD4NNrzdRqvkfkA6Yig0dTXmeVnmjRFyy8/i10iVTVxI0c2KiJFNpWpXUbsTgWwlaAFqAHC4hH7Fcpf4bGo15ZVDYUPMvQVYwjkZRqdHUWeFmTCs1IOV7Lc+Y1pdn72W+dny9GUXBAiTdIT41Y8gqz53u7BqrtoQW7WafbcIgt3YD+EPNHwwEmuNtQPp6+1S1TfOzQZBcyorniQSb+DXaE6UjwCTYsMgBc734ZK9RpmpbXouaQbWNvosySVW279D/fvaBYbdmgCB93qgNjodW2VrQSOU/Pn/Oro9u/glBaDBkQBsIZM3JGm/HEGhDht7NKMnn+aYDFJKlIK0Zs1+qPGcCLahla7Ct/sPL4xcv4XYncxZKF9gkIpNuRQGDOoQfjOVFya7Qlw4K0lXLwXdiiWGEqQbeB9jge2BcfrBBIFWZ/dcBybnB2CPbiqaxkqYFh2vN15vGGH9FrWl1chpsVyD0hpU1tCwIlfE8iDxJtrBQmCHr3zW6XV3bZnR/qjTwCnH9lc+VZueWW2GsSA17+tNfz5+14JIakio7B3wb6fdNT+ww3ohU9iDQ+kB0Gm4lxK3bib3t8dcHkcK0ZjhuRV5SXYoUKL7AcAoy4UIEfgmaLylYuBB5TlEhobHRl5tRhAuWlKDREmCzW3F9qNuSScX1NiVIi+akB4895YZlkIqC58yRG7FJPH1GLCm1KLhet0acK5UDlxtD/r4CuwI/e+GiRN+7w4ybm3ZE9clJ1ADvN2f95abf1wdrXX896JlanqJjeDrK39U9CrvgGy/K3Mm+j6YSY7mtWiFI9GJxlD3PXj6Pj7PjRXx4kk7il4tDiNNsOktn2XM4nM82YJ5GJ+ns5eT4eBLPj9OX8SHPXsQvF8cQA58eHnO+ePESTqLBYABt97ADjo4m+F97vqfRy8Pp5EXU+KnpjBpNek7CUW1bZb8jmMbTo4/TyenzyelkMp5MJvHk5JQGaVvOWxt3DNunYEui6VE8nR0hg3wIfq4W9oprYG9QEND6mBE7Xxu0UCx83JC/X8EA1+lqhGotlhL/pO4unrRgLPM7ZblkxpGLndYaT3Q8JIinLZ3cUMRoOp5ELTUhG/7lhnTW5jQb8gFx2BdGNyTFh5PDzXD9F2XZz6qS2T7R+hYS7LNk7LNEz4QaA8bFGUZVOgWWKTAUSMA3YeyYveMXwEylwaut25uxszcHFEoKwy55Lshf9f1DWx9Ba6Xd9rXjNfzvm95sq9fZoJpcAHZIuYWl0ustY1CrW63jeQmpWAgw6Kr9nKk7GSqNeYR1KXDLunbm7ALWTGQgreuF7bm1WswrCwf1Tp1pcOGcVQ1JsqI16j2gIQVsiwbcUWIuanSkwiIZj3ypVYXJEOfhMefRSnfMK5FnLMUtZOHbr7jMctQEId0OvJWAIMwFGHM3XxOAZGC5wBBjrirbYmrMliBBN+z0pANKU+kFTx1SzB/JDIEj55yudK2wVDZZkJK0BOtTZ/0jL/FteTltdWxNLtqiIBipoX5Qh3HUVelflI1JyeK3OGj83kmt1+zZbFMtK1lqhc6DYnwUJLtmMROS1KqzR7u/7v/WGeQtDRKsAHKdr9mKlyXIEKECm6uMwkeSAM8GhsNzIb1kGWaqdIW5u68eblLLfnLJ8wq+jphPnQUKC5KDrAK/pHXPOlX5dczOwWnep7dumNduqQSYPVM9BDNO6+7P2LISGVAsVigNQTDHn+Xf7df/C/uFicZ6IGHYV0nqnbh1/OpSzW6t2JXI8yDyjDPXkn31TZlfpLXbVXnNdR//x5hJRGF5xu0d0nevg3JryOGSS4upXI40vYCsvSZ7QygkI53GnQKZDW+R5jmM2c8Kt5hkm0cdEoSPWPXV/Zkgqq+0tuEXDGW/OvbPm5gDQwwl4f2CjPruuRRVbkUZDCrqUU/xws+byha+7KHSvdSqkMvalOOeI8sEfuL5h9ZILlE7MLZjyO1S8wsv6qyY56hd8bbYpEq7RHBmmFVuH9sw+PYRfpPizwoa86CbgxAiQxSd9V5oVezIJdXtqjKxanfDjp0baoCbrF1ZvbY/fuelP/5d2FX8XkLsnF90s73VOy87rikuDR4C/H3N//evOVLa6rB7OQs0PnSqSPsgzK7ucBtjdmbp6EoZIzDEsoqt+CWw2g75HJtaBDcSHEVtVqJUaMza6qcObieCfBa1ZzjQIBqIh+dcXiQ8TVUlbZJBDhaSSi4qmUGWlHxdYPZ4R6yM+e5uoLwRrHUC5p8rmQm5fAd2pTK24oaF0Vg9Gq1BB9glaLFYJ0KS6KaItFRGPCiyv2EYgKMyPyp6Tgzi58BofAHZmH3IgRtg6QrSCxekYMTq4TBeYEcz3j4FnmPGdp0Eio86AWSvH5DNAWQzjwGAhTBooRKtKsxx7NofuRaJrIo5nVIMQOwF+R2gv7r+zPVHnQhu1+PykpCkSi7E0tTQ6lhzL65t9m6DeWUZLqlleLLcBLNFZWw7sBgGFma74MYGbUlyUQi7A+FA471Z+DMi9jQY0WBmpao8Q8zcc7bGjDknobIGL8gsyby13IKybjKIbZiXb2VGR/stzaEdlF1xyZ6zQkm7MhgTLipbaXD4UndqnQiZVcbqdWIghxSlO5FcpIbSkEkTmG1F3LTen5+/YF93prcpjndD6Id5fIBBNOFPPP+0ih2zTCxFbXZ2wDUBgLkDXCNS13Z/tOciJaxmE+yhB+uwUkZULRZJqXKRrhPM4d5trYt7MbEYWt8+iEqSRkFW6wtPU43Jcr1bZzrN9rDcr1w/hv1qjs1zNOUYWdV4GAEUYLYAL4Gca+ITKbu8Y6/rPmhfO+XOgKdWXCJkR8PtcT0Gd2qkFouQ1dmGOSSvzF2WvW68/9q/DV0Zng3cWQLmPOeYzHdHFffy1rtQveaSEoU8+4OW3Y1mdi/7SuUiQ6uO/zvAIaygQPQhoyJfU1SHERRSMI8APZBf/O3QMHH6aLDqkwiKpIeAjVjpQzY6mUI3vxVq7R5rMXsUUTzr521x22VaOQzCp+RccY1heGj3kPwLOowBP6uHqiE5CBuTeUAEHyn3iMVD0m9LhexkgTG53PNoLqxIgGpdMAizmqdW6URRBcRWbP2W+6tpTcDt95r4xmFxRUAk5Wj7HN5GYQP+x4xje3MccHPGck1xO19Y0LTXv0sUsNlrf/59qOPqJwP0njRq3KQmKE/JvKJcgrR+FiG1eFf8nfY/hLxD6VbMoXWzpcEjh2SplTGY7giD4/l7yXdJb2ixf7gDtEeoI4qwL+hBoqgFV2SlKn2XwPB+ru4vSL2lORKW3IrLPoO8jqfoB/MHtDcfHP0WADdErR4Lrb6DTDyOB7V0mPXxw29syf2hG+YWzqxx6fQGo6+QwBMynlvQW9AmnsruffsPAReGzYHK5QPgcNTSg0qpRqzgEUVY20oWKhMLQWY7QA7ZzIcEG06Myo3FdgAcJzssd4bSgL4MtaJU21E3Cja8HxuQFTBJKO+7NU5w7X/EAHUpNVotGaUnPc6Cf8NS9T5OU+mS45wfEerbbykARhEeA67EdDLxBbLqoip38fIRgYWAK+wBqML5qaHC5PbZV3Ou86mXdK+3D1EvVx7Gd/djprPndNjfNmjzXKUXoGvnT0k3IRdqL+HvURsMhkkifCDcyQMKyZTOsLpOMV3JoB796buxN3Hunk+9OAZsVT7OpHjWhKbmftPpwdw9pwVkeJSaWP7tMaeFcSEF4H48Zvk3RuPdb46bsO8gii4n7IpEHnyaHTEMFitkoX9ALjughydpKqxZzfZMsd9lUliaHYi3neCtU2ggOcimmtOslNxYmjpntys03+h+n1RdTYQFIqwevNlDRNsAN175R9F2jst6/AujeWtMKXSerhK70mBWKs8S8M4nap3f9RHQtKDGuj+vAl9QBChtc8lFzv1hHkb8+SUwys2/ev0X9jGAY8Ezts6PlDKUjEAn+bvQwM7kiL1Tl8A+KqzB1OwNp+PItsP0d8/uFTbV25fL+uZf5+yI8mJ4QaUoaRNrlQ/pGG/qOfBmzRJDDlXZWC1i+u4Jhm2mWEpuFV53LLjI75bW4yK/T0qPi7y90e0DCPvukB1bcZPUXx8+m+JOc+sDD1zcejRG5UEeUC0GGgpccTo6D8mDpsscFkgM6wSQ6UzCFRINgZ74BlmSCTOvtAE6TGrOrbdMrN16D+1r5RbCudVg9LND97aRuEON5ZsW6F5V5eiRp5dNsgWfzWYxzyYn8SHwFzGfHPP4xfTF8clJ+nw+ffFyx6QDtYJOu+8T+7sDPte/9p/OapyyNwLPwtkbd/g8Yq/xUNpdRx1C4S8e3BuF6x9Mn4uoMbQvuyif+GjbHfE/GQcb9t9VeTuKFkIKs0p8lhO9KxYSuNDrEXLSnkFuj28VarZlzeC9nGC4RpUQ6duiMGM1gE2m+6/iOxQeIdO8yuhyPhFC26LBmA2ZSV2J0o+NQUT6lF2Vzv6u1/q7pj5LfKWVXDK/++6P8V2U9xBzZ5IBr1bVWbzvonSHrk9hvByz6ez54dGzARVbKQn3rof4gL1DNURQ8umkc1CKFQe5SHdlGgaVJ6tcBThsO3psqY6/+Gda5b1Nssod4fQ28HdJZA/C2l1H8LF9i6SpyaDVd+uCtdkuUg46nqurVnkD1XLtKm5o9vb3zibgkKGary8Q7RzBwwxQT9J7MhfDmtt9vm94d3dIo/hAO1gpVDSzw9Phd+pzrx0I1gRDxugTe+L7PGluEkjFSnw+wtrQygSvMudGpI+8O+dU5hfsd4g2KcjYbwsrATLT8kN+GzgQfwS+Xfni8C2zu3K3Pvdk+O9YFh7szJKORbUPWXVTqDGpHdUGukfM0VMksT1J3ss5OwSYw2dUmZ5aZqqyVNqyjIKjfN0/4ffmKMzBnYA+eB66V/zQguwGzHqnWbvKxYQ2NrlfwcvP2JduOne3Sf24mfzDIpkLTU+W7DnKGzpXXzDqXm+NvQelsgkXAJLNudsxbV0Lep8gPtyrnXE4PJ6+iDPOX8aHkL2IT45gEk9PIDvKJgAnz492mDQ6DbvHpjTPOftZ2O9LTMVlVPHL0Zjjdo2hwpIMr3qnYfikkHJbxPqo2TNhYKPzwJyaZS/mi+NZGs/5fBEf8uksPpm9nMXPDycwy16mfD472cGp+1mhM8MFX7GfQOdC1mxCvuRrYtGVv71yNw6FmDo8yFSb0FtqtrbXau0sYfXRaFvS20WXg0jqzaXcWR/aaXbv3Rr27u0YGR7BjtjvABeYapJ2RVfv/gZ8CHVImtS294G3SvXLWTusvWo51O4lys5txXhLsXu48A/G/qSydRD+ez1j1LkZtHGnfvOK0PY3eO761lD36R3VvLITIvXNJ0LoAjoV99/1XYEWl5pHqugxCwvS1Jft3TJvfZCMrnFUtz9MhnasS8o9SVX3dxfgyV5hxsS9R+dezllFp9HB5fSg/5bawTWy9+agfpuOznK9kFYab+CH+6C8FO46aJxBQXdCNxbhDRQqwksSpgR+AdysY0cvdgkh/Iyz2EJ4kOYHTcmfbTRL/Nx+zOschdCJ0cCTXrUY4eDhfTB6WgO4pni2f2WPSPi3CniFj9nZ+uhkFLmnEX5kBEdhywA3owiV69dGDd8GCR3UkjuKLe5B3RFqsAj0tB0++YbSFPLk7UfpRhE+mmLeL85B0zsqzfo1d4TpWuUBNTzIwgMSMf0b893Gd924CgQ5vjSIako4nhj21isCC5Un+BpdptIKzTMx5x/8ZW3utvX+/Yr62Qr2K/i3o+gZD0yRowD6r//cyBvyGPWk4LJFJzzKOGAjei/e1Dbx7w85/sBDjk5lLHyzB2XOBekWWYlrb70+RZeYt+uTiEbRaXh5xpmwL1icaiz2uL5G1/qbzm9u8Oc/K0Dv+ukLGkxN9TRk5jJBfjCLThc8N/1HBtsr/PRXb+mfsdufHhycU7gSJ9eN2Y4ifz/PvWnj6mvdi5L7wfs//U7kFoY6xg2/zVnzt/Gcrx2z4o8dx7sZzTQ9XgXPuL1t2+V+eH/+MRpFcx8xFe6dHc2vMAriV261Q1bp9Nr9dh3lXC4rF945mmiWeNeh1A7E/6V1SbsrT9fXrsVHdQHy5qYWL4v/plDw5j8BfcgfWA== +sidebar_class_name: "post 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"; + + + + + + + + + + +Accept and finalize a salary estimate. This associates the estimate with an employee job and marks it as accepted. + +Once accepted, the salary estimate becomes read-only for record-keeping purposes. The accepted salary can then be used to set up compensation for the employee. + +scope: `salary_estimates:write` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/post-v-1-sandbox-generate-1099.ParamsDetails.json b/docs/api/post-v-1-sandbox-generate-1099.ParamsDetails.json new file mode 100644 index 000000000..49933cebe --- /dev/null +++ b/docs/api/post-v-1-sandbox-generate-1099.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/post-v-1-sandbox-generate-1099.RequestSchema.json b/docs/api/post-v-1-sandbox-generate-1099.RequestSchema.json new file mode 100644 index 000000000..b67227053 --- /dev/null +++ b/docs/api/post-v-1-sandbox-generate-1099.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"contractor_id":{"type":"string","description":"The contractor UUID."},"year":{"type":"integer","description":"Must be equal to or more recent than 2015. If not specified, defaults to the previous year.\n"}},"required":["contractor_id"]}}}}} \ No newline at end of file diff --git a/docs/api/post-v-1-sandbox-generate-1099.StatusCodes.json b/docs/api/post-v-1-sandbox-generate-1099.StatusCodes.json new file mode 100644 index 000000000..031faeed5 --- /dev/null +++ b/docs/api/post-v-1-sandbox-generate-1099.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","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"},"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/post-v-1-sandbox-generate-1099.api.mdx b/docs/api/post-v-1-sandbox-generate-1099.api.mdx new file mode 100644 index 000000000..d752ba798 --- /dev/null +++ b/docs/api/post-v-1-sandbox-generate-1099.api.mdx @@ -0,0 +1,75 @@ +--- +id: post-v-1-sandbox-generate-1099 +title: "Generate a 1099 form [DEMO]" +description: "> 🚧 Demo action" +sidebar_label: "Generate a 1099 form [DEMO]" +hide_title: true +hide_table_of_contents: true +api: eJztXN1yG7eSfhXs7IXjKo5EUbIl6yK1jmWfo91yrIrtzZ6SXSNw0CQRD4ExgKFEu/Qie7OX+3r7CFvdAGaGwx+RsnRxUklV4pgDND40+h8/35ObdFxZp1OpHIwNd1Kr1M1LSE4vE5gOQQgQyede4vjY4m+vtHKG504b9kabqcVvugTf81wkp0mprUtnB6nlSgz1TToGhZ8hO+i/eJH0EgE2N7LE9slp8jP7v//57/9lZzDVjOf44yf18yf1M/swkTb8wqRlWhVzxmdcFnxYAJOKuQn4bqBm0mg1BeU+qU/qb2E8yzjDIZnQeYUf2Ugb5sA6qcasrEypLdg97GJzXcIpu8rrydnTayMdXCW9xMDXCqz7RYt5cvqd/ioNiOTUmQp6CfYB5fATL8tC5sSJ/T8sTu97YvMJTDn+n+dqood/QO6SXlIa5JuTYPFrM3QmRau5dUaq8RLbPkyANV3Yx4/nZ3vJbS+ZAzet3rSqYJa6v62sY0Ng8LXiBXOaacOm2gAzkCOn3IQrNugfPNtj5yOmtGO2hFyOJIgeEzDiVeEs9sNFKA3MpK4sw8H3Pqnk9rbXYtNlZ26fb299A1tqZf3sB/0+/rEI8t1/JLuwV7oCp4xSmfTu4HZVbctk5CzTI5royJM2wMU7Vcy9BNz2EsWnsB01bMGkAOWQl+YuwmFOW1HGpnfRW+i2DdXWL3fSNnzkWlSHWhfA1RLZ84YM6rVUjDPqy6zjDvbY673xHnutBA6IEsUcv6Hmlk35HKW2NHomBYilzqw0EnVcsyGgko+k4oX8BmJvFeJFXblsKYuqigIN2zJDCBBxQloCtYdmkFk99VOyPQaIv8bc802lpVlT9+uJzCcNEwyUBiwoZ/fYS2+x0FD9O1cVN3OWsjPI0RIbNugPBuxaV4VALggo5AyMZ0NsPegPDhlXgk34DBj3A854UZFsIIE9b1n9b9IynCuZVOx1LYuC1J24TKiYVowXhZ/NSj5+rbhxsDMrQ7cONxfB5ZUxoBya/uKazz1aZqXKgUlH8LVbQKrmbbu4HnSwTzazcqxQ/O+W3JcsfGGjgo/RRjomlUCTBJZdT8BNwDTrqgCEZYE8Glil3R77VTvwXV0zU2J7PuFqDIyPXJuK9CTWiHB0bVkwk5mfQrMQtW6vX4fQ1dumoOTcWp1L7kDU3nOPvdXWBUXkBtjF2RvLrqWbML5E46ptq0sxutpj71FFSC1kAazk+Rc+Rrbh1IfAvsmSvlj2ExLjkriGYzzdapBvsrwK0sOdM3JYOaiJX+Hsr3CJfNhQRwQTboO4g0IxKrlZxenegndJz0L39JVHlH6Yl0D/QRfc8nbbu5mOL19e69tecpPCDZ+WhXdhr/3/N94sOTrJhXgGecqPhEiPTo76KT8aHKVcHL8YHZ6Ik6P+SRK9VfLxfQzI2nMj+3OKhqK/hLP+jlGCNsKyua4M40phECFVjivMbVgpPxvkZfAMI15YWKV44YM3xzhyy6Tgwq0V86QjZckK5icHg0Mhnh88T5+LYZ4eHQ+O0heHJzw96h+Ong8OjvmLw8PEszfGuHVg2w5iiFyIXY76R8vhyq/asTe6UoJ9Uox9UrisIXYEwQxYXZkcZQ+8zMGNtKhV/AswWxkIsVRwbRR3eAMhBQVVveRoMFge9qMqjc7BWjLir5WTbl4jkN5nTnhZgmrkf6jFnNwrrl/AyILaWQbGaGOZrfIJLueVVAQiq/UqI6t11UOj5ppZshGXhWWiAvTAXDU96wQB7QD4mV6+9sO84g7G2kiwn3+aOFfa0/19oXO7R3nJXq6n+zEPSUs+N7oo6Ps+wUzzuvtTNq6kILPpY1kBDgEh83aII+/m7l/M7TK3G2y39cZPGLVpMQQPvzfWkRvD50kvkQ6mdlXCtEQ1+wLYIaCcrxmDWt1phN+H/IYceVBG6s50nlfG7rEP81LmvCjm3nN/gXkTyfvorl7D/ZIbPgV05AYKcqMhVyKSlKnVqHeA5mIKoUeBEiPnEUhF6xGkjI2NrkqpxpZiu5wr9IWV9WiGlSwEy1EOpqH9hCtRoNuVyktvqyhAiWA9kLTsSpFhy/w6XvUInF+rEM94kWec+ZbsKjRlYZHm3rGDN1n+I7Fmivo23iLxuYjzDdLI+FBXrrV2KfPVh3rVAunIDFuZEc89Q7hioATyxwQUjgvuVubuizBeReU2UMCMK8ewH9IMAjIPmhxcgFSMdBqzKjIbwSINC/DpRPDzvQUShI9YdeX/JC94RWsbf0EndVWHPdGZoBPWCt6NktPLu+YyrQonywL8WKhHHcWLPy8rW/yyg0ovjm2lGseRsRsXQuInXly0RvIB2Yqx553od53U/MqndaAbOBoC8ig2uTa+PCGwyEHS0GLw3SN8VPJrtZDoj4I192SIorfeI6OnGwL2ul1VZk5vbrhg51Y1oBx5U5Om5JC8DdKf/i7dJH2nIPXOL7ld3+ptkB3fFJfmtvfXmv8Z1hwprXXYi3z4HY0PVWspwGVyo9vYY+eUxpfaWokhltO+dFHboQJmUFhcu+BGoqOozUqSS5NXBTc/ebgpBT/pOxK4p0l7hisaeIFezK2GXH3JeJ7rSrlMQAEOskqNKiVAZCWfYy6yEMRcLsQayZBbaAcmWIjtBGtJy80lbyolpBq/BTfRgpLSOBqrR6M1WAA2AyNH8wwTL2MgR6SltvJBkf0DwwAclYVR0XOGAhGNL0HssYsCuAWWTyD/4oMUjFgDHMan2BFd+7op8AKz3XkWKT7qBJC9YUCf99fzWAFwKi1aqMzoyoUq0RpgoUWmKqzVrYbYCfIXgP7m+zPfH3Uiut2AK0gC5sAjObY1tDrW3Ilry73bYF46hkuKJTWs1cRgdhq2DWJgsRpYnO2IWxe1JSvkVLoNCFc03pmFbxBxoMGIBrOTWC7lgbM15qwEI7Vo8IISmQjWcg3KuslKbKt5iaVs7NPSHMqgaI/lkE21chOqg48qVxnw+HI9LblC5RaVdWaeWSiANsMyxWVus1wLyJrAbC3ipvXu/PwV+zLsu0Ict0MYhnl8gNPujtZzJuRY1mZnA1wbAdgt4FqZ+7a7o30vc8Jql8EeBbAeq5NTyPRolJW6kPk8w4rddms9vRcTp6vWtwuiUqRRIGp94XluKl5kZrPOLDTbwXK/9P0Y9qs5NizQlGNkVeNhBFCCXQO8BHKuWSikbPKOna67oH3llVsAblnPaC+KaPgcN2BgOADTo1Gs6qzDDNOy0HMAu82y1413X/vXsStV9LeWgCEvuMohq8o77OV6b70J1SuuqELKxR+07H40u3nZJ7qQAq06/usBx7CCAtGHjIpeeWNShxEUUrCAAD1QWPz10JR2jwerLjGHTcBlYD1WhpDNAMqqVrAWau0eazF7FFE8921YJMEw7bKtGgbh02qoucEwPLZ7SP5FHcaAn9VD1ZA8hKXJPCCCD1R7xD0sFdLScNAlVoGxuNzxaD6syEBh/ShrbYBo2j1ai63bcnc1bfasKN9r4huPRZDCkpSj7fN4G4WN+B8zju3McYWbs44bittp35Vy/W2igOVeu/Pvoo6rn6yg96RR46Y0QXVKFhRlhruyfhaxtLgt/oX2P4R8gdKdmGPrJqXBLYdsbLS1WO6IgyugZGBTrBNa7B7uAOUIdUQR84IOJIpacEUmujLbBIb3c3V/R+otzVEw5k7OugwKOp6jHywe0N5cePotAH6IWj1GRn8DlQUcD2rpsOoThl9KycOmG9YWzp315fQGow87BO6Q8cKBWYM2C1Q25+0/BFzacNKoBhy3WjpQ43kPjKkC2EpNtZAjSWY7Qo7VzIcEG3eMyqXF9gA8JxdY7g2lBTMLVtzOrYNp3Sja8G5sQFbAZnhIhG/K9hfb/4gBWqTUaLViVJ4MOKf8Rk6raRenrUzJcc6PCPX1TQ6AUUTAgCtx0O8TVwutv1TlJl4+IrAYcMUcgI4c/GSf7iWLe1/Nvs5lp+hepw9Jp1Yex0/xr+nB4BBnuGDQhoXOv4CpnT8V3aQa6Z2Ev0NtZTBMEhEC4YU6oFRMGwF0XNBUKqpHd/p+7GWcm+dTL44FV5WPMykumtDU3m86HZib5zQCgVupmeM3jzktjAspAA/j0aExGu9+c1yGvYUo+pqwPyTy4NNcEMNosWIV+gfkcgH06knaymItYscS+zaTwoOKkXjbCd45hQaSh2yrIc1Kq6WlqWt2m0Lzpe73KdXVRFgkwurBmxwiWQe48co/inZhu6zDvzhasMZUQuf5JHMTA3aiC5FBcD5Ja/+ui4CmBTXW3XkV+RKP4za3NFCCwepiBoxq8y9f/Z19iOBY9Iyt/SOtLRUj0En+Lg2wc9Vjb/UM2AeNh+sMO+O0Hdl2mDMwdlc1jX3r9CUS6ewdUV2MOwfTkpJYp0NIx3hznqNC4cSQQ1cu1aOUvgeCMc2UY8WdNlja47LYrqzHZXGfkh6XRTvR7QKIeXesjk24P4tJXx++muJ3c+sND1zcejR/gD8AqsXAwBRXnLbOY/Gg6TKEERLDcwLIdKbgGonGQE/egMiEtMPKWKDNpGbfes3E2q130L5WbSHuW62Mfjbo3joSixi0y0Z4rnSBu2ct0KR11MRz4ZGnJ/pixAeDQcpF/yQ9An6c8v5znh4fHD8/OckPhwfHLzZMOlKb0m73fWJ/v8Hn+9f+01uNU3YmcS+cnfnN5x57hZvSe0mXKxEFno+o7pWBeBS+fzR9PqLG0L5cRPkkRNt+i//JXrRhzeJuKtZQ7W8bqVhz5vg6HHNvyUgykkraSRaqnOhd6QQ3hV6PUJMODPI5vtOo2Y41g3dqgoX2UUxGpO+KwqwzAC472H0V6R6cVHlRCbTonhDaFgPWLslM7o8o/dgYRKRL2Z/S2d310qUnf4sKzeW10XjryWff3TG+yfIeYu5NMijMtWMVD+9q0KbrT3TX6WBwePTs6QoVm2gF9z4PcYG942mIqOQH/YWNUjxxUMh8U6VhpfKIyp8Ah3Vbjy3Vwe07NwHbOt7bFKv8Fk4ngd+mkL0S1uZzBB/a1wOaMxm0+n5d8Gy2j5Sjjhf6unW8gc5ybTrc0OT2964m4JDxNF9XINo1gocZoJ5k8GQ+hrV3+/zQcHt3SKOEQDtaKboLtcHT4Xfqc68MBM8Egwg3xJ6EPk+amwRKsxLMVDoXW9noVYbcyvyRs3NOx/yi/Y7RJgUZu6WwdE+u5YdCGrgi/oh8uw6Hw9fMjj7vzPDf8Vh4tDNj2hY1IWQ1zUGNfu2oltA9Yo2+vqu2ukjeqTl7BFjDZ3QyPXfMVmWpjWOCgqNi3t3hD+YozsHvgD54Hbpz+KEF2Q8oOrtZm46LSWNddr8DL2+wL1OdYy9L1kqQfxhlQ2ncZPdRzmhffcSoe50aBw9KxyZ8AEg2Z7tt2vos6H2C+BC8Hw84HD0/OE4F5y/SIxDH6ckz6KcHJyCeiT7AyeGzDSaNdsPukZQWBWdvpPs2xlKcoBO/HI05pmsMFdZfWu7shlnwl3rb1yMDE1YkOg/MqYE4Ho6eD/J0yIej9IgfDNKTwYtBenjUh4F4kfPh4GQDp+5nhc4tl3zCfgFTSFWzCfmCd6BV4NXWHIoxNSjr4+m67rH53M76s1obj7CGaLQt6e1DlyuR1Mml2ng+dKHZvbM17N3JGBluwfbY7wBfsNSk3ISu3v0Db6Muo45Fk9r2PnCqFAfaZO11y6HeLhzgX7itmK487N5L2gfdf4mBgmfZP3PEcNtLfmv5jbsm9CdxILe95Nfag9w1579cyV+u5Adcif8H95RC7umRhvcE/iv9Gz0k9fLiPP3Pupgu8UrQBLggC9FUvcOd/8WrQ2dIdCpVuOmKMp6i4RHs5cV5LKi336ag5JxuqmIDvJwb3itSpJkxW+6Fhwqae99PLLucSkX78S3aO16S5qVMQ0+pxv8aCKatn58iDLxxi4Zs6Smo+ioWqGqKd7MG/cGztP88PXjmn+qgd5ZQfprfb28/420lWwL/AtzOU7rkuyCy/vmCxVa4SKmegTFS4NDxUa7wBATcOFCWMmJcUi92a58G60VL034iDFUo9uuiqzssoVzdaxFt03sBNTIi1JD9o2P4yhN3k+Q02Z8d7Ifnx/a7z4/RoZYgupUpUDzDmvNS+iVPBUxp3Zcut+F7Yx3Oenqpr4zjZ5zSGsIraV4YqoKvo1niZ5yrhbwyVMG5/B497Mscvf3LCmd9+bnd6j0Km3fyK9rWIogQo2jS2zfAzYr3wgKJlC7jMV65CVZg4k5zL3lPx4N+ZARPYc0At70EH2r4rXmJrfX6SefltEar/IMifarM+YMlMU4iS4WKj7IVdw/bWtZL0BLZd6P3YGYyh9ZiNkaBLpvvU8N9gbgxrEvp77gLaEPXpQuSUNBLKU4zwvHEstdBi1g8j4c2KT56Qjz4l/CEBffFzmBzz+Ko7Dd8ZiBUtPzGIUpj+PpvjfCR/dbWTblq0YlP5sUX8+jlocuz12/ffe7C/968pPFP8HZfkEEHN26/LLgkYSXl/B5sxWUyw32DYC2SXrJoLz7jkXjrsN337+iLPpri9hZ//loBuuLLz2ieDJ3iIx3sRXeHaiokheJrHF6bl39y37dyIbzhXx04RJPf8hDt15ZaLZaec2l6oEEq3ca2bSdy8e79h6SXDMNLj1NNrtLwawxd+DWi6dWVY3wKEn/7nhRcjSsfc3ma+M//AxgY8fk= +sidebar_class_name: "post 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 + +Generates a 1099 document for testing purposes. + +scope: `contractors:write` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/post-v-1-sandbox-generate-w-2.ParamsDetails.json b/docs/api/post-v-1-sandbox-generate-w-2.ParamsDetails.json new file mode 100644 index 000000000..49933cebe --- /dev/null +++ b/docs/api/post-v-1-sandbox-generate-w-2.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/post-v-1-sandbox-generate-w-2.RequestSchema.json b/docs/api/post-v-1-sandbox-generate-w-2.RequestSchema.json new file mode 100644 index 000000000..e9a9f8fcf --- /dev/null +++ b/docs/api/post-v-1-sandbox-generate-w-2.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"employee_id":{"type":"string","description":"The employee UUID."},"year":{"type":"integer","description":"Must be equal to or more recent than 2015. If not specified, defaults to the previous year.\n"}},"required":["employee_id"]}}}}} \ No newline at end of file diff --git a/docs/api/post-v-1-sandbox-generate-w-2.StatusCodes.json b/docs/api/post-v-1-sandbox-generate-w-2.StatusCodes.json new file mode 100644 index 000000000..e76244e2d --- /dev/null +++ b/docs/api/post-v-1-sandbox-generate-w-2.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"properties":{"employee_uuid":{"type":"string","description":"The UUID of the employee","readOnly":true}}},{"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"]}]}}}},"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/post-v-1-sandbox-generate-w-2.api.mdx b/docs/api/post-v-1-sandbox-generate-w-2.api.mdx new file mode 100644 index 000000000..27b006830 --- /dev/null +++ b/docs/api/post-v-1-sandbox-generate-w-2.api.mdx @@ -0,0 +1,75 @@ +--- +id: post-v-1-sandbox-generate-w-2 +title: "Generate a W2 form [DEMO]" +description: "> 🚧 Demo action" +sidebar_label: "Generate a W2 form [DEMO]" +hide_title: true +hide_table_of_contents: true +api: eJztXF9vGzmS/yq8vockgFq2FSdx/DC4TJzseheZ+CaZyy2coE01SxLXLbKHZMtWDH+Re7nH+3r3EQ5VJLtbrT+WHBu4XcwAM5OoyeKPxWL9Y5E3yXU6rqzTqVQOxoY7qVXq5iUkx+cJTIcgBIjkWy9xfGzxt3fTstBzAPZem6nFL7oE3+9UJMdJqa1LZwep5UoM9XU6BoWfIbsaJL1EgM2NLLF1cpz8xP73v//rf9gJTDXjOf74Vf30Vf3EPk+kDb8waZlWxZzxGZcFHxbApGJuAr4bqJk0Wk1Bua/qq/pTGM0yzr4MmNB5hZ/YSBvmwDqpxqysTKkt2D52sLku4ZhdQJiWPb4y0sFF0ksM/F6BdT9rMU+Ob+iv0oBIjp2poJfkWjlQDj/xsixkTjzY+7vFqd0kNp/AlOOfPDcTPfw75C7pJaVBjjkJFr/GgTMpWo2tM1KNlxj2eQIsdmC//XZ60k9ue8kcuGn1pZUEs9T5Q2UdGwKD3yteMKeZNmyqDTADOfLITbhig/2DF312OmJKO2ZLyOVIgugxASNeFc5iP2R+aWAmdWUZDt7/qpLb216LRecL8/p2e+s/21Ir6+c92N/H/y1C/PjXZAfG8qL4OEqOz2/WsbSqtmUq8pLpEU0tdicR4OKjKuZ+zXESN4mTrkBqKP9J747VvR+CkSfdGb2XKD6F7ahhCyYFKIfrZ+4iHOa0FWVsehe9hW7bUG39cidtw0euRXWodQFcLZE9bcigDpGKcUZ9mXXcQZ+964/77J0SOCBKMXP8mppbNuVz3Cml0TMpQCx1ZqWRqFE0GwKqlJFUvJDfQfRXIV7cn+etDaqqokAVuswQAkSckJZA9VHhMqunfkq2xwDx15h7vqm0NGvqfjWR+aRhgoHSgAXlbJ+9Qe2ISvEvXFXczFnKTiBHfW/YYH8wYFe6KgTyQEAhZ2A8E2Lrwf7gOeNKsAmfAeN+uBkvKpIMJND3Otz/Ji3DmZLyxl5XsihIwRCPCRPTivGi8HNZycXfK24c7MzI0O0HeJnzApTgpiYV+RqoLTJWsWAhzRPL/t33KObsPQgwvGCf+TX7FVxlFHuKGoS9Pjx4RivxpjSy6LEPfN5jf6kUtNchsDkCaDjNniI/Vy3As4dfgaDebWblWOFOvnsTvmHhCxsVfIwmxjGpBOp0sOxqAm4CphFRBSAsC+TRPint+uwX7cB3dc2MaAb5hKsxMD5ybSrSk1izG6NPkAU7k/kpNFJVq6n1QhW6ejUb9BW3VueSOxC129FnH7R1QadwA+zs5L1lV9JNGF+icdE2dqUYXfTZJ5RQkkpZACt5fsnHyDac+hDYd1nSF8ueIjEuiWs4xrOtBvkuy4sgJdw5I4eVg5r4Bc7+ApfIe1u1KzXhNkgOKJSdkptVnO4tGMr0JHRP33pE6ed5CfQf8hyuU7jm07LwVvOd/3NjQJPDo1yIF5Cn/FCI9PDocD/lh4PDlItXr0fPj8TR4f5REg1kkutpydU8E9JA7jIBpbYSjXOEdEIf2In/wN5UbqKN/E5sWZLhL0Byyea6Qo2PosVKXoK50uYSf+GhO7CK/CMBQ+lom+UGhHTY07AhV5eM57mulP9Ii4p/KPncN3H8GmjrBRs34oWFaD9wPVpa0P91eUt63q8R8qQjY4H30bevXfq2I0cr8O02+HCH+4fLbtsv2rH3ulKCfVWMfVW4RYL3DIIZsLoyOYoQeNGBa2lxc/BLYLYyEDzKYGzJE/L7XApyLXvJ4WCwPOxvqjQ6B2tJrb1TTrp5jUB6Kz7hZQmqEeOhFnMy+MjvgJGF3WMZGKONZbbKJ4xbdiEVgcjq7ZGR8rnooW5yzSzZiMvCMlEByYNqetbBEW5n8DM9f+eHecsdjLWRYL89nThX2uO9PaFz26eIrJ/r6V6MwNKSz40uCvq+RzDTvO7+jI0rKUj7eY9egENAyLwd/Om7ufsHc7vM7br/CyEQIcH91IlP/O+N9eTG8HnSS6SDqV0VMi5RzS4BOwSU8zVjUKs7/e9PIcojexw2I3VnOs8rY/vs87yUOS+KuTfAlzBvYgvvI9VruFdyw6eA9thAQdYwRIxEkuLVGvUO0FwMavQoUGJkiAOpqD2ClLGx0VUp1dh6NcwVmrTKejTDShaC5SgH09B+wpUo0HpK5aW3lQ6hcLgeSFp2oUixZX4dL3oEzq9VcEu8yDPOfEt2EZqysEhzb5/Bqyz/kVgzxf023iIUO4vzDdLI+FBXrrV2KfOZl3rVAunIDFuZEc89Q7hioATyxwQUjgvuVmYvFmG8jZvbQAEzrhzDfkgzCMg87ORgAqRitKcxziO1ETTSsADvlAc3oLdAgvARqy78/8mcXdDaxl/QTF3U3ks0JmhMtYKQJtg8l2lVOFkW4MfCfdTZePHn5c0Wv+ywpRfHtlKN48jYjQsh8RMvzlojedu+Yux5x4ldJzW/8GntrwaOBr86ik2ujU/TCHRlSBpaDL57hN+U/L1aSD2Mgjb3ZIii194jo6cb/O66XVVmTm9uuKDnVjWgqH1TkyYJknwI0p9+kW6SflSQeuOX3K5v9SHIjm+KS0Opoj/W/B9+zZHSWoPdCRRQ+VCumhxcJjeajT47dfhzqa2V6GI57eP8Wg8VMIPC4toFMxINRa1WklyavCq4eerhpuT8pB9J4J4l7RmuaOAFejH0wiglC1FKJqAAB1mlRpUSILKSzzGoWHBizhd8jWTILbQdE0xHd5y1pGXmkveVElKNP4CbaEGxZRyN1aPRGiwAm4GRo3kmFYluE+I9JLK/LQVtOVchZULjSxB9dlYAt8DyCeSX3klBjzXAYXyKHdG0r5sCLzBsnmeR4qNOANkbBvThez2PFQCn0qKGyoyuXEj2rAEWWmSqwvzhaogdJ38B6K++P/P9cU9EsxtwBUnAYHYkx7aGVvuaO3FtuXcbzBvHcEkxHYYpl+jMTsPhSXQsVgOLsx1x6+JuyQo5lW4DwhWNd2bhe0QcaDCiwewkpnB54GyNOSvBSC0avKBEJoK2XIOybrIS22peYnId+7R2DkVQdNL0nE21chPKzI8qVxnw+GLyRipRWWfmmYUC6CgwU1zmNsu1gKxxzNYiblrvzs9fsC/DvivEcTuEYZjHBzjtnuu9ZEKOZa12NsC1EYDdAq6VuW+7O9pPMiesdhnsYQDrsTo5hUyPRlmpC5nPM0zobbfW03sxcbpqfbsgKkU7CkS9X3iem4oXmdm8Zxaa7aC53/h+DPvVHBsWqMrRs6rxMAIowa4BXgIZ1ywkUjZZx07XXdC+9ZtbAB7Yz+h0jGj4GDdgYDgA06NRzOqsw1wfxG+z7HXj3dc+1jH4xPzWEjDkBVc5ZFV5h75cb603oXrLFWVIufg7LbsfzW5e9okupECtjv96wNGtIEf0Ib2it16Z1G4EuRQsIKBMtkewHprS7vFg1SnmcGK2DKzHyuCyGUBZ1QrWQq3NYy1mjyKKp75NU9mBYZdt5TAIn1ZDzQ264XWBwgPyL+5hdPhZPVRTC0EQlibzgAg+U+4Rj6JUCEtDmU/MAmNyuWPRvFuRgcL8ER11GJ47bTJNx1BrsXVb7r5NawI+3mv8G49F0IYlKUfd5/E2Gzbif0w/tjPHFWbOOm7Ib6fjU4r1t/EClnvtzr+z2q9+soLek2YbN6kJylOysFFmeLjqZxFTi9viX2j/Q8gXKN2JObZuQho8csjGRluL6Y44uAIKBjb5OqHF7u4OUIxQexQxLuhAIq8FV2SiK7ONY3g/U/dnpN7aOQrG3MlZl0Fhj+doB4sH1Ddnnn4LgB+i3h4jo7+DygKOB9V0mPUJwy+F5OHQDXMLp876dHqD0bsdAk/IeOHArEGbBSqb4/YfAi5tqH2qAcejlg7UWLaBPlUAW6mpFnIkSW1HyDGb+ZBg44lRubTYHoDn5ALLvaK0YGZBi9u5dTCtG0Ud3vUNSAvYDGs9+KZof7H9jyigRUrNrlaM0pMB55Rfy2k17eK0lSk5zvkRob67zgHQiwgYcCUO9veJq4XWl1W5iZePCCw6XO/apbRP7bN+snj21ZzrnHeS7nX4kHRy5XH8FP+aHgye4wwXFNqw0PklmNr4U9JNqpHeSfg71FY6wyQRwRFeyANKxbQRQAWMplJxe3Sn78dexrl5PvXiWHBV+TiT4qJxTe39ptOBuXlOI1+9lzl+/ZjTQr+QHPAwHtV+0Xj3m+My7C1E0eeEfZHIg09zQQyjxopZ6B+QywXQqydpK4u5iB1T7NtMCusNI/G2EbxzCg0kD9lWQ5qVVktLU+fsNrnmS93vk6qribBIhNWDNzFEsg5wY5V/FO3CcVmHf3G0oI0phc7zSeYmBuxEFyKDYHyS1vldFwFNC2qsu/Mq8oXqazFtU99RQQkGq4sZMMrNv3n7Z/Y5gmPRMrbOj7S2lIxAI/lFGmCnqsc+6BmwzxqL6ww74XQc2TaYMzB2120a+9bhSyTSOTuivBh3DqYlBbFOB5eO8aaeo0LhRJdDVy7Vo5S+B4IxzJRjxZ02mNrjstgurcdlcZ+UHpdFO9DtAohxd8yOTbgvnKSvD59N8ae59YEHLm49mr9SEADVYmBgiitOR+cxedB0GcIIiWGdADKdKbhCotHRk9cgMiHtsDIW6DCpObdeM7F26x12Xyu3EM+tVno/G/beOhKLGLTLRlhXusDdkxZo2nXUxHPhkacn9sWIDwaDlIv9o/QQ+KuU77/k6auDVy+PjvLnw4NXrzdMOlKb0mn3fXx/f8Dn+9f202uNY7ZY1dxjb/FQup90uRJRYH1Eda8IxKPw/aPq8x41uvblIsonwdv2R/xP+lGHNYu7KVlDub9tpGJNzfFVqFZvyUgykkraSRaynGhdsZDAu16PkJMODPIxvtO4sx1rBu/kBAvtvZiMSN/lhVlnAFx2sPsq0m1AqfKiEqjRPSHULQasXZKZ3Jco/dgYRKRL2Vfp7G566RqWv9eF6vLKaLyH5aPv7hjfZXkPMfcqGRTG2jGLh1cu6ND1Kd0YOhg8P3zxbMUWm2gF966HOMPesRoibvKD/YWDUqw4KGS+KdOwcvOIyleAw7qjx9bWweM7NwHbKu9tklX+CKcTwG+TyF4Ja3Mdwef29YCmJoNW368L1mZ7Tznu8UJftcobqJZrU3FDE9vfO5uAQ8Zqvq5AtHMEDzNAPclgybwPa++2+aHh9uaQRgmOdtRSdKVpg6XD79TnXhEI1gSDCBe9noQ+T5qbBEqzEsxUOhdb2WhVhtzK/JGjc05lflF/R2+TnIzdQli67tayQyEMXOF/RL5dheLwNbOjzzsz/AuWhUc9M6ZjURNcVtMUauzXhmoJ3SPm6OsrZ6uT5J2cs0eAOXxGlem5Y7YqS20c83fBinn3hD+oozgHfwL64HnoTvFDC7IfUHROszaVi0ljXXa/gpf32JepTtnLkrYSZB9G2VAaN9l9lBM6Vx8x6l6HxsGCUtmEdwBJ52x3TFvXgt7HiQ/O+6sBh8OXB69Swfnr9BDEq/ToBeynB0cgXoh9gKPnLzaoNDoNu0dQWhScvZfu+xhTcYIqfjkqcwzXGG5Yf5G6cxpmwV/IZc08omO9ItB5YE4NxKvh6OUgT4d8OEoP+cEgPRq8HqTPD/dhIF7nfDg42sCp+2mhU8sln7CfwRRS1WxCvuDjHyrwamsORZ8alPX+dJ332Fy3s75Wa2MJa/BG25LeLrpciaQOLtXG+tCFZveO1rB3J2JkeATbY18ALjHVpNyErt79Da+bLqOOSZNa9z5wqBQH2qTtdcug3i4U8C/cVkxXFrv3knah+8/RUfAs+0f2GG57ya8tu3HXhP5JDMhtL/mltiB3zfkPU/KHKfkBU+L/wTOlEHt6pOG5gf9M/0RPaL05O03/o06mS7wSNAEuSEM0We9wqX/x6tAJEp1KFW66ooynqHgEe3N2GhPq7ScmKDinm6rYAC/nhlebFO3MGC33fJvWve8nlp1PpaLz+BbtHS9J81KmoadU438NBNPWz88QBt64RUW29BhWfRULVDXFu1mD/cGLdP9levDCv7hBr02h/DS/395+w9tKtgR+CdzOU7rk2yoH8M8XLLbBJUr1DIyRAgeOz5F9wdfI4NqBshQN43J6kVv7IFovapn2w2i4fWK/LrK6Qwfh6j6LSJu+LcTIgJA79g+t4XtT3E2S42RvdrAXnlzbW3xyjUpZgsBWpkChDCvNS+kXOhUwpdVeutKGb6x1OOrppT4fjp9xOmsIr6R5Zij3vY5miZ9xphbyylDe5vwm2tU3Odp4fK8jOT7/1m71CUXMm/YVbWvBQ4hRIOnhGuBmxVtpgURKV/DogQ/Mu8Tz5V7yiYqCfmQET2HNALe9BJ9n+LV5ga71JMrCi3HNTvKvhOxTNs4Xk0TfiLQTbnaUqnhi2N5ZvQS1j/04+gRmJnNoLWWjCOiC+R413BOIGl25lP6OJ382dF1+PaXI6RkbzQjHE8vehd3DYg0e6qH4Yglx4F/CsxXcJziDnj2Jo7Jf8WmBkMXyh4Uoi+HrvzWiRzpbWzflqkUnPhLo3wikJ4POT959+PitC/6meTvj//lbhUH2HFy7vbLgkoSUNuVN0BDnyQxPCYKOSHpJW0t8w/J367DVzQ3and9McXuLP/9eAZrd82+okAxV7NHO60XThptTSHK71xi3Nhf/ye3cymXwqn61kxCVfMsmtB9IarVYerql6YFqqHQb27YNx9nHT5+TXjIM71pONRlGw6/QTeFXiKZXZ4nx4Uv87SYpuBpX3r/yNPGf/wMf00xV +sidebar_class_name: "post 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 + +Generates a W2 document for testing purposes. + +scope: `employees:write` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/post-v-1-webhook-subscription.ParamsDetails.json b/docs/api/post-v-1-webhook-subscription.ParamsDetails.json new file mode 100644 index 000000000..49933cebe --- /dev/null +++ b/docs/api/post-v-1-webhook-subscription.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/post-v-1-webhook-subscription.RequestSchema.json b/docs/api/post-v-1-webhook-subscription.RequestSchema.json new file mode 100644 index 000000000..a977d2420 --- /dev/null +++ b/docs/api/post-v-1-webhook-subscription.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"required":true,"content":{"application/json":{"schema":{"description":"","type":"object","properties":{"url":{"type":"string"},"subscription_types":{"type":"array","items":{"type":"string","enum":["BankAccount","Company","CompanyBenefit","Contractor","ContractorPayment","Employee","EmployeeBenefit","EmployeeJobCompensation","ExternalPayroll","Form","Location","Notification","Payroll","PaySchedule","Signatory"]}}},"required":["url","subscription_types"]},"examples":{"Example":{"value":{"url":"https://partner-app.com/subscriber","subscription_types":["Company","Employee"]}}}}},"description":""}} \ No newline at end of file diff --git a/docs/api/post-v-1-webhook-subscription.StatusCodes.json b/docs/api/post-v-1-webhook-subscription.StatusCodes.json new file mode 100644 index 000000000..e011591ba --- /dev/null +++ b/docs/api/post-v-1-webhook-subscription.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"201":{"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"},"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/post-v-1-webhook-subscription.api.mdx b/docs/api/post-v-1-webhook-subscription.api.mdx new file mode 100644 index 000000000..da0a0b6a7 --- /dev/null +++ b/docs/api/post-v-1-webhook-subscription.api.mdx @@ -0,0 +1,75 @@ +--- +id: post-v-1-webhook-subscription +title: "Create a webhook subscription" +description: "Create a webhook subscription to receive events of the specified subscription_types whenever there is a state change." +sidebar_label: "Create a webhook subscription" +hide_title: true +hide_table_of_contents: true +api: eJztXFtvGzuS/ivc3oecAGpfFDsXPww21z0eTBIjdjY7cII21SxJPO4mOyRbtmLoV+zLvM1f3J+wKF76ppZsKTYWezYPQSyJLH4sFuvGIm+i63hSaiNjLgxMFDVcitjMC4iOziPIR8AYsGgQ0aJoNtHRt0GkQBdSaNDR0U003NvH/xjoVPEC20RH0dtrmhcZkNAyGkSpFAaEwba0KDKeWnq7f2jscBPpdAo5XaZ0NkUqhQINwtguRI7JFYymUl4SXY6qxjvRIHITiOToD0hNNIiuY0MnGqf0xfWw+A03GTbz38WnDSrRICqULEAZ7uZXlpzh/560NoqLSTTogfn58/EbBGemsBKgAso+imweHRlVwmIQlSq7G/UOxREo8vnT33bI54JRA5pc8SwjIyAnH0/PgBEjiZlybdv0jasNNaXuGxpEmSPHChDMfTMDxcfcioOCXM7sX6VQQNMpHWWAPF0G7EbYmCHNBglia4KkStH5Ens+QQp8BqT0rBhLhWNqILZ/e5gxzTQMIm4gXzv9V1RcvkxTWQoUpNcyL6iY13+9AgFj7n4SRtHUSNX6cELnOdi+b/Mik3OAxp917/DNX+UIKYPQ1Ivh22sDStDshM6VzLJoEL2TKo8G0d9kGtp8kIaPefWxbnpC56fpFFiZ4bCnfCKokWoefVssFrgtwG1QywG/WWthj9LDMaNw+Cw+PHj+JD44HL6IX1AK8XgPWArAXgzZQeRlN5oaU+ij3d2CKiNAxbQodlKZ79aCGtXi1pSlvpX+E/MdhfB7yRUwnKbl9LfFIFqxEjOalT+9JGYK8a9luWU72B1xsHewbHs+SEPeyVIw8lUQ8lU4W/S9BG2AoW2TpUqBMAmaCGkIXHNtdsh7eglElwqs4iuUnHEGzJkHrsmMZpztfBURDjscLg/7WRRKpqA16lbyVhhu5hUCrklO52RKiwIEuZqCsKOMJJujqp3LUgWMBE0u5UITUEoqTXSZTgnV5IILCyKhxig+Kg0kVtwuBsRpzorCmPJME1YC2hMq6p5oIS2bL3bIKbiZnr91w7ymBiZScdDffguSyGSqd6zDYYUwOBhx4ZbI/r5rYcZp1f0xmZScgdXnuVRAGBgEhMzb2qHo4+4v5naZ23WkmqrLTRiNfttT8t8vW+uurV1NNbkE7OBRzleMYVvd6jSdFpCiTtO4kH4z2u5Epmmp9A45mxc8pVk2d67SJcwJZyCM64XtqzVE60ZzMIACkFETPCxPcgc3c4V6A2hIAduieDlKBLVMIBW0h5cyMlGyLLiYaEIFIykV6PGV2qEZlTxjJEU5yH37KRUs42JCuHDS23Dld8jxuB6Ia3IhrGJL3DpeDCw4t1bOu/QiTyhxLcmFb0r8Is3JFTdTAk5luR8ta3LcbxO4nTMnYb5eGgkdydI01i4mExCg6lXzpAMzdKnGNHUMoYKAYMgf5VEYyqihfaLYhvE6bG4FGcyoMAT7IU0vIHO/k70J4ILYPY3hiVUbXiONMtgh76Qi3soPWiQsPsuqC/e/NbcXdm3DN2j+LyrnPhgTdGmlgI/j6Oj8trnkZWY4BmOWIu6jzsYLXy9vtvDLBlu6PbbmYhJGxm6UMY4/0eykMRJ6/r1jO4bcLjUfaA4h0PAcNVPaFJtUKheLMk2MtNLQYPDtI3wW/HsJtXpQIcjw41mKTnuPlcxrguc1RVFmmXX5XLuySIxc37Cl5/oaoP8G65os6mj3vZf++As30/ijgNgZv2ixutV7LzuuKS7NYvBrzf8Ma25Dj1UGu82HL6h8pMjmzsElfK3Z2CHHBr8upNYcXSwjyZTOgFR6KIMZZDYx4M1IMBSVWolSrtIyo+o3Bze2zk/80Qrc46g5w54GUU+MO6LiMqEufkkYZGAgKcW4FAxYUrjYpOXEnLd8jWhEXRKrMvHRkrMWNcxc9K60yZP3YKaSkSnVJIxGqtHsGrSA2ShsnnBhRTdFpIXU/F6R/R3dAByV+FHRcmL0MgISosAdcpIB1UDSKaSXzklBj9XDITTHjmjaV02BZphxmSdVXPmQE0D2+gHJCEDU8+gBmHONGipRsjS4bVYD8y0SUeYuWu6B2HHyW0A/uf7E9cc9Ecyux+UlIUmlGPOJrqBVvuZGXFvu3QTz0hBcUkOkAFI7s3mpTdOx6AcWZjum2oTdkmQ852YNwp7GG7PwHSL2NIilQfRUlhlDzNRztsKcFKC4ZDVeECxhXluuQFk16cXWz8u3gqE/CI2dYyMoM6WCPCG5FGaq0Sccl6ZU4PClLlGScMFKbdQ80ZBBapMsgvJUJ6lkkNSO2UrEdevN+fkB+xLs2yOOd0Poh3l4gEE04XtJM7QiTwnjE16pnTVwdQCg7wBX89S13RztKU8tVr0M9sCDdVgNzyGR43FSyIyn80TQ/I5rnW/FxLxvfbsgSmF3FLBqv9A0VSXNErV+z7SabaC5X7p+BPtVHBtlqMrRs6rwEAuQg14B3J9MJD6Rss46drpugva129wMaGr4DCE7Gi7G9RgIDkDkeByyOqswg09s6rsse9V487UPCVRNqIK7S8CIZlSkkLgjlK2s9TpUr6mwGVLK/rDL7kbT65d9KjPOUKvjPwc4uBXWEb1Pr8insSs3wroUxCNAC+QXfzU0Ic3DwapSzNaT7gM2IIV32RSgrEoBK6FW5rESswcRxWPXhgQSBMMu3chhWHxSjCRV6IaHdvfJv7CH0eEn1VAVJAdhaTL3iODM5h65tskeG5Zy0coCY3K5Y9GcW5GAwPwROmH+DCWR9gRzJbZuy823aUXAxXu1f+OwMLthrZSj7nN46w0b8D+kH9uZY4+Z04Yq67fTsQFlY/27eAHLvTbn30nlVz/qofeo3sZ1asLmKYnfKDMQxs8ipBbvir/V/qeQtyjdijm0rkMaPHJIJkpqjemOMLgAGwys83V8i83dHbAxQuVRhLigA8l6LbgiU1mquziG25m635F6Y+cImFDDZ10G+T2eoh3M7lHf+DPPBgA3RLU9xkr+AJF4HPeq6TDr44dfCsn9oRvmFo6Ndun0GqNzOxiekNHMgFqBNvFU1sftPwWcazICVG4V4HDU0oFqU41cWwfQgy1FLhkfc6u2A+SQzbxPsOHEqFhabAfAcbLFcqcoNaiZ1+J6rg3kVaOgw7u+gdUCOhlLldN10X67/c8ooDalelcLYtOTHmdOr3le5l2culQFxTk/INS311hwAYx4DLgS+3t7lquZlJdlsY6XDwgsOFwhBrAlB7/pxztR++yrPtc57yTdm8UZrVx5GD/Gj/H+8AnOsKXQRplML0FVxt8m3bgYy42Ev0Ot1xm2EuEd4VYekAsiFQOF9kmVImyP7vTd2Ms418+nWhwNpiweZlKU1a6p3m46HZjr5zQGhkepiaHXDzkt9AutA+7HI4ZeEzvednNchn0HUXQ5YV8bdN/TbIlh0FghC/0TctkC3T9JXWrMRWyYYr/LpDgWtXjiTSN46xRqSA6yLkd2VlIsLU2Vs1vnmi913yZVVxEhgQipBq9jiGgV4Noq/yza1nFZh39hNK+NbQqdptPETBXoqcxYAt74RI3zuy4COy2osG7Oq8AXFAGbtplRnlF/mIcefzYDYnPzL1//Ts4COBIsY+P8SEptkxFoJL9wBeRYDMh7OQNyJrG4TpE31B5HNg3mDJTedJuGvlX4Eoh0zo5sXowaA3lhg1gjvUtHaF3PUaJwosshSxPLcWx/9wRDmBmKCBPIKc/ultajPNsmpUd51gx0uwBC3B2yY1Oqk+rX+8+muNPc6sADF7cajdjyIA+oEgNXNe6OzkPyoO4ygjESwzoBZDoRcIVEg6PHr4EljOtRqTTYw6T63HrFxJqtN9h9jdxCOLfq9X7W7L1VJNoYpEnGWFfa4u6bBmi762wTx4UHnh7bY2M6HA5jyvaexwdAn8V07ymNn+0/e/r8efpktP/sxZpJB2q5Pe3exvd3B3yuf2U/ndY4Im84noWTN+7weUBe46H0TtTlSkDha5q3RuHvLXjV5zxqdO2LNspH3tt2R/yPdoIOqxd3XbLG5v7uIhUrao6vqO7KSDTmgutp4rOcaF2xkMC5Xg+Qk/YMcjG+kbizDakH7+QEM1+lnVjSt3lh2igAk+xvvorvUXi4SLOSoUZ3hFC3KNB6SWZSV6L0c2NYIl3Krkpnc9OL3ZC1Pkt8paSYEB99d8f4wYstxNypZBAYa4cs3g9euEPX32BnskP2h08ODh/3bLGpFLB1PcQJ9g7VEGGT7++1Dkqx4iDj6bpMQ+/mYaWrAIdVR4+NrYPHd+56UIW2Tla5I5xOAH+XRHYvrPV1BGfN6wF1TYZdfbcuWJvtPOWwxzN51ShvsLVc64ob6th+62wCDhmq+boC0cwR3M8A1SS9JXM+rL7d5vuGdzeHdhTvaActhRtNr7F0+Lu/E7NFBII1wcCI/Yk88n0e1TcJhCQFqJwbE1rpYFVGVPP0gaNzasv8gv4O3qZ1MjYLYQUA0w075MPAHv8j8O3KF4evmJ39eWOGf8Gy8KBnJvZYVHmXVdWFGnuVoVpC94A5eutJrE6Sd3LODgHm8ImtTE8N0WVRSGUIs85RNu+e8Ht1FObgTkDvPQ/dKX5oQHYDss5p1rpyMa60SbYreHmHfYnolL0saStm7cM4GXFlppuP8saeq4+J7V6Fxt6C2rIJ5wBanXO3Y9qqFnQbJ94778+GFA6e7j+LGaUv4gNgz+Lnh7AX7z8Hdsj2AJ4/OVyj0uxp2BZBaZZR8o6bHxNMxTFb8UtRmWO4RnDDWhmedk7DNKCPaEPE6qjZM6En0LlnTg3Zs9H46TCNR3Q0jg/o/jB+PnwxjJ8c7MGQvUjpaPh8Dae200LHmnI6Ja9AZVxUbEK+ZHPLoit/e+VuHAo+dbgZWanQW2q2VtdqrS1h9d5oU9KbRZe9SKrgUqytD2012zpaw96diJHgEeyAfAG4xFSTMFN79e7vQPtQh6RJpXvvOVQKA63T9rJhUBetAv7WbcW4t9i9fYX4VXAUqgvE/2c9hsUg+tSwG7dN6E9iQBaD6ENlQW6b8y9T8suU/IQpCbffK+11jHMrpDbxbD/2T3bEuv08SuempCs3pL0PfLjjAvc4hy1uqp4D0f4GLCPLzw3YG5Qws856KJ6zWTk8T6BiAjtfxVfxF/Lf//yvf5BTV8bwMkUlSV6WZoqRpMs1fRV/wXbWVQXBCsnRYGh/7fb8FVAFyvYh9rZ4nRvw1RGxvaqEB3tI3MhLECEx8/vZ2YntKhX/4RU8UAZqw2vZfiA3xGM7M53KAo7Ihedo0uSQPrpS3MAFvtMAaals/H9+Ezk2OC4gqujo/NsCL3SGrIKTQasdj6L/jP/dvv3z8uQ4/o/qmITjerpJtK6I+hdT2uv+BonmXHhmovaK0aQw8vLkOByVEKq1TLmtl7GstXeQsQFeu7YXkAXabF5XhQ5cm8aN/keanOdc2EqLBu0N+UwLHvueXEz+1ROMG18/Rhh4lxpNVP16wKr3YYZ7w8N472m8f+ievxnTMjOoGervF4tvg5AXeiWZzdTUbHU3ILd8xaDnin7n2aK+d4Xu+rzO/+vHcVqvtKis/0WUO73cssHzOL1vrtR8rbj0zWvsjjSgx9jz0NV1rAugl0D1PMatH8sZKMWZTXlZxd15+gquDQht82ioLpyxWvlS2CDM9ZYXw9AWB1KrAFW0+oDhPvKHS848obhT1HLR7mx/t1dRWg2pZkHztReDFtxpjJhBbtXGkmF7A7mM2ix09GJ3ZIY/48RWEO6leaLs8dgqmgX+jHMNqv3UWiUrYF4Wmhq+2p44eNBZ+HlkDVvPowaWRDBqLVOJErRsQzYd4bRlNTsDLAYRarVPtT5sPjxluVjpmdvfIHLpeVddFoIla9TQRrg3y1wJQVMhDyI0Wvrj+BTUjKfQWLjaftgXJ3Ztw12GM0G1GtvPWAqgfdelW9KQpTK3FRIWxyNN3vpNQUJRLpovJtMyD2/Z/Yt/x4a6Ew9vnt+EUcknfGvES7OrHkDJ87/+Wy1oyFzcFzkVDTprfbPuBG5qU/TLqftfc+r8fjNwbXaLjHK7Mb0tdxrvPJrhsWi/zvuG9320wVY3N+iOfVbZYoFffy8B44zzb6holS1Rtj7iIHh8qCQZt3mGFT5fU0L+5O5f7zI4E9bvOwfjFdW27rVjVnzWMpXLXl7dA+W9MGvbNg0hvvQYDaKR9yxzae26olfovdMr5yWGYzF0PfG7myijYlK6gNLRROVB2/q+0u/+j8YrM84hCQhvblyLM9xGi0UUuGS3lU1nLP4Hlfhvpg== +sidebar_class_name: "post 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"; + + + + + + + + + + +Create a webhook subscription to receive events of the specified subscription_types whenever there is a state change. + +> 📘 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/put-add-people-to-department.ParamsDetails.json b/docs/api/put-add-people-to-department.ParamsDetails.json new file mode 100644 index 000000000..c2fb5baa0 --- /dev/null +++ b/docs/api/put-add-people-to-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/put-add-people-to-department.RequestSchema.json b/docs/api/put-add-people-to-department.RequestSchema.json new file mode 100644 index 000000000..76a9b3ebb --- /dev/null +++ b/docs/api/put-add-people-to-department.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"required":true,"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."},"employees":{"type":"array","description":"Array of employees to add to the department","items":{"properties":{"uuid":{"type":"string"}}}},"contractors":{"type":"array","description":"Array of contractors to add to the department","items":{"properties":{"uuid":{"type":"string"}}}}}}}}}} \ No newline at end of file diff --git a/docs/api/put-add-people-to-department.StatusCodes.json b/docs/api/put-add-people-to-department.StatusCodes.json new file mode 100644 index 000000000..96736bb54 --- /dev/null +++ b/docs/api/put-add-people-to-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/put-add-people-to-department.api.mdx b/docs/api/put-add-people-to-department.api.mdx new file mode 100644 index 000000000..ed9c94f93 --- /dev/null +++ b/docs/api/put-add-people-to-department.api.mdx @@ -0,0 +1,72 @@ +--- +id: put-add-people-to-department +title: "Add people to a department" +description: "Add employees and contractors to a department" +sidebar_label: "Add people to a department" +hide_title: true +hide_table_of_contents: true +api: eJzdWNty2zYQ/RUUfUgyQ+hKXainunHa+qGJJ47bztieBCSWEhoSYABQtkajf+8sSInUxUndZKbT6kUiCCx2F3sOzmpNH9i8tE4zqRzMDXdSK+ZWBdDZDYU8BiFA0IDyomhPsfQuoLqA6ulC0BktSse4EKwAXWTAnGYCCm5cDsrRgDo+t2jzfDfobQiwiZEFWqEzeiYEgbzI9ArAEq4ESbRyhidOG0ucJpw0Rm/VrbKJLmBGPjSjdnZvpIMPt4oGtOCG5+DA4NZrqngOdEabye/LUmJ0EjcvuFvQgBr4VEoDgs6cKSGgNllAzulsTau0UOuMVHO6OXT+3QLI9fXFOdEpcQtoeUo3wW7zP9jPPt9nlxfsNzAW19YOLIALMHsupDyzcLjROUaUSwW22oc7YDG3IMjZ5QVZVkYJt1YnkjsQ5F66BVnp0vgJCc+yDrlIidIKiLSkMHopBYigmsOLIpOJP9hnltzkUsm8zNu2754vnCvsrNsVOrEdX0CdROfdbcGwgq+MzjL/vssLyeqVUs2/rw2y1vALdKO0IDr08YQHFFSZYw0NeoMR641Zf1SVUMrLzNFZe3yzuavyCNb9qMUKzR2eLNYWns5sTVsxd/+0mOX1sR86/hMSrOXCYOk7CRbf1jGccvi4QJLSGFBud0p1rVSmO+QKwD/fNPki81IKeGLKW+muTLOMr8C8IKk2RKpUm9wHS7QiC32P0Cotbi0tSSVkooP1vYNiKzZuDF8dhXaGoxhMg15EqxD4dQCGgEoHube5n0gPxmOcbTab6qxqHvj7zhySx7dyZ1P5ZMAWWtlq9qDXw69DpG63IW/8MZBXDzwvMqBfUX08y96kns/+e3UpBeSFdqCS1ZNqcRNQJ12GQdSkyeMMPK9+PgmnD/FJ1E0TnRdcrd7/M1v1atqE8CULr3kOpz35KkBya+VcwQkMdP4lTH5jjzznb8vkfD9xFey8gS0EESI8K6ExSkfjwbgXDwVLhpMRC/ujhMWTCWeTkYiidNKf9KMhPSwIOulNJ3wwnbLpMIxYOB4OWBwNgMVJFKbxJEoHEQJ+69mV43Mgv3CFymMHUiqiXhj2hAjH4bjXF/1kmoYQwSDsiTSe8DHdO/6bnc9hvx9F6C6PooiFYT9kURr2mIjidBSN4/4wFBQzs3dczfphOJ2Owihl4x6ELIzClPFhyFkkppyLIedxOqKbuy3phb3wmOdea0d+0qUS5FYRcqsQA/XlC4IYsLo0CRChwRKlHYEHaV2H/Mo/ArGlqbhlK0Mq9EhLljyTonOrPPwfmC2AfwRuVwylFNNLMEYKX3JCXHrViTl6cKCsl6gY5EdY0dnjIjfYlsAXxC4SzdbUY37sbLX8wbzn4Ba6Vshek7oFndHust9tqdbu+kCVbrpcoC8WzHKrX0uToUysCZcXsuJbJiD3pHuEunPINd3PXWWP+aPHdZ5DHzF80ual0eIzNgt8jWFbSEoj3cp7/rJCzFmSgLVnJWbg5q496wqvuwqfJ+bu0I4ubiUiPsfAjZfM+z7WJlgGS8gIL90ClKtvWKSDq5V1kH/NDpWFRzbYBBSv8beN/Gxzzg7xja49hestsT2O3N2MDTYQqfZR1CTjmwzU7Hsc0xLIAcUmwr5Jr8AsZQKt828ucR7r0nX9xK7AUJGImX9mOvXnjksPk/M7ZInOAWnd+/HMklc1ushlJQd8OyF0UmLB+7R9V2sinnhNVLdL59tdyVvIajRiwrjMfAHXb39o6hWzX2jrcq5adrCzrDrTwzby0Pt1o8y+eT9a15iDB9ctMi59MXrwrWteuKHLvveo6ZIDOjvuWJEc7gK60NbhovUaG8Brk202OPypBIPAu0NOMtJrJSwcIS3+fqSxbEf+/G3dLL0gnxFHj0S0VQJq1SJFGtQMehiMr9+6932ak//zRvhkbqscnv4XYZfq5rp6WSWLvdu77Y47jmYFsmLhPju3faldXr+jAY3rFjvX/kI2/B7/xuD31bnrogIu9uA4tqYZV/OSz3FuZRI/fwHI5nST +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"; + + + + + + + + + + +Add employees and contractors to a department + +scope: `departments:write` + + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/put-api-v-1-companies-company-id-payrolls-payroll-id-cancel.ParamsDetails.json b/docs/api/put-api-v-1-companies-company-id-payrolls-payroll-id-cancel.ParamsDetails.json new file mode 100644 index 000000000..7db1e6b2f --- /dev/null +++ b/docs/api/put-api-v-1-companies-company-id-payrolls-payroll-id-cancel.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":"payroll_id","in":"path","description":"The UUID of the payroll","required":true,"schema":{"type":"string"}}]} \ No newline at end of file diff --git a/docs/api/put-api-v-1-companies-company-id-payrolls-payroll-id-cancel.RequestSchema.json b/docs/api/put-api-v-1-companies-company-id-payrolls-payroll-id-cancel.RequestSchema.json new file mode 100644 index 000000000..c96bcede2 --- /dev/null +++ b/docs/api/put-api-v-1-companies-company-id-payrolls-payroll-id-cancel.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/api/put-api-v-1-companies-company-id-payrolls-payroll-id-cancel.StatusCodes.json b/docs/api/put-api-v-1-companies-company-id-payrolls-payroll-id-cancel.StatusCodes.json new file mode 100644 index 000000000..4b464d04d --- /dev/null +++ b/docs/api/put-api-v-1-companies-company-id-payrolls-payroll-id-cancel.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"type":"object","description":"A payroll that has been transitioned back to unprocessed state after cancellation.","x-examples":{"success_status":{"uuid":"b50e611d-8f3d-4f24-b001-46675f7b5777","employee_compensations":[],"payroll_uuid":"b50e611d-8f3d-4f24-b001-46675f7b5777","company_uuid":"6bf7807c-a5a0-4f4d-b2e7-3fbb4b2299fb","off_cycle":false,"auto_pilot":false,"processed":false,"processed_date":null,"calculated_at":null,"pay_period":{"start_date":"2021-02-01","end_date":"2021-02-15","pay_schedule_uuid":"00ebc4a4-ec88-4435-8f45-c505bb63e501"},"check_date":"2021-02-22","external":false,"payroll_deadline":"2021-02-18T22:00:00Z","created_at":"2022-02-01T22:00:00Z","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"},"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"},"created_at":{"type":"string","format":"date-time","description":"Datetime for when the resource was created.","readOnly":true,"title":"Created-At-Type"},"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":"Unprocessed-Payroll"}}}},"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/put-api-v-1-companies-company-id-payrolls-payroll-id-cancel.api.mdx b/docs/api/put-api-v-1-companies-company-id-payrolls-payroll-id-cancel.api.mdx new file mode 100644 index 000000000..ee0c8761f --- /dev/null +++ b/docs/api/put-api-v-1-companies-company-id-payrolls-payroll-id-cancel.api.mdx @@ -0,0 +1,74 @@ +--- +id: put-api-v-1-companies-company-id-payrolls-payroll-id-cancel +title: "Cancel a payroll" +description: "Transitions a `processed` payroll back to the `unprocessed` state. A payroll can be canceled if it meets both criteria:" +sidebar_label: "Cancel a payroll" +hide_title: true +hide_table_of_contents: true +api: eJztXFtzFLmS/iva2geGiC673djY+GXXY8MOEYfBMZhlzwJRVldldWuokmoklU0P4f++kSmpbn2h29h7OTsPBFCty6dUZipv0rfIQFprYRfR6cdv0bkqKy4XZ2kKxpzVdh6dfvx893kUZWBSLSorlIxOoyvNpRH4H8M4u660wvaQXbOKL7QqCjbl6RdmFbNzYNe17LQwllvYY2dN05RLNgX8K4UCMiZyJiwrAaxhU2XnLNXCghb89JP8JOPedMKwa6truMYfzmutQVpmRQn4C3BdCNDMzrlkh1XJLq+Ykg6SnzzJgGeFkDjAJ2lSVcFp86M51bW8jkbR13hWG6tiIS3MNMd1x3ZRQXT6MYJyClkGWfR5FFk+M/jt0vfHb6GvNrd8Fp0i2FGkwVRKGjDR6bdoMh7jX30Kv6tpC/K6iEZRqqQFabEVr6pCpARh/3eDTb9FJp1DyfFfDlSkpr9DaqPhrrUkt3Nu2ZwbNgWQzDa7CVmzcZ09c1vGeG5B+20qCMEe0Qa+8rIq3FqMg51gj5q+1LXIotNoejSG5wcHWXySP8viw3xyGE/H44P48Pnz46P8eHp0fHwcjSIoq0ItAJJUlRVIQ9MgTT+PorBlu42YOo4OvZ5P8+OT8XEa8yM+jg/zwyyeTuA4fpZPp4fTyeTFi3wajSKV50m6SAuITnNeGBhFvLYqqUShbPOpIdDylyTjFqJTWRfFKEp5kdYFt5Al3IaPFV8kFWihMqKb5dr6TtFkPDmIx5N4fIAUkdnw+8FR5Prjxmd1AWFx4zFM00N+GEN6chIfHj47ik/yw6M4PRofTafPn8HR+CC6G0XpHNIvw1EnE5ztqwUtedGuaCAnXRgnV5PJ6Xh8Oh7/JxJaQ7NEbDNxS+i1qbi2EnSibiXSSJhprQ2UxNtIlrs7omEF2grHUMvzN1xurBZyFo2iXOmSZsUVxSj9K1gfPxvLy8oxvzCkB8KwLFeaPjQSolAn6VoyIZnSGWhqEvjT+AYVFxnpFFHCHmOv82YAlC6prJMwHGe66M04YpxVGiqugWn4owZj2a0oClZXuAyn+bADbRajb1xmLWKrmIa8gNRSM6OUxDFahF6vEkTs2VvvdMFu5yKd9xZd1sauXLbBMTpA3OJLsKgBNPDsrSwWQblZYVFughaML/yc8RXu24D9lndzcNIgaJxSSQ+4XSCRK6xwsIHbADtHHPEFMk2A1hHpBtlUqQK4XIL2YQ52DpopTRvdJWSjWk2jxosFawbfY78qpCIyYqtlw6mDG+c4x/NCtsfOsowUNC+KBXGOn0g4JpvVXHNpAbLAl82ov7s9TXltoIexYQUEW3GH629I6gYI8iYOX8tUlaWSe+xcyRvQBhBFbUAbVvIFS+dKGceRtWxNAMiVXj3nNrtzGZawvDkD3vnYMg8qkWjZXAlMxO0Krr/F9Xe2pka65r0mwsgn3a1abMf57RJ6TDY4DzYsY0fNphzqghvLbnghso6N5abEQ7u7Qg1+bdx36DbcRoSapcRntlmgO462Ee33719fBNg7SG74+30tOuzRsw/+u2fv2xm7zu5730uLua59NB375bt67LXM0KJEheo1Wp/1GZdM5XlM44XvWwB7m+fxOfZZRpVo4N545XLxNiffY0gxkHWJUnGWzVUajaKfQUIuLNOAKogjhJ+VrE00is6V1pDSekbRhTClIDENR0U0in4Ruv/hA58h2Tv9rvhXpiFVMhWF4P7jb+1kF8LwqSiEXTAhTa3REGaZQLzTOozRmNIs16pkqiAZZMFSiz7fjZqVkpSvcK7m0KG3o9QeQ0ozIdOizsCddkt7YjaxS7sbv9GIzaZ0DdsH4RUckNGAWzDLWW1VfImNG0CtDfogcMJwO3DuS9+lq1o6xvrQyxoO17dgu6b9NmqB2tNxNXL7bcQNjDpqijkky5t91/UWHn2qFQ7ITgfyQPk2IvJ9HYhewgqdHF8S2FYjdxySezkNeGhTLAER3c7BhQ40GFXrFMhu8HNsErxz16R7Pm5yg1oatky/mogf0PwtlYQFK9UNdV9yY9AUBI1rRdd+4X+j2ZnmXmI4OSf/hmGKf4lWkZbax28RbXzRQesX1NmO923UIByT0d0dtjgcHy5HOX5Vlr1Stcx2CXKsGYJ9kox9klfzxp+CrN2sTIEzleGrMHaPveFfgJk62Kda3QjUq68v9okvhXH2EG7ssrj/UeNpQtEfrZWmOE9f6P33lu+41nwRjSJhoTSrlchg1OQLYAdUbzOlF2vmoFbfFfZ3FaQiF05P+jVTd6bStNZmj10tKpGid8HsXBj2BRZMZCCt64XtuXUHHexXXPMSMBikgWy/EOijIfecietR7wANR8C2qBTcSAw3MwwVNsl45DOt6krImSHn1ju7tfEuUC2KjKXI0qVvP+cSfY8ZerYLVWvWieYR5hKM4bMtVOdlAJKB5QL9pKmqbYeoMZuBBN2S0w8dUJpa5zx1SPGEkhk5U3skKnfDmJpUNslJSDqM9bG3/5Hn+C6/nHY6dhYXrRGQWx+voA570d3nrlj/qmxMQha/xEnjt45rvWRPJsti2SgCPi2AvZRW2AWGWK+IHHzB5ryqQLZqdaqyBe48bU0IiKBO4EL6LTfoTs8ZN+xaSBLPpGHK5IYXNVyPmFeAYYScNiirwdO66YmSRHt/vcfegROJjy/dNOeOhgLM55/m1lbmdH8/U6nZo1DuXqrK/RD2jb2mpd/3CWacNt2fslktMneAlOgMe47Z+yTvr/FWk9bpvr+IG4j7l9b+x9faGG9tJsJUkCSllrh9vB4ROLdXLljoWZ5x5lqya9+U+U1asFth5wxIqLxg/K85HBCF5Rm3W+R6zoNwayjghksy8zmO6Rlk0TdmhWQk00J5teE10rSAPfYKI9/uRBr1hiB8RKpr93eCqK5pb8MXdA2u21itt7TQsFIS+q7/mrWUdWFFVYCbC+VoIHjh87KwhV92EOn+3EbIWZgZu/EmEHvZmWmV39chyPe55ldeQnCGPEUpOtyyDYUqMGuYYe6BuKFD4O/P8F6KP2po1YNufAU3DI3otDdGLjY4c027ukqs2tywp+dWNaDU4qYmHSvkjef++IOw8/ithNgdftHd+lZvPO+4prg1nQDMX3v+f3jPcaS1B/YKT1lhAI28P4x9bzg29thryg9WyhiBJpZVbM5vgDV6qIAbKAzunT9GwkHRqJUoFRoD4/onB7dnNz/tucwrGkQrvIApl18SnqaqljbJoAALSS3zWmaQJRVfoD9uNngIU26g7x4sGWs9N+FVLTMhZ2/AzlVGOaIwG2tmoz3oAbsBLfJFIqSPrCYZVMqIB0X2dzQDcFbmZ+0kzGh+gWmcywK4CdlTMlLQYvVwGC+xo9lbvwReYEBnkYQRH3UBSF4/ocsbNutYARCD20LOEq1qi2KzwSt0LRJZl1PQqyEOjPwe0N9cf+b6o0yEY9fj8pyQpErmYmYaaI2tuRPVlnt3wZxZhltqmZIUw/LGbMhZB8NiNbCw2pwbG6QlKUQp7AaEKxrvTMJXiNiPwWgMZuaqLjLEzD1lG8w+yNzi7cZz16BsmqzEtpqWL7GQABOireSULlfLJXuGQUU7N2gT5rWtNTh8IcMlZFYbqxeJgcIlTxLJRWqSVGWY2QmG2VrEbevd6fkr9mXYdwU7bofQT/P4AANrwh81p4qS5ywTM9GonQ1wTQBgtoBrROra7o72nUgJq1kGe+jBOqwYB08wf1epQqSLRPJyy70u70XEctX+DkHUkiQKskZeeJrqmheJ3iwzvWY7aO4z1w9D5+32TgtU5WhZNXgYARRg1gCvgA7XxAdSNp2Og667oD13wp0BT624ocoOGsP5uB6Dq5ZUeR6iOuswN3U322x703j3vX/Z1PeE0qitOGDKC0zIJq5k5l6n9SZU51xSeJRnrqDGzWY2b/tcFSJDrY5/HOBgVpAh+pBWkS8DaMwIMimYR+ByeYRgPTQMFz8arCb/Qpb0KmAjVnmTjRJmeMyvhdocjw2bPQorvnZtmrIBhm6X6cQwCJ+SU8U1muFNecED0i/IMBr8rJmqrWQgCEuLeUAEV75KiII95JYK2YsCY3B5cKI5syIBifEjNMKs5qlVOlGUIF2LbdhydzFtBnD+XmvfOCyucoK4HHWfw9sKbMD/mHbsYI0rjjlKy+MAVHFNvv42VsByr93pd9nY1U9WjPekFeM2NEFxSl89BjcgrV9FCC1ui7/X/oeQ90b6LubQunVpqIpsppUxGO4Ik0sgZ2CTreNb7G7uAPkIjUUR/IIBJLJacEfmqtbbGIb3O+p+wdE7kiNhxq24GRLIy7i7D/CA+uayvRbiAYSbIR5ArtWfIJNQzvOQmg6jPp0S3p5L3ikRfW2NC6cvVepihowXFvQatIkfZbPf/kPABZYeo3Jry1V9qmUAlUKNWAePtesObC1LlYlckNoOkEM08yHBhoxRtbTZDoCjZI/kTlEa0Ddei5uFsVA2jYIOH9oGpAVMEup9vmsnuPY/ooD6I7VSLRmFJz3Okn8VZV0OcZpau2LsR4T68msKgFaEx4A7cTAeE1ULpb7U1SZaPiKwYHAFH4CKxH4yT/eifu6rzet8HATdG/chGsTKw/wx/jc+mDyjEoeuQpsWKv0Cujn8KegmZK52Yv7BaCuNYeIIbwj34oDNpYt+Kf1w+W7uZZyb19NsjgFbV4+zKJ5lnQsa91rOAObmNeWQYSo1sfzrYy4L7UIywP18zPKvjOa73xqXYW/Bii4m7IpEHnyZPTYMGitEoX+AL3ugVy/S1AZjETuG2LdZlMCiFj949xD87hJaSA6yqae0KiWXtqaJ2W0yzZe63ydU1wzCwiCsmbz1IaJ1gNtT+UfR9tJlA/qF2bw2phA6T+eJnWswc1VkCfjDJ+rk74YIaFnQYN2dVoEu4YIUv+Gi4D6ZhxZ/cQOMYvNn57+wqwCOhZOxkz+iq02Yc1A5+yA0sNdyxN6oG2BXCitPNbvglI7sHph4aWBXMQ19G/clDDLIHVFcjFsLZUVOLF7WdXcGeVvPUSNz0s2N2sYqj+l3P2BwM8VMcqs0hva4KLYL63FR3Cekx0XRdXSHAILfHaJjc26S5teHj6a4bG6T8MDNbWZjVB7kATVsoAFLrF3qPAQP2i7+phvWCSDRmYRbHDQYeuLroMo7iM76hXVb7yB9ndhCyFuttH42yN66IbaoLO2Whg9qSUePvLxsnOV8MpnEPBufxIfAj2M+fs7j44Pj5ycn6bPpwfGLDYsOo5WU7b6P7e8SfK5/c346rXHKLgTmwtmFSz6PGF083YuGVAko/OX5e6Nw/YPqcxY1mvZVH+UTb227FP+TvaDD/qfqjUdRLqQw88RHOfF0xUICZ3o9QkzaE8j5+FahZFvWTj6ICRbKWTEJDf09K8xYDWCTg9138Q0yj7/oxThzA6Fu0WDMEs+krkTpx+agQYYjuyqd3Y9eeitCmBAlvtVKzpj3vodz/Cmqe7C5U8kg0dcOUbw/ReWSrj/B3myPHUyeHR49XSFicyXh3vUQl9g7VEMEIT8Y9xKlWHFQiHRTpGGl8GS1qwCHdanHjugI9zSA6ZT3tsEql8IZOPDbBLJXwtpcR3DVvTvT1mTQ7rt9wdpsZykHGS/Ubae8gWq5NhU3tL79vaMJOGWo5hsyRDdG8DATNIv0J5mzYc33z3zfcPvjkGbxhnbQUihoZsNJh79Tn3t5IFgTDBmjn9gT3+dJe5NAKrxuVgprQysTTpUpNyJ9ZO+cU5lf0N/B2iQjYzcXVgJkpnMOeTdwhf0R6Hbri8PXrI5+3pngdEc56JkZpUX9fT1MYoVCjXFzUC2he8QYPVkS64Pkg5izfzUIHSuqTE8tM3VVKbx+SsZRsRhm+L06CmtwGdAHj0MPih86kN2E2SCbtalcTGhjk/sVvLzCvkwOyl6WtFVG50OeTIW2891nuaC8es6oe+Ma+xOUyiacAUg6Z7s0bVMLeh8j3hvvxxMOh88PjuOM8xfxIWTH8ckRjOODE8iOsjHAybOjDSqNsmH3cEqLgrNXwv45w1BcRhW/9JAMumsMBZZ4eD7IhhlAG5FcxCbV7ImwwtF5YEpNsuNp/nySxlM+zeNDfjCJTyYvJvGzwzFMshcpn05ONlDqflroteGCz9nPoAshGzIhXYoFkejW317ZjkLBpg6vezUq9Ds1W+trtTaWsHprtMvp3aLLlUga51JurA/tNbu3t4a9Bx4jwxTsiH0A+IKhJmnndPXu78BXoQ5Bk97bRQ/oKoWJNml71TlQ+1dHe7cV4zXF7tihAfAaOb2qbcwrEd8cxE2RRtwUTDY3A034B37zxxzdr3eWqCMAqeTT6D9iuuIen12+jv+9Ca0JvCAwB56RhbH0lN7SayST8eQoHj/HR9joRn7O68K/eBa+3y09JIBYSiH9dTl6cQB3ImNnl69DVI5xY1QqKDVLFj5dd8MGeMOP7rpJZA/RFiCNXJvO5dEnhn0shaSkXmfsHW9aEuFdTyFn/+wHjDufnyIMvLbnXCxP4XZ/AmErTufUVo/f9G51uds167bjrjNpywA7Tdp9DWTbSek5R1MB/wLcLGIEEKsb0FpktPzAf/jkiDT+5cJgU659RJKu1tSDxyRxgf1+7gHJprF7haNttA5W0yHAw1X4OBeJGckLPvQZ7d8c7DfCtv+t3c27/SBu+99act/tNwumrLyXtloXKFGe33glHLvFGZTEc8vPbECpoj5l3XixC+3hz7jSNQOvHPNSUxhv3ZgV/oyECI+fvsM9d2WEK55AbTgBJw9agt6lAa5JbwwvX7onmeieEL6HM0fnMCTBRtE7qlz4kRncCGsmIL/fpa2DFibNhxoB+SHkJro6axShijJv83egb0QKHUq32oKusu5Tw/0Mp0adHdP/McdgfNel61dQpKqk1AvheGLYS8/oLFT7oLLKVFrjkUjL+Cd/QZ67UIoX9oswK/sNCh78ZZeWQFbxv/5ryxn0pKQytuSyM845cW77kN4Q87f2cv7/t8duPSNa+Gr3q4IL4liSvW9eUXyMbg6al1XdddzTnuoPQ+IPPfXsFcZnLOo1Fkf69g0Pwve6uLvDz3/UgFYJPvd6wzXVIZFSyQTZD+1Lq2t366ffvDp/ytafMyvXGK4QUougNCN/n7F7tqEyehBALfPdA1CHsK5M2tkwu1HrH9oyWUNWR77V1mBD5fZoRTVd2c5vS2919E7Uy/dXET2q1tXqjRb3/+jcee/v7rdvrsWV+gLy7q7ZbIv/J8v67r8ATOvhgw== +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"; + + + + + + + + + + +Transitions a `processed` payroll back to the `unprocessed` state. A payroll can be canceled if it meets both criteria: + +- `processed` is `true` +- Current time is earlier than 4pm PT on the `payroll_deadline` + +scope: `payrolls:run` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/put-departments.ParamsDetails.json b/docs/api/put-departments.ParamsDetails.json new file mode 100644 index 000000000..c2fb5baa0 --- /dev/null +++ b/docs/api/put-departments.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/put-departments.RequestSchema.json b/docs/api/put-departments.RequestSchema.json new file mode 100644 index 000000000..a6e6b5952 --- /dev/null +++ b/docs/api/put-departments.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"required":true,"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."},"title":{"type":"string"}},"required":["version"]},"examples":{"Example":{"value":{"version":"db0edd04aaac4506f7edab03ac855d56","title":"Backup Dancer"}}}}}}} \ No newline at end of file diff --git a/docs/api/put-departments.StatusCodes.json b/docs/api/put-departments.StatusCodes.json new file mode 100644 index 000000000..cff0c6db6 --- /dev/null +++ b/docs/api/put-departments.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"},"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/put-departments.api.mdx b/docs/api/put-departments.api.mdx new file mode 100644 index 000000000..2f52bbf49 --- /dev/null +++ b/docs/api/put-departments.api.mdx @@ -0,0 +1,71 @@ +--- +id: put-departments +title: "Update a department" +description: "Update a department" +sidebar_label: "Update a department" +hide_title: true +hide_table_of_contents: true +api: eJztXNtz2zaz/1dweB6SzIi2JMsX+emkcXLqh7SZXE7ON06GBomlhIYEWAC0rXr8v3+zuJAUdbHl2A/9pp3ptBaBxQ+Lxd6wwG10E89qbWTMhYGZooZLEZtFBdHpRQRlCowBiwYRrapuEx19H0SyAvfXOYtOo6o2MYOKKlOCMDoaRIbONJI56/z6fRAx0JniFXaMTqMvFaMGCCVt32/im9CZrOCUXHYonl4rbuAyGkQVVbQEAwrJ30aClhCdRm3TpK45guY4QEXNPBpECv6suQIWnRpVwyDS2RxKGp3eRm62kTaKi1l01wf4eQ7ky5fzMyJzYubQwRndDZrB/z/+X8vG1x/O4/8DpbGvBzAHykAtQchpoaE/0BnOqOQCtBuHGohTqoGR1x/OyZUjSqjWMuPUACPX3MzJQtbKNshoUeyR85wIKYBwTSolrzgDNnBtaFUVPLPr9UKTi5ILXtZll/b3l3NjKn26v89kpvesXOxlstwPchBXdKFkUdjv+7Tise/Jxey/PcG48/MrhFFrYHvRZoYPIhB1iXIyHo4P4+FRPDp0YpLTujDRaff3u7vvjo+gzS+SLZBcf2UzKQyuzult1Jnz/h8auXy7ikOmf0BmUKwUSrThoPGrn8M6wKsCktVKgTDNKnlZcaT3yCcA+/dFyy8yqzmDHVneYbcjHRd0AeoVyaUiXORSlXayRAoyl9fESGQ/MXOuSc6hYHso34abAtZI/l1XRC8aBny/G0RwQ8uqcIx56/7f8ogWNSwxK2LpEBgbTiil2eRweJQfA6Pp8IBmJ4eH7PAoasaPfqHZj7oiZ1RkoKI7+w9C0JUU2o01Hg7xP/2NEnYg+d1ygQRIP7H4tCh+z606+fuJBWdQVtKAyBY7iUIrC5HXWTQtwKq17Uyw+vVBHNioOaNMlhUVi+RxtHzvLeLcp/AbLWE9EiirQi7ATc0ToUrRxQqN1/grEmm6oD7mMwEMGbxMGpUeN1Basg/hn5N/lGBFMyPVDng6nZ4akVW5QUzOlhl3j1ZwRKPDo/HRMD1gcXZwfBhPRodZnB4f0/j4kE2n+fHoeDQ9iPoCER0PT47p+OQkPjmYTOPJ0cE4TqdjiNNsOsnT42k+nkJHmXwydAbkVyrQ8HfU0XQ4mQwZmxxNjoYjNspO8glMYTwZsjw9pqiOOst/0WCejEbTKcKl0+k0nkxGk3iaT4Yxm6b54fQoHR1MWIScWVqutv/B5OTkcDLN46MhTOLJdJLH9GBC4yk7oZQdUJrmh9Hd96D0JsPJqp77TRryTtaCkW+CkG8C94C3fcCIAi1rlQFhEjQR0hC44drskff0BxBdK6dbghfgdg/X5IoWnO19E7iAk/F4ddgvolIyA61RGZC3wnCzaBBwTUq6IHNaVSDI9RyEHSWVzMqh9TQ8RiuUlAtNQCkUTF1nc0I1ueTCgkioMYqntYHEiszlgEhlyQUKOeWFJqwGlGUq2p6N63nZ0aJv3TBvqIGZVBz0jmrUwoyzpvsrp4ytRi2lwp1kEBAybwdLcz93/2Fun7l989P1S9yE0UVcVmH+91Wd2ai8e6kmPwA7eJSLDWPYVvfam08VZDznoHEh/Wa03YnMslrpPfJ5UXH02hfOKv+ABeEMhHG9sH2zhvtNyEMUFNb799rdkrRuXYN6B2hIAdtam2YpEeu3eFJBe3gpIzMl64qLmSZUMJJRQVKwDj6iSWteMJKhHJS+/ZwKVqBXw4WT3k4IaWOVZiCuyaWwii1x63g56LhK5JoXRRB5QolrSS59U+IXaeFCInAqy320rClxv80e4CR8CPP10khoKmvTWbuYzECAalfNkw7M0LXKaeYYQgUBwZA/yqMwlFGz1v1chvEmbG4FBVxRYTAapEjTC8jC72RvArggdk+jv2fVhtdIaQF75J1UxFvqwRIJi8+y6tL9N0FUl3Ztwy9ozi4d+9PWmKAjIQVscJiX51LWheFVAW4s3Ee9jRd+Xt1s4csOW3p5bM3FLIyM3ShjHD/R4kNnJBc2rhnbMWQ319Jz1MxpV2wyqVxcwzQx0kpDh8H3j/BF8D9raNWDsnqzHc9SdNo7V7JsCV60FEVdFDaYc+3qKjFye8MlPbeugTbUwLYmnQjjvZf++Cs38/h3AbEzftHd5lbvvey4prg062KTf9b877fmNqmwyWAv8+ErKh8pioVzcAnfajb2yLmx2S+pNUcXy0gyp1dAGj1UwBUUGtfOm5FgKBq1EmVcZXVB1UsHN7bOT+ySDa+W4uY1DZxA38Td6Cil4kdCs0zWwiQMCjCQ1CKvBQOWVHThkqMdJ+ZiydeIMA/YdUxOoxVnLeqYuehdLRgXs/dg5pKROdUkjEaa0ewaLAG7AsXzRcKFFd0MkVZS8ydF9i90A3BU4kdFy4nRSwrEjs+B7ZEPBVANJJtD9sM5KeixejiEltgRTfumKdBCAWWLJFB81gkge/2AJAUQ7TzWACy5Rg2VKFkb3DabgfkWiajL1OaP10DsOflLQD+6/sT1xz0RzK7H5SUhyaTI+Uw30BpfcyeurfbugnltCC6pIZicbp3Zstam61isBxZmm1Ntwm5JCl5yswXhmsY7s/AdIvY0iKVB9FzWBUPM1HO2wZxUoLhkLV4QLGFeW25A2TRZi209L98KZk8HOjvHRlBmTgU5IKUUZq7RJ8xrUytw+EJ2hQtWa6MWiYYCMpTuRFCe6SSTDJLWMduIuG29Oz9/w74E+64Rx4ch9MM8P8AgmvBnTQu0IkeE8Rlv1M4WuDoA0A+Aq3nm2u6O9hPPLFa9CnbiwTqshpeQyDxPKlnwbJHgodXD1rp8FBPLdevbB1ELu6OANfuFZpmqaZGo7XtmqdkOmvu160ewX8OxtEBVjp5Vg4dYgBz0BuAVWOOa+ETKNuvY67oL2jduczOgmeFXCNnRcDGux0BwACLzPGR1NmFukpwPWfY2I7rz2r9tE+MKHi4BKS3wFCipq3v05WZrvQ3VGypshpSyP+yyu9H09mWfy4Iz1Or4rwMc3ArriD6lV/TGKZPGjbAuBfEI0AL5xd8MTUjzfLCaFLP1pNcBG5DKu2wKUFalgI1QG/PYPXd5elE8d22asxqCYZfu5DAsPilSSRW64aHdU/Iv7GF0+EkzVAPJQViZzBMi+Gxzj1zbZI8NS7lYygJjcrln0ZxbkYA9DUzaA44Eg7At2Potd9+mDQEX77X+jcPC7Ia1Uo66z+FtN2zA/5x+bG+Oa8ycNlRZv53mBpSN9R/iBaz22p1/Hxq/+sUaei/abdymJmyekviNcmXPCO0sQmrxofiX2v8U8iVK92IOrduQBo8ckpmSWmO6IwwuwAYD23wd32J3dwdsjNB4FCEu6EGyXguuyFzW6iGO4eNM3a9IvbNzBMyo4Vd9Bvk9nqEdLJ5Q33xw9DsA3BDN9siV/AtE4nE8qabDrI8ffiUk94dumFs4N9ql01uMzu1geEJGCwNqA9rEU9ket/8UcK5JCqjcGsDhqKUH1aYaubYOoAdbi1IynnOrtgPkkM18SrDhxKhaWWwHwHFyieVOUWpQV16L64U2UDaNgg7v+wZWC+jElbM8wE9w7X9GAS1Tane1IDY96XGW9Aar3fo4da0qinN+RqhvbzIA9CI8BlyJ0XBouVpI+aOutvHyGYEFhyvEALbk4KV+tRctn3215zoXvaR7Ez5EvVx5GD/GP+PR+MDWTnQVWlrI7AeoxvjbpBvWQe0k/D1qa51hKxHeEV7KA3JBpGKg0D6pWoTt0Z++G3sV5/b5NIujwdTV80yKMtapbHrUdHowt88pB4ZHqYmhN885LfQLrQPuxyOG3hA73uPmuAr7AaLocsKuSOTJp7kkhkFjhSz0T8jlEuj1k9S1xlzEjin2h0yKY1GLJ941gvdOoYXkIOs6tbOSYmVpmpzdNtd8pftjUnUNERKIkGbwNoaINgFurfLPol06LuvxL4zmtbFNodNsnpi5Aj2XBUvAG5+oc37XR2CnBQ3W3XkV+IIiYNM2V5QX1B/mocdfXAGxufnXb34lnwM4Eixj5/xISm2TEWgkv3IF5FwMyHt5BeSzxOI6Rc6oPY7sGsxOje/OblMTvlw1twCWzo5sXowaA2Vlg1isyw1XIJp6jhqFE10OWZtY5rH97gmGMJPPBDVSYWqP8uJhaT3Ki8ek9CgvuoFuH0CIu0N2bE510nx9+myKO81tDjxwcZvRiC0P8oAaMVBQ4orbo/OQPGi7pJAjMawTQKYTAddINDh6/AZYwrhOa6XBHia159YbJtZtvcPu6+QWwrnVWu9ny97bRGIZgzRJjnWlS9w964C2u842cVx45umxIcvpeDyOKRuexBOgxzEdHtH4eHR8dHKSHaSj4+mWSQdqpT3tfozv7w74XP/GfjqtcUrOOJ6FkzN3+Dwgb/BQei/qcyWgwPqI+lERiEPh+gfV5zxqdO2rZZQvvLftjvhf7AUd1i7utmSNzf09RCo21BxfU92XkSjngut54rOcaF2xkMC5Xs+Qk/YMcjG+kbizDWkH7+UEC+m8mMSSvs8L00YBmGS0+yq+R+HhIitqhhrdEULdokDrFZnJXInSz41hifQpuyqd3U0vdkPW+izxtZJiRnz03R/jL149QsydSgaBsXbI4v3FK3fo+hL2ZntkND6YHL5as8XmUsCj6yE+YO9QDRE2+Wi4dFCKFQcFz7ZlGtZuHla7CnDYdPTY2Tp4fGfmoDvlvW2yyh3h9AL4hySy18LaXkfwuXs9oK3JsKvv1gVrs52nHPZ4Ia875Q22lmtbcUMb2z86m4BDhmq+vkB0cwRPM0AzSW/JnA+r77f5vuHDzaEdxTvaQUvhRtNbLB1+t30eFYFgTTAwYj+RF77Pi/YmgZCkwhuoxoRWOliVlGqePXN0Tm2ZX9Dfwdu0TsZuIawAYLpjh3wYuMb/CHy79sXhG2ZnP+/M8K9YFh70zMweiyrvsqq2UGPYGKoVdM+Yo7eexOYkeS/n7BBgDp/YyvTMEF1XlVSGMOscFYv+Cb9XR2EO7gT0yfPQveKHDmQ3IOudZm0rF+NKm+RxBS/vsC8RvbKXFW3FrH3Ik5QreyV9x1HO7Ll6Tmz3JjT2FtSWTTgH0Oqchx3TNrWgj3Hiwz29MYXJ0eg4ZpRO4wmw4/jkEIbx6ATYIRsCnBwcblFp9jTsEUFpUVDyjpu/ZpiKY7bil6Iyx3CN4Ia1MjzvnYZpQB/RhojNUbNnwppA54k5NWbHaX40zuKUpnk8oaNxfDKejuODyRDGbJrRdHyyhVOP00LnmnI6J7+AKrho2IR8KRaWRdf+9srDOBR8ahDa+dNN3mN73c7mWq2tJazeG+1Kerfoci2SJrgUW+tDl5o9OlrD3r2IkeAR7IB8BfiBqSZh5vbq3b+ArkMdkiaN7n3iUCkMtE3by45BvVsq4F+6rRivLXZfvgb8S3AUmkvAf1uP4W4QfezYjfsm9B9iQO4G0W+NBblvzv+Ykn9MyU+YknD7/SbWFdAfQPUixk0QyytQijMc1FeEopYxILSNsXA6biIbXy8aBNm95xUjXKdAahOIhlYAg/f+fbLRvntknyQy8+g02r8a7XeeLNq/7T1KdIcP4WARRHgtQBUouP4iNa24u0cdMyjtZeqVy1BnUMpomWOOXuwyqfgZ57SB8FqaH5TNmm6iWeFnnLKGrFY24r+4DRr5dYbW4XWNs7/43m31CS/AO6Owpm1z5wshhteB8O8UqLLKv38j1pKI7eUtQmszx4g9nEwOok+2nORnRnAUNgxwN4jwYv/H9uWh7nsXzWsTzVW4YD/bR6VCKUL4Yp+LwteXlp6r6Dx1NIjwOSj9e/4J1BXPoLOc7V17ez153zbcZ4gcHYHY/o3nRtp3XblSB0UmS3ucZnG80OSt3yUkVHDhw1BMZjXKruXCf/lHD6hLj/mHr87CqOQjXkz3ORB31ITy6L/+Tyt+yMxKalNS0aGz5h2wPuzb9s2FRz0b5uXBwI3ZrwrKreDYjXLr9+9FdDWyo3afMTvtPyz2HauatcHmt7fox3xRxd0d/vxnDahNL76jylC2EMtuFsatA7Xh5a/uvF5+9Mb/FdnyfM6GuYRrlGLR0VmRv9O58j6aK892j5PtBvI//KWytbx1PFz/zFvD6taavHHMij8vGaPVl0LaHqi7KrO1bdfsfPjyORpEqX8DrZTWWCp6jbfr6bVb95CTxEfS8LfbqKBiVjtr7kjiP/8GWC3Djg== +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"; + + + + + + + + + + +Update a department + +scope: `departments:write` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/put-remove-people-from-department.ParamsDetails.json b/docs/api/put-remove-people-from-department.ParamsDetails.json new file mode 100644 index 000000000..c2fb5baa0 --- /dev/null +++ b/docs/api/put-remove-people-from-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/put-remove-people-from-department.RequestSchema.json b/docs/api/put-remove-people-from-department.RequestSchema.json new file mode 100644 index 000000000..a475bd094 --- /dev/null +++ b/docs/api/put-remove-people-from-department.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"required":true,"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."},"employees":{"type":"array","description":"Array of employees to remove from a department","items":{"properties":{"uuid":{"type":"string"}}}},"contractors":{"type":"array","description":"Array of contractors to remove from a department","items":{"properties":{"uuid":{"type":"string"}}}}}}}}}} \ No newline at end of file diff --git a/docs/api/put-remove-people-from-department.StatusCodes.json b/docs/api/put-remove-people-from-department.StatusCodes.json new file mode 100644 index 000000000..96736bb54 --- /dev/null +++ b/docs/api/put-remove-people-from-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/put-remove-people-from-department.api.mdx b/docs/api/put-remove-people-from-department.api.mdx new file mode 100644 index 000000000..07dd67afb --- /dev/null +++ b/docs/api/put-remove-people-from-department.api.mdx @@ -0,0 +1,72 @@ +--- +id: put-remove-people-from-department +title: "Remove people from a department" +description: "Remove employees and contractors from a department" +sidebar_label: "Remove people from a department" +hide_title: true +hide_table_of_contents: true +api: eJzdWFtv2zYU/isc99AWEH2VL/LTsqbb8rA2SJptQBK0tHhks5VIlaScGIb/+3Ao2ZJv7bJ2GLa8JJLIj+f2fTwnK/rIZoV1mknlYGa4k1oxt8yBTm4pZFMQAgQNKM/z5hJL7wOqcyifLgSd0LxwzECmF8By0HkKLDE6YwJyblwGytGAOj6zCHy+femBBNjYyByh6IReeRACWZ7qJYAlXAkSa+UMj502liAu4aRGvlN3ysY6hwl5X7+1kwcjHby/UzSgOTc8AwcGz19RxTOgE1ovflcUEv2UaEHO3ZwG1MCnQhoQdOJMAQG18RwyTicrWgaIWmekmtH1vgdv50Bubi7OiU6Im0PDUroOtof/wX72kT+7vGC/gbG4tzJgDlyA2TEh4amF/YPO0aNMKrDlOdwBm3ILgpxdXpBFCUq4tTqW3IEgD9LNyVIXxi+IeZq2yEVClFZApCW50QspQATlGp7nqYx9ip9ZcptJJbMia2LfP587l9tJuy10bFu+lFqxztqb0mE5Xxqdpv57m+eSVTulmn1fAbLG6xdoRmFBtOjpgAcUVJFhIfU6vQHrDFl3UNZRwovU0Unz/Xp9X8YRrPtRiyXC7WcWqwuzM1nRhs/tDxajvDq0Q08/QIwFnRskgZNg8WvlwzGDDwskLowB5bZZqmqlhG6RawD/fFvHi8wKKeCJIW+Eu4RmKV+CeUESbYhUiTaZd5ZoReb6gTiN4SduLi1JJKSihfW9JWPDN24MXx64doZv0Zmav06TUhgOmYsF7yDzsLux9Hw8pNp6vS7TVYnBX7enqSDf2KJ1aZYBm2tly9W9Tgd/7fN1cwx545NBXj3yLE+BfkUN8jR9k3hV++9VpxSQ5dqBipdPqsh1QJ10KTpRSSefpuDV9fNBOJ7EJwk4jXWWc7V89/ewqt20duFLCK95Bsct+SpacmvlTIHAAO9Ct/4lWn5ji7zyb8rkfDdwJe08wIaCSBGeFlCD0sGwN+xM+4LF/dGAhd1BzKajEWejgYiiZNQddaM+3S8IOuqMR7w3HrNxP4xYOOz32DTqAZvGUZhMR1HSi5DwG8uuHZ8B+YUr7D+2JKUi6oRhR4hwGA47XdGNx0kIEfTCjkimIz6kO+m/3docdrtRhObyKIpYGHZDFiVhh4lomgyi4bTbDwXFyOykq97fD8fjQRglbNiBkIVRmDDeDzmLxJhz0ed8mgzo+n4jemEnPNS519qRn3ShBLlThNwp5EB1BYMgBqwuTAxEaLBEaUfgUVrXIr/yj0BsYUpt2TQjJXukJQueStG6U57+j8zmwD8Ct0uGDRXTCzBGCoxoqe2XvgvFMD06UNZ3rejnR1jSyem+N9hUwRf6X9SaDdQpU7ZYuyZh9DNwc131zb4/dXM6oe1Ft93oYNurvQ513S6BsDkCs9i0s4VJsWuslJfnshReJiDz6ntAv3PINN0NYonHfA3gPi+mJ4CPYl4aLT6DmeNn9NxCXBjplt7ylyV1zuIYrD0rMAi3981V13jvlUQ9snZLezRx0zHi8xS48R30ro0VBEthASnhhZuDctVVi7pwvbQOsq85oUQ4ccA6oHifX9XdaFN8ttSv29xjBN8o3GkKb1escZ5ItPeiUhs/c2ALvyM2jX45oDhT2DfJNZiFjKGR//o251NduLZf2BboKioy889MJz7vuHU/OL9DGusMUN+9Hc8seVVxjFyWfYGfLoSOC6x5H7bvquaIx745qqan882p5ArSipMYMC5TX8DV1x/qesXo59q6jKsGTjVtliPr0XZwx4VV3af9M4NqVW0OHl07T7n0ZelpuKpE4pYuut6seoYO6ORwlK2U4j6gc20d7lutcDi8Mel6ja8/FWCQhfcoU0b6DgqrSEiLf58YOpsReH5VDVIvyGdaphNObfoDtWzoJA0qUd33xxdzNRc/zcj/+ZB8NLZlDI//h2Eb6voGe1kGi73duQAP55B6B0pk7j67tnnJXd68pQGdVuN3pstrmj9gmfKHMu86L1mM8zm+W9GUq1nBZ7i2hMSfPwG1A4Wr +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"; + + + + + + + + + + +Remove employees and contractors from a department + +scope: `departments:write` + + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/put-v-1-companies-company-id-bank-accounts-verify.ParamsDetails.json b/docs/api/put-v-1-companies-company-id-bank-accounts-verify.ParamsDetails.json new file mode 100644 index 000000000..923f796bf --- /dev/null +++ b/docs/api/put-v-1-companies-company-id-bank-accounts-verify.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_uuid","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/put-v-1-companies-company-id-bank-accounts-verify.RequestSchema.json b/docs/api/put-v-1-companies-company-id-bank-accounts-verify.RequestSchema.json new file mode 100644 index 000000000..9e03a7547 --- /dev/null +++ b/docs/api/put-v-1-companies-company-id-bank-accounts-verify.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"required":true,"content":{"application/json":{"schema":{"type":"object","description":"Request body for verifying a company bank account with the two micro-deposit amounts.","required":["deposit_1","deposit_2"],"properties":{"deposit_1":{"type":"number","format":"float","description":"The first micro-deposit amount (order does not matter)."},"deposit_2":{"type":"number","format":"float","description":"The second micro-deposit amount (order does not matter)."}},"title":"Company-Bank-Account-Verify-Request"}}}}} \ No newline at end of file diff --git a/docs/api/put-v-1-companies-company-id-bank-accounts-verify.StatusCodes.json b/docs/api/put-v-1-companies-company-id-bank-accounts-verify.StatusCodes.json new file mode 100644 index 000000000..51d5b0372 --- /dev/null +++ b/docs/api/put-v-1-companies-company-id-bank-accounts-verify.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"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\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/put-v-1-companies-company-id-bank-accounts-verify.api.mdx b/docs/api/put-v-1-companies-company-id-bank-accounts-verify.api.mdx new file mode 100644 index 000000000..e64bfc898 --- /dev/null +++ b/docs/api/put-v-1-companies-company-id-bank-accounts-verify.api.mdx @@ -0,0 +1,84 @@ +--- +id: put-v-1-companies-company-id-bank-accounts-verify +title: "Verify a company bank account" +description: "Verify a company bank account by confirming the two micro-deposits sent to the bank account." +sidebar_label: "Verify a company bank account" +hide_title: true +hide_table_of_contents: true +api: eJztXFtz3LaS/itY5kF21VCXsSzLelrHlz16cKyKleOkbBWFIXtmcEwCDABKnqj037e6ceFlLtbIUu3u2TykHA2BxodGo29o4CYxkDda2EVy8vkmea2qmsvFqzwHY141dp6cfL64vRglBZhci9oKJZOT5J+gxXTBOMtdezbh8ivjea4aadlkwXIlp0JXQs6YnQOz14pVItcqLaBWRljDDEjLrKLP3d67X+QX+YuywOycW/qsdAGaqWkk1RKpIRdTAQUTkmn4swFjWc01r8CCNqxQYJhUllXcWtC7X+T5HDTsGMZZxb+JqqmQ7nN2hRMSOcf5MWxb1daMGJ9a0Ox6LvI5uwZ2LcqS8caqiluR87JcMCGFFdwC40zCNTNgkeBgrlwWhE5oWJov8mACHgAU7FrYOTVCcn06xJqffvqJ/dzt34MuJCugUl/kqSQi+AcDeSW0khVIO2KNcRguzz58PGd7Vwd7bg0FmL0bv5yZKG73EGTmBzF7N90/s6bBFgZkkVkwNgsILxnIolbCTcuIqim5deMNWGI1l2YK2vPGNlrG5eUVjYmTwZ80mFpJA7vsD9WwnEuGrGd2Lkw7HDesQkG0ogKDfy1Uw66FmSMQDVYLuHJArnjZgOmK0xouf4LJXKmv5otM2aXnzG6XDbth0S5P2DuhwbDrOTjMK/eFMMw0tLOmDcpO6B5H/BWQXQWbNaIAGvfzey75bDU9c/GkUPlJRS1S3yLFFmlo8ZRokLi88iDeXkHs2m2bAn14ilhMrmo4iZPOeqJwcq2FhctklHxLZ42xKhXSwkyTAKZ2UUNy8jmBagJFAUVyMUpUDe7raZGcJHVj06uDNEpd2gpdH3xK/Fkko8TymUGi3YkYpBwQaHPNZ8mJ1Q2MkiAvJjm5Scb7+/hPX319jKuQjJJcSQvSYite16XfSXv/Mtj0JjH5HCq+TON8zSojXOJBoib/gtwSn+Abr+rSIfIikBnLbUO/4G5KTpKD8dEz4PA8PTw8OEgPj4uX6aQ4KtKDYyhePts/HsPRc8Lr2OV7wTg/zPdzSMcvj4/Sw+PJy/T4KJ+mkI9fTI+geMmfHSWjJOxcj+31HPKvQs6SUaJVY4WcZbKpJqCTk+T4+cH+i/3DZy+TUTIXRQEy7vvY5vfff//9cP/4RTJKuvonTioJsj1s4McniQo7Lhklklf489uqLtUCNHvXyAKNh1/s5PYW2RjkwFsptiQPtUZZswI6fL0J62GsdjPuL+Rvv52+Cdqgt5C3Q15vQ8n3RCJ91n+PSE+3U9NRArKpaN7tqn3kV0LOTHJxu7yC3xvifDDTHcM8CeZJ3K5d+e/Rfs/NVyj6eq8lulJWlkmG+fJrLmhmHUnRwItFNlU66xKLYuY0zvJ8e1bSjbxq0UkV7yyNu8Mq4NIsG29h2L8aY1mugTQ3WrNKSVjglwmQ/+MtnSZFv7Maf3eAofOgnTSVEAaww/nUWqFKIds4gZmQ6II1JnhfTo9GW4koArM2TSyap6WVWyfJYd2Gu7suuSjCvxl8s6AlL++wUDjA+mXqDbNpJrmSEnJk3wTZYAHxRplHlvrG7RZwTpvjnOOjVs1svuwr7NCk7jZ6IHKGXYitjiPtTuBy8WFKnvg63kZquPWEaf+8uB3FXrIpy2TZbUf+0tgB03c2A/sgywUjqxicm+XlEaYzn5Ibm+U8n0ORTXjJZd4RlM/tbAjgSnxIgU3B5nPmCbCp0iuwnZXADaDvzK+5juGCMN5/bJ1/DdMSchdLVMpY1tSpVWmBrmkYA1dbLc12aactz9gTyAgyFBlS3XLKcZ40a4LFjVG5IJUSA4IVvL3HCjlL+z01/guvaOP1DSLaGhfGFDg1sooXo8QKW5JT4V1QNGFpa7mx2+H+4bIL9Yuy7J1qZIG7+Zw8fYrgACMCoxqdQ7uI8E0Yu8ve86/ATOMDqVqrK1FAwcj0os7ipUA1e3+/LoJiXyRjP4rr9M1eH9oK97DLUtBa6RWujP+9XTeuNUfXWFiour+vp5p9BeyQcwszpRdrxqBW3xWPjz7uJpHzc6buTOV5o80uO1/UPkKmLfkVLWIB0rpe2J5bq8WksbAXA3amfQDk8wJEkqQ2ot4CGoV33oA4Soycdk8qLJLxyGdaNTX6VKQLnCnFaJnQTBpRFizHYKPy7edcFiWaBiEx2NSsEwYR5gqM4bM7bLazAKQAy0VpGJ+oxnaYmrIZSNAtOz3pgNI0espzh5RLNPQIHDnndl8/AJHKZlOU8K5gfe6tf+IlvisvJ52OncklazbINXf7gzrsJrcXCCRoil+UTWmTpW9x0PSDk1qvK8bj5W35m/RODp+UwN5KK+zCqQ1kB1+wOa9rkK3anqhigStPSxNSQ6gTuJB+ySkcn2Oy4FJI2p5ZFMqM0gSXI+ZtT6AwpQUqGvC8jj1jkHu5yz6C2xKf37phXjseCjAXT+bW1uZkb69Qudml6HU3V9VeiJfTmi+0Kkv6vkcw0zx2f+pSA2QRK6UhSMwPabzVrHW672/mBub+rbX//bU2O522AwnDLiUptcyt4+XIZaNprVwu2Is8JX9J/V36pswv0sK5b0Cbym+M/zXGAVFYXnDLV4liH8brsLk1lHDF0b3mliNNLyCLkKt16l9IRnsanVBSG14jTUrYZe+UZt4ijXokCB+x6tL9S6HmJa1t+AW9zkvH/knraaFjpST0g6c1c6ma0oq6BDcW7qPBxgs/L2+28GWLLd0fG4PyMDJ240Uh8BMvzzojuUTmirEXd8wiBf+dxMRxNB6nOLHJlXaJ0sIwq0gaOgy+Q7JLij8baNWDjmGaI+OyBqS9p1pVG0Ki2K6pM6s2N+zpuVUNMJrdFH91vZD3XvrTT8LO0w8SUmf8ktv1rd572XFNcWk6Yfffa/5/eM2R0lqD3efDJ1Q+lC2g6I+JjWZjl51SHqhWxgh0saxic34FLOqhEq6gpBSMNyPBUES1kuRC503J9RMHt+c3P026M1zRIFkRBfTO8wrA7GLWyGkjCyiymi/wtNBsiBAm3EA/PFhy1nphgs/ovwc7VwWbc8PCaCyORmvQA+YScJmQJLp5e9L4gMj+QDegl7TLucTQpXMsG9NNOabgnZOCHquHE44sd9dPgZcu8xvT1I85AWSvH5BNICaFoFgFsBIGNVTm86GbosL+QcNKiAMnvwf0194pA+6JYHY9Li8JGZUPzEyEFn3Nrbi23LsL5pVluKSWKQltzQCrMJ3fcSxWAwuznWJOLnwsRSXsBoQrGm/NwnecKhyIBiMazMxVUxaUCI1HLR5zVoMWqmjx4ol9yFCuQRmbrMS2mpdvZeHylu3OoQjKzrlkz/BExM7pPH/a2EaDwxfPfWXRGKsXmYHS5aQzyUVuslwVkLWO2VrEbevt+fkL9mXYd4U43g2hH+bxAQbRhD8bXqIVOWKFmImodjbANQGAuQNcI3LXdnu0H0VOWM0y2EMP1mHFOo1MTadZrUqRLzJMS99trat7MbFatb5DEI2kHQVF3C88z3XDy0xv3jO9Zlto7leuH8N+kWOTElU5elYRDyOAAswa4DWQcc18ImWTdRx03Qbta7e5C+C5FVcI2dFwMa7HQBU4TE2nIauzDjO4s34wd1n22Hj7tX8butJJ6p0lIJzrNPV39OV6a70J1WsuKT3KCzo/9qOZzcs+V6UoUKvjfw5wcCvIEX1IryjUWAQ3glwK5hGgBfKLvx4aposfDVY8fyFPehWwEau9y0Zn82jm10KN5jGK2aOI4qlrwwIJhmGX6eQwCJ+SE8U1uuGh3UPyL+xhdPhZHCpCchCWJvOACKgCE5UxJnsoLI11fi4LjMnlgUVzbkUGEvNH6IRZzXOrdIZB2AZsw5bbb9NIwMV7rX/jsBS0YUnKUffForYB/sf0YwdzXGHmjOWa/HYqZ6VY/y5ewHKv7fl3Fv3qnRX0dtpt3KYmKE/J/EbBmkQ/i5BavCv+XvsfQt6j9F3MoXUb0uCRQzbTyhhMd4TBJVAwsMnX8S22d3eAYoToUYS4YACJvBZckblq9F0cw/uZun8g9c7OkTDjVlwNGeT3eI52sHxAfXPm6HcAuCHi9phq9RfIzON4UE2HWR8//FJI7g/dMLdwao1Lp7cYndtR4AkZLy3oNWgzT2Vz3P5DwGMhWwQcjloGUEP5DfpUHmwjK1WIqSC1HSCHbOZDgg0nRvXSYjsAjpM9ljtFaUBfeS1uFsZCFRsFHT70DUgLGKzgq/imaL/f/kcUUJ9Su6slo/Skx+nvMwxxmkbXHOf8iFDffssB0Ivo3Kk42N8nrpZKfW3qTbx8RGDB4QoxANUJPTFPd5P+2Vd7rvN5kHSP4UMyyJWH8VP8Mz0YP6MSh65Cm5Qq/wo6Gn9Kugk5VVsJ/4DaSmeYJMI7wv3qQ+kvz+AliEaG7TGcvht7Gefm+cTFMWCb+nEmxYvWNTX3m84A5uY5TaHAo9TM8m+POa1Qz8v8eMzyb4zGu98cl2HfQRR79dMPPc2eGAaNFS853V8ue6BXT9I0BnMRW6bY7zIpusDjiXeN4Hen0EJykE0zoVkpubQ0MWe3yTVf6n6fVF0kwgIRFgdvY4hkHeDWKv8o2t5x2YB/YTSvjSmFzvN5ZucazFyVWE7ujE/SOb8bIqBpQcS6Pa8CX1AEKG1zxUXJ/WEeevzlFTDKzb96/Q92HsCxYBk750dKGUpGoJH8hDcCT+WIvVdXwM4VVp5q9obTcWTXYF6BNttu09A3hi+ByODsiPJi/s4jJfCUd+kYb+s53G0CLplqbKqmrnjaEwxhpphJbpXG1B4X5d3SelyU90npcVF2A90hgBB3h+zYnJssfn34bIo7zY0HHri4cTRG5UHh+mAQAw2V8vcRY/Kg7TKBKRLDOgFkOl0FVTI41ZX4hnXmwkwabYAOk9pz6zUT67beYvd1cgvh3Gql97Nh760jcYfK0jcd0INa0tEjT6/YL6Z8PB6nvNg/Tg+Bv0j5/hFPXxy8ODo+zp9NDl683DDpQK2i0+77+P7ugM/1j/bTaY0T9kbgWTh74w6fR4zuhe0mQ64EFP56yb1R+BsiXvU5jxpd+7qPcsd72+6If2c36LD/qXrjUTIVUph55rOcaF2xkMC5Xo+QkxbhugnG+FbhzrasHXyQEyyVv01FpL/nhRmrAWx2sP0qvkfhETIvmwI1uiOEukWDMUsyk7sSpR8bg4gMKbsqne1NL3ZD1vos8bVWcsZ89D0c4y9R30PMnUqme2Exi/eXqN2h6xPYne2yg/Gzw+dPV2yxuZJw73qIM+wdqiHCJj/Y7x2UYsVBKfJNmYaVm6doXAU4rDt67Gwdf8PIdMp722SVO8IZBPB3SWSvhLW5juC8e3emrcmg1XfrgrXZzlMOe7xU153yBqrl2lTc0Mb2984m4JChmm8oEN0cwcMMECfpLZnzYc33bb5veHdzSKN4RztoKdxoZoOlw+/U514RCN1bK9yTDGzH99lpbxJIxWrQlbA2tDLBqky4EfkjR+ecyvyC/g7eJjkZ24WwEqAwHTvkw8AV/kfg27UvDl8zO/q8NcM/YVl40DMzOhbV3mXVbaHGfjRUS+geMUdPnsT6JPkg5+wQYA6fUWV6bplp6lppywpyjsrF8ITfq6MwB3cC+uB56EHxQweyG7AYnGZtKhcT2tjsfgUv77Avk4OylyVtVZB9mGYToe18+1He0Ln6lFH3GBp7C0plE84BJJ1zt2PaWAt6HyfeO+8vxhwOjw5epAXnL9NDKF6kx89hnx7SeF7sAxw/e75BpdFp2D2C0rLk7J2wf80wFVdQxS9etZ5iuMZww5IMzwenYfRikAsR41GzZ8KKQOeBOTUuXkymR+M8nfDJND3kB+P0ePxynD473Idx8TLnk/HxBk7dTwudGi74nP0MuhQysgn5gleZpefVnTkUfGqQxvnTMe+xuW5nfa3WxhJW7412Jb1bdLkSSQwu5cb60F6ze0dr2HsQMTI8gh2xTwBfMdUk7Zyu3v0BfBXqkDSJuveBQ6Uw0CZtrzoGtX91tHdbMV1T7H5LaeHwDBih9i/M/J7+F70Y9OrsNP1nzIcJrOqfAy/ILWgvSq57hGG8P36e7h+lB8/djf4pb0qL+6n9/XZ4aeANYqmE9HfcUD2myL6CvTo7Dam0pYv/dEcNG+C1PLqgJnFNRVs1NHJtOjc+dwz7XAlJJ3Ed2ltej+S1SH1PIWc/eYJp5+enCAPv2rm4yHO4fc4pMLbmZFyWHz5Y9WBO9yqWuxKzbjluO4MuvU52n7GH7zjdHcjFKEQ7P6uC4o9h3zvfzd18lejXTo0U5WDaF0rWPMYXn49YeumsvbTQv/7mP1OuIfz/ePkuXNusRR0D4XA6jjEFX54GLgC5NysRsSfOsx683kfhdwfR/YY1kGPBzpbj3m5+5SJ1DyKmfnmScO3e1MC/AjeLlO6pekGNL1b1m6Aop+oKtBYFhCe0cEPggznSUCyHmsxp3rWPr9HNqmbwCBtulX4/92RabIxS2m00RB4b9mewukt/Jm1XPyPcLj4zSs/B4ctAuE1Pkh96jjDyi2o6vNpvdImq3Ss+Xgun91J8GBGV35KMvIFKDRbG0UtdYhg/46zXEF5J80xTEngdzRo/I1PCU5wfURu4XbbiQc4o9jh4MFe0MsA1bYPh1V0nsHTLDJ+vnGNqIRyhjpKPVPfyIyM4CmsGuB0lqOV+bfXjW3cNbaBE9nt7e5+STa5WIuw8stxo0dxrX+5ArGtzRwmaWPNh+hH0lcihs0CttaP703vUcK9AxKjUUvobD7aM77p05w/KXFV03kc4dgx767cXCyVmaGwLlTfoh9Hs/8O/ysBd/s4bqzdhVPfgo0/SuLMwlDD/9T9bgSJ/Rhlbcdmhs/EV1uEEbloT9PfzrX8/3/r3863/759v9Trewje7h+/QkTEgs3bj7fHn5Oogvjjq3kk46bn3Pcr4dZUf7u3yBd68MBap3txg4PObLm9v8ec/G8DQ8fMFegqaikXJdheCgrwiOZny0sAGhfbkV++/PmXr44qV8w33vKlF8FMSf+m8G8ugzX9IQGsejd0G3TKz3f0WF8dux8F/6+h0DXcdF1dnBCKzWw/3tWNWet7zspfDubYH+lS13di26wqf/XaOe8pHkJWiKEDza4zP+LVb+XCogyEm/naTlFzOGpddcSTRWeB9Py76bf5/Om+k9GXr5sa1OFdfQd7eRlGz+DdlYm7/G8oU+g0= +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"; + + + + + + + + + + +Verify a company bank account by confirming the two micro-deposits sent to the bank account. + +Note that the order of the two deposits specified in request parameters does not matter. +There's a maximum of 5 verification attempts, after which we will automatically initiate a new set of micro-deposits and require the bank account to be verified with the new micro-deposits. + +### Bank account verification in demo +In the demo environment, use the `POST /v1/companies/{company_id}/bank_accounts/{bank_account_uuid}/send_test_deposits` endpoint to simulate the micro-deposits transfer and return the two amounts in the response. You can call this endpoint as many times as you wish to retrieve the values of the two micro-deposits. + +### Webhooks +- `company.bank_account.verified`: Fires when the company bank account is successfully verified. + +### Related guides +- [Manage company bank accounts](doc:manage-company-bank-accounts) +- [Bank Account Events](doc:bank-account-events) + +scope: `company_bank_accounts:write` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/put-v-1-companies-company-id-earning-types-earning-type-uuid.ParamsDetails.json b/docs/api/put-v-1-companies-company-id-earning-types-earning-type-uuid.ParamsDetails.json new file mode 100644 index 000000000..fc73b287d --- /dev/null +++ b/docs/api/put-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/put-v-1-companies-company-id-earning-types-earning-type-uuid.RequestSchema.json b/docs/api/put-v-1-companies-company-id-earning-types-earning-type-uuid.RequestSchema.json new file mode 100644 index 000000000..e79c535e8 --- /dev/null +++ b/docs/api/put-v-1-companies-company-id-earning-types-earning-type-uuid.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"The name of the custom earning type."}}},"examples":{"Example":{"value":{"name":"Gym Membership Stipend"}}}}}}} \ No newline at end of file diff --git a/docs/api/put-v-1-companies-company-id-earning-types-earning-type-uuid.StatusCodes.json b/docs/api/put-v-1-companies-company-id-earning-types-earning-type-uuid.StatusCodes.json new file mode 100644 index 000000000..77ce28ed3 --- /dev/null +++ b/docs/api/put-v-1-companies-company-id-earning-types-earning-type-uuid.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Example response","content":{"application/json":{"schema":{"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":{"name":"Gym Membership Stipend","uuid":"f4dc8972-8830-4c07-b623-349a04b040d7"}}}}}},"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/put-v-1-companies-company-id-earning-types-earning-type-uuid.api.mdx b/docs/api/put-v-1-companies-company-id-earning-types-earning-type-uuid.api.mdx new file mode 100644 index 000000000..497a5619e --- /dev/null +++ b/docs/api/put-v-1-companies-company-id-earning-types-earning-type-uuid.api.mdx @@ -0,0 +1,71 @@ +--- +id: put-v-1-companies-company-id-earning-types-earning-type-uuid +title: "Update an earning type" +description: "Update an earning type." +sidebar_label: "Update an earning type" +hide_title: true +hide_table_of_contents: true +api: eJztXFlvGzkS/ivc3ockgNqWZcV2/LSZONn1QyZGjs0unKBNNaslTrrJHpItW2P4vy+KR186bCn2ww4mwCATiSx+LNbFqqJuo5t4WmkjYy4MTBU1XIrYLEqITi8jKCbAGLBoENGybA/R0fdBZOhU47C3VAkupuTzogT7hQJdSqFBR6e30Wg4xL8Y6FTxEidHp9HbG1qUOZAwMhpEqRQGhMGxtCxzntqF9n/TOOE20ukMCrpMKRpEDm4kJ79BaqJBdBODI2/X90vh/wpa4MA3VM/IZ17qaBBVFWfRaZS9PDo4SV+NY2DHLB4fHh3Fk1E6jrNs+BLGh8Ph0TiL7u4GUalkCcpwR9sRvA0ItFFcTKNBD+LnGRAcSWRGzAwIeH7hrL3oLoB4CJnzs9VEkOeUfRD5Ijo1qgKEehNvOKDfK66A4Zd2cTxNbpBLYXCMgxHcGl7OaV61mfrPRUHeo8AoPeMl+WR4CYK1ODxm6cmr41F8cnI4jMfp8DieHI0O48PxKzocT4bjITuO7uyfQTQejpdP+ldpyDtZCUa+CUK+CeQHbgS0AYaSJCuVAmESNBHSELjh2uyR9/QHEF0psGwrlZxzBox8+XJ+Rrgmc5pztvdN4FbHo9Hysl9EqWQKWtNJDuStMNwsagRck4IuyIyWJQhyPQNhV5lItsCDWshKBYwEBZxyoQkoJZUmukpnhGpyxYUFkVBjFJ9UBhLL3KsBkcqSCxQyynNNWAXESEJFMxNl0qrL1R75BG6nl2/dMm+ogalUHPT35zNjSn26v89kqves3u+lstgPeh6XdKFkntvv9y3MOK2nvyDTijMgmVSkkAoIA4OAkHk7q+8q7v7F3D5z+xaurb9uw6jBXdvkP2/MClWKLqJBxA0U7c/XU01+AE7wKBdr1rCj7rVen0pIecZB40F6ZbTTiUzTSuk9tE48pXm+IAaP/gcsCGcgjJuF4+sz3C+pogUYQAHIKeq/kQ1Ja1Rr1FtAQwo4FsXLUSJoZQKpYD28lJGpklXJxVQTKhhJqSATIJV2aCYVzxlJUQ4KP35GBcvREHPhpLflUffIedYsxDW5EtawJe4crwYWnDsrcs3zPIg8ocSNJFd+KPGHtCDX3MwIOJPlvrSsKVDfpg/wXBdhv14aCZ3IyrTOLiZTEKCaU/OkAzN0pTKaOoZQQUAw5I/yKAxl1NBVotiF8SYot4Ic5lQYgvOQpheQhddk7wK4IFanufRmw1ukSQ575J1UxPu0QYeExWdZdeX+ThDVlT3b8Ak6syvH/knjTND/SgEfsuj08r69FFVuOIY+liLqUU/xwsfLyha+2UKlu2trLqZhZZxGGeP4Fc0vWith/LBybceQ+6Xm13as4zhqZrQtNqlULvJjmhhppaHF4PtX+CL47xU05kFZu9msZyk6650pWTQELxuKosrz6Hs9rioTIzcP7Ni5VQO0oQY2Dblrwqz3Xvrjr9zM4g8CYuf8orv1o9572XFD8WjuBn+d+Z/hzJHSWofd5cNXND5S5AsX4BK+0W3skXODH5dSa44hlpFkRudAajuUwxxyjWfn3UhwFLVZiVKu0iqn6rmDG9vgJ/5gBe5F1N7higFOoLt3sgkVPxKaprISJmGQg4GkElklGLCkpIsChOkEMZedWCOaUHdlrF18tBSsRS03F72rBONi+h7MTDIyo5qE1Ui9mj2DDrA5KJ4tEi6s6KaItJSaPyqy/2IYgKsSvyp6Try9TIDY9TmwPXKRA9VA0hmkP1yQghGrh0NogRPRta/bAs3xerhIAsUn3QCy1y9IJgCi2ccKgAXXaKESJSuDarMemB+RiAovmash9oL8DtCPbj5x81Engtv1uLwkJKkUGZ/qGloda27FteXZbTCvDcEjNUQKIE0wW1TatAOL1cDCbjOqTdCWJOcFNxsQrhi8NQvfIWJPg1gaRM9klTPETD1na8xJCYpL1uAFwRLmreUalPWQldhW8/KtYBgPQktz7A3KzKggh6SQwsw0xoRZZSoFDl8qi5IKVG5WaaMWiYYcUpTuRFCe6iSVDJImMFuLuBm9PT9/xbkE564Qx4ch9Ms8PcAgmvB7RXP0IkeE8Smvzc4GuDoA0A+Aq3nqxm6P9hNPLVa9DHbswTqshheQyCxLSpnzdJFgCuthZ13sxMRi1fn2QVTCahSwWl9omqqK5onarDOdYVtY7tduHsF5NccmOZpyjKxqPMQC5KDXAMc8nzXhLpGyyTv2pm6D9o1TbgY0NXyOkB0Nd8f1GAguQGSWhazOOsxQlLlcAOiHHHs9ePuzfxumEqrg4RIwoTkVKSRVeY+9XO+tN6F6Q4XNkFL2mz12t5refOwzmXOGVh3/c4BDWGED0ceMit44Y1KHETakIB4BeiB/+OuhCWmeDladYraR9CpgA1L6kE0ByqoUsBZq7R5rMXsSUTx3Y0ggQfDapVs5DItPiomkCsPwMO4x+Rd0GAN+Ui9VQ3IQljbziAg+29wj1zbZY6+lXHSywJhc7nk0F1YkIDB/hEGYUTQ1UiXSllvWYuuP3F5NawLuvtfENw4LswprpRxtn8PbKGzA/5RxbG+PK9ycNlTZuJ1mBpS96z8kClietT3/Luq4+tkKes8aNW5SEzZPSbyizEEYv4uQWnwo/s74n0LeoXQv5jC6udJgySGZKqk1pjvC4gLsZWBTrONHbB/ugL0j1BFFuBf0INmoBU9kJiv1kMBwN1f3L6Te0hwBU2r4vM8gr+Mp+sH8Ee3NhaPfAuCWqNUjU/IPEInH8aiWDrM+fvmlK7kvumFu4dxol05vMLqwg2GFjOYG1Bq0iaey+d7+U8C5JhNA41YDDqWWHlSbauTaBoAebCUKyXjGrdkOkEM28zHBhopRuXTYDoDjZIflzlBqUHNvxfVCGyjqQcGG92MDawV0kklV0E23/e74nzFAXUqNVgti05MeZ0FveFEVfZy6UiXFPT8h1Lc3KQBGER4DnsTBcGi5mkv5oyo38fIJgYWAK9wBbMvBc/1iL+rWvpq6zmUv6V5fH6JerjysH+M/44PRIe6wY9AmuUx/gKqdv026cZHJrYS/R21lMGwlwgfCnTwgF0QqBgr9k6pEUI/+9t3ayzg376c+HA2mKp9mU5Q1oanebTs9mJv3lAHDUmpi6M1TbgvjQhuA+/WIoTfErrfbHpdhP0AUXU7YNYk8+jY7YhgsVshC/4RcdkCv3qSuNOYitkyxP2RTHJtaPPG2E7x3Cw0kB1lXE7srKZaOps7ZbQrNl6bvkqqriZBAhNSLN3eIaB3gxiv/LNpOuazHv7Cat8Y2hU7TWWJmCvRM5iwB73yiVv2uj8BuC2qs2/Mq8AVFwKZt5pTn1BfzMOLP50Bsbv71m3+RzwEcCZ6xVT+SUttkBDrJr1wBORcD8l7OgXyW2FynyBm15ci2w5yD0tuqaZhbX18CkV7tyObFqDFQlPYSa6QP6Qht+jkqFE4MOWRlYpnF9ntPMFwz+VRQIxWm9ijPH5bWozzfJaVHed6+6PYBhHt3yI7NqE7qbx8/m+KquXXBAw+3Xo3Y9iAPqBYDBQWeuC2dh+RBM2UCGRLDPgFkOhFwjURDoMdvgCWM60mlNNhiUlO3XrOx9ugttK+VWwh1q5XRzwbdW0eii0GaJMO+0g53z1qgrdbZIY4LT7w9NmQZHY1GMWXDk3gM9DimwyMaHx8cH52cpIeTg+NXGzYdqBW22r1L7O8KfG5+7T+d1TglZxxr4eTMFZ8H5A0WpfeiPlcCCuyPqHa6gTgUbn4wfS6ixtC+7KJ85qNtV+J/thdsWHO4m5I1Nvf3EKlY03N8TXVfRqKMC65nic9yonfFRgIXej1BTtozyN3xjUTNNqRZvJcTzKWLYhJL+r4oTBsFYJKD7U/xPQoPF2leMbTojhDaFgVaL8lM6lqUfm4NS6RP2XXpbO96cRqy1meJr5UUU+Jv3/01/uDlDmLuTDIIvGuHLN4fvHRF1+ewN90jB6PD8csXK1RsJgXs3A9xgbNDN0RQ8oNhp1CKHQc5TzdlGlYqD6tcBzisKz22VAfLd2YGutXe2ySrXAmnd4F/SCJ7JazNfQSf288Dmp4Me/ruXLA320XKQcdzed1qb7C9XJuaG5q7/c7ZBFwydPP1BaKdI3icBepNek/mYlh9v8/3Ax/uDu0qPtAOVgoVTW/wdPi9nbPTDQR7goER+xV55uc8a14SCElKUAU3JozSwatMqObpE9/OqW3zC/Y7RJs2yNjuCisAmG75IX8NXBF/BL5d++bwNbuzX2/N8K/YFh7szNSWRZUPWVXTqDGsHdUSuifM0dtIYn2SvJdzdggwh09sZ3pqiK7KUipDmA2O8kW/wu/NUdiDq4A+eh661/zQguwWZL1q1qZ2Ma60SXZreHmHc92Lt841qR83W/+QJROuzGz7Vc5sXT0jdnp9NfYe1LZNuADQ2pyHlWnrXtBdgngfvB+PKIyPDo5jRumreAzsOD55CcP44ATYSzYEODl8ucGk2WrYDpfSPKfkHTd/TDEVx2zHL0Vjjtc1ggprZXjWq4ZpwBjRXhHrUrNnwoqLziNzasSOJ9nRKI0ndJLFY3owik9Gr0bx4XgII/YqpZPRyQZO7WaFzjXldEZ+AZVzUbMJ+ZIvLIuu/euVh3EoxNQgtIun67zH5r6d9b1aG1tYfTTalvR20+VKJPXlUmzsD+0M2/m2hrN7N0aCJdgB+QrwA1NNwszs07v/Al2FOiRNatv7yFelsNAmay9bDvWu08Dfea0Yr2x27z6Y/SUECvVz2f/biOFuEH1s+Y37NvQncSB3g+jX2oPct+e/XMlfruQnXEl4/V5br3PcW1mZeH4Q191dcd1pzWL/IwDuDtT5V7gE9t5Q+dS66P58wDfxTehUlnBKrrxh0KfXihu4irDE5a/CjnH+vX+DAh8KCWuwrBY2mXf3qKx5+d1933W36vcN7Kt8/4zMr2DVfgMRj2fV5jfB2rx2mz0WgF/lP/E/7a9lvL44j/9dVzTsOjOgzJrpZqWM5nppqTNkZcGFf26MBxKj9Wfk9cV5qGoQqrVMuW1tsRkS+1wYB+ALaftWWKB75U0D58CNaT2+f6bJZcGFbYpo0d7ypToteexncjH9uycYtz5+gTDw2TN6k3UnhR0MVYEP5EbD0ct4eBQfvMQ3rgwyWuUGlbj5/O7O/0gFaPOLZDap0j/AB//gQP995GP8hEd41t39JY+7n/65jGACbmJdAv0BVC9i+8q8kfDPPt/RHoJEYzkHpThD6r5vHNEYENpmYlB3nblb+5MvgwDznp9+QYUIpPo4axpdvKundHE3Uz1+lAJfxbB20BojM4tOo/35wX5tEfdvG2N0t9+xifu3S3bhDoUUG6+8PatUjtrrVYKW3GlEzKCwarEkC2dQyB7/Hb3YVW/wa9zuGsIraV4oW6lZR7PEr5EbGtJK2Szj5W2IAl+nGJG+rpAxl9/boz6hDjhRXDG2lnmEGDQX/z0Bqqwl67/CtyRi+2CU0MrMMEsYuiEG0SfbwvYzKzgKaxa4G0So2x8bq7D8yz6NVwitTiFyt2YbrSBKWahnt03OIEKzrD9kn0DNeQqto2sspP35g307cJ8hSrQksf031qW1n7r0ZBfyVBa2XG9xPNPkrdcvEjpE0UAzmVYYDtgd/83/qAp16Xe/w7OwKvmIP3zhc6yulI2y57/9RyNq9leLpDYFFS06qyOBPvLbxsruFjv48zdwY/bLnHIrKFYxbr0qX0ZzW1cKyhwNotNObNHRZ/x22dN/x3cV2iCx21v0pV9UfneHH/9eAcZzl9/RtijbCmpVh3F7hVvjo9vbfv7R+50XZF2Asmab4RW3HREsW+SflLfjJzQWjwKod5Q7oFrmrXu14mKb7Tj3Jw90VnLXcXF1lFgzu/GFbxyz3G9tNSOW4plmBprX0mwc23aaF18+R4No4kOoQtroQNFrDFPptTv5UKrBGAs/u41yKqaVu+Q4kvjnf5bTIBc= +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"; + + + + + + + + + + +Update an earning type. + +scope: `payrolls:write` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/put-v-1-companies-company-id-federal-tax-details.ParamsDetails.json b/docs/api/put-v-1-companies-company-id-federal-tax-details.ParamsDetails.json new file mode 100644 index 000000000..02a817035 --- /dev/null +++ b/docs/api/put-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/put-v-1-companies-company-id-federal-tax-details.RequestSchema.json b/docs/api/put-v-1-companies-company-id-federal-tax-details.RequestSchema.json new file mode 100644 index 000000000..cbc5e594f --- /dev/null +++ b/docs/api/put-v-1-companies-company-id-federal-tax-details.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"legal_name":{"type":"string","description":"The legal name of the company"},"ein":{"type":"string","description":"The EIN of of the company"},"tax_payer_type":{"type":"string","description":"What type of tax entity the company is","enum":["C-Corporation","S-Corporation","Sole proprietor","LLC","LLP","Limited partnership","Co-ownership","Association","Trusteeship","General partnership","Joint venture","Non-Profit"]},"filing_form":{"type":"string","description":"The form used by the company for federal tax filing. One of:\n- 941 (Quarterly federal tax return)\n- 944 (Annual federal tax return)","enum":["941","944"]},"taxable_as_scorp":{"type":"boolean","description":"Whether this company should be taxed as an S-Corporation"},"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."}},"required":["version"]},"examples":{"Example":{"value":{"version":"6cb95e00540706ca48d4577b3c839fbe","tax_payer_type":"LLP","taxable_as_scorp":false,"filing_form":"944","has_ein":true,"ein_verified":false,"legal_name":"Acme Corp."}}}}},"description":"Attributes related to federal tax details that can be updated via this endpoint include:"}} \ No newline at end of file diff --git a/docs/api/put-v-1-companies-company-id-federal-tax-details.StatusCodes.json b/docs/api/put-v-1-companies-company-id-federal-tax-details.StatusCodes.json new file mode 100644 index 000000000..cf3f0bfa6 --- /dev/null +++ b/docs/api/put-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"},"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/put-v-1-companies-company-id-federal-tax-details.api.mdx b/docs/api/put-v-1-companies-company-id-federal-tax-details.api.mdx new file mode 100644 index 000000000..19e50ad70 --- /dev/null +++ b/docs/api/put-v-1-companies-company-id-federal-tax-details.api.mdx @@ -0,0 +1,72 @@ +--- +id: put-v-1-companies-company-id-federal-tax-details +title: "Update Federal Tax Details" +description: "Updates attributes relevant for a company's federal taxes." +sidebar_label: "Update Federal Tax Details" +hide_title: true +hide_table_of_contents: true +api: eJztXG1z2ziS/is43ockVaIsO3bs+NNlnGTHV0nGlzg3t+VJ0RDZsjAhAQ4A2tak/N+vugHwTZQsOU7V7tRs1W7WItBoNIDupxuN/hbdxleVsSoW0sKV5lYoGdtFCdHxRQTFFLIMsujLKNJgSiUNmOj4W7Q3meA/GZhUixL7RMfRm1telDmw0DIaRamSFqTFtrwsc5ES/Z3fDXb4Fpl0DgXH/2eFzSE6jt5CBprn8Tm/jV+D5SI30Shy/ERq+jukNhpFpVYlaCscM9egjXAEfUNjtZBX0ajH4PkcWFppDdIy34mpGbNzYI70mH0CoL8v/Hchr9hVJTL48nRubWmOd3YylZoxyWycqmInyCgu+UKrPKfvOyKDolQWZLp4xmZKMyFnShc0faYkm6sbZhWrDA4nDJsJyLNxdDeKLL9NSr4AnbjJhEldNLOSVZ7jknRn9+ucW4ZtaU78loG0wi5oOqkqSi4XTJgx+0Vii+PfZMxO4hOlS+VWHX/4tPSDyoGhuLUAqzT+9O7difvnjP4RhbCQsZJrK0GbuSiJsorVTevvV8aoVNRkz3VlLED4+g+QuOp9Iv+tBK2UtJUG/OGDkvGZVjNhvaT4NIeEm8SkSpetDTBVKgcul3bAr3Owc9A9maC0IGPcMC67Ihizc37LaDlItIZZlHLBF2wKq7sxIdO8yuB4UKZLUn/37gTnMxO5kFcJ7pPN9jK2xC2UsWl3mXHDzdxJop3gKHeW/uX+Lnv6PxXXFnS+6LTWYCstifoz13SfPX0lZcXzle2Q/zk3CQi5xTJ4fp8Y9qYoc4VSPs1w2868pmAfqmIKmj19c/rhGa5UqcGgQrkbRSBkcg1azARkWy79m9MPbM4NmwJIZqo0BWNmVZ4vWCBIq8queS4yan0j7Jy6nn78NO6O7jhtcVCrKTynuEOj4xnPDfQ5Om2pBD5VlaUBjOW2MniGifwCNVBrbTeU1ZKSdGSH9tUSlyCrAvVNCTJzTWoxj6IZF7kzCMv7sWEdRdaWDm25S0/w8pid+0Vot0E1gwtBKyOVpRnngMrlqeoe2UyBa7IAy+b8GvAE4rTHNE5gtzXQd6w2kXTT9gRbS3H6gWUiI15KbkxnQmN2oooCtYExFRjGNbAp4HqCtKAhQzWhtIbU5gumNFEpuE3ny2uewxXPmeQFjKO7u7tRRD8k+MNmuqIhEEyeJ06beTaD1IprSDJuNySILZ02tHMwwDJnrZlV6itzBOmgZFAqI2yCtj6r8g2o/6xumJpZkJ01NyAzwwolYYGWM6xOo9MYi9knKMQNwNd84f5+r6Sd54sIJXYbgwModAo8WCH8wPMKOkCi4axvjTtfetbHH5+OGm/a19rR6gr62sv91l7TpmN/cdpi64s2fLtzE7b8yuBJ9qiKjFlAVV9w3TcWyMHB3u7+0cs0PUxfPj98vvd8MjmaHGTp7OiQH8yy50Oi6hi+QYm5aXcF9nJ/dzNpDWngoOUajdU7KtGJ304f8CSg4R0Q8N5kbz+e7MaT3WEhN7sMBU2y3p/sLwPiD8qyt6qSGcPd+JvEY6PhjwoMKjUNRlU6hUabwa0wdsze86/ATKUdEi21uhYZZOzz59PXaAJJTY1/kzi1/b295WE/S69JUdrsjUOBgQNhCL3MeVmCZDdzf8qmKlugYlioSgceGaJ3LqRhoLXSBnXnHFXlpZDERMKt1WJaWUhoy1yOmFfUgcKMVEJWAR5ZLpueaJpo1S5bmPuNG+aEW7hSWoDZEnQTm3Fad3/moDvBoULpWkeh8LbwTe6X7t/C7Qu3D4WQZ6Hx8F5EbsIIIboQxf/e2AeuNV9Eo0hYKMwQwFqimnwF7OC5XKwYg1rda4Y+lZCiDjG4kP4wUnem0rTSZszOF6VIOQIJ8uG+woIJD8nIUwBWr+FOyTUvwAJugJzj+fdGjEiSpay53oI1pBB8PkfJIRRPKmgPv8vYlVZVKeQVuiwZS7lEN4Y8CKvYtBJ5xlLcB4VvP+cyQ+XMhHS7txUlGLPTWTOQMOxSkmJL3DpejlqONbsReR62POPMtWSXvinzi7RwyMs7ru4jiabA83a1AXY4C/MNcKQB1m5GMbtyzmZYNU86CMNUesZTJxAuGcgM5aM9F5Zn3PKhrdhl4yQcbg05XHNpES5xpOk3yMKfZG8ChGR0phEGk9rwGmmaw5i9VZp5Sz3qkCD+SFSX7l+yvJe0tuGXqhLZpRP/tDEm42gUKQm/zKLji/vmUlS5FRjXIYp4jnoHL/y8fNjCly2OdHdsI+RVGBm78SwT+InnZ62RHB4YGHvRi6Gs2jUfWrC4jprw9rYhnI5hrQwRrvMAGwHfP8JnKf6ooFEPmvRmMx5RdNp7plXL/18K+9TtqjKxan3Djp4baoB4aV2MCaFNCM2997s//lXYefyLhNgZPwc2h1u993vHNcWluRv9veZ/hTUn92GVwe5FXlD5KJkvHMBlYq3ZGLNTS5EeZYxAiGWVc/FrPZTDNeQUZvBmJBiKWq1EqdBplXP91LEbE/iJf6EN9yxqz3CgQfCe2t7RlMuvCU9TVUmbZIBhiaSSs0pmkKHXU4C0HRBz0cEa0ZS7eHht4qMlsBa1zFz0tqJQyXuwc5VR9CKMxurRaA06jLmIUVKHFRLvvDwmZ/9EGICjMj8qWk70XqZQx1PG7CwHboClc0i/OpCCiNWzw3iBHdG0r5oCzzXwbNEJ8P2wCaB4/YAuSFTPY4DBQhjUUIlWlcVjs5ox3yKRFJcbZrEH8juMfnT9meuPZyKYXc+X3wlJquRMXJmatRprbiW15d5tZl5ZhktqmZLAGjBbVMa2gcUwY2G2M25sOC1JjjcHazgcaLy1CN8ix54GIxrMzFWVZ8gz95KteU5K0EJlDb8gszoitoLLuskgb8OyfCMzFz5rTg55UHbOJXuOMS47N4gJZxXefDj+fBwsETKrjNWLxECOYQslE8lFapJUZZA0wGwlx03r7eX5Afsy7DuwHTfj0A/z4xkMWxP+wIsLq9gLlokrUaudNeyawIDZgF0jUtd2e24/iZR4NcvM7ntmHa9WFJCo2SwpVS7SBQWzNlvr4kFCLIbWt89EJXN3+VefF56muuJ5otefmU6zLTT3K9ePYb9aYtMcVTkiq5ofRgwKMCsY9/cQiQ+krLOOva7bcHviDncGHIOLyLKj4XxczwPDAZiazUJUZxXP4C59wGyy7HXj7df+TehK1xUb74Apz7lMIanKe/Tlamu9jqsTLilCyrPfadndaGb9ss9VLjLU6vhfx3CAFQREHxMVhbBygBEEKZjnAC2QX/zVrEllfxxbdYjZXZYNMDZipYdsGnCvKgkrWa3NY73NfshWPHVtWCDB0O0yrRgG8afkVHGNMDy0e0z5hTOMgJ/VQ9UsORaWJvOIHJxT7FFQjoFzS4XsRIExuNyzaA5WJCDpugWjbpqnVukEnbA1vPVbbn9MawLO32vwjeMlowNLuxx1n+O3ObCB/x+JY3tzHDBzxnJNuJ3PLGjy9TdBAcu9tpffWY2rnwzQe9Ic4yY0QXFKf3UNmCrjZxFCi5vy32n/XZx3KN3Lc2jduDR45ZBcaWUMhjvC4BLIGViHdXyL7eEOkI9QI4rgF/RYItSCKzJXld4EGD7M1P2M1FsnR8IVx8vJHjf+jKdoB/NH1Ddnjn6LATdEfTxmWv0JMvF8PKqmw6iPH37JJfeXbhhbOLXGhdMbHh3syPCGjOeUWzHIbeKprPfbv4txYXyOR81wuGrpsUqhRsw9E0VY20oWKhMzQWo7sByimY/JbLgxKpcW2zHgJNkRuVOUBvS11+JmYSwUdaOgw/vYgLSASVym0wY4wbX/HgXUpdScaskoPOn5LPitKKqiz6epNObxbISuH8rqm9sUAFGE5wFXYncyIanmSn2tynWy/IGMBcAVfABKOXhqno2j7t1Xc69z0Qu61+5D1IuVh/Fj/DPe3XuOM+wotGmu0q+ga+NPQTfMmt1q8/eoDYJh2hEeCHfigEIypTPMEVRMVzIcj/703djLfK6fT704BmxV/phJ8ayBpuZh0+mxuX5OPhs0wdSfHzitkAjYyT6l8R42x2W2N9iK/VSjR51mZxsGjVVnJz58X3aYHp6kqQzGIrYMsW8yKYFJLZ542wjeO4WGJceyqaY0KyWXlqaO2a2D5kvdHxKqq4mwQITVgzc+RLSK4cYqfy+3neuynvzCaF4bUwidp/PEzjWYucqzBLzxiVr3d30OaFpQ87q9rIJccAtQ2OaaC8oxph0MRuXXwCg2/+rkZ3YemGPBMrbuj5QyFIxAI/mr0MBO5Yi9V9fAzhUm12n2mtN1ZNtgtl6EbA2bavclEOndHVFcjFsLRUlOLL7iIEjHeJPPUeHmRMihKhurWUzfPcHgZoorya3SGNrjIt8srMdF/pCQHhd529HtMxD87hAdw+TL+uvjR1PcbW594YGLW4/GKD3IM1RvAw0FrjhdnYfgQdNlCjMkhnkCKHQm4QaJBqAnbiFLMmGmlTZAl0nNvfWKibVbb3H6WrGFcG81iH7WnL1VJLo8KJvMMK+0I93XLabp1FETJ4UfPL1sks343t5ezLPJUbwP/DDmkxc8Ptw9fHF0lD6f7h6+XDPpQK2g2+6HYH93wef61/bTaY1j9lrgXTh77S6fR+wEL6XHUV8qgQufQ/xgLvwrCK/6HKJGaF92uXzi0ba74n8yDjqsWdx1wRqK/W2yK1bkHN/4NxatPRLNhBRmnvgoJ1pXTCRw0OsHxKS9gJyPbxWebMuawXsxwVw5FJMQ6ftQmLEawCa726/ie9w8/vkW48wRQt2iwZilPZO6FKXvG4OI9Cm7LJ3tTS92Q9H6KPGNVvKKee+7P8afonzANncqmZ6w1FG8P0XpLl2fwvhqzHb3nu8fPBs4YnMl4cH5EGfYO2RDhEO+O+lclGLGQS7SdZGGwcOTVS4DHFZdPbaOjn8cZFrpvU2wyl3h9Bz4TQLZg2ytzyM4bz8PaHIyaPXdumButkPK4Yzn6qaV3kC5XOuSGxrf/sHRBBwyZPP1N0Q7RvA4A9ST9JbMYVhzv833DTc3hzSKB9pBS+FBM2ssHX6nPg/yQDAnGDJGn9gT3+dJ85JAKlaCLoS1oZUJVmXKjUh/sHfOKc0v6O+ANglkbOfCSoDMtOyQdwMH8EeQ241PDl8xO/q8tcB/xbTwoGeu6FpUe8iqm0SNSW2olrj7gTF6QhKrg+S9mLPjAGP4jDLTU8tMVZZKW5YJ9/6wf8Pv1VGYg7sBffQ4dC/5ocWyGzDr3WatSxcT2tjkYQkvb7GvexzZcZP6uJnswyyZCm3n24/ymu7VZ4y6166xt6CUNuEAIOmcza5p61zQh4B4D94P9zjsv9g9jDPOX8b7kB3GRwcwiXePIDvIJgBHzw/WqDS6DXuAU5rnnL0V9s8rDMVllPHLUZmju8bwwNIenvduwwwgRiQXsb5q9kIYcHQeWVJ72eF09mIvjad8Oov3+e5efLT3ci9+vj+Bvexlyqd7R2sk9TAtdGq44HP2E+hcyFpMKJd8QSK68a9XNpNQwNQgjcPTddxjfd7O6lyttSmsHo22d3o76XKQk9q5lGvzQzvNHuytYe+ex8jwCnbEfgX4OnIviOnp3T+BD3Edgia17n1kVykMtE7bq5ZBvesk8HdeK8aDye7dZ8A/BaBQPwL+t0UMd6PoY8tu3Dehv4gBuRtFH2oLct+c/zYlf5uS7zAl4fV7rb1OcW5lZePr3bjO7orrTOssbl+9ZXV9p9p3dTP1T/WbbviyR5KGoWPThMrdK7BWGanOg6y7oboV9Ix+qQRGPej/xf+gclivzk7j/61vAGj0OfCM1Foz/mBdl9c4k0JI/zwXD2aM2jJjr85O68JT3FdEwi2KEQV6XosN8EUxva2VaI5Ek/A4cm1aj9WfGHZRCElJBC3aW77s5qWIm3JX/+kJxq2fqfQOPhNG7btK2k3hmL3J3kE8eRHvHrg6MTNe5dbVVQi/3919GYWQx08qoyBEf1k3Lx62tjzY41ZKERvWGcPKMGo2QGFVfa9VxDYr69WS/kmv7Ea/DEevpFc0ilwZjHfvzvB/l+t5RaOoXc4rGkWtal7RKGoV84pG0UAtr2gUdUp5RaOoVcnry79c6asNql49awncVSx5ub9PU/muqmTCNPVu6ndKK8uM0fvRf8Hidy1l4kjHOW74rQrh3XUfmYdpble15kU6fXkAk8nB/uRw8iLl+0fZ/sHh4fR5evT85WwKQ1Vr3DHYsLoPLvo9xWp8v04RmldpAQwXchx5C9pdq1dNXLlVLaK9C+tqS6gdQh0Hn1l4LbiTJcispHMXytEtW8TP1Me0I9l1yQJcLd6qQdUaH7DMB4Vw2svZgr5UVU8FcN+QcS82jI+ik6llb/wmYj73dPyb/E2aVJVwzC7ryGoDHMAc32hh4ZLWaU2FI3zEa0rgX4GbRUy1LxDnu6bn/LYpMNluh2sUq2vQWmS4WP5JC+47C9JQkBhRikNiK8tnjsKGbJfRRKAR+vU5qzsMcDjcr8tp099zjCbWX6kSKCOgZefRcbRzvbtTw7Odbw3QutsZBmiU9+nRWaVzBENeIfBSOH0QZ1CQUljSPK+hUD0ZO3qxuzzGzzjBFYQHaZ5puiheRbPEzzh/A2ml6ZLj4ltwQl9RBbhXFYri4ku71SeEFE6xDLStNSyyGIAQ6XXgmoBhvwgIkYjpvTrjlZ2j6U5r1f2JMmi/ZwRHYcUAd6MIodLHBmS1lOWKUmNiffGzPrQYqty1qsrXUnE1uh9z6Z0hWuH0wauz06jdvgUbRxFCa/PL7BPoa5FCa780RolKvuxQw50MRYNoMKa/MRfH+K5LVhjyVBWUokR8UKXFrmYikJ2ptEIXiITwH76QFHdXjl6gr8Oo7COqb3+v5NJ3cMP7r//V7G9crVIZW3DZouO0MxtSbj3uvzVo+d9fp7vNZuHW7pQ5F3RYSDl88wrsIrqmq/2gwqJRdNzxFoe02Bd8y2Ys9v72Df2xzzq/u8Of/6gAfeiLL6hCtXDFMC++YZ4MvVoa9vPaIn/60cvoGVvlY66YV6icQS2CAo98GY+2C+we4zkXdDvm/uL+6KBYnfiGnflayo1VPXHCis87lnvZ7Wx6oNou7dq2bfN79vk8GkVT7+kWipCF5jcYTeA3bsnDDTS6wvjbtyjn8qpysRtHEv/z/6oQ7sk= +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"; + + + + + + + + + + +Updates attributes relevant for a company's federal taxes. +This information is required is to onboard a company for use with Gusto Embedded Payroll. + +scope: `company_federal_taxes:write` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/put-v-1-companies-company-id-pay-schedules-pay-schedule-id.ParamsDetails.json b/docs/api/put-v-1-companies-company-id-pay-schedules-pay-schedule-id.ParamsDetails.json new file mode 100644 index 000000000..274e97c02 --- /dev/null +++ b/docs/api/put-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/put-v-1-companies-company-id-pay-schedules-pay-schedule-id.RequestSchema.json b/docs/api/put-v-1-companies-company-id-pay-schedules-pay-schedule-id.RequestSchema.json new file mode 100644 index 000000000..b9836c484 --- /dev/null +++ b/docs/api/put-v-1-companies-company-id-pay-schedules-pay-schedule-id.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"required":true,"content":{"application/json":{"schema":{"description":"","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."},"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"]},"anchor_pay_date":{"type":"string","description":"The first date that employees on this pay schedule are paid with Gusto.","example":"2020-05-15"},"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.","example":"2020-05-08"},"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."},"day_2":{"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.","type":["integer","null"]},"custom_name":{"type":"string","description":"A custom pay schedule name."},"auto_pilot":{"type":"boolean","description":"With Autopilot® enabled, payroll will run automatically one day before your payroll deadlines."}},"required":["version"]},"examples":{"Example":{"value":{"frequency":"Twice per month","anchor_pay_date":"2021-10-15","anchor_end_of_pay_period":"2021-10-15","day_1":15,"day_2":31,"custom_name":"demo pay schedule","version":"68934a3e9455fa72420237eb05902327","auto_pilot":true}}}}}}} \ No newline at end of file diff --git a/docs/api/put-v-1-companies-company-id-pay-schedules-pay-schedule-id.StatusCodes.json b/docs/api/put-v-1-companies-company-id-pay-schedules-pay-schedule-id.StatusCodes.json new file mode 100644 index 000000000..1d858c94f --- /dev/null +++ b/docs/api/put-v-1-companies-company-id-pay-schedules-pay-schedule-id.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Example response","content":{"application/json":{"schema":{"type":"object","title":"Pay Schedule","x-examples":{"Example":{"uuid":"f2a69c38-e2f9-4e31-b5c5-4754fc60a052","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"],"readOnly":true,"title":"Pay-Schedule-Frequency-Create-Update"},"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"]},"examples":{"Example":{"value":{"uuid":"f2a69c38-e2f9-4e31-b5c5-4754fc60a052","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"},"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/put-v-1-companies-company-id-pay-schedules-pay-schedule-id.api.mdx b/docs/api/put-v-1-companies-company-id-pay-schedules-pay-schedule-id.api.mdx new file mode 100644 index 000000000..a4f2441e6 --- /dev/null +++ b/docs/api/put-v-1-companies-company-id-pay-schedules-pay-schedule-id.api.mdx @@ -0,0 +1,77 @@ +--- +id: put-v-1-companies-company-id-pay-schedules-pay-schedule-id +title: "Update a pay schedule" +description: "Updates a pay schedule." +sidebar_label: "Update a pay schedule" +hide_title: true +hide_table_of_contents: true +api: eJztXM1yHDlyfhW49iApootsNkmR4mHDHP14edCIMZI83qAUJXRVdjdWVUAJQJHsUTBiDr77Bdav4LN99aPMC/gVHJkA6q9/2E2R69nx6CKpCz8fEon8QyK/RtfxtDJWxUJamGpuhZKxnZcQnVxEUIwhyyCLPg4iy6cGfzvnc/Y2nUFW5WDwgwZTKmnARCdfo9FwiH9lYFItShwsOoleXvOizIGFltEgSpW0IC225WWZi5Qm3v2LwQ5fI5POoOD4LwclUuO/QGqjQWSFzfGHNoxoEF3H4CYhFH5C/GdViSw6iSYj/vRZun8cw2jyLD6A/b14fJgexgdHhweT9OmQDw9H0SCaaPhSgUzn0Un07kqkwErQrFDSzqJBxGU6Uzop+TzJuEUUo+FoGA8P473D5jPILFETalWCFiprtRseR4Mo4/NkLzrZO3T/HEUn+3uDSPICR3wpp0ICaCGnOGRlVVKKXNnoZMJzA4Moxd0qEt/8lEm4cgDzOSv5nJlAlJubQW8f3s1wD0oNBqQlgjM1YbzTbScaRKVWJWgrHDEdBeudMNZjWxy7kuJLBUxkIK2YCNA4vJ1BZwImJPsnXAPOpIFnb2Q+j06srqCzu3HY3fg9ArjpbM4maOrmzM64ZVCUuZoDGKYkszNhuqi4RpgiY1fCzhqAIKsCuf7lJeg5uwL4HA38f5SdgQ4/LTLLa7cn7oRssMpXAW78XAO3EL8viclulvDdRssX2liG7b9l/RtBPyV8Mf72ogt5yVnYBHvOA3TPQG4xCNgNs8Pe4QpSLtkYqIXhBbgu3NAPDgH1wZ+3XcxLmcVvJrSmc4f8pj65YQkXEQlN0NEgklWe4153F3MqmW/CxmCvACTbY1xmbH+PCZmR2JPT1hIzPg9rJkbq713YJk+AiYA8YwL3NJ8zDTlccmnZxC887K5xu4qj/vLzX3u8+svP/06Qfvn5r55n8ZdwegSYHXZm2ZXIc6Q1rnPV+O5EtHtuSvQXfB7vBQqPHojCBlIlszuTuDVEYKp1hP7QlwkfokYk7bBXSjMDhYiXyW4zcCfUzW1mqsozJL4By6xi+3uuP3U1+F1b0LgOicvO+NwM2BW4PaM+S6BbRT/7o9Ylyd9ox0e4406RNRtei4Xl+93akwBwpiqdz9nVDOQSbWMIu29T7/KAGZ5zLSBb369u1eqJbTMoubYFSMtwAUxMFrqP561WA+JJIuXa+XieN1NtTMzvkYY3PdvgNkF7ylxztwCavANpwDKY8Cq3JvAKfm20amu0jYE+pxlrvG3zpoY7VioHLhfw/ogMd1pZRR3++z8YSD7OIRsgLq2QssgQupIMxy24FSnP8zlTEojDxzBRGthcVbrukgHPciEdrZfrg8qq+JwwIuLUikvYBO0M6GwsalphGDdGpYJb8OqWyxZr7rDThQ5Cuokd8wj7yLBKcmPEVEK2uWpz4NEwvI7X2PNfKqEhw49k+328GUQrrOtLnle/ATN7Y5t6qUUeeAIpf0N/BtHB8GDRD/peWfZKVTJjHyRjH6Szx79UYJATNBhV6RRYpsAwqSyDa2HsDnvNPwMzlXaGTqnVpcggY+/fn71A3rjkuch2Pkhkz4PRaHHa97LUKgVj8Liwl9IKO68RCMMKPmczXpYgG9k0VhmpBDosHiNDp40LaRhorbRhpkpnaG59EpJAJNxaLcaVhYQY49OAKU3DhREmXOSGZRWpHy6bnuhwkEfyaYe9BbfSi5dumufcwlRpAebj45m1pTnZ3c1UanbIcd1JVbEbHNXYn2v6vksw47Tu/oRNK5E5WVegKMjAIiAk3hYu6e3U/Z24feL23fi2kHELRtHTdTz9742s5VrzeTSIhIXCLAsOLIyafAbs4FHOV8xBrW7Vl29LSNGrNbiR/jBSd6bStNJmh72bl17lkNT/DPPGF/ZOSdjD3ZJrXgCabRpy0gReydKQO6TNA+otoOEI2BbZy43EUMqEoYL08FzGplpVpZBTQ+aJd6cq49CMK5FnwUhw7WdcorqcohNP3NuKGu2ws0kzkTDskyTBlrh9/OQMJ7dXTlV7lmecuZbsk2/K/CbNnXoEJ7LcRyJNgedtuoGRcx7W67mR8bGqbGvvYjYFCbrZNT90IIap9ISnjiBcMpAZ0kd7FJZn3C6NU3VhPA+Hu3bRsB+O6Rlk7k+yVwFCMjrTGKIhseEl0jgHZ/p7fTzoDEH4iFSf3N8JovpEext+QUX9qTadgzJBE0JJeDOJTi5uW0tR5VZgOI9GxHPUO3jh58XDFr5scaS7cxshp2Fm7MazTOAnnp+3ZnIm0JK5HUFu5xq0T4ND5ClKTmLDNqnSLpqZoXVM3NAi8O0zvF8IlU28NHfD0IhOek+0KtY4SHW7qkysWt+wI+eWNTC2E19abHLTmJavPffHaJjHbyTETvlFN6tbvfa845ri1twMft/z38Kek5OwSmH3Hbk8dwErMnDRd16jNigWgT6UMkagiWUVm/FLYLUcyuEScoN759VIUBS1WIlSodMq5/qxgxuT8RO/IYZ7ErVXuKSBY+juDcOYy88JT1NVSZtkkIOFpJKTSmaQoU+CPn/HiLno2BrRmLtrkFrFRwvGWtRSc9GrSmZCTl+DnamMzTj6f242Vs9Ge9ABdglaTOaJkMS6KSItlRH3iuzPaAbgrMzPipoTvZcxMJpfQLbDznPgBlg6g/SzM1LQYvVwGC+wI6r2VUvgOXq48ySM+KALQPL6CdkYI4r1OpYALIRBCZVoVWGkcQ0w3yKRVTGmiOYSiD0jvwP0B9efuf54JoLa9bg8JySpkhMxNTW02tbcimqLvdtgTi3DLbUUXWmM2aIytm1YLAcWVjvhxobTkuSiEHYNwiWNtybhK+6uEShwR2O0oqvcU7bG7AMLDV6MOYQbmBUo6yZLsS2n5UuKSltonRzyoFxAN4R5hWSTylYaHL5UFSWXeLizylg9TwzkkCJ3J5KL1CSpyiBpDLOViJvW29Pze+zLsO8SdtwMoZ/m4QEG1oQvFc9RizxlmZiKWuysgWsCALMBXCNS13Z7tG9FSljNItgDD9ZhtaKARE0mSalykc4pcrXZXhd3ImKxbH/7ICpJJwqy+rzwNNUVzxO9/sx0mm0huU9dP4b9aoqNcxTlaFnVeBgBpNuJpcBLIOWa+EDKOu3Y67oN2ufucGdA8UKE7MZwPq7HwHACpiaTENVZhbkOF2+y7XXj7ff+ZedebGMOGPOcyxSSqrxFXq7W1utQPeeSIqQ8+wttu5vNrN/2mcoFRoJJsjvAwawgQ/Q+raLnTpjUZgSZFMwjcBfZhGA1NKnsw8GqQ8xkSS8DNmClN9koGwHV/EqotXqs2exBWPHMtalvShi6XaYVwyB8So4V12iGh3b3Sb9whtHgZ/VUNSQHYWEx94jgHcUe8Q5JerdUyE4UGIPLPY3mzIrE3ZehEWY1T63SiaIbo5XY+i23P6b1AM7fa+wbf3dHB5a4HGWfw9sc2ID/Ie3Y3hqXqDljuSa7nU8saPL1N7ECFnttT7/z2q5+tGS8R80xbkITFKdk/qBcgrR+FSG0uCn+TvtvQt4Z6VbMoXXj0uCVQzLVyhgMd4TJJZAzsM7W8S22N3fApRoFiyL4BT1IZLXgjmBuwSaG4d1U3Z9w9NbJkTDleN/YQ+PPeIp6ML9HeXPuL8obAG6K+nhMtPoJZOJx3KukczfnNP2CS+4v3TC2cGaNC6c3GJ3ZkTHKqLCgV6BN/Cjr/fZvAo6JIIDCrQYcrlp6UCnUiGlGogh7W8lCZWIiSGwHyCGaeZ9gw41RubDZDoCjZIfkTlAa0Jdeipu5sVDUjYIM79sGJAVMMlG64Ou8/W77bxFA3ZGaUy0ZhSc9zoJfi6Iq+jhNpUuOa35AqC+vUwC0IjwG3Im94ZComiv1uSrX0fIBgQWDK/gAlHLw2DzZibp3X829zkUv6F67D1EvVh7mj/G/8d5oH1fYEWjjXKWfQdfKn4JuQk7UVszfG22pMUwc4Q3hThxQSKZ0hkk8itKK/GD95bu5F3GuX0+9OQZsVT7MonjWSly723J6MNevaQIZXqUmll8/5LLQLiQD3M/HLL9mNN/d1rgIewNWdDFhlyRy78vssGGQWCEK/Q182QG9fJGmMhiL2DLEvsmiBCa1+MHbSvDWJTSQHGRTjWlVSi5sTR2zW2eaL3S/S6iuHoSFQVg9eeNDRKsAN1r5W9F2rst69AuzeWlMIXSezhI702BmKs8S8Monat3f9RHQsqDGuj2tAl2QBShsc8lFzv1lHlr8+SUwis2fPv8TexfAsaAZW/dHShkKRqCS/FFoYGdywF6rS2DvFCbXafaC03VkW2FegjbbHtPQt3ZfwiC9uyOKi3FroShdprnyJh3jTT5HhcyJJoeqbKwmMX33AwY3U0wlt0pjaI+LfLOwHhf5XUJ6XORtR7cPIPjdITo24yapv95/NMXd5tYXHri59WyM0oM8oJoNNBS443R1HoIHTRef54t5Akh0yuZUMhjVhbiGLMmEGVfaAF0mNffWKxbWbr3F6WvFFsK91VLrZ83ZWzVEF4OyyQTzSjvUfdECTaeOmjgqPPDysmE24aPRKObZ8Dg+AH4U8+FTHh/tHT09Pk73x3tHz9YsOoxW0G33XWx/d8Hn+tf600mNE/ZC4F04e+EunwfsOV5K70R9qgQUmB9R3ckDcShc/yD6nEXtn1O0UT7y1ra74n+0E2RYs7nrgjUU+9uEK1bkHF9x0+eRaCKkMLPERzlRu2IigTO9HiAm7QnkfHyr8GRb1kzeiwnmylkxCQ19mxVmrAawyd72u/gamUfINK8ylOhuIJQtGoxZ4JnUpSh92xw0SH9kl6WzverFbu4FAYnLK63klHnvuz/HT6K8A5s7kQwSfe0QxftJlO7S9THsTHfY3mj/4PDJkiM2UxLunA9xjr1DNkQ45HvDzkUpZhzkIl0XaVh6eLLKZYDDqqvH1tHxL75MK723CVa5K5yeA79JIHsprPV5BO/azwOanAzafbcvmJvtLOVwxnN11UpvoFyudckNjW9/52gCThmy+foM0Y4R3M8E9SK9JnM2rLld5/uGm6tDmsUb2kFK4UEzazQdfqc+d/JAMCcYMkaf2CPf51HzkkAqfFdTCGtDKxO0ypgbkT6wd84pzS/I72BtkpGxnQsrATLT0kPeDVxifwS6Xfnk8BWro89bE/xHTAsPcmZK16L+0SVeYoVEjWGtqBbQPWCMniyJ1UHyXszZIcAYPqPM9NQyU5Wl0pZlZBzl8/4NvxdHYQ3uBvTe49C95IcWZDdh1rvNWpcuhu+pk7slvLyit9iyl/ayIK0y0g+TZCw0PVzbcpYX/oE7da9dY69B3dt/MgBJ5mx2TVvngt7FiPfG+9GIw8HTvaM44xzf8GVH8fEhDOO9Y8gOsyHA8f7hGpFGt2F3cErznLNXwv40xVAcPbimcgQTdNcYHlji4VnvNgxfNyvnItZXzZ4ISxyde6bUKDsaT56O0njMx5P4gO+N4uPRs1G8fzCEUfYs5ePR8RpK3U0KnRku+Ix9BzoXsiaTf9+MJLryr1c2o1CwqUEaZ0/XcY/1eTurc7XWprB6a7TN6e2ky6VIaudSrs0P7TS7s7eGvXseI8Mr2AH7EeAzhpqkndHTuz8DX4Y6BE1q2XvPrlKYaJ20Vy2FetNJ4O+8VoyXJrt3H/t+FwyF+qnv363FcDOIfmjpjdsW9BtRIDeD6Ptag9y25t9Vye+q5BtUSXj9XkuvM1xbWdn4ci+us7viOtOanhQndU2Rzv8ScgF7L6gosG76Jas+yA/SpKqEE/apM+DJlRYWPuH3P7Jf/vW//uc//4116h3Q82xMBugUjHBZpZB9kH/EjmcTitzXyX5pkF0C8xzQ9Re6VaEIIQ5cBSX3znLZ4IsFQPzzXwnX7fuRunyRx4LPty9cgageFT4+XvFQ2yVwxhx/jUPrJ807bbyrxnCQr+NRxw0cl/maCM2W4asqSdKdRFZzTeFe4C1UbvOvyZYWI6MSBv7NnZ+BZKSfdJEdHmTmbtW0Zvp/iWkT49Pzs/if68sfgjADnpFGa0D4YhDdqV4gIQusL+KqxuBGoKLM2On5WbgAWigHQi+rsQFyDD2rlmiJiCbXdeDatOoUPDLsohCS8kdaY2/5qJ+XIvY9hZz+wQ8Yt35+gjDwhTjyyiqSN3XTRsPRYTx8ipU7qJQPFZRxlTrC7zc3vugIGPudyij+1N/bO9ZmWFJ4oPtCtHUxeHtVsrTSGk3EsG2efdzQrcoKDQFdSYQt96BFfzd0nPM5aHdiW4cVRfFMXdGFo4FWwaidv+Nief+31e4gVLZpV5z5tVazWwQ7PP69SN1dSpa16879/6gu54rC1fP/+mvKreLlOxc964gD7LvzqytIdnPTLawRlNUm9bjuUGFrL94bblJhq2m3vMJWt5hWBoXq19CqtW709PjZ/gHfh2cHh4cTfjQ6GA1H+0cwHh4+G472R0e9glvtClvXsSmBfwZu5jGVsXEGY1PKrNsE4cTqErQWGeLyD9OQkhakoasetHedP7WyKPIgkLhdHBltxtCvD6ru0AW3vEsXZNPVg0VDyedEkFdF1rqdRSfR7uXebu1f7X5trPWb3Y5DtPu1Z1PfoBWHSdze3K90juatt1d4KZy5EuM2os2ycAheQKF6pHbjxS4TBD/jYlcMvHTMc01ZH6vGLPEz0sJAWmm6sbz4GiJKpylGt04rJMvFx3YrJH7hTsyStvVpR4jBtKXTD1yTwOlX9KEhYio+ged7hjeOIbNyEL2ldPhvmcGNsGKCm0GExu8PjdnclgL1+aqlYFsedMyz+y22N6wlwbAvCGooCwcafSqX1h2ilM55Pj0/6wiLls8wiNCvMm8mb0FfihRarNWY11TqaZca7mZIRbT8Y/o/5uAZ33VBrEOeqoKUGeF4ZNhLf9RZeA2DHlam0qoIhbT/wReQ4y7VwK/5RZiV/YBFvvx9skvbw7Phv/5jcxRwY0tlbMFla5z3IaGwJ0g7wL82XtLvgZK/QaDEn2YL13a3zLmgY09i7qsXyxfRJWUcBcEcDaKTTiClswf4tR/x+IjvbY3Fob5+xcDBe53f3ODPXyrAON/FR9QSmp4IkRjMBIX2VwQk2jzy+AdvWzxhq2IxKxYZqvtQi6CjIl9qqB0qQsF/L4B6fH8HVH3KurfMLoyzHd1+4zGdpbR1NFweEKtJ3dg0zx2x4ncdk2kxdNP0QEVZ2rVt28bP+ft30SAa+2hRocik0/wKI3L8yu17SODBcBL+9jXKuZxWLvTthsQ//wtE53Ww +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"; + + + + + + + + + + +Updates a pay schedule. + +scope: `pay_schedules:write` + +> ℹ️ Pay Schedules may be automatically adjusted +> +> If an onboarded company misses their first pay date, Gusto will automatically adjust the pay schedule to the next available pay date. +> +> See [Create a pay schedule](/embedded-payroll/docs/create-a-pay-schedule) for more information. + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/put-v-1-companies-company-id-payrolls-payroll-id-calculate.ParamsDetails.json b/docs/api/put-v-1-companies-company-id-payrolls-payroll-id-calculate.ParamsDetails.json new file mode 100644 index 000000000..7db1e6b2f --- /dev/null +++ b/docs/api/put-v-1-companies-company-id-payrolls-payroll-id-calculate.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":"payroll_id","in":"path","description":"The UUID of the payroll","required":true,"schema":{"type":"string"}}]} \ No newline at end of file diff --git a/docs/api/put-v-1-companies-company-id-payrolls-payroll-id-calculate.RequestSchema.json b/docs/api/put-v-1-companies-company-id-payrolls-payroll-id-calculate.RequestSchema.json new file mode 100644 index 000000000..c96bcede2 --- /dev/null +++ b/docs/api/put-v-1-companies-company-id-payrolls-payroll-id-calculate.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/api/put-v-1-companies-company-id-payrolls-payroll-id-calculate.StatusCodes.json b/docs/api/put-v-1-companies-company-id-payrolls-payroll-id-calculate.StatusCodes.json new file mode 100644 index 000000000..4c0b2e6b3 --- /dev/null +++ b/docs/api/put-v-1-companies-company-id-payrolls-payroll-id-calculate.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"202":{"description":"Accepted"},"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/put-v-1-companies-company-id-payrolls-payroll-id-calculate.api.mdx b/docs/api/put-v-1-companies-company-id-payrolls-payroll-id-calculate.api.mdx new file mode 100644 index 000000000..7216fe3b4 --- /dev/null +++ b/docs/api/put-v-1-companies-company-id-payrolls-payroll-id-calculate.api.mdx @@ -0,0 +1,75 @@ +--- +id: put-v-1-companies-company-id-payrolls-payroll-id-calculate +title: "Calculate a payroll" +description: "Performs calculations for taxes, benefits, and deductions for an unprocessed payroll. The calculated payroll details provide a preview of the actual values that will be used when the payroll is run." +sidebar_label: "Calculate a payroll" +hide_title: true +hide_table_of_contents: true +api: eJztXOtv3DiS/1d42g9JFq223XEeY2CBy8XJjj9kxpg4l1t4ApktVndzLJEKSbXdMfy/H6pISmr1I27Hxh7mJkBgW+Ljx2K9WdRNYiGvjXSL5Oj8Jnmry4qrxZs8B2vf1G6WHJ1/uf0ySATY3MjKSa2So+QUzESb0rKcF3ldcHxs2UQb5vg12AEbg4KJdHbAuBJMgKjztg1XrFaV0TgHCFbxhdFFMWRnM2gGbJ8zAY7LwrLK6LkUwDirDMwlXDE9YW4GjOeu5gWb86IGy9yMO3Yli4KNgdU4wdUMFDWMI0rLTK2Gv6vf1dlMLq0C33G7UPnMaKVrS/g5szVRZFIXzMDXGqxjBmyllbDsSroZ42y0P2I/n52dMuu4q+2QnWlGKHHmuIaAeHWVA4RK7/757oztzQ/2ctoKCXbvxv+6yKS43Qvt7d5N+A2fMlCi0lI5D+bvUuVFLeAffjeazWj34e+s4oaXlmhwEkD5WZAC40LnlyDYxOgSSaWkmrb7UQNzmklrkdyFvAQmFXYuwAGz4OpqwEppLXaSChnFk1Ybpt0MDM1USK5yCKMMCICnqIVm9w5HI/YpcgofF8DeKSfdIpI85w6m2shvYXy/Dg/e4D4yz7ZjEEx6FgBjtGlm8uu3ua7giF1E0h6ZWl0kg+Q6ndbW6VQqB1NDc6RuUUFydJ5AOQYhQCRfBonjU4vPTkN/fBb7GnvFp8mRMzUMkmba5OgmGe2P8MeyYKHgVQ5EcjtIDvcPVxv8oh17r2slkkGSa+VAOWzEq6qQOUHc+8Niy5vE5jMo+ZYh2O+KMRQBiEwNAkmja5MDExosU9oxuJbWDdkHfgnM1sZzaRBGwU6O9z59OjlGrpnzQophMkg8kRI9/gNyl+C6v9bSgCDC4QYQiSqjKzBOenKE50c3sTc3hi+SQSIdlN3nm0fNLgE7BK5YbJiDWrXDWWekmiZ9DfexglxOJFjUHmHNnnd0ntcGxXtRyZwXxYI51CGXsGBSgHK+F+kl54wc1w72SNjAAXKeF3un2yGHuNsN6h2g4QjYFjnfjxR0qB8qbpINyKdG15VUU6/Ucq4aDek0G9eyECxHpi1D+xlXovBCzBa6NqwjCIS5RLGcwvchn0YgUQ/ysa5dh6gpm4IC05IzDB1R2tpMeO6RcoXqDoEj5fAfihtcc9RAtM9Ku2xCQtJhrPOl/U8Cx3f55ajTsbO4ZIOAXHEvH9RhmNx+QSBOugK8kKUkZOk7nDT91XOtR3s4WiP66xRdY6FKvmAzXlWgWms21mKBO09bE60S6gQuVdhyi4ZrhorwQioSz6xhyozs5cUA1bJrV8gmtEFByXPV9kRJor2/GLKP4EXi/J2f5m3QxGC/PJ05V9mjvT2hczskLTjMdbkXNWYa1Cy93yOYad50f8amNRp59BNKbRrLOfxd3V/jrSet131/ETcS9y+t/efX2uxk0k4kLbtQpNQyv48X3g/ze+W9sMDyjDPfkl2EpixsUnDGwDtm/uX/GeOAKBwX3PF1rLgM420UbgMFzLlyDPuRp+sZZBGdVK/+pWIk0+h5ktoIGmlcwJC914YFizRYGoLwEaku/M8MUV3Q3sYndS3FReMER08LHSut4NcJmbLtaynrwsmqAD8XylFP8OLjVWGLb3YQ6eW50e2PM2M3LoTEV7w47czkHeI1c3uCfJ9rfuElRI8/UJQiv5Ztcm2aGM1p4oYOgb8/wyclv9bQqgfjA9xmPhrRa2+Mk9oBz9sRVV0UyZemXV1lTm9vuKTn1jXA8BK2Nel4IR8C96efpZulvypIvfFLbje3+hB4xzfFrbkd/LXnf4Y9x5E2GuxlOnxG5aNVsfDRH5NbzcaQnTh8XGlrJbpYTrMZnwNr9FABc/Dpj2BGoqFo1EqSS4M5EfPUw13ym58l3RWuaZCsiQLGXF1mPM91rVwmALMTWa0mtRIgsoovSlDObokQxtzCcniw4qwthQnvayWkmn4AN9OCzbhlcTbWzEZ7sARsDkZOFhlmUIyBHJFW2soHRfYvdANwVhZmRcuJocsYGM0vQQzZaQHcAstnkF96JwU91gCH8RI72uHmJfDCABeLLI74qAtA8oYJ2RhAtetYAzAkozKja4disyUq9C0yVZdjMOsh9pz8JaC/+f7M96dEYzC7AVfghCzXaiKntoHW+Jo7UW21dxfMG8dwSx3TCljrzJa1dV3HYj2wuNoJty5KS1bIUrotCNc03pmE7xFxGIPRGMzOdF0IxMwDZRvMWQVGatHiBSUyEbTlBpRNk7XY1tPyHaaxuYOO5FAE5WZcsees1MrNLPqEk9rVBjy+Jm+rRG2dWWQWCqAEbKa4zG2WawFZ65htRNy23p2ev2Bfhn3XsOPdEIZpHh9gZE34igl9p9lLJuRUNmpnC1wbAdg7wLUy9213R/tR5oTVroI9DGA9VidLyPRkklW6kPkiU7y8416X9yJiuW5/+yBqRRIFopEXnuem5kVmtsvMUrMdNPcb349hv4Zi4wJVOXpWDR5GACXYDcArIOOahUTKNuvY67oL2rdeuAXw3Mk5QvZj+Bg3YGA4AdOTSczqbMIMZVXoBYC9y7Y3jXff+3exK+MG7s4BY17gEUxWV9/Rl5ut9TZUb7mi9CgXf9C2+9ns9m2f6UIK1Or43wOObgU5og/pFYWzzsaNIJeCBQRogcLmb4aG6eJHg9Wcv5AnvQ7YgFXBZTOAvKoVbITamMeGzR6FFU98GxaHYBh22U4Og/BpNdbcoBse2z0k/aIM03FkM1UDyUNYWcwDIjij3CMeJKsQlobDx5gFxuRyz6J5tyIDhfkjdMKc4bnTJsMgbAu2fsvdxbQZwMd7rX/jsQgSWOJy1H3NqXQP/2P6sb01rjFz1nFDfjufODAU69/FC1jttTv9Thu/+sma8Z60YtymJihPyYKgzEG5sIqYWrwr/qX2P4R8aaTvYo6t25CG6hCmRluL6Y44uQIKBrb5OqHF7u4OUIzQeBQxLuhBIq8Fd2Sma3MXx/B+pu5nHL0jOQqm3Ml5n0BBxnO0g8UD6ptQd9AB4KdoxGNi9DdQWcDxoJoOsz5h+pWQvCnxwfyQ9en0FqN3OwSekPHCgdmANgujbI/bfwg4FrwAVbg0NUnhqKUHlVKN0pIDGMDWqtRCTiSp7Qg5ZjMfEmw8MapWNtsD8JRcIrlXlBbMPGhxu7AOyqZR1OF934C0gM184c4d/ATf/kcU0PJIrVQrRunJgLPk17Ksyz5OW5uK45ofEeq76xwAvYiAAXfiYH+fqFpofVlX22j5iMCiwxVjAIbFOE/ts2GyfPbVnuuc95LuTfiQ9HLlcf4U/0wPRs+pxKGr0EKlVWP8KemGFV87MX9vtLXOMHFEcISX8oASy8oEGLRPplZNMWFv+X7uVZzb19NsDhW1Pc6iuGhdU3u/5fRgbl/TBAQepWaOXz/mspp6wDAfFob62sD7rXEV9h1Y0eeEfZHIgy9ziQ2jxopZ6B/gyyXQ6xdpa4u5iB1T7HdZlMSiljB41wh+dwktJA/Z1mNalVYrW9Pk7La55ivd75OqawZpa0KbydsYItkEuLXKP4p26bisR784W9DGlELn+SxzMwN2pguRQTA+Sef8ro+AlgUN1t1pFemCLEBpmzmXBQ+HeejxF3NglJt/8/ZndhbBsWgZO+dHWltKRqCR/CwNsBM1YB/0HLAk+j0e5RxzOo7sGsw5GLurmMa+TfgSB+mdHVFejDsHZUVBrNPBpWO8reeoqV6ZK6Zrl+pJSu/DgDHMlFPFnTaY2uOyuFtaj8viPik9LotuoNsHEOPumB2bcZs1bx8+m+JPc5sDD9zcZjZG5UEBUMMGBkrccTo6j8mDtssYJjgY1gkg0ZnCan4VnepSXoPIhLTj2ligw6T23HrDwrqtd5C+Tm4hnlut9X62yN6mIe5QWXrcAd2rJR088vLEvpjw0WiUcrH/Oj0E/irl+y95+urg1cvXr/Pn44NXP21ZdBytpNPu+/j+/oDP92/sp9caR+xY4lk4O/aHzwP2Fg+lh0mfKhGFv3JxfxS+f1R93qNG175aRvkkeNv+iP/JMOqwf1e98SCZSCXtLAtZTrSu7VWMR8hJBwL5GN9plGzH2sl7OcFCey8mo6G/54VZZwBcdrD7Ln5A5glXXvCuDg2EusWAtSs8k/sSpR+bgwbpj+yrdHY3vdgNSRuyxFdGqykL0Xd/jm+yugebe5UMCmPtmMX7Jit/6PoUhtMhOxg9P3zxbI2IzbSCe9dDnGLvWA0Rhfxgf+mgFCsOCplvyzSsFR5R+wpw2HT02BEdPL5zM7Cd8t42WeWPcHoB/F0S2Wthba8jOOvenWlrMmj3/b5gbbb3lKOMF/qqU95AtVzbihva2P7e2QScMlbz9RmimyN4mAmaRQZL5n1Y+32bHxre3RzSLMHRjlqKLjJusXT4nvrcKwLBmmAQ/m4iexL6PGlvEijNKjCldC62stGqjLmV+SNH55zK/KL+jt4mORm7hbAKQNiOHQph4Br/I9LtKhSHb1gdvd6Z4J+xLDzqmSkdi5rgspq2UGO/MVQr6B4xR0+exOYkeS/n7BFgDp9RZXrumK2rShvHBDlHxaJ/wh/UUVyDPwF98Dx0r/ihA9lPKHqnWdvKxaSxLrtfwct77MtUr+xlRVsJsg+TbCyNm+0+yzGdq08YdW9C42BBqWzCO4Ckc+52TNvUgt7HiQ/O+6sRh8OXB69SwflP6SGIV+nrF7CfHrwG8ULsA7x+/mKLSqPTsHsEpUXB2Xvpvk0xFSeo4pejMsdwjaHAEg/PeqdhFtBHpBCxOWoORFgT6DwwpUbi1XjycpSnYz6epIf8YJS+Hv00Sp8f7sNI/JTz8ej1FkrdTwudWC75jP0XmEKqhkxIl2JBJLoKt1fuRqHoU4Oy3p9u8h7b63Y212ptLWEN3miX07tFl2uRNMGl2lofutTs3tEa9u5FjAyPYAfsM8AlppqUm9HVu38BX4c6Jk0a3fvAoVKcaJu21x2Dunx1dOm2Yrqh2B07NABOkNOr2qXzg7Qp0EjbrwbEW4E2/oLPmm8QJJhgDo6oXz9p5KPkf9J/0h32N6cn6X83mTWJ9wNmwAU5GO2Vy/7FClB1iVcVRvujF+n+y/TgRULfkZjwunAome3z2/71g2PEUkoVbsuhok1xIwR7c3oSk3KMW6tzSSez5ODTbTdsgBf86KqbQu6Qbf3RwLfp3B19Ytl5KRWd6XXG3vGiJa9kGnpKNf1bGDDtPH6GMPDWno+wAoXbLYqErTiZqWVyYNBAl+z10pcali51+cs1m7bjtjNpywM7TRqrB3aZlD6EYCvgl8DtIkUAqZ6DMVLQ8jssCNcOlCV3HlnQC9/GLzDQ5Zq69yUGXONyP//1haYxwu022oSs6dBBiGsJyS6SNZIa/D5KsuvHOva6y6bT+SB2tSlQtALj8Up6vksFlMR8K1t0DKVOlknsx0t9ig9f43o3DLx2zFND6bxNY1b4GmkRPxvzETfflxOu+XhMwxI4eVQX+PcYuCEF0r+ESUOkdF+I8drNMEiMh2GD5CNVMPzIDH6EDRNQ/O+Pr6M2JhWIqgG5Ip5RdJXXIEFdZX+dfAQzlzl0KN2qDbrSukcN9wROjbo7pb/xrMGGrivXsKDIdUlHMITjiWXvAruzWPWDWkvovEbTSMv4j3BRnvuUSpD64zgr+w3CB3tQ6uh4AlklvP3PljOQGpW2ruSqM87byLz4HZ5GJSzBvmnv6f/1paC/vhT0/+BLQUEFObh2e1XBJekq0ro3wUqcJ3PKbMetSgbJ0ZL1j0PiiyUL3VqLL1jZbR0OdnOD7tAnU9ze4uOvNaBrev4FLZehYjSyKEISMURyNOGFhS1y+vS3YNSfsc3extplxnuk1CLazSRcau16OGiJHgRQq3buAahDW18r7z3Z3aj1p/ZPN5DVk299TNBQufWu/JesOu9WPtiy5FGdfjrDe+PLJr0x4eGXzocPlnf35sa3ONOXoG5vm812+DeFV7f/Cyerh0I= +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"; + + + + + + + + + + +Performs calculations for taxes, benefits, and deductions for an unprocessed payroll. The calculated payroll details provide a preview of the actual values that will be used when the payroll is run. + +This calculation is asynchronous and a successful request responds with a 202 HTTP status. To view the details of the calculated payroll, use the GET /v1/companies/\{company_id\}/payrolls/\{payroll_id\} endpoint with *include=taxes,benefits,deductions* params. + +If the company is blocked from running payroll due to issues like incomplete setup, missing information or other compliance issues, the response will be 422 Unprocessable Entity with a categorization of the blockers as described in the error responses. + +scope: `payrolls:run` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/put-v-1-companies-company-id-payrolls-payroll-id-prepare.ParamsDetails.json b/docs/api/put-v-1-companies-company-id-payrolls-payroll-id-prepare.ParamsDetails.json new file mode 100644 index 000000000..40b87425f --- /dev/null +++ b/docs/api/put-v-1-companies-company-id-payrolls-payroll-id-prepare.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":"payroll_id","in":"path","description":"The UUID of the payroll","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"}},{"name":"sort_by","in":"query","required":false,"schema":{"type":"string","enum":["first_name","last_name"]},"description":"Sort employee compensations by name"}]} \ No newline at end of file diff --git a/docs/api/put-v-1-companies-company-id-payrolls-payroll-id-prepare.RequestSchema.json b/docs/api/put-v-1-companies-company-id-payrolls-payroll-id-prepare.RequestSchema.json new file mode 100644 index 000000000..bfa3a8cec --- /dev/null +++ b/docs/api/put-v-1-companies-company-id-payrolls-payroll-id-prepare.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"employee_uuids":{"type":["array","null"],"description":"An array of employee UUIDs. If passed, only those employees payroll items will be prepared.","items":{"type":"string"}}}}}}}} \ No newline at end of file diff --git a/docs/api/put-v-1-companies-company-id-payrolls-payroll-id-prepare.StatusCodes.json b/docs/api/put-v-1-companies-company-id-payrolls-payroll-id-prepare.StatusCodes.json new file mode 100644 index 000000000..3b5722761 --- /dev/null +++ b/docs/api/put-v-1-companies-company-id-payrolls-payroll-id-prepare.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"description":"The response from preparing a payroll for update. Contains refreshed employee compensations, updated payroll dates, and version information needed for subsequent payroll updates.","x-examples":{"success_status":{"uuid":"4428f108-e46e-4ab6-ba20-03cea031cfc0","employee_compensations":[],"payroll_uuid":"4428f108-e46e-4ab6-ba20-03cea031cfc0","company_uuid":"42b5333b-ee39-493a-bf7e-f41f2bd67848","payroll_status_meta":{"cancellable":false,"expected_check_date":"2025-06-17","initial_check_date":"2025-06-17","expected_debit_time":"2025-06-11T23:00:00Z","payroll_late":false,"initial_debit_cutoff_time":"2025-06-11T23:00:00Z"},"off_cycle":true,"auto_pilot":false,"off_cycle_reason":"Bonus","withholding_pay_period":"Twice per month","skip_regular_deductions":true,"fixed_withholding_rate":true,"final_termination_payroll":false,"processed":false,"processed_date":null,"calculated_at":null,"pay_period":{"start_date":"2025-06-10","end_date":"2025-06-16","pay_schedule_uuid":null},"check_date":"2025-06-17","external":false,"payroll_deadline":"2025-06-11T23:00:00Z","fixed_compensation_types":[{"name":"Bonus"},{"name":"Commission"},{"name":"Paycheck Tips"},{"name":"Cash Tips"},{"name":"Correction Payment"},{"name":"Reimbursement"}],"created_at":"2025-06-11T19:40:52Z","partner_owned_disbursement":null}},"type":"object","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"},"employee_compensations":{"type":"array","uniqueItems":false,"items":{"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"}},"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"},"fixed_compensation_types":{"type":"array","items":{"type":"object","readOnly":true,"properties":{"name":{"description":"The name of an available type of fixed compensation.","type":"string","readOnly":true}}},"title":"Payroll-Fixed-Compensation-Types-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-Prepared"}}}},"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/put-v-1-companies-company-id-payrolls-payroll-id-prepare.api.mdx b/docs/api/put-v-1-companies-company-id-payrolls-payroll-id-prepare.api.mdx new file mode 100644 index 000000000..7621266c9 --- /dev/null +++ b/docs/api/put-v-1-companies-company-id-payrolls-payroll-id-prepare.api.mdx @@ -0,0 +1,76 @@ +--- +id: put-v-1-companies-company-id-payrolls-payroll-id-prepare +title: "Prepare a payroll for update" +description: "This endpoint will build the payroll and get it ready for making updates. This includes adding/removing eligible employees from the Payroll and updating the check_date, payroll_deadline, and payroll_status_meta dates & times." +sidebar_label: "Prepare a payroll for update" +hide_title: true +hide_table_of_contents: true +api: eJztPWtzHDluf4XpVOL13bRelh+rD0m8fmRVdV4rftzm4nWNON2cGa56yN4mW/KsSv89BYBksx8zmhlLd5eLr+pqrR4SBEEQBEAAvE6MyOpK2mVy8uk6eaEXJVfL51kmjHle23ly8unzzedR8iWd1cbqVCorZhW3UqvULkuRnHxKxGIi8lzkySjhZRk3McnnUWL5zECzM76sdFHgNw+uMld8lpzYqhajpBKm1MoIk5xcJ0cHB/CfXJiskiUAS06S9zUiNq2LZJRkWlmhLLTiZVnIDIfc/9VA0+vEZHOx4H0YH+aC+ZHYtNILVlai5JVUM8ZZSUiyqa5YXebcij32QivLpTKsEtNKmLnImViUhV4KwTK9KIUyNNuR65IHMPCXGTGucnYpKiO1YlJNdbXADkwJkYscBzP1xIjfaqFs6EzAzF4C9BJf+KIsiDaGyDA2ltsav9S1zJOT5Pj46Nn08OBZKo6fiPSYT56kE350kB48ygQ/eHSYTbODZJR47Mct7GGpR4kbfLwdxIz4JvQ6mjx+9OjRJBXi0ffp8fePeDqZPhXp9PhwejTJnzx9dvwsacaieYwXwuJ6ZVxloij4pBDJyZQXRowS8aUUmRX5OJuL7GIMhElOkqODo8fpwZP08GkySqSSVvJiTYsAJBcTacdWLlpNDj8cPTo5ODg5OPifCLkCATk0/BgEIKutnk7XwrkZJdAkW2YwGeJzXls9LmWhbYAb2owrwZGBkx+0qk0ySq6knc91kUs1G5d8OS5FJTUQ+cOVzAQrRcUWWtl5MkrMhSzHlZjVBa/GucjrzC0sjTuVX0Q+juFVODf/q+LF2IpqIRUyxNhRICBZVhrYTuT9L47cqi6KUZLxIquBbPmYW/8xRv06MZZXtrdGyJsq731/Qssxhi2d14VwbAaAb0bJuvW2olI8moFb01zwvJBqzeoTreL9MQZxZ1BKKo4LTit0MwofXujFQhrY5fHXM75EFNkHWbabczPvf9RVJXDd2BlfLkDARb++E3IxqSsj6IfPoySrRKB0PJnD70+OD04eHxErV1aJaqyvFCyVNA0IIuLNKCFhnujJryKzCS5tKSorSeL0CXftexgLohNIhmItOUlgKVLcFKOO7H3O4LOxfFEyO+eWScPsXDAPFiUhfPAi0Go2EayqQWwyXeWiwiZegBnXoOQyZ1oh9D3GTqcBwJwbprRlEyEUwpksWyOOQOaj/IdT4bdaGMuuZBC+bKLtHDvQEuI3kOYBY6vhWChEZrGZ0VoBjAbDjKuAIvRszXeyZFdzmc1bk17Uxg5O2wCMCBGa/EJYOCIqwfO3qlj6/WylLRz7AdT0pRsz/QDr1tk3/dXsH5o4pFYO4WaCSC4/w84CboLYC8AjfQlM41GLJE3AbKJ1IbjqofbzXNi5qJiucKFjQsLi48KboDcUSxaA77GfNFARGDF89J1x4Yhz/Km+x57nuYRheVEsR5G2IInJZjWvuLJC5J4vA9RfaU0zXhvRwjGwAiBbcsLrT0DqgAjwJoCvVaYXC61QIwF1QgAWtRGVYQu+ZNlca0McWaswwERMdTU85iarc+an0F+cDu98apgHhAqoeSuYiNsBrr+C+UdLUwNdp60m0qgH8VItN+P8ZgotJuscU2umsaVk04R1wY1ll7yQjTroh5SwiNEMK+Hmxl2HuOEmWyhMJX1uwwTplNxka3/8ePrSo73FzvX//VjLiD1aCuRfe/S2Irrt6K73TlKMuraxiVS/W+XYqcrBhAGB6iRam/UZV0xPpynC8983QOztdJq+gD59rIKyeZ1wtXw7ReWmSzGh6gXsiuf5XGfJKPlBKDGVllUCRBAHFLyq2uguySh5KQ0oQ5GxlIySH2XV/vAznwHZo34f+BdWiUyrTBaSu4/vmsFeSsMnspB2yaQydQXGAssl4DupPYyKK4OSmiw8XeAeZF6BTD6DTuVmirv8ZlBaNfQmSu0xoDSTKitqb7j11sSsY5dmNd4hxLAosVFwJ7wCABkC3IBZntdWp2fQOCDUKM93go4HtwXnvnJdAkprTJSvxxH+xAFaPgDO/HAR3349G/gpvpY4v2ZGQar5Oa8y/zYRbSUZEIHtmYW9hZpje+4TDvv0a/gbNlHbYHdi49WlqJbsSoiLZOT+0Eh+96lvxb6B/xbLZJT8V80rKyr893uxkFypGlSvZJQ89//83Cfqzw3JgJzpGZIsUHSlldxoAA0TDWsyPxQ6u2AOBmtgoIIPfikvi4w7SqQJZwm7M+Z5fyHL9B0hkb4MSETbZdje33yerxSsKbBNMLUQnChyUOKAi07fvX9g0HRC0Y7cpafs6OhfcGZTkYuKFzBdvXCQ9th7C83ib8GKgL8CcHAMiQeGmbosCzRYeRGYeI+9BUa6kkaM2JV4UBTM1AvsJ5SVlbBLf677jfvAsCs+E7ROnjAOATAfQ1fGF7pW1uOBs4Lp+CVHKHcpBr6IvMW371rm0NC+D5Z6F3jbco89LZvIDGyPavqIZmbkpRhF6hkjTPrTuomdN/c+1IA/aCtDpKN0NjLyVt0PvSV9XbQrZlY4N7ur1z2lGucwn+i6Zc/CRkBgyL7emUk+5p7HpuVEvfV0hHl1rS0wKSeCOUBixYoP+WU39iaAXuA96S03Qs/wA//4QlqYr9JXg6gM+X83wUQBxYvYr+JZgBujM+kd+msZf8izvMng0DIWUdUDw3iWofDxFEGYYjeitL3Yt/LBwHKyf2N9yq5dgAHn+G2kOOu4vpqJcQueneDEAEUNSaYZv9QyZ0XkKtl4r9LxiXspfSMsb5TeFTcjAX9eVRz0j1rJ32pxasXCNJcD9Nd1wouibUyt8KqG0XazVoM6OsyRdCptsOgfgKq9fegBsO9AYSpF/tDdlvV9Ge44LQrnah12BbIXJEnaF21Xui5yuJATlvGiaPyKDxoMJjy7gBVHOg/OdiorY8fkJN/qGMCODDr2qMrekVJj2HlA6gRGPmcm0+UwImUlpqKqRD7eGaUA4s6RA4/ULhihJ+vu0JhV2hgwZmI0VL2YiGotGpEWhyCAh0ZM/FbzgtzwkW7G/sgyuF6xsoR/h/sE+hN8PGSF8ODRZYJXSqqZGTnGAz6Vi7JG0Yuq6h7DrXLJCzgtQWUsloxfconHLDJ83488SAIl7NcRQAnbmX6gKkubzUyqbfQhslV0xWYwZTMHxRpaBYrd3UTpyCBtevfZ0tlMUKIpOyqyP7Iqvhe7Q/SdBQ3a21xvq2LGE4iOk2CWE9A9dmrYHwDFP7DzH6WxupIZL87BT6FYJWwlxSXwYteDYvy5XCzR4a9ra2SOe/Q/IbhiBFtVsbK2TCqr6eNe5NF7KcHrxl6KUhsJpxPexKCXzmMBjrJkIRZ6i6m/gHEWzIovlu5WgmZXQWhIzrgB+S8qg9tOabrJiuUKGGN4RBhbT1YI/O797KandMdvrxg2BqohzHZERzjEGon3eqCVMwFx74zYBNyhPuxDK6fkdVn0dNryCzSXVYE1R8S4Q2iB7UqXBbVgM7wCBjy5Ygd7BweMbjNtXSm4SnkNfizFatVj+hEeuTyz8lIMjtMClEQqznrFpn3GrFW+o1MlHtptYV4YzYyoLsFmJx8dremIycWitrifZQ5G+1S6W1KkagsW+lc7ImgdUs74H0ArVmqCPXAzSn7Vkx2VuF/1JABtI93XZUGbneu6KpZ3zPkE9FbW/3Gomed9d/yOmL4ERlgI4v9c17BG/iMOtQ33D6J2H+w/ONA/Dv8j3TfECc9mzxfe8Rcgirzl1Iy3wd1sMjf3qQQ3Y//45lPb9943l7nkg23u7o3DFy/x4RwdWui/3iamK8oQVLSoCyvLQooqGjUoRyupFrrlPqAFXPjOt68bajCrwWXaVj9EhTRgV7q6WOHWmRaGR+GFt1Pj9Z/eP2dkUQ84XctKLni1RDrFuKyQcWA+ouNgrKfTrxZusMfRIEX5o6dt7IB5RCFnchJ8fx2+vuddf/bh7VdtdoKw5Ranja2dED778JZZfiEUy2uMgx044ejureRLXdtxDQpOPkYoY6nKen38xMDFam2N5Sr3+9HQCtUleOGb27BhSUDBvmG9muaRLk+M1Na5vpqT2uD6B+TmrLKNoMx1AWZtW162UFmllbRgbRem03wZHNFFr6BcVcDNeVe/7QegbO2W33LE9acGddzQ7KsgJh5x3Tz+rL8qEu7FHKC7ww7Ro9s2oKnjpDZWn2+GHJ+vHJ9irEo4+tIfuAlXTbfxrQti34xxYepABx/57paVQO+x94I835/c7yALZrXMxefv5taW5mR/P9eZ2cNMgb1ML/Z9okHqyIO/78tcLEpthcqWD5GQcYS9Vmyur+BMpMA7vwYgIRoK/ZkwwMuSrYiw4aRj/+oWmg45KjA4NWKJvznhYK37t+Y7ytTIIdU3ONrUCRetkyXLxZTXhW1dykZ+kUD+88sQE/34HFVDUIuqez/Vw7SG9eLbNbwunFUynpqPCe4Wejc03GgQuuQuwUPvTppI117pSfM+JnQqAE1FlUG8+eed4xIbiu6C0Q3+byBYZIVQJHkYeQBNKfBajKuZGLyGb2P/tqOpoDOvFTC80JcUJzwFXTznITAZ/c7KWMFz9EqB851n870eZ+pKzlAr2+bG863rFN93InJ+HMJarHDnknTbasQXTiI2Aw6CDrOh68MtZ4Oddp3NNiP62TQDrtAgfGTl7VxObdnVfNm1ans8svENJ/Bs+h54Nn1BPNuEyEYZIztlcUAUNdpSsPWQ2qT7GF1XmcBAbjfGutiXF9QkDlhenXTTO2RWCu/10TBemK8W3hA5GQ5gLyT7rlGYWZd0PVN2VaBPLGpw8qYbXI/BWpSOEivQYZZege7F+mxssJuWre55LhJBfvg+Sb1sDzfAOESQwWOXbQEJaXSNTw3oj+jXaK5TLguR4+kgqkqTGduJRcPvdKOgM9y6ubdXuVmqbGASQ+y3MR81OjaiNL4QS5ymFTNdLfvUb1rdugDvS5GBDY/BqC45A7vTzMCWWZZw/1IsSfW6EMvG8ifXALcUZSj2S17xhQCnWCXoEPTXKQByj3IdHNZboAYQ/AYgSAwVXAcKyHwpc2Ec5rNK1yXcn3oHXPC+gf+wlkXOMroZovZzrvKCzjq2BPEW5Q2jfzgMJA07h6QqkY+JOc5HkSFB10sZ5egyzqglO3dNmVukJTmNgYR2SSiQkboQxvDZJjEqfr65sFxCXk4I0KIZpWwmFEQ7+lVzoD0xTF1NeUYEgcgnlWPyjsPC8pxvEiIWZSMX4pIrPIQ4wHQMsmyLY6kYbmSJRwxoIUErId+4yywetUAgfkiqc/ovSmLSoP0X0OPOo9s9JA/KfK3EigCY9lycG5OiLnEfdTae/9zfbP6XLY6G9tggH/zI0K2JBDiLRho6RCKC3M41P8VhE0RRFGEN22D2A+Sj5+BqR26ICHz7CB/R3hpyDBIYhIhpRWMI4FnjkAnt6nJs11353oySlpwbaoCxu+uaRMfjG8f9GAKbvlUifUXLcrO61RvHO9QUlmbIcv+25v/31rytBXR2d8f5BsIHvSbiizQWQiTXHBt77BS9cqU2Bv39VrM5vxQsyKFCXIoCtSJ3jPiDIoiVJJMV6DnVd4RuinpJ+hYZ7mHLqzTQIBnUCs+CwpK+c1rXzfqs7c1D+JFCC63EEq2JrrvYpYiCsQ+af3Of5EaHK6W5v1ydLCmI5N+TIZsD26dvAdv0ZYRtY0v3502+LeetPz447qt9P2nLXuta5btX/Agg2C+KsV8U2VxIZ/Qiu4My14LSeJGV9tgbfoFntsuWcccbO325j24JCjCSeWQJrFYeh06wVRz+TSX9u1RJ/150Rdor7YIwStvxFDdJxFifWuufNPZcQ/moYzS5ZMUGuXK1FLDDHsjpaE//pG2Km6wn72BnHx31t+VHf9+BpjYJy18UbE9J+exzXpZCNR6Gic7RZYxL44s1ZF4dpmlDqv8cbk/PpaJzLTDlGMNFzkdM+8sagjDFBcpr4WgdesJOwrU/j3zuzgx9QTSUwmzpdEc00yx0f0iue5TJC4hxdxyz94vaXeINk5Zk3zfieuJ+k9r/+FL7myPhmyPhmyPhm1H5zZHw/3DN/+EdCW0rYMLVxdglj45zUQgrxrWa1ioX+djdY5s1FgKEkLbNg56y1jITXtcYwPcG01gwgtuPxsJouAYtxC5FJafLMWRUYdWXcU75J3eJ2V9ADYBRQy5tExCM40sIDD8rBATN0r00KimgsTp0XJyE2Vs9BV7A5dJy7CHe6wSAvG5ACpQP8xhAEKsQwhWirq2LYltlFVKLcQhIGUCxo+S3EH1H/X3MuGxKQTi8fPxEptVUzkxALeiaW1Gt3ztG5rllsKQWk24aZdYnFXvFYhgxP1uIHPC7ZVzIhbRrMBxovDUJXwPGPicMYTAzx6zYiQA1lFbG4+wKQTT4xjUXVmAZmgziNkzLV4oqC0Q7Z0Ep2FyxR1SsBSOtprWtK0H4+epbUuW1sdVybERBhZ3GisvMjDOdi3GjmK3EuGm9PT1/gr4M+g6w42YYumHuH0HPmiGl8QnL5UwGsbMGXeMRMBuga2RGbbfH9r3MEFfTR/bYIUu4+oD9cakLmS0x0XiztV7sRMTF0Pp2kagV7iiRh/3Cs6yqeRFq4azAqtVsC8n9nPpRKoan2KQAUU5Bvg4fhghiZNIg4qVQeRQFsu507HTdBtsXtLlzgUlQWEoBYZCN63BoEic8MitwDingmyx7aLz92vuYPZ+ftSEHTHgBFQjGVM5zp9N6HVYvuEL3KM+p2CeNZtYv+1wXMgepDv8nhL1agYroXWpFrkRhUCNQpWAOAwr5RAxWowbu4ntDK9y/oCY9hNiIlU5lw9gxOOZXohqOx8Bm98KKp9SmCe8Gs8tEPgzET6uJ5hWo4aH04R3Sz+9hUPhZGKqpsogo9CZzhxh8cBVM0dmDZqlULS8wOJc7JxqpFWOBQfdjrJnGM6urscZgrZW4dVtuv00DALL3Gv2GcKFsQeRykH2Eb7NhPf73qcd25jhwzGHpLACAyZBo62+iBfR7bU+/s6BXPxiA96DZxo1rAv2UrrKtuIRkHpqFdy1uin+r/Vdh3oJ0K86+dWPSYE0lqrhRl0HWRFU9Vuk6rsX26g7V+wgahbcLOiih1gIr4lPzbiPpbkfdj5iy1+wcJWYckqg72Lg9ThXE7lDe+GpRDQI0RNge00r/LlrVQe9M0nVy1lsmeVS++tQacqf3qojDDRkvrKhWYDuOwlfvCXGo+ClAuDWZEp2kaYcquhpdyS2HbK0WOpdTiWLbo+y9mXeJrL8xKnuLTQh0cj28Sw6yQqpL/6jK0lixCI28DO/qBigFzNiHvt+qJ1D7rxFAbUjNrnaJUQ7PBf8iF/Wii6epKyoUf4+ovvqS0ds0DgdYicODA6RqofVFXa6j5T0i5hUubwNgjtB35uFe0r77au51PnWc7sF8SDq+cj9+Cn+mh0ePMMQhFmgTqPsqqnD4o9MNsua2Yv4OtEFlGDnCKcItP2B4EKJd5r87fRq7j+f6+YTFMcLW5f1Miud59HjETtPpoLl+Tq4C7djyL/c5LdALUQH3FW+hTC2Ot9sc+2hvwIrkE6YgkTufZosNvcTyXuiv4MsW0sOTNLUBX8SWLvZNJoVFNB3w+BC8dQoNSoQyZrfg2z+9pQk+u3Wqea/7Lq66AIR5ICwM3tgQySqEm1P5a7FtXZd16OdHc9IYXeg8m4/tHB5X00U+Fu7wSaL7uy4GOC0RcN2eVp4u/vGWKOtLo8ZfXAqGvvnnL35kHzxyzJ+M0f0RPrsCdw56yn6G6tGnasTe6EvBPmiIPK3YS47XkfGBGWWRb602BfPFA+ncHaFfjFsrFiUasZDFTe8Z8Saeo8Y0L46F41I9TfF3B9CbmXKmuNUVuPa4LDZz63FZ7OLS47KIDd0uAt7u9t6xOTfj8Ovde1PoNjdceMDihtEYhgc5hAIbVALiq+nq3DsPmi6ugC3ECWD5UyWuAKhX9DDxMQ7x9ltn9cTi1lvsvsi34O+tBrWfNXtvFYgNIkvjuPBOLOnonqeXH+RTfnR0lPL84Fl6LPjTlB884enTw6dPnj3LHk0On36/ZtKdSpA76P5x0cdwfpLUOGHtWowjhqUY95IuVUI2OmV67oyFy/50oo80aqw20cbygdO26Yr/wZ6XYX+reGMsQyTNfOy8nHC6YmlWVL3uwSftCEQ2vtWwsy1rBu/4BAtNWswYQd+mhRlbCWHHh9uv4htgHl93jzMCBLKlgsTaLs9kFKL0dWMgkC5kitLZ/uil1x+M9xJfVVrNmLO+u2P8Lssd2JxEslBga3sv3u+ypEvX78TebI8dHj06fvxwYIvNtRI7x0OcQW8fDeE3+eFB66IUIg4Kma3zNAxunrymCHCx6uox2jqSni00UXhv46yiK5yOAb+JI3sQrfVxBB/i3JkmJgNXn9YFYrNJU/Z7vNBXUXgDxnKtC25obPudvQkwpI/m6zJE7CO4mwHCJN1JRjqsuf3Mdw03Pw5xFKdoeykFG82sOengd1d3YQcLpKSqhFSa84Hr86DJJFAacs1ccX9sZfypMuFGZvdsnXMM8/Py22ubVM9tKxMWnm420TnkzMAB/cPT7coFh6+YHf68NcHx/TQvZ1qVUOESywdqHISDqofdPfroUZNY7STv+Jybd0bowe3M4rM/Gp6IQeWoWHZv+J048nOgG9A790N3gh8ilGnAvHObtS5crHkTYPswseYxgJaZ1NWb8XyYjieywte0thzlpXu/CbsH09idoBg2QQogypzNrmlDLOguSrxT3p8ecXH85PBpmnP+fXos8qfps8fiID18JvLH+YEQzx49XiPSqDLm9kZpUXD2WtrfZ+CKwxpk9LIFloOBDYs8PO/chsFTFppMxHDVXPq3nHuGzh1T6ih/Opk+OcrSCZ9M02N+eJQ+O/r+KH10fCCO8u8zPjl6toZSu0mhU8Mln7MfRFVIFcjkCu3i4yAue2UzCn3uVskNfo/1cTurY7XWhrA6bTTm9DjochCTYFyqtfGhrWY7W2vQu2MxYi3uEftZiAtwNSk7x9S7vwg+hLV3mrTeVb5DUynUFl4j7XV0oLZTR1vZiumKYHfoEBA4BU4va5teHqYhQCMNwZIhK9D4f+A3yjZf8fyNykstw6NLmGUWp8gDE8+EZdIbg5hSyC9AiSDXmi9A6mwm43w9++gXwvcbfJXh5vYDH9TBEr7RMKFQtfXPjo/pjbTuI+xUYH3gnTF6Eoz9K71JvPeLeidMXVgKlyv5jJ6zHPky6v6Kr4RNauTvwl/2Db+GtAdJuvBytjn5RbE/MEydgLQMcCSy1qvKgAIUoDaQT8FXX5w3nfYakFR3Hangqzmi/TBQ0jtaKUAOn545YeeeC06uKmnFeYI1FcgAIb6ncmDJf6dY1iB9fnaa/jl4VCUwx1zwHBXLJtW2m1Djy2E1hSapCgMWqASJ3Hzv1uRNXgoqX+yyJLHmGj3G+fzsNEw7eocMlwyzHKEBJHZiiqMCqSCbuLMRtYlyhh8Y9mkhFS50BHvLBFteyrSpOvrPDmAafX4IaMAKkWXtKNxsTU/YkqN6stF7zK1kPkqqWrUcN9Ggzd7fatD4gdpdBsUDFIf7rRZVG/nBcqj0VOvMvUTvlDs89PfYz5BoWSvjkmlx0xYFKzTPyZZBAQmZN4UwkRib6gpiT91mdwXrevhjpiycc/EEkN23wf+n8F6AxwZKzMOMKC90wX/VlaTXOD2C7sFPX8bVanb0eFMMja7seLK8Fcvbt2xLH29ex/rc26fvwQwZLOFroCoK9oLqom7lftD50qtnG6Xvry9B24mZiNLifDLbcO2XuM6uiOMl6AEOCiJx72zYOVxiNUdTiBWCbLUoN5cqtgzVzw2bIZSoMKXgF4KbZQoESuENkErmyGThLIZXjZShUsKfvHH9JUVBlEaZ3Klz8JCWBCm9TkBB9mVZxk0NPe/dBlWZKz5r+lOZzqbRKlRDh4AyLLN/Dgp0EDxV7Dw5SfYvD/eDNrJ/3ci8m31/Eu1fN0LpZr+hAsYsuUOprgo4eJxY5qUkqZzmYoGiuV+PE95natOb4KV08QE/w1xXAB6EeVbhJccqmCX8DJQwUOBc2uV7YGXiVud4eY5lHp/XQJrAIzC43+bw90TwaqAOsgORYhYlvGQ+B9eZDxEYJe8xrutrRiAIKwaAt0CMVu+azfyK0iyHNmPyUV0ofaWg0oI4oQ03ojflQUBRbJBXdVHPgPMXGMtfAMcawigBhcC8nb4X1aXMRLRgzdmM9QL2seF+DjMAYZHi33CRa1zXXo6rKOjBZfcW2APDXrlNFBRQUA1yndX41jL0+ydXhYSTv9qJ4Jd+VPZOFNw7JenuFzjO/fofDYNhLWVt7IKrCI6rABXphkGv6+EfidNvOvv/I53dbWx4T26/LLhECYCy7NpJ3k/JJd6iedmbjJKTlsbpgcIPLa3QS+DPkEMCtXY/JdfXoIB/rIqbG/hM2gXI5VyigbpCC2pz519JoRskjfc8zOLTCw+AzWdwhyrdOhxRMO+I4iYq2drRGzWyweAz/FFJejV7qzX/zr2Emj9kq62YQWx8XQLVQsVjGfHxdvRZg1Bj4eyAULR/KPeKLOTtqPUPbfeu5bphX0NrD1DDF0Qsqp7YtOjZEU0P0IdKu7ZtrLueffyQjJKJM1UWGhXzil+BKcWvaMn9hePJNX27TgquZjV5/ggkHOy8rYMFncv9I6rf02aq62tq8UFfCHVzE3jMwt/oJbz5X/dC+ao= +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"; + + + + + + + + + + +This endpoint will build the payroll and get it ready for making updates. This includes adding/removing eligible employees from the Payroll and updating the check_date, payroll_deadline, and payroll_status_meta dates & times. +Results are paginated, with a maximum page size of 100 employee_compensations. + +Notes: + * Will null out calculated_at & totals if a payroll has already been calculated. + * Will return the version param used for updating the payroll + +scope: `payrolls:write` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/put-v-1-companies-company-id-payrolls-payroll-id-submit.ParamsDetails.json b/docs/api/put-v-1-companies-company-id-payrolls-payroll-id-submit.ParamsDetails.json new file mode 100644 index 000000000..7db1e6b2f --- /dev/null +++ b/docs/api/put-v-1-companies-company-id-payrolls-payroll-id-submit.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":"payroll_id","in":"path","description":"The UUID of the payroll","required":true,"schema":{"type":"string"}}]} \ No newline at end of file diff --git a/docs/api/put-v-1-companies-company-id-payrolls-payroll-id-submit.RequestSchema.json b/docs/api/put-v-1-companies-company-id-payrolls-payroll-id-submit.RequestSchema.json new file mode 100644 index 000000000..cc5e96983 --- /dev/null +++ b/docs/api/put-v-1-companies-company-id-payrolls-payroll-id-submit.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"submission_blockers":{"type":"array","description":"An array of submission_blockers, each with a selected unblock option.","items":{"type":"object","description":"Request object for resolving a submission blocker. Each submission_blocker should include a selected unblock option.","required":["blocker_type","selected_option"],"properties":{"blocker_type":{"type":"string","description":"The type of submission_blocker that is blocking the payment."},"selected_option":{"type":"string","description":"The selected option to unblock the payment's submission_blocker."}},"title":"Payroll-Submission-Blocker-Request-Type"}}}}}}}} \ No newline at end of file diff --git a/docs/api/put-v-1-companies-company-id-payrolls-payroll-id-submit.StatusCodes.json b/docs/api/put-v-1-companies-company-id-payrolls-payroll-id-submit.StatusCodes.json new file mode 100644 index 000000000..4c0b2e6b3 --- /dev/null +++ b/docs/api/put-v-1-companies-company-id-payrolls-payroll-id-submit.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"202":{"description":"Accepted"},"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/put-v-1-companies-company-id-payrolls-payroll-id-submit.api.mdx b/docs/api/put-v-1-companies-company-id-payrolls-payroll-id-submit.api.mdx new file mode 100644 index 000000000..2152b79fa --- /dev/null +++ b/docs/api/put-v-1-companies-company-id-payrolls-payroll-id-submit.api.mdx @@ -0,0 +1,75 @@ +--- +id: put-v-1-companies-company-id-payrolls-payroll-id-submit +title: "Submit payroll" +description: "Submits an unprocessed payroll to be calculated and run. This submission is asynchronous and a successful request responds with a 202 HTTP status. Upon success, transitions the payroll to the `processed` state." +sidebar_label: "Submit payroll" +hide_title: true +hide_table_of_contents: true +api: eJztXFlzG7eT/yrY2QfHVRxKouUjelrHx0YPTlSxvNl/Ka4ROGiSiGaAMYChzKj03be6AczFw6Is7W6lkqpUIhLHDw303c2bxEJeG+lWycnFTfJGlxVXq9d5Dta+rt0iObn4fPt5lHxN57V1OpXKwdxwJ7VK3aqC5OQigXIKQoBIPo8Sx+cWPzvjK6OLwiaducZe83ly4kwNo8SArbSyYJOTm2RyOMH/CLC5kRUunpwkCKJyIJLbUXJ8eLw+4Bft2HtdK5GMklwrB8rhIF5VhcwJ4sGfFkfeJDZfQMl3LMH+UIz9oc4XwAx8qcE6EMyA1bXJgQkNlintGHyV1o3ZB34FzNYGmFsAq4xeSgGCnb49+PTp9C2Tli15IcU4GSWeSIme/gm5S/DcX2ppQBDhjNGGSFQZXYFx0pMjfH5yE2dzY/gqGSXSQdn9fPuq2RXghJw7mGuz2rIHjWqXs85INU9GAyJ9rCCXMwmWXS8gnJmmM53ntbFjdr6qZM6LYsXcQlp2BSsmBSjnZ+F47pyR09rBQcUNL8GBYQYKjmR2ul1yjLfdoN4DGq6AY5mehZUYXmZcKl6SDcjnRteVVHPLuBIs54pNgdXWo5nWshAsx0dbhvELrkQh1ZxJxVa6NqzDCIS5BGv5HL4N+SwCEeC4LCzjU127DlFTNgcFpiVnWDqitLWZ8dwj5YqBEggcKYf/ILvBV15Whb9npV02IybpPKyL3v0n4cV338tJZ2LncMkWBrnmnj9owji5/YxAnHQFeCZLicnSd7hp+qt/tR7t8WQD639SldEogvi0APZOOelWfyhkTyQHX7EFrypQ+B4VUW6qxQpvnq4m4GMoE7hU4cots3W+YNyyS6mIPbPmUWZLXtRwOWLa0HJxhRldkKgh0LqZiZxEd385Zh/Bs8TFO7/NG09DCfbzDwvnKntycCB0bsckBce5Lg+ixEwrLybp+wOCmebN9KdsXksBbKYNK7WB+GLGf6j7S7zNpPWy7x/iRuL+I7X//lKbnc7ajaRll4qEWubv8XJE4PxdsWtZFPHJM878SHYZhrJwSSt2Ld2CATFVYIz/N8oBUTguuOObnmIfxpvI3AYKWHLlGM7DNcMDWQVODuJfKkY8LXUQG0EiTQsYs/fasKCRRr0lCB+R6tL/N0NUl3S38ZO6luLSk3/aWlpoWGkFv85Ile0+S1kXTlYF+L2QjwaMFz9eZ7b4zR4s3d/bSjWPO+M0LoTEr3hx1tnJG8Qb9vYE+far+YWXxEH0TDxF3YJ3n02ujTe4hWVO02voEPjbO3xS8ksNrXgwJDfb/WhFL71nRpftghftiqouiuRzM66uMqd3D+zJuU0DrOMOdg3pWCEfwutPf5dukf6qIPXKL7ndPupDeDt+KF7N7eifO/873DmutFVh9+nwOwofrYqV9/6Y3Kk2xuzU4ceVtlaiieU0W/AlsEYOFbCEwuLdBTUSFUUjVpJcmrwuuPnBw+3ZzU+T7gk3DEg2eAFTrq4ynue6Vi4TUICDrFazWgkQWcVXJShnd3gIU26h7x6sGWs9N+F9rYRU8w/gFlqwBbcs7saa3egOesCWYORslUlFTzdHpJW28kGR/QvNANyVhV1Rc6LrMgVG+0sQY3ZWALfA8gXkV95IQYs1wGG8xIl2vP0IvDDAxSqLKz7qAZC8YUM2BVDtOTYALKVFCZUZXTtkmx1eoR+RqbqcgtkMcWDk94D+5uczPx95IqrdgCu8hCzXaibntoHW2Jp7UW19dhfMa8fwSh3TClhrzJa1dV3DYjOweNoZty5yS1bIUrodCDcM3puE7xFxWIPRGswudF0IxMwDZRvMWQVGatHiBSUyEaTlFpTNkI3YNtPynRJoD0KHc8iDcguu2DNWauUWFm3CWe1qAx5f7iOLmVSits6sMgsF5Pi6M8VlbrNcC8haw2wr4nb0/vT8BecynLvhOd4NYdjm8QHGpwlfal6gFnnBhJzLRuzsgGsjAHsHuFbmfuz+aD/KnLDadbDHAazH6mQJmZ7NskoXMl9lipd3vOvyXkQsN93vEEStiKNANPzC89zUvMjMbp7pDdtDcr/28xjOayg2LVCUo2XV4GEEUILdArwCUq5ZCKTs0o6DqfugfeOZWwDPnVwiZL+G93EDBoYbMD2bxajONsxQVoVeAdi7XHszeP+7fxenMm7g7i9gyguucsjq6hvycru23oXqDVcUHuXiT7p2v5vdfe0LXUiBUh3/9YCjWUGG6ENaRSHv05gRZFKwgAA1ULj87dAwXPxosJr8C1nSm4CNWBVMNgP4VrWCrVAb9dg8s0d5iqd+DItLMHS7bCeGQfi0mmpu0AyP4x6SfpGH0eBnzVYNJA9h7TAPiOCcYo/SUrCH3FKpelFgDC4PNJo3KzJQGD9CI8wZnjttMnTCdmAbjtyfTZsFvL/X2jceiyCGpVeOss/jbRk24n9MO3Zwxg1qzjpuyG7nMweGfP27WAHrs/an31ljVz/ZsN6Tlo3b0ATFKVlglCUoF04RQ4t3xd8b/13Ieyt9E3Mc3bo0mHLI5kZbi+GOuLkCcgZ22TphxP7mDpCP0FgU0S8YQCKrBW9koWtzF8PwfqruZ1y9wzkK5tzJ5ZBAgcdz1IPFA8qbUHfQAeC3aNhjZvRfoLKA40ElHUZ9wvZrLnlIumFs4dRZH05vMXqzQ2CGjBcOzBa0WVhlt9/+XcClZVNA4dYAjqmWAVQKNUpLBmAAW6tSCzmTJLYj5BjNfEiwMWNUrV22B+Ap2SO5F5QWzDJIcbuyDspmUJThQ9uApIDNZtqUfJe33x//PQKov1LL1YpReDLgLPlXWdblEKetTcXxzI8I9d3XHACtiIABb+Lo8JCoWmh9VVe7aPmIwKLBFX0AhsU4P9in46Sf+2rzOheDoHvjPiSDWHncP8U/06PJMypx6Aq0aaHzKzCN8qegm1QzvdfjH6y20RimFxEM4V4cUCqmjQCD+snUKrLH8Ph+73Wcu8/TXI4FV1ePcyguWtPU3u84A5i7zzQDganUzPGvj3kstAvJAA/7Mce/Mtrvfmdch32Hp+hjwr5I5MGP2XuGUWLFKPR3vMse6M2HtLXFWMSeIfa7HEpiUUtYvKsEv3mEFpKHbOspnUqrtatpYna7TPO16fcJ1TWLsLgIazZvfYhkG+BWK38v2l66bEC/uFuQxhRC5/kicwsDdqELkUFQPkknfzdEQMeCBuv+tIp0wSdAYZsllwUPyTy0+IslMIrNv37zMzuP4FjUjJ38kdaWghGoJH+XBtipGrEPegnsXGPlqWFvOaUjuwpzCcbuy6ZxbuO+xEUGuSOKi3HnoKzIiXU6mHSMt/UcNT5ONDl07VI9S+n7sGB0M+VccacNhva4LO4W1uOyuE9Ij8ui6+gOAUS/O0bHFtxmzbcPH03x2dwm4YGX2+zGqDwoAGqegYESb5xS5zF40E6ZwgwXwzoBJDpTcI2LRkNPfgWRCWmntbFAyaQ2b73lYN3Re3BfJ7YQ81YbrZ8dvLdtiTtUlr7tgB7Uko4e+XjiUMz4ZDJJuTh8lR4Df5nywxc8fXn08sWrV/mz6dHLH3ccOq5WUrb7Pra/T/D5+Y3+9FLjhL2VmAtnb33yecTeYFJ6nAypElFgfUR9Lw/Eo/Dzo+jzFjWa9lUf5ZNgbfsU/5NxlGH/V/XGo2QmlbSLLEQ5UbtiIYE3vR4hJh0I5H18p5GzHWs3H8QEC+2tmIyW/pYVZp0BcNnR/rf4AR+PVHlRC5TofiGULQasXXszuS9R+r49aJHhyr5KZ3/Vi9OQtCFKfG20mrPgfQ/3+EtW93jmXiSDQl87RvH+kpVPuv4A4/mYHU2eHT9/uoHFFlrBveshznB2rIaITH502EuUYsVBIfNdkYaNzCNqXwEO21KPHdbB9J1bgO2U97bBKp/CGTjwdwlkb4S1u47gvNs709Zk0O37e8HabG8pRx4v9HWnvIFquXYVN7S+/b2jCbhlrOYbPohujOBhNmgOGTSZt2Htt3V+GHh3dUi7BEM7SilkNLtD0+H3NOdeHgjWBINg9BV7EuY8aTsJlGYVmFI6F0fZqFWm3Mr8kb1zTmV+UX5Ha5OMjP1cWAUgbEcPBTdwg/0R6XYdisO3nI6+3pvgv2NZeJQzc0qLmmCymrZQ47BRVGvoHjFGT5bE9iD5IObsEWAMn1Fleu6YratKG8cEGUfFapjhD+IonsFnQB88Dj0ofuhA9huKQTZrV7mYNNZl9yt4eY9zmRqUvaxJK0H6YZZNpXGL/Xd5S3n1GaPpjWscNCiVTXgDkGTO3dK0TS3ofYz4YLy/nHA4fnH0MhWc/5geg3iZvnoOh+nRKxDPxSHAq2fPd4g0yobdwyktCs7eS/fXHENxgip+OQpzdNcYMiy94cUgG2YBbURyEZtUcyDCBkfngSk1ES+nsxeTPJ3y6Sw95keT9NXkx0n67PgQJuLHnE8nr3ZQ6n5S6NRyyRfsJzCFVA2ZkC7Fikh0HbpX7kahaFODst6ebuIeu+t2ttdq7SxhDdZo96V3iy43ImmcS7WzPrQ37N7eGs4eeIwMU7Aj9jvAFYaalFtQ692/gG9CHYMmjex9YFcpbrRL2uuOQu23jva6FdMtxe44oQFwii+9ql26PEqbAo20KZZsugJt/B/8jIKW660cFDR1VLtSqxZuTDtizxk+3QJr9V3QWqZW2MNGweMm5Ir1L3al8oXRSte+e41jyySuOKuLRoE0DRtkpXM2OZywn8/Pz4JXPmafKq3ixBFzhisrfQiXOtFbZPjnZYP5khaAMTbRYhAwVBFXYTCo0MzOXTcT3B65hVqsRtjmSceJvZ9UiUJdhYzKPcK3bbYaF4t2FmE49Y0reetLeztNMGwlQSIqSkIHLKFJVFpbg2WFvMKWs8ZwoxzIKHoKDJNZ6C8i4bGSxy3A+N0l2hFhlVHsYKNfIWg6zI4nE7apRTZeSGwg/Sus78/RhNQ5du7hE5r6vEfbjdP83gGd3+a6ghN2GR/jianVZYLZjeAFeeYjc+Ak+e/0P+kHFF6fnab/1YR1JT7RBXBB1m3b7zvs6gFVl9gnMzmcPE8PX6RHz7HVTcCM14VDtdB+fjvkgLeIpZQqtGqilk9RCgj2+uw0RoQZt1bnkliAyEStljgAu0upz1KhaJJt8dvIj+k0Lj+x7KKUihLKnbX37PLllUzDTKnm/x4WTDsfP0UY2DLq3ftA4VY+RMJWnGykPjnQY6VfeNC999vrKPSdXduu47azaSuA9to0lq7ss+nnUXTQf9JiFc2DO7WPD7vd+j1rm9I932qoeh1KGfBAG+aPGPB8ERkuZnNYrWgA847u+O5NmL8F2RpaeWeeGXWx9OF2u5YZG7N3CGAdWhSbnfjadnTdHtNeXmu0lqFa6zzt58G+1ah33mmi3gCapHqUsJTy8Y+o9NV263DutGFzcj+J8kiBBp31n9gNiMa9DrZQsZW2Gcr0Jz8uDTeXniOa29vm9y1sBfwKuF2lyEmpXoIxUkDMPuITgK8OlKWICApSb79s/REb6k+sBz9mg5zan+d/wKYZjEzXHbQNVjMhwkN2DMkCslVI8ONv7SQHy6ODxmo5uGnF0u1BVBUHN63cuD1oDkylTUFt1KZA1RAEJ6+kl5upgJKE59qFvoVSJ33K+vVSnx/Br/GkWxbeuOaZoVzItjUr/BoJEX9/6CNKHP/8N/wKUfMkcfOo7vDvKXBDCnDYwU5LpNRsyXjtFhhhi5UEo+QjlX99zw5+hS0b3I4SlKS/tTL3ne/G3CozL9ay3w3zrfFnI9d9kNbXGEV+IlMBVSi+u5hI7ir5UYI63f46+whmKXPo3GirXul3Bw5o4IHAI6J4SulvTAjbMHWtVxaKXJdkrBGOJ5a9CwzFYmkmaneh8xrlA5Hr38KvmXAf9w7a8W3clf2GvzgRgps+h4xPMnz7H+0LRKpX2rqSq8463ojvaM0e4o4i/Mfc/8fc/1829wOnO/jqDqqCSxJNJGRvgka4SJaUBYw6IRklJz1jNS6JX/QMyqAZPmMLjHW40s0Nmu6fTHF7ix9/qQF9+IvPqJ8MVe2SGBKSKCGSkxkvLOxgmB9+CzbOU7bdMt54xmgf0oioHZPQ/d+1xlHrPAiglv/vAahDWN9U5L2u/aj1t/altpDVk2+z/9pQubWh3nhieYOvHbHmoLQz/I8E7hzbNbbOPp0no2QafKBSk9Fo+DXa6/zaX3nMpJ3c+M9ukoKree1DWn5J1DS8bzU0VkL4n84P0/Qf1c2NH3Gur0Dd3jZvzOHfFP66/R8Ern65 +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"; + + + + + + + + + + +Submits an unprocessed payroll to be calculated and run. This submission is asynchronous and a successful request responds with a 202 HTTP status. Upon success, transitions the payroll to the `processed` state. + +You should poll to ensure that payroll is processed successfully, as async errors only occur after async processing is complete. + +If the company is blocked from running payroll due to issues like incomplete setup, missing information or other compliance issues, the response will be 422 Unprocessable Entity with a categorization of the blockers as described in the error responses. + +scope: `payrolls:run` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/put-v-1-companies-company-id-payrolls.ParamsDetails.json b/docs/api/put-v-1-companies-company-id-payrolls.ParamsDetails.json new file mode 100644 index 000000000..7db1e6b2f --- /dev/null +++ b/docs/api/put-v-1-companies-company-id-payrolls.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":"payroll_id","in":"path","description":"The UUID of the payroll","required":true,"schema":{"type":"string"}}]} \ No newline at end of file diff --git a/docs/api/put-v-1-companies-company-id-payrolls.RequestSchema.json b/docs/api/put-v-1-companies-company-id-payrolls.RequestSchema.json new file mode 100644 index 000000000..5be23e7ab --- /dev/null +++ b/docs/api/put-v-1-companies-company-id-payrolls.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"employee_compensations":{"type":"array","items":{"type":"object","description":"","properties":{"employee_uuid":{"type":"string","description":"The UUID of the employee."},"version":{"type":"string","description":"The current version of this employee compensation from the prepared payroll. See the [versioning guide](https://docs.gusto.com/embedded-payroll/docs/idempotency) for information on how to use this field."},"excluded":{"type":"boolean","description":"This employee will be excluded from payroll calculation and will not be paid for the payroll."},"payment_method":{"type":"string","description":"The employee's compensation payment method. Invalid values will be ignored.","enum":["Direct Deposit","Check"]},"memo":{"type":"string","description":"Custom text that will be printed as a personal note to the employee on a paystub."},"fixed_compensations":{"type":"array","items":{"type":"object","description":"An array of fixed compensations for the employee. Fixed compensations include tips, bonuses, and one time reimbursements.","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."}}}},"hourly_compensations":{"type":"array","items":{"type":"object","description":"An array of hourly compensations for the employee. Hourly compensations include regular, overtime, and double overtime hours.","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."},"job_uuid":{"type":"string","description":"The UUIDs of the job for the compensation."}}}},"deductions":{"type":"array","items":{"type":"object","description":"An array of deductions for the employee.","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.","enum":["fixed","percent"]},"uuid":{"type":"string","description":"The UUID of the deduction. This parameter is optional and can be provided in order to update an existing deduction."}}}},"paid_time_off":{"type":"array","description":"An array of all paid time off the employee is eligible for this pay period. Each paid time off object can be the name or the specific policy_uuid.","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the PTO. This also serves as the unique, immutable identifier for the PTO. Must pass in name or policy_uuid but not both."},"hours":{"type":"string","description":"The hours of this PTO taken during the pay period."},"policy_uuid":{"type":"string","description":"The uuid of the PTO policy. Must pass in name or policy_uuid but not both."},"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","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","description":"The description of the reimbursement. If not provided, the reimbursement will be unnamed."},"uuid":{"type":"string","description":"The UUID of an existing reimbursement. This parameter is optional and can be provided in order to update an existing reimbursement."}}}}}}},"withholding_pay_period":{"description":"The payment schedule tax rate the payroll is based on. Only relevant for off-cycle payrolls.","type":"string","enum":["Every week","Every other week","Twice per month","Monthly","Quarterly","Semiannually","Annually"]},"skip_regular_deductions":{"description":"Block regular deductions and contributions for this payroll. Only relevant for off-cycle payrolls.","type":"boolean"},"fixed_withholding_rate":{"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 relevant for off-cycle payrolls.","type":"boolean"}},"required":["employee_compensations"],"title":"Payroll-Update"}}},"required":true}} \ No newline at end of file diff --git a/docs/api/put-v-1-companies-company-id-payrolls.StatusCodes.json b/docs/api/put-v-1-companies-company-id-payrolls.StatusCodes.json new file mode 100644 index 000000000..3b5722761 --- /dev/null +++ b/docs/api/put-v-1-companies-company-id-payrolls.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"description":"The response from preparing a payroll for update. Contains refreshed employee compensations, updated payroll dates, and version information needed for subsequent payroll updates.","x-examples":{"success_status":{"uuid":"4428f108-e46e-4ab6-ba20-03cea031cfc0","employee_compensations":[],"payroll_uuid":"4428f108-e46e-4ab6-ba20-03cea031cfc0","company_uuid":"42b5333b-ee39-493a-bf7e-f41f2bd67848","payroll_status_meta":{"cancellable":false,"expected_check_date":"2025-06-17","initial_check_date":"2025-06-17","expected_debit_time":"2025-06-11T23:00:00Z","payroll_late":false,"initial_debit_cutoff_time":"2025-06-11T23:00:00Z"},"off_cycle":true,"auto_pilot":false,"off_cycle_reason":"Bonus","withholding_pay_period":"Twice per month","skip_regular_deductions":true,"fixed_withholding_rate":true,"final_termination_payroll":false,"processed":false,"processed_date":null,"calculated_at":null,"pay_period":{"start_date":"2025-06-10","end_date":"2025-06-16","pay_schedule_uuid":null},"check_date":"2025-06-17","external":false,"payroll_deadline":"2025-06-11T23:00:00Z","fixed_compensation_types":[{"name":"Bonus"},{"name":"Commission"},{"name":"Paycheck Tips"},{"name":"Cash Tips"},{"name":"Correction Payment"},{"name":"Reimbursement"}],"created_at":"2025-06-11T19:40:52Z","partner_owned_disbursement":null}},"type":"object","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"},"employee_compensations":{"type":"array","uniqueItems":false,"items":{"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"}},"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"},"fixed_compensation_types":{"type":"array","items":{"type":"object","readOnly":true,"properties":{"name":{"description":"The name of an available type of fixed compensation.","type":"string","readOnly":true}}},"title":"Payroll-Fixed-Compensation-Types-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-Prepared"}}}},"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/put-v-1-companies-company-id-payrolls.api.mdx b/docs/api/put-v-1-companies-company-id-payrolls.api.mdx new file mode 100644 index 000000000..bcdc219ff --- /dev/null +++ b/docs/api/put-v-1-companies-company-id-payrolls.api.mdx @@ -0,0 +1,76 @@ +--- +id: put-v-1-companies-company-id-payrolls +title: "Update a payroll by ID" +description: "This endpoint allows you to update information for one or more employees for a specific **unprocessed** payroll. You can think of the **unprocessed**" +sidebar_label: "Update a payroll by ID" +hide_title: true +hide_table_of_contents: true +api: eJztPWtzGzeSfwU3W1eKfRy9rNiOPtydYjsXVV1inR+b3bNdFDgDkoiGwGSAEc1V6b9fdTeAwQyHFElLu5uct2or1hBoNBqNRr/QuEl0KSpupVbneXKalLVNr4/STM9KrqQw7l+LoczTki8qXRQmGSS5MFklS+iWnCbvptIwofJSS2UZLwo9N2yha2Y1q8ucW8GkGutqhuOwsa6YVoLpis10JZiYlYVeCGHwF85MKTI5lhl7/LhWZaUzYYzIHz9mDoF9xv6qa5ZxxexUqiumx8xORbf5R+XaMz36VWSWccM4szAaYKTHbCxFkRtmp9wiugCR8G2GUNqymc7leIFjGFvVma0r4QftjGGnla4nU0CsIcmAaVUs2DUvamE+KtfTjS5VVtS5yJlUMcB9xs7HiFWuGSDh2jXU8WRjsERCGSSuGbCx/Czyg6muq2LR/U1XLBd5neGfMOJC1xWrxG+1MJaNdL4YABKLj2ouiwLHHQlWiZm+FjkbV3rWxvGMzfhnOatnQI6jw8OA1LA1MFJ2JBxxc8YtrISciX32GigDMHun48jq1mguKvFRSVXWFqAgioierSsl8v2P6qMymS7FKbv0zHo6r6QVlx9VMkgsn5jk9ENy4Rn50yD5nE5qY3UqlRUT2gipXZQC2onZSOS5yJNBwssyboJdS17xmbCiAqA3ieIzkZwmf0n/CwGeXZynfxaVgS0ySCTsk6nguaiSQWKyqZjx5PQmoaESYyupJskgEaqewdDHh8ffpodP06NvYaRcjHld2OQ0/n7b3YYvAZeZVMIgQYHU6YgbkbOzi3N2TbgwbozOJCcC2ilxADTIOKzo+Zgp2JzSsLLS1zIX+YDa8LIsZIbT3zPsw0wqXPgI9qdvptaW5vTgINeZ2UfC7md6duAJ6UUI/n7AS5m6nlJN/uQAptHnR4BGbUS+n9wOAoUbkeQJW3I77ZFKgr1/f/7S71TXLRkkwO+yEnlyaqtarF6O22hQh/m2g7puWw36aZAYkdWVtAtkrBeE+FkGku2sttPk9MOn24h3KzPnEw+3EqbUyggDoI8PD+E/bRzf1ghpXANamVZWKAutogU++NVA05sIy+V5+pFILpSVKDnMgPEgFEGee4H6QivLpTKsEuNKmKnIV0owLyY8GPjLDBhXeeDi+DxRQoD8hMFMPTIgzJQNnQmY2U+AXuIzn5UF0cYQGYbGclvjl7qWcAaenBw/Hx8dPk/FyVORnvDR03TEjw/TwyeZ4IdPjrJxdghbtVfUwdoMArdsB9Eztu91PPr2yZMno1SIJ9+lJ9894elo/Eyk45Oj8fEof/rs+cnzpBmL5jGcCYvrlXGViaLgo0Ikp2NeGDFIxOdSZFbkw2wqsqshECaWKc+QtaWVvFjTIgDJxUjaIYjxuMnRu+Mnp4eHp4eH/xshVyAgh4YfgwBktdXj8Vo4t4MEmmSLDCZDfM5rq4elLLQNcEObYSU4MnDyvVY1KCwg6qa6yKWaDEu+GJaikhqI/G4uM8FKAbqIwg1trmQ5rMSkLng1bE5LPy4er8MYXoVz878qXgxJDiNDDL0E8EgGDWX5iyO3qotikGS8yGogWz7k1n+MUb9JjOWVXVoj5E2VL31/SssxhC2d14VwbAaAbwfJuvW2olI8moFb01zwvJBqzeoTreL9MQRh1zovaYUiSftCz2bS4LkZfb3gC0SRvZNluzk30+WPuqoErhu74IsZCLjo1zdCzkZ1ZQT98GmQZJUIlI4nc/Td6cnh6bfHxMqVVaIa6rmCpZKmAUFEvB14UU5aS4JLW4rKSpI4y4RbVgBIrCWnCR7fuCm6Z8wZqk7G8llJepF0B74Di5Iw1k2tRjWpBrHJdJWLCps0ejc1KLnMmVZOMQNNwAOYcuN0QaEQzmjRGnEAMh/lvwjKJGpnTvsfaTulMxiXEL+BNA8YWw3HQkEatGBGawUwGgydAokoQs/WfEcLNp/KbNqa9Kw2tnfaBmBEiNDkZ8Lu4ynNc1BJ/X620haO/QBq+tKNmb6Ddevsm+XVXD40cUitHMLNBL0yizPsLOAmiL0APNKXwDQetUjSBMxGWheCqyXUfpkKOxUVGAiw0DEhYfFx4U3QG4oFC8D32c8aqAiMGD76zsabUI3yv8/O8lzCsLwoFoNIW5DEZJOaV1xZIXLPlwHqr7SmGa+NaOEYWAGQLTnh9d9A6oAI8CaAr1WmZzOtUCMBdUIAFrURlWEzvmDZVGtDHFmrMMBIjMFU7Rtzk9W58FNYXpwO73xomAeECmn/vUwEBtES18+5aS1NDXRtW6rSqL14qRabcX4zhRaTdY6pNdPYUrI5BbrgxoLlLBt10A8pYRGjGVbCzY27DnHDTbZQmEp6ZsME6ZTcZGv36P0bEdb9930tI/ZoKZB/79Hbiui2o7veO0kx6trGJlL97pRj5yoHEwYEqpNobdZnXDE9HqcIr2WdrUfs9XicvoA+y1gFZfMm4WrxeozKzSq7/iyf6iwZJN8LJcbSskqACOKAgldVG90lGSQvpQFlKDKWkkHyI9iR8Ydf+ATIHvV7xz+zSmRaZbKQ3H180wz2Uho+koW0CyaVqSswFlguAd9R7WFUXBlJLjuw8HSBe5B5BTL5BDqVmynu8tteadXQmyjlnD7B8YX+wO6amHXs0qzGG4QYFiU2Cu6FVwAgQ4AbMMtZbXV6AY0DQo3yfC/oeHBbcO4r1yWgtMZE+XIcybEZYeh8un64iG+/nA38FH+QOL9mRkGq+TmvMv82EW0lGRCB7ZmFvYWaY3vu5Gv7Ev6GTdQ22J3YeHUtqgWbC3GVDNwfGsnvPi1bsT/Bfwvwdv1PzSsrKvz3WzGTXKkaVK9kkJz5f35aJuovDcmAnOkFkixQdKWV3GgADRP1azLfFzq7Yg5G7JcGBR/8Ul4WGXeUgE8yeMfvi3neXskyfUNIpC8DEtF26bf3N5/nKwVrCmwTTC0EJwr0hAMXnb95u2eYdxESd+kxOz7+V5zZWOSi4gVMV88cpH321lJkpfkWrAj4KwAHx5DYM8zUZVmgwcqLwMT77DUw0lwaMWBzsVcUzNTk5RfKykrYhT/X/cbdM2zOJ4LWyRPGIaBV1JXxma4hIkR44KxgOn7JEcp9ioHPIm/x7ZuWOdS374Ol3gXettxjT8smMgPbo5o+oJkZeS0GkXrGCJPlad3GzpsHH6rHH7SVIdJROhsZeafuh96SZV20K2ZWODe7q9c9pRrnMB/pumXPwkZAYMi+3plJPuYlj03LiXrn6Qjz6lpbYFKOBHOAxIoV7/PLbuxNAL3Ae9JbboQlww/84zOJwTOl572o9Pl/N8FEAcWL2K/iWSAKON3F+H2e5U0Gh5axiKr2DONZhsLHUwRhit2I0vZi38kHPcvJ/p0tU3btAvQ4x+8ixUXH9dVMjFvw7AQnBihqSDLN+LWWOSsiV8nGe5WOT9xL6U/C8kbpXREZCfjzquKgf9RK/laLcytmpgkO0F83CS+KtjG1wqsaRtvNWg3qaD9H0qm0waJTEkR3H3oA7BtQmEqRP3LRsmVfhjtOm7B7ryuQvSBJ0g60zXVd5BCQE5h/0fgV9xoMRjy7ghVHOvfOdiwrY4fkJN/qGMCODDouUZW9IaXGsMuA1CmMfMkwVN+/3yoxFlUl8uHOKAUQ944ceKR2wQg9WfeHxqTSxoAxE6Oh6tkIMwxWoxFpcQgCeGjAxG81L8gNH+lm7N9YBuEVK0v4d4gn0J/g4yErhAePLhO8gmi+GTjGAz6Vs7JG0Yuq6j7DrYLZMCB+MTeGX3OJxywy/LIfuZcEStgvI4AStjP9QFWWNpuZVNvoQ2Sr6IpNYMpmCoo1tAoUu7+J0pFB2vTus6WzmaBEU3ZUZP/Gqjgudo/oOwsatLep3lbFjCcQZwZ5s5yA7rNzwx4Dio/Z5Y/SWF3JjBeX4KdQkCFUSXENvNj1oBh/LhcLdPjr2hqZ4x7FPB7Mh1KsrCEDy2r6uB959F5K8Lqxl6LURsLphJEY9NJ5LMBRlszETG8x9RcwzoxZ8dm65Cev2VWQh5RTNlspKoPbTmmKZLUyqeBMgXkaW49WCPxufHbTU7rjt1cMG1NSHZie7fQvf4g1Eu+HnlY+ww32zoCNwB3q0z4gIwk1li6Lno9bfoEmWBVY0yXf9aGF+U/ccfgEQ8CAJ1fscP/wkFE00+WWsR/Aj6VYlGLoBx3gkcszK69F7zgtQEmk4qxXbNpnzFrlOzpV4qHdFuaF0cyI6hpsdvLR0ZoOmJzNaov7WeZgtI+li5IiVVuw0L/aEUHrkHLGfw9asVIT7IHbQfKrHu2oxP2qRwFoG+llXRa0WcqOvGfO70u57GH9H/uaed53x++A6WtghJkg/s91DWvkP+JQ23B/L2oPwf69A/1x+B/pviFOeDZ7vvCOvwBR5C2nZrwN7meTubljlnHP8c3Hdtl73wRzyQfbxO6NwxeD+HCO9i30328TU4gyJBXN6sLKspCiikYNytFKqoVuuU9oARe+8+3rhhrManCZttUPUSEN2FxXVyvcOuPC8Ci98G5q/PDfb88YWdQ9TteykjNeLZBOMS4rZByYj+g4GOrx+IuFG+xxNEhR/uhxGztgHlHIiRwF31+Hrx9411+8e/1Fm50gbLnFaWNrJ4Qv3r1mll8JxfIa82B7TjiKvZV8oWs7rEHByYcIZYhZ7VuqxqCrWq5yvx8NrVBdghe+iYb1SwJK9g3r1TSPdHlipLbO9cWc1Aa3fEBuzirbCMpcF2DWtuVlC5VVWkkL1nZpOs2X3hFd9grKVQXcnHf12+UElK3d8luOuP7UoI4bmn0VJLEjrpvnny2vioS4mAN0f9jdxgn5HzwntbH6dNvn+Hzl+BRzVcLRl37PTQg13cW3Lol9M8aFqQMdfOa7W1YCvc/eCvJ8f2huUrBJLXOx5WUMmYtZqa1Q2eIREjLOsNeKTfUcr3MZ5z/GNQAJ0VDI3XbBYMlWRNhw0rF/dQtNhxwVmJwascQ/nHCw1stR8x1lauSQWjY42tQJgdbRgrl7Ra2gbOQXCeS/vG7uHV2iaghqUfXgp3qYVr9efLeG14WzSsZT8yHB3ULvhoYbDUJB7hI89O6kiXTtlZ4072NCpwLQVFQZ5Jt/2jkvsaHoLhjd4v96kkVWCEWSh5EH0JQCw2JcTURvGL6N/euOpoLOvFbCMF1MhKgG6OI5D4nJ6HdWxgqeo1cKnO88m+4vcaau5AS1sm0inq9dpzjeicj5cQhrscKdS9JtqxFfOInYDNgLOsyGwodbzgY77TqbbUb0s2kGXKFB+MzKu7mc2rL5dNG1apd4ZOMIJ/Bs+hZ4Nn1BPNukyEY3Rna6xQFZ1GhLwdZDapPuY3RdZQITud0Y63JfXlCTOGF59aWbpUNmpfBenw3jhflq4Q2Zk+EA9kJy2TUKM+uSbsmUXZXoE4sanLzpJtdjshZdR4kV6DBLr0Av5fpsbLCblq3ueS4SQX74ZZJ62R4iwDhEkMFDd9sCLqRRGJ8a0B/Rr9Fcx1wWIsfTQVSVJjO2k4uG3ymioDPcurm3V7lZqKxnEn3stzEfNTo2ojS8EgucphUTXS2Wqd+0unMB3tJNeEpGdZczsDvNDGyZRQnxF7xhLg27EovG8ifXALeUZSgOwm1uVgk6BH04BUDu010Hh/UWqAEEvwEIEkMF14Hyl6yNw3xS6bqE+Kl3wAXvG/gPa1nkLKPIELWfcpUXdNbRLe3okjr6h8NA0rBLuFQl8iExx+UgMiQovJTRHV3GGbVkl64pc4u0IKcxkNAuCAUyUmfCGD7ZJEfFzzcXlku4lxMStGhGKZsIBdmOftUcaE8MU1djnhFBIPNJ5Xh5x2Fhec43SRGLbiMX4porPIQ4wHQMsmiLY6kYbmSJRwxoIUErId+4u1k8aIFA/JBUl/RflMSkQfsvoMddRtE9unMPklErsSIBpj0X58akrEvcR52N5z8vbzb/yxZHQ3tskA9+ZOjWZAJcRCP1HSIRQe7mmp/jtAmiKIqwhm3w9gPcR4eCHhq5ISLw3SO8R3urzzFIYBAiXisaQgLPGodMaFeXQ7su5Hs7SFpyrq8B5u6uaxIdjz857scU2PS1EukrWpbb1a1+crxDTWFp+iz3r2v++1vzthbQ2d0d5xsIH/SaiM/SWEiRXHNs7LNz9MqV2hj091vNpvxasCCHCnEtCtSK3DHiD4ogVpJMVqDnVN8QuinqJelrZLhHLa9ST4OkVyu8CApL+sZpXbfrb21vnsKPFJppJRZoTXTdxe6KKBj7oPk38SQ3OoSUpj64OlpQEsl/JH02B7ZPXwO26csI28aWXp43+bact/7k8GRZ7ftZW/aDrlW+e8WPAIJ9VIx9VGRzIZ3Ri+wOylwLusaLrLTPfuJXeGa72zLueGPnLw/QLUEJRjKPLIHVymPfCbaKw7+qpP+UKuk/i65Ie6VdEEZpOxzjJokY60Nr/ZPGnmsoH3WMJpes2CBzV0sBO+yDnI729M/aprjJluQd7Ozj4+Vt+d7HO9DUJmEJdbDQ6QuXD6a8LIVqPAxQ5AtWvlX5K/PqME0brvpPIXp6KRWda4Eph5gucomlxGwzQzbGBcpr4Wgdeob6cpeRz92ZoS+IhlKYLZ3uiGaahe6PyHWPMhlryjmO2ce6XztKvH7Skuz7SlxP3K9S+48vtb86Er46Er46Er4alV8dCf8P1/wP70hoWwEjrq6G7vLoMBeFsGJYq3GtcpEPXRzbrLEQIIW0bR4sKWstM+GHGhP4fsJrLJjB7UdjYTRcgxZi16KS48UQblRh1ZdhTvdP7hOzv4IaAKOGu7RNQjCOLyEx/KIQkDRLcWlUUkBjdei4PAmzv3oKvIDg0mLoIT7oBIC8bkBKlA/z6EEQqxBCCFHX1mWxrbIKqcUwJKT0oNhR8luIvqH+PmdcNqUgHF4+fyLTaiwnJqAWdM2tqLbcO0bmzDJYUouXbhpl1l8q9opFP2J+tpA54HfLsJAzaddg2NN4axL+ABj7O2EIg5kp3oodCVBDaWU8zq4QRINvXHNhBZahSS9u/bR8paiyQLRzZnQFmyv2hIq1YKbVuIai4oRfqG+s8trYajE0oqDCTkPFZWaGmc7FsFHMVmLctN6enj9DXwZ9e9hxMwzdMA+PoGfNcKXxKcvlRAaxswZd4xEwG6BrZEZtt8f2rcwQV7OM7IlDlnD1CfvDUhcyW+BF483WerYTEWd969tFola4o0Qe9gvPsqrmRaiFswKrVrMtJPcZ9aOrGJ5iowJEOSX5OnwYIoiZSb2Il0LlURbIutOx03UbbF/Q5s4FXoLCUgoIg2xch0NzccIjswLncAV8k2UPjbdfe5+z5+9nbcgBI15ABYIhlfPc6bReh9ULrtA9ynMq9kmjmfXLPtWFzEGqw/8JYa9WoCJ6n1qRK1EY1AhUKZjDgFI+EYPVqIG7+MHQCvEX1KT7EBuw0qlsmDsGx/xKVMPxGNjsQVjxnNo06d1gdpnIh4H4aTXSvAI1PJQ+vEf6+T0MCj8LQzVVFhGFpcncIwbvXAVTdPagWSpVywsMzuXOiUZqxVBg0v0Qa6bxzOpqqDFZayVu3Zbbb9MAgOy9Rr8hXOi2IHI5yL7wnkwH/4fUYztz7DnmsHQWAMDLkGjrb6IFLPfann4XQa/e64G312zjxjWBfkpX2VZcw2UemoV3LW6Kf6v9F2HegnQnzr51Y9JgTSWquFGXQdZEVT1W6TquxfbqDtX7CBqFtws6KKHWAivir+bdRdLdjrof8cpes3OUmHC4RN3Bxu1xqiB2j/LGV4tqEKAhwvYYV/pvolUd9N4kXefOesskj8pXn1tD7vSlKuIQIeOFFdUKbIdR+uoDIQ4VPwUIt+amROfSdPPaUSi55ZCtFb4pJVFse5S9N/M+kfURo3JpsQmBzl0P75KDWyHVtX9UZWGsmIVGXoZ3dQOUAmboU9/v1BOo/ZcIoDakZle7i1EOT/dCVRdPU1dUKP4BUX31OaO3aTqvZAFVC62v6nIdLR8QMa9weRsA7wh9Yx7tJ+3YVxPX+dBxugfzIen4yv34KfyZHh0/wRSHWKCNoO6rqMLhj043uDW3FfN3oPUqw8gRThFu+QHDgxDtMv/d6dPYy3iun09YHCNsXT7MpHieR49H7DSdDprr5+Qq0A4t//yQ0wK9EBVwX/EWytTieLvNcRntDViRfMKUJHLv02yxoZdY3gv9BXzZQrp/kqY24IvY0sW+yaSwiKYDHh+Cd06hQYlQxtst+PbP0tIEn9061Xyp+y6uugCEeSAsDN7YEMkqhJtT+UuxbYXLOvTzozlpjC50nk2HdgqPq+kiHwp3+CRR/K6LAU5LBFy3p5Wni3+8Jbr1pVHjL64FQ9/82Ysf2TuPHPMnYxQ/wmdX8F3QMfsFqkefqwH7SV8L9k5D5mnFXnIMR8YHZnSLfGu1KZgv1+GZxlbsCP1i3MKLoWjENq+Z8iafo8ZrXhwLx6V6nOLvDqA3M+VEcasrcO1xWWzm1uOy2MWlx2URG7pdBLzd7b1jU26G4df796ZQNDcEPGBxw2gM04McQoEN6KlRCp1750HTxRWwhTwBLH+qxByAekUPLz7GKd5+66yeWNx6i90X+RZ83KpX+1mz91aB2CCzNM4L7+SSDh54evlhPubHx8cpzw+fpyeCP0v54VOePjt69vT58+zJ6OjZd2sm3akEuYPuHxd9DOcnSY1T1q7FOGBYipHeDu3Dwt303BkLd/vTiT7SqLHaRBvLPadtU4h/b9/LsH9UvjGWIZJmOnReTjhdsTQrql4P4JN2BCIb32rY2ZY1g3d8goUmLWaIoO/SwoythLDDo+1X8SdgHl93jzMCBLKlgou1XZ7JKEXpy8ZAIF3IlKWz/dFLrz8Y7yWeV1pNmLO+u2P8TZY7sDmJZKHA1vZevL/JkoKu34j9yT47On5y8u2jni021UrsnA9xAb19NoTf5EeHrUApZBwUMlvnaejdPHlNGeBiVegx2jqSni00UXpv46yiEE7HgN/Ekd2L1vo8gnfx3ZkmJwNXn9YFcrNJU/Z7vNDzKL0Bc7nWJTc0tv3O3gQY0mfzdRki9hHczwBhku4kIx3W3H3mu4abH4c4ilO0vZSCjWbWnHTwu6u7sIMFUlJVQirNuef67DU3CZSGu2auuD+9K+9PlRE3Mntg65xjmp+X317bpHpuW5mw8HSzic4hZwb26B+ebnOXHL5idvjz1gTH99O8nGlVQoUglk/UOAwH1RJ2D+ijR01itZO843Nu3hmhB7czi8/+aHgiBpWjYtGN8Dtx5OdAEdB790N3kh8ilGnAvBPNWpcu1rwJsH2aWPMYQMtM6urNeD6MhyNZ4WtaW47y0r3fhN2DaexOUEybIAUQZc5mYdqQC7qLEu+U92fHXJw8PXqW5px/l56I/Fn6/FtxmB49F/m3+aEQz598u0akUWXM7Y3SouDsB2n/NgFXHNYgo5ctsBwMbFjk4WknGgZPWWgyEUOoufRvOS8ZOvdMqeP82Wj89DhLR3w0Tk/40XH6/Pi74/TJyaE4zr/L+Oj4+RpK7SaFzg2XfMq+F1UhVSCTK7SLj4O42yubUehTt0pu8Husz9tZnau1NoXVaaMxp8dJl72YBONSrc0PbTXb2VqD3h2LEWtxD9gvQlyBq0nZKV69+6vgfVh7p0nrXeV7NJVCbeE10l5HB2r76mjrtmK6Itnd170Uxn6v84Vn/o0uR64v8Lfxmz8b3gd6uGd+4IrFFxfgXFWLkl73oavu7ZKT/wwVJ+/vOaMve8QoWfMoyLql2PgtEGcvkGYcsJcTpSu6EnfH6x3LD3asrmR33+90bPwux4Y76R/2OMfvoaD/7+9Bi60esNiBRf7ur1j8Htjk7/Luw/bcYjZll7WlhndgknX1hr/W/l1+ePVBC/m6rLTIKUgeLl7Ed/+D+zB20Ph4pmqibTHdN3pH4sHejGCvoPRsG4ArMuDmZAPPENENVUvImL+1UMvfy9MTDEMFkJEGC+QnFc2DjWoK9o20nT78SxXRyJsNgTg2JPG3IHaY1x/zkYw/+IMYa4e68x2M8zGygJdRgx5kvF7t3q3oeRpjE9EZS7oODvcrRtvAXeX020ESPyTffpG85w1TH2f2r2r7R9u7Fa7B2wB6uCvqHkqRrH5LvUsxf0C9uhbVgs2FgBcM6Q964tN9ejeXGda5o7urySBBtwleIfmfmldWVPjvt2ImuVI1VF9JBsmZ/yemo1zJcuhUxGFbM2nT4HsISISHCSKdA9cDnF7g84m0kCY7e2tKeDs4WF/xQnmPWaeWsqJEJ3wdlNQ87AQSxJWXOH/zdq9xM9Pa6TE7Pv5XxMhnOdLDqARpn7nIbvQtMD/8FYBj4BieM4dwEfKZS5iEYfbZa1i3uTRiwOZiryiYqWehJkUl7KLniSl69ZVseJq+Q0CrqKsXGg6Pyr/23Xo7dvcV6LzNssKz1PMKwXu6knjbhuBqyX9OTSn4leBmkYIEScEMqWQOANxdRnCQWKEMceMHH6T6nKJHJo0qIqUuUEreRkSSPDVQxaQs46YmQWd1G1Rl5nzS9CcUm0arMA0dPMbwFoN3oCRwNoK6ZqfJaXJwfXQQbl0d3IQr0Pntgaf9wY2P/Mn8FkqLg+bifJl1VYDH37mleCnJK5XmYoauqeVy9uAtaVOZ4KWUNwQ/wxRXAO6FeVFhjtAqmCX8DBQw8D6QtIu34Kukk9DFLc+wSvpZDSQJxwQMDtPF1sB4glc9poQDkWIREsZreAfWhgzbQfIWr0V8yQgEYcUAYBAard403tpXVKVknbf1w5KftBHxwekZSf3gD3RFdjo+uWX3GDnFoocO+jxVH7wq3bTzmknzpbF2/TdYyn6/Rg9Ap/zeBS8+XtagddgxA4OhtgyxYw5tglpLl45pd4eeGw/b1S8/3PTQtFNeyX/uTgLgrdJD2hrAyqOa+GXVSelErr/T4eU0lr1lZxfnLW5snhaCs0BUM/N6/FZU1zITkaRonOJY5+0AGx7ksHVAA07xb0jANa7rUm0iUdCB6t5w3jPslRPazF+FO7s4Z7nOajxLod+/uOqRnPKM3Eq/9KOyN6LgPpmEcnZB1Llf/7ORbGhHa2NnXEVw3vts4lBCeMHOX3Yxj0I0ziuv8lJLOH+LQs8NlOuLlNA4GIBnrkKLC7Nwmxsj8Atv7OXHj6N30x4/brQoBnnQoPraqVRXXmPoNP+o/ASceY4+b8ibLpzCg2aVe3Zi4SASvs0QYADgpbSF026qOoOiKN3XNdwYdlrpejJ1sRhHEvfcLfn9PyrX040eXr5yGXPNJM+xYifLNVoh3osZqNMb6TED8qYf9DlMMYwYKay+qGJ8lRuNnMVHFUdLKP05j6JIHsez7h2y/iMgVHps7h5yunhI6ljLAdNyYRNZ3RrNRSU+KhRDAMWrn+ERX6gwazJdilN26dWJ03klrbiMi4JCVOSgLLjEAxOP/hunoHxIrjFn06soySA5bZSUJNxewR8aPSXBMwLec/mQ3NyA3fO+Km5v4fNvtYBA64dPoCVVeLUSxWQuMSSa9z+jFu+ub944pfER67rbHGqrpuZtfWzhdbTElWhLonmBCnQvCPlbuTshFNGTKj8InkPK4lbUeinIH+Jqk+JLR2SIghj10VJujM4kJy6yU9oG0ADKqTrDX6EvsDH+sU0UjN4z7MNMKuT+CPaWYVNeyrSJvP7JAUyjz48ADTiG91eRlcj3lxRPkPTs4jz9c7g7EqjcaPIviFhUu71psRRnb3qAOlnatW1jlf/i/btkkIxcKH+m0Zqp+BwKd/I5LblPdzy9oW83ScHVpKa8AwIJxxNvq7BBZXX/iKqHtpnq5oZavNNXQt3eBh6z8DfmKNz+H/LtXrw= +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"; + + + + + + + + + + +This endpoint allows you to update information for one or more employees for a specific **unprocessed** payroll. You can think of the **unprocessed** +payroll object as a template of fields that you can update. You cannot modify the structure of the payroll object through this endpoint, only values +of the fields included in the payroll. If you do not include specific employee compensations, fixed/hourly compensations, or deductions in your request body, they +will not be removed from the payroll. A maximum of 100 employee_compensations can be updated at a time. Only the employee compensation objects that were +inputted will be returned. + +scope: `payrolls:write` + + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/put-v-1-companies-company-uuid-holiday-pay-policy-add.ParamsDetails.json b/docs/api/put-v-1-companies-company-uuid-holiday-pay-policy-add.ParamsDetails.json new file mode 100644 index 000000000..e5b4000df --- /dev/null +++ b/docs/api/put-v-1-companies-company-uuid-holiday-pay-policy-add.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/put-v-1-companies-company-uuid-holiday-pay-policy-add.RequestSchema.json b/docs/api/put-v-1-companies-company-uuid-holiday-pay-policy-add.RequestSchema.json new file mode 100644 index 000000000..e007e4f44 --- /dev/null +++ b/docs/api/put-v-1-companies-company-uuid-holiday-pay-policy-add.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"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"},{"type":"object","required":["employees"],"properties":{"employees":{"type":"array","description":"An array of employee objects, each containing an employee_uuid.","items":{"type":"object","properties":{"uuid":{"type":"string"}}}}}}]}}}}} \ No newline at end of file diff --git a/docs/api/put-v-1-companies-company-uuid-holiday-pay-policy-add.StatusCodes.json b/docs/api/put-v-1-companies-company-uuid-holiday-pay-policy-add.StatusCodes.json new file mode 100644 index 000000000..5b176fff4 --- /dev/null +++ b/docs/api/put-v-1-companies-company-uuid-holiday-pay-policy-add.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"}}}},"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/put-v-1-companies-company-uuid-holiday-pay-policy-add.api.mdx b/docs/api/put-v-1-companies-company-uuid-holiday-pay-policy-add.api.mdx new file mode 100644 index 000000000..839f008d5 --- /dev/null +++ b/docs/api/put-v-1-companies-company-uuid-holiday-pay-policy-add.api.mdx @@ -0,0 +1,71 @@ +--- +id: put-v-1-companies-company-uuid-holiday-pay-policy-add +title: "Add employees to a company's holiday pay policy" +description: "Add employees to a company's holiday pay policy" +sidebar_label: "Add employees to a company's holiday pay policy" +hide_title: true +hide_table_of_contents: true +api: eJztXFlzGzmS/ivY2gfZESyJpG49rcfHtnrabkVb7t4JtaMEFpIkWlVANYCSxFbov28kjrpYpERZ8mzMzoPDNgvI/ADkhUQCd5EsQFHDpThl0UlUlCa+HsWpzAsqOGj/r0VSlpzFc5lxRhdJgX9kxtNFTBmLBhEDnSpeIJnoJHrDGIG8yOQCQBMjCSWezJYmngYp8I+l8bv4XehUFnBCLpc4cNAnN4obuIwG0W08K7WRMRcGZg51bBYFRCcXEeQTYAxY9HUQaUhLxc0iOrm4i9461m/SFLR+U5p5dHLx9f5rTU3pGzqLTowqYRAp0IUUGnR0cheNh0P8qz06XVpK0zKLBlEqhQFhsBUtioynFtTOHxqb3kU6nUNO8V8OZiQnf0Bq7FDgluZF5hh5mok21JT2l2tQ2vEbTXYPj3ePJsPRYXo4ZYej0cGEMjocHg4Px+PjoUVRL1J0Ek0Oj/b2R0fH8XQ0nsR7u4dH8fHoiMZsPDlmsMvSPaDRIJoCA0WzxM+5ZSvgJlkAVTphdGGRQQapARbmR9Acx/EJbsg/gKotTd7RBUoANfj7j1SUVC3IKLofRHl29QCZj1QZLshPpZmDIn/nYjYgP6rtNs3zOVeMfJQCxYYL4nkgh0KB5gyE6cE7pZmuOZ1VLbfWU/8AExXI55BLxWn20Ch8szbhn6g2DbofqSX5RynAAAgUw9Vof6xb1VNbCiCjYyTCBYMCBAORwgPYThtNO0tVZguyh+QyOpHqoQn8CRu1KXzgqjXEz1AYVEOFRFOZlfmkfHBh3vp2SJq8OhWMz0DIUpMzkKgedrle10w/QypFc8F+To30PK/BgKLiIeH91Tdrj+aTvLbgycgKr5lTcaVn/JqL2Rpa581m9czIUpk5OZ+XSnuYgbydm7ni2uT0IaBvQ7s20neQOqTj/ej+fhBVttbaO28ERindTdl4P94FRuO9o/QgpunRUTwdwuF0cjyio30a3X/F/m379gugVoEw1pQROSWU/OCN9hn+sUY7QuVD32E4tA1WZeu0UX5SWvTP50DSUikQhvhOyMTMgTjruE0+A9j/X/jvXMzIrOQMvr6aG1Pok50dJlO9be33dirznWD944IulMwy+32n7v6fjnSc0QWo12QqFeFiKlXuBynIXN6gqyo1suaaTDlkbNtJctO6PjS8N6QU/M8SiLU2fMpBWXY4Hk+JyBs7JPxp2R0iyz7T3PUgbbY/cW3CNEIG1yCILotCKgOMeHKBmSZUMGzJFWFgKM/00nIuOYIu+3bzWoCrlhMpM6ACh+PEuTtz90Gglz7ct53H92a97FW+++A7jud78297qe/Nvc+9fW8MLZ/4vZl3fef35t/1o9+bf9f3fvf57/rn7wug49OrFlQpFwb0Wv7Qg6Cf0qQUDBShfQ5mEHEDea9TaQ+s3+N5hAr+LLnCUV9Uzr/jLHscWXNkXweR4SZD0j7AiM/wj3eDlsvecG95C/ZJGvJBloJtsgNbQYL8Lgj5XWBUgiMCjQ5TgZalSoEwCZoIaQjccm22yUd6BUSXysUnhZLXnAEjp+92vnw5fUe4Jtc042w7GixNbXO+QCmp7AS0J9z/vrzkKxdsiWpyBdghpQZmUi1W8LCtHoxlPheQYgSjyc0c/JhtdyLTtFR6m5wvCp7SLFu4oOkKFnXco217aozik9LATkEVzdGyEAUZxWk2sibpQq2AegNoSAHbWh2wlIgNMT2psEjaI58pWRZczFwQlFJBJoBRn0UzKXnGSIphZe7bz6lgGUZrXJCFLDFurJIP226TqDWd9WhyF/JZAOJjLkInsjSNSY3JDASqS5hOTzqg1KWa0tQhpYKAYAgcZ87pSjunIKRJplZJGoJ10Vr/yEt8U15OGh0bg4tWKMgNdfphO2z7DUXQ6k/SxFbJ4vfINP7ZSa3X7PF4WS2F9EbKKZx+uoJ/EYWSmFShkwzIe2G4WQRVx6mlCzKnRQECZVvYVZhItkApssvsx0qQPeXCi48mukznhGpyyYVV9aQS8OSaZiVcDoiP9gOFqV1sVoJft6pnlXq7bGx53js2b916cNAb7nkszDitur92Oye7B8mlgiB927+Lfxup/xdGipxOa0Zck0thdThx63g5aGy9yQ3PsiDyhBLXklz6psQv0oLccDMnYJXKK8b/GVuIKAxl1PTmXdsw3gblVrhnpsIQ7Ic0vYAsvCZ7a8cFsTqNOQNrNrxFmmSwTT5IRbwBHrRIWHx2qi7d3wmiurRrG37BeOnSTf+kDiwwjpACfp5ay71+LHmZGV5k4HihHnUUL/y8rGzhywYq3cmJczELnLEbZYzjJ5qdNTi53FYPbzchD0vNJ5pDleRwM2rmtCk2qVQug8/w4MFKQ2OCH+bwZWXuxpGxFJ31niqZ1wQvaoqizLLoa9WuLBIj1zds2bm+BnguAOuaNJzuRy/98W/czOOfBcTO+fmtVW+rj152XFNcmvvBv9f8X2HNkdJKh92eh9/Q+EiR+diL8LVuY5ucGvy5kFpzDLGMJHN6DaSyQ5iFzDSunXcjwVFUZiVKuUrLjKpXDm4rTHwdNUfY0yDqCXonVFwlNE1lKUzCIAMDSSmmuBlmeKiYY1ZvTUA8oRra0fBSsNaKij+UgnEx+whmLhmZU9x3O26k4mbXoAXsGhSfLhIurOimiLSQmj8rsn9gGIBcieeKnhMj9QkQy58D2yZnGVANJJ1DeuWCFIxYPRxCc+yot1cPgWYKKFskgeKLDgCn1zMkEwBRj6MHYM41WqhEydL4NNKqTZBrkYjSns/0QuwE+S2gv7j+xPVHnQhu1+PykpCkUkz5TFfQqlhzo1lb7t0E88YQXFJDpABSB7N5qU0zsOgHFkY7pdoEbUkynnOzBmFP442n8AMi9jSIpUH0XJYZQ8zUz2yFOSlAcclqvCBYErJpK1BWTXqx9c/le8EwHoSG5tgdFKYnyS7JpTBzjTHhtDSlAocvJMC4YKU2apG47CCXIhGUpzpJJYOkDsxWIq5bbz6fn7Avwb494vg4hJ7NywMMogl/ljRDL3JAGJ/xyuysgasDAP0IuJqnru3maD/z1GLVy2D3PFiH1fAcEjmd+uqYBHO/j1vr/EmTmPetbxdEKaxGAav0haapKmmWqPU602q2geV+4/oR7FfN2CRDU46RVYWHhAqfFcDxDMiacJdIWecdO103QfvWKTcDmhp+jZB9BsrucT0GggyInE5DVmcV5iq7/Zhlr1PhG6/9+6q+iip4vARMaEbxVK0sHrCXq731OlRvqbDZQMr+sMvuuOn1y75cVVaFFT4J+HxBhS8Gq8IIG1L0nJGshobZ0ReDVR032Ei6D9iAFD5kU4CyKgWshFq5x+ZZ0vOL4qlr0z2AqnMYFp8UE0kVhuGh3XPOX9BhDPhJxaqC5CAsDeYZEZzb3CPXNtljt6VctLLAmFzueDQXViQgMH+EQZhRNDVSJbgJW4Ot23JzNa0IuP1eHd84LMwqrJVytH1VNWgH/0vGsZ0x9rg5bWzx4CyhUwPK7vUfEwUs99p8/s6quHqrh95WrcZ1asKVwXpFuQZh/ChCavGx+Fvtvwl5i9KDmEPrekuDRw7JTEmtMd0RmAuwm4F1sY5vsXm4A3aPUEUUYV/QgWSjFlyRuSzVYwLDp7m6H5B6Q3MEzKjh190J8jqeoh/MntHenDn6DQCORaUeUyX/ApF4HM9q6TDr49kvbcn9oRvmFk6Ndun0GqMLOxiekNHMgFqBNvFU1u/bvwk412QCaNwqwOGopQPVphq5tgGgB1uKXDI+5dZsB8ghm/mcYMOJUbG02A6Am8nWlDtDqUFdeyuuF9pAXjUKNrwbG1groBNXEvmIOMG1/xYD1KZUa7UgNj3pceb0ludl3sWpS1VQHPMLQn1/mwJgFOEx4EqMhkM7q5mUV2Wxbi5fEFgIuMIegGDtySv9ejtqn33V5zoXnaR7tX2IOrnywD+29z1G4117ot80aJNMplegKudvk25YS7uR8Heo9QbDViJ8INzKA3JBpMLqJiOJKkVQj+7wHe9lnOvHUy2OBlMWLzMo2rog86ThdGCuH1OowjL09iWHhXGhDcBDvbGht8Tye9oYl2E/QhRdTtgViTz7MFtiGCxWyEJ/g1y2QPcPUpfa1sRuFsk8ZlAci1o88aYTfHAINSQHWZcTOyoplpamytmtC82Xuj8lVVcRIYEIqZjXe4hoFeDaK38r2tZxWWf+AjdvjW0KnabzxMwV6LnMWALe+USN87suAl92GrBuPldhXlAEbNrmmvKM+sM8jPizayA2N//m7Q/kPIAjwTM2zo+k1DYZgU7yN66AnIoB+SivgZxLLLR0V4fuv7YcZuPOyMZhU7V9qWtPW2dHNi9GjYG8sJtYvNthQzpC63qOEoUTQw5ZmlhOY/vdEwzbTD4T1EiFqT3Ks8el9SjPnpLSozxrbnS7AMK+O2TH5lQn1dfnz6a409zqwAMXt+JGbHmQB1SJgYIcV9wenYfkQd1lAlMkhnUCOOlEwA0SDYEevwWWMK4npdJgD5Pqc+sVA2u23kD7GrmFcG7VG/2s0b1VJB5RSPmuAbpTOjl44eGxIZvS8XgcUzY8iveAHsZ0eEDjw9HhwdFRujsZHR6vGXSgltvT7qfE/u6Az/Wv/KezGifkHcezcPLOHT4PyFs8lN6OurMSUPi7sk9G4foH0+ciagztizbKLR9tuyP+re1gw/5Z5bWDaMoF1/PEZznRu2IhgQu9XiAn7SfI7fGNRM02pGbeyQlm0kUxiSX9UBSmjQIwyWjzVfyIwsNFmpUMLbojhLZFgdZLMpO6EqVv42GJdCm7Kp3NXS92w6n1WeIbJcWM+N13l8dfvHiCmDuTDMLYayBOvv/ihTt0fQXbs20yGu/u7b/uUbG5FPDkeogz7B2qIYKSj4atg1KsOMh4ui7T0Ks8rHQV4LDq6LGhOnh8Z+agG+W9dbLKHeF0NvCPSWT3wlpfR3DevCpS12TY1XfrgrXZLlIOOp7Jm0Z5g63lWlfcUO/tn5xNQJahmq8rEM0cwfMwqAbpPZmLYfXDPt83fLw7tFx8oB2sFCqaXuPp8Lvt86QdCNYEAyP2E9nyfbbqmwR4yQFUzo0JrXTwKhOqefrCu3Nqy/yC/Q7Rpg0yNtvCCgCmG37IbwN74o8wbze+OHzF6OznjSf8NywLD3ZmZo9FlQ9ZVV2oMawc1RK6F8zR20hidZK8k3N2CDCHT2xlemrCJW7CbHCULbon/N4chTG4E9Bnz0N3ih8akB1D1jnNWlcuho9GJE8reHEPTohO2cuStWLWP0yTCVf2AY0Nubyz5+pTYrtXW2PvQW3ZhAsArc153DFtVQv6lCDeB++HYwp7B6PDmFF6HO8BO4yP9mEYj46A7bMhwNHu/hqTZk/DnrApzTJKPnDz1wxTccxW/FI05rhdI6iwVobnndMwDRgj2i1iddTsJ6Fno/PMMzVmh5PpwTiNJ3QyjffoaBwfjY/H8e7eEMbsOKWT8dGamXqaFTrVlNM5+RuojItqmnBesoWdoht/e+VxMxRiahDaxdNV3mN93c7qWq21Jaw+Gm1KerPoshdJtbkUa+tDW82evFvD3p0dI8Ej2AH5DeAKU03CzO3VO3yWqAd1SJpUtveZt0qB0TprLxsOtX1TsnVbMV5R7B5uXYM2f5PMBoR1NspdtHj0ZUmaZStuFT36WRdfdx+dRPsHbDhMR4dHk/Rw93h3Mqbj4QGwA3p0QKfpZO+f+QYMZ5AX0oBIFxu9+7Lihnvjzvqv7ie7Yr80fdHa64/N2++dazGPvvL/xp+Rtq79O3Z6QICm8xBs+vRm68Rx+1keAED5tY+lhP2MUyP/ctH/xP9t31Z7c3Ya/1olaDmCnwNlNk5dehytlixR5jhZ4+F4Px4exKN9nC0GU1pmBg18/fvS80XvEEvOhb90if46Rn1m5M3ZaSVsVGuZcnvAb/eJ9tIkNsB7ovbGpEAjw+sytoFr09CqLU0uci7s0XCD9obySQseN94p8gTjxs+vEQZe/nQbdT/DnYcW7NQW1D0YtqRr9nECr2C+Y0sunfFYtSD3+FqeoTNc4WjpKSh/pfA21gXQK6B6EdvrqzbmsG3P6KJq2W6IY4nlNSjFmRV3xt43ChHh1oDQdruHsuWM88pHAO3lq7LzGCDOWLufe+6vaoxDbzbqjqJq2Dea/o7tUdUEWqPDOfWJVPvsIuoeLt9JtHM92qlK7nbumgt9v7Nc5rnjnmC0JR9eCUuVIV4vhrTgTgpjBrkVxSUZeQe57CyNoxe7vDF+xrGuINxL80zZHPEqmgV+vm881vgZpc+ZnZ4nGyuZRObBeNiXVoAqa066N3stidheQiMUHxgUpjphHUSfbVnMt3BwFFYwwDeUtBS/1N76ffCWzbcdH+E4ex93C4rpkleu9iK4JWt40SCh5FWcGiZzEKGF1D9PP4O65ik0VrQ2VvY+9o5tuMNwiOgWYvt/PCjTvuvSHULIUpnb80OLY0uT914XSShZQ1vJZFrm4Y25//CvPFCXD/QG7l3gSn7Bm/g+6ePO1lAk/df/qiXQuiOJD/eIBp0NXyPtDumujqle7mFTL3kGbs1OkVFuRdQq2523ChfR9ah6XscZ0pOOC1g2De5WLlrnudQGidzdoS/8orL7e/z5zxIwvL34ikZK2YI2K2aM20C0fqxx5ZS8CpHPa7La0fQOL0Q4tkUwkZG/GNt2b67A3cUNm8H7l44GVkysm8D+CKya59pzvXWTFZ+3fOjy9qHugVazMGvbNp3b2ZfzaBBN/I4ll9bTK3qDEQi9cYsesrq4pcHf7qKMilnptleOJGo3bVvqyjL7fzS2M22xurtzLc7lFYj7+0rKDP7fbsXu/xeTT+iT +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"; + + + + + + + + + + +Add employees to a company's holiday pay policy + +scope: `holiday_pay_policies:write` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/put-v-1-companies-company-uuid-holiday-pay-policy-remove.ParamsDetails.json b/docs/api/put-v-1-companies-company-uuid-holiday-pay-policy-remove.ParamsDetails.json new file mode 100644 index 000000000..e5b4000df --- /dev/null +++ b/docs/api/put-v-1-companies-company-uuid-holiday-pay-policy-remove.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/put-v-1-companies-company-uuid-holiday-pay-policy-remove.RequestSchema.json b/docs/api/put-v-1-companies-company-uuid-holiday-pay-policy-remove.RequestSchema.json new file mode 100644 index 000000000..e007e4f44 --- /dev/null +++ b/docs/api/put-v-1-companies-company-uuid-holiday-pay-policy-remove.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"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"},{"type":"object","required":["employees"],"properties":{"employees":{"type":"array","description":"An array of employee objects, each containing an employee_uuid.","items":{"type":"object","properties":{"uuid":{"type":"string"}}}}}}]}}}}} \ No newline at end of file diff --git a/docs/api/put-v-1-companies-company-uuid-holiday-pay-policy-remove.StatusCodes.json b/docs/api/put-v-1-companies-company-uuid-holiday-pay-policy-remove.StatusCodes.json new file mode 100644 index 000000000..5b176fff4 --- /dev/null +++ b/docs/api/put-v-1-companies-company-uuid-holiday-pay-policy-remove.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"}}}},"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/put-v-1-companies-company-uuid-holiday-pay-policy-remove.api.mdx b/docs/api/put-v-1-companies-company-uuid-holiday-pay-policy-remove.api.mdx new file mode 100644 index 000000000..3a1ef3f83 --- /dev/null +++ b/docs/api/put-v-1-companies-company-uuid-holiday-pay-policy-remove.api.mdx @@ -0,0 +1,71 @@ +--- +id: put-v-1-companies-company-uuid-holiday-pay-policy-remove +title: "Remove employees from a company's holiday pay policy" +description: "Remove employees from a company's holiday pay policy" +sidebar_label: "Remove employees from a company's holiday pay policy" +hide_title: true +hide_table_of_contents: true +api: eJztPGtzGzeSfwU390F2FUciqbc+ndePi7Kxo4rl5LYU1wgcNElEM8AEwEhiVPrvV43HvDikRFnyXu3tB5dtDtDdaPQbDdxFsgBFDZfilEUnUVGa+HoUpzIvqOCg/b8WSVlyFs9lxhldJAX+kRlPF7GCXF5DNIgY6FTxAiFFJ9Ev9mcCeZHJBYAmUyVzQokHt6WJh0UK/GNh/S5+FzqVBZyQyyVMHPTJjeIGLqNBdBvPSm1kzIWBmaM+NosCopOLCPIJMAYs+jqINKSl4mYRnVzcRW8d6jdpClq/Kc08Orn4ev+1hqb0DZ1FJ0aVMIgU6EIKDTo6uYvGwyH+1V6iLi2kaZlFgyiVwoAwOIoWRcZTS9TOHxqH3kU6nUNO8V+OzEhO/oDU2KXALc2LzCHyMBNtqCntL9egtMM3muweHu8eTYajw/Rwyg5Ho4MJZXQ4PBwejsfHQ0tFvVnRSTQ5PNrbHx0dx9PReBLv7R4excejIxqz8eSYwS5L94BGg2gKDBTNEs9zi1bATbIAqnTC6MJSBhmkBljgj6A5ruMT3JB/AFVbmryjCxQDavD3H6koqVqQUXQ/iPLs6gEwH6kyXJCfSjMHRf7OxWxAflTbbZjnc64Y+SgFig0XxONADIUCzRkI00PvlGa6xnRWjdxaD/0DTFQAn0MuFafZQ6vww9qAf6LaNOB+pBbkH6UAAyBQDFdT+2M9qmZtKYCMjhEIFwwKEAxECg/QdtoY2tmqMluQPQSX0YlUDzHwJxzUhvCBq9YSP0NhUA0VAk1lVuaT8sGNeevHIWjy6lQwPgMhS03OQKJ62O16XSP9DKkUzQ37OTXS47wGA4qKh4T3Vz+svZpP8toST0ZWeM2ciis949dczNbAOm8OqzkjS2Xm5HxeKu3JDOAtb+aKa5PThwh9G8a1KX0HqaN0vB/d3w+iytpae+eNwCiluykb78e7wGi8d5QexDQ9OoqnQzicTo5HdLRPo/uvOL9rwlGrQBhryoicEkp+8Eb7DP9Yox2h8qEPMRzaBquyddooz5QW/PM5kLRUCoQhfhIiMXMgzjpuk88A9v8X/jsXMzIrOYOvr+bGFPpkZ4fJVG9b+72dynwnWP+4oAsls8x+36mn/6cDHWd0Aeo1mUpFuJhKlftFCjKXN8RIUmpEzTWZcsjYtpPkpnV9aHlvSCn4nyUQa234lIOy6HA9HhKRN3ZJ+NOyO0SUfaa560HaaH/i2gQ2QgbXIIgui0IqA4x4cAGZJlQwHMkVYWAoz/TSdi45gi769vBagKuREykzoAKX48S5y7n7INBLH+7bzuN7o172Kt998R3H873xt73U98be596+Nw0tn/i9kXd95/fG3/Wj3xt/1/d+d/53/fP3JaDj06sRVCkXBvRa/jCDoJ/SpBQMFKF9DmYQcQN5r1NpL6zf43kKFfxZcoWrvqicf8dZ9jiy5sq+DiLDTYagfYARn+Ef7wYtlr3h3nIK9kka8kGWgm2Sga0AQX4XhPwuMCrBFYFGh6lAy1KlQJgETYQ0BG65NtvkI70Cokvl4pNCyWvOgJHTdztfvpy+I1yTa5pxth0Nlljb5BcoJZVlQJvh/vflLV+5YUtQkyvACSk1MJNqsQKHHfVgLPO5gBQjGE1u5uDXbKcTmaal0tvkfFHwlGbZwgVNV7Co4x5tx1NjFJ+UBnYKqmiOloUoyCiy2cgapAu1AtUbkIYQcKzVAQuJ2BDTgwqbpD3lMyXLgouZC4JSKsgEMOqz1ExKnjGSYliZ+/FzKliG0RoXZCFLjBur4sO2SxK1prMeTe6SfBYI8TEXoRNZmgZTYzIDgeoS2OlBByp1qaY0dZRSQUAwJBw553SlXVMQ0iRTqyQNwbpo7X/kJb4pLyeNiY3FRSsU5IY6/bATtn1CEbT6kzSxVbL4PSKNf3ZS6zV7PF5WSyG9kXIKp5+u4F9EoSQWVegkA/JeGG4WQdWRtXRB5rQoQKBsC7sLE8kWKEV2m/1aCaKnXHjx0USX6ZxQTS65sKqeVAKeXNOshMsB8dF+gDC1m81K8PtWzaxKcJeNlOe9Q/PW7QcHvWHOY8mM02r6a5c52RwklwqC9G3/Lv5tpP5fGClyOq0RcU0uhdXhxO3j5aCRepMbnmVB5AklbiS59EOJ36QFueFmTsAqlVeM/zO2EKkwlFHTW3dtk/E2KLfCnJkKQ3AewvQCsvCa7K0dF8TqNNYMrNnwFmmSwTb5IBXxBnjQAmHps6y6dH8nSNWl3dvwC8ZLl479kzqwwDhCCvh5ai33+rXkZWZ4kYHDhXrUUbzw87KyhS8bqHSnJs7FLGDGaZQxjp9odtbA5GpbPbgdQx6Wmk80h6rI4Thq5rQpNqlUroLPNDHSSkODwQ9j+LKyduPAWIjOeuPJRg3wooYoyiyLvlbjyiIxcv3Alp3rG4DnArBuSMPpfvTSH//GzTz+WUDsnJ9PrXpHffSy44bi1twP/r3n/wp7jpBWOuw2H35D4yNF5mMvwte6jW1yavDnQmrNMcQykszpNZDKDmEVMtO4d96NBEdRmZUo5SotM6peOXJbYeLrqLnCngFRT9A7oeIqoWkqS2ESBhkYSEoxxWSY4aFijlW9NQHxhGpoR8NLwVorKv5QCsbF7COYuWRkTjHvdthIhc3uQYuwa1B8uki4sKKbIqWF1PxZKfsHhgGIlXis6DkxUp8Asfg5sG1ylgHVQNI5pFcuSMGI1ZNDaI4T9fbqJdBMAWWLJEB80QUgez1CMgEQ9Tp6CMy5RguVKFkaX0ZalQS5EYko7flML4mdIL9F6C9uPnHzUSeC2/V0eUlIUimmfKYr0qpYcyOuLc9uEvPGENxSQ6QAUgezealNM7DoJyysdkq1CdqSZDznZg2FPYM3ZuEHpNjDIBYG0XNZZgxppp6zFc1JAYpLVtMLgiWhmraCympIL239vHwvGMaD0NAcm0FheZLsklwKM9cYE05LUypw9IUCGBes1EYtElcd5FIkgvJUJ6lkkNSB2UqK69Gb8/MTziU4t0ccH0ehR/PyBAbRhD9LmqEXOSCMz3hldtaQqwMB+hHkap66sZtT+5mnlla9TOyeJ9bRangOiZxOfZdMgrXfx+11/iQm5n372yWiFFajgFX6QtNUlTRL1HqdaQ3bwHK/cfMIzqs4NsnQlGNkVdFDQofPCsLxDMiacFdIWecdO1M3ofatU24GNDX8Gkn2FSib43oaCCIgcjoNVZ1VNFfV7cdse10K33jv31cdVlTB4yVgQjOKp2pl8YC9XO2t11H1lgpbDaTsD7vtDptev+3L3WVVWOGLgM8XVPhmsCqMsCFFzxnJatKwOvpiZFXHDTaS7iNsQAofsilAWZUCVpJaucfmWdLzi+KpG9M9gKprGJY+KSaSKgzDw7jn5F/QYQz4SYWqIsmRsLSYZ6Tg3NYeubbFHpuWctGqAmNxuePRXFiRgMD6EQZhRtHUSJVgEraGtu7IzdW0AuDyvTq+cbQwq7BWytH2VV2hHfpfMo7trLHHzWljmwdnCZ0aUDbXf0wUsDxrc/6dVXH1Vg+8rVqN69KErVMSryjXIIxfRSgtPpb+1vhvorwF6UGaw+g6pcEjh2SmpNZY7gjIBdhkYF2s40dsHu6AzRGqiCLkBR2SbNSCOzKXpXpMYPg0V/cDQm9ojoAZNfy6yyCv4yn6wewZ7c2Zg98gwKGo1GOq5F8gEk/Hs1o6rPp49EspuT90w9rCqdGunF7T6MIOhidkNDOgVlCbeCjr8/ZvIpxrMgE0bhXB4ailQ6otNXJtA0BPbClyyfiUW7MdSA7VzOckNpwYFUub7QhwnGyx3BlKDeraW3G90AbyalCw4d3YwFoBnbiWyEfECW78txigNqRaqwWx5UlPZ05veV7mXTp1qQqKa35BUt/fpgAYRXgacCdGw6HlaiblVVms4+ULEhYCrpADEOw9eaVfb0fts6/6XOeiU3Sv0oeoUysP+GN772M03rUn+k2DNslkegWqcv626Ia9tBsJfwdabzBsJcIHwq06IBdEKuxuMpKoUgT16C7f4V6mc/16qs3RYMriZRZFGWtckXnScjpkrl9T6MIy9PYll4VxoQ3AQ7+xobfE4nvaGpfJfoQoupqwaxJ59mW2xDBYrFCF/ga5bBHdv0hdatsTu1kk85hFcWxq8cCbTvDBJdQkOZJ1ObGrkmJpa6qa3brQfGn6U0p1FRASgJAKeZ1DRKsIrr3yt1LbOi7r8C9g89bYltBpOk/MXIGey4wl4J1P1Di/61Lg204DrZvzKvAFRcCWba4pz6g/zMOIP7sGYmvzb97+QM4DcSR4xsb5kZTaFiPQSf7GFZBTMSAf8S7gucRGS3d16P5ry2E27oxsHDZV6Uvde9o6O7J1MWoM5IVNYvFuhw3pCK37OUoUTgw5ZGliOY3tdw8wpJl8JqiRCkt7lGePK+tRnj2lpEd51kx0uwSEvDtUx+ZUJ9XX56+muNPc6sADN7fCRmx7kCeoEgN3KdQdnYfiQT1lAlMEhn0CyHQi4AaBhkCP3wJLGNeTUmmwh0n1ufWKhTVHb6B9jdpCOLfqjX7W6N4qEI9opHzXILrTOjl44eWxIZvS8XgcUzY8iveAHsZ0eEDjw9HhwdFRujsZHR6vWXSAltvT7qfE/u6Az82v/KezGifkHcezcPLOHT4PyFs8lN6OulwJVPi7sk+mws0Pps9F1BjaF20qt3y07Y74t7aDDftntdcOoikXXM8TX+VE74qNBC70eoGatGeQy/GNRM02pEbeqQlm0kUxiQX9UBSmjQIwyWjzXfyIwsNFmpUMLboDhLZFgdZLMpO6FqVvw2GBdCG7Lp3NXS9OQ9b6KvGNkmJGfPbdxfEXL54g5s4kgzD2GoiT77944Q5dX8H2bJuMxrt7+697VGwuBTy5H+IMZ4duiKDko2HroBQ7DjKerqs09CoPK10HOKw6emyoDh7fmTnoRntvXaxyRzidBP4xhexestb3EZw3r4rUPRl2992+YG+2i5SDjmfyptHeYHu51jU31Ln9k6sJiDJ083UFolkjeB4E1SK9J3MxrH7Y5/uBj3eHFosPtIOVQkXTazwdfrdznpSBYE8wMGI/kS0/Z6u+SYCXHEDl3JgwSgevMqGapy+cnVPb5hfsd4g2bZCxWQorAJhu+CGfBvbEH4FvN745fMXq7OeNGf4btoUHOzOzx6LKh6yqbtQYVo5qiboXrNHbSGJ1kbxTc3YUYA2f2M701IRL3ITZ4ChbdE/4vTkKa3AnoM9eh+40PzRIdghZ5zRrXbsYPhqRPK3hxT04ITptL0vWiln/ME0mXNkHNDbE8s6eq0+JnV6lxt6D2rYJFwBam/O4Y9qqF/QpQbwP3g/HFPYORocxo/Q43gN2GB/twzAeHQHbZ0OAo939NSbNnoY9ISnNMko+cPPXDEtxzHb8UjTmmK4RVFgrw/POaZgGjBFtilgdNXsm9CQ6z8ypMTucTA/GaTyhk2m8R0fj+Gh8PI5394YwZscpnYyP1nDqaVboVFNO5+RvoDIuKjYhX7KFZdGNv73yOA6FmBqEdvF0VfdY37ezuldrbQurj0abkt5suuylpEouxdr+0NawJ2drOLuTMRI8gh2Q3wCusNQkzNxevcNniXqoDkWTyvY+c6oUEK2z9rLhUNs3JVu3FeMVze7h1jVo8zfJbEBYV6PcRYtHX5akWbbiVtGjn3XxfffRSbR/wIbDdHR4NEkPd493J2M6Hh4AO6BHB3SaTvb+mW/AcAZ5IQ2IdLHRuy8rbrg37qz/6n6yO/ZL0xetvf7YvP3euRbz6Cv/b/wZaevav0OnBwRoOg/Bpi9vtk4ct5/lAQCUX/tYSshnnBr5l4v+J/5v+7bam7PT+NeqQMuR+DlQZuPUpcfRaskSZY7MGg/H+/HwIB7tI7cYTGmZGTTw9e9Lzxe9Q1pyLvylS/TXMeozI2/OTitho1rLlNsDfpsn2kuTOADvidobkwKNDK/b2AZuTEOrtjS5yLmwR8MN2BvKJy143HinyAOMGz+/RjLw8qdL1D2HOw8tWNYW1D0YtqRr9nECr2B+YksunfFYtSH3+FqeoTPc4WjpKSh/pfA21gXQK6B6EdvrqzbmsGPP6KIa2R6Ia4nlNSjFGdjkGgvI7xu9iHBrQGib8aF4Ofu88h1Ae/+q7LwHiExrz3Mv/lWDcfXNQd2FVAP7FtQ/sb2wGkB3gchZX061jzCiBuImnkQ716OdqvFu56653fc7y82eO9WDjLb3w2tjqTKk2ssjLbgTx5hBbmVySVjeQS47e+Tgxa6AjJ9xxSsA98I8U7ZYvApmgZ/vG682fkYxdPan5+3GSjgRebAi9skVoMrale4VXwsitrfRCMWXBoWpjloH0WfbH/MtGByEFQjwMSUtxS+1234f3GbzkcdHeNDeV96ChroqlmvCCP7JWmC0TCh/FaaG7RxEaCr1z9PPoK55Co0dra2WvZi9YwfuMFwi+ofY/h9PzLSfunSZELJU5vYg0dKxpcl7r5Ek9K6h0WQyLfPw2Nx/+OceqCsMekv3LmAlv+CVfF/9cYdsKJL+63/VEmj9ksQXfEQDzlPeJu2u666OsF74rVMvgwZuzU6RUW6F1ardnTcRF9H1qHpxx9nWk45XWLYT1uxbS/EVP2uDcO7u0EN+Udn9Pf78ZwkY9F58RbulbJublTnGbXhaP+G4kjWvQjz0mqx2P70rDHGPHRGsZuSvy7adnmt7d9HEZuT9S8cIKxjrGNgfl1V8rp3ZW8es+LzlVpeTinoGmtDCrB3bdHZnX86jQTTxeUwunf+nNyig9MZteqj1YqKDv91FGRWz0iVdDiSqOm2b7cpM+380kpy2WN3duRHn8grE/X0lZQb/bxO0+/8Fc0T2Lg== +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"; + + + + + + + + + + +Remove employees from a company's holiday pay policy + +scope: `holiday_pay_policies:write` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/put-v-1-companies-company-uuid-holiday-pay-policy.ParamsDetails.json b/docs/api/put-v-1-companies-company-uuid-holiday-pay-policy.ParamsDetails.json new file mode 100644 index 000000000..e5b4000df --- /dev/null +++ b/docs/api/put-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/put-v-1-companies-company-uuid-holiday-pay-policy.RequestSchema.json b/docs/api/put-v-1-companies-company-uuid-holiday-pay-policy.RequestSchema.json new file mode 100644 index 000000000..f4a35ddf4 --- /dev/null +++ b/docs/api/put-v-1-companies-company-uuid-holiday-pay-policy.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"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"},{"type":"object","description":"Request body for creating or updating a holiday pay policy","properties":{"federal_holidays":{"type":"object","description":"An object containing federal holiday objects, each containing a boolean selected property.","properties":{"new_years_day":{"type":"object","properties":{"selected":{"type":"boolean"}}},"mlk_day":{"type":"object","properties":{"selected":{"type":"boolean"}}},"presidents_day":{"type":"object","properties":{"selected":{"type":"boolean"}}},"memorial_day":{"type":"object","properties":{"selected":{"type":"boolean"}}},"juneteenth":{"type":"object","properties":{"selected":{"type":"boolean"}}},"independence_day":{"type":"object","properties":{"selected":{"type":"boolean"}}},"labor_day":{"type":"object","properties":{"selected":{"type":"boolean"}}},"columbus_day":{"type":"object","properties":{"selected":{"type":"boolean"}}},"veterans_day":{"type":"object","properties":{"selected":{"type":"boolean"}}},"thanksgiving":{"type":"object","properties":{"selected":{"type":"boolean"}}},"christmas_day":{"type":"object","properties":{"selected":{"type":"boolean"}}}}}},"title":"Holiday-Pay-Policy-Request"}]}}}}} \ No newline at end of file diff --git a/docs/api/put-v-1-companies-company-uuid-holiday-pay-policy.StatusCodes.json b/docs/api/put-v-1-companies-company-uuid-holiday-pay-policy.StatusCodes.json new file mode 100644 index 000000000..5b176fff4 --- /dev/null +++ b/docs/api/put-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"}}}},"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/put-v-1-companies-company-uuid-holiday-pay-policy.api.mdx b/docs/api/put-v-1-companies-company-uuid-holiday-pay-policy.api.mdx new file mode 100644 index 000000000..3c9e5fafa --- /dev/null +++ b/docs/api/put-v-1-companies-company-uuid-holiday-pay-policy.api.mdx @@ -0,0 +1,71 @@ +--- +id: put-v-1-companies-company-uuid-holiday-pay-policy +title: "Update a company's holiday pay policy" +description: "Update a company's holiday pay policy" +sidebar_label: "Update a company's holiday pay policy" +hide_title: true +hide_table_of_contents: true +api: eJztXFlzGzmS/ivY2gfbESyJpG49rcfHtnratsKWu3dC7SiDhSSJVhVQDaAksxX67xuJoy4WKVGmPBuz8+CwzQIyPySQBxIJ3EayAEUNl+KMRadRUZr4ehSnMi+o4KD9vxZJWXIWz2XGGV0kBf6RGU8X0SBioFPFCyQRnUafC0YNEEp8x2ea+F6kwD+21+/id6FTWcAp+bpEk4M+vVHcwNdoEH2LZ6U2MubCwMzhjM2igOj0MoJ8AowBi74MIg1pqbhZRKeXt9Erx/plmoLWL0szj04vv9x9qakpfUNn0alRJQwiBbqQQoOOTm+j8XCIf7XHpEtLaVpm0SBKpTAgDLaiRZHx1ILa/UNj09tIp3PIKf7LwYzk5A9IjR0KfKN5kTlGnmaiDTWl/eUalHb8RpO9o5O948lwdJQeTdnRaHQ4oYwOh0fDo/H4ZGhR1NMSnUaTo+P9g9HxSTwdjSfx/t7RcXwyOqYxG09OGOyxdB9oNIimwEDRLPEyt2wF3CQLoEonjC4sMsggNcCCfATNcRzv4Yb8A6h6pslrauedGvz9ZypKqhZkFN0Nojy7uofMO6oMF+SX0sxBkb9zMRuQn9VOm+bFnCtG3kmBy4YL4nkgh0KB5gyE6cE7pZmuOZ1XLZ+tp/4WJiqQzyGXitPsvlH4Zm3Cv1BtGnTfUUvyj1KAARC4DFej/bluVYu2FEBGJ0iECwYFCAYihXuwnTWadqaqzBZkH8lldCLVfQL8BRu1KbzlqjXET1AYVEOFRFOZlfmkvHdiXvl2SJo8PxOMz0DIUpNzkKgedrpe1Ew/QSpFc8I+pEZ6ntdgQFFx3+L91Tdrj+a9vLbgycguXjOn4krP+DUXszW0LprNasnIUpk5uZiXSnuYgbyVzVxxbXJ6H9BXoV0b6WtIHdLxQXR3N4ggLzK5ADQll7eRNwKjlO6lbHwQ7wGj8f5xehjT9Pg4ng7haDo5GdHRAY3uvmD/tn37CKhVIIw1ZUROCSU/eaN9jn+CqS8UegvDoW2wKlunjfJCadG/mANJS6VAGOI7IRMzB+Ks4w75BGD/f+m/czEjs5Iz+PJ8bkyhT3d3mUz1jrXfO6nMd4P1jwu6UDLL7Pfduvt/OtJxRhegXpCpVISLqVS5H6Qgc3lDjCSlRtZckymHjO24ldy0rvcN7yUpBf+zBGKtDZ9yUJYdjsdTIvLGDgl/WnaHyLLPNHc9SJvtL1ybIEbI4BoE0WVRSGWAEU8uMNOECoYtuSIMDOWZXprOJUfQZd9uXi/gquVEygyowOG45dyV3F1Y0Esf7trO40ezXvYqP3zwHcfzo/m3vdSP5t7n3n40hpZP/NHMu77zR/Pv+tEfzb/re3+4/Lv++ccC6Pj0qgVVii7vsYLlDz0I+ilNSsFAEdrnYAYRN5D3OpX2wPo9nkeo4M+SKxz1ZeX8O86yx5E1R/ZlEBluMiTtA4z4HP94N2i57A/3l7dg76Uhb2Up2CY7sBUkyO+CkN8FRiU4ItDoMBVoWaoUCJOgiZCGwDeuzQ55R6+A6FK5+KRQ8pozYOTs9e7nz2evCdfkmmac7USDJdE25QVKSWUF0Ba4/315yldO2BLV5AqwQ0oNzKRarOBhW90by3wqIMUIRpObOfgx2+5Epmmp9A65WBQ8pVm2cEHTFSzquEfb9tQYxSelgd2CKpqjZSEKMopiNrIm6UKtgHoDaEgB21odsJSIDTE9qTBJ2iOfKVkWXMxcEJRSQSaAUZ9FMyl5xkiKYWXu28+pYBlGa1yQhSwxbqySDztuk6g1nfVochfyeQDiYy5CJ7I0DaHGZAYC1SWI05MOKHWppjR1SKkgIBgCR8k5XWnnFIQ0ydQqSWNhXbbmP/IrvrleThsdG4OLVijIDXX6YTvs+A1F0Or30sRWyeI3yDT+4Fat1+zxeFkthfRGyimcfryCfxaFkphUoZMMyBthuFkEVUfR0gWZ06IAgWtb2FmYSLbAVWSn2Y+VIHvKhV8+mugynROqyVcurKon1QJPrmlWwtcB8dF+oDC1k81K8PNW9aySbV8bW543js0rNx8c9IZ7HgszTqvuL9zOye5BcqkgrL6d38W/jdT/CyNFzqY1I67JV2F1OHHz+HXQ2HqTG55lYckTSlxL8tU3JX6SFuSGmzkBq1ReMf7P2EJEYSijpjfv2obxKii3wj0zFYZgP6TpF8jCa7K3dlwQq9OYM7Bmw1ukSQY75K1UxBvgQYuExWdF9dX9nSCqr3Zuwy8YL3114p/UgQXGEVLAh6m13OvHkpeZ4UUGjhfqUUfxws/Lyha+bKDSnZw4F7PAGbtRxjh+otl5g5PLbfXwdgK5f9W8pzlUSQ4nUTOnzWWTSuUy+EwTI+1qaAj4fg6fV+ZuHBlL0VnvqZJ5TfCypijKLIu+VO3KIjFyfcOWnetrgOcCsK5Jw+m+86s//o2befxBQOycn99a9bZ659eOa4pTczf495z/K8w5UlrpsNty+A2NjxSZj70IX+s2dsiZwZ8LqTXHEMtIMqfXQCo7hFnITOPceTcSHEVlVqKUq7TMqHru4LbCxBdRc4Q9DaKeoHdCxVVC01SWwiQMMjCQlGKKm2GGh4o5ZvXWBMQTqqEdDS8Fa62o+G0pGBezd2DmkpE5xX2340YqbnYOWsCuQfHpIuHCLt0UkRZS860i+weGAciVeK7oOTFSnwCx/DmwHXKeAdVA0jmkVy5IwYjVwyE0x456Z/UQaKaAskUSKD7pAFC8niGZAIh6HD0Ac67RQiVKlsankVZtglyLRJT2fKYXYifIbwH96PoT1x91Irhdj8uvhCSVYspnuoJWxZobSW25dxPMS0NwSg2RAkgdzOalNs3Aoh9YGO2UahO0Jcl4zs0ahD2NNxbhW0TsaRBLg+i5LDOGmKmXbIU5KUBxyWq8IFgSsmkrUFZNerH1y/KNYMTWL9SaY3dQmJ4keySXwsw1xoTT0pQKHL6QAOOCldqoReKyg1yKRFCe6iSVDJI6MFuJuG69uTzfY1+CfXuW48MQejZPDzAsTfizpBl6kUPC+IxXZmcNXB0A6AfA1Tx1bTdH+4mnFqteBrvvwTqshueQyOnU18MkmPt92FznjxJi3je/XRClsBoFrNIXmqaqpFmi1utMq9kGlvul60ewXyWxSYamHCOrCg8JFT4rgOMZkDXhLpGyzjt2um6C9pVTbgY0NfwaIfsMlN3jegwEGRA5nYaszirMVXb7IdNep8I3nvs3oSuhCh6+AiY0o3iqVhb32MvV3nodqldU2GwgZX/YaXfc9PppX64jq8IKnwTcXlDhi8GqMMKGFD1nJKuhYXb0yWBVxw02ku4DNiCFD9kU4FqVAlZCrdxj8yxp+0vxzLXpHkDVOQyLT4qJpArD8NBum/ILOowBP6lYVZAchKXBbBHBhc09cm2TPXZbykUrC4zJ5Y5Hc2FFAgLzRxiEGUVTI1WCm7A12LotN1fTioDb79XxjcPCrMLaVY62r6r/7OB/yji2M8YeN6eNLR6cJXRqQNm9/kOigOVem8vvvIqrn/XQe1arcZ2asHlK4hXlGoTxowipxYfib7X/LuQtSvdiDq3rLQ0eOSQzJbXGdEdgLsBuBtbFOr7F5uEO2D1CFVGEfUEHko1acEbmslQPCQwf5+p+QuoNzREwo4ZfdwXkdTxFP5ht0d6cO/oNAI5FpR5TJf8CkXgcW7V0mPXx7Je25P7QDXMLZ0a7dHqN0YUdDE/IaGZArUCbeCrr9+3fBZxrMgE0bhXgcNTSgWpTjVzbANCDLUUuGZ9ya7YD5JDN3CbYcGJULE22A+Ak2RK5M5Qa1LW34nqhDeRVo2DDu7GBtQI6cSWRD4gTXPvvMUBtSrVWC2LTkx5nTr/xvMy7OHWpCopjfkKob76lABhFeAw4E6Ph0Eo1k/KqLNbJ8gmBhYAr7AEI1p481y92ovbZV32uc9lJulfbh6iTKw/8Y3vDYzTesyf6TYM2yWR6Bapy/jbphrW0Gy3+DrXeYNiuCB8It/KAXBCpsLrJSKJKEdSjO3zHexnn+vFUk6PBlMXTDIqyOjTVjxtOB+b6MYUqLEO/PeWwMC60AXioNzb0G7H8HjfGZdgPWIouJ+yKRLY+zNYyDBYrZKG/Y122QPcPUpfa1sRuFsk8ZFAci1o88aYTvHcINSQHWZcTOyoplqamytmtC82Xuj8mVVcRIYEIqZjXe4hoFeDaK38v2tZxWUd+gZu3xjaFTtN5YuYK9FxmLAHvfKLG+V0XgS87DVg3l1WQCy4Bm7a5pjyj/jAPI/7sGojNzb989RO5COBI8IyN8yMptU1GoJP8jSsgZ2JA3slrIBcSCy3d1aG7Ly2H2bgzsnHYVG1f6trT1tmRzYtRYyAv7CYW73aE24hVPUeJixNDDlmaWE5j+90TDNtMPhPUSIWpPcqzh6X1KM8ek9KjPGtudLsAwr47ZMfmVCfV1+1nU9xpbnXggZNbcSO2PMgDqpaBghxn3B6dh+RB3WUCUySGdQIodCLgBomGQI9/A5Ywriel0mAPk+pz6xUDa7beQPsauYVwbtUb/azRvVUkHlBI+boBulM6OXji4bEhm9LxeBxTNjyO94EexXR4SOOj0dHh8XG6NxkdnawZdKCW29Pux8T+7oDP9a/8p7Map+Q1x7Nw8todPg/IKzyU3om6Ugko/F3ZR6Nw/YPpcxE1hvZFG+UzH227I/5nO8GG/bPKawfRlAuu54nPcqJ3xUICF3o9QU7aC8jt8Y1EzTakZt7JCWbSRTGJJX1fFKaNAjDJaPNZfIeLh4s0KxladEcIbYsCrZfWTOpKlL6PhyXSpeyqdDZ3vdgNReuzxDdKihnxu+8uj7948Yhl7kwyCGOvgbj1/Rcv3KHrc9iZ7ZDReG//4EWPis2lgEfXQ5xj71ANEZR8NGwdlGLFQcbTdZmGXuVhpasAh1VHjw3VweM7MwfdKO+tk1XuCKezgX9IIrsX1vo6govmVZG6JsPOvpsXrM12kXLQ8UzeNMobbC3XuuKGem//6GwCsgzVfN0F0cwRbIdBNUjvyVwMq+/3+b7hw92h5eID7WClUNH0Gk+H322fR+1AsCYYGLGfyDPf51l9kwAvOYDKuTGhlQ5eZUI1T594d05tmV+w3yHatEHGZltYAcB0ww/5bWBP/BHkduOLw1eMzn7eWOC/YVl4sDMzeyyqfMiq6kKNYeWoltA9YY7eRhKrk+SdnLNDgDl8YivTUxMucRNmg6Ns0T3h9+YojMGdgG49D90pfmhAdgxZ5zRrXbkYPhqRPK7gxT04ITplL0vWiln/ME0mXNkHNDbk8tqeq0+J7V5tjb0HtWUTLgC0Nudhx7RVLehjgngfvB+NKewfjo5iRulJvA/sKD4+gGE8OgZ2wIYAx3sHa0yaPQ17xKY0yyh5y81fM0zFMVvxS9GY43aNoMLaNTzvnIZpwBjRbhGro2YvhJ6NzpYlNWZHk+nhOI0ndDKN9+loHB+PT8bx3v4QxuwkpZPx8RpJPc4KnWnK6Zz8DVTGRSUmlEu2sCK68bdXHiahEFOD0C6ervIe6+t2VtdqrS1h9dFoc6U3iy57kVSbS7G2PrTV7NG7Nezd2TESPIIdkN8ArjDVJMzcXr3DZ4l6UIekSWV7t7xVCozWWXvZcKjtm5Kt24rximL3cOsatPmbZDYgrLNR7qLFgy9L0ixbcavowc+6+Lr76DQ6OGTDYTo6Op6kR3sne5MxHQ8PgR3S40M6TSf7/8w3YDiDvJAGRLrY6N2XFTfcG3fWf3U/2Rn72PRF6+/NfGwUBFlAtpILh4dFcpiidOmx3ov77cnZ/JmYlyLc9PPRKPLqPA/jW+gBAZrOmw0p8e8akJB7rm4E7jzlCzJbew9m26+7bPetlm2+vLL9d1S2+CrKdt842e6LJdt9f2TLr4l4J7D61YzYWxfrXuxqD+kG5+X8w2L/E/+3ffrw5flZ/Gt1fsLRQsyBMruNXHq7sDb8oszRJo6H44N4eBiPDtAsMpjSMjMYf9W/L70u9hqx5Fz4O9EYTsfobhl5eX5W+QKqtUy5rb+xaRx7pxkb4DVue6FZYAzA6yrTgWvTcHrPNLnMubCVGw3aG7oPWvC48YyYJxg3fn6BMPButsujeQl33kGxoi2oe89vyRXat0O8//MdW5d3nW9fNSF3+JiloTOc4WjppTZ/4/dbrAugV0D1Ira3y+2WwLY9p4uqZbshjiWW16AUZ8jQV42j6zcgtM3D4KpyUdPK1zntrciy80onyqrdz73DWTXGQTcbdfFXDfvG0d+xPZ6agB8XytGfbdi3T1E1ccpOo93r0W5VBbt725zcu93ed1BtBZZXulJliNIvO1pwt+piBrldektr4jXksjMVjl7sjnHwM45wBeFemufKHtmsolng57vG26mfcLU5i9Tzgmq1BpF5MBbWVAFV1nx0L9pbErG9E0oovvcpTFXwMIg+2Sq17+HgKKxggI5VS/GxDp7fhOC1+dTqA+LYRzyauu4l1HveMA3d175DuuZVUf/5/vdCV78C6r+ufs7TN1j/9ua9D2re/yqmD2lcoVnwgNaNoXlHba7mseGABhH6G/1h+gnUNU+hoS+16bePT+zahrsMFxD649j+H6sCtO+6dGEaslTmtljC4nimyRtv30ioz0XPw2Ra5uFBzf/wT9pQd/jh3cXrwJV8xGdHfIbbFRKgwvuv/1Xrt3XuEuUlGnQe9OBydyC39bZx2y82ex028M3sFhnlVtmt2br1tvUyuh5V74Y5F3TacZ49BvYL/qoNdr+9xfjhs8ru7vDnP0vAHfvlFzTvytboWiPMuN1b1+/PrhTB87CZe0FWO+fegYXr9bZFcC6Rv+vfDgncnR0Xa20G7186glohWCfA/qi1knPt8185YcUXrehjOSNS90DPU5i1bZvBwfnni2gQTXwSJpc2OlL0BqM2euMmPRxUYZYGf7uNMipmpcsYOZKow7Tt7Srv5v/RyNC0l9XtrWtxIa9A3N1Vq8zg/134/7/Z4KFe +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"; + + + + + + + + + + +Update a company's holiday pay policy + +scope: `holiday_pay_policies:write` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/put-v-1-companies-company-uuid-signatories-signatory-uuid.ParamsDetails.json b/docs/api/put-v-1-companies-company-uuid-signatories-signatory-uuid.ParamsDetails.json new file mode 100644 index 000000000..dc587f8c1 --- /dev/null +++ b/docs/api/put-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/put-v-1-companies-company-uuid-signatories-signatory-uuid.RequestSchema.json b/docs/api/put-v-1-companies-company-uuid-signatories-signatory-uuid.RequestSchema.json new file mode 100644 index 000000000..08487cef9 --- /dev/null +++ b/docs/api/put-v-1-companies-company-uuid-signatories-signatory-uuid.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"required":true,"content":{"application/json":{"schema":{"type":"object","description":"Request body for updating a signatory. Email cannot be updated.","properties":{"version":{"type":"string","description":"Current version of the signatory (required for optimistic concurrency)."},"first_name":{"type":"string"},"last_name":{"type":"string"},"title":{"type":"string"},"phone":{"type":"string"},"birthday":{"type":"string","format":"date"},"ssn":{"type":"string","description":"The signatory's SSN."},"home_address":{"type":"object","properties":{"street_1":{"type":"string"},"street_2":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"zip":{"type":"string"},"country":{"type":"string"}}}},"required":["version"],"x-tags":["Signatories"],"title":"Signatory-Update-Request"}}}}} \ No newline at end of file diff --git a/docs/api/put-v-1-companies-company-uuid-signatories-signatory-uuid.StatusCodes.json b/docs/api/put-v-1-companies-company-uuid-signatories-signatory-uuid.StatusCodes.json new file mode 100644 index 000000000..c0da2fd84 --- /dev/null +++ b/docs/api/put-v-1-companies-company-uuid-signatories-signatory-uuid.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"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"}}}},"409":{"description":"Conflict","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"}}}},"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/put-v-1-companies-company-uuid-signatories-signatory-uuid.api.mdx b/docs/api/put-v-1-companies-company-uuid-signatories-signatory-uuid.api.mdx new file mode 100644 index 000000000..82b49e14a --- /dev/null +++ b/docs/api/put-v-1-companies-company-uuid-signatories-signatory-uuid.api.mdx @@ -0,0 +1,74 @@ +--- +id: put-v-1-companies-company-uuid-signatories-signatory-uuid +title: "Update a signatory" +description: "Updates a signatory that has been either invited or created. If the signatory has been created with minimal information through the [Invite a signatory](ref:post-v1-companies-company_uuid-signatories-invite) endpoint, then the first update must contain all attributes specified in the request body in order to start the identity verification process." +sidebar_label: "Update a signatory" +hide_title: true +hide_table_of_contents: true +api: eJztXVtz2ziy/is4nIckVaJtKb4/bSaXXW9VJqk4OXO2EhcNkS0JExLgAKBtjeP/fqobAElRl1iOcy5bfEjNmMTlQwN9Rbd4GxlIKy3sPDr9fBu9VEXJ5fxFmoIxLyo7i04/X9xdDKIMTKpFaYWS0Wn0qcy4BcM4M2IquVV6zuyMWzbjho0BJANhZ6CZkFfCQsaUZqkGbiHbYWcTZmfQ6ll38k3YtbAzVggpCp4zISdKFxxnZnamVTWdUf/PZzR2G8PFUw2T01IZG18N45TWIsD4/5snVSWyOLTGFw7eMwYyK5WQdoAjSxp+IrSxrKKFsqIylqVKWi4k43nOuLVajCukgSkhFRMBGROup4Y/KzCWjVU2x2dKZ6CZVcxYri01ERlIK+ycXYEWE5G61ZVaIdl3vsgv8pdf2AfIiRrTSmRgvsiYfT6vafb6CqQ1F08zlZ7W64+Bnj7DAUyqSjhll63lnl5rYeEyGkQ38bQyVsVCWphqmj228xKi088RFGPIMsiii6adNtd8Gp1aXcEg0mBKJQ2Y6PQ2Gu3t4X8Wj8d5RednUuXRIEKygbTYipdl7he7+4fBpreRSWdQ8OUxPhIlSw0GpHX0URPGmd/LJ6bZ9mgQOfCRGv8BqcW/hc3xwXmrzU1s+dTgEs8bmuAqS61K0Fa4FeEhwf/6IY3VQk6ju0FEJyKRvIDm9efwfhDJKs+ji7tBlPN7NfMQNzUpZ0p+pwkUXOQr4Y6FtrOMzzf3FybhWSFka4ixUjlwGXWZ/vcZEE8rzaSyHR4WhvHcKHpa8rlWyCQ4MO4aPvT7toPQZtwkxtxnzjOZ4YEBw6797Muig0t2fv4bctrf8bDSDFegjVBymTDdCfCYpZXWIC3znQLiepYddg7gZI5vIuTUseXF05m1pTnd3c1UanaIW3ZSVewGLoo9Mej9rsigKJUFmc6fsYnSC8JNSTZT1ygoKoPTCcMmAvKMFhQkRtKWGImx3FZ0armcv5uQCO+uF2RV4N6/58ZEg+gNnpdBdP5VlCUy+d2g7kKHYlnYf2OM0b8v8lscx/Tvi/yWJOc0e5J8Y0nyqumSJNSU4YTsG2tkVsolEZUkKK7buIYIqdsQTxi1bbXzmNc2faN0wY4PDw5YJa3InRjHZ8KwgsuK5/mcVWWueAYZ44ZdgyV1gGPiBEgA9o2dbZLOdORwSqexVFHmgFL6Gx1sVUDCs0yDMW2+q+WS47uuyDFWA9hkuJKP/cvRypcpKe6VvbiFlW/+EuXqoVQlrV4xGp6HCa9yi4r//EV0d3d3h1rgz0poyHB5JDJJXcANR4KExYuU50kjp2vpGh2Nh9leNhnGh/t7z+N9vncYHx8dHsfpMMuOstF+Njri0aLIjX5V42hBukb/VBJMS9q/fP0uqqVmtD88ONw7GI6e70e1nIzGavw3DxL5NGrLyWh4crwX7x3He9ijkYxO7dVCy/1ZS5gIhuMsO94/4Psnz9Oj/ZO948kxDA+yw+Fwf3h4gqA3c2/NjN0DhKcF9zIQMEHDqH2+PDWP0xEMYTKKjw6G+/HBeHgUnxwfncTZCOAYnh/A8+Nxl5ofeDqDvEPQv2sACS2KvpNjxXWG8o7sHJ4LYxdpfHDQpbGmodeSGVfVJu+E56ZNX/93Q+AMJvsHh98loxu3y4INb0UHowM22rMzdk7PojZvRS9Ku8OGUWCp6JxL9kZzmQqTqqhmqOjli8jzUHSyP9w7ilqcU7MHccj+3v6yWfObsuyNqmSGNtrHxlqEjGkwqtIpsEyBEzFwI4zdYW/5V2Cm0k4HlVpdCRRgnz6dvULRdsVzke18kQ+3tWpQ7Itk7Edxnb3aXYS2wj5rSw/QWukVhph/3sgjrjVHQ05YKNrP14+afAXsgBbEFAXQ6jmo1XcthXNv55Mp4tdM3ZlK00qbHfbRCbx87pT3V5h7Q596YfvabdgtueYFWNBMezPfqmZIUvk16i2g4QjYFm0YNxIjC8cPFTbJeORTrapSyCkaURnp5zGg9UFoxpXIM5aiSVP49jMusxyFgZBsriq0X2oHgjAXYAyfrlA8XcjvA5AMLBe5YXysKtsiasymIEE35PRDB5Sm0hOeOqRcogeHwJFyjvsWdZFUNpngCW8frM8L+x/5E98+L6etjq3FRWsY5NqbBtRhJ7q7uGvsfGSymJgsfo2Txu/cqQ2y4mSZLV8qOckFnewHMvYn6a0WPs6BvSbhGVicjCK0oMsSJJ5p572S16ombnuDK+tdX39sDDNVOkMD6lJIYvGkPtjJFc8ruBygl9B2hie0yVkFfr/qnsiNtJjLlpn92k3z0u2DALOlnU0w47Tu/sxZ62RyF0pDOHVOavbC6d9fOGHUqZ5IGHYpiXcTt4+XFPhhbq/YtcjzJtrDXEt26Zsyv0lzF6byroJ7+X9GBiIKyzNu+aqjuCRmHHNryOGKS8uwH47pD8jcc7KXckIy4ml0ikhseIk0zmEHfTDmBe9gYQjCR6S69EYcorqkvQ1P0Jy9dOQfNwYF2g9KwqJ7u2YtRZVbUebg5hLkHSwwXni8zGzhzRYsvTi3EXIaZsZuPMsEvuL5+9ZMzntYMbcjyPdPzW+8gBCi8BSl0GtzbFKlXYwuM8zHQ1oE/v4Mn6T4s4JGPGiSm818LsJC0nuiVbE5wOTaVWVi1eaGC3JuVYOOS7vcpKVs3/rTH/8u7Cx+JyF2yi+6W9/qrT87riluTSs20u/5/+M9p0DpOoXdCXKi8FEynzsnh4mNamOHnVl8XCpjBJpYVrEZv8ILAy+HcriC3ODeeTUSFEUtVqJU6LTKuX7q4C6Yh8+i9gpXNIhWGLtjLr8mPCW3NMkA41NJJSeVzCBLSj4v8JJggyE85gYWreAlY23BGn5TSYwQvAU7UxnFx8JsrJ6N9mABGPnw80RIOropIi2VEY+K7F9oBuCszM8a4oVj8ME9vJB6nwM3wNIZpF+dkYIWq4fDeIEdzc76JfBcA89CVAI2+Rg/vgCKeLsJXQiyXscKgIUwKKESrSqLbLPB+XEtElkVY9CrIXaM/AWgH1x/5vojTwS163H5k5CkSk7E1NTQaltzK6ot926DeWEZbqllSuJtRDBm6RavZVisBhZWO8G4WHiZi0LYDQhXNN6ahG8QsR+D0RjMzFSVZ4iZe8rWmJMStFBZgxdklmReWq5BWTdZiW01LV/LjNEdaMM55EHZGZfsOSuUtDODNuGkspUGhy9cuAqZVcbqeWIgh5SidZKL1CSpyiBpDLO1iJvW29PzN+zLsO+K43g/hH6anw8wHE34s+I5apFDlompqMXOBrgmADD3gGtE6tpuj/ZcpITVLIPd92AdVisKSNRkkpQqF+mcYsv32+viQUQsVu1vF0QliaMgq/mFp6mueJ7ozTyz0GwLyf3C9WO6zh8YAxvnKMrRsqrxMAIowKwBXgIp18QHUjZpx07XbdC+dMydAU+tuELIbgzn43oMDCdgajIJUZ11mKEoczUHMPfZ9rrx9nv/OnRlXMP9T8CY51ymkLjkjgdp602oXnJJUUCe/UHb7mYzm7d9pnKRoVTHfw5wMCvIEH1Mq8gn+dRmBJkUzCNADeQ3fz00jIr+NFj1NQNZ0quADVjpTTZKGEI1vxZqrR7rY/ZTjuKZa8PCEAzdLtOKYRA+5a7ToIHzmPQLPIwGP6unqiE5CEuLeUQEHyn2KCglw7mlK1KiOhrNmRUJSIwfoRFmNU+t0gk6YRuwdVtuz6b1AM7fa+wbhyUjhqVTjrKvzibr4P+ZdmxnjSvUHKWU4QB8YkGTr38fK2C51/b0e1/b1U9WjPekYeMmNEFxSuYZBVPV/CpCaPG++Bfa/xDyhZG+izm0blwavHJIploZg+GOMLkEcgY22Tq+xfbmDpCPUFsUwS/oQCKrBXdkpip9H8PwYaruHzh6i3MkTLkVV10CeR5PUQ/mjyhv3vtEswaAm6Jmj4lWf4FMPI5HlXQY9fHTL7nk/tKNkl2tceH0BqMzOygnlucW9Bq0iR9ls9/+Q8AF5t2icKsBh6uWDlQKNQpDBqAHW8lCZWIiSGwHyCGa+Zhgw41RubTZDoCj5ALJnaA0oK+8FDdzY6GoGwUZ3rUNSAqYxKXk3cNOcO1/RAAtjtRwtWQUnvQ4C34jiqro4jSVLjmu+SdCfX2TAqAV4THgTgz39oiquVJfq3ITLX8isGBwBR+A0mGemmc70eLdV3Ov87kTdK/dh6gTKw/zx5QvPhw9p5v8tkAb5yr9CrpW/hR0w1zOrQ5/Z7SVxjCdCG8IL8QB24nlupKBPbrLd3Mv49y8nnpzDNiq/DmL4lljmpqHLacDc/OaJpDhVWpi+c3PXFbICGV+Pmb5DaP5HrbGZdj3OIrt/LhHX+bCMQwSK0Shf+BcLoBevUhTGYxFbBliv8+iBCa1+MHbSvC7S2ggOcimGtOqlFzamjpmt8k0X+r+kFBdPQgLg7B68saHiNYBbrTyj6JduC7r0C/M5qUxhdB5OkvsTIOZqTxLwCufqHV/10VAy4Ia6/a0CnTBI0Bhmysucu4v89Diz6+AUWz+xct/sI8BHAuasXV/pJShYAQqyd+FBnYmB+ytugL2UWGCpWavOF1HthVmq1Rha7Opdl/CIJ27I4qLcWuhKMmJxdoCV9HEm3yOCg8nmhyqsrGaxPTeDxjczDoDmXJ87xfWc4UGW4f0sBhALB3SGkDwu0N0jNKG2xnmjxtNcbe59YUHbm6r6EU2BUn1MdBQ4I7T1XkIHjRdxjDBwTBPAInOJFzjoMHQEzeQJZkw40oboMuk5t56zcLarbfgvlZsIdxbrbR+NvDeuiHukUD5qgW6kzI5+MnLw7oDPhqNYp7tHcf7wI9ivnfI46Ph0eHxcfp8PDw62bDoMFpBt90Psf3dBZ/rX+tPJzVO2SuBd+Hslbt8HrCXeCm9E3WpElD43PcHo3D9g+hzFjWa9uUiyife2nZX/E92ggz730qrxVoGKcwsUXV9AiUSONPrJ8SkPYGcj28VcrZlzeSdmGCufGkCDf09K6yuUNh6F9/i4REyzauM6mBpIBaKH7pnJnUpSj82Bw3SHdll6WyverEbktZHia+1klPmve/uHFhysf0xdyIZJPraIYr3lyjdpetT2JnuMCxeOXi2gsWwxOXB+RDvsXfIhghMPtxbuChNQ373lsyTVS4DHNZdPbZYB6/v7AwMtEuWQ7DKXeF0HPj7BLJXwtqcR/CxXSLS5GTQ7rt9wdxsZykHHs/VdSu9wfpat7XJDY1v/+BoAk4Zsvm6B6IdI3icCepFek3mbFjzfZ3vG95fHdIs3tAOUooqKzdoOnxPfR7kgWBOMGSMXrEnvs+TppJAKlaCLoS1oZUJWmXMjUh/snfOKc2vLm7z1iYZGdu5sBIgMy095N3AFfZHoNu1Tw5fszp6vTXBf8e08CBnpnQtqr3JqptEjb1aUS2h+4kxerIk1gfJOzFnhwBj+Iwy01PLTFWWSluWkXGUz7s3/F4chTW4G9BHj0N3kh9akN2EWec2a1O6WFOJuX2aGP0wheykvSxJq4z0wyShusvtZ3lF9+oTRt1r19hrUEqbcAYgyZz7XdPWuaAPMeJD3fCIw/7h8CjOOD+J9yE7io8PYC8eHkN2kO0BHD8/2CDS6DbsAU5pnnP2Rti/phiKyyjjl6MwR3eNIcPSGZ51bsMMoI1ILmJ91eyJsMLReWRKjbKj8eRwlMZjPp7E+3w4io9HJ6P4+f4ejLKTlI9Hxxso9TApdGa44DP2K+hcyJpMSJd8TiS69tUr96NQsKlBGmdP13GPzXk763O1Nqawemu0fdLbSZcrkdTOpdyYH7rQ7MHeGvbueIwMr2AH7HeArxhqknZGpXf/Ar4KdQia1LL3kV2lMNEmaa9aCnWxQnKhWjFek+yOxZKj0X1LHftCx3ahY19F2leR9lWkfRVpX0XaV5H2FYV9FWm/530VaV9F2leR9lWkfRVpX0XaV5H2VaR9FWlfRdpXkfZVpH0VaV9F2leR9lWkfRVpX0XaV5H2VaR9FWlfRdpXkfZVpH0VaV9F2leR9lWkfRVpX0XaV5H2VaR9FWlfRXr/mHRfRdpXkfZVpH0VaV9F2leR9lWkfRVpX0XaV5H2VaR9FWlfRfo/XkWKaTQBwBme9LKy8dUwrhM04mDgUAAjhF7wRRNF8kZcbYe65ftvKbf7Y56+pA0kKbr8CXr6YK4vzfAdF2qOXO1HU6DZ+Xo3SgE/7RK6+0/cBMAeNvV/xX/HSrr4xfuz+D/rUCLNPwOekUW1bpzmO/WjvdFBvHcYDw+ii/anx1vP77oreYXUL4T05YGoWWI8eRl78f4sRCEZN0algq6iyaOh8j5sgBWNVNsnkR1Ek3A1cG1axbJPDPtcCEmXmK2xt6ws5aWIfU8hp7/4AePW42cIA8sU8XgPgqv0q8rIeenuzr0LezfXIX1oJVi5REMM87oQY304dpiLri7d76Nlu1id1ApKb64bellpjaIp7FT3QLKnYcUECx2XAoOimEssU+qczsn7XvjI+Yqv3Le+dr7irZchK974D56veNN82Hx5lSEHIHK2ziCiD5x/jxof20t/Ytj5+W+0tO6nzbubuUj85sPnK0A3Hz5f8TL1LvKKXgt1VK039EH0VUOFT6Mvy427u8WiynBYLrAQyfIpCtPovJG7+CLI+PB4Hn+isxf7k+uHXdP7JjYl8K/AzTzGIxCrK9BaZDiiz+IdRHBjQRryi1GYOy12ExNHx61a4NiHCJyexaJQz+kR2WSL/bS55tOmMTJtu9E6WHWHAA9FgQ8Zk8Yi5WNn0Wm0ezXcrXXX7m1b+dzttrTX7u2igrhDmYwpLl55VTpHce2FGS+Fk2VxBgUJtKXD+goKFS3S1o0Xuzg5vsa1rhl45ZjvNcXE141Z4mskhYG00sLOz1G+uVPv/fQXKVoALyqkTX30cPKggvDvMXBNSqlbyUxDxFR0x3hlZxhpCTfKg+ic0oB+ZAY3wpoJ7gYRyu0PjcR/7aryFiRqS8a0BF7ztCXnmoeBfeoHXqo1Dxphhvp2P947ikcnkZdbTbOuJGpkTdOmETHNMydZ2m1IoDQPSI602gfx0TI3opAhE1ZDRgcqY+SXmj4tc2EQoXVg3k3OQV+JFFrnsFHUVDW/Sw13M9wYlKUx/Y3XmcZ3Xar0hDxVBd3yEo4nhr32goCFxEK0EzKVVmh90yb/h/8tDu6itn6bXoVZ2Qf8vQQfmnM3oMhI/u3fGr5BapTK2ILL1jifwt1s255bQH3bGAy+tWk3d1XBaHyT0Q3CzjDGKq+ETzh0CfMZmUyLerru5Js4Q4vsG54z3DlUiKji7Uyrajpzv9RxRmO3MVw81TA5xcXd0yp38J7hzxeUSkhLv8XgbgSIQ8KVtQ/g+Z9lyPN2RNv4H5nIVmWcLwT0KFeZmrhaZztn7cST4Kjs4C/Q/PKL21DI3O+HmC8yZp9rFcZeYw6zuXiaqfS0Xn9Mmc3mGQ5gUlXCKbtsLff0WgsLl83Pjli4sbtlzgWJKBK2t143fI6u6FYo0DAaRKcd56Q1Mr7t+BAXyPDG4ki3t2hWf9L53R0+/rMC5M7PF6ipNGVxkhbJBHlfWXQ64bmBDcfv6QdvAjxj6/2glWsMBdjUIujJyFeDL3pfqH8eBVKbox4AqkNXV2ziPKPtqPZv7e+sIa0j4Wofs6Z0Y1W9dMSKPy6YacvuUdMDNXppN7Ztm1/vP31Ehek9skKRGan5NTrP/Npte7hhQZcNn91GOZfTyoU63JAow/miFVFbDf5/Wj9Ysniwbm9di4/qK8i7u/qcWfybwiJ3/w1P9VSr +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"; + + + + + + + + + + +Updates a signatory that has been either invited or created. If the signatory has been created with minimal information through the [Invite a signatory](ref:post-v1-companies-company_uuid-signatories-invite) endpoint, then the first update must contain all attributes specified in the request body in order to start the identity verification process. + +## Related guides +- [Signatory Events](doc:signatory-events) + +scope: `signatories:write` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/put-v-1-companies-company-uuid-tax-requirements-state.ParamsDetails.json b/docs/api/put-v-1-companies-company-uuid-tax-requirements-state.ParamsDetails.json new file mode 100644 index 000000000..e91e4b0df --- /dev/null +++ b/docs/api/put-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"},{"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/put-v-1-companies-company-uuid-tax-requirements-state.RequestSchema.json b/docs/api/put-v-1-companies-company-uuid-tax-requirements-state.RequestSchema.json new file mode 100644 index 000000000..8fe08f3c1 --- /dev/null +++ b/docs/api/put-v-1-companies-company-uuid-tax-requirements-state.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"required":true,"content":{"application/json":{"schema":{"type":"object","x-examples":{"example-1":{"requirement_sets":[{"key":"registrations","effective_from":null,"state":"GA","requirements":[{"key":"71653ec0-00b5-4c66-a58b-22ecf21704c5","value":"1233214-AB"},{"key":"6c0911ab-5860-412e-bdef-6437cd881df5","value":"474747-22"}]},{"key":"taxrates","effective_from":"2022-01-01","state":"GA","requirements":[{"key":"e0ac2284-8d30-4100-ae23-f85f9574868b","value":"0.05"}]},{"key":"depositschedules","effective_from":"2022-01-01","state":"GA","requirements":[{"key":"6ddfcbeb-94d3-4003-bfc2-8c6e1ca9f70c","value":"Semi-weekly"}]}]}},"properties":{"requirement_sets":{"type":"array","items":{"type":"object","properties":{"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."},"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."},"state":{"title":"State","type":"string","description":"One of the two-letter state abbreviations for the fifty United States and the District of Columbia (DC)"},"requirements":{"type":"array","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":{"type":["string","null"]}}}}}}}}},"examples":{"Example":{"value":{"requirement_sets":[{"key":"registrations","effective_from":null,"state":"GA","requirements":[{"key":"71653ec0-00b5-4c66-a58b-22ecf21704c5","value":"1233214-AB"},{"key":"6c0911ab-5860-412e-bdef-6437cd881df5","value":"474747-22"}]},{"key":"taxrates","effective_from":"2022-01-01","state":"GA","requirements":[{"key":"e0ac2284-8d30-4100-ae23-f85f9574868b","value":"0.05"}]},{"key":"depositschedules","effective_from":"2022-01-01","state":"GA","requirements":[{"key":"6ddfcbeb-94d3-4003-bfc2-8c6e1ca9f70c","value":"Semi-weekly"}]}]}}}}}}} \ No newline at end of file diff --git a/docs/api/put-v-1-companies-company-uuid-tax-requirements-state.StatusCodes.json b/docs/api/put-v-1-companies-company-uuid-tax-requirements-state.StatusCodes.json new file mode 100644 index 000000000..c524bc3e4 --- /dev/null +++ b/docs/api/put-v-1-companies-company-uuid-tax-requirements-state.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"OK"},"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/put-v-1-companies-company-uuid-tax-requirements-state.api.mdx b/docs/api/put-v-1-companies-company-uuid-tax-requirements-state.api.mdx new file mode 100644 index 000000000..a6b5fccc6 --- /dev/null +++ b/docs/api/put-v-1-companies-company-uuid-tax-requirements-state.api.mdx @@ -0,0 +1,71 @@ +--- +id: put-v-1-companies-company-uuid-tax-requirements-state +title: "Update State Tax Requirements" +description: "Update State Tax Requirements" +sidebar_label: "Update State Tax Requirements" +hide_title: true +hide_table_of_contents: true +api: eJztXFlzHDeS/ivY2gdJEV1kd/MUn1bWMcOYkKUwpfVO0IoiqpDVjVEVUAZQTbYZ/O8biaOuPsimyIeZkB227C4g8SGRyAsJ3EY38azWRsZcGJgpargUsVlWEJ1dRlCmwBiw6NsoYqAzxSv8Hp1FXytGDZALg//+Qm/Ib/BnzRWUIIz+Q/whdCYrOCNXmSwrKpaJoTeJ6rQ5u1bcwFU0iiqqaAkGlI7OLm8jQUuIzqLQr645i0YRx0EraubRKPJkWHRmVA2jSGdzKGl0dhs53JE2iotZdDcE/WUO5OvX83dE5sTMgfgxorvR7TYiHpHGud4DpT/eNC7AGFDk6wWxvQlNUwULbrlsh/W0/y/+m12EN5/P4/8FpfGzH2kOlIHqjZXTQq8M9g5ZWHIB2s4NlydOqQZG3nw+JwtHlFCtZcapAUauuZmTpayVbZDRotgj5zkRUgDhmlRKLjgDNnJtaFUVPLPAX2hyWXLBy7rs0v72cm5Mpc/295nM9J6Vqr1MlvtBiuKKLpUsCvt9n1Y89j25mP23Jxh3fn6FMGoNbC/avMijCERdorBOx9OjeHwcT46cuOa0LgyuQvv73d23UWToDCUtGkot9pIVuC1wznCRaxMvJrETEw467gplPJToOAiIAl1JoUEj2ul4jH/01+rTP1CuDseHq59+lYZ8kLVg5A9ByB8CZRZHAY1rpkDLWmVAmARNhDQEbrg2e+Qj/Q5E1wrs4oe1c9LONVnQgrO9P4QddjpdHfarqJTMQGuaFkDeC8PNskHANSnpksxpVYEg13MQdpRUsiVuJSsfHiPJpDCUC01AKak00XU2J1STKy4siIQao3haG0gWtKjhakSksuQChZzyQhNWAzGSUNH2bBbnao9cgJvp5Xs3zFtqYCYVB72jGFqYcdZ0f0VmNWdAcqlIKRUQBgYBIfNGEc4OhEH+dTbE/r80MrGrRO7n7k/mDpnrN7ZM/wWZ6Sm8y8hNGLdopRCq4W57+d9btUCVokvUnQbK7u+bqSbfATt4lMsNY9hWa7RPf6EvKsh4zkHjQvrNaLsTmWW10nvky7LiqGuXxODSf4cl4QyEcb2wfbOG+41lJAoKq7ONbEnu4WZuUO8ADSlgWxQvR4mglgmkgvbwUkZmStYVFzNNqGAko4KkYNUyoklrXjCSoRyUvv2cClZwMSNcOOnteBbWwjQDcU2uhFVsiVvHq5EF59aKXPOiCCJPKHEtyZVvSvwiLZ0hA6ey3EfLmhL32wzu58znMF8vjYSmsjadtYvJDASodtU86cAMXaucZo4hVBAQDPmjPApDGTV0nSj2YbwNm1tBAQsqDNpwijS9gCz9TvYmgAti9zSadas2vEZKC9gjH6QicEPLqoBRj4TFZ1l15f5MENWVXdvwC5q3K8f+tDUmaIWlgE+5ddO2z6WsC8OrAtxYuI8GGy/8vLrZwpcdtnR/bM3FLIyM3ShjHD/R4nNnJOevrRnbMeR+qfmVlhAcSc9RM6ddscmkcq4A08RIKw0dBt8/wlfB/6yhVQ/K6s12PEvRae9cybIleNlSFHVRRN+adnWVGLm9YU/PrWvg3JwtTe5GkeGmwJl99NIf/87NPP4kIHbGL7rb3Oqjlx3XFJcGHeWfa/7vv+ZIaaPB7vPhd1Q+UhRL5+ASvtVs7JFzY2MWqTVHF8tIMqcLII0eKmABhca182YkGIpGrUQZV1ldUPXSwY2t8xN/sgL3KurOcE0DJ9A3sde5doIpFd8TmmWyFiZhUICBpBZ5LRiwpKJLF3V0nJjLnq8RYfTWdUzOohVnLeqYuehDLRgXs49g5pKROdUkjEaa0ewa9IAtQPF8mXBhRTdDpJXU/EmR/RPdAByV+FHRcmL0kgKx43Nge+RzAVQDyeaQfXdOCnqsHg6hJXZE075pCrRQQNkyCRSfdQLIXj8gSQFEO481AEuuUUMlStYGt81mYL5FIuoytVH/GogDJ78H9DfXn7j+uCeC2fW4vCQkmRQ5n+kGWuNr7sS11d5dMG8MwSU1BFMKrTNb1tp0HYv1wMJsc6pN2C1JwUtutiBc03hnFn5AxJ4GsTSInsu6YIiZes42mJMKFJesxQuCJcxryw0omyZrsa3n5XvBbE6ns3NsBGXmVJADUkph5hp9wrw2tQKHL+QruGC1NmqZaCggQ+lOBOWZTjLJIGkds42I29a78/NX7Euw7xpxfBhCP8zzAwyiCX/WtEArckwYn/FG7WyBqwMA/QC4mmeu7e5oL3hmsepVsIcerMNqeAmJzPOkkgXPlgmmGh+21uWjmFiuW98hiFrYHQWs2S80y1RNi0Rt3zO9Zjto7jeuH8F+DcfSAlU5elYNHmIBctAbgFdgjWviEynbrOOg6y5o37rNzYBmhi8QsqPhYlyPgeAAROZ5yOpswgxlVcglgH7IsjeNd1/796EroQoeLgEpLajIIKmre/TlZmu9DdVbKmyGlLJ/2WV3o+ntyz6XBWeo1fEfBzi4FdYRfUqv6K1TJo0bYV0K4hGgBfKLvxmakOb5YDUpZutJrwM2IpV32RSgrEoBG6E25rERs2cRxXPXhgQSBMMu3clhWHxSpJIqdMNDu6fkX9jD6PCTZqgGkoOwMpknRPDF5h65tskeG5Zy0csCY3J5YNGcW5GAwPwROmFG0cxIlWAQtgXbsOXu27Qh4OK91r9xWJjdsFbKUfc1hzED/M/pxw7muMbMaUOV9dtpbkDZWP8hXsBqr93597nxq1+sofei3cZtasLmKYnfKAsQxs8ipBYfir/X/oeQ9yjdizm0bkMaPHJIZkpqjemOMLgAGwxs83V8i93dHbAxQuNRhLhgAMl6Lbgic1mrhziGjzN1f0fqnZ0jYEYNXwwZ5Pd4hnaweEJ989nR7wBwQzTbI1fyLxCJx/Gkmg6zPn74lZDcH7phbuHcaJdObzE6t4PhCRktDKgNaBNPZXvc/kPAuSYpoHJrAIejlgFUm2rk2jqAHmwtSsl4zq3aDpBDNvMpwYYTo2plsR0Ax8key52i1KAWXovrpTZQNo2CDh/6BlYL6CSXqqTbov1++x9RQH1K7a4WxKYnPc6S3mCNwhCnrlVFcc7PCPX9TQaAXoTHgCsxGY8tVwspv9fVNl4+I7DgcIUYwJYcvNSv9qL+2Vd7rnM5SLo34UM0yJWH8WNbbjGZHuAMewotLWT2HVRj/G3SjYtc7iT8A2prnWErEd4R7uUBuSBSMVBon1QtwvYYTt+NvYpz+3yaxdFg6up5JkVZ65rqx01nAHP7nHJgeJRqC8KecVroF1oH3I9HDL0hdrzHzXEV9gNE0eWEXZHIk0+zJ4ZBY4Us9A/IZQ/0+knqWmMuYscU+0MmxbGoxRPvGsF7p9BCcpB1ndpZSbGyNE3ObptrvtL9Mam6hggJREgzeBtDRJsAt1b5R9H2jssG/AujeW1sU+g0mydmrkDPZcES8MYn6pzfDRHYaUGDdXdeBb6gCNi0zYLygvrDPPT4iwUQm5t/8/bv5EsAR4Jl7JwfSaltMgKN5O9cATkXI/JRLoB8kVhcp8g7ao8juwbTFx0+ym1qwpdFU7vZOzuyeTFqDJSVDWKN9C4doW09R43CiS6HrE0s89h+9wRDmMlnghqpMLVHefGwtB7lxWNSepQX3UB3CCDE3SE7Nqc6ab4+fTbFneY2Bx64uM1oxJYHeUCNGCgoccXt0XlIHrRdUsiRGNYJINOJgGskGhw9fgMsYVyntdK2ujNsnc0T67beYfd1cgvh3Gqt97Nl720i0ccgTZJjXWmPu+86oO2us00cF555emzMcjqdTmPKxqfxIdCTmI6PaXwyOTk+Pc0O0snJ6y2TDtRKe9r9GN/fHfC5/o39dFrjjLzjeBZO3rnD5xF5i4fSe9GQKwEF1kfUj4pAHArXP6g+51Gja1/1Ub7w3rY74n+xF3RYu7jbkjU29/cQqdhQc3xN9VBGopwLrueJz3KidcVCAud6PUNO2jPIxfhG4s42pB18kBMspPNiEkv6Pi9MGwVgksnuq/gRhYeLrKgZanRHCHWLAq1XZCZzJUo/NoYlMqQcCtB3Nb32agLXIUt8raSYER99D8f4i1ePEHOnkkFgrB2yeH/xyh26voS92R6ZTA8Oj16t2WJzKeDR9RCfsXeohgibfDLuHZRixUHBs22ZhrWbh9WuAhw2HT12tg4e35k56E55b5usckc4gwD+IYnstbC21xF86V4PaGsy7Oq7dcHabOcphz1eyOtOeYOt5dpW3NDG9o/OJuCQoZpvKBDdHMHTDNBM0lsy58Pq+22+b/hwc2hH8Y520FK40fQWS4ffbZ9HRSBYEwyM2E/khe/zor1JICSp8N6QMaGVDlYlpZpnzxydU1vmF/Q36d6n2S2EFQBMd+yQDwPX+B+Bb9e+OHzD7OznnRn+O5aFBz0zs8eiyrusqi3UGDeGagXdM+borSexOUk+yDk7BJjDJ7YyPTNE11UllSHMOkfFcnjC79VRmIM7AX3yPPSg+KED2Q3IBqdZ28rFuNImeVzBywfsS8Sg7GVFWzFrH/Ik5creGNxxlHf2XD0ntnsTGnsLassmnANodc7DjmmbWtDHOPHeeT+ZUjg8npzEjNLX8SGwk/j0CMbx5BTYERsDnB4cbVFp9jTsEUFpUVDygZu/ZpiKY7bil6Iyx3CN4Ia1MjwfnIZpQB/RhojNUbNnwppA54k5NWUnaX48zeKUpnl8SCfT+HT6ehofHI5hyl5nNJ2ebuHU47TQuaaczskvoAouGjYhX4qlZdG1v73yMA4FnxqEdv50k/fYXrezuVZrawmr90a7kt4tulyLpAkuxdb60F6zR0dr2HsQMRI8gh2R3wG+Y6pJmLm9evdPoOtQh6RJo3ufOFQKA23T9rJjUO96Bfy924rx2mL3UdQtdP8lOAqOZf/OHsPdKPqtYzfum9B/iAG5G0W/Nhbkvjn/NCU/TckPmBL31yjErr9IZqPJ4UsKD75pPbwY1r+D4/87nnTGcBk7MI5FIZKecW2cOsWVgDzH44gF+GtWeM2puQYV/e1Ne5/R3+JpKJ1Mjo8OIBvH43F6FB9mx8cxPTpN4+kUsnw6ORkfZkfRKOyyaDI9OJhODuM3v9id72gcZ+PXkwlN46PT43F8OJlCnDLI4+PDg5OMnZ5OWN6lcXiCf8fTqZdBX4ZMb9AAr5sNvokwjceTeIzZrofMCsY0m05PD+NTdoCIxuOYwvQgzk+P8tdHJ4enx6dpB9F4b3zUAxMuFWVzYHXxRKCOGcuzFNL49SE7iA/H44M4zbNpfJodwySjr/OTcdYBdQElj68Bvhf+8OdueBlwVUAefgm1TyncqPMm9Qu9iTtvTcQXYOJ/2Gvn268DvhHDq4DU7bC8Z/j2yBtS4DW5/u/Y1Gqv5hZ1cx/OfglZKaLRCF19h6W7B8x4noNCAlf9RbryGQJ3r3Gwfptn+z60jD9gy9GmW4RrZn9+8YmcHo8nPh2JSQp7Lqagwsoi4Y7T/HsnHh1JIcMJNQD3yIUsYZUzeCrXNLIU2Ihcz3kBRJo5ntZiCyHxfY3AuBUi4X6m5aGV2n281J9RsW9vULv7i5bVtbvc2R9S2zvxdEgYVa313sSGRRhZT2gFTn9NEYlFQQvtr0RuJGgXtb3o6dfywueUt8vpJ9HcizXXMjx7s/rmTcuunOdmSb4KW4RvB3HvC+C3d6iKeWbF+a0s6jLllLx89/ZVdDfUBc+0Px+5NwXhgvEFZ/bGSUtvj7h7vQK0PeSZ1VRRYcC/wmPPLwcrGS761tuv3TbmtGv03rv/7jlzP23fT9vXs313/sayroB+B6qXsX3owzGv9y5SvxUGLLFcgFKcIWVXyBDUBNwYENoKUot14xNjDb7uU2Mt41bBtRMaglzfqw+27d0FjW9C+VNk++STfZLMzKOzaH8x2W/uG+zfdl9/utsfPv+0f2uX7Q7XDytevQdeqwKjFP9qDq24ezQnZlDal3NW1Mo7KOWA5Y5e7I7N8TNOdgPhtTQ/K3tEvolmhZ+RDRqyWtnjncvbEH6/yTAV8KZGjlx+67a6QB/caZw1bRsNjBDDA174/ylQZSP94fMnlkRsb+oTWps56tZQhjaKLmzt8I+M4ChsGOBuFGFs8VsblXS06Bbl2T5DNtzSzZewnZsfNmzp5nuQ0vAEXShUcnWtwWbZF+PwATbsEYqXuq+djSJ8EU5/yi9ALXgGHXFpH26yb93s24b7DDmDVjK2/49FSNp3XXmfAYoMfSojicXxQpP3fgeTcB0A34ZjMqtxnpbL/+Vf0KLurNW/ffcujEp+w1eOghGydUso7/7r/7TibR13qU1JRYfO1icJhxO4bQPMp3zL0AukgRuzXxWUW8m1O/XWK5XLaGErDIJaiUbR2eCtwyF5bOJk6BterdMGqdzeYjLtqyru7vDnP2vAkP7yG0qPsrcBrGQxbrN4Gx4N7HLhpZ81e0U2vZO4YX7BA7MtguxG/lWR/kOOqLgeBemepxQfhUyb5vzEP7K4G8f+w19cXMtRx7n1z1U2DG5t8VvHrPhLz9qvZnTaHqjgK7O1bddef/76JRpFqU8ildK6JIpeo5al1261wyk9KnL87TYqqJjVLr/lSOJf/w+x6W6O +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"; + + + + + + + + + + +Update State Tax Requirements + +scope: `company_tax_requirements:write` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/put-v-1-companies.ParamsDetails.json b/docs/api/put-v-1-companies.ParamsDetails.json new file mode 100644 index 000000000..dd4392082 --- /dev/null +++ b/docs/api/put-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/put-v-1-companies.RequestSchema.json b/docs/api/put-v-1-companies.RequestSchema.json new file mode 100644 index 000000000..980d1d82f --- /dev/null +++ b/docs/api/put-v-1-companies.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"contractor_only":{"type":"boolean","description":"Whether the company only supports contractors. Must be updated in order for the company to start supporting W-2 employees. Can only be updated from true to false. Note that updating this value will require additional onboarding steps to be completed in order for the company to support W-2 employees."}},"required":["contractor_only"]}}}}} \ No newline at end of file diff --git a/docs/api/put-v-1-companies.StatusCodes.json b/docs/api/put-v-1-companies.StatusCodes.json new file mode 100644 index 000000000..b8adad6af --- /dev/null +++ b/docs/api/put-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"}}}},"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/put-v-1-companies.api.mdx b/docs/api/put-v-1-companies.api.mdx new file mode 100644 index 000000000..59fb0172e --- /dev/null +++ b/docs/api/put-v-1-companies.api.mdx @@ -0,0 +1,71 @@ +--- +id: put-v-1-companies +title: "Update a company" +description: "Update a company." +sidebar_label: "Update a company" +hide_title: true +hide_table_of_contents: true +api: eJztPWtzGzeSfwU398FJlUYWab2sT6uV7Y32Yltl2clt2aoxONMkEc8AEwAjmXbpv191A5gXhxQpS3W7W5sPSUQC3Y0G+t0Av0cG0koLu4hOPn6PzlRRcrk4TVMw5rSy8+jk49Xt1U70NZ5VxqpYSAszza1QMraLEqKTjxEUE8gyyKKdiJdle4iJrnYiVYL76zyLTqKysvH1KE4JkQAT7UQZmFSLEodEJ9GHMuMWGGduyGL3k/wkTapKOGGf62knN1pY+BztRCXXvAAL2tAKJC8gOon85EQgVQLhltzOl5C9nwP78OH8BVNTZucQcEY7kYY/K6Ehi06srmAnMukcCh6dfI/csiNjtZCz6PZ2p0b6v/HfiEmnF+fxb6AN4vDY58Az0NFqODsRyKpAdo73xgfx3mE8OkDuZTDlVW6jk/bnt/11vEAGFEKCoWUgB+MJN5Cx04tzdu1oYdwYlQpuIWM3ws7ZQlWaBqQ8z3fZ+ZRJJYEJw0qtrkUG2Y4bw8syFylt4hPDPhZCiqIq2rCvfppbW5qTp08zlZpdOiy7qSqehsMRl3yhVZ7T9095KWI/U8jZf3uAcevjn5GMykC2G7XPnzY3fBb2BPcIjP2ryhbI0P6WpUpakBa/ai3g6R8GWfZ9eSfU5A9ILR4pjWfW4uk8+U5gNE+t0omS+aI1YaJUDlwunarf52DnoNsniuFUZqqyVNoa1sA0u+x1ZSybAKvo5GdMSKZ0BppNVReGVcxYrm2AI+SM/R6PGRRlrhYAZpedcelQteBNtSoYsgQBTHluYJe9URaYnXPrRiEkOxeGXfO8AnYj8px5djKeZQIXxnOm5ERxneFoY6E0CHDi6MvhTtId0T2KUYBaO/dxid1Xt7duiCmVNG5Lxnt7+J8u1y8r0lrTKo+22Xthc9zLs1ry+6dhWWNoKDUYkJaAou6otRVygJTA7tI5AiGHxH4Z/CvIQPOcvXRM0uw8A2nF1C+CvamKCeieytolncWzt3REcbdvUaVYYReJQxlQf2xwyyrPnZLp02D5V1ZyRI6TBnAFbXUWnyldKqfho53osv+3ygHVSakFWIUa8Ndfz+jfF/hvUQg8NyXXVoI2c1FGO9GZitVN8+epV1sO4HtdGQvgv/sbSOJVF8DflZCWXYO0lYZoJ3qjZHyh1VRYXO0Smx5bwlFfWwF6yz2gc4S8y6rUMgTQ2wf2k1Q2KOdJTvL90uvbwBFWcMlnkLHadP68fFSa7TQCRRnPbl4ZOsJQiKogiSJWBll3MpYK0DP//x0W7kQTbkQaXd3uRMIkpjIlSPQRNuet0gyX116vMKyG1Egau6w/qxfJCr6g6bqSzJse2ofgGBjLbWU2E0g3ts/8Bv+n6LREiwnZp6hFAkfl6b/ArWmR4nQyZ1qYL4xLR3guuEyBlaBNCakV17DLflE3cA16h3HZwAoU4BqNRV0twaMAo/JrYIo4+DFgm+Qq/QLabGml/R9xmP6z1/fhrLV5yz5Fb5Rlg4wIe7GAzn44J8SdcuQBDfMLCcesbXKUJqniaW0AEWu9+YMoh9HtsvNgqKxilfSHCrdXaMbTVFXS7nR2u0Aj3Uff0oNh4aRtGj6gBqzP/pDuESaZi9k8wZOQTCqDPpzZXkocF+fcMOGNBWQd+rlpzBYykzNEy6aaVxkdw0EDIkxScC3+qLjkP0BdT4Y5q4HGGnJyUgLwQTKqSmR3i+opq6T4s4KGBUsKs22dl7A4L34ThYAjN7G/Jq9mG6qYvJoFiJtCt5pnkHSp3sy448SN0QiTeFuSeFtyTwMpDJtWeb6oTdJkwXhtp64Fp9GnF+dDVJR8kaDXllU51A4Nl4u3Uwr7VgVTRsgZ2bO5qnS+SAzPuRYkl5NFEtxQ91cGSEuBbuMVRnUeJvHxdpCRJSpgTxRGV2ImcTr5TIO8/EMJmaBXvsWOec/0iWFToY1lQl4rkQIpYUAfh8K9IWzTSqLi3Nb/axD64JN5QLSuFnN5Oie0GLJBciPIQcD/JAJPxETDV3IAcpX6dEBzcLjWHN0EJ7LnFgoTnVBwMsToGsLAgRVubj8cuMNRf2IwsNFgTEcprA8FjdUANhkNyXTDfVoFSr8bPV7L+uVpKSVjNkPQOUnrhn4T5WYDyfTpTQho5yY+XJ6icyUkJ79lAwWx7FeFPUbj7MC0tn3Or4FNACTLgELNHTapbMsDogFzYazSIuU5ygRfSnjYORSDcvkvSTZFFZ3oNT51Rzq6HYxyihKkWZLENYEuv+YiJ0XjpSa+EZn7I0Bimlsw/Xh/Ofp1+vcuBeCCkXWEODgbklCrhvVifT/Dv4oS8gq/coqjTqK314inGNTPRZVbQcNaxgZj++HNKFA0mZ8knP1EQjDRR5idgvtDTciD5nlaoW/VobBD3Gj3YOhQLdG5bFjE144XcM+9JDD/DFu5TEh3E/+qZGWizXhTcpEluOOJmk5/nEc4m3QNwmUIl6np9BE41Kz2N+4TTb+oSi8n6PvM6xK2wvXZgHWDzNSi4HqRoGfFrWrbpY/NAld7un4+q+cP+A9d9qwKNfoJk43qCE/MMgWUhSBPLlm1FXfjWgO/9hMROiErRJbl6JMJK3i+oTdyP8wOFfOoCHvOH3GlCLxZaDlX8lHQEGDmdDNhgoKL/DEwEeDgmRKquSog8R/cLd2beaghPN3OQQ1+xJ3+aQ3+TvfUj7zTO61dmA2c02Flsv1WIONbO7FOPfkMU8KzopPkX+NaBYwhOUVT79ROD683OviXdceDS28f31oJfiAN1cf5uOLcx9YXaSpnfY29vXVS60pXraS0M0NResT3jtKjZzE/2nsW7+8fjuPnz/afxaPJ6Hg0Oh5PDmEvCpmr6HKuyhLYpa0yoQxzhZZ2lih6B6nSGXMDo+Hcjlupq1e00/2tKP5jW9FE+6Mx+x8BmrNLq/k1yAqHN8oluqyEBfbs+SgK2iO65JK90lymwqQqqnVFdHYaeXUQPd8f7R1FLaGnKLOJ1ZwMdig53N9nr/iC/SaM5UM0HO+PGxreiXReKJm10P/WoB8/G4+O70J/tePKetHeXrxH/4yiXtltqUI2kMnqZZ86eSKs++/HeyOs+/dTOj4D49KMkaFdjY3b/jjP06hffPGBe78I0s5er0hI+5krEsI13F4hrYWvE3qGaLBp2GjFSU1YNNo9aLVXvFAVesRqaOS4Ne4dzKqc6y6k1vdvK2ssdxmta+/rrhz8i8pFRo778PcvC6yAyRRtR/qFxcxAPmUp17D5lJSjuiGfngo3ZuXUV69/PWUX1SQXKfsFeG7nrIH2K/Dr1Vg9V2qnvj3qqg7pmg3xMU8D4EwVhTDU1NL69IIv0jmkX9h7UXaHczNf/lBpjaUtJdkFX9Bhb317iZlErIG1P3ztm01+5zNgp9kflbH9ee9AFJNKG3BfXC0FYc2qerFNGznuxdKnfvvDF1erYhKvr8fZUZo9P5zGMJ5O4v1schQfp3v78fPnMD14NprsH4xRpbXNeHSaZ6ir+l56FHWsb3TGtaXMgLeR0f7o0KkctADegkW5qgTszsEYyI+ODo6OD5/vH+yNRqOD/aO/fIMi5192J+JbtOxXttTowXifvVNqwl4I7AIaUqQHhwcPoMxv1/lQHSadUy6uzY9f+YRnAloMGcUHhwfx0WgvPjo4eH4PpnjLbPnMUGtD3aN21W1Roc32fSn7e/vLuWesAL5SFZmWjTtRVoBgnyRjn6RLZ1O/E2RU5610CixTYKjEBl+FsbvsNf8CzFQaXGju27jY+YunFJ66Dh+RDaW62ysErZWmdfd6WNzny1mNlcmHJajJF8AJKbcwQ+EZxkGj7szjXJaQYp3PsJs5+DXTdKbStMLeqveLEvOq+cK1N32BRVMddL1y3FotJpWFp3UnIQtFSasakK57IFC9BWkIITTROEiMHEcPKmyS8ZTPtKpKIWfG9QVwSa1cxlEzqUSesRSrFYUfP+cyy9F8COma9Vr9ly78B2P4bIOs2EUgJAPLRW4Yn6jKtpgas5lrtwns9KADlabSU546SrlkWFGvDLnYQ06vVDaZkpC0DtbHzv6HDr/2eTlpTWwtLlohIDfcyQdNwF7Cdtr8jbIxCVn8EpHGb92p9ZI9Hi+L5QdZaoW+OiXnXpKjhw2q74kdfMHmvCxB4nmULjmrMko60dZ4+lwfgZB+y7GpJZ1jhf6zkCSeSX0oE2rI+7zDfL4vQJjSBmWup4/LZmbdbft5l12CE4mPLx2aM8dDAds2ghCZcVpP/5nNKiwEoMdSKA3hxOx+kvfXeMOsdbrvP8wNzP2P1v7319rYiV0jEoZ9lqTUErePn11jktsr16rrjzzjzI1kn/1Q5jdp4QqJLjD1gvFPYxyQCsux8nl36uwsCLeGHK65a37gCNMfkIWXZK/+hWQk0+jyk9pouiV32SulmbdIOx0QRB+x6nMrlv9Mexs+QSfws2P/pPG00LFSErpdKSvWEiIwh8vdhegIXvh4WdjCN1uIdBe364vxq8SsRt3kfdHC5FJBA7j7PcWrTs2bVp3Ic5Sazptjk2JEiK3dGXaTu2xcw+C7MXxYavkKpTEHhiA67Y09l2tyi/W4qkysWj+wo+eGBvRy38tDWl7Ia3/649+FncdvJcTO+Ll4ZHjUa3923FDcmlbH0n/2/F94zxHSSoPda7JD5UNt5xT9MbHWbOyyc0t3e5QxwnfwUvtJrYdyuIacis3ejARDUauVKBUauwr0T47cjt/8c9Re4cCAaCAKmHD5JfEdt4lrkkkqiWlOyDAngCkdsyZCwOaHbniw5Kx1woRXLoH6GuxcZdQwG7CxGhvtQYewa9BiukiETF0CC7O1yogHpewf6AYg1tCAjJYTQ5cJMMIvINtlFzlgu4fLuZGTgh6rJ8f3iJjd1UvgOdY0FkmA+KgLQPZ6hK4Lql7HAIGUXJSzRKsKO5TXRYVuRFI3ywyQ2HPyO4S+c/N9BQhlIphdT5c/CUmq5FTMTE1a7WtuxbXl2W1iTi3DLbUMa1KNM1v4S2HBsRgmLKx2iomx8GWOl2rWUDgweGsWvkKKPQxGMJiZqyrP6H6A52xNc1KCFipr6AWZ1W2wK6ishwzSNszLlzKjZtiW5FAEZedcsmesUNLOqd9zWtHNIKKvvioqs8pYTOxC7nLUieQiNUmqMkgax2wlxc3o7fn5BucynDtwHDej0KN5fALD0YQ/K56jFTlkmZiJWu2sIdcEAswG5BqRurHbU3spUqLVLBO774l1tIYaQVKqXKQLSi5vttfFvZhYDO1vn4hK5u5eXC0vPE11xfNEr5eZzrAtNPepm+eaCAPHJjmqcvSsanoYESjArCAcy4ykwl0iZZ117E3dhtozJ9wZUCkWSXYwXIzraWg60gIxK2iur6Jusu314O33/mWYSvfCNj4BE55jRSxxl3nvZa3XUYX3hekSIRXWmMdm1m/73BXFEtLsjuDgVpAj+pBe0Vm4v+TdCHIpmKeALmA4ClaThuniRyOrrr+QJz1E2A4rvcumgXp0JawktTaP9TF7lKN47sbUt7AZhl2mlcMg+vzNO2jIeUj+BRluX/KDhiRHwtJiHpCC95R7xNto0oelQnaywJhc7lk051YkIDF/lAxcG15B2/Lt2G3FtAbg4r3Gv3G0ZCSwdMpR99X3IHv0P6Yf21vjgJmjtwsQAJ9a0BTrb+IFLM/ann8XtV/9ZADek0aMm9QE5SmZFxS8ZuVXEVKLm9LfGf9DlHcg3UlzGN2ENFRen2llDKY7AnIJFAys83X8iO3dHaAYofYoeNNz1yaJvBbcEewK2sQxvJ+poxaOluRImHG6ZN2lxst4inYwf0B9c+HbAhsCHIpaPKZafQMZ+iAeVNNh1sejXwrJfdENcwvn1rh0ekNjeENEacZzC3oFtYmHsj5u/yHChWETQOVWExxKLT1SKdUoDDmAnthKFioTU0FqO5AcspkPSWyoGJVLm+0IcJzssNwpSgP62mtxszAWinpQ0OF934C0gEmmShd8XbTfHf8jCqgLqZFqySg96eks+Ffs1+rTaSpdclzzI5L68msKgF6EpwF3YrS3R1zNlfpSlet4+YiEBYcrxAB0V+Qn9xJHu/bV1HU+9pLudfgQ9XLlAX+Mf8aj8TNqcWgrNP96Q238Kekm5FRtdfh70AadYToR3hHu5AFF67WFzoMc3eU73Mt0rl9PvTkGbFU+zqJ41rim5n7L6ZG5fk1T9wRQYvnXx1xW/cqGx0fP/hC++61xmewNjqLLCfs23IdeZucYBo0VstA/cC47RA8vsvPmzYMuqvMMTssI3rmEhiRHsqkmvqV3aWvqnN0613xp+n1SdTWQ+pkaViNvYohoFcGNVf5Rajvlsh7/AjavjSmFztN5YucazFzlWQLe+ESt+l2fAloW1LRuz6vAFzwClLZp7ok2j/9Qbv707Bf2PhDHgmVs1Y+UMpSMQCP5O77zdi532Gt1Dey9ws5TzV5wKke2DaZ/nO9eblMdvlzXTyN2akfuvSRroSjde3TKu3T4TlLo58AbBzN0OVRlYzWN6XsPMISZoS87of7fzdJ62Ch8j5Qe3uwRS4e0JiDE3SE7Nuem2zb+sNkUV82tCx64uc3FV2oPChfLwjHQUOCOU+k8JA+aKROYKv8AIL0YJOEGgQZHD28MJJkwdet9EJ3VC2uP3kL6WrmFULca9H7WyN4qEBt0lr5oEd3rJd155OVle9mUj8fjmGd7x/E+8KOY7x3y+Gh0dHh8nD6bjI6er1l0gFZQtfs+vr8r8Ln5tf10WuOEvRBYC2cvXPF5h51hUXo36nMlUOFvG92bCv/uhld9zqNG177sUvnEe9uuxP9kN+iw/69+Y7zuIYWZJ81TZtRI4C/WPXxO2jPIxfhWoWTb1jtqvZxguNaXEOi7vLD6lsjWu0ivnAqZ5lWGGt0BCtcil85M6lqUfgwHAelDdl0625tenIas9VniG63clS2Mvvs4vtErlNsec6eSQWKsHbJ430Tpiq4/we5sl43Gz/YPfh4QMbwCc+9+iIvWfdhayEd7nUIpdhzkIl2XaRgUnqxyHeCwqvTYEh3/1o1ptfc2ySpXwukF8JsksgfJWt9H8L59d6bpyaDdd/uCvdnOUw4ynqubVnuD9ZfkVzY3NLH9vbMJiDJ08/UPRDtH8DAI6kV6S+Z8WHO3zfcDNzeHhMU72kFLoaCZNZYOv6c594pASveejnv8+Imf86S5SSAVvspZCGvDKBOsinvm9HGjc553nl723iY5GduFsPi6pmnZIR8GDvgfgW83vjl8xero660ZTlc5g56ZUVlUe5dVN40ae7WhWqLuEXP05EmsTpL3cs6OAszhs7Pu26AsI+coX/Qr/F4dhTW4CuiD56F7zQ8tkv1DZL1q1rp2seYe5vZtYvVrEt0wqe83k32YJhOh6ZH+LbG88G9f0fQ6NPYWlNomnANIOmezMm3dC3ofJ94770djDvuHo6M44/x5vA/ZUXx8AHvx6Biyg2wP4PjZwRqVNvcXtbcNSvOcs1fCfpthKi6jjl98ocm9cYUCS2d43quGGUAfkULEutRchivaS4HOA3NqnB1NpofjNJ7wyTTe56NxfDx+Po6f7e/BOHue8sn4eA2n7qeFzg0XfM7+CjoXsmaTf9UNWXTjb69sxqGr3hN7tQq9o2drda/W2hZW7422T3q76XKQkjq4lGv7QzvD7h2t4exexEi36HfY7wBfMNUk7Zyu3v0D+BDVIWlS694HDpXqN+fWaHvVfjy808Dfua0Yr2h2pwlDt8m/xqYE/gW4WcSoHWN81ELjXfuTyHd64YtsFqSpX1xxK135Qyx0k6G6+wdZUJS7oNxvatTzw7sqYdAqSusJgWJ8eMFnGuh3XuitE/wJmejp9ehp3ZPy9Hvz4yy3+FoAlj79nlYa7+uH65O8FO72ZJxBQVcol65AvIACXxxoU+ngxS5/gl/jYlYAHoR5oSlXsgomPshPaw2/nHOJF1pdr9bA7+fUdzgQefgBGPx7AlwPPPUYnvKkyxiMV3aOHnioNOxEl1Qe/hEMDsIKBPhIsVHyXfPTKi/Dw4ADP4USnoj21cQgHO41cveSc50ybv+AzU6Ev1dj3k4vQV+LFFp701yXpRuGT2ng0wyJRVmO6W9M/Ro/delWDOQpPt1llXvW94lpfhQhNGHgL9dkKq2K8Dbwf/l7y9xFuOHFmYCVvcO7pT6MCc9K1DT9pTlL9KKFMrbgsgWn/5tGfZq/N3emt/79I7/3Fr7ap2XOBR0SOu7fvfh9jK5HUUj4uGuGJ63fR7rCVkRjcdz376hIP+j89hY//rMC1KUfr1DUNXVPkJRmgrReNvxgc3sxP73zLt/PbPVPLQ2uIFx8ohFB0UT+Flb7551cL6X7eaXtiPu3/tGkFWx17Bv+oaqay432P3PMit93LMzytf5mBiqm0q4d2zYTFx/e40vh/hecCkUWUPMbvArLb9yWhwQC/sQTfvY9yrmcVc6SO5AodryrDGvl5/+ndR+3e6i+f3cj3qsvIG9v6zNm8W+y+rf/B9Ay+bA= +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"; + + + + + + + + + + +Update a company. + +scope: `companies:write` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/put-v-1-company-benefits-company-benefit-id-contribution-exclusions.ParamsDetails.json b/docs/api/put-v-1-company-benefits-company-benefit-id-contribution-exclusions.ParamsDetails.json new file mode 100644 index 000000000..97d758b98 --- /dev/null +++ b/docs/api/put-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/put-v-1-company-benefits-company-benefit-id-contribution-exclusions.RequestSchema.json b/docs/api/put-v-1-company-benefits-company-benefit-id-contribution-exclusions.RequestSchema.json new file mode 100644 index 000000000..ea21195f1 --- /dev/null +++ b/docs/api/put-v-1-company-benefits-company-benefit-id-contribution-exclusions.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"contribution_exclusions":{"type":"array","description":"The list of contribution exclusions to update","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"}}},"required":["contribution_exclusions"]},"examples":{"Example":{"value":{"contribution_exclusions":[{"contribution_uuid":"082dfd3e-5b55-11f0-bb42-ab7136ba04e2","contribution_type":"Bonus","excluded":true},{"contribution_uuid":"082e034c-5b55-11f0-bb42-ab7136ba04e2","contribution_type":"Commission","excluded":false},{"contribution_uuid":"082e1f6c-5b55-11f0-bb42-ab7136ba04e2","contribution_type":"Regular","excluded":true}]}}}}}}} \ No newline at end of file diff --git a/docs/api/put-v-1-company-benefits-company-benefit-id-contribution-exclusions.StatusCodes.json b/docs/api/put-v-1-company-benefits-company-benefit-id-contribution-exclusions.StatusCodes.json new file mode 100644 index 000000000..026643696 --- /dev/null +++ b/docs/api/put-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"},"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/put-v-1-company-benefits-company-benefit-id-contribution-exclusions.api.mdx b/docs/api/put-v-1-company-benefits-company-benefit-id-contribution-exclusions.api.mdx new file mode 100644 index 000000000..9deefe762 --- /dev/null +++ b/docs/api/put-v-1-company-benefits-company-benefit-id-contribution-exclusions.api.mdx @@ -0,0 +1,73 @@ +--- +id: put-v-1-company-benefits-company-benefit-id-contribution-exclusions +title: "Update contribution exclusions for a company benefit" +description: "Updates contribution exclusions for a given company benefit." +sidebar_label: "Update contribution exclusions for a company benefit" +hide_title: true +hide_table_of_contents: true +api: eJztXOtz2za2/1dweT+kmRFtSZblx6dNneRuZm7aTB63u+NmaJA4lNCQAAuAtlWP//c7Bw+Soh6WHPtDd9KZnW4t4JwfDs4bIO6i23hWayNjLgzMFDVcitgsKojOLyMoU2AMWDSIaFV1h+jo6yCSFbj/esei86iqTXw9ijNZVlQskhQE5Nzo/h8SzuJMCqN4WuPcBG6zotaW5iBioDPFK/whOo++VIwa0KQ7nrTjSS4VoWTGr0EQz4Z4Nge/i9/FRa0UCFMsiJlzTUCwSnJhiBTFgtxI9c2RmAxH8TdCBSMfpZn7//R0CMpCW2o6kxWck6v+Cs9vFDdwFQ2iiipaggGlo/PLu0hncyhpdH4XOYFG2iguZtH9IBK0xD+syiYaRByXXlEzjwaRgj9rroBF50bV0JfP5zmQL1/evSYyJ2YOfRlE94O7wOlf8f/YbX714V38f6BQfoHVHCgDtcQsp4Ve4fYaV1ZyAdoyw62JU6qBkVcf3pFrR5RQrWXGqQFGbriZk4WslR2Q0aI4IO9yIqQAwjWplLzmDNjAjaFVVfDM6tMLTS5LLnhZl13aX3+aG1Pp88NDJjN9YPX2IJPlYdDTuKILJYvC/n5IKx77mVzM/tsTjDt/fokwag3sIBps3K1BBKIu0RzGw/FxPJzGo2PUfgY5rQsTnXf/fn//dRAZOkMFiC78dvzsFQVnKdCVFBo0MhoPh/ivZTG/uaVlVQAJI6NBhPoPwuDYjpQO/9A4YY2eUaXoArfXQKlXOaDaKKgUaBDGkkIFohvMzFtZ376iQeAm0z8gM6j+Cj2C4W5xS0Ze15ytE+1D+twBhFMP0HaWCDuCuxBGQ9hO2C4Z3V1LL5WyACpWCP42BzMH5fzKCjVUq0CM5EqWlmkjufv7rq1drpHUukV28H0dRLfxNi0z3BQI/6JDJX4TdtQCAKdmdqu8yuH/vaZFDdZ7rdm/KD0dw9Fxdhyzk2waT06Gx/EZjKbxWX56Mjk7owxGp2vBn0c/S1Hr7iKck0EXtY5TfjwdnWZnkxjYCYsnR9NpnI6zSZznw2OYHA2H00m+gdMF1XPymVd7cJsOR2ejs7OzeDic0Hhyxs7idDQ9iqdHw+OTyeToaHp8tImbLEuuvT/dkd3JMT2hp+OTeJSPWTxh0zw+m+Tj+Hg0yUZ5djROR5vYfYRZXVC1Oy8Ayo6ykyw+OZtO4gkcZXE6HZ7F05Ph5Hg6Gp+kw7MNvP6X50C40LWiIgPCy6pGtx6iSxcCRqf7r/f4zyCaDCerTucXachbWQtGfheE/C6cE/qzBo00FWhZqwwIk6CJkIbALdfmgLyn34DoWoE1oRAynJfgmlzTgrOD3wWa72Q8XmX7RVRKZqA1TQsgb4ThZtEg4JqUdEHmtKpAkJs5CGeoki3QU9iw5DFaI6dcaAJKSaWJrrM5oZpccWFBJNQ4AUJibehqQKSy5AKFnPJCE1YDMZJQ0c5s8qirA/IJ3Eov3zg2F9TATCoOes/oZ2HGWTP9JZnVnIH15qVUQBgYBITC2yPCPCzdH8LtC7cfJ7u+3y0YffZy9PR/3xLTH6SafAOc4FEuNvCwox4MoJ8qyHjOQeNGemO004nMslrpA/J5UXFM8Xyu/Q0WhDMQxs3C8c0eHjZ5MlFQ2FTRyJakC/IB9R7QkIINvzL3lAh6mUAqeA+vZWSmZF1xMdM29c+oICnYbBDRpDUvGMlQD0o/fk4FK7iYES6c9nbqIZvYNoy4JlfCOrbE7ePVwIJze0VueFEElSeUuJHkyg8lfpMWLn8G57Lcj1Y0JdrbbIes50NYr9dGQlNZm87exWQGAlS7a550EIauVU4zJxAqsH5C+SiPwlBGDV2nisswLoJxKyjgmgqDpQNFml5BFt6SfQjgglibxmzKug3vkdICDshbqYhPXQZLJCw+K6or928bxa7s3oa/YEi8cuJP22CCqawU8Gtu057taynrwnDMzi1FtKOe4YU/rxpb+GUPk17mrbmYBc44jTLG8SdafOhwcnXiGt6LHXPlXzp5speomdOu2mRSueKEaWKkS51bAT/M4Yvgf9bQugdl/WbLz1J03huT55bgZUtR1EURfW3G1VVi5PaBS35u3QBtqIFtQ+7bxPq91/74N27m8a8CYhf8ovvNo9573XFDcWswZ/ux53//PUdKGwN2r3BE52P7TzbBJXxr2Dgg74xtlUitOaZYRpI5vQbS+KECrqHQuHc+jIRA0biVKOMqw5rhJwc3tslP/KtVuJdRd4VrBjiFvo275WJKxbeEZpmshUkYFGAgqUVeCwYsqeiiBGGWkpjLpVwjwqZRNzE5j1aStagT5qK3tWBczN6DmUtG5lSTwI003OweLAG7BsXzRcKFVd0MkVZS8ydF9m9MA5Ar8VwxcmL1kgKx/DmwA/KhAKqBZHPIvrkkBTNWD4fQEidiaN+0BFoooGyRBIrPugAUr2dIUgDRrmMNQFv5ilmiZG3QbDYD8yMSUZepbTaugdhL8peAfnTziZuPNhHCrsflNSHJpMj5TDfQmlxzL6mtzu6CeWUIbik2koG0yWxZa9NNLNYDC6vNqTbBWpKCl9xsQbhm8N4ifIuIPQ1iaRA9l3WBFT2moW5nAuakAsUla/GCYAnz3nIDymbIWmzrZflGMNtK7liOraDMnApyREopzFxjTpjXplbg8IW+ORes1kYtEg0FZLZ3ISjPdJJJBkmbmG1E3I7eX56/4FyCc9eo424IPZvnBxhUE/6saYFRZEoYn/HG7WyBqwMAvQNczTM3dn+0n3hmsepVsBMP1mE1vIRE5nlSyYJniwQbu7vtdfkoIZbr9rcPohbWooA19kKzTNW0SNR2m1katofnfuXmEZzXSCwt0JVjZtXgIRYgB70BeAU2uCa+kbItOvam7oP2whk3A5oZfo2QHQ1X43oMBBkQmeehq7MJM5RVIRcAepdtbwbvv/dvwlRCFeyuASktsGGa1NUD/nJztN6G6oIK2yGl7A+77Y6b3r7tc1lwhl4d/+cAh7TCJqJPmRWFE4mQRtiUgngEGIH85m+GJqR5PlhNi9lm0uuADUjlUzYFqKtSwEaoTXhs1OxZVPGdG0MCCYJll+70MCw+KVJJFabhYdxTyi/YMCb8pGHVQHIQVhbzhAg+294j17bZY8tSLpa6wNhc7kU0l1YkILB/lNhjDpoZqRIswrZg64/c30wbAq7ea/Mbh4VZg7Vajr7P4W0NNuB/zjy2t8Y1YU4bqmzeTnMDytb6u2QBq7P2l9+HJq9+sYbei9aM29aE7VMSbyjXIIxfRWgt7op/afx3IV+i9CDmMLotafDIIZkpqTW2OwJzAbYY2Jbr+BH7pztga4Qmowh1QQ+SzVpwR+ayVrskho8Ldf9E6h3LETCjhl/3BeRtPMM4WDyhv/ng6HcAOBaNeeRK/gUi8Tie1NNh18ezXynJ/aEb9hbeGe3a6S1Gl3YwPCGjhQG1AW3iqWyv278LONckBXRuDeBw1NKDaluNXNsE0IOtRSkZz7l12wFy6GY+JdhwYlStbLYD4CS5JHLnKDWoa+/F9UIbKJtBwYf3cwPrBXSSS1XSbdX+8vjvcUDLlFqrFsS2Jz3Okt7i1ag+Tl2riuKanxHqm9sMALMIjwF3YjQcWqkWUn6rq22yfEZgIeEKNYC9cvCTfnkQLZ99tec6l72me1M+RL1eeeAf43/Go/ERrnDJoaWFzL6BaoK/bbpxkcu9lL9HbW0ybDXCJ8JLfUAuiFQMrzhJomoRzKO/fMd7Fef29TSbo8HU1fMsirI2NdWPW04P5vY15cDwKDUx9PY5l4V5oU3APT9i6C2x/B63xlXYO6ii6wm7SyJPvswlNQweK3Shv0Mvl0CvX6SuNfYi9myx77IojpdaPPFuEHxwCS0kB1nXqb9vtrI1Tc9uW2q+Mv0xrbqGCAlESMO8rSGiTYDbqPy9aJeOy3ryC9y8N7YtdJrNEzNXoOeyYHj13AafqHN+10dglwUN1v1lFeSCKmDbNteUF9Qf5mHGX1wDsb35Vxf/JJ8DOBIiY+f8SEptmxEYJH/jCsg7MSDv5TWQzxIv1ynymtrjyG7A9HedH5U2NeXLdXNlfOnsyPbFqDFQVraINdKndIS29zlqVE5MOWRtYpnH9ndPMJSZfCaokQpbe5QXu7X1KC8e09KjvOgWun0Aoe4O3bE51Unz69N3U9xpbnPggZvbcCP2epAH1KiBghJ33B6dh+ZBOyWFHInhPQEUOhFwg0RDosdvgSWM67RWGuxhUntuvWFh3dF7WF+ntxDOrdZmP1tsbxOJZQzSJDneK12S7usOaGt1doiTwjMvjw1ZTsfjcUzZ8DSeAD2J6XBK45PRyfT0NDtKRydnWxYdqJX2tPsxub874HPzm/jpvMY5ec3xLJy8dofPA3KBh9IHUV8qAQXej6gfVYE4FG5+cH0uo8bUvlpG+cJn2+6I/8VB8GHt5m5r1tje3y5aseHO8Q3VfR2Jci64nie+y4nRFS8SuNTrGXrSXkCuxjcSLduQlnmvJ1hIl8UklvRDWZg2CsAko/138T0qDxf2kjehxBFC36JA6xWdydwVpe/jYYn0KbtbOvuHXpyGovVd4hslxYz46rvP4y9ePULNnUsGgbV26OL9xSt36PoTHMwOyGh8NDl+ucbE5lLAo+9DfMDZ4TZEMPLRcOmgFG8cFDzb1mlYazysdjfAYdPRY8d08PjOzEF3rve2zSp3hNMr4HdpZK+Ftf0ewefu5wHtnQy7+25f8G62y5SDjRfypnO9wd7l2na5oa3tH91NQJbhNl9fIbo9gqdh0CzSRzKXw+qHY74fuHs4tFx8oh28FBqa3hLp8Hc751EVCN4JBkbsT+SFn/Oi/ZJASFLh54rGhFE6RJWUap49c3VO7TW/4L9DtmmTjP1KWAHAdCcO+TJwTf4R5HbjL4dvWJ39eW+B/4bXwoOfmdljUeVTVtVe1Bg2gWoF3TP26G0msblJ3us5OwTYwyf2ZnpmiK6rSipDmE2OikX/hN+7o7AGdwL65H3o3uWHDmTHkPVOs7ZdF+NKm+RxF17e4lz3teRSmdTPm218yJOUK/ul8p5cXttz9ZzY6U1p7COovTbhEkDrc3Y7pm3ugj4miQ9f5o0pTKajk5hRehZPgJ3Ep8cwjEenwI7ZEOD06HiLS7OnYY8oSouCkrfc/DXDVhyzN34pOnMs1wgarNXhee80TAPmiOHDXXfU7IWwptB5YkmN2UmaT8dZnNI0jyd0NI5Px2fj+GgyhDE7y2g6Pt0iqcd5oXeacjonP4MquGjEhHIpFlZEN/7rld0kFHJqENrl003fY/u9nc13tbZeYfXZaFfTu5cu1yJpikux9X7o0rBHV2s4u1cxEjyCHZDfAL5hq0mYuf307t9A16EOTZPG9z5xqRQYbfP2shNQ75cu8C99rRivvey+/F30zyFR8F9F/40zhvtB9LETNx5a0H9IALkfRL80EeShNf8IJT9CyXeEknv/9btP336WzFaT/Rdc9n3LY5fXNTpP6Dz0/RGWyQV+eCTzjc/qNF38H0+I/HhCZOMTItsQdBTy64NvjWxR5g3PkAxPxyxnRxAfp8fH8WiUD+M0nYxjmp6MjqYpHU5gvPMzJPbpig2PZwxPxzA8mmSPYPSYd0GQ3SifPobdundBOo9y2E0wIFq5Ot+58fWvQfMSzPZXwPC9I39UYZ8As69gmXl0Hh1ejw77T2Ud3q2+eHV/uPk5MHvFyrv8WhUYFv0zDbTi7pWGmEFpn2pYMbDXUMoI1VxXQL8B1YvY0YvdOQ3+jDuxgfBamh+UPZPZRLPCn1EkGrJa2X7i5V0wr1cZ5p6vapTO5dfuqE/o9J15rBnbeBKEGB6qsp4FqLKpZf97e0sitp+GElqbOfYDw72HQfTJXlb7Hg6OwgYG94MIg9nHNgx2TH5fS2+c8Tqdbx/o6qs8dpvdZangxuzrZ/iYGGp2OBHvvtw1iPB1M/1r/gnUNc+goxLtayD2AYVDO/CQ4eoxWsX2v/FkW/upK64eikyW9sDf4nihyRtvVCTcMcV3zpjM6jIE1P/yq6auge/fcXsduJKP+HSGtxN3GI467X/9R6vCuCGV1KakokPHPa33wMt6/ffkeuu6a5OZv91TfV6FDNyaw6qg3FqG9QR33oFdRtf2yKxHIhpE52uf7dsYAPGzEW2Q4N0dFopfVHF/j3/+swZMVy+/orNV9qarNQTGbYW64R2+rtR/+ugj8Evy0FuAG5YckkWxaF1+FPkv59e9T+i+g3FPBu4H9j/8/cC14nViXP/4YiNtDEJu4IUTVvx5KQSvFgrtDHTjldk6thuhP3z5HA2i1NcmJX5Wiu2sG3zGhN64rQ+HP1i84N/uooKKWe3KJkcS//l/3bpWIQ== +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"; + + + + + + + + + + +Updates contribution exclusions for a given company benefit. + +Currently this endpoint only works for 401-k and Roth 401-k benefit types. + +scope: `company_benefits:write` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/put-v-1-company-benefits-company-benefit-id-employee-benefits.ParamsDetails.json b/docs/api/put-v-1-company-benefits-company-benefit-id-employee-benefits.ParamsDetails.json new file mode 100644 index 000000000..97d758b98 --- /dev/null +++ b/docs/api/put-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"},{"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/put-v-1-company-benefits-company-benefit-id-employee-benefits.RequestSchema.json b/docs/api/put-v-1-company-benefits-company-benefit-id-employee-benefits.RequestSchema.json new file mode 100644 index 000000000..8edea36e7 --- /dev/null +++ b/docs/api/put-v-1-company-benefits-company-benefit-id-employee-benefits.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"employee_benefits":{"type":"array","description":"The list of employee benefits to create or update","items":{"description":"The representation of an employee benefit for a company benefit.","type":"object","title":"Employee-Benefit-For-Company-Benefit","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."},"company_benefit_uuid":{"type":"string","description":"The UUID of the company benefit.","readOnly":true},"uuid":{"type":"string","description":"The UUID of the employee benefit. Required for updating an effective dated employee benefit."},"action":{"type":"string","description":"The action to perform on the employee benefit. Required for creating/updating an effective dated employee benefit.","enum":["create","update"]}}}],"required":["employee_uuid"]}}},"required":["employee_benefits"]},"examples":{"Example":{"value":{"employee_benefits":[{"version":"09j3d29jqdpj92109j9j2d90dq","employee_uuid":"8f9f3f68-8fd3-499d-ade7-4a052e56494e","active":true,"employee_deduction":"250.00"}]}}}}}}} \ No newline at end of file diff --git a/docs/api/put-v-1-company-benefits-company-benefit-id-employee-benefits.StatusCodes.json b/docs/api/put-v-1-company-benefits-company-benefit-id-employee-benefits.StatusCodes.json new file mode 100644 index 000000000..f06f877e3 --- /dev/null +++ b/docs/api/put-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"},"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/put-v-1-company-benefits-company-benefit-id-employee-benefits.api.mdx b/docs/api/put-v-1-company-benefits-company-benefit-id-employee-benefits.api.mdx new file mode 100644 index 000000000..813bc0266 --- /dev/null +++ b/docs/api/put-v-1-company-benefits-company-benefit-id-employee-benefits.api.mdx @@ -0,0 +1,77 @@ +--- +id: put-v-1-company-benefits-company-benefit-id-employee-benefits +title: "Bulk update 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: "Bulk update employee benefits for a company benefit" +hide_title: true +hide_table_of_contents: true +api: eJztXXlvGzmW/yrcWgySACpHlo/Y/mvTOba92HQHnWSzgySQqaoniUmJrJAsO+rA333xHo86VJIlx9mdnvUAg44lHj8+Pr6b1PfkWzqrjFWpkBZmmluhZGqXJSRnHxJYTCDPIU8GCS/LZhOTfBokqgT313menCVlZdPL/TRTi5LL5XgCEqbCmu4HY5GnsCgLtQSIjZJBkoPJtChxuOQseeFbsNCCaSg1GJCWccnCAAykVkUBOROScVZybUVWFVwzP2vov8fOLRMyK6ocDBNyqvSCoDNTQiamImNWMTvnNo79wPjRFyDt3kf5UT7TwC0wpVlV5tzCQzFldg41GmEYLzTwfNkChm06eFip4VKoyhTLR60Fhe+nSvf1Ixy/BJpkSloupJAz9vrXc8Y1MCWLJbsURkwKwCXxsixE5vaMXQk7p1EvVnbgDGGflXNxwUymSqCJ3s/BoW+MwubcrBvjSgsLZ2GjkYvGhVgIC/kFy7nlbujBypAZlw541qHwCl0MESYQCWcwbtdw7SXohbAW8ki9xiS0IJr/bC30i2SQWD4zyPvPPOEDsZHhNZhSSQMmOfuejIZD/E+Hb7/xRVkACy2TQYKbBNJi2wacx58NdviemGwOC47/cqcu4VrzZTJIhIWFWZ3h7Rzqs+DIp6Z9LLSHi3FDqslnyCz+LWwBjeOV+tUlg+RbCg47zenXgf+8BG3c1MPTzwf56PTz17z8fDraH55+Pv08yk+H+ddkkESSVpVAcfDkYPTk8PR4lB4fZJAewlGWTo5PTtP9fHqSH+bT4en0kKjTlg6+99EhHDzJRk/SwwM4Tg85HKX8aDJKYXR6cnrE9w8OJkhbnllxCcmZ1RUMEt8XTvczfnJ0nPLT/aP08ODgND2d7J+ko9PpaZYfH0+GB/tNwDnkVeapuz8c7g2HDVy4e1pMqu73q73HXMqKF+MF/yYW1SI5Qw5ZP9iG5nRmxsrvuKyKAlnPCg0oisaF4nIscpBWTAXo0MIBGXMzLkFnyBwzSM6mvDDgmJBmhnUNuM3m46ps9LgEzWcw5gtVIfs2Z0H8Gv8FZmz5Nz4pYCxkphYQ2sXuhhdcL8eLqrCiLAhvEsnSpG19ANyEg+SSFxXURL8eJFCA33GPEqZT98kYxQURcXSUDvfTIW3xt1I4DeW/RmzXg+StAA05+3/P5P/bTLyZRf8POLDmJ0fcNRxpiV9qjvxOn6Ca+J5ox3dEU5Swcw1mrgrco1H7k3EOheX+8+tB7Hq02vNoTc8D7Pnp+vp2jH89SHhR/D4l3G2tsoOuSH/hBtLfQ7NSoxlohdMb8RxF2hmrhZytGHioxrJKazTofCfUY6i0HYI99gaA/v7gv0czZ1aJHD49nFtbmrPHj3OVmT2yX/cytXgc7NW05Es0v+j7xyKHRaksyGz5iCyDpvmHBo26QkupMjidMGwqoMj3UNyEkxcXM1GqAC5pNVNeFTYwTntx7+dg56DbxmEwWtBIpHFpir4D2kc7P1tg3FViukOCC5kAc4NBPkCbiJV8if8VKh+wqVaLFq4HBr8nLP3Hc9Pi/UndYvVxeQGomauqyBGsJaMvZ9ygCR9n7izFIQeezZnf3TX0W5FJYQEfanricUCDbpWMvtcG4EjRJXC9x54yHIeRUGBGzCTqY8OkYiT8CN8aiRJPWRvBU+m5vzbxkOuRktiRcZn76fxZCe5Bc5q9lVPpJt3qSPaMx8hEdR7BR6+dPyZnrLc94CZOxTfcz5peYcfY+ZQFmYsHgQ6PX0hjQmHYArWBkLMBy1VRcJ1OlU7dPz2QmlM2g2lwlCeaR9MD0B+TO8XplMdajDjOJdfIODzLlM5pwxVNZsSfEfQqQxJ/RY3U3suX3gG6cGu8IM65qElx0QZAjpRbYIe9tPNkCJWnl9INmtIi42xurT2DD9BDIc+GhkbtiWyqJHh11GZN1I7dk9JhaaeAV7ymFbUW3agbTh4zQs7QZxagyaNibjFxh8MxWIHi1Pg2p6vNij0iBh10ChggzwnQa884uxJF4aARGzSMh5uAvHEBD3BefFUi+5O8Yg8pQGLEJTzqOTURbntz0fmu8ZKHi0MrYox3pFM9NOTqHKZCghPj2IGCLDkrlZB24OMTuLN+oJxl1aIqOJ7DYulUwPBvrCqvuM5N5D3vuZ7h3+cO7VRoYx2mOSmWGoaaso/Jwcdk4A4Fbt+F+3B/OMSPm0Sv6cz2h8O/tfatSQjTAEdxF5n7eBOyzgF1DFKwAVPCt00ojz4mNBJnmuIi9NkmjEcOYg8yPlGXgED68B218LUYKtie2/C3sVDi+LmYTkGDzNDqsVcADZZ+YBqLRBQkkX00bKXFHjuXnf0cuLGEYfC1Epe8AGf21H2Sa/rfp+vrlsvYa8isM1x6Dx3OGbTCQ/6FR9nwaI8hH9bCfo14dbh5ccWXTqnsrVhT11t6WreyanpXdSu7pu3ebQ3mjVq0YrpfK6GB8TwX2IAXLduc5IXFoJ4kT0B4QUUH6OIlX4hi6TXbuczFpcgrXlxQKNBH2nwQ9Nc3T1sB1Iv/QHnDXooCmV9p9oZkvx/rFdcaRQ/+4Zu8gZLjCaT5VoZ/DiVIjMewZ/jly8ZsZAJGx7YmU82CNZ12tqm9CY2OCw8zPjDso5uRVeXHhOTGHvsdg6t/KDtnh8P9L7Qy+kfciej8uE1HLylMYxg60uxoSIvZFIe6SUScx7Y0AUcMD788YjgQ4wY5DXI2WdIq/XelVpciB+1s6U5AYKczEBwkp7DaUXshTaVd3HiP/aYsnPUflYxLqSy6JSEZIVDYOlhhBmGYAdvwqDbFKjYuITh9lTSAJgtIPPkf4t9rBh0kuQIzlsr6absNVuhzg8vm52F+GOaGwYMjlfXcdckL4QLv/65VVbK3oBfsP8W0Pu6Bslchq+B4TaBkseyjWxXqti5BkV3jZy6aw+poDh1IMZNKQ77XYpOewM9W5F7rY68AQ5Xth1+xkx4Yj9UTqCEztqFSzWoG1rEZL4yKvNYfsf7xWELJRU8cwZ9SP+keexsjJ84cQey8LIG7s+5t6VWt6BRgqSHDGIALp1xvilf/UDiij0ZBz20Zj+AYYMJ/t0IRd73+bnhvdRudmkzOEmrQt4uUQOsNQRFCY7l2nLMSLdxwSn54WpoMOkaGkDnmxbxP0mqPhPR90K670THshOi3MVvfvTt/vuLlWMWu5iKbtxBNoFByRpuG+VI81w2W7Qvy7zp/N9/bN9MPrmz90NfXlOQkoywnRYMzuXjzmuSgCz98uHUG5WR6Oj2YHp+kJ9P8ID08Pc1TnsOT9JAPj0ZwdHx4egj/wBmUf7Q04V8tCUhOGvLX4fBwNYr1m7Lspapkzj5Kxj5Kl/v+WoFB+azBqEpnwNDa8XJCGLvHXvEvwNCg874lWZC5OwzOxBX53keJou9wNFqd9p0stcrAGFLWL6QVdhkRUMxvyeYo3GVty0xUTqGtpap0wBjqMwwDrZU2zFTZHNXKhZAEYsxt2BA6SBcD5iNpYYQpF4VheeVqOWTdM9beXDQSJS/cNM+4hZnCkOKOmRKCmWax+yOXbyENtlAaTUKLgJB4OxQ23Ezde+J2idtVck2p7BaM2rij+tznG0pJbhx1/AWwg0e5XDMHtdoh0Hg1B38YqTtTWVZps8feLkuR8aJYOt/zCyxZ9CedKRD38DE64AuMBjANBdlnPkhOQwZH26HeMQZKqRUM7NFILkzvhwrSw3MZm6HVLuTMOKeESzQJK+PQTCpRYMTSWMxUUfs5lzlFEIR03NuooaMsQ5xIGHYhSbCN3T5eDBrZUGcLeZZnnLmW7MI3ZX6Tli6ECk5kuS+JNAs8b7MtwtSvw3o9N2LcsLKNvUvZDCToetf80IEYptJTnjmCYFWSpACF9igsxzqwm8Pxz8Lh1lDAJZfW1Y9ZFRhk6U+yVwFCMjrTFBpHsVF7Wy405+2XQWsIwkekunD/pZo1Hwbyn6C1cOHIP6mVSW/yYs1aooNII+I56hy88PHqYQvf7HCk23P7pIZbC1pCMdL2ujGTs4t65nYEuZlrfuOL2v91FK3jLMQ2dSaJkgPkdtQEvnmGd1J8RUehHUKq5wvJMJGPMdy9wYeJ7apybNXmhi0519fA2M0OE5o2oZDilef+9L2w8/R3CalTfuTWrGn1yvOOa4pb0+cB3e/5X2/PcaS1CrsTwUDhQ/WxZOBSMGi92nClzoaVysQq4Dm/hDpQVcAlFAb3zquRoCiiWEkyoamO+qGDm5Lx44t+HiXNFfY0cAzdLiidcPlljAnuSlpMKYGFcSWnlcwhH5d8iRHllhHzoWVrJBPuimmjik9WjLWkoeaSlxXlrF+BnauckmthNhZnoz1oAbsELaZL8mK0hgyRlsqIO0X2dzQDcFbmZ22E+mh+Afkee10AN8CyOWRfnJGCFquH4wN0qNrXLcHXoY/DiD91AZS79IXvE8z2xXX0AFwIgxJqrFWFxS0bgPkWY1ktJqD7IXaM/BbQP1x/5vrjmQhq1+PynIAO91TMTIQWbc2dqLbauwnmqWW4pZYpiTHVYMwuKmObhkU/sLDaKTc2nBZXWr8BYU/jnUn4EhH7MXyVQB0o5Z6yEfPYRYdrvCDzGFJcgzI26cXWT8sXMndhxvrkkAdl51yyA7ZQ0s4xqcOmla00OHwhuiJkXhmrl2PjcrlKjiUXmRlnKodxbZitRVy33p2ev2Ffhn172HE7hH6anw8wsCZ8rXiBWuSY5WImotjZANcEAGYLuEZkru3uaN+IjLCaVbCHHqzDasUCxmo6HZeqENlyLPliy71e3IqIi7797YKopL8dE88LzzKN0T69+cy0mu0guZ+6fq6YJFBsUqAoR8sq4mEEUIBZAxzT3STCXSBlk3bsdN0F7TN3uHOg8C1CdmM4H9djYDgBU9NpiOqswxzT2dtse2y8+96/iGlzzEtuzQETXnCZwdjde7qVtt6E6hmXLiWVf6Ztd7OZzds+V4XIUarj/x3gYFaQIXqXVlG4bhXMCFcO5RG4zCMhWA8N090/DVYMMZMl3QdswEpvsvk7bBLWQo3qMbLZT2HFc9emzvyg22UaMQzCp+REcY1meGh3l/QLZxgNfhanipAchJXF3CGCtxR7xGS59G6pv5EZosAYXO5oNGdWjEFSToPSJjyzSo8V5crWYuu23P2YxgH8fcho3zgsrsCCuBxln8NbH9iA/2fasZ019qg5SizjAHxqQZOvv40VsNprd/q9jnb1g57xHtTHuA5NUJzSV6/AJV71dasIocVt8bfa/xDy1kg3Yg6ta5cGUw7jmVbGYLgjTC6BnIFNto5vsbu5A+QjRIsi+AUdSGS14I7MVaW3MQxvp+p+xdEbJ0fCjPvrNk00/oxnqAeLO5Q3r/1NghqAmyIej6lWf4Icexx3KumEiRcZVlxyn3TD2MK5NS6cXmN0ZkeOGTJeWNBr0I79KJv99h8CLgybAAq3CDikWjpQ67rzRdjbSi5ULqaCxHaAHKKZdwk2ZIzKlc12ABwlWyR3gtKAvvRS3CyNhUVsFGR41zYgKWDGoe7mRjvBtf8RAdQeqT7V/gKHx+kLEro4TaVLjmv+iVBffMsAcrqa4cqa1RSL84mqhVJfqnITLX8isGBwxdcrsOTgoXm0l7RzX3Ve50Mn6B7dh6QTKw/zp/hnuj86oNKJpkCbFCr7Ajoqfwq6YTn1TszfGa3XGCaO8IZwKw4oJFM6x1o7xXQl6wsF7eW7uVdxbl5P3BwD1hVT3/2ieJ436p5vtZwOzM1rmkKOqVQsn/mZy0K7kAxwPx8W8jKa73ZrXIW9BSu6mLArErnzZbbYMEisEIX+Ab5sge5fpKkMlf/vZslssygsJA+DN5XgjUuoITnIpprQqpRc2ZoYs9tkmq90v02oLg7CwiAsTl77EMk6wLVW/lG0rXRZh35hNi+NKYTOs/m4vg4FXvkkjfxdFwEtCyLW3WkV6BKK4/klF0W4boIWf3EJjGLzT5/9yt7G+1RBMzbyR0oZCkagknyPl23O5YC9wrtgbxUW12n2nFM6sqkwG9f4dzabovsSBunkjtwFGmthUVp/19U/9sPreo7K0IVTyVRlUzVN6Xs/YHAzxUxyqzSG9rgotgvrcVHcJqTHRdF0dLsAgt8domNzbsbx27uPprhsbkx44ObG2dxDWLEs37OBhgXuOKXOQ/Cg7jKBqfK3sJDoTMIVDhoMPbzMPc6FmVTauJs/dd56zcKarXc4fY3YQshb9Vo/G87euiHaGJQdT7GutEXd5w3QdOqoiaPCT15ePsynfDQapTwfnqSHwJ+kfHjM0yf7T45PTrKDyf6T0w2LDqMtKNt9G9vfJfhc/6g/ndQ4Y88F5sLxmhsmnwfsGSal95IuVQIKrI+obuWBOBSufxB99b2iso3ygbe2XYr/wV6QYfXmbgrWUOxvG65YU3N8xU2XR5KpkMLMxz7KidqVyqHJ9PoJMWlPIOfj44WUb8KyevJOTLBQzooZ09A3WWHGagA73t99F18h8/iX9hhnbiCULRqMWeGZzJUo/dgcNEh3ZFels7vqxW7uSiCJyyut5Ix577s7x5+ivAWbO5EMEn3tEMX7U5Qu6foQ9mZ7bH90cHj0qOeIzZWEW9dDvMbeoRoiHPL9YStRihUHhcg2RRp6D09euQpwWJd6bBwd/wqhaZT3Nh5OpBROx4HfJpDdC2tzHcHb5vWAuiaDdt/tC9ZmO0s5nPFCXTXKG6iWa1NxQ+3b3zqagFOGar4uQzRjBHczQVyk12TOhjU363zfcHt1SLN4QztIKTxoZoOmw++pz608EP+mhLtz9sD3eVDfJJCq8YYktTJBq0y4EdlP9s45lfkF+R2sTTIydnNhJUBuGnrIu4E99keg25UvDl+zOvp6Z4K/x7LwIGdmlBbV3mTVdaHGMCqqFXQ/MUZPlsT6IHkn5uwQYAyfUWV6ZpmpylJpy3IyjoplN8PvxVFYg8uA3nkculP80IDsJsw72axN5WL4wsb4dgUvL+l1Dtkpe1mRVjnph+l4IrSd7z7Lc/8GCnWPrrHXoFQ24QxAkjnbpWljLehtjPjwCOSIw+Hx/pM05/w0PYT8SXpyBMN0/wTyo3wIcHJwtEGkUTbsFk5pUXD2Utg/ZxiKy6nil6Mwp7e3ruiiuMzZvJMNw8vkyrmIMdXsidDj6NwxpUb5k8n0eJSlEz6Zpod8f5SejE5H6cHhEEb5acYno5MNlLqdFDo3XPA5+wV0IWQkE9IFL+VLT6utKRRsapDG2dMx7rG5bmd9rdbGElZvjTY5vVl02YskOpdyY31oq9mtvTXs3fEYGaZgB+w9wBcMNUk7p6t3fwfehzoETaLsvWNXKUy0SdqrhkK9bhXwt24rpr3F7u3L0b8EQyG+zPaXtRiuB8kfDb1x04L+SRTI9SD5LWqQm9Z8r0ruVckPqJJrf/s9+p4O6cqb8PFZRFeQfLbyHgK5f0KSEKGTUUfD+x6oveHVCTp3fqb/Tv+dfh/i6evz9L9iRJ+mmgPPSUzVk/W+wPI8POLlrtviQUtR+uXs6evz+PovN0Zlgko7KEJA12WxAd4QpruyEtWLqAsYB65N4/L5A8M+LISkooDG2Dve1OalSOs3h//VD5g2Pn6EMPDaL0rTdbtVv9fk3mY+TveP2g8NNT6PT2+Asb+onIIK3T3c9ZcEbnohJf76xk0X0JBdCrx51nz9ML4dZtXK7zbcwc8X+CfCet5D2fqh6pdKp15vNn7o4P4J7PsnsO+fwL5/Avv+Cez7J7Dvn8C+fwL7/gns+yew75/AXv9Y5v0T2PdPYN8/gX3/BPb9E9j3T2DfP4F9/wT2/RPY909gz0zrvP1lnrxmf/iQunv4AmPV/p5B5Dbmbpeuvpbtg6HbRnZdW6RhCRpZhim5DSgKpQs5e7wbulozulh8Mkh8KP7T6rPebQZxTkLv9zFD8OnGJ8B78wo//V3w9svevW91j46aL03Tw3SmBP4FuFmm9J5rnU+LP/bcboWpsBR1jxY5brujbMgKNDrBNwvSUBkkrt3lGtf+wnoMXd3wS+t44sNQXej1r+R2l9Dfq72UuveaJSHn+FsF9AvvKGswwXiWPL7cf9z9rffH31fzkteP+37tne5B+2xnpQtMJvp8Bi+FS2ekOSwop7FyvJ7DQnV2yI2XussU+DWufs3AvWO+1nRxYt2YJX6NxDCQVZqKfj98D0UZTzMsEHlaIV0+fGq2ekPxMjoxPW2jGEGIIZFIeh24psRq91Fcl8ui9xsZr+wcnYlwOXGQvKEb5T8ygxthzQTXgwRTjX/UScqGFLjp8EdJucWJjUbZhrfst3lYP855kz0YDkGdZl/5oent3uaPI7ZjAw0k3Rf2NzmTzQV03L6m5rnJv4q+0la/iNzzu8KH6fBJOjrt+13hztcdIR5Bdv8OijQoK1/s7+6qh6wr1R1gGh93KDJSI2c+SDAyYn6fvgF9KTJoHPY6IUrvVz+mho9z5Gu0lFL6Gy8WGt91xWSGghw8qxjheGDYCy+jWXjiAysMcpVVi5DK/hfPa9zdn/AVFM/DrOwPfLncF8m7u4gorfy3/1YLJyoJUcYuuGyM80tVfAlXJVez8L3p8u6yvtc1BDGp3YxFBZe+mY8HiYt1t6g53pKwgp6GXbHb6JELdynHtIJYxoXbMxei5LbpH7rRkYIUlnrWKSR4KKYrkYp4U6QBrMeOjBHVYvlobYFBn/2JOIICDHcD0A57/es5Odr07NGliI/rNmoxTLzcwi5WJOIZwj4r5+KCmUyVLm/0PkQCGqNQIHzNGFdaWDgL6hUF2di/3nbh3nShoQcrQ2Z0URSflOpQeA0rBSKRh+Z2DddeX48I1GtMQgui+c/WQr+oyywsfLOPy4ILUl6krL976+JDcrm/+qsveGzOeiufegxWfHjNWBzq+3csNnqni+tr/PhrBVjw9eETyn1Nb8W4ahBBNZ5ripiaJ+dhMNgfsZsKqdYsNmTs5LKhfRL/9nRfcZd7Sc7VW+0G9p+8+KqXvI6M/ZVrkdq1ffzMESt92zLKV2us6h5oY5V2Y9um4fz63dtkkEx8WddCkROh+RV6uvzKbX24PkXZ1Cv8T8HlrHKFh25I/N//AN7gU8E= +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"; + + + + + + + + + + +Employee benefits represent an employee enrolled in a particular company benefit. It includes information specific to that employee's enrollment. + +Create or update(if the employee is already enrolled in the company benefit previously) an employee benefit for the company benefit. + +Benefits containing PHI are only visible to applications with the `employee_benefits:read:phi` scope. + +When the application has the `employee_benefits:write:benefit_type_limited` data scope, the application can only create or update 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/put-v-1-company-benefits-company-benefit-id.ParamsDetails.json b/docs/api/put-v-1-company-benefits-company-benefit-id.ParamsDetails.json new file mode 100644 index 000000000..97d758b98 --- /dev/null +++ b/docs/api/put-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/put-v-1-company-benefits-company-benefit-id.RequestSchema.json b/docs/api/put-v-1-company-benefits-company-benefit-id.RequestSchema.json new file mode 100644 index 000000000..c7cf8132f --- /dev/null +++ b/docs/api/put-v-1-company-benefits-company-benefit-id.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"required":true,"content":{"application/json":{"schema":{"description":"","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."},"active":{"type":"boolean","description":"Whether this benefit is active for employee participation. Company benefits may only be deactivated if no employees are actively participating."},"description":{"type":"string","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”."},"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 short-term and long-term disability benefits (different from voluntary disability)."},"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 short-term and long-term disability benefits (different from voluntary disability)."},"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":["version"]},"examples":{"Example":{"value":{"version":"98jr3289h3298hr9329gf9egskt3kagri32qqgiqe3872","active":false}}}}}}} \ No newline at end of file diff --git a/docs/api/put-v-1-company-benefits-company-benefit-id.StatusCodes.json b/docs/api/put-v-1-company-benefits-company-benefit-id.StatusCodes.json new file mode 100644 index 000000000..2f8256673 --- /dev/null +++ b/docs/api/put-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."},"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":"881ce3f2-e3e1-49c9-8ad4-0bcf515f5618","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"}}}}}},"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/put-v-1-company-benefits-company-benefit-id.api.mdx b/docs/api/put-v-1-company-benefits-company-benefit-id.api.mdx new file mode 100644 index 000000000..39e34ba08 --- /dev/null +++ b/docs/api/put-v-1-company-benefits-company-benefit-id.api.mdx @@ -0,0 +1,75 @@ +--- +id: put-v-1-company-benefits-company-benefit-id +title: "Update 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: "Update a company benefit" +hide_title: true +hide_table_of_contents: true +api: eJztXOtu3LiSfhWu9kcSoOVL244vvzbjJHuMs5kxctnsbBLIbKm6m2OJVEiq7Z7AwDzInpebJ1lUkZTUanXb7djAnIMEGEzS4qVYLFZ9VSzWt+g6nlTGqlhICxPNrVAytvMSopNPERQjyDLIokHEy7LdxERfBpHlE4PNTlVRcjlnP4GEsbD0TYMplTRgopNv0XBnB/+XgUm1KLF/dBK9uuZFmQMLLaNBlCppQVpsy8syFynNtf2bwQ7fIpNOoeDLI72f4iilBgPSUhemxoyz1NM1cnRtRYPIrSxSo98gtdEguo7BkUF0epLwr1UlsugkOtiHvcN0eBjv78HzeJ/DQcwPRsMYhsdHxwd8d29vhITPQBtHy/HRb3pveHQ83RseH0318d7weDI+hom5tHuXfKLF3vDr14n4CntHh8NoEHnaEkfY7iDiqRUziE6srmDQWejfuTCg2TnogkuQFqc2qtIprgmuLWjJ82gQlVxbCTqRvMAv//Pr/7JTpcsIx8vB8lFeT2CqslTamqQEnSL7JpDwQlXSmtDEb5AY5ZCMlU6gKHM1B51Yfo18G/PcrG4GydWwbpNym06TqvTLjSAHt9ybm0FUalWCtsLtRc3Sb2HTjNVCTqIuU3D300prkJb5Trj9dgrMbfMWewdA//7kvws5YZNKZPDl6dTa0pxsb2cqNVt0ErZSVWwHyY9LPtcqz+n7tsigKJUFmc6fsbHSTMix0oUXOcmm6opZxSqD0wnDxgLybCu6GUQgcZQCpE1SZG5rWXSqQPeuS1bFCDQuJ3DTMDcUZExIWpSXoAFTMp8zDbbSEjJ2NQXJutOyrxXoOSu55gUThhmwSDDuM54ODTz7ReZzt/M3eCDpBCXuNNxlJz58OHsZ2O979478XSO2T/TSyIsn6k5sxiZhCt8d2XI1Fem0b142glzJiemdPxzgeuaRUjlwSTOPeZXb/sP9cQp2CtpJTphIGObGI3ELQoAbaEUqSpK8LXa6SJ5hBZ87cRgBy4BG4BZFZsykaskS1+DHz+ftQeWEpHaBwOW9KoT8L5ATOyXFtczW1i+rNpC9xmU5tTtoqWxawHgMmhVVbgXaiXpxV8JOGZfMicUue4qseQOZSHnOzqSpNJcpPNtiXRquVJVnzOApNaoAO0U9UCgNzJSQirFIWS4ugf35x/8tado///gHUxo//ZRXwE61Mmab0d/fTfGY//nHP4hnQR8vswtkVaC5REn0inpZZ0OG1nOZl27YlWx8j0KTcokb/rme4XM0YJ/rSfBfSrPPzVSfox7ZSTWQrMwEp7lenJ8xL7h4KNrjbbFT0JYLyfyQjgY3QpfIsHGtpSyS0neYFi1Z4OmnhqmyyvN+jvmuDLsGvoXf7JTbeqG3y+Xn2oSuILNlVnuP/cpz3lUsfgtpPMi22MswMLsSeY6fWiobj3NbZU25YVKhdgKJRohMhDdgA/+10SH1tnBjVCqQFQPGZbYwpHAjqis0KaM5+0+0kChFnJ07XpLMrwMRd2ZITVkGWZUSyiR6Ao8QHWoxqtwXzylkBzesmdjgXvtFk9LkkgmZiZnIKp7Xk/gjIwzLwIIuhF+gbZmDwAQkwjMiVXIsJpWmLfHN15m527DTBtICgXZNlrsibIOiUPJ584nGdcafy4alwiA+yYHPYIshhcwDbFwHitNU6IyOx5wZkV7SoEFCSK+thXcPsYyxyIF9jIe4aYUJW1ev4DvJ7yDPjTRJkAcaI67KBUkkQts2e4DyqOFrJbQTqXdAwsye7+wFPfTu1emHt6/YcGuHvUCA2rOkUkNs+TXb39l9evmMZHB/Z+/p6FlrXY1NqYE00g8FWpEb2jRHBjYhxIVem7Cop4LXFnuvjVBqvy8043nVdoqyYQrp4f7zOOUA8f7zfR6PUj6Od3ay473x4c7+cXr8XU7RIuyMjo52U9gbD2PYg90YR4+PeLYf74zS8cHuwfjg+e7RD1eqcaXwzyDa39lfdpV/Vpa9VpXM2GfJ2GfpXOevFRi0hBq8bc4UOH0H18LYLfaGXwIzlXZuVKnVTGSQOWguDJvxXGRbnyXK0P5wuDztB1lqlYIxJN2vpBV2XlMgHF6d8rIE6VQXmSCVIQZkc1XpQCOdPC6kYaC10qg/0imetwshiYiEW3cyISGpvSDIY5tVsjEXuWFZRYeMy6YnOp+Epy9aDuMrN80ptzBRWoDZ0GMkMuO07v7M+Z2kNAh5ZmCRIGTeveMffdz9wdwuc7uhn7ZudAtG7bgYhPC/N/aNa83n0SASFor276tHTS4BO3gq5yvmoFa3usPvnJviDLw/jNSdqTSttNli7+clukH53JmkS5gzkYG0rhe2r/dwm6IACH6YhtwhYdUMGaymo3oD0toIyo1EjlgYKmgPL2VsolVVCjnxWM+hOgKvVrFRJfKMpSgHhW8/5TLL0XET0klvKyq5xc7GzUTCsAtJii1x+3gxaEWFHKD2Is84cy3ZhW/K/CbNndcCTmW5j8SaAs/bpNfRW+TMeVivl0bGR6qyrb2L2QQk6GbX/NA1xK30mKeOIYiIZIb80Z4KyzNueZ8oLpJxGg63hhxmXFqG/XBMLyBzf5K9CRCS0Zkmx5ngZA1POt5Rewiij1h14f5P5umC9jb8glb9ovZngjFBNKMk/DKOTj7dtpY6JkAj4jnqHLzw8/JhC182ONKLcxshJ2Fm7MazTOAnnp+3ZnLmvmfueTcutUJqfm55rZ6j5LQ2YpMq7XBCZphVPspYM/j2GT5I8RV9yKAetEeyYT4a0WnvsVbFGsxct0M0otY3XNBzfQ2M5XYdQEdoEyDsGy/98Udhp/EvEmJn/KKb1a3eeNlxTXFrbgY/9vxfYc9xpJUGu+OOovKhACkBXAykrDEbW+yMIiGlMoTJUeNN+Qya2GQOM8gp8uDNSDAUtVqJUqHTKuf6qSM3JvAT/0IC9yxqr7CngRPoxcuqEZeXCU8prp+4gFFSyXElM8iSks8x6r8AYj4tYI1oxN2dW23ioyWwFrXMXPS6kpmQkzdgpyqjaFKYjdWz0R4sEDYDLcbzREgS3RQpLZURD0rZrwgDcFbmZ0XL6QJhjOYXGEo7z4EbYOkU0ksHUhCxenKYd9S2Vi+B5xjdmSdhxEddALLXT+jCefU6eggshEENlWhVYeh+DWG+ReLulfpJ7ID8BULfuv7hXko0gQ5Pl5eExMXJTE1ajTU34tpy7zYxLyxGhIxlSgJrwGxRGdsGFv2EhdWOubHhtCS5KIRdQ2FP441Z+Bop9mMwGgNvJPBiYgQIQ93OBJoxliBU1tALMksyry1XUFk36aWtn5evZIZ4EFonhzwoO+WS7bFCSTs1iAnHla00OPpCmEbIrDJWzxPjghBKJpKL1CSpyiBpgNlKipvWm/PzZ+zLsG+PON6NQj/N4xMYRBO+YijaKvacZWIiarWzhlwTCDB3INeI1LXdnNp3IiVazTKx+55YR6sVBSRqPE5KlYt0TgGyu+11cS8mFn372yWiknSiIKvPC09TXfE80evPzEKzDTT3C9ePYb+aY6McVTkiq5oeRgQKMCsIL4GMa+IDKeusY6frJtSeusPd3Ag7sryP62lgOAFevoaoziqa62vku2x73XjzvX+1cF19ZwkY8RzvgZOqvEVfrrbW66g65ZIipDz7jbbdzWbWb/tU5SJDrY7/OYIDrCAg+pCoKFzsBhhBkIJ5CuiCxFGwmjSp7OORVYeYCUn3ETZgpYds7j5ZSVhJam0eazF7FFE8c22aWyl0u0wrhkH0KTlSXCMMD+0ekn/hDCPgZ/VUNUmOhKXFPCAF7yn2iJkp0rulPhMpRIExuNyxaA5WJCAxfpTQ/RlPrdKJotvSlbR1W25+TOsBnL/X4BtHS+YSa1DKUfc5epsDG+h/TBzbWWOPmTMWU3PkJOFjC5p8/buggOVem/PvvMbVT3rGe9Ic4yY0QXFK5g/KDKT1qwihxbvSv9D+uyhfGOlWmkPrxqXBK4dkgik/GO4Ik0sgZ2Ad1vEtNoc7QD5CjSiCX9AhiVAL7shUVfouwPB+pu5vOHrr5EiYcLxq7FDjz3iKdjB/QH1z7pM5GgLcFPXxGGv1O8jE0/Ggmg6jPn76JZfcX7phbOHMGhdOb2h0sCOjXJncgl5BbeJHWe+3fxfhlJqAyq0mOFy1dEilUKMwBAA9sZUsVCbGgtR2IDlEMx+S2HBjVC5ttiPAcXKB5U5RGtAzr8XN3Fgo6kZBh3exAWkBk7jM3TvgBNf+exTQ4kjNqZaMwpOezoJfi6IqunSaSpcc1/yIpL66TgEQRXgaKLFyZ4e4mit1WZXrePmIhAXAFXwASjl4ap5tRYt3X829zqdO0L12H6JOrDzMH+M/493hHq5wQaGNcpVegq6NPwXdMOV7I+HvjNYLhkkiPBBeiAMKyZTOMHFKMV3V2Xzd5bu5l+lcv556cwzYqnycRfEsa+Ub32s5HTLXr2kMGV6lYkLNYy4LcSEBcD8f5t0xmu9+a1wm+w6i6GLCLknkwZe5IIZBY4Uo9HfI5QLR/Ys0lcFYxIYh9rssijIO/eBtI3jrEhqSHMmmGtGqlFzamjpmtw6aL3W/T6iuHoSFQVg9eeNDRKsIbqzy91K7cF3W4V+YzWtjCqHzdJrYqQYzVXmWgDc+Uev+rksBLQtqWjfnVeBLSOTlMy7ykGuJiD+fAaPY/IvTv7H3gTgWLGPr/kgpQ8EINJIfhQZ2JgfsjZoBe68wuU6zl5yuI9sGs/WcaWPYVLsvYZDO3ZF7xmEtFCU5sfgEiSAd400+R4XCiZBDVTZW45i++wGDmykmklulMbTHRX63sB4X+X1CelzkbUe3S0Dwu0N0bMpNUn99+GiKu82tLzxwc+vZGKUHhSTvIAYaCtxxujoPwYOmywjGOBjmCSDTmYQrHDQAPXENWZIJM6q0AbpMau6tVyys3XqD09eKLYR7q170s+bsrRpikQZlkzHmlS5w92WLaDp11MRx4ZGXl+1kYz4cDmOe7RzF+8APY77znMeHu4fPj47SvdHu4fGaRYfRCrrtvg/2dxd8rn9tP53WOGEvBd6Fs5fu8nnATvFSeivqciVQgfkR1b08EEeF6x9Un0PUCO3LRSqfeLTtrvifbAUd1mzuumANxf7uIhUrco6v/OuVloxEYyGFmSY+yonWFRMJHPR6hJi0Z5Dz8a3Ck21ZM3knJpgrh2ISGvo2FGasBrDJ7ua7+AaFR8g0rzLU6G4g1C0ajFmSmdSlKH3fHDRId2SXpbO56cVuyFofJb7SSk6Y9767c/wuynuIuVPJmMWv6yje76J0l65PYWuyxXaHe/sHz3qO2FRJuHc+xDn2DtkQ4ZDv7ixclGLGQS7SdZGG3sOTVS4DHFZdPbaODl7f2SmYVnpvE6xyVzgdB/4ugexestbnEbxvPw9ocjJo992+YG62Q8rhjOfqqpXeQLlc65IbGt/+3tEEnDJk83UFoh0jeJgJ6kV6S+YwrLnd5vuGdzeHNIsH2kFL0WuqNZYOv1Ofe3kgmBOMb0XxE3vi+zxpXhJIhU/zCmFtaGWCVRlxI9JH9s45pfkF/R3QJoGMzVxYCZCZlh3ybmAP/gh8u/LJ4StWR583ZvhHTAsPemZC16LaQ1bdJGrs1IZqibpHjNETklgdJO/EnB0FGMNnlJmeWubfT7GMwFE+797we3UU1uBuQB88Dt1JfmiRHB7lLt5mrUsXE9rY5H4JL6+xr3u7vOAmdXEz2YdxMhLaTjef5SXdq48Zda9dY29BKW3CAUDSOXe7pq1zQe8D4j14Pxxy2H++exhnnB/H+5AdxkcHsBPvHkF2kO0AHO0drFFpdBt2D6c0zzl7LezvEwzF0ZPfkqMyR3eN4YElGZ52bsPwBbJyLmJ91eyZ0OPoPDCnhtnhaPx8mMYjPhrH+3x3GB8Nj4fx3v4ODLPjlI+GR2s4dT8tdGa44FP2E+hcyJpNyBd8xSo9r+7MoYCpQRqHp+u4x/q8ndW5WmtTWD0abUt6O+myl5LauZRr80MXmt3bW8PeHY+R4RXsgH0EuMRQk7RTenr3K/A+qkPQpNa9D+wqhYnWaXvVMqg3Cwn8C68V495k98WXyD8FoFC/Q/6nRQw3g+hty27ctqB/EQNyM4h+ri3IbWv+YUp+mJLvMCXh9Xutvc5wbWVl49luHHyiUEGh+0NCPl/33WSnik1daa5dKMW4l1pNASMsuIH1i3w8vr4C9XVHLL2UVRNXFYP72kv4PijAYKwd4euPBPc+DB7X5Yra9cfCS656WnpJxm1d0+az/Cx/VhZ89Zuluj+h9ExTLorS0ejx51LVqFCFjEb9GJ6Vt16tk3HA3y66XD+50sLCSbtcQ+LzZS9cFo1JVQmDpRFTCs3n83C7sbQEZEFdvwtdWr8rGlpeaOBTa2RaBE16sorcC1cLwsUznPQ3z/EXH90hYHbVInrFS0gyTKRtmxuWvhoVt1Q/I10e6lLEVJknfnF+Fv93fUtEU02BZ2T6msl8CYnF2V6GOjhu25DDMVrUjCpAhcp6TbEgJ5b0BBsb4Ktzen8tEbKIJil24Nq02P3EsE+FkJRo0hp7w9f/vBRxU8/v3/2AcevnZ0gGPiVHC71qt5oaKsOd4UG88zzePXBlYHyttvbvNzdfBiEs9pPKKFDV3cN7FnHoqVDw1y+I2OK/GzrO+Rz0hsUR11bM++cukfejKN664lF/uTJYZqq0jVEPEvjAIo/uX5kwfCRyfJJds/xpJnAz8JjhY2k2U3klLdfzVutnf/3aWY+05h8Ft4LC/nKHylr3r5UVlCfZ9IB+rxEi8kvgZh5TgZUGjNRFmhdbIY6I1Qy0FhkKo3815UpUSkP3EAh6HNhfWTR6EJZ0S/FohC5hqC6p9RhLJPf3WiS96e2XgCbbX+OTI0BADmuWRtuz3e0u2tv+tgzabhA+YJqxB36VzhFXeUPJS+HsZJxBQcZy6QS/hEJ1+O3Gi12uAn7Gta0YuHfMc015CavGLPEzLt1AWmm6U/v0LTgzL1KMv7yokAufvrRbvUN04sS0p22tqpDEgKlIdQHXPbV1Q4k5Ko/AeGWneCcWcv8G0TtK2P6eGdwIKya4GUSIut42eK199OoTVyukdfXi6ka3mbK1hd6cxvc4cWUBNwTuLsk4xMxc2c0X52cLZfVawHQQoco2v4zfgZ6JFFpi1GA4Kjy0TQ23M+QYwkvS9QYzwozvumR/IE9VQTqS6Hhi2Ct/tll4m0FFYlVaFaEC+7/5cmbcXXx7N+VlmJW9xZJT/nbTJZHhOfBf/6MReyoMrowtuGyN8yGkt3VdoiVAVqPxH478D0c+OPL+xFm4tttlzgUpI1K+37xt+BTNdluFKEeN0Tzpceq/4JtUY7Hbt2/oM3/Q+c0N/kz11lHJolnSwpWL/PQtIrSUr/LF22L79K2HFM/YbfGAFQsLlXDkvGUcI1+Wpy9G4R7ZurDBZsT+i8cQetnr2NgfgKm53SCXU8es+P0CXFoOFTQ90D6Wdm3bNsQ5//Aei6H66EShCM5pfoW2i1+5rQ+ZJRi+wN++RTmXk8rFZN2Q+Of/AdTFF8U= +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"; + + + + + + + + + + +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 the application has the `company_benefits:write:benefit_type_limited` data scope, the application can only update 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/put-v-1-company-form-sign.ParamsDetails.json b/docs/api/put-v-1-company-form-sign.ParamsDetails.json new file mode 100644 index 000000000..3f675eab2 --- /dev/null +++ b/docs/api/put-v-1-company-form-sign.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-client-ip","in":"header","required":false,"description":"Optional header to supply the IP address. This can be used to supply the IP address for signature endpoints instead of the signed_by_ip_address parameter.","schema":{"type":"string"}},{"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/put-v-1-company-form-sign.RequestSchema.json b/docs/api/put-v-1-company-form-sign.RequestSchema.json new file mode 100644 index 000000000..e67745082 --- /dev/null +++ b/docs/api/put-v-1-company-form-sign.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"required":true,"content":{"application/json":{"schema":{"description":"","type":"object","properties":{"signature_text":{"type":"string","description":"The signature"},"agree":{"type":"boolean","description":"Whether you agree to sign electronically"},"signed_by_ip_address":{"type":"string","description":"The IP address of the signatory who signed the form. Both IPv4 AND IPv6 are supported. You must provide the IP address with either this parameter OR you can leave out this parameter and set the IP address in the request header using the `x-gusto-client-ip` header instead."}},"required":["signature_text","agree"]},"examples":{"Example":{"value":{"signature_text":"Jane Smith","agree":true,"signed_by_ip_address":"192.168.0.1"}}}}}}} \ No newline at end of file diff --git a/docs/api/put-v-1-company-form-sign.StatusCodes.json b/docs/api/put-v-1-company-form-sign.StatusCodes.json new file mode 100644 index 000000000..b62fcf08f --- /dev/null +++ b/docs/api/put-v-1-company-form-sign.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"},"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/put-v-1-company-form-sign.api.mdx b/docs/api/put-v-1-company-form-sign.api.mdx new file mode 100644 index 000000000..005304932 --- /dev/null +++ b/docs/api/put-v-1-company-form-sign.api.mdx @@ -0,0 +1,71 @@ +--- +id: put-v-1-company-form-sign +title: "Sign a company form" +description: "Sign a company form. Company forms must be signed by the company signatory." +sidebar_label: "Sign a company form" +hide_title: true +hide_table_of_contents: true +api: eJztXFtvG7mS/ivc3ockgFq2FSdx/LSZONnjAZJ4c9nsQSZoU82SxJMW2UOybSuG//uiimTfdLHk2Is9BzPAzCRqsvixWKwbybpOrtJpZZ1OpXIwNdxJrVK3KCE5/pbAfAxCgEi+DxLHpxZ/e63nJVcL9labucUPugTf7VQkx0lZufTiIM19q3SizTy1cqqSQVJyw+fgwCCd60TxOSTHCbbIpEgGiVTYn7tZMkgM/FlJAyI5dqaCQWLzGcx5cnydeGyJdUaqaXIzSATY3MgSESTHyecZsC9fTk+YnjA3A4bkk5tBPVycbl5IUC6VZRx4BlyA6Qw94YWF/gAf6A+8YL4Dc5rZqiyLBQ13esa4EAasHbLPM2lZzhUbA6ssiLVNESRDJnFXGWCgRKmlcpZJZR1wEeeCTUBk40Umyyz2rbk6TDawqcWB/0n/kzjw6uw0/W8wFqe1Iw9OcLy5VGAJl+AO0jHHKb46O2UXnijj1upccgeCXUo3YwtdGWqQ86IYstMJU1oBk5aVRl9IAWLg2/CyLGROMvXIsm9zqeS8mrdpf388c660x3t7Qud2SEs6zPV8L0psWvKF0UVB3/d4KdPQU6rpvweCaevnJwgDF2kTFwcJqGqOm2C0P3qW7j9PD57hDhAw4VXhkuP27zc33/ts+ySninEW9gaJ5pC9bv3NsnllHcqLX2o29qISe3gZ0WYx/EP9oWyuSzhm5+FrRhSOsc05LaEttbJgcR6j/X38XxfOmys+LwtgsWUySHKtHCiHbVuLsPcPix2u24yRrkDOoBZIBpFPevwPyB1udYNawUk/elVJsYqbW+xcnAcXH1Sx8JrgZhDEeBtq2IJJAcrJiQRzG+Ewp60oY9Pb6HW6bUO19cuttA2fuBbVsdYFcLVE9rQhgxIuUf6oL7OOOxiyN8PpkL1RpGMWwA1z/CrKIl+gKMbNudSZlUZqUoBjkGrKJlLxQv70e2gJMRJvAH9LyN6QslFVUSRLmwUZQoCIE9KG7fIWVaWe+ynZAQPEX2Me+KbS6yXqfjmT+axhgoHSgAXl7JC9Yl9HpHt/56riZsFSdgI5qhDDRvujEbvUVSGQBwIKeQHGMyG2Hu2PnjKuBJvxC2DcD3fBi4okAwkEG+B/k5bhTPm4AOp1KYuCKe08jwkTQ61ZFH4uK7n4Z8WNg50ZGbr9Ai9zXoAS3NSkIl8DtS5jFXszLwu9APPIsv/yPYoFewsCDC/YZ37FPoKrjGKPUYOwl4cHT2glXpVGFgP2ji8G7PdKQXsdApsjgIbT7DHyc9UCPLn/FQim0WaoaHEn374JX7HwhU0KPmVuxh2TSqB2BcsuZ+Bm6EhEEVUAwrJAnmmDEIfsvXbgu7pmRjSDfMbVFBifuDYVaYMRWTkLofNqDsplQeNnfgqNVNVqar1Qha5ezQZ91bL5cYghe6etCzqFG2BnJ2+t9wj4Eo3zttkpxeR8yD6hhJJUygJYyfMffIpsw6mPgf2UJX2x7DES45K4hmM82WqQn7I8D1LCnTNyXDmoiZ/j7M9xiZT3dMKc2IzbIDmgUHZKblZxetAxlOlJ6J6+9ojSz4sS6D/ooSVXKXiTTFYzmOfGgCaHR7kQzyBP+aEQ6eHR4X7KD0eHKRcvXk6eHomjw/2jJBrIJLoFQhrIXSag1FaicY6QTugDO/Ef2KvKzbSRP4ktSzL8FUgu0UEjPxZdmZKXYC61+YG/8NAdfV38u4CxdLTNcgNCOu/ajbn6wXie60r5j7So+IeSL3wTx6+Atl6wccED9fYD16OlBf1fl7ek5/0aIU96MhZ4HwOcOrBpnOBvfgW+3wySNStE2/GvpfJL1Vue9sptuyTrFvWG/hkkh/uHyw7te+3YW10pwf5QjP2hUEkhGbCojwxYXZkcNzH4zQtX0qJ64j+AWYy8cIvX7g75ol7TSjH8Q2GseTgaLQ/7RZVG52AtGZY3ykm3qBFI70fNeFmCahTJWIsFuVzIxoCRBf1lGRijjWW2ymeMW3YuFYHIagWVkbydD9A6uGaWbMJlYZmogJZZNT3rIB0VKviZfnvjh3nNHUy1kWB3DKsIZprX3Z+waSUF2R821wbdJoeAkHk7xBa3c/cv5vaZ2w/A2rrLTxg1WjcsC783/gs3hi8wF+Bg3v59PdXsB2CHgHKxZgxqdWsE9KmEHOM08ojCZqTuTOd5ZTChsigl5g4W3gX6AYsmuvNear2Ge3VahBkoyB9xuiE5xM1co94BmothpZ4ESoxcoUAqao8gZWxqdFVKNbVeu3ZzQeNKFoLlKAfz0H7GlSjQf5HKS28rK0cZk3ogadm5IsWW+XU8HxA4v1bBMfQizzjzLdl5aMrCIi28hwReZfmPxJo57rfpFsHwWZxvkEbGx7pyrbVL2RQUOv1x1QLpyAxbmQnPPUO4wtwX8scEFI4L7vgqUezCeB03t4ECLrhymJPiSDMIyCLs5GACpGK0pzHSJrURNNK4AB8WBTM/6JAgfMSqc/9/sl7ntLbxF7T/57X/GI0J2kit4MOEMp+b5zKvCicxL0MUcR/1Nl78eXmzxS87bOnu2FaqaRwZu3EhpE93nrVG8t7VirEXvTBindS85/M6YggcDZFNFJtcG5+WEuihkDS0GHz7CF+U/LPqJH8mQZt7MkTRa++J0fMNkU/driozpzc37Oi5VQ0ob7KpSZOGSt4F6U+/SjdLPyhIvfFLbta3ehdkxzfFpcHE719r/s+/5hR7rDPYPf8flY9WxcI7uExuNBtDduooB6+tlehiOe0zLbUeKuACCotrF8xINBS1WklyafKq4Oaxh5uS85N+IIF7krRnuKKBF+hu8IvBRxaCj0xAAQ6ySk0qJUBkJV9gDNFxYr51fI0ETyPajslxsuSsJS0zl7ytlJBq+g7cTAuK7uNorB6N1qAD7AKMnCwyqUh0m8jtPpH9fSkWy7kKSSsaX4IYsrMCuAWWzyD/4Z0U9FgDHMbn2BFN+7op8AITF4ssUnzQCSB7w4A+gVLPYwXAubSooTKjKxfSbWuAhRaZqjCDuxpiz8nvAP3o+zPfH/dENLsBV5AEjF0ncmpraLWvuRPXlnu3wbxyDJcUE5LQnPHV50PRsVgNLM52wq2LuyUr5Fy6DQhXNN6ZhW8RcaDBiAazs5hE54GzNeasBCO1aPCCEpkI2nINyrrJSmyreYnHG9intXMognIzrthTNtfKzehsZFLhAazHF3MyUonKOrPILBSQo3RnisvcZrkWkDWO2VrETevd+fke+zLsu0Ict0MYhnl4gFE04c+KF2hFnjMhp7JWOxvg2gjAbgHXyty33R3tJ5kTVrsM9jCA9VidnEOmJ5Os1IXMFxnm6bZb6/mdmDhftb59EJWiHQWi3i88z03Fi8xs3jOdZjto7le+H8N+NcfGBapy9KxqPIwASrBrgJdAxjULiZRN1rHXdRe0r/3mFsBzJy/ofJJo+Bg3YGA4ANOTSczqrMMM/vwK7DbLXjfefe3fxK50NLK1BIx5wVUOWVXeoi/XW+tNqF5zRRlSLv5By+5Hs5uXfaYLKVCr478ecHQryBG9T68o3pqIbgS5FCwgoAS1R7AemtLu4WDVKeZwZrkMbMDK4LIZQFnVCtZCrc1jLWYPIoqnvg2LJBiGXbaVwyB8Wo01N+iGx3b3yb+4h9HhZ/VQNSQPYWky94jgM+Ue8TBQhbBUqk4WGJPLPYvm3YoMFOaP6GTD8Nxpk2k6CFyLrd9y921aE/DxXuPfeCyCNixJOeo+j7fZsBH/Q/qxvTmuMHPWcUN+Ox1gU6y/jRew3Gt3/p3VfvWjFfQeNdu4SU1QnpKFjXKBx9t+FjG1uC3+TvtfQt6hdCvm2LoJafDIIZsabS2mO+LgCigY2OTrhBa7uztAMULtUcS4oAeJvBZckZmuzDaO4d1M3d+QemvnKJhyJy/6DAp7PEc7WNyjvjnz9FsA/BD19pgY/RNUFnDcq6bDrE8YfikkD4dumFs4ddan0xuM3u0QeELGCwdmDdosUNkct/8ScGnD7bMacDxq6UGNF2fQpwpgKzXXQk4kqe0IOWYz7xNsPDEqlxbbA/Cc7LDcK0oL5iJocbuwDuZ1o6jD+74BaQFLd0H5pmi/2/5XFFCXUrOrFaP0ZMA551d457aP01am5DjnB4T65ioHQC8iYMCVONjfJ64WWv+oyk28fEBg0eGKMQBdOXhsnwyT7tlXc67zrZd0r8OHpJcrj+On+Nf0YPQUZ9hRaONC5z/A1Mafkm5STfROwt+jttIZJokIjnAnDygV0ybcoTeVitujP30/9jLOzfOpF8eCq8qHmRQXjWtq7zadHszNc5r4+5OZ41cPOS30C8kBD+PR7Tsa725zXIa9hSj6nLC/JHLv0+yIYdRYMQv9C3LZAb16kraymIvYMcW+zaTwxmck3jaCt06hgeQh22pMs9JqaWnqnN0m13yp+11SdTURFomwevAmhkjWAW6s8q+i7RyX9fgXRwvamFLoPJ9lbmbAznQhMgjGJ2md3/UR0LSgxro7ryJf6IYzpm0uuPTXnFGCweriAhjl5l+9/hv7HMGxaBlb50daW0pGoJH8Kg2wUzVg7/QFsM8aL9cZdsLpOLJtMMMjmju5TXX4clG/ReqcHVFejDsH85KCWKeDS8d4c5+jQuFEl0NXLtWTlL4HgjHMjG9nMphzWWyX1uOyuEtKj8uiHej2AcS4O2bHZtzfcqSv959N8ae59YEHLm49mn/UEQDVYmBgjitOR+cxedB0GcMEieE9AWQ6U3CJRKOjJ69AZELacWUs0GFSc269ZmLt1jvsvlZuIZ5brfR+Nuy9dSS6GLTLJnivtMPdkxZo2nXUxHPhgacn9sWEj0ajlIv9o/QQ+IuU7z/n6YuDF8+PjvKn44MXLzdMOlKb02n3XXx/f8Dn+9f202uNY9a9rDxgr/FQepj0uRJR4P2I6k4RiEfh+0fV5z1qdO3LLspHwdv2R/yPhlGHNYu7KVlDub9tpGLNnePL8F6gJSPJRCppZ1nIcqJ1xYsE3vV6gJx0YJCP8Z3Gne1YM3gvJ1ho78VkRPo2L8w6A+Cyg91X8R0Kj1R5UQnU6J5QfBi7JDO5v6L0a2MQkT5lf0tnd9NLD+H8yzpUl5dG40s4H333x/hJr413FXOvkkFhrB2zePjohQ5dH9ObrYPR08NnT1ZssZlWcOf7EGfYO96GiJv8YL9zUIo3DgqZb8o0rNw8ovI3wGHd0WNr6+DxnZuBbV3vbZJV/ginF8Bvk8heCWvzPYLP7ecBzZ0MWn2/Lng323vKcY8X+rJ1vYHucm263NDE9nfOJuCQ8TZfXyDaOYL7GaCeZLBk3oe1t9v80HB7c0ijBEe78+R5g6Wj4gLY504RCN4JBhGe2j0KfR41LwmUZiW+g3cutrLRqoy5lfkDR+ecrvlF/R29TXIydgth6cFhyw6FMHCF/xH5dhkuh6+ZHX3emeFf8Vp41DNTOhY1wWU1zUWN/dpQLaF7wBx9/ehvdZK8l3P2CDCHz+hmeu6o8IM2jvknXsWif8If1FGcgz8Bvfc8dO/yQwuyH1D0TrM2XReTxrrsbhde3mJfpnrXXpa0lSD7MMnG0lBRkB1HOaFz9Qmj7nVoHCwoXZvwDiDpnO2Oaeu7oHdx4oPz/mLE4fD5wYtUcP4yPQTxIj16BvvpwRGIZ2If4Ojpsw0qjU7D7hCUFgVnb6X7OcVUnKAbvxyVOYZrDDesf8reOw2z4J9Es2Ye0bFeEejcM6dG4sV48nyUp2M+nqSH/GCUHo1ejtKnh/swEi9zPh4dbeDU3bTQqeWSz9hvYAqpajYhX4qFfzUeXq9sx6HoU4Oy3p+u8x6b7+2sv6u18Qpr8Ebbkt6+dLkSSR1cqo33QzvN7hytYe9exMjwCHbAvgL8wFSTcjN6evd3fDa6jDomTWrde8+hUhxok7bXLYN607nA33mtmK687N59Q/xbdBTqF8T/tB7DzSD52LIbt03oX8SA3AyS97UFuW3Of5mSv0zJL5iS+Po9uG+/aUHRZL9Y2h1fWt9ax6kuUZY5uGpXH9pQ06jug9zlUwPtp2LrCqZ8DSVRsIIB9anrGNBJh9HKvwNOQlq9XxRtO2itAmytAms+x30507EGV6yoMmS/aTdjp2cXh+zV+xP8w3M6nAiuPXr7eF5BKjekCfqF3vxzWxnqvchW9Tb24SNNF5/FFoAZe/+OttMGZQaFpEe1d0MxFKbzZyL44Xyp6N15bBQqzA2Tm5vuK9PeWse126YERl9Mkt+5AvZpLkkHBxkIZf1WLl5y8HI0PHh+NNwfHiRR5q9SWwL/AdwuUnpW3aQBfMWObhO0Dam+AGOkIDnwNQjhyoGylHjAPe5399oSiIM4qXYpRNRUsV8fUt2hC211ly7EpitBxepxIT9PRRWpfqKbJcfJ3sXBHuU99q5D7cSbvTA7ui4U1FdlClTxoeQAL6WvOJAKmFPZgaUtcQJz3WOip5f6Mwf8jBNZQ3glzTND5wvraJb4GWdqIa8M5ca+XUff5VWOfhSWOkmOv31vt/qECszL34q29dZHiLGaH2kb4IbcpP7bcV+qkp45Um0UzG3FM/xB8okuXv3KCJ7CmgFuBgkq5o+NSm/tqaWtVKuzbbZRUyMz3uuJbipVgMSCiih28fC2Xb1wkGCFR/th8gnMhcyhteJN4Qp6679HDfcETg6NRUp/x0NYG7ou16cpcqrppBnheGTZm7C7WLwOibUeY60YYtS/hQoi3OeaQ+Gckzgq+4hVHkJC0Z/bosiGr//RSCjyu9TWzblq0VlRmbEP+7oxq/+3hRyDrKEA7JUFlySUtAmvg0r4llzgycskqMHjpqQq6YXv+KjAOmx3fY1hxBdT3Nzgz39WgM7Mt++ofAzdg6QdKCTFL2vKf7Y58fhjsBlP2Jr6jSvhx/fLatHSe0l4TF2XhPXvIXxN0t1g/b8u0rqSI11L1K5OW7MHle/2LPgXr9G6gYmrC9x22OgbtquwtVos+cxND7QCpdvYtm23z758TgbJOLjpc02eiOGXWNGDX3qRj+cg6Mfjb9dJwdW08hGEJ4n//C8RODEx +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"; + + + + + + + + + + +Sign a company form. Company forms must be signed by the company signatory. + +scope: `company_forms:sign` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/put-v-1-company-industry.ParamsDetails.json b/docs/api/put-v-1-company-industry.ParamsDetails.json new file mode 100644 index 000000000..dd4392082 --- /dev/null +++ b/docs/api/put-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/put-v-1-company-industry.RequestSchema.json b/docs/api/put-v-1-company-industry.RequestSchema.json new file mode 100644 index 000000000..d4379aa30 --- /dev/null +++ b/docs/api/put-v-1-company-industry.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":["string","null"],"example":"Computer Training","description":"Industry title"},"naics_code":{"type":"string","pattern":"^\\d{6}$","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","pattern":"^\\d{4}$","example":8243}}},"required":["naics_code"],"title":"Company-Industry-Selection-Required-Body"}}}}} \ No newline at end of file diff --git a/docs/api/put-v-1-company-industry.StatusCodes.json b/docs/api/put-v-1-company-industry.StatusCodes.json new file mode 100644 index 000000000..1ebd853c6 --- /dev/null +++ b/docs/api/put-v-1-company-industry.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"201":{"description":"Created","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"}}}},"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/put-v-1-company-industry.api.mdx b/docs/api/put-v-1-company-industry.api.mdx new file mode 100644 index 000000000..08d92f8ae --- /dev/null +++ b/docs/api/put-v-1-company-industry.api.mdx @@ -0,0 +1,77 @@ +--- +id: put-v-1-company-industry +title: "Update a company industry selection" +description: "Update the industry classification for a company by passing in a [NAICS code](https://www.naics.com)." +sidebar_label: "Update a company industry selection" +hide_title: true +hide_table_of_contents: true +api: eJztXFtzFDmW/iuanI0AIip9KRtj/LSMgR0/0BANbO+EYdKq1KkqNZlStqS0qXb4v2+cIylvdbHL2LE7Ezx00K7U5dPRuR9J14mFvDbSLZKT8+vkVJcVV4tXeQ7WvqrdPDk5/3rzdZQIsLmRlZNaJSfJ50pwB8zNgUklauvMguUFt1ZOZc6xEZtqwzjL/XhssmAVflYzJhXj7PyXV2enH1muBXx9Oneusie7u1dXVzuKy9zu5Lp8tvNFfVHvaUZeFAtWGX0pBTCu2jmddAX+Itj5x7NTGs6241mZ4y842u6zHXY2ZQtdM6GZ0q4Zruk3+qKugF3JomC19WtrQTKnWQVmqk3pATgwihes0PpbXXmotWGfz1gBl2D4DCw7fyeFAPuNvfpw1oISOrc7pf9CyAxMwYDKYVcqZ7Soc1zyM5xRgANTStVS+YsakJmg0/w21xWcsAtPcgn25MpIBxfJKPmezmrrdIqwZ4Y6pm5RQXJynkA5ASFAJF9HieMzi7+dRfp+hAIIDn7VFfi+ZyI5SarapZf7adjgNAJMRknFDS8RuSWWUryE5CQJDTMpklEikYkq7ubJkLM+zYF9/nz2mukpbUHolowSA3/U0oBITpypYZTYfA4lT06uE7+UxDoj1Sy5uRk1k/5P+l+08FcfztL/BmNxjjD7HLgAk6wfZ5SAqkskx3hv/DzdO0r3nyckCVNeFy456f5+M1zH67h1lpaB4pJOuAWB3MAuPRbGrdW55A4Eu5JujvxpqEHOi4I4VmncfRvZVYx8G15VRWCBJ5adl1LJsi67Yw84jhiA+C1ueFrxhdFFQd93eSXT0FOq2V/DgGnn52cIo7YgdhJUCJGnjL3is7gnBmyllQWL5Bzv7eM/fbqcGsDlJqMk18qBctiks5rd3y22u+5uCwp5ctJwZTKKO6Unv0PukOUMMqeTfuLIanUtxap9HSAKKgq5jtiMi/eqWPgl3YwS0kgZylk71nk7mKqLAtkCvvOyQpxH+/uH473hLL9o4+bsVQlG5lyxRsJO++L8cWEdlOwpaZ6G4qgLgtwv2KS2yFYWrOcZzqz8zoScScdUXU7AMM9oWhHrVUaWHHXlogKUqittvtGHOFBUbHYH2djKnBZrO5TjxvDFEuFesUJah0N+dFwJbkRcluTFcGFPP56dPguKll3NZT5n3ACbIjN3saO4cMdy7mCmjfyzZ2QkxM9Rx7EJFFrNkEDdRUvTro7nTl5K5A0SqGZ9SFwyBNxiR6lGLOr/9Zrek/yi5YmLHVQoDkq7UoNEpjgeHx7c3IwiL9+Fj4gxaweGfTJcqlWse9azg8vMe4NiGgYkfG/i4EMhSQ7HB0Ic7R+lR2KSp4cvxofpy4Njnh7uHUyPxvsv+MuDg6QvDInn9KTHM+cJLpWMSRDb5WUgl9XkYWTWcVevENp74Rkf7I/3jod49p/v7fXxKOuMt7KJJ9HQ7iVfb27wy+He4bIG+0U79lbXaisdtmYI9kUx9kWh0UPzBhYtgQGra5MDExo8i8J3ad0Oe8e/AbO1gSDX3iKws9e7ZDGlZZe8kGJnhYJsjed5AsZoY5EkfbUZfl8W+yF7rx81+wbYIUjvYs0c1OpWvfyxglxOUcav5hDWTN2ZzvPa2B32aVHJnHxDN5eWfYMFkwKU872wPXfOyEntYLdxSpiBggyu0+2QpPka1FtAwxGiYvUjMdzMOFTcJBuQz4yuK6lmlnxWNAQTaDT8pJaFYDla1TK0n3MliuA0k93veHCEuQRr+Qxuh/whAhHguCws4xNduw5RUzYDBaYlZxg6orS1mfLcI+WKgRIIHCnnZaWvaJR22ZSEpMNY5739TwLHd/nlpNOxs7hkjYBccS8f1AHdko6KRSFLScjSNzhp+t5zbZDs8XhZLD+rymhUS3xSAHujnHQL9Kw/ETn4gs15VYFCfvSmdaLFAneetibgY6gTuFRhyy2zNdo6yy6kIvHMGqbMLnlRw8WIaUPDxRGmtEGihkDrpmfjgV/ssI/gReL8jZ/mNFjMbgB0J8+PYKZ50/0Zm9UYGGEAV2oDkWN2vqj7a7zVpPW67ydxI3F/au1/f62NPmgzkbTsQpFSy/w+XowInN8r74wGlmec+ZbsIjRlYZMW3ikFEqogGP9vjAOicFxwx1ex4jASC8JtoIBLrhyGzRzHDAyyCJIc1L9UjGQa4wtSG0EjTQrYYW+1YcEijXpDED4i1YX/N0NUF7S38Rd0Qi88+Setp4WOlVbwfkqmbPNayrpwsirAz4VyNBC8+POysMUvW4h0f25Ms8WZsRsXQvo02ofOTD5iXzG3J8jtXPMLLyGmaQJFKThr2SbXxmcEhGVOEzd0CHz7DJ+V/KOGVj0Y0pvtfDSi195To8sNcVXTrq4ypzc37Om5VQ0waNkUxHW9kHeB+9PfpJun7xWk3vglN+tbvQu845vi1mBK6+ee/+vvOY601mD36fAbKh+tioWP/pjcaDZ22JmjNKG2VqKL5TSb80tgjR7CvHRhce+CGYmGolErSS5NXhfcPPVwe37zs6S7whUNkhVRwISrbxnPc10rlwkowEFWq2mtBIis4osSlLMbIgRM6fTDgyVnrRcmvK2VkGr2DtxcCzbnlsXZWDMb7UEP2CUYOV1kUhHr5oi00lY+KLJ/oBuAs7IwK1pODF0mwGh+CWKHfSiAW2D5HHKfonPosQY4jJfY0e6sXwIvMAG0yOKIj7oAJG+YkE0AVLuOFQBLScWfzOjaodhsiAp9i8ynA1dDHDj5PaC/+v4xFSoti2Y34AqckOVaTeXMNtAaX3Mrqi337oJ55RhuqWOYxW+d2bK2rutYrAYWVzvl1kVpyQpZSrcB4YrGW5PwLSIOYzAag9m5rguBmHmgbIM5q8BILVq8oEQmgrZcg7JpshLbalq+UYLKKB3JoQjKzbliB6zUys0t+oTT2tUGPL6m6hQye5mNFa2sTR1mrWO2FnEn0bg1PX/Bvr6MuMyOd0MYpnl8gJE14Y+aF2hFjnx63t4O10YA9g5w2xTt1mg/ytwXEpbBHgawHquTJWR6Os0qXch8kWFR8G57Xd6LiOWq/R2CqBVJFIhGXniem5oXmdksM71mW2juV74fw34NxSYFqnL0rBo8jABimWQ18ArIuGYhkbLJOg66boP21Au3ACrbIGQ/ho9xAwaGEzA9ncaszjrMUFaFXgDYu2x703j7vX8Tu1JR684cMOEFVzlkdXWLvlxvrTehOuWK0qNc/E7b7mezm7d9rgspUKvjfx5wdCvIEX1IryiWXqMbQS4FCwjQAoXNXw8N08WPBqupv5AnvQrYiFXBZaOyNpr5tVAb89iw2aOw4plvw+IQDMMu28lhED6tJpobdMNju4ekX5RhdPhZM1UDyUNYWswDIvhEuUdpKdlDYalUvSwwJpcHFs27FRkozB+hE+YMz502maaC6lpsw5bbi2kzgI/3Wv/GYxEksMTlqPua2vcA/2P6sYM1rjBz1nFDfjufOjAU69/FC1jutT39PjR+9ZMV4z1pxbhNTVCekgVBuQTlwipiavGu+Hvtfwh5b6RbMcfWbUiDJYdsZrS1mO6IkyugYGCTrxNabO/uAMUIjUcR44IBJPJacEfmujZ3cQzvZ+r+jqN3JEfBjDt5OSRQkPEc7WDxgPrmgx+/A8BP0YjH1Og/QWUBx4NqOsz6hOmXQvJQdMPcwpmzPp3eYvRuh8AKGS8cmDVoszDK5rj9h4BLPMiDyq0BHEstA6iUapSWHMAAtlalFnIqSW1HyDGb+ZBgY8WoWtpsD8BTskdyrygtmMugxa0/3xUbRR0+9A1IC9gMDyHxTdF+v/2PKKD+SK1UK0bpyYCz5N/xWOAQp62NP0X1iFDffM8B0IsIGHAn9vf2iKrhFO4GWj4isOhwxRiADhI+tc92kn7tq63rnA+S7k34kAxy5XH+FP9M98cHdMShq9Amhc6/gWmMPyXdpJrqrZh/MNpKZ5g4IjjCvTygVEwbAQbtk6lVFI/h8v3cyzg3r6fZHAuurh5nUVy0rqm933IGMDevaQoCS6mZ498fc1noF5IDHuZjjn9nNN/91rgM+w6s6HPC/pDIgy+zx4ZRY8Us9A/wZQ/06kXa2mIuYssU+10WJfFQSxi8awRvXUILyUO29YRWpdXS1jQ5u02u+VL3+6TqmkFYHIQ1k7cxRLIOcGuVfxRtr1w2oF+cLWhjSqHzfJ65uQE714XIIBifpFO/GyKgZUGDdXtaRbrEg8n8ksuCh2IeevzFJTDKzb86/Tv7FMGxaBk79SOtLSUj0Ej+Jg2wMzVi7/QlsE8aT54a9ppTObJrMMM5/3u5TU34ctncsujVjigvxp2DsqIg1ung0jHenueo6X4QV0zXLtXTlL6HAWOYKWeKO20wtcdlcbe0HpfFfVJ6XBbdQHcIIMbdMTs25zZrvj58NsVXc5uCB25uM5u/UxUANWxgoMQdp9J5TB60XSYwxcHwnAASnSm4wkGjoye/g8iEtJPaWKBiUlu3XrOwbustpK+TW4h1q5XezwbZWzfEHU6Wvu6AHpwlHT3y8sSemPLxeJxysXecHgJ/kfK9I56+2H9xdHycH0z2X7zcsOg4WknV7vv4/r7A5/s39tNrjRP2WmItnL32xecRO8Wi9E4ypEpEEQ7y3xuF7x9Vn/eo0bWv+iifBG/bl/if7EQd9n913niUTKWSdp6FLCdaVzxI4F2vR8hJBwL5GN9plGzH2skHOcFCey8mo6Fv88KsMwAu299+F98h80iVFzVe0GR+INQtBqxd4pncH1H6sTlokOHI/pTO9qYXuyFpQ5b4yuCdohB9D+f4U1b3YHOvkgFvEzVZvD9l5YuuT2FntsP2xweHz5+tELG5VnDv8xAfsHc8DRGFfH+vVyjFEweFzDdlGlYKj6j9CXBYV3rsiA6W79wcbOd4b5us8iWcQQB/l0T2SlibzxF86t6dac9k0O77fcGz2d5TjjJe6KvO8QY6y7XpcEMb2987m4BTxtN8Q4bo5ggeZoJmkcGSeR/W3m7zQ8O7m0OaJTjaUUvR5cMNlg6/U597RSB4JhgEo0/sSejzpL1JoOhmdymdi61stCoTbmX+yNE5p2N+UX9Hb5OcjO1CWAUgbMcOhTBwhf8R6XYVDoevWR193prgv+Gx8KhnZlQWNcFlNe1Bjb3GUC2he8QcPXkS65Pkg5yzR4A5fEYn03PHbF1V2jgmyDkqFsMKf1BHcQ2+AvrgeejB4YcOZD+hGFSzNh0Xk8a67H4HXt5iX6YGx16WtJUg+zDNJtLQff8tZ3lNdfUpo+5NaBwsKB2b8A4g6Zy7lWmbs6D3ceKD8/5izOHwaP9FKjh/mR6CeJEeP4e9dP8YxHOxB3B88HyDSqNq2D2C0qLg7K10f84wFSfoxC9HZY7hGkOBJR6eD6phFtBHpBCxKTUHIqwIdB6YUmPxYjI9GufphE+m6SHfH6fH45fj9OBwD8biZc4n4+MNlLqfFjqzXPI5+xuYQqqGTEiXYkEkugq3V+5GoehTg7Len27yHpvP7aw/q7XxCGvwRruc3j10uRJJE1yqjedDe83uHa1h70HEyLAEO2K/AXzDVJNyc7p69w/gq1DHpEmjex84VIoTbdL2umNQ+1dHe7cV0zWH3W9uRtH9/JsW5BAOnyi5+xMXG9+zeNRHA9a8cNHOUWHazmDPf375Iq6Pbv4j+fnaxc/XLm7nlMM+p/gnMG761+A6rDd4MgIfFYp8kza58fTX0DklmYtXz20F/Btwu0jpriapCN+1fcGo3w7dllRfgjGS3o4IRzARrwNlKahBReRV0NoHlOiKUT14SAkNar+ffySnaexflmkbDeE3DVcsY3W//nLa/mFZ+GBPyBPSy01+s+bJSbJ7ub/b8NfudftK083u8hFvfFoDzzIEJV2bAl2ZcB+aV9Jfh04FlHQnekmGXkOpB/vgx0t9QhQ/4/rWDLxyzA+Gkp/rxqzwMy4/PnP2EZWul/cVj501TI2Tx8eh8O8JcEPx3MrHg1K6XcV47eYYUsfS4SjxGu5HZvAjrJngZpSgMfm1NUOdF17WP8DSV/lRhXdfTUFh9bkYf5QgjkXPaeEzU8hjsV7UfQhrlOC7V/b99COYS5lDZx/bu/J0vXiXGu4KXBhau5T+xrqPDV2XrsRBkeuSymGE44llb4LQsXgCC1/AEjqv0U0hIv0lPFrAfXorPAz2Os7KfsWL5SGH4UtFyIjh63+2fIe0rrR1JVedcT7HIlZ86K55mq4rNL1lXLduwc939P613tELkuvgu9utCi5JxElZXQd9ep5cUvo89k1Gycng5bslpfoVj4tbh52vr9GufzbFzQ3+/EcN6O+ef0WFbuiEGyleIckzFcnJlBcWNjDY02gvn7H1L+utXFZ0hqhFNCdJuCnbfc3Pn3f3r+ltB+7f+o28NWT15Fv9LmFD5dbGn3pipZ96zsZyNNH2QFtTuY1tu87Ah8+fklEyCQFM6R/SMvwKnyvgV37LY5IXIxz87TopuJrVPtryQ6J25H371tiz8D+dNxP6THV97Vt80t9A3dw0PObwb4rMbv4X0y5zPA== +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"; + + + + + + + + + + +Update the industry classification for a company by passing in a [NAICS code](https://www.naics.com). + +Optionally provide an industry title and [SIC codes](https://siccode.com/). If you do not provide SIC codes, +we will use the NAICS code to perform an internal lookup. + +Our UI leverages [Middesk API](https://docs.middesk.com/reference/introduction) to determine industry +classification codes. + +scope: `companies:write` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/put-v-1-company-payment-configs.ParamsDetails.json b/docs/api/put-v-1-company-payment-configs.ParamsDetails.json new file mode 100644 index 000000000..e5b4000df --- /dev/null +++ b/docs/api/put-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/put-v-1-company-payment-configs.RequestSchema.json b/docs/api/put-v-1-company-payment-configs.RequestSchema.json new file mode 100644 index 000000000..7397b2527 --- /dev/null +++ b/docs/api/put-v-1-company-payment-configs.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"required":true,"content":{"application/json":{"schema":{"type":"object","description":"Request body for updating company payment configs. At least one of payment_speed, fast_payment_limit, or partner_owned_disbursement is required.","properties":{"payment_configs":{"type":"object","properties":{"payment_speed":{"type":"string","enum":["1-day","2-day","4-day"],"description":"Desired payment speed. 1-day is only applicable to partners that opt in."},"fast_payment_limit":{"type":["number","null"],"description":"Payment limit for 1-day or 2-day payroll (in dollars)."},"partner_owned_disbursement":{"type":"boolean","description":"Whether to use the partner-owned disbursement payment rail."}}}},"x-examples":{"update_payment_speed_and_limit":{"payment_configs":{"payment_speed":"2-day","fast_payment_limit":1000}},"update_payment_speed_only":{"payment_configs":{"payment_speed":"4-day"}}},"title":"Payment-Configs-Update-Request"}}}}} \ No newline at end of file diff --git a/docs/api/put-v-1-company-payment-configs.StatusCodes.json b/docs/api/put-v-1-company-payment-configs.StatusCodes.json new file mode 100644 index 000000000..18fb12679 --- /dev/null +++ b/docs/api/put-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"}}}},"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/put-v-1-company-payment-configs.api.mdx b/docs/api/put-v-1-company-payment-configs.api.mdx new file mode 100644 index 000000000..d34cb6e31 --- /dev/null +++ b/docs/api/put-v-1-company-payment-configs.api.mdx @@ -0,0 +1,77 @@ +--- +id: put-v-1-company-payment-configs +title: "Update a company's payment configs" +description: "Update payment speed, fast payment limit, and/or partner-owned disbursement for a company." +sidebar_label: "Update a company's payment configs" +hide_title: true +hide_table_of_contents: true +api: eJztXFlvG7mW/iuc6ockgEqW5S3x06TjZK6BSWIkzmQa7qBMFY8kdqrIapIlW234vw8Ol9pUUiTHxp170f2StorLx8Oz85B3kYa0VNwso9Oru+iNzAsqlq/TFLR+XZp5dHr17f7bIGKgU8ULw6WITqMvBaMGSEGXOQhDdAHABmRKtal+y3jOzYBQwfakIgVVRoCK5Y0ARhjXk1JpsA2nUhFKUjfx8Hfxu3htSAY4lhRA5JRc+zETO8/1gFzjTEn41c50PSBSYUs7T2LnSZrzXBOuiYI/S66ADX8X+zGjy/YKsIUU2ZLQosh4SicZECMDdk3MnBoiC0O4GBLXn2sipCE0y+QNMHIzB0Fel0Ze8Ewa/AoCh2F2Xb/88gv5BBk1wMis5Az07yImVxd0qWSWkQslkepczMhnhKO/PWcyPR3jRPFCx4f4Py9wIJ3KAk7JtSdaRYlUiimf6dMbxQ1cR4PoNp6V2siYCwMzRXH3YrMsIDq9iiCfAGPAom+DyNCZxt8uPDneuIHwkyzAdTxn0WlUlCZe7Md+4thPHPuJo0FUUEVzMKC05SdBc4hOo/+N/8vieH1xHv8PKI1cNIg4stIcKAMVDSKdziGn0eld5BBG2iguZtEgAlHmiG48Gh/Fo+N4/yiyHDmlZWai0+bv911OPUMsOReA2wcE2TaeUA2MvL44JwuHhVCtZcrtxtxwMydLWSrbIKVZNiTnUyKQF7kmhZILzpDbbRvPKTjZM02uci54XubNsb89nxtT6NO9PSZTPbT7MUxlvhfoj0TE/bff92jBY9+Ti9kvfsC48fMLhFFqYMPoflBROLBCWXIWSFtQM4+6BLmcA/ny5fwMBQsp4jtGgygIR3RqVAnrN+Qe9UHgLKVv6Cz0UKALKTRo7DQejfCf9uyfS6tZpmUWDaJUCgPCYKsGHff+0Nj0rjk/NxkC8OwZv6nYzSOTkz8gNch+CvnVcAehRZQexmpj87qPeBIqoOyjyJZucfeWta1u2W60C9d67WirKqwe86oeVJRZFq3o34umkrUa1Kkjqcg46DWrU567gYiCQoEGYSyJce8ZpDyn2Yth/1IbCneTSNppo0E09v9aHbUerx1vSD69fX0Wf/zw378NUQFe20GuT8kHuDUW/es3/yDPrSae1rajpX9fuJ5j3/PyRoaO7sOh//DZUMGoYv7Lpm1dNRmNhU+kzICKlV3+OgczB9WUJBRPpw9LBQwNSKnBNthgBIMdUpRnfSCBKkRnmYam82SSyfS7VbIVRKqU3YI2wF99Q1IoWIAwyAxNsFMlc4Kj4wdrwJH4Ho5egTKIuIG8Oe0a0fMAE9fqR8KCSglbIGP6ng0m80owYXSJiMKf01IwYEmF9VsP3cxcgZ7LrMnEoswndvweDKE5EQDM756wiFZ3Bf9DRQi3NC8yCEThKc06FnlVF0WH4wPGjveP42M2SePDk/Fh/OrgJY0PRwfT4/H+CX11cBB1dU50dHQ8HR2xUXz4EkbxYXp4Ek9SOIrZ5BUF+mp8MDrEXn26JToajUbDUbQi3JXsbhKEKc00bGLDq28NteFWnaApbXHqP5sGqEyfav1dlu9ybYMT94/QcK9p3uXqVs+j+2+O59Y6bI4pD0eHq7b3gzTknSwFQxcSuR0NPmh0ehRoWaoUCJPgPFq45doMyXv6HYgulVdg3vlxDgTXZEEzzpxe3dqYrwFFfheE/Cyu87O9NrQeF6F2c64iUEoqqzna2sv/vqpc12q/lVGT74AdUmpgJtVyzRy21Q/V4+cCUj7loDHA8Gu23YlM01LpIbl0eidbEjPnmnyHJeEM1b3the2pMYpPSgN7lYtOlA9GjKyHRK+yRr0DNNPQ4W4kgpsZhgqbpD3ymZJlwcVMY4hIUirIBKxbi2gmJc8YSdHDzH37ORUsQyPFhXO9GzGNxZyD1nS2hbG5CEAYGMozTehElqZB1JjMQICqyemHDih1qaY0dUipICAYAkfK9ZkEIU0yRQ5vMtZVa/8jz/FNfjltdGwsLlojIDfUyYftMIycngh+8wdpYitk8VucNP7ouNbrivF4VSy/iMJFozYIfisMN0unNpAcdEnmtChAuIAXKTeRbIk7b7fG40M3yFAu/JZrost0Tqgm11xY8UwqpkwWNCvBBfGmXiGZ2g1iJXhaVz2rsPR6SD6DE4mrt26aN46GHPSOwZeFGadV9xcuTLdeaC4VBI75KY3XT1qn+/4mbiDu31r7319rY16lmohrci2sUkvcPl4PLDi3V+SGZ1lgeUKJa0mufVPiN2np0jdghcoLxv8b44AoDGXU0D5W7OYivHAryGBBhcHMFcUxPYMsvSR79c8FsTKNwb1VG3UKc0jeSUW8RRq0hrD4LKmu3b/WGb22ext+Qa/72pF/Unta6FhJAR+n1pRtXkteZoYXGbi5UI46ghd+XhW28GUHkW7PjdnUMDN2o4xx/ESzi8ZMLrLtmXu5Zfz6geYQEmqeojZZUbNNKpXLjjFNjLTc0CDwj2f4IvifJdTqQVm9Wc9nR3TaG0P6Dbmkql1ZJEZubtjSc30NtKEGNjVpeCHvPffHX7mZxx8FxM74RffrW733vOOa4tZg6PT3nv/r7zmOtNZgd5JsqHxsOtBGf4RvNBtDcm5PXgqpNfdHOHO6AFLpoQwWkGncO29GgqGo1EqUcpWWGVXPHdyW3/wiaq6wp0HUEwVMqPie0DSVpTAJgwwMJKXoBvvrIwQ8s2iHByvOWitMeFcKxsXsPZi5ZGRONQmz1ck9uwctYAtQfLpMuLCsmyLSQmr+qMh+QzcAZyV+VrScGLpMgNj5OaaIL/AEEEg6h/S7c1LQY/VwCM2xox6uXwLNMFu3TMKIT7oAJK+fkEwARL2OHoA5t2d8iZIlZmM3RYWuRVIlLHsgdpz8FtBPrj9x/Vvnnw5X59ywglb5mjtRbbV3E0zrULd2ZvNSm6Zj0Q8srLb/0GQNwp7GO5Pw3cqRNtFzWWYMMVNP2QpzUoDiktV4QbCEeW25BmXVpBdbPy3fCmZPMhuSYyMoM6eCHJBcCjPX6BNOS1MqcPhC8pULVmqjlomGDFLk7kRQnuoklQyS2jFbi7huvTs9P2Bfgn172HE7hH6apwcYWBP+LGmGVuSYMD7jldrZAFcHAHoLuJqnru3uaD/z1GLVq2APPViH1fAcEjmdJoXMeLpM8NR4u73OH0TEvG9/uyBKYSUKWCUvNE1VSbNEbZaZVrMdNPdr149gv4pikwxVOXpWFR5iAXLQa4AXYI1r4hMpm6xjp+suaN844WZAU8MXtt7GjuFiXI+B4ARETqchq7MOM+RFJpcAepttrxrvvvdvQ1dCFWzPAROaUZFCUhY/0JfrrfUmVG+ocIU67A+77W42vXnb5zLjjNrymgA4uBXWEX1MrygUHwQ3wroUxCNAC+Q3fz00TBc/Gazq/MV60n3ABqTwLpsC5FUpYC3UyjxWbPYkrHju2pAwhK3F0I0chsUnxURShW54aPeY9AsyjA4/qaaqIDkIK4t5RASXNvfItU322LCUi1YWGJPLHYvm3IrE1a6hE2YUTY1UibSn32uxdVvuLqbVAC7eq/0bX0dnBdZyOeo+h7cW2ID/Kf3Yzhp7zJw2VFm/nU6NP7bexgtY7bU7/S4qv/pZz3jPajGuUxM2T0m8oGCFiF9FSC1ui7/V/qeQt0b6IebQug5p8MghmSmpNaY7wuQCbDCwydfxLXZ3d8DGCJVHEeKCDiTrteCOzGWptnEMH2bq/oGjNyRHwIwavugSyMt4inYwe0R9E6pZawBuiko8pkr+BSLxOB5V02HWx0+/EpL7QzfMLZwb7dLpNUbndjA8IaOZAbUGbVJUNbpPBZxrMgFUbhXgcNTSgWpTjVxbB9CDLUUuGZ9yq7YD5JDNfEyw4cSoWNlsB8BRskVypyg1qIXX4nqpDeRVo6DDu76B1QI6mUqV003Rfrv9zyig9ki1VAti05MeZ05vbb1OB6cuVUFxzU8I9e1t6qrTPAbcif3RyFI1k/J7WWyi5RMCCw5XiAFsndBzbWtMm2df9bnOVSfpXoUPUSdXHuaP8c94f3xgSxyaCi3UUwXzbZNuXEzlTszfGa3XGbYc4R3hVh6QCyIVw3JQSVQpgnh0l+/mXsW5eT3V5mgwZfE0i6Ksdk31w5bTgbl5TVNgeJSaGHr7lMtCv9A64H4+YugtsfM9bI2rsLdgRZcTdkUij77MFhsGjRWy0D/Bly3Q/YvUpcZcxI4p9m0WxbGoxQ/eNII/XEINyUHW5cSuSoqVralydptc85XuD0nVVYOECmdNqsnrGCJaB7i2yj+LtnVc1qFfpyi1KnStalAT8MYnapzfdRHYZUGFdXdaBbpU96sWlGfhPhZ6/NkCyLtQrX5ZVW0Hy9g4P5JSQ7hI9pUrIOdiQN7LBZBLiZWnipxRexzZNJj+qs2D3KYqfFlUF51aZ0c2L0aNgbxw1fjSu3SE1vUcpb0GRgWRpYnlNLbf/YAhzOQzQY1UmNqjPNsureeuF+yc0qM8awa6XQAh7g7ZsTnVSfX18bMp7jS3OvDAza1mI7Y8KNwmDGygIMcdt0fnIXlQd5nAFAfDOgEkOhFwg4MGR4/fdsrBg+isX1iz9Q7S18gthHOrXu9ng+ytG2KLytKz5oWUdi3p4ImXx0ZsSsfjcUzZ6GV8CPQkpqNjGp/snxy/fJkeTPZPXm1YdBgtt6fdD/H93QGf61/ZT6c1TskZx7NwcuYOnwfkDR5Ku9t3fSiwPqJ8UATiL0nZ/kH1OY/a3YNqoXzmvW13xP9sGHTYP6veeBBNueB6nvgsJ1pXLCRwrtcT5KQ9gVyMbyRKtiH15J2cYCadF5PYoX/khWmjAEyyv/suvkfm4SLNSoYa3Q2EukWB1is8k7oSpZ+bww7SHdlV6exuerEbktZniW+UxIthLvruzvEXLx7A5k4lg8BYO2Tx/uKFO3R9DsPZkOyPDw6PXvSI2FwKeHA9xAX2DtUQQcj3R62DUqw4yHi6KdPQKzysdBXgsO7osSE6eHxn5qAb5b11ssod4XQC+G0S2b2wNtcRXDbvztQ1GXb33b5gbbbzlIOMZ/KmUd5ga7k2FTfUsf2Dswk4Zajm6zJEM0fwOBNUi/SWzPmw+sc23zfc3hzaWbyjHbQUCpreYOnwu+3zoAgEa4KBEfuJPPN9ntU3CYQkBd6WNya00sGqTKjm6RNH59SW+QX9HbxN62TsFsLi5U3dsEM+DOzxPwLdbnxx+JrV2c87E/wrloUHPTOzx6LKu6yqLtQYVYZqBd0T5uitJ7E+Sd7JOTsEmMMntjI9NUSXRSGVIcw6R9mye8Lv1VFYgzsBffQ8dKf4oQHZTcg6p1mbysW40iZ5WMHLO+xLRKfsZUVbMWsfpsmEK/syw46znNlz9Smx3avQ2FtQWzbhHECrc7Y7pm1cM93diffO+8mYwuHx/knMKH0VHwI7iV8ewSjefwnsiI0AXh4cbVBp9jTsAUFpllHyjpu/ZpiKs2+3FBSVOYZrBAXW8vC8cxqmAX1EGyJWR82eCD2BziNTasxOJtPjcRpP6GQaH9L9cfxy/GocHxyOYMxepXQyfrmBUg/TQueacjonv4LKuKjIhHTBl26Ep9XWFAo+NQjt/Okq77G5bmd9rdbGElbvjTY5vVl02YukCi7FxvrQVrMHR2vYuxMxEjyCHZCvAN8x1STM3F69+w1oH+qQNKl07yOHSmGiTdpeNgxq++po67ZivKbY/f5+ENzPXyWzDmH3MZnt33rZeLfjU6NoxRVvYeqsrgWpX3TypcND0n1NqnX93z1a1a4Stpu1/jGAdsVH9wpJp3K5b0X9HR7rqZUz0Iis/bJV47mqbR+4in74Rk0Vhv3sGzVcECazjCptQ75HepFl53dXhlHf9W2Xm01a25RQwWp69Gz5uicm+gi6PxqNcNreiULB1RZzOH5o3aXqvJcUu2fbYi9E1XJ1AfQ7UL2M7fXOWjXW7yw1G6GbE8sFKMUZzuJLNgcR3BoQ2gZBqLicylr7BJm9klR2niJDA9zu5x6Yqhq7d13qRl3sVcPuGvo7tddSd/ZrwpeufFLRvn1mXwnBR/GivcX+XlV+tnfXfNnkfq+7W4PI1j14hV6qDN0ef3eaFtxdnY4Z5Pb+9ApLn0EuO3vgxotd8hQ/4/LWDNw75oWyidJ1Yxb4GVcfXgf8jAraSUTPG4GVVOLk4S03K6VAVc9bO36I2N7EIrQ0cwy/wzHjIPpsa0N+ZgY3wpoJ7gcRGp5Ptcl66yR+S1Hb3yDOo836y70chJkdV5gQRNW+j4fvxiEThtOn5st2gwgfstMfp59BLXgKjZ2ub97by8p7tuEew6WjpYnt33iKpH3XFZ0JWSpzawssjmeavPUiSUI9Fz5px2Ra5uERsf/wTyBQlyzz79CdhVndS4c+I+IOnpBV/df/rDkTqVFIbXIqGuN8CUdiXrKe6a5l767irvYx/n6f8l/kfUov0wZuzV6RUW6F36qxO69or6KFTcIHVRsNotPOW4ddgf2GNefaYN+7O/SYv6js/h5//rMEdJqvvqGiV7ZMzmpkxq17y6p3ntYy1vNPfodekPUPKfauKtxwtS2CmYn8ddv2y1iubN69i7kbvH/r1y7XENYRsP+F0YrOtfV/44gVX7Z8kNWgpO6BZqgwG9s23YSLL5fRIJr4OCiX1kdS9AZfPaA3btNDrhgDJfztLsqomJUuaHNDolqkbdNXmTr/P42nF9psdXfnWlzK7yDu7ysuM/i3DfDu/w/asK+W +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"; + + + + + + + + + + +Update payment speed, fast payment limit, and/or partner-owned disbursement for a company. + +At least one of `payment_speed`, `fast_payment_limit`, or `partner_owned_disbursement` is required. +1-day payment speed is only applicable to partners that opt in. 1-day is not allowed when AutoPilot is enabled. + +### Related guides +- [Payroll Processing Speeds](doc:2-day-vs-4-day) + +scope: `company_payment_configs:write` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/put-v-1-compensations-compensation-id.ParamsDetails.json b/docs/api/put-v-1-compensations-compensation-id.ParamsDetails.json new file mode 100644 index 000000000..0b8396479 --- /dev/null +++ b/docs/api/put-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/put-v-1-compensations-compensation-id.RequestSchema.json b/docs/api/put-v-1-compensations-compensation-id.RequestSchema.json new file mode 100644 index 000000000..9f0fcd6fd --- /dev/null +++ b/docs/api/put-v-1-compensations-compensation-id.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"required":true,"content":{"application/json":{"schema":{"description":"Request body for updating a compensation.","type":"object","allOf":[{"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"},{"type":"object","properties":{"rate":{"type":"string","description":"The dollar amount paid per payment unit.","example":"70000.00"},"payment_unit":{"type":"string","description":"The unit accompanying the compensation rate. If the employee is an owner, rate should be 'Paycheck'.","enum":["Hour","Week","Month","Year","Paycheck"],"example":"Year"},"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","description":"The effective date for this compensation.","example":"2023-01-01"},"title":{"type":"string","description":"The job title for this compensation.","example":"Software Engineer"},"adjust_for_minimum_wage":{"type":"boolean","description":"Whether the compensation should be adjusted to minimum wage during payroll calculation."},"minimum_wages":{"type":"array","items":{"type":"object","properties":{"uuid":{"type":"string","description":"The UUID of the minimum wage."}}}}},"title":"Compensations-Body"}],"x-examples":{"update_compensation":{"version":"b48c46abfed1487b873b442334b3c4ff","rate":"75000.00","payment_unit":"Year","flsa_status":"Exempt","effective_date":"2023-01-01","title":"Senior Engineer"}},"title":"Compensations-Update-Request-Body"}}}}} \ No newline at end of file diff --git a/docs/api/put-v-1-compensations-compensation-id.StatusCodes.json b/docs/api/put-v-1-compensations-compensation-id.StatusCodes.json new file mode 100644 index 000000000..40b31c3c0 --- /dev/null +++ b/docs/api/put-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"}}}},"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/put-v-1-compensations-compensation-id.api.mdx b/docs/api/put-v-1-compensations-compensation-id.api.mdx new file mode 100644 index 000000000..99869d582 --- /dev/null +++ b/docs/api/put-v-1-compensations-compensation-id.api.mdx @@ -0,0 +1,74 @@ +--- +id: put-v-1-compensations-compensation-id +title: "Update 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: "Update a compensation" +hide_title: true +hide_table_of_contents: true +api: eJztXelvG7mS/1e4PR+cAGpZt2R/2rwc+7LYzASTZLMPmUBmN6slTlqkhmTb0QT+3xfFoy8dthT77b5BBhjYlnj8WEXWxWLlW6QhLRQ3m+jy07fouVytqdg8S1PQ+llhltHlp8+3nzsRA50qvjZciujSNgOhKf6pSSqFoVwQLjKpVvZDIgVZyhuyKtIl4ZqsKWdEFoZkUhFKfpdJl/ynTDRZ0Q1Z0msgKyo2JK2P2yFJYYgU+YZIAcQsqcGhaGr4NXTJ+yWQtFAKhGn0wzZmCbbPDTdL+8dKakMUpNj4CrIM7CBzRg1cdX8Tv4mffvqJfIRkKeUX/ZuIyRWs1rncAMx/l8m8Pn63WGM3dnVJXnEFmtwsQRC6hUEXlohZkecb4vvgTDqVa7gkV421Xt4obuAq6kRf40WhjYy5MLBQ9tvYbNYQXX6KYJUAY8CiTkTX63oTHX3uRIYuNDazhKWCkQabsEUYXOkbuogujSqgEynQayk06OjyWzTo9fBHk93vyqVEnQi5DcJgK7pe5zy1w5//rrHpt0inS1hR/M2hjmTyO6Qmam8hZJ+CtQINwvg9k7WIKMh/INxu1InWSq5BGe5QFgVntSm0UVwsdk7x4cPrFzgwboK9gyug7BeRbxxFbjvRNSjN3XruniJsQt8pzObW3SXvAOzfn/z3XCzIouAMPj9ZGrPWl+fnTKa6aznTTeXqPLA5XtONknluvz/nDFZraUCkm6f2GO04bkaSQuN0XJOMQ8660W0nwh18GsV+lwmOebPk6XKbhAnkUiz0TgqWx+e0iUP3E2dX1MCuSauGGc017ELBZJ5TRehKFsI4ubUGRdZ0s0ImF4IbS1T/wRw/OHEq7EpomjqZi/tia5G4kC553SIKSkFB5I0A1bFNiF7KImckAXL2lm7SJaRfzpAyIIoVioS/y0JFnegjwJeoE72RwiyjTvQPoPhp6BF9vu1EWa7pXBtqCr1rWWHAl19htcZT/Y7mVHFg5GcpIHxY//0XhBl1UGesuLYnBOlCyhHaX1Sdt/QOUu3Vf717RhxAewzsZm8IaFJienLmZjl7WhJPE6rA8ZWSjH8FRjQ23xC4BrVBRiPDuWS1cawekdcogFZAnpxtL/qkGTpWSqNa4tdQjY8NnFJx8jXJoUuQg/mGPDm7Y0pHEiBLWSirCDfkRqovx0xVMQRYbYonZ7tZiDioEuSGLkCThGpgQWsjX3yP1rBtiu7dBLtHrw18zMrsXsSV2F/OnlqyVSu0Joa8EYQakgPVhpgbEMayy5oONUVCxaZLok5kuMnxhLzKNY3f2W0Zv8dDg0KwYWicKCXKQQgOsm/Lv/Jsz7jSTXuo45ozyGiRG40S1Yv2M02WXLlxrUzza7mPsLaaAZvvAYTDUfZ7oc08k2q+4oKvitUcuVibIJEyByq2ZngtGNoVoAnfobrTIOvcBMBwTX4Gu08IKxA48fqTpDRPi9wD26Eu6ujqUo8qRTf341J9ek2o1jLlaPFVJmiTPJ2IG1jpXXbSQ5g6dTiWFy3CHxjGEtCpv+79NvGde3Y3KPwPaftHwRUwVCp2rdZMha90tc4dBbwhXVNKjiYRS0Zs1IdxPOsP03g0nUKcZBTi4YzRAYUxTOkwqhlz0XjCer20P50l6XR4MUwGdNCbAJvQ2YRmaTKK6rZSlPYzloz60zgdjmg8GtJpfDHIhvEYJumgl/bZlGKPlqUT0SnMsoskjXusP4hHMJ7EyXR2Eff6g+FoPJnOLnr9KJgo0bTX6/W6vV7UtiiCcm7o40rttrkSDXqDYdzrx3bwvSfP79/Whv/0uZJj72RmblAsvhQLLgAU7oGlVT4NN6jGBxhnEzpNZnF6wXoxLjPGj2L8DD/CTxp8uJglUzpJx2wEw2xA+0kvvWAzmGYTOk5G6bDJBzaAcTaj/TgZpdN4xC56MR3CJM4ukkE6ZjPo7+RDMssuaC9J4z4MhvEom0zjdHbh8Hk2DCo+DMY7meDtpiYT6tbNo/HhWRAhUUtAzYPUq3GAjthFQi/SeDhI03iUpv2YjpM0nkA2StlkPIQpbXAgTccXCRvOphdsMh5nycWoR/vZJJlMx9mAsosWB2bZLEtgGo8uJiweJZOLeDbJekhZ1k+mQ9qbTSpSPhwl+7O4P4j7BynpfNg2Iau9yQDomGYxpGwSj5J+GidjBvE4zbIBG/YG0+EsCuIxmnYH4zug3H6+rTRlIxASOYE26o22PeifpSGvZCFsBMC5vn8UYHWXAi0LlaLnAZoIaQh85dp0yRv6BYgulHMf10pecwbMiXmuyTXNOev+Jo5xyfeAIr8JQr4X1+sX501oaBy1VFtd2INSUtmoRFPh+c+3tfBehbk16vwLYAe0IBZSbfbMYVvdqc7erSHlGXdxHr9m253INC2U7pL3mzVPKUZ5rBn0BTaEMxDG9cL21BjFk8LA+ZoqugIDiijIqTddyiGtvi1RHwENR8C2qGndSC485ocKTNIe+ULJYs3FwkWJUorONAYOLJqk4DkjKUYjVr79kgqWo0HFBdnIAkMPZeTJYl6B1vcyMN4GIAwM5bkmNMGoYEXUmCxAgKrI6YcOKHWhMpo6pFQQEAyBq9KcaJoOQqLIKASrb6xPDf5HfsfX98tlrWNtcdGeA3JD3fmwHbotCfGzNLE9ZPFLnDT+xe1aLysGg+1j+UGslUSLB30W8lIYbjZObPAQL12vQTjvBimXSLZBzlvWeHwhKOtZbsORS0I1ueLCHs95uSnn1zQv4KpDvAsRRsgsg1gBntZlTzxJlvdXtejWSzfNc0dDDvrI8JaFGadl96cuSGbdi5VEL8XtmO+SeLtJ62TfD+IG4v6Q2n99qY0xxXIirsmVsEJt7vh41amFsMkNRx/aX/JQ4lqSK9+UeCZtnKsL9lD5g/H/RjkgCkMZNfe4mXgeDreCHK6pMOjEUhzTb5CNP8le/HNB7JnG0MRWxAnjMl4jdRpDWHyWVFfu5xxRXVnehk/Qhr1y5E8qSwsNKyngl8yqssNrWRW54esc3Fx4jloHL3y8fdjCN0cc6ebcmotFmHljTXjG8Suav63N5Oz3HXM7gty9a36mqzLC4Clq43jVtkmlcndcDKNfLqhREfjuGT4I/kcBlXhQZZDVDWNHdNI7U3JVDfipGlEUeW7j665dsZ4bebhhQ87taoBeFBxqUrNC3vjdH3/kZhn/IiB2yi+63d/qjd87rimy5rbzg+d/BZ7jSHsVdpMOH1H42Gi+9f4wHntAbXTJa3tHv5ZaczSxjPS3+0EO5XANuUbeeTUSFEUpVqKUK4zWqicObsNufhrVV7ijQbTDC0io+DLHe7ZCmDmDHAzMC5EVggGb+zCFPuAh4KVD0z3YMtYabsKrQjAuFm/ALCUjS6pJmI2Us1keNIBdg+LZZs6F3bopIl1LzR8U2T/QDMBZiZ8VNSe6LgkQOz8H1iVv8e4DiL0TdEYKWqwejg8N6+7+JdAcA+abeRjxUReA5PUTkgRAVOvYAdBeGYnFXMnC4LE54BW6FnNRrBJ7fbkDYsvIbwD91fUnrj+eiaB2Pa4QHkulyPhCl9BKW/Moqm33roN5Fq6zMCemMmZXhTZ1w2I3sLDajGoTTss85yt37b0H4Y7GR5PwFSIO9+52jNo1N/WULTHP3ZVqhRcEK28s9qAsm+zEtpuWLwVzlxrVybEelFlSQYZkhVfrGm3CrDCFAofPXxjOuWCFNmoz15BjhFGKuaA81fNUMphXhtlexFXr4+n5M/Yl2HfHdrwfQj/N4wMMWxP+KGiOWmRCGF/wUuwcgKsDAH0PuJqnru3xaN/x1GLV22BHHqzDitfRc5ll87XMebqZC7q6J69XJxFxtYu/bRCFsCcKWHleaJqqguZzdfjMNJodIbmfuX4uXSVQLMlRlKNlVeIhFiAHvQf4GqxynftAyiHt2Op6DNrn7nAzsNmGCNmN4Xxcj4HYRAOZZSGqsw9zmWFwH7aXjY/n/ctGOsi9d0BCcypSmLskxZO09SFUz6mw4VF3hUP8bPow25cy5wylOv7vAAezwhqiD2kV+aTX0oywJgXxCFy6jkWwHxqGix8NVnn/Yi3pXcA6ZO1NNgX2vl3AXqileiy32aNsxdeuTZWzhm6XrsUwLD4pEkkVmuGh3UPSL5xhNPhJOVUJyUHYWswDInhvY48uW8+5pVw0osAYXG5pNGdWzEFg/AiNMKNoaqSaS5uAshdbu+Xxx7QcwPl7lX3jsLjUMrvLUfY5vNWBDfgf045trXGHmtOGKmu308yAsr7+fayA7V7H0+9taVef7RjvrDrGVWjCximJPyjXYBNuPtucGBdavC/+RvvvQt4Y6U7MoXXl0uCVw3yhpNYY7giTC7DOwCFbx7c43twB6yOUFkXwC1qQrNWCHLFpkfcg6Wmq7u826bI6OQIW1L5WaKLxZzxFPZg/oLx5W+a7BQBuivJ4ZEr+CWLucTyopLOPPNz0Wy65v3TD2MJro104vcLo30bgDRnNDag9aOd+lMN++3cB55okYBMHA+Bw1dKCakON+M6ErwJvC7GSjGfciu0AOUQzHxJsuDFabzHbAXCUbJDcCUoN6tpLcb3RBlZloyDD27aBlQJ67p4Z3MNOcO2/RwA1R6pOtSA2POlxruhXm+3TwqkLtaa45keE+vJrCoBWhMeAnOj3epaquZRfivUhWj4isGBwBR/A5gk90U+7UfPuq7rX+dQKupfuQ9SKlYf5Y/wT8+dsikNdoCW5TL+AKpW/Dbrh+5SjNn9rtJ3GsN0R3hBuxAG5IFIxUKifVCHC8Wgv3829jfPwekrmaDDF+nEWRVk92f6k5bRgHl5TBgyvUueGfn3MZaFdaA1wPx8x9Cux8522xm3Y99iKLiaclomrD7rMxjYMEitEob9jXzZA716kLjTGIo4Msd9nUfYBox+8rgTvXEIFyUHWReIfamyxpozZHTLNt7qfEqorByFhEFJOXvkQ0T7AlVb+XrSN67IW/cJsXhrbEDpNl3OzVKCXMmdz8Monqt3ftRHYZUGJ9XhaBbrgFrBhm2vKc+ov89Diz6+B2Nj8s+d/J+8DOBI0Y+3+SErt3uHKjHzElyavRYe8kddA3kvMPFXkBbXXkXWFWXt7ebTZVLovYZDW3ZGNi1FjMOXYBvCkN+kIrfI5Ctyc9oFdYWKZxfZ7P2BwM/lCUCMVhvYoz+8X1qM8PyWkR3led3TbAILfHaJjS6rn5bcPH01xt7nlhQcyt5yN8PAO2j6O8ttAwQo5bq/OQ/Cg6pJAhoNhngASnQi4wUGDoYev5+aM66RQGuxlUnVvvWdh9dZHnL5abKHMXN9l/Rw4e/uGuEdm6Ysa6FYuaeeRl8d6LKODwSCmrDeLR0CnMe1NaDztTyezWTpM+tOLA4sOo63sbfcptr+74HP9S/3ppMYlecHxLpy8cJfPHfIcL6W7UZsqAYV/WXAyCv+u1Is+Z1Gjab9uojzz1ra74j/rBhn2f5Vv3IkyLrhezn2UE7UrJhI40+sRYtKeQM7HNxJPtiHV5K2YYC6dFTO3Q99lhWmjAMy8fzwX3+Dm4SLNC4YS3Q2EskWB1lt7JnUpSt83hx2kPbLL0jle9WI3JK2PEt8oKRbEe9/tOf7k6xO2uRPJINDXDlG8P/naXbo+ge6iS+z7qKc7jthSCjg5H+It9g7ZEOGQ93uNi1LMOMh5eijSsPPwsMJlgMO+q8fa0fGvMXUtvbcKVrkrnJYDf59A9k5Yh/MI3tffzlQ5GZb7ji+Ym+0s5XDGc3lTS2+wuVyHkhsq3/7kaAJOGbL52huiHiN4mAnKRXpN5mxYfbfO9w3vrw7tLN7QDlIKD5o+oOnwe9vnJA8Ec4KBEfsVOfN9zqqXBELiK/MVNya00kGrJFTz9JG9c2rT/IL8DtamNTKOc2EFANM1PeTdwB32R6BbeJq8Z3X266MJ/hHTwoOcWdhrUeVNVlUlavRKRbWF7hFj9NaS2B8kb8WcHQKM4RObmZ4aoov1WipDmDWO8k37ht+Lo7AGdwP64HHoVvJDDbKbkLVusw6li2HVgvlpCS+vbMUD0Up72ZJWzOqHbJ5wZWufHDnLC/+O3XYvXWOvQW3ahDMAIbzMvbePcJoR74336YDCaNKfxozSi3gEbBrPxtCL+zNgY9YDmA3HB0SavQ07wSnNc0pecfPnAkNxrCzw5YqduAICgvkSJNW20IA2onURy6tmT4Qdjs4DU2rApkk2GaRxQpMsHtH+IJ4NLgbxcNSDAbtIaTKYHaDUaVLotaacLsnfQOVclGRyr+ktiW7865X7USjY1OHFcSlC78jZ2p+rdTCF1Vuj9Z1eT7rciaRdFukOr9E2O9lbswWUmh6jrZPTIVjoCENNwizt0ztbTGEbdQialLL3gV2lsmTJAWkvawq1+XS08Vox3pPsjh1KAK9xp68LE1/340Z9ubjJLGbf53ub0y3VCt/L6H9iWxUtfvb2dfzfZRCN41OAJVBmbYmtEm9b1aEGvcE47k3i/tjVcLKlZ1xxhPD5bfulwQvEsuLCP4xDmRq7cj/P3r4ui6u1K6vYh23YAN/y2VdtAjcCr1KNOq5N7ZnomSafQi2S2thHvqmkax5XJd1+8gPGtY+fIgx8oOecKU/hbU5Y6q6pVUv3r2DXeMnlXtTsY8wtVnD0avpvklmvod33xBe1v9YymVxGH8ZTXSyvXfGm/XSI5vmeR2zNp0EHqvH5Zx73q+3yL1e6r1UeJ9ChViXEH1ErIH6tmz6HKbqvPt6J5fDqfCgL2tyjRt6/Qkm8+tqcFvlRI+9HjbwfNfL+eTXyTiyJ15BKtapMD1znrj7LztpZp1fB+7gEswS1LQJrz6BOqYB3j4p3/8zidLe3+yoq6dhaK7dbJeHcpe1WPbKqvlUymqWjCU0yYP3RbJrMpsNkNBoMh6NkmI6yrFaAbfwYBdjKamoguFS1/bB3pR/skmJvT/mF+8eseg30C1C9iW0NiOgSi3PpZ4I1Czw3m6K5GeNRV5zhdI5mz5sWJHw1ILTtjXaY83T2lqC2L5mLu0tRowHSHMoVnC77u7qLVaP2AsuGuxe6u2tzwdUQOxaOO8pfWFp/yTIfi51H59f984bndP6tZbDfogeEqZTecSpUjs6RtwfpmjtzMGawsjbh1nF4ASvZ4pUbL3b3sfg1rnDPwDvHfKvs3eu+Mdf4NS46FHt/h+a8O0s7Sr6XBxonDw6flVRAlTVUtsvBU7GJ7eNuQguzxIh+yFzqRO9suun3zOBG2DMBlrjWUvxaOTgvg0j+dlz1x0ctyri/wuLp5e2Cg+curFy+ZZjHOvLo4DYq/9Vc8E6EHrf+JXsH6pqnUNttlUdja7Cc24bnDMmP8j+2f2NyjPZdt3QX5Klc2Zwhi+NMk5deZJCQpo6+N5NpsQoV4P/NV3ai7g7QO8wvwqzkV8hLUefyafC4+G//vToduCPWUpsVFbVxPoRMn5YX3QD+rXKEf/wrB4/3rxz402/gqzlf55RbMWEF3jcviT9F1zYDoKXhLtvhk8/4yk0b7PDtG5q+H1R+e4sf/1EAhumwqOY1VTYx3x4dxm1Aje2u5lvfAE+CS/2U3BGJ2bmeYFOJTU0bRb7Kx1YcyD3YczG242D+pSNne2jraLg7WlmSurITnjtiOa+jarEV6ap6oLayQn1/27oR8fbD+6gTJT64tpLW5FL0xiqVG8f3cEttAzA3+COnYlG4cLEbEiUXbWrIUiP6X2rxsubO+vbNtXgvv4C4vS03msG/bWj59n8BGp1nRg== +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"; + + + + + + + + + + +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`. + +### Webhooks +- `employee_job_compensation.updated`: Fires when a compensation is successfully updated + +scope: `compensations:write` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/put-v-1-contractor-document-sign.ParamsDetails.json b/docs/api/put-v-1-contractor-document-sign.ParamsDetails.json new file mode 100644 index 000000000..91739866a --- /dev/null +++ b/docs/api/put-v-1-contractor-document-sign.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-client-ip","in":"header","required":false,"description":"Optional header to supply the IP address. This can be used to supply the IP address for signature endpoints instead of the signed_by_ip_address parameter.","schema":{"type":"string"}},{"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/put-v-1-contractor-document-sign.RequestSchema.json b/docs/api/put-v-1-contractor-document-sign.RequestSchema.json new file mode 100644 index 000000000..fa0fb1d1e --- /dev/null +++ b/docs/api/put-v-1-contractor-document-sign.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"fields":{"type":"array","description":"List of fields and the values they will be set to.","items":{"type":"object","properties":{"key":{"type":"string","description":"Unique identifier of the field"},"value":{"type":"string","description":"Value for the field"}}}},"agree":{"type":"boolean","description":"Whether you agree to sign electronically"},"signed_by_ip_address":{"type":"string","description":"The IP address of the signatory who signed the form. You must provide the IP address with either this parameter OR you can leave out this parameter and set the IP address in the request header using the `x-gusto-client-ip` header instead."}},"required":["fields","agree"]}}}}} \ No newline at end of file diff --git a/docs/api/put-v-1-contractor-document-sign.StatusCodes.json b/docs/api/put-v-1-contractor-document-sign.StatusCodes.json new file mode 100644 index 000000000..33246015d --- /dev/null +++ b/docs/api/put-v-1-contractor-document-sign.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Example response","content":{"application/json":{"schema":{"title":"Document Signed","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},"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","signed_at":"2024-09-03T16:39:22.000-07:00","description":"Form W-9, Request for Taxpayer Identification Number and Certification","requires_signing":false,"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"},"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/put-v-1-contractor-document-sign.api.mdx b/docs/api/put-v-1-contractor-document-sign.api.mdx new file mode 100644 index 000000000..42134bf35 --- /dev/null +++ b/docs/api/put-v-1-contractor-document-sign.api.mdx @@ -0,0 +1,71 @@ +--- +id: put-v-1-contractor-document-sign +title: "Sign a contractor document" +description: "Sign a contractor document." +sidebar_label: "Sign a contractor document" +hide_title: true +hide_table_of_contents: true +api: eJztXOlvGzmW/1e4tR+SACpZlp3E9qdJ59gxMDmQOJNpuIMyVfUksVNFVpMs22rD//viPZJ16bDk2IudQQdopKMiH398fDePm+g6nlXGqlhICzPNrVAytosSopPzCIoJZBlk0fdBZPnM4G+vlbSap1Zp9kalVQHSGvyuSnC9T7PoJCorG1/ux2ndOM5849iImYwGUck1L8CCRqo3keQFRCdRaJVUlciiQSQkEuN2Hg0iDX9UQkMWnVhdwSAy6RwKHp3cRA5vZKwWchbdDqIMTKpFiXCik+hsDuzr19M3TE2ZnQMLg0S3g3rgwIY0FwhSlGHwOfAMdGf4Kc8N9Af5SP/Dc+Y6MKuYqcoyX9CQp58YzzINxgzZ2VwYlnLJJsAqA9napmyqNEN2cVtpYCCzUglpDRPSWOBZmA82gSyZLBJRJqFvzd9htIFVLQ78K/4f4sCrT6fxP0EbnNaOPHiD4xVCgnF85hbiCccpvvp0yi4dUcaNUangFjJ2JeycLVSlqUHK83zITqdMKglMGFZqdSkyyAauDS/LXKQkZE8MOy+EFEVVtGl/fzq3tjQne3uZSs2QlnSYqmIvSHJc8oVWeU7f93gpYt9TyNl/e4Jx6+dnCAMXaRMXBxHIqkDlGI/Gz+PRi3j/OapEBlNe5TY6af9+e/vd8RGM/UVlCyTXl2xUG5TPk5uoNee93w1y+WYZh5r8DqlFpdKohlaAwa9TAXlmWu241nwR9VftH8JYFCXXnHGZ0epd8rxyC7lgVyLPUVwNWGYV8kJYKMzdEH7AYhW/ugC+SvFHBUxkIK2YCtBBsAkR6jNhuZvQP7EZaU2r9+3t7SDiMw1tAhOlcuByicK3Odg5aJQ3Rn1IOcVMMsghtVpJgVK6QFCr1O5ujGddFW+pMLdKL9jVXHmFdpNQuhiyX1XFisrYoBF9Q0F6BIKgWzQvtfazj59pMmhvcuCXwFRl+21wyWlpu1SFpF+8sAbDVhkhZ/ThYsloXoRG3kIN0cK0xPs8yGRYke9uebos+oL85qxxHrXFHv4mf5MmVSWcsIvmexK+m5MrLSxckKkypZLGieF4NMK/usO8veZFmeP8XMtoF8UTNsdFDi6QfaEliwZ36AO5ta1kZKXDwmnx7KPMF85U3A4Ckm1IUtNtaDqPsBXJRblKcTcR15CKEuUlceS3HkZNWd13yYm0R2VPg726aKKVC7ILq6KXZy0D/loVJZdoI98WZa4WgFLRdIq+b5zQdqu7bO6CxdpuequY6m0Rt83w5834sspz55B6tk52+XbFTbA9DQux8wUTU1ZJ9+3ZKgAd0tssaeuX7aSGbIhJEAPSvNuWv2L+C5vmHC0Wt0zIDJUaDLvylr7DAAmQORagjVOaSWWH7IOy4LqT3SRn5FxiOudyBoxPbZ+SCJwcUjyq+dRuAfl0ukRFoCmk/sxYbmEVcxbAdXvhKZangG31yiP/sY9jvDCNfXXBqZuhMAy780kO5CFoxlJZlIpSg0GAGM7led3fDFfB+6Pi2sLOCH23/xOQt4PoOgbnEMhQe+fQ2OwIjg4mB+l4FGfp4TQ+PDgaxxOAg3hy+PJomh6O0xdHk6i2x9EZvy75AjQ79XrufAl7+k7pgn2Lj1GNfOhtfdtEdNom6PyTq+Q4WraabaO0bIKi6ejlcTp+fhCPj2EcHz6HcTw5ODqMx2n6Yv95epw+f3EUdcwGxqiH8eg4Hh2c7b84OTg+GY+Ho9EoHr08GY2WJDXMYsA++/AAjdi6SX+oiomPM16jMwwfolWKHVILpzP+X07Ecalb8oT/dEsXstNWSuoii8PR4bLn/6Ase6cqmbHfJGO/ybMmyoEM4wFV6RTVEAzJElwLY4fsPf8BzGAqhkoakhPnqZ1Aimz4m0SFPxyPl4f9KkutUjCGpPWttMIuagTCsIIv2JyXJUi0Ts42T1S2QA2gBChEYhimcCENA62VNsxU6Zxxwy6EJBAJt1aLSWUhIS25GLDaw/jF4iI3LKsovuWy6Vmn8RdD9gXcTM/fumFecwszpQWYHfMsghmndfdnbFZhFIsiUyiNzsAiIGTeDkHY3dz9i7l95vbD03Zs7iaMxrgbtPrfl/PItUngEtUEE8FB5FEu1oyRbJUufikhxbiJfLhXRurOVJpWGissi9Klac5x/IBFE2250kS9hntNFqQhp4DLqoYkee8a9Q7QbCtqdZQYWplAKlgPL2VsplVVCjlz6XevODSpRJ6xFOWg8O3nXGY5xihCOultle+ohFIPJAy7kGTYEreOFwMC59bKhzFO5BlnriW78E2ZX6SFzzCdyXIfiTUF6ttsiyj+U5ivl0bGJy4RDWsXsxlI0M2qedKBGabSU546hnCJxTDkj/YoLM+4XVkS6cJ4HZRbQw6XXFosUnGk6QVk4TXZuwAhGek0OjEyG94iTXIYsndKMx8zDDokCB+x6sL9TU77gtY2/IKO+qIurARngqGJkvBxSkXRzXMpqtwKTGCJIupRT/HCz8vKFr7soNLdsbEGEEbGbjzLhKt/fmqN5KpZK8ZebJn7feBFnbB6jvo4PIhNqrTL3zNDlanbQdRi8M8kY47M0JefRJZMtSo2pFd1u6pMrNrcsGPnVjVwof6GJk3mH7330h9/E3Yef5QQO+cX3a5v9d7LjmuKS4OV4L/W/N9/zZHSWofdKwCg8VEyX7gAF3P8DW5jyE4pIS2VMQJDLKvYHAuKtR3K4RJyKml6NxIcRW1WolTotMq5furgxhT8xB9J4J5F7RmuaOAEupunTbj8kfA0VZW0SQY5WEgqOa1kBllS8oVLBlpBzHkn1ohwe6IdmJxES8Fa1HJz0btKZkLO3oOdq4zNuWFhNFaPRmvQAXYJWkwXiZAkuikiLZURD4rsVwwDcFTmR0XP6TNhGl9ANmSfcuAGWDqH9IcLUjBi9XAYL7AjuvZ1U+A5Zs6LJFB81Akge/2AbAIgm3msAFgIgxYq0aqyvkC0BphvkUjKSldD7AX5HaCfXX/m+qNOBLfrcXlJSFIlp2Jmamh1rLkT15Z7t8G8sljXxx0cCa2SPu0WtAKL1cDCbKfc2KAtSS4KYTcgXNF4Zxa+Q8SeBiMazMxVlWeImXvO1piTErRQWYMXZJZk3lquQVk3WYltNS/fyow2LVuaQxmUnXPJDlihpJ1TRW5a4Y6sw5e6knEiZFYZqxeJoa0irN9ILlKTpCqDpAnM1iJuWu/Ozw/Yl2HfFeK4HUI/zOMDDKIJf1Q8Ry/ygmViJmqzswGuCQDMFnCNSF3b3dF+ESlhNctgDz1Yh9WKAhI1nSalykW6SLCgt91aF/diYrFqffsgKkkaBVmtLzxNdcXzRG/WmU6zHSz3K9ePYb+aY5McTTlGVjUeRgAFmDXASyDnmvhCyibv2Ou6C9rXTrkz4KkVlwjZ0XA5rsfAcACmptNQ1VmHGfw+kdlm2evGu6992I8yjGvYXgImPOcyhaQq77CX6731JlSvuaQKKc9+p2V3o5nNyz5XucjQquN/DnAIKygQfcioyG/o1WEEhRTMI0AP5Bd/PTSp7OPBqkvMFEmvAjZgpQ/ZNKCsKglrodbusRazRxHFU9eGBRIM0y7TqmEQPiUnimsMw0O7h+Rf0GEM+Fk9VA3JQViazAMiOKPaozBU7KG0tHdcAovLPY/mwooEJNaPktb5BUU7UWux9VvurqbNtjfle01847BkpLAk5Wj7HN5GYQP+x4xje3Nc4eaM5ZridtpupVx/myhgudfu/PtUx9VPVtB70qhxU5qgOiXzinKJ25ZuFqG0uC3+TvufQt6hdCfm0LpJaXDLIZlpZQyWO8LgEigZ2BTr+Ba7hztAOUIdUYS8oAeJohZckbmq9DaB4f1c3d+RektzJMy4FZd9BnkdT9EP5g9obz45+i0AbohaPaZa/Qky8Tge1NLRYTE3/FJK7jfdsLZwao0rpzcYXdiR4Q4Zzy3oNWgTT2Vz3v5TwIVhE0DjVgMOWy09qOGYB8ZUHmwlC5WJqSCzHSCHauZDgg07RuXSYjsAjpMdljtDaUBfeituFsZCUTcKNrwfG5AVMHTEgG/K9rvtf8YAdSk1Wi0ZlSc9zoJf4yHcPk5T6ZLjnB8R6tvrFACjCI8BV2J/NCKu5kr9qMpNvHxEYCHgCjkAHTl4ap4No+7eV7Ovc94rurePs3Vq5WH8GP8Z748PcIYdgzbJVfoDdO38qegm5FTtJPw9aiuDYZIIHwh36oBCMqX9oXpdyaAe/em7sZdxbp5PvTgGbFU+zqR41oSm5n7T6cHcPKcpZLiVmlh+/ZjTwriQAnA/HrP8mtF495vjMuwtRNHVhP15ooeeZkcMg8UKVeifkMsO6NWTNJXBWsSOJfZtJoVnEwPxthO8cwoNJAfZVBOalZJLS1PX7DaF5kvd71Oqq4mwQITVgzc5RLQOcOOVfxZtZ7usx78wmrfGVELn6Tyxcw1mrvIsAe98otb+XR8BTQtqrLvzKvCFjk1i2eaSC3d2EiUYjMovgVFt/tXrv7OzAI4Fz9jaP1LKUDECneQ3oYGdygF7ry6BnSk8XKfZG07bkW2H6W/V3CtsqtOXy/pyUmfviOpi3FooSkpirfIhHePNeQ53eYFLvAURq2lM3z3BkGaGqxgJFFzk25X1uMjvU9LjIm8nun0AIe8O1bE5d8ck6evDV1Pcbm694YGL29xLEe5KBgGqxUBDgStOW+eheNB0mcAUieE5AWQ6k3CFREOgJ64hSzJhJpU2QJtJzb71mom1W++gfa3aQti3Whn9bNC9dSS6GJRNpniutMPdNy3QpHXUxHHhkaeXjbIpH4/HMc9GR/Eh8JcxH73g8cv9ly+OjtKDyf7L4w2TDtQK2u2+T+zvNvhc/9p/Oqtxwt4I3Atnb9zm84C9xk3pYdTnSkCB5yOqe2UgDoXrH0yfi6gxtC+7KJ/4aNtt8T8ZBhvWLO6mYg3V/raRijVnjvEKRk9GoqmQwswTX+VE74oHCVzo9Qg1ac8gl+NbhZptWTN4ryaYK39YnUjfFYUZqwFssr/7Kr5H4REyzasMLbojFK6qLclM6o4o/dwYRKRPOVzC2NX1Yjd/nwPN5ZVWcsZ89t0f40+6fryrmDuTDJJu9Hn5/lOUbtP1KQxnQ7Y/Pjh8/myFis2VhHufh/iEvcNpiKDk+6PORimeOMhFuqnSsFJ5ssqdAId1W48t1fEXpUzreG9TrHJbOL0EfptC9kpYm88RnLWvBzRnMmj13brg2WwXKQcdz9VV63gDneXadLihye3vXU3AIcNpvr5AtGsEDzNAPUnvyVwMa+72+b7h9u6QRvGBdrBSqGhmg6ejmzbY514ZCJ4JhszfSHri+zxpbhJIxUq8GG9taGWCV5lwI9JHzs45HfML9jtEmxRk7JbC0vW4lh/yaeCK+CPw7cofDl8zO/q8M8O/4bHwYGdmtC2qfciqm4Mao9pRLaF7xBo9RRLri+S9mrNDgDV8upnKU0svQShtWUbBUb7o7/B7cxTm4HZAH7wO3Tv80ILsBsx6u1mbjosJbWxyvwMv77Avk71jL0vWKiP/ME0mQtNLITuO8ob21aeMutepsfegdGzCBYBkc7bbpq3Pgt4niPfB+8sxh8MX+y/jjPPj+BCyl/HRcxjF+0eQPc9GAEcHzzeYNNoNu0dSmuecvRP2zxmW4jI68cvRmGO6xlBhSYbnvd0wfD5A9W7teyasSHQemFPj7OVk+mKcxhM+mcaHfH8cH42Px/HB4QjG2XHKJ+OjDZy6nxU6NVzwOfsFdC5kzSbkS75wV1H97ZXtOBRiapDGxdN13WPzuZ31Z7U2HmH10Whb0tuHLlciqZNLufF8aKfZvbM17N3LGBluwQ7YN4AfWGqSdk5X737Fq6HLqEPRpLa9D5wqhYE2WXvVcqi3nQP8nduK8crD7oOofdD9lxAo1G+h/NtGDLeD6HPLb9w1of8QB3I7iD7UHuSuOf/lSv5yJT/hStwfvCtjSuA/gJtFTFdMOwxrLst3W6K6xOoStBYZXaNyL7bBtQVpKBfDabsJr30+rn60qf2MHC5e6NdHVndYiXB1zy7ShgIhxoe2fOWSHqSjR+fsPDqJ9i739+rXIPZuOo/O3e756dKRCr/Elc5RDfy1bF4Kdys7zqCgq9lLV6veQKF6XHX0YleXxc84pTWEV9L8pKkGu45miZ9xzgbSSlP94Pwm2PdXKfqaVxVO//x7u9UXvE7vXMyKtvUNMoQYnkCjF0yAa3Il/fu1RCKmq2CMV3aO+X/Y5xxEX+hwys+M4CisGeB2EOEzAZ+b59Va73iE59Bq2a3v19Vi41/F+14/GOZfGlz50lfrvcFwHCJ4d3pJDx+mQ+Jhz6v9CtwgwpfyzMfpF9CXIoWWEDT3/emK9B413MtwvhiMxPRv3LsyvuvStT7IU1XQlh7heGLYW6+BLJwiwzfzgtgT7/7LP7zAXYnOP0zyJozKPuPleF+HcdtdKMX+698aocUlKJWxBZctOutf9Oqjv2mef3iYd8C8dFm4tntlzgWJIandjTcH59El1qOzljU86b9DSTbhOx66NhZ73NxgmPVV57e3+PMfFaCxP/+OsqTpnBjJWSYovlvzXmJ7rk8/+9jkGdvw+tfKyYQ7nvRsVRDlyF847b2o6U6Ou+ccdwP4//p9y5V86Tqo9sOeNZPQBG/Pgv/w5y03MHH126AdNrqGrx2z4rNOCLD8jkvTA31BaTe2bfvxT1/PokE08Q9nFooCFM2v8O0DfuUEP1SM8WVN/O0myrmcVS7WciTxz/8CTpNFiw== +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"; + + + + + + + + + + +Sign a contractor document. + +scope: `contractor_documents:write` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/put-v-1-contractor-payment-groups-contractor-payment-group-id-fund.ParamsDetails.json b/docs/api/put-v-1-contractor-payment-groups-contractor-payment-group-id-fund.ParamsDetails.json new file mode 100644 index 000000000..00fa9a90c --- /dev/null +++ b/docs/api/put-v-1-contractor-payment-groups-contractor-payment-group-id-fund.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/put-v-1-contractor-payment-groups-contractor-payment-group-id-fund.RequestSchema.json b/docs/api/put-v-1-contractor-payment-groups-contractor-payment-group-id-fund.RequestSchema.json new file mode 100644 index 000000000..c96bcede2 --- /dev/null +++ b/docs/api/put-v-1-contractor-payment-groups-contractor-payment-group-id-fund.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/api/put-v-1-contractor-payment-groups-contractor-payment-group-id-fund.StatusCodes.json b/docs/api/put-v-1-contractor-payment-groups-contractor-payment-group-id-fund.StatusCodes.json new file mode 100644 index 000000000..9b812c7b0 --- /dev/null +++ b/docs/api/put-v-1-contractor-payment-groups-contractor-payment-group-id-fund.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Full contractor payment group object","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"}}}},"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/put-v-1-contractor-payment-groups-contractor-payment-group-id-fund.api.mdx b/docs/api/put-v-1-contractor-payment-groups-contractor-payment-group-id-fund.api.mdx new file mode 100644 index 000000000..a572ee972 --- /dev/null +++ b/docs/api/put-v-1-contractor-payment-groups-contractor-payment-group-id-fund.api.mdx @@ -0,0 +1,74 @@ +--- +id: put-v-1-contractor-payment-groups-contractor-payment-group-id-fund +title: "Fund a contractor payment group [DEMO]" +description: "> 🚧 Demo action" +sidebar_label: "Fund a contractor payment group [DEMO]" +hide_title: true +hide_table_of_contents: true +api: eJztPdtyG7mxv4IzqTq2Ew7Nq0jpYetofcmqKrvr8iVOjtdFgQOMiHgIzA4wkrku/Uhe8pjfyyec6gYwN85QpCxtnLN+2FqLgwEajb6ju+dToFKeUSOUPGPBSZDmJrwchpGSJqORUdkipZs1l2Zxkak81Z1PFoKFcS5Z0AsY11EmUpgzOAm+If/6x9//SZ7ytSI0gh9/kt+Q1yuh3Z9EaKJksiH0koqELhNOhCRmxe07XF6KTElY6Sf5k3wl1nlCDSewmJAXhJISJOJAIghSnzx3Y3B6FUV5pgnNjVpTIyKaJBu/UpoplltoKuuRqxWXZEnlB2IyKrWFVxOacXLBJeCNsz55ozkx1f3YOVkDemKUnUbgqG64H2hyrg01uT4ncabW5PyNhN1ydg5znD+3/+6T0+LfxI4HVGb851xknJFYZR7KTjxlPOIiNX3ArI5Uyk/IeUo3mUoSfZLl8jzoBYZe6ODkXfCkfP2Fe/2PSBPB+17wMbzItVGhkIZfWHoKzSbl8CJfLzljnMG4lGZ0zQ3PYMpPgaRrHpwEnUSV5wIoSgAhpdSsgl7g9xecmCznTWp7veLkzZuzp0TFeAhdOA56gY5WfE2Dk0+BBTTQJhPyIri+7hWA/SX8I27r9MVZ+GeeaVjEgbPilPFsxzy9gMt8DQgYDUbTcHAUDqeAAsZjmicmOKn+ft3cyFNA0lpIri0xUcPDJdWckdMXZ+TSwkKo1ioSQIbkSpgV2ag8wwFA3X1yFhOpJAeySDN1KRhnPTuGpmkiIjynB5q8Wwsp1vm6Ovf7hytjUn3y+DFTke7j8fYjtX7sjzN0hILPH9NUhO5NIS9+5yYMKz8/AjByzVk/uH7fCzSP8kyYDdLBE7VOqdycRhHX+jQ3q+Dk3fvrCl1l+ope+CPPuE6V1FwD0keDAfyvjr3neZJ0nj1Ry7/xyAQ9pDsuDbxfQcjjv2mY5FPlZLeJLN61Qo8IGSW5lU/lEW0P131gMEs2BVQ0SX6MES31Zb+lGiVVyjMjuEYG74KgdeLyXdgT8lYL1W7vNZfi55wTwbg0IhY8u4m7+sinlP0ok409tGtANp7xYv9164yMb7fPvOLRhwWwyH7z4nhkqVtthPGlMAcsh+Nvv5wV7fst5dTATcsQ8lYkCVnyUoGImNAkKeiSmBU1RK9UnjAYZ/UPeSj6vE9W9JKT86ci45EhT3mqtDDnSI5+mTU3K8Ueoaa0r/YJOXXsF1Fpp3DQFjBcrUTC4VGDb+pA1V4tNGOPIGgeAJSG50/goM8bUPUrktm/HvQCCwQI6G36yjgKhoVRH7gsT+JdeRQyTxIr3GtHAuNR5oHiXtMP3WdC/CLAZutUgVzy58SzTGV4QsbwdYrq3Cj7BifUTYBbpoTlVpBxgtC2kNR1LzDCJEBKpU4PnU4PUaeHIGsCUIS7ZUhKMyN5tlBXkrMFE3qZZ5qvnUz1WFoqlXAqO9H0dsXNimdW0VXmQL1lVyC4Qjt/5Mu10KBhFstERR/QtigAp1lGN1u88iehDXBJ+S7x7yIdH8akvUAYvq6uWqCrvuypX8VScprxS6RrP38JTn8L1e7NhV1hH2EAI2CT1TUfaPsnkhAYvq0rb+HYL27Non0Wh5FeDm1juXWRXOLThcJ52g7RKqIzi+wbMN9Qdm7uw7Hn3iQWqoI69tzToarJn0dFRTVtPIMauQpU68prbiijhrbhhjKGTghNXlSw1GZPnxYjARh6O2Cut6xb2Grp7rkDB5nm56L7IljzhEeGM0c1hwjnLdALDuFcEj8xQJVxrZJLvtfBxzTRn6e221fwKiuXDhqGy7p/bqutipR/YQ318FUxcfitnTh8DbBdWx3HhDlcgtr3vgjpaUER8uLXFp7opC85/Gxh6NBUnydF65i+BwmqJHd+x+5zeNNgmpI/aANIstxYajYuBHElMm6DIDH6zqUz/64uomuSsyLM3h8q2D3bWDAWAEC7KLhB3tc39m8T9YdK+iqCYe8LIRd0rXIJD/0PjFOWCMkrP8F7XBvrrG0hvTHTXtu1Y4FalhzpgEGg7CHjkVjThNg3H7XtbwvMlvVila0pxFQwUGLEmm8B8dS9XhxpjRgdYBgQ87K1A44abm7ce9WJxRWFJG6GVtP8ZjH+BEmxEOGOHcMfcUUr5E34Fgi9zYC/M17GuKiOMs6lXqkmsf0q3AwgLCog/EYZW0hL/uAC7WbczpEHkXFllm5S7gV4OjSKgO8XCdVmEas8WzBxIYw+wFD7E9WGTIh9z8OA1OcmJzJfL3lWHGmDMsnL52f3yWrfUvkhfFVS4V1znQ13Muf1r8TFimRCfyBxRnNWbO7XYj0HzcKoBYCyAFAWCMoii8VXFvyCWPAOSPylPe3wtQq/Exer8KXQH8LncNrhy1jcOalfUTTgkTLAvM+0VZq/KoUDEItYZQsHwW/OaKyjrYqFBeOGimRRJVcgfsMvcH/tArwk2+qZEjvXF6U5tmjurvnpLRUmfK6y8KVdydlpALkAyNdCUqMyjK3aU9j8YK8iGzS/pmkKW4drqoprc6MT/dV5+8/hw6/O22/beetyc+6Tyb96dV8Kx3+RJuVv2au7yfW5Y7b86vZ95dEv1u3rcJLumAW+uoNfAsF/dQd/bXfwdjfme1wQ/uq35btg+vyb8i2Gar0kTzlqUeBfwa+qt+a9IKYigevzPY6uuCo3ytBkj5yTQxwsnNO7WZ78XLZq3JU42pGZePi6NkPxkNXJq3wNz67oBSf/TTIu1mXalp2oFUIYfwsAcZnPxU4NyFsA0bbJ20NjRf3hUFhR/3mrb0uuXksOflv+QJEssA1extOMay6NNU9UDEk8Ql4kbckg/670ZCEJZvR3ZCgXKLhtkrKfoD3/Q8l95RwO9afsi1RK1G1NvVJ5tufUTsepmOBL5EplH1y5yE2r+OIMm0h7mImynXxbTyAOegGm6wa94DuhjcqgQsdXmsBDlcFwIC3/Y1uubo1J94Owla/3wPldJmb7VN9KgVCl1IewHGYuE6HTTEGlBPwm4noiZyNl2+VFr6jeJ2O7T8qMYF0utyObmlwB2BlfUyEr6djVc37uU6yLbOv3jmKTzSLb29aFkSTlGZLtIVS7pptFRGXEk8pCZU5yR92NR2yLEIEE9iUnds6kI9kLVNZ+G4vFRzDWQcWp2mH2SMYvaMYSrnWTX7u16/45brgk+iwtaPSn9x2eEyTIA5itPGeXBe1087oP7SZ+Tyrn/4j8wcLyByv3WhXWx3CvQrQdme1gZ+NANLCxuIh/pOs0sQpH51h9VOqeID46HvPBeBKy+XgcTo74OJzP2SQcRfPRIBrPx9F0FjQLW4JoOhlMjuJZOFzySTiJppNwPjyehPFkPhlF40E0P2J1LxUrwSbhYBoOZkG9vqR8MgxKiVOtW2gWJwSTKY/nw+UypHw0CSeUDcPlKDoKj/j0aEwn0Xhg32vT9++KvR+NByw6no/CeHI8Dyd8GYX0iEXhhM2OZsPhYDSLeNCiMoMRP2KD49kgHA+XcTiZRTxcsuUknA3HfDIazHgUT4JCFwaD/iAo1FcwKf8sZEMwnOOPVTZG12FbH22rlIY6CGZTnKsNkZZhHUAVTio5oErnwWwEI+EC3G18OIqnQ76kITuajsPJeDoL59FgGg7jYTxng5hN+bgVY/R4No0ZHYRxFE/DydExDek0ZuHgiE/GbBix42PWibE2hA32xpfXuE00DW7C0nA62EaUlRANPLmRwG+l4+TN3mA0OrYnUnddyt9rDkMwGo3ssu22vD1ekBZvQWO1VHdUuHvKo/FyOh+FMzaYhJPx8Sxc8iEP4wGfHbPBgA+XLdw9oePj5WhyHA75aBRO4ug4pJNBHEbLwYyN6HJ8POEt3D0NB/NwNGzhbnwyPN6Xu/eEeldhjiOG1rqZd81c6SCGeAuNVguzyrheqYQt+MeIcwtfPaU5eA4RltMn35HXfjB5Vg7eij74W7nq5ivO+VY687tm1K4yQTfGq7Gt7evIytjXw/nJYHAyGPxv5TK1pK2jwcCSMjJ9HY61ugSSd4EpdJX2A6idHKbB9TXWv26l5W8fkAuSYoiyREfjYN5WIqkQYyJnsvVAqjftlUOpxVP2OJb6NL/e0XTd8wYzOh7GPJ6Hk6PoKJwMh5Pw+Gg2C0fDyXJGx9FyOh4VON+tGSM6j2bz4+MwGoE+HCyX4Xw54+FgHg3Hg+N4OhxPW+X8chIdRWwchZPlZBpOZuN5SNlkEI4ZnUyXo2M6O5rek5zfQy8WGNwl9Us03yj2PbO0y31/Yi2iv/qoLv2H5YNO+V8OqQdYAvz1+m4sydKK7AWTwWQ7HvKDMuS5yiWDxgrWx0RybC0Cd9EbprgmUhnCPwpt+uR7KBfVecZ9hwqs37fxBqHJJU0E6/8kb1/GXgBJfpKENOEEhs+ziO8L19nTx3XQWiI81UsbLGrV29cy7vcdoacbZ1184CiAqeEXKtt0rIGjbvRXXqU8gqCShmYgbs+2Htf2E+mT15vUNRPBJiAf+KYMRdnmDdSYTCxzwx8X7S9IxhPq4uXFlH24WCugPgA0U7l7sjMRrHN3U/lD0g5ypDchLzShknlv1lcpL3ORMBJBkGztxq+oBIl8AUER7B5R6fKBMK+51nu5uy88IPayRxO6VLmpIDV0LUsKdLqpPZQ6z2IaWUgpNGthADhg7trxdtWlkwqviiSrEta72vkH5TVqifnKi5XNBR0MckUtf+AL0NyiepnwgwLHM5csfAaLhj9aqnWyYzTaZss30kV38KbnmTTCbKwYAXTQDVnRNOXSNqfBGyzFNnDyeDQOPhQzVEh35JroPFoRCAIJiey5KIhycUmTnJ/3SHHpZWeI8YBYzh2uizeLjkHnffKKW5Z498wu88TiUHB9YP8QBDOMitcfkYtcMBuZWKvielB/lsRrR62VfV+R65H7VWr//5fa0BqoWEhoci5RqC3sOZ73EDh7VjbC60ieUGJHknM31Hek2dgoMUemcozxxSiH3QkOdTCeeObOeMIvqTS28t0oTyAbx8lO/AtJkKchzIBiw0mkZcL75LnKiNNIvdoUCB+i6tz+H63pczxb/wv4DecW/cvS0gLDat9S3XWeGJEm3K4FfNRgPP/zNrP5JwewdH1td/dn93JD04GWtTd7BrJ/qJRIO4xieXhJNhHcHGE+EyRMIDVUELxHAtbW/aIPl9tpcEYrvaESfEdSRTEuTxdG7R5Yk3NtA8BP47uGVKyQ7x31hxAXC3+UPLTKzzpE7aO+d7Rjh8LR3Fzt8/XM/xPOHGbqVNiN1jwgfLB9Inp/cCm2Q230yZlt2qO0FmBiQeIqtGsq5FDCL3mCl1lOjXhFUYiVIBJZlCc0e2jBrdnNj4LqDlsGBC1eQC19jPGEG77IXWyjluvQ4SFA2726e7BlrNXcBNd18nt7Pwo3r3614kbVnkENsEueiXizEDKyF90LZoM1dwnZX8EMqCW8RVSC67LkBNcX0KjrRcKh05xNNEEjBSxWB467H9f97i3QBG7vNgs/471uANDrFrSZaMU+WgDEeDdkgqncuOKpLq/QjljYZIl2EBtGfg3Ql/Z9n2xR6cvp4PIhukjJWFzoArTC1jwIa9tvV4E5NQSO1BDoBVkas+tcm6ph0Q6Y3y3eA/iHiVgLswPClsEHoxDvEnyIDOeoJDdQh9kC5kXKM6FYCS+XrEik7YCyGNIKWzsun0lm82xLzkEPyqyoJGOyVtKsNNiEcW5yLO2rtD4UkuXaZJuFDbzD1YukItKLSDG+KA2zTojL0Yfj8wd4l8C7LeS4H4RumfsH0JMm/zmnCWiRI5e1ezO42gOg9wBXi8iOPRzaVyJCWPU2sD7F2MIK9WwLFceLVCUi2uCNzH5nvb4VEtdt59sEIpfIUZwV/EKjKMtpUiTkdEBVG3aA5D6179ksHo+xZQKiHCyrAh6CAAquOwAvk3nR6dqlHRuvHgLtE8vcjENL50tMPMI5rI/rYCCwAFFx7KM6XTDzdZqoDed6n2MvBh9+9s/8q9h3c28KWNIEro8WeXqDvOzW1rugekIlhkcp+xseu11N7z72lUoEA6kO/1mAvVmBhuhdWkWu+XBhRqBJQRwEoIHc4XeDBuHiewOruH9BS7oNsB5JnclmO4IqyTtBLdRjQWb3QopndgzxUxBwu3QlhoHwKblUNAMz3I+7S/x5HgaDnxRLFSBZELY2c4cQvMbYIzSGl76Hq6xFgSG43NBo1qxYcAnxo0XlEllhNlwnbM2Rh7NpeS+J/l5p31hYbK4lUjk2ukN4S4b18N+nHdvYY4ua04ZmaLfT2HB78b6PFbD91uH4e1HY1Q9a5ntQsnEZmsA4JXGMcol5l7gLH1rcF/7a+M+CvDbTjTD70aVLA1cO0Lpfawh3+MUlR2dgl63jRhxu7nD0EQqLwvsFDZDQaoETwXSKPVB6O1X3Hea2lpwj+QU14rKJIMfjZU7yHckbV7hUAcAuUbBHnKlfuFw4OO5U0mGrZrv8lkvuLt0gtnBmtA2nlzBas4PBDRlNDM86oF2UOe/3BbjQrotnAbC/ammAiqFGodEAdMDmcq2YiAWKbQ+yj2beJbD+xijdOmwLgMVkDeVWUGqeXToprjfa8HUxyMvwpm2AUkAvfHuOG+0EO/5zBFB9ppKrJcHwpINzTT/CxyWacOo8Syns+R5B9dmMxMEAJzEcDBCriVIfoMFtNy7vETBvcHkfAPOEHupH/UaWXXmv864RdC/ch6ARK/frh/BnOByNMcWhKtB8sqFX3xh0g1r1g4i/MVurMYwU4QzhWhxQSKIyZlvBZLn07NHcvl17G87d+ykOR3OTp/ezKcpK01TfbjsNMHfvKeYMrlIXhn68z22BXYgGuFuPGPqR4Hq32+M22HuQoo0J2ySRO99mjQy9xPJR6M+gyxrQ7ZvUuYZYxIEh9n02JSCpxU1eVYI3bqEEyYK8nWVeHE0Rs9tlmrckqR8eqmv5ykOxeOlDBF0Al1r5c6GtXZc18HdA3n3l/q4JQSOj+3BcebwACWDYpmg6UCnt35HnX7k/UkpjMAKUpEs675Hv1SUnrxVknmbkKcXryKrCdF+LupXZVLgvl8W3ump3RxgXq39ExZp0hJb5HDmWVVJJVG5CFYf43E3o3UxxgW36ILQH/S/2CuvZ5hYHh/SoSKqObhMA73f76NiK6kXx9O6jKfY2t7jwgMMtViPCftXOfqjJk0HGoTbCXp374EH5ypLHMBnkCWD7McmvYFJv6EFmea16xbNO98aqow/gvpZP0LVaPzt4r2uKPTJLn1a/elPPJe3d8/bYgMV0NBqFlA2g0I/OQjo4ouFsODuaz6Pxcjg73rHpRqnBLWz/WjWx159WapyQeuFCj2DBWj9oYsVD4WoXbg1F+RlFOARrUW9XSZMHztq2V/wP+l6G/bvyjXtBLKTQq4WLcoJ2hUQCa3rdQ0zaIcj6+EYBZxtSLt6ICSbKWjELnPomK0ybjHOzGB5+it8D8dgv74FEtxOBbMmgrrdJM5FNUfq8NXCS5sw2S+dw1QuvAWpdlPgqU7ZiC7zv5hq/iPQWZG5FMpfga/so3i8itZeuD3n/ok+Go/Fk+qiFxVZK8lvnQ7yAt302hGfy4aB2UQoZB4mIdkUaWpmn+OJZ19VjhXVcRyxdSe8tg1X2CqfhwO8TyG4Fa3cewetq7UyZk4Gnb88FcrOtpex5PFFXlfQGzOXaldxQ+va3jibAkj6br0kQ1RjB3SxQbNJpMldgeLPO95WIe6tDXMUZ2l5KAaPpHZoOnuM7t/JAICeYM4KPyAP3zoOykkAq6G0BfVj9KO21ypJqEd2zd04xzc/Lb29t2u4fB7mwknOmK3rIuYEt9ofHm2+U0bE7fHwwwt9CWriXMxd4LZo5kzUrEzUGhaLagu4eY/RoSXQHyRsx57LLCPZmoRF8rC9NVWYIQ+Mo2TRv+H3tq9uDvQG98zh0I/mhArJdkDVus3ali4lMm8XtEl6ew7v2Q1k1N6lpN6N+iBdLkeFnpA9c5an7eiu+XrjGToNi2oQ1AFHm7HdNW+SC3saI92XNI8onR8NZyCg9DieczcL5lA/C4ZyzKRtwPh9Pd4g0W1x8uFOaJJQ8F+aXCwjFMfuZThDmZSMboOFV4zZMc7ARWz9E3uLo3DGmRmy2jI9GUbik0JaEDkfhfHQ8CseTAR+x44guR/MdmLqdFDrTVNAV+ZZniZAFmmwRN6LoylWv7Ichb1Nzqa09XcQ9duftdOdq7UxhddZoldKrSZetkBTOpdyZH1obdmtvDd5ueIwErmB75C3nHyDUJM0KS+/+ymkb1D5oUsjeO3aV/EK7pL2qKNR66WitWjHsSHa36e465fQDp3oTgiAM1SXPMsEwjGidyuoQLCSrcZhDqKt97wX8o+FSF80dLAL8p9grZWShsy7tEUE9kSs/DJCd6+/ZT7gXg23vqHJQ1xaKF+xW2l+xWyqHdm0NuhEUTRHSHLsOUvjafPD4cvi4xQywH1N//KnrEYqX68cOy3jF6mgnz6ANgi/TpKmwVZoh42ss1WzpPLZWjZOy84U2TgOPsfNI+8Stc77IVPP0q3Om8BhwonmUZ8JsXkHhrM0Jc3biKTbFOs0BSUWtCCwO28XRwBucZmhmNivpcIoQiz4Izc0KLH1/o9ELXuE19OesYGfoWACdOHsH6VkKez+S0xfQO70INLs2I0fQdqUXQPs3/WP8imeXIuIVTJdFtliX+BgHPmawNEiAEP+GgLF2r27V0vAkUmuMoyMcDzR55viF+NSN0xdnhKkoX/s+mv/lqp2p9YtdO5enflXyEipSnfNjY8xAKu7p/5SUAdhIlTZrKivzQKlKq7pxPSnePX32/Y/vmzv5VNZfB9+Qf/3j7/8kQLyE4sXBT/IbghYiLe4RMFurvEhw8Q18h8tLkSkJa0KR+yuxzqHEFrsX2pBw91fsXaGNnd4W9gIRKGiQbmt7fRfHTLHcQlNZz1Zr4vUdtl2k7j4ILglsoSkYseSN5jbbw+/Hzska0GNNcNm9sRvuB5qc2zjjuf1ybNk1sdrzsU9Oy/6PZVzSG7gYlnRQduIJP4iSmj5gVkcq5Sfk3CkbfZLl8rys9jb8o3mcJlQgZ6KM+eRk47vgctjaMM5Jx6AXnOyUj9BnGQTke8hI1QZm/PQJ9OmbLLm+hp9/zjmo1HfvQYRnmESDQpQJVH6s6GzTSYcPXzrEPCLdXVnrB9G1eV8QJzcVjRK46rxONNid2rRbThnEiw7aQNF40haG46dwAEcMZYITVlvd3bGwGwYAvWNVtwRDSJSptj07ptIm4YEm79ZCYvpKZe4DewrQVITuTSEvfucmDCs/PwIwoEC934Vpi9G/hCgOw9MXZ+Gfi4u7AvGlxgdNkZrKs63eDzX9/uLNayhBrSuWQpG4f1RqqOsH/umTHfEaGq9dXxfnbxuxgaV2/X91Jrug +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 group. 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 group'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/put-v-1-contractors-contractor-id-payment-method.ParamsDetails.json b/docs/api/put-v-1-contractors-contractor-id-payment-method.ParamsDetails.json new file mode 100644 index 000000000..e23083315 --- /dev/null +++ b/docs/api/put-v-1-contractors-contractor-id-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/put-v-1-contractors-contractor-id-payment-method.RequestSchema.json b/docs/api/put-v-1-contractors-contractor-id-payment-method.RequestSchema.json new file mode 100644 index 000000000..32f983de0 --- /dev/null +++ b/docs/api/put-v-1-contractors-contractor-id-payment-method.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"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"},{"type":"object","properties":{"type":{"type":"string","enum":["Direct Deposit","Check"],"description":"The payment method type. If type is Direct Deposit, the contractor is required to have a bank account.\nsee [Bank account endpoint](./post-v1-contractors-contractor_uuid-bank_accounts)"}},"required":["type"]}]},"examples":{"example-1":{"value":{"version":"63859768485e218ccf8a449bb60f14ed","type":"Direct Deposit"}},"example-3":{"value":{"version":"63859768485e218ccf8a449bb60f14ed","type":"Check"}}}}},"description":""}} \ No newline at end of file diff --git a/docs/api/put-v-1-contractors-contractor-id-payment-method.StatusCodes.json b/docs/api/put-v-1-contractors-contractor-id-payment-method.StatusCodes.json new file mode 100644 index 000000000..7377ab555 --- /dev/null +++ b/docs/api/put-v-1-contractors-contractor-id-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"},"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/put-v-1-contractors-contractor-id-payment-method.api.mdx b/docs/api/put-v-1-contractors-contractor-id-payment-method.api.mdx new file mode 100644 index 000000000..f2327796e --- /dev/null +++ b/docs/api/put-v-1-contractors-contractor-id-payment-method.api.mdx @@ -0,0 +1,72 @@ +--- +id: put-v-1-contractors-contractor-id-payment-method +title: "Update a contractor's payment method" +description: "Updates a contractor's payment method. Note that creating a contractor" +sidebar_label: "Update a contractor's payment method" +hide_title: true +hide_table_of_contents: true +api: eJztXFlz47aW/isYzky5u0q0JXn30/Q6tx86cfVyk1vuLhoijyTEJMAGQNuKy//91jkASIpaLLnth9xKKqlYEpYPB2fHAe6i23hSGatiIS1MNLdCydjOSojOLiIoRpBlkEXfe5HlE4PfvVHSap5apdk5nxUgLfsIdqqokSrBDfEhi86isrLx9SBO6x6m9Xcisrh0AySFG6AXaTClkgZMdHYXDft9/F8GJtWixFGjs+jdLS/KHFhoGfUiHBOkxba8LHOREoK9Pwx2uItMOoWC419W2Byis9YSYr+E+GNA4JYeqdEfkNqoF93G4GYkSH72eIAfrnleAf0B2jh0R/snh6fHRycHJ4cwHJyk6fiEHxycjkZH/fHgAFoTvBUaUsveQqmMwIlMmQubjGbRWXQOOgVp+QTC90j5u6iqBJIVTk7Gpwf7R/Ho+ADig1N+Ep8cw2l8fHw8Oh2N4XhwiB0lL3Ci1+oVezOF9ErICXuVpqqSOF2phdLCzqKzQZibF/Tb2aDfv/9+f9+rVzv86dUSgOgeB53fTkKCXGOFo3A9+l3oa6wWchJ1e36ZAksrrZEBfSemxsxOgbnN22WfAejzhf8dKTCpRAbfX0ytLc3Z3l6mUrNLArCbqmIvMDxyplZ5Tr/viQyKUlmQ6ewlGyvNhBwrXRCbMSXZVN0wq1hlcDph2FhAnu1G92H5dxGXs1/HtIfdRYGsChSrBX5wJPt+36v7yCrPo/vvywjhBYk5QWLYYZd9GNMfTBjHAD0khmSXgdMuGZeZ/2guWaaYVJZJgAxXMwJWqrLKuYVsbqx5pL2V43GNUvqjEhocMRoO34QgrwrPqS1p2IAab+nTCIzblRZtbkSe46oIBq2ohVwY1szjCYWdXZNL5mTDsKIylvEsY1WJRIJbntp8xgb9/pIR3RL8aCQ/hqgiJMOZDNELZ8m5sQ6Xn8jNMwJ2icu8xKlSXtpKO4bWUHAhM9ANXU0jMRcR15rPUAUgjb73ImGhaDVotNs87T5BqcEgDayXJs5GXF4x7tQGw3EWJNZppU3EdW6sD28Ru1NSW3embve9aCqyDGTiv05kVYxAPzzeR26uIOsM6fret1VjPQ4ZR9BLgSmdgUZihX6kIoCn05r1aId67EbYadNqwEaAGgk3dCw07ncbT8lFtsvOQ+vAEJUUPyogzjHwowJpBc9b4hWUeNduLjDnjuPOnZ7TWfhvYMsXsDvZ7bHDfp+W8j+Hu/3+S5oy8LuSUAMlZFN+DYyHKRyISyTKQwy8KDU7jSC2wJEk1z84aQpAjxzOo/7/vtytbc5Fa9OcHKD1CQoJfyfGRc/GuwXzvkD8msurOBhMMl238QZO0H0vWuIx/OX9hRWSFv3++++/909Phxu5FPdExoP+wSJ//qIse68qmbFvkrFv8svUWQ8wFjL09lSlU2CZAkNmCm6FsbvsI78CZgJblVpdiwwy9vXrh7fINdc8F9nuN4nycTAcLk77VZZapWAMH+XA3kmLshYQCMMKPmNTXpYg2U2wCSOVzZC1Z6rSASNDJ5QLaRhorbRhpkqnjBt2KSSBSLi1WowqCwnxwWWPKe1lwY0w5iI3LKsAhYXLpmftVF+2XJp3bpo33MJEaQFmS5+GYMZp3f2l84xIkAqlgWVgERASbwsX+2Hq/k3cLnG7Rrmto9yCUUvNG13/fWOhgslfaeoXRk2uADt4lLMVc1CrBw3q5xJSMRZgcCO9MFJ3ptK00maXfZmVIuV5PnMa/QpmTGRovagXtq/3cK/kmhdgARmA/E/ctHpIMnY16i2g4QjkxKqxH4lREOGHCtrDcxmbaFWVQk6cm5ZySebXeO+4EnnGUuSDwrefcpnlqDSFdNzbiqjJzNUTCcMuJSm2xO3jZa8VtzhH1bM848y1ZJe+KfObNHPuBDiV5X4k0hQob5MNvKrzsF7PjYyPVGVbexezCUjQza75oQMxTKXHPHUE4ZKBzJA+2qOwPOOWP+x1vgnCrSGHay4tw344pmeQmZdkbwKEZCTT6KKS2vAaaZTDLnuPrpczub25IQgfkerS/T9BVD5k8d+gvbys44RgTNClUBLmw5UVaymq3ApMT9CIKEcdwQtfLwpb+GULkZ6f2wg5CTNjN55lAn/i+XlrJqsrWDq3I8jDXPMLLyAE2p6idsrbbJMq7bIzmWFWETe0CPzwDF+di1urB016s5mPRnTae6xV0Q586hG9xxfaVWVi1fqGc3puWQNjuYV1Te4bV/Kj5/74N2Gn8a8SYmf8nB+5vNVHzzuuKW5NK9r9e8//wntOMcEqgz1Ph99Q+SiZz5yDy8Ras7HLPlj8ulTGCHSxrHKRWK2HcriG3ODeeTMSDEWtVqJU6LTKuX7h4Mbk/MS/EsO9jNorXNIgBEbtkAfD2DpQyCAHC0klx5XMIEt8SDznxFzM+RrRiLu0bm3iowVnLWqZueh9JTMhJy4AY1NuWJiN1bPRHswBuwYtxrNESGLdFJFSaPWUyP6FbsBcVJ9yidHLCBjNLzC3dp4DN8BSDLqck4Ieq4cTMk+7q5fAcw08myVhxGddAJLXT8hGgHmtsI4lAAthUEMlWlUWxWY1MN8ixJVLIXac/Dmgn1x/n8VBmWilHhFXOGpIlRyLiamh1b7mVlRb7N0G88oy3FJLaZLGmQ0pnOBYLAcWVjvmxgZpSXJRCLsG4ZLGW5PwPSIOGSsag5mpqvIMMfM6P+YxJyVoobIGL8gsyby2XIGybrIU23JavpMZ+oPQkhyKoOyUS7bPCiXtlFJX4wqzSw5fqoqSSxTurDJWzxIDOaTI3YnkIjVJqjJIGsdsJeKm9fb0/AX7Muy7hB03Q+ineX6AgTXhR8VztCJHLBMTUaudNXBNAGA2gGtE6tpuj/azSAmrWQR74ME6rFYUkKjxOClVLtJZgnmtzfa6eBQRi2X72wVRSZIoyGp54WmqK54ner3MzDXbQnO/cv0Y9qspNspRlaNnVeNhBFCAWQG8BDKuiU+krLOOna7boH3jhDsDnlpxjZDdGD5l7jAwnICp8ThkdVZhhqLM1QzAbLLtdePt9/5d6No961rPASOec5lCUpUP6MvV1nodqjdcUoaUZ3/QtrvZzPptn6pcZKjV8T8HOLgV5Ig+pVf0ximT2o0gl4J5BGiB/OavhiaVfT5YdYrZn2ksAuux0rtsGpBXlYSVUGvzWLPZs7DiB9eGhSEYhl2mlcMgfEqOFNfohod2T0m/IMPo8LN6qhqSg7CwmCdE8IVyj8JQsofCUiHnssCYXO5YNOdWJCAxf5S0ylMwCFuDrdtyezFtjpAo3mv8G4clc8eIyOWo+xzeRmAD/uf0YztrXGLmjOWa/HY+tqAp1t/EC1jstT39zmu/emfJeDuNGDepCcpTMi8o1yCtX0VILW6Kf679TyGfG+lBzKF1E9LgkUMy0coYTHeEySVQMLDO1/Ettnd3gGKE2qMIcUEHEnktuCNTVelNHMPHmbp/4OgtyZEw4VZcdwnkZTxFO5g/ob45d+O3ALgpavEYa/UnyMTjeFJNh1kfP/1CSO4P3ahuxxqXTm8wOrcjwxMynlvQK9AmfpT1cftPARfGl0DUgMNRSwcqpRqxCEAUYW8rWahMjAWp7QA5ZDOfEmw4MSoXNtsBcJScI7lTlAb0tdfiZmYsFHWjoMO7vgFpAZO42rIN/ATX/mcU0PxIjVRLRulJj7Pgt6Koii5OU+mS45qfEeq72xQAvQiPAXdi4OtScqWuqnIdLZ8RWHC4QgxAJQcvDBWgtM++mnOdi07SvQ4fok6uPMwf48d4MNzHFc4ptFGu0ivQtfGnpBsWJW7F/J3RljrD7eKe+VIw6QufrGK6kkE8ust3cy/iXL+eenMM2Kp8nkVhEV/tcD9uOR2Y69c0hgyPUhPLb59zWegXkgPu52OW3zKa73FrXIS9ASu6nLArEnnyZc6xYdBYIQv9E3w5B3r5Ik1lMBexZYp9k0UJLGrxg7eN4INLaCA5yKYa0aqUXNiaOme3zjVf6P6YVF09CAuDsHryJoaIVgFurPLPop07LuvQL8zmtTGl0Hk6TexUg5mqPEvAG5+odX7XRUDLghrr9rQKdEEWoLTNNRc594d56PHn18AoN//qzT/YlwCOBcvYOj9SylAyAo3kb0ID+yB77KO6BvZFYXGdZm85HUe2DWar4H5rt6kOX8IgnbMjyotxa6EoKYjFInly6Rhv6jkqZE50OVRlYzWO6Xc/YAgzxURyqzSm9rjIN0vrcZE/JqXHRd4OdLsAQtwdsmNTbpL616fPprjT3PrAAze3no1ReZAHVLOBhgJ3nI7OQ/Kg6TKCMQ6GdQJIdCbhBgcNjp64hSzJhBlV2gAdJjXn1isW1m69hfS1cgvh3Gqp97NG9lYNMY9B2WSMdaVz1H3bAk1SR00cFZ55eVk/G/PhcBjzrH8SHwA/jnn/iMfHg+Ojk5N0fzQ4Pl2z6IUrU1v7/nM3RYL9dFrjbOFyB1UC70ZdqgQUWB9RPSoC8YXx1D+oPudRo2vfuc+y471td8S/sxt0WLO565I1lPvbhCtW1BzfcNPlkWgspDDTxGc50bpiIYFzvZ4hJ+0J5GJ8unciLGsm7+QEc+W8mISGfsgLM1YD2GSw/S5+ROYRMs2rDDW6Gwh1iwZjFngmdSVKPzcHDdId2VXpbG96sZu/+IDq8kYrOWE++u7O8acoH8HmTiWDxFg7ZPH+FKU7dKXbC2ww3D84fLlExKZKwqPrIc6xd6iGCEI+6M8dlGLFQS7SdZmGpcKTVa4CHFYdPbZEB4/v7BRMq7y3SVa5I5xOAL9JInsprPV1BF/a1wOamgzafbcvWJvtPOUg47m6aZU3WH8laGVxQxPbPzqbgFOGar4uQ7RzBE8zQb1Ib8mcD2setvm+4ebmkGbxjnbQUihoZo2lw9+pz6MiEKwJhszfE9rxfXaamwRS4XWiQlgbWplgVUbciPSZo3NOZX5Bfwdvk5yM7UJYvK5pWnbIh4FL/I9AtxtfHL5idTfuGtGWBP8Ny8KDnpnQsaj2LqtuCjX6taFaQPeMOXryJFYnyTs5Z4cAc/iMKtNTy0xVlkpblpFzlM+6J/xeHYU1uBPQJ89Dd4ofWpDdhFnnNGtduRheN0weV/Dynq4qyk7Zy4K2ysg+jJOR0Ha6/Sxv6Vx9zKh7HRp7C0plE84BJJ2z2TFtXQv6GCfeO+/HQw4HR4PjOOP8ND6A7Dg+OYR+PDiB7DDrA5zsH65RaXQa9oigNM85ey/snxNMxWVU8ctRmWO4xlBgiYenndMwA+gjUohYHzV7IiwJdJ6YUsPseDQ+GqbxiI/G8QEfDOOT4ekw3j/owzA7TfloeLKGUo/TQh8MF3zKXoPOhazJhHTJZ0SiG397ZTMKBZ8apHH+dJ33WF+3s7pWa20Jq/dG25zeLrpciqQOLuXa+tC5Zo+O1rB3J2JkeATbY78BXGGqSdopXb37F/BlqEPSpNa9TxwqhYnWaXvVMqj3cwX8c7cV46XF7vN3e18HR6G+2fuX9Rjue9Gnlt14aEH/IQbkvhf9UluQh9b8tyn525T8hCkJt987954oHW7m+u2YTv5rl/2iLLgrV1Ry6HK3TY9vcu5QjG4w8tzU2XbMbqwb/5v8Jk2qSjhjl0t8c9fKnN1oYeESb/qH+NlR278c0N05jOlJ1ZH8Njl7dx2t9SzT3M2wBRJh5E73+f0FtGYa0hl+8t/j/6dnrF6df4j/WZ9GEIAp8IxUbANhzHMDi0/HWIwIpb8qjJSLUXNn7NX5h/qNIW6MSgWVpVB2g676YgO83Uz3fCWaRtEUX/Zcm9bF+R3DLgohqaChNfaWt8x5KeLmZaP/9gPGra9fIgy8soyWYBXBmyd3hv3hYdw/igeHEb2rM+ZVblEAm+/v8cUdH4G8VhklRLo7u/FjATzPV9yq3fhNKAjPa0SHR1m/nw6OT0bp8f7p/mjIh/0jyI74yREfp6ODv+IDUp0HSwIdWm+WeFYnj+VT25Sup+iqa58PvUb1mLenukcK8zLc9gHq64vztSa736QBYBev2zoOZFYqIe33F7t7pTLrHpqjg6T2vTTzcoG0RAjn8bc9PHiu997um4ni/Z8evH5ebckDa3Q905TAr4CbWUyvGswpa+/d1y/gtVujco3VNWgtMpzIX1lA7BakoSQgyq+ztCufEuyF5bWfFEQuDf26+OoOK3Eu7z2PtxnF40bl5Q/O6HVCMmV2Gp1Fe9eDvRb77N11+Od+b+Hgjer7vAWsdI6GxusEXgqnEuIMCtILC8rnLRSqQ2s3XuwOCfFnXOKKgZeOea4X9q89Zok/IwUMpJV7p+fiLgQbr1IMfF5VSIyL7+1Wn1FdO2lY0rZWIQgxGBn8PAKulzyY5YeI6V4y4xU+jWbropte9JkqJX9mBjfCignuexGaoU+NAWu/z1RL3ga2ZIVYo8vhyvCChia3BK08smM9Q8uk9iJ0O8yv48+gr0UKrf1u7Ao9zbFHDfcyXBpq85g+Y82E8V0XrpNDnqqCSkkIx45h77wAslC9jA5IptKqCA+//Zd/8Ie7oyHvYL0Ns7JP+CiLz/+7MgtkWP/r/zX8idRG1Vxw2RrnaygAWeOQdtdx1/gUf1GP2bOLhVu7V+ZcELOTcN95FXQRXQ+idmocyXu26FN39NB3vHVkLPa/u0Nv9avO7+/x6x8VYLRz8R3VoKZCaZL4TFCCY4UX3Cb1i+BRvGRrnPAViwvPHMhZSw9H/s2FhVjBXZ9yjvp2IP/DvfaltHU0XB7y1KRuLOQbR6z4y5wtXnTOmx6ogEu7tm3blJ5//RL1opGPBwpFvoLmNxhz8Ru37+HMEAMG/O4uyrmcVC7adkPiP/8Gb4m/VA== +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"; + + + + + + + + + + +Updates a contractor's payment method. Note that creating a contractor +bank account will also update the contractor's payment method. + +scope: `contractor_payment_methods:write` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/put-v-1-contractors-contractor-uuid-address.ParamsDetails.json b/docs/api/put-v-1-contractors-contractor-uuid-address.ParamsDetails.json new file mode 100644 index 000000000..e23083315 --- /dev/null +++ b/docs/api/put-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/put-v-1-contractors-contractor-uuid-address.RequestSchema.json b/docs/api/put-v-1-contractors-contractor-uuid-address.RequestSchema.json new file mode 100644 index 000000000..06dd6993b --- /dev/null +++ b/docs/api/put-v-1-contractors-contractor-uuid-address.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"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"},{"type":"object","properties":{"street_1":{"type":"string"},"street_2":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"zip":{"type":"string"}}}]},"examples":{"Example":{"value":{"version":"fe75bd065ff48b91c35fe8ff842f986c","street_1":"300 3rd Street","street_2":null,"city":"San Francisco","state":"CA","zip":"94107"}}}}}}} \ No newline at end of file diff --git a/docs/api/put-v-1-contractors-contractor-uuid-address.StatusCodes.json b/docs/api/put-v-1-contractors-contractor-uuid-address.StatusCodes.json new file mode 100644 index 000000000..bfce3d167 --- /dev/null +++ b/docs/api/put-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"},"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/put-v-1-contractors-contractor-uuid-address.api.mdx b/docs/api/put-v-1-contractors-contractor-uuid-address.api.mdx new file mode 100644 index 000000000..678e620fa --- /dev/null +++ b/docs/api/put-v-1-contractors-contractor-uuid-address.api.mdx @@ -0,0 +1,75 @@ +--- +id: put-v-1-contractors-contractor-uuid-address +title: "Create or update a contractor's 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: "Create or update a contractor's address" +hide_title: true +hide_table_of_contents: true +api: eJztXFtvGzmW/ivc2od0AJUsyXc/LNbtJDvGIJ2gk0x24A7KVPGUxE4VWU2ybKsD/5F9mcf5e/sTFoeXuuliybEX6EEHaCSt4uXj4bnzkN+iu3hWaSNjLgzMFDVcitgsSojOriIopsAYsOjLIJIluK+XLDqLysrEN+M4lcIomhqpdOvfSVVxFlPGFGgdDSJDZxqHu2ha44gKdCmFBh2dfYsmoxH+xUCnipc4T3QWvb6jRZkDCS2jQYSzgDDYlpZlzlOLae9XjR2+RTqdQ0HxX24NkZz+CqmJBhHN83dZdHa1y5dS4aoNdxBvQGnupvENtVFczKJBD/bHOZC0UgqEIb4TkRkxcyBu6CH5AGD//8p/52JGZhVn8OWHuTGlPtvbYzLVQ7s3w1QWe2Ev4pIulMxz+32PMyhKaUCki5ckk4pwkUlVWKIQKchc3hIjSaVxOq5JxiFnw+j+fhAZbnJcxN8cAjrNIbofPEQEbRSAScYNFa4aMogqz93OUvZO5IvoLKO5hvtB6DbZsVvKzWLnmaiBHfv8zstdgclKGLUTNuSSjFa5ic6iTx/Oo/tBRFPDb1pgo6mUOVCxkqNwYZUOjJRLx/lDcincMPVPmszpDZApgCAMcjDABmRaGVLQBdGG57lrMOfaSMVTmhNGDSVUa5lyaoCRW27mOE0xjNrrMKqC+/v7L4MInGR2OSI6GE/IXzkoSj4YRW9AVCiyzd5HHypugOyfjqOwt9EHKsgbRUXKdSqjev+ii/PIb0x0ejAeHUctolv6NeSzsBqGPveK52Fm7qms7ST706fLV2EXmgEiR5eAoVF1cQMnUM3O/bqh4A3NK+homGiyvz/ZH50e0ZPR+BD2J+z0+PQwoywbZ2x/NGJeE3bAR6fHx6fHR8dpfDQ6OIgPTmAUT7Ojk5jCdP94ND2lEzhu9gM37PT09Bk2zO7XA9tl/wyig9HBstr/SRryRlaCkV8EIb8IpLqC3yrQyJsKtKxUCoRJ0ERIQ+COazMkb+lXILpSTrOWSt5wBsztF9fkhuacDX8RuBEHk8nytJ9EqWQKWqMqJK+F4WZRI+Dais+cliUIcjsHYWeZSrZAZljISgWMlisoF5qAUlJpoqt0Tqgm11xYEAk1RvFpZSCxW389IFLZ4cIIGeW5JqwCVN5UND1rK3zdsiGv3TQX1MBMKg56RyNiYcZp3f2lM0XWnhRSAWFgEBASbwcL/DB1/yRun7h9fYWYuQJmvTGLBC1LV4v53xvlRZWii2gQcQOFXuULLY2afAXs4FEu1sxhWz2oIz+UkPKMg8aN9MJouxOZppXSQ/JxUaLVyRfOJ/kKC8IZCON6Yft6D/dKqmgBBpABcmubjGyGHKIw16h3gIYjYFtkLzcSsV6bHypoD89lZKZkVXIx04QKRlIqyBTQqbJophXPGUmRDwrffk4Fy9Gn48Jxb8u7HpLLrJmIa3ItrGJL3D5eD1qOIrlFa+1ZnlDiWpJr35T4TVo4gw1OZbmPljQFytsMHqbM+7Bez42ETmVlWnsXkxkIUM2u+aEDMXSlMpo6glBBQDCkj/IoDEUPYxUrdmFcBOFWkMMNFcZ5JkYGBll4SfYmgAtiZRq9Xas2vEaa5jAkb6Qi3uIOOkNYfJZU1+7vBFFd270Nv6BJvXbknzbGBN0hKWBNuNBdS1HlhmP0YkdEOeoJXvh5WdjClx1Euju35mIWZsZulDGOn2j+vjUTGuKVczuCPMw1P9ECgivkKWrmtM02qVQueGOaGGm5oUXgh2f4JPhvFTTqQVm92cxnR3TaO1Oy2OCP1+2qMjFyc8OOnlvV4KEgox1fvfXcH3/mZh6/ExA74xfdr2/11vOOa4pbs8qZ/XPP/3h7jiOtNdhdOnxG5SNFvnAOLuEbzcaQXBr8uZRac3SxjHRhXq2HcriB3AaQ3owEQ1GrlSjlKq1yqn5wcGPr/MTvLMO97GQNVjRwDH0Xt6OcKRVfE5raUCBxwWhSiawSDFhS0kUBwnScmKuOrxFNqcv61CY+WnLWopaZi95UgnExewtmLhmZU03CbKSeze5BB9gNKJ4tEi4s66aItJSaPymyv6MbgLMSPytaToxepkDs/BzYkLzPgWog6RzSr85JQY/VwyG0wI5o2tctgeYYrS+SMOKzLgDJ6yd02YZ6HSsAFlyjhkqUrAyKzXpgvkUiqmIKajXEnpPfAfqz609cf5SJYHY9Ls8JSSpFxme6hlb7mjtRbbl3G8y5IbilhkgBpHFmi0qbtmOxGlhYbUa1CdKS5LzgZgPCFY13JuEbROzHIHYMoueyyhlipp6yNeakBMUla/CCYAnz2nINyrrJSmyraflaMPQHoSU5NoIycyrIPimkMHONPmFWmUqBw5fKoqQChZtV2qhFoiGHFLk7EZSnOkklg6RxzNYiblrvTs+fsC/BvivYcTuEfprnBxhYE36raI5W5IgwPuO12tkAVwcAegu4mqeu7e5oP/DUYtXLYA88WIfV8AISmWVJKXOeLhJBiy33ungUEYtV+9sHUQkrUcBqeaFpqiqaJ2qzzHSa7aC5z10/gv1qik1zVOXoWdV4iAXIQa8BXoI1rolPpGyyjr2uu6C9cMLNwOYLEbIbw8W4HgPBCYjMspDVWYcZijKXCwC9zbbXjXff+9ehK6EKtueAKc2pSCGpygf05XprvQnVBRU2Q0rZr3bb3Wx687bPZc4ZanX8zwEOboV1RJ/SK7pwyqR2I6xLQTwCtEB+89dDE9I8H6w6xWw96VXABqT0LpsC5FUpYC3U2jzWbPYsrHjp2pAwBMGwS7dyGBafFFNJFbrhod1T0i/IMDr8pJ6qhuQgLC3mCRF8tLlHrm2yx4alXHSywJhc7lk051YkYM9Ck9b5irSnX2ux9VvuLqb1AC7ea/wbh4VZgbVcjrrP4W0ENuB/Tj+2t8YVZk4bqqzfTjMD7kxqGy9gudfu9Htf+9UvVoz3ohHjJjVh85TEC8oNCONXEVKL2+LvtP8u5J2RHsQcWjchDR45JDMltcZ0R5hcgA0GNvk6vsXu7g7YGKH2KEJc0INkvRbckbms1DaO4eNM3V9w9JbkCJhRPG/sofEynqIdzJ9Q37x347cAuClq8ciU/B1E4nE8qabDrI+ffikk94dumFu4NNql0xuMzu1geEJGcwNqDdrEj7I5bv8u4FyTKaByqwGHo5YeVJtq5No6gB5sJQrJeMat2g6QQzbzKcGGE6NyabMdAEfJDsmdotSgbrwW1wttoKgbBR3e9w2sFtCJK+bZwk9w7b9HAXVHaqRaEJue9DgLeseLqujj1JUqKa75GaG+vksB0IvwGHAnxqORpWou5deq3ETLZwQWHK4QA9iSgx/0y2HUPftqznWuekn3OnyIernyMH9sS+rGk31cYUehTXOZfgVVG3+bdMMqsJ2YvzfaSmfYcoR3hDt5QC6IVAwU2idViSAe/eW7uZdxbl5PvTkaTFU+z6Ioa1xT/bjl9GBuXlMGDI9SE0PvnnNZ6BdaB9zPRwy9I3a+x61xGfYWrOhywq5I5MmX2WHDoLFCFvo7+LIDevUidaUxF7Fjin2bRXEsavGDt43gg0toIDnIupraVUmxtDV1zm6Ta77U/TGpunoQEgYh9eRNDBGtA9xY5e9F2zku69EvzOa1sU2h03SemLkCPZc5S8Abn6h1ftdHYJcFNdbdaRXogixg0zY3lOfUH+ahx5/fALG5+fOLv5CPARwJlrF1fiSltskINJKfuQJyKQbkrbwB8lFicZ0ir6g9jmwbzFaF885uUx2+hEF6Z0c2L0aNgaK0QSxWJVuXjtCmnqNC5kSXQ1Ymlllsv/sBQ5jJZ4IaqTC1R3m+XVqP8vwxKT3K83ag2wcQ4u6QHZtTndRfnz6b4k5z6wMP3Nx6NmLLgzygmg0UFLjj9ug8JA+aLlPIcDCsE0CiEwG3OGhw9PgdsIRxPa2UBnuY1Jxbr1lYu/UO0tfKLYRzq5XezwbZWzdEF4M0SYZ1pR3qvmqBtlJnmzgqPPPy2IhldDKZxJSNTuIDoMcxHR3R+Hh8fHRyku5Px8enGxYdRivsafdjfH93wOf61/bTaY0z8orjWTh55Q6fB+QCD6WHUZ8qAYWrT388Cl/f7lWf86jRtS+7KF94b9sd8b8YBh3WbO6mZI3N/W3DFWtqjm+p7vNIlHHB9TzxWU60rlhI4FyvZ8hJewK5GN9IlGxDmsl7OcFwKSCxQz/khdWl4Tvv4ltkHi7SvGKo0d1AhLZK8Tvi6kqUvm8OO0h/ZFels7vpxW5IWp8lvlVSzIiPvvtzYJH77mzuVDIIjLVDFu93XrpD1x9gOBuS8WT/4PDlChGbSwGProd4j71DNUQQ8vGoc1CKFQc5TzdlGlYKD6tcBTisO3psiY6/U6Jb5b1Nssod4fQC+G0S2Sthba4j+Ni+HtDUZNjdd/uCtdnOUw4ynsvbVnmD8feS1hY3NLH9o7MJOGWo5uszRDtH8DQT1Iv0lsz5sPphm+8bbm8O7Sze0Q5aCgVNb7B0+N32eVQEgjXBwIj9RF74Pi+amwRCkhJUwY0JrXSwKlOqefrM0Tm1ZX5Bfwdv0zoZu4WwAoDplh3yYeAK/yPQ7dYXh69Znf28M8E/Y1l40DMzeyyqvMuqmkKNUW2oltA9Y47eehLrk+S9nLNDgDl8YivTU0N0VZZSGcKsc5Qv+if8Xh2FNbgT0CfPQ/eKH1qQ/YW/3mnWpnIxrrRJHlfw8gb7EtEre1nSVszahyyZcmXmu8/yyp6rZ8R2r0Njb0Ft2YRzAK3O2e6Ytq4FfYwT75334wmFg6PxccwoPY0PgB3HJ4cwiscnwA7ZCOBk/3CDSrOnYY8ISvOckjfc/D7DVByzFb8UlTmGawQF1vLwvHcapgF9RBsi1kfNnggrAp0nptSEHU+zo0kaT+k0iw/oeBKfTE4n8f7BCCbsNKXTyckGSj1OC11qyumc/Agq56ImE9IlX1gS3frbK9tRKPjUILTzp+u8x+a6nfW1WhtLWL032ub0dtHlSiR1cCk21od2mj06WsPevYiR4BHsgHwG+IqpJmHm9urd34GuQh2SJrXufeJQKUy0SdvLlkG97xTwd24rxiuL3bvXeX8MjkJ9mfcP6zHcD6KfW3bjoQX9ixiQ+0H0U21BHlrzn6bkT1PyHaYk3H5fflzAJ0yQWzvdua6vmzIMVgsugKSg7L1QPNZrv/tR390shsS/PuDrUmcgMd1gNZ8vWET8PhGPySRhL9BbmuBVq1/EL0KnsoQzct167OXsVnED1/j1P8j//uN//klab7vYK6G2SMxmrNE4+GUNsTn+99ne1ewt0AFiA1ty4OnQ/BwugRVkuiD+JY0h+YTI7XFCi3j21qaCMqdpL/kdcOBLECHud1xi9dfZEsdhLsKqaKt3mrMGd41u6bUZfyVs5dauezdiUE/+3/F/2ad4zt9fxn+rT1EsgDlQZk1DA6F+VKQ90avAHO6KM25rjBaHkfP3l/VjNP2XPuwVZWyAt7Lt/WSBu8abotGBa9O68P9Ck6uCC1uI0Rp7x9vxtORx8wTOv/sB49bPLwPv46atIzhWTVQFXsqbjCaH8egoHh/ivdrmxZXW7/ahDh85/SiZTeT0d3brRw6e4PGg+i2V6PCIjUbp+Phkmh7vn+5PJ3QyOgJ2RE+OaJZOD/6gLw21bz0HOnxZ+QBR/HPbBdj1JaKW+C2/N9T62H1VqNOrc8Wz9aXzQlD9u8uvbP+qSwbHh1M2OjrMsoOT6ek43T/M4CTLTg4m2enJUdp9nGV/NCL7iuHTLACm8y4L3jjd/QWdYHbuYl0C/QpUL2JUPbG8AaU4w07OFJzXb3fBnQGhbYYPmdyZ0bVvhg3Cqttvh+FWhn7rJq479gCgqPrjLfvomFXcZh6dRXs3472WRdr71lPd93vNA2S2/M4r+krlqE8969OSO86PGRSW/Zdk7BUUSNU2djde7M7w8DMucc3AK8d8r+x53boxS/yMS9eQVsru8tW3EAucpxiXnFdIhasv7VYfUCs5PlzRtuZehBh0qX10CqiytqX/FoMdIrbXhgmtzBxzxaEmZhB9sIWM3zODG2HNBPeDCLXtz42ebstWLVJbqMyWSNU6t/XEUf2bF6dWGydH9Q9OlhqlEKrsgiKz1huNIbJz85RTY3kGEVpn/S77AOqGp9Dil0b9Wu9tzzbcY0gaVHqx/X8sidC+69JtcchTWVgnzuJ4oclrL4IkFCejnWYyrdATtWT+N/+eD3UnP94PeRVmJT/jmys+ve+qKJDh/df/bPgbd6uU2hRUtMa58FdiVFPp0QjpC00aAe0s5Vtjff/0if9ffWIvvgbuzF6ZU27l3Oq1b17tXkU3487bY7h7Z8tec9jaL3gRShvs+O0bOqKfVH5/jz//VgEGYFdfUPUrW7tttRzjNueyxsFt88YPwVl4STb412tWFV5eEIuW7Yn8MxBLYYC70eV88N1A/os75Ctp62i4OpqpSd14BReOWPHHjgex7Hc3PdDolGZj27bf8P7Tx2gQTb2rX0jr6Ch6i+EUvXX7Ho4xMRbA375FORWzyiUA3JD45/8AGLqQTQ== +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"; + + + + + + + + + + +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:write` + +> 🚧 Contractors can only have one address. +> +> When a contractor is created, an address is created for them by default. Updating the address will replace the existing address. + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/put-v-1-contractors-contractor-uuid-onboarding-status.ParamsDetails.json b/docs/api/put-v-1-contractors-contractor-uuid-onboarding-status.ParamsDetails.json new file mode 100644 index 000000000..e23083315 --- /dev/null +++ b/docs/api/put-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/put-v-1-contractors-contractor-uuid-onboarding-status.RequestSchema.json b/docs/api/put-v-1-contractors-contractor-uuid-onboarding-status.RequestSchema.json new file mode 100644 index 000000000..61a872bc1 --- /dev/null +++ b/docs/api/put-v-1-contractors-contractor-uuid-onboarding-status.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"onboarding_status":{"type":"string","description":"The updated onboarding status for the contractor","default":"onboarding_completed","enum":["admin_onboarding_incomplete","admin_onboarding_review","self_onboarding_not_invited","self_onboarding_invited","self_onboarding_started","self_onboarding_review","onboarding_completed"]}},"required":["onboarding_status"]}}}}} \ No newline at end of file diff --git a/docs/api/put-v-1-contractors-contractor-uuid-onboarding-status.StatusCodes.json b/docs/api/put-v-1-contractors-contractor-uuid-onboarding-status.StatusCodes.json new file mode 100644 index 000000000..1566726d5 --- /dev/null +++ b/docs/api/put-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"},"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/put-v-1-contractors-contractor-uuid-onboarding-status.api.mdx b/docs/api/put-v-1-contractors-contractor-uuid-onboarding-status.api.mdx new file mode 100644 index 000000000..74f799589 --- /dev/null +++ b/docs/api/put-v-1-contractors-contractor-uuid-onboarding-status.api.mdx @@ -0,0 +1,81 @@ +--- +id: put-v-1-contractors-contractor-uuid-onboarding-status +title: "Change the contractor's onboarding status" +description: "Updates a contractor's onboarding status." +sidebar_label: "Change the contractor's onboarding status" +hide_title: true +hide_table_of_contents: true +api: eJztXOtvGzmS/1d4fR+SAGq/kzj+dImT3Bq4TIw8dm7hGG2quyRx3E32kGzZmsT/+6KKZL/Uki3HPtwuEmA3EzVZ/LHIerLI79F1PK2MVbGQFqaaW6FkbBclREdnERRjyDLIovNRZPnU4G/HSlrNU6u0wZ81mFJJAyY6+h7t7ezgXxmYVIsSSUVH0btrXpQ5sNByKxpFqZIWpMXGvCxzkdK4238Y7PE9MukMCr5M6ssMyZQaDEhLXZiaMC5ZWoN6YpiSY8V1JuSUGcttZXBEN6VIjf+A1OK/hc3xh2Y68ce6X/yZ+kWj6DpenjdOu9SqBG2Fm3dViQz/9oMYq4WcRqMe+q9S/FkBExlIKyYCNJsozexMmBb+rehmFDUzSNwMbif+UQLyws6AfVvu/y1iIKuCzXleAfED/4nTajVNFa6ThSwaRTwrhExaHzXMBVwNfREydIxGkYF80v4olU2EnAtHtf919RdjuR7+4oGc99kEZZtLXGu+WGLS/whjkUvUmmn4sxIaMmZV2DOMd5ZiFAkLhaPr98vH9uaCcmBndbeG73fr3jCg44kWILN8wVrfwqKq7ri0Te6y6T7Tz8ubbphiYEmL7lipHLhcIvz7DCSzuoKR28JIg4mGq0Sv2VL3JDjjho0BUMI9pTbOAqS9fdVfs9yve2/K3S0whqmQzdDd1e/w+Ib+tLl15lQAbkpw6o66edWH/0mS1+iKaJw+f3m4v5fG2eE4jQ/2+cuYw6tX8T7f2d8/3JlMdvZfRoOa4BYJXBaKs2b3vuFGpCwDy0WO6s1BwR+T5sdmWrQa7UWc8NxAn/1n5zejZoh30oKm5QJpnI7ujdf+9mDDvs4yNAQ8yzSYeiieZUnz08+NcMoX+Ht/NqX7+cEm8llMJeMyYzy9lOoqh2wKLFNp5Vr7UY2YyqT9azOoH+PWUbvrPiLV3nCrg+m9yIFJuGIzockCK20DkonIIZFwleC3pP72s3ii85vzIGcHOwfLvsBvyrL3qpIZ+yYZ+yadb/BnBcZChs6GqnSKnAPDpLIMroWxW+wDvwRmKg2kA0ut5iKDjH39evIWtdec5yLb+iZRyRzs7S0P+1WWWqVgDB/nwN5JK+yiRiAMK/iCzXhZgmRXpNBmwMYqW6D6WahKB4xkZ7iQhoHWShtmqnTGuGEXQhKIhFurxbiykJDuuBgxr7gDhQnyiWUVoPbisumJ9oek62KLfQY307N3bphjbmGqtABz/nRmbWmOtrczlZot8gK3UlVsB68vLvlCqzyn79sEM07r7s/YtBIZkDkplIYgF8i8ezt4Q9z9xdw+c/seR9sOuQkvu6j+92Vb2bdxq6kml4AdPMrFijGo1e1uSQkpuiMGF9ILI3VnKk0rbbbYl0UpUp7nC2eSL2HRODGG2tdruF1yzQtAu6Mh59bZ85qk80QC6g2gIQVsi9vLUWKoZQKpoD38LmNTrapSyKkh9Z1yycbAKuO9i0rkGUtxHxS+/YzLLCfnTLrd2wrBttjJpBlIGHYhSbElbh0vRs6Fo7ViVyLPw5ZnnLmW7MI3ZX6RFuxK2BkDp7LcR2JNgfI2vYOTehrm63cj42NV2dbaxWwKEnSzap50YIap9ISnjiFcMpAZ8kd7FJZn3PKhrdiFcRyEW0MOc44mmVuONP0GWXhJ9iZASEYyja4IqQ2vkcY5bLH3SjPvso06JAgfserC/Z0gqgta2/AL+nIXjv3jxphskRcGHyfO9Vo7l6LKrcDomCiiHPUEL/y8LGzhywYi3R3bCDkNIy+c+Rf4ieenrZGcDzMwtmPI7bvmN17UoannqJ3x9rZJlXbJgcwwq2g3tBh8/8A6jEcUnfaeaFU0BM8airLKc/LfXbuqTKxa37Cj54YaoMMO65rcNGmID373x78LO4s/Soid8YtuVrf64PeOa4pLQz7brzX/l19ziiNXGexe1IzKR8l84RxcJtaajS12YvHnUhkj0MWyis34HFith3KYQ25w7bwZCYaiVitRKnRa5Vw/dXBjcn7ij7ThnkXtGQ40cBv6Om6HyWMuLxOepqqiOAqjhKSSk0pmkCU+vuo4MWcdXwMDB2g7JkfRkrMWtcxc9L6SGB9/ADtTGaUYwmisHo3WoANsDlpMFhRsaw0pIi2VEQ+K7B/oBuCozI+KlhOjlzEwGl9AtsVOc+AGWDqD9NI5KeixejiMF9gRTfuqKfBcA88WSaD4qBNA9voBXSannscAwEIYQ0k+VVkUm9XAfItEVsUY9DDEnpPfAfrJ9Weufy9xhbhCXJ8qORFTU0Orfc2NuLbcuw3mtWW4pJYpCaxxZovK2LZjMQwszHbCjQ3SkuSiEHYNwoHGG7PwPSL2NBjRYGamqjxDzNxztsaclKCFyhq8ILMk89pyBcq6ySC2YV6+kxn6g9CSHIqg7IxLts8KJe3MoE84qWylweHD5ASXKNxZZaxeJAZySClBJblITZKqDJMbTXZ0BeKm9eb8/A37Muw7sB3vhtAP8/gAw9aEPyueoxV5wTIxFbXaWQPXBADmDnAxI0RtN0f7WaSE1SyDPfBgHVYrCkjUZJKUKhfpIpG8uONaF/diYjG0vn0QlSSJgqyWF56muuJ5otfLTKfZBpr7tevHsF/NsXGOqhw9qxoPI4ACzArgJUh/TkNB1zrr2Ou6CdpjJ9wZ8NSKOUJ2NFyM6zEwHICpySRkdVZhhqLM1QLA3GXZ68abr/270JVxDXffAWOec5lCUpW36MvV1nodqmMuKUPKsz9o2d1oZv2yz1QuMtTq+D8HOLgV5Ig+pFd07JRJ7UaQS8E8ArRAfvFXQ8NjyEeDVaeYyZMeAjZipXfZNOBeVRJWQq3NY73NHmUrnrg2LJBgGHaZVg7jpnXCCg2ch+RfkGF0+Fk9VA3JQViazAMi+EK5R2Eo2UNhqZCdLDAml3sWzbkVCUjMHyXNaXGCQdgabP2Wm4tpTcDFe41/47BkJLC0y1H3ObyNwAb8j+nH9uY4YOboXB8J8IkFTbH+XbyA5V6b8++09qufDNB70ohxk5qgPCXzgjIHaf0sQmrxrvg77X8KeYfSrZhD6yakwSOHZKqVMZjuCINLoGBgna/jW2zu7gDFCLVHEeKCHiTyWnBFZqrSd3EM72fq/obUW5IjYcqtmPcZ5GU8RTuYP6C+OXX0WwDcELV4TLT6C2TicTyopsOsjx9+KST3h26YWzixxqXTG4zO7cjwhIznFvQKtImnsj5u/yngAotBULnVgMNRSw8qpRqFIQfQg61koTIxEaS2A+SQzXxIsOHEqFxabAfAcbLDcqcoDei51+JmYSwUdaOgw/u+AWkBk0yULvi6aL/b/mcUUJdSI9WSUXrS4yz4tSiqoo/TVLrkOOdHhPruOgVAL8JjwJXY3dkhruZKXVblOl4+IrDgcIUYgEoOnppnW1H37Ks51znrJd3r8CHq5crD+DH+M97d28cZdhTaOFfpJeja+FPSTciJ2mjz96gNOsO0I7wj3MkDCsmUzkCjfdKVDOLRn74bexnn+vnUi2PAVuXjTIpnjWtq7jedHsz1c5pAhkepieXXjzmtUJfD/HjM8mtG491vjsuw77AVXU7YFYk8+DQ72zBorJCF/ol92QE9PElTGcxFbJhiv8uksEoxEG8bwVun0EBykE01plkpubQ0dc5unWu+1P0+qbqaCAtEWD14E0NEqwA3Vvln0XaOy3r8C6N5bUwpdJ7OEjvTYGYqzxLwxidqnd/1EdC0oMa6Oa8CX3ALUNpmzkXO/WEeevz5HBjl5l8f/419CeBYsIyt8yOlDCUj0Ej+jqV9J3LEPqg5sC8Ki+s0e8vpOLJtMOegzaZiGvrW4Usg0js7orwYtxaKkoJYq7xLx3hTz1Hh5kSXQ1U2VpOYvnuCIcwUU8mt0pja4yK/W1qPi/w+KT0u8nag2wcQ4u6QHZtxk9RfHz6b4k5z6wMPXNx6NEblQR5QvQ00FLjidHQekgdNlzFMkBjWCSDTqQpUyeBUF+IasiQTZlxpQ5WcQXRWT6zdegPpa+UWwrnVoPezRvZWkehiUDaZYF1ph7tvW6BJ6qiJ48IjTy/bySZ8b28v5tnOYXwAWCm+84LHL3dfvjg8TPfHuy9frZl0oFbQafd9fH93wOf61/bTaY0j9lbgWTh76w6fR+wYD6W3oj5XAgoTLtbcE4XrH1Sf86jRtS+7KJ94b9sd8T/ZCjqsWdx1yRrK/d1lV6yoOb7ipr9HoomQwsxWVO0/fE7aM8jF+FahZNvW9YdeTjBXzotJiPRtXpixGsAmu5uv4gfcPEKmeZWhRneE6pr9/p5JXYnSz41BRPqUXZXO5qYXuyFrfZb4Sis5ZT767o/xlyjvsc2dSga6QxGyeH+J0h26PoWt6Rbb3ds/eP5sQMRmSsK96yFOsXeohghCvrvTOSjFioNcpOsyDYPCk1WuAhxWHT22RAeP7+wMTKu8t0lWuSOcXgB/l0T2IKz1dQRf2tcDmpoMWn23Llib7TzlIOO5umqVN1At17rihia2v3c2AYcM1Xz9DdHOETzMAPUkvSVzPqy53eb7hnc3hzSKd7SDlkJBM2ssHX6nPveKQLAmGDJ3Q5I98X2eNDcJpGIl6EJYG1qZYFXo4sojR+ecyvzq62vtuzObhbASIDMtO+TDwAH/I/DtyheHr5gdfd6Y4b9jWXjQM1M6FtXeZdVNocZObaiW0D1ijp48idVJ8l7O2SHAHD6jyvTUMlOVeA2KZeQc5Yv+Cb9XR2EO7gT0wfPQveKHFmQ3YNY7zVpXLia0scn9Cl7eY18me2UvS9oqI/swScZC29nmo7ylc/UJo+51aOwtKJVNOAeQdM7djmnrWtD7OPHeeX+5x+Hgxe7LOOP8VXwA2cv48DnsxLuHkD3PdgAO95+vUWl0GnaPoDTPOXsv7F9TTMVlVPHLUZljuMZQYGkPz3qnYQbQR+zcgQ6O9UCg88Cc2stejicv9tJ4zMeT+IDv7sWHe6/24v2DHdjLXqV8vHe4hlP300Inhgs+Y29A50LWbEK+5Ati0ZW/vXI3DgWfur7dWuc91tftrK7VWlvC6r3R9k5vF10OIqmDS7m2PrTT7N7RGvbuRYwMj2BH7HeAS0w1STujq3f/AD6EOiRNat37wKFSfUV5jbZXLYN60yng79xWjAeL3bv3wd8ER6G+Df4v6zHcjKJPLbtx24T+TQzIzSj6rbYgt835lyn5ZUp+wpSE2++19jqh5wYqG89346aTiXsMiJffjMCDKR/AuumSIB4tsQ6DatI1JED9dwyaS9u95zD6d5IwdKYL9f4GWDMMCa0f/H/j/6aHh16fnsR/r48DCMAMeEY6bukVge5Ab3FGhZD+ri5KaYyqM2OvT0/CkQDjxqhUUF0IpRfori02wOvFdNFWom0STfXjyLVp3Vx/YthZISRVFLRob3jNm5ci9j2FnP6nJxi3fn6GMPDOMKriVQxvXu/Z29l7Hu+8iHef4wXRDCa8yi1KQPP7zc350t05OlIxnb03+G7SN/lNmlSVcMQuWjvu6EoLCxf49Q1gfgArKOtHVnxypE+MpTMup3R5OJRnK5dGw2vP7hjTnWvRWywYbGNA7wzwGGY8nyzvJ0L4g712HX+wtNIaHY8lEWA//MnF0u/f5I+jeOlP97ejH+3/xhE/cH3ZlV1OR5aTlvSxH+xizVstF/h9zXtJF4SNndC/umNZ1Rnr1oGUvm2k5e9dFMcU5PZ3zMCEV5K5C4b13EIcn+j1p3U46Eh/ooaw+EelBqfrnpXyo7ynZP0a+RjCGigMTbSmzi6GHty6YD+8sgNj36iM0obLz8jc8UmN9Q9S3eNtMdTndRHgklyHe7ctLd9WRSseGAsabP1jRqufIfs/e2hsNDyD8/4DUMt8Pb/xd11NCfwSuFnEaPpiNQetRYYMd1xt3hSr352DawvSUM4U7bVzTFY+1TcKvmj7yT40taHfKgR1x1VI0Hj4k0PyPciVsLPoKNqe7263bML2954zcbM95IdQjaN3Qiqdo633BpSXwtnPOIOCjOjSPnwLhYq6DHX0YndQip9x1isID9I81XQouopmiZ+RCQbSSlNC/+x7CLhepxj8va6QH2fn7VafURidvA20reUNIQY7T0+jAdegBx68IBIx3c1mvLIzTMiHwqNR9JmqRX9mBEdhxQA3owiVzKdGPbXeNRt6oGxQYOjExhUchviZ/D90p3AfhqqStu8yitC/Mx8nn0HPRQqtVW1cLXqEZJsabmc4AdR2Mf0bq0OM77p0cR7yVBVUNEM4nhj2zssOC3Xa6OmFR7aIGf/hnzbi7hDMe7Jvw6jsEz4/4086XEEJbkv/9b+aXYg8LZWxBZctOsfkIfWU6ZBj1p/M98Y4/HLufjl3v5y7/3/OndfHFq7tdplzQYqbDNV3b1HPovlu1D7qQjE/Wg7RBxwNvEhoLJL4/h3j3686v7nBn/+sABMYZ+do6DXdfSADlgnKWa6Iq9vq5Okn7+M8Y2vC+hXzCy+XyEXL04j8MypL2Qd3I9KF/puB/DfPAwzy1vFwOIlSs7rxAY8ds+IvHX9xOZJoeqA/Udq1bdvO4enXL9EoGvvgpVDk32qODjT+P617KAPA6AZ/+x7lXE4rl0BzJPHPPwGKa8nc +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"; + + + + + + + + + + +Updates a contractor's onboarding status. + +scope: `contractors:write` + +Below is a list of valid onboarding status changes depending on the intended action to be performed on behalf of the contractor. + +| Action | current onboarding_status | new onboarding_status | +|:------------------|:------------:|----------:| +| Mark a contractor as self-onboarding | `admin_onboarding_incomplete` | `self_onboarding_not_invited` | +| Invite a contractor to self-onboard | `admin_onboarding_incomplete` or `self_onboarding_not_invited` | `self_onboarding_invited` | +| Cancel a contractor's self-onboarding | `self_onboarding_invited` or `self_onboarding_not_invited` | `admin_onboarding_incomplete` | +| Review a contractor's self-onboarded info | `self_onboarding_started` | `self_onboarding_review` | +| Finish a contractor's onboarding | `admin_onboarding_review` or `self_onboarding_review` | `onboarding_completed` | + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/put-v-1-contractors-contractor-uuid.ParamsDetails.json b/docs/api/put-v-1-contractors-contractor-uuid.ParamsDetails.json new file mode 100644 index 000000000..ef8002261 --- /dev/null +++ b/docs/api/put-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/put-v-1-contractors-contractor-uuid.RequestSchema.json b/docs/api/put-v-1-contractors-contractor-uuid.RequestSchema.json new file mode 100644 index 000000000..246d9c146 --- /dev/null +++ b/docs/api/put-v-1-contractors-contractor-uuid.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"required":true,"content":{"application/json":{"schema":{"description":"Request body for updating a contractor.","type":"object","allOf":[{"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"},{"type":"object","properties":{"type":{"type":"string","description":"The contractor type.","default":"Individual","enum":["Individual","Business"]},"wage_type":{"type":"string","description":"The contractor’s wage type.\n","enum":["Fixed","Hourly"]},"start_date":{"type":"string","description":"The day when the contractor will start working for the company.\n","example":"2020-01-11"},"hourly_rate":{"type":"string","description":"The contractor’s hourly rate. This attribute is required if the wage_type is `Hourly`.","example":"40.0"},"self_onboarding":{"type":"boolean","default":false,"description":"Whether the contractor or the payroll admin will complete onboarding in Gusto.\nSelf-onboarding is recommended so that contractors receive Gusto accounts.\nIf self_onboarding is true, then email is required."},"email":{"type":"string","description":"The contractor’s email address."},"first_name":{"type":"string","description":"The contractor’s first name.\nThis attribute is required for `Individual` contractors and will be ignored for `Business` contractors."},"last_name":{"type":"string","description":"The contractor’s last name.\nThis attribute is required for `Individual` contractors and will be ignored for `Business` contractors."},"middle_initial":{"type":"string","description":"The contractor’s middle initial.\nThis attribute is optional for `Individual` contractors and will be ignored for `Business` contractors."},"file_new_hire_report":{"type":"boolean","default":false,"description":"The boolean flag indicating whether Gusto will file a new hire report for the contractor.\nThis attribute is optional for `Individual` contractors and will be ignored for `Business` contractors."},"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.\nThis attribute is required for `Individual` contractors if `file_new_hire_report` is true and will be ignored for `Business` contractors."},"ssn":{"type":"string","pattern":"[0-9]{9}","description":"This attribute is optional for `Individual` contractors and will be ignored for `Business` contractors.\nSocial security number is needed to file the annual 1099 tax form."},"business_name":{"type":"string","description":"The name of the contractor business. This attribute is required for `Business` contractors and will be ignored for `Individual` contractors."},"ein":{"type":"string","description":"The employer identification number of the contractor business.\nThis attribute is optional for `Business` contractors and will be ignored for `Individual` contractors."},"is_active":{"type":"boolean","description":"The status of the contractor. If the contractor's start date is in the future, updating this field to true means we are setting the start date to today."}},"title":"Contractor-Body"}],"x-examples":{"update_individual_contractor":{"version":"b48c46abfed1487b873b442334b3c4ff","start_date":"2021-01-01","first_name":"Chanel","last_name":"Boyle","middle_initial":"X","wage_type":"Hourly","hourly_rate":"20.00","is_active":true},"update_business_contractor":{"version":"b48c46abfed1487b873b442334b3c4ff","start_date":"2020-01-11","business_name":"Contracting Solutions","ein":"991113334","wage_type":"Fixed","is_active":false}},"title":"Contractor-Update-Request-Body"}}}}} \ No newline at end of file diff --git a/docs/api/put-v-1-contractors-contractor-uuid.StatusCodes.json b/docs/api/put-v-1-contractors-contractor-uuid.StatusCodes.json new file mode 100644 index 000000000..5a28ab9c0 --- /dev/null +++ b/docs/api/put-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"}}}},"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/put-v-1-contractors-contractor-uuid.api.mdx b/docs/api/put-v-1-contractors-contractor-uuid.api.mdx new file mode 100644 index 000000000..e6a09fb23 --- /dev/null +++ b/docs/api/put-v-1-contractors-contractor-uuid.api.mdx @@ -0,0 +1,75 @@ +--- +id: put-v-1-contractors-contractor-uuid +title: "Update a contractor" +description: "Update a contractor." +sidebar_label: "Update a contractor" +hide_title: true +hide_table_of_contents: true +api: eJztXetyGzeWfhVs7w/bVWqapChS8o+pcXyZ0e4kcUX2JlO2iwK7D0nETaADoCUzLlXlNXZrpvbnvleeYB9h6xwAfWOTImV5ZmcqP2Yckbh8OMA5ODccfooMJIUWdh09efspeqZWOZfrp0kCxjwt7DJ68vb9zfujKAWTaJFboWT0JHqTp9wC4yxR0mqeWKV77+Q7+Tv2v//9X//DvudaCrl4J3+HH33PbbJkqrDsegmSJUsuF0IuGr0fGGbXObCH1MQuofYdE4bNhRRmCSlTcqa4ToVcPOqxixwSMRcJz7L1UTVwrSsNmnDJZsBSLhegVWGYETIB9ofCWMWulXxgmYZELaT4GRiXKZuLDJi9VsxAzjWudNA/OzNMzBHamhmxyrO1mxDYXKsVmxVGSDCGWcWETMWVSAueIU1MonJ4wi4rVObJtRYWLqOj6GO8QBSxkBYWmiN5Y8QcPXkbwWoGaQppdBTxPK83MdH7o8jyhcFmz6px8eMwojbXfBE9sbqAo0iDyZU0YKInn6Jhv4//NHf0oqAtnxdZdBQhVJAWW/E8z0RCsz7+0WDTT5FJlrDim2O8XgLTkGswIC11YWre2Gb2sKINU7qk2iMmpNuPXnQUOQJEavYjJDY6inKtctBWOPhFIVL817cyVgu5iNonFLG8eXP+HBG0j1NtKg08/VZma0eoG1w6McD0rrNQ744DDKs8U2tI2WzdOe81X8DUTbY5KchihVv9Unyk4/BHVehsHW2w5evGtA8Mw1GJB44YCLsEzd65Qd5FSP53fqR3US+6OYqEmfLEiqs6hplSGXBJK5/zIrPhSG3ObCy3hekg+LWwyzp5OglwBdoId75up3lSaA3SMt8pzOlOTI9dANDfb/33KBQWhUjh/cOltbl58vhxqhLTI07pJWr1OPBanPO1VllG3z8WKaxyZUEm60dsTkdnrvTKH23Jluoa+b0wOB1JKchSIuVtO3leskF0FH3luWCPDW3tZTVM2NAw1ruoxxDIXGhjp5KvanDeVnhkkWW3TfvrL/+JS9PGMhynx17jWrm1WswKC3i6NfxUCA0pEenXX/5S4fr1l7/WhjIkXq9FlqFAFgupap0C9FYXomfG72UVOMzfbxErkaYZTIUUVvDs81bixmJ+rK7lKOrNsy+2nCC877Iv2KVDUoQh99meLdB2rWYrCWg9IOSBq3gJKWiesRdOuGt2noK0pJGQiPimWM1AH7jO9r7d+zqX3Exba62kfPdiv18CSRwvwB+Y25b88MX5N49wNV4bIPquuPjMU09DMJ6mek/i3euhJ4FqLNd2iurvnldVXXxTZ4adO+9Av7A6jUolaG8aLdUKShJtaE/GagA7HXSB38DjGw93btqmCkXGxF7Db6HiRsufRb5Xu0QV0up9Zr/p6L0kZWiqt6CCj3yVZ/jRSb/Xv2Wz/VbggAwH3CnRnF3BSh0Qv/z1l7845ezXX/7aczd5BlMJ19Ol0DDVkCttD+FhxOfbsHnGF2SmINfKBRpmxN/eJEK2IBuIMwnXDCdkbkJikaYwQ2zXSn+YtrbzVv6+wPY4tYZNjdExZqJkWiQEEVus+I8KTVUvUYVmOHENk1Mv30mi9RXPCiJlYSB1tucCJGhejtdaHJHZG5iQblGC2yQtyBSuG6ZBEe4mVdVu6trdLka+leVd+W6z/7uIoVbplkscH5RMnq6EnNY6CIkkysAC2pTtbzVcCbiOjiID2bz+hVR2KuSVsGR8tL/d/g1Ju85vyqlqnwVoafT+5ijK+XoF0k5XYJeK9oLL9bdzclJsU6qfCw2JZc8hV0agzHy2hOQDDlf2oZO46c/YENR+euamL69NY+Qex+LcMRaYkq9ax3vJ8f5hFxff1IzRGxwm59rSupv25153Zd0QrUbqsEULmYJuznfna/mBqc8l5K12Xm2NVtjsUMWR+mxqVA0Y3fMKsxLG8Kx1d99hvWGk7Rd5kSdqhYfamf1tCh90qT8wLAzHquFYCpaLzBzh5cGZBpJjwjB0zqRFBukmsE1d4DBVptJewgZ0AKODbMAW+YZ824vU1LXlS+ie5qaxqwmXCWQZaaFTyMRCzLJtjowu1XbjPOUgSZpX2+39iH6mLgqTVkH38xeD43d6Dyw36Azc4iUMqgd+RaKGPIdew6EtqzRnVvWt/G9RcjZPBjw9jpNBfxKPYDKLOR8O4mGajmb9Pp/w/iRq+9Oi2WR0MplDEh/PJuN4dDybxWfJGOLxWZLw0fj09Gw0jBresODsamre0bA/HMb9QdwfRA3HlTvnpTMpGh+fnpxNxqej0xMYDk6TZH7KR6Oz2Wzcnw9GdDn5eRoumbrbJPp3pXH+mg8i+oOyNhMwizat+uhVtGEb43H3Bqb7z9IGm/PMQO1yCc611kUQnYyH4/7sOI2T48lJPBqcJPFsMuHx5CQ9O5tPBpPB2XFU2ljRBxCa967B2N+vkg8gfxbQU3oRbVMj3bR1NS56+aeooQ25Jh3qS/cl3rBmKqsjGg8H7N/QDfOdIl2jNDGip7ntseEpbqgzIaJnCq3rixyFholKg8FBI5sgOj7uj0+imuYfvbl4GrWV+Wjc7/VRZW+rFZs6Q/1OjF5gQAGglIjtq6vdoHXHuL3uvAzcV7eKL388dgsVanRT+RG3MOwk6Y9PzpJ4OODjeDQbQTybjJL4bHgyPJmM58n4NNlk2D4kIw5jiGF0PI5H434az8bHSXw24oPRSf84HYznLYYNXuo78esp57Pj/mQ+gFNIJ6en47PJ/PTsdHw8GvP5yclZxa+l17TJrY6wNV51H7S51H3aYtPoT3zGUwHxhdVqRdKZmDT64Yf4hx9+6PcJfcm7DnvJun6vAgv+qCS3XP7+A+is+AA99B1v5T/ft86ADuH9M+BgPDxhX0EquWbPQFrQHWw4Ou1XbPgKDb9nS64zZcl06OTDs5PR7Xx4Bzb0J9EzTI07258Epmyz1t+BFzEC4CVEjRdvSGUZ9UebobNvlGUvVSFTjBi6ONpPBRg0LDUYVegEWKrAMKksg4/C2B77mn8AZgpvPedaXYkUUmcGOPNXpL138u7xvBIUeycZ+1xc588fN6F1RPrqaglo7ZWVptbqP69UKa41x/tZWFjVP98+6vQDYAe00RZ4t3fPQa1uVYx9DNoZe37N1J2pJCnQa/h6nbsQtQsSfYA1E95pCobal16hxxhuXoEFzTRk5FewqhqSdOsS9QHQcARyLKm5H4mRkeGHCptkPPKFVkWOdy55Sb2qSV4Uq9isEFnKEjRaV779kss0Q+VUSLZWBcbJyli1i3yAMXyxh5nxKgDx5g3jM0wcqIgaex9OSU4/dEBpCj3niUPKJQOZInBN5oLTiOtKLno25njC6wfrbWP/I3/i6+flSa1jbXHRFga55o4/qEMvunlflw/fKBsTk8UvcNL4W3dqvawYDjfZ8o3MtcJgPZ9lwF5IK+zaiQ0kB1+zJc9zkKxMpZiplFxmtDUeHxkXXEi/5YaZIlkybtilkMSe0/JQTsmzdHnEvD8rjDCnDUoL8LQueyIn0d5f1kKxL9w0zxwNBZgDY7EEM07K7o9cRJe8bCulIZyYz5J43aR1su834gbi/ia1//mlNjufVxMJwy4lCbWp28fLo1q+hfPW+yNPIQMSf5e+KfObtHZ5IEBM5Rnj/83lgCgsT7nlXUexCeNZYG4NGVxxSS4xTolf7oCsPSd78S8kI57G8CiJDS+RZhn02Eulmb+RjhpDED4i1aX7l8yrS9rb8AlqxpdlsCRoWj2y26HpLN+yllWRWZFn4OZCPmoxXvh4k9nCNwewdHNuI+QizLx25opw0dtXtZm6HJc1gtx+ar6ppRp4itolrx+bRGmXIJdi+p7LBagIfPsMb6T4CSNNQTzoMvTjhqERnfTGXMEdDtGyXZFPrdrdsCHnuhrcFo+rayFf+9Mffy/sMv5WQuwuP+dl7W71tT87riluTS3Q8tue/wPvOY609cJu+atR+CiZrZ31h9GIHddGj51bygpRxqC9jBJvya+AlXIogyvIyPHvr5FwUZRiJUqEToqM64cObkNvfhTVV9jRIOqwAmZcfpjyhFwX0xTQfTIt5BzDZOnUuyrMDgthxg00zYMNZa1hJrwsyJX/NTk/KBgYZmPlbLQHDWBXoMV8TTFcjc6SaeqcJfeJ7M+oBuCszM+KNyeaLjNgNL+AtMdeZcANsASjq05JQY3Vw2F8hR1Nb/sSeIaRivU0jPhFF0CxVjchmwHIah0dANEBRPFpVWCSwC6r0LWYSsp36obYUvIbQL9z/ZnrX88G8biCiyxRci4WpoRW6poHUW2zdx3MU8twSy1TElilzK4KY+uKRTewsNo5ulzDl5lYCbsDYUfjg0n4EhGHQD2NwcxSFVmKmLmnbIl5moMWKq3wgkzL2OcWlGWTTmzdtHwhUxcirTiHLCi75JIds5WSdmlQJ5wXttDg8AWnu5BpYaxeTw1kkJBrUXKRmGmiUnQWB8VsK+Kq9eH0/Ab7MuzbcRz3Q+in+fIAw9GEnzBAaRUbs1QsRCl2dsA1AYDZA64RiWt7ONoLkRBWswl25ME6rFasYKrm82muMpGsKRax316v7kTEVdf+tkEUkjgK0pJfeJLogmdletwWVI1mB0jup64fJcuVFJtlKMpRsyrxMAIowGwB7uPkU+9I2XU7troegvaZY+4UKI6FkN0YzsYNsXqcgKn5PHh1tmH2j0PA7LPtZePD9/5F6Mq4hv1PwIxnGOyYulS3O93Wu1A945Lcozz9kbbdzWZ2b/tSZSJFqY7/c4CDWkGK6H1qRf5RXKlGkErBPAK8gfzmb4eG7uIvBquMv5Am3QXsiOVeZdNA2TsStkItr8fymH2Ro3ju2oR3UcDQ7DI1HwbhK6OfJZz7pF/gYVT4WTlVCclB2FjMPSJ4Tb5HQcmAziz1CXTBC4zO5daN5tSKKUj0H02rFKGposyfrdjaLQ9n0yqHkOy9Sr9xWFz6PJ1y9wgT8VYMG/B/ST22tcaOa45yEnAAPregydbfRwvY7HU4/V6VevWDjvEeVGxcuSbIT8k8o1y5rLf3lGPmXIv74m+0/yzkjZFuxRxaVyYNhhymC62MQXdHmFwCGQO7dB3f4nB1B8hGKDWKYBe0IJHWgjuC6Qr7KIZ3u+owl83UOEfCgmMeTAuN53GXYnCP8uaVG78GwE1Rssdcq59BTj2Oe5V0gpKqafoNk9wH3dC3cG6Nc6dXGMsMe814ZkFvQTv1o+y22z8LuDBsBijcSsAh1NKCSq5GYUgB9GALuVKpmAsS2wFy8GbeJ9gQMco3NtsBcJRskNwJSgP6yktxszYWVmWjIMPbugFJATN1b2L30BNc+88RQM2RKq6WjNyTHueKfxSrYtXGaQqdc1zzF4T64mMCgFqEx4A7Mej3iaqZUh+KfBctvyCwoHAFG4DyhB6aR72oGfuq4jpvW0730nyIWr7yMH+Mf8aD4TGlONQF2ixTyQfQ5eVPTjdKiDvk8LdG61SG6UR4RbjhBxSSKZ1iZrViupCBPdrLd3Nv4ty9nnJzKHv9yyyKp5Vqau62nBbM3Wuau8etU8s/fsllhYRF5udjln/0jwDutMZN2HscRecTdkki977MxjEMEit4oT/jXDZAdy/SFAZ9EQe62PdZFL40CYPXL8Fbl1BBcpBNMaNVKbmxNaXPbpdqvtH9Lq66chAWBmHl5JUNEW0DXN3Kn4u2ES5r0S/M5qUxudB5spzapQazVFk6BX/5RLX4XRsBLQtKrIfTKtAFjwC5ba64yLgP5qHGn10BI9/802d/ZK8DOBZuxlr8SClDzgi8JL/HVy3n8oh9ra6AvVaYearZc07hyPqFWSsUcrDaVJovYZBW7Ij8YtxaWOXukajyKh09sfL5HJgzvkCVQxU2VvOYvvcDBjNTLCS3SqNrj4tsP7cepo3fwaWHL+LFxiEtAQS7O3jHKF09fHv/3hQXzS0DHri55WyM0oPC48BwDDSscMcpdB6cB1WXGcxxMMwToJJR+GRXyaBUr/CpwTQVZlZoAxRMquLWWxZWb30A99V8CyFu1an97OC9bUPskVn6vAa6lUt69IWXl/bTOR8OhzFP+6fxCPgk5v0xjyeDyfj0NDmeDSZnOxbdSvW/g+5ff4lb3p9OajxhzYcDR4ye/PaiNlUCCv9k4s4o/LtEL/qcRo2qffO9MHvgtW0X4n/QCzLs75VvjM9OsIDalsfg9++T9gRyNr5VyNm29kS+5RPMlNNipjT0bVpY+Zbl4F38Gg+PkElWpCjR3UChVsbGmUlcitLnzUGDtEd2WTqHX71UMEGY4CW+1koumLe+23Pgs5zDj7kTyfQqqPTi/SxyF3R9CL1Fjw2Gx6OTRx0stlQS7pwP8Qp7h2yIwOSDfiNQihkHmUh2eRo6mSctXAY4bAs91ljHlyoztfTeylnlQjgtA34fR3YnrN15BK/rb2eqnAzafbcvmJvtNOXA45m6rqU3WF+HZWtyQ2Xb39mbgFOGbL72gaj7CO5ngnKR/iZzOqy5/c73Dfe/DmkWr2gHKYWMZnbcdPg99bmTBYI5wZD6oiUPfJ8H1UsCqVgOeiWsDa1MuFVm3IjkC1vnnNL8yhInXtskJeMwE1YCpKZ2D3kzsEP/CHS79snhW1ZHXx9M8O8xLTzImQWFRbVXWXWVqNEvL6oNdF/QR0+axHYnecvnXJUAoHe/PLHMFDkV60lJOcrW7Qi/F0dhDS4Ceu9+6FbyQw2ymzBtRbN2pYtVD3wPTxMrKxc2zaS23kz3w3w6E9ouD5/lua+KQd1L09jfoJQ24RRAkjn7hWnLXNC7KPFeeZ8MOYzGg0mccn4WjyCdxKcn0I8Hp5CepH2A0+OTHSKNomF3MEqzjLOXwv68QFdcShm/HIU5mmuuKCme4WUrGmYAdcRmwVhPhA5D554pNUwns/l4mMQzPpvHIz4YxqfDs2F8POrDMD1L+Gx4uoNSd5NC54YLvmRfgc6ELMnky4ZRhTr/emU/CgWdGqRx+nTp99idt7M9V2tnCqvXRusnvZ502YmkNC7lzvzQRrM7W2vYu2UxMgzBHrHvAT6gq0naJT29+zPwLtTBaVLK3ns2lcJEu6S9ql2ozaejjdeK8ZZkd+xQAjjHk54XNr4axLXKhnGbHdCT7DVOt1BfH+GHmIpVxU9fncf/UbrQqETCEnjqSgmUbyu31eka9ocncX8cD05cCSBfV7j++U37ncFzxLLCYg2uvhW3ECPFU/b01XlZB5gboxJBIVjS5OlZGzbAl3z0pk3iMRBVotGRa1N7JPrAsLcrISl4Vxv7wBeVPBdxVX34X/2Ace3jR6E0nTOlPIU3d4Kom3O6lPatcd14xeVe02zblpsbXw4IjP1KpWQxtPve8TXtd7UsJpfNh77Udun3rjoAPMu2PF9rPgraUTS6Vq1xnPb7yWByOksmx2fHsyEf9seQjvnpmM+T2egfscL0TfOZXqDD+0o4ePYk0fBdXenZTdH93lc1K5RRykGvXiK8WUzplqLXt1U/v7XMZlnl3D1P3lYt/Q7FWzGNsusXCejJpSuHhiVbhHPDtIpQNg7hsD/sY/2bwWCjKModVvw5hUUvHT0uew18IyxperNRqbGGrqMSvK+Isk8Fs/C+PWSlUPXJ8HLY25g1+7Isi/hOXkA2j+tfGfq1htXKxR6Nck/76rV9NSQgrsIvPPjQKz5eP5+z1gJxOBJyiE76AsPNvMGNysUHbFSzYPG2guwHDFirw+6LEmwvkn1ZMdzlXrWPLwNTNppvK8B+AOqq7vrfFPS2gusHIG/VWe+C36g5fZ/wd1f83Zshv1Th378tMf5JSgzf/fyLObvsOhGXQYTdharNgrYlNXOMgWuk4Nt+fPb+09lNB6/8Tbb+nbxAjT5j4WeKai8mpcu0s8r/YA/W5JASXXf4cz2USITK1K4fK9glCT73Nwq6V7SdAFsotvnbBLtAQ6jLL5p1+eWtP0VwOzff43pu+6mZfX9bhmy6jVqptUK1VbTMvbc8qoyQSqGmci3IQSvg0rBroDwQA7Zk49qI2FallGvaWeYtJivqZqOgqkskmVY/gFR7vNGwZaLZ6DQZjflsDulgdDqZnU6OZ6PR8Ph4NDtORvN5R23FQVlbsVG59NmSS8hatUu/UusMugqX/rCt8mqzht/QF/FrVXGksse0xJLX7nGBQXnerNkYKI9bdaGyIkR6XOXGs7PBYHB8fDzaUqSytogdpfti94Nnsbdo/Rb7UgImB/4BuFnHiChWV6C1SHEA/2AO9WwL0hAwNGqdw2jrb39RQYji9t8AQ2uuOZT70a+yv9uWqtE2pGWHgBhPb1mbMS+suxKW0ZPo8dXgcY2ZH39qOSxuqNq7vgqOo0LjyQo2Mc+FM4njFFZkF29w+3NYqahJVjde7LJR8Gtc05aBO8d8pSnzZNuYOX6NSw53zAU6NBzXdvwgXimwcPLg8CIBBlyTC6xdL4iGiKm0BeMFGhq2zNs8ii4o2f5zZnAjbJng5ihCR813lYvnRbD66jy5h5ekq1DyPoVfK95tCpKR+xmNDZOzVUi1vO0aoq38tC7ayg83ZFttkD3rr1ZdSEmq/mwLoMrlJBrtNuVjyHgPAsZp3U9fnUf1Erg1N+hRhF5P8+38AvSVSKB24ivPElXBekwNH6d4BNCfE9PfmJ5ofNcNOx2yBH8qxiqn/dOP+jhpw8JDIfR/piopVuEH/f7F19bjLgvDU+B5mJV9BxkvBbDfvxLT7ysOxVOZK2OxyG41TsfPSrZhf6qckb/9CuV9/Qql518LH+3jPOOCxBIJ2E9e7r+NrgZRPQ6OG/yk7ax+jxxuLDb/9Am98290dnODH/9UAIZE3r7Hq0bTIyi6HlJBwYu023Stb/bD4MR8xHb6vTvXEkoYyXXtrot8PaUNn7t7Gu3iGYeB/KeOUmyhraNhd2SoJHWlhTxzxIpfNzSdzbhC1QNvxtzubFtXV169eY1C2ocyVoo0Mc2x2Dz+P+17yAfCWAd+9inKuFwULjDnhkQJxZu3cXn7+v+oxSeaJ+vTJ9fitfoA8uamPGgW/6Yg3s3/AQGi7eM= +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"; + + + + + + + + + + +Update a contractor. + +> 🚧 Warning +> +> Watch out when changing a contractor's type (when the contractor is finished onboarding). Specifically, changing contractor type can be dangerous since Gusto won't recognize and file two separate 1099s if they simply change from business to individual + +scope: `contractors:write` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/put-v-1-employee-benefits-employee-benefit-id.ParamsDetails.json b/docs/api/put-v-1-employee-benefits-employee-benefit-id.ParamsDetails.json new file mode 100644 index 000000000..c6d58d248 --- /dev/null +++ b/docs/api/put-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/put-v-1-employee-benefits-employee-benefit-id.RequestSchema.json b/docs/api/put-v-1-employee-benefits-employee-benefit-id.RequestSchema.json new file mode 100644 index 000000000..52946cf78 --- /dev/null +++ b/docs/api/put-v-1-employee-benefits-employee-benefit-id.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"required":true,"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."},"active":{"type":"boolean","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","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."},"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."},"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 size of the company contribution corresponds to the size of the employee deduction relative to a tiered matching scheme.","enum":["amount","percentage","tiered"]},"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","description":"For the `amount` and `percentage` contribution types, the value of the corresponding amount or percentage."},{"type":"array","description":"For `tiered` contribution types, an array of tiers.","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."}}}}]}}},"elective":{"type":"boolean","description":"Whether the company contribution is elective (aka \"matching\"). For `tiered`, `elective_amount`, and `elective_percentage` contribution types this is ignored and assumed to be `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\ntheir limit.\n\n`Family` or `Individual`: Applicable to HSA benefit.\n\n`Joint Filing or Single` or `Married and Filing Separately`: Applicable to Dependent Care FSA benefit.","enum":["Family","Individual","Joint Filing or Single","Married and Filing Separately"]},"catch_up":{"type":"boolean","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."},"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","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.","deprecated":true},"contribute_as_percentage":{"type":"boolean","default":false,"description":"Whether the company contribution amount should be treated as a percentage to be deducted from each payroll.","deprecated":true}},"required":["version"]},"examples":{"Example":{"value":{"version":"09j3d29jqdpj92109j9j2d90dq","employee_deduction":"250.00"}}}}}}} \ No newline at end of file diff --git a/docs/api/put-v-1-employee-benefits-employee-benefit-id.StatusCodes.json b/docs/api/put-v-1-employee-benefits-employee-benefit-id.StatusCodes.json new file mode 100644 index 000000000..bb27eaf8d --- /dev/null +++ b/docs/api/put-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"},"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/put-v-1-employee-benefits-employee-benefit-id.api.mdx b/docs/api/put-v-1-employee-benefits-employee-benefit-id.api.mdx new file mode 100644 index 000000000..f5d52ded7 --- /dev/null +++ b/docs/api/put-v-1-employee-benefits-employee-benefit-id.api.mdx @@ -0,0 +1,73 @@ +--- +id: put-v-1-employee-benefits-employee-benefit-id +title: "Update 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: "Update an employee benefit" +hide_title: true +hide_table_of_contents: true +api: eJztXetuG7mSfhVuLw6SAGpHli+x/GszuezxYmcmmCQ7exAHbaq7JDFpkR2SbUcTGNjX2NfbJ1lUkeybWrLk2GfmzPEAgyQSLx+LxapiVbH0Lfoaz0pjVSykhZnmVigZ22UB0emHCBYTyDLIokHEi6LZxEQfB5HlM4PNXi2KXC0B2A8gYSosfanBFEoaMNHpt2g0HOIfGZhUiwIHiE6jV1/5osiBhZbRIEqVtCAttuVFkYuUJnv6yWCHb5FJ57DgqyO9m+MohQYD0lIXpqaMSwYB2cQh24sGkVtcpCafILX4b2Fz/CCsIvariAbR1xgcRlqEx4t/vQRt3NTD8aeDbDT+9CUrPo1H+8Pxp/GnUTYeZl+iQRSmT8pSZNFp9Oxg9OxwfDyKjw9SiA/hKI0nxyfjeD+bnmSH2XQ4nh4SFRYFl8vEgw69jw7h4Fk6ehYfHsBxfMjhKOZHk1EMo/HJ+IjvHxxMkIY8teISolOrSxhEvi+M91N+cnQc8/H+UXx4cDCOx5P9k3g0no7T7Ph4MjzYbwLOICtTT9394XBvOGzgwl3SYlJ2v1/tnXApS54nC/5VLMpFdIqcsH6wDc1zsRA2UX7HZZnnyGJWaFiAtEmuuExEBtKKqQAdWjggCTdJATpF5phBdDrluQHHbDQzrGvAbTpPyqLR4xI0n0HCF6pENm3Ogvg1/g1MYvlXPskhETJVCwjtqu6G51wvk0WZW1HkhDeqyNKk7bfArX7CQXTJ8xJqol8PIsjB77hHCdOp+yTJuAUi4ugoHu7HQ9rir4VwZ9h/jdiuB9E7ARoy9k/P5H9vJt7Mor8DB9b85Ii7hiMt8UvNkd/oE9QH3yLt+I5oihJ2rsHMVY57NGp/kmSQW+4/vx5UXY9Wex6t6XmAPT9eX9+O8a8HEc/zn6eEu61VdtAV8Q/cQPxzaFZoVYC2wumN6hxVtDNWCzmLBj1qLC21BmmZ74R6zM6BOQR77C0A/fuD/17IGZuVIoOPj+fWFub06dNMpWaPdPpeqhZPgw6PC77UKs/p+6cig0WhLMh0+YRNlWZCTpVeeN0p2VxdMatYaXA6YdhUQJ7tobgJJ69azESpHLik1Ux5mdvAOO3F/ToHOwdN6LtqmQnD3Lg0Rd8B7aOdny0w7iox3SHBhUyAucEgG7ACNCv4Ev8UKhuwqVaLFq5HBr8nLP3Hc9Pi/UndYvXV8gJQM1dlniFYq4FbyBg3jLN65s5SHHLg6Zz53V1DvxWZFBbwoaYnHgc03FbJ6HttAI4UXQLXe+w5w3EYCQVmxEyiPjZMKkbCj/CtkSjVKWsjeC4999cmHnI9UhI7Mi4zP50/K14os+Y0eyun0k261ZHsGY+RKQp75/JcnnvtfB6dst72gJs4FV9xP2t6hR1jZ1MWZC4eBDo8fiGNCYVhC9QGQs4GLFN5znU8VTp2f/VAak7ZDKbBUZ5oHk0PQH9M7hSnUx5rMeI4l1wj4/A0VTqjDVc0mRG/VaBXGZL4q9JI7b18rdz5u3BrvCDOuahJcdEGgIxh3AI77KXdjYVQeXop3aApLbKaza21Z/AB3lC41nxJQ6P2RDZVErw6arMmasfuSemwtFPAtdGIY6+wdDSIhIWF2eLkMSPkLAfCRjcq5hZT7XA4BitQnBrf5nS1WbFHxFwJOxfSqSECsu6MsyuR5w4asUHDeLgJyNsCUieocPCyQPYnecUeC5nmpRGX8KTn1FRw25s757aBl26yOLQixnhPOtVDQ67OYCokODGOHR4ZBjJjhRLSDmj5jjn8QBlLy0WZczyH+dKpgOFfWFlccZ2Zivf8zfUU/33m0E6FNtZhmpNiqWGoKTuPDs6jgTsUuH0X7sP94RA/bhK9pjPbHw7/0tq3JiFMAxwuFIcmctLJOaCOQQo2YEr4ugnl0XlEI3GGKP1nmzAeOYg9yPhEXQIC6cN31MLXYqhge27D38ZCgeNnYjoFDTJFq8deATRY+pFpLBJRkETWcClUudpij53Jzn4O3FjCMPhSikuegzN76j7RNf338fq6dWXsNWTWGS69hw7nDFrhMf/MK9nwZI8hH9bCfo14dbh5fsWXTqnsrVhT11vetG5l1fSu6lZ2Tft6tzWYt2pRWcKGadxBDYxnmcAGPG/Z5iQvLOgFigw7B+EFFR2gi9d8IfKl12xnMhOXIit5fsE4jug8apOczMi/vn1eecWo73+gvGGvRY7MrzR7S7Lfj/Uj1xpFD/7DN3kLBccTSPOtDP8SCpDoj2Ev8MvXjdnIBKwutjWZahas6bSzTe1NaLy48DDjI8PO3YysLM4jkht77GeZL9kvys7Z4XD/M62M/lLtRHX5cZuOt6QwjWF4kWZHQ1rMJj/UTSLirGpLE3DE8PjzE4YDMW6Q0yBjkyWt0n9XaHUpMtDOlu44BHY6A+GC5BRWg4x4KKUpUddPld5jPykLp/1HJeVSKovXEm+dM4HC1sEKMwjDDNjGjWqTr2LjEsKlr5QG0GQBiSf/Q/XvNYMOokyBSaSyftpugxX63HBl8/MwPwxzw+DBkcp67rrkuSACsn/XqizYO9AL9p9iWh/3QNmrOciGqSlQslh27laFuq1LUGTX6jPnzWG1N4cOpJhJpSHba7FJj+NnK3KvvWOvAEOV7YdfsZMeGY/VE6ghM7ahUs1qBtaxGc+Nqnit32P9/b6EgoseP4I/pX7SPfau8pw4cwSx86IA7s66t6VXtaJTgIWGFH0Azp1yvclf/V3uiD4aBT23pT+Co4MJ/95yRdz1+rvuvdVtdGoyOo2oQd8u4hf9LihCaCzXjnNWvIUbTsl3T0uTQcfIEDLD+Je/k7TaIyF9H7TrbrwYdlz025it79+fvVy55VjFruYCrykNRBPIlZzRpmngGZ7rBsv2Ofl3nT+onUYQb2Wm71zZ+qGvrymYSUZZRooGZ/pILNIfGwzeh9vFT8bDk/3RwXC8fzIaHoxPHgIlf9hAya6huus6ygYb2aVi3m5o7WQ6nh5Mj0/ik2l2EB+Ox1nMM3gWH/Lh0QiOjg/Hh/DHC61VKnXD/m3DTBVZbh+ROrptPOrgNuGobmB2u0NQLbN9CBrLv5HXm+LvJn6vDOebWd65EAbR4fBw1bv6k7LstSplxs4lY+fS5WR8KcGg3aDBqFKnwNAK9/pLGLvHfuSfgeFFw/s86GaTOSHtrl4i2zuXqJIPR6PVad/LQqsUjCEj8pW0wi4rBOSLXrI5Gh2ytrEnKiOX61KVOmAkM4QLaRhorbRhpkznaO5cCEkgEm6D9UX8dTFg3sMbRphykRuWleB8SXVPVMVkSlw0Aniv3DQvuIWZQlf3jhE8ghmnVfcnLg5IltVCabyqWASExLt1Yk0fdR+I2yVu1/hqWgtuwWgldkwy9/mqs36tb35l1OQzLJ04QJTLNXNQqx0c4Fdz8IeRujOVpqU2e+zdshApz/Ol84l8hiWr/BzORK328Ck6hhbopWIacro3+OANDRkcQA71jr55Cvmhw5lGcuEjP1SQHp7L2Axvk0LOjLssc4lXldI4NJNS5OhJNxYjqNR+zmVGni0hHfc28t0o+lVNJAy7kCTYErePF4NGlN7Z6J7lGWeuJbvwTZnfpKVz7YMTWe5LIs0Cz9tsi/DJm7Bez43ozy5tY+9iNgMJut41P3Qghin1lKeOIJgtJ8lxpj0KyzPe8nKvCRO9CIdbQw6XXFq87nAc0zPI0p9krwKEZHSmKWSDYqP2AjiXsbeOBq0hCB+R6sL9mSAq7570n6CxcuHIP6mVSW9Qbc1aKscFjYjnqHPwwserhy18s8ORbs/tg21uLWiIVR7gN42ZnFnWM7cjyM1c8xNf1H4ZR9Ha/0dsU0c4KWhF1+GawDfP8F6KL3iBbbs26/lCkFZkCYZhNtytq3ZlkVi1uWFLzvU1MHbzRR5Nm5Dg86Pn/vhXYefxzxJip/ycFd/f6kfPO64pbk3fzfxhz//x9pxu++sUdsezhsJHoW+TDFxyUq5XG3vsjJyWhTJG+MjJnF9C7UDN4RJyg3vn1UhQFJVYiVKh0zLn+rGDG5Px45PRnkTNFfY0cAzdTnSecPk5wcSLUlq814CFpJTTUmaQJQVfYqSjZcR8aNka0YS7ZO5KxUcrxlrUUHPR65JyKX4EO1cZBX3DbKyajfagBewStJgu6R6jNaSItFBG3Cmyv6EZgLMyP2vDBU3zC8j22JscuAGWziH97IwUtFg9HO84RtW+bgk8R5/TMgkj3usCKKbuJmQTjEJX6+gBuBAGJVSiVYlJVxuA+RaJLBcT0P0QO0Z+C+gvrj9z/fFMBLXrcXlOwMvzVMxMBa2yNXei2mrvJpjnluGWWqYk+vqDMbsojW0aFv3Awmqn3NhwWhK6y29A2NN4ZxK+RsR+DJ+9UjvwuadshTlxUYsaL8iscnWvQVk16cXWT8tXMnPu7/rk0A3KzrlkB2yhpJ1jsJFNS1tqcPiCp0TIrDRWLxPjnClKJpKL1CSpyiCpDbO1iOvWu9PzJ+zLsG8PO26H0E9z/wADa8KXkueoRY5ZJmaiEjsb4JoAwGwB14jUtd0d7VuRElazCvbQg3VYrVhAoqbTpFC5SJeJ5Ist93pxKyIu+va3C6KUdKIgq84LT1ONnju9+cy0mu0guZ+7fi7JKVBskqMoR8uqwsMIoACzBjimYZAId46UTdqx03UXtC/c4c6AvMcI2Y3h7rgeA8MJmJpOg1dnHeYqzWKbba8a7773r6p0DoyXb80BE55zmUJSFjfIy/XaehOqF1y6UGn2ibbdzWY2b/tc5SJDqY7/O8DBrCBD9C6tohc+HhfMCJem5xG4iDghWA8N0zDuDVblYiZLug/YgBXeZKOwNqr5tVAr9Vix2b2w4plrU0ck8dplGj4MwqfkRHGNZnhod5f0C2cYDX5WTVVBchBWFnOHCN6R7xGTOKS/lgrZ8gKjc7mj0ZxZkYCkqAaFVnhqlU4UxXDXYuu23P2YVgO4+15t3zgsLvGHuBxln8NbH9iA/z7t2M4ae9QcJTzgAHxqQdNdfxsrYLXX7vR7U9nVj3rGe1Qf49o1QX5Kn1UFlyCtX0VwLW6Lv9X+u5C3RroRc2hdX2kw5JDMtDIG3R1hcgl0Gdhk6/gWu5s7QHeEyqII94IOJLJacEfmqtTbGIa3U3V/xdEbJ0fCjPtnYE00/oynqAfzO5Q3b/wLlxqAm6I6HlOtfgOZeBx3KumEqR7YrFzJfdANfQtn1jh3eo3RmR0ZRsh4bkGvQZv4UTbf278LuDBsAijcKsAh1NKBWr+HWIS9LeVCZWIqSGwHyMGbeZdgQ8SoWNlsB8BRskVyJygN6Esvxc3SWFhUjYIM79oGJAVMEvLBbrQTXPvvEUDtkepT7R8WeZw+uaCL05S64Ljme4T66msKkNGTIZdur6b4aISomiv1uSw20fIegQWDqypegSkHj82Tvagd+6rjOh86Tvfq+hB1fOVh/hj/Ge+PDighpCnQJrlKP4OulD853TDNfyfm74zWawwTR3hDuOUHFJIpnWEOqGK6lPVDl/by3dyrODevp9ocA9Yl+d/9oniWNfLxb7WcDszNa5pChqFUTKC5z2WhXUgGuJ8PE8wZzXe7Na7C3oIVnU/YJYnc+TJbbBgkVvBCfwdftkD3L9KUhp6l7GbJbLMofOAQBm8qwRuXUENykE05oVUpubI1lc9uk2m+0v02rrpqEBYGYdXk9R0iWge41srfi7YVLuvQL8zmpTG50Hk6T+qcPPDKJ2rE77oIaFlQYd2dVoEu4dEGv+QiD8+g0OLPL4GRb/75i7+yd9U7v6AZG/EjpQw5I1BJ/oqPwM7kgP2IbxTfKUyu0+wlp3BkU2E2ykvsbDZV15cwSCd25B52WQuLwvo32M6kw9eXIZ+jNPQQWjJV2lhNY/reDxiumWImuVUaXXtc5Nu59bjIb+PS4yJvXnS7AMK9O3jH5twk1bd3701x0dwq4IGbW83GKD2oei7i2UDDAnecQufBeVB3mcBU+deBSHQm4QoHDYYeFhlIMmEmpTbuRVodt16zsGbrHU5fw7cQ4la91s+Gs7duiDYGZZMp5pW2qPuyAZpOHTVxVLjn5WXDbMpHo1HMs+FJfAj8WcyHxzx+tv/s+OQkPZjsPxtvWHQYbUHR7tvY/i7A5/pX+tNJjVP2UmAsHJ9fYvB5wF5gUHov6lIloMD8iPJWNxCHwvUPoq9+71a0UT7y1rYL8T/aCzKs3txNzhry/W3DFWtyjq+46fJINBVSmHnivZyoXSkhmkyve/BJewK5Oz4+lPoqLKsn7/gEc+WsmISGvskKM1YD2GR/9138EZnHvXhHie4GQtmiwZgVnklditL3zUGDdEd2WTq7q17s5p6qkri80krOmL99d+f4TRS3YHMnkkHiXTt48X4ThQu6Poa92R7bHx0cHj3pOWJzJeHW+RBvsHfIhgiHfH/YCpRixkEu0k2eht7Dk5UuAxzWhR4bR4eqT8zBNNJ7a2eVC+F0LvDbOLJ7YW3OI3jXfB5Q52TQ7rt9wdxsZymHM56rq0Z6A+VybUpuqO/2t/Ym4JQhm6/LEE0fwd1MUC3SazJnw5qbdb5vuL06pFm8oR2kFB40s0HT4ffU51Y3EF/rxL2FfOT7PKpfEkiF71AXwtrQygStMuFGpPd8O+eU5hfkd7A2ycjY7QorATLT0EP+GthjfwS6Xfnk8DWro693JvivmBYe5MyMwqLam6y6TtQYVopqBd09+ujJkljvJO/4nB0C9OEzykxPLTNlUShtWUbGUb7sRvi9OAprcBHQO/dDd5IfGpDdhFknmrUpXQwrvyS3S3h5TVVjZCftZUVaZaQfpslEaDvffZaXvjYPda+uxl6DUtqEMwBJ5mwXpq1yQW9jxIfipCMOh8f7z+KM83F8CNmz+OQIhvH+CWRH2RDg5OBog0ijaNgtLqV5ztlrYX+boSsuo4xfjsKcasJdUQEDmbF5JxqGRQ6UuyJWoWZPhJ6Lzh1TapQ9m0yPR2k84ZNpfMj3R/HJaDyKDw6HMMrGKZ+MTjZQ6nZS6MxwwefsB9C5kBWZkC5YLEJ6Wm1NoWBTgzTOnq78Hpvzdtbnam1MYfXWaJPTm0mXvUiqy6XcmB/aanbr2xr27twYGYZgB+xXgM/oapJ2Tk/v/ga8D3VwmlSy946vSmGiTdJeNRTqdSuBv/VaMe5Ndm+/2v8hGArVi+F/WIvhehD90tAbNy3oT6JArgfRT5UGuWnND6rkQZV8hyoJr98r6XWGaytKG1/ux1UkMZQsWvkkoVtf5xcQOuVHTF3itvXrBSBRGrjgGMfLrxX04melMgrlLjhfi2mVjTPuEW3qHuJy26zI5EbHhVIhuF/DS+7GQ3GSx1TNdGWhp1daWDgNq8T7XuJzVC9c5opJVeErxTaHTMkdni9DRKFbi8UlvIYqM3SPdNAxJlFf/cIzs8bQtAya9XQt4AsskhO8CI7nSBo2EgtaGyckCX2SZHX0wj3Mq1/Pdyu27lx+Bk+ix/Hf8b/TD3M8f3MW/1cVniEcc+AZ6ZwaSW+Zp5ehUqDbPCRzjKosY8/fnFUlxrkxKhWUp0PuHnr7jA3wuTc9fJZoK4g6G3Xg2jRI/siwDwshKcOjMfaOz+55IeK6sPm/+gHjxsdPEAa+4UbVuI7udVE4VwD+ON4/alcza3xe1fcBY39QGXmIuhu8dfWEzWWY/oiF4BvkdkPHOV+Cvsui8P9cVeAfqr6vqY76UL6tt3zbn64cfiiv/jsXw28Wdv/jlsIP1eEdwmZt+/5aq61X+lvUw3cFWBAmpaGvL98eNGZVvawh6AahtNbHP21x/S6j//2W0ywS0V9SALGsX6hZs9KHGv8PNf431fivi+c/VPj3NtTfpz7+eRRO1nnka+SH0z1gF6Gtr+V34X+Qofp4swiqyun72s+OjMaUC1/1CkWmLuHiocb+ljX2z+XaIvu4cY0a+6fs+e0K7OM4m+vrd4feVFy/VuUOZzSIapDRIOpHEQ2ijRBI9a8W7f++37/qq9X/f//zv/dcrf+hYv5Dxfw7qpi/kxtip0L5dAz+eUrl/x4F73uV0V34YnrWct2uIhgcgfdRRbxZeXl01Krb+zU2BfDPwM0ypuKYDW939dPN7Wboi46Rc7TIqFhw4Z0k8NWCNJREhrcpF6lZ+1vS1bXxht+UxrtQGKqLtS6ovYK5v1sbe93drwH9vj4Jm8I4FBCw8+g0enq5/3QlbPD0W09g4Bq90PhM1IcQSp2je947YHkhnP81zmBBTtiV4/ISFqpDcjde7HLN8Wtc3ZqBe8d8oymvfN2YBX6NizeQlppyIj98CzHr5ynGz5+XSIcPH5ut3tItkNi0p211IBFicM3TAQWuKVTRrRlKQ8RU3o7x0s7RjxXebg2it/Tg9ntmcCOsmeB6EKHz/pfa7d/7u8eV0GvXRN+9yvm6fhuqf/f9mO1hPHwWj8Z9P2bb/nrb0vR1oOqOi5VXtufvV6wcY2XuQW3ID6F4GoankALVJjdiQYMIrX7z8/Qt6EuRQuPI1XEUKrL7lBo+zZC70CcS07/x9ZPxXVc0EORk7ljFCMcjw155UchCHQKMnGUqLRfhZ+z/xe8ld0nePjL4MszKfiHvnsvkdQ+mUGb4b/+tFhHI8IUydsFlY5z3/imXXPFrd9F/q0NgD0Hr3zdoHX7sAL7ap0XOBYlLUg/fvP76EF22fothUqv2077g9kese2Qsdvz2DcPD73V+fY0ffykB8y0+fESJoalUg/udbEEpVmvCzk1mefyLN3uesG1+e6V3cUF4yWVDckW++GtvuN7VcnJB8t3w/skj5r30dXTsTzeoyF2bWC8cseJ3LcNuNTBe90A1XtiNbZu22Jv376JBNPGx+IUiw1PzK7yq8iu39+EBA7mhr/CPnMtZ6VJ/3JD43/8DTXGKWg== +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"; + + + + + + + + + + +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 update 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/put-v-1-employee-form-sign.ParamsDetails.json b/docs/api/put-v-1-employee-form-sign.ParamsDetails.json new file mode 100644 index 000000000..9986c7897 --- /dev/null +++ b/docs/api/put-v-1-employee-form-sign.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-client-ip","in":"header","required":false,"description":"Optional header to supply the IP address. This can be used to supply the IP address for signature endpoints instead of the signed_by_ip_address parameter.","schema":{"type":"string"}},{"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/put-v-1-employee-form-sign.RequestSchema.json b/docs/api/put-v-1-employee-form-sign.RequestSchema.json new file mode 100644 index 000000000..3a6a47fd8 --- /dev/null +++ b/docs/api/put-v-1-employee-form-sign.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"required":true,"content":{"application/json":{"schema":{"description":"","type":"object","properties":{"signature_text":{"type":"string","description":"The signature"},"agree":{"type":"boolean","description":"Whether you agree to sign electronically"},"signed_by_ip_address":{"type":"string","description":"The IP address of the signatory who signed the form. Both IPv4 AND IPv6 are supported. You must provide the IP address with either this parameter OR you can leave out this parameter and set the IP address in the request header using the `x-gusto-client-ip` header instead."},"preparer":{"type":"boolean","description":"Whether there is a preparer"},"preparer_first_name":{"type":"string"},"preparer_last_name":{"type":"string"},"preparer_street_1":{"type":"string"},"preparer_street_2":{"type":"string"},"preparer_city":{"type":"string"},"preparer_state":{"type":"string"},"preparer_zip":{"type":"string"},"preparer_agree":{"type":"string","description":"Whether preparer agrees to sign electronically"},"preparer2":{"type":"boolean","description":"Whether there is a 2nd preparer"},"preparer2_first_name":{"type":"string"},"preparer2_last_name":{"type":"string"},"preparer2_street_1":{"type":"string"},"preparer2_street_2":{"type":"string"},"preparer2_city":{"type":"string"},"preparer2_state":{"type":"string"},"preparer2_zip":{"type":"string"},"preparer2_agree":{"type":"string","description":"Whether 2nd preparer agrees to sign electronically"},"preparer3":{"type":"boolean","description":"Whether there is a 3rd preparer"},"preparer3_first_name":{"type":"string"},"preparer3_last_name":{"type":"string"},"preparer3_street_1":{"type":"string"},"preparer3_street_2":{"type":"string"},"preparer3_city":{"type":"string"},"preparer3_state":{"type":"string"},"preparer3_zip":{"type":"string"},"preparer3_agree":{"type":"string","description":"Whether 3rd preparer agrees to sign electronically"},"preparer4":{"type":"boolean","description":"Whether there is a 4th preparer"},"preparer4_first_name":{"type":"string"},"preparer4_last_name":{"type":"string"},"preparer4_street_1":{"type":"string"},"preparer4_street_2":{"type":"string"},"preparer4_city":{"type":"string"},"preparer4_state":{"type":"string"},"preparer4_zip":{"type":"string"},"preparer4_agree":{"type":"string","description":"Whether 4th preparer agrees to sign electronically"}},"required":["signature_text","agree"]},"examples":{"Example":{"value":{"signature_text":"Jane Smith","agree":true,"signed_by_ip_address":"192.168.0.1"}}}}}}} \ No newline at end of file diff --git a/docs/api/put-v-1-employee-form-sign.StatusCodes.json b/docs/api/put-v-1-employee-form-sign.StatusCodes.json new file mode 100644 index 000000000..b62fcf08f --- /dev/null +++ b/docs/api/put-v-1-employee-form-sign.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"},"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/put-v-1-employee-form-sign.api.mdx b/docs/api/put-v-1-employee-form-sign.api.mdx new file mode 100644 index 000000000..00c5f4d64 --- /dev/null +++ b/docs/api/put-v-1-employee-form-sign.api.mdx @@ -0,0 +1,74 @@ +--- +id: put-v-1-employee-form-sign +title: "Sign an employee form" +description: "Sign an employee form." +sidebar_label: "Sign an employee form" +hide_title: true +hide_table_of_contents: true +api: eJztPWtvGzmSf4XX9yEJoPZDUhLHny4TJ7ceIIkvj8stMkGb6i5J3LTIHpJtWwn83w9VJPslqSU5NnC7NwPMTCKRxXqxXiRLP6ObeFYaq2IhLcw0t0LJ2C4LiE6/RrCYQJZBFn0bRJbPDH72elHkagnA3ii9MPiNKsDNO8+i06gobXx1HIMfFk+VXsRGzGQ0iAqu+QIsaIT0M5J8AdFpFIYmIosGkZAIhNt5NIg0/FkKDVl0anUJg8ikc1jw6PRn5DCMjNVCzqLbQZSBSbUoEI3oNPo0B/b58/kZU1Nm58DCEtHtoFoWEXvAJRF8c7nA5zQXIG0sirDwHHgGurX0lOcGugu8pz/wnLkJzCpmyqLIl7Tc+QXjWabBmAP2aS4MS7lkE2ClgWzjUESSoWy4LTUwkFmhhLSGCWks8CzQgkMgSybLRBRJmFsJ8yDqYVODA/8T/ydx4OXFefzfoA2StScPznC9hZBgCK+MW4gnHEl8eXHOrhxQxo1RqeAWMnYt7JwtValpQMrz/ICdT5lUEpgwrNDqSmSQDdwYXhS5SEmXHxn2dSGkWJSLJuxvj+fWFub08DBTqTkgkR6kanEYtkpc8KVWeU7fH/JCxH6mkLN/9wDjxsdPEA0UUh8XBxHIcoG7b3g0fBofPYuPn+LOy2DKy9xGp83Pb2+/ddn2Ucwk47LaBqScB3/IPyRqrQqKVWgouAbNuLVaTEoLhnENTMl8ya54LjJSmPP4hQPAvsxBMl7P86QMUDh/yKnQxjIU/oDlvPqjsRrABhUcsFTYJX7KLQwYlxn7IQpax865beCkgfE8Z0FDCH2TqgJO2WVlQhAvc4r6eknaZAolDRhk6fDoCP/X5szrG74ocmBhZDSIUiUtSItjG/pw+A+DE342ZSRsjkJCQxgNgsjU5B+QWjR2Gg2jFW71shTZOsHuYESQDp69l/nSGaXbgd9Ru0DDEUxkIK2YCtDbAHuadoKMQ7fBa03bBWrjk62wNZ/aBtSJUjlwuQL2vAaDGipQZWmuU7oD9vpgdsBeSzJ3S+CaWX5Dww1b8CVa0WAnViazQgtFtngCQs7YVEieix9uO69gjMBrhL9G5HPJ7skyz6OVfYsMIYSIE8L4bfcGrbZaOJLMgAHiX+E8cEOFM5E0/Xou0nnNBA2FBgPSmgP2kn0Z0m77ncuS6yWL2RmkaM00Gx4Nh+xalXmGPMggF1egHRPC6OHRcESbds6vgHG33BXPS9IMBODdkftMGIaU8kkONOta5DmTyjoeE04MDXieO1rWcvHPkmsLezPST/sFXqY8B5lxXYEKfPXQ2oyVzIdK+pFh/+Vm5Ev2BjLQPGef+A37ALbUkj1GC8JejI+fkCReFlrkA/aWLwfs91JCUw6ezQGBmtPsMfJznQCe3L8EvA02CRpa3MnbN+FL5r9h05zPnG0XMkPrCoZdz8HOMaYJKioBMsM8eKY0onjA3ikLbqqtKSIK0jmXM2B8aptQhPGhy1oqMpWWC5A28RY/cSTUWlWZqc1K5ac6M+vtVSP8CEscsLfKWG9T0JNdnL0xLjjhKzAum26nyKaXB+wjaihppciBFTz9zmfINiR9As5jihwMe4zAuCCu4RpPdlrkhyguvZZUrr8CfonUX6KIpAu6PE1szo3XHJDBT6/h9KDlKOMzPz1+5TCKPy0LoP9gsBjdxOBcMnlN755rBxqNT9IsewppzMdZFo9PxkcxHw/HMc+ev5iOTrKT8dFJFBxklKpFweUyyYSG1CYZFMoIdM4BpTP6gp25L9jL0s6VFj+ILSs6/AVILzFWpJAao6qCF6Cvlf6On3A/HcNu/HsGE2Fpm6UaMmFdlDnh8jvjaapK6b4koeIfCr50Qyy/Adp63sf5YNj5D5RHwwq6v65uScf7DUoedXTM8z4keVVuV8fjX50Evt0Oog0Sou34l6icqDriaUpuV5FsEuot/TOIxkfj1YD2nbLsjSplxv6QjLkAH8GAQXukwahSp7iJwW1euBEGzRP/DsxgEohbvAp3KBZ1llZgxI1p73g4XF32syy0SsEYciyvpRV2WWEgXBw150UBsjYkE5UtKeRCNnocmbdfhoHWShtmynTOuGGXQhISSWWgEtK3ywFTzuIHCFMucsOyEkjMsp5Z1SnQoIKj9Otrt8wrbmGmtACzZ4ZHaMZpNf0Jm5UiI//DFkpj2GQRIWTeHrnFdu7+xdwuc7sJWNN2OYLRorXTMv95Hb9wrfkSyxIWFs3PN0NNvgNO8FguN6xBo7ZmQB8LSDFPo4jIb0aazlSalhprO8tCYBlj6UKg77CsszsXpVYyPKwqNExDTvGIVTXIA9zMFdZ7oGZDWqmmHhKjUMiDCtbDaxmbaVUWQs6Ms67tstSkFHnGUtSDhR8/5zLLMX4R0mlvozJJxZtqIWHYpSTDljg5XlLlgTlZ+cDQqTzjzI1kl34o80JauggJnMlyXxJrFrjfZjskwxeBXq+NjE9UaRuyi9kMJAb9QWoedGCGKfWUp44hWKWRGfJHeywsz7jl61SxjcarsLk15HDFpcXyGEeYXkGWfid7FyAkoz2NmTaZDW+RJjm4tMi7+UELBOFHrLp0/yfvdUmyDZ+g/7+s4sfgTNBHKgnvp1T77adlUeZWYF2GIOI+6my88PHqZgvf7LGl22sbIWdhZZzGs0y4AtlFYyUXXa1Ze9lJIzZpzTu+qDIGz1Gf2QS1SZV2ZakMIxTShgaDt6/wWYo/y1bxZ+qtuQNDEJ31nmq16Ml8qnFlkVjVP7Bl59YNoLpJ35C6DBW99doffxF2Hr+XEDvnF91uHvXW644biqLBGvRfMv/nlznlHpscdif+R+NDdWsKcJnodRsH7NzScYAyRmCIZZWrtFR2KIcryA3KzruR4CgqsxKlQqdlzvVjh25MwU/8nhTuSdSkcM0Ap9Dt5BeTj8QnH0kGOVhISjktZQZZUvAl5hCtIOZrK9aI8GCkGZicRivBWtRwc9GbUmZCzt6CnauMsvuwGqtWIxm0ELsCLabLREhS3Tpzu0/M/r6Si6Vc+qIVrS8gO2AXOXADLJ1D+t0FKRixenQYX+BEdO2bSOA5Fi6WSYD4oAQge/2CroBS0bEGwYUwaKESrUrry20bEPMjElliBXc9ip0gv4XoBzefufm4J6rzFoeX1wTMXadiZirUqlhzL66tzm4i89IyFCkWJKE+bmSL0thmYLEesUDtlBsbdkuSi4WwPRiuGbw3C98gxh4GIxjMzEMRnXvOVjgnBWihshpfkFmSeWu5ActqyFrc1vMSjzdwTmPnUAZl51yyEVsoaed0NjIt8SzY4RdqMkJmpbF6mRjIIUXtTiQXqUlSlUFSB2YbMa5H78/PdziX4dw16rgbhn6Zh0cwqCb8WfIcvcgzlomZqMxOD7omIGB2QNeI1I3dH9uPIiVczSqyY4+sw9WKBSRqOk0KlYt0mWCdbjdZL+7ExMU6+XaRKCXtKMiq/cLTVJc8T3T/nmkN28Nyv3TzGM6rODbJ0ZRjZFXhwwhBAWYD4gWQc018IaXPO3am7oPtK7e5M+CpFVd0PkkwXI7rcWC4AFPTaajqbMI5nKqbXcReDd5f9uFKkTsa2VkDJjznMoWkLLbYy83eug+rV1xShZRn/yCxu9VMv9jnKhcZWnX81yEcwgoKRO8zKnrljEkVRlBIwTwGVKB2GGxGTSr7cGhVJWZ/ZrmK2IAVPmTTgLqqJGxEtXKPlZo9iCqeuzH1TRlMu0yjhkH4KTlRXGMYXl0su0f+hT2MAT+rlmrcYUMUVoi5Rww+Ue0RDwOlT0uFbFWBsbjc8WgurEhAYv2ITjY0T63SiaKDwI24dUfuv00rAC7fq+Mbh4u7s0RajrbP4Vtv2ID/Q8axHRrXuDljuaa4nQ6wKdffJQpYnbU//y6quPrRGniP6m1clyaoTukvhMEVHm87KkJpcVf8W+N/CfMWpK04h9F1SoNHDslMK2Ow3BEWl0DJQF+s40fsH+4A5QhVRBHygg5KFLWgROaq1LsEhndzdX9D6I2dI2HGrbjqMsjv8RT9YH6P9ubCwW8g4JaotsdUqx8gE4/HvVo6rPr45VdScn/ohrWFc2tcOb3G0YUdGZ6Q8dyC3oBt4qH05+2/hLgw/vZZhXA4aumgGi7OYEzlkS3lQmViKshsB5RDNfM+kQ0nRsWKsB0CjpMtljtDaUBfeStulsbCohoUbHg3NiArYOguKO/L9tvjf8UAtSHVu1oyKk96PBf8Bq//dvE0pS440vyAqL6+SQEwivA4oCSOj46Iq7lS38uij5cPiFgIuKpnBXjl4LF5chC1z77qc52vnaJ7lT5EnVp5WD/Gv8bHwxFS2DJok1yl30FXzp+KbkJO1V7K34G2NhgmjfCBcKsOKCRT2l/n16UM26NLvlt7Fc9+eirhGLBl8TBE8awOTc3dyOmg2U/T1N2fTCy/eUiyMC6kANyvR7fvaL270biK9g6q6GrC7pLIvZPZUsNgsUIV+hf0soX0eiJNabAWsWeJfRei8MZnAN50gltJqFFyKJtyQlQpuSKaqmbXF5qvTL9Lqa4CwgIQVi1e5xDRJoRrr/yr2LaOyzr8C6t5a0wldJ7OEzvXYOYqzxLwzidqnN91MSCyoMJ1f14FvtANZyzbXHHhrjmjBoNR+RUwqs2/fPU39ikgx4JnbJwfKWWoGIFO8ovQwM7lgL1VV8A+Kbxcp9kZp+PIpsP073nuFDZV6ctV9SyqdXbkHr9YC4uCklirfEjHeH2fo0TlxJBDlTZW05i+9wBDmklPvZTG0h4X+W5lPS7yu5T0uMibiW4XgZB3h+rYnLtbjvTt/VdT3GludeCBwq1Wc486PEKVGmhYoMTp6DwUD+opE5giMLwngExnEq4RaAj0xA1kSSbMpNQG6DCpPrfeQFhz9B67r1FbCOdWa6Ofnr23CUQbB2WTKd4rbXH3rIE07Toa4rjwwORlR9mUD4fDmGdHJ/EY+POYHz3j8fPj589OTtLR5Pj5ix6iA7QFnXbfJfZ3B3xufuU/ndU4Ze3LygP2Cg+lD6IuVwIWeD+ivFMG4rBw84Ppq5/qFW0sH/lo2x3xPzoINqwWbl+xhmp/u2jFhjvH1/69QENHoqmQwswTX+VE74oXCVzo9QA1ac8gl+NbhTvbsnrxTk0wVy6KSQj0tijMvWtMjveX4ltUHiHTvMzQorcfSK7oTOquKP3aGgSkC9nd0tnf9dJDOPeyDs3ltVb4Es5l3901ftDD533V3JlkkJhrhyoePnqhQ9fH9GbreDgaP32yZovNlYQ734e4wNnhNkTY5MdHrYNSvHGQi7Sv0rB282SluwEOm44eG1sHj+/sHAy03ub6YpU7wukk8LsUstei1X+P4FPzeUB9J4Ok7+SCd7NdpBz2eK6uG9cb6C5X3+WGOre/czUBlwy3+boK0awR3M8CFZHek7kY1mz3+X7g7u6QVvGBdrBS9Kisx9NRnwOcc6cMBO8EQ+af2j3ycx7VLwmkYgU+ybc2jDLBq0y4EekDZ+ecrvkF+x2iTQoy9kth6cFhww/5NHBN/BH4du0vh2+gjr7em+Ff8Fp4sDMzOhbVPmTV9UWNo8pRrWD3gDX66tHf+iJ5p+bsMMAaPqOb6amlHhRKW+aeeOXL7gm/N0eBBncCeu916M7lhwbKbsGsc5rVd10MOxwkd7vw8qbqjtBOk7pxM/mHaTIRmvqT7LnKGZ2rTxlNr1Jj70Hp2oQLAMnm7HZMW90FvUsQ74P350MO42fHz+OM8xfxGLLn8clTOIqPTyB7mh0BnIye9pg0Og27Q1Ka55y9EfbHDEtxGd345WjMMV1juGHdU/bOaZgB9ySa1XSEwHpNonPPnBpmzyfTZ8M0nvDJNB7z42F8MnwxjEfjIxhmL1I+GZ70cOpuVujccMHn7DfQuZAVm5Av+dK9GvevV3bjUIipQRoXT1d1j/57O5vvavVeYfXRaFPTm5cu12JSJZey935oa9idszWc3ckYGR7BDtgXgO9YapJ2Tk/v/o7PRlexDkWTyvbec6oUFuqz9qrhUG9bF/hbrxXjtZfd22+IfwuBQvWC+J82YrgdRB8afmMbQf8iDuR2EL2rPMg2mv9yJX+5kl9wJeH1uw/fflMZZZPdvm13fGm9tY9T1S0tsXDT7D7U09OomoPc5TMNzadimxqmfPEtUbCDAc2p+hjQSYdW0r0DjnxZvdufbTfUGr3gGr3eXI37eq58+5Sqo8oB+03ZOTu/uBqzl+/O8A/P6HDCh/YY7eN5BZlcXybo9pxzz22F7/ciGo3k2PsPRC4+i80BK/buHW1rDOoMKkkHaueGou+R585E8IvLlf57l2GQb3ZHT+NCu7E9BGSr25JVs7ImpKRh49d1EazGYYu0HYZVZcZdRg37R6W+FNMHp/Vwb90QrOj1Duhq/AZ1DPysO77hPNOj9mHk8G7SGmIbjzUSG+4qsuGOMhvuJrThblIbbhfbcAe5DbcKbriv5JoM3V16o7tJb6TXS2+0q/RGO0pvtJv0RrtJb7RdeqMdpDfaKr3RvtJrMnR36Y3vJr0xPkdZI73xrtIb7yi98W7SG+8mvfF26Y13kN54q/TG+0qvydBt0rttN1PohDQhRNml01M3Gop+5xLYx4WgVMOT4Bvpro1RouMXw4PjZycHRwfHUQjtbmJTAP8O3Cxj6h7SuGfoOlO1x6ASxOoKtBYZscp1G4YbC9JQgR1jWRfFbmx3PAhUNdseY0Qe5nVxqiZ0cFs/p41jPZdwxY6t/iCaGihTq2Q7j06jw6vjw+p23eHPRqvk20Mq/B/+9H2Mbw892XRf1sfvpc4xx/E9d3ghXMudOIMF9d1ZUaczWKgOdx282B2649dI4AbAa2FeaDpg3wSzwK+RAwbSUtP2+vozJO8vUywkYK+v6PTrt+aojxjBO81cM7baNohi6KxLNgrI5Kw2TyEQMb3zp+ZgeLgTLrENoo908/hXVnAQNixwO4gwM/lQ5zSN3bayySpTsMsGqwbXoW3oY7EmQF0d3rSza76trevmL4drv3SWdO0ssp9rviGrueZzz4fVb4ZdYodbqB32kzvspXfYS/BwI8XDzSQPN9E83Ez0qEv0aAvRo36iR71Ej3qJHm0kerSZ6NEmokebiR53iR5vIXrcT/S4l+hxL9HjjUSPNxM93kT0uEs0HfK7O+qh5EqN1bFPOXqWcBGx2RR8EGHjdPN++hH0lUihYbzrJmzUt+qQBh5maKew8BHT3/FCofFTV3st5in1J1WM8Hhk2GvvQVl42oMt1EPfQ7J5/+a74XF3b8KL4Sysyj5gxzJ/OO7uIKL38d/+R+1s0HQWytgFlw04axuedxH/WReJ/t92SPc+DB3LYZFzQc6OnPtPH4J8ja6OSQb1m9rT9i82TH1Idlr/ogKFIt/wIa+xCOLnTyzdf9b57S1+/GcJWED8+g3jIE1vj8jpZ4LODDZ0/2/K6/EHT+QTtvG3HjZQF/oGyWUjDIt8E6PWj1FgoHMvKE1bHeL3QSew1D2Ldr+SsB+n/k//bMRajrQD9ebvZVTs2U8y/+K/GtHDxPU/udFioxvYbMbcGLFSOq9nYCxc2N6xzazm4vOnaBBNfLV+oShR0/waG/vxa6fy4ToUlvPxs59RzuWsdAcJDiT+879azNV+ +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"; + + + + + + + + + + +Sign an employee form. + +The optional preparer attributes are only valid for I-9 form. When a preparer is used, the +first name, last name, street address, city, state, and zip for that preparer are all required. + +scope: `employee_forms:sign` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/put-v-1-employees-employee-id-bank-accounts.ParamsDetails.json b/docs/api/put-v-1-employees-employee-id-bank-accounts.ParamsDetails.json new file mode 100644 index 000000000..7ff1a73ae --- /dev/null +++ b/docs/api/put-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"},{"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/put-v-1-employees-employee-id-bank-accounts.RequestSchema.json b/docs/api/put-v-1-employees-employee-id-bank-accounts.RequestSchema.json new file mode 100644 index 000000000..479c9ec67 --- /dev/null +++ b/docs/api/put-v-1-employees-employee-id-bank-accounts.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"routing_number":{"type":"string"},"account_number":{"type":"string"},"account_type":{"type":"string","enum":["Checking","Savings"]}},"required":["name","routing_number","account_number","account_type"]},"examples":{"Example":{"value":{"name":"BoA Checking Account","routing_number":"266905059","account_number":"5809431207","account_type":"Checking"}}}}}}} \ No newline at end of file diff --git a/docs/api/put-v-1-employees-employee-id-bank-accounts.StatusCodes.json b/docs/api/put-v-1-employees-employee-id-bank-accounts.StatusCodes.json new file mode 100644 index 000000000..be596e481 --- /dev/null +++ b/docs/api/put-v-1-employees-employee-id-bank-accounts.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Example response","content":{"application/json":{"schema":{"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"},"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/put-v-1-employees-employee-id-bank-accounts.api.mdx b/docs/api/put-v-1-employees-employee-id-bank-accounts.api.mdx new file mode 100644 index 000000000..746501450 --- /dev/null +++ b/docs/api/put-v-1-employees-employee-id-bank-accounts.api.mdx @@ -0,0 +1,71 @@ +--- +id: put-v-1-employees-employee-id-bank-accounts +title: "Update an employee bank account" +description: "Updates an employee bank account." +sidebar_label: "Update an employee bank account" +hide_title: true +hide_table_of_contents: true +api: eJztXNlvGzmT/1e4vQ9JALUtybefNud+fsiMkWOTD07QppolieNusodky9YY+t8XxaMvHZYc+2FnZ4BBEjVZ/LHIOlnkfXQXT0ptZMyFgYmihksRm3kB0flVBPkIGAMW/exFsgD39YJF51FRmng2iCEvMjkH0NXfEs7iERU3CU1TWQqjo16kQBdSaNDR+X007PfxDwY6VbxAgtF59P6O5kUGJLSMelEqhQFhsC0tioyndvD9PzR2uI90OoWc4t8MNxkgDY8gfkPFTfzaDR/1IjeZSI7+gBT/fReDG83C8SPjX2c0K+1fypLjHAdHBwM4HR7Gp+wM4sMRO43Pxmf9uM/6h8f908HwiJ1Evaiaue92Nk7Hg9GAxaenp8fx4fHZID4bnh7EB6cH7GDE2OGYnUW9SNAcYb2Rr8nbKaQ3XExIDVrJ0nAxSUSZj0BF59Hw+Pisf9Q/wq5TzhiIwOG6zffv378Phn0EFb75yYcRosVi0YsKhYtpuOOAg30f+KSNwoa9zgp9/XrxjsgxMVMguL7EjxAtljiwC6nQFcm0MS9TAVHmuCuryfSiz3TGxUTj/myP8aYBkVhCi8Dyh+D9RnMgY6lWTrW7Lg8R+9Kh8UITT4J4Eou16/kQ7Y9U3wBrka+ILnCfGzrRyLAgGeSSznMQhnwEM5VWqhX8WXIFDJvZ1fuJ6/n/Wj6siBz2D5e11G/SkA+yFIz8EIT8ELi4yEDQBhjqLlmqFAiToImQhsAd12aPfKQ3QHSpwO6oQskZZ8CIFQOuyYxmnO39ELgTDofD5WG/ikLJFLSmowzIe2G4mVcIuCY5nZMpLQoQ5HYKwu1byeYoY3NZqoCRoEqlXGgCSkmliS7TKaGaXHNhQSTUGMVHpYHErvV1j3gxCBTGlGeasBKIkYSKumdlHa73yGdwM71674Z5Sw1MpOKgf76cGlPo8/19JlO9Zw3PXirz/WBo4oLOlcwy+33fwozTqvsrMik5c8KZSwWEgUFAyLwdDMbD3P2HuV3mdo1oU2+4CaM2aRsW/3utx6hSdB71Im4gb/6+nmpyA9jBo5yvGcO2elBdfi4g5WMOGhfSC6PtTmSalkrvkS/zgqc0y+bE4NLfwJxwBsK4Xti+WsP9giqagwHcABlF+TeyJrmHwlyh3gEaUsC2uL0cJYJaJpAK2sPvMjJRsizQAhIqGEmpICMgpXZoRiXPGElxH+S+/ZQKlqEm5cLt3obXt0cuxvVAXJNrYRVb4tbxumfBubUitzzLwpYnlLiW5No3JX6R5uSWmykBp7LcR8uaHOVtsoUxvgzz9buR0JEsTWPtYjIBAapeNU86MEOXakxTxxAqCAiG/FEehaGMGrpqK7ZhvA3CrSCDGRWGYD+k6TfI3EuyNwFcECvTXHq14TXSKIM98kEq4k1sr0XC4rOsunZ/WvN0bdc2/IJG9Nqxf1Qbk72oF0kBv4+j86uH5pKXmeHobFuKKEcdwQs/Lwtb+LKDSLfH1lxMwsjYjTLG8RPNLhsjGVXCyrHna33DFS5c8DAdR82UNrdNKpWLNZgmRtrd0GDwFj6s4H+WUKsHVXmMjoyl6LT3WMm8JnhVUxRllll/y7Uri8TIzQ1bem5VA22ogU1NFr0qXvrod3/8jZtp/LuA2Bk/FyOsbvXR7x3XFJdm0ftnzf8Oa279/nUGu82Hb6h8pMjmzsElfKPZ2CMXBn8upNYcXSwjyZTOgFR6KIMZZBrXzpuRYCgqtRKlXKVlRtVLBze2zk/8u91wr6LmDFc0cBu6HfY3UxQJgwwMJKUYl4IBSwoXJrWcmKuWrxGNqEtSVCY+WnLWooaZiz6UgnExcYEXmVJNwmikGs2uQQvYDBQfzxMu7NZNEWkhNX9SZP9GN6AVQ6ZUYPQyAmLH58D2yGUGVANJMU5yTgp6rB4OoblN9eytnwLNFFA2TwLFZ50AstcPSEYAop7HCoA516ihEh9RbgDWiTlXQuw4+S2gn1qBP8pEMLsel98JSSrFmE90Ba3yNXfi2nLvJpjXhuCSGiIFkNqZzUttmo7FamBhtmOqTZCWJOM5NxsQrmi8Mws/IGJPg1gaRE9lmTHETKvsh8ecFKC4ZDVeECxhXluuQVk1WYltNS/fC4b+IDQkx0ZQZkoFOSC5FGaq0Sccl6ZU4PClMi+oQOFmpTZqnmjIIMXdnQjKU52kkkFSO2ZrEdetd+fnb9iXYN8V23E7hH6Y5wcYtib8WdIMrcgxYXzCK7WzAa4OAPQWcDVPXdvd0X7mqcWql8EeerAOq+E5JHI8TgqZ8XSeYLJru7XOH8XEfNX6dkGUwkoUsEpeaJqqkmaJ2iwzrWY7aO7Xrh/BfhXHRhmqcvSsKjzEAuSg1wAvwBrXxCdSNlnHTtdd0L51ws2ApobPELKj4WJcj4HgAESOxyGrsw5zdXKyzbJXjXdf+5D71YQq2H4HjGhGRQpJWTygL9db602o3lJhM6SU/WGX3Y2mNy/7VGacoVbH/x3g4FZYR/QpvaK3TplUboR1KYhHgBbIL/56aEKa54NVpZitJ70KWI8U3mVTgHtVClgLtTKP1TZ7lq144dpUZz4Ewy7dyGFYfFKMJFXohldnQ0/IvyDD6PCTaqjGMRRCWJrMEyL4YnOPXNtkjw1LuWhlgTG53LFozq1IQGD+CJ0wo2hqpEowCNuArdtydzGtCLh4r/ZvHBZmBdbuctR9Dm8tsAH/c/qxnTmuMHPaUGX9djo2oGysv40XsNxrd/5dVn71ixX0XtRiXKcmbJ6SeEGZgTB+FiG1uC3+VvtfQt6i9CDm0LoOafDIIZkoqTWmO8LgAmwwsMnX8S12d3fAxgiVRxHigg4k67XgikxlqbZxDB9n6v6F1BuSI2BCDZ91GeRlPEU7mD2hvrl09BsA3BCVeIyV/AtE4nE8qabDrI8ffikk94dumFu4MNql02uMzu1geEJGMwNqDdrEU9kct/8ScK7JCFC5VYDDUUsHqk01cm0dQA+2FLlkfMyt2g6QQzbzKcGGE6NiabEdAMfJFsudotSgZl6L67k2kFeNgg7v+gZWC+hkLFVON0X77fa/ooDalGqpFsSmJz3OnN7xvMy7OHWpCopzfkao7+9SAPQiPAZciUG/b7maSXlTFpt4+YzAgsNV1X9gycFL/Wovap991ec6V52kexU+RJ1ceRg/xn/Gg+EBzrCl0EaZTG9AVcbfJt24GMudNn+H2kpn2O4I7wi38oBcEKkYKLRPqhRBPLrTd2Mv49w8n2pxNJiyeJ5JUVa7pvpx0+nA3DynMTA8Sk0MvXvOaaFfaB1wPx4x9I7Y8R43x2XYW2xFlxN2RSJPPs3WNgwaK2Shf2FftkCvnqQuNeYidkyxbzMpjkUtnnjTCD44hRqSg6zLkZ2VFEtLU+XsNrnmS90fk6qriJBAhFSD1zFEtA5wbZV/FW3ruKzDvzCa18Y2hU7TaWKmCvRUZiwBb3yixvldF4GdFlRYd+dV4AtuAZu2mVGeUX+Yhx5/NgNic/Ov3/6LfAngSLCMjfMjKbVNRqCR/MYVkAvRIx/lDMgXicV1iryj9jiyaTBnoPSuYhr6VuFLINI5O7J5MWoM5IUNYo30Lh2hdT1HiZsTXQ5ZmliOY/vdEwxhJp8IaqTC1B7l2XZpPcqzx6T0KM+agW4XQIi7Q3ZsSnVSfX36bIo7za0OPHBxq9GILQ/ygKptoCDHFbdH5yF5UHcZwRiJYZ0AMp0IuEWiwdHjd8ASxvWoVBrsYVJ9br1mYs3WO0hfI7cQzq1Wej8bZG8diTYGaZIx1pW2uPuuAdpKnW3iuPDM02N9NqbD4TCmrH8aHwI9iWn/mMYng5Pj09P0YDQ4Odsw6UAtd2XGj/D93QGf61/ZT6c1zsk7jmfh5J07fO658uC9qMuVgALrI8pHRSAOhesfVJ/zqNG1L9ooX3hv2x3xv9gLOqxe3E3JGpv722ZXrKk5vqW6u0eiMRdcTxOf5UTrioUEzvV6hpy0Z5CL8Y1EyTakHryTE8yk82ISS/ohL0wbBWCSwe6r+BE3DxdpVjLU6I4Q6hYFWi/tmdSVKP3aGJZIl7Kr0tnd9GI3ZK3PEt8qKSbER9/dMf7ixSO2uVPJIDDWDlm8v3jhDl1fwt5kjwyGB4dHr1aI2FQKeHQ9xCX2DtUQQcgH/dZBKVYcZDzdlGlYKTysdBXgsO7osSE6eHxnpqAb5b11ssod4XQC+G0S2Sthba4j+NK8HlDXZNjVd+uCtdnOUw4ynsnbRnmDreXaVNxQx/aPzibgkKGar7shmjmCpxmgmqS3ZM6H1Q/bfN9we3NoR/GOdtBSKGh6g6XD77bPoyIQrAkGRuwn8sL3eVHfJBCSFKBybkxopYNVGVHN02eOzqkt8wv6O3ib1snYLYQVAEw37JAPA1f4H4Fvt744fM3s7OedGf4Ny8KDnpnYY1HlXVZVF2r0K0O1hO4Zc/TWk1ifJO/knB0CzOETW5meGqLLopDKEGado2zePeH36ijMwZ2APnkeulP80IDsBmSd06xN5WJcaZM8ruDlA/YlolP2sqStmLUP42TElZnuPso7e64+JrZ7FRp7C2rLJpwDaHXOdse0VS3oY5x477yfDCkcHg9OYkbpWXwI7CQ+PYJ+PDgFdsT6AKcHRxtUmj0Ne0RQmmWUfODmrwmm4pit+KWozDFcIyiwdg9PO6dhGtBHtCFiddTsmbAi0HliTg3ZyWh8PEzjER2N40M6GManw7NhfHDYhyE7S+loeLqBU4/TQheacjolb0BlXFRsQr5kc8uiW397ZTsOBZ8ahHb+dJX32Fy3s75Wa2MJq/dGmzu9WXS5EkkVXIqN9aGtZo+O1rB3J2IkeATbI98AbjDVJMzUXr37N9BVqEPSpNK9TxwqhYE2aXvZMKiLVgF/67ZivLLYvX1/901wFKrbu/9nPYZFL/rUsBsPTehvYkAWvei3yoI8NOd/TMk/puQXTEm4/d6592TT4a5iLZwkNw+49n6IH0KnsoBzcl2dN7aTgPr8VnED1xEeWPnA1rHB3/NvvB+C936E1T9WqOpEursj1nj5o3Vdawk3htNr3pqohm1dBfFh67MM3nlIogLwPf5v+/zK68uL+H+qEwoLYQqUWbVbgxjTTEN3qHfIzJwLf30YFytGbc7I68uLcEpBqNYy5bZUxWY87PVfbIA3nu3dX4HmktcFmT3XpnGZ/oUmVzkXtsihQXvHm+e04LHvycXkPz3BuPHzK4SB15jROqxjef0gyLA/PIr7x/HgyD0EMqZlZlAo698XC//YBWjzRjKbJOmu7fYvznTuO7ZvLa5+ZWSLt0MaT6Bs0eQxr6QsFu2rvt44Ll1s6sDoDLrNEyG/8HrH0rMdR6f9s8ODLR/u2OLNk7tYF0BvgOp5bC/QN9SPb/0xnFw02+KcYjkDpTjDsd0xIb40U88M7gwIbRNPqNycdl/7xFIvMKz51BIqh9CvC7TqsAbw6r5t4DWN5QmglPhTG/vGk1XXZhqdR/uzwX5VirJ/31DXi/3We0/790s6dYFSjJVmXuWXKkP15nUGLbhTGTGD3OqNpRun7yCXncVw9GJ3XIWfceprCK+keamWFrhJs8DPyA4NaalsWvXqPri9r1N0wV+XyJmrn81Wn1FJOLFY0baSVoQYVJs1Q0CVFbTuswOWRGxvyBJamimmRUP5Ry/6bGv2fmUER2HNAItehMrvU602G6LuJbzSO0syXX1ZEuilL0vCjBbQVYqFwMdaSTQ6uH9DOUBTw/citIL69/FnUDOeQmMj1AbJvh6xbxvuM5wzKu7Y/huP9bXvunTjGbJU5rbaweJ4ocl7L68kFNiiPWQyLVEaLf/+w79JQ93phefXuzAq+YTvhvgUtasEwJ3sv/5XvXHti11Sm5yKBp2vvkZhjU/WncJ9bd2e2p/zi2fgzuwXGeV2Z1pJvPfK4yqaDRoPQeGEz9v+XvfFuPNlv+wnXl3RBqnd36N781VliwX+/GcJ6DJf/UTNpmy1rRVWxm2UvMZtanLk5SdvFF+RtU7jmomGm/Ji3lCskb+23/JqUUE9CaTOOj8C1jJ33dUg53Duxru/ufe5kruOi6td94rZtS1+65gVf2nZ/GUns+6BKr0wG9s2LfXl1y8oRN6vzaV1TxS9RbVMb93Kh/MwdHzxt/soo2JSukjSkcT//he9E3Tz +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"; + + + + + + + + + + +Updates an employee bank account. + +scope: `employee_payment_methods:write` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/put-v-1-employees-employee-id-federal-taxes.ParamsDetails.json b/docs/api/put-v-1-employees-employee-id-federal-taxes.ParamsDetails.json new file mode 100644 index 000000000..f3db089c4 --- /dev/null +++ b/docs/api/put-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/put-v-1-employees-employee-id-federal-taxes.RequestSchema.json b/docs/api/put-v-1-employees-employee-id-federal-taxes.RequestSchema.json new file mode 100644 index 000000000..a8f22f77d --- /dev/null +++ b/docs/api/put-v-1-employees-employee-id-federal-taxes.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"required":true,"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.","example":"56a489ce86ed6c1b0f0cecc4050a0b01"},"filing_status":{"type":"string","enum":["Single","Married","Head of Household","Exempt from withholding"],"description":"Determines which tax return form an individual will use. One of: Single, Married, Head of Household, Exempt from withholding.","example":"Single"},"extra_withholding":{"type":"number","description":"Additional amount to be withheld from each paycheck."},"two_jobs":{"type":"boolean","description":"If there are only two jobs (e.g., you and your spouse each have a job), set to true."},"dependents_amount":{"type":"number","description":"Amount for dependents; a dependent entitles the taxpayer to claim a dependency exemption."},"other_income":{"type":"number","description":"Other income amount."},"deductions":{"type":"number","description":"Deductions other than the standard deduction to reduce withholding."},"w4_data_type":{"type":"string","enum":["rev_2020_w4"],"description":"The version of the W4 form. Only rev_2020_w4 is accepted for updates."},"federal_withholding_allowance":{"type":"integer","description":"Only applicable when w4_data_type is 'pre_2020_w4' (pre-2020 W4 forms are deprecated for updates)."},"additional_withholding":{"type":"number","description":"Only applicable when w4_data_type is 'pre_2020_w4' (pre-2020 W4 forms are deprecated for updates)."}},"required":["version","w4_data_type","filing_status"]}}}}} \ No newline at end of file diff --git a/docs/api/put-v-1-employees-employee-id-federal-taxes.StatusCodes.json b/docs/api/put-v-1-employees-employee-id-federal-taxes.StatusCodes.json new file mode 100644 index 000000000..d382b6ff0 --- /dev/null +++ b/docs/api/put-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"}}}},"409":{"description":"Conflict","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"}}}},"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/put-v-1-employees-employee-id-federal-taxes.api.mdx b/docs/api/put-v-1-employees-employee-id-federal-taxes.api.mdx new file mode 100644 index 000000000..d3421077b --- /dev/null +++ b/docs/api/put-v-1-employees-employee-id-federal-taxes.api.mdx @@ -0,0 +1,71 @@ +--- +id: put-v-1-employees-employee-id-federal-taxes +title: "Update federal taxes for an employee" +description: "Updates federal tax (W4) information for an employee. Only rev_2020_w4 format is accepted for updates." +sidebar_label: "Update federal taxes for an employee" +hide_title: true +hide_table_of_contents: true +api: eJztXVtzG7eS/ivY2QfbVRyJomhJ1r6sji8bPyR2xfZ6TzmuMThoioiHwATAkGJc+u9b3cBceREpW2dzzs5DKhaJy9cNoO8tfYsspIWRbhVdfvoWPdfznKvVVZqCtVeFm0WXnz7ffh5EAmxqZO6kVtFl9CEX3IFlUxBgeMYcv2GPP46fMKmm2sw5DmNTbRhXDOZ5plcAR+yNylbMwCIZDUfDZDlmfiyTlvE0hdyBoEmFX/3oN/WbsqnO4ZJ9KVdJwpaJ4zdgL5dGOvgSDaKb+LqwTsdSObg2BCB2qxyiy08RzCcgBIjo8yBy/NriZy/Deuw9v2HvwBU5fluuYuySX0eXzhQwiAzYXCsLNrr8Fo2GQ/xfmx3vCuLXtMiiQZRq5UA5HMXzPJMpgTn+3eLQb5FNZzDn+C8nXQbRZQUlfuVJi9/zm2gQefSRnvwOqYu6J/CqwfmdTH8/A1ZSwKwzReoKA2zBjQTLJtyCYFoxNwO2HCeCO57gzmwqIRNH0SDSCt5M6XLsAhy/NYDH+l3AS9SWFVaqawKVG4hxYfbR3xeElBudg3HSH8kCjJWeuWFr64xU12tbIyvSwhhQjoVJTE9pFw/2iL0DoJ8/he8RxXUhBXx+PHMut5fHx0Kn9oiuyVGq58fl5YpzvjI6y+j7YylgnmsHKl09IdKapGrFZnrJnGaFxe2kLbl9O4iqi14UUuxH04cPr1+UhFQH31qrtRI9ETAbl8LvjOIZ27Ji6uXDdy0Y1qD1mlduP2IbB7esbwSoYo7POjdQSpfo8+0gmspMquvEOu4KW2/wqd5BFVkWrQm4144JcGDmUoFly5lMZ3RjDbjC0GWd4zOTSsiFFAXP2FJmGZ0nV4IkmmJynmvjuHJsylNHl4CILxxdbn7DJxlyKNVzko7A9PTyNxWzd1JdZ4D/+pkbI0HgP38CLpDqn3RhYaYz+vDlDcxzx6ZGz9lSuhl+LtV1Y+qATQpXfce4Dasj90tZ2piZ8CzTS65SaHJLFfMJHfBmbl0pBgSEHjJiyfkKaeQsBeO4VIzPdaEc4vf0IvlH7Ge+YhNguCpbzkCx1nkhG3+LtpEY0QXiQkjctk3F3VfpSrF6anNdJnSWcRMAH0W3t6gB/iikAYGsKKVN5+5uRUJaZZfWuR3cIVl/hcWDSFYDC4nSv5euvXTdT7o2bLf/z9KVDv/GGb5Z5NxJ/lVtn7GUK4biBaxDohoyKUhMp1FC0kaQCY8FeDpDEZvOIP1KJ+2WOvldT1qHMNE6A662nwJdGAOMG2AabXO31AxXYY/lERwN2EoXxPCVLgyzObLG7z3jC2Acxw6YNjSOPnJL/cRPQ7osOCaJAjSkCaeAHJQA5Wzi6TuEbayaTVeA5WAs3lWkgrkZ91as4zc5X4FBYAHzcqYZKBKytj3GaZZmXM4ZrxZPV7UyI8y0fuIv0gFw3xCsoO0qbYKjRJHimENezItqUpdc67gS3AhWrYtEGfwBmpf2AE3Wftab7nrjwm060w7PWjTfrQ+ReInEz6XiThtkU9BJq184nkEX8JzneXiCTQPwDh+rd1l6pfoXUKq9y9K7LP90LkvLFLxLzvYOTC9r/xqytndgegemd2B6B+ZhHRjEeRPDDZ/nmddBHW254FkBLd0UPT3j44tnKVycgThLTybD6TCFNB0Pnw75cDI8WaPqMgpG0canHA2Phk0iQyprw+0NI9t3JHzYPOnwUVsitwhbU07RlA9FCqPTGIYXIh6Pzifxs8nZafw0vRiLdAinZ+enUUcPnYxOx0/bmuTs/OLZEJnace42sHF6Nh6JyURcwMnp+OJcPL14xofD6Xh6ccJHJ8+ebWBjkKHRnbblaLvpFp0ena4zpwl3nTl8lMJocn4an5+Ks3gM43HMR2fDGJ6ePjvjo/HpxdPJ/sy53eNW3g6i8XC8nr78RTv2ShdKYMLV5wtJnoPAzKEuTApMaLBMacfgRlqHZvBXYBYzid7j1QspQHhbQ1q24JkUR7+pQ/KhW0Cx3xRj34vr9YvjNrQNxmhTtIAx2tBbbxuT4fPaFOHG8FU0iKSDefPz7asmXwEnpNzBtTarLXvQqDstnnc5pHIqyQaBQDNNZzpNC2OP2PtVLlOeoW5EQ/IrrJhEAeBn4XjunJGTwsFxzg2fo1nDDGQc2Yyar1zSG3gl6gOgkb7ClLKehpUoKV0uVR6SDcivjS4wmmNJc6MangBaToRmUshMsBTN63kYP+NK4ItG84n0fKMEgDDPwVp+vYf9+LYEIsBxmVnGJ7pwDabG7BoUioiSnWHpEqUtzJSnHikm4ZVA4Mi52w1KQWmXTPGGNy/Wp9b5R+HGN+/LZWNig7hoywNZcv8+aMJRdPsZgZTu2i/axfTI4pe4afzG39pSVjxbf5bPtZpmkm72PR/2B5UbjeUSZN6+RKtmVT5xZClfsRnPc1DevUbuT7RY4e2h4y2NTdyeSxWujWW2SGcYK/giFT3xpLrYCSmKL2TpuZpLbEqHLAoI51XNxNdIxHxpuHwv/TbP/TlIsAf6fAQzTqvpT7znSO7fXBsob52Xmr1w+tcXTuz1tN5IWvZF0dtN/Dl+GTRCD95/DFeeceZHsi9hKCvj42Qwe1dhFR7GX0YGIgrH0UDadBXXxIx/3AYyWKCPjPNwzXBBVuElByknFaM3jd4DiY0gkSYZHLFXGD/ygnfQWoLwEau++P+T5faFzrb8BK21L579k9qg6BRG7aRlXmRO5hn4vfAddR5e+fH6Yyu/OeBJt/e25CMEKlsRv7eNnbxzsGHv1Z6RF0zLVAEhz1E3481rk2rjq9CEZU778FPN4Lt3+KDkHwXU4sGQ3Kz3oxW99MYIww7PtBpX5InTuwe25NymAehF7PKpm8r253D744/SzeI3CmKv/KLb7aN+DnfHD8WjoXKR/sz/6c8cV9qqsNt8+IjCh+Jb5OQwuVNtHLHXFF7KtbUSTSynfWyrkkMZLCCzeHZBjZSKohIrUSpNWmTcPPZwW+bhk6hJ4YYB0QZjd8LV14SnKQYdEgEZOEgKNS2UAJHkfDXHoMQOQxgLVdtW8Jqx1rKGXxUKXfOfwc20YDNuWbkbq3ajM2gBW4CR0xWFQYyBFJHm2sofiuzvaAbgrizsipoTLfQJRa/xoosj9jYDboFRgNQbKWixBjghGmePtpPAMwNcrJJyxQclANkbNmQTAFXTsQHgXFqUUInRFOje5fz4EUmVytsAsWPkt4D+6uczPx/fRKl2A65wE5JUq6m8thW0ytY8iGvrs5tgrhzDI3VMK2C1MTsvrGsaFpuBldROuXXla0kyOZduB8INgw9m4StEHNZgtAazM11kAjHzwNkKc5KDkVrUeEEJjIjBDpTVkI3YNvPypRJoD0Lj5ZAHRTHlUzbXys0s2oTTAovdPb4qaKZEYZ1ZJRYyoOhmorhMbZJqAUltmG1FXI8+nJ+/4FyGczdcx/0Qhm0eHmB5NeEPTGA5zc6YkNeyEjs74NoSgN0DrpWpH3s42ncyJax2Hew4gPVYnZxDoqfTJNeZTFeJ4vM9z3p+LybON51vF0Sh6EWBqN4LT1NT8Cwxu99Ma9gBkvvKz2M4r+LYJENRTn03JR5GACXYLcAxiUAi3AdSdmnHztRD0D73j1sAT51cIGS/hvdxAwaGGzA9nZZRnW2YqwKCfY69Gnz42b+sChUwK7n3DZjwDLMMie99upe23oXqOVcUBeTidzp2v5vdfewznUmBUh3/84BLs4IM0R9pFYXGs8qMIJOCBQSogcLhb4eGUdEHg1WlGULieB3YgOXBZDOAd1Ur2Aq1Uo/VNXuQq/jaj6lz9eh22UYMg/BpNdHcoBlejvuR/CvfMBr8rNqqguQhrBHzAxG8p9ijr7jwbqlUrSgwBpc7Gs2bFQkojB+hEeYMVWgk6ITtwNYdefgzrRbw/l5t33gsvj+SbjnKPo+3frAl/oe0Yzs0blBz1nFDdjufOjDk6+9jBazPOpx/byu7+tGG9R7Vz7gOTVCckoWHsgCqcfAFbj60uC/+1vjvQt5a6U7M5ejapcGUQ3JttLUY7ig3V0DOwC5bJ4w43NwB8hEqi6L0CzqQyGrBE5npwuxjGN5P1f2EqzdejoJr7uSiy6DwxlPUg9kPlDdv/foNAH6L6nlMjf4TVBJw/FBJh1GfsP2aSx6SbhhbeO2sD6fXGL3ZITBDxjMHZgvaJKyy22//LuDSsgmgcKsAl6mWDlQKNUpLBmAAW6i5FnIqSWyXkMto5o8EW2aM8rXD9gA8J1ss94LSglkEKW5X1sG8GlTK8K5tQFLAJr48dA87wY//HgHUXql+1YpReDLgnPMbOS/mXZy2MDlHmh8Q6subFACtiIABT+JkOCSuZlp/LfJdvHxAYKXBVdXfYM3JY/vkKGrnvuq8zqdO0L1yH6JOrLzcP8Yf45PRKWXymwJtkun0K5hK+VPQDeuKD7r8ndU2GsN0I4Ih3IoDSsW0Eb4q0RSqfB5d8v3e6zh301MdjqWCpgchigvRqDS/FzkdmLtpavwyi4ckC+1CMsCbv6+D9rsfjeuw97iKPibsi0R+OJmta1hKrDIK/R33sgV6M5G2sFRUeZglsw9REotawuJNJXgnCTUkD9kWE6JKq7WjqWJ2u0zzten3CdVVi7ByEVZtXvsQ0TbAtVb+XrStdFmHf+VuQRpTCJ2ns8TNDFgs90wgKJ+okb/rIiCyoMJ6OK9KvuAVoLDNgsuMh2QeWvzZAhjF5q+e/8Tel+BYqRkb+SOtLQUjUEl+lAbYazVgP+sFsPcaCywNe8EpHdlUmI2emYPNpsp9qcuzW7kjiotx56hCHQN4Oph0jNf1HL7JhyumCxfraUzfhwVLN1NeU3sohva4zPYL63GZ3Sekx2XWdHS7AEq/u4yOzbhNqm9/fDTFZ3OrhAcebrUbo/KgsoemvAYG5njilDovgwf1lAlMcTGsE6AGOAVLXLQ09OQNiERIOymMBUom1XnrLYQ1Rx/w+hqxhTJvtdH62fH2ti2xRwHliwboTsnk4IHJE0Mx5aPRKOZieBGPgZ/HfHjG4/OT87OLi/R0cnL+bAfR5Wpzynbfx/b3CT4/v9KfXmpcshcSc+HshU8+D9jzsmtnM4qq7eKeKOpOSjwEb1GjaZ+3UT4K1rZP8T86KmXY/1VZLXYWKGlnSYhyonalfgoyvR4gJh0Y5H18p/FlO1Zv3okJZtpbMQktfZcVZp0BcMnJ4af4M14eqdKsECjR/UIoWwxYu3ZnUl+i9H170CLdlX2VzuGqF6cha0OUeGm0ug6/qG5tjz9lfo9r7kUyYOdjFcX7U+Y+6foYjq6PGPV5PNnwxGZawb3rId7i7LIaonzkJ8NWojQt67sPfDyi8BXgsC312Hg6mL5zM7CN8t46WOVTOB0Hfp9A9kZYu+sI3jdbROqaDDp9fy5Ym+0t5fKNZ3rZKG+gWq5dxQ21b3/vaAJuWVbzdS9EM0bwYzaoiAyazNuw9m6dHwburw5pl2Bol1IKH5rdoenwe5pzLw8Ea4JBMPqKPQpzHtWdBEpjS+ZcOleOsqVWmXAr0wf2zjmV+ZXyu7Q2ycg4zIVVAMI29FBwAzfYHyXflqE4fAt19PXBDP+IZeGlnLmmtGjo+8QkVlmoMawU1Rq6B4zRkyWxPUjeiTl7BBjDZ1SZnjpmixzbt5kg4yhbdTP8QRyVNPgM6A+PQ3eKHxqQ/Yaik83aVS4mjXXJ/QpeXuFcpjplL2vSSpB+mCYTadzs8F1eUF59ymh65RoHDUplE94AJJmzX5q2qgW9jxEfjPfzEYfx2cl5LDh/Fo9BnMcXT2EYn1yAeCqGABenT3eINMqG3cMpzTLOXkn35zWG4uh3CuQchTm6awwfLN3hWScbhi3t2ruIVao5MGGDo/ODOTUS55Pp2SiNJ3wyjcf8ZBRfjJ6N4tPxEEbiWcono4sdnLqfFHptueQz9jcwmVQVm5Av2YpYtAzdK/txqLSpQVlvT1dxj911O9trtXaWsAZrtHnTm0WXG5FUzqXaWR/aGnZvbw1ndzxG/B0UZsA+AnzFUJNyM2q9+zvwTajLoEkle3+wq1RutEva64ZCbXdItroV4y3F7tgsORrt2+rYNzo2Gx37LtK+i7TvIu27SPsu0r6LtO8o7LtI+zPvu0j7LtK+i7TvIu27SPsu0r6LtO8i7btI+y7Svou07yLtu0j7LtK+i7TvIu27SPsu0r6LtO8i7btI+y7Svou07yLtu0j7LtK+i7TvIu27SPsu0r6LtO8i7btI+y7S/WPSfRdp30Xad5H2XaR9F2nfRdp3kfZdpH0Xad9F2neR9l2kfRfpP7yLFMtoSgCv8abnhYsXJ3GVS6j+lUgRN8LnZMdUlqcnmETwZfQ/8X9hJ1l89fZ1/N9VKE1iQ8AMuCCLou6x7HZSgCrm2JswGo6exsOz+OSp/8veU15k+LejG5/frv/Fb4dWkArtcShZY+S8YFdvX5dROMat1amkVCxZ9NTehgOwo4962xReB1kXHA38mEaz6CPLPs2loiReY+0DOyt5LuMwU6rrfw8Lxo2PnyAMbNPzLlXgcDstGHibc1JNbY6go0B/hbjsd6mzdHXY0XfUbDuS29vPg9JH+ZsW5DV05+7dUdttAGq38TSit7sbbKjTsTAG33F5rIFCv3Sj/bVmsO9bPfCMGufjl44zvgLzhCI7mP1DB5v2V2ymlxQVtuAz/FMJGXXchYaSff7o+u3anwvf/kaqP8de/0Hxn4CLIMksYGg9GkQvbzBkzbDVqPnX7f272vJ+ljOZzijdZsAVRlEkAePaUgm5kAJtYOotLCwcsTch4OYBDVjAM2BrcAZsC5o2mwJltxv/0nzFkCqe0CbjquobC/0m1OPq/fcZZMLvDTydofBMy6Bg40/XVztMtM6Aq7UtXtNlw9izAV/x5paa4WQfCCGJQUqaJIfNkX6/Zcg//64nTwaks7Ed2BRw5OUZ5b+Us4mHvge1nkS8jvXs/2C8/sm7yFnZNMxvcrzBuG+acTlvDE0xjEH5jfCHrDVS6aOBcDeUNzia+dGB9YEqUfh02d1rvKjGMtrc+10I3DquBDeCVcv5pJIoQmymukm3g2g5xuYMvrUlsHxCBhbJaDgaJsvx+ntAMdMRLx/H9BLwymcr1phNlZppCrkLZTI+N+S7mEvF2UCZ8CzTS3TPGvCoyXoTY3GzujPYdwo3ScTdH+UGSjSP2OPcQIw/lZB9XbeA3EDKOyApYtfotzzsvf0j0N22W4/rFF3roLuy83P5R9BtDvwrcLuKqRG+oUPf85t3VAnQHoaaNtYLMEYKJN1DeeXP8X2wf+DGgbL+Xn8qYxg3MamUuNEwHwdw3hjFzumgaiJyXNrzjF3y63owiobmoC4l1cB1ijZPa1NWT99AIWr+kJohy5BMPjeLLqPjxclxZSMef2sZJLfHXTuRiseCkViYDA3BoIJ5Lr0GjgXMSQ1vEAhz3Tkcv17sM1D4NVK6ZeGNa741lG3atmaOXyPxFtLCSLd6hwaMt1FCBOwqRdv6qkBuVO8DNy+NW9IewM2G9xKWiKmdlfHCzVBAl7Uag+gdFdh9zw5+hS0b3A4iNMx+rU26l6XebZhgd1sqa4ZKbY9sUNrDpn71VuMGZTfsqpxhW3sMu5K9JcDvFLTD7UJuSFF7X3RW+lDkx6B9j8+kYkzDAxlEaDDZN9N3YBYyhcYFrO1K+kUUxzTwWOCJoMkb089YIWDD1LXmachIjzrNCMcjy14GscHKWl10PYROC3Ro6XT/Lfx6G+4TIcFfeFHuyn7FX0ESot2+qABfUPj2P+sHg5ck19bNuWqs88GXOzSKsUInDrYo1J5Fi45vtXMQ5ttWNdfjj+MnLTu6s94GTevHblW4+OuObKpzuGRfKsHUEkmXSyMdfKl/W42DG3ecZ1zS+yNJ8i2Iuk/R4oSYVXezXHb9r7a8+4ytM9bh1G/f0P38YLLbW/z4jwLQ9//0GaWuoWpfkolCkpcuosspzyzs4ODjX4MSfMJ2uHYbqSo79dWqIfSj8GsDOi6l7//xzvphAP+lXfAtnPUc3Bz2qBhdK+Pnnlnx+5ZRsO441zOu6JrvHNvU1G8/vI8G0ST46nNNBozhS3T6+dKfepn0QmceP/sWZVxdFz765JdEGcDb6qdSN+Efjd8h075X3775Ee/1V1C3t9U1c/gzRapu/xeXl26B +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"; + + + + + + + + + + +Updates federal tax (W4) information for an employee. Only rev_2020_w4 format is accepted for updates. + +scope: `employee_federal_taxes:write` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/put-v-1-employees-employee-id-i-9-authorization-documents.ParamsDetails.json b/docs/api/put-v-1-employees-employee-id-i-9-authorization-documents.ParamsDetails.json new file mode 100644 index 000000000..230d65c22 --- /dev/null +++ b/docs/api/put-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/put-v-1-employees-employee-id-i-9-authorization-documents.RequestSchema.json b/docs/api/put-v-1-employees-employee-id-i-9-authorization-documents.RequestSchema.json new file mode 100644 index 000000000..fe1d2057e --- /dev/null +++ b/docs/api/put-v-1-employees-employee-id-i-9-authorization-documents.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"documents":{"type":"array","description":"An array of I-9 verification documents","items":{"type":"object","properties":{"document_type":{"type":"string","description":"The document type"},"document_title":{"type":"string","description":"The document title associated with the document type"},"document_number":{"type":"string","description":"The document's document number"},"expiration_date":{"type":"string","description":"The document's expiration date"},"issuing_authority":{"type":"string","description":"The document's issuing authority"}},"required":["document_type","document_title","issuing_authority"]}}},"required":["documents"]},"examples":{"Example":{"value":{"documents":[{"document_type":"us_passport","document_title":"US Passport","document_number":"F12345678","expiration_date":"2026-01-01","issuing_authority":"USA"}]}}}}}}} \ No newline at end of file diff --git a/docs/api/put-v-1-employees-employee-id-i-9-authorization-documents.StatusCodes.json b/docs/api/put-v-1-employees-employee-id-i-9-authorization-documents.StatusCodes.json new file mode 100644 index 000000000..04a9714be --- /dev/null +++ b/docs/api/put-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"},"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/put-v-1-employees-employee-id-i-9-authorization-documents.api.mdx b/docs/api/put-v-1-employees-employee-id-i-9-authorization-documents.api.mdx new file mode 100644 index 000000000..cbbc43ed6 --- /dev/null +++ b/docs/api/put-v-1-employees-employee-id-i-9-authorization-documents.api.mdx @@ -0,0 +1,78 @@ +--- +id: put-v-1-employees-employee-id-i-9-authorization-documents +title: "Create an employee's I-9 authorization 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: "Create an employee's I-9 authorization verification documents" +hide_title: true +hide_table_of_contents: true +api: eJztXFtvG7mS/ivc3gcngNoXxYkvDwebiZM9fsjEmCQne5AEbaq7JHHSTfaQbNmaQH9kX/Zx/97+hEUVyb7pYkuxH+YgAQaTqMnix2Kxbizye3QbTypjVSykhYnmVigZ23kJ0fnnCIoRZBlk0ddBZPnE4G+X8Rn7B2gxFik1xm8aTKmkAROdf4+Gh4f4vwxMqkVJTc6j17e8KHNgoWU0iFIlLUiLbXlZ5p7cwe8GO3yPTDqFguPfHJqIa83n0SASFgrT+l2NfofURoPeiC8lg6LM1RxgzzBEPWuhZplKqwKHH0SlViVoKxz8qhJZi7qxWsjJEvUPU2AfP15eMDVmdgob6Wvg2TuZz6NzqytYDKLwLXFj3Ges0GXP1H9l1KtDTtj8R+hR98UggttSOElIMm63p9j0Z9R/MYiEMZWQk4RXdqq0sPOtiXoKrKGwWCBv/6iEhgwlk1auz90l9qzC8nUQ3cabBNxzNro8i1+6Xn+6nXIRlnlBfCMhJzHyAo9/nfG8wu0UZCs6GQ+fPTsZn8Vno5PT+Ph4dBZzgCwewfHJycno9Nkzfro0kfMo02IGOslFCm4HrWBq9PH9y2jFCkbDw+FJfHgUHx4ts+Q8uiDSe4YF4otBjfas3AmtMTJJuc424lwC8l6lgufsPaQVNmREYfF1gX8G0fHh8bJq+VVZ9kZVMmNfJGNfJMoNigUYCxkqHFXpFEUJDJPKMrgVxu6zt/wbMFNpoP1bajUTGWRuUwvDZjwX2f4XicJ7PBwuD/tRllqlYAwf5cBeS4twAwJhWMHnbMrLEiS7mYKkUUYqm6PGmKtKB4wM9SAX0jDQWmnDTJVOGTfsWkgCkXBrtRhVFhKSpOsBU5rIBQpjLnLDsgqYVYzLpifqNZKC6332HtxMP792w7ziFiZKCzBfn0ytLc35wUGmUrNP5mA/VcVBUP9xyeda5Tl9PyCYcVp3f8omlciAjZVmhdLAMrAICJm3hZa/m7s/mdtnbt8CtrWhmzAqr659879vYVeXqCbfADt4lPM1Y1CrO7X8+xJSMRZgcCH9ZqTuTKVppc0++zAvRcrzfM4sLv03mDORgbSuF7av1/Cg5JoXYAEFIOe4/61qSO7jZq5RbwENKWBbFC9HiaGWCaSC9vBSxiZaVaWQE8O4zFjKJRsBq4xDM6pEnrEU5aDw7adcZjnaNiGd9LZ8sX12OW4GEoZdS1JsiVvH6wGBc2vFbkSeB5FnnLmW7No3ZX6R5uxG2CkDp7LcR2JNgfttcg97fxXm66WR8ZGqbGvtYjYBCbpZNU86MMNUesxTxxAuGcgM+aM9CsszbvndLt6rsLk15DDj0qK7wZGmF5C538neBAjJaE+jY0Jqw2ukUQ777I3SzBvwQYcE4SNWXbv/k4W7prUNv6CpvHbsHzXGZD8aRErCuzEZ/81zKarcCvSQiSLuo97GCz8vb7bwZWdX2Qg5CSNjN55lAj/x/Ko1EjqvK8ee39OP/ZUXEPxlz1E75W2xSZV2AUJmmFUkDS0G3z3CRyn+qKBRD5r0ZjMeUXTae6xV0RD83FCUVZ5HX+t2VZlYtblhR8+tamBsx4tebrJoPMy3XvrjT8JO43cSYmf8osX6Vm+97LimuDTovv1c87/+miOltQa7y4dPqHyUzOfOwWVio9nYZ5cWfy6VMQJdLKvYlM+A1XoohxnkBtfOm5FgKGq1EqVCp1XO9RMHNybnJ35HAvc0as9wRQMn0LdxO2gacfkt4WmqKmmTDHKwkFRyXMkMsqTkcwwVOk7M546vEY24yyzUJj5actailpmL3lQyE3LyFuxUZWzKDQujsXo0WoMOMIrz54mQJLopIi2VEQ+K7J/oBuCozI+KlhOjlxH4PANk++wqB26ApVNIvzknBT1WD4fxAjuiaV83BZ5jbmKeBIqPOgFkrx+QjQBkM48VAAthUEMlWlUWt816YL5FIqtiBHo1xJ6T3wH6m+vPXH/cE8HselxeEpJUybGYmBpa7WtuxbXl3m0wLy3DJbVMSWCNM1tUxrYdi9XAwmzH3NiwW5JcFMJuQLii8dYsfIOIPQ1GNJiZqirPEDP3nK0xJyVoobIGL8iszjOtQVk3WYltNS9fy4zST62dQxGUnXLJnrFCSTs16BOOK1tpcPhSVZRc4ubOKmP1PDGQQ0qJFMlFapJUZZA0jtlaxE3r7fn5K/Zl2HeFON4PoR/m8QEG0YQ/Kp6jFXnBMjERtdrZANcEAOYecI1IXdvt0b4XKWE1y2CPPViH1YoCEjUeJ6XKRTpPJC/uudbFTkwsVq1vH0QlaUdBVu8Xnqa64nmiN++ZTrMtNPdL149hv5pjoxxVOXpWNR5GAAWYNcBLIOOa+ETKJuvY67oN2lduc2fAUytmCNnRcDGux8BwAKbG45DVWYc5nBiY+yx73Xj7tX8dujKu4f4SMOI5lykkVXmHvlxvrTehesUlZUh59jstuxvNbF72qcpFhlod/3OAg1tBjuhDekWvnDKp3QhyKZhHgBbIL/56aFLZx4NVp5jJk14FbMBK77JpQFlVEtZCrc1jLWaPIoqXrk19WMYw7DKtHAbhU3KkuEY3PLR7SP6FPYwOP6uHqiE5CEuTeUAEHyj3KAwleygsFbKTBcbkcs+iObciAYn5I3TCrOapVTpRdNa3Flu/5fbbtCbg4r3Gv3FYMtqwJOWo+xzeZsMG/I/px/bmuMLMGcs1+e18bEFTrH8fL2C51/b8u6r96r0V9PaabdykJihPyfxGmYG0fhYhtXhf/J32P4S8Q+lOzKF1E9LgkUMy0coYTHeEwSVQMLDJ1/Ettnd3gGKE2qMIcUEPEnktuCJTVen7OIa7mbq/I/XWzpEw4VbM+gzyezxFO5g/oL65cvRbANwQ9fYYa/UnyMTjeFBNh1kfP/xSSO4P3TC3cGmNS6c3GJ3bkeEJGc8t6DVoE09lc9z+Q8CFYSNA5VYDDkctPaiUahSGHEAPtpKFysRYkNoOkEM28yHBhhOjcmmxHQDHyQ7LnaI0oGdei5u5sVDUjYIO7/sGpAVMMla64Jui/W77H1FAXUrNrpaM0pMeZ8FvRVEVfZym0iXHOT8i1Ne3KQB6ER4DrsTR4SFxNVfqW1Vu4uUjAgsOV4gBqOTgiXm6H3XPvppznc+9pHsdPkS9XHkYP8Z/xkfDZ1Q60VZoo1yl30DXxp+SbkKO1VbC36O20hkmifCOcCcPKCRTOgON9klXMmyP/vTd2Ms4N8+nXhwDtiofZ1I8a1xTs9t0ejA3z2kMGR6lJpbfPua00C8kB9yPxyy/ZTTebnNchn0PUWzX0D34NDtiGDRWyEL/gFx2QK+epKkM5iK2TLHfZ1ICi1o88bYRvHMKDSQH2VQjmpWSS0tT5+w2ueZL3XdJ1dVEWCDC6sGbGCJaB7ixyj+KtnNc1uNfGM1rY0qh83Sa2KkGM1V5loA3PlHr/K6PgKYFNdbteRX4giJAaZsZFzn3h3no8eczYJSbf/nq7+xDAMeCZWydHyllKBmBRvKT0MAu5YC9VTNgHxQW12l2wek4sm0wZ6DNtts09K3Dl0Ckd3ZEeTFuLRQlBbFWeZeO8aaeozJUECqZqmysxjF99wRDmCkmklulMbXHRX6/tB4X+S4pPS7ydqDbBxDi7pAdm3KT1F8fPpviTnPrAw9c3Ho0RuVBHlAtBhoKXHE6Og/Jg6bLCMZIDOsEkOlMwg0SDY6euIUsyYQZVdoAHSY159ZrJtZuvcXua+UWwrnVSu9nw95bR6KLQdlkjHWlHe5etEDTrqMmjguPPL3sMBvz4XAY8+zwND4GfhLzwxc8Pjk6eXF6mj4bHZ2cbZh0oFbQafcuvr874HP9a/vptMY5uxB4Fs4u3OHzgL3CQ+n9qM+VgALrI6qdIhCHwvUPqs951Ojal12Ue97bdkf8e/tBhzWLuylZQ7m/+0jFmprjG276MhKNhRRmmvgsJ1pXLCRwrtcj5KQ9g1yMbxXubMuawXs5wVw5LyYh0nd5YcZqAJscbb+Kb1F4hEzzKkON7gihbtFgzJLMpK5E6cfGICJ9yq5KZ3vTi92QtT5LfKOVnDAffffH+FOUO4i5U8kgMdYOWbw/RekOXZ/A/mSfHQ2fHT9/umKLTZWEneshrrB3qIYIm/zosHNQihUHuUg3ZRpWbp6schXgsO7osbV18PjOTsG0ynubZJU7wukF8PdJZK+EtbmO4EP7ekBTk0Gr79YFa7Odpxz2eK5uWuUN1t93WVvc0MT2O2cTcMhQzdcXiHaO4GEGqCfpLZnzYc3dNt83vL85pFG8ox20FG40s8HS4Xfqs1MEgjXBkDH6xPZ8n73mJoFUrARdCGtDKxOsyogbkT5ydM6pzC/o7+BtkpOxXQgrATLTskM+DFzhfwS+3fji8DWzo89bM/wTloUHPTOhY1HtXVbdFGoc1oZqCd0j5ujJk1ifJO/lnB0CzOEzqkxPLTNVWSptWUbOUT7vn/B7dRTm4E5AHzwP3St+aEF2A2a906xN5WJCG5vsVvDyBvsy2St7WdJWGdmHcTIS2k63H+WCztXHjLrXobG3oO46IjmApHPud0xb14Lu4sSHO39DDscvjk7ijPOz+Biyk/j0ORzGR6eQPc8OAU6fPd+g0ug0bIegNM85eyPsnxNMxWVU8ctRmWO4xnDDkgxPe6dhBtBHpBCxPmr2TFgR6Dwwp4bZyWj8YpjGIz4ax8f8aBifDs+G8bPjQxhmZykfDU83cGo3LXRpuOBT9gvoXMiaTciXfE4suvG3V+7HoeBTgzTOn67zHpvrdtbXam0sYfXeaFvS20WXK5HUwaXcWB/aabZztIa9exEjwyPYAfsE8A1TTdJO6erdP4GvQh2SJrXufeBQKQy0SdurlkFddAr4O7cV45XF7t3bwb8ER8HfDf4LewyLQfRby27cNaF/EQOyGES/1hbkrjn/NCU/TckPmJKFv/1ea69LnFtZ2Xh2FNcHkfXfEpHF4ixctvfvFISL9mbXdzJcpaptvcngiuXCITbqzTpKphSy+0KaxV03wZ+F9je1rONFByU2vVH6W0irfJRUcErZFrzx/EV+NF0MzMeTeIO0VAIfsVBsAu5+WX23qfNihruUS5rbDNjNVKRTupU643qOV2d8xbCS7Vkga7pQXf6RQP2N/d///Pf/stcz0PPax/Yq2F3FRUq1Os7xdpYat/gYLqyFY/39L/JvSLZLkW4yi9ZUXb4e54M3kGEmVGVWLx7TkCqdNSNBM9IXaVJVwjm77guNOS+45BO4prvmdebD7RPS4K1iCEotCEkGirRuc9LiLhEuvefiL8Qt7npapakCHdTD/lf8n/Rozcury/gf9QkSDT8FnpFZbACMeW6gP8wFzqUQ0l/vRsUeo7XN2Mury3CKxLgx+CIFiiFlpOh6NjbAG+l0N1uiOyMa4R+4Nq3HDvYM+1wISUUoLdpbvgzASxH7nkJO/t0TjFs/P0UYeM0crfc6dmPFSFXghcTh4fB5fPgiPnqOd4ozGPMqt+6lkPD7YvF1EFJmv6iMklj9dd32GZ/6Pmr3VmmjoO666PjSlxihfKxXV5tuP68eeYfXeB7kCR6ni5YkzW4cx7v3O7/1E8KDv+xjP7u88rNYR8TQld3Nz/d0RPTzkthElUmwpg3TPasetvn4nl2t+BzWMXpD2fwXJ6frXu95Ub/es+45neAq4K1aUwL/BtzMY3qMAl2Xs86jRt1GqFZjNQOtRUaZVsrDXbQ2E9xakIZytzh75yCtfTtsUD961HpDDPV36NfHV3fo41zdqYu36dzHjfrLn3eSx0R2zE6j8+hgdnRQ+04H31t2bHHQN4QHba1CxZneCFY6R4vj1TgvhdPicQYFqfIlMb+AQvVY7+jF7oQXP9PTS6sJr6R5pek0dx3NEj8jH4x/U4mQ+0jxZYpRKz5pFZ1//tpu9R71ttsLK9rW2xkhBmuD/x4B12R9+y91EImYLpXTrkYfsF7i6D2Vuf7ICI7CmgEWgwjt0W+NJWvt783butFX/R29/KXezI2tXdrJ9adVuzi4RO5UyxVlhuHI4UH/AcU9VN60jfUgQofGvBu/Bz0TKbQEqPEt6KGWA2p4kCGv0BLG9G+soDG+69LjApCnqqDCIsKxZ9hrv69ZqGVH1yawgqb8b/75J+4OCr3rdhFGZb/hEz3+NMgV3eAO8F//oxF4XL5SGVtw2aLzyt2g4kvhS9dPX+sddCb4vXFjfgZEPwOiewVEXkFYuLUHZc4FKTJS3N+9kfkczY5ItpvLeee9gKk3Qkub0Es/U2Us0vn+HUOTjzpfLPDnPyrAdMTnr2j5NN1kcMpLUAZyTcjTFvInv3k36ClbG2+tmWJwzuW8ZXgj/yRKJyB0NxtdPLYdvH/x4GwlXx3/Vke2NZsbd+iVY1b8oeNvLcdgTQ80r6Xd2LbtLl19/BANopEP+wpFjqHmNxha8xu35uE4H+NC/O17lHM5qVwizJHEP/8PCRUvrw== +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"; + + + + + + + + + + +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. + +Use the document options endpoint to get the possible document types and titles, which can vary depending on the employee's authorization status. + +> 🚧 Every request must contain the complete list of documents for the Employee. +> +> Every request to this endpoint removes any previous verification document records for the employee. + +scope: `i9_authorizations:manage` + + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/put-v-1-employees-employee-id-i-9-authorization-employer-sign.ParamsDetails.json b/docs/api/put-v-1-employees-employee-id-i-9-authorization-employer-sign.ParamsDetails.json new file mode 100644 index 000000000..e7238297a --- /dev/null +++ b/docs/api/put-v-1-employees-employee-id-i-9-authorization-employer-sign.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-client-ip","in":"header","required":false,"description":"Optional header to supply the IP address. This can be used to supply the IP address for signature endpoints instead of the signed_by_ip_address parameter.","schema":{"type":"string"}},{"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/put-v-1-employees-employee-id-i-9-authorization-employer-sign.RequestSchema.json b/docs/api/put-v-1-employees-employee-id-i-9-authorization-employer-sign.RequestSchema.json new file mode 100644 index 000000000..76e5ed992 --- /dev/null +++ b/docs/api/put-v-1-employees-employee-id-i-9-authorization-employer-sign.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"signature_text":{"type":"string","description":"The signature"},"signer_title":{"type":"string","description":"The signer's job title"},"signed_by_ip_address":{"type":"string","description":"The IP address of the signatory who signed the form. Both IPv4 AND IPv6 are supported. You must provide the IP address with either this parameter OR you can leave out this parameter and set the IP address in the request header using the `x-gusto-client-ip` header instead."},"agree":{"type":"boolean","description":"Whether you agree to sign electronically"},"additional_info":{"type":"string","description":"Any additional notes"},"alt_procedure":{"type":"boolean","description":"Whether an alternative procedure authorized by DHS to examine documents was used"}},"required":["signature_text","signer_title","agree"]},"examples":{"Example":{"value":[{"signature_text":"Jane Doe","signer_title":"Admin","signed_by_ip_address":"192.168.0.1","agree":true}]}}}}}} \ No newline at end of file diff --git a/docs/api/put-v-1-employees-employee-id-i-9-authorization-employer-sign.StatusCodes.json b/docs/api/put-v-1-employees-employee-id-i-9-authorization-employer-sign.StatusCodes.json new file mode 100644 index 000000000..38089d939 --- /dev/null +++ b/docs/api/put-v-1-employees-employee-id-i-9-authorization-employer-sign.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"},"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/put-v-1-employees-employee-id-i-9-authorization-employer-sign.api.mdx b/docs/api/put-v-1-employees-employee-id-i-9-authorization-employer-sign.api.mdx new file mode 100644 index 000000000..61193f6d1 --- /dev/null +++ b/docs/api/put-v-1-employees-employee-id-i-9-authorization-employer-sign.api.mdx @@ -0,0 +1,71 @@ +--- +id: put-v-1-employees-employee-id-i-9-authorization-employer-sign +title: "Employer sign an employee's Form I-9" +description: "Sign an employee's Form I-9 as an employer. Once the form is signed, the employee's I-9 authorization is considered complete and cannot be modified." +sidebar_label: "Employer sign an employee's Form I-9" +hide_title: true +hide_table_of_contents: true +api: eJztXOlvGzmW/1e4tR/SAVS2LCu+Pm06Tu94gSRGjukdJEGZqnqS2Kkiq0mWbSXw/754j2RdOiw5NrDT6AYG46h4/Pj4+G7yR3QbzypjVSykhZnmVigZ20UJ0dnnCIoJZBlk0ddBZPnM4G8X8Sn7J2gxFSk1xm8aTKmkAROd/YhGwyH+XwYm1aKkJmfR61telDmw0DIaRKmSFqTFtrwscz/c/h8GO/yITDqHguNfDk2kJn9AaqNBb+SXkkFR5moB8MwwRMcrO1dafHfwBlGpVQnaCgevqkTWGtVYLeRsadSPc2CfPl2cMzVldg4rx9XAs3cyX0RnVldwN4imShdJd/zPzQSyynMk1uaJflO6YNwYlQpuIWM3ws6ZnYsVS9tjnwy4b9TqS/TaE4JGMV8i9vLygoHMSiWkNXurMF+DNsJR/H6KpJXWIC3znQJmtzN77AMA/fuz/y7kjM0qkcHXX+bWluZsfz9TqdkjhttLVbEfGCwu+UKrPKfv+yKDolQWZLp4zqZKMyGRtLRopiSbqxtmFavC6qcC8mzl6jr0SozltjLbLbXFU51BmB9kEIGsCtzgVFjxHZAhpJLNP0rQBZcgbaLBiAw5fRDxXICMvt4NokylVYFfHZSd+CX0fWbqPxl1b0BVJhUmoekSDTNhrDvaiayKCejIM6s4Hbs/QcxkUnJjSqUtAZxzk9Qgfa8WzIlSOXC5Fufvc7Bz0ExpJpVlnF31BrticCuMNbTBtI2hwV50N4jgthQecsbtT1CoGYjRQHcoeSpp9eLhY/oBkP+FMRWXKY3reUYnRswktKVMQ63VVLINx2k254a5ERqJcBGfruLvwKU/NSPsMiPPMoFD8TzBU7kDDV/KBWt6I1eAQarx3CalVilklYaHsBiXjOcWtORWXAOrx6oPLmRssmDn//iAUgNueSFks52G3XCDsiSL7u5wwX9WQiMpPztV0YjINeJked+X9+XrILqNN2lQK2yO23ZxGr/sqBk6CqQ7SXB5PYp/XvO8Qjr9aGR4dMTheDo9Hg0PhseTwxdHk+nB4eTgaHg0PRpORuNpNPD6Lzqejg4Pj6en8enk+CQejyenMQfI4gmMj4+PJyeHh/wk6qi0KH0xHo6PpsfxwQTG8Th9MY5PDk7H8XR8Mh6lh8P05ChbR6QzL/qWBN+y8FkjepD/VoiFaDQcHcfDg3h4ELVOdnTJJS/4is05m/LcwIqj439fYvDoLXHqEqNS+7uvd/jfIBoPx8tWz1tl2W+qkhn7Ihn7IlGMIIOBQdWuwahKp8iKYEhKkkTcY2/4N2AGORhPY6nVtcggc2aCMOya5yLb+0K8MR6Nlqf9JAmmMXySA3strbCLGoEwrOALNudlCZLdzEHSLBOVkTxbqEoHjAxNNC6kYaC10oaZKp0zbtiVkAQi4dZqMaksJMSNVwOmnGgJI0y5yA3LKsCjx2XTE00y2serlt3w2k3ziluYKS3A7Gg4EMw4rbs/d+YHqZhCaWAZWASExNvBAL2fun8Tt0/cvtHelqtuwSj2uqa5/71RYlxrvogGkbBQmFWuwNKoyTfADh7lYs0c1OpeM/BDCamYCjC4kf4wUnem0rTSZo99XJQi5Xm+cAbMN1gwsvRcL2xf7+F+yTUvwAIyQE6mvVXNkGTz1Kh3gIYjYFtkLzcSI0vdDxWkh+cyNtOqKoWcGcZlxlIu2QRI+SGaSSXyjKXIB4VvP+cyy9GOF9Jxb8tN3GMX02YiYdiVJMGWuH28GrScA3Yj8jywPOPMtWRXvinzm7Rwngw4keU+EmkKPG8zuJ8yl2G9nhsZn6jKtvYuZjOQoJtd80MHYphKT3nqCMIlek9IH+1RWJ5xu4VX+iocbg05XHNp0fjkOKZnkIU/yV4FCMnoTKOZSmLDS6RJDntojzFvBAw6QxA+ItWV+39Sqle0t+EXVN5XjvyTRpmgt6QkvJuSAbF5LUWVW4HOO40oSBd2Dl74efmwhS87HOnu3EbIWZgZuzXa+bI1k7MNVsy96LlX67jmLS8geLOeonbO22yTKu1iF5lhVjkXpSHw/TN8kuLPChrxoL3fE+ajEZ30nmpVbLCr63ZVmdhNBvjdIOrIuVUN0Dzb5FyhaRNs0zee++PfhZ3H7yTETvlFd+tbvfG845oKsvj/3vO/wp7jSGsVds9RQ+GjZL5wBi4TG9XGHruw+HOpjBFoYlnF5vwaWC2HcriG3ODeeTUSFEUtVqJU6LTKuf7FwY3J+InfEcM9j9orXNHAMfRt3Ha8Jlx+S3hKDkaSQQ4WkkpOK5lBlpR8Qa5k24j53LE1ogl3Qc9axUdLxlrUUnPRb5XMhJy9ATtXGTnoYTZWz0Z70AF2jW7lIhGSWDdFpKUy4lGR/QvNAJyV+VlRc6L3MgFG8wvI9thlDtwAS+eQfnNGClqsHg7jBXZE1b5uCTzH0MMiCSM+6QKQvH5CNgGQzTpWACyEQQmVaFVZPDbrgfkWTcxtBcSekd8B+t71Z64/nomgdj0uzwlJquRUzEwNrbY1d6Lacu82mJeW4ZZapiSwxpgtKmPbhsVqYGG1U25sOC1JLgphNyBc0XhnEv6GiP0YjMZgZq6qPEPM3FO2xpyUoIXKGrwgszr8uAZl3WQlttW0fC0zCka2Tg55UHbOJTtkhZJ2btAmnFYWYw2EL1VFySUe7qwyVi8SAzmkLqjLRWqSVGWQNIbZWsRN693p+Rb7Muy7gh23Q+ineXqAgTXhz4rnqEWOWCZmohY7G+CaAMBsAdeI1LXdHe0HkRJWswx27ME6rFYUkKjpNClVLtJFInmx5V4XDyJisWp/+yAqSScKsvq88DTVFc8TvfnMdJrtILlfun4M+9UUm+QoytGyqvEwAijArAFeAinXxAdSNmnHXtdd0L5yhzsDnlpxjZDdGM7H9RgYTsDUdBqiOuswh3il2Wbb68a7733IIRrGNWzPAROeYxokqcp75OV6bb0J1SsuXR4p+4O23c1mNm/7XOUiQ6mO/3OAg1nhck+PaFS8csKkNiPIpGAeAWogv/nroUllnw5WHWImS3oVsAErvcmmAXlVSVgLtVaPNZs9CSteuDZNngrdLtOKYRA+JSeKazTDQ7vHpF84w2jws3qqGpKDsLSYR0TwkWKPwlCwh9xSITtRYAwu9zSaMysSkBg/QiPMap5apRNFqby12Potdz+m9QDO32vsG4clowNLXI6yz+FtDmzA/5R2bG+NK9ScsVyT3c6nFjT5+ttYAcu9dqffZW1XP1sx3rPmGDehCYpTMn9Qrl36/CslMl1ocVv8nfY/hbwz0r2YQ+vGpcGUQzLTyhgMd4TJJZAzsMnW8S12N3eAfITaogh+QQ8SWS24I3NV6W0Mw4epun/g6K2TI2FGie0eGn/GU9SD+SPKm0s3fguAm6I+HlOtvgPma6ndo0o6jPr46Zdccp90w9jChTUunN5gdGZHhhkyqgVYgzbxo2z2238KuDBsAijcasAh1dKDSqFGYcgA9GArWahMTAWJ7QA5RDMfE2zIGJVLm+0AOEp2SO4EpQF97aW4WRgLRd0oyPC+bUBSwCSugGsLO8G1/xkB1B2pOdWSUXjS4yz4rSiqoo/TVBorEbayrh8K9fVtCoBWhMeAO3EwHBJVc6W+VeUmWj4hsGBw1XWEWHLwi3m+F3VzX01e53Mv6F67D1EvVh7mj/Gf8cHoEFfYEWiTXKXfQNfKn4JuocZoa+bvjbbSGCaO8IZwJw4oJFM6w+ooxXQlw/HoL9/NvYxz83qaghOwVfk0i+JZY5qahy2nB3PzmqaQYSo1sfz2KZeFdiEZ4H4+Zvkto/ketsZl2Fuw4nW7ZOuxl9lhwyCxQhT6J/iyA3r1Ik1lMBaxY4h9m0UJLGrxg7eV4L1LaCA5yKaa0KqUXNqaOma3yTRf6v6QUF09CAuDsHryxoeI1gFutPLPou2ky3r0C7OF4joMofN0nti5BjNXeZaAVz5RK3/XR0DLghrr7rQKdEEWoLDNNRc598k8tPjza2AUm3/56h/sYwDHgmZs5Y+UMhSMQCX5u9DALuSAvVHXwD4qLK7T7JxTOrKtMFtV7TubTbX70tR9dnJHFBfj1kJRkhOLlehk0jHe1HNUyJxocqjKxmoa03c/YHAzxUxyqzSG9rjItwvrcZE/JKTHRd52dPsAgt8domNYgFl/ffxoisvm1gkP3Nx6NkblQR5QzQYaCtxxSp2H4EHTZQJYRErFxUh0JuEGBw2GnriFLMmEmVTaACWTmrz1moW1W+9w+lqxhZC3Wmn9bDh764boYlA2mWJdaYe65y3QdOqoiaPCEy8vG2ZTPhqNYp4NT+Ix8OOYD494fHxwfHRykh5ODo5PNyw6jFZQtvshtr9L8Ln+tf50UuOMnQvMhbNzl3wesFeYlN6L+lQJKOq67geicP2D6HMWNZr2ZRflM29tuxT/s70gw5rN3RSsodjfNlyxpuYYi957PBJNhRRmnvgoJ2pXLCRwptcTxKQ9gZyPT5X5wrJm8l5MMFfOiklo6PusMGM1gE0Odt/FN8g8QqZ5laFEdwOhbNFgzBLPpK5E6efmoEH6I7sqnd1VL3ZD0voo8Y1Wcsa8992f47soH8DmTiSDRF87RPG+i9IlXX+BvdkeOxgdjl88X3HE5krCg+shLrF3qIYIh/xg2EmUYsVBLtJNkYaVhyerXAU4rEs9to6Ou5IHplXe2wSrXAqn58BvE8heCWtzHcHH9vWApiaDdt/tC9ZmO0s5nPFc3bTKG6iWa1NxQ+PbPziagFOGar4+Q7RjBI8zQb1Ir8mcDWvu1/m+4fbqkGbxhnaQUnjQzAZNR/dpsM+DPBCsCYaM0Sf2zPd51twkkIrhtUNhbWhlglaZcCPSJ/bOOZX5BfkdrE13yWonF1YCZKalh7wbuML+CHS78cXha1ZHn3cm+O9YFh7kzIzSotqbrLop1BjWimoJ3RPG6MmSWB8k78WcHQKM4TOqTE8tM1WJ161YRsZRvuhn+L04CmtwGdBHj0P3ih9akN2EWS+btalcTGhjk4cVvPyGfZnslb0sSauM9MM0mQht57vPck559Smj7rVr7DWou5xKBiDJnO3StHUt6EOM+HAVcMRhfHRwHGecn8ZjyI7jkxcwjA9OIHuRDQFODl9sEGmUDXuAU5rnnP0m7PcZhuIyqvjlKMzRXWN4YImH571smAG0EclFrFPNnggrHJ1HptQoO55Mj0ZpPOGTaTzmB6P4ZHQ6ig/HQxhlpymfjE42UOphUujCcMHn7FfQuZA1mZAu+YJIdONvr2xHoWBTgzTOnq7jHpvrdtbXam0sYfXWaJvT20WXK5HUzqXcWB/aafZgbw179zxGhinYAfsd4BuGmqSd09W7fwFfhToETWrZ+8iuUphok7RXLYV61yng79xWjFcWu3dvGP8aDAV/v/jf2GK4G0TvW3rjvgX9RRTI3SB6W2uQ+9b8tyr5W5X8hCq587ffa+l1gWsrKxtfH8R1IrL+KxFZLE6TzgsBceeC/vJNVzGTVPrWvMcSnqfAy9LNF73H3snUxYjRy6LsE13tH3Qeu1j1SBC2TZXEZ1o0ZC3x1DGiQ2nE3hf5RZpUlXDGrvrLMWcFl3wGV/gETPDI3f6RZGkl6cnlFZIEJ0mDJgPgLrctPYHkL2rd3feIUFOdOKinDe88pfgOg40p8kOTz4FnJKyb6f1TCN1J3pX+5Q7XAcUy+hC5u8l6cRliZHgBWZj+3eKVTV0dCcXx8bWD+qUiJqSxwLOwHrePyWSRiDIJfWvqokZYS6oWBf43/m+iwMvLi/ifdW5nJxqc43z4fIi7eI0iN0Y9mNFLS+FZpP7zTXRxGhvgXXG6NS3R0BBNKevAtWk9Q/DMsM+FkFQe0hp7xzv7vBRx8xjTf/oB49bPzxEGbtImKjbvCo2Goxfx8Cg+eOHeY5nyKrfuFY7w+93d10EIZv2qMgov9Tn7wW9/de971qyTWLi191/I/DiHht0inwLDbKkzlrbtDvqZYX+oCXP9wjg9Bt1uvNZhaDG7y2vdzFX7WR6UanvsV2Xn7OLyesxevj3HP44oIendefTwMUdJZpbnrv6hc1fshX8GSLROEnv3HhmRzm4OmKVzd+c7bVAoomLojdqrSvZCwuVB8cPVkgC6Co38aafrsHymob0V971jhHCpDwkZVBaUe9ZKupcZok1vFq3bmB2fKroX5JO9UNQ7AD2GDtT8us0jQv2zFP0Pl8DOFfRHPYteZoWQ0Tqujw5OR3sHRyd7w72DGoJ7Pio8lnMbmxL4N+BmEdOLFGi/nHbeROo2Qgkeq2vQWmQtHao/OJMBbi1IQ9FbXIozkdY+bDioV9164BD1ROjXB1d36INc3akLtuncAY1C0qc7yWAic8HOo7No//pgvzad9n+0zIW7/b61sd83nqg+09sblc5RtXl9wUvh1EWcQUE6Y4ldz6FQPcK78WKX5MXPuOQ1A68c81JTQnfdmCV+RloYSCtNyYjPP4Kz+DJFxxXfw4rOPn9tt/qACsIx84q29blEiEGt0TkFrknN9x/roCFiuldOZxKTCfUeRx+o0vVnZnAjrJngbhCh4nvfqMzWAV06lrXI6h3K7u/Lp7L+3jqQq167atp1hZ1//60WoH5aMqnQQmk9lNYxBwYRmkzm3fQD6GuRQotzGuuFHmnZp4b7GRIJtXxM/8bqGeO7LslXyFNVkOgnHM8Me+1PNAt17Gg8BUlKBP8P//QTd0lCbxyeh1nZe3yex2eCXMENsr7/+l8Np+O+lcrYgsvWOK/DK35mvePSX8ePxh76t/Z3/JlARt0vcy7o8JCw+OGF2+fo+qD1PB6S+KznD/XG77/ghmbnXBmLY/34gbb3J53f3eHPf1aAnvDnryhyNRXRkzTJBAW/1tj0beL/8t7r1udsrUu1ZpnhAQy5aEn8yL/G0fH53KU653DsBu//tQe2kipdTdx2PWsSoULZngR/cQdsAxFXe68dMrqGrxyx4o8dW2fZz2p6oGYr7ca2bWvl8tPHaBBNvGtXKLLINL9B95nfOLYPyXT0/fC3H1HO5axyYSg3JP73f6Z2ipI= +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"; + + + + + + + + + + +Sign an employee's Form I-9 as an employer. Once the form is signed, the employee's I-9 authorization is considered complete and cannot be modified. + +scope: `i9_authorizations:manage` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/put-v-1-employees-employee-id-i-9-authorization.ParamsDetails.json b/docs/api/put-v-1-employees-employee-id-i-9-authorization.ParamsDetails.json new file mode 100644 index 000000000..230d65c22 --- /dev/null +++ b/docs/api/put-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/put-v-1-employees-employee-id-i-9-authorization.RequestSchema.json b/docs/api/put-v-1-employees-employee-id-i-9-authorization.RequestSchema.json new file mode 100644 index 000000000..c0163e740 --- /dev/null +++ b/docs/api/put-v-1-employees-employee-id-i-9-authorization.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"authorization_status":{"type":"string","description":"The employee's authorization status\n\n * `citizen`: A citizen is someone who was born in the United States or is a naturalized citizen living in the United States.\n * `noncitizen`: A noncitizen national is someone born in American Samoa, certain former citizens of the former Trust Territory of the Pacific Islands, and certain children of noncitizen nationals born abroad.\n * `permanent_resident`: A lawful permanent resident is someone who is not a US citizen and who resides under legally recognized and lawfully recorded permanent residence as an immigrant.\n * `alien`: Also referred to as a \"noncitizen authorized to work\". This includes anyone who is authorized to work in the United States but is not a US citizen, US national or lawful permanent resident.\n","enum":["citizen","noncitizen","permanent_resident","alien"]},"document_type":{"type":"string","description":"The type of document an employee holds, based on their authorization status.\n\n * This is unused for authorization status `citizen` or `noncitizen`.\n * If the authorization status is `permanent_resident`, this must be `uscis_alien_registration_number`.\n * If the authorization status is `alien`, this is required and may be any of the valid values.\n","enum":["uscis_alien_registration_number","form_i94","foreign_passport"]},"document_number":{"type":"string","description":"The document number. Formatting depends on the employee's document type.\n\n * For `document_type:'uscis_alien_registration_number'`, this must be a USCIS Number/A-Number, which is 7 to 9 digits.\n * For `document_type:'form_i94'`, this must be a Form I-94 Admission Number, which is 11 digits.\n * For `document_type:'foreign_passport'`, this must be the passport number.\n\nThis is required when the document type is present.\n"},"country":{"type":"string","description":"The document's country of issuance.\n\nThis is required when the document type is `foreign_passport`.\n"},"expiration_date":{"type":"string","description":"The document's expiration date.\n\nThis may only be used when the authorization status is `alien`.\n"},"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. If supplied, this endpoint will update the existing I-9 authorization if it exists."}},"required":["authorization_status"]},"examples":{"Example":{"value":{"version":"52b7c567242cb7452e89ba2bc02cb476","authorization_status":"citizen"}}}}}}} \ No newline at end of file diff --git a/docs/api/put-v-1-employees-employee-id-i-9-authorization.StatusCodes.json b/docs/api/put-v-1-employees-employee-id-i-9-authorization.StatusCodes.json new file mode 100644 index 000000000..38089d939 --- /dev/null +++ b/docs/api/put-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"},"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/put-v-1-employees-employee-id-i-9-authorization.api.mdx b/docs/api/put-v-1-employees-employee-id-i-9-authorization.api.mdx new file mode 100644 index 000000000..702fbf76f --- /dev/null +++ b/docs/api/put-v-1-employees-employee-id-i-9-authorization.api.mdx @@ -0,0 +1,89 @@ +--- +id: put-v-1-employees-employee-id-i-9-authorization +title: "Create or update an employee's I-9 authorization" +description: "An employee's I-9 authorization stores information about an employee's authorization status, as well as signatures and other information required to complete the Form I-9 for employment eligibility verification." +sidebar_label: "Create or update an employee's I-9 authorization" +hide_title: true +hide_table_of_contents: true +api: eJztXNty3DaTfhUs90JxaqjDaKzTxV+r+LDRRRJXbCf7l+2iQLJnBr9JgAFASROX7vZ+X2f3dfYF9hW2ugGQHA5npJGlqt2UXZXKaAaHD41Gn9DoL9FNPKuNVbGQFmaaW6FkbBcVRGcfIihTyHPIo0+jyPKZwe8u4lP2G2gxFRk1xt80mEpJAyY6+xKN9/fxfzmYTIuKmpxFr254WRXAQstoFGVKWpAW2/KqKvxwe/8w2OFLZLI5lBw/OTSRSv8BmY1GvZHPJYOyKtQCYMcwRMdrO1da/OngjaJKqwq0FQ5eXYu8M6qxWsjZyqjv5sDev794ydSU2TkMjquB57/IYhGdWV3D7SiaKl0my+N/aCeQdVEgsTZP9FrpknFjVCa4hZxdCztndi4GlrbL3htwv1Grj9ErTwgaxXyM2PmbCwYyr5SQ1uwOYb4CbYSj+N0UyWqtQVrmOwXMbmd22VsA+vuD/13IGZvVIodP382trczZ3l6uMrNLDLebqXIvMFhc8YVWRUG/74kcykpZkNniGZsqzYRE0tKimZJsrq6ZVawOq58KKPLB1S3RKzGW29rcb6kdnloahPlBRhHIusQNzoQVfwIyhFSy/aMCXXIJ0iYajMiR00cRLwTI6NPtKMpVVpf4q4OyFb+Evjum+cioewuqNpkwCU2XaJgJY93RTmRdpqAjz6zidOI+gpjJpOLGVEpbAjjnJmlA+l4dmKlSBXC5Fufvc7Bz0ExpJpVlnF32BrtkcCOMNbTBtI2hwW50O4rgphIecs7tV1CoHYjRQLcoeWpp9eLhY/oBkP+FMTWXGY3reUYnRswkdKVMS61hKtmW4zSbc8PcCK1EuIhPh/g7cOlXzQjbzMjzXOBQvEjwVG5Bw3O5YG1v5AowSDVe2KTSKoO81vAQFuOS8cKCltyKK2DNWM3BhZylC/byx7coNeCGl0K222nYNTcoS/Lo9hYX/EctNJLyg1MVrYhcI05W9311Xz6Nopt4kwa1wha4bRen8fmSmqGjQLqTBJfXo/jxihc10ulLK8OjIw7H0+nxeP9g/zg9fH6UTg8O04Oj/aPp0X46nkyjkdd/0fF0fHh4PD2NT9Pjk3gySU9jDpDHKUyOj4/Tk8NDfhItqbQoez7ZnxxNj+ODFCbxJHs+iU8OTifxdHIyGWeH+9nJUb6OSGde9K0IvlXhs0b0IP8NiIVovD8+jvcP4v2DqHOyozdc8pIPbM7ZlBcGBo6O/36FwaOfiVNXGJXa3366xX+jaLI/WbV6flaWvVa1zNlHydhHiWIEGQwMqnYNRtU6Q1YEQ1KSJOIu+4l/BmaQg/E0VlpdiRxyZyYIw654IfLdj8Qbk/F4ddr3kmAaw9MC2CtphV00CIRhJV+wOa8qkOx6DpJmSVVO8myhah0wMjTRuJCGgdZKG2bqbM64YZdCEoiEW6tFWltIiBsvR0w50RJGmHJRGJbXgEePy7YnmmS0j5cdu+GVm+YFtzBTWoDZ0nAgmHHWdH/mzA9SMaXSwHKwCAiJt4UBejd1vxG3T9y+0d6Vq27BKPaWTXP/favEuNZ8EY0iYaE0Q67AyqjJZ8AOHuVizRzU6k4z8G0FmZgKMLiR/jBSd6ayrNZml71bVCLjRbFwBsxnWDCy9FwvbN/s4V7FNS/BAjJAQaa9Ve2QZPM0qLeAhiNgW2QvNxIjS90PFaSH5zI206quhJwZxmXOMi5ZCqT8EE1aiyJnGfJB6dvPucwLtOOFdNzbcRN32cW0nUgYdilJsCVuHy9HHeeAXYuiCCzPOHMt2aVvyvwmLZwnA05kuR+JNCWetxncTZk3Yb2eGxlPVW07exezGUjQ7a75oQMxTK2nPHME4RK9J6SP9igsz7m9h1f6IhxuDQVccWnR+OQ4pmeQhT/JXgUIyehMo5lKYsNLpLSAXbTHmDcCRktDED4i1aX7PynVS9rb8A0q70tH/rRVJugtKQm/TMmA2LyWsi6sQOedRhSkC5cOXvh69bCFX7Y40stzGyFnYWbs1mrnN52ZnG0wMPei516t45qfeQnBm/UUtXPeZZtMaRe7yA2zyrkoLYHvnuG9FH/U0IoH7f2eMB+N6KT3VKtyg13dtKurxG4ywG9H0ZKcG2qA5tkm5wpNm2Cb/uS5P/5d2Hn8i4TYKb/odn2rnzzvuKaCLP5ve/5X2HMcaa3C7jlqKHyULBbOwGVio9rYZRcWv66UMQJNLKvYnF8Ba+RQAVdQGNw7r0aComjESpQJndUF1985uDEZP/EvxHDPou4KBxo4hr6Ju45XyuXnhGfkYCQ5FGAhqeW0ljnkScUX5Ep2jZgPS7ZGlHIX9GxUfLRirEUdNRe9rmUu5OwnsHOVk4MeZmPNbLQHS8Cu0K1cJEIS62aItFJGPCqyv6MZgLMyPytqTvReUmA0v4B8l70pgBtg2Ryyz85IQYvVw2G8xI6o2tctgRcYelgkYcQnXQCS10/IUgDZrmMAYCkMSqhEq9risVkPzLdoY24DEHtG/hLQX11/5vrjmQhq1+PynJBkSk7FzDTQGltzK6qt9u6CObcMt9QyJYG1xmxZG9s1LIaBhdVOubHhtCSFKIXdgHCg8dYkfI2I/RiMxmBmruoiR8zcU7bBnFSghcpbvCDzJvy4BmXTZBDbMC1fyZyCkZ2TQx6UnXPJDlmppJ0btAmntcVYA+HLVFlxiYc7r43Vi8RAAZkL6nKRmSRTOSStYbYWcdt6e3r+jH0Z9h1gx/sh9NM8PcDAmvBHzQvUIkcsFzPRiJ0NcE0AYO4B14jMtd0e7VuREVazCnbiwTqsVpSQqOk0qVQhskUieXnPvS4fRMRyaH/7IGpJJwry5rzwLNM1LxK9+cwsNdtCcp+7fgz7NRRLCxTlaFk1eBgBFGDWAK+AlGviAymbtGOv6zZoX7jDnQPPrLhCyG4M5+N6DAwnYGo6DVGddZhDvNLcZ9ubxtvvfbhDNIxruD8HpLzAa5Ckru6Ql+u19SZUL7h090j5P2jb3Wxm87bPVSFylOr4nwMczAp39/SIRsULJ0waM4JMCuYRoAbym78emlT26WA1IWaypIeAjVjlTTYNyKtKwlqojXps2OxJWPHCtWnvqdDtMp0YBuFTMlVcoxke2j0m/cIZRoOfNVM1kByElcU8IoJ3FHsUhoI95JYKuRQFxuByT6M5syIBifEjNMKs5plVOlF0lbcWW7/l9se0GcD5e61947DkdGCJy1H2ObztgQ34n9KO7a1xQM0ZyzXZ7XxqQZOvfx8rYLXX9vR709jVOwPj7bTHuA1NUJyS+YNy5a7PP9FFpgst3hf/UvuvQr400p2YQ+vWpcErh2SmlTEY7giTSyBnYJOt41tsb+4A+QiNRRH8gh4kslpwR+aq1vcxDB+m6n7E0TsnR8KMLrZ7aPwZz1APFo8ob9648TsA3BTN8Zhq9SfgfS21e1RJh1EfP/2KS+4v3TC2cGGNC6e3GJ3ZkeMNGeUCrEGb+FE2++1fBVwYlgIKtwZwuGrpQaVQozBkAHqwtSxVLqaCxHaAHKKZjwk23BhVK5vtADhKLpHcCUoD+spLcbMwFsqmUZDhfduApIBJXALXPewE1/5rBNDySO2plozCkx5nyW9EWZd9nKbWmIlwL+v6oVBf3WQAaEV4DLgTB/v7RNVCqc91tYmWTwgsGFxNHiGmHHxnnu1Gy3df7b3Oh17QvXEfol6sPMwf45/xwfgQV7gk0NJCZZ9BN8qfgm4hx+jezN8bbdAYJo7whvBSHFBIpnSO2VGK6VqG49Ffvpt7Fefm9bQJJ2Dr6mkWxfPWNDUPW04P5uY1TSHHq9TE8punXBbahWSA+/mY5TeM5nvYGldh34MVr7opW4+9zCU2DBIrRKG/gi+XQA8v0tQGYxFbhtjvsyiBSS1+8K4SvHMJLSQH2dQprUrJla1pYnabTPOV7g8J1TWDsDAIayZvfYhoHeBWK38t2qXrsh79wmwhuQ5D6DybJ3auwcxVkSfglU/Uub/rI6BlQYN1e1oFuiALUNjmiouC+8s8tPiLK2AUmz9/8SN7F8CxoBk790dKGQpGoJL8XWhgF3LEflJXwN4pTK7T7CWn68iuwuxktW9tNjXuS5v3uXR3RHExbi2UFTmxmIlOJh3jbT5HjcyJJoeqbaymMf3uBwxupphJbpXG0B4Xxf3CelwUDwnpcVF0Hd0+gOB3h+gYJmA2vz5+NMXd5jYXHri5zWyM0oM8oIYNNJS443R1HoIHbZcUMImUkouR6EzCNQ4aDD1xA3mSC5PW2gBdJrX31msW1m29xenrxBbCvdWg9bPh7K0bYhmDsskU80qXqPuyA5pOHTVxVHji5eX7+ZSPx+OY5/sn8QT4ccz3j3h8fHB8dHKSHaYHx6cbFh1GK+m2+yG2v7vgc/0b/emkxhl7KfAunL10l88j9gIvpXejPlUCiiav+4EoXP8g+pxFjaZ9tYxyx1vb7op/ZzfIsHZzNwVrKPZ3H65Yk3OMSe89HommQgozT3yUE7UrJhI40+sJYtKeQM7Hp8x8YVk7eS8mWChnxSQ09F1WmLEawCYH2+/iT8g8QmZFnaNEdwOhbNFgzArPZC5F6evmoEH6I7ssne1VL3ZD0voo8bVWcsa8992f409RPYDNnUgGib52iOL9KSp36fod7M522cH4cPL82cARmysJD86HeIO9QzZEOOQH+0sXpZhxUIhsU6Rh8PDktcsAh3VXj52j457kgemk97bBKneF03Pg7xPIHoS1OY/gXfd5QJuTQbvv9gVzs52lHM54oa476Q2Uy7UpuaH17R8cTcApQzZfnyG6MYLHmaBZpNdkzoY1d+t83/D+6pBm8YZ2kFJ40MwGTUfvabDPgzwQzAmGnNFPbMf32WlfEkjF8NmhsDa0MkGrpNyI7Im9c05pfkF+B2vTPbLayoWVALnp6CHvBg7YH4Fu1z45fM3q6OetCf47poUHOTOja1HtTVbdJmrsN4pqBd0TxujJklgfJO/FnB0CjOEzykzPLDN1hc+tWE7GUbHo3/B7cRTW4G5AHz0O3Ut+6EB2E+a926xN6WJCG5s8LOHlNfZlspf2siKtctIP0yQV2s63n+Ul3atPGXVvXGOvQd3jVDIASebc75q2yQV9iBEfngKOOUyODo7jnPPTeAL5cXzyHPbjgxPIn+f7ACeHzzeINLoNe4BTWhScvRb2zxmG4nLK+OUozNFdY3hgiYfnvdswA2gjkovYXDV7Igw4Oo9MqXF+nE6Pxlmc8nQaT/jBOD4Zn47jw8k+jPPTjKfjkw2UepgUujBc8Dn7AXQhZEMmpEuxIBJd+9cr96NQsKlBGmdPN3GPzXk763O1Nqawemu0y+ndpMtBJI1zKTfmhy41e7C3hr17HiPDK9gR+x3gM4aapJ3T07u/Ax9CHYImjex9ZFcpTLRJ2quOQr1dSuBfeq0YDya7L78w/iEYCv598f9ji+F2FP3a0Rt3LegvokBuR9HPjQa5a83fVMk3VfIVquTWv35vpNcFrq2qbXx1EDcXkc2nROSxOE36hXS2KujDjFWaLjfbmjDujSeXd1VtGeH76msoCuYLXnBMr3dvYRXVkuiOGk4xCqBGYnXrY7hkNpqSVAkUYiZSUeBTsu7F2+5H+VFeuJdmoXQO3Y15fw6nX6rHsbpoF1UYuYyRUNGH8cwaXAqX/gpil/2Cy7gWBkZMhFe3LqGzQ56BWkII8bcmsmZw23tzaUA2CE/xzrADY9936rq4t6f4/j1tE4dH+ObHpzoryS6HqkNc7rqhfguh0pL7ujCrRWOuuF70x1xG4Ae79LUgLpHUlOnHi0Jdh5JKy53O2E6/DsVOM1Cv5sS6AYdWdsZ2qO4FDfZR/o3997//1//853+w91K6DJAuvwliWoV/uUfl7tYjZ3mN7/P8FuP7+r/hUBfTdt9ZxmsDhhlV0oP8EnSxiBsGpgJJhp54A6v93O55tlTXcfjGJVWFp8Jh9iVMYfLvv/eVSM6+/569RwyIcHh3GT5uZJdEiEsEcemrJPlnyYSdUZYyzi9WdnS0ygejdn9H/rlzf5fcav0qRswImYEP23l6IEvXkl6/E7MN7uCOB+u38CU9K6edM1bX/vZ3Sq9FSUQgHRoB4d+UU5AdE75CwYXr6+tdKtG0O1NXe0ZYMHs5THld2L2pKPAvv+A9iijtifiUJtyt8inCMJlCrr3sS1Nzdq2FhUuqwdBEBJ3+IMumkyREITchyXAja6S9gXSPa1dKsPmHord3FTFrs6NHzbT/Fv8r1Zk7f3MR/9bcrNL0c+A5mYstAF+MZXmal7gWLN7jyh7gNsdoheZU5yxI1n7xNCpbgA2QgalmgUQzX7SJ5CPXplMEZMewD6WQlJzVGXvLihm8EnFbCu2f/YBx5+tnCAMZEK3adeRuq3qN98fP4/2j+OC5q4ZEDONq4ITvb28/jUIo+QeVU3C3v68Prry3/Nr6yYqrNaolyIkzds78Z1KcqgTcwuu5onusVGkZ7jveS3oJQtcgBr02lKqMFD0vqBRUGKgQV76wxUq/IPnbgm4Eof0TB3RlrDpwAozzErTAk/+Wl4qPWAaaql44uRzmN+Gw+K/fafSM3oHWgi61/a9vOBb6yNiFKbjMjRN2YcRsLopcAxXiGwDnKcNTrXge1rRal47WVvDraV2w5lcWfu0TvPE63r9tSEmm41z5PvhUGf22AmZejWVqJon22NDN5L+nxxQrk2bgrRpRlmKmubQBvVMiZ+y8MDjdFLQ30Oi5zcdOCb5u9S+r2LXSnz9GWByFbkfo6g2nWHTWtdpjmKvS2g6RYYSfG8bAXM51NHUlcp6kgOCmYxeyfpuigV2TEPNvzIg5eUrWHwg9eDx3w/l0tDRdHTrUvqPvUct2DpXfVW8aD/bF+gADLOst4RC3ubyj3uF9Z3Ls5QfvOPLEuN6yRUPFH07neLuLluU9/fr6i2trL27a4WZn/QMGskS4JaPE2czesl+SwUtFJJvdfb1kf5OVvHPHsnb6+4LH48XFW/Yz/bx3HrsPI3Y9FxlFMI7xqJ2Gh7nrZw7kGpgiWFsTdp6HFL2VeQ4O7jVHzwXozUXl2PyPgcRIrnd9dmkqfy2R1tkcYLwEGKpEeZ/NHS5AuS2Qy/5qLz2mtZU374mtV3CzxYXnh/ymUHKqAXfHefTA/i+Wqu2Yd27ouOAL0FuUrUWZFCIBff+e3CPv4S3lvq0GCMQU/f0m+aBXyXLQVPt0Z23JbmnJ5+P0OHt+dDyejLP0ePJ8DCenKR+n2f44SyfHR+srPwaVFoJFN7GpgH8GbhYxOgexukKrJ8cd9c+HlxtR0TIMcZ0ulc1E9BakoVt7dHBcaGxtQetRUzKzU9gaPZTQbx2spmOAN9zJwWwb9+CiYe4T3ChERg6anUdn0d7VwV4TLNv70nHQbvcGwmX0Bsf7dLUu0IHyLMsr4Tg2zqEktl05Gy+hVD3yuvFil8iHP+Py1gw8OOYbTUl768as8GdcvYGs1pRw8uFLuBA4z/ByAmueRmcfPnVbvUU3xHHmQNtGBiDE4DxR4VvgmhRsvyAbDRFT7SA6O5gwErZmFL2l10xfM4MbYc0Et6MI3atfW8esc9ruODerNVPvti5WrIdWVrY1Ulv/cqWqavNTKwBa578p/OvvmMixRz95qX3HKR1F6LibX6ZvQV+JDDqc1QpYCuLuUcO9HImIvmZMf2MGtfFdV4pLQZFh1MsqRjh2DHvlTzcLbxnRhQ8UoWX+ky//yV2imA9RvAyzsl+xRKPPBnJJ13g0/K//0p4E3NdKGVty2RnnhX9Br5vE8Dtr1C+t6UvroX+Lhn+Lhn+Lhn+Lhn+Lhn91NNzrTgs3dq8quCC1T2bOF2+IfYiuDjrF21H4n/Wi5X1r7BPWRzEW+375grGT97q4vcWv/6gBleyHT2gQanrSTXZPLigVY02Muyv6v/vVc+wztjbAvmZZoRyjXHTs0cjXhly6AXAlXlwAfjt4f/Fo/CBdHf2GrzIaMrfewQtHrPjdkvuxGnRve6ABWtmNbbtuxJv376JRlPo4f6nIh9L8Gu9S+LXb85DXjBcB+N2XqOByVruMADck/vtfhFuXfg== +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"; + + + + + + + + + + +An employee's I-9 authorization stores information about an employee's authorization status, as well as signatures and other information required to complete the Form I-9 for employment eligibility verification. + +If the version is supplied and the employee I-9 authorization exists, this endpoint acts as an update. Otherwise, it will create an employee I-9 authorization. + +Validations on this endpoint are conditional: + + * `document_type` may be required, depending on `authorization_status`. + * Valid formats for `document_number` vary, depending on `document_type`. + * `country` is only allowed with `document_type: 'foreign_passport'`. + * `expiration_date` is only allowed with `authorization_status: 'alien'`. + +> ℹ️ Unneeded information is automatically removed during updates. +> +> If an update causes some formerly-required fields to be unneeded, the now-unneeded data will be removed automatically. +> +> **Example:** Updating `authorization_status` from `alien` to `citizen` will cause any data in `document_type`, `document_number`, `country`, and `expiration_date` to be removed, since these fields are unused for `authorization_status:'citizen'`. + +Detailed instructions for completing Form I-9 can be found at https://www.uscis.gov/sites/default/files/document/forms/i-9instr.pdf + +scope: `i9_authorizations:write` + + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/put-v-1-employees-employee-id-onboarding-documents-config.ParamsDetails.json b/docs/api/put-v-1-employees-employee-id-onboarding-documents-config.ParamsDetails.json new file mode 100644 index 000000000..95b3135c8 --- /dev/null +++ b/docs/api/put-v-1-employees-employee-id-onboarding-documents-config.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","required":true,"description":"The UUID of the employee","example":"7b1d0df1-6403-4a06-8768-c1dd7d24d27a","schema":{"type":"string"}}]} \ No newline at end of file diff --git a/docs/api/put-v-1-employees-employee-id-onboarding-documents-config.RequestSchema.json b/docs/api/put-v-1-employees-employee-id-onboarding-documents-config.RequestSchema.json new file mode 100644 index 000000000..41d8332de --- /dev/null +++ b/docs/api/put-v-1-employees-employee-id-onboarding-documents-config.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","description":"Request body for updating an employee's onboarding documents configuration.","properties":{"i9_document":{"type":"boolean","default":false,"description":"Whether to include Form I-9 for this employee during onboarding.\nWhen true, the employee will be prompted to complete Form I-9 as part of their onboarding.\n"}},"x-examples":{"enable_i9":{"i9_document":true},"disable_i9":{"i9_document":false}},"title":"Employee-Onboarding-Documents-Config-Request"}}}}} \ No newline at end of file diff --git a/docs/api/put-v-1-employees-employee-id-onboarding-documents-config.StatusCodes.json b/docs/api/put-v-1-employees-employee-id-onboarding-documents-config.StatusCodes.json new file mode 100644 index 000000000..d6fc4bf2d --- /dev/null +++ b/docs/api/put-v-1-employees-employee-id-onboarding-documents-config.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","description":"Configuration for which onboarding documents (e.g. Form I-9) are required for an employee during onboarding.","properties":{"uuid":{"type":["string","null"],"description":"The UUID of the onboarding documents config record. Null when no config has been saved yet.","readOnly":true},"i9_document":{"type":"boolean","description":"Whether to include Form I-9 for this employee during onboarding.\nWhen true, the employee will be prompted to complete Form I-9 as part of their onboarding.\n","readOnly":true}},"x-examples":{"config_with_i9":{"uuid":"7b1d0df1-6403-4a06-8768-c1dd7d24d27a","i9_document":true},"config_without_i9":{"uuid":"7b1d0df1-6403-4a06-8768-c1dd7d24d27a","i9_document":false},"config_not_yet_saved":{"uuid":null,"i9_document":false}},"title":"Employee-Onboarding-Document"}}}},"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/put-v-1-employees-employee-id-onboarding-documents-config.api.mdx b/docs/api/put-v-1-employees-employee-id-onboarding-documents-config.api.mdx new file mode 100644 index 000000000..51ee63e40 --- /dev/null +++ b/docs/api/put-v-1-employees-employee-id-onboarding-documents-config.api.mdx @@ -0,0 +1,75 @@ +--- +id: put-v-1-employees-employee-id-onboarding-documents-config +title: "Update employee onboarding documents config" +description: "Indicate whether to include the Form I-9 for an employee during the onboarding process." +sidebar_label: "Update employee onboarding documents config" +hide_title: true +hide_table_of_contents: true +api: eJztWFtz27YS/iso8pBkhpBsHzdp+NScOD2jh5N4ErvtjKxxIWIloiYBFhfZHA3/+5kFSJG6ppn0pZ3zZAtcLBa7+327izW1kHkjXU3T6Zq+02XFVf02y8Dat97lNJ3OmllCBdjMyMpJrWhKJ0rIjDsgjzm4HAxxmkiVFV4AcTmQn7QpyYS9IQttCFcEyqrQNQAR3ki1DDJazTU3An9WRuN5ozs1WXR6RBKkNjsfZVGQOaBsWTkQeGSmy6oANziPW1Jx44he4G5pBqeM7tSdevaMfIKC4/6llwLsnWJk+r47pJeevRA6S7vTWf/hJaqxma4gJb91321acsWX8BtN6BNbeus0k8rB0nD0GHN1BTSdUijnIAQIOkuo40uLa93hFhcrbngJDowN4VC8BJrSX9l/gsq31xP2MxiLQUioxEjkwAUYmlCb5VBymq5pPIxah66mCQXlSzzo4uzie3b2ip1/T0NAF9wXjqbD9WY30FdoSykV2BANwR2wObcgyNvrCVlFWwi3VmcyePVRupzU2psgkPGiGJHJgiitgEiL0VvJENwgw6uqwESSWj23ZFpKJUtfDnXPXuTOVTYdj4XO7Ci4dpTpcty5klW8NroowvcxryRrd0q1fNYqZIPll2iGtyBGtEk2Hu4CeS9F59mKu5wm1MAfXhoQNHXGw65/bnIgt7eTqzbhNumKbn/imJ00pa/n5+JMLM7Zq8uzf7FLfvaK/fD61Q8sOxfitbi4FBev+YkINoi/LquMfeTLzhYDttLKgsVNF2dn+Gfbvs8+IJkmNNPKgXIoMvD6+HeLcuv9w/X8d8gc3b3wO60WculjXgd4P+Yyy4doFjrzJShnyQsYLUcbcL4k3ADp/HmMGgaApQmtjK7AOBmv6L0UvYnTPsWVLwq6x1K7wTloYxYuRAxk2ogR+eCLAllNEaW7bzm3ZA6giOUrEKQGNwqJwcVHVdQxGE1C5Zv7Tu3Aj3OtC+Bqz5G/7DPnFmu6XNpTzrlTv6CVIRH+eqbcv1+DOdjmdAhGdM49Av5evunD82fTfctdrQsHOrV33652wQs70Ku0u6/B3Yc49qoxew5ubBLqpAsY7liafdy4iV114k2Dopdnl/sA/KAd+Ul7JbBsYEJi/oPFsBiw2psMiNBgidKOwJO0bkT+yx+AWG9iLe0oM6aytGTFCylijP40qI8YRe4UId9q1+RqvG0aTfZIpGfRKQVjtInVbgvd7XoPHW4MrzGkDkp7iJr2tN4/AG7A1mSpTX3kjCB1oFDuUGcFmVxIsEgH7Z3DdqKzzBs7Ijd1JbHC1RGsD1ATKUC5uAvluXNGzr2D8aawE9P2H073KrEW9VZ/hWmoAWURxlETwWB2qrog2dbypdG+kmppCVeCZFwhT2AxRGvmXhaCZFhmylY+50oUSDxSxYI9aGqCzSVYy5fwZZOvO0MEOC4LS/hcezdwKiNLUGB6d7aqOyutNwueRUuxbCiBhqPnIvq2yQmRvsAMHybWdCv+tM34Yb6kg42Dy9EjAHnkER9hw4g2syFjfNCOBZCx93go+xiztjUXkzK4cYLcVnnHVuds006yQT8y6D03BGXvI6O1GADr/q1F3bLyX1HmP0WtZK5FHcqRrwR3mAmDkv3cniqpvkuTXQx+uU62nWkg4b9Z3dxPRVB8XkBbyw4VPSHtMYmvKkOWxeaMtcGjHTBsBfwBuK0ZdrtMr8AYKVBdiCr0ujaq3nXpBU8OFPbNET8ROUdHnISueOF3Rh1ss7f3xSZ2Ixz90Asds3ez4Yt2Y8dcgst1Cy7MQWznUzpenY83MBuvBzhrxqeBZsGsurnMmwJnr3Yy4ZWMgwkTUIbpZA9PV1Bquh2LqI+F3gb3hXHkiOKDOq+NFid0VvgZHdEN+J8R+zEnD4z5GyDi4d00EoAJ3IQJc3cQCCpYASsoCPcux8oX6QYrw+faOii/5YSo4cgBTUKR0z717Pe+m7cOYgiHuoUORrRQCiM1jpqYV+1QvTUMJxRnX/tx8RnMSmYwCEw/hoYyNg6CY4GWItOx8JvpRQgIbt1jMSgyXQJSTLDjuSXvW8CQ6zjQhim4u0a49Xdtx8ezQJzt6HrVnRpfNgJUEwoll0XIrPbrj30iofMqbV3J1UDPbcBUT4cnqH33OoOy8/+noRNPQ23+O3hy46rgMgAlQH7d8tOUrs5D9Lo3oYSm228Tp0hqltBcW4dq1mt8prk1RdPg8h8esL2ZzpBDjcR6E4isrT3icLEdxvXFp7bZfklOPHocvGHXzqt6QOE0afl+eL1m1iTdk9bXmfePfqg64tfov8OPgxs394X1XXQWu9mq1PttYr8D2btyJ2WHhfb69oYmdN52oqUOLYbhj9il8scYc11FhkrXcW1NC66WPrbZUSXSE9+uGJsK0f6DuXEwq9brKHGjH0A1zSbJHP4ODXrzPwc/FSQ= +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"; + + + + + + + + + + +Indicate whether to include the Form I-9 for an employee during the onboarding process. +If included, the employee will be prompted to complete Form I-9 as part of their onboarding. + +## Related guides +- [Employee onboarding](doc:employee-onboarding) + +scope: `employees:manage` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/put-v-1-employees-employee-id-onboarding-status.ParamsDetails.json b/docs/api/put-v-1-employees-employee-id-onboarding-status.ParamsDetails.json new file mode 100644 index 000000000..c8985cf67 --- /dev/null +++ b/docs/api/put-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/put-v-1-employees-employee-id-onboarding-status.RequestSchema.json b/docs/api/put-v-1-employees-employee-id-onboarding-status.RequestSchema.json new file mode 100644 index 000000000..87ad3244d --- /dev/null +++ b/docs/api/put-v-1-employees-employee-id-onboarding-status.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","required":["onboarding_status"],"properties":{"onboarding_status":{"type":"string","description":"Onboarding status value","enum":["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","onboarding_completed"]}}}}},"required":true}} \ No newline at end of file diff --git a/docs/api/put-v-1-employees-employee-id-onboarding-status.StatusCodes.json b/docs/api/put-v-1-employees-employee-id-onboarding-status.StatusCodes.json new file mode 100644 index 000000000..3e4aa1b53 --- /dev/null +++ b/docs/api/put-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"}}}},"422":{"description":"invalid status transition","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/put-v-1-employees-employee-id-onboarding-status.api.mdx b/docs/api/put-v-1-employees-employee-id-onboarding-status.api.mdx new file mode 100644 index 000000000..63f8345aa --- /dev/null +++ b/docs/api/put-v-1-employees-employee-id-onboarding-status.api.mdx @@ -0,0 +1,80 @@ +--- +id: put-v-1-employees-employee-id-onboarding-status +title: "Update the employee's onboarding status" +description: "Updates an employee's onboarding status." +sidebar_label: "Update the employee's onboarding status" +hide_title: true +hide_table_of_contents: true +api: eJztXOtvGzmS/1d4fR8yAdR+xUkcf7pMHrcGLhNjkuzcwgnaVLMkcdxNdki2bI3H//ui+OqHWrKk2Li7vQmwO4maZP1YZD1Z5G0iK1DUcCnOWHKaVLVJ54cplFUhFwA6/i3jLJViLKliXEwzbaipdTJKGOhc8QoHSE6TLxWjBjShgoSOTzRp+hHXb++rIP7Pz1DIa8I1oaTg2hA5IXNacLbcieQzKqagCYMKhP0gBTEzIFwYEAwYoTniIEaSMZAK1ESqEnAoMoYZLSY4OnYI2Pa+igbJn+S16/4nyWulQBiyNGHyJxFwPfR7a5zTdOlP97fTP9t/byP4QNVVm3mEaqKhmLRYT/4kl5SVXGQtFFzksqwKMHCJ37FL+7PnV8bFnNsmbZpn9scOVSM7VO8lKdUGNJebuE+sh+cNFTkUvS00wISVo22IZj0T24h+hTmH6zWIgBEuJnIIVRiSZeNFFroPcoNeU27sXywwZYn2kLznguvZavHaZaFW0SWXQ9OwgL4KncsKTsllVBSnJRV0CpfJKDF0qpPTi+Rd+JZ8GyU36bTWRqYoq1OncFKzqAAbQjkGxoBhOw15rbhZJKcXt8kbWVZULF7nOWj9ujaz5PTi2923UVJRRUswoLRtJ2gJyWny3+l/Whqvz8/Sv4PSqJNGCUfFNAPKQCWjROczKGlyeps46ok2iotpMkpA1CWiOTo4ep4evEgPnyMeBhNaFyY5bf9+19d7bxFLyQVoq19QCaZjqoGR1+dnZO6wEKq1zDk1wMg1NzOykLWyDXJaFHvkbEKEFIDKsFJyzhmwkWtDq6rguWXaE00uSi54WZftsb/9NDOm0qf7+0zmes/yei+X5X7gbVrRhZJFYb/v04qnvicX03/3A6atn58ijFoD20vuRpHDLWsQOFtRM1uyA59nQL58OXvbV7jJKFHwveYKWHJqVA2rF+TurrVrlL6m09BDga6k0KCx09HBAf6nS17XdsdM6iIZJblE82CwVYuP+79rbHrbor88BQWVAg3C2C44mfsMG25/Nw05/h1yg//mpsAfgjikH2Ov9FMwozcp3FAUMTspjz9Y2dPbpK45mueTZ88P88kRTQ9f5uP0+BU8S18d05fpq1cnL1g+PjyEk+NklCwb6tNkSJj7TaFy8hQgn4PSUtCCMDCUFwjUwqj871nze39ZGxpx1WyDEoTRVoxHDZ13woAi2AWEdrzuUWx/eyiqrxkj1xINLmMKdKRFGcvw96z5/YfpzGQJQ3Tw94ei47g4AQaKFsTQG6tlZrLA1Y1U/ffM0JtMg6mrhyGL+wwsUbSEqrQrFWjaj5tSnNBCL5McWpUlBnZwveUKcoPeotTckEDZAmL2W+a/DaDyILZjRHCfcP5E86lwhsVSjJoTP2bNx+0ZMbSAfQZ3cL3nBVi3dcaV1WlSmbgbeAGZgOsMv2Xx2wMsz7e7b3d3o6RSGGAYDi01tmx7e1GE4N9rIJyBMHzCcVNLRcyM68ZzRxs8oObuG/qjgGCTvi73/5oQ9AIwAqlBL9Ow+jGSoErRxRKF//JRjG1NAiPRpQ7edMuGoL3gBko3rF+vj22rAtWASeky1fe7l6saVDpRHAQrFqT1LTBEduna6W+yXJ/sz8vLNTxis7XiuGMpC6BiaeDfZiCI3YBu8XEMdEvCEHa81tbcbcAZ1WQMIEgcqY3Tb/B7Fv11DF57U+7ugDFMuWhId1e/5/3gnza3LpzwfHO/Hx8cL7ssv0hD3staMPTQnf/yvQaN/qYCLWuVA2ESNBHSELjh2uyRD/QKiK4V2AULfqdz3rh2sfjeV7G7HxVBEQxkfhTX2dv9LrQB6WjzDJSSygYgXZnxvy+va389Vo+aXQF2yKmBqVSLFTRsq/tFqIIcRUeT6xn4OdvuROZ5rfQe+byoOIYJC7d9rmDRCJwLOqgxio9rA/sxOiIKChtuGNkM6aQmoN4CGo6AbXGbu5EILmYYKiyS9sinStYVeh6ECkZyikkYG1FYSah5wUiOzn3p28+oYIVVJMJFPa1Q0WIuQWs63UDTnQcg3lEkdCxr02JqSqYg0IgGdvqhA0pdqwnNHVLU1oIhcOSck76uty6kySa4w9sb66Kz/onf8e39ctrq2JpcskJArqmTD9thL3HWNZiMX6RJrZCl75Bo+tHtWq8rjo6WxZILl2bz+SujqNDc+2w7SvoXUSmJcQsdF0DeCcPNIsg88pguyIxWFQjc5C5zN5ZsgdvJrrefNEHylAu/jzTRdT7DRNilx5zFnZ5ZQ305It7ehBEmdtVZDX4BY8+Y7LzcI5/AydnFO0fmjVsYDnrLYNrCTPPY/SmZ1pxZN5CUUkHYhk6N/qWt/vW1FaZyIiGuyaWwwpy5dbwcOefIrhW55kURtjyhxLUkl74p8Yu0cBkjsELlBeN/jVJEFIYyaujQVuzCeBOEW0EBcyoMJssojuk3yMJLsld7XBAr0+inWrXhNdK4gD3yXiriNfGoM4TFZ1l16f6bIapLu7bhF3SnLh37x42HsWdzIvBx4hIha+dS1oXhVQGOFspRT/DCz8vCFr5sIdK9FBcX00B54WJhq75pcd6i5KK3AdqOIffvml9oGQMmz1Ezo+1tk0vlEnJMEyPtbmgxePdgL9CzIzrtPVGybAa8aEYUdVFgzOvb1VVm5PqGHT031MBG1OuatKzvB7/709+4maUfBaTO+CV3q1t98HvHNcWlsSH7X2v+f37NcaSVBrsXj6LykaJYuKiH8LVmY4+cGXs4ILXm6GIZSWZ0DiTqoQLmUGhcO29GgqGIaiXJucrrgqqfHNyOv/g0ac9woEEy4P2OqbjKaJ7LWmBCDQPorBaTGg9ks4ouYgC9wjPGY5KuW7zkrHXc4/e1Pcn7AGYmmQ3eAzUSqdk16ACbg+KThT0LU+3U30Mi+we6AUiVeKpoOdFlHwOx9DmwPXJeANVA8hnkV85JQY81ZClpiR313uop0EIBZYssjPioE0D2eoIuRxLnMQCw5Bo1VKZkjeeJ66Ih1yITdTm2p3IDEHtOfgfor64/cf17KSHE5XdClksx4VMdoUVfcyuuLfdug3ltCC4pVgsAaZzZstam7VgMAwuznVBtgrRkBS+5WYNwoPHWLHyPiP0YxI5B9EzWBUPM1HM2Ys4qUFyyBi8IljGvLVegjE0GsQ3z8p1g9vC0JTk2gjIzKsgzUkphZhp9wkltagUOX+5OiTMuWK2NWmQaCrClHJmgPNdZLhnmtpu84wrETevt+fkL9iXYd2A7bobQk3l8gGFrwvcaD4okeUEYn/KodtbA1QGA3gCu5rlruz3aTzy3WPUy2GMP1mE1vIRMTiZZJQueLzI8qN5srcudmFgOrW8fRC2sRAGL8kLzXNW0yNR6mek020Jzv3b9CPaLHBsXqMrRs4p4iAXIQa8AHspkfCJlnXXsdd0G7Rsn3AywXmuOkN0YLsYNxV1IgMjJJGR1VmGOJSibLHtsvP3ax3IWQhVsvgPGtMCCpqyu7tGXq631OlRvqLBpQcp+t8vuqOn1yz6TBWeo1fF/DnBwK6wj+pBeka/hiW6EdSmIR4AWyC/+amiYJn00WPHcwXrSQ8BGpPIumwLcq1LASqjRPMZt9ihb8cwnb2PBHoZdupXDsPhicVqE85D8CzKMDj9p6uAiKQthaTIPiOCzzT1yV2xqw1IuOllgTC73LJpzKzIQmD9CJ8womhupMgzC1mDrt9xeTOMALt5r/BuHhVmBtbscdZ/D2whswP+YfmxvjgNmThuqXKXgxICysf4mXsByr+35dx796icD4z1pxLhJTdg8pS8mhjkI42cRUoub4u+0/yHknZHuxRxaNyENHjlkUyW1xnRHIC7ABgPrfB3fYnt3B2yMED2KEBf0IFmvBVdkJmu1iWO4m6n7G47ekhwBU2r4vM8gL+O5LSN+QH1z7sZvAXAkonhMlPwDROZxPKimw6yPJ78UkvtDN8wtnBnt0ukNRud2MDwho4UBtQJt5kdZH7f/EHCOZRao3CLgcNTSg2pTjVxbB9CDrUUpGZ9wq7YD5JDNfEiw4cSoWlpsB8BxssNypyg1qLnX4nqhDZSxUdDhfd/AagGduWK5DfwE1/5HFFB3pEaqBbHpSY+zpDdYDNzHqWtVUZzzI0J9d5MDoBfhMeBKHB4cWK4WUl7V1TpePiKw4HDFEj8sQvlJP91LumdfzbnORS/pHsOHpJcrD/RT/Gd6ePTMHu23Fdq4kPkVqGj8bdINqyy32vy90QadYbsjvCPcyQNyQaRioNA+qVoE8ehP39Fexrl+PnFxXO3io0yKssY11btNpwdz/ZyWizQfZVqhZK1T9Wvp7TbHZdgbbEWXE3ZFIg8+zc42DBorZKF/YF92QA9PUte6svfKHnxSWP8XBm8bwXun0EBykHU9trOSYmlpYs5unWu+1H2XVF0chIRBSCTexBDJKsCNVf5RtJ3jsh7/AjWvjW0KneazzMwUaKyRz8Abn6R1ftdHYKcFEev2vAp8wS1g0zZzygvqD/PQ4y/mQGxu/vWbv5HPARwJlrF1fiSltskINJK/YWX3mRiRD3IO5LPEiktF3lJ7HNk2mP52z05uUwxf5vFuVefsyObFqDFQVjaINdK7dIQ29Rw1bk50OWRtUjlJ7Xc/YAgz+VRQIxWm9igvNkvrUV7sktKjvGgHun0AIe4O2bEZ1Vn8+vDZFHeaGw88cHEjNWLLgzyguA0UlLji9ug8JA+aLmOY4GBYJ4BM93dXg1Nd8htgGeN6XCttC52D6KyeWLv1FtLXyi2Ec6tB72eN7K0aYoOKyrct0L0aytEjT48dsAk9OjpKKTs4SY+BvkzpwQuavjx8+eLkJH82Pnz5as2kw2ilPe3exfd3B3yuf7SfTmucEn9F5q07fB6RN3go7S78DaGIl753ROFrTb3qcx41uvZVF+UT7227I/4ne0GH/U/V2Y6Sib12O3yp9hFy0p5BLsY3EiW7fRe9lxMspPNiMjv0fV6YNgrAZIfbr+IH3Dxc5EXNUKO7geKdtv6eyV2J0o/RsIP0R3ZVOtubXntBjeuQJb5WUkyJj777NP7g1Q7b3KlksPfhQhbvD165Q9efYG+6Rw6Pnh0/fzogYjMpYOd6iHPsHaohgpAfHnQOSrHioOD5ukzDoPCw2lWAw6qjx5bo4PGdmYFulfc2ySp3hNML4DdJZA/CWl9H8Ll9Z6SpybCr75+XUMR7ykHGC3ndKm+wtVzrihua2H7nbAKSDNV8/Q3RzhE8DIE4SW/JnA+r77f5vuHm5tBS8Y520FIoaHqNpbPXIrHPThEI1gQDc/f2yBPf50lzk0BIfA6k5MaEVjpYlTHVPH/k6JzaMr94Max9tWy7EFYAMN2yQz4MHPA/At+ufXH4itnZz1sz/DcsCw96ZmqPRZV3WVVTqHEQDdUSukfM0VtPYnWSvJdzdggwh09sZXpuiK4rvAVL3B3hYtE/4ffqKMzBnYA+eB66V/zQguwIst5p1rpyMa60yXYreHmPfYnolb0saStm7cMkG3NlX4PYkspbe64+IbZ7DI29BbVlE84BtDpns2PaWAu6ixPvnfeXRxSOXxy+TBmlr9JjYC/Tk+dwkB6eAHvODgBOnj1fo9LsadgOQWlRUPKemz+mmIpjtuKXojLHcI2gwNo9POudhmlAH9GGiPGo2TNhINB5YE4dsZfjyYujPB3T8SQ9podH6cnRq6P02fEBHLFXOR0fnazh1G5a6ExTTmfkZ1AFF5FNyJdiYVl07W+vbMah4FPHZyZi3mN93c7qWq21JazeG23v9HbR5SCSGFyKtfWhnWY7R2vYuxcxEjyCHZHfAK4w1STMzF69+wfQIdQhaRJ17wOHSvGtkDXaXrYMavfKZOe2Yrqi2D1cwQZtfpZsETb/Rpcj113JW365YOmK0E6PG/SfTAurG942WvM4FL4isfbRrIEG/smt1V8yW6yxtoWcg2L10OiDT2cNtBt8wKr7tE3zSMC3pYv1eF/G3mrQFdAroHqRor1LEZjiDPnt0pgNe+OzPXBjQGjrHeOOdnt55VNX9q5K3XvyCjVzt5977Cg2dviaRqtgxg6r4OKDSj6RZB/6w4ck8PGm02R/frgfT8f2b1uvPN3tDz36Zw+7vRTXqkBb5y/M0oq7+7Ipg9Jeml3apW+hlEmX32681GXM8DPOd8XAg2OeK5sdWzVmhZ/vWq+LfUIpdXI28MZYlDMkHt4Ms+9KAFXW4e/fabRDpPb6DaG1mWHMFc6WRsknWxDwIxTcCCsI3I0S1D6/Nnrqnbufs0KNrNUCNjZ3R8tBU9pH1fCxMdxi4fyg/RzaKMHXz/THySdQc55Da9mau9P2uum+bbjPcB6o7FL7bzwH0L7r0hUpKHJ8O8lIYnE80eSdlx0SKnLwHTQm87oML3X9m7/ETl26wz9e9jZQJb/iRWMf07qjA9x3/ut/NNvMPmAjtSmpaI3jHrnsvGs29BZYfyot0/HXO5l/vZP51zuZ/+/fyXQmwMCN2a8Kyq2tsFbv1hvmi2R+aFVUUyl+2n2CcdCRnEltsPPtLbrVX1Rxd4c/f68BPeuLb+gpKFtLZy0449YHbt72Wqm2fvrVe01PyZoXHgfnFe7BikXLUUn8pdzOu5Kutt6917kdvH/pVzhX8NXxb/jl08jmxn1845iVfu74o8uRTNMD3ZbKrG3b9ivPv3xORsnYB0ultP6zouiP4//bNQ8J5dNb99ttUlAxrV1k54ZEy0u7rlJ0jfxfWu8zdHfV7a1r8Vlegbi7i5vM4L9tFHj3T4FO0QQ= +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"; + + + + + + + + + + +Updates an employee's onboarding status. + Below is a list of valid onboarding status changes depending on the intended action to be performed on behalf of the employee. + + | Action | current onboarding_status | new onboarding_status | + |:------------------|:------------:|----------:| + | Mark an employee as self-onboarding | `admin_onboarding_incomplete` | `self_onboarding_pending_invite` | + | Invite an employee to self-onboard | `admin_onboarding_incomplete` or `self_onboarding_pending_invite` | `self_onboarding_invited` | + | Cancel an employee's self-onboarding | `self_onboarding_invited` or `self_onboarding_pending_invite` | `admin_onboarding_incomplete` | + | Review an employee's self-onboarded info | `self_onboarding_completed_by_employee` | `self_onboarding_awaiting_admin_review` | + | Finish an employee's onboarding | `admin_onboarding_incomplete` or `self_onboarding_awaiting_admin_review` | `onboarding_completed` | + +scope: `employees:manage` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/put-v-1-employees-employee-id-payment-method.ParamsDetails.json b/docs/api/put-v-1-employees-employee-id-payment-method.ParamsDetails.json new file mode 100644 index 000000000..c8985cf67 --- /dev/null +++ b/docs/api/put-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/put-v-1-employees-employee-id-payment-method.RequestSchema.json b/docs/api/put-v-1-employees-employee-id-payment-method.RequestSchema.json new file mode 100644 index 000000000..1a5329869 --- /dev/null +++ b/docs/api/put-v-1-employees-employee-id-payment-method.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"required":true,"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.","example":"63859768485e218ccf8a449bb60f14ed"},"type":{"type":"string","enum":["Check","Direct Deposit"],"description":"The payment method type. If type is Check, split_by and splits do not need to be populated. If type is Direct Deposit, split_by and splits are required."},"split_by":{"type":["string","null"],"enum":["Percentage","Amount"],"description":"How the payment will be split. If Percentage, split amounts must add up to exactly 100. If Amount, values are in cents and the last split amount must be null to capture the remainder."},"splits":{"type":["array","null"],"description":"Array of payment splits. Required when type is Direct Deposit.","items":{"type":"object","properties":{"uuid":{"type":"string","description":"The bank account UUID."},"name":{"type":"string","description":"The bank account name."},"priority":{"description":"Order of priority for each payment split; priority 1 is the first account paid. Must be unique and sequential.","type":"integer"},"split_amount":{"type":["number","null"],"description":"If split_by is Amount, value is in cents (e.g., 500 for $5.00) and exactly one account must have null to capture the remainder. If split_by is Percentage, value is the percentage (e.g., 60 for 60%)."}}}}},"required":["version","type"]}}}}} \ No newline at end of file diff --git a/docs/api/put-v-1-employees-employee-id-payment-method.StatusCodes.json b/docs/api/put-v-1-employees-employee-id-payment-method.StatusCodes.json new file mode 100644 index 000000000..f49705431 --- /dev/null +++ b/docs/api/put-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"}}}},"409":{"description":"Conflict","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"}}}},"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/put-v-1-employees-employee-id-payment-method.api.mdx b/docs/api/put-v-1-employees-employee-id-payment-method.api.mdx new file mode 100644 index 000000000..be6d283f3 --- /dev/null +++ b/docs/api/put-v-1-employees-employee-id-payment-method.api.mdx @@ -0,0 +1,71 @@ +--- +id: put-v-1-employees-employee-id-payment-method +title: "Update payment method for an employee" +description: "Updates the payment method for an employee. Can set to Check or Direct Deposit with split configuration." +sidebar_label: "Update payment method for an employee" +hide_title: true +hide_table_of_contents: true +api: eJztPWtzGzeSfwU3t1uOqzgUSVESpftyih8Xf3Ciiu3LbTkuCpxpilgPgQmAkcyo9N+vugHMiw+JsrR7tzVVSVnkAI1Go9/o5txGBpJCC7uKzj7fRq/UMudydZ4kYMx5YRfR2ecvd196UQom0SK3QsnoLPqUp9yCYXYBLOerJUjLlmAXKmVzpRmXDJZ5plYAffaKS2bAMqvYqwUkX5nS7LXQkFj2GnJlhGU3wi6YyTNhWaLkXFwVmuNK/d/l79IkKoczdhkgTv2CU7egObvRwsJl1Iu+xVeFsSoW0sKVgxDbVQ7R2ecIljNIU0ijL73I8iuD373xENmF38J7gohDVA4OwLs0OovywsbXwzhgYMq/piKNm+jU0NDmhl9FZ1YX0Is0mFxJAyY6u41GgwH+06Tph4KIPi+yqBclSlqQFkfxPM9EQsgc/N3g0NvIJAtYcvzLCptBdFbuJfZ7id8HdBwFIjX7OySW0INvfJlnDpU37u94iB+ueVYA/QHaOKyODydHpyfHk/HkCEbDSZLMJ3w8Pp3Njgfz4RhqCzTPNOpFdKDT2So6i86XqpDld4ZYrSgE0hYmk/np+PA4np2MIR6f8kk8OYHT+OTkZHY6m8PJ8AiiXiT5Ehf5UZ07LhLyip0niQeba6EcDw/DutwteXY0GAwGd71yvUE6mp3MTw7jwVF6HI+Hk3F8Ohym8ej4FFKAJDkc8Gq9VwtuYPeKo/aKw0FryeHR4RAmo3E8SU8hHs/SSXw6Px3Eg3QwPh5MhqOj9KRa8tMH9iOXX3cvetheVBZZdvfl7q5XnujoWU/0AnQC0vIr+Kec6vE/9kjHgyZtD7+btrR+dIdAm2qAEEH1Y4WT0BL6bZhrrBbyKmrP/LgAlhRaoybzk5iak452wt9nHwDo82f/HAlwVYgUvvywsDY3ZwcHqUpMnxRYP1HLg6A3Uc1plWX0/ECksMyVBZmsXpLGF3Ku9JKUFFOSLdQN6vvC4HLCsLmALO1Hd2H761sBWSxRJ6/xnCPUmgX6uG55EGSfvZvTH0wYd8Y93LBkl4F3LxmXqf9oLlmqmFSWSYAUMZ4By1VeZNxC2oDVxKu3FR7XwDT8UQgNbsOVzNxGXK5+mZOYbNt+qShr8vUFWd1PQDGP1u3xa/o0A+MoX6PNjcgy3BWhQTuqYS4Mq9bxhMLJzhQ75jdsWRjLeJqyIkcSwTee2GzFhoPBBnhuAzVYGTfWA7x0EC8dxBmwS9zOJQJNeG4L7ZhTw5ILmYKu6Gcqlvkcca35CuUZafGlFwkLy9qAytI1afQr5BoM7tV6yeBshoqWOw3AEM6a9DkV8xDRa8B69xpxdxpn78k07a4XLUSagpz6r6eyWM5A3w/vPTdfIW2BdHPv6lquhEP+EuiNiCmdgkZihXkk7sCTRclidEI958SVo4ZsBqhd8EDnQuN51/HJuUj77CKMDgxRSPFHASRRBv4oQFrBs5oYBX3c9p3W2PCF48MXPad/8D/JkNEN+wH6V/0eOxoMaCt/OeoPBi9pycDZSkKJKGG24NfAeFgicLGa38vA6/LxohK4GnIkseUDRpYlIHrs8Dwe/PVlv7Qfn2uH5uQALUlQPPicGBedXe8gNv3CGF2MONg+MkPf4nv94jsaOB6M10/gZ2XZW1XIFF32jwunBMFYSJkGowqdAEsVGNK28E0Y22fv+VdgJlAt1+papJCyT5/evUaiXPNMpP3f5T7u8Bak2O+Sse/F693rgyZqG5zr+gmA1kobPIOmSvHfV/IXFNpWRbYGdfoVcELCLVwpvdqyBo26V118yCERcwGG3SzA75mmM5UkhTZ99nGVi4Rn2crx61dYMZGibNIsHM+t1WJWWDjIueZLsKCZBrKiKBwlSBLlEus9UEMIZIrV3ENi5O54UOGQjMf8SqsiF/LKkFwnXJJyMd7GFyJLWYIuztKPX3CZZqiuhGQrVaA/U4aQhPMSjEFbfC/KFwGRFCwXmWF8pgpbI2rMrkCCrsjpQQcsTaHnPHGYYhwtU0QcKXfnxbQevkllp3Pk8DpjfW6cf+Q5vs4vZ7WJtc1FWwTkhjv5oAn9yPnCQbH8rGxMQha/wUXjXxzXBl1xui6Wr5ScZ4I4+5GC/UnmWmG0zGcZsDfSCrsKIo4k5Su24HkOEnna+SEzla6Qe+h4/R4x22C5kJ5tDDNFsmDcsEshScSnJWNPSSdf9jB7YSsqsTkdclqAP69yZplBuKy53W/cMq/cOQgwe/rdhGaclNNfOu+dDMRSaQhc57Rmp5z+9ZUTehjlQsKwS0myO3XneNmrhX8uFvAszzhzI9mlH8r8Ia2cJwckVF4w/s/oQMTC8pRbfr/D/yoIt4YMrrm0DOchTM8gKy/JXssJyUimMTogteE10iyDPnuLXq9TvL0GCMKPSHXp/p0iVj4q9N+gL3ZZhmLBoUD/QUloRoRb9rIsMivyDNxaKEctwQtfrwtbeLKHSDfXNkJehZVxGk9TgY94dlFbyaU5N6ztCHI/1/zMlxDyFZ6idsHrbJMo7dKoqWFWETfUCHz/Cp9cdFGqB016s1qPIDrtPddqWY85S4je2Q7jinxq1e6BDT23aYCx3MKuITVj+95zf/ybsIv4FwmxM37Ohd886r3nHTcUj6aWUOjO/P/xmSOkrQa7SYffUPkoma1ckMPETrPRZ+8sfp0rYwS6WFa5ILjUQxlcQ2bw7LwZCYaiVCtRInRSZFz/4NBtuIcvo/oONwyINji7mEEosyEpZGBhWsh5IVNIw62Q2eEIz7iBphe85qw1vOG3hUyFvHLRL1tww8JqrFyNzqCB2DVoMV9NhSTWTRBTyhk+JWZ/QzegkVBJuEQPfQaM1heYvrzIAFPdCd26kZOCHqtHJ6T3+tu3wDMNPF1NA8Rn3QCS1y/IZgCy2scGBJfCoIaaalVYFJsdwY8bEZJnG1FsOfkNRH91830CDWWilt1FvML1n7u4NCVqpa+5F9XWZ9eRObcMj9RShqpyZkP2LDgWmxELu51zY8s71Ewshd2B4YbBe5PwLWIckoUEg5mFKrIUceZlatLjPM1BC5VW+IJMp6nXlluwLIdsxG0zLd/IFP1BqEkORVB2wSU7ZEsl7YKyhvMCE3sOv8Rdj0+FTAtj9WpqIIMEuXsquUjMNFEpTCvHbCvG1ej96fkzzmU4dwM7PgxDv8zzIxhYE/4oeIZW5Jil4kqUamcHuiYgYB6ArhGJG7s/th9EQriadWTHHlmHqxVLmKr5fJqrTCSrKabpH3bWy0cRcbnpfNtIFJIkCtJSXniS6IJnU71bZhrD9tDc524ew3klxWYZqnL0rEp8GCEowGxBPAcyrlOfSNllHVtT98H2lRPuFHhixTWi7GD42wqHA8MFmJrPQ1ZnG85lAchDjr0cvP/ZhwS8aV8n7uaAGc+4TGBa5Pfoy+3WehdWWMiDxOTp3+nY3Wpm97EvVCZS1Or4v0M4uBXkiD6lV+SLl0o3glwK5jFAC+QPfztqmBV9NrTKawZ/nbSOWI/l3mXTgLyqJGxFtTSPJZs9Cyu+c2PKei6GYZep5TAIPyVnimt0w8O4p6RfkGF0+Fm5VImSQ2FtM0+IwUfKPQpDyR4KS4VsZIExudyyaM6tmILE/BE6YVbzxCo9xSBsB27tkfuLaQnAxXuVf+NwcSV6xOWo+xy+lcAG/J/Tj23tcYOZM5Zr8tv53IKmWP8hXsD6rP3pd1H61S82wHtRiXGVmqA8JfOCcg3S+l2E1OJD8W+M/y7MG5DuxTmMrkIavHKYXmllDKY7wuISKBjY5ev4Efu7O0AxQulRhLighRJ5LXgiC1XohziGjzN1PyH0muRIuOJWXLcJ5GU8QTuYPaG+uXDwawi4JUrxmGv1J8ipx+NJNR1mffzyayG5v3Sj0ihrXDq9wtG5HSnekPHMgt6C7dRD2R23fxfiwvjqkxLhcNXSQpVSjVh/IZbhbAu5VKmYC1LbAeWQzXxKZMONUb522A4BR8kGyZ2iNKCvvRY3K2NhWQ4KOrztG5AWMFNXovcAP8GN/x4F1IRUSbVklJ70eC75N7Eslm08TaFzjnt+RlTffEsA0IvwOOBJDH1JUKbU1yLfRctnRCw4XGURDtac/GCo9qd+91Xd63xuJd3L8CFq5crD+jF+jIejQ7rJryu0WaaSr6BL409JN6zt3Iv5W9A2OsP1uqpmFZ70NWdWMV3IIB7t7bu11/HcvZ/ycAzYIn+eTWGlZOlwP247LTR372kOKV6lTi3/9pzbQr+QHHC/HrP8G6P1HrfHdbQfwIouJ+yKRJ58mw02DBorZKG/gy8bSG/epCkM5iL2TLE/ZFMCi1o88LoRvHcLFUoOZVPMaFdKrh1NmbPb5ZqvTX9Mqq4EwgIQVi5exRDRNoQrq/y92Dauy1r0C6t5bUwpdJ4spnahwSxUlk7BG5+odn/XxoC2BSWu+9Mq0AVZgNI211xk3F/mocefXQOj3Pz5q5/Yx4AcC5axdn+klKFkBBrJ34QG9k722Ht1DeyjwgJLzV5zuo6sG8xa38LeblMZvgQgrbsjyotxa2GZUxCLvQbk0jFe1XMUyJzocqjCxmoe03MPMISZ4kpyqzSm9rjIHpbW4yJ7TEqPi6we6LYRCHF3yI4tuJmWT58+m+Juc8sLDzzccjVG5UEeoZINNCzxxOnqPCQPqikzmCMwrBNAojMJNwg0OHriG6TTVJhZoQ3QZVJ1b71lY/XRe0hfLbcQ7q02ej87ZG8biAcUUL6uId0qmew98/bSQTrno9Eo5ulgEo+Bn8R8cMzjk+HJ8WSSHM6GJ6c7Nr3Wxri3799oxgn202mNs7X+GerN6UdtqgQssD6ieFQE4nsSaH5Qfc6jRte+1TL0wnvb7or/RT/osH9WWW0vmgspzGLqs5xoXbGQwLlez5CT9gRyMT419wjLqsVbOcFMOS9mSqDv88KM1QB2Otz/FN8j8wiZZEWKGt0BQt2iwZg1nklcidL3rUFA2pBdlc7+phen+Z4TVJc3Wskr5qPv9hp/ivwRbO5UMkiMtUMW70+Ru0tXahxhw9Hh+OjlBhFbKAmProe4wNmhGiII+XDQuChNQn33nsKTFq4CHLZdPdZEB6/v7AJMrby3Sla5K5xWAP+QRPZGtHbXEXyst4hUNRl0+u5csDbbecpBxjN1UytvsL4ba2txQxXbPzqbgEuGar42Q9RzBE+zQLlJb8mcD2vut/l+4MPNIa3iHe2gpVDQzA5Lh89pzqMiEKwJhtS3aL3wc15UnQRSYSfXUlgbRplgVWbciOSZo3NOZX5Bfwdvk5yM/UJY7Ig1NTvkw8AN/keg240vDt+yuxvXK74nwX/DsvCgZ67oWlR7l1VXhRqD0lCtYfeMOXryJLYnyVs5Z4cB5vAZVaYnlpkiz5W2LCXnKFu1b/i9Ogp7cDegT56HbhU/1FB2C6at26xd5WLY6Tl9XMHLW+oSla2ylzVtlZJ9mE9nQtvF/qu8pnv1OaPpZWjsLSiVTTgHkHTOw65py1rQxzjx3nk/GXEYHw9P4pTz03gM6Uk8OYJBPJxAepQOACaHRztUGt2GPSIozTLO3gr75xWm4lKq+OWozDFcYyiwxMOL1m0Y/pqLciFiedXsibAh0HliSo3Sk9n8eJTEMz6bx2M+HMWT0ekoPhwPYJSeJnw2muyg1OO00DvDBV+wH0FnQpZkQrpkKyLRje9eeRiFgk8N0jh/usx77K7b2V6rtbOE1XujdU6vF11uxKQMLuXO+tDGsEdHazi7FTEyvILtsd8AvmKqSdoFtd79DfgmrEPSpNS9TxwqhYV2aXtVM6jNDslGt2K8pdgdmyVHo4e2OnaNjvVGx66LtOsi7bpIuy7Srou06yLtOgq7LtLuzLsu0q6LtOsi7bpIuy7Srou06yLtuki7LtKui7TrIu26SLsu0q6LtOsi7bpIuy7Srou06yLtuki7LtKui7TrIu26SLsu0q6LtOsi7bpIuy7Srou06yLtuki7LtKui/ThOemui7TrIu26SLsu0q6LtOsi7bpIuy7Srou06yLtuki7LtKui/Qf3kVKaWHvPjqs/Wvv/yf+L2wHi88v3sX/XebDBFb1L4Cn5BZUjZLb3k8+GoyO4sFxPDxyr2Sf8yKzKE/V92tvtH+NuCyF9D1uqB5jJF/Kzi/elW+q58aoRNB9Krnl1KOGA7AtjxrUJJ6pqKqGem5MrePzhWGfl0LSTVwN9p7tkTwXsZ8p5NW/e4Bx7euXiAb22rm4yFO4vG8hD5gom3OyLuuv1aYXCYeWleqircocuqaYbQdyh6+A95b2R5WS49+e++Cm2HYPT7MTp5aAvf815kmhNYpiOFS/Qwe61sFakde1nu55QrXTcaDjjK9Av6TkDF7gYYxM60u2UDeU2DXgLunnAjJqmvM9IdFZdHw4OTo9OZ6MJ0cwGk6SZD7h4/HpbHY8mA/HLsG+rRMpCAZloqJe1MxQOSFpU6mVPkKQxOB0ly+My2r1WHhvuHsdOn4wLFWkgNGtpj5PrETNC+pCbYBoJ8o2wWpVhYZ3rM92NR1VG67eYx71Ive29fXd/oTEr+04NC/SSoRwBcYjGTpKqmvQInc5Jfdy9uFgQBPdkj0fHNFmyle84yZx2QzvJepQS/OAu9n+2vaSGKZOitASFSjR3Oo5PvWVGC55SAD67FdPYt9EvvGA+rv6KJvy+LCGNWSzxk0kKhzal1NWe8/HaTQ/10Jpn2tozvmFokKkgB/iSgR5smjS5D+qAUMkBdKeXP5yMfSL+uy9P6vCNd8R56LKk1bwrPbydWpkRjckcLA76/rRlXmqzWf3bl4JiDBN1vIZOMdYlBPrsSNf4vGXo/5g8JIwC+yJNqpx+0tXJLvZjbXWr8tEiQOJUfkgYHLsEDke/PVl+YbwekdvdfNFpPgS3iFucuBfgZtVTH3kNevlvan3IYFfH4tMEKtr0FqkSHlfIo661II0lHRBl8O5SN9i0uNxrdE89vkn58Rhx7HX7xE5/M152tzwq2owWrX6oPYWyoFbtrJ5bnNLFQy/NbSz/i7jLMoLEke06WfRwfXwoCzQOLitGf+7g7VbECq28v5YoTP0uby947lw5i5OYUk2b00WX8NStQ7CwYvdjQ0+xs1tAbwR5oVeO9w6zBwf494NJAVK6gf0FpwC8hmj8wR90fMCiVFqE1w8+JH4eQZck9y1e+oJREztn4wXdoFCHWobetEHKkj7nhUchC0L3PUi9IJ+rfynN8EXqPk797sFpQYKxr8yoE3zGGxJ9El+lepG4s9NwJkrYuuRSqIMsyuQCv4+uevoxiJXlkjVHO1ehH61+WX+AfS1SKB2+JUDRT+acEADD1KkBtqSmD7jbbbxU9cafSFL1JIu+QmPF4a98aLKQl0petipSgpkdaLsv/mfYuEuae/d4tdhVfYr/lyGz8y6C3DkXv/0PytmpSBGGbvksgbnk7uabzlPqP2wnr7yoRsbua3cYA/ANBySzVD6DLtUMPy2ynljGDU2TbaLUpxz4ZojC/9jGvjrPCZReMKXpVpoqgRzdqOFhcuKhSx8swd5xgUJAInyrVc1n6PrIVGsar84a8YaLX3zBVs9jMWZt7cYaX3S2d0dfv1HARirfv6Cik5TdSrppFRQVJlGZ3OeGdhBxB+CO/OS7YhjNm4qdJbLVU3PRr7NvRE9uW4VF5Xuh96/dKy5ha6Ofpvj+5LMlfV75YgVf2yY4vUYsZqBiji3O8fWzeTFp49RL5r5sHSpyFXQ/AbjW37jzjxc0WDcit/dRhmXV4XLlTiQqAV4U/mXyt7/UfvFkyZX3d66ER/VV5B3dyWTWfxMeZW7/wWy9pbh +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"; + + + + + + + + + + +Updates the payment method for an employee. Can set to Check or Direct Deposit with split configuration. + +scope: `employee_payment_methods:write` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/put-v-1-employees-employee-id-rehire.ParamsDetails.json b/docs/api/put-v-1-employees-employee-id-rehire.ParamsDetails.json new file mode 100644 index 000000000..230d65c22 --- /dev/null +++ b/docs/api/put-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/put-v-1-employees-employee-id-rehire.RequestSchema.json b/docs/api/put-v-1-employees-employee-id-rehire.RequestSchema.json new file mode 100644 index 000000000..f64b5bc4f --- /dev/null +++ b/docs/api/put-v-1-employees-employee-id-rehire.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"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"},{"type":"object","properties":{"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."}},"required":["effective_date","file_new_hire_report","work_location_uuid"],"title":"Rehire-Body"}]},"examples":{"Example":{"value":{"version":"1928d0c378e519e9c03fb959bc959a6b","effective_date":"2023-06-30","work_location_uuid":"b6ae9d93-d4b8-4119-8c96-dba595dd8c30","file_new_hire_report":true}}}}}}} \ No newline at end of file diff --git a/docs/api/put-v-1-employees-employee-id-rehire.StatusCodes.json b/docs/api/put-v-1-employees-employee-id-rehire.StatusCodes.json new file mode 100644 index 000000000..5016bf52a --- /dev/null +++ b/docs/api/put-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"}}}}}},"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/put-v-1-employees-employee-id-rehire.api.mdx b/docs/api/put-v-1-employees-employee-id-rehire.api.mdx new file mode 100644 index 000000000..535d02cfc --- /dev/null +++ b/docs/api/put-v-1-employees-employee-id-rehire.api.mdx @@ -0,0 +1,71 @@ +--- +id: put-v-1-employees-employee-id-rehire +title: "Update an employee rehire" +description: "Update an employee's rehire." +sidebar_label: "Update an employee rehire" +hide_title: true +hide_table_of_contents: true +api: eJztPWuT2zaSfwXH/eA4Jc5IGs1D/nRe27n1hyQu27ncluOiQbIpYU0BDADOjOKa/37VDYCkniONZ+qutuiqVDQi0Gg00O9u8Vt0G89qY1UspIWZ5lYoGdtlBdGLTxEsUshzyKNBxKuqO8REnweR5TODw94sqlItAZj7sABp6bkGUylpwEQvvkXj4RD/l4PJtKgQRvQienPLF1UJLIyMBlGmpAVpcSyvqlJktN7pvwxO+BaZbA4Ljp8ckpFK/wWZjQZRpVUF2gq33DVoI9wUP9BYLeQsGqyh8HEOLKu1BmmZn8RUwewcmAN9wj4A0N+f/HMhZ2xWixw+/zC3tjIvTk9zlZkTIuRJphangXBxxZdalSU9P22n/82Bjku+BP2cFUozIQulF7RZpiSbqxtmFasNLi0MKwSU+Ul0N4igKCCz4hqSnFs4bIM5X7KbOUjaBoTj0mBrLQ2uc6P0V4JeiBISCTfJXGhINFRK284aqVIlcLl1Ef+MFSWfMSFzOjo5w4XtHDT7LyQPuxFlyXAVxpmEG4brMLcO0aGLIWGEqCWlcvcgqWuRH7ZnHBlOMgB8ZminLIBzBG1ubWIst7U5DH4HZguBOQgn7ENdVeUSt88lE/Kal4gNzXckMGA7qHVWx+P4USqbGLA/nkSDCGS9QDaruLaJFQvkkqIuy/C5+T6BUsxEWuKX11wL7j4a4EZJXkaDyIONPt8NInujkgp0RivPuYa5KnPQBxz27/5AVy6TMIwze6OYh8k6MMMxZGpRcbk8YR+bK82ULJeMOB1o624M/nEj7Byp9yF+pXTFQFphlwxx6xwbwBFX4rff3r5evxJIYQ08/1WWy+iF1TXcDSJODPZAUjwzTANd6zk3bKYkMCGtYo5xt6x3N4huY3CikC6f/xyPViRZNIbp2TCfnPEszdPxZFRcFaMJH+fnZ6OCT0aX0QZRoqtsPB1eXAzj9CKbxhOeX8bT4gJi4KPJBefF5RSuona/BS8NbIqYaDwcT+LhRXw2jLbyS/eObZcgHvI2Zo6usvTqEsYQn6dnw3iSjc5iPikmcVoURZZCPhpdIZI7LyzBRipaYUtE9z2Rny5Jh6pe2RBNeVnDdxM355PJaDS9iCdnfBpP8vFZzPPzPC7OLjO4SNPpNBseTNxRPBw9iHr5OLsa5pNJfHV+mcaTfJLHaQaTeHzG4XycZVcXZ+ngXvJtP9ZWzNzRv0E0GU421fgvyrKfVC3zP+Qf8keGrKbhzxqMhRx1u6p1BixXYJhUlsGtMPaE/cy/AjO1dsq10upa5JA7JhWGkcg8CfC2S1vhAAqn2LSYzZ0EJq4+2JJY3cxvstIqA2NQfLI3JHX+kIz9IUlqLfiSzXlVgWw1aqryJcqVpap12DnD5bmQhoHWShtm6mzOuGFfvDZIuLVapLWFhK7jlwHz6i9AKLgoDctrQLnIZTsTDR3azJeOcfLGLfOKW5gpLcAcaZ0QmnHWTH/ubBxSygulgeVgEaGTP1AMrltfiLPQkJPZSJigBbhqk/nvW6nKtebLaBAJCwuzzabbgJp8BZzgsVzuWING3asRPlSQiYI0zRz8LaTpTGVZrc0J+7isRMbLculssK+wZCJHPUSzcHxzhqcV13wBFvAClBwvvlUtSNJYDdZHoIYQcCxeLweJ2CGACmzjbxmbaVVXQs4M4zJnGZcsBTQiCZu0FmXOMrwHCz9+zmVeopUipLu9HRv/hL0t2oWEYV8kcXTizvHLoGMkO5vGX3my7Ij3v/ihzB/S0il1r8rdQyLNAvltdoA1+y7s199GxlNV287ZxWwGEnR7ah50IIapdcEzRxAuGcgc6aM9Fpbn3G51L1bReBWYW0MJ11xahvMQpr8gS8/JXvYJyYinyfxDseElUlrCCftJaeYV1WAFBOFHpPri/p8gVl/obMM3qAW+OPKnrRRF+ack/FpELz7dt5dFXVqBXhhBRD5aY7zw9SazhSdHsPTq2kbIWVgZp/E8F/iIl+86K6GVtHVtR5D7b80vfAGN4eftyDnvXptMaeeE5miFOgOzJfD9K/wmxZ81tOJBt84MgSGITnoXWi1agJ9aiLIuSzLN3bi6SqzaP3BFzm0bQMpw35CO1fSzv/3x78LO418lxE75RXe7R/3s744bikdzN+jP/N/hzBHSToW95gSh8CE/jiw7JvaqjRP2lgy3ShmDzipKvDm/BtbIoRKuoTR4dl6NBEXRiJUoEzqrS65/cOjGZPzEv9KFex51d7hlgLvQqy5XyuXXhGeZqqVNcijBQlLLopY55EnFfVCrY8R8WrE1opS76FWj4qMNYy3qqLnop1rmQs5+BjtXOTmKYTXWrEZnsILYNWhRLBMh6epmiGmljHhUzP6JZgCuyvyqqDnRyk6B0foC8hP2rgRugGVzyL46IwUtVo8O4wuciKp91xZ4iU7wMgkQn3QDSF6/IEsBZLuPLQguhEEJlWhVY/hqD2J+RCLrRQp6O4prRv4Kou/dfObmI08Etevx8jchyZQsxMw0qDW25lFU25zdRealZXiklmG8ojVmF7WxXcNiO2JhtwU3NnBLUoqFsHsw3DL4aBL+hBh7GIxgMDNXdZkjztxTtsEZ/V+h8hZfkHkTRd2BZTNkK27baflG5mgPQodzyIOycy7ZGVsoaecGbcKitjUGKhA/HxxLhMxrY/UyMVBioEDJRHKRmSRTOUYEgmG2E+N29PH0/AXnMpy75ToehqFf5ukRDFcT/qx5iVrkguViJhqxswddExAwB6BrRObGHo/tB5ERrmYT2YlH1uFK4VtVFEmlSpEtE8kXB5714kFEXGw733UkakkcBXnDLzzLdM3LRO/nmZVhR0jul24ew3kNxdISRTlaVg0+jBAUYHYgXgEp18QHUvZpx7Wpx2D7yjF3DhTgQ5QdDOfjehwYLsBUUYSozi6cQ4DLHHLszeDjzz4k6wzjGg6/ASkvucwgqat75OVubb0Pq1dcUiSP5/+iY3ermf3HPlelyFGq438O4WBWkCH6mFbRKydMGjOCTArmMUAN5A9/N2qYe3kytJrYKlnS2xAbsMqbbBrwrioJO1Ft1GNzzZ7kKr71abEmh4Rul+nEMAg/JVPFNZrhYdxj0i/wMBr8rFmqQcmhsLGZR8TgI8UeMXsmvVsaotk+CozB5TWN5syKBCTGj9AIs5pnVulEUVJpJ27rI49n0waA8/da+8bhkhPD0i1H2dfk8tbwf0o7dm2PW9ScsVyT3c4LC5p8/UOsgM1Zx9PvXWNXP9sC71nLxm1oguKUzDPKNUjrdxFCi4fivzL+uzBfgXQvzmF069JgyiGZaWUMhjvC4hLIGdhn6/gRx5s7QD5CY1EEv2ANJbJa8ETmqtaHGIYPU3X/QOgdzpEw45gOXMPG83iGerB8RHnzzsHvIOCWaNij0OovkInH41ElHUZ9/PIbLrlPumFs4a01Lpze4ujMjhwzZLy0oHdgm3go+/3270JcGJYCCrcG4ZBqWUOVQo3CkAHoka3lQuWioMKMBuUQzXxMZEPGqNo4bIeAo+QKyZ2gNKCvvRQ3S2Nh0QwKMnzdNiApYBJXvHSAneDGf48AWoXUcrVkFJ70eC74rVjUi3U8Ta0rjnt+QlTf3GYAaEV4HPAkRsMhUbVU6mtd7aPlEyIWDK6mYA9z7T+Y5yfRau6rzet8Wgu6N+5DtBYrD+vH+Gc8Gp/hDlcEWlqq7CvoRvlT0A2r3o66/GvQthrDdCO8IbwSBxSSKY31SFYxXcvAHuvbd2tv4rl/P83hGLB19TSb4nlrmpqHbWcNzf17KiDHVGpi+e1TbgvtQjLA/XrM8ltG6z1sj5toH3AVXUzYFYk8+jZXrmGQWCEK/R33cgXp7Zs0tcFYxJEh9kM2JbCoxQPvKsF7t9Ci5FA2dUq7UnLjaJqY3T7TfGP6Q0J1DRAWgLBm8daHiHYh3Grl78V2JV22Rr+wmpfGFELn2Tyxcw0GC7oS8Mon6uTv1jGgbUGD6/G0CnQJBVj8mouS+2QeWvzlNTCKzb989Q/2MSDHgmbs5I+UMhSMQCX5OxZNvpUD9rO6BvZRYVGZZq85pSO7CrNT3X202dS4LwHIWu6I4mLcWlhU5MRiFTaZdIy39Ry18aW9qraxKmJ67gEGN1PMJLdKY2iPi/KwsB4X5UNCelyUXUd3HYHgd4fo2JybpHn6+NEUl81tEh54uM1qjMqDmkJgfw00LPDEKXUeggftlBQKBIZ1Akh0KhtXMhjVC3ELeZILk9baACWT2rz1jo11Rx/BfZ3YQshbbbV+9vDeLhCrOCibFFhPuULd1x2kietoiKPCE28vH+YFH4/HMc+HV/EE+GXMhxc8vhxdXlxdZWfp6HK6Z9MB2oKy3Q+x/V2Cz81v9KeTGi/Ya4G5cPbaJZ8H7BUmpU+idaoELHx164Ox8GX6XvQ5ixpN+2oVy2fe2nYp/mcnQYa1h7svWEOxv0NuxY5i2xtu1u9IVAgpzDzxUU7UrlhI4EyvJ4hJewI5Hx/r32+FZe3iazHBpqyZQN9nhRmrAWwyOv4Uf8bLI2RW1jlKdAcIZYsGYzbuTOZKlL5vDQKyDtlV6RyvenEaktZHiW+0kjPmve/1Nf4S1QOuuRPJINHXDlG8v0Tlkq4/wMnshI3GZ5Pz51tYbK4kPLge4h3ODtUQgclHw5VEKVYclCLbF2nYyjx57SrAYVfqscM6mL6zczCd8t42WOVSOGsO/CGB7K1o7a8j+Niti29rMuj0fUeRZt5SDjxeqptOeQPVcu0rbmh9+wdHE3DJUM23fiG6MYLHWaDZpNdkzoY19+t8P/BwdUireEM7SClkNLNH0+FzmvMgD4S6oHJGj9gzP+dZ20kgqbtqIawNo0zQKik3Inti75xTmV+Q38HaJCPjOBdWAuSmo4e8G7jF/gh0u/HF4Tt2R4+PJvjvWBYe5MyM0qLam6y6LdQYNopqA7snjNGTJbE7SL4Wc3YYYAyfUWV6ZpmpK+qpzMk4KpfrGX4vjsIeXAb00ePQa8UPHZTdgvlaNmtfuZjQxiYPK3j5CecyuVb2siGtctIPRZIKbefHr/Ka8uoFo+mNa+w1KJVNOAOQZM5hadqmFvQhRrw33i/HHCYXo8s459imBvllfHUOw3h0Bfl5PgS4OjvfI9IoG/YAp7QsOftJ2L9mGIrLqeKXozBHd40hw9Idnq9lw7AtVjkXsUk1eyJscXQemVLj/DItLsZZnPK0iCd8NI6vxtNxfDYZwjifZjwdX+2h1MOk0FvDBZ+zv4MuhWzIhHTBxljpaXUwhYJNDdI4e7qJe+yv29ldq7W3hNVbo92b3i263IpJ41zKvfWhK8Me7K3h7DWPkWEKdsB+B/iKoSZp59R690/g27AOQZNG9j6yqxQW2iftVUeh3q0U8K90K8Zbi93v74Ldm26ii7W2p1B+HpyYVZP16F5N3JJvLx2PD+vIZH1L5npLZt/v2ve79v2ufb9r3+/a97v2vY99v2t/5n2/a9/v2ve79v2ufb9r3+/a97v2/a59v2vf79r3u/b9rn2/a9/v2ve79v2ufb9r3+/a97v2/a59v2vf79r3u/b9rn2/a9/v2ve79v2ufb9r3+/a97v2/a59v2vf73p4TLrvd+37Xft+177fte937ftd+37Xvt+173ft+137fte+37Xvd/2/7Hf9ezAU7ut2/f9vMdwNovcdvXHfhv5NFMjdIPql0SD37blXJb0q+Q5VEtrQG+n1FvdW1Ta+HsVNIrL5lIg8dq/63uyV8iF0ufla8BN8S7LJVAUv2Je2Qd68uNHCwhf3Rnfn+jpCEQt3suHkWwpJEorYrg21uy6yttV7taHr7tCXohOj+2X/J/4v7KCNX757G/93k0Kg5efAc5KLLQL+ZdKry7zGvSyE9P29SJkYxW3OXr57G9IIjBujMkG1JBSSoP5cHIAtydScK+ld6m3F5MCN6XS7PzPs00JIqkLowD6yNZxXIvYzhZz9zQOMO18/RzSwzxjF9y5yY8lAvcCOtPFwfI7vTx+dY1NpDgWvS+te/R2+v7v7PAgxk7+rnKIY6+d6cIc/L8sdrbCrDYadvNIG6uF3IqLzi3w4zEaXV2l2eTY9S8d8PLyA/IJfXfAiSycbd58atmut0RwJh+svmMOj08Xfktm13x95UiKHRaUsyGz5nILSWLiAsUFaU7K5uqGElgFXnFQIKNEHu1tt+Q10+NwaGv6qk5nxvqv/9lN0/e3u9/VUfiR+WLa/rdAUB2uwtZbYqcnwve/UXLn97fDNGqlSJXC5dRH/jBUlx+73nC6PnOHCdg6aEZO7vmpcxaedcB3m1mmbPT2GhNG2V9IfsmccuS51nhnaKQvgXIfq5mvpD4G//TdIHIQTRqGnpU9pNrHFyrWrIwlQU7SodVbH4/gRAwgG7I8nHRavuLYJ+v/RICpqrHNzn5vvEyjFDBtAI2x+1VQUh8IDuMFe4MhlSgxYamq1Nwq7tzJaec41YD7ZxVvvOezf/YGuXCast2b2huJpGVGihRmOoUlSfmw4xVU9k6wB2npT4exENJfsQ/xK6arpOF5WsMlea0yx4x5vvUwdjnxP2jMm4ejade/5WZtGukWj6fgqH2Znl1dwPprCNBueFen0fJpm0/Mpv0jxHNcYF2XzGcrms+F2zF5E6QWHaT49i/NJehVPRqNpfJVNL+I85efT8zy/ymjudqZFiR7MjdvYVMC/AjfLmH7RoqPt37QGQrQ6EvVzrK5Ba5EDBdy9JQK3FqSh4C+qAGdh3cYkS+POD17EPg7uCfYpCjIWm9SrqjvURGRABlDr6DYwtqK9feYq+i0Evw1Uhz5/ShYYsZKdRy+i0+vRaWOLnX7rmEV3pw0NqLDT20+1LtFY8XqFV8KplTiHBemWDRZ6DQu1RmwHL3bZYXyMm9oBeCvMd5oywbtgVvgY92wgqzVlMT59C17myww93pc1bv/T5+6oD6jyHQdsGdvICkQxGCokO4BrMtzWf+WDQMTUkM54befI1qHaahB9oBLZ71nBQdixwN0gQlPmfWsEdbm6YeYD7JENZm40xW5m3MHkrUG0qYhWhP5OiU2cjhazK/0M4swp3Jfv3uLdbzbXsQgHEVrN5tfiA+hrkUHnqrVmEf0czCkNPM2RqmiMxPQ31ukYP3VDSUCZqQWVLxEezwx745mfhYp5tJ9zldW4ZSLJf/gfmeIuHen9g9dhVfYefwjI55xcaQ/yin/6ny1r4EFXytgFlx04mx4T2+5bfWvt4O9zs/zVtXBrT6uSC7rjxNPfvKz5FF2PmqN3PV8vVt0wj+Jn7CszFmd8+4auzW+6vLvDr/+sAf3ZT587Wh9ZOxcUwtrhMnX3+EMwP5+znf7ajs2En7GQy46Ajfxvaqw4lK41zvlzx6H3b+7cbaWro992z7ghc6v2XjlixR9X9O2mD9fOQBlb2b1ju/rx3W8fo0GUerdxoZw9wG/wgvIbd+YhH4x+JX73LSq5nNUukuJA4r//BcNIu2w= +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"; + + + + + + + + + + +Update an employee's rehire. + +scope: `employments:write` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/put-v-1-employees-employee-id-state-taxes.ParamsDetails.json b/docs/api/put-v-1-employees-employee-id-state-taxes.ParamsDetails.json new file mode 100644 index 000000000..f3db089c4 --- /dev/null +++ b/docs/api/put-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/put-v-1-employees-employee-id-state-taxes.RequestSchema.json b/docs/api/put-v-1-employees-employee-id-state-taxes.RequestSchema.json new file mode 100644 index 000000000..8676b1295 --- /dev/null +++ b/docs/api/put-v-1-employees-employee-id-state-taxes.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"states":{"type":"array","uniqueItems":true,"items":{"type":"object","properties":{"state":{"type":"string"},"questions":{"type":"array","uniqueItems":true,"items":{"type":"object","properties":{"key":{"type":"string"},"answers":{"type":"array","uniqueItems":true,"items":{"type":"object","properties":{"value":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"}]},"valid_from":{"type":"string"},"valid_up_to":{"type":["string","null"]}},"required":["value","valid_from"]}}},"required":["key"]}}},"required":["state"]}}},"required":["states"],"title":"Employee-State-Taxes-Request"}}},"required":true}} \ No newline at end of file diff --git a/docs/api/put-v-1-employees-employee-id-state-taxes.StatusCodes.json b/docs/api/put-v-1-employees-employee-id-state-taxes.StatusCodes.json new file mode 100644 index 000000000..582d82bd1 --- /dev/null +++ b/docs/api/put-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"}}}},"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/put-v-1-employees-employee-id-state-taxes.api.mdx b/docs/api/put-v-1-employees-employee-id-state-taxes.api.mdx new file mode 100644 index 000000000..7634ed785 --- /dev/null +++ b/docs/api/put-v-1-employees-employee-id-state-taxes.api.mdx @@ -0,0 +1,73 @@ +--- +id: put-v-1-employees-employee-id-state-taxes +title: "Update an employee's state taxes" +description: "Update attributes relevant for an employee's state taxes." +sidebar_label: "Update an employee's state taxes" +hide_title: true +hide_table_of_contents: true +api: eJztPGlvHDl2f4WpfNAY6Godli9hZxOtZK8FrD1eS85kYBsldtXrbq6qyBqS1VKPIWB/SPLn9pcE75Gsqw91yxKSLObDwKMuHo/vvshvkSpBcyuUPMuio6isbDzbj6EoczUHMPX/JSKLjeUWEstvwESDKAOTalHi1Ogo+lRm3ALj1moxqiwYpiGHGZeWjZVmXLKw0o5htBCjhYZf5Bd5bJhbbQQZDbdTYH9+fcFAZqUS0g7oFy7NNWjDispYNgJmqrLMBWRMSPoO4zGkVswgRlhopYLbARtVlqWV1iBtPmdK5nPGmRFykoc12bXIc1ySpymUODdmlzOeiywZa1VcMi6z8ENVJlZd1kBcfokO9vb34r39eG//S+SHyirPL5kGUzqI8jkd1KSqhCN2WWO1hdKjay0sXEaDyPKJiY4+R6/9KHbBb9g52KqMvg6im3hSGatiIS1MHOliOy8BZ0AxgiyDDMeVXPMCLGhc61skeQHRUfSf8Z9p9vGHs/g/QBuk3iASSMIp8Ax0NIhMOoWCR0ffIrduZKwWchINIpBVgfsc7B08i/eex/vPcKcMxrzKbXTU/v22zyGnCEshJBgiFpIoHnEDGTv+cMZmDhbGjVGpIPJdCztlc1VpGpDyPB+yszGTSgIThpVazUQG2cCN4cgLKaFjx7DPhZCiqIr22l9/mFpbmqPd3UylZkhYHKaq2A1Yi0s+1yrP6fsuL0XsZwo5+Ve/YNz6+QmCURnIhtHtoMZwTduqElnAbcntdEFmLqbAPn06O2Vq7PjXz4wGkYZfK6Ehi46srmA1SW5vvw4iA2mlhZ0TnU9UUXI5P05TMOa4stPo6PPX2xbfaHPNJ2Fd5FAlDRhc+mBvD//pAmkqWmlc5dEgSpW0IC2OauF7928Gh35bhJJrzecR7g03vChzt49fkpi/ctzZRdpRlL56/jQdvXoVj2E/jQ85fxm/yg5fxvs8O9jf59nTV8/HyKkoPtFRdHIcDaKxyCGRcJ1MhYZEQ6m0jY7GPDcwiIRJrpW+SvwMd/pfKzB4AAeDMEn4IRkrnfCsEDJBdVGvkvMR5NFR9EbkQk7YuTvAMrq+BZ4hXd+qysBU5Rlzp3V8ijKgWCULrrVTYJmYiaziuWHXU8WmfAaMowrlqD1YLma4H0mEnULhNZ7QbKoKILGopKk0DJjGjZGb/sCZ5XoC9sedZJRzebWDMsfj0bzkhtTzjztSqRIkaCaVhjFoDXqHWT4SMoObH3f2dthUw/jHnSA419fXw7EdDVM+nKjZLmJ8twRtlOQ5/iXkJHbn3KUlhlNb5Dt/PDlmHYwxuClzLol5/rDL/zj8gkroCubRUeRWCbyB4lNWtkOYgtsWi51DDqmNBpEqG1LOeF7Rx6ih2TkpfJLU8Pld6/M7TwrSLjJVRW/o6ZKxSLBlg9+2xi4wQmfk69bIU8XeK8t+Fnbqxn29HUTe5nVOhWA3xonUbjBA9ReyUtER2iFcZyvuDhAgwY7zXF1zmcISLheGEUioBiVABhlydcrztMrJwLd02o5hJ8ceV2j5iZf9Jh3+rQw8KvtClgX2LbNxUlajJLV6N4PDYZmNiVdPX8eH5Dwgby4eyZ254LLiOdn1mndbZ0p4C3F38fD7qhiBjpaTe/9xiX2cZQLH8Zy16L5A7V9UxVIua7KhR8ebqbxQlbTI5yc8F2OlpeAtaoNhU9AwrDHVTE2uO7vehaoT8uPS+QpkRXvDvYeWDmcrWqofVfN7uGZvhQb2kezMvy0g7Jx83JxfM2/LDfopyE1jt4KEa4aWijlLRZgVkh3ssYzPDaJyKtDGM6WZhtj/0XKkh22duWj5vk91dg/9C5iBgxsFwLnvffjRby9g2FZvPVZ7rwbszNu2HO3UnNZE92mFqvMLbEfOr7SasFCY1mHV6G/usKXGkMcK54v0HI9Fl3fRtLdUGk26rf2QO2dfK5aDtaDZp3OPRj4aaZgJsoW41HIvJqz8ORoplQNHnYPHjeioXd+mhiIMve14OgvO2YaY8lS864zHzEyRHaywOdTBXNh/ISxoDlav5861sK50XoNwbkPwmcPCLGYWDVLB5wy9VC4kEzIXEhj6ID4WxLAiF/LKIJs64bn7PJUUv6KRy0BaMRagF/b+IRxzImYgHWGfsJhiA0JBhdExim8TxhIE69TOMjLeJdErSOe+3nXSUx+Cu/gMx+JBWwi+gBs7YM5YDZjTHgMWNPKAnSL73bbUyQKrOVSeOYZzKqYLwxul2RevmL5EDoiad30WAA0rZM4MGwq3M2HKnM8ZsagZbs7TXs30Y55j2d0FtbZPFHSYeRApCT+NSWP14rLBEvLVP0lv71F4NxarziGZnXLLUqVdAJdRPNEwlwM7ur1tR5Kf/V5fb/u/09ZfBxHJLHqlXsPFZMTiC34TnyHnxX/1J4/fOM5ra+376pWaBhvgMiDuDuzmeXS7oEAuGux4XDXoQ9FcpkkwI8QcGAMmPeP7LQdomHEvkuS2idrIiIRcFSVCgkbx8MWtdBXPr9Ed+Mff/6sxfP/4+3+3NvXWb2NN2t0eUH42AsGf9XYtnxzT9GiBxRzrdUFxGniVVmtYa62eXM+2f63tzgJE/TyNs55tU7l2aTDxX4SxfuHDvcNFNYLR3BtVyWybzMmKJdgXydgXibTDQ4BBU6bBqEqnwDIFhkllGdwIY4fsHb/C9Kh2/lrIlLGz013KN7nATWSoKfvC2UGR1koTHnpOk/t9C5FfWDVxpE+5hYnS8xV7JBuZ6PMSUjTMmDsBf2aazlSaVtoM2cW8FJhAnDvRvoJ5Y86duasT17t13tSlX1xQWy9JcldDvQVobZvqVmJIzLBUIJLxkE+0qkohJ87AYeQ1AudPWMVGlcgzlmI6r/Djp1xmlGER0uVDW+lhgrkAY/hkAzfgQwAkA8tFbhgfqcq2kBqzCQbdDTr90gFKU+kxTx2kGK7IDAFHzDlZ6SYDpbLJmISkxVifO/SPPMe3+eWoNbF1uGiFgFxzJx80geKNlhp7r2xMQha/xk3jnxzXesk+OFgUy0+y1ApzmHyUA3strbBzzO9fBMMx5WUJEvnRlSZGKpsj5Yk0Hr7gp3qSG2aqdMq4YZdCOs1eM2VCRvKSTI5tTsjGRKAseCjNzLqqczlk5+BE4vNrt82Jw6EAs2VGnMCM03r6EzapROac/EJpCBzjUiL31HjLUet03+/IDcj9XWv/82ttzIrWGwnDLiUptcTR8dJFQ45Wrn4Z4l7MLZH6u/RDmSfS3FUQgITKC8b/GeOAUFiOOd5lrNgF4yQId11kxnm4pmeQuZdkr/6FbNx7UhteI41yGDKMOb1FGnSWIPgIVZfu3wSh8hVe/ws6j5d1+Th4WsNloeGKsxRVbkWZg9tLUG29I3jh50VhC1+2EOlecc8Vwd1Z0OOu07IfWju5QH3J3g4hd3PNe17U8YXHKMWvDdt0I1nihhaC797h00KOJqRk3DIrY7SFaGnjsKqfQFo2oJeRWxzS8kLeee6PMQ0f/yQhdsbPxVLLR73zvOOGImlacfDvNP9/THNcaaXB7uLhZ1Q+1NVC0R8Ta83GkJ1Zap9Qxgh0sawvN9d6KIcZ5FSA8GYkGIparUSp0FgQ0z84cDt+85NuimBxQLQkChhxeZXwNMUqUpJBDhaSSo4rmUGWlHxegLRmTYSAjSTd8GDBWeuECW8qSvq8AztVGZtyw8JurN6NaNABbAZajOcJ1rW0hhQhLZURDwrZL+gG4K7M74qWE0OXETDaX0A2ZB9y4AZYOoX0yjkp6LF6cHw1zgxXH8HXX5Kw4qMeANEbCj4jANmcYwmAhTCooRKtKsyYr4sK3YjEJwWXgthz8juAfnTzfV4PZSKYXQ+X54QkVXIsJqYGrfY1t8La4uw2MMeWIUkt9R80zmzoMguOxXLAwmnH3NggLUkuCmHXQLhk8NYofIMQ+zUYrYHVnyrPXOa0necu+TwpQQuVNfCCzJLMa8sVUNZDlsK2HJevQ0qzkRyKoOyUS/aUFUraqUGfcFzZSoODL3V9U4mQWWWsnieGihCYcZRcpCZJVYb1uOCYrYS4Gb09Pt/jXIZzl7DjZhD6bR4fwMCa8Ct2wVjFnrNMTEStdtaAawIAZgNwjUjd2O2hPRcpwWoWgT30wDpYrSggUeNxUqpcpPMEW/k2o3VxLyQWy+jbB6KSJFGQ1fLC01RXPE/0epnpDNtCcx+7eQzn1Rij3htXxAzwMAJQgFkBeAlkXBOfSFlnHXtTt4H2xAl3BhwLGQiyW8PFuB4GhhswNR6HrM4qmOuO503IXg/envahkGAY17A5B4x4jr1ECRWS19F+tbVeB9UJl5Qe5dnfiOxuN7Oe7FOViwy1Ov7nAA5uBTmiD+kV+a7W2o0gl4J5CNACeeKvBg3TxY8GVl1/8Y2bi4ANWOldNg1UbZOwEtTaPNZs9iiseObG1P0s1M1iWjkMgk/JkeIa3fC6PfkB8RdkGB1+Vm/VdEK7Vp7+YR4QggvKPQpDyR4KS/1lgpAFxuRyz6I5tyIBifkjdMKs5qlVum7cWAFbf+T2Ylov4OK9xr9xsLhmE+Jy1H0O3kZgA/yP6cf2zrjEzBnLNfntfGxBU6y/iRewOGt7/H2o/eqdJevtNGLcpCYoT8m8oMxAWn+KkFrcFP7O+O+CvLPSnTCH0U1IgyWHZKKVMZjuCJtLoGBgna/jR2zv7gDFCLVHEeKCHkjktSBFpqrSmziG9zN1b3H1luRImFCPfQ8aL+Mp2sH8AfXNB7d+CwC3RS0eY61+A5l4OB5U02HWx2+/EJL7ohvmFs6scen0BkbndmRYIeO5Bb0C2sSvsj5u/y7AhWEjQOVWAxxKLT1QKdUoDDmAHthKFioTY0FqO4AcspkPCWyoGJULxHYAOEx2UO4UpQE981rczI2Foh4UdHjfNyAtYFqdgHf4CW789yig7kqNVEtG6UkPZ8Fv8LpUH05TaWzf38i7vi+or29SdxnBw4CU2N/bI6zmSl1V5TpcPiJgweGq7/VhM84P5skw6ta+mrrO517SvQ4fol6uPOwf45/x/sFTanFoK7RRrtIr0LXxp6SbkGO1FfP3VlvqDBNHeEe4kwcUkimduf47XckgHv3ju70X4Vx/nuZKJV2UfJRD8axxTc39jtMDc/2ZxpBhKRXvhz7msdAvJAfc70f3c2i/+51xEewNWNHlhF2TyIMfs8OGQWOFLPR38GUH6OWHNJXBXMSWKfZNDiWwqcUv3jaCdx6hAcmBbKoRnUrJBdLUObt1rvnC9Puk6upFWFiE1Zs3MUS0CuDGKn8vtJ1yWQ9/YTevjSmFztNpYqcaDF5iSsAbn6hVv+tDQMeCGtbtcRXwQhfvMG0z4yLnvpiHHn8+A0a5+eOTt+wiAMeCZWzVj5QylIxAI/kz3uY5kwP2Ts2AXSjsPNXslFM5sm0w/f3ne7lNdfgyq2+fd2pHlBfDmxpF6W5MKO/S0X1Y389RGX8XSlU2VmO67x+ueYcwU0wkt0pjao+LfLO0Hhf5fVJ6XOTtQLcPQIi7Q3Zsyk1Sf334bIqr5tYFDyRuvRuj9iAPUM0GGgqkOJXOQ/KgmTKCMS6GfQKIdLr4pWRwqgtxA1mSCTOqtAEqJjV16xUHa4/eQvpauYVQt1rq/ayRvVVLbNBZetoCutdLOnjk42V72ZgfHBzEPNt7GR8CfxHzvec8frH/4vnLl+nT0f6LV2sOHVYrqNp9H9/fFfjc/Np+Oq1xxE4F1sLZqSs+D9gJFqXdPcBlUNQ3u+8Jhb9H71Wf86jRtS+7UO54b9uV+HeGQYf9b/Ub480+Kcw08VlOtK50QZZcr0fISXsEuRjfKpRsy5rNeznBXDkvJqGl7/LCjNUANtnfnorvkHmETPMq83drAMix1mDMAs+krkXp+/agRforh9se25peurMpTMgSX2slJ/5y4cIev4nyHmzuVDJIjLVDFu83Ubqi6w8wnAzZ/sHTw2dPlojYVEm4dz/EB5wduiGCkO/vdQql2HGQi3RdpmGp8GSV6wCHVaXHluj4Ry5M5zWhkKxyJZxeAL9JInspWOv7CC7ad2eangyivqML9mY7TznIeK6uW+0N1Mu1rrmhie3vnU3ALUM3X58h2jmCh9mgPqS3ZP6u5902P1wK3dgc0i7e0Q5aCgXNrLF0+J3m3CsC8a9JuSufO37OTnOTQCpW4hNGdI3YXT8NVmXEjUgfOTrn1OYX9HfwNsnJ2C6Exbc6TMsO+TBwif8R8Hbtm8NXnI4+b43wn7EtPOiZCZVFtXdZddOosVcbqgXoHjFHT57E6iR5L+fsIMAcPqPO9NTS22R4DT4j5yif9yv8Xh2FM7gK6IPnoXvNDy2Q3YZZr5q1rl1MaGOT+zW8vMG5TPbaXha0VUb2YZyMhKbXsrbc5dTfYqXpdWjsLSi1TTgHkHTOZmXauhf0Pk68d95fHHA4fL7/Is44fxUfQvYifvkM9uL9l5A9y/YAXj59tkalUTXsHkFpnnP2RtjfJpiKy6jjl6Myx3CNocASD0971TAD6CNSiFiXmj0SlgQ6D4ypg+zFaPz8II1HfDSOD/n+Qfzy4NVB/PRwDw6yVykfHbxcg6n7aaEzwwWfsj+BzoWs0YR4wZvP0uNqYwwFnxqkcf50nfdY37ezuldrbQur90bbnN5uulwKSR1cyrX9oZ1h947WcHYvYsSnsPSA/Qxwhakmaad09e4X4MugDkmTWvc+cKgUNlqn7VXLoHavjnZuK8Yrmt3DzXMw9k8qmwfm3+YhvRVvJ1AUs+FDGxs+x7DiKZs73pC5/35L7wqufVfi/ns91lMTd7z/sPn1kt4TBUGsWosvPt6BCFz81ZFxxe93P23w0UdLvfmIbbq7YUrgV8DNPKYrj63i6AW/cU+Vdoeh8Y/VDLQWGe7qcrq05YV/UBZuLEhTP0TlRHrla6eDQM32q6dImu4899rloP2sVXtQ/xz1wMXzLJ/WPVczfeF8+CCJT8DRM7vInPgo6FG0O9vfrauKu986Vebb3e6ju9Qg4DVfpfFRrXDJmJfC3TGOMyjoovGSB34K1SOLWy92WUb8jKdcsfDSNT9oyiiuWrPEz+03Ss9RszlpXPJSaS05uHl4iZZkD7imIKl/D5SWiOnKEuOVnWKcGupxg+icmii+Zwe3wooNbgcRauyPjW5/7e40tXXz51qnNuLefXi0zqm5j8uetas/dp5C6/3q1Uutduqn0HyVP0g8vQCML+PizFDKab/dO4jwqV7z0/gc9Eyk0OKG5ho73fzdpYG7GaIHNW1Mf2NJxvipC7fVIHevAipGcOwY9trLLwvNUfhob6bSCj0IQvW/+PcEuMs8+Zd2T8Ou7CM9lOrSC66Kg+zsv/57w71IsVIZW3DZWie8Xb3qjer+GVrm+/d3rx/y3WsnmRZu7C699IYiTMrom9eVn6PZPpG4aXo+WvqOj1eYX7G/2lic+O0beoefdH57iz//WgE6iJ+/ovBoagkjgcsEuXJZ/fbgSsr/8NGbxSdszUPOS88UHBo5b1mM+jXH7oFck7h7mns7AP+pH9xegVmHweWPnNeIbiz5iUNWfNHxKBZd8mbGMQnK2rFtQ//h00U0iEbe6y8U+T6aX+Mdf37tqN56Lo9+w6cW5aRyIYpbEvUW79qv2l75/2k5s12++vbNjbhQVyBvb2s2s/g3hTO3/wOZjHjQ +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"; + + + + + + + + + + +Update attributes relevant for an employee's state taxes. + +As described for the GET endpoint, the answers must be supplied in the effective-dated format, but currently only a single answer will be accepted - `valid_from` and `valid_up_to` must be `"2010-01-01"` and `null` respectively. + +scope: `employee_state_taxes:write` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/put-v-1-employees.ParamsDetails.json b/docs/api/put-v-1-employees.ParamsDetails.json new file mode 100644 index 000000000..c8985cf67 --- /dev/null +++ b/docs/api/put-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"}}]} \ No newline at end of file diff --git a/docs/api/put-v-1-employees.RequestSchema.json b/docs/api/put-v-1-employees.RequestSchema.json new file mode 100644 index 000000000..67b7ed8bb --- /dev/null +++ b/docs/api/put-v-1-employees.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"allOf":[{"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"},{"type":"object","properties":{"first_name":{"type":"string","example":"Weezy"},"middle_initial":{"type":["string","null"],"example":"F"},"last_name":{"type":"string","example":"Baby"},"email":{"type":"string","example":"tunechi@cashmoneyrecords.com"},"date_of_birth":{"type":"string","example":"1991-01-31"},"ssn":{"type":"string","pattern":"[0-9]{9}","example":"824920233"},"preferred_first_name":{"type":["string","null"]},"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."},"work_email":{"type":"string","example":"new.partner.work@example.com"}}}]}}},"required":true}} \ No newline at end of file diff --git a/docs/api/put-v-1-employees.StatusCodes.json b/docs/api/put-v-1-employees.StatusCodes.json new file mode 100644 index 000000000..c51960722 --- /dev/null +++ b/docs/api/put-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"}}}},"409":{"description":"invalid version","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"}}}},"422":{"description":"invalid attributes","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/put-v-1-employees.api.mdx b/docs/api/put-v-1-employees.api.mdx new file mode 100644 index 000000000..b8c16483d --- /dev/null +++ b/docs/api/put-v-1-employees.api.mdx @@ -0,0 +1,71 @@ +--- +id: put-v-1-employees +title: "Update an employee." +description: "Update an employee." +sidebar_label: "Update an employee." +hide_title: true +hide_table_of_contents: true +api: eJztfe2S2ziS4KvgOHdRdlxRpr6l+nExNf6YqbvtbkeXu3vn3A4ZJEAJbYpgE2TJakdF3Gvc692TXGQCIEGKUknl8u7OrH7ZJYKJRALI70x+8WTGc1oImd4w78rLysK/6/t8nSVyy7nyLj3GVZSLDIZ4V95PGaMFJzQldkzv1/TXVEUy41fkY/Xi1SYXBf/oXXoFXSrv6r33uoL54dL77C9LVUhfpAVf6vn9YptxGMjXIWeMM+/So1nmDsFXFY/KXBRb7+r9F++lXGc03V5HEVfquixW3tX7D/cfLr2M5nTNC54rHJfSNfeuvH/1/4rTXr+98X/muYI1XXoCFrbilPHcu/RUtOJr6l198TRCnipykS69S4+n5RoQHASDsR9M/P4Y8GE8pmVSeFfu7/dtur0CXNYi5YoUK06AiH5IFWfk+u0NudO4EKqUjAQtOCMbUazIVpY5DohokvTITUxSmXIiFMlyeScYZ5d6DM2yRERIpAtF3q9FKtbl2oX94dmqKDJ19eIFk5HqIfl7kVy/sOT2M7rNZZLg8xc0E755U6TLPxmAvvPzc0CjVJz1vPvLisL2ACwEs5TNaLHaOUfvVpz89NPNKyJjJIh9z7v0cv57KXLOvKsiL/n+Dbm/dw5SrjZ0ad/IucpkqriClwZBAP80p1clnpi4TLxLL5JpwdMCRjl0fPGbgqFf3PlFkQACr2tkDUoy/I1HRecqc57lXPG0QKiwXufyEJESPJI9D9bCP9N1lmi8DYoLVdCixF/KUsAdZdPBbMDmc5+Gk9AfDeKxH9LR2I9HdDIN+Gw2oTPv0otFroqF2Za/SFpsvUtvLRhL+EKkohA08a7SMkkuvYTWI/+XVHDr+ZqKxLvyPnGe0l7MuSr+/EnwVdqLZK/8hFTDq7cwWPF5MIqi6dyf9WfUHzE68+dsOPWDkAd0NokZQ6zWNKVLnpu39PTmQHlXHh1HPOrH/SjoD8cxD4d8OonohNNhNJr0pxOYtsxznhYLTcE1/NdSyIvLJFkUYg0bI9NQ0pyJdFk/d34D7BNeIJfJch7zPOds4dJM48Z4RvMCp3FRro55JBlQbTSJgyGgl1GN05oXKwl0eSVyHhXkFc+kEvqEWIgWmOYMcOu9q5gmil96xUYuMp5HuLwVzflKJsCe7HOzkvqSrIQqZC4i2FQzZkXVQqnUjnAWz2RUAgJqEck0Fsv6cGmExLwaYqDdX3q/yVDzUrPhYTSbjuM58ymLxv4oiCf+fM5Cn7PZaBqEjA7Gsedu7mwyDCMW9KNxP45iOhhNZmwSjKI45tF01B96DllPO+r2TMCm8lThRbMgBjzqT0Ys8GfBLPRHo0nkz/qDwJ9FcTgOgvlozAJn38pUACv/O6c5ngyxpvnWkvChXYGDxhebaBHJO44cTNOz/j2hSpkzY/besBRzoSz2DUofuYRHEq/eIBZOwzgczekoDmbz4Wg4iMLxZDDs98M4omy+l0xxomh9y15/5usMTjplv5WqWMQyXxj5sdjQJa/I5f4IC/6Ah2xx2vnicHwKcccXIFMdKRwAvrn+bRYEQdALAg9ERvs3uDy5+/rIvA6DeSKWIkz4IqOCIW9ZyDjWyNp7a/brw6W3pHkq1Arvlv4FoC5kvAhFDsoJSKMaO7ydsPXZSqbVkdjI/NPC8F/9yxpkdL7IZF7QZCHSO6GFiSMbKuqDpAG5JD/xdME/Z1qSGopveBLJNdfQFzB0QYtq0X2/P37XH10Ng6sg+N+ekQsZVWojc7bQUgxfALTuUckq0m7EkHXArbmHcTlomYXgjhjbVa+OUxAaEjPnlP2QJuaC3jeF3o6+sCv+7JD3NRawNO/DfUModkAy+7MXQNdyMp4rmdKE4MuEMpZzpdoL7JF3K6FcHY8UkqgyAyoTtU0jkS5B8coVCXmx4TwloAKqrSr4mtCUoUqoeuTvsiRruiWpLGA8KQBuc+5Y5oSmWyKLFc9JVuaZVJw8471lj6xp/okXIl0+Bw2vJe9P3T7zdmsrlf0/I+G2c0Ob+sJJ5O46PReKGIids1W88JjlGalTKe87+3jLOf7yvlakybIUjJ+oiwvG15kseBptn+OOiTSW+drokylZyQ0ckWqLY8ET1rk+V/c4iZYO/WoYcBWdve2c0dVtKqKGUiacpjtU/WXF8Ry2D0kNpHuOfWK5XmI9Y/ca981MSbGRxAAnDvDWuTaXFilPZJpstUUG1p40Y+APNOpoSm79lzLPCE8LUWwJIIlXzOX8J20PvPiPyVUcRfZxx2NFFamUeVIruZ0npcMoaFuG7s2uhxM9vMNapen2hxi1tX3ugj1WB2VrkS6chyK1j0E14EnsPsx4agbdic4B+gHb/wRWnB8eAVorK7ugV4gvwu3CWX17HN1QUeB/cHU5vxN8A+K0Ig8eYlTDDmxOl4Fy2NJ+ieNK7ScyB7A+JM5GVqAJK2GjnGfeYU3lZKHTOatZUMf6G1bX8ZdBEpFGSck4eSPzNbnx5zvL71ppa/r7ysKrZqZ5TsFnIAq+Vq7743/KsMPz8RRK3m8y/GZyWSP67y6V73cMtUdrwoUkm5WIVpZ0JOSJTJeqk4SOjbM7YT3aGAq7GKDbd7PiaROHDVUEQDMic5Jz/V+gRrWd95WRe+AidSBgvKrWDdPGB2HuzFQZ7CcIEy0WW1qiAYSACcx3R5OSk41IEhJyongB5AfakjJNQOjBhfssFHA/3Az8Q1UYVoK4a3PyPfuy/3C7zgICrz90hZqW+2l2i36VwKuV3tOFR2M3OnA44Kc52Z7omv8BEjyoJ56mechNqggtSMKpKsjgv7VVwt17dd/lInqMkioUHjFQvIx/AmkPaiDP1UWTKjgTXXKrriMKgOwvVK1EuixkSp79cv38IYQd39VJxycX6hPBtwm8fQBTkbo44cw98hboy8mdUKIg79vPLxT5EeC/RPgZXTpsfLPZ9JJU9Da0t5R3L0SqypymEX8B90X5gJePeHH1wv3Dj2XuGwx9F0FnlJ9I+anM/vTiOfCBhNM8JWuZ824itlx7B0TsI8IJbRJW3pGnkMh7gf+Ty+jaEfkIHaYpmRskPCSiv4lecPTs+2TQMbqBTBKaE7qWZVoQ8JSCydyQG1o6d8qgk6ZCGUQjw2PhXOwsMke2cdN2G6KElpuU55daYKqVLBMG0vziLd1GKx59uug5dtvfZAnO7V84h3DXdzLFMKZxeds30FXY8H/vNwQrx/gtTWguOCPfy5TbH93//wBoepcQ3l4LhTcE6EIqCO0H9cudLPjNv9xeWxNWC2mhGkTrkQqnZxd6lovnFfEUoTnX+0pJLD5zRhQM3xJ+x/MtbDRsuJDMgYO+DhA94DQnzy52F/2oGS7RF5HziIs7XsOHAaidmghumPAegR1MtuTZxQNTWr1lBR4O+N8WBdQpU9UbwpkzxbOL7i0EPEBkYOiD6EQAdBuhvLZvtMC2Kbr3EHRDdwCfsjI8i7AS/M/FcyRbvcJiRQu4VrUmVGx4Wmwrp1nbUebVQa83iaL+LR5L/x1cmvvdeM6juEQFRJste478G7PtGDRoPLvUw40Rgk48w9ovtLmDcLtsm0PMGiWDY7a0EQJwe2NmD+qoNymDzAWuiOgQ3ZHldXoC7f6zaSIwg3USGPkJGSdRmRjEuhzzzeDdjkpzxC6506ud3Jf2EnqH9KSnUHVcdLQ7tkn4A2CQgFr89Y47xA+e2W6k7tFRU2fIvNdr/XB88kg4YqM+H/uz/jDyR9Mp98OYcn84Y3RA+ZhP6bARFB5PWBBE/eksjKbD+TAc0EEw4WxCZxMaR+HIawRto37MwlF/6kfDEfVHQzr154N46I/5JBoEUZ9N6agjVE2nfBbPw8gPWH/gj/h44ofT2dwP+oPhaDyZzuZBv47mTuvI7Unx6K5Q8RDCngj8EdFqy8duZVxsgC2+Tpci5TyHM7BC4dOwdZ194ON4QqfhzI/mLPBhmT785MNv8BP80tiH+Syc0kk0ZiM+jAe0HwbRnM34NJ7QcTiKhs19YAM+jme074ejaOqP2Dzw6ZBP/HgeDqIxm/F+5z6Es3hOgzDy+3ww9EfxZOpHs7nGz2zDoN6HwbhzE4ze1NwEV7v5ZvtwbVmI12JQC8v1nB2gIzYP6Tzyh4Mo8kdR1PfpOIz8CY9HEZuMh3xKGzsQReN5yIaz6ZxNxuM4nI8C2o8n4WQ6jgc6PcLdgVk8i0M+9UfzCfNH4WTuzyZxAJRl/XA6pMFsUpPy6SjZn/n9gd8/SEmdzdImZH02Ged0TGOfR2zij8J+5Idjxv1xFMcDNgwG0yEkjmhY3rQ3GD+Ayv2H+1pSYs5mdSPuO0RLIqPDriHwNYBycshOKAXrCP5ioMzCR1Zt/+iOBHUm79kwl2sOtwWSXey/WPAPc+go5yD9qowMkyfyrj+8Gg2vRvNeEAR+ML3Ck1JiHu6+weOgMbiVqtcPxvMhnVB/HIxDf0TpxA/jIWR/sIhFnLOQN2UA74eMzUZjOpoPo+loHsziGe+P2aTfH/Unc4gGGNCTsD8c9+nAZ3w49kej+dwP56MZSIKQhoPpaIJsTRU558Wi7115wyAgw5yRW/ypfjaA+1xFmod9zPPCtF/vlqbkDXhyhIqkZ1xUcLCuvUvvD5EBtxz1gymuvEwL8Ad7P93CU4pH1N4ATLtZpCVk1+iMoPlwEgxnQ0yfTHQcC/e6ujO04+enSnGxR9G6Qf75vSyPzCmx9lqVVOI6PCoqWmeHNo5MkIxZ7bg9DIDQg6kMzdPyKLsEQRANolpFxY7Ij0avw0d2cfYxLARh0QSfV56NeoB3716tBzG8dy/b8cGZe3sRj5vgOCvu3tzcYwZWl/qoPbDZ+cAA7jtu8IOG1W3GIxGL2rCqjo4JG5mdwtwiBG4lxOOO3v0u82mLphNQip8Ao8s2iWATHGn10MV9RQuODgZ0/YODwcXXQAKgrlT7OqAGEprUhuc/uNHvTHCkzvOor+ZNqsHUt42s6B0nISTKMI65EZckLAvMjVEFxAlxQJ2YDXYd7TJz153sRqT/kIh3mqf3O/Uwe5QrHdZqhBm6YO3Lyn3awAr6BvGIyTg+EFlpJokeFRODV+xeNafRyWC10/hnag41GANQmXErok/VH3+TiWB0a/7uyqrJZCKi7eIrcazQ0+C65aOe6SuTZo6ZiUZRXtLk4Vi2UbhrU2pPQAEmfvvuByQ+RgpgAmCP3b4vO38zZHIcUbXsh7OugSAC9YwQN7FPjEv9EAa2zOQoGpRpItYmSWwXMzurBrlnOw7hotE9EhfjqdlFI4YbD6okOJRrra5jdw4SJqQJhHqfdnf2ZCh/RjP662Y2UPZjkCRyw1mPXBMAYtJRlFimWg9IpQWxJ/tDgFRdOCULJ6Y9WHTM8jCTFBmXbMbZykymxJmmW0RY8/gtFcx/J9bc/yGOvfv7dlHF0zJ06iL25KFyF/Z/GgvuG8SsnYRvo8zRoqDRau+NP1JL6kriuWjOBcnES6ywTQtpPPLdmUxwB4wP6ikmBjW4AtkjL6v/o0IPWWYiJh/zMnVv8MLs4UcYhPYOhvU+Nl1x+NSk/sRlUbZzVGzywZPE3erVQfkMAdVExuh1w9OyZwGdNHxgOojvg0umeYxMTN9GNosVFzmJBdjMOsp0JyjmAcSxH22jhNt4FyYM6Il0APhBSDI1P9o7CtFTqBVmZYKhmu44jeV87xxODGObpWP7+V6TCn913rokrleAcVZGyEUvMWKrg+o6RqVgpInP4lr0YHA85HLtpg7/v//zf4HPY30D38IZhRhiNZwSpS3RyBFcoDLgDFDQDgQsc4wshlQJ1SMuygiQJkpqk8MKwRp3DWPLKcTxNdLAuXyta2BoW+kouUyBPen0BpeWuPhIlnnhy5xByp3NS9Fjo5VIWFUIIXMS0ugTKehnAHwr19wp3zClEySRNLVBYZG3g+EwYc5ROMJpc5Hp8hQ/hehx5vjPlKT1bYSPS8xDCVMHBY/xOmmvcbc4kDnW0OzMCbJAUx7KiHASnRqAd7drmZpcUACfSFocx6pNstbuAeqR1wLxow6LAGRtYk4j2wuclkbNAn4AFVOIxCXBap9fvVkvCH71ejsdMR6XaFb/0oW5dimXebEwV/0xgsWV1u1tAdjEwDbZH2s3++G9h91KMHfr8antbVYKzrgsS7a7O3WzTGWu3Xg1nzUagxa49tdjKWFQO4kytags4fIyHkOBLU+0L5OmKVqqmrcDHscc1wdItCMptOGcpuW6ZSKJKi3GMZEeOrQDzC+AY3u5z4iDzZdQ9dy+lh3m3lcu+LpaLs7oLLoKIYiYG0t9h58cQw+TnGlMeHevjl/TI/fMzR38+o3rT1x2A/MsqFrUfOypr4HhonUqaaGd2Ro3h38WsqE4tVbuNRXAhUbxyxHFhai+LIz6AqKAM57TZFHQz4tE8NSGR5s/lAxmATXGQ08+E4XMFw4GDiQzCms5G0M6q/o6HNNWQ0T3jYwbrEMHuhyu2lKXgKE3VrijAV8zJkxUrK3KQZku4wUViXLucaV42ZPcVMCODVh11iRtoBSgKHhuiixoGEIJZLM6Rj8SSpVV+vIu4j1yvUQvGPrewQa+o8JYhNqW+/jX1+/Ii7v+C5diLxrU+ggNoBqZ120f3YHlVVnLmIC70VnQ+g9d12t+ercREfY2IGuTIo2p0sl219H1N7khMi5MDRnVC4xkkvCo0HEriCxAVQ6GrIyCgVf7v46DQE+QbIn/P8hHM8lHEy/L2qUph5TANzdvb3UtSlfSoamPwYMJiawGz3/DDevIcOmIglK1G40+rrSuUTiLS7k1S3kNqnfE8W6+hLKb77UusksnUIeaVAgTsdQn3Se5G8leS1VoqqqKShVXMCNrW+3rDjruxROQ5QfkHjfAJ8HBitq6+e3V11FDgU35b0SNnK9FUYAz6ZuelB+raf6BqON4oR2XhI+r9M0qH/TiOG/i2Ahs3fUCTdQuN06LojhaG7R6QbIRnW/XjtpwvS34xiaH6LTUJZHO3DZAgClVRzrNrw0I28ai0alux1PRZXE7KT0uNovjrPO6ELfO3bOt/IzXQTuoMNq/lSVZ8qKRCOTirwCbvf17rIZ1GKebNCsLrbhUOUfOFG6ctuCfi6oVGQbKzI3TPaAw1ZMJ6R4evf3+GwBV1T8cNJLBgwP72vlEcZCj4FaVWSt88r46gN0RqOuU4ACgunkZF2zOktRhaYIr6JEfQPxvBLhKAVxXYn7VorF1f7Ar5L4jYrbLbI5dqkMw23fRdymH967VZusoJmcL422bvBMqLDb7OpFAb5fb7x0f3L3p8vVgNgvYNRG2uHFbydBkQ7eK5Lwo81SZ+1hAnkaOPU7uq95hh1pZdTc4PDo+6SqQ7YDzwYoGp5zelAKa1+trs9Me8aWuqnMzt/RPO0rR/cFmkMcYT26/SEg11ZkkZQoqhK5iWqxMokX92DzIklJVT+9oLhAzuIUUm3wdax5ZJ2u9hD29ZnrkTZkkPpr5tccZE5qHwX83tWuZ0ct75C3Ni/ZgkDAqS0Sh41tgrixzWWbqihQrif5VCLoDyEHgD+YGKEWQumasPQ6JRQZBY2iP/GwI4kyuk4pMhR0tyB1W99FoZV65NYRr4Vt3lJho/b8iDEQFQC2D7gt7Wl7UPTE7LvfucWp19TzmjKsV6DPaGaJNit0WQQeU+Z2+XF+bPuN052qXv+JWHSxZ26UIUn9POt7OsiqXkBF4j2giYrIJjITAMhrBGE8Xe5joLsbnWtxzLe65FvdpanHrqdF9KDpNmh020NYFjR4MatoRjUz3uumaN+k7hEQ0JFJDsjfLiSG2c54r/tNtRu0g59hSu6lC+znNflHflO/rPStxjQvT/Q3VC3TO3vEc3BJWmzZN43QKScKZCU80WsA+rhmiQ1mEh2QyMHWRbHdL2WMiB9gE36hfe2QFqhxwHapNM/OZjoMgOZQN/e1tV/vNkLGTgZnKC8QG81703D1t/zzUJff0jcFWUwXPQVsy0DtuwoaHKyk/4Y5htreyHnfTstHqlU94PTr9JY22vG5j3V1zDAk2Cka7fv7vZUHeyDJl8LkJnd73e8mxkj3nSpZ5BH1IMFpU6N5bPfId/cSJKnOdp1A1vkR9SSDegvV+TU/5BMAepMivKSFfi9fNqxdN1DqyRVzi8jyXOuu7yZPM7yckT+5AXXziW2QoBV/KfLtnDhz1IOuri1U2K27WjK8TGUXYUvTdNgMtHSPcQpFPfEuE9bzqU0eLIhdhWfAX1Yc9SM4TWtQ6I4LUESOL9QmoYQKnCVBpSNj1zYKym6QM5mg2CaiUAaZg0qLgYxgY6CvB12kcRXr8iqYM63BEqj/Y4XzVBHFec6WOajfw1iJiIluEhrIsHKL6ZMlTiNxZchrQFktV5jGNNKbASFKGbV+r5gLNMtVUQgFxmTL3YL1v7L9nTrx7Xq6cF53FeXsuCDBOuB/4Qq9VL/y9LHy8ZP5rmNT/QZ9ayyvmu9dSpHh/bOLS4+/3T2mWSyjTRVv2NbbrtTcdKEu3ZEWzjKc11wwlQzca7rJZKjT9LKhIzelRRJXRCkLEHw2mi+p8L5CZfsRcvqImFolxr1nJzbZVb1bf7/noZGS91tO81NshuDoxJQvR9KPq9ec6sctEc6D9iT58mnmeedQ/P4+C9NhqIqHIxxSv8ELv48dLJzNQN8k0R55QokeSj2YoMZu01TaU6YGtH/6HYYWARUEhlPtw2OSlvdw5T/gdTQsdAobGvPqAbG0kQzM7kRK806ijtS086Elk+O9lAwTih6T6qP/FJJGPJuNb/wLa1seqR6nVK3r4NRze9IXuWcu6TAqRgd8OIAr8AFjj4tmfdy+bffLomg0l0qWdeYvtK2xmx1tnJlO5vzv3tsqaOXxqvnfK2mwDdrCb62MTyVyHnRjk3ulM05rAD8/wUyp+hwSmOnhcBfIQTM/EcQRbQDjrsO9ejyuzRSEPD2zwua4BrcyW3SGOzP3OnH7/F1Gs/B9S7mvhpy2a7lHfmbOjh8LWOB7w857/A+85QNorsFsmKjAf9J6hrQMR6wNio0duMLE2k0phF9vCVgJYPpTwO56gr8SIESsoKrbiRSKHTmX5M41uQ0t83ojzdwzwOnTekKafoJwP0n8WukR6UaYx+M/ZwhYPHNCHwcnXVIZ3lLWGUvymRO/Od7rwEgxtO1tVqqD3oIEYuoC2+NWAHGJoC6ZjaE+J2d9BDYBZiZkVJCco6iEn1gVVdejFfpimEg5qfzQ6tuSkt38JNAEvwHZRObW+5QIwSqsn1F6Rah0dCKKLNl0uclkWJol6nw2kRyyqoH8Hii0lv4Hoj/p9m/stVJUWY/CyAVj9/QBVoVbpmidRbfdtF5lr6z6GUrhamV2XqnAVi27E7Gpj7Y3TD7Hw+ACGHYNPJuEbwNgGmhGGk5dLiXVDf2jkOtf48pRVpW97sKyGdOLWTcvXKdPew/rmoAVVrGhKhjakKVJTm6fxsxkSImWlKvLtos7tSKmIdK7jolbM9mJcjz6dnt/DuzqmuXscj8PQTPPtEbRHk/8ONcqFJBPCxFJUbOcAusoioI5AV4lIjz0d21sRIa5qF9mRQVbjattZLJzWDcft9fpRRFx37W8biap3QHVf2k0Q9mDVGHYC57429ebYqtlSLEyAlYNmVeGjGxMIrvYgbj+cYxwph6Rj69VTsH2pLzfjWK8FKGsY2sY1ONTNFCwye3CuInrHbLv7reYT9/51I/x69AkwLQAWusfOo6T1Iaxe0hSdgbp9oW04oA5v+0o3QlkgZ9cIW7VCf4jjCZUK89HpSo1AlYIYDHR43PQu2YcaOEe/GVpVtAE16S7ELklmVDasVgExvxfVSjxWx+ybHMUb47Kt+0iUginHh4H4VV8Lq79B9YT0s3cYFH5STVVn8iAKO4t5Qgzeoe9Rd6rXZqlJa7ZeYHAutySaVisWPMUwPXjdchpBNY/EqNpe3NojT7+mFQBt79X6jcZFp3JUn8Spqqhb+H9LPba1xg4xh99Ew1ZrcWG+MnmMFrD71un0e1vp1Rcd8C7qa1y7JnRbNnNR7nSE+QNGXLVr8Vj8G+O/CvMGpAdxtqNrkwZCDotlLpUCd4edPOVoDBzSdcyI09Udrhs1WI3C2gUtlFBrgR3BNKQjSPo4UYdtu5ybk3KoirhrE8jccZ3e8YT85m3V690ioKeorkecyz94o03Hk3E67B+kp98xyU3QDXwLN/ChPnCn1zia1n5Ykp4UPN+D7cJAOWy3fxXiAhIrsGm+RdiGWlqoUlPmDzqVQbZM15KJGLNkK5StN/MpkbURo2xnszUCmpINkmtGqXh+Z6ty9FdA7SDLw9u6AXIBtbA5NQ/qCXr81zCgJqT6Vpt6BoOnbdHVwlOVOSTwHKVdPxbV15+hoTJnVfWzjEk/CJCq+hNSh2j5DRGzCpe1ATAr5pnCr4C5sa86rvO+5XSvzAev5Su38/vwJ/SOx4C+y9DCREafeF4Jf3S6QcreSYe/Ba1TGcYTYRThhh9QpKZCuJAkL9OqD1Br+XruXTwPr6faHMWLMvs2i6LMTW591HJaaB5ek1tZ/g2XZdMZiZkPWvEQnO9xa9xF+4ijqH3CdWP4J11m4xhajmW90F9xLhtIdy9SlQp8ESe62I9ZlICkFgPcFYIPLqFGSaOsytAkRu9sTeWzO6Sa77z+GFddBYRYIKSavLYhvH0I11L5a7FthMta9LOzGW6MLnQarRbFKucKiugX3Agfz4nftTHAZfEK19NpZekCRwDdNlVNLpxgrmRyxwn65q9f/o28s8gRKxmd+JGE2iKIOcDHKeErSzfpJflO3nHyTkKeZU5eUQxHugLTaWl1stpUmS91plgjdqSLjIsCEvnRgSeNSoeNzUw+R6mwWwF8L73wZezjcwPQmplimdJC5luTJn2UWw8+A/8Ilx6kRYudQ1ohYO1u6x3D8kf79Om9KTqaWwU8YHOr2QimB1XFCOYY5Hwt70wGlnUe1K+EPAZgkCcARCcp3wBQq+hBtcqCCRWWucI6cXt19i/MHX3C7XN8C9VXW7q0nwN3bx+II/IoXzlItzInL7/x8ljAYjoYDHzKgpk/4nTq02BC/Wl/OpnNomHYn84PLLpVSPoI3d+tJK3kp+YaV6RZT3pJsHa057WpYrEw5RuPxsJWm2jWpzVqUO2b9a7kwmjbOsR/0bM87N8ruxYy8qFvwaL+JDwmEphKkqf3SRsCaRsfWqt+hk9JV5O3fILVB4AQ9ENaWPXFi5N38Ts4PLbMgRINyH4qYefMRDpF6evmQCBtyDpL53TRaxoJWS/xJpfp0tSi7swBX9c4/ZhrlgzttvLKi/eHyHTQ9Rl25sFvgz3vuGLu51JOn9n9Uoq95P2gESiFjINERIc8DZ2Xh5U6A5zvCz06V8c0BVJOem/trNIhnJYBf4wjuxOtw3kE79xKkTonA3df7wvkZmtN2d7xRG6c9IbCfLRlb3JDbds/2psAU9psvvaBcH0ETzNBtUgjyUzriodlvm2QcbQ4xFmMom25FFw0dUDSwXN851EWCOQEc2Zqqy7MOxd1JUEqoaoT+u7YUcpKFWi0G31j65ximp/l383OPCeZsCnnTDlyyJiBHfqHpZv9LOee1eHjkwn+C6SFWz6zxLBoblTWvE7UCCpBtYPdN/TRoyax30ne8jlXRaBQsZwWNCqqtksMlaNk247wG3Zk16AjoE/uh24lPzgom8/QtKJZh9LF3HrCU9PE8Gu/aSvtZYdbNTvKnDzLK/MNV3y9Mo2NBMW0Ca0AcvtVyqNthMcp8UZ5nw4oH036U59ROvdHnE392ZgHfn/G2ZgFnM+G4wMszfY7OdUoTRJK3ojijyW44lj17QjdXEB/PDdlpuS/PhZQUiu1iViFmg0ROgydJ6bUgE3DeDKI/JCGsT+i/YE/G8wH/nAU8AGbRzQczA5Q6nFc6EZRQVfkLzxPRFqRSX9JFkm0MdUrx1HI6tS2s0TFQh/I2dqfq3UwhdVoo+5Jd5MuOzFpfvF0L0aNYY+21vBbP02LEftSXJJfsMEN9pTE0jv8PM0u1tZpUvHeJzaVqs91H+D20hGozULJRrWivyfZHWomB4P9NZO1mnsumzyXTZ7LJs9lk+eyyXPZ5LmE7lw2ed7zc9nkuWzyXDZ5Lps8l02eyybPZZPnsslz2eT2XDZ5Lps8l02eyybPZZPnsslz2eS5bPJcNnkumzyXTZ7LJs9lk+eyyXPZ5Lls8lw2eS6bPJdNnssmz2WT57LJc9nkuWzyXDZ5Lps8l02eyybPZZPnssk9OS3nsslz2eS5bPJcNnkumzyXTZ7LJs9lk/8xyibNh225Kv4i2dYe/qOKI2mS7KkiatZmOC65nc/W6zx778obT1gQRP3pLIymw/kwHNBBMOFsQmcTGkfh6OCXp80MtqZD4+EUQJrnoJpg5eKJ9Y+C8XUmC55G2+dozztf4YYNWMkN+gIV13HdWPCE7X402NLhQ71HP+ufcId+dGXPYYo6Au8gUX/h/I8tlq8JxhJIwBWFoMmBChD37TfVx6cfnukvNMSJtJ/y4NCiTHm0En+OqFqtZcq3OY9kzhRsAIBoitqDoPrzed8P+v4Q/WpKdZ6xDDy2ORyZ94E///Blft+AMRuM5oNgMBwCiCznMc9zzhZdJO4qqSk2cmE+Q79QK5pz8GZra88gUn/9ev/nyKs8N8j2IsVGVp+2d2DufOb+XXXYdM4VXleoDJV1fpW2WWlKbv2XMs+qeqdtxvV3zmX+aXHErqV80zPf5O7BO382j/SugZbePO742WsopVEZp584VVsfiOnLO57nggFIkzAKsxQ8VWiCATfRDPOzj9fSd8pOfWONapYO9YfmukKpWJa5Q5WHGkETVK42dFm/r1GsB+3DtHrBYnz/AdUFcFheeVlZ6EO28q68F3f9F1UU9sWXKqIq2D1+5D4HHoCLLPMENCjDhmgmNBfyGV8jK9o5Lq/4WnpNgmp4vvbDwmNYzR7AnTDf5uhz3Qczg8ewWMWjMhfF9hZ4v2ZBxg68jkDCXJeNmwqTw3JxNNwATnM0I9uVsgjCx6IuQstiBYfTRiwvvVtMM/maGTSEPRPcX3og036spd9re9odmXWMYHJ5heG5uyzXe9P4RrxhmRXHPMwWd7iiy/oM53M42T5GVl/svWxLF1e6XOGBqw+uLp2pYYXaX+G8keu3N3BzKjoOgsHYDyZ+fwzT83ytfohveX4nIu6c11oUY/X2Cxz4gsEGggD08W8Iqynz6g5X5Ukk1xhtRDwuFHltuASxCW7Xb28Ik1EJWiAehv9iekJQ7T00xHplZyU/Qt2+cRFZqlQ4/bm+X3CmMqmKNU0dOD+ZGGFasfleG21H6+oa/mv6a6oimfEr8rFiL1ebXBT8Y91xoeCfixdZQgXeHuQDXwxjeu/d9RH3OiP7ymFOIPdXUhUw8MsXUFV/ypP7e/j595KDtvr+A3DBHPPTkH8xgXol865imih+YD3PrGLzHPsTQGJRVXxbpwx1rsHWlqZbhwl7ptDVcxeg89U5xTN8EnqvwHG6FqnpqAC094ECDI+J1SypUjISmL2HAhU7IsAAaAKB7RBSsCBEnaN+qcc4KvSFIu/XIsW8Lwf2icoozYRf67N/MgB95+fngAZ0dujto6um37/6eEP867c3/s9VxLsicy0aX2pi+e8a4nfXOqjfAKadFQfHujL07U/vvEsvNAbIWqJ6kNMNtBugG73n1kl79UX/9sVLaLostbWkQcL1o01BUQkG8x/HWmmeqi9f9Ih38hNP7++rQ1bA32hZ3f9/OVI1Kg== +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"; + + + + + + + + + + +Update an employee. + +scope: `employees:write` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/put-v-1-external-payroll.ParamsDetails.json b/docs/api/put-v-1-external-payroll.ParamsDetails.json new file mode 100644 index 000000000..849144877 --- /dev/null +++ b/docs/api/put-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/put-v-1-external-payroll.RequestSchema.json b/docs/api/put-v-1-external-payroll.RequestSchema.json new file mode 100644 index 000000000..c76a6bd25 --- /dev/null +++ b/docs/api/put-v-1-external-payroll.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"replace_fields":{"type":"boolean","description":"Patch update external payroll items when set to true, otherwise it will overwrite the previous changes."},"external_payroll_items":{"type":"array","items":{"type":"object","description":"Submit wages, benefits, taxes for each employee","properties":{"employee_uuid":{"type":"string","description":"The UUID of the employee."},"earnings":{"type":"array","items":{"type":"object","description":"An array of earnings for the employee. Depends on your company selections, earnings includes wages, hours, bonuses, tips, commission and more.","properties":{"hours":{"type":"string","description":"The hour of the compensation for the pay period."},"amount":{"type":"string","description":"The amount of the earning."},"earning_id":{"type":"integer","description":"The ID of the earning."},"earning_type":{"type":"string","description":"The earning type for the compensation.","enum":["CompanyPayType","CompanyEarningType"]}}}},"benefits":{"type":"array","items":{"type":"object","description":"An array of benefits for the employee. Depends on your company selections, benefits include 401k, health insurance and more.","properties":{"company_contribution_amount":{"type":"string","description":"Company contribution amount towards the benefit"},"employee_deduction_amount":{"type":"string","description":"Employee deduction amount towards the benefit"},"benefit_id":{"type":"integer","description":"The ID of the benefit."}}}},"taxes":{"type":"array","description":"An array of taxes for the employee. Depends on your company selections, taxes include federal income tax, social security, medicare, and more.","items":{"type":"object","properties":{"amount":{"type":"string","description":"The amount of the tax."},"tax_id":{"type":"integer","description":"The ID of the tax."}}}}}}}}},"examples":{"Example":{"value":{"replace_fields":true,"external_payroll_items":[{"employee_uuid":"403c6ee3-5f58-40ef-a117-ff7175cd9ee3","earnings":[{"hours":"0.0","amount":"200.00","earning_type":"CompanyPayType","earning_id":1},{"hours":"0.0","amount":"5000.00","earning_type":"CompanyEarningType","earning_id":2}],"benefits":[{"company_contribution_amount":"300.0","employee_deduction_amount":"300.0","benefit_id":10},{"company_contribution_amount":"50.0","employee_deduction_amount":"100.0","benefit_id":21}],"taxes":[{"amount":"20.0","tax_id":1},{"amount":"100.0","tax_id":2}]}]}}}}}}} \ No newline at end of file diff --git a/docs/api/put-v-1-external-payroll.StatusCodes.json b/docs/api/put-v-1-external-payroll.StatusCodes.json new file mode 100644 index 000000000..cb3134496 --- /dev/null +++ b/docs/api/put-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"},"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/put-v-1-external-payroll.api.mdx b/docs/api/put-v-1-external-payroll.api.mdx new file mode 100644 index 000000000..6183b6eb3 --- /dev/null +++ b/docs/api/put-v-1-external-payroll.api.mdx @@ -0,0 +1,71 @@ +--- +id: put-v-1-external-payroll +title: "Update an external payroll" +description: "Update an external payroll with a list of external payroll items" +sidebar_label: "Update an external payroll" +hide_title: true +hide_table_of_contents: true +api: eJztPWlvI7eSf4Xb+2ESQC1LsjX2+NNO5tgMFkmMOTb74Bgy1ay2mGmRHZJtWxn4vy+KR1/q1mX7Ae9hAgSJJbJYLBbrZulbdB/fFNrImAsDN4oaLkVsVjlE55cRLOfAGLDoahAZeqPxs3f3BpSgGbmgKyWzTOOXMgc39QOLzqO8MPHtOAY/Ms7dyGgQ5VTRJRhQCOpbJOgSovMokcucitWsKDiLBhEXCIOaRTSIFPxVcAUsOjeqgEGkkwUsaXT+LXI4RtooLm6ih0HEQCeK54hFdB59XgD58uXDWyJTYhZA/BrRw6BcNuA38/jNnm/1sBQJpKih8X/xf9sDeH3xIf5fUBoheDQWQBmoBiIpzTS0l3uLJF1yAdquxqiBeE41MPL64gO5dUAJ1VomnBpg5I6bBVnJQtkBCc2yIfmQEiEFEK5JruQtZ8AGbgzN84wn9nxfaHK55IIvi2Ud9tUPC2NyfX50xGSih5ajholcHgUOCjxgvz+iOY/9TC5u/tMDjGsf/4hoFBrYMOon+yACUSyRKSejyTQevYzHU+RGBiktMhOd1z9/eLhCOupcCg0agU1GI/xPk5Tv7ukyz4CEkdEgSqQwIAyOrVHi6E+NE77VsFvnAQW5Ag3C2CnIDVSsMQNu0W9Mzv+ExESD6D7eeN8MNxlYbP0Vu6iumMLLaLjbo71SHYTbj12HlgUp+01kK3cXHgbNW7v3En52N+QFJF9nyMXb4b5rofpCEzvdXoJO6DldLUGYWQ6KSzbThipz+GI5XREHiVhIO68Lgj3JqiBY/5raUFPoTTenELmSCWgNzDGP//+rrgN04Hq5hNTG3PEsI3Mg17UFrsndAkTnXLzuiQIrnKhgxCgqNLeXxkhyXQMhRQLE0HuScTrnGUdOJ1QBAWFA+ekpFzTjfwMbEvIbTuBu2TogjyjNMkITXAmFJzUkwSvKuOm6quW2GNd0njnxtEb1dcViYFk/BaoUXW09Z2KnkVQqAss8kysAvbbcIGoDL2VIUxIEED33FdGmCsVxF6I7rkGXsnCCss1uqVRLihI5zSQ1uNpCFqqTM9eHesRmbmQ/5rPGxqxBAyp6eHh4GERzEJBy84jNeQg9i1TyENWF4vMCT3W2D0XKE2LAimTP6XaTht7DI3Zo6H3v7vbCxCLjdeU8g9kGzmpegdflHBLmEGfISBFUhrNOvO2wfv92vxAHcZUolnNHEWe+dczjIi9MP9iEGriRatXxZZtu60x7WRJOFFm2LqVrBAyTn42AfazSwKiDAChtb+u0mUuZARXr++/j59492wn/9A33coK/0Qo30rHf9kY+yWXYwpKuyILeAiohd/Wszb6AjJFUyaVTol5gWJW3w0A1IDC8GZJP6AZk5BMkheJmNSSvyTUS4prc0qxAZcnQyLXeBNeomutAXmi/0BC3qEBzhmbN4VtkPE1BgTBE2UWlQrtZKsPFDfGeD1pOmjDIQTD8WArC0yYRuCaUBHQQiJAirv52o9Fw+LNQXDNuJezQM90SDGXU0C4maO3ASIXY+wm7m8xtbmKQgUGu3YFsNQePd69nzRY0TBBqp11i93kfg3NwLAre2akchSiZpozC9DSenpwdxyfTyav4FaUQpyNgCQB7NWEnUdv2j+bJ/Hg0nY/iydl0Gp+g03XGJpMYTs5O6Ct4OT9NXkVNux5dswm6ZqPjaKNN7gdO0YfbYESXw45HUWX3tszbPsPscs08ik5O0tNkTl/Fp/SYxSfp6Cyen85Z/DJN0ulkPE7PEhrVbabLyvwZj0ajUWnhjNoGTPTGUe+Crj7jB01NM8bQQIA03QXOO/dpB6wT9HkrJXLZNGImky1GyxhX32CVTEeIawPkdAvIzQCPR6OHq9KMuawsknFlgJyM7Krhm0n1zcvRwxVO7zQ8LtsKf8spBKkefYSbIqOK/E5vrPld1+5h6bpSL6MPiOXeB1Yu+4bqBfnM8/2WvOoxHy6d8sITbwqW/6Fc2whTUMrOhfHDp+3hP3963R571aWx/XoVFd8DA0Uz8kEkqAE+0/uorR59ZKupUOyHJT4luJYG2wfWVVPY16Swl5L1aNulk4tX1qnrlJtWY34XoE8rQCMrQYeIiBd+kfvrYEEaTfeA92wCFffl1u2XgdEUh+wtWKPtgI/t4lsFbHQyChh0CNnopQPyXdB+F7SPFLTOIj0ZnazHzn+VhryXhWDkD0HIH8LF0v8qQGOAUIGWhUqAMAmaCGkI3HNthuQX+hWILhRYEzlkMVzcmWv0bjgb/iHQbzmZTNaX/RKEnXUm3wnDzarEgAeXJc9BVJHMuWQrdAJspsTjSPCKUi40AaWk0kQXyYJQTa65sEjMqHFXGGZWgVwP0GEx1S5JSnmmCSsA459UVDPLVNv1kHwCt9PLd26ZN45TOeg9EzIWzTgpp/9IbgrOwMYel1KhW2EQISTewQmRLup+J26buG3vs26MuA1j1KcVynKf7xH4W4M6+wqruqzrXsOO2pqw+JRDwlOMy98twF9GO53IJCmUHpLPq5xj1nHlIgxfYUWs/HCzcHx5hkdlzpgoyGyCwMgK5HBzSK0fNRsNWOWA7OUg2fRFABWkh+cycqNkkdt4JAZbvLONCUrEZl7wjJEE+WDpxy+oYBlGKrhw3FvLr9tca7kQ1+RaWME2c+d4PbDIubNyGQfP8oQSN5Jc+6HEH9LKpXTBiSz3pSXNEu/bzQ5ZpouwX8+NhM5lYWpnF5MbEKhbwql50IEYulApTRxBMHUiGNJHeSx2Da+8CZdbQQa3VNiEGkWYnkFW/iZ7FcAFsXcaM0VWbFQ6ckjeY+rE2eqDBgiLnyXVtfuvVfrX9mzDJ2jHXpcJn6BMMLAiBfyWOvNp416WRWY4JpMtRO6zN7WLFz5ev2zhmz2udHNtzcVNWBmnUcZsOo1mF7WVuuJSNYJs55pf6RLKEJijqE2iVWyTSOVy6UwTIy031Ai8fYUvgv+FMckgHpSVm9V6FqKT3hjvrIfKS4guVl6OK/KZkZsHNuRc1wB0kGDTkIcqS/+L5/74d24W8W8CYqf8oof+Ub943nFD8WisQf79zP/lz9wGE/oUdpMOv6PwkSJbOQMXY78b1MaQfDC2ekdqzW02RLoAeymHMriFzObvvRoJiqIUK1HCVYJu2A8O3dgaP/FvluF+jOo77BgQdcSY51R8ndEkQWdq5qLTs0KkhWDAZj4a0TBiLhu2RoTJnKYTtmasRTU1F70vbIbgFzALyciCahJWI+Vq9gwaiN2C4ulqxoVl3QQxzaXmT4rZP9AMwFWJXxU1J3ovcyB2fY71ChcZUA2+iMUaKWixenR85gVVe98WaIZx/9UsQHzWDSB5/YJkDiCqfXQguOQaJdRMyQJTOxsQ8yNmPtnaiWLLyG8g+tHNJ24+3omgdj1eIQqWSJHyG12iVtqae1FtfXYdmdeG4JEagsV1lTG7LLSpGxbdiIXdplSbcFtmGV9yswHDjsF7k/A9YuxhEAuD6IUsMoY4UxLS4B5nH06s8K1XN/VgWQ7pxK2blu98sVPt5lgPyiyoIMdkKYVZaLQJ08IUChx+IW7GBSu0UauZhgxcbExQnuhZIhnMKsOsF+Nq9P70/BXnEpzbwY67YeiXeX4EA2vCXwXNUIu8JIzf8FLsbEBXBwT0Duhqnrix+2P7iScWV72O7IlH1uFq+BJmMk1nucx4spphXGu3s14eRMRl1/m2kSiEvVHAyvtCk0QVNJupzXemMWwPyf3azbMJ9pJi8wxFOVpWJT7EIshB9yDu0+8zH0jZpB1bU/fB9o273Axs/BNRdjCcjxtKAHABItM0RHX6cC5r53Y59nqh3Z5n/y5MtdWIO3PAnGZUJDAr8i3ysl9bb8LqDRU2QkrZn/bY3Wp687EvZMYZSnX81yEczApriD6lVeRD9aUZYU0K4jFwha4Wg37UhDTPh1YZYnbVOB2IDUjuTTZbv4pqvhfVUj2WbPYsrPjBjalqY9Dt0rUYhsVPirmkCs3wMO4p6RfuMBr8pFyqRMmhsLaZJ8Tgs409YlWQ8G6pLwIOUWAMLrc0mjMrZiBsjsUm2mhipJpJW0fTi1t75P7XtATg/L3KvnG4MFcGjFyOss/hW13YgP9z2rGtPXaoOZt1RgA0NaCsr7+LFbA+a3/6XZR29YsOeC+qa1yFJmyckviLcgu2nu3KVbTZ0OKu+DfGPwrzBqStOIfRlUtjM/I3SmqN4Y6wuADrDGyydfyI/c0dsD5CaVEEv6CFkrVa8ERs8n0Hkh6m6n5G6LWbI+CGYv60hY2/4wnqwewJ5c1FVYjnEXBLlNcjVfJvEKF04kklHddlHeCaS17Wb2B8SLtweoWjMzsYZshoZh9QdGI781A2++2PQpxrMgcUbiXCIdXSQtWGGrEolS/D2RZiKRlPuRXbAeUQzXxKZEPGKF87bIeAo2SD5E5QalC3XorrlTawLAcFGd62DawU0LNQXr/VTnDjHyOAmpCqWy2IDU96PJf0Hl/rtfHUhcqpLRN6PlTf3WMJFTDiccCTGI9GlqqZlF+LfBMtnxGxYHAFH8CWHPygfxxGzdxXlde5bAXdS/chasXKw/ox/hmPJ8e4w4ZAm2cy+QqqVP426MZFKvdi/ha0TmPYcoQ3hBtxQC6IVAwU6idViHoRdH37bu11PDfvpzwcDabIn2dTlFWmqT5sOy00N+8pdWU6WC/znNtCu9Aa4H49W/9u1ztsj+to78CKLibsikSefJsNNgwSK0ShH8GXDaS7N6kLjbGIPUPsu2yKY1GLB15Xglu3UKHkUNbF3O5KirWjKWN2m0zztemHhOpKICQAIeXilQ8R9SFcaeXHYttIl7XoF1bz0tiG0GmymJmFAr2QGZuBVz5RLX/XxsBuC0pc96dVoAuygA3b3FKeUZ/MQ4s/uwViY/Ov3/xMPgfkSNCMtfyRlNoGI1BJ/s4VkA9iQH6Rt0A+SyyuU+QttenIusL0z+8PMptK9+W27GLQyB3ZuBg1Bpa5dWKN9Cade7fj6jkKZE40OWRhYpnG9nsPMLiZ/EZQIxWG9ijPdgvrUZ4dEtKjPKs7um0Egt8domMLqmflt08fTXHZ3DLhgYdbrkZseVB4Vh/YQMEST9y9GPLBg2rKHFIEhnUCSHQi4A6BBkOP3wObMa7nhdL2BVa4Ov0bq4/e4/bVYgshb9Vp/Wy4e30gmjhIM0uxrrRB3bc1pO2ts0McFZ55e2zEUjqZTGLKRmfxCdDTmI5e0vh0fPry7Cw5no9PX23YdIC2tNnuQ2x/l+Bz80v96aTGOXnLMRdO3rrk84C8waT0MGpTJWDhHw0cjIV/ke9Fn7Oo0bTPm1i+8Na2S/G/GAYZVh3upmCNjf3twhU9Ncd3VLd5JEq54Hox81FOW2Mugun1DDFpTyDn4xuJN9uQavFWTDCTzoqZWdDbrDBtFICZjfc/xV+QebhIsoKhRHeAULYo0HqNZxJXovS4NSyQNmRXpbO/6sVpSFofJb5TUtwQ73231/ib5wewuRPJtk9FGcX7m+cu6fqDfZo7nhyfTH/suGILKeDgeogLnB2qIcIlH48aiVKsOMh4sinS0Hl5WOEqwKEv9Vi7Opi+MwvQtfLeKljlUjgtB36XQHYnWpvrCD7XnwdUNRn29N25YG22s5TDHc/kXa28wdZybSpuqHz7g6MJuGSo5mszRD1G8DQLlJv0mszZsHq7zvcDd1eHdhVvaAcphRdNb9B0+L2dc5AHgjXBwPzz9hd+zovqJYGQ2E5nyY0Jo3TQKnOqefLM3jm1ZX5BfjffvO/lwgoApmt6yLuBHfZHoNudLw7v2Z39em+C4xOuUs7c2LSo8iarqgo1RqWiWsPuGWP01pLoD5K3Ys4OA4zhE1uZnhiiixybExBmjaNs1c7we3EU9uAyoE8eh24VP9RQLjsANLJZm8rFuNJmdljBy3ucS0Sr7GVNWjGrH9LZnCvbWG/PVd7avHpK7PTSNfYa1JZNOAPQypzd0rRlLeghRrw33k8nFE5ejk9jRumr+ATYaXw2hVE8PgM2ZSOAs+PpBpHmnqLu75RmGSXvufn7BkNxzFb8UhTm6K4RvLCWhxetbJgGtBGti1immj0ROhydJ6bUhJ3O05eTJJ7TeRqf0PEkPpu8msTHJyOYsFcJnU/ONlDqMCn0QVNOF+QnUBkXJZmQLtnKkujOv17ZjULBpgahnT1dxj021+3012ptLGH11mid0+tFl52YlM6l2Fgf2hh2sLeGs1seI8EU7ID8DvAVQ03CLOzTu38A7cI6BE2qB+ZP6yqFhTZJe1lTqA+NAv7Ga8W4s9i92RTgp2AolC0B/mUthodB9LGmN7Zt6N9EgTwMol9LDbJtz99VyXdV8ghVEl6/t949+XB4Z+NJsyCUZPgMCF+sdvaK/EP8IXQiczgn1+1WHfr8TnED1/4NImjzk2TWhW13Od75effmbmkK8owmMEs5ZKz+1qmvydUFNckipAS6N+ieeCJ18Q0wYkukWYC64xoI949l5S0ou1ffBQBuuSywLSwVN+Bexe7coXPH15Y2x2UsF+hB2Xlv4Dud2dI9miyq4sc9m3Nu7dfrpw8PbePZaqjnCz4so4U2jOULvLAWhoUBX/hJ/8I5dNurknuDaroP2ulAIytTBmQuRaHxb8NzPUAQIVeItwpTHcM1YvV2Dl0nEg6tdxwuTYKwm6qR7nBzl8t12L7bXjgCt9Fhb+PI0C+wC1TtJDvA7PYq83M121UphS3W9z2sdf5da8vS0TTl6vDmqf0sVTamPIylyukhDnwyGn8dkAXQDHW70IVCp30DA+3ZqbX9QN2hVJ8ceMHIO6qY6y3g0dy7sWurJ3AoKCqnbllrY5fazbznpw63NJPtP9hK2u1/qm5uONJQrsJdFxtD7wdEu1Y02reiGZAlYJtKBYPGUT+6VfG2m27ovb2evd1yN1PZTX8oLYBtfcXaatTp6H0acY2Ok5cAx/E0nZ7FJyNIYzoen8Zpejo+nSbsFcBxuxFXs0tW2ftpgp2hDurD1QNwOtoMsb+B02StE9fm9ljHO3TeCmPqd2hsuw1uhj3dDnrcAXoybvbiqpHZji17czUamQVIZW+uyp7Ep9c6B/oVqF7FtmNJ7Wcuyt8PaA5D1ytGk0lxhpT375AciwltI/uInTOfe38tZBA4tv6rIYh4mNdGrJywjmD3tCai1XSPsO83hWlw+wskttedWUTn0dHt+Kh8MHH0rd567+FozUw++tbxuyAP2BIPK3i9R1GoDL0u3wWI5tw1AYoZLG0noI4GrkvZIryDF7syAPwat90DuBPmhbIp/z6YOX6NVAkS02LuL9brBEMbrwsk0OVVfdQnNO+dOOoYWwo7RDH8NIc16oGqDtnnQcS28wChhVlguimU1Q2iT7YW+jErOAg9CzwMInRbPlYOT03EPlqyVj+m0CU7y2/Lq9seb+/v1vawewq6apEN4qgcVJdHox5xVA4OImdUFo25GuMQMrO/Y4M/C4O3MxSS1X+DZRBhG2P9W/oJ1C1PoMbqVRMt23foyA48YniqqLZj+zcWhGk/da1XBmTOVpDE4vFCk3deEIWfTrG/WMNkUizDL7L8h+9mRl3e2ze9extWJR+x45RPbroaMryr/tv/qq4mMloutVlSUYPT7863sf9WOd3/rCCAZzYD9+Yozyi319GKn29ecF5Gt+OyVanrXnTe+qmmNfg4put3la7wOaQ2CPTbNwyAflHZwwN+/FcBGIa5vEKJrrjrEHj5LQq/sNH9k0d1gv3w0QcwfiR9v/rUs91g2doRQZ9EvhNMs0crCucnQamDFQ7ArYvG7tGp+8mo/Sj4b/77UZ30dXTs/vGtktyVJfLGESv+3DB21gNk1QxUarnZOLZuslx8+Yzy2MfkltIaY4reYbyO3rmzD5UWqLzws29RRsVN4WKUDiT+8//Qajhh +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"; + + + + + + + + + + +Update an external payroll with a list of external payroll items + +scope: `external_payrolls:write` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/put-v-1-garnishments-garnishment-id.ParamsDetails.json b/docs/api/put-v-1-garnishments-garnishment-id.ParamsDetails.json new file mode 100644 index 000000000..c790c571b --- /dev/null +++ b/docs/api/put-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/put-v-1-garnishments-garnishment-id.RequestSchema.json b/docs/api/put-v-1-garnishments-garnishment-id.RequestSchema.json new file mode 100644 index 000000000..960c3741d --- /dev/null +++ b/docs/api/put-v-1-garnishments-garnishment-id.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"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,"type":["string","null"],"description":"The maximum deduction per annum. A null value indicates no maximum. Represented as a float, e.g. \"200.00\"."},"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."},"total_amount":{"type":["string","null"],"format":"float","readOnly":false,"description":"A maximum total deduction for the lifetime of this garnishment. A null value indicates no maximum."},"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"},"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."}},"required":["version"]},"examples":{"Example":{"value":{"version":"52b7c567242cb7452e89ba2bc02cb476","active":false}}}}}}} \ No newline at end of file diff --git a/docs/api/put-v-1-garnishments-garnishment-id.StatusCodes.json b/docs/api/put-v-1-garnishments-garnishment-id.StatusCodes.json new file mode 100644 index 000000000..63f5a9dfb --- /dev/null +++ b/docs/api/put-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"},"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/put-v-1-garnishments-garnishment-id.api.mdx b/docs/api/put-v-1-garnishments-garnishment-id.api.mdx new file mode 100644 index 000000000..e5aaf4611 --- /dev/null +++ b/docs/api/put-v-1-garnishments-garnishment-id.api.mdx @@ -0,0 +1,71 @@ +--- +id: put-v-1-garnishments-garnishment-id +title: "Update 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: "Update a garnishment" +hide_title: true +hide_table_of_contents: true +api: eJztXetuG7mSfhVu7wKZAGpFluVL/GOxnlxm/COTIJedPccJ2lR3SeJJi+wh2bY1gYF9jX29fZJFFcm+6WLJsefsDDzAwHE3m/WxqlisKhbpb9F1PC2NVbGQFqaaW6FkbBcFRCfnEczHkGWQRb2IF0WziYm+9CLLpwab/cS1FGY2B2npuQZTKGnARCffouFggD8yMKkWBX4bnUSvrvm8yIGFllEvSpW0IC225UWRi5ToPPuHwQ++RSadwZwv99Sk3WNKM5gXuVoAsAyyMiWsPcY1sIm4hozxuSqlNdiyAJ2CtHwKxjeGjE20mjMuq27+97//x7CCL/rs4wwWLOWSjaFuzpkpIBUTkTJZzsegmZowK+ZAFJRknGlIS62FnLIxN8L0WRMydchzo9iMXwKb82sxL+cN7K6PBXCdLzzouOCLuAAtVIZdgumzF2o+V5KVBgybKM2mTRI4+FSV2sZKZ6Ahw/G4V9g2nYk8Y6YsCqUtkhjz9Cuz/Bo7/qDm+PG84FKAYYVWlyIDlisuDbOK2RmImueG2Rm3RFBDwUXGLgVvgelHvchpV6TG/4DURr2o0KoAbYXTl7IUGf70rYxF1kW9jtg/zoB9+nT2ktg9gyYNJiT7CVUaaWng2VuZL6ITq0u46UWXoI1wKnU7BRQc9ug/CsQc8j77AEC/n/v3KONpKTL48sPM2sKcPHuWqdT0aYL1UzV/FiYUilCrPKf3z0QG80JZkOniKYlEyInSc5oAKP+ZukJelwbJCcMmAvKsH930osD45G5cq+aKVexqJtKZ67/JzDHkSk7NSl7y1IpLaJAdK5UDl0R3wsvcuqZdGL/OwM5wqmgmlV2mKUzgfL5gjgiN1s3dVcN07IpOokmuuG1hnfDcLCFARrjeVihQn70ShI83TASC5d6GZCrPufYd9Nl7KDQYkGQPDLZCED0G/WmffY6O+4PB54gG0AKxPIotQDeerEKORGiqJ36qrxTOLXSCeJbmlXFmhPm+iRrZuprKeUSLBOioF8kyz91ysETOKwe2WDXKrim1iuGasFiW1NlUKrRoYtKws8IwVDvCVz3dlhMe2k6cMTNV5plDwITMYCKksJAvnNpKWfI88bYdcWyjrrewaGmlQF1lSGreZ6cMP2OXPC8B8eBiCoZJFT67VWmHg4FX214l2UpPnWBR+MryPOlOy6WW283PDQM+rYZLFBuDRmuJ0sjFBFBX3KRo25Nt+IFyKvgicctqU1bbj+mOMiv4gjmy9yG4vcOmuUE6CTdJbcfuexp4K+pnwBiY1cArbA37aVXLceqMHOE2RJY4iN8iLhdvJ9HJ+bKxBInyOY/IfUm8+4JLAWSgeZ5Yfp3kAnB4xnIL7QdlhlTQjUHXU0MmrNJJA0GjJ99K4ZhbTb7c9CpcpBU3X1aJvfIQsSkqaNN0kAfWtKoddwkNemuESx7waZYJ/CfPl1y5DDTLwHKRm8Y8rhyvoMltB4y4dcflyV4ploO1oBl1w/h4rOFS8NZkda+EMSVaa3yyAnifnU7RI2IZtxxNOr/kIufjHCcGfXTx06uP7Nnl3rMmx561uHXBTt+dhclNiuX0bavhBQ17dQl6wa4AvkY9/wvpQnj08UqkQAo9V9LOol70Bn/mi2hJHX5WV0xNLLgBcDfAVOU5pNbQsythZzOVZ8iZ4GDQ1P63g8HAEcgXLP53duGJXNDwJqIwSaqylYJbltPrs3cfGDZn3BiVCpqxSLohH6eY0i4Czj9QYE438dtKGh3x4LzgBhLnKmw01Lfo7Qsaygc/lFfoeqdAc/MFN8B+cb7IMp/QHWpzYZyLqdP0mGn4rRQ4nVHp58pYx1VTcamyCr5lHat9n6KTLO6BLW/JepyhnRQT4bx1/+zl93HDYEz5B3FDw1xYy2X6sJryviLzJ+IOee8Wp1gzixLTKGM/SmoV8CHPKND8svJLCkhdYocWEp/kwX+SQ1NH99EoPToe7fFhvLd/uB+Pnh9BPE4Hk/jwcHQ02E+PRsejSdQI1qOD4fgoPTg8Go6G6fhodDCE4+djPhyng2E6Hh0dRkuxcMQPxwf7w+ejeHJ8tBePsvEwHo+zUXyc7md7Ezg4HI0GUR3EukA1+LIUtS2ZzheUCFlQ+gMdmkAyWoq6vP746OigFYf4d92wwHmNbZfaPVvlmEZ75KFH67w8N5xll8r12HEp8CEKuiX6+Lvkt8e3l9/+8f69y280WCnA1iSM2enfh8f7e8+X5ed68+JzPGtI0NP6PgGO7ibAJYd3yT30Dlx0+vdo2e+pfJPO+hnVrGivIGHwS3bUvWg4HtFgNBgMohv3Xy8aDUbL3uovyrLXqpQZ+ywZ+yzRG0H7AgbNpQajSp0CyxSFPZbBtTC2z97wr8BMqV3CzachM5fMEgYDJpH1P0s0QaPhcJnsJ1lolYIxZCtfSSvsokIgDJvzBZvxogDJrmbePRurbIHu+kKVOmBkmKbmQhoGWittmCnTGcY6F0ISiIRbq8W4tJDQpLmgpLStR8km6I6zrKSQiMv6S3TCaUm4aKQWXzkyL7iFqdICzI65RYIZp9XnT12G0rslGkJ8gMy7cxJ+FXcfmdtlbjfv3VxW3YCXgzH/vHbqudYcJ6+wMG8+X99r8hXcbCeUizU0qNWtscMH54iAQUH6yUifM5WmpTZ99nFRiJTnlKsThn2FBRPBh3QRTiXDZwXXfA4YLGrIyV1yOwquSxf7BtQ7QMMeQqjtemKUzPddBevhtYxNtSoLIaeGcZmFDZ7SODTjEheMFPVg7tvPuMxySjNKp72NbbE+O5vUhIRhF5IMW+LkeNFr7B+wK5HnQeUZZ64lu/BNmRfSwvmQ4EyWe0msmeN8m24R8L0L4/XayPhYlbYhu5hNQWKqI0jNdx2YYUo94aljCG6NyQz5oz0KyzHgW6WKXefJT24NOVxyaV2gaFVQkIWfyX4JEJLRnEYfmcyGt0jjHPrsNe70Of+k1+qC8BGrLtxPWjYvSLbhCToYF47943oxwahTSWinm9aMZV7mVuAGJvWI86gz8cLj5ckW3uwwpdu0jZDTQBk/41X+512DknMfVtBeVLm1zVrzCw/Z1EDLbe7VapMq7fZvM8zQu/2omsG3U/gkxW+Y5qxDzJAgct1Qj856467shsitalcWiVWbG7bs3KoGnfzXcpNG3PTGa3/8q7Cz+K2E2C1+0c36Vm+87rimKJpGGvFR5n9imWNPaxfsTgodjY+S+cI5uLh/tWHZ6LMz2n4rlDECXSwb6gWCHcrhEnKDsvPLSFgoKrMSpUKnZc71Dw5uTM5P/JYU7mkrG7CigVPo67gZ34+5/JrwlJKESQY5WEhKOSllBlkSSgyaTsx5y9eIsHah6ZicREvOWtRY5qLXpcS06BuwM5WxGTcsUKsKGpwMWsAuQYvJIhGSVDdFpIUy4l6R/Q3dAKTKPFVcOTF6GQMj+gKyPnuXAyYU0xlgfQU6KeixejihMKW/fgg8x/zUIgk9PugAkL2eIBsDyHocKwDOhUELlWhVWr/VugaYbxGCyJUQO05+C+h7933YIRamSp55XCHeTZWciKmpoFW+5k5cW/66CebUMhSpZUoCq53ZeWls07FYDSyMdsKNDbMlycVc2A0IVzTemYWvEbHvg1Efjd077jlbYfaJgxovyCzJvLVcg7JqshLbal6+khn6g9CYORRB2RmXbN9tfBj0CSelLTU4fK4wCSd3VhqrF4kB3EkRSiaSi9QlJpLaMVuLuG69Oz9/wW/dZsqyOm6H0JN5eIBBNeG3kue4ihyyTExFZXY2wDUBgNkCrhGpa7s72g8iJaxmGezIg3VYMTmXqMkkKVQu0kUi+XxLWc/vxMT5Kvl2QZSSZhRk1XzhaaoxTag3z5lWsx0s96n7juF3FcfGOZpy9KwqPIwACjBrgBdAi2viEymbVsfOp7ugfeEmdwaUtUXIrg8X43oMzBdyTEJWZx3mquxwG7FXjXeX/auqvNFVNm6pAWOeU8K0LG6xl+tX602oXnBJGVKe/YPE7qiZzWKfqVxkaNXxfwc4uBXkiN6nVxR2S4IbQS4F8whc8QchWA9NKvtwsKoUM3nSq4D1WOFdNqppwWV+LdRqeazU7EFU8cy1qSs3MewyjRwG4VNyrLhGN7zaobpH/oU5jA4/q0jVm2EEYWkw94jgI+UescJA+rDUb36GLDAmlzsrmnMrEpCYP0InzGqeYs2Pov3etdi6LXefplUHLt6r/RuHxe36kpaj7atqrTv4H9KP7YxxxTJnLNfkt/OJBU2x/jZewPJXu/PvXeVXP1nR35N6GtepCcpTMj9RLl1d7Bfax3apxW3xt9p/F/JWT7diDq3rkAa3HJKpVsZguiMQl0DBwCZfx7fY3d0BihEqjyLEBR1I5LWgRGaq1Ns4hndb6n7G3hszRwLWTlx2GeTneIrrYH6P9uad678BwJGopsdEq99BJh7HvVo6QadPiPxSSO433TC3cGaNS6fXGJ3bkVHhem5Br0Gb+F42x+3fBVwYNgY0bhXgsNXSgcr9YQD0qTzYUs5VJiaCzHaAHLKZ9wk27BgVS8J2ABwnWyx3htKAvgy1OwtjYV41Cja86xuQFTBJKCC+1U9w7b/HALV7qme1ZJSe9Dh9bUIXpyl1wXHMDwj11XUKgF5EqJFWE7Y3GBBXc6W+lsUmXj4gsOBwhRiASg5+ME/7UXvvq97XOe8k3avwIerkygP9GH+N94b7OMKWQRvnKv0Kulr8KemGh4N2Uv5ObyudYdII7wi38oBC+jpiq5guZZge3eE72ss4N4+nEo4BWxYPMyieZY3zaXcaTgfm5jE1688fcFjoF5ID7unhgT1G9O42xmXYW6iiywm7IpF7H2ZLDYPFClno79DLFujVgzSlwVzEjin2bQYlsKjFd95cBG8dQg3JQTblmEal5JJoqpzdJtd86fO7pOqqTljohFXE6xgiWge4XpW/F21ru6zDv0DNW2NKofN0ltiZBoOl9gn4xSdq7N91EdCwoMK6O68CX1AFKG1TVe6iBoNR+SUwys2fvviZfQzgWFgZG/tHShlKRuAi+avQwM5kj71Rl8A+Kiyu0+wlp+3I5oLZOPi6s9tUhS+hk87ekStFthbmBQWxeFiVXDo6/uzrOUpDZxokU6WN1SSm977DEGaKqeRWaUztcZFvl9bjIr9LSo+LvBnodgGEuDtkx2bcJNXb+8+muN3casMDhVtRY1Qe5AFVaqBhjhKnrfOQPKg/GcMEO8M6AWQ6k3CFnQZHD4+xJpkw41IbqiYPU2f9wJqtd5h9jdxC2Lda6f1smHvrumhjUDaZYF1pi7svG6Bp1lETx4UHHl42yCZ8OBzGPBscxyPgRzEfHPL4aO/o8Pg43R/vHT3fMOjQ25x2u+/i+7sNPvd9tX46q3HCXgrcC2cv3eZzj73ATel+1OVKQIH1EeWdIhCHwn0fTJ/zqNG1L9oon3hv223xP+kHG1YLd1OyhnJ/22jFmprjK266OhLhQV4zS3yWE1dXLCRwrtcD5KQ9g1yMjwcMroVlNfFOTjBXzotJqOvbvDBjNYBN9naX4htUHiHTvMQDY8x1hLZFgzFLOpO6EqXvo0GddHt2VTq7L73+uGHIEl9pJafMR99dGr+L4g5q7kwyHsrVVRbvd1G4Tdcf6Pze3nB/dPB0xRSbKQl3rod4h1+HaogwyfcGrY1SrDjIRbop07By8mSlqwCHdVuPjanjjw6aRnlvnaxyWzidAH6bRPZKWJvrCD42jwfUNRkkfScXrM12nnKY47m6apQ3UC3XpuKGOra/czYBSYZqvq5CNHME90OgGqRfyZwPa25f833D7ZdDohLOqXgrhRPNbFjp8D19c6cIBGuCIfMn5p/4b57UJwmkwpO5eHgltDJhVcHreNIHjs45lfkF+90+v7dTCCsBMtNYh3wYuML/CHy78sXha0ZHr3dm+K9YFh7szJS2RbV3WXVdqDGoFqoldA+YoydPYn2SvJNzdggwh8+oMj211bmwjJyjfNHd4ffmKIzB7YDeex66U/zQgOwIZp3drE3lYkIbm9yt4OU1fstkp+xlyVpltD5MkrHQdPR9RyovaV99wujzKjT2KyiVTTgHkGzOdtu0VS3oXZx477wfDTmMDveO4ozz5/EIsqP4+AAG8d4xZAfZAOB4/2CDSaPdsDsEpXnO2Wthf59iKi6jil+8RMvdOoQTlnR41tkNM2DdLWH1OIJjvSLQuWdODbOj8eRwmMZjPp7EI743jI+Hz4fx/mgAw+x5ysfD4w2cupsVOjNc8Bn7EXQuZMUm5AteGCU9r7bmUPCpQRrnT1d5j811O+trtTaWsHpvtKnpzaLLlUiq4FJurA9tNbtztIZfdyJGhluwPfYrwFdMNUk7o6N3fwO+CnVImlS2955DpUBok7VXjQX1plXA3zqtGK8sdm8fZP8xOArVMeg/rcdw04veN9aN2wb0F1lAbnrRL9UKctuYH5eSx6XkO5aScPq9sl5nOLaitPHlXty8lKP5S0Kx3uPNpn/mm00/y8/SpKqAE3bRfHFypYWFC7qLwacjnPKSWT2JltRASFo4yBrWOyDucF99Ar99zq57ueSmC1LJBHvi/xXTVanx6buz+D+rzR1CMAOe0YpVY1h5K85LHNFcSH/yGm1ujMLL8JqZ6urU7p04dHIaG+BhcTo2LdHTEHUta8+1adxD8MSw87mQpEeNvnc8tM8LEdcXtv6r7zBuPH6KMPAEOC6s6zhe3w82HAwP4sFhvHfgLvzyV+c1n9/cfOmFbNaPKqP8Ule0W9+9sPn+3MdLWR8vZX28lPWPuJR17TVi/8TbWh+vMf2nX2N6r5fi/vG34D7eNvp42+jjbaOPt40+3jb6eNvoH3/b6P/PP9DRCBdd13HOF6B3+mMdnXtUwzC/bHFp6k7XoIb4z9ktn4y6jk0B/Ctws4gx8o/VJWgt6NZGfzwZYViQhjb8MT3hsmpr/zxQL+C75c8EYbIhdLUORNVXAIPhsq98o9wZJU/sLDqJlpTtWzt/coMhO57I8UmWUueYy/DS5oVwwo4zmJPEl9TqJcxV1OaY6y92ZX34Gse0puOVfb7TVMK3rs8CX+OQDcYqVH5y/i1sD5ymuFVxWuLoz780W33AjIDTmhVtq+mDEEMeg/xl4JpCwZV328Z0kxDjpZ2hLQ5l8r3oA51t+h4Kroc1BG56EWY63tc5ksZMWHPH6xrDUD3e6U7XjbfyroqpQni0KjgJ1/+2QoEGsLaPHX2SX6W6knh5Ipx469WjZaJ5h26d6gtHgCqDipqHdrbVvpF/6kWYozNvJx9AX4oUGppb2z66FvAZNXyWoZDQT4/pd6zXNv7TpTAK8hRXEavcn116YtgrbxBYODmJ2bpMpSVOUhL4v/jLRrkrS/PZyJeBKnuPF0L62iNX4o1Tz7/9j3qmod4Uytg5l41+PoXi8/YfdOhkeqqE22Oq/S+XaveWycK1fVbkXJAJI5P9za8k59EllsI2P4960UknG/8FL3swFpt/+4Z8+qTzmxt8/FsJuMl0/gUXLy1c9HD+DQvJ6Vj/aq+uqXU/vPf+wFO2KVu/ZjDhejm5aCyfkb/rrrup4G6tcAn93UD+xbP7K1nrWLh6a6TidO3XvHDMij+23KLlJH79Ba6ihd3YtukAvfv0MepFY79vMHeXbWt+hWkEfuXEHko1cWMBn32Lci6npdvkdF3if/8HQMzdhg== +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"; + + + + + + + + + + +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:write` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/put-v-1-historical-employees.ParamsDetails.json b/docs/api/put-v-1-historical-employees.ParamsDetails.json new file mode 100644 index 000000000..c8051e6a5 --- /dev/null +++ b/docs/api/put-v-1-historical-employees.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"company_uuid","in":"path","required":true,"schema":{"type":"string"},"description":"The UUID of the company"},{"name":"historical_employee_uuid","in":"path","required":true,"schema":{"type":"string"},"description":"The UUID of the historical 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/put-v-1-historical-employees.RequestSchema.json b/docs/api/put-v-1-historical-employees.RequestSchema.json new file mode 100644 index 000000000..576fb89c2 --- /dev/null +++ b/docs/api/put-v-1-historical-employees.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"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"},{"type":"object","properties":{"first_name":{"type":"string"},"middle_initial":{"type":"string"},"last_name":{"type":"string"},"preferred_first_name":{"type":"string"},"date_of_birth":{"type":"string"},"ssn":{"type":"string","pattern":"[0-9]{9}"},"work_address":{"type":"object","properties":{"location_uuid":{"type":"string","description":"Reference to a company location"}}},"home_address":{"type":"object","properties":{"street_1":{"type":"string"},"street_2":{"type":["string","null"]},"city":{"type":"string"},"state":{"type":"string"},"zip":{"type":"string"}},"required":["street_1","city","state","zip"]},"termination":{"type":"object","properties":{"effective_date":{"type":"string","format":"date","description":"Date the employee was terminated from the company"}}},"email":{"type":"string","description":"Optional. If provided, the email address will be saved to the employee."},"job":{"type":"object","properties":{"hire_date":{"type":"string","format":"date","description":"The date when the employee was hired to the company"}}},"employee_state_taxes":{"type":"object","description":"","properties":{"wc_covered":{"type":"boolean","description":"Whether this job is eligible for workers' compensation coverage in the states of Washington (WA) or Wyoming (WY)."},"wc_class_code":{"type":"string","description":"The risk class code for workers' compensation in Washington or Wyoming state. For Washington, visit [Washington state's Risk Class page](https://www.lni.wa.gov/insurance/rates-risk-classes/risk-classes-for-workers-compensation/risk-class-lookup#/) to learn more. For Wyoming you can search for the code online using [WY Workforce Services website](https://dws.wyo.gov/dws-division/workers-compensation/) or call the agency at (307) 235-3217."}}}},"required":["first_name","last_name","date_of_birth","ssn","work_address","home_address","job","termination"],"title":"Historical-Employee-Body"}]},"examples":{"Example":{"value":{"version":"db0edd04aaac4506f7edab03ac855d56","first_name":"Soren","middle_initial":"A","last_name":"Kierkegaard","date_of_birth":"1995-05-05","ssn":123456294,"work_address":{"location_uuid":"1da85d35-1910-4d5e-8e94-39e8cdfe8c9a"},"home_address":{"street_1":"300 3rd Street","street_2":null,"city":"San Francisco","state":"CA","zip":94107},"job":{"hire_date":"2018-05-09"},"termination":{"effective_date":"2022-09-15"},"employee_state_taxes":{"wc_covered":true,"wc_class_code":20992}}}}}},"description":"Update a historical employee."}} \ No newline at end of file diff --git a/docs/api/put-v-1-historical-employees.StatusCodes.json b/docs/api/put-v-1-historical-employees.StatusCodes.json new file mode 100644 index 000000000..3732fd98b --- /dev/null +++ b/docs/api/put-v-1-historical-employees.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Example response","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},"examples":{"Create Historical Employee Example":{"value":{"uuid":"ad85459f-8bf5-4a8f-9079-3b3fa790799e","first_name":"Karl","middle_initial":null,"last_name":"Jaskolski","email":null,"company_uuid":"3c69d228-a250-49b4-9946-24e4e4294da4","manager_uuid":null,"employee_code":"eh3st1","version":"dedac972dd28945fcd6cd941723cc71a","department":null,"department_uuid":null,"terminated":true,"two_percent_shareholder":false,"onboarded":true,"historical":true,"onboarding_status":"onboarding_completed","onboarding_documents_config":{"uuid":null,"i9_document":false},"jobs":[{"uuid":"f0be5480-7a15-4583-b0d0-789c02a1afe4","version":"1c0722f3e090713b6a0db7c39904693e","employee_uuid":"ad85459f-8bf5-4a8f-9079-3b3fa790799e","current_compensation_uuid":"1a1faa42-274b-4440-b200-a5d81df14af2","payment_unit":"Year","primary":true,"title":"Client Support Director","compensations":[{"uuid":"145660ed-6fcc-4211-8915-18e2786290a2","version":"2cd4b18662395eb53bcf80d5b5447f36","payment_unit":"Year","flsa_status":"Exempt","job_uuid":"857feae3-414e-445d-b28b-2eb3ef50155e","effective_date":"2023-11-01","rate":"70000.00","adjust_for_minimum_wage":false,"minimum_wages":[]}],"rate":"70000.00","hire_date":"2023-11-01"}],"eligible_paid_time_off":[],"terminations":[{"uuid":"ad85459f-8bf5-4a8f-9079-3b3fa790799e","employee_uuid":"ad85459f-8bf5-4a8f-9079-3b3fa790799e","active":false,"effective_date":"2023-12-31","run_termination_payroll":false,"cancelable":true,"version":"e6c865df784842196d411c1466b01686"}],"garnishments":[],"date_of_birth":"1986-06-25","has_ssn":false,"ssn":"","phone":null,"preferred_first_name":null,"work_email":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/put-v-1-historical-employees.api.mdx b/docs/api/put-v-1-historical-employees.api.mdx new file mode 100644 index 000000000..50ac5f88a --- /dev/null +++ b/docs/api/put-v-1-historical-employees.api.mdx @@ -0,0 +1,71 @@ +--- +id: put-v-1-historical-employees +title: "Update a historical employee" +description: "Update a historical employee, an employee that was previously dismissed from the company in the current year." +sidebar_label: "Update a historical employee" +hide_title: true +hide_table_of_contents: true +api: eJztPe2S2zhyr4IwSdmuCBqSIilyfqTO8a7vnOTOrh3vbS5elwwS4Ag7FKEjyJEV11TlNfJ6eZJUAyAJUpRGMx5fcpfbctVqSBBoNID+7sYX5zO+bmQtMC9rdl2RmosS1/stcy4/OGyTMkoZdT7OHLFl+u0b6lw626bGtx5ec1mLimekWLHNthB7xqQzcyr2x4bJ+p8E3TuXX9SfvGLUuayrhs2cTJQ1K2t4Rbbbgmeq34tfpCjhmczWbEPU26J4mzuXH744GiJHpL+wrHZmzrYCeGrOJLS7ZZXk+mPTUNYVL6+dmcM+k822gEdhRF0385Zxmi0XySL1ie9GjEYkjkiepYEzcyiTWcW3terLeb9mKGuqipU1MiMgkaN6zZCGY46uGFN/fzDveXmNrhtO2cfn67reysuLCyoyOVconmdic9GiFG/JvhJFod5fcMo2W1GzMtu/QLmoEC9zUW0UXpAo0VrsUC1QI2E4LlHOWUHnzt3dzELuhw4PH2dOzWs169/rRyQtGP6hbXo3uw+jOa9kvSrJhh0i9W7mbDilBVvxktecFJNNCnKqg23FclZVjK7uGYmSmq1Evkp5Va8nW0g5ufBbUtesgnX84OLk45fkDhrvRHWzIpRWTErrqyNYKITemqum4XRqkOGG+QHmxMqMwVoRlInNlpR71Pbi3MF6rcWGnQ+BrCvG6pU3PXP90u9ffuhBK5uicD7ezZyM1/sjn5N6Gun/wbcTz0ebrQPNDNF2qD+HkWtWbXip537vTFmes6zmt2xFJ8GaOfpEOJdqTxwg/ztS67PYEiK0IxK1IDCK8kpsVAOzLno52IbwiQ087v2t+kGKOXqTo20lbjlldGbGI7xAZkXRjhcFShmS5JZR2Ac2SHNA7i8ivR8ba149FhFAtuAF2q1ZeYgR6LkDbIQK3Wyl1nFVk89scocOhzsAfZetMnHL1C7pPk6FKBgpD77+ac3qNas0VftFpIhLxAp+zdOCKUIIB5ZV8pkClZVSk0Q1ALlmiOsZKoglUOefiFzz8roWJXr+08sXSFTop73YAGF+/tMfXqgVAAgLIuUqE3QSwYcIrbi8QeojBB+dAI2XNgzW8ArGOXoNj7oGM3TLJa/RB+sb1fCZRD/AmK/UmFtybbGU3W43L0o+35H5tbi94KVsKlJm7KICLGCAFStYmbyw/8C5qLCBGttAW61wIcRNs/3bixewRwpGqhJtRNUCbuayFw3KSIkkI1W2VtjQ24kyJMqClww1Ehp++OkP6CdR3eSiyhi6YtUtz5hEO5ZKXttccifnu71Q86E7iSkHvIjyYhJctawZKQo1KrkGvolIjZ4v3OUL5C9CvPC9JfDHMdGyuI3NosZ8RnOVEbsY0W59kodUzmK8v+lEI/y9OVhYCUR3QBqNWKIOzPetiPLFuSVFwwYSjUNTl1HqBoSQLAjdKF8ySlJ3QbI4DGkYAT2wWKhzJSoGoI9ZtPNyMONL5184q27YNSEVPZj/peMlSYhd+GeQcen5iyCM/CQ45KIjPul4lMQhXYTYSzwXBzRkOGZJgBcJizOaszhLiDPBC3tu5yxcFy0qiq7UI8dmdsDZWrbmXJESvYbdz2UmOh506bx6aRjRZRJ47rKnuxZldXzXi9UkE+eQXY0ZkuO7vo/dBHuhc4Ja2uRPi7sjcuO7SeLf3em9OaQ0P24V4Saol6uHvGNLKrJhNaukkorNShoqrrE/czh0tSVqG49F7162PpS0Dojejz+++a6VeDtOMeuGnRD+vykIE0ixwfk3/GulyLx89wYbqbeFZM0IZdUAlpwUkh3IEEzvASbVgLAYOCWSUfTy3ZtOByBSiowrmWLH6zUQw0o1AIqkBIRSlAw4WS8oqDaWsvNMog8bXvJNs7H7fqDaQLYc95rH35oOsfX4BYDRSEbnznHMzxxWNhsgj77rh9iNYIt/BOTkpClqvfXb53d3Hx+ybWeIlL0AUq9JraSQbcVuuWhksUeUyw2XckJCa7l7q4TtGanmP5c/lzITW3aJPnU65+WGlOSafVJLLLeilPow+q4L/xuCa+gtals6D9BIW+reknSg/yfFIyU8sG3FJCtro8/lA5zwEqmNCyv0GduMQTZZxqRUFKZRTwx9pUs/9mmSYJJGKQ78PMQpCUKcByRauiyOIxKP+cI/CaKE9DFf0NR0wBiE4m5GMnZuGCvJPGdM1r+64WxdzjMxb24U1iy6c+mwxA2ybJng2IsJDiiJcUIXS+ymzCVxlFOqoNJLVZmv9PA9uyNhxjIv9zLXW4Q5SxdsGWUkYmSRBZG3BHZntoMhOhv42WLIyZuiWNVcsXRRpoJUlJfX/XvrGUBfsJpR55g6qmGjbEuqWg1jg9yRPE3VnSDK3UWkFE8N04bVawF4+Y5XLKvRd2wrJNc7pO2x7axXUzrKVO/EasuqTE1vTSq2FgUQsfa9mUlPV/vD17VZE7lSvFu3sCZPRdYAAMCUypxf95tLA8STronpTXNQzXfMgqdZvAzzhGJCsxAHbh7hJKEpZjQOlm5KiR/mjr24cbRIM+p6WejlWU78IIpp5AYZcNpl4C0cC60P2+rtnrDFxLYLn2VeFFAXx26c4iCIMhx7vovjLE9D102CkLrWujUlB5L3B0YqtTP4hlT7FoX3rYoWBmwZQOOzf25JAmbtDUkxB6qFfoDpM6fwSOTZwuYyzdMgIUHuxskiWPhZGkb+wvPSPCM0OYqmvJCkP2Xff2abLex0Qn9pZL3KRbUyzGm1I9esQ5f9ECb8UW2y1cP215SgpriVC/BW+lnsuq47d10H2Nf42WwkFfqB+Rwat+roaks4VbRlJfJcA2uJjAb8a1KVXK7V2dJPxpK177o9dOp0Kh16LcpuSyj52tBf/WQDAkC12oqqJsWKl7dcMxOLN3TYB04DfEncsHLFPm8HAs+OFRlI3ar3FTRdkbqbtIe98L0XXC7cS9f991Zh2BIpd6KiK83F1AcAlhZI63IaMEU64NTc3Y1NBOeZ08by3yTHrBihb8vCHNC72WMtl1OWs9MmzJHl6KCDqelsWSXBjDQyGo0mOEfvwRxiCZCgi8tmC1hGcl9moFo3klUSpazeMVYikC/lXtZsg0hJlbwp5+gPokEbskelqHvj8XBs0N1B1hLKDrNtqq2QDD1n8+s52pDqhtW8vNZ2kyG/f+jytULdcCll+5uidD+5oEN54UHonto9zyQyPU6OdsKVcLZ3oF/H/2X/wMT8bNnjQbi08Nf30Unoem0nR7RlmwfYA4ebpO9keoxjbLmfYj/i9ByPjUxQvRPIdI6szkf72hxahXmwge21ugeqpDBt4A+lMZISXeFXotoiVta83iMAct75Jx5DWeDDP0+qYgmyj9seayJRJ8yjXsid3CkTSsFYP7RPdt8c6eZjrIKQU+6HXsoDtfqI1kHohpcr6yUv29cgGrAit19uWWka3fLJBvoFPf4GZlydbgFSK22meu8AX6X7lTX7cTuyI7xWP9TsQM9nO2CnHXrUJlZi2InFmVJQTmvar1S7RjupzQbsN4m1kF3XiDawUNa7A2fGVzKdyVHNhCbmP9C6zj8MAvEyKxrKwEa/QW9wcjD9qZmOhr/rNLxuZFJVBGwGvGYbaZs//llbvk+6sB4nJfwi0m/Gl/+veO0PFLVHS8K1QLs1z9Yt6lDKClFey0kUnvQp9q0nLaNnORVFhSqmf7YeIbWcd52Se+IgTQBgrI+tGWYMj+rzYKROYX+Y75HLsZRoOlIdIxhPOWd6By+rlRe1ahhqygKYHhy4z1wC9VOLof6QHYS9JX9icaoj63J8cw+8jvD5fUdoqLk/TG/RnyL4tJN7puAYrMYEDCfsNA/WJ6bGvwcF98qJD5M8xK6U4HcsGJE18v9+LBIenqu7KRPRY4TUr3eXT3jL7wN4wml+1vZ5rPfcuMzfAX7Zn42nfBKJI9PeCRb7CHfCGIWddeQpOPLRzv/CeXRviHyEDDPkzAMUnmLR30QuOHv0YzzoHNlAFAWpENmIpqwRWEpBZR7wDePAnuJBDxpK8SCSGRoL++JgkpUiG2/GZkPFocWuZNVMM0y5Fk1BgZs/e0f22ZplN8/mlt72G9GAcfsnxsDd9VtRKoe2MXm3XyhT4cD+fVwR7AzjV6QgFWcU/U6UrH1o/34LYDoz55XYgHcUZgV4QV0P4xf9x5Mk+PW/Xr1sVVjNpLkcIG2OOpieP9OjPHvRIU8iUjG9rgTl/DOjSELzPWK3rNrDQsOCc0GtfpStA1gPGM3R82eHk37UCDNli6hYxvgt6/uHBko6NR7ctGBzBCtY7NHzZ/cM2cota7BwwK+9YlAPGapfEEatIZ4/m15CgANYhnJ9IB1loMxGil+3X4y6HWP06CaY7t3q+CEzU3sRZqJ+PHuh0NbPUDn1xa7sJaF6x8p63xnNxoYyp3d6vS4kwVdqW+L3cGjuDv05j6ISXSdabTmy5V+bZVdOg8G7mW5ulBDZBkz+ItJnWt1R/U7pNqeIteIMltoyBgi6O+ozu1dGfVNSiFxgEvEJ1p21tE4PoM1/bQwKjNAaCQz/hHCWrCkMYFOG+aHz7kCkOWOV7OHlQWDNeArzU3LSU4g6NjjaHDtE/IluFAI1+5uft4nv3bPTQB3GNKq5fjw/eCQNaOCxEMfeIsPBcslwmhOGFzElPmEhW5LFwCl8RuKE5bTNvJymgbfE2SIgOFiQJU78fIFDFmW+m3l0SYIJVzVZsjhP0gy71PNxwMIIp8s4wa4OO1zGiev13txl77l9kD96ylW8ALen6vwR3uqWjl2JvN4BWfy+vOYlY5UObwTmM9B1rXVgYR6RZRrjLKEuhmlieIThGTyCJ4N1SOJ0SaIspAFb5D7xUjdLaMyWeUTCNMgWw3WgPgvzmHg4DbIlDmjiYrJgEc6T1M9CGjNvch3SOE+Im2bYY/4CB3m0xFmcaPjMMvj9Ovjh5CIYuWm4CLZ0883W4WVLQpwRgVq1VM9aARLQJCVJhhd+luEgyzxMwjTDEcuDjEbhgi3JYAWyLExSuoiXCY3CME+TwCVeHqXRMsx9HR5hr0Ccx3nKljhIIoqDNEpwHOUuYJZ66XJB3DjqUfl0mPRi7PnYO4lJHc0yRmS/NyljJCQ5ZhmNcJB6GU5DynCY5blPF66/XEDgiO7LWc798B5Q7j7e9ZwSZNf+RNxNsJZ7E2/A1gDCySk9oeF0wvmrHGVt/4pUd/k5k56gyeC91s1lq8NjhtRO9l/b7u+n0FnFgPt1ERkmTuS9t7gMFpdBMnddF7vLS7VTGhV1eaxx6A4aj0L1PDdMFiQiOHTDFAeERDjNFxD9QTOaMUZTNuQBzEspjYOQBMkiWwaJG+cx80IaeV7gRQl4A0zXUeotQo/4mLJFiIMgSXCaBDFwgpSk/jKIFFk7L9Tbedl5mhde7Dwg6ttRYd9q5k1Zgz3Y+fEK3hK1RdsToMJuVmUD0TU6IihZRO4iXqjwyUL7sUx8ujkzZOLxU4W4tFuxNYP85VtZHhlT0mecmKAS2+DRYbE1dmjlyDjJaCsdj5sNsvamLeiD3fIovUR1gXQX3Sw6coTaFE31apxACBMxeWjqfWfZ6BtYaYETOYPT1t17kwgn7ZmTWYVHzcfnNZ3MO5y2pppDfdYatFHsQADuJk7wvYrV1ZZlPOe9YtVtHeM2MiulYotU5y2HeNzWuzskPmPW9ACQ8ieAaDZGESyCxa3uO7iQnakMDMr0DwYGG17TE3Rqc7Wv69T0pFRqQ/PvXej3xjnSx3n0R/NNqbvpTxtak1uGUgiUoUzFRsxQ2tQqNkbW4CdUDaysCEpqMqXmbibJDS//LAGfVE8Pk52OCFfarTVwM0z1dSwq92kdK8o2qLaYyPMTnpVhkOhZPjH4pF2r4TA6GKw3Gv+emE0NygBkZlzx7Kb74zei4JTszd9TUTVbUfBsv/pKGDvwdHfT/FGP9JVBM+eMRLKsakhxvy+7r/9gVKkjDgUY+N37twr5ylMAAwB5nLZ9teMPXSbnIVXzftjruhMFQD8i+E3aN8akfgqCNs3kLBw0ZcE3JkjsELJ2VN3lkeU4BYsG90xYjKXmEIxclQ8xKb29VDexOicRk5ICXL1PuzpHIpQ/KzX660Y2vRyHoCjEjtE5eomgExOOIvl1qeWAUrRdHIn+4MBVV9NFGc4Je2jBMdNTkaSKcA2LHKBmK0pkDTPNIlr1+B3hFL/nG4bf5rkqMjFMqnhagk5swJ7cVW73/f9Gg/sGPmsr4NsIc6SuSbY+euLPlJKmgnieDceCYOJrlb5b1sJY5KcjmeAMGBvUUwwMYnDX5Ry96n4rgR6izHiOPlVNaZ/glVnDT9BI6TvKrfdpaIpTb03oT97UzThGpQ0+eBK/Wz87SJ9BIJqIXFnd1G45MoFJHN4zHPj3wSQz3EbGp996Nus14xXKOejM2st0y4mKA8hznO2zgrX+LhUwoAfSDuB7exKledieUfCeQq4wbQp2WJ2p9dO0lO+9RYmh7TB17DjdG2Lh19ZXM2RbBSijTaao6Ex5bLVTXfuoJLQ0/lk1F924TcK2Qof/+z//C+i8ym9ge1X1I2V9c4Kk1kQzi3GByKBGgGx5QGBTKc9iSiSXc2SDrDokhRRa5WiZYA+77gNSv8E3roAGyoW1rKFc21J7yUUJ5EmHN9i4VJPPRFPVWFQUQu7auBTdNlvzgnaJEKJCKclukCroMEdXYsOs9A2TOoEKQcrWKcyrsTMcBqyYYo6w22xgpizFT8F6rDH+PwVpfRvmYyPzVMDUScZjrE7aajzNDkSlcmgOxgReoDEPaURqEB0aoM7u1DS7klB5IUh9Hqk2wVqHG2iOvucKPmKRCAC2DcwZRHuB0dKIWUAPIGNKATFDKtvnZyeeu+7PzvygwMfjAs36J1OQa5NyU9Urc9Qfw1hsbj1eFugbmb5N9MfGjn744KhCiip26/Gh7WNSCsa47bbYH67Um+tSVNqM19NZIzFohts+PRcTBrQHYaZnlQ0cXspySLBlhbZlkrJUmqqm7QDHOdv1HhQdcAqtOJdlsxmpSLwLi7FUpPs2ra/iC2Dbzo4pcbD4ArKex8dyQt37ygm/7KarRrQm3bkQeM6Mpn5AT87BhwnONCq8vVbnz+mRa2bHDn79wnmRTW5gnBWRq56OPfUxMFS0DyWttTFbw2bRz1oMBKfRzJ2hALjSIH45I7lQiS8rI74AK2CUVaSAilSrgqtaYF2Jqv5BQ2EUEGMcZcmnvBbVyoLA6sm0UrmcgyaTWX0ThulWQlTmG5EPSId2dFlUdSQuAUEfzPBAAn5JKTdesbEoB2m6lNWEF9I6x53g1e7kcc3Nx6s/kCtcMKg8apIsSJpCCuQwO0a/4lI2XfjyIeBz9FIXtlO2d9CBbwk3GqHW5T79+vv36OLWu7AxdjHA1ieoLjWIvB7b6E5Mr4taVgG4Ox0Frf/Qeb3m0fsdz1RtA7QxIdIqVLrYHxq6fiN2SOS1ySEzlfsyURQsq7XfCjwLkJWjXFZGwFBH++9C19UDFHuE/xF9MoN8Mv6y7UPqOb5+8+5K56JMBR2a/Bi1MSGQ1cD5J1ywiQiXCS8okYfe6PNS6waJs2oqV2Yq35eqVqM6m68g7eZ3WhY5xBOIQ0MspAW/1jsdo8r2ZG+ErE2Rzg5LHVUwLXtd7es2ulqLJ0DLW0U93gCdBAOrktbNs+++DhsSdMo/ETYqtuF1Dcakb7pTfuiG+TPCjmWFtkwSWM0Sm1nea8WxvlRtM9B1Nyulok6ZcUYYVa21QqsnJAbe+XHuaOuubxO+VUFIZbTUKZHW2K2DQIVUnWk0f2m6aMtYDCrVHVgqpjRuK6THhmZ1nnbeJ+L2sXttmT5jddAGKuXthyq016weBALZ8EuA5mj9nlbCOg3Tm3Lb1Fpw6WKOrCFsP23NPtddKTLlKDMnbtYWaq4I5cLePHr58Wvoqst/OKkkgwWnLRJ78EYy4KNgVhXbkfvkQ7cBpz1QL0ukGgDWzcdqwmYvCe2WRmoGc/QW2P+Og6kUupsKzO+qho/Oj6oPemyLmOUyi9NO1UJYV0rXxpw6d0cKxZ8kcm1ifFsm7wEZFrtjlUigtsvV7ywb3PES9ePio9uKZarEjV1KhhQ7speoYnVTldKcxxriNCpV4+Suqx12qpTV6Xr79/onbQFy7HA+mdFgpdObVEDzeX9sDsojvtJZdXbkln50IBTdnSwGeY7yZNeLhFBTHUnSlCBC6Cym1doEWvSvzYtt0cju7S2puIIMTiFRRb7OVY9aI2s/hSO1ZubodVMUWKn5vcVZBTQv3H8wuWtbI5fP0TtS1ePGwGHktuC19m+BunJdiWYrL1G9FrKt0Apd+i72E9MpUV3qnLFxO4Us5LuDpnP0e4MQa3AdVGQy7EiNblV2H8nW5pMrg7gRvH1FiUjL/x1iwCsAYhlUXzhS8qKviTlxuA+306iq5zl7XK5BntHGEFMB/aBE0Alh/qAu19eGz1jVucbpr2qpTqasHWJEYf9ION7BtL7BzQQAAaWsXB0hoocQ/zUX96+5uH/NxX2aXNx+aGU+5JMqzQEZGMuCRg4GMe2MQqZHzXTDk/Rb1RPSPaG+p/ZkWT7EccxzR3+m1agD4Cxd6jBU6DilOc7qh/x9c2QmtnJhqr8p8UIZZ29ZBWaJVpo2ReN0CEkBV3bdHZSAfVwxRAuzqj+FJtOnTpKdLil7judAVdg34tcRXqFEDjgO3aKZ8UzFQeAcsnX9HS1X+82AaQcDNZXp2vYq7kWPPdf6z31Vch++MKrUFNxvBUGiuveJk7Bj6VqIG7ViKtpbthZ3U7KxlSuf8HhM2ktmxy5emVLH7By5V8qZgvrLVFCrAaKpa1PaxE4ah0GY5DhO8xAHJM5x4i4TvEgXOVnCz4SN6+P/C6mKs8rj/zORN6KQN7yvkW9uJBnm2C2yKKG+H2Pihy4OkjTASRJE2A9YwAI/CahKwJ0qhz+uLc/WC1l7w0rdjJIsWfqU+nEShHlGo4wmgbf0F1m29MhkmfkjpeztCq3nlTk/WXz+oNj8fdX3n7oufe6mLAxiFy+JF+IgjBc4damLl3GSuT7xSM6GmdVe5i59P18wN3GX3iKNiEvTZbZIEjeIkgWbylc/b4udqkvvES8nJPCxvwygqHvg4tR3XUxCGns09wKS+2fXpW8NSuDgqzsTrdatRXWqtrwXhFHkMoqjHLKgfc/DceKF2IuZv4wjP3GJP8CWn9Eg9eIo8hdJyNJwkWZ57NIwDYNgmQ/uQDgrKd9KmY7DZc4IW+DACxgOgpDi1I9T7MNFEHnoemHIjqaPeyZ9/LBGwIMTyq0i8cujReLbER9YJP6hVOqRO6+NTWp9edMo8/FCoexYVKb52g521RvOSg2OsjgKab6MgzjwvSSigedlXhBFqetFcaTwc39ZfC+JI8hgVqnknUWuvVZhskz+qVs7xiX02wuXAjc49CD/TtTotWhKin4uEfq51LHj6g5Tpji7aOD6MipUKEKtCzvO0W/JDUOyqXQQXFdVWSnjXDFFTuc/6+DOmlxLpXV216Sqih1yy8gNI3KPlRlmcKtS33TYEqaJQUuouOIOOtFN3XVas1J22+yGQdbz0ftdO0Oyfc8rWKza78awdR9Mwjj95RDWvgcDM2yN7p6UbVPrezthO4AHpwu7vPhi89a7i6lrZy++HLuP6k4JzdVte2tWU8G1Nm2AItlyHZ+IKduoIMUJy+xGjNZA94d1nQd4DdM/0vFkn+8qZQQ91ucWXgN2JIRUqVzbD19U3QRS7l+qugEvG0CUplVtqyu4qMhITodtOw0FQGzvg1IWMUYqdpiMY7rABbtlBSJNvQZfaHuZ6cy5UpXBv2YE3cORAYCzS1H+0F8mbIt8DylPMxD0OgXg4Ia87o0t7vUXyk5SG0vbGxG07oUmXt2f912e17tzTlyP13fe10ronpkiCVYbTfK7B7pCguUKu//muwC7S+wn1sUXfXeTN+sNv3jkXXn23bOgzztWDWrlXgFP7lA46W8q0/OSb3Nz7aR1NvuAZJKKpr5QDS8obENQ7bH6G4tcnUn49EAPMzpoLbSb55lE3xsiit6Z+llwr1srrCrc/o25aYxkdZ806nzXjop+YIWREnokdzD9qqclSqUUst6Q0urn1C1sY/i/9Dee/d+6vc2QD3ClXmwLwhWdUXT1i+EMH5xbr/MgcsUcL0cXIB65lfzy6IWFH+GsyRo6//IFDHQ/VsXdHTz+Y8NAyAaBpfPwACWmXMLvIxcJ2uh93pZ0eIGO3al4ZNqtlU21aBmnMzNcdjBn4D5PAtL03nkEeEdxra4/NRcyPgyTf+G3M04iWSNz+mrLDue96PVKI0ubb/sWB3ca9l8A91Za2PG2toz27sf3zsxJ4R7byy/ORhPpiuyU2rXTG8CKPVDPvjgFKa8bXStKdwn//Q9EyM2t +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"; + + + + + + + + + + +Update a historical employee, an employee that was previously dismissed from the company in the current year. + +scope: `employees:manage` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/put-v-1-home-addresses-home-address-uuid.ParamsDetails.json b/docs/api/put-v-1-home-addresses-home-address-uuid.ParamsDetails.json new file mode 100644 index 000000000..45f54008e --- /dev/null +++ b/docs/api/put-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/put-v-1-home-addresses-home-address-uuid.RequestSchema.json b/docs/api/put-v-1-home-addresses-home-address-uuid.RequestSchema.json new file mode 100644 index 000000000..9e5944906 --- /dev/null +++ b/docs/api/put-v-1-home-addresses-home-address-uuid.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"allOf":[{"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"},{"type":"object","properties":{"street_1":{"type":"string"},"street_2":{"type":["string","null"]},"city":{"type":"string"},"state":{"type":"string"},"zip":{"type":"string"},"effective_date":{"type":["string","null"],"format":"date"},"courtesy_withholding":{"type":"boolean"}}}]}}},"required":true}} \ No newline at end of file diff --git a/docs/api/put-v-1-home-addresses-home-address-uuid.StatusCodes.json b/docs/api/put-v-1-home-addresses-home-address-uuid.StatusCodes.json new file mode 100644 index 000000000..1101f8121 --- /dev/null +++ b/docs/api/put-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"}}}},"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/put-v-1-home-addresses-home-address-uuid.api.mdx b/docs/api/put-v-1-home-addresses-home-address-uuid.api.mdx new file mode 100644 index 000000000..64e635698 --- /dev/null +++ b/docs/api/put-v-1-home-addresses-home-address-uuid.api.mdx @@ -0,0 +1,73 @@ +--- +id: put-v-1-home-addresses-home-address-uuid +title: "Update 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: "Update an employee's home address" +hide_title: true +hide_table_of_contents: true +api: eJztXFlzGzmS/ivY2ge3I1gSSdE6+LQeHzt6cLejba93wu0ogYUsEqMqoBpASWIr+N8nEkddPETKUuxubz90uMUCEh8SeSGRwH0kS1DUcCkuWTSNysrEN6N4IQtIKGMKtAbd+TOpKs6iQcRAp4qX2DOaRp8XQLAV8a2IzAgVBIoyl0sAwjWpNDBiJGFgQBVcAElBGcoFMfSOcJFJVVgghM5kZYhZQHFEXgcQhCogc5CpZMCIFCRVQA0QKhipSob/ayQBoSsF5IbmnHGzPPpN/CY+VWUpldFdgJBlkBp+A4RRw8XcEkplpQzoJbnlZrGQOeNibmnoVJYwJVdhQnp6q7iBq2gQGTrX0fRb9C7MtYYcfR9Ed/G80kbGXBiYO0bHZlkC9oBiBowBcpOWZbuJ7VpSRQtkFpK/jwQtIJpG/x3/pyX4+uNl/F+gNPJ/EHFchAVQBioaRDpdQEGj6X3khoq0UVzMo0EEoipw6PFw/CoensajVzgSg4xWuYmm7d9X/TV+GxZO49og2yCeUVzV1x8vyY3DQqjWMuXUALNMJEtZKdsgpXl+RC4zIqSwAlEqecMZsIFrQ8sy56md/gtNvhVc8KIq2rS//7QwptTT42MmU31kGXuUyuI4MDIu6VLJPLffj2nJY9+Ti/m/e4Jx6+eXQS6PotWg5vAmabf8LalZbJT8L18u36LEm54WRINIwe8VV8CiqVEVbF+a1er7INKQVoqbpV3vN7IoqVi+TlPQ+nVlFtH02/dVS6SUvqXzQFeBLqVAoZveR+PhEP/pAtWVpZRVeTSIUikMCIOtWnw//qfGpvfrKOXsn5CaCAeHO1qUuRvI00y0oaayv1h+TaOz4ZBmZ6NxfDqe0XjCsiw+H0+y+OKMnqSnGaOT0Wk0iPw6RNPoND1JxycwSdPzyXDGTrLRZHSanY1nr07Oh5BlKLtewZIwxjkbD08vRnE2mk3iSXY2iWfpJI1HbMJmw+HFxWw4RGUwCsAko2ganYzGI/KB59dL8pUum2/jaBohUyzro09UkPeKipTrVNpG1CAP3ryOBtEfvIym0cVkNDyzbKyEUdjpyyf8Sq1FCWtSm5iEOQqji7NhPBzFw5Hra21N0rI10TSjuYbVahCVCi2z4dBi67o+75bF2vwGeVytcfGxJC2p3vzWaTmbHk0j22ATbWe421i1oQqtR85vrFm2niDMABV1C+fq0WdS5kDF2nAt+8Uzp6eG3oEmeiGrnJEZOLMPObPOoKSckUyqGpodvBGn9ekqoOwXkS/DMrYFLLT+1jQXVZ6j+V3v5iRxvwG2sH69qRXdfRrWUv1g47brQA1YNSrw4HLg6ju7EWQrl84MHZFL4cjUP2myoDdAZgCCMMjBoNuYVYYUdEm04XnuGiy4NlLxlOYoWXTNG9mgojMPVNVVyxLtoxBppRQIU/s8j98ZySPyCZxIf2u8D5lXnMGBDowzKEppQKTLl1YQ20GSFGQhbzHmqTQOxzXJOOToylZtt/Mt8i4szPD7IDLc5DjFELLEr4N9WGHnyXCy7j5+loa8l5Vgh3iPLSTIb4KQ3wSyEoGCxvVRoGWlUiBMgiZCGgJ3XJsj8oFeA7FhHTI1RA3k8u2xNUxcu3APl7XvrdpsAKWkcoFVx7T635uFp0pZ58ANFHqTD1yjmlwDdkipgblUyy1j2FYPytenElKecdDkdgF+zrY7kWlaKX1EPi9LFPB86Vb9GpaEMxDG9bLG0hjFZ5WB4zqGJApyqwZGNiSdNQ2oD4CGFLAtSr6jRKxeeFJhkbRHPleyKrmYaxdkU4G2NuwHZhXPGUlRFwrffkEFy1FruHCxYSs0tpgL0JrON9q9LuSPAQgDQ3mum72FHyomcxCgGnZ60gGlrlRGU4cUNzS429CAnHO60o2HhDRJZpWkJVjfOusfeYlvy8u01bE1uWiLgtxSpx+2w1G0+o5Agk7/LE1slSx+h4PGvzip9Zo9Hq+r5RdRKolhHJ3lQN4Jw80S9zyfLTvokixoWYJAeRSWczPJlrjydmk8PoI2gXLhl1wTXaULQjW54sKqZ1ILZXJD8wquBkQqSy5QyOwCsQo8r+ue9Rb1qmVb37lh3jgectAHGlcLM07r7i+dibZ2tpAKgsQc/SYeb/E2s9bZvr+YG5j7l9X+81tt3PjXA3FNroQ1aolbx6tBK4AitxjOeZEnlLiW5Mo3JX6RXJKGgFUqrxj/a5wDojAUQ9BNotiF8SYot4IcbqgwLnQ1MgjI0muyN/9cEKvTGAVas+Et0iyHI/Ie9yvOIw06JCw+y6or92+CqK7s2oZfMFK8cuyfNZEWBlZSwC+ZdWW751JUueFlDm4s1KOe4oWf15UtfDlApXsJDi7mYWTsRhnj+InmH1sjua35hrEdQx6Wmp9pAfVu2HHULGhbbFKpXDqGaWKklYYWgx8e4Yvgv1fQmAdl7WYznqXorHemZLFjb1m3q8rEyN0NO3ZuU4PeVnO9SSsK+eClP/7KzSL+RUDsnF+02t7qg5cd1xSXBpNyf635//01R0pbHXaXD1/R+EiRL93uDzM1O9zGEbk0NpUsteYYYhnp8gC1HcrhBnKbYfBuJDiK2qxEKVdplVP1k4PbiZtfRu0ZbmgQbdgFzKi4Tmhq0yiJy1YklcgqwYAlJV0WIIzesUPApHp3e7AWrHW2Ce8rgSmwD2AWkpEF1SSMRurR7Bp0gN2A4tky4cKKbopIS6n5kyL7B4YBOCrxo6LnxK3LDIgdnwM7Ih9zoBpIuoD02gUpGLF6OIQW2FEfbZ8CzTGds0wCxWedALLXD+jSUfU8NgAsuEYLlShZGZ+k3LYrdC0SURUze4azAWIvyO8A/dX1J64/6kRwux6Xl4QklSLjc11Dq2PNg7i23rsN5rUhuKSG4ElPE8wWlTbtwGIzsDDbjGoTtCXJecHNDoQbGh/MwveI2NMglkYrM0w9Z2vMSQmKS9bgBcHqPPgWlHWTjdg28/KdYC5J3miO3UGZBRXkhBRSmIXGmDCrTKXA4Uvd2VHCBau0UctEQ46peikSQXmqEzxFTZrAbCvipvXh/PwZ+xLsu0Ec90Poh3l+gEE04feK5uhFTgnjc16bnR1wdQCg94CreeraHo72E08tVr0OduLBOqyGF5DILEtKmfN0meCx5n5rXTyKicWm9e2DqITVKGC1vtA0VRXNE7VbZzrNDrDcr10/gv1qjs1yNOUYWdV4iAXIQW8BXoJ1rolPpOzyjr2uh6B945SbgT33QMiOhtvjegwEByAyy0JWZxvmukphn2WvGx++9uH8wBVn7C0BM5pTkULiyjYe5a13oXpDhU2PUvZPu+xuNL172Rcy5wytOv7nAIewwgaiTxkV+ZP9OoywIQXxCNAD+cXfDg3Txc8Gqz5/sZH0JmADUvqQzdXgSAFbodbusRazZxHFS9emOUbGbZdu5TAsPilmkioMw+tz7CfkX9BhDPhJPVTryBwhrE3mCRF8trlHrm2yx25LuehkgTG53PNoLqxIQGD+CIMwo2hqpEqkPR7diq3f8nA1rQm4/V4T3zgs/uwdpRxtn8PbKGzA/5xxbG+OG9ycLVZAAjQzoOxef58oYL3X4fz7WMfVLzbQe9GocZOasHlK4hXlBoTxswipxX3xd9r/EPIOpQcxh9bNlgaPHJK5klipVda2RoDdDOyKdXyLw8MdsHuEOqII+4IeJBu14IosZKX2CQwf5+r+jtRbmiNgTrFuoofG63iKfjB/Qnvz0dFvAXBD1OqRKfkHiMTjeFJLh1kfP/zaltwfumFu4dJol05vMLqwg+EJGc0NqC1oE09l9779h4BzTWaAxq0GHI5aelBtqpFrGwB6sJUoJOMZt2Y7QA7ZzKcEG06MyrXFdgAcJzssd4ZSg7rxVlwvtYGibhRseD82sFZAJ6Fq7ME4wbX/EQPUpdRotSA2PelxFvQOS0f7OHWlSopzfkao7+5SAIwiPAZcidFwaLmaS3ldlbt4+YzAQsBVlz1jMc5P+uVR1D37as51vvWS7vX2IerlysP4Mf4Zj8YntsShbdBmuUyvQdXO3ybdsDrqIOHvUdsYDFuJ8IFwJw/IBZGKgUL/pCoR1KM/fTf2Os7d86kXR4OpyueZFGVNaKofN50ezN1zyoDhUWpi6N1zTgvjQhuA+/Hs7QI73uPmuA57D1F0OWFXJPLk0+yIYbBYIQv9A3LZAb15krrSmIs4MMW+z6Q4FrV44m0n+OAUGkgOsq5mdlZSrC1NnbPbFZqvdX9Mqq4mQgIRUg/e7CGibYAbr/yjaDvHZT3+hdG8NbYpdJouErNQoLGsOgHvfKLW+V0fgZ0W1FgP51XgC4qATdvcUJ5Tf5iHEX9+A8Tm5l+/+Tv5HMCR4Blb50dSapuMQCf5lSsgl2JAPsgbIJ8lVp4q8pba48i2w2xV/h4cNtXbl5v6Jk7n7MjmxagxUJR2E4vVuu6uEm3qOSrtrh8RWZlYZrH97gmGbSafC2qkwtQe5fl+aT3K88ek9CjP2xvdPoCw7w7ZsQXVSf316bMp7jS3PvDAxa1HI7Y8yAOqxUBBgStuj85D8qDpMoMMiWGdADKdCLhFoiHQ43fAEsb1rFIa7GFSc269ZWLt1gdoXyu3EM6tNkY/O3RvG4k9KkvftkD3akkHzzw9NmQZHY/HMWXD83gC9Cymw1Man43OTs/P05PZ6Oxix6QDtcKedj8m9ncHfK5/7T+d1ZiStxzPwslbd/g8IG/wUNpdD9uEwl98ejQKfwHCmz4XUWNoX3ZRvvDRtjvif3EUbNj/VL3xIMq44HqR+CwnelcsJHCh1zPkpD2D3B4f73necUOawXs5wXBrJLGkH4rC6hs9B6/iBxQeLtK8YmjRHaHWZaueuroSpR8bwxLpU3ZVOoe7XuyGrPVZ4lslxZz43Xd/DLw9dLiYO5MMAvfaIYv3By/doetPcDQ/IqPxyeTVyw0qtpACHl0P8RF7h2qIoOSjYeegFCsOcp7uyjRsVB5WuQpw2Hb02FIdf+lIt8p7m2SVO8LpbeD3SWRvhLW7juBz++5MU5NhV9+tC9Zmu0g56Hgub1vlDcZfStta3NDs7R+dTcAhQzVfXyDaOYKnGaCepPdkLobVD/t833B/d2hH8YF2sFKoaHqHp8Pvts+jdiBYEwyM2E/khe/zorlJICQp8TqkMaGVDl5lRjVPn3l3Tm2ZX7DfIdq0QcZhW1gBwHTLD/lt4Ib4I/Dt1heHb5md/Xwww79iWXiwM3N7LKp8yKqaQo1h7ajW0D1jjt5GEtuT5L2cs0OAOXxiK9NTQ7R7QYEwGxzly/4JvzdHYQ7uBPTJ89C94ocWZH8jtHeatatcjCttkscVvLzHvkT0yl7WrBWz/iFLZlzZVwMOHOWtPVfPiO1eb429B7VlEy4AtDZnv2Pauhb0MUF8uHM/pjA5HZ3FjNKLeALsLD5/BcN4dA7sFRsCnJ+82mHS7GnYIzaleU7Je27+mGMqjtmKX3s5G7drBBXWyvCidxqmAWNEu0Wsj5o9EzZsdJ6YU2N2NstOx2k8o7MsntDROD4fX4zjk8kQxuwipbPx+Q5OPc4KXWrK6YL8DVTORc0m5Eu+tCy69bdX9uNQiKlBaBdP13mP3XU722u1dpaw+mi0LentosuNSOrNpdhZH9pp9ujdGvbu7RgJHsEOyFeAa0w1CbOwV+/+AXQT6pA0qW3vE2+VwkC7rL1sOdTu1dHObcV4S7F7uF0O2vxNsmUQ/r0uR9I833KLqHs3Y8dlfF9nH02jV6dsOExHZ+ez9Ozk4mQ2puPhKbBTen5Ks3Q2+RPc3N9wZd8/+WNX6Ne279nN0e2vVuz3SMXWNym2P0Gx7cWJHQ+HbHgbo/uCyP6Pf6wwDOzy07/0cBfrEug1UL2M7RXH1mFo83RTtx16+1jegFKc4Si+chHF0YDQdi+AYu00d+ubT/ZmTvXw20+4nl1S7q2fur+bStOoP6O64YaZbe7XnWHT388U3x3yGTf7SBgKGL6GNI2Ob0bH3efCju/XXlBa4TM6WA7g7VylcowGvErRkjuNihkUVq02vN1SyN6aOHqxyyniZ5zYFsIbaX5UNn+4jWaJn9uvMn1CO+bUacPbTLUE4uDhDS4rkUCV3RL1b31aErG9oERoZRa4Kw2nb4Poky2Z+JERHIUtA6wGEdrnXxtL/i5Y1pb93cfItt5XqrW39a5S/Zt/XanVxj2KVP/gnlZqLH3/9aTxcDyJh2fx+GLr60lexUMlQDCa9sU0fEms8+RU662zQYRPA+lfsk+gbngKLRlqTL29HXxsGx4zZCoa2Nj+jcc22nddu9EGeWrfGpLE4nihyTuv/CQUUOEjZ0ymFUYZdoH+zb85QF12yr9M9jaMSn7Fe+E+BeFOelAJ/Nf/aGTeviQltSmoaNH54s+gmgf6Xuj+w2WdSbR8/P/rp/6c/hm4M8dlTrlVVGty7r05/BbdYB65axCjQTRdf1TuOzbTBvvc32Ow90XlqxX+/HsFGO99+45mWNkKL2s1GbeRGWs9vrRljX4KocFL8sD7dBunFG5oimXLE0T+uuiG9/Fc7bd7ffAwoH/qNwW3cNdxcfM7jjWzGy/9xjEr/tyJINYj7aYHOo3S7Gzbducfv3yOBtHMB/OFtBGOord4dZ/eupUPCc/pvfvtPsqpmFdu5+FIoqmhXUdVOyb/P63Ivytb9/euxWd5DWK1qkXN4N92l7L6F4koakk= +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"; + + + + + + + + + + +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:write` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/put-v-1-jobs-job-id.ParamsDetails.json b/docs/api/put-v-1-jobs-job-id.ParamsDetails.json new file mode 100644 index 000000000..ca3a5814e --- /dev/null +++ b/docs/api/put-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/put-v-1-jobs-job-id.RequestSchema.json b/docs/api/put-v-1-jobs-job-id.RequestSchema.json new file mode 100644 index 000000000..d515ce245 --- /dev/null +++ b/docs/api/put-v-1-jobs-job-id.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"required":true,"content":{"application/json":{"schema":{"description":"","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."},"title":{"type":"string","description":"The job title"},"hire_date":{"type":"string","description":"The date when the employee was hired or rehired for the job."},"two_percent_shareholder":{"type":"boolean","description":"Whether the employee owns at least 2% of the company."},"state_wc_covered":{"type":["boolean","null"],"description":"Whether this job is eligible for workers' compensation coverage in the state of Washington (WA)."},"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."}},"required":["version"]},"examples":{"Example":{"value":{"version":"gr78930htutrz444kuytr3s5hgxykuveb523fwl8sir","title":"Regional Manager","hire_date":"2020-12-21"}}}}},"description":"Update a job."}} \ No newline at end of file diff --git a/docs/api/put-v-1-jobs-job-id.StatusCodes.json b/docs/api/put-v-1-jobs-job-id.StatusCodes.json new file mode 100644 index 000000000..2777628e6 --- /dev/null +++ b/docs/api/put-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"},"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/put-v-1-jobs-job-id.api.mdx b/docs/api/put-v-1-jobs-job-id.api.mdx new file mode 100644 index 000000000..48d07753a --- /dev/null +++ b/docs/api/put-v-1-jobs-job-id.api.mdx @@ -0,0 +1,71 @@ +--- +id: put-v-1-jobs-job-id +title: "Update a job" +description: "Update a job." +sidebar_label: "Update a job" +hide_title: true +hide_table_of_contents: true +api: eJztXXuP27aW/ypcLRaTANaM/Lbnr83NY28WmzZo0u1epIFDiUc2G5l0SWombjDffXH4kGRZ9tiTyeJu0QJtE4k6/PGQPG/SX6Mv8bLURsZcGFgqargUsdluILr+EME6BcaARb2IbjbNJjr62IsU6I0UGnR0/TUaJAn+j4HOFN9gm+g6evmFrjcFkNAy6kWZFAaEwbZ0syl4Zuld/abxg6+Rzlawpvgnw00B0XX0nzKNepGDFMn0N8hM1Is2Sm5AGe46L0vO7DeulTaKi2XUa6F5vwLy88+vXxCZE7MC8ptMLyMcBmU/imIbXRtVwl0vugGluYNzP8GsVAqEIf6jQNsBvSTvAOzfP/j3XCzJsuQMPj5ZGbPR11dXTGb60k7CZSbXV4Hp8YZulSwK+/6KM1hvpAGRbZ+SXCrCRS7V2jKPSEFW8pYYSUqN3XFNcg4Fu4zuehGsN4XcAiwexqTwOVK/XfFsFVhHUiikWOpOFq64ggWjBro6rFvntNDQhQA/JbcrELsYbqkmSJoRqYgC90fkRjWdd72wcEK/H+qORVkUbuHuAchpWZjoGlt04bE093raKL6matsYYyplAVTscfWXFZgVKDc3XO+M6kITT8gSJtjfDS1KILe8KEgKRINB9iNvSSkK0JpQQeAL1wbXE06G/YuuEAbanZOjDszL4cWdyfUGhHarDT+/bwtt6HYNwixKwc3Rqdjv039K8NPQTSeOndnowOA/WjQ/euAm6Oz/HhaYW7nYgMoQgl5RBStZMFBnLZbG0pe3QhNqSAFUGzL4twqaXG+o2F7u76u7XqQNNbC4zRaZvAEFrDkVde/dc7GzZHGJcU2g4Eue+p1wK9VnUPpilyu2J7oEwt3etRAQ7C9Ur7hYGinIk1+ePb0PcEG1XmSSHd/J+9OmuP5M7NcEvz6ClIsmJtvzJXmL/AVywzU35EP7/YUmPyH955b+hi4bYvz29vayEPzyll4u5c0VF7pUVGRwhftFx4grtrhAXzX/EudSxR5h3ATYaBUXUn4uN/969RTlQAFUCbKWCrqZ2CSiG+uNKkW3US/iBtbN55VS7eAmbBRoEKZa8m0W/odVXI+kkQ8S/5Pr6N9k+kDJhBtzRzPvsPCYiv4udsHJvR/SQafYBrIoqCJ0LUthyIZyRjagdvSG086dOuisrqwOopmXsbgu9gaprNh43WIKtxpa3gpQPacw9UqWBUNtfvGWbrMVZJ8vkDMgyjWKtr/LUkW96BeAz1EveiOFWUW96B9A8Wn4Ivp414vyQtMFiqNSdw0rEHz5BdYb3NXvaEEVB0Z+kALCw+aff0SYUS96Ltdrru0OQb6QikL7Rf1xpwh+9V/vnhEH0CtprneYdkkqTE8uXC8XTyvmaUIVuHmlJOdfgBGNzbcEbkBtcaJxwrlkDTq33KwIqh7D10CeXOwP+kE99AgVjCjIgN9ATR8bWOvUuzBpAZcEZ7DYkicX93QZ7JaVLJW1BLdWQZ3TVT0hwBpdPLnonkLEgSrjli5Bk5RqNKDxtdXX4YsW2TZHDy6CbuoNwueMzK5FHIn9w8VTy7Z6hGZFDW6r2hIytyCMnS60tNpWEYkqfyB6VWgav7PLMn6PmwaFYJ5DZvjNNzkrFRHnthxY8q/8tOdc6V1LsueaeydEW1PfifYL5+5Yul2+zTFhbTVDw21pA0JylP1WarPIpVqsueDrcr3AWTzBRn0tGLruoAnvUN1ZkHWuA2A4Jt+DXSeElQiceP1JMlpkZeGBdaiLJrouk+aEWWp2rwnVWmacmrDQ20O4PGYnPYap04Rj56LF+CNkLAOd+rs8bRHfu2a7QeE/yNvfS26dhw9urB970ZcYXGjHckCXWQZaN5SS40nE0hEb9WEcz/rDLB5NpxCnOYV4OGN0QGEMUzqMGsZcNJ6wJMn601maTYfzYTqgg2QCbEJnE5pn6Shq2kpR1s9ZOupP42w4ovFoSKfxfJAP4zFMskGS9dmU4hctSyeiU5jl8zSLE9YfxCMYT+J0OpvHSX8wHI0n09k86UfBRImmSZIkl0kStS2KoJx39HGtdtuzEg2SwTBO+rElfnDn+fXbWvAfPtZy7J3MzS2KxZdiyQWAwjWwsspnx9dtzAOM8wmdprM4m7MkxmHG+CjGZ/gIn+zMw3yWTukkG7MRDPMB7adJNmczmOYTOk5H2XB3HtgAxvmM9uN0lE3jEZsnMR3CJM7n6SAbsxn0O+chneVzmqRZ3IfBMB7lk2mczeYOn5+GQT0Pg3HnJHi7aXcSmtbNd5uHZ0GERC0BtQhSrzEDdMTmKZ1n8XCQZfEoy/oxHadZPIF8lLHJeAhTujMDWTaep2w4m87ZZDzO0/koof18kk6m43xA2bw1A7N8lqcwjUfzCYtH6WQezyZ5gpxl/XQ6pMlsUrPy8TjZn8X9Qdw/ykkU4fuMrNcmA6BjmseQsUk8SvtZnI4ZxOMszwdsmAymw1kUxGM0vRyM74Fy9/Gu1pRou9Y74q5DtRQyOx4awlgDGifH/ISSs7ZjdKGtWUcCfSuqw1/2Q+Xd3jYVhDKmMOLXdIfbCikM9r8C+fsldKYAtd+CGrclxnEyiZP5+/7wejS8Hs0vkySJk+m1XSnlhh1pPE52GnvbKyzNfjKeD+mExuNknMYjSidxmg/7cX/MMpYBsBR2dQD0U8ZmozEdzYfZdDRPZvkM+mM26fdH/ckcswGe9CTtD8d9OogZDMfxaDSfx+l8NENNkNJ0MB1NrFjTRgGYRT+6joZJQoaKkXf2Uf1ugPt5Q5WxLuSwjysu42aL4pYK8gojOVxnMvIhKlxYz6Je9AffoLQc9ZOpHXkpDMaDo5/f4Vtql2jYAZuVFLAQ5TrFKGA0S5L5cJIMZzj6nBdcLBd+rqs9Qzse3909jgESlmIIg/z5oyy7C/NkfgV/zX++G/CouBiCHc454iIrSgYsWMftZkiEdsduQwR9Z7U8yC+xJIgjUY2iEkfkJ2/X2VdhcOE1DsTSooV9X0U26gbRXXNr3YvwrrnZTk/O3IWNeFoHp3lxd37nntKw2tQnzYHPI1kBcNexg+91rN5tIOM5rx2raun4tJGfqQtNPPGgIR629O72hU9bNZ0BKX8ERL02i3ASGtrqvo37ghqwAQYb+scAQxOvp4REm1rt24h6Stal9jL/3ol+75MjpW5L5EvyWjgy9W4jK3oDJAUQhEEBBliPpKUha7ol2mCe0DZYcW2k4hkt0K+jXW7uulPccPH/Enine4pPTzKuXFprJ82wR6sXNe0oX9CAf7Qp2qavO2H9ZDiGeEYH/XgEfRbP5mwc53Q2H+Vzmufz6Y6dwxKY9uf94TSfzTM6ZGw4HDE2yrLBaJbnadrhMc1HM0ZphhbOeByPIIN4DgMaDwbz2XxGsywdoMd0JPMZAZ2lSYpeVh+d33zO4jSdD+M0TwbzNJuNh9YR6XZ1q4S3s08qTyizQpK84AoyI1XUlXmMXG79QI6vettKXjX8hNOAN3zY+Sidjsf9PuszSGk2ZlMYMAYU+sPJdJ6f69A33a3T5rrL9US/Mx4kjfjCrIovnO2M3n3sItMovsAeE9/jnY/njJLRvoz/QRrySpaCkV8FIb8Kt2N+L8FG7xRoWaoMcy+giZDG1Rtckjf0MxBdKmfabZS84Sjord3ENZYxcHb5qxXho8Fgv9ufxUZJ9EzQwSIvheFmWyHg2kqJFd1sQNTVIKlkW9y+W1mqgJFgWRHlQhNQSipNdJmtCNXkExcWxIIao3haGljYjfupR7xBFCjklBeasNJmtKiov0RT2y7HTw0j9qXr5jk1sJSKgz7TirUw46z6/Kmzha16wcwuYWAQEDLvjKKp+7n7F3PbzG07000l4AaMZumuy+Wfn5Fb36O6+Az4gUe5PdCHbXWvdVJbaLcr8JvRfk5klpVKX5L32w0q12LrnKLPsCWcgTDuK2xfzeHVhiq6BgO4AArqo/cVSedKBdRnQEMK2BaXl6NkS50CqSA9/CojSyXLDUfzELNHGUVzEb06iyYtecFIhutg7duvqGDW+OTCrd5GuaJN0FYdcU0+CSvYFm4eP/UanqqruvJLnlDiWpJPvinxk7R1dgk4keVeWtascb+dEsp/G8brVyOhqSxNY+5isgQBqp41TzowQ5cqp5ljCNaDCYb8UR6FoWhI3V/m8TxsbgUF3FBhnAFmZFggW7+TvQrggtg9jUbUXvoOk1zeXurtkLD4LKs+uf8vENUnO7fhCSrXT1XRW1AmaJdJAT/m1hg4PpZ1WRiOBaeWIu6j1sYLj/c3W3jz4HIZzcUy9Ly1ypxx50C/bfTkQ0H7fTuG3L9qfqDrKl3jOWqTovWyyaRy9bYMPSuXIaoZfH8PPwv+ewm1eKhjB46Mpeikd67k+ogzX7UrNwsjjzfckXNdDVq+/X6TRtD3jV/98S/crOIfBcRO+UV3h1u98WvHNcWpuev9Ned/hjm3Ttwhhd0qekThY0sjrIGLEYsjauOSvDb4eCO1tmWRRjpvtpJDBdxAYf1kr0aCoqjESpRxhalv9cTBja3xE/9oF9zTqDnCjgZuQe/G+lMqPi+oc8kWzudelCIvBQO28B7PjhHzYcfWiLCCo2mYXEd7xlrUUHPRq1IwLpZvwKwkIyuqSeiNVL3ZOdgBdgOK59sFF3bpZoh0IzV/VGT/QDMAeyW+V9Sc6L2kQGz/HFhV8mkLrJyRgharh+Pz7KjaDw2BFhiU2C4Cxe86AGSv79AFVapxdAC09TdiuVCyxELxI8B8ixBv7oTYMvJ3gP7kvg/BZq5JULseV/C0MylyvtQVtMrWPItr+183wTwLtUEY/q6N2XWpTdOw6AYWRptTbcJuWRR87WoIDyDsaHw2C18h4lDEaGk0agap52yFeeHq02q8IFhV/nEAZdWkE1s3L18K5ipE6p1jPSizooIMyRrrFG1uMi9NqcDhC4kWLlipjdouNBQYCJFiISjPXMxnURtmBxHXrc/n5w/4rasB31+OpyH03Xx/gGFpwu8lLVCLTAjjS16JnSNwdQCgT4Creebano/2Hc8sVr0PduTBOqwYJV/IPF9sZMGz7ULQ9YlzvX4QE9dd89sGUQq7o4BV+4VmmSppsVDH98xOszMk9zP3nav9DRxLCxTlaFlVeIgFyEEfAL4Bq1wXPpByTDu2Pj0H7XO3uRnY6D1CdjScj+sxEJv/kHkeojqHMFflmqdMe9X4/Ll/uVNbe/IKSGmB5zIWLmnzIG19DNVzKmyE1AVzie9NH5/2lSw4Q6mO/zrAwaxwJ7se0ah47lO9wYywJgXxCFzts0VwGJqQ5vvBqkLM1pLuAtYjG2+y2VweqvmDUCv1WC2z77IUX7s2dZoc3S7diGFYfFKkkio0w0O7x+Rf2MNo8JOqqwqSg7A3mEdE8N7GHt3RB+eW+jNgIQqMweWWRnNmxQIExo/QCDOKYgppIW2S7yC2dsvzt2lFwPl7tX3jsLiyiOqMpcNbb9iA/3vasa0xdqg5baiydjvNDSjr659iBex/dT7/3lZ29UUHvYt6G9ehCZfn9xvlBmz18kebwXWhxVPx77T/JuQ7lO7FHFrXLg2mHBZLJbXGcEfoXIB1Bo7ZOr7F+eYOWB+hsiiCX9CCZK0WnBF7xuQElj5M1f3dnmCpd46AJcV0ZwuN3+MZ6sHiEeXN2+rwQADguqi2R67kHyAWHsejSjqM+vju91xyn3TD2MJro104vcboa0UwQ0YLA+oA2oWnctxv/ybgXJMU7CmMADikWlpQbagRa334OsxtKdaS8ZxbsR0gh2jmY4INGaPN3mQ7AI6TOyx3glKDuvFSXG+1gXXVKMjwtm1gpYBeuGrCE+wE1/5bBNAupXpXC2LDkx7nmn6xaf8WTl2qDZ4gPsW6fijUl1+wQhcY8RhwJvpJYrnqziQf4+V3BBYMruAD2JKDJ9oeK2/mvuq8zodW0L1yH6JWrDz0H+Nf8TCCrShvCrS0kNlnUJXyt0E3LEM9a/G3qHUaw3ZFeEN4Jw7IBZGK4fF8SVQpwvZoD9/1vY/z+HiqydFgys33GRRlzZOLDxpOC+bxMeXAMJW6MPTL9xwW2oXWAPf9EUO/ENvfw8a4D/uEpehiwvVJg0cd5s4yDBIrRKG/YV3ugO4epC41xiLODLGfMiiORS2eeFMJ3juEGpKDrMvUn3rdm5oqZnfMNN/7/CGhuooICURI1XntQ0SHANda+VvR7qTLWvwLvXlpbEPoNFstzEqBxrtSFuCVT9TI37UR2GFBhfV8XgW+4BKwYZsbyu1xH7uCQcviBoiNzT97/nfyPoAjQTM28kdSahuMsLed4LHd16JH3sgbIO8lFtcp8oLadGRTYTaOWJxtNlXuSyDSyh3ZuBg1BgsYbQBPepOO0Lqeo9S2YlsQWZpY5rF97wkGN5MvBTVSYWiP8uK0sB7lxUNCepQXTUe3DSD43SE6tqJ6Ub19/GiKy+ZWCQ+c3Ko3YsuDqpPmfhkoWOOM29R5CB7Un6SQIzGsE0CmEwG3SDQYengVwYJxnZZKg00m1XnrAwNrtj5j9zViC1URbJf1c2TvHSKxi0FiPWsp2A53XzRA211nmzgufOfhsYTldDAYxJQls3gEdBrTZELjaX86mc2yYdqfzo8MOlBb22z3Q2x/l+Bz31f600mNa19BTV645HOPPMek9GXU5kpA4YuUH4zCl/F70ecsajTtN7soL7y17VL8F5dBhtWTeyxYY2N/p6yKAzXHeOlba41EORdcrxY+yonaFQsJnOn1HWLSnkHOxzcSd7YhdeetmGB1otSSvs8Kq45QnT2Lb3Dx+MM1hBJHKJy92VszmStR+rY+LJE2ZVelc77qtTeDcR2ixLdKiiXx3ne7Dzyudf4ydyIZBPraIYr3B9+4pOsTuFxeEnvY/GnHFmuevzu/5+bRu7DJ+8lOohQrDgqeHYs0dG4eVroKcDiUemxsHX90RjfKe+tglUvhtBz4UwLZnbCO1xG8bx4PqGsy7Oy7ecHabGcphz1eyNtGeYPxpwAPFjfUvv2DownYZajmay+IZozgcTqoBuk1mbNh9f063zc8XR3aXryhHaQUbjR9RNPhe/vNgzwQrAkG5u+xvPDfXNQnCYTEK3vW3JjQSgetklLNs+/snVNb5hfkd7A2rZFxngsrAJhu6CHvBnbYH4Fv4Z6XA6Ozr89m+C9YFh7kzNKmRZU3WVVdqJFUimoP3XeM0VtL4nCQvBVzdggwhk9sZXpmiC43G6kMYdY4KrbtDL8XR2EMLgP66HHoVvFDA7I/19jKZh0rF8MroBYPK3h5Za+PEq2ylz1pxax+yBcpV/YiuTN7eeEvBbKfV66x16C2bMIZgBCuOTnZR3iYEe+N9+mAwmjSn8aM0nk8AjaNZ2NI4v4M2JglALPh+IhIs9mwBzilRUHJK27+WGIojtmKX3uRm705zt3GJJi/z61eFnhrr3QuYpVq9kzocHQemVMDNk3zySCLU5rm8Yj2B/FsMB/Ew1ECAzbPaDqYHeHUw6TQa005XZG/gSq4qNjkriayLLr1p1dO49DH1l2mlQi9p2brcK3W0RJWb402V3qz6LITSfuOyXu8Rtvswd6avY1y12O0lw72CN4aiaEmYVb26J09yLqPOgRNKtn7yK5Sdf/bEWkvGwp196aendOKcWex++5h7L8FQ6E6iv3/1mK460U/NfTGfQP6kyiQu170Q6VB7hvzX6rkL1XyDaoknH6vpNdrHNumNPFNP/5Nphr/s7C+XetoVIiY40Xvv4pfhc7kBq7JJ/zo+lZxA5/sVQLep3UcaPyOxc7BKzSacNteR1V3XFiBZHdZHVl3h8buvfzZ7ltP8X9ie5FF/Ozt6/i/q4yAJb8CyqyYqzvovDboBY5gzYU/rosjj92Nrs/evq5udmpfzmGP22IDPGFsz9oKVE+8LoDsuTaNw+sXmnwI1002aJ950ptueFzfJ/WvnmDcePzU3s+i3TnSQ7NS35ocLjfrj93dxuE+n8bzO3vrgvMC/iaZDUq05+2BB/bv/aGTf8YLuRr8d6Tjgm5BnXk510Nuto3u+6WRR/5hkf/jX3T4Z/8Bh79+r+H832to31gUNvQpFw3VV9ss1XQ2HyYrUxr1x2g0+lxujRrq8Wr5Zfu5vIF0PBjmt8VMc9W4HfInWLoL3d5QQZdWHexdFdMfxIN+uPn3iCK0+4EuUdnhLzS5Sxqe79zdY68J1hugn4HqbYxKKsa1pbi98Mcfv9htZC99cMpRPxNslyByyIDQ1c1AzsA4+AtWvcC6e37JClVoIHUIb0Ur4O7+yOGvG3eOA/WHzx9aC8RaD2YVXUdXN/0r/OTqq7MO7lBnYR2jtypKVaAy9yuYbrgTzjGDtZXQ+9eWwVq2WOzoxS4Ziq9xJAcId9J8q2zi8xDNDb7GIWrISmWD9h++Bqfqmb2G9FmJo3XXF4VW71AlurXf0baSsAgxKHIrcYEqu5Lbl1pYErE9f01oaVYYdA/FRb3ona0I/ZYeHIUDHeBPemgpfqqNhOZ+rrZxJR7DDq0eNPdl3eqQ/nE2x76uaD9v3rdV26OhcDGAsEYk2mQ7t2k1DKBehEai/jF/B+qGZ9BYObWtYC8zubINrxgyCc2Y2P4dq0y0/3RPaUGRybUtvrE4LjR56fcuCfXeaC4ymZXrcJnbv/grkqhLpnlz+EXolfwERS1CbGEKLn3/9t/rlW6vVpXarKlo0GnKvTber7Wld6qj4JeZgS/malNQbtej3X9fvRj4EN303X1jCPjaOwof8XyTNvj661e0yX9Wxd0dPv69BPSr8G7qG6q4u6v4w1esnbAnWbpt/Sb0J+Eu0Keky8c4ADrcpCC2DYkX+Wsdgn/jDmY59+M8UH9yX6STpY513Y5cxeFa9Tx3zHI/Z1G32HM56i9Q5Nnb7A63bWqntz+/j3pR6r2ctRMdit7a6+tu3XSHbCS6Qfjsa1RQsSydH+9I4j//C9MFmZM= +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"; + + + + + + + + + + +Update a job. + +scope: `jobs:write` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/put-v-1-locations-location-id.ParamsDetails.json b/docs/api/put-v-1-locations-location-id.ParamsDetails.json new file mode 100644 index 000000000..40eaa1cf5 --- /dev/null +++ b/docs/api/put-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/put-v-1-locations-location-id.RequestSchema.json b/docs/api/put-v-1-locations-location-id.RequestSchema.json new file mode 100644 index 000000000..5c6597a34 --- /dev/null +++ b/docs/api/put-v-1-locations-location-id.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"allOf":[{"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"},{"type":"object","properties":{"phone_number":{"type":"string","pattern":"[0-9]{10}","example":"8009360383"},"street_1":{"type":"string","example":"300 3rd Street"},"street_2":{"type":["string","null"],"example":"Apartment 318"},"city":{"type":"string","example":"San Francisco"},"state":{"type":"string"},"zip":{"type":"string","example":"94107"},"country":{"type":"string"},"mailing_address":{"type":"boolean","description":"For a company location, specify if this location is the company's mailing address. A company has a single mailing address, so this designation will override any previous selection."},"filing_address":{"type":"boolean","description":"For a company location, specify if this location is the company's filing address. A company has a single filing address, so this designation will override any previous selection."}}}]}}},"required":true}} \ No newline at end of file diff --git a/docs/api/put-v-1-locations-location-id.StatusCodes.json b/docs/api/put-v-1-locations-location-id.StatusCodes.json new file mode 100644 index 000000000..f2c3992b1 --- /dev/null +++ b/docs/api/put-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"}}}},"409":{"description":"Invalid version param","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"}}}},"422":{"description":"Invalid 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"}}}}}} \ No newline at end of file diff --git a/docs/api/put-v-1-locations-location-id.api.mdx b/docs/api/put-v-1-locations-location-id.api.mdx new file mode 100644 index 000000000..991c541b6 --- /dev/null +++ b/docs/api/put-v-1-locations-location-id.api.mdx @@ -0,0 +1,71 @@ +--- +id: put-v-1-locations-location-id +title: "Update a location" +description: "Update a location." +sidebar_label: "Update a location" +hide_title: true +hide_table_of_contents: true +api: eJztXVtz2ziW/itYzkM6VaKsm296Wk8uM66adFKdpHumnJQMEUcSOiTABkA7apf/+9bBhaSoiyXHrt2u5UNX2iRw8OEA5woc8S6SOShquBSXLBpHeWHim36cysQ+0+X/TTiLOhEDnSie44NoHH3OGTVAKAmNul/EF6ETmcOYXCcyy6ngoMe3ihu4jjqRoXMdja+ifwXy0ddO9D2eF9rImAsDcwclNsscsCFkU2AMcGia5/UmtquGpFDcLKPx1V30yo63vEgS0PqiMItofPX1/msnyqmiGRhQ2rYTNINoHP07/ocd9uLDZfwrKI1T6kQc57UAykBFnUgnC8hoNL6LHKBIG8XFPOpEIIoMAQ56g+O4dxL3jxEPgxktUhON68/vm2x7jVgyLkATswCCPIynVAMjFx8uyY3DQqjWMuHUACO33CzIUhbKNkhomnbJ5YwIKYBwTXIlbzgD1nFtaJ6n3PH3hSZXGRc8K7I67a8/LYzJ9fjoiMlEdy37u4nMjgK745wulUxT+/6I5jz2PbmY/80TjGuPXyKMQgPrRvedksOrW8dyNqdmsbaNPi2AfP58+ZrImWVI6Bd1IgV/FFwBi8ZGFbB9Qe7vaxtJ6Vs6Dz0U6FwKDRo7DXo9/Gd1eF3YHTMr0qgTJVIYEAZb1fh49LvGpne18denoCBXoEEY2wUnQwWhjCnQmnBB7HbrohQ46HL6OyQG/+YmxQf/qub9PYbvNMtTB9sjnGhDTWGfJApwZ0xofa/1zj/1h+PRcDw67/Z6vbh3Ou71ok5UWDHd1vi4t9LYSe1yUhQc9UG/d3w+pCc0Pu4dT+MRpSfxdDbsx/1jlrAEgE1hGHUivw+icQT9KWNno2M6Oh8mp6Pz3tnsDPrH7KTfH/VPzqeIx5E+mfaHx306iBkMj+PR6Pw8np6PzuLRkE7pdHA6OhmOUAaNAjCTfjSOhr0eGSpGPtpH1btBNI4ucqpMBsKQYf8M52HVQvSRCvJWUZFwnUjbgxrk9auLqBP9yfNoHJ2P+r1TO/NCGIWdPn/EtzQx/AbCPsoXUsBEFNkUVDSOznq98+FJb3iGs5/xlIv5xK916JHRDY/v7ztRrlDnGu4W13FjXcPsJyPE7aKulRXK3ot06QeqLco+xJNCKeReUD9+HE+efASwf19VioDMC87gQF3CGWS5NCCS5Usyk4pwMZMq83MRZCFviZGoS4hZcE1mHFKrVRobc29+4RgI3HdH4rcLnixWuTiFVIq57hJkIOEiSQsGjPDZxmZIhAaKG1m/ulvWwVYdZjTVsAm9JUEciXIWpaElv3jNaF+FyZVmu0veW1o0te8hy1O5BKg1QJZWovUgwvu6sIXWV1VzUaQpWsD1bk4Q9xvAyuY+Ta3k7tOwFOq91iBYb1QA9xskuCQylTIFKta23cccEj7joNe2Dtf1bfhCE088WIjHbb37deXTNE0HQJo9AaJOk0W4CDVr9ZDgvqYGDM/A7tvbBYgVvJ4SEq1btR8j6ikh0aDzH1xolFBnjpsauUsuhSNTSRtZ0BsgUwBBGKRg0FebFoZkdEm04WnqGiy4NlLxhKboFNI1F9AsINuobrj4SwK/rzt4V84Sfr2/x+ej3mh9K/8sDXkrC8Ee76iVJMgXQcgX4Ry3PwrQCFaBloVKgDAJmghpCHzn2nTJO/oNiC6UM4LB4SaXr4+skeGa3NCUs03eXX2GoJRUNnJZ9QH882r1qFJ0iU6zgaz+fDvVyTfADgk1MJdquWUM2+pBcalUxu0C/JxtdyKTpFC6Sz4tc1ztdOms9DdYEs5AGNcL21NjFJ8WBo7K8IsoSO2eMLIi6Wx7QH0ANKSAbXEbO0rE+jGeVFgk7ZHPlSxyjvqKCkYSivrLhiyIZlrwlJEEfZfMt19Qwaw25MKFVbXY02LOQGs632ivViF/CEAYGMpTTehUFqbG1JjMQYCq2OlJB5S6UDOaOKRUEBAMgSPnnKysBgtCmsnMCkltY12trH/kd3x9v4xrHWuTi7YIyC118mE7dKP7rwgkBDI/SxNbIYvf4KDxe7drg2Sfr4vlpbDyU3qfds88Xso/i1xJDJnoNAXyRhhulkHekb90SRY0z0E4Y4BLMZVsiVvJrrWfMMHhKRd+D2mii2RBqCbX3OGdlLt8ckPTAq47xDtqgcLMrjgrwC9e2bNMu1zXnOs3bphXblE46AO9awszTsruL52Pbs1eJhWELdj9IlpN9f9CU2GeqByIa3ItrCBP3Dped2pBHrlFe+63PKHEtSTXvinxi7R0Jh2sUHnB+D+jEBGFoeiDbNqKqzBeBeFWkMINFcb5LkaGDbL0kuxVHhfEyjTqJ6s2vEaaptAlbzHKclq4s0LC4rOsunb/ThDVtV3b8AQdn2vH/mnlXaAzIQW8n1n1vXsuWZEanqfgxkI5agheeLwubOHNASLdyJ9xMQ8jYzfKGHex54faSD6Lsj62Y8jDu+ZnmkFwWT1HzYLWt00ilcv2MQxK7G6oMfjhET4L/kcBlXqowm5HxlJ02numZLYjDi7bFfnEyN0NV/TcpgaNsHi9Sc3yvvO7P/6Nm0X8XkDsjF90v73VO793XFNcGszhtmv+119zpLTVYK/y4TdUPhLjfRvxYLC/w2x0yaWxJw9Sa44ulpEuECz1UAo3kNoQ05uRYChKtRIlXCVFStVPDu6Kr/gyqs9wQ4Nog+c7peLbhCY25TNx4eqkELNCMGCTnC4xO6x3eMV4BrPqEq85ayuu8dtCMC7m78AsJCMLqkkYjZSj2TVYAXYDis+WEy7s1k0QaS41f1Jk/0E3AEclflS0nOiuT4HY8TmwLvmQAtVAkgUk35yTgh6rh0Nohh11d/sUaIrx/HISKD7rBJC9fkCXjyjnsQFgxjVqqImShUGx2REJuRYhVbsRYsPJXwH6i+sf8rRck2B2PS6/EyaJFDM+1yW00tc8iGvrvetgLgzBJTUEM8eVM5sV2tQdi83AwmxnVJsgLZOUZ9zsQLih8cEsfIuIPQ1iaRC9kEXKEDP1nC0xT3JQXLIKLwg2YV5bbkFZNtmIbTMv3whmT2ZrkmMjKLOgggxJJoVZ2GO9WWEKBQ5fOKPgghXaqOVEQwqJPQMVlCd6kkgGk8ox24q4an04P3/GvgT7btiO+yH0wzw/wLA14Y+CpmhFTgjjc16qnR1wdQCg94CreeLaHo72I08sVr0OduTBOqyYYJ7I2WySy5Qnywmegu+31tmjmJhtWt8miEJYiQJWygtNElXQdKJ2y8xKswM094XrR7BfybFpiqocPasSD7EAOegtwHOwxnXiEym7rGOj6yFoXznhZmAT3wjZ0XAxrsdA7NGBnM1CVmcb5nDMpvdZ9rLx4Wv/JnQlVMH+O2BKUyoSmLjzjkdZ612oXlFhU4KU/W6X3Y2mdy/7QqacoVbH/xzg4FZYR/QpvSJ/Qah0I6xLQTwCtEB+8bdDwxTps8EqzxysJ70JWIfk3mWzx2Bo5rdCLc1juc2eZSuGxG15woxhl67lMCw+KaaSKnTDQ7un5F+QYXT4STlUCclBWJvMEyL4ZHOPXNtkjw1LuVjJAmNyuWHRnFsxAYH5I3TCjKKJkWoi7fnYVmzNloeLaUnAxXuVf+OwuBsFdpej7itv8TXwP6cf25jjBjOnDVXWb6czA8rG+vt4Aeu9Duffh9KvfrGB3otKjKvUhDsi94JyA8L4WYTU4r74V9r/EPIVSg9iDq2rkAaPHCZzJbXGdEcYXIANBnb5Or7F4e4O2Bih9ChCXNCAZL0WXJGFLNQ+juHjTN0/kXpNcgTMKR6cN9B4GU/QDqZPqG8+OPo1AG6IUjxmSv4JYuJxPKmmw6yPH34tJPeHbphbuDTapdMrjP6aBZ6Q0dSA2oJ24qnsjtt/CDjXZAqo3ErA4ailAdWmGvGaDM/C2hYik4zPuFXbAXLIZj4l2HBilK8ttgPgOLnCcqcoNagbr8X1UhvIykZBhzd9A6sF9MRdxNvDT3Dtf0QBrVKqpFoQm570ODP6HW8aN3HqQuUU5/yMUN98x8utwIjHgCvR7/UsV1MpvxX5Ll4+I7DgcIUYwN5y/Em/7EarZ1/Vuc5VI+lehg9RI1cexo/xz7g/GNpj/bpCm6Yy+QaqNP426YY3OA/a/A1qG51huyO8I7ySB+SCSMVAoX1ShQji0Zy+G3sd5+75lIujwRT580yKsso11Y+bTgPm7jnNgOFR6sTQ7885LfQLrQPuxyOGfid2vMfNcR32HlvR5YT9LfqnnubKNgwaK2Shf2BfroDePEldaMxFHJhi32dSHC+1eOJ1I/jgFCpIDrIupnZWUqwtTZmz2+War3V/TKquJEICEVIOXsUQ0TbAlVX+UbQrx2UN/oXRvDa2KXSaLCZmoUAvZMom4I1PVDu/ayKw04IS6+G8CnzBLWDTNjeUp9Qf5qHHn94Asbn5i1f/JJ8COBIsY+38SEptkxFoJH/jCsil6JB38gbIJ4m3LRV5Te1xZN1g1qoTDnabyvDlpizcWjk7snkxagxkuQ1isaIg1KqV9zkKbS87CyILE8tZbN97giHM5HNBjVSY2qM83S+tR3n6mJQe5Wk90G0CCHF3yI4tqJ6Ub58+m+JOc8sDD1zccjRirweFG99hGyjIcMXt0XlIHlRdpjBDYnhPAJlOBNwi0eDo8e/AJozraaE02MOk6tx6y8TqrQ+QvlpuIZxbbfR+dsjeNhJ73KZ8XQPduD/ZeebpsR6b0cFgEFPWO4tHQE9j2juh8Wn/9OTsLBlO+6fnOyYdqGX2tPsxvr874HP9S/vptMaYvOZ4Fk5eu8PnDnmFh9KumnATCl8J92gU/ga8V33Oo0bXPl9F+cJ72+6I/0U36LD/rTu2WO0huF5MfJYTrSteJHCu1zPkpD2DXIxvJEq2IdXgjZxgWfBpST/khZXVRwev4jvcPL4uhVDiCIWylbU9k7grSj82hiXSpOxu6RxuerEbstZniW+VFHPio+/mGFjpdPg2dyoZBMbaIYv3J8/doetP0J13SX8wHB2/3CBi9dK1w0euV60FIe/3Vg5K8cZBypNdmYaNwsMKdwMcth091kTHV53o2vXeKlnljnAaAfw+ieyNsHbfI/hUrxep7mTY1XfrgneznaccZDyVt7XrDcYX0G293FDF9o/OJuCQ4TZfc0PUcwRPM0A5SW/JnA+rH7b5vuH+5tCO4h3toKVQ0PQOS4fvbZ9HRSB4JxgYsa/IC9/nRVVJICTJsfrfmNBKB6sypZonzxydU3vNL+jv4G1aJ+OwEFYAMF2zQz4M3OB/BL7d+svhW2ZnXx/M8N/wWnjQM3N7LKq8y6qqixq90lCtoXvGHL31JLYnyRs5Z4cAc/jE3kxPDNFFnktlCLPOUbpsnvB7dRTm4E5AnzwP3bj8UIPsSwIbp1m7rotxpc3kcRde3mJfIhrXXta0FbP2YTaZcmV/auLAUV7bc/UZsd3L0NhbUHttwjmAVufsd0xb3gV9jBPvnffTAYXRSf80ZpSexyNgp/HZMfTi/hmwY9YDOBse71Bp9jTsEUFpmlLylps/55iKY/bGL0VljuEaQYG1e3jROA3TgD6iDRHLo2bPhA2BzhNzasBOp7OTQRJP6XQWj2h/EJ8NzgfxcNSDATtP6HRwtoNTj9NCl5pyuiB/B5VyUbIJ+ZIuLYtuffXKfhwKPjUI7X9AJeQ9dt/b2X5Xa+cVVu+N1nd6/dLlRiRlcCl23g9dafboaA17NyJGgkewHfIbwDdMNQmzsKV3/wG6CXVImpS694lDpTDQLm0vawZ1tVxypVox3nLZHSsnB4PtlZNlLNJWTLYVk23FZFsx2VZMthWTbfVcWzHZrnlbMdlWTLYVk23FZFsx2VZMthWTbcVkWzHZVky2FZNtxWRbMdlWTLYVk23FZFsx2VZMthWTbcVkWzHZVky2FZNtxWRbMdlWTLYVk23FZFsx2VZMthWTbcVkWzHZVky2FZNtxWRbMdlWTLYVk23FZFsx2VZMthWTbcVkWzH5eC3UVkw+EDW2FZM/XDHpPy8L2vxdsmXY/HsVR9I03VJFtFqbseMT6/6efTSOjk9Yr5f0T8+myenwfDgd0EHvBNgJPTuhs2Q6+it+j73x6d7Ah6/VGv3qHtkV+qVue3Zz9KEvp+eYpFTIpatefP71rt+7X2H2Wa93PjzpDc+GD33hvOoz7PXIUDHy0baO9v3WeUXgIqfKWMEb9q2u3PbR86rLRyrIW0VFwnUio+1fP9/+sfOK1vmo3zuNdn3t/FEfM8cKPbr2bfkO0bZOc+k+CM71Id84vyjJuauEviqq0a5DtHSkGbiEqK0gtAU3N6AUFugijVzBDZdF7chiyxfRn32izS+nb5nn7OmmicHDqhT6b4F/j3UO9BtQvYzR94sDrWjsv5lu944BoW1kiErO6fHvsdUWca0aNvZBsrM0WBbptQhWsOV5vamOrKOySkrpWzqv+juIVaNtSMsOAfH9V+vFYB51HOWFcYpgEY2jo5v+Ufm58qO7MqHGGeoFe7PDm6xCpejYee1Ic+6UY8wgsxpy/avxkMlolaGOXuzSw/gaZ7OF8EaaH5RNBW+jmeNrnKyGpFDcLD+iSXKa0YenFwkavosCZ1/ubBwcp2tb404Hqmx02yzgtSRiW2tGaGEWmGAIB6md6KO9/fIjIzgKWwa470Roan+pjPKboMNqpnQfe7lqJepKv67zm4q9rtcbOjuo7IZeLtVypXatNvYqt6ZxqwZritYVdTa1khfXcBckmM1/4NYhFx8uUQhKlgx6g+O4dxL3j/FXCEBl+v3sI6gbnkBt61XG3taHH9mGRwzXAk1sbP/Ggzvtu67VNEKayMyeZ1ocLzR54wWehCt0Fx8uCZNJgayz6/pf/lcnqMtP2lgVhcePSn7BXwbwSSh31oey49/+dyUquD1yqU1GRY3O53AKGSS7Cbrm1a037n4RX4ROZA5jcl1ezB3fKm7guvpBBwPfzVGeUm6lwMrznVcwV9EN5ttLFRN1onFNyaAfsJDaYMO7O/SEP6v0/h4f/1EAboyrr6jNlL3+ZvUQ49ZtZdF4RlMNO6bzU/CbXtqfP8B7S8EPrHFj4xxC6apY1pRp5Otoo/oE3HV4oAwl6SB4rzEvm3Hhf7ABWR8jB5jdI8FxpVrLhNvLgTbHbH9wARvgb0zYX1sQGKDw6gp8x7WpeegvNLnKuLDXymq0D/R1ac7jyl3+mycY1x6/RBj4wxHdbXx1/Pt3bMUjvvhwGf9aHqiXbK5M3CvHrPjTihldDz6qHqh8c7Ozbd0Wfvj8KepEUx/fZNKaeUVv8dcM6K1b85ADHt+5Z3dRSsW8cMGYI4myR1cVfqng/f/UgqHVXXV351p8kt9A3N+Xm8zg3zZwu/8fIQz9GA== +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"; + + + + + + + + + + +Update a location. + +scope: `companies:write` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/put-v-1-partner-managed-companies-company-uuid-migrate.ParamsDetails.json b/docs/api/put-v-1-partner-managed-companies-company-uuid-migrate.ParamsDetails.json new file mode 100644 index 000000000..9ff053362 --- /dev/null +++ b/docs/api/put-v-1-partner-managed-companies-company-uuid-migrate.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/put-v-1-partner-managed-companies-company-uuid-migrate.RequestSchema.json b/docs/api/put-v-1-partner-managed-companies-company-uuid-migrate.RequestSchema.json new file mode 100644 index 000000000..3f10c8fbd --- /dev/null +++ b/docs/api/put-v-1-partner-managed-companies-company-uuid-migrate.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string","description":"Email of the company signatory who is authorized to accept our [Terms of Service](https://flows.gusto.com/terms) and migration decision. You can retrieve the signatory email from the `GET /v/1/companies/{company_id}/signatories` endpoint."},"ip_address":{"type":"string","description":"The IP address of the signatory who viewed and accepted the Terms of Service."},"external_user_id":{"type":"string","description":"The signatory's user ID on your platform."}},"required":["email","ip_address","external_user_id"]}}}}} \ No newline at end of file diff --git a/docs/api/put-v-1-partner-managed-companies-company-uuid-migrate.StatusCodes.json b/docs/api/put-v-1-partner-managed-companies-company-uuid-migrate.StatusCodes.json new file mode 100644 index 000000000..99697a732 --- /dev/null +++ b/docs/api/put-v-1-partner-managed-companies-company-uuid-migrate.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Example response","content":{"application/json":{"schema":{"description":"","type":"object","properties":{"company_uuid":{"type":"string","description":"The company UUID"},"migration_status":{"type":"string","description":"The migration status. 'success' is the only valid return value.","enum":["success"]}}}}}},"404":{"description":"Not Found \n \nThe requested resource does not exist. Make sure the provided UUID is valid.\n"},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"oneOf":[{"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"},{"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"}]}}}}}} \ No newline at end of file diff --git a/docs/api/put-v-1-partner-managed-companies-company-uuid-migrate.api.mdx b/docs/api/put-v-1-partner-managed-companies-company-uuid-migrate.api.mdx new file mode 100644 index 000000000..43e156c02 --- /dev/null +++ b/docs/api/put-v-1-partner-managed-companies-company-uuid-migrate.api.mdx @@ -0,0 +1,73 @@ +--- +id: put-v-1-partner-managed-companies-company-uuid-migrate +title: "Migrate company to embedded payroll" +description: "Migrate an existing Gusto customer to your embedded payroll product." +sidebar_label: "Migrate company to embedded payroll" +hide_title: true +hide_table_of_contents: true +api: eJztXFtzGzmu/is8fR48qVLLl1zHTyeTy64fMuOaOGfOlpNqU01I4qab7CHZsjUu//ctgGTfdLHk2A9na1OVOJZI4CMIAiAI8ja5SWe1dTqVysHMcCe1St2yguT0MoFyAkKASL6NEl2B//ZMJKdJVbt0cZxW3DgFJi254jMQaa7LiisJNvxvmda1FGkpkTIko8TxmUXK72JDJC3A5kZWSDw5TT75xowrBjfSOqlm7G8IkeX4bwmGOc2WujYs4mMVXxpdFKwyWtS5G39VX9WFZrUF5ubSMlCi0lK5EXNzaOlcy6JgCkAgxVwrBbnDFtIEjjzPda1cw5BXVSFzEgOrLSK7/O1t7eYn336aO1fZ08NDoXM7JpGOc10eRohpgEjfH2qOnZ4hL8UWEq4ZV4Jd8jyHihCwD3Fo52FoF2BKy/SUfQazkDnsztHAFAyoHA4rbd39c5bRnHksmUO2mZ5m1rN9RrK1ua7glF0FWlmglTW0Tq+NdHCVjJKKG16CA4PzfpsoXkJymnRZJaNE4sRX3M2TUWLgz1oaEMmpMzWMEpvPoeTJ6W3i1TKxzkg1S+6GinMxB/bly9l7FBJNs+eR3I0atv+X0rymb8/P0v8FY7Fj4D4HLsD0+E95YWHI5T2OpZQKLDER3EE64RYEe3t+xhaeKOPW6lxyB4JdSzf32oMNcl4UY3Y2ZUorYNKiyi6kADFa0bADyy5LqWRZl13ae6oar2Qaeko1++9AMO18/Axh1BbEONks7VECqi5x6Z4cnbxMj16lxy/92p3yunDJaffzu7tvKEdbaWXBIrGToyP80RflhxteVgWw2DIZJblWDpTDth1JHP7TYofbDro+JbQsHq6e/BNyh3pn0GI56fn39G3N4FY1KfQgjUJd8zZMapVZx11td6PS9GK+15gd2DrPwdoDlDpqkFbFki14IQUz4Gqj8Jcaxh2Rhy7Jtzv6M0peHL1YFcKv2rGPulaCfVWMfVXIH5UZLKqhAatrkwMTGixT2nnrOmaf+HdgtjZAaKI6+pUkrUc2/qpQBi9OTlbZflGV0QiPTwpgH5STbrnPTGoFv03JNtxPNw5MWlbyJZvzqgLFrtGKIviJFktc/bSSwtDRrjsulWVgjDaW2TqfM27ZlVQ0tow7Z+SkdpCR4K9GTBsiFylMuSwsEzWgH+Cq7dn4xKsx+wxegJcfPJt33MFMGwl2zwVLMNO86f6MzWopgE21YaU2wAQ4BIRzsqr2rfW6TPyAcZX2F0P4vFVgbgzHOZMOyu7nm6lm34Em2aNcbuBBre5dJ58ryOVUgsWJDGpI3ZnO89rYMbtYVhIN59J78++wZFKAcr4Xtm/m8LDxN8xAQQbY6ZbkGNW4Qb0HNKSAbVG9PCVGViKQiusmaBmbGV1XUs0sOfacKzYBsrGIZlLLQoQoJLSfcyUKjCek8trbCcfIXTSMpGVXipZ05ufxygc1fq58SBNUnnHmW7Kr0JSFSVp6rwS0qMLCINGUuN5mcL9kzuN4gzYyPtG168xdymagwLSzFkhHYdjaTHnuBYKhnhIoHxNQOC644+tUsQ/jXVzcBgpYcOXQIXOkGRRkGVZyMH5SMVrTaJHJbATbNClgzD5qw8D7pFGPBOEjUV35nxmiuqK5jZ+gZ7ny4p+0ZhSteGvgto+lrAsn0R8SRVxHg4UXP15dbPGbPZZ0nzfGspEzduNCSPyKF+cdTj4gW8PbC+R+rfmVlxDDsyBRN+ddtcm18eGAsMxp0oaOgO/n8EXJP2tozYMhu9nyI4reek+NLluCly1FVRdF8q1pV1eZ09sb9uzcugbo/WFbk7tR4qQrcGSfgvanf0g3T39TkAanere51aegO74pTg1Gvf+Z8///c46UNjrsvhz+QOND4SSFdkxudRtjduZoA6KtlRhiOc3mfAGssUMFLKCgPWdwI9FRNGYlyaXJ64KbnzzclIKf9DdSuGdJd4RrGniFvkmDzaUBTrj6noVtdyagAAdZraa1EiCyii9LUK4XxFz2Yo0Et2LdwOQ0WQnWko6bSz7WSkg1+wRurgWbc8siN9ZwoznoAVuAkdNlJhWpbo5IK23loyL7B4YByLXJQuRcYdw+AUb8JYgxOy+AW2D5HPLvPkjBiDXAYbzEjujaNw2BFwa4WGaR4pMOAMUbGLIJYOojjmMNwFJatFCZ0TXmgLYACy0yVZcT2sKvgTgI8ntAf/f9me+PayK63YAraEKWazWVM9tAa2LNvaS22rsL5q1jOKWOYX6gDWbL2rpuYLEeWBztlFsXV0tWyFK6LQjXNN5bhB8RcaDBiAazc10XAjHzINkGc1aBkVq0eEGJTARruQFl02QttvWy/KAEJWg6K4d2UG7OFXvOSq3c3GJMOK1dbcDji6kCqURtnVlmFgrIaeevuMxtlmsBWRuYbUTctt5fnr9iX4Z916jjbggDm6cHGFUT/qx5gV7kFRNyJhuzswWujQDsDnCtzH3b/dF+ljlhtatgXwSwHquTJWR6Os0qXch8mWHecLe5Lh8kxHLd/A5B1IpWFIhmvfA8NzUvMrN9zfSa7WG53/p+jPLwUWKTAk05RlYNHkYAJdgNwCsg55qFRMo27zjoug/ad35xC+C5kwuE7Gn4PW7AwJAB09NpzOpswgxlVeglgN1l2pvG+8/9h9iVcQO7a8CEF1zlkNXVPfZys7fehuodV5Qb5OKfNO2em90+7XNdSIFWHf96wDGsoED0MaOidyEtG8MICilYQIAeKEz+ZmhKu6eD1SRXKZJeB2zEqhCyGUBd1Qo2Qm3cY6NmT6KKZ74NiyQYbrtsJ4dB+LSaaG4wDI/tHlN+cQ1jwM8aVg0kD2FlMI+I4IJyj9JSsoe2pVL1ssCYXB54NB9WZKAwf4RBmDM8d9pkuAnbgm3Ycv9l2hDw+702vvFYBC3Y5vi0OZYb4H/KOHYwxjVuzjpuKG7nUweG9vq7RAGrvfaX33kTVx+soXfQLuM2NUF5ynBOAwtQLowiphZ3xd9r/0PIe5TuxRxbt1saPHLIZkZbi+mOyFwBbQa2xTqhxf7hDtAeoYko4r5gAImiFpyRua7NLoHhw1zd35F6Z+UomHEnF0MBhTWeox8sHtHexHP9FoBn0SyPqdF/gcoCjke1dJj1CexXtuTh0A1zC2fO+nR6i9GHHQJPyHjhwGxAmwUq2/ftPwRcWjYBNG4N4HjUMoBKqUY8a5VlnNtalVrIqSSzHSHHbOZjgo0nRtXKZHsAXpI9kXtDidUWwYrbpXVQNo2iDR/GBmQFbDbVpuTbdvv99j9igPqU2lWtGKUnA86S32DBwRCnrU3FccxPCPXDTQ6AUUTAgDNxfHREUi20/l5X22T5hMBiwBX3AHTY/pN9Nk76Z1/tuc7lIOnebB+SQa488veFV8cnz3GEPYM2KXT+HWt2gvumpJtUU72X8g+orQ2GSSNCINzLA0rFtBG+kMvUKi6P4fA971Wc28fTTI4FV1dPMygu2tDUPmw4A5jbxzQFgUepmeM3TzksjAspAA/8mOM3jPg9bIyrsHdQRZ8T9uUijz7MnhpGixWz0D+glz3Q6wdpa4u5iD1T7LsMSmJRSyDedYL3DqGF5CHbekKj0mplapqc3bbQfKX7Q1J1DREWibCGebuHSDYBbr3yj6LtHZcN5Be5BWtMKXSezzM3N2DnuhAZBOeTdM7vhghoWNBg3V9WUS6oApS2WXBZ8HCYhxF/sQBGufm37/7OLiI4Fj1j5/xIa0vJCHSSf0gD7EyN2Ce9AHahsazMsPecjiO7DjNUED4obGq2L4umELN3dkR5Me4clBVtYp0OIR3jbT2HL8LliunapXqa0veBYNxmypniThtM7XFZ7JbW47J4SEqPy6K70R0CiPvumB2bc5s13z5+NsWf5jYHHji5DTdG5UEBUKMGBkqccTo6j8mDtssEpkgM6wRQ6EzBNRKNgZ68AZEJaSe1sUCHSe259YaBdVvvsfo6uYV4brU2+tmy9jaR6GPQLptiRWVPuu87oGnVURMvhScenjgSU35ycpJycfQmfQH8dcqPXvH09fHrV2/e5M8nx69/3jLoSK2k0+6HxP7+gM/3b/yntxqn7L3Es3D23h8+j9g7PJQeJ0OpRBShjvbBKHz/aPp8RI2hfdVHeRCibX/EfzCONqyd3G3JGsr97aIVG6ptr7kd6kgylUraeRaynOhdsZDAh15PkJMOAvJ7fKdxZTvWMh/kBAvto5iMSN8XhVlnAFx2vP8sfkLlkSovaoEW3RNC22Kw0nmoM3koKv4hHkRkSNlX6ezverEbijZkia+NVjMWdt9DHn/J6gFq7k0yKNxrxyzeX7Lyh64/wXg2Zscnz1+8fLZmic21ggfXQ5xj71gNERf58VHvoBQrDgqZb8s0rF08ova14LDp6LGzdPD4zs3Bdsp722SVP8IZbOB3SWSvhbW9juCiWxjf1mTQ7Pt5wdpsHynHNV7o6055A9VybStuaPf2D84mIMtYzTdUiG6O4HEYNIMMnszHsPZ+nx8a7u4OiUsItKOVwoVmt3g6/J76PGgHgjXBIPw9DHYQ+hy0NwmUZhVeAnIutrLRq0y4lfkT7845lflF+x2jTQoy9tvC4tU32/FDYRu4Jv6IcrsOxeEbRkdf7y3wP7AsPNqZGR2LmhCymrZQ46hxVCvonjBHT5HE5iT5IOfsEWAOn1Fleu6YratKG8cEBUfFcnjCH8xRHIM/AX30PPSg+KED2TMUg9OsbeVi0liXPazg5SP2ZWpQ9rJirQT5h2k2kYauBO7J5T2dq08ZdW+2xsGDUtmEDwDJ5ux2TNvUgj4kiA/B++sTDi9eHb9OBec/py9AvE7fvISj9PgNiJfiCODN85dbTBqdhj1gU1oUnH2U7q8ZpuIEVfxyNOa4XWO4YEmH54PTMAsYI9IWsTlqDkJYs9F5ZEmdiNeT6auTPJ3wyTR9wY9P0jcnP5+kz18cwYn4OeeTkzdbJPUwK3RmueRz9guYQqpGTCiXYkkiug63V3aTUIypQVkfTzd5j+11O5trtbaWsIZotKvp3aLLtUiazaXaWh/aa/bg3Rr2HuwYGR7BjtgfAN8x1aTcnK7e/QP4OtQxadLY3kfeKkVG26y97jjUu14Bf++2Yrq22H00vOH4qbkcGny/vxhBv9jmAmpzhfTeS65t6LXrJaAH39mjkeFFvP3u0/luTft9Lpz9EkQUO9xzTaw/sp3G9DYCk3/5WQmXVsrhNI0Ybb6+hjvBzb335dckuYtXdJubHbF3GkZAikNNgjP+RQtCN7z4vvMN2ntmlZKZ908NJS/7V+c7ub/ruabiqNrNUUDh3p5/rwCTw5eb3yfA+L177ZWeFHhGJrUVrYBcUtKWYeoX7wgacEZCyEa2QGg4DO/x0BdXf/twwQ4Xh8eHTZHT4W1TcSzuDmNPCfaqeQeCbgTJKovphp3ucp+dx/REFFNfPPiOQ4gIvWBQSHNYebnBX3C6cWAULzK89Jjteim9YXhAN/YNw9cOwo3RquAOtz3jJOpWc3EwpLM7A14D4NtduI5jK+DfgdtlioFaqhdgjBRAR17xHQ/srSzt49D2equ78SkRulVVD54UQXsY+21i2XRsWOPLAiF9Sa+Q0AsTbp6cJoeL48ON71G0OoEhxt1hOxKqtAgupDYFBlpBb3klvdamAkpS3ZU5eQ+lTvoy8/RSn67Fr3GcGwivpXluKDW7iSY+cUJSsJDXhtIKl7dxo/iW3gnAF0mS08tv3Vaf0Vp4g7CmbaN7CDG+AoG/T4Ab2pMOr936113ohhgZBUwLxOPPUfKZalZ+hIOnsIHB3ShBK/h7az/DUxIde9cuo+467zxnsbIAOw+LxHKIaMT9azBvz89QI+OZV/fFi1FCVu23aVjjndluDR9dkfbm71DgwNBMp/Q7nl2FF1ZWr/VBkeuSjvQIx4FdfR0G3wcROq8x1CIh/Vd4goH7FF14/+R95Mp+x8vxIQ8TJdZg+p9WO1HW+GxMyVWHTnyjJ/oJzCoP3uIZDuO29Wf/eeLn3+uJn7CyHdy4w6rgkkwAmbzbYJwvk8WxfwtoPa1klJwOngSKFvobVsZbhzRubzGu/2KKuzv8+M8aMOa8/IZewlAxn39GRFIQvuEBn64e/vR78JLP2KbHgzaMLgbY1CL6qCRcCu6/NuOL+/3rQvvB+zd/amitYL0A17/T1Mi5DR3eeWGlF70wYzVebnu8JaXf2rYbYpx/uUhGySSE6KWmOMjwa3ybgV/7SY8ZbYzh8bPbpOBqVvutpSeJf/4FpWD8yw== +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"; + + + + + + + + + + +Migrate an existing Gusto customer to your embedded payroll product. + +To use this endpoint, the customer will need to connect their Gusto account to your application using [OAuth2](https://docs.gusto.com/embedded-payroll/docs/oauth2) then view and [accept the Embedded Payroll Terms of Service](https://docs.gusto.com/embedded-payroll/reference/post-partner-managed-companies-company_uuid-accept_terms_of_service). + +scope: `partner_managed_companies:write` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/put-v-1-recurring-reimbursements.ParamsDetails.json b/docs/api/put-v-1-recurring-reimbursements.ParamsDetails.json new file mode 100644 index 000000000..322fc00b5 --- /dev/null +++ b/docs/api/put-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/put-v-1-recurring-reimbursements.RequestSchema.json b/docs/api/put-v-1-recurring-reimbursements.RequestSchema.json new file mode 100644 index 000000000..162421896 --- /dev/null +++ b/docs/api/put-v-1-recurring-reimbursements.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"allOf":[{"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"},{"type":"object","properties":{"description":{"type":"string","description":"The description of the reimbursement"},"amount":{"type":"number","description":"The dollar amount of the reimbursement"}}}]}}},"required":true}} \ No newline at end of file diff --git a/docs/api/put-v-1-recurring-reimbursements.StatusCodes.json b/docs/api/put-v-1-recurring-reimbursements.StatusCodes.json new file mode 100644 index 000000000..2fd1d98b0 --- /dev/null +++ b/docs/api/put-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"}}}},"409":{"description":"invalid version","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":"invalid attributes","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/put-v-1-recurring-reimbursements.api.mdx b/docs/api/put-v-1-recurring-reimbursements.api.mdx new file mode 100644 index 000000000..80290414b --- /dev/null +++ b/docs/api/put-v-1-recurring-reimbursements.api.mdx @@ -0,0 +1,71 @@ +--- +id: put-v-1-recurring-reimbursements +title: "Update a recurring reimbursement" +description: "Update a recurring reimbursement." +sidebar_label: "Update a recurring reimbursement" +hide_title: true +hide_table_of_contents: true +api: eJztWdty47gR/RUE+7A7VaREXT3iUybrScoPWbt82aTK4/KCQFPCDglwAFC2SsV/TzVISpQl+ZLMy6T8ZJNCNxqNcw6ajTXVBRjmpFZngsa0KF24HIQGeGmMVPN7AzJPSmMhB+UsDagAy40s0ILG9KYQzAFhZGNBdix6X9QXZbkuICZ/7PqKH4x08AcNqGNzS+Nberk7111AH8N5aZ0OpXIwr8MM3aoAHA15AkKAoAFlRdEd4k0tBiTdisa3a/qrzgumVp84B2s/lW5B49u76i6gBTMsBwfG+nGK5UBj+u/wH37aTxdn4e9gLK41oBIXvAAmwNCAWr6AnNF4TeuAqHW4fBpQUGWOAQ6j4SSMpuFggvEISFmZORp331dP83mKseRSgSVuAQSTGybMgiCfLs7Iso6FMGs1l8yBIA/SLchKl8YP4CzLeuQsJUorINKSwuilFCCCegwrikxyn6SfLbnNpZJ5mXd93/2ycK6wcb8vNLc9n/4e13m/TXdYsJXRWeZ/77NCho2lVPOfGodh5/UHDKO0IHq0CjYZlqJNaMHcYg9W1wsgNzdnp0SnPg87yKEBNfCtlAYEjZ0p4fhmVFUHRMY+sHlrYcAWWlmwaDSMIvyzG4MtPVrSMqMB5Vo5nDpe004O+39aHLren18nfwLHSB9DeGR5kdUTNT7vrWOu9G/KUiLvkpPRLB1ORmESDT+G4/EoCZMpT8PZCZtMJnwkxrMRQisvMr0CuG/MRuMpDMbRLBzw2Uk4ngzH4QySJIx4xAfTGYwmPKEBbbaCxpSns2Q6HkdjmI7EaDjhJ9MhY0wMI85O2Gi2txPnaSo5EFviqgEFgBtA5N2zDZYHgzAaXUezOBrFw3EviqIw+hhHEQ1o6fXhlYNZrkvMMT2Z9CYRraqAFgb1yUnoJGufcfvgKZX8VgKRApSTqQRTI0nao0LlUcXEucpWNUaqvXS/ZuIualvzg753TF/jufPmIC2QX5sUvsqhzjJmSG1y3OUGPK/xibkF5TZK1Xit6dAjVwD++XarGWReSgFvlB0pIC+0A8VXH0iqDZEq1SZndXIUWegH4jTKTr3pqYTMC9AOel+zICdzsI7lBXlYgGoh1MkReWCWNF4PbnSXAt9vxoxZRxrXB6atuhp5WxPnKZ53J99gZ7vjdwF10mUY72XLmnDnkKZVhVONo/G+fv6mHfm7LpV4i3wecUG+KEK+qGsP0G8lWDz6DFhdGo5ABkuUdgQepXU98k/2FRXL1Fhrj0Bydtr37JSWLFkmfdqeynU3aWCMNr6W2FWh5v12M5kxbIXnmYPcHjoE9rzefwU04MzBXJvVkTn8qBcxc1UAR4mziJdmzd6caM5LY3vkelVIrAxWNZi+wmorjHWdwZwzMikd9DcFETGQ+QrD6a3LmkJt1G8IDT3gWBSE2hPxctG4ajfJNpHPjS4LqeaWMCUIZ4ok4IsIjCYpZSYIR4nIm/ELpkSGYiJVXeh0qkEfcw7Wsjm8HPJFG4gAx2RmCUt06TpJDckcFJhtOhvXbZS2NCnjdaRMEVACA8fM1VzZLQiUdvepJ0kHWLc7+08bxHfxEncMO4ujRwiCgoH88AY9Wt1hIC21f9Mu9CQLP+Ok4XmN2pbZs31aSuX504r8O7/f+f3O7x+U38PhcX5vUGPfKf5O8XeK/4gUbz4EwLq/aeH3+9VEZll2nvqlPCXDLtCf+UBs8kRjOpmKKOKDk48JPxnNRsmQDaMpiCn7OGUpT8Y/4tfkk4+sA59NTfOQJRmEl+1QbIM9n9Hv3hs42BpQZZ74VuZ/0xpAcN1VuylouyaPDpT1fVgET82Ao53cgC5ZVr7c0cWs7bqq+3kbez/7HVLJLXTTy8bMYn8xpv3loH+sq91fS1FhSxfMsu0ElybDbm8DI1bIGkWhgNxDaS9tp5Br3++zBbCvwOwqrP2FvlOHdn7njzg+6PPCaPGMzwJ/rjq97ivkbg2hAx3vzcbj5G0HG58TYOYAEBoXYQZLyAgr3QIPnFouEFBXK+sg/19mqD0cmaAKKGrS5Va9Prdq0tGctwvLhkYtIaIKW9Gp9vE3xPX9f+yL73RPO537gGKj3p6nV2CWkkNnT7dy4w+evh/YF7hIJHnon0Od+r1E06cR/gsyrnNAzfFx/GzJ54Ya5KIWLt+yF5qXCGCfsL80NRrjnuNNn/20nZVcYi3gqYR9ICYzD8rm179uMei7rtq6nKmOn5fueZ6uoXPMfKc7ohpYDh5dv8iY9Aj0XFo3FL+ly4Ev1I5eXcVSoDgvtHU4fL3Gm5Ubk1UVvv5WAh7Lt3eoKEaiZnslENLi/4LGKcssPLPQX1qJ/0BeusA4uJy2FlWrrapRGjSyJ5HrVdDeQL0ttP/re6Uj6azTdvgub5Pd7bHya52s8HrnVNqvkbYWKH2Fe3Zs9zy6uLmmAU2aMizXAk0Me0DQsod6q3VRczRe1+/WNGNqXtalYe0SCcp25XYjr80/nZptF0zrdT3iWn8FVVUbbDl89kVl9R+eXIwd +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"; + + + + + + + + + + +Update a recurring reimbursement. + +scope: `reimbursements:write` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/put-v-1-salary-estimates-id.ParamsDetails.json b/docs/api/put-v-1-salary-estimates-id.ParamsDetails.json new file mode 100644 index 000000000..ce5d5820f --- /dev/null +++ b/docs/api/put-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/put-v-1-salary-estimates-id.RequestSchema.json b/docs/api/put-v-1-salary-estimates-id.RequestSchema.json new file mode 100644 index 000000000..3fe35771d --- /dev/null +++ b/docs/api/put-v-1-salary-estimates-id.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","required":["zip_code","occupations"],"properties":{"annual_net_revenue":{"type":["number","null"],"description":"The annual net revenue of the business (must be greater than 0)","example":600000},"zip_code":{"type":"string","description":"The ZIP code for location-based salary calculations","pattern":"^\\d{5}$","example":"94107"},"occupations":{"type":"array","description":"Array of occupations. Time percentages must sum to 100%.","minItems":1,"items":{"type":"object","required":["code","experience_level","time_percentage"],"properties":{"code":{"type":"string","description":"Bureau of Labor Statistics (BLS) occupation code","example":"151252"},"experience_level":{"type":"string","description":"Experience level for this occupation","enum":["novice","intermediate","average","skilled","expert"],"example":"expert"},"time_percentage":{"type":"string","format":"float","description":"Percentage of time spent in this occupation (as decimal, e.g., 0.5 = 50%)","minimum":0,"maximum":1,"example":0.6},"primary":{"type":"boolean","description":"Whether this is the primary occupation","example":true}}}}}}}},"required":true}} \ No newline at end of file diff --git a/docs/api/put-v-1-salary-estimates-id.StatusCodes.json b/docs/api/put-v-1-salary-estimates-id.StatusCodes.json new file mode 100644 index 000000000..c42807ff6 --- /dev/null +++ b/docs/api/put-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"}}}},"422":{"description":"unprocessable entity - already finalized","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/put-v-1-salary-estimates-id.api.mdx b/docs/api/put-v-1-salary-estimates-id.api.mdx new file mode 100644 index 000000000..379bdbd3f --- /dev/null +++ b/docs/api/put-v-1-salary-estimates-id.api.mdx @@ -0,0 +1,73 @@ +--- +id: put-v-1-salary-estimates-id +title: "Update a salary estimate" +description: "Update an existing salary estimate. You can modify the annual net revenue, ZIP code, and occupations." +sidebar_label: "Update a salary estimate" +hide_title: true +hide_table_of_contents: true +api: eJztXAtv27iW/itc7V60ASzHdpM0NbDAdvrYG+B2WkzbnZ1tuyotHducSKSGpJK6Qf774hySkizLTpwmd19TYNCpxcdH8rzPIa8iVYLmVih5lkXTqKxsfDGODc+5XiVgrCi4BROLLBpEGZhUixIbR9PoY5lxC4xLBt+EsUIumOvGQrch+01VLOWSFSoT8xWzS2wvK54zCZZpuABZwYD9x9k7lqoMBozLjKk0rUqCZIaf5Wf5YQndkVlRGcuksmwGbC4kz8V3yNhjnqZQWsgOhuytTIGFfw+6Axg2g1QVwDTwLFYyX7G50kxDqnQWnwOUuJ6y0qUy4GCYVJUwZV+7ezO91MLC12gQWb4w0fRT9N7N9Sq0iL4Mom/xojJWxUJaWLgNj+2qBGwPxQyyDHCLeVm2m1DXkmtegAWNg19FkhcQTaN/j/+VBnz+7iz+N9AGD2UQCTyZJfAMdDSITLqEgkfTq8hNFRmrhVxEgwhkVeDUk9HkOB6dxONjnCmDOa9yG03bv193D/4lYimEBEMHilQQz7iBjD1/d8YuHBbGjVGp4BYydinskq1UpalByvN8yM7mTCoJTBhWanUhMjwkasPLMhcpLf+RYZ8KIUVRFe2xvzxeWlua6eFhplIzpI0dpqo4DBsZl3ylVZ7T90Neitj3FHLxj37AuPXzAcKoDGTD6HpQ73BVEdXTlpbcLqNBpOGPSmjIoqnVFXQ3Bgn148ezl0zNaWc6NLfjQK6vvwwiA2mlhV3RKb9QRcnl6nmagjHPK7uMpp++XLcISZtLvgg4NJhSSQMGh56MRvjXOjZT0UjzKo8GUaqkBWmxVWu3D3832PRqE6Wa/Q6p3ZAAzzfYMuV5WuU0GvETl+x9/ELpkqlLCZo5MlGyxeMDBt9K0AKQX3O4gHzAcpX6bygPZpVBYjNBXgyjQVRqlFtWuBXTSfVQ+V7HM6Tz5dlbma/cvl4PIijKXK0AkvUpPjVzyCrPHe/smiuMw+xSmI1tEwZ3azeA39Xs3kD8rmZbgXT59rFqC9KDXpBOpicSbOLPaE+Um0ohYK4PH9mTaMpjbpGaQbaNvosyQSWy59RB9zQTBOrzQq13PpTK1oLGUf7z8+fs6vj6nxCEBkMCtIFA0pyk8XYMYWzIUB8ZJfks39R5QrIUpDVD9nOV50zMSQGuwLb69x+PP7yE252bM1e6wCYRiXQrCujlIfxgLC9KdrkE2U9Il9zUNENMXCvpXoSpBt4F2OC7Z1x+sl4gFRk1fycgOTeW+Rl70bQsoRYcrjVfbQpj/BW5ptXJcbBdgtAbUtbQsSBUxvNA8kTZwkJh+qT/utBd57VtQvenSgOvENff+Exp9t5yi9Ziatjjn/72/qAFl9iQWNkp4JuGftv0xA7DDUtljwFaH2icZrcS2q2bB3vV2V8SJXT0zQqHLctLqguRAtkXaE5BJpyJwC9A8wUZC+ciz8kqJDQ2+nI9iPDAkhI0SgJsdiOud3VbEql43qYEaVGcdOCxx9ywDFJR8Jy54QZsFI8PaEtKLQquV60ZZ0rlwOXGlL8uwS7Br144K9H3XtuM6+u2RfXJUVTP3m+u+st1t6831tb1da9mammKNcGzxvzrvEdmF3zjRZk72vfWVGIst1XLBImezo+zJ9mzJ/FJdjKPj07TUfxsfgRxmo0n6SR7AkezyQbMaXSaTp6NTk5G8ewkfRYf8exp/Gx+AjHw8dEJ5/Onz+A06jUGUHb3K+DoeIR/2uudRs+OxqOnUaOnxhNqNOooCTdqWyp7j2Acj48/jEfTJ6PpaDQcjUbx6HRKk7Ql542N1wTbpyBLovFxPJ4c4wZ5E/y9mttLroG9REJA6WMG7P3KoIRi4eMG/f0CBrhOlwNka7GQ+Dd1d/akBWOZd3vRaXXDxY5rjR902EeI0xZPbjBiNB6OohabkAz/ck08a3NaDemAOPiF0TVR8dHoaNNc/1lZ9lpVMtvHWt8yBPssGXNuNHIMGGdnGFXpFFimwJAhQV78kL3h58BMpcGzrfPN2NnLQzIlhWEXPBekr7r6oc2PoLXSzn1d0xr+901ttlXrbIyanAN2SLmFhdKrLXNQqxul4/sSUjEXYFBV+zVTdxJU2gzZh1Up0GVdOXF2DismMpDW9aKIhrVazCoLh7WnzjQ4c86qZkiSojXqPaDhCNgWBbgbiTmr0Q0VDsl45AutKgxfOA2P4ZeZt26tYrNK5BlL0YUsfPsll1mOnCCk88BbAQjCXIAxt9M1AUgGlgs0MWaqsq1NjdkCJOhmO/3QAaWp9JynDikGlmSGwHHnHK+sS2GpbDInJmkR1qe18488xbfpZdrq2FpctIVB0FJD/qAOw2idpX9WNiYmi1/hpPFbR7WesyeTTbasZKkVKg+y8ZGQ7IrFjOdo/a0aO/nujP9xbYZXNEMQAbjlfMWWvCxBBvMU2ExlZDvS8fs9YDg9F9KTlWGmSpeMG/ZVSBIBSU34yQXPK/g6YGTy1LvI5kQEWQX+POueddDx65C9B8d2n165aV64cxJg9ozzEMw4rbsfsEUlMiBDrFAaAlUOP8s/hdf/C+GFUcZ6ImHYV0m8nbhz/DogcO6s2KXI80DyjDPXkn31TZk/pJVzqTzbuo//Y2QkorA84/YWsbsXgbk15HDBpcU4LscxPYGsPCd7KSgkI55GN4HEhpdIsxyG7LVC/5IE82BtCMJHW/XV/Z0gqq90tuEXtGO/uu2fNQYH2hdKwts5SfTdaymq3IoySFPkow7jhZ83mS182YOlO3FVIRe1HEeHI8sEfuL5u9ZMLkrbM7fbkJup5mde1CExv6N2ydtkkyrtosCZYVY5J7bZ4Jtn+CjFHxU04kF7BzbMRyM66T3XqtgRSKrbVWVi1e6Ga3KurwF6WLtCem1l/MZTf/yrsMv4rYTYKb/oenurN552XFM8GswA/Hnm//vPHEfaqrA7AQsUPpQEJCcIQ6s71MaQnVnKWyljBJpYVrElv8CkpJdDPsCm5kGNBEVRi5UoFRpDtvqxg7tmPh5E7RX2NIh6jOEZl+cJT1NVSZtkkIOFpJLzSmaQJSVfFRg63mEoY7B73UreMNbWrOXXlcyEXLwBu1QZW3LDwmysno3OYA3YBWgxXyVCEummiLRURtwrst/QDMBZmZ8VNafPFdP8ArIhe5cDN8DSJaTnzkhBi9XDYbzAjma4fQneYE/CiA+6ANze4CHMAGSzjh6AhTAooRKtKgxw7HKOXItEVsWMUhQ9EDtG/hrQX1x/5vojTwS163F5SkhSJediYWpota25165t9m6DeW4ZHqllmFZujFmqFGgZFv3Awmrn3NjALUkuCmF3IOxpvPcWvkbEfgxGYzCzVFWeIWbud7bGjAEnobIGL8gsyby03IKybtKLrX8vX8mM8votziEPyi65ZE9YoaRdGrQJ55WtNDh8qUtZJ0JmlbF6lRjIIUXqTiQXqaEYZNIYZlsRN63338+fsa9L6G2S4+0Q+mkeHmAgTfgDk59WsROWiYWoxc4OuCYAMLeAa0Tq2u6P9r1ICavZBHvkwTqsFA5V83lSqlykqwQDuLc76+JOm1j0nW8XRCWJoyCr+YWnqcZIud7NM2vN9pDcz10/pusapRmwWY6iHC2rGg8jgALMFuAlkHJNfCBll3bsdN0H7QvH3Bnw1IoLhOzGcD6ux+BSRmo+D1GdbZhDcsLc5tjrxvuf/avQlWFi4NYUMOM5x0i+y1PcSVvvQvWCS4oS8ux3OnY3m9l97EuViwylOv7nAAezggzR+7SKfEFRbUaQScE8AtRA/vC3Q8Oo6YPBqtMQZEn3ARuw0ptslJZCNb8Vaq0eazJ7EFI8c22awhp0u0wrhkH4lJwprtEMD+3uc/8CD6PBz+qpakgOwsZi7hHBB4o9YuWQ9G6pkGtRYAwudzSaMysSoEIXNMKs5qlVOlFU/rAVW7fl/mxaD+D8vca+cVhcBVBd0OrwNgwb8D+kHdtZY4+aM5Zrstv53IImX/82VsBmr/33711tVz/qGe9Rw8ZNaILilMwzygVI61cRQou3xb/W/oeQr410I+bQunFpMOWQLLQyBsMdYXJMvpd8F/WGFvubO0A+Qm1RBL+gA4msFjyRpar0bQzDu6m6v+LoLc6RsOBWXHQ3yPN4inowv0d5886N3wLgpqjZY67Vd5CJx3Gvkg6jPn76DZfcJ90wtnBmjQunNxh9eQRmyHhuQW9Bm/hRdvvtPwRcYO07VbcHwCHV0oFKoUYs3xFFONtKUiW/ILEdIIdo5n2CDRmjcuOwHQC3k2tb7gSlAX0RCkWpsKNuFGR41zYgKWCSUNt3o53g2v+IAFofqeFqySg86XEW/BvWqXdxmkqXHNf8gFBffUsB0IrwGPAkxqORr45V51W5ay8fEFgwuIIPQOXNjw1VJbdzX01e51Mn6F67D1EnVh7mj/Gf8XjyhDL9bYE2y1V6DrpW/hR0E3Ku9iL+zmi9xjBRhDeE1+KAQjKlMyytU0xXMrBHd/lu7k2cu9dTH44BW5UPsyieNaapudtyOjB3r2kOGaZSE8u/PeSy0C4kA9zPxyz/xmi+u61xE/YtSNHFhF2RyL0vc40Mg8QKUegfoMs10P2LNBUWrGZ7hthvsyisyw6Dt5XgjUtoIDnIpprRqpTcOJo6ZrfLNN/ofpdQXT0IC4OwevLGh4i2AW608o+iXUuXdfYvzOalMYXQebpM7FKDWao8S8Arn6iVv+sioGVBjXX/vQr7giRAYZsLLnLuk3lo8ecXwCg2//zFX9mHAI4FzdjKHyllKBiBSvJXoYGdyQF7oy6AfVBYgKnZS07pyLbC9BfP7mQ21e7LRX3tby13RHExvJ1SlOTEWuVNOsabeg68VrNAk0NVNlbzmL77AYObKRaSW4V3HQsu8tuF9bjI7xLS4yJvO7pdAMHvDtGxJTdJ/fX+oykum1snPPBw69kYlQd5QDUZaCjwxCl1Xt+GrbvMYI6DYZ0AbjqTcImDBkNPfIMsyYSZVdoAJZOavPWWhbVb78F9rdhCyFv1Wj87eG/bELcosHzZAt0pqRw88PKyUTbnk8kk5tnoND4C/jTmoxMePx0/PTk9TZ/Mxk+f7Vh0GK2gbPddbH+X4HP9a/3ppMaUvRSYC2cvXfJ5wF5gUtrdRe1D4W8d3BmF6x9En7Oo0bQv11E+8ta2S/E/GgYZ9t9VdjuI5kIKs0x8lBO1KxYSONPrAWLSfoOcj28VcrZlzeSdmGC4Q5XQ0DdZYcZqAJuM9z/FN0g8QqZ5laFEdwOhbNFgzAbNpK5E6cfmoEG6I7sqnf1Vr/UXTX2U+FIruWDe++7O8V2UdyBzJ5IB71XVUbzvonRJ18cwXAzZePLk6Pigh8WWSsKd6yHeYe9QDRGYfDxaS5RixUEu0l2Rhl7mySpXAQ7bUo8t1vG3/kyrvLcJVrkUTseBv00guxfW7jqCD+0rJE1NBp2+OxeszXaWcuDxXF22yhuolmtXcUPj2985moBThmq+LkG0YwT3M0G9SK/JnA1rbtb5vuHt1SHN4g3tIKWQ0cwOTYffqc+dPBCsCYaM0Sf2yPd51NwkkIqV+HaEtaGVCVplxo1IH9g751TmF+R3sDbJyNjPhZUAmWnpIe8G9tgfYd8ufXH4ltVduiufe274r1gWHuTMgtKi2pusuinUGNWKagPdA8boyZLYHiTvxJwdAozhM6pMTy0zVVkqbVlGxlG+6mb4vTgKa3AZ0HuPQ3eKH1qQ3YRZJ5u1q1xMaGOTuxW8vMa+dM153U3q2s2kH+bJTGh6r2TPWV5SXn3OqHvtGnsNSmUTzgAkmXO7NG1dC3oXIz5cqp1wODoZP40zzp/FR5A9jU+PYRSPTyE7zkYAp0+Od4g0yobdwSnNc85eC/t9gaG4jCp+OQpzdNcYMizR8LKTDTOANiK5iHWq2W9Cj6Nzzzs1yZ7O5ieTNJ7x2Tw+4uNJfDp5NomfHI1gkj1L+WxyumOn7iaFzgwXfMl+Ap0LWW8T7ku+oi269LdXbrdDwaYGaZw9Xcc9dtftbK/V2lnC6q3RNqW3iy57kdTOpdxZH7rW7M7eGvbueIwMU7AD9ivAOYaapF3S1bvfgPehDkGTWvbes6sUJtol7VVLoa7foFy7rRhvKXYPt/3B2J9UtgrEf6c3jNo3g1ovAXTu+6/f29j9wE3tLvzQAzePexX56IAuolOdfzQ9ocv6vY/d7Hr1qH7j5nbP2/S/btOC4Z8RuIcXSobsA2rY5h69T4eaqkDTZTwa/YUsMCHP3MWJ8S0vW+7xlsTf52GTtf0bH9M7Bw/20MgPvjPShup/u93TI/UDOfNc8c2LU3d8i2TA0GcfsNHwmP0zOx795cCRBKamo+moTpUTddTIR8OTB3i1pH2M9MKD/9N9G46O1oI09RsXTsBufQeQLlBVN78HiBbE+lDuJbi6v3t3giwFjFXSm46Oo5fRNDq8GB92XzA8vELz4RpJAasnvFqoND54EW5g81K4C9hxBgXdwt7YwJdQqAivJZkS+Dlws4rdeLELweJnRL9l4N4x32kKt24bs8TP7bfz3qPYd2zc84JeTQM4eXiOj2gCuCYJ3r0kS0P4p0F4ZZfoxIdk5SByL5H8yAxuhC0TXA8iVGe/NIrvVSC9fpV04t9y6XnwZeuLK/7BlZ63Tjzn9zD+aHiy+dAJShhXCxFUOz1QiQ83InGGhFf7aclBhCLJvJ2/B01SqiGL5rI/3Y8+pIaHWXgGJqZ/Y+LK+K4b7Aw5PfBpFSMcjwx75fmKhRIyfFMyU2mFdhbtzT/4Vxe4i8/5V2jqx2fYL9CoSJfrQrr2X/+lIWM8ulIZW3DZGie8mNrzMGTn3arauPnzldXNV1Ydg1n4Zg/LnAviRJIpV17IfYouMK7eHSIaRFPyk75gzbix2PDqCq2gjzq/vsaf/6gAKfrTF5SmmsrciFsyQeZpFk3nPDfdhz/b5/X4F68GDtjNz4H2LiXYUHLVyPQo8tdm3TtTruzdvfK6H7z/02+3btlQt3H97+XW+9uo1Rdus+IPa1p508loejwn+t/Ztq2P3338EA2imfdjCieINb9EC5ZfusMOsd7plfvtKsq5XFTO6XJDoozh60qnVjL+f1pPJ6yT09WVa/FBnYO8vq6py+K/yUG7/i+oRkX4 +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"; + + + + + + + + + + +Update an existing salary estimate. You can modify the annual net revenue, ZIP code, and occupations. + +The salary estimate must not be finalized (accepted). Once accepted, salary estimates become read-only for record-keeping purposes. + +scope: `salary_estimates:write` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/put-v-1-tax-liabilities-finish.ParamsDetails.json b/docs/api/put-v-1-tax-liabilities-finish.ParamsDetails.json new file mode 100644 index 000000000..9ff053362 --- /dev/null +++ b/docs/api/put-v-1-tax-liabilities-finish.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/put-v-1-tax-liabilities-finish.RequestSchema.json b/docs/api/put-v-1-tax-liabilities-finish.RequestSchema.json new file mode 100644 index 000000000..c96bcede2 --- /dev/null +++ b/docs/api/put-v-1-tax-liabilities-finish.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/api/put-v-1-tax-liabilities-finish.StatusCodes.json b/docs/api/put-v-1-tax-liabilities-finish.StatusCodes.json new file mode 100644 index 000000000..e875608a3 --- /dev/null +++ b/docs/api/put-v-1-tax-liabilities-finish.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"202":{"description":"Accepted"},"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/put-v-1-tax-liabilities-finish.api.mdx b/docs/api/put-v-1-tax-liabilities-finish.api.mdx new file mode 100644 index 000000000..9a1ad21f8 --- /dev/null +++ b/docs/api/put-v-1-tax-liabilities-finish.api.mdx @@ -0,0 +1,71 @@ +--- +id: put-v-1-tax-liabilities-finish +title: "Finalize tax liabilities options and convert into processed payrolls" +description: "Finalizes tax liabilities for a company. All external payrolls edit action will be disabled." +sidebar_label: "Finalize tax liabilities options and convert into processed payrolls" +hide_title: true +hide_table_of_contents: true +api: eJztXFtvHDmu/iva2ockQJdvcS7jp83GyVkDmxljkpychScoq0vsbk2qpBpJ1XbH8H9fkJLq1he7OzZwdjEDDAJ3SdQniiIpktJNcp1Oa+t0KpWDqeFOapW6RQXJyUUC5RiEAJF8HSWOTy3+9u7agVG8YOd8YXRRWPyoK/Bdz0RyklS1S+eHqePXaSH5WBbSSbDpRCppZ8koqbjhJTgwSPAmUbyE5CTJdVlxtcjqWopklEiFlLjDDgb+qKUBkZw4U8MosfkMSp6c3CQeaWKdkWqa3I4SATY3skIsyUnyaQbs8+ezU6YnzM2AhTGS21Ez7P+l/0Pzf3N+lv4vGIsdw+gz4AJMb/wJLywMRznFuZRSgaVBBHeQjrkFwd6cn7G5J8q4tTqX3IFgV9LN2ELXhhrkvCj22NmEKa2AScsqo+dSgBj5NryqCpkTe59YdlFKJcu67NL++nTmXGVP9veFzu0eLehersv9uIBp5ReLvu/zSqahp1TTvwaCaefnZwijtiD2kvXcHiWg6hJl4ujg6EV68DI9fIHCIGDC68IlJ93fb2+/Ih9tpZUFi8SODo7wnz4r3+Q5VA4ELuXxwfFyg5+1Y+91rQT7TTH2m8IVxuUBi4w1YHVtcmBCg2VKOwbX0ro99oF/A2ZrA7RCkcFeNqRlc15IsfebomGPVuD6rCqjc7CWjwtg75STbtEgkJaVfMFmvKpAsasZKBplrMUCBY8WMWBkuVaOS2UZGKONZbbOZ4xbdikVgci4c0aOawfZnBc1XI6YNkQuUphwWVgmamBOM67ans0mvNxjH8HP9OKdH+YtdzDVRoLdUlYIZpo33Z+xaS0FsIk2rNQGmACHgJB5owRnB8oh/zpSu/+7RSbedCTpbu7+ydwhc8Pu0+PfIXc9rXSR+Anj7qsMQkWFi3wOv7d7lxvDF6jgHJTd39dTzb4BdggoF2vGoFYrVER/oT9WkMuJBIsLGTYjdWc6z2tj99inRSVRIS6Yw6X/BgsmBSjne2H7Zg33GzvCDBSkWJ1uSe7hZm5QbwENKWBbFC9PiaGWiaSi9ghSxqZG15VUU8u4Eiznio2BdCeiGdeyECxHOShD+xlXopBqyqTy0tuxvGQGmoGkZZeKFFvm1/FyROD8WrErWRRR5BlnviW7DE1ZWKSFtzbgVZb/SKwpcb9N4W7OnMf5BmlkfKxr11m7lE1BgWlXLZCOzLC1mfDcM4QrBkogf0xA4bjgjq8SxT6Mt3FzGyhgzpVDQ8uRZhCQRdjJwQRIxWhPo+0ltRE00riAPfZeGwbXvKwKGPVIED5i1aX/N0NUl7S28Rf0UC49+8etMUFTqRX8MiGnZvNcyrpwsirAj4X7aLDx4s/Lmy1+2WJL98e2Uk3jyNiNCyHxEy/OOyN5R2vF2J4hd0vNz7yE6HYFjroZ74pNro13CIRlTpM0dBh89wiflfyjhlY9GNKb7XhE0WvvidFlS/Cipajqoki+Nu3qKnN6c8OenlvVwDruYFOT21HipCtwZh+C9KdfpJulvyhIvfFLbte3+hBkxzfFpUFv9s81/89fc6S01mD3+fAFlY9WxcI7uExuNBt77MzRwUJbK9HFcprN+BxYo4cKmENhce2CGYmGolErSS5NXhfcPPVwU3J+0l9I4J4l3RmuaOAF+joNOpcmOObqW8bzXNfKZQIKcJDValIrASKr+KIE5XpOzEXP10jwiNV1TE6SJWct6Zi55H2thFTTD+BmWrAZtyyOxprRaA16wOZg5GSRSUWimyPSSlv5oMj+hW4AjsrCqGg58fQyBkbjSxB77LwAboHlM8i/eScFPdYAh/ESO6JpXzcFXhjgYpFFio86AWRvGJCNAVQ7jxUAS2lRQ2VG1w63zXpgoUWm6nJMR/MVEAdOfg/or74/8/1xT0SzG3AFSchyrSZyahtoja+5FdeWe3fBvHEMl9QxPPe3zmxZW9d1LFYDi7OdcOvibskKWUq3AeGKxluz8D0iDjQY0WB2putCIGYeONtgziowUosWLyiRiaAt16BsmqzEtpqX75SgwEtn59AJys24Ys9ZqZWbWfQJJ7WrDXh8MeQklaitM4vMQgE5SnemuMxtlmsBWeuYrUXctt6enz9jX4Z9V4jj/RCGYR4fYBRN+KPmBVqRl0zIqWzUzga4NgKw94BrZe7bbo/2o8wJq10GexzAeqxOlpDpySSrdCHzRYbxwPutdbkTE8tV6zsEUSvaUSCa/cLz3NS8yMzmPdNrtoXmfuP7MezXcGxcoCpHz6rBwwigBLsGeAVkXLMQSNlkHQddt0H71m9uATx3co6QPQ1/xg0YGA7A9GQSozrrMENZFXoBYO+z7E3j7df+XezKuIH7S8CYF1zlkNXVHfpyvbXehOotVxQh5eJ3WnY/mt287DNdSIFaHf/3gKNbQY7oQ3pFb70yadwIcilYQIAWKCz+emhKu8eD1YSYyZNeBWzEquCyGUBZ1QrWQm3MYyNmjyKKZ74NiyQYHrtsJ4ZB+LQaa27QDY/tHpJ/cQ+jw8+aoRpIHsLSZB4QwSeKPUpLwR46lkrViwJjcHlg0bxbkYHC+BE6Yc7w3GmT4SFsA7Zhy+23aUPAn/da/8ZjEbRhScpR93m87YaN+B/Tjx3McYWZs44b8tv5xIGhs/59vIDlXtvz77zxq5+soPek3cZtaILilCxslDkoF2YRQ4v3xd9r/0PIe5TuxBxbt0caTDlkU6OtxXBHHFwBHQY2+TqhxfbuDtAZofEo4rlgAIm8FlyRma7NfRzD3UzdP5B6Z+comHIn50MGhT2eox0sHlDfhEx5B4AfotkeE6O/g8oCjgfVdBj1CcMvHclD0g1jC2fO+nB6i9G7HQIzZLxwYNagzQKVzef2HwIuLRsDKrcGcEy1DKBSqFFacgAD2FqVWsiJJLUdIcdo5kOCjRmjammxPQDPyR7LvaK0YOZBi9uFdVA2jaIOH/oGpAVsNtGm5JtO+/32P6KA+pTaXa0YhScDzpJfYyHBEKetTcVxzo8I9d11DoBeRMCAK3F4cEBcLbT+VlebePmIwKLDFc8AVHLw1D7bS/q5rzavczEIujfHh2QQK4/jp/hnenj0HGfYU2jjQuffwDTGn4JuUk30VsI/oLbSGSaJCI5wLw4oFdNGgEH7ZGoVt8dw+n7sZZyb59MsjgVXV48zKS5a19TuNp0BzM1zmoDAVGrm+PVjTgv9QnLAw3jM8WtG4+02x2XY9xBFHxP2RSIPPs2eGEaNFaPQPyCXPdCrJ2lri7GILUPs95mUxKKWQLxrBO+cQgvJQ7b1mGal1dLSNDG7Ta75UvddQnUNERaJsGbw9gyRrAPcWuUfRdtLlw34F0cL2phC6DyfZW5mwM50ITIIxifp5O+GCGha0GDdnleRLygCFLaZc1nwkMxDj7+YA6PY/Ju3/2CfIjgWLWMnf6S1pWAEGskv0gA7UyP2Qc+BfdJYXGfYKad0ZNdghsrAndym5vgybwose7kjiotx56Cs6BDrdHDpGG/rOWoUTnQ5dO1SPUnpeyAYj5lyqrjTBkN7XBb3C+txWewS0uOy6B50hwDiuTtGx2bcZs3Xh4+m+Gxuk/DAxW1GY1QeFAA1YmCgxBWn1HkMHrRdxjBBYlgngExnCq6QaHT05DWITEg7ro0FSia1ees1E+u23mL3dWILMW+10vvZsPfWkehj0C6bYF1pj7unHdC066iJ58IjT08ciAk/OjpKuTh4nR4Df5Xyg5c8fXX46uXr1/nz8eGrnzZMOlIrKdu9i+/vE3y+f2M/vdY4YacSc+Hs1CefR+wtJqX3kiFXIgqsj6h3OoF4FL5/VH3eo0bXvuqjfBK8bZ/if7IXdVi7uJuCNRT7u49UrKk5vuJ2KCOJr3nPQpQTrSsWEnjX6xFi0oFB/ozvNO5sx9rBBzHBQnsvJiPSd3lh1hkAlx1uv4ofUHikyotaoEb3hFC3GLB2SWZyX6L0Y2MQkSFlX6WzvenFbsjaECW+MlpNWTh9D8f4LqsdxNyrZFB41o5RvO+y8knXp7A33WOHR8+PXzxbscVmWsHO9RDn2DtWQ8RNfnjQS5RixUEh802RhpWbR9S+AhzWpR47WwfTd24GtlPe2warfApncIC/TyB7JazNdQSfutcD2poMWn2/Llib7T3luMcLfdUpb6Bark3FDe3ZfudoAg4Zq/mGAtGNETzMAM0kgyXzPqy92+aHhvc3hzRKcLSjlsKNZjdYOvxOfXY6gWBNMAhGn9iT0OdJe5NAaVbh5R7nYisbrcqYW5k/8umcU5lf1N/R2yQnY7sjrAIQtmOHwjFwhf8R+XYVisPXzI4+b83wL1gWHvXMlNKiJrispi3UOGgM1RK6R4zRkyexPkg+iDl7BBjDZ1SZnjtm66rSxjFBzlGxGGb4gzqKc/AZ0AePQw+KHzqQ/YBikM3aVC4mjXXZbgUv77EvU4OylyVtJcg+TLKxNHTVb8tRTimvPmHUvTkaBwtKZRPeASSdc780bVMLuosTH5z3V0ccjl8evkoF5z+lxyBepa9fwEF6+BrEC3EA8Pr5iw0qjbJhOxxKi4Kz99J9n2IoTlDFL0dljsc1hhuWZHg2yIZZQB+RjohNqjkwYcVB54E5dSRejScvj/J0zMeT9JgfHqWvj346Sp8fH8CR+Cnn46PXGzi1mxY6s1zyGfs7mEKqhk3Il2JBLLoKt1fux6HoU4Oy3p9u4h6b63bW12ptLGEN3mhX0rtFlyuRNIdLtbE+tNds59Ma9h6cGBmmYEfsC8A3DDUpN6Ord/8Cvgp1DJo0uveBj0pxoE3aXncM6m2vgL93WzFdWew+SrqF7n+PjoJn2X+yx3A7Sn7t2I27JvRfYkBuR8nPjQW5a85/mpI/TckPmBL/3/C+z3upeCG/4+1Ufs06rypQGKwT3X1TFAziEw1hf1sGAm+I+PxBvLcoJCkwvPb+m7K5ruCEXcausVTCnlwZ6eAywcs7tgL+DbhdpHTnFc+aoXnzFkS/GW7eVM/BGCkodxJm8Ylf/7OdAua1rx0oS2dFXBa/IGtfphjFPdh9oQKFK/YbAm06LANe3a0PvO2+ZgL4tkEItNLrF/TGhZslJ8n+/HC/Kcnbv+m+cXG7v8TsfcyedhZ3v3kyg4pEgtDWpsCNHS6a80r6e+apgJIumy9dFjuFUg9WxtNLfaQZPyMf1hBeSfPcUFR5Hc0KPyNbLOS1oYjIxU20WPjIg7VvauTQxdduq4/4QIA3mivaNnfiEGJ8mAL/HgM3ZByHN4aJREqX2xiv3QwjGjFzO0o+UrnNj4zgKawZgIJVvtYiug701Ai+3IEyFRNq3WcyRgk+JWJ/mXwEM5c5dNajfUyA7l/vU8N9gUOjp5PS35gYs6Hr0p1BKHJdUr6QcDyx7F3YPvExF3pUROi8Rn1E0/hLeNWB+/hfeDTlNI7KfsWb9yHI43NpKFDh699a+UFuVNq6kqsOnajWlrRaiBz5M7dWczAY3XW646BVrc7pzfOmfYXi/4PaDALl4NrtVwWXJHm0026CkrhI5hRUj2oiGSUng8dwlugj4b6uSGKyAe+Mz7R1SPjmBl3Kz6a4vcWf/6gBDdvFV9RohmriaF/GOa1+36bL0Ke/Bj/sGVv3ts6aKcfrrNQi6tMk3K3tP/7ja+T94zvbwfsvf4lnJWM9A1c/Y9TwuTVz/oWdzrelh1p61uz886fk9vbfB3jMuQ== +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"; + + + + + + + + + + +Finalizes tax liabilities for a company. All external payrolls edit action will be disabled. + +scope: `external_payrolls:write` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/put-v-1-tax-liabilities.ParamsDetails.json b/docs/api/put-v-1-tax-liabilities.ParamsDetails.json new file mode 100644 index 000000000..9ff053362 --- /dev/null +++ b/docs/api/put-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/put-v-1-tax-liabilities.RequestSchema.json b/docs/api/put-v-1-tax-liabilities.RequestSchema.json new file mode 100644 index 000000000..9e644686b --- /dev/null +++ b/docs/api/put-v-1-tax-liabilities.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"liability_selections":{"type":"array","items":{"type":"object","required":["tax_id","last_unpaid_external_payroll_uuid","unpaid_liability_amount"],"description":"","properties":{"tax_id":{"type":"integer","description":"The ID of the tax."},"last_unpaid_external_payroll_uuid":{"type":["string","null"],"description":"The UUID of the last unpaid external payroll uuid. It should be null when the full amount of tax liability has been paid."},"unpaid_liability_amount":{"type":"number","description":"A selection of unpaid liability amount."}}}}}},"examples":{"Example":{"value":{"liability_selections":[{"tax_id":1,"last_unpaid_external_payroll_uuid":"7985032c-ee3a-4e98-af27-d56551eb5f1c","unpaid_liability_amount":50},{"tax_id":2,"last_unpaid_external_payroll_uuid":"5ed14dbb-958f-47c8-b16e-c4fed82dc486","unpaid_liability_amount":400},{"tax_id":8,"last_unpaid_external_payroll_uuid":null,"unpaid_liability_amount":0}]}}}}}}} \ No newline at end of file diff --git a/docs/api/put-v-1-tax-liabilities.StatusCodes.json b/docs/api/put-v-1-tax-liabilities.StatusCodes.json new file mode 100644 index 000000000..f9e3344e6 --- /dev/null +++ b/docs/api/put-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"},"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/put-v-1-tax-liabilities.api.mdx b/docs/api/put-v-1-tax-liabilities.api.mdx new file mode 100644 index 000000000..d6f42e578 --- /dev/null +++ b/docs/api/put-v-1-tax-liabilities.api.mdx @@ -0,0 +1,71 @@ +--- +id: put-v-1-tax-liabilities +title: "Update tax liabilities" +description: "Update tax liabilities for a company." +sidebar_label: "Update tax liabilities" +hide_title: true +hide_table_of_contents: true +api: eJztXOtvGzmS/1d4fR8yAdS2pPgVf7pMHrcGNjPGxLm5hSdoU81qiZNusodky9YE/t8PxUe/1JIlxz5gFjPAYhGLrPqxWKwXq/ktuovnlTYy5sLAXFHDpYjNqoTo/DqCYgaMAYu+jCJD5xr/9v7OgBI0J5d0pWSea/xRluCmXrDoPCorEy8nsaF3cc7pjOfccNDRKCqpogUYUEjpWyRoAdF5lMqipGKVVBVn0SjiAklQs4hGkYI/Kq6ARedGVTCKdLqAgkbn3yIHMdJGcTGP7kcRA50qXiKI6Dy6WgD5/PniHZEZMQsgnkd0P6rZ/m/833bhby4v4v8BpXGi574AykB1+Gc019Dn8g7XUnAB2jJh1EA8oxoYeXN5QZaOKKFay5RTA4zccrMgK1kpOyCleX5ALjIipADCNSmVXHIGbOTG0LLMeWrl+kKT64ILXlRFm/aXHxbGlPr88JDJVB/YnTxIZXEYdi4u3S7Z3w9pyWM/k4v5f3qCcevPLxFGpYEdRJulPYpAVAUqw3Q8PY7HJ/HkGLWAQUar3ETn7b/f339BOepSCg0aiU3HY/y/rijf39GizIGEkdEoSqUwIAyObUni8HeNE76to6NK0RVuoYFCr3NAlVBQKtAgjCVllYPekZaSEg05pPijRgl4ynL2O6QmGkV38dZjYLjJcfwVvYv/2RCNP9VE8RAoPC32RCB2epdw1lqFPYdW+dbhN/ps6N2B1U/Kfhb5yp2P+5El5/R7fdPW6eHIhyjmVJukEiXlLAG/6MRrlTuyNavrhpeo8typxKZTiXSJo0sCXeLpDgIppdZ8lkPStinru9/leOknPbDPXWYtFeorQHfzAsFVQgtZOVXdLvWgFSviZgyv1Es3XUD6NUGrsqeM+/IklpK1T4MMn3JfzQD/Aab4H54ncOfeitPbgPaxmLRVOvoADBTNyYVIZQHkit5FOykoot6kQNdD2xiND8bR8EY4WlsYoYsZoPhqPN5MFA3mFA3meBJtJB5NZtkEMpjEp1N2FB/BCcR0cjaJTyaT7BXQk5OjV8fR/Rcn2g2CXdK8Arvqv0X8HSIeNfKbduT3CV19Tj5BWiluVn8d4R3/f4nuiz/7R+OjdSf9kzTkg6wEI78JQn4Tzmn/UYHG8EmBlpVKgTAJmghpCNxxbQ7IR/oViK4UWPMTwihnk7gmS5pzdvCbwDjxaDpdZ/tZlEqmoDVFX/FeGLTQAQHXpKArsqBlCYLcLkBYLjPJVmjwbKjmMRKMWSgXmoBSUmmiq3RBqCY3XFgQCTVG8VllILEn8WZEpLLkAoWM8lwTVgExklDRzKxj7JsD8gncSq/fOzZvqYG5VBz0nhGhhRmn9fSXZF5xBiSTihRSAWFgEBAKb4+I7GHp/i3cvnD7oUaTe1xHbsHoeLsBiP/7lhj4QarJV8AJHuVqAw876sHo5lMJKc8wvLpdgD+MdjqRaVopfUCuViXHtGdFDG79V1gRzkAYNwvH13t4WGeLREFu0ycjG5IHeJhr1HtAs8HuqrSBr6NE0MoEUsF6eC0jcyWrkou5JlQwklJBZmAzJEQzq3jOSIp6UPjxCypYzsWccOG0t5VY22SvZsQ1uRHWsCVuH29GFpzbK3LLMXBzKk8ocSPJjR9K/CatXE4JzmS5H61oCjxv8x0SgcuwXq+NhM5kZVp7F5M5CAwKwq550kEYulIZTZ1AqCAgGMpHeRSGMmrokCp2YbwNh1tBDksqDIarFGl6BVn5k+xdABfEnmnM46zZ8BZplsMB+SAV8QHQqEPC4rOiunH/nyCqG7u34S/oz26c+GeNM8EYVgr4OXPB09a1FFVuOGazlqKrfXQOXvjz+mELv+xxpLu8NRfzwBmnUcY4/kTzyxYnl+YM8HYCeVhrfmqljl6iZkHbapNK5ZJ5pomRVhtaAn6Yw2fB/6igMQ/K2s2Gn6XorHemZLElXanHVWVi5PaBHTs3NECb7fkYhjahDvDRa3/8KzeL+GcBsXN+0f3mUR+97rihuDU22Px7z//ye46UNjrsrhx+ReMjRb5yAS7hW93GAbkwtnxYFzskWdAlkNoO5bCEXOPeeTcSHEVtVqKUq7TKqfrBwY1t8BP/bBXuZdRe4cCAaCCbn1HxNaFpivlFwiAHA0klskowYJg7FCBMJ4i57sQaERZS24EJlsZ6wVrUcnPRh0owLuYfwSwkIwuqSeBGam52DzrAlqB4tkq4sKqbItJSav6kyP6FYQByJZ4rek7MXmZALH8O7IBc5kA1+FKNDVIwYvVwfLkIXfumJdAcSyyrJFB81gWgeD1DMgMQzToGABZco4VKlKwMHpvNwPyIRFTFzNZAByD2gvwO0F/cfOLm45kIbtfj8pqQpFJkfK5raHWsuZfU1me3wbwxBLfUEKzuN8FsUWnTDiyGgYXVZlg9CD/mvOBmC8KBwXuL8AMi9jSIpUH0QlY5Q8zUS7bGnJSguGQNXhCsrlhuQFkPGcQ2LMv3gtnyZevk2AzKLKggr0ghhVlojAmzylQKHL5wscQFq7RRq6Qu+iaC8lQnqWSQNIHZRsTN6P3l+RPOJTh3QB13Q+jZPD/AoJrwR0Vz9CInhPE5r83OFrg6ANA7wNU8dWP3R/uJpxarXgd75ME6rIYXkMgsS0qZ83Rl63O77XXxKCEWQ/vbB1EJe6KA1eeFpqmqaJ6o7WemM2wPy/3GzSM4r5bYLEdTjpFVjYdYgBz0BuAlWOea+ELKNu/Ym7oP2rfucDOgqeFLhOxouBzXYyDIgMgsC1WdTZihKHO5AtC7bHs9eP+9fx+mEqpgdw2Y0ZyKFJKqfMBebvbW21C9pcJWSCn73W6746a3b/tC5pyhVcf/OcAhrLCB6FNGRW+dManDCBtSEI8APZDf/M3QhDTPB6suMdtIegjYiJQ+ZFOAuioFbIRau8dazZ5FFS/cGBJIEEy7dKuGYfFJMZNUYRgexj2l/MIZxoCf1KxqSA7C2mKeEMGVrT1ybYs9Ni3lolMFxuJyz6O5sCIBgfUjDMKMoqmRKpH2ynIjtv7I/Y9pTcDle01847Awe2CtlqPtc3ibAxvwP2cc21vjgJvThiobt9PMgLK5/i5RwPqs/eV3WcfVLwbovWiOcVOasHVK4g/KEvAS3q4ilBZ3xd8Z/13IO5QexBxGNymNvYabK6k1ljsCcwE2GdgW6/gR+4c7YHOEOqIIeUEPko1acEcWslK7BIaPc3X/QOqtkyNgTg1f9gXkz3iKfjB/QntzGZosagCORX08MiX/BBHuS5/U0mHVx7NfS8n9pRvWFi6MduX0BqMLOxjekNHcgNqANvFUtuft3wWcazIDNG414HDV0oNqS41c2wDQg61EIRnPuDXbAXKoZj4l2HBjVK5ttgPgJNkRuTOUGtTSW3G90gaKelCw4f3YwFoBnWRSFXRbtt8d/z0GqEupOdWC2PKkx1nQO2wX7OPUlSoprvkZob6/SwEwivAYcCcm47GVai7l16rcJstnBBYCrpAD2JaDH/TLg6h799Xc61z3iu51+hD1auWBf4z/jCfTV7a1p23QZrlMv4Kqnb8tunGRyb2Uv0dtMBi2GuED4U4dkAsiFQOF/klVot3w1V6+472Oc/t66s3RYKryeRZFWROa6sctpwdz+5oy11+VYMvQMy4L40IbgHt+tv/R8nvcGtdh76CKribsmkSefJkdNQwWK1Shv0MvO6CHF6krjbWIPUvsuyyKY1OLJ952gg8uoYHkIOtqZlclxdrW1DW7baH52vTHlOpqIiQQabXd1jlEtAlw45W/F23nuqwnv8DNW2NbQqfpIjELBXohc2zac84nat3f9RHYZUGNdX9ZBbmgCtiyzZLynPrLPIz48yUQW5t/8/Yf5CqAI8Eztu6PpNS2GIFO8leugFyIEfkol0CuJDbXKfKOrlwnXuMwff//o8KmOn1Z1p9RdO6ObF2MGgNFaZNYI31IR2jTz1GhcmLIISsTyyy2v3uCIc3kc0GNVFjaozzfraxHef6Ykh7leTvR7QMIeXeoji2oTupfn76a4m5z6wsP3NyaG7HtQR5QrQYKCtxx143tiwfNlBlkSAz7BFDoRMAtEg2BHr8DljCuZ5XSYC+TmnvrDQtrj97j9LVqC+HeajD62XL2NpHoYpAmybCvtCPddy3Q9tTZIQe+wfdZl8fGLKPT6TSmbHwWHwE9jen4hMank9OTs7P01Wxy+nrLogO1wt52Pyb2dxd8bn7tP53VOCfvON6Fk3fu8nlE3uKl9EHUl0pAgf0R1aMyEIfCzQ+mz0XUGNqXXZQvfLTtrvhfHAQb1mzutmKNrf3tohUbeo5vqe7rSJRxwfUi8VVO9K7YSOBCr2eoSXsBuRzfSDzZhjTMezXBXLooJrGkH4rCtFEAJpnsv4sfUXm4SPOKoUV3hNC2KNB6TWdS16L0fTwskT5l16Wzv+vFaShaXyW+VVLMic+++zz+5OUj1NyZZBCYa4cq3p+8dJeuP8DB/IBMpq+Ojl8OHLGFFPDofohLnB26IcIhn4w7F6XYcZDzdFulYfDwsMp1gMOmq8fW0cHrO7MA3WrvbYpV7gqnl8DvUsgehLW9j+Cq/XlA05Nhd9/tC/Zmu0g5nPFc3rbaG2wv17bmhia3f3Q1AVmGbr6+QrRrBE/DoF6k92QuhtUP+3w/cHd3aLn4QDtYKTxoeounw9/tnEdlINgTDIzYn8gLP+dF8yWBkKTET3iNCaN08Cozqnn6zNk5tW1+wX6HaNMGGfulsAKA6ZYf8mngQPwR5Hbrm8M3rM7+vLfAf8W28GBn5vZaVPmQVTWNGuPaUa2he8YavY0kNhfJezVnhwBr+MR2pqeG6KospTKE2eAoX/Vv+L05CmtwN6BPXofuNT+0IDuGrHebta1djCttksc1vHzAue4D4k6a1I+brX/IkhlX9oP+Pbm8s/fqGbHT69TYe1DbNuECQGtzdrumrXtBHxPE++D9dErh6GRyGjNKX8dHwE7js2MYx5MzYMdsDHCGn7ptNGn2NuwRSWmeU/KBmz/nWIpjtuMXv57OMF0jeGCtDi96t2EaMEa0KWJ91eyFMJDoPLGkpux0lp1M03hGZ1l8RCfT+Gz6ehq/OhrDlL1O6Wx6tkVSj7NCF5pyuiA/gsq5qMWEcslXVkS3/uuV3SQUYmoQ2sXTdd1je9/O5l6trS2sPhpta3q76XIQSZ1ciq39oZ1hj87WcHYvYyR4BTsivwJ8xVKTMAv76d2/gA6hDkWT2vY+caoUGG2z9rLlUO87DfydrxXjwWb37tfVP4ZAwX9b/ReOGO5H0S8tv/HQgv5NHMj9KPqp9iAPrflvV/K3K/kOV3Lvv37vfffkyuH9R0qwBtaUdn8TvwmdyhLOyU3/I3x9fqu4gRv/oSFo86NkNk/tP6G076s6Dz590lzpPPY7ZP+Swi5PJWDHh/157QWDtUdJnvSpnWd8CAd5bHsMx/Zw2n6S5jsMpNp8LJ/hv5wY+k8aubZa5/soZ3YhmyTYCKYuN3VRv2mu75CPx5uvPWkTdHz7EySbdKj7NMkOUo9OX58dj19N0xjgFY2P4PVZTLPpacyOT46PJzA7zibpFs05Px733vPYhekxsMkRm83i18dnWXx0mp7Fs8kJxOlRBuxsytKjs5NtTI/GHa5nezwUspHmOBgY/BZPl0C/AtWr2H7CjqUjT7R+sqo7DH1xLJegFGeoBe6O7ore/bPziBtSEbreK2ddN74iN6pfnGm9JocLD/P6MOsJ63CHp3VhN9MH4eNjZP7OxL5TZ188MYvoPDpcTg7r7trDb+1H6e4P18ztIe5b93E72+jlHU+lcnTO/rEIWnL3VkTMoLAPRqwdrXdQyN52OHqxuy3Cn3H5GwgP0rxU9mZoE80Sf0Z56PBWDSL3UeebFCPgNxWK5vpLe9QndBDuTA+MrU0IQgxPyOG/Z0DVgEnxJGL7gSqhlVlgVTJ0X4yiT7Zl7ns4OAobGNyPInR8vzQus2WnHjRP490sRe0Ltp5bLH27zq2QiNjnCfG1P1TqcD3fflpvFOHzg/rn7BOoJU+hpRnN0yT2NYdDO/CQoRDQJcb233jNrv3UtS+QIbcPQBlJLI4Xmrz35zc8eWcfImQyrYrwoN5/+DdiqLtN8E8ivQtcyS/4jocvGbubeVRt/+t/NZp87557MwUVLTrDQVIf+bcmwnnSsMprnYE7c1jmlFv1tMfxmzch19HS3p4FIxKNovPe25Zr9CP3eFR7PV/wAxJtkN63b5gyflb5/T3++Y8KMHC9/oJGTtmeV6uPjNtcdcMrlW2B/PCLD7tekk0vZG5YaYjr7IhgYiP/7Xz3CU/3DYx7QnM/eP/m72kOCtYJcPgx0lrOjed764QVX3Wc63oo38xA41marWPbTvHy81U0imY+eyikDQUUvcWYnd66TQ8XP5he4N++RTkV88qlTI4k/vd/X2wX+g== +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"; + + + + + + + + + + +Update tax liabilities for a company. + +scope: `external_payrolls:write` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/put-v-1-terminations-employee-id.ParamsDetails.json b/docs/api/put-v-1-terminations-employee-id.ParamsDetails.json new file mode 100644 index 000000000..230d65c22 --- /dev/null +++ b/docs/api/put-v-1-terminations-employee-id.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/put-v-1-terminations-employee-id.RequestSchema.json b/docs/api/put-v-1-terminations-employee-id.RequestSchema.json new file mode 100644 index 000000000..4c80eff53 --- /dev/null +++ b/docs/api/put-v-1-terminations-employee-id.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"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"},{"type":"object","description":"","properties":{"effective_date":{"type":"string","description":"The employee's last day of work."},"run_termination_payroll":{"type":"boolean","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":["effective_date"]}]},"examples":{"Example":{"value":{"version":"1928d0c378e519e9c03fb959bc959a6b","effective_date":"2020-06-30","run_termination_payroll":true}}}}}}} \ No newline at end of file diff --git a/docs/api/put-v-1-terminations-employee-id.StatusCodes.json b/docs/api/put-v-1-terminations-employee-id.StatusCodes.json new file mode 100644 index 000000000..c98ea3338 --- /dev/null +++ b/docs/api/put-v-1-terminations-employee-id.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Example Response","content":{"application/json":{"schema":{"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\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/put-v-1-terminations-employee-id.api.mdx b/docs/api/put-v-1-terminations-employee-id.api.mdx new file mode 100644 index 000000000..cd6a3b716 --- /dev/null +++ b/docs/api/put-v-1-terminations-employee-id.api.mdx @@ -0,0 +1,73 @@ +--- +id: put-v-1-terminations-employee-id +title: "Update an employee termination" +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: "Update an employee termination" +hide_title: true +hide_table_of_contents: true +api: eJztPWtz27aWfwXL/ZDkjujI8jufNk3Se/0hbSaP7d5xMzJEHEloKIAFQNlqxv995xwAJEU9LDn27E6Hmek0EYGDA+C8H+T35DadlNbpVCoHE8Od1Cp1iwKSV1cJzEYgBIikl/CiaA6xydde4vjE4rB3syLXCwDm/zID5ei5AVtoZcEmr74ng34f/yfAZkYWCCN5lby75bMiB/YxjEx6SaaVA+VwLC+KXGa03ss/LE74nthsCjOOf/NIJnr0B2Qu6bUgf54CM1AYsKAcgWB6zDhzYGZS+R+kYv/EvR8kvaQwugDjpEe2LKVorGGdkWqydo0vXy7fImQ3hSXYHi2EbICLX1W+SF45U8JdL5mDsdLv5n74WWkMKMfCpLhUAM8+AdC/r8JzqSZsUkoBX59PnSvsq5cvhc7sAd3xQaZnL+OdpgVfGJ3n9PylFDArtAOVLV6wsTZMqrE2s7AXxab6hjnNSovLScvGEnJxkNz1EgiXP3zYmcXpCP1mKrOph790TZZx53g2BbH2PHnm5BwaS4+0zoGrlbV/m4Kbglla99nyWlNu2UQrYFI5zWA83nSJGVcZ5HyUP9LC0rIa5AF7U/0dn+CaTI7ZtSnVsDFrGO7wGgeNeW6BcSXYtcdbzmEouAN6KhWtPi5daWDtjpYnrbvJegqtte5qG7vLuXVM8AXe9I0234haNmxg7Rnes9zlmM6lt0xGdqrLXDADGcg58YY0bCwVz9kNn4Blc8kZRz4ap9kiy4EFFA7Y5difIUFc3A9Jq/Bj5NGCLxjKJ1HmcJDc4Xbhz1IaECgliT9QakqHRJN8ro+B+MiLQhI/QSziX+c8L6EWSYngx8eHhxen6fERv0iPxeAo5eJEpOOjswxOR6OLi6yfrHDlrtMq0ZSI4/MzIfqjkxMxzngmxMWgn2UjwYGP+dHJYVLzHd3CEkP4X9oElQz6g37aP0oPcamNlEB3cEd/eslx/3hVa/yiHftZl0r8rn5X/2Be1P9ZgnWA92V1aTJgQoNlSjsGt9K6A/aefwNmS+MFZmH0XAoQXhhJy+Y8l+IgwmvQMVRKDYchwMBLRk6mjlnHHTHUzopreTNfVGF0BtYSs79TTrrF74qx39VnFIQzvmBTXhSg2M0U/MIjLYirFro0cecMl+dSWQbGaGOZLbMp45ZdS0VbG3LnjByVDoZEU9c9pr1EihDGXOaWiZJkMVf1TNSMtJnrhsJ555d5wx1MtJFg99Q4hGaaVdNfeL1FymemDTABDhE6+B1lQVvZNxnLbxhZa1mJh99r0cKN4Yukl0gHM7vOhFiBOvwGOCFgudiwBo26V/N9KiCTYwkWLzJQIU1nOstKYw/Y50UhM57nC68Dv8GCSQHK+Vk4vrrDlwU3fAYOkAByjoTvdA2SZG2F9R6okRmzKADJy0MidoigItsEKmMTo8tCqoklvZNxxUaARgJhMyplLliGdDAL46dciRxtFKk89TZMShLA1ULSsmtFHD3093jdaxg+7EbmeSR5xpkfya7DUBYuacFupJsyIKYKjEFHM0N+m6xVcssn8yHuN1Aj4yNdusbdpWwCCkx9awF0PAxbmjHP/IFwxUAJPB8TsHBccLeDNfsmMreBHOZcoWJ1HGEGAlkETg6yTypGPI2WBYmNIJHItvhZGxa0TW8JBOFHR3Xt/z9ErK6DTeF/QX1y7Y9/VEtRlH9awa/j5NXVfXuZlbmTaPQTROSjFuPFn1eZLT7Zg6WX17ZSTeLKOI0LIfERzz80VvLqa83a/kDup5pf+AwqA9efqJvyJtlk2njvSFiGDggaAPUB37/CFyX/RJswigdDcrNejyB66T02elYDvKohqjLPk6/VuLIYOr194JKcWzeAlOG2IXe1/fM+UH/6m3TT9FcFqVd+yd3mUe8D7fiheDV3ve7O/w53jpA2KuyWN4XCR6t84S07dIy2qI0DdkmGW6GtlWhiOc2mfA6skkM5zCG3eHdBjURFUYmVJJMmK3Nunnt0UzJ+0l+J4F4kzR2uGeAJ+jZtWvgjrr4NeZbpUrmhgBwcDEs1LpUAgaawj6E0jJirJVsjGXEfLKlUfLJirCUNNZf8XCoh1eQ9uKkW5OXG1Vi1Gt3BEmJzMHK8GEpFpJshpoW28lEx+zeaAbgqC6ui5kQrewSM1pcgDtiHHLgFlk0h+xZiLehdenQYn+FEVO2btsBz9CYXwwjxSTeAxxsWZCMAVe9jDYIzaVFCDY0uHbLNZsTCiKEqZyMw61FsGflLiH7085mfjzwR1W7AK1DCMNNqLCe2Qq2yNfc6tdXZTWReO4ZX6hgGW2pjdlZa1zQs1iMWdzvm1kVuGeZyJt0WDNcM3vsIf0aMAwxGMGKYYARohvqbiTgPCzBSixpfUKIKrmzAshqyFrf1Z/lOCbQHocE55EG5KVfsiM20clOKAPnoj8cv07OCK2RuUVpnFkMLObrrWg0Vl5kdZlrAsDbMNmJcj97/PH/BuQznriHH3TAMyzw9gpE04c+S56hFTpmQE1mJnS3o2oiA3QFdKzM/dn9sP8mMcLWryB4HZD2uTs5gqMfjYaFzmS2Gis92vOvZgw5xtu5+20iUijgKRMUvPMtMyfOh2c4zS8P2kNyv/TyG86oTG+UoytGyqvBhhKAEuwHxAki5DkMgZZt2bE3dB9s3nrkFUNwNUfYwvI8bcGC4AAY3Y1RnE84xwGV3ufZq8P53H3NDlnEDu1PAiOcYTxyWxT3ycrO23obVG64oksfFH3TtfjW7/dqnOpcCpTr+5xGOZgUZoo9pFb3xwqQyI8ikYAEDCjR7DDajprR7OrSq2CpZ0usQ67EimGwGkFa1go2oVuqxIrMnIcVLP6bOFaDbZRsxDMJPq5HmBs3wOO4xzy/yMBr8rFqqQsmjsLKZR8TgM8UeMaWmglsao9khCozB5ZZG82bFEBTGj9AIc4ZnTpuhpuzMRtzaI/dn0wqA9/dq+8bjIohhicpR9nl8a4aN+D+lHdva4xo1Zx03ZLfzsQNDvv4uVsDqrP3P70NlVz9bA+9ZzcZ1aILilCwwyhyUC7uIocVd8V8a/0OYL0G6F+c4unZpMOUwnBhtLYY74uIKyBnYZuuEEfubO+BTgdGiiH5BCyWyWvBGpro0uxiGD1N1/0LoDc5RMOGYlGthE3jcZ/EeUd588PAbCPglKvYYG/0XLCWCH03SYdQnLL/ikoekG8YWLp314fQaR292CMyQ8dyB2YDtMEDZ7rf/EOLSshGgcKsQjqmWFqoUasRaATmLd1uqmRZyLElsR5RjNPMxkY0Zo2Llsj0C/iSXjtwLSgtmHqS4XVgHs2pQlOFt24CkgB364pQd7AQ//kcE0DKkmqsVo/BkwHPGb+WsnLXxtKUpOO75CVF9d5sBoBURcMCbOOz36VRzrb+VxbazfELEosFV1Ydhrv25fXGQLOe+6rzOVSvoXrkPSStWHtdP8Z/p4eAId7gk0Ea5zr6BqZQ/Bd2wqmkv4m9BW2sME0UEQ3gpDigV00Zg3Y9mplRVpUlr+37tVTy376e6HAuuLJ5mU1zUpql92HZaaG7f0xgEplKHjt8+5bbQLiQDPKzHHL9ltN7D9riK9g6k6GPCvkjk0be5RIZRYsUo9A/Q5RLS6zdpS4uxiD1D7LtsSmJRSwDeVIL3bqFGyaNsyxHtSquVq6lidttM85XpDwnVVUBYBMKqxWsfItmEcK2VfxTbpXRZ6/ziakEaUwidZ9OhmxqwU52LIQTlkzTyd20MaFtQ4br/WcVziQVYfM6lL45ECgar8zkwis2/fvMv9jkix6JmbOSPtLYUjEAl+Zs0wC5Vj73Xc2CfNRaVGfaWUzqyqTAbFbt7m02V+xKBtHJHFBfjzsGsICcWq2zJpGO8rucokTipbLF0qR6n9DwAjG6mnCjutMHQHpf5bmE9LvOHhPS4zJuObhuB6HfH6NiU22H19PGjKT6bWyU88HKr1RiVBwWEKjIwMNPzUIEVgwf1lBGMERjWCeChMwU3CDQaevIWxFBIOyqNBUom1XnrDRtrjt6D+xqxhZi3Wmv9bOG9TSCWcdBuOMZ6yqXTfdtAmriOhvhTeOLtib4Y88FgkHLRP0+PgZ+lvH/K07PDs9Pz8+xodHh2sWXTEdqMst0Psf19gs/Pr/Snlxqv2FuJuXD21iefe+wNJqUPkvapRCywPqJ8kAfisfDzo+jzFjWa9sUyls+Cte1T/M8OogyrL3dbsIZif7tQxYZi2xtu2zSSjKWSdjoMUU7UrlhI4E2vJ4hJhwPyPj4W799Kx+rFWzHBXHsrZkig77PCrDMAbni4/y2+R+KRKstLgRLdA0LZYsDaFZrJfInSj61BQNqQfZXO/qoXpzX6B26MVhMWvO/2Gn/J4gFk7kUyKPS1YxTvL1n4pOtzOJgcsMPB0fHJizUsNtUKHlwP8QFnx2qIyOSH/aVEKVYc5DLbFmlYyzyi9BXgsCn12GAdTN+5KdhGeW8drPIpnJYDv0sgey1a2+sIPjfr4uuaDLp9fy9Ym+0t5cjjub5plDdQLde24obat39wNAGXjNV8bYJoxggeZ4Fqk0GTeRvW3q/zw8Dd1SGtEgztKKWQ0ewWTYfPac6DPBCsCQbB6BF7FuY8qzsJlGYFdmg4F0fZqFVG3Mrsib1zTmV+UX5Ha5OMjP1cWAUgbEMPBTdwjf0Rz+0mFIdv2B093vvAf8Oy8ChnJpQWNcFkNXWhRr9SVCvYPWGMniyJzUHyVszZY4AxfEaV6ZljtiwKbRwTZBzli3aGP4ijuAefAX30OHSr+KGBsl9QtLJZ28rFpLFu+LCCl59xLlOtspcVaSVIP4yHI2ncdP9V3lJefcxoeuUaBw1KZRPeACSZs1uatqoFfYgRH4z3swGH49PDs1RwbDUDcZaen0A/PTwHcSL6AOdHJ1tEGmXDHuCU5jlnP0v31wRDcYIqfjkKc3TXqGGPaHjayoZZQBuRXMQq1RwOYY2j88gnNRBno/HpIEtHfDROj/nhID0fXAzSo+M+DMRFxkeD8y0n9TApdGm55FP2E5hcquqY8FzyBR3RTehe2e2Eok0Nynp7uop7bK/b2VyrtbWENVijTUpvFl2uxaRyLtXW+tClYQ/21nB2y2NkmILtsd8AvmGoSbkptd79G/g6rGPQpJK9j+wqxYW2SXvdUKh3SwX8S92K6dpi9/tbWbemm4iwWnuK5efRiVk2Wffu1cQthfbSwWC3jkzWtWS2WzK7fteu37Xrd+36Xbt+167ftet97Ppduzvv+l27fteu37Xrd+36Xbt+167ftet37fpdu37Xrt+163ft+l27fteu37Xrd+36Xbt+167ftet37fpdu37Xrt+163ft+l27fteu37Xrd+36Xbt+167ftet37fpdu37X3WPSXb9r1+/a9bt2/a5dv2vX79r1u3b9rl2/a9fv2vW7dv2uXb/r/2W/60/RULiv2/X/v8Vw10s+NvTGfRv6myiQu17yS6VB7ttzp0o6VfIDqiS2oVfS6xL3VpQunR+mjY8j27RKK5Kj1/rudmMgRdd9CaKgTkiYY5hB1UWAmFUK36imQqIceAgNV1Fj9IupuMtNqdc18qMP3StWfdjZV+E/91/Bbn/v+4U/kvrT5xs+qe0/pk1xa60gRXO2+WH0WGOhTRU5wFiCi71nEWv8FvQv2oHvQrN6Br7dv0K/kdmlLMqmz3rjKlKxwXGg+OelysFav4NMK4tqT+OmbqSF3gtE3X+5PqNYe6mUj6PH3cQdYGv7yB81na73mAlxm+kCXrHr+v0F9tWNkQ6uE8w4hsiEp2OSsI1iBaIIqUiBkFSsMyG+ya/uxF/ut7tb9wF3+hx2bOurqjR71bL/k/4TG5zT1x8u0/+uMjy0/BS4ILVVI7D2w+1vwd9vaL9GGkpRGwr2+sNlzPIwbq3OpKdjvHdqn8YB2DFOvdMKzQ1ZF7T2/JjGywieWXY1k4qKRBqw9+zc54VMw0ypJv8ZAKaNn18gGtgGjtp103FjRUc5w4bBQX9wkvZP08MT7PkVMOZl7vz30ePvd3dfezGk9ZMWFGRq3+vOL2Dgeb6hU3m5/7OR9ltBPb7GIzk5Ff1+dnh2PsrOji6ORgM+6J+COOXnp3ycjY5XxRMyaWkMsk283EBgHo/GSxbqY/ZvR9jzpqSAWaEdqGzxgnIGWFeCoVtaU7GpvqF8owVfOzaWkKOLfLfckR3P4WttBwZSJyvwY9M82d6Lu3LEleis+qK298C23m/SlrHUAmtKNWxIzGZpYQA+0joHrlagX44ZkdISt6+X0k0JOZeccrPjcZotshwq2xK50rP8FnnfhKRV+DESCNaRRvW0ejGt0/Pe2H1vm6moOjm8GJyLfnZ0dg4nhxdwkfWPxqOLk4tRdnFywU9HSOet+0Ge7CNPHvWTLSeNpxiV+W1qC+DfgNtFSu+LaAjrd7V8T5ZHonhN9RyMkQLX9TnxhmonJnSgLEVZkZm9KXObElekjTdLpCHgHI7gKoncgt3gRdEcahOy1CKoNuYVjLU7WD9zeSc1hNUdoYwLOUuyekjXuWnyKnk5P3zZtH9efm+ouzsUslhIGRRiaXLUPkFQ8EJ6OZEKmJGwWCH7tzDTreP38FKfjcXHuLcNgNfC/GAo87oJZoGPcb8WstJQ1uDqe/TqXmfoYb4ucetXX5ujPqEM96S9ZmzF34hi1DzE78ANaeL2WzUIREoN4IyXbopR/1jd1Es+UUnqj6zgIWxY4K6XoG76WGu1JrtWXLqDglnh0kp6budQNFR8QWSU62TMoG2AhFqh0FDEvQTB2V/Hn8DMZQYNgqi1Eb0khQjWvhS4dxT5ZMBbrF6xYepKYz/kGdqpTjPC45ll7wKnslhHjmaL0FmJHEdb+o/w6iXuk3TBLHsbV2Uf8fU4IRPjC16QosPT/6oJGK+j0NbNuGrA+RJKcRoOg1uSQUs7+F7bIJ0X8jf3QoIgcHDrXhY5lyQxSEJ+D1L7KpkfBn6JhJD0kldNR+Ur9sNZh2O/f0eb/4vJ7+7w5z9LQD/86isqDEMl/CQihaTQ2wZfokmAz6Nd9oJtdGQ2bCO+fkMtGvoqCe8CWfK0fEufd3T2Q+9v7vWsPVd/futdxuqYayvijT+s9POS+bLq3NQzUFcVbuvYpo3x4cvnpJeMgj8102RpGX6DioPf+DuPeWx0uPC370nO1aT0ESAPEv/8Lzg5fmY= +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"; + + + + + + + + + + +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:write` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/put-v-1-time-off-policies-time-off-policy-uuid-add-employees.ParamsDetails.json b/docs/api/put-v-1-time-off-policies-time-off-policy-uuid-add-employees.ParamsDetails.json new file mode 100644 index 000000000..088a4c64e --- /dev/null +++ b/docs/api/put-v-1-time-off-policies-time-off-policy-uuid-add-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":"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/put-v-1-time-off-policies-time-off-policy-uuid-add-employees.RequestSchema.json b/docs/api/put-v-1-time-off-policies-time-off-policy-uuid-add-employees.RequestSchema.json new file mode 100644 index 000000000..d9b44cb5c --- /dev/null +++ b/docs/api/put-v-1-time-off-policies-time-off-policy-uuid-add-employees.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["employees"],"properties":{"employees":{"type":"array","items":{"type":"object","required":["uuid"],"properties":{"uuid":{"type":"string","description":"The UUID of the employee"},"balance":{"type":["string","null"],"description":"The starting balance for the employee"}}}}}}}}}} \ No newline at end of file diff --git a/docs/api/put-v-1-time-off-policies-time-off-policy-uuid-add-employees.StatusCodes.json b/docs/api/put-v-1-time-off-policies-time-off-policy-uuid-add-employees.StatusCodes.json new file mode 100644 index 000000000..dcbb4fe0d --- /dev/null +++ b/docs/api/put-v-1-time-off-policies-time-off-policy-uuid-add-employees.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"}}}},"422":{"description":"Add employees with no employees","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/put-v-1-time-off-policies-time-off-policy-uuid-add-employees.api.mdx b/docs/api/put-v-1-time-off-policies-time-off-policy-uuid-add-employees.api.mdx new file mode 100644 index 000000000..18cb5b962 --- /dev/null +++ b/docs/api/put-v-1-time-off-policies-time-off-policy-uuid-add-employees.api.mdx @@ -0,0 +1,71 @@ +--- +id: put-v-1-time-off-policies-time-off-policy-uuid-add-employees +title: "Add employees to a time off policy" +description: "Add employees to a time off policy. Employees are required to have at least one job to be added to a time off policy. Accepts starting balances for non-unlimited policies" +sidebar_label: "Add employees to a time off policy" +hide_title: true +hide_table_of_contents: true +api: eJztXOlvG7mS/1e4vR+SAGpZkm9/epk42RdgMwkmyc57SII21ayWOO4me0i2bY2h/31RPPrSYcvH7tvZGWCQRE0WfyzWxWKRt5EsQVHDpXjPorOorEx8NY4NLyCRWZaUMucpB937ZZFUFWcxZSyBoszlAkBHg4iBThUvkVp0Fr1mjNRfiZGEEqRCZJYRR2VI3tbfqQKi4PeKK2DYeE6vgFBDcqDaECmA/Can+GEKhDLmGq2h+DpNoTSaaEOV4WJGpjSnIgVNMqmIkCKuRM4LboCRMLvv4rvQqSzhjFysTP3sWnEDF9EguolnlTYy5sLAzDEtNosSorNvERRTQFTRIKJl2W6iox+DSENaKW4W0dm32+iNLEoqFohU69eVmUdn334sfzQDKH1NZ9GZURUMIgW6lEKDjs5uo8lohH90Ga0rSymr8mgQpVIYEAZb0bLMeWpB7P2mseltpNM5FBT/5pBHcvobpMbODm5oUeZuIE8z0Yaayv6CKx6dRfvZ8cFRykYxY6OT+GB0ksXT4/EkPhmfjNLj9GgyhlMLw84x8b0YnOynWTaJT+CYxgcHJxDTyUkajw8mhyf09PR4nO5Hg0jQAjEZ0MYvaDSIvMR5vFfUzQgZnaaqonlSgJlLK72gkrmsVHIt1aVbC99EUQPR2cGo+0tSCW7czyXlLJGVSaRIDKiCCzeKX4TQ65pyFKqkBMUlSxhd6OhsPBpEKVVqIa9AJVa4LAz7aTSICnqTBAL2d+yeLICqVoN2B2ReDojYjX4FSrulzg4PD4+mKeyz40NIJ9OjyZSNx6enI0qPT0/3aTSIuE5oavhV3dvzT4EGkzDLiGg0jkfjaBA12ouC6RcrPRqz8cnpYXyYZifxwWR8HJ+cpCfxZMSO0/3x/oSODqLloBGJo/39FA6PYzqdHscHk0kWn6SHND5AsEdH4xM4otHyx3LQk6pEyJb5+EvE/vwihjLAwPalBthf1uVfaulFleedxc1ornda3WU/BvgFSuwmjJ0vkRmh5Au67I9ZRj7Va6AwCjG8bQVqB6WN4mK2El18Ffz3CghnIAzPOChHvBcPRMu+sOxOF+MGMwfi6RB5LTCuwJ/WjOaE7K5Rfqa24yYiHaG8i9aXRbmR1iACURUYoLQkW/P0MkJV7Iv4XSO5BWsG8f2J77/sa0Sg960hiDKGAVEmVUENmptcUrM6pzkQpIER4PWcp/Pu7Kw4k2ue5w4D2EWioo43iRS2R4gKazkERqgmlNhhBwSGsyH5Hh2MhqPv0bA/A6/Bj5uGqIqpk06Huo1yTm1gjAaFSIWhLVoKJ3EyTM2sIaLBEO6mGBYBAQ/JR5EvSKXBEcHG+aKOc8nL2obhOAPS+Se6Y7QxyOXWJwTX+yd02r7ahb0bLWEte1Mpc6BihZc/ud+JCmOhEvKszc8X2vOMrRWVwF5ZGSsfreGXdxjhRgRsZA+qJQM9za5XCnuSKWRSwWbRDMhmXDjs1rR0wFsbtt4BPE4yC3qzVTpTKkg9MMmULOw+DF0LiqeVS7gxiG+bE3p+kF5RkIUWXUD0P8YlB6Bludu+csvwq6Nhl7Z4WEJ6SN5ZoOTDh/j8PDg158TvVJzpJsUJY6AVCvQYSaXI+KxStWLU8cFOE0krpUAY4nsHB+W2m0PyGdw0v/nviGlWcQY/Xs6NKfXZ3h6TqR7aDfEwlcVe2GHHJV0omef2+17T/d8d6TinC1CvrPnjwq2vHV+QubxGua00Ds01yTjkbEgQbUAZ7ATOC3nUWgmuiZAkl2IGirgIyVq0Vrz0+KXg2pMmNllhdauzRfIDUKXoYoX8f3JMlWSNbH79+v5ck0owhLwmOOAGCr0uGXCfiGw5iHxu5R4xStt7+151YBXgRkv8DzMeLg2EkmaH7sVwPsjqhkkr0Ux7ZdpM/DGIDDc5gsVINP6YZbGPRN3wB6OD1RzLz9KQd7ISbJcUywYS5Lsg5LuwMQ78XoFGtVOgZaVSIEwCSpohcMO1GZIP9BKIrpQ3C0peccx+vT/fw9VFibmiOWfDaLCyim1GglJS2dl319b/vipaG2VjhWpyCdghpQZmUi02jGFb3Skon0tIMezW5HoOfs62O5FpWik9JF8WJU9pni+cEl/CognWtYuIjFF8WhnYK6miBRhQREGOO87gtyzJofOsHvUO0Gws6qNuR8kakUAqLJL2yGdKViUXM/QbzPqLKbgYDdOZFc8ZSdHMFb79nAqWW8sgyEJWaMfqbKLFXIDWdHYPtfsUgDAwlOea0CkGPw1TYzIDAaphpycdUOpKZTT1yVZBQDAEjpxzutJNGgppkswqSUuwvnXWP/IS35aXs1bH1uSiDQpyTZ1+2A5DTCwtG5X+WZrYKln8FgeNPzqp9Zo9mayqZTdNfc3NHO18O639QH3/KkolMd1FpzmQt8Jwswiaj5ym6HnLEgSKuosJp5ItUKjsqvupo0M2lAsvTZroKp1jlH3BhdX8pJb35IrmFVwMiDesgUJm157hXsIuY92zTv5ftDzyWzfMG7c8HPSOLtnCjNO6+yvn2K25LzAY9sI4/C7+sln/L2wWeZ81A3FNLoRV6cSt48WgFRm6CMyLPKHEtSQXvinxi7RwigpWqbxi/MuYRkRhKKNm7TlLF8aboNwKcriiwuAOgCJNLyALr8ne+HFBrE7bYBXNhrdI0xzsJoF4ezzokLD4LKsu3J82Zrqwaxt+wdDqotko+zgDwwop4GNmDfn2uRRVbniZgxuLW9vZUbzw86qyhS87qHTvDIyLWRgZu1HGOH6i+afWSD5bvTr2fXNt7byd56iZ07bYpFK5EzuGqR0rDS0GPyb/6MhYis564458y66sbleViZHbG3bs3LoGmKnftpdt++APXvrjX7mZxx8FxM75RcvNrT542XFNcWnwgOmvNf+/v+ZIaaPD7vLhVzQ+EjOYdu+DO+MtbmNI3hv8uZRacwyxQtVAbYdyuIJc49p5NxIcRW1WopSrtMqpeungdqLGV1F7hmsaRGti4CkVl5gKk5UwCQPMqSSVyHAPzpKSLgoQRm+Jj6dUQzc4XgnWOkHyu0owLmYf7KbXpnLCaKQeza5BB9gVKJ4tEi6s6KaItJSaPymyf2IYgKMSPyp6TgzcpzbfgoLOhuQTFngASeeQXrogBSNWD4fQAjvq4eYp0FwBZYskUHzWCSB7/YBkCiCaeawBWHCNFipRssI8z7Y9kWuRuDTjeoi9IL8D9BfXP6Qpua4raTwuLwmJy+3pGloda+7EtdXebTCv2zU7TTBbVNq0A4v1wMJsM6pN0BaX8t6CcE3jnVn4DhF7GsTSIHouq5zZeiPP2RqzPxxo8IJgdbZ3A8q6yVps63n5VjCXEW40x+6gzJwKsk8KKcxcY0yYVaZS4PCFXBkXrNJGLRINOaQo3YmgPNVJKhkkTWC2EXHTend+/ox9CfZdI473Q+iHeX6AQTThdzxHM5IcEcZnvDY7W+DqAEDfA67mqWu7O9rPPLVY9SrYAw/WYe3X6WGm9H5rXTyIicW69V0pFgwVd7W+9M+JN6DqNNvBcr9unYnWHJvmaMoxslqtANwAvATrXBOfSNnmHXtdd0H7xil3UxjTnA2aOfEYmvR5ALMBc525us+yd9Jcu639+tLNOyXAJ/+TqrzDXm721ttQvaHCJgcp+80ue7v4c+Oyz2XOGVp1/N8BDmGFDUSfMiryxZ91GGFDCuIRoAcKNQsboWGy9Nlg1acPrv52DbABKX3IpgBlVQrYCLV2j+0jrKcXxfeuTXPuhdsu3cphWHxSTCVVGIbXB05PyL+gwxjwk3qo1tkWQliZzBMi+GJzj9wdTtttqS8QCVlgTC73PJoLKxIQmD/CIMwomhqpEtyEbcHWb7m7mtYE3H6viW8cFle+YqUcbZ/D2yhswP+ccWxvjmvcXCgxT2hmQNm9/n2igNVeu/PvUx1Xv1hD70Wjxk1qwtXLe0W5AmH8LEJq8b74O+0fhbxD6U7MoXWzpcEjh2SmpNaY7giDC7CbgW2xjm+xe7gDdo9QRxRhX9CDFOp4fCXM3Sx9mKv7uy1FaTRHwIz6qoQ2Gq/jKfrB/AntzSdHvwXADVGrR6bkHyASj+NJLR1mffzwK1tyf+iGuYX3Rrt0eoPRhR0MT8hobkBtQJt4Ktv37Y8CzrE4DI1bDTgctfSg2lQj1zYA9GArUUjGM27NdoAcsplPCTacGJUri+0AOE52WO4MpQZ15a24XmgDRd0o2PB+bGCtgE5CRdadcYJr/xgD1KXUaLUgNj3pcRb0hhdV0cepK1VSnPMzQn17kwJgFOEx4EqMRyPL1VzKy6rcxstnBBYCrrftQqOX+tUw6p59Nec633pJ93r7EPVy5WH82N4wG0/27QF/26BNc5legqqdv026YanXTsLfo7Y2GLYS4QPhTh6QCyIVFlUZSVQlgnr0p+/GXsW5fT714mgwVfk8k6KdoocHTacHc/ucMmB4lJoYevOc0wpVjMSPRwy9IXa8h81xFfY9RNHlhNO6rvlJp9kRw2CxQhb6EXLZAb1+krrSmIvYMcV+n0lxLGrxxNtO8M4pNJCW/n7Z1M5KipWlqXN220Lzle4PSdXVREggQurBmz1EtAlw45Ufi7ZzXNbjXxjNW2ObQqfpPDFzBXouc5aAdz5R6/yuj8BOC2qsu/Mq8MVV1xpCryjPqT/Mw4g/vwJic/Ov3/ydfAngSPCMrfMjKbVNRqCT/JUrIO/FgHyQV0C+SKy7VOSc2uPItsNs1TbvHDbV25dApHd2ZPNi1BgoSruJxdJjG9IR2tRzVCicGHLIysQyi+13TzBsM/lMUCMVpvYoz++X1qM8f0hKj/K8vdHtAwj77pAdm1Od1F+fPpviTnPrAw9c3Ho0V+3vAdVioKDAFbdH5yF50HQJlzGYTahicdE1Eg2BHr8BljCup5XSYA+TmnPrDRNrt95B+1q5hXButTb62aJ7m0jco67yvAW6V0k5eObpsRHL6GQyiam93wn0OKajIxofj4+PTk7S/en4+HTLpAO1usR759jfHfC5/rX/dFbjjJxzPAsn5+7weUDe4KH0MOpzJaDwt1cfjML1D6bPRdQY2pddlC98tO2O+F8Mgw3736q2HUQZF1zPE5/lRO+KhQTNhZQnzkl7Brk9vpGo2YY0g/dygrl0UUxiSd8VhWmjAEwy3n0VP6DwcJHmFUOL7gihbVGg9YrMpK5E6XFjWCJ9yq5KZ3fXi92QtT5LfK2kmBG/++6P8QcvHyDmziTjrUBVZ/H+4KU7dH1p7waOJ/sHh6/WqNhcCnhwPcQn7B2qIYKSj0edg1KsOMh5ui3TsFZ5WOUqwGHT0WNLdfD4zsxBt8p7m2SVO8LpbeDvk8heC2t7HcGX9s2RpibDrr5bF6zNdpFy0PFcXrfKG2wt17bihmZv/+BsAg4Zqvn6AtHOETzNAPUkvSdzMay+2+f7hvd3h3YUH2gHK4WKprd4Ovxu+zxoB4I1wcCI/URe+D4vmpsEQuKF3oIbE1rp4FWmVPP0mXfn1Jb5Bfsdok0bZOy2hRUATLf8kN8Grok/At+ufXH4htnZzzsz/FcsCw92ZmaPRZUPWVVTqDGqHdUKumfM0dtIYnOSvJdzdggwh09sZXpqiK7KUipDmA2O8kX/hN+bozAHdwL65HnoXvFDC7IbkPVOs7aVi3GlTfKwgpd32JeIXtnLirVi1j9kyZQrM999lHN7rp4R273eGnsPassmXABobc79jmnrWtCHBPE+eD+eUDg4Gh/HjNLT+ADYcXxyCKN4fALskI0ATvYPt5g0dxt7901pnlPyjps/ZpiKY7bi1z6SgNs1ggprZXjeOw3DFxKk2yLWR82eCWs2Ok/MqQk7nmZHkzSe0mkWH1B8wWZyOon3D0YwYacpnU5OtnDqYVbovaaczslPoHIuajb5JyCQRdf+9sr9OBRiahDaxdN13mN73c7mWq2tJaw+Gm1Lervoci2SenMpttaHdpo9eLeGvXs7RoJHsAPyK8AlppqEmdurd/+0TxCsoA5Jk9r2PvFWKQy0zdrLlkPtXpzs3FaMNxS7L21a2IePDrV/VOkf8X/Yp+tef3of/1edD+NY1T8HymxYsPL2XH2fIDxSMxlNDuPRUTw+dI8KZLTK8XWG1u8rTwydg3vIw99xQ/MYI/sYef3pfX2xn2otU27PU21Ybu+oYQO8lmcvqAlcU95UDQ1cm9aNzxeafCu4sCdxLdo7Xo+kJY9brxZ4gnHr51cIA+/auX1ReLZqzQuMgcUltW5m9c69vSK+8W2gJpPoLslsWqAlPk5o6AxXPOo+3+Svc3m3/JNkdpfQJ/zgRwk718faV/h793m2PJFwrzuhlpkrZO93e6fP56bka80DCfd6O6P/duWGlxLCFWxdAr0EqhexvbXpZeVjltUr1G2FAhXjmy6KM8spxt62iu/gxoDQdouDCu4M0sa3L+2Fo+ruNzBRkruk3CuXdX+UlHaj/qzqhiuzW9+rO8umd2e2KNjNA2+VffoCdeks2rsa7628Bbp3u04Ll3v9h1Bt9YM3kJXK0Qh6E0FL7ixEzKCwZmJFns6hkL0Vc/Ri/9hdId3ri+sJr6X5Sdl06SaaJX5ett4p/Ywa6ZRgzWultUbg4MGw23dPgCpr6vuXXC2J2N7HIrQyc9yEh8PGQfTZVog8ZgRHYcMAy0GEluaXxka9dRe2eqajeQGz1tFaf2tT6LI1rtgg+E7r+tAlRO2HFFtOaxChj9Ifs8+grngKrXVr3IW9gLxnG+4xnAiaotj+G0+GtO+6cmkO8lQW9sDM4nihyVuviCTUaKG3YjKtivAS37/5Zw2oS4B5F3MeRiW/4NVzn+Vwh0koeP7r3xo5swGB1KagokXn7pd/+7O4bVzEn+/dYC/KBm7MXplTbmXeau+ttzbfoivMQK/QiAbR2Qa/3zU5P7D8WhukdHuL0c9XlS+X+PPvFWD8+O0HWkBlK8aspDNuIz1Wv/K4cT1e/uLZ+4rcHVKsnWvwyGLRssORv4G6PrBxFeUuctwN7p86HtzAYMfI9TF4ze/GTb5xzIq/dBz4amjW9HDasbVt25N++voFjaePBgtpwwxFrzHqotdu8UMaFcNF/O02yqmYVW4/40iidaFdf1Dbf/+X1qsEXfG6vXUtvshLEMtlI234b7v3Wf430ohOOw== +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"; + + + + + + + + + + +Add employees to a time off policy. Employees are required to have at least one job to be added to a time off policy. Accepts starting balances for non-unlimited policies + +scope: `time_off_policies:write` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/put-v-1-time-off-policies-time-off-policy-uuid-balance.ParamsDetails.json b/docs/api/put-v-1-time-off-policies-time-off-policy-uuid-balance.ParamsDetails.json new file mode 100644 index 000000000..088a4c64e --- /dev/null +++ b/docs/api/put-v-1-time-off-policies-time-off-policy-uuid-balance.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/put-v-1-time-off-policies-time-off-policy-uuid-balance.RequestSchema.json b/docs/api/put-v-1-time-off-policies-time-off-policy-uuid-balance.RequestSchema.json new file mode 100644 index 000000000..05b0fbeb6 --- /dev/null +++ b/docs/api/put-v-1-time-off-policies-time-off-policy-uuid-balance.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["employees"],"properties":{"employees":{"type":"array","items":{"type":"object","required":["uuid","balance"],"properties":{"uuid":{"type":"string","description":"The UUID of the employee"},"balance":{"type":"string","description":"The new balance for the employee"}}}}}}}}}} \ No newline at end of file diff --git a/docs/api/put-v-1-time-off-policies-time-off-policy-uuid-balance.StatusCodes.json b/docs/api/put-v-1-time-off-policies-time-off-policy-uuid-balance.StatusCodes.json new file mode 100644 index 000000000..097eb79e7 --- /dev/null +++ b/docs/api/put-v-1-time-off-policies-time-off-policy-uuid-balance.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"}}}},"422":{"description":"Unlimited policy balance update","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/put-v-1-time-off-policies-time-off-policy-uuid-balance.api.mdx b/docs/api/put-v-1-time-off-policies-time-off-policy-uuid-balance.api.mdx new file mode 100644 index 000000000..b566c1eea --- /dev/null +++ b/docs/api/put-v-1-time-off-policies-time-off-policy-uuid-balance.api.mdx @@ -0,0 +1,71 @@ +--- +id: put-v-1-time-off-policies-time-off-policy-uuid-balance +title: "Update employee time off balances" +description: "Updates time off hours balances for employees for a time off policy." +sidebar_label: "Update employee time off balances" +hide_title: true +hide_table_of_contents: true +api: eJztXOtzGzeS/1dwcx9sV3Eoknrr0zmWfeuqdeyK7c1u2a4ROOghEc0AEwAjiVHxf79qPObFh0Q99vb2kqpUoiHQ+KHRLzQauI1kCYoaLsV7Fp1FZWXiq3FseAGJzLKklDlPOejel0VSVZzFU5pTkUI0iBjoVPES6URn0deSUQOaYCcis4zMZaU08c01yaQiUJS5XID/izZt3QDD7+K70Kks4YxcrMA5u1bcwEU0iG7iWaWNjLkwMHMTic2ihOjsWwTFFBgDFv0YRBrSSnGziM6+3UZvZFFSsXidpqD168rMo7NvP5Y/GmpKX9NZdGZUBYNIgS6l0KCjs9toMhrhf7rz1ZWllFV5NIhSKQwIg61oWeY8taD2ftPY9DbS6RwKiv/nYEZy+hukxk4FbmhR5m4gTzPRhprKfkGWR2fRfnZ8cJSyUczY6CQ+GJ1k8fR4PIlPxiej9Dg9mozh1MKwc0x8LwYn+2mWTeITOKbxwcEJxHRyksbjg8nhCT09PR6n+9EgErRATAa08QsRDSK/5B7vFXUzigYRTVNV0TwpwMylFR9QCa51ci3VJbBWE0UNRGcHo+6XpBLcuM8l5SyRlUmkSAyoggs3il+E0OuacsPFLClBcckSRhc6OhuPBlFKlVrIK1BJzgtuLAz702gQFfQmCQTsd+yeLICqVoN2B2ReDojYjX4FSrulzg4PD4+mKeyz40NIJ9OjyZSNx6enI0qPT0/3aTSIuE5oavhV3dvzT4EGkzDLiGg0jkfjaBDVamAF0y9WejRm45PTw/gwzU7ig8n4OD45SU/iyYgdp/vj/QkdHUTLQSMSR/v7KRwex3Q6PY4PJpMsPkkPaXyAYI+OxidwRKPlj+WgJ1WJkEkLwJ8i9m8vYigDDGxfaoD9aV3+pZZeVHneWdyM5nqn1V32XfEvUGI3Yex8icwIJV/Q1X7MMvKpXgOFYYDhbStQOyhtFBezVScv+O8VEM5AGJ5xUI54z49Hy76w7E4XAwQzB+LpEHktuJjZT2tGc0J21yg/U9txE5GOUN5F68ui3EhrEIGoCoxGWpKteXoZoSr2RfyukdyCNYP4/sT3X/Y1ItD71hBEGcOAKJOqoAbNTS6pWZ3THAjSINSQ6zlP593ZuYDumue5wwAuihN1WEeksD18NEdqOQRGqCaU2GEHBIazIfkeHYyGo+/RsD8Dr8GPm4aoiqmTToe6jXJONTGSoEEhUpEpELQUTuJkmJpZQ0SDIdxNMSwCAh6SjyJfkEqDI4KN8wUJcSt5WdswHGdAOn+iO0Ybg1xu/YTgen9Cp+2rXdi70RLWsjeVMgcqVnj5k/tOVBgLlZBnbX6+0J5nbK2oBPbKylj5aA2/vMMINyJgI31QLRnoaXa9UtiTTCGTCjaLZkA248Jht6alA97asPUO4HGSWdCbrdKZUkHqgUmmZEGkAIKuBcXTyiXcGMS3zQk9P0ivKMhCiy4g+qdxyQFoWe62r9wy/Opo2KUtHpaQHpJ3Fij58CE+Pw9OzTnxOxVnuklxwhhohQI9RlIpMj6rVK0YdXyw00TSSikQhvjewUG57eaQfAY3zW/+d8Q0qziDHy/nxpT6bG+PyVQP7YZ4mMpiL2yn45IulMxz+/te0/0/Hek4pwtQr6z548Ktrx1fkLm8RrmtNA7NNck45GxIEG1AGewEzgt51FoJromQJJdiBoq4CMlatFa89Pil4NqTRncgpNWtzhbJD0CVoosV8n/l2iCja9n8+vX9uSaVYLAmx4GBvIFCr0sG3CciWw6ikIG5O0Zpe2/fqw6sAtxoif9gxuP3iitgKGl26F4M54Osbpi0Es20V6bNxB+DyHCTI1iMROOPWRb7SNQNfzA6WM2x/CwNeScrwXZJsWwgQb4LQr4LG+PA7xVoVDsFWlYqBcIkoKQZAjdcmyH5QC+B6Ep5s6DkFWfAyPvzPVxdlJgrmnM2jAYrq9hmJCgllZ19d23991XR2igbK1STS8AOKTUwk2qxYQzb6k5B+VxCimG3Jtdz8HO23YlM00rpIfmyKHlK83zhlPgSFk2wrl1EZIzi08rAXkkVLcCAIgpy3HEGv2VJDp1n9ah3gGZjUR91O0rWiARSYZG0Rz5Tsiq5mKHfYNZfTMHFaEaSacVzRlI0c4VvP6eC5dYyCLKQFdqxOrtoMRegNZ3dQ+0+BSAMDOW5JnSKwU/D1JjMQIBq2OlJB5S6UhlNHVJ0eoIhcOSc05Vu0lBIk2RWSVqC9a2z/pGX+La8nLU6tiYXbVCQa+r0w3YYYmJp2aj0z9LEVsnitzho/NFJrdfsyWRVLb8KG1IBCzY4mKfKppEfru9fRakkprvoNAfyVhhuFkHzkdMUPW9ZgkBRdzHhVLIFCpVddT91dMiGcuGlSRNdpXOMsi+4sJqf1PKeXNG8gosB8YY1UMjs2jPcS9hlrHvW2feLlkd+64Z545aHg97RJVuYcVp3f+UcuzX3BQbDXhiH38WfNuv/hc0i77NmIK7JhbAqnbh1vBi0IkMXgXmRJ5S4luTCNyV+kXDfZOYErFJ5xfiXMY2IwlBGzdpzli6MN0G5FeRwRYXBHQBFml5AFl6TvfHjglidtsEqmg1vkaY52E0C8fZ40CFh8VlWXbj/2pjpwq5t+IKh1UWzUfZxBoYVUsDHzBry7XMpqtzwMgc3FupRT/HC51VlC7/soNK9MzAuZmFk7EYZ4/gTzT+1RvLZ6tWx75tra+ftPEfNnLbFJpXKndgxTO1YaWgx+DH5R0fGUnTWG3fkW3ZldbuqTIzc3rBj59Y1wEz9tr1s2wd/8NIf/8rNPP4oIHbOL1pubvXBy45rikuDB0x/rvn//TVHShsddpcPv6LxkZjBtHsf3BlvcRtD8t7g51JqzTHEMpLM6RWQ2g7lcAW5xrXzbiQ4itqsRClXaZVT9dLB7USNr6L2DNc0iNbEwFMqLjEVJithEgaYU0kqkeEenCUlXRQgjN4SH0+phm5wvBKsdYLkd5VgXMw+2E2vTeWE0Ug9ml2DDrArUDxbJFxY0U0RaSk1f1Jk/8AwAEclflT0nBi4T22+BQWdDcmnHKgGks4hvXRBCkasHg6hBXbUw81ToLkCyhZJoPisE0D2+gHJFEA081gDsOAaLVSiZIV5nm17ItcicWnG9RB7QX4H6C+uf0hTck2C2/W4vCQkLrena2h1rLkT11Z7t8G8NgSX1NhccRPMFpU27cBiPbAw24xqE7TFpby3IFzTeGcWvkPEngaxNIieyypniJl6ztaY/eFAgxcEq7O9G1DWTdZiW8/Lt4K5jHCjOXYHZeZUkH1SSGHmGmPCrDKVAocv5Mq4YJU2apFoyCFF6U4E5alOUskgaQKzjYib1rvz82fsS7DvGnG8H0I/zPMDDKIJv+M5mpHkiDA+47XZ2QJXBwD6HnA1T13b3dF+5qnFqlfBHniwDmu/UA4zpfdb6+JBTCzWre9KtV5IsdT60j8n3oCq02wHy/26dSZac2yaoynHyKrqpnw46A3AS7DONfGJlG3esdd1F7RvnHI3hTHN2aCZE4+hSZ8HMBsw15nu+yx7kxbfee3f1hWUVMH9JcBn1xKfXXuIt96G6g0VNjlI2W922ds1nxuXfS5zztCq478OcAgrbCD6lFGRL/6swwgbUhCPAD1QqFnYCA2Tpc8Gqz59sJH0OmADUvqQTQHKqhSwEWrtHttHWE8viu9dm+bcC7ddupXDsPikmEqqMAyvD5yekH9BhzHgJ/VQrbMthLAymSdE8MXmHrk7nLbbUl8gErLAmFzueTQXViQgMH+EQZhRNDVSJbgJ24Kt33J3Na0JuP1eE984LK58xUo52j6Ht1HYgP8549jeHNe4OW2osnE7zQwou9e/TxSw2mt3/n2q4+oXa+i9aNS4SU3YPCXxinIFwvhZhNTiffF32j8KeYfSnZhD62ZLg0cOyUxJrTHdEQYXYDcD22Id32L3cAfsHqGOKMK+oAcp1PH4Spi7WfowV/cXW4rSaI6AGfVVCW00XsdT9IP5E9qbT45+C4AbolaPTMk/QCQex5NaOsz6+OFXtuT+0A1zC++Ndun0BqMLOxiekNHcgNqANvFUtu/bHwWcY3EYGrcacDhq6UG1qUburrN4sJUoJOMZt2Y7QA7ZzKcEG06MypXFdgAcJzssd4ZSg7ryVlwvtIGibhRseD82sFZAJ6Ei6844wbV/jAHqUmq0WhCbnvQ4C3rDi6ro49SVKinO+Rmhvr1JATCK8BhwJcajkeVqLuVlVW7j5TMCCwHX23ah0Uv9ahh1z76ac51vvaR7vX2IernyMH5sr3iNJ/v2gL9t0Ka5TC9B1c7fJt2w1Gsn4e9RWxsMW4nwgXAnD8gFkQqLqowkqhJBPfrTd2Ov4tw+n3pxNJiqfJ5JUcZaV+AeNJ0ezO1zyoDhUWpi6M1zTitUMRI/HjH0htjxHjbHVdj3EEWXE07ruuYnnWZHDIPFClnoR8hlB/T6SepKYy5ixxT7fSbFsajFE287wTun0EBa+vtlUzsrKVaWps7ZbQvNV7o/JFVXEyGBCKkHb/YQ0SbAjVd+LNrOcVmPf2E0b41tCp2m88TMFei5zFkC3vlErfO7PgI7Laix7s6rwBdXXWsIvaI8p/4wDyP+/AqIzc2/fvMX8iWAI8Ezts6PpNQ2GYFO8leugLwXA/JBXgH5IrHuUpFzao8j2w6zVdu8c9hUb18Ckd7Zkc2LUWOgKO0mFkuPbUhHaFPPUaFwYsghKxPLLLa/e4Jhm8lnghqpMLVHeX6/tB7l+UNSepTn7Y1uH0DYd4fs2JzqpP716bMp7jS3PvDAxa1Hc9X+HlAtBgoKXHF7dB6SB02XcBmD2YQqFhddI9EQ6PEbYAnjelopDfYwqTm33jCxdusdtK+VWwjnVmujny26t4nEPeoqz1uge5WUg2eeHhuxjE4mk5ja+51Aj2M6OqLx8fj46OQk3Z+Oj0+3TDpQq0u8d4793QGf61/7T2c1zsg5x7Nwcu4OnwfkDR5KD6M+VwIKf3v1wShc/2D6XESNoX3ZRfnCR9vuiP/FMNiw/61q20GUccH1PPFZTvSuWEjQXEh54py0Z5Db4xuJmm1IM3gvJ5hLF8UklvRdUZg2CsAk491X8QMKDxdpXjG06I4Q2hYFWq/ITOpKlB43hiXSp+yqdHZ3vdgNWeuzxNdKihnxu+/+GH/w8gFi7kwy3gpUdRbvD166Q9eX9m7geLJ/cPhqjYrNpYAH10N8wt6hGiIo+XjUOSjFioOcp9syDWuVh1WuAhw2HT22VAeP78wcdKu8t0lWuSOc3gb+PonstbC21xF8ad8caWoy7Oq7dcHabBcpBx3P5XWrvMHWcm0rbmj29g/OJuCQoZqvLxDtHMHTDFBP0nsyF8Pqu32+b3h/d2hH8YF2sFKoaHqLp8PfbZ8H7UCwJhgYsT+RF77Pi+YmgZB4obfgxoRWOniVKdU8febdObVlfsF+h2jTBhm7bWEFANMtP+S3gWvij8C3a18cvmF29uedGf4rloUHOzOzx6LKh6yqKdQY1Y5qBd0z5uhtJLE5Sd7LOTsEmMMntjI9NURXZSmVIcwGR/mif8LvzVGYgzsBffI8dK/4oQXZDch6p1nbysW40iZ5WMHLO+xLRK/sZcVaMesfsmTKlZnvPsq5PVfPiO1eb429B7VlEy4AtDbnfse0dS3oQ4J4H7wfTygcHI2PY0bpaXwA7Dg+OYRRPD4BdshGACf7h1tMmruNvfumNM8pecfNHzNMxTFb8WsfScDtGkGFtTI8752G4QsJ0m0R66Nmz4Q1G50n5tSEHU+zo0kaT+k0iw8ovmAzOZ3E+wcjmLDTlE4nJ1s49TAr9F5TTufkJ1A5FzWb/BMQyKJrf3vlfhwKMTUI7eLpOu+xvW5nc63W1hJWH422Jb1ddLkWSb25FFvrQzvNHrxbw969HSPBI9gB+RXgElNNwszt1bt/2CcIVlCHpElte594qxQG2mbtZcuhdi9Odm4rxhuK3Zc2LezDR4faP6r09/i/7dN1rz+9j/9W58M4VvXPgTIbFqy8PVffJwiP1ExGk8N4dBSPD92jAhmtcnydofV95Ymhc3APefg7bmgeY2QfI68/va8v9lOtZcrteaoNy+0dNWyA1/LsBTWBa8qbqqGBa9O68flCk28FF/YkrkV7x+uRtORx69UCTzBufX6FMPCundsXhWer1jyBGFhcUutmVu/c2yviG98GajKJ7pLMpgVa4uOEhs5wxaPu803+Opd3yz9JZncJfcIPfpSwc32sfYW/d59nyxMJ97oT6pkZ3jNYGeB+93j6HG+Kv3Z8KgETk9tfSQjXr3UJ9BKoXsT2xqaXk49ZVq9OtxUKU4zvuSjOEITLSP9Uv6QJNwaEtvsb1G5njTa+cmlvG1W91y5RZrv93HuWdWOUiXaj/hzqhitzWd+rO6emd3duKMPNW26VfeUC1eYs2rsa76288bl3u07hlnvNo6O2xMFbwUrlaOm8HaAld2YgZlBYW7CyyudQyN7SOHqxf9GukO6JxfWE19L8pGxOdBPNEn9eth4j/Yxq5+R7zZOktZzi4MF628dNgCprz/s3WS2J2F66IrQyc9xphxPFQfTZloE8ZgRHYcMAy0GE5uSXxhC9dbeyevaheeay1r9aNWt751IyrqIgOEjr39DuR+3XElueaRChI9Ifs8+grngKrXVrfIK9ZbxnG+4xnAhamdj+jcc/2ndduRkHeSoLeypmcbzQ5K1XOBIKsdAlMZlWRXhu7z/82wXUZbm8HzkPo5Jf8H65T2W4EyMUPP/rfzVyZr2+1KagokXHvbLb1Nz2n3fR/UncNm7gn/lEr5cxAzdmr8wpt8Jo1erWG4Bv0RXmf1doRIPobIPXbTmKudQGadzeYtTxVeXLJX7+vQKM2779QHukbKWWFT7GbYTF6tcVN/Lo5S/eQb0id7vytbMMnlAsWlYx8jc/1wcUrpLbRWy7wf23jsM2MNgxcn3sW/O7cVpvHLPiLx3fuRoSNT3QXJZma9u2W/v09QsKp4/CCmldvKLXGO3Qa7f4IX2JYRp+u41yKmaV20c4kqjwtGuia5Ps/6f1GkBXvG5vXYsv8hLEctlIG/5t9xzL/wFKOO5u +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"; + + + + + + + + + + +Updates time off hours balances for employees for a time off policy. + +scope: `time_off_policies:write` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/put-v-1-time-off-policies-time-off-policy-uuid-deactivate.ParamsDetails.json b/docs/api/put-v-1-time-off-policies-time-off-policy-uuid-deactivate.ParamsDetails.json new file mode 100644 index 000000000..088a4c64e --- /dev/null +++ b/docs/api/put-v-1-time-off-policies-time-off-policy-uuid-deactivate.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/put-v-1-time-off-policies-time-off-policy-uuid-deactivate.RequestSchema.json b/docs/api/put-v-1-time-off-policies-time-off-policy-uuid-deactivate.RequestSchema.json new file mode 100644 index 000000000..c96bcede2 --- /dev/null +++ b/docs/api/put-v-1-time-off-policies-time-off-policy-uuid-deactivate.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/api/put-v-1-time-off-policies-time-off-policy-uuid-deactivate.StatusCodes.json b/docs/api/put-v-1-time-off-policies-time-off-policy-uuid-deactivate.StatusCodes.json new file mode 100644 index 000000000..344033c5e --- /dev/null +++ b/docs/api/put-v-1-time-off-policies-time-off-policy-uuid-deactivate.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"}}}},"422":{"description":"Policy has pending time off requests","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/put-v-1-time-off-policies-time-off-policy-uuid-deactivate.api.mdx b/docs/api/put-v-1-time-off-policies-time-off-policy-uuid-deactivate.api.mdx new file mode 100644 index 000000000..0b2a0e81f --- /dev/null +++ b/docs/api/put-v-1-time-off-policies-time-off-policy-uuid-deactivate.api.mdx @@ -0,0 +1,71 @@ +--- +id: put-v-1-time-off-policies-time-off-policy-uuid-deactivate +title: "Deactivate a time off policy" +description: "Deactivate a time off policy" +sidebar_label: "Deactivate a time off policy" +hide_title: true +hide_table_of_contents: true +api: eJztXOtvGzmS/1d4fR+SAGpZkt/+dNk4uTVwmRiT5OYWTtCmmtUS191kD8m2rTH8vx+Kj37pYcuPu729GWCQRE0WfyzWi8Ui7yIGOlW8NFyK6CQ6BZoafk0NEEoML4DILCOlzHm6+CF+CJ3KEk7IJX5KZJYl9hMHfXKjuIHLaBDdxrNKGxlzYWCmKBKOzaKE6OQigmIKjAGLfg4iWYL7esaik6isTHw9jpfo9n5ZJFXFWcxqmNEg0pBWiptFdHJxF32QRUnF4n2agtbvKzOPTi5+3v9sYCl9Q2fRiVEVDCIFupRCg45O7qLJaIR/dBmiK0spq/JoEKVSGBAGW9GyzHlq8e/8XWPTu0incygo/s3NN5LTv0NqLE/glhZl7gbyNBNtqKnsLzip6CTazQ73DlI2ihkbHcV7o6Msnh6OJ/HR+GiUHqYHkzEcWxh2jonvxeBoN82ySXwEhzTe2zuCmE6O0ni8N9k/osfHh+N0NxpEghaIyYA2fkGjQeSZ6vFeUzejaBDRNFUVzZMCzFzaBQKVzGWlkhuproC1mihchpO9UfeXpBLcuJ9LylkiK5NIkRhQBRduFL8IodcN5YaLWVKC4pIljC50dDIeDaKUKrWQ16CSnBfcWBj202gQFfQ2CQTs79g9WQBVrQbtDsi8HBCxG/0alHZLne3v7x9MU9hlh/uQTqYHkykbj4+PR5QeHh/v0mgQcZ1Ywat7e/4p0GASZhkRjcbxaBwNIijKXC4A1/yiXuL0YMzGR8f78X6aHcV7k/FhfHSUHsWTETtMd8e7Ezrai+4HjUgc7O6msH8Y0+n0MN6bTLL4KN2n8R6CPTgYH8EBje5/3g96UpUImbQA/Cli//QihjLQ2EX2p3X5h1p6UeV5Z3EzmuutVtcub9s1/QoldhPGzpfIjFDyDV32lywj5/UaKHS0hretQO2gtFFczKI+5e+C/14B4QyE4RkH5Yj34oHovi8s29PNpCJmDsTTIfJGcDGzP60YzQnZQ6P8Qm3HdUQ6QvkQrW+Lci2tQQSiKjCsaUm25ulVhKrYF/GHRnIL1gzi+xPf/76vEYHeRUMQZQwjq0yqgho0N7mkZnlOcyDKRniG3Mx5Ou/OzoozueF57jCAXSQqSBBHIoXt4dgwJLUcAiNUE0rssAMCw9mQ/Ij2RsPRj2jYn4HX4OdNQ1TF1EmnQ91GOaeaGEnQoBCpyBQIWgoncTJMzawgosEQ7qYYFgEBD8kXkS9IpcERwcb5goRAlbytbRiOMyCdf6I7RhuDXG59QnC9f0Kn7btt2LvWEtayN5UyByqWePkX9ztRYSxUQp61+flGe56xlaIS2CsrY+WjNfz9A0a4EQG7ZQDVkoGeZtcrhT3JFDKpYL1oBmQzLhx2a1o64K0NW+0AnieZBb3dKJ0pFaQemGRKFkQKIOhaUDytXMKtQXybnNDrg/SKgiy06AKi/zEuOQAty932lRuGXx4Nu7TFwxLSQ/LJAiWfP8enp8GpOSf+oOJM1ylOGAOtUKDHSCpFxmeVqhWjjg+2mkhaKQXCEN87OCi33RySr+CmeeG/I6ZZxRn8fDs3ptQnOztMpnpoN8TDVBY7YV8el3ShZJ7b7ztN9391pOOcLkC9s+aPC7e+dnxB5vIG5bbSODTXJOOQsyFBtAFlsBM4L+RRayW4JkKSXIoZKOIiJGvRWvHS85eCa08a3YGQVrc6WyQ/AFWKLpbI/wfXBhldy+b372enmlSCIeQVwQE3UOhVyYDHRGT3g2hKcyrSx8Qobe/te9WBVYAb3eN/mPH4veIKGEqaHboXw/kgqxsmLUUz7ZVpM/HnIDLc5AgWI9H4S5bFPhJ1w++N9pZzLL9IQz7JSrBtUixrSJAfgpAfwsY48HsFGtVOgZaVSoEwCShphsAt12ZIPtMrILpS3iwoec0ZMHJ2uoOrixJzTXPOhtFgaRXbjASlpLKz766t/31ZtNbKxhLV5AqwQ0oNzKRarBnDtnpQUL6WkGLYrcnNHPycbXci07RSeki+LUqe0jxfOCW+gkUTrGsXERmj+LQysFNSRQswoIiCHHecwW9ZkkPnWT3qLaDZWNRH3Y6SNSKBVFgk7ZHPlKxKLmboN5j1F1NwMZqRZFrxnJEUzVzh28+pYLm1DIIsZIV2rE5TWswFaE1nj1C78wCEgaE814ROMfhpmBqTGQhQDTs96YBSVyqjqUOKTk8wBI6cc7rSTRoKaZLMKklLsC466x95iW/Ly0mrY2ty0RoFuaFOP2yHISaW7huV/kWa2CpZ/BEHjb84qfWaPZksq+V54wRLEKwTf/nR9dOV/rsolcScF53mQD4Kw80iqD+ym+LIZQkC5d0FhlPJFihZduk9AvTKhnLhRUoTXaVzDLUvubDqn9RCn1zTvILLAfHWNVDIrAAw3FDYtax71knuy5Zb/uiG+eDWiIPe0i9bmHFad3/nvLu1+QVGxF4ihz/En4br/4XhImdZMxDX5FJYvU7cOl4OWuGhC8O8yBNKXEty6ZsSv0i4eTJzAlapvGL8w9hHRGEoo2blYUsXxoeg3ApyuKbC4DaAIk0vIAuvyd4CckGsTtuIFc2Gt0jTHOxOgXijPOiQsPgsqy7dnzZwurRrG37B+Oqy2S37YANjCyngS2at+ea5FFVueJmDGwv1qKd44edlZQtftlDp3kEYF7MwMnajjHH8RPPz1kg+Zb089mMTbu3kneeomdO22KRSuWM7hvkdKw0tBj8nCenIWIrOeuO2fMPWrG5XlYmRmxt27NyqBpiu37ShbTviz17649+4mcdfBMTO+UX361t99rLjmuLS4CnTn2v+f3/NkdJah93lw29ofCSmMe0GCLfHG9zGkJwZ/LmUWnMMsYwkc3oNpLZDOVxDrnHtvBsJjqI2K1HKVVrlVL11cDuh47uoPcMVDaIVgfCUiivMh8lKmIQBJlaSSmS4EWdJSRcFCKM3BMlTqqEbIS8Fa51I+VNlA9fPdudrQ9kwGqlHs2vQAXYNimeLhAsruikiLaXmL4rsbxgG4KjEj4qeE6P3qU26oKCzITnPgWog6RzSKxekYMTq4RBaYEc9XD8FmiugbJEEiq86AWSvH5BMAUQzjxUAC67RQiVKVpjs2bQxci0Sl2tcDbEX5HeA/ur6h1wl1yS4XY/LS0LiEny6hlbHmltxbbl3G8x7Q3BJjU0YN8FsUWnTDixWAwuzzag2QVtc3nsDwhWNt2bhJ0TsaRBLg+i5rHKGmKnnbI3ZnxA0eEGwOuW7BmXdZCW21bz8KJhLCzeaY3dQZk4F2SWFFGauMSbMKlMpcPhCwowLVmmjFomGHFKU7kRQnuoklQySJjBbi7hpvT0/f8G+BPuuEMfHIfTDvD7AIJrwOx6mGUkOCOMzXpudDXB1AKAfAVfz1LXdHu1XnlqsehnsngfrsPbr0TBd+ri1Lp7ExGLV+i4VxQmrUcBqfekfFq9B1Wm2heV+3zoYrTk2zdGUY2RV46mPR9cA91mhpE4GrYfa67oN2g9OuZvqmOaA0MzXZ6bWYK7T3Y9Z9iY3vvXafwxdCVXweAnwJwBJVT5gL9d7602oPlBhM4SU/d0uuxtNb172ucw5Q6uO/zvAIaywgehLRkW+ArQOI2xIQTwC9EChcGEtNMyYvhqs+gjCRtKrgA1I6UM2BSirUsBaqLV7bJ9jvbwonrk2zeEXbrt0K4dh8UkxlVRhGF6fOr0g/4IOY8BP6qFaB1wIYWkyL4jgm809cndCbbelvkokZIExudzzaC6sSEBg/giDMKNoaqRKcBO2AVu/5fZqWhNw+70mvnFYXA2LlXK0fQ5vo7AB/2vGsb05rnBz2lBl43aaGVB2r/+YKGC51/b8O6/j6jcr6L1p1LhJTdg8JfGKcg3C+FmE1OJj8XfaPwt5h9KDmEPrZkuDRw7JTEmtMd0RBhdgNwObYh3fYvtwB+weoY4owr6gBykU8/hymIdZ+jRX91dbj9JojoAZ9aUJbTRex1P0g/kL2ptzR78FwA1Rq0em5B8gEo/jRS0dZn388Etbcn/ohrmFM6NdOr3B6MIOhidkNDeg1qBNPJXN+/ZnAedYIYbGrQYcjlp6UG2qkWsbAHqwlSgk4xm3ZjtADtnMlwQbTozKpcV2ABwnOyx3hlKDuvZWXC+0gaJuFGx4PzawVkAnoSzrwTjBtX+OAepSarRaEJue9DgLesuLqujj1JUqKc75FaF+vE0BMIrwGHAlxqOR5Wou5VVVbuLlKwILAdfHdrXRW/1uGHXPvppznYte0r3ePkS9XHkYP7Y3qcaTXXvK3zZo01ymV6Bq52+TbljvtZXw96itDIatRPhAuJMH5IJIhZVVRhJViaAe/em7sZdxbp5PvTgaTFW+zqQoa0JT/bTp9GBunlMGDI9SE0NvX3NaoZSR+PGIobfEjve0OS7DfoQoupxwWhc3v+g0O2IYLFbIQj9DLjugV09SVxpzEVum2B8zKY5FLZ542wk+OIUG0r2/ZDa1s5JiaWnqnN2m0Hyp+1NSdTUREoiQevBmDxGtA9x45eei7RyX9fgXRvPW2KbQaTpPzFyBnsucJeCdT9Q6v+sjsNOCGuv2vAp8cSW2htBrynPqD/Mw4s+vgdjc/PsPfyXfAjgSPGPr/EhKbZMR6CR/4wrImRiQz/IayDeJxZeKnFJ7HNl2mK0C563Dpnr7Eoj0zo5sXowaA0VpN7FYf2xDOkKbeo4KhRNDDlmZWGax/e4Jhm0mnwlqpMLUHuX549J6lOdPSelRnrc3un0AYd8dsmNzqpP668tnU9xpbn3ggYtbj+ZK/j2gWgwUFLji9ug8JA+aLuFGBrMJVSwuukGiIdDjt8ASxvW0UhrsYVJzbr1mYu3WW2hfK7cQzq1WRj8bdG8diUcUV562QPfKKQevPD02YhmdTCYxtZc8gR7GdHRA48Px4cHRUbo7HR8eb5h0oFbXeW8d+7sDPte/9p/OapyQU45n4eTUHT4PyAc8lB5Gfa4EFP4K65NRuP7B9LmIGkP7sovyjY+23RH/m2GwYf9bJbeDKOOC63nis5zoXbGQoLmV8sI5ac8gt8c3EjXbkGbwXk4wly6KSSzph6IwbRSAScbbr+JnFB4u0rxiaNEdIbQtCrRekpnUlSg9bwxLpE/ZVels73qxG7LWZ4lvlBQz4nff/TH+4OUTxNyZZLwaqOos3h+8dIeub+0FwfFkd2//3QoVm0sBT66HOMfeoRoiKPl41DkoxYqDnKebMg0rlYdVrgIc1h09tlQHj+/MHHSrvLdJVrkjnN4G/jGJ7JWwNtcRfGtfH2lqMuzqu3XB2mwXKQcdz+VNq7zB1nJtKm5o9vZPzibgkKGary8Q7RzBywxQT9J7MhfD6od9vm/4eHdoR/GBdrBSqGh6g6fD77bPk3YgWBMMjNhP5I3v86a5SSAk3uotuDGhlQ5eZUo1T195d05tmV+w3yHatEHGdltYAcB0yw/5beCK+CPw7cYXh6+Znf28NcN/w7LwYGdm9lhU+ZBVNYUao9pRLaF7xRy9jSTWJ8l7OWeHAHP4xFamp4boqiylMoTZ4Chf9E/4vTkKc3AnoC+eh+4VP7QguwFZ7zRrU7kYV9okTyt4+YR9ieiVvSxZK2b9Q5ZMuTLz7Uc5tefqGbHd662x96C2bMIFgNbmPO6Ytq4FfUoQ74P3wwmFvYPxYcwoPY73gB3GR/swisdHwPbZCOBod3+DSXNXsrfflOY5JZ+4+WOGqThmK37tSwm4XSOosFaG573TMHwmQbotYn3U7JmwYqPzwpyasMNpdjBJ4ymdZvEexWdsJseTeHdvBBN2nNLp5GgDp55mhc405XRO/gIq56Jmk38HAll042+vPI5DIaYGoV08Xec9NtftrK/V2ljC6qPRtqS3iy5XIqk3l2JjfWin2ZN3a9i7t2MkeAQ7IL8BXGGqSZi5vXr3N/sOwRLqkDSpbe8Lb5XCQJusvWw51O7tyc5txXhNsfu9TQv78NGh9i8r/Vf87/b9uvfnZ/F/1vkwjlX9c6DMhgVLD9DV9wnCSzWT0WQ/Hh3E4333skBGqxyfaGj9vvTO0Cm41zz8HTc0jzGyj5H352f17X6qtUy5PU+1Ybm9o4YN8FqevaAmcE15UzU0cG1aNz7faHJRcGFP4lq0t7weSUset54u8ATj1s/vEAbetXP7ovB21YqXBgOLS2rdzPLFe3tPfO0DQU0m0V2SWbdA9/hCoaEzXPGo+4aTv851G+sS6BVQvYjt1UEP+EuW1c26rXBWMb4uojgD+5BX681EuDUgtI2yUcacTqx9udHeeal6Lzgi57r93NOKdWOccrtRfwJ1w6WJrO7VnVDTuzUxZGPzplhlX1vAlTuJdq7HO0uPS+7crVrz+53e85LqOuhipXLUNy+NtOROGGMGhZXIJRE5hUL21sXRi/3jaoV0r/2tJryS5rmymbl1NEv8jIwI72J+RaFzlYErXsesRREHDzbEvrMBVFmr0r9PaUnE9uoPoZWZ434vnGsNoq+2GOE5IzgKawawW3l3Eh0Mq7WLaC+i9lN7LYs2iNCA6S/ZV1DXPIUWpxtbYm+n7tiGOwyHRj8Q23/jsYH2XZduVEGeysKeplgcbzT56FWEhAIeNGVMplUR3mr7F3/nnbrsiLc/p2FU8iveS/ZbYHfSgKLiv/5bIxnWW0htCio6dNa/4drHf9fcvX+Jt1/9Qhu4NTtlTrmVCCvbd14RL6JrTAUu0YgG0ckaA9zSxp9YBKsNkrm7Qx/0XeX39/jz7xWgF7/4iXZB2bodq7GMW3/L6gf31k7/7a/eWL8jDxv2lRMNV+/EomWdIn8PcLV7cXW9zn9vB/ef2iuvYbBj5OpIqOZ34zzQCJWm9W3pcYmOvzj//g3vuHZtVm2j/F9al7S763x351p8k1cg7u+bZcd/21Dw/r8BjXwLVg== +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"; + + + + + + + + + + +Deactivate a time off policy + +scope: `time_off_policies:write` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/put-v-1-time-off-policies-time-off-policy-uuid-remove-employees.ParamsDetails.json b/docs/api/put-v-1-time-off-policies-time-off-policy-uuid-remove-employees.ParamsDetails.json new file mode 100644 index 000000000..088a4c64e --- /dev/null +++ b/docs/api/put-v-1-time-off-policies-time-off-policy-uuid-remove-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":"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/put-v-1-time-off-policies-time-off-policy-uuid-remove-employees.RequestSchema.json b/docs/api/put-v-1-time-off-policies-time-off-policy-uuid-remove-employees.RequestSchema.json new file mode 100644 index 000000000..d2dd5350e --- /dev/null +++ b/docs/api/put-v-1-time-off-policies-time-off-policy-uuid-remove-employees.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["employees"],"properties":{"employees":{"type":"array","items":{"type":"object","required":["uuid"],"properties":{"uuid":{"type":"string","description":"The UUID of the employee"}}}}}}}}}} \ No newline at end of file diff --git a/docs/api/put-v-1-time-off-policies-time-off-policy-uuid-remove-employees.StatusCodes.json b/docs/api/put-v-1-time-off-policies-time-off-policy-uuid-remove-employees.StatusCodes.json new file mode 100644 index 000000000..edbf21c4d --- /dev/null +++ b/docs/api/put-v-1-time-off-policies-time-off-policy-uuid-remove-employees.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"}}}},"422":{"description":"Remove employees with no employees","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/put-v-1-time-off-policies-time-off-policy-uuid-remove-employees.api.mdx b/docs/api/put-v-1-time-off-policies-time-off-policy-uuid-remove-employees.api.mdx new file mode 100644 index 000000000..428ec1e1d --- /dev/null +++ b/docs/api/put-v-1-time-off-policies-time-off-policy-uuid-remove-employees.api.mdx @@ -0,0 +1,71 @@ +--- +id: put-v-1-time-off-policies-time-off-policy-uuid-remove-employees +title: "Remove employees from a time off policy" +description: "Remove employees from a time off policy" +sidebar_label: "Remove employees from a time off policy" +hide_title: true +hide_table_of_contents: true +api: eJztXOlvG7mS/1e4vR+SAGpZkm9/2kyc7DOwmRiTZGcfkqBNNasljrvJDsm2rTH8vy+KR186bPnYfft2BhgkUZPFH4t1sVjkbcRAp4qXhksRnUS/QSGvgEBR5nIBoEmmZEEoMbwAIrOMlDLn6eK7+C50Kks4IRf4KZFZlthPHPTJteIGLqJBdBPPKm1kzIWBmaI4RmwWJUQn3yIopsAYsOjHIJIluK9nLDqJysrEV+N4iW7vl0VSVZzFyiJOasTRINKQVoqbRXTy7TZ6J4uSisXbNAWt31ZmHp18+3H3owGn9DWdRSdGVTCIFOhSCg06OrmNJqMR/tHlkK4spazKo0GUSmFAGGxFyzLnqZ3Fzh8am95GOp1DQfFvbtaRnP4BqbGcgRtalLkbyNNMtKGmsr/g1KKTaDc73DtI2ShmbHQU742Osnh6OJ7ER+OjUXqYHkzGcGxh2DkmvheDo900yybxERzSeG/vCGI6OUrj8d5k/4geHx+O091oEAlaICYD2vhljQaRZ63He0XdjKJBRNNUVTRPCjBzaZcJVDKXlUqupboE1mqiqIHoZG/U/SWpBDfu55JylsjKJFIkBlTBhRvFL0LodU254WKWlKC4ZAmjCx2djEeDKKVKLeQVqCTnBTcWhv00GkQFvUkCAfs7dk8WQFWrQbsDMi8HROxGvwKl3VJn+/v7B9MUdtnhPqST6cFkysbj4+MRpYfHx7s0GkRcJzQ1/Kru7fmnQINJmGVENBrHo3E0iBoZRcH0i5UejNn46Hg/3k+zo3hvMj6Mj47So3gyYofp7nh3Qkd70d2gEYmD3d0U9g9jOp0exnuTSRYfpfs03kOwBwfjIzig0d2Pu0FPqhIhW0ryl4j984sYygAD25caYH9Zl3+opRdVnncWN6O53mp17fJ2nXeJ3YSx8yUyI5R8Qcf9KcvIeb0GCt2t4W0rUDsobRQXs6hP+avgPysgnIEwPOOgHPFeVBDd9YVle7qZVMTMgXg6RF4LLmb2pxWjOSG7b5Rfqe24jkhHKO+j9WVRrqU1iEBUBQY3LcnWPL2MUBX7In7fSG7BmkF8f+L73/U1ItD71hBEGcP4KpOqoAbNTS6pWZ7THAjSINSQ6zlP593ZWXEm1zzPHQawi0RFHSUSKWwPx4YhqeUQGKGaUGKHHRAYzobke7Q3Go6+R8P+DLwGP20aoiqmTjod6jbKOdXESIIGhUhFpkDQUjiJk2FqZgURDYZwN8WwCAh4SD6JfEEqDY4INs4XJISr5HVtw3CcAen8E90x2hjkcusTguv9Ezpt32zD3rWWsJa9qZQ5ULHEy1/c70SFsVAJedbm5yvtecZWikpgr6yMlY/W8Hf3GOFGBOzGAVRLBnqaXa8U9iRTyKSC9aIZkM24cNitaemAtzZstQN4mmQW9GajdKZUkHpgt+2SAgi6FhRPK5dwYxDfJif08iC9oiALLbqA6H+MSw5Ay3K3feWG4ZdHwy5t8bCE9JB8sEDJx4/x6Wlwas6J36s403WKE8ZAKxToMZJKkfFZpWrFqOODrSaSVkqBMMT3Dg7KbTeH5DO4aX7z3xHTrOIMfryeG1Pqk50dJlM9tBviYSqLnbA7j0u6UDLP7fedpvu/OtJxTheg3ljzx4VbXzu+IHN5jXJbaRyaa5JxyNmQINqAMtgJnBfyqLUSXBMhSS7FDBRxEZK1aK146elLwbUnje5ASKtbnS2SH4AqRRdL5P+Da4OMrmXz69ezU00qwRDyiuCAGyj0qmTAQyKyu0E0pTkV6UNilLb39r3qwCrAje7wP8x4/Ky4AoaSZofuxXA+yOqGSUvRTHtl2kz8MYgMNzmCxUg0/pRlsY9E3fB7o73lHMuv0pAPshJsmxTLGhLkuyDku7AxDvysQKPaKdCyUikQJgElzRC44doMyUd6CURXypsFJa84A0bOTndwdVFirmjO2TAaLK1im5GglFR29t219b8vi9Za2ViimlwCdkipgZlUizVj2Fb3CsrnElIMuzW5noOfs+1OZJpWSg/Jl0XJU5rnC6fEl7BognXtIiJjFJ9WBnZKqmgBBhRRkOOOM/gtS3LoPKtHvQU0G4v6qNtRskYkkAqLpD3ymZJVycUM/Qaz/mIKLkYzkkwrnjOSopkrfPs5FSy3lkGQhazQjtXJSou5AK3p7AFqdx6AMDCU55rQKQY/DVNjMgMBqmGnJx1Q6kplNHVI0ekJhsCRc05XuklDIU2SWSVpCda3zvpHXuLb8nLS6tiaXLRGQa6p0w/bYYiJpbtGpX+VJrZKFr/HQeNPTmq9Zk8my2q5lF++5maOpr6dv32kyn8VpZKY8aLTHMh7YbhZBOVHZlN0vmUJAqXdhYVTyRYoV3bh/ezRJxvKhRcoTXSVzjHQvuDCKn9Si3xyRfMKLgbE29ZAIbPLz3A7YVey7lknui9aTvm9G+adWyEOekuvbGHGad39jfPt1uIXGA97eRx+F3+Zrf8XZoucZc1AXJMLYbU6cet4MWgFhy4I8yJPKHEtyYVvSvwiLZyiglUqrxj/MNYRURjKqFl51NKF8S4ot4IcrqgwuAmgSNMLyMJrsrd/XBCr0zZeRbPhLdI0B7tPIN4kDzokLD7Lqgv3pw2bLuzahl8wurpo9so+1MDIQgr4lFlbvnkuRZUbXubgxuLWdnYUL/y8rGzhyxYq3TsG42IWRsZulDGOn2h+3hrJJ6yXx35ouq2duvMcNXPaFptUKndoxzC7Y6WhxeCnpCAdGUvRWW/clG/YmNXtqjIxcnPDjp1b1QCT9Zu2s203/NFLf/w7N/P4k4DYOb/obn2rj152XFNcGjxj+mvN/++vOVJa67C7fPgdjY/EJKbd/uDmeIPbGJIzgz+XUmuOIZaRZE6vgNR2KIcryDWunXcjwVHUZiVKuUqrnKrXDm4ncHwTtWe4okG0IgyeUnGJ2TBZCZMwwLRKUokMt+EsKemiAGH0hhB5SjV04+OlYK0TJ3+oBONi9tHue202J4xG6tHsGnSAXYHi2SLhwopuikhLqfmzIvs7hgE4KvGjoufE2H1qUy4o6GxIznOgGkg6h/TSBSkYsXo4hBbYUQ/XT4HmCihbJIHii04A2esHJFMA0cxjBcCCa7RQiZIVpno2bYtci8RlGldD7AX5HaC/uf4hU8k1CW7X4/KSkLj0nq6h1bHmVlxb7t0G89YQXFJj08VNMFtU2rQDi9XAwmwzqk3QFpf13oBwReOtWfgBEXsaxNIgei6rnCFm6jlbY/bnAw1eEKxO+K5BWTdZiW01L98L5pLCjebYHZSZU0F2SSGFmWuMCbPKVAocvpAu44JV2qhFoiGHFKU7EZSnOkklg6QJzNYiblpvz89fsS/BvivE8WEI/TAvDzCIJvzEozQjyQFhfMZrs7MBrg4A9APgap66ttuj/cxTi1Uvg93zYB3Wfk0aJksfttbFo5hYrFrfpcI4YTUKWK0v/aPiNag6zbaw3G9bx6I1x6Y5mnKMrGo89eHoGuAlWOea+ETKJu/Y67oN2ndOuZvamOZ40MyJx9Bk0AOYNZjrzNVDlr2T5tpu7d/XOTOq4OES4PP/SVXeYy/Xe+tNqN5RYfODlP1hl92Npjcv+1zmnKFVx/8d4BBW2ED0OaMiX/9ZhxE2pCAeAXqgULawFhrmS18MVn0AYSPpVcAGpPQhmwKUVSlgLdTaPbZPsZ5fFM9cm+boC7ddupXDsPikmEqqMAyvz5yekX9BhzHgJ/VQreMthLA0mWdE8MXmHrk7n7bbUl8jErLAmFzueTQXViQgMH+EQZhRNDVSJbgJ24Ct33J7Na0JuP1eE984LK6CxUo52j6Ht1HYgP8l49jeHFe4OW2osnE7zQwou9d/SBSw3Gt7/p3XcfWrFfReNWrcpCZsnpJ4RbkCYfwsQmrxofg77Z+EvEPpXsyhdbOlwSOHZKak1pjuCIMLsJuBTbGOb7F9uAN2j1BHFGFf0IMUSnl8Mcz9LH2cq/ubrUZpNEfAjPrChDYar+Mp+sH8Ge3NuaPfAuCGqNUjU/JPEInH8ayWDrM+fvilLbk/dMPcwpnRLp3eYHRhB8MTMpobUGvQJp7K5n37k4BzrA9D41YDDkctPag21ci1DQA92EoUkvGMW7MdIIds5nOCDSdG5dJiOwCOkx2WO0OpQV15K64X2kBRNwo2vB8bWCugk1CUdW+c4No/xQB1KTVaLYhNT3qcBb3hRVX0cepKlRTn/IJQ39+kABhFeAy4EuPRyHI1l/KyKjfx8gWBhYDrfbvW6LV+M4y6Z1/Nuc63XtK93j5EvVx5GD+2t6nGk117xt82aNNcppegaudvk25Y7bWV8PeorQyGrUT4QLiTB+SCSIV1VUYSVYmgHv3pu7GXcW6eT704GkxVvsykKGOtoodHTacHc/OcMmB4lJoYevOS0wqFjMSPRwy9IXa8x81xGfYDRNHlhNO6tPlZp9kRw2CxQhb6CXLZAb16krrSmIvYMsX+kElxLGrxxNtO8N4pNJDu/BWzqZ2VFEtLU+fsNoXmS90fk6qriZBAhNSDN3uIaB3gxis/FW3nuKzHvzCat8Y2hU7TeWLmCvRc5iwB73yi1vldH4GdFtRYt+dV4IsrsDWEXlGeU3+YhxF/fgXE5ubfvvsb+RLAkeAZW+dHUmqbjEAn+TtXQM7EgHzE6q4vEksvFTml9jiy7TBb5c1bh0319iUQ6Z0d2bwYNQaK0m5isfrYhnSENvUcFQonhhyyMrHMYvvdEwzbTD4T1EiFqT3K84el9SjPH5PSozxvb3T7AMK+O2TH5lQn9dfnz6a409z6wAMXtx7NFfx7QLUYuNvX7ug8JA+aLuE+BrMJVSwuukaiIdDjN8ASxvW0UhrsYVJzbr1mYu3WW2hfK7cQzq1WRj8bdG8diQeUVp62QPeKKQcvPD02YhmdTCYxtVc8gR7GdHRA48Px4cHRUbo7HR8eb5h0oFZXeW8d+7sDPte/9p/OapyQU45n4eTUHT4PyDs8lB5Gfa4EFP4C66NRuP7B9LmIGkP7sovylY+23RH/q2GwYf9bBbeDKOOC63nis5zoXbGQoLmT8sw5ac8gt8c3EjXbkGbwXk4wly6KSSzp+6IwbRSAScbbr+JHFB4u0rxiaNEdIbQtCrRekpnUlSg9bQxLpE/ZVels73qxG7LWZ4mvlRQz4nff/TH+5OUjxNyZZLwYqOos3p+8dIeur+31wPFkd2//zQoVm0sBj66HOMfeoRoiKPl41DkoxYqDnKebMg0rlYdVrgIc1h09tlQHj+/MHHSrvLdJVrkjnN4G/iGJ7JWwNtcRfGlfHmlqMuzqu3XB2mwXKQcdz+V1q7zB1nJtKm5o9vaPzibgkKGary8Q7RzB8wxQT9J7MhfD6vt9vm/4cHdoR/GBdrBSqGh6g6fD77bPo3YgWBMMjNhP5JXv86q5SSAk3uktuDGhlQ5eZUo1T194d05tmV+w3yHatEHGdltYAcB0yw/5beCK+CPw7doXh6+Znf28NcN/x7LwYGdm9lhU+ZBVNYUao9pRLaF7wRy9jSTWJ8l7OWeHAHP4xFamp4boqiylMoTZ4Chf9E/4vTkKc3AnoM+eh+4VP7QguwFZ7zRrU7kYV9okjyt4+YB9ieiVvSxZK2b9Q5ZMuTLz7Uc5tefqGbHd662x96C2bMIFgNbmPOyYtq4FfUwQ74P3wwmFvYPxYcwoPY73gB3GR/swisdHwPbZCOBod3+DSXMXsrfflOY5JR+4+XOGqThmK37tOwm4XSOosFaG573TMHwkQbotYn3U7JmwYqPzzJyasMNpdjBJ4ymdZvEexUdsJseTeHdvBBN2nNLp5GgDpx5nhc405XROfgGVc1Gzyb8CgSy69rdXHsahEFOD0C6ervMem+t21tdqbSxh9dFoW9LbRZcrkdSbS7GxPrTT7NG7Nezd2zESPIIdkN8BLjHVJMzcXr37u32FYAl1SJrUtveZt0phoE3WXrYcavfuZOe2Yrym2P3OpoV9+OhQ+3eV/iv+d/t63dvzs/g/63wYx6r+OVBmw4Kl5+fq+wThnZrJaLIfjw7i8b57VyCjVY4PNLR+X3pl6BTcWx7+jhuaxxjZx8jb87P6bj/VWqbcnqfasNzeUcMGeC3PXlATuKa8qRoauDatG5+vNPlWcGFP4lq0t7weSUsetx4u8ATj1s9vEAbetXP7ovBy1YrXBgOLS2rdzPK1e3tLfO3zQE0m0V2SWbdAd/g+ofe8v0hmNwL9vo9+erBzQ6x9Ub93ZWfDQwgPuvZp+bVE9mEXdPqs7D5a4PTC0BlqRNR94cpfd7uJdQn0EqhexPZqpV/QT1lWN+u2wlWP8e0VxRnYXR9mNt+3iuTgxoDQdiuCiugMx9onLu3FoKr31CWKV7efe32yboxr227Un0XdcGk2q3t1Z9X07s8OBa55e62yr1KgjJ9EO1fjnaWnOHduV2nH3c7KxzjVVbBdlcrRPnntpSV3yhszKKwGL8nBKRSyt06OXuyfoiukextxNeGVNM+VzWSuo1niZ2RHeEX0M2qSE94Vb4nWkoyDB5trXyUBqqwV7t8/tSRie1WK0MrMcX8czgEH0WdbvPGUERyFNQPcDSK0EL81tuW9u0vVU/nmfcpgklzWxB36Bx9mXRCa5qj9pmHLeQwi9BX6U/YZ1BVPobVIjdm2F4F3bMMdhqjRXsT233hCo33XpctrkKeysAdXFscrTd57RSOhVgq9BpNpVYRH8f7FPy9AXSLKm/rTMCr5Da+A+2yDO9RBKfNf/60RKuuYpTYFFS06D3w9tz+V28aYP/MDvF5yDNyYnTKn3IqYVZZbr9/foivMxS7RiAbRyRoPuKTkP7AWWRskdnuLocBXld/d4c8/K8Bg6tsPtDzKlk9Z2WLchj2sfvVwLT9e/+Zdyhtyv39dOd3gu8SiZf8ifx1ztZd35dUujNoO7j91cLSGwY6RqwPSmt+Ne3rnmBV/6XjJ5SCm6YHWsDQb27bd1/nXL9Egmvq4qZDOndNrFF167RY/5BQxsMLfbqOcilnlgntHElWcdi1wbXH9X1pX9LvidXvrWnyRlyDu7hppw3/bjcDdfwOfgsbo +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"; + + + + + + + + + + +Remove employees from a time off policy + +scope: `time_off_policies:write` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/put-v-1-time-off-policies-time-off-policy-uuid.ParamsDetails.json b/docs/api/put-v-1-time-off-policies-time-off-policy-uuid.ParamsDetails.json new file mode 100644 index 000000000..088a4c64e --- /dev/null +++ b/docs/api/put-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/put-v-1-time-off-policies-time-off-policy-uuid.RequestSchema.json b/docs/api/put-v-1-time-off-policies-time-off-policy-uuid.RequestSchema.json new file mode 100644 index 000000000..f52ac1ea6 --- /dev/null +++ b/docs/api/put-v-1-time-off-policies-time-off-policy-uuid.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"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"},{"type":"object","description":"Request body for updating a time off policy","allOf":[{"type":"object","description":"Base Request Objectfor creating or updating a time off policy","properties":{"name":{"type":"string","description":"Name of the time off policy","example":"Vacation Policy"},"policy_type":{"type":"string","description":"Type of the time off policy. Currently only \"vacation\" and \"sick\" are supported","enum":["vacation","sick"]},"accrual_method":{"type":"string","description":"Accrual method of the time off policy","enum":["unlimited","per_pay_period","per_calendar_year","per_anniversary_year","per_hour_worked","per_hour_worked_no_overtime","per_hour_paid","per_hour_paid_no_overtime"]},"accrual_rate":{"type":["string","null"],"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"],"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. If accrual_method is per_anniversary_year, per_calendar_year, or unlimited, then accrual_waiting_period_days should be 0."},"carryover_limit_hours":{"type":["string","null"],"description":"The max number of hours an employee can carryover from one year to the next. If accrual_method is unlimited, then carryover_limit_hours must be blank."},"max_accrual_hours_per_year":{"type":["string","null"],"description":"The max number of hours an employee can accrue in a year. If accrual_method is yearly (per_anniversary_year, per_calendar_year) or unlimited, then max_accrual_hours_per_year must be blank."},"max_hours":{"type":["string","null"],"description":"The max number of hours an employee can accrue. If accrual_method is unlimited, then max_hours must be blank."},"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"}},"title":"Time-Off-Policy-Request-Base"}],"title":"Time-Off-Policy-Update-Request"}]}}}}} \ No newline at end of file diff --git a/docs/api/put-v-1-time-off-policies-time-off-policy-uuid.StatusCodes.json b/docs/api/put-v-1-time-off-policies-time-off-policy-uuid.StatusCodes.json new file mode 100644 index 000000000..c15790462 --- /dev/null +++ b/docs/api/put-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"}}}},"422":{"description":"Unlimited Policy updated with accrual rate","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/put-v-1-time-off-policies-time-off-policy-uuid.api.mdx b/docs/api/put-v-1-time-off-policies-time-off-policy-uuid.api.mdx new file mode 100644 index 000000000..f02fb71ed --- /dev/null +++ b/docs/api/put-v-1-time-off-policies-time-off-policy-uuid.api.mdx @@ -0,0 +1,71 @@ +--- +id: put-v-1-time-off-policies-time-off-policy-uuid +title: "Update a time off policy" +description: "Update a time off policy" +sidebar_label: "Update a time off policy" +hide_title: true +hide_table_of_contents: true +api: eJztXelvGzmW/1e4tR+SACpZki/ZnzYdJzsBJp0gx/QOkqBCFV9JHJfIapJlW23of188HnXpsORjdqY3Awy6XeLxI/luPr6+jWQBihouxVsWnUdFaeKrYWz4HBKZZUkhc55y0J0vi6QsOYt6EQOdKl5g/+g8+lIwaoBQgq2JzDLiWn8T34ROZQHn5MfK0OfXihv4EfWim3haaiNjLgxMHajYLAqIzr9GMJ8AY8Ci771IQ1oqbhbR+dfb6JWcF1QsXqYpaP2yNLPo/Ov35fd6NKWv6TQ6N6qEXqRAF1Jo0NH5bTQaDPAf7TXo0o6UlXnUi1IpDAiDrWhR5Dy1oA7+obHpbaTTGcwp/puDGcnJPyA1dilwQ+dF7ibyYybaUFPaL3b7zqPD7PToJGWDmLHBOD4ajLN4cjocxePheJCepiejIZxZGHaNie/FYHyYZtkoHsMpjY+OxhDT0TiNh0ej4zE9OzsdpodRLxJ0jpgMaOPPIepF/vg83ivqVhT1IpqmqqR5Mgczk5YUQCUzWarkWqpLYI0mihqIzo8G7S9JKbhxnwvKWSJLk0iRGFBzLtws/hBCr2vKDRfTpADFJUsYXejofDjoRSlVaiGvQCU5n3NjYdifBr1oTm+SMID9jt2TBVDVaNDsgJuXAyJ2s1+B0u6os+Pj45NJCofs9BjS0eRkNGHD4dnZgNLTs7NDGvUirhOaGn5V9fb7p0CDSZjdiGgwjAfDqBfBvMjlAvDMv1ZHnJ4M2XB8dhwfp9k4PhoNT+PxOB3HowE7TQ+HhyM6OIqWvZokTg4PUzg+jelkchofjUZZPE6PaXyEYE9OhmM4odHy+7LXoapEyKQB4CeJ/elJDGmAge1LDbCf0uVf6uhFmeetw81orvc63WVXvX6EArsJY9dLZEYo+Yya9n2WkQ/VGShU6YY3pUCloLRRXExXFbfgv5dAOANheMZBucE7ajxadoll/3EzqYiZAfHjEHktuJjaT2tmc0R21yy/Uttx0yAtorxrrM+LYuNYvQhEOUdrpEHZmqeXEbJil8TvmskdWD2J7098/2WXI8J4X+sBkcbQIMqkmlOD4iaX1KyuaQZEWcPMkOsZT2ft1VlyJtc8zx0GsIdEBQnkSKSwPdw29ElFh8AI1YQSO22PQH/aJ9+io0F/8C3qd1fgOfhhyxDlfOKo06FuopxRTYwkKFCIVGQCBCWFozgZlmbWDKLBEO6WGA4BAffJe5EvSKnBDYKN8wUJdit5XskwnKdHWn+iOkYZg7vc+AnBdf6EVtsX+2zvRklY0d5EyhyoWNnLX9x3osJcyIQ8a+7nM+33jK0llbC9sjSWPhrTL+8QwjUJWEsfVIMGOpxdnRT2JBPIpILNpBmQTblw2K1oaYG3Mmy9AngYZc7pzVbqTKkg1cQkU3JOpACCqgXJ09Il3BjEt00JPT1Izyi4hRZdQPRP2yUHoCG5m7pyy/Srs1lvtEEediDdJ28sUPLuXXxxEZSaU+J3Ms5kE+OEOVAKhfEYSaXI+LRUFWNU9sFeC0lLpUAY4nsHBeXczT75BG6ZX/3viGlacgbfn8+MKfT5wQGTqe5bh7ifyvlBcKfjgi6UzHP7+0Hd/T/d0HFOF6BeWPHHhTtfO78gM3mNdFtqnJprknHIWZ8g2oAyyAlcF+5R4yS4JkKSXIopKOIsJCvRGvbSw4+Caz80qgMhLW+1XCQ/AVWKLlaG/yvXBje6os0vX95eaFIKhpDXGAfcwFyvCwbsYpEte9GE5lSku9goTe3te1WGVYAbLfF/GPH4veQKGFKaD9q0bDhvZLXNpBVrpnkyzU383osMNzmCRUs0fp9lsbdE3fRHg6PVGMuv0pA3shRsnxDLhiHIN0HIN2FtHPi9BI1sp0DLUqVAmASkNEPghmvTJ+/oJRBdKi8WlLziDBh5e3GAp4sUc0VzzvpRb+UUmxsJSkllV98+W/99lbQ20sbKqMklYIeUGphKtdgwh211J6F8KiBFs1uT6xn4NdvuRKZpqXSffF4UPKV5vnBMfAmL2ljXziIyRvFJaeCgoIrOwYAiCnL0OIPeskP2nWb1qPeAZm1Rb3W7kawQCUOFQ9Ie+VTJsuBiinqDWX0xAWejGUkmJc8ZSVHMzX37GRUst5JBkIUsUY5V0UWLeQ5a0+kObPchAGFgKM81oRM0fupNjckUBKh6O/3QAaUuVUZThxSVnmAIHHfO8Uo7aCikSTLLJA3C+to6/8hTfJNezhsdG4uLNjDINXX8YTv0MbC0rFn6V2liy2Txa5w0fu+o1nP2aLTKll+ENamAeX+UlDYkzMg1N7OWdX1/1v8iCiUx8kUnOZDXwnCzCEIAN52iEi4KEEj1zjycSLZA+rIE4HcBdbOhXHjC0kSX6QwN7h9cWCGQVKSfXNG8hB894mVsGCGzZMDQrbAnWvWsguo/Gsr5tZvmlTspDnpP7WxhxmnV/YXT8Vbyz9Eu9nTZ/yZ+iq//F+KLvM3qibgmP4Tl7sSd449ew0h0xpgneUKJa0l++KbEH9LCMSpYpvKM8S8jJRGFoYyatVcubRivAnMryOGKCoPOAMUxPYEsPCd7OcgFsTxt7VYUG14iTXKw/gLxornXGsLis1v1w/3Tmk8/7NmGL2hl/ah9Zm9yoIUhBbzPrEzfvpZ5mRte5ODmQj7qMF74vMps4Zc9WLpzHcbFNMyM3ShjHH+i+YfGTD5wvTr3rmG3ZgjP76iZ0SbZpFK5yzuGUR5LDY0Nfkgo0g1jR3TSG53zLQ5a1a4sEiO3N2zJuXUNMGi/za1tquN3nvrj37iZxe8FxE75RcvNrd552nFN8Wjwrunnmf/7nzmOtFFht/fhNxQ+EoOZ1g1CJ3mL2uiTtwY/F1JrjiaWkWRGr4BUciiHK8g1np1XI0FRVGIlSrlKy5yq5w5uy4B8ETVXuKZBtMYcnlBxiVExWQqTMMDwSlKKDN1xlhR0MQdh9BZTeUI1tO3kFWOtZS+/KQXjYvrO+r82qhNmI9Vs9gxawK5A8WyRcGFJN0WkhdT8UZH9Hc0AnJX4WVFzog0/saEXJHTWJx9yoBpIOoP00hkpaLF6OITOsaPub14CzRVQtkjCiE+6ANxePyGZAIh6HWsAzrlGCZUoWWLIZ5t75FokLuK4HmLHyG8B/ej6h4gl1ySoXY/LU0Liwny6glbZmnvt2mrvJpiXhuCRGhs2ro3ZealN07BYDyysNqPaBG5x0e8tCNc03nsL3yBiPwaxYxA9k2XOEDP1O1th9vcENV4QrAr8bkBZNVmLbf1evhbMBYdrzrEelJlRQQ7JXAoz02gTZqUpFTh8IWzGBSu1UYtEQw4pUnciKE91kkoGSW2YbURct95/P3/FvgT7riHH3RD6aZ4eYCBN+B2dfiPJCWF8yiuxswWuDgD0DnA1T13b/dF+4qnFqlfBHnmwDms3/w2Dprud9fxemzhfd74rSXgh2lLxS/fKeAOqVrM9JPfLRgCn2rFJjqIcLasKT3VJugF4AVa5Jj6Qsk07drrug/aVY+46R6a+JjQz4jHUkfQAZgPmKui9y7HXEfK9z/516Eqogt0pwN8DJC7gdi9tvQ3VKypsnJCyf9hjd7Pp7cc+kzlnKNXx/w5wMCusIfqYVpHPA63MCGtSEI8ANVBIX9gIDeOmTwaruoiwlvQ6YD1SeJNNAdKqFLARaqUem7dZj0+Kb12b+goM3S7diGFYfFJMJFVohld3T4+4f4GH0eAn1VSNay6EsLKYR0Tw2cYeubuntm6pzxUJUWAMLnc0mjMrEhAYP0IjzCiaGqkSdMK2YOu23J9NqwGcv1fbNw6Ly2SxVI6yz+GtGTbgf0o7trPGNWpOG6qs3U4zA8r6+rtYAau99t+/D5Vd/WzNeM9qNq5DEzZOSTyjXIEwfhUhtLgr/lb7ByFvjXQn5tC6dmnwyiGZKqk1hjvC5AKsM7DN1vEt9jd3wPoIlUUR/IIOpJDS45Ni7t7S+6m6v9islJpzBEypT1BoovE8nqIezB9R3nxw4zcAuCkq9siU/ANE4nE8qqTDqI+ffsUl95duGFt4a7QLp9cYwz0fZg7mBtQGtIkfZbvf/iDgHPPEULhVgMNVSweqDTVybQ1AD7YUc8l4xq3YDpBDNPMxwYYbo2LlsB0At5OtLXeCUoO68lJcL7SBedUoyPCubWClgE5CctaddoJr/xAB1B6p5mpBbHjS45zTGz4v512culQFxTU/IdTXNykAWhEeA57EcDCwu5pLeVkW2/byCYEFg+t1M+fouX7Rj9p3X/W9ztdO0L1yH6JOrDzMH+Of8XB0aO/6mwJtksv0ElSl/G3QDbO+9iL+zmhrjWFLEd4QbsUBuSBSYX6VkUSVIrBHd/lu7lWc29dTHY4GUxZPsyjKatNU3285HZjb15QBw6vUxNCbp1xWSGgkfj5i6A2x891vjauwdyBFFxNOqxTnR11miwyDxApR6AfQZQv0+kXqUmMsYs8Q+y6L4pjU4gdvKsE7l1BDWvqnZhO7KilWjqaK2W0zzVe63ydUVw1CwiCkmrz2IaJNgGut/FC0reuyzv6F2bw0tiF0ms4SM1OgZzJnCXjlEzXu77oI7LKgwrr/XoV9cYm2htArynPqL/PQ4s+vgNjY/MtXfyGfAzgSNGPj/khKbYMRqCR/4wrIW9Ej7+QVkM8SUzAVuaD2OrKpMBtpznubTZX7Egbp3B3ZuBg1BuaFdWIxCzk8PK7yOUokTjQ5ZGlimcX2dz9gcDP5VFAjFYb2KM93C+tRnt8npEd53nR0uwCC3x2iYzOqk+rXx4+muNvc6sIDD7eazSX+e0AVGSiY44nbq/MQPKi7hHcZzAZUMbnoGgcNhh6/AZYwriel0mAvk+p76w0La7beg/sasYVwb7XW+tnCe5uG2CHF8qIBupNU2Xvi5bEBy+hoNIqpfeoJ9DSmgxManw5PT8bj9HAyPD3bsugwWpXtvbft7y74XP9KfzqpcU4uON6Fkwt3+dwjr/BSuh91dyWg8A9Z743C9Q+iz1nUaNoXbZTPvLXtrvif9YMM+79KvO1FGRdczxIf5UTtiokE9duUR45J+w1yPr6RyNmG1JN3YoK5dFZMYoe+ywrTRgGYZLj/Kb5D4uEizUuGEt0NhLJFgdYrNJO6FKWHzWEH6Y7ssnT2V73YDbfWR4mvlRRT4r3v7hx/8OIeZO5EMj4QVFUU7w9euEvX5/aZ4HB0eHT8Yg2LzaSAe+dDfMDeIRsiMPlw0LooxYyDnKfbIg1rmYeVLgMcNl09NlgHr+/MDHQjvbcOVrkrnI4Dv0sgey2s7XkEn5uPSOqcDHv67lwwN9tZyoHHc3ndSG+wuVzbkhtq3/7e0QScMmTzdQmiGSN4nAmqRXpN5mxYfbfO9w13V4d2Fm9oBymFjKa3aDr83fa5lweCOcHAiP2JPPN9ntUvCYTEt71zbkxopYNWmVDN0yf2zqlN8wvyO1ib1sjYz4UVAEw39JB3A9fYH2Hfrn1y+IbV2Z/33vDfMC08yJmpvRZV3mRVdaLGoFJUK+ieMEZvLYnNQfJOzNkhwBg+sZnpqSG6LAqpDGHWOMoX3Rt+L47CGtwN6KPHoTvJDw3IbkLWuc3ali7GlTbJ/RJe3mBfIjppLyvSiln9kCUTrsxs/1ku7L16Rmz3yjX2GtSmTTgD0Mqc3a5pq1zQ+xjx3ng/HVE4OhmexozSs/gI2Gk8PoZBPBwDO2YDgPHh8RaR5h5m7++U5jklb7j5Y4qhOGYzfm29BHTXCDKspeFZ5zYMiyVI5yJWV81+E9Y4Oo+8UyN2OslORmk8oZMsPqJYzGZ0NooPjwYwYmcpnYzGW3bqflLoraaczsgvoHIuqm3y1SBwi67965XddijY1CC0s6eruMf2vJ3NuVpbU1i9Ndqk9GbS5VoklXMptuaHtprd21vD3h2PkeAVbI/8BnCJoSZhZvbp3d9tNYIV1CFoUsneR3aVwkTbpL1sKNT2G8rWa8V4Q7L70oaFvfnoUPv6Sv8T/7etYvfyw9v4b1U8jGNW/wwos2bBShm66j1BqFczGoyO48FJPDx29QUyWuZYqKHxfaXa0AW4mh7+jRuKxxi3j5GXH95Wb/yp1jLl9RNP+0YNG+CzPPtATeCZ8jprqOfaNF58PtPk65wLexPXGHvP55G04HGjgIEfMG58foEw8K2d84tCBav1lQ3tFhfUqpnV5/f2tfjGMkF1JNE9ktl0QEusU+g17y+SWUeg23fnR7I0zze8Jmu/0VmpQNEgF/feIjqPjk/YYJAOT8eT9PTw7HAyoqPBCbATOj6hWTo5Wrsp/6QqFZzBvJAGRLrYozJF1C2GEPahUcLAM5jl1I9NG2T7e6mPjUQwlxCJ4WgXCl0ljs3n1CnRg05+GNqJChzbZgfi2HfN0z71h1fSapLH33z9q1B17BGrbPXJK0dG+cKlsH2rqm19i6y6/WZrbuEfCoIVbSvIPWZ1rpetalx3VwSrcmBx50El9WMG/yGlOQhGfR0f940KwZEMqVo0P7fr4m0pFtX8FY2S7t+ttt/3qSj271lA7Ge9sJ/1wh65Xpg1YdrCwxoza7jXnVOLz63ZWokG+x5fkC1rbbyNGvTvV6rsySqTbdiJ7urWIm6/Fek/oMjZ49Q027AW/ClfOEbd4XRfrDvdzevasAlPdaRuzTueWgVkDcg/XRW25caiVbG3t2I0vqLl5upWsSt1Htpbn8+OS6fovkXtsqy+NsNNrAugl0D1IrZ1QLz38T7LqmbtVmi1xchMijNE4R/3oClmQGgbLkdL0jm3G+un28frZaeOOtq17X6uUnrVGP2PZqMu+KrhyiLW92ovpu7tF4W7XZcHLq3jgu7XeXRwNTxYKRt/cLvOcVuizYcpst6LLlWOnrJ3L2jBnXcRM5hbF2OFsi5gLjuH4MaLfXHkuXTVutcPvHbMD8pagZvGLPDnZaOu/Sf06ZzZvqa6fcUcOHnw/i2zAFVWN3YrodghYvton9AS+d1UGWm96JNNI37IDG6EDRMsexH6qh9rL/d1cCMavuguDqf317u+xz5Vp5tWetsWrgXZGpOz/vEhtac3l56ux9+mFdutVrquKyxd/dguU20vRl1eb5BvNsqE0ZeoWb68ER/qRbhe/T77BOqKp9Cg/tpht7V+DmzDA4bkgC5obP/GJCztu67Up4A8lXObm2ZxPNPktZdTJDyHwMAQk2k5D/Wv/8NXEKPurtlTx0WYlXzEKk/+QtHlbSH7+l//q+ZWG3uT2sypaIyz6T9l0cV+WwdoHvqfv/D0a+DGHBQ55ZY7rZy59ZLwa3SFCRUrY0S96HxtGOs7vh7UBnve3mLw7ovKl0v8/HsJGP78+h3lsLIPHqzAZNwGKllVr3zjap+HCMkLcndEbO3aQs0SsWhog8gXUFkfl3MPIl3gcz+4f+pw5oYNdhu5PoRc7XetrF+5zYo/t2yG1bBj3QO1RmG2tm1q9Q9fPke9aOIjnXNpbRpFrzFkSq/d4YcsAAyF4rfbKKdiWrpwvBsSOZa2NVWlmfy/NMJrbfK6vXUtPstLEMtlTW34tzPj/hfQzun/ +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"; + + + + + + + + + + +Update a time off policy + +scope: `time_off_policies:write` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/put-v-1-verify-webhook-subscription-uuid.ParamsDetails.json b/docs/api/put-v-1-verify-webhook-subscription-uuid.ParamsDetails.json new file mode 100644 index 000000000..1b2926457 --- /dev/null +++ b/docs/api/put-v-1-verify-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/put-v-1-verify-webhook-subscription-uuid.RequestSchema.json b/docs/api/put-v-1-verify-webhook-subscription-uuid.RequestSchema.json new file mode 100644 index 000000000..21deacfd7 --- /dev/null +++ b/docs/api/put-v-1-verify-webhook-subscription-uuid.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"required":true,"content":{"application/json":{"schema":{"description":"","type":"object","properties":{"verification_token":{"type":"string","description":"The token POSTed to the Subscription URL."}},"required":["verification_token"]},"examples":{"Example":{"value":{"verification_token":"asefasedfe23e234easd"}}}}},"description":""}} \ No newline at end of file diff --git a/docs/api/put-v-1-verify-webhook-subscription-uuid.StatusCodes.json b/docs/api/put-v-1-verify-webhook-subscription-uuid.StatusCodes.json new file mode 100644 index 000000000..9f7d2422d --- /dev/null +++ b/docs/api/put-v-1-verify-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"},"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/put-v-1-verify-webhook-subscription-uuid.api.mdx b/docs/api/put-v-1-verify-webhook-subscription-uuid.api.mdx new file mode 100644 index 000000000..4de44c08c --- /dev/null +++ b/docs/api/put-v-1-verify-webhook-subscription-uuid.api.mdx @@ -0,0 +1,78 @@ +--- +id: put-v-1-verify-webhook-subscription-uuid +title: "Verify the webhook subscription" +description: "When a webhook subscription is created, a `verification_token` is POSTed to the registered webhook subscription URL. This `verify` endpoint needs to be called with `verification_token` before webhook events can be sent to the registered webhook URL." +sidebar_label: "Verify the webhook subscription" +hide_title: true +hide_table_of_contents: true +api: eJztXFtvG7mS/ivc3odMALUvinPzw8HmuuODk4kROyd74ARtqrsk8bib7CHZsjWBf8W+7Nv+xf0JiyqSfVNLthwb2B3kYTCxmix+LNaNxSK/R1fxrDJWxUJamGluhZKxXZYQHZ5FUEwgyyCLRhEvy3YTE30bRRpMqaQBEx1+j8Z7e/i/DEyqRYltosPo3RUvyhxYaBmNolRJC9JiW16WuUiJ3u4/DXb4Hpl0DgVfpXQ6RyqlBgPSUhempuwSJnOlLpipJnXjnWgUuQlEavJPSG00iq5iy2cGp/TF9SD8Vtgcm/nf4pMWlWgUlVqVoK1w86sqkeH/PWljtZCzaDQA8/Pno7cIzs5hLUANPPso82V0aHUF16Oo0vntqPcoTkCzz5/+tsM+lxm3YNilyHM2AXb88eQUMmYVs3NhqM3QuMZyW5mhoUFWBXKsBJm5XxagxVSQOGgo1IL+VUkNPJ3zSQ7I01XAboStGdJukCC2NkiuNV+usOcTpCAWwCrPiqnSOKYBRv27w0x5bmAUCQvFxum/5vLiVZqqSqIgvVFFyeWy+ddrkDAV7pO0mqdW6c4fx3xZAPV9V5S5WgK0/tn0Dr/8VU2QMkjDvRi+u7KgJc+P+VKrPI9G0Xuli2gU/U2loc1vyoqpqP9smh7z5Uk6h6zKcdgTMZPcKr2Mvl1fX6NagFNQ4oBX1kbYo/TpNOPw9Hn89ODFk/jg6fhl/JJziKd7kKUA2ctxdhB52Y3m1pbmcHe35NpK0DEvy51UFbuNoEaNuLVlaWil/8R8RyH8vRIaMpwmcfrb9ShasxILnlc/vCR2DvHPZblBHUgjDvYOVn3Pb8qy96qSGfsqGfsqnS/6vQJjIUPfpiqdAssUGCaVZXAljN1hH/gFMFNpIMNXarUQGWTOPQjDFjwX2c5XGeGw4/HqsJ9lqVUKxqBtZe+kFXZZIxCGFXzJ5rwsQbLLOUgaZaKyJZrapap0wMjQ5XIhDQOtlTbMVOmcccPOhSQQCbdWi0llISFxOx8xZzlrClMucsOyCtCfcNn0RA9JbD7fYSfgZnr2zg3zhluYKS3AfPslSGKmUrNDAQcJYQgw4tItEX3fJZhxWnd/zGaVyIDseaE0sAwsAkLm3TmgGOLuT+b2mdsPpNqmy00YnX43UvK/r3rrvq9dTzW5AOzgUS7XjEGtbgyaTkpI0aYZXEivjNSdqTSttNlhp8tSpDzPly5UuoAlExlI63ph+3oN0bvxAiygAOTchgjLk9xBZa5RbwENKWBbFC9HiaGVCaSC9fBSxmZaVaWQM8O4zFjKJUZ8lXFoJpXIM5aiHBS+/ZzLLBdyxoR00tsK5XfY0bQZSBh2LsmwJW4dz0cEzq2Viy69yDPOXEt27psyv0hLdinsnIEzWe4jsaZAfZvBzZw5DvP10sj4RFW2tXYxm4EE3ayaJx2YYSo95aljCJcMZIb80R6F5Rm3fEgUuzDeBOXWkMOCS8uwH9L0ArL0muxdgJCMdBq3J2Q2vEWa5LDD3ivNvJcfdUgQPmLVufs/udtzWtvwC7r/8zq4D84EQ1ol4eM0Ojy7aS5FlVuBmzGiiHrUU7zw86qyhS9bqHR3bCPkLIyM3XiWCfzE8+PWSBj5D47tGHKz1PzGCwgbDc9RO+dtsUmVdnvRzDCrSBpaDL55hM9S/F5BYx502GT48Yiis95TrYqG4FlDUVZ5TiGfa1eViVWbG3bs3FADjN9gU5PrZrf7wUt//EXYefxRQuycX3S9vtUHLzuuKS7N9ejnmv8Z1py2HuscdpcPX9D4KJkvXYDLxEa3scOOLP5cKmMEhlhWsTlfAKvtUA4LyCkx4N1IcBS1WYlSodMq5/oXBzem4Cf+SAL3OGrPcKBBNLDHnXB5kXC3f0kyyMFCUslpJTPIktLtTTpBzFkn1ogm3CWxahcfrQRrUcvNRe8rSp58ADtXGZtzw8JorB6N1qADjHZhy0RIEt0UkZbKiHtF9g8MA3BU5kdFz4m7lwmwsAvcYcc5cAMsnUN64YIUjFg9HMYL7Iiufd0UeI4Zl2VS7ysfcgLIXj8gmwDIZh4DAAth0EIlWlUW1WY9MN8ikVXhdssDEHtBfgfoJ9efuf6oE8HtelxeEpJUyamYmRpaHWtuxbXV3m0wryzDJbVMSWBNMFtUxrYDi2FgYbZTbmzQliQXhbAbEA403pqF7xGxp8GIBjNzVeUZYuaeszXmpAQtVNbgBZklmbeWa1DWTQaxDfPyncwwHoSW5tAOys65ZE9YoaSdG4wJp5WtNDh8qUuUJEJmlbF6mRjIIaUki+QiNUmqMkiawGwt4qb19vz8Dfsy7DsgjrdD6Id5eIBBNOH3iufoRZ6xTMxEbXY2wDUBgLkFXCNS13Z7tCciJaxmFeyBB+uwWlFAoqbTpFS5SJeJ5MUt17q4ExOLofXtg6gkaRRktb7wNNUVzxO9WWc6zbaw3K9cP4b9ao5NcjTlGFnVeBgBFGDWAPcnE4lPpGzyjr2u26B945Q7A55asUDIjobb43oMDAdgajoNWZ11mMEnNs1tlr1uvP3ahwSqYVzD7SVgwnMuU0jcEcqdvPUmVG+4pAwpz/5Jy+5GM5uXfa5ykaFVx/8c4BBWUCB6n1GRT2PXYQSFFMwjQA/kF389NKnsw8GqU8wUSQ8BG7HSh2waUFaVhLVQa/dYi9mDiOKRa8MCCYbbLtPKYRA+JSeKawzDQ7v75F/QYQz4WT1UDclBWJnMPSI4pdyjMJTsoW2pkJ0sMCaXex7NhRUJSMwfYRDmz1ASRSeYa7H1W26vpjUBt99r4huHJSOFJSlH2+fwNgob8D9kHNub44CbM5Zritv51IKmvf5tooDVXtvz77iOqx8N0HvUqHGTmqA8JfOKsgBp/SxCavG2+Dvtfwh5h9KNmEPrZkuDRw7JTCtjMN0RBpdAm4FNsY5vsX24A7RHqCOKsC/oQaKoBVdkrip9m8Dwbq7uV6Te0hwJM27Fos8gr+Mp+sH8Hu2NP/NsAXBD1Oox1eoPkInHca+WDrM+fviVLbk/dMPcwpE1Lp3eYHRhR4YnZDy3oNegTTyVzfv2HwIuDJsAGrcacDhq6UGlVKMwFAB6sJUsVCamgsx2gByymfcJNpwYlSuL7QA4TnZY7gylAb3wVtwsjYWibhRseD82ICtgkqnSBd+02++2/xED1KXUaLVklJ70OAt+JYqq6OM0lS45zvkBob67woILyJjHgCuxv7dHXM2VuqjKTbx8QGAh4Ap7ACo5+MU83om6Z1/Nuc5ZL+neLs7o5MrD+DH+Ge+Pn+AMOwZtkqv0AnTt/CnpJuRUbSX8PWqDwTBJhA+EO3lAIZnSGWj0T7qSQT3603djr+LcPJ96cQzYqnyYSfGsCU3N3abTg7l5TlPI8Cg1sfzqIaeFcSEF4H48ZvkVo/HuNsdV2LcQRZcT9rVB9z3NjhgGixWy0D8glx3Qw5M0lcFcxJYp9ttMSmBRiyfedoI3TqGB5CCbakKzUnJlaeqc3abQfKX7XVJ1NREWiLB68GYPEa0D3HjlH0XbOS7r8S+M5q0xpdB5Ok/sXIOZqzxLwDufqHV+10dA04Ia6/a8CnxBEaC0zYKLnPvDPIz48wUwys2/evMrOw3gWPCMrfMjpQwlI9BJfhEa2JEcsQ9qAexUYXGdZm85HUe2HeYCtNlWTUPfevsSiPTOjigvxq2FoqRNrFU+pGO8qeeoUDgx5FCVjdU0pu+eYNhmhiLCBAou8tul9bjI75LS4yJvb3T7AMK+O2TH5twk9df7z6a409z6wAMXtx6NUXmQB1SLgasad0fnIXnQdJnAFIlhnQAynUm4RKIh0BNXkCWZMJNKG6DDpObces3E2q230L5WbiGcWw1GPxt0bx2JLgZlkynWlXa4+7YFmrSOmjguPPD0sr1sysfjccyzvRfxAfDnMd97xuPn+8+fvXiRPpnsP3+5YdKBWkGn3XeJ/d0Bn+tf+09nNQ7ZW4Fn4eytO3wesTd4KL0T9bkSUPia5juj8PcWvOlzETWG9mUX5SMfbbsj/kc7wYY1i7spWUO5v9tIxZqa40tu+jISTYUUZp74LCd6VywkcKHXA+SkPYPcHt8q1GzLmsF7OcHcV2knRPqmKMxYDWCT/e1X8QMKj5BpXmVo0R0htC0ajFmRmdSVKP3YGESkT9lV6WzverEbstZniS+1kjPmd9/9Mf4Q5R3E3JlkkLjXDlm8P0TpDl1/gZ3ZDtsfPzl4+nhAxeZKwp3rIY6xd6iGCEq+v9c5KMWKg1ykmzINg8qTVa4CHNYdPbZUB4/v3PWgGm2TrHJHOL0N/G0S2YOwNtcRnLavBzQ1GbT6bl2wNttFykHHc3XZKm+gWq5NxQ3N3v7O2QQcMlTz9QWinSO4nwHqSXpP5mJYc7PP9w1v7w5pFB9oByuFimY2eDr87u/E3GEHgjXBkDH6xB75Po+amwRSsRJ0IawNrUzwKhNuRPrAu3NOZX7Bfodok4KM7bawEiAzLT/kt4ED8Ufg26UvDl8zO/q8NcO/YFl4sDMzOhbVPmTVTaHGXu2oVtA9YI6eIon1SfJeztkhwBw+o8r01DJTlaXSlmUUHOXL/gm/N0dhDu4E9N7z0L3ihxZkN2DWO83aVC4mtLHJ3Qpe3mNfJntlLyvWKiP/ME0mQtv59qO8pXP1KaPu9dbYe1Aqm3ABINmc2x3T1rWgdwniffD+fMzh4Nn+8zjj/GV8ANnz+MVT2Iv3X0D2NNsDePHk6QaTRqdhd9iU5jln74X9Y4apuIwqfjkac9yuMVRYkuF57zTMAMaItEWsj5o9EwY2OvfMqXH2fDJ9Nk7jCZ9M4wO+P45fjF+O4ycHezDOXqZ8Mn6xgVN3s0JHhgs+Z69B50LWbEK+5Eti0aW/vXI7DoWYOtyMrE3oDTVb62u1Npaw+mi0LentostBJPXmUm6sD+00u/NuDXv3dowMj2BH7AvABaaapJ3T1bt/AB9CHZImte29561SGGiTtVcth3rdKeDv3FaMB4vdu1eIX4dAob5A/P82YrgeRZ9afuOmCf1JHMj1KPqt9iA3zfmnK/npSn7AlYTb77X1OsK5lZWNF/uxu8kR+4c74vazALHf8PXuCdHFx8GXPhCsK0zMRoyz8/a5VmLVBchzbNJ+uwTTXjNhqBhkmCY9f0JxqKO3PMfrnqUSmD9Fg0KXYpEhGDq7ff/gyD4BHQahMixTXyhFL7MeEYL4Kr/Kz8blt3cX+7v+W9JGa3a/D/1M8nS9G6L1VXTs1fGRP3XBu6w4xOAcPMKT+nUHQvUX9j///Z//xU5crcerFD0Je1XZOW63HYGv8i/YjvhYs68y/m7y2WvgGjT1YXSlvkmg+BKSmO5z4eknEnegffbq19PTY+qqtPjDe0HgGegt7677gdwQj2lmJlUlHLLzQV4fXmph4Zxustd5FaeF5B8Oo7VrgZfQJDlDsvDNqY67sNi8KtC9O3h9iyd7vNR+PnrrMmseyn/E/04PMb06Por/Xp9ZEQjHrA4M/3xNd7C3OL9CSL9o6Epi9O8ZSY8/t2LcGJUKKl6iJaQL4dgAFYRug0sMoERTojtybVrPKzwy7KwQkspeWrS3XE9eitj3FHL2r55g3Pr5McLAi+0YL6xjevNYz3hv/DTeexbvP3VvEU15lVs0083v19ffRpGBtNKUMzv7HjmtcEqBQhodnn27/jYKmbzXKqPcWl8E7vjuxMCjCt3br6taffMVVZQyp3Fd03nSt5NR//2ZgdFu8xrNEMiIG5iitE1h/ATGTw6AGzz6J9fSYwKGtgMvcl3FpgR+AdwsY1SLWC1Aa5FBeJoGs/RwZUEaSvLh8jlPuvYZs1EAfcNzZqiJgdQ6EDWtAAbFxJ92kb8kO4MSFN3N/tdzpAI9b6q6b/nwUji9ijMoSLlWpOEtFCrqMtPRi90pH37G6a4hPEjzWNOJ3jqaJX5ua9YJ+QiSH79naCtYLc84eNBs/HtCbmbgHQYiEVxMx3GhLK2q8LYjnHR8WG+A61GEav2pMQhtnRhShcYdhNK3sJMjI4820z2o5uob2gZqFKERNx+nJ6AXIoXWEjX2lJ7D2KWGuxliRgsS099Yp2B815XQDPJUFVS+QTgeGfbOKwULFcNozjOVVkV4aO9f/CM73B3HeHf1NozKPuFDKD7n7kobUMb8139rRArZWCpjCy5bdP5OIr/2bbj+FL43dvdnoPkz0Pw/GGh6u2Phyu6WORdkoPzzjs45nEULPNEepBSNosNNQan3EN/wQpexSOv7dwzxPuv8+hp//r0C3EiefUNnpakGnbxIJih3tCZ0bKvVL598fPCY3RC9rplseEWCHoYLHjPyT1psCLndPTUX624H+U8e+A5y2XFzeNdQM72Jat44ZsWnnaBoNXRteqD2lnZj23b4c/z5NBpFEx8tF4qCNs0vcdvCL50EhMNZDKfxt+9RzuWscmkNRxK9BO+68Npl+3+03jrqytj3767FKdqE6+ta5JxXpkTH/wJ9wGLW +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"; + + + + + + + + + + +When a webhook subscription is created, a `verification_token` is POSTed to the registered webhook subscription URL. This `verify` endpoint needs to be called with `verification_token` before webhook events can be sent to the registered webhook URL. + +Use the /v1/webhook_subscriptions/\{webhook_subscription_uuid\}/request_verification_token API to resend the `verification_token` to the Subscriber. + +> 📘 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/put-v-1-webhook-subscription-uuid.ParamsDetails.json b/docs/api/put-v-1-webhook-subscription-uuid.ParamsDetails.json new file mode 100644 index 000000000..1b2926457 --- /dev/null +++ b/docs/api/put-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/put-v-1-webhook-subscription-uuid.RequestSchema.json b/docs/api/put-v-1-webhook-subscription-uuid.RequestSchema.json new file mode 100644 index 000000000..b3aaa0afe --- /dev/null +++ b/docs/api/put-v-1-webhook-subscription-uuid.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"required":true,"content":{"application/json":{"schema":{"description":"","type":"object","properties":{"subscription_types":{"type":"array","items":{"type":"string","enum":["BankAccount","Company","CompanyBenefit","Contractor","ContractorPayment","Employee","EmployeeBenefit","EmployeeJobCompensation","ExternalPayroll","Form","Location","Notification","Payroll","PaySchedule","Signatory"]}}},"required":["subscription_types"]},"examples":{"Example":{"value":{"subscription_types":["Company","Employee"]}}}}},"description":""}} \ No newline at end of file diff --git a/docs/api/put-v-1-webhook-subscription-uuid.StatusCodes.json b/docs/api/put-v-1-webhook-subscription-uuid.StatusCodes.json new file mode 100644 index 000000000..9f7d2422d --- /dev/null +++ b/docs/api/put-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"},"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/put-v-1-webhook-subscription-uuid.api.mdx b/docs/api/put-v-1-webhook-subscription-uuid.api.mdx new file mode 100644 index 000000000..c04e40e21 --- /dev/null +++ b/docs/api/put-v-1-webhook-subscription-uuid.api.mdx @@ -0,0 +1,76 @@ +--- +id: put-v-1-webhook-subscription-uuid +title: "Update a webhook subscription" +description: "Updates the Webhook Subscription associated with the provided UUID." +sidebar_label: "Update a webhook subscription" +hide_title: true +hide_table_of_contents: true +api: eJztXNlyGztzfhVkcmG7iqPNkhdd/BWvOUr9tlWWHOcv2TUCB00SRzPAGMBQolV8itzkLq+YR0g1ltk4pEhausiJL1wWSaDxodHoDQ3cRjfxuNRGxlwYGCtquBSxmRUQHV9EkA+BMWDRIKJF0Wyio++DSIEupNCgo+Pb6GBvD/9joFPFC2wTHUfvbmheZEBCy2gQpVIYEAbb0qLIeGrp7f6pscNtpNMJ5HSR0vkEqRQKNAhjuxA5ItcwnEh5RXQ5rBrvRIPITSCSwz8hNdEguokNHWuc0lfXw+I33GTYzH8XnzWoRIOoULIAZbibX1lyhv970tooLsbRoAfmly8nbxGcmcBSgAoo+ySyWXRsVAnzQVSqbD3qHYpDUOTL57/vkC8FowY0ueZZRoZATj+dnQMjRhIz4dq26RtXG2pK3Tc0iDJHjhUgmPtmCoqPuBUHBbmc2r9KoYCmEzrMAHm6CNiNsDFDmg0SxNYESZWiswX2fIYU+BRI6VkxkgrH1EBs//YwI5ppGETcQL5y+q+puHqVprIUKEhvZF5QMav/eg0CRtz9JIyiqZGq9eGUznKwfd/lRSZnAI0/697hm3+TQ6QMQlMvhu9uDChBs1M6UzLLokH0Xqo8GkR/l2lo81EaPuLVx7rpKZ2dpRNgZYbDnvGxoEaqWfR9Pp/jtgC3QS0H/GathT1Kj0aMwtHz+OjwxdP48OjgZfySUohHe8BSAPbygB1GXnajiTGFPt7dLagyAlRMi2InlfluLahRLW5NWepb6b8w31EIf5RcAcNpWk5/nw+iJSsxpVn5y0tiJhD/XpY7toPdEYd7h4u256M05L0sBSPfBCHfhLNFP0rQBhjaNlmqFAiToImQhsAN12aHfKBXQHSpwCq+QskpZ8CceeCaTGnG2c43EeGwBweLw34RhZIpaI26lbwThptZhYBrktMZmdCiAEGuJyDsKEPJZqhqZ7JUASNBk0u50ASUkkoTXaYTQjW55MKCSKgxig9LA4kVt8sBcZqzojCiPNOElYD2hIq6J1pIy+bLHXIGbqYX79wwb6iBsVQc9PfHQRKZTPWOdTisEAYHIy7cEtnfdy3MOK26PyHjkjOw+jyXCggDg4CQeVs7FH3c/c3cLnO7jlRTdbkJo9Fve0r++0Vr3bW1y6kmV4AdPMrZkjFsqzudprMCUtRpGhfSb0bbncg0LZXeIeezgqc0y2bOVbqCGeEMhHG9sH21hmjdaA4GUAAyaoKH5Unu4GauUG8ADSlgWxQvR4mglgmkgvbwUkbGSpYFF2NNqGAkpQI9vlI7NMOSZ4ykKAe5bz+hgmVcjAkXTnobrvwOORnVA3FNLoVVbIlbx8uBBefWynmXXuQJJa4lufRNiV+kGbnmZkLAqSz3o2VNjvttDHdz5jTM10sjoUNZmsbaxWQMAlS9ap50YIYu1YimjiFUEBAM+aM8CkMZNbRPFNsw3oTNrSCDKRWGYD+k6QVk5neyNwFcELunMTyxasNrpGEGO+S9VMRb+UGLhMVnWXXp/rfm9tKubfgGzf9l5dwHY4IurRTwaRQdX9w1l7zMDMdgzFLEfdTZeOHrxc0WftlgS7fH1lyMw8jYjTLG8SeanTZGQs+/d2zHkLul5iPNIQQanqNmQptik0rlYlGmiZFWGhoMvnuEL4L/KKFWDyoEGX48S9Fp75GSeU3woqYoyiyzLp9rVxaJkasbtvRcXwP032BVk3kd7X7w0h9/5WYSfxIQO+MXzZe3+uBlxzXFpZkPfq/5X2HNbeixzGC3+fAVlY8U2cw5uISvNBs75MTg14XUmqOLZSSZ0CmQSg9lMIXMJga8GQmGolIrUcpVWmZUPXZwY+v8xJ+swD2JmjPsaRD1xLhDKq4S6uKXhEEGBpJSjErBgCWFi01aTsxFy9eIhtQlsSoTHy04a1HDzEXvS5s8+QBmIhmZUE3CaKQaza5BC5iNwmYJF1Z0U0RaSM3vFdk/0A3AUYkfFS0nRi9DICEK3CGnGVANJJ1AeuWcFPRYPRxCc+yIpn3ZFGiGGZdZUsWVDzkBZK8fkAwBRD2PHoA516ihEiVLg9tmOTDfIhFl7qLlHogdJ78F9LPrT1x/3BPB7HpcXhKSVIoRH+sKWuVrbsS1xd5NMK8MwSU1RAogtTObl9o0HYt+YGG2I6pN2C1JxnNuViDsabwxC98jYk+DWBpET2SZMcRMPWcrzEkBiktW4wXBEua15RKUVZNebP28fCcY+oPQ2Dk2gjITKshTkkthJhp9wlFpSgUOX+oSJQkXrNRGzRINGaQ2ySIoT3WSSgZJ7ZgtRVy33pyfH7Evwb494rgeQj/MwwMMogk/SpqhFXlGGB/zSu2sgKsDAL0GXM1T13ZztGc8tVj1IthDD9ZhNTyHRI5GSSEzns4SQfM11zrfiol53/p2QZTC7ihg1X6haapKmiVq9Z5pNdtAc79y/Qj2qzg2zFCVo2dV4SEWIAe9BLg/mUh8ImWVdex03QTtG7e5GdDU8ClCdjRcjOsxEByAyNEoZHWWYQaf2NTrLHvVePO1DwlUTaiC9SVgSDMqUkjcEcpW1noVqjdU2AwpZX/aZXej6dXLPpEZZ6jV8Z8DHNwK64jep1fk09iVG2FdCuIRoAXyi78cmpDm4WBVKWbrSfcBG5DCu2wKUFalgKVQK/NYidmDiOKJa0MCCYJhl27kMCw+KYaSKnTDQ7v75F/Yw+jwk2qoCpKDsDCZe0RwbnOPXNtkjw1LuWhlgTG53LFozq1IQGD+CJ0wf4aSSHuCuRRbt+Xm27Qi4OK92r9xWJjdsFbKUfc5vPWGDfgf0o/tzLHHzGlDlfXb6ciAsrH+Ol7AYq/N+Xda+dWPeug9qrdxnZqweUriN8oUhPGzCKnFdfG32v8S8halOzGH1nVIg0cOyVhJrTHdEQYXYIOBVb6Ob7G5uwM2Rqg8ihAXdCBZrwVXZCJLtY5juJ2p+wOpN3aOgDE1fNplkN/jKdrB7B71jT/zbABwQ1TbY6TkTxCJx3Gvmg6zPn74hZDcH7phbuHEaJdOrzE6t4PhCRnNDKglaBNPZXXc/kvAuSZDQOVWAQ5HLR2oNtXItXUAPdhS5JLxEbdqO0AO2cz7BBtOjIqFxXYAHCdbLHeKUoOaei2uZ9pAXjUKOrzrG1gtoJORVDldFe232/+KAmpTqne1IDY96XHm9IbnZd7FqUtVUJzzA0J9d4MFF8CIx4Arsb+3Z7maSXlVFqt4+YDAgsMVYgBbcvBYP9mJ2mdf9bnORSfp3izOaOXKw/gxfoz3D57iDFsKbZjJ9ApUZfxt0o2LkdxI+DvUep1hKxHeEW7lAbkgUjFQaJ9UKcL26E7fjb2Ic/V8qsXRYMriYSZFWe2a6u2m04G5ek4jYHiUmhh685DTQr/QOuB+PGLoDbHjbTfHRdhriKLLCfvaoPueZksMg8YKWehfkMsW6P5J6lJjLmLDFPs6k+JY1OKJN43gnVOoITnIuhzaWUmxsDRVzm6Va77QfZtUXUWEBCKkGryOIaJlgGur/KtoW8dlHf6F0bw2til0mk4SM1GgJzJjCXjjEzXO77oI7LSgwro5rwJfUARs2mZKeUb9YR56/NkUiM3Nv3rzBzkP4EiwjI3zIym1TUagkfzKFZATMSAf5BTIucTiOkXeUnsc2TSYU1B6020a+lbhSyDSOTuyeTFqDOSFDWKN9C4doXU9R4nCiS6HLE0sR7H93RMMYWYoIkwgpzxbL61HebZNSo/yrBnodgGEuDtkxyZUJ9Wv959Ncae51YEHLm41GrHlQR5QJQauatwdnYfkQd1lCCMkhnUCyHQi4BqJBkeP3wBLGNfDUmmwh0n1ufWSiTVbb7D7GrmFcG7V6/2s2HvLSLQxSJOMsK60xd23DdB219kmjgsPPD22x0b04OAgpmzvRXwI9HlM957R+Pn+82cvXqRPh/vPX66YdKCW29PubXx/d8Dn+lf202mNY/KW41k4eesOnwfkDR5K70RdrgQUvqZ5axT+3oJXfc6jRte+aKN85L1td8T/aCfosHpxVyVrbO5vHalYUnN8TXVXRqIRF1xPEp/lROuKhQTO9XqAnLRnkIvxjcSdbUg9eCcnmPkq7cSSvssL00YBmGR/81X8gMLDRZqVDDW6I4S6RYHWCzKTuhKlXxvDEulSdlU6m5te7Ias9VniayXFmPjouzvGT15sIeZOJYPAWDtk8X7ywh26Poad8Q7ZP3h6ePSkZ4tNpICt6yFOsXeohgibfH+vdVCKFQcZT1dlGno3DytdBTgsO3psbB08vnPXgyq0dbLKHeF0Avh1Etm9sFbXEZw3rwfUNRl29d26YG2285TDHs/kdaO8wdZyrSpuqGP7rbMJOGSo5usKRDNHcD8DVJP0lsz5sPpum+8brm8O7Sje0Q5aCjeaXmHp8Hd/J2aLCARrgoER+xN55Ps8qm8SCEkKUDk3JrTSwaoMqebpA0fn1Jb5Bf0dvE3rZGwWwgoApht2yIeBPf5H4Nu1Lw5fMjv788YM/4pl4UHPjO2xqPIuq6oLNfYqQ7WA7gFz9NaTWJ4k7+ScHQLM4RNbmZ4aosuikMoQZp2jbNY94ffqKMzBnYDeex66U/zQgOwGZJ3TrFXlYlxpk2xX8PIe+xLRKXtZ0FbM2odRMuTKTDYf5a09Vx8R270Kjb0FtWUTzgG0Ome9Y9qqFnQbJ947788PKBw+238eM0pfxofAnscvjmAv3n8B7IjtAbx4erRCpdnTsC2C0iyj5D03P8eYimO24peiMsdwjeCGtTI86ZyGaUAf0YaI1VGzZ0JPoHPPnDpgz4ejZwdpPKTDUXxI9w/iFwcvD+Knh3twwF6mdHjwYgWnttNCJ5pyOiGvQWVcVGxCvmQzy6Jrf3tlPQ4FnzrcjKxU6B01W8trtVaWsHpvtCnpzaLLXiRVcClW1oe2mm0drWHvTsRI8Ah2QL4CXGGqSZiJvXr3D6B9qEPSpNK99xwqhYFWaXvZMKjzVgF/67Zi3Fvs3r5C/Do4CtUF4v+zHsN8EH1u2I27JvQXMSDzQfSxsiB3zfm3KfltSn7BlITb75X2OsG5FaWJp/uxf7Ejbr4HEPtIr3NRyr+7gQkL/6YKab6pQqjWMuW2bCJE3+178TvfxDfxN/I///2f/0XOXGHCqxTVHnlVmgnGhi579E38DdtZ5xMEKyRHE6D92BevgSpQtg+x97/raN/XO8T28hEe1SFxI69AhFTLH+fnp7arVPynV9lAGagNL1r7gdwQT+zMdCoLOCaXnqVJk6X6+FpxA5f22nWVBHAiY5XZcdTXLcTcXFjNbdVRfQThbtfVV+DbF93ma7wv4xbOro1Vgx7Kf8T/al8NenV6Ev97dcBiQThmtWD4t1bag73F+eVc+EVD0YnRGDHy6vQkHLIsiIy9vYwN8MK2vbos0Nrzup504No03gJ4pMlFzoWt0WjQ3nA9acFj35OL8T97gnHj6ycIA29ho3FbxvT6ZZmDvYOjeO9ZvH/kHs4Z0TIzqFPq7+fz74NIQ1oqm+C5uI3crnCbAoU0Or74Pv8+CGmn15LZRFBXBLZ8JKHnBYD2Vc21Xun5f/3GTvOKdQ+31nn6pf8llppN1aS/ez3eWUT0I3uev7qJdQH0CqiexbitYzkFpTjDJXJHoZ0HseDGgNA2u4ai6EzY0vfDBmECd7wjhlolkFoGqKLVBwzF3x85WaNl9SfujGh3ur/bq2t3b5fq0jnuXSyP87q3/ZIOLbhTFDGD3GqLBSv4FnIZtbnr6MXujA1/xjkvIdxL81TZ87RlNAv8uakqzqzRswLlxaSpMaqNiIMHVYWfh9Zu9ryCYEkEm9myxChcizpp0xHOWka5M8B8EKGe+lxruMYmufuVIpfAd/VnIZyyxgttgXvVzBUZNBXvIELjpD+NzkBNeQqNlarthH2TYtc23GUIHTVjbD9jsYD2XRfuUUOWytzWUFgcjzR55zcICWW7aKaYTMs8vHb3T/6lG+rORLwZfhtGJZ/xNRKf+Hb1BShq/td/qSULuVlIbXIqGnS+hMqHPuvfncBtbU1+u3z35vL5DWPgxuwWGeV2Z/lXAZ06u4imeBDaSykaRMfL3cPveP1HGyRxe4s+1heVzef49Y8SMOy4+I4aVtmKZav1GLeZhiW+W1MCHn/2Bu4JucN9XDLH4CxYUxbUfOQfQFjh87pbTc7Z3AzyX9zz7OWy42a/214xvTbFbxyz4vOWJV/0HeseuGkLs7Jt006ffjmPBtHQu6u5tF6HotcYN9BrJwHhKA/9WfzuNsqoGJcuCHYkUZ3RtsmpTIz/o/EyTlvGbm9di3NUBfN5JXJWNdgUzPx/AVLJr3k= +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"; + + + + + + + + + + +Updates 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/put-v-1-work-addresses-work-address-uuid.ParamsDetails.json b/docs/api/put-v-1-work-addresses-work-address-uuid.ParamsDetails.json new file mode 100644 index 000000000..a30c71c44 --- /dev/null +++ b/docs/api/put-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/put-v-1-work-addresses-work-address-uuid.RequestSchema.json b/docs/api/put-v-1-work-addresses-work-address-uuid.RequestSchema.json new file mode 100644 index 000000000..60b880a55 --- /dev/null +++ b/docs/api/put-v-1-work-addresses-work-address-uuid.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"allOf":[{"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"},{"type":"object","properties":{"location_uuid":{"type":"string","description":"Reference to a company location","example":"6a119be7-b4b0-4e27-aaa0-89d5f2524635"},"effective_date":{"type":"string","format":"date","example":"2023-05-15"}}}]}}},"required":true}} \ No newline at end of file diff --git a/docs/api/put-v-1-work-addresses-work-address-uuid.StatusCodes.json b/docs/api/put-v-1-work-addresses-work-address-uuid.StatusCodes.json new file mode 100644 index 000000000..5f673ac5d --- /dev/null +++ b/docs/api/put-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"}}}},"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/put-v-1-work-addresses-work-address-uuid.api.mdx b/docs/api/put-v-1-work-addresses-work-address-uuid.api.mdx new file mode 100644 index 000000000..5ea2ddb51 --- /dev/null +++ b/docs/api/put-v-1-work-addresses-work-address-uuid.api.mdx @@ -0,0 +1,71 @@ +--- +id: put-v-1-work-addresses-work-address-uuid +title: "Update an employee work address" +description: "The work address of an employee is used for payroll tax purposes." +sidebar_label: "Update an employee work address" +hide_title: true +hide_table_of_contents: true +api: eJztXFlzGzmS/ivY2ge3I1gSSVEixafV+NjRg7sVbXu8E25HGSxkkWgVgWoAJYmt0H+fSBx18RApS7s7u/PQ4RYLx5eJvJBI4D6SBShquBSXLJpGRWnim0F8K9V1QhlToDXo1p9JWXIW9SIGOlW8wJ7RNPq0AIKtiG9FZEaoILAscrkCIFyTUgMjmVSkoCsl85wYekeKUhVSgz76TfwmdCoLmJLvoZeeLqmgc/ge9SJD5zqafo3ehREvArroWy+6i+elNjLmwsDckRObVQHYA5YzYAwQMy2KZhPbtaCKLsGAwuHvI0GXEE2jTRRzJLSgZrGR+s+fL98i1abDiagXKfij5ApYNDWqhF6k0wUsaTS9jxzGSBvFxTx6eOhVAP4r/k9L0cXVZfw3UBon8hAWQBmoaPs4vQhEuUTah/3hadw/iwenSCqDjJa5iabN3x+6xLxFZiy5AG1pYdRAPKO4eBdXl+TGYSFUa5lyaoCRW24WZCVLZRukNM+PyGVGhBR23QslbzgD1nNtaFHkPLX8f6XJ1yUXfFkum2N/+2lhTKGnx8dMpvrIruxRKpfHYSVjL0H2+zEteOx7cjH/dz9g3Pj5dRC/o+jhWy/SkJaKm5Vd7zdyWVCxukhT0PqiNIto+vXbQ0OklL6l87ByCnQhBQrd9D4a9vv4T5t7urQjZWUe9aJUCgPCYKsG2ce/a2x6v75+cvY7pCbCyeGOLovcTeTHTLShprS/WImcRmcjgNOMjeMTmA3jUX9yEk8mJ2l8fgrnJzCYDNJ0gtLgdSbx3dh4fDI6G2TxZDSh8ahPB/Ek65/HsyHAaDg6Z6fpOOpFuXR4Q7fxyQmdDWkWn58O+jhbFk/YsB/3zwfnZ+dn48F4lOFsWQap4TeQoOg4YevH/UF8MkAVtJ8CP/0CRdPoZDI+nwxP2GjUz07oyXBwygbDc5qOT9LTyfnZGYq7UQAmGUTT6Hw8Jh+outbkb5yy0vLMfx5G0+iiMEfk/BRpT+1CR1dcXJO/8jy3DR2un99EvehPXiDEyel4aBesFEZhh88fL1Afo0KhgTQcGnxf1zcFlP0i8lWga908lIL/UQLhDIThGQflbAXXLWNxhOrYZeD6dOvDY0urrpXFncGcCjs4F3NCjZssrKmdKKxFNcFMyhyoeJSgj3wukAhNuCcimH3ujIYbue0R0PTjt7RUCoSxkBFFR8weo9baWQUZKBApECPdoE6NK/r8bBvZ29aGp81XsXn7PJVs77N+gSnBvHpH4gzCEfkIbnW/1oaOzEvO4EBbyRksC2lApKvXFjoXmVRLxzIpyELeIoWlBkdUxiFnlppa+R6T/oemKobGX+vWosxz9EZrvZyq7jX8Fr1Ya2m1e492ld7vo9rBiQYTUbv3r5EPFcLaf+tFhpscBwyBS/xFquvYRy/RwwOOMOqP1j3Jz9KQ97IU7BBHsmUI8psg5DeBkoZoQaPfVqBlqVIgTIImQhoCd1ybI/KBXgPRpXIyF/w3uXx7bJWBa3JDc86OMCzrOK4mL0ApqVyM1TKi/vea11QpusLoxsBSb3KHa6Mm14AdUmpgLtVqyxy21aPq97GA1Bmz2wV4mm13ItO0VPqIfFoVHMOalVOKa1jVdtzbO2MUn5UGjqtwkijIbXgULAYOaVWpQn0ANBwB26JhcCMRazb8UGGRtEc+V7IsuJhrQgUjKRVkBi4AN5LMSp4zkqKpWPr2CypYjkaFCxelNaJki3kJWtP5Hs7oKgBhYCjPNaEzWZoGU2MyBwGqZqcfOqDUpcpo6pDiDkIwBI6cc7rSDo2ENElmlaQhWF9b6x95iW/Ky7TRsUFctEVBbqnTD9sBg0gEEhT7Z2liq2TxO5w0/sVJrdfs4XBdLUtRKIkRHZ3lQFCQzOrpSv65Ndo7O1pQd2QvXZEFLQoQKN/CrsRMshVKkl1qTy/B6SkXXoQ00WW6IFST71xYdU8qIU9uaF7C9x7xHj2MkNkFZyX4tat6VnvM7w1X9s5N88atCQd9oC+zMOO06v7aeUTr1pZSQZDAo9/EvwzV/wtDhbvOaiKuyXdh9Thx6/i91wipyC3P8yDyhBLXknz3TYlfpJXb3DoV9Yrxv8YeIgpDGTUbt5BtGG+CcivI4Ya68JvimF5AVl6TvcXjglidxrjQmg1vkWY5HJH3UhFvhHutISw+y6rv7t8EUX23axt+wQjpu2P/rA4uMJaQAn7JrPXeTcuyzA0vguVEPeooXvh5XdnClwNUurO952LetNmUMY6faH7VmMlFihvmdgx5XGp+pksIewDPUbOgTbFJpXLJCKaJkW5jUzN4j23N2n407M/cMG4LY613puRyRyRftSuLxMjdDVt2blODTmi/3qTheD946Y+/cLOIfxEQO+cXPWxv9cHLjmuKS4M5t3+t+T//muNIWx12mw9f0PhIka/chgeTGDvcxhG5NDaPKbXmGGIZSRb0Bkhlh3K4gdymvL0bCY6iMitRylVa5lT95OC2QsXXUZPCDQ2iDYHvjIrrhKZ245owyMFAUoqsFAxYUtDVEoTRO4JizOi2I+K1YK0VGb8vBeNi/gHMQjKyoJqE2Ug1m12DFrAbUDxbJVxY0U0RaSE1f1Zkf8cwAGclflb0nBitz4DY+TmwI3KVA9VA0gWk1y5IwYjVwyF0iR310XYSaI6JgFUSRnxRApC9fkIyAxA1HRsALrlGC5UoWRpUmx0bIdciEeVyZg8QNkDsBPktoL+6/sT1R50Ibtfj8pKQpFJkfK4raFWseRDX1ns3wVwYgktqCB4z1MHsstSmGVhsBhaozag2QVuSnC+52YFwQ+ODWfgeEfsxiB2D6IUsc4aYqedshTkpQHHJarwgWJUU3oKyarIR22ZevhPMZZBrzbE7KLOggpyQpRRmoTEmzEpTKnD4fMo14YKV2qhVoiHHvLUUiaA81UkqGSR1YLYVcd36cH7+jH0J9t0gjvsh9NO8PMAgmvBHSXP0ImeE8TmvzM4OuDoA0HvA1Tx1bQ9H+5GnFqteBzvyYB1Ww5eQyCxLCpnzdJXgqeV+a718EhOXm9a3C6IUVqOAVfpC01SVNE/Ubp1pNTvAcl+4fgT7VRyb5WjKMbKq8BALkIPeArwA61wTn0jZ5R07XQ9B+8YpNwN7OoOQ3Rhuj+sxEJyAyCwLWZ1tmKtD+n2WvWp8+NqHvLkmVMH+EjCjORUpJGXxiL3c7q13oXpDhc0IUva7XXY3m9697AuZc4ZWHf9zgENYYQPR54yK/Ll2FUbYkIJ4BOiB/OJvh4YZ0heDVR052Eh6E7AeKXzIpgBlVQrYCrVyj5WYvYgoXro29eEfbrt0I4dh8Ukxk1RhGB7aPSf/gg5jwE+qqSpIDsIaMc+I4JPNPeKRr/DbUi5aWWBMLnc8mgsrEhCYP8IgzCiaGqkSaQ/WtmLrtjxcTasB3H6vjm8cFleQZKUcbZ/DWytswP+ScWyHxg1uThuqbNxOMwPK7vX3iQLWex3Ov6sqrn61YbxXtRrXqQmbpyReUW5AGE9FSC3ui7/V/oeQt0Z6FHNoXW9p8MghmSuJlWBFZWsE2M3ArljHtzg83AG7R6giirAv6ECyUQuuyEKWap/A8Gmu7q84ekNzBMwpVnd00HgdT9EP5s9ob658tWANwE1RqUem5J8gEo/jWS0dZn389Gtbcn/ohrmFS6NdOr3G6MIOhidkNDegtqBN/Ci79+0/BJxrMgM0bhXgcNTSgRpKhDCm8mBLsZSMZ9ya7QA5ZDOfE2w4MSrWFtsBcJxssdwZSg3qxltxvdIGllWjYMO7sYG1AjpxZS97xAmu/Y8YoPZItVYLYtOTHueS3mHdYhenLlVBkeYXhPruLgXAKMJjwJUY9PuWq7mU12Wxi5cvCCwEXFXRL9af/KRfH0Xts6/6XOdrJ+lebR+iTq48zB/jn/FgeGJP9ZsGbZbL9BpU5fxt0g3rpQ4S/s5oG4NhKxE+EG7lAbkgUjFQ6J9UKYJ6dMl3c6/j3E1PtTgaTFm8DFGU1aGpfho5HZi7acqA4VFqYujdS5KFcaENwP18tpTdzvc0Gtdh7yGKLifsikSencyWGAaLFbLQPyCXLdCbidSlxlzEgSn2fYjiWNTiB286wUdJqCE5yLqcWaqkWFuaKme3KzRf6/6UVF01CAmDkGryeg8RbQNce+UfRds6LuvwL8zmrbFNodN0kZiFAr2QOUvAO5+ocX7XRWDJggrr4bwKfEERsGmbG8pz6g/zMOLPb4DY3PzFm7+STwEcCZ6xcX4kpbbJCHSSX7gCcil65IO8AfJJYrGlIm+pPY5sOsxGLfDBYVO1fbmproG0zo5sXowaA8vCbmKxfteGdITW9RyltlXggsjSxDKL7Xc/YNhm8rmgRipM7VGe75fWozx/SkqP8ry50e0CCPvukB1bUJ1UX58/m+JOc6sDD1zcajZiy4M8oEoMFCxxxe3ReUge1F1mkOFgWCeATCcCbnHQEOjxO2AJ43pWKg32MKk+t95CWLP1AdrXyC2Ec6uN0c8O3ds2xB7FlG8boDvlk70XJo/1WUaHw2FMWX8Sj4COY9o/o/F4MD6bTNKT2WB8voPoMNrSnnY/JfZ3B3yuf+U/ndWYkrccz8LJW3f43CNv8FD6KOpyJaDw136ejML1D6bPRdT+Hl4T5Ssfbbsj/ldHwYb9T5XY9qKMC64Xic9yonfFQgIXer1ATtozyO3xjUTNNqSevJMTrK6t2KEfi8Kq6xMHr+IHFB4u0rxkaNHdQNXlwq7MpL6U+IfmsIN0R3ZVOoe7XuyGrPVZ4lslxZz43Xd3DryucbiYO5MMAvfaIYv3Jy/coetPcDQ/IoPhyej09QYVW0gBT66HuMLeoRoiKPmg3zooxYqDnKe7Mg0blYeVrgIcth09NlQHj+/MAnSjvLdOVrkjnM4Gfp9E9kZYu+sIPjWvi9Q1GXb13bpgbbaLlIOO5/K2Ud5g/B2grcUN9d7+ydkEnDJU83UFopkjeJ4JKiK9J3MxrH7c5/uG+7tDO4sPtIOVQkXTOzwdfrd9nrQDwZpgYMR+Iq98n1f1TQIhSYF3iY0JrXTwKjOqefrCu3Nqy/yC/Q7Rpg0yDtvCCgCmG37IbwM3xB+Bb7e+OHwLdfbzwQz/gmXhwc7M7bGo8iGrqgs1+pWjWkP3gjl6G0lsT5J3cs4OAebwia1MTw3RZVFIZQizwVG+6p7we3MUaHAnoM+eh+4UPzQguwlZ5zRrV7kYV9okTyt4eY99ieiUvaxZK2b9Q5bMuLKvEhw4y1t7rp4R273aGnsP6q7n2gDQ2pz9jmmrWtCnBPHhnvmQwuhsMI4ZpefxCNg4npxCPx5MgJ2yPsDk5HSHSbOnYU/YlOY5Je+5+XOOqThmK34pGnPcrhFUWCvDi85pmAaMEe0WsTpq9kzYsNF5Zk4N2XiWnQ3TeEZnWTyig2E8GZ4P45NRH4bsPKWz4WQHp55mhS415XRB/gIq56JiE/IlX1kW3frbK/txKMTUILSLp6u8x+66ne21WjtLWH002pT0ZtHlRiTV5lLsrA9tNXvybg17d3aMBI9ge+QLwDWmmoRZ2Kt3fwe6CXVImlS295m3SmGiXdZeNhxq+7Zk67ZivKXYPdyqBm3+ItkqCP9elyNpnm+5RdS+m7Hjer6vs4+m0ekZ6/fTwXgyS8cn5yezIR32z4Cd0ckZzdLZ6J/xLn/nxvqGq+r+vRm7Qr82fc9ujh74kMOvzTcV6NoLDq11OKODwfkMxvFsNOvHIxiOY0ppP56cs9NseDocnXmX8OjTGeHcN/I10vUcw/7wJO6f2jdxML5rM8o/FHAX6wLoNVC9iu3dxcYpZ/0iUbsduvFY3oBSnOFELjuLzwBcVE8EwZ0BoW28j6LrtHPrq0b29k35+OtGuGbtodxrNlV/R1XdqEtc1XADkZv7tYmt+68TjY/s+ASbfXcK5QkfV5pGxzeD4/YLVMf3aw8yPeBLLnj6781aqXJ0/l6DaMGdAsUMllaL1uTvLSxlZ6XceLFLIeJnpHHLwBvHvFI2XbhtzAI/N58g+ohmy2nPhoeIKunFycN7T/adFqDK7oC6lzztELG9j0RoaRa4CQ2Hbb3oo62Q+JEZ3AhbJnjoRWiOf60N97ugXA1zu49N7b48tJf6b355qFJpTH64s/tg5uwDW/jwVNR8iKjxNFYvwpew9C/ZR1A3PIWGGNTG2d7nPbYNjxnyBU1ibP/Ggxbtu67dQYM8lUtr+yyOV5q886pMQskTvonFZFpiXGD58W/+lQDq8kn+qbC3YVbyK97k9kkDdzaDcuy//kcttvZhI6nNkorGOJ/9qVHj2bbOQ2YtEho++b/h+TcnpgbuzHGRU27l2WrmvbcaX6MbzK627UbUi6brT7l9wyJibbDP/T2GQJ9V/vCAP/9RAkZBX7+h4VK27skaF8ZtvMKiaUZz3X0PqcmJn4LDfE0eeRVuI0nh3qJYNWxn5C9RbniVzlVEuwfhDgP6f/qZty3cdVzc/LRexezar71xzIo/tXzuevxZ90DbWpidbZte7+rzp6gXzXyIu5Q2PFD0Fi+001u38iENOL13v91HORXz0sXjbkhUZ9q255X99v/TiIfbsnV/71p8ktcgHh4qUTP4t43dH/4BlPlvbw== +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"; + + + + + + + + + + +The work address of an employee is used for payroll tax purposes. + +scope: `employees:manage` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/put-wire-in-requests-wire-in-request-uuid.ParamsDetails.json b/docs/api/put-wire-in-requests-wire-in-request-uuid.ParamsDetails.json new file mode 100644 index 000000000..6742684e1 --- /dev/null +++ b/docs/api/put-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/put-wire-in-requests-wire-in-request-uuid.RequestSchema.json b/docs/api/put-wire-in-requests-wire-in-request-uuid.RequestSchema.json new file mode 100644 index 000000000..746a84756 --- /dev/null +++ b/docs/api/put-wire-in-requests-wire-in-request-uuid.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"date_sent":{"type":"string","description":"The date the wire was sent"},"bank_name":{"type":"string","description":"Name of the bank sending the wire"},"amount_sent":{"type":"string","description":"Amount of money sent"},"additional_notes":{"type":"string","description":"Additional notes"}},"required":["date_sent","bank_name","amount_sent"]},"examples":{"Example":{"value":{"date_sent":"2024-06-10","bank_name":"Chase","amount_sent":314500,"additional_notes":"Wire for 2024-06-15 payroll."}}}}}}} \ No newline at end of file diff --git a/docs/api/put-wire-in-requests-wire-in-request-uuid.StatusCodes.json b/docs/api/put-wire-in-requests-wire-in-request-uuid.StatusCodes.json new file mode 100644 index 000000000..38bdc679f --- /dev/null +++ b/docs/api/put-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"},"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/put-wire-in-requests-wire-in-request-uuid.api.mdx b/docs/api/put-wire-in-requests-wire-in-request-uuid.api.mdx new file mode 100644 index 000000000..1b0630200 --- /dev/null +++ b/docs/api/put-wire-in-requests-wire-in-request-uuid.api.mdx @@ -0,0 +1,71 @@ +--- +id: put-wire-in-requests-wire-in-request-uuid +title: "Submit a wire in request" +description: "Submit a wire in request for a payment" +sidebar_label: "Submit a wire in request" +hide_title: true +hide_table_of_contents: true +api: eJztXFtzG7eS/ivY2QfHVRyJpCXr8rSOL+foVNlR+XJ8so6LBgdNEvEMMAEwkmiX/vtWN4C58SJRlh425VQlsTlA40Oj0Tc08D25SueVdTqVysHccCe1St2yhOT0UwLFFIQAkXweJLoE//VMJKdJWbn0UhqYSDUx8FcF1tn+D5OqkiIZJAZsqZUFm5x+T8bDIf5PgM2MLJFecpq8vOJFmQOLLZNBkmnlQDlsy8sylxmNvf+nxQ7fE5stoOD4J4810dM/IXPJILlKwVOj4cKf8Y+E5jQZHoJ4MjocpocnI0gPZsfTdDoTh+nhoTg4OgYhxuI4GSTWcVfZ5DThl1w6qeaTWaWETQaJNnIuFcGZTLn6mpwm/zpnr7WZc8WeLzjB7zeacCEMWCQ48o3Yec6/8QF7A5fsd22+Dtib39loODweEcsyWUpQbqJ4gdP7B67RgJ2prPO1oXo4PmTjoVuwd84AuAF7xxV7ZbjKpM30gD1/xk4ORsOjbvcs0xUOUhVTMMnpeHQyGh09HbXbGF3R9GOb0fjJweHBk/FokHAhJM6Q5xOlHTI8eVb/xN7QT4OEph+mscoowR1MLK10Mh6OD9Lh03Q0TAZJpeRfFUyc4dlXHD/TAimMnLm4urwqD4++zZJBUvJlgSiDFJzzpdF53voQVv1wxjkcHB6k8HR8kh6cDKcpPxrzNBuOx9k4O4GnU+QsL4gfAc9oODo4HA73hkPiGgk1iIlv1P8ehV8AF7lU0JrPePR+dHw6HJ4Oh/+bXF8PetL/FkoDOCSJC9MzxhlSY1KxMCpOyOAOdNLLtZ9WLf3WGanmSZ/yB+IhkwKUkzMJZj3x60bcb6L4jtohGbeASCgZJKCqAjXGym4pQQn8u4ELCZfI4rI0+gJQMWRcZZCjerlet61uwvKGF4BIsDUzkIG8kGreAbaGbrNnbqL/zDe8eYj+br0tcCRT9+3w9KxH9y6YN1Pvo+6rgZsGeVtTJb6E7ix0v96mPXYkHbq3SK/qnEjyU0NTVXmONqvHdmzPZtq0OdHeBC1NdXuirbUkyFJJJ7lbIyYtVXdr8i+4gw7cS24Z0bjepCJvYvGZyvJKEDHkILuUbuGhO82IFgvKE8foKtibaL9flsSN0KvP7JaiaDT1c61wVKfNue/1D6OrknRCV4nfSdvh6K3pdBT8rVfhGfUivjO3MLqaL7o7qW8abhbz0IP5HjWjWlBXDcpNVF+ElriQtpoW0nVF8HqQOOnQG0o+SgPpmUrfNtK/wW264HnV9p+yw5ngcHiUHh4cP0kPDscn6QnnkM6GIDIAcTIWBz/9p5/+08P5T/jPIDkYHqwGEm+0Y690pQT7QzH2h3pPNjDuNQNWVyYDJjRYVH4MrqR1e+w1/wrMVsarWvRPpADBPnw4e8GkZRc8l2LvD9rrB+Px6rAfVGl0BtbyaQ7spXLSLWsE0rKCL9mClyUodrkA5Y2FFktUUEtdmYiRYdTDpbIMjNHGMltlC8Yt+yIVgZhw54ycVg4mtC+/DFhQHJHCjMvcMlGREuCq6VnHb1/22DvwM/300g/znDuYayPBfv5l4VxpT/f3hc7sHoWGe5ku9mMomJZeROj7PsFMs7r7YzavpABSZ4U2wAQ4BITM2yGmu5m7P5nbZ24/DkbM0oCgOJ6QoF3rRhHh98awcGP4Mhkk0kFh10XXK1QnX2FJrjyhXG4Yg1rdHFyUkKHhtriQYTNSd6azrDJ2j71fljLjeb5kDpf+Kywbc2+pfb2G+yU3vAAHKAA5x/2P/k0kuYebuUa9AzSk4IKb4ykx1DKRVNQeQcrYHJ0ZqeaWcSVYxhWbAqusRzOtZC5YhnJQhPYLrlD9zdE9I+lt5WX22NmsGUha9kV5jerX8cuAwPm1Ypcyz6PIM858S/YlNGVhkZbe/QOvsvxHYk2B+21+C6fjPM43SCPjU1251tqlbA4KTLNqgXRkhq3MjGeeIVwxUAL5YwIKxwV3axM9XRjP4+Y2kMMFV45hP6QZBGQZdnIwAVIx2tMYcZPaCBppmsMee6UNCy7QoEOC8BGrvvj/k+H8Qmsbf0GL+cWzf9oYkz10ahT8NktOP900l6LKncR8GFGU5AV0Nl78eXWzxS87bOnu2FaqeRwZuzU+ynlrJGcqWDv28paBQjtsChx1C94Wm0wbnw4UljlN0tBi8F2igehjezJE0WvvmdHFlmigbleVE6e3N+zouXUN0C/eFl+2nfTXQfrTj9It0t8UpN74JdebW70OsuOb4tJcD36u+d9hzZHSRoPd5cNHVD5a5Uvv4DK51WzssTOHP5faWokultNswS+A1XoohwvIKakUzEg0FLVaSTJpsirn5hcPNyXnJ/2NBO5xJ/Rc08ALdDdz76O+EGAJyMHBpFIYRIKYhOik48R86vgaydTHR42JT1actaRl5pJXFSUqX4NbaMEW3LI4GqtHozXoALsAI2fLiVQkuhkiLbWV94rsd3QDOpm2jCuMXqbAaHwJYo+d54BRcbaA7Kt3UtBjDXBCmgFN+6Yp8NwAF8tJpPigE0D2hgHZFEA181gDsJDWUgrZR9JbgPVi7bUQe05+B+jbTroR90Q0uwFXjIozrWZybmtota+5E9dWe7fBPHMMl9QxrTAvFJ3ZorKu7VisBxZnO+PWxd0yyWUh3RaEaxrvzMJXiDim/4gGswtd5QIx8zqRGzBPSjBSiwYvKDERQVtuQFk3WYttPS9fKoH+ILR2DkVQbsEVe8IKrdzCok84q1xlwOPLdFFyhZtbVNaZ5cRCDhmlpBSXmaWUyqRxzDYiblrvzs832Jdh3zXieDuEYZiHBxhFE/6qeI5W5CkTci5rtbMFro0A7C3gWpn5trujfSczwmpXwR4EsB6rkwVM9Gw2KXUusyUl4G631sWdmFisW98+iErRjgJR7xeeZabi+cRs3zOdZjto7me+H8N+NcemOapy9KxqPIwASrAbgDengL5UYAvUXtdd0D73m1sAz5y8QMieho9xAwaGAzA9m8WszibMUJS5XgLY2yx73Xj3tX8ZuzJu4PYSMOU5Hp9OqvIGfbnZWm9D9ZzT8RDj4k9adj+a3b7sC51LgVod//WAo1tBjuh9ekXPvTKp3QhyKVhAgBYoLP5maEq7h4NVp5jJk14HbMDK4LIZQFnVCjZCrc1jLWYPIopnvg2LJBiGXbaVwyB8Wk01N+iGx3b3yb+4h9HhZ/VQNSQPYWUy94jgPeUepaVkD4WlUnWywJhc7lk071ZMQGH+CJ2wcKI5wSBsC7Z+y923aU3Ax3uNf+OxCNqwJOWo+zzeZsNG/A/px/bmuMbMWccN+e185sBQrH8bL2C11+78O6/96kdr6D1qtnGTmqA8JQsb5QKUC7OIqcXb4u+0/yHkHUo3Yo6tm5AGjxwmc6OtxXRHHFwBBQPbfJ3QYnd3ByhGqD2KGBf0IJHXgiuy0JW5jWN4N1P3T6Te2jkK5tzJiz6Dwh73RUv3qG/CmWsLQKyLCgBmRn8DNQk47lXTYdYnDL8SkodDN8wtnDnr0+kNRu92CDwh47kDswHtJFDZHrf/EHBp2RRQudWA41FLDyqlGqUlBzCArVShhZxJUtsRcsxm3idY1xTG9BbbA/Cc7LDcK0oL5iJocbu0Doq6UdThfd+AtICdzLQp+LZov9v+RxRQl1KzqxWj9GTAWfArWVRFH6etTMlxzg8I9eUVVqaAYAEDrsRoOCSu5lp/rcptvHxAYNHhijEAlRz8Yh/vJd2zr+Zc51Mv6V6HD0kvVx7HT/Gv6Wj8BGfYUWjTXGdfwdTGn5JuUs30TsLfo7bWGSaJCI5wJw8oFdNGgEH7ZCoVt0d/+n7sVZzb51MvjgVXlQ8zKS4a19TebTo9mNvnNAOBR6kTx68eclroF5IDHsZjjl8xGu9uc1yFfQtR9DlhXyRy79PsiGHUWDEL/QNy2QG9fpK2spiL2DHFfptJSSxqCcTbRvDGKTSQPGSqHrSWqu96S1Pn7La55ivd75Kqq4mwSITVgzcxRLIJcGOVfxRt57isx784WtDGlELn2WLiFgbsQudiAsH4JK3zuz4CmhbUWHfnVeQLigClbS64zHk4zEOPP78ARrn5Z8//yd5HcCxaxtb5kdaWkhFoJD/6YvQBe60vgL3XWFxn2AtOx5Ftg3kBxu66TWPfOnyJRHpnR5QX485BUfqyah1cOsabeo4KhRNdDl25VM9S+h4IxjBTzhV32mBqj8v8dmk9LvO7pPS4zNuBbh9AjLtjdmzB7aT+ev/ZFH+aWx944OLWozEqDwqAajEwUOCK09F5TB40XaYwQ2JYJ4BMZwoukWh09OQViImQdloZC3SY1Jxbb5hYu/UOu6+VW+gVrHa9ny17bxOJLgbtJjOsK+1w90ULNO06auK58MDTE0Mx4+PxOOVieJweAD9K+fApT49GR0+Pj7Mn09HRyZZJR2oFnXbfxff3B3y+f20/vdY4ZS8knoWzF/7wecCe46H0XtLnSkQRasXvjML3j6rPe9To2pddlI+Ct+2P+B/tRR3WLO62ZE28h3WjVGyoOcaLGz0ZSWZSSbuYhCwnWlcsJPCu1wPkpAODfIzvNO5sx5rBeznBXHsvZkKkb/LCLJXNT0a7r+JrFB4ZLqVw5gmxWJnfl5nMlyj92BhEpE/ZV+nsbnqxG7I2ZIkvjVZzFqLv/hjfZHkHMfcqGRTG2jGL902W/tD1F9ib7zG6VfB4zRZbaAV3roc4x96xGiJu8tGwc1CKFQe5zLZlGtZuHlH5CnDYdPTY2jp4fOcWYFvlvU2yyh/h9AL42ySy18LaXkfwvn09oKnJoNX364K12d5Tjns815et8gaq5dpW3NDE9nfOJuCQsZqvLxDtHMH9DFBPMlgy78Pam21+aHh7c0ijBEc7aincaHaLpcPv1OdOEQjWBINg9Ik9Cn0eNTcJlGYlmEI6F1vZaFWm3MrsgaNzTmV+UX9Hb5OcjN1CWAUgbMsOhTBwjf8R+XYZisM3zI4+78zwj1gWHvXMnI5FTXBZTVOoMawN1Qq6B8zRkyexOUneyzl7BJjDZ1SZnjlmq7LUxjFBzlG+7J/wx1cTwhz8Cei956F7xQ8tyH5A0TvN2lYuJo0NF+x2LxPDvkz1yl5WtBXdbtOzyVQat9h9FLo9i9e3sXsdGgcLSmUT3gEknXO7Y9q6FvQuTnxw3o/GHA6ejo5SwflJegDiKD0+hGE6OgZxKIYAx08Ot6g0Og27Q1Ca55y9ku7bHFNxgip+OSpzDNcYbliS4UXvNMwC+ogUItZHzfUt1ZVA5545NRZH09nTcZZO+XSWHvDROD0en4zTJwdDGIuTjE/Hx1s4dTctdGa55Av2K5hcqppNyJd8SSy6DLdXbseh6FODst6frvMe2+t2NtdqbS1hDd5oW9LbRZdrkdTBpdpaH9ppdudoDXv3IkaGR7AD9hHgK6aalFvQ1bvfga9DHZMmte6951ApDrRN2+uWQb3uFPB3biuma4vdu3etf42OQn3T+v+tx3A9SN627MZNE/qbGJDrQfKmtiA3zfmnKflpSn7AlMTb78F9+1ULiiabVLa/pXXn17O617vWvFiy8eWPBfgK+/rFifZLJWteVrnNLTE6pLOxbjcQ3viMx8Y3cfwTG3qGdf6wrEFtfkpmy+s68XUG3yMuRbyZ2TCsPecu3s89/f9yzVsbG191aD8GEZ+A6DDjCT2psPZtCTrMwbxoTfGwZcSCYPWuPftXRFaejCIyPIrmH+oPZTNdwin7EgjaU1OpL/SOREiS+C0VoG94KU4qMmqkqfsivSKzYY1WMKMk0ssNQYjCGRZrnjqpYfwnpXdB0mfnZ+m/68MnQrEALsiiNjhmPLew+uaKwwSACjfDceFSNNSCPTs/iwdQjFurM0lVSJTMopvd2AAvs9O1boWekGxqbQe+TWv3PrLsUyEV1a+0aO/4qAAvZRp6SjX/70Awbf38GGHgDXU0/Ju43jzkMx6OD70w+XdzZrzKg9jG36+vPw8Sx+coAklvOegS81VqS+BfgdtlShfmg4icqbpVtxGuX6ovwBhJr5r4124Q1ZUDZSmthOLmdffGJw4Hcce1nzpE+Yj9+rDqDn146zt1YTadA1xkSziBoRcVabu4RXKa7F+M9vvPK+5/X7drrnGRsEYsbLDK5Ci9QSR4Kb1EpAIKEos1jwYVusddTy/1B034GWe3gfBamueGDpU20SzxM07eQlYZSoh++h4d1mcZOs/PKuTDp8/tVu9QFr3OXNO2llCEGCUX/z4Fbmgn9x8MIBIp3W1lvHILTGjGwo1B8o6q7X5kBE9hwwDXgwSt8dvGjrfsQFv91xuurfrrH7sP7jQ/r2r/Rl3GEq8YsZAORJWCEhrP8dv7d5CgjrO/zd6BuZAZtOSgUTf07MM+NdwXOGV0JFL6O57H29B15aoy5JkuqEyBcDyy7GXYiixWxqK2EzqrivhG4n+Fx2S4P3YITHkRR2Vv8cGPkFv2R/goyOHr/zRyi6tQausKrlp0Nhm9PvbvjZt1D4YyyJaDK7df5ty/LEab7nvQCp+Si1HroSTTqMbTtfb0M14lsQ47fv+ONumDya+v8ee/KkAX9tNnVEmGql9pCwpJUesGW9ee7y9vg1l8zG6ytxumFi+wq2VLMSbhNv16B8HfjvGGeTe4f3MrvZbBnpHrXZya343deu6Zlb7vGMbV8KHpgbqxdFvbtg3c+Yf3qMVCxFL458gMxzdB8b+0+PFICEMa/O17knM1r3ww5UniP/8Hk3C/nw== +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"; + + + + + + + + + + +Submit a wire in request for a payment + +scope: `payrolls:run` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/recovery-cases.tag.mdx b/docs/api/recovery-cases.tag.mdx new file mode 100644 index 000000000..7ef52d4d7 --- /dev/null +++ b/docs/api/recovery-cases.tag.mdx @@ -0,0 +1,20 @@ +--- +id: recovery-cases +title: "Recovery Cases" +description: "Recovery Cases" +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/redebit-recovery-case.ParamsDetails.json b/docs/api/redebit-recovery-case.ParamsDetails.json new file mode 100644 index 000000000..eedb065bd --- /dev/null +++ b/docs/api/redebit-recovery-case.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"recovery_case_uuid","in":"path","required":true,"schema":{"type":"string"},"description":"The UUID of the recovery case"},{"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/redebit-recovery-case.RequestSchema.json b/docs/api/redebit-recovery-case.RequestSchema.json new file mode 100644 index 000000000..c96bcede2 --- /dev/null +++ b/docs/api/redebit-recovery-case.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} \ No newline at end of file diff --git a/docs/api/redebit-recovery-case.StatusCodes.json b/docs/api/redebit-recovery-case.StatusCodes.json new file mode 100644 index 000000000..e875608a3 --- /dev/null +++ b/docs/api/redebit-recovery-case.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"202":{"description":"Accepted"},"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/redebit-recovery-case.api.mdx b/docs/api/redebit-recovery-case.api.mdx new file mode 100644 index 000000000..53a89da5c --- /dev/null +++ b/docs/api/redebit-recovery-case.api.mdx @@ -0,0 +1,75 @@ +--- +id: redebit-recovery-case +title: "Initiate a redebit for a recovery case" +description: "After resolving the underlying bank error, initiate a redebit for an open recovery case. This submission is asynchronous and a successful request responds with a 202 HTTP status." +sidebar_label: "Initiate a redebit for a recovery case" +hide_title: true +hide_table_of_contents: true +api: eJztXFtv3Diy/is8Og9JgFbb7jiX8b6cbJyc8UNmjMQ52YUTyGyxupsTidSQVNs9hv/7ooqkpFZf7HZsHOwiAwwCt0jWx2LdWCzyOrlKp7V1OpXKwdRwJ7VK3aKC5Og8gXIMQoBIvg0Sx6cWf/sIuZ6DWbC33ILFL7oC3+9EJEeJAQFj6VIT2qU5t5AMEgE2N7LCdslR8mbiwDADVhdzqabMzYDVSoApFvjnmKvvDIzRZsCkkk5yB4yzMDabaMO4YroCxSIdhnSG7GwmLbP1uJTWSq2YtIzbhcpnRitdW8aVYJzZOs/B2kldMAN/1mAdYqm0EpZdSjdjnI32R+zXs7NTZh13tR1+VV/ViWMlXzDHvwOrK+Y0m+jasHFtpQJrmeALS+BwOm/e/so8XKdZZTQS/BuTij6WwJWTJQzoL0+C6Qn9tTQjdimLgo0hdryI7BBZ4MYFdYch+zIDxSY1zoEb6MyxWETOgRisISEtc4YrK3FxQCBeIhVagYgkiAceZK7LiqsFm3HL4CoHECBYya9kWZfNOnHnoKycHTBtmFw3O2mZ0g4n16wuHxeeIxCx4sJ0OHE4GrHPKnCUWr9TTroFwbO5ruCowb7IkIw9ujTSwUUySCpueAkODArzdaJ4CSS0ndZZXUuRDBKJglpxN0sGCUqJNCCSI2dqGCQ2n0HJk6PrxOtKYp2Raprc9AX9bAbs8+eT47WLm9wMGgj/SP+X9PDN6Un6f2BQeCOGGXABZgnFhBcW+rSOcV4liiKREtxBOuYWBHtzesLmflDGrdU5SZAX9QWKMDbIeVEM2cmEKa1oZSqj51KgzFAbXlWFzEnTn1h2XkpFi90Z+9vTmXOVPdrbEzq3QzIsw1yXe9GQpBVfGF0U9H2PVzINPaWa/ncYMO38/Axh1BbEMNnM80ECqi7RNo32Ry/S/ZfpwQu0SwImvC5cctT9/ebmG/LRi5TFwUb7I/ynZ5/yHCoHAhf0cP9wtcFv2rH3ulaCfVWMfVVntLZkSkCQYatNDkxo8BIOV9K6IfuApsPWBmiFIoO9hEjL5ryQYvhVEdnRGlzr5L5BIC2Zpxmv0DBeojlAKmMtFih+tIjR3OVaOS6V9VYWTWY+Y9yifSEQGXfOyHHtIJvzooYL0mHXzpJNuCwsEzWgveCq7dn4g4sh+wR+pufvPJm33MFUGwl2R1khmGnedH/GprUUQNa21AaYAIeAkHmDBGcHyiH/OlK794dFJl53JOl27v5kbp+5Qfv0+A/I3ZJVOk/8hFH7KoNQnfRKFn5vdZcbwxdo4ByU3d83j5p9B+wQUC420KBWa0zE8kJ/qiCXEwkWFzIoI3VnOs9rY4fsbFFJNIgL5nDpv8OCSQHK+V7YvlnDvcanMAMFGdbgQWnIISpzg3oHaDgCtkXx8iMxtDJxqGg9gpSxqdF1JdXUxzg5V+gr0XYimnEtC8FylIMytJ9xJQoMtqTy0tuJAMkNNISkZReKDFvm1/HCe2a/Vt4vB5FnnPmW7CI0ZWGRFt7bgDdZ/iOxpkR9m8LtnDmN8w3SyPhY166zdimbggLTrloYOjLD1mbCc88QrhgogfwxAYXjgju+ThSXYbyNym2ggDlXDh0txzGDgCxi2OJdgFSMdBp9L5mNYJHGBQzZe20YXPGyKjDa6QxB+IhVF/7fDFFd0NrGXzBOuWjCouhM0FVqBb9PKMDZPpeyLpysCvC0UI96ihd/XlW2+GUHlV6mbaWaRsrYjQtBASgvTjuUfLi1hrZnyO1S8xsvIQZfgaNuxrtik2vTBP9OkzR0GHw7hc9K/llDax5MswXww9CI3npPjC7bAc/bEVVdFMm3pl1dZU5vb7hk59Y1oBB6W5ObQeKkK3BmH4L0p1+km6W/K0i980tuNrf6EGTHN8WlwWj255r/+685jrTRYS/z4QsaH62KhQ9wcZO3xW0M2YmjjYW2VmKI5TSb8Tmwxg4VMIeCdsLBjURH0ZiVJJcmrwtunnq4KQU/6e8kcM+S7gzXNPACfZUGm0sTxGRDxvNc18plAgpwkNUKN9IgsoovSlBuKYg5X4o1krFPcLQuPlkJ1pKOm0ve10pINf0AbqYFbaAjNdZQozVYAjYHIyeLTCoS3RyRVtrKB0X2T8pmYO4lUEXPibuXMTCiL0EM2WkBuHXPZ5B/90EKRqwBDuMldkTXvmkKvDDAxSKLIz7qBJC9gSAbA6h2HmsAUtJITTOja4dqsxlYaJGpuhzT1nwNxF6QvwT0o+/PfH/Uieh2A64gCVmu1URObQOtiTV34tpq7y6YN47hkjqG+/42mC1r67qBxXpgcbYTbl3UlqyQpXRbEK5pvDML3yPiMAajMZid6boQiJkHzjaYswqM1KLFC0pkIljLDSibJmuxreflOyUo8dLRHNpBuRlX7DkrtXIzizHhpHa1AY8vJNMyqURtnVlkFgrIUbozxWVus1wLyNrAbCPitvXu/PwN+zLsu0Yc74YwkHl8gFE04c+aF+hFXjIhp7IxO1vg2gjA3gGulblvuzvaTzInrHYV7GEA67FiGjjTk0lW6ULmiwzzgXdb6/JeTCzXrW8fRK1Io0A0+sLz3NS8yMx2nVlqtoPlfuP7MezXcGxcoCnHyKrBwwigBLsBeAXkXLOQSNnmHXtdd0H71iu3AJ47OUfIfgy/xw0YGBJgejKJWZ1NmKGsCr0AsHdZ9qbx7mv/Lnal84E7S8CYF1zlkNXVLfZys7fehuotV5Qh5eIPWnZPzW5f9pkupECrjv97wDGsoED0IaOit+GoI4YRFFKwgAA9UFj8zdCUdo8Hq0kxUyS9DtiAVSFkM4CyqhVshNq4x0bMHkUUT3wbFodguO2ynRwG4dNqrLnBMDy2e0j+RR3GgJ81pBpIHsLKZB4QwRnlHvGEUoVtaTjki1lgTC73PJoPKzJQmD/CIMwZnjttMtyEbcHWb7m7mjYD+P1eG994LIIUlqQcbZ/H2ypsxP+YcWxvjmvcnHXcUNzO8fyZ9vp3iQJWe+3Ov9Mmrn6yZrwnrRq3qQnKU7KgKHNQLswiphbvin+p/Q8hXxrpVsyxdbulwSOHbGq0tZjuiMQV0GZgW6wTWuwe7gDtEZqIIu4LepAoasEVmena3CUwvJ+r+xVH72iOgil3ct5nUNDxHP1g8YD25tSP3wHgSTTqMTH6L1BZwPGglg6zPoH8ypY8HLphbuHEWZ9ObzH6sEPgCRkvHJgNaLMwyvZ9+w8Bl5aNAY1bAzgetfSgUqoRqypkGde2VqUWciLJbEfIMZv5kGDjiVG1stgegOfkEsu9obRg5sGK24V1UDaNog3vxwZkBWw20abk23b7y+1/xAAtj9RqtWKUngw4QxlKH6etTcVxzo8I9V2/FEZP2MH+PnG10Pp7XW3j5SMCiwFX3ANQycFT+2yYLJ99tec6572ke7N9SHq58kg/xT/Tg9FznOGSQRsXOv8OpnH+lHSTaqJ3Ev7eaGuDYZKIEAgv5QGlYtoIMOifTK2ievSn72mv4tw+n2ZxLLi6epxJcdGGpvZ+0+nB3D6nCQg8Ss0cv3rMaWFcSAF4oMccv2JE735zXIV9B1H0OWFfJPLg01wSw2ixYhb6B+RyCfT6SdraYi5ixxT7XSZFRZZh8K4TvHUKLSQPuS3VXFmaJme3LTRf6X6fVF1bLhoHYQ3xdg+RbALceuUfRbt0XNbjX6QWrDGl0Hk+y9zMgJ3pQmSxDjPpnN/1EdC0oMG6O68iX2LpJp9zWfBwmOcLeoFRbh4LYM8iOBY9Y+f8SGtLyQh0kl+kAXaiBuyDngM701hcZ9gxp+PIrsMMlYH3Cpua7cu8KbBcOjuivFgoWqUEng4hHVWnhnoOLPadUvlx7VI9Sel7GDBuM+VUcacNpva4LO6W1uOyuE9Kj8uiu9HtA4j77pgdm3GbNV8fPpviT3ObAw9c3Iaar/INgBoxMFDiitPReUwetF3GMMHBsE4Amc4UXOKgMdCTVyAyIe24NhboMKk9t94wsW7rHbSvk1uI51Zro58turdpiGUM2mUTrCtd4u5xBzRpHTXxXHjk6Yl9MeGj0SjlYv91egj8Vcr3X/L01cGrl69f58/HB69+2TLpOFpJp933if39AZ/v3/hPbzWO2LHEs3B27A+fB+wtHkoPkz5XIgpfaH9/FKFQP5g+H1FjaF8to3wSom1/xP9kGG1Yu7jbkjWU+7uLVGyoOb7kti8jyUQqaWdZyHKid8VCAh96PUJOOjDI7/GdRs12rCXeywkW2kcxGQ19WxRmnQFw2cHuq/gBhUeqvKgFWnQ/ENoWA9auyEzuS5R+jAYN0h/ZV+ns7nqxG7I2ZIkvjVZTFnbffRp/yeoeYu5NMijca8cs3l+y8oeuT2E4HbKD0fPDF8/WqNhMK7h3PcQp9o7VEFHJD/aXDkqx4qCQ+bZMw1rlEbWvAIdNR48d1cHjOzcD2ynvbZNV/gint4G/SyJ7LaztdQRn3esBbU0Grb5fF6zN9pFy1PFCX3bKG6iWa1txQ7u3v3c2AUnGar6+QHRzBA9DoJlk8GQ+hrW3+/zQ8O7ukKiEQDtaKVQ0u8XT4Xfqc68dCNYEg2D0iT0JfZ60NwmUZhVe7nEutrLRq4y5lfkj7845lflF+x2jTQoydtvCKgBhO34obAPXxB+Rb5ehOHzD7Ojzzgz/gmXh0c5M6VjUhJDVtIUa+42jWkH3iDl6iiQ2J8l7OWePAHP4jCrTc8dsXVXaOCYoOCoW/RP+YI7iHPwJ6IPnoXvFDx3InqDonWZtKxeTxrrsfgUv77EvU72ylxVrJcg/TLKxNHThb0cqx3SuPmHUvdkaBw9KZRM+ACSbc7dj2qYW9D5BfAjeX404HL48eJUKzn9JD0G8Sl+/gP304DWIF2If4PXzF1tMGp2G3WNTWhScvZfurymm4gRV/HI05rhdY6iwJMOz3mmYBYwRaYvYHDUHJqzZ6Dwwp0bi1XjycpSnYz6epIf8YJS+Hv0ySp8f7sNI/JLz8ej1Fk7dzwqdWC75jP0dTCFVwybkS7EgFl2G2yt341CMqUFZH083eY/tdTuba7W2lrCGaLQr6d2iy7VIms2l2lofutTs3rs17N3bMTI8gh2wLwDfMdWk3Iyu3v0T+DrUMWnS2N4H3ipFQtusve441JulAv6l24rp2mL3QdItdP97DBQ8y/6dI4abQfKx4zdum9B/iAO5GSS/NR7ktjn/dCU/XckPuBL/H96VsRXw78DtIqUrpp3nEvwTIMttUFFS/GqkgPY9EDw0vnKgLG3EcM5+thufHxlEAe8+Q4IrF/v1YTUdevDW91mG2e3r4eIzASFneZRUtaOnI9wsOUr25gd7y69L7F2vvh9xs9dOnCorwkrXpkBtCLezeSX95exUQEk3tFduWB1DqXss9uOlPj2Ln3GKGwZeO+apoVTspjEr/IwMsJDXhtII59fRzL+hV0Xe1MiL82/dVp/wVr33NGvaNhfJEGJ8zQH/HgM35FH612xpiJRuhDFeuxmmAeJx5yD5RDUqP0LBj7CBAGV4fIFC9Lf0Pgc+d4HiEk+hum9LDBJ8f8P+PvkEZi5z6KxHewOfLi3vUcM9gaQxPEjpbzxNsqHrykU7KHJd0iEb4Xhi2bugFizWdeFLHELnNSoxTeO/wlMI3CfNwksjx5Eq+4jX1UNmxB9AoUCFr//Tyg9yo9LWlVx1xjnZ8DBP742T3kyu28cZfr4C9PMVoP+fV4CCoXBw5faqgkuyKGRBr4OZP0/mB3QZvjtAMkiO1j4VFG39N6yptw67X19jFP3ZFDc3+POfNaAvP/+GrsZQGSBZVSEJ/IYnfbrK8vRjCD2fse2PCm2YXrzHqxYdd5eES8XrXkDyVwT820O7Qf0Pf4hoLXs9G9e/4tRwu41F/ANDnW8r79QsRSCnn8+Sm5t/AQ3GESc= +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"; + + + + + + + + + + +After resolving the underlying bank error, initiate a redebit for an open recovery case. This submission is asynchronous and a successful request responds with a 202 HTTP status. + +It may take up to four business days for the ACH debit to process; in the meantime, the status of the recovery case will be in the `initiated_redebit` state. When funds are successfully redebited, the recovery case is transitioned to the `recovered` state. + +If the company has exceeded maximum redebit attempts, or if the recovery case is not in a redebitable state, the response will be 422 Unprocessable Entity. + +scope: `recovery_cases:write` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/reimbursements.tag.mdx b/docs/api/reimbursements.tag.mdx new file mode 100644 index 000000000..a644bc7b1 --- /dev/null +++ b/docs/api/reimbursements.tag.mdx @@ -0,0 +1,20 @@ +--- +id: reimbursements +title: "Reimbursements" +description: "Reimbursements" +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/reports.tag.mdx b/docs/api/reports.tag.mdx new file mode 100644 index 000000000..0e2ef69db --- /dev/null +++ b/docs/api/reports.tag.mdx @@ -0,0 +1,20 @@ +--- +id: reports +title: "Reports" +description: "Reports" +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/salary-estimates.tag.mdx b/docs/api/salary-estimates.tag.mdx new file mode 100644 index 000000000..ae71c42f4 --- /dev/null +++ b/docs/api/salary-estimates.tag.mdx @@ -0,0 +1,20 @@ +--- +id: salary-estimates +title: "Salary Estimates" +description: "Salary Estimates" +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/schemas/admin.Schema.json b/docs/api/schemas/admin.Schema.json new file mode 100644 index 000000000..1d76a52be --- /dev/null +++ b/docs/api/schemas/admin.Schema.json @@ -0,0 +1 @@ +{"schema":{"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"]},"schemaType":"response"} \ No newline at end of file diff --git a/docs/api/schemas/admin.schema.mdx b/docs/api/schemas/admin.schema.mdx new file mode 100644 index 000000000..7da8ee5f7 --- /dev/null +++ b/docs/api/schemas/admin.schema.mdx @@ -0,0 +1,32 @@ +--- +id: admin +title: "Admin" +description: "The representation of an admin user in Gusto." +sidebar_label: "Admin" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"uuid":"string","email":"string","first_name":"string","last_name":"string","phone":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + +The representation of an admin user in Gusto. + + + + + \ No newline at end of file diff --git a/docs/api/schemas/benefit-summary.Schema.json b/docs/api/schemas/benefit-summary.Schema.json new file mode 100644 index 000000000..319296430 --- /dev/null +++ b/docs/api/schemas/benefit-summary.Schema.json @@ -0,0 +1 @@ +{"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"},"schemaType":"response"} \ No newline at end of file diff --git a/docs/api/schemas/benefit-summary.schema.mdx b/docs/api/schemas/benefit-summary.schema.mdx new file mode 100644 index 000000000..b6dd98844 --- /dev/null +++ b/docs/api/schemas/benefit-summary.schema.mdx @@ -0,0 +1,32 @@ +--- +id: benefit-summary +title: "Benefit-Summary" +description: "" +sidebar_label: "Benefit-Summary" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"start_date":"string","end_date":"string","description":"string","company_benefit_deduction":"string","company_benefit_contribution":"string","employees":{"uuid":"string","company_benefit_deduction":"string","company_benefit_contribution":"string","benefit_deduction":"string","benefit_contribution":"string","gross_pay":"string","imputed_pay":"string","payroll_benefits":{"payroll_uuid":"string","payroll_type":"string","check_date":"string","gross_pay":"string","imputed_pay":"string","company_benefit_deduction":"string","company_benefit_contribution":"string","pay_period":{"start_date":"string","end_date":"string"}}}} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/schemas/benefit-type-requirements.Schema.json b/docs/api/schemas/benefit-type-requirements.Schema.json new file mode 100644 index 000000000..a76a2de7e --- /dev/null +++ b/docs/api/schemas/benefit-type-requirements.Schema.json @@ -0,0 +1 @@ +{"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"},"schemaType":"response"} \ No newline at end of file diff --git a/docs/api/schemas/benefit-type-requirements.schema.mdx b/docs/api/schemas/benefit-type-requirements.schema.mdx new file mode 100644 index 000000000..b3a9b160e --- /dev/null +++ b/docs/api/schemas/benefit-type-requirements.schema.mdx @@ -0,0 +1,32 @@ +--- +id: benefit-type-requirements +title: "Benefit-Type-Requirements" +description: "" +sidebar_label: "Benefit-Type-Requirements" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"employee_deduction":{"required":true,"editable":true,"default_value":{"value":"string","type":"string"},"choices":"Unknown Type: array,null"},"contribution":{"required":true,"editable":true,"default_value":{"value":"string","type":"string"},"choices":["string"]},"deduct_as_percentage":{"required":true,"editable":true,"default_value":{"value":"string","type":"string"},"choices":["string"]},"catch_up":{"required":true,"editable":true,"default_value":{"value":"string","type":"string"},"choices":["string"]},"limit_option":{"required":true,"editable":true,"default_value":{"value":"string","type":"string"},"choices":["string"]},"company_contribution_annual_maximum":{"required":true,"editable":true,"default_value":{"value":"string","type":"string"},"choices":["string"]},"coverage_salary_multiplier":{"required":true,"editable":true,"default_value":{"value":"string","type":"string"},"choices":["string"]},"coverage_amount":{"required":true,"editable":true,"default_value":{"value":"string","type":"string"},"choices":["string"]}} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/schemas/company-attachment.Schema.json b/docs/api/schemas/company-attachment.Schema.json new file mode 100644 index 000000000..9ed7f4b61 --- /dev/null +++ b/docs/api/schemas/company-attachment.Schema.json @@ -0,0 +1 @@ +{"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"},"schemaType":"response"} \ No newline at end of file diff --git a/docs/api/schemas/company-attachment.schema.mdx b/docs/api/schemas/company-attachment.schema.mdx new file mode 100644 index 000000000..60b05ace1 --- /dev/null +++ b/docs/api/schemas/company-attachment.schema.mdx @@ -0,0 +1,32 @@ +--- +id: company-attachment +title: "Company-Attachment" +description: "The company attachment" +sidebar_label: "Company-Attachment" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"uuid":"string","name":"string","category":"gep_notice","upload_time":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + +The company attachment + + + + + \ No newline at end of file diff --git a/docs/api/schemas/company-bank-account.Schema.json b/docs/api/schemas/company-bank-account.Schema.json new file mode 100644 index 000000000..8384d4239 --- /dev/null +++ b/docs/api/schemas/company-bank-account.Schema.json @@ -0,0 +1 @@ +{"schema":{"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"},"schemaType":"response"} \ No newline at end of file diff --git a/docs/api/schemas/company-bank-account.schema.mdx b/docs/api/schemas/company-bank-account.schema.mdx new file mode 100644 index 000000000..44e60964c --- /dev/null +++ b/docs/api/schemas/company-bank-account.schema.mdx @@ -0,0 +1,32 @@ +--- +id: company-bank-account +title: "Company-Bank-Account" +description: "The company bank account" +sidebar_label: "Company-Bank-Account" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"uuid":"string","company_uuid":"string","account_type":"Checking","routing_number":"string","hidden_account_number":"string","verification_status":"awaiting_deposits","verification_type":"bank_deposits","plaid_status":"connected","last_cached_balance":"string","balance_fetched_date":"string","name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + +The company bank account + + + + + \ No newline at end of file diff --git a/docs/api/schemas/company-custom-field.Schema.json b/docs/api/schemas/company-custom-field.Schema.json new file mode 100644 index 000000000..8467c9eef --- /dev/null +++ b/docs/api/schemas/company-custom-field.Schema.json @@ -0,0 +1 @@ +{"schema":{"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"},"schemaType":"response"} \ No newline at end of file diff --git a/docs/api/schemas/company-custom-field.schema.mdx b/docs/api/schemas/company-custom-field.schema.mdx new file mode 100644 index 000000000..cc398bb83 --- /dev/null +++ b/docs/api/schemas/company-custom-field.schema.mdx @@ -0,0 +1,32 @@ +--- +id: company-custom-field +title: "Company-Custom-Field" +description: "A custom field on a company" +sidebar_label: "Company-Custom-Field" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"uuid":"string","name":"string","type":"text","description":"string","selection_options":"Unknown Type: array,null"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + +A custom field on a company + + + + + \ No newline at end of file diff --git a/docs/api/schemas/company-onboarding-status.Schema.json b/docs/api/schemas/company-onboarding-status.Schema.json new file mode 100644 index 000000000..ce7e26c6c --- /dev/null +++ b/docs/api/schemas/company-onboarding-status.Schema.json @@ -0,0 +1 @@ +{"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"]},"schemaType":"response"} \ No newline at end of file diff --git a/docs/api/schemas/company-onboarding-status.schema.mdx b/docs/api/schemas/company-onboarding-status.schema.mdx new file mode 100644 index 000000000..dd6d987d8 --- /dev/null +++ b/docs/api/schemas/company-onboarding-status.schema.mdx @@ -0,0 +1,32 @@ +--- +id: company-onboarding-status +title: "Company-Onboarding-Status" +description: "The representation of a company's onboarding status" +sidebar_label: "Company-Onboarding-Status" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"uuid":"string","onboarding_completed":true,"onboarding_steps":[{"title":"string","id":"add_addresses","required":true,"completed":true,"completed_at":"string","skippable":true,"requirements":["add_addresses"]}]} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + +The representation of a company's onboarding status + + + + + \ No newline at end of file diff --git a/docs/api/schemas/company.Schema.json b/docs/api/schemas/company.Schema.json new file mode 100644 index 000000000..a798a048d --- /dev/null +++ b/docs/api/schemas/company.Schema.json @@ -0,0 +1 @@ +{"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"]},"schemaType":"response"} \ No newline at end of file diff --git a/docs/api/schemas/company.schema.mdx b/docs/api/schemas/company.schema.mdx new file mode 100644 index 000000000..22309ebfc --- /dev/null +++ b/docs/api/schemas/company.schema.mdx @@ -0,0 +1,32 @@ +--- +id: company +title: "Company" +description: "The representation of a company in Gusto." +sidebar_label: "Company" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"ein":"string","entity_type":"C-Corporation","contractor_only":true,"tier":"simple","is_suspended":true,"company_status":"Approved","is_high_risk_business":true,"is_marijuana_business":true,"uuid":"string","name":"string","slug":"string","trade_name":"string","is_partner_managed":true,"pay_schedule_type":"single","join_date":"string","funding_type":"ach","locations":[{"street_1":"string","street_2":"string","city":"string","state":"string","zip":"string","country":"USA","inactive":true,"active":true}],"compensations":{"hourly":[{"name":"Overtime","multiple":1.5}],"fixed":[{"name":"Bonus"}],"paid_time_off":[{"name":"Vacation Hours"}]},"primary_signatory":"Unknown Type: object,null","primary_payroll_admin":{"first_name":"string","last_name":"string","phone":"string","email":"string"}} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + +The representation of a company in Gusto. + + + + + \ No newline at end of file diff --git a/docs/api/schemas/contractor-bank-account.Schema.json b/docs/api/schemas/contractor-bank-account.Schema.json new file mode 100644 index 000000000..14e615b97 --- /dev/null +++ b/docs/api/schemas/contractor-bank-account.Schema.json @@ -0,0 +1 @@ +{"schema":{"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"]},"schemaType":"response"} \ No newline at end of file diff --git a/docs/api/schemas/contractor-bank-account.schema.mdx b/docs/api/schemas/contractor-bank-account.schema.mdx new file mode 100644 index 000000000..eb10c7867 --- /dev/null +++ b/docs/api/schemas/contractor-bank-account.schema.mdx @@ -0,0 +1,32 @@ +--- +id: contractor-bank-account +title: "Contractor-Bank-Account" +description: "" +sidebar_label: "Contractor-Bank-Account" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"uuid":"string","contractor_uuid":"string","account_type":"Checking","name":"string","routing_number":"string","hidden_account_number":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/schemas/contractor-onboarding-status.Schema.json b/docs/api/schemas/contractor-onboarding-status.Schema.json new file mode 100644 index 000000000..585a08261 --- /dev/null +++ b/docs/api/schemas/contractor-onboarding-status.Schema.json @@ -0,0 +1 @@ +{"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"]},"schemaType":"response"} \ No newline at end of file diff --git a/docs/api/schemas/contractor-onboarding-status.schema.mdx b/docs/api/schemas/contractor-onboarding-status.schema.mdx new file mode 100644 index 000000000..f7339af77 --- /dev/null +++ b/docs/api/schemas/contractor-onboarding-status.schema.mdx @@ -0,0 +1,32 @@ +--- +id: contractor-onboarding-status +title: "Contractor-Onboarding-Status" +description: "The representation of an contractor's onboarding status." +sidebar_label: "Contractor-Onboarding-Status" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"uuid":"string","onboarding_status":"onboarding_completed","onboarding_steps":[{"title":"string","id":"string","required":true,"completed":true,"requirements":["string"]}]} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + +The representation of an contractor's onboarding status. + + + + + \ No newline at end of file diff --git a/docs/api/schemas/contractor-payment-body.Schema.json b/docs/api/schemas/contractor-payment-body.Schema.json new file mode 100644 index 000000000..1cf853d5b --- /dev/null +++ b/docs/api/schemas/contractor-payment-body.Schema.json @@ -0,0 +1 @@ +{"schema":{"description":"Request body for creating a contractor payment.","type":"object","required":["contractor_uuid","date"],"properties":{"contractor_uuid":{"type":"string","description":"The contractor receiving the payment."},"date":{"type":"string","format":"date","description":"Date of contractor payment.","example":"2020-01-01"},"payment_method":{"type":"string","enum":["Direct Deposit","Check","Historical Payment"],"default":"Direct Deposit"},"wage":{"type":"string","format":"float","description":"If the contractor is on a fixed wage, this is the fixed wage payment for the contractor, regardless of hours worked.","example":"5000"},"hours":{"type":"string","format":"float","description":"If the contractor is on an hourly wage, this is the number of hours that the contractor worked for the payment.","example":"40"},"bonus":{"type":"string","format":"float","description":"If the contractor is on an hourly wage, this is the bonus the contractor earned.","example":"500"},"reimbursement":{"type":"string","format":"float","description":"Reimbursed wages for the contractor.","example":"20"}},"x-tags":["Contractor Payments"],"title":"Contractor-Payment-Body"},"schemaType":"response"} \ No newline at end of file diff --git a/docs/api/schemas/contractor-payment-body.schema.mdx b/docs/api/schemas/contractor-payment-body.schema.mdx new file mode 100644 index 000000000..ae85f7881 --- /dev/null +++ b/docs/api/schemas/contractor-payment-body.schema.mdx @@ -0,0 +1,32 @@ +--- +id: contractor-payment-body +title: "Contractor-Payment-Body" +description: "Request body for creating a contractor payment." +sidebar_label: "Contractor-Payment-Body" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"contractor_uuid":"string","date":"2020-01-01","payment_method":"Direct Deposit","wage":"5000","hours":"40","bonus":"500","reimbursement":"20"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + +Request body for creating a contractor payment. + + + + + \ No newline at end of file diff --git a/docs/api/schemas/contractor-payment-for-group-preview.Schema.json b/docs/api/schemas/contractor-payment-for-group-preview.Schema.json new file mode 100644 index 000000000..e614e0f39 --- /dev/null +++ b/docs/api/schemas/contractor-payment-for-group-preview.Schema.json @@ -0,0 +1 @@ +{"schema":{"description":"Preview representation of a single contractor payment with nullable uuid.","type":"object","properties":{"uuid":{"type":["string","null"],"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-Preview"},"schemaType":"response"} \ No newline at end of file diff --git a/docs/api/schemas/contractor-payment-for-group-preview.schema.mdx b/docs/api/schemas/contractor-payment-for-group-preview.schema.mdx new file mode 100644 index 000000000..2cb51dd95 --- /dev/null +++ b/docs/api/schemas/contractor-payment-for-group-preview.schema.mdx @@ -0,0 +1,32 @@ +--- +id: contractor-payment-for-group-preview +title: "Contractor-Payment-For-Group-Preview" +description: "Preview representation of a single contractor payment with nullable uuid." +sidebar_label: "Contractor-Payment-For-Group-Preview" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"uuid":"string","contractor_uuid":"string","bonus":"string","hours":"string","payment_method":"Direct Deposit","reimbursement":"string","status":"Funded","hourly_rate":"string","may_cancel":true,"wage":"string","wage_type":"Hourly","wage_total":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + +Preview representation of a single contractor payment with nullable uuid. + + + + + \ No newline at end of file diff --git a/docs/api/schemas/contractor-payment-for-group.Schema.json b/docs/api/schemas/contractor-payment-for-group.Schema.json new file mode 100644 index 000000000..091017308 --- /dev/null +++ b/docs/api/schemas/contractor-payment-for-group.Schema.json @@ -0,0 +1 @@ +{"schema":{"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"},"schemaType":"response"} \ No newline at end of file diff --git a/docs/api/schemas/contractor-payment-for-group.schema.mdx b/docs/api/schemas/contractor-payment-for-group.schema.mdx new file mode 100644 index 000000000..a0db001f0 --- /dev/null +++ b/docs/api/schemas/contractor-payment-for-group.schema.mdx @@ -0,0 +1,32 @@ +--- +id: contractor-payment-for-group +title: "Contractor-Payment-For-Group" +description: "The representation of a single contractor payment." +sidebar_label: "Contractor-Payment-For-Group" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"uuid":"string","contractor_uuid":"string","bonus":"string","hours":"string","payment_method":"Direct Deposit","reimbursement":"string","status":"Funded","hourly_rate":"string","may_cancel":true,"wage":"string","wage_type":"Hourly","wage_total":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + +The representation of a single contractor payment. + + + + + \ No newline at end of file diff --git a/docs/api/schemas/contractor-payment-group-minimal.Schema.json b/docs/api/schemas/contractor-payment-group-minimal.Schema.json new file mode 100644 index 000000000..cc65499df --- /dev/null +++ b/docs/api/schemas/contractor-payment-group-minimal.Schema.json @@ -0,0 +1 @@ +{"schema":{"description":"The summary of a contractor payment group.","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":{"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}},"readOnly":true}}}],"x-examples":{"success":[{"uuid":"7f2337f9-9b78-44b9-aeed-be4777b833a8","company_uuid":"c54046f7-1be4-4c54-8194-f4842c30c86d","check_date":"2024-03-15","debit_date":"2024-03-11","status":"Funded","creation_token":"a51a3500-3200-43af-a738-169d4b66a9db","totals":{"debit_amount":"740.00","wage_amount":"720.00","reimbursement_amount":"20.00"}},{"uuid":"56260b3d-c375-415c-b77a-75d99f717193","company_uuid":"c54046f7-1be4-4c54-8194-f4842c30c86d","check_date":"2024-05-02","debit_date":"2024-04-26","status":"Unfunded","creation_token":"45ef81bb-ae24-4ad1-b2c6-6e563a4c30ed","totals":{"debit_amount":"2365.00","wage_amount":"2270.00","reimbursement_amount":"95.00"}}]},"x-tags":["Contractor Payment Groups"],"title":"Contractor-Payment-Group-Minimal"},"schemaType":"response"} \ No newline at end of file diff --git a/docs/api/schemas/contractor-payment-group-minimal.schema.mdx b/docs/api/schemas/contractor-payment-group-minimal.schema.mdx new file mode 100644 index 000000000..341b82418 --- /dev/null +++ b/docs/api/schemas/contractor-payment-group-minimal.schema.mdx @@ -0,0 +1,32 @@ +--- +id: contractor-payment-group-minimal +title: "Contractor-Payment-Group-Minimal" +description: "The summary of a contractor payment group." +sidebar_label: "Contractor-Payment-Group-Minimal" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"uuid":"string","company_uuid":"string","check_date":"string","debit_date":"string","status":"Unfunded","creation_token":"string","totals":{"amount":"string","debit_amount":"string","wage_amount":"string","reimbursement_amount":"string"}} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + +The summary of a contractor payment group. + + + + + \ No newline at end of file diff --git a/docs/api/schemas/contractor-payment-group-with-blockers.Schema.json b/docs/api/schemas/contractor-payment-group-with-blockers.Schema.json new file mode 100644 index 000000000..7c9137eea --- /dev/null +++ b/docs/api/schemas/contractor-payment-group-with-blockers.Schema.json @@ -0,0 +1 @@ +{"schema":{"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"},"schemaType":"response"} \ No newline at end of file diff --git a/docs/api/schemas/contractor-payment-group-with-blockers.schema.mdx b/docs/api/schemas/contractor-payment-group-with-blockers.schema.mdx new file mode 100644 index 000000000..64de6bccf --- /dev/null +++ b/docs/api/schemas/contractor-payment-group-with-blockers.schema.mdx @@ -0,0 +1,32 @@ +--- +id: contractor-payment-group-with-blockers +title: "Contractor-Payment-Group-With-Blockers" +description: "Contractor payment group with submission and credit blockers, but without individual contractor payments." +sidebar_label: "Contractor-Payment-Group-With-Blockers" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"uuid":"string","company_uuid":"string","check_date":"string","debit_date":"string","status":"Unfunded","creation_token":"string","partner_owned_disbursement":true,"submission_blockers":[{"blocker_type":"string","blocker_name":"string","unblock_options":[{"unblock_type":"string","check_date":"string","metadata":{}}],"selected_option":"string","status":"unresolved"}],"credit_blockers":[{"blocker_type":"string","blocker_name":"string","unblock_options":[{"unblock_type":"submit_wire","check_date":"string","metadata":{"wire_in_amount":"string","wire_in_deadline":"2024-07-29T15:51:28.071Z","wire_in_request_uuid":"string"}},{"unblock_type":"submit_bank_screenshot","check_date":"string","metadata":{"information_request_uuid":"string","bank_account_last_four_digits":"string"}},{"unblock_type":"respond_to_high_risk_fraud_rfi","check_date":"string","metadata":{"information_request_uuid":"string"}},{"unblock_type":"wait_for_reverse_wire","check_date":"string","metadata":{"reverse_wire_detail_id":0,"bank_account_last_four_digits":"string"}}],"selected_option":"string","status":"unresolved"}],"totals":{"amount":"string","debit_amount":"string","wage_amount":"string","reimbursement_amount":"string","check_amount":"string"}} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + +Contractor payment group with submission and credit blockers, but without individual contractor payments. + + + + + \ No newline at end of file diff --git a/docs/api/schemas/contractor-payment-group.Schema.json b/docs/api/schemas/contractor-payment-group.Schema.json new file mode 100644 index 000000000..caa5954a0 --- /dev/null +++ b/docs/api/schemas/contractor-payment-group.Schema.json @@ -0,0 +1 @@ +{"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"},"schemaType":"response"} \ No newline at end of file diff --git a/docs/api/schemas/contractor-payment-group.schema.mdx b/docs/api/schemas/contractor-payment-group.schema.mdx new file mode 100644 index 000000000..cc38e93f4 --- /dev/null +++ b/docs/api/schemas/contractor-payment-group.schema.mdx @@ -0,0 +1,32 @@ +--- +id: contractor-payment-group +title: "Contractor-Payment-Group" +description: "The full contractor payment group, including associated contractor payments." +sidebar_label: "Contractor-Payment-Group" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"uuid":"string","company_uuid":"string","check_date":"string","debit_date":"string","status":"Unfunded","creation_token":"string","partner_owned_disbursement":true,"submission_blockers":[{"blocker_type":"string","blocker_name":"string","unblock_options":[{"unblock_type":"string","check_date":"string","metadata":{}}],"selected_option":"string","status":"unresolved"}],"credit_blockers":[{"blocker_type":"string","blocker_name":"string","unblock_options":[{"unblock_type":"submit_wire","check_date":"string","metadata":{"wire_in_amount":"string","wire_in_deadline":"2024-07-29T15:51:28.071Z","wire_in_request_uuid":"string"}},{"unblock_type":"submit_bank_screenshot","check_date":"string","metadata":{"information_request_uuid":"string","bank_account_last_four_digits":"string"}},{"unblock_type":"respond_to_high_risk_fraud_rfi","check_date":"string","metadata":{"information_request_uuid":"string"}},{"unblock_type":"wait_for_reverse_wire","check_date":"string","metadata":{"reverse_wire_detail_id":0,"bank_account_last_four_digits":"string"}}],"selected_option":"string","status":"unresolved"}],"totals":{"amount":"string","debit_amount":"string","wage_amount":"string","reimbursement_amount":"string","check_amount":"string"},"contractor_payments":[{"uuid":"string","contractor_uuid":"string","bonus":"string","hours":"string","payment_method":"Direct Deposit","reimbursement":"string","status":"Funded","hourly_rate":"string","may_cancel":true,"wage":"string","wage_type":"Hourly","wage_total":"string"}]} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + +The full contractor payment group, including associated contractor payments. + + + + + \ No newline at end of file diff --git a/docs/api/schemas/contractor-payment-method.Schema.json b/docs/api/schemas/contractor-payment-method.Schema.json new file mode 100644 index 000000000..69637feae --- /dev/null +++ b/docs/api/schemas/contractor-payment-method.Schema.json @@ -0,0 +1 @@ +{"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"]},"schemaType":"response"} \ No newline at end of file diff --git a/docs/api/schemas/contractor-payment-method.schema.mdx b/docs/api/schemas/contractor-payment-method.schema.mdx new file mode 100644 index 000000000..7af07ff5a --- /dev/null +++ b/docs/api/schemas/contractor-payment-method.schema.mdx @@ -0,0 +1,32 @@ +--- +id: contractor-payment-method +title: "Contractor-Payment-Method" +description: "" +sidebar_label: "Contractor-Payment-Method" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"version":"string","type":"Direct Deposit","split_by":"Amount","splits":"Unknown Type: array,null"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/schemas/contractor-payment-summary-by-dates.Schema.json b/docs/api/schemas/contractor-payment-summary-by-dates.Schema.json new file mode 100644 index 000000000..7860c730b --- /dev/null +++ b/docs/api/schemas/contractor-payment-summary-by-dates.Schema.json @@ -0,0 +1 @@ +{"schema":{"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"},"schemaType":"response"} \ No newline at end of file diff --git a/docs/api/schemas/contractor-payment-summary-by-dates.schema.mdx b/docs/api/schemas/contractor-payment-summary-by-dates.schema.mdx new file mode 100644 index 000000000..a9b47ebd6 --- /dev/null +++ b/docs/api/schemas/contractor-payment-summary-by-dates.schema.mdx @@ -0,0 +1,32 @@ +--- +id: contractor-payment-summary-by-dates +title: "Contractor-Payment-Summary-By-Dates" +description: "The representation of the summary of contractor payments for a given company in a given time period." +sidebar_label: "Contractor-Payment-Summary-By-Dates" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"total":{"reimbursements":"string","wages":"string"},"contractor_payments":[{"contractor_uuid":"string","check_date":"string","reimbursement_total":"string","wage_total":"string","payments":[{"uuid":"string","contractor_uuid":"string","bonus":"string","date":"string","hours":"string","payment_method":"Direct Deposit","reimbursement":"string","status":"Funded","hourly_rate":"string","may_cancel":true,"wage":"string","wage_type":"Hourly","wage_total":"string"}]}]} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + +The representation of the summary of contractor payments for a given company in a given time period. + + + + + \ No newline at end of file diff --git a/docs/api/schemas/contractor-payment-summary.Schema.json b/docs/api/schemas/contractor-payment-summary.Schema.json new file mode 100644 index 000000000..9ebee5082 --- /dev/null +++ b/docs/api/schemas/contractor-payment-summary.Schema.json @@ -0,0 +1 @@ +{"schema":{"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"},"schemaType":"response"} \ No newline at end of file diff --git a/docs/api/schemas/contractor-payment-summary.schema.mdx b/docs/api/schemas/contractor-payment-summary.schema.mdx new file mode 100644 index 000000000..8d5756876 --- /dev/null +++ b/docs/api/schemas/contractor-payment-summary.schema.mdx @@ -0,0 +1,32 @@ +--- +id: contractor-payment-summary +title: "Contractor-Payment-Summary" +description: "The representation of the summary of contractor payments for a given company in a given time period." +sidebar_label: "Contractor-Payment-Summary" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"total":{"reimbursements":"string","wages":"string"},"contractor_payments":[{"contractor_uuid":0,"reimbursement_total":"string","wage_total":"string","payments":[{"uuid":"string","contractor_uuid":"string","bonus":"string","date":"string","hours":"string","payment_method":"Direct Deposit","reimbursement":"string","status":"Funded","hourly_rate":"string","may_cancel":true,"wage":"string","wage_type":"Hourly","wage_total":"string"}]}]} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + +The representation of the summary of contractor payments for a given company in a given time period. + + + + + \ No newline at end of file diff --git a/docs/api/schemas/contractor-payment.Schema.json b/docs/api/schemas/contractor-payment.Schema.json new file mode 100644 index 000000000..4ebed005a --- /dev/null +++ b/docs/api/schemas/contractor-payment.Schema.json @@ -0,0 +1 @@ +{"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"]},"schemaType":"response"} \ No newline at end of file diff --git a/docs/api/schemas/contractor-payment.schema.mdx b/docs/api/schemas/contractor-payment.schema.mdx new file mode 100644 index 000000000..921174ae9 --- /dev/null +++ b/docs/api/schemas/contractor-payment.schema.mdx @@ -0,0 +1,32 @@ +--- +id: contractor-payment +title: "Contractor Payment" +description: "The representation of a single contractor payment." +sidebar_label: "Contractor Payment" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"uuid":"string","contractor_uuid":"string","bonus":"string","date":"string","hours":"string","payment_method":"Direct Deposit","reimbursement":"string","status":"Funded","hourly_rate":"string","may_cancel":true,"wage":"string","wage_type":"Hourly","wage_total":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + +The representation of a single contractor payment. + + + + + \ No newline at end of file diff --git a/docs/api/schemas/contractor.Schema.json b/docs/api/schemas/contractor.Schema.json new file mode 100644 index 000000000..1879ca9e7 --- /dev/null +++ b/docs/api/schemas/contractor.Schema.json @@ -0,0 +1 @@ +{"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"},"schemaType":"response"} \ No newline at end of file diff --git a/docs/api/schemas/contractor.schema.mdx b/docs/api/schemas/contractor.schema.mdx new file mode 100644 index 000000000..85f7ae244 --- /dev/null +++ b/docs/api/schemas/contractor.schema.mdx @@ -0,0 +1,32 @@ +--- +id: contractor +title: "Contractor" +description: "The representation of a contractor (individual or business) in Gusto." +sidebar_label: "Contractor" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"uuid":"string","company_uuid":"string","wage_type":"Fixed","is_active":true,"version":"string","type":"Individual","first_name":"string","last_name":"string","middle_initial":"string","business_name":"string","ein":"string","has_ein":true,"email":"string","start_date":"string","address":"Unknown Type: object,null","hourly_rate":"50.0","file_new_hire_report":true,"work_state":"string","onboarded":true,"onboarding_status":"admin_onboarding_incomplete","payment_method":"Direct Deposit","has_ssn":true,"department_uuid":"string","department":"string","department_title":"string","dismissal_date":"string","upcoming_employment":"Unknown Type: object,null","dismissal_cancellation_eligible":true,"rehire_cancellation_eligible":true} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + +The representation of a contractor (individual or business) in Gusto. + + + + + \ No newline at end of file diff --git a/docs/api/schemas/contribution-exclusion.Schema.json b/docs/api/schemas/contribution-exclusion.Schema.json new file mode 100644 index 000000000..d515eeb20 --- /dev/null +++ b/docs/api/schemas/contribution-exclusion.Schema.json @@ -0,0 +1 @@ +{"schema":{"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"},"schemaType":"response"} \ No newline at end of file diff --git a/docs/api/schemas/contribution-exclusion.schema.mdx b/docs/api/schemas/contribution-exclusion.schema.mdx new file mode 100644 index 000000000..96eba6443 --- /dev/null +++ b/docs/api/schemas/contribution-exclusion.schema.mdx @@ -0,0 +1,32 @@ +--- +id: contribution-exclusion +title: "Contribution-Exclusion" +description: "The representation of a contribution exclusion for a company benefit." +sidebar_label: "Contribution-Exclusion" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"contribution_uuid":"string","contribution_type":"string","excluded":true} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + +The representation of a contribution exclusion for a company benefit. + + + + + \ No newline at end of file diff --git a/docs/api/schemas/document-signed.Schema.json b/docs/api/schemas/document-signed.Schema.json new file mode 100644 index 000000000..b9f966579 --- /dev/null +++ b/docs/api/schemas/document-signed.Schema.json @@ -0,0 +1 @@ +{"schema":{"title":"Document Signed","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},"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","signed_at":"2024-09-03T16:39:22.000-07:00","description":"Form W-9, Request for Taxpayer Identification Number and Certification","requires_signing":false,"draft":false,"year":null,"quarter":null}},"x-tags":["Documents"]},"schemaType":"response"} \ No newline at end of file diff --git a/docs/api/schemas/document-signed.schema.mdx b/docs/api/schemas/document-signed.schema.mdx new file mode 100644 index 000000000..520bb9aba --- /dev/null +++ b/docs/api/schemas/document-signed.schema.mdx @@ -0,0 +1,32 @@ +--- +id: document-signed +title: "Document Signed" +description: "" +sidebar_label: "Document Signed" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"uuid":"string","title":"string","name":"string","recipient_type":"Company","recipient_uuid":"string","signed_at":"string","description":"string","requires_signing":true,"draft":true,"year":0,"quarter":0} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/schemas/document.Schema.json b/docs/api/schemas/document.Schema.json new file mode 100644 index 000000000..a773c1d0b --- /dev/null +++ b/docs/api/schemas/document.Schema.json @@ -0,0 +1 @@ +{"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"]},"schemaType":"response"} \ No newline at end of file diff --git a/docs/api/schemas/document.schema.mdx b/docs/api/schemas/document.schema.mdx new file mode 100644 index 000000000..27360a188 --- /dev/null +++ b/docs/api/schemas/document.schema.mdx @@ -0,0 +1,32 @@ +--- +id: document +title: "Document" +description: "" +sidebar_label: "Document" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"uuid":"string","title":"string","name":"string","recipient_type":"Company","recipient_uuid":"string","pages":[{"image_url":"string","page_number":0}],"fields":[{"key":"string","value":"string","x":0,"y":0,"width":0,"height":0,"page_number":0,"data_type":"string","required":true}],"signed_at":"string","description":"string","requires_signing":true,"draft":true,"year":0,"quarter":0} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/schemas/earning-type.Schema.json b/docs/api/schemas/earning-type.Schema.json new file mode 100644 index 000000000..8a9f4ce64 --- /dev/null +++ b/docs/api/schemas/earning-type.Schema.json @@ -0,0 +1 @@ +{"schema":{"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"},"schemaType":"response"} \ No newline at end of file diff --git a/docs/api/schemas/earning-type.schema.mdx b/docs/api/schemas/earning-type.schema.mdx new file mode 100644 index 000000000..a5bd1a359 --- /dev/null +++ b/docs/api/schemas/earning-type.schema.mdx @@ -0,0 +1,32 @@ +--- +id: earning-type +title: "Earning-Type" +description: "" +sidebar_label: "Earning-Type" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"name":"string","uuid":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/schemas/employee-bank-account.Schema.json b/docs/api/schemas/employee-bank-account.Schema.json new file mode 100644 index 000000000..b97c3af42 --- /dev/null +++ b/docs/api/schemas/employee-bank-account.Schema.json @@ -0,0 +1 @@ +{"schema":{"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"]},"schemaType":"response"} \ No newline at end of file diff --git a/docs/api/schemas/employee-bank-account.schema.mdx b/docs/api/schemas/employee-bank-account.schema.mdx new file mode 100644 index 000000000..bc07ceb23 --- /dev/null +++ b/docs/api/schemas/employee-bank-account.schema.mdx @@ -0,0 +1,32 @@ +--- +id: employee-bank-account +title: "Employee-Bank-Account" +description: "" +sidebar_label: "Employee-Bank-Account" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"uuid":"string","employee_uuid":"string","account_type":"Checking","name":"string","routing_number":"string","hidden_account_number":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/schemas/employee-federal-tax-pre-2020.Schema.json b/docs/api/schemas/employee-federal-tax-pre-2020.Schema.json new file mode 100644 index 000000000..63bcf5c1c --- /dev/null +++ b/docs/api/schemas/employee-federal-tax-pre-2020.Schema.json @@ -0,0 +1 @@ +{"schema":{"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"]},"schemaType":"response"} \ No newline at end of file diff --git a/docs/api/schemas/employee-federal-tax-pre-2020.schema.mdx b/docs/api/schemas/employee-federal-tax-pre-2020.schema.mdx new file mode 100644 index 000000000..8a4f60b48 --- /dev/null +++ b/docs/api/schemas/employee-federal-tax-pre-2020.schema.mdx @@ -0,0 +1,32 @@ +--- +id: employee-federal-tax-pre-2020 +title: "Employee-Federal-Tax-Pre2020" +description: "Federal tax information for employees using the pre-2020 W4 form." +sidebar_label: "Employee-Federal-Tax-Pre2020" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"version":"string","employee_uuid":"string","employee_id":0,"company_id":0,"w4_data_type":"pre_2020_w4","filing_status":"string","federal_withholding_allowance":0,"additional_withholding":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + +Federal tax information for employees using the pre-2020 W4 form. + + + + + \ No newline at end of file diff --git a/docs/api/schemas/employee-federal-tax-rev-2020.Schema.json b/docs/api/schemas/employee-federal-tax-rev-2020.Schema.json new file mode 100644 index 000000000..93b47ca2f --- /dev/null +++ b/docs/api/schemas/employee-federal-tax-rev-2020.Schema.json @@ -0,0 +1 @@ +{"schema":{"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"]},"schemaType":"response"} \ No newline at end of file diff --git a/docs/api/schemas/employee-federal-tax-rev-2020.schema.mdx b/docs/api/schemas/employee-federal-tax-rev-2020.schema.mdx new file mode 100644 index 000000000..5cbd68746 --- /dev/null +++ b/docs/api/schemas/employee-federal-tax-rev-2020.schema.mdx @@ -0,0 +1,32 @@ +--- +id: employee-federal-tax-rev-2020 +title: "Employee-Federal-Tax-Rev2020" +description: "Federal tax information for employees using the revised 2020 W4 form." +sidebar_label: "Employee-Federal-Tax-Rev2020" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"version":"string","employee_uuid":"string","employee_id":0,"company_id":0,"w4_data_type":"rev_2020_w4","filing_status":"string","extra_withholding":"string","two_jobs":true,"dependents_amount":"string","other_income":"string","deductions":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + +Federal tax information for employees using the revised 2020 W4 form. + + + + + \ No newline at end of file diff --git a/docs/api/schemas/employee-federal-tax.Schema.json b/docs/api/schemas/employee-federal-tax.Schema.json new file mode 100644 index 000000000..803a9cc31 --- /dev/null +++ b/docs/api/schemas/employee-federal-tax.Schema.json @@ -0,0 +1 @@ +{"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"]},"schemaType":"response"} \ No newline at end of file diff --git a/docs/api/schemas/employee-federal-tax.schema.mdx b/docs/api/schemas/employee-federal-tax.schema.mdx new file mode 100644 index 000000000..354acefa7 --- /dev/null +++ b/docs/api/schemas/employee-federal-tax.schema.mdx @@ -0,0 +1,32 @@ +--- +id: employee-federal-tax +title: "Employee-Federal-Tax" +description: "Federal tax information for an employee. The response structure varies based on the w4_data_type field." +sidebar_label: "Employee-Federal-Tax" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"version":"string","employee_uuid":"string","employee_id":0,"company_id":0,"w4_data_type":"pre_2020_w4","filing_status":"string","federal_withholding_allowance":0,"additional_withholding":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + +Federal tax information for an employee. The response structure varies based on the w4_data_type field. + + + + + \ No newline at end of file diff --git a/docs/api/schemas/employee-pay-stub.Schema.json b/docs/api/schemas/employee-pay-stub.Schema.json new file mode 100644 index 000000000..d67dcfbd7 --- /dev/null +++ b/docs/api/schemas/employee-pay-stub.Schema.json @@ -0,0 +1 @@ +{"schema":{"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}},"x-tags":["Payrolls"],"required":["uuid"],"title":"Employee-Pay-Stub"},"schemaType":"response"} \ No newline at end of file diff --git a/docs/api/schemas/employee-pay-stub.schema.mdx b/docs/api/schemas/employee-pay-stub.schema.mdx new file mode 100644 index 000000000..efa0d861f --- /dev/null +++ b/docs/api/schemas/employee-pay-stub.schema.mdx @@ -0,0 +1,32 @@ +--- +id: employee-pay-stub +title: "Employee-Pay-Stub" +description: "The representation of an employee pay stub information." +sidebar_label: "Employee-Pay-Stub" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"uuid":"string","check_date":"string","gross_pay":"string","net_pay":"string","payroll_uuid":"string","check_amount":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + +The representation of an employee pay stub information. + + + + + \ No newline at end of file diff --git a/docs/api/schemas/employee-payment-method.Schema.json b/docs/api/schemas/employee-payment-method.Schema.json new file mode 100644 index 000000000..e38380b68 --- /dev/null +++ b/docs/api/schemas/employee-payment-method.Schema.json @@ -0,0 +1 @@ +{"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"]},"schemaType":"response"} \ No newline at end of file diff --git a/docs/api/schemas/employee-payment-method.schema.mdx b/docs/api/schemas/employee-payment-method.schema.mdx new file mode 100644 index 000000000..409fd69aa --- /dev/null +++ b/docs/api/schemas/employee-payment-method.schema.mdx @@ -0,0 +1,32 @@ +--- +id: employee-payment-method +title: "Employee-Payment-Method" +description: "" +sidebar_label: "Employee-Payment-Method" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"version":"string","type":"Direct Deposit","split_by":"Amount","splits":"Unknown Type: array,null"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/schemas/employee-state-tax.Schema.json b/docs/api/schemas/employee-state-tax.Schema.json new file mode 100644 index 000000000..dbae83223 --- /dev/null +++ b/docs/api/schemas/employee-state-tax.Schema.json @@ -0,0 +1 @@ +{"schema":{"title":"Employee-State-Tax","type":"object","x-examples":{"example-1":{"employee_uuid":"2005e601-3c78-410a-9d40-b960ae130383","state":"CA","questions":[{"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":"S","valid_from":"2010-01-01","valid_up_to":null}]},{"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}]},{"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}]},{"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":true,"valid_from":"2010-01-01","valid_up_to":null}]}]}},"x-tags":["Employee Tax Setup"],"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"]},"schemaType":"response"} \ No newline at end of file diff --git a/docs/api/schemas/employee-state-tax.schema.mdx b/docs/api/schemas/employee-state-tax.schema.mdx new file mode 100644 index 000000000..e670366fa --- /dev/null +++ b/docs/api/schemas/employee-state-tax.schema.mdx @@ -0,0 +1,32 @@ +--- +id: employee-state-tax +title: "Employee-State-Tax" +description: "" +sidebar_label: "Employee-State-Tax" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"employee_uuid":"string","state":"string","file_new_hire_report":true,"is_work_state":true,"questions":[{"label":"string","description":"string","key":"string","is_question_for_admin_only":true,"input_question_format":{"type":"string","options":[{"value":"string","label":"string"}]},"answers":[{"value":"string","valid_from":"string","valid_up_to":"string"}]}]} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/schemas/external-payroll-basic.Schema.json b/docs/api/schemas/external-payroll-basic.Schema.json new file mode 100644 index 000000000..6b1fa65cf --- /dev/null +++ b/docs/api/schemas/external-payroll-basic.Schema.json @@ -0,0 +1 @@ +{"schema":{"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"]},"schemaType":"response"} \ No newline at end of file diff --git a/docs/api/schemas/external-payroll-basic.schema.mdx b/docs/api/schemas/external-payroll-basic.schema.mdx new file mode 100644 index 000000000..c095258e5 --- /dev/null +++ b/docs/api/schemas/external-payroll-basic.schema.mdx @@ -0,0 +1,32 @@ +--- +id: external-payroll-basic +title: "External-Payroll-Basic" +description: "The representation of an external payroll with minimal information." +sidebar_label: "External-Payroll-Basic" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"uuid":"string","company_uuid":"string","check_date":"string","payment_period_start_date":"string","payment_period_end_date":"string","status":"unprocessed"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + +The representation of an external payroll with minimal information. + + + + + \ No newline at end of file diff --git a/docs/api/schemas/external-payroll-tax-suggestions.Schema.json b/docs/api/schemas/external-payroll-tax-suggestions.Schema.json new file mode 100644 index 000000000..b56cd065e --- /dev/null +++ b/docs/api/schemas/external-payroll-tax-suggestions.Schema.json @@ -0,0 +1 @@ +{"schema":{"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"}]}}},"schemaType":"response"} \ No newline at end of file diff --git a/docs/api/schemas/external-payroll-tax-suggestions.schema.mdx b/docs/api/schemas/external-payroll-tax-suggestions.schema.mdx new file mode 100644 index 000000000..05c0dea1c --- /dev/null +++ b/docs/api/schemas/external-payroll-tax-suggestions.schema.mdx @@ -0,0 +1,32 @@ +--- +id: external-payroll-tax-suggestions +title: "External-Payroll-Tax-Suggestions" +description: "The representation of an external payroll with minimal information." +sidebar_label: "External-Payroll-Tax-Suggestions" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"employee_uuid":"string","tax_suggestions":[{"tax_id":0,"amount":"string"}]} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + +The representation of an external payroll with minimal information. + + + + + \ No newline at end of file diff --git a/docs/api/schemas/external-payroll.Schema.json b/docs/api/schemas/external-payroll.Schema.json new file mode 100644 index 000000000..bb8bb078e --- /dev/null +++ b/docs/api/schemas/external-payroll.Schema.json @@ -0,0 +1 @@ +{"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"]},"schemaType":"response"} \ No newline at end of file diff --git a/docs/api/schemas/external-payroll.schema.mdx b/docs/api/schemas/external-payroll.schema.mdx new file mode 100644 index 000000000..af2056711 --- /dev/null +++ b/docs/api/schemas/external-payroll.schema.mdx @@ -0,0 +1,32 @@ +--- +id: external-payroll +title: "External-Payroll" +description: "The representation of an external payroll." +sidebar_label: "External-Payroll" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"uuid":"string","company_uuid":"string","check_date":"string","payment_period_start_date":"string","payment_period_end_date":"string","status":"unprocessed","external_payroll_items":[{"employee_uuid":"string","earnings":[{"amount":"string","hours":"string","earning_type":"string","earning_id":0}],"benefits":[{"benefit_id":0,"company_contribution_amount":"string","employee_deduction_amount":"string"}],"taxes":[{"tax_id":0,"amount":"string"}]}],"applicable_earnings":[{"earning_type":"string","earning_id":0,"name":"string","input_type":"string","category":"string"}],"applicable_benefits":"Unknown Type: array,null","applicable_taxes":[{"id":0,"name":"string","employer_tax":true,"resident_tax":true}],"metadata":{"deletable":true}} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + +The representation of an external payroll. + + + + + \ No newline at end of file diff --git a/docs/api/schemas/federal-tax-details.Schema.json b/docs/api/schemas/federal-tax-details.Schema.json new file mode 100644 index 000000000..b9e9399e0 --- /dev/null +++ b/docs/api/schemas/federal-tax-details.Schema.json @@ -0,0 +1 @@ +{"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"]},"schemaType":"response"} \ No newline at end of file diff --git a/docs/api/schemas/federal-tax-details.schema.mdx b/docs/api/schemas/federal-tax-details.schema.mdx new file mode 100644 index 000000000..ecb9ea608 --- /dev/null +++ b/docs/api/schemas/federal-tax-details.schema.mdx @@ -0,0 +1,32 @@ +--- +id: federal-tax-details +title: "Federal-Tax-Details" +description: "" +sidebar_label: "Federal-Tax-Details" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"version":"string","tax_payer_type":"string","taxable_as_scorp":true,"filing_form":"string","has_ein":true,"ein_verified":true,"ein_verification":{"status":"pending"},"legal_name":"string","effective_date":"string","deposit_schedule":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/schemas/flow.Schema.json b/docs/api/schemas/flow.Schema.json new file mode 100644 index 000000000..6bee4b340 --- /dev/null +++ b/docs/api/schemas/flow.Schema.json @@ -0,0 +1 @@ +{"schema":{"description":"The representation of a flow in Gusto white-label UI.","type":"object","x-examples":{"success_status":{"url":"https://flows.gusto-demo.com/flows/lO2BHHAMCScPVV9G5WEURW0Im_nP9mGYloQgjUWbenQ"}},"title":"Flow","x-tags":["Flows"],"properties":{"url":{"type":"string"}}},"schemaType":"response"} \ No newline at end of file diff --git a/docs/api/schemas/flow.schema.mdx b/docs/api/schemas/flow.schema.mdx new file mode 100644 index 000000000..0bf2ffa8e --- /dev/null +++ b/docs/api/schemas/flow.schema.mdx @@ -0,0 +1,32 @@ +--- +id: flow +title: "Flow" +description: "The representation of a flow in Gusto white-label UI." +sidebar_label: "Flow" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"url":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + +The representation of a flow in Gusto white-label UI. + + + + + \ No newline at end of file diff --git a/docs/api/schemas/form.Schema.json b/docs/api/schemas/form.Schema.json new file mode 100644 index 000000000..290c835f0 --- /dev/null +++ b/docs/api/schemas/form.Schema.json @@ -0,0 +1 @@ +{"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"]},"schemaType":"response"} \ No newline at end of file diff --git a/docs/api/schemas/form.schema.mdx b/docs/api/schemas/form.schema.mdx new file mode 100644 index 000000000..a418f394a --- /dev/null +++ b/docs/api/schemas/form.schema.mdx @@ -0,0 +1,32 @@ +--- +id: form +title: "Form" +description: "" +sidebar_label: "Form" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"uuid":"string","name":"string","title":"string","description":"string","draft":true,"year":0,"quarter":0,"requires_signing":true,"document_content_type":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/schemas/i-9-authorization-document-option.Schema.json b/docs/api/schemas/i-9-authorization-document-option.Schema.json new file mode 100644 index 000000000..a9da487b2 --- /dev/null +++ b/docs/api/schemas/i-9-authorization-document-option.Schema.json @@ -0,0 +1 @@ +{"schema":{"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"},"schemaType":"response"} \ No newline at end of file diff --git a/docs/api/schemas/i-9-authorization-document-option.schema.mdx b/docs/api/schemas/i-9-authorization-document-option.schema.mdx new file mode 100644 index 000000000..2b22d3110 --- /dev/null +++ b/docs/api/schemas/i-9-authorization-document-option.schema.mdx @@ -0,0 +1,32 @@ +--- +id: i-9-authorization-document-option +title: "I9-Authorization-Document-Option" +description: "An employee's I-9 verification document option based on the authorization status" +sidebar_label: "I9-Authorization-Document-Option" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"section":"A","description":"string","document_type":"string","document_title":["string"],"common_choice":true} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + +An employee's I-9 verification document option based on the authorization status + + + + + \ No newline at end of file diff --git a/docs/api/schemas/i-9-authorization-document.Schema.json b/docs/api/schemas/i-9-authorization-document.Schema.json new file mode 100644 index 000000000..c72d3c2d8 --- /dev/null +++ b/docs/api/schemas/i-9-authorization-document.Schema.json @@ -0,0 +1 @@ +{"schema":{"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"},"schemaType":"response"} \ No newline at end of file diff --git a/docs/api/schemas/i-9-authorization-document.schema.mdx b/docs/api/schemas/i-9-authorization-document.schema.mdx new file mode 100644 index 000000000..0350a1479 --- /dev/null +++ b/docs/api/schemas/i-9-authorization-document.schema.mdx @@ -0,0 +1,32 @@ +--- +id: i-9-authorization-document +title: "I9-Authorization-Document" +description: "An employee's I-9 verification document" +sidebar_label: "I9-Authorization-Document" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"uuid":"string","document_type":"string","document_title":"string","expiration_date":"string","issuing_authority":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + +An employee's I-9 verification document + + + + + \ No newline at end of file diff --git a/docs/api/schemas/i-9-authorization.Schema.json b/docs/api/schemas/i-9-authorization.Schema.json new file mode 100644 index 000000000..0f635ee69 --- /dev/null +++ b/docs/api/schemas/i-9-authorization.Schema.json @@ -0,0 +1 @@ +{"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"},"schemaType":"response"} \ No newline at end of file diff --git a/docs/api/schemas/i-9-authorization.schema.mdx b/docs/api/schemas/i-9-authorization.schema.mdx new file mode 100644 index 000000000..9f8c9214d --- /dev/null +++ b/docs/api/schemas/i-9-authorization.schema.mdx @@ -0,0 +1,32 @@ +--- +id: i-9-authorization +title: "I9-Authorization" +description: "An employee's I-9 authorization" +sidebar_label: "I9-Authorization" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"uuid":"string","form_uuid":"string","version":"string","authorization_status":"citizen","document_type":"uscis_alien_registration_number","has_document_number":true,"expiration_date":"string","country":"string","employer_signed":true,"employee_signed":true,"additional_info":"string","alt_procedure":true} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + +An employee's I-9 authorization + + + + + \ No newline at end of file diff --git a/docs/api/schemas/industry.Schema.json b/docs/api/schemas/industry.Schema.json new file mode 100644 index 000000000..006a0a214 --- /dev/null +++ b/docs/api/schemas/industry.Schema.json @@ -0,0 +1 @@ +{"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"]},"schemaType":"response"} \ No newline at end of file diff --git a/docs/api/schemas/industry.schema.mdx b/docs/api/schemas/industry.schema.mdx new file mode 100644 index 000000000..f282467ce --- /dev/null +++ b/docs/api/schemas/industry.schema.mdx @@ -0,0 +1,32 @@ +--- +id: industry +title: "Industry" +description: "" +sidebar_label: "Industry" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"company_uuid":"string","naics_code":611420,"sic_codes":[8243],"title":"Computer Training"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/schemas/pay-period.Schema.json b/docs/api/schemas/pay-period.Schema.json new file mode 100644 index 000000000..c33a8236d --- /dev/null +++ b/docs/api/schemas/pay-period.Schema.json @@ -0,0 +1 @@ +{"schema":{"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"},"schemaType":"response"} \ No newline at end of file diff --git a/docs/api/schemas/pay-period.schema.mdx b/docs/api/schemas/pay-period.schema.mdx new file mode 100644 index 000000000..f35a0fd05 --- /dev/null +++ b/docs/api/schemas/pay-period.schema.mdx @@ -0,0 +1,32 @@ +--- +id: pay-period +title: "Pay-Period" +description: "The representation of a pay period." +sidebar_label: "Pay-Period" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"start_date":"string","end_date":"string","pay_schedule_uuid":"string","payroll":{"payroll_uuid":"string","check_date":"string","processed":true,"payroll_deadline":"2024-07-29T15:51:28.071Z","payroll_type":"regular"}} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + +The representation of a pay period. + + + + + \ No newline at end of file diff --git a/docs/api/schemas/pay-schedule-assignment-department.Schema.json b/docs/api/schemas/pay-schedule-assignment-department.Schema.json new file mode 100644 index 000000000..e144d648f --- /dev/null +++ b/docs/api/schemas/pay-schedule-assignment-department.Schema.json @@ -0,0 +1 @@ +{"schema":{"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"},"schemaType":"response"} \ No newline at end of file diff --git a/docs/api/schemas/pay-schedule-assignment-department.schema.mdx b/docs/api/schemas/pay-schedule-assignment-department.schema.mdx new file mode 100644 index 000000000..5f74e7a61 --- /dev/null +++ b/docs/api/schemas/pay-schedule-assignment-department.schema.mdx @@ -0,0 +1,32 @@ +--- +id: pay-schedule-assignment-department +title: "Pay-Schedule-Assignment-Department" +description: "" +sidebar_label: "Pay-Schedule-Assignment-Department" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"department_uuid":"string","pay_schedule_uuid":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/schemas/pay-schedule-assignment-employee-change.Schema.json b/docs/api/schemas/pay-schedule-assignment-employee-change.Schema.json new file mode 100644 index 000000000..ea35b8f65 --- /dev/null +++ b/docs/api/schemas/pay-schedule-assignment-employee-change.Schema.json @@ -0,0 +1 @@ +{"schema":{"type":"object","x-examples":{"example-1":{"employee_uuid":"43b39ada-dc49-4879-9594-fe95f67ae434","first_name":"Penny","last_name":"Parker","pay_frequency":"Twice per month — Salaried pay schedule","first_pay_period":{"pay_schedule_uuid":"3f029a58-155d-4c30-8361-cc266b2c1f11","start_date":"2023-07-01","end_date":"2023-08-01","check_date":"2023-08-02"},"transition_pay_period":{"start_date":"2023-06-20","end_date":"2023-06-30"}}},"properties":{"employee_uuid":{"type":"string","description":"The UUID of the employee.","readOnly":true},"first_name":{"type":"string","description":"The employee's first name.","readOnly":true},"last_name":{"type":"string","description":"The employee's last name.","readOnly":true},"pay_frequency":{"type":"string","description":"New pay schedule frequency and name.","readOnly":true},"first_pay_period":{"description":"Pay schedule assignment first pay period information.","type":"object","x-examples":{"example-1":{"pay_schedule_uuid":"3f029a58-155d-4c30-8361-cc266b2c1f11","start_date":"2023-07-01","end_date":"2023-08-01","check_date":"2023-08-02"}},"properties":{"pay_schedule_uuid":{"type":"string","description":"The pay schedule UUID."},"start_date":{"type":"string","description":"Pay period start date."},"end_date":{"type":"string","description":"Pay period end date."},"check_date":{"type":"string","description":"Pay period check date."}},"x-tags":["Pay Schedules"],"title":"Pay-Schedule-Assignment-Pay-Period"},"transition_pay_period":{"description":"Pay schedule assignment transition pay period information.","type":"object","x-examples":{"example-1":{"start_date":"2023-07-01","end_date":"2023-08-01"}},"properties":{"start_date":{"type":"string","description":"Pay period start date."},"end_date":{"type":"string","description":"Pay period end date."}},"x-tags":["Pay Schedules"],"title":"Pay-Schedule-Assignment-Transition-Pay-Period"}},"x-tags":["Pay Schedules"],"title":"Pay-Schedule-Assignment-Employee-Change"},"schemaType":"response"} \ No newline at end of file diff --git a/docs/api/schemas/pay-schedule-assignment-employee-change.schema.mdx b/docs/api/schemas/pay-schedule-assignment-employee-change.schema.mdx new file mode 100644 index 000000000..f6149714a --- /dev/null +++ b/docs/api/schemas/pay-schedule-assignment-employee-change.schema.mdx @@ -0,0 +1,32 @@ +--- +id: pay-schedule-assignment-employee-change +title: "Pay-Schedule-Assignment-Employee-Change" +description: "" +sidebar_label: "Pay-Schedule-Assignment-Employee-Change" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"employee_uuid":"string","first_name":"string","last_name":"string","pay_frequency":"string","first_pay_period":{"pay_schedule_uuid":"string","start_date":"string","end_date":"string","check_date":"string"},"transition_pay_period":{"start_date":"string","end_date":"string"}} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/schemas/pay-schedule-assignment-employee.Schema.json b/docs/api/schemas/pay-schedule-assignment-employee.Schema.json new file mode 100644 index 000000000..9312c9232 --- /dev/null +++ b/docs/api/schemas/pay-schedule-assignment-employee.Schema.json @@ -0,0 +1 @@ +{"schema":{"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"},"schemaType":"response"} \ No newline at end of file diff --git a/docs/api/schemas/pay-schedule-assignment-employee.schema.mdx b/docs/api/schemas/pay-schedule-assignment-employee.schema.mdx new file mode 100644 index 000000000..db3b84d65 --- /dev/null +++ b/docs/api/schemas/pay-schedule-assignment-employee.schema.mdx @@ -0,0 +1,32 @@ +--- +id: pay-schedule-assignment-employee +title: "Pay-Schedule-Assignment-Employee" +description: "" +sidebar_label: "Pay-Schedule-Assignment-Employee" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"employee_uuid":"string","pay_schedule_uuid":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/schemas/pay-schedule-assignment-pay-period.Schema.json b/docs/api/schemas/pay-schedule-assignment-pay-period.Schema.json new file mode 100644 index 000000000..8a68358bd --- /dev/null +++ b/docs/api/schemas/pay-schedule-assignment-pay-period.Schema.json @@ -0,0 +1 @@ +{"schema":{"description":"Pay schedule assignment first pay period information.","type":"object","x-examples":{"example-1":{"pay_schedule_uuid":"3f029a58-155d-4c30-8361-cc266b2c1f11","start_date":"2023-07-01","end_date":"2023-08-01","check_date":"2023-08-02"}},"properties":{"pay_schedule_uuid":{"type":"string","description":"The pay schedule UUID."},"start_date":{"type":"string","description":"Pay period start date."},"end_date":{"type":"string","description":"Pay period end date."},"check_date":{"type":"string","description":"Pay period check date."}},"x-tags":["Pay Schedules"],"title":"Pay-Schedule-Assignment-Pay-Period"},"schemaType":"response"} \ No newline at end of file diff --git a/docs/api/schemas/pay-schedule-assignment-pay-period.schema.mdx b/docs/api/schemas/pay-schedule-assignment-pay-period.schema.mdx new file mode 100644 index 000000000..4c0a60026 --- /dev/null +++ b/docs/api/schemas/pay-schedule-assignment-pay-period.schema.mdx @@ -0,0 +1,32 @@ +--- +id: pay-schedule-assignment-pay-period +title: "Pay-Schedule-Assignment-Pay-Period" +description: "Pay schedule assignment first pay period information." +sidebar_label: "Pay-Schedule-Assignment-Pay-Period" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"pay_schedule_uuid":"string","start_date":"string","end_date":"string","check_date":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + +Pay schedule assignment first pay period information. + + + + + \ No newline at end of file diff --git a/docs/api/schemas/pay-schedule-assignment-preview.Schema.json b/docs/api/schemas/pay-schedule-assignment-preview.Schema.json new file mode 100644 index 000000000..61c90d594 --- /dev/null +++ b/docs/api/schemas/pay-schedule-assignment-preview.Schema.json @@ -0,0 +1 @@ +{"schema":{"description":"The representation of a pay schedule assignment preview.","type":"object","x-examples":{"example-1":{"type":"hourly_salaried","employee_changes":{"employee_uuid":"43b39ada-dc49-4879-9594-fe95f67ae434","first_name":"Penny","last_name":"Parker","pay_frequency":"Twice per month — Salaried pay schedule","first_pay_period":{"pay_schedule_uuid":"3f029a58-155d-4c30-8361-cc266b2c1f11","start_date":"2023-07-01","end_date":"2023-08-01","check_date":"2023-08-02"},"transition_pay_period":{"start_date":"2023-06-20","end_date":"2023-06-30"}}}},"properties":{"type":{"anyOf":[{"type":"string","enum":["single","hourly_salaried","by_employee","by_department"]},{"type":"null"}],"description":"The pay schedule assignment type.","readOnly":true},"employee_changes":{"type":"array","description":"A list of pay schedule changes including pay period and transition pay period.","items":{"type":"object","x-examples":{"example-1":{"employee_uuid":"43b39ada-dc49-4879-9594-fe95f67ae434","first_name":"Penny","last_name":"Parker","pay_frequency":"Twice per month — Salaried pay schedule","first_pay_period":{"pay_schedule_uuid":"3f029a58-155d-4c30-8361-cc266b2c1f11","start_date":"2023-07-01","end_date":"2023-08-01","check_date":"2023-08-02"},"transition_pay_period":{"start_date":"2023-06-20","end_date":"2023-06-30"}}},"properties":{"employee_uuid":{"type":"string","description":"The UUID of the employee.","readOnly":true},"first_name":{"type":"string","description":"The employee's first name.","readOnly":true},"last_name":{"type":"string","description":"The employee's last name.","readOnly":true},"pay_frequency":{"type":"string","description":"New pay schedule frequency and name.","readOnly":true},"first_pay_period":{"description":"Pay schedule assignment first pay period information.","type":"object","x-examples":{"example-1":{"pay_schedule_uuid":"3f029a58-155d-4c30-8361-cc266b2c1f11","start_date":"2023-07-01","end_date":"2023-08-01","check_date":"2023-08-02"}},"properties":{"pay_schedule_uuid":{"type":"string","description":"The pay schedule UUID."},"start_date":{"type":"string","description":"Pay period start date."},"end_date":{"type":"string","description":"Pay period end date."},"check_date":{"type":"string","description":"Pay period check date."}},"x-tags":["Pay Schedules"],"title":"Pay-Schedule-Assignment-Pay-Period"},"transition_pay_period":{"description":"Pay schedule assignment transition pay period information.","type":"object","x-examples":{"example-1":{"start_date":"2023-07-01","end_date":"2023-08-01"}},"properties":{"start_date":{"type":"string","description":"Pay period start date."},"end_date":{"type":"string","description":"Pay period end date."}},"x-tags":["Pay Schedules"],"title":"Pay-Schedule-Assignment-Transition-Pay-Period"}},"x-tags":["Pay Schedules"],"title":"Pay-Schedule-Assignment-Employee-Change"}}},"x-tags":["Pay Schedules"],"title":"Pay-Schedule-Assignment-Preview"},"schemaType":"response"} \ No newline at end of file diff --git a/docs/api/schemas/pay-schedule-assignment-preview.schema.mdx b/docs/api/schemas/pay-schedule-assignment-preview.schema.mdx new file mode 100644 index 000000000..24636dd62 --- /dev/null +++ b/docs/api/schemas/pay-schedule-assignment-preview.schema.mdx @@ -0,0 +1,32 @@ +--- +id: pay-schedule-assignment-preview +title: "Pay-Schedule-Assignment-Preview" +description: "The representation of a pay schedule assignment preview." +sidebar_label: "Pay-Schedule-Assignment-Preview" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"type":"single","employee_changes":[{"employee_uuid":"string","first_name":"string","last_name":"string","pay_frequency":"string","first_pay_period":{"pay_schedule_uuid":"string","start_date":"string","end_date":"string","check_date":"string"},"transition_pay_period":{"start_date":"string","end_date":"string"}}]} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + +The representation of a pay schedule assignment preview. + + + + + \ No newline at end of file diff --git a/docs/api/schemas/pay-schedule-assignment-transition-pay-period.Schema.json b/docs/api/schemas/pay-schedule-assignment-transition-pay-period.Schema.json new file mode 100644 index 000000000..1351d0f89 --- /dev/null +++ b/docs/api/schemas/pay-schedule-assignment-transition-pay-period.Schema.json @@ -0,0 +1 @@ +{"schema":{"description":"Pay schedule assignment transition pay period information.","type":"object","x-examples":{"example-1":{"start_date":"2023-07-01","end_date":"2023-08-01"}},"properties":{"start_date":{"type":"string","description":"Pay period start date."},"end_date":{"type":"string","description":"Pay period end date."}},"x-tags":["Pay Schedules"],"title":"Pay-Schedule-Assignment-Transition-Pay-Period"},"schemaType":"response"} \ No newline at end of file diff --git a/docs/api/schemas/pay-schedule-assignment-transition-pay-period.schema.mdx b/docs/api/schemas/pay-schedule-assignment-transition-pay-period.schema.mdx new file mode 100644 index 000000000..52e7905ea --- /dev/null +++ b/docs/api/schemas/pay-schedule-assignment-transition-pay-period.schema.mdx @@ -0,0 +1,32 @@ +--- +id: pay-schedule-assignment-transition-pay-period +title: "Pay-Schedule-Assignment-Transition-Pay-Period" +description: "Pay schedule assignment transition pay period information." +sidebar_label: "Pay-Schedule-Assignment-Transition-Pay-Period" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"start_date":"string","end_date":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + +Pay schedule assignment transition pay period information. + + + + + \ No newline at end of file diff --git a/docs/api/schemas/pay-schedule-assignment.Schema.json b/docs/api/schemas/pay-schedule-assignment.Schema.json new file mode 100644 index 000000000..1cd427ddf --- /dev/null +++ b/docs/api/schemas/pay-schedule-assignment.Schema.json @@ -0,0 +1 @@ +{"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"},"schemaType":"response"} \ No newline at end of file diff --git a/docs/api/schemas/pay-schedule-assignment.schema.mdx b/docs/api/schemas/pay-schedule-assignment.schema.mdx new file mode 100644 index 000000000..3a1cb282a --- /dev/null +++ b/docs/api/schemas/pay-schedule-assignment.schema.mdx @@ -0,0 +1,32 @@ +--- +id: pay-schedule-assignment +title: "Pay-Schedule-Assignment" +description: "The representation of a pay schedule assignment." +sidebar_label: "Pay-Schedule-Assignment" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"type":"single","hourly_pay_schedule_uuid":"string","salaried_pay_schedule_uuid":"string","default_pay_schedule_uuid":"string","employees":"Unknown Type: array,null","departments":"Unknown Type: array,null"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + +The representation of a pay schedule assignment. + + + + + \ No newline at end of file diff --git a/docs/api/schemas/pay-schedule.Schema.json b/docs/api/schemas/pay-schedule.Schema.json new file mode 100644 index 000000000..ec4bec7b7 --- /dev/null +++ b/docs/api/schemas/pay-schedule.Schema.json @@ -0,0 +1 @@ +{"schema":{"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"]},"schemaType":"response"} \ No newline at end of file diff --git a/docs/api/schemas/pay-schedule.schema.mdx b/docs/api/schemas/pay-schedule.schema.mdx new file mode 100644 index 000000000..267b042b7 --- /dev/null +++ b/docs/api/schemas/pay-schedule.schema.mdx @@ -0,0 +1,32 @@ +--- +id: pay-schedule +title: "Pay Schedule" +description: "The representation of a pay schedule." +sidebar_label: "Pay Schedule" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"uuid":"string","frequency":"Every week","anchor_pay_date":"string","anchor_end_of_pay_period":"string","day_1":0,"day_2":0,"name":"string","custom_name":"string","auto_pilot":true,"active":true} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + +The representation of a pay schedule. + + + + + \ No newline at end of file diff --git a/docs/api/schemas/payment-configs.Schema.json b/docs/api/schemas/payment-configs.Schema.json new file mode 100644 index 000000000..d39964444 --- /dev/null +++ b/docs/api/schemas/payment-configs.Schema.json @@ -0,0 +1 @@ +{"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"]},"schemaType":"response"} \ No newline at end of file diff --git a/docs/api/schemas/payment-configs.schema.mdx b/docs/api/schemas/payment-configs.schema.mdx new file mode 100644 index 000000000..0672c0fe9 --- /dev/null +++ b/docs/api/schemas/payment-configs.schema.mdx @@ -0,0 +1,32 @@ +--- +id: payment-configs +title: "Payment-Configs" +description: "" +sidebar_label: "Payment-Configs" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"company_uuid":"string","partner_uuid":"string","fast_payment_limit":"string","payment_speed":"1-day","partner_owned_disbursement":true,"earned_fast_ach_blockers":[{"blocker_type":"minimum_days","threshold":0}]} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/schemas/payroll-minimal.Schema.json b/docs/api/schemas/payroll-minimal.Schema.json new file mode 100644 index 000000000..cf7d89d85 --- /dev/null +++ b/docs/api/schemas/payroll-minimal.Schema.json @@ -0,0 +1 @@ +{"schema":{"description":"","type":"object","x-tags":["Payrolls"],"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"},"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"},"reversal_payroll_uuids":{"type":"array","description":"Array of reversal payroll UUIDs, if applicable.","uniqueItems":true,"items":{"type":"string","description":"The UUID of the reversal payroll.","nullable":false,"readOnly":true},"title":"Reversal-Payroll-Uuids-Type"}},"required":["company_uuid","uuid","payroll_uuid","processed"],"title":"Payroll-Minimal"},"schemaType":"response"} \ No newline at end of file diff --git a/docs/api/schemas/payroll-minimal.schema.mdx b/docs/api/schemas/payroll-minimal.schema.mdx new file mode 100644 index 000000000..9ce6fc6fb --- /dev/null +++ b/docs/api/schemas/payroll-minimal.schema.mdx @@ -0,0 +1,32 @@ +--- +id: payroll-minimal +title: "Payroll-Minimal" +description: "" +sidebar_label: "Payroll-Minimal" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"payroll_deadline":"2024-07-29T15:51:28.071Z","check_date":"string","processed":true,"processed_date":"string","calculated_at":"2024-07-29T15:51:28.071Z","uuid":"string","payroll_uuid":"string","company_uuid":"string","off_cycle":true,"off_cycle_reason":"Adhoc","auto_pilot":true,"external":true,"final_termination_payroll":true,"withholding_pay_period":"Every week","skip_regular_deductions":true,"fixed_withholding_rate":true,"pay_period":{"start_date":"string","end_date":"string","pay_schedule_uuid":"string"},"payroll_status_meta":{"cancellable":true,"expected_check_date":"string","initial_check_date":"string","expected_debit_time":"string","payroll_late":true,"initial_debit_cutoff_time":"string"},"totals":{"company_debit":"string","net_pay_debit":"string","tax_debit":"string","reimbursement_debit":"string","child_support_debit":"string","reimbursements":"string","net_pay":"string","gross_pay":"string","employee_bonuses":"string","employee_commissions":"string","employee_cash_tips":"string","employee_paycheck_tips":"string","additional_earnings":"string","owners_draw":"string","check_amount":"string","employer_taxes":"string","employee_taxes":"string","benefits":"string","employee_benefits_deductions":"string","imputed_pay":"string","deferred_payroll_taxes":"string","other_deductions":"string"},"payment_speed_changed":{"original_check_date":"string","current_check_date":"string","original_debit_date":"string","current_debit_date":"string","reason":"string"},"created_at":"2024-07-29T15:51:28.071Z","submission_blockers":[{"blocker_type":"string","blocker_name":"string","unblock_options":[{"unblock_type":"string","check_date":"string","metadata":{}}],"selected_option":"string","status":"unresolved"}],"credit_blockers":[{"blocker_type":"string","blocker_name":"string","unblock_options":[{"unblock_type":"submit_wire","check_date":"string","metadata":{"wire_in_amount":"string","wire_in_deadline":"2024-07-29T15:51:28.071Z","wire_in_request_uuid":"string"}},{"unblock_type":"submit_bank_screenshot","check_date":"string","metadata":{"information_request_uuid":"string","bank_account_last_four_digits":"string"}},{"unblock_type":"respond_to_high_risk_fraud_rfi","check_date":"string","metadata":{"information_request_uuid":"string"}},{"unblock_type":"wait_for_reverse_wire","check_date":"string","metadata":{"reverse_wire_detail_id":0,"bank_account_last_four_digits":"string"}}],"selected_option":"string","status":"unresolved"}],"reversal_payroll_uuids":["string"]} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/schemas/signatory-create-request.Schema.json b/docs/api/schemas/signatory-create-request.Schema.json new file mode 100644 index 000000000..1310f36eb --- /dev/null +++ b/docs/api/schemas/signatory-create-request.Schema.json @@ -0,0 +1 @@ +{"schema":{"type":"object","description":"Request body for creating a signatory with complete information. All listed required fields must be provided.","properties":{"first_name":{"type":"string","description":"The signatory's first name."},"last_name":{"type":"string","description":"The signatory's last name."},"title":{"type":"string","description":"The signatory's title (e.g. CEO, President)."},"phone":{"type":"string","description":"The signatory's phone number."},"birthday":{"type":"string","format":"date","description":"The signatory's date of birth."},"email":{"type":"string","format":"email","description":"The signatory's email address."},"ssn":{"type":"string","description":"The signatory's SSN."},"home_address":{"type":"object","description":"The signatory's home address.","properties":{"street_1":{"type":"string"},"street_2":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"zip":{"type":"string"},"country":{"type":"string","default":"USA"}},"required":["street_1","city","state","zip"]}},"required":["first_name","last_name","email","title","phone","birthday","ssn","home_address"],"x-tags":["Signatories"],"title":"Signatory-Create-Request"},"schemaType":"response"} \ No newline at end of file diff --git a/docs/api/schemas/signatory-create-request.schema.mdx b/docs/api/schemas/signatory-create-request.schema.mdx new file mode 100644 index 000000000..67a1c028e --- /dev/null +++ b/docs/api/schemas/signatory-create-request.schema.mdx @@ -0,0 +1,32 @@ +--- +id: signatory-create-request +title: "Signatory-Create-Request" +description: "Request body for creating a signatory with complete information. All listed required fields must be provided." +sidebar_label: "Signatory-Create-Request" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"first_name":"string","last_name":"string","title":"string","phone":"string","birthday":"2024-07-29","email":"user@example.com","ssn":"string","home_address":{"street_1":"string","street_2":"string","city":"string","state":"string","zip":"string","country":"USA"}} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + +Request body for creating a signatory with complete information. All listed required fields must be provided. + + + + + \ No newline at end of file diff --git a/docs/api/schemas/signatory-invite-request.Schema.json b/docs/api/schemas/signatory-invite-request.Schema.json new file mode 100644 index 000000000..5aa58eb93 --- /dev/null +++ b/docs/api/schemas/signatory-invite-request.Schema.json @@ -0,0 +1 @@ +{"schema":{"type":"object","description":"Request body for inviting a signatory.","properties":{"first_name":{"type":"string","description":"The signatory's first name."},"last_name":{"type":"string","description":"The signatory's last name."},"title":{"type":"string","description":"The signatory's title (e.g. CEO, President)."},"phone":{"type":"string","description":"The signatory's phone number."},"birthday":{"type":"string","format":"date","description":"The signatory's date of birth."},"email":{"type":"string","format":"email","description":"The signatory's email address."},"ssn":{"type":"string","description":"The signatory's SSN. Required for create with complete information; not used for invite."},"home_address":{"type":"object","description":"The signatory's home address.","properties":{"street_1":{"type":"string"},"street_2":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"zip":{"type":"string"},"country":{"type":"string","default":"USA"}}}},"required":["first_name","last_name","email"],"x-tags":["Signatories"],"title":"Signatory-Invite-Request"},"schemaType":"response"} \ No newline at end of file diff --git a/docs/api/schemas/signatory-invite-request.schema.mdx b/docs/api/schemas/signatory-invite-request.schema.mdx new file mode 100644 index 000000000..c4389874d --- /dev/null +++ b/docs/api/schemas/signatory-invite-request.schema.mdx @@ -0,0 +1,32 @@ +--- +id: signatory-invite-request +title: "Signatory-Invite-Request" +description: "Request body for inviting a signatory." +sidebar_label: "Signatory-Invite-Request" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"first_name":"string","last_name":"string","title":"string","phone":"string","birthday":"2024-07-29","email":"user@example.com","ssn":"string","home_address":{"street_1":"string","street_2":"string","city":"string","state":"string","zip":"string","country":"USA"}} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + +Request body for inviting a signatory. + + + + + \ No newline at end of file diff --git a/docs/api/schemas/signatory-update-request.Schema.json b/docs/api/schemas/signatory-update-request.Schema.json new file mode 100644 index 000000000..ee302ac71 --- /dev/null +++ b/docs/api/schemas/signatory-update-request.Schema.json @@ -0,0 +1 @@ +{"schema":{"type":"object","description":"Request body for updating a signatory. Email cannot be updated.","properties":{"version":{"type":"string","description":"Current version of the signatory (required for optimistic concurrency)."},"first_name":{"type":"string"},"last_name":{"type":"string"},"title":{"type":"string"},"phone":{"type":"string"},"birthday":{"type":"string","format":"date"},"ssn":{"type":"string","description":"The signatory's SSN."},"home_address":{"type":"object","properties":{"street_1":{"type":"string"},"street_2":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"zip":{"type":"string"},"country":{"type":"string"}}}},"required":["version"],"x-tags":["Signatories"],"title":"Signatory-Update-Request"},"schemaType":"response"} \ No newline at end of file diff --git a/docs/api/schemas/signatory-update-request.schema.mdx b/docs/api/schemas/signatory-update-request.schema.mdx new file mode 100644 index 000000000..d4a8f8202 --- /dev/null +++ b/docs/api/schemas/signatory-update-request.schema.mdx @@ -0,0 +1,32 @@ +--- +id: signatory-update-request +title: "Signatory-Update-Request" +description: "Request body for updating a signatory. Email cannot be updated." +sidebar_label: "Signatory-Update-Request" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"version":"string","first_name":"string","last_name":"string","title":"string","phone":"string","birthday":"2024-07-29","ssn":"string","home_address":{"street_1":"string","street_2":"string","city":"string","state":"string","zip":"string","country":"string"}} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + +Request body for updating a signatory. Email cannot be updated. + + + + + \ No newline at end of file diff --git a/docs/api/schemas/signatory.Schema.json b/docs/api/schemas/signatory.Schema.json new file mode 100644 index 000000000..5ef18550f --- /dev/null +++ b/docs/api/schemas/signatory.Schema.json @@ -0,0 +1 @@ +{"schema":{"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"}}}},"schemaType":"response"} \ No newline at end of file diff --git a/docs/api/schemas/signatory.schema.mdx b/docs/api/schemas/signatory.schema.mdx new file mode 100644 index 000000000..eef858e2d --- /dev/null +++ b/docs/api/schemas/signatory.schema.mdx @@ -0,0 +1,32 @@ +--- +id: signatory +title: "Signatory" +description: "The representation of a company's signatory" +sidebar_label: "Signatory" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"uuid":"string","first_name":"string","last_name":"string","title":"string","phone":"string","email":"string","birthday":"string","is_admin":true,"has_ssn":true,"version":"string","identity_verification_status":"Pass","home_address":"Unknown Type: object,null"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + +The representation of a company's signatory + + + + + \ No newline at end of file diff --git a/docs/api/schemas/tax-liabilities-selections.Schema.json b/docs/api/schemas/tax-liabilities-selections.Schema.json new file mode 100644 index 000000000..d9cf6e920 --- /dev/null +++ b/docs/api/schemas/tax-liabilities-selections.Schema.json @@ -0,0 +1 @@ +{"schema":{"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"}]}}},"schemaType":"response"} \ No newline at end of file diff --git a/docs/api/schemas/tax-liabilities-selections.schema.mdx b/docs/api/schemas/tax-liabilities-selections.schema.mdx new file mode 100644 index 000000000..0992e6212 --- /dev/null +++ b/docs/api/schemas/tax-liabilities-selections.schema.mdx @@ -0,0 +1,32 @@ +--- +id: tax-liabilities-selections +title: "Tax-Liabilities-Selections" +description: "The representation of tax liabilities selections." +sidebar_label: "Tax-Liabilities-Selections" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"tax_id":0,"tax_name":"string","last_unpaid_external_payroll_uuid":"string","possible_liabilities":[{"liability_amount":"string","payroll_check_date":"string","external_payroll_uuid":"string"}]} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + +The representation of tax liabilities selections. + + + + + \ No newline at end of file diff --git a/docs/api/schemas/unprocessed-termination-pay-period.Schema.json b/docs/api/schemas/unprocessed-termination-pay-period.Schema.json new file mode 100644 index 000000000..872ec2204 --- /dev/null +++ b/docs/api/schemas/unprocessed-termination-pay-period.Schema.json @@ -0,0 +1 @@ +{"schema":{"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"},"schemaType":"response"} \ No newline at end of file diff --git a/docs/api/schemas/unprocessed-termination-pay-period.schema.mdx b/docs/api/schemas/unprocessed-termination-pay-period.schema.mdx new file mode 100644 index 000000000..4cc02b5df --- /dev/null +++ b/docs/api/schemas/unprocessed-termination-pay-period.schema.mdx @@ -0,0 +1,32 @@ +--- +id: unprocessed-termination-pay-period +title: "Unprocessed-Termination-Pay-Period" +description: "The representation of an unprocessed termination pay period." +sidebar_label: "Unprocessed-Termination-Pay-Period" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"start_date":"string","end_date":"string","check_date":"string","debit_date":"string","employee_name":"string","employee_uuid":"string","pay_schedule_uuid":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + +The representation of an unprocessed termination pay period. + + + + + \ No newline at end of file diff --git a/docs/api/schemas/webhook-subscription.Schema.json b/docs/api/schemas/webhook-subscription.Schema.json new file mode 100644 index 000000000..5df0b8327 --- /dev/null +++ b/docs/api/schemas/webhook-subscription.Schema.json @@ -0,0 +1 @@ +{"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"]},"schemaType":"response"} \ No newline at end of file diff --git a/docs/api/schemas/webhook-subscription.schema.mdx b/docs/api/schemas/webhook-subscription.schema.mdx new file mode 100644 index 000000000..598b73875 --- /dev/null +++ b/docs/api/schemas/webhook-subscription.schema.mdx @@ -0,0 +1,32 @@ +--- +id: webhook-subscription +title: "Webhook-Subscription" +description: "The representation of webhook subscription." +sidebar_label: "Webhook-Subscription" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"uuid":"string","url":"string","status":"pending","subscription_types":["BankAccount"]} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + +The representation of webhook subscription. + + + + + \ No newline at end of file diff --git a/docs/api/sidebar.ts b/docs/api/sidebar.ts new file mode 100644 index 000000000..459bc71c7 --- /dev/null +++ b/docs/api/sidebar.ts @@ -0,0 +1,2608 @@ +import type { SidebarsConfig } from "@docusaurus/plugin-content-docs"; + +const sidebar: SidebarsConfig = { + apisidebar: [ + { + type: "doc", + id: "api/gusto-api", + }, + { + type: "category", + label: "Introspection", + link: { + type: "doc", + id: "api/introspection", + }, + items: [ + { + type: "doc", + id: "api/get-v-1-token-info", + label: "Get info about the current access token", + className: "api-method get", + }, + { + type: "doc", + id: "api/oauth-access-token", + label: "Create a System Access Token or Refresh an Access Token", + className: "api-method post", + }, + ], + }, + { + type: "category", + label: "Companies", + link: { + type: "doc", + id: "api/companies", + }, + items: [ + { + type: "doc", + id: "api/schemas/company", + label: "Company", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/company-onboarding-status", + label: "Company-Onboarding-Status", + className: "schema", + }, + { + type: "doc", + id: "api/post-v-1-partner-managed-companies", + label: "Create a partner managed company", + className: "api-method post", + }, + { + type: "doc", + id: "api/get-v-1-companies", + label: "Get a company", + className: "api-method get", + }, + { + type: "doc", + id: "api/put-v-1-companies", + label: "Update a company", + className: "api-method put", + }, + { + type: "doc", + id: "api/put-v-1-partner-managed-companies-company-uuid-migrate", + label: "Migrate company to embedded payroll", + className: "api-method put", + }, + { + type: "doc", + id: "api/get-v-1-partner-managed-companies-company-uuid-migration-readiness", + label: "Check company migration readiness", + className: "api-method get", + }, + { + type: "doc", + id: "api/post-partner-managed-companies-company-uuid-accept-terms-of-service", + label: "Accept terms of service for a company user", + className: "api-method post", + }, + { + type: "doc", + id: "api/post-partner-managed-companies-company-uuid-retrieve-terms-of-service", + label: "Retrieve terms of service status for a company user", + className: "api-method post", + }, + { + type: "doc", + id: "api/post-v-1-companies-company-id-admins", + label: "Create an admin for the company", + className: "api-method post", + }, + { + type: "doc", + id: "api/get-v-1-companies-company-id-admins", + label: "Get all the admins at a company", + className: "api-method get", + }, + { + type: "doc", + id: "api/get-v-1-company-onboarding-status", + label: "Get company onboarding status", + className: "api-method get", + }, + { + type: "doc", + id: "api/get-v-1-company-finish-onboarding", + label: "Finish company onboarding", + className: "api-method put", + }, + { + type: "doc", + id: "api/get-v-1-companies-company-id-custom-fields", + label: "Get the custom fields of a company", + className: "api-method get", + }, + { + type: "doc", + id: "api/get-companies-company-uuid-suspensions", + label: "Get suspensions for this company", + className: "api-method get", + }, + { + type: "doc", + id: "api/post-companies-company-uuid-suspensions", + label: "Suspend a company's account", + className: "api-method post", + }, + ], + }, + { + type: "category", + label: "Flows", + link: { + type: "doc", + id: "api/flows", + }, + items: [ + { + type: "doc", + id: "api/schemas/flow", + label: "Flow", + className: "schema", + }, + { + type: "doc", + id: "api/post-v-1-company-flows", + label: "Create a flow", + className: "api-method post", + }, + ], + }, + { + type: "category", + label: "Locations", + link: { + type: "doc", + id: "api/locations", + }, + items: [ + { + type: "doc", + id: "api/post-v-1-companies-company-id-locations", + label: "Create a company location", + className: "api-method post", + }, + { + type: "doc", + id: "api/get-v-1-companies-company-id-locations", + label: "Get all company locations", + className: "api-method get", + }, + { + type: "doc", + id: "api/get-v-1-locations-location-id", + label: "Get a location", + className: "api-method get", + }, + { + type: "doc", + id: "api/put-v-1-locations-location-id", + label: "Update a location", + className: "api-method put", + }, + { + type: "doc", + id: "api/get-v-1-locations-location-uuid-minimum-wages", + label: "Get minimum wages for a location", + className: "api-method get", + }, + ], + }, + { + type: "category", + label: "Bank Accounts", + link: { + type: "doc", + id: "api/bank-accounts", + }, + items: [ + { + type: "doc", + id: "api/get-v-1-companies-company-id-bank-accounts", + label: "Get all company bank accounts", + className: "api-method get", + }, + { + type: "doc", + id: "api/post-v-1-companies-company-id-bank-accounts", + label: "Create a company bank account", + className: "api-method post", + }, + { + type: "doc", + id: "api/put-v-1-companies-company-id-bank-accounts-verify", + label: "Verify a company bank account", + className: "api-method put", + }, + { + type: "doc", + id: "api/post-v-1-plaid-processor-token", + label: "Create a bank account from a plaid processor token", + className: "api-method post", + }, + { + type: "doc", + id: "api/delete-v-1-companies-company-id-bank-accounts-bank-account-id", + label: "Delete a company bank account", + className: "api-method delete", + }, + ], + }, + { + type: "category", + label: "Payment Configs", + link: { + type: "doc", + id: "api/payment-configs", + }, + items: [ + { + type: "doc", + id: "api/schemas/payment-configs", + label: "Payment-Configs", + className: "schema", + }, + { + type: "doc", + id: "api/get-v-1-company-payment-configs", + label: "Get a company's payment configs", + className: "api-method get", + }, + { + type: "doc", + id: "api/put-v-1-company-payment-configs", + label: "Update a company's payment configs", + className: "api-method put", + }, + ], + }, + { + type: "category", + label: "Pay Schedules", + link: { + type: "doc", + id: "api/pay-schedules", + }, + items: [ + { + type: "doc", + id: "api/schemas/pay-schedule", + label: "Pay Schedule", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/pay-schedule", + label: "Pay Schedule", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/pay-schedule-assignment", + label: "Pay-Schedule-Assignment", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/pay-schedule-assignment-employee", + label: "Pay-Schedule-Assignment-Employee", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/pay-schedule-assignment-department", + label: "Pay-Schedule-Assignment-Department", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/pay-schedule-assignment-preview", + label: "Pay-Schedule-Assignment-Preview", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/pay-schedule-assignment-employee-change", + label: "Pay-Schedule-Assignment-Employee-Change", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/pay-schedule-assignment-pay-period", + label: "Pay-Schedule-Assignment-Pay-Period", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/pay-schedule-assignment-transition-pay-period", + label: "Pay-Schedule-Assignment-Transition-Pay-Period", + className: "schema", + }, + { + type: "doc", + id: "api/post-v-1-companies-company-id-pay-schedules", + label: "Create a new pay schedule", + className: "api-method post", + }, + { + type: "doc", + id: "api/get-v-1-companies-company-id-pay-schedules", + label: "Get the pay schedules for a company", + className: "api-method get", + }, + { + type: "doc", + id: "api/get-v-1-companies-company-id-pay-schedules-preview", + label: "Preview pay schedule dates", + className: "api-method get", + }, + { + type: "doc", + id: "api/get-v-1-companies-company-id-pay-schedules-pay-schedule-id", + label: "Get a pay schedule", + className: "api-method get", + }, + { + type: "doc", + id: "api/put-v-1-companies-company-id-pay-schedules-pay-schedule-id", + label: "Update a pay schedule", + className: "api-method put", + }, + { + type: "doc", + id: "api/get-v-1-companies-company-id-unprocessed-termination-pay-periods", + label: "Get termination pay periods for a company", + className: "api-method get", + }, + { + type: "doc", + id: "api/get-v-1-companies-company-id-pay-schedules-assignments", + label: "Get pay schedule assignments for a company", + className: "api-method get", + }, + { + type: "doc", + id: "api/post-v-1-companies-company-id-pay-schedules-assignment-preview", + label: "Preview pay schedule assignments for a company", + className: "api-method post", + }, + { + type: "doc", + id: "api/post-v-1-companies-company-id-pay-schedules-assign", + label: "Assign pay schedules for a company", + className: "api-method post", + }, + ], + }, + { + type: "category", + label: "Employees", + link: { + type: "doc", + id: "api/employees", + }, + items: [ + { + type: "doc", + id: "api/get-v-1-companies-company-id-employees", + label: "Get employees of a company", + className: "api-method get", + }, + { + type: "doc", + id: "api/post-v-1-employees", + label: "Create an employee", + className: "api-method post", + }, + { + type: "doc", + id: "api/get-v-1-companies-company-id-employees-payment-details", + label: "Get employee payment details for a company", + className: "api-method get", + }, + { + type: "doc", + id: "api/post-v-1-historical-employees", + label: "Create a historical employee", + className: "api-method post", + }, + { + type: "doc", + id: "api/put-v-1-historical-employees", + label: "Update a historical employee", + className: "api-method put", + }, + { + type: "doc", + id: "api/get-v-1-employees", + label: "Get an employee", + className: "api-method get", + }, + { + type: "doc", + id: "api/put-v-1-employees", + label: "Update an employee.", + className: "api-method put", + }, + { + type: "doc", + id: "api/delete-v-1-employee", + label: "Delete an onboarding employee", + className: "api-method delete", + }, + { + type: "doc", + id: "api/get-v-1-employees-employee-id-custom-fields", + label: "Get an employee's custom fields", + className: "api-method get", + }, + { + type: "doc", + id: "api/put-v-1-employees-employee-id-onboarding-documents-config", + label: "Update employee onboarding documents config", + className: "api-method put", + }, + { + type: "doc", + id: "api/get-v-1-employees-employee-id-onboarding-status", + label: "Get the employee's onboarding status", + className: "api-method get", + }, + { + type: "doc", + id: "api/put-v-1-employees-employee-id-onboarding-status", + label: "Update the employee's onboarding status", + className: "api-method put", + }, + { + type: "doc", + id: "api/get-version-employees-time-off-activities", + label: "Get employee time off activities", + className: "api-method get", + }, + ], + }, + { + type: "category", + label: "Employee Tax Setup", + link: { + type: "doc", + id: "api/employee-tax-setup", + }, + items: [ + { + type: "doc", + id: "api/schemas/employee-federal-tax", + label: "Employee-Federal-Tax", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/employee-state-tax", + label: "Employee-State-Tax", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/employee-federal-tax-pre-2020", + label: "Employee-Federal-Tax-Pre2020", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/employee-federal-tax-rev-2020", + label: "Employee-Federal-Tax-Rev2020", + className: "schema", + }, + { + type: "doc", + id: "api/get-v-1-employees-employee-id-federal-taxes", + label: "Get federal taxes for an employee", + className: "api-method get", + }, + { + type: "doc", + id: "api/put-v-1-employees-employee-id-federal-taxes", + label: "Update federal taxes for an employee", + className: "api-method put", + }, + { + type: "doc", + id: "api/get-v-1-employees-employee-id-state-taxes", + label: "Get an employee's state taxes", + className: "api-method get", + }, + { + type: "doc", + id: "api/put-v-1-employees-employee-id-state-taxes", + label: "Update an employee's state taxes", + className: "api-method put", + }, + ], + }, + { + type: "category", + label: "Employee Payment Method", + link: { + type: "doc", + id: "api/employee-payment-method", + }, + items: [ + { + type: "doc", + id: "api/schemas/employee-bank-account", + label: "Employee-Bank-Account", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/employee-payment-method", + label: "Employee-Payment-Method", + className: "schema", + }, + { + type: "doc", + id: "api/post-v-1-employees-employee-id-bank-accounts", + label: "Create an employee bank account", + className: "api-method post", + }, + { + type: "doc", + id: "api/get-v-1-employees-employee-id-bank-accounts", + label: "Get all employee bank accounts", + className: "api-method get", + }, + { + type: "doc", + id: "api/delete-v-1-employees-employee-id-bank-accounts-bank-account-id", + label: "Delete an employee bank account", + className: "api-method delete", + }, + { + type: "doc", + id: "api/put-v-1-employees-employee-id-bank-accounts", + label: "Update an employee bank account", + className: "api-method put", + }, + { + type: "doc", + id: "api/get-v-1-employees-employee-id-payment-method", + label: "Get payment method for an employee", + className: "api-method get", + }, + { + type: "doc", + id: "api/put-v-1-employees-employee-id-payment-method", + label: "Update payment method for an employee", + className: "api-method put", + }, + ], + }, + { + type: "category", + label: "Employee Employments", + link: { + type: "doc", + id: "api/employee-employments", + }, + items: [ + { + type: "doc", + id: "api/schemas/unprocessed-termination-pay-period", + label: "Unprocessed-Termination-Pay-Period", + className: "schema", + }, + { + type: "doc", + id: "api/post-v-1-employees-employee-id-terminations", + label: "Create an employee termination", + className: "api-method post", + }, + { + type: "doc", + id: "api/get-v-1-employees-employee-id-terminations", + label: "Get terminations for an employee", + className: "api-method get", + }, + { + type: "doc", + id: "api/delete-v-1-employees-employee-id-terminations", + label: "Delete an employee termination", + className: "api-method delete", + }, + { + type: "doc", + id: "api/put-v-1-terminations-employee-id", + label: "Update an employee termination", + className: "api-method put", + }, + { + type: "doc", + id: "api/post-v-1-employees-employee-id-rehire", + label: "Create an employee rehire", + className: "api-method post", + }, + { + type: "doc", + id: "api/put-v-1-employees-employee-id-rehire", + label: "Update an employee rehire", + className: "api-method put", + }, + { + type: "doc", + id: "api/get-v-1-employees-employee-id-rehire", + label: "Get an employee rehire", + className: "api-method get", + }, + { + type: "doc", + id: "api/delete-v-1-employees-employee-id-rehire", + label: "Delete an employee rehire", + className: "api-method delete", + }, + { + type: "doc", + id: "api/get-v-1-employees-employee-id-employment-history", + label: "Get employment history for an employee", + className: "api-method get", + }, + ], + }, + { + type: "category", + label: "Employee Addresses", + link: { + type: "doc", + id: "api/employee-addresses", + }, + items: [ + { + type: "doc", + id: "api/get-v-1-employees-employee-id-home-addresses", + label: "Get an employee's home addresses", + className: "api-method get", + }, + { + type: "doc", + id: "api/post-v-1-employees-employee-id-home-addresses", + label: "Create an employee's home address", + className: "api-method post", + }, + { + type: "doc", + id: "api/get-v-1-home-addresses-home-address-uuid", + label: "Get an employee's home address", + className: "api-method get", + }, + { + type: "doc", + id: "api/put-v-1-home-addresses-home-address-uuid", + label: "Update an employee's home address", + className: "api-method put", + }, + { + type: "doc", + id: "api/delete-v-1-home-addresses-home-address-uuid", + label: "Delete an employee's home address", + className: "api-method delete", + }, + { + type: "doc", + id: "api/get-v-1-employees-employee-id-work-addresses", + label: "Get an employee's work addresses", + className: "api-method get", + }, + { + type: "doc", + id: "api/post-v-1-employees-employee-id-work-addresses", + label: "Create an employee work address", + className: "api-method post", + }, + { + type: "doc", + id: "api/get-v-1-work-addresses-work-address-uuid", + label: "Get an employee work address", + className: "api-method get", + }, + { + type: "doc", + id: "api/put-v-1-work-addresses-work-address-uuid", + label: "Update an employee work address", + className: "api-method put", + }, + { + type: "doc", + id: "api/delete-v-1-work-addresses-work-address-uuid", + label: "Delete an employee's work address", + className: "api-method delete", + }, + ], + }, + { + type: "category", + label: "Jobs and Compensations", + link: { + type: "doc", + id: "api/jobs-and-compensations", + }, + items: [ + { + type: "doc", + id: "api/post-v-1-jobs-job-id", + label: "Create a job", + className: "api-method post", + }, + { + type: "doc", + id: "api/get-v-1-employees-employee-id-jobs", + label: "Get jobs for an employee", + className: "api-method get", + }, + { + type: "doc", + id: "api/get-v-1-jobs-job-id", + label: "Get a job", + className: "api-method get", + }, + { + type: "doc", + id: "api/put-v-1-jobs-job-id", + label: "Update a job", + className: "api-method put", + }, + { + type: "doc", + id: "api/delete-v-1-jobs-job-id", + label: "Delete an individual job", + className: "api-method delete", + }, + { + type: "doc", + id: "api/get-v-1-jobs-job-id-compensations", + label: "Get compensations for a job", + className: "api-method get", + }, + { + type: "doc", + id: "api/post-v-1-compensations-compensation-id", + label: "Create a compensation", + className: "api-method post", + }, + { + type: "doc", + id: "api/get-v-1-compensations-compensation-id", + label: "Get a compensation", + className: "api-method get", + }, + { + type: "doc", + id: "api/put-v-1-compensations-compensation-id", + label: "Update a compensation", + className: "api-method put", + }, + { + type: "doc", + id: "api/delete-v-1-compensations-compensation-id", + label: "Delete a compensation", + className: "api-method delete", + }, + ], + }, + { + type: "category", + label: "Earning Types", + link: { + type: "doc", + id: "api/earning-types", + }, + items: [ + { + type: "doc", + id: "api/schemas/earning-type", + label: "Earning-Type", + className: "schema", + }, + { + type: "doc", + id: "api/post-v-1-companies-company-id-earning-types", + label: "Create a custom earning type", + className: "api-method post", + }, + { + type: "doc", + id: "api/get-v-1-companies-company-id-earning-types", + label: "Get all earning types for a company", + className: "api-method get", + }, + { + type: "doc", + id: "api/put-v-1-companies-company-id-earning-types-earning-type-uuid", + label: "Update an earning type", + className: "api-method put", + }, + { + type: "doc", + id: "api/delete-v-1-companies-company-id-earning-types-earning-type-uuid", + label: "Deactivate an earning type", + className: "api-method delete", + }, + ], + }, + { + type: "category", + label: "I-9 Verification", + link: { + type: "doc", + id: "api/i-9-verification", + }, + items: [ + { + type: "doc", + id: "api/schemas/i-9-authorization", + label: "I9-Authorization", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/i-9-authorization-document", + label: "I9-Authorization-Document", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/i-9-authorization-document-option", + label: "I9-Authorization-Document-Option", + className: "schema", + }, + { + type: "doc", + id: "api/get-v-1-employees-employee-id-i-9-authorization", + label: "Get an employee's I-9 authorization", + className: "api-method get", + }, + { + type: "doc", + id: "api/put-v-1-employees-employee-id-i-9-authorization", + label: "Create or update an employee's I-9 authorization", + className: "api-method put", + }, + { + type: "doc", + id: "api/get-v-1-employees-employee-id-i-9-authorization-document-options", + label: "Get an employee's I-9 verification document options", + className: "api-method get", + }, + { + type: "doc", + id: "api/get-v-1-employees-employee-id-i-9-authorization-documents", + label: "Get an employee's I-9 verification documents", + className: "api-method get", + }, + { + type: "doc", + id: "api/put-v-1-employees-employee-id-i-9-authorization-documents", + label: "Create an employee's I-9 authorization verification documents", + className: "api-method put", + }, + { + type: "doc", + id: "api/delete-v-1-employees-employee-id-i-9-authorization-documents-document-id", + label: "Delete an employee's I-9 verification document", + className: "api-method delete", + }, + { + type: "doc", + id: "api/put-v-1-employees-employee-id-i-9-authorization-employer-sign", + label: "Employer sign an employee's Form I-9", + className: "api-method put", + }, + ], + }, + { + type: "category", + label: "Contractor Payment Groups", + link: { + type: "doc", + id: "api/contractor-payment-groups", + }, + items: [ + { + type: "doc", + id: "api/schemas/contractor-payment-group", + label: "Contractor-Payment-Group", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/contractor-payment-group-minimal", + label: "Contractor-Payment-Group-Minimal", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/contractor-payment-for-group", + label: "Contractor-Payment-For-Group", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/contractor-payment-for-group-preview", + label: "Contractor-Payment-For-Group-Preview", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/contractor-payment-group-with-blockers", + label: "Contractor-Payment-Group-With-Blockers", + className: "schema", + }, + { + type: "doc", + id: "api/get-v-1-companies-company-id-contractor-payment-groups", + label: "Get contractor payment groups for a company", + className: "api-method get", + }, + { + type: "doc", + id: "api/post-v-1-companies-company-id-contractor-payment-groups", + label: "Create a contractor payment group", + className: "api-method post", + }, + { + type: "doc", + id: "api/post-v-1-companies-company-id-contractor-payment-groups-preview", + label: "Preview a contractor payment group", + className: "api-method post", + }, + { + type: "doc", + id: "api/get-v-1-contractor-payment-groups-contractor-payment-group-id", + label: "Get a contractor payment group", + className: "api-method get", + }, + { + type: "doc", + id: "api/delete-v-1-contractor-payment-groups-contractor-payment-group-id", + label: "Cancel a contractor payment group", + className: "api-method delete", + }, + { + type: "doc", + id: "api/put-v-1-contractor-payment-groups-contractor-payment-group-id-fund", + label: "Fund a contractor payment group [DEMO]", + className: "api-method put", + }, + { + type: "doc", + id: "api/get-v-1-contractor-payment-groups-id-partner-disbursements", + label: "Get partner disbursements for a contractor payment group", + className: "api-method get", + }, + { + type: "doc", + id: "api/patch-v-1-contractor-payment-groups-id-partner-disbursements", + label: "Update partner disbursements for a contractor payment group", + className: "api-method patch", + }, + ], + }, + { + type: "category", + label: "Contractor Payment Method", + link: { + type: "doc", + id: "api/contractor-payment-method", + }, + items: [ + { + type: "doc", + id: "api/schemas/contractor-payment-method", + label: "Contractor-Payment-Method", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/contractor-bank-account", + label: "Contractor-Bank-Account", + className: "schema", + }, + { + type: "doc", + id: "api/post-v-1-contractors-contractor-uuid-bank-accounts", + label: "Create a contractor bank account", + className: "api-method post", + }, + { + type: "doc", + id: "api/get-v-1-contractors-contractor-uuid-bank-accounts", + label: "Get all contractor bank accounts", + className: "api-method get", + }, + { + type: "doc", + id: "api/get-v-1-contractors-contractor-uuid-payment-method", + label: "Get a contractor's payment method", + className: "api-method get", + }, + { + type: "doc", + id: "api/put-v-1-contractors-contractor-id-payment-method", + label: "Update a contractor's payment method", + className: "api-method put", + }, + ], + }, + { + type: "category", + label: "Contractor Payments", + link: { + type: "doc", + id: "api/contractor-payments", + }, + items: [ + { + type: "doc", + id: "api/schemas/contractor-payment", + label: "Contractor Payment", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/contractor-payment-summary", + label: "Contractor-Payment-Summary", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/contractor-payment-summary-by-dates", + label: "Contractor-Payment-Summary-By-Dates", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/contractor-payment-body", + label: "Contractor-Payment-Body", + className: "schema", + }, + { + type: "doc", + id: "api/get-v-1-contractor-payments-contractor-payment-uuid-receipt", + label: "Get a single contractor payment receipt", + className: "api-method get", + }, + { + type: "doc", + id: "api/get-v-1-contractor-payments-contractor-payment-uuid-fund", + label: "Fund a contractor payment [DEMO]", + className: "api-method put", + }, + { + type: "doc", + id: "api/post-v-1-companies-company-id-contractor-payments", + label: "Create a contractor payment", + className: "api-method post", + }, + { + type: "doc", + id: "api/get-v-1-companies-company-id-contractor-payments", + label: "Get contractor payments for a company", + className: "api-method get", + }, + { + type: "doc", + id: "api/get-v-1-companies-company-id-contractor-payment-contractor-payment", + label: "Get a single contractor payment", + className: "api-method get", + }, + { + type: "doc", + id: "api/delete-v-1-companies-company-id-contractor-payment-contractor-payment", + label: "Cancel a contractor payment", + className: "api-method delete", + }, + { + type: "doc", + id: "api/get-companies-company-uuid-contractor-payments-preview", + label: "Preview contractor payment debit date", + className: "api-method get", + }, + ], + }, + { + type: "category", + label: "Contractors", + link: { + type: "doc", + id: "api/contractors", + }, + items: [ + { + type: "doc", + id: "api/schemas/contractor", + label: "Contractor", + className: "schema", + }, + { + type: "doc", + id: "api/post-v-1-companies-company-uuid-contractors", + label: "Create a contractor", + className: "api-method post", + }, + { + type: "doc", + id: "api/get-v-1-companies-company-uuid-contractors", + label: "Get contractors of a company", + className: "api-method get", + }, + { + type: "doc", + id: "api/get-v-1-contractors-contractor-uuid", + label: "Get a contractor", + className: "api-method get", + }, + { + type: "doc", + id: "api/put-v-1-contractors-contractor-uuid", + label: "Update a contractor", + className: "api-method put", + }, + { + type: "doc", + id: "api/delete-v-1-contractors-contractor-uuid", + label: "Delete a contractor", + className: "api-method delete", + }, + { + type: "doc", + id: "api/get-v-1-contractors-contractor-uuid-onboarding-status", + label: "Get the contractor's onboarding status", + className: "api-method get", + }, + { + type: "doc", + id: "api/put-v-1-contractors-contractor-uuid-onboarding-status", + label: "Change the contractor's onboarding status", + className: "api-method put", + }, + { + type: "doc", + id: "api/get-v-1-contractors-contractor-uuid-address", + label: "Get a contractor address", + className: "api-method get", + }, + { + type: "doc", + id: "api/put-v-1-contractors-contractor-uuid-address", + label: "Create or update a contractor's address", + className: "api-method put", + }, + { + type: "doc", + id: "api/get-v-1-companies-company-id-contractors-payment-details", + label: "List contractor payment details", + className: "api-method get", + }, + ], + }, + { + type: "category", + label: "Payrolls", + link: { + type: "doc", + id: "api/payrolls", + }, + items: [ + { + type: "doc", + id: "api/schemas/employee-pay-stub", + label: "Employee-Pay-Stub", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/pay-period", + label: "Pay-Period", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/payroll-minimal", + label: "Payroll-Minimal", + className: "schema", + }, + { + type: "doc", + id: "api/get-v-1-companies-company-id-pay-periods", + label: "Get pay periods for a company", + className: "api-method get", + }, + { + type: "doc", + id: "api/get-v-1-companies-company-id-payrolls", + label: "Get all payrolls for a company", + className: "api-method get", + }, + { + type: "doc", + id: "api/post-v-1-companies-company-id-payrolls", + label: "Create an off-cycle payroll", + className: "api-method post", + }, + { + type: "doc", + id: "api/get-v-1-companies-company-id-payroll-reversals", + label: "Get approved payroll reversals", + className: "api-method get", + }, + { + type: "doc", + id: "api/get-v-1-companies-company-id-payrolls-payroll-id", + label: "Get a single payroll", + className: "api-method get", + }, + { + type: "doc", + id: "api/put-v-1-companies-company-id-payrolls", + label: "Update a payroll by ID", + className: "api-method put", + }, + { + type: "doc", + id: "api/delete-v-1-companies-company-id-payrolls", + label: "Delete a payroll", + className: "api-method delete", + }, + { + type: "doc", + id: "api/put-v-1-companies-company-id-payrolls-payroll-id-prepare", + label: "Prepare a payroll for update", + className: "api-method put", + }, + { + type: "doc", + id: "api/get-v-1-payment-receipts-payrolls-payroll-uuid", + label: "Get a single payroll receipt", + className: "api-method get", + }, + { + type: "doc", + id: "api/get-v-1-companies-payroll-blockers-company-uuid", + label: "Get all payroll blockers for a company", + className: "api-method get", + }, + { + type: "doc", + id: "api/post-companies-payroll-skip-company-uuid", + label: "Skip a payroll", + className: "api-method post", + }, + { + type: "doc", + id: "api/post-payrolls-gross-up-payroll-uuid", + label: "Calculate gross up for a payroll", + className: "api-method post", + }, + { + type: "doc", + id: "api/put-v-1-companies-company-id-payrolls-payroll-id-calculate", + label: "Calculate a payroll", + className: "api-method put", + }, + { + type: "doc", + id: "api/put-v-1-companies-company-id-payrolls-payroll-id-submit", + label: "Submit payroll", + className: "api-method put", + }, + { + type: "doc", + id: "api/put-api-v-1-companies-company-id-payrolls-payroll-id-cancel", + label: "Cancel a payroll", + className: "api-method put", + }, + { + type: "doc", + id: "api/get-v-1-payrolls-payroll-uuid-employees-employee-uuid-pay-stub", + label: "Get an employee pay stub (pdf)", + className: "api-method get", + }, + { + type: "doc", + id: "api/get-v-1-employees-employee-uuid-pay-stubs", + label: "Get an employee's pay stubs", + className: "api-method get", + }, + { + type: "doc", + id: "api/post-v-1-payrolls-payroll-uuid-generated-documents-printable-payroll-checks", + label: "Generate printable payroll checks (pdf)", + className: "api-method post", + }, + { + type: "doc", + id: "api/get-v-1-companies-company-id-payrolls-id-partner-disbursements", + label: "Get partner disbursements for a payroll", + className: "api-method get", + }, + { + type: "doc", + id: "api/patch-v-1-companies-company-id-payrolls-id-partner-disbursements", + label: "Update partner disbursements for a payroll", + className: "api-method patch", + }, + ], + }, + { + type: "category", + label: "Company Forms", + link: { + type: "doc", + id: "api/company-forms", + }, + items: [ + { + type: "doc", + id: "api/get-v-1-company-forms", + label: "Get all company forms", + className: "api-method get", + }, + { + type: "doc", + id: "api/get-v-1-company-form", + label: "Get a company form", + className: "api-method get", + }, + { + type: "doc", + id: "api/get-v-1-company-form-pdf", + label: "Get a company form pdf", + className: "api-method get", + }, + { + type: "doc", + id: "api/put-v-1-company-form-sign", + label: "Sign a company form", + className: "api-method put", + }, + ], + }, + { + type: "category", + label: "Contractor Documents", + link: { + type: "doc", + id: "api/contractor-documents", + }, + items: [ + { + type: "doc", + id: "api/get-v-1-contractor-documents", + label: "Get all contractor documents", + className: "api-method get", + }, + { + type: "doc", + id: "api/get-v-1-contractor-document", + label: "Get a contractor document", + className: "api-method get", + }, + { + type: "doc", + id: "api/get-v-1-contractor-document-pdf", + label: "Get the contractor document pdf", + className: "api-method get", + }, + { + type: "doc", + id: "api/put-v-1-contractor-document-sign", + label: "Sign a contractor document", + className: "api-method put", + }, + ], + }, + { + type: "category", + label: "Employee Forms", + link: { + type: "doc", + id: "api/employee-forms", + }, + items: [ + { + type: "doc", + id: "api/post-v-1-sandbox-generate-w-2", + label: "Generate a W2 form [DEMO]", + className: "api-method post", + }, + { + type: "doc", + id: "api/get-v-1-employee-forms", + label: "Get all employee forms", + className: "api-method get", + }, + { + type: "doc", + id: "api/get-v-1-employee-form", + label: "Get an employee form", + className: "api-method get", + }, + { + type: "doc", + id: "api/get-v-1-employee-form-pdf", + label: "Get the employee form pdf", + className: "api-method get", + }, + { + type: "doc", + id: "api/put-v-1-employee-form-sign", + label: "Sign an employee form", + className: "api-method put", + }, + ], + }, + { + type: "category", + label: "Company Benefits", + link: { + type: "doc", + id: "api/company-benefits", + }, + items: [ + { + type: "doc", + id: "api/schemas/benefit-type-requirements", + label: "Benefit-Type-Requirements", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/benefit-summary", + label: "Benefit-Summary", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/contribution-exclusion", + label: "Contribution-Exclusion", + className: "schema", + }, + { + type: "doc", + id: "api/post-v-1-companies-company-id-company-benefits", + label: "Create a company benefit", + className: "api-method post", + }, + { + type: "doc", + id: "api/get-v-1-companies-company-id-company-benefits", + label: "Get benefits for a company", + className: "api-method get", + }, + { + type: "doc", + id: "api/get-v-1-company-benefits-company-benefit-id", + label: "Get a company benefit", + className: "api-method get", + }, + { + type: "doc", + id: "api/put-v-1-company-benefits-company-benefit-id", + label: "Update a company benefit", + className: "api-method put", + }, + { + type: "doc", + id: "api/delete-v-1-company-benefits-company-benefit-id", + label: "Delete a company benefit", + className: "api-method delete", + }, + { + type: "doc", + id: "api/get-v-1-benefits", + label: "Get all benefits supported by Gusto", + className: "api-method get", + }, + { + type: "doc", + id: "api/get-v-1-benefits-benefit-id", + label: "Get a supported benefit by ID", + className: "api-method get", + }, + { + type: "doc", + id: "api/get-v-1-benefits-company-benefit-id-summary", + label: "Get company benefit summary by company benefit id.", + className: "api-method get", + }, + { + type: "doc", + id: "api/get-v-1-company-benefits-company-benefit-id-employee-benefits", + label: "Get all employee benefits for a company benefit", + className: "api-method get", + }, + { + type: "doc", + id: "api/put-v-1-company-benefits-company-benefit-id-employee-benefits", + label: "Bulk update employee benefits for a company benefit", + className: "api-method put", + }, + { + type: "doc", + id: "api/get-v-1-company-benefits-company-benefit-id-contribution-exclusions", + label: "Get contribution exclusions for a company benefit", + className: "api-method get", + }, + { + type: "doc", + id: "api/put-v-1-company-benefits-company-benefit-id-contribution-exclusions", + label: "Update contribution exclusions for a company benefit", + className: "api-method put", + }, + { + type: "doc", + id: "api/get-v-1-benefits-benefits-id-requirements", + label: "Get benefit fields requirements by ID", + className: "api-method get", + }, + ], + }, + { + type: "category", + label: "Employee Benefits", + link: { + type: "doc", + id: "api/employee-benefits", + }, + items: [ + { + type: "doc", + id: "api/post-v-1-employees-employee-id-employee-benefits", + label: "Create an employee benefit", + className: "api-method post", + }, + { + type: "doc", + id: "api/get-v-1-employees-employee-id-employee-benefits", + label: "Get all benefits for an employee", + className: "api-method get", + }, + { + type: "doc", + id: "api/get-v-1-employee-benefits-employee-benefit-id", + label: "Get an employee benefit", + className: "api-method get", + }, + { + type: "doc", + id: "api/put-v-1-employee-benefits-employee-benefit-id", + label: "Update an employee benefit", + className: "api-method put", + }, + { + type: "doc", + id: "api/delete-v-1-employee-benefits-employee-benefit-id", + label: "Delete an employee benefit", + className: "api-method delete", + }, + { + type: "doc", + id: "api/get-employee-ytd-benefit-amounts-from-different-company", + label: "Get year-to-date benefit amounts from a different company", + className: "api-method get", + }, + { + type: "doc", + id: "api/post-employee-ytd-benefit-amounts-from-different-company", + label: "Create year-to-date benefit amounts from a different company", + className: "api-method post", + }, + { + type: "doc", + id: "api/get-v-1-employees-employee-uuid-section-603-high-earner-statuses", + label: "Get all Section 603 high earner statuses for an employee", + className: "api-method get", + }, + { + type: "doc", + id: "api/post-v-1-employees-employee-uuid-section-603-high-earner-statuses", + label: "Create a Section 603 high earner status", + className: "api-method post", + }, + { + type: "doc", + id: "api/get-v-1-employees-employee-uuid-section-603-high-earner-statuses-effective-year", + label: "Get a Section 603 high earner status for a specific year", + className: "api-method get", + }, + { + type: "doc", + id: "api/patch-v-1-employees-employee-uuid-section-603-high-earner-statuses-effective-year", + label: "Update a Section 603 high earner status", + className: "api-method patch", + }, + ], + }, + { + type: "category", + label: "Garnishments", + link: { + type: "doc", + id: "api/garnishments", + }, + items: [ + { + type: "doc", + id: "api/post-v-1-employees-employee-id-garnishments", + label: "Create a garnishment", + className: "api-method post", + }, + { + type: "doc", + id: "api/get-v-1-employees-employee-id-garnishments", + label: "Get garnishments for an employee", + className: "api-method get", + }, + { + type: "doc", + id: "api/get-v-1-garnishments-garnishment-id", + label: "Get a garnishment", + className: "api-method get", + }, + { + type: "doc", + id: "api/put-v-1-garnishments-garnishment-id", + label: "Update a garnishment", + className: "api-method put", + }, + { + type: "doc", + id: "api/get-v-1-garnishments-child-support", + label: "Get child support garnishment data", + className: "api-method get", + }, + ], + }, + { + type: "category", + label: "Federal Tax Details", + link: { + type: "doc", + id: "api/federal-tax-details", + }, + items: [ + { + type: "doc", + id: "api/schemas/federal-tax-details", + label: "Federal-Tax-Details", + className: "schema", + }, + { + type: "doc", + id: "api/get-v-1-companies-company-id-federal-tax-details", + label: "Get Federal Tax Details", + className: "api-method get", + }, + { + type: "doc", + id: "api/put-v-1-companies-company-id-federal-tax-details", + label: "Update Federal Tax Details", + className: "api-method put", + }, + ], + }, + { + type: "category", + label: "Industry Selection", + link: { + type: "doc", + id: "api/industry-selection", + }, + items: [ + { + type: "doc", + id: "api/get-v-1-company-industry", + label: "Get a company industry selection", + className: "api-method get", + }, + { + type: "doc", + id: "api/put-v-1-company-industry", + label: "Update a company industry selection", + className: "api-method put", + }, + ], + }, + { + type: "category", + label: "Signatories", + link: { + type: "doc", + id: "api/signatories", + }, + items: [ + { + type: "doc", + id: "api/schemas/signatory", + label: "Signatory", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/signatory-invite-request", + label: "Signatory-Invite-Request", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/signatory-create-request", + label: "Signatory-Create-Request", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/signatory-update-request", + label: "Signatory-Update-Request", + className: "schema", + }, + { + type: "doc", + id: "api/post-v-1-company-signatories", + label: "Create a signatory", + className: "api-method post", + }, + { + type: "doc", + id: "api/get-v-1-companies-company-uuid-signatories", + label: "Get the signatories for a company", + className: "api-method get", + }, + { + type: "doc", + id: "api/post-v-1-companies-company-uuid-signatories-invite", + label: "Invite a signatory", + className: "api-method post", + }, + { + type: "doc", + id: "api/put-v-1-companies-company-uuid-signatories-signatory-uuid", + label: "Update a signatory", + className: "api-method put", + }, + { + type: "doc", + id: "api/delete-v-1-companies-company-uuid-signatories-signatory-uuid", + label: "Delete a signatory", + className: "api-method delete", + }, + ], + }, + { + type: "category", + label: "External Payrolls", + link: { + type: "doc", + id: "api/external-payrolls", + }, + items: [ + { + type: "doc", + id: "api/schemas/external-payroll", + label: "External-Payroll", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/external-payroll-basic", + label: "External-Payroll-Basic", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/external-payroll-tax-suggestions", + label: "External-Payroll-Tax-Suggestions", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/tax-liabilities-selections", + label: "Tax-Liabilities-Selections", + className: "schema", + }, + { + type: "doc", + id: "api/post-v-1-external-payroll", + label: "Create a new external payroll for a company", + className: "api-method post", + }, + { + type: "doc", + id: "api/get-v-1-company-external-payrolls", + label: "Get external payrolls for a company", + className: "api-method get", + }, + { + type: "doc", + id: "api/get-v-1-external-payroll", + label: "Get an external payroll", + className: "api-method get", + }, + { + type: "doc", + id: "api/delete-v-1-external-payroll", + label: "Delete an external payroll", + className: "api-method delete", + }, + { + type: "doc", + id: "api/put-v-1-external-payroll", + label: "Update an external payroll", + className: "api-method put", + }, + { + type: "doc", + id: "api/get-v-1-external-payroll-calculate-taxes", + label: "Get tax suggestions for an external payroll", + className: "api-method get", + }, + { + type: "doc", + id: "api/get-v-1-tax-liabilities", + label: "Get tax liabilities", + className: "api-method get", + }, + { + type: "doc", + id: "api/put-v-1-tax-liabilities", + label: "Update tax liabilities", + className: "api-method put", + }, + { + type: "doc", + id: "api/put-v-1-tax-liabilities-finish", + label: "Finalize tax liabilities options and convert into processed payrolls", + className: "api-method put", + }, + ], + }, + { + type: "category", + label: "Tax Requirements", + link: { + type: "doc", + id: "api/tax-requirements", + }, + items: [ + { + type: "doc", + id: "api/get-v-1-companies-company-uuid-tax-requirements-state", + label: "Get State Tax Requirements", + className: "api-method get", + }, + { + type: "doc", + id: "api/put-v-1-companies-company-uuid-tax-requirements-state", + label: "Update State Tax Requirements", + className: "api-method put", + }, + { + type: "doc", + id: "api/get-v-1-companies-company-uuid-tax-requirements", + label: "Get All Tax Requirement States", + className: "api-method get", + }, + ], + }, + { + type: "category", + label: "Contractor Forms", + link: { + type: "doc", + id: "api/contractor-forms", + }, + items: [ + { + type: "doc", + id: "api/get-v-1-contractor-forms", + label: "Get all contractor forms", + className: "api-method get", + }, + { + type: "doc", + id: "api/get-v-1-contractor-form", + label: "Get a contractor form", + className: "api-method get", + }, + { + type: "doc", + id: "api/get-v-1-contractor-form-pdf", + label: "Get the contractor form pdf", + className: "api-method get", + }, + { + type: "doc", + id: "api/post-v-1-sandbox-generate-1099", + label: "Generate a 1099 form [DEMO]", + className: "api-method post", + }, + ], + }, + { + type: "category", + label: "Time Off Policies", + link: { + type: "doc", + id: "api/time-off-policies", + }, + items: [ + { + type: "doc", + id: "api/post-v-1-payrolls-payroll-id-calculate-accruing-time-off-hours", + label: "Calculate accruing time off hours", + className: "api-method post", + }, + { + type: "doc", + id: "api/get-v-1-time-off-policies-time-off-policy-uuid", + label: "Get a time off policy", + className: "api-method get", + }, + { + type: "doc", + id: "api/put-v-1-time-off-policies-time-off-policy-uuid", + label: "Update a time off policy", + className: "api-method put", + }, + { + type: "doc", + id: "api/get-v-1-companies-company-uuid-time-off-policies", + label: "Get all time off policies for a company", + className: "api-method get", + }, + { + type: "doc", + id: "api/post-v-1-companies-company-uuid-time-off-policies", + label: "Create a time off policy", + className: "api-method post", + }, + { + type: "doc", + id: "api/put-v-1-time-off-policies-time-off-policy-uuid-add-employees", + label: "Add employees to a time off policy", + className: "api-method put", + }, + { + type: "doc", + id: "api/put-v-1-time-off-policies-time-off-policy-uuid-remove-employees", + label: "Remove employees from a time off policy", + className: "api-method put", + }, + { + type: "doc", + id: "api/put-v-1-time-off-policies-time-off-policy-uuid-balance", + label: "Update employee time off balances", + className: "api-method put", + }, + { + type: "doc", + id: "api/put-v-1-time-off-policies-time-off-policy-uuid-deactivate", + label: "Deactivate a time off policy", + className: "api-method put", + }, + ], + }, + { + type: "category", + label: "Holiday Pay Policies", + link: { + type: "doc", + id: "api/holiday-pay-policies", + }, + items: [ + { + type: "doc", + id: "api/get-v-1-companies-company-uuid-holiday-pay-policy", + label: "Get a company's holiday pay policy", + className: "api-method get", + }, + { + type: "doc", + id: "api/post-v-1-companies-company-uuid-holiday-pay-policy", + label: "Create a holiday pay policy for a company", + className: "api-method post", + }, + { + type: "doc", + id: "api/put-v-1-companies-company-uuid-holiday-pay-policy", + label: "Update a company's holiday pay policy", + className: "api-method put", + }, + { + type: "doc", + id: "api/delete-v-1-companies-company-uuid-holiday-pay-policy", + label: "Delete a company's holiday pay policy", + className: "api-method delete", + }, + { + type: "doc", + id: "api/put-v-1-companies-company-uuid-holiday-pay-policy-add", + label: "Add employees to a company's holiday pay policy", + className: "api-method put", + }, + { + type: "doc", + id: "api/put-v-1-companies-company-uuid-holiday-pay-policy-remove", + label: "Remove employees from a company's holiday pay policy", + className: "api-method put", + }, + { + type: "doc", + id: "api/get-companies-company-uuid-paid-holidays", + label: "Preview a company's paid holidays", + className: "api-method get", + }, + ], + }, + { + type: "category", + label: "Departments", + link: { + type: "doc", + id: "api/departments", + }, + items: [ + { + type: "doc", + id: "api/post-departments", + label: "Create a department", + className: "api-method post", + }, + { + type: "doc", + id: "api/get-companies-departments", + label: "Get all departments of a company", + className: "api-method get", + }, + { + type: "doc", + id: "api/get-department", + label: "Get a department", + className: "api-method get", + }, + { + type: "doc", + id: "api/put-departments", + label: "Update a department", + className: "api-method put", + }, + { + type: "doc", + id: "api/delete-department", + label: "Delete a department", + className: "api-method delete", + }, + { + type: "doc", + id: "api/put-add-people-to-department", + label: "Add people to a department", + className: "api-method put", + }, + { + type: "doc", + id: "api/put-remove-people-from-department", + label: "Remove people from a department", + className: "api-method put", + }, + ], + }, + { + type: "category", + label: "Reports", + link: { + type: "doc", + id: "api/reports", + }, + items: [ + { + type: "doc", + id: "api/post-companies-company-uuid-reports", + label: "Create a custom report", + className: "api-method post", + }, + { + type: "doc", + id: "api/post-payrolls-payroll-uuid-reports-general-ledger", + label: "Create a general ledger report", + className: "api-method post", + }, + { + type: "doc", + id: "api/get-reports-request-uuid", + label: "Get a report", + className: "api-method get", + }, + { + type: "doc", + id: "api/get-companies-company-uuid-report-templates-report-type", + label: "Get a report template", + className: "api-method get", + }, + { + type: "doc", + id: "api/post-v-1-companies-company-id-reports-employees-annual-fica-wage", + label: "Create an employees annual FICA wage report", + className: "api-method post", + }, + ], + }, + { + type: "category", + label: "Generated Documents", + link: { + type: "doc", + id: "api/generated-documents", + }, + items: [ + { + type: "doc", + id: "api/get-v-1-generated-documents-document-type-request-uuid", + label: "Get a generated document", + className: "api-method get", + }, + ], + }, + { + type: "category", + label: "Notifications", + link: { + type: "doc", + id: "api/notifications", + }, + items: [ + { + type: "doc", + id: "api/get-notifications-notification-uuid", + label: "Get a notification's details", + className: "api-method get", + }, + { + type: "doc", + id: "api/get-company-notifications", + label: "Get notifications for company", + className: "api-method get", + }, + ], + }, + { + type: "category", + label: "Webhooks", + link: { + type: "doc", + id: "api/webhooks", + }, + items: [ + { + type: "doc", + id: "api/schemas/webhook-subscription", + label: "Webhook-Subscription", + className: "schema", + }, + { + type: "doc", + id: "api/post-v-1-webhook-subscription", + label: "Create a webhook subscription", + className: "api-method post", + }, + { + type: "doc", + id: "api/get-v-1-webhook-subscriptions", + label: "List webhook subscriptions", + className: "api-method get", + }, + { + type: "doc", + id: "api/put-v-1-webhook-subscription-uuid", + label: "Update a webhook subscription", + className: "api-method put", + }, + { + type: "doc", + id: "api/get-v-1-webhook-subscription-uuid", + label: "Get a webhook subscription", + className: "api-method get", + }, + { + type: "doc", + id: "api/delete-v-1-webhook-subscription-uuid", + label: "Delete a webhook subscription", + className: "api-method delete", + }, + { + type: "doc", + id: "api/put-v-1-verify-webhook-subscription-uuid", + label: "Verify the webhook subscription", + className: "api-method put", + }, + { + type: "doc", + id: "api/get-v-1-webhook-subscription-verification-token-uuid", + label: "Request the webhook subscription verification_token", + className: "api-method get", + }, + { + type: "doc", + id: "api/get-v-1-webhooks-health-check", + label: "Get the webhooks health status", + className: "api-method get", + }, + ], + }, + { + type: "category", + label: "Events", + link: { + type: "doc", + id: "api/events", + }, + items: [ + { + type: "doc", + id: "api/get-events", + label: "Get all events", + className: "api-method get", + }, + ], + }, + { + type: "category", + label: "Invoices", + link: { + type: "doc", + id: "api/invoices", + }, + items: [ + { + type: "doc", + id: "api/get-invoices-invoice-period", + label: "Retrieve invoicing data for companies", + className: "api-method get", + }, + ], + }, + { + type: "category", + label: "Recovery Cases", + link: { + type: "doc", + id: "api/recovery-cases", + }, + items: [ + { + type: "doc", + id: "api/get-recovery-cases", + label: "Get all recovery cases for a company", + className: "api-method get", + }, + { + type: "doc", + id: "api/redebit-recovery-case", + label: "Initiate a redebit for a recovery case", + className: "api-method put", + }, + ], + }, + { + type: "category", + label: "Company Attachment", + link: { + type: "doc", + id: "api/company-attachment", + }, + items: [ + { + type: "doc", + id: "api/schemas/company-attachment", + label: "Company-Attachment", + className: "schema", + }, + { + type: "doc", + id: "api/get-v-1-companies-attachment", + label: "Get Company Attachment Details", + className: "api-method get", + }, + { + type: "doc", + id: "api/get-v-1-companies-attachment-url", + label: "Get a temporary url to download the Company Attachment file", + className: "api-method get", + }, + { + type: "doc", + id: "api/get-v-1-companies-attachments", + label: "Get List of Company Attachments", + className: "api-method get", + }, + { + type: "doc", + id: "api/post-v-1-companies-attachment", + label: "Create Company Attachment and Upload File", + className: "api-method post", + }, + ], + }, + { + type: "category", + label: "Wire In Requests", + link: { + type: "doc", + id: "api/wire-in-requests", + }, + items: [ + { + type: "doc", + id: "api/get-wire-in-requests-wire-in-request-uuid", + label: "Get a single Wire In Request", + className: "api-method get", + }, + { + type: "doc", + id: "api/put-wire-in-requests-wire-in-request-uuid", + label: "Submit a wire in request", + className: "api-method put", + }, + { + type: "doc", + id: "api/get-companies-company-uuid-wire-in-request-uuid", + label: "Get all Wire In Requests for a company", + className: "api-method get", + }, + ], + }, + { + type: "category", + label: "ACH Transactions", + link: { + type: "doc", + id: "api/ach-transactions", + }, + items: [ + { + type: "doc", + id: "api/get-ach-transactions", + label: "Get all ACH transactions for a company", + className: "api-method get", + }, + ], + }, + { + type: "category", + label: "Information Requests", + link: { + type: "doc", + id: "api/information-requests", + }, + items: [ + { + type: "doc", + id: "api/get-information-requests", + label: "Get all information requests for a company", + className: "api-method get", + }, + { + type: "doc", + id: "api/submit-information-request", + label: "Submit information request responses", + className: "api-method put", + }, + ], + }, + { + type: "category", + label: "Salary Estimates", + link: { + type: "doc", + id: "api/salary-estimates", + }, + items: [ + { + type: "doc", + id: "api/post-v-1-employees-employee-id-salary-estimates", + label: "Create a salary estimate for an employee", + className: "api-method post", + }, + { + type: "doc", + id: "api/get-v-1-salary-estimates-id", + label: "Get a salary estimate", + className: "api-method get", + }, + { + type: "doc", + id: "api/put-v-1-salary-estimates-id", + label: "Update a salary estimate", + className: "api-method put", + }, + { + type: "doc", + id: "api/post-v-1-salary-estimates-uuid-accept", + label: "Accept a salary estimate", + className: "api-method post", + }, + { + type: "doc", + id: "api/get-v-1-salary-estimates-occupations", + label: "Search for BLS occupations", + className: "api-method get", + }, + ], + }, + { + type: "category", + label: "Reimbursements", + link: { + type: "doc", + id: "api/reimbursements", + }, + items: [ + { + type: "doc", + id: "api/get-v-1-employees-employee-id-recurring-reimbursements", + label: "Get recurring reimbursements for an employee", + className: "api-method get", + }, + { + type: "doc", + id: "api/post-v-1-employees-employee-id-recurring-reimbursements", + label: "Create a recurring reimbursement", + className: "api-method post", + }, + { + type: "doc", + id: "api/get-v-1-recurring-reimbursements", + label: "Get a recurring reimbursement", + className: "api-method get", + }, + { + type: "doc", + id: "api/put-v-1-recurring-reimbursements", + label: "Update a recurring reimbursement", + className: "api-method put", + }, + { + type: "doc", + id: "api/delete-v-1-recurring-reimbursements", + label: "Delete a recurring reimbursement", + className: "api-method delete", + }, + ], + }, + { + type: "category", + label: "People Batches", + link: { + type: "doc", + id: "api/people-batches", + }, + items: [ + { + type: "doc", + id: "api/post-v-1-companies-company-id-people-batches", + label: "Create a people batch", + className: "api-method post", + }, + { + type: "doc", + id: "api/get-v-1-people-batches-people-batch-uuid", + label: "Get a people batch", + className: "api-method get", + }, + ], + }, + { + type: "category", + label: "Forms", + items: [ + { + type: "doc", + id: "api/schemas/form", + label: "Form", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/form", + label: "Form", + className: "schema", + }, + ], + }, + { + type: "category", + label: "Documents", + items: [ + { + type: "doc", + id: "api/schemas/document", + label: "Document", + className: "schema", + }, + { + type: "doc", + id: "api/schemas/document-signed", + label: "Document Signed", + className: "schema", + }, + ], + }, + { + type: "category", + label: "Industry", + items: [ + { + type: "doc", + id: "api/schemas/industry", + label: "Industry", + className: "schema", + }, + ], + }, + { + type: "category", + label: "Admins", + items: [ + { + type: "doc", + id: "api/schemas/admin", + label: "Admin", + className: "schema", + }, + ], + }, + { + type: "category", + label: "Contractor", + items: [ + { + type: "doc", + id: "api/schemas/contractor-onboarding-status", + label: "Contractor-Onboarding-Status", + className: "schema", + }, + ], + }, + { + type: "category", + label: "Company Bank Accounts", + items: [ + { + type: "doc", + id: "api/schemas/company-bank-account", + label: "Company-Bank-Account", + className: "schema", + }, + ], + }, + { + type: "category", + label: "Custom Fields", + items: [ + { + type: "doc", + id: "api/schemas/company-custom-field", + label: "Company-Custom-Field", + className: "schema", + }, + ], + }, + ], +}; + +export default sidebar.apisidebar; diff --git a/docs/api/signatories.tag.mdx b/docs/api/signatories.tag.mdx new file mode 100644 index 000000000..b252e41c5 --- /dev/null +++ b/docs/api/signatories.tag.mdx @@ -0,0 +1,20 @@ +--- +id: signatories +title: "Signatories" +description: "Signatories" +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/submit-information-request.ParamsDetails.json b/docs/api/submit-information-request.ParamsDetails.json new file mode 100644 index 000000000..5ab09725e --- /dev/null +++ b/docs/api/submit-information-request.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"name":"information_request_uuid","in":"path","required":true,"schema":{"type":"string"},"description":"The UUID of the information request"}]} \ No newline at end of file diff --git a/docs/api/submit-information-request.RequestSchema.json b/docs/api/submit-information-request.RequestSchema.json new file mode 100644 index 000000000..b14e2fdb4 --- /dev/null +++ b/docs/api/submit-information-request.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"required_questions":{"type":"array","items":{"type":"object","required":["question_uuid","response_type"],"properties":{"question_uuid":{"type":"string","format":"uuid","description":"UUID of the question being answered"},"response_type":{"type":"string","enum":["text","document"],"description":"Type of response - matches the question's response_type from GET"},"text_response":{"type":"string","description":"Text response (required when response_type is text)"},"file_response":{"type":"string","description":"Data URL with base64-encoded file (e.g., \"data:image/png;base64,...\"). Required when response_type is document."},"file_name":{"type":"string","description":"Original filename with extension (e.g., \"document.pdf\"). Used for document uploads."}}}}}}}}}} \ No newline at end of file diff --git a/docs/api/submit-information-request.StatusCodes.json b/docs/api/submit-information-request.StatusCodes.json new file mode 100644 index 000000000..ec3393293 --- /dev/null +++ b/docs/api/submit-information-request.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"description":"Information request successfully submitted","content":{"application/json":{"schema":{"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"}}}},"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/submit-information-request.api.mdx b/docs/api/submit-information-request.api.mdx new file mode 100644 index 000000000..aa0eddb3f --- /dev/null +++ b/docs/api/submit-information-request.api.mdx @@ -0,0 +1,73 @@ +--- +id: submit-information-request +title: "Submit information request responses" +description: "Submit responses to an information request." +sidebar_label: "Submit information request responses" +hide_title: true +hide_table_of_contents: true +api: eJztXOtv27iy/1d49aUtYDmJ82zul9vt45wAp9ugDywO0kChxZHNrURqScqJG+R/vxg+JFmWHdtNPpyDLbDY1iJnfhxyHhwOeR/dxZNKGxlzYWCiqOFSxGZeQnR+FUExBsaARdeDyNCJxt8uRCZVYduRz/BXBdpo/C5LcL0vWHQe6WpccBPzpnGsXONoEN3FugT6A6iexxMlqzI6j1ota6qLLQUtIJYzUIozqFlEg4iBThUvsWt0Hn2xPxMFupRCgyZGEipIiz7xSIbfxZeqLKUymoylmRIDd+2OVDCS8RxIVeaSMk1eFlVueEmV2UNiMaOGvhp+Fx/pHS+qwjXW/Ceck4PR/sffht/Fd6FTWcI5uWkBSDwAfX6ruIGbaBCVVNECDCiU8X2EY10USuiTVBVn0SDiONaSmmk0iPATV8Cic6MqGEQ6nUJBo/P7yE1kpI3iYhI9dGX1dQrk27eLd0RmxEyhT0jRw7VjANr8JtkcqXb5pVIYEAY/0bLMeWop7P2pkcn9Mhw5/hNSnLlS4aoxHHSbbGKZcSl0qw9Vis5x3AYK3UerAXUVBQJBWGFOE9vpust4sfmS2AaRk0p0Hnl6i1JsSzCQImPgYkKo0LeAoB66IHq4gKgKRI/LEJnItCpQrNdL0zYvARkGiiQmBTXpFBd7C8MLTRZ4kkzJgvzj/VdEg0yS8LkPTYdlWzXIyyBscjsF0eHCtVWkV8gFNWILLu+ooeTb53+RW26mZEw1nBzFIFLJwKviSxhOhgPyPULdO+cFncBeKSb/69oOhsPh9+jV0BqmNfiCaIc1Rqdwj+H7pPiEC5pbLNjFAYU7A0LjrDfwAoeSZRbRN41DkKrmHazKMHoIf5o1YpflaH8f/7cI4WJZRYmu0hS0zqo8nxNnFg3gOt1ZMe9iuKNFmTsg/u/4V6ch0en+UXowen0Qj06PWHx0fDyKKT1mMZzuHx7sjw7TERxb/kVJxdzrVXRI07OjMT2Mz07Hh/HR/hjis+PRYcwOzo5ZOjo6pCdpNKg1Pk1lJUxSKmkgtcMfRNpQU2k0fSAYF5NmcQ2icS7TH/hbSedK5nl0ntFcw8OS2fsMpQINwjgxymyFg1iyUKvsQ8ceCP5XBYQzEIZnHNQaDg9dIe1EHLXek0F3dzvl6XSVQddkDLkUE22twIIpumqYiirPewzPFIjxxqdfXsGGhUFJMZZUMUe0d0ZLOkd1SFoy97+AUlJF1w/NrD9qpaZAXNt1Hq1B2bOImp9mHG4RdFkqOcMY6KFvidWQxlLmQMUSpouMWC9JzJTrPjxokAJd4ukObPBR0DnxlraxvVKF39C8I0hn12WlyGeuf5BPJRpgWgyd09nApy4LMefaOA/j7Wjd3dqw1ZJd6Z639Ljr45TQHUdYk7JucyNSNs7rIfWoh16tDfX0GLlIdrVbx7WmtBQUAxTKuEzGlTFSRNfeGRhu0Oi2TX78OdgN2+Jo/2jZQ/wuDfkgK8HId0HId4Ew/QQBQ6CyUikQJkETIQ2BO67NkHykP4DoSoHFj2ueo9e1YueazGjO2fC7ldPRaLTM9psolUQ3RMc5kPfCcDOvEXBtF/OUliUI55SRy1iyOUpvjos3qAM6LcqFJlb/NXq3KaEaI2gLIqHGKD6uDCQzmldwMyB+SQYKGeW5JqwCH/vXPes9ys2QfAE30qv3js1bamAiFQd9/XJqTKnP9/aYTPXQbo+GqSz2wnYo9lpqv+9ZmHFad39FJhVnYBWlkAoIA4OAUHhbuOTHpfu3cLvCXbcncANeDv797zvuNGzv5AdgB49yvoKHbfWoUflSQop+XeNEemW03YlM00rpIfk6L3lKMdSzHuUHzJtowG0A6jncq7eVREFOUf+9fbIkrYeoUW8BzbQsn6NE0MoEUsF6+FVG7B6fi4nbUqcUd0ek0g7NuOI5Iymug8K3n1LBcvSGXLjV28pNDMlF1jDimtwIa9hctKBvBhacmytyy/M8LHlCiWtJbnxT4idp7qN4Z7LcRyuaAvVtsoEnuAzj9auR0LGsTGvuYjIBAaqZNU86CENXKqOpEwgVBARD+SiPwlDc7fQtxUUYb4NyK8hhRoUh2A9p+gUy95rsXQAXzX7Vmg1vkcY5DMkHqYgP/AcLJCw+K6ob93/rLm/s3IZf0K3fOPGPG2cyjAaRFPApszmO9WNxqZYcHC/Uo47ihZ+XlS182UKlF3lrLiaBM3ajjHH8RPPLFieX++jhPd8wfvgdN5A+DPESNVPaXjapVC6wYJjGsquhJeBdNgshenNkLEVnvTGGXLMTqNtVZWLk+oYLdq6vAYbo67Yd7eDno1/98R/cTONPAmLn/KKH1a0++rXjmuLUPAz+nvP/hjlHSisd9qIc/kDjI0U+dwEu4WvdxpBc2I1YKbXmGGIZSaZ0BqS2QznMILf7Su9GgqOozUqUcpVWOVUvHdzYBj/xJ7vgXkXtEfY0cAt6MfEypuJHEnbNDHIwkFQiqwQDlvht8kIQc7UQa0SYFWsHJphR7gRrUcvNRR8qu/n9CGYqGZlSTQI3UnOzc7AAbAaKZ/OEC7t0U0RaSs2fFNm/MQxArsRzRc+Ju5cxEMufAxuSyxyoBpJOIf3hghSMWD0cQgvsiK591RBoroCyeRIoPusAULyeIRkDiGYcPQALrrVNS8jKoNqsBuZbJKIqxqD6IXaC/AWgn11/4vqjTgS363GF9EwqRcYnuoZWx5pbSW25dxvMG0NwSg2RAkgTzBaVNu3Aoh9YGG1GtQnakuQcD41WI+xpvLUIPyBiT4NYGkRPZZUzxEy9ZGvMSQmKS9bgBcES5q3lCpR1k15s/bJ8LxjGg9DSHLuDMlMqyCEppDBTTFCRrDKVAocv5PG4YJU2ap5oyF3qLhGUpzrB3HzSBGYrETett5fn79iXYN+e5bgZQs/m+QGGpQl/VTRHL3JCGJ/w2uysgasDAL0BXM1T13Z7tF94arHqZbBHHqzDangBicyypJQ5T+f2kGSzuS52EmLRN79dEJWwGgWs1heapqqieaLW68xCsy0s9xvXj2C/WmLjHE05RlY1HmIBctArgDeZZX+8vRpqp+s2aN865WZAU8NnCNnRcHtcj4EgAyKzrD4UWIEZijKXcwC9ybTXjbef+/ehK6EKNl8BY5pTkUJSlY/Yy9Xeeh2qt1TYDCllf9ppd9z0+mmfypwztOr4nwMcwgobiD5lVPTWn/mEMMKGFMQjQA/kJ381NCHN88GqU8w2ku4DNiClD9kU4FqVAlZCrd1jvcyeZSleuDYkkCC47dKtHIbF58+1oIHzlPILOowBP6lZ1ZAchKXBPCGCrzb3yLVN9thtKRcLWWBMLnc8mgsrEhCYP8IgzCiaGqkS3IStwdZtub2a1gTcfq+JbxwWd+5uVznaPoe3UdiA/znj2M4Ye9ycNlTZuJ1mBpTd628SBSz32l5+l3Vc/aKH3otGjZvUhM1TEq8oM1dJce1O0GxqcVP8C+1/CfkCpUcxh9bNlgaPHJKJklpjuiMwF2A3A+tiHd9i+3AH7B6hjijCvqADyUYtOCNTWalNAsPdXN0/kXpLcwRMqOGzroC8jqfoB/MntDeXjn4LgGNRq0em5E8Q7WP3J7N0mPXx7Je25P7QDXMLF0a7dHqD0YUdDE/IaG5ArUCbeCrr9+2/BBxLCGzBWQ04HLV0oNpUI1Zo8SLMbSUKyXjGrdkOkEM28ynBhhOjcmmyHQAnyQWRO0OpQc28FddzbaCoGwUb3o0NrBXQSajbezROcO1/xQAtUmq0WhCbnvQ4C1cp2sWpK1VSHPMzQn1/lwJgFOEx4Ewc7O9bqeZS/qjKdbJ8RmAh4Ap7AFty8FK/GkaLZ1/Nuc5VJ+lebx+iTq488I/xn/HB6BBHuGDQbOENqNr526QblrZstfg71HqDYbsifCC8kAfkgkjFQKF/UpUI6tEdvuO9jHP9eOrJ0WCwzvo5BkVZE5rq3YbTgbl+TBkwPEpNDL17zmFhXGgDcM+PGHpHLL/dxrgMe4Ol6HLCrkjkyYe5sAyDxQpZ6F9Ylwug+wepK425iC1T7JsMimNRiyfedoKPDqGB5CDbQlqNZb1LU1Pn7NaF5kvdd0nV1URIIEJq5s0eIloFuPHKv4p24bisI7/AzVtjm0Kn6TQxUwV6KnOWgHc+Uev8rovADgtqrNvLKsgFl4BN28woz6k/zMOIP58Bsbn5N2//Sb4GcCR4xtb5kZTaJiPQSf6B5ZcXYkA+yhmQrxKL6xR5R+1xZNthzkDpbdU09K23L4FI5+zI5sWoMVCUdhNrpA/pCG3qOSrt7hwQWZlYZrH97gmGbSafCGqkwtQe5flmaT3K811SepTn7Y1uF0DYd4fs2JTqpP769NkUd5pbH3jg5NbciC0P8oDqZaCgwBm3R+chedB0GUOGxLBOAIVOBNwi0RDo8TtgCeN6XCkNTTnzuqRVu/UW2tfKLYRzq97oZ43urSKxiEGaJMO60gXpvmuBtlpnmzgpPPPw2D7L6Gg0iinbP4uPgJ7GdP+ExqcHpydnZ+nh+OD09ZpBB2qFPe3eJfZ3B3yuf+0/ndU4J+84noWTd+7weUDe4qH0MOpKJaDwJe47o/Bl7970uYgaQ/tyEeULH227I/4Xw2DDmsldl6wJVd6ProoVNce3VHfXSJRxwfW0dVHAFhK40OsZctJeQG6PbyRqtiEN805OMJcuikks6ceiMG0UgEkOtp/Fj7h4uEjziqFFd4TQtijQemnNpK5E6dd4WCJdyq5KZ3vXi92Ivd5gzeWtkmJC/O67y+MnL3dY5s4kg8C9dsji/eSlO3S1167Iwejw6PhVj4pNpYCd6yEusXeohghKfrC/cFCKFQc5T9dlGnqVh1WuAhxWHT22VAeP78wUdKu8t0lWuSOczgZ+k0R2L6z1dQRf29cDmpoMO/tuXrA220XKQcdzedsqb7C1XOuKG5q9/c7ZBGQZqvm6C6KdI3gaBvUgvSdzMax+3Of7hpu7Q8vFB9rBSqGi6TWeDr/bPjvtQLAmGBixn8gL3+dFc5NASFKCcncOXSsdvMqYap4+8+6c2jK/YL9DtGmDjO22sAKA6faFtYeg2934I8jt1heHrxid/by1wP/AsvBgZyb2WFT5kFU1hRr7taNaQveMOXobSaxOkndyzg4B5vCJrUxP8aaqvW9PmA2O8nn3hD9ccvdjcCegT56H7hQ/tCA7hqxzmrWuXIwrbZLdCl4+YF8iOmUvS9aKWf+QJWOu7G3/Lbm8s+fqGbHd662x96C2bMIFgNbmbHZMW9eC7hLEhxvEIwpHJwenMaP0dXwE7DQ+O4b9+OAM2DHbBzg7PF5j0uxp2A6b0jyn5AM3PyeYimO24peiMcftGkGFtWt42jkN04Axot0i1kfNXgg9G50nltSInY6zk1Eaj+k4i4/owSg+G70exYdH+zBir1M6Hp2tkdRuVuhCU06n5DdQORe1mFAu+dyK6NbfXtlMQiGmBqFdPF3nPdbX7ayu1Vpbwuqj0fZKbxdd9iKpN5dibX3oQrOdd2vYu7NjJHgEOyB/APzAVJMwU3v17t9A+1CHpElte594qxQYrbP2suVQHxYK+BduK8a9xe6DqF3o/lsIFJzI/pMjhodB9LnlNx4b0H+JA3kYRL/XHuSxMf/tSv52Jb/gSsJjKfWzKw6pw7jyOatBWJbtZ61Q3qFf902qukPv21T9PRffqGoo+Leq8C0ln248j8rKPXZhptF5tDc72Ot7IWrvftUbUA979QNYtj7Cz1elclzT/o41Lbm7Yh0zKOw96+U3d6CQnZe2HL3YJVnxMw52BeFempfKJlRX0SzxM8pCQ1opmwy4ug/G+o19y+ZNhWK5um63+oJ3452/6GlbXwdDiJF/BMs+zAFUWb/QvSxrScT2XhehlZniZj4cWg6iL7bS5Fc4OAorGDwMIrzz/7l5Wet988pO36sdV0uvZkSHGT07zk6O4uPTg9P46PhkFI8PszQepa9PDrOTE5rRk6XXr87DQxSdF6Bar10tPtrU+eCfJgtPirmEk6uXCO7/H7gwyJvLC9SAcCgWjfZHx/H+SXxwbJmrQn/KvoCa8RRaC6t5EMDeod6zDfcYyhCjldj+Gw+3tO+6dO8P8lQW9szP4nihyXuv7ySUmb25vKjfYbLz8T/+ZQbqcnh+jO8CV/IZb8/7RI07D0PN8F//r1EEnNZSalNQ0aLjn6Tre/ulefCpM4775qWI/9An7Vqrba/MKbdaZa3Ivbd6V9HsIBr0vXKH4jhf8/qdN33XWCiuDVK6v8fQ8JvKHx7w578qQAd1dY02WNnaNqtCjNuYlPm3odYI/WV4Q+wV2eSZvBXjDVdUxbzlDSJ/X3b1+36uBh4ow+Rt7dveOnDx1wV/tvyOSOOb0HyVZm3btku6/PYV39Hyz/wV0r6zqOitfaHm1iEPGUs0U/jbfZRTMamcr3ck8c//A6svvfg= +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"; + + + + + + + + + + +Submit responses to an information request. +Supports both text responses and file uploads (multipart/form-data). +Maximum file size: 120MB. + +scope: `information_requests:write` + + + Request + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/tax-requirements.tag.mdx b/docs/api/tax-requirements.tag.mdx new file mode 100644 index 000000000..483791034 --- /dev/null +++ b/docs/api/tax-requirements.tag.mdx @@ -0,0 +1,20 @@ +--- +id: tax-requirements +title: "Tax Requirements" +description: "Tax Requirements" +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/time-off-policies.tag.mdx b/docs/api/time-off-policies.tag.mdx new file mode 100644 index 000000000..d3c5df812 --- /dev/null +++ b/docs/api/time-off-policies.tag.mdx @@ -0,0 +1,20 @@ +--- +id: time-off-policies +title: "Time Off Policies" +description: "Time Off Policies" +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/webhooks.tag.mdx b/docs/api/webhooks.tag.mdx new file mode 100644 index 000000000..3fd78e91f --- /dev/null +++ b/docs/api/webhooks.tag.mdx @@ -0,0 +1,20 @@ +--- +id: webhooks +title: "Webhooks" +description: "Webhooks" +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/wire-in-requests.tag.mdx b/docs/api/wire-in-requests.tag.mdx new file mode 100644 index 000000000..df5c40b6b --- /dev/null +++ b/docs/api/wire-in-requests.tag.mdx @@ -0,0 +1,20 @@ +--- +id: wire-in-requests +title: "Wire In Requests" +description: "Wire In Requests" +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/component-adapter/component-adapter-faq.md b/docs/component-adapter/component-adapter-faq.md index d811bba87..c1975e31e 100644 --- a/docs/component-adapter/component-adapter-faq.md +++ b/docs/component-adapter/component-adapter-faq.md @@ -3,8 +3,6 @@ title: Component Adapter FAQ order: 1 --- -## Component Adapter FAQ - This FAQ addresses common questions and potential issues when working with the Component Adapter system in the Gusto Embedded React SDK. ### General Questions diff --git a/docs/component-adapter/component-adapter-types.md b/docs/component-adapter/component-adapter-types.md index 857028f8d..ba6a92ed5 100644 --- a/docs/component-adapter/component-adapter-types.md +++ b/docs/component-adapter/component-adapter-types.md @@ -3,8 +3,6 @@ title: Component Adapter Types order: 4 --- -## Component Adapter Types - The Component Adapter system uses TypeScript interfaces to ensure type safety and consistent behavior. This document provides links to the type definitions you'll need when implementing custom components. ### Core Types diff --git a/docs/component-adapter/component-adapter.md b/docs/component-adapter/component-adapter.md index 9a0b84aea..eb80c4f2c 100644 --- a/docs/component-adapter/component-adapter.md +++ b/docs/component-adapter/component-adapter.md @@ -3,8 +3,6 @@ title: Component Adapter order: 5 --- -## Component Adapter - The Component Adapter system provides a powerful way to customize the UI components used throughout the Gusto Embedded React SDK. This feature allows you to replace the default SDK UI components with your own UI components while maintaining all the SDK's functionality. > Component adapters are powerful but can be complicated to set up and involve higher maintenance overhead. It is recommended to start with [theming](../theming/theming-guide.md) and then only use component adapters as needed. diff --git a/docs/component-adapter/how-the-component-adapter-works.md b/docs/component-adapter/how-the-component-adapter-works.md index 1235ec0fb..0dac203d0 100644 --- a/docs/component-adapter/how-the-component-adapter-works.md +++ b/docs/component-adapter/how-the-component-adapter-works.md @@ -3,8 +3,6 @@ title: How the Component Adapter Works order: 2 --- -## How the Component Adapter Works - 1. You create mappings that connect the SDK props to your UI components 2. You provide these mappings to either: - `GustoProvider` (recommended): Includes default React Aria components and allows overriding specific ones @@ -50,7 +48,7 @@ function App() { Button: ButtonAdapter, // Override just what you need }} > - + {}} /> ) } @@ -72,7 +70,7 @@ function App() { config={{ baseUrl: '/api/gusto/' }} components={myCompleteComponentSet} // Must provide all required components > - + {}} /> ) } diff --git a/docs/component-adapter/setting-up-your-component-adapter.md b/docs/component-adapter/setting-up-your-component-adapter.md index 9327c6f13..cb43fc57a 100644 --- a/docs/component-adapter/setting-up-your-component-adapter.md +++ b/docs/component-adapter/setting-up-your-component-adapter.md @@ -3,8 +3,6 @@ title: Setting Up Your Component Adapter order: 3 --- -## Setting Up Your Component Adapter - This guide will walk you through the process of creating and implementing your own Component Adapter for the Gusto Embedded React SDK. ### 1. Create Your Custom Component Implementations @@ -122,7 +120,7 @@ function App() { }} > {/* Your application components */} - + {}} /> ) } @@ -149,7 +147,7 @@ function App() { components={myCustomComponents} // Must provide all required components > {/* Your application components */} - + {}} /> ) } @@ -244,7 +242,7 @@ function App() { config={{ baseUrl: '/api/gusto/' }} components={materialUIComponents} // Only the components you want to customize > - + {}} /> ) } diff --git a/docs/getting-started/authentication.md b/docs/getting-started/authentication.md index 71ba093e0..b084b245e 100644 --- a/docs/getting-started/authentication.md +++ b/docs/getting-started/authentication.md @@ -3,8 +3,6 @@ title: Authentication order: 0 --- -## Authentication - To get started, you'll need to create a way to properly create and retrieve access tokens on behalf of your authenticated user from your application. Since there are a vast number of ways this might work for a partner, what we can suggest to get up and running is to implement a proxy server that handles translating requests from the SDK to the Gusto Embedded API. @@ -19,7 +17,7 @@ The most simple implementation is one where a partner has a backend service that The `` can receive a `baseUrl` that can be configured with the address of your backend proxy service and can also be used if necessary to pass along vendor authentication credentials. -```jsx react +```jsx import { GustoProvider } from '@gusto/embedded-react-sdk' function App() { @@ -37,7 +35,7 @@ The SDK provides two ways to add headers to API requests: For static headers like API keys or simple authentication tokens, you can pass them directly in the config: -```jsx react +```jsx import { GustoProvider } from '@gusto/embedded-react-sdk' function App() { diff --git a/docs/getting-started/getting-started.md b/docs/getting-started/getting-started.md index 19546a13a..610166fbb 100644 --- a/docs/getting-started/getting-started.md +++ b/docs/getting-started/getting-started.md @@ -13,7 +13,7 @@ To get started with the Gusto Embedded React SDK, first install it from NPM via In this case, installing via NPM: -``` +```bash npm i @gusto/embedded-react-sdk ``` diff --git a/docs/getting-started/proxy-security-partner-guidance.md b/docs/getting-started/proxy-security-partner-guidance.md index 7a0e19478..e24db409d 100644 --- a/docs/getting-started/proxy-security-partner-guidance.md +++ b/docs/getting-started/proxy-security-partner-guidance.md @@ -2,8 +2,6 @@ title: 'Proxy Security: Partner Guidance' --- -# Proxy Security: Partner Guidance - The Gusto API enforces application-level protections (scopes, company-bound tokens, rate limits). Your proxy enforces user-level authorization. Both layers are necessary -- UI-level restrictions alone are not sufficient since users can make API requests directly. ## What to do diff --git a/docs/hooks/hooks.md b/docs/hooks/hooks.md index bfeb22050..24bbbdee7 100644 --- a/docs/hooks/hooks.md +++ b/docs/hooks/hooks.md @@ -3,8 +3,6 @@ title: Hooks order: 1 --- -# Hooks - Hooks give you full control over form rendering while the SDK manages data fetching, validation, submission, and error handling. Each hook returns pre-bound field components, metadata, and actions — you supply the layout and labels. > Hooks are an experimental feature. APIs may change between minor versions during 0.x.x releases. @@ -29,7 +27,7 @@ import { useEmployeeDetailsForm, SDKFormProvider } from '@gusto/embedded-react-s function App() { return ( - + ) diff --git a/docs/hooks/useCompensationForm.md b/docs/hooks/useCompensationForm.md index 19fb92c31..4bc31eff3 100644 --- a/docs/hooks/useCompensationForm.md +++ b/docs/hooks/useCompensationForm.md @@ -3,8 +3,6 @@ title: useCompensationForm order: 3 --- -# useCompensationForm - Creates or updates job compensation for an employee — job title, FLSA classification, pay rate, payment unit, minimum wage adjustments, and Washington state workers' compensation fields. ```tsx diff --git a/docs/hooks/useEmployeeDetailsForm.md b/docs/hooks/useEmployeeDetailsForm.md index 802c33adb..cbf6b4c26 100644 --- a/docs/hooks/useEmployeeDetailsForm.md +++ b/docs/hooks/useEmployeeDetailsForm.md @@ -3,8 +3,6 @@ title: useEmployeeDetailsForm order: 2 --- -# useEmployeeDetailsForm - Creates or updates an employee's profile information — name, email, SSN, date of birth, and self-onboarding preference. ```tsx diff --git a/docs/hooks/useWorkAddressForm.md b/docs/hooks/useWorkAddressForm.md index 3c7b26131..5ccd1a792 100644 --- a/docs/hooks/useWorkAddressForm.md +++ b/docs/hooks/useWorkAddressForm.md @@ -3,8 +3,6 @@ title: useWorkAddressForm order: 4 --- -# useWorkAddressForm - Creates or updates an employee's work address — selecting a company location and an effective date. ```tsx diff --git a/docs/integration-guide/composition.md b/docs/integration-guide/composition.md index 8c9de4f49..b899bdd80 100644 --- a/docs/integration-guide/composition.md +++ b/docs/integration-guide/composition.md @@ -12,7 +12,7 @@ Workflows are individual components that encapsulate complex, often multi step u Using a workflow has appeal because you can render an entire user flow with a single component. For example, we can render the entire employee onboarding flow which is comprised of tax forms, user details, and payment information by using a single component as follows: ```jsx -import { EmployeeOnboardingFlow } from '@gusto/embedded-react-sdk'; +import { Employee } from '@gusto/embedded-react-sdk'; function MyApp({ companyId }) { return( @@ -21,7 +21,7 @@ function MyApp({ companyId }) { baseUrl: `/myapp/`, }} > - {...}} /> + {...}} /> ); } diff --git a/docs/integration-guide/customizing-sdk-ui.md b/docs/integration-guide/customizing-sdk-ui.md index 121b5e1a6..6b3df28c5 100644 --- a/docs/integration-guide/customizing-sdk-ui.md +++ b/docs/integration-guide/customizing-sdk-ui.md @@ -17,7 +17,7 @@ Theming sets the visual baseline for all of the SDK UI, and it is recommended to Theming allows you to set typography and color styles universally and change the entire look of the UI to match your brand by specifying a limited set of values. For example: -``` +```jsx import { GustoProvider } from '@gusto/embedded-react-sdk' import '@gusto/embedded-react-sdk/style.css' @@ -81,7 +81,7 @@ function App() { Button: ButtonAdapter, // Override just what you need }} > - + {}} /> ) } diff --git a/docs/integration-guide/error-handling.md b/docs/integration-guide/error-handling.md index 58f68621f..d8ac02362 100644 --- a/docs/integration-guide/error-handling.md +++ b/docs/integration-guide/error-handling.md @@ -3,8 +3,6 @@ title: Error Handling in the React SDK order: 7 --- -# Error Handling in the React SDK - Error handling in the React SDK occurs across multiple layers: 1. **Top-Level Error Boundary** — in `GustoProviderCustomUIAdapter.tsx` diff --git a/docs/integration-guide/event-handling.md b/docs/integration-guide/event-handling.md index 1c1ee69fe..e76bf3a2d 100644 --- a/docs/integration-guide/event-handling.md +++ b/docs/integration-guide/event-handling.md @@ -9,7 +9,7 @@ The Gusto Embedded React SDK can communicate events with the parent application. Each of our React SDK components ships with an `onEvent` property. This is a function callback that is supplied with the event type and data associated with the user action. It takes the form: -```typescript typescript +```typescript (eventType: EventType, data?: unknown) => void ``` @@ -19,7 +19,7 @@ The `data` argument can vary in shape and content. Some events will have no data You can supply a function to this callback and respond to events as needed. In the following example we set up an event handler for the `Employee.Profile` component and execute code based on the event type: -```jsx jsx +```jsx import { Employee, componentEvents } from '@gusto/embedded-react-sdk' const handleEvent = (eventType, data) => { diff --git a/docs/integration-guide/integration-guide.md b/docs/integration-guide/integration-guide.md index 27da4f29b..06533b16f 100644 --- a/docs/integration-guide/integration-guide.md +++ b/docs/integration-guide/integration-guide.md @@ -2,7 +2,7 @@ title: Integration Guide --- -The integration guide will provide general concepts for building with the Gusto Embedded React SDK. The intent of the SDK is to be flexible and customizable according to the needs of your application. The sections below detail how to accomplish some common use cases. +The integration guide covers the key concepts for building with the Gusto Embedded React SDK. The SDK is designed to be flexible -- you can use workflow components as-is for a quick start, or customize every aspect of the experience to match your application. The sections below walk through each integration surface area, from versioning and event handling to theming and error tracking. | Section | Description | | ------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | diff --git a/docs/integration-guide/observability.md b/docs/integration-guide/observability.md index f7bd23fe5..9092ce754 100644 --- a/docs/integration-guide/observability.md +++ b/docs/integration-guide/observability.md @@ -3,8 +3,6 @@ title: Observability and Error Tracking order: 8 --- -# Observability and Error Tracking - The Gusto Embedded React SDK provides built-in hooks for error tracking and performance monitoring. These hooks allow you to integrate with observability tools like Sentry, Datadog, New Relic, or your own custom monitoring solution. --- diff --git a/docs/integration-guide/routing.md b/docs/integration-guide/routing.md index 752c02902..377d07cbe 100644 --- a/docs/integration-guide/routing.md +++ b/docs/integration-guide/routing.md @@ -117,11 +117,10 @@ Once we have our wrapper components configured with the correct navigation, we c ```jsx import { Employee, - useGetEmployeesByCompany, componentEvents, } from '@gusto/embedded-react-sdk'; import '@gusto/embedded-react-sdk/style.css'; -import React, { Suspense } from 'react'; +import React from 'react'; import { createBrowserRouter, Link, diff --git a/docs/integration-guide/translation.md b/docs/integration-guide/translation.md index 11570a68d..ea02ff29e 100644 --- a/docs/integration-guide/translation.md +++ b/docs/integration-guide/translation.md @@ -22,7 +22,7 @@ For example, take the payment details step from the Employee Onboarding Flow. In We can update any text on this page by overriding the text strings in the dictionary. Here is an example updating the title and CTA text. ```jsx -import { EmployeeOnboardingFlow } from '@gusto/embedded-react-sdk'; +import { Employee } from '@gusto/embedded-react-sdk'; function MyApp({ companyId }) { return( @@ -39,7 +39,7 @@ function MyApp({ companyId }) { }, }} > - {...}} /> + {...}} /> ); } diff --git a/docs/reference/endpoint-reference.md b/docs/reference/endpoint-reference.md index dc0d98625..dbe4b04e9 100644 --- a/docs/reference/endpoint-reference.md +++ b/docs/reference/endpoint-reference.md @@ -4,8 +4,6 @@ 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/reference/proxy-examples.md b/docs/reference/proxy-examples.md index 8b3a9b0a7..08fc29008 100644 --- a/docs/reference/proxy-examples.md +++ b/docs/reference/proxy-examples.md @@ -2,8 +2,6 @@ title: 'Proxy Examples' --- -# Proxy Examples - Express.js examples for building endpoint allowlists. These examples assume a standard Express app with session-based authentication. For background, see the [Proxy Security: Partner Guidance](../getting-started/proxy-security-partner-guidance.md). ## Loading the endpoint inventory diff --git a/docs/theming/theme-variables.md b/docs/theming/theme-variables.md index 2b827e0cb..12f99b41d 100644 --- a/docs/theming/theme-variables.md +++ b/docs/theming/theme-variables.md @@ -3,8 +3,6 @@ title: Theme Variables order: 1 --- -# Theme Variables - | Variable | Type | | -------------------------------- | -------- | | **colorBody** | `string` | diff --git a/docs/theming/theming-guide.md b/docs/theming/theming-guide.md index 629cb0667..e4085ca72 100644 --- a/docs/theming/theming-guide.md +++ b/docs/theming/theming-guide.md @@ -28,7 +28,7 @@ See [theme variables](./theme-variables.md) for a complete list of available var You can set your theme by passing variables to the `theme` prop of the `GustoProvider` component. -``` +```jsx import { GustoProvider } from '@gusto/embedded-react-sdk' import '@gusto/embedded-react-sdk/style.css' @@ -57,11 +57,11 @@ function MyApp({ children }) { For example, consider the body color variables: -``` - colorBody - colorBodyAccent - colorBodyContent - colorBodySubContent +```text +colorBody +colorBodyAccent +colorBodyContent +colorBodySubContent ``` The `colorBodyContent` and `colorBodySubContent` colors will be displayed on top of both `colorBody` and `colorBodyAccent` backgrounds. You must ensure sufficient color contrast between: diff --git a/docs/theming/theming.md b/docs/theming/theming.md index cec959aba..5e83b0b21 100644 --- a/docs/theming/theming.md +++ b/docs/theming/theming.md @@ -2,8 +2,6 @@ title: Theming --- -## Theming - Theming provides a simple and powerful way to customize the visual appearance of the Gusto Embedded React SDK UI components. This feature allows you to change colors, typography, shadows, and other design variables to globally update the SDK visuals to match your application. > Theming is the recommended approach for customizing your UI. It provides the best balance of customization power and maintenance simplicity. For advanced customization, consider using [component adapters](../component-adapter/component-adapter.md). diff --git a/docs/what-is-the-gep-react-sdk.md b/docs/what-is-the-gep-react-sdk.md index c99baf977..15a3a6e57 100644 --- a/docs/what-is-the-gep-react-sdk.md +++ b/docs/what-is-the-gep-react-sdk.md @@ -5,14 +5,61 @@ order: 0 ## Introduction -The Gusto Embedded Payroll React SDK offers component libraries with built-in business logic that helps our developers with the complexity of building with payroll APIs. The SDK represents a deeply customizable and yet quick-to-deploy option that complements our existing iframes components (“Flows”) and our underlying APIs. While the latter two methods are still valuable tools (and can be used in conjunction with each other or the SDK), the SDK was built in order to add another compelling option in the spectrum between customization and build velocity that partners may face in establishing a full-fledged payroll application. +The Gusto Embedded Payroll (GEP) React SDK is a React component library with built-in business logic for building payroll experiences on top of the Gusto Embedded API. It handles the complexity of payroll workflows -- onboarding companies and employees, running payroll, managing contractors, handling taxes -- so you can ship a full-featured payroll product without becoming a payroll domain expert. -## Benefits of the SDK +The SDK complements Gusto's existing integration options (iframe-based Flows and the underlying REST API) by offering a middle ground: faster than building on raw APIs, more customizable than iframes. -Below are three demo videos that help illustrate the capabilities of our SDK components: +## Why use the SDK? -### [Custom theming, translations, and data integration for a better payroll product](https://drive.google.com/file/d/1lV7o0hbzTVwVost9MV5wgxGO__D-B2Gq/preview) +### Ship faster -### [Modularity and flexibility to shape your application's user experience](https://drive.google.com/file/d/12rfU6cSUfPVCaeWG3tvSZ7ARyVdGPQ9n/preview) +Pre-built workflow components encapsulate multi-step processes like employee onboarding or payroll execution. A single `` component handles profile collection, tax setup, payment method configuration, and document signing -- all in one React component. -### [Enabling event modeling to integrate with your systems](https://drive.google.com/file/d/1RaJdgN2g8yXOx03tjet2HUcBlvPtkvBI/preview) +```jsx +import { Employee } from '@gusto/embedded-react-sdk' + + +``` + +### Full UI control + +Unlike iframes, the SDK renders native React components inside your application. You control the look and feel through: + +- **[Theming](./theming/theming.md)** -- override CSS variables for colors, typography, spacing, and more +- **[Component Adapters](./component-adapter/component-adapter.md)** -- swap SDK primitives for your own design system components +- **[Composition](./integration-guide/composition.md)** -- rearrange, add, or remove sections within any workflow + +### Event-driven integration + +Every component emits typed events for user actions and API responses. Use events to drive navigation, trigger side effects, or feed analytics in your own application. + +```jsx +import { componentEvents } from '@gusto/embedded-react-sdk' + +function handleEvent(eventType, data) { + if (eventType === componentEvents.EMPLOYEE_CREATED) { + trackAnalytics('employee_created', { id: data.uuid }) + } +} +``` + +### Built-in business logic + +The SDK manages API calls, form validation, error handling, and state transitions internally. Components use [React Query](https://tanstack.com/query) for data fetching and caching, [react-hook-form](https://react-hook-form.com/) for form state, and [Zod](https://zod.dev/) for schema validation -- all wired together so you don't have to be. + +## How it compares + +| | 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 | + +For a deeper comparison, see [Build Pathways: SDK, Flows, and API](./deciding-to-build-with-the-sdk/build-pathways-sdk-flows-api.md). + +## Next steps + +- **[Getting Started](./getting-started/getting-started.md)** -- install the SDK, configure the provider, and set up your proxy +- **[Workflows Overview](./workflows-overview/workflows-overview.md)** -- see the available pre-built workflows +- **[Integration Guide](./integration-guide/integration-guide.md)** -- learn about events, composition, theming, and more diff --git a/docs/workflows-overview/company-onboarding.md b/docs/workflows-overview/company-onboarding.md index 2e95ee2e8..27f034bb1 100644 --- a/docs/workflows-overview/company-onboarding.md +++ b/docs/workflows-overview/company-onboarding.md @@ -21,22 +21,22 @@ function MyApp() { #### Props -| Name | Type | Description | -| ------------------ | ------ | --------------------------------------------------------------- | -| companyId Required | string | The associated company identifier. | -| defaultValues | object | Default values for individual flow step components | -| onEvent Required | | See events table for each subcomponent to see available events. | +| Name | Type | Description | +| ------------------------ | -------- | --------------------------------------------------------------- | +| **companyId** (Required) | string | The associated company identifier. | +| **defaultValues** | object | Default values for individual flow step components. | +| **onEvent** (Required) | function | See events table for each subcomponent to see available events. | ## Using Company Subcomponents -Employee onboarding components can be used to compose your own workflow, or can be rendered in isolation. For guidance on creating a custom workflow, see [docs on composition](../integration-guide/composition.md). +Company onboarding components can be used to compose your own workflow, or can be rendered in isolation. For guidance on creating a custom workflow, see [docs on composition](../integration-guide/composition.md). ### Available Subcomponents - Company.AssignSignatory - Company.CreateSignatory - Company.InviteSignatory -- Company.IndustrySelect +- Company.Industry - Company.DocumentSigner - Company.FederalTaxes - Company.PaySchedule @@ -250,11 +250,11 @@ function MyComponent() { #### Props -| Name | Type | Description | -| ------------------------ | ------ | -------------------------------------- | -| **companyId** (Required) | string | The associated company identifier. | -| **defaultValues** | | | -| **onEvent** (Required) | | See events table for available events. | +| Name | Type | Description | +| ------------------------ | -------- | -------------------------------------- | +| **companyId** (Required) | string | The associated company identifier. | +| **defaultValues** | object | Default values for location form fields. | +| **onEvent** (Required) | function | See events table for available events. | #### Events @@ -280,11 +280,11 @@ function MyComponent() { #### Props -| Name | Type | Description | -| ------------------------ | ------ | -------------------------------------- | -| **companyId** (Required) | string | The associated company identifier. | -| **defaultValues** | | | -| **onEvent** (Required) | | See events table for available events. | +| Name | Type | Description | +| ------------------------ | -------- | -------------------------------------- | +| **companyId** (Required) | string | The associated company identifier. | +| **defaultValues** | object | Default values for bank account form fields. | +| **onEvent** (Required) | function | See events table for available events. | #### Events diff --git a/docs/workflows-overview/employee-onboarding/employee-onboarding.md b/docs/workflows-overview/employee-onboarding/employee-onboarding.md index 13d9e489a..3f005dc37 100644 --- a/docs/workflows-overview/employee-onboarding/employee-onboarding.md +++ b/docs/workflows-overview/employee-onboarding/employee-onboarding.md @@ -10,11 +10,11 @@ The Employee Onboarding workflow provides a complete experience for onboarding a ### Implementation ```jsx -import { EmployeeOnboardingFlow } from '@gusto/embedded-react-sdk' +import { Employee } from '@gusto/embedded-react-sdk' function MyApp() { return ( - {}} @@ -25,14 +25,14 @@ function MyApp() { #### Props -| Name | Type | Default | Description | -| ----------------------- | ------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| employeeId | string | | The associated employee identifier. | -| companyId Required | string | | The associated company identifier. | -| defaultValues | object | | Default values for individual flow step components | -| onEvent Required | | | See events table for each subcomponent to see available events. | -| isSelfOnboardingEnabled | boolean | true | When true, presents the self-onboarding toggle allowing the admin to opt the employee into self-onboarding. When false, the option to self-onboard is not available. | -| withEmployeeI9 | boolean | false | When true, enables the Employee Documents step in the onboarding flow, allowing the admin to configure I-9 document requirements. | +| Name | Type | Default | Description | +| --------------------------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **employeeId** | string | | The associated employee identifier. | +| **companyId** (Required) | string | | The associated company identifier. | +| **defaultValues** | object | | Default values for individual flow step components. | +| **onEvent** (Required) | function | | See events table for each subcomponent to see available events. | +| **isSelfOnboardingEnabled** | boolean | true | When true, presents the self-onboarding toggle allowing the admin to opt the employee into self-onboarding. When false, the option to self-onboard is not available. | +| **withEmployeeI9** | boolean | false | When true, enables the Employee Documents step in the onboarding flow, allowing the admin to configure I-9 document requirements. | ## Using Employee Subcomponents @@ -66,16 +66,16 @@ function MyApp() { #### Props -| Name | Type | Description | -| ------------------ | ------ | -------------------------------------------- | -| companyId Required | string | The associated company identifier. | -| onEvent Required | | See events table below for available events. | +| Name | Type | Description | +| ------------------------ | -------- | -------------------------------------------- | +| **companyId** (Required) | string | The associated company identifier. | +| **onEvent** (Required) | function | See events table below for available events. | #### Events | Event type | Description | Data | | ---------------- | ------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------- | -| EMPLOYEE_CREATE | Fired when user clicks "Add employee" button | Undefined | +| EMPLOYEE_CREATE | Fired when user clicks "Add employee" button | None | | EMPLOYEE_UPDATE | Fired when user selects "Edit" from employee actions menu | { employeeId: string } | | EMPLOYEE_DELETED | Fired after selecting delete from the employee actions menu and the deleting an employee operation completes | Response data from Delete an onboarding employee endpoint | @@ -110,13 +110,13 @@ function MyComponent() { #### Props -| Name | Type | Default | Description | -| ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------- | ---------------------------------------------------------------------------------------------------------------------------------- | -| companyId Required | string | | The associated company identifier. | -| employeeId | string | false | The associated employee identifier. | -| onEvent Required | | | See events table for available events. | -| isAdmin | boolean | false | If the onboarding is being performed by an admin. When false it is configured to be self onboarding. | -| defaultValues | { employee?: { firstName?: string middleInitial?: string lastName?: string email?: string dateOfBirth?: string } homeAddress?: { street1?: string street2?: string city?: string state?: string zip?: string } } | undefined | Default values for the employee profile form inputs. If employee data is available via the API, defaultValues will be overwritten. | +| Name | Type | Default | Description | +| ------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------- | ---------------------------------------------------------------------------------------------------------------------------------- | +| **companyId** (Required) | string | | The associated company identifier. | +| **employeeId** | string | | The associated employee identifier. | +| **onEvent** (Required) | function | | See events table for available events. | +| **isAdmin** | boolean | false | If the onboarding is being performed by an admin. When false it is configured to be self onboarding. | +| **defaultValues** | { employee?: { firstName?: string middleInitial?: string lastName?: string email?: string dateOfBirth?: string } homeAddress?: { street1?: string street2?: string city?: string state?: string zip?: string } } | undefined | Default values for the employee profile form inputs. If employee data is available via the API, defaultValues will be overwritten. | #### Events @@ -158,12 +158,12 @@ function MyComponent() { #### Props -| Name | Type | Description | -| ------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------- | -------- | ----------- | ------- | ---------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | -| employeeId Required | string | The associated employee identifier. | -| startDate Required | string | The date the employee will start work. | -| onEvent Required | | See events table for available events. | -| defaultValues | { title?: string \| null rate?: string paymentUnit?: string, flsaStatus?: 'Commission Only Exempt' | 'Commission Only Nonexempt' | 'Exempt' | 'Nonexempt' | 'Owner' | 'Salaried Nonexempt' } | Default values for the employee profile form inputs. If employee data is available via the API, defaultValues will be overwritten. | +| Name | Type | Description | +| ------------------------ | ------ | -------------------------------------- | +| **employeeId** (Required) | string | The associated employee identifier. | +| **startDate** (Required) | string | The date the employee will start work. | +| **onEvent** (Required) | function | See events table for available events. | +| **defaultValues** | object | Default values for the compensation form. Accepts `title`, `rate`, `paymentUnit`, and `flsaStatus` (`'Exempt'`, `'Nonexempt'`, `'Salaried Nonexempt'`, `'Commission Only Exempt'`, `'Commission Only Nonexempt'`, or `'Owner'`). If employee data is available via the API, defaultValues will be overwritten. | #### Events @@ -191,10 +191,10 @@ function MyComponent() { #### Props -| Name | Type | Description | -| ------------------- | ------ | -------------------------------------- | -| employeeId Required | string | The associated employee identifier. | -| onEvent Required | | See events table for available events. | +| Name | Type | Description | +| --------------------------- | -------- | -------------------------------------- | +| **employeeId** (Required) | string | The associated employee identifier. | +| **onEvent** (Required) | function | See events table for available events. | #### Events @@ -219,11 +219,11 @@ function MyComponent() { #### Props -| Name | Type | Default | Description | -| ------------------- | ------- | ------- | ---------------------------------------------------------------------------------------------------- | -| employeeId Required | string | | The associated employee identifier. | -| onEvent Required | | | See events table for available events. | -| isAdmin | boolean | false | If the onboarding is being performed by an admin. When false it is configured to be self onboarding. | +| Name | Type | Default | Description | +| ------------------------- | -------- | ------- | ---------------------------------------------------------------------------------------------------- | +| **employeeId** (Required) | string | | The associated employee identifier. | +| **onEvent** (Required) | function | | See events table for available events. | +| **isAdmin** | boolean | false | If the onboarding is being performed by an admin. When false it is configured to be self onboarding. | #### Events @@ -248,11 +248,11 @@ function MyComponent() { #### Props -| Name | Type | Description | -| ------------------- | ------ | ---------------------------------------------------------------------------------------------------- | -| employeeId Required | string | The associated employee identifier. | -| onEvent Required | | See events table for available events. | -| isAdmin | | If the onboarding is being performed by an admin. When false it is configured to be self onboarding. | +| Name | Type | Description | +| ------------------------- | -------- | ---------------------------------------------------------------------------------------------------- | +| **employeeId** (Required) | string | The associated employee identifier. | +| **onEvent** (Required) | function | See events table for available events. | +| **isAdmin** | boolean | If the onboarding is being performed by an admin. When false it is configured to be self onboarding. | #### Events @@ -279,10 +279,10 @@ function MyComponent() { #### Props -| Name | Type | Description | -| ------------------- | ------ | -------------------------------------- | -| employeeId Required | string | The associated employee identifier. | -| onEvent Required | | See events table for available events. | +| Name | Type | Description | +| ------------------------- | -------- | -------------------------------------- | +| **employeeId** (Required) | string | The associated employee identifier. | +| **onEvent** (Required) | function | See events table for available events. | #### Events @@ -298,7 +298,7 @@ function MyComponent() { Used during admin onboarding to configure which documents are included in the employee's self-onboarding experience. When the employee has been invited to self-onboard, this step allows the admin to enable or disable the I-9 (Employment Eligibility Verification) form. When the employee is not self-onboarding, this step displays a read-only summary of the documents that will be part of the onboarding process. -This component is conditionally shown in the `EmployeeOnboardingFlow` when `withEmployeeI9` is set to `true`. +This component is conditionally shown in the `Employee.OnboardingFlow` when `withEmployeeI9` is set to `true`. ```jsx import { Employee } from '@gusto/embedded-react-sdk' @@ -315,10 +315,10 @@ function MyComponent() { #### Props -| Name | Type | Default | Description | -| ------------------- | ------ | ------- | -------------------------------------- | -| employeeId Required | string | | The associated employee identifier. | -| onEvent Required | | | See events table for available events. | +| Name | Type | Default | Description | +| ------------------------- | -------- | ------- | -------------------------------------- | +| **employeeId** (Required) | string | | The associated employee identifier. | +| **onEvent** (Required) | function | | See events table for available events. | #### Events @@ -347,11 +347,11 @@ function MyComponent() { #### Props -| Name | Type | Default | Description | -| ------------------- | ------- | ------- | ---------------------------------------------------------------------------------------------------- | -| employeeId Required | string | | The associated employee identifier. | -| onEvent Required | | | See events table for available events. | -| isAdmin | boolean | false | If the onboarding is being performed by an admin. When false it is configured to be self onboarding. | +| Name | Type | Default | Description | +| ------------------------- | -------- | ------- | ---------------------------------------------------------------------------------------------------- | +| **employeeId** (Required) | string | | The associated employee identifier. | +| **onEvent** (Required) | function | | See events table for available events. | +| **isAdmin** | boolean | false | If the onboarding is being performed by an admin. When false it is configured to be self onboarding. | #### Events diff --git a/docs/workflows-overview/employee-onboarding/employee-self-onboarding.md b/docs/workflows-overview/employee-onboarding/employee-self-onboarding.md index 98999b37b..49d0f0484 100644 --- a/docs/workflows-overview/employee-onboarding/employee-self-onboarding.md +++ b/docs/workflows-overview/employee-onboarding/employee-self-onboarding.md @@ -41,7 +41,7 @@ Like Employee onboarding, self-onboarding components can be used to compose your Displays guidance on what to expect from the workflow and what information the employee will be required to have on hand and provide. -```jsx jsx +```jsx import { Employee } from '@gusto/embedded-react-sdk' function MyApp() { diff --git a/docs/workflows-overview/information-requests.md b/docs/workflows-overview/information-requests.md new file mode 100644 index 000000000..e253aad64 --- /dev/null +++ b/docs/workflows-overview/information-requests.md @@ -0,0 +1,111 @@ +--- +title: Information Requests +order: 5 +--- + +## Overview + +The Information Requests workflow provides components for viewing and responding to information requests from Gusto. Information requests are questions that Gusto needs answered in order to process payroll or complete other operations. They may block payroll processing until resolved. + +### Implementation + +```jsx +import { InformationRequests } from '@gusto/embedded-react-sdk' + +function MyApp() { + return ( + {}} + /> + ) +} +``` + +#### Props + +| 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 | + +## Using Information Request Subcomponents + +Information request components can be used individually or composed into a custom workflow. For guidance on creating a custom workflow, see [docs on composition](../integration-guide/composition.md). + +### Available Subcomponents + +- InformationRequests.InformationRequestList +- InformationRequests.InformationRequestForm + +### InformationRequests.InformationRequestList + +Displays a list of pending information requests for a company. Each request shows its type, status, and whether it is blocking payroll. Requests in a "Pending Response" state have a "Respond" action. + +```jsx +import { InformationRequests } from '@gusto/embedded-react-sdk' + +function MyComponent() { + return ( + {}} + /> + ) +} +``` + +#### Props + +| Name | Type | Description | +| ------------------------ | -------- | ---------------------------------------------- | +| **companyId** (Required) | string | The associated company identifier. | +| **onEvent** (Required) | function | See events table for available events. | + +#### Events + +| Event type | Description | Data | +| --------------------------- | ---------------------------------------------- | --------------------- | +| INFORMATION_REQUEST_RESPOND | Fired when user clicks to respond to a request | { requestId: string } | + +### InformationRequests.InformationRequestForm + +Renders a form for responding to a specific information request. Supports text and document question types. Displays an alert if the request is blocking payroll processing. + +```jsx +import { InformationRequests } from '@gusto/embedded-react-sdk' + +function MyComponent() { + return ( + {}} + /> + ) +} +``` + +#### Props + +| Name | Type | Description | +| ------------------------ | -------- | ------------------------------------------------- | +| **companyId** (Required) | string | The associated company identifier. | +| **requestId** (Required) | string | The information request identifier to respond to. | +| **onEvent** (Required) | function | See events table for available events. | + +#### Events + +| 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 | diff --git a/docs/workflows-overview/run-payroll.md b/docs/workflows-overview/run-payroll.md index d92d84511..67db14266 100644 --- a/docs/workflows-overview/run-payroll.md +++ b/docs/workflows-overview/run-payroll.md @@ -69,6 +69,13 @@ Run payroll components can be used to compose your own workflow, or can be rende - [Payroll.PayrollReceipts](#payrollpayrollreceipts) - [Payroll.PayrollBlocker](#payrollpayrollblocker) - [Payroll.ConfirmWireDetails](#payrollconfirmwiredetails) +- [Payroll.DismissalFlow](#payrolldismissalflow) +- [Payroll.OffCycleFlow](#payrolloffcycleflow) +- [Payroll.OffCycleCreation](#payrolloffcyclecreation) +- [Payroll.TransitionFlow](#payrolltransitionflow) +- [Payroll.TransitionCreation](#payrolltransitioncreation) +- [Payroll.PayrollExecutionFlow](#payrollpayrollexecutionflow) +- [Payroll.RecoveryCases](#payrollrecoverycases) ### Payroll.PayrollLanding @@ -372,3 +379,216 @@ function MyComponent() { | PAYROLL_WIRE_INSTRUCTIONS_SELECT | Fired when user selects a wire-in request | { selectedWireInId: string } | | PAYROLL_WIRE_FORM_DONE | Fired when user completes the wire confirmation | { wireInRequest: [Response from the Submit wire-in request endpoint](https://docs.gusto.com/embedded-payroll/reference/put-wire_in_requests-wire_in_request_uuid) } | | PAYROLL_WIRE_FORM_CANCEL | Fired when user cancels the wire confirmation form | None | + +### Payroll.DismissalFlow + +Orchestrates the dismissal payroll workflow, which processes final pay for a terminated employee. The flow starts with pay period selection and then transitions to payroll execution. Used internally by `Employee.TerminationFlow` when the "Run a dismissal payroll" option is selected. + +```jsx +import { Payroll } from '@gusto/embedded-react-sdk' + +function MyComponent() { + return ( + {}} + /> + ) +} +``` + +#### Props + +| 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. | + +#### Events + +| Event type | Description | Data | +| ----------------------------- | ----------------------------------------------------- | ------------------------ | +| DISMISSAL_PAY_PERIOD_SELECTED | Fired when a pay period is selected for the dismissal | { payrollUuid?: string } | + +### Payroll.OffCycleFlow + +Orchestrates the off-cycle payroll workflow, including creation of the off-cycle payroll and subsequent payroll execution. Off-cycle payrolls are used for bonus payments, corrections, or other payments outside the regular payroll schedule. + +```jsx +import { Payroll } from '@gusto/embedded-react-sdk' + +function MyComponent() { + return {}} /> +} +``` + +#### Props + +| Name | Type | Description | +| ------------------------ | -------- | ---------------------------------------------------------------------- | +| **companyId** (Required) | string | The associated company identifier. | +| **payrollType** | string | The off-cycle payroll reason (e.g., `'bonus'`). Defaults to `'bonus'`. | +| **onEvent** (Required) | function | See events table for available events. | +| **withReimbursements** | boolean | Optional flag to show/hide reimbursements fields. Defaults to true. | + +#### Events + +| Event type | Description | Data | +| ----------------- | ------------------------------------------ | ------------------------ | +| OFF_CYCLE_CREATED | Fired when an off-cycle payroll is created | { payrollUuid?: string } | + +### Payroll.OffCycleCreation + +A standalone form for creating an off-cycle payroll. This is the lower-level building block used internally by `Payroll.OffCycleFlow`. Use this component directly when you need custom control over the off-cycle creation step. + +```jsx +import { Payroll } from '@gusto/embedded-react-sdk' + +function MyComponent() { + return {}} /> +} +``` + +#### Props + +| Name | Type | Description | +| ------------------------ | -------- | -------------------------------------------------------------------- | +| **companyId** (Required) | string | The associated company identifier. | +| **payrollType** | string | The off-cycle payroll type (e.g., `'bonus'`). Defaults to `'bonus'`. | +| **onEvent** (Required) | function | See events table for available events. | + +#### Events + +| Event type | Description | Data | +| ----------------- | ------------------------------------------- | ----------------------- | +| OFF_CYCLE_CREATED | Fired when the off-cycle payroll is created | { payrollUuid: string } | + +### Payroll.TransitionFlow + +Orchestrates the transition payroll workflow. Transition payrolls are used when a company changes pay schedules and needs to process payroll for the transitional pay period between the old and new schedules. + +```jsx +import { Payroll } from '@gusto/embedded-react-sdk' + +function MyComponent() { + return ( + {}} + /> + ) +} +``` + +#### 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. | + +#### Events + +| Event type | Description | Data | +| ------------------ | -------------------------------------------- | ------------------------ | +| TRANSITION_CREATED | Fired when the transition payroll is created | { payrollUuid?: string } | + +### Payroll.TransitionCreation + +A standalone form for creating a transition payroll. This is the lower-level building block used internally by `Payroll.TransitionFlow`. + +```jsx +import { Payroll } from '@gusto/embedded-react-sdk' + +function MyComponent() { + return ( + {}} + /> + ) +} +``` + +#### 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. | + +#### Events + +| Event type | Description | Data | +| ------------------ | -------------------------------------------- | ----------------------- | +| TRANSITION_CREATED | Fired when the transition payroll is created | { payrollUuid: string } | + +### Payroll.PayrollExecutionFlow + +Orchestrates the full payroll execution process from configuration through submission and processing. This component is used internally by `Payroll.PayrollFlow`, `Payroll.DismissalFlow`, `Payroll.OffCycleFlow`, and `Payroll.TransitionFlow`. Use it directly when you need to start the execution flow from a known payroll ID. + +```jsx +import { Payroll } from '@gusto/embedded-react-sdk' + +function MyComponent() { + return ( + {}} + /> + ) +} +``` + +#### 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. | + +### Payroll.RecoveryCases + +Displays and manages recovery cases for a company. Recovery cases occur when a payroll debit fails (e.g., insufficient funds) and Gusto needs to recover the funds. The component allows users to view recovery case details and initiate re-debits. + +```jsx +import { Payroll } from '@gusto/embedded-react-sdk' + +function MyComponent() { + return +} +``` + +#### Props + +| Name | Type | Description | +| ------------------------ | -------- | ---------------------------------- | +| **companyId** (Required) | string | The associated company identifier. | +| **onEvent** | function | Optional event handler. | + +#### Events + +| Event type | Description | Data | +| ----------------------------- | --------------------------------------------------- | -------------------------- | +| RECOVERY_CASE_RESOLVE | Fired when user initiates resolving a recovery case | { recoveryCaseId: string } | +| RECOVERY_CASE_RESUBMIT_DONE | Fired when a re-debit is successfully submitted | None | +| RECOVERY_CASE_RESUBMIT_CANCEL | Fired when user cancels the re-debit process | None | diff --git a/docs/workflows-overview/workflows-overview.md b/docs/workflows-overview/workflows-overview.md index 1df5b1ae5..6067663b1 100644 --- a/docs/workflows-overview/workflows-overview.md +++ b/docs/workflows-overview/workflows-overview.md @@ -26,7 +26,7 @@ Workflows are incredibly simple to add to your application. A single React compo In this example we incorporate the entire employee onboarding flow in our application. This component represents multiple steps including inputting profile details, taxes, and payment info. It can be implemented as follows: ```jsx -import { EmployeeOnboardingFlow } from '@gusto/embedded-react-sdk'; +import { Employee } from '@gusto/embedded-react-sdk'; function MyApp({ companyId }) { return( @@ -35,11 +35,10 @@ function MyApp({ companyId }) { baseUrl: `/myapp/`, }} > - {...}} /> + {...}} /> ); } - ``` This example renders a fully functional flow with the following steps: diff --git a/e2e/package-lock.json b/e2e/package-lock.json new file mode 100644 index 000000000..244c8924c --- /dev/null +++ b/e2e/package-lock.json @@ -0,0 +1,2439 @@ +{ + "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/website/.gitignore b/website/.gitignore new file mode 100644 index 000000000..b56921af6 --- /dev/null +++ b/website/.gitignore @@ -0,0 +1,6 @@ +node_modules/ +.docusaurus/ +build/ +.cache-loader/ +package-lock.json +openapi/ diff --git a/website/docusaurus.config.ts b/website/docusaurus.config.ts new file mode 100644 index 000000000..61fcc8f52 --- /dev/null +++ b/website/docusaurus.config.ts @@ -0,0 +1,168 @@ +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', + tagline: 'Embedded Payroll React SDK Documentation', + favicon: 'img/favicon.svg', + + url: 'http://localhost', + baseUrl: '/', + + onBrokenLinks: 'warn', + + markdown: { + format: 'detect', + }, + + i18n: { + defaultLocale: 'en', + locales: ['en'], + }, + + themes: [ + [ + require.resolve('@easyops-cn/docusaurus-search-local'), + { + hashed: true, + indexBlog: false, + docsRouteBasePath: '/docs', + docsDir: '../docs', + }, + ], + 'docusaurus-theme-openapi-docs', + ], + + presets: [ + [ + 'classic', + { + docs: { + path: '../docs', + routeBasePath: 'docs', + sidebarPath: './sidebars.ts', + breadcrumbs: true, + docItemComponent: '@theme/ApiItem', + }, + blog: false, + theme: { + customCss: ['./src/css/custom.css'], + }, + } satisfies Preset.Options, + ], + ], + + plugins: [ + function webpackPolyfills() { + return { + name: 'webpack-node-polyfills', + configureWebpack() { + return { + resolve: { + fallback: { + path: require.resolve('path-browserify'), + }, + }, + }; + }, + }; + }, + [ + 'docusaurus-plugin-openapi-docs', + { + id: 'api', + docsPluginId: 'classic', + config: { + gustoEmbedded: { + specPath: './openapi/gusto-embedded.yaml', + outputDir: '../docs/api', + sidebarOptions: { + groupPathsBy: 'tag', + categoryLinkSource: 'tag', + }, + } satisfies OpenApiPlugin.Options, + } satisfies Plugin.PluginOptions, + }, + ], + ], + + themeConfig: { + colorMode: { + defaultMode: 'light', + respectPrefersColorScheme: false, + }, + navbar: { + title: 'SDK', + logo: { + alt: 'Gusto Embedded SDK', + src: 'img/gusto-logo.svg', + }, + items: [ + { + type: 'docSidebar', + sidebarId: 'docs', + position: 'left', + label: 'Guides', + }, + { + type: 'docSidebar', + sidebarId: 'api', + position: 'left', + label: 'API Reference', + }, + { + href: 'https://github.com/Gusto/embedded-react-sdk', + label: 'GitHub', + position: 'right', + }, + ], + }, + footer: { + style: 'dark', + links: [ + { + title: 'Guides', + items: [ + { label: 'What is the SDK?', to: '/docs/what-is-the-gep-react-sdk' }, + { label: 'Getting Started', to: '/docs/getting-started/getting-started' }, + { label: 'Integration Guide', to: '/docs/integration-guide/integration-guide' }, + { label: 'Workflows', to: '/docs/workflows-overview/workflows-overview' }, + ], + }, + { + title: 'Customization', + items: [ + { label: 'Theming', to: '/docs/theming/theming' }, + { label: 'Component Adapter', to: '/docs/component-adapter/component-adapter' }, + { label: 'Hooks (Experimental)', to: '/docs/hooks/hooks' }, + ], + }, + { + title: 'Resources', + items: [ + { label: 'API Reference', to: '/docs/api/companies' }, + { + label: 'GitHub', + href: 'https://github.com/Gusto/embedded-react-sdk', + }, + { + label: 'Gusto Developer Portal', + href: 'https://docs.gusto.com/embedded-payroll/docs/introduction', + }, + ], + }, + ], + copyright: `Copyright © ${new Date().getFullYear()} Gusto, Inc.`, + }, + prism: { + theme: prismThemes.github, + darkTheme: prismThemes.dracula, + additionalLanguages: ['bash', 'json', 'ruby', 'python', 'java'], + }, + } satisfies Preset.ThemeConfig, +}; + +export default config; diff --git a/website/package.json b/website/package.json new file mode 100644 index 000000000..520f5ada3 --- /dev/null +++ b/website/package.json @@ -0,0 +1,52 @@ +{ + "name": "embedded-react-sdk-docs", + "version": "0.0.0", + "private": true, + "scripts": { + "docusaurus": "docusaurus", + "start": "docusaurus start", + "build": "docusaurus build", + "swizzle": "docusaurus swizzle", + "deploy": "docusaurus deploy", + "clear": "docusaurus clear", + "serve": "docusaurus serve", + "download:openapi": "curl -sf -o openapi/gusto-embedded.yaml https://raw.githubusercontent.com/Gusto/gusto-typescript-client/main/.speakeasy/logs/changes/new.openapi.yaml", + "gen-api-docs": "docusaurus gen-api-docs all", + "clean-api-docs": "docusaurus clean-api-docs all", + "prebuild": "npm run download:openapi && npm run gen-api-docs" + }, + "dependencies": { + "@docusaurus/core": "^3.7.0", + "@docusaurus/preset-classic": "^3.7.0", + "@easyops-cn/docusaurus-search-local": "^0.55.1", + "@mdx-js/react": "^3.0.0", + "clsx": "^2.0.0", + "docusaurus-plugin-openapi-docs": "^4.7.1", + "docusaurus-theme-openapi-docs": "^4.7.1", + "path-browserify": "^1.0.1", + "prism-react-renderer": "^2.3.0", + "react": "^18.0.0", + "react-dom": "^18.0.0" + }, + "devDependencies": { + "@docusaurus/module-type-aliases": "^3.7.0", + "@docusaurus/tsconfig": "^3.7.0", + "@docusaurus/types": "^3.7.0", + "typescript": "~5.8.0" + }, + "browserslist": { + "production": [ + ">0.5%", + "not dead", + "not op_mini all" + ], + "development": [ + "last 3 chrome version", + "last 3 firefox version", + "last 5 safari version" + ] + }, + "engines": { + "node": ">=18.0" + } +} diff --git a/website/sidebars.ts b/website/sidebars.ts new file mode 100644 index 000000000..23022637b --- /dev/null +++ b/website/sidebars.ts @@ -0,0 +1,132 @@ +import type { SidebarsConfig } from '@docusaurus/plugin-content-docs'; +import apiSidebar from '../docs/api/sidebar'; + +const sidebars: SidebarsConfig = { + docs: [ + 'what-is-the-gep-react-sdk', + { + type: 'category', + label: 'Deciding to Build with the SDK', + link: { + type: 'doc', + id: 'deciding-to-build-with-the-sdk/deciding-to-build-with-the-sdk', + }, + items: [ + 'deciding-to-build-with-the-sdk/build-pathways-sdk-flows-api', + 'deciding-to-build-with-the-sdk/component-types', + ], + }, + { + type: 'category', + label: 'Getting Started', + link: { + type: 'doc', + id: 'getting-started/getting-started', + }, + items: [ + 'getting-started/authentication', + 'getting-started/proxy-security-partner-guidance', + ], + }, + { + type: 'category', + label: 'Integration Guide', + link: { + type: 'doc', + id: 'integration-guide/integration-guide', + }, + items: [ + 'integration-guide/versioning', + 'integration-guide/event-handling', + 'integration-guide/event-types', + 'integration-guide/composition', + 'integration-guide/providing-your-own-data', + 'integration-guide/translation', + 'integration-guide/routing', + 'integration-guide/error-handling', + 'integration-guide/request-interceptors', + 'integration-guide/customizing-sdk-ui', + 'integration-guide/observability', + 'integration-guide/observability-examples', + ], + }, + { + type: 'category', + label: 'Workflows', + link: { + type: 'doc', + id: 'workflows-overview/workflows-overview', + }, + items: [ + { + type: 'category', + label: 'Employee Onboarding', + link: { + type: 'doc', + id: 'workflows-overview/employee-onboarding/employee-onboarding', + }, + items: [ + 'workflows-overview/employee-onboarding/employee-self-onboarding', + ], + }, + 'workflows-overview/company-onboarding', + 'workflows-overview/contractor-onboarding', + 'workflows-overview/contractor-payments', + 'workflows-overview/run-payroll', + 'workflows-overview/employee-termination', + 'workflows-overview/information-requests', + ], + }, + { + type: 'category', + label: 'Component Adapter', + link: { + type: 'doc', + id: 'component-adapter/component-adapter', + }, + items: [ + 'component-adapter/how-the-component-adapter-works', + 'component-adapter/setting-up-your-component-adapter', + 'component-adapter/component-adapter-faq', + 'component-adapter/component-adapter-types', + 'component-adapter/component-inventory', + ], + }, + { + type: 'category', + label: 'Theming', + link: { + type: 'doc', + id: 'theming/theming', + }, + items: [ + 'theming/theming-guide', + 'theming/theme-variables', + ], + }, + { + type: 'category', + label: 'Hooks (Experimental)', + link: { + type: 'doc', + id: 'hooks/hooks', + }, + items: [ + 'hooks/useEmployeeDetailsForm', + 'hooks/useCompensationForm', + 'hooks/useWorkAddressForm', + ], + }, + { + type: 'category', + label: 'Reference', + items: [ + 'reference/endpoint-reference', + 'reference/proxy-examples', + ], + }, + ], + api: apiSidebar, +}; + +export default sidebars; diff --git a/website/src/css/custom.css b/website/src/css/custom.css new file mode 100644 index 000000000..df72e6ce0 --- /dev/null +++ b/website/src/css/custom.css @@ -0,0 +1,532 @@ +@import url('https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600;700&display=swap'); + +html { + scrollbar-gutter: stable; +} + +:root { + --ifm-color-primary: #f45d48; + --ifm-color-primary-dark: #f24430; + --ifm-color-primary-darker: #f13724; + --ifm-color-primary-darkest: #d91f0c; + --ifm-color-primary-light: #f67660; + --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-heading-font-family: var(--ifm-font-family-base); + --ifm-font-size-base: 15px; + --ifm-code-font-size: 95%; + + --ifm-navbar-background-color: #1b1b1d; + --ifm-navbar-link-color: #ffffff; + --ifm-navbar-link-hover-color: #f45d48; + --ifm-navbar-height: 3.75rem; + + --ifm-link-color: #f45d48; + --ifm-link-hover-color: #d91f0c; + --ifm-breadcrumb-color-active: #f45d48; + + --ifm-toc-border-color: #ebedf0; + --ifm-table-stripe-background: #f9f9fa; + --ifm-table-border-color: #e0e0e0; + --ifm-hr-border-color: #ebedf0; + + --gusto-sidebar-category-color: #525860; + --gusto-table-header-bg: #eef0f2; + --gusto-pagination-border: #ebedf0; + --gusto-code-block-bg: #f7f7f8; + --gusto-sidebar-active-border: #f45d48; + + --docusaurus-highlighted-code-line-bg: rgba(244, 93, 72, 0.1); +} + +[data-theme='dark'] { + --ifm-color-primary: #ff7a68; + --ifm-color-primary-dark: #ff5c46; + --ifm-color-primary-darker: #ff4d35; + --ifm-color-primary-darkest: #ff2003; + --ifm-color-primary-light: #ff988a; + --ifm-color-primary-lighter: #ffa89b; + --ifm-color-primary-lightest: #ffd6cf; + + --ifm-background-color: #1b1b1d; + --ifm-background-surface-color: #242427; + + --ifm-navbar-background-color: #18181a; + + --ifm-link-color: #ff7a68; + --ifm-link-hover-color: #ff998c; + --ifm-breadcrumb-color-active: #ff7a68; + + --ifm-toc-border-color: #3a3a3d; + --ifm-table-stripe-background: #2a2a2d; + --ifm-table-border-color: #3a3a3d; + --ifm-hr-border-color: #3a3a3d; + + --gusto-sidebar-category-color: #9a9da3; + --gusto-table-header-bg: #2a2a2d; + --gusto-pagination-border: #3a3a3d; + --gusto-code-block-bg: #2a2a2d; + --gusto-sidebar-active-border: #ff7a68; + + --docusaurus-highlighted-code-line-bg: rgba(255, 122, 104, 0.15); +} + +/* ── Navbar ── */ + +.navbar { + box-shadow: none; + border-bottom: 1px solid rgba(255, 255, 255, 0.08); + padding: 0 1.5rem; +} + +.navbar__title { + font-size: 1.1rem; + font-weight: 300; + color: rgba(255, 255, 255, 0.5); + margin-left: -0.15rem; +} + +.navbar__inner { + max-width: 1400px; + margin: 0 auto; +} + +.navbar__link { + font-weight: 500; + font-size: 0.9rem; +} + +.navbar__link--active { + color: #ffffff; +} + +.navbar__link[href*="://"]::after { + background-color: currentColor; +} + +.navbar__link, +.navbar__link svg { + color: var(--ifm-navbar-link-color); +} + +.navbar__logo img { + height: 28px; + width: auto; +} + +[data-theme='dark'] .navbar { + border-bottom-color: rgba(255, 255, 255, 0.06); +} + +/* ── Search bar (always dark since navbar is always dark) ── */ + +.navbar .DocSearch-Button, +.navbar .aa-DetachedSearchButton, +.navbar .search-bar-container input, +nav .search-bar-container input { + border-radius: 20px; + background-color: rgba(255, 255, 255, 0.1); + 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; +} + +.navbar .DocSearch-Button:hover, +.navbar .aa-DetachedSearchButton:hover, +.navbar .search-bar-container input:focus, +nav .search-bar-container input:focus { + background-color: rgba(255, 255, 255, 0.15); + border-color: rgba(255, 255, 255, 0.25); +} + +.navbar .search-bar-container .search-icon { + color: rgba(255, 255, 255, 0.6); +} + +.navbar .search-bar-container .search-shortcut { + color: rgba(255, 255, 255, 0.4); + border-color: rgba(255, 255, 255, 0.2); + background: transparent; +} + +/* ── Sidebar ── */ + +.theme-doc-sidebar-container { + border-right: 1px solid var(--ifm-toc-border-color); +} + +.menu__link { + font-size: 0.875rem; + font-weight: 400; + border-radius: 0; + padding: 7px 12px; + border-left: 3px solid transparent; + transition: background-color 0.15s ease, color 0.15s ease, + border-color 0.15s ease; +} + +.menu__link--active:not(.menu__link--sublist) { + background-color: transparent; + color: var(--ifm-color-primary); + font-weight: 500; + border-left-color: var(--gusto-sidebar-active-border); +} + +[data-theme='dark'] .menu__link--active:not(.menu__link--sublist) { + background-color: transparent; +} + +.menu__link:hover { + color: var(--ifm-color-primary); + background-color: rgba(244, 93, 72, 0.04); +} + +[data-theme='dark'] .menu__link:hover { + background-color: rgba(255, 122, 104, 0.06); +} + +.menu__list-item-collapsible .menu__link--sublist { + font-weight: 600; + text-transform: uppercase; + font-size: 0.7rem; + letter-spacing: 0.06em; + color: var(--gusto-sidebar-category-color); + margin-top: 1.25rem; + border-left: none; +} + +.menu__list-item-collapsible:first-child .menu__link--sublist { + margin-top: 0; +} + +.menu__list .menu__list { + padding-left: 0.75rem; +} + +/* ── Content ── */ + +.markdown h1:first-child { + font-size: 2rem; + font-weight: 700; +} + +.markdown h2 { + font-size: 1.5rem; + font-weight: 600; + margin-top: 2.5rem; + padding-bottom: 0.4rem; + border-bottom: 1px solid var(--ifm-toc-border-color); +} + +.markdown h3 { + font-size: 1.2rem; + font-weight: 600; + margin-top: 1.75rem; +} + +.markdown > p { + line-height: 1.7; +} + +/* ── Tables ── */ + +.markdown table { + display: table; + width: 100%; + border-collapse: collapse; + font-size: 0.9rem; +} + +.markdown table th { + background-color: var(--gusto-table-header-bg); + font-weight: 600; + text-align: left; + padding: 12px 16px; + border: 1px solid var(--ifm-table-border-color); +} + +.markdown table td { + padding: 12px 16px; + border: 1px solid var(--ifm-table-border-color); + vertical-align: top; +} + +.markdown table tr:nth-child(even) { + background-color: var(--ifm-table-stripe-background); +} + +/* ── Code blocks ── */ + +.prism-code { + font-size: 0.85rem; + border-radius: 8px; +} + +div[class^='codeBlockContainer'] { + border-radius: 8px; + overflow: hidden; + border: 1px solid #e5e7eb; + box-shadow: 0 1px 4px rgba(0, 0, 0, 0.06); +} + +[data-theme='dark'] div[class^='codeBlockContainer'] { + box-shadow: 0 1px 3px rgba(0, 0, 0, 0.3); + border: 1px solid #3a3a3d; +} + +code { + border-radius: 4px; + padding: 2px 6px; + font-size: 0.875em; +} + +[data-theme='dark'] code { + background-color: rgba(255, 255, 255, 0.13); +} + +/* ── Table of contents (right sidebar) ── */ + +.table-of-contents__link--active { + color: var(--ifm-color-primary); + font-weight: 500; +} + +.table-of-contents__link:hover { + color: var(--ifm-color-primary); +} + +.table-of-contents { + font-size: 0.85rem; +} + +/* ── Breadcrumbs ── */ + +.breadcrumbs__link { + font-size: 0.8rem; +} + +.breadcrumbs__item--active .breadcrumbs__link { + background-color: transparent; + color: var(--ifm-color-primary); + font-weight: 600; +} + +[data-theme='dark'] .breadcrumbs__item--active .breadcrumbs__link { + background-color: transparent; +} + +/* ── Footer ── */ + +.footer--dark { + background-color: #111113; + border-top: 1px solid rgba(255, 255, 255, 0.08); +} + +.footer__links { + margin-bottom: 1.5rem; +} + +.footer__title { + font-size: 0.75rem; + text-transform: uppercase; + letter-spacing: 0.06em; + font-weight: 600; + color: rgba(255, 255, 255, 0.5); + margin-bottom: 0.75rem; +} + +.footer__item { + margin-bottom: 0.4rem; +} + +.footer__link-item { + font-size: 0.875rem; + color: rgba(255, 255, 255, 0.7); + transition: color 0.15s ease; +} + +.footer__link-item:hover { + color: #ffffff; + text-decoration: none; +} + +.footer__copyright { + font-size: 0.85rem; + opacity: 0.5; + padding-top: 1.5rem; + 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; +} + +.pagination-nav__link:hover { + border-color: var(--ifm-color-primary); + box-shadow: 0 2px 8px rgba(244, 93, 72, 0.1); +} + +[data-theme='dark'] .pagination-nav__link:hover { + box-shadow: 0 2px 8px rgba(255, 122, 104, 0.1); +} + +.pagination-nav__sublabel { + font-size: 0.75rem; + text-transform: uppercase; + letter-spacing: 0.05em; +} + +/* ── Admonitions ── */ + +.alert { + border-radius: 8px; +} + +[data-theme='dark'] .alert--info { + --ifm-alert-background-color: rgba(84, 199, 236, 0.1); + --ifm-alert-border-color: rgba(84, 199, 236, 0.3); +} + +[data-theme='dark'] .alert--warning { + --ifm-alert-background-color: rgba(255, 186, 0, 0.1); + --ifm-alert-border-color: rgba(255, 186, 0, 0.3); +} + +[data-theme='dark'] .alert--danger { + --ifm-alert-background-color: rgba(250, 56, 56, 0.1); + --ifm-alert-border-color: rgba(250, 56, 56, 0.3); +} + +/* ── Scrollbar (dark mode) ── */ + +[data-theme='dark'] ::-webkit-scrollbar { + width: 8px; + height: 8px; +} + +[data-theme='dark'] ::-webkit-scrollbar-track { + background: transparent; +} + +[data-theme='dark'] ::-webkit-scrollbar-thumb { + background: #4a4a4d; + border-radius: 4px; +} + +[data-theme='dark'] ::-webkit-scrollbar-thumb:hover { + background: #5a5a5d; +} + +/* ── Dark mode toggle in navbar ── */ + +.navbar__items .clean-btn[class*='toggle'] svg { + color: #ffffff; +} + +/* ── API sidebar method badges ── */ + +.api-method > .menu__link, +.schema > .menu__link { + align-items: center; + justify-content: start; +} + +.api-method > .menu__link::before, +.schema > .menu__link::before { + width: 55px; + height: 20px; + font-size: 12px; + line-height: 20px; + text-transform: uppercase; + font-weight: 600; + border-radius: 0.25rem; + border: 1px solid transparent; + margin-right: var(--ifm-spacing-horizontal); + text-align: center; + flex-shrink: 0; + color: white; +} + +.get > .menu__link::before { + content: 'get'; + background-color: var(--openapi-code-green, #009d77); +} + +.post > .menu__link::before { + content: 'post'; + background-color: var(--openapi-code-blue, #0072ce); +} + +.put > .menu__link::before { + content: 'put'; + background-color: var(--openapi-code-orange, #d97706); +} + +.delete > .menu__link::before { + content: 'del'; + background-color: var(--openapi-code-red, #dc2626); +} + +.patch > .menu__link::before { + content: 'patch'; + background-color: var(--openapi-code-orange, #d97706); +} + +.head > .menu__link::before { + content: 'head'; + background-color: var(--ifm-color-secondary-darkest, #6b7280); +} + +.schema > .menu__link::before { + content: 'schema'; + background-color: var(--ifm-color-secondary-darkest, #6b7280); +} + +/* ── API tag page cards ── */ + +.docItemContainer article .card { + border-radius: 10px; + border: 1px solid #ebedf0; + transition: border-color 0.15s ease, box-shadow 0.15s ease; + overflow: hidden; +} + +.docItemContainer article .card:hover { + border-color: var(--ifm-color-primary); + box-shadow: 0 3px 12px rgba(244, 93, 72, 0.08); +} + +[data-theme='dark'] .docItemContainer article .card { + border-color: #3a3a3d; + background-color: #242427; +} + +[data-theme='dark'] .docItemContainer article .card:hover { + border-color: var(--ifm-color-primary); + box-shadow: 0 3px 12px rgba(255, 122, 104, 0.08); +} + +.docItemContainer article .card .card__header h2 { + font-size: 1rem; + white-space: normal; + word-break: break-word; + overflow-wrap: break-word; +} + +.docItemContainer article .card .card__body { + font-size: 0.85rem; + color: #525860; +} + +[data-theme='dark'] .docItemContainer article .card .card__body { + color: #9a9da3; +} diff --git a/website/src/pages/index.module.css b/website/src/pages/index.module.css new file mode 100644 index 000000000..012664015 --- /dev/null +++ b/website/src/pages/index.module.css @@ -0,0 +1,344 @@ +/* ── Hero ── */ + +.hero { + padding: 5rem 2rem 4rem; + text-align: center; + background: linear-gradient(180deg, #f5f3f1 0%, #ffffff 100%); + border-bottom: 1px solid #ebedf0; +} + +[data-theme='dark'] .hero { + background: linear-gradient(180deg, #1b1b1d 0%, #242427 100%); + border-bottom-color: #3a3a3d; +} + +.heroInner { + max-width: 720px; + margin: 0 auto; +} + +.heroBrand { + display: flex; + align-items: baseline; + justify-content: center; + gap: 0.6rem; + margin-bottom: 1.5rem; + flex-wrap: wrap; +} + +.heroLogo { + height: 36px; + width: auto; +} + +.heroLogoDark { + display: block; +} + +.heroLogoLight { + display: none; +} + +[data-theme='dark'] .heroLogoDark { + display: none; +} + +[data-theme='dark'] .heroLogoLight { + display: block; +} + +.heroSdkLabel { + font-size: 1.6rem; + font-weight: 300; + letter-spacing: -0.01em; + color: #8a8a8d; + position: relative; + top: -2px; +} + +[data-theme='dark'] .heroSdkLabel { + color: #6a6a6d; +} + +.heroTagline { + font-size: 1.25rem; + line-height: 1.6; + color: #525860; + margin-bottom: 2rem; + max-width: 560px; + margin-left: auto; + margin-right: auto; +} + +[data-theme='dark'] .heroTagline { + color: #9a9da3; +} + +.heroActions { + display: flex; + gap: 1rem; + justify-content: center; + margin-bottom: 2rem; +} + +.heroPrimary { + display: inline-flex; + align-items: center; + padding: 0.75rem 2rem; + background-color: #f45d48; + color: #ffffff; + border-radius: 8px; + font-weight: 600; + font-size: 1rem; + text-decoration: none; + transition: background-color 0.15s ease, transform 0.1s ease; +} + +.heroPrimary:hover { + background-color: #d91f0c; + color: #ffffff; + text-decoration: none; + transform: translateY(-1px); +} + +.heroSecondary { + display: inline-flex; + align-items: center; + padding: 0.75rem 2rem; + background-color: transparent; + color: #1b1b1d; + border: 1px solid #d0d0d3; + border-radius: 8px; + font-weight: 600; + font-size: 1rem; + text-decoration: none; + transition: border-color 0.15s ease, color 0.15s ease, transform 0.1s ease; +} + +.heroSecondary:hover { + border-color: #f45d48; + color: #f45d48; + text-decoration: none; + transform: translateY(-1px); +} + +[data-theme='dark'] .heroSecondary { + color: #ffffff; + border-color: #4a4a4d; +} + +[data-theme='dark'] .heroSecondary:hover { + border-color: #ff7a68; + color: #ff7a68; +} + +.heroInstall { + display: inline-block; +} + +.heroInstall code { + display: inline-block; + padding: 0.5rem 1.25rem; + background-color: #1b1b1d; + border: 1px solid #1b1b1d; + border-radius: 6px; + font-size: 0.9rem; + color: #e0e0e3; + user-select: all; +} + +[data-theme='dark'] .heroInstall code { + background-color: #111113; + border-color: #3a3a3d; + color: #c0c0c3; +} + +/* ── Features ── */ + +.features { + padding: 4rem 2rem; + background-color: #ffffff; +} + +[data-theme='dark'] .features { + background-color: #1b1b1d; +} + +.featuresInner { + max-width: 1100px; + margin: 0 auto; +} + +.featuresGrid { + display: grid; + grid-template-columns: repeat(4, 1fr); + gap: 1.5rem; +} + +@media (max-width: 996px) { + .featuresGrid { + grid-template-columns: repeat(2, 1fr); + } +} + +@media (max-width: 600px) { + .featuresGrid { + grid-template-columns: 1fr; + } + + .heroActions { + flex-direction: column; + align-items: center; + } +} + +.featureCard { + padding: 1.5rem; + background-color: #faf9f8; + border: 1px solid #dfe1e5; + border-radius: 12px; + transition: border-color 0.15s ease, box-shadow 0.15s ease; +} + +.featureCard:hover { + border-color: #f45d48; + box-shadow: 0 4px 16px rgba(244, 93, 72, 0.1); +} + +[data-theme='dark'] .featureCard { + border-color: #3a3a3d; + background-color: #242427; +} + +[data-theme='dark'] .featureCard:hover { + border-color: #ff7a68; + box-shadow: 0 4px 16px rgba(255, 122, 104, 0.08); +} + +.featureIcon { + display: block; + margin-bottom: 0.75rem; + color: #f45d48; +} + +[data-theme='dark'] .featureIcon { + color: #ff7a68; +} + +.featureTitle { + font-size: 1.1rem; + font-weight: 600; + margin-bottom: 0.5rem; + color: #1b1b1d; +} + +[data-theme='dark'] .featureTitle { + color: #ffffff; +} + +.featureDescription { + font-size: 0.9rem; + line-height: 1.6; + color: #525860; + margin: 0; +} + +[data-theme='dark'] .featureDescription { + color: #9a9da3; +} + +/* ── Quick links ── */ + +.quickLinks { + padding: 4rem 2rem 5rem; + background-color: #f2f0ee; +} + +[data-theme='dark'] .quickLinks { + background-color: #242427; +} + +.quickLinksInner { + max-width: 1100px; + margin: 0 auto; +} + +.quickLinksTitle { + text-align: center; + font-size: 1.5rem; + font-weight: 700; + margin-bottom: 2rem; + color: #1b1b1d; +} + +[data-theme='dark'] .quickLinksTitle { + color: #ffffff; +} + +.quickLinksGrid { + display: grid; + grid-template-columns: repeat(4, 1fr); + gap: 1.25rem; +} + +@media (max-width: 996px) { + .quickLinksGrid { + grid-template-columns: repeat(2, 1fr); + } +} + +@media (max-width: 600px) { + .quickLinksGrid { + grid-template-columns: 1fr; + } +} + +.quickLinkCard { + display: block; + padding: 1.25rem 1.5rem; + background-color: #ffffff; + border: 1px solid #dfe1e5; + 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; +} + +.quickLinkCard:hover { + border-color: #f45d48; + box-shadow: 0 4px 14px rgba(244, 93, 72, 0.12); + text-decoration: none; + transform: translateY(-2px); +} + +[data-theme='dark'] .quickLinkCard { + background-color: #1b1b1d; + border-color: #3a3a3d; +} + +[data-theme='dark'] .quickLinkCard:hover { + border-color: #ff7a68; + box-shadow: 0 3px 12px rgba(255, 122, 104, 0.1); +} + +.quickLinkCard h3 { + font-size: 1rem; + font-weight: 600; + margin-bottom: 0.35rem; + color: #1b1b1d; +} + +[data-theme='dark'] .quickLinkCard h3 { + color: #ffffff; +} + +.quickLinkCard p { + font-size: 0.85rem; + color: #525860; + margin: 0; + line-height: 1.5; +} + +[data-theme='dark'] .quickLinkCard p { + color: #9a9da3; +} diff --git a/website/src/pages/index.tsx b/website/src/pages/index.tsx new file mode 100644 index 000000000..1b4a3368b --- /dev/null +++ b/website/src/pages/index.tsx @@ -0,0 +1,190 @@ +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 ( + + + + + + + + + ); +} + +function PaletteIcon({ className }: { className?: string }) { + return ( + + + + + + + + ); +} + +function SignalIcon({ className }: { className?: string }) { + return ( + + + + + + + + ); +} + +function GearIcon({ className }: { className?: string }) { + return ( + + + + + ); +} + +interface Feature { + title: string; + description: string; + icon: (props: { className?: string }) => ReactNode; +} + +const features: Feature[] = [ + { + title: 'Pre-built Workflows', + description: + 'Complete multi-step flows for employee onboarding, payroll, contractor management, and more — ready to drop into your app.', + icon: WorkflowIcon, + }, + { + title: 'Full UI Control', + description: + 'Use theming, component adapters, and composition to match your design system. Native React components, not iframes.', + icon: PaletteIcon, + }, + { + title: 'Event-driven', + description: + 'Every component emits typed events for user actions and API responses. Drive navigation, analytics, and side effects.', + icon: SignalIcon, + }, + { + title: 'Built-in Business Logic', + description: + 'API calls, form validation, error handling, and state transitions are managed internally with React Query, react-hook-form, and Zod.', + icon: GearIcon, + }, +]; + +function HeroSection() { + const { siteConfig } = useDocusaurusContext(); + + return ( +
+
+
+ {siteConfig.title} + {siteConfig.title} + SDK +
+

+ A React component library for building embedded payroll experiences on + top of the Gusto Embedded API. +

+
+ + Get Started + + + Learn More + +
+
+ npm install @gusto/embedded-react-sdk +
+
+
+ ); +} + +function FeaturesSection() { + return ( +
+
+
+ {features.map((feature) => ( +
+ +

{feature.title}

+

{feature.description}

+
+ ))} +
+
+
+ ); +} + +function QuickLinksSection() { + return ( +
+
+

Explore the SDK

+
+ +

Workflows

+

+ Employee onboarding, payroll, contractor payments, and more. +

+ + +

Integration Guide

+

+ Events, composition, theming, routing, and error handling. +

+ + +

API Reference

+

+ Full OpenAPI documentation for the Gusto Embedded API. +

+ + +

GitHub

+

+ Source code, issues, and contributions. +

+ +
+
+
+ ); +} + +export default function Home(): JSX.Element { + const { siteConfig } = useDocusaurusContext(); + + return ( + + + + + + ); +} diff --git a/website/src/theme/NotFound/Content/index.tsx b/website/src/theme/NotFound/Content/index.tsx new file mode 100644 index 000000000..343730fb6 --- /dev/null +++ b/website/src/theme/NotFound/Content/index.tsx @@ -0,0 +1,44 @@ +import Link from '@docusaurus/Link'; +import Heading from '@theme/Heading'; +import clsx from 'clsx'; +import styles from './styles.module.css'; + +export default function NotFoundContent(): JSX.Element { + return ( +
+
+ + Page Not Found + +

+ The page you're looking for doesn't exist or has been moved. +

+
+ + Go to Home + + + Browse Docs + +
+
+

Popular pages:

+
    +
  • + Getting Started +
  • +
  • + Integration Guide +
  • +
  • + API Reference +
  • +
  • + Workflows +
  • +
+
+
+
+ ); +} diff --git a/website/src/theme/NotFound/Content/styles.module.css b/website/src/theme/NotFound/Content/styles.module.css new file mode 100644 index 000000000..03b9eebd5 --- /dev/null +++ b/website/src/theme/NotFound/Content/styles.module.css @@ -0,0 +1,144 @@ +.root { + display: flex; + align-items: center; + justify-content: center; + min-height: 60vh; + padding: 3rem 2rem; +} + +.container { + text-align: center; + max-width: 480px; +} + +.title { + font-size: 2.5rem; + font-weight: 700; + margin-bottom: 0.75rem; +} + +.subtitle { + font-size: 1.1rem; + color: #525860; + margin-bottom: 2rem; + line-height: 1.6; +} + +[data-theme='dark'] .subtitle { + color: #9a9da3; +} + +.links { + display: flex; + gap: 1rem; + justify-content: center; + margin-bottom: 2.5rem; +} + +.homeLink { + display: inline-flex; + align-items: center; + padding: 0.625rem 1.5rem; + background-color: #f45d48; + color: #ffffff; + border-radius: 8px; + font-weight: 600; + font-size: 0.95rem; + text-decoration: none; + transition: background-color 0.15s ease; +} + +.homeLink:hover { + background-color: #d91f0c; + color: #ffffff; + text-decoration: none; +} + +.docsLink { + display: inline-flex; + align-items: center; + padding: 0.625rem 1.5rem; + background-color: transparent; + color: #1b1b1d; + border: 1px solid #d0d0d3; + border-radius: 8px; + font-weight: 600; + font-size: 0.95rem; + text-decoration: none; + transition: border-color 0.15s ease, color 0.15s ease; +} + +.docsLink:hover { + border-color: #f45d48; + color: #f45d48; + text-decoration: none; +} + +[data-theme='dark'] .docsLink { + color: #ffffff; + border-color: #4a4a4d; +} + +[data-theme='dark'] .docsLink:hover { + border-color: #ff7a68; + color: #ff7a68; +} + +.suggestions { + padding-top: 1.5rem; + border-top: 1px solid #ebedf0; +} + +[data-theme='dark'] .suggestions { + border-top-color: #3a3a3d; +} + +.suggestionsLabel { + font-size: 0.8rem; + text-transform: uppercase; + letter-spacing: 0.06em; + font-weight: 600; + color: #525860; + margin-bottom: 0.75rem; +} + +[data-theme='dark'] .suggestionsLabel { + color: #9a9da3; +} + +.suggestionsList { + list-style: none; + padding: 0; + margin: 0; + display: flex; + flex-wrap: wrap; + gap: 0.5rem; + justify-content: center; +} + +.suggestionsList li a { + display: inline-block; + padding: 0.35rem 0.85rem; + background-color: #f5f6f7; + border-radius: 6px; + font-size: 0.85rem; + color: #1b1b1d; + text-decoration: none; + transition: background-color 0.15s ease, color 0.15s ease; +} + +.suggestionsList li a:hover { + background-color: rgba(244, 93, 72, 0.1); + color: #f45d48; + text-decoration: none; +} + +[data-theme='dark'] .suggestionsList li a { + background-color: #2a2a2d; + color: #c0c0c3; +} + +[data-theme='dark'] .suggestionsList li a:hover { + background-color: rgba(255, 122, 104, 0.12); + color: #ff7a68; +} diff --git a/website/static/img/favicon.svg b/website/static/img/favicon.svg new file mode 100644 index 000000000..a3e516208 --- /dev/null +++ b/website/static/img/favicon.svg @@ -0,0 +1,4 @@ + + + G + diff --git a/website/static/img/gusto-logo-dark.svg b/website/static/img/gusto-logo-dark.svg new file mode 100644 index 000000000..199d733cf --- /dev/null +++ b/website/static/img/gusto-logo-dark.svg @@ -0,0 +1 @@ + diff --git a/website/static/img/gusto-logo.svg b/website/static/img/gusto-logo.svg new file mode 100644 index 000000000..f3c0ece00 --- /dev/null +++ b/website/static/img/gusto-logo.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/website/tsconfig.json b/website/tsconfig.json new file mode 100644 index 000000000..d250afaed --- /dev/null +++ b/website/tsconfig.json @@ -0,0 +1,6 @@ +{ + "extends": "@docusaurus/tsconfig", + "compilerOptions": { + "baseUrl": "." + } +} From 178625a321b096911acc6161cf658957c1b9970f Mon Sep 17 00:00:00 2001 From: Jeff Johnson Date: Wed, 8 Apr 2026 11:34:23 -0700 Subject: [PATCH 2/3] docs: rewrite docs site with new information architecture - Add quickstart section (install, first flow, next steps) - Add concepts section (flows/blocks, provider, events, auth, composition, theming, errors, i18n) - Add complete component inventory with individual pages for every flow and block - Add consolidated guides (routing, observability, component adapter, proxy setup, theme variables) - Rewrite sidebar, landing page, footer, and README to match new structure - Fact-checked all props, events, code examples, and flow steps against source code Made-with: Cursor --- README.md | 79 ++--- docs/components/company/assign-signatory.md | 42 +++ docs/components/company/bank-account.md | 41 +++ docs/components/company/company.md | 32 ++ docs/components/company/create-signatory.md | 40 +++ docs/components/company/document-list.md | 37 ++ docs/components/company/document-signer.md | 47 +++ docs/components/company/federal-taxes.md | 38 +++ docs/components/company/industry.md | 37 ++ docs/components/company/invite-signatory.md | 38 +++ docs/components/company/locations.md | 41 +++ docs/components/company/onboarding-flow.md | 61 ++++ .../components/company/onboarding-overview.md | 37 ++ docs/components/company/pay-schedule.md | 38 +++ docs/components/company/signature-form.md | 40 +++ docs/components/company/state-taxes-form.md | 39 +++ docs/components/company/state-taxes-list.md | 37 ++ docs/components/company/state-taxes.md | 38 +++ docs/components/components.md | 30 ++ docs/components/contractor/address.md | 38 +++ docs/components/contractor/contractor-list.md | 40 +++ .../contractor/contractor-profile.md | 40 +++ .../contractor/contractor-submit.md | 39 +++ docs/components/contractor/contractor.md | 29 ++ docs/components/contractor/create-payment.md | 41 +++ docs/components/contractor/new-hire-report.md | 38 +++ docs/components/contractor/onboarding-flow.md | 55 +++ docs/components/contractor/payment-flow.md | 39 +++ docs/components/contractor/payment-history.md | 37 ++ docs/components/contractor/payment-method.md | 38 +++ .../contractor/payment-statement.md | 32 ++ docs/components/contractor/payment-summary.md | 39 +++ docs/components/contractor/payments-list.md | 39 +++ docs/components/employee/compensation.md | 58 ++++ docs/components/employee/deductions.md | 48 +++ docs/components/employee/document-signer.md | 45 +++ .../components/employee/employee-documents.md | 43 +++ docs/components/employee/employee-list.md | 42 +++ docs/components/employee/employee.md | 44 +++ .../employee/employment-eligibility.md | 41 +++ docs/components/employee/federal-taxes.md | 41 +++ docs/components/employee/landing.md | 42 +++ docs/components/employee/onboarding-flow.md | 68 ++++ .../components/employee/onboarding-summary.md | 43 +++ docs/components/employee/payment-method.md | 44 +++ docs/components/employee/profile.md | 80 +++++ .../employee/self-onboarding-flow.md | 60 ++++ docs/components/employee/state-taxes.md | 42 +++ docs/components/employee/taxes.md | 40 +++ .../components/employee/terminate-employee.md | 51 +++ docs/components/employee/termination-flow.md | 60 ++++ .../employee/termination-summary.md | 58 ++++ .../information-request-form.md | 39 +++ .../information-request-list.md | 36 ++ .../information-requests-flow.md | 39 +++ .../information-requests.md | 19 ++ .../payroll/confirm-wire-details.md | 43 +++ docs/components/payroll/dismissal-flow.md | 38 +++ docs/components/payroll/off-cycle-creation.md | 37 ++ .../payroll/off-cycle-deductions-setting.md | 36 ++ docs/components/payroll/off-cycle-flow.md | 38 +++ .../payroll/off-cycle-reason-selection.md | 36 ++ docs/components/payroll/payroll-blocker.md | 35 ++ .../payroll/payroll-configuration.md | 48 +++ .../payroll/payroll-edit-employee.md | 43 +++ .../payroll/payroll-execution-flow.md | 45 +++ docs/components/payroll/payroll-flow.md | 51 +++ docs/components/payroll/payroll-history.md | 39 +++ docs/components/payroll/payroll-landing.md | 50 +++ docs/components/payroll/payroll-list.md | 40 +++ docs/components/payroll/payroll-overview.md | 48 +++ docs/components/payroll/payroll-receipts.md | 36 ++ docs/components/payroll/payroll.md | 35 ++ docs/components/payroll/recovery-cases.md | 39 +++ .../components/payroll/transition-creation.md | 42 +++ docs/components/payroll/transition-flow.md | 42 +++ docs/concepts/authentication-and-proxy.md | 135 ++++++++ docs/concepts/composition.md | 124 +++++++ docs/concepts/concepts.md | 22 ++ docs/concepts/error-handling.md | 130 +++++++ docs/concepts/events.md | 274 +++++++++++++++ docs/concepts/flows-and-blocks.md | 102 ++++++ docs/concepts/i18n.md | 80 +++++ docs/concepts/provider-and-configuration.md | 157 +++++++++ docs/concepts/theming-and-customization.md | 113 +++++++ docs/guides/component-adapter.md | 258 ++++++++++++++ docs/guides/guides.md | 17 + docs/guides/observability.md | 316 ++++++++++++++++++ docs/guides/providing-your-own-data.md | 45 +++ docs/guides/proxy-setup.md | 127 +++++++ docs/guides/request-interceptors.md | 77 +++++ docs/guides/routing.md | 254 ++++++++++++++ docs/guides/theme-variables.md | 114 +++++++ docs/guides/versioning.md | 24 ++ docs/quickstart/first-flow.md | 80 +++++ docs/quickstart/next-steps.md | 34 ++ docs/quickstart/quickstart.md | 115 +++++++ docs/what-is-the-gep-react-sdk.md | 16 +- website/docusaurus.config.ts | 17 +- website/sidebars.ts | 261 +++++++++++---- website/src/pages/index.tsx | 16 +- 101 files changed, 6015 insertions(+), 133 deletions(-) create mode 100644 docs/components/company/assign-signatory.md create mode 100644 docs/components/company/bank-account.md create mode 100644 docs/components/company/company.md create mode 100644 docs/components/company/create-signatory.md create mode 100644 docs/components/company/document-list.md create mode 100644 docs/components/company/document-signer.md create mode 100644 docs/components/company/federal-taxes.md create mode 100644 docs/components/company/industry.md create mode 100644 docs/components/company/invite-signatory.md create mode 100644 docs/components/company/locations.md create mode 100644 docs/components/company/onboarding-flow.md create mode 100644 docs/components/company/onboarding-overview.md create mode 100644 docs/components/company/pay-schedule.md create mode 100644 docs/components/company/signature-form.md create mode 100644 docs/components/company/state-taxes-form.md create mode 100644 docs/components/company/state-taxes-list.md create mode 100644 docs/components/company/state-taxes.md create mode 100644 docs/components/components.md create mode 100644 docs/components/contractor/address.md create mode 100644 docs/components/contractor/contractor-list.md create mode 100644 docs/components/contractor/contractor-profile.md create mode 100644 docs/components/contractor/contractor-submit.md create mode 100644 docs/components/contractor/contractor.md create mode 100644 docs/components/contractor/create-payment.md create mode 100644 docs/components/contractor/new-hire-report.md create mode 100644 docs/components/contractor/onboarding-flow.md create mode 100644 docs/components/contractor/payment-flow.md create mode 100644 docs/components/contractor/payment-history.md create mode 100644 docs/components/contractor/payment-method.md create mode 100644 docs/components/contractor/payment-statement.md create mode 100644 docs/components/contractor/payment-summary.md create mode 100644 docs/components/contractor/payments-list.md create mode 100644 docs/components/employee/compensation.md create mode 100644 docs/components/employee/deductions.md create mode 100644 docs/components/employee/document-signer.md create mode 100644 docs/components/employee/employee-documents.md create mode 100644 docs/components/employee/employee-list.md create mode 100644 docs/components/employee/employee.md create mode 100644 docs/components/employee/employment-eligibility.md create mode 100644 docs/components/employee/federal-taxes.md create mode 100644 docs/components/employee/landing.md create mode 100644 docs/components/employee/onboarding-flow.md create mode 100644 docs/components/employee/onboarding-summary.md create mode 100644 docs/components/employee/payment-method.md create mode 100644 docs/components/employee/profile.md create mode 100644 docs/components/employee/self-onboarding-flow.md create mode 100644 docs/components/employee/state-taxes.md create mode 100644 docs/components/employee/taxes.md create mode 100644 docs/components/employee/terminate-employee.md create mode 100644 docs/components/employee/termination-flow.md create mode 100644 docs/components/employee/termination-summary.md create mode 100644 docs/components/information-requests/information-request-form.md create mode 100644 docs/components/information-requests/information-request-list.md create mode 100644 docs/components/information-requests/information-requests-flow.md create mode 100644 docs/components/information-requests/information-requests.md create mode 100644 docs/components/payroll/confirm-wire-details.md create mode 100644 docs/components/payroll/dismissal-flow.md create mode 100644 docs/components/payroll/off-cycle-creation.md create mode 100644 docs/components/payroll/off-cycle-deductions-setting.md create mode 100644 docs/components/payroll/off-cycle-flow.md create mode 100644 docs/components/payroll/off-cycle-reason-selection.md create mode 100644 docs/components/payroll/payroll-blocker.md create mode 100644 docs/components/payroll/payroll-configuration.md create mode 100644 docs/components/payroll/payroll-edit-employee.md create mode 100644 docs/components/payroll/payroll-execution-flow.md create mode 100644 docs/components/payroll/payroll-flow.md create mode 100644 docs/components/payroll/payroll-history.md create mode 100644 docs/components/payroll/payroll-landing.md create mode 100644 docs/components/payroll/payroll-list.md create mode 100644 docs/components/payroll/payroll-overview.md create mode 100644 docs/components/payroll/payroll-receipts.md create mode 100644 docs/components/payroll/payroll.md create mode 100644 docs/components/payroll/recovery-cases.md create mode 100644 docs/components/payroll/transition-creation.md create mode 100644 docs/components/payroll/transition-flow.md create mode 100644 docs/concepts/authentication-and-proxy.md create mode 100644 docs/concepts/composition.md create mode 100644 docs/concepts/concepts.md create mode 100644 docs/concepts/error-handling.md create mode 100644 docs/concepts/events.md create mode 100644 docs/concepts/flows-and-blocks.md create mode 100644 docs/concepts/i18n.md create mode 100644 docs/concepts/provider-and-configuration.md create mode 100644 docs/concepts/theming-and-customization.md create mode 100644 docs/guides/component-adapter.md create mode 100644 docs/guides/guides.md create mode 100644 docs/guides/observability.md create mode 100644 docs/guides/providing-your-own-data.md create mode 100644 docs/guides/proxy-setup.md create mode 100644 docs/guides/request-interceptors.md create mode 100644 docs/guides/routing.md create mode 100644 docs/guides/theme-variables.md create mode 100644 docs/guides/versioning.md create mode 100644 docs/quickstart/first-flow.md create mode 100644 docs/quickstart/next-steps.md create mode 100644 docs/quickstart/quickstart.md diff --git a/README.md b/README.md index 9447ba80b..54312ec1c 100644 --- a/README.md +++ b/README.md @@ -1,54 +1,49 @@ -# 🦎 Gusto Embedded React SDK +# Gusto Embedded React SDK [![CI](https://github.com/Gusto/embedded-react-sdk/actions/workflows/ci.yaml/badge.svg)](https://github.com/Gusto/embedded-react-sdk/actions/workflows/ci.yaml) -To install: +A React component library for building embedded payroll experiences on top of the Gusto Embedded API. +```bash +npm install @gusto/embedded-react-sdk ``` -npm add @gusto/embedded-react-sdk -``` - -Examples at: -https://codesandbox.io/p/sandbox/gusto-embedded-sdk-demo-employeelist-nzpslw +[Try the CodeSandbox demo](https://codesandbox.io/p/devbox/happy-ardinghelli-nzpslw) ## Documentation -Live documentation is available at: https://docs.gusto.com/embedded-payroll/docs/what-is-the-gep-react-sdk - -- [What is the GEP React SDK](docs/what-is-the-gep-react-sdk.md) -- [Deciding to build with the SDK](docs/deciding-to-build-with-the-sdk/deciding-to-build-with-the-sdk.md) - - [Build Pathways - SDK, Flows & APIs](docs/deciding-to-build-with-the-sdk/build-pathways-sdk-flows-api.md) - - [Component Types](docs/deciding-to-build-with-the-sdk/component-types.md) -- [Getting Started](docs/getting-started/getting-started.md) - - [Authentication](docs/getting-started/authentication.md) -- [Integration Guide](docs/integration-guide/integration-guide.md) - - [Versioning](docs/integration-guide/versioning.md) - - [Event Handling](docs/integration-guide/event-handling.md) - - [Event Types](docs/integration-guide/event-types.md) - - [Error Handling](docs/integration-guide/error-handling.md) - - [Composition](docs/integration-guide/composition.md) - - [Providing your own data](docs/integration-guide/providing-your-own-data.md) - - [Translation](docs/integration-guide/translation.md) - - [Routing](docs/integration-guide/routing.md) - - [Request Interceptors](docs/integration-guide/request-interceptors.md) - - [Customizing SDK UI](docs/integration-guide/customizing-sdk-ui.md) -- [Theming](docs/theming/theming.md) - - [Theming Guide](docs/theming/theming-guide.md) - - [Theme Variables](docs/theming/theme-variables.md) -- [Component Adapter](docs/component-adapter/component-adapter.md) - - [How the Component Adapter Works](docs/component-adapter/how-the-component-adapter-works.md) - - [Component Adapter Types](docs/component-adapter/component-adapter-types.md) - - [Setting up your Component Adapter](docs/component-adapter/setting-up-your-component-adapter.md) - - [Component Inventory](docs/component-adapter/component-inventory.md) - - [Component Adapter FAQ](docs/component-adapter/component-adapter-faq.md) -- [Workflows Overview](docs/workflows-overview/workflows-overview.md) - - [Company Onboarding](docs/workflows-overview/company-onboarding.md) - - [Contractor Onboarding](docs/workflows-overview/contractor-onboarding.md) - - [Employee Onboarding](docs/workflows-overview/employee-onboarding/employee-onboarding.md) - - [Employee Self-Onboarding](docs/workflows-overview/employee-onboarding/employee-self-onboarding.md) - - [Run Payroll](docs/workflows-overview/run-payroll.md) -- [Hooks (Experimental)](docs/hooks/hooks.md) +- [What is the SDK?](docs/what-is-the-gep-react-sdk.md) +- **Quickstart** + - [Your First 5 Minutes](docs/quickstart/quickstart.md) + - [Your First Flow](docs/quickstart/first-flow.md) + - [Next Steps](docs/quickstart/next-steps.md) +- **Concepts** + - [Flows and Blocks](docs/concepts/flows-and-blocks.md) + - [Provider and Configuration](docs/concepts/provider-and-configuration.md) + - [Events](docs/concepts/events.md) + - [Authentication and Proxy](docs/concepts/authentication-and-proxy.md) + - [Composition](docs/concepts/composition.md) + - [Theming and Customization](docs/concepts/theming-and-customization.md) + - [Error Handling](docs/concepts/error-handling.md) + - [Internationalization](docs/concepts/i18n.md) +- **Components** + - [Components Overview](docs/components/components.md) + - [Company](docs/components/company/company.md) + - [Employee](docs/components/employee/employee.md) + - [Contractor](docs/components/contractor/contractor.md) + - [Payroll](docs/components/payroll/payroll.md) + - [Information Requests](docs/components/information-requests/information-requests.md) +- **Guides** + - [Versioning](docs/guides/versioning.md) + - [Routing](docs/guides/routing.md) + - [Request Interceptors](docs/guides/request-interceptors.md) + - [Providing Your Own Data](docs/guides/providing-your-own-data.md) + - [Observability](docs/guides/observability.md) + - [Component Adapter](docs/guides/component-adapter.md) + - [Proxy Setup](docs/guides/proxy-setup.md) + - [Theme Variables](docs/guides/theme-variables.md) +- **Hooks (Experimental)** + - [Hooks Overview](docs/hooks/hooks.md) - [useEmployeeDetailsForm](docs/hooks/useEmployeeDetailsForm.md) - [useCompensationForm](docs/hooks/useCompensationForm.md) - [useWorkAddressForm](docs/hooks/useWorkAddressForm.md) diff --git a/docs/components/company/assign-signatory.md b/docs/components/company/assign-signatory.md new file mode 100644 index 000000000..a23c914b9 --- /dev/null +++ b/docs/components/company/assign-signatory.md @@ -0,0 +1,42 @@ +--- +title: Company.AssignSignatory +sidebar_position: 3 +--- + +Allows users to choose between creating a new signatory with full details or inviting someone else to become the signatory. For more granular control, use `Company.CreateSignatory` or `Company.InviteSignatory` directly. + +## Usage + +```tsx +import { Company } from '@gusto/embedded-react-sdk' + +function MyComponent() { + return ( + { + console.log(eventType, data) + }} + /> + ) +} +``` + +## 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. | + +## 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) | diff --git a/docs/components/company/bank-account.md b/docs/components/company/bank-account.md new file mode 100644 index 000000000..90956761d --- /dev/null +++ b/docs/components/company/bank-account.md @@ -0,0 +1,41 @@ +--- +title: Company.BankAccount +sidebar_position: 11 +--- + +Manages company bank account setup and verification. Handles creating a new bank account, viewing existing accounts, and verifying accounts via micro-deposits. + +## Usage + +```tsx +import { Company } from '@gusto/embedded-react-sdk' + +function MyComponent() { + return ( + { + console.log(eventType, data) + }} + /> + ) +} +``` + +## 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. | + +## 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 | diff --git a/docs/components/company/company.md b/docs/components/company/company.md new file mode 100644 index 000000000..7c760d841 --- /dev/null +++ b/docs/components/company/company.md @@ -0,0 +1,32 @@ +--- +title: Company +sidebar_position: 1 +--- + +The Company domain provides components for onboarding a company onto Gusto's embedded payroll platform. These components handle tax setup, bank account configuration, pay schedules, location management, signatory assignment, and document signing. + +## Flow + +| 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. | diff --git a/docs/components/company/create-signatory.md b/docs/components/company/create-signatory.md new file mode 100644 index 000000000..0d451b397 --- /dev/null +++ b/docs/components/company/create-signatory.md @@ -0,0 +1,40 @@ +--- +title: Company.CreateSignatory +sidebar_position: 4 +--- + +Standalone form for creating a new signatory with full personal details including name, contact information, SSN, and home address. Use this component when you want to provide only the create signatory flow without the invite option. + +## Usage + +```tsx +import { Company } from '@gusto/embedded-react-sdk' + +function MyComponent() { + return ( + { + console.log(eventType, data) + }} + /> + ) +} +``` + +## 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. | + +## 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 | diff --git a/docs/components/company/document-list.md b/docs/components/company/document-list.md new file mode 100644 index 000000000..358114e97 --- /dev/null +++ b/docs/components/company/document-list.md @@ -0,0 +1,37 @@ +--- +title: Company.DocumentList +sidebar_position: 17 +--- + +Displays the list of company forms available for signing. This is the lower-level building block used internally by `Company.DocumentSigner` for the document list view. Use this component directly when you need full control over the document signing workflow. + +## Usage + +```tsx +import { Company } from '@gusto/embedded-react-sdk' + +function MyComponent() { + return ( + { + console.log(eventType, data) + }} + /> + ) +} +``` + +## 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. | + +## 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) | diff --git a/docs/components/company/document-signer.md b/docs/components/company/document-signer.md new file mode 100644 index 000000000..cb89b25cf --- /dev/null +++ b/docs/components/company/document-signer.md @@ -0,0 +1,47 @@ +--- +title: Company.DocumentSigner +sidebar_position: 6 +--- + +Provides an interface for company representatives to read and sign required company documents. This orchestrated component handles document listing, signatory management, and the document signing workflow. For more granular control, use `Company.DocumentList` or `Company.SignatureForm` directly. + +## Usage + +```tsx +import { Company } from '@gusto/embedded-react-sdk' + +function MyComponent() { + return ( + { + console.log(eventType, data) + }} + /> + ) +} +``` + +## 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. | + +## 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) | diff --git a/docs/components/company/federal-taxes.md b/docs/components/company/federal-taxes.md new file mode 100644 index 000000000..ec23a84e7 --- /dev/null +++ b/docs/components/company/federal-taxes.md @@ -0,0 +1,38 @@ +--- +title: Company.FederalTaxes +sidebar_position: 7 +--- + +Form for entering company federal tax information including EIN, tax payer type, filing form, and legal name. + +## Usage + +```tsx +import { Company } from '@gusto/embedded-react-sdk' + +function MyComponent() { + return ( + { + console.log(eventType, data) + }} + /> + ) +} +``` + +## 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. | + +## Events + +| 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 | diff --git a/docs/components/company/industry.md b/docs/components/company/industry.md new file mode 100644 index 000000000..a9f0fb780 --- /dev/null +++ b/docs/components/company/industry.md @@ -0,0 +1,37 @@ +--- +title: Company.Industry +sidebar_position: 8 +--- + +Industry selection component for the company. Allows users to search for and select the company's industry classification. + +## Usage + +```tsx +import { Company } from '@gusto/embedded-react-sdk' + +function MyComponent() { + return ( + { + console.log(eventType, data) + }} + /> + ) +} +``` + +## 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. | + +## 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 | diff --git a/docs/components/company/invite-signatory.md b/docs/components/company/invite-signatory.md new file mode 100644 index 000000000..29acac907 --- /dev/null +++ b/docs/components/company/invite-signatory.md @@ -0,0 +1,38 @@ +--- +title: Company.InviteSignatory +sidebar_position: 5 +--- + +Standalone form for inviting someone else to become the company signatory. The invited person receives an email to complete their signatory information. Use this component when you want to provide only the invite flow without the create option. + +## Usage + +```tsx +import { Company } from '@gusto/embedded-react-sdk' + +function MyComponent() { + return ( + { + console.log(eventType, data) + }} + /> + ) +} +``` + +## 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. | + +## 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 | diff --git a/docs/components/company/locations.md b/docs/components/company/locations.md new file mode 100644 index 000000000..ce3929250 --- /dev/null +++ b/docs/components/company/locations.md @@ -0,0 +1,41 @@ +--- +title: Company.Locations +sidebar_position: 10 +--- + +Manages company addresses including mailing and filing locations. Provides a list view of existing locations with the ability to add new locations and edit existing ones. + +## Usage + +```tsx +import { Company } from '@gusto/embedded-react-sdk' + +function MyComponent() { + return ( + { + console.log(eventType, data) + }} + /> + ) +} +``` + +## 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. | + +## 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 | diff --git a/docs/components/company/onboarding-flow.md b/docs/components/company/onboarding-flow.md new file mode 100644 index 000000000..315c18f50 --- /dev/null +++ b/docs/components/company/onboarding-flow.md @@ -0,0 +1,61 @@ +--- +title: Company.OnboardingFlow +sidebar_position: 2 +--- + +End-to-end company onboarding workflow that orchestrates all onboarding steps in sequence. This flow component manages navigation between individual onboarding blocks automatically. + +### Steps + +1. **OnboardingOverview** — Company onboarding status overview +2. **Locations** — Company work addresses +3. **FederalTaxes** — Federal tax setup +4. **Industry** — Industry classification +5. **BankAccount** — Company bank account for payroll +6. **Employee.OnboardingFlow** — Nested employee onboarding flow (runs the full [Employee.OnboardingFlow](../employee/onboarding-flow.md) within the company onboarding) +7. **PaySchedule** — Pay frequency and schedule configuration +8. **StateTaxes** — State tax registration +9. **DocumentSigner** — Sign required documents + +:::note +Step 6 is a nested `Employee.OnboardingFlow` — the company onboarding flow delegates to the employee onboarding flow to onboard the first employee before continuing with the remaining company steps. +::: + +## Usage + +```tsx +import { Company } from '@gusto/embedded-react-sdk' + +function MyApp() { + return ( + { + console.log(eventType, data) + }} + /> + ) +} +``` + +## 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. | + +## Events + +This component emits events from all of its subcomponents. See the individual block documentation for the specific events each step produces: + +- [OnboardingOverview events](./onboarding-overview.md#events) +- [Locations events](./locations.md#events) +- [FederalTaxes events](./federal-taxes.md#events) +- [Industry events](./industry.md#events) +- [BankAccount events](./bank-account.md#events) +- [Employee.OnboardingFlow events](../employee/onboarding-flow.md#events) +- [PaySchedule events](./pay-schedule.md#events) +- [StateTaxes events](./state-taxes.md#events) +- [DocumentSigner events](./document-signer.md#events) diff --git a/docs/components/company/onboarding-overview.md b/docs/components/company/onboarding-overview.md new file mode 100644 index 000000000..913895524 --- /dev/null +++ b/docs/components/company/onboarding-overview.md @@ -0,0 +1,37 @@ +--- +title: Company.OnboardingOverview +sidebar_position: 15 +--- + +Displays a summary of the company's onboarding progress and any outstanding requirements that need to be completed before payroll can be run. + +## Usage + +```tsx +import { Company } from '@gusto/embedded-react-sdk' + +function MyComponent() { + return ( + { + console.log(eventType, data) + }} + /> + ) +} +``` + +## 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. | + +## Events + +| 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 | diff --git a/docs/components/company/pay-schedule.md b/docs/components/company/pay-schedule.md new file mode 100644 index 000000000..88d9e75e3 --- /dev/null +++ b/docs/components/company/pay-schedule.md @@ -0,0 +1,38 @@ +--- +title: Company.PaySchedule +sidebar_position: 9 +--- + +Manages company pay schedules including creating, editing, and viewing pay schedules with preview functionality. + +## Usage + +```tsx +import { Company } from '@gusto/embedded-react-sdk' + +function MyComponent() { + return ( + { + console.log(eventType, data) + }} + /> + ) +} +``` + +## 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. | + +## 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) | +| `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 new file mode 100644 index 000000000..4b784e461 --- /dev/null +++ b/docs/components/company/signature-form.md @@ -0,0 +1,40 @@ +--- +title: Company.SignatureForm +sidebar_position: 16 +--- + +Form for reviewing and signing an individual company document. This is the lower-level building block used internally by `Company.DocumentSigner` for the signing step. Use this component directly when you need full control over the document signing workflow. + +## Usage + +```tsx +import { Company } from '@gusto/embedded-react-sdk' + +function MyComponent() { + return ( + { + console.log(eventType, data) + }} + /> + ) +} +``` + +## 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. | + +## 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 | diff --git a/docs/components/company/state-taxes-form.md b/docs/components/company/state-taxes-form.md new file mode 100644 index 000000000..34e5ad96b --- /dev/null +++ b/docs/components/company/state-taxes-form.md @@ -0,0 +1,39 @@ +--- +title: Company.StateTaxesForm +sidebar_position: 13 +--- + +Standalone form for editing state tax requirements for a specific state. This is the lower-level building block used internally by `Company.StateTaxes` for its edit view. Use this component directly when you need full control over navigation between the list and form views. + +## Usage + +```tsx +import { Company } from '@gusto/embedded-react-sdk' + +function MyComponent() { + return ( + { + console.log(eventType, data) + }} + /> + ) +} +``` + +## 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. | + +## Events + +| 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 | diff --git a/docs/components/company/state-taxes-list.md b/docs/components/company/state-taxes-list.md new file mode 100644 index 000000000..fe86c1820 --- /dev/null +++ b/docs/components/company/state-taxes-list.md @@ -0,0 +1,37 @@ +--- +title: Company.StateTaxesList +sidebar_position: 14 +--- + +Displays the list of state tax requirements for a company. This is the lower-level building block used internally by `Company.StateTaxes` for its list view. Use this component directly when you need full control over navigation between the list and form views. + +## Usage + +```tsx +import { Company } from '@gusto/embedded-react-sdk' + +function MyComponent() { + return ( + { + console.log(eventType, data) + }} + /> + ) +} +``` + +## 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. | + +## 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_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 new file mode 100644 index 000000000..fc6b62886 --- /dev/null +++ b/docs/components/company/state-taxes.md @@ -0,0 +1,38 @@ +--- +title: Company.StateTaxes +sidebar_position: 12 +--- + +Orchestrated component for managing company state taxes setup. Internally uses a state machine to switch between a list view and an edit form. For more granular control over navigation between views, use `Company.StateTaxesList` or `Company.StateTaxesForm` directly. + +## Usage + +```tsx +import { Company } from '@gusto/embedded-react-sdk' + +function MyComponent() { + return ( + { + console.log(eventType, data) + }} + /> + ) +} +``` + +## 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. | + +## 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 | diff --git a/docs/components/components.md b/docs/components/components.md new file mode 100644 index 000000000..8d6354a39 --- /dev/null +++ b/docs/components/components.md @@ -0,0 +1,30 @@ +--- +title: Components Overview +sidebar_position: 1 +--- + +The Gusto Embedded React SDK provides pre-built components organized by domain. Each domain includes a **flow** component that orchestrates the full workflow and individual **block** components that can be used independently for more granular control. + +For more on the distinction between flows and blocks, see [Flows and Blocks](../concepts/flows-and-blocks.md). + +## Domains + +### [Company](./company/company.md) + +Components for company onboarding — setting up federal and state taxes, bank accounts, pay schedules, locations, signatories, and document signing. + +### Employee + +Components for employee lifecycle management — onboarding profiles, compensation, tax setup, bank accounts, payment methods, and self-onboarding. + +### Contractor + +Components for contractor management — creating contractor profiles, setting up payment methods, and managing addresses. + +### Payroll + +Components for running payroll — preparing payrolls, reviewing and submitting, and handling off-cycle and contractor payments. + +### Information Requests + +Components for responding to tax agency notices and other information requests that require action from the company. diff --git a/docs/components/contractor/address.md b/docs/components/contractor/address.md new file mode 100644 index 000000000..0455dc98c --- /dev/null +++ b/docs/components/contractor/address.md @@ -0,0 +1,38 @@ +--- +title: Contractor.Address +sidebar_position: 6 +--- + +Form for entering or updating a contractor's mailing address. + +## Usage + +```tsx +import { Contractor } from '@gusto/embedded-react-sdk' + +function MyComponent() { + return ( + { + console.log(eventType, data) + }} + /> + ) +} +``` + +## 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. | + +## Events + +| 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 | diff --git a/docs/components/contractor/contractor-list.md b/docs/components/contractor/contractor-list.md new file mode 100644 index 000000000..a01d9057d --- /dev/null +++ b/docs/components/contractor/contractor-list.md @@ -0,0 +1,40 @@ +--- +title: Contractor.ContractorList +sidebar_position: 4 +--- + +Displays a list of contractors for a company with options to create new contractors, edit existing ones, delete contractors, and continue onboarding. + +## Usage + +```tsx +import { Contractor } from '@gusto/embedded-react-sdk' + +function MyComponent() { + return ( + { + console.log(eventType, data) + }} + /> + ) +} +``` + +## 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. | + +## 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 | diff --git a/docs/components/contractor/contractor-profile.md b/docs/components/contractor/contractor-profile.md new file mode 100644 index 000000000..9b9077aaf --- /dev/null +++ b/docs/components/contractor/contractor-profile.md @@ -0,0 +1,40 @@ +--- +title: Contractor.ContractorProfile +sidebar_position: 5 +--- + +Form for creating or editing a contractor profile. Supports both individual and business contractor types with appropriate fields for each. + +## Usage + +```tsx +import { Contractor } from '@gusto/embedded-react-sdk' + +function MyComponent() { + return ( + { + console.log(eventType, data) + }} + /> + ) +} +``` + +## 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. | + +## 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 | diff --git a/docs/components/contractor/contractor-submit.md b/docs/components/contractor/contractor-submit.md new file mode 100644 index 000000000..f9f657f0c --- /dev/null +++ b/docs/components/contractor/contractor-submit.md @@ -0,0 +1,39 @@ +--- +title: Contractor.ContractorSubmit +sidebar_position: 9 +--- + +Final submission step for contractor onboarding. Allows the user to review and submit the contractor's onboarding information, with an option to invite the contractor to self-onboard. + +## Usage + +```tsx +import { Contractor } from '@gusto/embedded-react-sdk' + +function MyComponent() { + return ( + { + console.log(eventType, data) + }} + /> + ) +} +``` + +## 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. | + +## 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 }` | diff --git a/docs/components/contractor/contractor.md b/docs/components/contractor/contractor.md new file mode 100644 index 000000000..5a319b43c --- /dev/null +++ b/docs/components/contractor/contractor.md @@ -0,0 +1,29 @@ +--- +title: Contractor +sidebar_position: 1 +--- + +The Contractor domain provides components for managing contractors on Gusto's embedded payroll platform. These components handle contractor onboarding, payment setup, address management, and contractor payment processing. + +## Flows + +| 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. | + +## Blocks + +| 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. | diff --git a/docs/components/contractor/create-payment.md b/docs/components/contractor/create-payment.md new file mode 100644 index 000000000..332cb2cf6 --- /dev/null +++ b/docs/components/contractor/create-payment.md @@ -0,0 +1,41 @@ +--- +title: Contractor.CreatePayment +sidebar_position: 11 +--- + +Form for creating a new contractor payment. Supports editing, previewing, and submitting the payment. + +## Usage + +```tsx +import { Contractor } from '@gusto/embedded-react-sdk' + +function MyComponent() { + return ( + { + console.log(eventType, data) + }} + /> + ) +} +``` + +## 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. | + +## 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 | diff --git a/docs/components/contractor/new-hire-report.md b/docs/components/contractor/new-hire-report.md new file mode 100644 index 000000000..e5ba62a04 --- /dev/null +++ b/docs/components/contractor/new-hire-report.md @@ -0,0 +1,38 @@ +--- +title: Contractor.NewHireReport +sidebar_position: 8 +--- + +Handles new hire reporting requirements for a contractor. This step collects information needed to file a new hire report with the appropriate state agency. + +## Usage + +```tsx +import { Contractor } from '@gusto/embedded-react-sdk' + +function MyComponent() { + return ( + { + console.log(eventType, data) + }} + /> + ) +} +``` + +## 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. | + +## Events + +| 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 | diff --git a/docs/components/contractor/onboarding-flow.md b/docs/components/contractor/onboarding-flow.md new file mode 100644 index 000000000..20f20c022 --- /dev/null +++ b/docs/components/contractor/onboarding-flow.md @@ -0,0 +1,55 @@ +--- +title: Contractor.OnboardingFlow +sidebar_position: 2 +--- + +End-to-end contractor onboarding workflow that orchestrates all onboarding steps in sequence — contractor selection, profile creation, address entry, payment method setup, new hire reporting, and final submission. + +### Steps + +1. **ContractorList** — Select or create a contractor (initial step) +2. **ContractorProfile** — Contractor name, type, and business details +3. **Address** — Contractor mailing address +4. **PaymentMethod** — Payment method configuration +5. **NewHireReport** — State new hire reporting +6. **ContractorSubmit** — Review and submit contractor onboarding + +:::note +In the self-onboarding path, the **Address** and **PaymentMethod** steps are skipped — those steps are handled by the contractor themselves via the self-onboarding experience. +::: + +## Usage + +```tsx +import { Contractor } from '@gusto/embedded-react-sdk' + +function MyApp() { + return ( + { + console.log(eventType, data) + }} + /> + ) +} +``` + +## 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. | + +## Events + +This component emits events from all of its subcomponents. See the individual block documentation for the specific events each step produces: + +- [ContractorList events](./contractor-list.md#events) +- [ContractorProfile events](./contractor-profile.md#events) +- [Address events](./address.md#events) +- [PaymentMethod events](./payment-method.md#events) +- [NewHireReport events](./new-hire-report.md#events) +- [ContractorSubmit events](./contractor-submit.md#events) diff --git a/docs/components/contractor/payment-flow.md b/docs/components/contractor/payment-flow.md new file mode 100644 index 000000000..de2f25cdc --- /dev/null +++ b/docs/components/contractor/payment-flow.md @@ -0,0 +1,39 @@ +--- +title: Contractor.PaymentFlow +sidebar_position: 3 +--- + +End-to-end contractor payment workflow that orchestrates the full payment lifecycle — listing payments, creating new payments, reviewing payment details, and viewing payment history. + +## Usage + +```tsx +import { Contractor } from '@gusto/embedded-react-sdk' + +function MyApp() { + return ( + { + console.log(eventType, data) + }} + /> + ) +} +``` + +## 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. | + +## Events + +This component emits events from all of its subcomponents. See the individual block documentation for the specific events each step produces: + +- [PaymentsList events](./payments-list.md#events) +- [CreatePayment events](./create-payment.md#events) +- [PaymentHistory events](./payment-history.md#events) +- [PaymentSummary events](./payment-summary.md#events) diff --git a/docs/components/contractor/payment-history.md b/docs/components/contractor/payment-history.md new file mode 100644 index 000000000..0bf2c7a84 --- /dev/null +++ b/docs/components/contractor/payment-history.md @@ -0,0 +1,37 @@ +--- +title: Contractor.PaymentHistory +sidebar_position: 12 +--- + +Displays the payment history for a specific contractor payment, with options to view details or cancel the payment. + +## Usage + +```tsx +import { Contractor } from '@gusto/embedded-react-sdk' + +function MyComponent() { + return ( + { + console.log(eventType, data) + }} + /> + ) +} +``` + +## Props + +| 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 | +| --- | --- | --- | +| `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 | diff --git a/docs/components/contractor/payment-method.md b/docs/components/contractor/payment-method.md new file mode 100644 index 000000000..9ae65bafb --- /dev/null +++ b/docs/components/contractor/payment-method.md @@ -0,0 +1,38 @@ +--- +title: Contractor.PaymentMethod +sidebar_position: 7 +--- + +Manages contractor payment method setup, including bank account creation and payment method configuration. + +## Usage + +```tsx +import { Contractor } from '@gusto/embedded-react-sdk' + +function MyComponent() { + return ( + { + console.log(eventType, data) + }} + /> + ) +} +``` + +## Props + +| 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 | diff --git a/docs/components/contractor/payment-statement.md b/docs/components/contractor/payment-statement.md new file mode 100644 index 000000000..82e8acd30 --- /dev/null +++ b/docs/components/contractor/payment-statement.md @@ -0,0 +1,32 @@ +--- +title: Contractor.PaymentStatement +sidebar_position: 14 +--- + +Displays a detailed payment statement for a contractor payment, including line items and payment breakdown. + +## Usage + +```tsx +import { Contractor } from '@gusto/embedded-react-sdk' + +function MyComponent() { + return ( + { + console.log(eventType, data) + }} + /> + ) +} +``` + +## 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. | diff --git a/docs/components/contractor/payment-summary.md b/docs/components/contractor/payment-summary.md new file mode 100644 index 000000000..dc4a19b99 --- /dev/null +++ b/docs/components/contractor/payment-summary.md @@ -0,0 +1,39 @@ +--- +title: Contractor.PaymentSummary +sidebar_position: 13 +--- + +Summary view of a contractor payment group, displaying payment totals and details for all contractors included in the payment. + +## Usage + +```tsx +import { Contractor } from '@gusto/embedded-react-sdk' + +function MyComponent() { + return ( + { + console.log(eventType, data) + }} + /> + ) +} +``` + +## 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. | + +## Events + +| 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 new file mode 100644 index 000000000..8e19adb54 --- /dev/null +++ b/docs/components/contractor/payments-list.md @@ -0,0 +1,39 @@ +--- +title: Contractor.PaymentsList +sidebar_position: 10 +--- + +Displays a list of contractor payments for a company, with options to create new payments, view existing payments, and respond to information requests. + +## Usage + +```tsx +import { Contractor } from '@gusto/embedded-react-sdk' + +function MyComponent() { + return ( + { + console.log(eventType, data) + }} + /> + ) +} +``` + +## 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. | + +## 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 | diff --git a/docs/components/employee/compensation.md b/docs/components/employee/compensation.md new file mode 100644 index 000000000..77d81e209 --- /dev/null +++ b/docs/components/employee/compensation.md @@ -0,0 +1,58 @@ +--- +title: Employee.Compensation +sidebar_position: 7 +--- + +## Description + +Collects compensation details for an employee including job title, FLSA status (exempt/nonexempt), pay rate, and payment unit (hourly, salary, etc.). For hourly employees, the component supports configuring multiple roles with different pay rates. + +## Code example + +```jsx +import { Employee } from '@gusto/embedded-react-sdk' + +function MyApp({ employeeId }) { + const handleEvent = (eventType, data) => { + // Handle compensation events + } + + 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. | + +### defaultValues shape + +```typescript +{ + title?: string + rate?: string + paymentUnit?: string + flsaStatus?: 'Exempt' | 'Nonexempt' | 'Salaried Nonexempt' | 'Commission Only Exempt' | 'Commission Only Nonexempt' | 'Owner' +} +``` + +## 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 | diff --git a/docs/components/employee/deductions.md b/docs/components/employee/deductions.md new file mode 100644 index 000000000..5ae2ada16 --- /dev/null +++ b/docs/components/employee/deductions.md @@ -0,0 +1,48 @@ +--- +title: Employee.Deductions +sidebar_position: 11 +--- + +## Description + +Configures additional withholdings from employee pay. Deductions can be set as a percentage or fixed amount, and can be either recurring or one-time. + +## Code example + +```jsx +import { Employee } from '@gusto/embedded-react-sdk' + +function MyApp({ employeeId }) { + const handleEvent = (eventType, data) => { + // Handle deduction events + } + + 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. | + +## 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 | diff --git a/docs/components/employee/document-signer.md b/docs/components/employee/document-signer.md new file mode 100644 index 000000000..9cdf879f8 --- /dev/null +++ b/docs/components/employee/document-signer.md @@ -0,0 +1,45 @@ +--- +title: Employee.DocumentSigner +sidebar_position: 13 +--- + +## Description + +Provides the employee with an interface to read and sign required employment documents. When `withEmployeeI9` is enabled and the employee has I-9 configured, the Document Signer first routes the employee through the Employment Eligibility step and then presents the I-9 form for signature alongside other required documents. + +## Code example + +```jsx +import { Employee } from '@gusto/embedded-react-sdk' + +function MyApp({ employeeId }) { + const handleEvent = (eventType, data) => { + // Handle document signing events + } + + 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. | + +## 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 | diff --git a/docs/components/employee/employee-documents.md b/docs/components/employee/employee-documents.md new file mode 100644 index 000000000..7f988fd09 --- /dev/null +++ b/docs/components/employee/employee-documents.md @@ -0,0 +1,43 @@ +--- +title: Employee.EmployeeDocuments +sidebar_position: 12 +--- + +## Description + +Used during admin onboarding to configure which documents are included in the employee's self-onboarding experience. When the employee has been invited to self-onboard, this step allows the admin to enable or disable the I-9 (Employment Eligibility Verification) form. When the employee is not self-onboarding, this step displays a read-only summary of the documents that will be part of the onboarding process. + +This component is conditionally shown in `Employee.OnboardingFlow` when `withEmployeeI9` is set to `true`. + +## Code example + +```jsx +import { Employee } from '@gusto/embedded-react-sdk' + +function MyApp({ employeeId }) { + const handleEvent = (eventType, data) => { + // Handle document configuration events + } + + 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. | + +## Events + +| 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 | diff --git a/docs/components/employee/employee-list.md b/docs/components/employee/employee-list.md new file mode 100644 index 000000000..b7dd9bacc --- /dev/null +++ b/docs/components/employee/employee-list.md @@ -0,0 +1,42 @@ +--- +title: Employee.EmployeeList +sidebar_position: 5 +--- + +## Description + +Displays a list of employees with their full names and current onboarding status. Provides actions for adding new employees, editing existing employees, and removing employees from the list. + +## Code example + +```jsx +import { Employee } from '@gusto/embedded-react-sdk' + +function MyApp({ companyId }) { + const handleEvent = (eventType, data) => { + // Handle employee list events + } + + 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. | + +## 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 | diff --git a/docs/components/employee/employee.md b/docs/components/employee/employee.md new file mode 100644 index 000000000..1a36197bb --- /dev/null +++ b/docs/components/employee/employee.md @@ -0,0 +1,44 @@ +--- +title: Employee +sidebar_position: 1 +--- + +## Overview + +The Employee domain provides components for managing the full employee lifecycle — onboarding, self-onboarding, tax configuration, payment setup, document signing, and termination. Components are accessible as properties on the `Employee` namespace import. + +```jsx +import { Employee } from '@gusto/embedded-react-sdk' +``` + +## Flows + +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 | + +## 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) | diff --git a/docs/components/employee/employment-eligibility.md b/docs/components/employee/employment-eligibility.md new file mode 100644 index 000000000..5225faba4 --- /dev/null +++ b/docs/components/employee/employment-eligibility.md @@ -0,0 +1,41 @@ +--- +title: Employee.EmploymentEligibility +sidebar_position: 14 +--- + +## Description + +I-9 employment eligibility verification form. Collects the employee's citizenship or immigration status and work authorization details required for the I-9 Employment Eligibility Verification process. This component is typically rendered as part of the `Employee.DocumentSigner` flow when `withEmployeeI9` is enabled. + +## Code example + +```jsx +import { Employee } from '@gusto/embedded-react-sdk' + +function MyApp({ employeeId }) { + const handleEvent = (eventType, data) => { + // Handle employment eligibility events + } + + 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. | + +## 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 | diff --git a/docs/components/employee/federal-taxes.md b/docs/components/employee/federal-taxes.md new file mode 100644 index 000000000..93ad850c8 --- /dev/null +++ b/docs/components/employee/federal-taxes.md @@ -0,0 +1,41 @@ +--- +title: Employee.FederalTaxes +sidebar_position: 8 +--- + +## Description + +Provides required form inputs for configuring employee federal tax withholding. Renders the appropriate federal tax form fields based on the employee's W-4 configuration. + +## Code example + +```jsx +import { Employee } from '@gusto/embedded-react-sdk' + +function MyApp({ employeeId }) { + const handleEvent = (eventType, data) => { + // Handle federal tax events + } + + 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. | + +## 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 | diff --git a/docs/components/employee/landing.md b/docs/components/employee/landing.md new file mode 100644 index 000000000..2bfbf073f --- /dev/null +++ b/docs/components/employee/landing.md @@ -0,0 +1,42 @@ +--- +title: Employee.Landing +sidebar_position: 16 +--- + +## Description + +Self-onboarding welcome page. Displays guidance on what to expect from the self-onboarding workflow and what information the employee will be required to have on hand and provide. + +## Code example + +```jsx +import { Employee } from '@gusto/embedded-react-sdk' + +function MyApp({ companyId, employeeId }) { + const handleEvent = (eventType, data) => { + // Handle landing events + } + + 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. | + +## Events + +| 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 new file mode 100644 index 000000000..7b7fc4a28 --- /dev/null +++ b/docs/components/employee/onboarding-flow.md @@ -0,0 +1,68 @@ +--- +title: Employee.OnboardingFlow +sidebar_position: 2 +--- + +## Description + +Multi-step admin-driven employee onboarding flow. Orchestrates the full sequence of steps required to onboard an employee to payroll: creating the employee record, collecting personal details, configuring compensation, taxes, payment method, deductions, documents, and displaying a summary. + +### Steps + +1. **EmployeeList** — Select or create an employee +2. **Profile** — Collect name, addresses, SSN, DOB, and start date +3. **Compensation** — Job title, FLSA status, pay rate, and payment unit +4. **FederalTaxes** — Federal tax withholding configuration +5. **StateTaxes** — State tax withholding configuration +6. **PaymentMethod** — Bank account setup for direct deposit +7. **Deductions** — Additional withholdings +8. **EmployeeDocuments** — I-9 document configuration (requires both `withEmployeeI9` to be `true` and the employee's onboarding status to not be in a completed state) +9. **OnboardingSummary** — Onboarding completion status + +:::note Self-onboarding branch +When an employee is set up for self-onboarding, the flow skips **FederalTaxes**, **StateTaxes**, and **PaymentMethod** after the Compensation step. Those steps are instead handled by the employee themselves through the [SelfOnboardingFlow](./self-onboarding-flow.md). +::: + +## Code example + +```jsx +import { Employee } from '@gusto/embedded-react-sdk' + +function MyApp({ companyId }) { + const handleEvent = (eventType, data) => { + // Handle events from all subcomponents + } + + 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. | + +## Events + +Emits events from all subcomponents in the flow. See individual block documentation for the complete list of events: + +- [EmployeeList events](./employee-list.md#events) +- [Profile events](./profile.md#events) +- [Compensation events](./compensation.md#events) +- [FederalTaxes events](./federal-taxes.md#events) +- [StateTaxes events](./state-taxes.md#events) +- [PaymentMethod events](./payment-method.md#events) +- [Deductions events](./deductions.md#events) +- [EmployeeDocuments events](./employee-documents.md#events) +- [OnboardingSummary events](./onboarding-summary.md#events) diff --git a/docs/components/employee/onboarding-summary.md b/docs/components/employee/onboarding-summary.md new file mode 100644 index 000000000..fefed8b99 --- /dev/null +++ b/docs/components/employee/onboarding-summary.md @@ -0,0 +1,43 @@ +--- +title: Employee.OnboardingSummary +sidebar_position: 15 +--- + +## Description + +Displays the current state of employee onboarding completion. Shows a summary of all onboarding steps and their status. Used as the final step in both admin onboarding and self-onboarding flows. + +## Code example + +```jsx +import { Employee } from '@gusto/embedded-react-sdk' + +function MyApp({ employeeId }) { + const handleEvent = (eventType, data) => { + // Handle summary events + } + + 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. | + +## 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 | diff --git a/docs/components/employee/payment-method.md b/docs/components/employee/payment-method.md new file mode 100644 index 000000000..17f5cc03e --- /dev/null +++ b/docs/components/employee/payment-method.md @@ -0,0 +1,44 @@ +--- +title: Employee.PaymentMethod +sidebar_position: 10 +--- + +## Description + +Configures employee bank accounts for direct deposit. Bank accounts created with this component are used to pay the employee when payroll is run. Supports adding multiple accounts and splitting payments across them. + +## Code example + +```jsx +import { Employee } from '@gusto/embedded-react-sdk' + +function MyApp({ employeeId }) { + const handleEvent = (eventType, data) => { + // Handle payment method events + } + + 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. | + +## 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 | +| `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 | diff --git a/docs/components/employee/profile.md b/docs/components/employee/profile.md new file mode 100644 index 000000000..849c33be4 --- /dev/null +++ b/docs/components/employee/profile.md @@ -0,0 +1,80 @@ +--- +title: Employee.Profile +sidebar_position: 6 +--- + +## Description + +Collects basic employee information including name, work address, start date, email, Social Security number, date of birth, and home address. Supports both admin onboarding and self-onboarding modes — in self-onboarding mode, admin-only fields (like work address and start date) are hidden. + +This component also provides the option to invite the employee to self-onboard when used in admin mode. + +## Code example + +```jsx +import { Employee } from '@gusto/embedded-react-sdk' + +function MyApp({ companyId, employeeId }) { + const handleEvent = (eventType, data) => { + // Handle profile events + } + + return ( + + ) +} +``` + +## 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. | + +### defaultValues shape + +```typescript +{ + employee?: { + firstName?: string + middleInitial?: string + lastName?: string + email?: string + dateOfBirth?: string + } + homeAddress?: { + street1?: string + street2?: string + city?: string + state?: string + zip?: string + } +} +``` + +## 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 | diff --git a/docs/components/employee/self-onboarding-flow.md b/docs/components/employee/self-onboarding-flow.md new file mode 100644 index 000000000..7d8ac1297 --- /dev/null +++ b/docs/components/employee/self-onboarding-flow.md @@ -0,0 +1,60 @@ +--- +title: Employee.SelfOnboardingFlow +sidebar_position: 3 +--- + +## Description + +Employee-facing onboarding flow. When an admin enables self-onboarding for an employee, the employee can be provided with this workflow to complete their own onboarding information. Many subcomponents are shared with the admin onboarding flow but are configured for the employee context (hiding admin-only fields). + +### Steps + +1. **Landing** — Welcome page with guidance on what information is needed +2. **Profile** — Collect name, email, SSN, DOB, and home address +3. **FederalTaxes** — Federal tax withholding configuration +4. **StateTaxes** — State tax withholding configuration +5. **PaymentMethod** — Bank account setup for direct deposit +6. **DocumentSigner** — Read and sign employment documents (with optional I-9) +7. **OnboardingSummary** — Onboarding completion status + +## Code example + +```jsx +import { Employee } from '@gusto/embedded-react-sdk' + +function MyApp({ companyId, employeeId }) { + const handleEvent = (eventType, data) => { + // Handle events from all subcomponents + } + + return ( + + ) +} +``` + +## 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. | + +## Events + +Emits events from all subcomponents in the flow. See individual block documentation for the complete list of events: + +- [Landing events](./landing.md#events) +- [Profile events](./profile.md#events) +- [FederalTaxes events](./federal-taxes.md#events) +- [StateTaxes events](./state-taxes.md#events) +- [PaymentMethod events](./payment-method.md#events) +- [DocumentSigner events](./document-signer.md#events) +- [OnboardingSummary events](./onboarding-summary.md#events) diff --git a/docs/components/employee/state-taxes.md b/docs/components/employee/state-taxes.md new file mode 100644 index 000000000..16fa871d7 --- /dev/null +++ b/docs/components/employee/state-taxes.md @@ -0,0 +1,42 @@ +--- +title: Employee.StateTaxes +sidebar_position: 9 +--- + +## Description + +Provides required form inputs for configuring employee state tax withholding. Renders state-specific tax form fields based on the employee's work state. + +## Code example + +```jsx +import { Employee } from '@gusto/embedded-react-sdk' + +function MyApp({ employeeId }) { + const handleEvent = (eventType, data) => { + // Handle state tax events + } + + 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. | + +## 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 | diff --git a/docs/components/employee/taxes.md b/docs/components/employee/taxes.md new file mode 100644 index 000000000..c7121d64a --- /dev/null +++ b/docs/components/employee/taxes.md @@ -0,0 +1,40 @@ +--- +title: Employee.Taxes +sidebar_position: 19 +--- + +## Description + +Combined federal and state taxes component. This is a legacy component that renders both federal and state tax forms in a single step. For new implementations, prefer using [Employee.FederalTaxes](./federal-taxes.md) and [Employee.StateTaxes](./state-taxes.md) as separate components. + +## Code example + +```jsx +import { Employee } from '@gusto/embedded-react-sdk' + +function MyApp({ employeeId }) { + const handleEvent = (eventType, data) => { + // Handle tax events + } + + 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. | + +## Events + +| 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 new file mode 100644 index 000000000..8029bbe25 --- /dev/null +++ b/docs/components/employee/terminate-employee.md @@ -0,0 +1,51 @@ +--- +title: Employee.TerminateEmployee +sidebar_position: 17 +--- + +## Description + +The main termination form where users specify the employee's last day of work and select how to process the final payroll. Automatically detects existing terminations — if an active termination exists, the form is pre-populated for editing. If the employee is already terminated, the user is redirected to the summary view. + +### Form fields + +- **Last day of work** — The effective date for the termination. Can be in the past or future. Must be on or after the employee's hire date. +- **Payroll option** — How to process the employee's final pay: run a dismissal payroll, include in regular payroll, or handle it another way. + +## Code example + +```jsx +import { Employee } from '@gusto/embedded-react-sdk' + +function MyApp({ companyId, employeeId }) { + const handleEvent = (eventType, data) => { + // Handle termination form events + } + + 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. | + +## 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 }` | diff --git a/docs/components/employee/termination-flow.md b/docs/components/employee/termination-flow.md new file mode 100644 index 000000000..6c01edc97 --- /dev/null +++ b/docs/components/employee/termination-flow.md @@ -0,0 +1,60 @@ +--- +title: Employee.TerminationFlow +sidebar_position: 4 +--- + +## Description + +Full employee termination workflow. Guides users through selecting a termination date, choosing how to process final payroll, reviewing termination details, and managing the offboarding process. The flow consists of two main states: the termination form and the termination summary. + +### Payroll options + +The workflow supports three payroll processing options for the employee's final paycheck: + +- **`dismissalPayroll`** — Run a dismissal payroll. Automatically determines the pay period and makes default PTO payout recommendations. +- **`regularPayroll`** — Process final pay in the employee's regular payroll. Defers payroll action until the next scheduled regular payroll. +- **`anotherWay`** — Handle final pay outside of Gusto. Triggers the off-cycle payroll creation flow. + +## Code example + +```jsx +import { Employee } from '@gusto/embedded-react-sdk' + +function MyApp({ companyId, employeeId }) { + const handleEvent = (eventType, data) => { + // Handle termination events + } + + 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. | + +## 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 }` | diff --git a/docs/components/employee/termination-summary.md b/docs/components/employee/termination-summary.md new file mode 100644 index 000000000..95a6b3f9c --- /dev/null +++ b/docs/components/employee/termination-summary.md @@ -0,0 +1,58 @@ +--- +title: Employee.TerminationSummary +sidebar_position: 18 +--- + +## Description + +Displays termination details and provides actions for managing the termination — editing details, cancelling the termination, or running payroll. Also includes an offboarding checklist with guidance on final pay timing, tax forms, and account disconnection. + +### Conditional actions + +The summary displays different action buttons based on the termination state: + +- **Edit termination** — Available when the termination date is in the future and the employee is not yet terminated. +- **Cancel termination** — Available when "Include in regular payroll" or "I'll handle it another way" was selected. Cannot cancel if "Run a dismissal payroll" was selected. +- **Run termination payroll** — Shown for the dismissal payroll option. +- **Run off-cycle payroll** — Shown when "I'll handle it another way" was selected. + +## Code example + +```jsx +import { Employee } from '@gusto/embedded-react-sdk' + +function MyApp({ companyId, employeeId }) { + const handleEvent = (eventType, data) => { + // Handle termination summary events + } + + return ( + + ) +} +``` + +## 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. | + +## 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 }` | diff --git a/docs/components/information-requests/information-request-form.md b/docs/components/information-requests/information-request-form.md new file mode 100644 index 000000000..8c956401a --- /dev/null +++ b/docs/components/information-requests/information-request-form.md @@ -0,0 +1,39 @@ +--- +title: InformationRequests.InformationRequestForm +sidebar_position: 4 +--- + +Form for responding to a specific information request. Displays the request details and provides input fields for the user to submit their response. + +## Usage + +```tsx +import { InformationRequests } from '@gusto/embedded-react-sdk' + +function MyComponent() { + return ( + { + console.log(eventType, data) + }} + /> + ) +} +``` + +## 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. | + +## 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 | diff --git a/docs/components/information-requests/information-request-list.md b/docs/components/information-requests/information-request-list.md new file mode 100644 index 000000000..696f0d6c7 --- /dev/null +++ b/docs/components/information-requests/information-request-list.md @@ -0,0 +1,36 @@ +--- +title: InformationRequests.InformationRequestList +sidebar_position: 3 +--- + +Displays a list of information requests for a company, showing their status and allowing the user to select one to respond to. + +## Usage + +```tsx +import { InformationRequests } from '@gusto/embedded-react-sdk' + +function MyComponent() { + return ( + { + console.log(eventType, data) + }} + /> + ) +} +``` + +## 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. | + +## Events + +| 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 new file mode 100644 index 000000000..ee100f49d --- /dev/null +++ b/docs/components/information-requests/information-requests-flow.md @@ -0,0 +1,39 @@ +--- +title: InformationRequests.InformationRequestsFlow +sidebar_position: 2 +--- + +End-to-end workflow for viewing and responding to information requests. Orchestrates the list view and response form, with optional alert display for pending requests. + +## Usage + +```tsx +import { InformationRequests } from '@gusto/embedded-react-sdk' + +function MyApp() { + return ( + { + console.log(eventType, data) + }} + /> + ) +} +``` + +## 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`. | + +## 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 | diff --git a/docs/components/information-requests/information-requests.md b/docs/components/information-requests/information-requests.md new file mode 100644 index 000000000..bf01185df --- /dev/null +++ b/docs/components/information-requests/information-requests.md @@ -0,0 +1,19 @@ +--- +title: Information Requests +sidebar_position: 1 +--- + +The Information Requests domain provides components for responding to tax agency notices and other information requests that require action from the company. These components handle listing pending requests, displaying request details, and submitting responses. + +## Flow + +| Component | Description | +| --- | --- | +| [InformationRequests.InformationRequestsFlow](./information-requests-flow.md) | End-to-end workflow for viewing and responding to information requests. | + +## Blocks + +| 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 new file mode 100644 index 000000000..7ca5fa56e --- /dev/null +++ b/docs/components/payroll/confirm-wire-details.md @@ -0,0 +1,43 @@ +--- +title: Payroll.ConfirmWireDetails +sidebar_position: 15 +--- + +Wire transfer confirmation step for verifying payment details before submitting payroll. Used when the company pays via wire transfer. + +## Usage + +```tsx +import { Payroll } from '@gusto/embedded-react-sdk' + +function MyComponent() { + return ( + { + console.log(eventType, data) + }} + /> + ) +} +``` + +## 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. | + +## 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 | diff --git a/docs/components/payroll/dismissal-flow.md b/docs/components/payroll/dismissal-flow.md new file mode 100644 index 000000000..3c5a493bd --- /dev/null +++ b/docs/components/payroll/dismissal-flow.md @@ -0,0 +1,38 @@ +--- +title: Payroll.DismissalFlow +sidebar_position: 5 +--- + +Workflow for processing dismissal (termination) payrolls. Handles pay period selection and final payment processing for terminated employees. + +## Usage + +```tsx +import { Payroll } from '@gusto/embedded-react-sdk' + +function MyApp() { + return ( + { + console.log(eventType, data) + }} + /> + ) +} +``` + +## 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. | + +## Events + +| 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 new file mode 100644 index 000000000..89170d3fe --- /dev/null +++ b/docs/components/payroll/off-cycle-creation.md @@ -0,0 +1,37 @@ +--- +title: Payroll.OffCycleCreation +sidebar_position: 16 +--- + +Form for creating an off-cycle payroll with type selection and employee assignment. + +## Usage + +```tsx +import { Payroll } from '@gusto/embedded-react-sdk' + +function MyComponent() { + return ( + { + console.log(eventType, data) + }} + /> + ) +} +``` + +## 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. | + +## Events + +| 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 new file mode 100644 index 000000000..d52591c72 --- /dev/null +++ b/docs/components/payroll/off-cycle-deductions-setting.md @@ -0,0 +1,36 @@ +--- +title: Payroll.OffCycleDeductionsSetting +sidebar_position: 17 +--- + +Configuration for deductions in off-cycle payrolls. Allows the user to specify which deductions should be applied to the off-cycle payroll run. + +## Usage + +```tsx +import { Payroll } from '@gusto/embedded-react-sdk' + +function MyComponent() { + return ( + { + console.log(eventType, data) + }} + /> + ) +} +``` + +## 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. | + +## Events + +| 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 new file mode 100644 index 000000000..10844929b --- /dev/null +++ b/docs/components/payroll/off-cycle-flow.md @@ -0,0 +1,38 @@ +--- +title: Payroll.OffCycleFlow +sidebar_position: 4 +--- + +Workflow for creating and running off-cycle payrolls such as bonuses, corrections, or other payments outside the regular payroll schedule. + +## Usage + +```tsx +import { Payroll } from '@gusto/embedded-react-sdk' + +function MyApp() { + return ( + { + console.log(eventType, data) + }} + /> + ) +} +``` + +## 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. | + +## Events + +| 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 new file mode 100644 index 000000000..000ff2416 --- /dev/null +++ b/docs/components/payroll/off-cycle-reason-selection.md @@ -0,0 +1,36 @@ +--- +title: Payroll.OffCycleReasonSelection +sidebar_position: 18 +--- + +Selection of the reason for running an off-cycle payroll, such as a bonus, correction, or final pay. + +## Usage + +```tsx +import { Payroll } from '@gusto/embedded-react-sdk' + +function MyComponent() { + return ( + { + console.log(eventType, data) + }} + /> + ) +} +``` + +## 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. | + +## Events + +| 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 new file mode 100644 index 000000000..837f2b6db --- /dev/null +++ b/docs/components/payroll/payroll-blocker.md @@ -0,0 +1,35 @@ +--- +title: Payroll.PayrollBlockerList +sidebar_position: 14 +--- + +Displays blocking issues that must be resolved before running payroll. This component may forward events from embedded recovery or information-request flows it renders inline. + +## Usage + +```tsx +import { Payroll } from '@gusto/embedded-react-sdk' + +function MyComponent() { + return ( + { + console.log(eventType, data) + }} + /> + ) +} +``` + +## 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. | + +## Events + +This component does not emit its own events directly. It renders embedded RecoveryCases and InformationRequestsFlow sub-components and forwards their events through the `onEvent` callback. diff --git a/docs/components/payroll/payroll-configuration.md b/docs/components/payroll/payroll-configuration.md new file mode 100644 index 000000000..435924fb6 --- /dev/null +++ b/docs/components/payroll/payroll-configuration.md @@ -0,0 +1,48 @@ +--- +title: Payroll.PayrollConfiguration +sidebar_position: 10 +--- + +Payroll preparation step for configuring employee hours, earnings, and deductions. This is where the user enters compensation details for each employee before submitting the payroll. + +## Usage + +```tsx +import { Payroll } from '@gusto/embedded-react-sdk' + +function MyComponent() { + return ( + { + console.log(eventType, data) + }} + /> + ) +} +``` + +## 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. | + +## 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 }` | diff --git a/docs/components/payroll/payroll-edit-employee.md b/docs/components/payroll/payroll-edit-employee.md new file mode 100644 index 000000000..cfa62a28f --- /dev/null +++ b/docs/components/payroll/payroll-edit-employee.md @@ -0,0 +1,43 @@ +--- +title: Payroll.PayrollEditEmployee +sidebar_position: 11 +--- + +Form for editing an individual employee's payroll details including hours, earnings, deductions, and reimbursements. + +## Usage + +```tsx +import { Payroll } from '@gusto/embedded-react-sdk' + +function MyComponent() { + return ( + { + console.log(eventType, data) + }} + /> + ) +} +``` + +## 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. | + +## 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 | diff --git a/docs/components/payroll/payroll-execution-flow.md b/docs/components/payroll/payroll-execution-flow.md new file mode 100644 index 000000000..476f08f9d --- /dev/null +++ b/docs/components/payroll/payroll-execution-flow.md @@ -0,0 +1,45 @@ +--- +title: Payroll.PayrollExecutionFlow +sidebar_position: 3 +--- + +Full payroll execution workflow for a specific payroll, from configuration through employee editing, review, and submission. Use this when you already have a payroll ID and want to skip the landing and list steps. + +## Usage + +```tsx +import { Payroll } from '@gusto/embedded-react-sdk' + +function MyApp() { + return ( + { + console.log(eventType, data) + }} + /> + ) +} +``` + +## 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. | + +## Events + +This component emits events from all of its subcomponents. See the individual block documentation for the specific events each step produces: + +- [PayrollConfiguration events](./payroll-configuration.md#events) +- [PayrollEditEmployee events](./payroll-edit-employee.md#events) +- [PayrollOverview events](./payroll-overview.md#events) +- [PayrollReceipts events](./payroll-receipts.md#events) diff --git a/docs/components/payroll/payroll-flow.md b/docs/components/payroll/payroll-flow.md new file mode 100644 index 000000000..e667ce24c --- /dev/null +++ b/docs/components/payroll/payroll-flow.md @@ -0,0 +1,51 @@ +--- +title: Payroll.PayrollFlow +sidebar_position: 2 +--- + +End-to-end payroll workflow that orchestrates the full payroll lifecycle — from the payroll landing page through configuration, employee editing, review, submission, and receipt viewing. + +## Usage + +```tsx +import { Payroll } from '@gusto/embedded-react-sdk' + +function MyApp() { + return ( + { + console.log(eventType, data) + }} + /> + ) +} +``` + +## 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. | + +## 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 | diff --git a/docs/components/payroll/payroll-history.md b/docs/components/payroll/payroll-history.md new file mode 100644 index 000000000..8f97f140c --- /dev/null +++ b/docs/components/payroll/payroll-history.md @@ -0,0 +1,39 @@ +--- +title: Payroll.PayrollHistory +sidebar_position: 9 +--- + +Displays historical payroll runs with summary information, receipt access, and cancellation options. + +## Usage + +```tsx +import { Payroll } from '@gusto/embedded-react-sdk' + +function MyComponent() { + return ( + { + console.log(eventType, data) + }} + /> + ) +} +``` + +## 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. | + +## Events + +| 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 | diff --git a/docs/components/payroll/payroll-landing.md b/docs/components/payroll/payroll-landing.md new file mode 100644 index 000000000..073d9b5a0 --- /dev/null +++ b/docs/components/payroll/payroll-landing.md @@ -0,0 +1,50 @@ +--- +title: Payroll.PayrollLanding +sidebar_position: 7 +--- + +Landing page for payroll that combines the payroll list with action options such as running a new payroll. Serves as the entry point for the payroll workflow. + +## Usage + +```tsx +import { Payroll } from '@gusto/embedded-react-sdk' + +function MyComponent() { + return ( + { + console.log(eventType, data) + }} + /> + ) +} +``` + +## 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. | + +## 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 | + +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 new file mode 100644 index 000000000..169a44ca9 --- /dev/null +++ b/docs/components/payroll/payroll-list.md @@ -0,0 +1,40 @@ +--- +title: Payroll.PayrollList +sidebar_position: 8 +--- + +Displays a list of payrolls for a company with their status, pay period, and available actions. + +## Usage + +```tsx +import { Payroll } from '@gusto/embedded-react-sdk' + +function MyComponent() { + return ( + { + console.log(eventType, data) + }} + /> + ) +} +``` + +## 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. | + +## 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 | diff --git a/docs/components/payroll/payroll-overview.md b/docs/components/payroll/payroll-overview.md new file mode 100644 index 000000000..8d4e13851 --- /dev/null +++ b/docs/components/payroll/payroll-overview.md @@ -0,0 +1,48 @@ +--- +title: Payroll.PayrollOverview +sidebar_position: 12 +--- + +Review and submission step that displays payroll totals, employee breakdowns, and handles final payroll confirmation. This is the last step before submitting the payroll for processing. + +## Usage + +```tsx +import { Payroll } from '@gusto/embedded-react-sdk' + +function MyComponent() { + return ( + { + console.log(eventType, data) + }} + /> + ) +} +``` + +## 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. | + +## 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 }` | diff --git a/docs/components/payroll/payroll-receipts.md b/docs/components/payroll/payroll-receipts.md new file mode 100644 index 000000000..42fec6c87 --- /dev/null +++ b/docs/components/payroll/payroll-receipts.md @@ -0,0 +1,36 @@ +--- +title: Payroll.PayrollReceipts +sidebar_position: 13 +--- + +Displays payroll receipts and payment details after a payroll has been submitted and processed. + +## Usage + +```tsx +import { Payroll } from '@gusto/embedded-react-sdk' + +function MyComponent() { + return ( + { + console.log(eventType, data) + }} + /> + ) +} +``` + +## 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. | + +## Events + +This component is purely presentational and does not emit any events directly. When used within PayrollLanding, navigation events such as `RUN_PAYROLL_BACK` are handled by the parent flow. diff --git a/docs/components/payroll/payroll.md b/docs/components/payroll/payroll.md new file mode 100644 index 000000000..55b9e6ca3 --- /dev/null +++ b/docs/components/payroll/payroll.md @@ -0,0 +1,35 @@ +--- +title: Payroll +sidebar_position: 1 +--- + +The Payroll domain provides components for running payroll on Gusto's embedded payroll platform. These components handle payroll preparation, employee compensation editing, payroll review and submission, off-cycle payrolls, dismissal payrolls, transition payrolls, and payment receipts. + +## Flows + +| 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. | + +## 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. | diff --git a/docs/components/payroll/recovery-cases.md b/docs/components/payroll/recovery-cases.md new file mode 100644 index 000000000..7519be62b --- /dev/null +++ b/docs/components/payroll/recovery-cases.md @@ -0,0 +1,39 @@ +--- +title: Payroll.RecoveryCases +sidebar_position: 20 +--- + +Displays and manages payroll recovery cases that require action, such as failed payments or returned transactions. + +## Usage + +```tsx +import { Payroll } from '@gusto/embedded-react-sdk' + +function MyComponent() { + return ( + { + console.log(eventType, data) + }} + /> + ) +} +``` + +## 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. | + +## 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 | +| `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 new file mode 100644 index 000000000..1a835a637 --- /dev/null +++ b/docs/components/payroll/transition-creation.md @@ -0,0 +1,42 @@ +--- +title: Payroll.TransitionCreation +sidebar_position: 19 +--- + +Form for creating a transition payroll when changing pay schedules. Handles the gap period between the old and new pay schedule to ensure employees are paid correctly during the transition. + +## Usage + +```tsx +import { Payroll } from '@gusto/embedded-react-sdk' + +function MyComponent() { + return ( + { + console.log(eventType, data) + }} + /> + ) +} +``` + +## 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. | + +## Events + +| 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 new file mode 100644 index 000000000..dda912c22 --- /dev/null +++ b/docs/components/payroll/transition-flow.md @@ -0,0 +1,42 @@ +--- +title: Payroll.TransitionFlow +sidebar_position: 6 +--- + +Workflow for creating transition payrolls when changing pay schedules. Handles the gap period between the old and new pay schedule. + +## Usage + +```tsx +import { Payroll } from '@gusto/embedded-react-sdk' + +function MyApp() { + return ( + { + console.log(eventType, data) + }} + /> + ) +} +``` + +## 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. | + +## Events + +| 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 new file mode 100644 index 000000000..82c13dc9a --- /dev/null +++ b/docs/concepts/authentication-and-proxy.md @@ -0,0 +1,135 @@ +--- +title: Authentication and Proxy +sidebar_position: 4 +--- + +The SDK does not call the Gusto API directly. All API requests are routed through your backend proxy, which handles OAuth2 token management and enforces user-level authorization. + +## Why a proxy is required + +The SDK runs in the browser. Exposing API credentials or OAuth tokens to the client would be a security risk. Instead, the SDK sends requests to your backend, which: + +1. Verifies the user's session +2. Acquires or refreshes an OAuth2 token from the Gusto API +3. Forwards the request to Gusto with the token attached +4. Returns the response to the SDK + +## Setting up the proxy connection + +Point the SDK to your proxy with the `baseUrl` config option on `GustoProvider`: + +```tsx +import { GustoProvider } from '@gusto/embedded-react-sdk' +import '@gusto/embedded-react-sdk/style.css' + +function App({ children }) { + return ( + + {children} + + ) +} +``` + +The SDK appends Gusto API paths to this base URL. For example, a request to `/v1/companies/:companyId/employees` becomes `/api/gusto/v1/companies/:companyId/employees`. + +## Adding headers + +### Static headers + +For headers that don't change (API keys, partner identifiers), pass them in `config.headers`: + +```tsx + +``` + +### Dynamic headers via request interceptors + +For headers computed at request time (e.g., refreshing tokens), use the `hooks.beforeRequest` interceptor: + +```tsx + { + request.headers.set('Authorization', 'Bearer ' + getToken()) + return request + }, + }, + ], + }, + }} +> +``` + +### Client IP header for form signing + +Some Gusto API endpoints require the end user's IP address for form signing compliance. Pass the `x-gusto-client-ip` header from your proxy with the user's real IP address. + +## Proxy security + +The Gusto API enforces application-level protections (scopes, company-bound tokens, rate limits). Your proxy enforces **user-level** authorization. Both layers are necessary — UI restrictions alone are not sufficient since users can make API requests directly. + +### Requirements + +1. **Authenticate every request** — verify the user's session on every proxied request, not just at login. +2. **Allowlist endpoints** — only forward requests to API endpoints your application uses. Deny everything else. +3. **Validate resource ownership** — verify that the authenticated user is authorized to access the resource in the URL (e.g., an employee should only reach their own employee ID). +4. **Log proxied requests** — maintain audit logs for security monitoring and incident response. + +### Endpoint allowlisting + +The SDK ships a machine-readable JSON file listing every Block and Flow with their endpoints. Import it from the package: + +```typescript +import inventory from '@gusto/embedded-react-sdk/endpoint-inventory.json' +``` + +The JSON maps each component to its API endpoints and required URL parameters: + +```json +{ + "blocks": { + "Employee.FederalTaxes": { + "endpoints": [ + { "method": "GET", "path": "/v1/employees/:employeeId/federal_taxes" }, + { "method": "PUT", "path": "/v1/employees/:employeeId/federal_taxes" } + ], + "variables": ["employeeId"] + } + }, + "flows": { + "Employee.SelfOnboardingFlow": { + "blocks": ["Employee.Landing", "Employee.Profile", "..."], + "endpoints": [ + { "method": "GET", "path": "/v1/employees/:employeeId" }, + { "method": "GET", "path": "/v1/companies/:companyId" } + ], + "variables": ["companyId", "employeeId"] + } + } +} +``` + +Look up the components your app uses, substitute `:param` placeholders with session values, and use the result as your allowlist. The inventory is auto-generated on every build and verified in CI, so upgrading the SDK automatically reflects endpoint changes. + +### Scoping by role + +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 | +| `:companyId` + `:employeeId` | Self-service employee, restricted to their own data | diff --git a/docs/concepts/composition.md b/docs/concepts/composition.md new file mode 100644 index 000000000..026580f3e --- /dev/null +++ b/docs/concepts/composition.md @@ -0,0 +1,124 @@ +--- +title: Composition +sidebar_position: 5 +--- + +The SDK supports flexible composition. Use a Flow component for the full out-of-the-box experience, or use individual Blocks to build a custom flow tailored to your application. + +## Using a Flow + +A single Flow component renders an entire multi-step user journey: + +```tsx +import { Employee, GustoProvider } from '@gusto/embedded-react-sdk' +import '@gusto/embedded-react-sdk/style.css' + +function App({ companyId }) { + return ( + + { + console.log(eventType, data) + }} + /> + + ) +} +``` + +This handles internal navigation between steps, data loading, validation, and API calls. It's the fastest path to a working integration. + +## Using individual Blocks + +Each step of a Flow is also available as a standalone Block. You can render any Block in isolation: + +```tsx +import { Employee, GustoProvider } from '@gusto/embedded-react-sdk' +import '@gusto/embedded-react-sdk/style.css' + +function App({ employeeId, startDate }) { + return ( + + { + if (eventType === 'employee/compensations/done') { + // Navigate to your next step + } + }} + /> + + ) +} +``` + +Because each Block is independent and saves data via the API on submission, you can: + +- **Reorder steps** to match your desired user flow +- **Skip steps** that aren't relevant to your use case +- **Insert your own content** between SDK steps +- **Embed Blocks** within your existing page layouts + +## Integrating with your router + +Blocks work naturally with any routing library. Use `onEvent` to trigger navigation when a step completes. + +Here's an abbreviated example with React Router: + +```tsx +import { Employee, componentEvents, GustoProvider } from '@gusto/embedded-react-sdk' +import { Routes, Route, useNavigate } from 'react-router-dom' + +function ProfileStep({ companyId, employeeId }) { + const navigate = useNavigate() + + return ( + { + if (eventType === componentEvents.EMPLOYEE_PROFILE_DONE) { + navigate('/onboarding/taxes') + } + }} + /> + ) +} + +function TaxesStep({ employeeId }) { + const navigate = useNavigate() + + return ( + { + if (eventType === componentEvents.EMPLOYEE_TAXES_DONE) { + navigate('/onboarding/payment') + } + }} + /> + ) +} + +function OnboardingApp({ companyId, employeeId }) { + return ( + + + } + /> + } + /> + {/* Additional steps... */} + + + ) +} +``` + +The same pattern applies to Next.js, TanStack Router, or any other routing solution. The key is listening for the appropriate `*_DONE` event from each Block and triggering navigation in your `onEvent` handler. diff --git a/docs/concepts/concepts.md b/docs/concepts/concepts.md new file mode 100644 index 000000000..99e406f8e --- /dev/null +++ b/docs/concepts/concepts.md @@ -0,0 +1,22 @@ +--- +title: Core Concepts +sidebar_position: 1 +--- + +This section covers the core concepts you need to understand when building with the Gusto Embedded React SDK. + +- [**Flows and Blocks**](./flows-and-blocks.md) — The SDK provides two levels of components: Flows handle entire multi-step user journeys out of the box, while Blocks give you individual steps for custom composition. + +- [**Provider and Configuration**](./provider-and-configuration.md) — Every SDK integration starts with `GustoProvider`, which configures your API proxy, theming, i18n, and component adapters. + +- [**Events**](./events.md) — Components communicate through a unified event system, emitting typed events for user interactions, API responses, and step completions. + +- [**Authentication and Proxy**](./authentication-and-proxy.md) — The SDK routes all API calls through your backend proxy, where you handle OAuth2 tokens and enforce user-level authorization. + +- [**Composition**](./composition.md) — Build custom flows by composing individual Blocks, reordering steps, and integrating with your router. + +- [**Theming and Customization**](./theming-and-customization.md) — Match the SDK to your brand using CSS variable theming, or replace UI primitives entirely with component adapters. + +- [**Error Handling**](./error-handling.md) — The SDK handles errors at multiple layers: form validation, API errors, error boundaries, and observability hooks for production monitoring. + +- [**Internationalization**](./i18n.md) — Override any user-facing string via the `dictionary` prop, with full TypeScript support for key discovery. diff --git a/docs/concepts/error-handling.md b/docs/concepts/error-handling.md new file mode 100644 index 000000000..43d4b078a --- /dev/null +++ b/docs/concepts/error-handling.md @@ -0,0 +1,130 @@ +--- +title: Error Handling +sidebar_position: 7 +--- + +The SDK handles errors at multiple layers: form submissions, component rendering, and top-level provider boundaries. All errors are normalized into a unified `SDKError` type. + +## SDKError + +Every error surfaces as an `SDKError`: + +```typescript +interface SDKError { + category: 'api_error' | 'validation_error' | 'network_error' | 'internal_error' + message: string + httpStatus?: number + fieldErrors: SDKFieldError[] + raw?: unknown +} +``` + +| 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 + +For `api_error` responses with structured validation errors (e.g., 422), the SDK extracts field-level errors: + +```typescript +interface SDKFieldError { + field: string + category: string + message: string + metadata?: Record +} +``` + +Components that use `react-hook-form` automatically map these field errors to inline form validation. + +## Error boundaries + +### Component-level + +Each SDK component is wrapped in a React `ErrorBoundary`. Unexpected rendering errors are caught and displayed as a recoverable error screen with a "Try again" button. + +### Top-level + +Errors that escape component-level boundaries are caught by a top-level `ErrorBoundary` in `GustoProvider`. This prevents SDK errors from crashing your application. + +## Error display + +The SDK renders errors based on their shape: + +- **Field errors** — displayed as an unordered list of individual field messages +- **Validation errors** — displayed as preformatted Zod output +- **All other errors** — displayed as a generic "An error occurred" message + +## Observability hooks + +To track errors in production, configure the `observability` option on `GustoProvider`: + +```tsx +import { GustoProvider } from '@gusto/embedded-react-sdk' +import type { ObservabilityHook } from '@gusto/embedded-react-sdk' + +const observability: ObservabilityHook = { + onError: (error) => { + Sentry.captureException(error.raw ?? new Error(error.message), { + tags: { + error_category: error.category, + component: error.componentName ?? 'unknown', + http_status: String(error.httpStatus ?? ''), + }, + }) + }, + onMetric: (metric) => { + if (metric.unit === 'ms') { + datadogRum.addTiming(metric.name, metric.value) + } + }, +} + +function App({ children }) { + return ( + + {children} + + ) +} +``` + +The `onError` callback receives an `ObservabilityError`, which extends `SDKError` with: + +- `timestamp` — when the error occurred +- `componentName` — the SDK component that errored (e.g., `"Employee.Profile"`) +- `componentStack` — the React component hierarchy (for rendering errors) + +The `onMetric` callback receives performance metrics like form submission duration and component loading time. + +## PII sanitization + +By default, the SDK sanitizes all error and metric data before passing it to your observability hooks: + +- SSNs, email addresses, phone numbers, credit card numbers, and API keys are pattern-redacted +- Sensitive field names (`password`, `token`, `ssn`, `bankAccount`, etc.) are removed +- The `raw` error field is excluded by default to prevent PII leakage + +Configure sanitization behavior: + +```tsx +const observability: ObservabilityHook = { + onError: (error) => errorTracker.capture(error), + sanitization: { + enabled: true, + includeRawError: false, + additionalSensitiveFields: ['customerId'], + }, +} +``` + +For detailed integration examples (Sentry, Datadog) and the full metric/error type reference, see the [observability documentation](../guides/observability.md). diff --git a/docs/concepts/events.md b/docs/concepts/events.md new file mode 100644 index 000000000..966107e88 --- /dev/null +++ b/docs/concepts/events.md @@ -0,0 +1,274 @@ +--- +title: Events +sidebar_position: 3 +--- + +The SDK uses a unified event system to communicate user interactions, API responses, and step completions to your application. + +## How events work + +Every SDK component accepts an `onEvent` callback: + +```typescript +(eventType: EventType, data?: unknown) => void +``` + +- `eventType` is a string constant identifying the event +- `data` is an optional payload, typically the API response associated with the action (e.g., the created employee object) + +## Using events + +Import `componentEvents` for type-safe event constants: + +```tsx +import { Employee, GustoProvider, componentEvents } from '@gusto/embedded-react-sdk' + +function App({ companyId, employeeId }) { + const handleEvent = (eventType, data) => { + if (eventType === componentEvents.EMPLOYEE_CREATED) { + const newEmployeeId = data.uuid + analytics.track('employee_created', { employeeId: newEmployeeId }) + } + + if (eventType === componentEvents.EMPLOYEE_PROFILE_DONE) { + router.push('/next-step') + } + } + + return ( + + + + ) +} +``` + +## Common patterns + +**Navigation** — Listen for `*_DONE` events to know when a step is complete and navigate to the next step. + +**Analytics** — Track `*_CREATED`, `*_UPDATED`, and `*_DELETED` events to measure user progress. + +**Side effects** — Trigger actions in your application when specific events fire (e.g., refresh a list after an employee is created). + +**Cancellation** — Listen for the `CANCEL` event to handle user-initiated cancellation. + +## Event types reference + +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` | + +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 new file mode 100644 index 000000000..13d045b51 --- /dev/null +++ b/docs/concepts/flows-and-blocks.md @@ -0,0 +1,102 @@ +--- +title: Flows and Blocks +sidebar_position: 1 +--- + +The Gusto Embedded React SDK organizes its components into two levels of abstraction: **Flows** and **Blocks**. + +## Flows (Workflows) + +Flows are pre-built, multi-step components that handle an entire user journey. They manage internal navigation, data loading, form validation, and API calls across all steps. Rendering a single Flow component gives you a complete experience with minimal setup. + +### 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 | + +### Using a Flow + +```tsx +import { Employee, GustoProvider } from '@gusto/embedded-react-sdk' +import '@gusto/embedded-react-sdk/style.css' + +function App({ companyId }) { + return ( + + { + console.log(eventType, data) + }} + /> + + ) +} +``` + +## Blocks (Building Blocks) + +Blocks are individual step-level components. Each Block handles one piece of a workflow — a single form, a single view, or a single action. Blocks can be used standalone or composed together into a custom flow. + +Examples of Blocks include: + +- `Employee.Profile` — employee personal details form +- `Employee.Compensation` — job and compensation setup +- `Employee.PaymentMethod` — direct deposit configuration +- `Company.BankAccount` — company bank account verification +- `Company.Locations` — manage company work locations +- `Payroll.PayrollOverview` — payroll review and submission + +Each Block is independent: it loads its own data, validates its own forms, and saves through the API when the user submits. + +### Using a Block + +```tsx +import { Employee, GustoProvider } from '@gusto/embedded-react-sdk' +import '@gusto/embedded-react-sdk/style.css' + +function App({ companyId, employeeId }) { + return ( + + { + if (eventType === 'employee/compensations/done') { + // Navigate to next step + } + }} + /> + + ) +} +``` + +## When to use each + +**Use a Flow when:** + +- You want the full experience with minimal code +- The default step order and navigation work for your use case +- You want to ship quickly and iterate later + +**Use Blocks when:** + +- You need to reorder, skip, or add steps +- You want to embed individual steps within your existing page layouts +- You need to integrate with your own routing (React Router, Next.js, etc.) +- You want to mix SDK components with your own custom UI between steps + +See [Composition](./composition.md) for details on building custom flows from Blocks. diff --git a/docs/concepts/i18n.md b/docs/concepts/i18n.md new file mode 100644 index 000000000..8e2eadccb --- /dev/null +++ b/docs/concepts/i18n.md @@ -0,0 +1,80 @@ +--- +title: Internationalization +sidebar_position: 8 +--- + +The SDK uses [i18next](https://www.i18next.com/) internally for all user-facing text. If your application also uses i18next, the SDK creates its own isolated instance to avoid conflicts. + +## Overriding strings + +Use the `dictionary` prop on `GustoProvider` to override any string in the SDK. The structure is: + +```typescript +{ + [languageCode]: { + [ComponentNamespace]: { + [key]: 'Your custom text' + } + } +} +``` + +### Example + +```tsx +import { Employee, GustoProvider } from '@gusto/embedded-react-sdk' +import '@gusto/embedded-react-sdk/style.css' + +function App({ companyId }) { + return ( + + {}} /> + + ) +} +``` + +This replaces the default title and submit button text on the `Employee.PaymentMethod` step. + +## TypeScript support + +All dictionary keys are fully typed. Your IDE provides autocomplete for: + +- Component namespace names (e.g., `'Employee.PaymentMethod'`) +- Individual string keys within each namespace (e.g., `'title'`, `'submitCta'`) + +Start typing inside the dictionary object to see available options. + +## Copy customization + +The `dictionary` prop isn't limited to translation. Use it to customize copy for your audience without changing languages — adjust terminology, tone, or instructions to match your product's voice. + +## Language configuration + +Control the active language and locale through `GustoProvider` props: + +```tsx + +``` + +| 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 new file mode 100644 index 000000000..b7cbf377d --- /dev/null +++ b/docs/concepts/provider-and-configuration.md @@ -0,0 +1,157 @@ +--- +title: Provider and Configuration +sidebar_position: 2 +--- + +`GustoProvider` is the root component that must wrap all SDK components. It configures API connectivity, theming, internationalization, and component adapters. + +## Basic setup + +```tsx +import { GustoProvider } from '@gusto/embedded-react-sdk' +import '@gusto/embedded-react-sdk/style.css' + +function App({ children }) { + return ( + + {children} + + ) +} +``` + +## Config options + +The `config` prop accepts an `APIConfig` object: + +### `baseUrl` (required) + +The URL of your backend proxy. All SDK API calls are sent to this base URL. See [Authentication and Proxy](./authentication-and-proxy.md). + +```tsx +config={{ baseUrl: '/api/gusto/' }} +``` + +### `headers` + +Static headers attached to every API request. Useful for API keys or simple auth tokens. + +```tsx +config={{ + baseUrl: '/api/gusto/', + headers: { + 'Authorization': 'Bearer your-api-key', + 'X-Custom-Header': 'value', + }, +}} +``` + +### `hooks` + +Request interceptors for dynamic request/response modification. Four hook points are available: + +- `beforeCreateRequest` — modify URL or method before the `Request` object is created +- `beforeRequest` — modify the request before it's sent (e.g., add dynamic auth headers) +- `afterSuccess` — handle successful responses (2xx) +- `afterError` — handle error responses (4xx, 5xx) or network failures + +```tsx +config={{ + baseUrl: '/api/gusto/', + hooks: { + beforeRequest: [ + { + beforeRequest: (context, request) => { + request.headers.set('Authorization', 'Bearer ' + getToken()) + return request + }, + }, + ], + }, +}} +``` + +### `observability` + +Error and performance tracking hooks. See [Error Handling](./error-handling.md). + +```tsx +config={{ + baseUrl: '/api/gusto/', + observability: { + onError: (error) => Sentry.captureException(error), + onMetric: (metric) => console.log(metric.name, metric.value), + }, +}} +``` + +## Top-level props + +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. | + +## Full example + +```tsx +import { GustoProvider } from '@gusto/embedded-react-sdk' +import '@gusto/embedded-react-sdk/style.css' + +function App({ children }) { + return ( + errorTracker.capture(error), + }, + }} + theme={{ + colorPrimary: '#1a73e8', + fontFamily: 'Inter, sans-serif', + }} + dictionary={{ + en: { + 'Employee.PaymentMethod': { + title: 'Set up direct deposit', + }, + }, + }} + > + {children} + + ) +} +``` + +## Provider stack + +Internally, `GustoProvider` composes several providers in this order: + +``` +GustoProvider + → ComponentsProvider (UI component map) + → LoadingIndicatorProvider + → ObservabilityProvider + → ErrorBoundary (top-level) + → ThemeProvider + → LocaleProvider + → I18nextProvider + → ApiProvider (React Query + HTTP client) + → {children} +``` + +You don't need to set up any of these individually — `GustoProvider` handles the full stack. diff --git a/docs/concepts/theming-and-customization.md b/docs/concepts/theming-and-customization.md new file mode 100644 index 000000000..910f23119 --- /dev/null +++ b/docs/concepts/theming-and-customization.md @@ -0,0 +1,113 @@ +--- +title: Theming and Customization +sidebar_position: 6 +--- + +The SDK provides two levels of visual customization: **theming** for CSS variable overrides, and **component adapters** for replacing UI primitives entirely. + +## Setup + +Import the SDK stylesheet before rendering any components: + +```typescript +import '@gusto/embedded-react-sdk/style.css' +``` + +This is typically done at your application root alongside the `GustoProvider` setup. + +## Theming + +Theming overrides CSS variables that control colors, typography, shadows, and spacing across all SDK components. Pass a `theme` object to `GustoProvider`: + +```tsx +import { GustoProvider } from '@gusto/embedded-react-sdk' +import '@gusto/embedded-react-sdk/style.css' + +function App({ children }) { + return ( + + {children} + + ) +} +``` + +The SDK ships with a baseline theme as a starting point. Override any subset of variables — unspecified variables keep their defaults. + +### Variable categories + +Theme variables are available for: + +- **Colors** — primary, body, border, error, warning, success colors with content/accent variants +- **Typography** — font family, sizes, weights, line heights +- **Shadows** — elevation levels +- **Spacing and radii** — layout spacing and border radius values + +For a complete list of available variables, see the [theme variables reference](../guides/theme-variables.md). + +### Accessibility + +Ensure sufficient contrast between background and content colors. For example, `colorBodyContent` and `colorBodySubContent` are displayed on top of `colorBody` and `colorBodyAccent`. Both pairings must meet [WCAG 2.2 contrast minimums](https://www.w3.org/WAI/WCAG22/Understanding/contrast-minimum.html). + +## Component adapters + +For customization beyond CSS variables — replacing the underlying UI components with your own — use component adapters. + +The SDK renders all UI through a `ComponentsContext`. By providing your own implementations for components like `Button`, `TextInput`, or `Select`, you can integrate your design system while the SDK handles all business logic. + +### Partial overrides with GustoProvider (recommended) + +`GustoProvider` accepts a `components` prop with partial overrides. Unspecified components fall back to the built-in React Aria defaults: + +```tsx +import { GustoProvider } from '@gusto/embedded-react-sdk' + +function App({ children }) { + return ( + + {children} + + ) +} +``` + +### Full control with GustoProviderCustomUIAdapter + +If you want to provide all UI components yourself (e.g., to avoid the React Aria dependency or optimize bundle size), use `GustoProviderCustomUIAdapter`. This requires implementing every component in the adapter interface: + +```tsx +import { GustoProviderCustomUIAdapter } from '@gusto/embedded-react-sdk' + +function App({ children }) { + return ( + + {children} + + ) +} +``` + +### Strategy + +1. **Start with theming** — override CSS variables to match your brand colors and typography +2. **Add component adapters selectively** — only replace the specific components where theming isn't sufficient +3. **Use `GustoProviderCustomUIAdapter` only when** you need full control over the UI layer or want to eliminate the React Aria dependency + +For detailed setup instructions, component interfaces, and a complete inventory of adaptable components, see the [component adapter documentation](../guides/component-adapter.md). diff --git a/docs/guides/component-adapter.md b/docs/guides/component-adapter.md new file mode 100644 index 000000000..d3dbb185f --- /dev/null +++ b/docs/guides/component-adapter.md @@ -0,0 +1,258 @@ +--- +title: Component Adapter +sidebar_position: 6 +--- + +The Component Adapter provides a "bring your own UI" approach — replace SDK UI primitives with components from your own design system while keeping all of the SDK's business logic and functionality. + +:::tip +Component adapters are powerful but involve higher maintenance overhead. Start with [theming](./theme-variables.md) first and use component adapters only when theming isn't sufficient. +::: + +## How It Works + +1. You create mappings that connect the SDK's prop interfaces to your UI components +2. You provide these mappings to a provider component +3. The SDK renders your components instead of its defaults + +## Choosing a Provider + +### GustoProvider (Recommended) + +Includes default React Aria components out of the box. Override only the components you need — everything else falls back to accessible defaults. + +```tsx +import { GustoProvider, Employee } from '@gusto/embedded-react-sdk' + +function App() { + return ( + + {}} /> + + ) +} +``` + +### GustoProviderCustomUIAdapter + +For complete UI control without React Aria dependencies. You must provide all required components. + +```tsx +import { GustoProviderCustomUIAdapter, Employee } from '@gusto/embedded-react-sdk' + +function App() { + return ( + + {}} /> + + ) +} +``` + +Use `GustoProviderCustomUIAdapter` when you want to implement all UI components yourself, minimize bundle size, or eliminate the React Aria dependency. + +## Step-by-Step Setup + +### 1. Implement the Props Interface + +Each component must implement the required props interface defined by the SDK. Component types extend basic HTML element props, so your implementations can accept and forward standard HTML attributes. + +```tsx +import type { TextInputProps } from '@gusto/embedded-react-sdk' + +const MyCustomTextInput = ({ + label, + description, + errorMessage, + isRequired, + isDisabled, + isInvalid, + id, + name, + value, + placeholder, + onChange, + onBlur, + inputRef, + shouldVisuallyHideLabel, + ...props +}: TextInputProps) => { + return ( +
+ + onChange && onChange(e.target.value)} + {...props} + /> + {errorMessage &&
{errorMessage}
} +
+ ) +} +``` + +### 2. Create Your Adapter Object + +Create an object implementing the `ComponentsContextType` interface with your custom components: + +```tsx +import type { ComponentsContextType } from '@gusto/embedded-react-sdk' + +const myCustomComponents: Partial = { + Button: props => , + TextInput: props => , + Select: props => , +} +``` + +### 3. Provide to Your App + +```tsx + + + +``` + +## Complete Material UI Example + +```tsx +import { GustoProvider, Employee } from '@gusto/embedded-react-sdk' +import TextField from '@mui/material/TextField' +import MuiButton from '@mui/material/Button' + +const materialUIComponents = { + TextInput: ({ + label, + description, + errorMessage, + isRequired, + isDisabled, + isInvalid, + id, + name, + value, + placeholder, + onChange, + onBlur, + ...props + }) => ( + onChange && onChange(e.target.value)} + onBlur={onBlur} + fullWidth + margin="normal" + {...props} + /> + ), + + Button: ({ children, isDisabled, isLoading, onClick, variant = 'primary', ...props }) => { + const muiVariant = + variant === 'primary' ? 'contained' : variant === 'secondary' ? 'outlined' : 'text' + + return ( + + {isLoading ? 'Loading...' : children} + + ) + }, +} + +function App() { + return ( + + {}} /> + + ) +} +``` + +## FAQ + +### Can I use a different UI framework? + +Yes. Any React-compatible UI library works (Material UI, Chakra UI, Ant Design, etc.) as long as your components implement the `ComponentsContextType` interface. + +### Do I need to implement all components? + +No. With `GustoProvider`, you only implement the components you want to customize. All others fall back to React Aria defaults. + +With `GustoProviderCustomUIAdapter`, you must provide all required components. There is no public `defaultComponents` export to merge with — this is an internal implementation detail. If you only want to override some components, use `GustoProvider` instead, which handles defaults for you. + +### How do I handle complex components like ComboBox or DatePicker? + +Options: + +1. Use a third-party library that provides similar functionality +2. Implement a simplified version +3. Keep the SDK defaults for complex components and only customize simpler ones + +Reference the [default implementations](https://github.com/Gusto/embedded-react-sdk/blob/main/src/contexts/ComponentAdapter/adapters/defaultComponentAdapter.tsx) to understand required behavior. + +### My custom component isn't working. What should I check? + +1. **All required props implemented** — verify against the prop interface +2. **Event handlers** — `onChange` and `onBlur` must be called with the correct parameter types +3. **Accessibility** — ensure proper labeling, ARIA attributes, and keyboard navigation +4. **Correct types** — import and use prop types from the SDK + +### My form values aren't being captured correctly. + +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` | + +### What about accessibility? + +When using the Component Adapter, you are responsible for ensuring accessibility compliance. The SDK's default components are built with accessibility in mind, but this does not automatically transfer to custom implementations. Pay attention to proper labeling, ARIA attributes, keyboard navigation, focus management, and color contrast. + +## Component Reference + +For the complete list of customizable components and their prop interfaces, see the [default implementations](https://github.com/Gusto/embedded-react-sdk/blob/main/src/contexts/ComponentAdapter/adapters/defaultComponentAdapter.tsx). + +## TypeScript Types + +All component adapter types are exported from the main SDK package: + +```typescript +import type { + ComponentsContextType, + ButtonProps, + TextInputProps, + SelectProps, + CheckboxProps, + // ... other component prop types +} from '@gusto/embedded-react-sdk' +``` diff --git a/docs/guides/guides.md b/docs/guides/guides.md new file mode 100644 index 000000000..28b5ee813 --- /dev/null +++ b/docs/guides/guides.md @@ -0,0 +1,17 @@ +--- +title: Guides +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 | diff --git a/docs/guides/observability.md b/docs/guides/observability.md new file mode 100644 index 000000000..ee6fb5441 --- /dev/null +++ b/docs/guides/observability.md @@ -0,0 +1,316 @@ +--- +title: Observability +sidebar_position: 5 +--- + +The Gusto Embedded React SDK provides built-in hooks for error tracking and performance monitoring. These hooks allow you to integrate with observability tools like Sentry, Datadog, New Relic, or your own custom monitoring solution. + +## Overview + +The observability system captures: + +- **Errors** — caught by error boundaries, validation failures, and API errors +- **Performance metrics** — form submission times and component loading durations + +This is separate from the `onEvent` system (for business-level event tracking) and request hooks (for request/response interception). + +## Configuration + +Configure observability by passing an `observability` object to the `GustoProvider` config: + +```tsx +import { GustoProvider } from '@gusto/embedded-react-sdk' +import type { ObservabilityHook } from '@gusto/embedded-react-sdk' + +const observability: ObservabilityHook = { + onError: error => { + console.error('[SDK Error]', error.category, error.message) + }, + onMetric: metric => { + console.log('[SDK Metric]', metric.name, metric.value, metric.unit) + }, +} + +function App() { + return ( + + + + ) +} +``` + +## Error Types + +### SDKError + +The core error type exposed through partner-facing hooks. Contains actionable information about what happened. + +```typescript +interface SDKError { + category: 'api_error' | 'validation_error' | 'network_error' | 'internal_error' + message: string + httpStatus?: number + fieldErrors: SDKFieldError[] + raw?: unknown +} +``` + +### ObservabilityError + +Extends `SDKError` with context for error-tracking tools. This is the type received by `onError`. + +```typescript +interface ObservabilityError extends SDKError { + timestamp: number + componentName?: string + componentStack?: string +} +``` + +### 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 | + +### Field Errors + +For `api_error` responses with structured validation errors (e.g. 422), the SDK extracts and flattens field-level errors: + +```typescript +interface SDKFieldError { + field: string + category: string + message: string + metadata?: Record +} +``` + +## Component Identification + +SDK components report their name in error reports and metrics: + +- `error.componentName` — e.g. `"Employee.Profile"` +- `metric.tags.component` — e.g. `"Employee.Compensation"` + +For errors caught by React ErrorBoundaries, `error.componentStack` provides the full React component hierarchy. + +## 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` | + +```typescript +interface ObservabilityMetric { + name: string + value: number + unit?: 'ms' | 'count' | 'bytes' | 'percent' + tags?: Record + timestamp: number +} +``` + +## Integration Examples + +### Console (Development) + +```tsx +const observability: ObservabilityHook = { + onError: error => { + console.group(`[SDK Error] ${error.category}`) + console.error('Message:', error.message) + console.error('Component:', error.componentName) + console.error('HTTP Status:', error.httpStatus) + console.error('Field Errors:', error.fieldErrors) + if (error.componentStack) console.error('Component Stack:', error.componentStack) + console.groupEnd() + }, + onMetric: metric => { + console.log(`[SDK Metric] ${metric.name}: ${metric.value}${metric.unit ?? ''}`, metric.tags) + }, +} +``` + +### Sentry + +```tsx +import * as Sentry from '@sentry/react' +import type { ObservabilityHook } from '@gusto/embedded-react-sdk' + +const observability: ObservabilityHook = { + onError: error => { + Sentry.captureException(error.raw ?? new Error(error.message), { + level: error.category === 'validation_error' ? 'warning' : 'error', + tags: { + error_category: error.category, + component: error.componentName ?? 'unknown', + http_status: String(error.httpStatus ?? ''), + }, + contexts: { + sdk_error: { + category: error.category, + message: error.message, + http_status: error.httpStatus, + field_error_count: error.fieldErrors.length, + }, + }, + fingerprint: ['gusto-sdk', error.category, error.componentName ?? 'unknown'], + }) + }, + onMetric: metric => { + Sentry.addBreadcrumb({ + category: 'performance', + message: `${metric.name}: ${metric.value}${metric.unit ?? ''}`, + level: 'info', + data: metric.tags, + }) + }, +} +``` + +### Datadog RUM + +```tsx +import { datadogRum } from '@datadog/browser-rum' +import type { ObservabilityHook } from '@gusto/embedded-react-sdk' + +const observability: ObservabilityHook = { + onError: error => { + const datadogError = new Error(error.message) + datadogError.name = error.category + + datadogRum.addError(datadogError, { + category: error.category, + component: error.componentName, + httpStatus: error.httpStatus, + }) + }, + onMetric: metric => { + if (metric.unit === 'ms') { + datadogRum.addTiming(metric.name, metric.value) + } else { + datadogRum.addAction(metric.name, { + value: metric.value, + unit: metric.unit, + ...metric.tags, + }) + } + }, +} +``` + +### Custom Analytics + +```tsx +import type { + ObservabilityHook, + ObservabilityError, + ObservabilityMetric, +} from '@gusto/embedded-react-sdk' + +class CustomAnalytics { + async trackError(error: ObservabilityError) { + await fetch('/api/analytics/errors', { + method: 'POST', + headers: { 'Content-Type': 'application/json' }, + body: JSON.stringify({ + category: error.category, + message: error.message, + httpStatus: error.httpStatus, + fieldErrors: error.fieldErrors, + component: error.componentName, + timestamp: error.timestamp, + }), + }) + } + + async trackMetric(metric: ObservabilityMetric) { + await fetch('/api/analytics/metrics', { + method: 'POST', + headers: { 'Content-Type': 'application/json' }, + body: JSON.stringify(metric), + }) + } +} + +const analytics = new CustomAnalytics() + +const observability: ObservabilityHook = { + onError: error => analytics.trackError(error), + onMetric: metric => analytics.trackMetric(metric), +} +``` + +## PII Sanitization + +### Automatic Sanitization + +By default, the SDK sanitizes all error and metric data before sending it to your observability hooks. + +**Pattern-based redaction** covers SSNs, email addresses, phone numbers, credit card numbers, and API keys/tokens. + +**Field-based removal** covers fields named `password`, `token`, `apiKey`, `secret`, `ssn`, `creditCard`, `cvv`, `pin`, `bankAccount`, `routingNumber`, `accountNumber`, and similar. + +### Configuration + +```tsx +const observability: ObservabilityHook = { + onError: error => { + yourErrorTracker.captureError(error) + }, + sanitization: { + enabled: true, + includeRawError: false, + additionalSensitiveFields: ['customerId', 'employeeId'], + customErrorSanitizer: error => ({ + ...error, + message: 'Custom sanitized message', + }), + }, +} +``` + +**What gets sanitized:** + +- `message` — PII patterns replaced with `[TYPE-REDACTED]` placeholders +- `fieldErrors[].message` — same PII redaction +- `fieldErrors[].metadata` — sensitive field names replaced with `[REDACTED]` +- `raw` — excluded by default (opt in with `includeRawError: true`) +- `tags` (metrics) — sensitive field names and PII patterns are sanitized + +## 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 | +| `hooks.afterError` (config) | Request/response interception | Modify requests, add auth tokens, log all API calls | + +## TypeScript Types + +All observability types are exported from the main SDK package: + +```typescript +import type { + ObservabilityHook, + ObservabilityError, + ObservabilityMetric, + ObservabilityMetricUnit, + SanitizationConfig, + SDKError, + SDKErrorCategory, + SDKFieldError, +} from '@gusto/embedded-react-sdk' +``` diff --git a/docs/guides/providing-your-own-data.md b/docs/guides/providing-your-own-data.md new file mode 100644 index 000000000..fe35db2a8 --- /dev/null +++ b/docs/guides/providing-your-own-data.md @@ -0,0 +1,45 @@ +--- +title: Providing Your Own Data +sidebar_position: 4 +--- + +The Gusto Embedded React SDK allows you to pre-fill forms with data from your application using the `defaultValues` prop. + +## Using Default Values + +If an SDK component contains a form and has a `defaultValues` property, you can set it with values from your own application data. The `defaultValues` object has keys corresponding to each form field. + +```tsx +import { Employee, GustoProvider } from '@gusto/embedded-react-sdk' + +function MyApp({ employeeId, startDate }) { + const someApplicationData = { + title: 'Mr. Manager', + rate: '50', + payment_unit: 'Hour', + } + + return ( + + {}} + defaultValues={someApplicationData} + /> + + ) +} +``` + +## Server Data Takes Precedence + +When you supply default values, they are replaced if the Gusto API already has saved data for those fields. For example, if you provide default compensation data but the employee already has compensation saved, the saved data takes precedence over your defaults. + +## Finding Available Default Values + +Documentation for components that support `defaultValues` and the shape of the object for each component can be found in the workflow documentation prop tables. diff --git a/docs/guides/proxy-setup.md b/docs/guides/proxy-setup.md new file mode 100644 index 000000000..2e6e3823a --- /dev/null +++ b/docs/guides/proxy-setup.md @@ -0,0 +1,127 @@ +--- +title: Proxy Setup +sidebar_position: 7 +--- + +The Gusto Embedded React SDK requires a server-side proxy to forward API requests to the Gusto API. This guide shows how to build a secure proxy with endpoint allowlisting using the SDK's built-in endpoint inventory. + +For background on proxy security requirements, see the [Authentication and Proxy](../concepts/authentication-and-proxy.md) concept guide. + +## Loading the Endpoint Inventory + +The SDK ships an `endpoint-inventory.json` file that maps every component and flow to the API endpoints it uses: + +```typescript +import { readFileSync } from 'fs' + +const inventoryPath = require.resolve('@gusto/embedded-react-sdk/endpoint-inventory.json') +const inventory = JSON.parse(readFileSync(inventoryPath, 'utf-8')) +``` + +## Building the Allowlist + +Use the inventory to build per-user allowlists based on which SDK components they access: + +```typescript +interface Endpoint { + method: string + path: string +} + +function getAllowlistForUser(user: SessionUser): Endpoint[] { + switch (user.role) { + case 'payroll_admin': + return buildAllowlistFromInventory( + { flows: ['Employee.OnboardingFlow', 'Payroll.PayrollFlow'] }, + { companyId: user.companyId }, + ) + + case 'onboarding_admin': + return buildAllowlistFromInventory( + { + blocks: [ + 'Employee.EmployeeList', + 'Employee.Profile', + 'Employee.Compensation', + 'Employee.FederalTaxes', + 'Employee.StateTaxes', + ], + }, + { companyId: user.companyId }, + ) + + case 'employee_self_service': + return buildAllowlistFromInventory( + { flows: ['Employee.SelfOnboardingFlow'] }, + { companyId: user.companyId, employeeId: user.employeeId }, + ) + + default: + return [] + } +} + +function buildAllowlistFromInventory( + config: { flows?: string[]; blocks?: string[] }, + variables: Record, +): Endpoint[] { + const endpoints: Endpoint[] = [] + + for (const flowName of config.flows ?? []) { + const flow = inventory.flows[flowName] + if (flow) endpoints.push(...flow.endpoints) + } + + for (const blockName of config.blocks ?? []) { + const block = inventory.blocks[blockName] + if (block) endpoints.push(...block.endpoints) + } + + return resolveEndpoints(endpoints, variables) +} + +function resolveEndpoints(endpoints: Endpoint[], variables: Record): Endpoint[] { + const seen = new Set() + return endpoints + .map(endpoint => ({ + method: endpoint.method, + path: endpoint.path.replace(/:([a-zA-Z]+)/g, (_match, param) => { + return variables[param] ?? '[^/]+' + }), + })) + .filter(ep => { + const key = `${ep.method} ${ep.path}` + if (seen.has(key)) return false + seen.add(key) + return true + }) +} +``` + +## Enforcing the Allowlist + +Apply the allowlist as Express middleware: + +```typescript +function enforceAllowlist(req: express.Request, res: express.Response, next: express.NextFunction) { + const { user } = req.session + const allowlist = getAllowlistForUser(user) + + const isAllowed = allowlist.some(endpoint => { + if (endpoint.method !== req.method) return false + return new RegExp(`^${endpoint.path}$`).test(req.path) + }) + + if (!isAllowed) { + return res.status(403).json({ error: 'Forbidden' }) + } + + next() +} + +app.all('/gusto-api/*', authenticate, enforceAllowlist, async (req, res) => { + // Forward the request to the Gusto API, adding auth and client IP headers +}) +``` + +The `resolveEndpoints` function substitutes path parameters (`:companyId`, `:employeeId`, etc.) with the actual IDs for the current user, ensuring users can only access their own data. Parameters without a provided value are replaced with `[^/]+` to match any valid path segment. diff --git a/docs/guides/request-interceptors.md b/docs/guides/request-interceptors.md new file mode 100644 index 000000000..26cc07926 --- /dev/null +++ b/docs/guides/request-interceptors.md @@ -0,0 +1,77 @@ +--- +title: Request Interceptors +sidebar_position: 3 +--- + +Request interceptors let you customize HTTP requests and responses in the Gusto Embedded React SDK. They are configured through the `hooks` property on `GustoProvider`'s `config`. + +## 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 | + +For complete hook interface details, see the [Speakeasy SDK Hooks documentation](https://www.speakeasy.com/docs/customize/code/sdk-hooks). + +## Configuration + +```tsx +import { GustoProvider } from '@gusto/embedded-react-sdk' + +function App() { + return ( + { + // Access context properties: operationID, baseURL, options, etc. + // Modify URL, method, etc. before Request object is created + + return input + }, + }, + ], + beforeRequest: [ + { + beforeRequest: (context, request) => { + // Access context properties: operationID, baseURL, options, etc. + request.headers.set('Authorization', 'Bearer ' + getToken()) + + return request + }, + }, + ], + afterSuccess: [ + { + afterSuccess: (context, response) => { + console.log(`${context.operationID} succeeded`) + + return response + }, + }, + ], + afterError: [ + { + afterError: (context, response, error) => { + console.error(`${context.operationID} failed`) + + return { response, error } + }, + }, + ], + }, + }} + > + + + ) +} +``` + +Each hook receives a `context` object with properties like `operationID`, `baseURL`, and `options`. The hook must return its input (or a modified version) to allow the request pipeline to continue. diff --git a/docs/guides/routing.md b/docs/guides/routing.md new file mode 100644 index 000000000..1322343fa --- /dev/null +++ b/docs/guides/routing.md @@ -0,0 +1,254 @@ +--- +title: Routing +sidebar_position: 2 +--- + +The Gusto Embedded React SDK is router-agnostic — it does not ship with or require any specific routing library. Instead, it uses an event-driven approach that integrates with whichever router you choose. + +This guide walks through a complete example using [React Router](https://reactrouter.com/) to build the Employee Self-Onboarding flow. + +## Overview + +Employee Self-Onboarding is comprised of the following steps, each available as a subcomponent of `Employee`: + +``` +Employee.Landing +Employee.Profile +Employee.Taxes +Employee.PaymentMethod +Employee.DocumentSigner +Employee.OnboardingSummary +``` + +For this flow, you need a `companyId` and an `employeeId`. Not all steps require both, but each requires the `employeeId`. + +## Step 1: Create the Routes + +Create a router with a route for each step in the flow: + +```tsx +import { createBrowserRouter } from 'react-router-dom' + +const createEmployeeSelfOnboardingRouter = ({ + companyId, + employeeId, +}: { + companyId: string + employeeId: string +}) => + createBrowserRouter([ + { + path: '/', + element: , + errorElement: , + children: [ + { path: '/' }, + { path: '/profile' }, + { path: '/taxes' }, + { path: '/payment_method' }, + { path: '/document_signer' }, + { path: '/onboarding_summary' }, + ], + }, + ]) +``` + +## Step 2: Create Wrapper Components with Navigation + +Each SDK component has an `onEvent` prop. When a component is ready for navigation, it fires an event. Create wrapper components that handle these events and navigate to the next step: + +```tsx +import { Employee, componentEvents } from '@gusto/embedded-react-sdk' +import { useNavigate } from 'react-router-dom' + +function EmployeeLandingWrapper({ companyId, employeeId }) { + const navigate = useNavigate() + return ( + { + if (eventType === componentEvents.EMPLOYEE_SELF_ONBOARDING_START) { + navigate('/profile') + } + }} + /> + ) +} +``` + +Each step component is independent and usable in isolation. When a user saves data, the component makes its own API call. You can rearrange steps in any order. + +## Step 3: Put It All Together + +Here is the full working example with all wrapper components and the router configuration: + +```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' + +interface AppProps { + companyId: string + employeeId: string +} + +function EmployeeLandingWrapper({ + companyId, + employeeId, +}: { + companyId: string + employeeId: string +}) { + const navigate = useNavigate() + + return ( + { + if (eventType === componentEvents.EMPLOYEE_SELF_ONBOARDING_START) { + navigate('/profile') + } + }} + /> + ) +} + +function EmployeeProfileWrapper({ + companyId, + employeeId, +}: { + companyId: string + employeeId: string +}) { + const navigate = useNavigate() + + return ( + { + if (eventType === componentEvents.EMPLOYEE_PROFILE_DONE) { + navigate('/taxes') + } + }} + /> + ) +} + +function EmployeeTaxesWrapper({ employeeId }: { employeeId: string }) { + const navigate = useNavigate() + + return ( + { + if (eventType === componentEvents.EMPLOYEE_TAXES_DONE) { + navigate('/payment_method') + } + }} + /> + ) +} + +function EmployeePaymentMethodWrapper({ employeeId }: { employeeId: string }) { + const navigate = useNavigate() + + return ( + { + if (eventType === componentEvents.EMPLOYEE_PAYMENT_METHOD_DONE) { + navigate('/document_signer') + } + }} + /> + ) +} + +function EmployeeDocumentSignerWrapper({ employeeId }: { employeeId: string }) { + const navigate = useNavigate() + + return ( + { + if (eventType === componentEvents.EMPLOYEE_FORMS_DONE) { + navigate('/onboarding_summary') + } + }} + /> + ) +} + +function EmployeeOnboardingSummaryWrapper({ employeeId }: { employeeId: string }) { + return ( + {}} + /> + ) +} + +const createEmployeeSelfOnboardingRouter = ({ + companyId, + employeeId, +}: { + companyId: string + employeeId: string +}) => + createBrowserRouter([ + { + path: '/', + element: , + errorElement: , + children: [ + { + path: '/', + element: , + }, + { + path: '/profile', + element: , + }, + { + path: '/taxes', + element: , + }, + { + path: '/payment_method', + element: , + }, + { + path: '/document_signer', + element: , + }, + { + path: '/onboarding_summary', + element: , + }, + ], + }, + ]) + +export default function App({ companyId, employeeId }: AppProps) { + const router = createEmployeeSelfOnboardingRouter({ + companyId, + employeeId, + }) + return ( + + + + ) +} +``` diff --git a/docs/guides/theme-variables.md b/docs/guides/theme-variables.md new file mode 100644 index 000000000..60ef2d6be --- /dev/null +++ b/docs/guides/theme-variables.md @@ -0,0 +1,114 @@ +--- +title: Theme Variables +sidebar_position: 8 +--- + +The SDK exposes theme variables to customize colors, typography, spacing, and other visual properties. Pass a partial theme object to `GustoProvider` — you only need to specify the variables you want to change. + +## Usage + +```tsx +import { GustoProvider } from '@gusto/embedded-react-sdk' + +function App() { + return ( + + {/* Your app content */} + + ) +} +``` + +:::note Accessibility +When customizing colors, ensure sufficient contrast ratios between foreground and background colors to meet WCAG 2.1 AA standards (4.5:1 for normal text, 3:1 for large text). +::: + +## Variable Reference + +### 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` | +| **colorSecondaryContent** | `string` | +| **colorSuccess** | `string` | +| **colorSuccessAccent** | `string` | +| **colorSuccessContent** | `string` | +| **colorWarning** | `string` | +| **colorWarningAccent** | `string` | +| **colorWarningContent** | `string` | + +### Typography + +| 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` | + +### Focus and Shadows + +| Variable | Type | +| --- | --- | +| **focusRingColor** | `string` | +| **focusRingWidth** | `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` | +| **inputDisabledBackgroundColor** | `string` | +| **inputErrorColor** | `string` | +| **inputLabelColor** | `string` | +| **inputLabelFontSize** | `string` | +| **inputLabelFontWeight** | `string` | +| **inputPlaceholderColor** | `string` | +| **inputRadius** | `string` | +| **transitionDuration** | `string` | diff --git a/docs/guides/versioning.md b/docs/guides/versioning.md new file mode 100644 index 000000000..9d4e02e3f --- /dev/null +++ b/docs/guides/versioning.md @@ -0,0 +1,24 @@ +--- +title: Versioning +sidebar_position: 1 +--- + +The Gusto Embedded React SDK follows [Semantic Versioning 2.0.0](https://semver.org/). + +## Pre-1.0 Versioning + +The SDK is currently pre-1.0.0, and [the rules of SemVer are different during this phase](https://semver.org/#spec-item-4): + +- **Breaking changes are allowed** in minor version bumps (0.x.0). This flexibility lets us iterate quickly based on partner feedback. +- **Frequent releases** are expected as we refine APIs and add functionality. + +## Communication and Support + +To ensure a smooth experience during this phase: + +- **Advance notice** — We communicate upcoming breaking changes well in advance, giving you time to prepare. +- **Upgrade guides** — Each breaking change includes a comprehensive upgrade guide to help you transition with minimal friction. + +## Staying Informed + +Track all releases and their details in our [CHANGELOG on npm](https://www.npmjs.com/package/@gusto/embedded-react-sdk?activeTab=code). We encourage you to stay updated and provide feedback as we work towards a stable 1.0 release. diff --git a/docs/quickstart/first-flow.md b/docs/quickstart/first-flow.md new file mode 100644 index 000000000..267686f77 --- /dev/null +++ b/docs/quickstart/first-flow.md @@ -0,0 +1,80 @@ +--- +title: Your First Flow +sidebar_position: 1 +--- + +Now that you have the SDK installed and a proxy running, render a full multi-step workflow with a single component. + +## What is a flow? + +A flow is a pre-built component that orchestrates an entire business process. It manages its own internal navigation, form state, API calls, and validation — you render one component and it handles the rest. + +## Render the Employee Onboarding Flow + +`Employee.OnboardingFlow` walks a user through the complete employee onboarding process: personal profile, federal and state taxes, payment method, and document signing. + +```jsx +import '@gusto/embedded-react-sdk/style.css' +import { GustoProvider, Employee } from '@gusto/embedded-react-sdk' + +function OnboardingPage({ companyId }) { + return ( + + + + ) +} +``` + +The flow renders each step in sequence and advances automatically when the user completes a step. You don't need to manage routing or step transitions — the flow handles that internally. + +## Handle events + +Every flow emits events through the `onEvent` callback. Use these to respond to user actions, track progress, or trigger side effects in your application. + +```jsx +import { Employee, GustoProvider, componentEvents } from '@gusto/embedded-react-sdk' + +function handleEvent(eventType, data) { + switch (eventType) { + case componentEvents.EMPLOYEE_CREATED: + console.log('New employee:', data.uuid) + break + + case componentEvents.EMPLOYEE_ONBOARDING_DONE: + // Navigate the user to the next page in your app + window.location.href = '/dashboard' + break + } +} + +function OnboardingPage({ companyId }) { + return ( + + + + ) +} +``` + +Events include both lifecycle signals (step completed, flow done) and data payloads from API responses (employee created, tax info updated). The `data` argument shape varies by event — lifecycle events have no data, while creation/update events include the API response. + +## Using individual blocks instead + +If you need more control over layout or step ordering, you can use the individual building blocks that make up a flow. For example, render just the compensation step: + +```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. + +## Next steps + +See [Next Steps](./next-steps.md) for curated links to theming, proxy setup, and advanced guides. diff --git a/docs/quickstart/next-steps.md b/docs/quickstart/next-steps.md new file mode 100644 index 000000000..69c0cf116 --- /dev/null +++ b/docs/quickstart/next-steps.md @@ -0,0 +1,34 @@ +--- +title: Next Steps +sidebar_position: 2 +--- + +You've installed the SDK, rendered a component, and run a flow. Here's where to go from here. + +## Understand the concepts + +- [What is the GEP React SDK?](../what-is-the-gep-react-sdk.md) — architecture overview and how the SDK compares to other integration options +- [Events](../concepts/events.md) — respond to user actions and API responses +- [Composition](../concepts/composition.md) — use individual blocks, reorder steps, or mix SDK components with your own UI + +## Browse the components + +- [Components Overview](../components/components.md) — all available pre-built flows: company onboarding, employee onboarding, payroll, contractors, and more + +## Customize the UI + +- [Theming and Customization](../concepts/theming-and-customization.md) — override CSS variables for colors, typography, and spacing +- [Theme Variables](../guides/theme-variables.md) — complete reference of all customizable theme variables +- [Component Adapter](../guides/component-adapter.md) — swap SDK primitives for your own design system components + +## Set up your proxy + +- [Authentication and Proxy](../concepts/authentication-and-proxy.md) — configure OAuth2 tokens and proxy authentication +- [Proxy Setup](../guides/proxy-setup.md) — endpoint allowlisting, authorization, and security best practices + +## Advanced guides + +- [Routing](../guides/routing.md) — integrate SDK flows with your app's router +- [Internationalization](../concepts/i18n.md) — localize SDK components with i18next +- [Error Handling](../concepts/error-handling.md) — handle API errors and validation failures +- [Request Interceptors](../guides/request-interceptors.md) — dynamically modify outgoing API requests diff --git a/docs/quickstart/quickstart.md b/docs/quickstart/quickstart.md new file mode 100644 index 000000000..789397922 --- /dev/null +++ b/docs/quickstart/quickstart.md @@ -0,0 +1,115 @@ +--- +title: Quickstart +sidebar_position: 0 +--- + +Get the Gusto Embedded React SDK rendering in your app in five minutes. By the end of this guide you'll have an employee list component on screen, backed by a minimal proxy server. + +## Prerequisites + +- React 18+ +- Node.js 18+ + +## 1. Install the SDK + +```bash +npm install @gusto/embedded-react-sdk +``` + +## 2. Import styles + +The SDK ships baseline styles for all components. Import the stylesheet at your application's entry point: + +```jsx +import '@gusto/embedded-react-sdk/style.css' +``` + +## 3. Set up GustoProvider + +Wrap your application with `GustoProvider` and point `baseUrl` to your backend proxy. The SDK sends all API requests through this URL — it never calls the Gusto API directly. + +```jsx +import { GustoProvider } from '@gusto/embedded-react-sdk' + +function App() { + return ( + + {/* SDK components go here */} + + ) +} +``` + +## 4. Render a component + +Import a component namespace and render it inside the provider. `Employee.EmployeeList` displays the employees for a given company: + +```jsx +import { Employee } from '@gusto/embedded-react-sdk' + +function EmployeePage({ companyId }) { + return {}} /> +} +``` + +## 5. Set up a minimal proxy + +The proxy sits between the SDK and the Gusto Embedded API. Its job is to attach your OAuth2 access token and forward requests. Here's a minimal Express example: + +```javascript +import express from 'express' + +const app = express() +app.use(express.json()) + +const GUSTO_API_BASE = 'https://api.gusto-demo.com' + +app.all('/api/gusto/*', async (req, res) => { + const gustoPath = req.originalUrl.replace('/api/gusto', '') + const accessToken = await getAccessTokenForUser(req) // Your OAuth2 token logic + + const response = await fetch(`${GUSTO_API_BASE}${gustoPath}`, { + method: req.method, + headers: { + Authorization: `Bearer ${accessToken}`, + 'Content-Type': 'application/json', + 'x-gusto-client-ip': req.ip, + }, + body: ['GET', 'HEAD'].includes(req.method) ? undefined : JSON.stringify(req.body), + }) + + res.status(response.status).json(await response.json()) +}) + +app.listen(3001) +``` + +The `x-gusto-client-ip` header is required for form-signing operations. Setting it once in your proxy covers all workflows. + +## Putting it all together + +```jsx +import '@gusto/embedded-react-sdk/style.css' +import { GustoProvider, Employee } from '@gusto/embedded-react-sdk' + +function App() { + const companyId = 'your-company-uuid' + + return ( + +

Employees

+ {}} /> +
+ ) +} + +export default App +``` + +## Try it live + +Explore a working example in [CodeSandbox](https://codesandbox.io/p/devbox/happy-ardinghelli-nzpslw) to see the full setup with a proxy and rendered components. + +## Next steps + +Ready to go beyond a list? [Render your first flow](./first-flow.md) to see a complete multi-step workflow in action. diff --git a/docs/what-is-the-gep-react-sdk.md b/docs/what-is-the-gep-react-sdk.md index 15a3a6e57..fd52805ce 100644 --- a/docs/what-is-the-gep-react-sdk.md +++ b/docs/what-is-the-gep-react-sdk.md @@ -1,6 +1,6 @@ --- title: What is the GEP React SDK? -order: 0 +sidebar_position: 0 --- ## Introduction @@ -25,9 +25,9 @@ import { Employee } from '@gusto/embedded-react-sdk' Unlike iframes, the SDK renders native React components inside your application. You control the look and feel through: -- **[Theming](./theming/theming.md)** -- override CSS variables for colors, typography, spacing, and more -- **[Component Adapters](./component-adapter/component-adapter.md)** -- swap SDK primitives for your own design system components -- **[Composition](./integration-guide/composition.md)** -- rearrange, add, or remove sections within any workflow +- **[Theming](./concepts/theming-and-customization.md)** -- override CSS variables for colors, typography, spacing, and more +- **[Component Adapters](./guides/component-adapter.md)** -- swap SDK primitives for your own design system components +- **[Composition](./concepts/composition.md)** -- rearrange, add, or remove sections within any workflow ### Event-driven integration @@ -56,10 +56,8 @@ The SDK manages API calls, form validation, error handling, and state transition | **Business logic** | Included | Included | You implement | | **Framework** | React required | Any (iframe) | Any | -For a deeper comparison, see [Build Pathways: SDK, Flows, and API](./deciding-to-build-with-the-sdk/build-pathways-sdk-flows-api.md). - ## Next steps -- **[Getting Started](./getting-started/getting-started.md)** -- install the SDK, configure the provider, and set up your proxy -- **[Workflows Overview](./workflows-overview/workflows-overview.md)** -- see the available pre-built workflows -- **[Integration Guide](./integration-guide/integration-guide.md)** -- learn about events, composition, theming, and more +- **[Quickstart](./quickstart/quickstart.md)** -- install the SDK, configure the provider, and set up your proxy +- **[Components Overview](./components/components.md)** -- see the available pre-built flows and blocks +- **[Concepts](./concepts/concepts.md)** -- learn about events, composition, theming, and more diff --git a/website/docusaurus.config.ts b/website/docusaurus.config.ts index 61fcc8f52..f16b3a2d9 100644 --- a/website/docusaurus.config.ts +++ b/website/docusaurus.config.ts @@ -105,7 +105,7 @@ const config: Config = { type: 'docSidebar', sidebarId: 'docs', position: 'left', - label: 'Guides', + label: 'Docs', }, { type: 'docSidebar', @@ -124,19 +124,20 @@ const config: Config = { style: 'dark', links: [ { - title: 'Guides', + title: 'Get Started', items: [ { label: 'What is the SDK?', to: '/docs/what-is-the-gep-react-sdk' }, - { label: 'Getting Started', to: '/docs/getting-started/getting-started' }, - { label: 'Integration Guide', to: '/docs/integration-guide/integration-guide' }, - { label: 'Workflows', to: '/docs/workflows-overview/workflows-overview' }, + { label: 'Quickstart', to: '/docs/quickstart/quickstart' }, + { label: 'Concepts', to: '/docs/concepts/concepts' }, + { label: 'Components', to: '/docs/components/components' }, ], }, { - title: 'Customization', + title: 'Guides', items: [ - { label: 'Theming', to: '/docs/theming/theming' }, - { label: 'Component Adapter', to: '/docs/component-adapter/component-adapter' }, + { label: 'Theming', to: '/docs/concepts/theming-and-customization' }, + { label: 'Component Adapter', to: '/docs/guides/component-adapter' }, + { label: 'Observability', to: '/docs/guides/observability' }, { label: 'Hooks (Experimental)', to: '/docs/hooks/hooks' }, ], }, diff --git a/website/sidebars.ts b/website/sidebars.ts index 23022637b..2909df12f 100644 --- a/website/sidebars.ts +++ b/website/sidebars.ts @@ -6,102 +6,234 @@ const sidebars: SidebarsConfig = { 'what-is-the-gep-react-sdk', { type: 'category', - label: 'Deciding to Build with the SDK', + label: 'Quickstart', link: { type: 'doc', - id: 'deciding-to-build-with-the-sdk/deciding-to-build-with-the-sdk', + id: 'quickstart/quickstart', }, - items: [ - 'deciding-to-build-with-the-sdk/build-pathways-sdk-flows-api', - 'deciding-to-build-with-the-sdk/component-types', - ], + items: ['quickstart/first-flow', 'quickstart/next-steps'], }, { type: 'category', - label: 'Getting Started', + label: 'Concepts', link: { type: 'doc', - id: 'getting-started/getting-started', + id: 'concepts/concepts', }, items: [ - 'getting-started/authentication', - 'getting-started/proxy-security-partner-guidance', + 'concepts/flows-and-blocks', + 'concepts/provider-and-configuration', + 'concepts/events', + 'concepts/authentication-and-proxy', + 'concepts/composition', + 'concepts/theming-and-customization', + 'concepts/error-handling', + 'concepts/i18n', ], }, { type: 'category', - label: 'Integration Guide', + label: 'Components', link: { type: 'doc', - id: 'integration-guide/integration-guide', - }, - items: [ - 'integration-guide/versioning', - 'integration-guide/event-handling', - 'integration-guide/event-types', - 'integration-guide/composition', - 'integration-guide/providing-your-own-data', - 'integration-guide/translation', - 'integration-guide/routing', - 'integration-guide/error-handling', - 'integration-guide/request-interceptors', - 'integration-guide/customizing-sdk-ui', - 'integration-guide/observability', - 'integration-guide/observability-examples', - ], - }, - { - type: 'category', - label: 'Workflows', - link: { - type: 'doc', - id: 'workflows-overview/workflows-overview', + id: 'components/components', }, items: [ { type: 'category', - label: 'Employee Onboarding', + label: 'Company', link: { type: 'doc', - id: 'workflows-overview/employee-onboarding/employee-onboarding', + id: 'components/company/company', }, items: [ - 'workflows-overview/employee-onboarding/employee-self-onboarding', + { + type: 'category', + label: 'Flows', + items: ['components/company/onboarding-flow'], + }, + { + type: 'category', + label: 'Blocks', + items: [ + 'components/company/assign-signatory', + 'components/company/create-signatory', + 'components/company/invite-signatory', + 'components/company/industry', + 'components/company/document-signer', + 'components/company/document-list', + 'components/company/signature-form', + 'components/company/federal-taxes', + 'components/company/pay-schedule', + 'components/company/locations', + 'components/company/bank-account', + 'components/company/state-taxes', + 'components/company/state-taxes-form', + 'components/company/state-taxes-list', + 'components/company/onboarding-overview', + ], + }, + ], + }, + { + type: 'category', + label: 'Employee', + link: { + type: 'doc', + id: 'components/employee/employee', + }, + items: [ + { + type: 'category', + label: 'Flows', + items: [ + 'components/employee/onboarding-flow', + 'components/employee/self-onboarding-flow', + 'components/employee/termination-flow', + ], + }, + { + type: 'category', + label: 'Blocks', + items: [ + 'components/employee/employee-list', + 'components/employee/profile', + 'components/employee/compensation', + 'components/employee/federal-taxes', + 'components/employee/state-taxes', + 'components/employee/payment-method', + 'components/employee/deductions', + 'components/employee/employee-documents', + 'components/employee/document-signer', + 'components/employee/employment-eligibility', + 'components/employee/onboarding-summary', + 'components/employee/landing', + 'components/employee/terminate-employee', + 'components/employee/termination-summary', + 'components/employee/taxes', + ], + }, + ], + }, + { + type: 'category', + label: 'Contractor', + link: { + type: 'doc', + id: 'components/contractor/contractor', + }, + items: [ + { + type: 'category', + label: 'Flows', + items: [ + 'components/contractor/onboarding-flow', + 'components/contractor/payment-flow', + ], + }, + { + type: 'category', + label: 'Blocks', + items: [ + 'components/contractor/contractor-list', + 'components/contractor/contractor-profile', + 'components/contractor/address', + 'components/contractor/payment-method', + 'components/contractor/new-hire-report', + 'components/contractor/contractor-submit', + 'components/contractor/payments-list', + 'components/contractor/create-payment', + 'components/contractor/payment-history', + 'components/contractor/payment-summary', + 'components/contractor/payment-statement', + ], + }, + ], + }, + { + type: 'category', + label: 'Payroll', + link: { + type: 'doc', + id: 'components/payroll/payroll', + }, + items: [ + { + type: 'category', + label: 'Flows', + items: [ + 'components/payroll/payroll-flow', + 'components/payroll/payroll-execution-flow', + 'components/payroll/off-cycle-flow', + 'components/payroll/dismissal-flow', + 'components/payroll/transition-flow', + ], + }, + { + type: 'category', + label: 'Blocks', + items: [ + 'components/payroll/payroll-landing', + 'components/payroll/payroll-list', + 'components/payroll/payroll-history', + 'components/payroll/payroll-configuration', + 'components/payroll/payroll-edit-employee', + 'components/payroll/payroll-overview', + 'components/payroll/payroll-receipts', + 'components/payroll/payroll-blocker', + 'components/payroll/confirm-wire-details', + 'components/payroll/off-cycle-creation', + 'components/payroll/off-cycle-deductions-setting', + 'components/payroll/off-cycle-reason-selection', + 'components/payroll/transition-creation', + 'components/payroll/recovery-cases', + ], + }, + ], + }, + { + type: 'category', + label: 'Information Requests', + link: { + type: 'doc', + id: 'components/information-requests/information-requests', + }, + items: [ + { + type: 'category', + label: 'Flows', + items: [ + 'components/information-requests/information-requests-flow', + ], + }, + { + type: 'category', + label: 'Blocks', + items: [ + 'components/information-requests/information-request-list', + 'components/information-requests/information-request-form', + ], + }, ], }, - 'workflows-overview/company-onboarding', - 'workflows-overview/contractor-onboarding', - 'workflows-overview/contractor-payments', - 'workflows-overview/run-payroll', - 'workflows-overview/employee-termination', - 'workflows-overview/information-requests', - ], - }, - { - type: 'category', - label: 'Component Adapter', - link: { - type: 'doc', - id: 'component-adapter/component-adapter', - }, - items: [ - 'component-adapter/how-the-component-adapter-works', - 'component-adapter/setting-up-your-component-adapter', - 'component-adapter/component-adapter-faq', - 'component-adapter/component-adapter-types', - 'component-adapter/component-inventory', ], }, { type: 'category', - label: 'Theming', + label: 'Guides', link: { type: 'doc', - id: 'theming/theming', + id: 'guides/guides', }, items: [ - 'theming/theming-guide', - 'theming/theme-variables', + 'guides/versioning', + 'guides/routing', + 'guides/request-interceptors', + 'guides/providing-your-own-data', + 'guides/observability', + 'guides/component-adapter', + 'guides/proxy-setup', + 'guides/theme-variables', ], }, { @@ -120,10 +252,7 @@ const sidebars: SidebarsConfig = { { type: 'category', label: 'Reference', - items: [ - 'reference/endpoint-reference', - 'reference/proxy-examples', - ], + items: ['reference/endpoint-reference', 'reference/proxy-examples'], }, ], api: apiSidebar, diff --git a/website/src/pages/index.tsx b/website/src/pages/index.tsx index 1b4a3368b..364dd7aec 100644 --- a/website/src/pages/index.tsx +++ b/website/src/pages/index.tsx @@ -25,7 +25,7 @@ function PaletteIcon({ className }: { className?: string }) { - + ); } @@ -108,7 +108,7 @@ function HeroSection() { top of the Gusto Embedded API.

- + 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 ( - + @@ -15,46 +22,92 @@ function WorkflowIcon({ className }: { className?: string }) { - ); + ) } function PaletteIcon({ className }: { className?: string }) { return ( - + - ); + ) } function SignalIcon({ className }: { className?: string }) { return ( - + - - - - + + + + - ); + ) } function GearIcon({ className }: { className?: string }) { return ( - + - + - ); + ) } interface Feature { - title: string; - description: string; - icon: (props: { className?: string }) => ReactNode; + title: string + description: string + icon: (props: { className?: string }) => ReactNode } const features: Feature[] = [ @@ -82,10 +135,10 @@ const features: Feature[] = [ 'API calls, form validation, error handling, and state transitions are managed internally with React Query, react-hook-form, and Zod.', icon: GearIcon, }, -]; +] function HeroSection() { - const { siteConfig } = useDocusaurusContext(); + const { siteConfig } = useDocusaurusContext() return (
@@ -104,8 +157,8 @@ function HeroSection() {
SDK

- 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() {
- {features.map((feature) => ( + {features.map(feature => (

{feature.title}

@@ -138,7 +191,7 @@ function FeaturesSection() {
- ); + ) } function QuickLinksSection() { @@ -149,36 +202,28 @@ function QuickLinksSection() {

Components

-

- Flows and blocks for onboarding, payroll, contractors, and more. -

+

Flows and blocks for onboarding, payroll, contractors, and more.

Concepts

-

- Events, composition, theming, authentication, and error handling. -

+

Events, composition, theming, authentication, and error handling.

API Reference

-

- Full OpenAPI documentation for the Gusto Embedded API. -

+

Full OpenAPI documentation for the Gusto Embedded API.

GitHub

-

- Source code, issues, and contributions. -

+

Source code, issues, and contributions.

- ); + ) } export default function Home(): JSX.Element { - const { siteConfig } = useDocusaurusContext(); + const { siteConfig } = useDocusaurusContext() return ( @@ -186,5 +231,5 @@ export default function Home(): JSX.Element { - ); + ) } diff --git a/website/src/theme/NotFound/Content/index.tsx b/website/src/theme/NotFound/Content/index.tsx index 343730fb6..afc2449f0 100644 --- a/website/src/theme/NotFound/Content/index.tsx +++ b/website/src/theme/NotFound/Content/index.tsx @@ -1,7 +1,7 @@ -import Link from '@docusaurus/Link'; -import Heading from '@theme/Heading'; -import clsx from 'clsx'; -import styles from './styles.module.css'; +import Link from '@docusaurus/Link' +import Heading from '@theme/Heading' +import clsx from 'clsx' +import styles from './styles.module.css' export default function NotFoundContent(): JSX.Element { return ( @@ -40,5 +40,5 @@ export default function NotFoundContent(): JSX.Element { - ); + ) } diff --git a/website/src/theme/NotFound/Content/styles.module.css b/website/src/theme/NotFound/Content/styles.module.css index 03b9eebd5..1f2ff3230 100644 --- a/website/src/theme/NotFound/Content/styles.module.css +++ b/website/src/theme/NotFound/Content/styles.module.css @@ -65,7 +65,9 @@ font-weight: 600; font-size: 0.95rem; text-decoration: none; - transition: border-color 0.15s ease, color 0.15s ease; + transition: + border-color 0.15s ease, + color 0.15s ease; } .docsLink:hover { @@ -124,7 +126,9 @@ font-size: 0.85rem; color: #1b1b1d; text-decoration: none; - transition: background-color 0.15s ease, color 0.15s ease; + transition: + background-color 0.15s ease, + color 0.15s ease; } .suggestionsList li a:hover {